pthread.h revision 17706
1169695Skan/*
2169695Skan * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu
3169695Skan * Copyright (c) 1995 by John Birrell <jb@cimlogic.com.au>
4169695Skan * All rights reserved.
5169695Skan *
6169695Skan * Redistribution and use in source and binary forms, with or without
7169695Skan * modification, are permitted provided that the following conditions
8169695Skan * are met:
9169695Skan * 1. Redistributions of source code must retain the above copyright
10169695Skan *    notice, this list of conditions and the following disclaimer.
11169695Skan * 2. Redistributions in binary form must reproduce the above copyright
12169695Skan *    notice, this list of conditions and the following disclaimer in the
13169695Skan *    documentation and/or other materials provided with the distribution.
14169695Skan * 3. All advertising materials mentioning features or use of this software
15169695Skan *    must display the following acknowledgement:
16169695Skan *  This product includes software developed by Chris Provenzano.
17169695Skan * 4. The name of Chris Provenzano may not be used to endorse or promote
18169695Skan *	  products derived from this software without specific prior written
19169695Skan *	  permission.
20169695Skan *
21169695Skan * 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 */
74struct pthread;
75struct pthread_attr;
76struct pthread_cond;
77struct pthread_cond_attr;
78struct pthread_mutex;
79struct pthread_mutex_attr;
80struct pthread_once;
81struct 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 */
90typedef struct	pthread			*pthread_t;
91typedef struct	pthread_attr		*pthread_attr_t;
92typedef struct	pthread_mutex		*pthread_mutex_t;
93typedef struct	pthread_mutex_attr	*pthread_mutexattr_t;
94typedef struct	pthread_cond		*pthread_cond_t;
95typedef struct	pthread_cond_attr	*pthread_condattr_t;
96typedef int     			pthread_key_t;
97typedef 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 */
105typedef void	*pthread_addr_t;
106typedef void	*(*pthread_startroutine_t) (void *);
107
108/*
109 * Once definitions.
110 */
111struct 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#define pthread_mutexattr_default   NULL
132#ifndef PTHREAD_KERNEL
133#define pthread_attr_default        NULL
134#endif
135
136/*
137 * Thread function prototype definitions:
138 */
139__BEGIN_DECLS
140int		pthread_attr_destroy __P((pthread_attr_t *));
141int		pthread_attr_getinheritsched __P((pthread_attr_t *, int *));
142int		pthread_attr_getschedparam __P((pthread_attr_t *,
143			struct sched_param *));
144int		pthread_attr_getschedpolicy __P((pthread_attr_t *, int *));
145int		pthread_attr_getscope __P((pthread_attr_t *, int *));
146int		pthread_attr_getstacksize __P((pthread_attr_t *, size_t *));
147int		pthread_attr_getstackaddr __P((pthread_attr_t *, void **));
148int		pthread_attr_getdetachstate __P((pthread_attr_t *, int *));
149int		pthread_attr_init __P((pthread_attr_t *));
150int		pthread_attr_setinheritsched __P((pthread_attr_t *, int));
151int		pthread_attr_setschedparam __P((pthread_attr_t *,
152			struct sched_param *));
153int		pthread_attr_setschedpolicy __P((pthread_attr_t *, int));
154int		pthread_attr_setscope __P((pthread_attr_t *, int));
155int		pthread_attr_setstacksize __P((pthread_attr_t *, size_t));
156int		pthread_attr_setstackaddr __P((pthread_attr_t *, void *));
157int		pthread_attr_setdetachstate __P((pthread_attr_t *, int));
158void		pthread_cleanup_pop __P((int execute));
159int		pthread_cleanup_push __P((void (*routine) (void *),
160			void *routine_arg));
161int		pthread_condattr_destroy __P((pthread_condattr_t *attr));
162int		pthread_condattr_init __P((pthread_condattr_t *attr));
163int		pthread_condattr_getpshared __P((pthread_condattr_t *attr,
164			int *pshared));
165int		pthread_condattr_setpshared __P((pthread_condattr_t *attr,
166			int pshared));
167int		pthread_cond_broadcast __P((pthread_cond_t *));
168int		pthread_cond_destroy __P((pthread_cond_t *));
169int		pthread_cond_init __P((pthread_cond_t *,
170			const pthread_condattr_t *));
171int		pthread_cond_signal __P((pthread_cond_t *));
172int		pthread_cond_timedwait __P((pthread_cond_t *,
173			pthread_mutex_t *, const struct timespec * abstime));
174int		pthread_cond_wait __P((pthread_cond_t *, pthread_mutex_t *));
175int		pthread_create __P((pthread_t *, const pthread_attr_t *,
176			void *(*start_routine) (void *), void *));
177int		pthread_detach __P((pthread_t *));
178int		pthread_equal __P((pthread_t, pthread_t));
179void		pthread_exit __P((void *));
180int		pthread_getspecific __P((pthread_key_t, void **));
181int		pthread_join __P((pthread_t, void **));
182int		pthread_key_create __P((pthread_key_t *,
183			void (*routine) (void *)));
184int		pthread_key_delete __P((pthread_key_t));
185int		pthread_kill __P((struct pthread *, int));
186int		pthread_mutexattr_destroy __P((pthread_mutexattr_t *));
187int		pthread_mutexattr_getprioceiling __P((pthread_mutexattr_t *,
188			int *prioceiling));
189int		pthread_mutexattr_getprotocol __P((pthread_mutexattr_t *,
190			int *protocol));
191int		pthread_mutexattr_getpshared __P((pthread_mutexattr_t *,
192			int *pshared));
193int		pthread_mutexattr_init __P((pthread_mutexattr_t *));
194int		pthread_mutexattr_setprioceiling __P((pthread_mutexattr_t *,
195			int prioceiling));
196int		pthread_mutexattr_setprotocol __P((pthread_mutexattr_t *,
197			int protocol));
198int		pthread_mutexattr_setpshared __P((pthread_mutexattr_t *,
199			int pshared));
200int		pthread_mutex_destroy __P((pthread_mutex_t *));
201int		pthread_mutex_getprioceiling __P((pthread_mutex_t *));
202int		pthread_mutex_init __P((pthread_mutex_t *,
203			const pthread_mutexattr_t *));
204int		pthread_mutex_lock __P((pthread_mutex_t *));
205int		pthread_mutex_setprioceiling __P((pthread_mutex_t *));
206int		pthread_mutex_trylock __P((pthread_mutex_t *));
207int		pthread_mutex_unlock __P((pthread_mutex_t *));
208int		pthread_once __P((pthread_once_t *,
209			void (*init_routine) (void)));
210pthread_t	pthread_self __P((void));
211int		pthread_setcancelstate __P((int, int *));
212int		pthread_setcanceltype __P((int, int *));
213int		pthread_setspecific __P((pthread_key_t, const void *));
214int		pthread_sigmask __P((int, const sigset_t *, sigset_t *));
215int		pthread_testcancel __P((void));
216
217
218int		pthread_getprio __P((pthread_t));
219int		pthread_setprio __P((pthread_t, int));
220void		pthread_yield __P((void));
221int		pthread_setschedparam __P((pthread_t pthread, int policy,
222			struct sched_param * param));
223int		pthread_getschedparam __P((pthread_t pthread, int *policy,
224			struct sched_param * param));
225int		pthread_attr_setfloatstate __P((pthread_attr_t *, int));
226int		pthread_attr_getfloatstate __P((pthread_attr_t *, int *));
227int		pthread_attr_setcleanup __P((pthread_attr_t *,
228			void (*routine) (void *), void *));
229__END_DECLS
230
231#endif
232