pthread.h revision 17393b06bab9cb3e95d0f466a56c746de19b8eee 
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 <machine/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
64/* TODO: remove this namespace pollution. */
65#define PTHREAD_ERRORCHECK_MUTEX_INITIALIZER PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP
66#define PTHREAD_RECURSIVE_MUTEX_INITIALIZER PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
67
68typedef struct {
69#if defined(__LP64__)
70  int32_t __private[12];
71#else
72  int32_t __private[1];
73#endif
74} pthread_cond_t;
75
76typedef long pthread_condattr_t;
77
78#define PTHREAD_COND_INITIALIZER  { { 0 } }
79
80typedef struct {
81#if defined(__LP64__)
82  int32_t __private[14];
83#else
84  int32_t __private[10];
85#endif
86} pthread_rwlock_t;
87
88typedef long pthread_rwlockattr_t;
89
90#define PTHREAD_RWLOCK_INITIALIZER  { { 0 } }
91
92typedef int pthread_key_t;
93
94typedef int pthread_once_t;
95
96#define PTHREAD_ONCE_INIT 0
97
98#if defined(__LP64__)
99#define PTHREAD_STACK_MIN (4 * PAGE_SIZE)
100#else
101#define PTHREAD_STACK_MIN (2 * PAGE_SIZE)
102#endif
103
104#define PTHREAD_CREATE_DETACHED  0x00000001
105#define PTHREAD_CREATE_JOINABLE  0x00000000
106
107#define PTHREAD_PROCESS_PRIVATE  0
108#define PTHREAD_PROCESS_SHARED   1
109
110#define PTHREAD_SCOPE_SYSTEM     0
111#define PTHREAD_SCOPE_PROCESS    1
112
113__BEGIN_DECLS
114
115int pthread_atfork(void (*)(void), void (*)(void), void(*)(void));
116
117int pthread_attr_destroy(pthread_attr_t*) __nonnull((1));
118int pthread_attr_getdetachstate(const pthread_attr_t*, int*) __nonnull((1, 2));
119int pthread_attr_getguardsize(const pthread_attr_t*, size_t*) __nonnull((1, 2));
120int pthread_attr_getschedparam(const pthread_attr_t*, struct sched_param*) __nonnull((1, 2));
121int pthread_attr_getschedpolicy(const pthread_attr_t*, int*) __nonnull((1, 2));
122int pthread_attr_getscope(const pthread_attr_t*, int*) __nonnull((1, 2));
123int pthread_attr_getstack(const pthread_attr_t*, void**, size_t*) __nonnull((1, 2, 3));
124int pthread_attr_getstacksize(const pthread_attr_t*, size_t*) __nonnull((1, 2));
125int pthread_attr_init(pthread_attr_t*) __nonnull((1));
126int pthread_attr_setdetachstate(pthread_attr_t*, int) __nonnull((1));
127int pthread_attr_setguardsize(pthread_attr_t*, size_t) __nonnull((1));
128int pthread_attr_setschedparam(pthread_attr_t*, const struct sched_param*) __nonnull((1, 2));
129int pthread_attr_setschedpolicy(pthread_attr_t*, int) __nonnull((1));
130int pthread_attr_setscope(pthread_attr_t*, int) __nonnull((1));
131int pthread_attr_setstack(pthread_attr_t*, void*, size_t) __nonnull((1));
132int pthread_attr_setstacksize(pthread_attr_t*, size_t stack_size) __nonnull((1));
133
134int pthread_condattr_destroy(pthread_condattr_t*) __nonnull((1));
135int pthread_condattr_getclock(const pthread_condattr_t*, clockid_t*) __nonnull((1, 2));
136int pthread_condattr_getpshared(const pthread_condattr_t*, int*) __nonnull((1, 2));
137int pthread_condattr_init(pthread_condattr_t*) __nonnull((1));
138int pthread_condattr_setclock(pthread_condattr_t*, clockid_t) __nonnull((1));
139int pthread_condattr_setpshared(pthread_condattr_t*, int) __nonnull((1));
140
141int pthread_cond_broadcast(pthread_cond_t*) __nonnull((1));
142int pthread_cond_destroy(pthread_cond_t*) __nonnull((1));
143int pthread_cond_init(pthread_cond_t*, const pthread_condattr_t*) __nonnull((1));
144int pthread_cond_signal(pthread_cond_t*) __nonnull((1));
145int pthread_cond_timedwait(pthread_cond_t*, pthread_mutex_t*, const struct timespec*) __nonnull((1, 2, 3));
146int pthread_cond_wait(pthread_cond_t*, pthread_mutex_t*) __nonnull((1, 2));
147
148int pthread_create(pthread_t*, pthread_attr_t const*, void *(*)(void*), void*) __nonnull((1, 3));
149int pthread_detach(pthread_t);
150void pthread_exit(void*) __noreturn;
151
152int pthread_equal(pthread_t, pthread_t);
153
154int pthread_getattr_np(pthread_t, pthread_attr_t*) __nonnull((2));
155
156int pthread_getcpuclockid(pthread_t, clockid_t*) __nonnull((2));
157
158int pthread_getschedparam(pthread_t, int*, struct sched_param*) __nonnull((2, 3));
159
160void* pthread_getspecific(pthread_key_t);
161
162pid_t pthread_gettid_np(pthread_t);
163
164int pthread_join(pthread_t, void**);
165
166int pthread_key_create(pthread_key_t*, void (*)(void*)) __nonnull((1));
167int pthread_key_delete(pthread_key_t);
168
169int pthread_mutexattr_destroy(pthread_mutexattr_t*) __nonnull((1));
170int pthread_mutexattr_getpshared(const pthread_mutexattr_t*, int*) __nonnull((1, 2));
171int pthread_mutexattr_gettype(const pthread_mutexattr_t*, int*) __nonnull((1, 2));
172int pthread_mutexattr_init(pthread_mutexattr_t*) __nonnull((1));
173int pthread_mutexattr_setpshared(pthread_mutexattr_t*, int) __nonnull((1));
174int pthread_mutexattr_settype(pthread_mutexattr_t*, int) __nonnull((1));
175
176int pthread_mutex_destroy(pthread_mutex_t*) __nonnull((1));
177int pthread_mutex_init(pthread_mutex_t*, const pthread_mutexattr_t*) __nonnull((1));
178int pthread_mutex_lock(pthread_mutex_t*) __nonnull((1));
179int pthread_mutex_timedlock(pthread_mutex_t*, const struct timespec*) __nonnull((1, 2));
180int pthread_mutex_trylock(pthread_mutex_t*) __nonnull((1));
181int pthread_mutex_unlock(pthread_mutex_t*) __nonnull((1));
182
183int pthread_once(pthread_once_t*, void (*)(void)) __nonnull((1, 2));
184
185int pthread_rwlockattr_destroy(pthread_rwlockattr_t*) __nonnull((1));
186int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t*, int*) __nonnull((1, 2));
187int pthread_rwlockattr_init(pthread_rwlockattr_t*) __nonnull((1));
188int pthread_rwlockattr_setpshared(pthread_rwlockattr_t*, int) __nonnull((1));
189
190int pthread_rwlock_destroy(pthread_rwlock_t*) __nonnull((1));
191int pthread_rwlock_init(pthread_rwlock_t*, const pthread_rwlockattr_t*) __nonnull((1));
192int pthread_rwlock_rdlock(pthread_rwlock_t*) __nonnull((1));
193int pthread_rwlock_timedrdlock(pthread_rwlock_t*, const struct timespec*) __nonnull((1, 2));
194int pthread_rwlock_timedwrlock(pthread_rwlock_t*, const struct timespec*) __nonnull((1, 2));
195int pthread_rwlock_tryrdlock(pthread_rwlock_t*) __nonnull((1));
196int pthread_rwlock_trywrlock(pthread_rwlock_t*) __nonnull((1));
197int pthread_rwlock_unlock(pthread_rwlock_t *rwlock) __nonnull((1));
198int pthread_rwlock_wrlock(pthread_rwlock_t*) __nonnull((1));
199
200pthread_t pthread_self(void) __pure2;
201
202int pthread_setname_np(pthread_t, const char*) __nonnull((2));
203
204int pthread_setschedparam(pthread_t, int, const struct sched_param*) __nonnull((3));
205
206int pthread_setspecific(pthread_key_t, const void*);
207
208typedef void (*__pthread_cleanup_func_t)(void*);
209
210typedef struct __pthread_cleanup_t {
211  struct __pthread_cleanup_t*   __cleanup_prev;
212  __pthread_cleanup_func_t      __cleanup_routine;
213  void*                         __cleanup_arg;
214} __pthread_cleanup_t;
215
216extern void __pthread_cleanup_push(__pthread_cleanup_t* c, __pthread_cleanup_func_t, void*);
217extern void __pthread_cleanup_pop(__pthread_cleanup_t*, int);
218
219/* Believe or not, the definitions of pthread_cleanup_push and
220 * pthread_cleanup_pop below are correct. Posix states that these
221 * can be implemented as macros that might introduce opening and
222 * closing braces, and that using setjmp/longjmp/return/break/continue
223 * between them results in undefined behavior.
224 */
225#define  pthread_cleanup_push(routine, arg)                      \
226    do {                                                         \
227        __pthread_cleanup_t  __cleanup;                          \
228        __pthread_cleanup_push( &__cleanup, (routine), (arg) );  \
229
230#define  pthread_cleanup_pop(execute)                  \
231        __pthread_cleanup_pop( &__cleanup, (execute)); \
232    } while (0);                                       \
233
234
235#if !defined(__LP64__)
236
237// Bionic additions that are deprecated even in the 32-bit ABI.
238//
239// TODO: Remove them once chromium_org / NFC have switched over.
240int pthread_cond_timedwait_monotonic_np(pthread_cond_t*, pthread_mutex_t*, const struct timespec*);
241int pthread_cond_timedwait_monotonic(pthread_cond_t*, pthread_mutex_t*, const struct timespec*);
242
243int pthread_cond_timedwait_relative_np(pthread_cond_t*, pthread_mutex_t*, const struct timespec*) /* TODO: __attribute__((deprecated("use pthread_cond_timedwait instead")))*/;
244#define HAVE_PTHREAD_COND_TIMEDWAIT_RELATIVE 1 /* TODO: stop defining this to push LP32 off this API sooner. */
245int pthread_cond_timeout_np(pthread_cond_t*, pthread_mutex_t*, unsigned) /* TODO: __attribute__((deprecated("use pthread_cond_timedwait instead")))*/;
246
247int pthread_mutex_lock_timeout_np(pthread_mutex_t*, unsigned) __attribute__((deprecated("use pthread_mutex_timedlock instead")));
248
249#endif /* !defined(__LP64__) */
250
251__END_DECLS
252
253#endif /* _PTHREAD_H_ */
254