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

// 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)]
pub struct RingQueue<P, C, L>
where P: Producer, C: Consumer, L: Lifecycle
{
	ring: *mut rte_ring,
	producer: PhantomData<P>,
	consumer: PhantomData<C>,
	lifecycle: PhantomData<L>,
}

impl<P, C, L> Drop for RingQueue<P, C, L>
where P: Producer, C: Consumer, L: Lifecycle
{
	fn drop(&mut self)
	{
		L::free(self.ring)
	}
}

impl<P, C, L> RingQueue<P, C, L>
where P: Producer, C: Consumer, L: Lifecycle
{	
	const DisableWaterMarking: u32 = 0;
	
	#[inline(always)]
	pub fn new(ring: *mut rte_ring) -> Self
	{
		RingQueue
		{
			ring: ring,
			producer: PhantomData,
			consumer: PhantomData,
			lifecycle: PhantomData,
		}
	}

	#[inline(always)]
	pub fn as_ptr(&self) -> *mut rte_ring
	{
		self.ring
	}
	
	#[inline(always)]
	pub fn isFull(&self) -> bool
	{
		isTrue(unsafe { rust_rte_ring_full(self.ring) })
	}
	
	#[inline(always)]
	pub fn isEmpty(&self) -> bool
	{
		isTrue(unsafe { rust_rte_ring_empty(self.ring) })
	}
	
	#[inline(always)]
	pub fn count(&self) -> u32
	{
		unsafe { rust_rte_ring_count(self.ring) }
	}
	
	#[inline(always)]
	pub fn remaining(&self) -> u32
	{
		unsafe { rust_rte_ring_free_count(self.ring) }
	}
	
	#[inline(always)]
	pub fn disableWaterMark(&mut self)
	{
		self.setWaterMark(Self::DisableWaterMarking);
	}
	
	#[inline(always)]
	pub fn setWaterMark(&mut self, count: u32)
	{
		let result = unsafe { ::dpdk_sys::rte_ring_set_water_mark(self.ring, count) };
		if likely(result == 0)
		{
			return
		}
		
		match result
		{
			NegativeE::EINVAL => panic!("invalid watermark count, '{}' (is it greater than the ring size?)", count),
			
			unexpected @ _ => panic!("Unexpected error code '{}' from rte_ring_set_water_mark()", unexpected),
		}
	}
	
	#[inline(always)]
	pub fn dumpToStandardError(&self)
	{
		unsafe
		{
			::dpdk_sys::rte_ring_dump(stderr as *mut FILE, self.ring);
		}
	}
}