benchmark-pr.yml

name: Benchmark-PR (build)

on:
  pull_request:
    branches: [main]

permissions:
  contents: read

concurrency:
  group: benchmark-pr-${{ github.ref }}
  cancel-in-progress: true

jobs:
  bench-linux:
    name: 'linux ${{ matrix.sys.compiler }}-${{ matrix.sys.version }} ${{ matrix.sys.flags }}'
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        sys:
          - { compiler: 'gcc',   version: '12', flags: 'force_no_instr_set' }
          - { compiler: 'gcc',   version: '14', flags: 'avx'                }
          - { compiler: 'gcc',   version: '13', flags: 'avx512'             }
          - { compiler: 'gcc',   version: '13', flags: 'avx512pf'           }
          - { compiler: 'gcc',   version: '13', flags: 'avx512vbmi'         }
          - { compiler: 'gcc',   version: '14', flags: 'avx512vbmi2'        }
          - { compiler: 'gcc',   version: '13', flags: 'avx512vnni'         }
          - { compiler: 'clang', version: '17', flags: 'sse3'               }
          - { compiler: 'clang', version: '17', flags: 'avx'                }

    defaults:
      run:
        shell: bash -l {0}

    steps:
      - name: Setup GCC compiler
        if: ${{ matrix.sys.compiler == 'gcc' }}
        run: |
          GCC_VERSION=${{ matrix.sys.version }}
          sudo apt-get update
          sudo apt-get --no-install-suggests --no-install-recommends install g++-$GCC_VERSION gcc-$GCC_VERSION
          echo "CC=gcc-$GCC_VERSION"   >> $GITHUB_ENV
          echo "CXX=g++-$GCC_VERSION"  >> $GITHUB_ENV

      - name: Setup Clang compiler
        if: ${{ matrix.sys.compiler == 'clang' }}
        run: |
          LLVM_VERSION=${{ matrix.sys.version }}
          sudo apt-get update
          sudo apt-get --no-install-suggests --no-install-recommends install clang-$LLVM_VERSION g++
          sudo ln -sf /usr/include/asm-generic /usr/include/asm
          echo "CC=clang-$LLVM_VERSION"    >> $GITHUB_ENV
          echo "CXX=clang++-$LLVM_VERSION" >> $GITHUB_ENV

      - uses: actions/checkout@v4

      - name: Set conda environment
        uses: mamba-org/setup-micromamba@main
        with:
          environment-name: myenv
          environment-file: environment-dev.yml
          init-shell: bash
          cache-downloads: true

      - name: Setup SDE
        if: startsWith(matrix.sys.flags, 'avx512')
        run: sh install_sde.sh

      - name: Configure CMake
        env:
          CC:  ${{ env.CC }}
          CXX: ${{ env.CXX }}
        run: |
          CMAKE_EXTRA_ARGS=""
          if [[ '${{ matrix.sys.flags }}' == 'avx'         ]]; then CMAKE_EXTRA_ARGS="-DTARGET_ARCH=sandybridge";    fi
          if [[ '${{ matrix.sys.flags }}' == 'sse3'        ]]; then CMAKE_EXTRA_ARGS="-DTARGET_ARCH=nocona";         fi
          if [[ '${{ matrix.sys.flags }}' == 'avx512'      ]]; then CMAKE_EXTRA_ARGS="-DTARGET_ARCH=skylake-avx512"; fi
          if [[ '${{ matrix.sys.flags }}' == 'avx512pf'    ]]; then CMAKE_EXTRA_ARGS="-DTARGET_ARCH=knl";            fi
          if [[ '${{ matrix.sys.flags }}' == 'avx512vbmi'  ]]; then CMAKE_EXTRA_ARGS="-DTARGET_ARCH=cannonlake";     fi
          if [[ '${{ matrix.sys.flags }}' == 'avx512vbmi2' ]]; then CMAKE_EXTRA_ARGS="-DTARGET_ARCH=icelake-server"; fi
          if [[ '${{ matrix.sys.flags }}' == 'avx512vnni'  ]]; then CMAKE_EXTRA_ARGS="-DTARGET_ARCH=knm";            fi
          cmake -S . -B _bench_build \
            -G Ninja \
            -DCMAKE_BUILD_TYPE=Release \
            -DCMAKE_C_COMPILER=$CC \
            -DCMAKE_CXX_COMPILER=$CXX \
            $CMAKE_EXTRA_ARGS \
            -DBUILD_BENCHMARKS=ON

      - name: Build
        run: ninja -C _bench_build bench_algorithms

      - name: Run benchmarks
        run: |
          if echo '${{ matrix.sys.flags }}' | grep -q 'avx512'; then
            ./sde-external-9.48.0-2024-11-25-lin/sde64 -tgl -- \
              ./_bench_build/benchmark/bench_algorithms \
              --benchmark_format=json --benchmark_out=benchmark-result.json
          else
            ./_bench_build/benchmark/bench_algorithms \
              --benchmark_format=json --benchmark_out=benchmark-result.json
          fi

      - name: Upload benchmark artifact
        uses: actions/upload-artifact@v4
        with:
          name: bench-linux-${{ matrix.sys.compiler }}-${{ matrix.sys.version }}-${{ matrix.sys.flags }}
          path: benchmark-result.json
          if-no-files-found: error

  bench-macos:
    name: 'macos-${{ matrix.os }}'
    runs-on: macos-${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [14, 15]

    defaults:
      run:
        shell: bash -e -l {0}

    steps:
      - uses: actions/checkout@v4

      - name: Set conda environment
        uses: mamba-org/setup-micromamba@main
        with:
          environment-name: myenv
          environment-file: environment-dev.yml
          init-shell: bash
          cache-downloads: true

      - name: Configure CMake
        run: |
          cmake -S . -B _bench_build \
            -DCMAKE_BUILD_TYPE=Release \
            -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX \
            -DBUILD_BENCHMARKS=ON

      - name: Build
        run: cmake --build _bench_build --target bench_algorithms --parallel 8

      - name: Run benchmarks
        run: |
          ./_bench_build/benchmark/bench_algorithms \
            --benchmark_format=json --benchmark_out=benchmark-result.json

      - name: Upload benchmark artifact
        uses: actions/upload-artifact@v4
        with:
          name: bench-macos-${{ matrix.os }}
          path: benchmark-result.json
          if-no-files-found: error