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