Merge branch 'master' into master

Signed-off-by: Vitor Bandeira <[email protected]>

.clang-tidy

@@ -3,6 +3,8 @@ Checks: >
   clang-diagnostic-*,
   clang-analyzer-*,
   -clang-analyzer-core.NonNullParamChecker,
+  -clang-analyzer-core.CallAndMessage,
+  -clang-analyzer-core.uninitialized.UndefReturn,
   -clang-analyzer-cplusplus.NewDeleteLeaks,
   -clang-analyzer-optin.performance.Padding,
   readability-*,
@@ -50,10 +52,12 @@ Checks: >
   -modernize-use-transparent-functors,
   misc-*,
   -misc-const-correctness,
+  -misc-include-cleaner,
   -misc-no-recursion,
   -misc-non-private-member-variables-in-classes,
   -misc-redundant-expression,
   -misc-unused-parameters,
+  -misc-use-anonymous-namespace,
 
 CheckOptions:
    - key:             google-runtime-int.TypeSuffix

.github/workflows/black.yaml

@@ -0,0 +1,11 @@
+name: Lint Python
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: psf/black@stable
+

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

@@ -13,7 +13,7 @@ jobs:
           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
       - name: Check that ODB Generated Files Are Up To Date

.github/workflows/github-actions-build-deb-package.yml

@@ -17,7 +17,7 @@ jobs:
       image: openroad/${{ matrix.os }}-dev
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
 

.github/workflows/github-actions-clang-tidy.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: 'recursive'
       - name: ClangTidy Gen
@@ -17,6 +17,7 @@ jobs:
           build_dir: './build'
           cmake_command: cmake . -B build
           config_file: '.clang-tidy'
+          exclude: "*/codeGenerator/templates/*"
           split_workflow: true
       - name: Upload Artifacts
         uses: actions/upload-artifact@v3

.github/workflows/github-actions-docs-test.yml

@@ -0,0 +1,39 @@
+name: Docs Tester
+
+on:
+  push:
+
+jobs:
+  docs-test-job:
+    name: 'Test docs for Tcl syntax and README'
+    runs-on: ubuntu-latest
+    container:
+      image: openroad/ubuntu-cpp20
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        submodules: 'recursive'
+
+    - name: Install required package
+      run: |
+        apt-get update 
+        apt-get install -y pandoc
+
+    - name: Build messages
+      run: |
+        python3 docs/src/test/make_messages.py
+
+    - name: Preprocess files
+      run: |
+        cd docs
+        make preprocess -j${nproc}
+    - name: Run Tcl syntax parser
+      run: |
+        python3 docs/src/test/man_tcl_params.py
+    - name: Run readme parser
+      run : |
+        cd docs
+        make clean
+        python3 src/test/readme_check.py

.github/workflows/github-actions-format-on-push.yml

@@ -15,7 +15,7 @@ jobs:
           sudo apt update
           sudo apt install -y clang-14 clang-format-14
       - name: Check out repository code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Get changed files
@@ -24,7 +24,7 @@ jobs:
       - name: Check format of cpp changed files
         run: |
           for file in ${{ steps.changed-files.outputs.all_changed_files }}; do
-            if [[ "${file##*.}" =~ ^(h|C|cc|cp|cpp|c++|CPP|cxx|hh)$ && "${file}" != "src/sta/"* && "${file}" != "src/rsz/"* && "${file}" != "src/odb/src/codeGenerator/"* ]]; then
+            if [[ "${file##*.}" =~ ^(h|C|cc|cp|cpp|c++|CPP|cxx|hh)$ && "${file}" != "src/sta/"* && "${file}" != "src/odb/src/codeGenerator/"* ]]; then
               clang-format --dry-run --Werror $file
             fi
           done

.github/workflows/github-actions-lint-tcl.yml

@@ -12,15 +12,8 @@ jobs:
 
       - name: Install tclint
         run: |
-          python -m pip install tclint==0.1.6
+          python -m pip install tclint==0.3.2
 
