| 1 |
.TH "hwlocality_disc_components" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*- |
| 2 |
.ad l |
| 3 |
.nh |
| 4 |
.SH NAME |
| 5 |
hwlocality_disc_components \- Components and Plugins: Discovery components and backends |
| 6 |
.SH SYNOPSIS |
| 7 |
.br |
| 8 |
.PP |
| 9 |
.SS "Data Structures" |
| 10 |
|
| 11 |
.in +1c |
| 12 |
.ti -1c |
| 13 |
.RI "struct \fBhwloc_disc_component\fP" |
| 14 |
.br |
| 15 |
.ti -1c |
| 16 |
.RI "struct \fBhwloc_disc_status\fP" |
| 17 |
.br |
| 18 |
.ti -1c |
| 19 |
.RI "struct \fBhwloc_backend\fP" |
| 20 |
.br |
| 21 |
.in -1c |
| 22 |
.SS "Typedefs" |
| 23 |
|
| 24 |
.in +1c |
| 25 |
.ti -1c |
| 26 |
.RI "typedef enum \fBhwloc_disc_phase_e\fP \fBhwloc_disc_phase_t\fP" |
| 27 |
.br |
| 28 |
.in -1c |
| 29 |
.SS "Enumerations" |
| 30 |
|
| 31 |
.in +1c |
| 32 |
.ti -1c |
| 33 |
.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 }" |
| 34 |
.br |
| 35 |
.ti -1c |
| 36 |
.RI "enum \fBhwloc_disc_status_flag_e\fP { \fBHWLOC_DISC_STATUS_FLAG_GOT_ALLOWED_RESOURCES\fP }" |
| 37 |
.br |
| 38 |
.in -1c |
| 39 |
.SS "Functions" |
| 40 |
|
| 41 |
.in +1c |
| 42 |
.ti -1c |
| 43 |
.RI "struct \fBhwloc_backend\fP * \fBhwloc_backend_alloc\fP (struct hwloc_topology *topology, struct \fBhwloc_disc_component\fP *component)" |
| 44 |
.br |
| 45 |
.ti -1c |
| 46 |
.RI "int \fBhwloc_backend_enable\fP (struct \fBhwloc_backend\fP *backend)" |
| 47 |
.br |
| 48 |
.in -1c |
| 49 |
.SH "Detailed Description" |
| 50 |
.PP |
| 51 |
|
| 52 |
.PP |
| 53 |
\fBNote\fP |
| 54 |
.RS 4 |
| 55 |
These structures and functions may change when \fBHWLOC_COMPONENT_ABI\fP is modified\&. |
| 56 |
.RE |
| 57 |
.PP |
| 58 |
|
| 59 |
.SH "Typedef Documentation" |
| 60 |
.PP |
| 61 |
.SS "typedef enum \fBhwloc_disc_phase_e\fP \fBhwloc_disc_phase_t\fP" |
| 62 |
|
| 63 |
.PP |
| 64 |
Discovery phase\&. |
| 65 |
.SH "Enumeration Type Documentation" |
| 66 |
.PP |
| 67 |
.SS "enum \fBhwloc_disc_phase_e\fP" |
| 68 |
|
| 69 |
.PP |
| 70 |
Discovery phase\&. |
| 71 |
.PP |
| 72 |
\fBEnumerator\fP |
| 73 |
.in +1c |
| 74 |
.TP |
| 75 |
\f(BIHWLOC_DISC_PHASE_GLOBAL \fP |
| 76 |
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\&. |
| 77 |
.TP |
| 78 |
\f(BIHWLOC_DISC_PHASE_CPU \fP |
| 79 |
CPU discovery\&. |
| 80 |
.TP |
| 81 |
\f(BIHWLOC_DISC_PHASE_MEMORY \fP |
| 82 |
Attach memory to existing CPU objects\&. |
| 83 |
.TP |
| 84 |
\f(BIHWLOC_DISC_PHASE_PCI \fP |
| 85 |
Attach PCI devices and bridges to existing CPU objects\&. |
| 86 |
.TP |
| 87 |
\f(BIHWLOC_DISC_PHASE_IO \fP |
| 88 |
I/O discovery that requires PCI devices (OS devices such as OpenCL, CUDA, etc\&.)\&. |
| 89 |
.TP |
| 90 |
\f(BIHWLOC_DISC_PHASE_MISC \fP |
| 91 |
Misc objects that gets added below anything else\&. |
| 92 |
.TP |
| 93 |
\f(BIHWLOC_DISC_PHASE_ANNOTATE \fP |
| 94 |
Annotating existing objects, adding distances, etc\&. |
| 95 |
.TP |
| 96 |
\f(BIHWLOC_DISC_PHASE_TWEAK \fP |
| 97 |
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\&. |
| 98 |
.SS "enum \fBhwloc_disc_status_flag_e\fP" |
| 99 |
|
| 100 |
.PP |
| 101 |
Discovery status flags\&. |
| 102 |
.PP |
| 103 |
\fBEnumerator\fP |
| 104 |
.in +1c |
| 105 |
.TP |
| 106 |
\f(BIHWLOC_DISC_STATUS_FLAG_GOT_ALLOWED_RESOURCES \fP |
| 107 |
The sets of allowed resources were already retrieved\&. |
| 108 |
.SH "Function Documentation" |
| 109 |
.PP |
| 110 |
.SS "struct \fBhwloc_backend\fP * hwloc_backend_alloc (struct hwloc_topology * topology, struct \fBhwloc_disc_component\fP * component)" |
| 111 |
|
| 112 |
.PP |
| 113 |
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\&. |
| 114 |
.SS "int hwloc_backend_enable (struct \fBhwloc_backend\fP * backend)" |
| 115 |
|
| 116 |
.PP |
| 117 |
Enable a previously allocated and setup backend\&. |
| 118 |
.SH "Author" |
| 119 |
.PP |
| 120 |
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&. |