lib/libkse/thread/thr_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$
  33  */
  34
  35 /* Allocate space for global thread variables here: */
  36 #define GLOBAL_PTHREAD_PRIVATE
  37
  38 #include "namespace.h"
  39 #include <sys/param.h>
  40 #include <sys/types.h>
  41 #include <machine/reg.h>
  42
  43 #include <sys/ioctl.h>
  44 #include <sys/mount.h>
  45 #include <sys/uio.h>
  46 #include <sys/socket.h>
  47 #include <sys/event.h>
  48 #include <sys/stat.h>
  49 #include <sys/sysctl.h>
  50 #include <sys/time.h>
  51 #include <sys/ttycom.h>
  52 #include <sys/user.h>
  53 #include <sys/wait.h>
  54 #include <sys/mman.h>
  55 #include <dirent.h>
  56 #include <errno.h>
  57 #include <fcntl.h>
  58 #include <paths.h>
  59 #include <poll.h>
  60 #include <pthread.h>
  61 #include <signal.h>
  62 #include <stdio.h>
  63 #include <stdlib.h>
  64 #include <string.h>
  65 #include <unistd.h>
  66 #include "un-namespace.h"
  67
  68 #include "pthread_private.h"
  69
  70 /*
  71  * All weak references used within libc should be in this table.
  72  * This will is so that static libraries will work.
  73  */
  74 static void *references[] = {
  75         &_accept,
  76         &_bind,
  77         &_close,
  78         &_connect,
  79         &_dup,
  80         &_dup2,
  81         &_execve,
  82         &_fcntl,
  83         &_flock,
  84         &_flockfile,
  85         &_fstat,
  86         &_fstatfs,
  87         &_fsync,
  88         &_funlockfile,
  89         &_getdirentries,
  90         &_getlogin,
  91         &_getpeername,
  92         &_getsockname,
  93         &_getsockopt,
  94         &_ioctl,
  95         &_kevent,
  96         &_listen,
  97         &_nanosleep,
  98         &_open,
  99         &_pthread_getspecific,
 100         &_pthread_key_create,
 101         &_pthread_key_delete,
 102         &_pthread_mutex_destroy,
 103         &_pthread_mutex_init,
 104         &_pthread_mutex_lock,
 105         &_pthread_mutex_trylock,
 106         &_pthread_mutex_unlock,
 107         &_pthread_mutexattr_init,
 108         &_pthread_mutexattr_destroy,
 109         &_pthread_mutexattr_settype,
 110         &_pthread_once,
 111         &_pthread_setspecific,
 112         &_read,
 113         &_readv,
 114         &_recvfrom,
 115         &_recvmsg,
 116         &_select,
 117         &_sendmsg,
 118         &_sendto,
 119         &_setsockopt,
 120         &_sigaction,
 121         &_sigprocmask,
 122         &_sigsuspend,
 123         &_socket,
 124         &_socketpair,
 125         &_wait4,
 126         &_write,
 127         &_writev
 128 };
 129
 130 /*
 131  * These are needed when linking statically.  All references within
 132  * libgcc (and in the future libc) to these routines are weak, but
 133  * if they are not (strongly) referenced by the application or other
 134  * libraries, then the actual functions will not be loaded.
 135  */
 136 static void *libgcc_references[] = {
 137         &_pthread_once,
 138         &_pthread_key_create,
 139         &_pthread_key_delete,
 140         &_pthread_getspecific,
 141         &_pthread_setspecific,
 142         &_pthread_mutex_init,
 143         &_pthread_mutex_destroy,
 144         &_pthread_mutex_lock,
 145         &_pthread_mutex_trylock,
 146         &_pthread_mutex_unlock
 147 };
 148
 149
 150 /*
 151  * Threaded process initialization
 152  */
 153 void
 154 _thread_init(void)
 155 {
 156         int             fd;
 157         int             flags;
 158         int             i;
 159         size_t          len;
 160         int             mib[2];
 161         struct clockinfo clockinfo;
 162         struct sigaction act;
 163
 164         /* Check if this function has already been called: */
 165         if (_thread_initial)
 166                 /* Only initialise the threaded application once. */
 167                 return;
 168
 169         /*
 170          * Make gcc quiescent about {,libgcc_}references not being
 171          * referenced:
 172          */
 173         if ((references[0] == NULL) || (libgcc_references[0] == NULL))
 174                 PANIC("Failed loading mandatory references in _thread_init");
 175
 176         /*
 177          * Check for the special case of this process running as
 178          * or in place of init as pid = 1:
 179          */
 180         if (getpid() == 1) {
 181                 /*
 182                  * Setup a new session for this process which is
 183                  * assumed to be running as root.
 184                  */
 185                 if (setsid() == -1)
 186                         PANIC("Can't set session ID");
 187                 if (revoke(_PATH_CONSOLE) != 0)
 188                         PANIC("Can't revoke console");
 189                 if ((fd = __sys_open(_PATH_CONSOLE, O_RDWR)) < 0)
 190                         PANIC("Can't open console");
 191                 if (setlogin("root") == -1)
 192                         PANIC("Can't set login to root");
 193                 if (__sys_ioctl(fd,TIOCSCTTY, (char *) NULL) == -1)
 194                         PANIC("Can't set controlling terminal");
 195                 if (__sys_dup2(fd,0) == -1 ||
 196                     __sys_dup2(fd,1) == -1 ||
 197                     __sys_dup2(fd,2) == -1)
 198                         PANIC("Can't dup2");
 199         }
 200
 201         /* Get the standard I/O flags before messing with them : */
 202         for (i = 0; i < 3; i++)
 203                 if (((_pthread_stdio_flags[i] =
 204                     __sys_fcntl(i,F_GETFL, NULL)) == -1) &&
 205                     (errno != EBADF))
 206                         PANIC("Cannot get stdio flags");
 207
 208         /*
 209          * Create a pipe that is written to by the signal handler to prevent
 210          * signals being missed in calls to _select:
 211          */
 212         if (__sys_pipe(_thread_kern_pipe) != 0) {
 213                 /* Cannot create pipe, so abort: */
 214                 PANIC("Cannot create kernel pipe");
 215         }
 216         /* Get the flags for the read pipe: */
 217         else if ((flags = __sys_fcntl(_thread_kern_pipe[0], F_GETFL, NULL)) == -1) {
 218                 /* Abort this application: */
 219                 PANIC("Cannot get kernel read pipe flags");
 220         }
 221         /* Make the read pipe non-blocking: */
 222         else if (__sys_fcntl(_thread_kern_pipe[0], F_SETFL, flags | O_NONBLOCK) == -1) {
 223                 /* Abort this application: */
 224                 PANIC("Cannot make kernel read pipe non-blocking");
 225         }
 226         /* Get the flags for the write pipe: */
 227         else if ((flags = __sys_fcntl(_thread_kern_pipe[1], F_GETFL, NULL)) == -1) {
 228                 /* Abort this application: */
 229                 PANIC("Cannot get kernel write pipe flags");
 230         }
 231         /* Make the write pipe non-blocking: */
 232         else if (__sys_fcntl(_thread_kern_pipe[1], F_SETFL, flags | O_NONBLOCK) == -1) {
 233                 /* Abort this application: */
 234                 PANIC("Cannot get kernel write pipe flags");
 235         }
 236         /* Allocate and initialize the ready queue: */
 237         else if (_pq_alloc(&_readyq, PTHREAD_MIN_PRIORITY, PTHREAD_LAST_PRIORITY) != 0) {
 238                 /* Abort this application: */
 239                 PANIC("Cannot allocate priority ready queue.");
 240         }
 241         /* Allocate memory for the thread structure of the initial thread: */
 242         else if ((_thread_initial = (pthread_t) malloc(sizeof(struct pthread))) == NULL) {
 243                 /*
 244                  * Insufficient memory to initialise this application, so
 245                  * abort:
 246                  */
 247                 PANIC("Cannot allocate memory for initial thread");
 248         }
 249         /* Allocate memory for the scheduler stack: */
 250         else if ((_thread_kern_sched_stack = malloc(SCHED_STACK_SIZE)) == NULL)
 251                 PANIC("Failed to allocate stack for scheduler");
 252         else {
 253                 /* Zero the global kernel thread structure: */
 254                 memset(&_thread_kern_thread, 0, sizeof(struct pthread));
 255                 _thread_kern_thread.flags = PTHREAD_FLAGS_PRIVATE;
 256                 memset(_thread_initial, 0, sizeof(struct pthread));
 257
 258                 /* Initialize the waiting and work queues: */
 259                 TAILQ_INIT(&_waitingq);
 260                 TAILQ_INIT(&_workq);
 261
 262                 /* Initialize the scheduling switch hook routine: */
 263                 _sched_switch_hook = NULL;
 264
 265                 /* Give this thread default attributes: */
 266                 memcpy((void *) &_thread_initial->attr, &pthread_attr_default,
 267                     sizeof(struct pthread_attr));
 268
 269                 /*
 270                  * Create a red zone below the main stack.  All other stacks are
 271                  * constrained to a maximum size by the paramters passed to
 272                  * mmap(), but this stack is only limited by resource limits, so
 273                  * this stack needs an explicitly mapped red zone to protect the
 274                  * thread stack that is just beyond.
 275                  */
 276                 if (mmap((void *) USRSTACK - PTHREAD_STACK_INITIAL -
 277                     PTHREAD_GUARD_DEFAULT, PTHREAD_GUARD_DEFAULT, 0, MAP_ANON,
 278                     -1, 0) == MAP_FAILED)
 279                         PANIC("Cannot allocate red zone for initial thread");
 280
 281                 /* Set the main thread stack pointer. */
 282                 _thread_initial->stack = (void *) USRSTACK -
 283                     PTHREAD_STACK_INITIAL;
 284
 285                 /* Set the stack attributes: */
 286                 _thread_initial->attr.stackaddr_attr = _thread_initial->stack;
 287                 _thread_initial->attr.stacksize_attr = PTHREAD_STACK_INITIAL;
 288
 289                 /* Setup the context for the scheduler: */
 290                 _setjmp(_thread_kern_sched_jb);
 291                 SET_STACK_JB(_thread_kern_sched_jb, _thread_kern_sched_stack +
 292                     SCHED_STACK_SIZE - sizeof(double));
 293                 SET_RETURN_ADDR_JB(_thread_kern_sched_jb, _thread_kern_scheduler);
 294
 295                 /*
 296                  * Write a magic value to the thread structure
 297                  * to help identify valid ones:
 298                  */
 299                 _thread_initial->magic = PTHREAD_MAGIC;
 300
 301                 /* Set the initial cancel state */
 302                 _thread_initial->cancelflags = PTHREAD_CANCEL_ENABLE |
 303                     PTHREAD_CANCEL_DEFERRED;
 304
 305                 /* Default the priority of the initial thread: */
 306                 _thread_initial->base_priority = PTHREAD_DEFAULT_PRIORITY;
 307                 _thread_initial->active_priority = PTHREAD_DEFAULT_PRIORITY;
 308                 _thread_initial->inherited_priority = 0;
 309
 310                 /* Initialise the state of the initial thread: */
 311                 _thread_initial->state = PS_RUNNING;
 312
 313                 /* Set the name of the thread: */
 314                 _thread_initial->name = strdup("_thread_initial");
 315
 316                 /* Initialize joiner to NULL (no joiner): */
 317                 _thread_initial->joiner = NULL;
 318
 319                 /* Initialize the owned mutex queue and count: */
 320                 TAILQ_INIT(&(_thread_initial->mutexq));
 321                 _thread_initial->priority_mutex_count = 0;
 322
 323                 /* Initialize the global scheduling time: */
 324                 _sched_ticks = 0;
 325                 gettimeofday((struct timeval *) &_sched_tod, NULL);
 326
 327                 /* Initialize last active: */
 328                 _thread_initial->last_active = (long) _sched_ticks;
 329
 330                 /* Initialize the initial context: */
 331                 _thread_initial->curframe = NULL;
 332                 _thread_initial->ctxtype = CTX_JB_NOSIG;
 333
 334                 /* Initialise the rest of the fields: */
 335                 _thread_initial->poll_data.nfds = 0;
 336                 _thread_initial->poll_data.fds = NULL;
 337                 _thread_initial->sig_defer_count = 0;
 338                 _thread_initial->yield_on_sig_undefer = 0;
 339                 _thread_initial->specific_data = NULL;
 340                 _thread_initial->cleanup = NULL;
 341                 _thread_initial->flags = 0;
 342                 _thread_initial->error = 0;
 343                 TAILQ_INIT(&_thread_list);
 344                 TAILQ_INSERT_HEAD(&_thread_list, _thread_initial, tle);
 345                 _set_curthread(_thread_initial);
 346
 347                 /* Initialise the global signal action structure: */
 348                 sigfillset(&act.sa_mask);
 349                 act.sa_handler = (void (*) ()) _thread_sig_handler;
 350                 act.sa_flags = SA_SIGINFO | SA_ONSTACK;
 351
 352                 /* Clear pending signals for the process: */
 353                 sigemptyset(&_process_sigpending);
 354
 355                 /* Clear the signal queue: */
 356                 memset(_thread_sigq, 0, sizeof(_thread_sigq));
 357
 358                 /*
 359                  * Create and install an alternate signal stack of
 360                  * the recommended size:
 361                  */
 362                 _thread_sigstack.ss_sp = malloc(SIGSTKSZ);
 363                 _thread_sigstack.ss_size = SIGSTKSZ;
 364                 _thread_sigstack.ss_flags = 0;
 365                 if ((_thread_sigstack.ss_sp == NULL) ||
 366                     (__sys_sigaltstack(&_thread_sigstack, NULL) != 0))
 367                         PANIC("Unable to install alternate signal stack");
 368
 369                 /* Enter a loop to get the existing signal status: */
 370                 for (i = 1; i < NSIG; i++) {
 371                         /* Check for signals which cannot be trapped: */
 372                         if (i == SIGKILL || i == SIGSTOP) {
 373                         }
 374
 375                         /* Get the signal handler details: */
 376                         else if (__sys_sigaction(i, NULL,
 377                             &_thread_sigact[i - 1]) != 0) {
 378                                 /*
 379                                  * Abort this process if signal
 380                                  * initialisation fails:
 381                                  */
 382                                 PANIC("Cannot read signal handler info");
 383                         }
 384
 385                         /* Initialize the SIG_DFL dummy handler count. */
 386                         _thread_dfl_count[i] = 0;
 387                 }
 388
 389                 /*
 390                  * Install the signal handler for the most important
 391                  * signals that the user-thread kernel needs. Actually
 392                  * SIGINFO isn't really needed, but it is nice to have.
 393                  */
 394                 if (__sys_sigaction(_SCHED_SIGNAL, &act, NULL) != 0 ||
 395                     __sys_sigaction(SIGINFO,       &act, NULL) != 0 ||
 396                     __sys_sigaction(SIGCHLD,       &act, NULL) != 0) {
 397                         /*
 398                          * Abort this process if signal initialisation fails:
 399                          */
 400                         PANIC("Cannot initialise signal handler");
 401                 }
 402                 _thread_sigact[_SCHED_SIGNAL - 1].sa_flags = SA_SIGINFO;
 403                 _thread_sigact[SIGINFO - 1].sa_flags = SA_SIGINFO;
 404                 _thread_sigact[SIGCHLD - 1].sa_flags = SA_SIGINFO;
 405
 406                 /* Get the process signal mask: */
 407                 __sys_sigprocmask(SIG_SETMASK, NULL, &_process_sigmask);
 408
 409                 /* Get the kernel clockrate: */
 410                 mib[0] = CTL_KERN;
 411                 mib[1] = KERN_CLOCKRATE;
 412                 len = sizeof (struct clockinfo);
 413                 if (sysctl(mib, 2, &clockinfo, &len, NULL, 0) == 0)
 414                         _clock_res_usec = clockinfo.tick > CLOCK_RES_USEC_MIN ?
 415                             clockinfo.tick : CLOCK_RES_USEC_MIN;
 416
 417                 /* Get the table size: */
 418                 if ((_thread_dtablesize = getdtablesize()) < 0) {
 419                         /*
 420                          * Cannot get the system defined table size, so abort
 421                          * this process.
 422                          */
 423                         PANIC("Cannot get dtablesize");
 424                 }
 425                 /* Allocate memory for the file descriptor table: */
 426                 if ((_thread_fd_table = (struct fd_table_entry **) malloc(sizeof(struct fd_table_entry *) * _thread_dtablesize)) == NULL) {
 427                         /* Avoid accesses to file descriptor table on exit: */
 428                         _thread_dtablesize = 0;
 429
 430                         /*
 431                          * Cannot allocate memory for the file descriptor
 432                          * table, so abort this process.
 433                          */
 434                         PANIC("Cannot allocate memory for file descriptor table");
 435                 }
 436                 /* Allocate memory for the pollfd table: */
 437                 if ((_thread_pfd_table = (struct pollfd *) malloc(sizeof(struct pollfd) * _thread_dtablesize)) == NULL) {
 438                         /*
 439                          * Cannot allocate memory for the file descriptor
 440                          * table, so abort this process.
 441                          */
 442                         PANIC("Cannot allocate memory for pollfd table");
 443                 } else {
 444                         /*
 445                          * Enter a loop to initialise the file descriptor
 446                          * table:
 447                          */
 448                         for (i = 0; i < _thread_dtablesize; i++) {
 449                                 /* Initialise the file descriptor table: */
 450                                 _thread_fd_table[i] = NULL;
 451                         }
 452
 453                         /* Initialize stdio file descriptor table entries: */
 454                         for (i = 0; i < 3; i++) {
 455                                 if ((_thread_fd_table_init(i) != 0) &&
 456                                     (errno != EBADF))
 457                                         PANIC("Cannot initialize stdio file "
 458                                             "descriptor table entry");
 459                         }
 460                 }
 461         }
 462
 463         /* Initialise the garbage collector mutex and condition variable. */
 464         if (_pthread_mutex_init(&_gc_mutex,NULL) != 0 ||
 465             pthread_cond_init(&_gc_cond,NULL) != 0)
 466                 PANIC("Failed to initialise garbage collector mutex or condvar");
 467 }
 468
 469 /*
 470  * Special start up code for NetBSD/Alpha
 471  */
 472 #if     defined(__NetBSD__) && defined(__alpha__)
 473 int
 474 main(int argc, char *argv[], char *env);
 475
 476 int
 477 _thread_main(int argc, char *argv[], char *env)
 478 {
 479         _thread_init();
 480         return (main(argc, argv, env));
 481 }
 482 #endif