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