Merge branch 'master' into grid-branch

Signed-off-by: Brayden Louie <[email protected]>

Author: braydenlouie

.bazelignore

@@ -0,0 +1,4 @@
+build/
+debug/
+src/sta/build/
+src/sta/debug/

.bazelrc

@@ -0,0 +1,103 @@
+common --enable_bzlmod
+common --enable_workspace  # explicitly currently still needing this
+
+# suppress distracting warning about newer module
+# versions found in dependency graph.
+common --check_direct_dependencies=off
+
+# Test timeouts for various levels.
+test --test_timeout=300,1800,1800,9600
+
+# bazel 7 is somewhat forgiving for glob patterns that don't
+# match, but bazel 8 will be strict. So start now.
+common --incompatible_disallow_empty_glob
+
+build --cxxopt "-std=c++17"        --host_cxxopt "-std=c++17"
+build --cxxopt "-xc++"             --host_cxxopt "-xc++"
+
+# Needed for floating point stability in FFT (fft_test will check this).
+# See also https://kristerw.github.io/2021/11/09/fp-contract/
+build --cxxopt "-ffp-contract=off" --host_cxxopt "-ffp-contract=off"
+
+# allow exceptions.
+build  --cxxopt=-fexceptions    --host_cxxopt=-fexceptions
+
+# Turn warnings on...
+build --copt "-Wall"               --host_copt "-Wall"
+build --copt "-Wextra"             --host_copt "-Wextra"
+
+# ... and disable the warnings we're not interested in.
+build --copt "-Wno-sign-compare"          --host_copt "-Wno-sign-compare"
+build --copt "-Wno-unused-parameter"      --host_copt "-Wno-unused-parameter"
+build --copt "-Wno-c++20-designator"      --host_copt "-Wno-c++20-designator"
+build --copt "-Wno-gcc-compat"            --host_copt "-Wno-gcc-compat"
+build --copt "-Wno-nullability-extension" --host_copt "-Wno-nullability-extension"
+
+# The warning acceptance bar in CI for PRs is set by -Werror of a specific
+# version of some chosen compiler. Disable warnings from other compilers until
+# they are fixed and under CI -Werror acceptance critera as there is nothing the
+# developers can(they can't be reproduced locally or in CI) or should do about
+# these warnings in code they are not working on.
+build --copt "-Wno-unused-private-field"  --host_copt "-Wno-unused-private-field"
+build --copt "-Wno-cast-function-type-mismatch"  --host_copt "-Wno-cast-function-type-mismatch"
+build --copt "-Wno-unused-but-set-variable"  --host_copt "-Wno-unused-but-set-variable"
+build --copt "-Wno-deprecated-copy"  --host_copt "-Wno-deprecated-copy"
+build --copt "-Wno-deprecated-copy-with-user-provided-copy"  --host_copt "-Wno-deprecated-copy-with-user-provided-copy"
+build --copt "-Wno-dangling"  --host_copt "-Wno-dangling"
+
+# For 3rd party code: Disable warnings entirely.
+# They are not actionable and just create noise.
+build --per_file_copt=external/.*@-w
+build --host_per_file_copt=external/.*@-w
+
+# Settings for --config=asan address sanitizer build
+build:asan --strip=never
+build:asan --copt -fsanitize=address --host_copt -fsanitize=address
+build:asan --copt -DADDRESS_SANITIZER --host_copt -DADDRESS_SANITIZER
+build:asan --copt -O1 --host_copt -O1
+build:asan --copt -g --host_copt -g
+build:asan --copt -fno-omit-frame-pointer --host_copt -fno-omit-frame-pointer
+build:asan --linkopt -fsanitize=address --host_linkopt -fsanitize=address
+
+# Flags with enough debug symbols to get useful outputs with Linux `perf`
+build:profile --strip=never
+build:profile --copt -g --host_copt -g
+build:profile --copt -gmlt --host_copt -gmlt
+build:profile --copt -fno-omit-frame-pointer --host_copt -fno-omit-frame-pointer
+
+# TODO: document
+build --incompatible_strict_action_env
+
+test --build_tests_only
+
+# --- Performance Optimizations ---
+# Use a high number of jobs and let the scheduler manage concurrency
+build --jobs=200
+
+# Enable local disk caching to supplement the remote cache.
+build --disk_cache=~/.cache/bazel-disk-cache
+build --repository_cache=~/.cache/bazel-repository-cache
+
+# --- CI Settings (write access) ---
+build:ci --remote_cache=https://storage.googleapis.com/openroad-bazel-cache
+build:ci --remote_cache_compression=true
+build:ci --remote_upload_local_results=true
+# CI only needs to know if the build succeeded, not the artifacts themselves.
+build:ci --remote_download_minimal
+# Disable disk cache for CI builds
+build:ci --disk_cache=
+
+# --- OpenROAD Developer Settings (read-only access) ---
+build:openroad-dev --remote_cache=https://storage.googleapis.com/openroad-bazel-cache
+build:openroad-dev --remote_cache_compression=true
+build:openroad-dev --remote_upload_local_results=false
+# Developers need the actual output files to run and use them.
+build:openroad-dev --remote_download_toplevel
+build:openroad-dev --google_default_credentials=true
+build:openroad-dev --disk_cache=/workspace/.cache/bazel-disk-cache
+build:openroad-dev --repository_cache=/workspace/.cache/bazel-repository-cache
+
+# Without this, bazelisk build ... builds the bazel-orfs tests
+build --build_tag_filters=-orfs
+
+try-import %workspace%/user.bazelrc

