Debian Codegraph @

doc/doxygen-doc/man/man3/hwlocality_openfabrics.3

raw
1 .TH "hwlocality_openfabrics" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_openfabrics \- Interoperability with OpenFabrics
6 .SH SYNOPSIS
7 .br
8 .PP
9 .SS "Functions"
10
11 .in +1c
12 .ti -1c
13 .RI "int \fBhwloc_ibv_get_device_cpuset\fP (\fBhwloc_topology_t\fP topology, struct ibv_device *ibdev, \fBhwloc_cpuset_t\fP set)"
14 .br
15 .ti -1c
16 .RI "\fBhwloc_obj_t\fP \fBhwloc_ibv_get_device_osdev_by_name\fP (\fBhwloc_topology_t\fP topology, const char *ibname)"
17 .br
18 .ti -1c
19 .RI "\fBhwloc_obj_t\fP \fBhwloc_ibv_get_device_osdev\fP (\fBhwloc_topology_t\fP topology, struct ibv_device *ibdev)"
20 .br
21 .in -1c
22 .SH "Detailed Description"
23 .PP
24 This interface offers ways to retrieve topology information about OpenFabrics devices (InfiniBand, Omni-Path, usNIC, etc)\&.
25 .SH "Function Documentation"
26 .PP
27 .SS "int hwloc_ibv_get_device_cpuset (\fBhwloc_topology_t\fP topology, struct ibv_device * ibdev, \fBhwloc_cpuset_t\fP set)\fR [inline]\fP"
28
29 .PP
30 Get the CPU set of processors that are physically close to device \fRibdev\fP\&. Store in \fRset\fP the CPU-set describing the locality of the OpenFabrics device \fRibdev\fP (InfiniBand, etc)\&.
31
32 .PP
33 Topology \fRtopology\fP and device \fRibdev\fP must match the local machine\&. I/O devices detection is not needed in the topology\&.
34
35 .PP
36 The function only returns the locality of the device\&. If more information about the device is needed, OS objects should be used instead, see \fBhwloc_ibv_get_device_osdev()\fP and \fBhwloc_ibv_get_device_osdev_by_name()\fP\&.
37
38 .PP
39 This function is currently only implemented in a meaningful way for Linux; other systems will simply get the cpuset of the entire topology\&.
40
41 .PP
42 \fBReturns\fP
43 .RS 4
44 0 on success\&.
45
46 .PP
47 -1 on error, for instance if device information could not be found\&.
48 .RE
49 .PP
50
51 .SS "\fBhwloc_obj_t\fP hwloc_ibv_get_device_osdev (\fBhwloc_topology_t\fP topology, struct ibv_device * ibdev)\fR [inline]\fP"
52
53 .PP
54 Get the hwloc OS device object corresponding to the OpenFabrics device \fRibdev\fP\&.
55 .PP
56 \fBReturns\fP
57 .RS 4
58 The hwloc OS device object describing the OpenFabrics device \fRibdev\fP (InfiniBand, etc)\&.
59
60 .PP
61 \fRNULL\fP if none could be found\&.
62 .RE
63 .PP
64 Topology \fRtopology\fP and device \fRibdev\fP must match the local machine\&. I/O devices detection must be enabled in the topology\&. If not, the locality of the object may still be found using \fBhwloc_ibv_get_device_cpuset()\fP\&.
65
66 .PP
67 \fBNote\fP
68 .RS 4
69 The corresponding PCI device object can be obtained by looking at the OS device parent object\&.
70 .RE
71 .PP
72
73 .SS "\fBhwloc_obj_t\fP hwloc_ibv_get_device_osdev_by_name (\fBhwloc_topology_t\fP topology, const char * ibname)\fR [inline]\fP"
74
75 .PP
76 Get the hwloc OS device object corresponding to the OpenFabrics device named \fRibname\fP\&.
77 .PP
78 \fBReturns\fP
79 .RS 4
80 The hwloc OS device object describing the OpenFabrics device (InfiniBand, Omni-Path, usNIC, etc) whose name is \fRibname\fP (mlx5_0, hfi1_0, usnic_0, qib0, etc)\&.
81
82 .PP
83 \fRNULL\fP if none could be found\&.
84 .RE
85 .PP
86 The name \fRibname\fP is usually obtained from ibv_get_device_name()\&.
87
88 .PP
89 The topology \fRtopology\fP does not necessarily have to match the current machine\&. For instance the topology may be an XML import of a remote host\&. I/O devices detection must be enabled in the topology\&.
90
91 .PP
92 \fBNote\fP
93 .RS 4
94 The corresponding PCI device object can be obtained by looking at the OS device parent object\&.
95 .RE
96 .PP
97
98 .SH "Author"
99 .PP
100 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.