pedant-graph 0.5.1

Deterministic code topology projected from pedant's symbol-resolution results
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
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

//! What one cache did, counted once per examined or dropped entry.
//!
//! Statistics describe cache work alone. Nothing here enters graph identity,
//! record order, serialization, or a query answer: a counter is read by a host
//! deciding whether its retention budget is worth the memory, and by the proofs
//! that hold this crate to reusing only what it claims to reuse.
//!
//! The reading is a copied value. The live counts it is taken from belong to
//! [`super::state`], so a host reads a number that cannot move under it.

/// One category's three cumulative counts, as a copied reading.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) struct CategoryCounts {
    hits: u64,
    misses: u64,
    evictions: u64,
}

impl CategoryCounts {
    /// One category's three counts, read together.
    pub(crate) fn new(hits: u64, misses: u64, evictions: u64) -> Self {
        Self {
            hits,
            misses,
            evictions,
        }
    }
}

/// A copied reading of one cache's cumulative activity.
///
/// Counters saturate rather than wrap, so a long-lived host reads a ceiling
/// instead of a count that silently restarted.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct GraphCacheStats {
    source_projections: CategoryCounts,
    exact_graphs: CategoryCounts,
    selected_indexes: CategoryCounts,
    derived_products: CategoryCounts,
}

impl GraphCacheStats {
    /// One reading, taken across all four categories at once.
    pub(crate) fn new(
        source_projections: CategoryCounts,
        exact_graphs: CategoryCounts,
        selected_indexes: CategoryCounts,
        derived_products: CategoryCounts,
    ) -> Self {
        Self {
            source_projections,
            exact_graphs,
            selected_indexes,
            derived_products,
        }
    }

    /// Source-unit projections reused from retained state.
    pub fn source_projection_hits(self) -> u64 {
        self.source_projections.hits
    }

    /// Source-unit projections that had to be rebuilt.
    pub fn source_projection_misses(self) -> u64 {
        self.source_projections.misses
    }

    /// Source-unit projections dropped to stay within their ceiling.
    pub fn source_projection_evictions(self) -> u64 {
        self.source_projections.evictions
    }

    /// Exact graphs answered from retained state.
    pub fn exact_graph_hits(self) -> u64 {
        self.exact_graphs.hits
    }

    /// Exact graphs that had to be built.
    pub fn exact_graph_misses(self) -> u64 {
        self.exact_graphs.misses
    }

    /// Exact graphs dropped to stay within their ceiling.
    pub fn exact_graph_evictions(self) -> u64 {
        self.exact_graphs.evictions
    }

    /// Edge-selection index sets answered from retained state.
    pub fn selected_index_hits(self) -> u64 {
        self.selected_indexes.hits
    }

    /// Edge-selection index sets that had to be built.
    pub fn selected_index_misses(self) -> u64 {
        self.selected_indexes.misses
    }

    /// Edge-selection index sets dropped to stay within their ceiling.
    pub fn selected_index_evictions(self) -> u64 {
        self.selected_indexes.evictions
    }

    /// Derived products answered from retained state.
    pub fn derived_product_hits(self) -> u64 {
        self.derived_products.hits
    }

    /// Derived products that had to be computed.
    pub fn derived_product_misses(self) -> u64 {
        self.derived_products.misses
    }

    /// Derived products dropped to stay within their ceiling.
    pub fn derived_product_evictions(self) -> u64 {
        self.derived_products.evictions
    }
}