Merge pull request #2385 from Pinata-Consulting/scripts-cleanup

maliberty · web-flow · commit 5ad9b98f2c3e · 2024-09-26T15:08:11.000-05:00
Scripts cleanup
diff --git a/flow/scripts/cts.tcl b/flow/scripts/cts.tcl
@@ -71,7 +71,7 @@ if {[info exist ::env(CTS_SNAPSHOTS)]} {
   save_progress 4_1_pre_repair_hold_setup
 }
 
-if {[info exists ::env(SKIP_CTS_REPAIR_TIMING)] == 0 || $::env(SKIP_CTS_REPAIR_TIMING) == 0} {
+if {![env_var_equals SKIP_CTS_REPAIR_TIMING 1]} {
   if {$::env(EQUIVALENCE_CHECK)} {
       write_eqy_verilog 4_before_rsz.v
   }
@@ -94,7 +94,7 @@ if {[info exists ::env(SKIP_CTS_REPAIR_TIMING)] == 0 || $::env(SKIP_CTS_REPAIR_T
 
 report_metrics 4 "cts final"
 
-if { [info exists ::env(POST_CTS_TCL)] } {
+if { [env_var_exists_and_non_empty POST_CTS_TCL] } {
   source $::env(POST_CTS_TCL)
 }
 
diff --git a/flow/scripts/detail_place.tcl b/flow/scripts/detail_place.tcl
@@ -6,7 +6,7 @@ source $::env(PLATFORM_DIR)/setRC.tcl
 
 proc do_dpl {} {
   # Only for use with hybrid rows
-  if {[info exists ::env(BALANCE_ROWS)] && $::env(BALANCE_ROWS)} {
+  if {[env_var_equals BALANCE_ROWS 1]} {
     balance_row_usage
   }
   
@@ -15,7 +15,7 @@ proc do_dpl {} {
       -right $::env(CELL_PAD_IN_SITES_DETAIL_PLACEMENT)
   detailed_placement
   
-  if {[info exists ::env(ENABLE_DPO)] && $::env(ENABLE_DPO)} {
+  if {[env_var_equals ENABLE_DPO 1]} {
     if {[info exist ::env(DPO_MAX_DISPLACEMENT)]} {
       improve_placement -max_displacement $::env(DPO_MAX_DISPLACEMENT)
     } else {
diff --git a/flow/scripts/detail_route.tcl b/flow/scripts/detail_route.tcl
@@ -10,34 +10,15 @@ load_design 5_1_grt.odb 4_cts.sdc
 set_propagated_clock [all_clocks]
 
 set additional_args ""
-if { [info exists ::env(dbProcessNode)]} {
-  append additional_args " -db_process_node $::env(dbProcessNode)"
-}
-if { [info exists ::env(OR_SEED)]} {
-  append additional_args " -or_seed $::env(OR_SEED)"
-}
-if { [info exists ::env(OR_K)]} {
-  append additional_args " -or_k $::env(OR_K)"
-}
-
-if { [info exists ::env(MIN_ROUTING_LAYER)]} {
-  append additional_args " -bottom_routing_layer $::env(MIN_ROUTING_LAYER)"
-}
-if { [info exists ::env(MAX_ROUTING_LAYER)]} {
-  append additional_args " -top_routing_layer $::env(MAX_ROUTING_LAYER)"
-}
-if { [info exists ::env(VIA_IN_PIN_MIN_LAYER)]} {
-  append additional_args " -via_in_pin_bottom_layer $::env(VIA_IN_PIN_MIN_LAYER)"
-}
-if { [info exists ::env(VIA_IN_PIN_MAX_LAYER)]} {
-  append additional_args " -via_in_pin_top_layer $::env(VIA_IN_PIN_MAX_LAYER)"
-}
-if { [info exists ::env(DISABLE_VIA_GEN)]} {
-  append additional_args " -disable_via_gen"
-}
-if { [info exists ::env(REPAIR_PDN_VIA_LAYER)]} {
-  append additional_args " -repair_pdn_vias $::env(REPAIR_PDN_VIA_LAYER)"
-}
+append_env_var additional_args dbProcessNode -db_process_node 1
+append_env_var additional_args OR_SEED -or_seed 1
+append_env_var additional_args OR_K -or_k 1
+append_env_var additional_args MIN_ROUTING_LAYER -bottom_routing_layer 1
+append_env_var additional_args MAX_ROUTING_LAYER -top_routing_layer 1
+append_env_var additional_args VIA_IN_PIN_MIN_LAYER -via_in_pin_bottom_layer 1
+append_env_var additional_args VIA_IN_PIN_MAX_LAYER -via_in_pin_top_layer 1
+append_env_var additional_args DISABLE_VIA_GEN -disable_via_gen 0
+append_env_var additional_args REPAIR_PDN_VIA_LAYER -repair_pdn_vias 1
 
 append additional_args " -save_guide_updates -verbose 1"
 
@@ -55,7 +36,7 @@ append additional_args " -save_guide_updates -verbose 1"
 # having to go spelunking in Tcl or modify configuration scripts, while
 # not having to wait too long or generating large useless reports.
 
-set arguments [expr {[info exists ::env(DETAILED_ROUTE_ARGS)] ? $::env(DETAILED_ROUTE_ARGS) : \
+set arguments [expr {[env_var_exists_and_non_empty DETAILED_ROUTE_ARGS] ? $::env(DETAILED_ROUTE_ARGS) : \
  [concat $additional_args {-drc_report_iter_step 5}]}]
 
 set all_args [concat [list \
@@ -79,7 +60,7 @@ if {![info exist ::env(SKIP_ANTENNA_REPAIR_POST_DRT)]} {
   }
 }
 
-if { [info exists ::env(POST_DETAIL_ROUTE_TCL)] } {
+if { [env_var_exists_and_non_empty POST_DETAIL_ROUTE_TCL] } {
   source $::env(POST_DETAIL_ROUTE_TCL)
 }
 
diff --git a/flow/scripts/generate_abstract.tcl b/flow/scripts/generate_abstract.tcl
@@ -1,6 +1,6 @@
 source $::env(SCRIPTS_DIR)/load.tcl
 
-set stem [expr {[info exists ::env(ABSTRACT_SOURCE)] ? $::env(ABSTRACT_SOURCE) : "6_final"}]
+set stem [expr {[env_var_exists_and_non_empty ABSTRACT_SOURCE] ? $::env(ABSTRACT_SOURCE) : "6_final"}]
 
 set result [find_sdc_file $stem.odb]
 set design_stage [lindex $result 0]
diff --git a/flow/scripts/global_place_skip_io.tcl b/flow/scripts/global_place_skip_io.tcl
@@ -2,7 +2,7 @@ source $::env(SCRIPTS_DIR)/load.tcl
 load_design 2_floorplan.odb 2_floorplan.sdc
 
 
-if { [info exists ::env(FLOORPLAN_DEF)] } {
+if { [env_var_exists_and_non_empty FLOORPLAN_DEF] } {
   puts "FLOORPLAN_DEF is set. Skipping global placement without IOs"
 } else {
   source $::env(SCRIPTS_DIR)/set_place_density.tcl
diff --git a/flow/scripts/global_route.tcl b/flow/scripts/global_route.tcl
@@ -19,7 +19,7 @@ proc global_route_helper {} {
   # GLOBAL_ROUTE_ARGS specifies.
   proc do_global_route {} {
     set all_args [concat [list -congestion_report_file $::env(REPORTS_DIR)/congestion.rpt] \
-      [expr {[info exists ::env(GLOBAL_ROUTE_ARGS)] ? $::env(GLOBAL_ROUTE_ARGS) : \
+      [expr {[env_var_exists_and_non_empty GLOBAL_ROUTE_ARGS] ? $::env(GLOBAL_ROUTE_ARGS) : \
       {-congestion_iterations 30 -congestion_report_iter_step 5 -verbose}}]]
 
     log_cmd global_route {*}$all_args
diff --git a/flow/scripts/io_placement_util.tcl b/flow/scripts/io_placement_util.tcl
@@ -1,7 +1,7 @@
-if {[info exists ::env(FLOORPLAN_DEF)]} {
+if {[env_var_exists_and_non_empty FLOORPLAN_DEF]} {
     puts "Skipping IO placement as DEF file was used to initialize floorplan."
 } else {
-  if {[info exists ::env(IO_CONSTRAINTS)]} {
+  if {[env_var_exists_and_non_empty IO_CONSTRAINTS]} {
     source $::env(IO_CONSTRAINTS)
   }
   set args [list -hor_layer $::env(IO_PLACER_H) \
diff --git a/flow/scripts/klayout.tcl b/flow/scripts/klayout.tcl
@@ -1,10 +1,10 @@
-if {[info exists ::env(FILL_CONFIG)]} {
+if {[env_var_exists_and_non_empty FILL_CONFIG]} {
     set fill_config $::env(FILL_CONFIG)
 } else {
     set fill_config ""
 }
 
-if {[info exists ::env(SEAL_GDS)]} {
+if {[env_var_exists_and_non_empty  SEAL_GDS]} {
     set seal_gds $::env(SEAL_GDS)
 } else {
     set seal_gds ""
diff --git a/flow/scripts/load.tcl b/flow/scripts/load.tcl
@@ -36,7 +36,7 @@ proc load_design {design_file sdc_file} {
 
   source $::env(PLATFORM_DIR)/setRC.tcl
 
-  if { [info exists ::env(LIB_MODEL)] && $::env(LIB_MODEL) == "CCS" } {
+  if { [env_var_equals LIB_MODEL CCS] } {
     puts "Using CCS delay calculation"
     set_delay_calculator prima
   }
diff --git a/flow/scripts/macro_place_util.tcl b/flow/scripts/macro_place_util.tcl
@@ -17,7 +17,7 @@ proc find_macros {} {
 if {[find_macros] != ""} {
 # If wrappers defined replace macros with their wrapped version
 # # ----------------------------------------------------------------------------
-  if {[info exists ::env(MACRO_WRAPPERS)]} {
+  if {[env_var_exists_and_non_empty MACRO_WRAPPERS]} {
     source $::env(MACRO_WRAPPERS)
 
     set wrapped_macros [dict keys [dict get $wrapper around]]
@@ -40,92 +40,48 @@ if {[find_macros] != ""} {
   set blockage_width [expr max($halo_max, $channel_max/2)]
 
   
-  if {[info exists ::env(MACRO_BLOCKAGE_HALO)]} {
+  if {[env_var_exists_and_non_empty MACRO_BLOCKAGE_HALO]} {
     set blockage_width $::env(MACRO_BLOCKAGE_HALO)
   }
 
-  if {[info exists ::env(MACRO_PLACEMENT_TCL)]} {
+  if {[env_var_exists_and_non_empty MACRO_PLACEMENT_TCL]} {
     source $::env(MACRO_PLACEMENT_TCL)
     puts "Using manual macro placement file $::env(MACRO_PLACEMENT_TCL)"
-  } elseif {[info exists ::env(MACRO_PLACEMENT)]} {
+  } elseif {[env_var_exists_and_non_empty MACRO_PLACEMENT]} {
     source $::env(SCRIPTS_DIR)/read_macro_placement.tcl
     puts "Using manual macro placement file $::env(MACRO_PLACEMENT)"
     read_macro_placement $::env(MACRO_PLACEMENT)
-  } elseif {[info exists ::env(RTLMP_FLOW)]} {
+  } elseif {[env_var_equals RTLMP_FLOW 1]} {
     puts "HierRTLMP Flow enabled..."
     set additional_rtlmp_args ""
-    if { [info exists ::env(RTLMP_MAX_LEVEL)]} {
-        append additional_rtlmp_args " -max_num_level $env(RTLMP_MAX_LEVEL)"
-    }
-    if { [info exists ::env(RTLMP_MAX_INST)]} {
-        append additional_rtlmp_args " -max_num_inst $env(RTLMP_MAX_INST)"
-    }
-    if { [info exists ::env(RTLMP_MIN_INST)]} {
-        append additional_rtlmp_args " -min_num_inst $env(RTLMP_MIN_INST)"
-    }
-    if { [info exists ::env(RTLMP_MAX_MACRO)]} {
-        append additional_rtlmp_args " -max_num_macro $env(RTLMP_MAX_MACRO)"
-    }
-    if { [info exists ::env(RTLMP_MIN_MACRO)]} {
-        append additional_rtlmp_args " -min_num_macro $env(RTLMP_MIN_MACRO)"
-    }
-    
+    append_env_var additional_rtlmp_args RTLMP_MAX_LEVEL -max_num_level 1
+    append_env_var additional_rtlmp_args RTLMP_MAX_INST -max_num_inst 1
+    append_env_var additional_rtlmp_args RTLMP_MIN_INST -min_num_inst 1
+    append_env_var additional_rtlmp_args RTLMP_MAX_MACRO -max_num_macro 1
+    append_env_var additional_rtlmp_args RTLMP_MIN_MACRO -min_num_macro 1
     append additional_rtlmp_args " -halo_width $halo_x"
     append additional_rtlmp_args " -halo_height $halo_y"
-
-    if { [info exists ::env(RTLMP_MIN_AR)]} {
-        append additional_rtlmp_args " -min_ar $env(RTLMP_MIN_AR)"
-    }
-    if { [info exists ::env(RTLMP_SIGNATURE_NET_THRESHOLD)]} {
-        append additional_rtlmp_args \
-            " -signature_net_threshold $env(RTLMP_SIGNATURE_NET_THRESHOLD)"
-    }
-    if { [info exists ::env(RTLMP_AREA_WT)]} {
-        append additional_rtlmp_args " -area_weight $env(RTLMP_AREA_WT)"
-    }
-    if { [info exists ::env(RTLMP_WIRELENGTH_WT)]} {
-        append additional_rtlmp_args " -wirelength_weight $env(RTLMP_WIRELENGTH_WT)"
-    }
-    if { [info exists ::env(RTLMP_OUTLINE_WT)]} {
-        append additional_rtlmp_args " -outline_weight $env(RTLMP_OUTLINE_WT)"
-    }
-    if { [info exists ::env(RTLMP_BOUNDARY_WT)]} {
-        append additional_rtlmp_args " -boundary_weight $env(RTLMP_BOUNDARY_WT)"
-    }
-
-    if { [info exists ::env(RTLMP_NOTCH_WT)]} {
-        append additional_rtlmp_args " -notch_weight $env(RTLMP_NOTCH_WT)"
-    }
-
-    if { [info exists ::env(RTLMP_DEAD_SPACE)]} {
-        append additional_rtlmp_args " -dead_space $env(RTLMP_DEAD_SPACE)"
-    }
-    if { [info exists ::env(RTLMP_CONFIG_FILE)]} {
-        append additional_rtlmp_args " -config_file $env(RTLMP_CONFIG_FILE)"
-    }
-    if { [info exists ::env(RTLMP_RPT_DIR)]} {
-        append additional_rtlmp_args " -report_directory $env(RTLMP_RPT_DIR)"
-    }
-
-    if { [info exists ::env(RTLMP_FENCE_LX)]} {
-        append additional_rtlmp_args " -fence_lx $env(RTLMP_FENCE_LX)"
-    }
-    if { [info exists ::env(RTLMP_FENCE_LY)]} {
-        append additional_rtlmp_args " -fence_ly $env(RTLMP_FENCE_LY)"
-    }
-    if { [info exists ::env(RTLMP_FENCE_UX)]} {
-        append additional_rtlmp_args " -fence_ux $env(RTLMP_FENCE_UX)"
-    }
-    if { [info exists ::env(RTLMP_FENCE_UY)]} {
-        append additional_rtlmp_args " -fence_uy $env(RTLMP_FENCE_UY)"
-    }
+    append_env_var additional_rtlmp_args RTLMP_MIN_AR -min_ar 1
+    append_env_var additional_rtlmp_args RTLMP_SIGNATURE_NET_THRESHOLD -signature_net_threshold 1
+    append_env_var additional_rtlmp_args RTLMP_AREA_WT -area_weight 1
+    append_env_var additional_rtlmp_args RTLMP_WIRELENGTH_WT -wirelength_weight 1
+    append_env_var additional_rtlmp_args RTLMP_OUTLINE_WT -outline_weight 1
+    append_env_var additional_rtlmp_args RTLMP_BOUNDARY_WT -boundary_weight 1
+    append_env_var additional_rtlmp_args RTLMP_NOTCH_WT -notch_weight 1
+    append_env_var additional_rtlmp_args RTLMP_DEAD_SPACE -dead_space 1
+    append_env_var additional_rtlmp_args RTLMP_CONFIG_FILE -config_file 1
+    append_env_var additional_rtlmp_args RTLMP_RPT_DIR -report_directory 1
+    append_env_var additional_rtlmp_args RTLMP_FENCE_LX -fence_lx 1
+    append_env_var additional_rtlmp_args RTLMP_FENCE_LY -fence_ly 1
+    append_env_var additional_rtlmp_args RTLMP_FENCE_UX -fence_ux 1
+    append_env_var additional_rtlmp_args RTLMP_FENCE_UY -fence_uy 1
 
     source $::env(SCRIPTS_DIR)/set_place_density.tcl
     append additional_rtlmp_args " -target_util $place_density"
 
     set all_args $additional_rtlmp_args
 
-    if { [info exists ::env(RTLMP_ARGS)] } {
+    if { [env_var_exists_and_non_empty RTLMP_ARGS] } {
       set all_args $::env(RTLMP_ARGS)
     }
 
diff --git a/flow/scripts/pdn.tcl b/flow/scripts/pdn.tcl
@@ -4,7 +4,7 @@ load_design 2_5_floorplan_tapcell.odb 1_synth.sdc
 source $::env(PDN_TCL)
 pdngen
 
-if { [info exists ::env(POST_PDN_TCL)] && [file exists $::env(POST_PDN_TCL)] } {
+if { [env_var_exists_and_non_empty POST_PDN_TCL] } {
   source $::env(POST_PDN_TCL)
 }
 
diff --git a/flow/scripts/read_liberty.tcl b/flow/scripts/read_liberty.tcl
@@ -1,12 +1,12 @@
 # To remove [WARNING STA-1212] from the logs for ASAP7.
 # /OpenROAD-flow-scripts/flow/platforms/asap7/lib/asap7sc7p5t_SIMPLE_RVT_TT_nldm_211120.lib.gz line 13178, timing group from output port.
 # Added following suppress_message
-if {[info exists ::env(PLATFORM)] && $::env(PLATFORM) == "asap7"} {
+if {[env_var_equals PLATFORM asap7]} {
    suppress_message STA 1212
 }
 
 #Read Liberty
-if {[info exists ::env(CORNERS)]} {
+if {[env_var_exists_and_non_empty CORNERS]} {
   # corners
   define_corners {*}$::env(CORNERS)
   foreach corner $::env(CORNERS) {
@@ -24,6 +24,6 @@ if {[info exists ::env(CORNERS)]} {
   }
 }
 
-if {[info exists ::env(PLATFORM)] && $::env(PLATFORM) == "asap7"} {
+if {[env_var_equals PLATFORM asap7]} {
    unsuppress_message STA 1212
 }
diff --git a/flow/scripts/report_metrics.tcl b/flow/scripts/report_metrics.tcl
@@ -7,7 +7,7 @@ proc report_puts { out } {
 }
 
 proc report_metrics { stage when {include_erc true} {include_clock_skew true} } {
-  if {[info exists ::env(SKIP_REPORT_METRICS)] && $::env(SKIP_REPORT_METRICS) == 1} {
+  if {[env_var_equals SKIP_REPORT_METRICS 1]} {
     return
   }
   puts "Report metrics stage $stage, $when..."
@@ -213,7 +213,7 @@ proc report_metrics { stage when {include_erc true} {include_clock_skew true} }
   report_puts "\n=========================================================================="
   report_puts "$when report_power"
   report_puts "--------------------------------------------------------------------------"
-  if {[info exists ::env(CORNERS)]} {
+  if {[env_var_exists_and_non_empty CORNERS]} {
     foreach corner $::env(CORNERS) {
       report_puts "Corner: $corner"
       report_power -corner $corner >> $filename
diff --git a/flow/scripts/resize.tcl b/flow/scripts/resize.tcl
@@ -13,20 +13,20 @@ set_dont_use $::env(DONT_USE_CELLS)
 # by default, IO ports will be buffered
 # to not buffer IO ports, set environment variable
 # DONT_BUFFER_PORT = 1
-if { ![info exists ::env(FOOTPRINT)] } {
-  if { ![info exists ::env(DONT_BUFFER_PORTS)] || $::env(DONT_BUFFER_PORTS) == 0 } {
+if { ![env_var_exists_and_non_empty FOOTPRINT] } {
+  if { ![env_var_equals DONT_BUFFER_PORTS 1] } {
     puts "Perform port buffering..."
     buffer_ports
   }
 }
 
 puts "Perform buffer insertion..."
 set additional_args ""
-if { [info exists ::env(CAP_MARGIN)] && $::env(CAP_MARGIN) > 0.0} {
+if { [env_var_exists_and_non_empty CAP_MARGIN] && $::env(CAP_MARGIN) > 0.0} {
   puts "Cap margin $::env(CAP_MARGIN)"
   append additional_args " -cap_margin $::env(CAP_MARGIN)"
 }
-if { [info exists ::env(SLEW_MARGIN)] && $::env(SLEW_MARGIN) > 0.0} {
+if { [env_var_exists_and_non_empty SLEW_MARGIN] && $::env(SLEW_MARGIN) > 0.0} {
   puts "Slew margin $::env(SLEW_MARGIN)"
   append additional_args " -slew_margin $::env(SLEW_MARGIN)"
 }

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ if {[info exist ::env(CTS_SNAPSHOTS)]} {`
`71`	`71`	`save_progress 4_1_pre_repair_hold_setup`
`72`	`72`	`}`
`73`	`73`
`74`		`-if {[info exists ::env(SKIP_CTS_REPAIR_TIMING)] == 0 \|\| $::env(SKIP_CTS_REPAIR_TIMING) == 0} {`
	`74`	`+if {![env_var_equals SKIP_CTS_REPAIR_TIMING 1]} {`
`75`	`75`	`if {$::env(EQUIVALENCE_CHECK)} {`
`76`	`76`	`write_eqy_verilog 4_before_rsz.v`
`77`	`77`	`}`
`@@ -94,7 +94,7 @@ if {[info exists ::env(SKIP_CTS_REPAIR_TIMING)] == 0 \|\| $::env(SKIP_CTS_REPAIR_T`
`94`	`94`
`95`	`95`	`report_metrics 4 "cts final"`
`96`	`96`
`97`		`-if { [info exists ::env(POST_CTS_TCL)] } {`
	`97`	`+if { [env_var_exists_and_non_empty POST_CTS_TCL] } {`
`98`	`98`	`source $::env(POST_CTS_TCL)`
`99`	`99`	`}`
`100`	`100`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ proc load_design {design_file sdc_file} {`
`36`	`36`
`37`	`37`	`source $::env(PLATFORM_DIR)/setRC.tcl`
`38`	`38`
`39`		`- if { [info exists ::env(LIB_MODEL)] && $::env(LIB_MODEL) == "CCS" } {`
	`39`	`+ if { [env_var_equals LIB_MODEL CCS] } {`
`40`	`40`	`puts "Using CCS delay calculation"`
`41`	`41`	`set_delay_calculator prima`
`42`	`42`	`}`