pthread.h revision 6b9c85b36d2e69b45d780e6a0b27d64909311a7e
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 41enum { 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 58#define PTHREAD_RWLOCK_INITIALIZER { { 0 } } 59 60enum { 61 PTHREAD_RWLOCK_PREFER_READER_NP = 0, 62 PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP = 1, 63}; 64 65#define PTHREAD_ONCE_INIT 0 66 67#if __ANDROID_API__ >= __ANDROID_API_N__ 68#define PTHREAD_BARRIER_SERIAL_THREAD -1 69#endif 70 71#if defined(__LP64__) 72#define PTHREAD_STACK_MIN (4 * PAGE_SIZE) 73#else 74#define PTHREAD_STACK_MIN (2 * PAGE_SIZE) 75#endif 76 77#define PTHREAD_CREATE_DETACHED 1 78#define PTHREAD_CREATE_JOINABLE 0 79 80#define PTHREAD_EXPLICIT_SCHED 0 81#define PTHREAD_INHERIT_SCHED 1 82 83#define PTHREAD_PRIO_NONE 0 84#define PTHREAD_PRIO_INHERIT 1 85 86#define PTHREAD_PROCESS_PRIVATE 0 87#define PTHREAD_PROCESS_SHARED 1 88 89#define PTHREAD_SCOPE_SYSTEM 0 90#define PTHREAD_SCOPE_PROCESS 1 91 92int pthread_atfork(void (*__prepare)(void), void (*__parent)(void), void (*__child)(void)) __INTRODUCED_IN(12); 93 94int pthread_attr_destroy(pthread_attr_t* __attr); 95int pthread_attr_getdetachstate(const pthread_attr_t* __attr, int* __state); 96int pthread_attr_getguardsize(const pthread_attr_t* __attr, size_t* __size); 97int pthread_attr_getinheritsched(const pthread_attr_t* __attr, int* __flag); 98int pthread_attr_getschedparam(const pthread_attr_t* __attr, struct sched_param* __param); 99int pthread_attr_getschedpolicy(const pthread_attr_t* __attr, int* __policy); 100int pthread_attr_getscope(const pthread_attr_t* __attr, int* __scope); 101int pthread_attr_getstack(const pthread_attr_t* __attr, void** __addr, size_t* __size); 102int pthread_attr_getstacksize(const pthread_attr_t* __attr, size_t* __size); 103int pthread_attr_init(pthread_attr_t* __attr); 104int pthread_attr_setdetachstate(pthread_attr_t* __attr, int __state); 105int pthread_attr_setguardsize(pthread_attr_t* __attr, size_t __size); 106int pthread_attr_setinheritsched(pthread_attr_t* __attr, int __flag); 107int pthread_attr_setschedparam(pthread_attr_t* __attr, const struct sched_param* __param); 108int pthread_attr_setschedpolicy(pthread_attr_t* __attr, int __policy); 109int pthread_attr_setscope(pthread_attr_t* __attr, int __scope); 110int pthread_attr_setstack(pthread_attr_t* __attr, void* __addr, size_t __size); 111int pthread_attr_setstacksize(pthread_attr_t* __addr, size_t __size); 112 113int pthread_condattr_destroy(pthread_condattr_t* __attr); 114int pthread_condattr_getclock(const pthread_condattr_t* __attr, clockid_t* __clock) __INTRODUCED_IN(21); 115int pthread_condattr_getpshared(const pthread_condattr_t* __attr, int* __shared); 116int pthread_condattr_init(pthread_condattr_t* __attr); 117int pthread_condattr_setclock(pthread_condattr_t* __attr, clockid_t __clock) __INTRODUCED_IN(21); 118int pthread_condattr_setpshared(pthread_condattr_t* __attr, int __shared); 119 120int pthread_cond_broadcast(pthread_cond_t* __cond); 121int pthread_cond_destroy(pthread_cond_t* __cond); 122int pthread_cond_init(pthread_cond_t* __cond, const pthread_condattr_t* __attr); 123int pthread_cond_signal(pthread_cond_t* __cond); 124int pthread_cond_timedwait(pthread_cond_t* __cond, pthread_mutex_t* __mutex, const struct timespec* __timeout); 125int pthread_cond_wait(pthread_cond_t* __cond, pthread_mutex_t* __mutex); 126 127int pthread_create(pthread_t* __pthread_ptr, pthread_attr_t const* __attr, void* (*__start_routine)(void*), void*); 128int pthread_detach(pthread_t __pthread); 129void pthread_exit(void* __return_value) __noreturn; 130 131int pthread_equal(pthread_t __lhs, pthread_t __rhs); 132 133int pthread_getattr_np(pthread_t __pthread, pthread_attr_t* __attr); 134 135int pthread_getcpuclockid(pthread_t __pthread, clockid_t* __clock); 136 137int pthread_getschedparam(pthread_t __pthread, int* __policy, struct sched_param* __param); 138 139void* pthread_getspecific(pthread_key_t __key); 140 141pid_t pthread_gettid_np(pthread_t __pthread) __INTRODUCED_IN(21); 142 143int pthread_join(pthread_t __pthread, void** __return_value_ptr); 144 145int pthread_key_create(pthread_key_t* __key_ptr, void (*__key_destructor)(void*)); 146int pthread_key_delete(pthread_key_t __key); 147 148int pthread_mutexattr_destroy(pthread_mutexattr_t* __attr); 149int pthread_mutexattr_getpshared(const pthread_mutexattr_t* __attr, int* __shared); 150int pthread_mutexattr_gettype(const pthread_mutexattr_t* __attr, int* __type); 151int pthread_mutexattr_getprotocol(const pthread_mutexattr_t* __attr, int* __protocol) __INTRODUCED_IN(28); 152int pthread_mutexattr_init(pthread_mutexattr_t* __attr); 153int pthread_mutexattr_setpshared(pthread_mutexattr_t* __attr, int __shared); 154int pthread_mutexattr_settype(pthread_mutexattr_t* __attr, int __type); 155int pthread_mutexattr_setprotocol(pthread_mutexattr_t* __attr, int __protocol) __INTRODUCED_IN(28); 156 157int pthread_mutex_destroy(pthread_mutex_t* __mutex); 158int pthread_mutex_init(pthread_mutex_t* __mutex, const pthread_mutexattr_t* __attr); 159int pthread_mutex_lock(pthread_mutex_t* __mutex); 160int pthread_mutex_timedlock(pthread_mutex_t* __mutex, const struct timespec* __timeout) 161 __INTRODUCED_IN(21); 162int pthread_mutex_trylock(pthread_mutex_t* __mutex); 163int pthread_mutex_unlock(pthread_mutex_t* __mutex); 164 165#if __ANDROID_API__ < 21 166/* 167 * Cruft for supporting old API levels. Pre-L we didn't have the proper POSIX 168 * APIs for things, but instead had some locally grown, artisan equivalents. 169 * Keep exposing the old prototypes on old API levels so we don't regress 170 * functionality. 171 * 172 * See the following bugs: 173 * * https://github.com/android-ndk/ndk/issues/420 174 * * https://github.com/android-ndk/ndk/issues/423 175 * * https://stackoverflow.com/q/44580542/632035 176 */ 177int pthread_mutex_lock_timeout_np(pthread_mutex_t* __mutex, unsigned __timeout_ms); 178int pthread_cond_timeout_np(pthread_cond_t* __cond, pthread_mutex_t* __mutex, unsigned __timeout_ms); 179int pthread_cond_timedwait_monotonic_np(pthread_cond_t* __cond, pthread_mutex_t* __mutex, const struct timespec* __timeout); 180int pthread_cond_timedwait_relative_np(pthread_cond_t* __cond, pthread_mutex_t* __mutex, const struct timespec* __relative_timeout); 181#endif 182 183int pthread_once(pthread_once_t* __once, void (*__init_routine)(void)); 184 185int pthread_rwlockattr_init(pthread_rwlockattr_t* __attr); 186int pthread_rwlockattr_destroy(pthread_rwlockattr_t* __attr); 187int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t* __attr, int* __shared); 188int pthread_rwlockattr_setpshared(pthread_rwlockattr_t* __attr, int __shared); 189int pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t* __attr, int* __kind) 190 __INTRODUCED_IN(23); 191int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t* __attr, int __kind) __INTRODUCED_IN(23); 192 193int pthread_rwlock_destroy(pthread_rwlock_t* __rwlock); 194int pthread_rwlock_init(pthread_rwlock_t* __rwlock, const pthread_rwlockattr_t* __attr); 195int pthread_rwlock_rdlock(pthread_rwlock_t* __rwlock); 196int pthread_rwlock_timedrdlock(pthread_rwlock_t* __rwlock, const struct timespec* __timeout); 197int pthread_rwlock_timedwrlock(pthread_rwlock_t* __rwlock, const struct timespec* __timeout); 198int pthread_rwlock_tryrdlock(pthread_rwlock_t* __rwlock); 199int pthread_rwlock_trywrlock(pthread_rwlock_t* __rwlock); 200int pthread_rwlock_unlock(pthread_rwlock_t* __rwlock); 201int pthread_rwlock_wrlock(pthread_rwlock_t* __rwlock); 202 203#if __ANDROID_API__ >= __ANDROID_API_N__ 204int pthread_barrierattr_init(pthread_barrierattr_t* __attr) __INTRODUCED_IN(24); 205int pthread_barrierattr_destroy(pthread_barrierattr_t* __attr) __INTRODUCED_IN(24); 206int pthread_barrierattr_getpshared(const pthread_barrierattr_t* __attr, int* __shared) __INTRODUCED_IN(24); 207int pthread_barrierattr_setpshared(pthread_barrierattr_t* __attr, int __shared) __INTRODUCED_IN(24); 208#endif 209 210#if __ANDROID_API__ >= __ANDROID_API_N__ 211int pthread_barrier_init(pthread_barrier_t* __barrier, const pthread_barrierattr_t* __attr, unsigned __count) __INTRODUCED_IN(24); 212int pthread_barrier_destroy(pthread_barrier_t* __barrier) __INTRODUCED_IN(24); 213int pthread_barrier_wait(pthread_barrier_t* __barrier) __INTRODUCED_IN(24); 214#endif 215 216#if __ANDROID_API__ >= __ANDROID_API_N__ 217int pthread_spin_destroy(pthread_spinlock_t* __spinlock) __INTRODUCED_IN(24); 218int pthread_spin_init(pthread_spinlock_t* __spinlock, int __shared) __INTRODUCED_IN(24); 219int pthread_spin_lock(pthread_spinlock_t* __spinlock) __INTRODUCED_IN(24); 220int pthread_spin_trylock(pthread_spinlock_t* __spinlock) __INTRODUCED_IN(24); 221int pthread_spin_unlock(pthread_spinlock_t* __spinlock) __INTRODUCED_IN(24); 222#endif 223 224pthread_t pthread_self(void) __attribute_const__; 225 226#if defined(__USE_GNU) 227int pthread_getname_np(pthread_t __pthread, char* __buf, size_t __n) __INTRODUCED_IN(26); 228#endif 229/* TODO: this should be __USE_GNU too. */ 230int pthread_setname_np(pthread_t __pthread, const char* __name); 231 232int pthread_setschedparam(pthread_t __pthread, int __policy, const struct sched_param* __param); 233int pthread_setschedprio(pthread_t __pthread, int __priority) __INTRODUCED_IN_FUTURE; 234 235int pthread_setspecific(pthread_key_t __key, const void* __value); 236 237typedef void (*__pthread_cleanup_func_t)(void*); 238 239typedef struct __pthread_cleanup_t { 240 struct __pthread_cleanup_t* __cleanup_prev; 241 __pthread_cleanup_func_t __cleanup_routine; 242 void* __cleanup_arg; 243} __pthread_cleanup_t; 244 245void __pthread_cleanup_push(__pthread_cleanup_t* c, __pthread_cleanup_func_t, void*); 246void __pthread_cleanup_pop(__pthread_cleanup_t*, int); 247 248/* Believe or not, the definitions of pthread_cleanup_push and 249 * pthread_cleanup_pop below are correct. Posix states that these 250 * can be implemented as macros that might introduce opening and 251 * closing braces, and that using setjmp/longjmp/return/break/continue 252 * between them results in undefined behavior. 253 */ 254#define pthread_cleanup_push(routine, arg) \ 255 do { \ 256 __pthread_cleanup_t __cleanup; \ 257 __pthread_cleanup_push( &__cleanup, (routine), (arg) ); \ 258 259#define pthread_cleanup_pop(execute) \ 260 __pthread_cleanup_pop( &__cleanup, (execute)); \ 261 } while (0); \ 262 263__END_DECLS 264 265#endif 266