LinuxThreads library.
[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   int * p_spinlock;             /* 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   struct pthread_start_args p_start_args; /* arguments for thread creation */
85   void ** p_specific[PTHREAD_KEY_1STLEVEL_SIZE]; /* thread-specific data */
86   void * p_libc_specific[_LIBC_TSD_KEY_N]; /* thread-specific data for libc */
87 };
88
89 /* The type of thread handles. */
90
91 typedef struct pthread_handle_struct * pthread_handle;
92
93 struct pthread_handle_struct {
94   int h_spinlock;               /* Spinlock for sychronized access */
95   pthread_descr h_descr;        /* Thread descriptor or NULL if invalid */
96 };
97
98 /* The type of messages sent to the thread manager thread */
99
100 struct pthread_request {
101   pthread_descr req_thread;     /* Thread doing the request */
102   enum {                        /* Request kind */
103     REQ_CREATE, REQ_FREE, REQ_PROCESS_EXIT, REQ_MAIN_THREAD_EXIT
104   } req_kind;
105   union {                       /* Arguments for request */
106     struct {                    /* For REQ_CREATE: */
107       const pthread_attr_t * attr; /* thread attributes */
108       void * (*fn)(void *);     /*   start function */
109       void * arg;               /*   argument to start function */
110       sigset_t mask;            /*   signal mask */
111     } create;
112     struct {                    /* For REQ_FREE: */
113       pthread_descr thread;     /*   descriptor of thread to free */
114     } free;
115     struct {                    /* For REQ_PROCESS_EXIT: */
116       int code;                 /*   exit status */
117     } exit;
118   } req_args;
119 };
120
121
122 /* Signals used for suspend/restart and for cancellation notification.  */
123
124 #ifdef SIGRTMIN
125 /* The have real-time signals.  */
126 extern int __pthread_sig_restart;
127 extern int __pthread_sig_cancel;
128 # define PTHREAD_SIG_RESTART __pthread_sig_restart
129 # define PTHREAD_SIG_CANCEL __pthread_sig_cancel
130 #else
131 # define PTHREAD_SIG_RESTART SIGUSR1
132 # define PTHREAD_SIG_CANCEL SIGUSR2
133 #endif
134
135 /* Global array of thread handles, used for validating a thread id
136    and retrieving the corresponding thread descriptor. Also used for
137    mapping the available stack segments. */
138
139 extern struct pthread_handle_struct __pthread_handles[PTHREAD_THREADS_MAX];
140
141 /* Descriptor of the initial thread */
142
143 extern struct _pthread_descr_struct __pthread_initial_thread;
144
145 /* Descriptor of the manager thread */
146
147 extern struct _pthread_descr_struct __pthread_manager_thread;
148
149 /* Descriptor of the main thread */
150
151 extern pthread_descr __pthread_main_thread;
152
153 /* Limit between the stack of the initial thread (above) and the
154    stacks of other threads (below). Aligned on a STACK_SIZE boundary.
155    Initially 0, meaning that the current thread is (by definition)
156    the initial thread. */
157
158 extern char *__pthread_initial_thread_bos;
159
160 /* File descriptor for sending requests to the thread manager.
161    Initially -1, meaning that pthread_initialize must be called. */
162
163 extern int __pthread_manager_request;
164
165 /* Other end of the pipe for sending requests to the thread manager. */
166
167 extern int __pthread_manager_reader;
168
169 /* Limits of the thread manager stack. */
170
171 extern char *__pthread_manager_thread_bos;
172 extern char *__pthread_manager_thread_tos;
173
174 /* Pending request for a process-wide exit */
175
176 extern int __pthread_exit_requested, __pthread_exit_code;
177
178 /* Return the handle corresponding to a thread id */
179
180 static inline pthread_handle thread_handle(pthread_t id)
181 {
182   return &__pthread_handles[id % PTHREAD_THREADS_MAX];
183 }
184
185 /* Validate a thread handle. Must have acquired h->h_spinlock before. */
186
187 static inline int invalid_handle(pthread_handle h, pthread_t id)
188 {
189   return h->h_descr == NULL || h->h_descr->p_tid != id;
190 }
191
192 /* Fill in defaults left unspecified by pt-machine.h.  */
193
194 /* The page size we can get from the system.  This should likely not be
195    changed by the machine file but, you never know.  */
196 #ifndef PAGE_SIZE
197 #define PAGE_SIZE  (sysconf (_SC_PAGE_SIZE))
198 #endif
199
200 /* The max size of the thread stack segments.  If the default
201    THREAD_SELF implementation is used, this must be a power of two and
202    a multiple of PAGE_SIZE.  */
203 #ifndef STACK_SIZE
204 #define STACK_SIZE  (2 * 1024 * 1024)
205 #endif
206
207 /* The initial size of the thread stack.  Must be a multiple of PAGE_SIZE.  */
208 #ifndef INITIAL_STACK_SIZE
209 #define INITIAL_STACK_SIZE  (4 * PAGE_SIZE)
210 #endif
211
212 /* Size of the thread manager stack. The "- 32" avoids wasting space
213    with some malloc() implementations. */
214 #ifndef THREAD_MANAGER_STACK_SIZE
215 #define THREAD_MANAGER_STACK_SIZE  (2 * PAGE_SIZE - 32)
216 #endif
217
218 /* The base of the "array" of thread stacks.  The array will grow down from
219    here.  Defaults to the calculated bottom of the initial application
220    stack.  */
221 #ifndef THREAD_STACK_START_ADDRESS
222 #define THREAD_STACK_START_ADDRESS  __pthread_initial_thread_bos
223 #endif
224
225 /* Get some notion of the current stack.  Need not be exactly the top
226    of the stack, just something somewhere in the current frame.  */
227 #ifndef CURRENT_STACK_FRAME
228 #define CURRENT_STACK_FRAME  ({ char __csf; &__csf; })
229 #endif
230
231 /* Recover thread descriptor for the current thread */
232
233 static inline pthread_descr thread_self (void) __attribute__ ((const));
234 static inline pthread_descr thread_self (void)
235 {
236 #ifdef THREAD_SELF
237   return THREAD_SELF;
238 #else
239   char *sp = CURRENT_STACK_FRAME;
240   if (sp >= __pthread_initial_thread_bos)
241     return &__pthread_initial_thread;
242   else if (sp >= __pthread_manager_thread_bos
243            && sp < __pthread_manager_thread_tos)
244     return &__pthread_manager_thread;
245   else
246     return (pthread_descr)(((unsigned long)sp | (STACK_SIZE-1))+1) - 1;
247 #endif
248 }
249
250 /* Debugging */
251
252 #ifdef DEBUG
253 #include <assert.h>
254 #define ASSERT assert
255 #define MSG __pthread_message
256 #else
257 #define ASSERT(x)
258 #define MSG(msg,arg...)
259 #endif
260
261 /* Internal global functions */
262
263 void __pthread_destroy_specifics(void);
264 void __pthread_perform_cleanup(void);
265 void __pthread_sighandler(int sig);
266 void __pthread_message(char * fmt, long arg, ...);
267 int __pthread_manager(void *reqfd);
268 void __pthread_manager_sighandler(int sig);
269 void __pthread_reset_main_thread(void);
270 void __fresetlockfiles(void);
271
272
273 /* Prototypes for the function without cancelation support when the
274    normal version has it.  */
275 extern int __libc_close (int fd);
276 extern int __libc_nanosleep (const struct timespec *requested_time,
277                              struct timespec *remaining);
278 extern int __libc_read (int fd, void *buf, size_t count);
279 extern pid_t __libc_waitpid (pid_t pid, int *stat_loc, int options);
280 extern int __libc_write (int fd, const void *buf, size_t count);