| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128 |
- .TH "hwlocality_advanced_io" 3 "Thu Sep 7 2023" "Version 2.9.3" "Hardware Locality (hwloc)" \" -*- nroff -*-
- .ad l
- .nh
- .SH NAME
- hwlocality_advanced_io \- Finding I/O objects
- .SH SYNOPSIS
- .br
- .PP
- .SS "Functions"
- .in +1c
- .ti -1c
- .RI "static \fBhwloc_obj_t\fP \fBhwloc_get_non_io_ancestor_obj\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP ioobj)"
- .br
- .ti -1c
- .RI "static \fBhwloc_obj_t\fP \fBhwloc_get_next_pcidev\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)"
- .br
- .ti -1c
- .RI "static \fBhwloc_obj_t\fP \fBhwloc_get_pcidev_by_busid\fP (\fBhwloc_topology_t\fP topology, unsigned domain, unsigned bus, unsigned dev, unsigned func)"
- .br
- .ti -1c
- .RI "static \fBhwloc_obj_t\fP \fBhwloc_get_pcidev_by_busidstring\fP (\fBhwloc_topology_t\fP topology, const char *busid)"
- .br
- .ti -1c
- .RI "static \fBhwloc_obj_t\fP \fBhwloc_get_next_osdev\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)"
- .br
- .ti -1c
- .RI "static \fBhwloc_obj_t\fP \fBhwloc_get_next_bridge\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)"
- .br
- .ti -1c
- .RI "static int \fBhwloc_bridge_covers_pcibus\fP (\fBhwloc_obj_t\fP bridge, unsigned domain, unsigned bus)"
- .br
- .in -1c
- .SH "Detailed Description"
- .PP
- .SH "Function Documentation"
- .PP
- .SS "static int hwloc_bridge_covers_pcibus (\fBhwloc_obj_t\fP bridge, unsigned domain, unsigned bus)\fC [inline]\fP, \fC [static]\fP"
- .SS "static \fBhwloc_obj_t\fP hwloc_get_next_bridge (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)\fC [inline]\fP, \fC [static]\fP"
- .PP
- Get the next bridge in the system\&.
- .PP
- \fBReturns\fP
- .RS 4
- the first bridge if \fCprev\fP is \fCNULL\fP\&.
- .PP
- the next bridge if \fCprev\fP is not \fCNULL\fP\&.
- .PP
- \fCNULL\fP if there is no next bridge\&.
- .RE
- .PP
- .SS "static \fBhwloc_obj_t\fP hwloc_get_next_osdev (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)\fC [inline]\fP, \fC [static]\fP"
- .PP
- Get the next OS device in the system\&.
- .PP
- \fBReturns\fP
- .RS 4
- the first OS device if \fCprev\fP is \fCNULL\fP\&.
- .PP
- the next OS device if \fCprev\fP is not \fCNULL\fP\&.
- .PP
- \fCNULL\fP if there is no next OS device\&.
- .RE
- .PP
- .SS "static \fBhwloc_obj_t\fP hwloc_get_next_pcidev (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)\fC [inline]\fP, \fC [static]\fP"
- .PP
- Get the next PCI device in the system\&.
- .PP
- \fBReturns\fP
- .RS 4
- the first PCI device if \fCprev\fP is \fCNULL\fP\&.
- .PP
- the next PCI device if \fCprev\fP is not \fCNULL\fP\&.
- .PP
- \fCNULL\fP if there is no next PCI device\&.
- .RE
- .PP
- .SS "static \fBhwloc_obj_t\fP hwloc_get_non_io_ancestor_obj (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP ioobj)\fC [inline]\fP, \fC [static]\fP"
- .PP
- Get the first non-I/O ancestor object\&. Given the I/O object \fCioobj\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 \fCioobj\fP\&.
- .PP
- \fBReturns\fP
- .RS 4
- a non-I/O object\&.
- .RE
- .PP
- \fBNote\fP
- .RS 4
- This function cannot return \fCNULL\fP\&.
- .PP
- 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\&.
- .RE
- .PP
- .SS "static \fBhwloc_obj_t\fP hwloc_get_pcidev_by_busid (\fBhwloc_topology_t\fP topology, unsigned domain, unsigned bus, unsigned dev, unsigned func)\fC [inline]\fP, \fC [static]\fP"
- .PP
- Find the PCI device object matching the PCI bus id given domain, bus device and function PCI bus id\&.
- .PP
- \fBReturns\fP
- .RS 4
- a matching PCI device object if any, \fCNULL\fP otherwise\&.
- .RE
- .PP
- .SS "static \fBhwloc_obj_t\fP hwloc_get_pcidev_by_busidstring (\fBhwloc_topology_t\fP topology, const char * busid)\fC [inline]\fP, \fC [static]\fP"
- .PP
- Find the PCI device object matching the PCI bus id given as a string xxxx:yy:zz\&.t or yy:zz\&.t\&.
- .PP
- \fBReturns\fP
- .RS 4
- a matching PCI device object if any, \fCNULL\fP otherwise\&.
- .RE
- .PP
- .SH "Author"
- .PP
- Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.
|