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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
|
/*
* 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.1 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__
#include "CL/cl.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
enum DEBUGP_LEVEL
{
DL_INFO,
DL_WARNING,
DL_ERROR
};
#ifdef NDEBUG
#define DEBUGP(...)
#else
//TODO: decide print or not with the value of level from environment
#define DEBUGP(level, fmt, ...) \
do { \
fprintf(stderr, "Beignet: "#fmt, ##__VA_ARGS__); \
fprintf(stderr, "\n"); \
} while (0)
#endif
/* 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(!CL_OBJECT_IS_CONTEXT(CTX))) { \
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(!CL_OBJECT_IS_COMMAND_QUEUE(QUEUE))) { \
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(!CL_OBJECT_IS_MEM(MEM))) { \
err = CL_INVALID_MEM_OBJECT; \
goto error; \
} \
} while (0)
#define CHECK_IMAGE(MEM, IMAGE) \
CHECK_MEM(MEM); \
do { \
if (UNLIKELY(!IS_IMAGE(MEM))) { \
err = CL_INVALID_MEM_OBJECT; \
goto error; \
} \
} while (0); \
struct _cl_mem_image *IMAGE; \
IMAGE = cl_mem_image(MEM); \
#define FIXUP_IMAGE_REGION(IMAGE, PREGION, REGION) \
const size_t *REGION; \
size_t REGION ##_REC[3]; \
do { \
if (PREGION == NULL) \
{ \
err = CL_INVALID_VALUE; \
goto error; \
} \
if (IMAGE->image_type == CL_MEM_OBJECT_IMAGE1D_ARRAY) { \
REGION ##_REC[0] = PREGION[0]; \
REGION ##_REC[1] = 1; \
REGION ##_REC[2] = PREGION[1]; \
REGION = REGION ##_REC; \
} else { \
REGION = PREGION; \
} \
if((REGION[0] == 0)||(REGION[1] == 0)||(REGION[2] == 0)) \
{ \
err = CL_INVALID_VALUE; \
goto error; \
} \
} while(0)
#define FIXUP_IMAGE_ORIGIN(IMAGE, PREGION, REGION) \
const size_t *REGION; \
size_t REGION ##_REC[3]; \
do { \
if (PREGION == NULL) \
{ \
err = CL_INVALID_VALUE; \
goto error; \
} \
if (IMAGE->image_type == CL_MEM_OBJECT_IMAGE1D_ARRAY) { \
REGION ##_REC[0] = PREGION[0]; \
REGION ##_REC[1] = 0; \
REGION ##_REC[2] = PREGION[1]; \
REGION = REGION ##_REC; \
} else { \
REGION = PREGION; \
} \
} while(0)
#define CHECK_EVENT(EVENT) \
do { \
if (UNLIKELY(EVENT == NULL)) { \
err = CL_INVALID_EVENT; \
goto error; \
} \
if (UNLIKELY(!CL_OBJECT_IS_EVENT(EVENT))) { \
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(!CL_OBJECT_IS_SAMPLER(SAMPLER))) { \
err = CL_INVALID_SAMPLER; \
goto error; \
} \
} while (0)
#define CHECK_ACCELERATOR_INTEL(ACCELERATOR_INTEL) \
do { \
if (UNLIKELY(ACCELERATOR_INTEL == NULL)) { \
err = CL_INVALID_ACCELERATOR_INTEL; \
goto error; \
} \
if (UNLIKELY(!CL_OBJECT_IS_ACCELERATOR_INTEL(ACCELERATOR_INTEL))) { \
err = CL_INVALID_ACCELERATOR_INTEL; \
goto error; \
} \
} while (0)
#define CHECK_KERNEL(KERNEL) \
do { \
if (UNLIKELY(KERNEL == NULL)) { \
err = CL_INVALID_KERNEL; \
goto error; \
} \
if (UNLIKELY(!CL_OBJECT_IS_KERNEL(KERNEL))) { \
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(!CL_OBJECT_IS_PROGRAM(PROGRAM))) { \
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_read(atomic_t *v) {
return *v;
}
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); }
/* Define one list node. */
typedef struct list_node {
struct list_node *n;
struct list_node *p;
} list_node;
typedef struct list_head {
list_node head_node;
} list_head;
static inline void list_node_init(list_node *node)
{
node->n = node;
node->p = node;
}
static inline int list_node_out_of_list(const struct list_node *node)
{
return node->n == node;
}
static inline void list_init(list_head *head)
{
head->head_node.n = &head->head_node;
head->head_node.p = &head->head_node;
}
extern void list_node_insert_before(list_node *node, list_node *the_new);
extern void list_node_insert_after(list_node *node, list_node *the_new);
static inline void list_node_del(struct list_node *node)
{
node->n->p = node->p;
node->p->n = node->n;
/* And all point to self for safe. */
node->p = node;
node->n = node;
}
static inline void list_add(list_head *head, list_node *the_new)
{
list_node_insert_after(&head->head_node, the_new);
}
static inline void list_add_tail(list_head *head, list_node *the_new)
{
list_node_insert_before(&head->head_node, the_new);
}
static inline int list_empty(const struct list_head *head)
{
return head->head_node.n == &head->head_node;
}
/* Move the content from one head to another. */
extern void list_move(struct list_head *the_old, struct list_head *the_new);
/* Merge the content of the two lists to one head. */
extern void list_merge(struct list_head *head, struct list_head *to_merge);
#undef offsetof
#ifdef __compiler_offsetof
#define offsetof(TYPE, MEMBER) __compiler_offsetof(TYPE, MEMBER)
#else
#define offsetof(TYPE, MEMBER) ((size_t) & ((TYPE *)0)->MEMBER)
#endif
#define list_entry(ptr, type, member) ({ \
const typeof( ((type *)0)->member ) *__mptr = (ptr); \
(type *)( (char *)__mptr - offsetof(type,member) ); })
#define list_for_each(pos, head) \
for (pos = (head)->head_node.n; pos != &((head)->head_node); pos = pos->n)
#define list_for_each_safe(pos, ne, head) \
for (pos = (head)->head_node.n, ne = pos->n; pos != &((head)->head_node); \
pos = ne, ne = pos->n)
extern cl_int cl_get_info_helper(const void *src, size_t src_size, void *dst,
size_t dst_size, size_t *ret_size);
#endif /* __CL_UTILS_H__ */
|
