feature: add disk i/o time series chart

Author: ClementTsang

CHANGELOG.md

@@ -41,6 +41,7 @@ That said, these are more guidelines rather than hard rules, though the project
 - [#2053](https://github.com/ClementTsang/bottom/pull/2053): Add a configurable default sort column for the process widget (`processes.default_sort` or `--process-default-sort`).
 - [#2066](https://github.com/ClementTsang/bottom/pull/2066): Add search support in the help dialog.
 - [#1791](https://github.com/ClementTsang/bottom/pull/1791), [#2072](https://github.com/ClementTsang/bottom/pull/2072): Add support for using a short name for the GPU in memory usage.
+- [#2073](https://github.com/ClementTsang/bottom/pull/2073): Add disk I/O time series graph.
 
 ### Changes
 
@@ -53,6 +54,7 @@ That said, these are more guidelines rather than hard rules, though the project
 - [#2064](https://github.com/ClementTsang/bottom/pull/2064): Move CPU config file options from `[flags]` to be under `[cpu]`.
 - [#2064](https://github.com/ClementTsang/bottom/pull/2064): Move memory config file options from `[flags]` to be under `[memory_graph]`.
 - [#2066](https://github.com/ClementTsang/bottom/pull/2066): Take cgroup into account for CPU usage% calculations.
+- [#2074](https://github.com/ClementTsang/bottom/pull/2074): Treat uppercase 'Q' as a quit shortcut.
 
 ### Other
 

docs/content/configuration/config-file/disk-io-graph.md

@@ -0,0 +1 @@
+# Disk I/O Graph

docs/content/usage/widgets/disk-io-graph.md

@@ -0,0 +1 @@
+# Disk I/O Graph Widget

docs/mkdocs.yml

@@ -168,6 +168,7 @@ nav:
           - "Disk Widget": usage/widgets/disk.md
           - "Temperature Widget": usage/widgets/temperature-table.md
           - "Temperature Graph Widget": usage/widgets/temperature-graph.md
+          - "Disk I/O Graph Widget": usage/widgets/disk-io-graph.md
           - "Battery Widget": usage/widgets/battery.md
       - "Auto-Complete": usage/autocomplete.md
   - "Configuration":
@@ -181,6 +182,7 @@ nav:
           - "Processes Widget": configuration/config-file/processes.md
           - "Temperature Table Widget": configuration/config-file/temperature-table.md
           - "Temperature Graph Widget": configuration/config-file/temperature-graph.md
+          - "Disk I/O Graph Widget": configuration/config-file/disk-io-graph.md
           - "Flags": configuration/config-file/flags.md
           - "Layout": configuration/config-file/layout.md
           - "Styling": configuration/config-file/styling.md

src/app.rs

@@ -81,6 +81,7 @@ pub struct AppConfigFields {
     pub default_temp_sort_column: Option<TempWidgetColumn>,
     pub default_disk_sort_column: Option<DiskWidgetColumn>,
     pub temperature_legend_position: Option<LegendPosition>,
+    pub disk_io_legend_position: Option<LegendPosition>,
 }
 
 /// For filtering out information
@@ -2073,6 +2074,14 @@ impl App {
             {
                 Some(widget_state.graph.state_mut())
             }
+            BottomWidgetType::DiskIoGraph
+                if let Some(widget_state) = self
+                    .states
+                    .disk_io_graph_state
+                    .get_mut_widget_state(self.current_widget.widget_id) =>
+            {
+                Some(widget_state.graph.state_mut())
+            }
             _ => None,
         }
     }

src/app/data/store.rs

@@ -3,6 +3,8 @@ use std::{
     vec::Vec,
 };
 
+use rustc_hash::FxHashSet;
+
 use super::{ProcessData, TimeSeriesData};
 #[cfg(feature = "battery")]
 use crate::collection::batteries;
@@ -42,7 +44,7 @@ pub struct StoredData {
     pub process_data: ProcessData,
     /// TODO: (points_rework_v1) Might be a better way to do this without having
     /// to store here?
-    pub prev_io: Vec<(u64, u64)>,
+    pub prev_io: Vec<Option<(u64, u64)>>,
     pub disk_harvest: Vec<DiskWidgetData>,
     pub temp_data: Vec<TempWidgetData>,
     #[cfg(feature = "battery")]
@@ -153,6 +155,41 @@ impl StoredData {
         if let Some(disks) = data.disks {
             if let Some(io) = data.io {
                 self.eat_disks(disks, io, harvested_time);
+
+                if !settings.use_basic_mode && used_widgets.use_disk_graph {
+                    let mut not_visited: FxHashSet<String> =
+                        self.time_series_data.disk_io_read.keys().cloned().collect();
+
+                    for disk in &self.disk_harvest {
+                        not_visited.remove(&disk.name);
+
+                        macro_rules! push_or_break {
+                            ($map:expr, $val:expr) => {
+                                let entry = $map.entry(disk.name.clone()).or_default();
+                                match $val {
+                                    Some(v) => entry.push(v as f64),
+                                    None => entry.insert_break(),
+                                }
+                            };
+                        }
+
+                        push_or_break!(self.time_series_data.disk_io_read, disk.io_read_rate_bytes);
+                        push_or_break!(
+                            self.time_series_data.disk_io_write,
+                            disk.io_write_rate_bytes
+                        );
+                    }
+
+                    for name in not_visited {
+                        if let Some(entry) = self.time_series_data.disk_io_read.get_mut(&name) {
+                            entry.insert_break();
+                        }
+
+                        if let Some(entry) = self.time_series_data.disk_io_write.get_mut(&name) {
+                            entry.insert_break();
+                        }
+                    }
+                }
             }
         }
 
@@ -182,8 +219,11 @@ impl StoredData {
 
         let prev_io_diff = disks.len().saturating_sub(self.prev_io.len());
         self.prev_io.reserve(prev_io_diff);
-        self.prev_io.extend((0..prev_io_diff).map(|_| (0, 0)));
+        self.prev_io.extend((0..prev_io_diff).map(|_| None));
 
+        // FIXME: prev_io is indexed by position (itx), not by device name. If the OS
+        // ever returns disks in a different order between collections, rates will be
+        // silently computed against the wrong previous value. Should be keyed by name.
         for (itx, device) in disks.into_iter().enumerate() {
             let Some(checked_name) = ({
                 #[cfg(target_os = "windows")]
@@ -245,19 +285,21 @@ impl StoredData {
             let (mut io_read_rate_bytes, mut io_write_rate_bytes) = (None, None);
             if let Some(Some(io_device)) = io_device {
                 if let Some(prev_io) = self.prev_io.get_mut(itx) {
-                    io_read_rate_bytes = Some(
-                        ((io_device.read_bytes.saturating_sub(prev_io.0)) as f64
-                            / time_since_last_harvest)
-                            .round() as u64,
-                    );
-
-                    io_write_rate_bytes = Some(
-                        ((io_device.write_bytes.saturating_sub(prev_io.1)) as f64
-                            / time_since_last_harvest)
-                            .round() as u64,
-                    );
-
-                    *prev_io = (io_device.read_bytes, io_device.write_bytes);
+                    if let Some((prev_read, prev_write)) = *prev_io {
+                        io_read_rate_bytes = Some(
+                            ((io_device.read_bytes.saturating_sub(prev_read)) as f64
+                                / time_since_last_harvest)
+                                .round() as u64,
+                        );
+
+                        io_write_rate_bytes = Some(
+                            ((io_device.write_bytes.saturating_sub(prev_write)) as f64
+                                / time_since_last_harvest)
+                                .round() as u64,
+                        );
+                    }
+
+                    *prev_io = Some((io_device.read_bytes, io_device.write_bytes));
                 }
             }
 

src/app/data/time_series.rs

@@ -65,6 +65,12 @@ pub struct TimeSeriesData {
     ///
     /// TODO: Maybe make this use TypedTemperature?
     pub temperature: HashMap<String, ChunkedData<f32>>,
+
+    /// Disk I/O read rate data, keyed by device name.
+    pub disk_io_read: HashMap<String, ChunkedData<f64>>,
+
+    /// Disk I/O write rate data, keyed by device name.
+    pub disk_io_write: HashMap<String, ChunkedData<f64>>,
 }
 
 impl TimeSeriesData {
@@ -297,5 +303,27 @@ impl TimeSeriesData {
                 true
             }
         });
+
+        self.disk_io_read.retain(|_, data| {
+            let _ = data.prune(end);
+
+            if data.no_elements() {
+                false
+            } else {
+                data.shrink_to_fit();
+                true
+            }
+        });
+
+        self.disk_io_write.retain(|_, data| {
+            let _ = data.prune(end);
+
+            if data.no_elements() {
+                false
+            } else {
+                data.shrink_to_fit();
+                true
+            }
+        });
     }
 }

src/app/layout_manager.rs

@@ -943,6 +943,7 @@ pub enum BottomWidgetType {
     Temp,
     TempGraph,
     Disk,
+    DiskIoGraph,
     BasicCpu,
     BasicMem,
     BasicNet,
@@ -958,7 +959,7 @@ impl BottomWidgetType {
 
     pub fn is_widget_graph(&self) -> bool {
         use BottomWidgetType::*;
-        matches!(self, Cpu | Net | Mem | TempGraph)
+        matches!(self, Cpu | Net | Mem | TempGraph | DiskIoGraph)
     }
 
     pub fn get_pretty_name(&self) -> &str {
@@ -990,6 +991,7 @@ impl std::str::FromStr for BottomWidgetType {
             "temp" | "temperature" => Ok(BottomWidgetType::Temp),
             "temp_graph" | "temperature_graph" => Ok(BottomWidgetType::TempGraph),
             "disk" => Ok(BottomWidgetType::Disk),
+            "disk_io_graph" => Ok(BottomWidgetType::DiskIoGraph),
             "empty" => Ok(BottomWidgetType::Empty),
             #[cfg(feature = "battery")]
             "battery" | "batt" => Ok(BottomWidgetType::Battery),
@@ -1015,6 +1017,8 @@ Supported widget names:
 +--------------------------------+
 |              disk              |
 +--------------------------------+
+|          disk_io_graph         |
++--------------------------------+
 |          batt, battery         |
 +--------------------------------+
 |              empty             |
@@ -1043,6 +1047,8 @@ Supported widget names:
 +--------------------------------+
 |              disk              |
 +--------------------------------+
+|          disk_io_graph         |
++--------------------------------+
 |              empty             |
 +--------------------------------+
                 ",
@@ -1064,5 +1070,6 @@ pub struct UsedWidgets {
     pub use_disk: bool,
     pub use_temp: bool,
     pub use_temp_graph: bool,
+    pub use_disk_graph: bool,
     pub use_battery: bool,
 }

src/app/states.rs

@@ -5,8 +5,9 @@ use crate::{
     constants,
     utils::input::InputFieldState,
     widgets::{
-        BatteryWidgetState, CpuWidgetState, DiskTableWidget, MemWidgetState, NetWidgetState,
-        ProcWidgetState, TempGraphWidgetState, TempWidgetState, query::ProcessQuery,
+        BatteryWidgetState, CpuWidgetState, DiskIoGraphWidgetState, DiskTableWidget,
+        MemWidgetState, NetWidgetState, ProcWidgetState, TempGraphWidgetState, TempWidgetState,
+        query::ProcessQuery,
     },
 };
 
@@ -18,6 +19,7 @@ pub struct AppWidgetStates {
     pub temp_state: TempState,
     pub temp_graph_state: TempGraphStates,
     pub disk_state: DiskState,
+    pub disk_io_graph_state: DiskIoGraphStates,
     pub battery_state: AppBatteryState,
     pub basic_table_widget_state: Option<BasicTableWidgetState>,
 }
@@ -192,6 +194,21 @@ impl TempGraphStates {
     }
 }
 
+/// Holds per-widget state for all disk I/O graph instances in the layout.
+pub struct DiskIoGraphStates {
+    pub widget_states: HashMap<u64, DiskIoGraphWidgetState>,
+}
+
+impl DiskIoGraphStates {
+    pub fn init(widget_states: HashMap<u64, DiskIoGraphWidgetState>) -> Self {
+        DiskIoGraphStates { widget_states }
+    }
+
+    pub fn get_mut_widget_state(&mut self, widget_id: u64) -> Option<&mut DiskIoGraphWidgetState> {
+        self.widget_states.get_mut(&widget_id)
+    }
+}
+
 pub struct DiskState {
     pub widget_states: HashMap<u64, DiskTableWidget>,
 }

src/canvas.rs

@@ -281,6 +281,12 @@ impl Painter {
                         rect[0],
                         app_state.current_widget.widget_id,
                     ),
+                    DiskIoGraph => self.draw_disk_io_graph(
+                        f,
+                        app_state,
+                        rect[0],
+                        app_state.current_widget.widget_id,
+                    ),
                     _ => {}
                 }
             } else if app_state.app_config_fields.use_basic_mode {
@@ -401,6 +407,9 @@ impl Painter {
                                 vertical_chunks[3],
                                 widget_id,
                             ),
+                            DiskIoGraph => {
+                                self.draw_disk_io_graph(f, app_state, vertical_chunks[3], widget_id)
+                            }
                             _ => {}
                         }
                     }
@@ -482,6 +491,9 @@ impl Painter {
                     TempGraph => {
                         self.draw_temperature_graph(f, app_state, *draw_loc, widget.widget_id)
                     }
+                    DiskIoGraph => {
+                        self.draw_disk_io_graph(f, app_state, *draw_loc, widget.widget_id)
+                    }
                     _ => {}
                 }
             }