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