Debian Codegraph @

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

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