Update yosys submodule

.gitignore

@@ -13,6 +13,7 @@ flow/logs
 flow/reports
 flow/objects
 flow/tech
+flow/tmp_surrogate
 
 # Tar archives
 flow/*tar.gz
@@ -105,3 +106,10 @@ bazel-testlogs
 
 # python venv
 venv/
+flow/backup_*
+
+# Local scratch notes (kept out of git)
+doc.md
+
+# macOS
+.DS_Store

README.md

@@ -46,7 +46,17 @@ timeline
 
 ## Tool Installation
 
-There are different ways to install and develop OpenROAD and ORFS, which is the best fit depends use-case, experience and personal taste.
+There are multiple ways to install and develop OpenROAD and ORFS. However, the best option depends on your use case, experience level, and personal preference.
+
+
+> **Recommendation for new users:**  
+> If you are new to OpenROAD-flow-scripts, Docker can be a reliable way to get started since it avoids most dependency and environment issues.  
+>  
+> On supported platforms, using the pre-built binaries can be an even simpler option as it avoids building from source.  
+>  
+> Alternatively, the Bazel-based flow also avoids manual dependency installation (aside from installing Bazelisk itself), similar to how Docker requires installing Docker.
+
+
 
 ### Use Bazel, avoid installing anything at all and adapt the flow to your needs in your own repository
 

docs/user/FlowVariables.md

@@ -157,7 +157,7 @@ configuration file.
 | <a name="IO_PLACER_H"></a>IO_PLACER_H| A list of metal layers on which the I/O pins are placed horizontally (top and bottom of the die).| |
 | <a name="IO_PLACER_V"></a>IO_PLACER_V| A list of metal layers on which the I/O pins are placed vertically (sides of the die).| |
 | <a name="IR_DROP_LAYER"></a>IR_DROP_LAYER| Default metal layer to report IR drop.| |
-| <a name="KEEP_VARS"></a>KEEP_VARS| Feature toggle to keep intermediate variables during the flow. This is useful for the single-run flow, where all stages of the flow are run in a single OpenROAD instance.| |
+| <a name="KEEP_VARS"></a>KEEP_VARS| Feature toggle to keep intermediate variables during the flow. This is useful for the single-run flow, where all stages of the flow are run in a single OpenROAD instance.| 0|
 | <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.| |
@@ -200,7 +200,6 @@ configuration file.
 | <a name="RTLMP_AREA_WT"></a>RTLMP_AREA_WT| Weight for the area of the current floorplan.| 0.1|
 | <a name="RTLMP_ARGS"></a>RTLMP_ARGS| Overrides all other RTL macro placer arguments.| |
 | <a name="RTLMP_BOUNDARY_WT"></a>RTLMP_BOUNDARY_WT| Weight for the boundary or how far the hard macro clusters are from boundaries.| 50.0|
-| <a name="RTLMP_DEAD_SPACE"></a>RTLMP_DEAD_SPACE| Specifies the target dead space percentage, which influences the utilization of a cluster.| 0.05|
 | <a name="RTLMP_FENCE_LX"></a>RTLMP_FENCE_LX| Defines the lower left X coordinate for the global fence bounding box in microns.| 0.0|
 | <a name="RTLMP_FENCE_LY"></a>RTLMP_FENCE_LY| Defines the lower left Y coordinate for the global fence bounding box in microns.| 0.0|
 | <a name="RTLMP_FENCE_UX"></a>RTLMP_FENCE_UX| Defines the upper right X coordinate for the global fence bounding box in microns.| 0.0|
@@ -241,7 +240,7 @@ configuration file.
 | <a name="SLEW_MARGIN"></a>SLEW_MARGIN| Specifies a slew margin when fixing max slew violations. This option allows you to overfix.| |
 | <a name="SWAP_ARITH_OPERATORS"></a>SWAP_ARITH_OPERATORS| Improve timing QoR by swapping ALU and MULT arithmetic operators.| |
 | <a name="SYNTH_ARGS"></a>SYNTH_ARGS| Optional synthesis variables for yosys.| |
-| <a name="SYNTH_BLACKBOXES"></a>SYNTH_BLACKBOXES| List of cells treated as a black box by Yosys. With Bazel, this can be used to run synthesis in parallel for the large modules of the design.| |
+| <a name="SYNTH_BLACKBOXES"></a>SYNTH_BLACKBOXES| List of cells treated as a black box by Yosys. With Bazel, this can be used to run synthesis in parallel for the large modules of the design. Non-existant modules are ignored silently, useful when listing modules statically, even if modules come and go dynamically.| |
 | <a name="SYNTH_CANONICALIZE_TCL"></a>SYNTH_CANONICALIZE_TCL| Specifies a Tcl script with commands to run as part of the synth canonicalize step.| |
 | <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.| 0|
 | <a name="SYNTH_HDL_FRONTEND"></a>SYNTH_HDL_FRONTEND| Select an alternative language frontend to ingest the design. Available option is "slang". If the variable is empty, design is read with the Yosys read_verilog command.| |
@@ -270,7 +269,8 @@ configuration file.
 | <a name="VERILOG_DEFINES"></a>VERILOG_DEFINES| Preprocessor defines passed to the language frontend. Example: `-D HPDCACHE_ASSERT_OFF`| |
 | <a name="VERILOG_FILES"></a>VERILOG_FILES| The path to the design Verilog/SystemVerilog files providing a description of modules.| |
 | <a name="VERILOG_INCLUDE_DIRS"></a>VERILOG_INCLUDE_DIRS| Specifies the include directories for the Verilog input files.| |
-| <a name="VERILOG_TOP_PARAMS"></a>VERILOG_TOP_PARAMS| Apply toplevel params (if exist).| |
+| <a name="VERILOG_TOP_PARAMS"></a>VERILOG_TOP_PARAMS| Apply toplevel params (if exist). Passed in as a list of key value pairs in tcl syntax; separated by spaces: PARAM1 VALUE1 PARAM2 VALUE2| |
+| <a name="WRITE_ODB_AND_SDC_EACH_STAGE"></a>WRITE_ODB_AND_SDC_EACH_STAGE| Save out .sdc and .odb file after each stage, useful to disable when using a single OpenROAD instance to run all stages of the flow.| 1|
 | <a name="YOSYS_FLAGS"></a>YOSYS_FLAGS| Flags to pass to yosys.| -v 3|
 ## synth variables
 
@@ -342,7 +342,6 @@ configuration file.
 - [RTLMP_AREA_WT](#RTLMP_AREA_WT)
 - [RTLMP_ARGS](#RTLMP_ARGS)
 - [RTLMP_BOUNDARY_WT](#RTLMP_BOUNDARY_WT)
-- [RTLMP_DEAD_SPACE](#RTLMP_DEAD_SPACE)
 - [RTLMP_FENCE_LX](#RTLMP_FENCE_LX)
 - [RTLMP_FENCE_LY](#RTLMP_FENCE_LY)
 - [RTLMP_FENCE_UX](#RTLMP_FENCE_UX)
@@ -488,6 +487,7 @@ configuration file.
 - [OPENROAD_HIERARCHICAL](#OPENROAD_HIERARCHICAL)
 - [SWAP_ARITH_OPERATORS](#SWAP_ARITH_OPERATORS)
 - [SYNTH_WRAPPED_OPERATORS](#SYNTH_WRAPPED_OPERATORS)
+- [WRITE_ODB_AND_SDC_EACH_STAGE](#WRITE_ODB_AND_SDC_EACH_STAGE)
 
 ## generate_abstract variables
 

flow/Makefile

@@ -744,6 +744,20 @@ check-yosys:
 .PHONY: all
 all: check-yosys check-openroad synth floorplan place cts route finish
 
+.PHONY: surrogate_tune
+surrogate_tune: check-openroad synth
+	(OPENROAD_ENABLE_SURROGATE=1 $(TIME_CMD) $(SURROGATE_OPENROAD_CMD) $(SCRIPTS_DIR)/surrogate_tune.tcl) 2>&1 | tee $(abspath $(LOG_DIR)/surrogate_tune.log)
+
+.PHONY: surrogate_tune_synthaware
+surrogate_tune_synthaware: check-openroad
+	@mkdir -p $(LOG_DIR)
+	($(TIME_CMD) $(PYTHON_EXE) $(SCRIPTS_DIR)/surrogate_tune_synthaware.py) 2>&1 | tee $(abspath $(LOG_DIR)/surrogate_tune_synthaware.log)
+
+.PHONY: surrogate_autotune
+surrogate_autotune: check-openroad
+	@mkdir -p $(LOG_DIR)
+	($(TIME_CMD) $(PYTHON_EXE) $(SCRIPTS_DIR)/surrogate_autotune.py) 2>&1 | tee $(abspath $(LOG_DIR)/surrogate_autotune.log)
+
 .PHONY: clean
 clean:
 	@echo

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

@@ -1,38 +1,38 @@
 {
     "synth__design__instance__area__stdcell": {
-        "value": 2130.06,
+        "value": 2090.0,
         "compare": "<="
     },
     "constraints__clocks__count": {
         "value": 1,
         "compare": "=="
     },
     "placeopt__design__instance__area": {
-        "value": 7213,
+        "value": 7210,
         "compare": "<="
     },
     "placeopt__design__instance__count__stdcell": {
-        "value": 10608,
+        "value": 10573,
         "compare": "<="
     },
     "detailedplace__design__violations": {
         "value": 0,
         "compare": "=="
     },
     "cts__design__instance__count__setup_buffer": {
-        "value": 922,
+        "value": 919,
         "compare": "<="
     },
     "cts__design__instance__count__hold_buffer": {
-        "value": 1796,
+        "value": 2001,
         "compare": "<="
     },
     "cts__timing__setup__ws": {
-        "value": -137.0,
+        "value": -127.0,
         "compare": ">="
     },
     "cts__timing__setup__tns": {
-        "value": -10800.0,
+        "value": -7220.0,
         "compare": ">="
     },
     "cts__timing__hold__ws": {
@@ -52,7 +52,7 @@
         "compare": ">="
     },
     "globalroute__timing__setup__tns": {
-        "value": -10200.0,
+        "value": -7080.0,
         "compare": ">="
     },
     "globalroute__timing__hold__ws": {
@@ -79,28 +79,12 @@
         "value": 100,
         "compare": "<="
     },
-    "detailedroute__timing__setup__ws": {
-        "value": -22.5,
-        "compare": ">="
-    },
-    "detailedroute__timing__setup__tns": {
-        "value": -90.0,
-        "compare": ">="
-    },
-    "detailedroute__timing__hold__ws": {
-        "value": -22.5,
-        "compare": ">="
-    },
-    "detailedroute__timing__hold__tns": {
-        "value": -90.0,
-        "compare": ">="
-    },
     "finish__timing__setup__ws": {
         "value": -94.5,
         "compare": ">="
     },
     "finish__timing__setup__tns": {
-        "value": -6330.0,
+        "value": -3610.0,
         "compare": ">="
     },
     "finish__timing__hold__ws": {
@@ -115,4 +99,4 @@
         "value": 7332,
         "compare": "<="
     }
-}
+}

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

@@ -32,7 +32,7 @@
         "compare": ">="
     },
     "cts__timing__setup__tns": {
-        "value": -706.0,
+        "value": -687.0,
         "compare": ">="
     },
     "cts__timing__hold__ws": {
@@ -52,7 +52,7 @@
         "compare": ">="
     },
     "globalroute__timing__setup__tns": {
-        "value": -2650.0,
+        "value": -2160.0,
         "compare": ">="
     },
     "globalroute__timing__hold__ws": {
@@ -79,28 +79,12 @@
         "value": 100,
         "compare": "<="
     },
-    "detailedroute__timing__setup__ws": {
-        "value": -19.0,
-        "compare": ">="
-    },
-    "detailedroute__timing__setup__tns": {
-        "value": -76.0,
-        "compare": ">="
-    },
-    "detailedroute__timing__hold__ws": {
-        "value": -19.0,
-        "compare": ">="
-    },
-    "detailedroute__timing__hold__tns": {
-        "value": -76.0,
-        "compare": ">="
-    },
     "finish__timing__setup__ws": {
-        "value": -36.5,
+        "value": -44.6,
         "compare": ">="
     },
     "finish__timing__setup__tns": {
-        "value": -1000.0,
+        "value": -1130.0,
         "compare": ">="
     },
     "finish__timing__hold__ws": {
@@ -115,4 +99,4 @@
         "value": 2254,
         "compare": "<="
     }
-}
+}

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

@@ -79,24 +79,8 @@
         "value": 100,
         "compare": "<="
     },
-    "detailedroute__timing__setup__ws": {
-        "value": -19.0,
-        "compare": ">="
-    },
-    "detailedroute__timing__setup__tns": {
-        "value": -76.0,
-        "compare": ">="
-    },
-    "detailedroute__timing__hold__ws": {
-        "value": -19.0,
-        "compare": ">="
-    },
-    "detailedroute__timing__hold__tns": {
-        "value": -76.0,
-        "compare": ">="
-    },
     "finish__timing__setup__ws": {
-        "value": -36.7,
+        "value": -57.0,
         "compare": ">="
     },
     "finish__timing__setup__tns": {
@@ -115,4 +99,4 @@
         "value": 2269,
         "compare": "<="
     }
-}
+}

flow/designs/asap7/aes/surrogate_base_params.json

@@ -0,0 +1,4 @@
+{
+  "cts_cluster_size": 10,
+  "cts_cluster_diameter": 50
+}

flow/designs/asap7/aes/surrogate_space.json

@@ -0,0 +1,62 @@
+{
+  "clock_period": {
+    "type": "float",
+    "minmax": [300, 600],
+    "step": 0
+  },
+  "core_utilization": {
+    "type": "int",
+    "minmax": [20, 99],
+    "step": 1
+  },
+  "core_aspect_ratio": {
+    "type": "float",
+    "minmax": [0.9, 1.1],
+    "step": 0
+  },
+  "tns_end_percent": {
+    "type": "int",
+    "minmax": [0, 100],
+    "step": 1
+  },
+  "global_padding": {
+    "type": "int",
+    "minmax": [0, 3],
+    "step": 1
+  },
+  "detail_padding": {
+    "type": "int",
+    "minmax": [0, 3],
+    "step": 1
+  },
+  "enable_dpo": {
+    "type": "binary",
+    "minmax": [0, 1],
+    "step": 1
+  },
+  "pin_layer_adjust": {
+    "type": "float",
+    "minmax": [0.2, 0.7],
+    "step": 0
+  },
+  "above_layer_adjust": {
+    "type": "float",
+    "minmax": [0.2, 0.7],
+    "step": 0
+  },
+  "density_margin_addon": {
+    "type": "float",
+    "minmax": [0.0, 0.99],
+    "step": 0
+  },
+  "cts_cluster_size": {
+    "type": "int",
+    "minmax": [10, 40],
+    "step": 1
+  },
+  "cts_cluster_diameter": {
+    "type": "int",
+    "minmax": [50, 200],
+    "step": 1
+  }
+}