Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v2.0.3

  |   Home   |   Support   |   FAQ   |  
opencl.h
1 /*
2  * Copyright ¬© 2012-2018 Inria. All rights reserved.
3  * Copyright ¬© 2013, 2018 Universit√© Bordeaux. All right reserved.
4  * See COPYING in top-level directory.
5  */
6 
14 #ifndef HWLOC_OPENCL_H
15 #define HWLOC_OPENCL_H
16 
17 #include <hwloc.h>
18 #include <hwloc/autogen/config.h>
19 #include <hwloc/helper.h>
20 #ifdef HWLOC_LINUX_SYS
21 #include <hwloc/linux.h>
22 #endif
23 
24 #ifdef __APPLE__
25 #include <OpenCL/cl.h>
26 #include <OpenCL/cl_ext.h>
27 #else
28 #include <CL/cl.h>
29 #include <CL/cl_ext.h>
30 #endif
31 
32 #include <stdio.h>
33 
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 
68 static __hwloc_inline int
69 hwloc_opencl_get_device_cpuset(hwloc_topology_t topology __hwloc_attribute_unused,
70  cl_device_id device __hwloc_attribute_unused,
71  hwloc_cpuset_t set)
72 {
73 #if (defined HWLOC_LINUX_SYS) && (defined CL_DEVICE_TOPOLOGY_AMD)
74  /* If we're on Linux + AMD OpenCL, use the AMD extension + the sysfs mechanism to get the local cpus */
75 #define HWLOC_OPENCL_DEVICE_SYSFS_PATH_MAX 128
76  char path[HWLOC_OPENCL_DEVICE_SYSFS_PATH_MAX];
77  cl_device_topology_amd amdtopo;
78  cl_int clret;
79 
80  if (!hwloc_topology_is_thissystem(topology)) {
81  errno = EINVAL;
82  return -1;
83  }
84 
85  clret = clGetDeviceInfo(device, CL_DEVICE_TOPOLOGY_AMD, sizeof(amdtopo), &amdtopo, NULL);
86  if (CL_SUCCESS != clret) {
88  return 0;
89  }
90  if (CL_DEVICE_TOPOLOGY_TYPE_PCIE_AMD != amdtopo.raw.type) {
92  return 0;
93  }
94 
95  sprintf(path, "/sys/bus/pci/devices/0000:%02x:%02x.%01x/local_cpus",
96  (unsigned) amdtopo.pcie.bus, (unsigned) amdtopo.pcie.device, (unsigned) amdtopo.pcie.function);
97  if (hwloc_linux_read_path_as_cpumask(path, set) < 0
98  || hwloc_bitmap_iszero(set))
100 #else
101  /* Non-Linux + AMD OpenCL systems simply get a full cpuset */
103 #endif
104  return 0;
105 }
106 
122 static __hwloc_inline hwloc_obj_t
124  unsigned platform_index, unsigned device_index)
125 {
126  unsigned x = (unsigned) -1, y = (unsigned) -1;
127  hwloc_obj_t osdev = NULL;
128  while ((osdev = hwloc_get_next_osdev(topology, osdev)) != NULL) {
129  if (HWLOC_OBJ_OSDEV_COPROC == osdev->attr->osdev.type
130  && osdev->name
131  && sscanf(osdev->name, "opencl%ud%u", &x, &y) == 2
132  && platform_index == x && device_index == y)
133  return osdev;
134  }
135  return NULL;
136 }
137 
158 static __hwloc_inline hwloc_obj_t
159 hwloc_opencl_get_device_osdev(hwloc_topology_t topology __hwloc_attribute_unused,
160  cl_device_id device __hwloc_attribute_unused)
161 {
162 #ifdef CL_DEVICE_TOPOLOGY_AMD
163  hwloc_obj_t osdev;
164  cl_device_topology_amd amdtopo;
165  cl_int clret;
166 
167  clret = clGetDeviceInfo(device, CL_DEVICE_TOPOLOGY_AMD, sizeof(amdtopo), &amdtopo, NULL);
168  if (CL_SUCCESS != clret) {
169  errno = EINVAL;
170  return NULL;
171  }
172  if (CL_DEVICE_TOPOLOGY_TYPE_PCIE_AMD != amdtopo.raw.type) {
173  errno = EINVAL;
174  return NULL;
175  }
176 
177  osdev = NULL;
178  while ((osdev = hwloc_get_next_osdev(topology, osdev)) != NULL) {
179  hwloc_obj_t pcidev = osdev->parent;
180  if (strncmp(osdev->name, "opencl", 6))
181  continue;
182  if (pcidev
183  && pcidev->type == HWLOC_OBJ_PCI_DEVICE
184  && pcidev->attr->pcidev.domain == 0
185  && pcidev->attr->pcidev.bus == amdtopo.pcie.bus
186  && pcidev->attr->pcidev.dev == amdtopo.pcie.device
187  && pcidev->attr->pcidev.func == amdtopo.pcie.function)
188  return osdev;
189  /* if PCI are filtered out, we need a info attr to match on */
190  }
191 
192  return NULL;
193 #else
194  return NULL;
195 #endif
196 }
197 
201 #ifdef __cplusplus
202 } /* extern "C" */
203 #endif
204 
205 
206 #endif /* HWLOC_OPENCL_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.
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
static hwloc_obj_t hwloc_opencl_get_device_osdev_by_index(hwloc_topology_t topology, unsigned platform_index, unsigned device_index)
Get the hwloc OS device object corresponding to the OpenCL device for the given indexes.
Definition: opencl.h:123
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
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
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
Operating system co-processor device. For instance "mic0" for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:312
unsigned short domain
Definition: hwloc.h:586
unsigned char func
Definition: hwloc.h:587
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
static int hwloc_opencl_get_device_cpuset(hwloc_topology_t topology, cl_device_id device, hwloc_cpuset_t set)
Get the CPU set of logical processors that are physically close to OpenCL device device.
Definition: opencl.h:69
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
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
static hwloc_obj_t hwloc_opencl_get_device_osdev(hwloc_topology_t topology, cl_device_id device)
Get the hwloc OS device object corresponding to OpenCL device deviceX.
Definition: opencl.h:159
int hwloc_bitmap_iszero(hwloc_const_bitmap_t bitmap)
Test whether bitmap bitmap is empty.