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