src/gallium/auxiliary/os/os_thread.h

   1 /**************************************************************************
   2  *
   3  * Copyright 1999-2006 Brian Paul
   4  * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
   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  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  21  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  *
  24  **************************************************************************/
  25
  26
  27 /**
  28  * @file
  29  *
  30  * Thread, mutex, condition variable, barrier, semaphore and
  31  * thread-specific data functions.
  32  */
  33
  34
  35 #ifndef OS_THREAD_H_
  36 #define OS_THREAD_H_
  37
  38
  39 #include "pipe/p_compiler.h"
  40 #include "util/u_debug.h" /* for assert */
  41
  42
  43 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE) || defined(PIPE_OS_HAIKU)
  44
  45 #include <pthread.h> /* POSIX threads headers */
  46 #include <stdio.h> /* for perror() */
  47
  48 #define PIPE_THREAD_HAVE_CONDVAR
  49
  50 /* pipe_thread
  51  */
  52 typedef pthread_t pipe_thread;
  53
  54 #define PIPE_THREAD_ROUTINE( name, param ) \
  55    void *name( void *param )
  56
  57 static INLINE pipe_thread pipe_thread_create( void *(* routine)( void *), void *param )
  58 {
  59    pipe_thread thread;
  60    if (pthread_create( &thread, NULL, routine, param ))
  61       return 0;
  62    return thread;
  63 }
  64
  65 static INLINE int pipe_thread_wait( pipe_thread thread )
  66 {
  67    return pthread_join( thread, NULL );
  68 }
  69
  70 static INLINE int pipe_thread_destroy( pipe_thread thread )
  71 {
  72    return pthread_detach( thread );
  73 }
  74
  75
  76 /* pipe_mutex
  77  */
  78 typedef pthread_mutex_t pipe_mutex;
  79
  80 #define pipe_static_mutex(mutex) \
  81    static pipe_mutex mutex = PTHREAD_MUTEX_INITIALIZER
  82
  83 #define pipe_mutex_init(mutex) \
  84    (void) pthread_mutex_init(&(mutex), NULL)
  85
  86 #define pipe_mutex_destroy(mutex) \
  87    pthread_mutex_destroy(&(mutex))
  88
  89 #define pipe_mutex_lock(mutex) \
  90    (void) pthread_mutex_lock(&(mutex))
  91
  92 #define pipe_mutex_unlock(mutex) \
  93    (void) pthread_mutex_unlock(&(mutex))
  94
  95
  96 /* pipe_condvar
  97  */
  98 typedef pthread_cond_t pipe_condvar;
  99
 100 #define pipe_static_condvar(mutex) \
 101    static pipe_condvar mutex = PTHREAD_COND_INITIALIZER
 102
 103 #define pipe_condvar_init(cond) \
 104    pthread_cond_init(&(cond), NULL)
 105
 106 #define pipe_condvar_destroy(cond) \
 107    pthread_cond_destroy(&(cond))
 108
 109 #define pipe_condvar_wait(cond, mutex) \
 110   pthread_cond_wait(&(cond), &(mutex))
 111
 112 #define pipe_condvar_signal(cond) \
 113   pthread_cond_signal(&(cond))
 114
 115 #define pipe_condvar_broadcast(cond) \
 116   pthread_cond_broadcast(&(cond))
 117
 118
 119 /* pipe_barrier
 120  */
 121 typedef pthread_barrier_t pipe_barrier;
 122
 123 static INLINE void pipe_barrier_init(pipe_barrier *barrier, unsigned count)
 124 {
 125    pthread_barrier_init(barrier, NULL, count);
 126 }
 127
 128 static INLINE void pipe_barrier_destroy(pipe_barrier *barrier)
 129 {
 130    pthread_barrier_destroy(barrier);
 131 }
 132
 133 static INLINE void pipe_barrier_wait(pipe_barrier *barrier)
 134 {
 135    pthread_barrier_wait(barrier);
 136 }
 137
 138
 139 #elif defined(PIPE_SUBSYSTEM_WINDOWS_USER)
 140
 141 #include <windows.h>
 142
 143 /* pipe_thread
 144  */
 145 typedef HANDLE pipe_thread;
 146
 147 #define PIPE_THREAD_ROUTINE( name, param ) \
 148    void * WINAPI name( void *param )
 149
 150 static INLINE pipe_thread pipe_thread_create( void *(WINAPI * routine)( void *), void *param )
 151 {
 152    DWORD id;
 153    return CreateThread( NULL, 0, (LPTHREAD_START_ROUTINE) routine, param, 0, &id );
 154 }
 155
 156 static INLINE int pipe_thread_wait( pipe_thread thread )
 157 {
 158    if (WaitForSingleObject( thread, INFINITE ) == WAIT_OBJECT_0)
 159       return 0;
 160    return -1;
 161 }
 162
 163 static INLINE int pipe_thread_destroy( pipe_thread thread )
 164 {
 165    if (CloseHandle( thread ))
 166       return 0;
 167    return -1;
 168 }
 169
 170
 171 /* pipe_mutex
 172  */
 173 typedef CRITICAL_SECTION pipe_mutex;
 174
 175 #define pipe_static_mutex(mutex) \
 176    /*static*/ pipe_mutex mutex = {0,0,0,0,0,0}
 177
 178 #define pipe_mutex_init(mutex) \
 179    InitializeCriticalSection(&mutex)
 180
 181 #define pipe_mutex_destroy(mutex) \
 182    DeleteCriticalSection(&mutex)
 183
 184 #define pipe_mutex_lock(mutex) \
 185    EnterCriticalSection(&mutex)
 186
 187 #define pipe_mutex_unlock(mutex) \
 188    LeaveCriticalSection(&mutex)
 189
 190
 191 /* pipe_condvar (XXX FIX THIS)
 192  */
 193 typedef unsigned pipe_condvar;
 194
 195 #define pipe_condvar_init(cond) \
 196    (void) cond
 197
 198 #define pipe_condvar_destroy(cond) \
 199    (void) cond
 200
 201 #define pipe_condvar_wait(cond, mutex) \
 202    (void) cond; (void) mutex
 203
 204 #define pipe_condvar_signal(cond) \
 205    (void) cond
 206
 207 #define pipe_condvar_broadcast(cond) \
 208    (void) cond
 209
 210
 211 /* pipe_barrier (XXX FIX THIS)
 212  */
 213 typedef unsigned pipe_barrier;
 214
 215 static INLINE void pipe_barrier_init(pipe_barrier *barrier, unsigned count)
 216 {
 217    /* XXX we could implement barriers with a mutex and condition var */
 218 }
 219
 220 static INLINE void pipe_barrier_destroy(pipe_barrier *barrier)
 221 {
 222 }
 223
 224 static INLINE void pipe_barrier_wait(pipe_barrier *barrier)
 225 {
 226    assert(0);
 227 }
 228
 229
 230
 231 #else
 232
 233 /** Dummy definitions */
 234
 235 typedef unsigned pipe_thread;
 236
 237 #define PIPE_THREAD_ROUTINE( name, param ) \
 238    void * name( void *param )
 239
 240 static INLINE pipe_thread pipe_thread_create( void *(* routine)( void *), void *param )
 241 {
 242    return 0;
 243 }
 244
 245 static INLINE int pipe_thread_wait( pipe_thread thread )
 246 {
 247    return -1;
 248 }
 249
 250 static INLINE int pipe_thread_destroy( pipe_thread thread )
 251 {
 252    return -1;
 253 }
 254
 255 typedef unsigned pipe_mutex;
 256 typedef unsigned pipe_condvar;
 257 typedef unsigned pipe_barrier;
 258
 259 #define pipe_static_mutex(mutex) \
 260    static pipe_mutex mutex = 0
 261
 262 #define pipe_mutex_init(mutex) \
 263    (void) mutex
 264
 265 #define pipe_mutex_destroy(mutex) \
 266    (void) mutex
 267
 268 #define pipe_mutex_lock(mutex) \
 269    (void) mutex
 270
 271 #define pipe_mutex_unlock(mutex) \
 272    (void) mutex
 273
 274 #define pipe_static_condvar(condvar) \
 275    static unsigned condvar = 0
 276
 277 #define pipe_condvar_init(condvar) \
 278    (void) condvar
 279
 280 #define pipe_condvar_destroy(condvar) \
 281    (void) condvar
 282
 283 #define pipe_condvar_wait(condvar, mutex) \
 284    (void) condvar
 285
 286 #define pipe_condvar_signal(condvar) \
 287    (void) condvar
 288
 289 #define pipe_condvar_broadcast(condvar) \
 290    (void) condvar
 291
 292
 293 static INLINE void pipe_barrier_init(pipe_barrier *barrier, unsigned count)
 294 {
 295    /* XXX we could implement barriers with a mutex and condition var */
 296    assert(0);
 297 }
 298
 299 static INLINE void pipe_barrier_destroy(pipe_barrier *barrier)
 300 {
 301    assert(0);
 302 }
 303
 304 static INLINE void pipe_barrier_wait(pipe_barrier *barrier)
 305 {
 306    assert(0);
 307 }
 308
 309
 310
 311 #endif  /* PIPE_OS_? */
 312
 313
 314 /*
 315  * Semaphores
 316  */
 317
 318 typedef struct
 319 {
 320    pipe_mutex mutex;
 321    pipe_condvar cond;
 322    int counter;
 323 } pipe_semaphore;
 324
 325
 326 static INLINE void
 327 pipe_semaphore_init(pipe_semaphore *sema, int init_val)
 328 {
 329    pipe_mutex_init(sema->mutex);
 330    pipe_condvar_init(sema->cond);
 331    sema->counter = init_val;
 332 }
 333
 334 static INLINE void
 335 pipe_semaphore_destroy(pipe_semaphore *sema)
 336 {
 337    pipe_mutex_destroy(sema->mutex);
 338    pipe_condvar_destroy(sema->cond);
 339 }
 340
 341 /** Signal/increment semaphore counter */
 342 static INLINE void
 343 pipe_semaphore_signal(pipe_semaphore *sema)
 344 {
 345    pipe_mutex_lock(sema->mutex);
 346    sema->counter++;
 347    pipe_condvar_signal(sema->cond);
 348    pipe_mutex_unlock(sema->mutex);
 349 }
 350
 351 /** Wait for semaphore counter to be greater than zero */
 352 static INLINE void
 353 pipe_semaphore_wait(pipe_semaphore *sema)
 354 {
 355    pipe_mutex_lock(sema->mutex);
 356    while (sema->counter <= 0) {
 357       pipe_condvar_wait(sema->cond, sema->mutex);
 358    }
 359    sema->counter--;
 360    pipe_mutex_unlock(sema->mutex);
 361 }
 362
 363
 364
 365 /*
 366  * Thread-specific data.
 367  */
 368
 369 typedef struct {
 370 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE) || defined(PIPE_OS_HAIKU)
 371    pthread_key_t key;
 372 #elif defined(PIPE_SUBSYSTEM_WINDOWS_USER)
 373    DWORD key;
 374 #endif
 375    int initMagic;
 376 } pipe_tsd;
 377
 378
 379 #define PIPE_TSD_INIT_MAGIC 0xff8adc98
 380
 381
 382 static INLINE void
 383 pipe_tsd_init(pipe_tsd *tsd)
 384 {
 385 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE) || defined(PIPE_OS_HAIKU)
 386    if (pthread_key_create(&tsd->key, NULL/*free*/) != 0) {
 387       perror("pthread_key_create(): failed to allocate key for thread specific data");
 388       exit(-1);
 389    }
 390 #elif defined(PIPE_SUBSYSTEM_WINDOWS_USER)
 391    assert(0);
 392 #endif
 393    tsd->initMagic = PIPE_TSD_INIT_MAGIC;
 394 }
 395
 396 static INLINE void *
 397 pipe_tsd_get(pipe_tsd *tsd)
 398 {
 399    if (tsd->initMagic != (int) PIPE_TSD_INIT_MAGIC) {
 400       pipe_tsd_init(tsd);
 401    }
 402 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE) || defined(PIPE_OS_HAIKU)
 403    return pthread_getspecific(tsd->key);
 404 #elif defined(PIPE_SUBSYSTEM_WINDOWS_USER)
 405    assert(0);
 406    return NULL;
 407 #else
 408    assert(0);
 409    return NULL;
 410 #endif
 411 }
 412
 413 static INLINE void
 414 pipe_tsd_set(pipe_tsd *tsd, void *value)
 415 {
 416    if (tsd->initMagic != (int) PIPE_TSD_INIT_MAGIC) {
 417       pipe_tsd_init(tsd);
 418    }
 419 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE) || defined(PIPE_OS_HAIKU)
 420    if (pthread_setspecific(tsd->key, value) != 0) {
 421       perror("pthread_set_specific() failed");
 422       exit(-1);
 423    }
 424 #elif defined(PIPE_SUBSYSTEM_WINDOWS_USER)
 425    assert(0);
 426 #else
 427    assert(0);
 428 #endif
 429 }
 430
 431
 432
 433 #endif /* OS_THREAD_H_ */