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