.TH "hwlocality_disc_components" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*- .ad l .nh .SH NAME hwlocality_disc_components \- Components and Plugins: Discovery components and backends .SH SYNOPSIS .br .PP .SS "Data Structures" .in +1c .ti -1c .RI "struct \fBhwloc_disc_component\fP" .br .ti -1c .RI "struct \fBhwloc_disc_status\fP" .br .ti -1c .RI "struct \fBhwloc_backend\fP" .br .in -1c .SS "Typedefs" .in +1c .ti -1c .RI "typedef enum \fBhwloc_disc_phase_e\fP \fBhwloc_disc_phase_t\fP" .br .in -1c .SS "Enumerations" .in +1c .ti -1c .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 }" .br .ti -1c .RI "enum \fBhwloc_disc_status_flag_e\fP { \fBHWLOC_DISC_STATUS_FLAG_GOT_ALLOWED_RESOURCES\fP }" .br .in -1c .SS "Functions" .in +1c .ti -1c .RI "struct \fBhwloc_backend\fP * \fBhwloc_backend_alloc\fP (struct hwloc_topology *topology, struct \fBhwloc_disc_component\fP *component)" .br .ti -1c .RI "int \fBhwloc_backend_enable\fP (struct \fBhwloc_backend\fP *backend)" .br .in -1c .SH "Detailed Description" .PP .PP \fBNote\fP .RS 4 These structures and functions may change when \fBHWLOC_COMPONENT_ABI\fP is modified\&. .RE .PP .SH "Typedef Documentation" .PP .SS "typedef enum \fBhwloc_disc_phase_e\fP \fBhwloc_disc_phase_t\fP" .PP Discovery phase\&. .SH "Enumeration Type Documentation" .PP .SS "enum \fBhwloc_disc_phase_e\fP" .PP Discovery phase\&. .PP \fBEnumerator\fP .in +1c .TP \f(BIHWLOC_DISC_PHASE_GLOBAL \fP 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\&. .TP \f(BIHWLOC_DISC_PHASE_CPU \fP CPU discovery\&. .TP \f(BIHWLOC_DISC_PHASE_MEMORY \fP Attach memory to existing CPU objects\&. .TP \f(BIHWLOC_DISC_PHASE_PCI \fP Attach PCI devices and bridges to existing CPU objects\&. .TP \f(BIHWLOC_DISC_PHASE_IO \fP I/O discovery that requires PCI devices (OS devices such as OpenCL, CUDA, etc\&.)\&. .TP \f(BIHWLOC_DISC_PHASE_MISC \fP Misc objects that gets added below anything else\&. .TP \f(BIHWLOC_DISC_PHASE_ANNOTATE \fP Annotating existing objects, adding distances, etc\&. .TP \f(BIHWLOC_DISC_PHASE_TWEAK \fP 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\&. .SS "enum \fBhwloc_disc_status_flag_e\fP" .PP Discovery status flags\&. .PP \fBEnumerator\fP .in +1c .TP \f(BIHWLOC_DISC_STATUS_FLAG_GOT_ALLOWED_RESOURCES \fP The sets of allowed resources were already retrieved\&. .SH "Function Documentation" .PP .SS "struct \fBhwloc_backend\fP * hwloc_backend_alloc (struct hwloc_topology * topology, struct \fBhwloc_disc_component\fP * component)" .PP 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\&. .SS "int hwloc_backend_enable (struct \fBhwloc_backend\fP * backend)" .PP Enable a previously allocated and setup backend\&. .SH "Author" .PP Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.