MagickCore  6.9.6
opencl-private.h
Go to the documentation of this file.
1 /*
2 Copyright 1999-2016 ImageMagick Studio LLC, a non-profit organization
3 dedicated to making software imaging solutions freely available.
4 
5 You may not use this file except in compliance with the License.
6 obtain a copy of the License at
7 
8 http://www.imagemagick.org/script/license.php
9 
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15 
16 MagickCore OpenCL private methods.
17 */
18 #ifndef MAGICKCORE_OPENCL_PRIVATE_H
19 #define MAGICKCORE_OPENCL_PRIVATE_H
20 
21 /*
22 Include declarations.
23 */
24 #include "magick/studio.h"
25 #include "magick/opencl.h"
26 
27 #if defined(__cplusplus) || defined(c_plusplus)
28 extern "C" {
29 #endif
30 
31 #if !defined(MAGICKCORE_OPENCL_SUPPORT)
32  typedef void* cl_context;
33  typedef void* cl_command_queue;
34  typedef void* cl_device_id;
35  typedef void* cl_event;
36  typedef void* cl_kernel;
37  typedef void* cl_mem;
38  typedef void* cl_platform_id;
39  typedef void* cl_uint;
40  typedef struct { unsigned char t[8]; } cl_device_type; /* 64-bit */
41 #else
42 
43 #define MAX_COMMAND_QUEUES 16
44 
45 /*
46  *
47  * function pointer typedefs
48  *
49  */
50 
51 /* Platform APIs */
52 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clGetPlatformIDs)(
53  cl_uint num_entries,
54  cl_platform_id * platforms,
55  cl_uint * num_platforms) CL_API_SUFFIX__VERSION_1_0;
56 
57 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clGetPlatformInfo)(
58  cl_platform_id platform,
59  cl_platform_info param_name,
60  size_t param_value_size,
61  void * param_value,
62  size_t * param_value_size_ret) CL_API_SUFFIX__VERSION_1_0;
63 
64 /* Device APIs */
65 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clGetDeviceIDs)(
66  cl_platform_id platform,
67  cl_device_type device_type,
68  cl_uint num_entries,
69  cl_device_id * devices,
70  cl_uint * num_devices) CL_API_SUFFIX__VERSION_1_0;
71 
72 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clGetDeviceInfo)(
73  cl_device_id device,
74  cl_device_info param_name,
75  size_t param_value_size,
76  void * param_value,
77  size_t * param_value_size_ret) CL_API_SUFFIX__VERSION_1_0;
78 
79 /* Context APIs */
80 typedef CL_API_ENTRY cl_context (CL_API_CALL *MAGICKpfn_clCreateContext)(
81  const cl_context_properties * properties,
82  cl_uint num_devices,
83  const cl_device_id * devices,
84  void (CL_CALLBACK *pfn_notify)(const char *, const void *, size_t, void *),
85  void * user_data,
86  cl_int * errcode_ret) CL_API_SUFFIX__VERSION_1_0;
87 
88 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clReleaseContext)(
89  cl_context context) CL_API_SUFFIX__VERSION_1_0;
90 
91 /* Command Queue APIs */
92 typedef CL_API_ENTRY cl_command_queue (CL_API_CALL *MAGICKpfn_clCreateCommandQueue)(
93  cl_context context,
94  cl_device_id device,
95  cl_command_queue_properties properties,
96  cl_int * errcode_ret) CL_API_SUFFIX__VERSION_1_0;
97 
98 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clReleaseCommandQueue)(
99  cl_command_queue command_queue) CL_API_SUFFIX__VERSION_1_0;
100 
101 /* Memory Object APIs */
102 typedef CL_API_ENTRY cl_mem (CL_API_CALL *MAGICKpfn_clCreateBuffer)(
103  cl_context context,
104  cl_mem_flags flags,
105  size_t size,
106  void * host_ptr,
107  cl_int * errcode_ret) CL_API_SUFFIX__VERSION_1_0;
108 
109 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clReleaseMemObject)(cl_mem memobj) CL_API_SUFFIX__VERSION_1_0;
110 
111 /* Program Object APIs */
112 typedef CL_API_ENTRY cl_program (CL_API_CALL *MAGICKpfn_clCreateProgramWithSource)(
113  cl_context context,
114  cl_uint count,
115  const char ** strings,
116  const size_t * lengths,
117  cl_int * errcode_ret) CL_API_SUFFIX__VERSION_1_0;
118 
119 typedef CL_API_ENTRY cl_program (CL_API_CALL *MAGICKpfn_clCreateProgramWithBinary)(
120  cl_context context,
121  cl_uint num_devices,
122  const cl_device_id * device_list,
123  const size_t * lengths,
124  const unsigned char ** binaries,
125  cl_int * binary_status,
126  cl_int * errcode_ret) CL_API_SUFFIX__VERSION_1_0;
127 
128 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clReleaseProgram)(cl_program program) CL_API_SUFFIX__VERSION_1_0;
129 
130 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clBuildProgram)(
131  cl_program program,
132  cl_uint num_devices,
133  const cl_device_id * device_list,
134  const char * options,
135  void (CL_CALLBACK *pfn_notify)(cl_program program, void * user_data),
136  void * user_data) CL_API_SUFFIX__VERSION_1_0;
137 
138 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clGetProgramInfo)(
139  cl_program program,
140  cl_program_info param_name,
141  size_t param_value_size,
142  void * param_value,
143  size_t * param_value_size_ret) CL_API_SUFFIX__VERSION_1_0;
144 
145 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clGetProgramBuildInfo)(
146  cl_program program,
147  cl_device_id device,
148  cl_program_build_info param_name,
149  size_t param_value_size,
150  void * param_value,
151  size_t * param_value_size_ret) CL_API_SUFFIX__VERSION_1_0;
152 
153 /* Kernel Object APIs */
154 typedef CL_API_ENTRY cl_kernel (CL_API_CALL *MAGICKpfn_clCreateKernel)(
155  cl_program program,
156  const char * kernel_name,
157  cl_int * errcode_ret) CL_API_SUFFIX__VERSION_1_0;
158 
159 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clReleaseKernel)(cl_kernel kernel) CL_API_SUFFIX__VERSION_1_0;
160 
161 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clSetKernelArg)(
162  cl_kernel kernel,
163  cl_uint arg_index,
164  size_t arg_size,
165  const void * arg_value) CL_API_SUFFIX__VERSION_1_0;
166 
167 typedef CL_API_ENTRY cl_int
168  (CL_API_CALL *MAGICKpfn_clFlush)(cl_command_queue command_queue)
169  CL_API_SUFFIX__VERSION_1_0;
170 
171 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clFinish)(cl_command_queue command_queue) CL_API_SUFFIX__VERSION_1_0;
172 
173 /* Enqueued Commands APIs */
174 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clEnqueueReadBuffer)(
175  cl_command_queue command_queue,
176  cl_mem buffer,
177  cl_bool blocking_read,
178  size_t offset,
179  size_t cb,
180  void * ptr,
181  cl_uint num_events_in_wait_list,
182  const cl_event * event_wait_list,
183  cl_event * event) CL_API_SUFFIX__VERSION_1_0;
184 
185 typedef CL_API_ENTRY void * (CL_API_CALL *MAGICKpfn_clEnqueueMapBuffer)(
186  cl_command_queue command_queue,
187  cl_mem buffer,
188  cl_bool blocking_map,
189  cl_map_flags map_flags,
190  size_t offset,
191  size_t cb,
192  cl_uint num_events_in_wait_list,
193  const cl_event * event_wait_list,
194  cl_event * event,
195  cl_int * errcode_ret) CL_API_SUFFIX__VERSION_1_0;
196 
197 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clEnqueueUnmapMemObject)(
198  cl_command_queue command_queue,
199  cl_mem memobj,
200  void * mapped_ptr,
201  cl_uint num_events_in_wait_list,
202  const cl_event * event_wait_list,
203  cl_event * event) CL_API_SUFFIX__VERSION_1_0;
204 
205 typedef CL_API_ENTRY cl_int (CL_API_CALL *MAGICKpfn_clEnqueueNDRangeKernel)(
206  cl_command_queue command_queue,
207  cl_kernel kernel,
208  cl_uint work_dim,
209  const size_t * global_work_offset,
210  const size_t * global_work_size,
211  const size_t * local_work_size,
212  cl_uint num_events_in_wait_list,
213  const cl_event * event_wait_list,
214  cl_event * event) CL_API_SUFFIX__VERSION_1_0;
215 
216 typedef CL_API_ENTRY cl_int(CL_API_CALL *MAGICKpfn_clGetEventProfilingInfo)(
217  cl_event event,
218  cl_profiling_info param_name,
219  size_t param_value_size,
220  void *param_value,
221  size_t *param_value_size_ret) CL_API_SUFFIX__VERSION_1_0;
222 
223 typedef CL_API_ENTRY cl_int(CL_API_CALL *MAGICKpfn_clWaitForEvents)(
224  cl_uint num_events,
225  const cl_event *event_list) CL_API_SUFFIX__VERSION_1_0;
226 
227 typedef CL_API_ENTRY cl_int(CL_API_CALL *MAGICKpfn_clReleaseEvent)(
228  cl_event event) CL_API_SUFFIX__VERSION_1_0;
229 
230 typedef CL_API_ENTRY cl_int(CL_API_CALL *MAGICKpfn_clRetainEvent)(
231  cl_event event) CL_API_SUFFIX__VERSION_1_0;
232 
233 typedef CL_API_ENTRY cl_int(CL_API_CALL *MAGICKpfn_clSetEventCallback)(
234  cl_event event,cl_int command_exec_callback_type,
235  void (CL_CALLBACK *MAGICKpfn_notify)(cl_event,cl_int,void *),
236  void *user_data) CL_API_SUFFIX__VERSION_1_1;
237 
238 /*
239  *
240  * vendor dispatch table structure
241  *
242  * note that the types in the structure KHRicdVendorDispatch mirror the function
243  * names listed in the string table khrIcdVendorDispatchFunctionNames
244  *
245  */
246 
247 typedef struct MagickLibraryRec MagickLibrary;
248 
249 struct MagickLibraryRec
250 {
251  void * base;
252 
253  MAGICKpfn_clGetPlatformIDs clGetPlatformIDs;
254  MAGICKpfn_clGetPlatformInfo clGetPlatformInfo;
255 
256  MAGICKpfn_clGetDeviceIDs clGetDeviceIDs;
257  MAGICKpfn_clGetDeviceInfo clGetDeviceInfo;
258 
259  MAGICKpfn_clCreateContext clCreateContext;
260  MAGICKpfn_clReleaseContext clReleaseContext;
261 
262  MAGICKpfn_clCreateCommandQueue clCreateCommandQueue;
263  MAGICKpfn_clReleaseCommandQueue clReleaseCommandQueue;
264  MAGICKpfn_clFlush clFlush;
265  MAGICKpfn_clFinish clFinish;
266 
267  MAGICKpfn_clCreateBuffer clCreateBuffer;
268  MAGICKpfn_clReleaseMemObject clReleaseMemObject;
269  MAGICKpfn_clCreateProgramWithSource clCreateProgramWithSource;
270  MAGICKpfn_clCreateProgramWithBinary clCreateProgramWithBinary;
271  MAGICKpfn_clReleaseProgram clReleaseProgram;
272  MAGICKpfn_clBuildProgram clBuildProgram;
273  MAGICKpfn_clGetProgramInfo clGetProgramInfo;
274  MAGICKpfn_clGetProgramBuildInfo clGetProgramBuildInfo;
275 
276  MAGICKpfn_clCreateKernel clCreateKernel;
277  MAGICKpfn_clReleaseKernel clReleaseKernel;
278  MAGICKpfn_clSetKernelArg clSetKernelArg;
279 
280  MAGICKpfn_clEnqueueReadBuffer clEnqueueReadBuffer;
281  MAGICKpfn_clEnqueueMapBuffer clEnqueueMapBuffer;
282  MAGICKpfn_clEnqueueUnmapMemObject clEnqueueUnmapMemObject;
283  MAGICKpfn_clEnqueueNDRangeKernel clEnqueueNDRangeKernel;
284 
285  MAGICKpfn_clGetEventProfilingInfo clGetEventProfilingInfo;
286 
287  MAGICKpfn_clWaitForEvents clWaitForEvents;
288  MAGICKpfn_clReleaseEvent clReleaseEvent;
289  MAGICKpfn_clRetainEvent clRetainEvent;
290  MAGICKpfn_clSetEventCallback clSetEventCallback;
291 };
292 
293 struct _MagickCLEnv {
294  MagickBooleanType OpenCLInitialized; /* whether OpenCL environment is initialized. */
295  MagickBooleanType OpenCLDisabled; /* whether if OpenCL has been explicitely disabled. */
296 
297  MagickLibrary * library;
298 
299  /*OpenCL objects */
300  cl_platform_id platform;
301  cl_device_type deviceType;
302  cl_device_id device;
303  cl_context context;
304 
305  MagickBooleanType disableProgramCache; /* disable the OpenCL program cache */
306  cl_program programs[MAGICK_OPENCL_NUM_PROGRAMS]; /* one program object maps one kernel source file */
307 
308  MagickBooleanType regenerateProfile; /* re-run the microbenchmark in auto device selection mode */
309 
310  SemaphoreInfo* lock;
311 
312  cl_command_queue commandQueues[MAX_COMMAND_QUEUES];
313  ssize_t commandQueuesPos;
314  SemaphoreInfo* commandQueuesLock;
315 };
316 
317 #endif
318 
319 #if defined(MAGICKCORE_HDRI_SUPPORT)
320 #define CLOptions "-cl-single-precision-constant -cl-mad-enable -DMAGICKCORE_HDRI_SUPPORT=1 "\
321  "-DCLQuantum=float -DCLSignedQuantum=float -DCLPixelType=float4 -DQuantumRange=%f " \
322  "-DQuantumScale=%f -DCharQuantumScale=%f -DMagickEpsilon=%f -DMagickPI=%f "\
323  " -DMaxMap=%u -DMAGICKCORE_QUANTUM_DEPTH=%u"
324 #define CLPixelPacket cl_float4
325 #define CLCharQuantumScale 1.0f
326 #elif (MAGICKCORE_QUANTUM_DEPTH == 8)
327 #define CLOptions "-cl-single-precision-constant -cl-mad-enable " \
328  "-DCLQuantum=uchar -DCLSignedQuantum=char -DCLPixelType=uchar4 -DQuantumRange=%ff " \
329  "-DQuantumScale=%ff -DCharQuantumScale=%ff -DMagickEpsilon=%ff -DMagickPI=%ff "\
330  "-DMaxMap=%u -DMAGICKCORE_QUANTUM_DEPTH=%u"
331 #define CLPixelPacket cl_uchar4
332 #define CLCharQuantumScale 1.0f
333 #elif (MAGICKCORE_QUANTUM_DEPTH == 16)
334 #define CLOptions "-cl-single-precision-constant -cl-mad-enable " \
335  "-DCLQuantum=ushort -DCLSignedQuantum=short -DCLPixelType=ushort4 -DQuantumRange=%f "\
336  "-DQuantumScale=%f -DCharQuantumScale=%f -DMagickEpsilon=%f -DMagickPI=%f "\
337  "-DMaxMap=%u -DMAGICKCORE_QUANTUM_DEPTH=%u"
338 #define CLPixelPacket cl_ushort4
339 #define CLCharQuantumScale 257.0f
340 #elif (MAGICKCORE_QUANTUM_DEPTH == 32)
341 #define CLOptions "-cl-single-precision-constant -cl-mad-enable " \
342  "-DCLQuantum=uint -DCLSignedQuantum=int -DCLPixelType=uint4 -DQuantumRange=%f "\
343  "-DQuantumScale=%f -DCharQuantumScale=%f -DMagickEpsilon=%f -DMagickPI=%f "\
344  "-DMaxMap=%u -DMAGICKCORE_QUANTUM_DEPTH=%u"
345 #define CLPixelPacket cl_uint4
346 #define CLCharQuantumScale 16843009.0f
347 #elif (MAGICKCORE_QUANTUM_DEPTH == 64)
348 #define CLOptions "-cl-single-precision-constant -cl-mad-enable " \
349  "-DCLQuantum=ulong -DCLSignedQuantum=long -DCLPixelType=ulong4 -DQuantumRange=%f "\
350  "-DQuantumScale=%f -DCharQuantumScale=%f -DMagickEpsilon=%f -DMagickPI=%f "\
351  "-DMaxMap=%u -DMAGICKCORE_QUANTUM_DEPTH=%u"
352 #define CLPixelPacket cl_ulong4
353 #define CLCharQuantumScale 72340172838076673.0f
354 #endif
355 
356 typedef enum {
383 
384 extern MagickPrivate cl_context
386 
387 extern MagickPrivate cl_kernel
389 
390 extern MagickPrivate cl_command_queue
392 
395  const char *,const char *,const size_t,
396  const ExceptionType,const char *,const char *,...),
397  RecordProfileData(MagickCLEnv,ProfiledKernels,cl_event),
398  RelinquishOpenCLCommandQueue(MagickCLEnv, cl_command_queue),
400 
401 extern MagickPrivate unsigned long
404 
405 extern MagickPrivate const char*
407 
408 extern MagickPrivate void
409  OpenCLLog(const char*);
410 
411 extern MagickPrivate void
412  OpenCLTerminus();
413 
414 /* #define OPENCLLOG_ENABLED 1 */
415 static inline void OpenCLLogException(const char* function,
416  const unsigned int line,
417  ExceptionInfo* exception) {
418 #ifdef OPENCLLOG_ENABLED
419  if (exception->severity!=0) {
420  char message[MaxTextExtent];
421  /* dump the source into a file */
422  (void) FormatLocaleString(message,MaxTextExtent,"%s:%d Exception(%d):%s "
423  ,function,line,exception->severity,exception->reason);
424  OpenCLLog(message);
425  }
426 #else
427  magick_unreferenced(function);
428  magick_unreferenced(line);
429  magick_unreferenced(exception);
430 #endif
431 }
432 
433 
434 #if defined(__cplusplus) || defined(c_plusplus)
435 }
436 #endif
437 
438 #endif
Definition: opencl-private.h:380
Definition: opencl-private.h:370
MagickPrivate cl_command_queue AcquireOpenCLCommandQueue(MagickCLEnv)
void * cl_event
Definition: opencl-private.h:35
Definition: opencl.h:29
Definition: exception.h:102
Definition: opencl-private.h:369
Definition: opencl-private.h:381
MagickPrivate MagickBooleanType RelinquishOpenCLCommandQueue(MagickCLEnv, cl_command_queue)
void * cl_command_queue
Definition: opencl-private.h:33
MagickPrivate unsigned long GetOpenCLDeviceMaxMemAllocSize(MagickCLEnv)
MagickExport ssize_t FormatLocaleString(char *magick_restrict string, const size_t length, const char *magick_restrict format,...)
Definition: locale.c:470
Definition: opencl-private.h:364
void(MagickDLLCall *delete_instance)(gs_main_instance *)
Definition: opencl-private.h:359
void * cl_device_id
Definition: opencl-private.h:34
MagickPrivate unsigned long GetOpenCLDeviceLocalMemorySize(MagickCLEnv)
Definition: opencl-private.h:372
ExceptionType
Definition: exception.h:28
Definition: opencl-private.h:375
void * cl_platform_id
Definition: opencl-private.h:38
MagickPrivate void OpenCLTerminus()
Definition: opencl.c:3128
Definition: opencl-private.h:368
MagickBooleanType
Definition: magick-type.h:211
Definition: opencl-private.h:377
void * cl_kernel
Definition: opencl-private.h:36
char * reason
Definition: exception.h:111
void * cl_uint
Definition: opencl-private.h:39
Definition: opencl-private.h:358
MagickPrivate const char * GetOpenCLCachedFilesDirectory()
Definition: opencl.c:2965
void * cl_context
Definition: opencl-private.h:32
#define MaxTextExtent
Definition: method-attribute.h:106
Definition: opencl-private.h:360
Definition: opencl-private.h:379
MagickOpenCLProgram
Definition: opencl.h:27
MagickPrivate cl_kernel AcquireOpenCLKernel(MagickCLEnv, MagickOpenCLProgram, const char *)
MagickPrivate void OpenCLLog(const char *)
Definition: opencl.c:3088
MagickPrivate MagickBooleanType OpenCLThrowMagickException(ExceptionInfo *, const char *, const char *, const size_t, const ExceptionType, const char *, const char *,...)
Definition: opencl-private.h:365
MagickPrivate cl_context GetOpenCLContext(MagickCLEnv)
Definition: opencl-private.h:361
Definition: opencl-private.h:376
void * cl_mem
Definition: opencl-private.h:37
Definition: opencl-private.h:40
Definition: opencl-private.h:373
Definition: opencl-private.h:363
#define magick_unreferenced(x)
Definition: method-attribute.h:123
ProfiledKernels
Definition: opencl-private.h:356
Definition: opencl-private.h:357
#define MagickPrivate
Definition: method-attribute.h:99
Definition: opencl-private.h:371
static void OpenCLLogException(const char *function, const unsigned int line, ExceptionInfo *exception)
Definition: opencl-private.h:415
Definition: opencl-private.h:367
MagickPrivate MagickBooleanType RecordProfileData(MagickCLEnv, ProfiledKernels, cl_event)
Definition: opencl-private.h:366
Definition: opencl-private.h:374
Definition: semaphore.c:58
Definition: opencl-private.h:378
Definition: opencl-private.h:362
Definition: opencl.c:2816
MagickPrivate MagickBooleanType RelinquishOpenCLKernel(MagickCLEnv, cl_kernel)
ExceptionType severity
Definition: exception.h:105