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
  56 /*
  57  * Flags for threads and thread attributes.
  58  */
  59 #define PTHREAD_DETACHED            0x1
  60 #define PTHREAD_SCOPE_SYSTEM        0x2
  61 #define PTHREAD_INHERIT_SCHED       0x4
  62 #define PTHREAD_NOFLOAT             0x8
  63
  64 #define PTHREAD_CREATE_DETACHED     PTHREAD_DETACHED
  65 #define PTHREAD_CREATE_JOINABLE     0
  66 #define PTHREAD_SCOPE_PROCESS       0
  67 #define PTHREAD_EXPLICIT_SCHED      0
  68
  69 /*
  70  * Flags for read/write lock attributes
  71  */
  72 #define PTHREAD_PROCESS_PRIVATE     0
  73 #define PTHREAD_PROCESS_SHARED      1
  74
  75 /*
  76  * Flags for cancelling threads
  77  */
  78 #define PTHREAD_CANCEL_ENABLE           0
  79 #define PTHREAD_CANCEL_DISABLE          1
  80 #define PTHREAD_CANCEL_DEFERRED         0
  81 #define PTHREAD_CANCEL_ASYNCHRONOUS     2
  82 #define PTHREAD_CANCELED                ((void *) 1)
  83
  84 /*
  85  * Forward structure definitions.
  86  *
  87  * These are mostly opaque to the user.
  88  */
  89 struct pthread;
  90 struct pthread_attr;
  91 struct pthread_cond;
  92 struct pthread_cond_attr;
  93 struct pthread_mutex;
  94 struct pthread_mutex_attr;
  95 struct pthread_once;
  96 struct pthread_rwlock;
  97 struct pthread_rwlockattr;
  98
  99 /*
 100  * Primitive system data type definitions required by P1003.1c.
 101  *
 102  * Note that P1003.1c specifies that there are no defined comparison
 103  * or assignment operators for the types pthread_attr_t, pthread_cond_t,
 104  * pthread_condattr_t, pthread_mutex_t, pthread_mutexattr_t.
 105  */
 106 typedef struct  pthread                 *pthread_t;
 107 typedef struct  pthread_attr            *pthread_attr_t;
 108 typedef struct  pthread_mutex           *pthread_mutex_t;
 109 typedef struct  pthread_mutex_attr      *pthread_mutexattr_t;
 110 typedef struct  pthread_cond            *pthread_cond_t;
 111 typedef struct  pthread_cond_attr       *pthread_condattr_t;
 112 typedef int                             pthread_key_t;
 113 typedef struct  pthread_once            pthread_once_t;
 114 typedef struct  pthread_rwlock          *pthread_rwlock_t;
 115 typedef struct  pthread_rwlockattr      *pthread_rwlockattr_t;
 116
 117 /*
 118  * Additional type definitions:
 119  *
 120  * Note that P1003.1c reserves the prefixes pthread_ and PTHREAD_ for
 121  * use in header symbols.
 122  */
 123 typedef void    *pthread_addr_t;
 124 typedef void    *(*pthread_startroutine_t)(void *);
 125
 126 /*
 127  * Once definitions.
 128  */
 129 struct pthread_once {
 130         int             state;
 131         pthread_mutex_t mutex;
 132 };
 133
 134 /*
 135  * Flags for once initialization.
 136  */
 137 #define PTHREAD_NEEDS_INIT  0
 138 #define PTHREAD_DONE_INIT   1
 139
 140 /*
 141  * Static once initialization values.
 142  */
 143 #define PTHREAD_ONCE_INIT   { PTHREAD_NEEDS_INIT, NULL }
 144
 145 /*
 146  * Static initialization values.
 147  */
 148 #define PTHREAD_MUTEX_INITIALIZER       NULL
 149 #define PTHREAD_COND_INITIALIZER        NULL
 150 #define PTHREAD_RWLOCK_INITIALIZER      NULL
 151
 152 /*
 153  * Default attribute arguments (draft 4, deprecated).
 154  */
 155 #ifndef PTHREAD_KERNEL
 156 #define pthread_condattr_default    NULL
 157 #define pthread_mutexattr_default   NULL
 158 #define pthread_attr_default        NULL
 159 #endif
 160
 161 #define PTHREAD_PRIO_NONE       0
 162 #define PTHREAD_PRIO_INHERIT    1
 163 #define PTHREAD_PRIO_PROTECT    2
 164
 165 /*
 166  * Mutex types (Single UNIX Specification, Version 2, 1997).
 167  *
 168  * Note that a mutex attribute with one of the following types:
 169  *
 170  *      PTHREAD_MUTEX_NORMAL
 171  *      PTHREAD_MUTEX_RECURSIVE
 172  *      MUTEX_TYPE_FAST (deprecated)
 173  *      MUTEX_TYPE_COUNTING_FAST (deprecated)
 174  *
 175  * will deviate from POSIX specified semantics.
 176  */
 177 enum pthread_mutextype {
 178         PTHREAD_MUTEX_ERRORCHECK        = 1,    /* Default POSIX mutex */
 179         PTHREAD_MUTEX_RECURSIVE         = 2,    /* Recursive mutex */
 180         PTHREAD_MUTEX_NORMAL            = 3,    /* No error checking */
 181         MUTEX_TYPE_MAX
 182 };
 183
 184 #define PTHREAD_MUTEX_DEFAULT           PTHREAD_MUTEX_ERRORCHECK
 185 #define MUTEX_TYPE_FAST                 PTHREAD_MUTEX_NORMAL
 186 #define MUTEX_TYPE_COUNTING_FAST        PTHREAD_MUTEX_RECURSIVE
 187
 188 /*
 189  * Thread function prototype definitions:
 190  */
 191 __BEGIN_DECLS
 192 int             pthread_attr_destroy(pthread_attr_t *);
 193 int             pthread_attr_getstacksize(const pthread_attr_t *, size_t *);
 194 int             pthread_attr_getguardsize(const pthread_attr_t *, size_t *);
 195 int             pthread_attr_getstackaddr(const pthread_attr_t *, void **);
 196 int             pthread_attr_getdetachstate(const pthread_attr_t *, int *);
 197 int             pthread_attr_init(pthread_attr_t *);
 198 int             pthread_attr_setstacksize(pthread_attr_t *, size_t);
 199 int             pthread_attr_setguardsize(pthread_attr_t *, size_t);
 200 int             pthread_attr_setstackaddr(pthread_attr_t *, void *);
 201 int             pthread_attr_setdetachstate(pthread_attr_t *, int);
 202 void            pthread_cleanup_pop(int);
 203 void            pthread_cleanup_push(void (*) (void *), void *routine_arg);
 204 int             pthread_condattr_destroy(pthread_condattr_t *);
 205 int             pthread_condattr_init(pthread_condattr_t *);
 206
 207 #if defined(_POSIX_THREAD_PROCESS_SHARED)
 208 int             pthread_condattr_getpshared(pthread_condattr_t *, int *);
 209 int             pthread_condattr_setpshared(pthread_condattr_t *, int);
 210 #endif
 211
 212 int             pthread_cond_broadcast(pthread_cond_t *);
 213 int             pthread_cond_destroy(pthread_cond_t *);
 214 int             pthread_cond_init(pthread_cond_t *,
 215                         const pthread_condattr_t *);
 216 int             pthread_cond_signal(pthread_cond_t *);
 217 int             pthread_cond_timedwait(pthread_cond_t *,
 218                         pthread_mutex_t *, const struct timespec *);
 219 int             pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *);
 220 int             pthread_create(pthread_t *, const pthread_attr_t *,
 221                         void *(*) (void *), void *);
 222 int             pthread_detach(pthread_t);
 223 int             pthread_equal(pthread_t, pthread_t);
 224 void            pthread_exit(void *) __dead2;
 225 void            *pthread_getspecific(pthread_key_t);
 226 int             pthread_join(pthread_t, void **);
 227 int             pthread_key_create(pthread_key_t *,
 228                         void (*) (void *));
 229 int             pthread_key_delete(pthread_key_t);
 230 int             pthread_kill(pthread_t, int);
 231 int             pthread_mutexattr_init(pthread_mutexattr_t *);
 232 int             pthread_mutexattr_destroy(pthread_mutexattr_t *);
 233 int             pthread_mutexattr_gettype(pthread_mutexattr_t *, int *);
 234 int             pthread_mutexattr_settype(pthread_mutexattr_t *, int);
 235 int             pthread_mutex_destroy(pthread_mutex_t *);
 236 int             pthread_mutex_init(pthread_mutex_t *,
 237                         const pthread_mutexattr_t *);
 238 int             pthread_mutex_lock(pthread_mutex_t *);
 239 int             pthread_mutex_trylock(pthread_mutex_t *);
 240 int             pthread_mutex_unlock(pthread_mutex_t *);
 241 int             pthread_once(pthread_once_t *, void (*) (void));
 242 int             pthread_rwlock_destroy(pthread_rwlock_t *);
 243 int             pthread_rwlock_init(pthread_rwlock_t *,
 244                         const pthread_rwlockattr_t *);
 245 int             pthread_rwlock_rdlock(pthread_rwlock_t *);
 246 int             pthread_rwlock_tryrdlock(pthread_rwlock_t *);
 247 int             pthread_rwlock_trywrlock(pthread_rwlock_t *);
 248 int             pthread_rwlock_unlock(pthread_rwlock_t *);
 249 int             pthread_rwlock_wrlock(pthread_rwlock_t *);
 250 int             pthread_rwlockattr_init(pthread_rwlockattr_t *);
 251 int             pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *,
 252                         int *);
 253 int             pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int);
 254 int             pthread_rwlockattr_destroy(pthread_rwlockattr_t *);
 255 pthread_t       pthread_self(void);
 256 int             pthread_setspecific(pthread_key_t, const void *);
 257 int             pthread_sigmask(int, const sigset_t *, sigset_t *);
 258
 259 int             pthread_cancel(pthread_t);
 260 int             pthread_setcancelstate(int, int *);
 261 int             pthread_setcanceltype(int, int *);
 262 void            pthread_testcancel(void);
 263
 264 int             pthread_getprio(pthread_t);
 265 int             pthread_setprio(pthread_t, int);
 266 void            pthread_yield(void);
 267
 268 #if defined(_POSIX_THREAD_PROCESS_SHARED)
 269 int             pthread_mutexattr_getpshared(pthread_mutexattr_t *,
 270                         int *pshared);
 271 int             pthread_mutexattr_setpshared(pthread_mutexattr_t *,
 272                         int pshared);
 273 #endif
 274
 275 int             pthread_mutexattr_getprioceiling(pthread_mutexattr_t *,
 276                         int *);
 277 int             pthread_mutexattr_setprioceiling(pthread_mutexattr_t *,
 278                         int);
 279 int             pthread_mutex_getprioceiling(pthread_mutex_t *, int *);
 280 int             pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *);
 281
 282 int             pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *);
 283 int             pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int);
 284
 285 int             pthread_attr_getinheritsched(const pthread_attr_t *, int *);
 286 int             pthread_attr_getschedparam(const pthread_attr_t *,
 287                         struct sched_param *);
 288 int             pthread_attr_getschedpolicy(const pthread_attr_t *, int *);
 289 int             pthread_attr_getscope(const pthread_attr_t *, int *);
 290 int             pthread_attr_setinheritsched(pthread_attr_t *, int);
 291 int             pthread_attr_setschedparam(pthread_attr_t *,
 292                         const struct sched_param *);
 293 int             pthread_attr_setschedpolicy(pthread_attr_t *, int);
 294 int             pthread_attr_setscope(pthread_attr_t *, int);
 295 int             pthread_getschedparam(pthread_t pthread, int *,
 296                         struct sched_param *);
 297 int             pthread_setschedparam(pthread_t, int,
 298                         const struct sched_param *);
 299 __END_DECLS
 300
 301 #endif