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

#ifndef USE_THREADS
#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 THR
/* Rats: if dTHR is just blank then the subsequent ";" throws an error */
#define dTHR extern int errno
#else

#ifdef FAKE_THREADS
typedef struct thread *perl_thread;
/* With fake threads, thr is global(ish) so we don't need dTHR */
#define dTHR extern int errno

/*
 * Note that SCHEDULE() is only callable from pp code (which
 * must be expecting to be restarted). We'll have to do
 * something a bit different for XS code.
 */
#define SCHEDULE() return schedule(), op

#define MUTEX_LOCK(m)
#define MUTEX_UNLOCK(m)
#define MUTEX_INIT(m)
#define MUTEX_DESTROY(m)
#define COND_INIT(c) perl_cond_init(c)
#define COND_SIGNAL(c) perl_cond_signal(c)
#define COND_BROADCAST(c) perl_cond_broadcast(c)
#define COND_WAIT(c, m) STMT_START {	\
	perl_cond_wait(c);		\
	SCHEDULE();			\
    } STMT_END
#define COND_DESTROY(c)

#else
/* POSIXish threads */
typedef pthread_t perl_thread;
#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))
#else
#define pthread_mutexattr_default NULL
#endif /* OLD_PTHREADS_API */

#define MUTEX_INIT(m) \
    if (pthread_mutex_init((m), pthread_mutexattr_default)) \
	croak("panic: MUTEX_INIT"); \
    else 1
#define MUTEX_LOCK(m) \
    if (pthread_mutex_lock((m))) croak("panic: MUTEX_LOCK"); else 1
#define MUTEX_UNLOCK(m) \
    if (pthread_mutex_unlock((m))) croak("panic: MUTEX_UNLOCK"); else 1
#define MUTEX_DESTROY(m) \
    if (pthread_mutex_destroy((m))) croak("panic: MUTEX_DESTROY"); else 1
#define COND_INIT(c) \
    if (pthread_cond_init((c), NULL)) croak("panic: COND_INIT"); else 1
#define COND_SIGNAL(c) \
    if (pthread_cond_signal((c))) croak("panic: COND_SIGNAL"); else 1
#define COND_BROADCAST(c) \
    if (pthread_cond_broadcast((c))) croak("panic: COND_BROADCAST"); else 1
#define COND_WAIT(c, m) \
    if (pthread_cond_wait((c), (m))) croak("panic: COND_WAIT"); else 1
#define COND_DESTROY(c) \
    if (pthread_cond_destroy((c))) croak("panic: COND_DESTROY"); else 1
/* XXX Add "old" (?) POSIX draft interface too */
#ifdef OLD_PTHREADS_API
struct thread *getTHR _((void));
#define THR getTHR()
#else
#define THR ((struct thread *) pthread_getspecific(thr_key))
#endif /* OLD_PTHREADS_API */
#define dTHR struct thread *thr = THR
#endif /* FAKE_THREADS */

struct thread {
    perl_thread	Tself;

    /* The fields that used to be global */
    SV **	Tstack_base;
    SV **	Tstack_sp;
    SV **	Tstack_max;

#ifdef OP_IN_REGISTER
    OP *	Topsave;
#else
    OP *	Top;
#endif

    I32 *	Tscopestack;
    I32		Tscopestack_ix;
    I32		Tscopestack_max;

    ANY *	Tsavestack;
    I32		Tsavestack_ix;
    I32		Tsavestack_max;

    OP **	Tretstack;
    I32		Tretstack_ix;
    I32		Tretstack_max;

    I32 *	Tmarkstack;
    I32 *	Tmarkstack_ptr;
    I32 *	Tmarkstack_max;

    SV **	Tcurpad;

    SV *	TSv;
    XPV *	TXpv;
    char	Tbuf[2048];	/* should be a global locked by a mutex */
    char	Ttokenbuf[256];	/* should be a global locked by a mutex */
    struct stat	Tstatbuf;
    struct tms	Ttimesbuf;
    
    /* XXX What about regexp stuff? */

    /* Now the fields that used to be "per interpreter" (even when global) */

    /* XXX What about magic variables such as $/, $? and so on? */
    HV *	Tdefstash;
    HV *	Tcurstash;

    SV **	Ttmps_stack;
    I32		Ttmps_ix;
    I32		Ttmps_floor;
    I32		Ttmps_max;

