libguile/init.c

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