X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/462e5cf694f345fbf34a1f95e9a82957e59dcc2b..638eceb6656bf10acb1a6dc2a55880f5e1a6c8c4:/thread.h

diff --git a/thread.h b/thread.h
index b207862..1e2a220 100644
--- a/thread.h
+++ b/thread.h
@@ -1,155 +1,328 @@
-#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)
+#ifdef USE_THREADS
 
-#define THR
-/* Rats: if dTHR is just blank then the subsequent ";" throws an error */
-#define dTHR extern int errno
+#ifdef WIN32
+#  include <win32thread.h>
 #else
-#include <pthread.h>
+#  ifdef OLD_PTHREADS_API /* Here be dragons. */
+#    define DETACH(t)				\
+    STMT_START {				\
+	if (pthread_detach(&(t)->self)) {	\
+	    MUTEX_UNLOCK(&(t)->mutex);		\
+	    Perl_croak(aTHX_ "panic: DETACH");		\
+	}					\
+    } STMT_END
+#    define THR getTHR()
+struct perl_thread *getTHR (void);
+#    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(DJGPP) || defined(__OPEN_VM)
+#      define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_attr_setdetachstate(a,&(s))
+#      define YIELD pthread_yield(NULL)
+#    endif
+#  endif
+#    define pthread_mutexattr_default NULL
+#    define pthread_condattr_default  NULL
+#endif
 
-#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
+#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
 
-struct thread {
-    pthread_t	Tself;
+#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
 
-    /* The fields that used to be global */
-    SV **	Tstack_base;
-    SV **	Tstack_sp;
-    SV **	Tstack_max;
+#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(aTHX_ "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(aTHX_ "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 SET_THR(thr)		cthread_set_data(cthread_self(), thr)
+#define THR			cthread_data(cthread_self())
+
+#define INIT_THREADS		cthread_init()
+#define YIELD			cthread_yield()
+#define ALLOC_THREAD_KEY
+#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 OP_IN_REGISTER
-    OP *	Topsave;
+#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(aTHX_ "panic: MUTEX_INIT");				\
+    } STMT_END
 #else
-    OP *	Top;
+#define MUTEX_INIT(m)						\
+    STMT_START {						\
+	if (pthread_mutex_init((m), pthread_mutexattr_default))	\
+	    Perl_croak(aTHX_ "panic: MUTEX_INIT");				\
+    } STMT_END
 #endif
+#define MUTEX_LOCK(m)				\
+    STMT_START {				\
+	if (pthread_mutex_lock((m)))		\
+	    Perl_croak(aTHX_ "panic: MUTEX_LOCK");		\
+    } STMT_END
+#define MUTEX_UNLOCK(m)				\
+    STMT_START {				\
+	if (pthread_mutex_unlock((m)))		\
+	    Perl_croak(aTHX_ "panic: MUTEX_UNLOCK");	\
+    } STMT_END
+#define MUTEX_LOCK_NOCONTEXT(m)				\
+    STMT_START {					\
+	if (pthread_mutex_lock((m)))			\
+	    Perl_croak_nocontext("panic: MUTEX_LOCK");	\
+    } STMT_END
+#define MUTEX_UNLOCK_NOCONTEXT(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(aTHX_ "panic: MUTEX_DESTROY");	\
+    } STMT_END
+#endif /* MUTEX_INIT */
 
