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