[CI][Bench] Refactor bench workflow

lukaszstolarczuk · lukaszstolarczuk · commit 2d0ae0bf5dea · 2025-11-24T20:26:40.000+01:00
diff --git a/.github/workflows/sycl-linux-run-tests.yml b/.github/workflows/sycl-linux-run-tests.yml
@@ -378,5 +378,4 @@ jobs:
         dry_run: ${{ inputs.benchmark_dry_run }}
         exit_on_failure: ${{ inputs.benchmark_exit_on_failure }}
         build_ref: ${{ inputs.repo_ref }}
-      env:
-        RUNNER_TAG: ${{ inputs.runner }}
+        runner: ${{ inputs.runner }}
diff --git a/devops/actions/run-tests/benchmark/action.yml b/devops/actions/run-tests/benchmark/action.yml
@@ -2,16 +2,9 @@ name: 'Run benchmarks'
 
 # This action assumes the following prerequisites:
 #
-# - SYCL is accessible in the system (nightly image provides it within /opt/sycl),
-#   or SYCL is placed in ./toolchain (TODO: change this??). The second option has higher priority.
-# - /devops has been checked out in ./devops.
-# - env.GITHUB_TOKEN was properly set, because according to Github, that's
-#   apparently the recommended way to pass a secret into a github action:
-
-#   https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#accessing-your-secrets
-#
-# - env.RUNNER_TAG set to the runner tag used to run this workflow: Currently,
-#   only specific runners are fully supported.
+# - SYCL is placed in dir pointed by 'inputs.sycl_dir', if not, it has to be accessible
+#   in the system (e.g. nightly image provides it within /opt/sycl, but it might be a little older).
+# - /devops dir has been checked out in ./devops.
 
 inputs:
   target_devices:
@@ -37,59 +30,130 @@ inputs:
   exit_on_failure:
     type: string
     required: False
+  # Path to SYCL installation directory
+  sycl_dir:
+    type: string
+    required: False
+    default: "./toolchain"
+  # Only specific runners are supported
+  runner:
+    type: string
+    required: True
 
 runs:
   # composite actions don't make use of 'name', so copy-paste names as a comment in the first line of each step
   using: "composite"
   steps:
-  - name: Check specified runner type / target backend
+  - name: Check inputs and set up environment
     shell: bash
     env:
+      # inputs are not directly used, as this allows code injection
       TARGET_DEVICE: ${{ inputs.target_devices }}
       PRESET: ${{ inputs.preset }}
+      SYCL_DIR: ${{ inputs.sycl_dir }}
+      RUNNER_TAG: ${{ inputs.runner }}
+      # Will append "_<device>_<backend>" to that prefix, as the save name
+      SAVE_PREFIX: ${{ inputs.save_name }}
     run: |
+      # Check inputs and set up environment
+
+      # Ensure runner name has nothing injected
+      if [ -z "$(printf '%s' "$RUNNER_NAME" | grep -oE '^[a-zA-Z0-9_-]+$')" ]; then
+          echo "Bad runner name, please ensure runner name is [a-zA-Z0-9_-]."
+          exit 1
+      fi
+
       # Check specified runner type / target backend
       case "$RUNNER_TAG" in
-        '["PVC_PERF"]' ) ;;
-        '["BMG_PERF"]' ) ;;
+        '["PVC_PERF"]') MACHINE_TYPE="PVC" ;;
+        '["BMG_PERF"]') MACHINE_TYPE="BMG" ;;
         *)
+          # Best effort at matching if not known runners
+          # TODO: should we drop it and just exit instead?
+          MACHINE_TYPE="${RUNNER_TAG#[\"}"
+          MACHINE_TYPE="${MACHINE_TYPE%_PERF=\"]}"
           echo "#"
           echo "# WARNING: Only specific tuned runners are fully supported."
           echo "# This workflow is not guaranteed to work with other runners."
           echo "#" ;;
       esac
 
-      # Ensure runner name has nothing injected
-      # TODO: in terms of security, is this overkill?
-      if [ -z "$(printf '%s' "$RUNNER_NAME" | grep -oE '^[a-zA-Z0-9_-]+$')" ]; then
-          echo "Bad runner name, please ensure runner name is [a-zA-Z0-9_-]."
-          exit 1
-      fi
-
-      # input.target_devices is not directly used, as this allows code injection
       case "$TARGET_DEVICE" in
