1 /*- 2 * SPDX-License-Identifier: BSD-4-Clause 3 * 4 * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu 5 * Copyright (c) 1995-1998 by John Birrell <jb@cimlogic.com.au> 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by Chris Provenzano. 19 * 4. The name of Chris Provenzano may not be used to endorse or promote 20 * products derived from this software without specific prior written 21 * permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY CHRIS PROVENZANO ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL CHRIS PROVENZANO BE LIABLE FOR ANY 27 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 29 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 30 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 * 35 * $FreeBSD$ 36 */ 37 #ifndef _PTHREAD_H_ 38 #define _PTHREAD_H_ 39 40 /* 41 * Header files. 42 */ 43 #include <sys/cdefs.h> 44 #include <sys/_pthreadtypes.h> 45 #include <machine/_limits.h> 46 #include <machine/_types.h> 47 #include <sys/_sigset.h> 48 #include <sched.h> 49 #include <time.h> 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 *); 153 int pthread_attr_getstack( 154 const pthread_attr_t * __restrict, void ** __restrict, 155 size_t * __restrict); 156 int pthread_attr_getstacksize(const pthread_attr_t * __restrict, 157 size_t * __restrict); 158 int pthread_attr_getguardsize(const pthread_attr_t * __restrict, 159 size_t * __restrict); 160 int pthread_attr_getstackaddr(const pthread_attr_t *, void **); 161 int pthread_attr_getdetachstate(const pthread_attr_t *, 162 int *); 163 int pthread_attr_init(pthread_attr_t *); 164 int pthread_attr_setstacksize(pthread_attr_t *, size_t); 165 int pthread_attr_setguardsize(pthread_attr_t *, size_t); 166 int pthread_attr_setstack(pthread_attr_t *, void *, 167 size_t); 168 int pthread_attr_setstackaddr(pthread_attr_t *, void *); 169 int pthread_attr_setdetachstate(pthread_attr_t *, int); 170 int pthread_barrier_destroy(pthread_barrier_t *); 171 int pthread_barrier_init(pthread_barrier_t * __restrict, 172 const pthread_barrierattr_t * __restrict, unsigned); 173 int pthread_barrier_wait(pthread_barrier_t *); 174 int pthread_barrierattr_destroy(pthread_barrierattr_t *); 175 int pthread_barrierattr_getpshared( 176 const pthread_barrierattr_t * __restrict, int * __restrict); 177 int pthread_barrierattr_init(pthread_barrierattr_t *); 178 int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 179 180 #define pthread_cleanup_push(cleanup_routine, cleanup_arg) \ 181 { \ 182 struct _pthread_cleanup_info __cleanup_info__; \ 183 __pthread_cleanup_push_imp(cleanup_routine, cleanup_arg,\ 184 &__cleanup_info__); \ 185 { 186 187 #define pthread_cleanup_pop(execute) \ 188 (void)0; \ 189 } \ 190 __pthread_cleanup_pop_imp(execute); \ 191 } 192 193 int pthread_condattr_destroy(pthread_condattr_t *); 194 int pthread_condattr_getclock(const pthread_condattr_t * __restrict, 195 clockid_t * __restrict); 196 int pthread_condattr_getpshared(const pthread_condattr_t *, int *); 197 int pthread_condattr_init(pthread_condattr_t *); 198 int pthread_condattr_setclock(pthread_condattr_t *, clockid_t); 199 int pthread_condattr_setpshared(pthread_condattr_t *, int); 200 int pthread_cond_broadcast(pthread_cond_t *); 201 int pthread_cond_destroy(pthread_cond_t *); 202 int pthread_cond_init(pthread_cond_t * __restrict, 203 const pthread_condattr_t * __restrict); 204 int pthread_cond_signal(pthread_cond_t *); 205 int pthread_cond_timedwait(pthread_cond_t *, 206 pthread_mutex_t * __mutex, 207 const struct timespec *) 208 __requires_exclusive(*__mutex); 209 int pthread_cond_wait(pthread_cond_t * __restrict, 210 pthread_mutex_t * __restrict __mutex) 211 __requires_exclusive(*__mutex); 212 int pthread_create(pthread_t * __restrict, 213 const pthread_attr_t * __restrict, void *(*) (void *), 214 void * __restrict); 215 int pthread_detach(pthread_t); 216 int pthread_equal(pthread_t, pthread_t); 217 void pthread_exit(void *) __dead2; 218 void *pthread_getspecific(pthread_key_t); 219 int pthread_getcpuclockid(pthread_t, clockid_t *); 220 int pthread_join(pthread_t, void **); 221 int pthread_key_create(pthread_key_t *, void (*) (void *)); 222 int pthread_key_delete(pthread_key_t); 223 int pthread_mutexattr_init(pthread_mutexattr_t *); 224 int pthread_mutexattr_destroy(pthread_mutexattr_t *); 225 int pthread_mutexattr_getpshared( 226 const pthread_mutexattr_t * __restrict, 227 int * __restrict); 228 int pthread_mutexattr_gettype( 229 const pthread_mutexattr_t * __restrict, int * __restrict); 230 int pthread_mutexattr_settype(pthread_mutexattr_t *, int); 231 int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int); 232 int pthread_mutex_consistent(pthread_mutex_t * __mutex) 233 __requires_exclusive(*__mutex); 234 int pthread_mutex_destroy(pthread_mutex_t * __mutex) 235 __requires_unlocked(*__mutex); 236 int pthread_mutex_init(pthread_mutex_t * __restrict __mutex, 237 const pthread_mutexattr_t * __restrict) 238 __requires_unlocked(*__mutex); 239 int pthread_mutex_lock(pthread_mutex_t * __mutex) 240 __locks_exclusive(*__mutex); 241 int pthread_mutex_trylock(pthread_mutex_t * __mutex) 242 __trylocks_exclusive(0, *__mutex); 243 int pthread_mutex_timedlock(pthread_mutex_t * __restrict __mutex, 244 const struct timespec * __restrict) 245 __trylocks_exclusive(0, *__mutex); 246 int pthread_mutex_unlock(pthread_mutex_t * __mutex) 247 __unlocks(*__mutex); 248 int pthread_once(pthread_once_t *, void (*) (void)); 249 int pthread_rwlock_destroy(pthread_rwlock_t * __rwlock) 250 __requires_unlocked(*__rwlock); 251 int pthread_rwlock_init(pthread_rwlock_t * __restrict __rwlock, 252 const pthread_rwlockattr_t * __restrict) 253 __requires_unlocked(*__rwlock); 254 int pthread_rwlock_rdlock(pthread_rwlock_t * __rwlock) 255 __locks_shared(*__rwlock); 256 int pthread_rwlock_timedrdlock( 257 pthread_rwlock_t * __restrict __rwlock, 258 const struct timespec * __restrict) 259 __trylocks_shared(0, *__rwlock); 260 int pthread_rwlock_timedwrlock( 261 pthread_rwlock_t * __restrict __rwlock, 262 const struct timespec * __restrict) 263 __trylocks_exclusive(0, *__rwlock); 264 int pthread_rwlock_tryrdlock(pthread_rwlock_t * __rwlock) 265 __trylocks_shared(0, *__rwlock); 266 int pthread_rwlock_trywrlock(pthread_rwlock_t * __rwlock) 267 __trylocks_exclusive(0, *__rwlock); 268 int pthread_rwlock_unlock(pthread_rwlock_t * __rwlock) 269 __unlocks(*__rwlock); 270 int pthread_rwlock_wrlock(pthread_rwlock_t * __rwlock) 271 __locks_exclusive(*__rwlock); 272 int pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 273 int pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t *, 274 int *); 275 int pthread_rwlockattr_getpshared( 276 const pthread_rwlockattr_t * __restrict, 277 int * __restrict); 278 int pthread_rwlockattr_init(pthread_rwlockattr_t *); 279 int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t *, 280 int); 281 int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int); 282 pthread_t pthread_self(void); 283 int pthread_setspecific(pthread_key_t, const void *); 284 285 int pthread_spin_init(pthread_spinlock_t * __spin, int) 286 __requires_unlocked(*__spin); 287 int pthread_spin_destroy(pthread_spinlock_t * __spin) 288 __requires_unlocked(*__spin); 289 int pthread_spin_lock(pthread_spinlock_t * __spin) 290 __locks_exclusive(*__spin); 291 int pthread_spin_trylock(pthread_spinlock_t * __spin) 292 __trylocks_exclusive(0, *__spin); 293 int pthread_spin_unlock(pthread_spinlock_t * __spin) 294 __unlocks(*__spin); 295 int pthread_cancel(pthread_t); 296 int pthread_setcancelstate(int, int *); 297 int pthread_setcanceltype(int, int *); 298 void pthread_testcancel(void); 299 300 #if __BSD_VISIBLE 301 int pthread_getprio(pthread_t); 302 int pthread_setprio(pthread_t, int); 303 void pthread_yield(void); 304 305 int pthread_getname_np(pthread_t, char *, size_t); 306 int pthread_setname_np(pthread_t, const char *); 307 #endif 308 309 int pthread_mutexattr_getprioceiling( 310 const pthread_mutexattr_t * __restrict, 311 int * __restrict); 312 int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int); 313 int pthread_mutex_getprioceiling(const pthread_mutex_t * __restrict, 314 int * __restrict); 315 int pthread_mutex_setprioceiling(pthread_mutex_t * __restrict, int, 316 int * __restrict); 317 318 int pthread_mutexattr_getprotocol( 319 const pthread_mutexattr_t * __restrict, 320 int * __restrict); 321 int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 322 323 int pthread_mutexattr_getrobust( 324 pthread_mutexattr_t * __restrict, int * __restrict); 325 int pthread_mutexattr_setrobust(pthread_mutexattr_t *, int); 326 327 int pthread_attr_getinheritsched(const pthread_attr_t * __restrict, 328 int * __restrict); 329 int pthread_attr_getschedparam(const pthread_attr_t *, 330 struct sched_param *); 331 int pthread_attr_getschedpolicy(const pthread_attr_t * __restrict, 332 int * __restrict); 333 int pthread_attr_getscope(const pthread_attr_t * __restrict, 334 int * __restrict); 335 int pthread_attr_setinheritsched(pthread_attr_t *, int); 336 int pthread_attr_setschedparam(pthread_attr_t *, 337 const struct sched_param *); 338 int pthread_attr_setschedpolicy(pthread_attr_t *, int); 339 int pthread_attr_setscope(pthread_attr_t *, int); 340 int pthread_getschedparam(pthread_t pthread, int * __restrict, 341 struct sched_param * __restrict); 342 int pthread_setschedparam(pthread_t, int, 343 const struct sched_param *); 344 #if __XSI_VISIBLE 345 int pthread_getconcurrency(void); 346 int pthread_setconcurrency(int); 347 #endif 348 349 void __pthread_cleanup_push_imp(void (*)(void *), void *, 350 struct _pthread_cleanup_info *); 351 void __pthread_cleanup_pop_imp(int); 352 __END_DECLS 353 354 #endif /* !_PTHREAD_H_ */ 355