simplify caching

Author: TShapinsky

.github/workflows/build.yaml

@@ -12,70 +12,51 @@ jobs:
   cache:
     name: Update Submodule Cache
     runs-on: ubuntu-24.04
+    outputs:
+      key: submodules-${{ steps.submodule-hash.outputs.HASH }}
+    env:
+      cache-path: |
+        .git/modules
+        binutils
+        gdb
+        gcc
+        llvm
+        newlib
+        glibc
+        musl
+        uclib-ng
+        dejagnu
+        pk
+        qemu
+        spike
     steps:
       - uses: actions/checkout@v4
 
-      - name: Cache GCC
-        uses: actions/cache@v4
-        with:
-          path: |
-            .git/modules/gcc
-            gcc
-          key: compiler-gcc
-
-      - name: Cache LLVM
-        uses: actions/cache@v4
-        with:
-          path: |
-            .git/modules/llvm
-            llvm
-          key: compiler-llvm
-      
-      - name: Cache Newlib
-        uses: actions/cache@v4
-        with:
-          path: |
-            .git/modules/newlib
-            newlib
-          key: mode-newlib
+      - name: Generate Submodule Hash
+        id: submodule-hash
+        run: echo "HASH=$(git submodule | sha1sum | sed 's/.\{3\}$//')" >> $GITHUB_OUTPUT
 
-      - name: Cache Linux
+      - name: Check is Cache Exists for Exact Submodule Configuration
+        id: cache-check
         uses: actions/cache@v4
         with:
-          path: |
-            .git/modules/glibc
-            glibc
-          key: mode-linux
+          path: ${{ env.cache-path }}
+          key: submodules-${{ steps.submodule-hash.outputs.HASH }}
+          lookup-only: true
 
-      - name: Cache musl
+      - name: If no Cache Hit, Update Cache
         uses: actions/cache@v4
+        if: steps.cache-check.outputs.cache-hit != 'true'
         with:
-          path: |
-            .git/modules/musl
-            musl
-          key: mode-musl
-
-      - name: Cache uClibc
-        uses: actions/cache@v4
-        with:
-          path: |
-            .git/modules/uclibc-ng
-            uclibc-ng
-          key: mode-uclibc
+          path: ${{ env.cache-path }}
+          key: submodules-${{ steps.submodule-hash.outputs.HASH }}
+          restore-keys: |
+            submodules-
 
-      - name: Cache Always Required Submodules
-        uses: actions/cache@v4
-        with:
-          path: |
-            .git/modules/binutils
-            .git/modules/gdb
-            binutils
-            gdb
-          key: general-dependencies
-
-      - name: Clone needed submodules
+      - name: Clone submodules
+        if: steps.cache-check.outputs.cache-hit != 'true'
         run: |
-          git submodule update --init --progress --depth 1 --jobs $(nproc) binutils gdb gcc llvm newlib glibc musl
+          git submodule update --init --progress --depth 1 --jobs $(nproc) binutils gdb gcc llvm newlib glibc musl dejagnu pk qemu spike
           git submodule update --init --progress uclibc-ng
 
 
@@ -84,6 +65,8 @@ jobs:
     name: Build Toolchain Variants
     runs-on: ${{ matrix.os }}
     needs: [cache]
+    env:
+      cache-key: ${{ needs.cache.outputs.key }}
     strategy:
       matrix:
         os:     [ubuntu-22.04, ubuntu-24.04]
@@ -105,63 +88,44 @@ jobs:
           echo "-- After --"
           df -h
 
-      - name: Generate Required Submodules
-        id: required-submodules
+      - name: Generate Submodules List
+        id: cache-path
         run: |
+          submodules="gdb:binutils"
           case "${{ matrix.mode }}" in
             "linux")
-              MODE_SUBMODULE="glibc";;
+              submodules="$submodules:glibc";;
             "musl")
-              MODE_SUBMODULE="musl";;
+              submodules="$submodules:musl";;
             "uclibc")
-              MODE_SUBMODULE="uclibc-ng";;
+              submodules="$submodules:uclibc-ng";;
             "newlib")
-              MODE_SUBMODULE="newlib";;
+              submodules="$submodules:newlib";;
             *)
               echo "Invalid Mode"; exit 1;;
           esac
-          echo "MODE_SUBMODULE=$MODE_SUBMODULE" >> $GITHUB_OUTPUT
           case "${{ matrix.compiler }}" in
             "gcc")
-              COMPILER_SUBMODULE="gcc";;
+              submodules="$submodules:gcc";;
             "llvm")
-              COMPILER_SUBMODULE="llvm";;
+              submodules="$submodules:llvm";;
             *)
               echo "Invalid Compiler"; exit 1;;
           esac
-          echo "COMPILER_SUBMODULE=$COMPILER_SUBMODULE" >> $GITHUB_OUTPUT
+          submodules=$(echo $submodules | sed 's/:/\n/g')
+          submodules=$submodules$'\n'$(echo "$submodules" | sed -e 's/^/.git\/modules\//')
+          echo 'submodules<<EOF' >> $GITHUB_OUTPUT
+          echo "$submodules" >> $GITHUB_OUTPUT
+          echo 'EOF' >> $GITHUB_OUTPUT
 
       - uses: actions/checkout@v4
 
-      - name: Load Compiler Submodule from Cache
+      - name: Load Cache
         uses: actions/cache/restore@v4
-        env:
-          submodule: ${{ steps.required-submodules.outputs.COMPILER_SUBMODULE }}
         with:
           path: |
-            .git/modules/${{ env.submodule }}
-            ${{ env.submodule }}
-          key: compiler-${{ matrix.compiler }}
-
-      - name: Load Mode Submodule from Cache
-        uses: actions/cache/restore@v4
-        env:
-          submodule: ${{ steps.required-submodules.outputs.MODE_SUBMODULE }}
-        with:
-          path: |
-            .git/modules/${{ env.submodule }}
-            ${{ env.submodule }}
-          key: mode-${{ matrix.mode }}
-      
-      - name: Load Always Required Submodules from Cache
-        uses: actions/cache/restore@v4
-        with:
-          path: |
-            .git/modules/binutils
-            .git/modules/gdb
-            binutils
-            gdb
-          key: general-dependencies
+            ${{ steps.cache-path.outputs.submodules }}
+          key: ${{ env.cache-key }}
 
       - name: Install Dependencies
         run: sudo ./.github/setup-apt.sh
@@ -218,6 +182,9 @@ jobs:
   test-sim:
     name: Test Simulation
     runs-on: ${{ matrix.os }}
+    needs: [cache]
+    env:
+      cache-key: ${{ needs.cache.outputs.key }}
     strategy:
       matrix:
         os:     [ubuntu-24.04]
@@ -236,6 +203,25 @@ jobs:
 
       - uses: actions/checkout@v4
 
+      - uses: actions/cache/restore@v4
+        with:
+          path: |
+            .git/modules/gcc
+            .git/modules/newlib
+            .git/modules/binutils
+            .git/modules/gdb
+            .git/modules/spike
+            .git/modules/pk
+            .git/modules/dejagnu
+            gcc
+            newlib
+            binutils
+            gdb
+            spike
+            pk
+            dejagnu
+          key: ${{ env.cache-key }}
+
       - name: Install Dependencies
         run: sudo ./.github/setup-apt.sh