    int		Tin_eval;
    OP *	Trestartop;
    int		Tdelaymagic;
    bool	Tdirty;
    U8		Tlocalizing;
    COP *	Tcurcop;

    CONTEXT *	Tcxstack;
    I32		Tcxstack_ix;
    I32		Tcxstack_max;

    AV *	Tcurstack;
    AV *	Tmainstack;
    JMPENV *	Ttop_env;
    I32		Trunlevel;

    /* XXX Sort stuff, firstgv, secongv and so on? */

    perl_mutex *Tthreadstart_mutexp;
    HV *	Tcvcache;
    U32		Tthrflags;

#ifdef FAKE_THREADS
    perl_thread next, prev;		/* Linked list of all threads */
    perl_thread next_run, prev_run;	/* Linked list of runnable threads */
    perl_cond	wait_queue;		/* Wait queue that we are waiting on */
    IV		private;		/* Holds data across time slices */
    I32		savemark;		/* Holds MARK for thread join values */
#endif /* FAKE_THREADS */
};

typedef struct thread *Thread;

/* Values and macros for thrflags */
#define THR_STATE_MASK	3
#define THR_NORMAL	0
#define THR_DETACHED	1
#define THR_JOINED	2
#define THR_DEAD	3

#define ThrSTATE(t)	(t->Tthrflags & THR_STATE_MASK)
#define ThrSETSTATE(t, s) STMT_START {		\
	(t)->Tthrflags &= ~THR_STATE_MASK;	\
	(t)->Tthrflags |= (s);			\
	DEBUG_L(fprintf(stderr, "thread 0x%lx set to state %d\n", \
			(unsigned long)(t), (s))); \
    } STMT_END

typedef struct condpair {
    perl_mutex	mutex;
    perl_cond	owner_cond;
    perl_cond	cond;
    Thread	owner;
} 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

#undef	stack_base
#undef	stack_sp
#undef	stack_max
#undef	curstack
#undef	mainstack
#undef	markstack
#undef	markstack_ptr
#undef	markstack_max
#undef	scopestack
#undef	scopestack_ix
#undef	scopestack_max
#undef	savestack
#undef	savestack_ix
#undef	savestack_max
#undef	retstack
#undef	retstack_ix
#undef	retstack_max
#undef	curcop
#undef	cxstack
#undef	cxstack_ix
#undef	cxstack_max
#undef	tmps_stack
#undef	tmps_floor
#undef	tmps_ix
#undef	tmps_max
#undef	curpad
#undef	Sv
#undef	Xpv
#undef	top_env
#undef	runlevel
#undef	in_eval

#define self		(thr->Tself)
#define stack_base	(thr->Tstack_base)
#define stack_sp	(thr->Tstack_sp)
#define stack_max	(thr->Tstack_max)
#ifdef OP_IN_REGISTER
#define opsave		(thr->Topsave)
#else
#undef	op
#define op		(thr->Top)
#endif
#define	curcop		(thr->Tcurcop)
#define	stack		(thr->Tstack)
#define	mainstack	(thr->Tmainstack)
#define	markstack	(thr->Tmarkstack)
#define	markstack_ptr	(thr->Tmarkstack_ptr)
#define	markstack_max	(thr->Tmarkstack_max)
#define	scopestack	(thr->Tscopestack)
#define	scopestack_ix	(thr->Tscopestack_ix)
#define	scopestack_max	(thr->Tscopestack_max)

#define	savestack	(thr->Tsavestack)
#define	savestack_ix	(thr->Tsavestack_ix)
#define	savestack_max	(thr->Tsavestack_max)

#define	retstack	(thr->Tretstack)
#define	retstack_ix	(thr->Tretstack_ix)
#define	retstack_max	(thr->Tretstack_max)

#define	cxstack		(thr->Tcxstack)
#define	cxstack_ix	(thr->Tcxstack_ix)
#define	cxstack_max	(thr->Tcxstack_max)

#define curpad		(thr->Tcurpad)
#define Sv		(thr->TSv)
#define Xpv		(thr->TXpv)
#define defstash	(thr->Tdefstash)
#define curstash	(thr->Tcurstash)

#define tmps_stack	(thr->Ttmps_stack)
#define tmps_ix		(thr->Ttmps_ix)
#define tmps_floor	(thr->Ttmps_floor)
#define tmps_max	(thr->Ttmps_max)

