"Sync" threading libaries.
[dragonfly.git] / sys / sys / _pthreadtypes.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
34 #ifndef _SYS__PTHREADTYPES_H_
35 #define _SYS__PTHREADTYPES_H_
36
37 /*
38  * Forward structure definitions.
39  *
40  * These are mostly opaque to the user.
41  */
42 struct pthread;
43 struct pthread_attr;
44 struct pthread_cond;
45 struct pthread_cond_attr;
46 struct pthread_mutex;
47 struct pthread_mutex_attr;
48 struct pthread_once;
49 struct pthread_rwlock;
50 struct pthread_rwlockattr;
51 struct pthread_barrier;
52 struct pthread_barrier_attr;
53 struct pthread_spinlock;
54
55 /*
56  * Primitive system data type definitions required by P1003.1c.
57  *
58  * Note that P1003.1c specifies that there are no defined comparison
59  * or assignment operators for the types pthread_attr_t, pthread_cond_t,
60  * pthread_condattr_t, pthread_mutex_t, pthread_mutexattr_t.
61  */
62 typedef struct  pthread                 *pthread_t;
63 typedef struct  pthread_attr            *pthread_attr_t;
64 typedef struct  pthread_mutex           *pthread_mutex_t;
65 typedef struct  pthread_mutex_attr      *pthread_mutexattr_t;
66 typedef struct  pthread_cond            *pthread_cond_t;
67 typedef struct  pthread_cond_attr       *pthread_condattr_t;
68 typedef int                             pthread_key_t;
69 typedef struct  pthread_once            pthread_once_t;
70 typedef struct  pthread_rwlock          *pthread_rwlock_t;
71 typedef struct  pthread_rwlockattr      *pthread_rwlockattr_t;
72 typedef struct  pthread_barrier         *pthread_barrier_t;
73 typedef struct  pthread_barrierattr     *pthread_barrierattr_t;
74 typedef struct  pthread_spinlock        *pthread_spinlock_t;
75
76 /*
77  * Additional type definitions:
78  *
79  * Note that P1003.1c reserves the prefixes pthread_ and PTHREAD_ for
80  * use in header symbols.
81  */
82 typedef void    *pthread_addr_t;
83 typedef void    *(*pthread_startroutine_t) (void *);
84
85 /*
86  * Once definitions.
87  */
88 struct pthread_once {
89         int             state;
90         pthread_mutex_t mutex;
91 };
92
93 #endif /* ! _SYS__PTHREADTYPES_H_ */