odb: add ChipCallBack

Signed-off-by: LucasYuki <[email protected]>

Author: LucasYuki

src/gui/src/drcWidget.cpp

@@ -231,14 +231,14 @@ void DRCWidget::setChip(odb::dbChip* chip)
 {
   chip_ = chip;
 
-  addOwner(chip_->getBlock());
+  addOwner(chip_);
   updateMarkerGroups();
 }
 
 void DRCWidget::showEvent(QShowEvent* event)
 {
   if (chip_) {
-    addOwner(chip_->getBlock());
+    addOwner(chip_);
   }
 
   updateMarkerGroups();

src/gui/src/drcWidget.h

@@ -19,7 +19,7 @@
 #include "gui/gui.h"
 #include "inspector.h"
 #include "odb/db.h"
-#include "odb/dbBlockCallBackObj.h"
+#include "odb/dbChipCallBackObj.h"
 #include "odb/geom.h"
 
 namespace utl {
@@ -51,7 +51,7 @@ class DRCRenderer : public Renderer
   odb::dbMarkerCategory* category_;
 };
 
-class DRCWidget : public QDockWidget, public odb::dbBlockCallBackObj
+class DRCWidget : public QDockWidget, public odb::dbChipCallBackObj
 {
   Q_OBJECT
 

src/odb/include/odb/dbBlockCallBackObj.h

@@ -18,8 +18,6 @@ class dbFill;
 class dbITerm;
 class dbInst;
 class dbIoType;
-class dbMarker;
-class dbMarkerCategory;
 class dbMaster;
 class dbModBTerm;
 class dbModule;
@@ -182,16 +180,6 @@ class dbBlockCallBackObj
   virtual void inDbFillCreate(dbFill*) {}
   // dbFill End
 
-  // dbMarkerCategory Start
-  virtual void inDbMarkerCategoryCreate(dbMarkerCategory*) {}
-  virtual void inDbMarkerCategoryDestroy(dbMarkerCategory*) {}
-  // dbMarkerCategory End
-
-  // dbMarker Start
-  virtual void inDbMarkerCreate(dbMarker*) {}
-  virtual void inDbMarkerDestroy(dbMarker*) {}
-  // dbMarker End
-
   virtual void inDbBlockStreamOutBefore(dbBlock*) {}
   virtual void inDbBlockStreamOutAfter(dbBlock*) {}
   virtual void inDbBlockReadNetsBefore(dbBlock*) {}

src/odb/include/odb/dbChipCallBackObj.h

@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (c) 2019-2025, The OpenROAD Authors
+
+#pragma once
+
+#include <list>
+
+#include "odb/odb.h"
+
+namespace odb {
+
+class dbChip;
+class dbMarker;
+class dbMarkerCategory;
+
+///////////////////////////////////////////////////////////////////////////////
+///
+/// dbChipCallBackObj - An object comprising a list of stub routines
+/// invoked by dbChip.
+/// Derived classes may implement these routines, causing external code
+/// to be invoked from inside dbBlock methods.
+///
+///////////////////////////////////////////////////////////////////////////////
+
+class dbChipCallBackObj
+{
+ public:
+  // dbMarkerCategory Start
+  virtual void inDbMarkerCategoryCreate(dbMarkerCategory*) {}
+  virtual void inDbMarkerCategoryDestroy(dbMarkerCategory*) {}
+  // dbMarkerCategory End
+
+  // dbMarker Start
+  virtual void inDbMarkerCreate(dbMarker*) {}
+  virtual void inDbMarkerDestroy(dbMarker*) {}
+  // dbMarker End
+
+  // allow ECO client initialization - payam
+  virtual dbChipCallBackObj& operator()() { return *this; }
+
+  // Manipulate _callback list of owner -- in journal.cpp
+  void addOwner(dbChip* new_owner);
+  bool hasOwner() const { return (_owner != nullptr); }
+  void removeOwner();
+
+  dbChipCallBackObj() { _owner = nullptr; }
+  virtual ~dbChipCallBackObj() { removeOwner(); }
+
+ private:
+  dbChip* _owner = nullptr;
+};
+
+}  // namespace odb

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

@@ -195,6 +195,15 @@
     "dbBlock.h", 
     "dbTech.h", 
     "dbPropertyItr.h",
-    "dbChipConn.h"
+    "dbChipConn.h",
+    "dbChipConnItr.h",
+    "dbChipInst.h",
+    "dbChipInstItr.h",
+    "dbChipNet.h",
+    "dbChipNetItr.h",
+    "dbCommon.h",
+    "odb/dbChipCallBackObj.h",
+    "odb/dbObject.h",
+    "odb/geom.h"
   ]
 } 

src/odb/src/db/CMakeLists.txt

