1 /* 2 * Copyright 2001-2011 Haiku, Inc. All Rights Reserved. 3 * Distributed under the terms of the MIT License. 4 */ 5 #ifndef _PTHREAD_H_ 6 #define _PTHREAD_H_ 7 8 9 #include <sched.h> 10 #include <stdint.h> 11 #include <sys/types.h> 12 #include <time.h> 13 14 15 #define PTHREAD_MUTEX_DEFAULT 0 16 #define PTHREAD_MUTEX_NORMAL 1 17 #define PTHREAD_MUTEX_ERRORCHECK 2 18 #define PTHREAD_MUTEX_RECURSIVE 3 19 20 #define PTHREAD_PROCESS_PRIVATE 0 21 #define PTHREAD_PROCESS_SHARED 1 22 23 /* 24 * Flags for threads and thread attributes. 25 */ 26 #define PTHREAD_DETACHED 0x1 27 #define PTHREAD_SCOPE_SYSTEM 0x2 28 #define PTHREAD_INHERIT_SCHED 0x4 29 #define PTHREAD_NOFLOAT 0x8 30 31 #define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED 32 #define PTHREAD_CREATE_JOINABLE 0 33 #define PTHREAD_SCOPE_PROCESS 0 34 #define PTHREAD_EXPLICIT_SCHED 0 35 36 /* 37 * Flags for cancelling threads 38 */ 39 #define PTHREAD_CANCEL_ENABLE 0 40 #define PTHREAD_CANCEL_DISABLE 1 41 #define PTHREAD_CANCEL_DEFERRED 0 42 #define PTHREAD_CANCEL_ASYNCHRONOUS 2 43 #define PTHREAD_CANCELED ((void *) 1) 44 45 #define PTHREAD_ONCE_INIT { -1 } 46 47 #define PTHREAD_BARRIER_SERIAL_THREAD -1 48 #define PTHREAD_PRIO_NONE 0 49 #define PTHREAD_PRIO_INHERIT 1 50 #define PTHREAD_PRIO_PROTECT 2 51 52 #define PTHREAD_DESTRUCTOR_ITERATIONS 4 53 54 55 /* private structure */ 56 struct __pthread_cleanup_handler { 57 struct __pthread_cleanup_handler *previous; 58 void (*function)(void *argument); 59 void *argument; 60 }; 61 62 #define pthread_cleanup_push(func, arg) \ 63 do { \ 64 struct __pthread_cleanup_handler __handler; \ 65 __handler.function = (func); \ 66 __handler.argument = (arg); \ 67 __pthread_cleanup_push_handler(&__handler); 68 69 #define pthread_cleanup_pop(execute) \ 70 if (execute) \ 71 __handler.function(__handler.argument); \ 72 __pthread_cleanup_pop_handler(); \ 73 } while (0) 74 75 76 #ifdef __cplusplus 77 extern "C" { 78 #endif 79 80 #define PTHREAD_MUTEX_INITIALIZER \ 81 { PTHREAD_MUTEX_DEFAULT, 0, -42, -1, 0 } 82 #define PTHREAD_RECURSIVE_MUTEX_INITIALIZER \ 83 { PTHREAD_MUTEX_RECURSIVE, 0, -42, -1, 0 } 84 #define PTHREAD_COND_INITIALIZER \ 85 { 0, -42, NULL, 0, 0 } 86 #define PTHREAD_RWLOCK_INITIALIZER \ 87 { 0, -1, {{0}} } 88 89 /* mutex functions */ 90 extern int pthread_mutex_destroy(pthread_mutex_t *mutex); 91 extern int pthread_mutex_getprioceiling(const pthread_mutex_t *mutex, 92 int *_priorityCeiling); 93 extern int pthread_mutex_init(pthread_mutex_t *mutex, 94 const pthread_mutexattr_t *attr); 95 extern int pthread_mutex_lock(pthread_mutex_t *mutex); 96 extern int pthread_mutex_setprioceiling(pthread_mutex_t *mutex, 97 int newPriorityCeiling, int *_oldPriorityCeiling); 98 extern int pthread_mutex_clocklock(pthread_mutex_t *mutex, 99 clockid_t clock_id, const struct timespec *abstime); 100 extern int pthread_mutex_timedlock(pthread_mutex_t *mutex, 101 const struct timespec *abstime); 102 extern int pthread_mutex_trylock(pthread_mutex_t *mutex); 103 extern int pthread_mutex_unlock(pthread_mutex_t *mutex); 104 105 /* mutex attribute functions */ 106 extern int pthread_mutexattr_destroy(pthread_mutexattr_t *mutexAttr); 107 extern int pthread_mutexattr_getprioceiling(const pthread_mutexattr_t *mutexAttr, 108 int *_priorityCeiling); 109 extern int pthread_mutexattr_getprotocol(const pthread_mutexattr_t *mutexAttr, 110 int *_protocol); 111 extern int pthread_mutexattr_getpshared(const pthread_mutexattr_t *mutexAttr, 112 int *_processShared); 113 extern int pthread_mutexattr_gettype(const pthread_mutexattr_t *mutexAttr, 114 int *_type); 115 extern int pthread_mutexattr_init(pthread_mutexattr_t *mutexAttr); 116 extern int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *mutexAttr, 117 int priorityCeiling); 118 extern int pthread_mutexattr_setprotocol(pthread_mutexattr_t *mutexAttr, 119 int protocol); 120 extern int pthread_mutexattr_setpshared(pthread_mutexattr_t *mutexAttr, 121 int processShared); 122 extern int pthread_mutexattr_settype(pthread_mutexattr_t *mutexAttr, int type); 123 124 /* barrier functions */ 125 extern int pthread_barrier_init(pthread_barrier_t *barrier, 126 const pthread_barrierattr_t *attr, unsigned count); 127 extern int pthread_barrier_destroy(pthread_barrier_t *barrier); 128 extern int pthread_barrier_wait(pthread_barrier_t *barrier); 129 130 /* barrier attribute functions */ 131 extern int pthread_barrierattr_destroy(pthread_barrierattr_t *attr); 132 extern int pthread_barrierattr_getpshared(const pthread_barrierattr_t *attr, 133 int *shared); 134 extern int pthread_barrierattr_init(pthread_barrierattr_t *attr); 135 extern int pthread_barrierattr_setpshared(pthread_barrierattr_t *attr, 136 int shared); 137 138 /* condition variable functions */ 139 extern int pthread_cond_destroy(pthread_cond_t *cond); 140 extern int pthread_cond_init(pthread_cond_t *cond, 141 const pthread_condattr_t *attr); 142 extern int pthread_cond_broadcast(pthread_cond_t *cond); 143 extern int pthread_cond_signal(pthread_cond_t *cond); 144 extern int pthread_cond_clockwait(pthread_cond_t *cond, pthread_mutex_t *mutex, 145 clockid_t clock_id, const struct timespec *abstime); 146 extern int pthread_cond_timedwait(pthread_cond_t *cond, pthread_mutex_t *mutex, 147 const struct timespec *abstime); 148 extern int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex); 149 150 /* condition variable attribute functions */ 151 extern int pthread_condattr_destroy(pthread_condattr_t *condAttr); 152 extern int pthread_condattr_init(pthread_condattr_t *condAttr); 153 extern int pthread_condattr_getpshared(const pthread_condattr_t *condAttr, 154 int *processShared); 155 extern int pthread_condattr_setpshared(pthread_condattr_t *condAttr, 156 int processShared); 157 extern int pthread_condattr_getclock(const pthread_condattr_t *condAttr, 158 clockid_t *clockID); 159 extern int pthread_condattr_setclock(pthread_condattr_t *condAttr, 160 clockid_t clockID); 161 162 /* rwlock functions */ 163 extern int pthread_rwlock_init(pthread_rwlock_t *lock, 164 const pthread_rwlockattr_t *attr); 165 extern int pthread_rwlock_destroy(pthread_rwlock_t *lock); 166 extern int pthread_rwlock_rdlock(pthread_rwlock_t *lock); 167 extern int pthread_rwlock_tryrdlock(pthread_rwlock_t *lock); 168 extern int pthread_rwlock_clockrdlock(pthread_rwlock_t* rwlock, 169 clockid_t clock_id, const struct timespec* abstime); 170 extern int pthread_rwlock_timedrdlock(pthread_rwlock_t *lock, 171 const struct timespec *abstime); 172 extern int pthread_rwlock_wrlock(pthread_rwlock_t *lock); 173 extern int pthread_rwlock_trywrlock(pthread_rwlock_t *lock); 174 extern int pthread_rwlock_clockwrlock(pthread_rwlock_t* rwlock, 175 clockid_t clock_id, const struct timespec* abstime); 176 extern int pthread_rwlock_timedwrlock(pthread_rwlock_t *lock, 177 const struct timespec *abstime); 178 extern int pthread_rwlock_unlock(pthread_rwlock_t *lock); 179 180 /* rwlock attribute functions */ 181 extern int pthread_rwlockattr_init(pthread_rwlockattr_t *attr); 182 extern int pthread_rwlockattr_destroy(pthread_rwlockattr_t *attr); 183 extern int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *attr, 184 int *shared); 185 extern int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *attr, 186 int shared); 187 188 /* spinlock functions */ 189 extern int pthread_spin_init(pthread_spinlock_t* spinlock, int pshared); 190 extern int pthread_spin_destroy(pthread_spinlock_t* spinlock); 191 extern int pthread_spin_lock(pthread_spinlock_t* spinlock); 192 extern int pthread_spin_trylock(pthread_spinlock_t* spinlock); 193 extern int pthread_spin_unlock(pthread_spinlock_t* spinlock); 194 195 /* misc. functions */ 196 extern int pthread_atfork(void (*prepare)(void), void (*parent)(void), 197 void (*child)(void)); 198 extern int pthread_once(pthread_once_t *once_control, 199 void (*init_routine)(void)); 200 201 /* thread attributes functions */ 202 extern int pthread_attr_destroy(pthread_attr_t *attr); 203 extern int pthread_attr_init(pthread_attr_t *attr); 204 extern int pthread_attr_getdetachstate(const pthread_attr_t *attr, 205 int *detachstate); 206 extern int pthread_attr_setdetachstate(pthread_attr_t *attr, int detachstate); 207 extern int pthread_attr_getstacksize(const pthread_attr_t *attr, 208 size_t *stacksize); 209 extern int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize); 210 extern int pthread_attr_getscope(const pthread_attr_t *attr, 211 int *contentionScope); 212 extern int pthread_attr_setscope(pthread_attr_t *attr, int contentionScope); 213 214 extern int pthread_attr_getschedparam(const pthread_attr_t *attr, 215 struct sched_param *param); 216 extern int pthread_attr_setschedparam(pthread_attr_t *attr, 217 const struct sched_param *param); 218 219 extern int pthread_attr_getguardsize(const pthread_attr_t *attr, 220 size_t *guardsize); 221 extern int pthread_attr_setguardsize(pthread_attr_t *attr, size_t guardsize); 222 223 extern int pthread_attr_getstack(const pthread_attr_t *attr, 224 void **stackaddr, size_t *stacksize); 225 extern int pthread_attr_setstack(pthread_attr_t *attr, void *stackaddr, 226 size_t stacksize); 227 228 #if 0 /* Unimplemented attribute functions: */ 229 230 /* [TPS] */ 231 extern int pthread_attr_getinheritsched(const pthread_attr_t *attr, 232 int *inheritsched); 233 extern int pthread_attr_setinheritsched(pthread_attr_t *attr, int inheritsched); 234 235 extern int pthread_attr_getschedpolicy(const pthread_attr_t *attr, 236 int *policy); 237 extern int pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy); 238 239 #endif /* 0 */ 240 241 /* thread functions */ 242 extern int pthread_create(pthread_t *thread, const pthread_attr_t *attr, 243 void *(*start_routine)(void*), void *arg); 244 extern int pthread_detach(pthread_t thread); 245 extern int pthread_equal(pthread_t t1, pthread_t t2); 246 extern void pthread_exit(void *value_ptr) __attribute__ ((noreturn)); 247 extern int pthread_join(pthread_t thread, void **_value); 248 extern pthread_t pthread_self(void); 249 extern int pthread_getconcurrency(void); 250 extern int pthread_setconcurrency(int newLevel); 251 252 extern int pthread_cancel(pthread_t thread); 253 extern int pthread_setcancelstate(int state, int *_oldState); 254 extern int pthread_setcanceltype(int type, int *_oldType); 255 extern void pthread_testcancel(void); 256 257 extern int pthread_getschedparam(pthread_t thread, int *policy, 258 struct sched_param *param); 259 extern int pthread_setschedparam(pthread_t thread, int policy, 260 const struct sched_param *param); 261 262 /* thread specific data functions */ 263 extern int pthread_key_create(pthread_key_t *key, 264 void (*destructorFunc)(void*)); 265 extern int pthread_key_delete(pthread_key_t key); 266 extern void *pthread_getspecific(pthread_key_t key); 267 extern int pthread_setspecific(pthread_key_t key, const void *value); 268 269 /* private functions */ 270 extern void __pthread_cleanup_push_handler( 271 struct __pthread_cleanup_handler *handler); 272 extern struct __pthread_cleanup_handler *__pthread_cleanup_pop_handler(void); 273 274 #ifdef __cplusplus 275 } 276 #endif 277 278 #endif /* _PTHREAD_ */ 279