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