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 #pragma once 30 31 /** 32 * @file pthread.h 33 * @brief POSIX threads. 34 */ 35 36 #include <limits.h> 37 #include <bits/pthread_types.h> 38 #include <sched.h> 39 #include <sys/cdefs.h> 40 #include <sys/types.h> 41 #include <time.h> 42 43 __BEGIN_DECLS 44 45 enum { 46 PTHREAD_MUTEX_NORMAL = 0, 47 PTHREAD_MUTEX_RECURSIVE = 1, 48 PTHREAD_MUTEX_ERRORCHECK = 2, 49 50 PTHREAD_MUTEX_ERRORCHECK_NP = PTHREAD_MUTEX_ERRORCHECK, 51 PTHREAD_MUTEX_RECURSIVE_NP = PTHREAD_MUTEX_RECURSIVE, 52 53 PTHREAD_MUTEX_DEFAULT = PTHREAD_MUTEX_NORMAL 54 }; 55 56 #define PTHREAD_MUTEX_INITIALIZER { { ((PTHREAD_MUTEX_NORMAL & 3) << 14) } } 57 #define PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP { { ((PTHREAD_MUTEX_RECURSIVE & 3) << 14) } } 58 #define PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP { { ((PTHREAD_MUTEX_ERRORCHECK & 3) << 14) } } 59 60 #define PTHREAD_COND_INITIALIZER { { 0 } } 61 #define PTHREAD_COND_INITIALIZER_MONOTONIC_NP { { 1 << 1 } } 62 63 #define PTHREAD_RWLOCK_INITIALIZER { { 0 } } 64 65 enum { 66 PTHREAD_RWLOCK_PREFER_READER_NP = 0, 67 PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP = 1, 68 }; 69 70 #define PTHREAD_ONCE_INIT 0 71 72 #if __ANDROID_API__ >= 24 73 #define PTHREAD_BARRIER_SERIAL_THREAD (-1) 74 #endif 75 76 #if defined(__LP64__) 77 #define PTHREAD_STACK_MIN (4 * PAGE_SIZE) 78 #else 79 #define PTHREAD_STACK_MIN (2 * PAGE_SIZE) 80 #endif 81 82 #define PTHREAD_CREATE_DETACHED 1 83 #define PTHREAD_CREATE_JOINABLE 0 84 85 #define PTHREAD_EXPLICIT_SCHED 0 86 #define PTHREAD_INHERIT_SCHED 1 87 88 #define PTHREAD_PRIO_NONE 0 89 #define PTHREAD_PRIO_INHERIT 1 90 91 #define PTHREAD_PROCESS_PRIVATE 0 92 #define PTHREAD_PROCESS_SHARED 1 93 94 #define PTHREAD_SCOPE_SYSTEM 0 95 #define PTHREAD_SCOPE_PROCESS 1 96 97 int pthread_atfork(void (* _Nullable __prepare)(void), void (* _Nullable __parent)(void), void (* _Nullable __child)(void)); 98 99 int pthread_attr_destroy(pthread_attr_t* _Nonnull __attr); 100 int pthread_attr_getdetachstate(const pthread_attr_t* _Nonnull __attr, int* _Nonnull __state); 101 int pthread_attr_getguardsize(const pthread_attr_t* _Nonnull __attr, size_t* _Nonnull __size); 102 103 #if __ANDROID_API__ >= 28 104 int pthread_attr_getinheritsched(const pthread_attr_t* _Nonnull __attr, int* _Nonnull __flag) __INTRODUCED_IN(28); 105 #endif /* __ANDROID_API__ >= 28 */ 106 107 int pthread_attr_getschedparam(const pthread_attr_t* _Nonnull __attr, struct sched_param* _Nonnull __param); 108 int pthread_attr_getschedpolicy(const pthread_attr_t* _Nonnull __attr, int* _Nonnull __policy); 109 int pthread_attr_getscope(const pthread_attr_t* _Nonnull __attr, int* _Nonnull __scope); 110 int pthread_attr_getstack(const pthread_attr_t* _Nonnull __attr, void* _Nullable * _Nonnull __addr, size_t* _Nonnull __size); 111 int pthread_attr_getstacksize(const pthread_attr_t* _Nonnull __attr, size_t* _Nonnull __size); 112 int pthread_attr_init(pthread_attr_t* _Nonnull __attr); 113 int pthread_attr_setdetachstate(pthread_attr_t* _Nonnull __attr, int __state); 114 int pthread_attr_setguardsize(pthread_attr_t* _Nonnull __attr, size_t __size); 115 116 #if __ANDROID_API__ >= 28 117 int pthread_attr_setinheritsched(pthread_attr_t* _Nonnull __attr, int __flag) __INTRODUCED_IN(28); 118 #endif /* __ANDROID_API__ >= 28 */ 119 120 int pthread_attr_setschedparam(pthread_attr_t* _Nonnull __attr, const struct sched_param* _Nonnull __param); 121 int pthread_attr_setschedpolicy(pthread_attr_t* _Nonnull __attr, int __policy); 122 int pthread_attr_setscope(pthread_attr_t* _Nonnull __attr, int __scope); 123 int pthread_attr_setstack(pthread_attr_t* _Nonnull __attr, void* _Nonnull __addr, size_t __size); 124 int pthread_attr_setstacksize(pthread_attr_t* _Nonnull __addr, size_t __size); 125 126 int pthread_condattr_destroy(pthread_condattr_t* _Nonnull __attr); 127 128 #if __ANDROID_API__ >= 21 129 int pthread_condattr_getclock(const pthread_condattr_t* _Nonnull __attr, clockid_t* _Nonnull __clock) __INTRODUCED_IN(21); 130 #endif /* __ANDROID_API__ >= 21 */ 131 132 int pthread_condattr_getpshared(const pthread_condattr_t* _Nonnull __attr, int* _Nonnull __shared); 133 int pthread_condattr_init(pthread_condattr_t* _Nonnull __attr); 134 135 #if __ANDROID_API__ >= 21 136 int pthread_condattr_setclock(pthread_condattr_t* _Nonnull __attr, clockid_t __clock) __INTRODUCED_IN(21); 137 #endif /* __ANDROID_API__ >= 21 */ 138 139 int pthread_condattr_setpshared(pthread_condattr_t* _Nonnull __attr, int __shared); 140 141 int pthread_cond_broadcast(pthread_cond_t* _Nonnull __cond); 142 143 #if __ANDROID_API__ >= 30 144 int pthread_cond_clockwait(pthread_cond_t* _Nonnull __cond, pthread_mutex_t* _Nonnull __mutex, clockid_t __clock, 145 const struct timespec* _Nullable __timeout) __INTRODUCED_IN(30); 146 #endif /* __ANDROID_API__ >= 30 */ 147 148 int pthread_cond_destroy(pthread_cond_t* _Nonnull __cond); 149 int pthread_cond_init(pthread_cond_t* _Nonnull __cond, const pthread_condattr_t* _Nullable __attr); 150 int pthread_cond_signal(pthread_cond_t* _Nonnull __cond); 151 int pthread_cond_timedwait(pthread_cond_t* _Nonnull __cond, pthread_mutex_t* _Nonnull __mutex, const struct timespec* _Nullable __timeout); 152 /* 153 * Condition variables use CLOCK_REALTIME by default for their timeouts, however that is 154 * typically inappropriate, since that clock can change dramatically, causing the timeout to 155 * either expire earlier or much later than intended. 156 * Condition variables have an initialization option to use CLOCK_MONOTONIC, and in addition, 157 * Android provides pthread_cond_timedwait_monotonic_np to use CLOCK_MONOTONIC on a condition 158 * variable for this single wait no matter how it was initialized. 159 * Note that pthread_cond_clockwait() allows specifying an arbitrary clock and has superseded this 160 * function. 161 */ 162 163 #if (!defined(__LP64__)) || (defined(__LP64__)) 164 int pthread_cond_timedwait_monotonic_np(pthread_cond_t* _Nonnull __cond, pthread_mutex_t* _Nonnull __mutex, 165 const struct timespec* _Nullable __timeout) __INTRODUCED_IN_64(28); 166 #endif /* (!defined(__LP64__)) || (defined(__LP64__)) */ 167 168 int pthread_cond_wait(pthread_cond_t* _Nonnull __cond, pthread_mutex_t* _Nonnull __mutex); 169 170 #if defined(__clang__) 171 /* 172 * Disable -Wbuiltin-requires-header because clang confuses this declaration with the one defined in 173 * "llvm/tools/clang/include/clang/Basic/Builtins.def", which did not define any formal arguments. 174 * It seems to be an upstream bug and the fix (https://reviews.llvm.org/D58531) is still under 175 * review. Thus, let's disable the warning for this function declaration. 176 */ 177 #pragma clang diagnostic push 178 #pragma clang diagnostic ignored "-Wbuiltin-requires-header" 179 #endif 180 int pthread_create(pthread_t* _Nonnull __pthread_ptr, pthread_attr_t const* _Nullable __attr, void* _Nonnull (* _Nonnull __start_routine)(void* _Nonnull), void* _Nullable); 181 #if defined(__clang__) 182 #pragma clang diagnostic pop 183 #endif 184 185 int pthread_detach(pthread_t __pthread); 186 void pthread_exit(void* _Nullable __return_value) __noreturn; 187 188 int pthread_equal(pthread_t __lhs, pthread_t __rhs); 189 190 int pthread_getattr_np(pthread_t __pthread, pthread_attr_t* _Nonnull __attr); 191 192 int pthread_getcpuclockid(pthread_t __pthread, clockid_t* _Nonnull __clock); 193 194 void* _Nullable pthread_getspecific(pthread_key_t __key); 195 196 197 #if __ANDROID_API__ >= 21 198 pid_t pthread_gettid_np(pthread_t __pthread) __INTRODUCED_IN(21); 199 #endif /* __ANDROID_API__ >= 21 */ 200 201 202 int pthread_join(pthread_t __pthread, void* _Nullable * _Nullable __return_value_ptr); 203 204 int pthread_key_create(pthread_key_t* _Nonnull __key_ptr, void (* _Nullable __key_destructor)(void* _Nullable)); 205 int pthread_key_delete(pthread_key_t __key); 206 207 int pthread_mutexattr_destroy(pthread_mutexattr_t* _Nonnull __attr); 208 int pthread_mutexattr_getpshared(const pthread_mutexattr_t* _Nonnull __attr, int* _Nonnull __shared); 209 int pthread_mutexattr_gettype(const pthread_mutexattr_t* _Nonnull __attr, int* _Nonnull __type); 210 211 #if __ANDROID_API__ >= 28 212 int pthread_mutexattr_getprotocol(const pthread_mutexattr_t* _Nonnull __attr, int* _Nonnull __protocol) __INTRODUCED_IN(28); 213 #endif /* __ANDROID_API__ >= 28 */ 214 215 int pthread_mutexattr_init(pthread_mutexattr_t* _Nonnull __attr); 216 int pthread_mutexattr_setpshared(pthread_mutexattr_t* _Nonnull __attr, int __shared); 217 int pthread_mutexattr_settype(pthread_mutexattr_t* _Nonnull __attr, int __type); 218 219 #if __ANDROID_API__ >= 28 220 int pthread_mutexattr_setprotocol(pthread_mutexattr_t* _Nonnull __attr, int __protocol) __INTRODUCED_IN(28); 221 #endif /* __ANDROID_API__ >= 28 */ 222 223 224 225 #if __ANDROID_API__ >= 30 226 int pthread_mutex_clocklock(pthread_mutex_t* _Nonnull __mutex, clockid_t __clock, 227 const struct timespec* _Nullable __abstime) __INTRODUCED_IN(30); 228 #endif /* __ANDROID_API__ >= 30 */ 229 230 int pthread_mutex_destroy(pthread_mutex_t* _Nonnull __mutex); 231 int pthread_mutex_init(pthread_mutex_t* _Nonnull __mutex, const pthread_mutexattr_t* _Nullable __attr); 232 int pthread_mutex_lock(pthread_mutex_t* _Nonnull __mutex); 233 234 #if __ANDROID_API__ >= 21 235 int pthread_mutex_timedlock(pthread_mutex_t* _Nonnull __mutex, const struct timespec* _Nullable __timeout) 236 __INTRODUCED_IN(21); 237 #endif /* __ANDROID_API__ >= 21 */ 238 239 240 /* 241 * POSIX historically only supported using pthread_mutex_timedlock() with CLOCK_REALTIME, however 242 * that is typically inappropriate, since that clock can change dramatically, causing the timeout to 243 * either expire earlier or much later than intended. 244 * This function is added to use a timespec based on CLOCK_MONOTONIC that does not suffer 245 * from this issue. 246 * Note that pthread_mutex_clocklock() allows specifying an arbitrary clock and has superseded this 247 * function. 248 */ 249 250 #if __ANDROID_API__ >= 28 251 int pthread_mutex_timedlock_monotonic_np(pthread_mutex_t* _Nonnull __mutex, const struct timespec* _Nullable __timeout) 252 __INTRODUCED_IN(28); 253 #endif /* __ANDROID_API__ >= 28 */ 254 255 int pthread_mutex_trylock(pthread_mutex_t* _Nonnull __mutex); 256 int pthread_mutex_unlock(pthread_mutex_t* _Nonnull __mutex); 257 258 int pthread_once(pthread_once_t* _Nonnull __once, void (* _Nonnull __init_routine)(void)); 259 260 int pthread_rwlockattr_init(pthread_rwlockattr_t* _Nonnull __attr); 261 int pthread_rwlockattr_destroy(pthread_rwlockattr_t* _Nonnull __attr); 262 int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t* _Nonnull __attr, int* _Nonnull __shared); 263 int pthread_rwlockattr_setpshared(pthread_rwlockattr_t* _Nonnull __attr, int __shared); 264 265 #if __ANDROID_API__ >= 23 266 int pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t* _Nonnull __attr, int* _Nonnull __kind) 267 __INTRODUCED_IN(23); 268 int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t* _Nonnull __attr, int __kind) __INTRODUCED_IN(23); 269 #endif /* __ANDROID_API__ >= 23 */ 270 271 272 273 #if __ANDROID_API__ >= 30 274 int pthread_rwlock_clockrdlock(pthread_rwlock_t* _Nonnull __rwlock, clockid_t __clock, 275 const struct timespec* _Nullable __timeout) __INTRODUCED_IN(30); 276 int pthread_rwlock_clockwrlock(pthread_rwlock_t* _Nonnull __rwlock, clockid_t __clock, 277 const struct timespec* _Nullable __timeout) __INTRODUCED_IN(30); 278 #endif /* __ANDROID_API__ >= 30 */ 279 280 int pthread_rwlock_destroy(pthread_rwlock_t* _Nonnull __rwlock); 281 int pthread_rwlock_init(pthread_rwlock_t* _Nonnull __rwlock, const pthread_rwlockattr_t* _Nullable __attr); 282 int pthread_rwlock_rdlock(pthread_rwlock_t* _Nonnull __rwlock); 283 int pthread_rwlock_timedrdlock(pthread_rwlock_t* _Nonnull __rwlock, const struct timespec* _Nullable __timeout); 284 /* See the comment on pthread_mutex_timedlock_monotonic_np for usage of this function. */ 285 286 #if __ANDROID_API__ >= 28 287 int pthread_rwlock_timedrdlock_monotonic_np(pthread_rwlock_t* _Nonnull __rwlock, 288 const struct timespec* _Nullable __timeout) __INTRODUCED_IN(28); 289 #endif /* __ANDROID_API__ >= 28 */ 290 291 int pthread_rwlock_timedwrlock(pthread_rwlock_t* _Nonnull __rwlock, const struct timespec* _Nullable __timeout); 292 /* See the comment on pthread_mutex_timedlock_monotonic_np for usage of this function. */ 293 294 #if __ANDROID_API__ >= 28 295 int pthread_rwlock_timedwrlock_monotonic_np(pthread_rwlock_t* _Nonnull __rwlock, 296 const struct timespec* _Nullable __timeout) __INTRODUCED_IN(28); 297 #endif /* __ANDROID_API__ >= 28 */ 298 299 int pthread_rwlock_tryrdlock(pthread_rwlock_t* _Nonnull __rwlock); 300 int pthread_rwlock_trywrlock(pthread_rwlock_t* _Nonnull __rwlock); 301 int pthread_rwlock_unlock(pthread_rwlock_t* _Nonnull __rwlock); 302 int pthread_rwlock_wrlock(pthread_rwlock_t* _Nonnull __rwlock); 303 304 #if __ANDROID_API__ >= 24 305 int pthread_barrierattr_init(pthread_barrierattr_t* _Nonnull __attr) __INTRODUCED_IN(24); 306 int pthread_barrierattr_destroy(pthread_barrierattr_t* _Nonnull __attr) __INTRODUCED_IN(24); 307 int pthread_barrierattr_getpshared(const pthread_barrierattr_t* _Nonnull __attr, int* _Nonnull __shared) __INTRODUCED_IN(24); 308 int pthread_barrierattr_setpshared(pthread_barrierattr_t* _Nonnull __attr, int __shared) __INTRODUCED_IN(24); 309 #endif 310 311 #if __ANDROID_API__ >= 24 312 int pthread_barrier_init(pthread_barrier_t* _Nonnull __barrier, const pthread_barrierattr_t* _Nullable __attr, unsigned __count) __INTRODUCED_IN(24); 313 int pthread_barrier_destroy(pthread_barrier_t* _Nonnull __barrier) __INTRODUCED_IN(24); 314 int pthread_barrier_wait(pthread_barrier_t* _Nonnull __barrier) __INTRODUCED_IN(24); 315 #endif 316 317 #if __ANDROID_API__ >= 24 318 int pthread_spin_destroy(pthread_spinlock_t* _Nonnull __spinlock) __INTRODUCED_IN(24); 319 int pthread_spin_init(pthread_spinlock_t* _Nonnull __spinlock, int __shared) __INTRODUCED_IN(24); 320 int pthread_spin_lock(pthread_spinlock_t* _Nonnull __spinlock) __INTRODUCED_IN(24); 321 int pthread_spin_trylock(pthread_spinlock_t* _Nonnull __spinlock) __INTRODUCED_IN(24); 322 int pthread_spin_unlock(pthread_spinlock_t* _Nonnull __spinlock) __INTRODUCED_IN(24); 323 #endif 324 325 pthread_t pthread_self(void) __attribute_const__; 326 327 #if defined(__USE_GNU) 328 329 #if __ANDROID_API__ >= 26 330 int pthread_getname_np(pthread_t __pthread, char* _Nonnull __buf, size_t __n) __INTRODUCED_IN(26); 331 #endif /* __ANDROID_API__ >= 26 */ 332 333 #endif 334 /* TODO: this should be __USE_GNU too. */ 335 int pthread_setname_np(pthread_t __pthread, const char* _Nonnull __name); 336 337 /** 338 * [pthread_setschedparam(3)](https://man7.org/linux/man-pages/man3/pthread_setschedparam.3.html) 339 * sets the scheduler policy and parameters of the given thread. 340 * 341 * This call is not useful to applications on Android, because they don't 342 * have permission to set their scheduling policy, and the only priority 343 * for their policy is 0 anyway. If you only need to set your scheduling 344 * priority, see setpriority() instead. 345 * 346 * Returns 0 on success and returns an error number on failure. 347 */ 348 int pthread_setschedparam(pthread_t __pthread, int __policy, const struct sched_param* _Nonnull __param); 349 350 /** 351 * [pthread_getschedparam(3)](https://man7.org/linux/man-pages/man3/pthread_getschedparam.3.html) 352 * gets the scheduler policy and parameters of the given thread. 353 * 354 * Returns 0 on success and returns an error number on failure. 355 */ 356 int pthread_getschedparam(pthread_t __pthread, int* _Nonnull __policy, struct sched_param* _Nonnull __param); 357 358 /** 359 * [pthread_setschedprio(3)](https://man7.org/linux/man-pages/man3/pthread_setschedprio.3.html) 360 * sets the scheduler priority of the given thread. 361 * 362 * This call is not useful to applications on Android, because they don't 363 * have permission to set their scheduling policy, and the only priority 364 * for their policy is 0 anyway. If you only need to set your scheduling 365 * priority, see setpriority() instead. 366 * 367 * Returns 0 on success and returns an error number on failure. 368 * 369 * Available since API level 28. 370 */ 371 372 #if __ANDROID_API__ >= 28 373 int pthread_setschedprio(pthread_t __pthread, int __priority) __INTRODUCED_IN(28); 374 #endif /* __ANDROID_API__ >= 28 */ 375 376 377 int pthread_setspecific(pthread_key_t __key, const void* _Nullable __value); 378 379 typedef void (* _Nullable __pthread_cleanup_func_t)(void* _Nullable); 380 381 typedef struct __pthread_cleanup_t { 382 struct __pthread_cleanup_t* _Nullable __cleanup_prev; 383 __pthread_cleanup_func_t _Nullable __cleanup_routine; 384 void* _Nullable __cleanup_arg; 385 } __pthread_cleanup_t; 386 387 void __pthread_cleanup_push(__pthread_cleanup_t* _Nonnull c, __pthread_cleanup_func_t _Nullable, void* _Nullable); 388 void __pthread_cleanup_pop(__pthread_cleanup_t* _Nonnull, int); 389 390 /* Believe or not, the definitions of pthread_cleanup_push and 391 * pthread_cleanup_pop below are correct. Posix states that these 392 * can be implemented as macros that might introduce opening and 393 * closing braces, and that using setjmp/longjmp/return/break/continue 394 * between them results in undefined behavior. 395 */ 396 #define pthread_cleanup_push(routine, arg) \ 397 do { \ 398 __pthread_cleanup_t __cleanup; \ 399 __pthread_cleanup_push( &__cleanup, (routine), (arg) ); \ 400 401 #define pthread_cleanup_pop(execute) \ 402 __pthread_cleanup_pop( &__cleanup, (execute)); \ 403 } while (0); \ 404 405 __END_DECLS 406