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
|
.TH "hwloc_disc_component" 3 "Version 2.12.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
.ad l
.nh
.SH NAME
hwloc_disc_component
.SH SYNOPSIS
.br
.PP
.PP
\fC#include <plugins\&.h>\fP
.SS "Data Fields"
.in +1c
.ti -1c
.RI "const char * \fBname\fP"
.br
.ti -1c
.RI "unsigned \fBphases\fP"
.br
.ti -1c
.RI "unsigned \fBexcluded_phases\fP"
.br
.ti -1c
.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)"
.br
.ti -1c
.RI "unsigned \fBpriority\fP"
.br
.ti -1c
.RI "unsigned \fBenabled_by_default\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Discovery component structure\&.
This is the major kind of components, taking care of the discovery\&. They are registered by generic components, either statically-built or as plugins\&.
.SH "Field Documentation"
.PP
.SS "unsigned hwloc_disc_component::enabled_by_default"
.PP
Enabled by default\&. If unset, if will be disabled unless explicitly requested\&.
.SS "unsigned hwloc_disc_component::excluded_phases"
.PP
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 (\fC~UL\fP)\&.
.PP
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\&.
.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)"
.PP
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\&.
.SS "const char* hwloc_disc_component::name"
.PP
Name\&. If this component is built as a plugin, this name does not have to match the plugin filename\&.
.SS "unsigned hwloc_disc_component::phases"
.PP
Discovery phases performed by this component\&. OR'ed set of \fBhwloc_disc_phase_t\fP\&.
.SS "unsigned hwloc_disc_component::priority"
.PP
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\&.)\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.
|
