Merge pull request #10240 from The-OpenROAD-Project-staging/web-debug-graphics

web: add debug graphics support via gui::HeadlessViewer

Author: maliberty

src/Main.cc

@@ -450,7 +450,10 @@ static int tclAppInit(int& argc,
     }
   }
 #ifdef ENABLE_READLINE
-  if (!gui::Gui::enabled() && !exit_after_cmd_file) {
+  // Initialize readline unless the Qt GUI is active (it has its own
+  // script widget).  The web viewer's headless mode still needs the
+  // terminal prompt.
+  if (!gui::Gui::hasUI() && !exit_after_cmd_file) {
     return tclOrdReadlineInit(interp);
   }
 #endif

src/OpenRoad.cc

@@ -134,6 +134,9 @@ OpenRoad::~OpenRoad()
   delete example_;
   delete extractor_;
   delete detailed_router_;
+  // Stop the web server first — its I/O threads access the database
+  // for tile rendering, so it must be torn down before the DB.
+  delete web_server_;
   delete replace_;
   delete pdnsim_;
   delete finale_;
@@ -147,7 +150,6 @@ OpenRoad::~OpenRoad()
   delete stt_builder_;
   delete dft_;
   delete estimate_parasitics_;
-  delete web_server_;
   delete logger_;
   delete verilog_reader_;
   delete service_registry_;
@@ -257,7 +259,8 @@ 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);
+  web_server_
+      = new web::WebServer(db_, sta_, logger_, tcl_interp, getThreadCount());
 
   // Init components.
   Ord_Init(tcl_interp);

src/gui/include/gui/gui.h

@@ -719,6 +719,30 @@ class Chart
   Chart() = default;
 };
 
+// Optional backend plugged in when the Qt GUI is not running (e.g. the web
+// viewer).  Lets Gui::enabled/redraw/pause work without Qt so that debug
+// graphics (gpl, cts, drt, mpl, ...) light up in headless contexts.
+// Installed via Gui::setHeadlessViewer.  The Qt GUI, when present, always
+// takes precedence: the viewer is only consulted when main_window is null.
+class HeadlessViewer
+{
+ public:
+  virtual ~HeadlessViewer() = default;
+
+  // Called by Renderer::redraw() / Gui::redraw().  Typically broadcasts
+  // a refresh notification to connected clients.
+  virtual void redraw() = 0;
+
+  // Called by Gui::pause().  Should block the calling thread until some
+  // external signal (e.g. a client click) releases it, or until timeout_ms
+  // expires.  timeout_ms == 0 means wait indefinitely.
+  virtual void pause(int timeout_ms) = 0;
+
+  // True while pause() is blocking.  Consumers (like the web tile renderer)
+  // can use this to gate unsafe cross-thread reads of renderer state.
+  virtual bool isPaused() const = 0;
+};
+
 // This is the API for the rest of the program to interact with the
 // GUI.  This class is accessed by the GUI implementation to interact
 // with the rest of the system.  This class itself doesn't hold the
@@ -1005,9 +1029,32 @@ class Gui
   // returns the Gui singleton
   static Gui* get();
 
-  // Will return true if the GUI is active, false otherwise
+  // Will return true if any GUI backend is active (Qt or headless).
+  // Tool renderers should use this to decide whether debug graphics
+  // are available.
   static bool enabled();
 
+  // Will return true only when the Qt main window is running.
+  // Tcl commands that need Qt widgets (selection, zoom, labels, …)
+  // should gate on this rather than enabled().
+  static bool hasUI();
+
+  // Install / inspect a HeadlessViewer (used when the Qt GUI is not
+  // running).  See the HeadlessViewer class comment for semantics.
+  void setHeadlessViewer(HeadlessViewer* viewer);
+  HeadlessViewer* getHeadlessViewer() const { return headless_viewer_; }
+
+  // Factory for gui::Chart instances when the Qt GUI is not running.
+  // The web viewer installs a factory that returns WebChart*.  When the
+  // Qt GUI is running, the main window's ChartsWidget is used instead
+  // and this factory is ignored.
+  using ChartFactory
+      = std::function<Chart*(const std::string& name,
+                             const std::string& x_label,
+                             const std::vector<std::string>& y_labels)>;
+  void setChartFactory(ChartFactory factory);
+  const ChartFactory& getChartFactory() const { return chart_factory_; }
+
   // initialize the GUI
   void init(odb::dbDatabase* db, sta::dbSta* sta, utl::Logger* logger);
 
@@ -1044,6 +1091,10 @@ class Gui
   static constexpr int kDefaultGifDelay = 250;
 
   std::string main_window_title_ = "OpenROAD";
