Merge remote-tracking branch 'origin/master' into yosys-upgrade

Attempting to resolve conflicts on yosys-upgrade

Author: loglav03

.github/workflows/nightly_test_manual.yml

@@ -112,4 +112,5 @@ jobs:
         name: nightly_test_results
         path: |
           vtr_flow/**/*.log
+          vtr_flow/**/vpr.out
           vtr_flow/**/parse_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,6 +144,92 @@ jobs:
       run: ./.github/scripts/unittest.sh
 
 
+  # 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'
+      uses: SimenB/github-actions-cpu-cores@v2
+      id: cpu-cores
+
+    - name: 'Install dependencies'
+      run: ./.github/scripts/install_dependencies.sh
+
+    - name: 'ccache'
+      uses: hendrikmuhs/[email protected]
+
+    - name: 'Test with VTR_ASSERT_LEVEL 4'
+      if: success() || failure()
+      env:
+        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"
+        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:
     runs-on: ubuntu-24.04
     strategy:
@@ -137,42 +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 serial VPR_EXECUTION_ENGINE',
-            params: '-DCMAKE_COMPILE_WARNING_AS_ERROR=on -DVTR_IPO_BUILD=off -DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DVPR_EXECUTION_ENGINE=serial -DTATUM_EXECUTION_ENGINE=serial',
-            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',
@@ -484,7 +559,9 @@ jobs:
     needs:
       - Build
       - Format
-      - UniTests
+      - VerifyTestSuites
+      - UnitTests
+      - BuildVariations
       - Regression
       - Sanitized
       - Parmys

.gitmodules

@@ -6,3 +6,7 @@
 [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

.readthedocs.yaml

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

Makefile

@@ -1,4 +1,4 @@
-#This is a simple wrapper which hides cmake (for convenience, and from non-expert end users).
+# This is a simple wrapper which hides cmake (for convenience, and from non-expert end users).
 #
 # It supports the targets:
 #   'make'           - builds everything (all libaries/executables)
@@ -15,12 +15,14 @@
 #
 #   'make BUILD_TYPE=debug VERBOSE=1'
 
-#Default build type
-# Possible values:
-#    release_pgo	#Perform a 2-stage build with profile-guided compiler optimization
-#    release		#Build with compiler optimization
-#    debug			#Build with debug info and no compiler optimization
-#    strict			#Build VPR with warnings treated as errors
+# Build type
+# Possible values (not case sensitive):
+#    release            #Build with compiler optimization (Default)
+#    RelWithDebInfo     #Build with debug info and compiler optimizations
+#    debug              #Build with debug info and no compiler optimization
+# Possible suffixes:
+#    _pgo               #Perform a 2-stage build with profile-guided compiler optimization
+#    _strict            #Build VPR with warnings treated as errors
 BUILD_TYPE ?= release
 
 #Debugging verbosity enable

README.developers.md

@@ -1131,11 +1131,17 @@ All tests passed (1 assertion in 1 test case)
 VTR has support for several additional tools/features to aid debugging.
 
 ## Basic
-To build vpr with make in debug mode, simply add `BUILD_TYPE=debug` at the end of your make command. 
+To build a tool with make in debug mode, simply add `BUILD_TYPE=debug` at the end of your make command. For example, to build all tools in debug mode use:
 ```shell
-$ make vpr BUILD_TYPE=debug
+$ make BUILD_TYPE=debug
 ```
 
+You can also enable additional (verbose) output from some tools. To build vpr with both debug information and additional output, use:
+```shell
+$ make vpr BUILD_TYPE=debug VERBOSE=1
+```
+
+
 ## Sanitizers
 VTR can be compiled using *sanitizers* which will detect invalid memory accesses, memory leaks and undefined behaviour (supported by both GCC and LLVM):
 ```shell

dev/subtree_config.xml

@@ -24,11 +24,6 @@
         internal_path="libs/EXTERNAL/libtatum"
         external_url="https://github.com/verilog-to-routing/tatum.git"
         default_external_ref="master"/>
-    <subtree
-        name="libezgl"
-        internal_path="libs/EXTERNAL/libezgl"
-        external_url="https://github.com/mariobadr/ezgl.git"
-        default_external_ref="master"/>
     <subtree
         name="capnproto"
         internal_path="libs/EXTERNAL/capnproto"

dev/vtr_test_suite_verifier/test_suites_info.json

@@ -0,0 +1,85 @@
+{"test_suites": [
+    {
+        "name": "vtr_reg_basic",
+        "ignored_tasks": []
+    },
+    {
+        "name": "vtr_reg_basic_odin",
+        "ignored_tasks": []
+    },
+    {
+        "name": "parmys_reg_basic",
+        "ignored_tasks": []
+    },
+    {
+        "name": "vtr_reg_valgrind_small",
+        "ignored_tasks": []
+    },
+    {
+        "name": "vtr_reg_strong",
+        "ignored_tasks": [
+            "strong_ap/gen_mass_report",
+            "strong_cluster_seed_type",
+            "strong_router_heap",
+            "strong_verify_rr_graph_3d",
+            "strong_xilinx_support"
+        ]
+    },
+    {
+        "name": "vtr_reg_strong_odin",
+        "ignored_tasks": [
+            "strong_pack_modes",
+            "strong_xilinx_support",
+            "strong_router_heap",
+            "strong_cluster_seed_type"
+        ]
+    },
+    {
+        "name": "vtr_reg_nightly_test1",
+        "ignored_tasks": [
+            "arithmetic_tasks/FIR_filters",
+            "arithmetic_tasks/FIR_filters_frac",
+            "arithmetic_tasks/adder_trees",
+            "symbiflow"
+        ]
+    },
+    {
+        "name": "vtr_reg_nightly_test2",
+        "ignored_tasks": [
+            "complex_switch",
+            "vpr_verify_custom_sb_diff_chan_width",
+            "vtr_xilinx_qor"
+        ]
+    },
+    {
+        "name": "vtr_reg_nightly_test3",
+        "ignored_tasks": [
+            "vtr_reg_qor_chain_large"
+        ]
+    },
+    {
+        "name": "vtr_reg_nightly_test4",
+        "ignored_tasks": []
+    },
+    {
+        "name": "vtr_reg_nightly_test5",
+        "ignored_tasks": [
+            "vpr_noc_mlp_odin_ii",
+            "vpr_3d_noc_star_topology",
+            "vpr_3d_noc_nearest_neighbor_topology",
+            "vpr_3d_noc_clique_topology"
+        ]
+    },
+    {
+        "name": "vtr_reg_nightly_test6",
+        "ignored_tasks": []
+    },
+    {
+        "name": "vtr_reg_nightly_test7",
+        "ignored_tasks": [
+            "vtr_reg_qor_large_depop_run_flat",
+            "vtr_reg_qor_large_run_flat",
+            "verify_router_lookahead_run_flat"
+        ]
+    }
+]}