[perl5.git] / thread.h

/*    thread.h
 *
 *    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
 *    by Larry Wall and others
 *
 *    You may distribute under the terms of either the GNU General Public
 *    License or the Artistic License, as specified in the README file.
 *
 */

#if defined(USE_ITHREADS)

#if defined(VMS)
#include <builtins.h>
#endif

#ifdef WIN32
#  include <win32thread.h>
#else
#  ifdef OLD_PTHREADS_API /* Here be dragons. */
#    define DETACH(t) \
    STMT_START {						\
        int _eC_;						\
        if ((_eC_ = pthread_detach(&(t)->self))) {		\
            MUTEX_UNLOCK(&(t)->mutex);				\
            Perl_croak_nocontext("panic: DETACH (%d) [%s:%d]",	\
                                 _eC_, __FILE__, __LINE__);	\
        }							\
    } STMT_END

#    define PERL_GET_CONTEXT	Perl_get_context()
#    define PERL_SET_CONTEXT(t)	Perl_set_context((void*)t)

#    define PTHREAD_GETSPECIFIC_INT
#    ifdef OEMVS
#      define pthread_addr_t void *
#      define pthread_create(t,a,s,d)        pthread_create(t,&(a),s,d)
#      define pthread_keycreate              pthread_key_create
#    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(__hpux) && defined(__ux_version) && __ux_version <= 1020
#      define pthread_attr_init(a) pthread_attr_create(a)
       /* XXX pthread_setdetach_np() missing in DCE threads on HP-UX 10.20 */
#      define PTHREAD_ATTR_SETDETACHSTATE(a,s)	(0)
#      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(OEMVS)
#      define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_attr_setdetachstate(a,&(s))
#      define YIELD pthread_yield(NULL)
#    endif
#  endif
#  if !defined(__hpux) || !defined(__ux_version) || __ux_version > 1020
#    define pthread_mutexattr_default NULL
#    define pthread_condattr_default  NULL
#  endif
#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 __VMS
  /* Default is 1024 on VAX, 8192 otherwise */
#  ifdef __ia64
#    define THREAD_CREATE_NEEDS_STACK (48*1024)
#  else
#    define THREAD_CREATE_NEEDS_STACK (32*1024)
#  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_nocontext("panic: MUTEX_INIT [%s:%d]",	\
                                 __FILE__, __LINE__);		\
        }							\
    } 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_nocontext("panic: COND_INIT [%s:%d]",	\
                                 __FILE__, __LINE__);		\
        }							\
    } 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_RET_TYPE		any_t

#define DETACH(t)		cthread_detach(t->self)
#define JOIN(t, avp)		(*(avp) = MUTABLE_AV(cthread_join(t->self)))

#define PERL_SET_CONTEXT(t)	cthread_set_data(cthread_self(), t)
#define PERL_GET_CONTEXT	cthread_data(cthread_self())

#define INIT_THREADS		cthread_init()
#define YIELD			cthread_yield()
#define ALLOC_THREAD_KEY	NOOP
#define FREE_THREAD_KEY		NOOP
#define SET_THREAD_SELF(thr)	(thr->self = cthread_self())

#endif /* I_MACH_CTHREADS */

#ifndef YIELD
#  ifdef SCHED_YIELD
#    define YIELD SCHED_YIELD
#  elif defined(HAS_SCHED_YIELD)
#    define YIELD sched_yield()
#  elif defined(HAS_PTHREAD_YIELD)
    /* pthread_yield(NULL) platforms are expected
     * to have #defined YIELD for themselves. */
#    define YIELD pthread_yield()
#  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 {						\
        int _eC_;						\
        Zero((m), 1, perl_mutex);                               \
        if ((_eC_ = pthread_mutex_init((m), pthread_mutexattr_default)))	\
            Perl_croak_nocontext("panic: MUTEX_INIT (%d) [%s:%d]",	\
                                 _eC_, __FILE__, __LINE__);	\
    } STMT_END
#  else
#    define MUTEX_INIT(m) \
    STMT_START {						\
        int _eC_;						\
        if ((_eC_ = pthread_mutex_init((m), pthread_mutexattr_default)))	\
            Perl_croak_nocontext("panic: MUTEX_INIT (%d) [%s:%d]",	\
                                 _eC_, __FILE__, __LINE__);	\
    } STMT_END
#  endif

#  ifdef PERL_TSA_ACTIVE
#    define perl_pthread_mutex_lock(m) perl_tsa_mutex_lock(m)
#    define perl_pthread_mutex_unlock(m) perl_tsa_mutex_unlock(m)
#  else
#    define perl_pthread_mutex_lock(m) pthread_mutex_lock(m)
#    define perl_pthread_mutex_unlock(m) pthread_mutex_unlock(m)
#  endif

#  define MUTEX_LOCK(m) \
    STMT_START {						\
        int _eC_;						\
        if ((_eC_ = perl_pthread_mutex_lock((m))))			\
            Perl_croak_nocontext("panic: MUTEX_LOCK (%d) [%s:%d]",	\
                                 _eC_, __FILE__, __LINE__);	\
    } STMT_END

#  define MUTEX_UNLOCK(m) \
    STMT_START {						\
        int _eC_;						\
        if ((_eC_ = perl_pthread_mutex_unlock((m))))			\
            Perl_croak_nocontext("panic: MUTEX_UNLOCK (%d) [%s:%d]",	\
                                 _eC_, __FILE__, __LINE__);	\
    } STMT_END

#  define MUTEX_DESTROY(m) \
    STMT_START {						\
        int _eC_;						\
        if ((_eC_ = pthread_mutex_destroy((m))))		\
            Perl_croak_nocontext("panic: MUTEX_DESTROY (%d) [%s:%d]",	\
                                 _eC_, __FILE__, __LINE__);	\
    } STMT_END
#endif /* MUTEX_INIT */

