Merge pull request #7824 from AcKoucher/odb-scan-inst-owner

odb: move ownership of _dbScanInst to _dbBlock

Author: maliberty

src/odb/include/odb/db.h

@@ -8440,6 +8440,8 @@ class dbScanInst : public dbObject
 
   dbInst* getInst() const;
 
+  void insertAtFront(dbScanList* scan_list);
+
   static dbScanInst* create(dbScanList* scan_list, dbInst* inst);
   // User Code End dbScanInst
 };
@@ -8452,9 +8454,8 @@ class dbScanInst : public dbObject
 class dbScanList : public dbObject
 {
  public:
-  dbSet<dbScanInst> getScanInsts() const;
-
   // User Code Begin dbScanList
+  dbSet<dbScanInst> getScanInsts() const;
   dbScanInst* add(dbInst* inst);
   static dbScanList* create(dbScanPartition* scan_partition);
   // User Code End dbScanList

src/odb/src/codeGenerator/schema.json

@@ -153,6 +153,15 @@
       "reversible": "true",
       "orderReversed": "true",
       "sequential": 0
+    },
+    {
+      "name": "dbScanListScanInstItr",
+      "parentObject": "dbScanInst",
+      "tableName": "scan_inst_tbl",
+      "reversible": "true",
+      "orderReversed": "true",
+      "sequential": 0,
+      "includes": ["dbScanList.h", "dbScanInst.h"]
     }
   ],
   "relations":[
@@ -301,12 +310,6 @@
       "type": "1_n",
       "tbl_name": "scan_lists_"
     },
-    {
-      "parent": "dbScanList",
-      "child": "dbScanInst",
-      "type": "1_n",
-      "tbl_name": "scan_insts_"
-    },
     {
       "parent": "dbDft",
       "child": "dbScanChain",

src/odb/src/codeGenerator/schema/scan/dbScanInst.json

@@ -42,6 +42,18 @@
       "type": "uint",
       "default": "0",
       "flags": ["private"]
+    },
+    {
+      "name": "_next_list_scan_inst",
+      "type": "dbId<_dbScanInst>",
+      "flags": ["private"],
+      "schema":"db_schema_block_owns_scan_insts"
+    },
+    {
+      "name": "_prev_list_scan_inst",
+      "type": "dbId<_dbScanInst>",
+      "flags": ["private"],
+      "schema":"db_schema_block_owns_scan_insts"
     }
   ],
   "enums": [

src/odb/src/codeGenerator/schema/scan/dbScanList.json

@@ -9,6 +9,27 @@
     "optimizing the scan chain."],
   "cpp_includes": [
     "dbScanChain.h",
-    "dbScanPartition.h"
+    "dbScanPartition.h",
+    "dbDft.h",
+    "dbScanListScanInstItr.h"],
+  "fields": [
+    {
+      "name": "_unused",
+      "type": "uint",
+      "flags": [
+        "private"
+      ],
+      "default": 0,
+      "comment": "// As the elements of a free dbTable are 12 bytes long, we need this additional member in order to make _dbScanList big enough to allow safe casting between table members.",
+      "schema": "db_schema_block_owns_scan_insts"
+    },
+    {
+      "name": "_first_scan_inst",
+      "type": "dbId<_dbScanInst>",
+      "flags": [
+        "private"
+      ],
+      "schema": "db_schema_block_owns_scan_insts"
+    }
   ]
 }

src/odb/src/db/CMakeLists.txt

@@ -161,6 +161,7 @@ add_library(db
     dbModulePortItr.cpp
     dbNetTrackItr.cpp
     dbRegionGroupItr.cpp
+    dbScanListScanInstItr.cpp
     # Generator Code End cpp
 )
 

src/odb/src/db/dbBlock.cpp

@@ -91,6 +91,8 @@
 #include "dbSBoxItr.h"
 #include "dbSWire.h"
 #include "dbSWireItr.h"
+#include "dbScanInst.h"
+#include "dbScanListScanInstItr.h"
 #include "dbTable.h"
 #include "dbTable.hpp"
 #include "dbTech.h"
@@ -180,6 +182,9 @@ _dbBlock::_dbBlock(_dbDatabase* db)
   _inst_tbl = new dbTable<_dbInst>(
       db, this, (GetObjTbl_t) &_dbBlock::getObjectTable, dbInstObj);
 
