Merge pull request #7878 from AcKoucher/odb-inst-to-scan-inst

odb: hash instance to its scan version

Author: maliberty

src/odb/include/odb/db.h

@@ -3263,6 +3263,12 @@ class dbInst : public dbObject
   ///
   bool isEndCap() const;
 
+  ///
+  /// Get the scan version of this instance.
+  /// Returns nullptr if this instance has no scan version.
+  ///
+  dbScanInst* getScanInst() const;
+
   void setPinAccessIdx(uint idx);
 
   uint getPinAccessIdx() const;

src/odb/include/odb/dbId.h

@@ -40,3 +40,17 @@ class dbId
 };
 
 }  // namespace odb
+
+// Enable unordered_map/set usage
+namespace std {
+
+template <typename T>
+struct hash<odb::dbId<T>>
+{
+  std::size_t operator()(const odb::dbId<T>& db_id) const
+  {
+    return std::hash<unsigned int>()(db_id);
+  }
+};
+
+}  // namespace std

src/odb/src/db/dbBlock.cpp

@@ -846,6 +846,7 @@ dbOStream& operator<<(dbOStream& stream, const _dbBlock& block)
   stream << block._max_layer_for_clock;
   stream << block._bterm_groups;
   stream << block._bterm_top_layer_grid;
+  stream << block._inst_scan_inst_map;
 
   //---------------------------------------------------------- stream out
   // properties
@@ -1024,6 +1025,9 @@ dbIStream& operator>>(dbIStream& stream, _dbBlock& block)
   if (db->isSchema(db_schema_bterm_top_layer_grid)) {
     stream >> block._bterm_top_layer_grid;
   }
+  if (db->isSchema(db_schema_map_insts_to_scan_insts)) {
+    stream >> block._inst_scan_inst_map;
+  }
 
   //---------------------------------------------------------- stream in
   // properties

src/odb/src/db/dbBlock.h

@@ -287,6 +287,7 @@ class _dbBlock : public _dbObject
 
   std::unordered_map<std::string, int> _module_name_id_map;
   std::unordered_map<std::string, int> _inst_name_id_map;
+  std::unordered_map<dbId<_dbInst>, dbId<_dbScanInst>> _inst_scan_inst_map;
 
   unsigned char _num_ext_dbs;
 

src/odb/src/db/dbDatabase.h

@@ -43,8 +43,14 @@ namespace odb {
 const uint db_schema_major = 0;  // Not used...
 const uint db_schema_initial = 57;
 
-const uint db_schema_minor = 110;  // Current revision number
+const uint db_schema_minor = 111;  // Current revision number
 
+// Revision where the map which associates instances to their
+// scan version was added
+const uint db_schema_map_insts_to_scan_insts = 111;
+
+// Revision where the ownership of the scan insts was changed
+// from the its scan list to the block
 const uint db_schema_block_owns_scan_insts = 110;
 
 // Revision where is_connect_to_term_ flag was added to dbGuide

src/odb/src/db/dbInst.cpp

@@ -29,6 +29,7 @@
 #include "dbNet.h"
 #include "dbNullIterator.h"
 #include "dbRegion.h"
+#include "dbScanInst.h"
 #include "dbTable.h"
 #include "dbTable.hpp"
 #include "odb/db.h"
@@ -785,6 +786,22 @@ bool dbInst::isEndCap() const
   return getMaster()->isEndCap();
 }
 
+dbScanInst* dbInst::getScanInst() const
+{
+  _dbInst* inst = (_dbInst*) this;
+  _dbBlock* block = (_dbBlock*) inst->getOwner();
+  auto itr = block->_inst_scan_inst_map.find(inst->getId());
+
+  if (itr == block->_inst_scan_inst_map.end()) {
+    return nullptr;
+  }
+
+  dbId<_dbScanInst> scan_inst_id = itr->second;
+  _dbScanInst* scan_inst = block->_scan_inst_tbl->getPtr(scan_inst_id);
+
+  return (dbScanInst*) scan_inst;
+}
+
 dbSet<dbITerm> dbInst::getITerms()
 {
   _dbInst* inst = (_dbInst*) this;
@@ -1411,6 +1428,15 @@ void dbInst::destroy(dbInst* inst_)
                              inst->_name);
   }
 
+  dbScanInst* scan_inst = inst_->getScanInst();
+  if (scan_inst) {
+    inst->getLogger()->error(
+        utl::ODB,
+        505,
+        "Attempt to destroy instance {} with an associated scan inst.",
+        inst->_name);
+  }
+
   uint i;
   uint n = inst->_iterms.size();
 

src/odb/src/db/dbScanInst.cpp

@@ -255,8 +255,9 @@ dbScanInst* dbScanInst::create(dbScanList* scan_list, dbInst* inst)
 {
   _dbBlock* block = (_dbBlock*) ((_dbInst*) inst)->getOwner();
   _dbScanInst* scan_inst = (_dbScanInst*) block->_scan_inst_tbl->create();
-  scan_inst->inst_ = ((_dbInst*) inst)->getId();
-
+  odb::uint inst_id = ((_dbInst*) inst)->getId();
+  scan_inst->inst_ = (dbId<dbInst>) inst_id;
+  block->_inst_scan_inst_map[(dbId<_dbInst>) inst_id] = scan_inst->getId();
   return (dbScanInst*) scan_inst;
 }