Merge pull request #6841 from The-OpenROAD-Project-staging/rsz-graphics

maliberty · web-flow · commit e6864059545b · 2025-03-13T00:39:31.000Z
rsz: add debug Graphics class and simple subdivide renderer
diff --git a/src/rsz/include/rsz/Resizer.hh b/src/rsz/include/rsz/Resizer.hh
@@ -138,6 +138,7 @@ class RecoverPower;
 class RepairDesign;
 class RepairSetup;
 class RepairHold;
+class ResizerObserver;
 
 class SpefWriter;
 
@@ -445,6 +446,7 @@ class Resizer : public dbStaState, public dbNetworkObserver
   std::optional<float> cellLeakage(LibertyCell* cell);
   // For debugging - calls getSwappableCells
   void reportEquivalentCells(LibertyCell* base_cell, bool match_cell_footprint);
+  void setDebugGraphics(std::shared_ptr<ResizerObserver> graphics);
 
  protected:
   void init();
@@ -828,6 +830,8 @@ class Resizer : public dbStaState, public dbNetworkObserver
   std::unordered_map<size_t, int>
       vt_hash_map_;  // maps hash value to unique int
 
+  std::shared_ptr<ResizerObserver> graphics_;
+
   friend class BufferedNet;
   friend class GateCloner;
   friend class PreChecks;
