summaryrefslogtreecommitdiff
path: root/lib/libc_r/include/pthread.h
blob: 1d997eb7e0b1657e7d3b54583f990aaa6052551e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
/*
 * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu
 * Copyright (c) 1995-1998 by John Birrell <jb@cimlogic.com.au>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *  This product includes software developed by Chris Provenzano.
 * 4. The name of Chris Provenzano may not be used to endorse or promote 
 *	  products derived from this software without specific prior written
 *	  permission.
 *
 * THIS SOFTWARE IS PROVIDED BY CHRIS PROVENZANO ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL CHRIS PROVENZANO BE LIABLE FOR ANY 
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
 * SUCH DAMAGE.
 *
 * $OpenBSD: pthread.h,v 1.6 1999/03/10 10:00:47 d Exp $
 *
 */
#ifndef _PTHREAD_H_
#define _PTHREAD_H_

#ifdef _POSIX_THREADS

/*
 * Header files.
 */
#include <sys/cdefs.h>
#include <sys/types.h>
#include <sys/time.h>
#include <sys/signal.h>
#include <limits.h>
#include <sched.h>

/*
 * Run-time invariant values:
 */
#define PTHREAD_DESTRUCTOR_ITERATIONS		4
#define PTHREAD_KEYS_MAX			256
#define PTHREAD_STACK_MIN			1024
#define PTHREAD_THREADS_MAX			ULONG_MAX

/*
 * Compile time symbolic constants for portability specifications:
 *
 * Note that those commented out are not currently supported by the
 * implementation.
 */

#define _POSIX_THREAD_ATTR_STACKADDR
#define _POSIX_THREAD_ATTR_STACKSIZE
/* #define _POSIX_THREAD_PRIORITY_SCHEDULING */
/* #define _POSIX_THREAD_PRIO_INHERIT   */
/* #define _POSIX_THREAD_PRIO_PROTECT   */
/* #define _POSIX_THREAD_PROCESS_SHARED */
#define _POSIX_THREAD_SAFE_FUNCTIONS

/*
 * Flags for threads and thread attributes.
 */
#define PTHREAD_DETACHED            0x1
#define PTHREAD_SCOPE_SYSTEM        0x2
#define PTHREAD_INHERIT_SCHED       0x4
#define PTHREAD_NOFLOAT             0x8

#define PTHREAD_CREATE_DETACHED     PTHREAD_DETACHED
#define PTHREAD_CREATE_JOINABLE     0
#define PTHREAD_SCOPE_PROCESS       0
#define PTHREAD_EXPLICIT_SCHED      0

/*
 * Flags for read/write lock attributes
 */
#define PTHREAD_PROCESS_PRIVATE     0
#define PTHREAD_PROCESS_SHARED      1	

/*
 * Flags for cancelling threads
 */
#define PTHREAD_CANCEL_ENABLE		0
#define PTHREAD_CANCEL_DISABLE		1
#define PTHREAD_CANCEL_DEFERRED		0
#define PTHREAD_CANCEL_ASYNCHRONOUS	1
#define PTHREAD_CANCELED		((void *) 1)

/*
 * Forward structure definitions.
 *
 * These are mostly opaque to the user.
 */
struct pthread;
struct pthread_attr;
struct pthread_cond;
struct pthread_cond_attr;
struct pthread_mutex;
struct pthread_mutex_attr;
struct pthread_once;
struct pthread_rwlock;
struct pthread_rwlockattr;
struct sched_param;

/*
 * Primitive system data type definitions required by P1003.1c.
 *
 * Note that P1003.1c specifies that there are no defined comparison
 * or assignment operators for the types pthread_attr_t, pthread_cond_t,
 * pthread_condattr_t, pthread_mutex_t, pthread_mutexattr_t.
 */
typedef struct	pthread			*pthread_t;
typedef struct	pthread_attr		*pthread_attr_t;
typedef struct	pthread_mutex		*pthread_mutex_t;
typedef struct	pthread_mutex_attr	*pthread_mutexattr_t;
typedef struct	pthread_cond		*pthread_cond_t;
typedef struct	pthread_cond_attr	*pthread_condattr_t;
typedef int     			pthread_key_t;
typedef struct	pthread_once		pthread_once_t;
typedef struct	pthread_rwlock		*pthread_rwlock_t;
typedef struct	pthread_rwlockattr	*pthread_rwlockattr_t;