#ifndef COND_INIT
#  define COND_INIT(c) \
    STMT_START {						\
        int _eC_;						\
        if ((_eC_ = pthread_cond_init((c), pthread_condattr_default)))	\
            Perl_croak_nocontext("panic: COND_INIT (%d) [%s:%d]",	\
                                 _eC_, __FILE__, __LINE__);	\
    } STMT_END

#  define COND_SIGNAL(c) \
    STMT_START {						\
        int _eC_;						\
        if ((_eC_ = pthread_cond_signal((c))))			\
            Perl_croak_nocontext("panic: COND_SIGNAL (%d) [%s:%d]",	\
                                 _eC_, __FILE__, __LINE__);	\
    } STMT_END

#  define COND_BROADCAST(c) \
    STMT_START {						\
        int _eC_;						\
        if ((_eC_ = pthread_cond_broadcast((c))))		\
            Perl_croak_nocontext("panic: COND_BROADCAST (%d) [%s:%d]",	\
                                 _eC_, __FILE__, __LINE__);	\
    } STMT_END

#  define COND_WAIT(c, m) \
    STMT_START {						\
        int _eC_;						\
        if ((_eC_ = pthread_cond_wait((c), (m))))		\
            Perl_croak_nocontext("panic: COND_WAIT (%d) [%s:%d]",	\
                                 _eC_, __FILE__, __LINE__);	\
    } STMT_END

#  define COND_DESTROY(c) \
    STMT_START {						\
        int _eC_;						\
        if ((_eC_ = pthread_cond_destroy((c))))			\
            Perl_croak_nocontext("panic: COND_DESTROY (%d) [%s:%d]",	\
                                 _eC_, __FILE__, __LINE__);	\
    } STMT_END
#endif /* COND_INIT */

#if defined(MUTEX_LOCK) && defined(MUTEX_UNLOCK)                \
 && defined(COND_SIGNAL) && defined(COND_WAIT)

/* These emulate native many-reader/1-writer locks.
 * Basically a locking reader just locks the semaphore long enough to increment
 * a counter; and similarly decrements it when when through.  Any writer will
 * run only when the count of readers is 0.  That is because it blocks on that
 * semaphore (doing a COND_WAIT) until it gets control of it, which won't
 * happen unless the count becomes 0.  ALL readers and other writers are then
 * blocked until it releases the semaphore.  The reader whose unlocking causes
 * the count to become 0 signals any waiting writers, and the system guarantees
 * that only one gets control at a time */

#  define PERL_READ_LOCK(mutex)                                     \
    STMT_START {                                                    \
        MUTEX_LOCK(&(mutex)->lock);                                 \
        (mutex)->readers_count++;                                   \
        MUTEX_UNLOCK(&(mutex)->lock);                               \
    } STMT_END

#  define PERL_READ_UNLOCK(mutex)                                   \
    STMT_START {                                                    \
        MUTEX_LOCK(&(mutex)->lock);                                 \
        (mutex)->readers_count--;                                   \
        if ((mutex)->readers_count <= 0) {                          \
            assert((mutex)->readers_count == 0);                    \
            COND_SIGNAL(&(mutex)->wakeup);                          \
            (mutex)->readers_count = 0;                             \
        }                                                           \
        MUTEX_UNLOCK(&(mutex)->lock);                               \
    } STMT_END

#  define PERL_WRITE_LOCK(mutex)                                    \
    STMT_START {                                                    \
        MUTEX_LOCK(&(mutex)->lock);                                 \
        do {                                                        \
            if ((mutex)->readers_count <= 0) {                      \
                assert((mutex)->readers_count == 0);                \
                (mutex)->readers_count = 0;                         \
                break;                                              \
            }                                                       \
            COND_WAIT(&(mutex)->wakeup, &(mutex)->lock);            \
        }                                                           \
        while (1);                                                  \
                                                                    \
        /* Here, the mutex is locked, with no readers */            \
    } STMT_END

#  define PERL_WRITE_UNLOCK(mutex)                                  \
    STMT_START {                                                    \
        COND_SIGNAL(&(mutex)->wakeup);                              \
        MUTEX_UNLOCK(&(mutex)->lock);                               \
    } STMT_END

#  define PERL_RW_MUTEX_INIT(mutex)                                 \
    STMT_START {                                                    \
        MUTEX_INIT(&(mutex)->lock);                                 \
        COND_INIT(&(mutex)->wakeup);                                \
        (mutex)->readers_count = 0;                                 \
    } STMT_END

#  define PERL_RW_MUTEX_DESTROY(mutex)                              \
    STMT_START {                                                    \
        COND_DESTROY(&(mutex)->wakeup);                             \
        MUTEX_DESTROY(&(mutex)->lock);                              \
    } STMT_END

#endif

/* DETACH(t) must only be called while holding t->mutex */
#ifndef DETACH
#  define DETACH(t) \
    STMT_START {						\
        int _eC_;						\
        if ((_eC_ = pthread_detach((t)->self))) {		\
            MUTEX_UNLOCK(&(t)->mutex);				\
            Perl_croak_nocontext("panic: DETACH (%d) [%s:%d]",	\
                                 _eC_, __FILE__, __LINE__);	\
        }							\
    } STMT_END
#endif /* DETACH */

#ifndef JOIN
#  define JOIN(t, avp) \
    STMT_START {						\
        int _eC_;						\
        if ((_eC_ = pthread_join((t)->self, (void**)(avp))))	\
            Perl_croak_nocontext("panic: pthread_join (%d) [%s:%d]",	\
                                 _eC_, __FILE__, __LINE__);	\
    } STMT_END
#endif /* JOIN */

/* Use an unchecked fetch of thread-specific data instead of a checked one.
 * It would fail if the key were bogus, but if the key were bogus then
 * Really Bad Things would be happening anyway. --dan */
