1 /* Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
2 * 2004, 2006, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public License
6 * as published by the Free Software Foundation; either version 3 of
7 * the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 /* Include the headers for just about everything.
23 We call all their initialization functions. */
35 #include "libguile/_scm.h"
37 /* Everybody has an init function. */
38 #include "libguile/alist.h"
39 #include "libguile/arbiters.h"
40 #include "libguile/async.h"
41 #include "libguile/backtrace.h"
42 #include "libguile/bitvectors.h"
43 #include "libguile/boolean.h"
44 #include "libguile/bytevectors.h"
45 #include "libguile/chars.h"
46 #include "libguile/control.h"
47 #include "libguile/continuations.h"
48 #include "libguile/debug.h"
49 #ifdef GUILE_DEBUG_MALLOC
50 #include "libguile/debug-malloc.h"
52 #include "libguile/deprecation.h"
53 #include "libguile/dynl.h"
54 #include "libguile/dynwind.h"
55 #include "libguile/eq.h"
56 #include "libguile/error.h"
57 #include "libguile/eval.h"
58 #include "libguile/evalext.h"
59 #include "libguile/expand.h"
60 #include "libguile/feature.h"
61 #include "libguile/filesys.h"
62 #include "libguile/finalizers.h"
63 #include "libguile/fluids.h"
64 #include "libguile/fports.h"
65 #include "libguile/frames.h"
66 #include "libguile/gc.h"
67 #include "libguile/gdbint.h"
68 #include "libguile/generalized-arrays.h"
69 #include "libguile/generalized-vectors.h"
70 #include "libguile/goops.h"
71 #include "libguile/gsubr.h"
72 #include "libguile/hash.h"
73 #include "libguile/hashtab.h"
74 #include "libguile/hooks.h"
75 #include "libguile/gettext.h"
76 #include "libguile/i18n.h"
77 #include "libguile/instructions.h"
78 #include "libguile/ioext.h"
79 #include "libguile/keywords.h"
80 #include "libguile/list.h"
81 #include "libguile/load.h"
82 #include "libguile/macros.h"
83 #include "libguile/mallocs.h"
84 #include "libguile/memoize.h"
85 #include "libguile/modules.h"
86 #include "libguile/net_db.h"
87 #include "libguile/numbers.h"
88 #include "libguile/objcodes.h"
89 #include "libguile/objprop.h"
90 #include "libguile/options.h"
91 #include "libguile/pairs.h"
92 #include "libguile/poll.h"
93 #include "libguile/ports.h"
94 #include "libguile/posix.h"
96 #include "libguile/regex-posix.h"
98 #include "libguile/print.h"
99 #include "libguile/procprop.h"
100 #include "libguile/procs.h"
101 #include "libguile/programs.h"
102 #include "libguile/promises.h"
103 #include "libguile/array-map.h"
104 #include "libguile/random.h"
105 #include "libguile/rdelim.h"
106 #include "libguile/read.h"
107 #include "libguile/rw.h"
108 #include "libguile/scmsigs.h"
109 #include "libguile/script.h"
110 #include "libguile/simpos.h"
111 #include "libguile/smob.h"
112 #include "libguile/socket.h"
113 #include "libguile/sort.h"
114 #include "libguile/srcprop.h"
115 #include "libguile/stackchk.h"
116 #include "libguile/stacks.h"
117 #include "libguile/stime.h"
118 #include "libguile/strings.h"
119 #include "libguile/srfi-1.h"
120 #include "libguile/srfi-4.h"
121 #include "libguile/srfi-13.h"
122 #include "libguile/srfi-14.h"
123 #include "libguile/srfi-60.h"
124 #include "libguile/strorder.h"
125 #include "libguile/strports.h"
126 #include "libguile/struct.h"
127 #include "libguile/symbols.h"
128 #include "libguile/throw.h"
129 #include "libguile/arrays.h"
130 #include "libguile/trees.h"
131 #include "libguile/values.h"
132 #include "libguile/variable.h"
133 #include "libguile/vectors.h"
134 #include "libguile/version.h"
135 #include "libguile/vm.h"
136 #include "libguile/vports.h"
137 #include "libguile/guardians.h"
138 #include "libguile/extensions.h"
139 #include "libguile/uniform.h"
140 #include "libguile/deprecated.h"
142 #include "libguile/init.h"
143 #include "libguile/private-options.h"
154 /* initializing standard and current I/O ports */
162 /* proc to be called in scope of exception handler stream_handler. */
164 stream_body (void *data
)
166 stream_body_data
*body_data
= (stream_body_data
*) data
;
167 SCM port
= scm_fdes_to_port (body_data
->fdes
, body_data
->mode
, SCM_BOOL_F
);
168 scm_set_port_revealed_x (port
, SCM_INUM1
);
172 /* exception handler for stream_body. */
174 stream_handler (void *data SCM_UNUSED
,
176 SCM throw_args SCM_UNUSED
)
181 /* Convert a file descriptor to a port, using scm_fdes_to_port.
182 - set the revealed count for FILE's file descriptor to 1, so
183 that fdes won't be closed when the port object is GC'd.
184 - catch exceptions: allow Guile to be able to start up even
185 if it has been handed bogus stdin/stdout/stderr. replace the
186 bad ports with void ports. */
188 scm_standard_stream_to_port (int fdes
, char *mode
)
191 stream_body_data body_data
;
193 body_data
.fdes
= fdes
;
194 body_data
.mode
= mode
;
195 port
= scm_internal_catch (SCM_BOOL_T
, stream_body
, &body_data
,
196 stream_handler
, NULL
);
197 if (scm_is_false (port
))
198 port
= scm_void_port (mode
);
202 /* Create standard ports from stdin, stdout, and stderr. */
204 scm_init_standard_ports ()
206 /* From the SCSH manual:
208 It can be useful to turn I/O buffering off in some cases, for
209 example when an I/O stream is to be shared by multiple
210 subprocesses. For this reason, scsh allocates an unbuffered port
211 for file descriptor 0 at start-up time.
213 Because shells frequently share stdin with subprocesses, if the
214 shell does buffered reads, it might ``steal'' input intended for
215 a subprocess. For this reason, all shells, including sh, csh,
216 and scsh, read stdin unbuffered. Applications that can tolerate
217 buffered input on stdin can reset \ex{(current-input-port)} to
218 block buffering for higher performance. */
220 scm_set_current_input_port
221 (scm_standard_stream_to_port (0, isatty (0) ? "r0" : "r"));
222 scm_set_current_output_port
223 (scm_standard_stream_to_port (1, isatty (1) ? "w0" : "w"));
224 scm_set_current_error_port
225 (scm_standard_stream_to_port (2, isatty (2) ? "w0" : "w"));
230 /* Loading the startup Scheme files. */
232 /* The boot code "ice-9/boot-9" is only loaded by scm_boot_guile when
233 this is false. The unexec code uses this, to keep ice_9 from being
234 loaded into dumped guile executables. */
235 int scm_ice_9_already_loaded
= 0;
238 scm_load_startup_files ()
240 /* We want a path only containing directories from GUILE_LOAD_PATH,
241 SCM_SITE_DIR and SCM_LIBRARY_DIR when searching for the site init
242 file, so we do this before loading Ice-9. */
244 scm_sys_search_load_path (scm_from_locale_string ("init.scm"));
247 if (!scm_ice_9_already_loaded
)
249 scm_c_primitive_load_path ("ice-9/boot-9");
251 /* Load the init.scm file. */
252 if (scm_is_true (init_path
))
253 scm_primitive_load (init_path
);
258 /* The main init code. */
261 typedef int setjmp_type
;
263 typedef long setjmp_type
;
266 /* All the data needed to invoke the main function. */
267 struct main_func_closure
269 /* the function to call */
270 void (*main_func
)(void *closure
, int argc
, char **argv
);
271 void *closure
; /* dummy data to pass it */
273 char **argv
; /* the argument list it should receive */
276 static void *invoke_main_func(void *body_data
);
279 /* Fire up the Guile Scheme interpreter.
281 Call MAIN_FUNC, passing it CLOSURE, ARGC, and ARGV. MAIN_FUNC
282 should do all the work of the program (initializing other packages,
283 reading user input, etc.) before returning. When MAIN_FUNC
284 returns, call exit (EXIT_FAILURE); this function never returns.
285 If you want some other exit value, MAIN_FUNC may call exit itself.
287 scm_boot_guile arranges for program-arguments to return the strings
288 given by ARGC and ARGV. If MAIN_FUNC modifies ARGC/ARGV, should
289 call scm_set_program_arguments with the final list, so Scheme code
290 will know which arguments have been processed.
292 scm_boot_guile establishes a catch-all catch handler which prints
293 an error message and exits the process. This means that Guile
294 exits in a coherent way when system errors occur and the user isn't
295 prepared to handle it. If the user doesn't like this behavior,
296 they can establish their own universal catcher to shadow this one.
298 Why must the caller do all the real work from MAIN_FUNC? The
299 garbage collector assumes that all local variables of type SCM will
300 be above scm_boot_guile's stack frame on the stack. If you try to
301 manipulate SCM values after this function returns, it's the luck of
302 the draw whether the GC will be able to find the objects you
303 allocate. So, scm_boot_guile function exits, rather than
304 returning, to discourage people from making that mistake. */
308 scm_boot_guile (int argc
, char ** argv
, void (*main_func
) (), void *closure
)
311 struct main_func_closure c
;
313 c
.main_func
= main_func
;
318 res
= scm_with_guile (invoke_main_func
, &c
);
320 /* If the caller doesn't want this, they should exit from main_func
330 invoke_main_func (void *body_data
)
332 struct main_func_closure
*closure
= (struct main_func_closure
*) body_data
;
334 scm_i_set_boot_program_arguments (closure
->argc
, closure
->argv
);
335 (*closure
->main_func
) (closure
->closure
, closure
->argc
, closure
->argv
);
337 scm_restore_signals ();
339 /* This tick gives any pending
340 * asyncs a chance to run. This must be done after
341 * the call to scm_restore_signals.
345 /* Indicate success by returning non-NULL.
350 scm_i_pthread_mutex_t scm_i_init_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
351 int scm_initialized_p
= 0;
354 really_cleanup_for_exit (void *unused
)
356 scm_flush_all_ports ();
363 if (scm_i_pthread_mutex_trylock (&scm_i_init_mutex
) == 0)
364 scm_i_pthread_mutex_unlock (&scm_i_init_mutex
);
367 fprintf (stderr
, "Cannot exit gracefully when init is in progress; aborting.\n");
371 /* This function might be called in non-guile mode, so we need to
372 enter it temporarily.
374 scm_with_guile (really_cleanup_for_exit
, NULL
);
378 scm_i_init_guile (void *base
)
380 if (scm_initialized_p
)
383 scm_storage_prehistory ();
384 scm_threads_prehistory (base
); /* requires storage_prehistory */
385 scm_weak_table_prehistory (); /* requires storage_prehistory */
386 #ifdef GUILE_DEBUG_MALLOC
387 scm_debug_malloc_prehistory ();
389 scm_symbols_prehistory (); /* requires weak_table_prehistory */
390 scm_modules_prehistory ();
391 scm_init_array_handle ();
392 scm_bootstrap_bytevectors (); /* Requires array-handle */
393 scm_bootstrap_instructions ();
394 scm_bootstrap_objcodes ();
395 scm_bootstrap_programs ();
397 scm_register_r6rs_ports ();
398 scm_register_foreign ();
399 scm_register_srfi_1 ();
400 scm_register_srfi_60 ();
401 scm_register_poll ();
403 scm_init_strings (); /* Requires array-handle */
404 scm_init_struct (); /* Requires strings */
405 scm_smob_prehistory ();
406 scm_init_variable ();
407 scm_init_continuations (); /* requires smob_prehistory */
408 scm_init_root (); /* requires continuations */
409 scm_init_threads (); /* requires smob_prehistory */
411 scm_init_thread_procs (); /* requires gsubrs */
412 scm_init_procprop ();
414 scm_init_arbiters (); /* requires smob_prehistory */
415 scm_init_async (); /* requires smob_prehistory */
418 #ifdef GUILE_DEBUG_MALLOC
419 scm_init_debug_malloc ();
421 scm_init_dynwind (); /* requires smob_prehistory */
424 scm_init_finalizers ();
426 scm_init_control (); /* requires fluids */
428 scm_init_backtrace ();
430 scm_init_strports ();
434 scm_init_deprecation ();
436 scm_init_promises (); /* requires smob_prehistory */
437 scm_init_hooks (); /* Requires smob_prehistory */
439 scm_init_gc (); /* Requires hooks and `get_internal_run_time' */
440 scm_init_gc_protect_object (); /* requires threads_prehistory */
441 scm_init_gdbint (); /* Requires strports, gc_protect_object */
444 scm_init_keywords (); /* Requires smob_prehistory */
445 scm_init_fports_keywords ();
447 scm_init_random (); /* Requires smob_prehistory */
448 scm_init_macros (); /* Requires smob_prehistory and random */
449 scm_init_mallocs (); /* Requires smob_prehistory */
450 scm_init_modules (); /* Requires smob_prehistory */
454 scm_init_filesys (); /* Requires smob_prehistory */
459 scm_init_regex_posix (); /* Requires smob_prehistory */
463 #ifdef HAVE_NETWORKING
468 scm_init_srcprop (); /* requires smob_prehistory */
469 scm_init_stackchk ();
471 scm_init_generalized_arrays ();
472 scm_init_generalized_vectors ();
473 scm_init_vectors (); /* Requires array-handle, */
475 scm_init_bitvectors (); /* Requires smob_prehistory, array-handle */
476 scm_init_srfi_4 (); /* Requires smob_prehistory, array-handle */
477 scm_init_arrays (); /* Requires smob_prehistory, array-handle */
478 scm_init_array_map ();
480 scm_init_frames (); /* Requires smob_prehistory */
481 scm_init_stacks (); /* Requires strings, struct, frames */
483 scm_init_values (); /* Requires struct */
484 scm_init_load (); /* Requires strings */
485 scm_init_print (); /* Requires strings, struct, smob */
487 scm_init_strorder ();
489 scm_init_srfi_14 (); /* Requires smob_prehistory */
490 scm_init_throw (); /* Requires smob_prehistory */
493 scm_init_weak_set ();
494 scm_init_weak_table ();
495 scm_init_weak_vectors ();
496 scm_init_guardians (); /* requires smob_prehistory */
498 scm_init_standard_ports (); /* Requires fports */
499 scm_init_expand (); /* Requires structs */
500 scm_init_memoize (); /* Requires smob_prehistory */
501 scm_init_eval (); /* Requires smob_prehistory */
502 scm_init_load_path ();
503 scm_init_eval_in_scheme ();
505 scm_init_debug (); /* Requires macro smobs */
508 scm_init_dynamic_linking (); /* Requires smob_prehistory */
510 scm_bootstrap_i18n ();
515 #if SCM_ENABLE_DEPRECATED == 1
516 scm_i_init_deprecated ();
519 scm_initialized_p
= 1;
521 scm_stack_checking_enabled_p
= SCM_STACK_CHECKING_P
;
525 scm_init_extensions ();
527 atexit (cleanup_for_exit
);
528 scm_load_startup_files ();
529 scm_init_load_should_auto_compile ();
531 /* Capture the dynamic state after loading boot-9, so that new threads end up
532 in the guile-user module. */
533 scm_init_threads_default_dynamic_state ();
535 /* Finally, cause finalizers to run in a separate thread. */
536 scm_init_finalizer_thread ();