pthreads/pthread.h

   1 /*
   2  * Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  * Copyright 1996 1995 by Open Software Foundation, Inc. 1997 1996 1995 1994 1993 1992 1991
  25  *              All Rights Reserved
  26  *
  27  * Permission to use, copy, modify, and distribute this software and
  28  * its documentation for any purpose and without fee is hereby granted,
  29  * provided that the above copyright notice appears in all copies and
  30  * that both the copyright notice and this permission notice appear in
  31  * supporting documentation.
  32  *
  33  * OSF DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
  34  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  35  * FOR A PARTICULAR PURPOSE.
  36  *
  37  * IN NO EVENT SHALL OSF BE LIABLE FOR ANY SPECIAL, INDIRECT, OR
  38  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  39  * LOSS OF USE, DATA OR PROFITS, WHETHER IN ACTION OF CONTRACT,
  40  * NEGLIGENCE, OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
  41  * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  42  *
  43  */
  44 /*
  45  * MkLinux
  46  */
  47
  48 /*
  49  * POSIX Threads - IEEE 1003.1c
  50  */
  51
  52 #ifndef _POSIX_PTHREAD_H
  53 #define _POSIX_PTHREAD_H
  54
  55 #include <_types.h>
  56 #ifndef __POSIX_LIB__
  57 #include <pthread_impl.h>
  58 #endif
  59 #include <sched.h>
  60 #include <time.h>
  61
  62 #ifndef _PTHREAD_ATTR_T
  63 #define _PTHREAD_ATTR_T
  64 typedef __darwin_pthread_attr_t         pthread_attr_t;
  65 #endif
  66
  67 #ifndef _PTHREAD_COND_T
  68 #define _PTHREAD_COND_T
  69 typedef __darwin_pthread_cond_t         pthread_cond_t;
  70 #endif
  71
  72 #ifndef _PTHREAD_CONDATTR_T
  73 #define _PTHREAD_CONDATTR_T
  74 typedef __darwin_pthread_condattr_t     pthread_condattr_t;
  75 #endif
  76
  77 #ifndef _PTHREAD_KEY_T
  78 #define _PTHREAD_KEY_T
  79 typedef __darwin_pthread_key_t          pthread_key_t;
  80 #endif
  81
  82 #ifndef _PTHREAD_MUTEX_T
  83 #define _PTHREAD_MUTEX_T
  84 typedef __darwin_pthread_mutex_t        pthread_mutex_t;
  85 #endif
  86
  87 #ifndef _PTHREAD_MUTEXATTR_T
  88 #define _PTHREAD_MUTEXATTR_T
  89 typedef __darwin_pthread_mutexattr_t    pthread_mutexattr_t;
  90 #endif
  91
  92 #ifndef _PTHREAD_ONCE_T
  93 #define _PTHREAD_ONCE_T
  94 typedef __darwin_pthread_once_t         pthread_once_t;
  95 #endif
  96
  97 #ifndef _PTHREAD_RWLOCK_T
  98 #define _PTHREAD_RWLOCK_T
  99 typedef __darwin_pthread_rwlock_t       pthread_rwlock_t;
 100 #endif
 101
 102 #ifndef _PTHREAD_RWLOCKATTR_T
 103 #define _PTHREAD_RWLOCKATTR_T
 104 typedef __darwin_pthread_rwlockattr_t   pthread_rwlockattr_t;
 105 #endif
 106
 107 #ifndef _PTHREAD_T
 108 #define _PTHREAD_T
 109 typedef __darwin_pthread_t              pthread_t;
 110 #endif
 111
 112 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)
 113
 114 #ifndef _MACH_PORT_T
 115 #define _MACH_PORT_T
 116 typedef __darwin_mach_port_t            mach_port_t;
 117 #endif
 118
 119 #ifndef _SIGSET_T
 120 #define _SIGSET_T
 121 typedef __darwin_sigset_t               sigset_t;
 122 #endif
 123
 124 #endif /* ! _POSIX_C_SOURCE && ! _XOPEN_SOURCE */
 125
 126 /*
 127  * These symbols indicate which [optional] features are available
 128  * They can be tested at compile time via '#ifdef XXX'
 129  * The way to check for pthreads is like so:
 130
 131  * #include <unistd.h>
 132  * #ifdef _POSIX_THREADS
 133  * #include <pthread.h>
 134  * #endif
 135
 136  */
 137
 138 /* These will be moved to unistd.h */
 139
 140 /*
 141  * Note: These data structures are meant to be opaque.  Only enough
 142  * structure is exposed to support initializers.
 143  * All of the typedefs will be moved to <sys/types.h>
 144  */
 145
 146 #include <sys/cdefs.h>
 147
 148 __BEGIN_DECLS
 149 /*
 150  * Threads
 151  */
 152
 153
 154 /*
 155  * Cancel cleanup handler management.  Note, since these are implemented as macros,
 156  * they *MUST* occur in matched pairs!
 157  */
 158
 159 #define pthread_cleanup_push(func, val) \
 160    { \
 161              struct __darwin_pthread_handler_rec __handler; \
 162              pthread_t __self = pthread_self(); \
 163              __handler.__routine = func; \
 164              __handler.__arg = val; \
 165              __handler.__next = __self->__cleanup_stack; \
 166              __self->__cleanup_stack = &__handler;
 167
 168 #define pthread_cleanup_pop(execute) \
 169              /* Note: 'handler' must be in this same lexical context! */ \
 170              __self->__cleanup_stack = __handler.__next; \
 171              if (execute) (__handler.__routine)(__handler.__arg); \
 172    }
 173
 174 /*
 175  * Thread attributes
 176  */
 177
 178 #define PTHREAD_CREATE_JOINABLE      1
 179 #define PTHREAD_CREATE_DETACHED      2
 180
 181 #define PTHREAD_INHERIT_SCHED        1
 182 #define PTHREAD_EXPLICIT_SCHED       2
 183
 184 #define PTHREAD_CANCEL_ENABLE        0x01  /* Cancel takes place at next cancellation point */
 185 #define PTHREAD_CANCEL_DISABLE       0x00  /* Cancel postponed */
 186 #define PTHREAD_CANCEL_DEFERRED      0x02  /* Cancel waits until cancellation point */
 187 #define PTHREAD_CANCEL_ASYNCHRONOUS  0x00  /* Cancel occurs immediately */
 188
 189 /* Value returned from pthread_join() when a thread is canceled */
 190 #define PTHREAD_CANCELED             ((void *) 1)
 191
 192 /* We only support PTHREAD_SCOPE_SYSTEM */
 193 #define PTHREAD_SCOPE_SYSTEM         1
 194 #define PTHREAD_SCOPE_PROCESS        2
 195
 196 /* We only support PTHREAD_PROCESS_PRIVATE */
 197 #define PTHREAD_PROCESS_SHARED         1
 198 #define PTHREAD_PROCESS_PRIVATE        2
 199
 200 /*
 201  * Mutex protocol attributes
 202  */
 203 #define PTHREAD_PRIO_NONE            0
 204 #define PTHREAD_PRIO_INHERIT         1
 205 #define PTHREAD_PRIO_PROTECT         2
 206
 207 /*
 208  * Mutex type attributes
 209  */
 210 #define PTHREAD_MUTEX_NORMAL            0
 211 #define PTHREAD_MUTEX_ERRORCHECK        1
 212 #define PTHREAD_MUTEX_RECURSIVE         2
 213 #define PTHREAD_MUTEX_DEFAULT           PTHREAD_MUTEX_NORMAL
 214 /*
 215  * Mutex variables
 216  */
 217
 218 #define PTHREAD_MUTEX_INITIALIZER {_PTHREAD_MUTEX_SIG_init, {0}}
 219
 220 /*
 221  * Condition variable attributes
 222  */
 223
 224 /*
 225  * Condition variables
 226  */
 227
 228 #define PTHREAD_COND_INITIALIZER {_PTHREAD_COND_SIG_init, {0}}
 229
 230 /*
 231  * Initialization control (once) variables
 232  */
 233
 234 #define PTHREAD_ONCE_INIT {_PTHREAD_ONCE_SIG_init, {0}}
 235
 236 /*
 237  * Prototypes for all PTHREAD interfaces
 238  */
 239 int       pthread_atfork(void (*prepare)(void), void (*parent)(void),
 240                       void (*child)(void));
 241 int       pthread_attr_destroy(pthread_attr_t *attr);
 242 int       pthread_attr_getdetachstate(const pthread_attr_t *attr,
 243                                       int *detachstate);
 244 int       pthread_attr_getguardsize(const pthread_attr_t *attr,
 245                                       size_t *guardsize);
 246 int       pthread_attr_getinheritsched(const pthread_attr_t *attr,
 247                                        int *inheritsched);
 248 int       pthread_attr_getschedparam(const pthread_attr_t *attr,
 249                                      struct sched_param *param);
 250 int       pthread_attr_getschedpolicy(const pthread_attr_t *attr,
 251                                       int *policy);
 252 int       pthread_attr_getscope(pthread_attr_t *, int *);
 253 int       pthread_attr_getstack(const pthread_attr_t *attr,
 254                                       void **stackaddr, size_t *stacksize);
 255 int       pthread_attr_getstackaddr(const pthread_attr_t *attr,
 256                                       void **stackaddr);
 257 int       pthread_attr_getstacksize(const pthread_attr_t *attr,
 258                                       size_t *stacksize);
 259 int       pthread_attr_init(pthread_attr_t *attr);
 260 int       pthread_attr_setdetachstate(pthread_attr_t *attr,
 261                                       int detachstate);
 262 int       pthread_attr_setguardsize(pthread_attr_t *attr, size_t guardsize);
 263 int       pthread_attr_setinheritsched(pthread_attr_t *attr,
 264                                        int inheritsched);
 265 int       pthread_attr_setschedparam(pthread_attr_t *attr,
 266                                      const struct sched_param *param);
 267 int       pthread_attr_setschedpolicy(pthread_attr_t *attr,
 268                                       int policy);
 269 int       pthread_attr_setscope(pthread_attr_t *, int);
 270 int       pthread_attr_setstack(pthread_attr_t *attr,
 271                                       void *stackaddr, size_t stacksize);
 272 int       pthread_attr_setstackaddr(pthread_attr_t *attr,
 273                                       void *stackaddr);
 274 int       pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize);
 275 int       pthread_cancel(pthread_t thread) __DARWIN_ALIAS(pthread_cancel);
 276
 277 int       pthread_cond_broadcast(pthread_cond_t *cond);
 278 int       pthread_cond_destroy(pthread_cond_t *cond);
 279 int       pthread_cond_init(pthread_cond_t *cond,
 280                             const pthread_condattr_t *attr);
 281 int       pthread_cond_signal(pthread_cond_t *cond);
 282 int       pthread_cond_timedwait(pthread_cond_t *cond,
 283                                  pthread_mutex_t *mutex,
 284                                  const struct timespec *abstime) __DARWIN_ALIAS(pthread_cond_timedwait);
 285 int       pthread_cond_wait(pthread_cond_t *cond,
 286                             pthread_mutex_t *mutex) __DARWIN_ALIAS(pthread_cond_wait);
 287 int       pthread_condattr_destroy(pthread_condattr_t *attr);
 288 int       pthread_condattr_getpshared(const pthread_condattr_t *attr,
 289                         int *pshared);
 290 int       pthread_condattr_init(pthread_condattr_t *attr);
 291 int       pthread_condattr_setpshared(pthread_condattr_t *attr,
 292                         int pshared);
 293 int       pthread_create(pthread_t *thread,
 294                          const pthread_attr_t *attr,
 295                          void *(*start_routine)(void *),
 296                          void *arg);
 297 int       pthread_detach(pthread_t thread);
 298 int       pthread_equal(pthread_t t1,
 299                         pthread_t t2);
 300 void      pthread_exit(void *value_ptr) __dead2;
 301 int       pthread_getconcurrency(void);
 302 int       pthread_getschedparam(pthread_t thread,
 303                                 int *policy,
 304                                 struct sched_param *param);
 305 void     *pthread_getspecific(pthread_key_t key);
 306 int       pthread_join(pthread_t thread,
 307                        void **value_ptr) __DARWIN_ALIAS(pthread_join);
 308 int       pthread_key_create(pthread_key_t *key,
 309                              void (*destructor)(void *));
 310 int       pthread_key_delete(pthread_key_t key);
 311 int       pthread_mutex_destroy(pthread_mutex_t *mutex);
 312 int       pthread_mutex_getprioceiling(const pthread_mutex_t *mutex,
 313                                        int *prioceiling);
 314 int       pthread_mutex_init(pthread_mutex_t *mutex,
 315                              const pthread_mutexattr_t *attr);
 316 int       pthread_mutex_lock(pthread_mutex_t *mutex);
 317 int       pthread_mutex_setprioceiling(pthread_mutex_t *mutex,
 318                                        int prioceiling,
 319                                        int *old_prioceiling);
 320 int       pthread_mutex_trylock(pthread_mutex_t *mutex);
 321 int       pthread_mutex_unlock(pthread_mutex_t *mutex);
 322 int       pthread_mutexattr_destroy(pthread_mutexattr_t *attr);
 323 int       pthread_mutexattr_getprioceiling(const pthread_mutexattr_t *attr,
 324                                            int *prioceiling);
 325 int       pthread_mutexattr_getprotocol(const pthread_mutexattr_t *attr,
 326                                         int *protocol);
 327 int       pthread_mutexattr_getpshared(const pthread_mutexattr_t *attr,
 328                                         int *pshared);
 329 int       pthread_mutexattr_gettype(const pthread_mutexattr_t *attr,
 330                                         int *type);
 331 int       pthread_mutexattr_init(pthread_mutexattr_t *attr);
 332 int       pthread_mutexattr_setprioceiling(pthread_mutexattr_t *attr,
 333                                            int prioceiling);
 334 int       pthread_mutexattr_setprotocol(pthread_mutexattr_t *attr,
 335                                         int protocol);
 336 int       pthread_mutexattr_setpshared(pthread_mutexattr_t *attr,
 337                                         int pshared);
 338 int       pthread_mutexattr_settype(pthread_mutexattr_t *attr,
 339                                         int type);
 340 int       pthread_once(pthread_once_t *once_control,
 341                        void (*init_routine)(void));
 342 int       pthread_rwlock_destroy(pthread_rwlock_t * rwlock);
 343 int       pthread_rwlock_init(pthread_rwlock_t * rwlock,
 344                              const pthread_rwlockattr_t *attr);
 345 int       pthread_rwlock_rdlock(pthread_rwlock_t *rwlock);
 346 int       pthread_rwlock_tryrdlock(pthread_rwlock_t *rwlock);
 347 int       pthread_rwlock_trywrlock(pthread_rwlock_t *rwlock);
 348 int       pthread_rwlock_unlock(pthread_rwlock_t *rwlock);
 349 int       pthread_rwlock_wrlock(pthread_rwlock_t *rwlock);
 350 int       pthread_rwlockattr_destroy(pthread_rwlockattr_t *attr);
 351 int       pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *attr,
 352                         int *pshared);
 353 int       pthread_rwlockattr_init(pthread_rwlockattr_t *attr);
 354 int       pthread_rwlockattr_setpshared(pthread_rwlockattr_t *attr,
 355                         int pshared);
 356 pthread_t pthread_self(void);
 357
 358 int       pthread_setcancelstate(int state, int *oldstate) __DARWIN_ALIAS(pthread_setcancelstate);
 359 int       pthread_setcanceltype(int type, int *oldtype) __DARWIN_ALIAS(pthread_setcanceltype);
 360 int       pthread_setconcurrency(int);
 361 int       pthread_setschedparam(pthread_t thread,
 362                                 int policy,
 363                                 const struct sched_param *param);
 364 int       pthread_setspecific(pthread_key_t key,
 365                               const void *value);
 366 void      pthread_testcancel(void) __DARWIN_ALIAS(pthread_testcancel);
 367
 368 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)
 369 /* returns non-zero if pthread_create or cthread_fork have been called */
 370 int             pthread_is_threaded_np(void);
 371
 372 /* returns non-zero if the current thread is the main thread */
 373 int             pthread_main_np(void);
 374
 375 /* return the mach thread bound to the pthread */
 376 mach_port_t     pthread_mach_thread_np(pthread_t);
 377 size_t          pthread_get_stacksize_np(pthread_t);
 378 void *          pthread_get_stackaddr_np(pthread_t);
 379
 380 /* Like pthread_cond_signal(), but only wake up the specified pthread */
 381 int             pthread_cond_signal_thread_np(pthread_cond_t *, pthread_t);
 382
 383 /* Like pthread_cond_timedwait, but use a relative timeout */
 384 int             pthread_cond_timedwait_relative_np(pthread_cond_t *cond,
 385                                  pthread_mutex_t *mutex,
 386                                  const struct timespec *reltime);
 387
 388 /* Like pthread_create(), but leaves the thread suspended */
 389 int       pthread_create_suspended_np(pthread_t *thread,
 390                          const pthread_attr_t *attr,
 391                          void *(*start_routine)(void *),
 392                          void *arg);
 393 int       pthread_kill(pthread_t, int);
 394 int       pthread_sigmask(int, const sigset_t *, sigset_t *);
 395 void      pthread_yield_np(void);
 396 #endif /* ! _POSIX_C_SOURCE && ! _XOPEN_SOURCE */
 397 __END_DECLS
 398 #endif /* _POSIX_PTHREAD_H */