Merge branch 'master' into temp_place_est_chan_util

Author: soheilshahrouz

.github/workflows/nightly_test_manual.yml

@@ -112,4 +112,25 @@ jobs:
         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,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

CMakeLists.txt

@@ -26,7 +26,6 @@ set_property(CACHE VTR_IPO_BUILD PROPERTY STRINGS auto on off)
 set(VTR_ASSERT_LEVEL "2" CACHE STRING "VTR assertion checking level. 0: no assertions, 1: fast assertions, 2: regular assertions, 3: additional assertions with noticeable run-time overhead, 4: all assertions (including those with significant run-time cost)")
 set_property(CACHE VTR_ASSERT_LEVEL PROPERTY STRINGS 0 1 2 3 4)
 
-option(VTR_ENABLE_STRICT_COMPILE "Specifies whether compiler warnings should be treated as errors (e.g. -Werror)" OFF)
 option(VTR_ENABLE_SANITIZE "Enable address/leak/undefined-behaviour sanitizers (i.e. run-time error checking)" OFF)
 option(VTR_ENABLE_PROFILING "Enable performance profiler (gprof)" OFF)
 option(VTR_ENABLE_COVERAGE "Enable code coverage tracking (gcov)" OFF)
@@ -228,18 +227,17 @@ foreach(flag ${FLEX_BISON_WARN_SUPPRESS_FLAGS_TO_CHECK})
     endif()
 endforeach()
 
-#Suppress IPO link warnings
-set(IPO_LINK_WARN_SUPRESS_FLAGS " ")
-set(IPO_LINK_WARN_SUPRESS_FLAGS_TO_CHECK
-    "-Wno-null-dereference"
-    )
-foreach(flag ${IPO_LINK_WARN_SUPRESS_FLAGS_TO_CHECK})
-    CHECK_CXX_COMPILER_FLAG(${flag} CXX_COMPILER_SUPPORTS_${flag})
-    if(CXX_COMPILER_SUPPORTS_${flag})
-        #Flag supported, so enable it
-        set(IPO_LINK_WARN_SUPRESS_FLAGS "${IPO_LINK_WARN_SUPRESS_FLAGS} ${flag}")
-    endif()
-endforeach()
+# Suppress IPO link warnings.
+# When IPO is turned on, it sometimes leads to false positives for warnings
+# since it checks for warnings after some of the source files have been compiled.
+# We globally suppress these warnings here. Any CMake executable which is added
+# after this line will have these warnings suppressed at link time.
+if (CMAKE_INTERPROCEDURAL_OPTIMIZATION)
+    message(STATUS "IPO: Suppressing known VTR warnings.")
+    add_link_options(-Wno-alloc-size-larger-than  # libarchfpga allocates C-style arrays using integers.
+                     -Wno-stringop-overflow       # EXTERNAL/capnproto has some string overflow warnings.
+                     )
+endif()
 
 #
 # Sanitizer flags

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
@@ -40,7 +42,7 @@ override CMAKE_PARAMS := -DCMAKE_BUILD_TYPE=$(CMAKE_BUILD_TYPE) -G 'Unix Makefil
 #Are we doing a strict (i.e. warnings as errors) build?
 ifneq (,$(findstring strict,$(BUILD_TYPE)))
 	#Configure for strict build with VPR warning treated as errors
-override CMAKE_PARAMS := -DVTR_ENABLE_STRICT_COMPILE=on ${CMAKE_PARAMS}
+override CMAKE_PARAMS := -DCMAKE_COMPILE_WARNING_AS_ERROR=on ${CMAKE_PARAMS}
 endif #Strict build type
 
 #Enable verbosity

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

blifexplorer/CMakeLists.txt

@@ -56,13 +56,6 @@ else()
                             ${CMAKE_DL_LIBS}
     )
 
-    #Supress IPO link warnings if IPO is enabled
-    get_target_property(TEST_BLIFEXPLORER_USES_IPO blifexplorer INTERPROCEDURAL_OPTIMIZATION)
-    if (TEST_BLIFEXPLORER_USES_IPO)
-        set_property(TARGET blifexplorer APPEND PROPERTY LINK_FLAGS ${IPO_LINK_WARN_SUPRESS_FLAGS})
-    endif()
-
-
     install(TARGETS blifexplorer DESTINATION bin)
 
 endif()

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"