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