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