| 1 |
.TH "hwlocality_generic_components" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*- |
| 2 |
.ad l |
| 3 |
.nh |
| 4 |
.SH NAME |
| 5 |
hwlocality_generic_components \- Components and Plugins: Generic components |
| 6 |
.SH SYNOPSIS |
| 7 |
.br |
| 8 |
.PP |
| 9 |
.SS "Data Structures" |
| 10 |
|
| 11 |
.in +1c |
| 12 |
.ti -1c |
| 13 |
.RI "struct \fBhwloc_component\fP" |
| 14 |
.br |
| 15 |
.in -1c |
| 16 |
.SS "Typedefs" |
| 17 |
|
| 18 |
.in +1c |
| 19 |
.ti -1c |
| 20 |
.RI "typedef enum \fBhwloc_component_type_e\fP \fBhwloc_component_type_t\fP" |
| 21 |
.br |
| 22 |
.in -1c |
| 23 |
.SS "Enumerations" |
| 24 |
|
| 25 |
.in +1c |
| 26 |
.ti -1c |
| 27 |
.RI "enum \fBhwloc_component_type_e\fP { \fBHWLOC_COMPONENT_TYPE_DISC\fP, \fBHWLOC_COMPONENT_TYPE_XML\fP }" |
| 28 |
.br |
| 29 |
.in -1c |
| 30 |
.SS "Functions" |
| 31 |
|
| 32 |
.in +1c |
| 33 |
.ti -1c |
| 34 |
.RI "int \fBhwloc_plugin_check_namespace\fP (const char *pluginname, const char *symbol)" |
| 35 |
.br |
| 36 |
.in -1c |
| 37 |
.SH "Detailed Description" |
| 38 |
.PP |
| 39 |
|
| 40 |
.PP |
| 41 |
\fBNote\fP |
| 42 |
.RS 4 |
| 43 |
These structures and functions may change when \fBHWLOC_COMPONENT_ABI\fP is modified\&. |
| 44 |
.RE |
| 45 |
.PP |
| 46 |
|
| 47 |
.SH "Typedef Documentation" |
| 48 |
.PP |
| 49 |
.SS "typedef enum \fBhwloc_component_type_e\fP \fBhwloc_component_type_t\fP" |
| 50 |
|
| 51 |
.PP |
| 52 |
Generic component type\&. |
| 53 |
.SH "Enumeration Type Documentation" |
| 54 |
.PP |
| 55 |
.SS "enum \fBhwloc_component_type_e\fP" |
| 56 |
|
| 57 |
.PP |
| 58 |
Generic component type\&. |
| 59 |
.PP |
| 60 |
\fBEnumerator\fP |
| 61 |
.in +1c |
| 62 |
.TP |
| 63 |
\f(BIHWLOC_COMPONENT_TYPE_DISC \fP |
| 64 |
The data field must point to a struct \fBhwloc_disc_component\fP\&. |
| 65 |
.TP |
| 66 |
\f(BIHWLOC_COMPONENT_TYPE_XML \fP |
| 67 |
The data field must point to a struct hwloc_xml_component\&. |
| 68 |
.SH "Function Documentation" |
| 69 |
.PP |
| 70 |
.SS "int hwloc_plugin_check_namespace (const char * pluginname, const char * symbol)\fR [inline]\fP" |
| 71 |
|
| 72 |
.PP |
| 73 |
Make sure that plugins can lookup core symbols\&. This is a sanity check to avoid lazy-lookup failures when libhwloc is loaded within a plugin, and later tries to load its own plugins\&. This may fail (and abort the program) if libhwloc symbols are in a private namespace\&. |
| 74 |
|
| 75 |
.PP |
| 76 |
\fBReturns\fP |
| 77 |
.RS 4 |
| 78 |
0 on success\&. |
| 79 |
|
| 80 |
.PP |
| 81 |
-1 if the plugin cannot be successfully loaded\&. The caller plugin init() callback should return a negative error code as well\&. |
| 82 |
.RE |
| 83 |
.PP |
| 84 |
Plugins should call this function in their init() callback to avoid later crashes if lazy symbol resolution is used by the upper layer that loaded hwloc (e\&.g\&. OpenCL implementations using dlopen with RTLD_LAZY)\&. |
| 85 |
|
| 86 |
.PP |
| 87 |
\fBNote\fP |
| 88 |
.RS 4 |
| 89 |
The build system must define HWLOC_INSIDE_PLUGIN if and only if building the caller as a plugin\&. |
| 90 |
|
| 91 |
.PP |
| 92 |
This function should remain inline so plugins can call it even when they cannot find libhwloc symbols\&. |
| 93 |
.RE |
| 94 |
.PP |
| 95 |
|
| 96 |
.SH "Author" |
| 97 |
.PP |
| 98 |
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&. |