1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
/*
* Copyright © 2012 Intel Corporation
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Author: Benjamin Segovia <benjamin.segovia@intel.com>
*/
#ifndef __CL_UTILS_H__
#define __CL_UTILS_H__
/* INLINE is forceinline */
#define INLINE __attribute__((always_inline)) inline
/* Branch hint */
#define LIKELY(x) __builtin_expect((x),1)
#define UNLIKELY(x) __builtin_expect((x),0)
/* Stringify macros */
#define JOIN(X, Y) _DO_JOIN(X, Y)
#define _DO_JOIN(X, Y) _DO_JOIN2(X, Y)
#define _DO_JOIN2(X, Y) X##Y
/* Check compile time errors */
#define STATIC_ASSERT(value) \
struct JOIN(__,JOIN(__,__LINE__)) { \
int x[(value) ? 1 : -1]; \
}
/* Throw errors */
#ifdef NDEBUG
#define ERR(ERROR, ...) \
do { \
err = ERROR; \
goto error; \
} while (0)
#else
#define ERR(ERROR, ...) \
do { \
fprintf(stderr, "error in %s line %i\n", __FILE__, __LINE__); \
fprintf(stderr, __VA_ARGS__); \
fprintf(stderr, "\n"); \
err = ERROR; \
goto error; \
} while (0)
#endif
#define DO_ALLOC_ERR \
do { \
ERR(CL_OUT_OF_HOST_MEMORY, "Out of memory"); \
} while (0)
#define ERR_IF(COND, ERROR, ...) \
do { \
if (UNLIKELY(COND)) ERR (ERROR, __VA_ARGS__); \
} while (0)
#define INVALID_VALUE_IF(COND) \
do { \
ERR_IF(COND, CL_INVALID_VALUE, "Invalid value"); \
} while (0)
#define INVALID_DEVICE_IF(COND) \
do { \
ERR_IF(COND, CL_INVALID_DEVICE, "Invalid device"); \
} while (0)
#define MAX(x0, x1) ((x0) > (x1) ? (x0) : (x1))
#define MIN(x0, x1) ((x0) < (x1) ? (x0) : (x1))
#define ALIGN(A, B) (((A) % (B)) ? (A) + (B) - ((A) % (B)) : (A))
#define DO_ALLOC_ERROR \
do { \
err = CL_OUT_OF_HOST_MEMORY; \
goto error; \
} while (0)
#define FATAL(...) \
do { \
fprintf(stderr, "error: "); \
fprintf(stderr, __VA_ARGS__); \
fprintf(stderr, "\n"); \
assert(0); \
exit(-1); \
} while (0)
#define FATAL_IF(COND, ...) \
do { \
if (UNLIKELY(COND)) FATAL(__VA_ARGS__); \
} while (0)
#define NOT_IMPLEMENTED FATAL ("Not implemented")
#define CHECK_CONTEXT(CTX) \
do { \
if (UNLIKELY(CTX == NULL)) { \
err = CL_INVALID_CONTEXT; \
goto error; \
} \
if (UNLIKELY(CTX->magic != CL_MAGIC_CONTEXT_HEADER)) { \
err = CL_INVALID_CONTEXT; \
goto error; \
} \
} while (0)
#define CHECK_QUEUE(QUEUE) \
do { \
if (UNLIKELY(QUEUE == NULL)) { \
err = CL_INVALID_COMMAND_QUEUE; \
goto error; \
} \
if (UNLIKELY(QUEUE->magic != CL_MAGIC_QUEUE_HEADER)) { \
err = CL_INVALID_COMMAND_QUEUE; \
goto error; \
} \
} while (0)
#define CHECK_MEM(MEM) \
do { \
if (UNLIKELY(MEM == NULL)) { \
err = CL_INVALID_MEM_OBJECT; \
goto error; \
} \
if (UNLIKELY(MEM->magic != CL_MAGIC_MEM_HEADER)) { \
err = CL_INVALID_MEM_OBJECT; \
goto error; \
} \
} while (0)
#define CHECK_IMAGE(IMAGE) \
CHECK_MEM(image); \
do { \
if (UNLIKELY(!IMAGE->is_image)) { \
err = CL_INVALID_MEM_OBJECT; \
goto error; \
} \
} while (0)
#define CHECK_EVENT(EVENT) \
do { \
if (UNLIKELY(EVENT == NULL)) { \
err = CL_INVALID_EVENT; \
goto error; \
} \
if (UNLIKELY(EVENT->magic != CL_MAGIC_EVENT_HEADER)) { \
err = CL_INVALID_EVENT; \
goto error; \
} \
} while (0)
#define CHECK_SAMPLER(SAMPLER) \
do { \
if (UNLIKELY(SAMPLER == NULL)) { \
err = CL_INVALID_SAMPLER; \
goto error; \
} \
if (UNLIKELY(SAMPLER->magic != CL_MAGIC_SAMPLER_HEADER)) {\
err = CL_INVALID_SAMPLER; \
goto error; \
} \
} while (0)
#define CHECK_KERNEL(KERNEL) \
do { \
if (UNLIKELY(KERNEL == NULL)) { \
err = CL_INVALID_KERNEL; \
goto error; \
} \
if (UNLIKELY(KERNEL->magic != CL_MAGIC_KERNEL_HEADER)) { \
err = CL_INVALID_KERNEL; \
goto error; \
} \
} while (0)
#define CHECK_PROGRAM(PROGRAM) \
do { \
if (UNLIKELY(PROGRAM == NULL)) { \
err = CL_INVALID_PROGRAM; \
goto error; \
} \
if (UNLIKELY(PROGRAM->magic != CL_MAGIC_PROGRAM_HEADER)) {\
err = CL_INVALID_PROGRAM; \
goto error; \
} \
} while (0)
#define ELEMENTS(x) (sizeof(x)/sizeof(*(x)))
#define CALLOC_STRUCT(T) (struct T*) cl_calloc(1, sizeof(struct T))
#define CALLOC(T) (T*) cl_calloc(1, sizeof(T))
#define CALLOC_ARRAY(T, N) (T*) cl_calloc(N, sizeof(T))
#define MEMZERO(x) do { memset((x),0,sizeof(*(x))); } while (0)
/* Run some code and catch errors */
#define TRY(fn,...) \
do { \
if (UNLIKELY((err = fn(__VA_ARGS__)) != CL_SUCCESS)) \
goto error; \
} while (0)
#define TRY_NO_ERR(fn,...) \
do { \
if (UNLIKELY(fn(__VA_ARGS__) != CL_SUCCESS)) \
goto error; \
} while (0)
#define TRY_ALLOC(dst, EXPR) \
do { \
if (UNLIKELY((dst = EXPR) == NULL)) \
DO_ALLOC_ERROR; \
} while (0)
#define TRY_ALLOC_NO_ERR(dst, EXPR) \
do { \
if (UNLIKELY((dst = EXPR) == NULL)) \
goto error; \
} while (0)
#define TRY_ALLOC_NO_RET(EXPR) \
do { \
if (UNLIKELY((EXPR) == NULL)) \
DO_ALLOC_ERROR; \
} while (0)
/* Break Point Definitions */
#if !defined(NDEBUG)
#define BREAK \
do { \
__asm__("int3"); \
} while(0)
#define BREAK_IF(value) \
do { \
if (UNLIKELY(!(value))) BREAKPOINT(); \
} while(0)
#else
#define BREAKPOINT() do { } while(0)
#define ASSERT(value) do { } while(0)
#endif
/* For all internal functions */
#define LOCAL __attribute__ ((visibility ("internal")))
/* Align a structure or a variable */
#define ALIGNED(X) __attribute__ ((aligned (X)))
/* Number of DWORDS */
#define SIZEOF32(X) (sizeof(X) / sizeof(uint32_t))
/* Memory quantity */
#define KB 1024
#define MB (KB*KB)
/* To help bitfield definitions */
#define BITFIELD_BIT(X) 1
#define BITFIELD_RANGE(X,Y) ((Y) - (X) + 1)
/* 32 bits atomic variable */
typedef volatile int atomic_t;
static INLINE int atomic_add(atomic_t *v, const int c) {
register int i = c;
__asm__ __volatile__("lock ; xaddl %0, %1;"
: "+r"(i), "+m"(*v)
: "m"(*v), "r"(i));
return i;
}
static INLINE int atomic_inc(atomic_t *v) { return atomic_add(v, 1); }
static INLINE int atomic_dec(atomic_t *v) { return atomic_add(v, -1); }
#endif /* __CL_UTILS_H__ */
|