@@ -90,6 +90,7 @@ add_library(db
     dbChip.cpp
     dbChipBump.cpp
     dbChipBumpInst.cpp
+    dbChipCallBackObj.cpp 
     dbChipConn.cpp
     dbChipInst.cpp
     dbChipNet.cpp

src/odb/src/db/dbChip.cpp

@@ -10,7 +10,13 @@
 #include "dbBlock.h"
 #include "dbBlockItr.h"
 #include "dbChipConn.h"
+#include "dbChipConnItr.h"
+#include "dbChipInst.h"
+#include "dbChipInstItr.h"
+#include "dbChipNet.h"
+#include "dbChipNetItr.h"
 #include "dbChipRegion.h"
+#include "dbCommon.h"
 #include "dbDatabase.h"
 #include "dbMarkerCategory.h"
 #include "dbNameCache.h"
@@ -20,18 +26,13 @@
 #include "dbTable.hpp"
 #include "dbTech.h"
 #include "odb/db.h"
+#include "odb/dbChipCallBackObj.h"
+#include "odb/dbObject.h"
 #include "odb/dbSet.h"
+#include "odb/geom.h"
 // User Code Begin Includes
 #include <cstdlib>
-
-#include "dbChipConnItr.h"
-#include "dbChipInst.h"
-#include "dbChipInstItr.h"
-#include "dbChipNet.h"
-#include "dbChipNetItr.h"
-#include "dbCommon.h"
-#include "odb/dbObject.h"
-#include "odb/geom.h"
+#include <list>
 // User Code End Includes
 namespace odb {
 template class dbTable<_dbChip>;
@@ -342,6 +343,11 @@ _dbChip::~_dbChip()
   delete name_cache_;
   delete block_itr_;
   delete prop_itr_;
+
+  while (!callbacks_.empty()) {
+    auto _cbitr = callbacks_.begin();
+    (*_cbitr)->removeOwner();
+  }
   // User Code End Destructor
 }
 

src/odb/src/db/dbChip.h

@@ -11,6 +11,9 @@
 #include "odb/dbId.h"
 #include "odb/geom.h"
 #include "odb/odb.h"
+// User Code Begin Includes
+#include <list>
+// User Code End Includes
 
 namespace odb {
 class dbIStream;
@@ -27,6 +30,9 @@ class _dbChipInst;
 class _dbChipConn;
 class _dbChipNet;
 class _dbTech;
+// User Code Begin Classes
+class dbChipCallBackObj;
+// User Code End Classes
 
 class _dbChip : public _dbObject
 {
@@ -75,6 +81,10 @@ class _dbChip : public _dbObject
   dbTable<_dbChipRegion>* chip_region_tbl_;
   dbTable<_dbMarkerCategory>* marker_categories_tbl_;
   dbId<_dbChip> next_entry_;
+
+  // User Code Begin Fields
+  std::list<dbChipCallBackObj*> callbacks_;
+  // User Code End Fields
 };
 dbIStream& operator>>(dbIStream& stream, _dbChip& obj);
 dbOStream& operator<<(dbOStream& stream, const _dbChip& obj);

src/odb/src/db/dbChipCallBackObj.cpp

@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (c) 2019-2025, The OpenROAD Authors
+
+#include "odb/dbChipCallBackObj.h"
+
+#include "dbChip.h"
+
+namespace odb {
+
+////////////////////////////////////////////////////////////////////
+//
+// dbChipCallBackObj - Methods
+//
+////////////////////////////////////////////////////////////////////
+
+void dbChipCallBackObj::addOwner(dbChip* new_owner)
+{
+  if (!new_owner) {
+    return;
+  }
+
+  if (_owner) {
+    removeOwner();
+  }
+
+  _dbChip* chip = (_dbChip*) new_owner;
+  chip->callbacks_.insert(chip->callbacks_.end(), this);
+  _owner = new_owner;
+}
+
+void dbChipCallBackObj::removeOwner()
+{
+  if (_owner) {
+    _dbChip* chip = (_dbChip*) _owner;
+    chip->callbacks_.remove(this);
+    _owner = nullptr;
+  }
+}
+
+}  // namespace odb

src/odb/src/db/dbMarker.cpp

@@ -25,7 +25,7 @@
 // User Code Begin Includes
 #include "dbChip.h"
 #include "dbCore.h"
-#include "odb/dbBlockCallBackObj.h"
+#include "odb/dbChipCallBackObj.h"
 #include "odb/dbObject.h"
 // User Code End Includes
 namespace odb {
@@ -806,11 +806,9 @@ dbMarker* dbMarker::create(dbMarkerCategory* category)
 
   _dbMarker* marker = _category->marker_tbl_->create();
 
-  _dbBlock* block = marker->getBlock();
-  if (block) {
-    for (auto cb : block->callbacks_) {
-      cb->inDbMarkerCreate((dbMarker*) marker);
-    }
+  _dbChip* chip = marker->getChip();
+  for (auto cb : chip->callbacks_) {
+    cb->inDbMarkerCreate((dbMarker*) marker);
   }
 
   return (dbMarker*) marker;
@@ -820,8 +818,8 @@ void dbMarker::destroy(dbMarker* marker)
 {
   _dbMarker* _marker = (_dbMarker*) marker;
 
-  _dbBlock* block = _marker->getBlock();
-  for (auto cb : block->callbacks_) {
+  _dbChip* chip = _marker->getChip();
+  for (auto cb : chip->callbacks_) {
     cb->inDbMarkerDestroy(marker);
   }