1 /* $NetBSD: pthread.h,v 1.14 2003/07/18 22:01:47 nathanw 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_getrrtimer_np(void); 60 int pthread_setrrtimer_np(int); 61 62 int pthread_attr_init(pthread_attr_t *); 63 int pthread_attr_destroy(pthread_attr_t *); 64 int pthread_attr_get_np(pthread_t, pthread_attr_t *); 65 int pthread_attr_getguardsize(const pthread_attr_t *, size_t *); 66 int pthread_attr_setguardsize(pthread_attr_t *, size_t); 67 int pthread_attr_getinheritsched(const pthread_attr_t *, int *); 68 int pthread_attr_setinheritsched(pthread_attr_t *, int); 69 int pthread_attr_getschedparam(const pthread_attr_t *, 70 struct sched_param *); 71 int pthread_attr_setschedparam(pthread_attr_t *, 72 const struct sched_param *); 73 int pthread_attr_getscope(const pthread_attr_t *, int *); 74 int pthread_attr_setscope(pthread_attr_t *, int); 75 int pthread_attr_getstack(const pthread_attr_t *, void **, size_t *); 76 int pthread_attr_setstack(pthread_attr_t *, void *, size_t); 77 int pthread_attr_getstacksize(const pthread_attr_t *, size_t *); 78 int pthread_attr_setstacksize(pthread_attr_t *, size_t); 79 int pthread_attr_getstackaddr(const pthread_attr_t *, void **); 80 int pthread_attr_setstackaddr(pthread_attr_t *, void *); 81 int pthread_attr_getdetachstate(const pthread_attr_t *, int *); 82 int pthread_attr_setdetachstate(pthread_attr_t *, int); 83 int pthread_attr_getname_np(const pthread_attr_t *, char *, 84 size_t, void **); 85 int pthread_attr_setname_np(pthread_attr_t *, const char *, void *); 86 87 int pthread_mutex_init(pthread_mutex_t *, const pthread_mutexattr_t *); 88 int pthread_mutex_destroy(pthread_mutex_t *); 89 int pthread_mutex_lock(pthread_mutex_t *); 90 int pthread_mutex_trylock(pthread_mutex_t *); 91 int pthread_mutex_unlock(pthread_mutex_t *); 92 int pthread_mutexattr_init(pthread_mutexattr_t *); 93 int pthread_mutexattr_destroy(pthread_mutexattr_t *); 94 int pthread_mutexattr_gettype(const pthread_mutexattr_t *, int *); 95 int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int); 96 97 int pthread_cond_init(pthread_cond_t *, const pthread_condattr_t *); 98 int pthread_cond_destroy(pthread_cond_t *); 99 int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *); 100 int pthread_cond_timedwait(pthread_cond_t *, pthread_mutex_t *, 101 const struct timespec *); 102 int pthread_cond_signal(pthread_cond_t *); 103 int pthread_cond_broadcast(pthread_cond_t *); 104 int pthread_condattr_init(pthread_condattr_t *); 105 int pthread_condattr_destroy(pthread_condattr_t *); 106 107 int pthread_once(pthread_once_t *, void (*)(void)); 108 109 int pthread_key_create(pthread_key_t *, void (*)(void *)); 110 int pthread_key_delete(pthread_key_t); 111 int pthread_setspecific(pthread_key_t, const void *); 112 void* pthread_getspecific(pthread_key_t); 113 114 int pthread_cancel(pthread_t); 115 int pthread_setcancelstate(int, int *); 116 int pthread_setcanceltype(int, int *); 117 void pthread_testcancel(void); 118 119 int pthread_getname_np(pthread_t, char *, size_t); 120 int pthread_setname_np(pthread_t, const char *, void *); 121 122 struct pthread_cleanup_store { 123 void *pad[4]; 124 }; 125 126 #define pthread_cleanup_push(routine, arg) \ 127 { \ 128 struct pthread_cleanup_store __store; \ 129 pthread__cleanup_push((routine),(arg), &__store); 130 131 #define pthread_cleanup_pop(execute) \ 132 pthread__cleanup_pop((execute), &__store); \ 133 } 134 135 void pthread__cleanup_push(void (*)(void *), void *, void *); 136 void pthread__cleanup_pop(int, void *); 137 138 int pthread_spin_init(pthread_spinlock_t *, int); 139 int pthread_spin_destroy(pthread_spinlock_t *); 140 int pthread_spin_lock(pthread_spinlock_t *); 141 int pthread_spin_trylock(pthread_spinlock_t *); 142 int pthread_spin_unlock(pthread_spinlock_t *); 143 144 int pthread_rwlock_init(pthread_rwlock_t *, 145 const pthread_rwlockattr_t *); 146 int pthread_rwlock_destroy(pthread_rwlock_t *); 147 int pthread_rwlock_rdlock(pthread_rwlock_t *); 148 int pthread_rwlock_tryrdlock(pthread_rwlock_t *); 149 int pthread_rwlock_wrlock(pthread_rwlock_t *); 150 int pthread_rwlock_trywrlock(pthread_rwlock_t *); 151 int pthread_rwlock_timedrdlock(pthread_rwlock_t *, 152 const struct timespec *); 153 int pthread_rwlock_timedwrlock(pthread_rwlock_t *, 154 const struct timespec *); 155 int pthread_rwlock_unlock(pthread_rwlock_t *); 156 int pthread_rwlockattr_init(pthread_rwlockattr_t *); 157 int pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 158 159 int pthread_barrier_init(pthread_barrier_t *, 160 const pthread_barrierattr_t *, unsigned int); 161 int pthread_barrier_wait(pthread_barrier_t *); 162 int pthread_barrier_destroy(pthread_barrier_t *); 163 int pthread_barrierattr_init(pthread_barrierattr_t *); 164 int pthread_barrierattr_destroy(pthread_barrierattr_t *); 165 166 int *pthread__errno(void); 167 __END_DECLS 168 169 #define PTHREAD_CREATE_JOINABLE 0 170 #define PTHREAD_CREATE_DETACHED 1 171 172 #define PTHREAD_INHERIT_SCHED 0 173 #define PTHREAD_EXPLICIT_SCHED 1 174 175 #define PTHREAD_SCOPE_PROCESS 0 176 #define PTHREAD_SCOPE_SYSTEM 1 177 178 #define PTHREAD_PROCESS_PRIVATE 0 179 #define PTHREAD_PROCESS_SHARED 1 180 181 #define PTHREAD_CANCEL_DEFERRED 0 182 #define PTHREAD_CANCEL_ASYNCHRONOUS 1 183 184 #define PTHREAD_CANCEL_ENABLE 0 185 #define PTHREAD_CANCEL_DISABLE 1 186 187 #define PTHREAD_BARRIER_SERIAL_THREAD 1234567 188 189 /* 190 * POSIX 1003.1-2001, section 2.5.9.3: "The symbolic constant 191 * PTHREAD_CANCELED expands to a constant expression of type (void *) 192 * whose value matches no pointer to an object in memory nor the value 193 * NULL." 194 */ 195 #define PTHREAD_CANCELED ((void *) 1) 196 197 /* 198 * Maximum length of a thread's name, including the terminating NUL. 199 */ 200 #define PTHREAD_MAX_NAMELEN_NP 32 201 202 /* 203 * Mutex attributes. 204 */ 205 #define PTHREAD_MUTEX_NORMAL 0 206 #define PTHREAD_MUTEX_ERRORCHECK 1 207 #define PTHREAD_MUTEX_RECURSIVE 2 208 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_NORMAL 209 210 #define PTHREAD_COND_INITIALIZER _PTHREAD_COND_INITIALIZER 211 #define PTHREAD_MUTEX_INITIALIZER _PTHREAD_MUTEX_INITIALIZER 212 #define PTHREAD_ONCE_INIT _PTHREAD_ONCE_INIT 213 #define PTHREAD_RWLOCK_INITIALIZER _PTHREAD_RWLOCK_INITIALIZER 214 #define PTHREAD_SPINLOCK_INITIALIZER _PTHREAD_SPINLOCK_INITIALIZER 215 216 #endif /* _LIB_PTHREAD_H */ 217