Skip to content

Commit

Permalink
Merge pull request #525 from cryspen/keks/towards-merge-queue-and-ben…
Browse files Browse the repository at this point in the history
…ch-graphs

Rework Actions to work well with Merge Queues and Enable Benchmarks in there
  • Loading branch information
keks authored Aug 27, 2024
2 parents 4873df7 + 6108ada commit 094f5e4
Show file tree
Hide file tree
Showing 28 changed files with 342 additions and 262 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/c-bench.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Benchmark C

on:
workflow_dispatch:
merge_group:

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

jobs:
benchmark:
strategy:
fail-fast: false
matrix:
os:
- macos-latest
- ubuntu-latest
# - windows-latest # currently runs forever, needs to be investigated before adding again!

runs-on: ${{ matrix.os }}
defaults:
run:
shell: bash

steps:
- uses: actions/checkout@v4

- name: 🔨 Build libcrux-ml-kem/c
working-directory: libcrux-ml-kem/c
run: |
cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release
# FIXME: Benchmarks on Windows CI are not working right now.
# - name: 🏃🏻‍♀️ Benchmark
# working-directory: libcrux-ml-kem/c
# run: ./build/Release/ml_kem_bench
# if: ${{ matrix.os == 'windows-latest' }}

- name: 🏃🏻‍♀️ Benchmark (libcrux-ml-kem/c)
working-directory: libcrux-ml-kem/c
run: ./build/ml_kem_bench
if: ${{ matrix.os != 'windows-latest' && (github.event_name == 'merge_group' || github.event_name == 'workflow_dispatch') }}

- name: 🔨 Build libcrux-ml-kem/cg
working-directory: libcrux-ml-kem/cg
run: |
cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release
- name: 🏃🏻‍♀️ Benchmark libcrux-ml-kem/cg
working-directory: libcrux-ml-kem/cg
run: ./build/ml_kem_bench
if: ${{ matrix.os != 'windows-latest' && (github.event_name == 'merge_group' || github.event_name == 'workflow_dispatch') }}
53 changes: 0 additions & 53 deletions .github/workflows/c.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ concurrency:

jobs:
extract:
if: ${{ github.event_name != 'merge_group' }}
runs-on: ubuntu-latest
container: franziskus/libcrux-c:latest
defaults:
Expand All @@ -36,7 +35,6 @@ jobs:
if-no-files-found: error

extract-header-only:
if: ${{ github.event_name != 'merge_group' }}
runs-on: ubuntu-latest
container: franziskus/libcrux-c:latest
defaults:
Expand All @@ -59,7 +57,6 @@ jobs:

diff:
needs: [extract]
if: ${{ github.event_name != 'merge_group' }}
runs-on: ubuntu-latest
defaults:
run:
Expand All @@ -80,7 +77,6 @@ jobs:
diff-header-only:
needs: [extract-header-only]
if: ${{ github.event_name != 'merge_group' }}
runs-on: ubuntu-latest
defaults:
run:
Expand All @@ -101,7 +97,6 @@ jobs:
build:
needs: [extract]
if: ${{ github.event_name != 'merge_group' }}
strategy:
fail-fast: false
matrix:
Expand Down Expand Up @@ -141,7 +136,6 @@ jobs:

build-header-only:
needs: [extract-header-only]
if: ${{ github.event_name != 'merge_group' }}
strategy:
fail-fast: false
matrix:
Expand Down Expand Up @@ -174,50 +168,3 @@ jobs:
- name: 🏃🏻‍♀️ Test
run: ./build/ml_kem_test
if: ${{ matrix.os != 'windows-latest' }}

benchmark:
if: ${{ github.event_name == 'merge_group' || github.event_name == 'workflow_dispatch' }}
strategy:
fail-fast: false
matrix:
os:
- macos-latest
- ubuntu-latest
- windows-latest

runs-on: ${{ matrix.os }}
defaults:
run:
shell: bash
working-directory: libcrux-ml-kem/c

steps:
- uses: actions/checkout@v4

- name: 🔨 Build Release
run: |
cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release
# FIXME: Benchmarks on Windows CI are not working right now.
# - name: 🏃🏻‍♀️ Benchmark
# run: ./build/Release/ml_kem_bench
# if: ${{ matrix.os == 'windows-latest' }}

- name: 🏃🏻‍♀️ Benchmark (c)
run: ./build/ml_kem_bench
if: ${{ matrix.os != 'windows-latest' && (github.event_name == 'merge_group' || github.event_name == 'workflow_dispatch') }}

- name: 🏃🏻‍♀️ Benchmark (cg)
working-directory: libcrux-ml-kem/cg
run: ./build/ml_kem_bench
if: ${{ matrix.os != 'windows-latest' && (github.event_name == 'merge_group' || github.event_name == 'workflow_dispatch') }}

