Merge branch 'master' into secure-pin_access

Signed-off-by: Eder Monteiro <[email protected]>

Author: eder-matheus

dev_env.sh

@@ -1,9 +1,16 @@
 #!/usr/bin/env bash
-
-function setpaths() {
+#
+# Set developer paths and environment variables here,
+# user settings go in ./env.sh
+function __setpaths() {
     local DIR=$(readlink -f "$(dirname "${BASH_SOURCE[0]}")")
+    [ "$(find $DIR/dependencies -type f -user root)" ] && echo "WARNING! Files set up by sudo found in $DIR"
     export PATH="$DIR/dependencies/bin:$PATH"
     export CMAKE_INSTALL_RPATH=$DIR/dependencies/lib:$DIR/dependencies/lib64
-}
 
-setpaths
+    if [[ "$OSTYPE" == "darwin"* ]]; then
+        export CMAKE_PREFIX_PATH="$(brew --prefix or-tools)"
+    fi
+}
+__setpaths
+unset -f __setpaths

docker/Dockerfile.dev

@@ -15,10 +15,12 @@ COPY InstallerOpenROAD.sh \
 ARG options=""
 ARG constantBuildDir="-constant-build-dir"
 
-RUN env CFLAGS="-D__TIME__=0 -D__DATE__=0 -D__TIMESTAMP__=0 -Wno-builtin-macro-redefined" \
-      CXXFLAGS="-D__TIME__=0 -D__DATE__=0 -D__TIMESTAMP__=0 -Wno-builtin-macro-redefined" \
-      ./DependencyInstaller.sh $options $constantBuildDir \
-      && rm -rf /tmp/installer /tmp/* /var/tmp/* /var/lib/apt/lists/*
+ENV CFLAGS="-D__TIME__=0 -D__DATE__=0 -D__TIMESTAMP__=0 -Wno-builtin-macro-redefined"
+ENV CXXFLAGS="-D__TIME__=0 -D__DATE__=0 -D__TIMESTAMP__=0 -Wno-builtin-macro-redefined"
+
+RUN ./DependencyInstaller.sh -base $options $constantBuildDir \
+    && ./DependencyInstaller.sh -common $options $constantBuildDir \
+    && rm -rf /tmp/installer /tmp/* /var/tmp/* /var/lib/apt/lists/*
 
 ARG fromImage
 

docs/user/BuildLocally.md

@@ -4,8 +4,7 @@
 
 The `setup.sh` script installs all of the dependencies, including OpenROAD dependencies, if they are not already installed.
 
-Supported configurations are: CentOS 7, Ubuntu 20.04, Ubuntu 22.04, Ubuntu 22.04(aarch64), RHEL 8,
-Debian 10 and Debian 11.
+Supported configurations are: Ubuntu 20.04, Ubuntu 22.04, Ubuntu 22.04(aarch64), RHEL 8, RockyLinux 9 and Debian 11.
 
 ``` shell
 git clone --recursive https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts

docs/user/BuildWithPrebuilt.md

@@ -1,13 +1,13 @@
 # Using Pre-built Binaries
 
 ## Install Klayout and Yosys
-Please ensure the Klayout version (denoted with `klayoutVersion` variable) is consistent with the one used in [DependencyInstaller script](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/etc/DependencyInstaller.sh). 
+Please ensure the Klayout version (denoted with `klayoutVersion` variable) is consistent with the one used in [DependencyInstaller script](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/etc/DependencyInstaller.sh).
 
 Instructions for installing:
 - [Klayout>=0.28.8](https://www.klayout.de/build.html)
 - [Yosys>=0.39](https://github.com/YosysHQ/oss-cad-suite-build/blob/master/README.md#installation)
 
-```{tip} Unfortunately KLayout maintainers do not provide Debian 10/11 compatible packages. You can follow the build-from-sources instruction (Version >=0.25) and Ubuntu 22 instructions [here](https://www.klayout.de/build.html#:~:text=Building%20KLayout%20on%20Linux%20(Version%20%3E%3D%200.25)). 
+```{tip} Unfortunately KLayout maintainers do not provide Debian 11 compatible packages. You can follow the build-from-sources instruction (Version >=0.25) and Ubuntu 22 instructions [here](https://www.klayout.de/build.html#:~:text=Building%20KLayout%20on%20Linux%20(Version%20%3E%3D%200.25)).
 ```
 
 ## Install OpenROAD
@@ -19,7 +19,7 @@ Thanks to [Precision Innovations](https://precisioninno.com/) for hosting and ma
 
 The following platforms are supported currently:
 - Ubuntu 20.04/22.04
-- Debian 10/11
+- Debian 11
 
 Use the following steps to download:
 
@@ -29,24 +29,24 @@ Step 2: Download the artifacts for your distribution.
 
 Step 3: Run the install command based on platform use package installer.
         For example Ubuntu 20.04 use:
-        
+
 ```shell
 sudo apt install ./openroad_2.0_amd64-ubuntu20.04.deb
 ```
 
 ## Install Klayout and Yosys
-Please ensure the Klayout version (denoted with `klayoutVersion` variable) is consistent with the one used in [DependencyInstaller script](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/etc/DependencyInstaller.sh). 
+Please ensure the Klayout version (denoted with `klayoutVersion` variable) is consistent with the one used in [DependencyInstaller script](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/etc/DependencyInstaller.sh).
 
 Instructions for installing:
 - [Klayout>=0.28.8](https://www.klayout.de/build.html)
 - [Yosys>=0.39](https://github.com/YosysHQ/oss-cad-suite-build/blob/master/README.md#installation)
 
-```{tip} Unfortunately KLayout maintainers do not provide Debian 10/11 compatible packages. You can follow the build-from-sources instruction (Version >=0.25) and Ubuntu 22 instructions [here](https://www.klayout.de/build.html#:~:text=Building%20KLayout%20on%20Linux%20(Version%20%3E%3D%200.25)). 
+```{tip} Unfortunately KLayout maintainers do not provide Debian 11 compatible packages. You can follow the build-from-sources instruction (Version >=0.25) and Ubuntu 22 instructions [here](https://www.klayout.de/build.html#:~:text=Building%20KLayout%20on%20Linux%20(Version%20%3E%3D%200.25)).
 ```
 
 
 ## Verify Installation
-You may clone the OpenROAD-flow-scripts repository non-recursively. 
+You may clone the OpenROAD-flow-scripts repository non-recursively.
 
 ```
 git clone https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts.git
@@ -60,7 +60,7 @@ export OPENROAD_EXE=$(command -v openroad)
 export YOSYS_EXE=$(command -v yosys)
 
 # only if KLayout is built from source
-export LD_LIBRARY_PATH="<klayout_location>/bin:$PATH" 
+export LD_LIBRARY_PATH="<klayout_location>/bin:$PATH"
 
 yosys -help
 openroad -help

docs/user/BuildWithWSL.md

@@ -2,7 +2,7 @@
 Windows Subsystem for Linux, or WSL for short is a way for you to mount a Linux-based OS onto your Windows machine, allowing you to build OpenROAD-flow-scripts both locally and via Docker. 
 
 ## Install WSL
-Instructions to install WSL can be found [here](https://learn.microsoft.com/en-us/windows/wsl/install). You may use any kernel supported, such as: CentOS 7, Ubuntu 20.04, Ubuntu 22.04, RHEL 8, Debian 10 and Debian 11.
+Instructions to install WSL can be found [here](https://learn.microsoft.com/en-us/windows/wsl/install). You may use any kernel supported, such as: Ubuntu 20.04, Ubuntu 22.04, RHEL 8, RockyLinux 9, Debian 11.
 
 We recommend that users follow the Docker build by continuing onto the guide below. However, if you wish to install locally, you may follow the build locally instructions [here](./BuildLocally.md).
 

docs/user/DockerShell.md

@@ -33,10 +33,10 @@ If you need to use a different Docker image than default, override by using the
 environment variable:
 
 ```
-OR_IMAGE=openroad/flow-centos7-builder:v1234 util/docker_shell make
+OR_IMAGE=openroad/flow-ubuntu22.04-builder:v1234 util/docker_shell make
 ```
 
-If you have built your OpenROAD Docker image using prebuilt binaries, 
+If you have built your OpenROAD Docker image using prebuilt binaries,
 you might want to source custom paths for your modules as follows.
 
 ```

docs/user/FlowVariables.md

@@ -181,6 +181,7 @@ configuration file.
 | <a name="SYNTH_ARGS"></a>SYNTH_ARGS| Optional synthesis variables for yosys.| -flatten| |
 | <a name="SYNTH_GUT"></a>SYNTH_GUT| Load design and remove all internal logic before doing synthesis. This is useful when creating a mock .lef abstract that has a smaller area than the amount of logic would allow. bazel-orfs uses this to mock SRAMs, for instance.| | |
 | <a name="SYNTH_HIERARCHICAL"></a>SYNTH_HIERARCHICAL| Enable to Synthesis hierarchically, otherwise considered flat synthesis.| 0| |
+| <a name="SYNTH_MEMORY_MAX_BITS"></a>SYNTH_MEMORY_MAX_BITS| Maximum number of bits for memory synthesis.| 4096| |
 | <a name="TAPCELL_TCL"></a>TAPCELL_TCL| Path to Endcap and Welltie cells file.| | |
 | <a name="TAP_CELL_NAME"></a>TAP_CELL_NAME| Name of the cell to use in tap cell insertion.| | |
 | <a name="TECH_LEF"></a>TECH_LEF| A technology LEF file of the PDK that includes all relevant information regarding metal layers, vias, and spacing requirements.| | |
@@ -209,6 +210,7 @@ configuration file.
 - [SDC_GUT](#SDC_GUT)
 - [SYNTH_GUT](#SYNTH_GUT)
 - [SYNTH_HIERARCHICAL](#SYNTH_HIERARCHICAL)
+- [SYNTH_MEMORY_MAX_BITS](#SYNTH_MEMORY_MAX_BITS)
 - [TIEHI_CELL_AND_PORT](#TIEHI_CELL_AND_PORT)
 - [TIELO_CELL_AND_PORT](#TIELO_CELL_AND_PORT)
 - [VERILOG_FILES](#VERILOG_FILES)

docs/user/InstructionsForAutoTuner.md

@@ -124,27 +124,40 @@ The following commands should be run from `./tools/AutoTuner`.
 
 #### Tune only 
 
-* AutoTuner: `python3 -m autotuner.distributed tune -h`
+* AutoTuner: `openroad_autotuner tune -h`
 
 Example:
 
 ```shell
-python3 -m autotuner.distributed --design gcd --platform sky130hd \
+openroad_autotuner --design gcd --platform sky130hd \
                        --config ../../flow/designs/sky130hd/gcd/autotuner.json \
                        tune --samples 5
 ```
 #### Sweep only 
 
-* Parameter sweeping: `python3 -m autotuner.distributed sweep -h`
+* Parameter sweeping: `openroad_autotuner sweep -h`
 
 Example:
 
 ```shell
-python3 -m autotuner.distributed --design gcd --platform sky130hd \
+openroad_autotuner --design gcd --platform sky130hd \
                        --config src/autotuner/distributed-sweep-example.json \
                        sweep
 ```
 
+#### Plot images
+
+After running an AutoTuner experiment, you can generate a graph to understand the results better.
+The graph will show the progression of one metric (see list below) over the execution of the experiment.
+
+- QoR
+- Runtime per trial
+- Clock Period
+- Worst slack
+
+```shell
+python3 utils/plot.py --results_dir <your-autotuner-result-path>
+```
 
 ### Google Cloud Platform (GCP) distribution with Ray
 

env.sh

@@ -1,24 +1,25 @@
-if [[ "$OSTYPE" == "darwin"* ]]; then
-  DIR="$(dirname $(perl -e 'use Cwd "abs_path";print abs_path(shift)' "${BASH_SOURCE[0]}"))"
-else
-  DIR="$(dirname $(readlink -f "${BASH_SOURCE[0]}"))"
-fi
+#!/usr/bin/env bash
+function __setpaths() {
+  if [[ "$OSTYPE" == "darwin"* ]]; then
+    DIR="$(dirname $(perl -e 'use Cwd "abs_path";print abs_path(shift)' "${BASH_SOURCE[0]}"))"
+  else
+    DIR="$(dirname $(readlink -f "${BASH_SOURCE[0]}"))"
+  fi
 
-if [ -f /opt/rh/rh-python38/enable ]; then
-  source /opt/rh/rh-python38/enable
-fi
+  export OPENROAD=${DIR}/tools/OpenROAD
+  echo "OPENROAD: ${OPENROAD}"
 
-export OPENROAD=${DIR}/tools/OpenROAD
-echo "OPENROAD: ${OPENROAD}"
+  # Set user paths and environment variables here,
+  # developer settings go in ./dev_env.sh
+  export PATH=${DIR}/tools/install/OpenROAD/bin:$PATH
+  export PATH=${DIR}/tools/install/yosys/bin:$PATH
 
-export PATH=${DIR}/dependencies/bin:$PATH
-export PATH=${DIR}/tools/install/OpenROAD/bin:$PATH
-export PATH=${DIR}/tools/install/yosys/bin:$PATH
+  if [[ "$OSTYPE" == "darwin"* ]]; then
+    export PATH="/Applications/KLayout/klayout.app/Contents/MacOS:$PATH"
+    export PATH="$(brew --prefix bison)/bin:$(brew --prefix flex)/bin:$(brew --prefix tcl-tk)/bin:$PATH"
+  fi
 
-if [[ "$OSTYPE" == "darwin"* ]]; then
-  export PATH="/Applications/KLayout/klayout.app/Contents/MacOS:$PATH"
-  export PATH="$(brew --prefix bison)/bin:$(brew --prefix flex)/bin:$(brew --prefix tcl-tk)/bin:$PATH"
-  export CMAKE_PREFIX_PATH="$(brew --prefix or-tools)"
-fi
-
-export FLOW_HOME=$DIR/flow
+  export FLOW_HOME=$DIR/flow
+}
+__setpaths
+unset -f __setpaths

etc/DependencyInstaller.sh

@@ -260,7 +260,7 @@ OR_INSTALLER_ARGS="-eqy"
 # default prefix
 PREFIX=""
 # default option
-option="all"
+option="none"
 # default isLocal
 isLocal="false"
 constantBuildDir="false"
@@ -272,16 +272,20 @@ while [ "$#" -gt 0 ]; do
         -h|-help)
             _help 0
             ;;
+        -all)
+            if [[ "${option}" != "none" ]]; then
+                echo "WARNING: previous argument -${option} will be overwritten with -all." >&2
+            fi
+            option="all"
+            ;;
         -base)
-            OR_INSTALLER_ARGS="${OR_INSTALLER_ARGS} -base"
-            if [[ "${option}" != "all" ]]; then
+            if [[ "${option}" != "none" ]]; then
                 echo "WARNING: previous argument -${option} will be overwritten with -base." >&2
             fi
             option="base"
             ;;
         -common)
-            OR_INSTALLER_ARGS="${OR_INSTALLER_ARGS} -common"
-            if [[ "${option}" != "all" ]]; then
+            if [[ "${option}" != "none" ]]; then
                 echo "WARNING: previous argument -${option} will be overwritten with -common." >&2
             fi
             option="common"
@@ -309,6 +313,13 @@ while [ "$#" -gt 0 ]; do
     shift 1
 done
 
+if [[ "${option}" == "none"  ]]; then
+        echo "You must use one of: -all|-base|-common" >&2
+        _help
+fi
+
+OR_INSTALLER_ARGS="${OR_INSTALLER_ARGS} -${option}"
+
 platform="$(uname -s)"
 case "${platform}" in
     "Linux" )