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