psutil 5.4.0

Process and system monitoring library
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

use std::ops::Sub;
use std::time::Duration;

/// Every attribute represents the seconds the CPU has spent in the given mode.
#[cfg_attr(feature = "serde", serde(crate = "renamed_serde"))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CpuTimes {
	pub(crate) user: Duration,
	pub(crate) system: Duration,
	pub(crate) idle: Duration,
	pub(crate) nice: Duration,

	#[cfg(target_os = "linux")]
	pub(crate) iowait: Duration,
	#[cfg(target_os = "linux")]
	pub(crate) irq: Duration,
	#[cfg(target_os = "linux")]
	pub(crate) softirq: Duration,
	#[cfg(target_os = "linux")]
	pub(crate) steal: Option<Duration>,
	#[cfg(target_os = "linux")]
	pub(crate) guest: Option<Duration>,
	#[cfg(target_os = "linux")]
	pub(crate) guest_nice: Option<Duration>,
}

impl CpuTimes {
	/// Time spent by normal processes executing in user mode;
	/// on Linux this also includes guest time.
	pub fn user(&self) -> Duration {
		self.user
	}

	/// Time spent by processes executing in kernel mode.
	pub fn system(&self) -> Duration {
		self.system
	}

	/// Time spent doing nothing.
	pub fn idle(&self) -> Duration {
		#[cfg(target_os = "linux")]
		{
			self.idle + self.iowait
		}
		#[cfg(target_os = "macos")]
		{
			self.idle
		}
		#[cfg(not(any(target_os = "linux", target_os = "macos")))]
		{
			todo!()
		}
	}

	/// New method, not in Python psutil.
	pub fn busy(&self) -> Duration {
		#[cfg(target_os = "linux")]
		{
			// On Linux guest times are already accounted in "user" or "nice" times.
			// https://github.com/giampaolo/psutil/blob/e65cc95de72828caed74c7916530dd74fca351e3/psutil/__init__.py#L1653
			self.user
				+ self.system
				+ self.nice + self.irq
				+ self.softirq
				+ self.steal.unwrap_or_default()
		}
		#[cfg(target_os = "macos")]
		{
			self.user + self.system + self.nice
		}
		#[cfg(not(any(target_os = "linux", target_os = "macos")))]
		{
			todo!()
		}
	}

	/// New method, not in Python psutil.
	pub fn total(&self) -> Duration {
		self.busy() + self.idle()
	}
}

impl Sub for &CpuTimes {
	type Output = CpuTimes;

	fn sub(self, other: Self) -> Self::Output {
		CpuTimes {
			// have to use `checked_sub` since CPU times can decrease over time on some platforms
			// https://github.com/giampaolo/psutil/blob/e65cc95de72828caed74c7916530dd74fca351e3/psutil/__init__.py#L1687
			user: self.user.checked_sub(other.user).unwrap_or_default(),
			system: self.system.checked_sub(other.system).unwrap_or_default(),
			idle: self.idle.checked_sub(other.idle).unwrap_or_default(),
			nice: self.nice.checked_sub(other.nice).unwrap_or_default(),

			#[cfg(target_os = "linux")]
			iowait: self.iowait.checked_sub(other.iowait).unwrap_or_default(),
			#[cfg(target_os = "linux")]
			irq: self.irq.checked_sub(other.irq).unwrap_or_default(),
			#[cfg(target_os = "linux")]
			softirq: self.softirq.checked_sub(other.softirq).unwrap_or_default(),
			#[cfg(target_os = "linux")]
			steal: self.steal.and_then(|first| {
				other
					.steal
					.map(|second| first.checked_sub(second).unwrap_or_default())
			}),
			#[cfg(target_os = "linux")]
			guest: self.guest.and_then(|first| {
				other
					.guest
					.map(|second| first.checked_sub(second).unwrap_or_default())
			}),
			#[cfg(target_os = "linux")]
			guest_nice: self.guest_nice.and_then(|first| {
				other
					.guest_nice
					.map(|second| first.checked_sub(second).unwrap_or_default())
			}),
		}
	}
}