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