pthread.h revision 1.1.2.7 1 /* $NetBSD: pthread.h,v 1.1.2.7 2001/12/30 02:14:41 nathanw 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
43 #include <time.h> /* For timespec */
44 #include <sched.h>
45 #include <signal.h> /* For sigset_t. XXX perhaps pthread_sigmask should
46 * be in signal.h instead of here.
47 */
48 #include "pthread_types.h"
49 #include "sched.h"
50
51 int pthread_create(pthread_t *thread, const pthread_attr_t *attr,
52 void *(*startfunc)(void *), void *arg);
53 void pthread_exit(void *retval) __attribute__((__noreturn__));
54 int pthread_join(pthread_t thread, void **valptr);
55 int pthread_equal(pthread_t t1, pthread_t t2);
56 pthread_t pthread_self(void);
57 int pthread_detach(pthread_t thread);
58
59 int pthread_kill(pthread_t thread, int sig);
60 int pthread_sigmask(int how, const sigset_t *set, sigset_t *oset);
61
62 int pthread_attr_destroy(pthread_attr_t *attr);
63 int pthread_attr_getdetachstate(pthread_attr_t *attr, int *detachstate);
64 int pthread_attr_init(pthread_attr_t *attr);
65 int pthread_attr_setdetachstate(pthread_attr_t *attr, int detachstate);
66 int pthread_attr_setschedparam(pthread_attr_t *attr,
67 const struct sched_param *param);
68 int pthread_attr_getschedparam(pthread_attr_t *attr,
69 struct sched_param *param);
70
71 int pthread_mutex_init(pthread_mutex_t *mutex,
72 const pthread_mutexattr_t *attr);
73 int pthread_mutex_destroy(pthread_mutex_t *mutex);
74 int pthread_mutex_lock(pthread_mutex_t *mutex);
75 int pthread_mutex_trylock(pthread_mutex_t *mutex);
76 int pthread_mutex_unlock(pthread_mutex_t *mutex);
77 int pthread_mutexattr_init(pthread_mutexattr_t *attr);
78 int pthread_mutexattr_destroy(pthread_mutexattr_t *attr);
79
80 int pthread_cond_init(pthread_cond_t *cond,
81 const pthread_condattr_t *attr);
82 int pthread_cond_destroy(pthread_cond_t *cond);
83 int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex);
84 int pthread_cond_timedwait(pthread_cond_t *cond, pthread_mutex_t *mutex,
85 const struct timespec *abstime);
86 int pthread_cond_signal(pthread_cond_t *cond);
87 int pthread_cond_broadcast(pthread_cond_t *cond);
88 int pthread_condattr_init(pthread_condattr_t *attr);
89 int pthread_condattr_destroy(pthread_condattr_t *attr);
90
91 int pthread_once(pthread_once_t *once_control, void (*routine)(void));
92
93 int pthread_key_create(pthread_key_t *key, void (*destructor)(void *));
94 int pthread_key_delete(pthread_key_t key);
95 int pthread_setspecific(pthread_key_t key, const void *value);
96 void* pthread_getspecific(pthread_key_t key);
97
98 int pthread_cancel(pthread_t thread);
99 int pthread_setcancelstate(int state, int *oldstate);
100 int pthread_setcanceltype(int type, int *oldtype);
101 void pthread_testcancel(void);
102
103 struct pthread_cleanup_store {
104 void *pad[4];
105 };
106
107 #define pthread_cleanup_push(routine,arg) \
108 { \
109 struct pthread_cleanup_store __store; \
110 pthread__cleanup_push((routine),(arg), &__store);
111
112 #define pthread_cleanup_pop(execute) \
113 pthread__cleanup_pop((execute), &__store); \
114 }
115
116 void pthread__cleanup_push(void (*routine)(void *), void *arg, void *store);
117 void pthread__cleanup_pop(int execute, void *store);
118
119 void pthread_lockinit(pthread_spin_t *lock);
120 void pthread_spinlock(pthread_t thread, pthread_spin_t *lock);
121 int pthread_spintrylock(pthread_t thread, pthread_spin_t *lock);
122 void pthread_spinunlock(pthread_t thread, pthread_spin_t *lock);
123
124 int *pthread__errno(void);
125
126 #define PTHREAD_CREATE_JOINABLE 0
127 #define PTHREAD_CREATE_DETACHED 1
128
129 #define PTHREAD_PROCESS_PRIVATE 0
130 #define PTHREAD_PROCESS_SHARED 1
131
132 #define PTHREAD_CANCEL_DEFERRED 0
133 #define PTHREAD_CANCEL_ASYNCHRONOUS 1
134
135 #define PTHREAD_CANCEL_ENABLE 0
136 #define PTHREAD_CANCEL_DISABLE 1
137
138 /* POSIX 1003.1-2001, section 2.5.9.3: "The symbolic constant
139 * PTHREAD_CANCELLED expands to a constant expression of type (void *)
140 * whose value matches no pointer to an object in memory nor the value
141 * NULL."
142 */
143 #define PTHREAD_CANCELLED ((void *) 1)
144
145 #define _POSIX_THREADS
146
147 #define PTHREAD_DESTRUCTOR_ITERATIONS 4 /* Min. required */
148 #define PTHREAD_KEYS_MAX 256
149 #define PTHREAD_STACK_MIN 4096 /* XXX Pulled out of my butt */
150 #define PTHREAD_THREADS_MAX 64 /* Min. required */
151
152
153 #endif /* _LIB_PTHREAD_H */
154