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 \f
 125 /* miscellaneous chattiness */
 126
 127 void
 128 print_help()
 129 {
 130     puts(
 131 "Usage: sbcl [runtime-options] [toplevel-options] [user-options]\n\
 132 Common runtime options:\n\
 133   --help                     Print this message and exit.\n\
 134   --version                  Print version information and exit.\n\
 135   --core <filename>          Use the specified core file instead of the default.\n\
 136   --dynamic-space-size <MiB> Size of reserved dynamic space in megabytes.\n\
 137   --control-stack-size <MiB> Size of reserved control stack in megabytes.\n\
 138 \n\
 139 Common toplevel options:\n\
 140   --sysinit <filename>       System-wide init-file to use instead of default.\n\
 141   --userinit <filename>      Per-user init-file to use instead of default.\n\
 142   --no-sysinit               Inhibit processing of any system-wide init-file.\n\
 143   --no-userinit              Inhibit processing of any per-user init-file.\n\
 144 \n\
 145 User options are not processed by SBCL. All runtime options must\n\
 146 appear before toplevel options, and all toplevel options must\n\
 147 appear before user options.\n\
 148 \n\
 149 For more information please refer to the SBCL User Manual, which\n\
 150 should be installed along with SBCL, and is also available from the\n\
 151 website <http://www.sbcl.org/>.\n");
 152 }
 153
 154 void
 155 print_version()
 156 {
 157     printf("SBCL %s\n", SBCL_VERSION_STRING);
 158 }
 159
 160 void
 161 print_banner()
 162 {
 163     printf(
 164 "This is SBCL %s, an implementation of ANSI Common Lisp.\n\
 165 More information about SBCL is available at <http://www.sbcl.org/>.\n\
 166 \n\
 167 SBCL is free software, provided as is, with absolutely no warranty.\n\
 168 It is mostly in the public domain; some portions are provided under\n\
 169 BSD-style licenses.  See the CREDITS and COPYING files in the\n\
 170 distribution for more information.\n\
 171 ", SBCL_VERSION_STRING);
 172 }
 173
 174 /* Look for a core file to load, first in the directory named by the
 175  * SBCL_HOME environment variable, then in a hardcoded default
 176  * location.  Returns a malloced copy of the core filename. */
 177 char *
 178 search_for_core ()
 179 {
 180     char *sbcl_home = getenv("SBCL_HOME");
 181     char *lookhere;
 182     char *stem = "/sbcl.core";
 183     char *core;
 184
 185     if (!(sbcl_home && *sbcl_home)) sbcl_home = SBCL_HOME;
 186     lookhere = (char *) calloc(strlen(sbcl_home) +
 187                                strlen(stem) +
 188                                1,
 189                                sizeof(char));
 190     sprintf(lookhere, "%s%s", sbcl_home, stem);
 191     core = copied_existing_filename_or_null(lookhere);
 192
 193     if (!core) {
 194         lose("can't find core file at %s\n", lookhere);
 195     }
 196
 197     free(lookhere);
 198
 199     return core;
 200 }
 201
 202 char **posix_argv;
 203 char *core_string;
 204
 205 \f
 206 int
 207 main(int argc, char *argv[], char *envp[])
 208 {
 209 #ifdef LISP_FEATURE_WIN32
 210     /* Exception handling support structure. Evil Win32 hack. */
 211     struct lisp_exception_frame exception_frame;
 212 #endif
 213
 214     /* the name of the core file we're to execute. Note that this is
 215      * a malloc'ed string which should be freed eventually. */
 216     char *core = 0;
 217     char **sbcl_argv = 0;
 218     os_vm_offset_t embedded_core_offset = 0;
 219
 220     /* other command line options */
 221     boolean noinform = 0;
 222     boolean end_runtime_options = 0;
 223
 224     lispobj initial_function;
 225     const char *sbcl_home = getenv("SBCL_HOME");
 226
 227     interrupt_init();
 228     block_blockable_signals();
 229
 230     setlocale(LC_ALL, "");
 231
 232     /* Parse our part of the command line (aka "runtime options"),
 233      * stripping out those options that we handle. */
 234     {
 235         int argi = 1;
 236         while (argi < argc) {
 237             char *arg = argv[argi];
 238             if (0 == strcmp(arg, "--noinform")) {
 239                 noinform = 1;
 240                 ++argi;
 241             } else if (0 == strcmp(arg, "--core")) {
 242                 if (core) {
 243                     lose("more than one core file specified\n");
 244                 } else {
 245                     ++argi;
 246                     if (argi >= argc) {
 247                         lose("missing filename for --core argument\n");
 248                     }
 249                     core = copied_string(argv[argi]);
 250                     ++argi;
 251                 }
 252             } else if (0 == strcmp(arg, "--help")) {
 253                 /* I think this is the (or a) usual convention: upon
 254                  * seeing "--help" we immediately print our help
 255                  * string and exit, ignoring everything else. */
 256                 print_help();
 257                 exit(0);
 258             } else if (0 == strcmp(arg, "--version")) {
 259                 /* As in "--help" case, I think this is expected. */
 260                 print_version();
 261                 exit(0);
 262             } else if (0 == strcmp(arg, "--dynamic-space-size")) {
 263                 ++argi;
 264                 if (argi >= argc)
 265                     lose("missing argument for --dynamic-space-size");
 266                 errno = 0;
 267                 dynamic_space_size = strtol(argv[argi++], 0, 0) << 20;
 268                 if (errno)
 269                     lose("argument to --dynamic-space-size is not a number");
 270             } else if (0 == strcmp(arg, "--control-stack-size")) {
 271                 ++argi;
 272                 if (argi >= argc)
 273                     lose("missing argument for --control-stack-size");
 274                 errno = 0;
 275                 thread_control_stack_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, and to the appropriate
 332      * stack alignment. */
 333     dynamic_space_size &= ~(PAGE_BYTES-1);
 334     thread_control_stack_size &= ~(CONTROL_STACK_ALIGNMENT_BYTES-1);
 335
 336     /* KLUDGE: os_vm_page_size is set by os_init(), and on some
 337      * systems (e.g. Alpha) arch_init() needs need os_vm_page_size, so
 338      * it must follow os_init(). -- WHN 2000-01-26 */
 339     os_init(argv, envp);
 340     arch_init();
 341     gc_init();
 342     validate();
 343
 344     /* If no core file was specified, look for one. */
 345     if (!core) {
 346        char *runtime_path = os_get_runtime_executable_path();
 347
 348        if (runtime_path) {
 349           os_vm_offset_t offset = search_for_embedded_core(runtime_path);
 350
 351           if (offset != -1) {
 352              embedded_core_offset = offset;
 353              core = runtime_path;
 354           } else {
 355              free(runtime_path);
 356              core = search_for_core();
 357           }
 358        } else {
 359           core = search_for_core();
 360        }
 361     }
 362
 363     /* Make sure that SBCL_HOME is set and not the empty string,
 364        unless loading an embedded core. */
 365     if (!(sbcl_home && *sbcl_home) && embedded_core_offset == 0) {
 366         char *envstring, *copied_core, *dir;
 367         char *stem = "SBCL_HOME=";
 368         copied_core = copied_string(core);
 369         dir = dirname(copied_core);
 370         envstring = (char *) calloc(strlen(stem) +
 371                                     strlen(dir) +
 372                                     1,
 373                                     sizeof(char));
 374         sprintf(envstring, "%s%s", stem, dir);
 375         putenv(envstring);
 376         free(copied_core);
 377     }
 378
 379     if (!noinform && embedded_core_offset == 0) {
 380         print_banner();
 381         fflush(stdout);
 382     }
 383
 384 #if defined(SVR4) || defined(__linux__)
 385     tzset();
 386 #endif
 387
 388     define_var("nil", NIL, 1);
 389     define_var("t", T, 1);
 390
 391     enable_lossage_handler();
 392
 393     globals_init();
 394
 395     initial_function = load_core_file(core, embedded_core_offset);
 396     if (initial_function == NIL) {
 397         lose("couldn't find initial function\n");
 398     }
 399
 400     gc_initialize_pointers();
 401
 402     arch_install_interrupt_handlers();
 403 #ifndef LISP_FEATURE_WIN32
 404     os_install_interrupt_handlers();
 405 #else
 406 /*     wos_install_interrupt_handlers(handler); */
 407     wos_install_interrupt_handlers(&exception_frame);
 408 #endif
 409
 410     /* Pass core filename and the processed argv into Lisp. They'll
 411      * need to be processed further there, to do locale conversion.
 412      */
 413     core_string = core;
 414     posix_argv = sbcl_argv;
 415
 416     FSHOW((stderr, "/funcalling initial_function=0x%lx\n",
 417           (unsigned long)initial_function));
 418 #ifdef LISP_FEATURE_WIN32
 419     fprintf(stderr, "\n\
 420 This is experimental prerelease support for the Windows platform: use\n\
 421 at your own risk.  \"Your Kitten of Death awaits!\"\n");
 422     fflush(stdout);
 423     fflush(stderr);
 424 #endif
 425     create_initial_thread(initial_function);
 426     lose("CATS.  CATS ARE NICE.\n");
 427     return 0;
 428 }