Merge branch 'master' into temp_coding_style_guide

Author: soheilshahrouz

.github/scripts/install_dependencies.sh

@@ -2,40 +2,32 @@
 
 sudo apt update
 
+# Required packages specifically for the CI and not VTR in general.
 sudo apt install -y \
   autoconf \
   automake \
   bash \
-  bison \
   binutils \
   binutils-gold \
-  build-essential \
   capnproto \
   exuberant-ctags \
   curl \
   doxygen \
-  flex \
   fontconfig \
   gdb \
-  git \
   gperf \
   libcairo2-dev \
   libcapnp-dev \
-  libgtk-3-dev \
   libevent-dev \
   libfontconfig1-dev \
   liblist-moreutils-perl \
   libncurses5-dev \
-  libx11-dev \
   libxft-dev \
   libxml2-utils \
   libxml++2.6-dev \
-  libreadline-dev \
   tcllib \
   tcl8.6-dev \
-  libffi-dev \
   perl \
-  pkg-config \
   texinfo \
   time \
   valgrind \
@@ -54,9 +46,10 @@ sudo apt install -y \
   clang-15 \
   clang-16 \
   clang-17 \
-  clang-18 \
-  clang-format-18 \
-  libtbb-dev
+  clang-18
+
+# Standard packages install script.
+./install_apt_packages.sh
 
 pip install -r requirements.txt
 

.github/scripts/install_jammy_dependencies.sh

@@ -2,40 +2,32 @@
 
 sudo apt update
 
+# Required packages specifically for the CI and not VTR in general.
 sudo apt install -y \
   autoconf \
   automake \
   bash \
-  bison \
   binutils \
   binutils-gold \
-  build-essential \
   capnproto \
   exuberant-ctags \
   curl \
   doxygen \
-  flex \
   fontconfig \
   gdb \
-  git \
   gperf \
   libcairo2-dev \
   libcapnp-dev \
-  libgtk-3-dev \
   libevent-dev \
   libfontconfig1-dev \
   liblist-moreutils-perl \
   libncurses5-dev \
-  libx11-dev \
   libxft-dev \
   libxml2-utils \
   libxml++2.6-dev \
-  libreadline-dev \
   tcllib \
   tcl8.6-dev \
-  libffi-dev \
   perl \
-  pkg-config \
   texinfo \
   time \
   valgrind \
@@ -50,9 +42,10 @@ sudo apt install -y \
   g++-11 \
   gcc-11 \
   g++-12 \
-  gcc-12 \
-  clang-format-14 \
-  libtbb-dev
+  gcc-12
+
+# Standard packages install script.
+./install_apt_packages.sh
 
 pip install -r requirements.txt
 

.github/workflows/nightly_test_manual.yml

@@ -50,6 +50,7 @@ jobs:
         make get_ispd_benchmarks
         ./dev/upgrade_vtr_archs.sh
         make get_symbiflow_benchmarks
+        make get_zeroasic_rr_graphs
 
     # Build VTR using the default build options.
     - name: 'Build VTR'
@@ -104,3 +105,33 @@ jobs:
       run: |
         source .venv/bin/activate
         ./run_reg_test.py -j12 vtr_reg_nightly_test7
+
+    - name: Upload regression results
+      if: success() || failure()
+      uses: actions/upload-artifact@v4
+      with:
+        name: nightly_test_results
+        path: |
+          vtr_flow/**/*.log
+          vtr_flow/**/vpr.out
+          vtr_flow/**/parse_results*.txt
+
+    - name: Generate golden results
+      if: success() || failure()
+      run: |
+        source .venv/bin/activate
+        ./run_reg_test.py vtr_reg_nightly_test1 -create_golden
+        ./run_reg_test.py vtr_reg_nightly_test2 -create_golden
+        ./run_reg_test.py vtr_reg_nightly_test3 -create_golden
+        ./run_reg_test.py vtr_reg_nightly_test4 -create_golden
+        ./run_reg_test.py vtr_reg_nightly_test5 -create_golden
+        ./run_reg_test.py vtr_reg_nightly_test6 -create_golden
+        ./run_reg_test.py vtr_reg_nightly_test7 -create_golden
+
+    - name: Upload golden results
+      if: success() || failure()
+      uses: actions/upload-artifact@v4
+      with:
+        name: nightly_tests_golden
+        path: |
+          vtr_flow/**/vtr_reg_nightly*/**/golden_results.txt