+  _scan_inst_tbl = new dbTable<_dbScanInst>(
+      db, this, (GetObjTbl_t) &_dbBlock::getObjectTable, dbScanInstObj);
+
   _module_tbl = new dbTable<_dbModule>(
       db, this, (GetObjTbl_t) &_dbBlock::getObjectTable, dbModuleObj);
 
@@ -338,6 +343,8 @@ _dbBlock::_dbBlock(_dbDatabase* db)
 
   _inst_iterm_itr = new dbInstITermItr(_iterm_tbl);
 
+  _scan_list_scan_inst_itr = new dbScanListScanInstItr(_scan_inst_tbl);
+
   _box_itr = new dbBoxItr<1024>(_box_tbl, nullptr, false);
 
   _swire_itr = new dbSWireItr(_swire_tbl);
@@ -406,6 +413,7 @@ _dbBlock::~_dbBlock()
   delete _net_tbl;
   delete _inst_hdr_tbl;
   delete _inst_tbl;
+  delete _scan_inst_tbl;
   delete _module_tbl;
   delete _modinst_tbl;
   delete _modbterm_tbl;
@@ -450,6 +458,7 @@ _dbBlock::~_dbBlock()
   delete _net_bterm_itr;
   delete _net_iterm_itr;
   delete _inst_iterm_itr;
+  delete _scan_list_scan_inst_itr;
   delete _box_itr;
   delete _swire_itr;
   delete _sbox_itr;
@@ -785,6 +794,7 @@ dbOStream& operator<<(dbOStream& stream, const _dbBlock& block)
   stream << *block._inst_hdr_tbl;
   stream << *block._module_tbl;
   stream << *block._inst_tbl;
+  stream << *block._scan_inst_tbl;
   stream << *block._modinst_tbl;
   stream << *block._modbterm_tbl;
   stream << *block._busport_tbl;
@@ -941,6 +951,9 @@ dbIStream& operator>>(dbIStream& stream, _dbBlock& block)
     stream >> *block._inst_tbl;
     stream >> *block._module_tbl;
   }
+  if (db->isSchema(db_schema_block_owns_scan_insts)) {
+    stream >> *block._scan_inst_tbl;
+  }
   stream >> *block._modinst_tbl;
   if (db->isSchema(db_schema_update_hierarchy)) {
     stream >> *block._modbterm_tbl;

src/odb/src/db/dbBlock.h

@@ -33,6 +33,8 @@ class _dbITerm;
 class _dbNet;
 class _dbInst;
 class _dbInstHdr;
+class _dbScanInst;
+class dbScanListScanInstItr;
 class _dbWire;
 class _dbVia;
 class _dbGCellGrid;
@@ -200,6 +202,7 @@ class _dbBlock : public _dbObject
   dbTable<_dbNet>* _net_tbl;
   dbTable<_dbInstHdr>* _inst_hdr_tbl;
   dbTable<_dbInst>* _inst_tbl;
+  dbTable<_dbScanInst>* _scan_inst_tbl;
   dbTable<_dbBox, 1024>* _box_tbl;
   dbTable<_dbVia, 1024>* _via_tbl;
   dbTable<_dbGCellGrid>* _gcell_grid_tbl;
@@ -251,6 +254,7 @@ class _dbBlock : public _dbObject
   dbNetBTermItr* _net_bterm_itr;
   dbNetITermItr* _net_iterm_itr;
   dbInstITermItr* _inst_iterm_itr;
+  dbScanListScanInstItr* _scan_list_scan_inst_itr;
   dbBoxItr<1024>* _box_itr;
   dbSWireItr* _swire_itr;
   dbSBoxItr* _sbox_itr;

src/odb/src/db/dbDatabase.h

@@ -43,7 +43,9 @@ namespace odb {
 const uint db_schema_major = 0;  // Not used...
 const uint db_schema_initial = 57;
 
-const uint db_schema_minor = 109;  // Current revision number
+const uint db_schema_minor = 110;  // Current revision number
+
+const uint db_schema_block_owns_scan_insts = 110;
 
 // Revision where is_connect_to_term_ flag was added to dbGuide
 const uint db_schema_guide_connected_to_term = 109;

src/odb/src/db/dbScanInst.cpp

@@ -36,6 +36,12 @@ bool _dbScanInst::operator==(const _dbScanInst& rhs) const
   if (clock_edge_ != rhs.clock_edge_) {
     return false;
   }
+  if (_next_list_scan_inst != rhs._next_list_scan_inst) {
+    return false;
+  }
+  if (_prev_list_scan_inst != rhs._prev_list_scan_inst) {
+    return false;
+  }
 
   return true;
 }
@@ -59,6 +65,12 @@ dbIStream& operator>>(dbIStream& stream, _dbScanInst& obj)
   stream >> obj.inst_;
   stream >> obj.scan_clock_;
   stream >> obj.clock_edge_;
+  if (obj.getDatabase()->isSchema(db_schema_block_owns_scan_insts)) {
+    stream >> obj._next_list_scan_inst;
+  }
+  if (obj.getDatabase()->isSchema(db_schema_block_owns_scan_insts)) {
+    stream >> obj._prev_list_scan_inst;
+  }
   return stream;
 }
 
