Merge remote-tracking branch 'origin/master' into odb-new-unfolded-structuree

Author: osamahammad21

.bazelrc

@@ -5,6 +5,10 @@ common --enable_bzlmod
 # Remove this registry line once the version lands on BCR.
 common --registry=https://raw.githubusercontent.com/oharboe/bazel-central-registry/1beaf797951046d93a2f656d4238c954a21833e5/
 common --registry=https://bcr.bazel.build/
+
+# abc is driven programmatically by OpenROAD, so skip the interactive
+# readline dependency exposed by abc@0.64-yosyshq.bcr.2.
+common --@abc//:use_readline=false
 build --workspace_status_command=tools/workspace_status.sh
 
 # Release builds embed real git version info; dev builds use cache-safe placeholders.

.readthedocs.yaml

@@ -15,7 +15,7 @@ build:
     - libasound2
     - graphviz
   tools:
-    python: "3.7"
+    python: "3.10"
     nodejs: "16"
   jobs:
     post_install:

BUILD.bazel

@@ -187,6 +187,7 @@ OPENROAD_MAIN_DEPS = [
     "//src/utl",
     "//src/web",
     "@abseil-cpp//absl/base:no_destructor",
+    "@boost.dll",
     "@boost.stacktrace",
     "@rules_cc//cc/runfiles",  # sets BAZEL_CURRENT_REPOSITORY
     "@tcl_lang//:tcl",

MODULE.bazel

@@ -7,7 +7,20 @@ module(
 
 # --- Regular dependencies (propagated to downstream consumers via MVS) ---
 
-bazel_dep(name = "abc", version = "0.64-yosyshq.bcr.1")
+bazel_dep(name = "abc", version = "0.64-yosyshq.bcr.2")
+
+# Patch abc's non-readline prompt path to flush stdout and exit on EOF.
+# Without this, yosys's coprocess driver (which waits for the "abc NN> "
+# prompt over a pipe) deadlocks when abc is built with use_readline=false.
+# Drop this override once the fix is in a published BCR abc release.
+single_version_override(
+    module_name = "abc",
+    patch_strip = 1,
+    patches = [
+        "//bazel/abc-patches:0001-mainUtils-flush-prompt-and-handle-eof-without-readline.patch",
+    ],
+)
+
 bazel_dep(name = "abseil-cpp", version = "20260107.1")
 bazel_dep(name = "bazel_skylib", version = "1.7.1")
 bazel_dep(name = "coin-or-lemon", version = "1.3.1")
@@ -30,6 +43,7 @@ bazel_dep(name = "boost.bind", version = BOOST_VERSION)
 bazel_dep(name = "boost.config", version = BOOST_VERSION)
 bazel_dep(name = "boost.container", version = BOOST_VERSION)
 bazel_dep(name = "boost.container_hash", version = BOOST_VERSION)
+bazel_dep(name = "boost.dll", version = BOOST_VERSION)
 bazel_dep(name = "boost.format", version = BOOST_VERSION)
 bazel_dep(name = "boost.fusion", version = BOOST_VERSION)
 bazel_dep(name = "boost.geometry", version = BOOST_VERSION)

MODULE.bazel.lock

@@ -0,0 +1,62 @@
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: Matt Liberty <mliberty@precisioninno.com>
+Date: Fri, 30 May 2026 00:00:00 +0000
+Subject: [PATCH] mainUtils: match readline behavior when ABC_USE_READLINE is
+ undefined
+
+The non-readline branch of Abc_UtilsGetUsersInput has three behavioral
+gaps versus the readline branch that break callers driving abc as a
+coprocess over a pipe (e.g. yosys's techmap/abc.cc, which waits for the
+"abc NN> " prompt with the source command echoed back via
+read_until_abc_done()):
+
+  1. The prompt is written with fprintf() but never flushed. With stdout
+     fully buffered (pipe), the prompt never reaches the reader; the
+     reader waits for the prompt, abc waits in fgets(), deadlock.
+
+  2. There is no echo of the line read from stdin. readline() displays
+     each character as it is typed (and on a pipe, readline's stream
+     handling still emits the line + newline to its output). Without
+     that, yosys never sees the "abc NN> source ..." pattern it requires
+     to advance state.
+
+  3. EOF on stdin is silently ignored: fgets() returns NULL, the
+     function returns a stale Prompt buffer, and the caller loops. The
+     readline branch exits(0) when readline() returns NULL.
+
+Fix all three. Echo only when stdin is not a tty -- on a tty the kernel
+already echoes typed characters, and double-echo would be visible.
+
+Upstreaming to YosysHQ/abc and berkeley-abc/abc.
+
+Signed-off-by: Matt Liberty <mliberty@precisioninno.com>
+---
+ src/base/main/mainUtils.c | 9 ++++++++-
+ 1 file changed, 8 insertions(+), 1 deletion(-)
+
+diff --git a/src/base/main/mainUtils.c b/src/base/main/mainUtils.c
+--- a/src/base/main/mainUtils.c
++++ b/src/base/main/mainUtils.c
+@@ -18,6 +18,8 @@
+
+ ***********************************************************************/
+
++#include <unistd.h>
++
+ #include "base/abc/abc.h"
+ #include "mainInt.h"
+
+@@ -91,7 +93,13 @@
+     {
+     char * pRetValue;
+     fprintf( pAbc->Out, "%s", Prompt );
++    fflush( pAbc->Out );
+     pRetValue = fgets( Prompt, 5000, stdin );
++    if ( pRetValue == NULL ) { exit(0); }
++    if ( !isatty( fileno(stdin) ) ) {
++        fputs( Prompt, pAbc->Out );
++        fflush( pAbc->Out );
++    }
+     return Prompt;
+     }
+ #endif

bazel/abc-patches/0001-mainUtils-flush-prompt-and-handle-eof-without-readline.patch

@@ -0,0 +1 @@
+exports_files(glob(["*.patch"]))

bazel/abc-patches/BUILD

@@ -3,20 +3,65 @@ set -e
 
 # Install binary and runfiles from bazel build
 
-TARFILE=$(cd $BUILD_WORKSPACE_DIRECTORY; bazelisk info bazel-bin)/packaging/openroad.tar
+BAZEL_BIN=$(cd "$BUILD_WORKSPACE_DIRECTORY"; bazel info bazel-bin)
+TARFILE="$BAZEL_BIN/packaging/openroad.tar"
 
-DEST_DIR=${1:-${BUILD_WORKSPACE_DIRECTORY}/../install/OpenROAD/bin}
+# The desktop entry is built into bazel-bin only for GUI builds
+# --//:platform=gui
+DESKTOP_SRC="$BAZEL_BIN/src/gui/openroad.desktop"
+ICON_SRC="$BUILD_WORKSPACE_DIRECTORY/src/gui/resources/icon.png"
 
-mkdir -p "$DEST_DIR"
-cp -f "$TARFILE" "$DEST_DIR"
-cd "$DEST_DIR"
-tar -xf openroad.tar
-rm -f openroad.tar
+INSTALL_DESKTOP=0
+if [ "${OPENROAD_INSTALL_GUI:-0}" = "1" ]; then
+    INSTALL_DESKTOP=1
+fi
+
+DEST_DIR=${1:-${BUILD_WORKSPACE_DIRECTORY}/../install/OpenROAD}
+
+mkdir -p "$DEST_DIR/bin"
+
+# Remove previous OpenROAD install artifacts.
+rm -f "$DEST_DIR/bin/openroad"
+rm -f "$DEST_DIR/bin/openroad.repo_mapping"
+rm -f "$DEST_DIR/bin/openroad.runfiles_manifest"
+rm -rf "$DEST_DIR/bin/openroad.runfiles"
+
+tar -xf "$TARFILE" -C "$DEST_DIR/bin"
 
 # Remove useless files from pkg_tar from bazel
-if [ -e openroad.repo_mapping ]; then
-    chmod u+w openroad.repo_mapping
-    rm -rf openroad.repo_mapping
+if [ -e "$DEST_DIR/bin/openroad.repo_mapping" ]; then
+    chmod u+w "$DEST_DIR/bin/openroad.repo_mapping"
+    rm -rf "$DEST_DIR/bin/openroad.repo_mapping"
 fi
 
-echo "OpenROAD binary installed to $(realpath "$DEST_DIR")"
+ABS_DEST="$(realpath "$DEST_DIR")"
+echo "OpenROAD binary installed to $ABS_DEST"
+
+# Remove any previously installed desktop entry and icon before (re)installing,
+# mirroring the binary artifact cleanup above. This runs unconditionally so a
+# prior GUI install is cleaned up even when the current install is not a GUI
+# build, avoiding a stale launcher/icon left pointing at an old prefix.
+APPS_DIR="${HOME}/.local/share/applications"
+rm -f "$ABS_DEST/share/openroad/gui/icon.png"
+rm -f "$APPS_DIR/openroad.desktop"
+
+# Install the desktop entry (menu launcher + icon) if Bazel built it, i.e.
+# this is a GUI build.
+if [ "$INSTALL_DESKTOP" = "1" ] && [ -f "$DESKTOP_SRC" ]; then
+    GUI_SHARE="$ABS_DEST/share/openroad/gui"
+    mkdir -p "$GUI_SHARE"
+    cp -f "$ICON_SRC" "$GUI_SHARE/icon.png"
+
+    mkdir -p "$APPS_DIR"
+    cp -f "$DESKTOP_SRC" "$APPS_DIR/openroad.desktop"
+    # Fill in the install prefix for the icon, and point Exec at the absolute
+    # binary so the launcher works without openroad being on PATH.
+    sed -i \
+        -e "s|@OPENROAD_PREFIX@|$ABS_DEST|g" \
+        -e "s|^Exec=openroad |Exec=$ABS_DEST/bin/openroad |" \
+        "$APPS_DIR/openroad.desktop"
+    if command -v update-desktop-database >/dev/null 2>&1; then
+        update-desktop-database "$APPS_DIR" >/dev/null 2>&1 || true
+    fi
+    echo "OpenROAD desktop entry installed to $APPS_DIR/openroad.desktop"
+fi

bazel/install.sh

@@ -35,6 +35,7 @@
     "myst_parser",
     "sphinxcontrib.mermaid",
     "sphinx_tabs.tabs",
+    "sphinx_llm.txt",
 ]
 
 myst_enable_extensions = [

docs/conf.py

@@ -0,0 +1,9 @@
+sphinx-external-toc==0.3.1
+sphinx
+sphinx-autobuild
+myst-parser
+sphinxcontrib-mermaid
+sphinx-book-theme
+sphinx-copybutton
+sphinx-tabs
+sphinx-llm