include/pthread.h

   1 /*
   2  * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu
   3  * Copyright (c) 1995-1998 by John Birrell <jb@cimlogic.com.au>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. All advertising materials mentioning features or use of this software
  15  *    must display the following acknowledgement:
  16  *  This product includes software developed by Chris Provenzano.
  17  * 4. The name of Chris Provenzano may not be used to endorse or promote
  18  *        products derived from this software without specific prior written
  19  *        permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY CHRIS PROVENZANO ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL CHRIS PROVENZANO BE LIABLE FOR ANY
  25  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  * $FreeBSD: src/include/pthread.h,v 1.20.2.4 2003/05/27 18:18:01 jdp Exp $
  34  */
  35 #ifndef _PTHREAD_H_
  36 #define _PTHREAD_H_
  37
  38 /*
  39  * Header files.
  40  */
  41 #include <sys/cdefs.h>
  42 #include <sys/types.h>
  43 #include <sys/time.h>
  44 #include <sys/signal.h>
  45 #include <limits.h>
  46 #include <sys/sched.h>
  47
  48 /*
  49  * Run-time invariant values:
  50  */
  51 #define PTHREAD_DESTRUCTOR_ITERATIONS           4
  52 #define PTHREAD_KEYS_MAX                        256
  53 #define PTHREAD_STACK_MIN                       1024
  54 #define PTHREAD_THREADS_MAX                     ULONG_MAX
  55 #define PTHREAD_BARRIER_SERIAL_THREAD           -1
  56
  57 /*
  58  * Flags for threads and thread attributes.
  59  */
  60 #define PTHREAD_DETACHED            0x1
  61 #define PTHREAD_SCOPE_SYSTEM        0x2
  62 #define PTHREAD_INHERIT_SCHED       0x4
  63 #define PTHREAD_NOFLOAT             0x8
  64
  65 #define PTHREAD_CREATE_DETACHED     PTHREAD_DETACHED
  66 #define PTHREAD_CREATE_JOINABLE     0
  67 #define PTHREAD_SCOPE_PROCESS       0
  68 #define PTHREAD_EXPLICIT_SCHED      0
  69
  70 /*
  71  * Flags for read/write lock attributes
  72  */
  73 #define PTHREAD_PROCESS_PRIVATE     0
  74 #define PTHREAD_PROCESS_SHARED      1
  75
  76 /*
  77  * Flags for cancelling threads
  78  */
  79 #define PTHREAD_CANCEL_ENABLE           0
  80 #define PTHREAD_CANCEL_DISABLE          1
  81 #define PTHREAD_CANCEL_DEFERRED         0
  82 #define PTHREAD_CANCEL_ASYNCHRONOUS     2
  83 #define PTHREAD_CANCELED                ((void *) 1)
  84
  85 /*
  86  * Flags for once initialization.
  87  */
  88 #define PTHREAD_NEEDS_INIT  0
  89 #define PTHREAD_DONE_INIT   1
  90
  91 /*
  92  * Static once initialization values.
  93  */
  94 #define PTHREAD_ONCE_INIT   { PTHREAD_NEEDS_INIT, NULL }
  95
  96 /*
  97  * Static initialization values.
  98  */
  99 #define PTHREAD_MUTEX_INITIALIZER       NULL
 100 #define PTHREAD_COND_INITIALIZER        NULL
 101 #define PTHREAD_RWLOCK_INITIALIZER      NULL
 102
 103 /*
 104  * Default attribute arguments (draft 4, deprecated).
 105  */
 106 #ifndef PTHREAD_KERNEL
 107 #define pthread_condattr_default    NULL
 108 #define pthread_mutexattr_default   NULL
 109 #define pthread_attr_default        NULL
 110 #endif
 111
 112 #define PTHREAD_PRIO_NONE       0
 113 #define PTHREAD_PRIO_INHERIT    1
 114 #define PTHREAD_PRIO_PROTECT    2
 115
 116 /*
 117  * Mutex types (Single UNIX Specification, Version 2, 1997).
 118  *
 119  * Note that a mutex attribute with one of the following types:
 120  *
 121  *      PTHREAD_MUTEX_NORMAL
 122  *      PTHREAD_MUTEX_RECURSIVE
 123  *      MUTEX_TYPE_FAST (deprecated)
 124  *      MUTEX_TYPE_COUNTING_FAST (deprecated)
 125  *
 126  * will deviate from POSIX specified semantics.
 127  */
 128 enum pthread_mutextype {
 129         PTHREAD_MUTEX_ERRORCHECK        = 1,    /* Default POSIX mutex */
 130         PTHREAD_MUTEX_RECURSIVE         = 2,    /* Recursive mutex */
 131         PTHREAD_MUTEX_NORMAL            = 3,    /* No error checking */
 132         MUTEX_TYPE_MAX
 133 };
 134
 135 #define PTHREAD_MUTEX_DEFAULT           PTHREAD_MUTEX_ERRORCHECK
 136 #define MUTEX_TYPE_FAST                 PTHREAD_MUTEX_NORMAL
 137 #define MUTEX_TYPE_COUNTING_FAST        PTHREAD_MUTEX_RECURSIVE
 138
 139 /*
 140  * Thread function prototype definitions:
 141  */
 142 __BEGIN_DECLS
 143 int             pthread_atfork(void (*)(void), void (*)(void), void (*)(void));
 144 int             pthread_attr_destroy(pthread_attr_t *);
 145 int             pthread_attr_getguardsize(const pthread_attr_t * __restrict,
 146                         size_t *);
 147 int             pthread_attr_getstack(const pthread_attr_t * __restrict,
 148                                       void ** __restrict, size_t * __restrict);
 149 int             pthread_attr_getstacksize(const pthread_attr_t *, size_t *);
 150 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE < 200809)
 151 int             pthread_attr_getstackaddr(const pthread_attr_t *, void **);
 152 #endif
 153 int             pthread_attr_getdetachstate(const pthread_attr_t *, int *);
 154 int             pthread_attr_init(pthread_attr_t *);
 155 int             pthread_attr_setguardsize(pthread_attr_t *, size_t);
 156 int             pthread_attr_setstack(pthread_attr_t *, void *, size_t);
 157 int             pthread_attr_setstacksize(pthread_attr_t *, size_t);
 158 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE < 200809)
 159 int             pthread_attr_setstackaddr(pthread_attr_t *, void *);
 160 #endif
 161 int             pthread_attr_setdetachstate(pthread_attr_t *, int);
 162 int             pthread_barrier_destroy(pthread_barrier_t *);
 163 int             pthread_barrier_init(pthread_barrier_t *,
 164                         const pthread_barrierattr_t *, unsigned);
 165 int             pthread_barrier_wait(pthread_barrier_t *);
 166 int             pthread_barrierattr_destroy(pthread_barrierattr_t *);
 167 int             pthread_barrierattr_init(pthread_barrierattr_t *);
 168 int             pthread_barrierattr_getpshared(const pthread_barrierattr_t *,
 169                         int *);
 170 int             pthread_barrierattr_setpshared(pthread_barrierattr_t *, int);
 171 void            pthread_cleanup_pop(int);
 172 void            pthread_cleanup_push(void (*) (void *), void *);
 173 int             pthread_condattr_destroy(pthread_condattr_t *);
 174 int             pthread_condattr_init(pthread_condattr_t *);
 175
 176 int             pthread_condattr_getpshared(const pthread_condattr_t *, int *);
 177 int             pthread_condattr_setpshared(pthread_condattr_t *, int);
 178
 179 int             pthread_condattr_getclock(const pthread_condattr_t *, clockid_t *);
 180 int             pthread_condattr_setclock(pthread_condattr_t *, clockid_t);
 181
 182 int             pthread_cond_broadcast(pthread_cond_t *);
 183 int             pthread_cond_destroy(pthread_cond_t *);
 184 int             pthread_cond_init(pthread_cond_t *,
 185                                   const pthread_condattr_t *);
 186 int             pthread_cond_signal(pthread_cond_t *);
 187 int             pthread_cond_timedwait(pthread_cond_t *, pthread_mutex_t *,
 188                                        const struct timespec *);
 189 int             pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *);
 190 int             pthread_create(pthread_t *, const pthread_attr_t *,
 191                                void *(*) (void *), void *);
 192 int             pthread_detach(pthread_t);
 193 int             pthread_equal(pthread_t, pthread_t);
 194 void            pthread_exit(void *) __dead2;
 195 void            *pthread_getspecific(pthread_key_t);
 196 int             pthread_join(pthread_t, void **);
 197 int             pthread_key_create(pthread_key_t *, void (*) (void *));
 198 int             pthread_key_delete(pthread_key_t);
 199 int             pthread_mutexattr_init(pthread_mutexattr_t *);
 200 int             pthread_mutexattr_destroy(pthread_mutexattr_t *);
 201 int             pthread_mutexattr_gettype(pthread_mutexattr_t *, int *);
 202 int             pthread_mutexattr_settype(pthread_mutexattr_t *, int);
 203 int             pthread_mutex_destroy(pthread_mutex_t *);
 204 int             pthread_mutex_init(pthread_mutex_t *,
 205                                    const pthread_mutexattr_t *);
 206 int             pthread_mutex_lock(pthread_mutex_t *);
 207 int             pthread_mutex_timedlock(pthread_mutex_t *,
 208                                         const struct timespec *);
 209 int             pthread_mutex_trylock(pthread_mutex_t *);
 210 int             pthread_mutex_unlock(pthread_mutex_t *);
 211 int             pthread_once(pthread_once_t *, void (*) (void));
 212 int             pthread_rwlock_destroy(pthread_rwlock_t *);
 213 int             pthread_rwlock_init(pthread_rwlock_t *,
 214                                     const pthread_rwlockattr_t *);
 215 int             pthread_rwlock_rdlock(pthread_rwlock_t *);
 216 int             pthread_rwlock_timedrdlock(pthread_rwlock_t *,
 217                                     const struct timespec *);
 218 int             pthread_rwlock_tryrdlock(pthread_rwlock_t *);
 219 int             pthread_rwlock_trywrlock(pthread_rwlock_t *);
 220 int             pthread_rwlock_unlock(pthread_rwlock_t *);
 221 int             pthread_rwlock_wrlock(pthread_rwlock_t *);
 222 int             pthread_rwlock_timedwrlock(pthread_rwlock_t *,
 223                                     const struct timespec *);
 224 int             pthread_rwlockattr_init(pthread_rwlockattr_t *);
 225 int             pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *,
 226                                               int *);
 227 int             pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int);
 228 int             pthread_rwlockattr_destroy(pthread_rwlockattr_t *);
 229 pthread_t       pthread_self(void);
 230 int             pthread_setspecific(pthread_key_t, const void *);
 231
 232 int             pthread_spin_destroy(pthread_spinlock_t *);
 233 int             pthread_spin_init(pthread_spinlock_t *, int);
 234 int             pthread_spin_lock(pthread_spinlock_t *);
 235 int             pthread_spin_trylock(pthread_spinlock_t *);
 236 int             pthread_spin_unlock(pthread_spinlock_t *);
 237
 238 int             pthread_cancel(pthread_t);
 239 int             pthread_setcancelstate(int, int *);
 240 int             pthread_setcanceltype(int, int *);
 241 void            pthread_testcancel(void);
 242
 243 int             pthread_getprio(pthread_t);
 244 int             pthread_setprio(pthread_t, int);
 245 void            pthread_yield(void);
 246
 247 int             pthread_mutexattr_getpshared(const pthread_mutexattr_t *, int *);
 248 int             pthread_mutexattr_setpshared(pthread_mutexattr_t *, int);
 249
 250 int             pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, int *);
 251 int             pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int);
 252 int             pthread_mutex_getprioceiling(pthread_mutex_t *, int *);
 253 int             pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *);
 254
 255 int             pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *);
 256 int             pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int);
 257
 258 int             pthread_attr_getinheritsched(const pthread_attr_t *, int *);
 259 int             pthread_attr_getschedparam(const pthread_attr_t *,
 260                                            struct sched_param *);
 261 int             pthread_attr_getschedpolicy(const pthread_attr_t *, int *);
 262 int             pthread_attr_getscope(const pthread_attr_t *, int *);
 263 int             pthread_attr_setinheritsched(pthread_attr_t *, int);
 264 int             pthread_attr_setschedparam(pthread_attr_t *,
 265                                            const struct sched_param *);
 266 int             pthread_attr_setschedpolicy(pthread_attr_t *, int);
 267 int             pthread_attr_setscope(pthread_attr_t *, int);
 268 int             pthread_getschedparam(pthread_t pthread, int *,
 269                                       struct sched_param *);
 270 int             pthread_setschedparam(pthread_t, int,
 271                                       const struct sched_param *);
 272 int             pthread_getconcurrency(void);
 273 int             pthread_setconcurrency(int);
 274
 275 int             pthread_attr_setfloatstate(pthread_attr_t *, int);
 276 int             pthread_attr_getfloatstate(pthread_attr_t *, int *);
 277 __END_DECLS
 278
 279 #endif