dpdk-core 0.1.5

A wrapper around DPDK's core framework
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171

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


/// Wraps a DPDK memory zone.
///
/// If constructed using any of the methods in this struct apart from `look_up()`, will be freed on drop.
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord)]
pub struct MemoryZone
{
	name: ConstCStr,
	handle: NonNull<rte_memzone>,
	free_on_drop: bool,
}

impl Drop for MemoryZone
{
	#[inline(always)]
	fn drop(&mut self)
	{
		if self.free_on_drop
		{
			match unsafe { rte_memzone_free(self.handle.as_ptr() as *const _) }
			{
				0 => (),
				
				// Can not drop an IVSHMEM memory zone
				NegativeE::EINVAL => (),

				illegal @ _ => panic!("Unexpected result '{}' from rte_memzone_free()", illegal),
			}
		}
	}
}

impl PrintAllInformation for MemoryZone
{
	#[inline(always)]
	fn print_information_to_stream(stream: *mut FILE)
	{
		unsafe { rte_memzone_dump(stream) };
	}
}

impl MemoryZone
{
	/// Special sentinel value used by DPDK for longest possible reservation.
	pub const SpecialLengthSignifyingLongestPossibleReservation: usize = 0;
	
	/// Find a memory zone using its name.
	#[inline(always)]
	pub fn look_up(name: ConstCStr) -> Option<Self>
	{
		Self::assert_memory_zone_name_size(name);

		let result = unsafe { rte_memzone_lookup(name.as_ptr()) };
		if unlikely!(result.is_null())
		{
			None
		}
		else
		{
			Some
			(
				MemoryZone
				{
					name,
					handle: unsafe { NonNull::new_unchecked(result as *mut _) },
					free_on_drop: false,
				}
			)
		}
	}
	
	/// Reserve the longest possible memory zone with `alignment` set to cache line size (`RTE_CACHE_LINE_SIZE`).
	#[inline(always)]
	pub fn reserve_with_alignment_as_cache_line_size_longest_possible(name: ConstCStr, numa_node_choice: NumaNodeChoice, memory_zone_reservation_page_choice: MemoryZoneReservationPageChoice) -> Option<Self>
	{
		Self::reserve_with_alignment_as_cache_line_size(name, numa_node_choice, memory_zone_reservation_page_choice, Self::SpecialLengthSignifyingLongestPossibleReservation)
	}
	
	/// Reserve a memory zone with `alignment` set to cache line size (`RTE_CACHE_LINE_SIZE`).
	///
	/// Note: 0 for `length` is special; it allocates the longest possible item of memory: see `Self::SpecialLengthSignifyingLongestPossibleReservation`. Rather than specifying length as `0`, use `Self::reserve_with_alignment_as_cache_line_size_longest_possible` instead as it documents intention better.
	#[inline(always)]
	pub fn reserve_with_alignment_as_cache_line_size(name: ConstCStr, numa_node_choice: NumaNodeChoice, memory_zone_reservation_page_choice: MemoryZoneReservationPageChoice, length: usize) -> Option<Self>
	{
		Self::assert_memory_zone_name_size(name);

		let result = unsafe { rte_memzone_reserve(name.as_ptr(), length, numa_node_choice.into(), memory_zone_reservation_page_choice.bits()) };
		Self::process_reservation_result(name, result, "rte_memzone_reserve")
	}
	
	/// Reserve the longest possible memory zone with `alignment` specified.
	#[inline(always)]
	pub fn reserve_with_alignment_longest_possible(name: ConstCStr, numa_node_choice: NumaNodeChoice, memory_zone_reservation_page_choice: MemoryZoneReservationPageChoice, alignment: u32) -> Option<MemoryZone>
	{
		Self::reserve_with_alignment(name, numa_node_choice, memory_zone_reservation_page_choice, Self::SpecialLengthSignifyingLongestPossibleReservation, alignment)
	}
	
