ic-testkit 0.76.0

PocketIC-oriented test utilities for IC canister tests
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

//! Canister-side benchmark marker emission using IC execution counters.

use crate::benchmark::{
    BenchmarkCounters, BenchmarkMarkerError, DEFAULT_PREFIX, format_marker, try_format_marker,
};

const WASM_PAGE_BYTES: u128 = 65_536;

/// Print one `ICTK` marker for `label` using the current counters.
///
/// Pair labels ending in `:start` and `:end` for host-side span analysis.
pub fn measure(label: &str) {
    ic_platform::ic0::debug_print(format_marker(DEFAULT_PREFIX, label, counters()).as_bytes());
}

/// Admit a start/end label, then print one complete `ICTK` marker.
///
/// # Errors
/// Returns the marker grammar refusal before printing any bytes.
pub fn try_measure(label: &str) -> Result<(), BenchmarkMarkerError> {
    let marker = try_format_marker(DEFAULT_PREFIX, label, counters())?;
    ic_platform::ic0::debug_print(marker.as_bytes());
    Ok(())
}

/// Read the instruction, Wasm heap, and stable-memory counters.
#[must_use]
pub fn counters() -> BenchmarkCounters {
    BenchmarkCounters {
        instructions: u128::from(ic_platform::ic0::performance_counter(1)),
        heap_bytes: wasm_memory_size_bytes(),
        memory_bytes: u128::from(ic_platform::ic0::stable64_size()) * WASM_PAGE_BYTES,
    }
}

fn wasm_memory_size_bytes() -> u128 {
    u128::try_from(std::arch::wasm32::memory_size(0)).expect("usize fits into u128")
        * WASM_PAGE_BYTES
}