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