This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Integrate mainline changes into win32 branch. Now would be a good time
[perl5.git] / thread.h
CommitLineData
ea0efc06 1#ifdef USE_THREADS
12ca11f6 2
ea0efc06 3#ifdef WIN32
d55594ae
GS
4# include <win32thread.h>
5#else
12ca11f6 6
12ca11f6
MB
7/* POSIXish threads */
8typedef pthread_t perl_thread;
11343788 9#ifdef OLD_PTHREADS_API
ea0efc06
MB
10# define pthread_mutexattr_init(a) pthread_mutexattr_create(a)
11# define pthread_mutexattr_settype(a,t) pthread_mutexattr_setkind_np(a,t)
12# define pthread_key_create(k,d) pthread_keycreate(k,(pthread_destructor_t)(d))
13# define YIELD pthread_yield()
14# define DETACH(t) \
15 STMT_START { \
46930d8f 16 if (pthread_detach(&(t)->self)) { \
ea0efc06
MB
17 MUTEX_UNLOCK(&(t)->mutex); \
18 croak("panic: DETACH"); \
19 } \
20 } STMT_END
11343788 21#else
ea0efc06
MB
22# define pthread_mutexattr_default NULL
23# define pthread_condattr_default NULL
24# define pthread_attr_default NULL
11343788 25#endif /* OLD_PTHREADS_API */
d55594ae 26#endif
11343788 27
ea0efc06
MB
28#ifndef YIELD
29# define YIELD sched_yield()
30#endif
31
32#ifndef MUTEX_INIT
33#define MUTEX_INIT(m) \
34 STMT_START { \
35 if (pthread_mutex_init((m), pthread_mutexattr_default)) \
36 croak("panic: MUTEX_INIT"); \
37 } STMT_END
38#define MUTEX_LOCK(m) \
39 STMT_START { \
40 if (pthread_mutex_lock((m))) \
41 croak("panic: MUTEX_LOCK"); \
42 } STMT_END
43#define MUTEX_UNLOCK(m) \
44 STMT_START { \
45 if (pthread_mutex_unlock((m))) \
46 croak("panic: MUTEX_UNLOCK"); \
47 } STMT_END
48#define MUTEX_DESTROY(m) \
49 STMT_START { \
50 if (pthread_mutex_destroy((m))) \
51 croak("panic: MUTEX_DESTROY"); \
52 } STMT_END
53#endif /* MUTEX_INIT */
54
55#ifndef COND_INIT
56#define COND_INIT(c) \
57 STMT_START { \
58 if (pthread_cond_init((c), pthread_condattr_default)) \
59 croak("panic: COND_INIT"); \
60 } STMT_END
61#define COND_SIGNAL(c) \
62 STMT_START { \
63 if (pthread_cond_signal((c))) \
64 croak("panic: COND_SIGNAL"); \
65 } STMT_END
66#define COND_BROADCAST(c) \
67 STMT_START { \
68 if (pthread_cond_broadcast((c))) \
69 croak("panic: COND_BROADCAST"); \
70 } STMT_END
71#define COND_WAIT(c, m) \
72 STMT_START { \
73 if (pthread_cond_wait((c), (m))) \
74 croak("panic: COND_WAIT"); \
75 } STMT_END
76#define COND_DESTROY(c) \
77 STMT_START { \
78 if (pthread_cond_destroy((c))) \
79 croak("panic: COND_DESTROY"); \
80 } STMT_END
81#endif /* COND_INIT */
33f46ff6 82
f826a10b 83/* DETACH(t) must only be called while holding t->mutex */
ea0efc06
MB
84#ifndef DETACH
85#define DETACH(t) \
86 STMT_START { \
46930d8f 87 if (pthread_detach((t)->self)) { \
ea0efc06
MB
88 MUTEX_UNLOCK(&(t)->mutex); \
89 croak("panic: DETACH"); \
90 } \
91 } STMT_END
92#endif /* DETACH */
33f46ff6 93
ea0efc06
MB
94#ifndef JOIN
95#define JOIN(t, avp) \
96 STMT_START { \
46930d8f 97 if (pthread_join((t)->self, (void**)(avp))) \
ea0efc06
MB
98 croak("panic: pthread_join"); \
99 } STMT_END
100#endif /* JOIN */
101
102#ifndef SET_THR
103#define SET_THR(t) \
104 STMT_START { \
105 if (pthread_setspecific(thr_key, (void *) (t))) \
106 croak("panic: pthread_setspecific"); \
107 } STMT_END
108#endif /* SET_THR */
109
110#ifndef THR
111# ifdef OLD_PTHREADS_API
11343788 112struct thread *getTHR _((void));
ea0efc06
MB
113# define THR getTHR()
114# else
115# define THR ((struct thread *) pthread_getspecific(thr_key))
116# endif /* OLD_PTHREADS_API */
117#endif /* THR */
118
119#ifndef dTHR
120# define dTHR struct thread *thr = THR
121#endif /* dTHR */
11343788 122
33f46ff6
MB
123#ifndef INIT_THREADS
124# ifdef NEED_PTHREAD_INIT
125# define INIT_THREADS pthread_init()
126# else
127# define INIT_THREADS NOOP
128# endif
129#endif
11343788 130
d55594ae 131
ea0efc06
MB
132#ifndef THREAD_RET_TYPE
133# define THREAD_RET_TYPE void *
134# define THREAD_RET_CAST(p) ((void *)(p))
135#endif /* THREAD_RET */
136
33f46ff6 137struct thread {
11343788 138 /* The fields that used to be global */
33f46ff6 139 /* Important ones in the first cache line (if alignment is done right) */
11343788 140 SV ** Tstack_sp;
462e5cf6
MB
141#ifdef OP_IN_REGISTER
142 OP * Topsave;
143#else
11343788 144 OP * Top;
462e5cf6 145#endif
33f46ff6
MB
146 SV ** Tcurpad;
147 SV ** Tstack_base;
148
149 SV ** Tstack_max;
11343788
MB
150
151 I32 * Tscopestack;
152 I32 Tscopestack_ix;
153 I32 Tscopestack_max;
154
155 ANY * Tsavestack;
156 I32 Tsavestack_ix;
157 I32 Tsavestack_max;
158
159 OP ** Tretstack;
160 I32 Tretstack_ix;
161 I32 Tretstack_max;
162
163 I32 * Tmarkstack;
164 I32 * Tmarkstack_ptr;
165 I32 * Tmarkstack_max;
166
11343788
MB
167 SV * TSv;
168 XPV * TXpv;
11343788
MB
169 struct stat Tstatbuf;
170 struct tms Ttimesbuf;
171
172 /* XXX What about regexp stuff? */
173
174 /* Now the fields that used to be "per interpreter" (even when global) */
175
a863c7d1
MB
176 /* Fields used by magic variables such as $@, $/ and so on */
177 bool Ttainted;
178 PMOP * Tcurpm;
179 SV * Tnrs;
180 SV * Trs;
181 GV * Tlast_in_gv;
182 char * Tofs;
183 STRLEN Tofslen;
184 GV * Tdefoutgv;
185 char * Tchopset;
186 SV * Tformtarget;
187 SV * Tbodytarget;
188 SV * Ttoptarget;
189
190 /* Stashes */
11343788
MB
191 HV * Tdefstash;
192 HV * Tcurstash;
11343788 193
a863c7d1 194 /* Stacks */
11343788
MB
195 SV ** Ttmps_stack;
196 I32 Ttmps_ix;
197 I32 Ttmps_floor;
198 I32 Ttmps_max;
199
200 int Tin_eval;
201 OP * Trestartop;
202 int Tdelaymagic;
203 bool Tdirty;
204 U8 Tlocalizing;
0f15f207 205 COP * Tcurcop;
11343788 206
c09156bb 207 PERL_CONTEXT * Tcxstack;
11343788
MB
208 I32 Tcxstack_ix;
209 I32 Tcxstack_max;
210
0f15f207 211 AV * Tcurstack;
11343788 212 AV * Tmainstack;
e858de61 213 JMPENV * Ttop_env;
11343788
MB
214
215 /* XXX Sort stuff, firstgv, secongv and so on? */
216
199100c8
MB
217 SV * oursv;
218 HV * cvcache;
46930d8f 219 perl_thread self; /* Underlying thread object */
33f46ff6 220 U32 flags;
554b3eca
MB
221 AV * magicals; /* Per-thread magicals */
222 AV * specific; /* Thread-specific user data */
38a03e6e
MB
223 SV * errsv; /* Backing SV for $@ */
224 HV * errhv; /* HV for what was %@ in pp_ctl.c */
f826a10b 225 perl_mutex mutex; /* For the fields others can change */
33f46ff6
MB
226 U32 tid;
227 struct thread *next, *prev; /* Circular linked list of threads */
d55594ae 228 JMPENV Tstart_env; /* Top of top_env longjmp() chain */
00495520 229#ifdef HAVE_THREAD_INTERN
f826a10b
MB
230 struct thread_intern i; /* Platform-dependent internals */
231#endif
199100c8 232 char trailing_nul; /* For the sake of thrsv and oursv */
11343788
MB
233};
234
235typedef struct thread *Thread;
236
33f46ff6 237/* Values and macros for thr->flags */
605e5515
MB
238#define THRf_STATE_MASK 7
239#define THRf_R_JOINABLE 0
240#define THRf_R_JOINED 1
241#define THRf_R_DETACHED 2
242#define THRf_ZOMBIE 3
243#define THRf_DEAD 4
f93b4edd 244
458fb581 245#define THRf_DID_DIE 8
07b73707 246
f826a10b 247/* ThrSTATE(t) and ThrSETSTATE(t) must only be called while holding t->mutex */
458fb581 248#define ThrSTATE(t) ((t)->flags & THRf_STATE_MASK)
f93b4edd 249#define ThrSETSTATE(t, s) STMT_START { \
605e5515 250 (t)->flags &= ~THRf_STATE_MASK; \
33f46ff6 251 (t)->flags |= (s); \
605e5515
MB
252 DEBUG_L(PerlIO_printf(PerlIO_stderr(), \
253 "thread %p set to state %d\n", (t), (s))); \
f93b4edd
MB
254 } STMT_END
255
256typedef struct condpair {
f826a10b
MB
257 perl_mutex mutex; /* Protects all other fields */
258 perl_cond owner_cond; /* For when owner changes at all */
259 perl_cond cond; /* For cond_signal and cond_broadcast */
260 Thread owner; /* Currently owning thread */
f93b4edd
MB
261} condpair_t;
262
263#define MgMUTEXP(mg) (&((condpair_t *)(mg->mg_ptr))->mutex)
264#define MgOWNERCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->owner_cond)
265#define MgCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->cond)
266#define MgOWNER(mg) ((condpair_t *)(mg->mg_ptr))->owner
267
11343788
MB
268#undef stack_base
269#undef stack_sp
270#undef stack_max
0f15f207 271#undef curstack
11343788
MB
272#undef mainstack
273#undef markstack
274#undef markstack_ptr
275#undef markstack_max
276#undef scopestack
277#undef scopestack_ix
278#undef scopestack_max
279#undef savestack
280#undef savestack_ix
281#undef savestack_max
282#undef retstack
283#undef retstack_ix
284#undef retstack_max
0f15f207 285#undef curcop
11343788
MB
286#undef cxstack
287#undef cxstack_ix
288#undef cxstack_max
809a5acc
MB
289#undef defstash
290#undef curstash
6d4ff0d2
MB
291#undef tmps_stack
292#undef tmps_floor
293#undef tmps_ix
294#undef tmps_max
11343788
MB
295#undef curpad
296#undef Sv
297#undef Xpv
96827780
MB
298#undef statbuf
299#undef timesbuf
a863c7d1
MB
300#undef tainted
301#undef curpm
302#undef nrs
303#undef rs
304#undef last_in_gv
305#undef ofs
306#undef ofslen
307#undef defoutgv
308#undef chopset
309#undef formtarget
310#undef bodytarget
d55594ae 311#undef start_env
a863c7d1 312#undef toptarget
11343788 313#undef top_env
11343788 314#undef in_eval
809a5acc
MB
315#undef restartop
316#undef delaymagic
317#undef dirty
318#undef localizing
11343788 319
11343788
MB
320#define stack_base (thr->Tstack_base)
321#define stack_sp (thr->Tstack_sp)
322#define stack_max (thr->Tstack_max)
462e5cf6
MB
323#ifdef OP_IN_REGISTER
324#define opsave (thr->Topsave)
325#else
326#undef op
11343788 327#define op (thr->Top)
462e5cf6 328#endif
0f15f207 329#define curcop (thr->Tcurcop)
11343788 330#define stack (thr->Tstack)
809a5acc 331#define curstack (thr->Tcurstack)
11343788
MB
332#define mainstack (thr->Tmainstack)
333#define markstack (thr->Tmarkstack)
334#define markstack_ptr (thr->Tmarkstack_ptr)
335#define markstack_max (thr->Tmarkstack_max)
336#define scopestack (thr->Tscopestack)
337#define scopestack_ix (thr->Tscopestack_ix)
338#define scopestack_max (thr->Tscopestack_max)
339
340#define savestack (thr->Tsavestack)
341#define savestack_ix (thr->Tsavestack_ix)
342#define savestack_max (thr->Tsavestack_max)
343
344#define retstack (thr->Tretstack)
345#define retstack_ix (thr->Tretstack_ix)
346#define retstack_max (thr->Tretstack_max)
347
348#define cxstack (thr->Tcxstack)
349#define cxstack_ix (thr->Tcxstack_ix)
350#define cxstack_max (thr->Tcxstack_max)
351
352#define curpad (thr->Tcurpad)
353#define Sv (thr->TSv)
354#define Xpv (thr->TXpv)
96827780
MB
355#define statbuf (thr->Tstatbuf)
356#define timesbuf (thr->Ttimesbuf)
a863c7d1
MB
357#define tainted (thr->Ttainted)
358#define tainted (thr->Ttainted)
359#define curpm (thr->Tcurpm)
360#define nrs (thr->Tnrs)
361#define rs (thr->Trs)
362#define last_in_gv (thr->Tlast_in_gv)
363#define ofs (thr->Tofs)
57d3b86d 364#define ofslen (thr->Tofslen)
a863c7d1
MB
365#define defoutgv (thr->Tdefoutgv)
366#define chopset (thr->Tchopset)
367#define formtarget (thr->Tformtarget)
368#define bodytarget (thr->Tbodytarget)
369#define toptarget (thr->Ttoptarget)
11343788
MB
370#define defstash (thr->Tdefstash)
371#define curstash (thr->Tcurstash)
11343788
MB
372
373#define tmps_stack (thr->Ttmps_stack)
374#define tmps_ix (thr->Ttmps_ix)
375#define tmps_floor (thr->Ttmps_floor)
376#define tmps_max (thr->Ttmps_max)
377
378#define in_eval (thr->Tin_eval)
379#define restartop (thr->Trestartop)
380#define delaymagic (thr->Tdelaymagic)
381#define dirty (thr->Tdirty)
382#define localizing (thr->Tlocalizing)
383
384#define top_env (thr->Ttop_env)
d55594ae 385#define start_env (thr->Tstart_env)
11343788 386
ea0efc06
MB
387#else
388/* USE_THREADS is not defined */
389#define MUTEX_LOCK(m)
390#define MUTEX_UNLOCK(m)
391#define MUTEX_INIT(m)
392#define MUTEX_DESTROY(m)
393#define COND_INIT(c)
394#define COND_SIGNAL(c)
395#define COND_BROADCAST(c)
396#define COND_WAIT(c, m)
397#define COND_DESTROY(c)
398
399#define THR
400/* Rats: if dTHR is just blank then the subsequent ";" throws an error */
401#define dTHR extern int errno
11343788 402#endif /* USE_THREADS */