lib/libc_r/uthread/uthread_init.c

   1 /*
   2  * Copyright (c) 1995-1998 John Birrell <jb@cimlogic.com.au>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by John Birrell.
  16  * 4. Neither the name of the author nor the names of any co-contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  * $FreeBSD: src/lib/libc_r/uthread/uthread_init.c,v 1.23.2.11 2003/02/24 23:27:32 das Exp $
  33  * $DragonFly: src/lib/libc_r/uthread/uthread_init.c,v 1.11 2008/05/25 21:34:49 hasso Exp $
  34  */
  35
  36 /* Allocate space for global thread variables here: */
  37 #define GLOBAL_PTHREAD_PRIVATE
  38
  39 #include <sys/user.h>   /* MUST BE FIRST */
  40 #include <errno.h>
  41 #include <stdlib.h>
  42 #include <string.h>
  43 #include <fcntl.h>
  44 #include <paths.h>
  45 #include <poll.h>
  46 #include <unistd.h>
  47 #include <sys/ioctl.h>
  48 #include <sys/sysctl.h>
  49 #include <sys/time.h>
  50 #include <sys/ttycom.h>
  51 #include <sys/param.h>
  52 #include <sys/mman.h>
  53 #include <machine/reg.h>
  54 #include <pthread.h>
  55 #include "pthread_private.h"
  56
  57 /*
  58  * These are needed when linking statically.  All references within
  59  * libgcc (and in the future libc) to these routines are weak, but
  60  * if they are not (strongly) referenced by the application or other
  61  * libraries, then the actual functions will not be loaded.
  62  */
  63 static void *thread_references[] = {
  64         &_pthread_once,
  65         &_pthread_key_create,
  66         &_pthread_key_delete,
  67         &_pthread_getspecific,
  68         &_pthread_setspecific,
  69         &_pthread_mutex_init,
  70         &_pthread_mutex_destroy,
  71         &_pthread_mutex_lock,
  72         &_pthread_mutex_trylock,
  73         &_pthread_mutex_unlock,
  74         &_pthread_cond_init,
  75         &_pthread_cond_destroy,
  76         &_pthread_cond_wait,
  77         &_pthread_cond_timedwait,
  78         &_pthread_cond_signal,
  79         &_pthread_cond_broadcast
  80 };
  81
  82 #ifdef GCC_2_8_MADE_THREAD_AWARE
  83 typedef void *** (*dynamic_handler_allocator)();
  84 extern void __set_dynamic_handler_allocator(dynamic_handler_allocator);
  85
  86 static pthread_key_t except_head_key;
  87
  88 typedef struct {
  89         void **__dynamic_handler_chain;
  90         void *top_elt[2];
  91 } except_struct;
  92
  93 static void ***dynamic_allocator_handler_fn()
  94 {
  95         except_struct *dh = (except_struct *)pthread_getspecific(except_head_key);
  96
  97         if(dh == NULL) {
  98                 dh = (except_struct *)malloc( sizeof(except_struct) );
  99                 memset(dh, '\0', sizeof(except_struct));
 100                 dh->__dynamic_handler_chain= dh->top_elt;
 101                 pthread_setspecific(except_head_key, (void *)dh);
 102         }
 103         return &dh->__dynamic_handler_chain;
 104 }
 105 #endif /* GCC_2_8_MADE_THREAD_AWARE */
 106
 107 /*
 108  * Threaded process initialization
 109  */
 110
 111 void    _thread_init(void) __attribute__((constructor));
 112
 113 void
 114 _thread_init(void)
 115 {
 116         int             fd;
 117         int             flags;
 118         int             i;
 119         size_t          len;
 120         int             mib[2];
 121         struct clockinfo clockinfo;
 122         struct sigaction act;
 123
 124         /* Check if this function has already been called: */
 125         if (_thread_initial)
 126                 /* Only initialise the threaded application once. */
 127                 return;
 128
 129         /*
 130          * Make gcc quiescent about thread_references not being
 131          * referenced:
 132          */
 133         if (thread_references[0] == NULL)
 134                 PANIC("Mandatory pthread_* functions not loaded");
 135
 136         /*
 137          * Check for the special case of this process running as
 138          * or in place of init as pid = 1:
 139          */
 140         if (getpid() == 1) {
 141                 /*
 142                  * Setup a new session for this process which is
 143                  * assumed to be running as root.
 144                  */
 145                 if (setsid() == -1)
 146                         PANIC("Can't set session ID");
 147                 if (revoke(_PATH_CONSOLE) != 0)
 148                         PANIC("Can't revoke console");
 149                 if ((fd = __sys_open(_PATH_CONSOLE, O_RDWR)) < 0)
 150                         PANIC("Can't open console");
 151                 if (setlogin("root") == -1)
 152                         PANIC("Can't set login to root");
 153                 if (__sys_ioctl(fd, TIOCSCTTY, NULL) == -1)
 154                         PANIC("Can't set controlling terminal");
 155                 if (__sys_dup2(fd, 0) == -1 ||
 156                     __sys_dup2(fd, 1) == -1 ||
 157                     __sys_dup2(fd, 2) == -1)
 158                         PANIC("Can't dup2");
 159         }
 160
 161         /* Get the standard I/O flags before messing with them : */
 162         for (i = 0; i < 3; i++) {
 163                 if (((_pthread_stdio_flags[i] =
 164                     __sys_fcntl(i, F_GETFL, NULL)) == -1) &&
 165                     (errno != EBADF))
 166                         PANIC("Cannot get stdio flags");
 167         }
 168
 169         /*
 170          * Create a pipe that is written to by the signal handler to prevent
 171          * signals being missed in calls to _select:
 172          */
 173         _thread_mksigpipe();
 174
 175         /* Allocate and initialize the ready queue: */
 176         if (_pq_alloc(&_readyq, PTHREAD_MIN_PRIORITY, PTHREAD_LAST_PRIORITY) != 0) {
 177                 /* Abort this application: */
 178                 PANIC("Cannot allocate priority ready queue.");
 179         }
 180         /* Allocate memory for the thread structure of the initial thread: */
 181         else if ((_thread_initial = (pthread_t) malloc(sizeof(struct pthread))) == NULL) {
 182                 /*
 183                  * Insufficient memory to initialise this application, so
 184                  * abort:
 185                  */
 186                 PANIC("Cannot allocate memory for initial thread");
 187         }
 188         /* Allocate memory for the scheduler stack: */
 189         else if ((_thread_kern_sched_stack = malloc(SCHED_STACK_SIZE)) == NULL)
 190                 PANIC("Failed to allocate stack for scheduler");
 191         else {
 192                 /* Zero the global kernel thread structure: */
 193                 memset(&_thread_kern_thread, 0, sizeof(struct pthread));
 194                 _thread_kern_thread.flags = PTHREAD_FLAGS_PRIVATE;
 195                 _thread_kern_thread.tcb = _libc_allocate_tls();
 196                 memset(_thread_initial, 0, sizeof(struct pthread));
 197
 198                 /* Initialize the waiting and work queues: */
 199                 TAILQ_INIT(&_waitingq);
 200                 TAILQ_INIT(&_workq);
 201
 202                 /* Initialize the scheduling switch hook routine: */
 203                 _sched_switch_hook = NULL;
 204
 205                 /* Give this thread default attributes: */
 206                 memcpy((void *) &_thread_initial->attr, &pthread_attr_default,
 207                     sizeof(struct pthread_attr));
 208
 209                 /* Initialize the thread stack cache: */
 210                 SLIST_INIT(&_stackq);
 211
 212                 /* Find the stack top */
 213                 mib[0] = CTL_KERN;
 214                 mib[1] = KERN_USRSTACK;
 215                 len = sizeof (int);
 216                 if (sysctl(mib, 2, &_usrstack, &len, NULL, 0) == -1)
 217                         _usrstack = (void *)USRSTACK;
 218                 _next_stack = _usrstack - PTHREAD_STACK_INITIAL -
 219                     PTHREAD_STACK_DEFAULT - (2 * PTHREAD_STACK_GUARD);
 220                 /*
 221                  * Create a red zone below the main stack.  All other stacks are
 222                  * constrained to a maximum size by the paramters passed to
 223                  * mmap(), but this stack is only limited by resource limits, so
 224                  * this stack needs an explicitly mapped red zone to protect the
 225                  * thread stack that is just beyond.
 226                  */
 227                 if (mmap(_usrstack - PTHREAD_STACK_INITIAL -
 228                     PTHREAD_STACK_GUARD, PTHREAD_STACK_GUARD, 0,
 229                     MAP_ANON | MAP_TRYFIXED, -1, 0) == MAP_FAILED)
 230                         PANIC("Cannot allocate red zone for initial thread");
 231
 232                 _thread_initial->tcb = tls_get_tcb();
 233                 /* Set the main thread stack pointer. */
 234                 _thread_initial->stack = _usrstack - PTHREAD_STACK_INITIAL;
 235
 236                 /* Set the stack attributes: */
 237                 _thread_initial->attr.stackaddr_attr = _thread_initial->stack;
 238                 _thread_initial->attr.stacksize_attr = PTHREAD_STACK_INITIAL;
 239
 240                 /* Setup the context for the scheduler: */
 241                 _setjmp(_thread_kern_sched_jb);
 242                 SET_STACK_JB(_thread_kern_sched_jb, _thread_kern_sched_stack +
 243                     SCHED_STACK_SIZE - sizeof(double));
 244                 SET_RETURN_ADDR_JB(_thread_kern_sched_jb, _thread_kern_scheduler);
 245
 246                 /*
 247                  * Write a magic value to the thread structure
 248                  * to help identify valid ones:
 249                  */
 250                 _thread_initial->magic = PTHREAD_MAGIC;
 251
 252                 /* Set the initial cancel state */
 253                 _thread_initial->cancelflags = PTHREAD_CANCEL_ENABLE |
 254                     PTHREAD_CANCEL_DEFERRED;
 255
 256                 /* Default the priority of the initial thread: */
 257                 _thread_initial->base_priority = PTHREAD_DEFAULT_PRIORITY;
 258                 _thread_initial->active_priority = PTHREAD_DEFAULT_PRIORITY;
 259                 _thread_initial->inherited_priority = 0;
 260
 261                 /* Initialise the state of the initial thread: */
 262                 _thread_initial->state = PS_RUNNING;
 263
 264                 /* Set the name of the thread: */
 265                 _thread_initial->name = strdup("_thread_initial");
 266
 267                 /* Initialize joiner to NULL (no joiner): */
 268                 _thread_initial->joiner = NULL;
 269
 270                 /* Initialize the owned mutex queue and count: */
 271                 TAILQ_INIT(&(_thread_initial->mutexq));
 272                 _thread_initial->priority_mutex_count = 0;
 273
 274                 /* Initialize the global scheduling time: */
 275                 _sched_ticks = 0;
 276                 gettimeofday((struct timeval *) &_sched_tod, NULL);
 277
 278                 /* Initialize last active: */
 279                 _thread_initial->last_active = (long) _sched_ticks;
 280
 281                 /* Initialize the initial context: */
 282                 _thread_initial->curframe = NULL;
 283
 284                 /* Initialise the rest of the fields: */
 285                 _thread_initial->poll_data.nfds = 0;
 286                 _thread_initial->poll_data.fds = NULL;
 287                 _thread_initial->sig_defer_count = 0;
 288                 _thread_initial->yield_on_sig_undefer = 0;
 289                 _thread_initial->specific_data = NULL;
 290                 _thread_initial->cleanup = NULL;
 291                 _thread_initial->flags = 0;
 292                 TAILQ_INIT(&_thread_list);
 293                 TAILQ_INSERT_HEAD(&_thread_list, _thread_initial, tle);
 294                 _set_curthread(_thread_initial);
 295                 TAILQ_INIT(&_atfork_list);
 296                 _pthread_mutex_init(&_atfork_mutex, NULL);
 297
 298                 /* Initialise the global signal action structure: */
 299                 sigfillset(&act.sa_mask);
 300                 act.sa_handler = (void (*) ()) _thread_sig_handler;
 301                 act.sa_flags = SA_SIGINFO | SA_RESTART;
 302
 303                 /* Clear pending signals for the process: */
 304                 sigemptyset(&_process_sigpending);
 305
 306                 /* Clear the signal queue: */
 307                 memset(_thread_sigq, 0, sizeof(_thread_sigq));
 308
 309                 /* Enter a loop to get the existing signal status: */
 310                 for (i = 1; i < NSIG; i++) {
 311                         /* Check for signals which cannot be trapped: */
 312                         if (i == SIGKILL || i == SIGSTOP) {
 313                         }
 314
 315                         /* Get the signal handler details: */
 316                         else if (__sys_sigaction(i, NULL,
 317                             &_thread_sigact[i - 1]) != 0) {
 318                                 /*
 319                                  * Abort this process if signal
 320                                  * initialisation fails:
 321                                  */
 322                                 PANIC("Cannot read signal handler info");
 323                         }
 324
 325                         /* Initialize the SIG_DFL dummy handler count. */
 326                         _thread_dfl_count[i] = 0;
 327                 }
 328
 329                 /*
 330                  * Install the signal handler for the most important
 331                  * signals that the user-thread kernel needs. Actually
 332                  * SIGINFO isn't really needed, but it is nice to have.
 333                  */
 334                 if (__sys_sigaction(_SCHED_SIGNAL, &act, NULL) != 0 ||
 335                     __sys_sigaction(SIGINFO,       &act, NULL) != 0 ||
 336                     __sys_sigaction(SIGCHLD,       &act, NULL) != 0) {
 337                         /*
 338                          * Abort this process if signal initialisation fails:
 339                          */
 340                         PANIC("Cannot initialise signal handler");
 341                 }
 342                 _thread_sigact[_SCHED_SIGNAL - 1].sa_flags = SA_SIGINFO;
 343                 _thread_sigact[SIGINFO - 1].sa_flags = SA_SIGINFO;
 344                 _thread_sigact[SIGCHLD - 1].sa_flags = SA_SIGINFO;
 345
 346                 /* Get the process signal mask: */
 347                 __sys_sigprocmask(SIG_SETMASK, NULL, &_process_sigmask);
 348
 349                 /* Get the kernel clockrate: */
 350                 mib[0] = CTL_KERN;
 351                 mib[1] = KERN_CLOCKRATE;
 352                 len = sizeof (struct clockinfo);
 353                 if (sysctl(mib, 2, &clockinfo, &len, NULL, 0) == 0)
 354                         _clock_res_usec = clockinfo.tick > CLOCK_RES_USEC_MIN ?
 355                             clockinfo.tick : CLOCK_RES_USEC_MIN;
 356
 357                 /* Get the table size: */
 358                 if ((_thread_dtablesize = getdtablesize()) < 0) {
 359                         /*
 360                          * Cannot get the system defined table size, so abort
 361                          * this process.
 362                          */
 363                         PANIC("Cannot get dtablesize");
 364                 }
 365                 /* Allocate memory for the file descriptor table: */
 366                 if ((_thread_fd_table = (struct fd_table_entry **) malloc(sizeof(struct fd_table_entry *) * _thread_dtablesize)) == NULL) {
 367                         /* Avoid accesses to file descriptor table on exit: */
 368                         _thread_dtablesize = 0;
 369
 370                         /*
 371                          * Cannot allocate memory for the file descriptor
 372                          * table, so abort this process.
 373                          */
 374                         PANIC("Cannot allocate memory for file descriptor table");
 375                 }
 376                 /* Allocate memory for the pollfd table: */
 377                 if ((_thread_pfd_table = (struct pollfd *) malloc(sizeof(struct pollfd) * _thread_dtablesize)) == NULL) {
 378                         /*
 379                          * Cannot allocate memory for the file descriptor
 380                          * table, so abort this process.
 381                          */
 382                         PANIC("Cannot allocate memory for pollfd table");
 383                 } else {
 384                         /*
 385                          * Enter a loop to initialise the file descriptor
 386                          * table:
 387                          */
 388                         for (i = 0; i < _thread_dtablesize; i++) {
 389                                 /* Initialise the file descriptor table: */
 390                                 _thread_fd_table[i] = NULL;
 391                         }
 392
 393                         /* Initialize stdio file descriptor table entries: */
 394                         for (i = 0; i < 3; i++) {
 395                                 if ((_thread_fd_table_init(i) != 0) &&
 396                                     (errno != EBADF))
 397                                         PANIC("Cannot initialize stdio file "
 398                                             "descriptor table entry");
 399                         }
 400                 }
 401         }
 402
 403 #ifdef GCC_2_8_MADE_THREAD_AWARE
 404         /* Create the thread-specific data for the exception linked list. */
 405         if(pthread_key_create(&except_head_key, NULL) != 0)
 406                 PANIC("Failed to create thread specific execption head");
 407
 408         /* Setup the gcc exception handler per thread. */
 409         __set_dynamic_handler_allocator( dynamic_allocator_handler_fn );
 410 #endif /* GCC_2_8_MADE_THREAD_AWARE */
 411
 412         /* Initialise the garbage collector mutex and condition variable. */
 413         if (pthread_mutex_init(&_gc_mutex,NULL) != 0 ||
 414             pthread_cond_init(&_gc_cond,NULL) != 0)
 415                 PANIC("Failed to initialise garbage collector mutex or condvar");
 416 }
 417
 418 int _thread_autoinit_dummy_decl = 0;
 419
 420
 421 void
 422 _thread_mksigpipe(void)
 423 {
 424         int fd, flags, i;
 425
 426         /*
 427          * Create a pipe that is written to by the signal handler to
 428          * prevent signals being missed in calls to
 429          * __sys_select:
 430          */
 431         if (__sys_pipe(_thread_kern_pipe) != 0) {
 432                 /* Cannot create pipe, so abort: */
 433                 PANIC("Cannot create pthread kernel pipe.");
 434         }
 435         /*
 436          * Make sure the pipe does not get in the way of stdio:
 437          */
 438         for (i = 0; i < 2; i++) {
 439                 if (_thread_kern_pipe[i] < 3) {
 440                         fd = __sys_fcntl(_thread_kern_pipe[i], F_DUPFD, 3);
 441                         if (fd == -1)
 442                             PANIC("Cannot create kernel pipe");
 443                         __sys_close(_thread_kern_pipe[i]);
 444                         _thread_kern_pipe[i] = fd;
 445                 }
 446         }
 447         /* Get the flags for the read pipe: */
 448         if ((flags = __sys_fcntl(_thread_kern_pipe[0], F_GETFL, NULL)) == -1)
 449                 abort();
 450         /* Make the read pipe non-blocking: */
 451         if (__sys_fcntl(_thread_kern_pipe[0], F_SETFL, flags | O_NONBLOCK) == -1)
 452                 abort();
 453         /* Get the flags for the write pipe: */
 454         if ((flags = __sys_fcntl(_thread_kern_pipe[1], F_GETFL, NULL)) == -1)
 455                 abort();
 456         /* Make the write pipe non-blocking: */
 457         if (__sys_fcntl(_thread_kern_pipe[1], F_SETFL, flags | O_NONBLOCK) == -1)
 458                 abort();
 459 }