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
//! Simple benchmarking functionality for supporting thyme.
//!
//! Benchmarks consist of a moving average and associated statistics of a given
//! set of timings. Timings that are grouped together share the same tag.
//! You can pass a block to be timed using [`run`](fn.run.html), or create a handle with
//! [`start`](fn.start.html) and end the timing with [`end`](struct.Handle.html#method.end).
//! Use [`stats`](fn.stats.html) to get a [`Stats`](struct.Stats.html), which is the
//! primary interface for reporting on the timings.
use std::time::{Duration, Instant};
use parking_lot::{const_mutex, Mutex};
const MOVING_AVG_LEN: usize = 30;
static BENCH: Mutex<BenchSet> = const_mutex(BenchSet::new());
/// A benchmarking handle created by [`start`](fn.start.html). [`end`](#method.end) this to
/// finish the given benchmark timing
pub struct Handle {
index: usize
}
impl Handle {
/// Finish the timing associated with this handle.
pub fn end(self) {
end(self);
}
}
/// Runs the specified closure `block` as a benchmark timing
/// with the given `tag`.
pub fn run<Ret, F: FnOnce() -> Ret>(tag: &str, block: F) -> Ret {
let handle = start(tag);
let ret = (block)();
end(handle);
ret
}
/// Starts a benchmark timing with the given `tag`. You
/// must [`end`](struct.Handle.html#method.end) the returned [`Handle`](struct.Handle.html) to complete
/// the timing.
#[must_use]
pub fn start(tag: &str) -> Handle {
let mut bench = BENCH.lock();
bench.start(tag)
}
/// Returns a `Stats` object for the benchmark timings
/// associated with the given `tag`. Limits to a number
/// of recent samples if there are a large number of total samples.
pub fn stats(tag: &str) -> Stats {
let bench = BENCH.lock();
bench.stats(tag, Some(MOVING_AVG_LEN))
}
/// Like [`stats`](fn.stats.html), but there is no limit on the
/// number of samples to be considered.
pub fn stats_all(tag: &str) -> Stats {
let bench = BENCH.lock();
bench.stats(tag, None)
}
/// Like [`report`](fn.report.html), but produces a condensed version
/// of the data.
pub fn short_report(tag: &str) -> String {
let bench = BENCH.lock();
bench.short_report(tag, Some(MOVING_AVG_LEN))
}
/// A convenience method to automatically generate a report
/// String for the given `tag`. The report will include all of the
/// data in the [`Stats`](struct.Stats.html) associated with this `tag`,
/// and be formatted with appropriate units. Limits to a number of
/// recent samples if there are a large number of total samples.
pub fn report(tag: &str) -> String {
let bench = BENCH.lock();
bench.report(tag, Some(MOVING_AVG_LEN))
}
/// Like [`report`](fn.report.html), but there is no limit on the
/// number of samples to be considered.
pub fn report_all(tag: &str) -> String {
let bench = BENCH.lock();
bench.report(tag, None)
}
fn end(handle: Handle) {
let mut bench = BENCH.lock();
bench.end(handle);
}
/// Statistics associated with a given set of benchmark timings.
/// These are obtained with the `stats` method for a given tag.
/// Statistics are for a moving average of the last N timings for the
/// tag, where N is currently hardcoded to 30.
#[derive(Debug, Copy, Clone)]
pub struct Stats {
count: usize,
total_s: f32,
average_s: f32,
stdev_s: f32,
max_s: f32,
unit: Unit,
}
impl Default for Stats {
fn default() -> Self {
Stats {
count: 0,
total_s: 0.0,
average_s: 0.0,
stdev_s: 0.0,
max_s: 0.0,
unit: Unit::Seconds,
}
}
}
impl Stats {
/// Returns the sum total of the timings, in the current unit
/// of this `Stats`.
pub fn total(&self) -> f32 {
self.total_s * self.unit.multiplier()
}
/// Returns the average of the timings, in the current unit
/// of this `Stats`.
pub fn average(&self) -> f32 {
self.average_s * self.unit.multiplier()
}
/// Returns the standard devication of the timings, in the current unit
/// of this `Stats`.
pub fn stdev(&self) -> f32 {
self.stdev_s * self.unit.multiplier()
}
/// Returns the maximum of the timings, in the current unit
/// of this `Stats`.
pub fn max(&self) -> f32 {
self.max_s * self.unit.multiplier()
}
/// Returns the postfix string of the Unit associated with this
/// `Stats`, such as "s" for Seconds, "ms" for milliseconds, and
/// "µs" for microseconds.
pub fn unit_postfix(&self) -> &'static str {
self.unit.postfix()
}
/// Automatically picks an appropriate unit for this `Stats` based
/// on the size of the average value, and converts the stats to
/// use that unit.
pub fn pick_unit(self) -> Stats {
const CHANGE_VALUE: f32 = 0.0999999;
if self.average_s > CHANGE_VALUE {
self.in_seconds()
} else if self.average_s * Unit::Millis.multiplier() > CHANGE_VALUE {
self.in_millis()
} else {
self.in_micros()
}
}
/// Converts this `Stats` to use seconds as a unit
pub fn in_seconds(mut self) -> Stats {
self.unit = Unit::Seconds;
self
}
/// Converts this `Stats` to use milliseconds as a unit
pub fn in_millis(mut self) -> Stats {
self.unit = Unit::Millis;
self
}
/// Converts this `Stats` to use microseconds as a unit
pub fn in_micros(mut self) -> Stats {
self.unit = Unit::Micros;
self
}
}
struct BenchSet {
// TODO maybe use HashMap here once we can create a hashmap in const
benches: Vec<Bench>,
}
impl BenchSet {
const fn new() -> BenchSet {
BenchSet {
benches: Vec::new()
}
}
fn start(&mut self, tag: &str) -> Handle {
// TODO handle multiple starts at the same time?
// check if bench with this tag already exists
for (index, bench) in self.benches.iter_mut().enumerate() {
if bench.tag == tag {
bench.start = Some(Instant::now());
return Handle { index };
}
}
// create new bench
let mut bench = Bench::new(tag.to_string());
bench.start = Some(Instant::now());
let index = self.benches.len();
self.benches.push(bench);
Handle { index }
}
fn end(&mut self, handle: Handle) {
let bench = &mut self.benches[handle.index];
let duration = Instant::now() - bench.start.take().unwrap_or_else(Instant::now);
bench.history.push(duration);
}
fn stats(&self, tag: &str, limit: Option<usize>) -> Stats {
for bench in self.benches.iter() {
if bench.tag == tag {
return bench.stats(limit);
}
}
Stats::default()
}
fn report(&self, tag: &str, limit: Option<usize>) -> String {
for bench in self.benches.iter() {
if bench.tag == tag {
return bench.report_str(limit);
}
}
"Bench not found".to_string()
}
fn short_report(&self, tag: &str, limit: Option<usize>) -> String {
for bench in self.benches.iter() {
if bench.tag == tag {
return bench.short_report_str(limit);
}
}
"Bench not found".to_string()
}
}
#[derive(Copy, Clone, Debug)]
enum Unit {
Seconds,
Millis,
Micros,
}
impl Unit {
fn postfix(self) -> &'static str {
use Unit::*;
match self {
Seconds => "s",
Millis => "ms",
Micros => "µs"
}
}
fn multiplier(self) -> f32 {
use Unit::*;
match self {
Seconds => 1.0,
Millis => 1000.0,
Micros => 1_000_000.0,
}
}
}
struct Bench {
tag: String,
history: Vec<Duration>,
start: Option<Instant>,
}
impl Bench {
fn new(tag: String) -> Bench {
Bench {
history: Vec::new(),
start: None,
tag,
}
}
fn stats(&self, limit: Option<usize>) -> Stats {
let len = self.history.len();
let count = match limit {
None => len,
Some(limit) => std::cmp::min(len, limit),
};
let data = || { self.history.iter().rev().take(count) };
let sum = (data)().sum::<Duration>().as_secs_f32();
let max = match (data)().max() {
None => 0.0,
Some(dur) => dur.as_secs_f32(),
};
let avg = sum / (count as f32);
let numer: f32 = (data)().map(|d| (d.as_secs_f32() - avg) * (d.as_secs_f32() - avg)).sum();
let stdev_sq = numer / (count as f32 - 1.0);
let stdev = stdev_sq.sqrt();
Stats {
count,
total_s: sum,
average_s: avg,
stdev_s: stdev,
max_s: max,
unit: Unit::Seconds,
}
}
fn short_report_str(&self, limit: Option<usize>) -> String {
let stats = self.stats(limit).pick_unit();
if self.history.len() == 1 {
format!("{}: {:.2} {}", self.tag, stats.average(), stats.unit_postfix())
} else {
format!(
"{}: {:.2} ± {:.2} {}",
self.tag, stats.average(), stats.stdev(), stats.unit_postfix(),
)
}
}
fn report_str(&self, limit: Option<usize>) -> String {
let stats = self.stats(limit).pick_unit();
if self.history.len() == 1 {
format!("{}: {:.2} {}", self.tag, stats.average(), stats.unit_postfix())
} else {
format!(
"{} ({} Samples): {:.2} ± {:.2}; max {:.2}, total {:.2} {}",
self.tag, stats.count, stats.average(), stats.stdev(), stats.max(), stats.total(), stats.unit_postfix(),
)
}
}
}