clang  15.0.0git
opencl-c-base.h
Go to the documentation of this file.
1 //===----- opencl-c-base.h - OpenCL C language base definitions -----------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef _OPENCL_BASE_H_
10 #define _OPENCL_BASE_H_
11 
12 // Define extension macros
13 
14 #if (defined(__OPENCL_CPP_VERSION__) || __OPENCL_C_VERSION__ >= 200)
15 // For SPIR and SPIR-V all extensions are supported.
16 #if defined(__SPIR__) || defined(__SPIRV__)
17 #define cl_khr_subgroup_extended_types 1
18 #define cl_khr_subgroup_non_uniform_vote 1
19 #define cl_khr_subgroup_ballot 1
20 #define cl_khr_subgroup_non_uniform_arithmetic 1
21 #define cl_khr_subgroup_shuffle 1
22 #define cl_khr_subgroup_shuffle_relative 1
23 #define cl_khr_subgroup_clustered_reduce 1
24 #define cl_khr_subgroup_rotate 1
25 #define cl_khr_extended_bit_ops 1
26 #define cl_khr_integer_dot_product 1
27 #define __opencl_c_integer_dot_product_input_4x8bit 1
28 #define __opencl_c_integer_dot_product_input_4x8bit_packed 1
29 #define cl_ext_float_atomics 1
30 #ifdef cl_khr_fp16
31 #define __opencl_c_ext_fp16_global_atomic_load_store 1
32 #define __opencl_c_ext_fp16_local_atomic_load_store 1
33 #define __opencl_c_ext_fp16_global_atomic_add 1
34 #define __opencl_c_ext_fp16_local_atomic_add 1
35 #define __opencl_c_ext_fp16_global_atomic_min_max 1
36 #define __opencl_c_ext_fp16_local_atomic_min_max 1
37 #endif
38 #ifdef cl_khr_fp64
39 #define __opencl_c_ext_fp64_global_atomic_add 1
40 #define __opencl_c_ext_fp64_local_atomic_add 1
41 #define __opencl_c_ext_fp64_global_atomic_min_max 1
42 #define __opencl_c_ext_fp64_local_atomic_min_max 1
43 #endif
44 #define __opencl_c_ext_fp32_global_atomic_add 1
45 #define __opencl_c_ext_fp32_local_atomic_add 1
46 #define __opencl_c_ext_fp32_global_atomic_min_max 1
47 #define __opencl_c_ext_fp32_local_atomic_min_max 1
48 
49 #endif // defined(__SPIR__) || defined(__SPIRV__)
50 #endif // (defined(__OPENCL_CPP_VERSION__) || __OPENCL_C_VERSION__ >= 200)
51 
52 // Define feature macros for OpenCL C 2.0
53 #if (__OPENCL_CPP_VERSION__ == 100 || __OPENCL_C_VERSION__ == 200)
54 #define __opencl_c_pipes 1
55 #define __opencl_c_generic_address_space 1
56 #define __opencl_c_work_group_collective_functions 1
57 #define __opencl_c_atomic_order_acq_rel 1
58 #define __opencl_c_atomic_order_seq_cst 1
59 #define __opencl_c_atomic_scope_device 1
60 #define __opencl_c_atomic_scope_all_devices 1
61 #define __opencl_c_device_enqueue 1
62 #define __opencl_c_read_write_images 1
63 #define __opencl_c_program_scope_global_variables 1
64 #define __opencl_c_images 1
65 #endif
66 
67 // Define header-only feature macros for OpenCL C 3.0.
68 #if (__OPENCL_CPP_VERSION__ == 202100 || __OPENCL_C_VERSION__ == 300)
69 // For the SPIR and SPIR-V target all features are supported.
70 #if defined(__SPIR__) || defined(__SPIRV__)
71 #define __opencl_c_atomic_order_seq_cst 1
72 #define __opencl_c_atomic_scope_device 1
73 #define __opencl_c_atomic_scope_all_devices 1
74 #define __opencl_c_read_write_images 1
75 #endif // defined(__SPIR__)
76 #endif // (__OPENCL_CPP_VERSION__ == 202100 || __OPENCL_C_VERSION__ == 300)
77 
78 #if !defined(__opencl_c_generic_address_space)
79 // Internal feature macro to provide named (global, local, private) address
80 // space overloads for builtin functions that take a pointer argument.
81 #define __opencl_c_named_address_space_builtins 1
82 #endif // !defined(__opencl_c_generic_address_space)
83 
84 #if defined(cl_intel_subgroups) || defined(cl_khr_subgroups) || defined(__opencl_c_subgroups)
85 // Internal feature macro to provide subgroup builtins.
86 #define __opencl_subgroup_builtins 1
87 #endif
88 
89 // built-in scalar data types:
90 
91 /**
92  * An unsigned 8-bit integer.
93  */
94 typedef unsigned char uchar;
95 
96 /**
97  * An unsigned 16-bit integer.
98  */
99 typedef unsigned short ushort;
100 
101 /**
102  * An unsigned 32-bit integer.
103  */
104 typedef unsigned int uint;
105 
106 /**
107  * An unsigned 64-bit integer.
108  */
109 typedef unsigned long ulong;
110 
111 /**
112  * The unsigned integer type of the result of the sizeof operator. This
113  * is a 32-bit unsigned integer if CL_DEVICE_ADDRESS_BITS
114  * defined in table 4.3 is 32-bits and is a 64-bit unsigned integer if
115  * CL_DEVICE_ADDRESS_BITS is 64-bits.
116  */
117 typedef __SIZE_TYPE__ size_t;
118 
119 /**
120  * A signed integer type that is the result of subtracting two pointers.
121  * This is a 32-bit signed integer if CL_DEVICE_ADDRESS_BITS
122  * defined in table 4.3 is 32-bits and is a 64-bit signed integer if
123  * CL_DEVICE_ADDRESS_BITS is 64-bits.
124  */
125 typedef __PTRDIFF_TYPE__ ptrdiff_t;
126 
127 /**
128  * A signed integer type with the property that any valid pointer to
129  * void can be converted to this type, then converted back to pointer
130  * to void, and the result will compare equal to the original pointer.
131  */
132 typedef __INTPTR_TYPE__ intptr_t;
133 
134 /**
135  * An unsigned integer type with the property that any valid pointer to
136  * void can be converted to this type, then converted back to pointer
137  * to void, and the result will compare equal to the original pointer.
138  */
139 typedef __UINTPTR_TYPE__ uintptr_t;
140 
141 // built-in vector data types:
142 typedef char char2 __attribute__((ext_vector_type(2)));
143 typedef char char3 __attribute__((ext_vector_type(3)));
144 typedef char char4 __attribute__((ext_vector_type(4)));
145 typedef char char8 __attribute__((ext_vector_type(8)));
146 typedef char char16 __attribute__((ext_vector_type(16)));
147 typedef uchar uchar2 __attribute__((ext_vector_type(2)));
148 typedef uchar uchar3 __attribute__((ext_vector_type(3)));
149 typedef uchar uchar4 __attribute__((ext_vector_type(4)));
150 typedef uchar uchar8 __attribute__((ext_vector_type(8)));
151 typedef uchar uchar16 __attribute__((ext_vector_type(16)));
152 typedef short short2 __attribute__((ext_vector_type(2)));
153 typedef short short3 __attribute__((ext_vector_type(3)));
154 typedef short short4 __attribute__((ext_vector_type(4)));
155 typedef short short8 __attribute__((ext_vector_type(8)));
156 typedef short short16 __attribute__((ext_vector_type(16)));
157 typedef ushort ushort2 __attribute__((ext_vector_type(2)));
158 typedef ushort ushort3 __attribute__((ext_vector_type(3)));
159 typedef ushort ushort4 __attribute__((ext_vector_type(4)));
160 typedef ushort ushort8 __attribute__((ext_vector_type(8)));
161 typedef ushort ushort16 __attribute__((ext_vector_type(16)));
162 typedef int int2 __attribute__((ext_vector_type(2)));
163 typedef int int3 __attribute__((ext_vector_type(3)));
164 typedef int int4 __attribute__((ext_vector_type(4)));
165 typedef int int8 __attribute__((ext_vector_type(8)));
166 typedef int int16 __attribute__((ext_vector_type(16)));
167 typedef uint uint2 __attribute__((ext_vector_type(2)));
168 typedef uint uint3 __attribute__((ext_vector_type(3)));
169 typedef uint uint4 __attribute__((ext_vector_type(4)));
170 typedef uint uint8 __attribute__((ext_vector_type(8)));
171 typedef uint uint16 __attribute__((ext_vector_type(16)));
172 typedef long long2 __attribute__((ext_vector_type(2)));
173 typedef long long3 __attribute__((ext_vector_type(3)));
174 typedef long long4 __attribute__((ext_vector_type(4)));
175 typedef long long8 __attribute__((ext_vector_type(8)));
176 typedef long long16 __attribute__((ext_vector_type(16)));
177 typedef ulong ulong2 __attribute__((ext_vector_type(2)));
178 typedef ulong ulong3 __attribute__((ext_vector_type(3)));
179 typedef ulong ulong4 __attribute__((ext_vector_type(4)));
180 typedef ulong ulong8 __attribute__((ext_vector_type(8)));
181 typedef ulong ulong16 __attribute__((ext_vector_type(16)));
182 typedef float float2 __attribute__((ext_vector_type(2)));
183 typedef float float3 __attribute__((ext_vector_type(3)));
184 typedef float float4 __attribute__((ext_vector_type(4)));
185 typedef float float8 __attribute__((ext_vector_type(8)));
186 typedef float float16 __attribute__((ext_vector_type(16)));
187 #ifdef cl_khr_fp16
188 #pragma OPENCL EXTENSION cl_khr_fp16 : enable
189 typedef half half2 __attribute__((ext_vector_type(2)));
190 typedef half half3 __attribute__((ext_vector_type(3)));
191 typedef half half4 __attribute__((ext_vector_type(4)));
192 typedef half half8 __attribute__((ext_vector_type(8)));
193 typedef half half16 __attribute__((ext_vector_type(16)));
194 #endif
195 #ifdef cl_khr_fp64
196 #if __OPENCL_C_VERSION__ < CL_VERSION_1_2
197 #pragma OPENCL EXTENSION cl_khr_fp64 : enable
198 #endif
199 typedef double double2 __attribute__((ext_vector_type(2)));
200 typedef double double3 __attribute__((ext_vector_type(3)));
201 typedef double double4 __attribute__((ext_vector_type(4)));
202 typedef double double8 __attribute__((ext_vector_type(8)));
203 typedef double double16 __attribute__((ext_vector_type(16)));
204 #endif
205 
206 // An internal alias for half, for use by OpenCLBuiltins.td.
207 #define __half half
208 
209 #if defined(__OPENCL_CPP_VERSION__)
210 #define NULL nullptr
211 #elif defined(__OPENCL_C_VERSION__)
212 #define NULL ((void*)0)
213 #endif
214 
215 /**
216  * Value of maximum non-infinite single-precision floating-point
217  * number.
218  */
219 #define MAXFLOAT 0x1.fffffep127f
220 
221 /**
222  * A positive float constant expression. HUGE_VALF evaluates
223  * to +infinity. Used as an error value returned by the built-in
224  * math functions.
225  */
226 #define HUGE_VALF (__builtin_huge_valf())
227 
228 /**
229  * A positive double constant expression. HUGE_VAL evaluates
230  * to +infinity. Used as an error value returned by the built-in
231  * math functions.
232  */
233 #define HUGE_VAL (__builtin_huge_val())
234 
235 /**
236  * A constant expression of type float representing positive or
237  * unsigned infinity.
238  */
239 #define INFINITY (__builtin_inff())
240 
241 /**
242  * A constant expression of type float representing a quiet NaN.
243  */
244 #define NAN as_float(INT_MAX)
245 
246 #define FP_ILOGB0 INT_MIN
247 #define FP_ILOGBNAN INT_MAX
248 
249 #define FLT_DIG 6
250 #define FLT_MANT_DIG 24
251 #define FLT_MAX_10_EXP +38
252 #define FLT_MAX_EXP +128
253 #define FLT_MIN_10_EXP -37
254 #define FLT_MIN_EXP -125
255 #define FLT_RADIX 2
256 #define FLT_MAX 0x1.fffffep127f
257 #define FLT_MIN 0x1.0p-126f
258 #define FLT_EPSILON 0x1.0p-23f
259 
260 #define M_E_F 2.71828182845904523536028747135266250f
261 #define M_LOG2E_F 1.44269504088896340735992468100189214f
262 #define M_LOG10E_F 0.434294481903251827651128918916605082f
263 #define M_LN2_F 0.693147180559945309417232121458176568f
264 #define M_LN10_F 2.30258509299404568401799145468436421f
265 #define M_PI_F 3.14159265358979323846264338327950288f
266 #define M_PI_2_F 1.57079632679489661923132169163975144f
267 #define M_PI_4_F 0.785398163397448309615660845819875721f
268 #define M_1_PI_F 0.318309886183790671537767526745028724f
269 #define M_2_PI_F 0.636619772367581343075535053490057448f
270 #define M_2_SQRTPI_F 1.12837916709551257389615890312154517f
271 #define M_SQRT2_F 1.41421356237309504880168872420969808f
272 #define M_SQRT1_2_F 0.707106781186547524400844362104849039f
273 
274 #define DBL_DIG 15
275 #define DBL_MANT_DIG 53
276 #define DBL_MAX_10_EXP +308
277 #define DBL_MAX_EXP +1024
278 #define DBL_MIN_10_EXP -307
279 #define DBL_MIN_EXP -1021
280 #define DBL_RADIX 2
281 #define DBL_MAX 0x1.fffffffffffffp1023
282 #define DBL_MIN 0x1.0p-1022
283 #define DBL_EPSILON 0x1.0p-52
284 
285 #define M_E 0x1.5bf0a8b145769p+1
286 #define M_LOG2E 0x1.71547652b82fep+0
287 #define M_LOG10E 0x1.bcb7b1526e50ep-2
288 #define M_LN2 0x1.62e42fefa39efp-1
289 #define M_LN10 0x1.26bb1bbb55516p+1
290 #define M_PI 0x1.921fb54442d18p+1
291 #define M_PI_2 0x1.921fb54442d18p+0
292 #define M_PI_4 0x1.921fb54442d18p-1
293 #define M_1_PI 0x1.45f306dc9c883p-2
294 #define M_2_PI 0x1.45f306dc9c883p-1
295 #define M_2_SQRTPI 0x1.20dd750429b6dp+0
296 #define M_SQRT2 0x1.6a09e667f3bcdp+0
297 #define M_SQRT1_2 0x1.6a09e667f3bcdp-1
298 
299 #ifdef cl_khr_fp16
300 
301 #define HALF_DIG 3
302 #define HALF_MANT_DIG 11
303 #define HALF_MAX_10_EXP +4
304 #define HALF_MAX_EXP +16
305 #define HALF_MIN_10_EXP -4
306 #define HALF_MIN_EXP -13
307 #define HALF_RADIX 2
308 #define HALF_MAX ((0x1.ffcp15h))
309 #define HALF_MIN ((0x1.0p-14h))
310 #define HALF_EPSILON ((0x1.0p-10h))
311 
312 #define M_E_H 2.71828182845904523536028747135266250h
313 #define M_LOG2E_H 1.44269504088896340735992468100189214h
314 #define M_LOG10E_H 0.434294481903251827651128918916605082h
315 #define M_LN2_H 0.693147180559945309417232121458176568h
316 #define M_LN10_H 2.30258509299404568401799145468436421h
317 #define M_PI_H 3.14159265358979323846264338327950288h
318 #define M_PI_2_H 1.57079632679489661923132169163975144h
319 #define M_PI_4_H 0.785398163397448309615660845819875721h
320 #define M_1_PI_H 0.318309886183790671537767526745028724h
321 #define M_2_PI_H 0.636619772367581343075535053490057448h
322 #define M_2_SQRTPI_H 1.12837916709551257389615890312154517h
323 #define M_SQRT2_H 1.41421356237309504880168872420969808h
324 #define M_SQRT1_2_H 0.707106781186547524400844362104849039h
325 
326 #endif //cl_khr_fp16
327 
328 #define CHAR_BIT 8
329 #define SCHAR_MAX 127
330 #define SCHAR_MIN (-128)
331 #define UCHAR_MAX 255
332 #define CHAR_MAX SCHAR_MAX
333 #define CHAR_MIN SCHAR_MIN
334 #define USHRT_MAX 65535
335 #define SHRT_MAX 32767
336 #define SHRT_MIN (-32768)
337 #define UINT_MAX 0xffffffff
338 #define INT_MAX 2147483647
339 #define INT_MIN (-2147483647-1)
340 #define ULONG_MAX 0xffffffffffffffffUL
341 #define LONG_MAX 0x7fffffffffffffffL
342 #define LONG_MIN (-0x7fffffffffffffffL-1)
343 
344 // OpenCL v1.1 s6.11.8, v1.2 s6.12.8, v2.0 s6.13.8 - Synchronization Functions
345 
346 // Flag type and values for barrier, mem_fence, read_mem_fence, write_mem_fence
348 
349 /**
350  * Queue a memory fence to ensure correct
351  * ordering of memory operations to local memory
352  */
353 #define CLK_LOCAL_MEM_FENCE 0x01
354 
355 /**
356  * Queue a memory fence to ensure correct
357  * ordering of memory operations to global memory
358  */
359 #define CLK_GLOBAL_MEM_FENCE 0x02
360 
361 #if defined(__OPENCL_CPP_VERSION__) || (__OPENCL_C_VERSION__ >= CL_VERSION_2_0)
362 
363 typedef enum memory_scope {
364  memory_scope_work_item = __OPENCL_MEMORY_SCOPE_WORK_ITEM,
365  memory_scope_work_group = __OPENCL_MEMORY_SCOPE_WORK_GROUP,
366  memory_scope_device = __OPENCL_MEMORY_SCOPE_DEVICE,
367 #if defined(__opencl_c_atomic_scope_all_devices)
368  memory_scope_all_svm_devices = __OPENCL_MEMORY_SCOPE_ALL_SVM_DEVICES,
369 #if (__OPENCL_C_VERSION__ >= CL_VERSION_3_0 || __OPENCL_CPP_VERSION__ >= 202100)
370  memory_scope_all_devices = memory_scope_all_svm_devices,
371 #endif // (__OPENCL_C_VERSION__ >= CL_VERSION_3_0 || __OPENCL_CPP_VERSION__ >= 202100)
372 #endif // defined(__opencl_c_atomic_scope_all_devices)
373 /**
374  * Subgroups have different requirements on forward progress, so just test
375  * all the relevant macros.
376  * CL 3.0 sub-groups "they are not guaranteed to make independent forward progress"
377  * KHR subgroups "Subgroups within a workgroup are independent, make forward progress with respect to each other"
378  */
379 #if defined(cl_intel_subgroups) || defined(cl_khr_subgroups) || defined(__opencl_c_subgroups)
380  memory_scope_sub_group = __OPENCL_MEMORY_SCOPE_SUB_GROUP
381 #endif
382 } memory_scope;
383 
384 /**
385  * Queue a memory fence to ensure correct ordering of memory
386  * operations between work-items of a work-group to
387  * image memory.
388  */
389 #define CLK_IMAGE_MEM_FENCE 0x04
390 
391 #ifndef ATOMIC_VAR_INIT
392 #define ATOMIC_VAR_INIT(x) (x)
393 #endif //ATOMIC_VAR_INIT
394 #define ATOMIC_FLAG_INIT 0
395 
396 // enum values aligned with what clang uses in EmitAtomicExpr()
397 typedef enum memory_order
398 {
399  memory_order_relaxed = __ATOMIC_RELAXED,
400  memory_order_acquire = __ATOMIC_ACQUIRE,
401  memory_order_release = __ATOMIC_RELEASE,
402  memory_order_acq_rel = __ATOMIC_ACQ_REL,
403 #if defined(__opencl_c_atomic_order_seq_cst)
404  memory_order_seq_cst = __ATOMIC_SEQ_CST
405 #endif
406 } memory_order;
407 
408 #endif // defined(__OPENCL_CPP_VERSION__) || (__OPENCL_C_VERSION__ >= CL_VERSION_2_0)
409 
410 // OpenCL v1.1 s6.11.3, v1.2 s6.12.14, v2.0 s6.13.14 - Image Read and Write Functions
411 
412 // These values need to match the runtime equivalent
413 //
414 // Addressing Mode.
415 //
416 #define CLK_ADDRESS_NONE 0
417 #define CLK_ADDRESS_CLAMP_TO_EDGE 2
418 #define CLK_ADDRESS_CLAMP 4
419 #define CLK_ADDRESS_REPEAT 6
420 #define CLK_ADDRESS_MIRRORED_REPEAT 8
421 
422 //
423 // Coordination Normalization
424 //
425 #define CLK_NORMALIZED_COORDS_FALSE 0
426 #define CLK_NORMALIZED_COORDS_TRUE 1
427 
428 //
429 // Filtering Mode.
430 //
431 #define CLK_FILTER_NEAREST 0x10
432 #define CLK_FILTER_LINEAR 0x20
433 
434 #ifdef cl_khr_gl_msaa_sharing
435 #pragma OPENCL EXTENSION cl_khr_gl_msaa_sharing : enable
436 #endif //cl_khr_gl_msaa_sharing
437 
438 //
439 // Channel Datatype.
440 //
441 #define CLK_SNORM_INT8 0x10D0
442 #define CLK_SNORM_INT16 0x10D1
443 #define CLK_UNORM_INT8 0x10D2
444 #define CLK_UNORM_INT16 0x10D3
445 #define CLK_UNORM_SHORT_565 0x10D4
446 #define CLK_UNORM_SHORT_555 0x10D5
447 #define CLK_UNORM_INT_101010 0x10D6
448 #define CLK_SIGNED_INT8 0x10D7
449 #define CLK_SIGNED_INT16 0x10D8
450 #define CLK_SIGNED_INT32 0x10D9
451 #define CLK_UNSIGNED_INT8 0x10DA
452 #define CLK_UNSIGNED_INT16 0x10DB
453 #define CLK_UNSIGNED_INT32 0x10DC
454 #define CLK_HALF_FLOAT 0x10DD
455 #define CLK_FLOAT 0x10DE
456 #define CLK_UNORM_INT24 0x10DF
457 
458 // Channel order, numbering must be aligned with cl_channel_order in cl.h
459 //
460 #define CLK_R 0x10B0
461 #define CLK_A 0x10B1
462 #define CLK_RG 0x10B2
463 #define CLK_RA 0x10B3
464 #define CLK_RGB 0x10B4
465 #define CLK_RGBA 0x10B5
466 #define CLK_BGRA 0x10B6
467 #define CLK_ARGB 0x10B7
468 #define CLK_INTENSITY 0x10B8
469 #define CLK_LUMINANCE 0x10B9
470 #define CLK_Rx 0x10BA
471 #define CLK_RGx 0x10BB
472 #define CLK_RGBx 0x10BC
473 #define CLK_DEPTH 0x10BD
474 #define CLK_DEPTH_STENCIL 0x10BE
475 #if __OPENCL_C_VERSION__ >= CL_VERSION_2_0
476 #define CLK_sRGB 0x10BF
477 #define CLK_sRGBx 0x10C0
478 #define CLK_sRGBA 0x10C1
479 #define CLK_sBGRA 0x10C2
480 #define CLK_ABGR 0x10C3
481 #endif //__OPENCL_C_VERSION__ >= CL_VERSION_2_0
482 
483 // OpenCL v2.0 s6.13.16 - Pipe Functions
484 #if defined(__OPENCL_CPP_VERSION__) || (__OPENCL_C_VERSION__ >= CL_VERSION_2_0)
485 #define CLK_NULL_RESERVE_ID (__builtin_astype(((void*)(__SIZE_MAX__)), reserve_id_t))
486 
487 // OpenCL v2.0 s6.13.17 - Enqueue Kernels
488 #define CL_COMPLETE 0x0
489 #define CL_RUNNING 0x1
490 #define CL_SUBMITTED 0x2
491 #define CL_QUEUED 0x3
492 
493 #define CLK_SUCCESS 0
494 #define CLK_ENQUEUE_FAILURE -101
495 #define CLK_INVALID_QUEUE -102
496 #define CLK_INVALID_NDRANGE -160
497 #define CLK_INVALID_EVENT_WAIT_LIST -57
498 #define CLK_DEVICE_QUEUE_FULL -161
499 #define CLK_INVALID_ARG_SIZE -51
500 #define CLK_EVENT_ALLOCATION_FAILURE -100
501 #define CLK_OUT_OF_RESOURCES -5
502 
503 #define CLK_NULL_QUEUE 0
504 #define CLK_NULL_EVENT (__builtin_astype(((__SIZE_MAX__)), clk_event_t))
505 
506 // execution model related definitions
507 #define CLK_ENQUEUE_FLAGS_NO_WAIT 0x0
508 #define CLK_ENQUEUE_FLAGS_WAIT_KERNEL 0x1
509 #define CLK_ENQUEUE_FLAGS_WAIT_WORK_GROUP 0x2
510 
512 typedef int clk_profiling_info;
513 
514 // Profiling info name (see capture_event_profiling_info)
515 #define CLK_PROFILING_COMMAND_EXEC_TIME 0x1
516 
517 #define MAX_WORK_DIM 3
518 
519 #ifdef __opencl_c_device_enqueue
520 typedef struct {
521  unsigned int workDimension;
522  size_t globalWorkOffset[MAX_WORK_DIM];
523  size_t globalWorkSize[MAX_WORK_DIM];
524  size_t localWorkSize[MAX_WORK_DIM];
525 } ndrange_t;
526 #endif // __opencl_c_device_enqueue
527 
528 #endif // defined(__OPENCL_CPP_VERSION__) || (__OPENCL_C_VERSION__ >= CL_VERSION_2_0)
529 
530 /**
531  * OpenCL v1.1/1.2/2.0 s6.2.4.2 - as_type operators
532  * Reinterprets a data type as another data type of the same size
533  */
534 #define as_char(x) __builtin_astype((x), char)
535 #define as_char2(x) __builtin_astype((x), char2)
536 #define as_char3(x) __builtin_astype((x), char3)
537 #define as_char4(x) __builtin_astype((x), char4)
538 #define as_char8(x) __builtin_astype((x), char8)
539 #define as_char16(x) __builtin_astype((x), char16)
540 
541 #define as_uchar(x) __builtin_astype((x), uchar)
542 #define as_uchar2(x) __builtin_astype((x), uchar2)
543 #define as_uchar3(x) __builtin_astype((x), uchar3)
544 #define as_uchar4(x) __builtin_astype((x), uchar4)
545 #define as_uchar8(x) __builtin_astype((x), uchar8)
546 #define as_uchar16(x) __builtin_astype((x), uchar16)
547 
548 #define as_short(x) __builtin_astype((x), short)
549 #define as_short2(x) __builtin_astype((x), short2)
550 #define as_short3(x) __builtin_astype((x), short3)
551 #define as_short4(x) __builtin_astype((x), short4)
552 #define as_short8(x) __builtin_astype((x), short8)
553 #define as_short16(x) __builtin_astype((x), short16)
554 
555 #define as_ushort(x) __builtin_astype((x), ushort)
556 #define as_ushort2(x) __builtin_astype((x), ushort2)
557 #define as_ushort3(x) __builtin_astype((x), ushort3)
558 #define as_ushort4(x) __builtin_astype((x), ushort4)
559 #define as_ushort8(x) __builtin_astype((x), ushort8)
560 #define as_ushort16(x) __builtin_astype((x), ushort16)
561 
562 #define as_int(x) __builtin_astype((x), int)
563 #define as_int2(x) __builtin_astype((x), int2)
564 #define as_int3(x) __builtin_astype((x), int3)
565 #define as_int4(x) __builtin_astype((x), int4)
566 #define as_int8(x) __builtin_astype((x), int8)
567 #define as_int16(x) __builtin_astype((x), int16)
568 
569 #define as_uint(x) __builtin_astype((x), uint)
570 #define as_uint2(x) __builtin_astype((x), uint2)
571 #define as_uint3(x) __builtin_astype((x), uint3)
572 #define as_uint4(x) __builtin_astype((x), uint4)
573 #define as_uint8(x) __builtin_astype((x), uint8)
574 #define as_uint16(x) __builtin_astype((x), uint16)
575 
576 #define as_long(x) __builtin_astype((x), long)
577 #define as_long2(x) __builtin_astype((x), long2)
578 #define as_long3(x) __builtin_astype((x), long3)
579 #define as_long4(x) __builtin_astype((x), long4)
580 #define as_long8(x) __builtin_astype((x), long8)
581 #define as_long16(x) __builtin_astype((x), long16)
582 
583 #define as_ulong(x) __builtin_astype((x), ulong)
584 #define as_ulong2(x) __builtin_astype((x), ulong2)
585 #define as_ulong3(x) __builtin_astype((x), ulong3)
586 #define as_ulong4(x) __builtin_astype((x), ulong4)
587 #define as_ulong8(x) __builtin_astype((x), ulong8)
588 #define as_ulong16(x) __builtin_astype((x), ulong16)
589 
590 #define as_float(x) __builtin_astype((x), float)
591 #define as_float2(x) __builtin_astype((x), float2)
592 #define as_float3(x) __builtin_astype((x), float3)
593 #define as_float4(x) __builtin_astype((x), float4)
594 #define as_float8(x) __builtin_astype((x), float8)
595 #define as_float16(x) __builtin_astype((x), float16)
596 
597 #ifdef cl_khr_fp64
598 #define as_double(x) __builtin_astype((x), double)
599 #define as_double2(x) __builtin_astype((x), double2)
600 #define as_double3(x) __builtin_astype((x), double3)
601 #define as_double4(x) __builtin_astype((x), double4)
602 #define as_double8(x) __builtin_astype((x), double8)
603 #define as_double16(x) __builtin_astype((x), double16)
604 #endif // cl_khr_fp64
605 
606 #ifdef cl_khr_fp16
607 #define as_half(x) __builtin_astype((x), half)
608 #define as_half2(x) __builtin_astype((x), half2)
609 #define as_half3(x) __builtin_astype((x), half3)
610 #define as_half4(x) __builtin_astype((x), half4)
611 #define as_half8(x) __builtin_astype((x), half8)
612 #define as_half16(x) __builtin_astype((x), half16)
613 #endif // cl_khr_fp16
614 
615 #define as_size_t(x) __builtin_astype((x), size_t)
616 #define as_ptrdiff_t(x) __builtin_astype((x), ptrdiff_t)
617 #define as_intptr_t(x) __builtin_astype((x), intptr_t)
618 #define as_uintptr_t(x) __builtin_astype((x), uintptr_t)
619 
620 // C++ for OpenCL - __remove_address_space
621 #if defined(__OPENCL_CPP_VERSION__)
622 template <typename _Tp> struct __remove_address_space { using type = _Tp; };
623 #if defined(__opencl_c_generic_address_space)
624 template <typename _Tp> struct __remove_address_space<__generic _Tp> {
625  using type = _Tp;
626 };
627 #endif
628 template <typename _Tp> struct __remove_address_space<__global _Tp> {
629  using type = _Tp;
630 };
631 template <typename _Tp> struct __remove_address_space<__private _Tp> {
632  using type = _Tp;
633 };
634 template <typename _Tp> struct __remove_address_space<__local _Tp> {
635  using type = _Tp;
636 };
637 template <typename _Tp> struct __remove_address_space<__constant _Tp> {
638  using type = _Tp;
639 };
640 #endif
641 
642 // OpenCL v1.1 s6.9, v1.2/2.0 s6.10 - Function qualifiers
643 
644 #define __kernel_exec(X, typen) __kernel \
645  __attribute__((work_group_size_hint(X, 1, 1))) \
646  __attribute__((vec_type_hint(typen)))
647 
648 #define kernel_exec(X, typen) __kernel \
649  __attribute__((work_group_size_hint(X, 1, 1))) \
650  __attribute__((vec_type_hint(typen)))
651 
652 #if defined(__OPENCL_CPP_VERSION__) || (__OPENCL_C_VERSION__ >= CL_VERSION_1_2)
653 // OpenCL v1.2 s6.12.13, v2.0 s6.13.13 - printf
654 
655 int printf(__constant const char* st, ...) __attribute__((format(printf, 1, 2)));
656 #endif
657 
658 #ifdef cl_intel_device_side_avc_motion_estimation
659 
660 #define CLK_AVC_ME_MAJOR_16x16_INTEL 0x0
661 #define CLK_AVC_ME_MAJOR_16x8_INTEL 0x1
662 #define CLK_AVC_ME_MAJOR_8x16_INTEL 0x2
663 #define CLK_AVC_ME_MAJOR_8x8_INTEL 0x3
664 
665 #define CLK_AVC_ME_MINOR_8x8_INTEL 0x0
666 #define CLK_AVC_ME_MINOR_8x4_INTEL 0x1
667 #define CLK_AVC_ME_MINOR_4x8_INTEL 0x2
668 #define CLK_AVC_ME_MINOR_4x4_INTEL 0x3
669 
670 #define CLK_AVC_ME_MAJOR_FORWARD_INTEL 0x0
671 #define CLK_AVC_ME_MAJOR_BACKWARD_INTEL 0x1
672 #define CLK_AVC_ME_MAJOR_BIDIRECTIONAL_INTEL 0x2
673 
674 #define CLK_AVC_ME_PARTITION_MASK_ALL_INTEL 0x0
675 #define CLK_AVC_ME_PARTITION_MASK_16x16_INTEL 0x7E
676 #define CLK_AVC_ME_PARTITION_MASK_16x8_INTEL 0x7D
677 #define CLK_AVC_ME_PARTITION_MASK_8x16_INTEL 0x7B
678 #define CLK_AVC_ME_PARTITION_MASK_8x8_INTEL 0x77
679 #define CLK_AVC_ME_PARTITION_MASK_8x4_INTEL 0x6F
680 #define CLK_AVC_ME_PARTITION_MASK_4x8_INTEL 0x5F
681 #define CLK_AVC_ME_PARTITION_MASK_4x4_INTEL 0x3F
682 
683 #define CLK_AVC_ME_SLICE_TYPE_PRED_INTEL 0x0
684 #define CLK_AVC_ME_SLICE_TYPE_BPRED_INTEL 0x1
685 #define CLK_AVC_ME_SLICE_TYPE_INTRA_INTEL 0x2
686 
687 #define CLK_AVC_ME_SEARCH_WINDOW_EXHAUSTIVE_INTEL 0x0
688 #define CLK_AVC_ME_SEARCH_WINDOW_SMALL_INTEL 0x1
689 #define CLK_AVC_ME_SEARCH_WINDOW_TINY_INTEL 0x2
690 #define CLK_AVC_ME_SEARCH_WINDOW_EXTRA_TINY_INTEL 0x3
691 #define CLK_AVC_ME_SEARCH_WINDOW_DIAMOND_INTEL 0x4
692 #define CLK_AVC_ME_SEARCH_WINDOW_LARGE_DIAMOND_INTEL 0x5
693 #define CLK_AVC_ME_SEARCH_WINDOW_RESERVED0_INTEL 0x6
694 #define CLK_AVC_ME_SEARCH_WINDOW_RESERVED1_INTEL 0x7
695 #define CLK_AVC_ME_SEARCH_WINDOW_CUSTOM_INTEL 0x8
696 
697 #define CLK_AVC_ME_SAD_ADJUST_MODE_NONE_INTEL 0x0
698 #define CLK_AVC_ME_SAD_ADJUST_MODE_HAAR_INTEL 0x2
699 
700 #define CLK_AVC_ME_SUBPIXEL_MODE_INTEGER_INTEL 0x0
701 #define CLK_AVC_ME_SUBPIXEL_MODE_HPEL_INTEL 0x1
702 #define CLK_AVC_ME_SUBPIXEL_MODE_QPEL_INTEL 0x3
703 
704 #define CLK_AVC_ME_COST_PRECISION_QPEL_INTEL 0x0
705 #define CLK_AVC_ME_COST_PRECISION_HPEL_INTEL 0x1
706 #define CLK_AVC_ME_COST_PRECISION_PEL_INTEL 0x2
707 #define CLK_AVC_ME_COST_PRECISION_DPEL_INTEL 0x3
708 
709 #define CLK_AVC_ME_BIDIR_WEIGHT_QUARTER_INTEL 0x10
710 #define CLK_AVC_ME_BIDIR_WEIGHT_THIRD_INTEL 0x15
711 #define CLK_AVC_ME_BIDIR_WEIGHT_HALF_INTEL 0x20
712 #define CLK_AVC_ME_BIDIR_WEIGHT_TWO_THIRD_INTEL 0x2B
713 #define CLK_AVC_ME_BIDIR_WEIGHT_THREE_QUARTER_INTEL 0x30
714 
715 #define CLK_AVC_ME_BORDER_REACHED_LEFT_INTEL 0x0
716 #define CLK_AVC_ME_BORDER_REACHED_RIGHT_INTEL 0x2
717 #define CLK_AVC_ME_BORDER_REACHED_TOP_INTEL 0x4
718 #define CLK_AVC_ME_BORDER_REACHED_BOTTOM_INTEL 0x8
719 
720 #define CLK_AVC_ME_INTRA_16x16_INTEL 0x0
721 #define CLK_AVC_ME_INTRA_8x8_INTEL 0x1
722 #define CLK_AVC_ME_INTRA_4x4_INTEL 0x2
723 
724 #define CLK_AVC_ME_SKIP_BLOCK_PARTITION_16x16_INTEL 0x0
725 #define CLK_AVC_ME_SKIP_BLOCK_PARTITION_8x8_INTEL 0x4000
726 
727 #define CLK_AVC_ME_SKIP_BLOCK_16x16_FORWARD_ENABLE_INTEL (0x1 << 24)
728 #define CLK_AVC_ME_SKIP_BLOCK_16x16_BACKWARD_ENABLE_INTEL (0x2 << 24)
729 #define CLK_AVC_ME_SKIP_BLOCK_16x16_DUAL_ENABLE_INTEL (0x3 << 24)
730 #define CLK_AVC_ME_SKIP_BLOCK_8x8_FORWARD_ENABLE_INTEL (0x55 << 24)
731 #define CLK_AVC_ME_SKIP_BLOCK_8x8_BACKWARD_ENABLE_INTEL (0xAA << 24)
732 #define CLK_AVC_ME_SKIP_BLOCK_8x8_DUAL_ENABLE_INTEL (0xFF << 24)
733 #define CLK_AVC_ME_SKIP_BLOCK_8x8_0_FORWARD_ENABLE_INTEL (0x1 << 24)
734 #define CLK_AVC_ME_SKIP_BLOCK_8x8_0_BACKWARD_ENABLE_INTEL (0x2 << 24)
735 #define CLK_AVC_ME_SKIP_BLOCK_8x8_1_FORWARD_ENABLE_INTEL (0x1 << 26)
736 #define CLK_AVC_ME_SKIP_BLOCK_8x8_1_BACKWARD_ENABLE_INTEL (0x2 << 26)
737 #define CLK_AVC_ME_SKIP_BLOCK_8x8_2_FORWARD_ENABLE_INTEL (0x1 << 28)
738 #define CLK_AVC_ME_SKIP_BLOCK_8x8_2_BACKWARD_ENABLE_INTEL (0x2 << 28)
739 #define CLK_AVC_ME_SKIP_BLOCK_8x8_3_FORWARD_ENABLE_INTEL (0x1 << 30)
740 #define CLK_AVC_ME_SKIP_BLOCK_8x8_3_BACKWARD_ENABLE_INTEL (0x2 << 30)
741 
742 #define CLK_AVC_ME_BLOCK_BASED_SKIP_4x4_INTEL 0x00
743 #define CLK_AVC_ME_BLOCK_BASED_SKIP_8x8_INTEL 0x80
744 
745 #define CLK_AVC_ME_INTRA_LUMA_PARTITION_MASK_ALL_INTEL 0x0
746 #define CLK_AVC_ME_INTRA_LUMA_PARTITION_MASK_16x16_INTEL 0x6
747 #define CLK_AVC_ME_INTRA_LUMA_PARTITION_MASK_8x8_INTEL 0x5
748 #define CLK_AVC_ME_INTRA_LUMA_PARTITION_MASK_4x4_INTEL 0x3
749 
750 #define CLK_AVC_ME_INTRA_NEIGHBOR_LEFT_MASK_ENABLE_INTEL 0x60
751 #define CLK_AVC_ME_INTRA_NEIGHBOR_UPPER_MASK_ENABLE_INTEL 0x10
752 #define CLK_AVC_ME_INTRA_NEIGHBOR_UPPER_RIGHT_MASK_ENABLE_INTEL 0x8
753 #define CLK_AVC_ME_INTRA_NEIGHBOR_UPPER_LEFT_MASK_ENABLE_INTEL 0x4
754 
755 #define CLK_AVC_ME_LUMA_PREDICTOR_MODE_VERTICAL_INTEL 0x0
756 #define CLK_AVC_ME_LUMA_PREDICTOR_MODE_HORIZONTAL_INTEL 0x1
757 #define CLK_AVC_ME_LUMA_PREDICTOR_MODE_DC_INTEL 0x2
758 #define CLK_AVC_ME_LUMA_PREDICTOR_MODE_DIAGONAL_DOWN_LEFT_INTEL 0x3
759 #define CLK_AVC_ME_LUMA_PREDICTOR_MODE_DIAGONAL_DOWN_RIGHT_INTEL 0x4
760 #define CLK_AVC_ME_LUMA_PREDICTOR_MODE_PLANE_INTEL 0x4
761 #define CLK_AVC_ME_LUMA_PREDICTOR_MODE_VERTICAL_RIGHT_INTEL 0x5
762 #define CLK_AVC_ME_LUMA_PREDICTOR_MODE_HORIZONTAL_DOWN_INTEL 0x6
763 #define CLK_AVC_ME_LUMA_PREDICTOR_MODE_VERTICAL_LEFT_INTEL 0x7
764 #define CLK_AVC_ME_LUMA_PREDICTOR_MODE_HORIZONTAL_UP_INTEL 0x8
765 #define CLK_AVC_ME_CHROMA_PREDICTOR_MODE_DC_INTEL 0x0
766 #define CLK_AVC_ME_CHROMA_PREDICTOR_MODE_HORIZONTAL_INTEL 0x1
767 #define CLK_AVC_ME_CHROMA_PREDICTOR_MODE_VERTICAL_INTEL 0x2
768 #define CLK_AVC_ME_CHROMA_PREDICTOR_MODE_PLANE_INTEL 0x3
769 
770 #define CLK_AVC_ME_FRAME_FORWARD_INTEL 0x1
771 #define CLK_AVC_ME_FRAME_BACKWARD_INTEL 0x2
772 #define CLK_AVC_ME_FRAME_DUAL_INTEL 0x3
773 
774 #define CLK_AVC_ME_INTERLACED_SCAN_TOP_FIELD_INTEL 0x0
775 #define CLK_AVC_ME_INTERLACED_SCAN_BOTTOM_FIELD_INTEL 0x1
776 
777 #define CLK_AVC_ME_INITIALIZE_INTEL 0x0
778 
779 #define CLK_AVC_IME_PAYLOAD_INITIALIZE_INTEL 0x0
780 #define CLK_AVC_REF_PAYLOAD_INITIALIZE_INTEL 0x0
781 #define CLK_AVC_SIC_PAYLOAD_INITIALIZE_INTEL 0x0
782 
783 #define CLK_AVC_IME_RESULT_INITIALIZE_INTEL 0x0
784 #define CLK_AVC_REF_RESULT_INITIALIZE_INTEL 0x0
785 #define CLK_AVC_SIC_RESULT_INITIALIZE_INTEL 0x0
786 
787 #define CLK_AVC_IME_RESULT_SINGLE_REFERENCE_STREAMOUT_INITIALIZE_INTEL 0x0
788 #define CLK_AVC_IME_RESULT_SINGLE_REFERENCE_STREAMIN_INITIALIZE_INTEL 0x0
789 #define CLK_AVC_IME_RESULT_DUAL_REFERENCE_STREAMOUT_INITIALIZE_INTEL 0x0
790 #define CLK_AVC_IME_RESULT_DUAL_REFERENCE_STREAMIN_INITIALIZE_INTEL 0x0
791 
792 #endif // cl_intel_device_side_avc_motion_estimation
793 
794 // Disable any extensions we may have enabled previously.
795 #pragma OPENCL EXTENSION all : disable
796 
797 #endif //_OPENCL_BASE_H_
memory_order_release
@ memory_order_release
Definition: opencl-c-base.h:401
type
memory_order_acq_rel
@ memory_order_acq_rel
Definition: opencl-c-base.h:402
memory_order
memory_order
Definition: opencl-c-base.h:397
cl_mem_fence_flags
uint cl_mem_fence_flags
Definition: opencl-c-base.h:347
memory_scope_work_item
@ memory_scope_work_item
Definition: opencl-c-base.h:364
memory_order_acquire
@ memory_order_acquire
Definition: opencl-c-base.h:400
size_t
__SIZE_TYPE__ size_t
The unsigned integer type of the result of the sizeof operator.
Definition: opencl-c-base.h:117
memory_scope_work_group
@ memory_scope_work_group
Definition: opencl-c-base.h:365
uchar
unsigned char uchar
An unsigned 8-bit integer.
Definition: opencl-c-base.h:94
MAX_WORK_DIM
#define MAX_WORK_DIM
Definition: opencl-c-base.h:517
intptr_t
__INTPTR_TYPE__ intptr_t
A signed integer type with the property that any valid pointer to void can be converted to this type,...
Definition: opencl-c-base.h:132
uintptr_t
__UINTPTR_TYPE__ uintptr_t
An unsigned integer type with the property that any valid pointer to void can be converted to this ty...
Definition: opencl-c-base.h:139
__attribute__
char char2 __attribute__((ext_vector_type(2)))
Definition: opencl-c-base.h:142
memory_scope
memory_scope
Definition: opencl-c-base.h:363
kernel_enqueue_flags_t
int kernel_enqueue_flags_t
Definition: opencl-c-base.h:511
ulong
unsigned long ulong
An unsigned 64-bit integer.
Definition: opencl-c-base.h:109
uint
unsigned int uint
An unsigned 32-bit integer.
Definition: opencl-c-base.h:104
clk_profiling_info
int clk_profiling_info
Definition: opencl-c-base.h:512
memory_order_seq_cst
@ memory_order_seq_cst
Definition: stdatomic.h:62
ptrdiff_t
__PTRDIFF_TYPE__ ptrdiff_t
A signed integer type that is the result of subtracting two pointers.
Definition: opencl-c-base.h:125
ushort
unsigned short ushort
An unsigned 16-bit integer.
Definition: opencl-c-base.h:99
memory_order_relaxed
@ memory_order_relaxed
Definition: opencl-c-base.h:399
printf
int printf(__constant const char *st,...) __attribute__((format(printf
memory_scope_device
@ memory_scope_device
Definition: opencl-c-base.h:366