hwlocality_advanced_io.3 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  1. .TH "hwlocality_advanced_io" 3 "Thu Sep 7 2023" "Version 2.9.3" "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. .in +1c
  11. .ti -1c
  12. .RI "static \fBhwloc_obj_t\fP \fBhwloc_get_non_io_ancestor_obj\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP ioobj)"
  13. .br
  14. .ti -1c
  15. .RI "static \fBhwloc_obj_t\fP \fBhwloc_get_next_pcidev\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)"
  16. .br
  17. .ti -1c
  18. .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)"
  19. .br
  20. .ti -1c
  21. .RI "static \fBhwloc_obj_t\fP \fBhwloc_get_pcidev_by_busidstring\fP (\fBhwloc_topology_t\fP topology, const char *busid)"
  22. .br
  23. .ti -1c
  24. .RI "static \fBhwloc_obj_t\fP \fBhwloc_get_next_osdev\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)"
  25. .br
  26. .ti -1c
  27. .RI "static \fBhwloc_obj_t\fP \fBhwloc_get_next_bridge\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP prev)"
  28. .br
  29. .ti -1c
  30. .RI "static int \fBhwloc_bridge_covers_pcibus\fP (\fBhwloc_obj_t\fP bridge, unsigned domain, unsigned bus)"
  31. .br
  32. .in -1c
  33. .SH "Detailed Description"
  34. .PP
  35. .SH "Function Documentation"
  36. .PP
  37. .SS "static int hwloc_bridge_covers_pcibus (\fBhwloc_obj_t\fP bridge, unsigned domain, unsigned bus)\fC [inline]\fP, \fC [static]\fP"
  38. .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"
  39. .PP
  40. Get the next bridge in the system\&.
  41. .PP
  42. \fBReturns\fP
  43. .RS 4
  44. the first bridge if \fCprev\fP is \fCNULL\fP\&.
  45. .PP
  46. the next bridge if \fCprev\fP is not \fCNULL\fP\&.
  47. .PP
  48. \fCNULL\fP if there is no next bridge\&.
  49. .RE
  50. .PP
  51. .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"
  52. .PP
  53. Get the next OS device in the system\&.
  54. .PP
  55. \fBReturns\fP
  56. .RS 4
  57. the first OS device if \fCprev\fP is \fCNULL\fP\&.
  58. .PP
  59. the next OS device if \fCprev\fP is not \fCNULL\fP\&.
  60. .PP
  61. \fCNULL\fP if there is no next OS device\&.
  62. .RE
  63. .PP
  64. .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"
  65. .PP
  66. Get the next PCI device in the system\&.
  67. .PP
  68. \fBReturns\fP
  69. .RS 4
  70. the first PCI device if \fCprev\fP is \fCNULL\fP\&.
  71. .PP
  72. the next PCI device if \fCprev\fP is not \fCNULL\fP\&.
  73. .PP
  74. \fCNULL\fP if there is no next PCI device\&.
  75. .RE
  76. .PP
  77. .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"
  78. .PP
  79. 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\&.
  80. .PP
  81. \fBReturns\fP
  82. .RS 4
  83. a non-I/O object\&.
  84. .RE
  85. .PP
  86. \fBNote\fP
  87. .RS 4
  88. This function cannot return \fCNULL\fP\&.
  89. .PP
  90. 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\&.
  91. .RE
  92. .PP
  93. .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"
  94. .PP
  95. Find the PCI device object matching the PCI bus id given domain, bus device and function PCI bus id\&.
  96. .PP
  97. \fBReturns\fP
  98. .RS 4
  99. a matching PCI device object if any, \fCNULL\fP otherwise\&.
  100. .RE
  101. .PP
  102. .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"
  103. .PP
  104. Find the PCI device object matching the PCI bus id given as a string xxxx:yy:zz\&.t or yy:zz\&.t\&.
  105. .PP
  106. \fBReturns\fP
  107. .RS 4
  108. a matching PCI device object if any, \fCNULL\fP otherwise\&.
  109. .RE
  110. .PP
  111. .SH "Author"
  112. .PP
  113. Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.