#define in_eval		(thr->Tin_eval)
#define restartop	(thr->Trestartop)
#define delaymagic	(thr->Tdelaymagic)
#define dirty		(thr->Tdirty)
#define localizing	(thr->Tlocalizing)

#define	top_env		(thr->Ttop_env)
#define	runlevel	(thr->Trunlevel)

#define	threadstart_mutexp	(thr->Tthreadstart_mutexp)
#define	cvcache		(thr->Tcvcache)
#define	thrflags	(thr->Tthrflags)
#endif /* USE_THREADS */
Commit	Line	Data
11343788	1	#ifndef USE_THREADS
	2	#define MUTEX_LOCK(m)
	3	#define MUTEX_UNLOCK(m)
	4	#define MUTEX_INIT(m)
	5	#define MUTEX_DESTROY(m)
	6	#define COND_INIT(c)
	7	#define COND_SIGNAL(c)
	8	#define COND_BROADCAST(c)
	9	#define COND_WAIT(c, m)
	10	#define COND_DESTROY(c)
	11
	12	#define THR
	13	/* Rats: if dTHR is just blank then the subsequent ";" throws an error */
	14	#define dTHR extern int errno
	15	#else
11343788	16
12ca11f6	17	#ifdef FAKE_THREADS
	18	typedef struct thread *perl_thread;
	19	/* With fake threads, thr is global(ish) so we don't need dTHR */
	20	#define dTHR extern int errno
	21
	22	/*
	23	* Note that SCHEDULE() is only callable from pp code (which
	24	* must be expecting to be restarted). We'll have to do
	25	* something a bit different for XS code.
	26	*/
	27	#define SCHEDULE() return schedule(), op
	28
	29	#define MUTEX_LOCK(m)
	30	#define MUTEX_UNLOCK(m)
	31	#define MUTEX_INIT(m)
	32	#define MUTEX_DESTROY(m)
	33	#define COND_INIT(c) perl_cond_init(c)
	34	#define COND_SIGNAL(c) perl_cond_signal(c)
	35	#define COND_BROADCAST(c) perl_cond_broadcast(c)
	36	#define COND_WAIT(c, m) STMT_START { \
	37	perl_cond_wait(c); \
	38	SCHEDULE(); \
	39	} STMT_END
	40	#define COND_DESTROY(c)
	41
	42	#else
	43	/* POSIXish threads */
	44	typedef pthread_t perl_thread;
11343788	45	#ifdef OLD_PTHREADS_API
	46	#define pthread_mutexattr_init(a) pthread_mutexattr_create(a)
	47	#define pthread_mutexattr_settype(a,t) pthread_mutexattr_setkind_np(a,t)
	48	#define pthread_key_create(k,d) pthread_keycreate(k,(pthread_destructor_t)(d))
	49	#else
	50	#define pthread_mutexattr_default NULL
	51	#endif /* OLD_PTHREADS_API */
	52
	53	#define MUTEX_INIT(m) \
	54	if (pthread_mutex_init((m), pthread_mutexattr_default)) \
	55	croak("panic: MUTEX_INIT"); \
	56	else 1
	57	#define MUTEX_LOCK(m) \
	58	if (pthread_mutex_lock((m))) croak("panic: MUTEX_LOCK"); else 1
	59	#define MUTEX_UNLOCK(m) \
	60	if (pthread_mutex_unlock((m))) croak("panic: MUTEX_UNLOCK"); else 1
	61	#define MUTEX_DESTROY(m) \
	62	if (pthread_mutex_destroy((m))) croak("panic: MUTEX_DESTROY"); else 1
	63	#define COND_INIT(c) \
	64	if (pthread_cond_init((c), NULL)) croak("panic: COND_INIT"); else 1
	65	#define COND_SIGNAL(c) \
	66	if (pthread_cond_signal((c))) croak("panic: COND_SIGNAL"); else 1
	67	#define COND_BROADCAST(c) \
	68	if (pthread_cond_broadcast((c))) croak("panic: COND_BROADCAST"); else 1
	69	#define COND_WAIT(c, m) \
	70	if (pthread_cond_wait((c), (m))) croak("panic: COND_WAIT"); else 1
	71	#define COND_DESTROY(c) \
	72	if (pthread_cond_destroy((c))) croak("panic: COND_DESTROY"); else 1
	73	/* XXX Add "old" (?) POSIX draft interface too */
	74	#ifdef OLD_PTHREADS_API
	75	struct thread *getTHR _((void));
	76	#define THR getTHR()
	77	#else
	78	#define THR ((struct thread *) pthread_getspecific(thr_key))
	79	#endif /* OLD_PTHREADS_API */
	80	#define dTHR struct thread *thr = THR
