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

Author: oharboe

docker/Dockerfile.builder

@@ -33,6 +33,7 @@ COPY --link flow/platforms flow/platforms
 COPY --link flow/util flow/util
 COPY --link flow/scripts flow/scripts
 COPY --link flow/designs flow/designs
+COPY --link tools/AutoTuner tools/AutoTuner
 
 COPY --link --from=orfs-builder-base /OpenROAD-flow-scripts/tools/install tools/install
 COPY --link \

docs/user/InstructionsForAutoTuner.md

@@ -23,18 +23,16 @@ User-defined coefficient values (`coeff_perform`, `coeff_power`, `coeff_area`) o
 
 ## Setting up AutoTuner
 
-To setup AutoTuner, make sure you have a virtual environment set up with
-Python 3.9.X. There are plenty of ways to do this, we recommend using 
-[Miniconda](https://docs.conda.io/en/latest/miniconda.html),
-which is a free minimal installer for the package manager `conda`. 
+We have provided two convenience scripts, `./install.sh` and `./setup.sh`
+that works in Python3.8 for installation and configuration of AutoTuner,
+as shown below:
 
 ```shell
-# set up conda environment
-conda create -n autotuner_env python=3.9
-conda activate autotuner_env
+# Install prerequisites
+./tools/AutoTuner/install.sh
 
-# install requirements
-pip install -r ./tools/AutoTuner/requirements.txt
+# Start virtual environment
+./tools/AutoTuner/setup.sh
 ```
 
 ## Input JSON structure
@@ -198,6 +196,15 @@ We show three different views possible at the end, namely: `Table View`, `Scatte
 ![Parallel Coordinate View](../images/Autotuner_best_parameter_view.webp)
 <p style="text-align: center;">Parallel Coordinate View (best run is in green)</p>
 
+## Testing framework
+
+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
+```
 
 ## Citation
 

etc/DependencyInstaller.sh

@@ -126,7 +126,9 @@ _installUbuntuPackages() {
         zlib1g-dev
 
     # install KLayout
-    if  [[ $1 == "rodete" || $(_versionCompare "$1") -ge 23.04 ]]; then
+    if  [[ $1 == "rodete" ]]; then
+        apt-get -y install --no-install-recommends klayout python3-pandas
+    elif _versionCompare "$1" -ge 23.04; then
         apt-get -y install --no-install-recommends klayout python3-pandas
     else
         arch=$(uname -m)

flow/Makefile

@@ -104,6 +104,11 @@
 # Default design
 DESIGN_CONFIG ?= ./designs/nangate45/gcd/config.mk
 
+# Include design and platform configuration before setting default options
+# in this file. This allows the DESIGN_CONFIG to set different defaults than
+# this file.
+include $(DESIGN_CONFIG)
+
 # For instance Bazel needs artifacts (.odb and .rpt files) on a failure to
 # allow the user to save hours on re-running the failed step locally, but
 # when working with a Makefile flow, it is more natural to fail the step
@@ -139,6 +144,7 @@ export ROUTING_LAYER_ADJUSTMENT ?= 0.5
 export RECOVER_POWER ?= 0
 export SKIP_INCREMENTAL_REPAIR ?= 0
 export DETAILED_METRICS ?= 0
+export EQUIVALENCE_CHECK ?= 0
 
 # If we are running headless use offscreen rendering for save_image
 ifndef DISPLAY
@@ -191,10 +197,6 @@ export UTILS_DIR     ?= $(FLOW_HOME)/util
 export SCRIPTS_DIR   ?= $(FLOW_HOME)/scripts
 export TEST_DIR      ?= $(FLOW_HOME)/test
 
-#-------------------------------------------------------------------------------
-# Include design and platform configuration
-include $(DESIGN_CONFIG)
-
 PUBLIC=nangate45 sky130hd sky130hs asap7 ihp-sg13g2 gf180
 
 ifneq ($(wildcard $(PLATFORM_HOME)/$(PLATFORM)),)
@@ -373,7 +375,7 @@ ifeq ($(wildcard $(3)),)
 # each macro.
 block := $(patsubst ./designs/$(PLATFORM)/$(DESIGN_NICKNAME)/%,%,$(dir $(3)))
 $(1) $(2) &:
-	$$(UNSET_AND_MAKE) DESIGN_NAME=${block} DESIGN_NICKNAME=$$(DESIGN_NICKNAME)_${block} DESIGN_CONFIG=./designs/$$(PLATFORM)/$$(DESIGN_NICKNAME)/block.mk generate_abstract
+	$$(UNSET_AND_MAKE) DESIGN_NAME=${block} DESIGN_NICKNAME=$$(DESIGN_NICKNAME)_${block} DESIGN_CONFIG=$$(shell dirname $$(DESIGN_CONFIG))/block.mk generate_abstract
 else
 # There is a unique config.mk for this Verilog module
 $(1) $(2) &:

flow/designs/asap7/gcd/autotuner.json

@@ -3,7 +3,7 @@
     "_SDC_CLK_PERIOD": {
         "type": "float",
         "minmax": [
-            50,
+            300,
             1000
         ],
         "step": 0

flow/designs/ihp-sg13g2/gcd/autotuner.json

@@ -3,8 +3,8 @@
     "_SDC_CLK_PERIOD": {
         "type": "float",
         "minmax": [
-            1.0,
-            4.3647
+            7.0,
+            12.0
         ],
         "step": 0
     },
@@ -52,23 +52,23 @@
         "type": "float",
         "minmax": [
             0.1,
-            0.7
+            0.3
         ],
         "step": 0
     },
     "PLACE_DENSITY_LB_ADDON": {
         "type": "float",
         "minmax": [
             0.0,
-            0.99
+            0.1
         ],
         "step": 0
     },
     "_PINS_DISTANCE": {
         "type": "int",
         "minmax": [
             1,
-            4
+            1
         ],
         "step": 1
     },

flow/designs/sky130hd/gcd/autotuner.json

@@ -99,3 +99,4 @@
         "step": 0
     }
 }
