driver_opencl.c 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889
  1. /* StarPU --- Runtime system for heterogeneous multicore architectures.
  2. *
  3. * Copyright (C) 2010-2014 Université de Bordeaux 1
  4. * Copyright (C) 2010 Mehdi Juhoor <mjuhoor@gmail.com>
  5. * Copyright (C) 2010, 2011, 2012, 2013 Centre National de la Recherche Scientifique
  6. * Copyright (C) 2011 Télécom-SudParis
  7. *
  8. * StarPU is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU Lesser General Public License as published by
  10. * the Free Software Foundation; either version 2.1 of the License, or (at
  11. * your option) any later version.
  12. *
  13. * StarPU is distributed in the hope that it will be useful, but
  14. * WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  16. *
  17. * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  18. */
  19. #include <math.h>
  20. #include <starpu.h>
  21. #include <starpu_profiling.h>
  22. #include <common/config.h>
  23. #include <common/utils.h>
  24. #include <core/debug.h>
  25. #include <starpu_opencl.h>
  26. #include <drivers/driver_common/driver_common.h>
  27. #include "driver_opencl.h"
  28. #include "driver_opencl_utils.h"
  29. #include <common/utils.h>
  30. #include <datawizard/memory_manager.h>
  31. #include <datawizard/malloc.h>
  32. #ifdef STARPU_SIMGRID
  33. #include <core/simgrid.h>
  34. #endif
  35. static int nb_devices = -1;
  36. static int init_done = 0;
  37. static starpu_pthread_mutex_t big_lock = STARPU_PTHREAD_MUTEX_INITIALIZER;
  38. static size_t global_mem[STARPU_MAXOPENCLDEVS];
  39. #ifdef STARPU_USE_OPENCL
  40. static cl_context contexts[STARPU_MAXOPENCLDEVS];
  41. static cl_device_id devices[STARPU_MAXOPENCLDEVS];
  42. static cl_command_queue queues[STARPU_MAXOPENCLDEVS];
  43. static cl_command_queue in_transfer_queues[STARPU_MAXOPENCLDEVS];
  44. static cl_command_queue out_transfer_queues[STARPU_MAXOPENCLDEVS];
  45. static cl_command_queue peer_transfer_queues[STARPU_MAXOPENCLDEVS];
  46. static cl_command_queue alloc_queues[STARPU_MAXOPENCLDEVS];
  47. static cl_event task_events[STARPU_MAXOPENCLDEVS];
  48. #endif
  49. void
  50. _starpu_opencl_discover_devices(struct _starpu_machine_config *config)
  51. {
  52. /* Discover the number of OpenCL devices. Fill the result in CONFIG. */
  53. /* As OpenCL must have been initialized before calling this function,
  54. * `nb_device' is ensured to be correctly set. */
  55. STARPU_ASSERT(init_done == 1);
  56. config->topology.nhwopenclgpus = nb_devices;
  57. }
  58. static void _starpu_opencl_limit_gpu_mem_if_needed(unsigned devid)
  59. {
  60. starpu_ssize_t limit;
  61. size_t STARPU_ATTRIBUTE_UNUSED totalGlobalMem = 0;
  62. size_t STARPU_ATTRIBUTE_UNUSED to_waste = 0;
  63. char name[30];
  64. #ifdef STARPU_SIMGRID
  65. totalGlobalMem = _starpu_simgrid_get_memsize("OpenCL", devid);
  66. #elif defined(STARPU_USE_OPENCL)
  67. /* Request the size of the current device's memory */
  68. cl_int err;
  69. err = clGetDeviceInfo(devices[devid], CL_DEVICE_GLOBAL_MEM_SIZE, sizeof(totalGlobalMem), &totalGlobalMem, NULL);
  70. if (STARPU_UNLIKELY(err != CL_SUCCESS))
  71. STARPU_OPENCL_REPORT_ERROR(err);
  72. #endif
  73. limit = starpu_get_env_number("STARPU_LIMIT_OPENCL_MEM");
  74. if (limit == -1)
  75. {
  76. sprintf(name, "STARPU_LIMIT_OPENCL_%u_MEM", devid);
  77. limit = starpu_get_env_number(name);
  78. }
  79. #if defined(STARPU_USE_OPENCL) || defined(STARPU_SIMGRID)
  80. if (limit == -1)
  81. {
  82. /* Use 90% of the available memory by default. */
  83. limit = totalGlobalMem / (1024*1024) * 0.9;
  84. }
  85. #endif
  86. global_mem[devid] = limit * 1024*1024;
  87. #ifdef STARPU_USE_OPENCL
  88. /* How much memory to waste ? */
  89. to_waste = totalGlobalMem - global_mem[devid];
  90. #endif
  91. _STARPU_DEBUG("OpenCL device %d: Wasting %ld MB / Limit %ld MB / Total %ld MB / Remains %ld MB\n",
  92. devid, (long)to_waste/(1024*1024), (long) limit, (long)totalGlobalMem/(1024*1024),
  93. (long)(totalGlobalMem - to_waste)/(1024*1024));
  94. }
  95. #ifdef STARPU_USE_OPENCL
  96. void starpu_opencl_get_context(int devid, cl_context *context)
  97. {
  98. *context = contexts[devid];
  99. }
  100. void starpu_opencl_get_device(int devid, cl_device_id *device)
  101. {
  102. *device = devices[devid];
  103. }
  104. void starpu_opencl_get_queue(int devid, cl_command_queue *queue)
  105. {
  106. *queue = queues[devid];
  107. }
  108. void starpu_opencl_get_current_queue(cl_command_queue *queue)
  109. {
  110. struct _starpu_worker *worker = _starpu_get_local_worker_key();
  111. STARPU_ASSERT(queue);
  112. *queue = queues[worker->devid];
  113. }
  114. void starpu_opencl_get_current_context(cl_context *context)
  115. {
  116. struct _starpu_worker *worker = _starpu_get_local_worker_key();
  117. STARPU_ASSERT(context);
  118. *context = contexts[worker->devid];
  119. }
  120. #ifndef STARPU_SIMGRID
  121. cl_int _starpu_opencl_init_context(int devid)
  122. {
  123. cl_int err;
  124. cl_uint uint;
  125. STARPU_PTHREAD_MUTEX_LOCK(&big_lock);
  126. _STARPU_DEBUG("Initialising context for dev %d\n", devid);
  127. // Create a compute context
  128. err = 0;
  129. contexts[devid] = clCreateContext(NULL, 1, &devices[devid], NULL, NULL, &err);
  130. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  131. err = clGetDeviceInfo(devices[devid], CL_DEVICE_MEM_BASE_ADDR_ALIGN, sizeof(uint), &uint, NULL);
  132. if (STARPU_UNLIKELY(err != CL_SUCCESS))
  133. STARPU_OPENCL_REPORT_ERROR(err);
  134. starpu_malloc_set_align(uint/8);
  135. // Create execution queue for the given device
  136. queues[devid] = clCreateCommandQueue(contexts[devid], devices[devid], 0, &err);
  137. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  138. // Create transfer queue for the given device
  139. cl_command_queue_properties props;
  140. err = clGetDeviceInfo(devices[devid], CL_DEVICE_QUEUE_PROPERTIES, sizeof(props), &props, NULL);
  141. if (STARPU_UNLIKELY(err != CL_SUCCESS))
  142. STARPU_OPENCL_REPORT_ERROR(err);
  143. props &= ~CL_QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE;
  144. in_transfer_queues[devid] = clCreateCommandQueue(contexts[devid], devices[devid], props, &err);
  145. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  146. out_transfer_queues[devid] = clCreateCommandQueue(contexts[devid], devices[devid], props, &err);
  147. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  148. peer_transfer_queues[devid] = clCreateCommandQueue(contexts[devid], devices[devid], props, &err);
  149. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  150. alloc_queues[devid] = clCreateCommandQueue(contexts[devid], devices[devid], 0, &err);
  151. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  152. STARPU_PTHREAD_MUTEX_UNLOCK(&big_lock);
  153. return CL_SUCCESS;
  154. }
  155. cl_int _starpu_opencl_deinit_context(int devid)
  156. {
  157. cl_int err;
  158. STARPU_PTHREAD_MUTEX_LOCK(&big_lock);
  159. _STARPU_DEBUG("De-initialising context for dev %d\n", devid);
  160. err = clReleaseContext(contexts[devid]);
  161. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  162. err = clReleaseCommandQueue(queues[devid]);
  163. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  164. err = clReleaseCommandQueue(in_transfer_queues[devid]);
  165. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  166. err = clReleaseCommandQueue(out_transfer_queues[devid]);
  167. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  168. err = clReleaseCommandQueue(peer_transfer_queues[devid]);
  169. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  170. err = clReleaseCommandQueue(alloc_queues[devid]);
  171. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  172. contexts[devid] = NULL;
  173. STARPU_PTHREAD_MUTEX_UNLOCK(&big_lock);
  174. return CL_SUCCESS;
  175. }
  176. #endif
  177. cl_int starpu_opencl_allocate_memory(cl_mem *mem STARPU_ATTRIBUTE_UNUSED, size_t size STARPU_ATTRIBUTE_UNUSED, cl_mem_flags flags STARPU_ATTRIBUTE_UNUSED)
  178. {
  179. #ifdef STARPU_SIMGRID
  180. STARPU_ABORT();
  181. #else
  182. cl_int err;
  183. cl_mem memory;
  184. struct _starpu_worker *worker = _starpu_get_local_worker_key();
  185. memory = clCreateBuffer(contexts[worker->devid], flags, size, NULL, &err);
  186. if (err == CL_OUT_OF_HOST_MEMORY) return err;
  187. if (err != CL_SUCCESS) STARPU_OPENCL_REPORT_ERROR(err);
  188. /*
  189. * OpenCL uses lazy memory allocation: we will only know if the
  190. * allocation failed when trying to copy data onto the device. But we
  191. * want to know this __now__, so we just perform a dummy copy.
  192. */
  193. char dummy = 0;
  194. cl_event ev;
  195. err = clEnqueueWriteBuffer(alloc_queues[worker->devid], memory, CL_TRUE,
  196. 0, sizeof(dummy), &dummy,
  197. 0, NULL, &ev);
  198. if (err == CL_MEM_OBJECT_ALLOCATION_FAILURE)
  199. return err;
  200. if (err == CL_OUT_OF_RESOURCES)
  201. return err;
  202. if (err != CL_SUCCESS)
  203. STARPU_OPENCL_REPORT_ERROR(err);
  204. clWaitForEvents(1, &ev);
  205. clReleaseEvent(ev);
  206. *mem = memory;
  207. return CL_SUCCESS;
  208. #endif
  209. }
  210. cl_int starpu_opencl_copy_ram_to_opencl(void *ptr, unsigned src_node STARPU_ATTRIBUTE_UNUSED, cl_mem buffer, unsigned dst_node STARPU_ATTRIBUTE_UNUSED, size_t size, size_t offset, cl_event *event, int *ret)
  211. {
  212. cl_int err;
  213. struct _starpu_worker *worker = _starpu_get_local_worker_key();
  214. if (event)
  215. _STARPU_TRACE_START_DRIVER_COPY_ASYNC(src_node, dst_node);
  216. cl_event ev;
  217. err = clEnqueueWriteBuffer(in_transfer_queues[worker->devid], buffer, CL_FALSE, offset, size, ptr, 0, NULL, &ev);
  218. if (event)
  219. _STARPU_TRACE_END_DRIVER_COPY_ASYNC(src_node, dst_node);
  220. if (STARPU_LIKELY(err == CL_SUCCESS))
  221. {
  222. if (event == NULL)
  223. {
  224. /* We want a synchronous copy, let's synchronise the queue */
  225. err = clWaitForEvents(1, &ev);
  226. if (STARPU_UNLIKELY(err))
  227. STARPU_OPENCL_REPORT_ERROR(err);
  228. err = clReleaseEvent(ev);
  229. if (STARPU_UNLIKELY(err))
  230. STARPU_OPENCL_REPORT_ERROR(err);
  231. }
  232. else
  233. {
  234. *event = ev;
  235. }
  236. if (ret)
  237. {
  238. *ret = (event == NULL) ? 0 : -EAGAIN;
  239. }
  240. }
  241. return err;
  242. }
  243. cl_int starpu_opencl_copy_opencl_to_ram(cl_mem buffer, unsigned src_node STARPU_ATTRIBUTE_UNUSED, void *ptr, unsigned dst_node STARPU_ATTRIBUTE_UNUSED, size_t size, size_t offset, cl_event *event, int *ret)
  244. {
  245. cl_int err;
  246. struct _starpu_worker *worker = _starpu_get_local_worker_key();
  247. if (event)
  248. _STARPU_TRACE_START_DRIVER_COPY_ASYNC(src_node, dst_node);
  249. cl_event ev;
  250. err = clEnqueueReadBuffer(out_transfer_queues[worker->devid], buffer, CL_FALSE, offset, size, ptr, 0, NULL, &ev);
  251. if (event)
  252. _STARPU_TRACE_END_DRIVER_COPY_ASYNC(src_node, dst_node);
  253. if (STARPU_LIKELY(err == CL_SUCCESS))
  254. {
  255. if (event == NULL)
  256. {
  257. /* We want a synchronous copy, let's synchronise the queue */
  258. err = clWaitForEvents(1, &ev);
  259. if (STARPU_UNLIKELY(err))
  260. STARPU_OPENCL_REPORT_ERROR(err);
  261. err = clReleaseEvent(ev);
  262. if (STARPU_UNLIKELY(err))
  263. STARPU_OPENCL_REPORT_ERROR(err);
  264. }
  265. else
  266. {
  267. *event = ev;
  268. }
  269. if (ret)
  270. {
  271. *ret = (event == NULL) ? 0 : -EAGAIN;
  272. }
  273. }
  274. return err;
  275. }
  276. cl_int starpu_opencl_copy_opencl_to_opencl(cl_mem src, unsigned src_node STARPU_ATTRIBUTE_UNUSED, size_t src_offset, cl_mem dst, unsigned dst_node STARPU_ATTRIBUTE_UNUSED, size_t dst_offset, size_t size, cl_event *event, int *ret)
  277. {
  278. cl_int err;
  279. struct _starpu_worker *worker = _starpu_get_local_worker_key();
  280. if (event)
  281. _STARPU_TRACE_START_DRIVER_COPY_ASYNC(src_node, dst_node);
  282. cl_event ev;
  283. err = clEnqueueCopyBuffer(peer_transfer_queues[worker->devid], src, dst, src_offset, dst_offset, size, 0, NULL, &ev);
  284. if (event)
  285. _STARPU_TRACE_END_DRIVER_COPY_ASYNC(src_node, dst_node);
  286. if (STARPU_LIKELY(err == CL_SUCCESS))
  287. {
  288. if (event == NULL)
  289. {
  290. /* We want a synchronous copy, let's synchronise the queue */
  291. err = clWaitForEvents(1, &ev);
  292. if (STARPU_UNLIKELY(err))
  293. STARPU_OPENCL_REPORT_ERROR(err);
  294. err = clReleaseEvent(ev);
  295. if (STARPU_UNLIKELY(err))
  296. STARPU_OPENCL_REPORT_ERROR(err);
  297. }
  298. else
  299. {
  300. *event = ev;
  301. }
  302. if (ret)
  303. {
  304. *ret = (event == NULL) ? 0 : -EAGAIN;
  305. }
  306. }
  307. return err;
  308. }
  309. #ifdef STARPU_USE_OPENCL
  310. cl_int starpu_opencl_copy_async_sync(uintptr_t src, size_t src_offset, unsigned src_node, uintptr_t dst, size_t dst_offset, unsigned dst_node, size_t size, cl_event *event)
  311. {
  312. enum starpu_node_kind src_kind = starpu_node_get_kind(src_node);
  313. enum starpu_node_kind dst_kind = starpu_node_get_kind(dst_node);
  314. cl_int err;
  315. int ret;
  316. switch (_STARPU_MEMORY_NODE_TUPLE(src_kind,dst_kind))
  317. {
  318. case _STARPU_MEMORY_NODE_TUPLE(STARPU_OPENCL_RAM,STARPU_CPU_RAM):
  319. err = starpu_opencl_copy_opencl_to_ram(
  320. (cl_mem) src, src_node,
  321. (void*) dst + dst_offset, dst_node,
  322. size, src_offset, event, &ret);
  323. if (STARPU_UNLIKELY(err))
  324. STARPU_OPENCL_REPORT_ERROR(err);
  325. return ret;
  326. case _STARPU_MEMORY_NODE_TUPLE(STARPU_CPU_RAM,STARPU_OPENCL_RAM):
  327. err = starpu_opencl_copy_ram_to_opencl(
  328. (void*) src + src_offset, src_node,
  329. (cl_mem) dst, dst_node,
  330. size, dst_offset, event, &ret);
  331. if (STARPU_UNLIKELY(err))
  332. STARPU_OPENCL_REPORT_ERROR(err);
  333. return ret;
  334. case _STARPU_MEMORY_NODE_TUPLE(STARPU_OPENCL_RAM,STARPU_OPENCL_RAM):
  335. err = starpu_opencl_copy_opencl_to_opencl(
  336. (cl_mem) src, src_node, src_offset,
  337. (cl_mem) dst, dst_node, dst_offset,
  338. size, event, &ret);
  339. if (STARPU_UNLIKELY(err))
  340. STARPU_OPENCL_REPORT_ERROR(err);
  341. return ret;
  342. default:
  343. STARPU_ABORT();
  344. break;
  345. }
  346. }
  347. #endif
  348. #if 0
  349. cl_int _starpu_opencl_copy_rect_opencl_to_ram(cl_mem buffer, unsigned src_node STARPU_ATTRIBUTE_UNUSED, void *ptr, unsigned dst_node STARPU_ATTRIBUTE_UNUSED, const size_t buffer_origin[3], const size_t host_origin[3],
  350. const size_t region[3], size_t buffer_row_pitch, size_t buffer_slice_pitch,
  351. size_t host_row_pitch, size_t host_slice_pitch, cl_event *event)
  352. {
  353. cl_int err;
  354. struct _starpu_worker *worker = _starpu_get_local_worker_key();
  355. cl_bool blocking;
  356. blocking = (event == NULL) ? CL_TRUE : CL_FALSE;
  357. if (event)
  358. _STARPU_TRACE_START_DRIVER_COPY_ASYNC(src_node, dst_node);
  359. err = clEnqueueReadBufferRect(out_transfer_queues[worker->devid], buffer, blocking, buffer_origin, host_origin, region, buffer_row_pitch,
  360. buffer_slice_pitch, host_row_pitch, host_slice_pitch, ptr, 0, NULL, event);
  361. if (event)
  362. _STARPU_TRACE_END_DRIVER_COPY_ASYNC(src_node, dst_node);
  363. if (err != CL_SUCCESS) STARPU_OPENCL_REPORT_ERROR(err);
  364. return CL_SUCCESS;
  365. }
  366. cl_int _starpu_opencl_copy_rect_ram_to_opencl(void *ptr, unsigned src_node STARPU_ATTRIBUTE_UNUSED, cl_mem buffer, unsigned dst_node STARPU_ATTRIBUTE_UNUSED, const size_t buffer_origin[3], const size_t host_origin[3],
  367. const size_t region[3], size_t buffer_row_pitch, size_t buffer_slice_pitch,
  368. size_t host_row_pitch, size_t host_slice_pitch, cl_event *event)
  369. {
  370. cl_int err;
  371. struct _starpu_worker *worker = _starpu_get_local_worker_key();
  372. cl_bool blocking;
  373. blocking = (event == NULL) ? CL_TRUE : CL_FALSE;
  374. if (event)
  375. _STARPU_TRACE_START_DRIVER_COPY_ASYNC(src_node, dst_node);
  376. err = clEnqueueWriteBufferRect(in_transfer_queues[worker->devid], buffer, blocking, buffer_origin, host_origin, region, buffer_row_pitch,
  377. buffer_slice_pitch, host_row_pitch, host_slice_pitch, ptr, 0, NULL, event);
  378. if (event)
  379. _STARPU_TRACE_END_DRIVER_COPY_ASYNC(src_node, dst_node);
  380. if (err != CL_SUCCESS) STARPU_OPENCL_REPORT_ERROR(err);
  381. return CL_SUCCESS;
  382. }
  383. #endif
  384. #endif /* STARPU_USE_OPENCL */
  385. static size_t _starpu_opencl_get_global_mem_size(int devid)
  386. {
  387. return global_mem[devid];
  388. }
  389. void _starpu_opencl_init(void)
  390. {
  391. STARPU_PTHREAD_MUTEX_LOCK(&big_lock);
  392. if (!init_done)
  393. {
  394. #ifdef STARPU_SIMGRID
  395. nb_devices = _starpu_simgrid_get_nbhosts("OpenCL");
  396. #else /* STARPU_USE_OPENCL */
  397. cl_platform_id platform_id[_STARPU_OPENCL_PLATFORM_MAX];
  398. cl_uint nb_platforms;
  399. cl_int err;
  400. int i;
  401. cl_device_type device_type = CL_DEVICE_TYPE_GPU|CL_DEVICE_TYPE_ACCELERATOR;
  402. _STARPU_DEBUG("Initialising OpenCL\n");
  403. // Get Platforms
  404. if (starpu_get_env_number("STARPU_OPENCL_ON_CPUS") > 0)
  405. device_type |= CL_DEVICE_TYPE_CPU;
  406. if (starpu_get_env_number("STARPU_OPENCL_ONLY_ON_CPUS") > 0)
  407. device_type = CL_DEVICE_TYPE_CPU;
  408. err = clGetPlatformIDs(_STARPU_OPENCL_PLATFORM_MAX, platform_id, &nb_platforms);
  409. if (STARPU_UNLIKELY(err != CL_SUCCESS)) nb_platforms=0;
  410. _STARPU_DEBUG("Platforms detected: %u\n", nb_platforms);
  411. // Get devices
  412. nb_devices = 0;
  413. {
  414. unsigned j;
  415. for (j=0; j<nb_platforms; j++)
  416. {
  417. cl_uint num;
  418. int platform_valid = 1;
  419. char name[1024], vendor[1024];
  420. err = clGetPlatformInfo(platform_id[j], CL_PLATFORM_NAME, 1024, name, NULL);
  421. if (err != CL_SUCCESS)
  422. {
  423. STARPU_OPENCL_REPORT_ERROR_WITH_MSG("clGetPlatformInfo NAME", err);
  424. platform_valid = 0;
  425. }
  426. else
  427. {
  428. err = clGetPlatformInfo(platform_id[j], CL_PLATFORM_VENDOR, 1024, vendor, NULL);
  429. if (STARPU_UNLIKELY(err != CL_SUCCESS))
  430. {
  431. STARPU_OPENCL_REPORT_ERROR_WITH_MSG("clGetPlatformInfo VENDOR", err);
  432. platform_valid = 0;
  433. }
  434. }
  435. if(strcmp(name, "SOCL Platform") == 0)
  436. {
  437. platform_valid = 0;
  438. _STARPU_DEBUG("Skipping SOCL Platform\n");
  439. }
  440. #ifdef STARPU_VERBOSE
  441. if (platform_valid)
  442. _STARPU_DEBUG("Platform: %s - %s\n", name, vendor);
  443. else
  444. _STARPU_DEBUG("Platform invalid\n");
  445. #endif
  446. if (platform_valid && nb_devices <= STARPU_MAXOPENCLDEVS)
  447. {
  448. err = clGetDeviceIDs(platform_id[j], device_type, STARPU_MAXOPENCLDEVS-nb_devices, STARPU_MAXOPENCLDEVS == nb_devices ? NULL : &devices[nb_devices], &num);
  449. if (err == CL_DEVICE_NOT_FOUND)
  450. {
  451. _STARPU_DEBUG(" No devices detected on this platform\n");
  452. }
  453. else
  454. {
  455. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  456. _STARPU_DEBUG(" %u devices detected\n", num);
  457. nb_devices += num;
  458. }
  459. }
  460. }
  461. }
  462. // Get location of OpenCl kernel source files
  463. _starpu_opencl_program_dir = getenv("STARPU_OPENCL_PROGRAM_DIR");
  464. if (nb_devices > STARPU_MAXOPENCLDEVS)
  465. {
  466. _STARPU_DISP("# Warning: %u OpenCL devices available. Only %d enabled. Use configure option --enable-maxopencldev=xxx to update the maximum value of supported OpenCL devices?\n", nb_devices, STARPU_MAXOPENCLDEVS);
  467. nb_devices = STARPU_MAXOPENCLDEVS;
  468. }
  469. // initialise internal structures
  470. for(i=0 ; i<nb_devices ; i++)
  471. {
  472. contexts[i] = NULL;
  473. queues[i] = NULL;
  474. in_transfer_queues[i] = NULL;
  475. out_transfer_queues[i] = NULL;
  476. peer_transfer_queues[i] = NULL;
  477. alloc_queues[i] = NULL;
  478. }
  479. #endif /* STARPU_USE_OPENCL */
  480. init_done=1;
  481. }
  482. STARPU_PTHREAD_MUTEX_UNLOCK(&big_lock);
  483. }
  484. #ifndef STARPU_SIMGRID
  485. static unsigned _starpu_opencl_get_device_name(int dev, char *name, int lname);
  486. #endif
  487. static int _starpu_opencl_start_job(struct _starpu_job *j, struct _starpu_worker *args);
  488. static void _starpu_opencl_stop_job(struct _starpu_job *j, struct _starpu_worker *args);
  489. int _starpu_opencl_driver_init(struct _starpu_worker *args)
  490. {
  491. int devid = args->devid;
  492. int workerid = args->workerid;
  493. _starpu_worker_start(args, _STARPU_FUT_OPENCL_KEY);
  494. #ifndef STARPU_SIMGRID
  495. _starpu_opencl_init_context(devid);
  496. #endif
  497. /* one more time to avoid hacks from third party lib :) */
  498. _starpu_bind_thread_on_cpu(args->config, args->bindid);
  499. _starpu_opencl_limit_gpu_mem_if_needed(devid);
  500. _starpu_memory_manager_set_global_memory_size(args->memory_node, _starpu_opencl_get_global_mem_size(devid));
  501. _starpu_malloc_init(args->memory_node);
  502. args->status = STATUS_UNKNOWN;
  503. float size = (float) global_mem[devid] / (1<<30);
  504. #ifdef STARPU_SIMGRID
  505. const char *devname = "Simgrid";
  506. #else
  507. /* get the device's name */
  508. char devname[128];
  509. _starpu_opencl_get_device_name(devid, devname, 128);
  510. #endif
  511. snprintf(args->name, sizeof(args->name), "OpenCL %u (%s %.1f GiB)", devid, devname, size);
  512. snprintf(args->short_name, sizeof(args->short_name), "OpenCL %u", devid);
  513. _STARPU_DEBUG("OpenCL (%s) dev id %d thread is ready to run on CPU %d !\n", devname, devid, args->bindid);
  514. _STARPU_TRACE_WORKER_INIT_END(workerid);
  515. /* tell the main thread that this one is ready */
  516. STARPU_PTHREAD_MUTEX_LOCK(&args->mutex);
  517. args->worker_is_initialized = 1;
  518. STARPU_PTHREAD_COND_SIGNAL(&args->ready_cond);
  519. STARPU_PTHREAD_MUTEX_UNLOCK(&args->mutex);
  520. return 0;
  521. }
  522. int _starpu_opencl_driver_run_once(struct _starpu_worker *args)
  523. {
  524. int workerid = args->workerid;
  525. unsigned memnode = args->memory_node;
  526. struct _starpu_job *j;
  527. struct starpu_task *task;
  528. int res;
  529. task = starpu_task_get_current();
  530. if (task)
  531. {
  532. cl_int status;
  533. size_t size;
  534. int err;
  535. /* On-going asynchronous task, check for its termination first */
  536. err = clGetEventInfo(task_events[args->devid], CL_EVENT_COMMAND_EXECUTION_STATUS, sizeof(cl_int), &status, &size);
  537. STARPU_ASSERT(size == sizeof(cl_int));
  538. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  539. if (status != CL_COMPLETE)
  540. {
  541. /* Not ready yet, no better thing to do than waiting */
  542. __starpu_datawizard_progress(memnode, 1, 0);
  543. return 0;
  544. }
  545. /* Asynchronous task completed! */
  546. _starpu_opencl_stop_job(_starpu_get_job_associated_to_task(task), args);
  547. }
  548. __starpu_datawizard_progress(memnode, 1, 1);
  549. _STARPU_TRACE_END_PROGRESS(memnode);
  550. task = _starpu_get_worker_task(args, workerid, memnode);
  551. if (task == NULL)
  552. return 0;
  553. j = _starpu_get_job_associated_to_task(task);
  554. /* can OpenCL do that task ? */
  555. if (!_STARPU_OPENCL_MAY_PERFORM(j))
  556. {
  557. /* this is not a OpenCL task */
  558. _starpu_push_task_to_workers(task);
  559. return 0;
  560. }
  561. res = _starpu_opencl_start_job(j, args);
  562. if (res)
  563. {
  564. switch (res)
  565. {
  566. case -EAGAIN:
  567. _STARPU_DISP("ouch, OpenCL could not actually run task %p, putting it back...\n", task);
  568. _starpu_push_task_to_workers(task);
  569. STARPU_ABORT();
  570. return 0;
  571. default:
  572. STARPU_ABORT();
  573. }
  574. }
  575. #ifndef STARPU_SIMGRID
  576. if (task->cl->opencl_flags[j->nimpl] & STARPU_OPENCL_ASYNC)
  577. {
  578. /* Record event to synchronize with task termination later */
  579. int err;
  580. cl_command_queue queue;
  581. starpu_opencl_get_queue(args->devid, &queue);
  582. /* the function clEnqueueMarker is deprecated from
  583. * OpenCL version 1.2. We would like to use the new
  584. * function clEnqueueMarkerWithWaitList. We could do
  585. * it by checking its availability through our own
  586. * configure macro HAVE_CLENQUEUEMARKERWITHWAITLIST
  587. * and the OpenCL macro CL_VERSION_1_2. However these
  588. * 2 macros detect the function availability in the
  589. * ICD and not in the device implementation.
  590. */
  591. err = clEnqueueMarker(queue, &task_events[args->devid]);
  592. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  593. }
  594. else
  595. #else
  596. #ifdef STARPU_DEVEL
  597. #warning No CUDA asynchronous execution with simgrid yet.
  598. #endif
  599. #endif
  600. /* Synchronous execution */
  601. {
  602. _starpu_opencl_stop_job(j, args);
  603. }
  604. _STARPU_TRACE_START_PROGRESS(memnode);
  605. return 0;
  606. }
  607. int _starpu_opencl_driver_deinit(struct _starpu_worker *args)
  608. {
  609. _STARPU_TRACE_WORKER_DEINIT_START;
  610. unsigned memnode = args->memory_node;
  611. _starpu_handle_all_pending_node_data_requests(memnode);
  612. /* In case there remains some memory that was automatically
  613. * allocated by StarPU, we release it now. Note that data
  614. * coherency is not maintained anymore at that point ! */
  615. _starpu_free_all_automatically_allocated_buffers(memnode);
  616. _starpu_malloc_shutdown(memnode);
  617. #ifndef STARPU_SIMGRID
  618. unsigned devid = args->devid;
  619. _starpu_opencl_deinit_context(devid);
  620. #endif
  621. _STARPU_TRACE_WORKER_DEINIT_END(_STARPU_FUT_OPENCL_KEY);
  622. return 0;
  623. }
  624. void *_starpu_opencl_worker(void *arg)
  625. {
  626. struct _starpu_worker* args = arg;
  627. _starpu_opencl_driver_init(args);
  628. _STARPU_TRACE_START_PROGRESS(memnode);
  629. while (_starpu_machine_is_running())
  630. _starpu_opencl_driver_run_once(args);
  631. _starpu_opencl_driver_deinit(args);
  632. _STARPU_TRACE_END_PROGRESS(memnode);
  633. return NULL;
  634. }
  635. #ifdef STARPU_USE_OPENCL
  636. #ifndef STARPU_SIMGRID
  637. static unsigned _starpu_opencl_get_device_name(int dev, char *name, int lname)
  638. {
  639. int err;
  640. if (!init_done)
  641. {
  642. _starpu_opencl_init();
  643. }
  644. // Get device name
  645. err = clGetDeviceInfo(devices[dev], CL_DEVICE_NAME, lname, name, NULL);
  646. if (STARPU_UNLIKELY(err != CL_SUCCESS)) STARPU_OPENCL_REPORT_ERROR(err);
  647. _STARPU_DEBUG("Device %d : [%s]\n", dev, name);
  648. return EXIT_SUCCESS;
  649. }
  650. #endif
  651. #endif
  652. unsigned _starpu_opencl_get_device_count(void)
  653. {
  654. if (!init_done)
  655. {
  656. _starpu_opencl_init();
  657. }
  658. return nb_devices;
  659. }
  660. #ifdef STARPU_USE_OPENCL
  661. cl_device_type _starpu_opencl_get_device_type(int devid)
  662. {
  663. int err;
  664. cl_device_type type;
  665. if (!init_done)
  666. _starpu_opencl_init();
  667. err = clGetDeviceInfo(devices[devid], CL_DEVICE_TYPE, sizeof(cl_device_type), &type, NULL);
  668. if (STARPU_UNLIKELY(err != CL_SUCCESS))
  669. STARPU_OPENCL_REPORT_ERROR(err);
  670. return type;
  671. }
  672. #endif /* STARPU_USE_OPENCL */
  673. static int _starpu_opencl_start_job(struct _starpu_job *j, struct _starpu_worker *args)
  674. {
  675. int ret;
  676. STARPU_ASSERT(j);
  677. struct starpu_task *task = j->task;
  678. int profiling = starpu_profiling_status_get();
  679. STARPU_ASSERT(task);
  680. struct starpu_codelet *cl = task->cl;
  681. STARPU_ASSERT(cl);
  682. _starpu_set_current_task(j->task);
  683. args->current_task = j->task;
  684. ret = _starpu_fetch_task_input(j);
  685. if (ret != 0)
  686. {
  687. /* there was not enough memory, so the input of
  688. * the codelet cannot be fetched ... put the
  689. * codelet back, and try it later */
  690. return -EAGAIN;
  691. }
  692. _starpu_driver_start_job(args, j, &j->cl_start, 0, profiling);
  693. starpu_opencl_func_t func = _starpu_task_get_opencl_nth_implementation(cl, j->nimpl);
  694. STARPU_ASSERT_MSG(func, "when STARPU_OPENCL is defined in 'where', opencl_func or opencl_funcs has to be defined");
  695. if (starpu_get_env_number("STARPU_DISABLE_KERNELS") <= 0)
  696. {
  697. #ifdef STARPU_SIMGRID
  698. double length = NAN;
  699. #ifdef STARPU_OPENCL_SIMULATOR
  700. func(_STARPU_TASK_GET_INTERFACES(task), task->cl_arg);
  701. #ifndef CL_PROFILING_CLOCK_CYCLE_COUNT
  702. #ifdef CL_PROFILING_COMMAND_SHAVE_CYCLE_COUNT
  703. #define CL_PROFILING_CLOCK_CYCLE_COUNT CL_PROFILING_COMMAND_SHAVE_CYCLE_COUNT
  704. #else
  705. #error The OpenCL simulator must provide CL_PROFILING_CLOCK_CYCLE_COUNT
  706. #endif
  707. #endif
  708. struct starpu_profiling_task_info *profiling_info = task->profiling_info;
  709. STARPU_ASSERT_MSG(profiling_info->used_cycles, "Application kernel must call starpu_opencl_collect_stats to collect simulated time");
  710. length = ((double) profiling_info->used_cycles)/MSG_get_host_speed(MSG_host_self());
  711. #endif
  712. _starpu_simgrid_execute_job(j, &args->perf_arch, length);
  713. #else
  714. func(_STARPU_TASK_GET_INTERFACES(task), task->cl_arg);
  715. #endif
  716. }
  717. return 0;
  718. }
  719. static void _starpu_opencl_stop_job(struct _starpu_job *j, struct _starpu_worker *args)
  720. {
  721. struct timespec codelet_end;
  722. int profiling = starpu_profiling_status_get();
  723. _starpu_set_current_task(NULL);
  724. args->current_task = NULL;
  725. _starpu_driver_end_job(args, j, &args->perf_arch, &codelet_end, 0, profiling);
  726. _starpu_driver_update_job_feedback(j, args, &args->perf_arch,
  727. &j->cl_start, &codelet_end, profiling);
  728. _starpu_push_task_output(j);
  729. _starpu_handle_job_termination(j);
  730. }
  731. #ifdef STARPU_USE_OPENCL
  732. int _starpu_run_opencl(struct _starpu_worker *workerarg)
  733. {
  734. _STARPU_DEBUG("Running OpenCL %u from the application\n", workerarg->devid);
  735. workerarg->set = NULL;
  736. workerarg->worker_is_initialized = 0;
  737. /* Let's go ! */
  738. _starpu_opencl_worker(workerarg);
  739. return 0;
  740. }
  741. #endif /* STARPU_USE_OPENCL */