Merge pull request #8920 from The-OpenROAD-Project-staging/odb-refactor

Odb refactor dbBox/dbSBox

Author: maliberty

src/dpl/src/PlacementDRC.cpp

@@ -13,6 +13,7 @@
 #include "odb/dbTransform.h"
 #include "odb/dbTypes.h"
 #include "odb/geom.h"
+#include "odb/isotropy.h"
 
 namespace dpl {
 
@@ -36,7 +37,7 @@ odb::Rect transformEdgeRect(const odb::Rect& edge_rect,
 odb::Rect getQueryRect(const odb::Rect& edge_box, const int spc)
 {
   odb::Rect query_rect(edge_box);
-  bool is_vertical_edge = edge_box.getDir() == 0;
+  bool is_vertical_edge = edge_box.getDir() == odb::vertical;
   if (is_vertical_edge) {
     // vertical edge
     query_rect = query_rect.bloat(spc, odb::Orientation2D::Horizontal);
@@ -89,7 +90,7 @@ bool PlacementDRC::checkEdgeSpacing(const Node* cell,
                   + 1;  // +1 to account for EXACT rules
     odb::Rect edge1_box = cell_edges::transformEdgeRect(
         edge1.getBBox(), cell, x_real, y_real, orient);
-    bool is_vertical_edge = edge1_box.getDir() == 0;
+    bool is_vertical_edge = edge1_box.getDir() == odb::vertical;
     odb::Rect query_rect = cell_edges::getQueryRect(edge1_box, max_spc);
     GridX xMin = grid_->gridX(DbuX(query_rect.xMin()));
     GridX xMax = grid_->gridEndX(DbuX(query_rect.xMax()));

src/dpl/src/infrastructure/Grid.cpp

@@ -149,7 +149,7 @@ void Grid::markBlocked(odb::dbBlock* block)
           if (routing_level <= 1 || routing_level > 3) {  // considering M2, M3
             return;
           }
-          if (wire_rect.getDir() == 1) {  // horizontal
+          if (wire_rect.getDir() == odb::horizontal) {
             return;
           }
           wire_rect.moveDelta(-core.xMin(), -core.yMin());

src/drt/src/gc/FlexGC_main.cpp

@@ -21,6 +21,7 @@
 #include "gc/FlexGC_impl.h"
 #include "odb/dbTypes.h"
 #include "odb/geom.h"
+#include "odb/isotropy.h"
 
 using odb::dbTechLayerType;
 
@@ -3873,7 +3874,8 @@ void FlexGCWorker::Impl::patchMetalShape_minStep()
           } else {
             continue;
           }
-          if (enc_box.getDir() == 1 && markerBBox.yMin() == enc_box.yMin()
+          if (enc_box.getDir() == odb::horizontal
+              && markerBBox.yMin() == enc_box.yMin()
               && markerBBox.yMax() == enc_box.yMax()) {
             int bloating_dist = std::max(0, min_step_length - markerBBox.dx());
             if (markerBBox.xMin() >= enc_box.xMin()
@@ -3885,7 +3887,7 @@ void FlexGCWorker::Impl::patchMetalShape_minStep()
             } else {
               continue;
             }
-          } else if (enc_box.getDir() == 0
+          } else if (enc_box.getDir() == odb::vertical
                      && markerBBox.xMin() == enc_box.xMin()
                      && markerBBox.xMax() == enc_box.xMax()) {
             int bloating_dist = std::max(0, min_step_length - markerBBox.dy());

src/drt/src/io/io.cpp

@@ -958,9 +958,7 @@ void io::Parser::updateNetRouting(frNet* netIn, odb::dbNet* net)
               == getTech()->name2via_.end()) {
             logger_->error(DRT, 109, "Unsupported via in db.");
           } else {
-            int x, y;
-            box->getViaXY(x, y);
-            odb::Point p(x, y);
+            const odb::Point p = box->getViaXY();
             auto viaDef = getTech()->name2via_[viaName];
             auto tmpP = std::make_unique<frVia>(viaDef);
             tmpP->setOrigin(p);
@@ -2666,11 +2664,10 @@ void io::Parser::setMasters(odb::dbDatabase* db)
                               master->getName(),
                               _term->getName());
               }
-              int x, y;
-              box->getViaXY(x, y);
+              const odb::Point pt = box->getViaXY();
               auto viaDef = getTech()->name2via_[box->getTechVia()->getName()];
               auto tmpP = std::make_unique<frVia>(viaDef);
-              tmpP->setOrigin({x, y});
+              tmpP->setOrigin(pt);
               // layer1 rect
               addPinFig(
                   tmpP->getLayer1BBox(), viaDef->getLayer1Num(), pinIn.get());

src/odb/include/odb/db.h

@@ -192,74 +192,69 @@ class dbBox : public dbObject
   ///
   /// Get the lower coordinate.
   ///
-  int xMin();
+  int xMin() const;
 
   ///
   /// Get the lower y coordinate.
   ///
-  int yMin();
+  int yMin() const;
 
   ///
   /// Get the high x coordinate.
   ///
-  int xMax();
+  int xMax() const;
 
   ///
   /// Get the high y coordinate.
   ///
-  int yMax();
+  int yMax() const;
 
   ///
   /// Returns true if this box represents a via
   ///
-  bool isVia();
+  bool isVia() const;
 
   ///
   /// Get tech-via this box represents.
   /// returns nullptr if this box does not represent a tech-via
   ///
-  dbTechVia* getTechVia();
+  dbTechVia* getTechVia() const;
 
   ///
   /// Get block-via this box represents.
   /// returns nullptr if this box does not represent a block-via
   ///
-  dbVia* getBlockVia();
-
-  ///
-  /// Return the placed location of this via.
-  ///
-  void getViaXY(int& x, int& y);
+  dbVia* getBlockVia() const;
 
   ///
   /// Return the placed location of this via.
   ///
-  Point getViaXY();
+  Point getViaXY() const;
 
   ///
   /// Get the box bounding points.
   ///
-  Rect getBox();
+  Rect getBox() const;
 
   ///
   /// Get the translated boxes of this via
   ///
-  void getViaBoxes(std::vector<dbShape>& shapes);
+  void getViaBoxes(std::vector<dbShape>& shapes) const;
 
   ///
   /// Get the translated boxes of this via on the given layer
   ///
-  void getViaLayerBoxes(dbTechLayer* layer, std::vector<dbShape>& shapes);
+  void getViaLayerBoxes(dbTechLayer* layer, std::vector<dbShape>& shapes) const;
 
   ///
-  /// Get the width (xMax-xMin) of the box.
+  /// Get the orientation of the box.
   ///
-  int getDir();
+  Orientation2D getDir() const;
 
   ///
   /// Get the width (xMax-xMin) of the box.
   ///
-  uint getDX();
+  uint getDX() const;
 
   int getDesignRuleWidth() const;
 
@@ -268,25 +263,25 @@ class dbBox : public dbObject
   ///
   /// Get the height (yMax-yMin) of the box.
   ///
-  uint getDY();
-  uint getWidth(uint dir = 1);
-  uint getLength(uint dir = 1);
+  uint getDY() const;
+  uint getWidth(uint dir = 1) const;
+  uint getLength(uint dir = 1) const;
 
   ///
   /// Set temporary flag visited
   ///
   void setVisited(bool value);
-  bool isVisited();
+  bool isVisited() const;
 
   ///
   /// Get the owner of this box
   ///
-  dbObject* getBoxOwner();
+  dbObject* getBoxOwner() const;
 
   ///
   /// Get the owner type of this box
   ///
-  dbBoxOwner getOwnerType();
+  dbBoxOwner getOwnerType() const;
 
   ///
   /// Get the layer of this box.
@@ -300,13 +295,13 @@ class dbBox : public dbObject
   /// These bboxes have no layer.
   ///    All dbBox(s) that represent VIA's.
   ///
-  dbTechLayer* getTechLayer();
+  dbTechLayer* getTechLayer() const;
 
   ///
   /// Get the layer mask assigned to this box.
   /// Returns 0 is not assigned or bbox has no layer
   ///
-  uint getLayerMask();
+  uint getLayerMask() const;
 
   ///
   /// Sets the layer mask for this box.
@@ -433,37 +428,37 @@ class dbSBox : public dbBox
   ///
   /// Get the shape type of this wire.
   ///
-  dbWireShapeType getWireShapeType();
+  dbWireShapeType getWireShapeType() const;
 
   ///
   /// Return the specified direction of this segment
   ///
-  Direction getDirection();
+  Direction getDirection() const;
 
   ///
   /// Get the swire of this shape
   ///
-  dbSWire* getSWire();
+  dbSWire* getSWire() const;
 
   ///
   /// Get Oct Wire Shape
   ///
-  Oct getOct();
+  Oct getOct() const;
 
   ///
   /// Get via mask for bottom layer of via
   ///
-  uint getViaBottomLayerMask();
+  uint getViaBottomLayerMask() const;
 
   ///
   /// Get via mask for cut layer of via
   ///
-  uint getViaCutLayerMask();
+  uint getViaCutLayerMask() const;
 
   ///
   /// Get via mask for top layer of via
   ///
-  uint getViaTopLayerMask();
+  uint getViaTopLayerMask() const;
 
   ///
   /// Set via masks
@@ -473,7 +468,7 @@ class dbSBox : public dbBox
   ///
   /// Has via mask
   ///
-  bool hasViaLayerMasks();
+  bool hasViaLayerMasks() const;
 
   ///
   /// Create a set of new sboxes from a via array

src/odb/include/odb/dbShape.h

@@ -364,8 +364,7 @@ class dbInstShapeItr
   dbTechVia* _via;
   dbSet<dbBox> _via_boxes;
   dbSet<dbBox>::iterator _via_box_itr;
-  int _via_x;
-  int _via_y;
+  Point _via_pt;
   bool _expand_vias;
   int _prev_state;
 
@@ -399,8 +398,7 @@ class dbITermShapeItr
   dbTechVia* _via;
   dbSet<dbBox> _via_boxes;
   dbSet<dbBox>::iterator _via_box_itr;
-  int _via_x;
-  int _via_y;
+  Point _via_pt;
   bool _expand_vias;
 
   void getShape(dbBox* box, dbShape& shape);

src/odb/include/odb/geom.h

@@ -352,7 +352,7 @@ class Rect
 
   int minDXDY() const;
   int maxDXDY() const;
-  int getDir() const;
+  Orientation2D getDir() const;
 
   void set_xlo(int x);
   void set_xhi(int x);
@@ -669,17 +669,14 @@ inline int Rect::maxDXDY() const
   return std::max(dx(), dy());
 }
 
-inline int Rect::getDir() const
+inline Orientation2D Rect::getDir() const
 {
   const int DX = dx();
   const int DY = dy();
   if (DX < DY) {
-    return 0;
+    return vertical;
   }
-  if (DX > DY) {
-    return 1;
-  }
-  return -1;
+  return horizontal;
 }
 
 inline void Rect::moveTo(int x, int y)

src/odb/include/odb/isotropy.h

@@ -87,6 +87,7 @@ class Orientation2D
   Orientation2D& operator=(const Orientation2D& other) = default;
 
   constexpr operator Value() const { return static_cast<Value>(value_); }
+  Value value() const { return static_cast<Value>(value_); }  // for swig
 
   // [Horizontal -> Vertical] [Vertical -> Horizontal]
   Orientation2D turn_90() const { return Value(value_ ^ 1); }
@@ -289,6 +290,8 @@ inline constexpr Direction2D north{Direction2D::North};
 inline constexpr Direction3D down{Direction3D::Down};
 inline constexpr Direction3D up{Direction3D::Up};
 
+#ifndef SWIG
 using utl::format_as;
+#endif
 
 }  // namespace odb

src/odb/src/db/dbBPin.cpp

@@ -251,9 +251,9 @@ void dbBPin::destroy(dbBPin* bpin_)
   dbId<_dbBox> nextBox = bpin->_boxes;
   while (nextBox) {
     _dbBox* b = block->_box_tbl->getPtr(nextBox);
-    nextBox = b->_next_box;
+    nextBox = b->next_box_;
     dbProperty::destroyProperties(b);
-    block->remove_rect(b->_shape._rect);
+    block->remove_rect(b->shape_.rect);
     block->_box_tbl->destroy(b);
   }
 
@@ -294,7 +294,7 @@ void _dbBPin::removeBox(_dbBox* box)
   dbId<_dbBox> boxid = box->getOID();
   if (boxid == _boxes) {
     // at head of list, need to move head
-    _boxes = box->_next_box;
+    _boxes = box->next_box_;
   } else {
     // in the middle of the list, need to iterate and relink
     dbId<_dbBox> id = _boxes;
@@ -303,10 +303,10 @@ void _dbBPin::removeBox(_dbBox* box)
     }
     while (id != 0) {
       _dbBox* nbox = block->_box_tbl->getPtr(id);
-      dbId<_dbBox> nid = nbox->_next_box;
+      dbId<_dbBox> nid = nbox->next_box_;
 
       if (nid == boxid) {
-        nbox->_next_box = box->_next_box;
+        nbox->next_box_ = box->next_box_;
         break;
       }