[perl5.git] / thread.h

/*    thread.h
 *
 *    Copyright (c) 1997-2002, Larry Wall
 *
 *    You may distribute under the terms of either the GNU General Public
 *    License or the Artistic License, as specified in the README file.
 *
 */

#if defined(USE_5005THREADS) || defined(USE_ITHREADS)

#if defined(VMS)
#include <builtins.h>
#endif

#ifdef WIN32
#  include <win32thread.h>
#else
#ifdef NETWARE
#  include <nw5thread.h>
#else
#  ifdef OLD_PTHREADS_API /* Here be dragons. */
#    define DETACH(t) \
    STMT_START {						\
	if (pthread_detach(&(t)->self)) {			\
	    MUTEX_UNLOCK(&(t)->mutex);				\
	    Perl_croak_nocontext("panic: DETACH");		\
	}							\
    } STMT_END

#    define PERL_GET_CONTEXT	Perl_get_context()
#    define PERL_SET_CONTEXT(t)	Perl_set_context((void*)t)

#    define PTHREAD_GETSPECIFIC_INT
#    ifdef DJGPP
#      define pthread_addr_t any_t
#      define NEED_PTHREAD_INIT
#      define PTHREAD_CREATE_JOINABLE (1)
#    endif
#    ifdef __OPEN_VM
#      define pthread_addr_t void *
#    endif
#    ifdef VMS
#      define pthread_attr_init(a) pthread_attr_create(a)
#      define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_setdetach_np(a,s)
#      define PTHREAD_CREATE(t,a,s,d) pthread_create(t,a,s,d)
#      define pthread_key_create(k,d) pthread_keycreate(k,(pthread_destructor_t)(d))
#      define pthread_mutexattr_init(a) pthread_mutexattr_create(a)
#      define pthread_mutexattr_settype(a,t) pthread_mutexattr_setkind_np(a,t)
#    endif
#    if defined(__hpux) && defined(__ux_version) && __ux_version <= 1020
#      define pthread_attr_init(a) pthread_attr_create(a)
       /* XXX pthread_setdetach_np() missing in DCE threads on HP-UX 10.20 */
#      define PTHREAD_ATTR_SETDETACHSTATE(a,s)	(0)
#      define PTHREAD_CREATE(t,a,s,d) pthread_create(t,a,s,d)
#      define pthread_key_create(k,d) pthread_keycreate(k,(pthread_destructor_t)(d))
#      define pthread_mutexattr_init(a) pthread_mutexattr_create(a)
#      define pthread_mutexattr_settype(a,t) pthread_mutexattr_setkind_np(a,t)
#    endif
#    if defined(DJGPP) || defined(__OPEN_VM)
#      define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_attr_setdetachstate(a,&(s))
#      define YIELD pthread_yield(NULL)
#    endif
#  endif
#  if !defined(__hpux) || !defined(__ux_version) || __ux_version > 1020
#    define pthread_mutexattr_default NULL
#    define pthread_condattr_default  NULL
#  endif
#endif	/* NETWARE */
#endif

#ifndef PTHREAD_CREATE
/* You are not supposed to pass NULL as the 2nd arg of PTHREAD_CREATE(). */
#  define PTHREAD_CREATE(t,a,s,d) pthread_create(t,&(a),s,d)
#endif

#ifndef PTHREAD_ATTR_SETDETACHSTATE
#  define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_attr_setdetachstate(a,s)
#endif

#ifndef PTHREAD_CREATE_JOINABLE
#  ifdef OLD_PTHREAD_CREATE_JOINABLE
#    define PTHREAD_CREATE_JOINABLE OLD_PTHREAD_CREATE_JOINABLE
#  else
#    define PTHREAD_CREATE_JOINABLE 0 /* Panic?  No, guess. */
#  endif
#endif

#ifdef DGUX
#  define THREAD_CREATE_NEEDS_STACK (32*1024)
#endif

#ifdef I_MACH_CTHREADS

/* cthreads interface */

/* #include <mach/cthreads.h> is in perl.h #ifdef I_MACH_CTHREADS */

#define MUTEX_INIT(m) \
    STMT_START {						\
	*m = mutex_alloc();					\
	if (*m) {						\
	    mutex_init(*m);					\
	} else {						\
	    Perl_croak_nocontext("panic: MUTEX_INIT");		\
	}							\
    } STMT_END

