Add definition of struct pthread_key_struct and destr_function.
[kopensolaris-gnu/glibc.git] / linuxthreads / internals.h
1 /* Linuxthreads - a simple clone()-based implementation of Posix        */
2 /* threads for Linux.                                                   */
3 /* Copyright (C) 1996 Xavier Leroy (Xavier.Leroy@inria.fr)              */
4 /*                                                                      */
5 /* This program is free software; you can redistribute it and/or        */
6 /* modify it under the terms of the GNU Library General Public License  */
7 /* as published by the Free Software Foundation; either version 2       */
8 /* of the License, or (at your option) any later version.               */
9 /*                                                                      */
10 /* This program 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        */
13 /* GNU Library General Public License for more details.                 */
14
15 /* Internal data structures */
16
17 /* Includes */
18
19 #include <limits.h>
20 #include <setjmp.h>
21 #include <signal.h>
22 #include <unistd.h>
23 #include <sys/types.h>
24 #include <bits/libc-tsd.h> /* for _LIBC_TSD_KEY_N */
25
26 #include "pt-machine.h"
27
28 #ifndef THREAD_GETMEM
29 # define THREAD_GETMEM(descr, member) descr->member
30 #endif
31 #ifndef THREAD_GETMEM_NC
32 # define THREAD_GETMEM_NC(descr, member) descr->member
33 #endif
34 #ifndef THREAD_SETMEM
35 # define THREAD_SETMEM(descr, member, value) descr->member = (value)
36 #endif
37 #ifndef THREAD_SETMEM_NC
38 # define THREAD_SETMEM_NC(descr, member, value) descr->member = (value)
39 #endif
40
41 /* Arguments passed to thread creation routine */
42
43 struct pthread_start_args {
44   void * (*start_routine)(void *); /* function to run */
45   void * arg;                   /* its argument */
46   sigset_t mask;                /* initial signal mask for thread */
47   int schedpolicy;              /* initial scheduling policy (if any) */
48   struct sched_param schedparam; /* initial scheduling parameters (if any) */
49 };
50
51
52 /* We keep thread specific data in a special data structure, a two-level
53    array.  The top-level array contains pointers to dynamically allocated
54    arrays of a certain number of data pointers.  So we can implement a
55    sparse array.  Each dynamic second-level array has
56         PTHREAD_KEY_2NDLEVEL_SIZE
57    entries.  This value shouldn't be too large.  */
58 #define PTHREAD_KEY_2NDLEVEL_SIZE       32
59
60 /* We need to address PTHREAD_KEYS_MAX key with PTHREAD_KEY_2NDLEVEL_SIZE
61    keys in each subarray.  */
62 #define PTHREAD_KEY_1STLEVEL_SIZE \
63   ((PTHREAD_KEYS_MAX + PTHREAD_KEY_2NDLEVEL_SIZE - 1) \
64    / PTHREAD_KEY_2NDLEVEL_SIZE)
65
66 typedef void (*destr_function)(void *);
67
68 struct pthread_key_struct {
69   int in_use;                   /* already allocated? */
70   destr_function destr;         /* destruction routine */
71 };
72
73
74 #define PTHREAD_START_ARGS_INITIALIZER { NULL, NULL, {{0, }}, 0, { 0 } }
75
76 /* The type of thread descriptors */
77
78 typedef struct _pthread_descr_struct * pthread_descr;
79
80 struct _pthread_descr_struct {
81   pthread_descr p_nextlive, p_prevlive;
82                                 /* Double chaining of active threads */
83   pthread_descr p_nextwaiting;  /* Next element in the queue holding the thr */
84   pthread_descr p_nextlock;     /* can be on a queue and waiting on a lock */
85   pthread_t p_tid;              /* Thread identifier */
86   int p_pid;                    /* PID of Unix process */
87   int p_priority;               /* Thread priority (== 0 if not realtime) */
88   struct _pthread_fastlock * p_lock; /* Spinlock for synchronized accesses */
89   int p_signal;                 /* last signal received */
90   sigjmp_buf * p_signal_jmp;    /* where to siglongjmp on a signal or NULL */
91   sigjmp_buf * p_cancel_jmp;    /* where to siglongjmp on a cancel or NULL */
92   char p_terminated;            /* true if terminated e.g. by pthread_exit */
93   char p_detached;              /* true if detached */
94   char p_exited;                /* true if the assoc. process terminated */
95   void * p_retval;              /* placeholder for return value */
96   int p_retcode;                /* placeholder for return code */
97   pthread_descr p_joining;      /* thread joining on that thread or NULL */
98   struct _pthread_cleanup_buffer * p_cleanup; /* cleanup functions */
99   char p_cancelstate;           /* cancellation state */
100   char p_canceltype;            /* cancellation type (deferred/async) */
101   char p_canceled;              /* cancellation request pending */
102   int * p_errnop;               /* pointer to used errno variable */
103   int p_errno;                  /* error returned by last system call */
104   int * p_h_errnop;             /* pointer to used h_errno variable */
105   int p_h_errno;                /* error returned by last netdb function */
106   char * p_in_sighandler;       /* stack address of sighandler, or NULL */
107   char p_sigwaiting;            /* true if a sigwait() is in progress */
108   struct pthread_start_args p_start_args; /* arguments for thread creation */
109   void ** p_specific[PTHREAD_KEY_1STLEVEL_SIZE]; /* thread-specific data */
110   void * p_libc_specific[_LIBC_TSD_KEY_N]; /* thread-specific data for libc */
111   int p_userstack;              /* nonzero if the user provided the stack */
112   void *p_guardaddr;            /* address of guard area or NULL */
113   size_t p_guardsize;           /* size of guard area */
114   pthread_descr p_self;         /* Pointer to this structure */
115   int p_nr;                     /* Index of descriptor in __pthread_handles */
116 } __attribute__ ((aligned(32))); /* We need to align the structure so that
117                                     doubles are aligned properly.  This is 8
118                                     bytes on MIPS and 16 bytes on MIPS64.
119                                     32 bytes might give better cache
120                                     utilization.  */
121
122
123 /* The type of thread handles. */
124
125 typedef struct pthread_handle_struct * pthread_handle;
126
127 struct pthread_handle_struct {
128   struct _pthread_fastlock h_lock; /* Fast lock for sychronized access */
129   pthread_descr h_descr;        /* Thread descriptor or NULL if invalid */
130   char * h_bottom;              /* Lowest address in the stack thread */
131 };
132
133 /* The type of messages sent to the thread manager thread */
134
135 struct pthread_request {
136   pthread_descr req_thread;     /* Thread doing the request */
137   enum {                        /* Request kind */
138     REQ_CREATE, REQ_FREE, REQ_PROCESS_EXIT, REQ_MAIN_THREAD_EXIT,
139     REQ_POST, REQ_DEBUG
140   } req_kind;
141   union {                       /* Arguments for request */
142     struct {                    /* For REQ_CREATE: */
143       const pthread_attr_t * attr; /* thread attributes */
144       void * (*fn)(void *);     /*   start function */
145       void * arg;               /*   argument to start function */
146       sigset_t mask;            /*   signal mask */
147     } create;
148     struct {                    /* For REQ_FREE: */
149       pthread_t thread_id;      /*   identifier of thread to free */
150     } free;
151     struct {                    /* For REQ_PROCESS_EXIT: */
152       int code;                 /*   exit status */
153     } exit;
154     void * post;                /* For REQ_POST: the semaphore */
155   } req_args;
156 };
157
158
159 /* Signals used for suspend/restart and for cancellation notification.  */
160
161 extern int __pthread_sig_restart;
162 extern int __pthread_sig_cancel;
163
164 /* Signal used for interfacing with gdb */
165
166 extern int __pthread_sig_debug;
167
168 /* Global array of thread handles, used for validating a thread id
169    and retrieving the corresponding thread descriptor. Also used for
170    mapping the available stack segments. */
171
172 extern struct pthread_handle_struct __pthread_handles[PTHREAD_THREADS_MAX];
173
174 /* Descriptor of the initial thread */
175
176 extern struct _pthread_descr_struct __pthread_initial_thread;
177
178 /* Descriptor of the manager thread */
179
180 extern struct _pthread_descr_struct __pthread_manager_thread;
181
182 /* Descriptor of the main thread */
183
184 extern pthread_descr __pthread_main_thread;
185
186 /* Limit between the stack of the initial thread (above) and the
187    stacks of other threads (below). Aligned on a STACK_SIZE boundary.
188    Initially 0, meaning that the current thread is (by definition)
189    the initial thread. */
190
191 extern char *__pthread_initial_thread_bos;
192
193 /* Indicate whether at least one thread has a user-defined stack (if 1),
194    or all threads have stacks supplied by LinuxThreads (if 0). */
195
196 extern int __pthread_nonstandard_stacks;
197
198 /* File descriptor for sending requests to the thread manager.
199    Initially -1, meaning that __pthread_initialize_manager must be called. */
200
201 extern int __pthread_manager_request;
202
203 /* Other end of the pipe for sending requests to the thread manager. */
204
205 extern int __pthread_manager_reader;
206
207 /* Limits of the thread manager stack. */
208
209 extern char *__pthread_manager_thread_bos;
210 extern char *__pthread_manager_thread_tos;
211
212 /* Pending request for a process-wide exit */
213
214 extern int __pthread_exit_requested, __pthread_exit_code;
215
216 /* Set to 1 by gdb if we're debugging */
217
218 extern volatile int __pthread_threads_debug;
219
220 /* Return the handle corresponding to a thread id */
221
222 static inline pthread_handle thread_handle(pthread_t id)
223 {
224   return &__pthread_handles[id % PTHREAD_THREADS_MAX];
225 }
226
227 /* Validate a thread handle. Must have acquired h->h_spinlock before. */
228
229 static inline int invalid_handle(pthread_handle h, pthread_t id)
230 {
231   return h->h_descr == NULL || h->h_descr->p_tid != id;
232 }
233
234 /* Fill in defaults left unspecified by pt-machine.h.  */
235
236 /* The page size we can get from the system.  This should likely not be
237    changed by the machine file but, you never know.  */
238 #ifndef PAGE_SIZE
239 #define PAGE_SIZE  (sysconf (_SC_PAGE_SIZE))
240 #endif
241
242 /* The max size of the thread stack segments.  If the default
243    THREAD_SELF implementation is used, this must be a power of two and
244    a multiple of PAGE_SIZE.  */
245 #ifndef STACK_SIZE
246 #define STACK_SIZE  (2 * 1024 * 1024)
247 #endif
248
249 /* The initial size of the thread stack.  Must be a multiple of PAGE_SIZE.  */
250 #ifndef INITIAL_STACK_SIZE
251 #define INITIAL_STACK_SIZE  (4 * PAGE_SIZE)
252 #endif
253
254 /* Size of the thread manager stack. The "- 32" avoids wasting space
255    with some malloc() implementations. */
256 #ifndef THREAD_MANAGER_STACK_SIZE
257 #define THREAD_MANAGER_STACK_SIZE  (2 * PAGE_SIZE - 32)
258 #endif
259
260 /* The base of the "array" of thread stacks.  The array will grow down from
261    here.  Defaults to the calculated bottom of the initial application
262    stack.  */
263 #ifndef THREAD_STACK_START_ADDRESS
264 #define THREAD_STACK_START_ADDRESS  __pthread_initial_thread_bos
265 #endif
266
267 /* Get some notion of the current stack.  Need not be exactly the top
268    of the stack, just something somewhere in the current frame.  */
269 #ifndef CURRENT_STACK_FRAME
270 #define CURRENT_STACK_FRAME  ({ char __csf; &__csf; })
271 #endif
272
273 /* Recover thread descriptor for the current thread */
274
275 extern pthread_descr __pthread_find_self (void) __attribute__ ((const));
276
277 static inline pthread_descr thread_self (void) __attribute__ ((const));
278 static inline pthread_descr thread_self (void)
279 {
280 #ifdef THREAD_SELF
281   return THREAD_SELF;
282 #else
283   char *sp = CURRENT_STACK_FRAME;
284   if (sp >= __pthread_initial_thread_bos)
285     return &__pthread_initial_thread;
286   else if (sp >= __pthread_manager_thread_bos
287            && sp < __pthread_manager_thread_tos)
288     return &__pthread_manager_thread;
289   else if (__pthread_nonstandard_stacks)
290     return __pthread_find_self();
291   else
292     return (pthread_descr)(((unsigned long)sp | (STACK_SIZE-1))+1) - 1;
293 #endif
294 }
295
296 /* Max number of times we must spin on a spinlock calling sched_yield().
297    After MAX_SPIN_COUNT iterations, we put the calling thread to sleep. */
298
299 #ifndef MAX_SPIN_COUNT
300 #define MAX_SPIN_COUNT 50
301 #endif
302
303 /* Duration of sleep (in nanoseconds) when we can't acquire a spinlock
304    after MAX_SPIN_COUNT iterations of sched_yield().
305    With the 2.0 and 2.1 kernels, this MUST BE > 2ms.
306    (Otherwise the kernel does busy-waiting for realtime threads,
307     giving other threads no chance to run.) */
308
309 #ifndef SPIN_SLEEP_DURATION
310 #define SPIN_SLEEP_DURATION 2000001
311 #endif
312
313 /* Debugging */
314
315 #ifdef DEBUG
316 #include <assert.h>
317 #define ASSERT assert
318 #define MSG __pthread_message
319 #else
320 #define ASSERT(x)
321 #define MSG(msg,arg...)
322 #endif
323
324 /* Internal global functions */
325
326 void __pthread_destroy_specifics(void);
327 void __pthread_perform_cleanup(void);
328 int __pthread_initialize_manager(void);
329 void __pthread_message(char * fmt, ...);
330 int __pthread_manager(void *reqfd);
331 void __pthread_manager_sighandler(int sig);
332 void __pthread_reset_main_thread(void);
333 void __fresetlockfiles(void);
334 void __pthread_manager_adjust_prio(int thread_prio);
335
336 extern int __pthread_attr_setguardsize __P ((pthread_attr_t *__attr,
337                                              size_t __guardsize));
338 extern int __pthread_attr_getguardsize __P ((__const pthread_attr_t *__attr,
339                                              size_t *__guardsize));
340 extern int __pthread_attr_setstackaddr __P ((pthread_attr_t *__attr,
341                                              void *__stackaddr));
342 extern int __pthread_attr_getstackaddr __P ((__const pthread_attr_t *__attr,
343                                              void **__stackaddr));
344 extern int __pthread_attr_setstacksize __P ((pthread_attr_t *__attr,
345                                              size_t __stacksize));
346 extern int __pthread_attr_getstacksize __P ((__const pthread_attr_t *__attr,
347                                              size_t *__stacksize));
348 extern int __pthread_getconcurrency __P ((void));
349 extern int __pthread_setconcurrency __P ((int __level));
350 extern int __pthread_mutexattr_gettype __P ((__const pthread_mutexattr_t *__attr,
351                                              int *__kind));
352 extern void __pthread_kill_other_threads_np __P ((void));
353
354 /* Prototypes for the function without cancelation support when the
355    normal version has it.  */
356 extern int __libc_close (int fd);
357 extern int __libc_nanosleep (const struct timespec *requested_time,
358                              struct timespec *remaining);
359 extern int __libc_read (int fd, void *buf, size_t count);
360 extern pid_t __libc_waitpid (pid_t pid, int *stat_loc, int options);
361 extern int __libc_write (int fd, const void *buf, size_t count);