src/gallium/auxiliary/os/os_thread.h

   1 /**************************************************************************
   2  *
   3  * Copyright 1999-2006 Brian Paul
   4  * Copyright 2008 VMware, Inc.
   5  * All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  21  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23  * OTHER DEALINGS IN THE SOFTWARE.
  24  *
  25  **************************************************************************/
  26
  27
  28 /**
  29  * @file
  30  *
  31  * Thread, mutex, condition variable, barrier, semaphore and
  32  * thread-specific data functions.
  33  */
  34
  35
  36 #ifndef OS_THREAD_H_
  37 #define OS_THREAD_H_
  38
  39
  40 #include "pipe/p_compiler.h"
  41 #include "util/u_debug.h" /* for assert */
  42
  43 #include "c11/threads.h"
  44
  45 #ifdef HAVE_PTHREAD
  46 #include <signal.h>
  47 #endif
  48
  49
  50 /* pipe_thread
  51  */
  52 typedef thrd_t pipe_thread;
  53
  54 #define PIPE_THREAD_ROUTINE( name, param ) \
  55    int name( void *param )
  56
  57 static inline pipe_thread pipe_thread_create( PIPE_THREAD_ROUTINE((*routine), ), void *param )
  58 {
  59    pipe_thread thread;
  60 #ifdef HAVE_PTHREAD
  61    sigset_t saved_set, new_set;
  62    int ret;
  63
  64    sigfillset(&new_set);
  65    pthread_sigmask(SIG_SETMASK, &new_set, &saved_set);
  66    ret = thrd_create( &thread, routine, param );
  67    pthread_sigmask(SIG_SETMASK, &saved_set, NULL);
  68 #else
  69    int ret;
  70    ret = thrd_create( &thread, routine, param );
  71 #endif
  72    if (ret)
  73       return 0;
  74
  75    return thread;
  76 }
  77
  78 static inline int pipe_thread_wait( pipe_thread thread )
  79 {
  80    return thrd_join( thread, NULL );
  81 }
  82
  83 static inline int pipe_thread_destroy( pipe_thread thread )
  84 {
  85    return thrd_detach( thread );
  86 }
  87
  88 static inline void pipe_thread_setname( const char *name )
  89 {
  90 #if defined(HAVE_PTHREAD)
  91 #  if defined(__GNU_LIBRARY__) && defined(__GLIBC__) && defined(__GLIBC_MINOR__) && \
  92       (__GLIBC__ >= 3 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 12))
  93    pthread_setname_np(pthread_self(), name);
  94 #  endif
  95 #endif
  96    (void)name;
  97 }
  98
  99
 100 static inline int pipe_thread_is_self( pipe_thread thread )
 101 {
 102 #if defined(HAVE_PTHREAD)
 103 #  if defined(__GNU_LIBRARY__) && defined(__GLIBC__) && defined(__GLIBC_MINOR__) && \
 104       (__GLIBC__ >= 3 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 12))
 105    return pthread_equal(pthread_self(), thread);
 106 #  endif
 107 #endif
 108    return 0;
 109 }
 110
 111 /* pipe_mutex
 112  */
 113 typedef mtx_t pipe_mutex;
 114
 115 #define pipe_static_mutex(mutex) \
 116    static pipe_mutex mutex = _MTX_INITIALIZER_NP
 117
 118 #define pipe_mutex_init(mutex) \
 119    (void) mtx_init(&(mutex), mtx_plain)
 120
 121 #define pipe_mutex_destroy(mutex) \
 122    mtx_destroy(&(mutex))
 123
 124 #define pipe_mutex_lock(mutex) \
 125    (void) mtx_lock(&(mutex))
 126
 127 #define pipe_mutex_unlock(mutex) \
 128    (void) mtx_unlock(&(mutex))
 129
 130 #define pipe_mutex_assert_locked(mutex) \
 131    __pipe_mutex_assert_locked(&(mutex))
 132
 133 static inline void
 134 __pipe_mutex_assert_locked(pipe_mutex *mutex)
 135 {
 136 #ifdef DEBUG
 137    /* NOTE: this would not work for recursive mutexes, but
 138     * pipe_mutex doesn't support those
 139     */
 140    int ret = mtx_trylock(mutex);
 141    assert(ret == thrd_busy);
 142    if (ret == thrd_success)
 143       mtx_unlock(mutex);
 144 #endif
 145 }
 146
 147 /* pipe_condvar
 148  */
 149 typedef cnd_t pipe_condvar;
 150
 151 #define pipe_condvar_signal(cond) \
 152    cnd_signal(&(cond))
 153
 154 #define pipe_condvar_broadcast(cond) \
 155    cnd_broadcast(&(cond))
 156
 157
 158 /*
 159  * pipe_barrier
 160  */
 161
 162 #if (defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_HURD)) && !defined(PIPE_OS_ANDROID)
 163
 164 typedef pthread_barrier_t pipe_barrier;
 165
 166 static inline void pipe_barrier_init(pipe_barrier *barrier, unsigned count)
 167 {
 168    pthread_barrier_init(barrier, NULL, count);
 169 }
 170
 171 static inline void pipe_barrier_destroy(pipe_barrier *barrier)
 172 {
 173    pthread_barrier_destroy(barrier);
 174 }
 175
 176 static inline void pipe_barrier_wait(pipe_barrier *barrier)
 177 {
 178    pthread_barrier_wait(barrier);
 179 }
 180
 181
 182 #else /* If the OS doesn't have its own, implement barriers using a mutex and a condvar */
 183
 184 typedef struct {
 185    unsigned count;
 186    unsigned waiters;
 187    uint64_t sequence;
 188    pipe_mutex mutex;
 189    pipe_condvar condvar;
 190 } pipe_barrier;
 191
 192 static inline void pipe_barrier_init(pipe_barrier *barrier, unsigned count)
 193 {
 194    barrier->count = count;
 195    barrier->waiters = 0;
 196    barrier->sequence = 0;
 197    pipe_mutex_init(barrier->mutex);
 198    cnd_init(&barrier->condvar);
 199 }
 200
 201 static inline void pipe_barrier_destroy(pipe_barrier *barrier)
 202 {
 203    assert(barrier->waiters == 0);
 204    pipe_mutex_destroy(barrier->mutex);
 205    cnd_destroy(&barrier->condvar);
 206 }
 207
 208 static inline void pipe_barrier_wait(pipe_barrier *barrier)
 209 {
 210    pipe_mutex_lock(barrier->mutex);
 211
 212    assert(barrier->waiters < barrier->count);
 213    barrier->waiters++;
 214
 215    if (barrier->waiters < barrier->count) {
 216       uint64_t sequence = barrier->sequence;
 217
 218       do {
 219          cnd_wait(&barrier->condvar, &barrier->mutex);
 220       } while (sequence == barrier->sequence);
 221    } else {
 222       barrier->waiters = 0;
 223       barrier->sequence++;
 224       pipe_condvar_broadcast(barrier->condvar);
 225    }
 226
 227    pipe_mutex_unlock(barrier->mutex);
 228 }
 229
 230
 231 #endif
 232
 233
 234 /*
 235  * Semaphores
 236  */
 237
 238 typedef struct
 239 {
 240    pipe_mutex mutex;
 241    pipe_condvar cond;
 242    int counter;
 243 } pipe_semaphore;
 244
 245
 246 static inline void
 247 pipe_semaphore_init(pipe_semaphore *sema, int init_val)
 248 {
 249    pipe_mutex_init(sema->mutex);
 250    cnd_init(&sema->cond);
 251    sema->counter = init_val;
 252 }
 253
 254 static inline void
 255 pipe_semaphore_destroy(pipe_semaphore *sema)
 256 {
 257    pipe_mutex_destroy(sema->mutex);
 258    cnd_destroy(&sema->cond);
 259 }
 260
 261 /** Signal/increment semaphore counter */
 262 static inline void
 263 pipe_semaphore_signal(pipe_semaphore *sema)
 264 {
 265    pipe_mutex_lock(sema->mutex);
 266    sema->counter++;
 267    pipe_condvar_signal(sema->cond);
 268    pipe_mutex_unlock(sema->mutex);
 269 }
 270
 271 /** Wait for semaphore counter to be greater than zero */
 272 static inline void
 273 pipe_semaphore_wait(pipe_semaphore *sema)
 274 {
 275    pipe_mutex_lock(sema->mutex);
 276    while (sema->counter <= 0) {
 277       cnd_wait(&sema->cond, &sema->mutex);
 278    }
 279    sema->counter--;
 280    pipe_mutex_unlock(sema->mutex);
 281 }
 282
 283
 284
 285 /*
 286  * Thread-specific data.
 287  */
 288
 289 typedef struct {
 290    tss_t key;
 291    int initMagic;
 292 } pipe_tsd;
 293
 294
 295 #define PIPE_TSD_INIT_MAGIC 0xff8adc98
 296
 297
 298 static inline void
 299 pipe_tsd_init(pipe_tsd *tsd)
 300 {
 301    if (tss_create(&tsd->key, NULL/*free*/) != 0) {
 302       exit(-1);
 303    }
 304    tsd->initMagic = PIPE_TSD_INIT_MAGIC;
 305 }
 306
 307 static inline void *
 308 pipe_tsd_get(pipe_tsd *tsd)
 309 {
 310    if (tsd->initMagic != (int) PIPE_TSD_INIT_MAGIC) {
 311       pipe_tsd_init(tsd);
 312    }
 313    return tss_get(tsd->key);
 314 }
 315
 316 static inline void
 317 pipe_tsd_set(pipe_tsd *tsd, void *value)
 318 {
 319    if (tsd->initMagic != (int) PIPE_TSD_INIT_MAGIC) {
 320       pipe_tsd_init(tsd);
 321    }
 322    if (tss_set(tsd->key, value) != 0) {
 323       exit(-1);
 324    }
 325 }
 326
 327
 328
 329 /*
 330  * Thread statistics.
 331  */
 332
 333 /* Return the time of a thread's CPU time clock. */
 334 static inline int64_t
 335 pipe_thread_get_time_nano(pipe_thread thread)
 336 {
 337 #if defined(PIPE_OS_LINUX) && defined(HAVE_PTHREAD)
 338    struct timespec ts;
 339    clockid_t cid;
 340
 341    pthread_getcpuclockid(thread, &cid);
 342    clock_gettime(cid, &ts);
 343    return (int64_t)ts.tv_sec * 1000000000 + ts.tv_nsec;
 344 #else
 345    return 0;
 346 #endif
 347 }
 348
 349 /* Return the time of the current thread's CPU time clock. */
 350 static inline int64_t
 351 pipe_current_thread_get_time_nano(void)
 352 {
 353 #if defined(HAVE_PTHREAD)
 354    return pipe_thread_get_time_nano(pthread_self());
 355 #else
 356    return 0;
 357 #endif
 358 }
 359
 360 #endif /* OS_THREAD_H_ */