[perl5.git] / thread.h

#ifdef USE_THREADS

#ifdef WIN32
#  include <win32thread.h>
#else
#  if defined(OLD_PTHREADS_API) && !defined(DJGPP)
     /* POSIXish threads */
#    define pthread_mutexattr_init(a) pthread_mutexattr_create(a)
#    define pthread_mutexattr_settype(a,t) pthread_mutexattr_setkind_np(a,t)
#    define pthread_key_create(k,d) pthread_keycreate(k,(pthread_destructor_t)(d))
#    define DETACH(t)				\
    STMT_START {				\
	if (pthread_detach(&(t)->self)) {	\
	    MUTEX_UNLOCK(&(t)->mutex);		\
	    croak("panic: DETACH");		\
	}					\
    } STMT_END
#  else
#    define pthread_mutexattr_default NULL
#    define pthread_condattr_default NULL
#  endif /* OLD_PTHREADS_API */
#endif

#ifndef YIELD
#  define YIELD SCHED_YIELD
#endif

#ifdef PTHREAD_CREATE_JOINABLE
#  define ATTR_JOINABLE PTHREAD_CREATE_JOINABLE
#else
#  ifdef PTHREAD_CREATE_UNDETACHED
#    define ATTR_JOINABLE PTHREAD_CREATE_UNDETACHED
#  else
#    ifdef __UNDETACHED
#      define ATTR_JOINABLE __UNDETACHED
#    endif
#  endif
#endif

#ifndef MUTEX_INIT
#define MUTEX_INIT(m)						\
    STMT_START {						\
	if (pthread_mutex_init((m), pthread_mutexattr_default))	\
	    croak("panic: MUTEX_INIT");				\
    } STMT_END
#define MUTEX_LOCK(m)				\
    STMT_START {				\
	if (pthread_mutex_lock((m)))		\
	    croak("panic: MUTEX_LOCK");		\
    } STMT_END
#define MUTEX_UNLOCK(m)				\
    STMT_START {				\
	if (pthread_mutex_unlock((m)))		\
	    croak("panic: MUTEX_UNLOCK");	\
    } STMT_END