@@ -70,6 +82,8 @@ dbOStream& operator<<(dbOStream& stream, const _dbScanInst& obj)
   stream << obj.inst_;
   stream << obj.scan_clock_;
   stream << obj.clock_edge_;
+  stream << obj._next_list_scan_inst;
+  stream << obj._prev_list_scan_inst;
   return stream;
 }
 
@@ -137,28 +151,24 @@ uint dbScanInst::getBits() const
 void dbScanInst::setScanEnable(dbBTerm* scan_enable)
 {
   _dbScanInst* scan_inst = (_dbScanInst*) this;
-  _dbScanChain* scan_chain = (_dbScanChain*) scan_inst->getOwner();
-  dbDft* dft = (dbDft*) scan_chain->getOwner();
+  _dbBlock* block = (_dbBlock*) scan_inst->getOwner();
+  dbDft* dft = (dbDft*) block->_dft_tbl->getPtr(block->_dft);
   scan_inst->scan_enable_ = dbScanPin::create(dft, scan_enable);
 }
 
 void dbScanInst::setScanEnable(dbITerm* scan_enable)
 {
   _dbScanInst* scan_inst = (_dbScanInst*) this;
-  _dbScanList* scan_list = (_dbScanList*) scan_inst->getOwner();
-  _dbScanPartition* scan_partition = (_dbScanPartition*) scan_list->getOwner();
-  _dbScanChain* scan_chain = (_dbScanChain*) scan_partition->getOwner();
-  dbDft* dft = (dbDft*) scan_chain->getOwner();
+  _dbBlock* block = (_dbBlock*) scan_inst->getOwner();
+  dbDft* dft = (dbDft*) block->_dft_tbl->getPtr(block->_dft);
   scan_inst->scan_enable_ = dbScanPin::create(dft, scan_enable);
 }
 
 std::variant<dbBTerm*, dbITerm*> dbScanInst::getScanEnable() const
 {
   _dbScanInst* scan_inst = (_dbScanInst*) this;
-  _dbScanList* scan_list = (_dbScanList*) scan_inst->getOwner();
-  _dbScanPartition* scan_partition = (_dbScanPartition*) scan_list->getOwner();
-  _dbScanChain* scan_chain = (_dbScanChain*) scan_partition->getOwner();
-  _dbDft* dft = (_dbDft*) scan_chain->getOwner();
+  _dbBlock* block = (_dbBlock*) scan_inst->getOwner();
+  _dbDft* dft = (_dbDft*) block->_dft_tbl->getPtr(block->_dft);
   const dbScanPin* scan_enable = (dbScanPin*) dft->scan_pins_->getPtr(
       (dbId<_dbScanPin>) scan_inst->scan_enable_);
   return scan_enable->getPin();
@@ -177,10 +187,8 @@ std::string_view getName(odb::dbITerm* iterm)
 void dbScanInst::setAccessPins(const AccessPins& access_pins)
 {
   _dbScanInst* scan_inst = (_dbScanInst*) this;
-  _dbScanList* scan_list = (_dbScanList*) scan_inst->getOwner();
-  _dbScanPartition* scan_partition = (_dbScanPartition*) scan_list->getOwner();
-  _dbScanChain* scan_chain = (_dbScanChain*) scan_partition->getOwner();
-  dbDft* dft = (dbDft*) scan_chain->getOwner();
+  _dbBlock* block = (_dbBlock*) scan_inst->getOwner();
+  dbDft* dft = (dbDft*) block->_dft_tbl->getPtr(block->_dft);
 
   std::visit(
       [&access_pins, scan_inst, dft](auto&& scan_in_pin) {
@@ -200,10 +208,8 @@ dbScanInst::AccessPins dbScanInst::getAccessPins() const
 {
   AccessPins access_pins;
   _dbScanInst* scan_inst = (_dbScanInst*) this;
-  _dbScanList* scan_list = (_dbScanList*) scan_inst->getOwner();
-  _dbScanPartition* scan_partition = (_dbScanPartition*) scan_list->getOwner();
-  _dbScanChain* scan_chain = (_dbScanChain*) scan_partition->getOwner();
-  _dbDft* dft = (_dbDft*) scan_chain->getOwner();
+  _dbBlock* block = (_dbBlock*) scan_inst->getOwner();
+  _dbDft* dft = (_dbDft*) block->_dft_tbl->getPtr(block->_dft);
 
   const auto& [scan_in_id, scan_out_id] = scan_inst->access_pins_;
 
@@ -221,19 +227,34 @@ dbScanInst::AccessPins dbScanInst::getAccessPins() const
 dbInst* dbScanInst::getInst() const
 {
   _dbScanInst* scan_inst = (_dbScanInst*) this;
-  _dbScanList* scan_list = (_dbScanList*) scan_inst->getOwner();
-  _dbScanPartition* scan_partition = (_dbScanPartition*) scan_list->getOwner();
-  _dbScanChain* scan_chain = (_dbScanChain*) scan_partition->getOwner();
-  _dbDft* dft = (_dbDft*) scan_chain->getOwner();
-  _dbBlock* block = (_dbBlock*) dft->getOwner();
-
+  _dbBlock* block = (_dbBlock*) scan_inst->getOwner();
   return (dbInst*) block->_inst_tbl->getPtr((dbId<_dbInst>) scan_inst->inst_);
 }
 
+void dbScanInst::insertAtFront(dbScanList* scan_list_)
+{
+  _dbScanInst* scan_inst = (_dbScanInst*) this;
+  _dbScanList* scan_list = (_dbScanList*) scan_list_;
+  _dbBlock* block = (_dbBlock*) scan_inst->getOwner();
+
+  if (scan_list->_first_scan_inst != 0) {
+    _dbScanInst* head
+        = block->_scan_inst_tbl->getPtr(scan_list->_first_scan_inst);
+    scan_inst->_next_list_scan_inst = scan_list->_first_scan_inst;
+    head->_prev_list_scan_inst = scan_inst->getOID();
+  } else {
+    // Needed if an already listed scan inst is moved to an empty list.
+    scan_inst->_next_list_scan_inst = 0;
+  }
+
+  scan_inst->_prev_list_scan_inst = 0;
+  scan_list->_first_scan_inst = scan_inst->getOID();
+}
+
 dbScanInst* dbScanInst::create(dbScanList* scan_list, dbInst* inst)
 {
-  _dbScanList* obj = (_dbScanList*) scan_list;
-  _dbScanInst* scan_inst = (_dbScanInst*) obj->scan_insts_->create();
+  _dbBlock* block = (_dbBlock*) ((_dbInst*) inst)->getOwner();
+  _dbScanInst* scan_inst = (_dbScanInst*) block->_scan_inst_tbl->create();
   scan_inst->inst_ = ((_dbInst*) inst)->getId();
 
   return (dbScanInst*) scan_inst;

src/odb/src/db/dbScanInst.h

@@ -37,6 +37,8 @@ class _dbScanInst : public _dbObject
   dbId<dbInst> inst_;
   std::string scan_clock_;
   uint clock_edge_;
+  dbId<_dbScanInst> _next_list_scan_inst;
+  dbId<_dbScanInst> _prev_list_scan_inst;
 };
 dbIStream& operator>>(dbIStream& stream, _dbScanInst& obj);
 dbOStream& operator<<(dbOStream& stream, const _dbScanInst& obj);