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