Added THREADSPECIFIC define.
[cacao.git] / src / threads / native / threads.h
1 /* threads/native/threads.h - native threads header
2
3    Copyright (C) 1996-2005 R. Grafl, A. Krall, C. Kruegel, C. Oates,
4    R. Obermaisser, M. Platter, M. Probst, S. Ring, E. Steiner,
5    C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich, J. Wenninger,
6    Institut f. Computersprachen - TU Wien
7
8    This file is part of CACAO.
9
10    This program is free software; you can redistribute it and/or
11    modify it under the terms of the GNU General Public License as
12    published by the Free Software Foundation; either version 2, or (at
13    your option) any later version.
14
15    This program is distributed in the hope that it will be useful, but
16    WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18    General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with this program; if not, write to the Free Software
22    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
23    02111-1307, USA.
24
25    Contact: cacao@complang.tuwien.ac.at
26
27    Authors: Stefan Ring
28
29    $Id: threads.h 1923 2005-02-10 10:43:41Z twisti $
30
31 */
32
33
34 #ifndef _THREADS_H
35 #define _THREADS_H
36
37 #include <pthread.h>
38 #include <semaphore.h>
39
40 #include "mm/memory.h"
41 #include "native/jni.h"
42 #include "native/include/java_lang_Object.h" /* required by java/lang/VMThread*/
43 #include "native/include/java_lang_Thread.h"
44 #include "native/include/java_lang_VMThread.h"
45
46 #if defined(__DARWIN__)
47 #include <mach/mach.h>
48
49 /* We need to emulate recursive mutexes. */
50 #define MUTEXSIM
51 #endif
52
53
54 #if defined(HAVE___THREAD)
55
56 #define THREADSPECIFIC    __thread
57 #define THREADOBJECT      ((java_lang_VMThread*) threadobj)
58 #define THREADINFO        (&threadobj->info)
59
60 extern __thread threadobject *threadobj;
61
62 #else /* defined(HAVE___THREAD) */
63
64 #define THREADSPECIFIC
65 #define THREADOBJECT ((java_lang_VMThread*) pthread_getspecific(tkey_threadinfo))
66 #define THREADINFO (&((threadobject*) pthread_getspecific(tkey_threadinfo))->info)
67
68 extern pthread_key_t tkey_threadinfo;
69
70 #endif /* defined(HAVE___THREAD) */
71
72
73 /* typedefs *******************************************************************/
74
75 typedef struct ExecEnvironment ExecEnvironment;
76 typedef struct nativethread nativethread;
77 typedef struct threadobject threadobject;
78 typedef struct monitorLockRecord monitorLockRecord;
79 typedef struct lockRecordPoolHeader lockRecordPoolHeader;
80 typedef struct lockRecordPool lockRecordPool;
81 typedef java_lang_Thread thread;
82
83
84 /* ExecEnvironment *************************************************************
85
86    Monitor lock implementation
87
88 *******************************************************************************/
89
90 struct ExecEnvironment {
91         monitorLockRecord *firstLR;
92         lockRecordPool    *lrpool;
93         int                numlr;
94 };
95
96
97 struct nativethread {
98         threadobject      *next;
99         threadobject      *prev;
100         java_objectheader *_exceptionptr;
101         methodinfo        *_threadrootmethod;
102         void              *_stackframeinfo;
103         pthread_t          tid;
104 #if defined(__DARWIN__)
105         mach_port_t        mach_thread;
106 #endif
107         pthread_mutex_t    joinMutex;
108         pthread_cond_t     joinCond;
109 };
110
111
112 /* threadobject ****************************************************************
113
114    DOCUMENT ME!
115
116 *******************************************************************************/
117
118 struct threadobject {
119         java_lang_VMThread  o;
120         nativethread        info;
121         ExecEnvironment     ee;
122
123         pthread_mutex_t     waitLock;
124         pthread_cond_t      waitCond;
125         bool                interrupted;
126         bool                signaled;
127         bool                isSleeping;
128
129         dumpinfo            dumpinfo;       /* dump memory info structure         */
130 };
131
132
133 struct monitorLockRecord {
134         threadobject      *ownerThread;
135         java_objectheader *o;
136         int                lockCount;
137         monitorLockRecord *nextFree;
138         int                queuers;
139         monitorLockRecord *waiter;
140         monitorLockRecord *incharge;
141         bool               waiting;
142         sem_t              queueSem;
143         pthread_mutex_t    resolveLock;
144         pthread_cond_t     resolveWait;
145 };
146
147
148
149 struct lockRecordPoolHeader {
150         lockRecordPool *next;
151         int             size;
152 }; 
153
154 struct lockRecordPool {
155         lockRecordPoolHeader header;
156         monitorLockRecord    lr[1];
157 };
158
159
160 monitorLockRecord *monitorEnter(threadobject *, java_objectheader *);
161 bool monitorExit(threadobject *, java_objectheader *);
162
163 bool threadHoldsLock(threadobject *t, java_objectheader *o);
164 void signal_cond_for_object (java_objectheader *obj);
165 void broadcast_cond_for_object (java_objectheader *obj);
166 void wait_cond_for_object (java_objectheader *obj, s8 time, s4 nanos);
167
168 void initThreadsEarly();
169 void initThreads(u1 *stackbottom);
170 void initObjectLock(java_objectheader *);
171 void initLocks();
172 void initThread(java_lang_VMThread *);
173 void startThread(thread *t);
174 void joinAllThreads();
175
176 void sleepThread(s8 millis, s4 nanos);
177 void yieldThread();
178
179 void setPriorityThread(thread *t, s4 priority);
180
181 void interruptThread(java_lang_VMThread *);
182 bool interruptedThread();
183 bool isInterruptedThread(java_lang_VMThread *);
184
185 /* This must not be changed, it is used in asm_criticalsections */
186 typedef struct {
187         u1 *mcodebegin;
188         u1 *mcodeend;
189         u1 *mcoderestart;
190 } threadcritnode;
191
192 void thread_registercritical(threadcritnode *);
193 u1 *thread_checkcritical(u1*);
194
195 extern volatile int stopworldwhere;
196
197 void cast_stopworld();
198 void cast_startworld();
199
200 #endif /* _THREADS_H */
201
202
203 /*
204  * These are local overrides for various environment variables in Emacs.
205  * Please do not remove this and leave it at the end of the file, where
206  * Emacs will automagically detect them.
207  * ---------------------------------------------------------------------
208  * Local variables:
209  * mode: c
210  * indent-tabs-mode: t
211  * c-basic-offset: 4
212  * tab-width: 4
213  * End:
214  */