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

// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.

//! Report lgalloc metrics.

use std::collections::BTreeMap;
use std::ops::AddAssign;
use std::time::Duration;

use lgalloc::{FileStats, SizeClassStats};
use mz_ore::cast::CastFrom;
use mz_ore::metrics::{raw, MetricsRegistry};
use paste::paste;
use prometheus::core::{AtomicU64, GenericGauge};

/// An accumulator for [`FileStats`].
#[derive(Default)]
struct FileStatsAccum {
    /// The size of the file in bytes.
    pub file_size: usize,
    /// Size of the file on disk in bytes.
    pub allocated_size: usize,
    /// Number of mapped bytes, if different from `dirty`. Consult `man 7 numa` for details.
    pub mapped: usize,
    /// Number of active bytes. Consult `man 7 numa` for details.
    pub active: usize,
    /// Number of dirty bytes. Consult `man 7 numa` for details.
    pub dirty: usize,
}

impl AddAssign<&FileStats> for FileStatsAccum {
    fn add_assign(&mut self, rhs: &FileStats) {
        self.file_size += rhs.file_size;
        self.allocated_size += rhs.allocated_size;
        self.mapped += rhs.mapped;
        self.active += rhs.active;
        self.dirty += rhs.dirty;
    }
}

macro_rules! metrics_size_class {
    ($namespace:ident
        @size_class ($(($name:ident, $desc:expr, $metric:expr, $conv:expr)),*)
        @file ($(($f_name:ident, $f_metric:ident, $f_desc:expr)),*)
    ) => {
        metrics_size_class! {
            @define $namespace
            @size_class $(($name, $desc, $metric, $conv)),*
            @file $(($f_name, $f_metric, $f_desc)),*
        }
    };
    (@define $namespace:ident
        @size_class $(($name:ident, $desc:expr, $metric:expr, $conv:expr)),*
        @file $(($f_name:ident, $f_metric:ident, $f_desc:expr)),*
    ) => {
        paste! {
            struct LgMetrics {
                stats: lgalloc::LgAllocStats,
                size_class: BTreeMap<usize, LgMetricsSC>,
                $($metric: raw::UIntGaugeVec,)*
                $($f_metric: raw::UIntGaugeVec,)*
            }
            struct LgMetricsSC {
                $($metric: GenericGauge<AtomicU64>,)*
                $($f_metric: GenericGauge<AtomicU64>,)*
            }
            impl LgMetrics {
                fn new(registry: &MetricsRegistry) -> Self {
                    Self {
                        size_class: BTreeMap::default(),
                        stats: lgalloc::LgAllocStats::default(),
                        $($metric: registry.register(mz_ore::metric!(
                            name: concat!(stringify!($namespace), "_", stringify!($metric)),
                            help: $desc,
                            var_labels: ["size_class"],
                        )),)*
                        $($f_metric: registry.register(mz_ore::metric!(
                            name: concat!(stringify!($namespace), "_", stringify!($f_metric)),
                            help: $f_desc,
                            var_labels: ["size_class"],
                        )),)*
                    }
                }
                fn get_size_class(&mut self, size_class: usize) -> &LgMetricsSC {
                    self.size_class.entry(size_class).or_insert_with(|| {
                        let labels: &[&str] = &[&size_class.to_string()];
                        LgMetricsSC {
                            $($metric: self.$metric.with_label_values(labels),)*
                            $($f_metric: self.$f_metric.with_label_values(labels),)*
                        }
                    })
                }
                fn update(&mut self) {
                    let mut stats = std::mem::take(&mut self.stats);
                    lgalloc::lgalloc_stats(&mut stats);
                    for sc in &stats.size_class {
                        let sc_stats = self.get_size_class(sc.size_class);
                        $(sc_stats.$metric.set(($conv)(u64::cast_from(sc.$name), sc));)*
                    }
                    let mut accums = BTreeMap::new();
                    for file_stat in &stats.file_stats {
                        let accum: &mut FileStatsAccum = accums.entry(file_stat.size_class).or_default();
                        accum.add_assign(file_stat);
                    }
                    for (size_class, accum) in accums {
                        let sc_stats = self.get_size_class(size_class);
                        $(sc_stats.$f_metric.set(u64::cast_from(accum.$f_name));)*
                    }
                    self.stats = stats;
                }
            }
        }
    };
}

fn normalize_by_size_class(value: u64, stats: &SizeClassStats) -> u64 {
    value * u64::cast_from(stats.size_class)
}

fn id(value: u64, _stats: &SizeClassStats) -> u64 {
    value
}

metrics_size_class! {
    mz_metrics_lgalloc
    @size_class (
        (allocations, "Number of region allocations in size class", allocations_total, id),
        (area_total_bytes, "Number of bytes in all areas in size class", area_total_bytes, id),
        (areas, "Number of areas backing size class", areas_total, id),
        (clean_regions, "Number of clean regions in size class", clean_regions_total, id),
        (clean_regions, "Number of clean regions in size class", clean_regions_bytes_total, normalize_by_size_class),
        (deallocations, "Number of region deallocations for size class", deallocations_total, id),
        (free_regions, "Number of free regions in size class", free_regions_total, id),
        (free_regions, "Number of free regions in size class", free_regions_bytes_total, normalize_by_size_class),
        (global_regions, "Number of global regions in size class", global_regions_total, id),
        (global_regions, "Number of global regions in size class", global_regions_bytes_total, normalize_by_size_class),
        (refill, "Number of area refills for size class", refill_total, id),
        (slow_path, "Number of slow path region allocations for size class", slow_path_total, id),
        (thread_regions, "Number of thread regions in size class", thread_regions_total, id),
        (thread_regions, "Number of thread regions in size class", thread_regions_bytes_total, normalize_by_size_class),
        (clear_eager_total, "Number of thread regions in size class", clear_eager_total, id),
        (clear_eager_total, "Number of thread regions in size class", clear_eager_bytes_total, normalize_by_size_class),
        (clear_slow_total, "Number of thread regions in size class", clear_slow_total, id),
        (clear_slow_total, "Number of thread regions in size class", clear_slow_bytes_total, normalize_by_size_class)
    )
    @file (
        (file_size, file_size_bytes, "Sum of file sizes in size class"),
        (allocated_size, file_allocated_size_bytes, "Sum of allocated sizes in size class"),
        (mapped, vm_mapped_bytes, "Sum of mapped sizes in size class"),
        (active, vm_active_bytes, "Sum of active sizes in size class"),
        (dirty, vm_dirty_bytes, "Sum of dirty sizes in size class")
    )
}

/// Register a task to read lgalloc stats.
#[allow(clippy::unused_async)]
pub async fn register_metrics_into(metrics_registry: &MetricsRegistry) {
    let mut lgmetrics = LgMetrics::new(metrics_registry);

    mz_ore::task::spawn(|| "lgalloc_stats_update", async move {
        let mut interval = tokio::time::interval(Duration::from_secs(30));
        interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
        loop {
            interval.tick().await;
            lgmetrics.update();
        }
    });
}