Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v1.8

  |   Home   |   Support   |   FAQ   |  
opencl.h
1 /*
2  * Copyright ¬© 2012-2013 Inria. All rights reserved.
3  * Copyright ¬© 2013 Universit√© Bordeaux 1. 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 #include <CL/cl.h>
25 #include <CL/cl_ext.h>
26 
27 #include <stdio.h>
28 
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 
63 static __hwloc_inline int
64 hwloc_opencl_get_device_cpuset(hwloc_topology_t topology __hwloc_attribute_unused,
65  cl_device_id device __hwloc_attribute_unused,
66  hwloc_cpuset_t set)
67 {
68 #if (defined HWLOC_LINUX_SYS) && (defined CL_DEVICE_TOPOLOGY_AMD)
69  /* If we're on Linux + AMD OpenCL, use the AMD extension + the sysfs mechanism to get the local cpus */
70 #define HWLOC_OPENCL_DEVICE_SYSFS_PATH_MAX 128
71  char path[HWLOC_OPENCL_DEVICE_SYSFS_PATH_MAX];
72  FILE *sysfile = NULL;
73  cl_device_topology_amd amdtopo;
74  cl_int clret;
75 
76  if (!hwloc_topology_is_thissystem(topology)) {
77  errno = EINVAL;
78  return -1;
79  }
80 
81  clret = clGetDeviceInfo(device, CL_DEVICE_TOPOLOGY_AMD, sizeof(amdtopo), &amdtopo, NULL);
82  if (CL_SUCCESS != clret) {
84  return 0;
85  }
86  if (CL_DEVICE_TOPOLOGY_TYPE_PCIE_AMD != amdtopo.raw.type) {
88  return 0;
89  }
90 
91  sprintf(path, "/sys/bus/pci/devices/0000:%02x:%02x.%01x/local_cpus", amdtopo.pcie.bus, amdtopo.pcie.device, amdtopo.pcie.function);
92  sysfile = fopen(path, "r");
93  if (!sysfile)
94  return -1;
95 
96  hwloc_linux_parse_cpumap_file(sysfile, set);
97  if (hwloc_bitmap_iszero(set))
99 
100  fclose(sysfile);
101 #else
102  /* Non-Linux + AMD OpenCL systems simply get a full cpuset */
104 #endif
105  return 0;
106 }
107 
123 static __hwloc_inline hwloc_obj_t
125  unsigned platform_index, unsigned device_index)
126 {
127  unsigned x = (unsigned) -1, y = (unsigned) -1;
128  hwloc_obj_t osdev = NULL;
129  while ((osdev = hwloc_get_next_osdev(topology, osdev)) != NULL) {
130  if (HWLOC_OBJ_OSDEV_COPROC == osdev->attr->osdev.type
131  && osdev->name
132  && sscanf(osdev->name, "opencl%ud%u", &x, &y) == 2
133  && platform_index == x && device_index == y)
134  return osdev;
135  }
136  return NULL;
137 }
138 
152 static __hwloc_inline hwloc_obj_t
153 hwloc_opencl_get_device_osdev(hwloc_topology_t topology __hwloc_attribute_unused,
154  cl_device_id device __hwloc_attribute_unused)
155 {
156 #ifdef CL_DEVICE_TOPOLOGY_AMD
157  hwloc_obj_t osdev;
158  cl_device_topology_amd amdtopo;
159  cl_int clret;
160 
161  clret = clGetDeviceInfo(device, CL_DEVICE_TOPOLOGY_AMD, sizeof(amdtopo), &amdtopo, NULL);
162  if (CL_SUCCESS != clret) {
163  errno = EINVAL;
164  return NULL;
165  }
166  if (CL_DEVICE_TOPOLOGY_TYPE_PCIE_AMD != amdtopo.raw.type) {
167  errno = EINVAL;
168  return NULL;
169  }
170 
171  osdev = NULL;
172  while ((osdev = hwloc_get_next_osdev(topology, osdev)) != NULL) {
173  hwloc_obj_t pcidev = osdev->parent;
174  if (strncmp(osdev->name, "opencl", 6))
175  continue;
176  if (pcidev
177  && pcidev->type == HWLOC_OBJ_PCI_DEVICE
178  && pcidev->attr->pcidev.domain == 0
179  && pcidev->attr->pcidev.bus == amdtopo.pcie.bus
180  && pcidev->attr->pcidev.dev == amdtopo.pcie.device
181  && pcidev->attr->pcidev.func == amdtopo.pcie.function)
182  return osdev;
183  }
184 
185  return NULL;
186 #else
187  return NULL;
188 #endif
189 }
190 
194 #ifdef __cplusplus
195 } /* extern "C" */
196 #endif
197 
198 
199 #endif /* HWLOC_OPENCL_H */
HWLOC_DECLSPEC int hwloc_topology_is_thissystem(hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure
Does the topology context come from this system?
HWLOC_DECLSPEC int hwloc_linux_parse_cpumap_file(FILE *file, hwloc_cpuset_t set)
Convert a linux kernel cpumap file file into hwloc CPU set.
Operating system co-processor device. For instance &quot;mic0&quot; for a Xeon Phi (MIC) on Linux...
Definition: hwloc.h:270
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:357
Structure of a topology object.
Definition: hwloc.h:331
HWLOC_DECLSPEC void hwloc_bitmap_copy(hwloc_bitmap_t dst, hwloc_const_bitmap_t src)
Copy the contents of bitmap src into the already allocated bitmap dst.
static __hwloc_inline hwloc_const_cpuset_t hwloc_topology_get_complete_cpuset(hwloc_topology_t topology) __hwloc_attribute_pure
Get complete CPU set.
Definition: helper.h:726
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
hwloc_obj_osdev_type_t type
Definition: hwloc.h:520
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:333
char * name
Object description if any.
Definition: hwloc.h:335
static __hwloc_inline 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:1175
unsigned short domain
Definition: hwloc.h:496
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:339
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
HWLOC_DECLSPEC int hwloc_bitmap_iszero(hwloc_const_bitmap_t bitmap) __hwloc_attribute_pure
Test whether bitmap bitmap is empty.
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:577
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:220
static __hwloc_inline 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:124
unsigned char bus
Definition: hwloc.h:497
static __hwloc_inline hwloc_obj_t hwloc_opencl_get_device_osdev(hwloc_topology_t topology __hwloc_attribute_unused, cl_device_id device __hwloc_attribute_unused)
Get the hwloc OS device object corresponding to OpenCL device device.
Definition: opencl.h:153
static __hwloc_inline int hwloc_opencl_get_device_cpuset(hwloc_topology_t topology __hwloc_attribute_unused, cl_device_id device __hwloc_attribute_unused, hwloc_cpuset_t set)
Get the CPU set of logical processors that are physically close to OpenCL device device.
Definition: opencl.h:64
unsigned char func
Definition: hwloc.h:497
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:116
unsigned char dev
Definition: hwloc.h:497