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 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
//! # benchmark-simple
//!
//! A tiny benchmarking library for Rust.
//!
//! - Trivial to use
//! - Works pretty much everywhere, including WebAssembly (WASI, but also
//! in-browser)
//!
//! ```rust
//! use benchmark_simple::*;
//!
//! fn test_function() {
//! // ...
//! }
//!
//! let bench = Bench::new();
//! let mut options = Options::default();
//! let res = bench.run(&options, || test_function());
//! println!("result: {}", res);
//! ```
//!
//! Throughput computation:
//!
//! ```rust
//! use benchmark_simple::*;
//!
//! fn test_function(m: &mut [u8]) {
//! // ...
//! }
//!
//! let mut m = vec![0u8; 1_000_000];
//! let bench = Bench::new();
//! let options = Options::default();
//! let res = bench.run(&options, || test_function(&mut m));
//! let throughput = res.throughput(m.len() as _);
//! println!("throughput: {}", throughput);
//! ```
//! Options:
//!
//! ```rust
//! pub struct Options {
//! /// Number of iterations to perform.
//! pub iterations: u64,
//! /// Number of warm-up iterations to perform.
//! pub warmup_iterations: u64,
//! /// Minimum number of samples to collect.
//! pub min_samples: usize,
//! /// Maximum number of samples to collect.
//! pub max_samples: usize,
//! /// Maximum RSD to tolerate (in 0...100).
//! pub max_rsd: f64,
//! /// Maximum benchmark duration time.
//! pub max_duration: Option<std::time::Duration>,
//! /// Verbose output.
//! pub verbose: bool,
//! }
//! ```
//!
//! Benchmark results can be made verbose by setting `verbose` to `true` in the
//! `Options` struct, or by defining a `BENCHMARK_VERBOSE` environment variable.
use std::fmt::{self, Debug, Display, Formatter};
use std::mem;
use std::ops::Add;
use std::ptr;
use std::rc::Rc;
use std::time::Duration;
use precision::*;
/// Options.
#[derive(Clone, Debug)]
pub struct Options {
/// Number of iterations to perform.
pub iterations: u64,
/// Number of warm-up iterations to perform.
pub warmup_iterations: u64,
/// Minimum number of samples to collect.
pub min_samples: usize,
/// Maximum number of samples to collect.
pub max_samples: usize,
/// Maximum RSD to tolerate (in 0...100).
pub max_rsd: f64,
/// Maximum benchmark duration time.
pub max_duration: Option<Duration>,
/// Verbose output
pub verbose: bool,
}
impl Default for Options {
fn default() -> Self {
let mut verbose = false;
std::env::var("BENCHMARK_VERBOSE")
.map(|_| verbose = true)
.ok();
Self {
iterations: 1,
warmup_iterations: 0,
min_samples: 3,
max_samples: 5,
max_rsd: 5.0,
verbose,
max_duration: None,
}
}
}
/// A benchmark result.
pub struct BenchResult {
elapsed: Elapsed,
precision: Precision,
options: Rc<Options>,
}
impl Add for BenchResult {
type Output = BenchResult;
fn add(self, other: BenchResult) -> Self::Output {
BenchResult {
elapsed: self.elapsed + other.elapsed,
precision: self.precision,
options: self.options,
}
}
}
impl BenchResult {
/// Returns the number of ticks.
pub fn ticks(&self) -> u64 {
self.elapsed.ticks()
}
/// Returns the elapsed time in seconds.
pub fn as_secs(&self) -> u64 {
self.elapsed.as_secs(&self.precision)
}
/// Returns the elapsed time in seconds (floating point).
pub fn as_secs_f64(&self) -> f64 {
self.elapsed.as_secs_f64(&self.precision)
}
/// Returns the elapsed time in milliseconds.
pub fn as_millis(&self) -> u64 {
self.elapsed.as_millis(&self.precision)
}
/// Returns the elapsed time in nanoseconds.
pub fn as_ns(&self) -> u64 {
self.elapsed.as_ns(&self.precision)
}
/// Compute the throughput for a given volume of data.
/// The volume is the amount of bytes processed in a single iteration.
pub fn throughput(self, mut volume: u128) -> Throughput {
volume *= self.options.iterations as u128;
Throughput {
volume: volume as f64,
result: self,
}
}
}
impl Display for BenchResult {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "{:.2}s", self.as_secs_f64())
}
}
impl Debug for BenchResult {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "{}", self)
}
}
/// The result of a benchmark, as a throughput.
pub struct Throughput {
volume: f64,
result: BenchResult,
}
impl Throughput {
/// The throughput as a floating point number.
pub fn as_f64(&self) -> f64 {
self.volume * 1_000_000_000f64 / (self.result.as_ns() as f64)
}
/// The throughput as an integer.
pub fn as_u128(&self) -> u128 {
self.volume as u128 * 1_000_000_000 / (self.result.as_ns() as u128)
}
/// The throughput in kibibytes.
pub fn as_kib(&self) -> f64 {
self.volume * 1_000_000_000f64 / (self.result.as_ns() as f64) / 1024.0
}
/// The throughput in mebibytes.
pub fn as_mib(&self) -> f64 {
self.volume * 1_000_000_000f64 / (self.result.as_ns() as f64) / (1024.0 * 1024.0)
}
/// The throughput in gibibytes.
pub fn as_gib(&self) -> f64 {
self.volume * 1_000_000_000f64 / (self.result.as_ns() as f64) / (1024.0 * 1024.0 * 1024.0)
}
/// The throughput in kilobytes.
pub fn as_kb(&self) -> f64 {
self.volume * 1_000_000_000f64 / (self.result.as_ns() as f64) / 1000.0
}
/// The throughput in megabytes.
pub fn as_mb(&self) -> f64 {
self.volume * 1_000_000_000f64 / (self.result.as_ns() as f64) / (1000.0 * 1000.0)
}
/// The throughput in gigabytes.
pub fn as_gb(&self) -> f64 {
self.volume * 1_000_000_000f64 / (self.result.as_ns() as f64) / (1000.0 * 1000.0 * 1000.0)
}
/// The throughput in kilobits.
pub fn as_kb8(&self) -> f64 {
self.volume * 8_000_000_000f64 / (self.result.as_ns() as f64) / 1000.0
}
/// The throughput in megabits.
pub fn as_mb8(&self) -> f64 {
self.volume * 8_000_000_000f64 / (self.result.as_ns() as f64) / (1000.0 * 1000.0)
}
/// The throughput in gigabits.
pub fn as_gb8(&self) -> f64 {
self.volume * 8_000_000_000f64 / (self.result.as_ns() as f64) / (1000.0 * 1000.0 * 1000.0)
}
}
impl Display for Throughput {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
match self.as_u128() {
0..=999 => write!(f, "{:.2} /s", self.as_f64()),
1_000..=999_999 => write!(f, "{:.2} K/s", self.as_kb()),
1_000_000..=999_999_999 => write!(f, "{:.2} M/s", self.as_mb()),
_ => write!(f, "{:.2} G/s", self.as_gb()),
}
}
}
impl Debug for Throughput {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "{}", self)
}
}
/// A benchmarking environment.
#[derive(Clone)]
pub struct Bench {
precision: Precision,
}
impl Bench {
/// Create a new benchmarking environment.
pub fn new() -> Self {
let precision = Precision::new(Default::default()).unwrap();
Bench { precision }
}
fn run_once<F, G>(&self, options: Rc<Options>, f: &mut F) -> BenchResult
where
F: FnMut() -> G,
{
let iterations = options.iterations;
let start = self.precision.now();
for _ in 0..iterations {
black_box(f());
}
let elapsed = self.precision.now() - start;
BenchResult {
elapsed,
precision: self.precision.clone(),
options,
}
}
/// Run a single test.
pub fn run<F, G>(&self, options: &Options, mut f: F) -> BenchResult
where
F: FnMut() -> G,
{
let options = Rc::new(options.clone());
let max_samples = std::cmp::max(1, options.max_samples);
let verbose = options.verbose;
if verbose {
println!("Starting a new benchmark.");
if options.warmup_iterations > 0 {
println!("Warming up for {} iterations.", options.warmup_iterations);
}
}
for _ in 0..options.warmup_iterations {
black_box(f());
}
let mut results = Vec::with_capacity(max_samples);
let start = self.precision.now();
for i in 1..=max_samples {
if verbose {
println!("Running iteration {}.", i);
}
let result = self.run_once(options.clone(), &mut f);
results.push(result);
if results.len() <= 1 {
if verbose {
println!("Iteration {}: {}", i, results.last().unwrap());
}
continue;
}
let mean = results.iter().map(|r| r.as_secs_f64()).sum::<f64>() / results.len() as f64;
let std_dev = (results
.iter()
.map(|r| (r.as_secs_f64() - mean).powi(2))
.sum::<f64>()
/ (results.len() - 1) as f64)
.sqrt();
let rsd = std_dev * 100.0 / mean;
if verbose {
println!("Iteration {}: {:.2}s ± {:.2}%", i, mean, rsd);
}
if i >= options.min_samples && rsd < options.max_rsd {
if verbose {
println!("Enough samples have been collected.");
}
break;
}
if let Some(max_duration) = options.max_duration {
let elapsed =
Duration::from_secs((self.precision.now() - start).as_secs(&self.precision));
if elapsed >= max_duration {
if verbose {
println!("Timeout.");
}
break;
}
}
}
let result = results.into_iter().min_by_key(|r| r.as_ns()).unwrap();
if verbose {
println!("Result: {}", result);
}
result
}
}
impl Default for Bench {
fn default() -> Self {
Self::new()
}
}
/// Force the compiler to avoid optimizing away a value that is computed
/// for benchmarking purposes, but not used afterwards.
#[inline(never)]
pub fn black_box<T>(dummy: T) -> T {
let ret = unsafe { ptr::read_volatile(&dummy) };
mem::forget(dummy);
ret
}