#if (defined(__ALPHA) && (__VMS_VER >= 70000000)) || \
    (defined(__alpha) && defined(__osf__) && !defined(__GNUC__)) /* Available only on >= 4.0 */
#  define HAS_PTHREAD_UNCHECKED_GETSPECIFIC_NP /* Configure test needed */
#endif

#ifdef HAS_PTHREAD_UNCHECKED_GETSPECIFIC_NP
#  define PTHREAD_GETSPECIFIC(key) pthread_unchecked_getspecific_np(key)
#else
#    define PTHREAD_GETSPECIFIC(key) pthread_getspecific(key)
#endif

#if defined(PERL_THREAD_LOCAL) && !defined(PERL_GET_CONTEXT) && !defined(PERL_SET_CONTEXT) && !defined(__cplusplus)
/* Use C11 thread-local storage, where possible.
 * Frustratingly we can't use it for C++ extensions, C++ and C disagree on the
 * syntax used for thread local storage, meaning that the working token that
 * Configure probed for C turns out to be a compiler error on C++. Great.
 * (Well, unless one or both is supporting non-standard syntax as an extension)
 * As Configure doesn't have a way to probe for C++ dialects, we just take the
 * safe option and do the same as 5.34.0 and earlier - use pthreads on C++.
 * Of course, if C++ XS extensions really want to avoid *all* this overhead,
 * they should #define PERL_NO_GET_CONTEXT and pass aTHX/aTHX_ explicitly) */
#  define PERL_USE_THREAD_LOCAL
extern PERL_THREAD_LOCAL void *PL_current_context;

#  define PERL_GET_CONTEXT        PL_current_context

/* We must also call pthread_setspecific() always, as C++ code has to read it
 * with pthreads (the #else side just below) */

#  define PERL_SET_CONTEXT(t)                                           \
    STMT_START {                                                        \
        int _eC_;                                                       \
        if ((_eC_ = pthread_setspecific(PL_thr_key, PL_current_context = (void *)(t)))) \
            Perl_croak_nocontext("panic: pthread_setspecific (%d) [%s:%d]", \
                                 _eC_, __FILE__, __LINE__);             \
    } STMT_END

#else
/* else fall back to pthreads */

#  ifndef PERL_GET_CONTEXT
#    define PERL_GET_CONTEXT	PTHREAD_GETSPECIFIC(PL_thr_key)
#  endif

/* For C++ extensions built on a system where the C compiler provides thread
 * local storage that call PERL_SET_CONTEXT() also need to set
 * PL_current_context, so need to call into C code to do this.
 * To avoid exploding code complexity, do this also on C platforms that don't
 * support thread local storage. PERL_SET_CONTEXT is not called that often. */

#  ifndef PERL_SET_CONTEXT
#    define PERL_SET_CONTEXT(t) Perl_set_context((void*)t)
#  endif /* PERL_SET_CONTEXT */
#endif /* PERL_THREAD_LOCAL */

#ifndef INIT_THREADS
#  ifdef NEED_PTHREAD_INIT
#    define INIT_THREADS pthread_init()
#  endif
#endif

#ifndef ALLOC_THREAD_KEY
#  define ALLOC_THREAD_KEY \
    STMT_START {						\
        if (pthread_key_create(&PL_thr_key, 0)) {		\
            PERL_UNUSED_RESULT(write(2, STR_WITH_LEN("panic: pthread_key_create failed\n"))); \
            exit(1);						\
        }							\
    } STMT_END
#endif

#ifndef FREE_THREAD_KEY
#  define FREE_THREAD_KEY \
    STMT_START {						\
        pthread_key_delete(PL_thr_key);				\
    } STMT_END
#endif

#ifndef PTHREAD_ATFORK
#  ifdef HAS_PTHREAD_ATFORK
#    define PTHREAD_ATFORK(prepare,parent,child)		\
        pthread_atfork(prepare,parent,child)
#  else
#    define PTHREAD_ATFORK(prepare,parent,child)		\
        NOOP
#  endif
#endif

#ifndef THREAD_RET_TYPE
#  define THREAD_RET_TYPE	void *
#endif /* THREAD_RET */

#  define LOCK_DOLLARZERO_MUTEX		MUTEX_LOCK(&PL_dollarzero_mutex)
#  define UNLOCK_DOLLARZERO_MUTEX	MUTEX_UNLOCK(&PL_dollarzero_mutex)

#endif /* USE_ITHREADS */

#ifndef MUTEX_LOCK
#  define MUTEX_LOCK(m)           NOOP
#endif

#ifndef MUTEX_UNLOCK
#  define MUTEX_UNLOCK(m)         NOOP
#endif

#ifndef MUTEX_INIT
#  define MUTEX_INIT(m)           NOOP
#endif

#ifndef MUTEX_DESTROY
#  define MUTEX_DESTROY(m)        NOOP
#endif

#ifndef COND_INIT
#  define COND_INIT(c)            NOOP
#endif

#ifndef COND_SIGNAL
#  define COND_SIGNAL(c)          NOOP
#endif

#ifndef COND_BROADCAST
#  define COND_BROADCAST(c)       NOOP
#endif

#ifndef COND_WAIT
#  define COND_WAIT(c, m)         NOOP
#endif

#ifndef COND_DESTROY
#  define COND_DESTROY(c)         NOOP
#endif

#ifndef PERL_READ_LOCK
#  define PERL_READ_LOCK          NOOP
#  define PERL_READ_UNLOCK        NOOP
#  define PERL_WRITE_LOCK         NOOP
#  define PERL_WRITE_UNLOCK       NOOP
#  define PERL_RW_MUTEX_INIT      NOOP
#  define PERL_RW_MUTEX_DESTROY   NOOP
#endif

#ifndef LOCK_DOLLARZERO_MUTEX
#  define LOCK_DOLLARZERO_MUTEX   NOOP
#endif

