Debian Codegraph @

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

raw
1 .TH "hwloc_component" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwloc_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 "unsigned \fBabi\fP"
16 .br
17 .ti -1c
18 .RI "int(* \fBinit\fP )(unsigned long \fBflags\fP)"
19 .br
20 .ti -1c
21 .RI "void(* \fBfinalize\fP )(unsigned long \fBflags\fP)"
22 .br
23 .ti -1c
24 .RI "\fBhwloc_component_type_t\fP \fBtype\fP"
25 .br
26 .ti -1c
27 .RI "unsigned long \fBflags\fP"
28 .br
29 .ti -1c
30 .RI "void * \fBdata\fP"
31 .br
32 .in -1c
33 .SH "Detailed Description"
34 .PP
35 Generic component structure\&.
36
37 Generic components structure, either statically listed by configure in static-components\&.h or dynamically loaded as a plugin\&.
38 .SH "Field Documentation"
39 .PP
40 .SS "unsigned hwloc_component::abi"
41
42 .PP
43 Component ABI version, set to \fBHWLOC_COMPONENT_ABI\fP\&.
44 .SS "void* hwloc_component::data"
45
46 .PP
47 Component data, pointing to a struct \fBhwloc_disc_component\fP or struct hwloc_xml_component\&.
48 .SS "void(* hwloc_component::finalize) (unsigned long \fBflags\fP)"
49
50 .PP
51 Process-wide component termination callback\&. This optional callback is called after unregistering the component from the hwloc core (before unloading the plugin)\&.
52
53 .PP
54 \fRflags\fP is always 0 for now\&.
55
56 .PP
57 \fBNote\fP
58 .RS 4
59 If the component uses ltdl for loading its own plugins, it should load/unload them only in \fBinit()\fP and \fBfinalize()\fP, to avoid race conditions with hwloc's use of ltdl\&.
60 .RE
61 .PP
62
63 .SS "unsigned long hwloc_component::flags"
64
65 .PP
66 Component flags, unused for now\&.
67 .SS "int(* hwloc_component::init) (unsigned long \fBflags\fP)"
68
69 .PP
70 Process-wide component initialization callback\&. This optional callback is called when the component is registered to the hwloc core (after loading the plugin)\&.
71
72 .PP
73 When the component is built as a plugin, this callback should call hwloc_check_plugin_namespace() and return an negative error code on error\&.
74
75 .PP
76 \fRflags\fP is always 0 for now\&.
77
78 .PP
79 \fBReturns\fP
80 .RS 4
81 0 on success, or a negative code on error\&.
82 .RE
83 .PP
84 \fBNote\fP
85 .RS 4
86 If the component uses ltdl for loading its own plugins, it should load/unload them only in \fBinit()\fP and \fBfinalize()\fP, to avoid race conditions with hwloc's use of ltdl\&.
87 .RE
88 .PP
89
90 .SS "\fBhwloc_component_type_t\fP hwloc_component::type"
91
92 .PP
93 Component type\&.
94
95 .SH "Author"
96 .PP
97 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.