.bazelversion

@@ -0,0 +1 @@
+8.3.1

.clang-format

@@ -26,6 +26,8 @@ BraceWrapping:
   SplitEmptyNamespace:   true
 BreakBeforeBinaryOperators: All
 BreakBeforeBraces: Custom
+InsertBraces: true
+LineEnding: LF
 DerivePointerAlignment: false
 SpaceAfterCStyleCast: true
 Standard: c++17

.clang-tidy

@@ -31,6 +31,7 @@ Checks: >
   -google-runtime-references,
   -google-explicit-constructor,
   performance-*,
+  -performance-enum-size,
   bugprone-*,
   -bugprone-branch-clone,
   -bugprone-easily-swappable-parameters,
@@ -56,11 +57,16 @@ Checks: >
   -misc-non-private-member-variables-in-classes,
   -misc-redundant-expression,
   -misc-unused-parameters,
+  -misc-use-anonymous-namespace,
 
 CheckOptions:
    - key:             google-runtime-int.TypeSuffix
      value:           _t
 
+# All modules but sta
+# Exclude build as there is too much noise from swig generated code
+HeaderFilterRegex: "(?!build/.*)/(ant|cts|dbSta|dft|dpl|drt|dst|est|exa|fin|gpl|grt|gui|ifp|mpl|odb|ord|pad|par|pdn|ppl|psm|rcx|rmp|rsz|stt|tap|upf|utl)/.*"
+
 # Not currently handling identifier naming
 # WarningsAsErrors: "*"
 

.dockerignore

@@ -1,3 +1,4 @@
 .git
 build*
 Dockerfile
+etc/openroad_deps_prefixes.txt

.github/workflows/black.yaml

@@ -0,0 +1,18 @@
+name: Lint Python
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  Black:
+    runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: Run black
+        uses: psf/black@stable

.github/workflows/github-actions-are-differences-found.yml

@@ -0,0 +1,20 @@
+name: Check that OK files are up to date
+
+on:
+  pull_request:
+
+jobs:
+  No-Diffs-In-Ok-Files:
+    runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Check ok files
+        run: |
+          set +e
+          grep --include="*.ok" -Rn "Differences found "
+          if [[ "$?" == "0" ]]; then
+            exit 1
+          fi

.github/workflows/github-actions-are-odb-files-generated.yml

@@ -1,23 +1,29 @@
 name: Check That ODB Files Are Generated
+
 on:
-  # Triggers the workflow on push or pull request events
   push:
+    branches:
+    - master
   pull_request:
+    branches:
+    - master
 
 jobs:
-  format:
-    runs-on: ubuntu-latest
+  Are-Odb-Files-Generated:
+    runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
     steps:
-      - name: setup
-        run: |
-          sudo apt update
-          sudo apt install -y python3-jinja2 git clang-format-14
       - name: Check out repository code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          submodules: 'recursive'
+      - name: setup
+        run: |
+          python3 -m venv venv
+          venv/bin/pip install jinja2==3.1.6
       - name: Check that ODB Generated Files Are Up To Date
         run: |
+          source venv/bin/activate
           cd src/odb/src/codeGenerator/
           ./generate
           if [ -z "$(git status --porcelain)" ]; then
@@ -26,7 +32,7 @@ jobs:
             echo ::group::Non-Empty Git Status Oputput
             git status --porcelain
             echo ::endgroup::
-            
+
             echo ::group::Non-Empty Git Diff Oputput
             git diff
             echo ::endgroup::
@@ -35,4 +41,3 @@ jobs:
             printf "run ./generate in the src/odb/src/codeGenerator folder"
             exit 1
           fi
-