dep_benchmarks.yml

# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json

# Reusable workflow to run benchmarks on a single hypervisor/cpu_vendor combination.
#
# Artifact upload:
#   Benchmark results are uploaded as workflow artifacts named
#   benchmarks_<OS>_<hypervisor>_<cpu_vendor>, kept for as long as GitHub
#   allows so that a later run can still be compared against them. A set
#   mshv_kernel joins the hypervisor, as in benchmarks_Linux_mshv3-6.18_amd.
#   Reading them is left to whoever wants a report, so that a comparison
#   covers every configuration at once.

name: Run Benchmarks

on:
  workflow_call:
    inputs:
      docs_only:
        description: Skip building if docs only
        required: false
        type: string
        default: "false"
      hypervisor:
        description: Hypervisor for this run (passed from caller matrix)
        required: true
        type: string
      cpu_vendor:
        description: CPU vendor for the build, amd or intel (passed from caller matrix)
        required: true
        type: string
      arch:
        description: CPU architecture for the build, X64 or arm64 (passed from caller matrix)
        required: true
        type: string
      mshv_kernel:
        description: MSHV kernel of the Azure Linux 3 pool, for example 6.18. Empty selects the default mshv3 pool.
        required: false
        type: string
        default: ""
      baseline_ref:
        description: >-
          Commit to measure these results against. When set, its benchmarks run
          first on this machine, so the comparison reflects the change rather
          than the difference between two runners.
        required: false
        type: string
        default: ""
env:
  CARGO_TERM_COLOR: always
  RUST_BACKTRACE: full

permissions:
  contents: read

defaults:
  run:
    shell: bash

jobs:
  run-benchmarks:
    if: ${{ inputs.docs_only == 'false' }}
    timeout-minutes: ${{ fromJSON(vars.BENCHMARKS_JOB_TIMEOUT || '60') }}
    runs-on: ${{ fromJson(inputs.arch == 'X64'
        && format('["self-hosted", "{0}", "X64", "1ES.Pool=hld-{1}-{2}", "JobId=run-benchmarks-{3}-{4}-{5}"]',
            inputs.hypervisor == 'hyperv-ws2025' && 'Windows' || 'Linux',
            inputs.hypervisor == 'hyperv-ws2025' && 'win2025' || inputs.hypervisor == 'mshv3' && format('azlinux3-mshv{0}', inputs.mshv_kernel != '' && format('-{0}', inputs.mshv_kernel) || '') || inputs.hypervisor,
            inputs.cpu_vendor,
            github.run_id,
            github.run_number,
            github.run_attempt)
        || '["self-hosted", "Linux", "arm64", "kvm"]') }}
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
        with:
          # The baseline pass checks out another commit, which needs its history.
          fetch-depth: ${{ inputs.baseline_ref == '' && 1 || 0 }}

      - uses: hyperlight-dev/ci-setup-workflow@2f4142ba17cf573af44fc1e1f1ffc743daded5b3  # v1.10.0
        with:
          rust-toolchain: "1.94"
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Rust cache
        uses: Swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6  # v2.9.2
        with:
          shared-key: "${{ inputs.arch }}-${{ runner.os }}-${{ inputs.hypervisor }}-release"
          save-if: "false"

      - name: Set up sccache
        uses: ./.github/actions/setup-sccache

      - name: Download Rust guests
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
        with:
          name: rust-guests-${{ inputs.arch }}-release
          path: src/tests/rust_guests/bin/release/

      - name: Download C guests
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
        with:
          name: c-guests-${{ inputs.arch }}-release
          path: src/tests/c_guests/bin/release/

      - name: Download baseline Rust guests
        if: inputs.baseline_ref != ''
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
        with:
          name: rust-guests-${{ inputs.arch }}-release-baseline
          path: ${{ runner.temp }}/baseline-guests/rust/

      - name: Download baseline C guests
        if: inputs.baseline_ref != ''
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
        with:
          name: c-guests-${{ inputs.arch }}-release-baseline
          path: ${{ runner.temp }}/baseline-guests/c/

      # Both commits are measured on this machine, so the comparison reflects
      # them rather than the difference between two runners. The branch point
      # is read off the merge this run validates, so on anything else there is
      # no second parent and the comparison would measure the wrong commit.
      - name: Build
        run: just build release

      - name: Run benchmarks
        run: |
          if [ -n "${{ inputs.baseline_ref }}" ]; then
            git rev-parse --verify --quiet HEAD^2 >/dev/null || {
              echo "::error::HEAD is not a merge, so ${{ inputs.baseline_ref }} is not the branch point"
              exit 1
            }
            just bench-against ${{ inputs.baseline_ref }} "$RUNNER_TEMP/baseline-guests"
          else
            just bench-ci main
          fi

      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
        with:
          name: benchmarks_${{ runner.os }}_${{ inputs.hypervisor }}${{ inputs.mshv_kernel != '' && format('-{0}', inputs.mshv_kernel) || '' }}_${{ inputs.cpu_vendor }}
          path: ./target/criterion/
          if-no-files-found: error
          # The longest GitHub keeps an artifact, so that a run stays readable
          # for as long as the history it contributes to.
          retention-days: 90