libguile/init.c

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