	/// Reserve a memory zone with `alignment` specified.
	///
	/// Note: 0 for `length` is special; it allocates the longest possible item of memory: see `Self::SpecialLengthSignifyingLongestPossibleReservation`. Rather than specifying length as `0`, use `Self::reserve_with_alignment_longest_possible` instead as it documents intention better.
	#[inline(always)]
	pub fn reserve_with_alignment(name: ConstCStr, numa_node_choice: NumaNodeChoice, memory_zone_reservation_page_choice: MemoryZoneReservationPageChoice, length: usize, alignment: u32) -> Option<Self>
	{
		Self::assert_memory_zone_name_size(name);

		let result = unsafe { rte_memzone_reserve_aligned(name.as_ptr(), length, numa_node_choice.into(), memory_zone_reservation_page_choice.bits(), alignment as u32) };
		Self::process_reservation_result(name, result, "rte_memzone_reserve_aligned")
	}

	/// Reserve the longest possible memory zone with `alignment` and `boundary` specified.
	#[inline(always)]
	pub fn reserve_with_alignment_and_boundary_longest_possible(name: ConstCStr, numa_node_choice: NumaNodeChoice, memory_zone_reservation_page_choice: MemoryZoneReservationPageChoice, alignment: u32, boundary: u32) -> Option<Self>
	{
		Self::reserve_with_alignment_and_boundary(name, numa_node_choice, memory_zone_reservation_page_choice, Self::SpecialLengthSignifyingLongestPossibleReservation as u32, alignment, boundary)
	}
	
	/// Reserve a memory zone with `alignment` and `boundary` specified.
	///
	/// Note: 0 for `length` is special; it allocates the longest possible item of memory: see `Self::SpecialLengthSignifyingLongestPossibleReservation`. Rather than specifying length as `0`, use `Self::reserve_with_alignment_and_boundary_longest_possible` instead as it documents intention better.
	#[inline(always)]
	pub fn reserve_with_alignment_and_boundary(name: ConstCStr, numa_node_choice: NumaNodeChoice, memory_zone_reservation_page_choice: MemoryZoneReservationPageChoice, length: u32, alignment: u32, boundary: u32) -> Option<Self>
	{
		Self::assert_memory_zone_name_size(name);

		debug_assert!(length <= boundary as u32, "length '{}' is greater than the boundary '{:?}'", length, boundary);

		let result = unsafe { rte_memzone_reserve_bounded(name.as_ptr(), length as usize, numa_node_choice.into(), memory_zone_reservation_page_choice.bits(), alignment, boundary as u32) };
		Self::process_reservation_result(name, result, "rte_memzone_reserve_bounded")
	}
	
	#[inline(always)]
	fn assert_memory_zone_name_size(name: ConstCStr)
	{
		debug_assert!(name.length_excluding_trailing_nul() < RTE_MEMZONE_NAMESIZE, "name '{}' is equal to or greater than RTE_MEMZONE_NAMESIZE, '{}'", name, RTE_MEMZONE_NAMESIZE);
	}
	
	#[inline(always)]
	fn process_reservation_result(name: ConstCStr, result: *const rte_memzone, function_name: &str) -> Option<Self>
	{
		if unlikely!(result.is_null())
		{
			match LogicalCore::current_logical_core_error_number()
			{
				E::ENOSPC => None,
				E::ENOMEM => None,
				
				E::EINVAL => panic!("Bad parameters passed to {}()", function_name),
				E::EEXIST => panic!("Memory zone named '{}' already exists", name),
				E_RTE::NO_CONFIG => panic!("Could not get a pointer to rte_config in function {}()", function_name),
				E_RTE::SECONDARY => panic!("Function {}() was called from a secondary process instance", function_name),
				
				illegal @ _ => panic!("Unexpected error '{}' from {}()", illegal, function_name),
			}
		}
		else
		{
			Some
			(
				Self
				{
					name,
					handle: unsafe { NonNull::new_unchecked(result as *mut _) },
					free_on_drop: true,
				}
			)
		}
	}
}