Debian Codegraph @

doc/doxygen-doc/man/man3/hwlocality_helper_nodeset_convert.3

raw
1 .TH "hwlocality_helper_nodeset_convert" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_helper_nodeset_convert \- Converting between CPU sets and node sets
6 .SH SYNOPSIS
7 .br
8 .PP
9 .SS "Functions"
10
11 .in +1c
12 .ti -1c
13 .RI "int \fBhwloc_cpuset_to_nodeset\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP _cpuset, \fBhwloc_nodeset_t\fP nodeset)"
14 .br
15 .ti -1c
16 .RI "int \fBhwloc_cpuset_from_nodeset\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_cpuset_t\fP _cpuset, \fBhwloc_const_nodeset_t\fP nodeset)"
17 .br
18 .in -1c
19 .SH "Detailed Description"
20 .PP
21
22 .SH "Function Documentation"
23 .PP
24 .SS "int hwloc_cpuset_from_nodeset (\fBhwloc_topology_t\fP topology, \fBhwloc_cpuset_t\fP _cpuset, \fBhwloc_const_nodeset_t\fP nodeset)\fR [inline]\fP"
25
26 .PP
27 Convert a NUMA node set into a CPU set\&. For each NUMA node included in the input \fRnodeset\fP, set the corresponding local PUs in the output \fR_cpuset\fP\&.
28
29 .PP
30 If some CPUs have no local NUMA nodes, this function never sets their indexes in the output CPU set, even if a full node set is given in input\&.
31
32 .PP
33 Hence the entire topology node set is converted into the set of all CPUs that have some local NUMA nodes\&.
34
35 .PP
36 \fBReturns\fP
37 .RS 4
38 0 on success\&.
39
40 .PP
41 -1 with errno set to \fRENOMEM\fP on internal reallocation failure\&.
42 .RE
43 .PP
44
45 .SS "int hwloc_cpuset_to_nodeset (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP _cpuset, \fBhwloc_nodeset_t\fP nodeset)\fR [inline]\fP"
46
47 .PP
48 Convert a CPU set into a NUMA node set\&. For each PU included in the input \fR_cpuset\fP, set the corresponding local NUMA node(s) in the output \fRnodeset\fP\&.
49
50 .PP
51 If some NUMA nodes have no CPUs at all, this function never sets their indexes in the output node set, even if a full CPU set is given in input\&.
52
53 .PP
54 Hence the entire topology CPU set is converted into the set of all nodes that have some local CPUs\&.
55
56 .PP
57 \fBReturns\fP
58 .RS 4
59 0 on success\&.
60
61 .PP
62 -1 with errno set to \fRENOMEM\fP on internal reallocation failure\&.
63 .RE
64 .PP
65
66 .SH "Author"
67 .PP
68 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.