libguile/init.c

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