2 * main() entry point for a stand-alone SBCL image
6 * This software is part of the SBCL system. See the README file for
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.
21 #ifndef LISP_FEATURE_WIN32
24 #include <sys/types.h>
25 #ifndef LISP_FEATURE_WIN32
31 #include <sys/param.h>
34 #ifndef LISP_FEATURE_WIN32
41 #if defined(SVR4) || defined(__linux__)
45 #if !(defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THREAD))
55 #include "interrupt.h"
64 #include "genesis/static-symbols.h"
65 #include "genesis/symbol.h"
74 #define SBCL_HOME SBCL_PREFIX"/lib/sbcl/"
77 #ifdef LISP_FEATURE_HPUX
78 extern void *return_from_lisp_stub;
79 #include "genesis/closure.h"
80 #include "genesis/simple-fun.h"
84 /* SIGINT handler that invokes the monitor (for when Lisp isn't up to it) */
86 sigint_handler(int signal, siginfo_t *info, os_context_t *context)
88 lose("\nSIGINT hit at 0x%08lX\n",
89 (unsigned long) *os_context_pc_addr(context));
92 /* (This is not static, because we want to be able to call it from
97 SHOW("entering sigint_init()");
98 install_handler(SIGINT, sigint_handler);
99 SHOW("leaving sigint_init()");
103 * helper functions for dealing with command line args
107 successful_malloc(size_t size)
109 void* result = malloc(size);
111 lose("malloc failure\n");
115 return (void *) NULL; /* dummy value: return something ... */
119 copied_string(char *string)
121 return strcpy(successful_malloc(1+strlen(string)), string);
125 copied_existing_filename_or_null(char *filename)
127 struct stat filename_stat;
128 if (stat(filename, &filename_stat)) { /* if failure */
131 return copied_string(filename);
135 #ifndef LISP_FEATURE_WIN32
137 copied_realpath(const char *pathname)
142 /* realpath() supposedly can't be counted on to always return
143 * an absolute path, so we prepend the cwd to relative paths */
145 if (pathname[0] != '/') {
146 messy = successful_malloc(PATH_MAX + 1);
147 if (getcwd(messy, PATH_MAX + 1) == NULL) {
152 snprintf(messy + len, PATH_MAX + 1 - len, "/%s", pathname);
155 tidy = successful_malloc(PATH_MAX + 1);
156 if (realpath((messy ? messy : pathname), tidy) == NULL) {
164 #endif /* LISP_FEATURE_WIN32 */
166 /* miscellaneous chattiness */
172 "Usage: sbcl [runtime-options] [toplevel-options] [user-options]\n\
173 Common runtime options:\n\
174 --help Print this message and exit.\n\
175 --version Print version information and exit.\n\
176 --core <filename> Use the specified core file instead of the default.\n\
177 --dynamic-space-size <MiB> Size of reserved dynamic space in megabytes.\n\
178 --control-stack-size <MiB> Size of reserved control stack in megabytes.\n\
180 Common toplevel options:\n\
181 --sysinit <filename> System-wide init-file to use instead of default.\n\
182 --userinit <filename> Per-user init-file to use instead of default.\n\
183 --no-sysinit Inhibit processing of any system-wide init-file.\n\
184 --no-userinit Inhibit processing of any per-user init-file.\n\
185 --disable-debugger Invoke sb-ext:disable-debugger.\n\
186 --noprint Run a Read-Eval Loop without printing results.\n\
187 --script [<filename>] Skip #! line, disable debugger, avoid verbosity.\n\
188 --quit Exit with code 0 after option processing.\n\
189 --non-interactive Sets both --quit and --disable-debugger.\n\
190 Common toplevel options that are processed in order:\n\
191 --eval <form> Form to eval when processing this option.\n\
192 --load <filename> File to load when processing this option.\n\
194 User options are not processed by SBCL. All runtime options must\n\
195 appear before toplevel options, and all toplevel options must\n\
196 appear before user options.\n\
198 For more information please refer to the SBCL User Manual, which\n\
199 should be installed along with SBCL, and is also available from the\n\
200 website <http://www.sbcl.org/>.\n");
206 printf("SBCL %s\n", SBCL_VERSION_STRING);
213 "This is SBCL %s, an implementation of ANSI Common Lisp.\n\
214 More information about SBCL is available at <http://www.sbcl.org/>.\n\
216 SBCL is free software, provided as is, with absolutely no warranty.\n\
217 It is mostly in the public domain; some portions are provided under\n\
218 BSD-style licenses. See the CREDITS and COPYING files in the\n\
219 distribution for more information.\n\
220 ", SBCL_VERSION_STRING);
223 /* Look for a core file to load, first in the directory named by the
224 * SBCL_HOME environment variable, then in a hardcoded default
225 * location. Returns a malloced copy of the core filename. */
229 char *sbcl_home = getenv("SBCL_HOME");
231 char *stem = "/sbcl.core";
234 if (!(sbcl_home && *sbcl_home)) sbcl_home = SBCL_HOME;
235 lookhere = (char *) calloc(strlen(sbcl_home) +
239 sprintf(lookhere, "%s%s", sbcl_home, stem);
240 core = copied_existing_filename_or_null(lookhere);
243 lose("can't find core file at %s\n", lookhere);
251 /* Try to find the path to an executable from argv[0], this is only
252 * used when os_get_runtime_executable_path() returns NULL */
253 #ifdef LISP_FEATURE_WIN32
255 search_for_executable(const char *argv0)
259 #else /* LISP_FEATURE_WIN32 */
261 search_for_executable(const char *argv0)
263 char *search, *start, *end, *buf;
265 /* If argv[0] contains a slash then it's probably an absolute path
266 * or relative to the current directory, so check if it exists. */
267 if (strchr(argv0, '/') != NULL && access(argv0, F_OK) == 0)
268 return copied_realpath(argv0);
270 /* Bail on an absolute path which doesn't exist */
274 /* Otherwise check if argv[0] exists relative to any directory in PATH */
275 search = getenv("PATH");
278 search = copied_string(search);
279 buf = successful_malloc(PATH_MAX + 1);
280 for (start = search; (end = strchr(start, ':')) != NULL; start = end + 1) {
282 snprintf(buf, PATH_MAX + 1, "%s/%s", start, argv0);
283 if (access(buf, F_OK) == 0) {
285 search = copied_realpath(buf);
295 #endif /* LISP_FEATURE_WIN32 */
298 parse_size_arg(char *arg, char *arg_name)
300 char *tail, *power_name;
303 res = strtoul(arg, &tail, 0);
306 lose("%s argument is not a number: %s", arg_name, arg);
307 } else if (tail[0]) {
309 power_name = copied_string(tail);
310 size = strlen(power_name);
311 for (i=0; i<size; i++)
312 power_name[i] = toupper(power_name[i]);
318 if ((0==strcmp("KB", power_name)) ||
319 (0==strcmp("KIB", power_name))) {
321 } else if ((0==strcmp("MB", power_name)) ||
322 (0==strcmp("MIB", power_name))) {
324 } else if ((0==strcmp("GB", power_name)) ||
325 (0==strcmp("GIB", power_name))) {
328 lose("%s argument has an unknown suffix: %s", arg_name, tail);
333 (res >= (SIZE_MAX >> power))) {
334 lose("%s argument is out of range: %s", arg_name, arg);
343 struct runtime_options *runtime_options;
345 char *saved_runtime_path = NULL;
346 #if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THREAD)
347 void pthreads_win32_init();
352 main(int argc, char *argv[], char *envp[])
354 #ifdef LISP_FEATURE_WIN32
355 /* Exception handling support structure. Evil Win32 hack. */
356 struct lisp_exception_frame exception_frame;
359 /* the name of the core file we're to execute. Note that this is
360 * a malloc'ed string which should be freed eventually. */
362 char **sbcl_argv = 0;
363 os_vm_offset_t embedded_core_offset = 0;
364 char *runtime_path = 0;
366 /* other command line options */
367 boolean noinform = 0;
368 boolean end_runtime_options = 0;
369 boolean disable_lossage_handler_p = 0;
371 lispobj initial_function;
372 const char *sbcl_home = getenv("SBCL_HOME");
374 #if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THREAD)
376 pthreads_win32_init();
380 block_blockable_signals(0, 0);
382 setlocale(LC_ALL, "");
384 runtime_options = NULL;
386 /* Save the argv[0] derived runtime path in case
387 * os_get_runtime_executable_path(1) isn't able to get an
388 * externally-usable path later on. */
389 saved_runtime_path = search_for_executable(argv[0]);
391 /* Check early to see if this executable has an embedded core,
392 * which also populates runtime_options if the core has runtime
394 runtime_path = os_get_runtime_executable_path(0);
395 if (runtime_path || saved_runtime_path) {
396 os_vm_offset_t offset = search_for_embedded_core(
397 runtime_path ? runtime_path : saved_runtime_path);
399 embedded_core_offset = offset;
400 core = (runtime_path ? runtime_path :
401 copied_string(saved_runtime_path));
409 /* Parse our part of the command line (aka "runtime options"),
410 * stripping out those options that we handle. */
411 if (runtime_options != NULL) {
412 dynamic_space_size = runtime_options->dynamic_space_size;
413 thread_control_stack_size = runtime_options->thread_control_stack_size;
418 runtime_options = successful_malloc(sizeof(struct runtime_options));
420 while (argi < argc) {
421 char *arg = argv[argi];
422 if (0 == strcmp(arg, "--script")) {
423 /* This is both a runtime and a toplevel option. As a
424 * runtime option, it is equivalent to --noinform.
425 * This exits, and does not increment argi, so that
426 * TOPLEVEL-INIT sees the option. */
428 end_runtime_options = 1;
429 disable_lossage_handler_p = 1;
430 lose_on_corruption_p = 1;
432 } else if (0 == strcmp(arg, "--noinform")) {
435 } else if (0 == strcmp(arg, "--core")) {
437 lose("more than one core file specified\n");
441 lose("missing filename for --core argument\n");
443 core = copied_string(argv[argi]);
446 } else if (0 == strcmp(arg, "--help")) {
447 /* I think this is the (or a) usual convention: upon
448 * seeing "--help" we immediately print our help
449 * string and exit, ignoring everything else. */
452 } else if (0 == strcmp(arg, "--version")) {
453 /* As in "--help" case, I think this is expected. */
456 } else if (0 == strcmp(arg, "--dynamic-space-size")) {
459 lose("missing argument for --dynamic-space-size");
460 dynamic_space_size = parse_size_arg(argv[argi++], "--dynamic-space-size");
461 # ifdef MAX_DYNAMIC_SPACE_END
462 if (!((DYNAMIC_SPACE_START <
463 DYNAMIC_SPACE_START+dynamic_space_size) &&
464 (DYNAMIC_SPACE_START+dynamic_space_size <=
465 MAX_DYNAMIC_SPACE_END)))
466 lose("--dynamic-space-size argument %s is too large, max %lu",
467 argv[argi-1], MAX_DYNAMIC_SPACE_END-DYNAMIC_SPACE_START);
469 } else if (0 == strcmp(arg, "--control-stack-size")) {
472 lose("missing argument for --control-stack-size");
474 thread_control_stack_size = parse_size_arg(argv[argi++], "--control-stack-size");
475 } else if (0 == strcmp(arg, "--debug-environment")) {
477 printf("; Commandline arguments:\n");
479 printf("; %2d: \"%s\"\n", n, argv[n]);
483 printf(";\n; Environment:\n");
485 printf("; %2d: \"%s\"\n", n, ENVIRON[n]);
489 } else if (0 == strcmp(arg, "--disable-ldb")) {
490 disable_lossage_handler_p = 1;
492 } else if (0 == strcmp(arg, "--lose-on-corruption")) {
493 lose_on_corruption_p = 1;
495 } else if (0 == strcmp(arg, "--end-runtime-options")) {
496 end_runtime_options = 1;
499 } else if (0 == strcmp(arg, "--merge-core-pages")) {
501 merge_core_pages = 1;
502 } else if (0 == strcmp(arg, "--no-merge-core-pages")) {
504 merge_core_pages = 0;
505 } else if (0 == strcmp(arg, "--default-merge-core-pages")) {
507 merge_core_pages = -1;
509 /* This option was unrecognized as a runtime option,
510 * so it must be a toplevel option or a user option,
511 * so we must be past the end of the runtime option
516 /* This is where we strip out those options that we handle. We
517 * also take this opportunity to make sure that we don't find
518 * an out-of-place "--end-runtime-options" option. */
520 char *argi0 = argv[argi];
522 /* (argc - argi) for the arguments, one for the binary,
523 and one for the terminating NULL. */
524 sbcl_argv = successful_malloc((2 + argc - argi) * sizeof(char *));
525 sbcl_argv[0] = argv[0];
526 while (argi < argc) {
527 char *arg = argv[argi++];
528 /* If we encounter --end-runtime-options for the first
529 * time after the point where we had to give up on
530 * runtime options, then the point where we had to
531 * give up on runtime options must've been a user
533 if (!end_runtime_options &&
534 0 == strcmp(arg, "--end-runtime-options")) {
535 lose("bad runtime option \"%s\"\n", argi0);
537 sbcl_argv[argj++] = arg;
543 /* Align down to multiple of page_table page size, and to the appropriate
544 * stack alignment. */
545 dynamic_space_size &= ~(sword_t)(PAGE_BYTES-1);
546 #ifdef LISP_FEATURE_GENCGC
547 dynamic_space_size &= ~(sword_t)(GENCGC_CARD_BYTES-1);
549 thread_control_stack_size &= ~(sword_t)(CONTROL_STACK_ALIGNMENT_BYTES-1);
551 /* Preserve the runtime options for possible future core saving */
552 runtime_options->dynamic_space_size = dynamic_space_size;
553 runtime_options->thread_control_stack_size = thread_control_stack_size;
555 /* KLUDGE: os_vm_page_size is set by os_init(), and on some
556 * systems (e.g. Alpha) arch_init() needs need os_vm_page_size, so
557 * it must follow os_init(). -- WHN 2000-01-26 */
559 dyndebug_init(); /* after os_init: do not print output before execve */
564 /* If no core file was specified, look for one. */
566 core = search_for_core();
569 /* Make sure that SBCL_HOME is set and not the empty string,
570 unless loading an embedded core. */
571 if (!(sbcl_home && *sbcl_home) && embedded_core_offset == 0) {
572 char *envstring, *copied_core, *dir;
573 char *stem = "SBCL_HOME=";
574 copied_core = copied_string(core);
575 dir = dirname(copied_core);
576 envstring = (char *) calloc(strlen(stem) +
580 sprintf(envstring, "%s%s", stem, dir);
585 if (!noinform && embedded_core_offset == 0) {
590 if (embedded_core_offset == 0) {
591 /* Here we make a last attempt at recognizing an embedded core,
592 * so that a file with an embedded core is a valid argument to
593 * --core. We take care that any decisions on special behaviour
594 * (suppressed banner, embedded options) have already been made
595 * before we reach this block, so that there is no observable
596 * difference between "embedded" and "bare" images given to
598 os_vm_offset_t offset = search_for_embedded_core(core);
600 embedded_core_offset = offset;
603 #if defined(SVR4) || defined(__linux__) || defined(__NetBSD__)
607 define_var("nil", NIL, 1);
608 define_var("t", T, 1);
610 if (!disable_lossage_handler_p)
611 enable_lossage_handler();
615 initial_function = load_core_file(core, embedded_core_offset);
616 if (initial_function == NIL) {
617 lose("couldn't find initial function\n");
619 #ifdef LISP_FEATURE_SB_DYNAMIC_CORE
622 #ifdef LISP_FEATURE_HPUX
623 /* -1 = CLOSURE_FUN_OFFSET, 23 = SIMPLE_FUN_CODE_OFFSET, we are
624 * not in LANGUAGE_ASSEMBLY so we cant reach them. */
625 return_from_lisp_stub = (void *) ((char *)*((unsigned long *)
626 ((char *)initial_function + -1)) + 23);
629 gc_initialize_pointers();
631 arch_install_interrupt_handlers();
632 #ifndef LISP_FEATURE_WIN32
633 os_install_interrupt_handlers();
635 /* wos_install_interrupt_handlers(handler); */
636 wos_install_interrupt_handlers(&exception_frame);
639 /* Pass core filename and the processed argv into Lisp. They'll
640 * need to be processed further there, to do locale conversion.
643 posix_argv = sbcl_argv;
645 FSHOW((stderr, "/funcalling initial_function=0x%lx\n",
646 (unsigned long)initial_function));
647 #ifdef LISP_FEATURE_WIN32
649 This is experimental prerelease support for the Windows platform: use\n\
650 at your own risk. \"Your Kitten of Death awaits!\"\n");
654 create_initial_thread(initial_function);
655 lose("CATS. CATS ARE NICE.\n");