#define MUTEX_LOCK(m)			mutex_lock(*m)
#define MUTEX_UNLOCK(m)			mutex_unlock(*m)
#define MUTEX_DESTROY(m) \
    STMT_START {						\
	mutex_free(*m);						\
	*m = 0;							\
    } STMT_END

#define COND_INIT(c) \
    STMT_START {						\
	*c = condition_alloc();					\
	if (*c) {						\
	    condition_init(*c);					\
	}							\
	else {							\
	    Perl_croak_nocontext("panic: COND_INIT");		\
	}							\
    } STMT_END

#define COND_SIGNAL(c)		condition_signal(*c)
#define COND_BROADCAST(c)	condition_broadcast(*c)
#define COND_WAIT(c, m)		condition_wait(*c, *m)
#define COND_DESTROY(c) \
    STMT_START {						\
	condition_free(*c);					\
	*c = 0;							\
    } STMT_END

#define THREAD_CREATE(thr, f)	(thr->self = cthread_fork(f, thr), 0)
#define THREAD_POST_CREATE(thr)

#define THREAD_RET_TYPE		any_t
#define THREAD_RET_CAST(x)	((any_t) x)

#define DETACH(t)		cthread_detach(t->self)
#define JOIN(t, avp)		(*(avp) = (AV *)cthread_join(t->self))

#define PERL_SET_CONTEXT(t)	cthread_set_data(cthread_self(), t)
#define PERL_GET_CONTEXT	cthread_data(cthread_self())

#define INIT_THREADS		cthread_init()
#define YIELD			cthread_yield()
#define ALLOC_THREAD_KEY	NOOP
#define FREE_THREAD_KEY		NOOP
#define SET_THREAD_SELF(thr)	(thr->self = cthread_self())

#endif /* I_MACH_CTHREADS */

#ifndef YIELD
#  ifdef SCHED_YIELD
#    define YIELD SCHED_YIELD
#  else
#    ifdef HAS_SCHED_YIELD
#      define YIELD sched_yield()
#    else
#      ifdef HAS_PTHREAD_YIELD
    /* pthread_yield(NULL) platforms are expected
     * to have #defined YIELD for themselves. */
#        define YIELD pthread_yield()
#      endif
#    endif
#  endif
#endif

#ifdef __hpux
#  define MUTEX_INIT_NEEDS_MUTEX_ZEROED
#endif

#ifndef MUTEX_INIT

#  ifdef MUTEX_INIT_NEEDS_MUTEX_ZEROED
    /* Temporary workaround, true bug is deeper. --jhi 1999-02-25 */
#    define MUTEX_INIT(m) \
    STMT_START {						\
	Zero((m), 1, perl_mutex);                               \
 	if (pthread_mutex_init((m), pthread_mutexattr_default))	\
	    Perl_croak_nocontext("panic: MUTEX_INIT");		\
    } STMT_END
#  else
#    define MUTEX_INIT(m) \
    STMT_START {						\
	if (pthread_mutex_init((m), pthread_mutexattr_default))	\
	    Perl_croak_nocontext("panic: MUTEX_INIT");		\
    } STMT_END
#  endif

#  define MUTEX_LOCK(m) \
    STMT_START {						\
	if (pthread_mutex_lock((m)))				\
	    Perl_croak_nocontext("panic: MUTEX_LOCK");		\
    } STMT_END

#  define MUTEX_UNLOCK(m) \
    STMT_START {						\
	if (pthread_mutex_unlock((m)))				\
	    Perl_croak_nocontext("panic: MUTEX_UNLOCK");	\
    } STMT_END

#  define MUTEX_DESTROY(m) \
    STMT_START {						\
	if (pthread_mutex_destroy((m)))				\
	    Perl_croak_nocontext("panic: MUTEX_DESTROY");	\
    } STMT_END
#endif /* MUTEX_INIT */

#ifndef COND_INIT
#  define COND_INIT(c) \
    STMT_START {						\
	if (pthread_cond_init((c), pthread_condattr_default))	\
	    Perl_croak_nocontext("panic: COND_INIT");		\
    } STMT_END

#  define COND_SIGNAL(c) \
    STMT_START {						\
	if (pthread_cond_signal((c)))				\
	    Perl_croak_nocontext("panic: COND_SIGNAL");		\
    } STMT_END

#  define COND_BROADCAST(c) \
    STMT_START {						\
	if (pthread_cond_broadcast((c)))			\
	    Perl_croak_nocontext("panic: COND_BROADCAST");	\
    } STMT_END

