Merge pull request The-OpenROAD-Project#3428 from Pinata-Consulting/variables-openroad-hierarchical

variables: add OPENROAD_HIERARCHICAL

Author: maliberty

docs/user/FlowVariables.md

@@ -168,6 +168,7 @@ configuration file.
 | <a name="MAX_ROUTING_LAYER"></a>MAX_ROUTING_LAYER| The highest metal layer name to be used in routing.| |
 | <a name="MIN_BUF_CELL_AND_PORTS"></a>MIN_BUF_CELL_AND_PORTS| Used to insert a buffer cell to pass through wires. Used in synthesis.| |
 | <a name="MIN_ROUTING_LAYER"></a>MIN_ROUTING_LAYER| The lowest metal layer name to be used in routing.| |
+| <a name="OPENROAD_HIERARCHICAL"></a>OPENROAD_HIERARCHICAL| Feature toggle to enable to run OpenROAD in hierarchical mode, otherwise considered flat. Will eventually be the default and this option will be retired.| 0|
 | <a name="PDN_TCL"></a>PDN_TCL| File path which has a set of power grid policies used by pdn to be applied to the design, such as layers to use, stripe width and spacing to generate the actual metal straps.| |
 | <a name="PLACE_DENSITY"></a>PLACE_DENSITY| The desired average placement density of cells: 1.0 = dense, 0.0 = widely spread. The intended effort is also communicated by this parameter. Use a low value for faster builds and higher value for better quality of results. If a too low value is used, the placer will not be able to place all cells and a recommended minimum placement density can be found in the logs. A too high value can lead to excessive runtimes, even timeouts and subtle failures in the flow after placement, such as in CTS or global routing when timing repair fails. The default is platform specific.| |
 | <a name="PLACE_DENSITY_LB_ADDON"></a>PLACE_DENSITY_LB_ADDON| Check the lower boundary of the PLACE_DENSITY and add PLACE_DENSITY_LB_ADDON if it exists.| |
@@ -483,6 +484,7 @@ configuration file.
 - [KLAYOUT_TECH_FILE](#KLAYOUT_TECH_FILE)
 - [LIB_FILES](#LIB_FILES)
 - [MACRO_EXTENSION](#MACRO_EXTENSION)
+- [OPENROAD_HIERARCHICAL](#OPENROAD_HIERARCHICAL)
 - [PLATFORM](#PLATFORM)
 - [PLATFORM_TCL](#PLATFORM_TCL)
 - [PROCESS](#PROCESS)

flow/scripts/load.tcl

@@ -18,23 +18,9 @@ proc load_design { design_file sdc_file } {
       }
     }
     read_verilog $::env(RESULTS_DIR)/$design_file
-    if {
-      [env_var_exists_and_non_empty SYNTH_WRAPPED_OPERATORS] ||
-      [env_var_exists_and_non_empty SWAP_ARITH_OPERATORS]
-    } {
-      link_design -hier $::env(DESIGN_NAME)
-    } else {
-      link_design $::env(DESIGN_NAME)
-    }
+    log_cmd link_design {*}[hier_options] $::env(DESIGN_NAME)
   } elseif { $ext == ".odb" } {
-    if {
-      [env_var_exists_and_non_empty SYNTH_WRAPPED_OPERATORS] ||
-      [env_var_exists_and_non_empty SWAP_ARITH_OPERATORS]
-    } {
-      read_db -hier $::env(RESULTS_DIR)/$design_file
-    } else {
-      read_db $::env(RESULTS_DIR)/$design_file
-    }
+    log_cmd read_db {*}[hier_options] $::env(RESULTS_DIR)/$design_file
   } else {
     error "Unrecognized input file $design_file"
   }

flow/scripts/open.tcl

@@ -16,7 +16,7 @@ if { [env_var_exists_and_non_empty DEF_FILE] } {
   log_cmd read_def $input_file
 } else {
   set input_file $::env(ODB_FILE)
-  log_cmd read_db $input_file
+  log_cmd read_db {*}[hier_options] $input_file
 }
 
 proc read_timing { input_file } {

flow/scripts/util.tcl

@@ -186,3 +186,17 @@ proc source_env_var_if_exists { env_var } {
     log_cmd source $::env($env_var)
   }
 }
+
+# Feature toggle for now, eventually the -hier option
+# will be default and this code will be deleted.
+proc hier_options { } {
+  if {
+    [env_var_exists_and_non_empty SYNTH_WRAPPED_OPERATORS] ||
+    [env_var_exists_and_non_empty SWAP_ARITH_OPERATORS] ||
+    [env_var_equals OPENROAD_HIERARCHICAL 1]
+  } {
+    return "-hier"
+  } else {
+    return ""
+  }
+}

flow/scripts/variables.yaml

@@ -1039,3 +1039,9 @@ MAX_REPAIR_ANTENNAS_ITER_GRT:
     antennas will run.
   stages:
     - grt
+OPENROAD_HIERARCHICAL:
+  description: >
+    Feature toggle to enable to run OpenROAD in hierarchical mode,
+    otherwise considered flat. Will eventually be the default and
+    this option will be retired.
+  default: 0