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) || defined(PIPE_OS_EMBEDDED) || defined(PIPE_OS_CYGWIN)
  44
  45 #include <pthread.h> /* POSIX threads headers */
  46 #include <stdio.h> /* for perror() */
  47
  48
  49 /* pipe_thread
  50  */
  51 typedef pthread_t pipe_thread;
  52
  53 #define PIPE_THREAD_ROUTINE( name, param ) \
  54    void *name( void *param )
  55
  56 static INLINE pipe_thread pipe_thread_create( void *(* routine)( void *), void *param )
  57 {
  58    pipe_thread thread;
  59    if (pthread_create( &thread, NULL, routine, param ))
  60       return 0;
  61    return thread;
  62 }
  63
  64 static INLINE int pipe_thread_wait( pipe_thread thread )
  65 {
  66    return pthread_join( thread, NULL );
  67 }
  68
  69 static INLINE int pipe_thread_destroy( pipe_thread thread )
  70 {
  71    return pthread_detach( thread );
  72 }
  73
  74
  75 /* pipe_mutex
  76  */
  77 typedef pthread_mutex_t pipe_mutex;
  78
  79 #define pipe_static_mutex(mutex) \
  80    static pipe_mutex mutex = PTHREAD_MUTEX_INITIALIZER
  81
  82 #define pipe_mutex_init(mutex) \
  83    (void) pthread_mutex_init(&(mutex), NULL)
  84
  85 #define pipe_mutex_destroy(mutex) \
  86    pthread_mutex_destroy(&(mutex))
  87
  88 #define pipe_mutex_lock(mutex) \
  89    (void) pthread_mutex_lock(&(mutex))
  90
  91 #define pipe_mutex_unlock(mutex) \
  92    (void) pthread_mutex_unlock(&(mutex))
  93
  94
  95 /* pipe_condvar
  96  */
  97 typedef pthread_cond_t pipe_condvar;
  98
  99 #define pipe_static_condvar(mutex) \
 100    static pipe_condvar mutex = PTHREAD_COND_INITIALIZER
 101
 102 #define pipe_condvar_init(cond) \
 103    pthread_cond_init(&(cond), NULL)
 104
 105 #define pipe_condvar_destroy(cond) \
 106    pthread_cond_destroy(&(cond))
 107
 108 #define pipe_condvar_wait(cond, mutex) \
 109   pthread_cond_wait(&(cond), &(mutex))
 110
 111 #define pipe_condvar_signal(cond) \
 112   pthread_cond_signal(&(cond))
 113
 114 #define pipe_condvar_broadcast(cond) \
 115   pthread_cond_broadcast(&(cond))
 116
 117
 118
 119 #elif defined(PIPE_SUBSYSTEM_WINDOWS_USER)
 120
 121 #include <windows.h>
 122
 123 /* pipe_thread
 124  */
 125 typedef HANDLE pipe_thread;
 126
 127 #define PIPE_THREAD_ROUTINE( name, param ) \
 128    void * WINAPI name( void *param )
 129
 130 static INLINE pipe_thread pipe_thread_create( void *(WINAPI * routine)( void *), void *param )
 131 {
 132    DWORD id;
 133    return CreateThread( NULL, 0, (LPTHREAD_START_ROUTINE) routine, param, 0, &id );
 134 }
 135
 136 static INLINE int pipe_thread_wait( pipe_thread thread )
 137 {
 138    if (WaitForSingleObject( thread, INFINITE ) == WAIT_OBJECT_0)
 139       return 0;
 140    return -1;
 141 }
 142
 143 static INLINE int pipe_thread_destroy( pipe_thread thread )
 144 {
 145    if (CloseHandle( thread ))
 146       return 0;
 147    return -1;
 148 }
 149
 150
 151 /* pipe_mutex
 152  */
 153 typedef CRITICAL_SECTION pipe_mutex;
 154
 155 /* http://locklessinc.com/articles/pthreads_on_windows/ */
 156 #define pipe_static_mutex(mutex) \
 157    static pipe_mutex mutex = {(PCRITICAL_SECTION_DEBUG)-1, -1, 0, 0, 0, 0}
 158
 159 #define pipe_mutex_init(mutex) \
 160    InitializeCriticalSection(&mutex)
 161
 162 #define pipe_mutex_destroy(mutex) \
 163    DeleteCriticalSection(&mutex)
 164
 165 #define pipe_mutex_lock(mutex) \
 166    EnterCriticalSection(&mutex)
 167
 168 #define pipe_mutex_unlock(mutex) \
 169    LeaveCriticalSection(&mutex)
 170
 171 /* TODO: Need a macro to declare "I don't care about WinXP compatibilty" */
 172 #if 0 && defined (_WIN32_WINNT) && (_WIN32_WINNT >= 0x0600)
 173 /* CONDITION_VARIABLE is only available on newer versions of Windows
 174  * (Server 2008/Vista or later).
 175  * http://msdn.microsoft.com/en-us/library/ms682052(VS.85).aspx
 176  *
 177  * pipe_condvar
 178  */
 179 typedef CONDITION_VARIABLE pipe_condvar;
 180
 181 #define pipe_static_condvar(cond) \
 182    /*static*/ pipe_condvar cond = CONDITION_VARIABLE_INIT
 183
 184 #define pipe_condvar_init(cond) \
 185    InitializeConditionVariable(&(cond))
 186
 187 #define pipe_condvar_destroy(cond) \
 188    (void) cond /* nothing to do */
 189
 190 #define pipe_condvar_wait(cond, mutex) \
 191    SleepConditionVariableCS(&(cond), &(mutex), INFINITE)
 192
 193 #define pipe_condvar_signal(cond) \
 194    WakeConditionVariable(&(cond))
 195
 196 #define pipe_condvar_broadcast(cond) \
 197    WakeAllConditionVariable(&(cond))
 198
 199 #else /* need compatibility with pre-Vista Win32 */
 200
 201 /* pipe_condvar (XXX FIX THIS)
 202  * See http://www.cs.wustl.edu/~schmidt/win32-cv-1.html
 203  * for potential pitfalls in implementation.
 204  */
 205 typedef DWORD pipe_condvar;
 206
 207 #define pipe_static_condvar(cond) \
 208    /*static*/ pipe_condvar cond = 1
 209
 210 #define pipe_condvar_init(cond) \
 211    (void) (cond = 1)
 212
 213 #define pipe_condvar_destroy(cond) \
 214    (void) cond
 215
 216 /* Poor man's pthread_cond_wait():
 217    Just release the mutex and sleep for one millisecond.
 218    The caller's while() loop does all the work. */
 219 #define pipe_condvar_wait(cond, mutex) \
 220    do { pipe_mutex_unlock(mutex); \
 221         Sleep(cond); \
 222         pipe_mutex_lock(mutex); \
 223    } while (0)
 224
 225 #define pipe_condvar_signal(cond) \
 226    (void) cond
 227
 228 #define pipe_condvar_broadcast(cond) \
 229    (void) cond
 230
 231 #endif /* pre-Vista win32 */
 232
 233 #else
 234
 235 #include "os/os_time.h"
 236
 237 /** Dummy definitions */
 238
 239 typedef unsigned pipe_thread;
 240
 241 #define PIPE_THREAD_ROUTINE( name, param ) \
 242    void * name( void *param )
 243
 244 static INLINE pipe_thread pipe_thread_create( void *(* routine)( void *), void *param )
 245 {
 246    return 0;
 247 }
 248
 249 static INLINE int pipe_thread_wait( pipe_thread thread )
 250 {
 251    return -1;
 252 }
 253
 254 static INLINE int pipe_thread_destroy( pipe_thread thread )
 255 {
 256    return -1;
 257 }
 258
 259 typedef unsigned pipe_mutex;
 260
 261 #define pipe_static_mutex(mutex) \
 262    static pipe_mutex mutex = 0
 263
 264 #define pipe_mutex_init(mutex) \
 265    (void) mutex
 266
 267 #define pipe_mutex_destroy(mutex) \
 268    (void) mutex
 269
 270 #define pipe_mutex_lock(mutex) \
 271    (void) mutex
 272
 273 #define pipe_mutex_unlock(mutex) \
 274    (void) mutex
 275
 276 typedef int64_t pipe_condvar;
 277
 278 #define pipe_static_condvar(condvar) \
 279    static pipe_condvar condvar = 1000
 280
 281 #define pipe_condvar_init(condvar) \
 282    (void) (condvar = 1000)
 283
 284 #define pipe_condvar_destroy(condvar) \
 285    (void) condvar
 286
 287 /* Poor man's pthread_cond_wait():
 288    Just release the mutex and sleep for one millisecond.
 289    The caller's while() loop does all the work. */
 290 #define pipe_condvar_wait(condvar, mutex) \
 291    do { pipe_mutex_unlock(mutex); \
 292         os_time_sleep(condvar); \
 293         pipe_mutex_lock(mutex); \
 294    } while (0)
 295
 296 #define pipe_condvar_signal(condvar) \
 297    (void) condvar
 298
 299 #define pipe_condvar_broadcast(condvar) \
 300    (void) condvar
 301
 302
 303 #endif  /* PIPE_OS_? */
 304
 305
 306 /*
 307  * pipe_barrier
 308  */
 309
 310 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_HAIKU) || defined(PIPE_OS_EMBEDDED)
 311
 312 typedef pthread_barrier_t pipe_barrier;
 313
 314 static INLINE void pipe_barrier_init(pipe_barrier *barrier, unsigned count)
 315 {
 316    pthread_barrier_init(barrier, NULL, count);
 317 }
 318
 319 static INLINE void pipe_barrier_destroy(pipe_barrier *barrier)
 320 {
 321    pthread_barrier_destroy(barrier);
 322 }
 323
 324 static INLINE void pipe_barrier_wait(pipe_barrier *barrier)
 325 {
 326    pthread_barrier_wait(barrier);
 327 }
 328
 329
 330 #else /* If the OS doesn't have its own, implement barriers using a mutex and a condvar */
 331
 332 typedef struct {
 333    unsigned count;
 334    unsigned waiters;
 335    uint64_t sequence;
 336    pipe_mutex mutex;
 337    pipe_condvar condvar;
 338 } pipe_barrier;
 339
 340 static INLINE void pipe_barrier_init(pipe_barrier *barrier, unsigned count)
 341 {
 342    barrier->count = count;
 343    barrier->waiters = 0;
 344    barrier->sequence = 0;
 345    pipe_mutex_init(barrier->mutex);
 346    pipe_condvar_init(barrier->condvar);
 347 }
 348
 349 static INLINE void pipe_barrier_destroy(pipe_barrier *barrier)
 350 {
 351    assert(barrier->waiters == 0);
 352    pipe_mutex_destroy(barrier->mutex);
 353    pipe_condvar_destroy(barrier->condvar);
 354 }
 355
 356 static INLINE void pipe_barrier_wait(pipe_barrier *barrier)
 357 {
 358    pipe_mutex_lock(barrier->mutex);
 359
 360    assert(barrier->waiters < barrier->count);
 361    barrier->waiters++;
 362
 363    if (barrier->waiters < barrier->count) {
 364       uint64_t sequence = barrier->sequence;
 365
 366       do {
 367          pipe_condvar_wait(barrier->condvar, barrier->mutex);
 368       } while (sequence == barrier->sequence);
 369    } else {
 370       barrier->waiters = 0;
 371       barrier->sequence++;
 372       pipe_condvar_broadcast(barrier->condvar);
 373    }
 374
 375    pipe_mutex_unlock(barrier->mutex);
 376 }
 377
 378
 379 #endif
 380
 381
 382 /*
 383  * Semaphores
 384  */
 385
 386 typedef struct
 387 {
 388    pipe_mutex mutex;
 389    pipe_condvar cond;
 390    int counter;
 391 } pipe_semaphore;
 392
 393
 394 static INLINE void
 395 pipe_semaphore_init(pipe_semaphore *sema, int init_val)
 396 {
 397    pipe_mutex_init(sema->mutex);
 398    pipe_condvar_init(sema->cond);
 399    sema->counter = init_val;
 400 }
 401
 402 static INLINE void
 403 pipe_semaphore_destroy(pipe_semaphore *sema)
 404 {
 405    pipe_mutex_destroy(sema->mutex);
 406    pipe_condvar_destroy(sema->cond);
 407 }
 408
 409 /** Signal/increment semaphore counter */
 410 static INLINE void
 411 pipe_semaphore_signal(pipe_semaphore *sema)
 412 {
 413    pipe_mutex_lock(sema->mutex);
 414    sema->counter++;
 415    pipe_condvar_signal(sema->cond);
 416    pipe_mutex_unlock(sema->mutex);
 417 }
 418
 419 /** Wait for semaphore counter to be greater than zero */
 420 static INLINE void
 421 pipe_semaphore_wait(pipe_semaphore *sema)
 422 {
 423    pipe_mutex_lock(sema->mutex);
 424    while (sema->counter <= 0) {
 425       pipe_condvar_wait(sema->cond, sema->mutex);
 426    }
 427    sema->counter--;
 428    pipe_mutex_unlock(sema->mutex);
 429 }
 430
 431
 432
 433 /*
 434  * Thread-specific data.
 435  */
 436
 437 typedef struct {
 438 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE) || defined(PIPE_OS_HAIKU) || defined(PIPE_OS_EMBEDDED) || defined(PIPE_OS_CYGWIN)
 439    pthread_key_t key;
 440 #elif defined(PIPE_SUBSYSTEM_WINDOWS_USER)
 441    DWORD key;
 442 #endif
 443    int initMagic;
 444 } pipe_tsd;
 445
 446
 447 #define PIPE_TSD_INIT_MAGIC 0xff8adc98
 448
 449
 450 static INLINE void
 451 pipe_tsd_init(pipe_tsd *tsd)
 452 {
 453 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE) || defined(PIPE_OS_HAIKU) || defined(PIPE_OS_EMBEDDED) || defined(PIPE_OS_CYGWIN)
 454    if (pthread_key_create(&tsd->key, NULL/*free*/) != 0) {
 455       perror("pthread_key_create(): failed to allocate key for thread specific data");
 456       exit(-1);
 457    }
 458 #elif defined(PIPE_SUBSYSTEM_WINDOWS_USER)
 459    assert(0);
 460 #endif
 461    tsd->initMagic = PIPE_TSD_INIT_MAGIC;
 462 }
 463
 464 static INLINE void *
 465 pipe_tsd_get(pipe_tsd *tsd)
 466 {
 467    if (tsd->initMagic != (int) PIPE_TSD_INIT_MAGIC) {
 468       pipe_tsd_init(tsd);
 469    }
 470 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE) || defined(PIPE_OS_HAIKU) || defined(PIPE_OS_EMBEDDED) || defined(PIPE_OS_CYGWIN)
 471    return pthread_getspecific(tsd->key);
 472 #elif defined(PIPE_SUBSYSTEM_WINDOWS_USER)
 473    assert(0);
 474    return NULL;
 475 #else
 476    assert(0);
 477    return NULL;
 478 #endif
 479 }
 480
 481 static INLINE void
 482 pipe_tsd_set(pipe_tsd *tsd, void *value)
 483 {
 484    if (tsd->initMagic != (int) PIPE_TSD_INIT_MAGIC) {
 485       pipe_tsd_init(tsd);
 486    }
 487 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE) || defined(PIPE_OS_HAIKU) || defined(PIPE_OS_EMBEDDED) || defined(PIPE_OS_CYGWIN)
 488    if (pthread_setspecific(tsd->key, value) != 0) {
 489       perror("pthread_set_specific() failed");
 490       exit(-1);
 491    }
 492 #elif defined(PIPE_SUBSYSTEM_WINDOWS_USER)
 493    assert(0);
 494 #else
 495    assert(0);
 496 #endif
 497 }
 498
 499
 500
 501 #endif /* OS_THREAD_H_ */