mq_status:
if: |
always() &&
(github.event_name == 'workflow_dispatch' || github.event_name == 'merge_group')
needs: [benchmark]
uses: cryspen/actions/.github/workflows/merge-queue-status.yml@jonas/merge-queue-status
with:
needs_json: "${{toJSON(needs)}}"
1 change: 1 addition & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
pull_request:
branches: ["main", "dev"]
workflow_dispatch:
merge_group:

env:
CARGO_TERM_COLOR: always
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/ecdh.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
pull_request:
branches: ["main", "dev", "*"]
workflow_dispatch:
merge_group:

env:
CARGO_TERM_COLOR: always
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/hax.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
- cron: "0 0 * * *"

workflow_dispatch:
merge_group:

env:
CARGO_TERM_COLOR: always
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/kem.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
pull_request:
branches: ["main", "dev", "*"]
workflow_dispatch:
merge_group:

env:
CARGO_TERM_COLOR: always
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/mldsa.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
pull_request:
branches: ["main", "dev", "*"]
workflow_dispatch:
merge_group:

env:
CARGO_TERM_COLOR: always
Expand Down
105 changes: 105 additions & 0 deletions .github/workflows/mlkem-bench.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
name: Benchmark ML-KEM

on:
workflow_dispatch:
merge_group:

env:
CARGO_TERM_COLOR: always

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

jobs:
benchmark:
strategy:
fail-fast: true
matrix:
bits: [32, 64]
os:
- macos-13
- macos-latest
- ubuntu-latest
- windows-latest
exclude:
# There's no such thing as 32-bit macOS
- bits: 32
os: "macos-latest"
- bits: 32
os: "macos-13"

runs-on: ${{ matrix.os }}
defaults:
run:
shell: bash
working-directory: libcrux-ml-kem

steps:
- uses: actions/checkout@v4

- name: Update dependencies
run: cargo update

- run: echo "RUST_TARGET_FLAG=" > $GITHUB_ENV
if: ${{ matrix.bits == 64 }}

- name: 🛠️ Setup Ubuntu x86
if: ${{ matrix.bits == 32 && matrix.os == 'ubuntu-latest' }}
run: |
rustup target add i686-unknown-linux-gnu
sudo apt-get update
sudo apt-get install -y gcc-multilib g++-multilib
- name: 🛠️ Setup Ubuntu x64
if: ${{ matrix.bits == 64 && matrix.os == 'ubuntu-latest' }}
run: |
rustup target add aarch64-unknown-linux-gnu
- name: 🛠️ Setup macOS
if: ${{ matrix.os == 'macos-latest' }}
run: |
rustup target add aarch64-apple-darwin
# Set up 32 bit systems

- name: 🛠️ Config Windows x86
run: echo "RUST_TARGET_FLAG=--target=i686-pc-windows-msvc" > $GITHUB_ENV
if: ${{ matrix.bits == 32 && matrix.os == 'windows-latest' }}

- name: 🛠️ Config Linux x86
run: |
echo "RUST_TARGET_FLAG=--target=i686-unknown-linux-gnu" > $GITHUB_ENV
if: ${{ matrix.bits == 32 && matrix.os == 'ubuntu-latest' }}

# - name: 🔨 Build
# run: cargo build --benches

# - name: ⬆ Upload build
# uses: ./.github/actions/upload_artifacts
# with:
# name: benchmarks_${{ matrix.os }}_${{ matrix.bits }}

# Benchmarks ...

- name: 🏃🏻‍♀️ Benchmarks
run: cargo bench --verbose $RUST_TARGET_FLAG -- --output-format bencher | tee bench.txt

- name: 🏃🏻‍♀️ Benchmarks Portable
run: |
cargo clean
LIBCRUX_DISABLE_SIMD128=1 LIBCRUX_DISABLE_SIMD256=1 cargo bench --verbose $RUST_TARGET_FLAG -- --output-format bencher | sed 's/^test \(.*\) \.\.\. bench/test portable \1 ... bench/' | tee -a bench.txt
- name: Clear Cargo.lock so it doesn't interfere with git
run: git checkout Cargo.lock
- name: Store benchmarks
uses: benchmark-action/github-action-benchmark@v1
with:
name: ML-KEM Benchmark
tool: 'cargo'
output-file-path: libcrux-ml-kem/bench.txt
benchmark-data-dir-path: dev/bench/mlkem
github-token: ${{ secrets.GITHUB_TOKEN }}
auto-push: true



Loading

0 comments on commit 094f5e4

Please sign in to comment.