1 /* 2 * Copyright (C) 2008 The Android Open Source Project 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in 12 * the documentation and/or other materials provided with the 13 * distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #ifndef _PTHREAD_H_ 30 #define _PTHREAD_H_ 31 32 #include <limits.h> 33 #include <bits/pthread_types.h> 34 #include <sched.h> 35 #include <sys/cdefs.h> 36 #include <sys/types.h> 37 #include <time.h> 38 39 __BEGIN_DECLS 40 41 enum { 42 PTHREAD_MUTEX_NORMAL = 0, 43 PTHREAD_MUTEX_RECURSIVE = 1, 44 PTHREAD_MUTEX_ERRORCHECK = 2, 45 46 PTHREAD_MUTEX_ERRORCHECK_NP = PTHREAD_MUTEX_ERRORCHECK, 47 PTHREAD_MUTEX_RECURSIVE_NP = PTHREAD_MUTEX_RECURSIVE, 48 49 PTHREAD_MUTEX_DEFAULT = PTHREAD_MUTEX_NORMAL 50 }; 51 52 #define PTHREAD_MUTEX_INITIALIZER { { ((PTHREAD_MUTEX_NORMAL & 3) << 14) } } 53 #define PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP { { ((PTHREAD_MUTEX_RECURSIVE & 3) << 14) } } 54 #define PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP { { ((PTHREAD_MUTEX_ERRORCHECK & 3) << 14) } } 55 56 #define PTHREAD_COND_INITIALIZER { { 0 } } 57 #if __ANDROID_API__ >= 21 58 #define PTHREAD_COND_INITIALIZER_MONOTONIC_NP { { 1 << 1 } } 59 #endif 60 61 #define PTHREAD_RWLOCK_INITIALIZER { { 0 } } 62 63 enum { 64 PTHREAD_RWLOCK_PREFER_READER_NP = 0, 65 PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP = 1, 66 }; 67 68 #define PTHREAD_ONCE_INIT 0 69 70 #if __ANDROID_API__ >= 24 71 #define PTHREAD_BARRIER_SERIAL_THREAD (-1) 72 #endif 73 74 #if defined(__LP64__) 75 #define PTHREAD_STACK_MIN (4 * PAGE_SIZE) 76 #else 77 #define PTHREAD_STACK_MIN (2 * PAGE_SIZE) 78 #endif 79 80 #define PTHREAD_CREATE_DETACHED 1 81 #define PTHREAD_CREATE_JOINABLE 0 82 83 #define PTHREAD_EXPLICIT_SCHED 0 84 #define PTHREAD_INHERIT_SCHED 1 85 86 #define PTHREAD_PRIO_NONE 0 87 #define PTHREAD_PRIO_INHERIT 1 88 89 #define PTHREAD_PROCESS_PRIVATE 0 90 #define PTHREAD_PROCESS_SHARED 1 91 92 #define PTHREAD_SCOPE_SYSTEM 0 93 #define PTHREAD_SCOPE_PROCESS 1 94 95 int pthread_atfork(void (*__prepare)(void), void (*__parent)(void), void (*__child)(void)); 96 97 int pthread_attr_destroy(pthread_attr_t* __attr); 98 int pthread_attr_getdetachstate(const pthread_attr_t* __attr, int* __state); 99 int pthread_attr_getguardsize(const pthread_attr_t* __attr, size_t* __size); 100 int pthread_attr_getinheritsched(const pthread_attr_t* __attr, int* __flag) __INTRODUCED_IN(28); 101 int pthread_attr_getschedparam(const pthread_attr_t* __attr, struct sched_param* __param); 102 int pthread_attr_getschedpolicy(const pthread_attr_t* __attr, int* __policy); 103 int pthread_attr_getscope(const pthread_attr_t* __attr, int* __scope); 104 int pthread_attr_getstack(const pthread_attr_t* __attr, void** __addr, size_t* __size); 105 int pthread_attr_getstacksize(const pthread_attr_t* __attr, size_t* __size); 106 int pthread_attr_init(pthread_attr_t* __attr); 107 int pthread_attr_setdetachstate(pthread_attr_t* __attr, int __state); 108 int pthread_attr_setguardsize(pthread_attr_t* __attr, size_t __size); 109 int pthread_attr_setinheritsched(pthread_attr_t* __attr, int __flag) __INTRODUCED_IN(28); 110 int pthread_attr_setschedparam(pthread_attr_t* __attr, const struct sched_param* __param); 111 int pthread_attr_setschedpolicy(pthread_attr_t* __attr, int __policy); 112 int pthread_attr_setscope(pthread_attr_t* __attr, int __scope); 113 int pthread_attr_setstack(pthread_attr_t* __attr, void* __addr, size_t __size); 114 int pthread_attr_setstacksize(pthread_attr_t* __addr, size_t __size); 115 116 int pthread_condattr_destroy(pthread_condattr_t* __attr); 117 int pthread_condattr_getclock(const pthread_condattr_t* __attr, clockid_t* __clock) __INTRODUCED_IN(21); 118 int pthread_condattr_getpshared(const pthread_condattr_t* __attr, int* __shared); 119 int pthread_condattr_init(pthread_condattr_t* __attr); 120 int pthread_condattr_setclock(pthread_condattr_t* __attr, clockid_t __clock) __INTRODUCED_IN(21); 121 int pthread_condattr_setpshared(pthread_condattr_t* __attr, int __shared); 122 123 int pthread_cond_broadcast(pthread_cond_t* __cond); 124 int pthread_cond_clockwait(pthread_cond_t* __cond, pthread_mutex_t* __mutex, clockid_t __clock, 125 const struct timespec* __timeout) __INTRODUCED_IN(30); 126 int pthread_cond_destroy(pthread_cond_t* __cond); 127 int pthread_cond_init(pthread_cond_t* __cond, const pthread_condattr_t* __attr); 128 int pthread_cond_signal(pthread_cond_t* __cond); 129 int pthread_cond_timedwait(pthread_cond_t* __cond, pthread_mutex_t* __mutex, const struct timespec* __timeout); 130 /* 131 * Condition variables use CLOCK_REALTIME by default for their timeouts, however that is 132 * typically inappropriate, since that clock can change dramatically, causing the timeout to 133 * either expire earlier or much later than intended. 134 * Condition variables have an initialization option to use CLOCK_MONOTONIC, and in addition, 135 * Android provides pthread_cond_timedwait_monotonic_np to use CLOCK_MONOTONIC on a condition 136 * variable for this single wait no matter how it was initialized. 137 * Note that pthread_cond_clockwait() allows specifying an arbitrary clock and has superseded this 138 * function. 139 */ 140 int pthread_cond_timedwait_monotonic_np(pthread_cond_t* __cond, pthread_mutex_t* __mutex, 141 const struct timespec* __timeout) __INTRODUCED_IN_64(28); 142 int pthread_cond_wait(pthread_cond_t* __cond, pthread_mutex_t* __mutex); 143 144 #if defined(__clang__) 145 /* 146 * Disable -Wbuiltin-requires-header because clang confuses this declaration with the one defined in 147 * "llvm/tools/clang/include/clang/Basic/Builtins.def", which did not define any formal arguments. 148 * It seems to be an upstream bug and the fix (https://reviews.llvm.org/D58531) is still under 149 * review. Thus, let's disable the warning for this function declaration. 150 */ 151 #pragma clang diagnostic push 152 #pragma clang diagnostic ignored "-Wbuiltin-requires-header" 153 #endif 154 int pthread_create(pthread_t* __pthread_ptr, pthread_attr_t const* __attr, void* (*__start_routine)(void*), void*); 155 #if defined(__clang__) 156 #pragma clang diagnostic pop 157 #endif 158 159 int pthread_detach(pthread_t __pthread); 160 void pthread_exit(void* __return_value) __noreturn; 161 162 int pthread_equal(pthread_t __lhs, pthread_t __rhs); 163 164 int pthread_getattr_np(pthread_t __pthread, pthread_attr_t* __attr); 165 166 int pthread_getcpuclockid(pthread_t __pthread, clockid_t* __clock); 167 168 int pthread_getschedparam(pthread_t __pthread, int* __policy, struct sched_param* __param); 169 170 void* pthread_getspecific(pthread_key_t __key); 171 172 pid_t pthread_gettid_np(pthread_t __pthread) __INTRODUCED_IN(21); 173 174 int pthread_join(pthread_t __pthread, void** __return_value_ptr); 175 176 int pthread_key_create(pthread_key_t* __key_ptr, void (*__key_destructor)(void*)); 177 int pthread_key_delete(pthread_key_t __key); 178 179 int pthread_mutexattr_destroy(pthread_mutexattr_t* __attr); 180 int pthread_mutexattr_getpshared(const pthread_mutexattr_t* __attr, int* __shared); 181 int pthread_mutexattr_gettype(const pthread_mutexattr_t* __attr, int* __type); 182 int pthread_mutexattr_getprotocol(const pthread_mutexattr_t* __attr, int* __protocol) __INTRODUCED_IN(28); 183 int pthread_mutexattr_init(pthread_mutexattr_t* __attr); 184 int pthread_mutexattr_setpshared(pthread_mutexattr_t* __attr, int __shared); 185 int pthread_mutexattr_settype(pthread_mutexattr_t* __attr, int __type); 186 int pthread_mutexattr_setprotocol(pthread_mutexattr_t* __attr, int __protocol) __INTRODUCED_IN(28); 187 188 int pthread_mutex_clocklock(pthread_mutex_t* __mutex, clockid_t __clock, 189 const struct timespec* __abstime) __INTRODUCED_IN(30); 190 int pthread_mutex_destroy(pthread_mutex_t* __mutex); 191 int pthread_mutex_init(pthread_mutex_t* __mutex, const pthread_mutexattr_t* __attr); 192 int pthread_mutex_lock(pthread_mutex_t* __mutex); 193 int pthread_mutex_timedlock(pthread_mutex_t* __mutex, const struct timespec* __timeout) 194 __INTRODUCED_IN(21); 195 196 /* 197 * POSIX historically only supported using pthread_mutex_timedlock() with CLOCK_REALTIME, however 198 * that is typically inappropriate, since that clock can change dramatically, causing the timeout to 199 * either expire earlier or much later than intended. 200 * This function is added to use a timespec based on CLOCK_MONOTONIC that does not suffer 201 * from this issue. 202 * Note that pthread_mutex_clocklock() allows specifying an arbitrary clock and has superseded this 203 * function. 204 */ 205 int pthread_mutex_timedlock_monotonic_np(pthread_mutex_t* __mutex, const struct timespec* __timeout) 206 __INTRODUCED_IN(28); 207 int pthread_mutex_trylock(pthread_mutex_t* __mutex); 208 int pthread_mutex_unlock(pthread_mutex_t* __mutex); 209 210 #if __ANDROID_API__ < 21 211 /* 212 * Cruft for supporting old API levels. Pre-L we didn't have the proper POSIX 213 * APIs for things, but instead had some locally grown, artisan equivalents. 214 * Keep exposing the old prototypes on old API levels so we don't regress 215 * functionality. 216 * 217 * See the following bugs: 218 * * https://github.com/android-ndk/ndk/issues/420 219 * * https://github.com/android-ndk/ndk/issues/423 220 * * https://stackoverflow.com/q/44580542/632035 221 */ 222 int pthread_mutex_lock_timeout_np(pthread_mutex_t* __mutex, unsigned __timeout_ms); 223 int pthread_cond_timeout_np(pthread_cond_t* __cond, pthread_mutex_t* __mutex, unsigned __timeout_ms); 224 int pthread_cond_timedwait_relative_np(pthread_cond_t* __cond, pthread_mutex_t* __mutex, const struct timespec* __relative_timeout); 225 #endif 226 227 int pthread_once(pthread_once_t* __once, void (*__init_routine)(void)); 228 229 int pthread_rwlockattr_init(pthread_rwlockattr_t* __attr); 230 int pthread_rwlockattr_destroy(pthread_rwlockattr_t* __attr); 231 int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t* __attr, int* __shared); 232 int pthread_rwlockattr_setpshared(pthread_rwlockattr_t* __attr, int __shared); 233 int pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t* __attr, int* __kind) 234 __INTRODUCED_IN(23); 235 int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t* __attr, int __kind) __INTRODUCED_IN(23); 236 237 int pthread_rwlock_clockrdlock(pthread_rwlock_t* __rwlock, clockid_t __clock, 238 const struct timespec* __timeout) __INTRODUCED_IN(30); 239 int pthread_rwlock_clockwrlock(pthread_rwlock_t* __rwlock, clockid_t __clock, 240 const struct timespec* __timeout) __INTRODUCED_IN(30); 241 int pthread_rwlock_destroy(pthread_rwlock_t* __rwlock); 242 int pthread_rwlock_init(pthread_rwlock_t* __rwlock, const pthread_rwlockattr_t* __attr); 243 int pthread_rwlock_rdlock(pthread_rwlock_t* __rwlock); 244 int pthread_rwlock_timedrdlock(pthread_rwlock_t* __rwlock, const struct timespec* __timeout); 245 /* See the comment on pthread_mutex_timedlock_monotonic_np for usage of this function. */ 246 int pthread_rwlock_timedrdlock_monotonic_np(pthread_rwlock_t* __rwlock, 247 const struct timespec* __timeout) __INTRODUCED_IN(28); 248 int pthread_rwlock_timedwrlock(pthread_rwlock_t* __rwlock, const struct timespec* __timeout); 249 /* See the comment on pthread_mutex_timedlock_monotonic_np for usage of this function. */ 250 int pthread_rwlock_timedwrlock_monotonic_np(pthread_rwlock_t* __rwlock, 251 const struct timespec* __timeout) __INTRODUCED_IN(28); 252 int pthread_rwlock_tryrdlock(pthread_rwlock_t* __rwlock); 253 int pthread_rwlock_trywrlock(pthread_rwlock_t* __rwlock); 254 int pthread_rwlock_unlock(pthread_rwlock_t* __rwlock); 255 int pthread_rwlock_wrlock(pthread_rwlock_t* __rwlock); 256 257 #if __ANDROID_API__ >= 24 258 int pthread_barrierattr_init(pthread_barrierattr_t* __attr) __INTRODUCED_IN(24); 259 int pthread_barrierattr_destroy(pthread_barrierattr_t* __attr) __INTRODUCED_IN(24); 260 int pthread_barrierattr_getpshared(const pthread_barrierattr_t* __attr, int* __shared) __INTRODUCED_IN(24); 261 int pthread_barrierattr_setpshared(pthread_barrierattr_t* __attr, int __shared) __INTRODUCED_IN(24); 262 #endif 263 264 #if __ANDROID_API__ >= 24 265 int pthread_barrier_init(pthread_barrier_t* __barrier, const pthread_barrierattr_t* __attr, unsigned __count) __INTRODUCED_IN(24); 266 int pthread_barrier_destroy(pthread_barrier_t* __barrier) __INTRODUCED_IN(24); 267 int pthread_barrier_wait(pthread_barrier_t* __barrier) __INTRODUCED_IN(24); 268 #endif 269 270 #if __ANDROID_API__ >= 24 271 int pthread_spin_destroy(pthread_spinlock_t* __spinlock) __INTRODUCED_IN(24); 272 int pthread_spin_init(pthread_spinlock_t* __spinlock, int __shared) __INTRODUCED_IN(24); 273 int pthread_spin_lock(pthread_spinlock_t* __spinlock) __INTRODUCED_IN(24); 274 int pthread_spin_trylock(pthread_spinlock_t* __spinlock) __INTRODUCED_IN(24); 275 int pthread_spin_unlock(pthread_spinlock_t* __spinlock) __INTRODUCED_IN(24); 276 #endif 277 278 pthread_t pthread_self(void) __attribute_const__; 279 280 #if defined(__USE_GNU) 281 int pthread_getname_np(pthread_t __pthread, char* __buf, size_t __n) __INTRODUCED_IN(26); 282 #endif 283 /* TODO: this should be __USE_GNU too. */ 284 int pthread_setname_np(pthread_t __pthread, const char* __name); 285 286 int pthread_setschedparam(pthread_t __pthread, int __policy, const struct sched_param* __param); 287 int pthread_setschedprio(pthread_t __pthread, int __priority) __INTRODUCED_IN(28); 288 289 int pthread_setspecific(pthread_key_t __key, const void* __value); 290 291 typedef void (*__pthread_cleanup_func_t)(void*); 292 293 typedef struct __pthread_cleanup_t { 294 struct __pthread_cleanup_t* __cleanup_prev; 295 __pthread_cleanup_func_t __cleanup_routine; 296 void* __cleanup_arg; 297 } __pthread_cleanup_t; 298 299 void __pthread_cleanup_push(__pthread_cleanup_t* c, __pthread_cleanup_func_t, void*); 300 void __pthread_cleanup_pop(__pthread_cleanup_t*, int); 301 302 /* Believe or not, the definitions of pthread_cleanup_push and 303 * pthread_cleanup_pop below are correct. Posix states that these 304 * can be implemented as macros that might introduce opening and 305 * closing braces, and that using setjmp/longjmp/return/break/continue 306 * between them results in undefined behavior. 307 */ 308 #define pthread_cleanup_push(routine, arg) \ 309 do { \ 310 __pthread_cleanup_t __cleanup; \ 311 __pthread_cleanup_push( &__cleanup, (routine), (arg) ); \ 312 313 #define pthread_cleanup_pop(execute) \ 314 __pthread_cleanup_pop( &__cleanup, (execute)); \ 315 } while (0); \ 316 317 __END_DECLS 318 319 #endif 320