#ifndef UNLOCK_DOLLARZERO_MUTEX
#  define UNLOCK_DOLLARZERO_MUTEX NOOP
#endif

/* THR, SET_THR, and dTHR are there for compatibility with old versions */
#ifndef THR
#  define THR		PERL_GET_THX
#endif

#ifndef SET_THR
#  define SET_THR(t)	PERL_SET_THX(t)
#endif

#ifndef dTHR
#  define dTHR dNOOP
#endif

#ifndef INIT_THREADS
#  define INIT_THREADS NOOP
#endif

/*
 * ex: set ts=8 sts=4 sw=4 et:
 */
Commit	Line	Data
d6376244 JH	1	/* thread.h
d6376244 JH	2	*
54ca4ee7	3	* Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
1d325971	4	* by Larry Wall and others
d6376244 JH	5	*
	6	* You may distribute under the terms of either the GNU General Public
	7	* License or the Artistic License, as specified in the README file.
	8	*
	9	*/
	10
3db8f154	11	#if defined(USE_ITHREADS)
12ca11f6	12
fd8cd3a3 DS	13	#if defined(VMS)
	14	#include <builtins.h>
	15	#endif
	16
ea0efc06	17	#ifdef WIN32
d55594ae	18	# include <win32thread.h>
2986a63f	19	#else
0d85d877	20	# ifdef OLD_PTHREADS_API /* Here be dragons. */
ba869deb GS	21	# define DETACH(t) \
ba869deb GS	22	STMT_START { \
1604cfb0 MS	23	int _eC_; \
	24	if ((_eC_ = pthread_detach(&(t)->self))) { \
	25	MUTEX_UNLOCK(&(t)->mutex); \
	26	Perl_croak_nocontext("panic: DETACH (%d) [%s:%d]", \
	27	_eC_, __FILE__, __LINE__); \
	28	} \
ea0efc06	29	} STMT_END
ba869deb GS	30
	31	# define PERL_GET_CONTEXT Perl_get_context()
	32	# define PERL_SET_CONTEXT(t) Perl_set_context((void*)t)
	33
0d85d877	34	# define PTHREAD_GETSPECIFIC_INT
20b634c2 JH	35	# ifdef OEMVS
20b634c2 JH	36	# define pthread_addr_t void *
20b634c2 JH	37	# define pthread_create(t,a,s,d) pthread_create(t,&(a),s,d)
	38	# define pthread_keycreate pthread_key_create
	39	# endif
0d85d877 JH	40	# ifdef VMS
	41	# define pthread_attr_init(a) pthread_attr_create(a)
	42	# define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_setdetach_np(a,s)
6dc3770d	43	# define PTHREAD_CREATE(t,a,s,d) pthread_create(t,a,s,d)
0d85d877 JH	44	# define pthread_key_create(k,d) pthread_keycreate(k,(pthread_destructor_t)(d))
0d85d877 JH	45	# define pthread_mutexattr_init(a) pthread_mutexattr_create(a)
9bbd4fab	46	# define pthread_mutexattr_settype(a,t) pthread_mutexattr_setkind_np(a,t)
0d85d877	47	# endif
2eb25c99 JH	48	# if defined(__hpux) && defined(__ux_version) && __ux_version <= 1020
	49	# define pthread_attr_init(a) pthread_attr_create(a)
	50	/* XXX pthread_setdetach_np() missing in DCE threads on HP-UX 10.20 */
10617789	51	# define PTHREAD_ATTR_SETDETACHSTATE(a,s) (0)
2eb25c99 JH	52	# define PTHREAD_CREATE(t,a,s,d) pthread_create(t,a,s,d)
	53	# define pthread_key_create(k,d) pthread_keycreate(k,(pthread_destructor_t)(d))
	54	# define pthread_mutexattr_init(a) pthread_mutexattr_create(a)
	55	# define pthread_mutexattr_settype(a,t) pthread_mutexattr_setkind_np(a,t)
	56	# endif
4457f3fc	57	# if defined(OEMVS)
0d85d877 JH	58	# define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_attr_setdetachstate(a,&(s))
	59	# define YIELD pthread_yield(NULL)
	60	# endif
0d85d877	61	# endif
2eb25c99	62	# if !defined(__hpux) \|\| !defined(__ux_version) \|\| __ux_version > 1020
1cfa4ec7	63	# define pthread_mutexattr_default NULL
0d85d877	64	# define pthread_condattr_default NULL
2eb25c99	65	# endif
0d85d877 JH	66	#endif
	67
	68	#ifndef PTHREAD_CREATE
	69	/* You are not supposed to pass NULL as the 2nd arg of PTHREAD_CREATE(). */
	70	# define PTHREAD_CREATE(t,a,s,d) pthread_create(t,&(a),s,d)
	71	#endif
	72
	73	#ifndef PTHREAD_ATTR_SETDETACHSTATE
	74	# define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_attr_setdetachstate(a,s)
d55594ae	75	#endif
1cfa4ec7	76
ef4af2be JH	77	#ifndef PTHREAD_CREATE_JOINABLE
	78	# ifdef OLD_PTHREAD_CREATE_JOINABLE
	79	# define PTHREAD_CREATE_JOINABLE OLD_PTHREAD_CREATE_JOINABLE
	80	# else
	81	# define PTHREAD_CREATE_JOINABLE 0 /* Panic? No, guess. */
	82	# endif
	83	#endif
	84
93a09687 JM	85	#ifdef __VMS
93a09687 JM	86	/* Default is 1024 on VAX, 8192 otherwise */
3319632a CB	87	# ifdef __ia64
	88	# define THREAD_CREATE_NEEDS_STACK (48*1024)
	89	# else
	90	# define THREAD_CREATE_NEEDS_STACK (32*1024)
	91	# endif
