xref: /freebsd/include/pthread.h (revision 952d112864d8008aa87278a30a539d888a8493cd)
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  * Flags for threads and thread attributes.
71  */
72 #define PTHREAD_DETACHED            0x1
73 #define PTHREAD_SCOPE_SYSTEM        0x2
74 #define PTHREAD_INHERIT_SCHED       0x4
75 #define PTHREAD_NOFLOAT             0x8
76 
77 #define PTHREAD_CREATE_DETACHED     PTHREAD_DETACHED
78 #define PTHREAD_CREATE_JOINABLE     0
79 #define PTHREAD_SCOPE_PROCESS       0
80 #define PTHREAD_EXPLICIT_SCHED      0
81 
82 /*
83  * Forward structure definitions.
84  *
85  * These are mostly opaque to the user.
86  */
87 struct pthread;
88 struct pthread_attr;
89 struct pthread_cond;
90 struct pthread_cond_attr;
91 struct pthread_mutex;
92 struct pthread_mutex_attr;
93 struct pthread_once;
94 struct sched_param;
95 
96 /*
97  * Primitive system data type definitions required by P1003.1c.
98  *
99  * Note that P1003.1c specifies that there are no defined comparison
100  * or assignment operators for the types pthread_attr_t, pthread_cond_t,
101  * pthread_condattr_t, pthread_mutex_t, pthread_mutexattr_t.
102  */
103 typedef struct	pthread			*pthread_t;
104 typedef struct	pthread_attr		*pthread_attr_t;
105 typedef struct	pthread_mutex		*pthread_mutex_t;
106 typedef struct	pthread_mutex_attr	*pthread_mutexattr_t;
107 typedef struct	pthread_cond		*pthread_cond_t;
108 typedef struct	pthread_cond_attr	*pthread_condattr_t;
109 typedef int     			pthread_key_t;
110 typedef struct	pthread_once		pthread_once_t;
111 
112 /*
113  * Additional type definitions:
114  *
115  * Note that P1003.1c reserves the prefixes pthread_ and PTHREAD_ for
116  * use in header symbols.
117  */
118 typedef void	*pthread_addr_t;
119 typedef void	*(*pthread_startroutine_t) (void *);
120 
121 /*
122  * Once definitions.
123  */
124 struct pthread_once {
125 	int		state;
126 	pthread_mutex_t	mutex;
127 };
128 
129 /*
130  * Flags for once initialization.
131  */
132 #define PTHREAD_NEEDS_INIT  0
133 #define PTHREAD_DONE_INIT   1
134 
135 /*
136  * Static once initialization values.
137  */
138 #define PTHREAD_ONCE_INIT   { PTHREAD_NEEDS_INIT, NULL }
139 
140 /*
141  * Default attribute arguments.
142  */
143 #ifndef PTHREAD_KERNEL
144 #define pthread_condattr_default    NULL
145 #define pthread_mutexattr_default   NULL
146 #define pthread_attr_default        NULL
147 #endif
148 
149 enum pthread_mutextype {
150 	MUTEX_TYPE_FAST			= 1,
151 	MUTEX_TYPE_COUNTING_FAST	= 2,	/* Recursive */
152 	MUTEX_TYPE_MAX
153 };
154 
155 /*
156  * Thread function prototype definitions:
157  */
158 __BEGIN_DECLS
159 int		pthread_attr_destroy __P((pthread_attr_t *));
160 int		pthread_attr_getinheritsched __P((pthread_attr_t *, int *));
161 int		pthread_attr_getschedparam __P((pthread_attr_t *,
162 			struct sched_param *));
163 int		pthread_attr_getschedpolicy __P((pthread_attr_t *, int *));
164 int		pthread_attr_getscope __P((pthread_attr_t *, int *));
165 int		pthread_attr_getstacksize __P((pthread_attr_t *, size_t *));
166 int		pthread_attr_getstackaddr __P((pthread_attr_t *, void **));
167 int		pthread_attr_getdetachstate __P((pthread_attr_t *, int *));
168 int		pthread_attr_init __P((pthread_attr_t *));
169 int		pthread_attr_setinheritsched __P((pthread_attr_t *, int));
170 int		pthread_attr_setschedparam __P((pthread_attr_t *,
171 			struct sched_param *));
172 int		pthread_attr_setschedpolicy __P((pthread_attr_t *, int));
173 int		pthread_attr_setscope __P((pthread_attr_t *, int));
174 int		pthread_attr_setstacksize __P((pthread_attr_t *, size_t));
175 int		pthread_attr_setstackaddr __P((pthread_attr_t *, void *));
176 int		pthread_attr_setdetachstate __P((pthread_attr_t *, int));
177 void		pthread_cleanup_pop __P((int execute));
178 void		pthread_cleanup_push __P((void (*routine) (void *),
179 			void *routine_arg));
180 int		pthread_condattr_destroy __P((pthread_condattr_t *attr));
181 int		pthread_condattr_init __P((pthread_condattr_t *attr));
182 int		pthread_condattr_getpshared __P((pthread_condattr_t *attr,
183 			int *pshared));
184 int		pthread_condattr_setpshared __P((pthread_condattr_t *attr,
185 			int pshared));
186 int		pthread_cond_broadcast __P((pthread_cond_t *));
187 int		pthread_cond_destroy __P((pthread_cond_t *));
188 int		pthread_cond_init __P((pthread_cond_t *,
189 			const pthread_condattr_t *));
190 int		pthread_cond_signal __P((pthread_cond_t *));
191 int		pthread_cond_timedwait __P((pthread_cond_t *,
192 			pthread_mutex_t *, const struct timespec * abstime));
193 int		pthread_cond_wait __P((pthread_cond_t *, pthread_mutex_t *));
194 int		pthread_create __P((pthread_t *, const pthread_attr_t *,
195 			void *(*start_routine) (void *), void *));
196 int		pthread_detach __P((pthread_t *));
197 int		pthread_equal __P((pthread_t, pthread_t));
198 void		pthread_exit __P((void *));
199 void		*pthread_getspecific __P((pthread_key_t));
200 int		pthread_join __P((pthread_t, void **));
201 int		pthread_key_create __P((pthread_key_t *,
202 			void (*routine) (void *)));
203 int		pthread_key_delete __P((pthread_key_t));
204 int		pthread_kill __P((struct pthread *, int));
205 int		pthread_mutexattr_destroy __P((pthread_mutexattr_t *));
206 int		pthread_mutexattr_getprioceiling __P((pthread_mutexattr_t *,
207 			int *prioceiling));
208 int		pthread_mutexattr_getprotocol __P((pthread_mutexattr_t *,
209 			int *protocol));
210 int		pthread_mutexattr_getpshared __P((pthread_mutexattr_t *,
211 			int *pshared));
212 int		pthread_mutexattr_init __P((pthread_mutexattr_t *));
213 int		pthread_mutexattr_setprioceiling __P((pthread_mutexattr_t *,
214 			int prioceiling));
215 int		pthread_mutexattr_setprotocol __P((pthread_mutexattr_t *,
216 			int protocol));
217 int		pthread_mutexattr_setpshared __P((pthread_mutexattr_t *,
218 			int pshared));
219 int		pthread_mutex_destroy __P((pthread_mutex_t *));
220 int		pthread_mutex_getprioceiling __P((pthread_mutex_t *));
221 int		pthread_mutex_init __P((pthread_mutex_t *,
222 			const pthread_mutexattr_t *));
223 int		pthread_mutex_lock __P((pthread_mutex_t *));
224 int		pthread_mutex_setprioceiling __P((pthread_mutex_t *));
225 int		pthread_mutex_trylock __P((pthread_mutex_t *));
226 int		pthread_mutex_unlock __P((pthread_mutex_t *));
227 int		pthread_once __P((pthread_once_t *,
228 			void (*init_routine) (void)));
229 pthread_t	pthread_self __P((void));
230 int		pthread_setcancelstate __P((int, int *));
231 int		pthread_setcanceltype __P((int, int *));
232 int		pthread_setspecific __P((pthread_key_t, const void *));
233 int		pthread_sigmask __P((int, const sigset_t *, sigset_t *));
234 int		pthread_testcancel __P((void));
235 
236 
237 int		pthread_getprio __P((pthread_t));
238 int		pthread_setprio __P((pthread_t, int));
239 void		pthread_yield __P((void));
240 int		pthread_setschedparam __P((pthread_t pthread, int policy,
241 			struct sched_param * param));
242 int		pthread_getschedparam __P((pthread_t pthread, int *policy,
243 			struct sched_param * param));
244 int		pthread_attr_setfloatstate __P((pthread_attr_t *, int));
245 int		pthread_attr_getfloatstate __P((pthread_attr_t *, int *));
246 int		pthread_attr_setcleanup __P((pthread_attr_t *,
247 			void (*routine) (void *), void *));
248 __END_DECLS
249 
250 #endif
251