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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
.TH "CPU and node sets of entire topologies" 3 "Tue Oct 7 2014" "Version 1.10.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
.ad l
.nh
.SH NAME
CPU and node sets of entire topologies \-
.SS "Functions"
.in +1c
.ti -1c
.RI "static \fBhwloc_const_cpuset_t\fP \fBhwloc_topology_get_complete_cpuset\fP (\fBhwloc_topology_t\fP topology)"
.br
.ti -1c
.RI "static \fBhwloc_const_cpuset_t\fP \fBhwloc_topology_get_topology_cpuset\fP (\fBhwloc_topology_t\fP topology)"
.br
.ti -1c
.RI "static \fBhwloc_const_cpuset_t\fP \fBhwloc_topology_get_online_cpuset\fP (\fBhwloc_topology_t\fP topology)"
.br
.ti -1c
.RI "static \fBhwloc_const_cpuset_t\fP \fBhwloc_topology_get_allowed_cpuset\fP (\fBhwloc_topology_t\fP topology)"
.br
.ti -1c
.RI "static \fBhwloc_const_nodeset_t\fP \fBhwloc_topology_get_complete_nodeset\fP (\fBhwloc_topology_t\fP topology)"
.br
.ti -1c
.RI "static \fBhwloc_const_nodeset_t\fP \fBhwloc_topology_get_topology_nodeset\fP (\fBhwloc_topology_t\fP topology)"
.br
.ti -1c
.RI "static \fBhwloc_const_nodeset_t\fP \fBhwloc_topology_get_allowed_nodeset\fP (\fBhwloc_topology_t\fP topology)"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Function Documentation"
.PP
.SS "static \fBhwloc_const_cpuset_t\fP hwloc_topology_get_allowed_cpuset (\fBhwloc_topology_t\fPtopology)\fC [inline]\fP, \fC [static]\fP"
.PP
Get allowed CPU set\&.
.PP
\fBReturns:\fP
.RS 4
the CPU set of allowed logical processors of the system\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
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\&.
.RE
.PP
.SS "static \fBhwloc_const_nodeset_t\fP hwloc_topology_get_allowed_nodeset (\fBhwloc_topology_t\fPtopology)\fC [inline]\fP, \fC [static]\fP"
.PP
Get allowed node set\&.
.PP
\fBReturns:\fP
.RS 4
the node set of allowed memory of the system\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
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\&.
.RE
.PP
.SS "static \fBhwloc_const_cpuset_t\fP hwloc_topology_get_complete_cpuset (\fBhwloc_topology_t\fPtopology)\fC [inline]\fP, \fC [static]\fP"
.PP
Get complete CPU set\&.
.PP
\fBReturns:\fP
.RS 4
the complete CPU set of logical processors of the system\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
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\&.
.RE
.PP
.SS "static \fBhwloc_const_nodeset_t\fP hwloc_topology_get_complete_nodeset (\fBhwloc_topology_t\fPtopology)\fC [inline]\fP, \fC [static]\fP"
.PP
Get complete node set\&.
.PP
\fBReturns:\fP
.RS 4
the complete node set of memory of the system\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
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\&.
.RE
.PP
.SS "static \fBhwloc_const_cpuset_t\fP hwloc_topology_get_online_cpuset (\fBhwloc_topology_t\fPtopology)\fC [inline]\fP, \fC [static]\fP"
.PP
Get online CPU set\&.
.PP
\fBReturns:\fP
.RS 4
the CPU set of online logical processors of the system\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
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\&.
.RE
.PP
.SS "static \fBhwloc_const_cpuset_t\fP hwloc_topology_get_topology_cpuset (\fBhwloc_topology_t\fPtopology)\fC [inline]\fP, \fC [static]\fP"
.PP
Get topology CPU set\&.
.PP
\fBReturns:\fP
.RS 4
the CPU set of logical processors of the system for which hwloc provides topology information\&. This is equivalent to the cpuset of the system object\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
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\&.
.RE
.PP
.SS "static \fBhwloc_const_nodeset_t\fP hwloc_topology_get_topology_nodeset (\fBhwloc_topology_t\fPtopology)\fC [inline]\fP, \fC [static]\fP"
.PP
Get topology node set\&.
.PP
\fBReturns:\fP
.RS 4
the node set of memory of the system for which hwloc provides topology information\&. This is equivalent to the nodeset of the system object\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
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\&.
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.
|
