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
148
149
150
151
152
153
154
155
156
157

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


pub trait Context<IpV4: AddressLookUpForSendCallback<in_addr>, IpV6: AddressLookUpForSendCallback<in6_addr>> : Sized + Drop
{
	const Protocol: Layer4Protocol;
	
	type Device: Device;
	
	#[doc(hidden)]
	#[inline(always)]
	fn _opaqueFfiHandle(&mut self) -> *mut tle_ctx;
	
	#[doc(hidden)]
	#[inline(always)]
	fn _newContext(opaqueFfiHandle: *mut tle_ctx, addressLookUpForSendToIpV4: Rc<RefCell<IpV4>>, addressLookUpForSendToIpV6: Rc<RefCell<IpV6>>) -> Self;
	
	#[doc(hidden)]
	#[inline(always)]
	fn _drop(&mut self)
	{
		unsafe { ::dpdk_sys::tle_ctx_destroy(self._opaqueFfiHandle()) };
	}
	
	#[inline(always)]
	fn create
	(
		numaSocketIdToAllocateMemoryFrom: Option<NumaSocketId>,
		maximumNumberOfStreams: u32,
		maximumNumberOfReceiveBuffers: u32,
		maximumNumberOfSendBuffers: u32,
		sendMaximumBulkNumber: u32,
		addressLookUpForSendToIpV4: Rc<RefCell<IpV4>>,
		addressLookUpForSendToIpV6: Rc<RefCell<IpV6>>,
		mut deviceConfigurations: Vec<DeviceConfiguration>,
	) -> Option<(Self, Vec<(DeviceConfiguration, Self::Device)>)>
	{
		let parameters = tle_ctx_param
		{
			socket_id: numaSocketIdToAllocateMemoryFrom.as_int32_t(),
			proto: Self::Protocol.tldkValue(),
			max_streams: maximumNumberOfStreams,
			max_stream_rbufs: maximumNumberOfReceiveBuffers,
			max_stream_sbufs: maximumNumberOfSendBuffers,
			send_bulk_size: sendMaximumBulkNumber,
			lookup4: IpV4::asFunctionPointer(),
			lookup4_data: addressLookUpForSendToIpV4.as_ptr() as *mut c_void,
			lookup6: IpV6::asFunctionPointer(),
			lookup6_data: addressLookUpForSendToIpV4.as_ptr() as *mut c_void,
		};
		
		let result = unsafe { ::dpdk_sys::tle_ctx_create(&parameters) };
		if unlikely(result.is_null())
		{
			match unsafe { rust_rte_errno() }
			{
				E::ENOMEM => None,
				
				E::ENODEV => None,
			
				E::EINVAL => panic!("Supplied an invalid value"),
			
				illegal @ _ => panic!("Unexpected errno '{}' from tle_ctx_create()", illegal),
			}
		}
		else
		{
			let mut context = Self::_newContext(result, addressLookUpForSendToIpV4, addressLookUpForSendToIpV6);
			
			let mut devices = Vec::with_capacity(deviceConfigurations.len());
			for deviceConfiguration in deviceConfigurations.drain(..)
			{
				let device = context._createNewDevice(&deviceConfiguration).expect("Out of memory creating Device");
				devices.push((deviceConfiguration, device))
			}
			
			Some((context, devices))
		}
	}
	
	#[inline(always)]
	fn invalidateBecauseDestinationInformationHasChanged(&mut self)
	{
		unsafe { ::dpdk_sys::tle_ctx_invalidate(self._opaqueFfiHandle()) };
	}
	
	#[inline(always)]
	fn poll(&mut self, number: u32);
	
	#[doc(hidden)]
	#[inline(always)]
	fn _createNewDevice(&mut self, deviceConfiguration: &DeviceConfiguration) -> Option<Self::Device>
	{
		let (receiveOffload, transmitOffload) = deviceConfiguration.offloading(Self::Protocol);
		
		// NOTE: the value pointed to by port in tle_bl_port is NOT CLONED by tle_add_dev(). However, the reference (port) is never used again outside of tle_add_dev
		
		// NOTE: These 4 statement force borrows of ipV4BlockedPorts and ipV6BlockedPorts which live longer than the code before and after tle_add_dev()
		let ipV4BlockedPorts = deviceConfiguration.ipV4BlockedPortsForTldk();
		let ipV6BlockedPorts = deviceConfiguration.ipV6BlockedPortsForTldk();
		
		{
			let ipV4BlockedPorts = &ipV4BlockedPorts;
			let ipV6BlockedPorts = &ipV6BlockedPorts;
			
			let dev_prm = tle_dev_param
			{
				rx_offload: receiveOffload.bits(),
				tx_offload: transmitOffload.bits(),
				local_addr4: deviceConfiguration.in_addr(),
				local_addr6: deviceConfiguration.in6_addr(),
				bl4: tle_bl_port
				{
					nb_port: ipV4BlockedPorts.len() as u32,
					port: if ipV4BlockedPorts.is_empty()
					{
						null()
					}
					else
					{
						ipV4BlockedPorts.as_ptr()
					},
				},
				bl6: tle_bl_port
				{
					nb_port: ipV6BlockedPorts.len() as u32,
					port: if ipV6BlockedPorts.is_empty()
					{
						null()
					}
					else
					{
						ipV6BlockedPorts.as_ptr()
					}
				},
			};
		
			let result = unsafe { ::dpdk_sys::tle_add_dev(self._opaqueFfiHandle(), &dev_prm) };
			if unlikely(result.is_null())
			{
				match unsafe { rust_rte_errno() }
				{
					E::ENOMEM => None,
			
					E::EINVAL => panic!("Supplied an invalid value"),
			
					illegal @ _ => panic!("Unexpected errno '{}' from tle_add_dev()", illegal),
				}
			}
			else
			{
				Some(Self::Device::_new(result))
			}
		}
	}
}