Merge pull request #7725 from QuantamHD/enable_gui_bazel

gui: Enable gui with bazel

Author: maliberty

BUILD.bazel

@@ -25,6 +25,7 @@ string_flag(
     build_setting_default = "cli",
     values = [
         "cli",
+        "gui",
     ],
 )
 
@@ -35,6 +36,13 @@ config_setting(
     },
 )
 
+config_setting(
+    name = "platform_gui",
+    flag_values = {
+        ":platform": "gui",
+    },
+)
+
 # TODO: once project is properly decomposed, we don't
 # need these blanked dependencies in multiple places anymore.
 OPENROAD_LIBRARY_DEPS = [
@@ -60,7 +68,6 @@ OPENROAD_LIBRARY_DEPS = [
     "//src/gpl",
     "//src/grt",
     "//src/grt:ui",
-    "//src/gui",
     "//src/ifp",
     "//src/ifp:ui",
     "//src/mpl",
@@ -86,7 +93,12 @@ OPENROAD_LIBRARY_DEPS = [
     "//src/utl",
     "//src/utl:ui",
     "@edu_berkeley_abc//:abc-lib",
-]
+] + select(
+    {
+        ":platform_gui": ["//src/gui:gui_qt"],
+        ":platform_cli": ["//src/gui"],
+    },
+)
 
 OPENROAD_COPTS = [
     "-Wno-error",
@@ -121,14 +133,9 @@ cc_binary(
         ":rmp_swig",
         ":rmp_tcl",
         "//bazel:runfiles",
-    ] + select({
-        ":platform_cli": [],
-    }),
+    ],
     copts = OPENROAD_COPTS,
     features = ["-use_header_modules"],
-    linkopts = select({
-        ":platform_cli": [],
-    }),
     malloc = "@tcmalloc//tcmalloc",
     visibility = ["//visibility:public"],
     deps = [
@@ -143,6 +150,13 @@ cc_binary(
     ],
 )
 
+GUI_BUILD_FLAGS = select(
+    {
+        ":platform_gui": ["BUILD_GUI=true"],
+        ":platform_cli": ["BUILD_GUI=false"],
+    },
+)
+
 cc_library(
     name = "openroad_lib_private",
     srcs = [
@@ -157,9 +171,7 @@ cc_library(
         "src/rmp/include/rmp/*.h",
     ]),
     copts = OPENROAD_COPTS,
-    defines = OPENROAD_DEFINES + [
-        "BUILD_GUI=false",
-    ],
+    defines = OPENROAD_DEFINES + GUI_BUILD_FLAGS,
     features = ["-use_header_modules"],
     includes = [
         "include",
@@ -185,9 +197,7 @@ cc_library(
     ]),
     hdrs = glob(["src/rmp/include/rmp/*.h"]),
     copts = OPENROAD_COPTS,
-    defines = OPENROAD_DEFINES + [
-        "BUILD_GUI=false",
-    ],
+    defines = OPENROAD_DEFINES + GUI_BUILD_FLAGS,
     features = ["-use_header_modules"],
     includes = [
         "include",

MODULE.bazel

@@ -90,6 +90,18 @@ bazel_dep(name = "spdlog", version = "1.15.1")
 bazel_dep(name = "tcmalloc", version = "0.0.0-20250331-43fcf6e")
 bazel_dep(name = "zlib", version = "1.3.1.bcr.5")
 
+# 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
+# allow openroad to link, but will search on the system at runtime for
+# the correct system libs.
+bazel_dep(name = "qt-bazel")
+git_override(
+    module_name = "qt-bazel",
+    commit = "90cfbab79df93960c5493f8a75df6199fb80fe26",
+    remote = "https://github.com/The-OpenROAD-Project/qt_bazel_prebuilts",
+)
+
 bazel_dep(name = "googletest", version = "1.16.0", dev_dependency = True)
 
 # Dependencies needed by one of the rules_hdl repos. Once they are on

MODULE.bazel.lock

@@ -41,8 +41,9 @@ class BazelInitializer
     using rules_cc::cc::runfiles::Runfiles;
 
     std::string error;
-    std::unique_ptr<Runfiles> runfiles(Runfiles::Create(
-        getProgramLocation().value(), BAZEL_CURRENT_REPOSITORY, &error));
+    std::string program_location = getProgramLocation().value();
+    std::unique_ptr<Runfiles> runfiles(
+        Runfiles::Create(program_location, BAZEL_CURRENT_REPOSITORY, &error));
     if (!runfiles) {
       std::cerr << "Error initializing Bazel runfiles: " << error << std::endl;
       std::exit(1);
@@ -57,6 +58,12 @@ class BazelInitializer
                 << std::endl;
       std::exit(1);
     }
+
+    // Setup env variables for any other libraries that use runfiles
+    std::string manifest = program_location + ".runfiles/MANIFEST";
+    std::string runfiles_dir = program_location + ".runfiles";
+    setenv("RUNFILES_MANIFEST_FILE", manifest.c_str(), /*__replace=*/true);
+    setenv("RUNFILES_DIR", runfiles_dir.c_str(), /*__replace=*/true);
   }
 };
 

bazel/InitRunFiles.cpp

@@ -86,8 +86,27 @@ def _tcl_wrap_cc_impl(ctx):
         tools = ctx.files._swig,
         executable = ([file for file in ctx.files._swig if file.basename == "swig"][0]),
     )
