src/mesa/glapi/glthread.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.5.2
   4  *
   5  * Copyright (C) 1999-2006  Brian Paul   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  * Thread support for gl dispatch.
  28  *
  29  * Initial version by John Stone (j.stone@acm.org) (johns@cs.umr.edu)
  30  *                and Christoph Poliwoda (poliwoda@volumegraphics.com)
  31  * Revised by Keith Whitwell
  32  * Adapted for new gl dispatcher by Brian Paul
  33  *
  34  *
  35  *
  36  * DOCUMENTATION
  37  *
  38  * This thread module exports the following types:
  39  *   _glthread_TSD     Thread-specific data area
  40  *   _glthread_Thread  Thread datatype
  41  *   _glthread_Mutex   Mutual exclusion lock
  42  *
  43  * Macros:
  44  *   _glthread_DECLARE_STATIC_MUTEX(name)   Declare a non-local mutex
  45  *   _glthread_INIT_MUTEX(name)             Initialize a mutex
  46  *   _glthread_LOCK_MUTEX(name)             Lock a mutex
  47  *   _glthread_UNLOCK_MUTEX(name)           Unlock a mutex
  48  *
  49  * Functions:
  50  *   _glthread_GetID(v)      Get integer thread ID
  51  *   _glthread_InitTSD()     Initialize thread-specific data
  52  *   _glthread_GetTSD()      Get thread-specific data
  53  *   _glthread_SetTSD()      Set thread-specific data
  54  *
  55  */
  56
  57 /*
  58  * If this file is accidentally included by a non-threaded build,
  59  * it should not cause the build to fail, or otherwise cause problems.
  60  * In general, it should only be included when needed however.
  61  */
  62
  63 #ifndef GLTHREAD_H
  64 #define GLTHREAD_H
  65
  66
  67 #if defined(USE_MGL_NAMESPACE)
  68 #define _glapi_Dispatch _mglapi_Dispatch
  69 #endif
  70
  71
  72
  73 #if (defined(PTHREADS) || defined(SOLARIS_THREADS) ||\
  74      defined(WIN32_THREADS) || defined(BEOS_THREADS)) \
  75     && !defined(THREADS)
  76 # define THREADS
  77 #endif
  78
  79 #ifdef VMS
  80 #include <GL/vms_x_fix.h>
  81 #endif
  82
  83 /*
  84  * POSIX threads. This should be your choice in the Unix world
  85  * whenever possible.  When building with POSIX threads, be sure
  86  * to enable any compiler flags which will cause the MT-safe
  87  * libc (if one exists) to be used when linking, as well as any
  88  * header macros for MT-safe errno, etc.  For Solaris, this is the -mt
  89  * compiler flag.  On Solaris with gcc, use -D_REENTRANT to enable
  90  * proper compiling for MT-safe libc etc.
  91  */
  92 #if defined(PTHREADS)
  93 #include <pthread.h> /* POSIX threads headers */
  94
  95 typedef struct {
  96    pthread_key_t  key;
  97    int initMagic;
  98 } _glthread_TSD;
  99
 100 typedef pthread_t _glthread_Thread;
 101
 102 typedef pthread_mutex_t _glthread_Mutex;
 103
 104 #define _glthread_DECLARE_STATIC_MUTEX(name) \
 105    static _glthread_Mutex name = PTHREAD_MUTEX_INITIALIZER
 106
 107 #define _glthread_INIT_MUTEX(name) \
 108    pthread_mutex_init(&(name), NULL)
 109
 110 #define _glthread_DESTROY_MUTEX(name) \
 111    pthread_mutex_destroy(&(name))
 112
 113 #define _glthread_LOCK_MUTEX(name) \
 114    (void) pthread_mutex_lock(&(name))
 115
 116 #define _glthread_UNLOCK_MUTEX(name) \
 117    (void) pthread_mutex_unlock(&(name))
 118
 119 typedef pthread_cond_t _glthread_Cond;
 120
 121 #define _glthread_DECLARE_STATIC_COND(name) \
 122    static _glthread_Cond name = PTHREAD_COND_INITIALIZER
 123
 124 #define _glthread_INIT_COND(cond)                       \
 125    pthread_cond_init(&(cond), NULL)
 126
 127 #define _glthread_DESTROY_COND(name) \
 128    pthread_cond_destroy(&(name))
 129
 130 #define _glthread_COND_WAIT(cond, mutex) \
 131   pthread_cond_wait(&(cond), &(mutex))
 132
 133 #define _glthread_COND_SIGNAL(cond) \
 134   pthread_cond_signal(&(cond))
 135
 136 #define _glthread_COND_BROADCAST(cond) \
 137   pthread_cond_broadcast(&(cond))
 138
 139
 140 #else /* PTHREADS */
 141
 142 typedef unsigned int _glthread_Cond;
 143 #define _glthread_DECLARE_STATIC_COND(name) \
 144 //  #warning Condition variables not implemented.
 145
 146 #define _glthread_INIT_COND(cond)           \
 147   ASSERT(0);
 148
 149 #define _glthread_DESTROY_COND(name) \
 150   ASSERT(0);
 151
 152 #define _glthread_COND_WAIT(cond, mutex) \
 153   ASSERT(0);
 154
 155 #define _glthread_COND_SIGNAL(cond) \
 156   ASSERT(0);
 157
 158 #define _glthread_COND_BROADCAST(cond) \
 159   ASSERT(0);
 160
 161 #endif
 162
 163
 164 /*
 165  * Solaris threads. Use only up to Solaris 2.4.
 166  * Solaris 2.5 and higher provide POSIX threads.
 167  * Be sure to compile with -mt on the Solaris compilers, or
 168  * use -D_REENTRANT if using gcc.
 169  */
 170 #ifdef SOLARIS_THREADS
 171 #include <thread.h>
 172
 173 typedef struct {
 174    thread_key_t key;
 175    mutex_t      keylock;
 176    int          initMagic;
 177 } _glthread_TSD;
 178
 179 typedef thread_t _glthread_Thread;
 180
 181 typedef mutex_t _glthread_Mutex;
 182
 183 /* XXX need to really implement mutex-related macros */
 184 #define _glthread_DECLARE_STATIC_MUTEX(name)  static _glthread_Mutex name = 0
 185 #define _glthread_INIT_MUTEX(name)  (void) name
 186 #define _glthread_DESTROY_MUTEX(name) (void) name
 187 #define _glthread_LOCK_MUTEX(name)  (void) name
 188 #define _glthread_UNLOCK_MUTEX(name)  (void) name
 189
 190 #endif /* SOLARIS_THREADS */
 191
 192
 193
 194
 195 /*
 196  * Windows threads. Should work with Windows NT and 95.
 197  * IMPORTANT: Link with multithreaded runtime library when THREADS are
 198  * used!
 199  */
 200 #ifdef WIN32_THREADS
 201 #include <windows.h>
 202
 203 typedef struct {
 204    DWORD key;
 205    int   initMagic;
 206 } _glthread_TSD;
 207
 208 typedef HANDLE _glthread_Thread;
 209
 210 typedef CRITICAL_SECTION _glthread_Mutex;
 211
 212 #define _glthread_DECLARE_STATIC_MUTEX(name)  /*static*/ _glthread_Mutex name = {0,0,0,0,0,0}
 213 #define _glthread_INIT_MUTEX(name)  InitializeCriticalSection(&name)
 214 #define _glthread_DESTROY_MUTEX(name)  DeleteCriticalSection(&name)
 215 #define _glthread_LOCK_MUTEX(name)  EnterCriticalSection(&name)
 216 #define _glthread_UNLOCK_MUTEX(name)  LeaveCriticalSection(&name)
 217
 218 #endif /* WIN32_THREADS */
 219
 220
 221 /*
 222  * BeOS threads. R5.x required.
 223  */
 224 #ifdef BEOS_THREADS
 225
 226 /* Problem with OS.h and this file on haiku */
 227 #ifndef __HAIKU__
 228 #include <kernel/OS.h>
 229 #endif
 230
 231 #include <support/TLS.h>
 232
 233 /* The only two typedefs required here
 234  * this is cause of the OS.h problem
 235  */
 236 #ifdef __HAIKU__
 237 typedef int32 thread_id;
 238 typedef int32 sem_id;
 239 #endif
 240
 241 typedef struct {
 242    int32        key;
 243    int          initMagic;
 244 } _glthread_TSD;
 245
 246 typedef thread_id _glthread_Thread;
 247
 248 /* Use Benaphore, aka speeder semaphore */
 249 typedef struct {
 250     int32   lock;
 251     sem_id  sem;
 252 } benaphore;
 253 typedef benaphore _glthread_Mutex;
 254
 255 #define _glthread_DECLARE_STATIC_MUTEX(name)  static _glthread_Mutex name = { 0, 0 }
 256 #define _glthread_INIT_MUTEX(name)      name.sem = create_sem(0, #name"_benaphore"), name.lock = 0
 257 #define _glthread_DESTROY_MUTEX(name)   delete_sem(name.sem), name.lock = 0
 258 #define _glthread_LOCK_MUTEX(name)      if (name.sem == 0) _glthread_INIT_MUTEX(name); \
 259                                                                                 if (atomic_add(&(name.lock), 1) >= 1) acquire_sem(name.sem)
 260 #define _glthread_UNLOCK_MUTEX(name)    if (atomic_add(&(name.lock), -1) > 1) release_sem(name.sem)
 261
 262 #endif /* BEOS_THREADS */
 263
 264
 265
 266 #ifndef THREADS
 267
 268 /*
 269  * THREADS not defined
 270  */
 271
 272 typedef unsigned _glthread_TSD;
 273
 274 typedef unsigned _glthread_Thread;
 275
 276 typedef unsigned _glthread_Mutex;
 277
 278 #define _glthread_DECLARE_STATIC_MUTEX(name)  static _glthread_Mutex name = 0
 279
 280 #define _glthread_INIT_MUTEX(name)  (void) name
 281
 282 #define _glthread_DESTROY_MUTEX(name)  (void) name
 283
 284 #define _glthread_LOCK_MUTEX(name)  (void) name
 285
 286 #define _glthread_UNLOCK_MUTEX(name)  (void) name
 287
 288 #endif /* THREADS */
 289
 290
 291
 292 /*
 293  * Platform independent thread specific data API.
 294  */
 295
 296 extern unsigned long
 297 _glthread_GetID(void);
 298
 299
 300 extern void
 301 _glthread_InitTSD(_glthread_TSD *);
 302
 303
 304 extern void *
 305 _glthread_GetTSD(_glthread_TSD *);
 306
 307
 308 extern void
 309 _glthread_SetTSD(_glthread_TSD *, void *);
 310
 311 #if !defined __GNUC__ || __GNUC__ < 3
 312 #  define __builtin_expect(x, y) x
 313 #endif
 314
 315 #if defined(GLX_USE_TLS)
 316
 317 extern __thread struct _glapi_table * _glapi_tls_Dispatch
 318     __attribute__((tls_model("initial-exec")));
 319
 320 #define GET_DISPATCH() _glapi_tls_Dispatch
 321
 322 #elif !defined(GL_CALL)
 323 # if defined(THREADS)
 324 #  define GET_DISPATCH() \
 325    ((__builtin_expect( _glapi_Dispatch != NULL, 1 )) \
 326        ? _glapi_Dispatch : _glapi_get_dispatch())
 327 # else
 328 #  define GET_DISPATCH() _glapi_Dispatch
 329 # endif /* defined(THREADS) */
 330 #endif  /* ndef GL_CALL */
 331
 332
 333 #endif /* THREADS_H */