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 #ifndef LISP_FEATURE_WIN32
  21 #include <libgen.h>
  22 #endif
  23 #include <sys/types.h>
  24 #ifndef LISP_FEATURE_WIN32
  25 #include <sys/wait.h>
  26 #endif
  27 #include <stdlib.h>
  28 #include <unistd.h>
  29 #include <sys/file.h>
  30 #include <sys/param.h>
  31 #include <sys/stat.h>
  32 #include <signal.h>
  33 #ifndef LISP_FEATURE_WIN32
  34 #include <sched.h>
  35 #endif
  36 #include <errno.h>
  37 #include <locale.h>
  38
  39 #if defined(SVR4) || defined(__linux__)
  40 #include <time.h>
  41 #endif
  42
  43 #include "signal.h"
  44
  45 #include "runtime.h"
  46 #include "alloc.h"
  47 #include "vars.h"
  48 #include "globals.h"
  49 #include "os.h"
  50 #include "interrupt.h"
  51 #include "arch.h"
  52 #include "gc.h"
  53 #include "interr.h"
  54 #include "validate.h"
  55 #include "core.h"
  56 #include "save.h"
  57 #include "lispregs.h"
  58 #include "thread.h"
  59
  60 #include "genesis/static-symbols.h"
  61 #include "genesis/symbol.h"
  62
  63
  64 #ifdef irix
  65 #include <string.h>
  66 #include "interr.h"
  67 #endif
  68
  69 #ifndef SBCL_HOME
  70 #define SBCL_HOME "/usr/local/lib/sbcl/"
  71 #endif
  72
  73 \f
  74 /* SIGINT handler that invokes the monitor (for when Lisp isn't up to it) */
  75 static void
  76 sigint_handler(int signal, siginfo_t *info, void *void_context)
  77 {
  78     lose("\nSIGINT hit at 0x%08lX\n",
  79          (unsigned long) *os_context_pc_addr(void_context));
  80 }
  81
  82 /* (This is not static, because we want to be able to call it from
  83  * Lisp land.) */
  84 void
  85 sigint_init(void)
  86 {
  87     SHOW("entering sigint_init()");
  88     install_handler(SIGINT, sigint_handler);
  89     SHOW("leaving sigint_init()");
  90 }
  91 \f
  92 /*
  93  * helper functions for dealing with command line args
  94  */
  95
  96 void *
  97 successful_malloc(size_t size)
  98 {
  99     void* result = malloc(size);
 100     if (0 == result) {
 101         lose("malloc failure\n");
 102     } else {
 103         return result;
 104     }
 105     return (void *) NULL; /* dummy value: return something ... */
 106 }
 107
 108 char *
 109 copied_string(char *string)
 110 {
 111     return strcpy(successful_malloc(1+strlen(string)), string);
 112 }
 113
 114 char *
 115 copied_existing_filename_or_null(char *filename)
 116 {
 117     struct stat filename_stat;
 118     if (stat(filename, &filename_stat)) { /* if failure */
 119         return 0;
 120     } else {
 121         return copied_string(filename);
 122     }
 123 }
 124
 125 /* Convert a null-terminated array of null-terminated strings (e.g.
 126  * argv or envp) into a Lisp list of Lisp base-strings. */
 127 static lispobj
 128 alloc_base_string_list(char *array_ptr[])
 129 {
 130     if (*array_ptr) {
 131         return alloc_cons(alloc_base_string(*array_ptr),
 132                           alloc_base_string_list(1 + array_ptr));
 133     } else {
 134         return NIL;
 135     }
 136 }
 137 \f
 138 /* miscellaneous chattiness */
 139
 140 void
 141 print_help()
 142 {
 143     puts(
 144 "Usage: sbcl [runtime-options] [toplevel-options] [user-options]\n\
 145 Common runtime options:\n\
 146   --help                     Print this message and exit.\n\
 147   --version                  Print version information and exit.\n\
 148   --core <filename>          Use the specified core file instead of the default.\n\
 149   --dynamic-space-size <MiB> Size of reserved dynamic space in megabytes.\n\
 150   --control-stack-size <MiB> Size of reserved control stack in megabytes.\n\
 151 \n\
 152 Common toplevel options:\n\
 153   --sysinit <filename>       System-wide init-file to use instead of default.\n\
 154   --userinit <filename>      Per-user init-file to use instead of default.\n\
 155   --no-sysinit               Inhibit processing of any system-wide init-file.\n\
 156   --no-userinit              Inhibit processing of any per-user init-file.\n\
 157 \n\
 158 User options are not processed by SBCL. All runtime options must\n\
 159 appear before toplevel options, and all toplevel options must\n\
 160 appear before user options.\n\
 161 \n\
 162 For more information please refer to the SBCL User Manual, which\n\
 163 should be installed along with SBCL, and is also available from the\n\
 164 website <http://www.sbcl.org/>.\n");
 165 }
 166
 167 void
 168 print_version()
 169 {
 170     printf("SBCL %s\n", SBCL_VERSION_STRING);
 171 }
 172
 173 void
 174 print_banner()
 175 {
 176     printf(
 177 "This is SBCL %s, an implementation of ANSI Common Lisp.\n\
 178 More information about SBCL is available at <http://www.sbcl.org/>.\n\
 179 \n\
 180 SBCL is free software, provided as is, with absolutely no warranty.\n\
 181 It is mostly in the public domain; some portions are provided under\n\
 182 BSD-style licenses.  See the CREDITS and COPYING files in the\n\
 183 distribution for more information.\n\
 184 ", SBCL_VERSION_STRING);
 185 }
 186
 187 /* Look for a core file to load, first in the directory named by the
 188  * SBCL_HOME environment variable, then in a hardcoded default
 189  * location.  Returns a malloced copy of the core filename. */
 190 char *
 191 search_for_core ()
 192 {
 193     char *sbcl_home = getenv("SBCL_HOME");
 194     char *lookhere;
 195     char *stem = "/sbcl.core";
 196     char *core;
 197
 198     if (!(sbcl_home && *sbcl_home)) sbcl_home = SBCL_HOME;
 199     lookhere = (char *) calloc(strlen(sbcl_home) +
 200                                strlen(stem) +
 201                                1,
 202                                sizeof(char));
 203     sprintf(lookhere, "%s%s", sbcl_home, stem);
 204     core = copied_existing_filename_or_null(lookhere);
 205
 206     if (!core) {
 207         lose("can't find core file at %s\n", lookhere);
 208     }
 209
 210     free(lookhere);
 211
 212     return core;
 213 }
 214
 215 char **posix_argv;
 216 char *core_string;
 217
 218 \f
 219 int
 220 main(int argc, char *argv[], char *envp[])
 221 {
 222 #ifdef LISP_FEATURE_WIN32
 223     /* Exception handling support structure. Evil Win32 hack. */
 224     struct lisp_exception_frame exception_frame;
 225 #endif
 226
 227     /* the name of the core file we're to execute. Note that this is
 228      * a malloc'ed string which should be freed eventually. */
 229     char *core = 0;
 230     char **sbcl_argv = 0;
 231     os_vm_offset_t embedded_core_offset = 0;
 232
 233     /* other command line options */
 234     boolean noinform = 0;
 235     boolean end_runtime_options = 0;
 236
 237     lispobj initial_function;
 238     const char *sbcl_home = getenv("SBCL_HOME");
 239
 240     interrupt_init();
 241     block_blockable_signals();
 242
 243     setlocale(LC_ALL, "");
 244
 245     /* Parse our part of the command line (aka "runtime options"),
 246      * stripping out those options that we handle. */
 247     {
 248         int argi = 1;
 249         while (argi < argc) {
 250             char *arg = argv[argi];
 251             if (0 == strcmp(arg, "--noinform")) {
 252                 noinform = 1;
 253                 ++argi;
 254             } else if (0 == strcmp(arg, "--core")) {
 255                 if (core) {
 256                     lose("more than one core file specified\n");
 257                 } else {
 258                     ++argi;
 259                     if (argi >= argc) {
 260                         lose("missing filename for --core argument\n");
 261                     }
 262                     core = copied_string(argv[argi]);
 263                     ++argi;
 264                 }
 265             } else if (0 == strcmp(arg, "--help")) {
 266                 /* I think this is the (or a) usual convention: upon
 267                  * seeing "--help" we immediately print our help
 268                  * string and exit, ignoring everything else. */
 269                 print_help();
 270                 exit(0);
 271             } else if (0 == strcmp(arg, "--version")) {
 272                 /* As in "--help" case, I think this is expected. */
 273                 print_version();
 274                 exit(0);
 275             } else if (0 == strcmp(arg, "--dynamic-space-size")) {
 276                 ++argi;
 277                 if (argi >= argc)
 278                     lose("missing argument for --dynamic-space-size");
 279                 errno = 0;
 280                 dynamic_space_size = strtol(argv[argi++], 0, 0) << 20;
 281                 if (errno)
 282                     lose("argument to --dynamic-space-size is not a number");
 283             } else if (0 == strcmp(arg, "--control-stack-size")) {
 284                 ++argi;
 285                 if (argi >= argc)
 286                     lose("missing argument for --control-stack-size");
 287                 errno = 0;
 288                 thread_control_stack_size = strtol(argv[argi++], 0, 0) << 20;
 289                 if (errno)
 290                     lose("argument to --dynamic-space-size is not a number");
 291             } else if (0 == strcmp(arg, "--debug-environment")) {
 292                 int n = 0;
 293                 printf("; Commandline arguments:\n");
 294                 while (n < argc) {
 295                     printf(";  %2d: \"%s\"\n", n, argv[n]);
 296                     ++n;
 297                 }
 298                 n = 0;
 299                 printf(";\n; Environment:\n");
 300                 while (ENVIRON[n]) {
 301                     printf(";  %2d: \"%s\"\n", n, ENVIRON[n]);
 302                     ++n;
 303                 }
 304                 ++argi;
 305             } else if (0 == strcmp(arg, "--end-runtime-options")) {
 306                 end_runtime_options = 1;
 307                 ++argi;
 308                 break;
 309             } else {
 310                 /* This option was unrecognized as a runtime option,
 311                  * so it must be a toplevel option or a user option,
 312                  * so we must be past the end of the runtime option
 313                  * section. */
 314                 break;
 315             }
 316         }
 317         /* This is where we strip out those options that we handle. We
 318          * also take this opportunity to make sure that we don't find
 319          * an out-of-place "--end-runtime-options" option. */
 320         {
 321             char *argi0 = argv[argi];
 322             int argj = 1;
 323             /* (argc - argi) for the arguments, one for the binary,
 324                and one for the terminating NULL. */
 325             sbcl_argv = successful_malloc((2 + argc - argi) * sizeof(char *));
 326             sbcl_argv[0] = argv[0];
 327             while (argi < argc) {
 328                 char *arg = argv[argi++];
 329                 /* If we encounter --end-runtime-options for the first
 330                  * time after the point where we had to give up on
 331                  * runtime options, then the point where we had to
 332                  * give up on runtime options must've been a user
 333                  * error. */
 334                 if (!end_runtime_options &&
 335                     0 == strcmp(arg, "--end-runtime-options")) {
 336                     lose("bad runtime option \"%s\"\n", argi0);
 337                 }
 338                 sbcl_argv[argj++] = arg;
 339             }
 340             sbcl_argv[argj] = 0;
 341         }
 342     }
 343
 344     /* Align down to multiple of page_table page size, and to the appropriate
 345      * stack alignment. */
 346     dynamic_space_size &= ~(PAGE_BYTES-1);
 347     thread_control_stack_size &= ~(CONTROL_STACK_ALIGNMENT_BYTES-1);
 348
 349     /* KLUDGE: os_vm_page_size is set by os_init(), and on some
 350      * systems (e.g. Alpha) arch_init() needs need os_vm_page_size, so
 351      * it must follow os_init(). -- WHN 2000-01-26 */
 352     os_init(argv, envp);
 353     arch_init();
 354     gc_init();
 355     validate();
 356
 357     /* If no core file was specified, look for one. */
 358     if (!core) {
 359        char *runtime_path = os_get_runtime_executable_path();
 360
 361        if (runtime_path) {
 362           os_vm_offset_t offset = search_for_embedded_core(runtime_path);
 363
 364           if (offset != -1) {
 365              embedded_core_offset = offset;
 366              core = runtime_path;
 367           } else {
 368              free(runtime_path);
 369              core = search_for_core();
 370           }
 371        } else {
 372           core = search_for_core();
 373        }
 374     }
 375
 376     /* Make sure that SBCL_HOME is set and not the empty string,
 377        unless loading an embedded core. */
 378     if (!(sbcl_home && *sbcl_home) && embedded_core_offset == 0) {
 379         char *envstring, *copied_core, *dir;
 380         char *stem = "SBCL_HOME=";
 381         copied_core = copied_string(core);
 382         dir = dirname(copied_core);
 383         envstring = (char *) calloc(strlen(stem) +
 384                                     strlen(dir) +
 385                                     1,
 386                                     sizeof(char));
 387         sprintf(envstring, "%s%s", stem, dir);
 388         putenv(envstring);
 389         free(copied_core);
 390     }
 391
 392     if (!noinform && embedded_core_offset == 0) {
 393         print_banner();
 394         fflush(stdout);
 395     }
 396
 397 #if defined(SVR4) || defined(__linux__)
 398     tzset();
 399 #endif
 400
 401     define_var("nil", NIL, 1);
 402     define_var("t", T, 1);
 403
 404     enable_lossage_handler();
 405
 406     globals_init();
 407
 408     initial_function = load_core_file(core, embedded_core_offset);
 409     if (initial_function == NIL) {
 410         lose("couldn't find initial function\n");
 411     }
 412
 413     gc_initialize_pointers();
 414
 415     arch_install_interrupt_handlers();
 416 #ifndef LISP_FEATURE_WIN32
 417     os_install_interrupt_handlers();
 418 #else
 419 /*     wos_install_interrupt_handlers(handler); */
 420     wos_install_interrupt_handlers(&exception_frame);
 421 #endif
 422
 423     /* Pass core filename and the processed argv into Lisp. They'll
 424      * need to be processed further there, to do locale conversion.
 425      */
 426     core_string = core;
 427     posix_argv = sbcl_argv;
 428
 429     FSHOW((stderr, "/funcalling initial_function=0x%lx\n",
 430           (unsigned long)initial_function));
 431 #ifdef LISP_FEATURE_WIN32
 432     fprintf(stderr, "\n\
 433 This is experimental prerelease support for the Windows platform: use\n\
 434 at your own risk.  \"Your Kitten of Death awaits!\"\n");
 435     fflush(stdout);
 436     fflush(stderr);
 437 #endif
 438     create_initial_thread(initial_function);
 439     lose("CATS.  CATS ARE NICE.\n");
 440     return 0;
 441 }