| 1 |
.TH "hwloc_backend" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*- |
| 2 |
.ad l |
| 3 |
.nh |
| 4 |
.SH NAME |
| 5 |
hwloc_backend |
| 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 \fBphases\fP" |
| 16 |
.br |
| 17 |
.ti -1c |
| 18 |
.RI "unsigned long \fBflags\fP" |
| 19 |
.br |
| 20 |
.ti -1c |
| 21 |
.RI "int \fBis_thissystem\fP" |
| 22 |
.br |
| 23 |
.ti -1c |
| 24 |
.RI "void * \fBprivate_data\fP" |
| 25 |
.br |
| 26 |
.ti -1c |
| 27 |
.RI "void(* \fBdisable\fP )(struct \fBhwloc_backend\fP *backend)" |
| 28 |
.br |
| 29 |
.ti -1c |
| 30 |
.RI "int(* \fBdiscover\fP )(struct \fBhwloc_backend\fP *backend, struct \fBhwloc_disc_status\fP *status)" |
| 31 |
.br |
| 32 |
.ti -1c |
| 33 |
.RI "int(* \fBget_pci_busid_cpuset\fP )(struct \fBhwloc_backend\fP *backend, struct hwloc_pcidev_attr_s *busid, \fBhwloc_bitmap_t\fP cpuset)" |
| 34 |
.br |
| 35 |
.in -1c |
| 36 |
.SH "Detailed Description" |
| 37 |
.PP |
| 38 |
Discovery backend structure\&. |
| 39 |
|
| 40 |
A backend is the instantiation of a discovery component\&. When a component gets enabled for a topology, its instantiate() callback creates a backend\&. |
| 41 |
|
| 42 |
.PP |
| 43 |
\fBhwloc_backend_alloc()\fP initializes all fields to default values that the component may change (except "component" and "next") before enabling the backend with \fBhwloc_backend_enable()\fP\&. |
| 44 |
|
| 45 |
.PP |
| 46 |
Most backends assume that the topology is_thissystem flag is set because they talk to the underlying operating system\&. However they may still be used in topologies without the is_thissystem flag for debugging reasons\&. In practice, they are usually auto-disabled in such cases (excluded by xml or synthetic backends, or by environment variables when changing the Linux fsroot or the x86 cpuid path)\&. |
| 47 |
.SH "Field Documentation" |
| 48 |
.PP |
| 49 |
.SS "void(* hwloc_backend::disable) (struct \fBhwloc_backend\fP *backend)" |
| 50 |
|
| 51 |
.PP |
| 52 |
Callback for freeing the private_data\&. May be NULL\&. |
| 53 |
.SS "int(* hwloc_backend::discover) (struct \fBhwloc_backend\fP *backend, struct \fBhwloc_disc_status\fP *status)" |
| 54 |
|
| 55 |
.PP |
| 56 |
Main discovery callback\&. returns -1 on error, either because it couldn't add its objects ot the existing topology, or because of an actual discovery/gathering failure\&. May be NULL\&. |
| 57 |
.SS "unsigned long hwloc_backend::flags" |
| 58 |
|
| 59 |
.PP |
| 60 |
Backend flags, currently always 0\&. |
| 61 |
.SS "int(* hwloc_backend::get_pci_busid_cpuset) (struct \fBhwloc_backend\fP *backend, struct hwloc_pcidev_attr_s *busid, \fBhwloc_bitmap_t\fP cpuset)" |
| 62 |
|
| 63 |
.PP |
| 64 |
Callback to retrieve the locality of a PCI object\&. Called by the PCI core when attaching PCI hierarchy to CPU objects\&. May be NULL\&. |
| 65 |
.SS "int hwloc_backend::is_thissystem" |
| 66 |
|
| 67 |
.PP |
| 68 |
Backend-specific 'is_thissystem' property\&. Set to 0 if the backend disables the thissystem flag for this topology (e\&.g\&. loading from xml or synthetic string, or using a different fsroot on Linux, or a x86 CPUID dump)\&. Set to -1 if the backend doesn't care (default)\&. |
| 69 |
.SS "unsigned hwloc_backend::phases" |
| 70 |
|
| 71 |
.PP |
| 72 |
Discovery phases performed by this component, possibly without some of them if excluded by other components\&. OR'ed set of \fBhwloc_disc_phase_t\fP\&. |
| 73 |
.SS "void* hwloc_backend::private_data" |
| 74 |
|
| 75 |
.PP |
| 76 |
Backend private data, or NULL if none\&. |
| 77 |
|
| 78 |
.SH "Author" |
| 79 |
.PP |
| 80 |
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&. |