From fc0a82bd10abdbcc5635309db85dc5776bd5f5b3 Mon Sep 17 00:00:00 2001 From: Micha Reiser Date: Thu, 25 Jul 2024 12:56:46 +0200 Subject: [PATCH 1/2] Add benchmark for query with many tracked structs --- Cargo.toml | 8 ++++++- benches/incremental.rs | 54 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 benches/incremental.rs diff --git a/Cargo.toml b/Cargo.toml index 09e1f3d3..c6a369cf 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -24,6 +24,7 @@ smallvec = "1.0.0" [dev-dependencies] annotate-snippets = "0.11.4" +criterion = "0.5.1" derive-new = "0.5.9" expect-test = "1.4.0" eyre = "0.6.8" @@ -33,5 +34,10 @@ rustversion = "1.0" test-log = "0.2.11" trybuild = "1.0" + +[[bench]] +name = "incremental" +harness = false + [workspace] -members = [ "components/salsa-macro-rules","components/salsa-macros"] +members = ["components/salsa-macro-rules", "components/salsa-macros"] diff --git a/benches/incremental.rs b/benches/incremental.rs new file mode 100644 index 00000000..a73efea2 --- /dev/null +++ b/benches/incremental.rs @@ -0,0 +1,54 @@ +use criterion::{criterion_group, criterion_main, BatchSize, Criterion}; +use salsa::Setter; + +#[salsa::input] +struct Input { + field: usize, +} + +#[salsa::tracked] +struct Tracked<'db> { + number: usize, +} + +#[salsa::tracked(return_ref)] +fn index<'db>(db: &'db dyn salsa::Database, input: Input) -> Vec> { + (0..input.field(db)).map(|i| Tracked::new(db, i)).collect() +} + +#[salsa::tracked] +fn root(db: &dyn salsa::Database, input: Input) -> usize { + let index = index(db, input); + index.len() +} + +fn many_tracked_structs(criterion: &mut Criterion) { + criterion.bench_function("many_tracked_structs", |b| { + b.iter_batched_ref( + || { + let db = salsa::default_database(); + + let input = Input::new(&db, 1_000); + let input2 = Input::new(&db, 1); + + // prewarm cache + let _ = root(&db, input); + let _ = root(&db, input2); + + (db, input, input2) + }, + |(db, input, input2)| { + // Make a change, but fetch the result for the other input + input2.set_field(db).to(2); + + let result = root(db, *input); + + assert_eq!(result, 1_000); + }, + BatchSize::LargeInput, + ); + }); +} + +criterion_group!(benches, many_tracked_structs); +criterion_main!(benches); From d18d8008e92e96c18915b1f97e048dfdead7dd9a Mon Sep 17 00:00:00 2001 From: Micha Reiser Date: Fri, 26 Jul 2024 11:55:14 +0200 Subject: [PATCH 2/2] Add codspeed --- .github/workflows/test.yml | 40 ++++++++++++++++++++++++++++++++++++++ Cargo.toml | 2 +- benches/incremental.rs | 2 +- 3 files changed, 42 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 80bfbbbd..723f8b68 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -89,3 +89,43 @@ jobs: - name: Run examples with Miri run: | cargo miri run --example calc + + benchmarks: + name: Benchmarks + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Rust toolchain + uses: dtolnay/rust-toolchain@master + id: rust-toolchain + with: + toolchain: stable + + - name: "Setup codspeed" + uses: taiki-e/install-action@v2 + with: + tool: cargo-codspeed + + - uses: actions/cache@v4 + with: + path: | + ~/.cargo/bin/ + ~/.cargo/registry/index/ + ~/.cargo/registry/cache/ + ~/.cargo/git/db/ + target/ + key: ${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}-${{ hashFiles('**/Cargo.toml') }} + restore-keys: | + ${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}- + ${{ runner.os }}-cargo- + + - name: "Build benchmarks" + run: cargo codspeed build + + - name: "Run benchmarks" + uses: CodSpeedHQ/action@v2 + with: + run: cargo codspeed run + token: ${{ secrets.CODSPEED_TOKEN }} diff --git a/Cargo.toml b/Cargo.toml index c6a369cf..395d0098 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -24,7 +24,7 @@ smallvec = "1.0.0" [dev-dependencies] annotate-snippets = "0.11.4" -criterion = "0.5.1" +codspeed-criterion-compat = { version = "2.6.0", default-features = false } derive-new = "0.5.9" expect-test = "1.4.0" eyre = "0.6.8" diff --git a/benches/incremental.rs b/benches/incremental.rs index a73efea2..101e6d01 100644 --- a/benches/incremental.rs +++ b/benches/incremental.rs @@ -1,4 +1,4 @@ -use criterion::{criterion_group, criterion_main, BatchSize, Criterion}; +use codspeed_criterion_compat::{criterion_group, criterion_main, BatchSize, Criterion}; use salsa::Setter; #[salsa::input]