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 = 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 char **posix_argv;
 215 char *core_string;
 216
 217 \f
 218 int
 219 main(int argc, char *argv[], char *envp[])
 220 {
 221 #ifdef LISP_FEATURE_WIN32
 222     /* Exception handling support structure. Evil Win32 hack. */
 223     struct lisp_exception_frame exception_frame;
 224 #endif
 225
 226     /* the name of the core file we're to execute. Note that this is
 227      * a malloc'ed string which should be freed eventually. */
 228     char *core = 0;
 229     char **sbcl_argv = 0;
 230     os_vm_offset_t embedded_core_offset = 0;
 231
 232     /* other command line options */
 233     boolean noinform = 0;
 234     boolean end_runtime_options = 0;
 235
 236     lispobj initial_function;
 237     const char *sbcl_home = getenv("SBCL_HOME");
 238
 239     interrupt_init();
 240     block_blockable_signals();
 241
 242     setlocale(LC_ALL, "");
 243
 244     /* Parse our part of the command line (aka "runtime options"),
 245      * stripping out those options that we handle. */
 246     {
 247         int argi = 1;
 248         while (argi < argc) {
 249             char *arg = argv[argi];
 250             if (0 == strcmp(arg, "--noinform")) {
 251                 noinform = 1;
 252                 ++argi;
 253             } else if (0 == strcmp(arg, "--core")) {
 254                 if (core) {
 255                     lose("more than one core file specified\n");
 256                 } else {
 257                     ++argi;
 258                     if (argi >= argc) {
 259                         lose("missing filename for --core argument\n");
 260                     }
 261                     core = copied_string(argv[argi]);
 262                     ++argi;
 263                 }
 264             } else if (0 == strcmp(arg, "--help")) {
 265                 /* I think this is the (or a) usual convention: upon
 266                  * seeing "--help" we immediately print our help
 267                  * string and exit, ignoring everything else. */
 268                 print_help();
 269                 exit(0);
 270             } else if (0 == strcmp(arg, "--version")) {
 271                 /* As in "--help" case, I think this is expected. */
 272                 print_version();
 273                 exit(0);
 274             } else if (0 == strcmp(arg, "--dynamic-space-size")) {
 275                 ++argi;
 276                 if (argi >= argc)
 277                     lose("missing argument for --dynamic-space-size");
 278                 errno = 0;
 279                 dynamic_space_size = strtol(argv[argi++], 0, 0) << 20;
 280                 if (errno)
 281                     lose("argument to --dynamic-space-size is not a number");
 282             } else if (0 == strcmp(arg, "--debug-environment")) {
 283                 int n = 0;
 284                 printf("; Commandline arguments:\n");
 285                 while (n < argc) {
 286                     printf(";  %2d: \"%s\"\n", n, argv[n]);
 287                     ++n;
 288                 }
 289                 n = 0;
 290                 printf(";\n; Environment:\n");
 291                 while (ENVIRON[n]) {
 292                     printf(";  %2d: \"%s\"\n", n, ENVIRON[n]);
 293                     ++n;
 294                 }
 295                 ++argi;
 296             } else if (0 == strcmp(arg, "--end-runtime-options")) {
 297                 end_runtime_options = 1;
 298                 ++argi;
 299                 break;
 300             } else {
 301                 /* This option was unrecognized as a runtime option,
 302                  * so it must be a toplevel option or a user option,
 303                  * so we must be past the end of the runtime option
 304                  * section. */
 305                 break;
 306             }
 307         }
 308         /* This is where we strip out those options that we handle. We
 309          * also take this opportunity to make sure that we don't find
 310          * an out-of-place "--end-runtime-options" option. */
 311         {
 312             char *argi0 = argv[argi];
 313             int argj = 1;
 314             /* (argc - argi) for the arguments, one for the binary,
 315                and one for the terminating NULL. */
 316             sbcl_argv = successful_malloc((2 + argc - argi) * sizeof(char *));
 317             sbcl_argv[0] = argv[0];
 318             while (argi < argc) {
 319                 char *arg = argv[argi++];
 320                 /* If we encounter --end-runtime-options for the first
 321                  * time after the point where we had to give up on
 322                  * runtime options, then the point where we had to
 323                  * give up on runtime options must've been a user
 324                  * error. */
 325                 if (!end_runtime_options &&
 326                     0 == strcmp(arg, "--end-runtime-options")) {
 327                     lose("bad runtime option \"%s\"\n", argi0);
 328                 }
 329                 sbcl_argv[argj++] = arg;
 330             }
 331             sbcl_argv[argj] = 0;
 332         }
 333     }
 334
 335     /* Align down to multiple of page_table page size */
 336     dynamic_space_size &= ~(PAGE_BYTES - 1);
 337
 338     /* KLUDGE: os_vm_page_size is set by os_init(), and on some
 339      * systems (e.g. Alpha) arch_init() needs need os_vm_page_size, so
 340      * it must follow os_init(). -- WHN 2000-01-26 */
 341     os_init(argv, envp);
 342     arch_init();
 343     gc_init();
 344     validate();
 345
 346     /* If no core file was specified, look for one. */
 347     if (!core) {
 348        char *runtime_path = os_get_runtime_executable_path();
 349
 350        if (runtime_path) {
 351           os_vm_offset_t offset = search_for_embedded_core(runtime_path);
 352
 353           if (offset != -1) {
 354              embedded_core_offset = offset;
 355              core = runtime_path;
 356           } else {
 357              free(runtime_path);
 358              core = search_for_core();
 359           }
 360        } else {
 361           core = search_for_core();
 362        }
 363     }
 364
 365     /* Make sure that SBCL_HOME is set and not the empty string,
 366        unless loading an embedded core. */
 367     if (!(sbcl_home && *sbcl_home) && embedded_core_offset == 0) {
 368         char *envstring, *copied_core, *dir;
 369         char *stem = "SBCL_HOME=";
 370         copied_core = copied_string(core);
 371         dir = dirname(copied_core);
 372         envstring = (char *) calloc(strlen(stem) +
 373                                     strlen(dir) +
 374                                     1,
 375                                     sizeof(char));
 376         sprintf(envstring, "%s%s", stem, dir);
 377         putenv(envstring);
 378         free(copied_core);
 379     }
 380
 381     if (!noinform && embedded_core_offset == 0) {
 382         print_banner();
 383         fflush(stdout);
 384     }
 385
 386 #if defined(SVR4) || defined(__linux__)
 387     tzset();
 388 #endif
 389
 390     define_var("nil", NIL, 1);
 391     define_var("t", T, 1);
 392
 393     enable_lossage_handler();
 394
 395     globals_init();
 396
 397     initial_function = load_core_file(core, embedded_core_offset);
 398     if (initial_function == NIL) {
 399         lose("couldn't find initial function\n");
 400     }
 401
 402     gc_initialize_pointers();
 403
 404     arch_install_interrupt_handlers();
 405 #ifndef LISP_FEATURE_WIN32
 406     os_install_interrupt_handlers();
 407 #else
 408 /*     wos_install_interrupt_handlers(handler); */
 409     wos_install_interrupt_handlers(&exception_frame);
 410 #endif
 411
 412     /* Pass core filename and the processed argv into Lisp. They'll
 413      * need to be processed further there, to do locale conversion.
 414      */
 415     core_string = core;
 416     posix_argv = sbcl_argv;
 417
 418     FSHOW((stderr, "/funcalling initial_function=0x%lx\n",
 419           (unsigned long)initial_function));
 420 #ifdef LISP_FEATURE_WIN32
 421     fprintf(stderr, "\n\
 422 This is experimental prerelease support for the Windows platform: use\n\
 423 at your own risk.  \"Your Kitten of Death awaits!\"\n");
 424     fflush(stdout);
 425     fflush(stderr);
 426 #endif
 427     create_initial_thread(initial_function);
 428     lose("CATS.  CATS ARE NICE.\n");
 429     return 0;
 430 }