• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_INITIALIZER             {0}
46 #define  PTHREAD_RECURSIVE_MUTEX_INITIALIZER   {0x4000}
47 #define  PTHREAD_ERRORCHECK_MUTEX_INITIALIZER  {0x8000}
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 
61 
62 typedef struct
63 {
64     int volatile value;
65 } pthread_cond_t;
66 
67 typedef struct
68 {
69     uint32_t flags;
70     void * stack_base;
71     size_t stack_size;
72     size_t guard_size;
73     int32_t sched_policy;
74     int32_t sched_priority;
75 } pthread_attr_t;
76 
77 typedef long pthread_mutexattr_t;
78 typedef long pthread_condattr_t;
79 
80 typedef int pthread_key_t;
81 typedef long pthread_t;
82 
83 typedef volatile int  pthread_once_t;
84 
85 /*
86  * Defines
87  */
88 #define PTHREAD_COND_INITIALIZER  {0}
89 
90 #define PTHREAD_STACK_MIN (2 * PAGE_SIZE)
91 
92 #define PTHREAD_CREATE_DETACHED  0x00000001
93 #define PTHREAD_CREATE_JOINABLE  0x00000000
94 
95 #define PTHREAD_ONCE_INIT    0
96 
97 #define PTHREAD_PROCESS_PRIVATE  0
98 #define PTHREAD_PROCESS_SHARED   1
99 
100 #define PTHREAD_SCOPE_SYSTEM     0
101 #define PTHREAD_SCOPE_PROCESS    1
102 
103 /*
104  * Prototypes
105  */
106 #if __cplusplus
107 extern "C" {
108 #endif
109 
110 int pthread_attr_init(pthread_attr_t * attr);
111 int pthread_attr_destroy(pthread_attr_t * attr);
112 
113 int pthread_attr_setdetachstate(pthread_attr_t * attr, int state);
114 int pthread_attr_getdetachstate(pthread_attr_t const * attr, int * state);
115 
116 int pthread_attr_setschedpolicy(pthread_attr_t * attr, int policy);
117 int pthread_attr_getschedpolicy(pthread_attr_t const * attr, int * policy);
118 
119 int pthread_attr_setschedparam(pthread_attr_t * attr, struct sched_param const * param);
120 int pthread_attr_getschedparam(pthread_attr_t const * attr, struct sched_param * param);
121 
122 int pthread_attr_setstacksize(pthread_attr_t * attr, size_t stack_size);
123 int pthread_attr_getstacksize(pthread_attr_t const * attr, size_t * stack_size);
124 
125 int pthread_attr_setstackaddr(pthread_attr_t * attr, void * stackaddr);
126 int pthread_attr_getstackaddr(pthread_attr_t const * attr, void ** stackaddr);
127 
128 int pthread_attr_setstack(pthread_attr_t * attr, void * stackaddr, size_t stack_size);
129 int pthread_attr_getstack(pthread_attr_t const * attr, void ** stackaddr, size_t * stack_size);
130 
131 int pthread_attr_setguardsize(pthread_attr_t * attr, size_t guard_size);
132 int pthread_attr_getguardsize(pthread_attr_t const * attr, size_t * guard_size);
133 
134 int pthread_attr_setscope(pthread_attr_t *attr, int  scope);
135 int pthread_attr_getscope(pthread_attr_t const *attr);
136 
137 int pthread_getattr_np(pthread_t thid, pthread_attr_t * attr);
138 
139 int pthread_create(pthread_t *thread, pthread_attr_t const * attr,
140                    void *(*start_routine)(void *), void * arg);
141 void pthread_exit(void * retval);
142 int pthread_join(pthread_t thid, void ** ret_val);
143 int pthread_detach(pthread_t  thid);
144 
145 pthread_t pthread_self(void);
146 int pthread_equal(pthread_t one, pthread_t two);
147 
148 int pthread_getschedparam(pthread_t thid, int * policy,
149                           struct sched_param * param);
150 int pthread_setschedparam(pthread_t thid, int poilcy,
151                           struct sched_param const * param);
152 
153 int pthread_mutexattr_init(pthread_mutexattr_t *attr);
154 int pthread_mutexattr_destroy(pthread_mutexattr_t *attr);
155 int pthread_mutexattr_gettype(const pthread_mutexattr_t *attr, int *type);
156 int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int type);
157 int pthread_mutexattr_setpshared(pthread_mutexattr_t *attr, int  pshared);
158 int pthread_mutexattr_getpshared(pthread_mutexattr_t *attr, int *pshared);
159 
160 int pthread_mutex_init(pthread_mutex_t *mutex,
161                        const pthread_mutexattr_t *attr);
162 int pthread_mutex_destroy(pthread_mutex_t *mutex);
163 int pthread_mutex_lock(pthread_mutex_t *mutex);
164 int pthread_mutex_unlock(pthread_mutex_t *mutex);
165 int pthread_mutex_trylock(pthread_mutex_t *mutex);
166 int pthread_mutex_timedlock(pthread_mutex_t *mutex, struct timespec*  ts);
167 
168 int pthread_condattr_init(pthread_condattr_t *attr);
169 int pthread_condattr_getpshared(pthread_condattr_t *attr, int *pshared);
170 int pthread_condattr_setpshared(pthread_condattr_t* attr, int pshared);
171 int pthread_condattr_destroy(pthread_condattr_t *attr);
172 
173 int pthread_cond_init(pthread_cond_t *cond,
174                       const pthread_condattr_t *attr);
175 int pthread_cond_destroy(pthread_cond_t *cond);
176 int pthread_cond_broadcast(pthread_cond_t *cond);
177 int pthread_cond_signal(pthread_cond_t *cond);
178 int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex);
179 int pthread_cond_timedwait(pthread_cond_t *cond,
180                            pthread_mutex_t * mutex,
181                            const struct timespec *abstime);
182 
183 /* BIONIC: same as pthread_cond_timedwait, except the 'abstime' given refers
184  *         to the CLOCK_MONOTONIC clock instead, to avoid any problems when
185  *         the wall-clock time is changed brutally
186  */
187 int pthread_cond_timedwait_monotonic_np(pthread_cond_t         *cond,
188                                         pthread_mutex_t        *mutex,
189                                         const struct timespec  *abstime);
190 
191 /* BIONIC: DEPRECATED. same as pthread_cond_timedwait_monotonic_np()
192  * unfortunately pthread_cond_timedwait_monotonic has shipped already
193  */
194 int pthread_cond_timedwait_monotonic(pthread_cond_t         *cond,
195                                      pthread_mutex_t        *mutex,
196                                      const struct timespec  *abstime);
197 
198 #define HAVE_PTHREAD_COND_TIMEDWAIT_MONOTONIC 1
199 
200 /* BIONIC: same as pthread_cond_timedwait, except the 'reltime' given refers
201  *         is relative to the current time.
202  */
203 int pthread_cond_timedwait_relative_np(pthread_cond_t         *cond,
204                                      pthread_mutex_t        *mutex,
205                                      const struct timespec  *reltime);
206 
207 #define HAVE_PTHREAD_COND_TIMEDWAIT_RELATIVE 1
208 
209 
210 
211 int pthread_cond_timeout_np(pthread_cond_t *cond,
212                             pthread_mutex_t * mutex,
213                             unsigned msecs);
214 
215 /* same as pthread_mutex_lock(), but will wait up to 'msecs' milli-seconds
216  * before returning. same return values than pthread_mutex_trylock though, i.e.
217  * returns EBUSY if the lock could not be acquired after the timeout
218  * expired.
219  */
220 int pthread_mutex_lock_timeout_np(pthread_mutex_t *mutex, unsigned msecs);
221 
222 /* read-write lock support */
223 
224 typedef int pthread_rwlockattr_t;
225 
226 typedef struct {
227     pthread_mutex_t  lock;
228     pthread_cond_t   cond;
229     int              numLocks;
230     int              writerThreadId;
231     int              pendingReaders;
232     int              pendingWriters;
233     void*            reserved[4];  /* for future extensibility */
234 } pthread_rwlock_t;
235 
236 #define PTHREAD_RWLOCK_INITIALIZER  { PTHREAD_MUTEX_INITIALIZER, 0, NULL, 0, 0 }
237 
238 int pthread_rwlockattr_init(pthread_rwlockattr_t *attr);
239 int pthread_rwlockattr_destroy(pthread_rwlockattr_t *attr);
240 int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *attr, int  pshared);
241 int pthread_rwlockattr_getpshared(pthread_rwlockattr_t *attr, int *pshared);
242 
243 int pthread_rwlock_init(pthread_rwlock_t *rwlock, const pthread_rwlockattr_t *attr);
244 int pthread_rwlock_destroy(pthread_rwlock_t *rwlock);
245 
246 int pthread_rwlock_rdlock(pthread_rwlock_t *rwlock);
247 int pthread_rwlock_tryrdlock(pthread_rwlock_t *rwlock);
248 int pthread_rwlock_timedrdlock(pthread_rwlock_t *rwlock, const struct timespec *abs_timeout);
249 
250 int pthread_rwlock_wrlock(pthread_rwlock_t *rwlock);
251 int pthread_rwlock_trywrlock(pthread_rwlock_t *rwlock);
252 int pthread_rwlock_timedwrlock(pthread_rwlock_t *rwlock, const struct timespec *abs_timeout);
253 
254 int pthread_rwlock_unlock(pthread_rwlock_t *rwlock);
255 
256 
257 int pthread_key_create(pthread_key_t *key, void (*destructor_function)(void *));
258 int pthread_key_delete (pthread_key_t);
259 int pthread_setspecific(pthread_key_t key, const void *value);
260 void *pthread_getspecific(pthread_key_t key);
261 
262 int pthread_kill(pthread_t tid, int sig);
263 int pthread_sigmask(int how, const sigset_t *set, sigset_t *oset);
264 
265 int pthread_getcpuclockid(pthread_t  tid, clockid_t  *clockid);
266 
267 int pthread_once(pthread_once_t  *once_control, void (*init_routine)(void));
268 
269 int pthread_setname_np(pthread_t thid, const char *thname);
270 
271 typedef void  (*__pthread_cleanup_func_t)(void*);
272 
273 typedef struct __pthread_cleanup_t {
274     struct __pthread_cleanup_t*   __cleanup_prev;
275     __pthread_cleanup_func_t      __cleanup_routine;
276     void*                         __cleanup_arg;
277 } __pthread_cleanup_t;
278 
279 extern void  __pthread_cleanup_push(__pthread_cleanup_t*      c,
280                                     __pthread_cleanup_func_t  routine,
281                                     void*                     arg);
282 
283 extern void  __pthread_cleanup_pop(__pthread_cleanup_t*  c,
284                                    int                   execute);
285 
286 /* Believe or not, the definitions of pthread_cleanup_push and
287  * pthread_cleanup_pop below are correct. Posix states that these
288  * can be implemented as macros that might introduce opening and
289  * closing braces, and that using setjmp/longjmp/return/break/continue
290  * between them results in undefined behaviour.
291  *
292  * And indeed, GLibc and other C libraries use a similar definition
293  */
294 #define  pthread_cleanup_push(routine, arg)                      \
295     do {                                                         \
296         __pthread_cleanup_t  __cleanup;                          \
297         __pthread_cleanup_push( &__cleanup, (routine), (arg) );  \
298 
299 #define  pthread_cleanup_pop(execute)                  \
300         __pthread_cleanup_pop( &__cleanup, (execute)); \
301     } while (0);
302 
303 #if __cplusplus
304 } /* extern "C" */
305 #endif
306 
307 /************ TO FIX ************/
308 
309 #define LONG_LONG_MAX __LONG_LONG_MAX__
310 #define LONG_LONG_MIN (-__LONG_LONG_MAX__ - 1)
311 
312 #endif /* _PTHREAD_H_ */
313