Debian Codegraph @

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

raw
1 .TH "hwlocality_helper_find_covering" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_helper_find_covering \- Finding Objects covering at least 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_child_covering_cpuset\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, \fBhwloc_obj_t\fP parent)"
14 .br
15 .ti -1c
16 .RI "\fBhwloc_obj_t\fP \fBhwloc_get_obj_covering_cpuset\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set)"
17 .br
18 .ti -1c
19 .RI "\fBhwloc_obj_t\fP \fBhwloc_get_next_obj_covering_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_covering_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 .in -1c
25 .SH "Detailed Description"
26 .PP
27
28 .SH "Function Documentation"
29 .PP
30 .SS "\fBhwloc_obj_t\fP hwloc_get_child_covering_cpuset (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, \fBhwloc_obj_t\fP parent)\fR [inline]\fP"
31
32 .PP
33 Get the child covering at least CPU set \fRset\fP\&.
34 .PP
35 \fBReturns\fP
36 .RS 4
37 the child that covers the set entirely\&.
38
39 .PP
40 \fRNULL\fP if no child matches or if \fRset\fP is empty\&.
41 .RE
42 .PP
43 \fBNote\fP
44 .RS 4
45 This function cannot work if parent does not have a CPU set (I/O or Misc objects)\&.
46 .RE
47 .PP
48
49 .SS "\fBhwloc_obj_t\fP hwloc_get_next_obj_covering_cpuset_by_depth (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set, int depth, \fBhwloc_obj_t\fP prev)\fR [inline]\fP"
50
51 .PP
52 Iterate through same-depth objects covering at least CPU set \fRset\fP\&. The next invokation should pass the previous return value in \fRprev\fP so as to obtain the next object covering at least another part of \fRset\fP\&.
53
54 .PP
55 \fBReturns\fP
56 .RS 4
57 the first object at depth \fRdepth\fP covering at least part of CPU set \fRset\fP if object \fRprev\fP is \fRNULL\fP\&.
58
59 .PP
60 the next one if \fRprev\fP is not \fRNULL\fP\&.
61
62 .PP
63 \fRNULL\fP if there is no next object\&.
64 .RE
65 .PP
66 \fBNote\fP
67 .RS 4
68 This function cannot work if objects at the given depth do not have CPU sets (I/O or Misc objects)\&.
69 .RE
70 .PP
71
72 .SS "\fBhwloc_obj_t\fP hwloc_get_next_obj_covering_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"
73
74 .PP
75 Iterate through same-type objects covering at least CPU set \fRset\fP\&. The next invokation should pass the previous return value in \fRprev\fP so as to obtain the next object of type \fRtype\fP covering at least another part of \fRset\fP\&.
76
77 .PP
78 \fBReturns\fP
79 .RS 4
80 the first object of type \fRtype\fP covering at least part of CPU set \fRset\fP if object \fRprev\fP is \fRNULL\fP\&.
81
82 .PP
83 the next one if \fRprev\fP is not \fRNULL\fP\&.
84
85 .PP
86 \fRNULL\fP if there is no next object\&.
87
88 .PP
89 \fRNULL\fP if there is no depth for the given type\&.
90
91 .PP
92 \fRNULL\fP if there are multiple depths for the given type, the caller should fallback to \fBhwloc_get_next_obj_covering_cpuset_by_depth()\fP\&.
93 .RE
94 .PP
95 \fBNote\fP
96 .RS 4
97 This function cannot work if objects of the given type do not have CPU sets (I/O or Misc objects)\&.
98 .RE
99 .PP
100
101 .SS "\fBhwloc_obj_t\fP hwloc_get_obj_covering_cpuset (\fBhwloc_topology_t\fP topology, \fBhwloc_const_cpuset_t\fP set)\fR [inline]\fP"
102
103 .PP
104 Get the lowest object covering at least CPU set \fRset\fP\&.
105 .PP
106 \fBReturns\fP
107 .RS 4
108 the lowest object covering the set entirely\&.
109
110 .PP
111 \fRNULL\fP if no object matches or if \fRset\fP is empty\&.
112 .RE
113 .PP
114
115 .SH "Author"
116 .PP
117 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.