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