Merge remote-tracking branch 'private/master' into gpl-new-regions

Author: gudeh

.gitignore

@@ -29,7 +29,6 @@ build
 build_linux
 build_mac
 test/results
-flow
 
 docs/main
 README2.md
@@ -57,7 +56,8 @@ obj-x86_64-linux-gnu/
 
 user.bazelrc
 
-bazel-*
+# Limit ignore to these files, so we see and clean out other cruft that pollutes grep
+/bazel-*
 
 projectview.bazelproject
 .bsp/

MODULE.bazel

@@ -112,6 +112,8 @@ git_override(
 
 bazel_dep(name = "googletest", version = "1.17.0", dev_dependency = True)
 
+bazel_dep(name = "abseil-cpp", version = "20240722.0", repo_name = "com_google_absl")
+
 # Dependencies needed by one of the rules_hdl repos. Once they are on
 # BCR, they should depend on their own version.
 bazel_dep(name = "glpk", version = "5.0.bcr.3", repo_name = "org_gnu_glpk")
@@ -169,10 +171,10 @@ orfs = use_extension("@bazel-orfs//:extension.bzl", "orfs_repositories")
 # To bump version, run: bazelisk run @bazel-orfs//:bump
 orfs.default(
     # Official image https://hub.docker.com/r/openroad/orfs/tags
-    image = "docker.io/openroad/orfs:v3.0-4076-gf94bb8c31",
+    image = "docker.io/openroad/orfs:v3.0-4091-gc1e9016cf",
     # Use OpenROAD of this repo instead of from the docker image
     openroad = "//:openroad",
-    sha256 = "3338a59012776ed939a3d4e66fc2609ac68d2c7f588a4563ed9ca7cefd913faf",
+    sha256 = "4e4daf718eb0281738f6f50ae6bb17445fae0c75a30f6570adda1ce6d2dd2308",
 )
 use_repo(orfs, "com_github_nixos_patchelf_download")
 use_repo(orfs, "docker_orfs")

MODULE.bazel.lock

@@ -369,3 +369,32 @@ First create a local work folder with all dependencies for the step that you wan
 Now run make directly with the `/tmp/floorplan/_main` work folder, but be sure to use the `do-` targets that side-step ORFS make dependency checking:
 
     make --file ~/OpenROAD-flow-scripts/flow/Makefile --dir /tmp/floorplan/_main DESIGN_CONFIG=config.mk do-floorplan
+
+## Whittling down .odb files with deltaDebug.py
+
+Global place can take hours to run and to debug an error, the test case has to be whittled down to minutes, or it is probably intractable.
+
+Consider an error such as:
+
+    [ERROR GPL-0305] RePlAce diverged during gradient descent calculation, resulting in an invalid step length (Inf or NaN). This is often caused by numerical instability or high placement density. Consider reducing placement density to potentially resolve the issue.
+
+First create a folder with all the dependencies to run global placement:
+
+    bazelisk run //test/orfs/gcd:gcd_deps /tmp/bug
+
+Drop into a shell that has the build environment set up:
+
+    $ /tmp/bug/make bash
+    Makefile Environment  /tmp/bug/_main
+
+Run up to the failing stage and stop with ctrl-c on the step that you want to run the whittling down on:
+
+    make --file=$FLOW_HOME/Makefile do-place
+
+Now run deltaDebug.py:
+
+    $OPENROAD_EXE -python ~/OpenROAD-flow-scripts/tools/OpenROAD/etc/deltaDebug.py --error_string GPL-0305 --base_db_path test/orfs/gcd/results/asap7/gcd/base/3_2_place_iop.odb --use_stdout --exit_early_on_error --step "make --file=$FLOW_HOME/Makefile do-3_3_place_gp"
+
+This should eventually leave you with a whittled down .odb file. Copy the whittled down .odb file into the correct place for 3_2_place_iop.odb, then create a bug report:
+
+    /tmp/bug/make global_place_issue

docs/user/Bazel.md

@@ -3,10 +3,10 @@
 
 #pragma once
 
-#include <tcl.h>
-
 #include <string>
 
+#include "tcl.h"
+
 namespace ord {
 
 // Call this inside of Tcl_Main.

include/ord/InitOpenRoad.hh

@@ -3,8 +3,6 @@
 
 #include "ord/Design.h"
 
-#include <tcl.h>
-
 #include <cmath>
 #include <cstdint>
 #include <istream>
@@ -20,6 +18,7 @@
 #include "odb/db.h"
 #include "ord/OpenRoad.hh"
 #include "ord/Tech.h"
+#include "tcl.h"
 #include "utl/Logger.h"
 
 namespace ord {

src/Design.cc

@@ -4,7 +4,6 @@
 #include <libgen.h>
 #include <stdlib.h>  // NOLINT(modernize-deprecated-headers): for setenv()
 #include <strings.h>
-#include <tcl.h>
 
 #include <array>
 #include <climits>
@@ -19,6 +18,7 @@
 #include <system_error>
 
 #include "boost/stacktrace/stacktrace.hpp"
+#include "tcl.h"
 #ifdef ENABLE_READLINE
 // If you get an error on this include be sure you have
 //   the package tcl-tclreadline-devel installed

src/Main.cc

@@ -3,8 +3,6 @@
 
 #include "ord/OpenRoad.hh"
 
-#include <tcl.h>
-
 #include <cstdlib>
 #include <cstring>
 #include <filesystem>
@@ -16,6 +14,7 @@
 #include <vector>
 
 #include "ord/Version.hh"
+#include "tcl.h"
 #ifdef ENABLE_PYTHON3
 #define PY_SSIZE_T_CLEAN
 #include "Python.h"

src/OpenRoad.cc

@@ -3,8 +3,6 @@
 
 #include "ord/Tech.h"
 
-#include <tcl.h>
-
 #include <string>
 
 #include "db_sta/dbNetwork.hh"
@@ -15,6 +13,7 @@
 #include "sta/Liberty.hh"
 #include "sta/MinMax.hh"
 #include "sta/Units.hh"
+#include "tcl.h"
 
 namespace ord {
 

src/Tech.cc

@@ -3,8 +3,6 @@
 
 #include "ord/Timing.h"
 
-#include <tcl.h>
-
 #include <algorithm>
 #include <array>
 #include <cstring>