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
 152 /*
 153  * pipe_barrier
 154  */
 155
 156 #if (defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_HURD)) && !defined(PIPE_OS_ANDROID)
 157
 158 typedef pthread_barrier_t pipe_barrier;
 159
 160 static inline void pipe_barrier_init(pipe_barrier *barrier, unsigned count)
 161 {
 162    pthread_barrier_init(barrier, NULL, count);
 163 }
 164
 165 static inline void pipe_barrier_destroy(pipe_barrier *barrier)
 166 {
 167    pthread_barrier_destroy(barrier);
 168 }
 169
 170 static inline void pipe_barrier_wait(pipe_barrier *barrier)
 171 {
 172    pthread_barrier_wait(barrier);
 173 }
 174
 175
 176 #else /* If the OS doesn't have its own, implement barriers using a mutex and a condvar */
 177
 178 typedef struct {
 179    unsigned count;
 180    unsigned waiters;
 181    uint64_t sequence;
 182    pipe_mutex mutex;
 183    pipe_condvar condvar;
 184 } pipe_barrier;
 185
 186 static inline void pipe_barrier_init(pipe_barrier *barrier, unsigned count)
 187 {
 188    barrier->count = count;
 189    barrier->waiters = 0;
 190    barrier->sequence = 0;
 191    pipe_mutex_init(barrier->mutex);
 192    cnd_init(&barrier->condvar);
 193 }
 194
 195 static inline void pipe_barrier_destroy(pipe_barrier *barrier)
 196 {
 197    assert(barrier->waiters == 0);
 198    pipe_mutex_destroy(barrier->mutex);
 199    cnd_destroy(&barrier->condvar);
 200 }
 201
 202 static inline void pipe_barrier_wait(pipe_barrier *barrier)
 203 {
 204    pipe_mutex_lock(barrier->mutex);
 205
 206    assert(barrier->waiters < barrier->count);
 207    barrier->waiters++;
 208
 209    if (barrier->waiters < barrier->count) {
 210       uint64_t sequence = barrier->sequence;
 211
 212       do {
 213          cnd_wait(&barrier->condvar, &barrier->mutex);
 214       } while (sequence == barrier->sequence);
 215    } else {
 216       barrier->waiters = 0;
 217       barrier->sequence++;
 218       cnd_broadcast(&barrier->condvar);
 219    }
 220
 221    pipe_mutex_unlock(barrier->mutex);
 222 }
 223
 224
 225 #endif
 226
 227
 228 /*
 229  * Semaphores
 230  */
 231
 232 typedef struct
 233 {
 234    pipe_mutex mutex;
 235    pipe_condvar cond;
 236    int counter;
 237 } pipe_semaphore;
 238
 239
 240 static inline void
 241 pipe_semaphore_init(pipe_semaphore *sema, int init_val)
 242 {
 243    pipe_mutex_init(sema->mutex);
 244    cnd_init(&sema->cond);
 245    sema->counter = init_val;
 246 }
 247
 248 static inline void
 249 pipe_semaphore_destroy(pipe_semaphore *sema)
 250 {
 251    pipe_mutex_destroy(sema->mutex);
 252    cnd_destroy(&sema->cond);
 253 }
 254
 255 /** Signal/increment semaphore counter */
 256 static inline void
 257 pipe_semaphore_signal(pipe_semaphore *sema)
 258 {
 259    pipe_mutex_lock(sema->mutex);
 260    sema->counter++;
 261    cnd_signal(&sema->cond);
 262    pipe_mutex_unlock(sema->mutex);
 263 }
 264
 265 /** Wait for semaphore counter to be greater than zero */
 266 static inline void
 267 pipe_semaphore_wait(pipe_semaphore *sema)
 268 {
 269    pipe_mutex_lock(sema->mutex);
 270    while (sema->counter <= 0) {
 271       cnd_wait(&sema->cond, &sema->mutex);
 272    }
 273    sema->counter--;
 274    pipe_mutex_unlock(sema->mutex);
 275 }
 276
 277
 278
 279 /*
 280  * Thread-specific data.
 281  */
 282
 283 typedef struct {
 284    tss_t key;
 285    int initMagic;
 286 } pipe_tsd;
 287
 288
 289 #define PIPE_TSD_INIT_MAGIC 0xff8adc98
 290
 291
 292 static inline void
 293 pipe_tsd_init(pipe_tsd *tsd)
 294 {
 295    if (tss_create(&tsd->key, NULL/*free*/) != 0) {
 296       exit(-1);
 297    }
 298    tsd->initMagic = PIPE_TSD_INIT_MAGIC;
 299 }
 300
 301 static inline void *
 302 pipe_tsd_get(pipe_tsd *tsd)
 303 {
 304    if (tsd->initMagic != (int) PIPE_TSD_INIT_MAGIC) {
 305       pipe_tsd_init(tsd);
 306    }
 307    return tss_get(tsd->key);
 308 }
 309
 310 static inline void
 311 pipe_tsd_set(pipe_tsd *tsd, void *value)
 312 {
 313    if (tsd->initMagic != (int) PIPE_TSD_INIT_MAGIC) {
 314       pipe_tsd_init(tsd);
 315    }
 316    if (tss_set(tsd->key, value) != 0) {
 317       exit(-1);
 318    }
 319 }
 320
 321
 322
 323 /*
 324  * Thread statistics.
 325  */
 326
 327 /* Return the time of a thread's CPU time clock. */
 328 static inline int64_t
 329 pipe_thread_get_time_nano(pipe_thread thread)
 330 {
 331 #if defined(PIPE_OS_LINUX) && defined(HAVE_PTHREAD)
 332    struct timespec ts;
 333    clockid_t cid;
 334
 335    pthread_getcpuclockid(thread, &cid);
 336    clock_gettime(cid, &ts);
 337    return (int64_t)ts.tv_sec * 1000000000 + ts.tv_nsec;
 338 #else
 339    return 0;
 340 #endif
 341 }
 342
 343 /* Return the time of the current thread's CPU time clock. */
 344 static inline int64_t
 345 pipe_current_thread_get_time_nano(void)
 346 {
 347 #if defined(HAVE_PTHREAD)
 348    return pipe_thread_get_time_nano(pthread_self());
 349 #else
 350    return 0;
 351 #endif
 352 }
 353
 354 #endif /* OS_THREAD_H_ */