ci: free space before using docker

Author: phsauter

.github/actions/free-space/action.yml

@@ -0,0 +1,45 @@
+# Copyright (c) 2025 ETH Zurich and University of Bologna.
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+# Author:  Philippe Sauter <phsauter@iis.ee.ethz.ch>
+
+name: 'Free Disk Space on Runner'
+description: 'Frees disk space on GitHub-hosted runners to make room for eg large Docker images'
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Show disk usage before cleanup
+      shell: bash
+      run: |
+        echo "Disk usage before cleanup:"
+        df -h
+
+    - name: Prune Docker data
+      shell: bash
+      run: |
+        # Remove stopped containers, unused networks, dangling images, and build cache
+        docker system prune -af || true
+
+    - name: Remove large preinstalled SDKs and toolchains
+      shell: bash
+      run: |
+        # These paths are known big space hogs on ubuntu-latest runners
+        sudo rm -rf /usr/local/lib/android || true
+        sudo rm -rf /usr/share/dotnet || true
+        sudo rm -rf /opt/ghc || true
+        sudo rm -rf /opt/hostedtoolcache/CodeQL || true
+        sudo rm -rf /opt/hostedtoolcache/go || true
+
+    - name: Clean APT caches
+      shell: bash
+      run: |
+        sudo apt-get clean || true
+        sudo rm -rf /var/lib/apt/lists/* || true
+
+    - name: Show disk usage after cleanup
+      shell: bash
+      run: |
+        echo "Disk usage after cleanup:"
+        df -h

.github/actions/oseda-caching/action.yml

@@ -11,10 +11,6 @@ inputs:
   cmd:
     description: 'Command to run in the OSEDA container'
     required: true
-  image_file_name:
-    description: 'Name of the artifact to download (default: oseda-image)'
-    required: false
-    default: 'oseda-image'
   service_name:
     description: 'Name of the Docker service (default: from ./docker-compose.yml)'
     required: false
@@ -26,50 +22,40 @@ runs:
     - name: Set up Docker environment
       shell: bash
       run: |
-        echo "UID=$(id -u)" >> $GITHUB_ENV
-        echo "GID=$(id -g)" >> $GITHUB_ENV
+        echo "UID=$(id -u)" >> "$GITHUB_ENV"
+        echo "GID=$(id -g)" >> "$GITHUB_ENV"
 
     - name: Get image name from docker-compose
       id: get-image
       shell: bash
       run: |
         IMAGE=$(docker compose config | awk '/image:/{print $2}' | head -n 1)
         if [ -z "$IMAGE" ]; then
-          echo "ERROR: No image found in docker-compose.yml"
+          echo "[ERROR] No image found in docker-compose.yml"
           exit 1
         fi
-        echo "IMAGE_NAME=$IMAGE" >> $GITHUB_ENV
-
-    - name: Download Docker image from cache
-      continue-on-error: true
-      uses: actions/cache/restore@v4
-      with:
-        key: oseda-${{ env.IMAGE_NAME }}
-        path: /tmp/oseda.tar.gz
+        echo "IMAGE_NAME=$IMAGE" >> "$GITHUB_ENV"
 
-    - name: Load or pull Docker image
+    - name: Pull Docker image
       shell: bash
       run: |
-        if [ -f "/tmp/oseda.tar.gz" ]; then
-          docker import /tmp/oseda.tar.gz
-          echo "Loaded image $IMAGE_NAME from artifacts/cache"
-        else
-          docker compose pull
-        fi
+        docker compose pull
 
     - name: Determine service name if not provided
       shell: bash
       run: |
         if [ -z "${{ inputs.service_name }}" ]; then
           SERVICE_NAME=$(docker compose config --services | head -n 1)
-          echo "service_name=$SERVICE_NAME" >> $GITHUB_ENV
+          echo "service_name=$SERVICE_NAME" >> "$GITHUB_ENV"
         else
-          echo "service_name=${{ inputs.service_name }}" >> $GITHUB_ENV
+          echo "service_name=${{ inputs.service_name }}" >> "$GITHUB_ENV"
         fi
 
     - name: Run commands in OSEDA container
       shell: bash
       run: |
-        docker compose up -d
-        docker compose exec ${{ env.service_name }} bash -c "source ~/.bashrc; ${{ inputs.cmd }}" | tee result.log
-        echo "result_log=$(pwd)/result.log" >> $GITHUB_ENV
+        # Avoid extra pulls now that we've already pulled
+        docker compose up -d --pull=never
+        docker compose exec -T "${{ env.service_name }}" \
+          bash -lc "source ~/.bashrc; ${{ inputs.cmd }}" | tee result.log
+        echo "result_log=$(pwd)/result.log" >> "$GITHUB_ENV"

.github/actions/oseda-cmd/action.yml

@@ -29,6 +29,8 @@ jobs:
         uses: actions/checkout@v4
         with:
           submodules: true
+      - name: Free disk space
+        uses: ./.github/actions/free-space
       - name: Get run ID of "Full Flow" workflow
         id: get-run-id
         run: |

.github/workflows/artistic.yml

@@ -26,22 +26,19 @@ jobs:
         uses: actions/checkout@v4
         with:
           submodules: true
-
+      - name: Free disk space
+        uses: ./.github/actions/free-space
       - name: Run Yosys, OpenROAD and KLayout
         uses: ./.github/actions/oseda-cmd
         with:
           cmd: "make yosys && make openroad && make klayout"
-      - name: Upload openroad output
+      - name: Upload openroad outputs
         uses: actions/upload-artifact@v4
         with:
           name: croc-openroad-out
-          path: openroad/out
-        continue-on-error: true
-      - name: Upload openroad reports
-        uses: actions/upload-artifact@v4
-        with:
-          name: croc-openroad-reports
-          path: openroad/reports
+          path: |
+            openroad/out
+            openroad/reports
         continue-on-error: true
       - name: Upload gds
         uses: actions/upload-artifact@v4

.github/workflows/full-flow.yml

@@ -20,7 +20,8 @@ jobs:
         uses: actions/checkout@v4
         with:
           submodules: true
-
+      - name: Free disk space
+        uses: ./.github/actions/free-space
       - name: Run simulation commands in OSEDA
         uses: ./.github/actions/oseda-cmd
         with:
@@ -31,21 +32,17 @@ jobs:
           name: croc-sw
           path: sw/bin
         continue-on-error: true
-      - name: Upload waveform
-        uses: actions/upload-artifact@v4
-        with:
-          name: croc-waveform
-          path: croc.fst
-        continue-on-error: true
-
       - name: Upload simulation output
         uses: actions/upload-artifact@v4
         with:
           name: simulation-output
-          path: ${{ env.result_log }}
+          path: |
+            verilator/croc.fst
+            verilator/croc.log
+        continue-on-error: true
       - name: Check simulation output
         shell: bash
-        run: ./.github/scripts/check_sim.sh ${{ env.result_log }}
+        run: ./.github/scripts/check_sim.sh ./verilator/croc.log
 
   synthesis:
     runs-on: ubuntu-latest
@@ -55,20 +52,18 @@ jobs:
         uses: actions/checkout@v4
         with:
           submodules: true
-
+      - name: Free disk space
+        uses: ./.github/actions/free-space
       - name: Setup OSEDA container
         uses: ./.github/actions/oseda-cmd
         with:
           cmd: "make yosys && tail -n 40 yosys/reports/*area.rpt"
-      - name: Upload synthesis reports
+      - name: Upload synthesis outputs
         uses: actions/upload-artifact@v4
         with:
           name: croc-synth-reports
-          path: yosys/reports
-        continue-on-error: true
-      - name: Upload netlist
-        uses: actions/upload-artifact@v4
-        with:
-          name: croc-netlist
-          path: yosys/out
+          path: |
+            yosys/reports
+            yosys/out
         continue-on-error: true
+

.github/workflows/short-flow.yml

@@ -106,7 +106,7 @@ verilator/obj_dir/Vtb_croc_soc: verilator/croc.f $(SW_HEX)
 
 ## Simulate RTL using Verilator
 verilator: verilator/obj_dir/Vtb_croc_soc
-	cd verilator; obj_dir/Vtb_croc_soc +binary="$(realpath $(SW_HEX))"
+	cd verilator; obj_dir/Vtb_croc_soc +binary="$(realpath $(SW_HEX))" | tee croc.log
 
 .PHONY: verilator vsim vsim-yosys
 

Makefile

@@ -1,3 +1,5 @@
 obj_dir
 croc*.f
 *.vcd
+*.fst
+*.log