/*
 * Additional type definitions:
 *
 * Note that P1003.1c reserves the prefixes pthread_ and PTHREAD_ for
 * use in header symbols.
 */
typedef void	*pthread_addr_t;
typedef void	*(*pthread_startroutine_t) __P((void *));

/*
 * Once definitions.
 */
struct pthread_once {
	int		state;
	pthread_mutex_t	mutex;
};

/*
 * Flags for once initialization.
 */
#define PTHREAD_NEEDS_INIT  0
#define PTHREAD_DONE_INIT   1

/*
 * Static once initialization values. 
 */
#define PTHREAD_ONCE_INIT   { PTHREAD_NEEDS_INIT, PTHREAD_MUTEX_INITIALIZER }

/*
 * Static initialization values. 
 */
#define PTHREAD_MUTEX_INITIALIZER	((pthread_mutex_t) NULL)
#define PTHREAD_COND_INITIALIZER	((pthread_cond_t) NULL)
#define PTHREAD_RWLOCK_INITIALIZER	((pthread_rwlock_t) NULL)

enum pthread_mutextype {
	PTHREAD_MUTEX_DEFAULT		= 1,
	PTHREAD_MUTEX_RECURSIVE		= 2,
	PTHREAD_MUTEX_NORMAL		= 3,
	PTHREAD_MUTEX_ERRORCHECK	= 4,
	MUTEX_TYPE_MAX
};

#define MUTEX_TYPE_FAST			PTHREAD_MUTEX_DEFAULT
#define MUTEX_TYPE_COUNTING_FAST	PTHREAD_MUTEX_RECURSIVE

/*
 * Thread function prototype definitions:
 */
__BEGIN_DECLS
int		pthread_atfork(void (*)(void), void (*)(void), void (*)(void));
int		pthread_attr_destroy __P((pthread_attr_t *));
int		pthread_attr_getinheritsched __P((const pthread_attr_t *, int *));
int		pthread_attr_getschedparam __P((const pthread_attr_t *,
			struct sched_param *));
int		pthread_attr_getschedpolicy __P((const pthread_attr_t *, int *));
int		pthread_attr_getscope __P((const pthread_attr_t *, int *));
int		pthread_attr_getstacksize __P((pthread_attr_t *, size_t *));
int		pthread_attr_getstackaddr __P((pthread_attr_t *, void **));
int		pthread_attr_getdetachstate __P((pthread_attr_t *, int *));
int		pthread_attr_init __P((pthread_attr_t *));
int		pthread_attr_setinheritsched __P((pthread_attr_t *, int));
int		pthread_attr_setschedparam __P((pthread_attr_t *,
			const struct sched_param *));
int		pthread_attr_setschedpolicy __P((pthread_attr_t *, int));
int		pthread_attr_setscope __P((pthread_attr_t *, int));
int		pthread_attr_setstacksize __P((pthread_attr_t *, size_t));
int		pthread_attr_setstackaddr __P((pthread_attr_t *, void *));
int		pthread_attr_setdetachstate __P((pthread_attr_t *, int));
int		pthread_cancel __P((pthread_t));
void		pthread_cleanup_pop __P((int execute));
void		pthread_cleanup_push __P((void (*routine) (void *),
			void *routine_arg));
int		pthread_condattr_destroy __P((pthread_condattr_t *attr));
int		pthread_condattr_init __P((pthread_condattr_t *attr));
int		pthread_condattr_getpshared __P((const pthread_condattr_t *attr,
			int *pshared));
int		pthread_condattr_setpshared __P((pthread_condattr_t *attr,
			int pshared));
int		pthread_cond_broadcast __P((pthread_cond_t *));
int		pthread_cond_destroy __P((pthread_cond_t *));
int		pthread_cond_init __P((pthread_cond_t *,
			const pthread_condattr_t *));
int		pthread_cond_signal __P((pthread_cond_t *));
int		pthread_cond_timedwait __P((pthread_cond_t *,
			pthread_mutex_t *, const struct timespec * abstime));
int		pthread_cond_wait __P((pthread_cond_t *, pthread_mutex_t *));
int		pthread_create __P((pthread_t *, const pthread_attr_t *,
			void *(*start_routine) (void *), void *));
int		pthread_detach __P((pthread_t));
int		pthread_equal __P((pthread_t, pthread_t));
__dead void	pthread_exit __P((void *)) __attribute__((noreturn));
void		*pthread_getspecific __P((pthread_key_t));
int		pthread_join __P((pthread_t, void **));
int		pthread_key_create __P((pthread_key_t *,
			void (*routine) (void *)));
