Debian Codegraph @

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

raw
1 .TH "hwlocality_object_sets" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_object_sets \- Object Sets (hwloc_cpuset_t and hwloc_nodeset_t)
6 .SH SYNOPSIS
7 .br
8 .PP
9 .SS "Typedefs"
10
11 .in +1c
12 .ti -1c
13 .RI "typedef \fBhwloc_bitmap_t\fP \fBhwloc_cpuset_t\fP"
14 .br
15 .ti -1c
16 .RI "typedef \fBhwloc_const_bitmap_t\fP \fBhwloc_const_cpuset_t\fP"
17 .br
18 .ti -1c
19 .RI "typedef \fBhwloc_bitmap_t\fP \fBhwloc_nodeset_t\fP"
20 .br
21 .ti -1c
22 .RI "typedef \fBhwloc_const_bitmap_t\fP \fBhwloc_const_nodeset_t\fP"
23 .br
24 .in -1c
25 .SH "Detailed Description"
26 .PP
27 Hwloc uses bitmaps to represent two distinct kinds of object sets: CPU sets (\fBhwloc_cpuset_t\fP) and NUMA node sets (\fBhwloc_nodeset_t\fP)\&. These types are both typedefs to a common back end type (\fBhwloc_bitmap_t\fP), and therefore all the hwloc bitmap functions are applicable to both \fBhwloc_cpuset_t\fP and \fBhwloc_nodeset_t\fP (see \fBThe bitmap API\fP)\&.
28
29 .PP
30 The rationale for having two different types is that even though the actions one wants to perform on these types are the same (e\&.g\&., enable and disable individual items in the set/mask), they're used in very different contexts: one for specifying which processors to use and one for specifying which NUMA nodes to use\&. Hence, the name difference is really just to reflect the intent of where the type is used\&.
31 .SH "Typedef Documentation"
32 .PP
33 .SS "typedef \fBhwloc_const_bitmap_t\fP \fBhwloc_const_cpuset_t\fP"
34
35 .PP
36 A non-modifiable \fBhwloc_cpuset_t\fP\&.
37 .SS "typedef \fBhwloc_const_bitmap_t\fP \fBhwloc_const_nodeset_t\fP"
38
39 .PP
40 A non-modifiable \fBhwloc_nodeset_t\fP\&.
41 .SS "typedef \fBhwloc_bitmap_t\fP \fBhwloc_cpuset_t\fP"
42
43 .PP
44 A CPU set is a bitmap whose bits are set according to CPU physical OS indexes\&. It may be consulted and modified with the bitmap API as any \fBhwloc_bitmap_t\fP (see \fBhwloc/bitmap\&.h\fP)\&.
45
46 .PP
47 Each bit may be converted into a PU object using \fBhwloc_get_pu_obj_by_os_index()\fP\&.
48 .PP
49 \fBSee also\fP
50 .RS 4
51 faq_indexes
52 .RE
53 .PP
54
55 .SS "typedef \fBhwloc_bitmap_t\fP \fBhwloc_nodeset_t\fP"
56
57 .PP
58 A node set is a bitmap whose bits are set according to NUMA memory node physical OS indexes\&. It may be consulted and modified with the bitmap API as any \fBhwloc_bitmap_t\fP (see \fBhwloc/bitmap\&.h\fP)\&. Each bit may be converted into a NUMA node object using \fBhwloc_get_numanode_obj_by_os_index()\fP\&.
59 .PP
60 \fBSee also\fP
61 .RS 4
62 faq_indexes
63 .RE
64 .PP
65 When binding memory on a system without any NUMA node, the single main memory bank is considered as NUMA node #0\&.
66
67 .PP
68 See also \fBConverting between CPU sets and node sets\fP\&.
69 .SH "Author"
70 .PP
71 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.