.github/workflows/test.yml

@@ -99,7 +99,26 @@ jobs:
       run: ./dev/${{ matrix.script }}
 
 
-  UniTests:
+  VerifyTestSuites:
+    runs-on: ubuntu-24.04
+    name: 'Verify Test Suites'
+    steps:
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: 3.12.3
+
+    - uses: actions/checkout@v4
+      # NOTE: We do not need sub-modules. This only verifies the tests, does not run them.
+
+    - name: 'Run test suite verification'
+      run: |
+        ./dev/vtr_test_suite_verifier/verify_test_suites.py \
+            -vtr_regression_tests_dir vtr_flow/tasks/regression_tests \
+            -test_suite_info dev/vtr_test_suite_verifier/test_suites_info.json
+
+
+  UnitTests:
     name: 'U: C++ Unit Tests'
     runs-on: ubuntu-24.04
     steps:
@@ -125,36 +144,90 @@ jobs:
       run: ./.github/scripts/unittest.sh
 
 
-  Warnings:
-    name: 'W: Check Compilation Warnings'
+  # This test builds different variations of VTR (with different CMake Params)
+  # and ensures that they can run the basic regression tests. This also ensures
+  # that these build variations are warning clean.
+  BuildVariations:
     runs-on: ubuntu-24.04
+    name: 'B: Build Variations'
+    env:
+      # For the CI, we want all build variations to be warning clean.
+      # NOTE: Need to turn IPO off due to false warnings being produced.
+      COMMON_CMAKE_PARAMS: '-DCMAKE_COMPILE_WARNING_AS_ERROR=on -DVTR_IPO_BUILD=off'
     steps:
 
     - uses: actions/setup-python@v5
       with:
         python-version: 3.12.3
+
     - uses: actions/checkout@v4
       with:
         submodules: 'true'
 
-    - name: Get number of CPU cores
+    - name: 'Get number of CPU cores'
       uses: SimenB/github-actions-cpu-cores@v2
       id: cpu-cores
 
-    - name: Install dependencies
+    - name: 'Install dependencies'
       run: ./.github/scripts/install_dependencies.sh
 
-    - uses: hendrikmuhs/[email protected]
+    - name: 'ccache'
+      uses: hendrikmuhs/[email protected]
 
-    - name: Test
+    - name: 'Test with VTR_ASSERT_LEVEL 4'
+      if: success() || failure()
       env:
-        #In order to get compilation warnings produced per source file, we must do a non-IPO build
-        #We also turn warnings into errors for this target by doing a strict compile
-        CMAKE_PARAMS: "-DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DVTR_ENABLE_STRICT_COMPILE=on -DVTR_IPO_BUILD=off"
+        CMAKE_PARAMS: "${{ env.COMMON_CMAKE_PARAMS }} -DVTR_ASSERT_LEVEL=4"
         NUM_PROC: ${{ steps.cpu-cores.outputs.count }}
       run: |
+        rm -f build/CMakeCache.txt
         export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
-        ./.github/scripts/build.sh
+        make -j${{ steps.cpu-cores.outputs.count}}
+        ./run_reg_test.py vtr_reg_basic -show_failures -j${{ steps.cpu-cores.outputs.count}}
+
+    - name: 'Test with NO_GRAPHICS'
+      if: success() || failure()
+      env:
+        CMAKE_PARAMS: "${{ env.COMMON_CMAKE_PARAMS }} -DVPR_USE_EZGL=off"
+        NUM_PROC: ${{ steps.cpu-cores.outputs.count }}
+      run: |
+        rm -f build/CMakeCache.txt
+        export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+        make -j${{ steps.cpu-cores.outputs.count}}
+        ./run_reg_test.py vtr_reg_basic -show_failures -j${{ steps.cpu-cores.outputs.count}}
+
+    - name: 'Test with NO_SERVER'
+      if: success() || failure()
+      env:
+        CMAKE_PARAMS: "${{ env.COMMON_CMAKE_PARAMS }} -DVPR_USE_SERVER=off"
+        NUM_PROC: ${{ steps.cpu-cores.outputs.count }}
+      run: |
+        rm -f build/CMakeCache.txt
+        export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+        make -j${{ steps.cpu-cores.outputs.count}}
+        ./run_reg_test.py vtr_reg_basic -show_failures -j${{ steps.cpu-cores.outputs.count}}
+
+    - name: 'Test with CAPNPROTO disabled'
+      if: success() || failure()
+      env:
+        CMAKE_PARAMS: "${{ env.COMMON_CMAKE_PARAMS }} -DVTR_ENABLE_CAPNPROTO=off"
+        NUM_PROC: ${{ steps.cpu-cores.outputs.count }}
+      run: |
+        rm -f build/CMakeCache.txt
+        export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+        make -j${{ steps.cpu-cores.outputs.count}}
+        ./run_reg_test.py vtr_reg_basic -show_failures -j${{ steps.cpu-cores.outputs.count}}
+
+    - name: 'Test with serial VPR_EXECUTION_ENGINE'
+      if: success() || failure()
+      env:
+        CMAKE_PARAMS: "${{ env.COMMON_CMAKE_PARAMS }} -DVPR_EXECUTION_ENGINE=serial -DTATUM_EXECUTION_ENGINE=serial"
+        NUM_PROC: ${{ steps.cpu-cores.outputs.count }}
+      run: |
+        rm -f build/CMakeCache.txt
+        export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+        make -j${{ steps.cpu-cores.outputs.count}}
+        ./run_reg_test.py vtr_reg_basic -show_failures -j${{ steps.cpu-cores.outputs.count}}
 
 
   Regression:
