libguile/init.c

   1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003 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 #ifdef DEBUG_EXTENSIONS
  43 #include "libguile/debug.h"
  44 #endif
  45 #ifdef GUILE_DEBUG_MALLOC
  46 #include "libguile/debug-malloc.h"
  47 #endif
  48 #include "libguile/deprecation.h"
  49 #include "libguile/dynl.h"
  50 #include "libguile/dynwind.h"
  51 #include "libguile/environments.h"
  52 #include "libguile/eq.h"
  53 #include "libguile/error.h"
  54 #include "libguile/eval.h"
  55 #include "libguile/evalext.h"
  56 #include "libguile/feature.h"
  57 #include "libguile/filesys.h"
  58 #include "libguile/fluids.h"
  59 #include "libguile/fports.h"
  60 #include "libguile/futures.h"
  61 #include "libguile/gc.h"
  62 #include "libguile/gdbint.h"
  63 #include "libguile/goops.h"
  64 #include "libguile/gsubr.h"
  65 #include "libguile/hash.h"
  66 #include "libguile/hashtab.h"
  67 #include "libguile/hooks.h"
  68 #include "libguile/iselect.h"
  69 #include "libguile/ioext.h"
  70 #include "libguile/keywords.h"
  71 #include "libguile/lang.h"
  72 #include "libguile/list.h"
  73 #include "libguile/load.h"
  74 #include "libguile/macros.h"
  75 #include "libguile/mallocs.h"
  76 #include "libguile/modules.h"
  77 #include "libguile/net_db.h"
  78 #include "libguile/numbers.h"
  79 #include "libguile/objects.h"
  80 #include "libguile/objprop.h"
  81 #include "libguile/options.h"
  82 #include "libguile/pairs.h"
  83 #include "libguile/ports.h"
  84 #include "libguile/posix.h"
  85 #ifdef HAVE_REGCOMP
  86 #include "libguile/regex-posix.h"
  87 #endif
  88 #include "libguile/print.h"
  89 #include "libguile/procprop.h"
  90 #include "libguile/procs.h"
  91 #include "libguile/properties.h"
  92 #include "libguile/ramap.h"
  93 #include "libguile/random.h"
  94 #include "libguile/rdelim.h"
  95 #include "libguile/read.h"
  96 #include "libguile/rw.h"
  97 #include "libguile/scmsigs.h"
  98 #include "libguile/script.h"
  99 #include "libguile/simpos.h"
 100 #include "libguile/smob.h"
 101 #include "libguile/socket.h"
 102 #include "libguile/sort.h"
 103 #include "libguile/srcprop.h"
 104 #include "libguile/stackchk.h"
 105 #include "libguile/stacks.h"
 106 #include "libguile/stime.h"
 107 #include "libguile/strings.h"
 108 #include "libguile/strop.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/deprecated.h"
 124
 125 #include "libguile/init.h"
 126
 127 #ifdef HAVE_STRING_H
 128 #include <string.h>
 129 #endif
 130 #ifdef HAVE_UNISTD_H
 131 #include <unistd.h>
 132 #endif
 133 \f
 134 /* Setting up the stack.  */
 135
 136 static void
 137 restart_stack (void *base)
 138 {
 139   scm_dynwinds = SCM_EOL;
 140   SCM_DYNENV (scm_rootcont) = SCM_EOL;
 141   SCM_THROW_VALUE (scm_rootcont) = SCM_EOL;
 142 #ifdef DEBUG_EXTENSIONS
 143   SCM_DFRAME (scm_rootcont) = scm_last_debug_frame = 0;
 144 #endif
 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_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_makfrom0str (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_FALSEP (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 = scm_sys_search_load_path (scm_makfrom0str ("init.scm"));
 316
 317   /* Load Ice-9.  */
 318   if (!scm_ice_9_already_loaded)
 319     {
 320       scm_primitive_load_path (scm_makfrom0str ("ice-9/boot-9.scm"));
 321
 322       /* Load the init.scm file.  */
 323       if (SCM_NFALSEP (init_path))
 324         scm_primitive_load (init_path);
 325     }
 326 }
 327
 328 \f
 329 /* The main init code.  */
 330
 331 #ifdef _UNICOS
 332 typedef int setjmp_type;
 333 #else
 334 typedef long setjmp_type;
 335 #endif
 336
 337 /* All the data needed to invoke the main function.  */
 338 struct main_func_closure
 339 {
 340   /* the function to call */
 341   void (*main_func)(void *closure, int argc, char **argv);
 342   void *closure;                /* dummy data to pass it */
 343   int argc;
 344   char **argv;                  /* the argument list it should receive */
 345 };
 346
 347
 348 static void scm_init_guile_1 (SCM_STACKITEM *base);
 349 static void scm_boot_guile_1 (SCM_STACKITEM *base,
 350                               struct main_func_closure *closure);
 351 static SCM invoke_main_func(void *body_data);
 352
 353
 354 /* Fire up the Guile Scheme interpreter.
 355
 356    Call MAIN_FUNC, passing it CLOSURE, ARGC, and ARGV.  MAIN_FUNC
 357    should do all the work of the program (initializing other packages,
 358    reading user input, etc.) before returning.  When MAIN_FUNC
 359    returns, call exit (0); this function never returns.  If you want
 360    some other exit value, MAIN_FUNC may call exit itself.
 361
 362    scm_boot_guile arranges for program-arguments to return the strings
 363    given by ARGC and ARGV.  If MAIN_FUNC modifies ARGC/ARGV, should
 364    call scm_set_program_arguments with the final list, so Scheme code
 365    will know which arguments have been processed.
 366
 367    scm_boot_guile establishes a catch-all catch handler which prints
 368    an error message and exits the process.  This means that Guile
 369    exits in a coherent way when system errors occur and the user isn't
 370    prepared to handle it.  If the user doesn't like this behavior,
 371    they can establish their own universal catcher to shadow this one.
 372
 373    Why must the caller do all the real work from MAIN_FUNC?  The
 374    garbage collector assumes that all local variables of type SCM will
 375    be above scm_boot_guile's stack frame on the stack.  If you try to
 376    manipulate SCM values after this function returns, it's the luck of
 377    the draw whether the GC will be able to find the objects you
 378    allocate.  So, scm_boot_guile function exits, rather than
 379    returning, to discourage people from making that mistake.  */
 380
 381
 382 void
 383 scm_boot_guile (int argc, char ** argv, void (*main_func) (), void *closure)
 384 {
 385   /* The garbage collector uses the address of this variable as one
 386      end of the stack, and the address of one of its own local
 387      variables as the other end.  */
 388   SCM_STACKITEM dummy;
 389   struct main_func_closure c;
 390
 391   c.main_func = main_func;
 392   c.closure = closure;
 393   c.argc = argc;
 394   c.argv = argv;
 395
 396   scm_boot_guile_1 (&dummy, &c);
 397 }
 398
 399 void
 400 scm_init_guile ()
 401 {
 402   scm_init_guile_1 ((SCM_STACKITEM *)scm_get_stack_base ());
 403 }
 404
 405 int scm_initialized_p = 0;
 406
 407 static void
 408 scm_init_guile_1 (SCM_STACKITEM *base)
 409 {
 410   if (scm_initialized_p)
 411     return;
 412
 413   if (base == NULL)
 414     {
 415       fprintf (stderr, "cannot determine stack base!\n");
 416       abort ();
 417     }
 418
 419   if (sizeof (mpz_t) > (3 * sizeof (scm_t_bits)))
 420     {
 421       fprintf (stderr,
 422                "GMP's mpz_t must fit into a double_cell,"
 423                "but doesn't seem to here.\n");
 424     }
 425
 426   scm_block_gc = 1;
 427
 428   scm_storage_prehistory ();
 429   scm_threads_prehistory ();
 430   scm_ports_prehistory ();
 431   scm_smob_prehistory ();
 432   scm_hashtab_prehistory ();    /* requires storage_prehistory */
 433   scm_tables_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_ioext ();
 483   scm_init_keywords ();
 484   scm_init_list ();
 485   scm_init_macros ();
 486   scm_init_mallocs ();
 487   scm_init_modules ();
 488   scm_init_numbers ();
 489   scm_init_options ();
 490   scm_init_pairs ();
 491   scm_init_ports ();
 492 #ifdef HAVE_POSIX
 493   scm_init_filesys ();
 494   scm_init_posix ();
 495 #endif
 496 #ifdef HAVE_REGCOMP
 497   scm_init_regex_posix ();
 498 #endif
 499   scm_init_procs ();
 500   scm_init_scmsigs ();
 501 #ifdef HAVE_NETWORKING
 502   scm_init_net_db ();
 503   scm_init_socket ();
 504 #endif
 505   scm_init_sort ();
 506 #ifdef DEBUG_EXTENSIONS
 507   scm_init_srcprop ();
 508 #endif
 509   scm_init_stackchk ();
 510   scm_init_strings ();
 511   scm_init_struct ();   /* Requires strings */
 512   scm_init_stacks ();   /* Requires strings, struct */
 513   scm_init_symbols ();
 514   scm_init_values ();   /* Requires struct */
 515   scm_init_load ();     /* Requires strings */
 516   scm_init_objects ();  /* Requires struct */
 517   scm_init_print ();    /* Requires strings, struct */
 518   scm_init_read ();
 519   scm_init_stime ();
 520   scm_init_strorder ();
 521   scm_init_strop ();
 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 #ifdef DEBUG_EXTENSIONS
 531   scm_init_debug ();    /* Requires macro smobs */
 532 #endif
 533   scm_init_random ();
 534 #if SCM_HAVE_ARRAYS
 535   scm_init_ramap ();
 536   scm_init_unif ();
 537 #endif
 538   scm_init_simpos ();
 539   scm_init_load_path ();
 540   scm_init_standard_ports ();  /* Requires fports */
 541 #ifdef DYNAMIC_LINKING
 542   scm_init_dynamic_linking ();
 543 #endif
 544 #if SCM_ENABLE_ELISP
 545   scm_init_lang ();
 546 #endif /* SCM_ENABLE_ELISP */
 547   scm_init_script ();
 548
 549   scm_init_goops ();
 550
 551 #if SCM_ENABLE_DEPRECATED == 1
 552   scm_i_init_deprecated ();
 553 #endif
 554
 555   scm_initialized_p = 1;
 556
 557   scm_block_gc = 0;             /* permit the gc to run */
 558   /* ints still disabled */
 559
 560 #ifdef STACK_CHECKING
 561   scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
 562 #endif
 563
 564   scm_init_rdelim ();
 565   scm_init_rw ();
 566   scm_init_extensions ();
 567
 568   scm_load_startup_files ();
 569 }
 570
 571 /* Record here whether SCM_BOOT_GUILE_1 has already been called.  This
 572    variable is now here and not inside SCM_BOOT_GUILE_1 so that one
 573    can tweak it. This is necessary for unexec to work. (Hey, "1-live"
 574    is the name of a local radiostation...) */
 575
 576 int scm_boot_guile_1_live = 0;
 577
 578 static void
 579 scm_boot_guile_1 (SCM_STACKITEM *base, struct main_func_closure *closure)
 580 {
 581   scm_init_guile_1 (base);
 582
 583   /* This function is not re-entrant. */
 584   if (scm_boot_guile_1_live)
 585     abort ();
 586
 587   scm_boot_guile_1_live = 1;
 588
 589   scm_set_program_arguments (closure->argc, closure->argv, 0);
 590   invoke_main_func (closure);
 591
 592   scm_restore_signals ();
 593
 594   /* This tick gives any pending
 595    * asyncs a chance to run.  This must be done after
 596    * the call to scm_restore_signals.
 597    */
 598   SCM_ASYNC_TICK;
 599
 600   /* If the caller doesn't want this, they should return from
 601      main_func themselves.  */
 602   exit (0);
 603 }
 604
 605 static SCM
 606 invoke_main_func (void *body_data)
 607 {
 608   struct main_func_closure *closure = (struct main_func_closure *) body_data;
 609
 610   (*closure->main_func) (closure->closure, closure->argc, closure->argv);
 611
 612   /* never reached */
 613   return SCM_UNDEFINED;
 614 }
 615
 616 /*
 617   Local Variables:
 618   c-file-style: "gnu"
 619   End:
 620 */