polkadot_overseer/
memory_stats.rs

1// Copyright (C) Parity Technologies (UK) Ltd.
2// This file is part of Polkadot.
3
4// Polkadot is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8
9// Polkadot is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12// GNU General Public License for more details.
13
14// You should have received a copy of the GNU General Public License
15// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
16
17use tikv_jemalloc_ctl::stats;
18
19#[derive(Clone)]
20pub struct MemoryAllocationTracker {
21	epoch: tikv_jemalloc_ctl::epoch_mib,
22	allocated: stats::allocated_mib,
23	resident: stats::resident_mib,
24}
25
26impl MemoryAllocationTracker {
27	pub fn new() -> Result<Self, tikv_jemalloc_ctl::Error> {
28		Ok(Self {
29			epoch: tikv_jemalloc_ctl::epoch::mib()?,
30			allocated: stats::allocated::mib()?,
31			resident: stats::resident::mib()?,
32		})
33	}
34
35	pub fn snapshot(&self) -> Result<MemoryAllocationSnapshot, tikv_jemalloc_ctl::Error> {
36		// update stats by advancing the allocation epoch
37		self.epoch.advance()?;
38
39		let allocated = self.allocated.read()?;
40		let resident = self.resident.read()?;
41		Ok(MemoryAllocationSnapshot { allocated, resident })
42	}
43}
44
45/// Snapshot of collected memory metrics.
46#[non_exhaustive]
47#[derive(Debug, Clone)]
48pub struct MemoryAllocationSnapshot {
49	/// Total resident memory, in bytes.
50	pub resident: usize,
51	/// Total allocated memory, in bytes.
52	pub allocated: usize,
53}
polkadot_overseer/memory_stats.rs

polkadot_overseer/
memory_stats.rs