+
+    output_files = [output_file]
+
+    if ctx.attr.runtime_header:
+        runtime_header = ctx.actions.declare_file(ctx.attr.runtime_header)
+        runtime_args = ctx.actions.args()
+        runtime_args.add("-tcl8")
+        runtime_args.add("-external-runtime")
+        runtime_args.add(runtime_header)
+        ctx.actions.run(
+            outputs = [runtime_header],
+            inputs = [],
+            arguments = [runtime_args],
+            tools = [ctx.attr._swig.files_to_run],
+            executable = ([file for file in ctx.files._swig if file.basename == "swig"][0]),
+            toolchain = None,
+        )
+        output_files.append(runtime_header)
+
     return [
-        DefaultInfo(files = depset([output_file])),
+        DefaultInfo(files = depset(output_files)),
         TclSwigInfo(
             transitive_srcs = src_inputs,
             includes = includes_paths,
@@ -133,6 +152,7 @@ tcl_wrap_cc = rule(
         "swig_options": attr.string_list(
             doc = "args to pass directly to the swig binary",
         ),
+        "runtime_header": attr.string(),
         "_swig": attr.label(
             default = "@org_swig//:swig_stable",
             allow_files = True,

bazel/tcl_wrap_cc.bzl

@@ -22,6 +22,57 @@ class Logger;
 
 namespace sta {
 
+// std::any and typeid do not work on incomplete types
+// talking to the OpenSTA author about implementing these
+// upstream instead. https://github.com/llvm/llvm-project/issues/36746
+// for llvm bug.
+//
+// Deleting all the constructors to preserve behavior as opaque pointers.
+// This should let RTTI based constructs like std::any to work on these
+// types. See
+// https://github.com/The-OpenROAD-Project/OpenROAD/pull/7725#discussion_r2201423922
+// for more information.
+class Library
+{
+ public:
+  Library() = delete;
+};
+class Cell
+{
+ public:
+  Cell() = delete;
+};
+class Port
+{
+ public:
+  Port() = delete;
+};
+class Instance
+{
+ public:
+  Instance() = delete;
+};
+class Pin
+{
+ public:
+  Pin() = delete;
+};
+class Term
+{
+ public:
+  Term() = delete;
+};
+class Net
+{
+ public:
+  Net() = delete;
+};
+class ViewType
+{
+ public:
+  ViewType() = delete;
+};
+
 class dbSta;
 class dbNetwork;
 class dbStaReport;