1 /* Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3 Contributed by Ulrich Drepper <drepper@redhat.com>, 2002.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, write to the Free
17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
27 #include <sys/types.h>
28 #include <hp-timing.h>
30 #include <lowlevellock.h>
31 #include <pthreaddef.h>
32 #include <dl-sysdep.h>
33 #include "../nptl_db/thread_db.h"
35 #ifdef HAVE_FORCED_UNWIND
38 #define __need_res_state
42 # define TCB_ALIGNMENT sizeof (double)
46 /* We keep thread specific data in a special data structure, a two-level
47 array. The top-level array contains pointers to dynamically allocated
48 arrays of a certain number of data pointers. So we can implement a
49 sparse array. Each dynamic second-level array has
50 PTHREAD_KEY_2NDLEVEL_SIZE
51 entries. This value shouldn't be too large. */
52 #define PTHREAD_KEY_2NDLEVEL_SIZE 32
54 /* We need to address PTHREAD_KEYS_MAX key with PTHREAD_KEY_2NDLEVEL_SIZE
55 keys in each subarray. */
56 #define PTHREAD_KEY_1STLEVEL_SIZE \
57 ((PTHREAD_KEYS_MAX + PTHREAD_KEY_2NDLEVEL_SIZE - 1) \
58 / PTHREAD_KEY_2NDLEVEL_SIZE)
63 /* Internal version of the buffer to store cancellation handler
65 struct pthread_unwind_buf
75 /* This is the placeholder of the public version. */
80 /* Pointer to the previous cleanup buffer. */
81 struct pthread_unwind_buf
*prev
;
83 /* Backward compatibility: state of the old-style cleanup
84 handler at the time of the previous new-style cleanup handler
86 struct _pthread_cleanup_buffer
*cleanup
;
88 /* Cancellation type before the push call. */
95 /* Opcodes and data types for communication with the signal handler to
96 change user/group IDs. */
105 /* Thread descriptor data structure. */
111 /* This overlaps the TCB as used for TLS without threads (see tls.h). */
116 int multiple_threads
;
120 /* This extra padding has no special purpose, and this structure layout
121 is private and subject to change without affecting the official ABI.
122 We just have it here in case it might be convenient for some
123 implementation-specific instrumentation hack or suchlike. */
127 /* This descriptor's link on the `stack_used' or `__stack_user' list. */
130 /* Thread ID - which is also a 'is this thread descriptor (and
131 therefore stack) used' flag. */
134 /* Process ID - thread group ID in kernel speak. */
137 /* List of robust mutexes the thread is holding. */
138 pthread_mutex_t
*robust_list
;
140 #ifdef __PTHREAD_MUTEX_HAVE_PREV
141 # define ENQUEUE_MUTEX(mutex) \
143 mutex->__data.__next = THREAD_GETMEM (THREAD_SELF, robust_list); \
144 THREAD_SETMEM (THREAD_SELF, robust_list, mutex); \
145 if (mutex->__data.__next != NULL) \
146 mutex->__data.__next->__data.__prev = mutex; \
147 mutex->__data.__prev = NULL; \
149 # define DEQUEUE_MUTEX(mutex) \
151 if (mutex->__data.__prev == NULL) \
152 THREAD_SETMEM (THREAD_SELF, robust_list, mutex->__data.__next); \
154 mutex->__data.__prev->__data.__next = mutex->__data.__next; \
155 if (mutex->__data.__next != NULL) \
156 mutex->__data.__next->__data.__prev = mutex->__data.__prev; \
157 mutex->__data.__prev = NULL; \
158 mutex->__data.__next = NULL; \
161 # define ENQUEUE_MUTEX(mutex) \
163 mutex->__data.__next = THREAD_GETMEM (THREAD_SELF, robust_list); \
164 THREAD_SETMEM (THREAD_SELF, robust_list, mutex); \
166 # define DEQUEUE_MUTEX(mutex) \
168 pthread_mutex_t *runp = THREAD_GETMEM (THREAD_SELF, robust_list); \
170 THREAD_SETMEM (THREAD_SELF, robust_list, runp->__data.__next); \
173 while (runp->__data.__next != mutex) \
174 runp = runp->__data.__next; \
176 runp->__data.__next = runp->__data.__next->__data.__next; \
177 mutex->__data.__next = NULL; \
182 /* List of cleanup buffers. */
183 struct _pthread_cleanup_buffer
*cleanup
;
185 /* Unwind information. */
186 struct pthread_unwind_buf
*cleanup_jmp_buf
;
187 #define HAVE_CLEANUP_JMP_BUF
189 /* Flags determining processing of cancellation. */
191 /* Bit set if cancellation is disabled. */
192 #define CANCELSTATE_BIT 0
193 #define CANCELSTATE_BITMASK 0x01
194 /* Bit set if asynchronous cancellation mode is selected. */
195 #define CANCELTYPE_BIT 1
196 #define CANCELTYPE_BITMASK 0x02
197 /* Bit set if canceling has been initiated. */
198 #define CANCELING_BIT 2
199 #define CANCELING_BITMASK 0x04
200 /* Bit set if canceled. */
201 #define CANCELED_BIT 3
202 #define CANCELED_BITMASK 0x08
203 /* Bit set if thread is exiting. */
204 #define EXITING_BIT 4
205 #define EXITING_BITMASK 0x10
206 /* Bit set if thread terminated and TCB is freed. */
207 #define TERMINATED_BIT 5
208 #define TERMINATED_BITMASK 0x20
209 /* Bit set if thread is supposed to change XID. */
211 #define SETXID_BITMASK 0x40
212 /* Mask for the rest. Helps the compiler to optimize. */
213 #define CANCEL_RESTMASK 0xffffff80
215 #define CANCEL_ENABLED_AND_CANCELED(value) \
216 (((value) & (CANCELSTATE_BITMASK | CANCELED_BITMASK | EXITING_BITMASK \
217 | CANCEL_RESTMASK | TERMINATED_BITMASK)) == CANCELED_BITMASK)
218 #define CANCEL_ENABLED_AND_CANCELED_AND_ASYNCHRONOUS(value) \
219 (((value) & (CANCELSTATE_BITMASK | CANCELTYPE_BITMASK | CANCELED_BITMASK \
220 | EXITING_BITMASK | CANCEL_RESTMASK | TERMINATED_BITMASK)) \
221 == (CANCELTYPE_BITMASK | CANCELED_BITMASK))
223 /* We allocate one block of references here. This should be enough
224 to avoid allocating any memory dynamically for most applications. */
225 struct pthread_key_data
227 /* Sequence number. We use uintptr_t to not require padding on
228 32- and 64-bit machines. On 64-bit machines it helps to avoid
234 } specific_1stblock
[PTHREAD_KEY_2NDLEVEL_SIZE
];
236 /* Two-level array for the thread-specific data. */
237 struct pthread_key_data
*specific
[PTHREAD_KEY_1STLEVEL_SIZE
];
239 /* Flag which is set when specific data is set. */
242 /* True if events must be reported. */
245 /* True if the user provided the stack. */
248 /* True if thread must stop at startup time. */
251 /* Lock to synchronize access to the descriptor. */
254 /* Lock for synchronizing setxid calls. */
255 lll_lock_t setxid_futex
;
258 /* Offset of the CPU clock at start thread start time. */
259 hp_timing_t cpuclock_offset
;
262 /* If the thread waits to join another one the ID of the latter is
265 In case a thread is detached this field contains a pointer of the
266 TCB if the thread itself. This is something which cannot happen
267 in normal operation. */
268 struct pthread
*joinid
;
269 /* Check whether a thread is detached. */
270 #define IS_DETACHED(pd) ((pd)->joinid == (pd))
272 /* Flags. Including those copied from the thread attribute. */
275 /* The result of the thread function. */
278 /* Scheduling parameters for the new thread. */
279 struct sched_param schedparam
;
282 /* Start position of the code to be executed and the argument passed
284 void *(*start_routine
) (void *);
288 td_eventbuf_t eventbuf
;
289 /* Next descriptor with a pending event. */
290 struct pthread
*nextevent
;
292 #ifdef HAVE_FORCED_UNWIND
293 /* Machine-specific unwind info. */
294 struct _Unwind_Exception exc
;
297 /* If nonzero pointer to area allocated for the stack and its
300 size_t stackblock_size
;
301 /* Size of the included guard area. */
303 /* This is what the user specified and what we will report. */
304 size_t reported_guardsize
;
306 /* Resolver state. */
307 struct __res_state res
;
309 /* If you add fields after the res field above, please adjust
310 the following macro. */
311 #define PTHREAD_STRUCT_END_PADDING \
312 (sizeof (struct pthread) - offsetof (struct pthread, res) \
313 - sizeof (((struct pthread *) 0)->res))
315 } __attribute ((aligned (TCB_ALIGNMENT
)));