-      # TODO: hardcoded list of files while we incrementally lint codebase
-      # See issue #4347 for tracking
       - name: Lint
         run: |
-          tclint \
-            src/rsz/src/Resizer.tcl \
-            src/gui/src/gui.tcl \
-            src/pdn/src/pdn.tcl \
-            src/pad/src/pad.tcl \
-            src/psm/src/pdnsim.tcl
+          tclint .

.github/workflows/github-actions-macos.yml

@@ -15,7 +15,7 @@ jobs:
         with:
           xcode-version: latest-stable
       - name: Check out repository code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: 'recursive'
       - name: Install dependencies
@@ -47,7 +47,7 @@ jobs:
           rm -rf "${{ github.workspace }}"
           mkdir -p "${{ github.workspace }}"
       - name: Check out repository code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: 'recursive'
       - name: Build OpenROAD

.github/workflows/github-actions-on-push.yml

@@ -11,9 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: run security_scan_on_push
         uses: The-OpenROAD-Project/actions/security_scan_on_push@main
-
-
-

CMakeLists.txt

@@ -75,6 +75,14 @@ option(ENABLE_TESTS "Enable OpenROAD tests" ON)
 # Allow enabling address sanitizer
 option(ASAN "Enable Address Sanitizer" OFF)
 
+# Allow enabling address sanitizer
+#  On Ubuntu22.04 you need to use "sudo sysctl vm.mmap_rnd_bits=28" to
+#  resolve a known fatal
+option(TSAN "Enable Thread Sanitizer" OFF)
+
+# Allow enabling address sanitizer
+option(UBSAN "Enable Undefined Behavior Sanitizer" OFF)
+
 project(OpenROAD VERSION 1
   LANGUAGES CXX
 )
@@ -137,19 +145,54 @@ configure_file(
   ${OPENROAD_HOME}/include/ord/Version.hh
   )
 
+
 ################################################################
 
+if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS "9.1")
+  MESSAGE(STATUS "Older version of GCC detected. Linking against stdc++fs")
+  link_libraries(stdc++fs)
+endif()
+
 # Ask CMake to output a compile_commands.json file for use with things like clang-tidy
 set(CMAKE_EXPORT_COMPILE_COMMANDS 1)
 
-
-
 add_subdirectory(third-party)
 
 if(ENABLE_TESTS)
+  find_program (BASH_PROGRAM bash REQUIRED)
+
   enable_testing()
   add_custom_target(build_and_test ${CMAKE_CTEST_COMMAND} --parallel --output-on-failure -LE IntegrationTest)
   include(GoogleTest)
 endif()
 
 add_subdirectory(src)
+
+# After all compiled, look for the respective flags
+target_compile_definitions(openroad PRIVATE GPU)
+target_compile_definitions(openroad PRIVATE BUILD_PYTHON)
+target_compile_definitions(openroad PRIVATE BUILD_GUI)
+target_compile_definitions(openroad PRIVATE ENABLE_CHARTS)
+
+####################################################################
+
+# Build man pages (Optional)
+
+# Use the processor_count command to get the number of cores
+include(ProcessorCount)
+ProcessorCount(PROCESSOR_COUNT)
+message("Number of processor cores: ${PROCESSOR_COUNT}")
+
+option(BUILD_MAN "Enable building man pages" OFF)
+if(BUILD_MAN)
+  add_custom_target(
+    man_page ALL
+    COMMAND make clean && make preprocess && make all -j${PROCESSOR_COUNT}
+    WORKING_DIRECTORY ${OPENROAD_HOME}/docs
+  )
+
+  # Based on ${CMAKE_INSTALL_PREFIX}, we want to go to ${CMAKE_INSTALL_PREFIX}/share/man
+  set(MANPAGE_DIR ${OPENROAD_HOME}/docs/cat)
+  install(DIRECTORY ${MANPAGE_DIR} DESTINATION ${CMAKE_INSTALL_PREFIX}/share/man)
+
+endif()