libnuma 0.0.4

A mid-level binding to libnuma that provides Linux NUMA operations
Documentation 
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

// This file is part of libnuma. 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/libnuma/master/COPYRIGHT. No part of predicator, 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 libnuma. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/libnuma/master/COPYRIGHT.


#[derive(Default, Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct CpuIndex(u16);

impl Index for CpuIndex
{
	#[inline(always)]
	fn to_c_uint(&self) -> c_uint
	{
		self.0 as c_uint
	}
}

//noinspection SpellCheckingInspection
impl CpuIndex
{
	#[inline(always)]
	pub fn new(value: u16) -> Self
	{
		CpuIndex(value)
	}
	
	/// length, size, count
	/// Kernel limit on number of cpus - same as NR_CPUS
	/// Equivalent concept to NodeIndex::number_of_nodes_in_nodemask()
	pub fn number_of_possible_cpus() -> usize
	{
		match unsafe { numa_num_possible_cpus() }
		{
			x if x.is_negative() => panic!("numa_num_possible_cpus returned a negative value {}", x),
			0 => panic!("numa_num_possible_cpus returned 0"),
			x @ _ => x as usize,
		}
	}
	
	/// Number (Count) of CPUs we can use
	pub fn number_of_permitted_cpus() -> usize
	{
		match unsafe { numa_num_task_cpus() }
		{
			x if x.is_negative() => panic!("numa_num_task_cpus returned a negative value {}", x),
			0 => panic!("numa_num_task_cpus returned 0"),
			x @ _ => x as usize,
		}
	}
	
	/// Number (Count) of CPUs we can use
	pub fn number_of_configured_cpus() -> usize
	{
		match unsafe { numa_num_configured_cpus() }
		{
			x if x.is_negative() => panic!("numa_num_configured_cpus returned a negative value {}", x),
			0 => panic!("numa_num_configured_cpus returned 0"),
			x @ _ => x as usize,
		}
	}
	
	/// Returns None if the cpu has no Node. This is because the CPU does not exist or is not online
	pub fn node_for_cpu(&self) -> Option<NodeIndex>
	{
		match unsafe { numa_node_of_cpu(self.0 as c_int) }
		{
			-1 => match errno().0
			{
				::libc::EINVAL => None,
				unexpected @ _ => panic!("numa_node_for_cpu set an unexpected errno {}", unexpected),
			},
			x if x.is_negative() => panic!("numa_num_possible_cpus returned a negative value {}", x),
			value @ _ => Some(NodeIndex(value as u8))
		}
	}
}