/* StarPU --- Runtime system for heterogeneous multicore architectures. * * Copyright (C) 2010-2017 Université de Bordeaux * Copyright (C) 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017 CNRS * * StarPU 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. * * StarPU 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 in COPYING.LGPL for more details. */ #ifndef __STARPU_UTIL_H__ #define __STARPU_UTIL_H__ #include #include #include #include #include #include #ifdef __GLIBC__ #include #endif #ifdef STARPU_SIMGRID_MC #include #endif #ifdef __cplusplus extern "C" { #endif #if defined __GNUC__ && defined __GNUC_MINOR__ # define STARPU_GNUC_PREREQ(maj, min) \ ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min)) #else # define STARPU_GNUC_PREREQ(maj, min) 0 #endif #ifdef __GNUC__ # define STARPU_UNLIKELY(expr) (__builtin_expect(!!(expr),0)) # define STARPU_LIKELY(expr) (__builtin_expect(!!(expr),1)) # define STARPU_ATTRIBUTE_UNUSED __attribute__((unused)) # define STARPU_ATTRIBUTE_NORETURN __attribute__((noreturn)) # define STARPU_ATTRIBUTE_INTERNAL __attribute__ ((visibility ("internal"))) # define STARPU_ATTRIBUTE_MALLOC __attribute__((malloc)) # define STARPU_ATTRIBUTE_WARN_UNUSED_RESULT __attribute__((warn_unused_result)) # define STARPU_ATTRIBUTE_PURE __attribute__((pure)) # define STARPU_ATTRIBUTE_ALIGNED(size) __attribute__((aligned(size))) # define STARPU_ATTRIBUTE_FORMAT(type, string, first) __attribute__((format(type, string, first))) #else # define STARPU_UNLIKELY(expr) (expr) # define STARPU_LIKELY(expr) (expr) # define STARPU_ATTRIBUTE_UNUSED # define STARPU_ATTRIBUTE_NORETURN # define STARPU_ATTRIBUTE_INTERNAL # define STARPU_ATTRIBUTE_MALLOC # define STARPU_ATTRIBUTE_WARN_UNUSED_RESULT # define STARPU_ATTRIBUTE_PURE # define STARPU_ATTRIBUTE_ALIGNED(size) # define STARPU_ATTRIBUTE_FORMAT(type, string, first) #endif /* Note that if we're compiling C++, then just use the "inline" keyword, since it's part of C++ */ #if defined(c_plusplus) || defined(__cplusplus) # define STARPU_INLINE inline #elif defined(_MSC_VER) || defined(__HP_cc) # define STARPU_INLINE __inline #else # define STARPU_INLINE __inline__ #endif #if STARPU_GNUC_PREREQ(4, 3) # define STARPU_ATTRIBUTE_CALLOC_SIZE(num,size) __attribute__((alloc_size(num,size))) # define STARPU_ATTRIBUTE_ALLOC_SIZE(size) __attribute__((alloc_size(size))) #else # define STARPU_ATTRIBUTE_CALLOC_SIZE(num,size) # define STARPU_ATTRIBUTE_ALLOC_SIZE(size) #endif #if STARPU_GNUC_PREREQ(3, 1) && !defined(BUILDING_STARPU) && !defined(STARPU_USE_DEPRECATED_API) && !defined(STARPU_USE_DEPRECATED_ONE_ZERO_API) #define STARPU_DEPRECATED __attribute__((__deprecated__)) #else #define STARPU_DEPRECATED #endif /* __GNUC__ */ #if STARPU_GNUC_PREREQ(3,3) #define STARPU_WARN_UNUSED_RESULT __attribute__((__warn_unused_result__)) #else #define STARPU_WARN_UNUSED_RESULT #endif /* __GNUC__ */ #define STARPU_POISON_PTR ((void *)0xdeadbeef) #define STARPU_MIN(a,b) ((a)<(b)?(a):(b)) #define STARPU_MAX(a,b) ((a)<(b)?(b):(a)) #define STARPU_BACKTRACE_LENGTH 32 #ifdef __GLIBC__ # define STARPU_DUMP_BACKTRACE() do { \ void *__ptrs[STARPU_BACKTRACE_LENGTH]; \ int __n = backtrace(__ptrs, STARPU_BACKTRACE_LENGTH); \ backtrace_symbols_fd(__ptrs, __n, 2); \ } while (0) #else # define STARPU_DUMP_BACKTRACE() do { } while (0) #endif #ifdef STARPU_SIMGRID_MC #define STARPU_SIMGRID_ASSERT(x) MC_assert(!!(x)) #else #define STARPU_SIMGRID_ASSERT(x) #endif #ifdef STARPU_NO_ASSERT #define STARPU_ASSERT(x) do { if (0) { (void) (x); } } while(0) #define STARPU_ASSERT_ACCESSIBLE(x) do { if (0) { (void) (x); } } while(0) #define STARPU_ASSERT_MSG(x, msg, ...) do { if (0) { (void) (x); (void) msg; } } while(0) #else # if defined(__CUDACC__) || defined(STARPU_HAVE_WINDOWS) # define STARPU_ASSERT(x) do { if (STARPU_UNLIKELY(!(x))) { STARPU_DUMP_BACKTRACE(); STARPU_SIMGRID_ASSERT(x); *(int*)NULL = 0; } } while(0) # 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(x); *(int*)NULL = 0; }} while(0) # else # define STARPU_ASSERT(x) do { if (STARPU_UNLIKELY(!(x))) { STARPU_DUMP_BACKTRACE(); STARPU_SIMGRID_ASSERT(x); assert(x); } } while (0) # 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(x); assert(x); } } while(0) # endif # define STARPU_ASSERT_ACCESSIBLE(ptr) do { \ volatile char __c STARPU_ATTRIBUTE_UNUSED = *(char*) (ptr); \ } while(0) #endif #ifdef __APPLE_CC__ # define _starpu_abort() *(volatile int*)NULL = 0 #else # define _starpu_abort() abort() #endif #define STARPU_ABORT() do { \ STARPU_DUMP_BACKTRACE(); \ fprintf(stderr, "[starpu][abort][%s()@%s:%d]\n", __starpu_func__, __FILE__, __LINE__); \ _starpu_abort(); \ } while(0) #define STARPU_ABORT_MSG(msg, ...) do { \ STARPU_DUMP_BACKTRACE(); \ fprintf(stderr, "[starpu][abort][%s()@%s:%d] " msg "\n", __starpu_func__, __FILE__, __LINE__, ## __VA_ARGS__); \ _starpu_abort(); \ } while(0) #if defined(STARPU_HAVE_STRERROR_R) #if !__GLIBC__ || ((_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && ! _GNU_SOURCE) /* XSI-compliant version of strerror_r returns an int */ #define starpu_strerror_r(errnum, buf, buflen) \ do \ { \ int _ret = strerror_r((errnum), (buf), (buflen)); \ STARPU_ASSERT(_ret == 0); \ } \ while (0) #else /* GNU-specific version of strerror_r returns a char * */ #define starpu_strerror_r(errnum, buf, buflen) \ do \ { \ char * const _user_buf = (buf); \ const size_t _user_buflen = (buflen); \ /* the GNU-specific behaviour when 'buf' == NULL cannot be emulated with the XSI-compliant version */ \ STARPU_ASSERT((buf) != NULL); \ char * _tmp_buf = strerror_r((errnum), _user_buf, _user_buflen); \ if (_tmp_buf != _user_buf) \ { \ if (_user_buflen > 0) \ { \ strncpy(_user_buf, _tmp_buf, _user_buflen); \ _user_buf[_user_buflen-1] = '\0'; \ } \ } \ } \ while (0) #endif /* strerror_r ABI version */ # define STARPU_CHECK_RETURN_VALUE(err, message, ...) {if (STARPU_UNLIKELY(err != 0)) { \ char xmessage[256]; starpu_strerror_r(-err, xmessage, 256); \ fprintf(stderr, "[starpu] Unexpected value: <%d:%s> returned for " message "\n", err, xmessage, ## __VA_ARGS__); \ STARPU_ABORT(); }} # define STARPU_CHECK_RETURN_VALUE_IS(err, value, message, ...) {if (STARPU_UNLIKELY(err != value)) { \ char xmessage[256]; starpu_strerror_r(-err, xmessage, 256); \ fprintf(stderr, "[starpu] Unexpected value: <%d!=%d:%s> returned for " message "\n", err, value, xmessage, ## __VA_ARGS__); \ STARPU_ABORT(); }} #else # define STARPU_CHECK_RETURN_VALUE(err, message, ...) {if (STARPU_UNLIKELY(err != 0)) { \ fprintf(stderr, "[starpu] Unexpected value: <%d> returned for " message "\n", err, ## __VA_ARGS__); \ STARPU_ABORT(); }} # define STARPU_CHECK_RETURN_VALUE_IS(err, value, message, ...) {if (STARPU_UNLIKELY(err != value)) { \ fprintf(stderr, "[starpu] Unexpected value: <%d != %d> returned for " message "\n", err, value, ## __VA_ARGS__); \ STARPU_ABORT(); }} #endif /* STARPU_HAVE_STRERROR_R */ #if defined(__i386__) || defined(__x86_64__) static __starpu_inline unsigned starpu_cmpxchg(unsigned *ptr, unsigned old, unsigned next) { __asm__ __volatile__("lock cmpxchgl %2,%1": "+a" (old), "+m" (*ptr) : "q" (next) : "memory"); return old; } static __starpu_inline unsigned starpu_xchg(unsigned *ptr, unsigned next) { /* Note: xchg is always locked already */ __asm__ __volatile__("xchgl %1,%0": "+m" (*ptr), "+q" (next) : : "memory"); return next; } #define STARPU_HAVE_XCHG #if defined(__i386__) static __starpu_inline unsigned long starpu_cmpxchgl(unsigned long *ptr, unsigned long old, unsigned long next) { __asm__ __volatile__("lock cmpxchgl %2,%1": "+a" (old), "+m" (*ptr) : "q" (next) : "memory"); return old; } static __starpu_inline unsigned long starpu_xchgl(unsigned long *ptr, unsigned long next) { /* Note: xchg is always locked already */ __asm__ __volatile__("xchgl %1,%0": "+m" (*ptr), "+q" (next) : : "memory"); return next; } #define STARPU_HAVE_XCHGL #endif #if defined(__x86_64__) static __starpu_inline unsigned long starpu_cmpxchgl(unsigned long *ptr, unsigned long old, unsigned long next) { __asm__ __volatile__("lock cmpxchgq %2,%1": "+a" (old), "+m" (*ptr) : "q" (next) : "memory"); return old; } static __starpu_inline unsigned long starpu_xchgl(unsigned long *ptr, unsigned long next) { /* Note: xchg is always locked already */ __asm__ __volatile__("xchgq %1,%0": "+m" (*ptr), "+q" (next) : : "memory"); return next; } #define STARPU_HAVE_XCHGL #endif #endif #define STARPU_ATOMIC_SOMETHING(name,expr) \ static __starpu_inline unsigned starpu_atomic_##name(unsigned *ptr, unsigned value) \ { \ unsigned old, next; \ while (1) \ { \ old = *ptr; \ next = expr; \ if (starpu_cmpxchg(ptr, old, next) == old) \ break; \ }; \ return expr; \ } #define STARPU_ATOMIC_SOMETHINGL(name,expr) \ static __starpu_inline unsigned long starpu_atomic_##name##l(unsigned long *ptr, unsigned long value) \ { \ unsigned long old, next; \ while (1) \ { \ old = *ptr; \ next = expr; \ if (starpu_cmpxchgl(ptr, old, next) == old) \ break; \ }; \ return expr; \ } /* Returns the new value */ #ifdef STARPU_HAVE_SYNC_FETCH_AND_ADD #define STARPU_ATOMIC_ADD(ptr, value) (__sync_fetch_and_add ((ptr), (value)) + (value)) #define STARPU_ATOMIC_ADDL(ptr, value) (__sync_fetch_and_add ((ptr), (value)) + (value)) #else #if defined(STARPU_HAVE_XCHG) STARPU_ATOMIC_SOMETHING(add, old + value) #define STARPU_ATOMIC_ADD(ptr, value) starpu_atomic_add(ptr, value) #endif #if defined(STARPU_HAVE_XCHGL) STARPU_ATOMIC_SOMETHINGL(add, old + value) #define STARPU_ATOMIC_ADDL(ptr, value) starpu_atomic_addl(ptr, value) #endif #endif #ifdef STARPU_HAVE_SYNC_FETCH_AND_OR #define STARPU_ATOMIC_OR(ptr, value) (__sync_fetch_and_or ((ptr), (value))) #define STARPU_ATOMIC_ORL(ptr, value) (__sync_fetch_and_or ((ptr), (value))) #else #if defined(STARPU_HAVE_XCHG) STARPU_ATOMIC_SOMETHING(or, old | value) #define STARPU_ATOMIC_OR(ptr, value) starpu_atomic_or(ptr, value) #endif #if defined(STARPU_HAVE_XCHGL) STARPU_ATOMIC_SOMETHINGL(or, old | value) #define STARPU_ATOMIC_ORL(ptr, value) starpu_atomic_orl(ptr, value) #endif #endif #ifdef STARPU_HAVE_SYNC_BOOL_COMPARE_AND_SWAP #define STARPU_BOOL_COMPARE_AND_SWAP(ptr, old, value) (__sync_bool_compare_and_swap ((ptr), (old), (value))) #elif defined(STARPU_HAVE_XCHG) #define STARPU_BOOL_COMPARE_AND_SWAP(ptr, old, value) (starpu_cmpxchg((ptr), (old), (value)) == (old)) #endif #ifdef STARPU_HAVE_SYNC_VAL_COMPARE_AND_SWAP #define STARPU_VAL_COMPARE_AND_SWAP(ptr, old, value) (__sync_val_compare_and_swap ((ptr), (old), (value))) #elif defined(STARPU_HAVE_XCHG) #define STARPU_VAL_COMPARE_AND_SWAP(ptr, old, value) (starpu_cmpxchg((ptr), (old), (value))) #endif #ifdef STARPU_HAVE_SYNC_LOCK_TEST_AND_SET #define STARPU_TEST_AND_SET(ptr, value) (__sync_lock_test_and_set ((ptr), (value))) #define STARPU_RELEASE(ptr) (__sync_lock_release ((ptr))) #elif defined(STARPU_HAVE_XCHG) #define STARPU_TEST_AND_SET(ptr, value) (starpu_xchg((ptr), (value))) #define STARPU_RELEASE(ptr) (starpu_xchg((ptr), 0)) #endif #ifdef STARPU_HAVE_SYNC_SYNCHRONIZE #define STARPU_SYNCHRONIZE() __sync_synchronize() #elif defined(__i386__) #define STARPU_SYNCHRONIZE() __asm__ __volatile__("lock; addl $0,0(%%esp)" ::: "memory") #elif defined(__KNC__) || defined(__KNF__) #define STARPU_SYNCHRONIZE() __asm__ __volatile__("lock; addl $0,0(%%rsp)" ::: "memory") #elif defined(__x86_64__) #define STARPU_SYNCHRONIZE() __asm__ __volatile__("mfence" ::: "memory") #elif defined(__ppc__) || defined(__ppc64__) #define STARPU_SYNCHRONIZE() __asm__ __volatile__("sync" ::: "memory") #endif #if defined(__i386__) #define STARPU_RMB() __asm__ __volatile__("lock; addl $0,0(%%esp)" ::: "memory") #define STARPU_WMB() __asm__ __volatile__("lock; addl $0,0(%%esp)" ::: "memory") #elif defined(__KNC__) || defined(__KNF__) #define STARPU_RMB() __asm__ __volatile__("lock; addl $0,0(%%rsp)" ::: "memory") #define STARPU_WMB() __asm__ __volatile__("lock; addl $0,0(%%rsp)" ::: "memory") #elif defined(__x86_64__) #define STARPU_RMB() __asm__ __volatile__("lfence" ::: "memory") #define STARPU_WMB() __asm__ __volatile__("sfence" ::: "memory") #elif defined(__ppc__) || defined(__ppc64__) #define STARPU_RMB() __asm__ __volatile__("sync" ::: "memory") #define STARPU_WMB() __asm__ __volatile__("sync" ::: "memory") #else #define STARPU_RMB() STARPU_SYNCHRONIZE() #define STARPU_WMB() STARPU_SYNCHRONIZE() #endif #ifdef __cplusplus } #endif #ifdef __cplusplus extern "C" { #endif extern int _starpu_silent; char *starpu_getenv(const char *str); static __starpu_inline int starpu_get_env_number(const char *str) { char *strval; strval = starpu_getenv(str); if (strval) { /* the env variable was actually set */ long int val; char *check; val = strtol(strval, &check, 10); if (*check) { fprintf(stderr,"The %s environment variable must contain an integer\n", str); STARPU_ABORT(); } /* fprintf(stderr, "ENV %s WAS %d\n", str, val); */ STARPU_ASSERT_MSG(val >= 0, "The value for the environment variable '%s' cannot be negative", str); return (int)val; } else { /* there is no such env variable */ /* fprintf("There was no %s ENV\n", str); */ return -1; } } static __starpu_inline int starpu_get_env_number_default(const char *str, int defval) { int ret = starpu_get_env_number(str); if (ret == -1) ret = defval; return ret; } static __starpu_inline float starpu_get_env_float_default(const char *str, float defval) { char *strval; strval = starpu_getenv(str); if (strval) { /* the env variable was actually set */ float val; char *check; val = strtof(strval, &check); if (*check) { fprintf(stderr,"The %s environment variable must contain a float\n", str); STARPU_ABORT(); } /* fprintf(stderr, "ENV %s WAS %f\n", str, val); */ return val; } else { /* there is no such env variable */ /* fprintf("There was no %s ENV\n", str); */ return defval; } } void starpu_execute_on_each_worker(void (*func)(void *), void *arg, uint32_t where); void starpu_execute_on_each_worker_ex(void (*func)(void *), void *arg, uint32_t where, const char *name); void starpu_execute_on_specific_workers(void (*func)(void*), void *arg, unsigned num_workers, unsigned *workers, const char *name); double starpu_timing_now(void); #ifdef _WIN32 /* Try to fetch the system definition of timespec */ #include #include #ifdef HAVE_UNISTD_H #include #endif #include #if !defined(_MSC_VER) || defined(BUILDING_STARPU) #include #endif #if !defined(STARPU_HAVE_STRUCT_TIMESPEC) || (defined(_MSC_VER) && _MSC_VER < 1900) /* If it didn't get defined in the standard places, then define it ourself */ #ifndef STARPU_TIMESPEC_DEFINED #define STARPU_TIMESPEC_DEFINED 1 struct timespec { time_t tv_sec; /* Seconds */ long tv_nsec; /* Nanoseconds */ }; #endif /* STARPU_TIMESPEC_DEFINED */ #endif /* STARPU_HAVE_STRUCT_TIMESPEC */ /* Fetch gettimeofday on mingw/cygwin */ #if defined(__MINGW32__) || defined(__CYGWIN__) #include #endif #else #include #endif /* _WIN32 */ #ifdef __cplusplus } #endif #endif /* __STARPU_UTIL_H__ */