1 /* 2 * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu 3 * Copyright (c) 1995-1998 by John Birrell <jb@cimlogic.com.au> 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. All advertising materials mentioning features or use of this software 15 * must display the following acknowledgement: 16 * This product includes software developed by Chris Provenzano. 17 * 4. The name of Chris Provenzano may not be used to endorse or promote 18 * products derived from this software without specific prior written 19 * permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY CHRIS PROVENZANO ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL CHRIS PROVENZANO BE LIABLE FOR ANY 25 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 26 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 27 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 28 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * $FreeBSD$ 34 */ 35 #ifndef _PTHREAD_H_ 36 #define _PTHREAD_H_ 37 38 /* 39 * Header files. 40 */ 41 #include <sys/cdefs.h> 42 #include <sys/_pthreadtypes.h> 43 #include <machine/_limits.h> 44 #include <machine/_types.h> 45 #include <sys/_sigset.h> 46 #include <sched.h> 47 #include <time.h> 48 49 __NULLABILITY_PRAGMA_PUSH 50 51 /* 52 * Run-time invariant values: 53 */ 54 #define PTHREAD_DESTRUCTOR_ITERATIONS 4 55 #define PTHREAD_KEYS_MAX 256 56 #define PTHREAD_STACK_MIN __MINSIGSTKSZ 57 #define PTHREAD_THREADS_MAX __ULONG_MAX 58 #define PTHREAD_BARRIER_SERIAL_THREAD -1 59 60 /* 61 * Flags for threads and thread attributes. 62 */ 63 #define PTHREAD_DETACHED 0x1 64 #define PTHREAD_SCOPE_SYSTEM 0x2 65 #define PTHREAD_INHERIT_SCHED 0x4 66 #define PTHREAD_NOFLOAT 0x8 67 68 #define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED 69 #define PTHREAD_CREATE_JOINABLE 0 70 #define PTHREAD_SCOPE_PROCESS 0 71 #define PTHREAD_EXPLICIT_SCHED 0 72 73 /* 74 * Values for process shared/private attributes. 75 */ 76 #define PTHREAD_PROCESS_PRIVATE 0 77 #define PTHREAD_PROCESS_SHARED 1 78 79 /* 80 * Flags for cancelling threads 81 */ 82 #define PTHREAD_CANCEL_ENABLE 0 83 #define PTHREAD_CANCEL_DISABLE 1 84 #define PTHREAD_CANCEL_DEFERRED 0 85 #define PTHREAD_CANCEL_ASYNCHRONOUS 2 86 #define PTHREAD_CANCELED ((void *) 1) 87 88 /* 89 * Flags for once initialization. 90 */ 91 #define PTHREAD_NEEDS_INIT 0 92 #define PTHREAD_DONE_INIT 1 93 94 /* 95 * Static once initialization values. 96 */ 97 #define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, NULL } 98 99 /* 100 * Static initialization values. 101 */ 102 #define PTHREAD_MUTEX_INITIALIZER NULL 103 #define PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP ((pthread_mutex_t)1) 104 #define PTHREAD_COND_INITIALIZER NULL 105 #define PTHREAD_RWLOCK_INITIALIZER NULL 106 107 /* 108 * Default attribute arguments (draft 4, deprecated). 109 */ 110 #ifndef PTHREAD_KERNEL 111 #define pthread_condattr_default NULL 112 #define pthread_mutexattr_default NULL 113 #define pthread_attr_default NULL 114 #endif 115 116 #define PTHREAD_PRIO_NONE 0 117 #define PTHREAD_PRIO_INHERIT 1 118 #define PTHREAD_PRIO_PROTECT 2 119 120 /* 121 * Mutex types (Single UNIX Specification, Version 2, 1997). 122 * 123 * Note that a mutex attribute with one of the following types: 124 * 125 * PTHREAD_MUTEX_NORMAL 126 * PTHREAD_MUTEX_RECURSIVE 127 * 128 * will deviate from POSIX specified semantics. 129 */ 130 enum pthread_mutextype { 131 PTHREAD_MUTEX_ERRORCHECK = 1, /* Default POSIX mutex */ 132 PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */ 133 PTHREAD_MUTEX_NORMAL = 3, /* No error checking */ 134 PTHREAD_MUTEX_ADAPTIVE_NP = 4, /* Adaptive mutex, spins briefly before blocking on lock */ 135 PTHREAD_MUTEX_TYPE_MAX 136 }; 137 138 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK 139 140 #define PTHREAD_MUTEX_STALLED 0 141 #define PTHREAD_MUTEX_ROBUST 1 142 143 struct _pthread_cleanup_info { 144 __uintptr_t pthread_cleanup_pad[8]; 145 }; 146 147 /* 148 * Thread function prototype definitions: 149 */ 150 __BEGIN_DECLS 151 int pthread_atfork(void (*)(void), void (*)(void), void (*)(void)); 152 int pthread_attr_destroy(pthread_attr_t * _Nonnull); 153 int pthread_attr_getstack( 154 const pthread_attr_t * _Nonnull __restrict, 155 void ** _Nonnull __restrict, 156 size_t * _Nonnull __restrict); 157 int pthread_attr_getstacksize(const pthread_attr_t * _Nonnull, 158 size_t * _Nonnull); 159 int pthread_attr_getguardsize(const pthread_attr_t * _Nonnull, 160 size_t * _Nonnull); 161 int pthread_attr_getstackaddr(const pthread_attr_t *, void **); 162 int pthread_attr_getdetachstate(const pthread_attr_t * _Nonnull, 163 int * _Nonnull); 164 int pthread_attr_init(pthread_attr_t * _Nonnull); 165 int pthread_attr_setstacksize(pthread_attr_t * _Nonnull, size_t); 166 int pthread_attr_setguardsize(pthread_attr_t * _Nonnull, size_t); 167 int pthread_attr_setstack(pthread_attr_t * _Nonnull, void *, 168 size_t); 169 int pthread_attr_setstackaddr(pthread_attr_t *, void *); 170 int pthread_attr_setdetachstate(pthread_attr_t * _Nonnull, int); 171 int pthread_barrier_destroy(pthread_barrier_t * _Nonnull); 172 int pthread_barrier_init(pthread_barrier_t * _Nonnull, 173 const pthread_barrierattr_t *, unsigned); 174 int pthread_barrier_wait(pthread_barrier_t * _Nonnull); 175 int pthread_barrierattr_destroy(pthread_barrierattr_t * _Nonnull); 176 int pthread_barrierattr_getpshared( 177 const pthread_barrierattr_t * _Nonnull, int * _Nonnull); 178 int pthread_barrierattr_init(pthread_barrierattr_t * _Nonnull); 179 int pthread_barrierattr_setpshared(pthread_barrierattr_t * _Nonnull, 180 int); 181 182 #define pthread_cleanup_push(cleanup_routine, cleanup_arg) \ 183 { \ 184 struct _pthread_cleanup_info __cleanup_info__; \ 185 __pthread_cleanup_push_imp(cleanup_routine, cleanup_arg,\ 186 &__cleanup_info__); \ 187 { 188 189 #define pthread_cleanup_pop(execute) \ 190 (void)0; \ 191 } \ 192 __pthread_cleanup_pop_imp(execute); \ 193 } 194 195 int pthread_condattr_destroy(pthread_condattr_t * _Nonnull); 196 int pthread_condattr_getclock(const pthread_condattr_t * _Nonnull, 197 clockid_t * _Nonnull); 198 int pthread_condattr_getpshared(const pthread_condattr_t * _Nonnull, 199 int * _Nonnull); 200 int pthread_condattr_init(pthread_condattr_t * _Nonnull); 201 int pthread_condattr_setclock(pthread_condattr_t * _Nonnull, 202 clockid_t); 203 int pthread_condattr_setpshared(pthread_condattr_t * _Nonnull, int); 204 int pthread_cond_broadcast(pthread_cond_t * _Nonnull); 205 int pthread_cond_destroy(pthread_cond_t * _Nonnull); 206 int pthread_cond_init(pthread_cond_t * _Nonnull, 207 const pthread_condattr_t *); 208 int pthread_cond_signal(pthread_cond_t * _Nonnull); 209 int pthread_cond_timedwait(pthread_cond_t * _Nonnull, 210 pthread_mutex_t * _Nonnull __mutex, 211 const struct timespec * _Nonnull) 212 __requires_exclusive(*__mutex); 213 int pthread_cond_wait(pthread_cond_t * _Nonnull, 214 pthread_mutex_t * _Nonnull __mutex) 215 __requires_exclusive(*__mutex); 216 int pthread_create(pthread_t * _Nonnull, const pthread_attr_t *, 217 void *(* _Nonnull) (void *), void *); 218 int pthread_detach(pthread_t); 219 int pthread_equal(pthread_t, pthread_t); 220 void pthread_exit(void *) __dead2; 221 void *pthread_getspecific(pthread_key_t); 222 int pthread_getcpuclockid(pthread_t, clockid_t * _Nonnull); 223 int pthread_join(pthread_t, void **); 224 int pthread_key_create(pthread_key_t * _Nonnull, 225 void (*) (void *)); 226 int pthread_key_delete(pthread_key_t); 227 int pthread_mutexattr_init(pthread_mutexattr_t * _Nonnull); 228 int pthread_mutexattr_destroy(pthread_mutexattr_t * _Nonnull); 229 int pthread_mutexattr_getpshared( 230 const pthread_mutexattr_t * _Nonnull, int * _Nonnull); 231 int pthread_mutexattr_gettype(pthread_mutexattr_t * _Nonnull, 232 int * _Nonnull); 233 int pthread_mutexattr_settype(pthread_mutexattr_t * _Nonnull, int); 234 int pthread_mutexattr_setpshared(pthread_mutexattr_t * _Nonnull, 235 int); 236 int pthread_mutex_consistent(pthread_mutex_t * _Nonnull __mutex) 237 __requires_exclusive(*__mutex); 238 int pthread_mutex_destroy(pthread_mutex_t * _Nonnull __mutex) 239 __requires_unlocked(*__mutex); 240 int pthread_mutex_init(pthread_mutex_t * _Nonnull __mutex, 241 const pthread_mutexattr_t *) 242 __requires_unlocked(*__mutex); 243 int pthread_mutex_lock(pthread_mutex_t * _Nonnull __mutex) 244 __locks_exclusive(*__mutex); 245 int pthread_mutex_trylock(pthread_mutex_t * _Nonnull __mutex) 246 __trylocks_exclusive(0, *__mutex); 247 int pthread_mutex_timedlock(pthread_mutex_t * _Nonnull __mutex, 248 const struct timespec * _Nonnull) 249 __trylocks_exclusive(0, *__mutex); 250 int pthread_mutex_unlock(pthread_mutex_t * _Nonnull __mutex) 251 __unlocks(*__mutex); 252 int pthread_once(pthread_once_t * _Nonnull, 253 void (* _Nonnull) (void)); 254 int pthread_rwlock_destroy(pthread_rwlock_t * _Nonnull __rwlock) 255 __requires_unlocked(*__rwlock); 256 int pthread_rwlock_init(pthread_rwlock_t * _Nonnull __rwlock, 257 const pthread_rwlockattr_t *) 258 __requires_unlocked(*__rwlock); 259 int pthread_rwlock_rdlock(pthread_rwlock_t * _Nonnull __rwlock) 260 __locks_shared(*__rwlock); 261 int pthread_rwlock_timedrdlock(pthread_rwlock_t * _Nonnull __rwlock, 262 const struct timespec * _Nonnull) 263 __trylocks_shared(0, *__rwlock); 264 int pthread_rwlock_timedwrlock(pthread_rwlock_t * _Nonnull __rwlock, 265 const struct timespec * _Nonnull) 266 __trylocks_exclusive(0, *__rwlock); 267 int pthread_rwlock_tryrdlock(pthread_rwlock_t * _Nonnull __rwlock) 268 __trylocks_shared(0, *__rwlock); 269 int pthread_rwlock_trywrlock(pthread_rwlock_t * _Nonnull __rwlock) 270 __trylocks_exclusive(0, *__rwlock); 271 int pthread_rwlock_unlock(pthread_rwlock_t * _Nonnull __rwlock) 272 __unlocks(*__rwlock); 273 int pthread_rwlock_wrlock(pthread_rwlock_t * _Nonnull __rwlock) 274 __locks_exclusive(*__rwlock); 275 int pthread_rwlockattr_destroy(pthread_rwlockattr_t * _Nonnull); 276 int pthread_rwlockattr_getkind_np( 277 const pthread_rwlockattr_t * _Nonnull, int *); 278 int pthread_rwlockattr_getpshared( 279 const pthread_rwlockattr_t * _Nonnull, int * _Nonnull); 280 int pthread_rwlockattr_init(pthread_rwlockattr_t * _Nonnull); 281 int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t * _Nonnull, 282 int); 283 int pthread_rwlockattr_setpshared(pthread_rwlockattr_t * _Nonnull, 284 int); 285 pthread_t pthread_self(void); 286 int pthread_setspecific(pthread_key_t, const void *); 287 288 int pthread_spin_init(pthread_spinlock_t * _Nonnull __spin, int) 289 __requires_unlocked(*__spin); 290 int pthread_spin_destroy(pthread_spinlock_t * _Nonnull __spin) 291 __requires_unlocked(*__spin); 292 int pthread_spin_lock(pthread_spinlock_t * _Nonnull __spin) 293 __locks_exclusive(*__spin); 294 int pthread_spin_trylock(pthread_spinlock_t * _Nonnull __spin) 295 __trylocks_exclusive(0, *__spin); 296 int pthread_spin_unlock(pthread_spinlock_t * _Nonnull __spin) 297 __unlocks(*__spin); 298 int pthread_cancel(pthread_t); 299 int pthread_setcancelstate(int, int *); 300 int pthread_setcanceltype(int, int *); 301 void pthread_testcancel(void); 302 303 #if __BSD_VISIBLE 304 int pthread_getprio(pthread_t); 305 int pthread_setprio(pthread_t, int); 306 void pthread_yield(void); 307 #endif 308 309 int pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, int *); 310 int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int); 311 int pthread_mutex_getprioceiling(pthread_mutex_t *, int *); 312 int pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *); 313 314 int pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *); 315 int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 316 317 int pthread_mutexattr_getrobust( 318 pthread_mutexattr_t * _Nonnull __restrict, 319 int * _Nonnull __restrict); 320 int pthread_mutexattr_setrobust(pthread_mutexattr_t * _Nonnull, 321 int); 322 323 int pthread_attr_getinheritsched(const pthread_attr_t *, int *); 324 int pthread_attr_getschedparam(const pthread_attr_t * _Nonnull, 325 struct sched_param * _Nonnull); 326 int pthread_attr_getschedpolicy(const pthread_attr_t * _Nonnull, 327 int * _Nonnull); 328 int pthread_attr_getscope(const pthread_attr_t * _Nonnull, 329 int * _Nonnull); 330 int pthread_attr_setinheritsched(pthread_attr_t *, int); 331 int pthread_attr_setschedparam(pthread_attr_t * _Nonnull, 332 const struct sched_param * _Nonnull); 333 int pthread_attr_setschedpolicy(pthread_attr_t * _Nonnull, int); 334 int pthread_attr_setscope(pthread_attr_t * _Nonnull, int); 335 int pthread_getschedparam(pthread_t pthread, int * _Nonnull, 336 struct sched_param * _Nonnull); 337 int pthread_setschedparam(pthread_t, int, 338 const struct sched_param * _Nonnull); 339 #if __XSI_VISIBLE 340 int pthread_getconcurrency(void); 341 int pthread_setconcurrency(int); 342 #endif 343 344 void __pthread_cleanup_push_imp(void (*)(void *), void *, 345 struct _pthread_cleanup_info *); 346 void __pthread_cleanup_pop_imp(int); 347 __END_DECLS 348 __NULLABILITY_PRAGMA_POP 349 350 #endif /* !_PTHREAD_H_ */ 351