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