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