StarPU Handbook
starpu_opencl.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2010-2014,2018 Université de Bordeaux
4  * Copyright (C) 2011,2012 Inria
5  * Copyright (C) 2010-2013,2015-2017,2019 CNRS
6  *
7  * StarPU is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU Lesser General Public License as published by
9  * the Free Software Foundation; either version 2.1 of the License, or (at
10  * your option) any later version.
11  *
12  * StarPU is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15  *
16  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
17  */
18 
19 #ifndef __STARPU_OPENCL_H__
20 #define __STARPU_OPENCL_H__
21 
22 #include <starpu_config.h>
23 #ifdef STARPU_USE_OPENCL
24 #ifndef CL_TARGET_OPENCL_VERSION
25 #define CL_TARGET_OPENCL_VERSION 100
26 #endif
27 #ifdef __APPLE__
28 #include <OpenCL/cl.h>
29 #else
30 #include <CL/cl.h>
31 #endif
32 #include <assert.h>
33 
34 #ifdef __cplusplus
35 extern "C"
36 {
37 #endif
38 
49 {
52 };
53 
63 void starpu_opencl_get_context(int devid, cl_context *context);
64 
68 void starpu_opencl_get_device(int devid, cl_device_id *device);
69 
74 void starpu_opencl_get_queue(int devid, cl_command_queue *queue);
75 
79 void starpu_opencl_get_current_context(cl_context *context);
80 
85 void starpu_opencl_get_current_queue(cl_command_queue *queue);
86 
105 int starpu_opencl_set_kernel_args(cl_int *err, cl_kernel *kernel, ...);
106 
134 void starpu_opencl_load_program_source(const char *source_file_name, char *located_file_name, char *located_dir_name, char *opencl_program_source);
135 
141 void starpu_opencl_load_program_source_malloc(const char *source_file_name, char **located_file_name, char **located_dir_name, char **opencl_program_source);
142 
151 int starpu_opencl_compile_opencl_from_file(const char *source_file_name, const char *build_options);
152 
161 int starpu_opencl_compile_opencl_from_string(const char *opencl_program_source, const char *file_name, const char *build_options);
162 
169 int starpu_opencl_load_binary_opencl(const char *kernel_id, struct starpu_opencl_program *opencl_programs);
170 
174 int starpu_opencl_load_opencl_from_file(const char *source_file_name, struct starpu_opencl_program *opencl_programs, const char *build_options);
178 int starpu_opencl_load_opencl_from_string(const char *opencl_program_source, struct starpu_opencl_program *opencl_programs, const char *build_options);
179 
183 int starpu_opencl_unload_opencl(struct starpu_opencl_program *opencl_programs);
184 
197 int starpu_opencl_load_kernel(cl_kernel *kernel, cl_command_queue *queue, struct starpu_opencl_program *opencl_programs, const char *kernel_name, int devid);
198 
202 int starpu_opencl_release_kernel(cl_kernel kernel);
203 
218 int starpu_opencl_collect_stats(cl_event event);
219 
231 const char *starpu_opencl_error_string(cl_int status);
232 
238 void starpu_opencl_display_error(const char *func, const char *file, int line, const char *msg, cl_int status);
239 
245 #define STARPU_OPENCL_DISPLAY_ERROR(status) starpu_opencl_display_error(__starpu_func__, __FILE__, __LINE__, NULL, status)
246 
250 static __starpu_inline void starpu_opencl_report_error(const char *func, const char *file, int line, const char *msg, cl_int status)
251 {
252  starpu_opencl_display_error(func, file, line, msg, status);
253  assert(0);
254 }
255 
261 #define STARPU_OPENCL_REPORT_ERROR(status) starpu_opencl_report_error(__starpu_func__, __FILE__, __LINE__, NULL, status)
262 
267 #define STARPU_OPENCL_REPORT_ERROR_WITH_MSG(msg, status) starpu_opencl_report_error(__starpu_func__, __FILE__, __LINE__, msg, status)
268 
273 cl_int starpu_opencl_allocate_memory(int devid, cl_mem *addr, size_t size, cl_mem_flags flags);
274 
287 cl_int starpu_opencl_copy_ram_to_opencl(void *ptr, unsigned src_node, cl_mem buffer, unsigned dst_node, size_t size, size_t offset, cl_event *event, int *ret);
288 
301 cl_int starpu_opencl_copy_opencl_to_ram(cl_mem buffer, unsigned src_node, void *ptr, unsigned dst_node, size_t size, size_t offset, cl_event *event, int *ret);
302 
315 cl_int starpu_opencl_copy_opencl_to_opencl(cl_mem src, unsigned src_node, size_t src_offset, cl_mem dst, unsigned dst_node, size_t dst_offset, size_t size, cl_event *event, int *ret);
316 
327 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);
328 
333 #ifdef __cplusplus
334 }
335 #endif
336 
337 #endif /* STARPU_USE_OPENCL */
338 
339 #endif /* __STARPU_OPENCL_H__ */
cl_int starpu_opencl_copy_opencl_to_opencl(cl_mem src, unsigned src_node, size_t src_offset, cl_mem dst, unsigned dst_node, size_t dst_offset, size_t size, cl_event *event, int *ret)
void starpu_opencl_get_current_context(cl_context *context)
int starpu_opencl_load_kernel(cl_kernel *kernel, cl_command_queue *queue, struct starpu_opencl_program *opencl_programs, const char *kernel_name, int devid)
int starpu_opencl_release_kernel(cl_kernel kernel)
int starpu_opencl_set_kernel_args(cl_int *err, cl_kernel *kernel,...)
int starpu_opencl_load_opencl_from_file(const char *source_file_name, struct starpu_opencl_program *opencl_programs, const char *build_options)
cl_int starpu_opencl_copy_opencl_to_ram(cl_mem buffer, unsigned src_node, void *ptr, unsigned dst_node, size_t size, size_t offset, cl_event *event, int *ret)
int starpu_opencl_load_binary_opencl(const char *kernel_id, struct starpu_opencl_program *opencl_programs)
int starpu_opencl_load_opencl_from_string(const char *opencl_program_source, struct starpu_opencl_program *opencl_programs, const char *build_options)
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)
int starpu_opencl_compile_opencl_from_file(const char *source_file_name, const char *build_options)
int starpu_opencl_unload_opencl(struct starpu_opencl_program *opencl_programs)
cl_int starpu_opencl_copy_ram_to_opencl(void *ptr, unsigned src_node, cl_mem buffer, unsigned dst_node, size_t size, size_t offset, cl_event *event, int *ret)
void starpu_opencl_get_current_queue(cl_command_queue *queue)
void starpu_opencl_get_context(int devid, cl_context *context)
int starpu_opencl_compile_opencl_from_string(const char *opencl_program_source, const char *file_name, const char *build_options)
cl_int starpu_opencl_allocate_memory(int devid, cl_mem *addr, size_t size, cl_mem_flags flags)
void starpu_opencl_load_program_source(const char *source_file_name, char *located_file_name, char *located_dir_name, char *opencl_program_source)
void starpu_opencl_display_error(const char *func, const char *file, int line, const char *msg, cl_int status)
void starpu_opencl_load_program_source_malloc(const char *source_file_name, char **located_file_name, char **located_dir_name, char **opencl_program_source)
cl_program programs[STARPU_MAXOPENCLDEVS]
Definition: starpu_opencl.h:51
void starpu_opencl_get_queue(int devid, cl_command_queue *queue)
static __starpu_inline void starpu_opencl_report_error(const char *func, const char *file, int line, const char *msg, cl_int status)
Definition: starpu_opencl.h:250
#define STARPU_MAXOPENCLDEVS
Definition: starpu_config.h:113
void starpu_opencl_get_device(int devid, cl_device_id *device)
int starpu_opencl_collect_stats(cl_event event)
Definition: starpu_opencl.h:48
const char * starpu_opencl_error_string(cl_int status)