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 /* pipe_mutex
 101  */
 102 typedef mtx_t pipe_mutex;
 103
 104 #define pipe_static_mutex(mutex) \
 105    static pipe_mutex mutex = _MTX_INITIALIZER_NP
 106
 107 #define pipe_mutex_init(mutex) \
 108    (void) mtx_init(&(mutex), mtx_plain)
 109
 110 #define pipe_mutex_destroy(mutex) \
 111    mtx_destroy(&(mutex))
 112
 113 #define pipe_mutex_lock(mutex) \
 114    (void) mtx_lock(&(mutex))
 115
 116 #define pipe_mutex_unlock(mutex) \
 117    (void) mtx_unlock(&(mutex))
 118
 119 #define pipe_mutex_assert_locked(mutex) \
 120    __pipe_mutex_assert_locked(&(mutex))
 121
 122 static inline void
 123 __pipe_mutex_assert_locked(pipe_mutex *mutex)
 124 {
 125 #ifdef DEBUG
 126    /* NOTE: this would not work for recursive mutexes, but
 127     * pipe_mutex doesn't support those
 128     */
 129    int ret = mtx_trylock(mutex);
 130    assert(ret == thrd_busy);
 131    if (ret == thrd_success)
 132       mtx_unlock(mutex);
 133 #endif
 134 }
 135
 136 /* pipe_condvar
 137  */
 138 typedef cnd_t pipe_condvar;
 139
 140 #define pipe_condvar_init(cond) \
 141    cnd_init(&(cond))
 142
 143 #define pipe_condvar_destroy(cond) \
 144    cnd_destroy(&(cond))
 145
 146 #define pipe_condvar_wait(cond, mutex) \
 147    cnd_wait(&(cond), &(mutex))
 148
 149 #define pipe_condvar_signal(cond) \
 150    cnd_signal(&(cond))
 151
 152 #define pipe_condvar_broadcast(cond) \
 153    cnd_broadcast(&(cond))
 154
 155
 156 /*
 157  * pipe_barrier
 158  */
 159
 160 #if (defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_HURD)) && !defined(PIPE_OS_ANDROID)
 161
 162 typedef pthread_barrier_t pipe_barrier;
 163
 164 static inline void pipe_barrier_init(pipe_barrier *barrier, unsigned count)
 165 {
 166    pthread_barrier_init(barrier, NULL, count);
 167 }
 168
 169 static inline void pipe_barrier_destroy(pipe_barrier *barrier)
 170 {
 171    pthread_barrier_destroy(barrier);
 172 }
 173
 174 static inline void pipe_barrier_wait(pipe_barrier *barrier)
 175 {
 176    pthread_barrier_wait(barrier);
 177 }
 178
 179
 180 #else /* If the OS doesn't have its own, implement barriers using a mutex and a condvar */
 181
 182 typedef struct {
 183    unsigned count;
 184    unsigned waiters;
 185    uint64_t sequence;
 186    pipe_mutex mutex;
 187    pipe_condvar condvar;
 188 } pipe_barrier;
 189
 190 static inline void pipe_barrier_init(pipe_barrier *barrier, unsigned count)
 191 {
 192    barrier->count = count;
 193    barrier->waiters = 0;
 194    barrier->sequence = 0;
 195    pipe_mutex_init(barrier->mutex);
 196    pipe_condvar_init(barrier->condvar);
 197 }
 198
 199 static inline void pipe_barrier_destroy(pipe_barrier *barrier)
 200 {
 201    assert(barrier->waiters == 0);
 202    pipe_mutex_destroy(barrier->mutex);
 203    pipe_condvar_destroy(barrier->condvar);
 204 }
 205
 206 static inline void pipe_barrier_wait(pipe_barrier *barrier)
 207 {
 208    pipe_mutex_lock(barrier->mutex);
 209
 210    assert(barrier->waiters < barrier->count);
 211    barrier->waiters++;
 212
 213    if (barrier->waiters < barrier->count) {
 214       uint64_t sequence = barrier->sequence;
 215
 216       do {
 217          pipe_condvar_wait(barrier->condvar, barrier->mutex);
 218       } while (sequence == barrier->sequence);
 219    } else {
 220       barrier->waiters = 0;
 221       barrier->sequence++;
 222       pipe_condvar_broadcast(barrier->condvar);
 223    }
 224
 225    pipe_mutex_unlock(barrier->mutex);
 226 }
 227
 228
 229 #endif
 230
 231
 232 /*
 233  * Semaphores
 234  */
 235
 236 typedef struct
 237 {
 238    pipe_mutex mutex;
 239    pipe_condvar cond;
 240    int counter;
 241 } pipe_semaphore;
 242
 243
 244 static inline void
 245 pipe_semaphore_init(pipe_semaphore *sema, int init_val)
 246 {
 247    pipe_mutex_init(sema->mutex);
 248    pipe_condvar_init(sema->cond);
 249    sema->counter = init_val;
 250 }
 251
 252 static inline void
 253 pipe_semaphore_destroy(pipe_semaphore *sema)
 254 {
 255    pipe_mutex_destroy(sema->mutex);
 256    pipe_condvar_destroy(sema->cond);
 257 }
 258
 259 /** Signal/increment semaphore counter */
 260 static inline void
 261 pipe_semaphore_signal(pipe_semaphore *sema)
 262 {
 263    pipe_mutex_lock(sema->mutex);
 264    sema->counter++;
 265    pipe_condvar_signal(sema->cond);
 266    pipe_mutex_unlock(sema->mutex);
 267 }
 268
 269 /** Wait for semaphore counter to be greater than zero */
 270 static inline void
 271 pipe_semaphore_wait(pipe_semaphore *sema)
 272 {
 273    pipe_mutex_lock(sema->mutex);
 274    while (sema->counter <= 0) {
 275       pipe_condvar_wait(sema->cond, sema->mutex);
 276    }
 277    sema->counter--;
 278    pipe_mutex_unlock(sema->mutex);
 279 }
 280
 281
 282
 283 /*
 284  * Thread-specific data.
 285  */
 286
 287 typedef struct {
 288    tss_t key;
 289    int initMagic;
 290 } pipe_tsd;
 291
 292
 293 #define PIPE_TSD_INIT_MAGIC 0xff8adc98
 294
 295
 296 static inline void
 297 pipe_tsd_init(pipe_tsd *tsd)
 298 {
 299    if (tss_create(&tsd->key, NULL/*free*/) != 0) {
 300       exit(-1);
 301    }
 302    tsd->initMagic = PIPE_TSD_INIT_MAGIC;
 303 }
 304
 305 static inline void *
 306 pipe_tsd_get(pipe_tsd *tsd)
 307 {
 308    if (tsd->initMagic != (int) PIPE_TSD_INIT_MAGIC) {
 309       pipe_tsd_init(tsd);
 310    }
 311    return tss_get(tsd->key);
 312 }
 313
 314 static inline void
 315 pipe_tsd_set(pipe_tsd *tsd, void *value)
 316 {
 317    if (tsd->initMagic != (int) PIPE_TSD_INIT_MAGIC) {
 318       pipe_tsd_init(tsd);
 319    }
 320    if (tss_set(tsd->key, value) != 0) {
 321       exit(-1);
 322    }
 323 }
 324
 325
 326
 327 #endif /* OS_THREAD_H_ */