pthread_int.h revision 1.1.2.18 1 /* $NetBSD: pthread_int.h,v 1.1.2.18 2002/01/28 19:05:49 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_INT_H
40 #define _LIB_PTHREAD_INT_H
41
42 #include <sa.h>
43 #include <signal.h>
44
45 #define PTHREAD__DEBUG
46 #define ERRORCHECK
47
48 #include "pthread_types.h"
49 #include "pthread_queue.h"
50
51 /* The size of this structure needs to be no larger than struct
52 * __pthread_cleanup_store, defined in pthread.h.
53 */
54 struct pt_clean_t {
55 PTQ_ENTRY(pt_clean_t) ptc_next;
56 void (*ptc_cleanup)(void *);
57 void *ptc_arg;
58 };
59
60 struct pthread_st {
61 unsigned int pt_magic;
62
63 int pt_type; /* normal, upcall, or idle */
64 int pt_state; /* running, blocked, etc. */
65 pthread_spin_t pt_statelock; /* lock on pt_state */
66 int pt_flags; /* see PT_FLAG_* below */
67 int pt_cancel; /* Deferred cancellation */
68 int pt_spinlocks; /* Number of spinlocks held. */
69 int pt_blockedlwp; /* LWP/SA number when blocked */
70
71 int pt_errno; /* Thread-specific errno. */
72
73 /* Entry on the run queue */
74 PTQ_ENTRY(pthread_st) pt_runq;
75 /* Entry on the list of all threads */
76 PTQ_ENTRY(pthread_st) pt_allq;
77 /* Entry on the sleep queue (xxx should be same as run queue?) */
78 PTQ_ENTRY(pthread_st) pt_sleep;
79 /* Queue we're sleeping on */
80 struct pthread_queue_t *pt_sleepq;
81 /* Lock protecting that queue */
82 pthread_spin_t *pt_sleeplock;
83
84 stack_t pt_stack; /* Our stack */
85 ucontext_t *pt_uc; /* Saved context when we're stopped */
86
87 sigset_t pt_sigmask; /* Signals we won't take. */
88 sigset_t pt_siglist; /* Signals pending for us. */
89 pthread_spin_t pt_siglock; /* Lock on above */
90
91 void * pt_exitval; /* Read by pthread_join() */
92
93 /* Stack of cancellation cleanup handlers and their arguments */
94 PTQ_HEAD(, pt_clean_t) pt_cleanup_stack;
95
96 /* Other threads trying to pthread_join() us. */
97 struct pthread_queue_t pt_joiners;
98 /* Lock for above, and for changing pt_state to ZOMBIE or DEAD,
99 * and for setting the DETACHED flag
100 */
101 pthread_spin_t pt_join_lock;
102
103 /* Thread we were going to switch to before we were preempted
104 * ourselves. Will be used by the upcall that's continuing us.
105 */
106 pthread_t pt_switchto;
107 ucontext_t* pt_switchtouc;
108
109 /* The context we saved in pthread__locked_switch but which
110 * was trashed when we were preempted before switching stacks.
111 */
112 ucontext_t* pt_sleepuc;
113
114 /* Threads that are preempted with spinlocks held will be
115 * continued until they unlock their spinlock. When they do
116 * so, they should jump ship to the thread pointed to by
117 * pt_next.
118 */
119 pthread_t pt_next;
120
121 /* The upcall that is continuing this thread */
122 pthread_t pt_parent;
123
124 /* A queue lock that this thread held while trying to
125 * context switch to another process.
126 */
127 pthread_spin_t* pt_heldlock;
128
129 /* Thread-specific data */
130 void* pt_specific[PTHREAD_KEYS_MAX];
131
132 #ifdef PTHREAD__DEBUG
133 int blocks;
134 int preempts;
135 int rescheds;
136 #endif
137 };
138
139
140
141 /* Thread types */
142 #define PT_THREAD_NORMAL 1
143 #define PT_THREAD_UPCALL 2
144 #define PT_THREAD_IDLE 3
145
146 /* Thread states */
147 #define PT_STATE_RUNNABLE 1
148 #define PT_STATE_BLOCKED_SYS 2
149 #define PT_STATE_BLOCKED_QUEUE 3
150 #define PT_STATE_ZOMBIE 4
151 #define PT_STATE_DEAD 5
152 #define PT_STATE_RECYCLABLE 6
153
154 /* Flag values */
155
156 #define PT_FLAG_DETACHED 0x0001
157 #define PT_FLAG_IDLED 0x0002
158 #define PT_FLAG_CS_DISABLED 0x0004 /* Cancellation disabled */
159 #define PT_FLAG_CS_ASYNC 0x0008 /* Cancellation is async */
160 #define PT_FLAG_CS_PENDING 0x0010
161
162 #define PT_MAGIC 0x11110001
163 #define PT_DEAD 0xDEAD0001
164
165 #define PT_ATTR_MAGIC 0x22220002
166 #define PT_ATTR_DEAD 0xDEAD0002
167
168 #define PT_STACKSIZE (1<<16)
169 #define PT_STACKMASK (PT_STACKSIZE-1)
170
171 #define PT_UPCALLSTACKS 16
172
173 #define NIDLETHREADS 4
174 #define IDLESPINS 1000
175
176 /* Flag to be used in a ucontext_t's uc_flags indicating that
177 * the saved register state is "user" state only, not full
178 * trap state.
179 */
180 #define _UC_USER_BIT 30
181 #define _UC_USER (1LU << _UC_USER_BIT)
182
183 void pthread_init(void) __attribute__ ((__constructor__));
184
185 /* Utility functions */
186
187 /* Set up/clean up a thread's basic state. */
188 void pthread__initthread(pthread_t t);
189
190 /* Go do something else. Don't go back on the run queue */
191 void pthread__block(pthread_t self, pthread_spin_t* queuelock);
192 /* Put a thread back on the run queue */
193 void pthread__sched(pthread_t self, pthread_t thread);
194 void pthread__sched_idle(pthread_t self, pthread_t thread);
195 void pthread__sched_idle2(pthread_t self);
196
197 void pthread__sched_bulk(pthread_t self, pthread_t qhead);
198
199 void pthread__idle(void);
200
201 /* Get the next thread */
202 pthread_t pthread__next(pthread_t self);
203
204 int pthread__stackalloc(pthread_t *t);
205 void pthread__initmain(pthread_t *t);
206
207 void pthread__sa_start(void);
208 void pthread__sa_recycle(pthread_t old, pthread_t new);
209
210 /* Alarm code */
211 void *pthread__alarm_add(pthread_t, const struct timespec *,
212 void (*)(void *), void *);
213 void pthread__alarm_del(pthread_t, void *);
214 int pthread__alarm_fired(void *);
215 void pthread__alarm_process(pthread_t self, void *arg);
216
217
218 #include "pthread_md.h"
219
220 int _getcontext_u(ucontext_t *);
221 int _setcontext_u(const ucontext_t *);
222 int _swapcontext_u(ucontext_t *, const ucontext_t *);
223
224 void pthread__testcancel(pthread_t self);
225
226 /* Stack location of pointer to a particular thread */
227 #define pthread__id(sp) \
228 ((pthread_t) (((vaddr_t)(sp)) & ~PT_STACKMASK))
229
230 #define pthread__self() (pthread__id(pthread__sp()))
231
232 /* These three routines are defined in processor-specific code. */
233 void pthread__upcall_switch(pthread_t self, pthread_t next);
234 void pthread__switch(pthread_t self, pthread_t next);
235 void pthread__locked_switch(pthread_t self, pthread_t next,
236 pthread_spin_t *lock);
237
238
239 void pthread__signal(pthread_t t, int sig, int code);
240
241 void pthread__destroy_tsd(pthread_t self);
242
243
244 #define PTHREADD_CREATE 0
245 #define PTHREADD_IDLE 1
246 #define PTHREADD_UPCALLS 2
247 #define PTHREADD_UP_BLOCK 3
248 #define PTHREADD_UP_NEW 4
249 #define PTHREADD_UP_PREEMPT 5
250 #define PTHREADD_UP_UNBLOCK 6
251 #define PTHREADD_UP_SIGNAL 7
252 #define PTHREADD_SPINLOCKS 8
253 #define PTHREADD_SPINUNLOCKS 9
254 #define PTHREADD_SPINPREEMPT 10
255 #define PTHREADD_RESOLVELOCKS 11
256 #define PTHREADD_SWITCHTO 12
257 #define PTHREADD_NCOUNTERS 13
258
259 #ifdef PTHREAD__DEBUG
260
261 #define PTHREAD__DEBUG_SHMKEY (0x000f)
262 #define PTHREAD__DEBUG_SHMSIZE (1<<18)
263
264 extern int pthread__debug_counters[PTHREADD_NCOUNTERS];
265
266 #define PTHREADD_ADD(x) (pthread__debug_counters[(x)]++)
267
268 #define DPRINTF(x) pthread__debuglog_printf x
269
270 struct pthread_msgbuf {
271 #define BUF_MAGIC 0x090976
272 int msg_magic;
273 long msg_bufw;
274 long msg_bufr;
275 long msg_bufs;
276 char msg_bufc[1];
277 };
278
279 void pthread__debug_init(void);
280 struct pthread_msgbuf* pthread__debuglog_init(int force);
281 void pthread__debuglog_printf(const char *fmt, ...);
282
283 #else /* PTHREAD_DEBUG */
284
285 #define PTHREADD_ADD(x)
286 #define DPRINTF(x)
287
288 #endif /* PTHREAD_DEBUG */
289
290 #endif /* _LIB_PTHREAD_INT_H */
291
292