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