bottom 0.13.0

A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows.
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
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

//! Collecting memory data using sysinfo.

use std::num::NonZeroU64;

use crate::collection::{DataCollector, memory::MemData};

#[inline]
fn get_usage(used: u64, total: u64) -> Option<MemData> {
    NonZeroU64::new(total).map(|total_bytes| MemData {
        total_bytes,
        used_bytes: used,
    })
}

/// Returns memory (RAM) usage using sysinfo.
///
/// On Linux, this will take cgroup usage/limits into account.
pub(crate) fn get_ram_usage(collector: &DataCollector) -> Option<MemData> {
    let sys = &collector.sys.system;

    cfg_if::cfg_if! {
        if #[cfg(target_os = "linux")] {
            use crate::collection::linux::cgroups;

            let base_used = sys.used_memory();
            let base_total = sys.total_memory();

            let (used, total) = match &collector.cgroup_memory_data.ram {
                Some(cgroup_data) => {
                    let used = cgroup_data.used_bytes;
                    let total = match cgroup_data.limit {
                        Some(cgroups::CgroupMemLimit::Bytes(bytes)) => bytes,
                        Some(cgroups::CgroupMemLimit::Max) => base_total,
                        None => base_total,
                    };

                    (used, total)
                }
                None => (base_used, base_total),
            };

            get_usage(used, total)
        } else {
            get_usage(sys.used_memory(), sys.total_memory())
        }
    }
}

/// Returns SWAP usage using sysinfo.
///
/// On Linux, this will take cgroup usage/limits into account.
#[cfg(not(target_os = "windows"))]
pub(crate) fn get_swap_usage(collector: &DataCollector) -> Option<MemData> {
    let sys = &collector.sys.system;

    cfg_if::cfg_if! {
        if #[cfg(target_os = "linux")] {
            use crate::collection::linux::cgroups;

            let base_used = sys.used_swap();
            let base_total = sys.total_swap();

            let (used, total) = match &collector.cgroup_memory_data.swap {
                Some(cgroup_data) => {
                    let used = cgroup_data.used_bytes;
                    let total = match cgroup_data.limit {
                        Some(cgroups::CgroupMemLimit::Bytes(bytes)) => bytes,
                        Some(cgroups::CgroupMemLimit::Max) => base_total,
                        None => base_total,
                    };

                    (used, total)
                }
                None => (base_used, base_total),
            };

            get_usage(used, total)
        } else {
            get_usage(sys.used_swap(), sys.total_swap())
        }
    }
}

/// Returns cache usage using sysinfo.
///
/// sysinfo has no way to do this directly but it should equal the difference
/// between the available and free memory. Free memory is defined as memory
/// not containing any data, which means cache and buffer memory are not
/// "free". Available memory is defined as memory able to be allocated by
/// processes, which includes cache and buffer memory. On Windows, this will
/// always be 0.
///
/// For more information, see [sysinfo docs](https://docs.rs/sysinfo/latest/sysinfo/struct.System.html#method.available_memory)
/// and [this explanation on memory](https://askubuntu.com/questions/867068/what-is-available-memory-while-using-free-command)
#[cfg(not(target_os = "windows"))]
pub(crate) fn get_cache_usage(sys: &sysinfo::System) -> Option<MemData> {
    let mem_used = sys.available_memory().saturating_sub(sys.free_memory());
    let mem_total = sys.total_memory();

    get_usage(mem_used, mem_total)
}