Warn when most of the RAM has been used up by Rerun (#1651)

* Warn when most of the RAM has been used up by Rerun

Unless the `--memory-limit` is already set, we now warn and suggest
setting it when Rerun is using 75% of all available RAM by itself.

* On web, always purge memory after 3.5 GB

* typos fix

* fix clppy

crates/re_memory/Cargo.toml

@@ -33,6 +33,7 @@ smallvec = "1.10"
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 backtrace = "0.3"
 memory-stats = "1.0"
+sysinfo = { version = "0.28.3", default-features = false }
 
 # web dependencies:
 [target.'cfg(target_arch = "wasm32")'.dependencies]

crates/re_memory/src/lib.rs

@@ -7,6 +7,7 @@ mod allocation_tracker;
 mod memory_history;
 mod memory_limit;
 mod memory_use;
+mod ram_warner;
 pub mod util;
 
 #[cfg(not(target_arch = "wasm32"))]
@@ -23,7 +24,7 @@ use backtrace_web::Backtrace;
 
 pub use {
     accounting_allocator::AccountingAllocator, memory_history::MemoryHistory,
-    memory_limit::MemoryLimit, memory_use::MemoryUse,
+    memory_limit::MemoryLimit, memory_use::MemoryUse, ram_warner::*,
 };
 
 /// Number of allocation and their total size.

crates/re_memory/src/ram_warner.rs

@@ -0,0 +1,61 @@
+/// Amount of available RAM on this machine.
+#[cfg(not(target_arch = "wasm32"))]
+pub fn total_ram_in_bytes() -> u64 {
+    use sysinfo::SystemExt as _;
+
+    let mut sys = sysinfo::System::new_all();
+    sys.refresh_all();
+
+    let total_memory = sys.total_memory();
+
+    re_log::debug!(
+        "Total RAM: {}",
+        re_format::format_bytes(sys.total_memory() as _)
+    );
+
+    total_memory
+}
+
+/// Amount of available RAM on this machine.
+#[cfg(target_arch = "wasm32")]
+pub fn total_ram_in_bytes() -> u64 {
+    1_u64 << 32
+}
+
+// ----------------------------------------------------------------------------
+
+pub struct RamLimitWarner {
+    total_ram_in_bytes: u64,
+    limit: u64,
+    has_warned: bool,
+}
+
+impl RamLimitWarner {
+    pub fn warn_at_fraction_of_max(fraction: f32) -> Self {
+        let 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,
+            limit,
+            has_warned: false,
+        }
+    }
+
+    /// 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 {
+                if 0 <= used && self.limit <= used as u64 {
+                    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 _),
+                    );
+                }
+            }
+        }
+    }
+}

crates/re_viewer/Cargo.toml

@@ -99,8 +99,8 @@ rfd = "0.11"
 serde = { version = "1", features = ["derive"] }
 slotmap = { version = "1.0.6", features = ["serde"] }
 smallvec = { version = "1.10", features = ["serde"] }
-time = { workspace = true, default-features = false, features = ["formatting"] }
 thiserror.workspace = true
+time = { workspace = true, default-features = false, features = ["formatting"] }
 uuid = { version = "1.1", features = ["serde", "v4", "js"] }
 vec1 = "1.8"
 wgpu.workspace = true

crates/re_viewer/src/app.rs

@@ -57,6 +57,7 @@ const MAX_ZOOM_FACTOR: f32 = 4.0;
 pub struct App {
     build_info: re_build_info::BuildInfo,
     startup_options: StartupOptions,
+    ram_limit_warner: re_memory::RamLimitWarner,
     re_ui: re_ui::ReUi,
 
     /// Listens to the local text log stream
@@ -127,6 +128,7 @@ impl App {
         Self {
             build_info,
             startup_options,
+            ram_limit_warner: re_memory::RamLimitWarner::warn_at_fraction_of_max(0.75),
             re_ui,
             text_log_rx,
             component_ui_registry: Default::default(),
@@ -416,6 +418,11 @@ impl eframe::App for App {
     fn update(&mut self, egui_ctx: &egui::Context, frame: &mut eframe::Frame) {
         let frame_start = Instant::now();
 
+        if self.startup_options.memory_limit.limit.is_none() {
+            // we only warn about high memory usage if the user hasn't specified a limit
+            self.ram_limit_warner.update();
+        }
+
         if self.icon_status == AppIconStatus::NotSetTryAgain {
             self.icon_status = setup_app_icon();
         }

crates/re_viewer/src/web.rs

@@ -33,7 +33,12 @@ pub async fn start(
         Box::new(move |cc| {
             let build_info = re_build_info::build_info!();
             let app_env = crate::AppEnvironment::Web;
-            let startup_options = crate::StartupOptions::default();
+            let startup_options = crate::StartupOptions {
+                memory_limit: re_memory::MemoryLimit {
+                    // On wasm32 we only have 4GB of memory to play around with.
+                    limit: Some(3_500_000_000),
+                },
+            };
             let re_ui = crate::customize_eframe(cc);
             let url = url.unwrap_or_else(|| get_url(&cc.integration_info));