Merge pull request #10264 from The-OpenROAD-Project-staging/web-server-blocking

web: make web_server block like GUI, add -web flag

Author: maliberty

BUILD.bazel

@@ -197,6 +197,7 @@ cc_binary(
         "//src/gui",
         "//src/sta:opensta_lib",
         "//src/utl",
+        "//src/web",
         "@boost.stacktrace",
         "@rules_cc//cc/runfiles",  # sets BAZEL_CURRENT_REPOSITORY
         "@tcl_lang//:tcl",

src/Main.cc

@@ -5,11 +5,13 @@
 #include <strings.h>
 
 #include <array>
+#include <charconv>
 #include <climits>
 #include <clocale>
 #include <csignal>
 #include <cstdio>
 #include <cstdlib>
+#include <cstring>
 #include <filesystem>
 #include <iostream>
 #include <memory>
@@ -37,6 +39,7 @@
 #include "sta/StringUtil.hh"
 #include "utl/Logger.h"
 #include "utl/decode.h"
+#include "web/web.h"
 
 #ifdef BAZEL_CURRENT_REPOSITORY
 #include "bazel/tcl_library_init.h"
@@ -93,6 +96,8 @@ static const char* metrics_filename = nullptr;
 static const char* read_odb_filename = nullptr;
 static bool no_settings = false;
 static bool minimize = false;
+static bool web_enabled = false;
+static const char* web_port_arg = nullptr;
 
 static const char* init_filename = ".openroad";
 
@@ -249,6 +254,8 @@ int main(int argc, char* argv[])
   read_odb_filename = findCmdLineKey(argc, argv, "-db");
   no_settings = findCmdLineFlag(argc, argv, "-no_settings");
   minimize = findCmdLineFlag(argc, argv, "-minimize");
+  web_enabled = findCmdLineFlag(argc, argv, "-web");
+  web_port_arg = findCmdLineKey(argc, argv, "-web_port");
 
   cmd_argc = argc;
   cmd_argv = argv;
@@ -375,6 +382,22 @@ static int tclAppInit(int& argc,
     ord::initOpenRoad(
         interp, log_filename, metrics_filename, exit_after_cmd_file);
 
+    // Start the web server before splash/thread output so the
+    // WebLogSink captures all startup messages for the browser console.
+    if (web_enabled) {
+      int port = 0;
+      if (web_port_arg) {
+        const char* end = web_port_arg + std::strlen(web_port_arg);
+        auto [ptr, ec] = std::from_chars(web_port_arg, end, port);
+        if (ec != std::errc{} || ptr != end || port < 0 || port > 65535) {
+          fprintf(
+              stderr, "Error: invalid -web_port value '%s'\n", web_port_arg);
+          exit(EXIT_FAILURE);
+        }
+      }
+      ord::OpenRoad::openRoad()->getWebServer()->serve(port);
+    }
+
     bool no_splash = findCmdLineFlag(argc, argv, "-no_splash");
     if (!no_splash) {
       showSplash();
@@ -389,7 +412,11 @@ static int tclAppInit(int& argc,
           ord::OpenRoad::openRoad()->getThreadCount(), false);
     }
 
-    const bool gui_enabled = gui::Gui::enabled();
+    // gui::Gui::enabled() is true when a HeadlessViewer is installed
+    // (which the web server does).  But addRestoreStateCommand() only
+    // works with the Qt event loop — the web server executes scripts
+    // directly on the main thread, like the non-GUI path.
+    const bool gui_enabled = gui::Gui::enabled() && !web_enabled;
 
     if (read_odb_filename) {
       std::string cmd = fmt::format("read_db {{{}}}", read_odb_filename);
@@ -448,6 +475,12 @@ static int tclAppInit(int& argc,
         }
       }
     }
+
+    // Block until the web server is stopped (like QApplication::exec()
+    // for the GUI).  After this returns, fall through to readline.
+    if (web_enabled) {
+      ord::OpenRoad::openRoad()->getWebServer()->waitForStop();
+    }
   }
 #ifdef ENABLE_READLINE
   // Initialize readline unless the Qt GUI is active (it has its own