93a09687 JM	92	#endif
93a09687 JM	93
7f3d1cf1 BH	94	#ifdef I_MACH_CTHREADS
	95
	96	/* cthreads interface */
	97
	98	/* #include <mach/cthreads.h> is in perl.h #ifdef I_MACH_CTHREADS */
	99
ba869deb GS	100	#define MUTEX_INIT(m) \
ba869deb GS	101	STMT_START { \
1604cfb0 MS	102	*m = mutex_alloc(); \
	103	if (*m) { \
	104	mutex_init(*m); \
	105	} else { \
	106	Perl_croak_nocontext("panic: MUTEX_INIT [%s:%d]", \
	107	__FILE__, __LINE__); \
	108	} \
ba869deb GS	109	} STMT_END
	110
	111	#define MUTEX_LOCK(m) mutex_lock(*m)
ba869deb	112	#define MUTEX_UNLOCK(m) mutex_unlock(*m)
ba869deb GS	113	#define MUTEX_DESTROY(m) \
ba869deb GS	114	STMT_START { \
1604cfb0 MS	115	mutex_free(*m); \
1604cfb0 MS	116	*m = 0; \
ba869deb GS	117	} STMT_END
	118
	119	#define COND_INIT(c) \
	120	STMT_START { \
1604cfb0 MS	121	*c = condition_alloc(); \
	122	if (*c) { \
	123	condition_init(*c); \
	124	} \
	125	else { \
	126	Perl_croak_nocontext("panic: COND_INIT [%s:%d]", \
	127	__FILE__, __LINE__); \
	128	} \
ba869deb	129	} STMT_END
7f3d1cf1 BH	130
	131	#define COND_SIGNAL(c) condition_signal(*c)
	132	#define COND_BROADCAST(c) condition_broadcast(*c)
	133	#define COND_WAIT(c, m) condition_wait(c, m)
ba869deb GS	134	#define COND_DESTROY(c) \
ba869deb GS	135	STMT_START { \
1604cfb0 MS	136	condition_free(*c); \
1604cfb0 MS	137	*c = 0; \
ba869deb	138	} STMT_END
7f3d1cf1	139
7f3d1cf1	140	#define THREAD_RET_TYPE any_t
7f3d1cf1 BH	141
7f3d1cf1 BH	142	#define DETACH(t) cthread_detach(t->self)
a062e10d	143	#define JOIN(t, avp) (*(avp) = MUTABLE_AV(cthread_join(t->self)))
7f3d1cf1	144
ba869deb GS	145	#define PERL_SET_CONTEXT(t) cthread_set_data(cthread_self(), t)
ba869deb GS	146	#define PERL_GET_CONTEXT cthread_data(cthread_self())
7f3d1cf1 BH	147
	148	#define INIT_THREADS cthread_init()
	149	#define YIELD cthread_yield()
ba869deb	150	#define ALLOC_THREAD_KEY NOOP
e1b5da64	151	#define FREE_THREAD_KEY NOOP
7f3d1cf1 BH	152	#define SET_THREAD_SELF(thr) (thr->self = cthread_self())
	153
	154	#endif /* I_MACH_CTHREADS */
	155
1cfa4ec7	156	#ifndef YIELD
e7a4f449 JH	157	# ifdef SCHED_YIELD
e7a4f449 JH	158	# define YIELD SCHED_YIELD
c2844c4f AC	159	# elif defined(HAS_SCHED_YIELD)
	160	# define YIELD sched_yield()
	161	# elif defined(HAS_PTHREAD_YIELD)
e7a4f449 JH	162	/* pthread_yield(NULL) platforms are expected
e7a4f449 JH	163	* to have #defined YIELD for themselves. */
c2844c4f	164	# define YIELD pthread_yield()
e7a4f449	165	# endif
9731c6ca	166	#endif
11343788	167
227c31c3 JH	168	#ifdef __hpux
	169	# define MUTEX_INIT_NEEDS_MUTEX_ZEROED
	170	#endif
	171
ea0efc06	172	#ifndef MUTEX_INIT
ba869deb GS	173
ba869deb GS	174	# ifdef MUTEX_INIT_NEEDS_MUTEX_ZEROED
227c31c3	175	/* Temporary workaround, true bug is deeper. --jhi 1999-02-25 */
ba869deb	176	# define MUTEX_INIT(m) \
227c31c3	177	STMT_START { \
1604cfb0 MS	178	int _eC_; \
	179	Zero((m), 1, perl_mutex); \
	180	if ((_eC_ = pthread_mutex_init((m), pthread_mutexattr_default))) \
	181	Perl_croak_nocontext("panic: MUTEX_INIT (%d) [%s:%d]", \
	182	_eC_, __FILE__, __LINE__); \
227c31c3	183	} STMT_END
ba869deb GS	184	# else
ba869deb GS	185	# define MUTEX_INIT(m) \
ea0efc06	186	STMT_START { \
1604cfb0 MS	187	int _eC_; \
	188	if ((_eC_ = pthread_mutex_init((m), pthread_mutexattr_default))) \
	189	Perl_croak_nocontext("panic: MUTEX_INIT (%d) [%s:%d]", \
	190	_eC_, __FILE__, __LINE__); \
ea0efc06	191	} STMT_END
ba869deb GS	192	# endif
ba869deb GS	193
3baee7cc JH	194	# ifdef PERL_TSA_ACTIVE
	195	# define perl_pthread_mutex_lock(m) perl_tsa_mutex_lock(m)
	196	# define perl_pthread_mutex_unlock(m) perl_tsa_mutex_unlock(m)
	197	# else
	198	# define perl_pthread_mutex_lock(m) pthread_mutex_lock(m)
	199	# define perl_pthread_mutex_unlock(m) pthread_mutex_unlock(m)
	200	# endif
	201
