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