This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix Win32 breakage caused by changes 23535/23542.
[perl5.git] / thread.h
CommitLineData
d6376244
JH
1/* thread.h
2 *
b5f8cc5c 3 * Copyright (C) 1999, 2000, 2001, 2002, 2004, by Larry Wall and others
d6376244
JH
4 *
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
7 *
8 */
9
3db8f154 10#if defined(USE_ITHREADS)
12ca11f6 11
fd8cd3a3
DS
12#if defined(VMS)
13#include <builtins.h>
14#endif
15
ea0efc06 16#ifdef WIN32
d55594ae
GS
17# include <win32thread.h>
18#else
2986a63f
JH
19#ifdef NETWARE
20# include <nw5thread.h>
21#else
0d85d877 22# ifdef OLD_PTHREADS_API /* Here be dragons. */
ba869deb
GS
23# define DETACH(t) \
24 STMT_START { \
28a80024
MHM
25 int _eC_; \
26 if ((_eC_ = pthread_detach(&(t)->self))) { \
ba869deb 27 MUTEX_UNLOCK(&(t)->mutex); \
28a80024
MHM
28 Perl_croak_nocontext("panic: DETACH (%d) [%s:%d]", \
29 _eC_, __FILE__, __LINE__); \
ba869deb 30 } \
ea0efc06 31 } STMT_END
ba869deb
GS
32
33# define PERL_GET_CONTEXT Perl_get_context()
34# define PERL_SET_CONTEXT(t) Perl_set_context((void*)t)
35
0d85d877
JH
36# define PTHREAD_GETSPECIFIC_INT
37# ifdef DJGPP
38# define pthread_addr_t any_t
39# define NEED_PTHREAD_INIT
6dc3770d 40# define PTHREAD_CREATE_JOINABLE (1)
0d85d877
JH
41# endif
42# ifdef __OPEN_VM
43# define pthread_addr_t void *
44# endif
20b634c2
JH
45# ifdef OEMVS
46# define pthread_addr_t void *
20b634c2
JH
47# define pthread_create(t,a,s,d) pthread_create(t,&(a),s,d)
48# define pthread_keycreate pthread_key_create
49# endif
0d85d877
JH
50# ifdef VMS
51# define pthread_attr_init(a) pthread_attr_create(a)
52# define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_setdetach_np(a,s)
6dc3770d 53# define PTHREAD_CREATE(t,a,s,d) pthread_create(t,a,s,d)
0d85d877
JH
54# define pthread_key_create(k,d) pthread_keycreate(k,(pthread_destructor_t)(d))
55# define pthread_mutexattr_init(a) pthread_mutexattr_create(a)
9bbd4fab 56# define pthread_mutexattr_settype(a,t) pthread_mutexattr_setkind_np(a,t)
0d85d877 57# endif
2eb25c99
JH
58# if defined(__hpux) && defined(__ux_version) && __ux_version <= 1020
59# define pthread_attr_init(a) pthread_attr_create(a)
60 /* XXX pthread_setdetach_np() missing in DCE threads on HP-UX 10.20 */
10617789 61# define PTHREAD_ATTR_SETDETACHSTATE(a,s) (0)
2eb25c99
JH
62# define PTHREAD_CREATE(t,a,s,d) pthread_create(t,a,s,d)
63# define pthread_key_create(k,d) pthread_keycreate(k,(pthread_destructor_t)(d))
64# define pthread_mutexattr_init(a) pthread_mutexattr_create(a)
65# define pthread_mutexattr_settype(a,t) pthread_mutexattr_setkind_np(a,t)
66# endif
20b634c2 67# if defined(DJGPP) || defined(__OPEN_VM) || defined(OEMVS)
0d85d877
JH
68# define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_attr_setdetachstate(a,&(s))
69# define YIELD pthread_yield(NULL)
70# endif
0d85d877 71# endif
2eb25c99 72# if !defined(__hpux) || !defined(__ux_version) || __ux_version > 1020
1cfa4ec7 73# define pthread_mutexattr_default NULL
0d85d877 74# define pthread_condattr_default NULL
2eb25c99 75# endif
2986a63f 76#endif /* NETWARE */
0d85d877
JH
77#endif
78
79#ifndef PTHREAD_CREATE
80/* You are not supposed to pass NULL as the 2nd arg of PTHREAD_CREATE(). */
81# define PTHREAD_CREATE(t,a,s,d) pthread_create(t,&(a),s,d)
82#endif
83
84#ifndef PTHREAD_ATTR_SETDETACHSTATE
85# define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_attr_setdetachstate(a,s)
d55594ae 86#endif
1cfa4ec7 87
ef4af2be
JH
88#ifndef PTHREAD_CREATE_JOINABLE
89# ifdef OLD_PTHREAD_CREATE_JOINABLE
90# define PTHREAD_CREATE_JOINABLE OLD_PTHREAD_CREATE_JOINABLE
91# else
92# define PTHREAD_CREATE_JOINABLE 0 /* Panic? No, guess. */
93# endif
94#endif
95
5cbe9849 96#ifdef DGUX
95036ac7 97# define THREAD_CREATE_NEEDS_STACK (32*1024)
5cbe9849
JH
98#endif
99
7f3d1cf1
BH
100#ifdef I_MACH_CTHREADS
101
102/* cthreads interface */
103
104/* #include <mach/cthreads.h> is in perl.h #ifdef I_MACH_CTHREADS */
105
ba869deb
GS
106#define MUTEX_INIT(m) \
107 STMT_START { \
108 *m = mutex_alloc(); \
109 if (*m) { \
110 mutex_init(*m); \
111 } else { \
28a80024
MHM
112 Perl_croak_nocontext("panic: MUTEX_INIT [%s:%d]", \
113 __FILE__, __LINE__); \
ba869deb
GS
114 } \
115 } STMT_END
116
117#define MUTEX_LOCK(m) mutex_lock(*m)
ba869deb 118#define MUTEX_UNLOCK(m) mutex_unlock(*m)
ba869deb
GS
119#define MUTEX_DESTROY(m) \
120 STMT_START { \
121 mutex_free(*m); \
122 *m = 0; \
123 } STMT_END
124
125#define COND_INIT(c) \
126 STMT_START { \
127 *c = condition_alloc(); \
128 if (*c) { \
129 condition_init(*c); \
130 } \
131 else { \
28a80024
MHM
132 Perl_croak_nocontext("panic: COND_INIT [%s:%d]", \
133 __FILE__, __LINE__); \
ba869deb
GS
134 } \
135 } STMT_END
7f3d1cf1
BH
136
137#define COND_SIGNAL(c) condition_signal(*c)
138#define COND_BROADCAST(c) condition_broadcast(*c)
139#define COND_WAIT(c, m) condition_wait(*c, *m)
ba869deb
GS
140#define COND_DESTROY(c) \
141 STMT_START { \
142 condition_free(*c); \
143 *c = 0; \
144 } STMT_END
7f3d1cf1
BH
145
146#define THREAD_CREATE(thr, f) (thr->self = cthread_fork(f, thr), 0)
147#define THREAD_POST_CREATE(thr)
148
149#define THREAD_RET_TYPE any_t
150#define THREAD_RET_CAST(x) ((any_t) x)
151
152#define DETACH(t) cthread_detach(t->self)
153#define JOIN(t, avp) (*(avp) = (AV *)cthread_join(t->self))
154
ba869deb
GS
155#define PERL_SET_CONTEXT(t) cthread_set_data(cthread_self(), t)
156#define PERL_GET_CONTEXT cthread_data(cthread_self())
7f3d1cf1
BH
157
158#define INIT_THREADS cthread_init()
159#define YIELD cthread_yield()
ba869deb 160#define ALLOC_THREAD_KEY NOOP
e1b5da64 161#define FREE_THREAD_KEY NOOP
7f3d1cf1
BH
162#define SET_THREAD_SELF(thr) (thr->self = cthread_self())
163
164#endif /* I_MACH_CTHREADS */
165
1cfa4ec7 166#ifndef YIELD
e7a4f449
JH
167# ifdef SCHED_YIELD
168# define YIELD SCHED_YIELD
169# else
170# ifdef HAS_SCHED_YIELD
171# define YIELD sched_yield()
172# else
173# ifdef HAS_PTHREAD_YIELD
174 /* pthread_yield(NULL) platforms are expected
175 * to have #defined YIELD for themselves. */
176# define YIELD pthread_yield()
177# endif
178# endif
179# endif
9731c6ca 180#endif
11343788 181
227c31c3
JH
182#ifdef __hpux
183# define MUTEX_INIT_NEEDS_MUTEX_ZEROED
184#endif
185
ea0efc06 186#ifndef MUTEX_INIT
ba869deb
GS
187
188# ifdef MUTEX_INIT_NEEDS_MUTEX_ZEROED
227c31c3 189 /* Temporary workaround, true bug is deeper. --jhi 1999-02-25 */
ba869deb 190# define MUTEX_INIT(m) \
227c31c3 191 STMT_START { \
28a80024 192 int _eC_; \
227c31c3 193 Zero((m), 1, perl_mutex); \
28a80024
MHM
194 if ((_eC_ = pthread_mutex_init((m), pthread_mutexattr_default))) \
195 Perl_croak_nocontext("panic: MUTEX_INIT (%d) [%s:%d]", \
196 _eC_, __FILE__, __LINE__); \
227c31c3 197 } STMT_END
ba869deb
GS
198# else
199# define MUTEX_INIT(m) \
ea0efc06 200 STMT_START { \
28a80024
MHM
201 int _eC_; \
202 if ((_eC_ = pthread_mutex_init((m), pthread_mutexattr_default))) \
203 Perl_croak_nocontext("panic: MUTEX_INIT (%d) [%s:%d]", \
204 _eC_, __FILE__, __LINE__); \
ea0efc06 205 } STMT_END
ba869deb
GS
206# endif
207
208# define MUTEX_LOCK(m) \
209 STMT_START { \
28a80024
MHM
210 int _eC_; \
211 if ((_eC_ = pthread_mutex_lock((m)))) \
212 Perl_croak_nocontext("panic: MUTEX_LOCK (%d) [%s:%d]", \
213 _eC_, __FILE__, __LINE__); \
cea2e8a9 214 } STMT_END
ba869deb 215
efc57feb 216# define MUTEX_UNLOCK(m) \
ba869deb 217 STMT_START { \
28a80024
MHM
218 int _eC_; \
219 if ((_eC_ = pthread_mutex_unlock((m)))) \
220 Perl_croak_nocontext("panic: MUTEX_UNLOCK (%d) [%s:%d]", \
221 _eC_, __FILE__, __LINE__); \
ea0efc06 222 } STMT_END
ba869deb
GS
223
224# define MUTEX_DESTROY(m) \
225 STMT_START { \
28a80024
MHM
226 int _eC_; \
227 if ((_eC_ = pthread_mutex_destroy((m)))) \
228 Perl_croak_nocontext("panic: MUTEX_DESTROY (%d) [%s:%d]", \
229 _eC_, __FILE__, __LINE__); \
ea0efc06
MB
230 } STMT_END
231#endif /* MUTEX_INIT */
232
233#ifndef COND_INIT
ba869deb 234# define COND_INIT(c) \
ea0efc06 235 STMT_START { \
28a80024
MHM
236 int _eC_; \
237 if ((_eC_ = pthread_cond_init((c), pthread_condattr_default))) \
238 Perl_croak_nocontext("panic: COND_INIT (%d) [%s:%d]", \
239 _eC_, __FILE__, __LINE__); \
ea0efc06 240 } STMT_END
ba869deb
GS
241
242# define COND_SIGNAL(c) \
243 STMT_START { \
28a80024
MHM
244 int _eC_; \
245 if ((_eC_ = pthread_cond_signal((c)))) \
246 Perl_croak_nocontext("panic: COND_SIGNAL (%d) [%s:%d]", \
247 _eC_, __FILE__, __LINE__); \
ea0efc06 248 } STMT_END
ba869deb
GS
249
250# define COND_BROADCAST(c) \
251 STMT_START { \
28a80024
MHM
252 int _eC_; \
253 if ((_eC_ = pthread_cond_broadcast((c)))) \
254 Perl_croak_nocontext("panic: COND_BROADCAST (%d) [%s:%d]", \
255 _eC_, __FILE__, __LINE__); \
ea0efc06 256 } STMT_END
ba869deb
GS
257
258# define COND_WAIT(c, m) \
259 STMT_START { \
28a80024
MHM
260 int _eC_; \
261 if ((_eC_ = pthread_cond_wait((c), (m)))) \
262 Perl_croak_nocontext("panic: COND_WAIT (%d) [%s:%d]", \
263 _eC_, __FILE__, __LINE__); \
ea0efc06 264 } STMT_END
ba869deb
GS
265
266# define COND_DESTROY(c) \
267 STMT_START { \
28a80024
MHM
268 int _eC_; \
269 if ((_eC_ = pthread_cond_destroy((c)))) \
270 Perl_croak_nocontext("panic: COND_DESTROY (%d) [%s:%d]", \
271 _eC_, __FILE__, __LINE__); \
ea0efc06
MB
272 } STMT_END
273#endif /* COND_INIT */
33f46ff6 274
f826a10b 275/* DETACH(t) must only be called while holding t->mutex */
ea0efc06 276#ifndef DETACH
ba869deb
GS
277# define DETACH(t) \
278 STMT_START { \
28a80024
MHM
279 int _eC_; \
280 if ((_eC_ = pthread_detach((t)->self))) { \
ba869deb 281 MUTEX_UNLOCK(&(t)->mutex); \
28a80024
MHM
282 Perl_croak_nocontext("panic: DETACH (%d) [%s:%d]", \
283 _eC_, __FILE__, __LINE__); \
ba869deb 284 } \
ea0efc06
MB
285 } STMT_END
286#endif /* DETACH */
33f46ff6 287
ea0efc06 288#ifndef JOIN
ba869deb
GS
289# define JOIN(t, avp) \
290 STMT_START { \
28a80024
MHM
291 int _eC_; \
292 if ((_eC_ = pthread_join((t)->self, (void**)(avp)))) \
293 Perl_croak_nocontext("panic: pthread_join (%d) [%s:%d]", \
294 _eC_, __FILE__, __LINE__); \
ea0efc06
MB
295 } STMT_END
296#endif /* JOIN */
297
0953243c
JH
298/* Use an unchecked fetch of thread-specific data instead of a checked one.
299 * It would fail if the key were bogus, but if the key were bogus then
300 * Really Bad Things would be happening anyway. --dan */
026b9da6 301#if (defined(__ALPHA) && (__VMS_VER >= 70000000)) || \
cb23e6a4 302 (defined(__alpha) && defined(__osf__) && !defined(__GNUC__)) /* Available only on >= 4.0 */
8b8b35ab
JH
303# define HAS_PTHREAD_UNCHECKED_GETSPECIFIC_NP /* Configure test needed */
304#endif
305
306#ifdef HAS_PTHREAD_UNCHECKED_GETSPECIFIC_NP
307# define PTHREAD_GETSPECIFIC(key) pthread_unchecked_getspecific_np(key)
308#else
6cfe8af5 309# define PTHREAD_GETSPECIFIC(key) pthread_getspecific(key)
8b8b35ab
JH
310#endif
311
312#ifndef PERL_GET_CONTEXT
313# define PERL_GET_CONTEXT PTHREAD_GETSPECIFIC(PL_thr_key)
ba869deb
GS
314#endif
315
316#ifndef PERL_SET_CONTEXT
317# define PERL_SET_CONTEXT(t) \
318 STMT_START { \
28a80024
MHM
319 int _eC_; \
320 if ((_eC_ = pthread_setspecific(PL_thr_key, (void *)(t)))) \
321 Perl_croak_nocontext("panic: pthread_setspecific (%d) [%s:%d]", \
322 _eC_, __FILE__, __LINE__); \
ea0efc06 323 } STMT_END
ba869deb 324#endif /* PERL_SET_CONTEXT */
ea0efc06 325
1feb2720
GS
326#ifndef INIT_THREADS
327# ifdef NEED_PTHREAD_INIT
328# define INIT_THREADS pthread_init()
329# endif
0d85d877 330#endif
ea0efc06 331
ba869deb
GS
332#ifndef ALLOC_THREAD_KEY
333# define ALLOC_THREAD_KEY \
334 STMT_START { \
28a80024
MHM
335 int _eC_; \
336 if ((_eC_ = pthread_key_create(&PL_thr_key, 0))) { \
337 PerlIO_printf(PerlIO_stderr(), "panic: pthread_key_create (%d) [%s:%d]", \
338 _eC_, __FILE__, __LINE__); \
c44d3fdb
GS
339 exit(1); \
340 } \
ba869deb
GS
341 } STMT_END
342#endif
343
e1b5da64
GS
344#ifndef FREE_THREAD_KEY
345# define FREE_THREAD_KEY \
346 STMT_START { \
347 pthread_key_delete(PL_thr_key); \
348 } STMT_END
349#endif
350
50dd6e57 351#ifndef PTHREAD_ATFORK
144e72cb
RS
352# ifdef HAS_PTHREAD_ATFORK
353# define PTHREAD_ATFORK(prepare,parent,child) \
de992003 354 pthread_atfork(prepare,parent,child)
144e72cb 355# else
8ff9412f
RS
356# define PTHREAD_ATFORK(prepare,parent,child) \
357 NOOP
144e72cb 358# endif
50dd6e57
GS
359#endif
360
1feb2720
GS
361#ifndef THREAD_RET_TYPE
362# define THREAD_RET_TYPE void *
363# define THREAD_RET_CAST(p) ((void *)(p))
364#endif /* THREAD_RET */
365
e2975953
JH
366# define LOCK_DOLLARZERO_MUTEX MUTEX_LOCK(&PL_dollarzero_mutex)
367# define UNLOCK_DOLLARZERO_MUTEX MUTEX_UNLOCK(&PL_dollarzero_mutex)
368
3db8f154 369#endif /* USE_ITHREADS */
1feb2720
GS
370
371#ifndef MUTEX_LOCK
372# define MUTEX_LOCK(m)
373#endif
374
1feb2720
GS
375#ifndef MUTEX_UNLOCK
376# define MUTEX_UNLOCK(m)
377#endif
1feb2720
GS
378
379#ifndef MUTEX_INIT
380# define MUTEX_INIT(m)
381#endif
382
383#ifndef MUTEX_DESTROY
384# define MUTEX_DESTROY(m)
385#endif
386
387#ifndef COND_INIT
388# define COND_INIT(c)
389#endif
390
391#ifndef COND_SIGNAL
392# define COND_SIGNAL(c)
393#endif
394
395#ifndef COND_BROADCAST
396# define COND_BROADCAST(c)
397#endif
398
399#ifndef COND_WAIT
400# define COND_WAIT(c, m)
401#endif
402
403#ifndef COND_DESTROY
404# define COND_DESTROY(c)
405#endif
406
407#ifndef LOCK_SV_MUTEX
408# define LOCK_SV_MUTEX
409#endif
410
411#ifndef UNLOCK_SV_MUTEX
412# define UNLOCK_SV_MUTEX
413#endif
414
415#ifndef LOCK_STRTAB_MUTEX
416# define LOCK_STRTAB_MUTEX
417#endif
418
419#ifndef UNLOCK_STRTAB_MUTEX
420# define UNLOCK_STRTAB_MUTEX
421#endif
422
423#ifndef LOCK_CRED_MUTEX
424# define LOCK_CRED_MUTEX
425#endif
426
427#ifndef UNLOCK_CRED_MUTEX
428# define UNLOCK_CRED_MUTEX
429#endif
430
4755096e
GS
431#ifndef LOCK_FDPID_MUTEX
432# define LOCK_FDPID_MUTEX
433#endif
434
435#ifndef UNLOCK_FDPID_MUTEX
436# define UNLOCK_FDPID_MUTEX
437#endif
438
631cfb58
GS
439#ifndef LOCK_SV_LOCK_MUTEX
440# define LOCK_SV_LOCK_MUTEX
441#endif
442
443#ifndef UNLOCK_SV_LOCK_MUTEX
444# define UNLOCK_SV_LOCK_MUTEX
445#endif
446
e2975953
JH
447#ifndef LOCK_DOLLARZERO_MUTEX
448# define LOCK_DOLLARZERO_MUTEX
449#endif
450
451#ifndef UNLOCK_DOLLARZERO_MUTEX
452# define UNLOCK_DOLLARZERO_MUTEX
453#endif
454
ba869deb 455/* THR, SET_THR, and dTHR are there for compatibility with old versions */
1feb2720 456#ifndef THR
ba869deb
GS
457# define THR PERL_GET_THX
458#endif
459
460#ifndef SET_THR
461# define SET_THR(t) PERL_SET_THX(t)
1feb2720
GS
462#endif
463
464#ifndef dTHR
465# define dTHR dNOOP
466#endif
467
468#ifndef INIT_THREADS
469# define INIT_THREADS NOOP
470#endif