Add benchmarks workflow #6
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # ------------------------------------------------------------------------------ | |
| # Copyright Matt Borland 2026. | |
| # Distributed under the Boost Software License, | |
| # Version 1.0. (See accompanying file LICENSE_1_0.txt | |
| # or copy at http://www.boost.org/LICENSE_1_0.txt) | |
| # ------------------------------------------------------------------------------ | |
| # | |
| # Runs the Boost.SafeNumbers Google Benchmark suites (test/benchmarks/*.cpp) in | |
| # release mode across a spread of native runners. The benchmarks are built via | |
| # CMake with -DBOOST_SAFE_NUMBERS_BUILD_BENCHMARKS=ON, which pulls Google | |
| # Benchmark in with FetchContent. Each job emits per-suite JSON and a ready to | |
| # paste AsciiDoc section (produced by test/benchmarks/render_results.py) as | |
| # artifacts for the documentation benchmarks page. | |
| name: Run Benchmarks | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - develop | |
| - feature/** | |
| pull_request: | |
| types: [opened, synchronize, reopened] | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ format('{0}:{1}:benchmarks', github.repository, github.ref) }} | |
| cancel-in-progress: true | |
| env: | |
| GIT_FETCH_JOBS: 8 | |
| # Repetitions plus the median aggregate keep the reported numbers stable; the | |
| # report-aggregates-only flag keeps the JSON small. | |
| BENCH_ARGS: "--benchmark_repetitions=5 --benchmark_min_time=0.10s --benchmark_report_aggregates_only=true --benchmark_out_format=json" | |
| jobs: | |
| linux: | |
| name: ${{ matrix.title }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - title: Linux x64 | |
| os: ubuntu-latest | |
| arch: x64 | |
| anchor: linux_x64 | |
| desc: "Run on the GitHub Actions `ubuntu-latest` runner using GCC 14 in release mode (`-O2`, pass:[C++]20)." | |
| multilib: false | |
| cmake_extra: "" | |
| - title: Linux x86 (32-bit) | |
| os: ubuntu-latest | |
| arch: x86-32 | |
| anchor: linux_x86_32 | |
| desc: "Run on the GitHub Actions `ubuntu-latest` runner using GCC 14 targeting 32-bit x86 (`-m32`) in release mode (`-O2`, pass:[C++]20)." | |
| multilib: true | |
| cmake_extra: "-DCMAKE_CXX_FLAGS=-m32 -DCMAKE_C_FLAGS=-m32" | |
| - title: Linux ARM64 | |
| os: ubuntu-24.04-arm | |
| arch: arm64 | |
| anchor: linux_arm64 | |
| desc: "Run on the GitHub Actions `ubuntu-24.04-arm` runner using GCC 14 in release mode (`-O2`, pass:[C++]20)." | |
| multilib: false | |
| cmake_extra: "" | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Install packages | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y g++-14 cmake | |
| if [ "${{ matrix.multilib }}" = "true" ]; then | |
| sudo apt-get install -y g++-14-multilib | |
| fi | |
| - name: Setup Boost | |
| run: | | |
| LIBRARY=${GITHUB_REPOSITORY#*/} | |
| echo "LIBRARY=$LIBRARY" >> $GITHUB_ENV | |
| REF=${GITHUB_BASE_REF:-$GITHUB_REF} | |
| REF=${REF#refs/heads/} | |
| BOOST_BRANCH=develop && [ "$REF" = "master" ] && BOOST_BRANCH=master || true | |
| cd .. | |
| git clone -b "$BOOST_BRANCH" --depth 1 "https://github.com/boostorg/boost.git" boost-root | |
| cd boost-root | |
| mkdir -p libs/$LIBRARY | |
| # Exclude doc/: it carries an Antora examples symlink (which git-bash on | |
| # Windows cannot recreate) and a large node_modules tree, neither of | |
| # which the benchmark build or depinst need. | |
| shopt -s extglob | |
| cp -r "$GITHUB_WORKSPACE"/!(doc) libs/$LIBRARY/ | |
| git submodule update --init tools/boostdep | |
| python3 tools/boostdep/depinst/depinst.py --git_args "--jobs $GIT_FETCH_JOBS" $LIBRARY | |
| - name: Configure and build benchmarks | |
| run: | | |
| cd ../boost-root | |
| cmake -S . -B __build__ \ | |
| -DCMAKE_BUILD_TYPE=Release \ | |
| -DBUILD_TESTING=OFF \ | |
| -DBOOST_INCLUDE_LIBRARIES="$LIBRARY;safe_numerics;random" \ | |
| -DBOOST_SAFE_NUMBERS_BUILD_BENCHMARKS=ON \ | |
| -DCMAKE_CXX_COMPILER=g++-14 -DCMAKE_C_COMPILER=gcc-14 \ | |
| ${{ matrix.cmake_extra }} | |
| cmake --build __build__ --config Release --parallel 4 \ | |
| --target benchmark_unsigned_operations benchmark_signed_operations benchmark_float_operations | |
| - name: Run benchmarks and render results | |
| run: | | |
| cd ../boost-root | |
| OUT="$GITHUB_WORKSPACE/bench-results" | |
| mkdir -p "$OUT" | |
| find_exe() { find __build__ -type f \( -name "$1" -o -name "$1.exe" \) | head -1; } | |
| "$(find_exe benchmark_unsigned_operations)" $BENCH_ARGS --benchmark_out="$OUT/unsigned.json" | |
| "$(find_exe benchmark_signed_operations)" $BENCH_ARGS --benchmark_out="$OUT/signed.json" | |
| "$(find_exe benchmark_float_operations)" $BENCH_ARGS --benchmark_out="$OUT/float.json" | |
| python3 "$GITHUB_WORKSPACE/test/benchmarks/render_results.py" \ | |
| --title "${{ matrix.title }}" --anchor "${{ matrix.anchor }}" --desc "${{ matrix.desc }}" \ | |
| --unsigned "$OUT/unsigned.json" --signed "$OUT/signed.json" --float "$OUT/float.json" \ | |
| > "$OUT/section.adoc" | |
| echo "==================== ${{ matrix.title }} ====================" | |
| cat "$OUT/section.adoc" | |
| - name: Upload results | |
| if: always() | |
| uses: actions/upload-artifact@v6 | |
| with: | |
| name: benchmarks-linux-${{ matrix.arch }} | |
| path: bench-results | |
| if-no-files-found: warn | |
| macos: | |
| name: macOS ARM64 | |
| runs-on: macos-latest | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Setup Boost | |
| run: | | |
| LIBRARY=${GITHUB_REPOSITORY#*/} | |
| echo "LIBRARY=$LIBRARY" >> $GITHUB_ENV | |
| REF=${GITHUB_BASE_REF:-$GITHUB_REF} | |
| REF=${REF#refs/heads/} | |
| BOOST_BRANCH=develop && [ "$REF" = "master" ] && BOOST_BRANCH=master || true | |
| cd .. | |
| git clone -b "$BOOST_BRANCH" --depth 1 "https://github.com/boostorg/boost.git" boost-root | |
| cd boost-root | |
| mkdir -p libs/$LIBRARY | |
| # Exclude doc/: it carries an Antora examples symlink (which git-bash on | |
| # Windows cannot recreate) and a large node_modules tree, neither of | |
| # which the benchmark build or depinst need. | |
| shopt -s extglob | |
| cp -r "$GITHUB_WORKSPACE"/!(doc) libs/$LIBRARY/ | |
| git submodule update --init tools/boostdep | |
| python3 tools/boostdep/depinst/depinst.py --git_args "--jobs $GIT_FETCH_JOBS" $LIBRARY | |
| - name: Configure and build benchmarks | |
| run: | | |
| cd ../boost-root | |
| cmake -S . -B __build__ \ | |
| -DCMAKE_BUILD_TYPE=Release \ | |
| -DBUILD_TESTING=OFF \ | |
| -DBOOST_INCLUDE_LIBRARIES="$LIBRARY;safe_numerics;random" \ | |
| -DBOOST_SAFE_NUMBERS_BUILD_BENCHMARKS=ON | |
| cmake --build __build__ --config Release --parallel 4 \ | |
| --target benchmark_unsigned_operations benchmark_signed_operations benchmark_float_operations | |
| - name: Run benchmarks and render results | |
| run: | | |
| cd ../boost-root | |
| OUT="$GITHUB_WORKSPACE/bench-results" | |
| mkdir -p "$OUT" | |
| find_exe() { find __build__ -type f \( -name "$1" -o -name "$1.exe" \) | head -1; } | |
| "$(find_exe benchmark_unsigned_operations)" $BENCH_ARGS --benchmark_out="$OUT/unsigned.json" | |
| "$(find_exe benchmark_signed_operations)" $BENCH_ARGS --benchmark_out="$OUT/signed.json" | |
| "$(find_exe benchmark_float_operations)" $BENCH_ARGS --benchmark_out="$OUT/float.json" | |
| python3 "$GITHUB_WORKSPACE/test/benchmarks/render_results.py" \ | |
| --title "macOS ARM64" --anchor "macos_arm64" \ | |
| --desc "Run on the GitHub Actions \`macos-latest\` runner (Apple Silicon) using Apple Clang in release mode (\`-O2\`, pass:[C++]20)." \ | |
| --unsigned "$OUT/unsigned.json" --signed "$OUT/signed.json" --float "$OUT/float.json" \ | |
| > "$OUT/section.adoc" | |
| echo "==================== macOS ARM64 ====================" | |
| cat "$OUT/section.adoc" | |
| - name: Upload results | |
| if: always() | |
| uses: actions/upload-artifact@v6 | |
| with: | |
| name: benchmarks-macos-arm64 | |
| path: bench-results | |
| if-no-files-found: warn | |
| windows: | |
| name: ${{ matrix.title }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - title: Windows x64 | |
| os: windows-latest | |
| arch: x64 | |
| anchor: windows_x64 | |
| cmake_arch: x64 | |
| desc: "Run on the GitHub Actions `windows-latest` runner using MSVC in release mode (`/O2`, pass:[C++]20)." | |
| - title: Windows x86 (32-bit) | |
| os: windows-latest | |
| arch: x86-32 | |
| anchor: windows_x86_32 | |
| cmake_arch: Win32 | |
| desc: "Run on the GitHub Actions `windows-latest` runner using MSVC targeting 32-bit x86 in release mode (`/O2`, pass:[C++]20)." | |
| - title: Windows ARM64 | |
| os: windows-11-arm | |
| arch: arm64 | |
| anchor: windows_arm64 | |
| cmake_arch: ARM64 | |
| desc: "Run on the GitHub Actions `windows-11-arm` runner using MSVC in release mode (`/O2`, pass:[C++]20)." | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Setup Boost | |
| run: | | |
| LIBRARY=${GITHUB_REPOSITORY#*/} | |
| echo "LIBRARY=$LIBRARY" >> $GITHUB_ENV | |
| REF=${GITHUB_BASE_REF:-$GITHUB_REF} | |
| REF=${REF#refs/heads/} | |
| BOOST_BRANCH=develop && [ "$REF" = "master" ] && BOOST_BRANCH=master || true | |
| cd .. | |
| git clone -b "$BOOST_BRANCH" --depth 1 "https://github.com/boostorg/boost.git" boost-root | |
| cd boost-root | |
| mkdir -p libs/$LIBRARY | |
| # Exclude doc/: it carries an Antora examples symlink (which git-bash on | |
| # Windows cannot recreate) and a large node_modules tree, neither of | |
| # which the benchmark build or depinst need. | |
| shopt -s extglob | |
| cp -r "$GITHUB_WORKSPACE"/!(doc) libs/$LIBRARY/ | |
| git submodule update --init tools/boostdep | |
| python tools/boostdep/depinst/depinst.py --git_args "--jobs $GIT_FETCH_JOBS" $LIBRARY | |
| - name: Configure and build benchmarks | |
| run: | | |
| cd ../boost-root | |
| cmake -S . -B __build__ -A ${{ matrix.cmake_arch }} \ | |
| -DBUILD_TESTING=OFF \ | |
| -DBOOST_INCLUDE_LIBRARIES="$LIBRARY;safe_numerics;random" \ | |
| -DBOOST_SAFE_NUMBERS_BUILD_BENCHMARKS=ON | |
| cmake --build __build__ --config Release --parallel 4 \ | |
| --target benchmark_unsigned_operations benchmark_signed_operations benchmark_float_operations | |
| - name: Run benchmarks and render results | |
| run: | | |
| cd ../boost-root | |
| OUT="$GITHUB_WORKSPACE/bench-results" | |
| mkdir -p "$OUT" | |
| find_exe() { find __build__ -type f \( -name "$1" -o -name "$1.exe" \) | head -1; } | |
| "$(find_exe benchmark_unsigned_operations)" $BENCH_ARGS --benchmark_out="$OUT/unsigned.json" | |
| "$(find_exe benchmark_signed_operations)" $BENCH_ARGS --benchmark_out="$OUT/signed.json" | |
| "$(find_exe benchmark_float_operations)" $BENCH_ARGS --benchmark_out="$OUT/float.json" | |
| python "$GITHUB_WORKSPACE/test/benchmarks/render_results.py" \ | |
| --title "${{ matrix.title }}" --anchor "${{ matrix.anchor }}" --desc "${{ matrix.desc }}" \ | |
| --unsigned "$OUT/unsigned.json" --signed "$OUT/signed.json" --float "$OUT/float.json" \ | |
| > "$OUT/section.adoc" | |
| echo "==================== ${{ matrix.title }} ====================" | |
| cat "$OUT/section.adoc" | |
| - name: Upload results | |
| if: always() | |
| uses: actions/upload-artifact@v6 | |
| with: | |
| name: benchmarks-windows-${{ matrix.arch }} | |
| path: bench-results | |
| if-no-files-found: warn |