Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v2.0.3

  |   Home   |   Support   |   FAQ   |  
nvml.h
1 /*
2  * Copyright © 2012-2016 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 
55 static __hwloc_inline int
56 hwloc_nvml_get_device_cpuset(hwloc_topology_t topology __hwloc_attribute_unused,
57  nvmlDevice_t device, hwloc_cpuset_t set)
58 {
59 #ifdef HWLOC_LINUX_SYS
60  /* If we're on Linux, use the sysfs mechanism to get the local cpus */
61 #define HWLOC_NVML_DEVICE_SYSFS_PATH_MAX 128
62  char path[HWLOC_NVML_DEVICE_SYSFS_PATH_MAX];
63  nvmlReturn_t nvres;
64  nvmlPciInfo_t pci;
65 
66  if (!hwloc_topology_is_thissystem(topology)) {
67  errno = EINVAL;
68  return -1;
69  }
70 
71  nvres = nvmlDeviceGetPciInfo(device, &pci);
72  if (NVML_SUCCESS != nvres) {
73  errno = EINVAL;
74  return -1;
75  }
76 
77  sprintf(path, "/sys/bus/pci/devices/%04x:%02x:%02x.0/local_cpus", pci.domain, pci.bus, pci.device);
78  if (hwloc_linux_read_path_as_cpumask(path, set) < 0
79  || hwloc_bitmap_iszero(set))
81 #else
82  /* Non-Linux systems simply get a full cpuset */
84 #endif
85  return 0;
86 }
87 
101 static __hwloc_inline hwloc_obj_t
103 {
104  hwloc_obj_t osdev = NULL;
105  while ((osdev = hwloc_get_next_osdev(topology, osdev)) != NULL) {
106  if (HWLOC_OBJ_OSDEV_GPU == osdev->attr->osdev.type
107  && osdev->name
108  && !strncmp("nvml", osdev->name, 4)
109  && atoi(osdev->name + 4) == (int) idx)
110  return osdev;
111  }
112  return NULL;
113 }
114 
128 static __hwloc_inline hwloc_obj_t
129 hwloc_nvml_get_device_osdev(hwloc_topology_t topology, nvmlDevice_t device)
130 {
131  hwloc_obj_t osdev;
132  nvmlReturn_t nvres;
133  nvmlPciInfo_t pci;
134  char uuid[64];
135 
136  if (!hwloc_topology_is_thissystem(topology)) {
137  errno = EINVAL;
138  return NULL;
139  }
140 
141  nvres = nvmlDeviceGetPciInfo(device, &pci);
142  if (NVML_SUCCESS != nvres)
143  return NULL;
144 
145  nvres = nvmlDeviceGetUUID(device, uuid, sizeof(uuid));
146  if (NVML_SUCCESS != nvres)
147  uuid[0] = '\0';
148 
149  osdev = NULL;
150  while ((osdev = hwloc_get_next_osdev(topology, osdev)) != NULL) {
151  hwloc_obj_t pcidev = osdev->parent;
152  const char *info;
153 
154  if (strncmp(osdev->name, "nvml", 4))
155  continue;
156 
157  if (pcidev
158  && pcidev->type == HWLOC_OBJ_PCI_DEVICE
159  && pcidev->attr->pcidev.domain == pci.domain
160  && pcidev->attr->pcidev.bus == pci.bus
161  && pcidev->attr->pcidev.dev == pci.device
162  && pcidev->attr->pcidev.func == 0)
163  return osdev;
164 
165  info = hwloc_obj_get_info_by_name(osdev, "NVIDIAUUID");
166  if (info && !strcmp(info, uuid))
167  return osdev;
168  }
169 
170  return NULL;
171 }
172 
176 #ifdef __cplusplus
177 } /* extern "C" */
178 #endif
179 
180 
181 #endif /* HWLOC_NVML_H */
hwloc_const_cpuset_t hwloc_topology_get_complete_cpuset(hwloc_topology_t topology)
Get complete CPU set.
struct hwloc_obj * parent
Parent, NULL if root (Machine object)
Definition: hwloc.h:407
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.
Operating system GPU device. For instance ":0.0" for a GL display, "card0" for a Linux DRM device...
Definition: hwloc.h:302
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:636
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:1123
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:369
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:129
unsigned char bus
Definition: hwloc.h:587
hwloc_obj_osdev_type_t type
Definition: hwloc.h:610
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:376
static const char * hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name)
Search the given key name in object infos and return the corresponding value.
static int hwloc_nvml_get_device_cpuset(hwloc_topology_t topology, nvmlDevice_t device, hwloc_cpuset_t set)
Get the CPU set of logical processors that are physically close to NVML device device.
Definition: nvml.h:56
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:359
Structure of a topology object.
Definition: hwloc.h:357
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:139
unsigned short domain
Definition: hwloc.h:586
unsigned char func
Definition: hwloc.h:587
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
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.
unsigned char dev
Definition: hwloc.h:587
PCI device (filtered out by default). They are not added to the topology unless I/O discovery is enab...
Definition: hwloc.h:256
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:102
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
int hwloc_bitmap_iszero(hwloc_const_bitmap_t bitmap)
Test whether bitmap bitmap is empty.