Merge branch 'The-OpenROAD-Project:master' into signoff-single-commit

Author: nanocoh

docs/user/FlowVariables.md

@@ -100,6 +100,7 @@ configuration file.
 | <a name="ADDITIONAL_GDS"></a>ADDITIONAL_GDS| Hardened macro GDS files listed here.| |
 | <a name="ADDITIONAL_LEFS"></a>ADDITIONAL_LEFS| Hardened macro LEF view files listed here. The LEF information of the macros is immutable and used throughout all stages. Stored in the .odb file.| |
 | <a name="ADDITIONAL_LIBS"></a>ADDITIONAL_LIBS| Hardened macro library files listed here. The library information is immutable and used throughout all stages. Not stored in the .odb file.| |
+| <a name="ASAP7_USE_VT"></a>ASAP7_USE_VT| A space separated list of VT options to use with the ASAP7 standard cell library: RVT, LVT, SLVT.| RVT|
 | <a name="BALANCE_ROWS"></a>BALANCE_ROWS| Balance rows during placement.| 0|
 | <a name="BLOCKS"></a>BLOCKS| Blocks used as hard macros in a hierarchical flow. Do note that you have to specify block-specific inputs file in the directory mentioned by Makefile.| |
 | <a name="BUFFER_PORTS_ARGS"></a>BUFFER_PORTS_ARGS| Specify arguments to the buffer_ports call during placement. Only used if DONT_BUFFER_PORTS=0.| |
@@ -127,6 +128,7 @@ configuration file.
 | <a name="DETAILED_METRICS"></a>DETAILED_METRICS| If set, then calls report_metrics prior to repair operations in the CTS and global route stages| 0|
 | <a name="DETAILED_ROUTE_ARGS"></a>DETAILED_ROUTE_ARGS| Add additional arguments for debugging purposes during detail route.| |
 | <a name="DETAILED_ROUTE_END_ITERATION"></a>DETAILED_ROUTE_END_ITERATION| Maximum number of iterations.| 64|
+| <a name="DETAIL_PLACEMENT_ARGS"></a>DETAIL_PLACEMENT_ARGS| Specify arguments to the detailed_placement call during placement.| |
 | <a name="DFF_LIB_FILES"></a>DFF_LIB_FILES| Technology mapping liberty files for flip-flops.| |
 | <a name="DFF_MAP_FILE"></a>DFF_MAP_FILE| Optional mapping file supplied to Yosys to map D flip-flops| |
 | <a name="DIE_AREA"></a>DIE_AREA| The die area specified as a list of lower-left and upper-right corners in microns (X1 Y1 X2 Y2).| |
@@ -161,7 +163,7 @@ configuration file.
 | <a name="KLAYOUT_TECH_FILE"></a>KLAYOUT_TECH_FILE| A mapping from LEF/DEF to GDS using the KLayout tool.| |
 | <a name="LATCH_MAP_FILE"></a>LATCH_MAP_FILE| Optional mapping file supplied to Yosys to map latches| |
 | <a name="LAYER_PARASITICS_FILE"></a>LAYER_PARASITICS_FILE| Path to per layer parasitics file. Defaults to $(PLATFORM_DIR)/setRC.tcl.| |
-| <a name="LEC_CHECK"></a>LEC_CHECK| Perform a formal equivalence check between before and after netlists.| 1|
+| <a name="LEC_CHECK"></a>LEC_CHECK| Perform a formal equivalence check between before and after netlists. If this fails, report an issue to OpenROAD.| 0|
 | <a name="LIB_FILES"></a>LIB_FILES| A Liberty file of the standard cell library with PVT characterization, input and output characteristics, timing and power definitions for each cell.| |
 | <a name="MACRO_BLOCKAGE_HALO"></a>MACRO_BLOCKAGE_HALO| Distance beyond the edges of a macro that will also be covered by the blockage generated for that macro. Note that the default macro blockage halo comes from the largest of the specified MACRO_PLACE_HALO x or y values. This variable overrides that calculation.| |
 | <a name="MACRO_EXTENSION"></a>MACRO_EXTENSION| Sets the number of GCells added to the blockages boundaries from macros.| |
