ppl: add deprecated message for -random and -random_seed

eder-matheus · eder-matheus · commit ef7d63cc4de9 · 2025-07-22T12:07:23.000-03:00
Signed-off-by: Eder Monteiro &lt;emrmonteiro@precisioninno.com&gt;
diff --git a/src/ppl/src/IOPlacer.tcl b/src/ppl/src/IOPlacer.tcl
@@ -208,6 +208,8 @@ proc write_pin_placement { args } {
 
 sta::define_cmd_args "place_pins" {[-hor_layers h_layers]\
                                   [-ver_layers v_layers]\
+                                  [-random_seed seed]\
+                                  [-random]\
                                   [-corner_avoidance distance]\
                                   [-min_distance min_dist]\
                                   [-min_distance_in_tracks]\
@@ -220,146 +222,150 @@ sta::define_cmd_args "place_pins" {[-hor_layers h_layers]\
 proc place_pins { args } {
   ord::parse_list_args "place_pins" args list {-exclude -group_pins}
   sta::parse_key_args "place_pins" args \
-    keys {-hor_layers -ver_layers -corner_avoidance \
+    keys {-hor_layers -ver_layers -random_seed -corner_avoidance \
           -min_distance -write_pin_placement} \
-    flags {-min_distance_in_tracks -annealing} ;# checker off
+    flags {-random -min_distance_in_tracks -annealing} ;# checker off
 
   sta::check_argc_eq0 "place_pins" $args
 
-  set regions $list(-exclude)
-  set pin_groups $list(-group_pins)
+  if { [info exists flags(-random)] || [info exists keys(-random_seed)] } {
+    utl::warn PPL 113 "-random and -random_seed are deprecated."
+  } else {
+    set regions $list(-exclude)
+    set pin_groups $list(-group_pins)
 
-  set dbTech [ord::get_db_tech]
-  if { $dbTech == "NULL" } {
-    utl::error PPL 31 "No technology found."
-  }
+    set dbTech [ord::get_db_tech]
+    if { $dbTech == "NULL" } {
+      utl::error PPL 31 "No technology found."
+    }
 
-  set dbBlock [ord::get_db_block]
-  if { $dbBlock == "NULL" } {
-    utl::error PPL 32 "No block found."
-  }
+    set dbBlock [ord::get_db_block]
+    if { $dbBlock == "NULL" } {
+      utl::error PPL 32 "No block found."
+    }
 
-  set db [ord::get_db]
+    set db [ord::get_db]
 
-  set blockages {}
+    set blockages {}
 
-  foreach inst [$dbBlock getInsts] {
-    if { [$inst isBlock] } {
-      if { ![$inst isPlaced] } {
-        utl::warn PPL 15 "Macro [$inst getName] is not placed."
-      } else {
-        lappend blockages $inst
+    foreach inst [$dbBlock getInsts] {
+      if { [$inst isBlock] } {
+        if { ![$inst isPlaced] } {
+          utl::warn PPL 15 "Macro [$inst getName] is not placed."
+        } else {
+          lappend blockages $inst
+        }
       }
     }
-  }
-
-  utl::report "Found [llength $blockages] macro blocks."
-
-  if { [info exists keys(-hor_layers)] } {
-    set hor_layers $keys(-hor_layers)
-  } else {
-    utl::error PPL 17 "-hor_layers is required."
-  }
 
-  if { [info exists keys(-ver_layers)] } {
-    set ver_layers $keys(-ver_layers)
-  } else {
-    utl::error PPL 18 "-ver_layers is required."
-  }
+    utl::report "Found [llength $blockages] macro blocks."
 
-  # set default interval_length from boundaries as 1u
-  set distance 1
-  if { [info exists keys(-corner_avoidance)] } {
-    set distance $keys(-corner_avoidance)
-    ppl::set_corner_avoidance [ord::microns_to_dbu $distance]
-  }
+    if { [info exists keys(-hor_layers)] } {
+      set hor_layers $keys(-hor_layers)
+    } else {
+      utl::error PPL 17 "-hor_layers is required."
+    }
 
-  set min_dist 2
-  set dist_in_tracks [info exists flags(-min_distance_in_tracks)]
-  if { [info exists keys(-min_distance)] } {
-    set min_dist $keys(-min_distance)
-    if { $dist_in_tracks } {
-      ppl::set_min_distance $min_dist
+    if { [info exists keys(-ver_layers)] } {
+      set ver_layers $keys(-ver_layers)
     } else {
-      ppl::set_min_distance [ord::microns_to_dbu $min_dist]
+      utl::error PPL 18 "-ver_layers is required."
     }
-  } else {
-    utl::report "Using $min_dist tracks default min distance between IO pins."
-    # setting min distance as 0u leads to the default min distance
-    ppl::set_min_distance 0
-  }
-  ppl::set_min_distance_in_tracks $dist_in_tracks
 
-  set bterms_cnt [llength [$dbBlock getBTerms]]
+    # set default interval_length from boundaries as 1u
+    set distance 1
+    if { [info exists keys(-corner_avoidance)] } {
+      set distance $keys(-corner_avoidance)
+      ppl::set_corner_avoidance [ord::microns_to_dbu $distance]
+    }
 
-  if { $bterms_cnt == 0 } {
-    utl::error PPL 19 "Design without pins."
-  }
+    set min_dist 2
+    set dist_in_tracks [info exists flags(-min_distance_in_tracks)]
+    if { [info exists keys(-min_distance)] } {
+      set min_dist $keys(-min_distance)
+      if { $dist_in_tracks } {
+        ppl::set_min_distance $min_dist
+      } else {
+        ppl::set_min_distance [ord::microns_to_dbu $min_dist]
+      }
+    } else {
+      utl::report "Using $min_dist tracks default min distance between IO pins."
+      # setting min distance as 0u leads to the default min distance
+      ppl::set_min_distance 0
+    }
+    ppl::set_min_distance_in_tracks $dist_in_tracks
 
+    set bterms_cnt [llength [$dbBlock getBTerms]]
 
-  set num_tracks_y 0
-  foreach hor_layer_name $hor_layers {
-    set hor_layer [ppl::parse_layer_name $hor_layer_name]
-    if { ![ord::db_layer_has_hor_tracks $hor_layer] } {
-      utl::error PPL 21 "Horizontal routing tracks not found for layer $hor_layer_name."
+    if { $bterms_cnt == 0 } {
+      utl::error PPL 19 "Design without pins."
     }
 
-    if { [$hor_layer getDirection] != "HORIZONTAL" } {
-      utl::error PPL 45 "Layer $hor_layer_name preferred direction is not horizontal."
-    }
 
-    set hor_track_grid [$dbBlock findTrackGrid $hor_layer]
+    set num_tracks_y 0
+    foreach hor_layer_name $hor_layers {
+      set hor_layer [ppl::parse_layer_name $hor_layer_name]
+      if { ![ord::db_layer_has_hor_tracks $hor_layer] } {
+        utl::error PPL 21 "Horizontal routing tracks not found for layer $hor_layer_name."
+      }
 
-    set num_tracks_y [expr $num_tracks_y+[llength [$hor_track_grid getGridY]]]
+      if { [$hor_layer getDirection] != "HORIZONTAL" } {
+        utl::error PPL 45 "Layer $hor_layer_name preferred direction is not horizontal."
+      }
 
-    ppl::add_hor_layer $hor_layer
-  }
+      set hor_track_grid [$dbBlock findTrackGrid $hor_layer]
 
-  set num_tracks_x 0
-  foreach ver_layer_name $ver_layers {
-    set ver_layer [ppl::parse_layer_name $ver_layer_name]
-    if { ![ord::db_layer_has_ver_tracks $ver_layer] } {
-      utl::error PPL 23 "Vertical routing tracks not found for layer $ver_layer_name."
-    }
+      set num_tracks_y [expr $num_tracks_y+[llength [$hor_track_grid getGridY]]]
 
-    if { [$ver_layer getDirection] != "VERTICAL" } {
-      utl::error PPL 46 "Layer $ver_layer_name preferred direction is not vertical."
+      ppl::add_hor_layer $hor_layer
     }
 
-    set ver_track_grid [$dbBlock findTrackGrid $ver_layer]
+    set num_tracks_x 0
+    foreach ver_layer_name $ver_layers {
+      set ver_layer [ppl::parse_layer_name $ver_layer_name]
+      if { ![ord::db_layer_has_ver_tracks $ver_layer] } {
+        utl::error PPL 23 "Vertical routing tracks not found for layer $ver_layer_name."
+      }
 
-    set num_tracks_x [expr $num_tracks_x+[llength [$ver_track_grid getGridX]]]
+      if { [$ver_layer getDirection] != "VERTICAL" } {
+        utl::error PPL 46 "Layer $ver_layer_name preferred direction is not vertical."
+      }
 
-    ppl::add_ver_layer $ver_layer
-  }
+      set ver_track_grid [$dbBlock findTrackGrid $ver_layer]
 
-  set num_slots [expr (2*$num_tracks_x + 2*$num_tracks_y)/$min_dist]
+      set num_tracks_x [expr $num_tracks_x+[llength [$ver_track_grid getGridX]]]
 
-  if { [llength $regions] != 0 } {
-    set lef_units [$dbTech getLefUnits]
+      ppl::add_ver_layer $ver_layer
+    }
+
+    set num_slots [expr (2*$num_tracks_x + 2*$num_tracks_y)/$min_dist]
+
+    if { [llength $regions] != 0 } {
+      set lef_units [$dbTech getLefUnits]
 
-    foreach region $regions {
-      exclude_io_pin_region -region $region
+      foreach region $regions {
+        exclude_io_pin_region -region $region
+      }
     }
-  }
 
-  if { [llength $pin_groups] != 0 } {
-    foreach group $pin_groups {
-      set pins [ppl::parse_pin_names "place_pins -group_pins" $group]
-      if { [llength $pins] != 0 } {
-        odb::add_pin_group $pins 0
+    if { [llength $pin_groups] != 0 } {
+      foreach group $pin_groups {
+        set pins [ppl::parse_pin_names "place_pins -group_pins" $group]
+        if { [llength $pins] != 0 } {
+          odb::add_pin_group $pins 0
+        }
       }
     }
-  }
 
-  if { [info exists keys(-write_pin_placement)] } {
-    ppl::set_pin_placement_file $keys(-write_pin_placement)
-  }
+    if { [info exists keys(-write_pin_placement)] } {
+      ppl::set_pin_placement_file $keys(-write_pin_placement)
+    }
 
-  if { [info exists flags(-annealing)] } {
-    ppl::run_annealing
-  } else {
-    ppl::run_hungarian_matching
+    if { [info exists flags(-annealing)] } {
+      ppl::run_annealing
+    } else {
+      ppl::run_hungarian_matching
+    }
   }
 }
 
diff --git a/src/ppl/test/CMakeLists.txt b/src/ppl/test/CMakeLists.txt
@@ -106,6 +106,8 @@ or_integration_tests(
     place_pin_error1
     place_pin_error2
     place_pin_error3
+    random_deprecated1
+    random_deprecated2
     top_layer1
     top_layer2
     top_layer3
diff --git a/src/ppl/test/random_deprecated1.ok b/src/ppl/test/random_deprecated1.ok
@@ -0,0 +1,6 @@
+[INFO ODB-0227] LEF file: Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
+[INFO ODB-0128] Design: gcd
+[INFO ODB-0130]     Created 54 pins.
+[INFO ODB-0131]     Created 88 components and 422 component-terminals.
+[INFO ODB-0133]     Created 54 nets and 88 connections.
+[WARNING PPL-0113] -random and -random_seed are deprecated.
diff --git a/src/ppl/test/random_deprecated1.tcl b/src/ppl/test/random_deprecated1.tcl
@@ -0,0 +1,6 @@
+# gcd_nangate45 IO placement
+source "helpers.tcl"
+read_lef Nangate45/Nangate45.lef
+read_def gcd.def
+
+place_pins -random -hor_layers metal3 -ver_layers metal2 -corner_avoidance 0 -min_distance 0.12
diff --git a/src/ppl/test/random_deprecated2.ok b/src/ppl/test/random_deprecated2.ok
@@ -0,0 +1,6 @@
+[INFO ODB-0227] LEF file: Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
+[INFO ODB-0128] Design: gcd
+[INFO ODB-0130]     Created 54 pins.
+[INFO ODB-0131]     Created 88 components and 422 component-terminals.
+[INFO ODB-0133]     Created 54 nets and 88 connections.
+[WARNING PPL-0113] -random and -random_seed are deprecated.
diff --git a/src/ppl/test/random_deprecated2.tcl b/src/ppl/test/random_deprecated2.tcl
@@ -0,0 +1,6 @@
+# gcd_nangate45 IO placement
+source "helpers.tcl"
+read_lef Nangate45/Nangate45.lef
+read_def gcd.def
+
+place_pins -random_seed 20 -hor_layers metal3 -ver_layers metal2 -corner_avoidance 0 -min_distance 0.12
