pthread.h revision e2f25831eba8dcbb57aebbf50c463d4473c7df30 
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
39typedef struct {
40#if defined(__LP64__)
41  int32_t __private[10];
42#else
43  int32_t __private[1];
44#endif
45} pthread_mutex_t;
46
47typedef long pthread_mutexattr_t;
48
49enum {
50    PTHREAD_MUTEX_NORMAL = 0,
51    PTHREAD_MUTEX_RECURSIVE = 1,
52    PTHREAD_MUTEX_ERRORCHECK = 2,
53
54    PTHREAD_MUTEX_ERRORCHECK_NP = PTHREAD_MUTEX_ERRORCHECK,
55    PTHREAD_MUTEX_RECURSIVE_NP  = PTHREAD_MUTEX_RECURSIVE,
56
57    PTHREAD_MUTEX_DEFAULT = PTHREAD_MUTEX_NORMAL
58};
59
60#define PTHREAD_MUTEX_INITIALIZER { { ((PTHREAD_MUTEX_NORMAL & 3) << 14) } }
61#define PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP { { ((PTHREAD_MUTEX_RECURSIVE & 3) << 14) } }
62#define PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP { { ((PTHREAD_MUTEX_ERRORCHECK & 3) << 14) } }
63
64typedef struct {
65#if defined(__LP64__)
66  int32_t __private[12];
67#else
68  int32_t __private[1];
69#endif
70} pthread_cond_t;
71
72typedef long pthread_condattr_t;
73
74#define PTHREAD_COND_INITIALIZER  { { 0 } }
75
76typedef struct {
77#if defined(__LP64__)
78  int32_t __private[14];
79#else
80  int32_t __private[10];
81#endif
82} pthread_rwlock_t;
83
84typedef long pthread_rwlockattr_t;
85
86#define PTHREAD_RWLOCK_INITIALIZER  { { 0 } }
87
88enum {
89  PTHREAD_RWLOCK_PREFER_READER_NP = 0,
90  PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP = 1,
91};
92
93typedef int pthread_key_t;
94
95typedef int pthread_once_t;
96
97#define PTHREAD_ONCE_INIT 0
98
99typedef struct {
100#if defined(__LP64__)
101  int64_t __private[4];
102#else
103  int32_t __private[8];
104#endif
105} pthread_barrier_t;
106
107typedef int pthread_barrierattr_t;
108
109#define PTHREAD_BARRIER_SERIAL_THREAD -1
110
111typedef struct {
112#if defined(__LP64__)
113  int64_t __private;
114#else
115  int32_t __private[2];
116#endif
117} pthread_spinlock_t;
118
119#if defined(__LP64__)
120#define PTHREAD_STACK_MIN (4 * PAGE_SIZE)
121#else
122#define PTHREAD_STACK_MIN (2 * PAGE_SIZE)
123#endif
124
125#define PTHREAD_CREATE_DETACHED  0x00000001
126#define PTHREAD_CREATE_JOINABLE  0x00000000
127
128#define PTHREAD_PROCESS_PRIVATE  0
129#define PTHREAD_PROCESS_SHARED   1
130
131#define PTHREAD_SCOPE_SYSTEM     0
132#define PTHREAD_SCOPE_PROCESS    1
133
134__BEGIN_DECLS
135
136int pthread_atfork(void (*)(void), void (*)(void), void (*)(void)) __INTRODUCED_IN(21);
137
138int pthread_attr_destroy(pthread_attr_t* _Nonnull);
139int pthread_attr_getdetachstate(const pthread_attr_t* _Nonnull, int* _Nonnull);
140int pthread_attr_getguardsize(const pthread_attr_t* _Nonnull, size_t* _Nonnull);
141int pthread_attr_getschedparam(const pthread_attr_t* _Nonnull, struct sched_param* _Nonnull);
142int pthread_attr_getschedpolicy(const pthread_attr_t* _Nonnull, int* _Nonnull);
143int pthread_attr_getscope(const pthread_attr_t* _Nonnull, int* _Nonnull);
144int pthread_attr_getstack(const pthread_attr_t* _Nonnull, void** _Nonnull, size_t* _Nonnull);
145int pthread_attr_getstacksize(const pthread_attr_t* _Nonnull, size_t* _Nonnull);
146int pthread_attr_init(pthread_attr_t* _Nonnull);
147int pthread_attr_setdetachstate(pthread_attr_t* _Nonnull, int);
148int pthread_attr_setguardsize(pthread_attr_t* _Nonnull, size_t);
149int pthread_attr_setschedparam(pthread_attr_t* _Nonnull, const struct sched_param* _Nonnull);
150int pthread_attr_setschedpolicy(pthread_attr_t* _Nonnull, int);
151int pthread_attr_setscope(pthread_attr_t* _Nonnull, int);
152int pthread_attr_setstack(pthread_attr_t* _Nonnull, void*, size_t);
153int pthread_attr_setstacksize(pthread_attr_t* _Nonnull, size_t);
154
155int pthread_condattr_destroy(pthread_condattr_t* _Nonnull);
156int pthread_condattr_getclock(const pthread_condattr_t* _Nonnull, clockid_t* _Nonnull)
157  __INTRODUCED_IN(21);
158int pthread_condattr_getpshared(const pthread_condattr_t* _Nonnull, int* _Nonnull);
159int pthread_condattr_init(pthread_condattr_t* _Nonnull);
160int pthread_condattr_setclock(pthread_condattr_t* _Nonnull, clockid_t) __INTRODUCED_IN(21);
161int pthread_condattr_setpshared(pthread_condattr_t* _Nonnull, int);
162
163int pthread_cond_broadcast(pthread_cond_t* _Nonnull);
164int pthread_cond_destroy(pthread_cond_t* _Nonnull);
165int pthread_cond_init(pthread_cond_t* _Nonnull, const pthread_condattr_t*);
166int pthread_cond_signal(pthread_cond_t* _Nonnull);
167int pthread_cond_timedwait(pthread_cond_t* _Nonnull, pthread_mutex_t* _Nonnull,
168                           const struct timespec* _Nonnull);
169int pthread_cond_wait(pthread_cond_t* _Nonnull, pthread_mutex_t* _Nonnull);
170
171int pthread_create(pthread_t* _Nonnull, pthread_attr_t const*,
172                   void* (* _Nonnull start_routine)(void*), void*);
173int pthread_detach(pthread_t);
174void pthread_exit(void*) __noreturn;
175
176int pthread_equal(pthread_t, pthread_t);
177
178int pthread_getattr_np(pthread_t, pthread_attr_t* _Nonnull);
179
180int pthread_getcpuclockid(pthread_t, clockid_t* _Nonnull);
181
182int pthread_getschedparam(pthread_t, int* _Nonnull, struct sched_param* _Nonnull);
183
184void* pthread_getspecific(pthread_key_t);
185
186pid_t pthread_gettid_np(pthread_t) __INTRODUCED_IN(21);
187
188int pthread_join(pthread_t, void**);
189
190int pthread_key_create(pthread_key_t* _Nonnull, void (*)(void*));
191int pthread_key_delete(pthread_key_t);
192
193int pthread_mutexattr_destroy(pthread_mutexattr_t* _Nonnull);
194int pthread_mutexattr_getpshared(const pthread_mutexattr_t* _Nonnull, int* _Nonnull);
195int pthread_mutexattr_gettype(const pthread_mutexattr_t* _Nonnull, int* _Nonnull);
196int pthread_mutexattr_init(pthread_mutexattr_t* _Nonnull);
197int pthread_mutexattr_setpshared(pthread_mutexattr_t* _Nonnull, int);
198int pthread_mutexattr_settype(pthread_mutexattr_t* _Nonnull, int);
199
200int pthread_mutex_destroy(pthread_mutex_t* _Nonnull);
201int pthread_mutex_init(pthread_mutex_t* _Nonnull, const pthread_mutexattr_t*);
202int pthread_mutex_lock(pthread_mutex_t* _Nonnull);
203int pthread_mutex_timedlock(pthread_mutex_t* _Nonnull, const struct timespec* _Nonnull)
204  __INTRODUCED_IN(21);
205int pthread_mutex_trylock(pthread_mutex_t* _Nonnull);
206int pthread_mutex_unlock(pthread_mutex_t* _Nonnull);
207
208int pthread_once(pthread_once_t* _Nonnull, void (* _Nonnull init_routine)(void));
209
210int pthread_rwlockattr_init(pthread_rwlockattr_t* _Nonnull);
211int pthread_rwlockattr_destroy(pthread_rwlockattr_t* _Nonnull);
212int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t* _Nonnull, int* _Nonnull);
213int pthread_rwlockattr_setpshared(pthread_rwlockattr_t* _Nonnull, int);
214int pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t* _Nonnull, int* _Nonnull)
215  __INTRODUCED_IN(23);
216int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t* _Nonnull, int) __INTRODUCED_IN(23);
217
218int pthread_rwlock_destroy(pthread_rwlock_t* _Nonnull);
219int pthread_rwlock_init(pthread_rwlock_t* _Nonnull, const pthread_rwlockattr_t*);
220int pthread_rwlock_rdlock(pthread_rwlock_t* _Nonnull);
221int pthread_rwlock_timedrdlock(pthread_rwlock_t* _Nonnull, const struct timespec* _Nonnull);
222int pthread_rwlock_timedwrlock(pthread_rwlock_t* _Nonnull, const struct timespec* _Nonnull);
223int pthread_rwlock_tryrdlock(pthread_rwlock_t* _Nonnull);
224int pthread_rwlock_trywrlock(pthread_rwlock_t* _Nonnull);
225int pthread_rwlock_unlock(pthread_rwlock_t* _Nonnull);
226int pthread_rwlock_wrlock(pthread_rwlock_t* _Nonnull);
227
228int pthread_barrierattr_init(pthread_barrierattr_t* _Nonnull attr) __INTRODUCED_IN(24);
229int pthread_barrierattr_destroy(pthread_barrierattr_t* _Nonnull attr) __INTRODUCED_IN(24);
230int pthread_barrierattr_getpshared(pthread_barrierattr_t* _Nonnull attr, int* _Nonnull pshared)
231  __INTRODUCED_IN(24);
232int pthread_barrierattr_setpshared(pthread_barrierattr_t* _Nonnull attr, int pshared)
233  __INTRODUCED_IN(24);
234
235int pthread_barrier_init(pthread_barrier_t* _Nonnull, const pthread_barrierattr_t*, unsigned)
236  __INTRODUCED_IN(24);
237int pthread_barrier_destroy(pthread_barrier_t* _Nonnull) __INTRODUCED_IN(24);
238int pthread_barrier_wait(pthread_barrier_t* _Nonnull) __INTRODUCED_IN(24);
239
240int pthread_spin_destroy(pthread_spinlock_t* _Nonnull) __INTRODUCED_IN(24);
241int pthread_spin_init(pthread_spinlock_t* _Nonnull, int) __INTRODUCED_IN(24);
242int pthread_spin_lock(pthread_spinlock_t* _Nonnull) __INTRODUCED_IN(24);
243int pthread_spin_trylock(pthread_spinlock_t* _Nonnull) __INTRODUCED_IN(24);
244int pthread_spin_unlock(pthread_spinlock_t* _Nonnull) __INTRODUCED_IN(24);
245
246pthread_t pthread_self(void) __pure2;
247
248#if defined(__USE_GNU)
249int pthread_getname_np(pthread_t, char* _Nonnull, size_t) __INTRODUCED_IN_FUTURE;
250#endif
251/* TODO: this should be __USE_GNU too. */
252int pthread_setname_np(pthread_t, const char* _Nonnull);
253
254int pthread_setschedparam(pthread_t, int, const struct sched_param* _Nonnull);
255
256int pthread_setspecific(pthread_key_t, const void*);
257
258typedef void (*__pthread_cleanup_func_t)(void*);
259
260typedef struct __pthread_cleanup_t {
261  struct __pthread_cleanup_t*   __cleanup_prev;
262  __pthread_cleanup_func_t      __cleanup_routine;
263  void*                         __cleanup_arg;
264} __pthread_cleanup_t;
265
266extern void __pthread_cleanup_push(__pthread_cleanup_t* c, __pthread_cleanup_func_t, void*);
267extern void __pthread_cleanup_pop(__pthread_cleanup_t*, int);
268
269/* Believe or not, the definitions of pthread_cleanup_push and
270 * pthread_cleanup_pop below are correct. Posix states that these
271 * can be implemented as macros that might introduce opening and
272 * closing braces, and that using setjmp/longjmp/return/break/continue
273 * between them results in undefined behavior.
274 */
275#define  pthread_cleanup_push(routine, arg)                      \
276    do {                                                         \
277        __pthread_cleanup_t  __cleanup;                          \
278        __pthread_cleanup_push( &__cleanup, (routine), (arg) );  \
279
280#define  pthread_cleanup_pop(execute)                  \
281        __pthread_cleanup_pop( &__cleanup, (execute)); \
282    } while (0);                                       \
283
284__END_DECLS
285
286#endif /* _PTHREAD_H_ */
287