Merge remote-tracking branch 'origin/master' into HEAD

Author: oharboe

docs/user/FlowVariables.md

@@ -98,7 +98,7 @@ configuration file.
 | <a name="GND_NETS_VOLTAGES"></a>GND_NETS_VOLTAGES| Used for IR Drop calculation.|  |
 | <a name="GPL_ROUTABILITY_DRIVEN"></a>GPL_ROUTABILITY_DRIVEN| Specifies whether the placer should use routability driven placement.|  |
 | <a name="GPL_TIMING_DRIVEN"></a>GPL_TIMING_DRIVEN| Specifies whether the placer should use timing driven placement.|  |
-| <a name="GUI_NO_TIMING"></a>GUI_NO_TIMING| Skip loading timing for a faster GUI load.|  |
+| <a name="GUI_TIMING"></a>GUI_TIMING| Load timing information when opening GUI. For large designs, this can be quite time consuming. Useful to disable when investigating non-timing aspects like floorplan, placement, routing, etc.|  |
 | <a name="HOLD_SLACK_MARGIN"></a>HOLD_SLACK_MARGIN| Specifies a time margin for the slack when fixing hold violations. This option allows you to overfix.|  |
 | <a name="IO_PLACER_H"></a>IO_PLACER_H| The metal layer on which to place the I/O pins horizontally (top and bottom of the die).|  |
 | <a name="IO_PLACER_V"></a>IO_PLACER_V| The metal layer on which to place the I/O pins vertically (sides of the die).|  |
