Hardware Locality (hwloc) 3.0.0a1-git
nvml.h
1/*
2 * SPDX-License-Identifier: BSD-3-Clause
3 * Copyright © 2012-2026 Inria. All rights reserved.
4 * See COPYING in top-level directory.
5 */
6
13
14#ifndef HWLOC_NVML_H
15#define HWLOC_NVML_H
16
17#include "hwloc.h"
18#include "hwloc/autogen/config.h"
19#include "hwloc/helper.h"
20
21#include <nvml.h>
22
23
24#ifdef __cplusplus
25extern "C" {
26#endif
27
28
36
55static __hwloc_inline int
56hwloc_nvml_get_device_cpuset(hwloc_topology_t topology __hwloc_attribute_unused,
57 nvmlDevice_t device, hwloc_cpuset_t set)
58{
59 nvmlReturn_t nvres;
60 nvmlPciInfo_t pci;
61
62 if (!hwloc_topology_is_thissystem(topology)) {
63 errno = EINVAL;
64 return -1;
65 }
66
67 nvres = nvmlDeviceGetPciInfo(device, &pci);
68 if (NVML_SUCCESS != nvres) {
69 errno = EINVAL;
70 return -1;
71 }
72
73 return hwloc_get_pci_busid_cpuset(topology, set, pci.domain, pci.bus, pci.device, 0);
74}
75
89static __hwloc_inline hwloc_obj_t
91{
92 hwloc_obj_t osdev = NULL;
93 while ((osdev = hwloc_get_next_osdev(topology, osdev)) != NULL) {
94 if ((osdev->attr->osdev.types & (HWLOC_OBJ_OSDEV_GPU|HWLOC_OBJ_OSDEV_COPROC)) /* assume future nvml devices will be at least GPU or COPROC */
95 && osdev->name
96 && !strncmp("nvml", osdev->name, 4)
97 && atoi(osdev->name + 4) == (int) idx)
98 return osdev;
99 }
100 return NULL;
101}
102
116static __hwloc_inline hwloc_obj_t
117hwloc_nvml_get_device_osdev(hwloc_topology_t topology, nvmlDevice_t device)
118{
119 hwloc_obj_t osdev;
120 nvmlReturn_t nvres;
121 nvmlPciInfo_t pci;
122 char uuid[64];
123
124 if (!hwloc_topology_is_thissystem(topology)) {
125 errno = EINVAL;
126 return NULL;
127 }
128
129 nvres = nvmlDeviceGetPciInfo(device, &pci);
130 if (NVML_SUCCESS != nvres)
131 return NULL;
132
133 nvres = nvmlDeviceGetUUID(device, uuid, sizeof(uuid));
134 if (NVML_SUCCESS != nvres)
135 uuid[0] = '\0';
136
137 osdev = NULL;
138 while ((osdev = hwloc_get_next_osdev(topology, osdev)) != NULL) {
139 hwloc_obj_t pcidev = osdev->parent;
140 const char *info;
141
142 if (strncmp(osdev->name, "nvml", 4))
143 continue;
144
145 if (pcidev
146 && pcidev->type == HWLOC_OBJ_PCI_DEVICE
147 && pcidev->attr->pcidev.domain == pci.domain
148 && pcidev->attr->pcidev.bus == pci.bus
149 && pcidev->attr->pcidev.dev == pci.device
150 && pcidev->attr->pcidev.func == 0)
151 return osdev;
152
153 info = hwloc_obj_get_info_by_name(osdev, "NVIDIAUUID");
154 if (info && !strcmp(info, uuid))
155 return osdev;
156 }
157
158 return NULL;
159}
160
162
163
164#ifdef __cplusplus
165} /* extern "C" */
166#endif
167
168
169#endif /* HWLOC_NVML_H */
hwloc_obj_t hwloc_get_next_osdev(hwloc_topology_t topology, hwloc_obj_t prev)
Get the next OS device in the system.
Definition helper.h:1310
int hwloc_get_pci_busid_cpuset(hwloc_topology_t topology, hwloc_cpuset_t cpuset, unsigned domain, unsigned bus, unsigned dev, unsigned func)
Find the locality of a given PCI bus id.
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition hwloc.h:788
const char * hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name)
Search the given name in the object array of infos and return the corresponding value.
hwloc_obj_t hwloc_nvml_get_device_osdev(hwloc_topology_t topology, nvmlDevice_t device)
Get the hwloc OS device object corresponding to NVML device device.
Definition nvml.h:117
int hwloc_nvml_get_device_cpuset(hwloc_topology_t topology, nvmlDevice_t device, hwloc_cpuset_t set)
Get the CPU set of processors that are physically close to NVML device device.
Definition nvml.h:56
hwloc_obj_t hwloc_nvml_get_device_osdev_by_index(hwloc_topology_t topology, unsigned idx)
Get the hwloc OS device object corresponding to the NVML device whose index is idx.
Definition nvml.h:90
hwloc_bitmap_t hwloc_cpuset_t
A CPU set is a bitmap whose bits are set according to CPU physical OS indexes.
Definition hwloc.h:165
@ HWLOC_OBJ_OSDEV_COPROC
Operating system co-processor device. For instance "opencl0d0" for a OpenCL device,...
Definition hwloc.h:400
@ HWLOC_OBJ_OSDEV_GPU
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device,...
Definition hwloc.h:393
@ HWLOC_OBJ_PCI_DEVICE
PCI device (filtered out by default).
Definition hwloc.h:324
struct hwloc_obj * hwloc_obj_t
Convenience typedef; a pointer to a struct hwloc_obj.
Definition hwloc.h:691
hwloc_obj_osdev_types_t types
OR'ed set of at least one hwloc_obj_osdev_type_e.
Definition hwloc.h:771
unsigned char dev
Device number (zz in the PCI BDF notation xxxx:yy:zz.t).
Definition hwloc.h:737
unsigned char func
Function number (t in the PCI BDF notation xxxx:yy:zz.t).
Definition hwloc.h:738
unsigned char bus
Bus number (yy in the PCI BDF notation xxxx:yy:zz.t).
Definition hwloc.h:736
unsigned int domain
Domain number (xxxx in the PCI BDF notation xxxx:yy:zz.t).
Definition hwloc.h:735
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition hwloc.h:504
hwloc_obj_type_t type
Type of object.
Definition hwloc.h:494
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition hwloc.h:511
struct hwloc_obj * parent
Parent, NULL if root (Machine object).
Definition hwloc.h:542
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev