Parameterized benchmark group labels with flavor names in note_encryp…

…tion and circuit benchmarks
QED-it · Jul 8, 2024 · b72152a · b72152a
1 parent 80c7574
commit b72152a
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 9 deletions.
diff --git a/benches/circuit.rs b/benches/circuit.rs
@@ -11,13 +11,17 @@ use orchard::{
     circuit::{ProvingKey, VerifyingKey},
     keys::{FullViewingKey, Scope, SpendingKey},
     note::AssetBase,
-    orchard_flavor::{OrchardFlavor, OrchardVanilla, OrchardZSA},
+    orchard_flavor::{OrchardVanilla, OrchardZSA},
     value::NoteValue,
     Anchor, Bundle,
 };
 use rand::rngs::OsRng;
 
-fn criterion_benchmark<FL: OrchardFlavor>(c: &mut Criterion) {
+mod utils;
+
+use utils::OrchardFlavorBench;
+
+fn criterion_benchmark<FL: OrchardFlavorBench>(c: &mut Criterion) {
     let rng = OsRng;
 
     let sk = SpendingKey::from_bytes([7; 32]).unwrap();
@@ -56,7 +60,7 @@ fn criterion_benchmark<FL: OrchardFlavor>(c: &mut Criterion) {
     let recipients_range = 1..=4;
 
     {
-        let mut group = c.benchmark_group("proving");
+        let mut group = FL::benchmark_group(c, "proving");
         group.sample_size(10);
         for num_recipients in recipients_range.clone() {
             let (bundle, instances) = create_bundle(num_recipients);
@@ -72,7 +76,7 @@ fn criterion_benchmark<FL: OrchardFlavor>(c: &mut Criterion) {
     }
 
     {
-        let mut group = c.benchmark_group("verifying");
+        let mut group = FL::benchmark_group(c, "verifying");
         for num_recipients in recipients_range {
             let (bundle, instances) = create_bundle(num_recipients);
             let bundle = bundle

diff --git a/benches/note_decryption.rs b/benches/note_decryption.rs
@@ -5,7 +5,7 @@ use orchard::{
     keys::{FullViewingKey, PreparedIncomingViewingKey, Scope, SpendingKey},
     note::AssetBase,
     note_encryption::{CompactAction, OrchardDomain},
-    orchard_flavor::{OrchardFlavor, OrchardVanilla, OrchardZSA},
+    orchard_flavor::{OrchardVanilla, OrchardZSA},
     value::NoteValue,
     Anchor, Bundle,
 };
@@ -15,7 +15,11 @@ use zcash_note_encryption_zsa::{batch, try_compact_note_decryption, try_note_dec
 #[cfg(unix)]
 use pprof::criterion::{Output, PProfProfiler};
 
-fn bench_note_decryption<FL: OrchardFlavor>(c: &mut Criterion) {
+mod utils;
+
+use utils::OrchardFlavorBench;
+
+fn bench_note_decryption<FL: OrchardFlavorBench>(c: &mut Criterion) {
     let rng = OsRng;
     let pk = ProvingKey::build::<FL>();
 
@@ -82,7 +86,7 @@ fn bench_note_decryption<FL: OrchardFlavor>(c: &mut Criterion) {
     let domain = OrchardDomain::for_action(action);
 
     let compact = {
-        let mut group = c.benchmark_group("note-decryption");
+        let mut group = FL::benchmark_group(c, "note-decryption");
         group.throughput(Throughput::Elements(1));
 
         group.bench_function("valid", |b| {
@@ -104,7 +108,7 @@ fn bench_note_decryption<FL: OrchardFlavor>(c: &mut Criterion) {
     };
 
     {
-        let mut group = c.benchmark_group("compact-note-decryption");
+        let mut group = FL::benchmark_group(c, "compact-note-decryption");
         group.throughput(Throughput::Elements(invalid_ivks.len() as u64));
         group.bench_function("invalid", |b| {
             b.iter(|| {
@@ -131,7 +135,7 @@ fn bench_note_decryption<FL: OrchardFlavor>(c: &mut Criterion) {
             })
             .collect();
 
-        let mut group = c.benchmark_group("batch-note-decryption");
+        let mut group = FL::benchmark_group(c, "batch-note-decryption");
 
         for size in [10, 50, 100] {
             group.throughput(Throughput::Elements((ivks * size) as u64));

diff --git a/benches/utils.rs b/benches/utils.rs
@@ -0,0 +1,28 @@
+use criterion::{measurement::Measurement, BenchmarkGroup, Criterion};
+
+use orchard::orchard_flavor::{OrchardFlavor, OrchardVanilla, OrchardZSA};
+
+pub(crate) trait OrchardFlavorBench: OrchardFlavor {
+    fn benchmark_group<'a, M: Measurement>(
+        c: &'a mut Criterion<M>,
+        group_name: &str,
+    ) -> BenchmarkGroup<'a, M>;
+}
+
+impl OrchardFlavorBench for OrchardVanilla {
+    fn benchmark_group<'a, M: Measurement>(
+        c: &'a mut Criterion<M>,
+        group_name: &str,
+    ) -> BenchmarkGroup<'a, M> {
+        c.benchmark_group(format!("[OrchardVanilla] {}", group_name))
+    }
+}
+
+impl OrchardFlavorBench for OrchardZSA {
+    fn benchmark_group<'a, M: Measurement>(
+        c: &'a mut Criterion<M>,
+        group_name: &str,
+    ) -> BenchmarkGroup<'a, M> {
+        c.benchmark_group(format!("[OrchardZSA] {}", group_name))
+    }
+}