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
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

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

use std::collections::HashMap;

use derive_more::{Add, Sub, Sum};

use crate::network::net_io_counters_pernic;
use crate::{Bytes, Count, Result};

#[cfg_attr(feature = "serde", serde(crate = "renamed_serde"))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Clone, Debug, Add, Sum, Sub)]
pub struct NetIoCounters {
	pub(crate) bytes_sent: Bytes,
	pub(crate) bytes_recv: Bytes,
	pub(crate) packets_sent: Count,
	pub(crate) packets_recv: Count,
	pub(crate) err_in: Count,
	pub(crate) err_out: Count,
	pub(crate) drop_in: Count,
	pub(crate) drop_out: Count,
}

impl NetIoCounters {
	/// Number of bytes sent.
	pub fn bytes_sent(&self) -> Bytes {
		self.bytes_sent
	}

	/// Number of bytes received.
	pub fn bytes_recv(&self) -> Bytes {
		self.bytes_recv
	}

	/// Number of packets sent.
	pub fn packets_sent(&self) -> Count {
		self.packets_sent
	}

	/// Number of packets received.
	pub fn packets_recv(&self) -> Count {
		self.packets_recv
	}

	/// Total number of errors while receiving.
	/// Renamed from `errin` in Python psutil.
	pub fn err_in(&self) -> Count {
		self.err_in
	}

	/// Total number of errors while sending.
	/// Renamed from `errout` in Python psutil.
	pub fn err_out(&self) -> Count {
		self.err_out
	}

	/// Total number of incoming packets which were dropped.
	/// Renamed from `dropin` in Python psutil.
	pub fn drop_in(&self) -> Count {
		self.drop_in
	}

	/// Total number of outgoing packets which were dropped (always 0 on macOS and BSD).
	/// Renamed from `dropout` in Python psutil.
	pub fn drop_out(&self) -> Count {
		self.drop_out
	}
}

fn nowrap(prev: u64, current: u64, corrected: u64) -> u64 {
	if current >= prev {
		corrected + (current - prev)
	} else {
		corrected + current + ((u32::MAX as u64) - prev)
	}
}

fn nowrap_struct(
	prev: &NetIoCounters,
	current: &NetIoCounters,
	corrected: &NetIoCounters,
) -> NetIoCounters {
	NetIoCounters {
		bytes_sent: nowrap(prev.bytes_sent, current.bytes_sent, corrected.bytes_sent),
		bytes_recv: nowrap(prev.bytes_recv, current.bytes_recv, corrected.bytes_recv),
		packets_sent: nowrap(
			prev.packets_sent,
			current.packets_sent,
			corrected.packets_sent,
		),
		packets_recv: nowrap(
			prev.packets_recv,
			current.packets_recv,
			corrected.packets_recv,
		),
		err_in: nowrap(prev.err_in, current.err_in, corrected.err_in),
		err_out: nowrap(prev.err_out, current.err_out, corrected.err_out),
		drop_in: nowrap(prev.drop_in, current.drop_in, corrected.drop_in),
		drop_out: nowrap(prev.drop_out, current.drop_out, corrected.drop_out),
	}
}

fn fix_io_counter_overflow(
	prev: &HashMap<String, NetIoCounters>,
	current: &HashMap<String, NetIoCounters>,
	corrected: &HashMap<String, NetIoCounters>,
) -> HashMap<String, NetIoCounters> {
	current
		.iter()
		.map(|(name, current_counters)| {
			if !prev.contains_key(name) || !corrected.contains_key(name) {
				(name.clone(), current_counters.clone())
			} else {
				let prev_counters = &prev[name];
				let corrected_counters = &corrected[name];

				(
					name.clone(),
					nowrap_struct(prev_counters, current_counters, corrected_counters),
				)
			}
		})
		.collect()
}

/// Used to persist data between calls to detect data overflow by the kernel and fix the result.
#[derive(Debug, Clone, Default)]
pub struct NetIoCountersCollector {
	prev_net_io_counters_pernic: Option<HashMap<String, NetIoCounters>>,
	corrected_net_io_counters_pernic: Option<HashMap<String, NetIoCounters>>,
}

impl NetIoCountersCollector {
	pub fn net_io_counters(&mut self) -> Result<NetIoCounters> {
		let sum = self.net_io_counters_pernic()?.into_values().sum();

		Ok(sum)
	}

	pub fn net_io_counters_pernic(&mut self) -> Result<HashMap<String, NetIoCounters>> {
		let io_counters = net_io_counters_pernic()?;

		let corrected_counters = match (
			&self.prev_net_io_counters_pernic,
			&self.corrected_net_io_counters_pernic,
		) {
			(Some(prev), Some(corrected)) => fix_io_counter_overflow(prev, &io_counters, corrected),
			_ => io_counters.clone(),
		};

		self.prev_net_io_counters_pernic = Some(io_counters);
		self.corrected_net_io_counters_pernic = Some(corrected_counters.clone());

		Ok(corrected_counters)
	}
}