src/runtime/runtime.c

   1 /*
   2  * main() entry point for a stand-alone SBCL image
   3  */
   4
   5 /*
   6  * This software is part of the SBCL system. See the README file for
   7  * more information.
   8  *
   9  * This software is derived from the CMU CL system, which was
  10  * written at Carnegie Mellon University and released into the
  11  * public domain. The software is in the public domain and is
  12  * provided with absolutely no warranty. See the COPYING and CREDITS
  13  * files for more information.
  14  */
  15
  16 #include "sbcl.h"
  17
  18 #include <stdio.h>
  19 #include <string.h>
  20 #include <libgen.h>
  21 #include <sys/types.h>
  22 #include <sys/wait.h>
  23 #include <stdlib.h>
  24 #include <unistd.h>
  25 #include <sys/file.h>
  26 #include <sys/param.h>
  27 #include <sys/stat.h>
  28 #include <signal.h>
  29 #include <sched.h>
  30 #include <errno.h>
  31
  32 #if defined(SVR4) || defined(__linux__)
  33 #include <time.h>
  34 #endif
  35
  36 #include "signal.h"
  37
  38 #include "runtime.h"
  39 #include "alloc.h"
  40 #include "vars.h"
  41 #include "globals.h"
  42 #include "os.h"
  43 #include "interrupt.h"
  44 #include "arch.h"
  45 #include "gc.h"
  46 #include "interr.h"
  47 #include "monitor.h"
  48 #include "validate.h"
  49 #include "core.h"
  50 #include "save.h"
  51 #include "lispregs.h"
  52 #include "thread.h"
  53
  54 #include "genesis/static-symbols.h"
  55 #include "genesis/symbol.h"
  56
  57
  58 #ifdef irix
  59 #include <string.h>
  60 #include "interr.h"
  61 #endif
  62
  63 #ifndef SBCL_HOME
  64 #define SBCL_HOME "/usr/local/lib/sbcl/"
  65 #endif
  66
  67 \f
  68 /* SIGINT handler that invokes the monitor (for when Lisp isn't up to it) */
  69 static void
  70 sigint_handler(int signal, siginfo_t *info, void *void_context)
  71 {
  72     lose("\nSIGINT hit at 0x%08lX\n",
  73          (unsigned long) *os_context_pc_addr(void_context));
  74 }
  75
  76 /* (This is not static, because we want to be able to call it from
  77  * Lisp land.) */
  78 void
  79 sigint_init(void)
  80 {
  81     SHOW("entering sigint_init()");
  82     install_handler(SIGINT, sigint_handler);
  83     SHOW("leaving sigint_init()");
  84 }
  85 \f
  86 /*
  87  * helper functions for dealing with command line args
  88  */
  89
  90 void *
  91 successful_malloc(size_t size)
  92 {
  93     void* result = malloc(size);
  94     if (0 == result) {
  95         lose("malloc failure");
  96     } else {
  97         return result;
  98     }
  99     return (void *) NULL; /* dummy value: return something ... */
 100 }
 101
 102 char *
 103 copied_string(char *string)
 104 {
 105     return strcpy(successful_malloc(1+strlen(string)), string);
 106 }
 107
 108 char *
 109 copied_existing_filename_or_null(char *filename)
 110 {
 111     struct stat filename_stat;
 112     if (stat(filename, &filename_stat)) { /* if failure */
 113         return 0;
 114     } else {
 115         return copied_string(filename);
 116     }
 117 }
 118
 119 /* Convert a null-terminated array of null-terminated strings (e.g.
 120  * argv or envp) into a Lisp list of Lisp base-strings. */
 121 static lispobj
 122 alloc_base_string_list(char *array_ptr[])
 123 {
 124     if (*array_ptr) {
 125         return alloc_cons(alloc_base_string(*array_ptr),
 126                           alloc_base_string_list(1 + array_ptr));
 127     } else {
 128         return NIL;
 129     }
 130 }
 131 \f
 132 /* miscellaneous chattiness */
 133
 134 void
 135 print_help()
 136 {
 137     puts(
 138 "SBCL is a Common Lisp programming environment. Ordinarily you shouldn't\n\
 139 need command line options when you invoke it interactively: you can just\n\
 140 start it and work with the customary Lisp READ-EVAL-PRINT loop.\n\
 141 \n\
 142 One option idiom which is sometimes useful interactively (e.g. when\n\
 143 exercising a test case for a bug report) is\n\
 144   sbcl --sysinit /dev/null --userinit /dev/null\n\
 145 to keep SBCL from reading any initialization files at startup. And some\n\
 146 people like to suppress the default startup message:\n\
 147   sbcl --noinform\n\
 148 \n\
 149 Other options can be useful when you're running SBCL noninteractively,\n\
 150 e.g. from a script, or if you have a strange system configuration, so\n\
 151 that SBCL can't by default find one of the files it needs. For\n\
 152 information on such options, see the sbcl(1) man page.\n\
 153 \n\
 154 More information on SBCL can be found on its man page, or at\n\
 155 <http://sbcl.sf.net/>.\n");
 156 }
 157
 158 void
 159 print_version()
 160 {
 161     printf("SBCL %s\n", SBCL_VERSION_STRING);
 162 }
 163
 164 void
 165 print_banner()
 166 {
 167     printf(
 168 "This is SBCL %s, an implementation of ANSI Common Lisp.\n\
 169 \n\
 170 More information about SBCL is available at <http://www.sbcl.org/>.\
 171 \n\
 172 SBCL is free software, provided as is, with absolutely no warranty.\n\
 173 It is mostly in the public domain; some portions are provided under\n\
 174 BSD-style licenses.  See the CREDITS and COPYING files in the\n\
 175 distribution for more information.\n\
 176 ", SBCL_VERSION_STRING);
 177 }
 178
 179 \f
 180 int
 181 main(int argc, char *argv[], char *envp[])
 182 {
 183     /* the name of the core file we're to execute. Note that this is
 184      * a malloc'ed string which should be freed eventually. */
 185     char *core = 0;
 186
 187     /* other command line options */
 188     boolean noinform = 0;
 189     boolean end_runtime_options = 0;
 190
 191     lispobj initial_function;
 192
 193     /* KLUDGE: os_vm_page_size is set by os_init(), and on some
 194      * systems (e.g. Alpha) arch_init() needs need os_vm_page_size, so
 195      * it must follow os_init(). -- WHN 2000-01-26 */
 196     os_init();
 197     arch_init();
 198     gc_init();
 199     validate();
 200
 201     /* Parse our part of the command line (aka "runtime options"),
 202      * stripping out those options that we handle. */
 203     {
 204         int argi = 1;
 205         while (argi < argc) {
 206             char *arg = argv[argi];
 207             if (0 == strcmp(arg, "--noinform")) {
 208                 noinform = 1;
 209                 ++argi;
 210             } else if (0 == strcmp(arg, "--core")) {
 211                 if (core) {
 212                     lose("more than one core file specified");
 213                 } else {
 214                     ++argi;
 215                     if (argi >= argc) {
 216                         lose("missing filename for --core argument");
 217                     }
 218                     core = copied_string(argv[argi]);
 219                     ++argi;
 220                 }
 221             } else if (0 == strcmp(arg, "--help")) {
 222                 /* I think this is the (or a) usual convention: upon
 223                  * seeing "--help" we immediately print our help
 224                  * string and exit, ignoring everything else. */
 225                 print_help();
 226                 exit(0);
 227             } else if (0 == strcmp(arg, "--version")) {
 228                 /* As in "--help" case, I think this is expected. */
 229                 print_version();
 230                 exit(0);
 231             } else if (0 == strcmp(arg, "--end-runtime-options")) {
 232                 end_runtime_options = 1;
 233                 ++argi;
 234                 break;
 235             } else {
 236                 /* This option was unrecognized as a runtime option,
 237                  * so it must be a toplevel option or a user option,
 238                  * so we must be past the end of the runtime option
 239                  * section. */
 240                 break;
 241             }
 242         }
 243         /* This is where we strip out those options that we handle. We
 244          * also take this opportunity to make sure that we don't find
 245          * an out-of-place "--end-runtime-options" option. */
 246         {
 247             char *argi0 = argv[argi];
 248             int argj = 1;
 249             while (argi < argc) {
 250                 char *arg = argv[argi++];
 251                 /* If we encounter --end-runtime-options for the first
 252                  * time after the point where we had to give up on
 253                  * runtime options, then the point where we had to
 254                  * give up on runtime options must've been a user
 255                  * error. */
 256                 if (!end_runtime_options &&
 257                     0 == strcmp(arg, "--end-runtime-options")) {
 258                     lose("bad runtime option \"%s\"", argi0);
 259                 }
 260                 argv[argj++] = arg;
 261             }
 262             argv[argj] = 0;
 263             argc = argj;
 264         }
 265     }
 266
 267     /* If no core file was specified, look for one. */
 268     if (!core) {
 269         char *sbcl_home = getenv("SBCL_HOME");
 270         char *lookhere;
 271         char *stem = "/sbcl.core";
 272         if(!sbcl_home) sbcl_home = SBCL_HOME;
 273         lookhere = (char *) calloc(strlen(sbcl_home) +
 274                                    strlen(stem) +
 275                                    1,
 276                                    sizeof(char));
 277         sprintf(lookhere, "%s%s", sbcl_home, stem);
 278         core = copied_existing_filename_or_null(lookhere);
 279         free(lookhere);
 280         if (!core) {
 281             lose("can't find core file");
 282         }
 283     }
 284     /* Make sure that SBCL_HOME is set, no matter where the core was
 285      * found */
 286     if (!getenv("SBCL_HOME")) {
 287         char *envstring, *copied_core, *dir;
 288         char *stem = "SBCL_HOME=";
 289         copied_core = copied_string(core);
 290         dir = dirname(copied_core);
 291         envstring = (char *) calloc(strlen(stem) +
 292                                     strlen(dir) +
 293                                     1,
 294                                     sizeof(char));
 295         sprintf(envstring, "%s%s", stem, dir);
 296         putenv(envstring);
 297         free(copied_core);
 298     }
 299
 300     if (!noinform) {
 301         print_banner();
 302         fflush(stdout);
 303     }
 304
 305 #if defined(SVR4) || defined(__linux__)
 306     tzset();
 307 #endif
 308
 309     define_var("nil", NIL, 1);
 310     define_var("t", T, 1);
 311
 312     set_lossage_handler(monitor_or_something);
 313
 314     globals_init();
 315
 316     initial_function = load_core_file(core);
 317     if (initial_function == NIL) {
 318         lose("couldn't find initial function");
 319     }
 320     SHOW("freeing core");
 321     free(core);
 322
 323     gc_initialize_pointers();
 324
 325     interrupt_init();
 326     arch_install_interrupt_handlers();
 327     os_install_interrupt_handlers();
 328
 329     /* Convert remaining argv values to something that Lisp can grok. */
 330     SHOW("setting POSIX-ARGV symbol value");
 331     SetSymbolValue(POSIX_ARGV, alloc_base_string_list(argv),0);
 332
 333     /* Install a handler to pick off SIGINT until the Lisp system gets
 334      * far enough along to install its own handler. */
 335     sigint_init();
 336
 337     FSHOW((stderr, "/funcalling initial_function=0x%lx\n", initial_function));
 338     create_thread(initial_function);
 339     /* in a unithread build, create_thread never returns */
 340 #ifdef LISP_FEATURE_SB_THREAD
 341     parent_loop();
 342 #endif
 343 }
 344
 345 #ifdef LISP_FEATURE_SB_THREAD
 346
 347 /* this is being pared down as time goes on; eventually we want to get
 348  * to the point that we have no parent loop at all and the parent
 349  * thread runs Lisp just like any other */
 350
 351 static void /* noreturn */ parent_loop(void)
 352 {
 353     struct sigaction sa;
 354     sigset_t sigset;
 355     int status;
 356     pid_t pid=0;
 357
 358     sigemptyset(&sigset);
 359     sa.sa_handler=SIG_IGN;
 360     sa.sa_mask=sigset;
 361     sa.sa_flags=0;
 362     sigaction(SIGINT, &sa, 0);  /* ^c should go to the lisp thread instead */
 363     sigaction(SIG_THREAD_EXIT, &sa, 0);
 364     sigaction(SIGCHLD, &sa, 0);
 365
 366     while(!all_threads) {
 367         sched_yield();
 368     }
 369     while(all_threads && (pid=waitpid(-1,&status,__WALL))) {
 370         struct thread *th;
 371         if(pid==-1) {
 372             if(errno == EINTR) continue;
 373             fprintf(stderr,"waitpid: %s\n",strerror(errno));
 374         }
 375         else if(WIFEXITED(status) || WIFSIGNALED(status)) {
 376             th=find_thread_by_pid(pid);
 377             if(!th) continue;
 378             destroy_thread(th);
 379             if(!all_threads) break;
 380         }
 381     }
 382     exit(WEXITSTATUS(status));
 383 }
 384
 385 #endif