src/mesa/glapi/glthread.h

   1 /* $Id: glthread.h,v 1.5 2000/02/11 21:38:33 brianp Exp $ */
   2
   3 /*
   4  * Mesa 3-D graphics library
   5  * Version:  3.3
   6  *
   7  * Copyright (C) 1999-2000  Brian Paul   All Rights Reserved.
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included
  17  * in all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  22  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  23  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  24  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  */
  26
  27
  28 /*
  29  * Thread support for gl dispatch.
  30  *
  31  * Initial version by John Stone (j.stone@acm.org) (johns@cs.umr.edu)
  32  *                and Christoph Poliwoda (poliwoda@volumegraphics.com)
  33  * Revised by Keith Whitwell
  34  * Adapted for new gl dispatcher by Brian Paul
  35  *
  36  *
  37  *
  38  * DOCUMENTATION
  39  *
  40  * This thread module exports the following types:
  41  *   _glthread_TSD     Thread-specific data area
  42  *   _glthread_Thread  Thread datatype
  43  *   _glthread_Mutex   Mutual exclusion lock
  44  *
  45  * Macros:
  46  *   _glthread_DECLARE_STATIC_MUTEX(name)   Declare a non-local mutex
  47  *   _glthread_INIT_MUTEX(name)             Initialize a mutex
  48  *   _glthread_LOCK_MUTEX(name)             Lock a mutex
  49  *   _glthread_UNLOCK_MUTEX(name)           Unlock a mutex
  50  *
  51  * Functions:
  52  *   _glthread_GetID(v)      Get integer thread ID
  53  *   _glthread_InitTSD()     Initialize thread-specific data
  54  *   _glthread_GetTSD()      Get thread-specific data
  55  *   _glthread_SetTSD()      Set thread-specific data
  56  *
  57  */
  58
  59 /*
  60  * If this file is accidentally included by a non-threaded build,
  61  * it should not cause the build to fail, or otherwise cause problems.
  62  * In general, it should only be included when needed however.
  63  */
  64
  65
  66 #ifndef GLTHREAD_H
  67 #define GLTHREAD_H
  68
  69
  70 #if defined(PTHREADS) || defined(SOLARIS_THREADS) || defined(WIN32_THREADS) || defined(XTHREADS)
  71 #define THREADS
  72 #endif
  73
  74
  75
  76 /*
  77  * POSIX threads. This should be your choice in the Unix world
  78  * whenever possible.  When building with POSIX threads, be sure
  79  * to enable any compiler flags which will cause the MT-safe
  80  * libc (if one exists) to be used when linking, as well as any
  81  * header macros for MT-safe errno, etc.  For Solaris, this is the -mt
  82  * compiler flag.  On Solaris with gcc, use -D_REENTRANT to enable
  83  * proper compiling for MT-safe libc etc.
  84  */
  85 #if defined(PTHREADS)
  86 #include <pthread.h> /* POSIX threads headers */
  87
  88 typedef struct {
  89    pthread_key_t  key;
  90    int initMagic;
  91 } _glthread_TSD;
  92
  93 typedef pthread_t _glthread_Thread;
  94
  95 typedef pthread_mutex_t _glthread_Mutex;
  96
  97 #define _glthread_DECLARE_STATIC_MUTEX(name) \
  98    static _glthread_Mutex name = PTHREAD_MUTEX_INITIALIZER
  99
 100 #define _glthread_INIT_MUTEX(name) \
 101    pthread_mutex_init(&(name), NULL)
 102
 103 #define _glthread_LOCK_MUTEX(name) \
 104    (void) pthread_mutex_lock(&(name))
 105
 106 #define _glthread_UNLOCK_MUTEX(name) \
 107    (void) pthread_mutex_unlock(&(name))
 108
 109 #endif /* PTHREADS */
 110
 111
 112
 113
 114 /*
 115  * Solaris threads. Use only up to Solaris 2.4.
 116  * Solaris 2.5 and higher provide POSIX threads.
 117  * Be sure to compile with -mt on the Solaris compilers, or
 118  * use -D_REENTRANT if using gcc.
 119  */
 120 #ifdef SOLARIS_THREADS
 121 #include <thread.h>
 122
 123 typedef struct {
 124    thread_key_t key;
 125    mutex_t      keylock;
 126    int          initMagic;
 127 } _glthread_TSD;
 128
 129 typedef thread_t _glthread_Thread;
 130
 131 typedef mutex_t _glthread_Mutex;
 132
 133 /* XXX need to really implement mutex-related macros */
 134 #define _glthread_DECLARE_STATIC_MUTEX(name)  static _glthread_Mutex name = 0
 135 #define _glthread_INIT_MUTEX(name)  (void) name
 136 #define _glthread_LOCK_MUTEX(name)  (void) name
 137 #define _glthread_UNLOCK_MUTEX(name)  (void) name
 138
 139 #endif /* SOLARIS_THREADS */
 140
 141
 142
 143
 144 /*
 145  * Windows threads. Should work with Windows NT and 95.
 146  * IMPORTANT: Link with multithreaded runtime library when THREADS are
 147  * used!
 148  */
 149 #ifdef WIN32_THREADS
 150 #include <windows.h>
 151
 152 typedef struct {
 153    DWORD key;
 154    int   initMagic;
 155 } _glthread_TSD;
 156
 157 typedef HANDLE _glthread_Thread;
 158
 159 typedef CRITICAL_SECTION _glthread_Mutex;
 160
 161 /* XXX need to really implement mutex-related macros */
 162 #define _glthread_DECLARE_STATIC_MUTEX(name)  static _glthread_Mutex name = 0
 163 #define _glthread_INIT_MUTEX(name)  (void) name
 164 #define _glthread_LOCK_MUTEX(name)  (void) name
 165 #define _glthread_UNLOCK_MUTEX(name)  (void) name
 166
 167 #endif /* WIN32_THREADS */
 168
 169
 170
 171
 172 /*
 173  * XFree86 has its own thread wrapper, Xthreads.h
 174  * We wrap it again for GL.
 175  */
 176 #ifdef XTHREADS
 177 #include "Xthreads.h"
 178
 179 typedef struct {
 180    xthread_key_t key;
 181    int initMagic;
 182 } _glthread_TSD;
 183
 184 typedef xthread_t _glthread_Thread;
 185
 186 typedef xmutex_rec _glthread_Mutex;
 187
 188 #define _glthread_DECLARE_STATIC_MUTEX(name) \
 189    static _glthread_Mutex name = XMUTEX_INITIALIZER
 190
 191 #define _glthread_INIT_MUTEX(name) \
 192    xmutex_init(&(name))
 193
 194 #define _glthread_LOCK_MUTEX(name) \
 195    (void) xmutex_lock(&(name))
 196
 197 #define _glthread_UNLOCK_MUTEX(name) \
 198    (void) xmutex_unlock(&(name))
 199
 200 #endif /* XTHREADS */
 201
 202
 203
 204
 205 #ifndef THREADS
 206
 207 /*
 208  * THREADS not defined
 209  */
 210
 211 typedef GLuint _glthread_TSD;
 212
 213 typedef GLuint _glthread_Thread;
 214
 215 typedef GLuint _glthread_Mutex;
 216
 217 #define _glthread_DECLARE_STATIC_MUTEX(name)  static _glthread_Mutex name = 0
 218
 219 #define _glthread_INIT_MUTEX(name)  (void) name
 220
 221 #define _glthread_LOCK_MUTEX(name)  (void) name
 222
 223 #define _glthread_UNLOCK_MUTEX(name)  (void) name
 224
 225 #endif /* THREADS */
 226
 227
 228
 229 /*
 230  * Platform independent thread specific data API.
 231  */
 232
 233 extern unsigned long
 234 _glthread_GetID(void);
 235
 236
 237 extern void
 238 _glthread_InitTSD(_glthread_TSD *);
 239
 240
 241 extern void *
 242 _glthread_GetTSD(_glthread_TSD *);
 243
 244
 245 extern void
 246 _glthread_SetTSD(_glthread_TSD *, void *);
 247
 248
 249
 250 #endif /* THREADS_H */
 251