#  define COND_WAIT(c, m) \
    STMT_START {						\
	if (pthread_cond_wait((c), (m)))			\
	    Perl_croak_nocontext("panic: COND_WAIT");		\
    } STMT_END

#  define COND_DESTROY(c) \
    STMT_START {						\
	if (pthread_cond_destroy((c)))				\
	    Perl_croak_nocontext("panic: COND_DESTROY");	\
    } STMT_END
#endif /* COND_INIT */

/* DETACH(t) must only be called while holding t->mutex */
#ifndef DETACH
#  define DETACH(t) \
    STMT_START {						\
	if (pthread_detach((t)->self)) {			\
	    MUTEX_UNLOCK(&(t)->mutex);				\
	    Perl_croak_nocontext("panic: DETACH");		\
	}							\
    } STMT_END
#endif /* DETACH */

#ifndef JOIN
#  define JOIN(t, avp) \
    STMT_START {						\
	if (pthread_join((t)->self, (void**)(avp)))		\
	    Perl_croak_nocontext("panic: pthread_join");	\
    } STMT_END
#endif /* JOIN */

/* Use an unchecked fetch of thread-specific data instead of a checked one.
 * It would fail if the key were bogus, but if the key were bogus then
 * Really Bad Things would be happening anyway. --dan */
#if (defined(__ALPHA) && (__VMS_VER >= 70000000)) || \
    (defined(__alpha) && defined(__osf__)) /* Available only on >= 4.0 */
#  define HAS_PTHREAD_UNCHECKED_GETSPECIFIC_NP /* Configure test needed */
#endif

#ifdef HAS_PTHREAD_UNCHECKED_GETSPECIFIC_NP
#  define PTHREAD_GETSPECIFIC(key) pthread_unchecked_getspecific_np(key)
#else
#  define PTHREAD_GETSPECIFIC(key) pthread_getspecific(key)
#endif

#ifndef PERL_GET_CONTEXT
#  define PERL_GET_CONTEXT	PTHREAD_GETSPECIFIC(PL_thr_key)
#endif

#ifndef PERL_SET_CONTEXT
#  define PERL_SET_CONTEXT(t) \
    STMT_START {						\
	if (pthread_setspecific(PL_thr_key, (void *)(t)))	\
	    Perl_croak_nocontext("panic: pthread_setspecific");	\
    } STMT_END
#endif /* PERL_SET_CONTEXT */

#ifndef INIT_THREADS
#  ifdef NEED_PTHREAD_INIT
#    define INIT_THREADS pthread_init()
#  endif
#endif

#ifndef ALLOC_THREAD_KEY
#  define ALLOC_THREAD_KEY \
    STMT_START {						\
	if (pthread_key_create(&PL_thr_key, 0))	{		\
	    PerlIO_printf(PerlIO_stderr(), "panic: pthread_key_create");	\
	    exit(1);						\
	}							\
    } STMT_END
#endif

#ifndef FREE_THREAD_KEY
#  define FREE_THREAD_KEY \
    STMT_START {						\
	pthread_key_delete(PL_thr_key);				\
    } STMT_END
#endif

#ifndef PTHREAD_ATFORK
#  ifdef HAS_PTHREAD_ATFORK
#    define PTHREAD_ATFORK(prepare,parent,child)		\
	pthread_atfork(prepare,parent,child)
#  else
#    define PTHREAD_ATFORK(prepare,parent,child)		\
	NOOP
#  endif
#endif

#ifndef THREAD_RET_TYPE
#  define THREAD_RET_TYPE	void *
#  define THREAD_RET_CAST(p)	((void *)(p))
#endif /* THREAD_RET */

#if defined(USE_5005THREADS)

/* Accessor for per-thread SVs */
#  define THREADSV(i) (thr->threadsvp[i])

/*
 * LOCK_SV_MUTEX and UNLOCK_SV_MUTEX are performance-critical. Here, we
 * try only locking them if there may be more than one thread in existence.
 * Systems with very fast mutexes (and/or slow conditionals) may wish to
 * remove the "if (threadnum) ..." test.
 * XXX do NOT use C<if (PL_threadnum) ...> -- it sets up race conditions!
 */
