Merge pull request The-OpenROAD-Project#6904 from The-OpenROAD-Project-staging/odb-observer

ord/odb: move lef/def/odb load observer callback from ord to odb

Author: maliberty

include/ord/OpenRoad.hh

@@ -40,8 +40,6 @@
 #include <string>
 #include <vector>
 
-#include "OpenRoadObserver.hh"
-
 extern "C" {
 struct Tcl_Interp;
 }
@@ -243,9 +241,6 @@ class OpenRoad
   void setThreadCount(const char* threads, bool printInfo = true);
   int getThreadCount();
 
-  void addObserver(OpenRoadObserver* observer);
-  void removeObserver(OpenRoadObserver* observer);
-
   std::string getExePath() const;
   std::string getDocsPath() const;
 
@@ -290,8 +285,6 @@ class OpenRoad
   stt::SteinerTreeBuilder* stt_builder_ = nullptr;
   dft::Dft* dft_ = nullptr;
 
-  std::set<OpenRoadObserver*> observers_;
-
   int threads_ = 1;
 
   static OpenRoad* app_;

src/OpenRoad.cc

@@ -271,14 +271,12 @@ void OpenRoad::readLef(const char* filename,
                        bool make_library)
 {
   odb::lefin lef_reader(db_, logger_, false);
-  dbLib* lib = nullptr;
-  dbTech* tech = nullptr;
   if (make_tech && make_library) {
-    lib = lef_reader.createTechAndLib(tech_name, lib_name, filename);
-    tech = db_->findTech(tech_name);
+    lef_reader.createTechAndLib(tech_name, lib_name, filename);
   } else if (make_tech) {
-    tech = lef_reader.createTech(tech_name, filename);
+    lef_reader.createTech(tech_name, filename);
   } else if (make_library) {
+    dbTech* tech;
     if (tech_name[0] != '\0') {
       tech = db_->findTech(tech_name);
     } else {
@@ -287,14 +285,7 @@ void OpenRoad::readLef(const char* filename,
     if (!tech) {
       logger_->error(ORD, 51, "Technology {} not found", tech_name);
     }
-    lib = lef_reader.createLib(tech, lib_name, filename);
-  }
-
-  // both are null on parser failure
-  if (lib != nullptr || tech != nullptr) {
-    for (OpenRoadObserver* observer : observers_) {
-      observer->postReadLef(tech, lib);
-    }
+    lef_reader.createLib(tech, lib_name, filename);
   }
 }
 
@@ -324,20 +315,11 @@ void OpenRoad::readDef(const char* filename,
   if (continue_on_errors) {
     def_reader.continueOnErrors();
   }
-  dbBlock* block = nullptr;
   if (child) {
     auto parent = db_->getChip()->getBlock();
-    block = def_reader.createBlock(parent, search_libs, filename, tech);
+    def_reader.createBlock(parent, search_libs, filename, tech);
   } else {
-    dbChip* chip = def_reader.createChip(search_libs, filename, tech);
-    if (chip) {
-      block = chip->getBlock();
-    }
-  }
-  if (block) {
-    for (OpenRoadObserver* observer : observers_) {
-      observer->postReadDef(block);
-    }
+    def_reader.createChip(search_libs, filename, tech);
   }
 }
 
@@ -492,11 +474,6 @@ void OpenRoad::readDb(std::istream& stream)
                     | std::ios::eofbit);
 
   db_->read(stream);
-
-  // this fixes up the database post read
-  for (OpenRoadObserver* observer : observers_) {
-    observer->postReadDb(db_);
-  }
 }
 
 void OpenRoad::writeDb(std::ostream& stream)
@@ -538,16 +515,12 @@ void OpenRoad::linkDesign(const char* design_name, bool hierarchy)
     sta::dbSta* sta = getSta();
     sta->getDbNetwork()->setHierarchy();
   }
-  for (OpenRoadObserver* observer : observers_) {
-    observer->postReadDb(db_);
-  }
+  db_->triggerPostReadDb();
 }
 
 void OpenRoad::designCreated()
 {
-  for (OpenRoadObserver* observer : observers_) {
-    observer->postReadDb(db_);
-  }
+  db_->triggerPostReadDb();
 }
 
 bool OpenRoad::unitsInitialized()
@@ -561,19 +534,6 @@ odb::Rect OpenRoad::getCore()
   return db_->getChip()->getBlock()->getCoreArea();
 }
 
