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