Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: Add a few new benchmarks that exercise the MemoryManager which is often how StableStructures are used #253

Merged
merged 3 commits into from
Dec 2, 2024
Merged

test: Add a few new benchmarks that exercise the MemoryManager which is often how StableStructures are used #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5d39e34
test: Add a few new benchmarks that exercise the MemoryManager which …
frankdavid Nov 29, 2024
9b34680
Merge remote-tracking branch 'origin/main' into frankdavid/mem-manage…
frankdavid Dec 2, 2024
4a67caa
Canbench
frankdavid Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 48 additions & 7 deletions benchmarks/src/btreemap.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use crate::Random;
use canbench_rs::{bench, bench_fn, BenchResult};
use ic_stable_structures::{storable::Blob, BTreeMap, DefaultMemoryImpl, Storable};
use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
use ic_stable_structures::{storable::Blob, BTreeMap, DefaultMemoryImpl, Memory, Storable};
use std::ops::Bound;
use tiny_rng::{Rand, Rng};

Expand Down Expand Up @@ -164,12 +165,24 @@ pub fn btreemap_insert_blob_1024_512_v2() -> BenchResult {
insert_blob_helper_v2::<1024, 512>()
}

#[bench(raw)]
pub fn btreemap_insert_blob_1024_512_v2_mem_manager() -> BenchResult {
insert_blob_helper_v2_mem_manager::<1024, 512>()
}

#[bench(raw)]
pub fn btreemap_insert_u64_u64() -> BenchResult {
let btree = BTreeMap::new_v1(DefaultMemoryImpl::default());
insert_helper::<u64, u64>(btree)
}

#[bench(raw)]
pub fn btreemap_insert_u64_u64_mem_manager() -> BenchResult {
let memory_manager = MemoryManager::init(DefaultMemoryImpl::default());
let btree = BTreeMap::new(memory_manager.get(MemoryId::new(42)));
insert_helper::<u64, u64>(btree)
}

