[p5sagit/p5-mst-13.2.git] / thread.h

#ifdef USE_THREADS

#ifdef WIN32
#  include <win32thread.h>
#else

#ifndef DJGPP
/* POSIXish threads */
#ifdef OLD_PTHREADS_API
#  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 YIELD pthread_yield()
#  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
#endif

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

#ifndef YIELD
#  ifdef HAS_SCHED_YIELD
#    define YIELD sched_yield()
#  else
#    ifdef HAS_PTHREAD_YIELD
#      define YIELD pthread_yield()
#    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(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(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 = threadnum? THR : (struct perl_thread*)SvPVX(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 (threadnum)			\
	    MUTEX_LOCK(&sv_mutex);	\
    } STMT_END

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