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.
20 #ifndef LISP_FEATURE_WIN32
23 #include <sys/types.h>
24 #ifndef LISP_FEATURE_WIN32
30 #include <sys/param.h>
33 #ifndef LISP_FEATURE_WIN32
39 #if defined(SVR4) || defined(__linux__)
50 #include "interrupt.h"
60 #include "genesis/static-symbols.h"
61 #include "genesis/symbol.h"
70 #define SBCL_HOME "/usr/local/lib/sbcl/"
74 /* SIGINT handler that invokes the monitor (for when Lisp isn't up to it) */
76 sigint_handler(int signal, siginfo_t *info, void *void_context)
78 lose("\nSIGINT hit at 0x%08lX\n",
79 (unsigned long) *os_context_pc_addr(void_context));
82 /* (This is not static, because we want to be able to call it from
87 SHOW("entering sigint_init()");
88 install_handler(SIGINT, sigint_handler);
89 SHOW("leaving sigint_init()");
93 * helper functions for dealing with command line args
97 successful_malloc(size_t size)
99 void* result = malloc(size);
101 lose("malloc failure\n");
105 return (void *) NULL; /* dummy value: return something ... */
109 copied_string(char *string)
111 return strcpy(successful_malloc(1+strlen(string)), string);
115 copied_existing_filename_or_null(char *filename)
117 struct stat filename_stat;
118 if (stat(filename, &filename_stat)) { /* if failure */
121 return copied_string(filename);
125 /* miscellaneous chattiness */
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\
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\
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\
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");
157 printf("SBCL %s\n", SBCL_VERSION_STRING);
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\
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);
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. */
180 char *sbcl_home = getenv("SBCL_HOME");
182 char *stem = "/sbcl.core";
185 if (!(sbcl_home && *sbcl_home)) sbcl_home = SBCL_HOME;
186 lookhere = (char *) calloc(strlen(sbcl_home) +
190 sprintf(lookhere, "%s%s", sbcl_home, stem);
191 core = copied_existing_filename_or_null(lookhere);
194 lose("can't find core file at %s\n", lookhere);
205 struct runtime_options *runtime_options;
209 main(int argc, char *argv[], char *envp[])
211 #ifdef LISP_FEATURE_WIN32
212 /* Exception handling support structure. Evil Win32 hack. */
213 struct lisp_exception_frame exception_frame;
216 /* the name of the core file we're to execute. Note that this is
217 * a malloc'ed string which should be freed eventually. */
219 char **sbcl_argv = 0;
220 os_vm_offset_t embedded_core_offset = 0;
221 char *runtime_path = 0;
223 /* other command line options */
224 boolean noinform = 0;
225 boolean end_runtime_options = 0;
227 lispobj initial_function;
228 const char *sbcl_home = getenv("SBCL_HOME");
231 block_blockable_signals();
233 setlocale(LC_ALL, "");
235 runtime_options = NULL;
237 /* Check early to see if this executable has an embedded core,
238 * which also populates runtime_options if the core has runtime
240 runtime_path = os_get_runtime_executable_path();
242 os_vm_offset_t offset = search_for_embedded_core(runtime_path);
244 embedded_core_offset = offset;
252 /* Parse our part of the command line (aka "runtime options"),
253 * stripping out those options that we handle. */
254 if (runtime_options != NULL) {
255 dynamic_space_size = runtime_options->dynamic_space_size;
256 thread_control_stack_size = runtime_options->thread_control_stack_size;
261 runtime_options = successful_malloc(sizeof(struct runtime_options));
263 while (argi < argc) {
264 char *arg = argv[argi];
265 if (0 == strcmp(arg, "--script")) {
266 /* This is both a runtime and a toplevel option. As a
267 * runtime option, it is equivalent to --noinform.
268 * This exits, and does not increment argi, so that
269 * TOPLEVEL-INIT sees the option. */
271 end_runtime_options = 1;
273 } else if (0 == strcmp(arg, "--noinform")) {
276 } else if (0 == strcmp(arg, "--core")) {
278 lose("more than one core file specified\n");
282 lose("missing filename for --core argument\n");
284 core = copied_string(argv[argi]);
287 } else if (0 == strcmp(arg, "--help")) {
288 /* I think this is the (or a) usual convention: upon
289 * seeing "--help" we immediately print our help
290 * string and exit, ignoring everything else. */
293 } else if (0 == strcmp(arg, "--version")) {
294 /* As in "--help" case, I think this is expected. */
297 } else if (0 == strcmp(arg, "--dynamic-space-size")) {
300 lose("missing argument for --dynamic-space-size");
302 dynamic_space_size = strtol(argv[argi++], 0, 0) << 20;
304 lose("argument to --dynamic-space-size is not a number");
305 # ifdef MAX_DYNAMIC_SPACE_END
306 if (!((DYNAMIC_SPACE_START < DYNAMIC_SPACE_START+dynamic_space_size) &&
307 (DYNAMIC_SPACE_START+dynamic_space_size <= MAX_DYNAMIC_SPACE_END)))
308 lose("specified --dynamic-space-size too large");
310 } else if (0 == strcmp(arg, "--control-stack-size")) {
313 lose("missing argument for --control-stack-size");
315 thread_control_stack_size = strtol(argv[argi++], 0, 0) << 20;
317 lose("argument to --control-stack-size is not a number");
318 } else if (0 == strcmp(arg, "--debug-environment")) {
320 printf("; Commandline arguments:\n");
322 printf("; %2d: \"%s\"\n", n, argv[n]);
326 printf(";\n; Environment:\n");
328 printf("; %2d: \"%s\"\n", n, ENVIRON[n]);
332 } else if (0 == strcmp(arg, "--end-runtime-options")) {
333 end_runtime_options = 1;
337 /* This option was unrecognized as a runtime option,
338 * so it must be a toplevel option or a user option,
339 * so we must be past the end of the runtime option
344 /* This is where we strip out those options that we handle. We
345 * also take this opportunity to make sure that we don't find
346 * an out-of-place "--end-runtime-options" option. */
348 char *argi0 = argv[argi];
350 /* (argc - argi) for the arguments, one for the binary,
351 and one for the terminating NULL. */
352 sbcl_argv = successful_malloc((2 + argc - argi) * sizeof(char *));
353 sbcl_argv[0] = argv[0];
354 while (argi < argc) {
355 char *arg = argv[argi++];
356 /* If we encounter --end-runtime-options for the first
357 * time after the point where we had to give up on
358 * runtime options, then the point where we had to
359 * give up on runtime options must've been a user
361 if (!end_runtime_options &&
362 0 == strcmp(arg, "--end-runtime-options")) {
363 lose("bad runtime option \"%s\"\n", argi0);
365 sbcl_argv[argj++] = arg;
371 /* Align down to multiple of page_table page size, and to the appropriate
372 * stack alignment. */
373 dynamic_space_size &= ~(PAGE_BYTES-1);
374 thread_control_stack_size &= ~(CONTROL_STACK_ALIGNMENT_BYTES-1);
376 /* Preserve the runtime options for possible future core saving */
377 runtime_options->dynamic_space_size = dynamic_space_size;
378 runtime_options->thread_control_stack_size = thread_control_stack_size;
380 /* KLUDGE: os_vm_page_size is set by os_init(), and on some
381 * systems (e.g. Alpha) arch_init() needs need os_vm_page_size, so
382 * it must follow os_init(). -- WHN 2000-01-26 */
388 /* If no core file was specified, look for one. */
390 core = search_for_core();
393 /* Make sure that SBCL_HOME is set and not the empty string,
394 unless loading an embedded core. */
395 if (!(sbcl_home && *sbcl_home) && embedded_core_offset == 0) {
396 char *envstring, *copied_core, *dir;
397 char *stem = "SBCL_HOME=";
398 copied_core = copied_string(core);
399 dir = dirname(copied_core);
400 envstring = (char *) calloc(strlen(stem) +
404 sprintf(envstring, "%s%s", stem, dir);
409 if (!noinform && embedded_core_offset == 0) {
414 #if defined(SVR4) || defined(__linux__)
418 define_var("nil", NIL, 1);
419 define_var("t", T, 1);
421 enable_lossage_handler();
425 initial_function = load_core_file(core, embedded_core_offset);
426 if (initial_function == NIL) {
427 lose("couldn't find initial function\n");
430 gc_initialize_pointers();
432 arch_install_interrupt_handlers();
433 #ifndef LISP_FEATURE_WIN32
434 os_install_interrupt_handlers();
436 /* wos_install_interrupt_handlers(handler); */
437 wos_install_interrupt_handlers(&exception_frame);
440 /* Pass core filename and the processed argv into Lisp. They'll
441 * need to be processed further there, to do locale conversion.
444 posix_argv = sbcl_argv;
446 FSHOW((stderr, "/funcalling initial_function=0x%lx\n",
447 (unsigned long)initial_function));
448 #ifdef LISP_FEATURE_WIN32
450 This is experimental prerelease support for the Windows platform: use\n\
451 at your own risk. \"Your Kitten of Death awaits!\"\n");
455 create_initial_thread(initial_function);
456 lose("CATS. CATS ARE NICE.\n");