pthread_int.h revision 1.44 1 /* $NetBSD: pthread_int.h,v 1.44 2007/08/04 18:54:13 ad Exp $ */
2
3 /*-
4 * Copyright (c) 2001, 2002, 2003, 2006, 2007 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 and Andrew Doran.
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 #define PTHREAD__DEBUG
43 #define ERRORCHECK
44
45 #include "pthread_types.h"
46 #include "pthread_queue.h"
47 #include "pthread_debug.h"
48 #include "pthread_md.h"
49
50 #include <lwp.h>
51 #include <signal.h>
52
53 #define PTHREAD_KEYS_MAX 256
54 /*
55 * The size of this structure needs to be no larger than struct
56 * __pthread_cleanup_store, defined in pthread.h.
57 */
58 struct pt_clean_t {
59 PTQ_ENTRY(pt_clean_t) ptc_next;
60 void (*ptc_cleanup)(void *);
61 void *ptc_arg;
62 };
63
64 /* Private data for pthread_attr_t */
65 struct pthread_attr_private {
66 char ptap_name[PTHREAD_MAX_NAMELEN_NP];
67 void *ptap_namearg;
68 void *ptap_stackaddr;
69 size_t ptap_stacksize;
70 size_t ptap_guardsize;
71 };
72
73 struct __pthread_st {
74 unsigned int pt_magic; /* Magic number */
75 int pt_num; /* ID XXX should die */
76 int pt_state; /* running, blocked, etc. */
77 pthread_spin_t pt_lock; /* lock on state */
78 int pt_flags; /* see PT_FLAG_* below */
79 int pt_cancel; /* Deferred cancellation */
80 int pt_spinlocks; /* Number of spinlocks held. */
81 void *pt_mutexhint; /* Last mutex held. */
82 int pt_errno; /* Thread-specific errno. */
83 stack_t pt_stack; /* Our stack */
84 ucontext_t *pt_uc; /* Saved context when we're stopped */
85 void *pt_exitval; /* Read by pthread_join() */
86 char *pt_name; /* Thread's name, set by the app. */
87
88 /* Stack of cancellation cleanup handlers and their arguments */
89 PTQ_HEAD(, pt_clean_t) pt_cleanup_stack;
90
91 /* Thread-specific data */
92 void *pt_specific[PTHREAD_KEYS_MAX];
93
94 /* For debugger: LWPs waiting to join. */
95 pthread_queue_t pt_joiners;
96 PTQ_ENTRY(__pthread_st) pt_joinq;
97
98 /* LWP ID and entry on the list of all threads. */
99 lwpid_t pt_lid;
100 PTQ_ENTRY(__pthread_st) pt_allq;
101
102 /*
103 * General synchronization data. We try to align, as threads
104 * on other CPUs will access this data frequently.
105 */
106 int pt_dummy1 __aligned(128);
107 int pt_sleeponq; /* on a sleep queue */
108 int pt_signalled; /* Received pthread_cond_signal() */
109 void *pt_sleepobj; /* object slept on */
110 pthread_queue_t *pt_sleepq; /* sleep queue */
111 PTQ_ENTRY(__pthread_st) pt_sleep;
112 int pt_dummy2 __aligned(128);
113 };
114
115 /* Thread states */
116 #define PT_STATE_RUNNING 1
117 #define PT_STATE_ZOMBIE 5
118 #define PT_STATE_DEAD 6
119
120 /* Flag values */
121
122 #define PT_FLAG_DETACHED 0x0001
123 #define PT_FLAG_CS_DISABLED 0x0004 /* Cancellation disabled */
124 #define PT_FLAG_CS_ASYNC 0x0008 /* Cancellation is async */
125 #define PT_FLAG_CS_PENDING 0x0010
126 #define PT_FLAG_SCOPE_SYSTEM 0x0040
127 #define PT_FLAG_EXPLICIT_SCHED 0x0080
128 #define PT_FLAG_SUSPENDED 0x0100 /* In the suspended queue */
129
130 #define PT_MAGIC 0x11110001
131 #define PT_DEAD 0xDEAD0001
132
133 #define PT_ATTR_MAGIC 0x22220002
134 #define PT_ATTR_DEAD 0xDEAD0002
135
136 #ifdef PT_FIXEDSTACKSIZE_LG
137
138 #define PT_STACKSIZE_LG PT_FIXEDSTACKSIZE_LG
139 #define PT_STACKSIZE (1<<(PT_STACKSIZE_LG))
140 #define PT_STACKMASK (PT_STACKSIZE-1)
141
142 #else /* PT_FIXEDSTACKSIZE_LG */
143
144 extern int pthread_stacksize_lg;
145 extern size_t pthread_stacksize;
146 extern vaddr_t pthread_stackmask;
147
148 #define PT_STACKSIZE_LG pthread_stacksize_lg
149 #define PT_STACKSIZE pthread_stacksize
150 #define PT_STACKMASK pthread_stackmask
151
152 #endif /* PT_FIXEDSTACKSIZE_LG */
153
154 /* Flag to be used in a ucontext_t's uc_flags indicating that
155 * the saved register state is "user" state only, not full
156 * trap state.
157 */
158 #define _UC_USER_BIT 30
159 #define _UC_USER (1LU << _UC_USER_BIT)
160
161 void pthread_init(void) __attribute__ ((__constructor__));
162
163 /* Utility functions */
164
165 /* Get offset from stack start to struct sa_stackinfo */
166 ssize_t pthread__stackinfo_offset(void);
167
168 void pthread__unpark_all(pthread_t self, pthread_spin_t *lock,
169 pthread_queue_t *threadq);
170 void pthread__unpark(pthread_t self, pthread_spin_t *lock,
171 pthread_queue_t *queue, pthread_t target);
172 int pthread__park(pthread_t self, pthread_spin_t *lock,
173 pthread_queue_t *threadq,
174 const struct timespec *abs_timeout,
175 int cancelpt, const void *hint);
176
177 int pthread__stackalloc(pthread_t *t);
178 void pthread__initmain(pthread_t *t);
179
180 /* Internal locking primitives */
181 void pthread__lockprim_init(int ncpu);
182 void pthread_lockinit(pthread_spin_t *lock);
183 void pthread_spinlock(pthread_t thread, pthread_spin_t *lock);
184 int pthread_spintrylock(pthread_t thread, pthread_spin_t *lock);
185 void pthread_spinunlock(pthread_t thread, pthread_spin_t *lock);
186
187 extern const struct pthread_lock_ops *pthread__lock_ops;
188
189 void pthread__simple_lock_init(__cpu_simple_lock_t *);
190 int pthread__simple_lock_try(__cpu_simple_lock_t *);
191 void pthread__simple_unlock(__cpu_simple_lock_t *);
192
193 #ifndef _getcontext_u
194 int _getcontext_u(ucontext_t *);
195 #endif
196 #ifndef _setcontext_u
197 int _setcontext_u(const ucontext_t *);
198 #endif
199 #ifndef _swapcontext_u
200 int _swapcontext_u(ucontext_t *, const ucontext_t *);
201 #endif
202
203 void pthread__testcancel(pthread_t self);
204 int pthread__find(pthread_t self, pthread_t target);
205
206 #ifndef PTHREAD_MD_INIT
207 #define PTHREAD_MD_INIT
208 #endif
209
210 #ifndef _INITCONTEXT_U_MD
211 #define _INITCONTEXT_U_MD(ucp)
212 #endif
213
214 #define _INITCONTEXT_U(ucp) do { \
215 (ucp)->uc_flags = _UC_CPU | _UC_STACK; \
216 _INITCONTEXT_U_MD(ucp) \
217 } while (/*CONSTCOND*/0)
218
219 #ifdef PTHREAD_MACHINE_HAS_ID_REGISTER
220 #define pthread__id(reg) (reg)
221 #else
222 /* Stack location of pointer to a particular thread */
223 #define pthread__id(sp) \
224 ((pthread_t) (((vaddr_t)(sp)) & ~PT_STACKMASK))
225
226 #define pthread__id_reg() pthread__sp()
227 #endif
228
229 #define pthread__self() (pthread__id(pthread__id_reg()))
230
231 #define pthread__abort() \
232 pthread__assertfunc(__FILE__, __LINE__, __func__, "unreachable")
233
234 #define pthread__assert(e) do { \
235 if (__predict_false(!(e))) \
236 pthread__assertfunc(__FILE__, __LINE__, __func__, #e); \
237 } while (/*CONSTCOND*/0)
238
239 #define pthread__error(err, msg, e) do { \
240 if (__predict_false(!(e))) { \
241 pthread__errorfunc(__FILE__, __LINE__, __func__, msg); \
242 return (err); \
243 } \
244 } while (/*CONSTCOND*/0)
245
246 void pthread__destroy_tsd(pthread_t self);
247 void pthread__assertfunc(const char *file, int line, const char *function,
248 const char *expr);
249 void pthread__errorfunc(const char *file, int line, const char *function,
250 const char *msg);
251
252 #if defined(i386) || defined(__x86_64__)
253 #define pthread__smt_pause() __asm __volatile("rep; nop" ::: "memory")
254 #else
255 #define pthread__smt_pause() /* nothing */
256 #endif
257
258 extern int pthread__nspins;
259
260 #endif /* _LIB_PTHREAD_INT_H */
261