Skip to main content

StorageBenchmark

Struct StorageBenchmark 

Source
pub struct StorageBenchmark { /* private fields */ }
Expand description

Storage performance benchmarking engine.

Collects LatencySamples during a benchmark run, then computes statistical summaries via StorageBenchmark::compute_result.

§Example

use ipfrs_storage::{BenchmarkConfig, BenchmarkOp, StorageBenchmark};

let config = BenchmarkConfig::default_write();
let mut bench = StorageBenchmark::new(config);

// Simulate recording some operations
bench.record_op(BenchmarkOp::Write, 120, 4096, true);
bench.record_op(BenchmarkOp::Write, 95, 4096, true);

let result = bench.compute_result(500_000); // 0.5 s in µs
println!("{}", StorageBenchmark::format_result(&result));

Implementations§

Source§

impl StorageBenchmark

Source

pub fn new(config: BenchmarkConfig) -> Self

Create a new benchmark engine from the given configuration.

The PRNG is seeded from config.seed; if the seed is zero the engine falls back to a fixed non-zero seed to satisfy xorshift64 requirements.

Source

pub fn add_sample(&mut self, sample: LatencySample)

Push a pre-built LatencySample onto the collection.

Source

pub fn record_op( &mut self, op: BenchmarkOp, latency_us: u64, bytes: usize, success: bool, )

Record a single operation result, constructing a LatencySample and adding it to the internal collection.

Source

pub fn sample_count(&self) -> usize

Return the number of samples currently held.

Source

pub fn success_rate(&self) -> f64

Fraction of recorded operations that succeeded (0.0 when no samples).

Source

pub fn reset(&mut self)

Clear all recorded samples and reset the PRNG to the original seed.

Source

pub fn compute_result(&self, duration_us: u64) -> BenchmarkResult

Compute a BenchmarkResult from all samples collected so far.

duration_us is the wall-clock time of the entire run in microseconds. When duration_us is zero, throughput is reported as 0.0 to avoid division-by-zero.

Source

pub fn compute_percentile(samples: &mut [u64], percentile: f64) -> u64

Compute a percentile value from a mutable slice of latency samples.

The slice is sorted in place. Returns 0 for an empty slice. percentile must be in the range [0.0, 100.0]; values outside that range are clamped.

Source

pub fn compute_throughput(bytes: u64, duration_us: u64) -> f64

Compute throughput in megabytes per second.

Returns 0.0 when duration_us is zero.

Source

pub fn generate_block(&mut self, size: usize) -> Vec<u8>

Generate a pseudo-random block of size bytes using the internal xorshift64 PRNG.

Each call advances the PRNG state so successive calls produce different (but deterministic) data.

Source

pub fn format_result(result: &BenchmarkResult) -> String

Format a BenchmarkResult as a human-readable summary string.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more