Home | History | Annotate | Line # | Download | only in libpthread
pthread.h revision 1.10
      1 /*	$NetBSD: pthread.h,v 1.10 2003/06/02 16:59:27 christos 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 
     47 #include "pthread_types.h"
     48 
     49 __BEGIN_DECLS
     50 int	pthread_atfork(void (*)(void), void (*)(void), void (*)(void));
     51 int	pthread_create(pthread_t *, const pthread_attr_t *,
     52 	    void *(*)(void *), void *);
     53 void	pthread_exit(void *) __attribute__((__noreturn__));
     54 int	pthread_join(pthread_t, void **);
     55 int	pthread_equal(pthread_t, pthread_t);
     56 pthread_t	pthread_self(void);
     57 int	pthread_detach(pthread_t);
     58 
     59 int	pthread_kill(pthread_t, int);
     60 
     61 int	pthread_getrrtimer_np(void);
     62 int	pthread_setrrtimer_np(int);
     63 
     64 int	pthread_attr_init(pthread_attr_t *);
     65 int	pthread_attr_destroy(pthread_attr_t *);
     66 int	pthread_attr_getschedparam(const pthread_attr_t *,
     67     struct sched_param *);
     68 int	pthread_attr_setschedparam(pthread_attr_t *,
     69     const struct sched_param *);
     70 int	pthread_attr_getstack(const pthread_attr_t *, void **, size_t *);
     71 int	pthread_attr_getstacksize(const pthread_attr_t *, size_t *);
     72 int	pthread_attr_getstackaddr(const pthread_attr_t *, void **);
     73 int	pthread_attr_getdetachstate(const pthread_attr_t *, int *);
     74 int	pthread_attr_setdetachstate(pthread_attr_t *, int);
     75 int	pthread_attr_getname_np(const pthread_attr_t *, char *,
     76 	    size_t, void **);
     77 int	pthread_attr_setname_np(pthread_attr_t *, const char *, void *);
     78 
     79 int	pthread_mutex_init(pthread_mutex_t *, const pthread_mutexattr_t *);
     80 int	pthread_mutex_destroy(pthread_mutex_t *);
     81 int	pthread_mutex_lock(pthread_mutex_t *);
     82 int	pthread_mutex_trylock(pthread_mutex_t *);
     83 int	pthread_mutex_unlock(pthread_mutex_t *);
     84 int	pthread_mutexattr_init(pthread_mutexattr_t *);
     85 int	pthread_mutexattr_destroy(pthread_mutexattr_t *);
     86 int	pthread_mutexattr_gettype(const pthread_mutexattr_t *, int *);
     87 int	pthread_mutexattr_settype(pthread_mutexattr_t *attr, int);
     88 
     89 int	pthread_cond_init(pthread_cond_t *, const pthread_condattr_t *);
     90 int	pthread_cond_destroy(pthread_cond_t *);
     91 int	pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *);
     92 int	pthread_cond_timedwait(pthread_cond_t *, pthread_mutex_t *,
     93 	    const struct timespec *);
     94 int	pthread_cond_signal(pthread_cond_t *);
     95 int	pthread_cond_broadcast(pthread_cond_t *);
     96 int	pthread_condattr_init(pthread_condattr_t *);
     97 int	pthread_condattr_destroy(pthread_condattr_t *);
     98 
     99 int	pthread_once(pthread_once_t *, void (*)(void));
    100 
    101 int	pthread_key_create(pthread_key_t *, void (*)(void *));
    102 int	pthread_key_delete(pthread_key_t);
    103 int	pthread_setspecific(pthread_key_t, const void *);
    104 void*	pthread_getspecific(pthread_key_t);
    105 
    106 int	pthread_cancel(pthread_t);
    107 int	pthread_setcancelstate(int, int *);
    108 int	pthread_setcanceltype(int, int *);
    109 void	pthread_testcancel(void);
    110 
    111 int	pthread_getname_np(pthread_t, char *, size_t);
    112 int	pthread_setname_np(pthread_t, const char *, void *);
    113 
    114 struct pthread_cleanup_store {
    115 	void	*pad[4];
    116 };
    117 
    118 #define pthread_cleanup_push(routine, arg)			\
    119         {							\
    120 		struct pthread_cleanup_store __store;		\
    121 		pthread__cleanup_push((routine),(arg), &__store);
    122 
    123 #define pthread_cleanup_pop(execute)				\
    124 		pthread__cleanup_pop((execute), &__store);	\
    125 	}
    126 
    127 void	pthread__cleanup_push(void (*)(void *), void *, void *);
    128 void	pthread__cleanup_pop(int, void *);
    129 
    130 int	pthread_spin_init(pthread_spinlock_t *, int);
    131 int	pthread_spin_destroy(pthread_spinlock_t *);
    132 int	pthread_spin_lock(pthread_spinlock_t *);
    133 int	pthread_spin_trylock(pthread_spinlock_t *);
    134 int	pthread_spin_unlock(pthread_spinlock_t *);
    135 
    136 int	pthread_rwlock_init(pthread_rwlock_t *,
    137 	    const pthread_rwlockattr_t *);
    138 int	pthread_rwlock_destroy(pthread_rwlock_t *);
    139 int	pthread_rwlock_rdlock(pthread_rwlock_t *);
    140 int	pthread_rwlock_tryrdlock(pthread_rwlock_t *);
    141 int	pthread_rwlock_wrlock(pthread_rwlock_t *);
    142 int	pthread_rwlock_trywrlock(pthread_rwlock_t *);
    143 int	pthread_rwlock_timedrdlock(pthread_rwlock_t *,
    144 	    const struct timespec *);
    145 int	pthread_rwlock_timedwrlock(pthread_rwlock_t *,
    146 	    const struct timespec *);
    147 int	pthread_rwlock_unlock(pthread_rwlock_t *);
    148 int	pthread_rwlockattr_init(pthread_rwlockattr_t *);
    149 int	pthread_rwlockattr_destroy(pthread_rwlockattr_t *);
    150 
    151 int	pthread_barrier_init(pthread_barrier_t *,
    152 	    const pthread_barrierattr_t *, unsigned int);
    153 int	pthread_barrier_wait(pthread_barrier_t *);
    154 int	pthread_barrier_destroy(pthread_barrier_t *);
    155 int	pthread_barrierattr_init(pthread_barrierattr_t *);
    156 int	pthread_barrierattr_destroy(pthread_barrierattr_t *);
    157 
    158 int 	*pthread__errno(void);
    159 __END_DECLS
    160 
    161 #define	PTHREAD_CREATE_JOINABLE	0
    162 #define	PTHREAD_CREATE_DETACHED	1
    163 
    164 #define PTHREAD_PROCESS_PRIVATE	0
    165 #define PTHREAD_PROCESS_SHARED	1
    166 
    167 #define PTHREAD_CANCEL_DEFERRED		0
    168 #define PTHREAD_CANCEL_ASYNCHRONOUS	1
    169 
    170 #define PTHREAD_CANCEL_ENABLE		0
    171 #define PTHREAD_CANCEL_DISABLE		1
    172 
    173 #define PTHREAD_BARRIER_SERIAL_THREAD	1234567
    174 
    175 /*
    176  * POSIX 1003.1-2001, section 2.5.9.3: "The symbolic constant
    177  * PTHREAD_CANCELED expands to a constant expression of type (void *)
    178  * whose value matches no pointer to an object in memory nor the value
    179  * NULL."
    180  */
    181 #define PTHREAD_CANCELED	((void *) 1)
    182 
    183 #define PTHREAD_DESTRUCTOR_ITERATIONS	4	/* Min. required */
    184 #define PTHREAD_KEYS_MAX	256
    185 #define PTHREAD_STACK_MIN	4096 /* XXX Pulled out of my butt */
    186 #define PTHREAD_THREADS_MAX	64		/* Min. required */
    187 
    188 /*
    189  * Maximum length of a thread's name, including the terminating NUL.
    190  */
    191 #define	PTHREAD_MAX_NAMELEN_NP	32
    192 
    193 /*
    194  * Mutex attributes.
    195  */
    196 #define	PTHREAD_MUTEX_NORMAL		0
    197 #define	PTHREAD_MUTEX_ERRORCHECK	1
    198 #define	PTHREAD_MUTEX_RECURSIVE		2
    199 #define	PTHREAD_MUTEX_DEFAULT		PTHREAD_MUTEX_NORMAL
    200 
    201 #endif /* _LIB_PTHREAD_H */
    202