commonware-storage 2026.7.0

use commonware_storage::merkle::{Family, Location, Position};
use commonware_utils::test_rng;
use criterion::{criterion_group, Criterion};
use rand::RngExt as _;
use std::hint::black_box;

#[cfg(not(full_bench))]
const N_LEAVES: [u64; 2] = [1_000_000, 1_000_000_000_000];
#[cfg(full_bench)]
const N_LEAVES: [u64; 3] = [1_000_000, 1_000_000_000_000, 1 << 62];

/// Positions evaluated per measured iteration. Amortizes timer overhead and exercises a spread of
/// bit patterns (the cost varies with the popcount structure near the target).
const SAMPLES: usize = 4096;

/// Generate `SAMPLES` valid leaf positions drawn from leaf counts in `[0, max_leaves)`. The
/// benchmark focuses on the common leaf/size (`Some`) path exercised by callers like `leaves()` and
/// `Location::try_from`; it does not measure the non-leaf (`None`) path used for leaf detection.
fn sample_positions<F: Family>(max_leaves: u64) -> Vec<Position<F>> {
    let mut rng = test_rng();
    (0..SAMPLES)
        .map(|_| F::location_to_position(Location::new(rng.random_range(0..max_leaves))))
        .collect()
}

fn bench_position_to_location_family<F: Family>(c: &mut Criterion, family: &str) {
    for n in N_LEAVES {
        let positions = sample_positions::<F>(n);
        c.bench_function(&format!("{}/n={n} family={family}", module_path!()), |b| {
            b.iter(|| {
                for &pos in &positions {
                    black_box(F::position_to_location(black_box(pos)));
                }
            });
        });
    }
}

fn bench_position_to_location(c: &mut Criterion) {
    bench_position_to_location_family::<commonware_storage::mmr::Family>(c, "mmr");
    bench_position_to_location_family::<commonware_storage::mmb::Family>(c, "mmb");
}

criterion_group! {
    name = benches;
    config = Criterion::default().sample_size(10);
    targets = bench_position_to_location
}