Merge pull request #8016 from osamahammad21/odb-chipinst

ODB: add dbChipInst

Author: maliberty

src/odb/include/odb/db.h

@@ -106,6 +106,7 @@ class dbAccessPoint;
 class dbBusPort;
 class dbCellEdgeSpacing;
 class dbChip;
+class dbChipInst;
 class dbDatabase;
 class dbDft;
 class dbGCellGrid;
@@ -7002,6 +7003,8 @@ class dbChip : public dbObject
   ///
   dbBlock* getBlock();
 
+  dbSet<dbChipInst> getChipInsts() const;
+
   ///
   /// Create a new chip.
   /// Returns nullptr if there is no database technology.
@@ -7022,6 +7025,34 @@ class dbChip : public dbObject
   // User Code End dbChip
 };
 
+class dbChipInst : public dbObject
+{
+ public:
+  std::string getName() const;
+
+  void setLoc(const Point3D& loc);
+
+  Point3D getLoc() const;
+
+  dbChip* getMasterChip() const;
+
+  dbChip* getParentChip() const;
+
+  // User Code Begin dbChipInst
+  void setOrient(const dbOrientType& orient);
+
+  dbOrientType getOrient() const;
+
+  dbTransform getTransform() const;
+
+  static odb::dbChipInst* create(dbChip* parent_chip,
+                                 dbChip* master_chip,
+                                 const std::string& name);
+
+  static void destroy(dbChipInst* chipInst);
+  // User Code End dbChipInst
+};
+
 class dbDatabase : public dbObject
 {
  public:
@@ -7031,6 +7062,8 @@ class dbDatabase : public dbObject
 
   dbSet<dbProperty> getProperties() const;
 
+  dbSet<dbChipInst> getChipInsts() const;
+
   // User Code Begin dbDatabase
 
   void setTopChip(dbChip* chip);

src/odb/include/odb/dbCompare.h

@@ -479,6 +479,15 @@ struct less<odb::dbChip*>
   }
 };
 
+template <>
+struct less<odb::dbChipInst*>
+{
+  bool operator()(const odb::dbChipInst* lhs, const odb::dbChipInst* rhs) const
+  {
+    return odb::compare_by_id(lhs, rhs);
+  }
+};
+
 template <>
 struct less<odb::dbDatabase*>
 {

src/odb/include/odb/dbObject.h

@@ -61,6 +61,7 @@ enum dbObjectType
   dbBusPortObj,
   dbCellEdgeSpacingObj,
   dbChipObj,
+  dbChipInstObj,
   dbDatabaseObj,
   dbDftObj,
   dbGCellGridObj,

src/odb/include/odb/geom.h

@@ -57,13 +57,51 @@ class Point
   friend dbIStream& operator>>(dbIStream& stream, Point& p);
   friend dbOStream& operator<<(dbOStream& stream, const Point& p);
 
- private:
+ protected:
   int x_ = 0;
   int y_ = 0;
 };
 
 std::ostream& operator<<(std::ostream& os, const Point& pIn);
 
