This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
avoid using context pointer in MUTEX_INIT() et al; remove the
[perl5.git] / thread.h
CommitLineData
1feb2720 1#if defined(USE_THREADS) || defined(USE_ITHREADS)
12ca11f6 2
ea0efc06 3#ifdef WIN32
d55594ae
GS
4# include <win32thread.h>
5#else
0d85d877 6# ifdef OLD_PTHREADS_API /* Here be dragons. */
ba869deb
GS
7# define DETACH(t) \
8 STMT_START { \
9 if (pthread_detach(&(t)->self)) { \
10 MUTEX_UNLOCK(&(t)->mutex); \
efc57feb 11 Perl_croak_nocontext("panic: DETACH"); \
ba869deb 12 } \
ea0efc06 13 } STMT_END
ba869deb
GS
14
15# define PERL_GET_CONTEXT Perl_get_context()
16# define PERL_SET_CONTEXT(t) Perl_set_context((void*)t)
17
0d85d877
JH
18# define PTHREAD_GETSPECIFIC_INT
19# ifdef DJGPP
20# define pthread_addr_t any_t
21# define NEED_PTHREAD_INIT
6dc3770d 22# define PTHREAD_CREATE_JOINABLE (1)
0d85d877
JH
23# endif
24# ifdef __OPEN_VM
25# define pthread_addr_t void *
26# endif
27# ifdef VMS
28# define pthread_attr_init(a) pthread_attr_create(a)
29# define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_setdetach_np(a,s)
6dc3770d 30# define PTHREAD_CREATE(t,a,s,d) pthread_create(t,a,s,d)
0d85d877
JH
31# define pthread_key_create(k,d) pthread_keycreate(k,(pthread_destructor_t)(d))
32# define pthread_mutexattr_init(a) pthread_mutexattr_create(a)
9bbd4fab 33# define pthread_mutexattr_settype(a,t) pthread_mutexattr_setkind_np(a,t)
0d85d877
JH
34# endif
35# if defined(DJGPP) || defined(__OPEN_VM)
36# define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_attr_setdetachstate(a,&(s))
37# define YIELD pthread_yield(NULL)
38# endif
0d85d877 39# endif
1cfa4ec7 40# define pthread_mutexattr_default NULL
0d85d877 41# define pthread_condattr_default NULL
0d85d877
JH
42#endif
43
44#ifndef PTHREAD_CREATE
45/* You are not supposed to pass NULL as the 2nd arg of PTHREAD_CREATE(). */
46# define PTHREAD_CREATE(t,a,s,d) pthread_create(t,&(a),s,d)
47#endif
48
49#ifndef PTHREAD_ATTR_SETDETACHSTATE
50# define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_attr_setdetachstate(a,s)
d55594ae 51#endif
1cfa4ec7 52
ef4af2be
JH
53#ifndef PTHREAD_CREATE_JOINABLE
54# ifdef OLD_PTHREAD_CREATE_JOINABLE
55# define PTHREAD_CREATE_JOINABLE OLD_PTHREAD_CREATE_JOINABLE
56# else
57# define PTHREAD_CREATE_JOINABLE 0 /* Panic? No, guess. */
58# endif
59#endif
60
7f3d1cf1
BH
61#ifdef I_MACH_CTHREADS
62
63/* cthreads interface */
64
65/* #include <mach/cthreads.h> is in perl.h #ifdef I_MACH_CTHREADS */
66
ba869deb
GS
67#define MUTEX_INIT(m) \
68 STMT_START { \
69 *m = mutex_alloc(); \
70 if (*m) { \
71 mutex_init(*m); \
72 } else { \
efc57feb 73 Perl_croak_nocontext("panic: MUTEX_INIT"); \
ba869deb
GS
74 } \
75 } STMT_END
76
77#define MUTEX_LOCK(m) mutex_lock(*m)
ba869deb 78#define MUTEX_UNLOCK(m) mutex_unlock(*m)
ba869deb
GS
79#define MUTEX_DESTROY(m) \
80 STMT_START { \
81 mutex_free(*m); \
82 *m = 0; \
83 } STMT_END
84
85#define COND_INIT(c) \
86 STMT_START { \
87 *c = condition_alloc(); \
88 if (*c) { \
89 condition_init(*c); \
90 } \
91 else { \
efc57feb 92 Perl_croak_nocontext("panic: COND_INIT"); \
ba869deb
GS
93 } \
94 } STMT_END
7f3d1cf1
BH
95
96#define COND_SIGNAL(c) condition_signal(*c)
97#define COND_BROADCAST(c) condition_broadcast(*c)
98#define COND_WAIT(c, m) condition_wait(*c, *m)
ba869deb
GS
99#define COND_DESTROY(c) \
100 STMT_START { \
101 condition_free(*c); \
102 *c = 0; \
103 } STMT_END
7f3d1cf1
BH
104
105#define THREAD_CREATE(thr, f) (thr->self = cthread_fork(f, thr), 0)
106#define THREAD_POST_CREATE(thr)
107
108#define THREAD_RET_TYPE any_t
109#define THREAD_RET_CAST(x) ((any_t) x)
110
111#define DETACH(t) cthread_detach(t->self)
112#define JOIN(t, avp) (*(avp) = (AV *)cthread_join(t->self))
113
ba869deb
GS
114#define PERL_SET_CONTEXT(t) cthread_set_data(cthread_self(), t)
115#define PERL_GET_CONTEXT cthread_data(cthread_self())
7f3d1cf1
BH
116
117#define INIT_THREADS cthread_init()
118#define YIELD cthread_yield()
ba869deb 119#define ALLOC_THREAD_KEY NOOP
7f3d1cf1
BH
120#define SET_THREAD_SELF(thr) (thr->self = cthread_self())
121
122#endif /* I_MACH_CTHREADS */
123
1cfa4ec7 124#ifndef YIELD
e7a4f449
JH
125# ifdef SCHED_YIELD
126# define YIELD SCHED_YIELD
127# else
128# ifdef HAS_SCHED_YIELD
129# define YIELD sched_yield()
130# else
131# ifdef HAS_PTHREAD_YIELD
132 /* pthread_yield(NULL) platforms are expected
133 * to have #defined YIELD for themselves. */
134# define YIELD pthread_yield()
135# endif
136# endif
137# endif
9731c6ca 138#endif
11343788 139
227c31c3
JH
140#ifdef __hpux
141# define MUTEX_INIT_NEEDS_MUTEX_ZEROED
142#endif
143
ea0efc06 144#ifndef MUTEX_INIT
ba869deb
GS
145
146# ifdef MUTEX_INIT_NEEDS_MUTEX_ZEROED
227c31c3 147 /* Temporary workaround, true bug is deeper. --jhi 1999-02-25 */
ba869deb 148# define MUTEX_INIT(m) \
227c31c3
JH
149 STMT_START { \
150 Zero((m), 1, perl_mutex); \
151 if (pthread_mutex_init((m), pthread_mutexattr_default)) \
efc57feb 152 Perl_croak_nocontext("panic: MUTEX_INIT"); \
227c31c3 153 } STMT_END
ba869deb
GS
154# else
155# define MUTEX_INIT(m) \
ea0efc06
MB
156 STMT_START { \
157 if (pthread_mutex_init((m), pthread_mutexattr_default)) \
efc57feb 158 Perl_croak_nocontext("panic: MUTEX_INIT"); \
ea0efc06 159 } STMT_END
ba869deb
GS
160# endif
161
162# define MUTEX_LOCK(m) \
163 STMT_START { \
164 if (pthread_mutex_lock((m))) \
ba869deb 165 Perl_croak_nocontext("panic: MUTEX_LOCK"); \
cea2e8a9 166 } STMT_END
ba869deb 167
efc57feb 168# define MUTEX_UNLOCK(m) \
ba869deb
GS
169 STMT_START { \
170 if (pthread_mutex_unlock((m))) \
171 Perl_croak_nocontext("panic: MUTEX_UNLOCK"); \
ea0efc06 172 } STMT_END
ba869deb
GS
173
174# define MUTEX_DESTROY(m) \
175 STMT_START { \
176 if (pthread_mutex_destroy((m))) \
efc57feb 177 Perl_croak_nocontext("panic: MUTEX_DESTROY"); \
ea0efc06
MB
178 } STMT_END
179#endif /* MUTEX_INIT */
180
181#ifndef COND_INIT
ba869deb 182# define COND_INIT(c) \
ea0efc06
MB
183 STMT_START { \
184 if (pthread_cond_init((c), pthread_condattr_default)) \
efc57feb 185 Perl_croak_nocontext("panic: COND_INIT"); \
ea0efc06 186 } STMT_END
ba869deb
GS
187
188# define COND_SIGNAL(c) \
189 STMT_START { \
190 if (pthread_cond_signal((c))) \
efc57feb 191 Perl_croak_nocontext("panic: COND_SIGNAL"); \
ea0efc06 192 } STMT_END
ba869deb
GS
193
194# define COND_BROADCAST(c) \
195 STMT_START { \
196 if (pthread_cond_broadcast((c))) \
efc57feb 197 Perl_croak_nocontext("panic: COND_BROADCAST"); \
ea0efc06 198 } STMT_END
ba869deb
GS
199
200# define COND_WAIT(c, m) \
201 STMT_START { \
202 if (pthread_cond_wait((c), (m))) \
efc57feb 203 Perl_croak_nocontext("panic: COND_WAIT"); \
ea0efc06 204 } STMT_END
ba869deb
GS
205
206# define COND_DESTROY(c) \
207 STMT_START { \
208 if (pthread_cond_destroy((c))) \
efc57feb 209 Perl_croak_nocontext("panic: COND_DESTROY"); \
ea0efc06
MB
210 } STMT_END
211#endif /* COND_INIT */
33f46ff6 212
f826a10b 213/* DETACH(t) must only be called while holding t->mutex */
ea0efc06 214#ifndef DETACH
ba869deb
GS
215# define DETACH(t) \
216 STMT_START { \
217 if (pthread_detach((t)->self)) { \
218 MUTEX_UNLOCK(&(t)->mutex); \
efc57feb 219 Perl_croak_nocontext("panic: DETACH"); \
ba869deb 220 } \
ea0efc06
MB
221 } STMT_END
222#endif /* DETACH */
33f46ff6 223
ea0efc06 224#ifndef JOIN
ba869deb
GS
225# define JOIN(t, avp) \
226 STMT_START { \
227 if (pthread_join((t)->self, (void**)(avp))) \
efc57feb 228 Perl_croak_nocontext("panic: pthread_join"); \
ea0efc06
MB
229 } STMT_END
230#endif /* JOIN */
231
ba869deb
GS
232#ifndef PERL_GET_CONTEXT
233# define PERL_GET_CONTEXT pthread_getspecific(PL_thr_key)
234#endif
235
236#ifndef PERL_SET_CONTEXT
237# define PERL_SET_CONTEXT(t) \
238 STMT_START { \
239 if (pthread_setspecific(PL_thr_key, (void *)(t))) \
efc57feb 240 Perl_croak_nocontext("panic: pthread_setspecific"); \
ea0efc06 241 } STMT_END
ba869deb 242#endif /* PERL_SET_CONTEXT */
ea0efc06 243
1feb2720
GS
244#ifndef INIT_THREADS
245# ifdef NEED_PTHREAD_INIT
246# define INIT_THREADS pthread_init()
247# endif
0d85d877 248#endif
ea0efc06 249
ba869deb
GS
250#ifndef ALLOC_THREAD_KEY
251# define ALLOC_THREAD_KEY \
252 STMT_START { \
c44d3fdb
GS
253 if (pthread_key_create(&PL_thr_key, 0)) { \
254 fprintf(stderr, "panic: pthread_key_create"); \
255 exit(1); \
256 } \
ba869deb
GS
257 } STMT_END
258#endif
259
1feb2720
GS
260#ifndef THREAD_RET_TYPE
261# define THREAD_RET_TYPE void *
262# define THREAD_RET_CAST(p) ((void *)(p))
263#endif /* THREAD_RET */
264
265#if defined(USE_THREADS)
266
940cb80d 267/* Accessor for per-thread SVs */
1feb2720 268# define THREADSV(i) (thr->threadsvp[i])
940cb80d
MB
269
270/*
271 * LOCK_SV_MUTEX and UNLOCK_SV_MUTEX are performance-critical. Here, we
272 * try only locking them if there may be more than one thread in existence.
273 * Systems with very fast mutexes (and/or slow conditionals) may wish to
274 * remove the "if (threadnum) ..." test.
b099ddc0 275 * XXX do NOT use C<if (PL_threadnum) ...> -- it sets up race conditions!
940cb80d 276 */
1feb2720
GS
277# define LOCK_SV_MUTEX MUTEX_LOCK(&PL_sv_mutex)
278# define UNLOCK_SV_MUTEX MUTEX_UNLOCK(&PL_sv_mutex)
279# define LOCK_STRTAB_MUTEX MUTEX_LOCK(&PL_strtab_mutex)
280# define UNLOCK_STRTAB_MUTEX MUTEX_UNLOCK(&PL_strtab_mutex)
281# define LOCK_CRED_MUTEX MUTEX_LOCK(&PL_cred_mutex)
282# define UNLOCK_CRED_MUTEX MUTEX_UNLOCK(&PL_cred_mutex)
ea0efc06 283
11343788 284
33f46ff6 285/* Values and macros for thr->flags */
605e5515
MB
286#define THRf_STATE_MASK 7
287#define THRf_R_JOINABLE 0
288#define THRf_R_JOINED 1
289#define THRf_R_DETACHED 2
290#define THRf_ZOMBIE 3
291#define THRf_DEAD 4
f93b4edd 292
458fb581 293#define THRf_DID_DIE 8
07b73707 294
f826a10b 295/* ThrSTATE(t) and ThrSETSTATE(t) must only be called while holding t->mutex */
458fb581 296#define ThrSTATE(t) ((t)->flags & THRf_STATE_MASK)
f93b4edd 297#define ThrSETSTATE(t, s) STMT_START { \
605e5515 298 (t)->flags &= ~THRf_STATE_MASK; \
33f46ff6 299 (t)->flags |= (s); \
bf49b057 300 DEBUG_S(PerlIO_printf(Perl_debug_log, \
605e5515 301 "thread %p set to state %d\n", (t), (s))); \
f93b4edd
MB
302 } STMT_END
303
304typedef struct condpair {
f826a10b
MB
305 perl_mutex mutex; /* Protects all other fields */
306 perl_cond owner_cond; /* For when owner changes at all */
307 perl_cond cond; /* For cond_signal and cond_broadcast */
308 Thread owner; /* Currently owning thread */
f93b4edd
MB
309} condpair_t;
310
311#define MgMUTEXP(mg) (&((condpair_t *)(mg->mg_ptr))->mutex)
312#define MgOWNERCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->owner_cond)
313#define MgCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->cond)
314#define MgOWNER(mg) ((condpair_t *)(mg->mg_ptr))->owner
315
11343788 316#endif /* USE_THREADS */
1feb2720
GS
317#endif /* USE_THREADS || USE_ITHREADS */
318
319#ifndef MUTEX_LOCK
320# define MUTEX_LOCK(m)
321#endif
322
1feb2720
GS
323#ifndef MUTEX_UNLOCK
324# define MUTEX_UNLOCK(m)
325#endif
1feb2720
GS
326
327#ifndef MUTEX_INIT
328# define MUTEX_INIT(m)
329#endif
330
331#ifndef MUTEX_DESTROY
332# define MUTEX_DESTROY(m)
333#endif
334
335#ifndef COND_INIT
336# define COND_INIT(c)
337#endif
338
339#ifndef COND_SIGNAL
340# define COND_SIGNAL(c)
341#endif
342
343#ifndef COND_BROADCAST
344# define COND_BROADCAST(c)
345#endif
346
347#ifndef COND_WAIT
348# define COND_WAIT(c, m)
349#endif
350
351#ifndef COND_DESTROY
352# define COND_DESTROY(c)
353#endif
354
355#ifndef LOCK_SV_MUTEX
356# define LOCK_SV_MUTEX
357#endif
358
359#ifndef UNLOCK_SV_MUTEX
360# define UNLOCK_SV_MUTEX
361#endif
362
363#ifndef LOCK_STRTAB_MUTEX
364# define LOCK_STRTAB_MUTEX
365#endif
366
367#ifndef UNLOCK_STRTAB_MUTEX
368# define UNLOCK_STRTAB_MUTEX
369#endif
370
371#ifndef LOCK_CRED_MUTEX
372# define LOCK_CRED_MUTEX
373#endif
374
375#ifndef UNLOCK_CRED_MUTEX
376# define UNLOCK_CRED_MUTEX
377#endif
378
ba869deb 379/* THR, SET_THR, and dTHR are there for compatibility with old versions */
1feb2720 380#ifndef THR
ba869deb
GS
381# define THR PERL_GET_THX
382#endif
383
384#ifndef SET_THR
385# define SET_THR(t) PERL_SET_THX(t)
1feb2720
GS
386#endif
387
388#ifndef dTHR
389# define dTHR dNOOP
390#endif
391
392#ifndef INIT_THREADS
393# define INIT_THREADS NOOP
394#endif