Merge pull request The-OpenROAD-Project#6870 from eder-matheus/ppl_odb_exclude

ppl/odb: add function to define excluded regions for pin placement

Author: maliberty

src/odb/src/db/odb.tcl

@@ -682,7 +682,7 @@ sta::define_cmd_args "set_io_pin_constraint" {[-direction direction] \
                                               [-pin_names names] \
                                               [-region region] \
                                               [-mirrored_pins pins] \
-                                              [-group]
+                                              [-group] \
                                               [-order]}
 
 proc set_io_pin_constraint { args } {
@@ -795,6 +795,54 @@ proc set_io_pin_constraint { args } {
   }
 }
 
+sta::define_cmd_args "exclude_io_pin_region" { [-region region] }
+
+proc exclude_io_pin_region { args } {
+  ord::parse_list_args "exclude_io_pin_region" args list {-region}
+  sta::parse_key_args "exclude_io_pin_region" args keys {-region} flags {}
+
+  sta::check_argc_eq0 "exclude_io_pin_region" $args
+
+  set regions $list(-region)
+
+  if { [llength $regions] != 0 } {
+    set block [odb::get_block]
+    set db_tech [ord::get_db_tech]
+    set lef_units [$db_tech getLefUnits]
+
+    foreach region $regions {
+      if { [regexp -all {(top|bottom|left|right):(.+)} $region - edge interval] } {
+        if {
+          [regexp -all {([0-9]+[.]*[0-9]*|[*]+)-([0-9]+[.]*[0-9]*|[*]+)} $interval - begin end]
+        } {
+          if { $begin == "*" } {
+            set begin [ppl::get_edge_extreme "-exclude" 1 $edge]
+          }
+          if { $end == "*" } {
+            set end [ppl::get_edge_extreme "-exclude" 0 $edge]
+          }
+          set begin [expr { int($begin * $lef_units) }]
+          set end [expr { int($end * $lef_units) }]
+          
+          set excluded_region [$block findConstraintRegion $edge $begin $end]
+          $block addBlockedRegionForPins $excluded_region
+        } elseif { $interval == "*" } {
+          set begin [ppl::get_edge_extreme "-exclude" 1 $edge]
+          set end [ppl::get_edge_extreme "-exclude" 0 $edge]
+
+          set excluded_region [$block findConstraintRegion $edge $begin $end]
+          $block addBlockedRegionForPins $excluded_region
+        } else {
+          utl::error ODB 27 "-exclude: $interval is an invalid region."
+        }
+      } else {
+        utl::error ODB 28 "-exclude: invalid syntax in $region.\
+          Use (top|bottom|left|right):interval."
+      }
+    }
+  }
+}
+
 sta::define_cmd_args "clear_io_pin_constraints" {}
 
 proc clear_io_pin_constraints { args } {

src/ppl/README.md

@@ -95,6 +95,25 @@ pin placement grid defined with `define_pin_shape_pattern` use:
 The `up` option is only available when the pin placement grid is created with
 the `define_pin_shape_pattern` command.
 
+### Exclude IO Pin Region
+
+The `exclude_io_pin_region` command sets regions in the die edges where pins
+cannot be placed.
+
+It is possible to use the `-region` argument multiple times in a single call
+of `exclude_io_pin_region`.
+
+```tcl
+exclude_io_pin_region 
+    [-region edge:interval]
+```
+
+#### Options
+
+| Switch Name | Description |
+| ----- | ----- |
+| `-region` | Syntax is `-region edge:interval`. The `edge` values are (`top\|bottom\|left\|right`). The `interval` can be the whole edge with the wildcard `*` value or a range of values. |
+
 ### Clear IO Pin Constraints
 
 The `clear_io_pin_constraints` command clears all the previously-defined
@@ -263,7 +282,7 @@ place_pins
 | `-corner_avoidance` | The distance (in microns) from each corner within which pin placement should be avoided. |
 | `-min_distance` | The minimum distance between pins on the die boundary. This distance can be in microns (default) or in number of tracks between each pin. The default value is the length of two routing tracks between each pin. |
 | `-min_distance_in_tracks` | Flag that allows setting the min distance in number of tracks instead of microns. |
-| `-exclude` | A region where pins cannot be placed. Either `top|bottom|left|right:edge_interval`, which is the edge interval from the selected edge; `begin:end` for begin-end of all edges. |
+| `-exclude` | A region where pins cannot be placed. Either `top\|bottom\|left\|right:edge_interval`, which is the edge interval from the selected edge; `begin:end` for begin-end of all edges. |
 | `-group_pins` | A list of pins to be placed together on the die boundary. |
 | `-annealing` | Flag to enable simulated annealing pin placement. |
 | `-write_pin_placement` | A file with the pin placement generated in the format of multiple calls for the `place_pin` command. |

src/ppl/include/ppl/IOPlacer.h

@@ -207,6 +207,7 @@ class IOPlacer
   std::vector<Section> createSectionsPerConstraint(Constraint& constraint);
   void getPinsFromDirectionConstraint(Constraint& constraint);
   void initMirroredPins(bool annealing = false);
+  void initExcludedIntervals();
   Interval findIntervalFromRect(const odb::Rect& rect);
   void getConstraintsFromDB();
   void initConstraints(bool annealing = false);

src/ppl/src/IOPlacer.cpp

@@ -1895,6 +1895,15 @@ void IOPlacer::initMirroredPins(bool annealing)
   }
 }
 