+

flow/scripts/cts.tcl

@@ -72,13 +72,13 @@ if {[info exist ::env(CTS_SNAPSHOTS)]} {
 }
 
 if {[info exists ::env(SKIP_CTS_REPAIR_TIMING)] == 0 || $::env(SKIP_CTS_REPAIR_TIMING) == 0} {
-  if {[info exists ::env(EQUIVALENCE_CHECK)] && $::env(EQUIVALENCE_CHECK) == 1} {
+  if {$::env(EQUIVALENCE_CHECK)} {
       write_eqy_verilog 4_before_rsz.v
   }
 
   repair_timing_helper
 
-  if {[info exists ::env(EQUIVALENCE_CHECK)] && $::env(EQUIVALENCE_CHECK) == 1} {
+  if {$::env(EQUIVALENCE_CHECK)} {
       run_equivalence_test
   }
 

flow/test/test_helper.sh

@@ -77,4 +77,39 @@ if [ $ret -eq 0 ] && grep -q 'power:' <(echo $TARGETS); then
   ret=$(( ret + $? ))
 fi
 
+# Run Autotuner CI specifically for gcd on selected platforms.
+RUN_AUTOTUNER=0
+case $DESIGN_NAME in
+  "gcd")
+    RUN_AUTOTUNER=1
+    ;;
+esac
+case $PLATFORM in
+     "asap7" | "sky130hd" | "ihp-sg13g2" )
+      # Keep RUN_AUTOTUNER enabled only for these platforms
+      ;;
+     *)
+      RUN_AUTOTUNER=0
+      ;;
+esac
+
+if [ $RUN_AUTOTUNER -eq 1 ]; then
+  # change directory to the root of the repo
+  echo "Install and starting venv"
+  cd ../
+  ./tools/AutoTuner/installer.sh
+  . ./tools/AutoTuner/setup.sh
+
+  # remove dashes
+  PLATFORM=${PLATFORM//-/}
+  # convert to uppercase
+  PLATFORM=${PLATFORM^^}
+
+  echo "Running Autotuner smoke tune test"
+  python3 -m unittest tools.AutoTuner.test.smoke_test_tune.${PLATFORM}TuneSmokeTest.test_tune
+
+  echo "Running Autotuner smoke sweep test"
+  python3 -m unittest tools.AutoTuner.test.smoke_test_sweep.${PLATFORM}SweepSmokeTest.test_sweep
+fi
+
 exit $ret

flow/util/genReport.py

@@ -246,7 +246,9 @@ def write_summary():
 
 for log_dir, dirs, files in sorted(os.walk(LOGS_FOLDER, topdown=False)):
     dir_list = log_dir.split(os.sep)
-    if len(dir_list) != 4:
+    # Handles autotuner folders, which do not have `report.log` natively.
+    # TODO: Can we log something for autotuner?
+    if len(dir_list) != 4 or "test-" in dir_list[-1]:
         continue
     report_dir = log_dir.replace(LOGS_FOLDER, REPORTS_FOLDER)