+class Point3D
+{
+ public:
+  Point3D() = default;
+  Point3D(int x, int y, int z) : x_(x), y_(y), z_(z) {}
+  Point3D& operator=(const Point3D&) = default;
+  Point3D(const Point3D& p) : x_(p.x()), y_(p.y()), z_(p.z()) {}
+  Point3D(const Point& p, int z) : x_(p.x()), y_(p.y()), z_(z) {}
+
+  bool operator==(const Point3D& rhs) const;
+  bool operator!=(const Point3D& rhs) const { return !(*this == rhs); }
+  bool operator<(const Point3D& rhs) const;
+  bool operator>=(const Point3D& rhs) const { return !(*this < rhs); }
+
+  int z() const { return z_; }
+  void setZ(int z) { z_ = z; }
+  int x() const { return x_; }
+  void setX(int x) { x_ = x; }
+  int y() const { return y_; }
+  void setY(int y) { y_ = y; }
+  void set(const int x, const int y, const int z)
+  {
+    setX(x);
+    setY(y);
+    setZ(z);
+  }
+
+  friend dbIStream& operator>>(dbIStream& stream, Point3D& p);
+  friend dbOStream& operator<<(dbOStream& stream, const Point3D& p);
+
+ private:
+  int x_ = 0;
+  int y_ = 0;
+  int z_ = 0;
+};
+
+std::ostream& operator<<(std::ostream& os, const Point3D& pIn);
+
 /*
 an Oct represents a 45-degree routing segment as 2 connected octagons
 
@@ -443,6 +481,16 @@ inline bool Point::operator<(const Point& rhs) const
   return std::tie(x_, y_) < std::tie(rhs.x_, rhs.y_);
 }
 
+inline bool Point3D::operator==(const Point3D& rhs) const
+{
+  return std::tie(x_, y_, z_) == std::tie(rhs.x_, rhs.y_, rhs.z_);
+}
+
+inline bool Point3D::operator<(const Point3D& rhs) const
+{
+  return std::tie(x_, y_, z_) < std::tie(rhs.x_, rhs.y_, rhs.z_);
+}
+
 inline bool Rect::operator<(const Rect& rhs) const
 {
   return std::tie(xlo_, ylo_, xhi_, yhi_)

src/odb/src/codeGenerator/gen.py

@@ -128,10 +128,12 @@ def add_field_attributes(field, klass, flags_struct, schema):
     field["isHashTable"] = is_hash_table(field["type"])
     field["hashTableType"] = get_hash_table_type(field["type"])
     field["isPassByRef"] = is_pass_by_ref(field["type"])
-    field["isSetByRef"] = is_set_by_ref(field["type"])
+    field.setdefault("flags", [])
+    field["isSetByRef"] = "set-const-ref" in field["flags"] or is_set_by_ref(
+        field["type"]
+    )
     if "argument" not in field:
         field["argument"] = field["name"].strip("_")
-    field.setdefault("flags", [])
     if "private" in field["flags"]:
         field["flags"].append("no-set")
         field["flags"].append("no-get")

src/odb/src/codeGenerator/schema.json

@@ -162,6 +162,15 @@
       "orderReversed": "true",
       "sequential": 0,
       "includes": ["dbScanList.h", "dbScanInst.h"]
+    },
+    {
+      "name": "dbChipInstItr",
+      "parentObject": "dbChipInst",
+      "tableName": "chip_inst_tbl",
+      "reversible": "true",
+      "orderReversed": "true",
+      "sequential": 0,
+      "includes": ["dbChipInst.h", "dbChip.h"]
     }
   ],
   "relations":[
@@ -387,6 +396,14 @@
       "type":"1_n",
       "tbl_name":"_prop_tbl",
       "flags": ["no-serial"]
+    },
+    {
+      "parent":"dbDatabase",
+      "child":"dbChipInst",
+      "type":"1_n",
+      "tbl_name":"chip_inst_tbl_",
+      "schema":"db_schema_chip_inst",
+      "flags": ["no-serial"]
     }
   ]
 }

src/odb/src/codeGenerator/schema/chip/dbChip.json

@@ -142,6 +142,12 @@
       "name": "_prop_itr",
       "type": "dbPropertyItr*",
       "flags": ["private", "no-cmp", "no-serial"]
+    },
+    {
+      "name": "chipinsts_",
+      "type": "dbId<_dbChipInst>",
+      "flags": ["private"],
+      "schema":"db_schema_chip_inst"
     }
   ],
   "declared_classes": ["dbPropertyItr", "_dbNameCache","dbBlockItr"],

src/odb/src/codeGenerator/schema/chip/dbChipInst.json

@@ -0,0 +1,43 @@
+{
+  "name": "dbChipInst",
+  "type": "dbObject",
+  "fields": [
+    {
+      "name": "name_",
+      "type": "std::string",
+      "flags":["cmpgt", "no-set"]
+    },
+    {
+      "name": "loc_",
+      "type": "Point3D",
+      "flags":["cmpgt", "set-const-ref"]
+    },
+    {
+      "name": "orient_",
+      "type": "dbOrientType::Value",
+      "flags": ["private" ,"cmpgt", "no-serial"]
+    },
+    {
+      "name": "master_chip_",
+      "type": "dbId<_dbChip>",
+      "flags": ["no-set"],
+      "parent" : "dbDatabase"
+    },
+    {
+      "name": "parent_chip_",
+      "type": "dbId<_dbChip>",
+      "flags": ["no-set"],
+      "parent":"dbDatabase"
+    },
+    {
+      "name":"chipinst_next_",
+      "type":"dbId<_dbChipInst>",
+      "flags":["private"]
+    }
+  ],
+  "h_includes": [
+    "odb/geom.h",
+    "odb/dbTypes.h"
+  ],
+  "cpp_includes": []
+}

src/odb/src/db/CMakeLists.txt

@@ -88,6 +88,7 @@ add_library(db
     dbBusPort.cpp
     dbCellEdgeSpacing.cpp
     dbChip.cpp
+    dbChipInst.cpp
     dbDatabase.cpp
     dbDft.cpp
     dbGCellGrid.cpp
@@ -144,6 +145,7 @@ add_library(db
     dbTechLayerTwoWiresForbiddenSpcRule.cpp
     dbTechLayerWidthTableRule.cpp
     dbTechLayerWrongDirSpacingRule.cpp
+    dbChipInstItr.cpp
     dbGroupInstItr.cpp
     dbGroupItr.cpp
     dbGroupModInstItr.cpp

src/odb/src/db/dbChip.cpp

@@ -15,6 +15,10 @@
 #include "dbTech.h"
 #include "odb/db.h"
 #include "odb/dbSet.h"
+// User Code Begin Includes
+#include "dbChipInst.h"
+#include "dbChipInstItr.h"
+// User Code End Includes
 namespace odb {
 template class dbTable<_dbChip>;
 
@@ -71,6 +75,9 @@ bool _dbChip::operator==(const _dbChip& rhs) const
   if (_top != rhs._top) {
     return false;
   }
+  if (chipinsts_ != rhs.chipinsts_) {
+    return false;
+  }
   if (*_prop_tbl != *rhs._prop_tbl) {
     return false;
   }
@@ -181,6 +188,9 @@ dbIStream& operator>>(dbIStream& stream, _dbChip& obj)
     stream >> obj.tsv_;
   }
   stream >> obj._top;
+  if (obj.getDatabase()->isSchema(db_schema_chip_inst)) {
+    stream >> obj.chipinsts_;
+  }
   // User Code Begin >>
   stream >> *obj._block_tbl;
   stream >> *obj._prop_tbl;
@@ -212,6 +222,7 @@ dbOStream& operator<<(dbOStream& stream, const _dbChip& obj)
   stream << obj.scribe_line_south_;
   stream << obj.tsv_;
   stream << obj._top;
+  stream << obj.chipinsts_;
   // User Code Begin <<
   stream << *obj._block_tbl;
   stream << NamedTable("prop_tbl", obj._prop_tbl);
@@ -475,6 +486,13 @@ dbBlock* dbChip::getBlock()
   return (dbBlock*) chip->_block_tbl->getPtr(chip->_top);
 }
 
+dbSet<dbChipInst> dbChip::getChipInsts() const
+{
+  _dbChip* chip = (_dbChip*) this;
+  _dbDatabase* db = (_dbDatabase*) chip->getOwner();
+  return dbSet<dbChipInst>(chip, db->chip_inst_itr_);
+}
+
 dbChip* dbChip::create(dbDatabase* db_, const std::string& name, ChipType type)
 {
   _dbDatabase* db = (_dbDatabase*) db_;