ba869deb GS	202	# define MUTEX_LOCK(m) \
ba869deb GS	203	STMT_START { \
1604cfb0 MS	204	int _eC_; \
	205	if ((_eC_ = perl_pthread_mutex_lock((m)))) \
	206	Perl_croak_nocontext("panic: MUTEX_LOCK (%d) [%s:%d]", \
	207	_eC_, __FILE__, __LINE__); \
cea2e8a9	208	} STMT_END
ba869deb	209
efc57feb	210	# define MUTEX_UNLOCK(m) \
ba869deb	211	STMT_START { \
1604cfb0 MS	212	int _eC_; \
	213	if ((_eC_ = perl_pthread_mutex_unlock((m)))) \
	214	Perl_croak_nocontext("panic: MUTEX_UNLOCK (%d) [%s:%d]", \
	215	_eC_, __FILE__, __LINE__); \
ea0efc06	216	} STMT_END
ba869deb GS	217
	218	# define MUTEX_DESTROY(m) \
	219	STMT_START { \
1604cfb0 MS	220	int _eC_; \
	221	if ((_eC_ = pthread_mutex_destroy((m)))) \
	222	Perl_croak_nocontext("panic: MUTEX_DESTROY (%d) [%s:%d]", \
	223	_eC_, __FILE__, __LINE__); \
ea0efc06 MB	224	} STMT_END
	225	#endif /* MUTEX_INIT */
	226
	227	#ifndef COND_INIT
ba869deb	228	# define COND_INIT(c) \
ea0efc06	229	STMT_START { \
1604cfb0 MS	230	int _eC_; \
	231	if ((_eC_ = pthread_cond_init((c), pthread_condattr_default))) \
	232	Perl_croak_nocontext("panic: COND_INIT (%d) [%s:%d]", \
	233	_eC_, __FILE__, __LINE__); \
ea0efc06	234	} STMT_END
ba869deb GS	235
	236	# define COND_SIGNAL(c) \
	237	STMT_START { \
1604cfb0 MS	238	int _eC_; \
	239	if ((_eC_ = pthread_cond_signal((c)))) \
	240	Perl_croak_nocontext("panic: COND_SIGNAL (%d) [%s:%d]", \
	241	_eC_, __FILE__, __LINE__); \
ea0efc06	242	} STMT_END
ba869deb GS	243
	244	# define COND_BROADCAST(c) \
	245	STMT_START { \
1604cfb0 MS	246	int _eC_; \
	247	if ((_eC_ = pthread_cond_broadcast((c)))) \
	248	Perl_croak_nocontext("panic: COND_BROADCAST (%d) [%s:%d]", \
	249	_eC_, __FILE__, __LINE__); \
ea0efc06	250	} STMT_END
ba869deb GS	251
	252	# define COND_WAIT(c, m) \
	253	STMT_START { \
1604cfb0 MS	254	int _eC_; \
	255	if ((_eC_ = pthread_cond_wait((c), (m)))) \
	256	Perl_croak_nocontext("panic: COND_WAIT (%d) [%s:%d]", \
	257	_eC_, __FILE__, __LINE__); \
ea0efc06	258	} STMT_END
ba869deb GS	259
	260	# define COND_DESTROY(c) \
	261	STMT_START { \
1604cfb0 MS	262	int _eC_; \
	263	if ((_eC_ = pthread_cond_destroy((c)))) \
	264	Perl_croak_nocontext("panic: COND_DESTROY (%d) [%s:%d]", \
	265	_eC_, __FILE__, __LINE__); \
ea0efc06 MB	266	} STMT_END
ea0efc06 MB	267	#endif /* COND_INIT */
33f46ff6	268
5640a370 KW	269	#if defined(MUTEX_LOCK) && defined(MUTEX_UNLOCK) \
	270	&& defined(COND_SIGNAL) && defined(COND_WAIT)
	271
	272	/* These emulate native many-reader/1-writer locks.
	273	* Basically a locking reader just locks the semaphore long enough to increment
	274	* a counter; and similarly decrements it when when through. Any writer will
	275	* run only when the count of readers is 0. That is because it blocks on that
	276	* semaphore (doing a COND_WAIT) until it gets control of it, which won't
	277	* happen unless the count becomes 0. ALL readers and other writers are then
	278	* blocked until it releases the semaphore. The reader whose unlocking causes
	279	* the count to become 0 signals any waiting writers, and the system guarantees
	280	* that only one gets control at a time */
	281
	282	# define PERL_READ_LOCK(mutex) \
	283	STMT_START { \
385ff598	284	MUTEX_LOCK(&(mutex)->lock); \
c4f0298e	285	(mutex)->readers_count++; \
385ff598	286	MUTEX_UNLOCK(&(mutex)->lock); \
5640a370 KW	287	} STMT_END
	288
	289	# define PERL_READ_UNLOCK(mutex) \
	290	STMT_START { \
385ff598	291	MUTEX_LOCK(&(mutex)->lock); \
c4f0298e KW	292	(mutex)->readers_count--; \
c4f0298e KW	293	if ((mutex)->readers_count <= 0) { \
7510ca24	294	assert((mutex)->readers_count == 0); \
385ff598	295	COND_SIGNAL(&(mutex)->wakeup); \
c4f0298e	296	(mutex)->readers_count = 0; \
5640a370	297	} \
385ff598	298	MUTEX_UNLOCK(&(mutex)->lock); \
5640a370 KW	299	} STMT_END
	300
	301	# define PERL_WRITE_LOCK(mutex) \
	302	STMT_START { \
385ff598	303	MUTEX_LOCK(&(mutex)->lock); \
5640a370	304	do { \
7510ca24 KW	305	if ((mutex)->readers_count <= 0) { \
	306	assert((mutex)->readers_count == 0); \
	307	(mutex)->readers_count = 0; \
5640a370	308	break; \
7510ca24	309	} \
385ff598	310	COND_WAIT(&(mutex)->wakeup, &(mutex)->lock); \
5640a370 KW	311	} \
	312	while (1); \
	313	\
	314	/* Here, the mutex is locked, with no readers */ \
	315	} STMT_END
	316
