pthread.h revision e5f816c01780220880ee59a29f727c48b51365d3 
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
39#if defined(__LP64__)
40  #define __RESERVED_INITIALIZER , {0}
41#else
42  #define __RESERVED_INITIALIZER
43#endif
44
45typedef struct {
46  int volatile value;
47#ifdef __LP64__
48  char __reserved[36];
49#endif
50} pthread_mutex_t;
51
52#define  __PTHREAD_MUTEX_INIT_VALUE            0
53#define  __PTHREAD_RECURSIVE_MUTEX_INIT_VALUE  0x4000
54#define  __PTHREAD_ERRORCHECK_MUTEX_INIT_VALUE 0x8000
55
56#define PTHREAD_MUTEX_INITIALIZER {__PTHREAD_MUTEX_INIT_VALUE __RESERVED_INITIALIZER}
57#define PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP {__PTHREAD_ERRORCHECK_MUTEX_INIT_VALUE __RESERVED_INITIALIZER}
58#define PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP {__PTHREAD_RECURSIVE_MUTEX_INIT_VALUE __RESERVED_INITIALIZER}
59
60/* TODO: remove this namespace pollution. */
61#define PTHREAD_ERRORCHECK_MUTEX_INITIALIZER PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP
62#define PTHREAD_RECURSIVE_MUTEX_INITIALIZER PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
63
64enum {
65    PTHREAD_MUTEX_NORMAL = 0,
66    PTHREAD_MUTEX_RECURSIVE = 1,
67    PTHREAD_MUTEX_ERRORCHECK = 2,
68
69    PTHREAD_MUTEX_ERRORCHECK_NP = PTHREAD_MUTEX_ERRORCHECK,
70    PTHREAD_MUTEX_RECURSIVE_NP  = PTHREAD_MUTEX_RECURSIVE,
71
72    PTHREAD_MUTEX_DEFAULT = PTHREAD_MUTEX_NORMAL
73};
74
75typedef struct {
76  unsigned int value;
77#ifdef __LP64__
78  char __reserved[44];
79#endif
80} pthread_cond_t;
81
82#define PTHREAD_COND_INITIALIZER  {0 __RESERVED_INITIALIZER}
83
84typedef long pthread_mutexattr_t;
85typedef long pthread_condattr_t;
86
87typedef long pthread_rwlockattr_t;
88
89typedef struct {
90#if !defined(__LP64__)
91  pthread_mutex_t __unused_lock;
92  pthread_cond_t __unused_cond;
93#endif
94  volatile int32_t state; // 0=unlock, -1=writer lock, +n=reader lock
95  volatile int32_t writer_thread_id;
96  volatile int32_t pending_readers;
97  volatile int32_t pending_writers;
98  int32_t attr;
99#ifdef __LP64__
100  char __reserved[36];
101#else
102  char __reserved[12];
103#endif
104
105} pthread_rwlock_t;
106
107#ifdef __LP64__
108  #define PTHREAD_RWLOCK_INITIALIZER  { 0, 0, 0, 0, 0, { 0 } }
109#else
110  #define PTHREAD_RWLOCK_INITIALIZER  { PTHREAD_MUTEX_INITIALIZER, PTHREAD_COND_INITIALIZER, 0, 0, 0, 0, 0, { 0 } }
111#endif
112
113typedef int pthread_key_t;
114
115typedef int pthread_once_t;
116
117#define PTHREAD_ONCE_INIT 0
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));
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 stack_size) __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));
157int pthread_condattr_getpshared(const pthread_condattr_t*, int*) __nonnull((1, 2));
158int pthread_condattr_init(pthread_condattr_t*) __nonnull((1));
159int pthread_condattr_setclock(pthread_condattr_t*, clockid_t) __nonnull((1));
160int pthread_condattr_setpshared(pthread_condattr_t*, int) __nonnull((1));
161
162int pthread_cond_broadcast(pthread_cond_t*) __nonnull((1));
163int pthread_cond_destroy(pthread_cond_t*) __nonnull((1));
164int pthread_cond_init(pthread_cond_t*, const pthread_condattr_t*) __nonnull((1));
165int pthread_cond_signal(pthread_cond_t*) __nonnull((1));
166int pthread_cond_timedwait(pthread_cond_t*, pthread_mutex_t*, const struct timespec*) __nonnull((1, 2, 3));
167int pthread_cond_wait(pthread_cond_t*, pthread_mutex_t*) __nonnull((1, 2));
168
169int pthread_create(pthread_t*, pthread_attr_t const*, void *(*)(void*), void*) __nonnull((1, 3));
170int pthread_detach(pthread_t);
171void pthread_exit(void*) __noreturn;
172
173int pthread_equal(pthread_t, pthread_t);
174
175int pthread_getattr_np(pthread_t, pthread_attr_t*) __nonnull((2));
176
177int pthread_getcpuclockid(pthread_t, clockid_t*) __nonnull((2));
178
179int pthread_getschedparam(pthread_t, int*, struct sched_param*) __nonnull((2, 3));
180
181void* pthread_getspecific(pthread_key_t);
182
183pid_t pthread_gettid_np(pthread_t);
184
185int pthread_join(pthread_t, void**);
186
187int pthread_key_create(pthread_key_t*, void (*)(void*)) __nonnull((1));
188int pthread_key_delete(pthread_key_t);
189
190int pthread_mutexattr_destroy(pthread_mutexattr_t*) __nonnull((1));
191int pthread_mutexattr_getpshared(const pthread_mutexattr_t*, int*) __nonnull((1, 2));
192int pthread_mutexattr_gettype(const pthread_mutexattr_t*, int*) __nonnull((1, 2));
193int pthread_mutexattr_init(pthread_mutexattr_t*) __nonnull((1));
194int pthread_mutexattr_setpshared(pthread_mutexattr_t*, int) __nonnull((1));
195int pthread_mutexattr_settype(pthread_mutexattr_t*, int) __nonnull((1));
196
197int pthread_mutex_destroy(pthread_mutex_t*) __nonnull((1));
198int pthread_mutex_init(pthread_mutex_t*, const pthread_mutexattr_t*) __nonnull((1));
199int pthread_mutex_lock(pthread_mutex_t*) __nonnull((1));
200int pthread_mutex_timedlock(pthread_mutex_t*, const struct timespec*) __nonnull((1, 2));
201int pthread_mutex_trylock(pthread_mutex_t*) __nonnull((1));
202int pthread_mutex_unlock(pthread_mutex_t*) __nonnull((1));
203
204int pthread_once(pthread_once_t*, void (*)(void)) __nonnull((1, 2));
205
206int pthread_rwlockattr_destroy(pthread_rwlockattr_t*) __nonnull((1));
207int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t*, int*) __nonnull((1, 2));
208int pthread_rwlockattr_init(pthread_rwlockattr_t*) __nonnull((1));
209int pthread_rwlockattr_setpshared(pthread_rwlockattr_t*, int) __nonnull((1));
210
211int pthread_rwlock_destroy(pthread_rwlock_t*) __nonnull((1));
212int pthread_rwlock_init(pthread_rwlock_t*, const pthread_rwlockattr_t*) __nonnull((1));
213int pthread_rwlock_rdlock(pthread_rwlock_t*) __nonnull((1));
214int pthread_rwlock_timedrdlock(pthread_rwlock_t*, const struct timespec*) __nonnull((1, 2));
215int pthread_rwlock_timedwrlock(pthread_rwlock_t*, const struct timespec*) __nonnull((1, 2));
216int pthread_rwlock_tryrdlock(pthread_rwlock_t*) __nonnull((1));
217int pthread_rwlock_trywrlock(pthread_rwlock_t*) __nonnull((1));
218int pthread_rwlock_unlock(pthread_rwlock_t *rwlock) __nonnull((1));
219int pthread_rwlock_wrlock(pthread_rwlock_t*) __nonnull((1));
220
221pthread_t pthread_self(void) __pure2;
222
223int pthread_setname_np(pthread_t, const char*) __nonnull((2));
224
225int pthread_setschedparam(pthread_t, int, const struct sched_param*) __nonnull((3));
226
227int pthread_setspecific(pthread_key_t, const void*);
228
229typedef void (*__pthread_cleanup_func_t)(void*);
230
231typedef struct __pthread_cleanup_t {
232  struct __pthread_cleanup_t*   __cleanup_prev;
233  __pthread_cleanup_func_t      __cleanup_routine;
234  void*                         __cleanup_arg;
235} __pthread_cleanup_t;
236
237extern void __pthread_cleanup_push(__pthread_cleanup_t* c, __pthread_cleanup_func_t, void*);
238extern void __pthread_cleanup_pop(__pthread_cleanup_t*, int);
239
240/* Believe or not, the definitions of pthread_cleanup_push and
241 * pthread_cleanup_pop below are correct. Posix states that these
242 * can be implemented as macros that might introduce opening and
243 * closing braces, and that using setjmp/longjmp/return/break/continue
244 * between them results in undefined behavior.
245 */
246#define  pthread_cleanup_push(routine, arg)                      \
247    do {                                                         \
248        __pthread_cleanup_t  __cleanup;                          \
249        __pthread_cleanup_push( &__cleanup, (routine), (arg) );  \
250
251#define  pthread_cleanup_pop(execute)                  \
252        __pthread_cleanup_pop( &__cleanup, (execute)); \
253    } while (0);                                       \
254
255
256#if !defined(__LP64__)
257
258// Bionic additions that are deprecated even in the 32-bit ABI.
259//
260// TODO: Remove them once chromium_org / NFC have switched over.
261int pthread_cond_timedwait_monotonic_np(pthread_cond_t*, pthread_mutex_t*, const struct timespec*);
262int pthread_cond_timedwait_monotonic(pthread_cond_t*, pthread_mutex_t*, const struct timespec*);
263
264int pthread_cond_timedwait_relative_np(pthread_cond_t*, pthread_mutex_t*, const struct timespec*) /* TODO: __attribute__((deprecated("use pthread_cond_timedwait instead")))*/;
265#define HAVE_PTHREAD_COND_TIMEDWAIT_RELATIVE 1 /* TODO: stop defining this to push LP32 off this API sooner. */
266int pthread_cond_timeout_np(pthread_cond_t*, pthread_mutex_t*, unsigned) /* TODO: __attribute__((deprecated("use pthread_cond_timedwait instead")))*/;
267
268int pthread_mutex_lock_timeout_np(pthread_mutex_t*, unsigned) __attribute__((deprecated("use pthread_mutex_timedlock instead")));
269
270#endif /* !defined(__LP64__) */
271
272__END_DECLS
273
274#endif /* _PTHREAD_H_ */
275