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 #ifndef __POSIX_LIB__
  56 #include <pthread_impl.h>
  57 #endif
  58 #include <errno.h>
  59 #include <sched.h>
  60 #include <time.h>
  61 #include <unistd.h>
  62 #include <limits.h>
  63 #include <signal.h>
  64
  65 #ifndef _POSIX_C_SOURCE
  66 #include <mach/mach_types.h>
  67 #endif /* ! _POSIX_C_SOURCE */
  68
  69 /*
  70  * These symbols indicate which [optional] features are available
  71  * They can be tested at compile time via '#ifdef XXX'
  72  * The way to check for pthreads is like so:
  73
  74  * #include <unistd.h>
  75  * #ifdef _POSIX_THREADS
  76  * #include <pthread.h>
  77  * #endif
  78
  79  */
  80
  81 /* These will be moved to unistd.h */
  82
  83
  84 /* These two should be defined also */
  85 #undef  _POSIX_THREAD_PROCESS_SHARED
  86 #undef  _POSIX_THREAD_SAFE_FUNCTIONS
  87
  88 /*
  89  * Note: These data structures are meant to be opaque.  Only enough
  90  * structure is exposed to support initializers.
  91  * All of the typedefs will be moved to <sys/types.h>
  92  */
  93
  94 #include <sys/cdefs.h>
  95
  96 __BEGIN_DECLS
  97 /*
  98  * Threads
  99  */
 100
 101
 102 /*
 103  * Cancel cleanup handler management.  Note, since these are implemented as macros,
 104  * they *MUST* occur in matched pairs!
 105  */
 106
 107 #define pthread_cleanup_push(func, val) \
 108    { \
 109              struct _pthread_handler_rec __handler; \
 110              pthread_t __self = pthread_self(); \
 111              __handler.routine = func; \
 112              __handler.arg = val; \
 113              __handler.next = __self->cleanup_stack; \
 114              __self->cleanup_stack = &__handler;
 115
 116 #define pthread_cleanup_pop(execute) \
 117              /* Note: 'handler' must be in this same lexical context! */ \
 118              __self->cleanup_stack = __handler.next; \
 119              if (execute) (__handler.routine)(__handler.arg); \
 120    }
 121
 122 /*
 123  * Thread attributes
 124  */
 125
 126 #define PTHREAD_CREATE_JOINABLE      1
 127 #define PTHREAD_CREATE_DETACHED      2
 128
 129 #define PTHREAD_INHERIT_SCHED        1
 130 #define PTHREAD_EXPLICIT_SCHED       2
 131
 132 #define PTHREAD_CANCEL_ENABLE        0x01  /* Cancel takes place at next cancellation point */
 133 #define PTHREAD_CANCEL_DISABLE       0x00  /* Cancel postponed */
 134 #define PTHREAD_CANCEL_DEFERRED      0x02  /* Cancel waits until cancellation point */
 135 #define PTHREAD_CANCEL_ASYNCHRONOUS  0x00  /* Cancel occurs immediately */
 136
 137 /* We only support PTHREAD_SCOPE_SYSTEM */
 138 #define PTHREAD_SCOPE_SYSTEM         1
 139 #define PTHREAD_SCOPE_PROCESS        2
 140
 141 /* We only support PTHREAD_PROCESS_PRIVATE */
 142 #define PTHREAD_PROCESS_SHARED         1
 143 #define PTHREAD_PROCESS_PRIVATE        2
 144
 145 /* Who defines this? */
 146
 147 #if !defined(ENOTSUP)
 148 #define ENOTSUP 89
 149 #endif
 150 /*
 151  * Mutex protocol attributes
 152  */
 153 #define PTHREAD_PRIO_NONE            0
 154 #define PTHREAD_PRIO_INHERIT         1
 155 #define PTHREAD_PRIO_PROTECT         2
 156
 157 /*
 158  * Mutex type attributes
 159  */
 160 #define PTHREAD_MUTEX_NORMAL            0
 161 #define PTHREAD_MUTEX_ERRORCHECK        1
 162 #define PTHREAD_MUTEX_RECURSIVE         2
 163 #define PTHREAD_MUTEX_DEFAULT           PTHREAD_MUTEX_NORMAL
 164 /*
 165  * Mutex variables
 166  */
 167
 168 #define PTHREAD_MUTEX_INITIALIZER {_PTHREAD_MUTEX_SIG_init, {0}}
 169
 170 /*
 171  * Condition variable attributes
 172  */
 173
 174 /*
 175  * Condition variables
 176  */
 177
 178 #define PTHREAD_COND_INITIALIZER {_PTHREAD_COND_SIG_init, {0}}
 179
 180 /*
 181  * Initialization control (once) variables
 182  */
 183
 184 #define PTHREAD_ONCE_INIT {_PTHREAD_ONCE_SIG_init, {0}}
 185
 186 /*
 187  * Thread Specific Data - keys
 188  */
 189
 190 #include <sys/time.h>
 191
 192 /*
 193  * Prototypes for all PTHREAD interfaces
 194  */
 195 int       pthread_attr_destroy(pthread_attr_t *attr);
 196 int       pthread_attr_getdetachstate(const pthread_attr_t *attr,
 197                                       int *detachstate);
 198 int       pthread_attr_getinheritsched(const pthread_attr_t *attr,
 199                                        int *inheritsched);
 200 int       pthread_attr_getschedparam(const pthread_attr_t *attr,
 201                                      struct sched_param *param);
 202 int       pthread_attr_getschedpolicy(const pthread_attr_t *attr,
 203                                       int *policy);
 204 int       pthread_attr_getstackaddr(const pthread_attr_t *attr,
 205                                       void **stackaddr);
 206 int       pthread_attr_getstacksize(const pthread_attr_t *attr,
 207                                       size_t *stacksize);
 208 int       pthread_attr_getstack(const pthread_attr_t *attr,
 209                                       void **stackaddr, size_t *stacksize);
 210 int       pthread_attr_getguardsize(const pthread_attr_t *attr,
 211                                       size_t *guardsize);
 212 int       pthread_attr_init(pthread_attr_t *attr);
 213 int       pthread_attr_setdetachstate(pthread_attr_t *attr,
 214                                       int detachstate);
 215 int       pthread_attr_setinheritsched(pthread_attr_t *attr,
 216                                        int inheritsched);
 217 int       pthread_attr_setschedparam(pthread_attr_t *attr,
 218                                      const struct sched_param *param);
 219 int       pthread_attr_setschedpolicy(pthread_attr_t *attr,
 220                                       int policy);
 221 int       pthread_attr_setstackaddr(pthread_attr_t *attr,
 222                                       void *stackaddr);
 223 int       pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize);
 224 int       pthread_attr_setguardsize(pthread_attr_t *attr, size_t guardsize);
 225 int       pthread_attr_setstack(pthread_attr_t *attr,
 226                                       void *stackaddr, size_t stacksize);
 227 int       pthread_cancel(pthread_t thread);
 228 int       pthread_setcancelstate(int state, int *oldstate);
 229 int       pthread_setcanceltype(int type, int *oldtype);
 230 void      pthread_testcancel(void);
 231 int       pthread_cond_broadcast(pthread_cond_t *cond);
 232 int       pthread_cond_destroy(pthread_cond_t *cond);
 233 int       pthread_cond_init(pthread_cond_t *cond,
 234                             const pthread_condattr_t *attr);
 235 int       pthread_cond_signal(pthread_cond_t *cond);
 236 int       pthread_cond_wait(pthread_cond_t *cond,
 237                             pthread_mutex_t *mutex);
 238 int       pthread_cond_timedwait(pthread_cond_t *cond,
 239                                  pthread_mutex_t *mutex,
 240                                  const struct timespec *abstime);
 241 int       pthread_condattr_init(pthread_condattr_t *attr);
 242 int       pthread_condattr_destroy(pthread_condattr_t *attr);
 243 int       pthread_condattr_getpshared(const pthread_condattr_t *attr,
 244                         int *pshared);
 245 int       pthread_condattr_setpshared(pthread_condattr_t *attr,
 246                         int pshared);
 247 int       pthread_create(pthread_t *thread,
 248                          const pthread_attr_t *attr,
 249                          void *(*start_routine)(void *),
 250                          void *arg);
 251 int       pthread_detach(pthread_t thread);
 252 int       pthread_equal(pthread_t t1,
 253                         pthread_t t2);
 254 void      pthread_exit(void *value_ptr) __dead2;
 255 int       pthread_kill(pthread_t, int);
 256 int       pthread_sigmask(int, const sigset_t *, sigset_t *);
 257 int       pthread_getschedparam(pthread_t thread,
 258                                 int *policy,
 259                                 struct sched_param *param);
 260 int       pthread_join(pthread_t thread,
 261                        void **value_ptr);
 262 int       pthread_mutex_destroy(pthread_mutex_t *mutex);
 263 int       pthread_mutex_getprioceiling(const pthread_mutex_t *mutex,
 264                                        int *prioceiling);
 265 int       pthread_mutex_init(pthread_mutex_t *mutex,
 266                              const pthread_mutexattr_t *attr);
 267 int       pthread_mutex_lock(pthread_mutex_t *mutex);
 268 int       pthread_mutex_setprioceiling(pthread_mutex_t *mutex,
 269                                        int prioceiling,
 270                                        int *old_prioceiling);
 271 int       pthread_mutex_trylock(pthread_mutex_t *mutex);
 272 int       pthread_mutex_unlock(pthread_mutex_t *mutex);
 273 int       pthread_mutexattr_destroy(pthread_mutexattr_t *attr);
 274 int       pthread_mutexattr_getprioceiling(const pthread_mutexattr_t *attr,
 275                                            int *prioceiling);
 276 int       pthread_mutexattr_getprotocol(const pthread_mutexattr_t *attr,
 277                                         int *protocol);
 278 int       pthread_mutexattr_getpshared(const pthread_mutexattr_t *attr,
 279                                         int *pshared);
 280 int       pthread_mutexattr_gettype(const pthread_mutexattr_t *attr,
 281                                         int *type);
 282 int       pthread_mutexattr_init(pthread_mutexattr_t *attr);
 283 int       pthread_mutexattr_setprioceiling(pthread_mutexattr_t *attr,
 284                                            int prioceiling);
 285 int       pthread_mutexattr_setprotocol(pthread_mutexattr_t *attr,
 286                                         int protocol);
 287 int       pthread_mutexattr_settype(pthread_mutexattr_t *attr,
 288                                         int type);
 289 int       pthread_mutexattr_setpshared(pthread_mutexattr_t *attr,
 290                                         int pshared);
 291 int       pthread_once(pthread_once_t *once_control,
 292                        void (*init_routine)(void));
 293 pthread_t pthread_self(void);
 294 int       pthread_setschedparam(pthread_t thread,
 295                                 int policy,
 296                                 const struct sched_param *param);
 297 int       pthread_key_create(pthread_key_t *key,
 298                              void (*destructor)(void *));
 299 int       pthread_key_delete(pthread_key_t key);
 300 int       pthread_setspecific(pthread_key_t key,
 301                               const void *value);
 302 void     *pthread_getspecific(pthread_key_t key);
 303 int       pthread_attr_getscope(pthread_attr_t *, int *);
 304 int       pthread_attr_setscope(pthread_attr_t *, int);
 305 int       pthread_getconcurrency(void);
 306 int       pthread_setconcurrency(int);
 307 int       pthread_rwlock_destroy(pthread_rwlock_t * rwlock);
 308 int       pthread_rwlock_init(pthread_rwlock_t * rwlock,
 309                              const pthread_rwlockattr_t *attr);
 310 int       pthread_rwlock_rdlock(pthread_rwlock_t *rwlock);
 311 int       pthread_rwlock_tryrdlock(pthread_rwlock_t *rwlock);
 312 int       pthread_rwlock_wrlock(pthread_rwlock_t *rwlock);
 313 int       pthread_rwlock_trywrlock(pthread_rwlock_t *rwlock);
 314 int       pthread_rwlock_unlock(pthread_rwlock_t *rwlock);
 315 int       pthread_rwlockattr_init(pthread_rwlockattr_t *attr);
 316 int       pthread_rwlockattr_destroy(pthread_rwlockattr_t *attr);
 317 int       pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *attr,
 318                         int *pshared);
 319 int       pthread_rwlockattr_setpshared(pthread_rwlockattr_t *attr,
 320                         int pshared);
 321
 322 #ifndef _POSIX_C_SOURCE
 323 /* returns non-zero if pthread_create or cthread_fork have been called */
 324 int             pthread_is_threaded_np(void);
 325
 326 /* returns non-zero if the current thread is the main thread */
 327 int             pthread_main_np(void);
 328
 329 /* return the mach thread bound to the pthread */
 330 mach_port_t     pthread_mach_thread_np(pthread_t);
 331 size_t          pthread_get_stacksize_np(pthread_t);
 332 void *          pthread_get_stackaddr_np(pthread_t);
 333
 334 /* Like pthread_cond_signal(), but only wake up the specified pthread */
 335 int             pthread_cond_signal_thread_np(pthread_cond_t *, pthread_t);
 336
 337 /* Like pthread_cond_timedwait, but use a relative timeout */
 338 int             pthread_cond_timedwait_relative_np(pthread_cond_t *cond,
 339                                  pthread_mutex_t *mutex,
 340                                  const struct timespec *reltime);
 341
 342 /* Like pthread_create(), but leaves the thread suspended */
 343 int       pthread_create_suspended_np(pthread_t *thread,
 344                          const pthread_attr_t *attr,
 345                          void *(*start_routine)(void *),
 346                          void *arg);
 347 void pthread_yield_np(void);
 348 #endif /* ! _POSIX_C_SOURCE */
 349 __END_DECLS
 350 #endif /* _POSIX_PTHREAD_H */