-        level_zero:*) ;;
-        level_zero_v2:*) ;;
+        level_zero:*) SAVE_SUFFIX="L0" ;;
+        level_zero_v2:*)
+          SAVE_SUFFIX="L0v2"
+          ONEAPI_DEVICE_SELECTOR="level_zero:gpu"
+          export SYCL_UR_USE_LEVEL_ZERO_V2=1
+          echo "SYCL_UR_USE_LEVEL_ZERO_V2=$SYCL_UR_USE_LEVEL_ZERO_V2" >> $GITHUB_ENV
+          ;;
+        opencl:*) SAVE_SUFFIX="OCL" ;;
         *)
+          SAVE_SUFFIX="${TARGET_DEVICE%%:*}"
           echo "#"
           echo "# WARNING: Only level_zero backend is fully supported."
           echo "# This workflow is not guaranteed to work with other backends."
           echo "#" ;;
       esac
-      echo "ONEAPI_DEVICE_SELECTOR=$TARGET_DEVICE" >> $GITHUB_ENV 
+
+      # Export variables with machine type, save name, device selector, etc.
+      export ONEAPI_DEVICE_SELECTOR=$TARGET_DEVICE
+      echo "ONEAPI_DEVICE_SELECTOR=$ONEAPI_DEVICE_SELECTOR" >> $GITHUB_ENV
+      export SAVE_SUFFIX=$SAVE_SUFFIX
+      echo "SAVE_SUFFIX=$SAVE_SUFFIX" >> $GITHUB_ENV
+      export MACHINE_TYPE=$MACHINE_TYPE
+      echo "MACHINE_TYPE=$MACHINE_TYPE" >> $GITHUB_ENV
+
+      export SAVE_NAME="${SAVE_PREFIX}_${MACHINE_TYPE}_${SAVE_SUFFIX}"
+      echo "SAVE_NAME=$SAVE_NAME" >> $GITHUB_ENV
+      export SAVE_TIMESTAMP="$(date -u +'%Y%m%d_%H%M%S')"  # Timestamps are in UTC time
+      echo "SAVE_TIMESTAMP=$SAVE_TIMESTAMP" >> $GITHUB_ENV
+
+      # By default, the benchmark scripts forceload level_zero
+      FORCELOAD_ADAPTER="${ONEAPI_DEVICE_SELECTOR%%:*}"
+      echo "Adapter: $FORCELOAD_ADAPTER"
+      echo "FORCELOAD_ADAPTER=$FORCELOAD_ADAPTER" >> $GITHUB_ENV
 
       # Make sure specified preset is a known value and is not malicious
       python3 ./devops/scripts/benchmarks/presets.py query "$PRESET"
       [ "$?" -ne 0 ] && exit 1  # Stop workflow if invalid preset
       echo "PRESET=$PRESET" >> $GITHUB_ENV
+
+      # Check if SYCL dir exists and has SYCL lib; set CMPLR_ROOT if so
+      if [ -d "$SYCL_DIR" ] && [ -f "$SYCL_DIR/lib/libsycl.so" ]; then
+        echo "Using SYCL from: $SYCL_DIR"
+        export CMPLR_ROOT=$SYCL_DIR
+        echo "CMPLR_ROOT=$CMPLR_ROOT" >> $GITHUB_ENV
+      else
+        echo "WARNING: SYCL directory '$SYCL_DIR' does not exist or is missing libsycl.so"
+        echo "Checking if SYCL is installed in the system..."
+        which sycl-ls
+        sycl-ls
+        export CMPLR_ROOT="$(dirname $(which sycl-ls))"
+        echo "Using SYCL from: $CMPLR_ROOT"
+        echo "CMPLR_ROOT=$CMPLR_ROOT" >> $GITHUB_ENV
+      fi
   - name: Set NUMA node to run benchmarks on
     shell: bash
     run: |
       # Set CPU and GPU affinity for the first NUMA node; second node is used by UMF
       NUMA_NODE=0
       echo "ZE_AFFINITY_MASK=$NUMA_NODE" >> $GITHUB_ENV
       echo "NUMA_NODE=$NUMA_NODE" >> $GITHUB_ENV
+  - name: Set env var for results branch
+    shell: bash
+    run: |
+      # Set env var for results branch
 