-void OpenRoad::addObserver(OpenRoadObserver* observer)
-{
-  observer->set_unregister_observer(
-      [this, observer] { removeObserver(observer); });
-  observers_.insert(observer);
-}
-
-void OpenRoad::removeObserver(OpenRoadObserver* observer)
-{
-  observer->set_unregister_observer(nullptr);
-  observers_.erase(observer);
-}
-
 void OpenRoad::setThreadCount(int threads, bool printInfo)
 {
   int max_threads = std::thread::hardware_concurrency();

src/dbSta/include/db_sta/dbSta.hh

@@ -41,7 +41,7 @@
 
 #include "odb/db.h"
 #include "odb/dbBlockCallBackObj.h"
-#include "ord/OpenRoadObserver.hh"
+#include "odb/dbDatabaseObserver.h"
 #include "sta/Sta.hh"
 
 namespace ord {
@@ -104,7 +104,7 @@ class BufferUseAnalyser
   std::unique_ptr<sta::PatternMatch> clkbuf_pattern_;
 };
 
-class dbSta : public Sta, public ord::OpenRoadObserver
+class dbSta : public Sta, public odb::dbDatabaseObserver
 {
  public:
   ~dbSta() override;

src/dbSta/src/MakeDbSta.cc

@@ -56,8 +56,6 @@ void initDbSta(OpenRoad* openroad)
   Dbsta_Init(tcl_interp);
   // Eval encoded sta TCL sources.
   sta::evalTclInit(tcl_interp, sta::dbSta_tcl_inits);
-
-  openroad->addObserver(sta);
 }
 
 }  // namespace ord

src/dbSta/src/dbSta.cc

@@ -232,6 +232,7 @@ void dbSta::initVars(Tcl_Interp* tcl_interp,
                      utl::Logger* logger)
 {
   db_ = db;
+  db->addObserver(this);
   logger_ = logger;
   makeComponents();
   if (tcl_interp) {

src/drt/test/stubs.cpp

@@ -76,14 +76,6 @@ void OpenRoad::readDb(const char*, bool)
 {
 }
 
-void OpenRoad::addObserver(OpenRoadObserver* observer)
-{
-}
-
-void OpenRoad::removeObserver(OpenRoadObserver* observer)
-{
-}
-
 int OpenRoad::getThreadCount()
 {
   return 0;

src/gui/src/gui.cpp

@@ -1422,7 +1422,7 @@ int startGui(int& argc,
   }
   main_window->setTitle(gui->getMainWindowTitle());
 
-  open_road->addObserver(main_window);
+  open_road->getDb()->addObserver(main_window);
   if (!interactive) {
     gui->setContinueAfterClose();
     main_window->setAttribute(Qt::WA_DontShowOnScreen);
@@ -1518,7 +1518,7 @@ int startGui(int& argc,
   }
 
   // cleanup
-  open_road->removeObserver(main_window);
+  open_road->getDb()->removeObserver(main_window);
 
   if (!exception.hasException()) {
     // don't save anything if exception occured

src/gui/src/mainWindow.h

@@ -79,7 +79,7 @@ class HelpWidget;
 
 // This is the main window for the GUI.  Currently we use a single
 // instance of this class.
-class MainWindow : public QMainWindow, public ord::OpenRoadObserver
+class MainWindow : public QMainWindow, public odb::dbDatabaseObserver
 {
   Q_OBJECT
 

src/odb/include/odb/db.h

@@ -43,6 +43,7 @@
 
 #include "dbBlockSet.h"
 #include "dbCCSegSet.h"
+#include "dbDatabaseObserver.h"
 #include "dbMatrix.h"
 #include "dbNetSet.h"
 #include "dbObject.h"
@@ -484,6 +485,21 @@ class dbDatabase : public dbObject
   ///
   void report();
 
+  ///
+  /// Used to be notified when lef/def/odb are read.
+  ///
+  void addObserver(dbDatabaseObserver* observer);
+  void removeObserver(dbDatabaseObserver* observer);
+
+  ///
+  /// Notify observers when one of these operations is complete.
+  /// Fine-grained callbacks during construction are not as helpful
+  /// as knowing when the data is fully loaded into odb.
+  ///
+  void triggerPostReadLef(dbTech* tech, dbLib* library);
+  void triggerPostReadDef(dbBlock* block);
+  void triggerPostReadDb();
+
   ///
   /// Create an instance of a database
   ///

include/ord/OpenRoadObserver.hh src/odb/include/odb/dbDatabaseObserver.hinclude/ord/OpenRoadObserver.hh renamed to src/odb/include/odb/dbDatabaseObserver.h

@@ -15,17 +15,10 @@ class dbDatabase;
 class dbLib;
 class dbTech;
 
-}  // namespace odb
-
-namespace ord {
-
-class OpenRoad;
-
-// Observer interface
-class OpenRoadObserver
+class dbDatabaseObserver
 {
  public:
-  virtual ~OpenRoadObserver()
+  virtual ~dbDatabaseObserver()
   {
     if (unregister_observer_) {
       unregister_observer_();
@@ -37,7 +30,7 @@ class OpenRoadObserver
   virtual void postReadDef(odb::dbBlock* block) = 0;
   virtual void postReadDb(odb::dbDatabase* db) = 0;
 
-  void set_unregister_observer(std::function<void()> unregister_observer)
+  void setUnregisterObserver(std::function<void()> unregister_observer)
   {
     unregister_observer_ = std::move(unregister_observer);
   }
@@ -46,4 +39,4 @@ class OpenRoadObserver
   std::function<void()> unregister_observer_;
 };
 
-}  // namespace ord
+}  // namespace odb