pthread.h revision 1.1.2.13 1 /* $NetBSD: pthread.h,v 1.1.2.13 2002/10/27 23:35:01 thorpej Exp $ */
2
3 /*-
4 * Copyright (c) 2001 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Nathan J. Williams.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the NetBSD
21 * Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39 #ifndef _LIB_PTHREAD_H
40 #define _LIB_PTHREAD_H
41
42 #include <sys/cdefs.h>
43
44 #include <time.h> /* For timespec */
45 #include <sched.h>
46 #include <signal.h> /* For sigset_t. XXX pthread_sigmask should
47 * be in signal.h instead of here.
48 */
49 #include "pthread_types.h"
50 #include <sched.h>
51
52 __BEGIN_DECLS
53 int pthread_create(pthread_t *thread, const pthread_attr_t *attr,
54 void *(*startfunc)(void *), void *arg);
55 void pthread_exit(void *retval) __attribute__((__noreturn__));
56 int pthread_join(pthread_t thread, void **valptr);
57 int pthread_equal(pthread_t t1, pthread_t t2);
58 pthread_t pthread_self(void);
59 int pthread_detach(pthread_t thread);
60
61 int pthread_kill(pthread_t thread, int sig);
62 int pthread_sigmask(int how, const sigset_t *set, sigset_t *oset);
63
64 int pthread_attr_destroy(pthread_attr_t *attr);
65 int pthread_attr_getdetachstate(pthread_attr_t *attr, int *detachstate);
66 int pthread_attr_init(pthread_attr_t *attr);
67 int pthread_attr_setdetachstate(pthread_attr_t *attr, int detachstate);
68 int pthread_attr_setschedparam(pthread_attr_t *attr,
69 const struct sched_param *param);
70 int pthread_attr_getschedparam(pthread_attr_t *attr,
71 struct sched_param *param);
72
73 int pthread_mutex_init(pthread_mutex_t *mutex,
74 const pthread_mutexattr_t *attr);
75 int pthread_mutex_destroy(pthread_mutex_t *mutex);
76 int pthread_mutex_lock(pthread_mutex_t *mutex);
77 int pthread_mutex_trylock(pthread_mutex_t *mutex);
78 int pthread_mutex_unlock(pthread_mutex_t *mutex);
79 int pthread_mutexattr_init(pthread_mutexattr_t *attr);
80 int pthread_mutexattr_destroy(pthread_mutexattr_t *attr);
81
82 int pthread_cond_init(pthread_cond_t *cond,
83 const pthread_condattr_t *attr);
84 int pthread_cond_destroy(pthread_cond_t *cond);
85 int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex);
86 int pthread_cond_timedwait(pthread_cond_t *cond, pthread_mutex_t *mutex,
87 const struct timespec *abstime);
88 int pthread_cond_signal(pthread_cond_t *cond);
89 int pthread_cond_broadcast(pthread_cond_t *cond);
90 int pthread_condattr_init(pthread_condattr_t *attr);
91 int pthread_condattr_destroy(pthread_condattr_t *attr);
92
93 int pthread_once(pthread_once_t *once_control, void (*routine)(void));
94
95 int pthread_key_create(pthread_key_t *key, void (*destructor)(void *));
96 int pthread_key_delete(pthread_key_t key);
97 int pthread_setspecific(pthread_key_t key, const void *value);
98 void* pthread_getspecific(pthread_key_t key);
99
100 int pthread_cancel(pthread_t thread);
101 int pthread_setcancelstate(int state, int *oldstate);
102 int pthread_setcanceltype(int type, int *oldtype);
103 void pthread_testcancel(void);
104
105 struct pthread_cleanup_store {
106 void *pad[4];
107 };
108
109 #define pthread_cleanup_push(routine,arg) \
110 { \
111 struct pthread_cleanup_store __store; \
112 pthread__cleanup_push((routine),(arg), &__store);
113
114 #define pthread_cleanup_pop(execute) \
115 pthread__cleanup_pop((execute), &__store); \
116 }
117
118 void pthread__cleanup_push(void (*routine)(void *), void *arg, void *store);
119 void pthread__cleanup_pop(int execute, void *store);
120
121 int pthread_spin_init(pthread_spinlock_t *lock, int pshared);
122 int pthread_spin_destroy(pthread_spinlock_t *lock);
123 int pthread_spin_lock(pthread_spinlock_t *lock);
124 int pthread_spin_trylock(pthread_spinlock_t *lock);
125 int pthread_spin_unlock(pthread_spinlock_t *lock);
126
127 int *pthread__errno(void);
128 __END_DECLS
129
130 #define PTHREAD_CREATE_JOINABLE 0
131 #define PTHREAD_CREATE_DETACHED 1
132
133 #define PTHREAD_PROCESS_PRIVATE 0
134 #define PTHREAD_PROCESS_SHARED 1
135
136 #define PTHREAD_CANCEL_DEFERRED 0
137 #define PTHREAD_CANCEL_ASYNCHRONOUS 1
138
139 #define PTHREAD_CANCEL_ENABLE 0
140 #define PTHREAD_CANCEL_DISABLE 1
141
142 /* POSIX 1003.1-2001, section 2.5.9.3: "The symbolic constant
143 * PTHREAD_CANCELED expands to a constant expression of type (void *)
144 * whose value matches no pointer to an object in memory nor the value
145 * NULL."
146 */
147 #define PTHREAD_CANCELED ((void *) 1)
148
149 #define _POSIX_THREADS
150
151 #define PTHREAD_DESTRUCTOR_ITERATIONS 4 /* Min. required */
152 #define PTHREAD_KEYS_MAX 256
153 #define PTHREAD_STACK_MIN 4096 /* XXX Pulled out of my butt */
154 #define PTHREAD_THREADS_MAX 64 /* Min. required */
155
156 typedef struct pthread_ops_st {
157 int (*mutex_init)(pthread_mutex_t *, const pthread_mutexattr_t *);
158 int (*mutex_lock)(pthread_mutex_t *);
159 int (*mutex_trylock)(pthread_mutex_t *);
160 int (*mutex_unlock)(pthread_mutex_t *);
161 int (*mutex_destroy)(pthread_mutex_t *);
162 int (*mutexattr_init)(pthread_mutexattr_t *);
163 int (*mutexattr_destroy)(pthread_mutexattr_t *);
164
165 int (*cond_init)(pthread_cond_t *, const pthread_condattr_t *);
166 int (*cond_signal)(pthread_cond_t *);
167 int (*cond_broadcast)(pthread_cond_t *);
168 int (*cond_wait)(pthread_cond_t *, pthread_mutex_t *);
169 int (*cond_timedwait)(pthread_cond_t *, pthread_mutex_t *,
170 const struct timespec *);
171 int (*cond_destroy)(pthread_cond_t *);
172 int (*condattr_init)(pthread_condattr_t *);
173 int (*condattr_destroy)(pthread_condattr_t *);
174
175 int (*thr_keycreate)(pthread_key_t *, void (*)(void *));
176 int (*thr_setspecific)(pthread_key_t, const void *);
177 void *(*thr_getspecific)(pthread_key_t);
178 int (*thr_keydelete)(pthread_key_t);
179
180 int (*thr_once)(pthread_once_t *, void (*)(void));
181
182 pthread_t (*thr_self)(void);
183
184 int (*thr_sigsetmask)(int, const sigset_t *, sigset_t *);
185
186 int *(*thr_errno)(void);
187 } pthread_ops_t;
188
189
190 #endif /* _LIB_PTHREAD_H */
191