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
118

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


/// Coalesce configuration.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[derive(Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct CoalesceConfiguration
{
	/// Adaptive coalescing.
	///
	/// If `Some` then the driver must support either `ETHTOOL_COALESCE_USE_ADAPTIVE_RX` or `ETHTOOL_COALESCE_USE_ADAPTIVE_TX` or both.
	#[serde(default)] pub adaptive_coalescing: Option<AdaptiveCoalescingConfiguration>,
	
	/// Normal settings.
	///
	/// Driver must support:-
	///
	/// * `ETHTOOL_COALESCE_RX_USECS` if `ReceiveTransmitCoalescing.Receive.microseconds` is `Some`.
	/// * `ETHTOOL_COALESCE_RX_MAX_FRAMES` to change `ReceiveTransmitCoalescing.Receive.maximum_frames` is `Some`.
	/// * `ETHTOOL_COALESCE_TX_USECS` if `ReceiveTransmitCoalescing.Receive.microseconds` is `Some`.
	/// * `ETHTOOL_COALESCE_TX_MAX_FRAMES` to change `ReceiveTransmitCoalescing.Receive.maximum_frames` is `Some`.
	pub receive_transmit: ReceiveTransmitCoalescing,
	
	/// Settings to used if an IRQ (interrupt request) is being serviced by the host.
	///
	/// Driver must support:-
	///
	/// * `ETHTOOL_COALESCE_RX_USECS_IRQ` if `ReceiveTransmitCoalescing.Receive.microseconds` is `Some`.
	/// * `ETHTOOL_COALESCE_RX_MAX_FRAMES_IRQ` to change `ReceiveTransmitCoalescing.Receive.maximum_frames` is `Some`.
	/// * `ETHTOOL_COALESCE_TX_USECS_IRQ` if `ReceiveTransmitCoalescing.Receive.microseconds` is `Some`.
	/// * `ETHTOOL_COALESCE_TX_MAX_FRAMES_IRQ` to change `ReceiveTransmitCoalescing.Receive.maximum_frames` is `Some`.
	pub receive_transmit_whilst_irq_is_being_serviced_by_the_host: ReceiveTransmitCoalescing,
	
	/// Threshold.
	///
	/// Driver must support `ETHTOOL_COALESCE_PKT_RATE_LOW` if is `Some`.
	#[serde(default)] pub low_packet_rate_packets_per_second_threshold: Option<NonZeroU32>,
	
	/// Settings to apply if the `low_packet_rate_packets_per_second_threshold` is met.
	///
	/// Driver must support:-
	///
	/// * `ETHTOOL_COALESCE_RX_USECS_LOW` if `ReceiveTransmitCoalescing.Receive.microseconds` is `Some`.
	/// * `ETHTOOL_COALESCE_RX_MAX_FRAMES_LOW` to change `ReceiveTransmitCoalescing.Receive.maximum_frames` is `Some`.
	/// * `ETHTOOL_COALESCE_TX_USECS_LOW` if `ReceiveTransmitCoalescing.Receive.microseconds` is `Some`.
	/// * `ETHTOOL_COALESCE_TX_MAX_FRAMES_LOW` to change `ReceiveTransmitCoalescing.Receive.maximum_frames` is `Some`.
	pub receive_transmit_at_low_packet_rate: ReceiveTransmitCoalescing,
	
	/// Threshold.
	///
	/// Driver must support `ETHTOOL_COALESCE_PKT_RATE_HIGH` if is `Some`.
	#[serde(default)] pub high_packet_rate_packets_per_second_threshold: Option<NonZeroU32>,
	
	/// Settings to apply if the `high_packet_rate_packets_per_second_threshold` is met.
	///
	/// Driver must support:-
	///
	/// * `ETHTOOL_COALESCE_RX_USECS_HIGH` if `ReceiveTransmitCoalescing.Receive.microseconds` is `Some`.
	/// * `ETHTOOL_COALESCE_RX_MAX_FRAMES_HIGH` to change `ReceiveTransmitCoalescing.Receive.maximum_frames` is `Some`.
	/// * `ETHTOOL_COALESCE_TX_USECS_HIGH` if `ReceiveTransmitCoalescing.Receive.microseconds` is `Some`.
	/// * `ETHTOOL_COALESCE_TX_MAX_FRAMES_HIGH` to change `ReceiveTransmitCoalescing.Receive.maximum_frames` is `Some`.
	pub receive_transmit_at_high_packet_rate: ReceiveTransmitCoalescing,
	
	/// How many microseconds to delay in-memory statistics block updates.
	///
	/// Some drivers do not have an	in-memory statistic block, and in such cases this value is ignored.
	///
	/// This value must not be zero.
	///
	/// Driver must support `ETHTOOL_COALESCE_STATS_BLOCK_USECS`.
	#[serde(default)] pub statistics_block_coalesce_microseconds: Option<NonZeroU32>,
}

impl CoalesceConfiguration
{
	#[inline(always)]
	pub(crate) fn as_ethtool_coalesce(&self) -> ethtool_coalesce
	{
		let (rate_sample_interval, use_adaptive_rx_coalesce, use_adaptive_tx_coalesce) = AdaptiveCoalescingConfiguration::to_values(&self.adaptive_coalescing);
		
		let (rx_coalesce_usecs, rx_max_coalesced_frames, tx_coalesce_usecs, tx_max_coalesced_frames) = self.receive_transmit.destructure();
		
		let (rx_coalesce_usecs_irq, rx_max_coalesced_frames_irq, tx_coalesce_usecs_irq, tx_max_coalesced_frames_irq) = self.receive_transmit_whilst_irq_is_being_serviced_by_the_host.destructure();
		
		let (rx_coalesce_usecs_low, rx_max_coalesced_frames_low, tx_coalesce_usecs_low, tx_max_coalesced_frames_low) = self.receive_transmit_at_low_packet_rate.destructure();
		
		let (rx_coalesce_usecs_high, rx_max_coalesced_frames_high, tx_coalesce_usecs_high, tx_max_coalesced_frames_high) = self.receive_transmit_at_high_packet_rate.destructure();
		
		ethtool_coalesce
		{
			cmd: ETHTOOL_SCOALESCE,
			rx_coalesce_usecs,
			rx_max_coalesced_frames,
			rx_coalesce_usecs_irq,
			rx_max_coalesced_frames_irq,
			tx_coalesce_usecs,
			tx_max_coalesced_frames,
			tx_coalesce_usecs_irq,
			tx_max_coalesced_frames_irq,
			stats_block_coalesce_usecs: self.statistics_block_coalesce_microseconds,
			use_adaptive_rx_coalesce,
			use_adaptive_tx_coalesce,
			pkt_rate_low: self.low_packet_rate_packets_per_second_threshold,
			rx_coalesce_usecs_low,
			rx_max_coalesced_frames_low,
			tx_coalesce_usecs_low,
			tx_max_coalesced_frames_low,
			pkt_rate_high: self.high_packet_rate_packets_per_second_threshold,
			rx_coalesce_usecs_high,
			rx_max_coalesced_frames_high,
			tx_coalesce_usecs_high,
			tx_max_coalesced_frames_high,
			rate_sample_interval,
		}
	}
}