-    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;
-    AV *	Tpad;
-    AV *	Tpadname;
-
-    SV **	Ttmps_stack;
-    I32		Ttmps_ix;
-    I32		Ttmps_floor;
-    I32		Ttmps_max;
-
-    int		Tin_eval;
-    OP *	Trestartop;
-    int		Tdelaymagic;
-    bool	Tdirty;
-    U8		Tlocalizing;
-
-    CONTEXT *	Tcxstack;
-    I32		Tcxstack_ix;
-    I32		Tcxstack_max;
-
-    AV *	Tstack;
-    AV *	Tmainstack;
-    JMPENV *	Ttop_env;
-    I32		Trunlevel;
-
-    /* XXX Sort stuff, firstgv, secongv and so on? */
-
-    pthread_mutex_t *	Tthreadstart_mutexp;
-    HV *	Tcvcache;
-    U32		Tthrflags;
-};
-
-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)
+#ifndef COND_INIT
+#define COND_INIT(c)						\
+    STMT_START {						\
+	if (pthread_cond_init((c), pthread_condattr_default))	\
+	    Perl_croak(aTHX_ "panic: COND_INIT");				\
+    } STMT_END
+#define COND_SIGNAL(c)				\
+    STMT_START {				\
+	if (pthread_cond_signal((c)))		\
+	    Perl_croak(aTHX_ "panic: COND_SIGNAL");	\
+    } STMT_END
+#define COND_BROADCAST(c)			\
+    STMT_START {				\
+	if (pthread_cond_broadcast((c)))	\
+	    Perl_croak(aTHX_ "panic: COND_BROADCAST");	\
+    } STMT_END
+#define COND_WAIT(c, m)				\
+    STMT_START {				\
+	if (pthread_cond_wait((c), (m)))	\
+	    Perl_croak(aTHX_ "panic: COND_WAIT");		\
+    } STMT_END
+#define COND_DESTROY(c)				\
+    STMT_START {				\
+	if (pthread_cond_destroy((c)))		\
+	    Perl_croak(aTHX_ "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(aTHX_ "panic: DETACH");		\
+	}					\
+    } STMT_END
+#endif /* DETACH */
+
+#ifndef JOIN
+#define JOIN(t, avp) 					\
+    STMT_START {					\
+	if (pthread_join((t)->self, (void**)(avp)))	\
+	    Perl_croak(aTHX_ "panic: pthread_join");		\
+    } STMT_END
+#endif /* JOIN */
+
+#ifndef SET_THR
+#define SET_THR(t)					\
+    STMT_START {					\
+	if (pthread_setspecific(PL_thr_key, (void *) (t)))	\
+	    Perl_croak(aTHX_ "panic: pthread_setspecific");	\
+    } STMT_END
+#endif /* SET_THR */
+
+#ifndef THR
+#define THR ((struct perl_thread *) pthread_getspecific(PL_thr_key))
+#endif
+
+/*
+ * 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".
+ *
+ * The use of PL_threadnum should be safe here.
+ */
+#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.
+ * XXX do NOT use C<if (PL_threadnum) ...> -- it sets up race conditions!
+ */
+#define LOCK_SV_MUTEX				\
+    STMT_START {				\
+	MUTEX_LOCK(&PL_sv_mutex);		\
+    } STMT_END
+
+#define UNLOCK_SV_MUTEX				\
+    STMT_START {				\
+	MUTEX_UNLOCK(&PL_sv_mutex);		\
+    } STMT_END
+
+/* Likewise for strtab_mutex */
+#define LOCK_STRTAB_MUTEX			\
+    STMT_START {				\
+	MUTEX_LOCK(&PL_strtab_mutex);		\
+    } STMT_END
+
+#define UNLOCK_STRTAB_MUTEX			\
+    STMT_START {				\
+	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)->Tthrflags &= ~THR_STATE_MASK;	\
-	(t)->Tthrflags |= (s);			\
-	DEBUG_L(fprintf(stderr, "thread 0x%lx set to state %d\n", \
-			(unsigned long)(t), (s))); \
+	(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 {
-    pthread_mutex_t	mutex;
-    pthread_cond_t	owner_cond;
-    pthread_cond_t	cond;
-    Thread		owner;
+    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)
@@ -157,87 +330,24 @@ typedef struct condpair {
 #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	stack
-#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	cxstack
-#undef	cxstack_ix
-#undef	cxstack_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	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 pad		(thr->Tpad)
-#define padname		(thr->Tpadname)
-
-#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)
+/* USE_THREADS is not defined */
+#define MUTEX_LOCK(m)
+#define MUTEX_LOCK_NOCONTEXT(m)
+#define MUTEX_UNLOCK(m)
+#define MUTEX_UNLOCK_NOCONTEXT(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
+#define dTHR dNOOP
 #endif /* USE_THREADS */