more complete support for implicit thread/interpreter pointer,
[p5sagit/p5-mst-13.2.git] / thread.h
CommitLineData
ea0efc06 1#ifdef USE_THREADS
12ca11f6 2
ea0efc06 3#ifdef WIN32
d55594ae 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 12 } \
13 } STMT_END
9bbd4fab 14# define THR getTHR()
20ce7b12 15struct perl_thread *getTHR (void);
0d85d877 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 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 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 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
38# ifndef VMS
1cfa4ec7 39# define pthread_mutexattr_default NULL
0d85d877 40# define pthread_condattr_default NULL
41# endif
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 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 61#ifdef I_MACH_CTHREADS
62
63/* cthreads interface */
64
65/* #include <mach/cthreads.h> is in perl.h #ifdef I_MACH_CTHREADS */
66
67#define MUTEX_INIT(m) \
68 STMT_START { \
69 *m = mutex_alloc(); \
70 if (*m) { \
71 mutex_init(*m); \
72 } else { \
cea2e8a9 73 Perl_croak(aTHX_ "panic: MUTEX_INIT"); \
7f3d1cf1 74 } \
75 } STMT_END
76
77#define MUTEX_LOCK(m) mutex_lock(*m)
78#define MUTEX_UNLOCK(m) mutex_unlock(*m)
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 } else { \
cea2e8a9 91 Perl_croak(aTHX_ "panic: COND_INIT"); \
7f3d1cf1 92 } \
93 } STMT_END
94
95#define COND_SIGNAL(c) condition_signal(*c)
96#define COND_BROADCAST(c) condition_broadcast(*c)
97#define COND_WAIT(c, m) condition_wait(*c, *m)
98#define COND_DESTROY(c) \
99 STMT_START { \
100 condition_free(*c); \
101 *c = 0; \
102 } STMT_END
103
104#define THREAD_CREATE(thr, f) (thr->self = cthread_fork(f, thr), 0)
105#define THREAD_POST_CREATE(thr)
106
107#define THREAD_RET_TYPE any_t
108#define THREAD_RET_CAST(x) ((any_t) x)
109
110#define DETACH(t) cthread_detach(t->self)
111#define JOIN(t, avp) (*(avp) = (AV *)cthread_join(t->self))
112
113#define SET_THR(thr) cthread_set_data(cthread_self(), thr)
114#define THR cthread_data(cthread_self())
115
116#define INIT_THREADS cthread_init()
117#define YIELD cthread_yield()
118#define ALLOC_THREAD_KEY
119#define SET_THREAD_SELF(thr) (thr->self = cthread_self())
120
121#endif /* I_MACH_CTHREADS */
122
1cfa4ec7 123#ifndef YIELD
e7a4f449 124# ifdef SCHED_YIELD
125# define YIELD SCHED_YIELD
126# else
127# ifdef HAS_SCHED_YIELD
128# define YIELD sched_yield()
129# else
130# ifdef HAS_PTHREAD_YIELD
131 /* pthread_yield(NULL) platforms are expected
132 * to have #defined YIELD for themselves. */
133# define YIELD pthread_yield()
134# endif
135# endif
136# endif
9731c6ca 137#endif
11343788 138
227c31c3 139#ifdef __hpux
140# define MUTEX_INIT_NEEDS_MUTEX_ZEROED
141#endif
142
ea0efc06 143#ifndef MUTEX_INIT
227c31c3 144#ifdef MUTEX_INIT_NEEDS_MUTEX_ZEROED
145 /* Temporary workaround, true bug is deeper. --jhi 1999-02-25 */
146#define MUTEX_INIT(m) \
147 STMT_START { \
148 Zero((m), 1, perl_mutex); \
149 if (pthread_mutex_init((m), pthread_mutexattr_default)) \
cea2e8a9 150 Perl_croak(aTHX_ "panic: MUTEX_INIT"); \
227c31c3 151 } STMT_END
152#else
ea0efc06 153#define MUTEX_INIT(m) \
154 STMT_START { \
155 if (pthread_mutex_init((m), pthread_mutexattr_default)) \
cea2e8a9 156 Perl_croak(aTHX_ "panic: MUTEX_INIT"); \
ea0efc06 157 } STMT_END
227c31c3 158#endif
ea0efc06 159#define MUTEX_LOCK(m) \
160 STMT_START { \
161 if (pthread_mutex_lock((m))) \
cea2e8a9 162 Perl_croak(aTHX_ "panic: MUTEX_LOCK"); \
ea0efc06 163 } STMT_END
164#define MUTEX_UNLOCK(m) \
165 STMT_START { \
166 if (pthread_mutex_unlock((m))) \
cea2e8a9 167 Perl_croak(aTHX_ "panic: MUTEX_UNLOCK"); \
168 } STMT_END
169#define MUTEX_LOCK_NOCONTEXT(m) \
170 STMT_START { \
171 if (pthread_mutex_lock((m))) \
172 Perl_croak_nocontext("panic: MUTEX_LOCK"); \
173 } STMT_END
174#define MUTEX_UNLOCK_NOCONTEXT(m) \
175 STMT_START { \
176 if (pthread_mutex_unlock((m))) \
177 Perl_croak_nocontext("panic: MUTEX_UNLOCK");\
ea0efc06 178 } STMT_END
179#define MUTEX_DESTROY(m) \
180 STMT_START { \
181 if (pthread_mutex_destroy((m))) \
cea2e8a9 182 Perl_croak(aTHX_ "panic: MUTEX_DESTROY"); \
ea0efc06 183 } STMT_END
184#endif /* MUTEX_INIT */
185
186#ifndef COND_INIT
187#define COND_INIT(c) \
188 STMT_START { \
189 if (pthread_cond_init((c), pthread_condattr_default)) \
cea2e8a9 190 Perl_croak(aTHX_ "panic: COND_INIT"); \
ea0efc06 191 } STMT_END
192#define COND_SIGNAL(c) \
193 STMT_START { \
194 if (pthread_cond_signal((c))) \
cea2e8a9 195 Perl_croak(aTHX_ "panic: COND_SIGNAL"); \
ea0efc06 196 } STMT_END
197#define COND_BROADCAST(c) \
198 STMT_START { \
199 if (pthread_cond_broadcast((c))) \
cea2e8a9 200 Perl_croak(aTHX_ "panic: COND_BROADCAST"); \
ea0efc06 201 } STMT_END
202#define COND_WAIT(c, m) \
203 STMT_START { \
204 if (pthread_cond_wait((c), (m))) \
cea2e8a9 205 Perl_croak(aTHX_ "panic: COND_WAIT"); \
ea0efc06 206 } STMT_END
207#define COND_DESTROY(c) \
208 STMT_START { \
209 if (pthread_cond_destroy((c))) \
cea2e8a9 210 Perl_croak(aTHX_ "panic: COND_DESTROY"); \
ea0efc06 211 } STMT_END
212#endif /* COND_INIT */
33f46ff6 213
f826a10b 214/* DETACH(t) must only be called while holding t->mutex */
ea0efc06 215#ifndef DETACH
216#define DETACH(t) \
217 STMT_START { \
46930d8f 218 if (pthread_detach((t)->self)) { \
ea0efc06 219 MUTEX_UNLOCK(&(t)->mutex); \
cea2e8a9 220 Perl_croak(aTHX_ "panic: DETACH"); \
ea0efc06 221 } \
222 } STMT_END
223#endif /* DETACH */
33f46ff6 224
ea0efc06 225#ifndef JOIN
226#define JOIN(t, avp) \
227 STMT_START { \
46930d8f 228 if (pthread_join((t)->self, (void**)(avp))) \
cea2e8a9 229 Perl_croak(aTHX_ "panic: pthread_join"); \
ea0efc06 230 } STMT_END
231#endif /* JOIN */
232
233#ifndef SET_THR
234#define SET_THR(t) \
235 STMT_START { \
533c011a 236 if (pthread_setspecific(PL_thr_key, (void *) (t))) \
cea2e8a9 237 Perl_croak(aTHX_ "panic: pthread_setspecific"); \
ea0efc06 238 } STMT_END
239#endif /* SET_THR */
240
241#ifndef THR
0d85d877 242#define THR ((struct perl_thread *) pthread_getspecific(PL_thr_key))
243#endif
ea0efc06 244
940cb80d 245/*
246 * dTHR is performance-critical. Here, we only do the pthread_get_specific
247 * if there may be more than one thread in existence, otherwise we get thr
248 * from thrsv which is cached in the per-interpreter structure.
249 * Systems with very fast pthread_get_specific (which should be all systems
250 * but unfortunately isn't) may wish to simplify to "...*thr = THR".
b099ddc0 251 *
252 * The use of PL_threadnum should be safe here.
940cb80d 253 */
ea0efc06 254#ifndef dTHR
940cb80d 255# define dTHR \
533c011a 256 struct perl_thread *thr = PL_threadnum? THR : (struct perl_thread*)SvPVX(PL_thrsv)
ea0efc06 257#endif /* dTHR */
11343788 258
33f46ff6 259#ifndef INIT_THREADS
260# ifdef NEED_PTHREAD_INIT
261# define INIT_THREADS pthread_init()
262# else
263# define INIT_THREADS NOOP
264# endif
265#endif
11343788 266
940cb80d 267/* Accessor for per-thread SVs */
268#define THREADSV(i) (thr->threadsvp[i])
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 */
5f08fbcd 277#define LOCK_SV_MUTEX \
278 STMT_START { \
b099ddc0 279 MUTEX_LOCK(&PL_sv_mutex); \
5f08fbcd 280 } STMT_END
281
282#define UNLOCK_SV_MUTEX \
283 STMT_START { \
b099ddc0 284 MUTEX_UNLOCK(&PL_sv_mutex); \
940cb80d 285 } STMT_END
286
5f08fbcd 287/* Likewise for strtab_mutex */
288#define LOCK_STRTAB_MUTEX \
289 STMT_START { \
b099ddc0 290 MUTEX_LOCK(&PL_strtab_mutex); \
5f08fbcd 291 } STMT_END
292
293#define UNLOCK_STRTAB_MUTEX \
294 STMT_START { \
b099ddc0 295 MUTEX_UNLOCK(&PL_strtab_mutex); \
940cb80d 296 } STMT_END
d55594ae 297
ea0efc06 298#ifndef THREAD_RET_TYPE
299# define THREAD_RET_TYPE void *
300# define THREAD_RET_CAST(p) ((void *)(p))
301#endif /* THREAD_RET */
302
11343788 303
33f46ff6 304/* Values and macros for thr->flags */
605e5515 305#define THRf_STATE_MASK 7
306#define THRf_R_JOINABLE 0
307#define THRf_R_JOINED 1
308#define THRf_R_DETACHED 2
309#define THRf_ZOMBIE 3
310#define THRf_DEAD 4
f93b4edd 311
458fb581 312#define THRf_DID_DIE 8
07b73707 313
f826a10b 314/* ThrSTATE(t) and ThrSETSTATE(t) must only be called while holding t->mutex */
458fb581 315#define ThrSTATE(t) ((t)->flags & THRf_STATE_MASK)
f93b4edd 316#define ThrSETSTATE(t, s) STMT_START { \
605e5515 317 (t)->flags &= ~THRf_STATE_MASK; \
33f46ff6 318 (t)->flags |= (s); \
8b73bbec 319 DEBUG_S(PerlIO_printf(PerlIO_stderr(), \
605e5515 320 "thread %p set to state %d\n", (t), (s))); \
f93b4edd 321 } STMT_END
322
323typedef struct condpair {
f826a10b 324 perl_mutex mutex; /* Protects all other fields */
325 perl_cond owner_cond; /* For when owner changes at all */
326 perl_cond cond; /* For cond_signal and cond_broadcast */
327 Thread owner; /* Currently owning thread */
f93b4edd 328} condpair_t;
329
330#define MgMUTEXP(mg) (&((condpair_t *)(mg->mg_ptr))->mutex)
331#define MgOWNERCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->owner_cond)
332#define MgCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->cond)
333#define MgOWNER(mg) ((condpair_t *)(mg->mg_ptr))->owner
334
ea0efc06 335#else
336/* USE_THREADS is not defined */
337#define MUTEX_LOCK(m)
cea2e8a9 338#define MUTEX_LOCK_NOCONTEXT(m)
ea0efc06 339#define MUTEX_UNLOCK(m)
cea2e8a9 340#define MUTEX_UNLOCK_NOCONTEXT(m)
ea0efc06 341#define MUTEX_INIT(m)
342#define MUTEX_DESTROY(m)
343#define COND_INIT(c)
344#define COND_SIGNAL(c)
345#define COND_BROADCAST(c)
346#define COND_WAIT(c, m)
347#define COND_DESTROY(c)
93bce2dc 348#define LOCK_SV_MUTEX
349#define UNLOCK_SV_MUTEX
5f08fbcd 350#define LOCK_STRTAB_MUTEX
351#define UNLOCK_STRTAB_MUTEX
ea0efc06 352
353#define THR
cea2e8a9 354#define dTHR dNOOP
11343788 355#endif /* USE_THREADS */