1 /* Copyright (C) 1995,1996,1997,1998,1999, 2000 Free Software Foundation, Inc.
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
40 * If you do not wish that, delete this exception notice. */
42 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
43 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
46 /* Include the headers for just about everything.
47 We call all their initialization functions. */
53 #include "libguile/_scm.h"
55 /* Everybody has an init function. */
56 #include "libguile/alist.h"
57 #include "libguile/arbiters.h"
58 #include "libguile/async.h"
59 #include "libguile/backtrace.h"
60 #include "libguile/boolean.h"
61 #include "libguile/chars.h"
62 #include "libguile/continuations.h"
63 #ifdef DEBUG_EXTENSIONS
64 #include "libguile/debug.h"
66 #ifdef GUILE_DEBUG_MALLOC
67 #include "libguile/debug-malloc.h"
69 #include "libguile/dynl.h"
70 #include "libguile/dynwind.h"
71 #include "libguile/environments.h"
72 #include "libguile/eq.h"
73 #include "libguile/error.h"
74 #include "libguile/eval.h"
75 #include "libguile/evalext.h"
76 #include "libguile/feature.h"
77 #include "libguile/filesys.h"
78 #include "libguile/fluids.h"
79 #include "libguile/fports.h"
80 #include "libguile/gc.h"
81 #include "libguile/gdbint.h"
82 #include "libguile/gsubr.h"
83 #include "libguile/hash.h"
84 #include "libguile/hashtab.h"
85 #include "libguile/hooks.h"
87 #include "libguile/iselect.h"
89 #include "libguile/ioext.h"
90 #include "libguile/keywords.h"
91 #include "libguile/lang.h"
92 #include "libguile/list.h"
93 #include "libguile/load.h"
94 #include "libguile/macros.h"
95 #include "libguile/mallocs.h"
96 #include "libguile/modules.h"
97 #include "libguile/net_db.h"
98 #include "libguile/numbers.h"
99 #include "libguile/objects.h"
100 #include "libguile/objprop.h"
101 #include "libguile/options.h"
102 #include "libguile/pairs.h"
103 #include "libguile/ports.h"
104 #include "libguile/posix.h"
106 #include "libguile/regex-posix.h"
108 #include "libguile/print.h"
109 #include "libguile/procprop.h"
110 #include "libguile/procs.h"
111 #include "libguile/properties.h"
112 #include "libguile/ramap.h"
113 #include "libguile/random.h"
114 #include "libguile/read.h"
115 #include "libguile/scmsigs.h"
116 #include "libguile/script.h"
117 #include "libguile/simpos.h"
118 #include "libguile/smob.h"
119 #include "libguile/socket.h"
120 #include "libguile/sort.h"
121 #include "libguile/srcprop.h"
122 #include "libguile/stackchk.h"
123 #include "libguile/stacks.h"
124 #include "libguile/stime.h"
125 #include "libguile/strings.h"
126 #include "libguile/strop.h"
127 #include "libguile/strorder.h"
128 #include "libguile/strports.h"
129 #include "libguile/struct.h"
130 #include "libguile/symbols.h"
131 #include "libguile/tag.h"
132 #include "libguile/throw.h"
133 #include "libguile/unif.h"
134 #include "libguile/variable.h"
135 #include "libguile/vectors.h"
136 #include "libguile/version.h"
137 #include "libguile/vports.h"
138 #include "libguile/weaks.h"
139 #include "libguile/guardians.h"
141 #include "libguile/init.h"
150 /* Setting up the stack. */
153 restart_stack (void *base
)
155 scm_dynwinds
= SCM_EOL
;
156 SCM_DYNENV (scm_rootcont
) = SCM_EOL
;
157 SCM_THROW_VALUE (scm_rootcont
) = SCM_EOL
;
158 #ifdef DEBUG_EXTENSIONS
159 SCM_DFRAME (scm_rootcont
) = scm_last_debug_frame
= 0;
161 SCM_BASE (scm_rootcont
) = base
;
162 scm_continuation_stack_ptr
= SCM_MAKINUM (0);
166 start_stack (void *base
)
170 root
= scm_permanent_object (scm_make_root (SCM_UNDEFINED
));
171 scm_set_root (SCM_ROOT_STATE (root
));
172 scm_stack_base
= base
;
174 scm_exitval
= SCM_BOOL_F
; /* vestigial */
176 #if SCM_DEBUG_DEPRECATED == 0
177 scm_top_level_lookup_closure_var
= SCM_BOOL_F
;
179 scm_system_transformer
= SCM_BOOL_F
;
181 scm_root
->fluids
= scm_make_initial_fluids ();
183 /* Create an object to hold the root continuation.
185 SCM_NEWCELL (scm_rootcont
);
186 SCM_SET_CONTREGS (scm_rootcont
, scm_must_malloc (sizeof (scm_contregs
),
188 SCM_SET_CELL_TYPE (scm_rootcont
, scm_tc7_contin
);
189 SCM_SEQ (scm_rootcont
) = 0;
190 /* The root continuation is further initialized by restart_stack. */
192 /* Create the look-aside stack for variables that are shared between
193 * captured continuations.
195 scm_continuation_stack
= scm_make_vector (SCM_MAKINUM (512), SCM_UNDEFINED
);
196 /* The continuation stack is further initialized by restart_stack. */
198 /* The remainder of stack initialization is factored out to another
199 * function so that if this stack is ever exitted, it can be
200 * re-entered using restart_stack. */
201 restart_stack (base
);
206 static char remsg
[] = "remove\n#define ", addmsg
[] = "add\n#define ";
210 fixconfig (char *s1
,char *s2
,int s
)
214 fputs ("\nin ", stderr
);
215 fputs (s
? "setjump" : "scmfig", stderr
);
216 fputs (".h and recompile scm\n", stderr
);
227 if (HEAP_SEG_SIZE
!= j
)
228 fixconfig ("reduce", "size of HEAP_SEG_SIZE", 0);
231 if (2 * SCM_BITSPERDIG
/ SCM_CHAR_BIT
> sizeof (long))
232 fixconfig (remsg
, "SCM_BIGDIG", 0);
233 #ifndef SCM_DIGSTOOBIG
234 if (SCM_DIGSPERLONG
* sizeof (SCM_BIGDIG
) > sizeof (long))
235 fixconfig (addmsg
, "SCM_DIGSTOOBIG", 0);
239 #ifdef SCM_STACK_GROWS_UP
240 if (((SCM_STACKITEM
*) & j
- stack_start_ptr
) < 0)
241 fixconfig (remsg
, "SCM_STACK_GROWS_UP", 1);
243 if ((stack_start_ptr
- (SCM_STACKITEM
*) & j
) < 0)
244 fixconfig (addmsg
, "SCM_STACK_GROWS_UP", 1);
251 /* initializing standard and current I/O ports */
260 /* proc to be called in scope of exception handler stream_handler. */
262 stream_body (void *data
)
264 stream_body_data
*body_data
= (stream_body_data
*) data
;
265 SCM port
= scm_fdes_to_port (body_data
->fdes
, body_data
->mode
,
266 scm_makfrom0str (body_data
->name
));
268 SCM_REVEALED (port
) = 1;
272 /* exception handler for stream_body. */
274 stream_handler (void *data
, SCM tag
, SCM throw_args
)
279 /* Convert a file descriptor to a port, using scm_fdes_to_port.
280 - NAME is a C string, not a Guile string
281 - set the revealed count for FILE's file descriptor to 1, so
282 that fdes won't be closed when the port object is GC'd.
283 - catch exceptions: allow Guile to be able to start up even
284 if it has been handed bogus stdin/stdout/stderr. replace the
285 bad ports with void ports. */
287 scm_standard_stream_to_port (int fdes
, char *mode
, char *name
)
290 stream_body_data body_data
;
292 body_data
.fdes
= fdes
;
293 body_data
.mode
= mode
;
294 body_data
.name
= name
;
295 port
= scm_internal_catch (SCM_BOOL_T
, stream_body
, &body_data
,
296 stream_handler
, NULL
);
297 if (SCM_FALSEP (port
))
298 port
= scm_void_port (mode
);
302 /* Create standard ports from stdin, stdout, and stderr. */
304 scm_init_standard_ports ()
306 /* From the SCSH manual:
308 It can be useful to turn I/O buffering off in some cases, for
309 example when an I/O stream is to be shared by multiple
310 subprocesses. For this reason, scsh allocates an unbuffered port
311 for file descriptor 0 at start-up time.
313 Because shells frequently share stdin with subprocesses, if the
314 shell does buffered reads, it might ``steal'' input intended for
315 a subprocess. For this reason, all shells, including sh, csh,
316 and scsh, read stdin unbuffered. Applications that can tolerate
317 buffered input on stdin can reset \ex{(current-input-port)} to
318 block buffering for higher performance. */
321 = scm_standard_stream_to_port (0,
322 isatty (0) ? "r0" : "r",
324 scm_def_outp
= scm_standard_stream_to_port (1,
325 isatty (1) ? "w0" : "w",
327 scm_def_errp
= scm_standard_stream_to_port (2,
328 isatty (2) ? "w0" : "w",
331 scm_cur_inp
= scm_def_inp
;
332 scm_cur_outp
= scm_def_outp
;
333 scm_cur_errp
= scm_def_errp
;
334 scm_cur_loadp
= SCM_BOOL_F
;
339 /* Loading the startup Scheme files. */
341 /* The boot code "ice-9/boot-9" is only loaded by scm_boot_guile when
342 this is false. The unexec code uses this, to keep ice_9 from being
343 loaded into dumped guile executables. */
344 int scm_ice_9_already_loaded
= 0;
347 scm_load_startup_files ()
349 /* We want a path only containing directories from GUILE_LOAD_PATH,
350 SCM_SITE_DIR and SCM_LIBRARY_DIR when searching for the site init
351 file, so we do this before loading Ice-9. */
352 SCM init_path
= scm_sys_search_load_path (scm_makfrom0str ("init.scm"));
355 if (!scm_ice_9_already_loaded
)
357 scm_primitive_load_path (scm_makfrom0str ("ice-9/boot-9.scm"));
359 /* Load the init.scm file. */
360 if (SCM_NFALSEP (init_path
))
361 scm_primitive_load (init_path
);
363 scm_post_boot_init_modules ();
367 /* Get an integer from an environment variable. */
369 scm_i_getenv_int (const char *var
, int def
)
371 char *end
, *val
= getenv (var
);
375 res
= strtol (val
, &end
, 10);
382 /* The main init code. */
385 typedef int setjmp_type
;
387 typedef long setjmp_type
;
390 /* All the data needed to invoke the main function. */
391 struct main_func_closure
393 /* the function to call */
394 void (*main_func
)(void *closure
, int argc
, char **argv
);
395 void *closure
; /* dummy data to pass it */
397 char **argv
; /* the argument list it should receive */
401 static void scm_init_guile_1 (SCM_STACKITEM
*base
);
402 static void scm_boot_guile_1 (SCM_STACKITEM
*base
,
403 struct main_func_closure
*closure
);
404 static SCM
invoke_main_func(void *body_data
);
407 /* Fire up the Guile Scheme interpreter.
409 Call MAIN_FUNC, passing it CLOSURE, ARGC, and ARGV. MAIN_FUNC
410 should do all the work of the program (initializing other packages,
411 reading user input, etc.) before returning. When MAIN_FUNC
412 returns, call exit (0); this function never returns. If you want
413 some other exit value, MAIN_FUNC may call exit itself.
415 scm_boot_guile arranges for program-arguments to return the strings
416 given by ARGC and ARGV. If MAIN_FUNC modifies ARGC/ARGV, should
417 call scm_set_program_arguments with the final list, so Scheme code
418 will know which arguments have been processed.
420 scm_boot_guile establishes a catch-all catch handler which prints
421 an error message and exits the process. This means that Guile
422 exits in a coherent way when system errors occur and the user isn't
423 prepared to handle it. If the user doesn't like this behavior,
424 they can establish their own universal catcher to shadow this one.
426 Why must the caller do all the real work from MAIN_FUNC? The
427 garbage collector assumes that all local variables of type SCM will
428 be above scm_boot_guile's stack frame on the stack. If you try to
429 manipulate SCM values after this function returns, it's the luck of
430 the draw whether the GC will be able to find the objects you
431 allocate. So, scm_boot_guile function exits, rather than
432 returning, to discourage people from making that mistake. */
436 scm_boot_guile (int argc
, char ** argv
, void (*main_func
) (), void *closure
)
438 /* The garbage collector uses the address of this variable as one
439 end of the stack, and the address of one of its own local
440 variables as the other end. */
442 struct main_func_closure c
;
444 c
.main_func
= main_func
;
449 scm_boot_guile_1 (&dummy
, &c
);
452 extern void *scm_get_stack_base ();
457 scm_init_guile_1 ((SCM_STACKITEM
*)scm_get_stack_base ());
460 int scm_initialized_p
= 0;
463 scm_init_guile_1 (SCM_STACKITEM
*base
)
465 if (scm_initialized_p
)
470 fprintf (stderr
, "cannot determine stack base!\n");
474 scm_ints_disabled
= 1;
477 scm_ports_prehistory ();
478 scm_smob_prehistory ();
479 scm_tables_prehistory ();
480 #ifdef GUILE_DEBUG_MALLOC
481 scm_debug_malloc_prehistory ();
483 scm_init_storage (scm_i_getenv_int ("GUILE_INIT_SEGMENT_SIZE_1", 0),
484 scm_i_getenv_int ("GUILE_MIN_YIELD_1", 0),
485 scm_i_getenv_int ("GUILE_INIT_SEGMENT_SIZE_2", 0),
486 scm_i_getenv_int ("GUILE_MIN_YIELD_2", 0),
487 scm_i_getenv_int ("GUILE_MAX_SEGMENT_SIZE", 0));
488 scm_struct_prehistory (); /* Must come after scm_init_storage */
489 scm_weaks_prehistory (); /* Must come after scm_init_storage */
490 scm_init_subr_table ();
491 scm_environments_prehistory (); /* create the root environment */
494 scm_init_threads (base
);
498 scm_init_environments ();
501 scm_init_arbiters ();
505 scm_init_continuations ();
506 #ifdef GUILE_DEBUG_MALLOC
507 scm_init_debug_malloc ();
513 scm_init_backtrace (); /* Requires fluids */
519 scm_init_properties ();
520 scm_init_hooks (); /* Requires objprop until hook names are removed */
521 scm_init_gc (); /* Requires hooks, async */
526 scm_init_keywords ();
540 scm_init_regex_posix ();
543 scm_init_procprop ();
545 #ifdef HAVE_NETWORKING
550 #ifdef DEBUG_EXTENSIONS
553 scm_init_stackchk ();
554 scm_init_struct (); /* Requires struct */
556 scm_init_strports ();
560 scm_init_objects (); /* Requires struct */
561 scm_init_print (); /* Requires struct */
565 scm_init_strorder ();
568 scm_init_variable ();
572 scm_init_guardian ();
576 #ifdef DEBUG_EXTENSIONS
577 scm_init_debug (); /* Requires macro smobs */
585 scm_init_load_path ();
586 scm_init_standard_ports ();
587 scm_init_dynamic_linking ();
590 scm_initialized_p
= 1;
592 scm_block_gc
= 0; /* permit the gc to run */
593 /* ints still disabled */
595 #ifdef STACK_CHECKING
596 scm_stack_checking_enabled_p
= SCM_STACK_CHECKING_P
;
601 /* Record here whether SCM_BOOT_GUILE_1 has already been called. This
602 variable is now here and not inside SCM_BOOT_GUILE_1 so that one
603 can tweak it. This is necessary for unexec to work. (Hey, "1-live"
604 is the name of a local radiostation...) */
606 int scm_boot_guile_1_live
= 0;
609 scm_boot_guile_1 (SCM_STACKITEM
*base
, struct main_func_closure
*closure
)
611 scm_init_guile_1 (base
);
613 /* This function is not re-entrant. */
614 if (scm_boot_guile_1_live
)
617 scm_boot_guile_1_live
= 1;
619 scm_set_program_arguments (closure
->argc
, closure
->argv
, 0);
620 invoke_main_func (closure
);
622 scm_restore_signals ();
624 /* This tick gives any pending
625 * asyncs a chance to run. This must be done after
626 * the call to scm_restore_signals.
630 /* If the caller doesn't want this, they should return from
631 main_func themselves. */
636 invoke_main_func (void *body_data
)
638 struct main_func_closure
*closure
= (struct main_func_closure
*) body_data
;
640 scm_load_startup_files ();
642 (*closure
->main_func
) (closure
->closure
, closure
->argc
, closure
->argv
);
645 return SCM_UNDEFINED
;