Merge pull request #8766 from The-OpenROAD-Project-staging/grt-rudy-selection

grt: Add option of RUDY on nets from selection

Author: maliberty

src/grt/include/grt/Rudy.h

@@ -2,6 +2,8 @@
 // Copyright (c) 2024-2025, The OpenROAD Authors
 
 #include <cassert>
+#include <optional>
+#include <set>
 #include <utility>
 // #define _CRTDBG_MAP_ALLOC
 
@@ -39,7 +41,8 @@ class Rudy
    * \pre we need to call this function after `setGridConfig` and
    * `setWireWidth`.
    * */
-  void calculateRudy();
+  void calculateRudy(std::optional<std::set<odb::dbNet*>*> selection
+                     = std::nullopt);
 
   /**
    * Set the grid area and grid numbers.
@@ -65,6 +68,7 @@ class Rudy
   void makeGrid();
   void getResourceReductions();
   Tile& getEditableTile(int x, int y) { return grid_.at(x).at(y); }
+  void processNet(odb::dbNet* net);
   void processIntersectionSignalNet(odb::Rect net_rect);
 
   odb::dbBlock* block_;

src/grt/src/Rudy.cpp

@@ -5,6 +5,8 @@
 
 #include <algorithm>
 #include <cstdint>
+#include <optional>
+#include <set>
 #include <utility>
 
 #include "grt/GRoute.h"
@@ -104,7 +106,7 @@ void Rudy::getResourceReductions()
   }
 }
 
-void Rudy::calculateRudy()
+void Rudy::calculateRudy(std::optional<std::set<odb::dbNet*>*> selection)
 {
   // Clear previous computation
   for (auto& grid_column : grid_) {
@@ -115,15 +117,26 @@ void Rudy::calculateRudy()
 
   getResourceReductions();
 
-  // refer: https://ieeexplore.ieee.org/document/4211973
-  for (auto net : block_->getNets()) {
-    if (!net->getSigType().isSupply()) {
-      const auto net_rect = net->getTermBBox();
-      processIntersectionSignalNet(net_rect);
+  if (selection.has_value()) {
+    for (auto net : *selection.value()) {
+      processNet(net);
+    }
+  } else {
+    for (auto net : block_->getNets()) {
+      processNet(net);
     }
   }
 }
 
+void Rudy::processNet(odb::dbNet* net)
+{
+  // refer: https://ieeexplore.ieee.org/document/4211973
+  if (!net->getSigType().isSupply()) {
+    const auto net_rect = net->getTermBBox();
+    processIntersectionSignalNet(net_rect);
+  }
+}
+
 void Rudy::processIntersectionSignalNet(const odb::Rect net_rect)
 {
   const auto net_area = net_rect.area();

src/grt/src/heatMapRudy.cpp

@@ -4,10 +4,13 @@
 #include "heatMapRudy.h"
 
 #include <algorithm>
+#include <any>
 #include <cmath>
+#include <set>
 #include <stdexcept>
 #include <vector>
 
+#include "gui/gui.h"
 #include "odb/db.h"
 #include "odb/dbTypes.h"
 #include "odb/geom.h"
@@ -20,11 +23,19 @@ RUDYDataSource::RUDYDataSource(utl::Logger* logger,
     : GlobalRoutingDataSource(logger,
                               "Estimated Congestion (RUDY)",
                               "RUDY",
-                              "RUDY")
+                              "RUDY"),
+      selection_only_(false)
 {
   grouter_ = grouter;
   db_ = db;
   rudy_ = nullptr;
+  selection_only_ = false;
+
+  addBooleanSetting(
+      "Selection",
+      "Only consider nets in selection",
+      [this]() { return selection_only_; },
+      [this](bool value) { selection_only_ = value; });
 }
 
 void RUDYDataSource::combineMapData(bool base_has_value,
@@ -108,7 +119,17 @@ bool RUDYDataSource::populateMap()
     return false;
   }
 
-  rudy_->calculateRudy();
+  if (selection_only_ && gui::Gui::enabled()) {
+    std::set<odb::dbNet*> selection;
+    for (const gui::Selected& item : gui::Gui::get()->selection()) {
+      if (item.isNet()) {
+        selection.insert(std::any_cast<odb::dbNet*>(item.getObject()));
+      }
+    }
+    rudy_->calculateRudy(&selection);
+  } else {
+    rudy_->calculateRudy();
+  }
 
   for (int x = 0; x < x_grid_size; ++x) {
     for (int y = 0; y < y_grid_size; ++y) {

src/grt/src/heatMapRudy.h

@@ -58,6 +58,7 @@ class RUDYDataSource : public gui::GlobalRoutingDataSource,
   grt::GlobalRouter* grouter_;
   odb::dbDatabase* db_;
   grt::Rudy* rudy_;
+  bool selection_only_;
 };
 
 }  // namespace grt

src/gui/include/gui/gui.h

@@ -639,6 +639,9 @@ class Gui
   // Add an instance to the selection set
   void addSelectedInst(const char* name);
 
+  // Return the selected set
+  const SelectionSet& selection();
+
   // check if any object(inst/net) is present in sect/highlight set
   bool anyObjectInSet(bool selection_set, odb::dbObjectType obj_type) const;
 

src/gui/src/gui.cpp

@@ -334,6 +334,11 @@ void Gui::addSelectedInst(const char* name)
   main_window->addSelected(makeSelected(inst));
 }
 
+const SelectionSet& Gui::selection()
+{
+  return main_window->selection();
+}
+
 bool Gui::anyObjectInSet(bool selection_set, odb::dbObjectType obj_type) const
 {
   return main_window->anyObjectInSet(selection_set, obj_type);

src/gui/src/mainWindow.cpp

@@ -530,6 +530,11 @@ void MainWindow::updateTitle()
   }
 }
 
+const SelectionSet& MainWindow::selection()
+{
+  return selected_;
+}
+
 void MainWindow::setBlock(odb::dbBlock* block)
 {
   updateTitle();

src/gui/src/mainWindow.h

@@ -100,6 +100,9 @@ class MainWindow : public QMainWindow, public odb::dbDatabaseObserver
 
   void setTitle(const std::string& title);
 
+  // Return the selected set
+  const SelectionSet& selection();
+
  signals:
   // Signaled when we get a postRead callback to tell the sub-widgets
   // to update

src/gui/src/stub.cpp

@@ -133,6 +133,12 @@ void Gui::setSelected(const Selected& selection)
 {
 }
 
+const SelectionSet& Gui::selection()
+{
+  static SelectionSet dummy;
+  return dummy;
+}
+
 void Gui::registerDescriptor(const std::type_info& type,
                              const Descriptor* descriptor)
 {