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