@@ -292,7 +292,7 @@ configuration file.
 - [GENERATE_ARTIFACTS_ON_FAILURE](#GENERATE_ARTIFACTS_ON_FAILURE)
 - [GLOBAL_PLACEMENT_ARGS](#GLOBAL_PLACEMENT_ARGS)
 - [GND_NETS_VOLTAGES](#GND_NETS_VOLTAGES)
-- [GUI_NO_TIMING](#GUI_NO_TIMING)
+- [GUI_TIMING](#GUI_TIMING)
 - [HOLD_SLACK_MARGIN](#HOLD_SLACK_MARGIN)
 - [IR_DROP_LAYER](#IR_DROP_LAYER)
 - [KLAYOUT_TECH_FILE](#KLAYOUT_TECH_FILE)

docs/user/InstructionsForAutoTuner.md

@@ -208,6 +208,7 @@ Assuming the virtual environment is setup at `./tools/AutoTuner/autotuner_env`:
 ./tools/AutoTuner/setup.sh
 python3 ./tools/AutoTuner/test/smoke_test_sweep.py
 python3 ./tools/AutoTuner/test/smoke_test_tune.py
+python3 ./tools/AutoTuner/test/smoke_test_sample_iteration.py
 ```
 
 ## Citation

etc/DependencyInstaller.sh

@@ -195,7 +195,8 @@ _installUbuntuPackages() {
             docker-ce \
             docker-ce-cli \
             containerd.io \
-            docker-buildx-plugin
+            docker-buildx-plugin \
+            docker-compose-plugin
     fi
 }
 

flow/Makefile

@@ -797,6 +797,10 @@ $(eval $(call do-copy,5_route,4_cts.sdc,,.sdc))
 do-route:
 	$(UNSET_AND_MAKE) do-5_1_grt do-5_2_route do-5_3_fillcell do-5_route do-5_route.sdc
 
+.PHONY: do-grt
+do-grt:
+	$(UNSET_AND_MAKE) do-5_1_grt
+
 .PHONY: clean_route
 clean_route:
 	rm -rf output*/ results*.out.dmp layer_*.mps

flow/designs/sky130hd/gcd/autotuner.json

@@ -4,8 +4,8 @@
     "_SDC_CLK_PERIOD": {
         "type": "float",
         "minmax": [
-            3.0,
-            4.0
+            7.0,
+            12.0
         ],
         "step": 0
     },

flow/scripts/generate_abstract.tcl

@@ -1,4 +1,5 @@
 source $::env(SCRIPTS_DIR)/load.tcl
+erase_non_stage_variables generate_abstract
 
 set stem [expr {[env_var_exists_and_non_empty ABSTRACT_SOURCE] ? $::env(ABSTRACT_SOURCE) : "6_final"}]
 

flow/scripts/open.tcl

@@ -53,7 +53,8 @@ proc read_timing {input_file} {
   set _tmp [find_timing_paths]
 }
 
-if {![env_var_equals GUI_NO_TIMING 1]} {
+if {[env_var_equals GUI_TIMING 1]} {
+  puts "GUI_TIMING=1 reading timing, takes a little while for large designs..."
   read_timing $input_file
 }
 

flow/scripts/variables.yaml

@@ -80,6 +80,13 @@ CORE_AREA:
 SKIP_REPORT_METRICS:
   description: >
     If set to 1, then metrics, report_metrics does nothing. Useful to speed up builds.
+  stages:
+    - floorplan
+    - place
+    - cts
+    - grt
+    - route
+    - final
 PROCESS:
   description: >
     Technology node or process in use.
@@ -103,6 +110,14 @@ LIB_FILES:
 DONT_USE_CELLS:
   description: >
     Dont use cells eases pin access in detailed routing.
+SYNTH_GUT:
+  description: >
+    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.
+  stages:
+    - synth
 SYNTH_HIERARCHICAL:
   description: >
     Enable to Synthesis hierarchically, otherwise considered flat synthesis.
@@ -165,6 +180,11 @@ FLOORPLAN_DEF:
     Use the DEF file to initialize floorplan.
   stages:
     - floorplan
+REMOVE_ABC_BUFFERS:
+  description: >
+    Remove abc buffers from the netlist.
+  stages:
+    - floorplan
 PLACE_SITE:
   description: >
     Placement site for core cells defined in the technology LEF file.
@@ -216,6 +236,12 @@ MAKE_TRACKS:
     Tcl file that defines add routing tracks to a floorplan.
   stages:
     - floorplan
+IO_CONSTRAINTS:
+  description: >
+    File path to the IO constraints .tcl file.
+  stages:
+    - floorplan
+    - place
 IO_PLACER_H:
   description: >
     The metal layer on which to place the I/O pins horizontally (top and bottom of the die).
@@ -228,12 +254,17 @@ IO_PLACER_V:
   stages:
     - floorplan
     - place
-GUI_NO_TIMING:
+GUI_TIMING:
   description: >
-    Skip loading timing for a faster GUI load.
+    Load timing information when opening GUI. For large designs, this can
+    be quite time consuming. Useful to disable when investigating non-timing
+    aspects like floorplan, placement, routing, etc.
+  value: 1
 FILL_CELLS:
   description: >
     Fill cells are used to fill empty sites. If not set or empty, fill cell insertion is skipped.
+  stages:
+    - route
 TAP_CELL_NAME:
   description: >
     Name of the cell to use in tap cell insertion.
@@ -250,6 +281,12 @@ CELL_PAD_IN_SITES_DETAIL_PLACEMENT:
     - place
     - cts
     - grt
+PLACE_PINS_ARGS:
+  description: >
+    Arguments to place_pins
+  stages:
+    - place
+    - floorplan
 PLACE_DENSITY:
   description: >
     The desired placement density of cells. It reflects how spread the cells would be on the core area.
@@ -324,13 +361,15 @@ MIN_ROUTING_LAYER:
     - place
     - grt
     - route
+    - final
 MAX_ROUTING_LAYER:
   description: >
     The highest metal layer name to be used in routing.
   stages:
     - place
     - grt
     - route
+    - final
 DETAILED_ROUTE_ARGS:
   description: >
     Add additional arguments for debugging purposes during detail route.
@@ -378,6 +417,16 @@ SDC_FILE:
   required: true
   description: >
     The path to design constraint (SDC) file.
+  stages:
+    - synth
+SDC_GUT:
+  description: >
+    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.
+  stages:
+    - synth
 ADDITIONAL_FILES:
   description: >
     Additional files to be added to `make issue` archive.
@@ -421,9 +470,13 @@ ABC_AREA:
 PWR_NETS_VOLTAGES:
   description: >
     Used for IR Drop calculation.
+  stages:
+    - final
 GND_NETS_VOLTAGES:
   description: >
     Used for IR Drop calculation.
+  stages:
+    - final
 BLOCKS:
   description: >
     Blocks used as hard macros in a hierarchical flow. Do note that you have to
@@ -526,3 +579,8 @@ USE_FILL:
 SEAL_GDS:
   description: >
     Seal macro to place around the design.
+ABSTRACT_SOURCE:
+  description: >
+    Which .odb file to use to create abstract
+  stages:
+    - generate_abstract

flow/test/test_helper.sh

@@ -94,13 +94,13 @@ case $PLATFORM in
 esac
 
 if [ $RUN_AUTOTUNER -eq 1 ]; then
-  # change directory to the root of the repo
-  echo "Install and starting venv"
+  # run the commands in ORFS root dir
+  echo "[INFO FLW-0029] Installing dependencies in virtual environment."
   cd ../
   ./tools/AutoTuner/installer.sh
   . ./tools/AutoTuner/setup.sh
 
-  # remove dashes
+  # remove dashes and capitalize platform name
   PLATFORM=${PLATFORM//-/}
   # convert to uppercase
   PLATFORM=${PLATFORM^^}
@@ -111,13 +111,32 @@ if [ $RUN_AUTOTUNER -eq 1 ]; then
   echo "Running Autotuner smoke sweep test"
   python3 -m unittest tools.AutoTuner.test.smoke_test_sweep.${PLATFORM}SweepSmokeTest.test_sweep
 
-  echo "Running Autotuner ref file test (only once)"
+  echo "Running Autotuner smoke tests for --sample and --iteration."
+  python3 -m unittest tools.AutoTuner.test.smoke_test_sample_iteration.${PLATFORM}SampleIterationSmokeTest.test_sample_iteration
+
   if [ "$PLATFORM" == "asap7" ] && [ "$DESIGN" == "gcd" ]; then
+    echo "Running Autotuner ref file test (only once)"
     python3 -m unittest tools.AutoTuner.test.ref_file_check.RefFileCheck.test_files
   fi
 
   echo "Running Autotuner smoke algorithm & evaluation test"
   python3 -m unittest tools.AutoTuner.test.smoke_test_algo_eval.${PLATFORM}AlgoEvalSmokeTest.test_algo_eval
+
+  # run this test last (because it modifies current path)
+  echo "Running Autotuner remote test"
+  if [ "$PLATFORM" == "asap7" ] && [ "$DESIGN" == "gcd" ]; then
+    # Get the directory of the current script
+    script_dir="$(dirname "${BASH_SOURCE[0]}")"
+    cd "$script_dir"/../../
+    latest_image=$(./etc/DockerTag.sh -dev)
+    echo "ORFS_VERSION=$latest_image" > ./tools/AutoTuner/.env
+    cd ./tools/AutoTuner
+    docker compose up --wait
+    docker compose exec ray-worker bash -c "cd /OpenROAD-flow-scripts/tools/AutoTuner/src/autotuner && \
+            python3 distributed.py --design gcd --platform asap7 --server 127.0.0.1 --port 10001 \
+            --config ../../../../flow/designs/asap7/gcd/autotuner.json tune --samples 1"
+    docker compose down -v --remove-orphans
+  fi
 fi
 
 exit $ret

tools/AutoTuner/.gitignore

@@ -9,3 +9,4 @@ __pycache__/
 
 # Autotuner env
 autotuner_env
+.env