| 1 |
.TH "hwloc_disc_component" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*- |
| 2 |
.ad l |
| 3 |
.nh |
| 4 |
.SH NAME |
| 5 |
hwloc_disc_component |
| 6 |
.SH SYNOPSIS |
| 7 |
.br |
| 8 |
.PP |
| 9 |
.PP |
| 10 |
\fR#include <plugins\&.h>\fP |
| 11 |
.SS "Data Fields" |
| 12 |
|
| 13 |
.in +1c |
| 14 |
.ti -1c |
| 15 |
.RI "const char * \fBname\fP" |
| 16 |
.br |
| 17 |
.ti -1c |
| 18 |
.RI "unsigned \fBphases\fP" |
| 19 |
.br |
| 20 |
.ti -1c |
| 21 |
.RI "unsigned \fBexcluded_phases\fP" |
| 22 |
.br |
| 23 |
.ti -1c |
| 24 |
.RI "struct \fBhwloc_backend\fP *(* \fBinstantiate\fP )(struct hwloc_topology *topology, struct \fBhwloc_disc_component\fP *component, unsigned \fBexcluded_phases\fP, const void *data1, const void *data2, const void *data3)" |
| 25 |
.br |
| 26 |
.ti -1c |
| 27 |
.RI "unsigned \fBpriority\fP" |
| 28 |
.br |
| 29 |
.ti -1c |
| 30 |
.RI "unsigned \fBenabled_by_default\fP" |
| 31 |
.br |
| 32 |
.in -1c |
| 33 |
.SH "Detailed Description" |
| 34 |
.PP |
| 35 |
Discovery component structure\&. |
| 36 |
|
| 37 |
This is the major kind of components, taking care of the discovery\&. They are registered by generic components, either statically-built or as plugins\&. |
| 38 |
.SH "Field Documentation" |
| 39 |
.PP |
| 40 |
.SS "unsigned hwloc_disc_component::enabled_by_default" |
| 41 |
|
| 42 |
.PP |
| 43 |
Enabled by default\&. If unset, if will be disabled unless explicitly requested\&. |
| 44 |
.SS "unsigned hwloc_disc_component::excluded_phases" |
| 45 |
|
| 46 |
.PP |
| 47 |
Component phases to exclude, as an OR'ed set of \fBhwloc_disc_phase_t\fP\&. For a GLOBAL component, this usually includes all other phases (\fR~UL\fP)\&. |
| 48 |
|
| 49 |
.PP |
| 50 |
Other components only exclude types that may bring conflicting topology information\&. MISC components should likely not be excluded since they usually bring non-primary additional information\&. |
| 51 |
.SS "struct \fBhwloc_backend\fP *(* hwloc_disc_component::instantiate) (struct hwloc_topology *topology, struct \fBhwloc_disc_component\fP *component, unsigned \fBexcluded_phases\fP, const void *data1, const void *data2, const void *data3)" |
| 52 |
|
| 53 |
.PP |
| 54 |
Instantiate callback to create a backend from the component\&. Parameters data1, data2, data3 are NULL except for components that have special enabling routines such as \fBhwloc_topology_set_xml()\fP\&. |
| 55 |
.SS "const char* hwloc_disc_component::name" |
| 56 |
|
| 57 |
.PP |
| 58 |
Name\&. If this component is built as a plugin, this name does not have to match the plugin filename\&. |
| 59 |
.SS "unsigned hwloc_disc_component::phases" |
| 60 |
|
| 61 |
.PP |
| 62 |
Discovery phases performed by this component\&. OR'ed set of \fBhwloc_disc_phase_t\fP\&. |
| 63 |
.SS "unsigned hwloc_disc_component::priority" |
| 64 |
|
| 65 |
.PP |
| 66 |
Component priority\&. Used to sort topology->components, higher priority first\&. Also used to decide between two components with the same name\&. Usual values are 50 for native OS (or platform) components, 45 for x86, 40 for no-OS fallback, 30 for global components (xml, synthetic), 20 for pci, 10 for other misc components (opencl etc\&.)\&. |
| 67 |
|
| 68 |
.SH "Author" |
| 69 |
.PP |
| 70 |
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&. |