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