+
+  // Used when Qt GUI is not active.  Installed by the web viewer.
+  HeadlessViewer* headless_viewer_ = nullptr;
+  ChartFactory chart_factory_;
 };
 
 // The main entry point

src/gui/src/gui.cpp

@@ -232,13 +232,19 @@ Gui::Gui() : continue_after_close_(false), logger_(nullptr), db_(nullptr)
 }
 
 bool Gui::enabled()
+{
+  Gui* self = Gui::get();
+  return main_window != nullptr || self->headless_viewer_ != nullptr;
+}
+
+bool Gui::hasUI()
 {
   return main_window != nullptr;
 }
 
 void Gui::registerRenderer(Renderer* renderer)
 {
-  if (Gui::enabled()) {
+  if (main_window != nullptr) {
     main_window->getControls()->registerRenderer(renderer);
   }
 
@@ -252,7 +258,7 @@ void Gui::unregisterRenderer(Renderer* renderer)
     return;
   }
 
-  if (Gui::enabled()) {
+  if (main_window != nullptr) {
     main_window->getControls()->unregisterRenderer(renderer);
   }
 
@@ -262,20 +268,42 @@ void Gui::unregisterRenderer(Renderer* renderer)
 
 void Gui::redraw()
 {
-  if (!Gui::enabled()) {
+  if (main_window != nullptr) {
+    main_window->redraw();
     return;
   }
-  main_window->redraw();
+  if (headless_viewer_ != nullptr) {
+    headless_viewer_->redraw();
+  }
 }
 
 void Gui::status(const std::string& message)
 {
-  main_window->status(message);
+  if (main_window != nullptr) {
+    main_window->status(message);
+  }
+  // No status surface in headless mode; silently drop.
 }
 
 void Gui::pause(int timeout)
 {
-  main_window->pause(timeout);
+  if (main_window != nullptr) {
+    main_window->pause(timeout);
+    return;
+  }
+  if (headless_viewer_ != nullptr) {
+    headless_viewer_->pause(timeout);
+  }
+}
+
+void Gui::setHeadlessViewer(HeadlessViewer* viewer)
+{
+  headless_viewer_ = viewer;
+}
+
+void Gui::setChartFactory(ChartFactory factory)
+{
+  chart_factory_ = std::move(factory);
 }
 
 Selected Gui::makeSelected(const std::any& object)
@@ -963,7 +991,7 @@ void Gui::registerHeatMap(HeatMapDataSource* heatmap)
       [this](HeatMapDataSource* source) { unregisterHeatMap(source); });
   registerRenderer(renderer.get());
   heat_map_renderers_[heatmap] = std::move(renderer);
-  if (Gui::enabled()) {
+  if (main_window != nullptr) {
     main_window->registerHeatMap(heatmap);
   }
 }
@@ -982,7 +1010,7 @@ void Gui::unregisterHeatMap(HeatMapDataSource* heatmap)
     unregisterRenderer(renderer_itr->second.get());
     heat_map_renderers_.erase(renderer_itr);
   }
-  if (Gui::enabled()) {
+  if (main_window != nullptr) {
     main_window->unregisterHeatMap(heatmap);
   }
   heat_maps_.erase(heatmap);
@@ -1408,7 +1436,13 @@ Chart* Gui::addChart(const std::string& name,
                      const std::string& x_label,
                      const std::vector<std::string>& y_labels)
 {
-  return main_window->getChartsWidget()->addChart(name, x_label, y_labels);
+  if (main_window != nullptr) {
+    return main_window->getChartsWidget()->addChart(name, x_label, y_labels);
+  }
+  if (chart_factory_) {
+    return chart_factory_(name, x_label, y_labels);
+  }
+  return nullptr;
 }
 
 void Gui::removeRouteGuides(odb::dbNet* net)

src/gui/src/gui.i

@@ -13,7 +13,7 @@ using utl::GUI;
 bool check_gui(const char* command)
 {
   auto logger = ord::OpenRoad::openRoad()->getLogger(); 
-  if (!gui::Gui::enabled()) {
+  if (!gui::Gui::hasUI()) {
     logger->info(GUI, 1, "Command {} is not usable in non-GUI mode", command);
     return false;
   }
@@ -505,7 +505,9 @@ const std::string input_dialog(const char* title, const char* question)
 // language to avoid conflicts in C++.
 void gui_pause(int timeout = 0)
 {
-  if (!check_gui("pause")) {
+  if (!gui::Gui::enabled()) {
+    auto logger = ord::OpenRoad::openRoad()->getLogger();
+    logger->info(GUI, 96, "Command pause is not usable in non-GUI mode");
     return;
   }
   auto gui = gui::Gui::get();

src/gui/src/stub.cpp

@@ -11,6 +11,7 @@
 #include <set>
 #include <string>
 #include <typeinfo>
+#include <utility>
 #include <vector>
 
 #include "bufferTreeDescriptor.h"
@@ -46,20 +47,34 @@ Gui* gui::Gui::get()
 }
 
 bool gui::Gui::enabled()
+{
+  return Gui::get()->getHeadlessViewer() != nullptr;
+}
+
+bool gui::Gui::hasUI()
 {
   return false;
 }
 
-void gui::Gui::registerRenderer(gui::Renderer*)
+void gui::Gui::registerRenderer(gui::Renderer* renderer)
 {
+  renderers_.insert(renderer);
+  redraw();
 }
 
 void HeatMapDataSource::registerHeatMap()
 {
+  // gpl / other modules call this to expose their heatmap to the GUI.
+  // In headless mode the web viewer enumerates heatmaps via
+  // gui::getRegisteredHeatMapSources() (factory-backed sources) so this
+  // one-off pathway does nothing here for now.  Left intentionally as
+  // a no-op until heatmap plumbing for ad-hoc sources lands.
 }
 
-void gui::Gui::unregisterRenderer(gui::Renderer*)
+void gui::Gui::unregisterRenderer(gui::Renderer* renderer)
 {
+  renderers_.erase(renderer);
+  redraw();
 }
 
 void gui::Gui::zoomTo(const odb::Rect& rect_dbu)
@@ -68,10 +83,26 @@ void gui::Gui::zoomTo(const odb::Rect& rect_dbu)
 
 void gui::Gui::redraw()
 {
+  if (headless_viewer_ != nullptr) {
+    headless_viewer_->redraw();
+  }
 }
 
 void gui::Gui::pause(int timeout)
 {
+  if (headless_viewer_ != nullptr) {
+    headless_viewer_->pause(timeout);
+  }
+}
+
+void gui::Gui::setHeadlessViewer(HeadlessViewer* viewer)
+{
+  headless_viewer_ = viewer;
+}
+
+void gui::Gui::setChartFactory(ChartFactory factory)
+{
+  chart_factory_ = std::move(factory);
 }
 
 void Gui::status(const std::string& /* message */)
@@ -84,9 +115,13 @@ void Gui::triggerAction(const std::string& /* action */)
 
 void Renderer::redraw()
 {
+  Gui::get()->redraw();
 }
 
-Renderer::~Renderer() = default;
+Renderer::~Renderer()
+{
+  Gui::get()->unregisterRenderer(this);
+}
 
 void DiscreteLegend::addLegendKey(const Painter::Color& color,
                                   const std::string& text)
@@ -97,17 +132,27 @@ void DiscreteLegend::draw(Painter& painter) const
 {
 }
 
-bool Renderer::checkDisplayControl(const std::string& /* name */)
+bool Renderer::checkDisplayControl(const std::string& name)
 {
+  auto it = controls_.find(name);
+  if (it != controls_.end()) {
+    return it->second.visibility;
+  }
   return false;
 }
 
 void Renderer::addDisplayControl(
-    const std::string& /* name */,
-    bool /* initial_visible */,
-    const DisplayControlCallback& /* setup */,
-    const std::vector<std::string>& /* mutual_exclusivity */)
+    const std::string& name,
+    bool initial_visible,
+    const DisplayControlCallback& setup,
+    const std::vector<std::string>& mutual_exclusivity)
 {
+  DisplayControl control;
+  control.visibility = initial_visible;
+  control.interactive_setup = setup;
+  control.mutual_exclusivity.insert(mutual_exclusivity.begin(),
+                                    mutual_exclusivity.end());
+  controls_[name] = std::move(control);
 }
 
 Renderer::Settings Renderer::getSettings()
@@ -241,6 +286,9 @@ Chart* Gui::addChart(const std::string& name,
                      const std::string& x_label,
                      const std::vector<std::string>& y_labels)
 {
+  if (chart_factory_) {
+    return chart_factory_(name, x_label, y_labels);
+  }
   return nullptr;
 }
 

src/web/BUILD

@@ -86,6 +86,13 @@ cc_library(
         "src/timing_report.cpp",
         "src/timing_report.h",
         "src/web.cpp",
+        "src/web_chart.cpp",
+        "src/web_chart.h",
+        "src/web_painter.cpp",
+        "src/web_painter.h",
+        "src/web_serve.cpp",
+        "src/web_viewer_hook.cpp",
+        "src/web_viewer_hook.h",
         ":report_assets",
     ],
     hdrs = [
@@ -109,6 +116,7 @@ cc_library(
         "@boost.asio",
         "@boost.beast",
         "@boost.geometry",
+        "@spdlog",
         "@tcl_lang//:tcl",
     ],
 )