Merge pull request #7108 from eder-matheus/ppl_top_layer_grid

ppl: move top layer grid definition to odb

Author: eder-matheus

src/odb/include/odb/db.h

@@ -892,6 +892,26 @@ class dbBlock : public dbObject
     std::vector<dbBTerm*> bterms;
     bool order = false;
   };
+
+  struct dbBTermTopLayerGrid
+  {
+    // The single top-most routing layer of the placement grid.
+    dbTechLayer* layer = nullptr;
+    // The distance between each valid position on the grid in the x- and
+    // y-directions, respectively.
+    int x_step = 0;
+    int y_step = 0;
+    // The region of the placement grid.
+    Polygon region;
+    // The width and height of the pins assigned to this grid. The centers of
+    // the pins are placed on the grid positions.
+    int pin_width = 0;
+    int pin_height = 0;
+    // The boundary around existing routing obstructions that the pins should
+    // avoid.
+    int keepout = 0;
+  };
+
   ///
   /// Get block chip name.
   ///
@@ -971,6 +991,21 @@ class dbBlock : public dbObject
   ///
   void addBTermGroup(const std::vector<dbBTerm*>& bterms, bool order);
 
+  ///
+  /// Define the top layer grid for pin placement.
+  ///
+  void setBTermTopLayerGrid(const dbBTermTopLayerGrid& top_layer_grid);
+
+  ///
+  /// Get the top layer grid for pin placement.
+  ///
+  std::optional<dbBTermTopLayerGrid> getBTermTopLayerGrid();
+
+  ///
+  /// Get only the polygon corresponding to the top layer grid region.
+  ///
+  Polygon getBTermTopLayerGridRegion();
+
   ///
   /// Find the rectangle corresponding to the constraint region in a specific
   /// edge of the die area.

src/odb/include/odb/util.h

@@ -19,6 +19,9 @@ class dbBlock;
 class dbBox;
 class dbDatabase;
 class dbNet;
+class dbTechLayer;
+class Rect;
+class Polygon;
 
 // A class that implements an array that can grow efficiently
 template <class T>
