Hardware Locality (hwloc)  2.10.0
nvml.h
1 /*
2  * Copyright © 2012-2023 Inria. All rights reserved.
3  * See COPYING in top-level directory.
4  */
5 
13 #ifndef HWLOC_NVML_H
14 #define HWLOC_NVML_H
15 
16 #include "hwloc.h"
17 #include "hwloc/autogen/config.h"
18 #include "hwloc/helper.h"
19 #ifdef HWLOC_LINUX_SYS
20 #include "hwloc/linux.h"
21 #endif
22 
23 #include <nvml.h>
24 
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30 
58 static __hwloc_inline int
59 hwloc_nvml_get_device_cpuset(hwloc_topology_t topology __hwloc_attribute_unused,
60  nvmlDevice_t device, hwloc_cpuset_t set)
61 {
62 #ifdef HWLOC_LINUX_SYS
63  /* If we're on Linux, use the sysfs mechanism to get the local cpus */
64 #define HWLOC_NVML_DEVICE_SYSFS_PATH_MAX 128
65  char path[HWLOC_NVML_DEVICE_SYSFS_PATH_MAX];
66  nvmlReturn_t nvres;
67  nvmlPciInfo_t pci;
68 
69  if (!hwloc_topology_is_thissystem(topology)) {
70  errno = EINVAL;
71  return -1;
72  }
73 
74  nvres = nvmlDeviceGetPciInfo(device, &pci);
75  if (NVML_SUCCESS != nvres) {
76  errno = EINVAL;
77  return -1;
78  }
79 
80  sprintf(path, "/sys/bus/pci/devices/%04x:%02x:%02x.0/local_cpus", pci.domain, pci.bus, pci.device);
81  if (hwloc_linux_read_path_as_cpumask(path, set) < 0
82  || hwloc_bitmap_iszero(set))
84 #else
85  /* Non-Linux systems simply get a full cpuset */
87 #endif
88  return 0;
89 }
90 
104 static __hwloc_inline hwloc_obj_t
106 {
107  hwloc_obj_t osdev = NULL;
108  while ((osdev = hwloc_get_next_osdev(topology, osdev)) != NULL) {
109  if (HWLOC_OBJ_OSDEV_GPU == osdev->attr->osdev.type
110  && osdev->name
111  && !strncmp("nvml", osdev->name, 4)
112  && atoi(osdev->name + 4) == (int) idx)
113  return osdev;
114  }
115  return NULL;
116 }
117 
131 static __hwloc_inline hwloc_obj_t
132 hwloc_nvml_get_device_osdev(hwloc_topology_t topology, nvmlDevice_t device)
133 {
134  hwloc_obj_t osdev;
135  nvmlReturn_t nvres;
136  nvmlPciInfo_t pci;
137  char uuid[64];
138 
139  if (!hwloc_topology_is_thissystem(topology)) {
140  errno = EINVAL;
141  return NULL;
142  }
143 
144  nvres = nvmlDeviceGetPciInfo(device, &pci);
145  if (NVML_SUCCESS != nvres)
146  return NULL;
147 
148  nvres = nvmlDeviceGetUUID(device, uuid, sizeof(uuid));
149  if (NVML_SUCCESS != nvres)
150  uuid[0] = '\0';
151 
152  osdev = NULL;
153  while ((osdev = hwloc_get_next_osdev(topology, osdev)) != NULL) {
154  hwloc_obj_t pcidev = osdev->parent;
155  const char *info;
156 
157  if (strncmp(osdev->name, "nvml", 4))
158  continue;
159 
160  if (pcidev
161  && pcidev->type == HWLOC_OBJ_PCI_DEVICE
162  && pcidev->attr->pcidev.domain == pci.domain
163  && pcidev->attr->pcidev.bus == pci.bus
164  && pcidev->attr->pcidev.dev == pci.device
165  && pcidev->attr->pcidev.func == 0)
166  return osdev;
167 
168  info = hwloc_obj_get_info_by_name(osdev, "NVIDIAUUID");
169  if (info && !strcmp(info, uuid))
170  return osdev;
171  }
172 
173  return NULL;
174 }
175 
179 #ifdef __cplusplus
180 } /* extern "C" */
181 #endif
182 
183 
184 #endif /* HWLOC_NVML_H */
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:161
@ 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:374
@ HWLOC_OBJ_PCI_DEVICE
PCI device (filtered out by default).
Definition: hwloc.h:295
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:742
static const char * hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name)
Search the given name in object infos and return the corresponding value.
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
hwloc_const_cpuset_t hwloc_topology_get_complete_cpuset(hwloc_topology_t topology)
Get complete CPU set.
static 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:1282
int hwloc_bitmap_iszero(hwloc_const_bitmap_t bitmap)
Test whether bitmap bitmap is empty.
int hwloc_bitmap_copy(hwloc_bitmap_t dst, hwloc_const_bitmap_t src)
Copy the contents of bitmap src into the already allocated bitmap dst.
int hwloc_linux_read_path_as_cpumask(const char *path, hwloc_bitmap_t set)
Convert a linux kernel cpumask file path into a hwloc bitmap set.
static 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:59
static 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:105
static 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:132
Structure of a topology object.
Definition: hwloc.h:431
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:443
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:433
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:450
struct hwloc_obj * parent
Parent, NULL if root (Machine object)
Definition: hwloc.h:481
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
unsigned char dev
Device number (zz in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:677
unsigned char func
Function number (t in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:678
unsigned short domain
Domain number (xxxx in the PCI BDF notation xxxx:yy:zz.t). Only 16bits PCI domains are supported by d...
Definition: hwloc.h:670
unsigned char bus
Bus number (yy in the PCI BDF notation xxxx:yy:zz.t).
Definition: hwloc.h:676
hwloc_obj_osdev_type_t type
Definition: hwloc.h:716