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