+void IOPlacer::initExcludedIntervals()
+{
+  for (const odb::Rect& excluded_region :
+       getBlock()->getBlockedRegionsForPins()) {
+    Interval excluded_interv = findIntervalFromRect(excluded_region);
+    excluded_intervals_.push_back(excluded_interv);
+  }
+}
+
 Interval IOPlacer::findIntervalFromRect(const odb::Rect& rect)
 {
   int begin;
@@ -2211,7 +2220,7 @@ void IOPlacer::updateSlots()
 void IOPlacer::runHungarianMatching(bool random_mode)
 {
   slots_per_section_ = parms_->getSlotsPerSection();
-
+  initExcludedIntervals();
   initNetlistAndCore(hor_layers_, ver_layers_);
   getBlockedRegionsFromMacros();
 
@@ -2355,6 +2364,7 @@ void IOPlacer::setAnnealingDebugNoPauseMode(const bool no_pause_mode)
 void IOPlacer::runAnnealing(bool random)
 {
   slots_per_section_ = parms_->getSlotsPerSection();
+  initExcludedIntervals();
   initNetlistAndCore(hor_layers_, ver_layers_);
   getBlockedRegionsFromMacros();
 

src/ppl/src/IOPlacer.tcl

@@ -463,34 +463,7 @@ proc place_pins { args } {
     set lef_units [$dbTech getLefUnits]
 
     foreach region $regions {
-      if { [regexp -all {(top|bottom|left|right):(.+)} $region - edge interval] } {
-        set edge_ [ppl::parse_edge "-exclude" $edge]
-
-        if {
-          [regexp -all {([0-9]+[.]*[0-9]*|[*]+)-([0-9]+[.]*[0-9]*|[*]+)} $interval - begin end]
-        } {
-          if { $begin == "*" } {
-            set begin [ppl::get_edge_extreme "-exclude" 1 $edge]
-          }
-          if { $end == "*" } {
-            set end [ppl::get_edge_extreme "-exclude" 0 $edge]
-          }
-          set begin [expr { int($begin * $lef_units) }]
-          set end [expr { int($end * $lef_units) }]
-
-          ppl::exclude_interval $edge_ $begin $end
-        } elseif { $interval == "*" } {
-          set begin [ppl::get_edge_extreme "-exclude" 1 $edge]
-          set end [ppl::get_edge_extreme "-exclude" 0 $edge]
-
-          ppl::exclude_interval $edge_ $begin $end
-        } else {
-          utl::error PPL 25 "-exclude: $interval is an invalid region."
-        }
-      } else {
-        utl::error PPL 26 "-exclude: invalid syntax in $region.\
-          Use (top|bottom|left|right):interval."
-      }
+      exclude_io_pin_region -region $region
     }
   }
 

src/ppl/test/CMakeLists.txt

@@ -51,6 +51,7 @@ or_integration_tests(
     exclude1
     exclude2
     exclude3
+    exclude4
     gcd
     group_pins1
     group_pins2