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
|
.TH "hwlocality_disc_backends" 3 "Thu Feb 11 2021" "Version 2.4.1" "Hardware Locality (hwloc)" \" -*- nroff -*-
.ad l
.nh
.SH NAME
hwlocality_disc_backends \- Components and Plugins: Discovery backends
.SH SYNOPSIS
.br
.PP
.SS "Data Structures"
.in +1c
.ti -1c
.RI "struct \fBhwloc_disc_status\fP"
.br
.ti -1c
.RI "struct \fBhwloc_backend\fP"
.br
.in -1c
.SS "Typedefs"
.in +1c
.ti -1c
.RI "typedef enum \fBhwloc_disc_phase_e\fP \fBhwloc_disc_phase_t\fP"
.br
.in -1c
.SS "Enumerations"
.in +1c
.ti -1c
.RI "enum \fBhwloc_disc_phase_e\fP { \fBHWLOC_DISC_PHASE_GLOBAL\fP, \fBHWLOC_DISC_PHASE_CPU\fP, \fBHWLOC_DISC_PHASE_MEMORY\fP, \fBHWLOC_DISC_PHASE_PCI\fP, \fBHWLOC_DISC_PHASE_IO\fP, \fBHWLOC_DISC_PHASE_MISC\fP, \fBHWLOC_DISC_PHASE_ANNOTATE\fP, \fBHWLOC_DISC_PHASE_TWEAK\fP }"
.br
.ti -1c
.RI "enum \fBhwloc_disc_status_flag_e\fP { \fBHWLOC_DISC_STATUS_FLAG_GOT_ALLOWED_RESOURCES\fP }"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "struct \fBhwloc_backend\fP * \fBhwloc_backend_alloc\fP (struct hwloc_topology *topology, struct \fBhwloc_disc_component\fP *component)"
.br
.ti -1c
.RI "int \fBhwloc_backend_enable\fP (struct \fBhwloc_backend\fP *backend)"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Typedef Documentation"
.PP
.SS "typedef enum \fBhwloc_disc_phase_e\fP \fBhwloc_disc_phase_t\fP"
.PP
Discovery phase\&.
.SH "Enumeration Type Documentation"
.PP
.SS "enum \fBhwloc_disc_phase_e\fP"
.PP
Discovery phase\&.
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIHWLOC_DISC_PHASE_GLOBAL \fP\fP
xml or synthetic, platform-specific components such as bgq\&. Discovers everything including CPU, memory, I/O and everything else\&. A component with a Global phase usually excludes all other phases\&.
.TP
\fB\fIHWLOC_DISC_PHASE_CPU \fP\fP
CPU discovery\&.
.TP
\fB\fIHWLOC_DISC_PHASE_MEMORY \fP\fP
Attach memory to existing CPU objects\&.
.TP
\fB\fIHWLOC_DISC_PHASE_PCI \fP\fP
Attach PCI devices and bridges to existing CPU objects\&.
.TP
\fB\fIHWLOC_DISC_PHASE_IO \fP\fP
I/O discovery that requires PCI devices (OS devices such as OpenCL, CUDA, etc\&.)\&.
.TP
\fB\fIHWLOC_DISC_PHASE_MISC \fP\fP
Misc objects that gets added below anything else\&.
.TP
\fB\fIHWLOC_DISC_PHASE_ANNOTATE \fP\fP
Annotating existing objects, adding distances, etc\&.
.TP
\fB\fIHWLOC_DISC_PHASE_TWEAK \fP\fP
Final tweaks to a ready-to-use topology\&. This phase runs once the topology is loaded, before it is returned to the topology\&. Hence it may only use the main hwloc API for modifying the topology, for instance by restricting it, adding info attributes, etc\&.
.SS "enum \fBhwloc_disc_status_flag_e\fP"
.PP
Discovery status flags\&.
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIHWLOC_DISC_STATUS_FLAG_GOT_ALLOWED_RESOURCES \fP\fP
The sets of allowed resources were already retrieved\&.
.SH "Function Documentation"
.PP
.SS "struct \fBhwloc_backend\fP* hwloc_backend_alloc (struct hwloc_topology * topology, struct \fBhwloc_disc_component\fP * component)"
.PP
Allocate a backend structure, set good default values, initialize backend->component and topology, etc\&. The caller will then modify whatever needed, and call \fBhwloc_backend_enable()\fP\&.
.SS "int hwloc_backend_enable (struct \fBhwloc_backend\fP * backend)"
.PP
Enable a previously allocated and setup backend\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.
|
