This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
avoid leaking lexicals into program being debugged (from Ilya
[perl5.git] / thread.h
index 22373e6..d03cef1 100644 (file)
--- a/thread.h
+++ b/thread.h
-#ifdef USE_THREADS
+#if defined(USE_THREADS) || defined(USE_ITHREADS)
 
 #ifdef WIN32
 #  include <win32thread.h>
 #else
-/* XXX What we really need is Configure probing for all of these
- * pthread thingies, old, medium, and new, not the blanket statement of
- * OLD_PTHREADS_API. --jhi */
-#  if defined(OLD_PTHREADS_API) && !defined(DJGPP) && !defined(__OPEN_VM) && !defined(OEMVS)
-     /* 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))
+#  ifdef OLD_PTHREADS_API /* Here be dragons. */
 #    define DETACH(t)                          \
     STMT_START {                               \
        if (pthread_detach(&(t)->self)) {       \
            MUTEX_UNLOCK(&(t)->mutex);          \
-           croak("panic: DETACH");             \
+           Perl_croak(aTHX_ "panic: DETACH");          \
        }                                       \
     } STMT_END
-#  else
+#    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 /* OLD_PTHREADS_API */
+#    define pthread_condattr_default  NULL
+#endif
+
+#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
+
+#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
+
+#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_LOCK_NOCONTEXT(m)        mutex_lock(*m)
+#define MUTEX_UNLOCK(m)                mutex_unlock(*m)
+#define MUTEX_UNLOCK_NOCONTEXT(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                    ((struct perl_thread *)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
 #  endif
 #endif
 
-#ifdef PTHREADS_CREATED_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
+#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
 #define MUTEX_INIT(m)                                          \
     STMT_START {                                               \
        if (pthread_mutex_init((m), pthread_mutexattr_default)) \
-           croak("panic: MUTEX_INIT");                         \
+           Perl_croak(aTHX_ "panic: MUTEX_INIT");                              \
     } STMT_END
+#endif
 #define MUTEX_LOCK(m)                          \
     STMT_START {                               \
        if (pthread_mutex_lock((m)))            \
-           croak("panic: MUTEX_LOCK");         \
+           Perl_croak(aTHX_ "panic: MUTEX_LOCK");              \
     } STMT_END
 #define MUTEX_UNLOCK(m)                                \
     STMT_START {                               \
        if (pthread_mutex_unlock((m)))          \
-           croak("panic: MUTEX_UNLOCK");       \
+           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)))         \
-           croak("panic: MUTEX_DESTROY");      \
+           Perl_croak(aTHX_ "panic: MUTEX_DESTROY");   \
     } STMT_END
 #endif /* MUTEX_INIT */
 
 #define COND_INIT(c)                                           \
     STMT_START {                                               \
        if (pthread_cond_init((c), pthread_condattr_default))   \
-           croak("panic: COND_INIT");                          \
+           Perl_croak(aTHX_ "panic: COND_INIT");                               \
     } STMT_END
 #define COND_SIGNAL(c)                         \
     STMT_START {                               \
        if (pthread_cond_signal((c)))           \
-           croak("panic: COND_SIGNAL");        \
+           Perl_croak(aTHX_ "panic: COND_SIGNAL");     \
     } STMT_END
 #define COND_BROADCAST(c)                      \
     STMT_START {                               \
        if (pthread_cond_broadcast((c)))        \
-           croak("panic: COND_BROADCAST");     \
+           Perl_croak(aTHX_ "panic: COND_BROADCAST");  \
     } STMT_END
 #define COND_WAIT(c, m)                                \
     STMT_START {                               \
        if (pthread_cond_wait((c), (m)))        \
-           croak("panic: COND_WAIT");          \
+           Perl_croak(aTHX_ "panic: COND_WAIT");               \
     } STMT_END
 #define COND_DESTROY(c)                                \
     STMT_START {                               \
        if (pthread_cond_destroy((c)))          \
-           croak("panic: COND_DESTROY");       \
+           Perl_croak(aTHX_ "panic: COND_DESTROY");    \
     } STMT_END
 #endif /* COND_INIT */
 
     STMT_START {                               \
        if (pthread_detach((t)->self)) {        \
            MUTEX_UNLOCK(&(t)->mutex);          \
-           croak("panic: DETACH");             \
+           Perl_croak(aTHX_ "panic: DETACH");          \
        }                                       \
     } STMT_END
 #endif /* DETACH */
 #define JOIN(t, avp)                                   \
     STMT_START {                                       \
        if (pthread_join((t)->self, (void**)(avp)))     \
-           croak("panic: pthread_join");               \
+           Perl_croak(aTHX_ "panic: pthread_join");            \
     } STMT_END
 #endif /* JOIN */
 
 #define SET_THR(t)                                     \
     STMT_START {                                       \
        if (pthread_setspecific(PL_thr_key, (void *) (t)))      \
-           croak("panic: pthread_setspecific");        \
+           Perl_croak(aTHX_ "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 */
+#ifndef INIT_THREADS
+#  ifdef NEED_PTHREAD_INIT
+#    define INIT_THREADS pthread_init()
+#  endif
+#endif
+
+#ifndef THREAD_RET_TYPE
+#  define THREAD_RET_TYPE      void *
+#  define THREAD_RET_CAST(p)   ((void *)(p))
+#endif /* THREAD_RET */
+
+#if defined(USE_THREADS)
 
 /*
  * dTHR is performance-critical. Here, we only do the pthread_get_specific
@@ -145,58 +257,35 @@ struct perl_thread *getTHR _((void));
  * 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 */
+#  if !defined(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
+#  if !defined(THR)
+#    define THR ((struct perl_thread *) pthread_getspecific(PL_thr_key))
 #  endif
-#endif
+
 
 /* Accessor for per-thread SVs */
-#define THREADSV(i) (thr->threadsvp[i])
+#  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 {                               \
-       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 */
+#  define LOCK_SV_MUTEX                MUTEX_LOCK(&PL_sv_mutex)
+#  define UNLOCK_SV_MUTEX      MUTEX_UNLOCK(&PL_sv_mutex)
+#  define LOCK_STRTAB_MUTEX    MUTEX_LOCK(&PL_strtab_mutex)
+#  define UNLOCK_STRTAB_MUTEX  MUTEX_UNLOCK(&PL_strtab_mutex)
+#  define LOCK_CRED_MUTEX      MUTEX_LOCK(&PL_cred_mutex)
+#  define UNLOCK_CRED_MUTEX    MUTEX_UNLOCK(&PL_cred_mutex)
 
 
 /* Values and macros for thr->flags */
@@ -214,7 +303,7 @@ struct perl_thread *getTHR _((void));
 #define ThrSETSTATE(t, s) STMT_START {         \
        (t)->flags &= ~THRf_STATE_MASK;         \
        (t)->flags |= (s);                      \
-       DEBUG_S(PerlIO_printf(PerlIO_stderr(),  \
+       DEBUG_S(PerlIO_printf(Perl_debug_log,   \
                              "thread %p set to state %d\n", (t), (s))); \
     } STMT_END
 
@@ -230,27 +319,85 @@ typedef struct condpair {
 #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 */
+#endif /* USE_THREADS || USE_ITHREADS */
+
+#ifndef MUTEX_LOCK
+#  define MUTEX_LOCK(m)
+#endif
+
+#ifndef MUTEX_LOCK_NOCONTEXT
+#  define MUTEX_LOCK_NOCONTEXT(m)
+#endif
+
+#ifndef MUTEX_UNLOCK
+#  define MUTEX_UNLOCK(m)
+#endif
+
+#ifndef MUTEX_UNLOCK_NOCONTEXT
+#  define MUTEX_UNLOCK_NOCONTEXT(m)
+#endif
+
+#ifndef MUTEX_INIT
+#  define MUTEX_INIT(m)
+#endif
+
+#ifndef MUTEX_DESTROY
+#  define MUTEX_DESTROY(m)
+#endif
+
+#ifndef COND_INIT
+#  define COND_INIT(c)
+#endif
+
+#ifndef COND_SIGNAL
+#  define COND_SIGNAL(c)
+#endif
+
+#ifndef COND_BROADCAST
+#  define COND_BROADCAST(c)
+#endif
+
+#ifndef COND_WAIT
+#  define COND_WAIT(c, m)
+#endif
+
+#ifndef COND_DESTROY
+#  define COND_DESTROY(c)
+#endif
+
+#ifndef LOCK_SV_MUTEX
+#  define LOCK_SV_MUTEX
+#endif
+
+#ifndef UNLOCK_SV_MUTEX
+#  define UNLOCK_SV_MUTEX
+#endif
+
+#ifndef LOCK_STRTAB_MUTEX
+#  define LOCK_STRTAB_MUTEX
+#endif
+
+#ifndef UNLOCK_STRTAB_MUTEX
+#  define UNLOCK_STRTAB_MUTEX
+#endif
+
+#ifndef LOCK_CRED_MUTEX
+#  define LOCK_CRED_MUTEX
+#endif
+
+#ifndef UNLOCK_CRED_MUTEX
+#  define UNLOCK_CRED_MUTEX
+#endif
+
+#ifndef THR
+#  define THR
+#endif
+
+#ifndef dTHR
+#  define dTHR dNOOP
+#endif
+
+#ifndef INIT_THREADS
+#  define INIT_THREADS NOOP
+#endif