Debian Codegraph @

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

raw
1 .TH "hwlocality_helper_topology_sets" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_helper_topology_sets \- CPU and node sets of entire topologies
6 .SH SYNOPSIS
7 .br
8 .PP
9 .SS "Functions"
10
11 .in +1c
12 .ti -1c
13 .RI "\fBhwloc_const_cpuset_t\fP \fBhwloc_topology_get_complete_cpuset\fP (\fBhwloc_topology_t\fP topology)"
14 .br
15 .ti -1c
16 .RI "\fBhwloc_const_cpuset_t\fP \fBhwloc_topology_get_topology_cpuset\fP (\fBhwloc_topology_t\fP topology)"
17 .br
18 .ti -1c
19 .RI "\fBhwloc_const_cpuset_t\fP \fBhwloc_topology_get_allowed_cpuset\fP (\fBhwloc_topology_t\fP topology)"
20 .br
21 .ti -1c
22 .RI "\fBhwloc_const_nodeset_t\fP \fBhwloc_topology_get_complete_nodeset\fP (\fBhwloc_topology_t\fP topology)"
23 .br
24 .ti -1c
25 .RI "\fBhwloc_const_nodeset_t\fP \fBhwloc_topology_get_topology_nodeset\fP (\fBhwloc_topology_t\fP topology)"
26 .br
27 .ti -1c
28 .RI "\fBhwloc_const_nodeset_t\fP \fBhwloc_topology_get_allowed_nodeset\fP (\fBhwloc_topology_t\fP topology)"
29 .br
30 .in -1c
31 .SH "Detailed Description"
32 .PP
33
34 .SH "Function Documentation"
35 .PP
36 .SS "\fBhwloc_const_cpuset_t\fP hwloc_topology_get_allowed_cpuset (\fBhwloc_topology_t\fP topology)"
37
38 .PP
39 Get allowed CPU set\&.
40 .PP
41 \fBReturns\fP
42 .RS 4
43 the CPU set of allowed processors of the system\&.
44 .RE
45 .PP
46 \fBNote\fP
47 .RS 4
48 This function cannot return \fRNULL\fP\&.
49
50 .PP
51 If the topology flag \fBHWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED\fP was not set, this is identical to \fBhwloc_topology_get_topology_cpuset()\fP, which means all PUs are allowed\&.
52
53 .PP
54 If \fBHWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED\fP was set, applying \fBhwloc_bitmap_intersects()\fP on the result of this function and on an object cpuset checks whether there are allowed PUs inside that object\&. Applying \fBhwloc_bitmap_and()\fP returns the list of these allowed PUs\&.
55
56 .PP
57 The returned cpuset is not newly allocated and should thus not be changed or freed, \fBhwloc_bitmap_dup()\fP must be used to obtain a local copy\&.
58 .RE
59 .PP
60
61 .SS "\fBhwloc_const_nodeset_t\fP hwloc_topology_get_allowed_nodeset (\fBhwloc_topology_t\fP topology)"
62
63 .PP
64 Get allowed node set\&.
65 .PP
66 \fBReturns\fP
67 .RS 4
68 the node set of allowed memory of the system\&.
69 .RE
70 .PP
71 \fBNote\fP
72 .RS 4
73 This function cannot return \fRNULL\fP\&.
74
75 .PP
76 If the topology flag \fBHWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED\fP was not set, this is identical to \fBhwloc_topology_get_topology_nodeset()\fP, which means all NUMA nodes are allowed\&.
77
78 .PP
79 If \fBHWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED\fP was set, applying \fBhwloc_bitmap_intersects()\fP on the result of this function and on an object nodeset checks whether there are allowed NUMA nodes inside that object\&. Applying \fBhwloc_bitmap_and()\fP returns the list of these allowed NUMA nodes\&.
80
81 .PP
82 The returned nodeset is not newly allocated and should thus not be changed or freed, \fBhwloc_bitmap_dup()\fP must be used to obtain a local copy\&.
83 .RE
84 .PP
85
86 .SS "\fBhwloc_const_cpuset_t\fP hwloc_topology_get_complete_cpuset (\fBhwloc_topology_t\fP topology)"
87
88 .PP
89 Get complete CPU set\&.
90 .PP
91 \fBReturns\fP
92 .RS 4
93 the complete CPU set of processors of the system\&.
94 .RE
95 .PP
96 \fBNote\fP
97 .RS 4
98 This function cannot return \fRNULL\fP\&.
99
100 .PP
101 The returned cpuset is not newly allocated and should thus not be changed or freed; \fBhwloc_bitmap_dup()\fP must be used to obtain a local copy\&.
102
103 .PP
104 This is equivalent to retrieving the root object complete CPU-set\&.
105 .RE
106 .PP
107
108 .SS "\fBhwloc_const_nodeset_t\fP hwloc_topology_get_complete_nodeset (\fBhwloc_topology_t\fP topology)"
109
110 .PP
111 Get complete node set\&.
112 .PP
113 \fBReturns\fP
114 .RS 4
115 the complete node set of memory of the system\&.
116 .RE
117 .PP
118 \fBNote\fP
119 .RS 4
120 This function cannot return \fRNULL\fP\&.
121
122 .PP
123 The returned nodeset is not newly allocated and should thus not be changed or freed; \fBhwloc_bitmap_dup()\fP must be used to obtain a local copy\&.
124
125 .PP
126 This is equivalent to retrieving the root object complete nodeset\&.
127 .RE
128 .PP
129
130 .SS "\fBhwloc_const_cpuset_t\fP hwloc_topology_get_topology_cpuset (\fBhwloc_topology_t\fP topology)"
131
132 .PP
133 Get topology CPU set\&.
134 .PP
135 \fBReturns\fP
136 .RS 4
137 the CPU set of processors of the system for which hwloc provides topology information\&. This is equivalent to the cpuset of the system object\&.
138 .RE
139 .PP
140 \fBNote\fP
141 .RS 4
142 This function cannot return \fRNULL\fP\&.
143
144 .PP
145 The returned cpuset is not newly allocated and should thus not be changed or freed; \fBhwloc_bitmap_dup()\fP must be used to obtain a local copy\&.
146
147 .PP
148 This is equivalent to retrieving the root object CPU-set\&.
149 .RE
150 .PP
151
152 .SS "\fBhwloc_const_nodeset_t\fP hwloc_topology_get_topology_nodeset (\fBhwloc_topology_t\fP topology)"
153
154 .PP
155 Get topology node set\&.
156 .PP
157 \fBReturns\fP
158 .RS 4
159 the node set of memory of the system for which hwloc provides topology information\&. This is equivalent to the nodeset of the system object\&.
160 .RE
161 .PP
162 \fBNote\fP
163 .RS 4
164 This function cannot return \fRNULL\fP\&.
165
166 .PP
167 The returned nodeset is not newly allocated and should thus not be changed or freed; \fBhwloc_bitmap_dup()\fP must be used to obtain a local copy\&.
168
169 .PP
170 This is equivalent to retrieving the root object nodeset\&.
171 .RE
172 .PP
173
174 .SH "Author"
175 .PP
176 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.