2cca577c KW	317	# define PERL_WRITE_UNLOCK(mutex) \
2cca577c KW	318	STMT_START { \
385ff598 TC	319	COND_SIGNAL(&(mutex)->wakeup); \
385ff598 TC	320	MUTEX_UNLOCK(&(mutex)->lock); \
2cca577c	321	} STMT_END
c4f0298e	322
72dfa47e KW	323	# define PERL_RW_MUTEX_INIT(mutex) \
72dfa47e KW	324	STMT_START { \
385ff598 TC	325	MUTEX_INIT(&(mutex)->lock); \
385ff598 TC	326	COND_INIT(&(mutex)->wakeup); \
72dfa47e KW	327	(mutex)->readers_count = 0; \
	328	} STMT_END
	329
	330	# define PERL_RW_MUTEX_DESTROY(mutex) \
	331	STMT_START { \
385ff598 TC	332	COND_DESTROY(&(mutex)->wakeup); \
385ff598 TC	333	MUTEX_DESTROY(&(mutex)->lock); \
72dfa47e KW	334	} STMT_END
72dfa47e KW	335
5640a370 KW	336	#endif
5640a370 KW	337
f826a10b	338	/* DETACH(t) must only be called while holding t->mutex */
ea0efc06	339	#ifndef DETACH
ba869deb GS	340	# define DETACH(t) \
ba869deb GS	341	STMT_START { \
1604cfb0 MS	342	int _eC_; \
	343	if ((_eC_ = pthread_detach((t)->self))) { \
	344	MUTEX_UNLOCK(&(t)->mutex); \
	345	Perl_croak_nocontext("panic: DETACH (%d) [%s:%d]", \
	346	_eC_, __FILE__, __LINE__); \
	347	} \
ea0efc06 MB	348	} STMT_END
ea0efc06 MB	349	#endif /* DETACH */
33f46ff6	350
ea0efc06	351	#ifndef JOIN
ba869deb GS	352	# define JOIN(t, avp) \
ba869deb GS	353	STMT_START { \
1604cfb0 MS	354	int _eC_; \
	355	if ((_eC_ = pthread_join((t)->self, (void**)(avp)))) \
	356	Perl_croak_nocontext("panic: pthread_join (%d) [%s:%d]", \
	357	_eC_, __FILE__, __LINE__); \
ea0efc06 MB	358	} STMT_END
	359	#endif /* JOIN */
	360
0953243c JH	361	/* Use an unchecked fetch of thread-specific data instead of a checked one.
	362	* It would fail if the key were bogus, but if the key were bogus then
	363	* Really Bad Things would be happening anyway. --dan */
026b9da6	364	#if (defined(__ALPHA) && (__VMS_VER >= 70000000)) \|\| \
cb23e6a4	365	(defined(__alpha) && defined(__osf__) && !defined(__GNUC__)) /* Available only on >= 4.0 */
8b8b35ab JH	366	# define HAS_PTHREAD_UNCHECKED_GETSPECIFIC_NP /* Configure test needed */
	367	#endif
	368
	369	#ifdef HAS_PTHREAD_UNCHECKED_GETSPECIFIC_NP
	370	# define PTHREAD_GETSPECIFIC(key) pthread_unchecked_getspecific_np(key)
	371	#else
6cfe8af5	372	# define PTHREAD_GETSPECIFIC(key) pthread_getspecific(key)
8b8b35ab JH	373	#endif
8b8b35ab JH	374
c4b6855d NC	375	#if defined(PERL_THREAD_LOCAL) && !defined(PERL_GET_CONTEXT) && !defined(PERL_SET_CONTEXT) && !defined(__cplusplus)
	376	/* Use C11 thread-local storage, where possible.
	377	* Frustratingly we can't use it for C++ extensions, C++ and C disagree on the
	378	* syntax used for thread local storage, meaning that the working token that
	379	* Configure probed for C turns out to be a compiler error on C++. Great.
	380	* (Well, unless one or both is supporting non-standard syntax as an extension)
	381	* As Configure doesn't have a way to probe for C++ dialects, we just take the
	382	* safe option and do the same as 5.34.0 and earlier - use pthreads on C++.
	383	* Of course, if C++ XS extensions really want to avoid all this overhead,
	384	* they should #define PERL_NO_GET_CONTEXT and pass aTHX/aTHX_ explicitly) */
3683a9ee NC	385	# define PERL_USE_THREAD_LOCAL
	386	extern PERL_THREAD_LOCAL void *PL_current_context;
	387
	388	# define PERL_GET_CONTEXT PL_current_context
	389
34e35871 NC	390	/* We must also call pthread_setspecific() always, as C++ code has to read it
	391	* with pthreads (the #else side just below) */
	392
3683a9ee NC	393	# define PERL_SET_CONTEXT(t) \
	394	STMT_START { \
	395	int _eC_; \
	396	if ((_eC_ = pthread_setspecific(PL_thr_key, PL_current_context = (void *)(t)))) \
	397	Perl_croak_nocontext("panic: pthread_setspecific (%d) [%s:%d]", \
	398	_eC_, __FILE__, __LINE__); \
	399	} STMT_END
	400
	401	#else
	402	/* else fall back to pthreads */
	403
	404	# ifndef PERL_GET_CONTEXT
	405	# define PERL_GET_CONTEXT PTHREAD_GETSPECIFIC(PL_thr_key)
	406	# endif
ba869deb	407
34e35871 NC	408	/* For C++ extensions built on a system where the C compiler provides thread
	409	* local storage that call PERL_SET_CONTEXT() also need to set
	410	* PL_current_context, so need to call into C code to do this.
	411	* To avoid exploding code complexity, do this also on C platforms that don't
	412	* support thread local storage. PERL_SET_CONTEXT is not called that often. */
	413
