summaryrefslogtreecommitdiff
path: root/xc/extras/Mesa/src/mthreads.h
blob: 77f32d8e4df0d412cc4edeb1c2e28863df68b23b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/* $Id: mthreads.h,v 1.4 2000/01/30 00:27:02 brianp Exp $ */

/*
 * Mesa 3-D graphics library
 * Version:  3.3
 * 
 * Copyright (C) 1999  Brian Paul   All Rights Reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */


/*
 * mthreads.h -- platform dependent thread support for Mesa 
 *
 * Initial version by John Stone (j.stone@acm.org) (johns@cs.umr.edu)
 *                and Christoph Poliwoda (poliwoda@volumegraphics.com)
 *
 * Revised by Keith Whitwell
 */



/*
 * If this file is accidentally included by a non-threaded build, 
 * it should not cause the build to fail, or otherwise cause problems.
 * In general, it should only be included when needed however.
 */
#ifdef THREADS
/*
 * It is an error not to select a specific threads API when compiling.
 */
#if !defined PTHREADS && !defined SOLARIS_THREADS && !defined WIN32
#error One of PTHREADS, SOLARIS_THREADS or WIN32 must be defined.
#endif


/*
 * Error messages which should be printed when our Mesa thread APIs fail
 * for one reason or another.
 */
#define MESA_INIT_TSD_ERROR "Mesa: thread failed to allocate key for thread specific data"
#define MESA_GET_TSD_ERROR "Mesa: thread failed to get thread specific data"
#define MESA_SET_TSD_ERROR "Mesa: thread failed to set thread specific data"


/*
 * magic number for win32 and solaris threads equivalents of pthread_once
 * This could probably be done better, but we haven't figured out how yet. 
 */
#define INITFUNC_CALLED_MAGIC 0xff8adc98




/*
 * POSIX threads. This should be your choice in the Unix world
 * whenever possible.  When building with POSIX threads, be sure
 * to any able any compiler flags which will cause the MT-safe
 * libc (if one exists) to be used when linking, as well as any
 * header macros for MT-safe errno, etc.  For Solaris, this is the -mt
 * compiler flag.  On Solaris with gcc, use -D_REENTRANT to enable
 * proper compiling for MT-safe libc etc.
 */
#ifdef PTHREADS
#include <pthread.h> /* POSIX threads headers */

typedef struct {
  pthread_key_t  key;
  pthread_once_t once;
} MesaTSD;

typedef pthread_mutex_t MesaMutex;
typedef pthread_t MesaThread;

#endif /* PTHREADS */




/*
 * Solaris threads. Use only up to Solaris 2.4. 
 * Solaris 2.5 and higher provide POSIX threads.
 * Be sure to compile with -mt on the Solaris compilers, or 
 * use -D_REENTRANT if using gcc.
 */
#ifdef SOLARIS_THREADS
#include <thread.h>

typedef struct {
  thread_key_t key;
  mutex_t      keylock;
  int          initfuncCalled;
} MesaTSD;

typedef mutex_t MesaMutex;
typedef thread_t MesaThread;

#endif /* SOLARIS_THREADS */




/*
 * Windows threads. Should work with Windows NT and 95. 
 * IMPORTANT: Link with multithreaded runtime library when THREADS are
 * used!
 */

#ifdef WIN32
#include <windows.h>

typedef struct {
  DWORD key;
  int   initfuncCalled;
} MesaTSD;

typedef CRITICAL_SECTION MesaMutex;
typedef HANDLE MesaThread;

#endif /* WIN32 */




/*
 * Platform independent thread specific data API. 
 */
void  MesaInitTSD(MesaTSD *);
void* MesaGetTSD (MesaTSD *);
void  MesaSetTSD (MesaTSD *, void *, void (*initfunc)(void));


/* 
 * The following APIs are preliminary.  They may be needed in 
 * future versions of Mesa.  
 */
#if 0

/*
 * Platform independent mutual exclusion lock API.
 */
void  MesaInitMutex    (MesaMutex *);
void  MesaDestroyMutex (MesaMutex *);
void  MesaLockMutex    (MesaMutex *);
void  MesaUnlockMutex  (MesaMutex *);

/* 
 * Platform independent thread management API.
 */
MesaThread  MesaCreateThread ((void*)(*)(void*), void*);
void        MesaJoinThread   (MesaThread);

#endif 

#endif /* THREADS */