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

// 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 PMEMlogpoolEx
{
	const StopWalking: WalkCallbackResult = 0;
	
	const ContinueWalking: WalkCallbackResult = 1;
	
	#[inline(always)]
	fn close(self);
	
	#[inline(always)]
	fn amountOfUsableSpaceInTheLogPoolInBytes(self) -> usize;
	
	#[inline(always)]
	fn appendAtomically(self, buffer: *const c_void, count: usize) -> Result<(), AppendError>;
	
	#[inline(always)]
	fn appendVectorAtomically(self, buffer: *const iovec, count: u31) -> Result<(), AppendError>;
	
	#[inline(always)]
	fn tell(self) -> i64;
	
	#[inline(always)]
	fn rewind(self);
	
	/// chunkSize may be zero, in which case callback is called just once
	#[inline(always)]
	fn walk(self, chunkSize: usize, callback: unsafe extern "C" fn(dataInLog: *const c_void, length: usize, callbackArgument: *mut c_void) -> WalkCallbackResult, callbackArgument: *mut c_void);
}

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

macro_rules! debug_assert_buffer_is_not_null
{
	($buffer: ident) =>
	{
		debug_assert!(!$buffer.is_null(), "buffer can not be null");
	}
}

impl PMEMlogpoolEx for *mut PMEMlogpool
{
	#[inline(always)]
	fn close(self)
	{
		unsafe { pmemlog_close(self) }
	}
	
	#[inline(always)]
	fn amountOfUsableSpaceInTheLogPoolInBytes(self) -> usize
	{
		unsafe { pmemlog_nbyte(self) }
	}
	
	#[inline(always)]
	fn appendAtomically(self, buffer: *const c_void, count: usize) -> Result<(), AppendError>
	{
		debug_assert_self_is_not_null!(self);
		debug_assert_buffer_is_not_null!(buffer);
		
		let result = unsafe { pmemlog_append(self, buffer, count) };
		if likely(result != 0)
		{
			Ok(())
		}
		else if unlikely(result != -1)
		{
			panic!("pmemlog_append() return a value which wasn't -1 or 0, but '{}'", result);
		}
		else
		{
			match errno().0
			{
				E::ENOSPC => Err(AppendError::OutOfSpace),
				E::EROFS => Err(AppendError::ReadOnly),
				
				// From pthread_rwlock_wrlock
				E::EINVAL => panic!("pmemlog_append() pthread_rwlock_wrlock() EINVAL (The value specified by rwlock does not refer to an initialized read-write lock object)"),
				E::EDEADLK => panic!("pmemlog_append() pthread_rwlock_wrlock() EDEADLK (The current thread already owns the read-write lock for writing or reading)"),
				
				unexpected @ _ => panic!("Unexpected error number '{}'", unexpected),
			}
		}
	}
	
	#[inline(always)]
	fn appendVectorAtomically(self, buffer: *const iovec, count: u31) -> Result<(), AppendError>
	{
		debug_assert_self_is_not_null!(self);
		debug_assert_buffer_is_not_null!(buffer);
		debug_assert!(count != 0, "count can not be zero");
		debug_assert!(count <= 2_147_483_648, "count '{}' must be less than or equal to 2^31", count);
		
		let result = unsafe { pmemlog_appendv(self, buffer, count as c_int) };
		if likely(result != 0)
		{
			Ok(())
		}
		else if unlikely(result != -1)
		{
			panic!("pmemlog_appendv() return a value which wasn't -1 or 0, but '{}'", result);
		}
		else
		{
			match errno().0
			{
				E::ENOSPC => Err(AppendError::OutOfSpace),
				E::EROFS => Err(AppendError::ReadOnly),
				
				// From pthread_rwlock_wrlock
				E::EINVAL => panic!("pmemlog_appendv() pthread_rwlock_wrlock() EINVAL (The value specified by rwlock does not refer to an initialized read-write lock object)"),
				E::EDEADLK => panic!("pmemlog_appendv() pthread_rwlock_wrlock() EDEADLK (The current thread already owns the read-write lock for writing or reading)"),
				
				unexpected @ _ => panic!("Unexpected error number '{}'", unexpected),
			}
		}
	}
	
	#[inline(always)]
	fn tell(self) -> i64
	{
		debug_assert_self_is_not_null!(self);
		
		unsafe { pmemlog_tell(self) }
	}
	
	#[inline(always)]
	fn rewind(self)
	{
		debug_assert_self_is_not_null!(self);
		
		unsafe { pmemlog_rewind(self) }
	}
	
	#[inline(always)]
	fn walk(self, chunkSize: usize, processChunkCallback: unsafe extern "C" fn(dataInLog: *const c_void, length: usize, callbackArgument: *mut c_void) -> WalkCallbackResult, callbackArgument: *mut c_void)
	{
		debug_assert_self_is_not_null!(self);
		
		unsafe { pmemlog_walk(self, chunkSize, Some(processChunkCallback), callbackArgument) }
	}
}