libguile/init.c

   1 /* Copyright (C) 1995,1996,1997,1998,1999, 2000 Free Software Foundation, Inc.
   2  *
   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)
   6  * any later version.
   7  *
   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.
  12  *
  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
  17  *
  18  * As a special exception, the Free Software Foundation gives permission
  19  * for additional uses of the text contained in its release of GUILE.
  20  *
  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.
  26  *
  27  * This exception does not however invalidate any other reasons why
  28  * the executable file might be covered by the GNU General Public License.
  29  *
  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.
  37  *
  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.  */
  41
  42 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
  43    gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
  44
  45 \f
  46 /* Include the headers for just about everything.
  47    We call all their initialization functions.  */
  48
  49 #include <stdio.h>
  50 #include <sys/stat.h>
  51 #include <fcntl.h>
  52
  53 #include "libguile/_scm.h"
  54
  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"
  65 #endif
  66 #ifdef GUILE_DEBUG_MALLOC
  67 #include "libguile/debug-malloc.h"
  68 #endif
  69 #include "libguile/dynl.h"
  70 #include "libguile/dynwind.h"
  71 #include "libguile/eq.h"
  72 #include "libguile/error.h"
  73 #include "libguile/eval.h"
  74 #include "libguile/evalext.h"
  75 #include "libguile/feature.h"
  76 #include "libguile/filesys.h"
  77 #include "libguile/fluids.h"
  78 #include "libguile/fports.h"
  79 #include "libguile/gc.h"
  80 #include "libguile/gdbint.h"
  81 #include "libguile/gsubr.h"
  82 #include "libguile/hash.h"
  83 #include "libguile/hashtab.h"
  84 #include "libguile/hooks.h"
  85 #ifdef GUILE_ISELECT
  86 #include "libguile/iselect.h"
  87 #endif
  88 #include "libguile/ioext.h"
  89 #include "libguile/keywords.h"
  90 #include "libguile/lang.h"
  91 #include "libguile/list.h"
  92 #include "libguile/load.h"
  93 #include "libguile/macros.h"
  94 #include "libguile/mallocs.h"
  95 #include "libguile/modules.h"
  96 #include "libguile/net_db.h"
  97 #include "libguile/numbers.h"
  98 #include "libguile/objects.h"
  99 #include "libguile/objprop.h"
 100 #include "libguile/options.h"
 101 #include "libguile/pairs.h"
 102 #include "libguile/ports.h"
 103 #include "libguile/posix.h"
 104 #ifdef HAVE_REGCOMP
 105 #include "libguile/regex-posix.h"
 106 #endif
 107 #include "libguile/print.h"
 108 #include "libguile/procprop.h"
 109 #include "libguile/procs.h"
 110 #include "libguile/ramap.h"
 111 #include "libguile/random.h"
 112 #include "libguile/read.h"
 113 #include "libguile/scmsigs.h"
 114 #include "libguile/script.h"
 115 #include "libguile/simpos.h"
 116 #include "libguile/smob.h"
 117 #include "libguile/socket.h"
 118 #include "libguile/sort.h"
 119 #include "libguile/srcprop.h"
 120 #include "libguile/stackchk.h"
 121 #include "libguile/stacks.h"
 122 #include "libguile/stime.h"
 123 #include "libguile/strings.h"
 124 #include "libguile/strop.h"
 125 #include "libguile/strorder.h"
 126 #include "libguile/strports.h"
 127 #include "libguile/struct.h"
 128 #include "libguile/symbols.h"
 129 #include "libguile/tag.h"
 130 #include "libguile/throw.h"
 131 #include "libguile/unif.h"
 132 #include "libguile/variable.h"
 133 #include "libguile/vectors.h"
 134 #include "libguile/version.h"
 135 #include "libguile/vports.h"
 136 #include "libguile/weaks.h"
 137 #include "libguile/guardians.h"
 138
 139 #include "libguile/init.h"
 140
 141 #ifdef HAVE_STRING_H
 142 #include <string.h>
 143 #endif
 144 #ifdef HAVE_UNISTD_H
 145 #include <unistd.h>
 146 #endif
 147 \f
 148 /* Setting up the stack.  */
 149
 150 static void
 151 restart_stack (void *base)
 152 {
 153   scm_dynwinds = SCM_EOL;
 154   SCM_DYNENV (scm_rootcont) = SCM_EOL;
 155   SCM_THROW_VALUE (scm_rootcont) = SCM_EOL;
 156 #ifdef DEBUG_EXTENSIONS
 157   SCM_DFRAME (scm_rootcont) = scm_last_debug_frame = 0;
 158 #endif
 159   SCM_BASE (scm_rootcont) = base;
 160   scm_continuation_stack_ptr = SCM_MAKINUM (0);
 161 }
 162
 163 static void
 164 start_stack (void *base)
 165 {
 166   SCM root;
 167
 168   root = scm_permanent_object (scm_make_root (SCM_UNDEFINED));
 169   scm_set_root (SCM_ROOT_STATE (root));
 170   scm_stack_base = base;
 171
 172   scm_exitval = SCM_BOOL_F;     /* vestigial */
 173
 174   scm_top_level_lookup_closure_var = SCM_BOOL_F;
 175   scm_system_transformer = SCM_BOOL_F;
 176
 177   scm_root->fluids = scm_make_initial_fluids ();
 178
 179   /* Create an object to hold the root continuation.
 180    */
 181   SCM_NEWCELL (scm_rootcont);
 182   SCM_SET_CONTREGS (scm_rootcont, scm_must_malloc (sizeof (scm_contregs),
 183                                                    "continuation"));
 184   SCM_SET_CELL_TYPE (scm_rootcont, scm_tc7_contin);
 185   SCM_SEQ (scm_rootcont) = 0;
 186   /* The root continuation if further initialized by restart_stack. */
 187
 188   /* Create the look-aside stack for variables that are shared between
 189    * captured continuations.
 190    */
 191   scm_continuation_stack = scm_make_vector (SCM_MAKINUM (512), SCM_UNDEFINED);
 192   /* The continuation stack is further initialized by restart_stack. */
 193
 194   /* The remainder of stack initialization is factored out to another
 195    * function so that if this stack is ever exitted, it can be
 196    * re-entered using restart_stack.  */
 197   restart_stack (base);
 198 }
 199
 200
 201 #if 0
 202 static char remsg[] = "remove\n#define ", addmsg[] = "add\n#define ";
 203
 204
 205 static void
 206 fixconfig (char *s1,char *s2,int s)
 207 {
 208   fputs (s1, stderr);
 209   fputs (s2, stderr);
 210   fputs ("\nin ", stderr);
 211   fputs (s ? "setjump" : "scmfig", stderr);
 212   fputs (".h and recompile scm\n", stderr);
 213   exit (1);
 214 }
 215
 216
 217 static void
 218 check_config (void)
 219 {
 220   scm_sizet j;
 221
 222   j = HEAP_SEG_SIZE;
 223   if (HEAP_SEG_SIZE != j)
 224     fixconfig ("reduce", "size of HEAP_SEG_SIZE", 0);
 225
 226 #ifdef SCM_BIGDIG
 227   if (2 * SCM_BITSPERDIG / SCM_CHAR_BIT > sizeof (long))
 228       fixconfig (remsg, "SCM_BIGDIG", 0);
 229 #ifndef SCM_DIGSTOOBIG
 230   if (SCM_DIGSPERLONG * sizeof (SCM_BIGDIG) > sizeof (long))
 231       fixconfig (addmsg, "SCM_DIGSTOOBIG", 0);
 232 #endif
 233 #endif
 234
 235 #ifdef SCM_STACK_GROWS_UP
 236   if (((SCM_STACKITEM *) & j - stack_start_ptr) < 0)
 237     fixconfig (remsg, "SCM_STACK_GROWS_UP", 1);
 238 #else
 239   if ((stack_start_ptr - (SCM_STACKITEM *) & j) < 0)
 240     fixconfig (addmsg, "SCM_STACK_GROWS_UP", 1);
 241 #endif
 242 }
 243 #endif
 244
 245
 246 \f
 247 /* initializing standard and current I/O ports */
 248
 249 typedef struct
 250 {
 251   int fdes;
 252   char *mode;
 253   char *name;
 254 } stream_body_data;
 255
 256 /* proc to be called in scope of exception handler stream_handler. */
 257 static SCM
 258 stream_body (void *data)
 259 {
 260   stream_body_data *body_data = (stream_body_data *) data;
 261   SCM port = scm_fdes_to_port (body_data->fdes, body_data->mode,
 262                                scm_makfrom0str (body_data->name));
 263
 264   SCM_REVEALED (port) = 1;
 265   return port;
 266 }
 267
 268 /* exception handler for stream_body.  */
 269 static SCM
 270 stream_handler (void *data, SCM tag, SCM throw_args)
 271 {
 272   return SCM_BOOL_F;
 273 }
 274
 275 /* Convert a file descriptor to a port, using scm_fdes_to_port.
 276    - NAME is a C string, not a Guile string
 277    - set the revealed count for FILE's file descriptor to 1, so
 278    that fdes won't be closed when the port object is GC'd.
 279    - catch exceptions: allow Guile to be able to start up even
 280    if it has been handed bogus stdin/stdout/stderr.  replace the
 281    bad ports with void ports.  */
 282 static SCM
 283 scm_standard_stream_to_port (int fdes, char *mode, char *name)
 284 {
 285   SCM port;
 286   stream_body_data body_data;
 287
 288   body_data.fdes = fdes;
 289   body_data.mode = mode;
 290   body_data.name = name;
 291   port = scm_internal_catch (SCM_BOOL_T, stream_body, &body_data,
 292                              stream_handler, NULL);
 293   if (SCM_FALSEP (port))
 294     port = scm_void_port (mode);
 295   return port;
 296 }
 297
 298 /* Create standard ports from stdin, stdout, and stderr.  */
 299 static void
 300 scm_init_standard_ports ()
 301 {
 302   /* From the SCSH manual:
 303
 304      It can be useful to turn I/O buffering off in some cases, for
 305      example when an I/O stream is to be shared by multiple
 306      subprocesses.  For this reason, scsh allocates an unbuffered port
 307      for file descriptor 0 at start-up time.
 308
 309      Because shells frequently share stdin with subprocesses, if the
 310      shell does buffered reads, it might ``steal'' input intended for
 311      a subprocess.  For this reason, all shells, including sh, csh,
 312      and scsh, read stdin unbuffered.  Applications that can tolerate
 313      buffered input on stdin can reset \ex{(current-input-port)} to
 314      block buffering for higher performance.  */
 315
 316   scm_def_inp
 317     = scm_standard_stream_to_port (0,
 318                                    isatty (0) ? "r0" : "r",
 319                                    "standard input");
 320   scm_def_outp = scm_standard_stream_to_port (1,
 321                                               isatty (1) ? "w0" : "w",
 322                                               "standard output");
 323   scm_def_errp = scm_standard_stream_to_port (2,
 324                                               isatty (2) ? "w0" : "w",
 325                                               "standard error");
 326
 327   scm_cur_inp = scm_def_inp;
 328   scm_cur_outp = scm_def_outp;
 329   scm_cur_errp = scm_def_errp;
 330   scm_cur_loadp = SCM_BOOL_F;
 331 }
 332
 333
 334 \f
 335 /* Loading the startup Scheme files.  */
 336
 337 /* The boot code "ice-9/boot-9" is only loaded by scm_boot_guile when
 338    this is false.  The unexec code uses this, to keep ice_9 from being
 339    loaded into dumped guile executables.  */
 340 int scm_ice_9_already_loaded = 0;
 341
 342 void
 343 scm_load_startup_files ()
 344 {
 345   /* We want a path only containing directories from GUILE_LOAD_PATH,
 346      SCM_SITE_DIR and SCM_LIBRARY_DIR when searching for the site init
 347      file, so we do this before loading Ice-9.  */
 348   SCM init_path = scm_sys_search_load_path (scm_makfrom0str ("init.scm"));
 349
 350   /* Load Ice-9.  */
 351   if (!scm_ice_9_already_loaded)
 352     {
 353       scm_primitive_load_path (scm_makfrom0str ("ice-9/boot-9.scm"));
 354
 355       /* Load the init.scm file.  */
 356       if (SCM_NFALSEP (init_path))
 357         scm_primitive_load (init_path);
 358
 359       scm_post_boot_init_modules ();
 360     }
 361 }
 362
 363 /* Get an integer from an environment variable.  */
 364 static int
 365 scm_i_getenv_int (const char *var, int def)
 366 {
 367   char *end, *val = getenv (var);
 368   long res;
 369   if (!val)
 370     return def;
 371   res = strtol (val, &end, 10);
 372   if (end == val)
 373     return def;
 374   return res;
 375 }
 376
 377 \f
 378 /* The main init code.  */
 379
 380 #ifdef _UNICOS
 381 typedef int setjmp_type;
 382 #else
 383 typedef long setjmp_type;
 384 #endif
 385
 386 /* All the data needed to invoke the main function.  */
 387 struct main_func_closure
 388 {
 389   /* the function to call */
 390   void (*main_func)(void *closure, int argc, char **argv);
 391   void *closure;                /* dummy data to pass it */
 392   int argc;
 393   char **argv;                  /* the argument list it should receive */
 394 };
 395
 396
 397 static void scm_boot_guile_1(SCM_STACKITEM *base, struct main_func_closure *closure);
 398 static SCM invoke_main_func(void *body_data);
 399
 400
 401 /* Fire up the Guile Scheme interpreter.
 402
 403    Call MAIN_FUNC, passing it CLOSURE, ARGC, and ARGV.  MAIN_FUNC
 404    should do all the work of the program (initializing other packages,
 405    reading user input, etc.) before returning.  When MAIN_FUNC
 406    returns, call exit (0); this function never returns.  If you want
 407    some other exit value, MAIN_FUNC may call exit itself.
 408
 409    scm_boot_guile arranges for program-arguments to return the strings
 410    given by ARGC and ARGV.  If MAIN_FUNC modifies ARGC/ARGV, should
 411    call scm_set_program_arguments with the final list, so Scheme code
 412    will know which arguments have been processed.
 413
 414    scm_boot_guile establishes a catch-all catch handler which prints
 415    an error message and exits the process.  This means that Guile
 416    exits in a coherent way when system errors occur and the user isn't
 417    prepared to handle it.  If the user doesn't like this behavior,
 418    they can establish their own universal catcher to shadow this one.
 419
 420    Why must the caller do all the real work from MAIN_FUNC?  The
 421    garbage collector assumes that all local variables of type SCM will
 422    be above scm_boot_guile's stack frame on the stack.  If you try to
 423    manipulate SCM values after this function returns, it's the luck of
 424    the draw whether the GC will be able to find the objects you
 425    allocate.  So, scm_boot_guile function exits, rather than
 426    returning, to discourage people from making that mistake.  */
 427
 428
 429 void
 430 scm_boot_guile (int argc, char ** argv, void (*main_func) (), void *closure)
 431 {
 432   /* The garbage collector uses the address of this variable as one
 433      end of the stack, and the address of one of its own local
 434      variables as the other end.  */
 435   SCM_STACKITEM dummy;
 436   struct main_func_closure c;
 437
 438   c.main_func = main_func;
 439   c.closure = closure;
 440   c.argc = argc;
 441   c.argv = argv;
 442
 443   scm_boot_guile_1 (&dummy, &c);
 444 }
 445
 446
 447 /* Record here whether SCM_BOOT_GUILE_1 has already been called.  This
 448    variable is now here and not inside SCM_BOOT_GUILE_1 so that one
 449    can tweak it. This is necessary for unexec to work. (Hey, "1-live"
 450    is the name of a local radiostation...) */
 451
 452 int scm_boot_guile_1_live = 0;
 453
 454 int scm_initialized_p = 0;
 455
 456 static void
 457 scm_boot_guile_1 (SCM_STACKITEM *base, struct main_func_closure *closure)
 458 {
 459   /* static int live = 0; */
 460   setjmp_type setjmp_val;
 461
 462   /* This function is not re-entrant. */
 463   if (scm_boot_guile_1_live)
 464     abort ();
 465
 466   scm_boot_guile_1_live = 1;
 467
 468   scm_ints_disabled = 1;
 469   scm_block_gc = 1;
 470
 471   if (scm_initialized_p)
 472     {
 473       restart_stack (base);
 474     }
 475   else
 476     {
 477       scm_ports_prehistory ();
 478       scm_smob_prehistory ();
 479       scm_tables_prehistory ();
 480 #ifdef GUILE_DEBUG_MALLOC
 481       scm_debug_malloc_prehistory ();
 482 #endif
 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_init_root ();
 492 #ifdef USE_THREADS
 493       scm_init_threads (base);
 494 #endif
 495       start_stack (base);
 496       scm_init_gsubr ();
 497       scm_init_feature ();
 498       scm_init_alist ();
 499       scm_init_arbiters ();
 500       scm_init_async ();
 501       scm_init_boolean ();
 502       scm_init_chars ();
 503       scm_init_continuations ();
 504 #ifdef GUILE_DEBUG_MALLOC
 505       scm_init_debug_malloc ();
 506 #endif
 507       scm_init_dynwind ();
 508       scm_init_eq ();
 509       scm_init_error ();
 510       scm_init_fluids ();
 511       scm_init_backtrace ();    /* Requires fluids */
 512       scm_init_fports ();
 513       scm_init_gdbint ();
 514       scm_init_hash ();
 515       scm_init_hashtab ();
 516       scm_init_objprop ();
 517       scm_init_hooks ();        /* Requires objprop until hook names are removed */
 518       scm_init_gc ();           /* Requires hooks, async */
 519 #ifdef GUILE_ISELECT
 520       scm_init_iselect ();
 521 #endif
 522       scm_init_ioext ();
 523       scm_init_keywords ();
 524       scm_init_list ();
 525       scm_init_macros ();
 526       scm_init_mallocs ();
 527       scm_init_modules ();
 528       scm_init_numbers ();
 529       scm_init_options ();
 530       scm_init_pairs ();
 531       scm_init_ports ();
 532 #ifdef HAVE_POSIX
 533       scm_init_filesys ();
 534       scm_init_posix ();
 535 #endif
 536 #ifdef HAVE_REGCOMP
 537       scm_init_regex_posix ();
 538 #endif
 539       scm_init_procs ();
 540       scm_init_procprop ();
 541       scm_init_scmsigs ();
 542 #ifdef HAVE_NETWORKING
 543       scm_init_net_db ();
 544       scm_init_socket ();
 545 #endif
 546       scm_init_sort ();
 547 #ifdef DEBUG_EXTENSIONS
 548       scm_init_srcprop ();
 549 #endif
 550       scm_init_stackchk ();
 551       scm_init_struct ();       /* Requires struct */
 552       scm_init_stacks ();
 553       scm_init_strports ();
 554       scm_init_symbols ();
 555       scm_init_tag ();
 556       scm_init_load ();
 557       scm_init_objects ();      /* Requires struct */
 558       scm_init_print ();        /* Requires struct */
 559       scm_init_read ();
 560       scm_init_stime ();
 561       scm_init_strings ();
 562       scm_init_strorder ();
 563       scm_init_strop ();
 564       scm_init_throw ();
 565       scm_init_variable ();
 566       scm_init_vectors ();
 567       scm_init_version ();
 568       scm_init_weaks ();
 569       scm_init_guardian ();
 570       scm_init_vports ();
 571       scm_init_eval ();
 572       scm_init_evalext ();
 573 #ifdef DEBUG_EXTENSIONS
 574       scm_init_debug ();        /* Requires macro smobs */
 575 #endif
 576       scm_init_random ();
 577 #ifdef HAVE_ARRAYS
 578       scm_init_ramap ();
 579       scm_init_unif ();
 580 #endif
 581       scm_init_simpos ();
 582       scm_init_load_path ();
 583       scm_init_standard_ports ();
 584       scm_init_dynamic_linking ();
 585       scm_init_lang ();
 586       scm_init_script ();
 587       scm_initialized_p = 1;
 588     }
 589
 590   scm_block_gc = 0;             /* permit the gc to run */
 591   /* ints still disabled */
 592
 593 #ifdef STACK_CHECKING
 594   scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
 595 #endif
 596
 597   setjmp_val = setjmp (SCM_JMPBUF (scm_rootcont));
 598   if (!setjmp_val)
 599     {
 600       scm_set_program_arguments (closure->argc, closure->argv, 0);
 601       scm_internal_lazy_catch (SCM_BOOL_T, invoke_main_func, closure,
 602                                scm_handle_by_message, 0);
 603     }
 604
 605   scm_restore_signals ();
 606
 607   /* This tick gives any pending
 608    * asyncs a chance to run.  This must be done after
 609    * the call to scm_restore_signals.
 610    */
 611   SCM_ASYNC_TICK;
 612
 613   /* If the caller doesn't want this, they should return from
 614      main_func themselves.  */
 615   exit (0);
 616 }
 617
 618
 619 static SCM
 620 invoke_main_func (void *body_data)
 621 {
 622   struct main_func_closure *closure = (struct main_func_closure *) body_data;
 623
 624   scm_load_startup_files ();
 625
 626   (*closure->main_func) (closure->closure, closure->argc, closure->argv);
 627
 628   /* never reached */
 629   return SCM_UNDEFINED;
 630 }
 631
 632 /*
 633   Local Variables:
 634   c-file-style: "gnu"
 635   End:
 636 */