int		pthread_key_delete __P((pthread_key_t));
int		pthread_kill __P((struct pthread *, int));
int		pthread_mutexattr_destroy __P((pthread_mutexattr_t *));
int		pthread_mutexattr_getprioceiling __P((pthread_mutexattr_t *,
			int *prioceiling));
int		pthread_mutexattr_getprotocol __P((pthread_mutexattr_t *,
			int *protocol));
int		pthread_mutexattr_getpshared __P((pthread_mutexattr_t *,
			int *pshared));
int		pthread_mutexattr_init __P((pthread_mutexattr_t *));
int		pthread_mutexattr_setprioceiling __P((pthread_mutexattr_t *,
			int prioceiling));
int		pthread_mutexattr_setprotocol __P((pthread_mutexattr_t *,
			int protocol));
int		pthread_mutexattr_setpshared __P((pthread_mutexattr_t *,
			int pshared));
int		pthread_mutexattr_settype __P((pthread_mutexattr_t *, int));
int		pthread_mutex_destroy __P((pthread_mutex_t *));
int		pthread_mutex_getprioceiling __P((pthread_mutex_t *));
int		pthread_mutex_init __P((pthread_mutex_t *,
			const pthread_mutexattr_t *));
int		pthread_mutex_lock __P((pthread_mutex_t *));
int		pthread_mutex_setprioceiling __P((pthread_mutex_t *));
int		pthread_mutex_trylock __P((pthread_mutex_t *));
int		pthread_mutex_unlock __P((pthread_mutex_t *));
int		pthread_once __P((pthread_once_t *,
			void (*init_routine) (void)));
int		pthread_rwlock_destroy __P((pthread_rwlock_t *));
int		pthread_rwlock_init __P((pthread_rwlock_t *,
			const pthread_rwlockattr_t *));
int		pthread_rwlock_rdlock __P((pthread_rwlock_t *));
int		pthread_rwlock_tryrdlock __P((pthread_rwlock_t *));
int		pthread_rwlock_trywrlock __P((pthread_rwlock_t *));
int		pthread_rwlock_unlock __P((pthread_rwlock_t *));
int		pthread_rwlock_wrlock __P((pthread_rwlock_t *));
int		pthread_rwlockattr_init __P((pthread_rwlockattr_t *));
int		pthread_rwlockattr_getpshared __P((const pthread_rwlockattr_t *,
			int *));
int		pthread_rwlockattr_setpshared __P((pthread_rwlockattr_t *,
			int *));
int		pthread_rwlockattr_destroy __P((pthread_rwlockattr_t *));
pthread_t	pthread_self __P((void));
int		pthread_setcancelstate __P((int, int *));
int		pthread_setcanceltype __P((int, int *));
int		pthread_setspecific __P((pthread_key_t, const void *));
int		pthread_sigmask __P((int, const sigset_t *, sigset_t *));
void		pthread_testcancel __P((void));


int		pthread_getprio __P((pthread_t));
int		pthread_setprio __P((pthread_t, int));
void		pthread_yield __P((void));
int		pthread_setschedparam __P((pthread_t pthread, int policy,
			const struct sched_param * param));
int		pthread_getschedparam __P((pthread_t pthread, int *policy,
			struct sched_param * param));
int		pthread_attr_setfloatstate __P((pthread_attr_t *, int));
int		pthread_attr_getfloatstate __P((pthread_attr_t *, int *));
int		pthread_attr_setcleanup __P((pthread_attr_t *,
			void (*routine) (void *), void *));


#if 0
/*
 * Single Unix Specification v2 (UNIX98) also wants these:
 */

#define PTHREAD_PRIO_INHERIT
#define PTHREAD_PRIO_NONE
#define PTHREAD_PRIO_PROTECT

int		pthread_attr_getguardsize __P((const pthread_attr_t *, 
			size_t *));
int		pthread_attr_setguardsize __P((const pthread_attr_t *, 
			size_t));
int		pthread_getconcurrency __P((void));
int		pthread_mutexattr_gettype __P((const pthread_mutexattr_t *,
			int *));
int		pthread_setconcurrency __P((int));

#endif	/* susv2 */

__END_DECLS

#else /* ! _POSIX_THREADS */
#warning "included <pthread.h> without -pthread compiler option"
#endif /* ! _POSIX_THREADS */
#endif /* _PTHREAD_H_ */