pthread.h revision 14adff1cfa06a3d4d3281a9bf7848b556d84c20d 
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((1));
139int pthread_attr_getdetachstate(const pthread_attr_t*, int*) __nonnull((1, 2));
140int pthread_attr_getguardsize(const pthread_attr_t*, size_t*) __nonnull((1, 2));
141int pthread_attr_getschedparam(const pthread_attr_t*, struct sched_param*) __nonnull((1, 2));
142int pthread_attr_getschedpolicy(const pthread_attr_t*, int*) __nonnull((1, 2));
143int pthread_attr_getscope(const pthread_attr_t*, int*) __nonnull((1, 2));
144int pthread_attr_getstack(const pthread_attr_t*, void**, size_t*) __nonnull((1, 2, 3));
145int pthread_attr_getstacksize(const pthread_attr_t*, size_t*) __nonnull((1, 2));
146int pthread_attr_init(pthread_attr_t*) __nonnull((1));
147int pthread_attr_setdetachstate(pthread_attr_t*, int) __nonnull((1));
148int pthread_attr_setguardsize(pthread_attr_t*, size_t) __nonnull((1));
149int pthread_attr_setschedparam(pthread_attr_t*, const struct sched_param*) __nonnull((1, 2));
150int pthread_attr_setschedpolicy(pthread_attr_t*, int) __nonnull((1));
151int pthread_attr_setscope(pthread_attr_t*, int) __nonnull((1));
152int pthread_attr_setstack(pthread_attr_t*, void*, size_t) __nonnull((1));
153int pthread_attr_setstacksize(pthread_attr_t*, size_t) __nonnull((1));
154
155int pthread_condattr_destroy(pthread_condattr_t*) __nonnull((1));
156int pthread_condattr_getclock(const pthread_condattr_t*, clockid_t*) __nonnull((1, 2))
157  __INTRODUCED_IN(21);
158int pthread_condattr_getpshared(const pthread_condattr_t*, int*) __nonnull((1, 2));
159int pthread_condattr_init(pthread_condattr_t*) __nonnull((1));
160int pthread_condattr_setclock(pthread_condattr_t*, clockid_t) __nonnull((1)) __INTRODUCED_IN(21);
161int pthread_condattr_setpshared(pthread_condattr_t*, int) __nonnull((1));
162
163int pthread_cond_broadcast(pthread_cond_t*) __nonnull((1));
164int pthread_cond_destroy(pthread_cond_t*) __nonnull((1));
165int pthread_cond_init(pthread_cond_t*, const pthread_condattr_t*) __nonnull((1));
166int pthread_cond_signal(pthread_cond_t*) __nonnull((1));
167int pthread_cond_timedwait(pthread_cond_t*, pthread_mutex_t*, const struct timespec*) __nonnull((1, 2, 3));
168int pthread_cond_wait(pthread_cond_t*, pthread_mutex_t*) __nonnull((1, 2));
169
170int pthread_create(pthread_t*, pthread_attr_t const*, void *(*)(void*), void*) __nonnull((1, 3));
171int pthread_detach(pthread_t);
172void pthread_exit(void*) __noreturn;
173
174int pthread_equal(pthread_t, pthread_t);
175
176int pthread_getattr_np(pthread_t, pthread_attr_t*) __nonnull((2));
177
178int pthread_getcpuclockid(pthread_t, clockid_t*) __nonnull((2));
179
180int pthread_getschedparam(pthread_t, int*, struct sched_param*) __nonnull((2, 3));
181
182void* pthread_getspecific(pthread_key_t);
183
184pid_t pthread_gettid_np(pthread_t) __INTRODUCED_IN(21);
185
186int pthread_join(pthread_t, void**);
187
188int pthread_key_create(pthread_key_t*, void (*)(void*)) __nonnull((1));
189int pthread_key_delete(pthread_key_t);
190
191int pthread_mutexattr_destroy(pthread_mutexattr_t*) __nonnull((1));
192int pthread_mutexattr_getpshared(const pthread_mutexattr_t*, int*) __nonnull((1, 2));
193int pthread_mutexattr_gettype(const pthread_mutexattr_t*, int*) __nonnull((1, 2));
194int pthread_mutexattr_init(pthread_mutexattr_t*) __nonnull((1));
195int pthread_mutexattr_setpshared(pthread_mutexattr_t*, int) __nonnull((1));
196int pthread_mutexattr_settype(pthread_mutexattr_t*, int) __nonnull((1));
197
198int pthread_mutex_destroy(pthread_mutex_t*) __nonnull((1));
199int pthread_mutex_init(pthread_mutex_t*, const pthread_mutexattr_t*) __nonnull((1));
200#if !defined(__LP64__)
201int pthread_mutex_lock(pthread_mutex_t*) /* __nonnull((1)) */;
202#else
203int pthread_mutex_lock(pthread_mutex_t*) __nonnull((1));
204#endif
205int pthread_mutex_timedlock(pthread_mutex_t*, const struct timespec*) __nonnull((1, 2))
206  __INTRODUCED_IN(21);
207int pthread_mutex_trylock(pthread_mutex_t*) __nonnull((1));
208#if !defined(__LP4__)
209int pthread_mutex_unlock(pthread_mutex_t*) /* __nonnull((1)) */;
210#else
211int pthread_mutex_unlock(pthread_mutex_t*) __nonnull((1));
212#endif
213
214int pthread_once(pthread_once_t*, void (*)(void)) __nonnull((1, 2));
215
216int pthread_rwlockattr_init(pthread_rwlockattr_t*) __nonnull((1));
217int pthread_rwlockattr_destroy(pthread_rwlockattr_t*) __nonnull((1));
218int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t*, int*) __nonnull((1, 2));
219int pthread_rwlockattr_setpshared(pthread_rwlockattr_t*, int) __nonnull((1));
220int pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t*, int*) __nonnull((1, 2))
221  __INTRODUCED_IN(23);
222int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t*, int) __nonnull((1)) __INTRODUCED_IN(23);
223
224int pthread_rwlock_destroy(pthread_rwlock_t*) __nonnull((1));
225int pthread_rwlock_init(pthread_rwlock_t*, const pthread_rwlockattr_t*) __nonnull((1));
226int pthread_rwlock_rdlock(pthread_rwlock_t*) __nonnull((1));
227int pthread_rwlock_timedrdlock(pthread_rwlock_t*, const struct timespec*) __nonnull((1, 2));
228int pthread_rwlock_timedwrlock(pthread_rwlock_t*, const struct timespec*) __nonnull((1, 2));
229int pthread_rwlock_tryrdlock(pthread_rwlock_t*) __nonnull((1));
230int pthread_rwlock_trywrlock(pthread_rwlock_t*) __nonnull((1));
231int pthread_rwlock_unlock(pthread_rwlock_t *) __nonnull((1));
232int pthread_rwlock_wrlock(pthread_rwlock_t*) __nonnull((1));
233
234int pthread_barrierattr_init(pthread_barrierattr_t* attr) __nonnull((1)) __INTRODUCED_IN(24);
235int pthread_barrierattr_destroy(pthread_barrierattr_t* attr) __nonnull((1)) __INTRODUCED_IN(24);
236int pthread_barrierattr_getpshared(pthread_barrierattr_t* attr, int* pshared) __nonnull((1, 2))
237  __INTRODUCED_IN(24);
238int pthread_barrierattr_setpshared(pthread_barrierattr_t* attr, int pshared) __nonnull((1))
239  __INTRODUCED_IN(24);
240
241int pthread_barrier_init(pthread_barrier_t*, const pthread_barrierattr_t*, unsigned) __nonnull((1))
242  __INTRODUCED_IN(24);
243int pthread_barrier_destroy(pthread_barrier_t*) __nonnull((1)) __INTRODUCED_IN(24);
244int pthread_barrier_wait(pthread_barrier_t*) __nonnull((1)) __INTRODUCED_IN(24);
245
246int pthread_spin_destroy(pthread_spinlock_t*) __nonnull((1)) __INTRODUCED_IN(24);
247int pthread_spin_init(pthread_spinlock_t*, int) __nonnull((1)) __INTRODUCED_IN(24);
248int pthread_spin_lock(pthread_spinlock_t*) __nonnull((1)) __INTRODUCED_IN(24);
249int pthread_spin_trylock(pthread_spinlock_t*) __nonnull((1)) __INTRODUCED_IN(24);
250int pthread_spin_unlock(pthread_spinlock_t*) __nonnull((1)) __INTRODUCED_IN(24);
251
252pthread_t pthread_self(void) __pure2;
253
254#if defined(__USE_GNU)
255int pthread_getname_np(pthread_t, char*, size_t) __nonnull((2)) __INTRODUCED_IN(25);
256#endif
257/* TODO: this should be __USE_GNU too. */
258int pthread_setname_np(pthread_t, const char*) __nonnull((2));
259
260int pthread_setschedparam(pthread_t, int, const struct sched_param*) __nonnull((3));
261
262int pthread_setspecific(pthread_key_t, const void*);
263
264typedef void (*__pthread_cleanup_func_t)(void*);
265
266typedef struct __pthread_cleanup_t {
267  struct __pthread_cleanup_t*   __cleanup_prev;
268  __pthread_cleanup_func_t      __cleanup_routine;
269  void*                         __cleanup_arg;
270} __pthread_cleanup_t;
271
272extern void __pthread_cleanup_push(__pthread_cleanup_t* c, __pthread_cleanup_func_t, void*);
273extern void __pthread_cleanup_pop(__pthread_cleanup_t*, int);
274
275/* Believe or not, the definitions of pthread_cleanup_push and
276 * pthread_cleanup_pop below are correct. Posix states that these
277 * can be implemented as macros that might introduce opening and
278 * closing braces, and that using setjmp/longjmp/return/break/continue
279 * between them results in undefined behavior.
280 */
281#define  pthread_cleanup_push(routine, arg)                      \
282    do {                                                         \
283        __pthread_cleanup_t  __cleanup;                          \
284        __pthread_cleanup_push( &__cleanup, (routine), (arg) );  \
285
286#define  pthread_cleanup_pop(execute)                  \
287        __pthread_cleanup_pop( &__cleanup, (execute)); \
288    } while (0);                                       \
289
290
291#if !defined(__LP64__)
292
293// Bionic additions that are deprecated even in the 32-bit ABI.
294int pthread_cond_timedwait_relative_np(pthread_cond_t*, pthread_mutex_t*, const struct timespec*) __attribute__((deprecated("use pthread_cond_timedwait instead")));
295
296int pthread_mutex_lock_timeout_np(pthread_mutex_t*, unsigned) __attribute__((deprecated("use pthread_mutex_timedlock instead")));
297
298#endif /* !defined(__LP64__) */
299
300__END_DECLS
301
302#endif /* _PTHREAD_H_ */
303