+      # Set BENCHMARK_RESULTS_BRANCH globally for all subsequent steps.
+      # This has to be done this way because of limits of composite actions.
+      BENCHMARK_RESULTS_BRANCH="sycl-benchmark-ci-results"
+      echo "BENCHMARK_RESULTS_BRANCH=$BENCHMARK_RESULTS_BRANCH" >> $GITHUB_ENV
+  - name: Checkout results repo
+    uses: actions/checkout@v5
+    with:
+      ref: ${{ env.BENCHMARK_RESULTS_BRANCH }}
+      path: ./llvm-ci-perf-results
+      persist-credentials: true
   # Compute-benchmarks relies on UR static libraries, cmake config files, etc.
   # DPC++ doesn't ship with these files. The easiest way of obtaining these
   # files is to build from scratch.
@@ -102,10 +166,10 @@ runs:
   # modified output the entire sycl build dir as an artifact, in which the
   # intermediate files required can be stitched together from the build files.
   # However, this is not exactly "clean" or "fun to maintain"...
-  - name: Build Unified Runtime
+  - name: Clone and build Unified Runtime
     shell: bash
     run: |
-      # Build Unified Runtime
+      # Clone and build Unified Runtime
       echo "::group::checkout_llvm_ur"
 
       # Sparse-checkout UR at build ref:
@@ -137,13 +201,27 @@ runs:
       cd -
 
       echo "::endgroup::"
-  # Linux tools installed during docker creation may not match the self-hosted
-  # kernel version, so we need to install the correct version here.
-  - name: Install perf in version matching the host kernel
+  - name: Install dependencies
     shell: bash
+    env:
+      RUNNER_TAG: ${{ inputs.runner }}
     run: |
-      # Install perf in version matching the host kernel
-      echo "::group::install_linux_tools"
+      # Install dependencies
+
+      echo "::group::use_compute_runtime_tag_cache"
+
+      # Cache the compute_runtime version from dependencies.json, but perform a
+      # check with L0 version before using it: This value is not guaranteed to
+      # accurately reflect the current compute_runtime version used, as the
+      # docker images are built nightly.
+      export COMPUTE_RUNTIME_TAG_CACHE="$(cat ./devops/dependencies.json | jq -r .linux.compute_runtime.github_tag)"
+
+      echo "::endgroup::"
+      echo "::group::install_perf"
+
+      # Install perf in version matching the host kernel.
+      # Linux tools installed during docker creation may not match the self-hosted
+      # kernel version, so we need to install the correct version here.
       if [ "$RUNNER_TAG" = '["BMG_PERF"]' ]; then
         echo "Adding repositories for Ubuntu 25.10 (Questing) on BMG_PERF runner"
         echo "deb http://archive.ubuntu.com/ubuntu/ questing main restricted universe multiverse" | sudo tee /etc/apt/sources.list.d/questing.list
@@ -152,30 +230,10 @@ runs:
       fi
       sudo apt-get update
       sudo apt-get install -y linux-tools-$(uname -r)
-      echo "::endgroup::"
-  - name: Set env var for results branch
-    shell: bash
-    run: |
-        # Set env var for results branch
-        # Set BENCHMARK_RESULTS_BRANCH globally for all subsequent steps.
-        # This has to be done this way because of limits of composite actions.
-        BENCHMARK_RESULTS_BRANCH="sycl-benchmark-ci-results"
-        echo "BENCHMARK_RESULTS_BRANCH=$BENCHMARK_RESULTS_BRANCH" >> $GITHUB_ENV
-  - name: Checkout results repo
-    uses: actions/checkout@v5
-    with:
-      ref: ${{ env.BENCHMARK_RESULTS_BRANCH }}
-      path: llvm-ci-perf-results
-  - name: Build and run benchmarks
-    env:
-      # Need to append "_<device>_<backend>" to save name in order to follow
-      # conventions:
-      SAVE_PREFIX: ${{ inputs.save_name }}
-    shell: bash
-    run: |
-      # Build and run benchmarks
 
+      echo "::endgroup::"
       echo "::group::install_python_deps"
+
       echo "Installing python dependencies..."
       # Using --break-system-packages because:
       # - venv is not installed
@@ -186,58 +244,30 @@ runs:
       pip install --user --break-system-packages -r ./devops/scripts/benchmarks/requirements.txt
 
       echo "::endgroup::"
