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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190

//! Bindings to `/proc/stat`.
use crate::{util, Error};
use std::{fs::File, io};

macro_rules! parse_single {
    ($name:expr) => {
        |input| {
            let (input, name) = util::parse_token(input).ok_or(Error::from("cannot read name"))?;
            if name != $name {
                return Err(Error::from(format!(
                    "incorrect name, expected: {}, actual: {}",
                    $name, name
                )));
            }
            let (input, value) = util::parse_u64(input).ok_or(Error::from("cannot read value"))?;
            let input = util::consume_space(input);
            if !input.is_empty() {
                return Err(Error::from("trailing content"));
            }
            Ok(value)
        }
    };
}

/// The stats from `/proc/stat`.
#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct Stat {
    /// Total stats, sum of all cpus.
    pub cpu_totals: StatCpu,
    /// For each cpu, the number of *units* spent in different contexts.
    pub cpus: Vec<StatCpu>,
    /// Number of context switches since the system booted.
    pub context_switches: u64,
    /// Timestamp (in seconds since epoch) that system booted.
    pub boot_time: u64,
    /// The total number of processes and threads created since system booted.
    pub processes: u64,
    /// The total number of processes running on the cpu.
    pub procs_running: u64,
    /// The total number of processes waiting to run on the cpu.
    pub procs_blocked: u64,
    // todo `softirq`
}

impl Stat {
    const PATH: &'static str = "/proc/stat";

    /// Parse the contents of `/proc/stat`.
    pub fn from_system() -> io::Result<Self> {
        Stat::from_reader(File::open(Self::PATH)?)
    }

    fn from_reader(reader: impl io::Read) -> io::Result<Self> {
        let mut reader = util::LineParser::new(reader);
        let cpu_totals = reader.parse_line(StatCpu::from_str)?;
        let mut cpus = Vec::new();
        loop {
            if let Ok(cpu_info) = reader.parse_line(StatCpu::from_str) {
                cpus.push(cpu_info);
            } else {
                break;
            }
        }
        reader.parse_line(util::parse_dummy)?;
        let context_switches = reader.parse_line(parse_single!("ctxt"))?;
        let boot_time = reader.parse_line(parse_single!("btime"))?;
        let processes = reader.parse_line(parse_single!("processes"))?;
        let procs_running = reader.parse_line(parse_single!("procs_running"))?;
        let procs_blocked = reader.parse_line(parse_single!("procs_blocked"))?;
        // todo softirq
        Ok(Stat {
            cpu_totals,
            cpus,
            context_switches,
            boot_time,
            processes,
            procs_running,
            procs_blocked,
        })
    }
}

/// Info about the number of *units* in the various cpu contexts.
///
/// *units* could be anything, for example cpu cycles, or hundredths of a second. The numbers only
/// really make sense as a proportion of the total.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct StatCpu {
    pub user: u64,
    pub nice: u64,
    pub system: u64,
    pub idle: u64,
    pub iowait: u64,
    pub irq: u64,
    pub softirq: u64,
    pub steal: Option<u64>,
    pub guest: Option<u64>,
    pub guest_nice: Option<u64>,
}

macro_rules! err_msg {
    ($inner:expr, $msg:expr) => {
        $inner.ok_or_else(|| Error::from($msg))
    };
}

impl StatCpu {
    fn from_str(input: &str) -> Result<StatCpu, Error> {
        let (input, cpunum) = err_msg!(util::parse_token(input), "first token")?;
        if !cpunum.starts_with("cpu") {
            return Err("starts with cpu<x>".into());
        }

        let (input, user) = err_msg!(util::parse_u64(input), "user")?;
        let (input, nice) = err_msg!(util::parse_u64(input), "nice")?;
        let (input, system) = err_msg!(util::parse_u64(input), "system")?;
        let (input, idle) = err_msg!(util::parse_u64(input), "idle")?;
        let (input, iowait) = err_msg!(util::parse_u64(input), "iowait")?;
        let (input, irq) = err_msg!(util::parse_u64(input), "irq")?;
        let (input, softirq) = err_msg!(util::parse_u64(input), "softirq")?;
        // Following are optional fields
        let (input, steal) = match util::parse_u64(input) {
            Some((i, steal)) => (i, Some(steal)),
            None => (input, None),
        };
        let (input, guest) = match util::parse_u64(input) {
            Some((i, guest)) => (i, Some(guest)),
            None => (input, None),
        };
        let (_, guest_nice) = match util::parse_u64(input) {
            Some((i, guest_nice)) => (i, Some(guest_nice)),
            None => (input, None),
        };
        // We don't check remaining content as future linux may add extra columns.
        Ok(StatCpu {
            user,
            nice,
            system,
            idle,
            iowait,
            irq,
            softirq,
            steal,
            guest,
            guest_nice,
        })
    }

    /// Convenience function to add up all cpu values.
    pub fn total(&self) -> u64 {
        self.user
            .checked_add(self.nice)
            .unwrap()
            .checked_add(self.system)
            .unwrap()
            .checked_add(self.idle)
            .unwrap()
            .checked_add(self.iowait)
            .unwrap()
            .checked_add(self.irq)
            .unwrap()
            .checked_add(self.softirq)
            .unwrap()
            .checked_add(self.steal.unwrap_or(0))
            .unwrap()
            .checked_add(self.guest.unwrap_or(0))
            .unwrap()
            .checked_add(self.guest_nice.unwrap_or(0))
            .unwrap()
    }
}

#[test]
fn test_stat() {
    let raw = "\
cpu  17501 2 6293 8212469 20141 1955 805 0 0 0
cpu0 4713 0 1720 2049410 8036 260 255 0 0 0
cpu1 3866 0 1325 2054893 3673 928 307 0 0 0
cpu2 4966 1 1988 2051243 5596 516 141 0 0 0
cpu3 3955 0 1258 2056922 2835 250 100 0 0 0
intr 1015182 8 8252 0 0 0 0 0 0 1 113449 0 0 198907 0 0 0 18494 0 0 1 0 0 0 29 22 7171 46413 13 0 413 167 528 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
ctxt 2238717
btime 1535128607
processes 2453
procs_running 1
procs_blocked 0
softirq 4257581 64 299604 69 2986 36581 0 3497229 283111 0 137937
";
    let _stat = Stat::from_reader(io::Cursor::new(raw)).unwrap();
}