5 #ifndef SPA_UTILS_DEFS_H
6 #define SPA_UTILS_DEFS_H
10 # if __cplusplus >= 201103L
11 # define SPA_STATIC_ASSERT_IMPL(expr, msg, ...) static_assert(expr, msg)
12 # define SPA_ALIGNOF alignof
14 #elif __STDC_VERSION__ >= 202311L
15 # define SPA_STATIC_ASSERT_IMPL(expr, msg, ...) static_assert(expr, msg)
16 # define SPA_ALIGNOF alignof
19 # if __STDC_VERSION__ >= 201112L
20 # define SPA_STATIC_ASSERT_IMPL(expr, msg, ...) _Static_assert(expr, msg)
21 # define SPA_ALIGNOF _Alignof
24 #ifndef SPA_STATIC_ASSERT_IMPL
25 #define SPA_STATIC_ASSERT_IMPL(expr, ...) \
26 ((void)sizeof(struct { int spa_static_assertion_failed : 2 * !!(expr) - 1; }))
29 #define SPA_ALIGNOF __alignof__
32 #define SPA_STATIC_ASSERT(expr, ...) SPA_STATIC_ASSERT_IMPL(expr, ## __VA_ARGS__, "`" #expr "` evaluated to false")
34 #define SPA_CONCAT_NOEXPAND(a, b) a ## b
35 #define SPA_CONCAT(a, b) SPA_CONCAT_NOEXPAND(a, b)
69 #if defined(__clang__) && defined(__cplusplus) && __cplusplus >= 201103L
71 # define SPA_FALLTHROUGH [[clang::fallthrough]];
72 #elif __GNUC__ >= 7 || __clang_major__ >= 10
73 # define SPA_FALLTHROUGH __attribute__ ((fallthrough));
75 # define SPA_FALLTHROUGH
78 #define SPA_FLAG_MASK(field,mask,flag) (((field) & (mask)) == (flag))
79 #define SPA_FLAG_IS_SET(field,flag) SPA_FLAG_MASK(field, flag, flag)
81 #define SPA_FLAG_SET(field,flag) ((field) |= (flag))
82 #define SPA_FLAG_CLEAR(field, flag) \
84 SPA_STATIC_ASSERT(__builtin_constant_p(flag) ? \
85 (__typeof__(flag))(__typeof__(field))(__typeof__(flag))(flag) == (flag) : \
86 sizeof(field) >= sizeof(flag), \
87 "truncation problem when masking " #field \
89 ((field) &= ~(__typeof__(field))(flag)); \
91 #define SPA_FLAG_UPDATE(field,flag,val) ((val) ? SPA_FLAG_SET((field),(flag)) : SPA_FLAG_CLEAR((field),(flag)))
98 #define SPA_DIRECTION_REVERSE(d) ((d) ^ 1)
100 #define SPA_RECTANGLE(width,height) ((struct spa_rectangle){ (width), (height) })
106 #define SPA_POINT(x,y) ((struct spa_point){ (x), (y) })
112 #define SPA_REGION(x,y,width,height) ((struct spa_region){ SPA_POINT(x,y), SPA_RECTANGLE(width,height) })
118 #define SPA_FRACTION(num,denom) ((struct spa_fraction){ (num), (denom) })
124 #define SPA_N_ELEMENTS(arr) (sizeof(arr) / sizeof((arr)[0]))
135 #define SPA_FOR_EACH_ELEMENT(arr, ptr) \
136 for ((ptr) = arr; (ptr) < (arr) + SPA_N_ELEMENTS(arr); (ptr)++)
138 #define SPA_FOR_EACH_ELEMENT_VAR(arr, var) \
139 for (__typeof__((arr)[0])* var = arr; (var) < (arr) + SPA_N_ELEMENTS(arr); (var)++)
143 __typeof__(a) _a = (a); \
144 SPA_LIKELY(_a >= 0) ? _a : -_a; \
146 #define SPA_MIN(a,b) \
148 __typeof__(a) _min_a = (a); \
149 __typeof__(b) _min_b = (b); \
150 SPA_LIKELY(_min_a <= _min_b) ? _min_a : _min_b; \
152 #define SPA_MAX(a,b) \
154 __typeof__(a) _max_a = (a); \
155 __typeof__(b) _max_b = (b); \
156 SPA_LIKELY(_max_a >= _max_b) ? _max_a : _max_b; \
158 #define SPA_CLAMP(v,low,high) \
160 __typeof__(v) _v = (v); \
161 __typeof__(low) _low = (low); \
162 __typeof__(high) _high = (high); \
163 SPA_MIN(SPA_MAX(_v, _low), _high); \
166 #define SPA_CLAMPF(v,low,high) \
168 fminf(fmaxf(v, low), high); \
170 #define SPA_CLAMPD(v,low,high) \
172 fmin(fmax(v, low), high); \
176 #define SPA_SWAP(a,b) \
178 __typeof__(a) _t = (a); \
182 #define SPA_TYPECHECK(type,x) \
185 (void)(&_dummy == &_dummy2); \
190 #define SPA_CMP(a, b) \
192 __typeof__(a) _a = (a); \
193 __typeof__(b) _b = (b); \
194 (_a > _b) ? 1 : (_a == _b) ? 0 : (_a < _b) ? -1 \
195 : (_a == _a) ? -1 : (_b == _b) ? 1 \
202 #define SPA_PTROFF(ptr_,offset_,type_) ((type_*)((uintptr_t)(ptr_) + (ptrdiff_t)(offset_)))
203 #define SPA_PTROFF_ALIGN(ptr_,offset_,alignment_,type_) \
204 SPA_PTR_ALIGN(SPA_PTROFF(ptr_,offset_,type_),alignment_,type_)
209 #define SPA_MEMBER(b,o,t) SPA_PTROFF(b,o,t)
210 #define SPA_MEMBER_ALIGN(b,o,a,t) SPA_PTROFF_ALIGN(b,o,a,t)
212 #define SPA_CONTAINER_OF(p,t,m) ((t*)((uintptr_t)(p) - offsetof(t,m)))
214 #define SPA_PTRDIFF(p1,p2) ((intptr_t)(p1) - (intptr_t)(p2))
216 #define SPA_PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
217 #define SPA_UINT32_TO_PTR(u) ((void*) ((uintptr_t) (u)))
219 #define SPA_TIME_INVALID ((int64_t)INT64_MIN)
220 #define SPA_IDX_INVALID ((unsigned int)-1)
221 #define SPA_ID_INVALID ((uint32_t)0xffffffff)
223 #define SPA_NSEC_PER_SEC (1000000000LL)
224 #define SPA_NSEC_PER_MSEC (1000000ll)
225 #define SPA_NSEC_PER_USEC (1000ll)
226 #define SPA_USEC_PER_SEC (1000000ll)
227 #define SPA_USEC_PER_MSEC (1000ll)
228 #define SPA_MSEC_PER_SEC (1000ll)
230 #define SPA_TIMESPEC_TO_NSEC(ts) ((ts)->tv_sec * SPA_NSEC_PER_SEC + (ts)->tv_nsec)
231 #define SPA_TIMESPEC_TO_USEC(ts) ((ts)->tv_sec * SPA_USEC_PER_SEC + (ts)->tv_nsec / SPA_NSEC_PER_USEC)
232 #define SPA_TIMEVAL_TO_NSEC(tv) ((tv)->tv_sec * SPA_NSEC_PER_SEC + (tv)->tv_usec * SPA_NSEC_PER_USEC)
233 #define SPA_TIMEVAL_TO_USEC(tv) ((tv)->tv_sec * SPA_USEC_PER_SEC + (tv)->tv_usec)
236 #define SPA_PRINTF_FUNC(fmt, arg1) __attribute__((format(printf, fmt, arg1)))
237 #define SPA_FORMAT_ARG_FUNC(arg1) __attribute__((format_arg(arg1)))
238 #define SPA_ALIGNED(align) __attribute__((aligned(align)))
239 #define SPA_DEPRECATED __attribute__ ((deprecated))
240 #define SPA_EXPORT __attribute__((visibility("default")))
241 #define SPA_SENTINEL __attribute__((__sentinel__))
242 #define SPA_UNUSED __attribute__ ((unused))
243 #define SPA_NORETURN __attribute__ ((noreturn))
244 #define SPA_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))
246 #define SPA_PRINTF_FUNC(fmt, arg1)
247 #define SPA_FORMAT_ARG_FUNC(arg1)
248 #define SPA_ALIGNED(align)
249 #define SPA_DEPRECATED
254 #define SPA_WARN_UNUSED_RESULT
258 #define SPA_API_PROTO static inline
259 #define SPA_API_IMPL static inline
262 #ifndef SPA_API_UTILS_DEFS
264 #define SPA_API_UTILS_DEFS SPA_API_IMPL
266 #define SPA_API_UTILS_DEFS static inline
271 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
272 #define SPA_RESTRICT restrict
273 #elif defined(__GNUC__) && __GNUC__ >= 4
274 #define SPA_RESTRICT __restrict__
279 #define SPA_ROUND_DOWN(num,value) \
281 __typeof__(num) _num = (num); \
282 ((_num) - ((_num) % (value))); \
284 #define SPA_ROUND_UP(num,value) \
286 __typeof__(value) _v = (value); \
287 ((((num) + (_v) - 1) / (_v)) * (_v)); \
290 #define SPA_ROUND_MASK(num,mask) ((__typeof__(num))((mask)-1))
292 #define SPA_ROUND_DOWN_N(num,align) ((num) & ~SPA_ROUND_MASK(num, align))
293 #define SPA_ROUND_UP_N(num,align) ((((num)-1) | SPA_ROUND_MASK(num, align))+1)
295 #define SPA_SCALE32(val,num,denom) \
297 uint64_t _val = (val); \
298 uint64_t _denom = (denom); \
299 (uint32_t)(((_val) * (num)) / (_denom)); \
302 #define SPA_SCALE32_UP(val,num,denom) \
304 uint64_t _val = (val); \
305 uint64_t _denom = (denom); \
306 (uint32_t)(((_val) * (num) + (_denom)-1) / (_denom)); \
310 #define SPA_PTR_ALIGNMENT(p,align) ((uintptr_t)(p) & ((align)-1))
311 #define SPA_IS_ALIGNED(p,align) (SPA_PTR_ALIGNMENT(p,align) == 0)
312 #define SPA_PTR_ALIGN(p,align,type) ((type*)SPA_ROUND_UP_N((intptr_t)(p), (intptr_t)(align)))
316 #define SPA_LIKELY(x) (__builtin_expect(!!(x),1))
317 #define SPA_UNLIKELY(x) (__builtin_expect(!!(x),0))
319 #define SPA_LIKELY(x) (x)
320 #define SPA_UNLIKELY(x) (x)
327 if (
SPA_LIKELY((uintptr_t)p1 <= (uintptr_t)p2 && s2 <= s1 &&
328 (uintptr_t)p2 - (uintptr_t)p1 <= s1 - s2)) {
329 if (remaining != NULL)
330 *remaining = ((uintptr_t)p1 + s1) - ((uintptr_t)p2 + s2);
333 if (remaining != NULL)
340 const void *p2,
size_t s2,
size_t align,
346 if (remaining != NULL)
352 #define spa_ptr_type_inside(p1, s1, p2, type, remaining) \
353 spa_ptr_inside_and_aligned(p1, s1, p2, sizeof(type), SPA_ALIGNOF(type), remaining)
355 #define SPA_PTR_TO_INT(p) ((int) ((intptr_t) (p)))
356 #define SPA_INT_TO_PTR(u) ((void*) ((intptr_t) (u)))
358 #define SPA_STRINGIFY_1(...) #__VA_ARGS__
359 #define SPA_STRINGIFY(...) SPA_STRINGIFY_1(__VA_ARGS__)
369 #define spa_return_if_fail(expr) \
371 if (SPA_UNLIKELY(!(expr))) { \
372 fprintf(stderr, "'%s' failed at %s:%u %s()\n", \
373 #expr , __FILE__, __LINE__, __func__); \
378 #define spa_return_val_if_fail(expr, val) \
380 if (SPA_UNLIKELY(!(expr))) { \
381 fprintf(stderr, "'%s' failed at %s:%u %s()\n", \
382 #expr , __FILE__, __LINE__, __func__); \
390 #define spa_assert_se(expr) \
392 if (SPA_UNLIKELY(!(expr))) { \
393 fprintf(stderr, "'%s' failed at %s:%u %s()\n", \
394 #expr , __FILE__, __LINE__, __func__); \
399 #define spa_assert_se(expr) \
401 int _unique_var = (expr); \
408 #define spa_nop() do {} while (false)
411 #define spa_assert(expr) spa_nop()
412 #elif defined (FASTPATH)
413 #define spa_assert(expr) spa_assert_se(expr)
415 #define spa_assert(expr) spa_assert_se(expr)
419 #define spa_assert_not_reached() abort()
421 #define spa_assert_not_reached() \
423 fprintf(stderr, "Code should not be reached at %s:%u %s()\n", \
424 __FILE__, __LINE__, __func__); \
429 #define spa_memzero(x,l) (memset((x), 0, (l)))
430 #define spa_zero(x) (spa_memzero(&(x), sizeof(x)))
432 #ifdef SPA_DEBUG_MEMCPY
433 #define spa_memcpy(d,s,n) \
435 fprintf(stderr, "%s:%u %s() memcpy(%p, %p, %zd)\n", \
436 __FILE__, __LINE__, __func__, (d), (s), (size_t)(n)); \
439 #define spa_memmove(d,s,n) \
441 fprintf(stderr, "%s:%u %s() memmove(%p, %p, %zd)\n", \
442 __FILE__, __LINE__, __func__, (d), (s), (size_t)(n)); \
446 #define spa_memcpy(d,s,n) memcpy(d,s,n)
447 #define spa_memmove(d,s,n) memmove(d,s,n)
450 #define spa_aprintf(_fmt, ...) \
453 if (asprintf(&(_strp), (_fmt), ## __VA_ARGS__ ) == -1) \
SPA_API_UTILS_DEFS bool spa_ptr_inside_and_aligned(const void *p1, size_t s1, const void *p2, size_t s2, size_t align, size_t *remaining)
Definition: defs.h:413
#define SPA_API_UTILS_DEFS
Definition: defs.h:324
#define SPA_LIKELY(x)
Definition: defs.h:392
spa_direction
Definition: defs.h:106
SPA_API_UTILS_DEFS bool spa_ptrinside(const void *p1, size_t s1, const void *p2, size_t s2, size_t *remaining)
Definition: defs.h:398
#define SPA_IS_ALIGNED(p, align)
Definition: defs.h:380
@ SPA_DIRECTION_INPUT
Definition: defs.h:107
@ SPA_DIRECTION_OUTPUT
Definition: defs.h:108
int line
Definition: defs.h:440
const char * location
Definition: defs.h:443
int col
Definition: defs.h:441
size_t len
Definition: defs.h:442
const char * reason
Definition: defs.h:444
uint32_t num
Definition: defs.h:138
uint32_t denom
Definition: defs.h:139
int32_t y
Definition: defs.h:125
int32_t x
Definition: defs.h:124
uint32_t width
Definition: defs.h:117
uint32_t height
Definition: defs.h:118
struct spa_point position
Definition: defs.h:131
struct spa_rectangle size
Definition: defs.h:132