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 \n\
 151 Common toplevel options:\n\
 152   --sysinit <filename>       System-wide init-file to use instead of default.\n\
 153   --userinit <filename>      Per-user init-file to use instead of default.\n\
 154   --no-sysinit               Inhibit processing of any system-wide init-file.\n\
 155   --no-userinit              Inhibit processing of any per-user init-file.\n\
 156 \n\
 157 User options are not processed by SBCL. All runtime options must\n\
 158 appear before toplevel options, and all toplevel options must\n\
 159 appear before user options.\n\
 160 \n\
 161 For more information please refer to the SBCL User Manual, which\n\
 162 should be installed along with SBCL, and is also available from the\n\
 163 website <http://www.sbcl.org/>.\n");
 164 }
 165
 166 void
 167 print_version()
 168 {
 169     printf("SBCL %s\n", SBCL_VERSION_STRING);
 170 }
 171
 172 void
 173 print_banner()
 174 {
 175     printf(
 176 "This is SBCL %s, an implementation of ANSI Common Lisp.\n\
 177 More information about SBCL is available at <http://www.sbcl.org/>.\n\
 178 \n\
 179 SBCL is free software, provided as is, with absolutely no warranty.\n\
 180 It is mostly in the public domain; some portions are provided under\n\
 181 BSD-style licenses.  See the CREDITS and COPYING files in the\n\
 182 distribution for more information.\n\
 183 ", SBCL_VERSION_STRING);
 184 }
 185
 186 /* Look for a core file to load, first in the directory named by the
 187  * SBCL_HOME environment variable, then in a hardcoded default
 188  * location.  Returns a malloced copy of the core filename. */
 189 char *
 190 search_for_core ()
 191 {
 192     char *sbcl_home = getenv("SBCL_HOME");
 193     char *lookhere;
 194     char *stem = "/sbcl.core";
 195     char *core;
 196
 197     if(!sbcl_home) sbcl_home = SBCL_HOME;
 198     lookhere = (char *) calloc(strlen(sbcl_home) +
 199                                strlen(stem) +
 200                                1,
 201                                sizeof(char));
 202     sprintf(lookhere, "%s%s", sbcl_home, stem);
 203     core = copied_existing_filename_or_null(lookhere);
 204
 205     if (!core) {
 206         lose("can't find core file at %s\n", lookhere);
 207     }
 208
 209     free(lookhere);
 210
 211     return core;
 212 }
 213
 214  \f
 215 int
 216 main(int argc, char *argv[], char *envp[])
 217 {
 218 #ifdef LISP_FEATURE_WIN32
 219     /* Exception handling support structure. Evil Win32 hack. */
 220     struct lisp_exception_frame exception_frame;
 221 #endif
 222
 223     /* the name of the core file we're to execute. Note that this is
 224      * a malloc'ed string which should be freed eventually. */
 225     char *core = 0;
 226     char **sbcl_argv = 0;
 227     os_vm_offset_t embedded_core_offset = 0;
 228
 229     /* other command line options */
 230     boolean noinform = 0;
 231     boolean end_runtime_options = 0;
 232
 233     lispobj initial_function;
 234
 235     interrupt_init();
 236     block_blockable_signals();
 237
 238     setlocale(LC_ALL, "");
 239
 240     /* Parse our part of the command line (aka "runtime options"),
 241      * stripping out those options that we handle. */
 242     {
 243         int argi = 1;
 244         while (argi < argc) {
 245             char *arg = argv[argi];
 246             if (0 == strcmp(arg, "--noinform")) {
 247                 noinform = 1;
 248                 ++argi;
 249             } else if (0 == strcmp(arg, "--core")) {
 250                 if (core) {
 251                     lose("more than one core file specified\n");
 252                 } else {
 253                     ++argi;
 254                     if (argi >= argc) {
 255                         lose("missing filename for --core argument\n");
 256                     }
 257                     core = copied_string(argv[argi]);
 258                     ++argi;
 259                 }
 260             } else if (0 == strcmp(arg, "--help")) {
 261                 /* I think this is the (or a) usual convention: upon
 262                  * seeing "--help" we immediately print our help
 263                  * string and exit, ignoring everything else. */
 264                 print_help();
 265                 exit(0);
 266             } else if (0 == strcmp(arg, "--version")) {
 267                 /* As in "--help" case, I think this is expected. */
 268                 print_version();
 269                 exit(0);
 270             } else if (0 == strcmp(arg, "--dynamic-space-size")) {
 271                 ++argi;
 272                 if (argi >= argc)
 273                     lose("missing argument for --dynamic-space-size");
 274                 errno = 0;
 275                 dynamic_space_size = strtol(argv[argi++], 0, 0) << 20;
 276                 if (errno)
 277                     lose("argument to --dynamic-space-size is not a number");
 278             } else if (0 == strcmp(arg, "--debug-environment")) {
 279                 int n = 0;
 280                 printf("; Commandline arguments:\n");
 281                 while (n < argc) {
 282                     printf(";  %2d: \"%s\"\n", n, argv[n]);
 283                     ++n;
 284                 }
 285                 n = 0;
 286                 printf(";\n; Environment:\n");
 287                 while (ENVIRON[n]) {
 288                     printf(";  %2d: \"%s\"\n", n, ENVIRON[n]);
 289                     ++n;
 290                 }
 291                 ++argi;
 292             } else if (0 == strcmp(arg, "--end-runtime-options")) {
 293                 end_runtime_options = 1;
 294                 ++argi;
 295                 break;
 296             } else {
 297                 /* This option was unrecognized as a runtime option,
 298                  * so it must be a toplevel option or a user option,
 299                  * so we must be past the end of the runtime option
 300                  * section. */
 301                 break;
 302             }
 303         }
 304         /* This is where we strip out those options that we handle. We
 305          * also take this opportunity to make sure that we don't find
 306          * an out-of-place "--end-runtime-options" option. */
 307         {
 308             char *argi0 = argv[argi];
 309             int argj = 1;
 310             /* (argc - argi) for the arguments, one for the binary,
 311                and one for the terminating NULL. */
 312             sbcl_argv = successful_malloc((2 + argc - argi) * sizeof(char *));
 313             sbcl_argv[0] = argv[0];
 314             while (argi < argc) {
 315                 char *arg = argv[argi++];
 316                 /* If we encounter --end-runtime-options for the first
 317                  * time after the point where we had to give up on
 318                  * runtime options, then the point where we had to
 319                  * give up on runtime options must've been a user
 320                  * error. */
 321                 if (!end_runtime_options &&
 322                     0 == strcmp(arg, "--end-runtime-options")) {
 323                     lose("bad runtime option \"%s\"\n", argi0);
 324                 }
 325                 sbcl_argv[argj++] = arg;
 326             }
 327             sbcl_argv[argj] = 0;
 328         }
 329     }
 330
 331     /* Align down to multiple of page_table page size */
 332     dynamic_space_size = (dynamic_space_size/PAGE_BYTES) * PAGE_BYTES;
 333
 334     /* KLUDGE: os_vm_page_size is set by os_init(), and on some
 335      * systems (e.g. Alpha) arch_init() needs need os_vm_page_size, so
 336      * it must follow os_init(). -- WHN 2000-01-26 */
 337     os_init(argv, envp);
 338     arch_init();
 339     gc_init();
 340     validate();
 341
 342     /* If no core file was specified, look for one. */
 343     if (!core) {
 344        char *runtime_path = os_get_runtime_executable_path();
 345
 346        if (runtime_path) {
 347           os_vm_offset_t offset = search_for_embedded_core(runtime_path);
 348
 349           if (offset != -1) {
 350              embedded_core_offset = offset;
 351              core = runtime_path;
 352           } else {
 353              free(runtime_path);
 354              core = search_for_core();
 355           }
 356        } else {
 357           core = search_for_core();
 358        }
 359     }
 360
 361     /* Make sure that SBCL_HOME is set, unless loading an embedded core. */
 362     if (!getenv("SBCL_HOME") && embedded_core_offset == 0) {
 363         char *envstring, *copied_core, *dir;
 364         char *stem = "SBCL_HOME=";
 365         copied_core = copied_string(core);
 366         dir = dirname(copied_core);
 367         envstring = (char *) calloc(strlen(stem) +
 368                                     strlen(dir) +
 369                                     1,
 370                                     sizeof(char));
 371         sprintf(envstring, "%s%s", stem, dir);
 372         putenv(envstring);
 373         free(copied_core);
 374     }
 375
 376     if (!noinform) {
 377         print_banner();
 378         fflush(stdout);
 379     }
 380
 381 #if defined(SVR4) || defined(__linux__)
 382     tzset();
 383 #endif
 384
 385     define_var("nil", NIL, 1);
 386     define_var("t", T, 1);
 387
 388     enable_lossage_handler();
 389
 390     globals_init();
 391
 392     initial_function = load_core_file(core, embedded_core_offset);
 393     if (initial_function == NIL) {
 394         lose("couldn't find initial function\n");
 395     }
 396
 397     gc_initialize_pointers();
 398
 399     arch_install_interrupt_handlers();
 400 #ifndef LISP_FEATURE_WIN32
 401     os_install_interrupt_handlers();
 402 #else
 403 /*     wos_install_interrupt_handlers(handler); */
 404     wos_install_interrupt_handlers(&exception_frame);
 405 #endif
 406
 407     /* Pass core filename into Lisp */
 408     SetSymbolValue(CORE_STRING, alloc_base_string(core),0);
 409     SHOW("freeing core");
 410     free(core);
 411
 412     /* Convert remaining argv values to something that Lisp can grok. */
 413     SHOW("setting POSIX-ARGV symbol value");
 414     SetSymbolValue(POSIX_ARGV, alloc_base_string_list(sbcl_argv),0);
 415     free(sbcl_argv);
 416
 417     FSHOW((stderr, "/funcalling initial_function=0x%lx\n",
 418           (unsigned long)initial_function));
 419 #ifdef LISP_FEATURE_WIN32
 420     fprintf(stderr, "\n\
 421 This is experimental prerelease support for the Windows platform: use\n\
 422 at your own risk.  \"Your Kitten of Death awaits!\"\n");
 423     fflush(stdout);
 424     fflush(stderr);
 425 #endif
 426     create_initial_thread(initial_function);
 427     lose("CATS.  CATS ARE NICE.\n");
 428     return 0;
 429 }