@@ -484,15 +517,18 @@ int ord::tclInit(Tcl_Interp* interp)
 static void showUsage(const char* prog, const char* init_filename)
 {
   printf("Usage: %s [-help] [-version] [-no_init] [-no_splash] [-exit] ", prog);
-  printf("[-gui] [-threads count|max] [-log file_name] [-metrics file_name] ");
-  printf("[-db file_name] [-no_settings] [-minimize] cmd_file\n");
+  printf("[-gui] [-web] [-threads count|max] [-log file_name] ");
+  printf("[-metrics file_name] [-db file_name] [-no_settings] [-minimize] ");
+  printf("cmd_file\n");
   printf("  -help                 show help and exit\n");
   printf("  -version              show version and exit\n");
   printf("  -no_init              do not read %s init file\n", init_filename);
   printf("  -threads count|max    use count threads\n");
   printf("  -no_splash            do not show the license splash at startup\n");
   printf("  -exit                 exit after reading cmd_file\n");
   printf("  -gui                  start in gui mode\n");
+  printf("  -web                  start in web viewer mode\n");
+  printf("  -web_port port        web server port (default auto-assigned)\n");
   printf("  -minimize             start the gui minimized\n");
   printf("  -no_settings          do not load the previous gui settings\n");
 #ifdef ENABLE_PYTHON3

src/web/BUILD

@@ -17,6 +17,12 @@ py_binary(
     main = "src/embed_report_assets.py",
 )
 
+py_binary(
+    name = "embed_web_assets",
+    srcs = ["src/embed_web_assets.py"],
+    main = "src/embed_web_assets.py",
+)
+
 genrule(
     name = "report_assets",
     srcs = [
@@ -67,6 +73,39 @@ genrule(
     tools = [":embed_report_assets"],
 )
 
+_WEB_ASSET_FILES = [
+    "src/index.html",
+    "src/style.css",
+    "src/theme.js",
+    "src/coordinates.js",
+    "src/ui-utils.js",
+    "src/checkbox-tree-model.js",
+    "src/vis-tree.js",
+    "src/websocket-manager.js",
+    "src/websocket-tile-layer.js",
+    "src/display-controls.js",
+    "src/inspector.js",
+    "src/ruler.js",
+    "src/tcl-completer.js",
+    "src/hierarchy-browser.js",
+    "src/menu-bar.js",
+    "src/clock-tree-widget.js",
+    "src/schematic-widget.js",
+    "src/charts-widget.js",
+    "src/timing-widget.js",
+    "src/drc-widget.js",
+    "src/main.js",
+]
+
+genrule(
+    name = "web_assets",
+    srcs = _WEB_ASSET_FILES,
+    outs = ["src/web_assets.cpp"],
+    cmd = "$(execpath :embed_web_assets) --output $@ " +
+          " ".join(["$(location %s)" % f for f in _WEB_ASSET_FILES]),
+    tools = [":embed_web_assets"],
+)
+
 cc_library(
     name = "web",
     srcs = [
@@ -86,6 +125,7 @@ cc_library(
         "src/timing_report.cpp",
         "src/timing_report.h",
         "src/web.cpp",
+        "src/web_assets.h",
         "src/web_chart.cpp",
         "src/web_chart.h",
         "src/web_painter.cpp",
@@ -94,6 +134,7 @@ cc_library(
         "src/web_viewer_hook.cpp",
         "src/web_viewer_hook.h",
         ":report_assets",
+        ":web_assets",
     ],
     hdrs = [
         "include/web/web.h",

src/web/CMakeLists.txt

@@ -12,6 +12,36 @@ swig_lib(NAME         web
                        ${ODB_HOME}/include
 )
 
+set(WEB_ASSET_FILES
+    src/index.html
+    src/style.css
+    src/theme.js
+    src/coordinates.js
+    src/ui-utils.js
+    src/checkbox-tree-model.js
+    src/vis-tree.js
+    src/websocket-manager.js
+    src/websocket-tile-layer.js
+    src/display-controls.js
+    src/inspector.js
+    src/ruler.js
+    src/tcl-completer.js
+    src/hierarchy-browser.js
+    src/menu-bar.js
+    src/clock-tree-widget.js
+    src/schematic-widget.js
+    src/charts-widget.js
+    src/timing-widget.js
+    src/drc-widget.js
+    src/main.js
+)
+
+# Prepend CMAKE_CURRENT_SOURCE_DIR to each asset file.
+set(WEB_ASSET_PATHS "")
+foreach(f ${WEB_ASSET_FILES})
+  list(APPEND WEB_ASSET_PATHS ${CMAKE_CURRENT_SOURCE_DIR}/${f})
+endforeach()
+
 set(REPORT_ASSETS_CPP ${CMAKE_CURRENT_BINARY_DIR}/report_assets.cpp)
 add_custom_command(
   OUTPUT ${REPORT_ASSETS_CPP}
@@ -39,29 +69,22 @@ add_custom_command(
         ${CMAKE_CURRENT_SOURCE_DIR}/src/main.js
   DEPENDS
     src/embed_report_assets.py
-    src/style.css
-    src/theme.js
-    src/coordinates.js
-    src/ui-utils.js
-    src/checkbox-tree-model.js
-    src/vis-tree.js
-    src/websocket-manager.js
-    src/websocket-tile-layer.js
-    src/display-controls.js
-    src/inspector.js
-    src/ruler.js
-    src/tcl-completer.js
-    src/hierarchy-browser.js
-    src/menu-bar.js
-    src/clock-tree-widget.js
-    src/schematic-widget.js
-    src/charts-widget.js
-    src/timing-widget.js
-    src/drc-widget.js
-    src/main.js
+    ${WEB_ASSET_FILES}
   COMMENT "Generating report_assets.cpp"
 )
 
+set(WEB_ASSETS_CPP ${CMAKE_CURRENT_BINARY_DIR}/web_assets.cpp)
+add_custom_command(
+  OUTPUT ${WEB_ASSETS_CPP}
+  COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/src/embed_web_assets.py
+    --output ${WEB_ASSETS_CPP}
+    ${WEB_ASSET_PATHS}
+  DEPENDS
+    src/embed_web_assets.py
+    ${WEB_ASSET_FILES}
+  COMMENT "Generating web_assets.cpp"
+)
+
 target_sources(web
   PRIVATE
     src/clock_tree_report.cpp
@@ -78,6 +101,7 @@ target_sources(web
     src/web_viewer_hook.cpp
     src/MakeWeb.cpp
     ${REPORT_ASSETS_CPP}
+    ${WEB_ASSETS_CPP}
 )
 
 target_link_libraries(web

src/web/include/web/web.h

@@ -3,8 +3,11 @@
 
 #pragma once
 
+#include <condition_variable>
+#include <cstdint>
 #include <functional>
 #include <memory>
+#include <mutex>
 #include <string>
 #include <thread>
 #include <vector>
@@ -22,6 +25,10 @@ namespace sta {
 class dbSta;
 }
 
+namespace spdlog::sinks {
+class sink;
+}
+
 namespace web {
 
 struct Color;
@@ -33,23 +40,29 @@ struct TclEvaluator;
 class TimingReport;
 class WebViewerHook;
 
-// Factory that creates, starts, and returns a shutdown callback for a
-// Listener.  Defined in web.cpp (where Listener is local); called from
-// web_serve.cpp.
-std::function<void()> createAndRunListener(
+// Returned by createAndRunListener: a shutdown callback and the actual
+// port the listener bound to (useful when the caller passes port 0).
+struct ListenerHandle
+{
+  std::function<void()> shutdown;
+  uint16_t port;
+};
+
+// Factory that creates, starts, and returns a handle for a Listener.
+// Defined in web.cpp (where Listener is local); called from web_serve.cpp.
+ListenerHandle createAndRunListener(
     boost::asio::io_context& ioc,
     const boost::asio::ip::tcp::endpoint& endpoint,
     std::shared_ptr<TileGenerator> generator,
     std::shared_ptr<TclEvaluator> tcl_eval,
     std::shared_ptr<TimingReport> timing_report,
     std::shared_ptr<ClockTreeReport> clock_report,
-    const std::string& doc_root,
     utl::Logger* logger,
     WebViewerHook* viewer_hook);
 
-// A layout web server.  serve() starts the server in background threads
-// and returns immediately so the Tcl interpreter remains interactive
-// (analogous to -gui for the Qt frontend).
+// A layout web server.  serve() starts the server in background I/O
+// threads; waitForStop() blocks the calling thread until requestStop()
+// is called, mirroring gui::show / gui::hide.
 
 class WebServer
 {
@@ -64,11 +77,19 @@ class WebServer
   // Start the web server on the given port.  Launches background
   // I/O threads and returns immediately.  A second call is a no-op if
   // the server is already running.
-  void serve(int port, const std::string& doc_root);
+  void serve(int port);
 
   // True after serve() returns and before stop/destructor.
   bool isRunning() const { return ioc_ != nullptr; }
 
+  // Block the calling thread until requestStop() is called, then
+  // tear down the server.  Typically called on the main/Tcl thread.
+  void waitForStop();
+
+  // Signal waitForStop() to return.  Safe to call from any thread
+  // (e.g. an ASIO worker thread executing a Tcl command).
+  void requestStop();
+
   void saveReport(const std::string& filename,
                   int max_setup_paths,
                   int max_hold_paths);
@@ -94,6 +115,7 @@ class WebServer
   int num_threads_ = 0;
   std::shared_ptr<TileGenerator> generator_;
   std::unique_ptr<WebViewerHook> viewer_hook_;
+  std::shared_ptr<spdlog::sinks::sink> log_sink_;
 
   // Background I/O context and worker threads (non-null while running).
   std::unique_ptr<boost::asio::io_context> ioc_;
@@ -103,6 +125,12 @@ class WebServer
   // io_context is destroyed — prevents a crash where the acceptor's
   // destructor references the io_context that's mid-destruction.
   std::function<void()> shutdown_listener_;
+
+  // Blocking support: waitForStop() sleeps on stop_cv_ until
+  // requestStop() sets stop_requested_.
+  std::mutex stop_mutex_;
+  std::condition_variable stop_cv_;
+  bool stop_requested_ = false;
 };
 
 }  // namespace web