1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
.TH "hwlocality_rsmi" 3 "Version 2.12.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
.ad l
.nh
.SH NAME
hwlocality_rsmi \- Interoperability with the ROCm SMI Management Library
.SH SYNOPSIS
.br
.PP
.SS "Functions"
.in +1c
.ti -1c
.RI "int \fBhwloc_rsmi_get_device_cpuset\fP (\fBhwloc_topology_t\fP topology, uint32_t dv_ind, \fBhwloc_cpuset_t\fP set)"
.br
.ti -1c
.RI "\fBhwloc_obj_t\fP \fBhwloc_rsmi_get_device_osdev_by_index\fP (\fBhwloc_topology_t\fP topology, uint32_t dv_ind)"
.br
.ti -1c
.RI "\fBhwloc_obj_t\fP \fBhwloc_rsmi_get_device_osdev\fP (\fBhwloc_topology_t\fP topology, uint32_t dv_ind)"
.br
.in -1c
.SH "Detailed Description"
.PP
This interface offers ways to retrieve topology information about devices managed by the ROCm SMI Management Library\&.
.SH "Function Documentation"
.PP
.SS "int hwloc_rsmi_get_device_cpuset (\fBhwloc_topology_t\fP topology, uint32_t dv_ind, \fBhwloc_cpuset_t\fP set)\fC [inline]\fP"
.PP
Get the CPU set of logical processors that are physically close to AMD GPU device whose index is \fCdv_ind\fP\&. Store in \fCset\fP the CPU-set describing the locality of the AMD GPU device whose index is \fCdv_ind\fP\&.
.PP
Topology \fCtopology\fP and device \fCdv_ind\fP must match the local machine\&. I/O devices detection and the ROCm SMI component are not needed in the topology\&.
.PP
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_rsmi_get_device_osdev()\fP and \fBhwloc_rsmi_get_device_osdev_by_index()\fP\&.
.PP
This function is currently only implemented in a meaningful way for Linux; other systems will simply get a full cpuset\&.
.PP
\fBReturns\fP
.RS 4
0 on success\&.
.PP
-1 on error, for instance if device information could not be found\&.
.RE
.PP
.SS "\fBhwloc_obj_t\fP hwloc_rsmi_get_device_osdev (\fBhwloc_topology_t\fP topology, uint32_t dv_ind)\fC [inline]\fP"
.PP
Get the hwloc OS device object corresponding to AMD GPU device, whose index is \fCdv_ind\fP\&.
.PP
\fBReturns\fP
.RS 4
The hwloc OS device object that describes the given AMD GPU, whose index is \fCdv_ind\fP\&.
.PP
\fCNULL\fP if none could be found\&.
.RE
.PP
Topology \fCtopology\fP and device \fCdv_ind\fP must match the local machine\&. I/O devices detection and the ROCm SMI component must be enabled in the topology\&. If not, the locality of the object may still be found using \fBhwloc_rsmi_get_device_cpuset()\fP\&.
.PP
\fBNote\fP
.RS 4
The corresponding hwloc PCI device may be found by looking at the result parent pointer (unless PCI devices are filtered out)\&.
.RE
.PP
.SS "\fBhwloc_obj_t\fP hwloc_rsmi_get_device_osdev_by_index (\fBhwloc_topology_t\fP topology, uint32_t dv_ind)\fC [inline]\fP"
.PP
Get the hwloc OS device object corresponding to the AMD GPU device whose index is \fCdv_ind\fP\&.
.PP
\fBReturns\fP
.RS 4
The hwloc OS device object describing the AMD GPU device whose index is \fCdv_ind\fP\&.
.PP
\fCNULL\fP if none could be found\&.
.RE
.PP
The topology \fCtopology\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 and the ROCm SMI component must be enabled in the topology\&.
.PP
\fBNote\fP
.RS 4
The corresponding PCI device object can be obtained by looking at the OS device parent object (unless PCI devices are filtered out)\&.
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.
|
