proxmox-mirrors/proxmox
1
0
Fork 1
mirror of https://git.proxmox.com/git/proxmox synced 2025-04-28 20:29:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

sys: add doc-comments for ProcFsMemInfo type

Browse Source 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2025-04-07 20:40:10 +02:00
parent 58d6e8d492
commit a3381b6197
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
proxmox-sys/src/linux/procfs/mod.rs
View File

@ -405,13 +405,26 @@ fn test_read_proc_stat() {
}
#[derive(Debug, Serialize)]
/// Memory stats relevant for Proxmox projects.
///
/// NOTE: Unlike the name would suggest this is not a 1:1 representation of /proc/meminfo and also
/// includes some other metrics like KSM shared pages gathered from sysfs.
/// Ensure this is what you want if you return this type from your code for others to consume.
pub struct ProcFsMemInfo {
/// Total usable RAM, i.e. installed memory minus bad regions and kernel binary code.
pub memtotal: u64,
/// Memory that's guaranteed completely unused, almost always quite a bit smaller than the
/// amount of memory actually available for programs.
pub memfree: u64,
/// Calculated from subtracting MemAvailable from MemTotal.
pub memused: u64,
/// Memory shared through the Kernel Same-Page Merging mechanism. Metric gathered from sysfs.
pub memshared: u64,
/// Total amount of swap space available.
pub swaptotal: u64,
//// Amount of swap space that is currently unused.
pub swapfree: u64,
/// Used swap, i.e., swaptotal - swapfree.
pub swapused: u64,
}