#define MUTEX_DESTROY(m)			\
    STMT_START {				\
	if (pthread_mutex_destroy((m)))		\
	    croak("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))	\
	    croak("panic: COND_INIT");				\
    } STMT_END
#define COND_SIGNAL(c)				\
    STMT_START {				\
	if (pthread_cond_signal((c)))		\
	    croak("panic: COND_SIGNAL");	\
    } STMT_END
#define COND_BROADCAST(c)			\
    STMT_START {				\
	if (pthread_cond_broadcast((c)))	\
	    croak("panic: COND_BROADCAST");	\
    } STMT_END
#define COND_WAIT(c, m)				\
    STMT_START {				\
	if (pthread_cond_wait((c), (m)))	\
	    croak("panic: COND_WAIT");		\
    } STMT_END
#define COND_DESTROY(c)				\
    STMT_START {				\
	if (pthread_cond_destroy((c)))		\
	    croak("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);		\
	    croak("panic: DETACH");		\
	}					\
    } STMT_END
#endif /* DETACH */

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

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

#ifndef THR
#  ifdef OLD_PTHREADS_API
struct perl_thread *getTHR _((void));
#    define THR getTHR()
#  else
#    define THR ((struct perl_thread *) pthread_getspecific(PL_thr_key))
#  endif /* OLD_PTHREADS_API */
#endif /* THR */

/*
 * dTHR is performance-critical. Here, we only do the pthread_get_specific
 * if there may be more than one thread in existence, otherwise we get thr
 * from thrsv which is cached in the per-interpreter structure.
 * Systems with very fast pthread_get_specific (which should be all systems
 * but unfortunately isn't) may wish to simplify to "...*thr = THR".
 */
#ifndef dTHR
#  define dTHR \
    struct perl_thread *thr = PL_threadnum? THR : (struct perl_thread*)SvPVX(PL_thrsv)
#endif /* dTHR */

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

/* 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.
 */
#define LOCK_SV_MUTEX				\
    STMT_START {				\
	if (PL_threadnum)			\
	    MUTEX_LOCK(&PL_sv_mutex);		\
    } STMT_END

#define UNLOCK_SV_MUTEX				\
    STMT_START {				\
	if (PL_threadnum)			\
	    MUTEX_UNLOCK(&PL_sv_mutex);		\
    } STMT_END

/* Likewise for strtab_mutex */
#define LOCK_STRTAB_MUTEX			\
    STMT_START {				\
	if (PL_threadnum)			\
	    MUTEX_LOCK(&PL_strtab_mutex);	\
    } STMT_END

#define UNLOCK_STRTAB_MUTEX			\
    STMT_START {				\
	if (PL_threadnum)			\
	    MUTEX_UNLOCK(&PL_strtab_mutex);	\
    } STMT_END

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


/* 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(PerlIO_stderr(),	\
			      "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

#else
/* USE_THREADS is not defined */
#define MUTEX_LOCK(m)
#define MUTEX_UNLOCK(m)
#define MUTEX_INIT(m)
#define MUTEX_DESTROY(m)
#define COND_INIT(c)
#define COND_SIGNAL(c)
#define COND_BROADCAST(c)
#define COND_WAIT(c, m)
#define COND_DESTROY(c)
#define LOCK_SV_MUTEX
#define UNLOCK_SV_MUTEX
#define LOCK_STRTAB_MUTEX
#define UNLOCK_STRTAB_MUTEX

#define THR
/* Rats: if dTHR is just blank then the subsequent ";" throws an error */
#ifdef WIN32
#define dTHR extern int Perl___notused
#else
#define dTHR extern int errno
#endif
#endif /* USE_THREADS */
Commit	Line	Data
ea0efc06	1	#ifdef USE_THREADS
12ca11f6	2
ea0efc06	3	#ifdef WIN32
d55594ae GS	4	# include <win32thread.h>
d55594ae GS	5	#else
1cfa4ec7 GS	6	# if defined(OLD_PTHREADS_API) && !defined(DJGPP)
	7	/* POSIXish threads */
	8	# define pthread_mutexattr_init(a) pthread_mutexattr_create(a)
	9	# define pthread_mutexattr_settype(a,t) pthread_mutexattr_setkind_np(a,t)
	10	# define pthread_key_create(k,d) pthread_keycreate(k,(pthread_destructor_t)(d))
	11	# define DETACH(t) \
ea0efc06	12	STMT_START { \
46930d8f	13	if (pthread_detach(&(t)->self)) { \
ea0efc06 MB	14	MUTEX_UNLOCK(&(t)->mutex); \
	15	croak("panic: DETACH"); \
	16	} \
	17	} STMT_END
1cfa4ec7 GS	18	# else
	19	# define pthread_mutexattr_default NULL
	20	# define pthread_condattr_default NULL
	21	# endif /* OLD_PTHREADS_API */
d55594ae	22	#endif
1cfa4ec7 GS	23
	24	#ifndef YIELD
	25	# define YIELD SCHED_YIELD
9731c6ca	26	#endif
11343788	27
1cfa4ec7	28	#ifdef PTHREAD_CREATE_JOINABLE
940cb80d MB	29	# define ATTR_JOINABLE PTHREAD_CREATE_JOINABLE
	30	#else
	31	# ifdef PTHREAD_CREATE_UNDETACHED
	32	# define ATTR_JOINABLE PTHREAD_CREATE_UNDETACHED
	33	# else
1cfa4ec7 GS	34	# ifdef __UNDETACHED
1cfa4ec7 GS	35	# define ATTR_JOINABLE __UNDETACHED
6ee623d5	36	# endif
52e1cb5e	37	# endif
ea0efc06 MB	38	#endif
	39
	40	#ifndef MUTEX_INIT
	41	#define MUTEX_INIT(m) \
	42	STMT_START { \
	43	if (pthread_mutex_init((m), pthread_mutexattr_default)) \
	44	croak("panic: MUTEX_INIT"); \
	45	} STMT_END
	46	#define MUTEX_LOCK(m) \
	47	STMT_START { \
	48	if (pthread_mutex_lock((m))) \
	49	croak("panic: MUTEX_LOCK"); \
	50	} STMT_END
	51	#define MUTEX_UNLOCK(m) \
	52	STMT_START { \
	53	if (pthread_mutex_unlock((m))) \
	54	croak("panic: MUTEX_UNLOCK"); \
	55	} STMT_END
	56	#define MUTEX_DESTROY(m) \
	57	STMT_START { \
	58	if (pthread_mutex_destroy((m))) \
	59	croak("panic: MUTEX_DESTROY"); \
	60	} STMT_END
	61	#endif /* MUTEX_INIT */
	62
	63	#ifndef COND_INIT
	64	#define COND_INIT(c) \
	65	STMT_START { \
	66	if (pthread_cond_init((c), pthread_condattr_default)) \
	67	croak("panic: COND_INIT"); \
	68	} STMT_END
	69	#define COND_SIGNAL(c) \
	70	STMT_START { \
	71	if (pthread_cond_signal((c))) \
	72	croak("panic: COND_SIGNAL"); \
	73	} STMT_END
	74	#define COND_BROADCAST(c) \
	75	STMT_START { \
	76	if (pthread_cond_broadcast((c))) \
	77	croak("panic: COND_BROADCAST"); \
	78	} STMT_END
	79	#define COND_WAIT(c, m) \
	80	STMT_START { \
	81	if (pthread_cond_wait((c), (m))) \
	82	croak("panic: COND_WAIT"); \
	83	} STMT_END
	84	#define COND_DESTROY(c) \
	85	STMT_START { \
	86	if (pthread_cond_destroy((c))) \
	87	croak("panic: COND_DESTROY"); \
	88	} STMT_END
	89	#endif /* COND_INIT */
33f46ff6	90
f826a10b	91	/* DETACH(t) must only be called while holding t->mutex */
ea0efc06 MB	92	#ifndef DETACH
	93	#define DETACH(t) \
	94	STMT_START { \
46930d8f	95	if (pthread_detach((t)->self)) { \
ea0efc06 MB	96	MUTEX_UNLOCK(&(t)->mutex); \
	97	croak("panic: DETACH"); \
	98	} \
	99	} STMT_END
	100	#endif /* DETACH */
33f46ff6	101
ea0efc06 MB	102	#ifndef JOIN
	103	#define JOIN(t, avp) \
	104	STMT_START { \
46930d8f	105	if (pthread_join((t)->self, (void**)(avp))) \
ea0efc06 MB	106	croak("panic: pthread_join"); \
	107	} STMT_END
	108	#endif /* JOIN */
	109
	110	#ifndef SET_THR
	111	#define SET_THR(t) \
	112	STMT_START { \
533c011a	113	if (pthread_setspecific(PL_thr_key, (void *) (t))) \
ea0efc06 MB	114	croak("panic: pthread_setspecific"); \
	115	} STMT_END
	116	#endif /* SET_THR */
	117
	118	#ifndef THR
	119	# ifdef OLD_PTHREADS_API
52e1cb5e	120	struct perl_thread *getTHR _((void));
ea0efc06 MB	121	# define THR getTHR()
ea0efc06 MB	122	# else
533c011a	123	# define THR ((struct perl_thread *) pthread_getspecific(PL_thr_key))
ea0efc06 MB	124	# endif /* OLD_PTHREADS_API */
	125	#endif /* THR */
	126
940cb80d MB	127	/*
	128	* dTHR is performance-critical. Here, we only do the pthread_get_specific
	129	* if there may be more than one thread in existence, otherwise we get thr
	130	* from thrsv which is cached in the per-interpreter structure.
	131	* Systems with very fast pthread_get_specific (which should be all systems
	132	* but unfortunately isn't) may wish to simplify to "...*thr = THR".
	133	*/
ea0efc06	134	#ifndef dTHR
940cb80d	135	# define dTHR \
533c011a	136	struct perl_thread thr = PL_threadnum? THR : (struct perl_thread)SvPVX(PL_thrsv)
ea0efc06	137	#endif /* dTHR */
11343788	138
33f46ff6 MB	139	#ifndef INIT_THREADS
	140	# ifdef NEED_PTHREAD_INIT
	141	# define INIT_THREADS pthread_init()
	142	# else
	143	# define INIT_THREADS NOOP
	144	# endif
	145	#endif
11343788	146
940cb80d MB	147	/* Accessor for per-thread SVs */
	148	#define THREADSV(i) (thr->threadsvp[i])
	149
	150	/*
	151	* LOCK_SV_MUTEX and UNLOCK_SV_MUTEX are performance-critical. Here, we
	152	* try only locking them if there may be more than one thread in existence.
	153	* Systems with very fast mutexes (and/or slow conditionals) may wish to
	154	* remove the "if (threadnum) ..." test.
	155	*/
5f08fbcd GS	156	#define LOCK_SV_MUTEX \
	157	STMT_START { \
	158	if (PL_threadnum) \
	159	MUTEX_LOCK(&PL_sv_mutex); \
	160	} STMT_END
	161
	162	#define UNLOCK_SV_MUTEX \
	163	STMT_START { \
533c011a	164	if (PL_threadnum) \
5f08fbcd	165	MUTEX_UNLOCK(&PL_sv_mutex); \
940cb80d MB	166	} STMT_END
940cb80d MB	167
5f08fbcd GS	168	/* Likewise for strtab_mutex */
	169	#define LOCK_STRTAB_MUTEX \
	170	STMT_START { \
	171	if (PL_threadnum) \
	172	MUTEX_LOCK(&PL_strtab_mutex); \
	173	} STMT_END
	174
	175	#define UNLOCK_STRTAB_MUTEX \
	176	STMT_START { \
533c011a	177	if (PL_threadnum) \
5f08fbcd	178	MUTEX_UNLOCK(&PL_strtab_mutex); \
940cb80d	179	} STMT_END
d55594ae	180
ea0efc06 MB	181	#ifndef THREAD_RET_TYPE
	182	# define THREAD_RET_TYPE void *
	183	# define THREAD_RET_CAST(p) ((void *)(p))
	184	#endif /* THREAD_RET */
	185
11343788	186
33f46ff6	187	/* Values and macros for thr->flags */
605e5515 MB	188	#define THRf_STATE_MASK 7
	189	#define THRf_R_JOINABLE 0
	190	#define THRf_R_JOINED 1
	191	#define THRf_R_DETACHED 2
	192	#define THRf_ZOMBIE 3
	193	#define THRf_DEAD 4
f93b4edd	194
458fb581	195	#define THRf_DID_DIE 8
07b73707	196
f826a10b	197	/* ThrSTATE(t) and ThrSETSTATE(t) must only be called while holding t->mutex */
458fb581	198	#define ThrSTATE(t) ((t)->flags & THRf_STATE_MASK)
f93b4edd	199	#define ThrSETSTATE(t, s) STMT_START { \
605e5515	200	(t)->flags &= ~THRf_STATE_MASK; \
33f46ff6	201	(t)->flags \|= (s); \
8b73bbec	202	DEBUG_S(PerlIO_printf(PerlIO_stderr(), \
605e5515	203	"thread %p set to state %d\n", (t), (s))); \
f93b4edd MB	204	} STMT_END
	205
	206	typedef struct condpair {
f826a10b MB	207	perl_mutex mutex; /* Protects all other fields */
	208	perl_cond owner_cond; /* For when owner changes at all */
	209	perl_cond cond; /* For cond_signal and cond_broadcast */
	210	Thread owner; /* Currently owning thread */
f93b4edd MB	211	} condpair_t;
	212
	213	#define MgMUTEXP(mg) (&((condpair_t *)(mg->mg_ptr))->mutex)
	214	#define MgOWNERCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->owner_cond)
	215	#define MgCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->cond)
	216	#define MgOWNER(mg) ((condpair_t *)(mg->mg_ptr))->owner
	217
ea0efc06 MB	218	#else
	219	/* USE_THREADS is not defined */
	220	#define MUTEX_LOCK(m)
	221	#define MUTEX_UNLOCK(m)
	222	#define MUTEX_INIT(m)
	223	#define MUTEX_DESTROY(m)
	224	#define COND_INIT(c)
	225	#define COND_SIGNAL(c)
	226	#define COND_BROADCAST(c)
	227	#define COND_WAIT(c, m)
	228	#define COND_DESTROY(c)
93bce2dc GS	229	#define LOCK_SV_MUTEX
93bce2dc GS	230	#define UNLOCK_SV_MUTEX
5f08fbcd GS	231	#define LOCK_STRTAB_MUTEX
5f08fbcd GS	232	#define UNLOCK_STRTAB_MUTEX
ea0efc06 MB	233
	234	#define THR
	235	/* Rats: if dTHR is just blank then the subsequent ";" throws an error */
76e3520e	236	#ifdef WIN32
e3b8966e	237	#define dTHR extern int Perl___notused
76e3520e	238	#else
ea0efc06	239	#define dTHR extern int errno
76e3520e	240	#endif
11343788	241	#endif /* USE_THREADS */