12ca11f6	81	#endif /* FAKE_THREADS */
11343788	82
11343788	83	struct thread {
12ca11f6	84	perl_thread Tself;
11343788	85
	86	/* The fields that used to be global */
	87	SV ** Tstack_base;
	88	SV ** Tstack_sp;
	89	SV ** Tstack_max;
	90
462e5cf6	91	#ifdef OP_IN_REGISTER
	92	OP * Topsave;
	93	#else
11343788	94	OP * Top;
462e5cf6	95	#endif
11343788	96
	97	I32 * Tscopestack;
	98	I32 Tscopestack_ix;
	99	I32 Tscopestack_max;
	100
	101	ANY * Tsavestack;
	102	I32 Tsavestack_ix;
	103	I32 Tsavestack_max;
	104
	105	OP ** Tretstack;
	106	I32 Tretstack_ix;
	107	I32 Tretstack_max;
	108
	109	I32 * Tmarkstack;
	110	I32 * Tmarkstack_ptr;
	111	I32 * Tmarkstack_max;
	112
	113	SV ** Tcurpad;
	114
	115	SV * TSv;
	116	XPV * TXpv;
	117	char Tbuf[2048]; /* should be a global locked by a mutex */
	118	char Ttokenbuf[256]; /* should be a global locked by a mutex */
	119	struct stat Tstatbuf;
	120	struct tms Ttimesbuf;
	121
	122	/* XXX What about regexp stuff? */
	123
	124	/* Now the fields that used to be "per interpreter" (even when global) */
	125
	126	/* XXX What about magic variables such as $/, $? and so on? */
	127	HV * Tdefstash;
	128	HV * Tcurstash;
11343788	129
	130	SV ** Ttmps_stack;
	131	I32 Ttmps_ix;
	132	I32 Ttmps_floor;
	133	I32 Ttmps_max;
	134
	135	int Tin_eval;
	136	OP * Trestartop;
	137	int Tdelaymagic;
	138	bool Tdirty;
	139	U8 Tlocalizing;
0f15f207	140	COP * Tcurcop;
11343788	141
	142	CONTEXT * Tcxstack;
	143	I32 Tcxstack_ix;
	144	I32 Tcxstack_max;
	145
0f15f207	146	AV * Tcurstack;
11343788	147	AV * Tmainstack;
e858de61	148	JMPENV * Ttop_env;
11343788	149	I32 Trunlevel;
	150
	151	/* XXX Sort stuff, firstgv, secongv and so on? */
	152
12ca11f6	153	perl_mutex *Tthreadstart_mutexp;
11343788	154	HV * Tcvcache;
f93b4edd	155	U32 Tthrflags;
12ca11f6	156
	157	#ifdef FAKE_THREADS
	158	perl_thread next, prev; /* Linked list of all threads */
	159	perl_thread next_run, prev_run; /* Linked list of runnable threads */
	160	perl_cond wait_queue; /* Wait queue that we are waiting on */
	161	IV private; /* Holds data across time slices */
0f15f207	162	I32 savemark; /* Holds MARK for thread join values */
12ca11f6	163	#endif /* FAKE_THREADS */
11343788	164	};
	165
	166	typedef struct thread *Thread;
	167
