Update.
[glibc.git] / nptl / descr.h
blob361169804855f71c4569d1267bd65edb8f243a81
1 /* Copyright (C) 2002, 2003, 2004 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
18 02111-1307 USA. */
20 #ifndef _DESCR_H
21 #define _DESCR_H 1
23 #include <limits.h>
24 #include <sched.h>
25 #include <setjmp.h>
26 #include <stdbool.h>
27 #include <sys/types.h>
28 #include <hp-timing.h>
29 #include <list.h>
30 #include <lowlevellock.h>
31 #include <pthreaddef.h>
32 #include <dl-sysdep.h>
33 #include "../nptl_db/thread_db.h"
34 #include <tls.h>
35 #ifdef HAVE_FORCED_UNWIND
36 # include <unwind.h>
37 #endif
38 #define __need_res_state
39 #include <resolv.h>
41 #ifndef TCB_ALIGNMENT
42 # define TCB_ALIGNMENT sizeof (double)
43 #endif
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
64 information. */
65 struct pthread_unwind_buf
67 struct
69 __jmp_buf jmp_buf;
70 int mask_was_saved;
71 } cancel_jmp_buf[1];
73 union
75 /* This is the placeholder of the public version. */
76 void *pad[4];
78 struct
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
85 installment. */
86 struct _pthread_cleanup_buffer *cleanup;
88 /* Cancellation type before the push call. */
89 int canceltype;
90 } data;
91 } priv;
95 /* Thread descriptor data structure. */
96 struct pthread
98 union
100 #if !TLS_DTV_AT_TP
101 /* This overlaps the TCB as used for TLS without threads (see tls.h). */
102 tcbhead_t header;
103 #else
104 struct
106 int multiple_threads;
107 } header;
108 #endif
110 /* This extra padding has no special purpose, and this structure layout
111 is private and subject to change without affecting the official ABI.
112 We just have it here in case it might be convenient for some
113 implementation-specific instrumentation hack or suchlike. */
114 void *__padding[16];
117 /* This descriptor's link on the `stack_used' or `__stack_user' list. */
118 list_t list;
120 /* Thread ID - which is also a 'is this thread descriptor (and
121 therefore stack) used' flag. */
122 pid_t tid;
124 /* Process ID - thread group ID in kernel speak. */
125 pid_t pid;
127 /* List of cleanup buffers. */
128 struct _pthread_cleanup_buffer *cleanup;
130 /* Unwind information. */
131 struct pthread_unwind_buf *cleanup_jmp_buf;
132 #define HAVE_CLEANUP_JMP_BUF
134 /* Flags determining processing of cancellation. */
135 int cancelhandling;
136 /* Bit set if cancellation is disabled. */
137 #define CANCELSTATE_BIT 0
138 #define CANCELSTATE_BITMASK 0x01
139 /* Bit set if asynchronous cancellation mode is selected. */
140 #define CANCELTYPE_BIT 1
141 #define CANCELTYPE_BITMASK 0x02
142 /* Bit set if canceling has been initiated. */
143 #define CANCELING_BIT 2
144 #define CANCELING_BITMASK 0x04
145 /* Bit set if canceled. */
146 #define CANCELED_BIT 3
147 #define CANCELED_BITMASK 0x08
148 /* Bit set if thread is exiting. */
149 #define EXITING_BIT 4
150 #define EXITING_BITMASK 0x10
151 /* Bit set if thread terminated and TCB is freed. */
152 #define TERMINATED_BIT 5
153 #define TERMINATED_BITMASK 0x20
154 /* Mask for the rest. Helps the compiler to optimize. */
155 #define CANCEL_RESTMASK 0xffffffc0
157 #define CANCEL_ENABLED_AND_CANCELED(value) \
158 (((value) & (CANCELSTATE_BITMASK | CANCELED_BITMASK | EXITING_BITMASK \
159 | CANCEL_RESTMASK | TERMINATED_BITMASK)) == CANCELED_BITMASK)
160 #define CANCEL_ENABLED_AND_CANCELED_AND_ASYNCHRONOUS(value) \
161 (((value) & (CANCELSTATE_BITMASK | CANCELTYPE_BITMASK | CANCELED_BITMASK \
162 | EXITING_BITMASK | CANCEL_RESTMASK | TERMINATED_BITMASK)) \
163 == (CANCELTYPE_BITMASK | CANCELED_BITMASK))
165 /* We allocate one block of references here. This should be enough
166 to avoid allocating any memory dynamically for most applications. */
167 struct pthread_key_data
169 /* Sequence number. We use uintptr_t to not require padding on
170 32- and 64-bit machines. On 64-bit machines it helps to avoid
171 wrapping, too. */
172 uintptr_t seq;
174 /* Data pointer. */
175 void *data;
176 } specific_1stblock[PTHREAD_KEY_2NDLEVEL_SIZE];
178 /* Flag which is set when specific data is set. */
179 bool specific_used;
181 /* Two-level array for the thread-specific data. */
182 struct pthread_key_data *specific[PTHREAD_KEY_1STLEVEL_SIZE];
184 /* True if events must be reported. */
185 bool report_events;
187 /* True if the user provided the stack. */
188 bool user_stack;
190 /* Lock to synchronize access to the descriptor. */
191 lll_lock_t lock;
193 #if HP_TIMING_AVAIL
194 /* Offset of the CPU clock at start thread start time. */
195 hp_timing_t cpuclock_offset;
196 #endif
198 /* If the thread waits to join another one the ID of the latter is
199 stored here.
201 In case a thread is detached this field contains a pointer of the
202 TCB if the thread itself. This is something which cannot happen
203 in normal operation. */
204 struct pthread *joinid;
205 /* Check whether a thread is detached. */
206 #define IS_DETACHED(pd) ((pd)->joinid == (pd))
208 /* Flags. Including those copied from the thread attribute. */
209 int flags;
211 /* The result of the thread function. */
212 void *result;
214 /* Scheduling parameters for the new thread. */
215 struct sched_param schedparam;
216 int schedpolicy;
218 /* Start position of the code to be executed and the argument passed
219 to the function. */
220 void *(*start_routine) (void *);
221 void *arg;
223 /* Debug state. */
224 td_eventbuf_t eventbuf;
225 /* Next descriptor with a pending event. */
226 struct pthread *nextevent;
228 #ifdef HAVE_FORCED_UNWIND
229 /* Machine-specific unwind info. */
230 struct _Unwind_Exception exc;
231 #endif
233 /* If nonzero pointer to area allocated for the stack and its
234 size. */
235 void *stackblock;
236 size_t stackblock_size;
237 /* Size of the included guard area. */
238 size_t guardsize;
239 /* This is what the user specified and what we will report. */
240 size_t reported_guardsize;
242 /* Resolver state. */
243 struct __res_state res;
244 } __attribute ((aligned (TCB_ALIGNMENT)));
247 #endif /* descr.h */