@@ -169,36 +242,12 @@ jobs:
             suite: 'vtr_reg_basic',
             extra_pkgs: ""
           },
-          {
-            name: 'Basic with highest assertion level',
-            params: '-DCMAKE_COMPILE_WARNING_AS_ERROR=on -DVTR_IPO_BUILD=off -DVTR_ASSERT_LEVEL=4 -DWITH_BLIFEXPLORER=on',
-            suite: 'vtr_reg_basic',
-            extra_pkgs: ""
-          },
           {
             name: 'Basic_odin',
             params: '-DCMAKE_COMPILE_WARNING_AS_ERROR=on -DVTR_IPO_BUILD=off -DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DWITH_PARMYS=OFF -DWITH_ODIN=on',
             suite: 'vtr_reg_basic_odin',
             extra_pkgs: ""
           },
-          {
-            name: 'Basic with NO_GRAPHICS',
-            params: '-DCMAKE_COMPILE_WARNING_AS_ERROR=on -DVTR_IPO_BUILD=off -DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DVPR_USE_EZGL=off',
-            suite: 'vtr_reg_basic',
-            extra_pkgs: ""
-          },
-          {
-            name: 'Basic with NO_SERVER',
-            params: '-DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DVPR_USE_EZGL=on -DVPR_USE_SERVER=off',
-            suite: 'vtr_reg_basic',
-            extra_pkgs: ""
-          },
-          {
-            name: 'Basic with CAPNPROTO disabled',
-            params: '-DCMAKE_COMPILE_WARNING_AS_ERROR=on -DVTR_IPO_BUILD=off -DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DVTR_ENABLE_CAPNPROTO=off',
-            suite: 'vtr_reg_basic',
-            extra_pkgs: ""
-          },
           {
             name: 'Basic with VTR_ENABLE_DEBUG_LOGGING',
             params: '-DCMAKE_COMPILE_WARNING_AS_ERROR=on -DVTR_IPO_BUILD=off -DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DVTR_ENABLE_DEBUG_LOGGING=on',
@@ -510,8 +559,9 @@ jobs:
     needs:
       - Build
       - Format
-      - UniTests
-      - Warnings
+      - VerifyTestSuites
+      - UnitTests
+      - BuildVariations
       - Regression
       - Sanitized
       - Parmys

.gitmodules

@@ -6,3 +6,10 @@
 [submodule "libs/EXTERNAL/sockpp"]
 	path = libs/EXTERNAL/sockpp
 	url = https://github.com/w0lek/sockpp.git
+
+[submodule "libs/EXTERNAL/libezgl"]
+	path = libs/EXTERNAL/libezgl
+	url = https://github.com/verilog-to-routing/ezgl.git
+[submodule "libs/EXTERNAL/yosys"]
+	path = libs/EXTERNAL/yosys
+	url = https://github.com/YosysHQ/yosys.git

.readthedocs.yaml

@@ -19,6 +19,10 @@ build:
   tools:
     python: "3.11"
 
+submodules:
+  include: all
+
 python:
   install:
     - requirements: doc/requirements.txt
+    - requirements: requirements.txt