This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Make #2012 glob pattern more portable.
[perl5.git] / thread.h
index 5cb4b28..50d9fc3 100644 (file)
--- a/thread.h
+++ b/thread.h
@@ -3,30 +3,38 @@
 #ifdef WIN32
 #  include <win32thread.h>
 #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))
-#  define YIELD pthread_yield()
-#  define DETACH(t)                            \
+#  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
-#  define pthread_attr_default NULL
-#endif /* OLD_PTHREADS_API */
+#  else
+#    define pthread_mutexattr_default NULL
+#    define pthread_condattr_default NULL
+#  endif /* OLD_PTHREADS_API */
 #endif
 
 #ifndef YIELD
-#  define YIELD sched_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
@@ -102,22 +110,30 @@ typedef pthread_t perl_thread;
 #ifndef SET_THR
 #define SET_THR(t)                                     \
     STMT_START {                                       \
-       if (pthread_setspecific(thr_key, (void *) (t))) \
+       if (pthread_setspecific(PL_thr_key, (void *) (t)))      \
            croak("panic: pthread_setspecific");        \
     } STMT_END
 #endif /* SET_THR */
 
 #ifndef THR
 #  ifdef OLD_PTHREADS_API
-struct thread *getTHR _((void));
+struct perl_thread *getTHR _((void));
 #    define THR getTHR()
 #  else
-#    define THR ((struct thread *) pthread_getspecific(thr_key))
+#    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 thread *thr = THR
+#  define dTHR \
+    struct perl_thread *thr = PL_threadnum? THR : (struct perl_thread*)SvPVX(PL_thrsv)
 #endif /* dTHR */
 
 #ifndef INIT_THREADS
@@ -128,92 +144,45 @@ struct thread *getTHR _((void));
 #  endif
 #endif
 
-#ifndef THREAD_RET_TYPE
-#  define THREAD_RET_TYPE      void *
-#  define THREAD_RET_CAST(p)   ((void *)(p))
-#endif /* THREAD_RET */
+/* Accessor for per-thread SVs */
+#define THREADSV(i) (thr->threadsvp[i])
 
-struct thread {
-    /* The fields that used to be global */
-    /* Important ones in the first cache line (if alignment is done right) */
-    SV **      Tstack_sp;
-#ifdef OP_IN_REGISTER
-    OP *       Topsave;
-#else
-    OP *       Top;
-#endif
-    SV **      Tcurpad;
-    SV **      Tstack_base;
-
-    SV **      Tstack_max;
-
-    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 *       TSv;
-    XPV *      TXpv;
-    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;
+/*
+ * 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
 
-    AV *       Tcurstack;
-    AV *       Tmainstack;
-    JMPENV *   Ttop_env;
-    I32                Trunlevel;
+#define UNLOCK_SV_MUTEX                                \
+    STMT_START {                               \
+       if (PL_threadnum)                       \
+           MUTEX_UNLOCK(&PL_sv_mutex);         \
+    } STMT_END
 
-    /* XXX Sort stuff, firstgv, secongv and so on? */
+/* Likewise for strtab_mutex */
+#define LOCK_STRTAB_MUTEX                      \
+    STMT_START {                               \
+       if (PL_threadnum)                       \
+           MUTEX_LOCK(&PL_strtab_mutex);       \
+    } STMT_END
 
-    SV *       Toursv;
-    HV *       Tcvcache;
-    perl_thread        self;                   /* Underlying thread object */
-    U32                flags;
-    perl_mutex mutex;                  /* For the fields others can change */
-    U32                tid;
-    struct thread *next, *prev;                /* Circular linked list of threads */
+#define UNLOCK_STRTAB_MUTEX                    \
+    STMT_START {                               \
+       if (PL_threadnum)                       \
+           MUTEX_UNLOCK(&PL_strtab_mutex);     \
+    } STMT_END
 
-#ifdef ADD_THREAD_INTERN
-    struct thread_intern i;            /* Platform-dependent internals */
-#endif
-    char       trailing_nul;           /* For the sake of thrsv, t->Toursv */
-};
+#ifndef THREAD_RET_TYPE
+#  define THREAD_RET_TYPE      void *
+#  define THREAD_RET_CAST(p)   ((void *)(p))
+#endif /* THREAD_RET */
 
-typedef struct thread *Thread;
 
 /* Values and macros for thr->flags */
 #define THRf_STATE_MASK        7
@@ -223,14 +192,14 @@ typedef struct thread *Thread;
 #define THRf_ZOMBIE    3
 #define THRf_DEAD      4
 
-#define THRf_DIE_FATAL 8
+#define THRf_DID_DIE   8
 
 /* ThrSTATE(t) and ThrSETSTATE(t) must only be called while holding t->mutex */
-#define ThrSTATE(t) ((t)->flags)
+#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(),  \
+       DEBUG_S(PerlIO_printf(PerlIO_stderr(),  \
                              "thread %p set to state %d\n", (t), (s))); \
     } STMT_END
 
@@ -246,102 +215,6 @@ 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 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 defstash
-#undef curstash
-#undef tmps_stack
-#undef tmps_floor
-#undef tmps_ix
-#undef tmps_max
-#undef curpad
-#undef Sv
-#undef Xpv
-#undef statbuf
-#undef timesbuf
-#undef top_env
-#undef runlevel
-#undef in_eval
-#undef restartop
-#undef delaymagic
-#undef dirty
-#undef localizing
-
-#define oursv          (thr->Toursv)
-#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 curstack       (thr->Tcurstack)
-#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 statbuf                (thr->Tstatbuf)
-#define timesbuf       (thr->Ttimesbuf)
-#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        cvcache         (thr->Tcvcache)
 #else
 /* USE_THREADS is not defined */
 #define MUTEX_LOCK(m)
@@ -353,8 +226,16 @@ typedef struct condpair {
 #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 */