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 #ifndef _PTHREAD_H_
29 #define _PTHREAD_H_
30 
31 #include <time.h>
32 #include <signal.h>
33 #include <sched.h>
34 #include <limits.h>
35 #include <sys/types.h>
36 
37 /*
38  * Types
39  */
40 typedef struct
41 {
42     int volatile value;
43 } pthread_mutex_t;
44 
45 #define  __PTHREAD_MUTEX_INIT_VALUE            0
46 #define  __PTHREAD_RECURSIVE_MUTEX_INIT_VALUE  0x4000
47 #define  __PTHREAD_ERRORCHECK_MUTEX_INIT_VALUE 0x8000
48 
49 #define  PTHREAD_MUTEX_INITIALIZER             {__PTHREAD_MUTEX_INIT_VALUE}
50 #define  PTHREAD_RECURSIVE_MUTEX_INITIALIZER   {__PTHREAD_RECURSIVE_MUTEX_INIT_VALUE}
51 #define  PTHREAD_ERRORCHECK_MUTEX_INITIALIZER  {__PTHREAD_ERRORCHECK_MUTEX_INIT_VALUE}
52 
53 enum {
54     PTHREAD_MUTEX_NORMAL = 0,
55     PTHREAD_MUTEX_RECURSIVE = 1,
56     PTHREAD_MUTEX_ERRORCHECK = 2,
57 
58     PTHREAD_MUTEX_ERRORCHECK_NP = PTHREAD_MUTEX_ERRORCHECK,
59     PTHREAD_MUTEX_RECURSIVE_NP  = PTHREAD_MUTEX_RECURSIVE,
60 
61     PTHREAD_MUTEX_DEFAULT = PTHREAD_MUTEX_NORMAL
62 };
63 
64 
65 
66 typedef struct
67 {
68     int volatile value;
69 } pthread_cond_t;
70 
71 typedef struct
72 {
73     uint32_t flags;
74     void * stack_base;
75     size_t stack_size;
76     size_t guard_size;
77     int32_t sched_policy;
78     int32_t sched_priority;
79 } pthread_attr_t;
80 
81 typedef long pthread_mutexattr_t;
82 typedef long pthread_condattr_t;
83 
84 typedef int pthread_key_t;
85 typedef long pthread_t;
86 
87 typedef volatile int  pthread_once_t;
88 
89 /*
90  * Defines
91  */
92 #define PTHREAD_COND_INITIALIZER  {0}
93 
94 #define PTHREAD_STACK_MIN (2 * PAGE_SIZE)
95 
96 #define PTHREAD_CREATE_DETACHED  0x00000001
97 #define PTHREAD_CREATE_JOINABLE  0x00000000
98 
99 #define PTHREAD_ONCE_INIT    0
100 
101 #define PTHREAD_PROCESS_PRIVATE  0
102 #define PTHREAD_PROCESS_SHARED   1
103 
104 #define PTHREAD_SCOPE_SYSTEM     0
105 #define PTHREAD_SCOPE_PROCESS    1
106 
107 /*
108  * Prototypes
109  */
110 #ifdef __cplusplus
111 extern "C" {
112 #endif
113 
114 int pthread_attr_init(pthread_attr_t * attr);
115 int pthread_attr_destroy(pthread_attr_t * attr);
116 
117 int pthread_attr_setdetachstate(pthread_attr_t * attr, int state);
118 int pthread_attr_getdetachstate(pthread_attr_t const * attr, int * state);
119 
120 int pthread_attr_setschedpolicy(pthread_attr_t * attr, int policy);
121 int pthread_attr_getschedpolicy(pthread_attr_t const * attr, int * policy);
122 
123 int pthread_attr_setschedparam(pthread_attr_t * attr, struct sched_param const * param);
124 int pthread_attr_getschedparam(pthread_attr_t const * attr, struct sched_param * param);
125 
126 int pthread_attr_setstacksize(pthread_attr_t * attr, size_t stack_size);
127 int pthread_attr_getstacksize(pthread_attr_t const * attr, size_t * stack_size);
128 
129 int pthread_attr_setstackaddr(pthread_attr_t * attr, void * stackaddr);
130 int pthread_attr_getstackaddr(pthread_attr_t const * attr, void ** stackaddr);
131 
132 int pthread_attr_setstack(pthread_attr_t * attr, void * stackaddr, size_t stack_size);
133 int pthread_attr_getstack(pthread_attr_t const * attr, void ** stackaddr, size_t * stack_size);
134 
135 int pthread_attr_setguardsize(pthread_attr_t * attr, size_t guard_size);
136 int pthread_attr_getguardsize(pthread_attr_t const * attr, size_t * guard_size);
137 
138 int pthread_attr_setscope(pthread_attr_t *attr, int  scope);
139 int pthread_attr_getscope(pthread_attr_t const *attr);
140 
141 int pthread_getattr_np(pthread_t thid, pthread_attr_t * attr);
142 
143 int pthread_create(pthread_t *thread, pthread_attr_t const * attr,
144                    void *(*start_routine)(void *), void * arg);
145 
146 __noreturn void pthread_exit(void * retval);
147 
148 int pthread_join(pthread_t thid, void ** ret_val);
149 int pthread_detach(pthread_t  thid);
150 
151 pthread_t pthread_self(void);
152 int pthread_equal(pthread_t one, pthread_t two);
153 
154 int pthread_getschedparam(pthread_t thid, int * policy,
155                           struct sched_param * param);
156 int pthread_setschedparam(pthread_t thid, int poilcy,
157                           struct sched_param const * param);
158 
159 int pthread_mutexattr_init(pthread_mutexattr_t *attr);
160 int pthread_mutexattr_destroy(pthread_mutexattr_t *attr);
161 int pthread_mutexattr_gettype(const pthread_mutexattr_t *attr, int *type);
162 int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int type);
163 int pthread_mutexattr_setpshared(pthread_mutexattr_t *attr, int  pshared);
164 int pthread_mutexattr_getpshared(pthread_mutexattr_t *attr, int *pshared);
165 
166 int pthread_mutex_init(pthread_mutex_t *mutex,
167                        const pthread_mutexattr_t *attr);
168 int pthread_mutex_destroy(pthread_mutex_t *mutex);
169 int pthread_mutex_lock(pthread_mutex_t *mutex);
170 int pthread_mutex_unlock(pthread_mutex_t *mutex);
171 int pthread_mutex_trylock(pthread_mutex_t *mutex);
172 int pthread_mutex_timedlock(pthread_mutex_t *mutex, struct timespec*  ts);
173 
174 int pthread_condattr_init(pthread_condattr_t *attr);
175 int pthread_condattr_getpshared(pthread_condattr_t *attr, int *pshared);
176 int pthread_condattr_setpshared(pthread_condattr_t* attr, int pshared);
177 int pthread_condattr_destroy(pthread_condattr_t *attr);
178 
179 int pthread_cond_init(pthread_cond_t *cond,
180                       const pthread_condattr_t *attr);
181 int pthread_cond_destroy(pthread_cond_t *cond);
182 int pthread_cond_broadcast(pthread_cond_t *cond);
183 int pthread_cond_signal(pthread_cond_t *cond);
184 int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex);
185 int pthread_cond_timedwait(pthread_cond_t *cond,
186                            pthread_mutex_t * mutex,
187                            const struct timespec *abstime);
188 
189 /* BIONIC: same as pthread_cond_timedwait, except the 'abstime' given refers
190  *         to the CLOCK_MONOTONIC clock instead, to avoid any problems when
191  *         the wall-clock time is changed brutally
192  */
193 int pthread_cond_timedwait_monotonic_np(pthread_cond_t         *cond,
194                                         pthread_mutex_t        *mutex,
195                                         const struct timespec  *abstime);
196 
197 /* BIONIC: DEPRECATED. same as pthread_cond_timedwait_monotonic_np()
198  * unfortunately pthread_cond_timedwait_monotonic has shipped already
199  */
200 int pthread_cond_timedwait_monotonic(pthread_cond_t         *cond,
201                                      pthread_mutex_t        *mutex,
202                                      const struct timespec  *abstime);
203 
204 #define HAVE_PTHREAD_COND_TIMEDWAIT_MONOTONIC 1
205 
206 /* BIONIC: same as pthread_cond_timedwait, except the 'reltime' given refers
207  *         is relative to the current time.
208  */
209 int pthread_cond_timedwait_relative_np(pthread_cond_t         *cond,
210                                      pthread_mutex_t        *mutex,
211                                      const struct timespec  *reltime);
212 
213 #define HAVE_PTHREAD_COND_TIMEDWAIT_RELATIVE 1
214 
215 
216 
217 int pthread_cond_timeout_np(pthread_cond_t *cond,
218                             pthread_mutex_t * mutex,
219                             unsigned msecs);
220 
221 /* same as pthread_mutex_lock(), but will wait up to 'msecs' milli-seconds
222  * before returning. same return values than pthread_mutex_trylock though, i.e.
223  * returns EBUSY if the lock could not be acquired after the timeout
224  * expired.
225  */
226 int pthread_mutex_lock_timeout_np(pthread_mutex_t *mutex, unsigned msecs);
227 
228 int pthread_key_create(pthread_key_t *key, void (*destructor_function)(void *));
229 int pthread_key_delete (pthread_key_t);
230 int pthread_setspecific(pthread_key_t key, const void *value);
231 void *pthread_getspecific(pthread_key_t key);
232 
233 int pthread_kill(pthread_t tid, int sig);
234 int pthread_sigmask(int how, const sigset_t *set, sigset_t *oset);
235 
236 int pthread_getcpuclockid(pthread_t  tid, clockid_t  *clockid);
237 
238 int pthread_once(pthread_once_t  *once_control, void (*init_routine)(void));
239 
240 typedef void  (*__pthread_cleanup_func_t)(void*);
241 
242 typedef struct __pthread_cleanup_t {
243     struct __pthread_cleanup_t*   __cleanup_prev;
244     __pthread_cleanup_func_t      __cleanup_routine;
245     void*                         __cleanup_arg;
246 } __pthread_cleanup_t;
247 
248 extern void  __pthread_cleanup_push(__pthread_cleanup_t*      c,
249                                     __pthread_cleanup_func_t  routine,
250                                     void*                     arg);
251 
252 extern void  __pthread_cleanup_pop(__pthread_cleanup_t*  c,
253                                    int                   execute);
254 
255 /* Believe or not, the definitions of pthread_cleanup_push and
256  * pthread_cleanup_pop below are correct. Posix states that these
257  * can be implemented as macros that might introduce opening and
258  * closing braces, and that using setjmp/longjmp/return/break/continue
259  * between them results in undefined behaviour.
260  *
261  * And indeed, GLibc and other C libraries use a similar definition
262  */
263 #define  pthread_cleanup_push(routine, arg)                      \
264     do {                                                         \
265         __pthread_cleanup_t  __cleanup;                          \
266         __pthread_cleanup_push( &__cleanup, (routine), (arg) );  \
267 
268 #define  pthread_cleanup_pop(execute)                  \
269         __pthread_cleanup_pop( &__cleanup, (execute)); \
270     } while (0);
271 
272 #ifdef __cplusplus
273 } /* extern "C" */
274 #endif
275 
276 #endif /* _PTHREAD_H_ */
277