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

// 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 PersistentMemoryObjectPoolPathExt
{
	/// Not supported if the path is a /dev/daxN ('Device DAX') device file path
	#[inline(always)]
	fn validatePersistentMemoryObjectPoolIsConsistent(&self, layoutName: Option<&str>) -> Result<bool, GenericError>;
	
	#[inline(always)]
	fn openPersistentMemoryObjectPool(&self, layoutName: Option<&str>) -> Result<*mut PMEMobjpool, GenericError>;
	
	#[inline(always)]
	fn createPersistentMemoryObjectPool(&self, layoutName: Option<&str>, poolSize: usize, mode: mode_t) -> Result<*mut PMEMobjpool, GenericError>;
}

macro_rules! handleError
{
	($function: path) =>
	{
		{
			let osErrorNumber = errno().0;
			const functionName: &'static str = stringify!($function);
			Err(GenericError::new(osErrorNumber, pmemobj_errormsg, functionName))
		}
	}
}

impl PersistentMemoryObjectPoolPathExt for Path
{
	#[inline(always)]
	fn validatePersistentMemoryObjectPoolIsConsistent(&self, layoutName: Option<&str>) -> Result<bool, GenericError>
	{
		let layout = layoutAsRawPointer(layoutName);
		let result = usePath!(self, pmemobj_check, layout);
		unsafe { CString::from_raw(layout as *mut _) };
		
		match result
		{
			1 => Ok(false),
			0 => Ok(true),
			-1 => handleError!(pmemobj_check),
			illegal @ _ => panic!("pmemobj_check() returned illegal value '{}'", illegal)
		}
	}
	
	#[inline(always)]
	fn openPersistentMemoryObjectPool(&self, layoutName: Option<&str>) -> Result<*mut PMEMobjpool, GenericError>
	{
		let layout = layoutAsRawPointer(layoutName);
		let result = usePath!(self, pmemobj_open, layout);
		unsafe { CString::from_raw(layout as *mut _) };
		
		if unlikely(result.is_null())
		{
			handleError!(pmemobj_open)
		}
		else
		{
			Ok(result)
		}
	}
	
	#[inline(always)]
	fn createPersistentMemoryObjectPool(&self, layoutName: Option<&str>, poolSize: usize, mode: mode_t) -> Result<*mut PMEMobjpool, GenericError>
	{
		let layout = layoutAsRawPointer(layoutName);
		let result = usePath!(self, pmemobj_create, layout, poolSize, mode);
		unsafe { CString::from_raw(layout as *mut _) };
		
		if unlikely(result.is_null())
		{
			handleError!(pmemobj_create)
		}
		else
		{
			Ok(result)
		}
	}
}

#[inline(always)]
fn layoutAsRawPointer(layoutName: Option<&str>) -> *const c_char
{
	if let Some(layoutName) = layoutName
	{
		debug_assert!(layoutName.len() + 1 <= PMEMOBJ_MAX_ALLOC_SIZE as usize, "layoutName length '{}' + 1 is greater than PMEMOBJ_MAX_ALLOC_SIZE '{}'", layoutName.len(), PMEMOBJ_MAX_ALLOC_SIZE);
		
		let cString = CString::new(layoutName).expect("Invalid layout name");
		
		cString.into_raw()
	}
	else
	{
		null()
	}
}