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 1312b30..d03cef1 100644 (file)
--- a/thread.h
+++ b/thread.h
@@ -1,4 +1,4 @@
-#ifdef USE_THREADS
+#if defined(USE_THREADS) || defined(USE_ITHREADS)
 
 #ifdef WIN32
 #  include <win32thread.h>
@@ -8,11 +8,11 @@
     STMT_START {                               \
        if (pthread_detach(&(t)->self)) {       \
            MUTEX_UNLOCK(&(t)->mutex);          \
-           croak("panic: DETACH");             \
+           Perl_croak(aTHX_ "panic: DETACH");          \
        }                                       \
     } STMT_END
 #    define THR getTHR()
-struct perl_thread *getTHR _((void));
+struct perl_thread *getTHR (void);
 #    define PTHREAD_GETSPECIFIC_INT
 #    ifdef DJGPP
 #      define pthread_addr_t any_t
@@ -35,10 +35,8 @@ struct perl_thread *getTHR _((void));
 #      define YIELD pthread_yield(NULL)
 #    endif
 #  endif
-#  ifndef VMS
 #    define pthread_mutexattr_default NULL
 #    define pthread_condattr_default  NULL
-#  endif
 #endif
 
 #ifndef PTHREAD_CREATE
@@ -50,6 +48,14 @@ struct perl_thread *getTHR _((void));
 #  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 */
@@ -62,12 +68,14 @@ struct perl_thread *getTHR _((void));
                if (*m) {                               \
                        mutex_init(*m);                 \
                } else {                                \
-                       croak("panic: MUTEX_INIT");     \
+                       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);                         \
@@ -80,7 +88,7 @@ struct perl_thread *getTHR _((void));
                if (*c) {                               \
                        condition_init(*c);             \
                } else {                                \
-                       croak("panic: COND_INIT");      \
+                       Perl_croak(aTHX_ "panic: COND_INIT");   \
                }                                       \
        } STMT_END
 
@@ -103,7 +111,7 @@ struct perl_thread *getTHR _((void));
 #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 THR                    ((struct perl_thread *)cthread_data(cthread_self()))
 
 #define INIT_THREADS           cthread_init()
 #define YIELD                  cthread_yield()
@@ -128,26 +136,50 @@ struct perl_thread *getTHR _((void));
 #  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 */
 
@@ -155,27 +187,27 @@ struct perl_thread *getTHR _((void));
 #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 */
 
@@ -185,7 +217,7 @@ struct perl_thread *getTHR _((void));
     STMT_START {                               \
        if (pthread_detach((t)->self)) {        \
            MUTEX_UNLOCK(&(t)->mutex);          \
-           croak("panic: DETACH");             \
+           Perl_croak(aTHX_ "panic: DETACH");          \
        }                                       \
     } STMT_END
 #endif /* DETACH */
@@ -194,7 +226,7 @@ struct perl_thread *getTHR _((void));
 #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 */
 
@@ -202,72 +234,58 @@ struct perl_thread *getTHR _((void));
 #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
-#define THR ((struct perl_thread *) pthread_getspecific(PL_thr_key))
+#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
  * 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 */
+#  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 */
@@ -285,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
 
@@ -301,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