Home | History | Annotate | Line # | Download | only in libpthread
pthread.h revision 1.1.2.20
      1 /*	$NetBSD: pthread.h,v 1.1.2.20 2003/01/13 22:50:09 thorpej Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2001 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Nathan J. Williams.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *        This product includes software developed by the NetBSD
     21  *        Foundation, Inc. and its contributors.
     22  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  *    contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  * POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 
     39 #ifndef _LIB_PTHREAD_H
     40 #define _LIB_PTHREAD_H
     41 
     42 #include <sys/cdefs.h>
     43 
     44 #include <time.h>	/* For timespec */
     45 #include <sched.h>
     46 #include <signal.h>	/* For sigset_t. XXX pthread_sigmask should
     47 			 * be in signal.h instead of here.
     48 			 */
     49 #include "pthread_types.h"
     50 
     51 __BEGIN_DECLS
     52 int	pthread_create(pthread_t *thread, const pthread_attr_t *attr,
     53 	    void *(*startfunc)(void *), void *arg);
     54 void	pthread_exit(void *retval) __attribute__((__noreturn__));
     55 int	pthread_join(pthread_t thread, void **valptr);
     56 int	pthread_equal(pthread_t t1, pthread_t t2);
     57 pthread_t	pthread_self(void);
     58 int	pthread_detach(pthread_t thread);
     59 
     60 int	pthread_kill(pthread_t thread, int sig);
     61 int	pthread_sigmask(int how, const sigset_t *set, sigset_t *oset);
     62 
     63 int	pthread_getrrtimer_np(void);
     64 int	pthread_setrrtimer_np(int);
     65 
     66 int	pthread_attr_destroy(pthread_attr_t *attr);
     67 int	pthread_attr_getdetachstate(pthread_attr_t *attr, int *detachstate);
     68 int	pthread_attr_init(pthread_attr_t *attr);
     69 int	pthread_attr_setdetachstate(pthread_attr_t *attr, int detachstate);
     70 int	pthread_attr_setschedparam(pthread_attr_t *attr,
     71 	    const struct sched_param *param);
     72 int	pthread_attr_getschedparam(pthread_attr_t *attr,
     73 	    struct sched_param *param);
     74 
     75 int	pthread_mutex_init(pthread_mutex_t *mutex,
     76 	    const pthread_mutexattr_t *attr);
     77 int	pthread_mutex_destroy(pthread_mutex_t *mutex);
     78 int	pthread_mutex_lock(pthread_mutex_t *mutex);
     79 int	pthread_mutex_trylock(pthread_mutex_t *mutex);
     80 int	pthread_mutex_unlock(pthread_mutex_t *mutex);
     81 int	pthread_mutexattr_init(pthread_mutexattr_t *attr);
     82 int	pthread_mutexattr_destroy(pthread_mutexattr_t *attr);
     83 int	pthread_mutexattr_gettype(const pthread_mutexattr_t *attr, int *type);
     84 int	pthread_mutexattr_settype(pthread_mutexattr_t *attr, int type);
     85 
     86 int	pthread_cond_init(pthread_cond_t *cond,
     87 	    const pthread_condattr_t *attr);
     88 int	pthread_cond_destroy(pthread_cond_t *cond);
     89 int	pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex);
     90 int	pthread_cond_timedwait(pthread_cond_t *cond, pthread_mutex_t *mutex,
     91 	    const struct timespec *abstime);
     92 int	pthread_cond_signal(pthread_cond_t *cond);
     93 int	pthread_cond_broadcast(pthread_cond_t *cond);
     94 int	pthread_condattr_init(pthread_condattr_t *attr);
     95 int	pthread_condattr_destroy(pthread_condattr_t *attr);
     96 
     97 int	pthread_once(pthread_once_t *once_control, void (*routine)(void));
     98 
     99 int	pthread_key_create(pthread_key_t *key, void (*destructor)(void *));
    100 int	pthread_key_delete(pthread_key_t key);
    101 int	pthread_setspecific(pthread_key_t key, const void *value);
    102 void*	pthread_getspecific(pthread_key_t key);
    103 
    104 int	pthread_cancel(pthread_t thread);
    105 int	pthread_setcancelstate(int state, int *oldstate);
    106 int	pthread_setcanceltype(int type, int *oldtype);
    107 void	pthread_testcancel(void);
    108 
    109 struct pthread_cleanup_store {
    110 	void	*pad[4];
    111 };
    112 
    113 #define pthread_cleanup_push(routine,arg)			\
    114         {							\
    115 		struct pthread_cleanup_store __store;	\
    116 		pthread__cleanup_push((routine),(arg), &__store);
    117 
    118 #define pthread_cleanup_pop(execute)				\
    119 		pthread__cleanup_pop((execute), &__store);	\
    120 	}
    121 
    122 void	pthread__cleanup_push(void (*routine)(void *), void *arg, void *store);
    123 void	pthread__cleanup_pop(int execute, void *store);
    124 
    125 int	pthread_spin_init(pthread_spinlock_t *lock, int pshared);
    126 int	pthread_spin_destroy(pthread_spinlock_t *lock);
    127 int	pthread_spin_lock(pthread_spinlock_t *lock);
    128 int	pthread_spin_trylock(pthread_spinlock_t *lock);
    129 int	pthread_spin_unlock(pthread_spinlock_t *lock);
    130 
    131 int	pthread_rwlock_init(pthread_rwlock_t *rwlock,
    132 	    const pthread_rwlockattr_t *attr);
    133 int	pthread_rwlock_destroy(pthread_rwlock_t *rwlock);
    134 int	pthread_rwlock_rdlock(pthread_rwlock_t *rwlock);
    135 int	pthread_rwlock_tryrdlock(pthread_rwlock_t *rwlock);
    136 int	pthread_rwlock_wrlock(pthread_rwlock_t *rwlock);
    137 int	pthread_rwlock_trywrlock(pthread_rwlock_t *rwlock);
    138 int	pthread_rwlock_timedrdlock(pthread_rwlock_t *rwlock,
    139 	    const struct timespec *abs_timeout);
    140 int	pthread_rwlock_timedwrlock(pthread_rwlock_t *rwlock,
    141 	    const struct timespec *abs_timeout);
    142 int	pthread_rwlock_unlock(pthread_rwlock_t *rwlock);
    143 int	pthread_rwlockattr_init(pthread_rwlockattr_t *attr);
    144 int	pthread_rwlockattr_destroy(pthread_rwlockattr_t *attr);
    145 
    146 int	pthread_barrier_init(pthread_barrier_t *barrier,
    147 	    const pthread_barrierattr_t *attr, unsigned int count);
    148 int	pthread_barrier_wait(pthread_barrier_t *barrier);
    149 int	pthread_barrier_destroy(pthread_barrier_t *barrier);
    150 int	pthread_barrierattr_init(pthread_barrierattr_t *attr);
    151 int	pthread_barrierattr_destroy(pthread_barrierattr_t *attr);
    152 
    153 int 	*pthread__errno(void);
    154 __END_DECLS
    155 
    156 #define	PTHREAD_CREATE_JOINABLE	0
    157 #define	PTHREAD_CREATE_DETACHED	1
    158 
    159 #define PTHREAD_PROCESS_PRIVATE	0
    160 #define PTHREAD_PROCESS_SHARED	1
    161 
    162 #define PTHREAD_CANCEL_DEFERRED		0
    163 #define PTHREAD_CANCEL_ASYNCHRONOUS	1
    164 
    165 #define PTHREAD_CANCEL_ENABLE		0
    166 #define PTHREAD_CANCEL_DISABLE		1
    167 
    168 #define PTHREAD_BARRIER_SERIAL_THREAD	1234567
    169 
    170 /*
    171  * POSIX 1003.1-2001, section 2.5.9.3: "The symbolic constant
    172  * PTHREAD_CANCELED expands to a constant expression of type (void *)
    173  * whose value matches no pointer to an object in memory nor the value
    174  * NULL."
    175  */
    176 #define PTHREAD_CANCELED	((void *) 1)
    177 
    178 #define	_POSIX_THREADS
    179 
    180 #define PTHREAD_DESTRUCTOR_ITERATIONS	4	/* Min. required */
    181 #define PTHREAD_KEYS_MAX	256
    182 #define PTHREAD_STACK_MIN	4096 /* XXX Pulled out of my butt */
    183 #define PTHREAD_THREADS_MAX	64		/* Min. required */
    184 
    185 /*
    186  * Mutex attributes.
    187  */
    188 #define	PTHREAD_MUTEX_NORMAL		0
    189 #define	PTHREAD_MUTEX_ERRORCHECK	1
    190 #define	PTHREAD_MUTEX_RECURSIVE		2
    191 #define	PTHREAD_MUTEX_DEFAULT		PTHREAD_MUTEX_NORMAL
    192 
    193 #endif /* _LIB_PTHREAD_H */
    194