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$
  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 <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  * Forward structure definitions.
  87  *
  88  * These are mostly opaque to the user.
  89  */
  90 struct pthread;
  91 struct pthread_attr;
  92 struct pthread_cond;
  93 struct pthread_cond_attr;
  94 struct pthread_mutex;
  95 struct pthread_mutex_attr;
  96 struct pthread_once;
  97 struct pthread_rwlock;
  98 struct pthread_rwlockattr;
  99 struct pthread_barrier;
 100 struct pthread_barrier_attr;
 101 struct pthread_spinlock;
 102
 103 /*
 104  * Primitive system data type definitions required by P1003.1c.
 105  *
 106  * Note that P1003.1c specifies that there are no defined comparison
 107  * or assignment operators for the types pthread_attr_t, pthread_cond_t,
 108  * pthread_condattr_t, pthread_mutex_t, pthread_mutexattr_t.
 109  */
 110 typedef struct  pthread                 *pthread_t;
 111 typedef struct  pthread_attr            *pthread_attr_t;
 112 typedef struct  pthread_mutex           *pthread_mutex_t;
 113 typedef struct  pthread_mutex_attr      *pthread_mutexattr_t;
 114 typedef struct  pthread_cond            *pthread_cond_t;
 115 typedef struct  pthread_cond_attr       *pthread_condattr_t;
 116 typedef int                             pthread_key_t;
 117 typedef struct  pthread_once            pthread_once_t;
 118 typedef struct  pthread_rwlock          *pthread_rwlock_t;
 119 typedef struct  pthread_rwlockattr      *pthread_rwlockattr_t;
 120 typedef struct  pthread_barrier         *pthread_barrier_t;
 121 typedef struct  pthread_barrierattr     *pthread_barrierattr_t;
 122 typedef struct  pthread_spinlock        *pthread_spinlock_t;
 123
 124 /*
 125  * Additional type definitions:
 126  *
 127  * Note that P1003.1c reserves the prefixes pthread_ and PTHREAD_ for
 128  * use in header symbols.
 129  */
 130 typedef void    *pthread_addr_t;
 131 typedef void    *(*pthread_startroutine_t)(void *);
 132
 133 /*
 134  * Once definitions.
 135  */
 136 struct pthread_once {
 137         int             state;
 138         pthread_mutex_t mutex;
 139 };
 140
 141 /*
 142  * Flags for once initialization.
 143  */
 144 #define PTHREAD_NEEDS_INIT  0
 145 #define PTHREAD_DONE_INIT   1
 146
 147 /*
 148  * Static once initialization values.
 149  */
 150 #define PTHREAD_ONCE_INIT   { PTHREAD_NEEDS_INIT, NULL }
 151
 152 /*
 153  * Static initialization values.
 154  */
 155 #define PTHREAD_MUTEX_INITIALIZER       NULL
 156 #define PTHREAD_COND_INITIALIZER        NULL
 157 #define PTHREAD_RWLOCK_INITIALIZER      NULL
 158
 159 /*
 160  * Default attribute arguments (draft 4, deprecated).
 161  */
 162 #ifndef PTHREAD_KERNEL
 163 #define pthread_condattr_default    NULL
 164 #define pthread_mutexattr_default   NULL
 165 #define pthread_attr_default        NULL
 166 #endif
 167
 168 #define PTHREAD_PRIO_NONE       0
 169 #define PTHREAD_PRIO_INHERIT    1
 170 #define PTHREAD_PRIO_PROTECT    2
 171
 172 /*
 173  * Mutex types (Single UNIX Specification, Version 2, 1997).
 174  *
 175  * Note that a mutex attribute with one of the following types:
 176  *
 177  *      PTHREAD_MUTEX_NORMAL
 178  *      PTHREAD_MUTEX_RECURSIVE
 179  *      MUTEX_TYPE_FAST (deprecated)
 180  *      MUTEX_TYPE_COUNTING_FAST (deprecated)
 181  *
 182  * will deviate from POSIX specified semantics.
 183  */
 184 enum pthread_mutextype {
 185         PTHREAD_MUTEX_ERRORCHECK        = 1,    /* Default POSIX mutex */
 186         PTHREAD_MUTEX_RECURSIVE         = 2,    /* Recursive mutex */
 187         PTHREAD_MUTEX_NORMAL            = 3,    /* No error checking */
 188         MUTEX_TYPE_MAX
 189 };
 190
 191 #define PTHREAD_MUTEX_DEFAULT           PTHREAD_MUTEX_ERRORCHECK
 192 #define MUTEX_TYPE_FAST                 PTHREAD_MUTEX_NORMAL
 193 #define MUTEX_TYPE_COUNTING_FAST        PTHREAD_MUTEX_RECURSIVE
 194
 195 /*
 196  * Thread function prototype definitions:
 197  */
 198 __BEGIN_DECLS
 199 int             pthread_atfork(void (*prepare)(void), void (*parent)(void),
 200                         void (*child)(void));
 201 int             pthread_attr_destroy(pthread_attr_t *);
 202 int             pthread_attr_getstack(const pthread_attr_t * __restrict,
 203                         void ** __restrict stackaddr,
 204                         size_t * __restrict stacksize);
 205 int             pthread_attr_getstacksize(const pthread_attr_t *, size_t *);
 206 int             pthread_attr_getguardsize(const pthread_attr_t *, size_t *);
 207 int             pthread_attr_getstackaddr(const pthread_attr_t *, void **);
 208 int             pthread_attr_getdetachstate(const pthread_attr_t *, int *);
 209 int             pthread_attr_init(pthread_attr_t *);
 210 int             pthread_attr_setstacksize(pthread_attr_t *, size_t);
 211 int             pthread_attr_setguardsize(pthread_attr_t *, size_t);
 212 int             pthread_attr_setstack(pthread_attr_t *, void *, size_t);
 213 int             pthread_attr_setstackaddr(pthread_attr_t *, void *);
 214 int             pthread_attr_setdetachstate(pthread_attr_t *, int);
 215 int             pthread_barrier_destroy(pthread_barrier_t *);
 216 int             pthread_barrier_init(pthread_barrier_t *,
 217                         const pthread_barrierattr_t *, unsigned);
 218 int             pthread_barrier_wait(pthread_barrier_t *);
 219 int             pthread_barrierattr_destroy(pthread_barrierattr_t *);
 220 int             pthread_barrierattr_getpshared(const pthread_barrierattr_t *,
 221                         int *);
 222 int             pthread_barrierattr_init(pthread_barrierattr_t *);
 223 int             pthread_barrierattr_setpshared(pthread_barrierattr_t *, int);
 224 void            pthread_cleanup_pop(int);
 225 void            pthread_cleanup_push(void (*) (void *), void *routine_arg);
 226 int             pthread_condattr_destroy(pthread_condattr_t *);
 227 int             pthread_condattr_init(pthread_condattr_t *);
 228
 229 int             pthread_cond_broadcast(pthread_cond_t *);
 230 int             pthread_cond_destroy(pthread_cond_t *);
 231 int             pthread_cond_init(pthread_cond_t *,
 232                         const pthread_condattr_t *);
 233 int             pthread_cond_signal(pthread_cond_t *);
 234 int             pthread_cond_timedwait(pthread_cond_t *,
 235                         pthread_mutex_t *, const struct timespec *);
 236 int             pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *);
 237 int             pthread_create(pthread_t *, const pthread_attr_t *,
 238                         void *(*) (void *), void *);
 239 int             pthread_detach(pthread_t);
 240 int             pthread_equal(pthread_t, pthread_t);
 241 void            pthread_exit(void *) __dead2;
 242 void            *pthread_getspecific(pthread_key_t);
 243 int             pthread_join(pthread_t, void **);
 244 int             pthread_key_create(pthread_key_t *,
 245                         void (*) (void *));
 246 int             pthread_key_delete(pthread_key_t);
 247 int             pthread_kill(pthread_t, int);
 248 int             pthread_mutexattr_init(pthread_mutexattr_t *);
 249 int             pthread_mutexattr_destroy(pthread_mutexattr_t *);
 250 int             pthread_mutexattr_gettype(pthread_mutexattr_t *, int *);
 251 int             pthread_mutexattr_settype(pthread_mutexattr_t *, int);
 252 int             pthread_mutex_destroy(pthread_mutex_t *);
 253 int             pthread_mutex_init(pthread_mutex_t *,
 254                         const pthread_mutexattr_t *);
 255 int             pthread_mutex_lock(pthread_mutex_t *);
 256 int             pthread_mutex_trylock(pthread_mutex_t *);
 257 int             pthread_mutex_timedlock(pthread_mutex_t *,
 258                         const struct timespec *);
 259 int             pthread_mutex_unlock(pthread_mutex_t *);
 260 int             pthread_once(pthread_once_t *, void (*) (void));
 261 int             pthread_rwlock_destroy(pthread_rwlock_t *);
 262 int             pthread_rwlock_init(pthread_rwlock_t *,
 263                         const pthread_rwlockattr_t *);
 264 int             pthread_rwlock_rdlock(pthread_rwlock_t *);
 265 int             pthread_rwlock_timedrdlock(pthread_rwlock_t *,
 266                         const struct timespec *);
 267 int             pthread_rwlock_timedwrlock(pthread_rwlock_t *,
 268                         const struct timespec *);
 269 int             pthread_rwlock_tryrdlock(pthread_rwlock_t *);
 270 int             pthread_rwlock_trywrlock(pthread_rwlock_t *);
 271 int             pthread_rwlock_unlock(pthread_rwlock_t *);
 272 int             pthread_rwlock_wrlock(pthread_rwlock_t *);
 273 int             pthread_rwlockattr_init(pthread_rwlockattr_t *);
 274 int             pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *,
 275                         int *);
 276 int             pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int);
 277 int             pthread_rwlockattr_destroy(pthread_rwlockattr_t *);
 278 pthread_t       pthread_self(void);
 279 int             pthread_setspecific(pthread_key_t, const void *);
 280 int             pthread_sigmask(int, const sigset_t *, sigset_t *);
 281
 282 int             pthread_spin_init(pthread_spinlock_t *, int);
 283 int             pthread_spin_destroy(pthread_spinlock_t *);
 284 int             pthread_spin_lock(pthread_spinlock_t *);
 285 int             pthread_spin_trylock(pthread_spinlock_t *);
 286 int             pthread_spin_unlock(pthread_spinlock_t *);
 287 int             pthread_cancel(pthread_t);
 288 int             pthread_setcancelstate(int, int *);
 289 int             pthread_setcanceltype(int, int *);
 290 void            pthread_testcancel(void);
 291
 292 int             pthread_getprio(pthread_t);
 293 int             pthread_setprio(pthread_t, int);
 294 void            pthread_yield(void);
 295
 296 int             pthread_mutexattr_getprioceiling(pthread_mutexattr_t *,
 297                         int *);
 298 int             pthread_mutexattr_setprioceiling(pthread_mutexattr_t *,
 299                         int);
 300 int             pthread_mutex_getprioceiling(pthread_mutex_t *, int *);
 301 int             pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *);
 302
 303 int             pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *);
 304 int             pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int);
 305
 306 int             pthread_attr_getinheritsched(const pthread_attr_t *, int *);
 307 int             pthread_attr_getschedparam(const pthread_attr_t *,
 308                         struct sched_param *);
 309 int             pthread_attr_getschedpolicy(const pthread_attr_t *, int *);
 310 int             pthread_attr_getscope(const pthread_attr_t *, int *);
 311 int             pthread_attr_setinheritsched(pthread_attr_t *, int);
 312 int             pthread_attr_setschedparam(pthread_attr_t *,
 313                         const struct sched_param *);
 314 int             pthread_attr_setschedpolicy(pthread_attr_t *, int);
 315 int             pthread_attr_setscope(pthread_attr_t *, int);
 316 int             pthread_getschedparam(pthread_t pthread, int *,
 317                         struct sched_param *);
 318 int             pthread_setschedparam(pthread_t, int,
 319                         const struct sched_param *);
 320 int             pthread_getconcurrency(void);
 321 int             pthread_setconcurrency(int);
 322 __END_DECLS
 323
 324 #endif