required changes

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

Author: osamahammad21

src/OpenRoad.cc

@@ -162,7 +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();
+  callback_handler_ = new utl::CallBackHandler(logger_);
   db_->setLogger(logger_);
   sta_ = sta::makeDbSta();
   verilog_network_ = makeDbVerilogNetwork();

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",

src/drt/src/TritonRoute.cpp

@@ -58,10 +58,7 @@ TritonRoute::TritonRoute()
   }
 }
 
-TritonRoute::~TritonRoute()
-{
-  callback_handler_->removeCallBack(pa_callback_.get());
-}
+TritonRoute::~TritonRoute() = default;
 
 void TritonRoute::setDebugDR(bool on)
 {
@@ -545,7 +542,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);
-  callback_handler_->addCallBack(pa_callback_.get());
+  pa_callback_->setOwner(callback_handler);
 }
 
 bool TritonRoute::initGuide()

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",

src/utl/CMakeLists.txt

@@ -37,6 +37,7 @@ endif()
 
 add_library(utl_lib
   src/CallBackHandler.cpp
+  src/CallBack.cpp
   src/Metrics.cpp
   src/CFileUtils.cpp
   src/ScopedTemporaryFile.cpp

src/utl/include/utl/CallBack.h

@@ -4,23 +4,34 @@
 #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.
-///
+/**
+ * @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() = default;
+  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() {};
+  /**
+   * @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

src/utl/include/utl/CallBackHandler.h

@@ -5,39 +5,44 @@
 
 #include <set>
 
-#include "utl/CallBack.h"
-
 namespace utl {
-
-/// @brief Handler class for managing callback registration and triggering.
-///
-/// This class provides a centralized mechanism for modules to register
-/// callbacks and trigger them when specific events occur.
+class Logger;
+class CallBack;
+
+/**
+ * @brief Handler class for managing callback registration and triggering.
+ *
+ * This class provides a centralized mechanism for modules to register
+ * callbacks and trigger them when specific events occur.
+ */
 class CallBackHandler
 {
  public:
-  CallBackHandler() = default;
+  CallBackHandler(utl::Logger* logger);
   ~CallBackHandler() = default;
 
-  /// @brief Register a callback for event notifications.
-  ///
-  /// @param callback Pointer to the callback object to register
+  /**
+   * @brief Register a callback for event notifications.
+   *
+   * @param callback Pointer to the callback object to register
+   */
   void addCallBack(CallBack* callback);
 
-  /// @brief Unregister a callback from event notifications.
-  ///
-  /// @param callback Pointer to the callback object to unregister
+  /**
+   * @brief Unregister a callback from event notifications.
+   *
+   * @param callback Pointer to the callback object to unregister
+   */
   void removeCallBack(CallBack* callback);
 
-  /// @brief Trigger the onPinAccessUpdateRequired callback for all registered
-  /// callbacks.
-  ///
-  /// This method iterates through all registered callbacks and calls their
-  /// onPinAccessUpdateRequired method.
+  /**
+   * @brief Trigger the onPinAccessUpdateRequired callback for all registered
+   * callbacks.
+   */
   void triggerOnPinAccessUpdateRequired();
 
  private:
-  /// @brief Set of registered callbacks.
+  utl::Logger* logger_;
   std::set<CallBack*> callbacks_;
 };
 

src/utl/src/CallBack.cpp

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (c) 2025-2025, The OpenROAD Authors
+
+#include "utl/CallBack.h"
+
+#include "utl/CallBackHandler.h"
+
+namespace utl {
+
+CallBack::~CallBack()
+{
+  removeOwner();
+}
+
+void CallBack::setOwner(CallBackHandler* owner)
+{
+  owner_ = owner;
+  owner_->addCallBack(this);
+}
+
+void CallBack::removeOwner()
+{
+  if (owner_) {
+    owner_->removeCallBack(this);
+    owner_ = nullptr;
+  }
+}
+
+}  // namespace utl

src/utl/src/CallBackHandler.cpp

@@ -3,10 +3,20 @@
 
 #include "utl/CallBackHandler.h"
 
+#include "utl/CallBack.h"
+#include "utl/Logger.h"
+
 namespace utl {
 
+CallBackHandler::CallBackHandler(utl::Logger* logger) : logger_(logger)
+{
+}
+
 void CallBackHandler::addCallBack(CallBack* callback)
 {
+  if (callback == nullptr) {
+    logger_->error(utl::UTL, 200, "Registering null callback is not allowed");
+  }
   callbacks_.insert(callback);
 }
 
@@ -18,9 +28,7 @@ void CallBackHandler::removeCallBack(CallBack* callback)
 void CallBackHandler::triggerOnPinAccessUpdateRequired()
 {
   for (CallBack* callback : callbacks_) {
-    if (callback != nullptr) {
-      callback->onPinAccessUpdateRequired();
-    }
+    callback->onPinAccessUpdateRequired();
   }
 }