Debian Codegraph @

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

raw
1 .TH "hwlocality_helper_find_inside" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_helper_find_inside \- Finding Objects inside a CPU set
6 .SH SYNOPSIS
7 .br
8 .PP
9 .SS "Functions"
10
11 .in +1c
12 .ti -1c
13 .RI "\fBhwloc_obj_t\fP \fBhwloc_get_first_largest_obj_inside_cpuset\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set)"
14 .br
15 .ti -1c
16 .RI "int \fBhwloc_get_largest_objs_inside_cpuset\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, \fBhwloc_obj_t\fP *restrict objs, int max)"
17 .br
18 .ti -1c
19 .RI "\fBhwloc_obj_t\fP \fBhwloc_get_next_obj_inside_cpuset_by_depth\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, int depth, \fBhwloc_obj_t\fP prev)"
20 .br
21 .ti -1c
22 .RI "\fBhwloc_obj_t\fP \fBhwloc_get_next_obj_inside_cpuset_by_type\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, \fBhwloc_obj_type_t\fP type, \fBhwloc_obj_t\fP prev)"
23 .br
24 .ti -1c
25 .RI "\fBhwloc_obj_t\fP \fBhwloc_get_obj_inside_cpuset_by_depth\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, int depth, unsigned idx)"
26 .br
27 .ti -1c
28 .RI "\fBhwloc_obj_t\fP \fBhwloc_get_obj_inside_cpuset_by_type\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, \fBhwloc_obj_type_t\fP type, unsigned idx)"
29 .br
30 .ti -1c
31 .RI "unsigned \fBhwloc_get_nbobjs_inside_cpuset_by_depth\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, int depth)"
32 .br
33 .ti -1c
34 .RI "int \fBhwloc_get_nbobjs_inside_cpuset_by_type\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, \fBhwloc_obj_type_t\fP type)"
35 .br
36 .ti -1c
37 .RI "int \fBhwloc_get_obj_index_inside_cpuset\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, \fBhwloc_obj_t\fP obj)"
38 .br
39 .in -1c
40 .SH "Detailed Description"
41 .PP
42
43 .SH "Function Documentation"
44 .PP
45 .SS "\fBhwloc_obj_t\fP hwloc_get_first_largest_obj_inside_cpuset (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set)\fR [inline]\fP"
46
47 .PP
48 Get the first largest object included in the given cpuset \fRset\fP\&.
49 .PP
50 \fBReturns\fP
51 .RS 4
52 the first object that is included in \fRset\fP and whose parent is not\&.
53
54 .PP
55 \fRNULL\fP if no such object exists\&.
56 .RE
57 .PP
58 This is convenient for iterating over all largest objects within a CPU set by doing a loop getting the first largest object and clearing its CPU set from the remaining CPU set\&.
59 .SS "int hwloc_get_largest_objs_inside_cpuset (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, \fBhwloc_obj_t\fP *restrict objs, int max)"
60
61 .PP
62 Get the set of largest objects covering exactly a given cpuset \fRset\fP\&.
63 .PP
64 \fBReturns\fP
65 .RS 4
66 the number of objects returned in \fRobjs\fP\&.
67
68 .PP
69 -1 if no set of objects may cover that cpuset\&.
70 .RE
71 .PP
72
73 .SS "unsigned hwloc_get_nbobjs_inside_cpuset_by_depth (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, int depth)\fR [inline]\fP"
74
75 .PP
76 Return the number of objects at depth \fRdepth\fP included in CPU set \fRset\fP\&.
77 .PP
78 \fBReturns\fP
79 .RS 4
80 the number of objects\&.
81
82 .PP
83 0 if the depth is invalid\&.
84 .RE
85 .PP
86 \fBNote\fP
87 .RS 4
88 Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set)\&.
89
90 .PP
91 This function cannot work if objects at the given depth do not have CPU sets (I/O or Misc objects)\&.
92 .RE
93 .PP
94
95 .SS "int hwloc_get_nbobjs_inside_cpuset_by_type (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, \fBhwloc_obj_type_t\fP type)\fR [inline]\fP"
96
97 .PP
98 Return the number of objects of type \fRtype\fP included in CPU set \fRset\fP\&.
99 .PP
100 \fBReturns\fP
101 .RS 4
102 the number of objects\&.
103
104 .PP
105 0 if there are no objects of that type in the topology\&.
106
107 .PP
108 -1 if there are multiple levels of objects of that type, the caller should fallback to \fBhwloc_get_nbobjs_inside_cpuset_by_depth()\fP\&.
109 .RE
110 .PP
111 \fBNote\fP
112 .RS 4
113 Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set)\&.
114
115 .PP
116 This function cannot work if objects of the given type do not have CPU sets (I/O objects)\&.
117 .RE
118 .PP
119
120 .SS "\fBhwloc_obj_t\fP hwloc_get_next_obj_inside_cpuset_by_depth (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, int depth, \fBhwloc_obj_t\fP prev)\fR [inline]\fP"
121
122 .PP
123 Return the next object at depth \fRdepth\fP included in CPU set \fRset\fP\&. The next invokation should pass the previous return value in \fRprev\fP so as to obtain the next object in \fRset\fP\&.
124
125 .PP
126 \fBReturns\fP
127 .RS 4
128 the first object at depth \fRdepth\fP included in \fRset\fP if \fRprev\fP is \fRNULL\fP\&.
129
130 .PP
131 the next object at depth \fRdepth\fP included in \fRset\fP if \fRprev\fP is not \fRNULL\fP\&.
132
133 .PP
134 \fRNULL\fP if there is no next object\&.
135 .RE
136 .PP
137 \fBNote\fP
138 .RS 4
139 Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set)\&.
140
141 .PP
142 This function cannot work if objects at the given depth do not have CPU sets (I/O or Misc objects)\&.
143 .RE
144 .PP
145
146 .SS "\fBhwloc_obj_t\fP hwloc_get_next_obj_inside_cpuset_by_type (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, \fBhwloc_obj_type_t\fP type, \fBhwloc_obj_t\fP prev)\fR [inline]\fP"
147
148 .PP
149 Return the next object of type \fRtype\fP included in CPU set \fRset\fP\&. The next invokation should pass the previous return value in \fRprev\fP so as to obtain the next object in \fRset\fP\&.
150
151 .PP
152 \fBReturns\fP
153 .RS 4
154 the first object of type \fRtype\fP included in \fRset\fP if \fRprev\fP is \fRNULL\fP\&.
155
156 .PP
157 the next object of type \fRtype\fP included in \fRset\fP if \fRprev\fP is not \fRNULL\fP\&.
158
159 .PP
160 \fRNULL\fP if there is no next object\&.
161
162 .PP
163 \fRNULL\fP if there is no depth for the given type\&.
164
165 .PP
166 \fRNULL\fP if there are multiple depths for the given type, the caller should fallback to \fBhwloc_get_next_obj_inside_cpuset_by_depth()\fP\&.
167 .RE
168 .PP
169 \fBNote\fP
170 .RS 4
171 Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set)\&.
172
173 .PP
174 This function cannot work if objects of the given type do not have CPU sets (I/O or Misc objects)\&.
175 .RE
176 .PP
177
178 .SS "int hwloc_get_obj_index_inside_cpuset (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, \fBhwloc_obj_t\fP obj)\fR [inline]\fP"
179
180 .PP
181 Return the logical index among the objects included in CPU set \fRset\fP\&. Consult all objects in the same level as \fRobj\fP and inside CPU set \fRset\fP in the logical order, and return the index of \fRobj\fP within them\&. If \fRset\fP covers the entire topology, this is the logical index of \fRobj\fP\&. Otherwise, this is similar to a logical index within the part of the topology defined by CPU set \fRset\fP\&.
182
183 .PP
184 \fBReturns\fP
185 .RS 4
186 the logical index among the objects included in the set if any\&.
187
188 .PP
189 -1 if the object is not included in the set\&.
190 .RE
191 .PP
192 \fBNote\fP
193 .RS 4
194 Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set)\&.
195
196 .PP
197 This function cannot work if obj does not have CPU sets (I/O objects)\&.
198 .RE
199 .PP
200
201 .SS "\fBhwloc_obj_t\fP hwloc_get_obj_inside_cpuset_by_depth (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, int depth, unsigned idx)\fR [inline]\fP"
202
203 .PP
204 Return the (logically) \fRidx\fP -th object at depth \fRdepth\fP included in CPU set \fRset\fP\&.
205 .PP
206 \fBReturns\fP
207 .RS 4
208 the object if any, \fRNULL\fP otherwise\&.
209 .RE
210 .PP
211 \fBNote\fP
212 .RS 4
213 Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set)\&.
214
215 .PP
216 This function cannot work if objects at the given depth do not have CPU sets (I/O or Misc objects)\&.
217 .RE
218 .PP
219
220 .SS "\fBhwloc_obj_t\fP hwloc_get_obj_inside_cpuset_by_type (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, \fBhwloc_obj_type_t\fP type, unsigned idx)\fR [inline]\fP"
221
222 .PP
223 Return the \fRidx\fP -th object of type \fRtype\fP included in CPU set \fRset\fP\&.
224 .PP
225 \fBReturns\fP
226 .RS 4
227 the object if any\&.
228
229 .PP
230 \fRNULL\fP if there is no such object\&.
231
232 .PP
233 \fRNULL\fP if there is no depth for given type\&.
234
235 .PP
236 \fRNULL\fP if there are multiple depths for given type, the caller should fallback to \fBhwloc_get_obj_inside_cpuset_by_depth()\fP\&.
237 .RE
238 .PP
239 \fBNote\fP
240 .RS 4
241 Objects with empty CPU sets are ignored (otherwise they would be considered included in any given set)\&.
242
243 .PP
244 This function cannot work if objects of the given type do not have CPU sets (I/O or Misc objects)\&.
245 .RE
246 .PP
247
248 .SH "Author"
249 .PP
250 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.