Calliper

Calliper is a Callgrind-based benchmarking harness with few-too-many knobs sticking out.

Table of contents

• Table of contents
  • Usage
  • Examples
  • License
  • Acknowledgmenets

Usage

To use Calliper, you must have Valgrind installed.

To write your first benchmark with Calliper, add the following to your Cargo.toml: ```toml [dev-dependencies] calliper = "0.1.2"

[[bench]] name = "myfirstcalliper_benchmark" harness = false ```

Then, create a file at $PROJECT/benches/my_first_calliper_benchmark.rs with the following contents:

```rust use calliper::utils::black_box; use calliper::{Runner, Scenario};

[inline(never)]

[no_mangle]

fn binarysearchimpl(haystack: &[u8], needle: u8) -> Result { haystack.binarysearch(&needle) } fn benchbinarysearch() { let range = (0..255).collect::>(); let _ = blackbox(binarysearchimpl(blackbox(&range), blackbox(253))); }

[inline(never)]

[no_mangle]

fn linearsearchimpl(haystack: &[u8], needle: u8) -> Option { haystack.iter().position(|n| *n == needle) }

fn benchlinearsearch() { let range = (0..255).collect::>(); blackbox(linearsearchimpl(blackbox(&range), black_box(253))); }

fn main() -> Result<(), Box> { let runner = Runner::default(); let benches = [ Scenario::new(benchlinearsearch), Scenario::new(benchbinarysearch), ]; runner.run(&benches).unwrap(); Ok(()) } ```

Now the benchmark can be executed with cargo bench.

More sophisticated examples can be found in benches folder of this repository.

License

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

at your option.

Acknowledgements

Calliper is inspired by Iai benchmarking harness.