Merge pull request #7987 from osamahammad21/utl-callback

maliberty · web-flow · commit 3bbfc26940fb · 2025-08-11T17:26:58.000Z
Implement callback registry to enable inter-module communication throughout openroad.
diff --git a/include/ord/OpenRoad.hh b/include/ord/OpenRoad.hh
@@ -101,7 +101,8 @@ class ICeWall;
 
 namespace utl {
 class Logger;
-}
+class CallBackHandler;
+}  // namespace utl
 
 namespace dst {
 class Distributed;
@@ -137,6 +138,7 @@ class OpenRoad
 
   Tcl_Interp* tclInterp() { return tcl_interp_; }
   utl::Logger* getLogger() { return logger_; }
+  utl::CallBackHandler* getCallBackHandler() { return callback_handler_; }
   odb::dbDatabase* getDb() { return db_; }
   sta::dbSta* getSta() { return sta_; }
   sta::dbNetwork* getDbNetwork();
@@ -256,6 +258,7 @@ class OpenRoad
   dst::Distributed* distributer_ = nullptr;
   stt::SteinerTreeBuilder* stt_builder_ = nullptr;
   dft::Dft* dft_ = nullptr;
+  utl::CallBackHandler* callback_handler_ = nullptr;
 
   int threads_ = 1;
 
diff --git a/src/OpenRoad.cc b/src/OpenRoad.cc
@@ -54,6 +54,7 @@
 #include "tap/MakeTapcell.h"
 #include "triton_route/MakeTritonRoute.h"
 #include "upf/MakeUpf.h"
+#include "utl/CallBackHandler.h"
 #include "utl/Logger.h"
 #include "utl/MakeLogger.h"
 #include "utl/Progress.h"
@@ -116,6 +117,7 @@ OpenRoad::~OpenRoad()
   dft::deleteDft(dft_);
   delete logger_;
   delete verilog_reader_;
+  delete callback_handler_;
 }
 
 sta::dbNetwork* OpenRoad::getDbNetwork()
