libguile/init.c

   1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001 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/deprecation.h"
  70 #include "libguile/dynl.h"
  71 #include "libguile/dynwind.h"
  72 #include "libguile/environments.h"
  73 #include "libguile/eq.h"
  74 #include "libguile/error.h"
  75 #include "libguile/eval.h"
  76 #include "libguile/evalext.h"
  77 #include "libguile/feature.h"
  78 #include "libguile/filesys.h"
  79 #include "libguile/fluids.h"
  80 #include "libguile/fports.h"
  81 #include "libguile/gc.h"
  82 #include "libguile/gdbint.h"
  83 #include "libguile/goops.h"
  84 #include "libguile/gsubr.h"
  85 #include "libguile/hash.h"
  86 #include "libguile/hashtab.h"
  87 #include "libguile/hooks.h"
  88 #ifdef GUILE_ISELECT
  89 #include "libguile/iselect.h"
  90 #endif
  91 #include "libguile/ioext.h"
  92 #include "libguile/keywords.h"
  93 #include "libguile/lang.h"
  94 #include "libguile/list.h"
  95 #include "libguile/load.h"
  96 #include "libguile/macros.h"
  97 #include "libguile/mallocs.h"
  98 #include "libguile/modules.h"
  99 #include "libguile/net_db.h"
 100 #include "libguile/numbers.h"
 101 #include "libguile/objects.h"
 102 #include "libguile/objprop.h"
 103 #include "libguile/options.h"
 104 #include "libguile/pairs.h"
 105 #include "libguile/ports.h"
 106 #include "libguile/posix.h"
 107 #ifdef HAVE_REGCOMP
 108 #include "libguile/regex-posix.h"
 109 #endif
 110 #include "libguile/print.h"
 111 #include "libguile/procprop.h"
 112 #include "libguile/procs.h"
 113 #include "libguile/properties.h"
 114 #include "libguile/ramap.h"
 115 #include "libguile/random.h"
 116 #include "libguile/rdelim.h"
 117 #include "libguile/read.h"
 118 #include "libguile/rw.h"
 119 #include "libguile/scmsigs.h"
 120 #include "libguile/script.h"
 121 #include "libguile/simpos.h"
 122 #include "libguile/smob.h"
 123 #include "libguile/socket.h"
 124 #include "libguile/sort.h"
 125 #include "libguile/srcprop.h"
 126 #include "libguile/stackchk.h"
 127 #include "libguile/stacks.h"
 128 #include "libguile/stime.h"
 129 #include "libguile/strings.h"
 130 #include "libguile/strop.h"
 131 #include "libguile/strorder.h"
 132 #include "libguile/strports.h"
 133 #include "libguile/struct.h"
 134 #include "libguile/symbols.h"
 135 #include "libguile/tag.h"
 136 #include "libguile/throw.h"
 137 #include "libguile/unif.h"
 138 #include "libguile/values.h"
 139 #include "libguile/variable.h"
 140 #include "libguile/vectors.h"
 141 #include "libguile/version.h"
 142 #include "libguile/vports.h"
 143 #include "libguile/weaks.h"
 144 #include "libguile/guardians.h"
 145 #include "libguile/extensions.h"
 146
 147 #include "libguile/init.h"
 148
 149 #ifdef HAVE_STRING_H
 150 #include <string.h>
 151 #endif
 152 #ifdef HAVE_UNISTD_H
 153 #include <unistd.h>
 154 #endif
 155 \f
 156 /* Setting up the stack.  */
 157
 158 static void
 159 restart_stack (void *base)
 160 {
 161   scm_dynwinds = SCM_EOL;
 162   SCM_DYNENV (scm_rootcont) = SCM_EOL;
 163   SCM_THROW_VALUE (scm_rootcont) = SCM_EOL;
 164 #ifdef DEBUG_EXTENSIONS
 165   SCM_DFRAME (scm_rootcont) = scm_last_debug_frame = 0;
 166 #endif
 167   SCM_BASE (scm_rootcont) = base;
 168   scm_continuation_stack_ptr = SCM_MAKINUM (0);
 169 }
 170
 171 static void
 172 start_stack (void *base)
 173 {
 174   SCM root;
 175
 176   root = scm_permanent_object (scm_make_root (SCM_UNDEFINED));
 177   scm_set_root (SCM_ROOT_STATE (root));
 178   scm_stack_base = base;
 179
 180   scm_exitval = SCM_BOOL_F;     /* vestigial */
 181
 182 #if SCM_DEBUG_DEPRECATED == 0
 183   scm_top_level_lookup_closure_var = SCM_BOOL_F;
 184   scm_system_transformer = SCM_BOOL_F;
 185 #endif
 186
 187   scm_root->fluids = scm_make_initial_fluids ();
 188
 189   /* Create an object to hold the root continuation.
 190    */
 191   {
 192     scm_contregs_t *contregs = scm_must_malloc (sizeof (scm_contregs_t),
 193                                               "continuation");
 194     contregs->num_stack_items = 0;
 195     contregs->seq = 0;
 196     SCM_NEWSMOB (scm_rootcont, scm_tc16_continuation, contregs);
 197   }
 198   /* The root continuation is further initialized by restart_stack. */
 199
 200   /* Create the look-aside stack for variables that are shared between
 201    * captured continuations.
 202    */
 203   scm_continuation_stack = scm_c_make_vector (512, SCM_UNDEFINED);
 204   /* The continuation stack is further initialized by restart_stack. */
 205
 206   /* The remainder of stack initialization is factored out to another
 207    * function so that if this stack is ever exitted, it can be
 208    * re-entered using restart_stack.  */
 209   restart_stack (base);
 210 }
 211
 212
 213 #if 0
 214 static char remsg[] = "remove\n#define ", addmsg[] = "add\n#define ";
 215
 216
 217 static void
 218 fixconfig (char *s1,char *s2,int s)
 219 {
 220   fputs (s1, stderr);
 221   fputs (s2, stderr);
 222   fputs ("\nin ", stderr);
 223   fputs (s ? "setjump" : "scmfig", stderr);
 224   fputs (".h and recompile scm\n", stderr);
 225   exit (1);
 226 }
 227
 228
 229 static void
 230 check_config (void)
 231 {
 232   size_t j;
 233
 234   j = HEAP_SEG_SIZE;
 235   if (HEAP_SEG_SIZE != j)
 236     fixconfig ("reduce", "size of HEAP_SEG_SIZE", 0);
 237
 238 #ifdef SCM_BIGDIG
 239   if (2 * SCM_BITSPERDIG / SCM_CHAR_BIT > sizeof (long))
 240       fixconfig (remsg, "SCM_BIGDIG", 0);
 241 #ifndef SCM_DIGSTOOBIG
 242   if (SCM_DIGSPERLONG * sizeof (SCM_BIGDIG) > sizeof (long))
 243       fixconfig (addmsg, "SCM_DIGSTOOBIG", 0);
 244 #endif
 245 #endif
 246
 247 #ifdef SCM_STACK_GROWS_UP
 248   if (((SCM_STACKITEM *) & j - stack_start_ptr) < 0)
 249     fixconfig (remsg, "SCM_STACK_GROWS_UP", 1);
 250 #else
 251   if ((stack_start_ptr - (SCM_STACKITEM *) & j) < 0)
 252     fixconfig (addmsg, "SCM_STACK_GROWS_UP", 1);
 253 #endif
 254 }
 255 #endif
 256
 257
 258 \f
 259 /* initializing standard and current I/O ports */
 260
 261 typedef struct
 262 {
 263   int fdes;
 264   char *mode;
 265   char *name;
 266 } stream_body_data;
 267
 268 /* proc to be called in scope of exception handler stream_handler. */
 269 static SCM
 270 stream_body (void *data)
 271 {
 272   stream_body_data *body_data = (stream_body_data *) data;
 273   SCM port = scm_fdes_to_port (body_data->fdes, body_data->mode,
 274                                scm_makfrom0str (body_data->name));
 275
 276   SCM_REVEALED (port) = 1;
 277   return port;
 278 }
 279
 280 /* exception handler for stream_body.  */
 281 static SCM
 282 stream_handler (void *data SCM_UNUSED,
 283                 SCM tag SCM_UNUSED,
 284                 SCM throw_args SCM_UNUSED)
 285 {
 286   return SCM_BOOL_F;
 287 }
 288
 289 /* Convert a file descriptor to a port, using scm_fdes_to_port.
 290    - NAME is a C string, not a Guile string
 291    - set the revealed count for FILE's file descriptor to 1, so
 292    that fdes won't be closed when the port object is GC'd.
 293    - catch exceptions: allow Guile to be able to start up even
 294    if it has been handed bogus stdin/stdout/stderr.  replace the
 295    bad ports with void ports.  */
 296 static SCM
 297 scm_standard_stream_to_port (int fdes, char *mode, char *name)
 298 {
 299   SCM port;
 300   stream_body_data body_data;
 301
 302   body_data.fdes = fdes;
 303   body_data.mode = mode;
 304   body_data.name = name;
 305   port = scm_internal_catch (SCM_BOOL_T, stream_body, &body_data,
 306                              stream_handler, NULL);
 307   if (SCM_FALSEP (port))
 308     port = scm_void_port (mode);
 309   return port;
 310 }
 311
 312 /* Create standard ports from stdin, stdout, and stderr.  */
 313 static void
 314 scm_init_standard_ports ()
 315 {
 316   /* From the SCSH manual:
 317
 318      It can be useful to turn I/O buffering off in some cases, for
 319      example when an I/O stream is to be shared by multiple
 320      subprocesses.  For this reason, scsh allocates an unbuffered port
 321      for file descriptor 0 at start-up time.
 322
 323      Because shells frequently share stdin with subprocesses, if the
 324      shell does buffered reads, it might ``steal'' input intended for
 325      a subprocess.  For this reason, all shells, including sh, csh,
 326      and scsh, read stdin unbuffered.  Applications that can tolerate
 327      buffered input on stdin can reset \ex{(current-input-port)} to
 328      block buffering for higher performance.  */
 329
 330   scm_def_inp
 331     = scm_standard_stream_to_port (0,
 332                                    isatty (0) ? "r0" : "r",
 333                                    "standard input");
 334   scm_def_outp = scm_standard_stream_to_port (1,
 335                                               isatty (1) ? "w0" : "w",
 336                                               "standard output");
 337   scm_def_errp = scm_standard_stream_to_port (2,
 338                                               isatty (2) ? "w0" : "w",
 339                                               "standard error");
 340
 341   scm_cur_inp = scm_def_inp;
 342   scm_cur_outp = scm_def_outp;
 343   scm_cur_errp = scm_def_errp;
 344   scm_cur_loadp = SCM_BOOL_F;
 345 }
 346
 347
 348 \f
 349 /* Loading the startup Scheme files.  */
 350
 351 /* The boot code "ice-9/boot-9" is only loaded by scm_boot_guile when
 352    this is false.  The unexec code uses this, to keep ice_9 from being
 353    loaded into dumped guile executables.  */
 354 int scm_ice_9_already_loaded = 0;
 355
 356 void
 357 scm_load_startup_files ()
 358 {
 359   /* We want a path only containing directories from GUILE_LOAD_PATH,
 360      SCM_SITE_DIR and SCM_LIBRARY_DIR when searching for the site init
 361      file, so we do this before loading Ice-9.  */
 362   SCM init_path = scm_sys_search_load_path (scm_makfrom0str ("init.scm"));
 363
 364   /* Load Ice-9.  */
 365   if (!scm_ice_9_already_loaded)
 366     {
 367       scm_primitive_load_path (scm_makfrom0str ("ice-9/boot-9.scm"));
 368
 369       /* Load the init.scm file.  */
 370       if (SCM_NFALSEP (init_path))
 371         scm_primitive_load (init_path);
 372     }
 373 }
 374
 375 \f
 376 /* The main init code.  */
 377
 378 #ifdef _UNICOS
 379 typedef int setjmp_type;
 380 #else
 381 typedef long setjmp_type;
 382 #endif
 383
 384 /* All the data needed to invoke the main function.  */
 385 struct main_func_closure
 386 {
 387   /* the function to call */
 388   void (*main_func)(void *closure, int argc, char **argv);
 389   void *closure;                /* dummy data to pass it */
 390   int argc;
 391   char **argv;                  /* the argument list it should receive */
 392 };
 393
 394
 395 static void scm_init_guile_1 (SCM_STACKITEM *base);
 396 static void scm_boot_guile_1 (SCM_STACKITEM *base,
 397                               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 void
 447 scm_init_guile ()
 448 {
 449   scm_init_guile_1 ((SCM_STACKITEM *)scm_get_stack_base ());
 450 }
 451
 452 int scm_initialized_p = 0;
 453
 454 static void
 455 scm_init_guile_1 (SCM_STACKITEM *base)
 456 {
 457   if (scm_initialized_p)
 458     return;
 459
 460   if (base == NULL)
 461     {
 462       fprintf (stderr, "cannot determine stack base!\n");
 463       abort ();
 464     }
 465
 466   scm_ints_disabled = 1;
 467   scm_block_gc = 1;
 468
 469   scm_ports_prehistory ();
 470   scm_smob_prehistory ();
 471   scm_tables_prehistory ();
 472 #ifdef GUILE_DEBUG_MALLOC
 473   scm_debug_malloc_prehistory ();
 474 #endif
 475   scm_init_storage ();            /* requires smob_prehistory */
 476   scm_struct_prehistory ();       /* requires storage */
 477   scm_symbols_prehistory ();      /* requires storage */
 478   scm_weaks_prehistory ();        /* requires storage */
 479   scm_init_subr_table ();
 480   scm_environments_prehistory (); /* requires storage */
 481   scm_modules_prehistory ();      /* requires storage */
 482   scm_init_variable ();           /* all bindings need variables */
 483   scm_init_continuations ();
 484   scm_init_root ();               /* requires continuations */
 485 #ifdef USE_THREADS
 486   scm_init_threads (base);
 487 #endif
 488   start_stack (base);
 489   scm_init_gsubr ();
 490   scm_init_procprop ();
 491   scm_init_environments ();
 492   scm_init_feature ();
 493   scm_init_alist ();
 494   scm_init_arbiters ();
 495   scm_init_async ();
 496   scm_init_boolean ();
 497   scm_init_chars ();
 498 #ifdef GUILE_DEBUG_MALLOC
 499   scm_init_debug_malloc ();
 500 #endif
 501   scm_init_dynwind ();
 502   scm_init_eq ();
 503   scm_init_error ();
 504   scm_init_fluids ();
 505   scm_init_backtrace ();        /* Requires fluids */
 506   scm_init_fports ();
 507   scm_init_strports ();
 508   scm_init_gdbint ();           /* Requires strports */
 509   scm_init_hash ();
 510   scm_init_hashtab ();
 511   scm_init_deprecation ();      /* Requires hashtabs */
 512   scm_init_objprop ();
 513   scm_init_properties ();
 514   scm_init_hooks ();            /* Requires smob_prehistory */
 515   scm_init_gc ();               /* Requires hooks, async */
 516 #ifdef GUILE_ISELECT
 517   scm_init_iselect ();
 518 #endif
 519   scm_init_ioext ();
 520   scm_init_keywords ();
 521   scm_init_list ();
 522   scm_init_macros ();
 523   scm_init_mallocs ();
 524   scm_init_modules ();
 525   scm_init_numbers ();
 526   scm_init_options ();
 527   scm_init_pairs ();
 528   scm_init_ports ();
 529 #ifdef HAVE_POSIX
 530   scm_init_filesys ();
 531   scm_init_posix ();
 532 #endif
 533 #ifdef HAVE_REGCOMP
 534   scm_init_regex_posix ();
 535 #endif
 536   scm_init_procs ();
 537   scm_init_scmsigs ();
 538 #ifdef HAVE_NETWORKING
 539   scm_init_net_db ();
 540   scm_init_socket ();
 541 #endif
 542   scm_init_sort ();
 543 #ifdef DEBUG_EXTENSIONS
 544   scm_init_srcprop ();
 545 #endif
 546   scm_init_stackchk ();
 547   scm_init_strings ();
 548   scm_init_struct ();   /* Requires strings */
 549   scm_init_stacks ();   /* Requires strings, struct */
 550   scm_init_symbols ();
 551   scm_init_tag ();
 552   scm_init_values ();   /* Requires struct */
 553   scm_init_load ();     /* Requires strings */
 554   scm_init_objects ();  /* Requires struct */
 555   scm_init_print ();    /* Requires strings, struct */
 556   scm_init_read ();
 557   scm_init_stime ();
 558   scm_init_strorder ();
 559   scm_init_strop ();
 560   scm_init_throw ();
 561   scm_init_vectors ();
 562   scm_init_version ();
 563   scm_init_weaks ();
 564   scm_init_guardians ();
 565   scm_init_vports ();
 566   scm_init_eval ();
 567   scm_init_evalext ();
 568 #ifdef DEBUG_EXTENSIONS
 569   scm_init_debug ();    /* Requires macro smobs */
 570 #endif
 571   scm_init_random ();
 572 #ifdef HAVE_ARRAYS
 573   scm_init_ramap ();
 574   scm_init_unif ();
 575 #endif
 576   scm_init_simpos ();
 577   scm_init_load_path ();
 578   scm_init_standard_ports ();  /* Requires fports */
 579   scm_init_dynamic_linking ();
 580   scm_init_lang ();
 581   scm_init_script ();
 582
 583   scm_init_goops ();
 584
 585   scm_initialized_p = 1;
 586
 587   scm_block_gc = 0;             /* permit the gc to run */
 588   /* ints still disabled */
 589
 590 #ifdef STACK_CHECKING
 591   scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
 592 #endif
 593
 594   scm_init_rdelim ();
 595   scm_init_rw ();
 596   scm_init_extensions ();
 597
 598   scm_load_startup_files ();
 599 }
 600
 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...) */
 605
 606 int scm_boot_guile_1_live = 0;
 607
 608 static void
 609 scm_boot_guile_1 (SCM_STACKITEM *base, struct main_func_closure *closure)
 610 {
 611   scm_init_guile_1 (base);
 612
 613   /* This function is not re-entrant. */
 614   if (scm_boot_guile_1_live)
 615     abort ();
 616
 617   scm_boot_guile_1_live = 1;
 618
 619   scm_set_program_arguments (closure->argc, closure->argv, 0);
 620   invoke_main_func (closure);
 621
 622   scm_restore_signals ();
 623
 624   /* This tick gives any pending
 625    * asyncs a chance to run.  This must be done after
 626    * the call to scm_restore_signals.
 627    */
 628   SCM_ASYNC_TICK;
 629
 630   /* If the caller doesn't want this, they should return from
 631      main_func themselves.  */
 632   exit (0);
 633 }
 634
 635 static SCM
 636 invoke_main_func (void *body_data)
 637 {
 638   struct main_func_closure *closure = (struct main_func_closure *) body_data;
 639
 640   (*closure->main_func) (closure->closure, closure->argc, closure->argv);
 641
 642   /* never reached */
 643   return SCM_UNDEFINED;
 644 }
 645
 646 /*
 647   Local Variables:
 648   c-file-style: "gnu"
 649   End:
 650 */