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