3683a9ee	414	# ifndef PERL_SET_CONTEXT
34e35871	415	# define PERL_SET_CONTEXT(t) Perl_set_context((void*)t)
3683a9ee NC	416	# endif /* PERL_SET_CONTEXT */
3683a9ee NC	417	#endif /* PERL_THREAD_LOCAL */
ea0efc06	418
1feb2720 GS	419	#ifndef INIT_THREADS
	420	# ifdef NEED_PTHREAD_INIT
	421	# define INIT_THREADS pthread_init()
	422	# endif
0d85d877	423	#endif
ea0efc06	424
ba869deb GS	425	#ifndef ALLOC_THREAD_KEY
	426	# define ALLOC_THREAD_KEY \
	427	STMT_START { \
1604cfb0	428	if (pthread_key_create(&PL_thr_key, 0)) { \
b469f1e0	429	PERL_UNUSED_RESULT(write(2, STR_WITH_LEN("panic: pthread_key_create failed\n"))); \
1604cfb0 MS	430	exit(1); \
1604cfb0 MS	431	} \
ba869deb GS	432	} STMT_END
	433	#endif
	434
e1b5da64 GS	435	#ifndef FREE_THREAD_KEY
	436	# define FREE_THREAD_KEY \
	437	STMT_START { \
1604cfb0	438	pthread_key_delete(PL_thr_key); \
e1b5da64 GS	439	} STMT_END
	440	#endif
	441
50dd6e57	442	#ifndef PTHREAD_ATFORK
144e72cb RS	443	# ifdef HAS_PTHREAD_ATFORK
144e72cb RS	444	# define PTHREAD_ATFORK(prepare,parent,child) \
1604cfb0	445	pthread_atfork(prepare,parent,child)
144e72cb	446	# else
8ff9412f	447	# define PTHREAD_ATFORK(prepare,parent,child) \
1604cfb0	448	NOOP
144e72cb	449	# endif
50dd6e57 GS	450	#endif
50dd6e57 GS	451
1feb2720 GS	452	#ifndef THREAD_RET_TYPE
1feb2720 GS	453	# define THREAD_RET_TYPE void *
1feb2720 GS	454	#endif /* THREAD_RET */
1feb2720 GS	455
e2975953 JH	456	# define LOCK_DOLLARZERO_MUTEX MUTEX_LOCK(&PL_dollarzero_mutex)
	457	# define UNLOCK_DOLLARZERO_MUTEX MUTEX_UNLOCK(&PL_dollarzero_mutex)
	458
3db8f154	459	#endif /* USE_ITHREADS */
1feb2720 GS	460
1feb2720 GS	461	#ifndef MUTEX_LOCK
63d37b7a	462	# define MUTEX_LOCK(m) NOOP
1feb2720 GS	463	#endif
1feb2720 GS	464
1feb2720	465	#ifndef MUTEX_UNLOCK
63d37b7a	466	# define MUTEX_UNLOCK(m) NOOP
1feb2720	467	#endif
1feb2720 GS	468
1feb2720 GS	469	#ifndef MUTEX_INIT
63d37b7a	470	# define MUTEX_INIT(m) NOOP
1feb2720 GS	471	#endif
	472
	473	#ifndef MUTEX_DESTROY
63d37b7a	474	# define MUTEX_DESTROY(m) NOOP
1feb2720 GS	475	#endif
	476
	477	#ifndef COND_INIT
63d37b7a	478	# define COND_INIT(c) NOOP
1feb2720 GS	479	#endif
	480
	481	#ifndef COND_SIGNAL
63d37b7a	482	# define COND_SIGNAL(c) NOOP
1feb2720 GS	483	#endif
	484
	485	#ifndef COND_BROADCAST
63d37b7a	486	# define COND_BROADCAST(c) NOOP
1feb2720 GS	487	#endif
	488
	489	#ifndef COND_WAIT
63d37b7a	490	# define COND_WAIT(c, m) NOOP
1feb2720 GS	491	#endif
	492
	493	#ifndef COND_DESTROY
63d37b7a	494	# define COND_DESTROY(c) NOOP
1feb2720 GS	495	#endif
1feb2720 GS	496
5640a370 KW	497	#ifndef PERL_READ_LOCK
	498	# define PERL_READ_LOCK NOOP
	499	# define PERL_READ_UNLOCK NOOP
	500	# define PERL_WRITE_LOCK NOOP
	501	# define PERL_WRITE_UNLOCK NOOP
13d2ab8b TC	502	# define PERL_RW_MUTEX_INIT NOOP
13d2ab8b TC	503	# define PERL_RW_MUTEX_DESTROY NOOP
5640a370 KW	504	#endif
5640a370 KW	505
e2975953	506	#ifndef LOCK_DOLLARZERO_MUTEX
63d37b7a	507	# define LOCK_DOLLARZERO_MUTEX NOOP
e2975953 JH	508	#endif
	509
	510	#ifndef UNLOCK_DOLLARZERO_MUTEX
63d37b7a	511	# define UNLOCK_DOLLARZERO_MUTEX NOOP
e2975953 JH	512	#endif
e2975953 JH	513
ba869deb	514	/* THR, SET_THR, and dTHR are there for compatibility with old versions */
1feb2720	515	#ifndef THR
ba869deb GS	516	# define THR PERL_GET_THX
	517	#endif
	518
	519	#ifndef SET_THR
	520	# define SET_THR(t) PERL_SET_THX(t)
1feb2720 GS	521	#endif
	522
	523	#ifndef dTHR
	524	# define dTHR dNOOP
	525	#endif
	526
	527	#ifndef INIT_THREADS
	528	# define INIT_THREADS NOOP
	529	#endif
e9a8c099 MHM	530
e9a8c099 MHM	531	/*
14d04a33	532	* ex: set ts=8 sts=4 sw=4 et:
e9a8c099	533	*/