libguile/init.c

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