209812c3da1b96553a1288805941f1847346fe25
[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 <unistd.h>
24 #include <stackinfo.h>
25
26 #include <tls.h>
27 #include "descr.h"
28
29 extern long int testandset (int *spinlock);
30 extern int __compare_and_swap (long int *p, long int oldval, long int newval);
31
32 #include "semaphore.h"
33
34 #ifndef THREAD_GETMEM
35 # define THREAD_GETMEM(descr, member) descr->member
36 #endif
37 #ifndef THREAD_GETMEM_NC
38 # define THREAD_GETMEM_NC(descr, member) descr->member
39 #endif
40 #ifndef THREAD_SETMEM
41 # define THREAD_SETMEM(descr, member, value) descr->member = (value)
42 #endif
43 #ifndef THREAD_SETMEM_NC
44 # define THREAD_SETMEM_NC(descr, member, value) descr->member = (value)
45 #endif
46
47 typedef void (*destr_function)(void *);
48
49 struct pthread_key_struct {
50   int in_use;                   /* already allocated? */
51   destr_function destr;         /* destruction routine */
52 };
53
54
55 #define PTHREAD_START_ARGS_INITIALIZER(fct) \
56   { (void *(*) (void *)) fct, NULL, {{0, }}, 0, { 0 } }
57
58
59 /* The type of thread handles. */
60
61 typedef struct pthread_handle_struct * pthread_handle;
62
63 struct pthread_handle_struct {
64   struct _pthread_fastlock h_lock; /* Fast lock for sychronized access */
65   pthread_descr h_descr;        /* Thread descriptor or NULL if invalid */
66   char * h_bottom;              /* Lowest address in the stack thread */
67 };
68
69 /* The type of messages sent to the thread manager thread */
70
71 struct pthread_request {
72   pthread_descr req_thread;     /* Thread doing the request */
73   enum {                        /* Request kind */
74     REQ_CREATE, REQ_FREE, REQ_PROCESS_EXIT, REQ_MAIN_THREAD_EXIT,
75     REQ_POST, REQ_DEBUG, REQ_KICK, REQ_FOR_EACH_THREAD
76   } req_kind;
77   union {                       /* Arguments for request */
78     struct {                    /* For REQ_CREATE: */
79       const pthread_attr_t * attr; /* thread attributes */
80       void * (*fn)(void *);     /*   start function */
81       void * arg;               /*   argument to start function */
82       sigset_t mask;            /*   signal mask */
83     } create;
84     struct {                    /* For REQ_FREE: */
85       pthread_t thread_id;      /*   identifier of thread to free */
86     } free;
87     struct {                    /* For REQ_PROCESS_EXIT: */
88       int code;                 /*   exit status */
89     } exit;
90     void * post;                /* For REQ_POST: the semaphore */
91     struct {                    /* For REQ_FOR_EACH_THREAD: callback */
92       void (*fn)(void *, pthread_descr);
93       void *arg;
94     } for_each;
95   } req_args;
96 };
97
98
99 /* Signals used for suspend/restart and for cancellation notification.  */
100
101 extern int __pthread_sig_restart;
102 extern int __pthread_sig_cancel;
103
104 /* Signal used for interfacing with gdb */
105
106 extern int __pthread_sig_debug;
107
108 /* Global array of thread handles, used for validating a thread id
109    and retrieving the corresponding thread descriptor. Also used for
110    mapping the available stack segments. */
111
112 extern struct pthread_handle_struct __pthread_handles[PTHREAD_THREADS_MAX];
113
114 /* Descriptor of the main thread */
115
116 extern pthread_descr __pthread_main_thread;
117
118 /* File descriptor for sending requests to the thread manager.
119    Initially -1, meaning that __pthread_initialize_manager must be called. */
120
121 extern int __pthread_manager_request;
122
123 /* Other end of the pipe for sending requests to the thread manager. */
124
125 extern int __pthread_manager_reader;
126
127 #ifdef FLOATING_STACKS
128 /* Maximum stack size.  */
129 extern size_t __pthread_max_stacksize;
130 #endif
131
132 /* Pending request for a process-wide exit */
133
134 extern int __pthread_exit_requested, __pthread_exit_code;
135
136 /* Set to 1 by gdb if we're debugging */
137
138 extern volatile int __pthread_threads_debug;
139
140 /* Globally enabled events.  */
141 extern volatile td_thr_events_t __pthread_threads_events;
142
143 /* Pointer to descriptor of thread with last event.  */
144 extern volatile pthread_descr __pthread_last_event;
145
146 /* Flag which tells whether we are executing on SMP kernel. */
147 extern int __pthread_smp_kernel;
148
149 /* Return the handle corresponding to a thread id */
150
151 static inline pthread_handle thread_handle(pthread_t id)
152 {
153   return &__pthread_handles[id % PTHREAD_THREADS_MAX];
154 }
155
156 /* Validate a thread handle. Must have acquired h->h_spinlock before. */
157
158 static inline int invalid_handle(pthread_handle h, pthread_t id)
159 {
160   return h->h_descr == NULL || h->h_descr->p_tid != id || h->h_descr->p_terminated;
161 }
162
163 static inline int nonexisting_handle(pthread_handle h, pthread_t id)
164 {
165   return h->h_descr == NULL || h->h_descr->p_tid != id;
166 }
167
168 /* Fill in defaults left unspecified by pt-machine.h.  */
169
170 /* We round up a value with page size. */
171 #ifndef page_roundup
172 #define page_roundup(v,p) ((((size_t) (v)) + (p) - 1) & ~((p) - 1))
173 #endif
174
175 /* The page size we can get from the system.  This should likely not be
176    changed by the machine file but, you never know.  */
177 #ifndef PAGE_SIZE
178 #define PAGE_SIZE  (sysconf (_SC_PAGE_SIZE))
179 #endif
180
181 /* The initial size of the thread stack.  Must be a multiple of PAGE_SIZE.  */
182 #ifndef INITIAL_STACK_SIZE
183 #define INITIAL_STACK_SIZE  (4 * PAGE_SIZE)
184 #endif
185
186 /* Size of the thread manager stack. The "- 32" avoids wasting space
187    with some malloc() implementations. */
188 #ifndef THREAD_MANAGER_STACK_SIZE
189 #define THREAD_MANAGER_STACK_SIZE  (2 * PAGE_SIZE - 32)
190 #endif
191
192 /* The base of the "array" of thread stacks.  The array will grow down from
193    here.  Defaults to the calculated bottom of the initial application
194    stack.  */
195 #ifndef THREAD_STACK_START_ADDRESS
196 #define THREAD_STACK_START_ADDRESS  __pthread_initial_thread_bos
197 #endif
198
199 /* If MEMORY_BARRIER isn't defined in pt-machine.h, assume the architecture
200    doesn't need a memory barrier instruction (e.g. Intel x86).  Some
201    architectures distinguish between full, read and write barriers.  */
202
203 #ifndef MEMORY_BARRIER
204 #define MEMORY_BARRIER()
205 #endif
206 #ifndef READ_MEMORY_BARRIER
207 #define READ_MEMORY_BARRIER() MEMORY_BARRIER()
208 #endif
209 #ifndef WRITE_MEMORY_BARRIER
210 #define WRITE_MEMORY_BARRIER() MEMORY_BARRIER()
211 #endif
212
213 /* Max number of times we must spin on a spinlock calling sched_yield().
214    After MAX_SPIN_COUNT iterations, we put the calling thread to sleep. */
215
216 #ifndef MAX_SPIN_COUNT
217 #define MAX_SPIN_COUNT 50
218 #endif
219
220 /* Max number of times the spinlock in the adaptive mutex implementation
221    spins actively on SMP systems.  */
222
223 #ifndef MAX_ADAPTIVE_SPIN_COUNT
224 #define MAX_ADAPTIVE_SPIN_COUNT 100
225 #endif
226
227 /* Duration of sleep (in nanoseconds) when we can't acquire a spinlock
228    after MAX_SPIN_COUNT iterations of sched_yield().
229    With the 2.0 and 2.1 kernels, this MUST BE > 2ms.
230    (Otherwise the kernel does busy-waiting for realtime threads,
231     giving other threads no chance to run.) */
232
233 #ifndef SPIN_SLEEP_DURATION
234 #define SPIN_SLEEP_DURATION 2000001
235 #endif
236
237 /* Debugging */
238
239 #ifdef DEBUG
240 #include <assert.h>
241 #define ASSERT assert
242 #define MSG __pthread_message
243 #else
244 #define ASSERT(x)
245 #define MSG(msg,arg...)
246 #endif
247
248 /* Internal global functions */
249
250 extern void __pthread_do_exit (void *retval, char *currentframe)
251      __attribute__ ((__noreturn__));
252 extern void __pthread_destroy_specifics (void);
253 extern void __pthread_perform_cleanup (char *currentframe);
254 extern void __pthread_init_max_stacksize (void);
255 extern int __pthread_initialize_manager (void);
256 extern void __pthread_message (char * fmt, ...);
257 extern int __pthread_manager (void *reqfd);
258 extern int __pthread_manager_event (void *reqfd);
259 extern void __pthread_manager_sighandler (int sig);
260 extern void __pthread_reset_main_thread (void);
261 extern void __pthread_once_fork_prepare (void);
262 extern void __pthread_once_fork_parent (void);
263 extern void __pthread_once_fork_child (void);
264 extern void __flockfilelist (void);
265 extern void __funlockfilelist (void);
266 extern void __fresetlockfiles (void);
267 extern void __pthread_manager_adjust_prio (int thread_prio);
268 extern void __pthread_initialize_minimal (void);
269
270 extern int __pthread_attr_setguardsize (pthread_attr_t *__attr,
271                                         size_t __guardsize);
272 extern int __pthread_attr_getguardsize (const pthread_attr_t *__attr,
273                                         size_t *__guardsize);
274 extern int __pthread_attr_setstackaddr (pthread_attr_t *__attr,
275                                         void *__stackaddr);
276 extern int __pthread_attr_getstackaddr (const pthread_attr_t *__attr,
277                                         void **__stackaddr);
278 extern int __pthread_attr_setstacksize (pthread_attr_t *__attr,
279                                         size_t __stacksize);
280 extern int __pthread_attr_getstacksize (const pthread_attr_t *__attr,
281                                         size_t *__stacksize);
282 extern int __pthread_attr_setstack (pthread_attr_t *__attr, void *__stackaddr,
283                                     size_t __stacksize);
284 extern int __pthread_attr_getstack (const pthread_attr_t *__attr, void **__stackaddr,
285                                     size_t *__stacksize);
286 extern int __pthread_getconcurrency (void);
287 extern int __pthread_setconcurrency (int __level);
288 extern int __pthread_mutex_timedlock (pthread_mutex_t *__mutex,
289                                       const struct timespec *__abstime);
290 extern int __pthread_mutexattr_getpshared (const pthread_mutexattr_t *__attr,
291                                            int *__pshared);
292 extern int __pthread_mutexattr_setpshared (pthread_mutexattr_t *__attr,
293                                            int __pshared);
294 extern int __pthread_mutexattr_gettype (const pthread_mutexattr_t *__attr,
295                                         int *__kind);
296 extern void __pthread_kill_other_threads_np (void);
297
298 extern void __pthread_restart_old(pthread_descr th);
299 extern void __pthread_suspend_old(pthread_descr self);
300 extern int __pthread_timedsuspend_old(pthread_descr self, const struct timespec *abs);
301
302 extern void __pthread_restart_new(pthread_descr th);
303 extern void __pthread_suspend_new(pthread_descr self);
304 extern int __pthread_timedsuspend_new(pthread_descr self, const struct timespec *abs);
305
306 extern void __pthread_wait_for_restart_signal(pthread_descr self);
307
308 extern int __pthread_yield (void);
309
310 extern int __pthread_rwlock_timedrdlock (pthread_rwlock_t *__restrict __rwlock,
311                                          __const struct timespec *__restrict
312                                          __abstime);
313 extern int __pthread_rwlock_timedwrlock (pthread_rwlock_t *__restrict __rwlock,
314                                          __const struct timespec *__restrict
315                                          __abstime);
316 extern int __pthread_rwlockattr_destroy (pthread_rwlockattr_t *__attr);
317
318 extern int __pthread_barrierattr_getpshared (__const pthread_barrierattr_t *
319                                              __restrict __attr,
320                                              int *__restrict __pshared);
321
322 extern int __pthread_spin_lock (pthread_spinlock_t *__lock);
323 extern int __pthread_spin_trylock (pthread_spinlock_t *__lock);
324 extern int __pthread_spin_unlock (pthread_spinlock_t *__lock);
325 extern int __pthread_spin_init (pthread_spinlock_t *__lock, int __pshared);
326 extern int __pthread_spin_destroy (pthread_spinlock_t *__lock);
327
328 extern int __pthread_clock_gettime (hp_timing_t freq, struct timespec *tp);
329 extern void __pthread_clock_settime (hp_timing_t offset);
330
331
332 /* Global pointers to old or new suspend functions */
333
334 extern void (*__pthread_restart)(pthread_descr);
335 extern void (*__pthread_suspend)(pthread_descr);
336 extern int (*__pthread_timedsuspend)(pthread_descr, const struct timespec *);
337
338 /* Prototypes for the function without cancelation support when the
339    normal version has it.  */
340 extern int __libc_close (int fd);
341 extern int __libc_nanosleep (const struct timespec *requested_time,
342                              struct timespec *remaining);
343 /* Prototypes for some of the new semaphore functions.  */
344 extern int __new_sem_post (sem_t * sem);
345 extern int __new_sem_init (sem_t *__sem, int __pshared, unsigned int __value);
346 extern int __new_sem_wait (sem_t *__sem);
347 extern int __new_sem_trywait (sem_t *__sem);
348 extern int __new_sem_getvalue (sem_t *__restrict __sem, int *__restrict __sval);
349 extern int __new_sem_destroy (sem_t *__sem);
350
351 /* Prototypes for compatibility functions.  */
352 extern int __pthread_attr_init_2_1 (pthread_attr_t *__attr);
353 extern int __pthread_attr_init_2_0 (pthread_attr_t *__attr);
354 extern int __pthread_create_2_1 (pthread_t *__restrict __thread,
355                                  const pthread_attr_t *__attr,
356                                  void *(*__start_routine) (void *),
357                                  void *__restrict __arg);
358 extern int __pthread_create_2_0 (pthread_t *__restrict thread,
359                                  const pthread_attr_t *__attr,
360                                  void *(*__start_routine) (void *),
361                                  void *__restrict arg);
362
363 /* The functions called the signal events.  */
364 extern void __linuxthreads_create_event (void);
365 extern void __linuxthreads_death_event (void);
366 extern void __linuxthreads_reap_event (void);
367
368 /* This function is called to initialize the pthread library.  */
369 extern void __pthread_initialize (void);
370
371 #endif /* internals.h */