[go: up one dir, main page]

divan 0.1.3

Statistically-comfy benchmarking library.
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
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

use crate::{
    counter::KnownCounterKind,
    time::{FineDuration, Timer, Timestamp},
};

/// Processed measurement.
pub(crate) struct Sample {
    /// The time this sample took to run.
    ///
    /// This is gotten from [`RawSample`] with:
    /// `end.duration_since(start, timer).clamp_to(timer.precision())`.
    pub duration: FineDuration,
}

/// Unprocessed measurement.
///
/// This cannot be serialized because [`Timestamp`] is an implementation detail
/// for both the `Instant` and TSC timers.
pub(crate) struct RawSample {
    pub start: Timestamp,
    pub end: Timestamp,
    pub timer: Timer,
    pub counter_totals: [u128; KnownCounterKind::COUNT],
}

/// Multi-thread measurement.
pub(crate) struct ThreadSample {
    /// The total wall clock time spent over the collected samples.
    ///
    /// This is the earliest [`RawSample::start`] subtracted from the latest
    /// [`RawSample::end`] across all threads for the multi-thread sample set.
    /// In other words, it is the time spent between the timing section
    /// barriers.
    // TODO: Report counter throughput.
    #[allow(dead_code)]
    pub total_wall_time: FineDuration,
}

impl RawSample {
    /// Simply computes `end - start` without clamping to precision.
    #[inline]
    pub fn duration(&self) -> FineDuration {
        self.end.duration_since(self.start, self.timer)
    }
}

/// [`Sample`] collection.
#[derive(Default)]
pub(crate) struct SampleCollection {
    /// The number of iterations within each sample.
    pub sample_size: u32,

    /// Collected samples.
    pub all: Vec<Sample>,

    /// Collected multi-thread data.
    ///
    /// To associate this with samples in `all`, stride over `all` with the
    /// thread count.
    pub threads: Vec<ThreadSample>,
}

impl SampleCollection {
    /// Discards all recorded data.
    #[inline]
    pub fn clear(&mut self) {
        self.all.clear();
        self.threads.clear();
    }

    /// Computes the total number of iterations across all samples.
    ///
    /// We use `u64` in case sample count and sizes are huge.
    #[inline]
    pub fn iter_count(&self) -> u64 {
        self.sample_size as u64 * self.all.len() as u64
    }

    /// Computes the total time across all samples.
    #[inline]
    pub fn total_duration(&self) -> FineDuration {
        FineDuration { picos: self.all.iter().map(|s| s.duration.picos).sum() }
    }

    /// Returns all samples sorted by duration.
    #[inline]
    pub fn sorted_samples(&self) -> Vec<&Sample> {
        let mut result: Vec<&Sample> = self.all.iter().collect();
        result.sort_unstable_by_key(|s| s.duration);
        result
    }
}