nvml 0.0.2

A mid-level wrapper around PMDK (the persistent memory development kit), formely NVML
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 © 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 PMEMblkpoolEx
{
	#[inline(always)]
	fn close(self);
	
	#[inline(always)]
	fn blockSize(self) -> usize;
	
	#[inline(always)]
	fn numberOfBlocksAvailableInBlockPool(self) -> usize;
	
	/// Returns false if the block has previously had its error condition set
	#[inline(always)]
	fn read_from(self, to: *mut c_void, zeroBasedBlockIndex: usize) -> bool;
	
	#[inline(always)]
	fn write_to(self, from: *const c_void, zeroBasedBlockIndex: usize);
	
	#[inline(always)]
	fn setZero(self, zeroBasedBlockIndex: usize);
	
	#[inline(always)]
	fn setError(self, zeroBasedBlockIndex: usize);
}

macro_rules! debug_assert_self_is_not_null
{
	($self: ident) =>
	{
		debug_assert!(!$self.is_null(), "PMEMblkpool (pbp) can not be null");
	}
}

impl PMEMblkpoolEx for *mut PMEMblkpool
{
	#[inline(always)]
	fn close(self)
	{
		debug_assert_self_is_not_null!(self);
		
		unsafe { pmemblk_close(self) }
	}
	
	#[inline(always)]
	fn blockSize(self) -> usize
	{
		debug_assert_self_is_not_null!(self);
		
		unsafe { pmemblk_bsize(self) }
	}
	
	#[inline(always)]
	fn numberOfBlocksAvailableInBlockPool(self) -> usize
	{
		debug_assert_self_is_not_null!(self);
		
		unsafe { pmemblk_nblock(self) }
	}
	
	#[inline(always)]
	fn read_from(self, to: *mut c_void, zeroBasedBlockIndex: usize) -> bool
	{
		debug_assert_self_is_not_null!(self);
		debug_assert!(!to.is_null(), "to can not be null");
		debug_assert!(zeroBasedBlockIndex < self.numberOfBlocksAvailableInBlockPool(), "zeroBasedBlockIndex '{}' exceeds numberOfBlocksAvailableInBlockPool '{}'", zeroBasedBlockIndex, self.numberOfBlocksAvailableInBlockPool());
		
		let result = unsafe { pmemblk_read(self, to, zeroBasedBlockIndex as c_longlong)};
		if likely(result == 0)
		{
			return true;
		}
		else if unlikely(result != -1)
		{
			panic!("pmemblk_read() return a value which wasn't -1 or 0, but '{}'", result);
		}
		else
		{
			let osErrorNumber = errno().0;
			if likely(osErrorNumber == E::EIO)
			{
				false
			}
			else
			{
				GenericError::new(osErrorNumber, pmemblk_errormsg, "pmemblk_read").panic();
			}
		}
	}
	
	#[inline(always)]
	fn write_to(self, from: *const c_void, zeroBasedBlockIndex: usize)
	{
		debug_assert_self_is_not_null!(self);
		debug_assert!(!from.is_null(), "from can not be null");
		debug_assert!(zeroBasedBlockIndex < self.numberOfBlocksAvailableInBlockPool(), "zeroBasedBlockIndex '{}' exceeds numberOfBlocksAvailableInBlockPool '{}'", zeroBasedBlockIndex, self.numberOfBlocksAvailableInBlockPool());
		
		let result = unsafe { pmemblk_write(self, from, zeroBasedBlockIndex as c_longlong)};
		if likely(result == 0)
		{
			return;
		}
		else if unlikely(result != -1)
		{
			panic!("pmemblk_write() return a value which wasn't -1 or 0, but '{}'", result);
		}
		else
		{
			GenericError::new(errno().0, pmemblk_errormsg, "pmemblk_write").panic();
		}
	}
	
	#[inline(always)]
	fn setZero(self, zeroBasedBlockIndex: usize)
	{
		debug_assert_self_is_not_null!(self);
		debug_assert!(zeroBasedBlockIndex < self.numberOfBlocksAvailableInBlockPool(), "zeroBasedBlockIndex '{}' exceeds numberOfBlocksAvailableInBlockPool '{}'", zeroBasedBlockIndex, self.numberOfBlocksAvailableInBlockPool());
		
		let result = unsafe { pmemblk_set_zero(self, zeroBasedBlockIndex as c_longlong)};
		if likely(result == 0)
		{
			return;
		}
		else if unlikely(result != -1)
		{
			panic!("pmemblk_set_zero() return a value which wasn't -1 or 0, but '{}'", result);
		}
		else
		{
			GenericError::new(errno().0, pmemblk_errormsg, "pmemblk_set_zero").panic();
		}
	}
	
	#[inline(always)]
	fn setError(self, zeroBasedBlockIndex: usize)
	{
		debug_assert_self_is_not_null!(self);
		debug_assert!(zeroBasedBlockIndex < self.numberOfBlocksAvailableInBlockPool(), "zeroBasedBlockIndex '{}' exceeds numberOfBlocksAvailableInBlockPool '{}'", zeroBasedBlockIndex, self.numberOfBlocksAvailableInBlockPool());
		
		let result = unsafe { pmemblk_set_error(self, zeroBasedBlockIndex as c_longlong)};
		if likely(result == 0)
		{
			return;
		}
		else if unlikely(result != -1)
		{
			panic!("pmemblk_set_error() return a value which wasn't -1 or 0, but '{}'", result);
		}
		else
		{
			GenericError::new(errno().0, pmemblk_errormsg, "pmemblk_set_error").panic();
		}
	}
}