@@ -207,6 +210,15 @@ void cutRows(dbBlock* block,
 // individual macro placement
 std::string generateMacroPlacementString(dbBlock* block);
 
+void set_bterm_top_layer_grid(dbBlock* block,
+                              dbTechLayer* layer,
+                              int x_step,
+                              int y_step,
+                              Rect region,
+                              int width,
+                              int height,
+                              int keepout);
+
 class WireLengthEvaluator
 {
  public:

src/odb/src/db/dbBlock.cpp

@@ -719,6 +719,30 @@ dbIStream& operator>>(dbIStream& stream, _dbBTermGroup& obj)
   return stream;
 }
 
+dbOStream& operator<<(dbOStream& stream, const _dbBTermTopLayerGrid& obj)
+{
+  stream << obj.layer;
+  stream << obj.x_step;
+  stream << obj.y_step;
+  stream << obj.region;
+  stream << obj.pin_width;
+  stream << obj.pin_height;
+  stream << obj.keepout;
+  return stream;
+}
+
+dbIStream& operator>>(dbIStream& stream, _dbBTermTopLayerGrid& obj)
+{
+  stream >> obj.layer;
+  stream >> obj.x_step;
+  stream >> obj.y_step;
+  stream >> obj.region;
+  stream >> obj.pin_width;
+  stream >> obj.pin_height;
+  stream >> obj.keepout;
+  return stream;
+}
+
 dbOStream& operator<<(dbOStream& stream, const _dbBlock& block)
 {
   std::list<dbBlockCallBackObj*>::const_iterator cbitr;
@@ -840,6 +864,9 @@ dbOStream& operator<<(dbOStream& stream, const _dbBlock& block)
   if (db->isSchema(db_schema_block_pin_groups)) {
     stream << block._bterm_groups;
   }
+  if (db->isSchema(db_schema_bterm_top_layer_grid)) {
+    stream << block._bterm_top_layer_grid;
+  }
 
   //---------------------------------------------------------- stream out
   // properties
@@ -1012,6 +1039,9 @@ dbIStream& operator>>(dbIStream& stream, _dbBlock& block)
   if (db->isSchema(db_schema_block_pin_groups)) {
     stream >> block._bterm_groups;
   }
+  if (db->isSchema(db_schema_bterm_top_layer_grid)) {
+    stream >> block._bterm_top_layer_grid;
+  }
 
   //---------------------------------------------------------- stream in
   // properties
@@ -1604,6 +1634,99 @@ void dbBlock::addBTermGroup(const std::vector<dbBTerm*>& bterms, bool order)
   block->_bterm_groups.push_back(std::move(group));
 }
 
+void dbBlock::setBTermTopLayerGrid(
+    const dbBlock::dbBTermTopLayerGrid& top_layer_grid)
+{
+  _dbBlock* block = (_dbBlock*) this;
+  _dbBTermTopLayerGrid& top_grid = block->_bterm_top_layer_grid;
+
+  utl::Logger* logger = block->getImpl()->getLogger();
+  const odb::Rect& die_area = getDieArea();
+
+  if (!die_area.contains(top_layer_grid.region.getEnclosingRect())) {
+    logger->error(
+        utl::ODB, 124, "Top layer grid region is out of the die area.");
+  }
+
+  if (top_layer_grid.x_step <= 0) {
+    logger->error(
+        utl::ODB,
+        500,
+        "The x_step for the top layer grid must be greater than zero.");
+  }
+  if (top_layer_grid.y_step <= 0) {
+    logger->error(
+        utl::ODB,
+        501,
+        "The y_step for the top layer grid must be greater than zero.");
+  }
+  if (top_layer_grid.pin_width <= 0) {
+    logger->error(
+        utl::ODB,
+        502,
+        "The pin width for the top layer grid must be greater than zero.");
+  }
+  if (top_layer_grid.pin_height <= 0) {
+    logger->error(
+        utl::ODB,
+        503,
+        "The pin height for the top layer grid must be greater than zero.");
+  }
+  if (top_layer_grid.keepout <= 0) {
+    logger->error(
+        utl::ODB,
+        504,
+        "The pin keepout for the top layer grid must be greater than zero.");
+  }
+
+  top_grid.layer = top_layer_grid.layer->getId();
+  top_grid.x_step = top_layer_grid.x_step;
+  top_grid.y_step = top_layer_grid.y_step;
+  top_grid.region = top_layer_grid.region;
+  top_grid.pin_width = top_layer_grid.pin_width;
+  top_grid.pin_height = top_layer_grid.pin_height;
+  top_grid.keepout = top_layer_grid.keepout;
+}
+
+std::optional<dbBlock::dbBTermTopLayerGrid> dbBlock::getBTermTopLayerGrid()
+{
+  _dbBlock* block = (_dbBlock*) this;
+
+  dbBlock::dbBTermTopLayerGrid top_layer_grid;
+
+  odb::dbTech* tech = getDb()->getTech();
+  if (block->_bterm_top_layer_grid.region.getPoints().empty()) {
+    return std::nullopt;
+  }
+
+  top_layer_grid.layer = odb::dbTechLayer::getTechLayer(
+      tech, block->_bterm_top_layer_grid.layer);
+  top_layer_grid.x_step = block->_bterm_top_layer_grid.x_step;
+  top_layer_grid.y_step = block->_bterm_top_layer_grid.y_step;
+  top_layer_grid.region = block->_bterm_top_layer_grid.region;
+  top_layer_grid.pin_width = block->_bterm_top_layer_grid.pin_width;
+  top_layer_grid.pin_height = block->_bterm_top_layer_grid.pin_height;
+  top_layer_grid.keepout = block->_bterm_top_layer_grid.keepout;
+
+  return top_layer_grid;
+}
+
+Polygon dbBlock::getBTermTopLayerGridRegion()
+{
+  _dbBlock* block = (_dbBlock*) this;
+
+  const Polygon& region = block->_bterm_top_layer_grid.region;
+  if (region.getPoints().empty()) {
+    utl::Logger* logger = block->getImpl()->getLogger();
+    logger->error(utl::ODB,
+                  428,
+                  "Cannot get top layer grid region. Pin placement grid on top "
+                  "layer not created.");
+  }
+
+  return region;
+}
+
 Rect dbBlock::findConstraintRegion(const Direction2D& edge, int begin, int end)
 {
   Rect constraint_region;

src/odb/src/db/dbBlock.h

@@ -125,6 +125,17 @@ struct _dbBTermGroup
   bool order = false;
 };
 
+struct _dbBTermTopLayerGrid
+{
+  dbId<_dbTechLayer> layer;
+  int x_step = 0;
+  int y_step = 0;
+  Polygon region;
+  int pin_width = 0;
+  int pin_height = 0;
+  int keepout = 0;
+};
+
 class _dbBlock : public _dbObject
 {
  public:
@@ -182,6 +193,7 @@ class _dbBlock : public _dbObject
   int _min_layer_for_clock;
   int _max_layer_for_clock;
   std::vector<_dbBTermGroup> _bterm_groups;
+  _dbBTermTopLayerGrid _bterm_top_layer_grid;
 
   // NON-PERSISTANT-STREAMED-MEMBERS
   dbTable<_dbBTerm>* _bterm_tbl;
@@ -309,4 +321,7 @@ dbIStream& operator>>(dbIStream& stream, _dbBlock& block);
 dbOStream& operator<<(dbOStream& stream, const _dbBTermGroup& obj);
 dbIStream& operator>>(dbIStream& stream, _dbBTermGroup& obj);
 
+dbOStream& operator<<(dbOStream& stream, const _dbBTermTopLayerGrid& obj);
+dbIStream& operator>>(dbIStream& stream, _dbBTermTopLayerGrid& obj);
+
 }  // namespace odb

src/odb/src/db/dbDatabase.h

@@ -43,7 +43,10 @@ namespace odb {
 const uint db_schema_major = 0;  // Not used...
 const uint db_schema_initial = 57;
 
-const uint db_schema_minor = 106;  // Current revision number
+const uint db_schema_minor = 107;  // Current revision number
+
+// Revision where dbBTerm top layer grid was added to dbBlock
+const uint db_schema_bterm_top_layer_grid = 107;
 
 // Revision where die area is converted to a polygon
 const uint db_schema_die_area_is_polygon = 106;

src/odb/src/swig/common/odb.i

@@ -75,4 +75,11 @@ using namespace odb;
 %include "odb/wOrder.h"
 
 std::string generateMacroPlacementString(odb::dbBlock* block);
-
+void set_bterm_top_layer_grid(odb::dbBlock* block,
+                              odb::dbTechLayer* layer,
+                              int x_step,
+                              int y_step,
+                              odb::Rect region,
+                              int width,
+                              int height,
+                              int keepout);