Merge pull request The-OpenROAD-Project#8710 from hongted/gpl-graphics-refactor

gpl: Factor out graphics use in gpl

Author: maliberty

src/OpenRoad.cc

@@ -3,6 +3,8 @@
 
 #include "ord/OpenRoad.hh"
 
+#include <tcl.h>
+
 #include <cstdlib>
 #include <cstring>
 #include <filesystem>
@@ -267,6 +269,7 @@ void OpenRoad::init(Tcl_Interp* tcl_interp,
   rsz::initResizer(tcl_interp);
   ppl::initIoplacer(tcl_interp);
   gpl::initReplace(tcl_interp);
+  gpl::initReplaceGraphics(replace_, logger_);
   dpl::initOpendp(tcl_interp);
   fin::initFinale(tcl_interp);
   ram::initRamGen(tcl_interp);

src/gpl/BUILD

@@ -14,13 +14,16 @@ package(
 cc_library(
     name = "gpl",
     srcs = [
+        "src/AbstractGraphics.cpp",
         "src/MakeReplace.cpp",
         "src/fft.cpp",
         "src/fft.h",
         "src/fftsg.cpp",
         "src/fftsg2d.cpp",
-        "src/graphics.cpp",
-        "src/graphics.h",
+        "src/graphicsImpl.cpp",
+        "src/graphicsImpl.h",
+        "src/graphicsNone.cpp",
+        "src/graphicsNone.h",
         "src/initialPlace.cpp",
         "src/initialPlace.h",
         "src/mbff.cpp",
@@ -43,6 +46,7 @@ cc_library(
         ":tcl",
     ],
     hdrs = [
+        "include/gpl/AbstractGraphics.h",
         "include/gpl/MakeReplace.h",
         "include/gpl/Replace.h",
     ],

src/gpl/CMakeLists.txt

@@ -24,34 +24,59 @@ swig_lib(NAME      gpl
          SCRIPTS   src/replace.tcl
 )
 
+add_library(gpl_lib
+  src/AbstractGraphics.cpp
+  src/replace.cpp
+  src/initialPlace.cpp
+  src/nesterovPlace.cpp
+  src/placerBase.cpp
+  src/nesterovBase.cpp
+  src/fft.cpp
+  src/fftsg.cpp
+  src/fftsg2d.cpp
+  src/routeBase.cpp
+  src/timingBase.cpp
+  src/graphicsNone.cpp
+  src/solver.cpp
+  src/mbff.cpp
+)
+
 target_sources(gpl
   PRIVATE
     src/MakeReplace.cpp
-    src/replace.cpp
-    src/initialPlace.cpp
-    src/nesterovPlace.cpp
-    src/placerBase.cpp
-    src/nesterovBase.cpp
-    src/fft.cpp
-    src/fftsg.cpp
-    src/fftsg2d.cpp
-    src/routeBase.cpp
-    src/timingBase.cpp
-    src/graphics.cpp
-    src/solver.cpp
-    src/mbff.cpp
+    src/graphicsImpl.cpp
 )
 
 messages(TARGET gpl)
+messages(TARGET gpl_lib)
 
 target_include_directories(gpl
+  PUBLIC
+    include
+)
+
+target_include_directories(gpl_lib
   PUBLIC
     include
     ${LEMON_INCLUDE_DIRS}
 )
 
+target_link_libraries(gpl_lib
+  PRIVATE
+    utl_lib
+    Eigen3::Eigen
+    odb
+    OpenSTA
+    rsz_lib
+    grt_lib
+    ortools::ortools
+    Threads::Threads
+    OpenMP::OpenMP_CXX
+)
+
 target_link_libraries(gpl
   PRIVATE
+    gpl_lib
     utl_lib
     Eigen3::Eigen
     gui

src/gpl/include/gpl/AbstractGraphics.h

@@ -0,0 +1,138 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (c) 2020-2025, The OpenROAD Authors
+
+#pragma once
+
+#include <memory>
+#include <optional>
+#include <string_view>
+#include <utility>
+#include <vector>
+
+#include "odb/db.h"
+#include "odb/geom.h"
+
+namespace gpl {
+
+class PlacerBaseCommon;
+class PlacerBase;
+class NesterovBase;
+class NesterovBaseCommon;
+class NesterovPlace;
+
+// This is an abstract interface for gpl to draw debugging graphics on the
+// layout.
+class AbstractGraphics
+{
+ public:
+  using LineSeg = std::pair<odb::Point, odb::Point>;
+  using LineSegs = std::vector<LineSeg>;
+
+  virtual ~AbstractGraphics();
+
+  // Create a new object of the same class.
+  virtual std::unique_ptr<AbstractGraphics> MakeNew(utl::Logger* logger) const
+      = 0;
+
+  // Turns debug on and sets mode to Mbff.
+  virtual void debugForMbff() = 0;
+
+  // Turns debug on and sets mode to Initial(place).
+  virtual void debugForInitialPlace(
+      std::shared_ptr<PlacerBaseCommon> pbc,
+      std::vector<std::shared_ptr<PlacerBase>>& pbVec)
+      = 0;
+
+  // Turns debug on and sets mode to Nesterov(place)
+  virtual void debugForNesterovPlace(
+      NesterovPlace* np,
+      std::shared_ptr<PlacerBaseCommon> pbc,
+      std::shared_ptr<NesterovBaseCommon> nbc,
+      std::vector<std::shared_ptr<PlacerBase>>& pbVec,
+      std::vector<std::shared_ptr<NesterovBase>>& nbVec,
+      bool draw_bins,
+      odb::dbInst* inst)
+      = 0;
+
+  // Draw the graphics; optionally pausing afterwards
+  void cellPlot(bool pause = false) { cellPlotImpl(pause); }
+
+  // Update the chart for the current iter
+  virtual void addIter(int iter, double overflow) = 0;
+  virtual void addTimingDrivenIter(int iter) = 0;
+  virtual void addRoutabilitySnapshot(int iter) = 0;
+  virtual void addRoutabilityIter(int iter, bool revert) = 0;
+
+  // Draw the MBFF mapping
+  virtual void mbffMapping(const LineSegs& segs) = 0;
+  virtual void mbffFlopClusters(const std::vector<odb::dbInst*>& ffs) = 0;
+
+  // Show a message in the status bar
+  virtual void status(std::string_view message) = 0;
+
+  // Is the graphics enabled or not.
+  //  Graphics could be disabled for
+  //
+  //  1. Debug not being on.
+  //  2. Being used as a library (ex. in a test).
+  //  3. The GUI is not displayed.
+  virtual bool enabled() = 0;
+
+  // Set the debug condition to `set_on`.
+  //
+  // Note that even if set, the graphics may still be disabled under conditions
+  // #2 and #3 of enabled() above.
+  virtual void setDebugOn(bool set_on) = 0;
+
+  void addFrameLabel(const odb::Rect& bbox,
+                     std::string_view label,
+                     std::string_view label_name,
+                     int image_width_px = 500)
+  {
+    addFrameLabelImpl(bbox, label, label_name, image_width_px);
+  }
+
+  void saveLabeledImage(std::string_view path,
+                        std::string_view label,
+                        bool select_buffers,
+                        std::string_view heatmap_control = "",
+                        int image_width_px = 500)
+  {
+    saveLabeledImageImpl(
+        path, label, select_buffers, heatmap_control, image_width_px);
+  }
+
+  // Gui functions.
+  virtual void gifStart(std::string_view path) = 0;
+  void gifAddFrame(const odb::Rect& region = odb::Rect(),
+                   int width_px = 0,
+                   double dbu_per_pixel = 0,
+                   std::optional<int> delay = std::nullopt)
+  {
+    gifAddFrameImpl(region, width_px, dbu_per_pixel, delay);
+  }
+  virtual void deleteLabel(std::string_view label_name) = 0;
+  virtual void gifEnd() = 0;
+
+ protected:
+  virtual void cellPlotImpl(bool pause) = 0;
+
+  virtual void addFrameLabelImpl(const odb::Rect& bbox,
+                                 std::string_view label,
+                                 std::string_view label_name,
+                                 int image_width_px)
+      = 0;
+  virtual void saveLabeledImageImpl(std::string_view path,
+                                    std::string_view label,
+                                    bool select_buffers,
+                                    std::string_view heatmap_control,
+                                    int image_width_px)
+      = 0;
+  virtual void gifAddFrameImpl(const odb::Rect& region,
+                               int width_px,
+                               double dbu_per_pixel,
+                               std::optional<int> delay)
+      = 0;
+};
+
+}  // namespace gpl

src/gpl/include/gpl/MakeReplace.h

@@ -4,11 +4,15 @@
 #pragma once
 
 #include <tcl.h>
+namespace utl {
+class Logger;
+}  // namespace utl
 
 namespace gpl {
 
 class Replace;
 
 void initReplace(Tcl_Interp* tcl_interp);
+void initReplaceGraphics(Replace* replace, utl::Logger* log);
 
 }  // namespace gpl

src/gpl/include/gpl/Replace.h

@@ -7,6 +7,8 @@
 #include <string>
 #include <vector>
 
+#include "AbstractGraphics.h"
+
 namespace odb {
 class dbDatabase;
 class dbInst;
@@ -46,13 +48,21 @@ using Clusters = std::vector<Cluster>;
 class Replace
 {
  public:
+  // Create a replace object with no graphics.
   Replace(odb::dbDatabase* odb,
           sta::dbSta* sta,
           rsz::Resizer* resizer,
           grt::GlobalRouter* router,
           utl::Logger* logger);
+
   ~Replace();
 
+  // Use the following class as a template for graphics interface.
+  //
+  // Note: no ownership is transfered as the object will create a new
+  // graphics object of the same class.
+  void setGraphicsInterface(const gpl::AbstractGraphics& graphics);
+
   void reset();
 
   void doIncrementalPlace(int threads);
@@ -130,6 +140,8 @@ class Replace
   grt::GlobalRouter* fr_ = nullptr;
   utl::Logger* log_ = nullptr;
 
+  std::unique_ptr<AbstractGraphics> graphics_;
+
   std::shared_ptr<PlacerBaseCommon> pbc_;
   std::shared_ptr<NesterovBaseCommon> nbc_;
   std::vector<std::shared_ptr<PlacerBase>> pbVec_;

src/gpl/src/AbstractGraphics.cpp

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (c) 2020-2025, The OpenROAD Authors
+
+#include "gpl/AbstractGraphics.h"
+
+namespace gpl {
+
+AbstractGraphics::~AbstractGraphics() = default;
+
+}  // namespace gpl

src/gpl/src/MakeReplace.cpp

@@ -6,6 +6,8 @@
 #include <tcl.h>
 
 #include "gpl/Replace.h"
+#include "graphicsImpl.h"
+#include "utl/Logger.h"
 #include "utl/decode.h"
 
 extern "C" {
@@ -22,4 +24,9 @@ void initReplace(Tcl_Interp* tcl_interp)
   utl::evalTclInit(tcl_interp, gpl::gpl_tcl_inits);
 }
 
+void initReplaceGraphics(Replace* replace, utl::Logger* log)
+{
+  replace->setGraphicsInterface(gpl::GraphicsImpl(log));
+}
+
 }  // namespace gpl