hwlocality_cudart(3) Library Functions Manual hwlocality_cudart(3)
NAME
hwlocality_cudart - Interoperability with the CUDA Runtime API
SYNOPSIS
Functions
int hwloc_cudart_get_device_pci_ids (hwloc_topology_t topology, int
idx, int *domain, int *bus, int *dev)
int hwloc_cudart_get_device_cpuset (hwloc_topology_t topology, int idx,
hwloc_cpuset_t set)
hwloc_obj_t hwloc_cudart_get_device_pcidev (hwloc_topology_t topology,
int idx)
hwloc_obj_t hwloc_cudart_get_device_osdev_by_index (hwloc_topology_t
topology, unsigned idx)
Detailed Description
This interface offers ways to retrieve topology information about CUDA
devices when using the CUDA Runtime API.
Function Documentation
int hwloc_cudart_get_device_cpuset (hwloc_topology_t topology, int idx,
hwloc_cpuset_t set) [inline]
Get the CPU set of processors that are physically close to device idx.
Store in set the CPU-set describing the locality of the CUDA device
whose index is idx.
Topology topology and device idx must match the local machine. I/O
devices detection and the CUDA component are not needed in the
topology.
The function only returns the locality of the device. If more
information about the device is needed, OS objects should be used
instead, see hwloc_cudart_get_device_osdev_by_index().
This function is currently only implemented in a meaningful way for
Linux; other systems will simply get a full cpuset.
Returns
0 on success.
-1 on error, for instance if device information could not be found.
hwloc_obj_t hwloc_cudart_get_device_osdev_by_index (hwloc_topology_t
topology, unsigned idx) [inline]
Get the hwloc OS device object corresponding to the CUDA device whose
index is idx.
Returns
The hwloc OS device object describing the CUDA device whose index
is idx.
NULL if none could be found.
The topology topology 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 hwloc_cudart_get_device_cpuset().
Note
The corresponding PCI device object can be obtained by looking at
the OS device parent object (unless PCI devices are filtered out).
This function is identical to
hwloc_cuda_get_device_osdev_by_index().
int hwloc_cudart_get_device_pci_ids (hwloc_topology_t topology, int idx,
int * domain, int * bus, int * dev) [inline]
Return the domain, bus and device IDs of the CUDA device whose index is
idx. Device index idx must match the local machine.
Returns
0 on success.
-1 on error, for instance if device information could not be found.
hwloc_obj_t hwloc_cudart_get_device_pcidev (hwloc_topology_t topology, int
idx) [inline]
Get the hwloc PCI device object corresponding to the CUDA device whose
index is idx.
Returns
The hwloc PCI device object describing the CUDA device whose index
is idx.
NULL if none could be found.
Topology topology and device idx must match the local machine. I/O
devices detection must be enabled in topology topology. The CUDA
component is not needed in the topology.
Author
Generated automatically by Doxygen for Hardware Locality (hwloc) from
the source code.
Hardware Locality (hwloc) Version 2.12.0 hwlocality_cudart(3)
hwloc 2.12.0 - Generated Thu May 8 14:50:50 CDT 2025