17#ifndef __STARPU_UTIL_H__
18#define __STARPU_UTIL_H__
32#ifdef STARPU_SIMGRID_MC
33#include <simgrid/modelchecker.h>
52#if defined __GNUC__ && defined __GNUC_MINOR__
53# define STARPU_GNUC_PREREQ(maj, min) \
54 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
56# define STARPU_GNUC_PREREQ(maj, min) 0
64# define STARPU_UNLIKELY(expr) (__builtin_expect(!!(expr),0))
66# define STARPU_UNLIKELY(expr) (expr)
74# define STARPU_LIKELY(expr) (__builtin_expect(!!(expr),1))
76# define STARPU_LIKELY(expr) (expr)
83# define STARPU_ATTRIBUTE_UNUSED __attribute__((unused))
85# define STARPU_ATTRIBUTE_UNUSED
92# define STARPU_ATTRIBUTE_NORETURN __attribute__((noreturn))
94# define STARPU_ATTRIBUTE_NORETURN
101# define STARPU_ATTRIBUTE_INTERNAL __attribute__ ((visibility ("internal")))
103# define STARPU_ATTRIBUTE_INTERNAL
110# define STARPU_ATTRIBUTE_MALLOC __attribute__((malloc))
112# define STARPU_ATTRIBUTE_MALLOC
119# define STARPU_ATTRIBUTE_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
121# define STARPU_ATTRIBUTE_WARN_UNUSED_RESULT
128# define STARPU_ATTRIBUTE_PURE __attribute__((pure))
130# define STARPU_ATTRIBUTE_PURE
137# define STARPU_ATTRIBUTE_ALIGNED(size) __attribute__((aligned(size)))
139# define STARPU_ATTRIBUTE_ALIGNED(size)
143# define STARPU_ATTRIBUTE_FORMAT(type, string, first) __attribute__((format(type, string, first)))
145# define STARPU_ATTRIBUTE_FORMAT(type, string, first)
150#if defined(c_plusplus) || defined(__cplusplus)
151# define STARPU_INLINE inline
152#elif defined(_MSC_VER) || defined(__HP_cc)
153# define STARPU_INLINE __inline
155# define STARPU_INLINE __inline__
158#if STARPU_GNUC_PREREQ(4, 3)
159# define STARPU_ATTRIBUTE_CALLOC_SIZE(num,size) __attribute__((alloc_size(num,size)))
160# define STARPU_ATTRIBUTE_ALLOC_SIZE(size) __attribute__((alloc_size(size)))
162# define STARPU_ATTRIBUTE_CALLOC_SIZE(num,size)
163# define STARPU_ATTRIBUTE_ALLOC_SIZE(size)
166#if STARPU_GNUC_PREREQ(3, 1) && !defined(BUILDING_STARPU) && !defined(STARPU_USE_DEPRECATED_API) && !defined(STARPU_USE_DEPRECATED_ONE_ZERO_API)
167#define STARPU_DEPRECATED __attribute__((__deprecated__))
169#define STARPU_DEPRECATED
172#if STARPU_GNUC_PREREQ(3,3)
173#define STARPU_WARN_UNUSED_RESULT __attribute__((__warn_unused_result__))
175#define STARPU_WARN_UNUSED_RESULT
178#define STARPU_BACKTRACE_LENGTH 32
180# define STARPU_DUMP_BACKTRACE() do { \
181 void *__ptrs[STARPU_BACKTRACE_LENGTH]; \
182 int __n = backtrace(__ptrs, STARPU_BACKTRACE_LENGTH); \
183 backtrace_symbols_fd(__ptrs, __n, 2); \
186# define STARPU_DUMP_BACKTRACE() do { } while (0)
189#ifdef STARPU_SIMGRID_MC
190#define STARPU_SIMGRID_ASSERT(x) MC_assert(!!(x))
192#define STARPU_SIMGRID_ASSERT(x)
199#ifdef STARPU_NO_ASSERT
200#define STARPU_ASSERT(x) do { if (0) { (void) (x); } } while(0)
202# if defined(__CUDACC__) || defined(STARPU_HAVE_WINDOWS)
203# define STARPU_ASSERT(x) do { if (STARPU_UNLIKELY(!(x))) { STARPU_DUMP_BACKTRACE(); STARPU_SIMGRID_ASSERT(0 && #x); *(int*)NULL = 0; } } while(0)
205# define STARPU_ASSERT(x) do { if (STARPU_UNLIKELY(!(x))) { STARPU_DUMP_BACKTRACE(); STARPU_SIMGRID_ASSERT(0 && #x); assert(0 && #x); } } while (0)
209#ifdef STARPU_NO_ASSERT
210#define STARPU_ASSERT_ACCESSIBLE(x) do { if (0) { (void) (x); } } while(0)
212#define STARPU_ASSERT_ACCESSIBLE(ptr) do { volatile char __c STARPU_ATTRIBUTE_UNUSED = *(char*) (ptr); } while(0)
220#ifdef STARPU_NO_ASSERT
221#define STARPU_ASSERT_MSG(x, msg, ...) do { if (0) { (void) (x); (void) msg; } } while(0)
223# if defined(__INTEL_COMPILER)
224# pragma warning disable 279
226# if defined(__CUDACC__) || defined(STARPU_HAVE_WINDOWS)
227# define STARPU_ASSERT_MSG(x, msg, ...) do { if (STARPU_UNLIKELY(!(x))) { STARPU_DUMP_BACKTRACE(); fprintf(stderr, "\n[starpu][%s][assert failure] " msg "\n\n", __starpu_func__, ## __VA_ARGS__); STARPU_SIMGRID_ASSERT(0 && #x); *(int*)NULL = 0; }} while(0)
229# define STARPU_ASSERT_MSG(x, msg, ...) do { if (STARPU_UNLIKELY(!(x))) { STARPU_DUMP_BACKTRACE(); fprintf(stderr, "\n[starpu][%s][assert failure] " msg "\n\n", __starpu_func__, ## __VA_ARGS__); STARPU_SIMGRID_ASSERT(0 && #x); assert(0 && #x); } } while(0)
234# ifdef __clang_analyzer__
235# define _starpu_abort() exit(42)
237# define _starpu_abort() *(volatile int*)NULL = 0
240# define _starpu_abort() abort()
246#define STARPU_ABORT() do { \
247 STARPU_DUMP_BACKTRACE(); \
248 fprintf(stderr, "[starpu][abort][%s()@%s:%d]\n", __starpu_func__, __FILE__, __LINE__); \
257#define STARPU_ABORT_MSG(msg, ...) do { \
258 STARPU_DUMP_BACKTRACE(); \
259 fprintf(stderr, "[starpu][abort][%s()@%s:%d] " msg "\n", __starpu_func__, __FILE__, __LINE__, ## __VA_ARGS__); \
264 #undef STARPU_HAVE_STRERROR_R
267#if defined(STARPU_HAVE_STRERROR_R)
268#if (! defined(__GLIBC__) || !__GLIBC__) || ((_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && (! defined(_GNU_SOURCE)))
270# define starpu_strerror_r(errnum, buf, buflen) \
273 int _ret = strerror_r((errnum), (buf), (buflen)); \
274 STARPU_ASSERT(_ret == 0); \
279# define starpu_strerror_r(errnum, buf, buflen) \
282 char * const _user_buf = (buf); \
283 const size_t _user_buflen = (buflen); \
285 STARPU_ASSERT((buf) != NULL); \
286 char * _tmp_buf = strerror_r((errnum), _user_buf, _user_buflen); \
287 if (_tmp_buf != _user_buf) \
289 if (_user_buflen > 0) \
291 strncpy(_user_buf, _tmp_buf, _user_buflen-1); \
292 _user_buf[_user_buflen-1] = '\0'; \
304#if defined(STARPU_HAVE_STRERROR_R)
305# define STARPU_CHECK_RETURN_VALUE(err, message, ...) {if (STARPU_UNLIKELY(err != 0)) { \
306 char xmessage[256]; starpu_strerror_r(-err, xmessage, 256); \
307 fprintf(stderr, "[starpu] Unexpected value: <%d:%s> returned for " message "\n", err, xmessage, ## __VA_ARGS__); \
310# define STARPU_CHECK_RETURN_VALUE(err, message, ...) {if (STARPU_UNLIKELY(err != 0)) { \
311 fprintf(stderr, "[starpu] Unexpected value: <%d> returned for " message "\n", err, ## __VA_ARGS__); \
319#if defined(STARPU_HAVE_STRERROR_R)
320# define STARPU_CHECK_RETURN_VALUE_IS(err, value, message, ...) {if (STARPU_UNLIKELY(err != value)) { \
321 char xmessage[256]; starpu_strerror_r(-err, xmessage, 256); \
322 fprintf(stderr, "[starpu] Unexpected value: <%d!=%d:%s> returned for " message "\n", err, value, xmessage, ## __VA_ARGS__); \
325# define STARPU_CHECK_RETURN_VALUE_IS(err, value, message, ...) {if (STARPU_UNLIKELY(err != value)) { \
326 fprintf(stderr, "[starpu] Unexpected value: <%d != %d> returned for " message "\n", err, value, ## __VA_ARGS__); \
336#if defined(__i386__) || defined(__x86_64__)
337static __starpu_inline
unsigned _starpu_cmpxchg(
unsigned *ptr,
unsigned old,
unsigned next)
339 __asm__ __volatile__(
"lock cmpxchgl %2,%1":
"+a" (old),
"+m" (*ptr) :
"q" (next) :
"memory");
342#define STARPU_HAVE_CMPXCHG
343static __starpu_inline
unsigned _starpu_xchg(
unsigned *ptr,
unsigned next)
346 __asm__ __volatile__(
"xchgl %1,%0":
"+m" (*ptr),
"+q" (next) : :
"memory");
349#define STARPU_HAVE_XCHG
351static __starpu_inline uint32_t _starpu_cmpxchg32(uint32_t *ptr, uint32_t old, uint32_t next)
353 __asm__ __volatile__(
"lock cmpxchgl %2,%1":
"+a" (old),
"+m" (*ptr) :
"q" (next) :
"memory");
356#define STARPU_HAVE_CMPXCHG32
357static __starpu_inline uint32_t _starpu_xchg32(uint32_t *ptr, uint32_t next)
360 __asm__ __volatile__(
"xchgl %1,%0":
"+m" (*ptr),
"+q" (next) : :
"memory");
363#define STARPU_HAVE_XCHG32
366static __starpu_inline
unsigned long _starpu_cmpxchgl(
unsigned long *ptr,
unsigned long old,
unsigned long next)
368 __asm__ __volatile__(
"lock cmpxchgl %2,%1":
"+a" (old),
"+m" (*ptr) :
"q" (next) :
"memory");
371#define STARPU_HAVE_CMPXCHGL
372static __starpu_inline
unsigned long _starpu_xchgl(
unsigned long *ptr,
unsigned long next)
375 __asm__ __volatile__(
"xchgl %1,%0":
"+m" (*ptr),
"+q" (next) : :
"memory");
378#define STARPU_HAVE_XCHGL
381#if defined(__x86_64__)
382static __starpu_inline
unsigned long _starpu_cmpxchgl(
unsigned long *ptr,
unsigned long old,
unsigned long next)
384 __asm__ __volatile__(
"lock cmpxchgq %2,%1":
"+a" (old),
"+m" (*ptr) :
"q" (next) :
"memory");
387#define STARPU_HAVE_CMPXCHGL
388static __starpu_inline
unsigned long _starpu_xchgl(
unsigned long *ptr,
unsigned long next)
391 __asm__ __volatile__(
"xchgq %1,%0":
"+m" (*ptr),
"+q" (next) : :
"memory");
394#define STARPU_HAVE_XCHGL
398static __starpu_inline uint64_t _starpu_cmpxchg64(uint64_t *ptr, uint64_t old, uint64_t next)
400 uint32_t next_hi = next >> 32;
401 uint32_t next_lo = next & 0xfffffffful;
402 __asm__ __volatile__(
"lock cmpxchg8b %1":
"+A" (old),
"+m" (*ptr) :
"c" (next_hi),
"b" (next_lo) :
"memory");
405#define STARPU_HAVE_CMPXCHG64
408#if defined(__x86_64__)
409static __starpu_inline uint64_t _starpu_cmpxchg64(uint64_t *ptr, uint64_t old, uint64_t next)
411 __asm__ __volatile__(
"lock cmpxchgq %2,%1":
"+a" (old),
"+m" (*ptr) :
"q" (next) :
"memory");
414#define STARPU_HAVE_CMPXCHG64
415static __starpu_inline uint64_t _starpu_xchg64(uint64_t *ptr, uint64_t next)
418 __asm__ __volatile__(
"xchgq %1,%0":
"+m" (*ptr),
"+q" (next) : :
"memory");
421#define STARPU_HAVE_XCHG64
426#define STARPU_ATOMIC_SOMETHING(name,expr) \
427static __starpu_inline unsigned starpu_atomic_##name(unsigned *ptr, unsigned value) \
429 unsigned old, next; \
434 if (_starpu_cmpxchg(ptr, old, next) == old) \
439#define STARPU_ATOMIC_SOMETHINGL(name,expr) \
440static __starpu_inline unsigned long starpu_atomic_##name##l(unsigned long *ptr, unsigned long value) \
442 unsigned long old, next; \
447 if (_starpu_cmpxchgl(ptr, old, next) == old) \
452#define STARPU_ATOMIC_SOMETHING64(name,expr) \
453static __starpu_inline uint64_t starpu_atomic_##name##64(uint64_t *ptr, uint64_t value) \
455 uint64_t old, next; \
460 if (_starpu_cmpxchg64(ptr, old, next) == old) \
467#ifdef STARPU_HAVE_SYNC_FETCH_AND_ADD
468#define STARPU_ATOMIC_ADD(ptr, value) (__sync_fetch_and_add ((ptr), (value)) + (value))
469#define STARPU_ATOMIC_ADDL(ptr, value) (__sync_fetch_and_add ((ptr), (value)) + (value))
470#define STARPU_ATOMIC_ADD64(ptr, value) (__sync_fetch_and_add ((ptr), (value)) + (value))
472#if defined(STARPU_HAVE_CMPXCHG)
473STARPU_ATOMIC_SOMETHING(add, old + value)
474#define STARPU_ATOMIC_ADD(ptr, value) starpu_atomic_add(ptr, value)
476#if defined(STARPU_HAVE_CMPXCHGL)
477STARPU_ATOMIC_SOMETHINGL(add, old + value)
478#define STARPU_ATOMIC_ADDL(ptr, value) starpu_atomic_addl(ptr, value)
480#if defined(STARPU_HAVE_CMPXCHG64)
481STARPU_ATOMIC_SOMETHING64(add, old + value)
482#define STARPU_ATOMIC_ADD64(ptr, value) starpu_atomic_add64(ptr, value)
486#ifdef STARPU_HAVE_SYNC_FETCH_AND_OR
487#define STARPU_ATOMIC_OR(ptr, value) (__sync_fetch_and_or ((ptr), (value)))
488#define STARPU_ATOMIC_ORL(ptr, value) (__sync_fetch_and_or ((ptr), (value)))
489#define STARPU_ATOMIC_OR64(ptr, value) (__sync_fetch_and_or ((ptr), (value)))
491#if defined(STARPU_HAVE_CMPXCHG)
492STARPU_ATOMIC_SOMETHING(or, old | value)
493#define STARPU_ATOMIC_OR(ptr, value) starpu_atomic_or(ptr, value)
495#if defined(STARPU_HAVE_CMPXCHGL)
496STARPU_ATOMIC_SOMETHINGL(or, old | value)
497#define STARPU_ATOMIC_ORL(ptr, value) starpu_atomic_orl(ptr, value)
499#if defined(STARPU_HAVE_CMPXCHG64)
500STARPU_ATOMIC_SOMETHING64(or, old | value)
501#define STARPU_ATOMIC_OR64(ptr, value) starpu_atomic_or64(ptr, value)
506#ifdef STARPU_HAVE_SYNC_BOOL_COMPARE_AND_SWAP
507#define STARPU_BOOL_COMPARE_AND_SWAP(ptr, old, value) (__sync_bool_compare_and_swap ((ptr), (old), (value)))
508#define STARPU_BOOL_COMPARE_AND_SWAP32(ptr, old, value) STARPU_BOOL_COMPARE_AND_SWAP(ptr, old, value)
509#define STARPU_BOOL_COMPARE_AND_SWAP64(ptr, old, value) STARPU_BOOL_COMPARE_AND_SWAP(ptr, old, value)
511#ifdef STARPU_HAVE_CMPXCHG
512#define STARPU_BOOL_COMPARE_AND_SWAP(ptr, old, value) (_starpu_cmpxchg((ptr), (old), (value)) == (old))
514#ifdef STARPU_HAVE_CMPXCHG32
515#define STARPU_BOOL_COMPARE_AND_SWAP32(ptr, old, value) (_starpu_cmpxchg32((ptr), (old), (value)) == (old))
517#ifdef STARPU_HAVE_CMPXCHG64
518#define STARPU_BOOL_COMPARE_AND_SWAP64(ptr, old, value) (_starpu_cmpxchg64((ptr), (old), (value)) == (old))
522#if UINTPTR_MAX == UINT64_MAX
523#define STARPU_BOOL_COMPARE_AND_SWAP_PTR(ptr, old, value) STARPU_BOOL_COMPARE_AND_SWAP64(ptr, old, value)
525#define STARPU_BOOL_COMPARE_AND_SWAP_PTR(ptr, old, value) STARPU_BOOL_COMPARE_AND_SWAP32(ptr, old, value)
529#ifdef STARPU_HAVE_SYNC_VAL_COMPARE_AND_SWAP
530#define STARPU_VAL_COMPARE_AND_SWAP(ptr, old, value) (__sync_val_compare_and_swap ((ptr), (old), (value)))
531#define STARPU_VAL_COMPARE_AND_SWAP32(ptr, old, value) STARPU_VAL_COMPARE_AND_SWAP(ptr, old, value)
532#define STARPU_VAL_COMPARE_AND_SWAP64(ptr, old, value) STARPU_VAL_COMPARE_AND_SWAP(ptr, old, value)
534#ifdef STARPU_HAVE_CMPXCHG
535#define STARPU_VAL_COMPARE_AND_SWAP(ptr, old, value) (_starpu_cmpxchg((ptr), (old), (value)))
537#ifdef STARPU_HAVE_CMPXCHG32
538#define STARPU_VAL_COMPARE_AND_SWAP32(ptr, old, value) (_starpu_cmpxchg32((ptr), (old), (value)))
540#ifdef STARPU_HAVE_CMPXCHG64
541#define STARPU_VAL_COMPARE_AND_SWAP64(ptr, old, value) (_starpu_cmpxchg64((ptr), (old), (value)))
545#if UINTPTR_MAX == UINT64_MAX
546#define STARPU_VAL_COMPARE_AND_SWAP_PTR(ptr, old, value) STARPU_VAL_COMPARE_AND_SWAP64(ptr, old, value)
548#define STARPU_VAL_COMPARE_AND_SWAP_PTR(ptr, old, value) STARPU_VAL_COMPARE_AND_SWAP32(ptr, old, value)
551#ifdef STARPU_HAVE_ATOMIC_EXCHANGE_N
552#define STARPU_VAL_EXCHANGE(ptr, value) (__atomic_exchange_n((ptr), (value), __ATOMIC_SEQ_CST))
553#define STARPU_VAL_EXCHANGEL(ptr, value) STARPU_VAL_EXCHANGE((ptr) (value))
554#define STARPU_VAL_EXCHANGE32(ptr, value) STARPU_VAL_EXCHANGE((ptr) (value))
555#define STARPU_VAL_EXCHANGE64(ptr, value) STARPU_VAL_EXCHANGE((ptr) (value))
557#ifdef STARPU_HAVE_XCHG
558#define STARPU_VAL_EXCHANGE(ptr, value) (_starpu_xchg((ptr), (value)))
560#ifdef STARPU_HAVE_XCHGL
561#define STARPU_VAL_EXCHANGEL(ptr, value) (_starpu_xchgl((ptr), (value)))
563#ifdef STARPU_HAVE_XCHG32
564#define STARPU_VAL_EXCHANGE32(ptr, value) (_starpu_xchg32((ptr), (value)))
566#ifdef STARPU_HAVE_XCHG64
567#define STARPU_VAL_EXCHANGE64(ptr, value) (_starpu_xchg64((ptr), (value)))
572#ifdef STARPU_HAVE_SYNC_LOCK_TEST_AND_SET
573#define STARPU_TEST_AND_SET(ptr, value) (__sync_lock_test_and_set ((ptr), (value)))
574#define STARPU_RELEASE(ptr) (__sync_lock_release ((ptr)))
575#elif defined(STARPU_HAVE_XCHG)
576#define STARPU_TEST_AND_SET(ptr, value) (_starpu_xchg((ptr), (value)))
577#define STARPU_RELEASE(ptr) (_starpu_xchg((ptr), 0))
580#ifdef STARPU_HAVE_SYNC_SYNCHRONIZE
581#define STARPU_SYNCHRONIZE() __sync_synchronize()
582#elif defined(__i386__)
583#define STARPU_SYNCHRONIZE() __asm__ __volatile__("lock; addl $0,0(%%esp)" ::: "memory")
584#elif defined(__KNC__) || defined(__KNF__)
585#define STARPU_SYNCHRONIZE() __asm__ __volatile__("lock; addl $0,0(%%rsp)" ::: "memory")
586#elif defined(__x86_64__)
587#define STARPU_SYNCHRONIZE() __asm__ __volatile__("mfence" ::: "memory")
588#elif defined(__ppc__) || defined(__ppc64__)
589#define STARPU_SYNCHRONIZE() __asm__ __volatile__("sync" ::: "memory")
595#if defined(__x86_64__)
596#define STARPU_RMB() __asm__ __volatile__("lfence" ::: "memory")
597#elif defined(__aarch64__)
598#define STARPU_RMB() __asm__ __volatile__("dsb ld" ::: "memory")
600#define STARPU_RMB() STARPU_SYNCHRONIZE()
606#if defined(__x86_64__)
607#define STARPU_WMB() __asm__ __volatile__("sfence" ::: "memory")
608#elif defined(__aarch64__)
609#define STARPU_WMB() __asm__ __volatile__("dsb st" ::: "memory")
611#define STARPU_WMB() STARPU_SYNCHRONIZE()
614#if defined(__i386__) || defined(__x86_64__)
615#define STARPU_CACHELINE_SIZE 64
616#elif defined(__ppc__) || defined(__ppc64__) || defined(__ia64__)
617#define STARPU_CACHELINE_SIZE 128
618#elif defined(__s390__) || defined(__s390x__)
619#define STARPU_CACHELINE_SIZE 256
622#define STARPU_CACHELINE_SIZE 1024
627#include <sys/types.h>
633#if !defined(_MSC_VER) || defined(BUILDING_STARPU)
636#if !defined(STARPU_HAVE_STRUCT_TIMESPEC) || (defined(_MSC_VER) && _MSC_VER < 1900)
638#ifndef STARPU_TIMESPEC_DEFINED
639#define STARPU_TIMESPEC_DEFINED 1
648#if defined(__MINGW32__) || defined(__CYGWIN__)