f93b4edd	168	/* Values and macros for thrflags */
	169	#define THR_STATE_MASK 3
	170	#define THR_NORMAL 0
	171	#define THR_DETACHED 1
	172	#define THR_JOINED 2
	173	#define THR_DEAD 3
	174
	175	#define ThrSTATE(t) (t->Tthrflags & THR_STATE_MASK)
	176	#define ThrSETSTATE(t, s) STMT_START { \
	177	(t)->Tthrflags &= ~THR_STATE_MASK; \
	178	(t)->Tthrflags \|= (s); \
	179	DEBUG_L(fprintf(stderr, "thread 0x%lx set to state %d\n", \
	180	(unsigned long)(t), (s))); \
	181	} STMT_END
	182
	183	typedef struct condpair {
12ca11f6	184	perl_mutex mutex;
	185	perl_cond owner_cond;
	186	perl_cond cond;
	187	Thread owner;
f93b4edd	188	} condpair_t;
	189
	190	#define MgMUTEXP(mg) (&((condpair_t *)(mg->mg_ptr))->mutex)
	191	#define MgOWNERCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->owner_cond)
	192	#define MgCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->cond)
	193	#define MgOWNER(mg) ((condpair_t *)(mg->mg_ptr))->owner
	194
11343788	195	#undef stack_base
	196	#undef stack_sp
	197	#undef stack_max
0f15f207	198	#undef curstack
11343788	199	#undef mainstack
	200	#undef markstack
	201	#undef markstack_ptr
	202	#undef markstack_max
	203	#undef scopestack
	204	#undef scopestack_ix
	205	#undef scopestack_max
	206	#undef savestack
	207	#undef savestack_ix
	208	#undef savestack_max
	209	#undef retstack
	210	#undef retstack_ix
	211	#undef retstack_max
0f15f207	212	#undef curcop
11343788	213	#undef cxstack
	214	#undef cxstack_ix
	215	#undef cxstack_max
6d4ff0d2	216	#undef tmps_stack
	217	#undef tmps_floor
	218	#undef tmps_ix
	219	#undef tmps_max
11343788	220	#undef curpad
	221	#undef Sv
	222	#undef Xpv
11343788	223	#undef top_env
	224	#undef runlevel
	225	#undef in_eval
	226
	227	#define self (thr->Tself)
	228	#define stack_base (thr->Tstack_base)
	229	#define stack_sp (thr->Tstack_sp)
	230	#define stack_max (thr->Tstack_max)
462e5cf6	231	#ifdef OP_IN_REGISTER
	232	#define opsave (thr->Topsave)
	233	#else
	234	#undef op
11343788	235	#define op (thr->Top)
462e5cf6	236	#endif
0f15f207	237	#define curcop (thr->Tcurcop)
11343788	238	#define stack (thr->Tstack)
	239	#define mainstack (thr->Tmainstack)
	240	#define markstack (thr->Tmarkstack)
	241	#define markstack_ptr (thr->Tmarkstack_ptr)
	242	#define markstack_max (thr->Tmarkstack_max)
	243	#define scopestack (thr->Tscopestack)
	244	#define scopestack_ix (thr->Tscopestack_ix)
	245	#define scopestack_max (thr->Tscopestack_max)
	246
	247	#define savestack (thr->Tsavestack)
	248	#define savestack_ix (thr->Tsavestack_ix)
	249	#define savestack_max (thr->Tsavestack_max)
	250
	251	#define retstack (thr->Tretstack)
	252	#define retstack_ix (thr->Tretstack_ix)
	253	#define retstack_max (thr->Tretstack_max)
	254
	255	#define cxstack (thr->Tcxstack)
	256	#define cxstack_ix (thr->Tcxstack_ix)
	257	#define cxstack_max (thr->Tcxstack_max)
	258
	259	#define curpad (thr->Tcurpad)
	260	#define Sv (thr->TSv)
	261	#define Xpv (thr->TXpv)
	262	#define defstash (thr->Tdefstash)
	263	#define curstash (thr->Tcurstash)
11343788	264
	265	#define tmps_stack (thr->Ttmps_stack)
	266	#define tmps_ix (thr->Ttmps_ix)
	267	#define tmps_floor (thr->Ttmps_floor)
	268	#define tmps_max (thr->Ttmps_max)
	269
	270	#define in_eval (thr->Tin_eval)
	271	#define restartop (thr->Trestartop)
	272	#define delaymagic (thr->Tdelaymagic)
	273	#define dirty (thr->Tdirty)
	274	#define localizing (thr->Tlocalizing)
	275
	276	#define top_env (thr->Ttop_env)
	277	#define runlevel (thr->Trunlevel)
	278
	279	#define threadstart_mutexp (thr->Tthreadstart_mutexp)
f93b4edd	280	#define cvcache (thr->Tcvcache)
f93b4edd	281	#define thrflags (thr->Tthrflags)
11343788	282	#endif /* USE_THREADS */