Debian Codegraph @

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

raw
1 .TH "hwlocality_cuda" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_cuda \- Interoperability with the CUDA Driver API
6 .SH SYNOPSIS
7 .br
8 .PP
9 .SS "Functions"
10
11 .in +1c
12 .ti -1c
13 .RI "int \fBhwloc_cuda_get_device_pci_ids\fP (\fBhwloc_topology_t\fP topology, CUdevice cudevice, int *domain, int *bus, int *dev)"
14 .br
15 .ti -1c
16 .RI "int \fBhwloc_cuda_get_device_cpuset\fP (\fBhwloc_topology_t\fP topology, CUdevice cudevice, \fBhwloc_cpuset_t\fP set)"
17 .br
18 .ti -1c
19 .RI "\fBhwloc_obj_t\fP \fBhwloc_cuda_get_device_pcidev\fP (\fBhwloc_topology_t\fP topology, CUdevice cudevice)"
20 .br
21 .ti -1c
22 .RI "\fBhwloc_obj_t\fP \fBhwloc_cuda_get_device_osdev\fP (\fBhwloc_topology_t\fP topology, CUdevice cudevice)"
23 .br
24 .ti -1c
25 .RI "\fBhwloc_obj_t\fP \fBhwloc_cuda_get_device_osdev_by_index\fP (\fBhwloc_topology_t\fP topology, unsigned idx)"
26 .br
27 .in -1c
28 .SH "Detailed Description"
29 .PP
30 This interface offers ways to retrieve topology information about CUDA devices when using the CUDA Driver API\&.
31 .SH "Function Documentation"
32 .PP
33 .SS "int hwloc_cuda_get_device_cpuset (\fBhwloc_topology_t\fP topology, CUdevice cudevice, \fBhwloc_cpuset_t\fP set)\fR [inline]\fP"
34
35 .PP
36 Get the CPU set of processors that are physically close to device \fRcudevice\fP\&. Store in \fRset\fP the CPU-set describing the locality of the CUDA device \fRcudevice\fP\&.
37
38 .PP
39 Topology \fRtopology\fP and device \fRcudevice\fP must match the local machine\&. I/O devices detection and the CUDA component are not needed in the topology\&.
40
41 .PP
42 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_cuda_get_device_osdev()\fP and \fBhwloc_cuda_get_device_osdev_by_index()\fP\&.
43
44 .PP
45 This function is currently only implemented in a meaningful way for Linux; other systems will simply get the cpuset of the entire topology\&.
46
47 .PP
48 \fBReturns\fP
49 .RS 4
50 0 on success\&.
51
52 .PP
53 -1 on error, for instance if device information could not be found\&.
54 .RE
55 .PP
56
57 .SS "\fBhwloc_obj_t\fP hwloc_cuda_get_device_osdev (\fBhwloc_topology_t\fP topology, CUdevice cudevice)\fR [inline]\fP"
58
59 .PP
60 Get the hwloc OS device object corresponding to CUDA device \fRcudevice\fP\&.
61 .PP
62 \fBReturns\fP
63 .RS 4
64 The hwloc OS device object that describes the given CUDA device \fRcudevice\fP\&.
65
66 .PP
67 \fRNULL\fP if none could be found\&.
68 .RE
69 .PP
70 Topology \fRtopology\fP and device \fRcudevice\fP must match the local machine\&. I/O devices detection and the CUDA component must be enabled in the topology\&. If not, the locality of the object may still be found using \fBhwloc_cuda_get_device_cpuset()\fP\&.
71
72 .PP
73 \fBNote\fP
74 .RS 4
75 This function cannot work if PCI devices are filtered out\&.
76
77 .PP
78 The corresponding hwloc PCI device may be found by looking at the result parent pointer (unless PCI devices are filtered out)\&.
79 .RE
80 .PP
81
82 .SS "\fBhwloc_obj_t\fP hwloc_cuda_get_device_osdev_by_index (\fBhwloc_topology_t\fP topology, unsigned idx)\fR [inline]\fP"
83
84 .PP
85 Get the hwloc OS device object corresponding to the CUDA device whose index is \fRidx\fP\&.
86 .PP
87 \fBReturns\fP
88 .RS 4
89 The hwloc OS device object describing the CUDA device whose index is \fRidx\fP\&.
90
91 .PP
92 \fRNULL\fP if none could be found\&.
93 .RE
94 .PP
95 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 and the CUDA component must be enabled in the topology\&.
96
97 .PP
98 \fBNote\fP
99 .RS 4
100 The corresponding PCI device object can be obtained by looking at the OS device parent object (unless PCI devices are filtered out)\&.
101
102 .PP
103 This function is identical to \fBhwloc_cudart_get_device_osdev_by_index()\fP\&.
104 .RE
105 .PP
106
107 .SS "int hwloc_cuda_get_device_pci_ids (\fBhwloc_topology_t\fP topology, CUdevice cudevice, int * domain, int * bus, int * dev)\fR [inline]\fP"
108
109 .PP
110 Return the domain, bus and device IDs of the CUDA device \fRcudevice\fP\&. Device \fRcudevice\fP must match the local machine\&.
111
112 .PP
113 \fBReturns\fP
114 .RS 4
115 0 on success\&.
116
117 .PP
118 -1 on error, for instance if device information could not be found\&.
119 .RE
120 .PP
121
122 .SS "\fBhwloc_obj_t\fP hwloc_cuda_get_device_pcidev (\fBhwloc_topology_t\fP topology, CUdevice cudevice)\fR [inline]\fP"
123
124 .PP
125 Get the hwloc PCI device object corresponding to the CUDA device \fRcudevice\fP\&.
126 .PP
127 \fBReturns\fP
128 .RS 4
129 The hwloc PCI device object describing the CUDA device \fRcudevice\fP\&.
130
131 .PP
132 \fRNULL\fP if none could be found\&.
133 .RE
134 .PP
135 Topology \fRtopology\fP and device \fRcudevice\fP must match the local machine\&. I/O devices detection must be enabled in topology \fRtopology\fP\&. The CUDA component is not needed in the topology\&.
136 .SH "Author"
137 .PP
138 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.