diff --git a/src/rsz/src/CMakeLists.txt b/src/rsz/src/CMakeLists.txt
@@ -59,6 +59,7 @@ add_library(rsz_lib
 
 target_sources(rsz
   PRIVATE
+    Graphics.cc
     MakeResizer.cc
     SteinerRenderer.cc
 )
@@ -70,6 +71,7 @@ target_include_directories(rsz
     # A side-effect of including OpenSTA swig files
     ${OPENSTA_HOME}
     ${OPENSTA_HOME}/include/sta
+    .
 )
 
 target_include_directories(rsz_lib
diff --git a/src/rsz/src/Graphics.cc b/src/rsz/src/Graphics.cc
@@ -0,0 +1,94 @@
+/////////////////////////////////////////////////////////////////////////////
+//
+// Copyright (c) 2025, Precision Innovations Inc.
+// All rights reserved.
+//
+// BSD 3-Clause License
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+// * Redistributions of source code must retain the above copyright notice, this
+//   list of conditions and the following disclaimer.
+//
+// * Redistributions in binary form must reproduce the above copyright notice,
+//   this list of conditions and the following disclaimer in the documentation
+//   and/or other materials provided with the distribution.
+//
+// * Neither the name of the copyright holder nor the names of its
+//   contributors may be used to endorse or promote products derived from
+//   this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+//
+///////////////////////////////////////////////////////////////////////////////
+
+#include "Graphics.hh"
+
+namespace rsz {
+
+Graphics::Graphics()
+{
+  gui::Gui::get()->registerRenderer(this);
+}
+
+void Graphics::setNet(odb::dbNet* net)
+{
+  net_ = net;
+  if (!net) {
+    subdivide_ignore_ = false;
+  }
+}
+
+void Graphics::stopOnSubdivideStep(const bool stop)
+{
+  stop_on_subdivide_step_ = stop;
+}
+
+void Graphics::subdivideStart(odb::dbNet* net)
+{
+  lines_.clear();
+  if (net_) {
+    subdivide_ignore_ = (net != net_);
+  }
+}
+
+void Graphics::subdivide(const odb::Line& line)
+{
+  if (subdivide_ignore_) {
+    return;
+  }
+  lines_.emplace_back(line);
+  if (stop_on_subdivide_step_) {
+    gui::Gui::get()->redraw();
+    gui::Gui::get()->pause();
+  }
+}
+
+void Graphics::subdivideDone()
+{
+  if (!subdivide_ignore_) {
+    gui::Gui::get()->redraw();
+    gui::Gui::get()->pause();
+  }
+}
+
+void Graphics::drawObjects(gui::Painter& painter)
+{
+  painter.setPen(gui::Painter::red, true);
+  for (const odb::Line& line : lines_) {
+    painter.drawLine(line.pt0(), line.pt1());
+  }
+}
+
+}  // namespace rsz
diff --git a/src/rsz/src/Graphics.hh b/src/rsz/src/Graphics.hh
@@ -0,0 +1,67 @@
+/////////////////////////////////////////////////////////////////////////////
+//
+// Copyright (c) 2025, Precision Innovations Inc.
+// All rights reserved.
+//
+// BSD 3-Clause License
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+// * Redistributions of source code must retain the above copyright notice, this
+//   list of conditions and the following disclaimer.
+//
+// * Redistributions in binary form must reproduce the above copyright notice,
+//   this list of conditions and the following disclaimer in the documentation
+//   and/or other materials provided with the distribution.
+//
+// * Neither the name of the copyright holder nor the names of its
+//   contributors may be used to endorse or promote products derived from
+//   this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+//
+///////////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include "ResizerObserver.hh"
+#include "gui/gui.h"
+
+namespace rsz {
+
+class Graphics : public gui::Renderer, public ResizerObserver
+{
+ public:
+  Graphics();
+
+  // ResizerObserver
+  void setNet(odb::dbNet* net) override;
+  void stopOnSubdivideStep(bool stop) override;
+  void subdivideStart(odb::dbNet* net) override;
+  void subdivide(const odb::Line& line) override;
+  void subdivideDone() override;
+
+  // Renderer
+  void drawObjects(gui::Painter& painter) override;
+
+ private:
+  odb::dbNet* net_{nullptr};
+  std::vector<odb::Line> lines_;
+  // Ingore this net if true
+  bool subdivide_ignore_{false};
+  // stop at each step?
+  bool stop_on_subdivide_step_{false};
+};
+
+}  // namespace rsz
diff --git a/src/rsz/src/RepairDesign.cc b/src/rsz/src/RepairDesign.cc
@@ -38,6 +38,7 @@
 #include <vector>
 
 #include "BufferedNet.hh"
+#include "ResizerObserver.hh"
 #include "db_sta/dbNetwork.hh"
 #include "rsz/Resizer.hh"
 #include "sta/Corner.hh"
@@ -670,7 +671,7 @@ void RepairDesign::repairNet(Net* net,
         repaired_net = true;
 
         debugPrint(logger_, RSZ, "repair_net", 3, "fanout violation");
-        LoadRegion region = findLoadRegions(drvr_pin, max_fanout);
+        LoadRegion region = findLoadRegions(net, drvr_pin, max_fanout);
         corner_ = corner;
         makeRegionRepeaters(region,
                             max_fanout,
@@ -1480,12 +1481,21 @@ LoadRegion::LoadRegion(PinSeq& pins, Rect& bbox) : pins_(pins), bbox_(bbox)
 {
 }
 
-LoadRegion RepairDesign::findLoadRegions(const Pin* drvr_pin, int max_fanout)
+LoadRegion RepairDesign::findLoadRegions(const Net* net,
+                                         const Pin* drvr_pin,
+                                         int max_fanout)
 {
   PinSeq loads = findLoads(drvr_pin);
   Rect bbox = findBbox(loads);
   LoadRegion region(loads, bbox);
+  if (graphics_) {
+    odb::dbNet* db_net = db_network_->staToDb(net);
+    graphics_->subdivideStart(db_net);
+  }
   subdivideRegion(region, max_fanout);
+  if (graphics_) {
+    graphics_->subdivideDone();
+  }
   return region;
 }
 
@@ -1498,17 +1508,20 @@ void RepairDesign::subdivideRegion(LoadRegion& region, int max_fanout)
     int y_min = region.bbox_.yMin();
     int y_max = region.bbox_.yMax();
     region.regions_.resize(2);
-    int64_t x_mid = (x_min + x_max) / 2;
-    int64_t y_mid = (y_min + y_max) / 2;
+    int x_mid = (x_min + x_max) / 2;
+    int y_mid = (y_min + y_max) / 2;
     bool horz_partition;
+    odb::Line cut;
     if (region.bbox_.dx() > region.bbox_.dy()) {
       region.regions_[0].bbox_ = Rect(x_min, y_min, x_mid, y_max);
       region.regions_[1].bbox_ = Rect(x_mid, y_min, x_max, y_max);
+      cut = odb::Line{x_mid, y_min, x_mid, y_max};
       horz_partition = true;
     } else {
       region.regions_[0].bbox_ = Rect(x_min, y_min, x_max, y_mid);
       region.regions_[1].bbox_ = Rect(x_min, y_mid, x_max, y_max);
       horz_partition = false;
+      cut = odb::Line{x_min, y_mid, x_max, y_mid};
     }
     for (const Pin* pin : region.pins_) {
       Point loc = db_network_->location(pin);
@@ -1523,6 +1536,9 @@ void RepairDesign::subdivideRegion(LoadRegion& region, int max_fanout)
         logger_->critical(RSZ, 83, "pin outside regions");
       }
     }
+    if (graphics_) {
+      graphics_->subdivide(cut);
+    }
     region.pins_.clear();
     for (LoadRegion& sub : region.regions_) {
       if (!sub.pins_.empty()) {
@@ -2233,4 +2249,9 @@ void RepairDesign::reportViolationCounters(bool invalidate_driver_vertices,
   }
 }
 
+void RepairDesign::setDebugGraphics(std::shared_ptr<ResizerObserver> graphics)
+{
+  graphics_ = std::move(graphics);
+}
+
 }  // namespace rsz
diff --git a/src/rsz/src/RepairDesign.hh b/src/rsz/src/RepairDesign.hh
@@ -113,6 +113,7 @@ class RepairDesign : dbStaState
                                int fanout_violations,
                                int length_violations,
                                int repaired_net_count);
+  void setDebugGraphics(std::shared_ptr<ResizerObserver> graphics);
 
  protected:
   void init();
@@ -198,7 +199,9 @@ class RepairDesign : dbStaState
                       double load_cap,
                       double slew,
                       const DcalcAnalysisPt* dcalc_ap);
-  LoadRegion findLoadRegions(const Pin* drvr_pin, int max_fanout);
+  LoadRegion findLoadRegions(const Net* net,
+                             const Pin* drvr_pin,
+                             int max_fanout);
   void subdivideRegion(LoadRegion& region, int max_fanout);
   void makeRegionRepeaters(LoadRegion& region,
                            int max_fanout,
@@ -280,6 +283,7 @@ class RepairDesign : dbStaState
   const MinMax* max_ = MinMax::max();
 
   int print_interval_ = 0;
+  std::shared_ptr<ResizerObserver> graphics_;
 
   // Elmore factor for 20-80% slew thresholds.
   static constexpr float elmore_skew_factor_ = 1.39;
diff --git a/src/rsz/src/Resizer.cc b/src/rsz/src/Resizer.cc
@@ -47,6 +47,7 @@
 #include "RepairDesign.hh"
 #include "RepairHold.hh"
 #include "RepairSetup.hh"
+#include "ResizerObserver.hh"
 #include "boost/multi_array.hpp"
 #include "db_sta/dbNetwork.hh"
 #include "sta/ArcDelayCalc.hh"
@@ -4606,4 +4607,10 @@ void Resizer::copyDontUseFromLiberty()
   }
 }
 