#  define LOCK_SV_MUTEX		MUTEX_LOCK(&PL_sv_mutex)
#  define UNLOCK_SV_MUTEX	MUTEX_UNLOCK(&PL_sv_mutex)
#  define LOCK_STRTAB_MUTEX	MUTEX_LOCK(&PL_strtab_mutex)
#  define UNLOCK_STRTAB_MUTEX	MUTEX_UNLOCK(&PL_strtab_mutex)
#  define LOCK_CRED_MUTEX	MUTEX_LOCK(&PL_cred_mutex)
#  define UNLOCK_CRED_MUTEX	MUTEX_UNLOCK(&PL_cred_mutex)
#  define LOCK_FDPID_MUTEX	MUTEX_LOCK(&PL_fdpid_mutex)
#  define UNLOCK_FDPID_MUTEX	MUTEX_UNLOCK(&PL_fdpid_mutex)
#  define LOCK_SV_LOCK_MUTEX	MUTEX_LOCK(&PL_sv_lock_mutex)
#  define UNLOCK_SV_LOCK_MUTEX	MUTEX_UNLOCK(&PL_sv_lock_mutex)

/* Values and macros for thr->flags */
#define THRf_STATE_MASK	7
#define THRf_R_JOINABLE	0
#define THRf_R_JOINED	1
#define THRf_R_DETACHED	2
#define THRf_ZOMBIE	3
#define THRf_DEAD	4

#define THRf_DID_DIE	8

/* ThrSTATE(t) and ThrSETSTATE(t) must only be called while holding t->mutex */
#define ThrSTATE(t) ((t)->flags & THRf_STATE_MASK)
#define ThrSETSTATE(t, s) STMT_START {		\
	(t)->flags &= ~THRf_STATE_MASK;		\
	(t)->flags |= (s);			\
	DEBUG_S(PerlIO_printf(Perl_debug_log,	\
			      "thread %p set to state %d\n", (t), (s))); \
    } STMT_END

typedef struct condpair {
    perl_mutex	mutex;		/* Protects all other fields */
    perl_cond	owner_cond;	/* For when owner changes at all */
    perl_cond	cond;		/* For cond_signal and cond_broadcast */
    Thread	owner;		/* Currently owning thread */
} condpair_t;

#define MgMUTEXP(mg) (&((condpair_t *)(mg->mg_ptr))->mutex)
#define MgOWNERCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->owner_cond)
#define MgCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->cond)
#define MgOWNER(mg) ((condpair_t *)(mg->mg_ptr))->owner

#endif /* USE_5005THREADS */
#endif /* USE_5005THREADS || USE_ITHREADS */

#ifndef MUTEX_LOCK
#  define MUTEX_LOCK(m)
#endif

#ifndef MUTEX_UNLOCK
#  define MUTEX_UNLOCK(m)
#endif

#ifndef MUTEX_INIT
#  define MUTEX_INIT(m)
#endif

#ifndef MUTEX_DESTROY
#  define MUTEX_DESTROY(m)
#endif

#ifndef COND_INIT
#  define COND_INIT(c)
#endif

#ifndef COND_SIGNAL
#  define COND_SIGNAL(c)
#endif

#ifndef COND_BROADCAST
#  define COND_BROADCAST(c)
#endif

#ifndef COND_WAIT
#  define COND_WAIT(c, m)
#endif

#ifndef COND_DESTROY
#  define COND_DESTROY(c)
#endif

#ifndef LOCK_SV_MUTEX
#  define LOCK_SV_MUTEX
#endif

#ifndef UNLOCK_SV_MUTEX
#  define UNLOCK_SV_MUTEX
#endif

#ifndef LOCK_STRTAB_MUTEX
#  define LOCK_STRTAB_MUTEX
#endif

#ifndef UNLOCK_STRTAB_MUTEX
#  define UNLOCK_STRTAB_MUTEX
#endif

#ifndef LOCK_CRED_MUTEX
#  define LOCK_CRED_MUTEX
#endif

#ifndef UNLOCK_CRED_MUTEX
#  define UNLOCK_CRED_MUTEX
#endif

#ifndef LOCK_FDPID_MUTEX
#  define LOCK_FDPID_MUTEX
#endif

#ifndef UNLOCK_FDPID_MUTEX
#  define UNLOCK_FDPID_MUTEX
#endif

#ifndef LOCK_SV_LOCK_MUTEX
#  define LOCK_SV_LOCK_MUTEX
#endif

#ifndef UNLOCK_SV_LOCK_MUTEX
#  define UNLOCK_SV_LOCK_MUTEX
#endif

/* THR, SET_THR, and dTHR are there for compatibility with old versions */
#ifndef THR
#  define THR		PERL_GET_THX
#endif

#ifndef SET_THR
#  define SET_THR(t)	PERL_SET_THX(t)
#endif

#ifndef dTHR
#  define dTHR dNOOP
#endif

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