[Preview] OpenROAD web server as new GUI

.bazelrc

@@ -15,6 +15,7 @@ test --test_timeout=300,1800,1800,9600
 # bazel 7 is somewhat forgiving for glob patterns that don't
 # match, but bazel 8 will be strict. So start now.
 common --incompatible_disallow_empty_glob
+common --experimental_isolated_extension_usages
 
 build --cxxopt "-std=c++20"        --host_cxxopt "-std=c++20"
 build --cxxopt "-xc++"             --host_cxxopt "-xc++"

BUILD.bazel

@@ -126,6 +126,8 @@ OPENROAD_LIBRARY_DEPS = [
     "//src/upf:ui",
     "//src/utl",
     "//src/utl:ui",
+    "//src/web",
+    "//src/web:ui",
     "@abc",
     ":ord",
 ] + select(

MODULE.bazel

@@ -79,6 +79,10 @@ bazel_dep(name = "readline", version = "8.2.bcr.3")
 bazel_dep(name = "bant", version = "0.2.4", dev_dependency = True)
 bazel_dep(name = "googletest", version = "1.17.0.bcr.2", dev_dependency = True)
 
+# JavaScript unit tests
+bazel_dep(name = "aspect_rules_js", version = "3.0.2", dev_dependency = True)
+bazel_dep(name = "rules_nodejs", version = "6.7.3", dev_dependency = True)
+
 # A from source build of QT that allows it to link into OpenROAD.
 # Building like any other bazel project. scripts in the docker folder
 # of this project generate stubs .ifso for things like X11 that will
@@ -123,6 +127,25 @@ pip.parse(
 )
 use_repo(pip, "openroad-pip")
 
+node = use_extension(
+    "@rules_nodejs//nodejs:extensions.bzl",
+    "node",
+    dev_dependency = True,
+)
+node.toolchain(node_version = "22.14.0")
+
+npm = use_extension(
+    "@aspect_rules_js//npm:extensions.bzl",
+    "npm",
+    dev_dependency = True,
+    isolate = True,
+)
+npm.npm_translate_lock(
+    name = "npm",
+    pnpm_lock = "//src/web:pnpm-lock.yaml",
+)
+use_repo(npm, "npm")
+
 bazel_dep(name = "bazel-orfs", dev_dependency = True)
 
 # To bump version, run: bazelisk run @bazel-orfs//:bump

etc/Build.sh

@@ -265,4 +265,4 @@ if [[ "$isNinja" == "yes" ]]; then
     exit 0
 fi
 eval cmake "${cmakeOptions}" -B "${buildDir}" .
-eval time cmake --build "${buildDir}" -j "${numThreads}"
+eval time cmake --build "${buildDir}" -j "${numThreads}"

include/ord/OpenRoad.hh

@@ -128,6 +128,10 @@ namespace est {
 class EstimateParasitics;
 }
 
+namespace web {
+class WebServer;
+}
+
 namespace ord {
 
 class dbVerilogNetwork;
@@ -181,6 +185,7 @@ class OpenRoad
   {
     return estimate_parasitics_;
   }
+  web::WebServer* getWebServer() { return web_server_; }
 
   // Return the bounding box of the db rows.
   odb::Rect getCore();
@@ -284,6 +289,7 @@ class OpenRoad
   stt::SteinerTreeBuilder* stt_builder_ = nullptr;
   dft::Dft* dft_ = nullptr;
   est::EstimateParasitics* estimate_parasitics_ = nullptr;
+  web::WebServer* web_server_ = nullptr;
   utl::CallBackHandler* callback_handler_ = nullptr;
 
   int threads_ = 1;

src/CMakeLists.txt

@@ -288,6 +288,7 @@ add_subdirectory(dft)
 add_subdirectory(mpl)
 add_subdirectory(par)
 add_subdirectory(est)
+add_subdirectory(web)
 
 ################################################################
 
@@ -358,6 +359,7 @@ target_link_libraries(openroad
   mpl
   par
   est
+  web
   absl::synchronization
   ${ABC_LIBRARY}
   ${TCL_LIBRARY}
@@ -437,6 +439,7 @@ if (Python3_FOUND AND BUILD_PYTHON)
     pdn_py
     dft_py
     par_py
+    web_py
   )
 
 else()

src/Main.cc

@@ -64,6 +64,7 @@ using std::string;
   X(gpl)                                 \
   X(dpl)                                 \
   X(exa)                                 \
+  X(web)                                 \
   X(ppl)                                 \
   X(tap)                                 \
   X(cts)                                 \

src/OpenRoad.cc

@@ -90,6 +90,8 @@
 #include "utl/Progress.h"
 #include "utl/ScopedTemporaryFile.h"
 #include "utl/decode.h"
+#include "web/MakeWeb.h"
+#include "web/web.h"
 
 namespace ord {
 extern const char* ord_tcl_inits[];
@@ -146,6 +148,7 @@ OpenRoad::~OpenRoad()
   delete stt_builder_;
   delete dft_;
   delete estimate_parasitics_;
+  delete web_server_;
   delete logger_;
   delete verilog_reader_;
   delete callback_handler_;
@@ -256,6 +259,7 @@ void OpenRoad::init(Tcl_Interp* tcl_interp,
   icewall_ = new pad::ICeWall(db_, logger_);
   dft_ = new dft::Dft(db_, sta_, logger_);
   example_ = new exa::Example(db_, logger_);
+  web_server_ = new web::WebServer(db_, sta_, logger_, tcl_interp);
 
   // Init components.
   Ord_Init(tcl_interp);
@@ -295,6 +299,7 @@ void OpenRoad::init(Tcl_Interp* tcl_interp,
   stt::initSteinerTreeBuilder(tcl_interp);
   dft::initDft(tcl_interp);
   est::initTcl(tcl_interp);
+  web::initWeb(tcl_interp);
 
   // Import exported commands to global namespace.
   Tcl_Eval(tcl_interp, "sta::define_sta_cmds");

src/grt/CMakeLists.txt

@@ -39,6 +39,7 @@ target_link_libraries(grt_lib
     ant_lib
     dpl_lib
     dbSta_lib
+    gui_heatmap_core
     stt_lib
     rsz_lib
     OpenSTA
@@ -94,6 +95,7 @@ if (Python3_FOUND AND BUILD_PYTHON)
       dpl_lib
       dbSta
       gui
+      gui_heatmap_core
       stt
       OpenSTA
       Boost::boost

src/grt/include/grt/GlobalRouter.h

@@ -55,6 +55,11 @@ class dbNetwork;
 class SpefWriter;
 }  // namespace sta
 
+namespace gui {
+class HeatMapSourceRegistration;
+using HeatMapSourceHandle = std::shared_ptr<HeatMapSourceRegistration>;
+}  // namespace gui
+
 namespace grt {
 
 class FastRouteCore;
@@ -69,7 +74,6 @@ class RoutePt;
 class AbstractGrouteRenderer;
 class AbstractFastRouteRenderer;
 class GlobalRouter;
-class AbstractRoutingCongestionDataSource;
 class GRouteDbCbk;
 class Rudy;
 
@@ -122,10 +126,8 @@ class GlobalRouter
                dpl::Opendp* opendp);
   ~GlobalRouter();
 
-  void initGui(std::unique_ptr<AbstractRoutingCongestionDataSource>
-                   routing_congestion_data_source,
-               std::unique_ptr<AbstractRoutingCongestionDataSource>
-                   routing_congestion_data_source_rudy);
+  void initGui(gui::HeatMapSourceHandle routing_congestion_data_source,
+               gui::HeatMapSourceHandle routing_congestion_data_source_rudy);
 
   void clear();
 
@@ -564,8 +566,8 @@ class GlobalRouter
 
   RepairAntennas* repair_antennas_;
   Rudy* rudy_;
-  std::unique_ptr<AbstractRoutingCongestionDataSource> heatmap_;
-  std::unique_ptr<AbstractRoutingCongestionDataSource> heatmap_rudy_;
+  gui::HeatMapSourceHandle heatmap_;
+  gui::HeatMapSourceHandle heatmap_rudy_;
 
   // variables congestion report file
   const char* congestion_file_name_;

src/grt/src/GlobalRouter.cpp

@@ -26,7 +26,6 @@
 
 #include "AbstractFastRouteRenderer.h"
 #include "AbstractGrouteRenderer.h"
-#include "AbstractRoutingCongestionDataSource.h"
 #include "CUGR.h"
 #include "DataType.h"
 #include "FastRoute.h"
@@ -42,6 +41,7 @@
 #include "grt/GRoute.h"
 #include "grt/PinGridLocation.h"
 #include "grt/Rudy.h"
+#include "gui/heatMap.h"
 #include "odb/db.h"
 #include "odb/dbObject.h"
 #include "odb/dbSet.h"
@@ -109,15 +109,12 @@ GlobalRouter::GlobalRouter(utl::Logger* logger,
   cugr_ = new CUGR(db_, logger_, callback_handler_, stt_builder_, sta_);
 }
 
-void GlobalRouter::initGui(std::unique_ptr<AbstractRoutingCongestionDataSource>
-                               routing_congestion_data_source,
-                           std::unique_ptr<AbstractRoutingCongestionDataSource>
-                               routing_congestion_data_source_rudy)
+void GlobalRouter::initGui(
+    gui::HeatMapSourceHandle routing_congestion_data_source,
+    gui::HeatMapSourceHandle routing_congestion_data_source_rudy)
 {
   heatmap_ = std::move(routing_congestion_data_source);
-  heatmap_->registerHeatMap();
   heatmap_rudy_ = std::move(routing_congestion_data_source_rudy);
-  heatmap_rudy_->registerHeatMap();
 }
 
 void GlobalRouter::clear()
@@ -479,7 +476,12 @@ void GlobalRouter::updateDbCongestion()
   } else {
     fastroute_->updateDbCongestion(min_layer, max_layer);
   }
-  heatmap_->update();
+  if (heatmap_) {
+    heatmap_->invalidateInstances();
+  }
+  if (heatmap_rudy_) {
+    heatmap_rudy_->invalidateInstances();
+  }
 }
 
 int GlobalRouter::repairAntennas(odb::dbMTerm* diode_mterm,
@@ -2433,7 +2435,12 @@ void GlobalRouter::readGuides(const char* file_name)
   updateEdgesUsage();
   computeGCellGridPatternFromGuides(guides);
   updateDbCongestionFromGuides();
-  heatmap_->update();
+  if (heatmap_) {
+    heatmap_->invalidateInstances();
+  }
+  if (heatmap_rudy_) {
+    heatmap_rudy_->invalidateInstances();
+  }
   saveGuidesFromFile(guides);
 }
 
@@ -2472,7 +2479,12 @@ void GlobalRouter::loadGuidesFromDB()
   if (block_->getGCellGrid() == nullptr) {
     updateDbCongestion();
   }
-  heatmap_->update();
+  if (heatmap_) {
+    heatmap_->invalidateInstances();
+  }
+  if (heatmap_rudy_) {
+    heatmap_rudy_->invalidateInstances();
+  }
 }
 
 void GlobalRouter::ensurePinsPositions(odb::dbNet* db_net)

src/grt/src/MakeGlobalRouter.cpp

@@ -23,8 +23,8 @@ extern const char* grt_tcl_inits[];
 
 void initGui(grt::GlobalRouter* grt, odb::dbDatabase* db, utl::Logger* logger)
 {
-  grt->initGui(std::make_unique<grt::RoutingCongestionDataSource>(logger, db),
-               std::make_unique<grt::RUDYDataSource>(logger, grt, db));
+  grt->initGui(grt::registerRoutingCongestionHeatMapSource(logger, db),
+               grt::registerRudyHeatMapSource(logger, grt, db));
 }
 
 void initTcl(Tcl_Interp* tcl_interp)

src/grt/src/heatMap.cpp

@@ -5,6 +5,7 @@
 
 #include <algorithm>
 #include <cstdint>
+#include <memory>
 #include <vector>
 
 #include "gui/heatMap.h"
@@ -14,6 +15,16 @@
 
 namespace grt {
 
+gui::HeatMapSourceHandle registerRoutingCongestionHeatMapSource(
+    utl::Logger* logger,
+    odb::dbDatabase* db)
+{
+  return gui::registerHeatMapSource(
+      "Routing Congestion", "Routing", "RoutingCongestion", [logger, db]() {
+        return std::make_shared<RoutingCongestionDataSource>(logger, db);
+      });
+}
+
 RoutingCongestionDataSource::RoutingCongestionDataSource(utl::Logger* logger,
                                                          odb::dbDatabase* db)
     : gui::GlobalRoutingDataSource(logger,

src/grt/src/heatMap.h

@@ -5,21 +5,16 @@
 
 #include <string>
 
-#include "AbstractRoutingCongestionDataSource.h"
 #include "gui/heatMap.h"
 #include "odb/db.h"
 
 namespace grt {
 
-class RoutingCongestionDataSource : public gui::GlobalRoutingDataSource,
-                                    public AbstractRoutingCongestionDataSource
+class RoutingCongestionDataSource : public gui::GlobalRoutingDataSource
 {
  public:
   RoutingCongestionDataSource(utl::Logger* logger, odb::dbDatabase* db);
 
-  void registerHeatMap() override { gui::HeatMapDataSource::registerHeatMap(); }
-  void update() override { gui::HeatMapDataSource::update(); }
-
  protected:
   bool populateMap() override;
   void combineMapData(bool base_has_value,
@@ -65,4 +60,8 @@ class RoutingCongestionDataSource : public gui::GlobalRoutingDataSource,
   double max_;
 };
 
+gui::HeatMapSourceHandle registerRoutingCongestionHeatMapSource(
+    utl::Logger* logger,
+    odb::dbDatabase* db);
+
 }  // namespace grt

src/grt/src/heatMapRudy.cpp

@@ -6,6 +6,7 @@
 #include <algorithm>
 #include <any>
 #include <cmath>
+#include <memory>
 #include <set>
 #include <stdexcept>
 #include <vector>
@@ -20,6 +21,16 @@
 
 namespace grt {
 
+gui::HeatMapSourceHandle registerRudyHeatMapSource(utl::Logger* logger,
+                                                   grt::GlobalRouter* grouter,
+                                                   odb::dbDatabase* db)
+{
+  return gui::registerHeatMapSource(
+      "Estimated Congestion (RUDY)", "RUDY", "RUDY", [logger, grouter, db]() {
+        return std::make_shared<RUDYDataSource>(logger, grouter, db);
+      });
+}
+
 RUDYDataSource::RUDYDataSource(utl::Logger* logger,
                                grt::GlobalRouter* grouter,
                                odb::dbDatabase* db)