+void Resizer::setDebugGraphics(std::shared_ptr<ResizerObserver> graphics)
+{
+  repair_design_->setDebugGraphics(graphics);
+  graphics_ = std::move(graphics);
+}
+
 }  // namespace rsz
diff --git a/src/rsz/src/Resizer.i b/src/rsz/src/Resizer.i
@@ -44,6 +44,7 @@
 #include "rsz/Resizer.hh"
 #include "sta/Delay.hh"
 #include "db_sta/dbNetwork.hh"
+#include "Graphics.hh"
 
 namespace ord {
 // Defined in OpenRoad.i
@@ -777,6 +778,23 @@ void report_equiv_cells_cmd(LibertyCell* cell, bool match_cell_footprint)
   resizer->reportEquivalentCells(cell, match_cell_footprint);
 }
 
+void set_debug_cmd(const char* net_name,
+                   const bool subdivide_step)
+{
+  Resizer* resizer = getResizer();
+
+  odb::dbNet* net = nullptr;
+  if (net_name) {
+    auto block = ord::OpenRoad::openRoad()->getDb()->getChip()->getBlock();
+    net = block->findNet(net_name);
+  }
+
+  auto graphics = std::make_shared<Graphics>();
+  graphics->setNet(net);
+  graphics->stopOnSubdivideStep(subdivide_step);
+  resizer->setDebugGraphics(std::move(graphics));
+}
+
 } // namespace
 
 %} // inline
diff --git a/src/rsz/src/Resizer.tcl b/src/rsz/src/Resizer.tcl
@@ -980,6 +980,21 @@ proc repair_setup_pin { end_pin } {
   repair_setup_pin_cmd $end_pin
 }
 
+proc set_debug { args } {
+  sta::parse_key_args "set_debug" args \
+    keys { -net } \
+    flags { -subdivide_step } ;# checker off
+
+  set net ""
+  if { [info exists keys(-net)] } {
+    set net $keys(-net)
+  }
+
+  set subdivide_step [info exists flags(-subdivide_step)]
+
+  rsz::set_debug_cmd $net $subdivide_step
+}
+
 proc report_swappable_pins { } {
   report_swappable_pins_cmd
 }
diff --git a/src/rsz/src/ResizerObserver.hh b/src/rsz/src/ResizerObserver.hh

Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,7 @@ add_library(rsz_lib`
`59`	`59`
`60`	`60`	`target_sources(rsz`
`61`	`61`	`PRIVATE`
	`62`	`+ Graphics.cc`
`62`	`63`	`MakeResizer.cc`
`63`	`64`	`SteinerRenderer.cc`
`64`	`65`	`)`
`@@ -70,6 +71,7 @@ target_include_directories(rsz`
`70`	`71`	`# A side-effect of including OpenSTA swig files`
`71`	`72`	`${OPENSTA_HOME}`
`72`	`73`	`${OPENSTA_HOME}/include/sta`
	`74`	`+ .`
`73`	`75`	`)`
`74`	`76`
`75`	`77`	`target_include_directories(rsz_lib`