xref: /freebsd/include/pthread.h (revision bcd92649c9952c9c9e8845dbd34276a60dd16664)
1 /*
2  * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu
3  * Copyright (c) 1995 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 _PTHREAD_H_
35 #define _PTHREAD_H_
36 
37 /*
38  * Header files.
39  */
40 #include <sys/cdefs.h>
41 #include <sys/types.h>
42 #include <sys/time.h>
43 #include <sys/signal.h>
44 #include <limits.h>
45 
46 /*
47  * Run-time invariant values:
48  */
49 #define PTHREAD_DESTRUCTOR_ITERATIONS		4
50 #define PTHREAD_KEYS_MAX			256
51 #define PTHREAD_STACK_MIN			1024
52 #define PTHREAD_THREADS_MAX			ULONG_MAX
53 
54 /*
55  * Compile time symbolic constants for portability specifications:
56  *
57  * Note that those commented out are not currently supported by the
58  * implementation.
59  */
60 #define _POSIX_THREADS
61 #define _POSIX_THREAD_ATTR_STACKADDR
62 #define _POSIX_THREAD_ATTR_STACKSIZE
63 #define _POSIX_THREAD_PRIORITY_SCHEDULING
64 /* #define _POSIX_THREAD_PRIO_INHERIT   */
65 /* #define _POSIX_THREAD_PRIO_PROTECT   */
66 /* #define _POSIX_THREAD_PROCESS_SHARED */
67 #define _POSIX_THREAD_SAFE_FUNCTIONS
68 
69 /*
70  * Forward structure definitions.
71  *
72  * These are mostly opaque to the user.
73  */
74 struct pthread;
75 struct pthread_attr;
76 struct pthread_cond;
77 struct pthread_cond_attr;
78 struct pthread_mutex;
79 struct pthread_mutex_attr;
80 struct pthread_once;
81 struct sched_param;
82 
83 /*
84  * Primitive system data type definitions required by P1003.1c.
85  *
86  * Note that P1003.1c specifies that there are no defined comparison
87  * or assignment operators for the types pthread_attr_t, pthread_cond_t,
88  * pthread_condattr_t, pthread_mutex_t, pthread_mutexattr_t.
89  */
90 typedef struct	pthread			*pthread_t;
91 typedef struct	pthread_attr		*pthread_attr_t;
92 typedef struct	pthread_mutex		*pthread_mutex_t;
93 typedef struct	pthread_mutex_attr	*pthread_mutexattr_t;
94 typedef struct	pthread_cond		*pthread_cond_t;
95 typedef struct	pthread_cond_attr	*pthread_condattr_t;
96 typedef int     			pthread_key_t;
97 typedef struct	pthread_once		pthread_once_t;
98 
99 /*
100  * Additional type definitions:
101  *
102  * Note that P1003.1c reserves the prefixes pthread_ and PTHREAD_ for
103  * use in header symbols.
104  */
105 typedef void	*pthread_addr_t;
106 typedef void	*(*pthread_startroutine_t) (void *);
107 
108 /*
109  * Once definitions.
110  */
111 struct pthread_once {
112 	int		state;
113 	pthread_mutex_t	mutex;
114 };
115 
116 /*
117  * Flags for once initialization.
118  */
119 #define PTHREAD_NEEDS_INIT  0
120 #define PTHREAD_DONE_INIT   1
121 
122 /*
123  * Static once initialization values.
124  */
125 #define PTHREAD_ONCE_INIT   { PTHREAD_NEEDS_INIT, NULL }
126 
127 /*
128  * Default attribute arguments.
129  */
130 #define pthread_condattr_default    NULL
131 #ifndef PTHREAD_KERNEL
132 #define pthread_mutexattr_default   NULL
133 #define pthread_attr_default        NULL
134 #endif
135 
136 enum pthread_mutextype {
137 	MUTEX_TYPE_FAST			= 1,
138 	MUTEX_TYPE_COUNTING_FAST	= 2,	/* Recursive */
139 	MUTEX_TYPE_MAX
140 };
141 
142 /*
143  * Thread function prototype definitions:
144  */
145 __BEGIN_DECLS
146 int		pthread_attr_destroy __P((pthread_attr_t *));
147 int		pthread_attr_getinheritsched __P((pthread_attr_t *, int *));
148 int		pthread_attr_getschedparam __P((pthread_attr_t *,
149 			struct sched_param *));
150 int		pthread_attr_getschedpolicy __P((pthread_attr_t *, int *));
151 int		pthread_attr_getscope __P((pthread_attr_t *, int *));
152 int		pthread_attr_getstacksize __P((pthread_attr_t *, size_t *));
153 int		pthread_attr_getstackaddr __P((pthread_attr_t *, void **));
154 int		pthread_attr_getdetachstate __P((pthread_attr_t *, int *));
155 int		pthread_attr_init __P((pthread_attr_t *));
156 int		pthread_attr_setinheritsched __P((pthread_attr_t *, int));
157 int		pthread_attr_setschedparam __P((pthread_attr_t *,
158 			struct sched_param *));
159 int		pthread_attr_setschedpolicy __P((pthread_attr_t *, int));
160 int		pthread_attr_setscope __P((pthread_attr_t *, int));
161 int		pthread_attr_setstacksize __P((pthread_attr_t *, size_t));
162 int		pthread_attr_setstackaddr __P((pthread_attr_t *, void *));
163 int		pthread_attr_setdetachstate __P((pthread_attr_t *, int));
164 void		pthread_cleanup_pop __P((int execute));
165 int		pthread_cleanup_push __P((void (*routine) (void *),
166 			void *routine_arg));
167 int		pthread_condattr_destroy __P((pthread_condattr_t *attr));
168 int		pthread_condattr_init __P((pthread_condattr_t *attr));
169 int		pthread_condattr_getpshared __P((pthread_condattr_t *attr,
170 			int *pshared));
171 int		pthread_condattr_setpshared __P((pthread_condattr_t *attr,
172 			int pshared));
173 int		pthread_cond_broadcast __P((pthread_cond_t *));
174 int		pthread_cond_destroy __P((pthread_cond_t *));
175 int		pthread_cond_init __P((pthread_cond_t *,
176 			const pthread_condattr_t *));
177 int		pthread_cond_signal __P((pthread_cond_t *));
178 int		pthread_cond_timedwait __P((pthread_cond_t *,
179 			pthread_mutex_t *, const struct timespec * abstime));
180 int		pthread_cond_wait __P((pthread_cond_t *, pthread_mutex_t *));
181 int		pthread_create __P((pthread_t *, const pthread_attr_t *,
182 			void *(*start_routine) (void *), void *));
183 int		pthread_detach __P((pthread_t *));
184 int		pthread_equal __P((pthread_t, pthread_t));
185 void		pthread_exit __P((void *));
186 void		*pthread_getspecific __P((pthread_key_t));
187 int		pthread_join __P((pthread_t, void **));
188 int		pthread_key_create __P((pthread_key_t *,
189 			void (*routine) (void *)));
190 int		pthread_key_delete __P((pthread_key_t));
191 int		pthread_kill __P((struct pthread *, int));
192 int		pthread_mutexattr_destroy __P((pthread_mutexattr_t *));
193 int		pthread_mutexattr_getprioceiling __P((pthread_mutexattr_t *,
194 			int *prioceiling));
195 int		pthread_mutexattr_getprotocol __P((pthread_mutexattr_t *,
196 			int *protocol));
197 int		pthread_mutexattr_getpshared __P((pthread_mutexattr_t *,
198 			int *pshared));
199 int		pthread_mutexattr_init __P((pthread_mutexattr_t *));
200 int		pthread_mutexattr_setprioceiling __P((pthread_mutexattr_t *,
201 			int prioceiling));
202 int		pthread_mutexattr_setprotocol __P((pthread_mutexattr_t *,
203 			int protocol));
204 int		pthread_mutexattr_setpshared __P((pthread_mutexattr_t *,
205 			int pshared));
206 int		pthread_mutex_destroy __P((pthread_mutex_t *));
207 int		pthread_mutex_getprioceiling __P((pthread_mutex_t *));
208 int		pthread_mutex_init __P((pthread_mutex_t *,
209 			const pthread_mutexattr_t *));
210 int		pthread_mutex_lock __P((pthread_mutex_t *));
211 int		pthread_mutex_setprioceiling __P((pthread_mutex_t *));
212 int		pthread_mutex_trylock __P((pthread_mutex_t *));
213 int		pthread_mutex_unlock __P((pthread_mutex_t *));
214 int		pthread_once __P((pthread_once_t *,
215 			void (*init_routine) (void)));
216 pthread_t	pthread_self __P((void));
217 int		pthread_setcancelstate __P((int, int *));
218 int		pthread_setcanceltype __P((int, int *));
219 int		pthread_setspecific __P((pthread_key_t, const void *));
220 int		pthread_sigmask __P((int, const sigset_t *, sigset_t *));
221 int		pthread_testcancel __P((void));
222 
223 
224 int		pthread_getprio __P((pthread_t));
225 int		pthread_setprio __P((pthread_t, int));
226 void		pthread_yield __P((void));
227 int		pthread_setschedparam __P((pthread_t pthread, int policy,
228 			struct sched_param * param));
229 int		pthread_getschedparam __P((pthread_t pthread, int *policy,
230 			struct sched_param * param));
231 int		pthread_attr_setfloatstate __P((pthread_attr_t *, int));
232 int		pthread_attr_getfloatstate __P((pthread_attr_t *, int *));
233 int		pthread_attr_setcleanup __P((pthread_attr_t *,
234 			void (*routine) (void *), void *));
235 __END_DECLS
236 
237 #endif
238