#[bench(raw)]
pub fn btreemap_insert_u64_u64_v2() -> BenchResult {
let btree = BTreeMap::new(DefaultMemoryImpl::default());
Expand Down Expand Up @@ -204,16 +217,20 @@ pub fn btreemap_insert_blob_8_u64_v2() -> BenchResult {
pub fn btreemap_insert_10mib_values() -> BenchResult {
let mut btree = BTreeMap::new(DefaultMemoryImpl::default());

// Insert 200 10MiB values.
// Insert 20 10MiB values.
let mut rng = Rng::from_seed(0);
let mut values = vec![];
for _ in 0..200 {
values.push(rng.iter(Rand::rand_u8).take(10 * 1024).collect::<Vec<_>>());
for _ in 0..20 {
values.push(
rng.iter(Rand::rand_u8)
.take(10 * 1024 * 1024)
.collect::<Vec<_>>(),
);
}

bench_fn(|| {
let mut i = 0u64;
for value in values.into_iter() {
for value in values {
btree.insert(i, value);
i += 1;
}
Expand Down Expand Up @@ -543,6 +560,11 @@ pub fn btreemap_get_blob_512_1024_v2() -> BenchResult {
get_blob_helper_v2::<512, 1024>()
}

#[bench(raw)]
pub fn btreemap_get_blob_512_1024_v2_mem_manager() -> BenchResult {
get_blob_helper_v2_mem_manager::<512, 1024>()
}

#[bench(raw)]
pub fn btreemap_get_u64_u64() -> BenchResult {
let btree = BTreeMap::new_v1(DefaultMemoryImpl::default());
Expand All @@ -555,6 +577,13 @@ pub fn btreemap_get_u64_u64_v2() -> BenchResult {
get_helper::<u64, u64>(btree)
}

#[bench(raw)]
pub fn btreemap_get_u64_u64_v2_mem_manager() -> BenchResult {
let memory_manager = MemoryManager::init(DefaultMemoryImpl::default());
let btree = BTreeMap::new(memory_manager.get(MemoryId::new(42)));
get_helper::<u64, u64>(btree)
}

#[bench(raw)]
pub fn btreemap_get_u64_blob_8() -> BenchResult {
let btree = BTreeMap::new_v1(DefaultMemoryImpl::default());
Expand Down Expand Up @@ -590,9 +619,15 @@ fn insert_blob_helper_v2<const K: usize, const V: usize>() -> BenchResult {
insert_helper::<Blob<K>, Blob<V>>(btree)
}

fn insert_blob_helper_v2_mem_manager<const K: usize, const V: usize>() -> BenchResult {
let memory_manager = MemoryManager::init(DefaultMemoryImpl::default());
let btree = BTreeMap::new(memory_manager.get(MemoryId::new(42)));
insert_helper::<Blob<K>, Blob<V>>(btree)
}

// Profiles inserting a large number of random blobs into a btreemap.
fn insert_helper<K: Clone + Ord + Storable + Random, V: Storable + Random>(
mut btree: BTreeMap<K, V, DefaultMemoryImpl>,
mut btree: BTreeMap<K, V, impl Memory>,
) -> BenchResult {
let num_keys = 10_000;
let mut rng = Rng::from_seed(0);
Expand Down Expand Up @@ -640,8 +675,14 @@ fn get_blob_helper_v2<const K: usize, const V: usize>() -> BenchResult {
get_helper::<Blob<K>, Blob<V>>(btree)
}

fn get_blob_helper_v2_mem_manager<const K: usize, const V: usize>() -> BenchResult {
let memory_manager = MemoryManager::init(DefaultMemoryImpl::default());
let btree = BTreeMap::new(memory_manager.get(MemoryId::new(42)));
get_helper::<Blob<K>, Blob<V>>(btree)
}

fn get_helper<K: Clone + Ord + Storable + Random, V: Storable + Random>(
mut btree: BTreeMap<K, V, DefaultMemoryImpl>,
mut btree: BTreeMap<K, V, impl Memory>,
) -> BenchResult {
let num_keys = 10_000;
let mut rng = Rng::from_seed(0);
Expand Down
26 changes: 21 additions & 5 deletions benchmarks/src/vec.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
use crate::Random;
use canbench_rs::{bench, bench_fn, BenchResult};
use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
use ic_stable_structures::storable::Blob;
use ic_stable_structures::{DefaultMemoryImpl, StableVec, Storable};
use ic_stable_structures::{DefaultMemoryImpl, Memory, StableVec, Storable};
use tiny_rng::{Rand, Rng};

#[bench(raw)]
Expand Down Expand Up @@ -44,6 +45,11 @@ pub fn vec_get_blob_4() -> BenchResult {
vec_get_blob::<4>()
}

#[bench(raw)]
pub fn vec_get_blob_4_mem_manager() -> BenchResult {
vec_get_blob_mem_manager::<4>()
}

#[bench(raw)]
pub fn vec_get_blob_8() -> BenchResult {
vec_get_blob::<8>()
Expand All @@ -64,14 +70,19 @@ pub fn vec_get_blob_64() -> BenchResult {
vec_get_blob::<64>()
}

#[bench(raw)]
pub fn vec_get_blob_64_mem_manager() -> BenchResult {
vec_get_blob_mem_manager::<64>()
}

#[bench(raw)]
pub fn vec_get_blob_128() -> BenchResult {
vec_get_blob::<128>()
}

#[bench(raw)]
pub fn vec_get_u64() -> BenchResult {
vec_get::<u64>()
vec_get::<u64>(DefaultMemoryImpl::default())
}

fn vec_insert_blob<const N: usize>() -> BenchResult {
Expand All @@ -97,12 +108,17 @@ fn vec_insert<T: Storable + Random>() -> BenchResult {
}

fn vec_get_blob<const N: usize>() -> BenchResult {
vec_get::<Blob<N>>()
vec_get::<Blob<N>>(DefaultMemoryImpl::default())
}

fn vec_get_blob_mem_manager<const N: usize>() -> BenchResult {
let memory_manager = MemoryManager::init(DefaultMemoryImpl::default());
vec_get::<Blob<N>>(memory_manager.get(MemoryId::new(42)))
}

fn vec_get<T: Storable + Random>() -> BenchResult {
fn vec_get<T: Storable + Random>(memory: impl Memory) -> BenchResult {
let num_items = 10_000;
let svec: StableVec<T, _> = StableVec::new(DefaultMemoryImpl::default()).unwrap();
let svec: StableVec<T, _> = StableVec::new(memory).unwrap();

let mut rng = Rng::from_seed(0);

Expand Down
40 changes: 38 additions & 2 deletions canbench_results.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ benches:
heap_increase: 0
stable_memory_increase: 0
scopes: {}
btreemap_get_blob_512_1024_v2_mem_manager:
total:
instructions: 3164909208
heap_increase: 0
stable_memory_increase: 0
scopes: { }
btreemap_get_blob_64_1024:
total:
instructions: 572513751
Expand Down Expand Up @@ -130,12 +136,18 @@ benches:
instructions: 255485892
heap_increase: 0
stable_memory_increase: 0
scopes: { }
btreemap_get_u64_u64_v2_mem_manager:
total:
instructions: 673752904
heap_increase: 0
stable_memory_increase: 0
scopes: {}
btreemap_insert_10mib_values:
total:
instructions: 82015559
instructions: 5251584111
heap_increase: 0
stable_memory_increase: 32
stable_memory_increase: 3613
scopes: {}
btreemap_insert_blob_1024_128:
total:
Expand Down Expand Up @@ -208,6 +220,12 @@ benches:
instructions: 5070548871
heap_increase: 0
stable_memory_increase: 261
scopes: { }
btreemap_insert_blob_1024_512_v2_mem_manager:
total:
instructions: 6292667075
heap_increase: 0
stable_memory_increase: 256
scopes: {}
btreemap_insert_blob_1024_64:
total:
Expand Down Expand Up @@ -359,6 +377,12 @@ benches:
heap_increase: 0
stable_memory_increase: 7
scopes: {}
btreemap_insert_u64_u64_mem_manager:
total:
instructions: 1019612837
heap_increase: 0
stable_memory_increase: 0
scopes: { }
btreemap_insert_u64_u64_v2:
total:
instructions: 421501977
Expand Down Expand Up @@ -635,11 +659,23 @@ benches:
heap_increase: 0
stable_memory_increase: 0
scopes: {}
vec_get_blob_4_mem_manager:
total:
instructions: 14476122
heap_increase: 0
stable_memory_increase: 0
scopes: { }
vec_get_blob_64:
total:
instructions: 12960294
heap_increase: 0
stable_memory_increase: 0
scopes: { }
vec_get_blob_64_mem_manager:
total:
instructions: 24146389
heap_increase: 0
stable_memory_increase: 0
scopes: {}
vec_get_blob_8:
total:
Expand Down