dpdk 0.0.1

A wrapper around DPDK
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

// This file is part of dpdk. 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/dpdk/master/COPYRIGHT. No part of dpdk, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2016-2017 The developers of dpdk. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/dpdk/master/COPYRIGHT.


#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct TransmitQueueDeviceConfiguration
{
	ringPrefetchThreshold: Option<u8>,
	ringHostThreshold: Option<u8>,
	ringWritebackThreshold: Option<u8>,
	startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis: Option<u16>,
	transmitDescriptorsRSbitThreshold: Option<u16>,
	flagsToRemove: TransmitQueueFlags,
	flagsToInsert: TransmitQueueFlags,
	startQueueWhenEthernetDeviceStarted: bool,
}

impl TransmitQueueDeviceConfiguration
{
	#[inline(always)]
	pub fn new
	(
		ringPrefetchThreshold: Option<u8>,
		ringHostThreshold: Option<u8>,
		ringWritebackThreshold: Option<u8>,
		startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis: Option<u16>,
		transmitDescriptorsRSbitThreshold: Option<u16>,
		flagsToRemove: TransmitQueueFlags,
		flagsToInsert: TransmitQueueFlags,
		startQueueWhenEthernetDeviceStarted: bool
	) -> Self
	{
		if let Some(ringWritebackThreshold) = ringWritebackThreshold
		{
			if ringWritebackThreshold > 0
			{
				if let Some(transmitDescriptorsRSbitThreshold) = transmitDescriptorsRSbitThreshold
				{
					assert!(transmitDescriptorsRSbitThreshold == 1, "if ringWritebackThreshold '{}' is greater than zero, then transmitDescriptorsRSbitThreshold '{}' must be one", ringWritebackThreshold, transmitDescriptorsRSbitThreshold);
				}
			}
		}
		
		TransmitQueueDeviceConfiguration
		{
			ringPrefetchThreshold: ringPrefetchThreshold,
			ringHostThreshold: ringHostThreshold,
			ringWritebackThreshold: ringWritebackThreshold,
			transmitDescriptorsRSbitThreshold: transmitDescriptorsRSbitThreshold,
			startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis: startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis,
			flagsToRemove: flagsToRemove,
			flagsToInsert: flagsToInsert,
			startQueueWhenEthernetDeviceStarted: startQueueWhenEthernetDeviceStarted,
		}
	}
	
	#[inline(always)]
	pub fn overrideForTldk(startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis: u16) -> Self
	{
		Self::new(None, None, None, Some(startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis), None, TransmitQueueFlags::all(), TransmitQueueFlags::empty(), true)
	}
	
	#[inline(always)]
	pub fn validate(&self, numberOfTransmitDescriptorsForTheTransmitRingAlsoKnownAsRingSize: u16)
	{
		if let Some(transmitDescriptorsRSbitThreshold) = self.transmitDescriptorsRSbitThreshold
		{
			assert!(transmitDescriptorsRSbitThreshold < numberOfTransmitDescriptorsForTheTransmitRingAlsoKnownAsRingSize - 3, "transmitDescriptorsRSbitThreshold '{}' is too large for numberOfTransmitDescriptorsForTheTransmitRingAlsoKnownAsRingSize '{}' - 3", transmitDescriptorsRSbitThreshold, numberOfTransmitDescriptorsForTheTransmitRingAlsoKnownAsRingSize);
		}
		
		if let Some(startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis) = self.startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis
		{
			assert!(startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis < numberOfTransmitDescriptorsForTheTransmitRingAlsoKnownAsRingSize - 3, "startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis '{}' is too large for numberOfTransmitDescriptorsForTheTransmitRingAlsoKnownAsRingSize '{}' - 3", startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis, numberOfTransmitDescriptorsForTheTransmitRingAlsoKnownAsRingSize);
		}
	}
	
	#[inline(always)]
	pub fn as_rte_eth_txconf(&self, mut configuration: rte_eth_txconf) -> rte_eth_txconf
	{
		if let Some(ringPrefetchThreshold) = self.ringPrefetchThreshold
		{
			configuration.tx_thresh.pthresh = ringPrefetchThreshold;
		}
		
		if let Some(ringHostThreshold) = self.ringHostThreshold
		{
			configuration.tx_thresh.hthresh = ringHostThreshold;
		}
		
		if let Some(ringWritebackThreshold) = self.ringWritebackThreshold
		{
			configuration.tx_thresh.wthresh = ringWritebackThreshold;
		}
		
		if let Some(startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis) = self.startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis
		{
			configuration.tx_free_thresh = startFreeingTransmitBuffersIfThereAreLessFreeDescriptorsThanThis;
		}
		
		if let Some(transmitDescriptorsRSbitThreshold) = self.transmitDescriptorsRSbitThreshold
		{
			configuration.tx_rs_thresh = transmitDescriptorsRSbitThreshold;
		}
		
		let mut flags = TransmitQueueFlags::from_bits_truncate(configuration.txq_flags);
		flags.remove(self.flagsToRemove);
		flags.insert(self.flagsToInsert);
		configuration.txq_flags = flags.bits();
		
		configuration.tx_deferred_start = if self.startQueueWhenEthernetDeviceStarted
		{
			0
		}
		else
		{
			1
		};
		
		configuration
	}
	
	#[inline(always)]
	pub fn startQueueWhenEthernetDeviceStarted(&self) -> bool
	{
		self.startQueueWhenEthernetDeviceStarted
	}
}