| 1 |
.TH "hwlocality_advanced_io" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*- |
| 2 |
.ad l |
| 3 |
.nh |
| 4 |
.SH NAME |
| 5 |
hwlocality_advanced_io \- Finding I/O objects |
| 6 |
.SH SYNOPSIS |
| 7 |
.br |
| 8 |
.PP |
| 9 |
.SS "Functions" |
| 10 |
|
| 11 |
.in +1c |
| 12 |
.ti -1c |
| 13 |
.RI "\fBhwloc_obj_t\fP \fBhwloc_get_non_io_ancestor_obj\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP ioobj)" |
| 14 |
.br |
| 15 |
.ti -1c |
| 16 |
.RI "\fBhwloc_obj_t\fP \fBhwloc_get_next_pcidev\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)" |
| 17 |
.br |
| 18 |
.ti -1c |
| 19 |
.RI "\fBhwloc_obj_t\fP \fBhwloc_get_pcidev_by_busid\fP (\fBhwloc_topology_t\fP topology, unsigned domain, unsigned bus, unsigned dev, unsigned func)" |
| 20 |
.br |
| 21 |
.ti -1c |
| 22 |
.RI "\fBhwloc_obj_t\fP \fBhwloc_get_pcidev_by_busidstring\fP (\fBhwloc_topology_t\fP topology, const char *busid)" |
| 23 |
.br |
| 24 |
.ti -1c |
| 25 |
.RI "\fBhwloc_obj_t\fP \fBhwloc_get_next_osdev\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)" |
| 26 |
.br |
| 27 |
.ti -1c |
| 28 |
.RI "\fBhwloc_obj_t\fP \fBhwloc_get_next_bridge\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)" |
| 29 |
.br |
| 30 |
.ti -1c |
| 31 |
.RI "int \fBhwloc_bridge_covers_pcibus\fP (\fBhwloc_obj_t\fP bridge, unsigned domain, unsigned bus)" |
| 32 |
.br |
| 33 |
.in -1c |
| 34 |
.SH "Detailed Description" |
| 35 |
.PP |
| 36 |
|
| 37 |
.SH "Function Documentation" |
| 38 |
.PP |
| 39 |
.SS "int hwloc_bridge_covers_pcibus (\fBhwloc_obj_t\fP bridge, unsigned domain, unsigned bus)\fR [inline]\fP" |
| 40 |
|
| 41 |
.SS "\fBhwloc_obj_t\fP hwloc_get_next_bridge (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)\fR [inline]\fP" |
| 42 |
|
| 43 |
.PP |
| 44 |
Get the next bridge in the system\&. |
| 45 |
.PP |
| 46 |
\fBReturns\fP |
| 47 |
.RS 4 |
| 48 |
the first bridge if \fRprev\fP is \fRNULL\fP\&. |
| 49 |
|
| 50 |
.PP |
| 51 |
the next bridge if \fRprev\fP is not \fRNULL\fP\&. |
| 52 |
|
| 53 |
.PP |
| 54 |
\fRNULL\fP if there is no next bridge\&. |
| 55 |
.RE |
| 56 |
.PP |
| 57 |
|
| 58 |
.SS "\fBhwloc_obj_t\fP hwloc_get_next_osdev (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)\fR [inline]\fP" |
| 59 |
|
| 60 |
.PP |
| 61 |
Get the next OS device in the system\&. |
| 62 |
.PP |
| 63 |
\fBReturns\fP |
| 64 |
.RS 4 |
| 65 |
the first OS device if \fRprev\fP is \fRNULL\fP\&. |
| 66 |
|
| 67 |
.PP |
| 68 |
the next OS device if \fRprev\fP is not \fRNULL\fP\&. |
| 69 |
|
| 70 |
.PP |
| 71 |
\fRNULL\fP if there is no next OS device\&. |
| 72 |
.RE |
| 73 |
.PP |
| 74 |
|
| 75 |
.SS "\fBhwloc_obj_t\fP hwloc_get_next_pcidev (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)\fR [inline]\fP" |
| 76 |
|
| 77 |
.PP |
| 78 |
Get the next PCI device in the system\&. |
| 79 |
.PP |
| 80 |
\fBReturns\fP |
| 81 |
.RS 4 |
| 82 |
the first PCI device if \fRprev\fP is \fRNULL\fP\&. |
| 83 |
|
| 84 |
.PP |
| 85 |
the next PCI device if \fRprev\fP is not \fRNULL\fP\&. |
| 86 |
|
| 87 |
.PP |
| 88 |
\fRNULL\fP if there is no next PCI device\&. |
| 89 |
.RE |
| 90 |
.PP |
| 91 |
|
| 92 |
.SS "\fBhwloc_obj_t\fP hwloc_get_non_io_ancestor_obj (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP ioobj)\fR [inline]\fP" |
| 93 |
|
| 94 |
.PP |
| 95 |
Get the first non-I/O ancestor object\&. Given the I/O object \fRioobj\fP, find the smallest non-I/O ancestor object\&. This object (normal or memory) may then be used for binding because it has non-NULL CPU and node sets and because its locality is the same as \fRioobj\fP\&. |
| 96 |
|
| 97 |
.PP |
| 98 |
\fBReturns\fP |
| 99 |
.RS 4 |
| 100 |
a non-I/O object\&. |
| 101 |
.RE |
| 102 |
.PP |
| 103 |
\fBNote\fP |
| 104 |
.RS 4 |
| 105 |
This function cannot return \fRNULL\fP\&. |
| 106 |
|
| 107 |
.PP |
| 108 |
The resulting object is usually a normal object but it could also be a memory object (e\&.g\&. NUMA node) in future platforms if I/O objects ever get attached to memory instead of CPUs\&. |
| 109 |
.RE |
| 110 |
.PP |
| 111 |
|
| 112 |
.SS "\fBhwloc_obj_t\fP hwloc_get_pcidev_by_busid (\fBhwloc_topology_t\fP topology, unsigned domain, unsigned bus, unsigned dev, unsigned func)\fR [inline]\fP" |
| 113 |
|
| 114 |
.PP |
| 115 |
Find the PCI device object matching the PCI bus id given domain, bus device and function PCI bus id\&. |
| 116 |
.PP |
| 117 |
\fBReturns\fP |
| 118 |
.RS 4 |
| 119 |
a matching PCI device object if any, \fRNULL\fP otherwise\&. |
| 120 |
.RE |
| 121 |
.PP |
| 122 |
|
| 123 |
.SS "\fBhwloc_obj_t\fP hwloc_get_pcidev_by_busidstring (\fBhwloc_topology_t\fP topology, const char * busid)\fR [inline]\fP" |
| 124 |
|
| 125 |
.PP |
| 126 |
Find the PCI device object matching the PCI bus id given as a string xxxx:yy:zz\&.t or yy:zz\&.t\&. |
| 127 |
.PP |
| 128 |
\fBReturns\fP |
| 129 |
.RS 4 |
| 130 |
a matching PCI device object if any, \fRNULL\fP otherwise\&. |
| 131 |
.RE |
| 132 |
.PP |
| 133 |
|
| 134 |
.SH "Author" |
| 135 |
.PP |
| 136 |
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&. |