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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

// 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 EthernetPortReceiveModeConfiguration
{
	pub multiQueuePacketDistributionMode: MultiQueuePacketReceiveMode,
	pub maximumReceivePacketLengthOnlyUsedIfJumboFramesEnabled: Option<u16>, // => implies jumbo frames enabled for us
	pub splitHeaderSizeIfHeaderSplitEnabled: Option<u16>, // => implies header split enabled
	
	pub hardwareIpUdpOrTcpChecksumOffloadEnabled: bool,
	pub hardwareVlanFilterEnabled: bool,
	pub hardwareVlanStripEnabled: bool,
	pub extendedVlanEnabled: bool,
	pub hardwareCyclicRedundancyChecksumStrippingEnabled: bool,
	pub scatterPacketsReceiveHandlerEnabled: bool,
	pub largeReceiveOffloadEnabled: bool,
}

impl Default for EthernetPortReceiveModeConfiguration
{
	#[inline(always)]
	fn default() -> Self
	{
		Self::defaultish(MaximumTransmissionUnitSizeInBytes::EthernetV2)
	}
}

impl EthernetPortReceiveModeConfiguration
{
	#[inline(always)]
	pub fn defaultish(maximumTransmissionUnitSizeInBytes: MaximumTransmissionUnitSizeInBytes) -> EthernetPortReceiveModeConfiguration
	{
		EthernetPortReceiveModeConfiguration
		{
			multiQueuePacketDistributionMode: MultiQueuePacketReceiveMode::default(),
			maximumReceivePacketLengthOnlyUsedIfJumboFramesEnabled: maximumTransmissionUnitSizeInBytes.conservativeJumboFrameLength(),
			splitHeaderSizeIfHeaderSplitEnabled: None,
			hardwareIpUdpOrTcpChecksumOffloadEnabled: true,
			hardwareVlanFilterEnabled: false,
			hardwareVlanStripEnabled: false,
			extendedVlanEnabled: false,
			hardwareCyclicRedundancyChecksumStrippingEnabled: true,
			scatterPacketsReceiveHandlerEnabled: false,
			largeReceiveOffloadEnabled: true,
		}
	}
	
	#[inline(always)]
	pub fn disableReceiveSideScaling(&mut self)
	{
		self.multiQueuePacketDistributionMode.disableReceiveSideScaling();
	}
	
	#[inline(always)]
	pub fn enableReceiveSideScaling(&mut self)
	{
		self.multiQueuePacketDistributionMode.enableReceiveSideScaling();
	}
	
	#[inline(always)]
	pub fn enableTcpLargeReceiveOffload(&mut self)
	{
		self.largeReceiveOffloadEnabled = true;
	}
	
	#[inline(always)]
	pub fn disableTcpLargeReceiveOffload(&mut self)
	{
		self.largeReceiveOffloadEnabled = false;
	}
	
	#[inline(always)]
	pub fn enableHardwareVlanStripping(&mut self)
	{
		self.hardwareVlanStripEnabled = true;
	}
	
	#[inline(always)]
	pub fn disableHardwareVlanStripping(&mut self)
	{
		self.hardwareVlanStripEnabled = false;
	}
	
	#[inline(always)]
	pub fn enableHardwareCyclicRedundancyChecksumStripping(&mut self)
	{
		self.hardwareCyclicRedundancyChecksumStrippingEnabled = true;
	}
	
	#[inline(always)]
	pub fn enableIpV4TcpAndUdpChecksumOffload(&mut self)
	{
		self.hardwareIpUdpOrTcpChecksumOffloadEnabled = true;
	}
	
	#[inline(always)]
	pub fn disableIpV4TcpAndUdpChecksumOffload(&mut self)
	{
		self.hardwareIpUdpOrTcpChecksumOffloadEnabled = false;
	}
	
	#[inline(always)]
	pub fn as_rte_eth_rxmode(&self) -> rte_eth_rxmode
	{
		let actualMaximumReceivePacketLength = match self.maximumReceivePacketLengthOnlyUsedIfJumboFramesEnabled
		{
			None => ::dpdk_sys::ETHER_MAX_LEN as u32,
			Some(size) =>
			{
				debug_assert!(size <= ::dpdk_sys::ETHER_MAX_JUMBO_FRAME_LEN, "Jumbo frame size must be less than or equal to '{}', and can not be '{}'", ::dpdk_sys::ETHER_MAX_JUMBO_FRAME_LEN, size);
				size as u32
			}
		};
		debug_assert!(actualMaximumReceivePacketLength as usize >= ::dpdk_sys::ETHER_MIN_LEN, "Frame size must be greater than or equal to than '{}', and can not be '{}'", ::dpdk_sys::ETHER_MIN_LEN, actualMaximumReceivePacketLength);
		
		let splitHeaderSize = self.splitHeaderSizeIfHeaderSplitEnabled.unwrap_or(0);
		
		let mut rxmode = rte_eth_rxmode
		{
			mq_mode: self.multiQueuePacketDistributionMode.as_rte_eth_rx_mq_mode(),
			max_rx_pkt_len: actualMaximumReceivePacketLength,
			split_hdr_size: splitHeaderSize,
			__bindgen_bitfield: 0,
		};
		
		unsafe
		{
			rust_rte_eth_rxmode_setBitFields
			(
				&mut rxmode,
				self.splitHeaderSizeIfHeaderSplitEnabled.is_some(),
				self.hardwareIpUdpOrTcpChecksumOffloadEnabled,
				self.hardwareVlanFilterEnabled,
				self.hardwareVlanStripEnabled,
				self.extendedVlanEnabled,
				self.maximumReceivePacketLengthOnlyUsedIfJumboFramesEnabled.is_some(),
				self.hardwareCyclicRedundancyChecksumStrippingEnabled,
				self.scatterPacketsReceiveHandlerEnabled,
				self.largeReceiveOffloadEnabled
			)
		}
		
		rxmode
	}
}