@@ -160,6 +162,7 @@ void OpenRoad::init(Tcl_Interp* tcl_interp,
   // Make components.
   utl::Progress::setBatchMode(batch_mode);
   logger_ = utl::makeLogger(log_filename, metrics_filename);
+  callback_handler_ = new utl::CallBackHandler(logger_);
   db_->setLogger(logger_);
   sta_ = sta::makeDbSta();
   verilog_network_ = makeDbVerilogNetwork();
@@ -219,6 +222,7 @@ void OpenRoad::init(Tcl_Interp* tcl_interp,
                    opendp_,
                    stt_builder_,
                    logger_,
+                   callback_handler_,
                    tcl_interp);
   initTritonCts(tritonCts_,
                 db_,
@@ -240,8 +244,13 @@ void OpenRoad::init(Tcl_Interp* tcl_interp,
   initOpenRCX(extractor_, db_, logger_, getVersion(), tcl_interp);
   initICeWall(icewall_, db_, logger_, tcl_interp);
   initRestructure(restructure_, logger_, sta_, db_, resizer_, tcl_interp);
-  initTritonRoute(
-      detailed_router_, db_, logger_, distributer_, stt_builder_, tcl_interp);
+  initTritonRoute(detailed_router_,
+                  db_,
+                  logger_,
+                  callback_handler_,
+                  distributer_,
+                  stt_builder_,
+                  tcl_interp);
   initPDNSim(pdnsim_, logger_, db_, sta_, resizer_, opendp_, tcl_interp);
   initAntennaChecker(antenna_checker_, db_, logger_, tcl_interp);
   initPartitionMgr(
diff --git a/src/drt/BUILD b/src/drt/BUILD
@@ -86,6 +86,7 @@ cc_library(
         "src/AbstractGraphicsFactory.h",
         "src/DesignCallBack.cpp",
         "src/DesignCallBack.h",
+        "src/PACallBack.h",
         "src/TritonRoute.cpp",
         "src/db/drObj/drAccessPattern.cpp",
         "src/db/drObj/drNet.cpp",
diff --git a/src/drt/include/triton_route/MakeTritonRoute.h b/src/drt/include/triton_route/MakeTritonRoute.h
@@ -11,7 +11,8 @@ class dbDatabase;
 
 namespace utl {
 class Logger;
-}
+class CallBackHandler;
+}  // namespace utl
 
 namespace dst {
 class Distributed;
@@ -32,6 +33,7 @@ void deleteTritonRoute(drt::TritonRoute* router);
 void initTritonRoute(drt::TritonRoute* router,
                      odb::dbDatabase* db,
                      utl::Logger* logger,
+                     utl::CallBackHandler* callback_handler,
                      dst::Distributed* dist,
                      stt::SteinerTreeBuilder* stt_builder,
                      Tcl_Interp* tcl_interp);
diff --git a/src/drt/include/triton_route/TritonRoute.h b/src/drt/include/triton_route/TritonRoute.h
@@ -26,7 +26,8 @@ class dbWire;
 
 namespace utl {
 class Logger;
-}
+class CallBackHandler;
+}  // namespace utl
 
 namespace stt {
 class SteinerTreeBuilder;
@@ -41,6 +42,7 @@ namespace drt {
 class frDesign;
 class frInst;
 class DesignCallBack;
+class PACallBack;
 class FlexDR;
 class FlexPA;
 class FlexTA;
@@ -84,6 +86,7 @@ class TritonRoute
   ~TritonRoute();
   void init(odb::dbDatabase* db,
             utl::Logger* logger,
+            utl::CallBackHandler* callback_handler,
             dst::Distributed* dist,
             stt::SteinerTreeBuilder* stt_builder,
             std::unique_ptr<AbstractGraphicsFactory> graphics_factory);
@@ -185,6 +188,7 @@ class TritonRoute
   std::unique_ptr<frDesign> design_;
   std::unique_ptr<frDebugSettings> debug_;
   std::unique_ptr<DesignCallBack> db_callback_;
+  std::unique_ptr<PACallBack> pa_callback_;
   std::unique_ptr<RouterConfiguration> router_cfg_;
   odb::dbDatabase* db_{nullptr};
   utl::Logger* logger_{nullptr};
diff --git a/src/drt/src/MakeTritonRoute.cpp b/src/drt/src/MakeTritonRoute.cpp
@@ -35,6 +35,7 @@ void deleteTritonRoute(drt::TritonRoute* router)
 void initTritonRoute(drt::TritonRoute* router,
                      odb::dbDatabase* db,
                      utl::Logger* logger,
+                     utl::CallBackHandler* callback_handler,
                      dst::Distributed* dist,
                      stt::SteinerTreeBuilder* stt_builder,
                      Tcl_Interp* tcl_interp)
@@ -46,7 +47,12 @@ void initTritonRoute(drt::TritonRoute* router,
   std::unique_ptr<drt::AbstractGraphicsFactory> graphics_factory
       = std::make_unique<drt::GraphicsFactory>();
 
-  router->init(db, logger, dist, stt_builder, std::move(graphics_factory));
+  router->init(db,
+               logger,
+               callback_handler,
+               dist,
+               stt_builder,
+               std::move(graphics_factory));
 }
 
 }  // namespace drt
diff --git a/src/drt/src/PACallBack.h b/src/drt/src/PACallBack.h
@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (c) 2025-2025, The OpenROAD Authors
+
+#pragma once
+
+#include "triton_route/TritonRoute.h"
+#include "utl/CallBack.h"
+#include "utl/Logger.h"
+
+namespace drt {
+
+class frDesign;
+class FlexPA;
+
+class PACallBack : public utl::CallBack
+{
+ public:
+  PACallBack(TritonRoute* router) : router_(router) {}
+
+  ~PACallBack() override = default;
+
+  void onPinAccessUpdateRequired() override
+  {
+    // TODO: Implement
+  }
+
+ private:
+  TritonRoute* router_;
+};
+
+}  // namespace drt
diff --git a/src/drt/src/TritonRoute.cpp b/src/drt/src/TritonRoute.cpp
@@ -18,6 +18,7 @@
 
 #include "AbstractGraphicsFactory.h"
 #include "DesignCallBack.h"
+#include "PACallBack.h"
 #include "db/tech/frTechObject.h"
 #include "distributed/PinAccessJobDescription.h"
 #include "distributed/RoutingCallBack.h"
@@ -41,13 +42,15 @@
 #include "stt/SteinerTreeBuilder.h"
 #include "ta/AbstractTAGraphics.h"
 #include "ta/FlexTA.h"
+#include "utl/CallBackHandler.h"
 #include "utl/ScopedTemporaryFile.h"
 
 namespace drt {
 
 TritonRoute::TritonRoute()
     : debug_(std::make_unique<frDebugSettings>()),
       db_callback_(std::make_unique<DesignCallBack>(this)),
+      pa_callback_(std::make_unique<PACallBack>(this)),
       router_cfg_(std::make_unique<RouterConfiguration>())
 {
   if (distributed_) {
@@ -526,6 +529,7 @@ void TritonRoute::applyUpdates(
 void TritonRoute::init(
     odb::dbDatabase* db,
     Logger* logger,
+    utl::CallBackHandler* callback_handler,
     dst::Distributed* dist,
     stt::SteinerTreeBuilder* stt_builder,
     std::unique_ptr<AbstractGraphicsFactory> graphics_factory)
@@ -537,6 +541,7 @@ void TritonRoute::init(
   design_ = std::make_unique<frDesign>(logger_, router_cfg_.get());
   dist->addCallBack(new RoutingCallBack(this, dist, logger));
   graphics_factory_ = std::move(graphics_factory);
+  pa_callback_->setOwner(callback_handler);
 }
 
 bool TritonRoute::initGuide()
diff --git a/src/grt/include/grt/GlobalRouter.h b/src/grt/include/grt/GlobalRouter.h
@@ -22,7 +22,8 @@ using AdjacencyList = std::vector<std::vector<int>>;
 
 namespace utl {
 class Logger;
-}
+class CallBackHandler;
+}  // namespace utl
 
 namespace odb {
 class dbDatabase;
@@ -114,6 +115,7 @@ class GlobalRouter
   ~GlobalRouter();
 
   void init(utl::Logger* logger,
+            utl::CallBackHandler* callback_handler,
             stt::SteinerTreeBuilder* stt_builder,
             odb::dbDatabase* db,
             sta::dbSta* sta,
@@ -446,6 +448,7 @@ class GlobalRouter
   void configFastRoute();
 
   utl::Logger* logger_;
+  utl::CallBackHandler* callback_handler_;
   stt::SteinerTreeBuilder* stt_builder_;
   ant::AntennaChecker* antenna_checker_;
   dpl::Opendp* opendp_;
diff --git a/src/grt/include/grt/MakeGlobalRouter.h b/src/grt/include/grt/MakeGlobalRouter.h
@@ -31,7 +31,8 @@ class SteinerTreeBuilder;
 
 namespace utl {
 class Logger;
-}
+class CallBackHandler;
+}  // namespace utl
 
 namespace grt {
 
@@ -47,6 +48,7 @@ void initGlobalRouter(grt::GlobalRouter* grt,
                       dpl::Opendp* dpl,
                       stt::SteinerTreeBuilder* stt_builder,
                       utl::Logger* logger,
+                      utl::CallBackHandler* callback_handler,
                       Tcl_Interp* tcl_interp);
 
 void deleteGlobalRouter(grt::GlobalRouter* global_router);
diff --git a/src/grt/src/GlobalRouter.cpp b/src/grt/src/GlobalRouter.cpp
@@ -47,6 +47,7 @@
 #include "sta/Parasitics.hh"
 #include "sta/Set.hh"
 #include "stt/SteinerTreeBuilder.h"
+#include "utl/CallBackHandler.h"
 #include "utl/Logger.h"
 #include "utl/algorithms.h"
 
@@ -89,6 +90,7 @@ GlobalRouter::GlobalRouter()
 }
 
 void GlobalRouter::init(utl::Logger* logger,
+                        utl::CallBackHandler* callback_handler,
                         stt::SteinerTreeBuilder* stt_builder,
                         odb::dbDatabase* db,
                         sta::dbSta* sta,
@@ -101,6 +103,7 @@ void GlobalRouter::init(utl::Logger* logger,
                             routing_congestion_data_source_rudy)
 {
   logger_ = logger;
+  callback_handler_ = callback_handler;
   stt_builder_ = stt_builder;
   db_ = db;
   stt_builder_ = stt_builder;
@@ -4898,6 +4901,7 @@ void GlobalRouter::addDirtyNet(odb::dbNet* net)
 
 std::vector<Net*> GlobalRouter::updateDirtyRoutes(bool save_guides)
 {
+  callback_handler_->triggerOnPinAccessUpdateRequired();
   std::vector<Net*> dirty_nets;
   if (!dirty_nets_.empty()) {
     fastroute_->setVerbose(false);
diff --git a/src/grt/src/MakeGlobalRouter.cpp b/src/grt/src/MakeGlobalRouter.cpp
@@ -38,12 +38,14 @@ void initGlobalRouter(grt::GlobalRouter* grt,
                       dpl::Opendp* dpl,
                       stt::SteinerTreeBuilder* stt_builder,
                       utl::Logger* logger,
+                      utl::CallBackHandler* callback_handler,
                       Tcl_Interp* tcl_interp)
 {
   // Define swig TCL commands.
   Grt_Init(tcl_interp);
   utl::evalTclInit(tcl_interp, grt::grt_tcl_inits);
   grt->init(logger,
+            callback_handler,
             stt_builder,
             db,
             sta,
diff --git a/src/utl/BUILD b/src/utl/BUILD
@@ -15,6 +15,8 @@ package(
 cc_library(
     name = "utl",
     srcs = [
+        "src/CallBack.cpp",
+        "src/CallBackHandler.cpp",
         "src/CFileUtils.cpp",
         "src/CommandLineProgress.cpp",
         "src/CommandLineProgress.h",
@@ -30,6 +32,8 @@ cc_library(
         "src/timer.cpp",
     ],
     hdrs = [
+        "include/utl/CallBack.h",
+        "include/utl/CallBackHandler.h",
         "include/utl/CFileUtils.h",
         "include/utl/Logger.h",
         "include/utl/Metrics.h",
@@ -85,6 +89,8 @@ cc_library(
         ":tcl",
     ],
     hdrs = [
+        "include/utl/CallBack.h",
+        "include/utl/CallBackHandler.h",
         "include/utl/CFileUtils.h",
         "include/utl/Logger.h",
         "include/utl/MakeLogger.h",
diff --git a/src/utl/CMakeLists.txt b/src/utl/CMakeLists.txt
@@ -36,6 +36,8 @@ if (Python3_FOUND AND BUILD_PYTHON)
 endif()
 
 add_library(utl_lib
+  src/CallBackHandler.cpp
+  src/CallBack.cpp
   src/Metrics.cpp
   src/CFileUtils.cpp
   src/ScopedTemporaryFile.cpp
diff --git a/src/utl/include/utl/CallBack.h b/src/utl/include/utl/CallBack.h
@@ -0,0 +1,37 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (c) 2025-2025, The OpenROAD Authors
+
+#pragma once
+
+namespace utl {
+class CallBackHandler;
+
+/**
+ * @brief Base class for callbacks to enable inter-module communication.
+ *
+ * This class provides a standardized interface for modules to communicate
+ * with each other through callback mechanisms. Derived classes should
+ * implement specific callback methods as needed.
+ */
+class CallBack
+{
+ public:
+  virtual ~CallBack();
+
+  /**
+   * @brief Called when pin access needs to be updated.
+   *
+   * This callback is triggered when modules detect that access points need to
+   * be recalculated or updated.
+   */
+  virtual void onPinAccessUpdateRequired() {}
+
+  void setOwner(CallBackHandler* owner);
+  CallBackHandler* getOwner() const { return owner_; }
+  void removeOwner();
+
+ private:
+  CallBackHandler* owner_{nullptr};
+};
+
+}  // namespace utl
diff --git a/src/utl/include/utl/CallBackHandler.h b/src/utl/include/utl/CallBackHandler.h
diff --git a/src/utl/src/CallBack.cpp b/src/utl/src/CallBack.cpp
diff --git a/src/utl/src/CallBackHandler.cpp b/src/utl/src/CallBackHandler.cpp