@@ -388,6 +390,7 @@ configuration file.
 - [CELL_PAD_IN_SITES_DETAIL_PLACEMENT](#CELL_PAD_IN_SITES_DETAIL_PLACEMENT)
 - [CELL_PAD_IN_SITES_GLOBAL_PLACEMENT](#CELL_PAD_IN_SITES_GLOBAL_PLACEMENT)
 - [CLUSTER_FLOPS](#CLUSTER_FLOPS)
+- [DETAIL_PLACEMENT_ARGS](#DETAIL_PLACEMENT_ARGS)
 - [DONT_BUFFER_PORTS](#DONT_BUFFER_PORTS)
 - [EARLY_SIZING_CAP_RATIO](#EARLY_SIZING_CAP_RATIO)
 - [FLOORPLAN_DEF](#FLOORPLAN_DEF)
@@ -496,6 +499,7 @@ configuration file.
 
 ## All stages variables
 
+- [ASAP7_USE_VT](#ASAP7_USE_VT)
 - [KEEP_VARS](#KEEP_VARS)
 - [NUM_CORES](#NUM_CORES)
 - [OPENROAD_HIERARCHICAL](#OPENROAD_HIERARCHICAL)

docs/user/InstructionsForAutoTuner.md

@@ -122,27 +122,28 @@ The order of the parameters matter. Arguments `--design`, `--platform` and
 The following commands should be run from `./tools/AutoTuner`.
 ```
 
-#### Tune only 
-
-* AutoTuner: `openroad_autotuner tune -h`
+#### Tune only
 
 Example:
 
 ```shell
-openroad_autotuner --design gcd --platform sky130hd \
-                       --config ../../flow/designs/sky130hd/gcd/autotuner.json \
-                       tune --samples 5
+python3 -m autotuner.distributed \
+  --design gcd \
+  --platform sky130hd \
+  --config ../../flow/designs/sky130hd/gcd/autotuner.json \
+  tune --samples 5
 ```
-#### Sweep only 
 
-* Parameter sweeping: `openroad_autotuner sweep -h`
+#### Sweep only
 
 Example:
 
 ```shell
-openroad_autotuner --design gcd --platform sky130hd \
-                       --config src/autotuner/distributed-sweep-example.json \
-                       sweep
+python3 -m autotuner.distributed \
+  --design gcd \
+  --platform sky130hd \
+  --config src/autotuner/distributed-sweep-example.json \
+  sweep
 ```
 
 #### Plot images
@@ -159,6 +160,19 @@ The graph will show the progression of one metric (see list below) over the exec
 python3 utils/plot.py --results_dir <your-autotuner-result-path>
 ```
 
+#### Work Directory
+
+Use `--work-dir` to specify a writable directory for outputs. This is passed to ORFS as `WORK_HOME`.
+
+```shell
+python3 -m autotuner.distributed \
+  --design gcd \
+  --platform sky130hd \
+  --config ../../flow/designs/sky130hd/gcd/autotuner.json \
+  --work-dir /tmp/autotuner123 \
+  tune --samples 5
+```
+
 ### Google Cloud Platform (GCP) distribution with Ray
 
 GCP Setup Tutorial coming soon.
@@ -171,6 +185,7 @@ GCP Setup Tutorial coming soon.
 | `--platform`                  | Name of the platform for Autotuning.                                                                  ||
 | `--config`                    | Configuration file that sets which knobs to use for Autotuning.                                       ||
 | `--experiment`                | Experiment name. This parameter is used to prefix the FLOW_VARIANT and to set the Ray log destination.| test |
+| `--work-dir`                  | Work directory for outputs (passed to ORFS as WORK_HOME).                                             | Installation directory |
 | `--git_clean`                 | Clean binaries and build files. **WARNING**: may lose previous data.                                  ||
 | `--git_clone`                 | Force new git clone. **WARNING**: may lose previous data.                                             ||
 | `--git_clone_args`            | Additional git clone arguments.                                                                       ||

etc/DependencyInstaller.sh

@@ -20,7 +20,10 @@ _versionCompare() {
 }
 
 _installORDependencies() {
-    ./tools/OpenROAD/etc/DependencyInstaller.sh ${OR_INSTALLER_ARGS}
+    if [[ ${YOSYS_VER} == "" ]]; then
+        YOSYS_VER=v$(grep 'yosys_ver =' tools/yosys/docs/source/conf.py | awk -F'"' '{print $2}')
+    fi
+    ./tools/OpenROAD/etc/DependencyInstaller.sh ${OR_INSTALLER_ARGS} -yosys-ver="${YOSYS_VER}"
 }
 
 _installPipCommon() {
@@ -306,6 +309,10 @@ Usage: $0 [-all|-base|-common] [-<ARGS>]
                                 #    sudo or with root access.
        $0 -ci
                                 # Installs CI tools
+       $0 -yosys-ver=VERSION
+                                # Installs specified version of Yosys.
+                                #    By default, the Yosys version is
+                                #    obtained from tools/yosys/docs/source/conf.py
        $0 -constant-build-dir
                                 #  Use constant build directory, instead of
                                 #    random one.
@@ -315,6 +322,7 @@ EOF
 
 # default args
 OR_INSTALLER_ARGS="-eqy"
+YOSYS_VER=""
 # default prefix
 PREFIX=""
 # default option
@@ -355,6 +363,9 @@ while [ "$#" -gt 0 ]; do
             CI="yes"
             OR_INSTALLER_ARGS="${OR_INSTALLER_ARGS} -save-deps-prefixes=/etc/openroad_deps_prefixes.txt"
             ;;
+        -yosys-ver=*)
+            YOSYS_VER=${1#*=}
+            ;;
         -prefix=*)
             OR_INSTALLER_ARGS="${OR_INSTALLER_ARGS} $1"
             PREFIX=${1#*=}

etc/DockerHelper.sh

@@ -73,7 +73,10 @@ _setup() {
             fromImage="${FROM_IMAGE_OVERRIDE:-$osBaseImage}"
             cp tools/OpenROAD/etc/DependencyInstaller.sh etc/InstallerOpenROAD.sh
             context="etc"
-            buildArgs="--build-arg options=${options} ${noConstantBuildDir}"
+            local yosys_ver
+            yosys_ver=v$(grep 'yosys_ver =' tools/yosys/docs/source/conf.py | awk -F'"' '{print $2}')
+            options+=" -yosys-ver=${yosys_ver}"
+            buildArgs="--build-arg \"options=${options}\" ${noConstantBuildDir}"
             ;;
         *)
             echo "Target ${target} not found" >&2
@@ -87,20 +90,20 @@ _setup() {
 
 _create() {
     echo "Create docker image ${imagePath} using ${file}"
-    ${DOCKER_CMD} buildx build \
+    eval ${DOCKER_CMD} buildx build \
         --file "${file}" \
         --tag "${imagePath}" \
-        ${buildArgs} \
+        "${buildArgs}" \
         "${context}"
     rm -f etc/InstallerOpenROAD.sh
 }
 
 _push() {
-    if [[ -z ${username+x} ]]; then
+    if [[ -z ${username+x} ]] && [[ ${dryRun} != 1 ]]; then
         echo "Missing required -username=<USER> argument"
         _help
     fi
-    if [[ -z ${password+x} ]]; then
+    if [[ -z ${password+x} ]] && [[ ${dryRun} != 1 ]]; then
         echo "Missing required -password=<PASS> argument"
         _help
     fi

flow/.gitignore

@@ -1,4 +1,3 @@
-settings.mk
 vars.sh
 vars.gdb
 vars.tcl

flow/Makefile

@@ -1,5 +1,7 @@
-# settings.mk is not under source control. Put variables into this
-# file to avoid having to adding the to the make command line.
+# Put variables into this file to avoid having to adding
+# the to the make command line.
+#
+# Out of ORFS trees can have their own settings.mk.
 -include settings.mk
 
 # ==============================================================================
@@ -389,6 +391,8 @@ endef
 # Custom target to go from synthesis to placement in a single OpenROAD run
 $(eval $(call do-step,1_3_floorplan_to_place, $(RESULTS_DIR)/1_synth.odb $(RESULTS_DIR)/1_synth.sdc,floorplan_to_place))
 
+$(eval $(call OPEN_GUI_SHORTCUT,yosys,1_2_yosys.v))
+
 .PHONY: floorplan_to_place
 floorplan_to_place: $(RESULTS_DIR)/1_synth.odb $(RESULTS_DIR)/1_synth.sdc
 	$(UNSET_AND_MAKE) do-1_3_floorplan_to_place
@@ -777,6 +781,7 @@ $(eval $(call OPEN_GUI_SHORTCUT,final,6_final.odb))
 
 $(foreach file,$(RESULTS_DEF),$(eval $(call OPEN_GUI,$(file),DEF_FILE)))
 $(foreach file,$(RESULTS_ODB),$(eval $(call OPEN_GUI,$(file),ODB_FILE)))
+$(foreach file,$(RESULTS_V),$(eval $(call OPEN_GUI,$(file),V_FILE)))
 
 # Write a def for the corresponding odb
 $(foreach file,$(RESULTS_ODB),$(file).def): %.def:

flow/designs/asap7/aes-block/config.mk

@@ -8,10 +8,9 @@ export SDC_FILE      = $(DESIGN_HOME)/$(PLATFORM)/$(DESIGN_NICKNAME)/constraint.
 
 export ABC_AREA               = 1
 
-export CORE_UTILIZATION       = 40
+export CORE_UTILIZATION       = 47
 export CORE_ASPECT_RATIO      = 1
 export CORE_MARGIN            = 2
-export PLACE_DENSITY          = 0.53
 
 export BLOCKS ?= aes_rcon aes_sbox
 export SYNTH_HIERARCHICAL = 1

flow/designs/asap7/aes-block/rules-base.json

@@ -12,27 +12,27 @@
         "compare": "<="
     },
     "placeopt__design__instance__count__stdcell": {
-        "value": 10573,
+        "value": 10501,
         "compare": "<="
     },
     "detailedplace__design__violations": {
         "value": 0,
         "compare": "=="
     },
     "cts__design__instance__count__setup_buffer": {
-        "value": 919,
+        "value": 913,
         "compare": "<="
     },
     "cts__design__instance__count__hold_buffer": {
-        "value": 923,
+        "value": 1691,
         "compare": "<="
     },
     "cts__timing__setup__ws": {
-        "value": -124.0,
+        "value": -148.0,
         "compare": ">="
     },
     "cts__timing__setup__tns": {
-        "value": -5920.0,
+        "value": -12100.0,
         "compare": ">="
     },
     "cts__timing__hold__ws": {
@@ -48,11 +48,11 @@
         "compare": "<="
     },
     "globalroute__timing__setup__ws": {
-        "value": -150.0,
+        "value": -171.0,
         "compare": ">="
     },
     "globalroute__timing__setup__tns": {
-        "value": -6750.0,
+        "value": -9610.0,
         "compare": ">="
     },
     "globalroute__timing__hold__ws": {
@@ -64,7 +64,7 @@
         "compare": ">="
     },
     "detailedroute__route__wirelength": {
-        "value": 52923,
+        "value": 50927,
         "compare": "<="
     },
     "detailedroute__route__drc_errors": {
@@ -80,11 +80,11 @@
         "compare": "<="
     },
     "finish__timing__setup__ws": {
-        "value": -116.0,
+        "value": -98.4,
         "compare": ">="
     },
     "finish__timing__setup__tns": {
-        "value": -3780.0,
+        "value": -5410.0,
         "compare": ">="
     },
     "finish__timing__hold__ws": {

flow/designs/asap7/ibex/rules-base.json

@@ -32,7 +32,7 @@
         "compare": ">="
     },
     "cts__timing__setup__tns": {
-        "value": -35900.0,
+        "value": -48300.0,
         "compare": ">="
     },
     "cts__timing__hold__ws": {
@@ -52,7 +52,7 @@
         "compare": ">="
     },
     "globalroute__timing__setup__tns": {
-        "value": -63800.0,
+        "value": -82000.0,
         "compare": ">="
     },
     "globalroute__timing__hold__ws": {
@@ -84,7 +84,7 @@
         "compare": ">="
     },
     "finish__timing__setup__tns": {
-        "value": -24300.0,
+        "value": -46500.0,
         "compare": ">="
     },
     "finish__timing__hold__ws": {

flow/designs/asap7/minimal/README.md

@@ -62,6 +62,10 @@ gui_synth
 The module hierarchy can here be examined to give a sense of
 area required for the default placement density.
 
+## `make gui_yosys` OpenROAD GUI information for Yosys netlist
+
+It is possible to set up hierarchical synthesis using ORFS, in which case it can be helpful to view a netlist with blackboxed submodules, in which case there's no .odb file and `make gui_synth` is not available.
+
 ## `make gui_floorplan` OpenROAD GUI information
 
 Next to iterate on floorplan settings: