re_memory 0.32.0-alpha.1

Run-time memory tracking and profiling.
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

/// Amount of available RAM on this machine.
#[cfg(not(target_arch = "wasm32"))]
pub fn total_ram_in_bytes() -> Option<u64> {
    re_tracing::profile_function!();

    let mut sys = sysinfo::System::new_with_specifics(
        sysinfo::RefreshKind::nothing()
            .with_memory(sysinfo::MemoryRefreshKind::nothing().with_ram()),
    );

    {
        re_tracing::profile_scope!("refresh_memory");
        sys.refresh_memory();
    }

    let bytes = sys.total_memory();
    if bytes == 0 { None } else { Some(bytes) }
}

/// Amount of available RAM on this machine.
#[cfg(target_arch = "wasm32")]
pub fn total_ram_in_bytes() -> Option<u64> {
    #![expect(clippy::unnecessary_wraps)]
    Some(1_u64 << 32)
}

// ----------------------------------------------------------------------------

/// Helper to warn if we are using too much RAM.
///
/// You need to call [`RamLimitWarner::update`] regularly.
pub struct RamLimitWarner {
    total_ram_in_bytes: u64,
    warn_limit: u64,
    has_warned: bool,
}

impl RamLimitWarner {
    pub fn warn_at_fraction_of_max(fraction: f32) -> Self {
        if let Some(total_ram_in_bytes) = total_ram_in_bytes() {
            let limit = (fraction as f64 * total_ram_in_bytes as f64).round() as _;
            Self {
                total_ram_in_bytes,
                warn_limit: limit,
                has_warned: false,
            }
        } else {
            re_log::warn_once!("Failed to figure out how much RAM this machine has");
            Self {
                total_ram_in_bytes: 0,
                warn_limit: 0,
                has_warned: true,
            }
        }
    }

    /// Warns if we have exceeded the limit.
    pub fn update(&mut self) {
        if !self.has_warned {
            let used = crate::MemoryUse::capture();
            let used = used.counted.or(used.resident);
            if let Some(used) = used
                && self.warn_limit <= used
            {
                self.has_warned = true;
                re_log::warn!(
                    "RAM usage is {} (with a total of {} system RAM). You may want to start Rerun with the --memory-limit flag to limit RAM usage.",
                    re_format::format_bytes(used as _),
                    re_format::format_bytes(self.total_ram_in_bytes as _),
                );
            }
        }
    }
}