[CI] Added Odin Build

Author: AlexandreSinger

.github/workflows/test.yml

@@ -108,6 +108,44 @@ jobs:
         ccache -s
 
 
+  BuildVTRWithOdin:
+    name: 'B: Building VTR Release With Odin'
+    runs-on: ubuntu-24.04
+    steps:
+    - 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
+
+    - uses: hendrikmuhs/[email protected]
+
+    - name: Build
+      env:
+        CMAKE_PARAMS: "-DCMAKE_COMPILE_WARNING_AS_ERROR=on -DVTR_IPO_BUILD=off -DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DWITH_PARMYS=OFF -DWITH_ODIN=on"
+        NUM_PROC: ${{ steps.cpu-cores.outputs.count }}
+      run: |
+        export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+        make -j${{ steps.cpu-cores.outputs.count}} release
+
+    - name: Pack Build
+      shell: bash
+      run: |
+        tar -czvf build.tar.gz --exclude='CMakeFiles' --exclude='*.a' --exclude='*.cmake' build/
+
+    - name: Store Build Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: build-release-with-odin.tar.gz
+        path: build.tar.gz
+        retention-days: 1
+
+    - name: Print CCache Statistics
+      run: |
+        ccache -s
+
+
   Format:
     runs-on: ubuntu-24.04
     strategy:
@@ -272,9 +310,21 @@ jobs:
         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 VTR_ENABLE_DEBUG_LOGGING enabled'
+      if: success() || failure()
+      env:
+        CMAKE_PARAMS: "${{ env.COMMON_CMAKE_PARAMS }} -DVTR_ENABLE_DEBUG_LOGGING=on"
+        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
+    needs: [BuildVTR]
     strategy:
       fail-fast: false
       matrix:
@@ -285,29 +335,83 @@ jobs:
             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 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',
-            suite: 'vtr_reg_basic',
-            extra_pkgs: ""
-          },
-          {
-            name: 'Basic_odin 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 -DWITH_PARMYS=OFF -DWITH_ODIN=on',
-            suite: 'vtr_reg_basic_odin',
-            extra_pkgs: ""
-          },
           {
             name: 'Strong',
             params: '-DCMAKE_COMPILE_WARNING_AS_ERROR=on -DVTR_IPO_BUILD=off -DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on',
             suite: 'vtr_reg_strong',
             extra_pkgs: "libeigen3-dev"
+          }
+        ]
+    name: 'R: ${{ matrix.name }}'
+    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: Install external libraries
+      run: sudo apt install -y ${{ matrix.extra_pkgs }}
+      if: ${{ matrix.extra_pkgs }}
+
+    - name: Download Build Artifact
+      uses: actions/download-artifact@v4
+      with:
+        name: build-release.tar.gz
+
+    - name: Unpack Build
+      shell: bash
+      run: |
+        tar -xvzf build.tar.gz
+
+    - name: Test
+      run: |
+        ./run_reg_test.py ${{ matrix.suite }} -show_failures -j${{ steps.cpu-cores.outputs.count}}
+
+    - name: Upload regression run files
+      if: ${{ !cancelled() }}
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{matrix.name}}_run_files
+        path: |
+          vtr_flow/**/*.out
+          # vtr_flow/**/*.blif  # Removed since it was taking too much space and was hardly used.
+          vtr_flow/**/*.p
+          vtr_flow/**/*.net
+          vtr_flow/**/*.r
+
+    - name: Upload regression results
+      if: ${{ !cancelled() }}
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{matrix.name}}_results
+        path: |
+          vtr_flow/**/*.log
+          vtr_flow/**/parse_results*.txt
+
+
+  RegressionWithOdin:
+    runs-on: ubuntu-24.04
+    needs: [BuildVTRWithOdin]
+    strategy:
+      fail-fast: false
+      matrix:
+        include: [
+          {
+            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: 'Strong_odin',
@@ -344,15 +448,18 @@ jobs:
       run: sudo apt install -y ${{ matrix.extra_pkgs }}
       if: ${{ matrix.extra_pkgs }}
 
-    - uses: hendrikmuhs/[email protected]
+    - name: Download Build Artifact
+      uses: actions/download-artifact@v4
+      with:
+        name: build-release-with-odin.tar.gz
+
+    - name: Unpack Build
+      shell: bash
+      run: |
+        tar -xvzf build.tar.gz
 
     - name: Test
-      env:
-        CMAKE_PARAMS: ${{ matrix.params }}
-        NUM_PROC: ${{ steps.cpu-cores.outputs.count }}
       run: |
-        export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
-        ./.github/scripts/build.sh
         ./run_reg_test.py ${{ matrix.suite }} -show_failures -j${{ steps.cpu-cores.outputs.count}}
 
     - name: Upload regression run files
@@ -376,6 +483,7 @@ jobs:
           vtr_flow/**/*.log
           vtr_flow/**/parse_results*.txt
 
+
   Sanitized:
     runs-on: ubuntu-24.04
     strategy:
@@ -467,6 +575,7 @@ jobs:
   ODINII:
     name: 'ODIN-II Basic Test'
     runs-on: ubuntu-24.04
+    needs: [BuildVTRWithOdin]
     steps:
 
     - uses: actions/setup-python@v5
@@ -483,17 +592,19 @@ jobs:
     - name: Install dependencies
       run: ./.github/scripts/install_dependencies.sh
 
-    - uses: hendrikmuhs/[email protected]
+      - name: Download Build Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: build-release-with-odin.tar.gz
+
+      - name: Unpack Build
+        shell: bash
+        run: |
+          tar -xvzf build.tar.gz
 
     - name: Test
-      env:
-        CMAKE_PARAMS: '-DVTR_ASSERT_LEVEL=3 -DVTR_ENABLE_SANITIZE=on -DVTR_IPO_BUILD=off -DWITH_BLIFEXPLORER=on -DWITH_PARMYS=OFF -DWITH_ODIN=on'
-        BUILD_TYPE: debug
-        NUM_PROC: ${{ steps.cpu-cores.outputs.count }}
       run: |
         sudo sysctl -w vm.mmap_rnd_bits=28
-        export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
-        ./.github/scripts/build.sh
         ./run_reg_test.py odin_reg_basic -show_failures -j${{ steps.cpu-cores.outputs.count }}
 
 
@@ -609,16 +720,19 @@ jobs:
     needs:
       - Build
       - BuildVTR
+      - BuildVTRWithOdin
       - Format
       - VerifyTestSuites
       - UnitTests
       - BuildVariations
       - Regression
+      - RegressionWithOdin
       - Sanitized
       - Parmys
       - ODINII
       - VQM2BLIF
       - Compatibility
+      - JammyCompatibility
     runs-on: ubuntu-24.04
     steps: