NetBSD/lib/libpthread/pthread_int.h

302 lines
9.6 KiB
C

/* $NetBSD: pthread_int.h,v 1.59 2007/10/16 15:21:54 ad Exp $ */
/*-
* Copyright (c) 2001, 2002, 2003, 2006, 2007 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Nathan J. Williams and Andrew Doran.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the NetBSD
* Foundation, Inc. and its contributors.
* 4. Neither the name of The NetBSD Foundation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*
* NOTE: when changing anything in this file, please ensure that
* libpthread_dbg still compiles.
*/
#ifndef _LIB_PTHREAD_INT_H
#define _LIB_PTHREAD_INT_H
/* #define PTHREAD__DEBUG */
#define ERRORCHECK
#include "pthread_types.h"
#include "pthread_queue.h"
#include "pthread_debug.h"
#include "pthread_md.h"
#include <sys/tree.h>
#include <lwp.h>
#include <signal.h>
#define PTHREAD_KEYS_MAX 256
#define PTHREAD__UNPARK_MAX 32
/*
* The size of this structure needs to be no larger than struct
* __pthread_cleanup_store, defined in pthread.h.
*/
struct pt_clean_t {
PTQ_ENTRY(pt_clean_t) ptc_next;
void (*ptc_cleanup)(void *);
void *ptc_arg;
};
/* Private data for pthread_attr_t */
struct pthread_attr_private {
char ptap_name[PTHREAD_MAX_NAMELEN_NP];
void *ptap_namearg;
void *ptap_stackaddr;
size_t ptap_stacksize;
size_t ptap_guardsize;
};
struct __pthread_st {
unsigned int pt_magic; /* Magic number */
int pt_num; /* ID XXX should die */
int pt_state; /* running, blocked, etc. */
pthread_mutex_t pt_lock; /* lock on state */
int pt_flags; /* see PT_FLAG_* below */
int pt_cancel; /* Deferred cancellation */
int pt_spinlocks; /* Number of spinlocks held. */
int pt_errno; /* Thread-specific errno. */
stack_t pt_stack; /* Our stack */
void *pt_exitval; /* Read by pthread_join() */
char *pt_name; /* Thread's name, set by the app. */
int pt_willpark; /* About to park */
lwpid_t pt_unpark; /* Unpark this when parking */
void *pt_unparkhint; /* Hint for the above */
/* Threads to defer waking, usually until pthread_mutex_unlock(). */
lwpid_t pt_waiters[PTHREAD__UNPARK_MAX];
size_t pt_nwaiters;
/* Stack of cancellation cleanup handlers and their arguments */
PTQ_HEAD(, pt_clean_t) pt_cleanup_stack;
/* For debugger: LWPs waiting to join. */
pthread_queue_t pt_joiners;
PTQ_ENTRY(__pthread_st) pt_joinq;
/* LWP ID and entry on the list of all threads. */
lwpid_t pt_lid;
RB_ENTRY(__pthread_st) pt_alltree;
PTQ_ENTRY(__pthread_st) pt_allq;
PTQ_ENTRY(__pthread_st) pt_deadq;
/*
* General synchronization data. We try to align, as threads
* on other CPUs will access this data frequently.
*/
int pt_dummy1 __aligned(128);
volatile int pt_rwlocked; /* Handed rwlock successfully */
volatile int pt_sleeponq; /* On a sleep queue */
volatile int pt_signalled; /* Received pthread_cond_signal() */
void * volatile pt_sleepobj; /* Object slept on */
PTQ_ENTRY(__pthread_st) pt_sleep;
void (*pt_early)(void *);
int pt_dummy2 __aligned(128);
/* Thread-specific data. Large so it sits close to the end. */
int pt_havespecific;
void *pt_specific[PTHREAD_KEYS_MAX];
/*
* Context for thread creation. At the end as it's cached
* and then only ever passed to _lwp_create().
*/
ucontext_t pt_uc;
};
struct pthread_lock_ops {
void (*plo_init)(__cpu_simple_lock_t *);
int (*plo_try)(__cpu_simple_lock_t *);
void (*plo_unlock)(__cpu_simple_lock_t *);
};
/* Thread states */
#define PT_STATE_RUNNING 1
#define PT_STATE_ZOMBIE 5
#define PT_STATE_DEAD 6
/* Flag values */
#define PT_FLAG_DETACHED 0x0001
#define PT_FLAG_CS_DISABLED 0x0004 /* Cancellation disabled */
#define PT_FLAG_CS_ASYNC 0x0008 /* Cancellation is async */
#define PT_FLAG_CS_PENDING 0x0010
#define PT_FLAG_SCOPE_SYSTEM 0x0040
#define PT_FLAG_EXPLICIT_SCHED 0x0080
#define PT_FLAG_SUSPENDED 0x0100 /* In the suspended queue */
#define PT_MAGIC 0x11110001
#define PT_DEAD 0xDEAD0001
#define PT_ATTR_MAGIC 0x22220002
#define PT_ATTR_DEAD 0xDEAD0002
extern int pthread__stacksize_lg;
extern size_t pthread__stacksize;
extern vaddr_t pthread__stackmask;
extern vaddr_t pthread__threadmask;
extern int pthread__nspins;
extern int pthread__concurrency;
extern int pthread__osrev;
extern int pthread__unpark_max;
/* Flag to be used in a ucontext_t's uc_flags indicating that
* the saved register state is "user" state only, not full
* trap state.
*/
#define _UC_USER_BIT 30
#define _UC_USER (1LU << _UC_USER_BIT)
void pthread_init(void) __attribute__ ((__constructor__));
/* Utility functions */
void pthread__unpark_all(pthread_t self, pthread_spin_t *lock,
pthread_queue_t *threadq);
void pthread__unpark(pthread_t self, pthread_spin_t *lock,
pthread_queue_t *queue, pthread_t target);
int pthread__park(pthread_t self, pthread_spin_t *lock,
pthread_queue_t *threadq,
const struct timespec *abs_timeout,
int cancelpt, const void *hint);
/* Internal locking primitives */
void pthread__lockprim_init(void);
void pthread_lockinit(pthread_spin_t *);
void pthread_spinlock(pthread_spin_t *);
int pthread_spintrylock(pthread_spin_t *);
void pthread_spinunlock(pthread_spin_t *);
extern const struct pthread_lock_ops *pthread__lock_ops;
int pthread__simple_locked_p(__cpu_simple_lock_t *);
#define pthread__simple_lock_init(alp) (*pthread__lock_ops->plo_init)(alp)
#define pthread__simple_lock_try(alp) (*pthread__lock_ops->plo_try)(alp)
#define pthread__simple_unlock(alp) (*pthread__lock_ops->plo_unlock)(alp)
#ifndef _getcontext_u
int _getcontext_u(ucontext_t *);
#endif
#ifndef _setcontext_u
int _setcontext_u(const ucontext_t *);
#endif
#ifndef _swapcontext_u
int _swapcontext_u(ucontext_t *, const ucontext_t *);
#endif
void pthread__testcancel(pthread_t);
int pthread__find(pthread_t);
#ifndef PTHREAD_MD_INIT
#define PTHREAD_MD_INIT
#endif
#ifndef _INITCONTEXT_U_MD
#define _INITCONTEXT_U_MD(ucp)
#endif
#define _INITCONTEXT_U(ucp) do { \
(ucp)->uc_flags = _UC_CPU | _UC_STACK; \
_INITCONTEXT_U_MD(ucp) \
} while (/*CONSTCOND*/0)
#ifdef PTHREAD_MACHINE_HAS_ID_REGISTER
#define pthread__id(reg) (reg)
#else
/* Stack location of pointer to a particular thread */
#define pthread__id(sp) \
((pthread_t) (((vaddr_t)(sp)) & pthread__threadmask))
#define pthread__id_reg() pthread__sp()
#endif
#define pthread__self() (pthread__id(pthread__id_reg()))
#define pthread__abort() \
pthread__assertfunc(__FILE__, __LINE__, __func__, "unreachable")
#define pthread__assert(e) do { \
if (__predict_false(!(e))) \
pthread__assertfunc(__FILE__, __LINE__, __func__, #e); \
} while (/*CONSTCOND*/0)
#define pthread__error(err, msg, e) do { \
if (__predict_false(!(e))) { \
pthread__errorfunc(__FILE__, __LINE__, __func__, msg); \
return (err); \
} \
} while (/*CONSTCOND*/0)
void pthread__destroy_tsd(pthread_t self);
void pthread__assertfunc(const char *file, int line, const char *function,
const char *expr);
void pthread__errorfunc(const char *file, int line, const char *function,
const char *msg);
int pthread__atomic_cas_ptr(volatile void *, void **, void *);
void *pthread__atomic_swap_ptr(volatile void *, void *);
void pthread__membar_full(void);
void pthread__membar_producer(void);
void pthread__membar_consumer(void);
int pthread__mutex_deferwake(pthread_t, pthread_mutex_t *);
int pthread__mutex_catchup(pthread_mutex_t *);
#ifndef pthread__smt_pause
#define pthread__smt_pause() /* nothing */
#endif
/*
* Bits in the owner field of the lock that indicate lock state. If the
* WRITE_LOCKED bit is clear, then the owner field is actually a count of
* the number of readers.
*/
#define RW_HAS_WAITERS 0x01 /* lock has waiters */
#define RW_WRITE_WANTED 0x02 /* >= 1 waiter is a writer */
#define RW_WRITE_LOCKED 0x04 /* lock is currently write locked */
#define RW_UNUSED 0x08 /* currently unused */
#define RW_FLAGMASK 0x0f
#define RW_READ_COUNT_SHIFT 4
#define RW_READ_INCR (1 << RW_READ_COUNT_SHIFT)
#define RW_THREAD ((uintptr_t)-RW_READ_INCR)
#define RW_OWNER(rw) ((rw)->rw_owner & RW_THREAD)
#define RW_COUNT(rw) ((rw)->rw_owner & RW_THREAD)
#define RW_FLAGS(rw) ((rw)->rw_owner & ~RW_THREAD)
#define ptr_owner ptr_writer
#endif /* _LIB_PTHREAD_INT_H */