-      echo "::group::establish_parameters_and_vars"
-
-      export CMPLR_ROOT=./toolchain
-      # By default, the benchmark scripts forceload level_zero
-      FORCELOAD_ADAPTER="${ONEAPI_DEVICE_SELECTOR%%:*}"
-      echo "Adapter: $FORCELOAD_ADAPTER"
-
-      case "$ONEAPI_DEVICE_SELECTOR" in
-        level_zero:*) SAVE_SUFFIX="L0" ;;
-        level_zero_v2:*)
-          SAVE_SUFFIX="L0v2"
-          export ONEAPI_DEVICE_SELECTOR="level_zero:gpu"  # "level_zero_v2:gpu" not supported anymore
-          export SYCL_UR_USE_LEVEL_ZERO_V2=1
-          ;;
-        opencl:*) SAVE_SUFFIX="OCL" ;;
-        *) SAVE_SUFFIX="${ONEAPI_DEVICE_SELECTOR%%:*}";;
-      esac
-      case "$RUNNER_TAG" in
-        '["PVC_PERF"]') MACHINE_TYPE="PVC" ;;
-        '["BMG_PERF"]') MACHINE_TYPE="BMG" ;;
-        # Best effort at matching
-        *)
-          MACHINE_TYPE="${RUNNER_TAG#[\"}"
-          MACHINE_TYPE="${MACHINE_TYPE%_PERF=\"]}"
-          ;;
-      esac
-      SAVE_NAME="${SAVE_PREFIX}_${MACHINE_TYPE}_${SAVE_SUFFIX}"
-      echo "SAVE_NAME=$SAVE_NAME" >> $GITHUB_ENV
-      SAVE_TIMESTAMP="$(date -u +'%Y%m%d_%H%M%S')"  # Timestamps are in UTC time
- 
-      # Cache the compute_runtime version from dependencies.json, but perform a
-      # check with L0 version before using it: This value is not guaranteed to
-      # accurately reflect the current compute_runtime version used, as the
-      # docker images are built nightly. 
-      export COMPUTE_RUNTIME_TAG_CACHE="$(cat ./devops/dependencies.json | jq -r .linux.compute_runtime.github_tag)"
-
-      echo "::endgroup::"
-      echo "::group::sycl_ls"
+  - name: Run sycl-ls
+    shell: bash
+    run: |
+      # Run sycl-ls
       sycl-ls --verbose
-      echo "::endgroup::"
-      echo "::group::run_benchmarks"
+  - name: Build and run benchmarks
+    shell: bash
+    run: |
+      # Build and run benchmarks
 
+      echo "::group::setup_workdir"
       WORKDIR="$(realpath ./llvm_test_workdir)"
       if [ -n "$WORKDIR" ] && [ -d "$WORKDIR" ] && [[ "$WORKDIR" == *llvm_test_workdir* ]]; then rm -rf "$WORKDIR" ; fi
 
       # Clean up potentially existing, old summary files
       [ -f "github_summary_exe.md" ] && rm github_summary_exe.md
       [ -f "github_summary_reg.md" ] && rm github_summary_reg.md
 
+      echo "::endgroup::"
+      echo "::group::run_benchmarks"
+
       numactl --cpunodebind "$NUMA_NODE" --membind "$NUMA_NODE" \
       ./devops/scripts/benchmarks/main.py "$WORKDIR" \
-        --sycl "$(realpath ./toolchain)" \
+        --sycl "$(realpath $CMPLR_ROOT)" \
         --ur "$(realpath ./ur/install)" \
         --adapter "$FORCELOAD_ADAPTER" \
         --save "$SAVE_NAME" \
@@ -253,6 +283,7 @@ runs:
 
       echo "::endgroup::"
       echo "::group::compare_results"
+
       python3 ./devops/scripts/benchmarks/compare.py to_hist \
         --avg-type EWMA \
         --cutoff "$(date -u -d '7 days ago' +'%Y%m%d_%H%M%S')" \
@@ -289,7 +320,7 @@ runs:
         cp "$diff" "../cached_changes/$diff"
       done
   - name: Push benchmarks results
-    if: inputs.upload_results == 'true' && always()
+    if: always() && inputs.upload_results == 'true'
     shell: bash
     run: |
       # Push benchmarks results
