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

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


#[derive(Debug, Clone)]
pub struct MappedFileBackedMemory
{
	address: *mut c_void,
	fileBackedMemoryDropWrapper: Arc<FileBackedMemoryDropWrapper>,
}

unsafe impl Send for MappedFileBackedMemory
{
}

unsafe impl Sync for MappedFileBackedMemory
{
}

impl FileBackedMemory for MappedFileBackedMemory
{
	const Alignment: usize = 4096;
	
	const IsPersistent: bool = true;
	
	#[doc(hidden)]
	#[inline(always)]
	fn _openFlags(exclusive: bool) -> PersistentMemoryFileFlags
	{
		if exclusive
		{
			PersistentMemoryFileFlags::Exclusive
		}
		else
		{
			PersistentMemoryFileFlags::None
		}
	}
	
	#[doc(hidden)]
	#[inline(always)]
	fn _finishMappingIfMemoryIsOfCorrectType(isPersistentMemory: bool, isPersistentMemoryThatSupportsFlushingWithPersist: bool) -> bool
	{
		!isPersistentMemory || !isPersistentMemoryThatSupportsFlushingWithPersist
	}
	
	#[doc(hidden)]
	#[inline(always)]
	fn _new(address: *mut c_void, mappedLength: usize) -> Self
	{
		Self
		{
			address: address,
			fileBackedMemoryDropWrapper: FileBackedMemoryDropWrapper::new(address, mappedLength)
		}
	}
	
	#[doc(hidden)]
	#[inline(always)]
	fn _address(&self) -> *mut c_void
	{
		self.address
	}
	
	#[doc(hidden)]
	#[inline(always)]
	fn _mappedLength(&self) -> usize
	{
		self.fileBackedMemoryDropWrapper.mappedLength
	}
}

impl MappedFileBackedMemory
{
	#[inline(always)]
	pub fn createAndOpen(persistentMemoryFilePath: &Path, length: usize, mode: mode_t, sparse: bool, temporaryFile: bool, exclusive: bool) -> Result<Option<Self>, GenericError>
	{
		assert!(length != 0, "length can not be zero when creating");
		
		let mut flags = PersistentMemoryFileFlags::Create;
		
		if sparse
		{
			flags |= PersistentMemoryFileFlags::Sparse;
		}
		
		if temporaryFile
		{
			flags |= PersistentMemoryFileFlags::TmpFile;
		}
		
		if exclusive
		{
			flags |= PersistentMemoryFileFlags::Exclusive;
		}
		
		Self::_map(persistentMemoryFilePath, length, flags, mode)
	}
}