linux-support 0.0.25

Comprehensive Linux support for namespaces, cgroups, processes, scheduling, parsing /proc, parsing /sys, signals, hyper threads, CPUS, NUMA nodes, unusual file descriptors, PCI devices and much, much more
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

// This file is part of linux-support. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/linux-support/master/COPYRIGHT. No part of linux-support, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2020 The developers of linux-support. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/linux-support/master/COPYRIGHT.


/// A receive queue reference to a folder `/sys/class/net/<network_interface_name>/queues/rx-<N>` where `N` is `queue_identifier`.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ReceiveSysfsQueue<'a>
{
	network_interface_name: &'a NetworkInterfaceName,
	
	queue_identifier: QueueIdentifier,
}

impl<'a> SysfsQueue<'a> for ReceiveSysfsQueue<'a>
{
	const Prefix: &'static str = "rx";
	
	fn new(network_interface_name: &'a NetworkInterfaceName, queue_identifier: QueueIdentifier) -> Self
	{
		Self
		{
			network_interface_name,
			queue_identifier,
		}
	}
	
	#[inline(always)]
	fn network_interface_name(&self) -> &'a NetworkInterfaceName
	{
		self.network_interface_name
	}
	
	#[inline(always)]
	fn queue_identifier(&self) -> QueueIdentifier
	{
		self.queue_identifier
	}
}

impl<'a> ReceiveSysfsQueue<'a>
{
	
	/// Receive Packet Steering (RPS) affinity.
	///
	/// Default is `HyperThreads::empty()`.
	#[inline(always)]
	pub fn receive_packet_steering_affinity(&self, sys_path: &SysPath) -> io::Result<HyperThreads>
	{
		self.rps_cpus_file_path(sys_path).parse_comma_separated_bit_set().map(HyperThreads)
	}
	
	/// Set Receive Packet Steering (RPS) affinity.
	///
	/// Default is `HyperThreads::empty()`.
	#[inline(always)]
	pub fn set_receive_packet_steering_affinity(&self, sys_path: &SysPath, hyper_threads: &HyperThreads) -> io::Result<()>
	{
		assert_effective_user_id_is_root("write /sys/class/net/<network_interface_name>/queues/rx-<queue_identifier/rps_cpus");
		
		let file_path = self.rps_cpus_file_path(sys_path);
		
		if file_path.exists()
		{
			let mask = IntoBitMask(hyper_threads);
			file_path.write_value(mask)
		}
		else
		{
			Ok(())
		}
	}
	
	/// Receive Packet Steering (RPS) flow table count.
	///
	/// The flow table count is the maximum number of Receive Packet Steering (RPS) flows for a receive queue.
	///
	/// Default is `0`.
	#[inline(always)]
	pub fn receive_packet_steering_flow_table_count(&self, sys_path: &SysPath) -> io::Result<usize>
	{
		self.rps_flow_cnt_file_path(sys_path).read_value()
	}
	
	/// Set Receive Packet Steering (RPS) flow table count.
	///
	/// The flow table count is the maximum number of Receive Packet Steering (RPS) flows for a receive queue.
	///
	/// Default is `0`.
	#[inline(always)]
	pub fn set_receive_packet_steering_flow_table_count(&self, sys_path: &SysPath, flow_table_count: usize) -> io::Result<()>
	{
		assert_effective_user_id_is_root("write /sys/class/net/<network_interface_name>/queues/rx-<queue_identifier/rps_flow_cnt");
		
		let file_path = self.rps_flow_cnt_file_path(sys_path);
		
		if file_path.exists()
		{
			file_path.write_value(UnpaddedDecimalInteger(flow_table_count))
		}
		else
		{
			Ok(())
		}
	}
	
	#[inline(always)]
	fn rps_flow_cnt_file_path(&self, sys_path: &SysPath) -> PathBuf
	{
		self.file_path(sys_path, "rps_flow_cnt")
	}
	
	#[inline(always)]
	fn rps_cpus_file_path(&self, sys_path: &SysPath) -> PathBuf
	{
		self.file_path(sys_path, "rps_cpus")
	}
}