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