Merge pull request #9109 from The-OpenROAD-Project-staging/secure-store-hier-flag-in-odb

odb: Store hierarchy_ flag in odb

Author: maliberty

src/OpenRoad.cc

@@ -504,16 +504,21 @@ void OpenRoad::read3DBloxBMap(const std::string& filename)
   odb::ThreeDBlox parser(logger_, db_);
   parser.readBMap(filename);
 }
+
 void OpenRoad::write3Dbv(const std::string& filename)
 {
   odb::ThreeDBlox writer(logger_, db_, sta_);
   writer.writeDbv(filename, db_->getChip());
 }
+
 void OpenRoad::write3Dbx(const std::string& filename)
 {
   odb::ThreeDBlox writer(logger_, db_, sta_);
   writer.writeDbx(filename, db_->getChip());
 }
+
+// TODO: bool hierarchy should be removed in the future.
+// It is retained for a while for backward compatibility.
 void OpenRoad::readDb(const char* filename, bool hierarchy)
 {
   try {
@@ -523,7 +528,7 @@ void OpenRoad::readDb(const char* filename, bool hierarchy)
     logger_->error(ORD, 54, "odb file {} is invalid: {}", filename, f.what());
   }
   // treat this as a hierarchical network.
-  if (hierarchy) {
+  if (hierarchy || db_->hasHierarchy()) {
     logger_->warn(
         ORD,
         12,

src/OpenRoad.tcl

@@ -233,6 +233,9 @@ sta::define_cmd_args "write_db" {filename}
 sta::define_cmd_args "read_db" {[-hier] filename}
 
 proc read_db { args } {
+  # TODO: -hier is not needed anymore.
+  # - It will be removed in a future release.
+  # - It is currently retained for backward compatibility.
   sta::parse_key_args "read_db" args keys {} flags {-hier}
   sta::check_argc_eq1or2 "read_db" $args
   set filename [file nativename [lindex $args 0]]

src/dbSta/include/db_sta/dbNetwork.hh

@@ -394,9 +394,9 @@ class dbNetwork : public ConcreteNetwork
 
   // hierarchy handler, set in openroad tested in network child traverserser
 
-  void setHierarchy() { hierarchy_ = true; }
-  void disableHierarchy() { hierarchy_ = false; }
-  bool hasHierarchy() const { return hierarchy_; }
+  void setHierarchy() { db_->setHierarchy(true); }
+  void disableHierarchy() { db_->setHierarchy(false); }
+  bool hasHierarchy() const { return db_->hasHierarchy(); }
   bool hasHierarchicalElements() const;
   void reassociateHierFlatNet(dbModNet* mod_net,
                               dbNet* new_flat_net,
@@ -470,7 +470,6 @@ class dbNetwork : public ConcreteNetwork
   static constexpr unsigned DBIDTAG_WIDTH = 0x4;
 
  private:
-  bool hierarchy_ = false;
   std::set<const Cell*> hier_modules_;
   std::set<const Port*> concrete_ports_;
   std::unique_ptr<dbEditHierarchy> hierarchy_editor_;

src/dbSta/src/dbEditHierarchy.cc

@@ -252,7 +252,7 @@ void dbEditHierarchy::hierarchicalConnect(dbITerm* source_pin,
   //
   dbNet* source_db_net = source_pin->getNet();
   dbNet* dest_db_net = dest_pin->getNet();
-  if (db_network_->hierarchy_ == false) {
+  if (db_network_->hasHierarchy() == false) {
     // If both source pin and dest pin do not have a corresponding flat net,
     // Create a new net and connect it with source pin.
     if (source_db_net == nullptr && dest_db_net == nullptr) {

src/dbSta/src/dbNetwork.cc

@@ -768,7 +768,7 @@ ObjectId dbNetwork::id(const Port* port) const
     return std::numeric_limits<ObjectId>::max();
   }
 
-  if (hierarchy_) {
+  if (hasHierarchy()) {
     if (isConcretePort(port)) {
       return ConcreteNetwork::id(port);
     }
@@ -790,7 +790,7 @@ ObjectId dbNetwork::id(const Port* port) const
 ObjectId dbNetwork::id(const Cell* cell) const
 {
   // in hierarchical flow we use the object id for the index
-  if (hierarchy_) {
+  if (hasHierarchy()) {
     if (!isConcreteCell(cell)) {
       const dbObject* obj = reinterpret_cast<const dbObject*>(cell);
       return getDbNwkObjectId(obj);
@@ -808,7 +808,7 @@ ObjectId dbNetwork::id(const Instance* instance) const
   if (instance == top_instance_) {
     return 0;
   }
-  if (hierarchy_) {
+  if (hasHierarchy()) {
     const dbObject* obj = reinterpret_cast<const dbObject*>(instance);
     return getDbNwkObjectId(obj);
   }
@@ -840,7 +840,7 @@ const char* dbNetwork::name(const Port* port) const
     return nullptr;
   }
 
-  if (hierarchy_) {
+  if (hasHierarchy()) {
     size_t last_idx = name.find_last_of('/');
     if (last_idx != std::string::npos) {
       name = name.substr(last_idx + 1);
@@ -887,7 +887,7 @@ const char* dbNetwork::name(const Instance* instance) const
     name = mod_inst->getName();
   }
 
-  if (hierarchy_) {
+  if (hasHierarchy()) {
     size_t last_idx = std::string::npos;
     size_t pos = name.length();
     while ((pos = name.rfind('/', pos)) != std::string::npos) {
@@ -1096,7 +1096,7 @@ Instance* dbNetwork::parent(const Instance* instance) const
 
 Port* dbNetwork::findPort(const Cell* cell, const char* name) const
 {
-  if (hierarchy_) {
+  if (hasHierarchy()) {
     dbMaster* db_master;
     dbModule* db_module;
     staToDb(cell, db_master, db_module);
@@ -1125,7 +1125,7 @@ bool dbNetwork::isLeaf(const Instance* instance) const
   if (instance == top_instance_) {
     return false;
   }
-  if (hierarchy_) {
+  if (hasHierarchy()) {
     dbMaster* db_master;
     dbModule* db_module;
     Cell* cur_cell = cell(instance);
@@ -1140,7 +1140,7 @@ bool dbNetwork::isLeaf(const Instance* instance) const
 
 Instance* dbNetwork::findInstance(const char* path_name) const
 {
-  if (hierarchy_) {  // are we in hierarchical mode ?
+  if (hasHierarchy()) {  // are we in hierarchical mode ?
     // find a hierarchical module instance first
     dbModInst* mod_inst = block()->findModInst(path_name);
     if (mod_inst) {
@@ -1395,7 +1395,7 @@ ObjectId dbNetwork::id(const Pin* pin) const
 
   staToDb(pin, iterm, bterm, moditerm);
 
-  if (hierarchy_) {
+  if (hasHierarchy()) {
     // get the id for hierarchical objects using dbid.
     std::uintptr_t tag_value
         = reinterpret_cast<std::uintptr_t>(pin) & kPointerTagMask;
@@ -1784,7 +1784,7 @@ ObjectId dbNetwork::id(const Net* net) const
   dbModNet* modnet = nullptr;
   dbNet* dnet = nullptr;
   staToDb(net, dnet, modnet);
-  if (hierarchy_) {
+  if (hasHierarchy()) {
     const dbObject* obj = reinterpret_cast<const dbObject*>(net);
     return getDbNwkObjectId(obj);
   }
@@ -1865,7 +1865,7 @@ const char* dbNetwork::name(const Net* net) const
     // strip out the parent name in hierarchy mode
     // turn this off to get full flat names
 
-    if (hierarchy_) {
+    if (hasHierarchy()) {
       //
       // If this is not a hierarchical name, return it
       //
@@ -2054,7 +2054,7 @@ const Net* dbNetwork::highestConnectedNet(Net* net) const
 
 ObjectId dbNetwork::id(const Term* term) const
 {
-  if (hierarchy_) {
+  if (hasHierarchy()) {
     const dbObject* obj = reinterpret_cast<const dbObject*>(term);
     return getDbNwkObjectId(obj);
   }
@@ -3408,7 +3408,7 @@ we can decide whether or not to use the ConcreteNetwork api.
 */
 bool dbNetwork::isConcreteCell(const Cell* cell) const
 {
-  if (!hierarchy_) {
+  if (!hasHierarchy()) {
     return true;
   }
 
@@ -3426,7 +3426,7 @@ void dbNetwork::registerConcretePort(const Port* port)
 
 bool dbNetwork::isConcretePort(const Port* port) const
 {
-  if (!hierarchy_) {
+  if (!hasHierarchy()) {
     return true;
   }
   if (concrete_ports_.find(port) != concrete_ports_.end()) {
@@ -3494,7 +3494,7 @@ int dbNetwork::toIndex(const Port* port) const
 
 bool dbNetwork::hasMembers(const Port* port) const
 {
-  if (hierarchy_) {
+  if (hasHierarchy()) {
     dbMTerm* mterm = nullptr;
     dbBTerm* bterm = nullptr;
     dbModBTerm* modbterm = nullptr;
@@ -3580,7 +3580,7 @@ PortMemberIterator* dbNetwork::memberIterator(const Port* port) const
 {
   // top-level port is concrete port. DbNetworkPortMemberIterator cannot handle
   // it.
-  if (!hierarchy_ || isConcretePort(port)) {
+  if (!hasHierarchy() || isConcretePort(port)) {
     return ConcreteNetwork::memberIterator(port);
   }
 

src/odb/include/odb/db.h

@@ -7377,6 +7377,9 @@ class dbDatabase : public dbObject
 
   // User Code Begin dbDatabase
 
+  void setHierarchy(bool value);
+  bool hasHierarchy() const;
+
   void setTopChip(dbChip* chip);
   ///
   /// Return the libs contained in the database. A database can contain

src/odb/src/db/dbDatabase.cpp

@@ -180,6 +180,7 @@ _dbDatabase::_dbDatabase(_dbDatabase* db)
   master_id_ = 0;
   logger_ = utl::Logger::defaultLogger();
   unique_id_ = db_unique_id++;
+  hierarchy_ = false;
 
   gds_lib_tbl_ = new dbTable<_dbGDSLib, 2>(
       this, this, (GetObjTbl_t) &_dbDatabase::getObjectTable, dbGdsLibObj);
@@ -290,6 +291,11 @@ dbIStream& operator>>(dbIStream& stream, _dbDatabase& obj)
       stream >> obj.dbu_per_micron_;
     }
   }
+  if (obj.isSchema(kSchemaHierarchyFlag)) {
+    stream >> obj.hierarchy_;
+  } else {
+    obj.hierarchy_ = false;
+  }
   // Set the _tech on the block & libs now they are loaded
   if (!obj.isSchema(kSchemaBlockTech)) {
     if (obj.chip_) {
@@ -354,6 +360,7 @@ dbOStream& operator<<(dbOStream& stream, const _dbDatabase& obj)
   stream << *obj.chip_bump_inst_tbl_;
   stream << *obj.chip_net_tbl_;
   stream << obj.dbu_per_micron_;
+  stream << obj.hierarchy_;
   // User Code End <<
   return stream;
 }
@@ -455,6 +462,7 @@ _dbDatabase::_dbDatabase(_dbDatabase* /* unused: db */, int id)
   logger_ = nullptr;
   unique_id_ = id;
   dbu_per_micron_ = 0;
+  hierarchy_ = false;
 
   chip_tbl_ = new dbTable<_dbChip, 2>(
       this, this, (GetObjTbl_t) &_dbDatabase::getObjectTable, dbChipObj);
@@ -693,6 +701,18 @@ dbTech* dbDatabase::getTech()
       utl::ODB, 432, "getTech() is obsolete in a multi-tech db");
 }
 
+void dbDatabase::setHierarchy(bool value)
+{
+  _dbDatabase* db = reinterpret_cast<_dbDatabase*>(this);
+  db->hierarchy_ = value;
+}
+
+bool dbDatabase::hasHierarchy() const
+{
+  const _dbDatabase* db = reinterpret_cast<const _dbDatabase*>(this);
+  return db->hierarchy_;
+}
+
 void dbDatabase::read(std::istream& file)
 {
   _dbDatabase* db = (_dbDatabase*) this;

src/odb/src/db/dbDatabase.h

@@ -48,7 +48,10 @@ namespace odb {
 inline constexpr uint kSchemaMajor = 0;  // Not used...
 inline constexpr uint kSchemaInitial = 57;
 
-inline constexpr uint kSchemaMinor = 123;  // Current revision number
+inline constexpr uint kSchemaMinor = 124;  // Current revision number
+
+// Revision where _dbDatabase::hierarchy_ was added
+inline constexpr uint kSchemaHierarchyFlag = 124;
 
 // Revision where dbMarkerCategory was moved from dbBlock to dbChip
 inline constexpr uint kSchemaChipMarkerCategories = 123;
@@ -320,6 +323,7 @@ class _dbDatabase : public _dbObject
   dbChipBumpInstItr* chip_bump_inst_itr_;
   dbChipNetItr* chip_net_itr_;
   int unique_id_;
+  bool hierarchy_;
 
   utl::Logger* logger_;
   std::set<dbDatabaseObserver*> observers_;

src/odb/test/cpp/BUILD

@@ -251,4 +251,25 @@ cc_test(
     ],
 )
 
+cc_test(
+    name = "TestWriteReadDbHier",
+    srcs = [
+        "TestWriteReadDbHier.cpp",
+    ],
+    data = [
+        "//src/odb/test:regression_resources",
+    ],
+    deps = [
+        "//src/dbSta",
+        "//src/dbSta:dbNetwork",
+        "//src/odb",
+        "//src/sta:opensta_lib",
+        "//src/tst",
+        "//src/tst:integrated_fixture",
+        "//src/utl",
+        "@googletest//:gtest",
+        "@googletest//:gtest_main",
+    ],
+)
+
 # TODO: more to come.

src/odb/test/cpp/CMakeLists.txt

@@ -38,6 +38,7 @@ add_executable(TestChips TestChips.cpp)
 add_executable(Test3DBloxParser Test3DBloxParser.cpp)
 add_executable(Test3DBloxChecker Test3DBloxChecker.cpp)
 add_executable(TestSwapMaster TestSwapMaster.cpp)
+add_executable(TestWriteReadDbHier TestWriteReadDbHier.cpp)
 
 target_link_libraries(OdbGTests ${TEST_LIBS})
 target_link_libraries(TestCallBacks ${TEST_LIBS})
@@ -56,6 +57,7 @@ target_link_libraries(TestChips ${TEST_LIBS})
 target_link_libraries(Test3DBloxParser ${TEST_LIBS})
 target_link_libraries(Test3DBloxChecker ${TEST_LIBS})
 target_link_libraries(TestSwapMaster ${TEST_LIBS})
+target_link_libraries(TestWriteReadDbHier ${TEST_LIBS})
 
 # Skip the tests from being registered here, since they are called via
 # cpp_tests.tcl and don't need to be executed twice. The cpp_tests.tcl
@@ -82,6 +84,7 @@ add_dependencies(build_and_test
         Test3DBloxParser
         Test3DBloxChecker
         TestSwapMaster
+        TestWriteReadDbHier
         OdbGTests
 )
 add_subdirectory(helper)