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 */
297 unsigned long parse_size_arg(char *arg, char *arg_name)
299 char *tail, *power_name;
300 unsigned long power, res;
302 res = strtoul(arg, &tail, 0);
305 lose("%s argument is not a number: %s", arg_name, arg);
306 } else if (tail[0]) {
308 power_name = copied_string(tail);
309 size = strlen(power_name);
310 for (i=0; i<size; i++)
311 power_name[i] = toupper(power_name[i]);
317 if ((0==strcmp("KB", power_name)) ||
318 (0==strcmp("KIB", power_name))) {
320 } else if ((0==strcmp("MB", power_name)) ||
321 (0==strcmp("MIB", power_name))) {
323 } else if ((0==strcmp("GB", power_name)) ||
324 (0==strcmp("GIB", power_name))) {
327 lose("%s argument has an unknown suffix: %s", arg_name, tail);
332 (res > (ULONG_MAX >> power))) {
333 lose("%s argument is out of range: %s", arg_name, arg);
342 struct runtime_options *runtime_options;
344 char *saved_runtime_path = NULL;
345 #if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THREAD)
346 void pthreads_win32_init();
351 main(int argc, char *argv[], char *envp[])
353 #ifdef LISP_FEATURE_WIN32
354 /* Exception handling support structure. Evil Win32 hack. */
355 struct lisp_exception_frame exception_frame;
358 /* the name of the core file we're to execute. Note that this is
359 * a malloc'ed string which should be freed eventually. */
361 char **sbcl_argv = 0;
362 os_vm_offset_t embedded_core_offset = 0;
363 char *runtime_path = 0;
365 /* other command line options */
366 boolean noinform = 0;
367 boolean end_runtime_options = 0;
368 boolean disable_lossage_handler_p = 0;
370 lispobj initial_function;
371 const char *sbcl_home = getenv("SBCL_HOME");
373 #if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THREAD)
375 pthreads_win32_init();
379 block_blockable_signals(0, 0);
381 setlocale(LC_ALL, "");
383 runtime_options = NULL;
385 /* Save the argv[0] derived runtime path in case
386 * os_get_runtime_executable_path(1) isn't able to get an
387 * externally-usable path later on. */
388 saved_runtime_path = search_for_executable(argv[0]);
390 /* Check early to see if this executable has an embedded core,
391 * which also populates runtime_options if the core has runtime
393 runtime_path = os_get_runtime_executable_path(0);
394 if (runtime_path || saved_runtime_path) {
395 os_vm_offset_t offset = search_for_embedded_core(
396 runtime_path ? runtime_path : saved_runtime_path);
398 embedded_core_offset = offset;
399 core = (runtime_path ? runtime_path :
400 copied_string(saved_runtime_path));
408 /* Parse our part of the command line (aka "runtime options"),
409 * stripping out those options that we handle. */
410 if (runtime_options != NULL) {
411 dynamic_space_size = runtime_options->dynamic_space_size;
412 thread_control_stack_size = runtime_options->thread_control_stack_size;
417 runtime_options = successful_malloc(sizeof(struct runtime_options));
419 while (argi < argc) {
420 char *arg = argv[argi];
421 if (0 == strcmp(arg, "--script")) {
422 /* This is both a runtime and a toplevel option. As a
423 * runtime option, it is equivalent to --noinform.
424 * This exits, and does not increment argi, so that
425 * TOPLEVEL-INIT sees the option. */
427 end_runtime_options = 1;
428 disable_lossage_handler_p = 1;
429 lose_on_corruption_p = 1;
431 } else if (0 == strcmp(arg, "--noinform")) {
434 } else if (0 == strcmp(arg, "--core")) {
436 lose("more than one core file specified\n");
440 lose("missing filename for --core argument\n");
442 core = copied_string(argv[argi]);
445 } else if (0 == strcmp(arg, "--help")) {
446 /* I think this is the (or a) usual convention: upon
447 * seeing "--help" we immediately print our help
448 * string and exit, ignoring everything else. */
451 } else if (0 == strcmp(arg, "--version")) {
452 /* As in "--help" case, I think this is expected. */
455 } else if (0 == strcmp(arg, "--dynamic-space-size")) {
458 lose("missing argument for --dynamic-space-size");
459 dynamic_space_size = parse_size_arg(argv[argi++], "--dynamic-space-size");
460 # ifdef MAX_DYNAMIC_SPACE_END
461 if (!((DYNAMIC_SPACE_START <
462 DYNAMIC_SPACE_START+dynamic_space_size) &&
463 (DYNAMIC_SPACE_START+dynamic_space_size <=
464 MAX_DYNAMIC_SPACE_END)))
465 lose("--dynamic-space-size argument %s is too large, max %lu",
466 argv[argi-1], MAX_DYNAMIC_SPACE_END-DYNAMIC_SPACE_START);
468 } else if (0 == strcmp(arg, "--control-stack-size")) {
471 lose("missing argument for --control-stack-size");
473 thread_control_stack_size = parse_size_arg(argv[argi++], "--control-stack-size");
474 } else if (0 == strcmp(arg, "--debug-environment")) {
476 printf("; Commandline arguments:\n");
478 printf("; %2d: \"%s\"\n", n, argv[n]);
482 printf(";\n; Environment:\n");
484 printf("; %2d: \"%s\"\n", n, ENVIRON[n]);
488 } else if (0 == strcmp(arg, "--disable-ldb")) {
489 disable_lossage_handler_p = 1;
491 } else if (0 == strcmp(arg, "--lose-on-corruption")) {
492 lose_on_corruption_p = 1;
494 } else if (0 == strcmp(arg, "--end-runtime-options")) {
495 end_runtime_options = 1;
498 } else if (0 == strcmp(arg, "--merge-core-pages")) {
500 merge_core_pages = 1;
501 } else if (0 == strcmp(arg, "--no-merge-core-pages")) {
503 merge_core_pages = 0;
504 } else if (0 == strcmp(arg, "--default-merge-core-pages")) {
506 merge_core_pages = -1;
508 /* This option was unrecognized as a runtime option,
509 * so it must be a toplevel option or a user option,
510 * so we must be past the end of the runtime option
515 /* This is where we strip out those options that we handle. We
516 * also take this opportunity to make sure that we don't find
517 * an out-of-place "--end-runtime-options" option. */
519 char *argi0 = argv[argi];
521 /* (argc - argi) for the arguments, one for the binary,
522 and one for the terminating NULL. */
523 sbcl_argv = successful_malloc((2 + argc - argi) * sizeof(char *));
524 sbcl_argv[0] = argv[0];
525 while (argi < argc) {
526 char *arg = argv[argi++];
527 /* If we encounter --end-runtime-options for the first
528 * time after the point where we had to give up on
529 * runtime options, then the point where we had to
530 * give up on runtime options must've been a user
532 if (!end_runtime_options &&
533 0 == strcmp(arg, "--end-runtime-options")) {
534 lose("bad runtime option \"%s\"\n", argi0);
536 sbcl_argv[argj++] = arg;
542 /* Align down to multiple of page_table page size, and to the appropriate
543 * stack alignment. */
544 dynamic_space_size &= ~(PAGE_BYTES-1);
545 #ifdef LISP_FEATURE_GENCGC
546 dynamic_space_size &= ~(GENCGC_CARD_BYTES-1);
548 thread_control_stack_size &= ~(CONTROL_STACK_ALIGNMENT_BYTES-1);
550 /* Preserve the runtime options for possible future core saving */
551 runtime_options->dynamic_space_size = dynamic_space_size;
552 runtime_options->thread_control_stack_size = thread_control_stack_size;
554 /* KLUDGE: os_vm_page_size is set by os_init(), and on some
555 * systems (e.g. Alpha) arch_init() needs need os_vm_page_size, so
556 * it must follow os_init(). -- WHN 2000-01-26 */
558 dyndebug_init(); /* after os_init: do not print output before execve */
563 /* If no core file was specified, look for one. */
565 core = search_for_core();
568 /* Make sure that SBCL_HOME is set and not the empty string,
569 unless loading an embedded core. */
570 if (!(sbcl_home && *sbcl_home) && embedded_core_offset == 0) {
571 char *envstring, *copied_core, *dir;
572 char *stem = "SBCL_HOME=";
573 copied_core = copied_string(core);
574 dir = dirname(copied_core);
575 envstring = (char *) calloc(strlen(stem) +
579 sprintf(envstring, "%s%s", stem, dir);
584 if (!noinform && embedded_core_offset == 0) {
589 if (embedded_core_offset == 0) {
590 /* Here we make a last attempt at recognizing an embedded core,
591 * so that a file with an embedded core is a valid argument to
592 * --core. We take care that any decisions on special behaviour
593 * (suppressed banner, embedded options) have already been made
594 * before we reach this block, so that there is no observable
595 * difference between "embedded" and "bare" images given to
597 os_vm_offset_t offset = search_for_embedded_core(core);
599 embedded_core_offset = offset;
602 #if defined(SVR4) || defined(__linux__) || defined(__NetBSD__)
606 define_var("nil", NIL, 1);
607 define_var("t", T, 1);
609 if (!disable_lossage_handler_p)
610 enable_lossage_handler();
614 initial_function = load_core_file(core, embedded_core_offset);
615 if (initial_function == NIL) {
616 lose("couldn't find initial function\n");
618 #ifdef LISP_FEATURE_HPUX
619 /* -1 = CLOSURE_FUN_OFFSET, 23 = SIMPLE_FUN_CODE_OFFSET, we are
620 * not in LANGUAGE_ASSEMBLY so we cant reach them. */
621 return_from_lisp_stub = (void *) ((char *)*((unsigned long *)
622 ((char *)initial_function + -1)) + 23);
625 gc_initialize_pointers();
627 arch_install_interrupt_handlers();
628 #ifndef LISP_FEATURE_WIN32
629 os_install_interrupt_handlers();
631 /* wos_install_interrupt_handlers(handler); */
632 wos_install_interrupt_handlers(&exception_frame);
635 /* Pass core filename and the processed argv into Lisp. They'll
636 * need to be processed further there, to do locale conversion.
639 posix_argv = sbcl_argv;
641 FSHOW((stderr, "/funcalling initial_function=0x%lx\n",
642 (unsigned long)initial_function));
643 #ifdef LISP_FEATURE_WIN32
645 This is experimental prerelease support for the Windows platform: use\n\
646 at your own risk. \"Your Kitten of Death awaits!\"\n");
650 create_initial_thread(initial_function);
651 lose("CATS. CATS ARE NICE.\n");