libguile/init.c

   1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002 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
  43 \f
  44 /* Include the headers for just about everything.
  45    We call all their initialization functions.  */
  46
  47 #include <stdio.h>
  48 #include <sys/stat.h>
  49 #include <fcntl.h>
  50
  51 #include "libguile/_scm.h"
  52
  53 /* Everybody has an init function.  */
  54 #include "libguile/alist.h"
  55 #include "libguile/arbiters.h"
  56 #include "libguile/async.h"
  57 #include "libguile/backtrace.h"
  58 #include "libguile/boolean.h"
  59 #include "libguile/chars.h"
  60 #include "libguile/continuations.h"
  61 #ifdef DEBUG_EXTENSIONS
  62 #include "libguile/debug.h"
  63 #endif
  64 #ifdef GUILE_DEBUG_MALLOC
  65 #include "libguile/debug-malloc.h"
  66 #endif
  67 #include "libguile/deprecation.h"
  68 #include "libguile/dynl.h"
  69 #include "libguile/dynwind.h"
  70 #include "libguile/environments.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/goops.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/rdelim.h"
 115 #include "libguile/read.h"
 116 #include "libguile/rw.h"
 117 #include "libguile/scmsigs.h"
 118 #include "libguile/script.h"
 119 #include "libguile/simpos.h"
 120 #include "libguile/smob.h"
 121 #include "libguile/socket.h"
 122 #include "libguile/sort.h"
 123 #include "libguile/srcprop.h"
 124 #include "libguile/stackchk.h"
 125 #include "libguile/stacks.h"
 126 #include "libguile/stime.h"
 127 #include "libguile/strings.h"
 128 #include "libguile/strop.h"
 129 #include "libguile/strorder.h"
 130 #include "libguile/strports.h"
 131 #include "libguile/struct.h"
 132 #include "libguile/symbols.h"
 133 #include "libguile/throw.h"
 134 #include "libguile/unif.h"
 135 #include "libguile/values.h"
 136 #include "libguile/variable.h"
 137 #include "libguile/vectors.h"
 138 #include "libguile/version.h"
 139 #include "libguile/vports.h"
 140 #include "libguile/weaks.h"
 141 #include "libguile/guardians.h"
 142 #include "libguile/extensions.h"
 143
 144 #include "libguile/init.h"
 145
 146 #ifdef HAVE_STRING_H
 147 #include <string.h>
 148 #endif
 149 #ifdef HAVE_UNISTD_H
 150 #include <unistd.h>
 151 #endif
 152 \f
 153 /* Setting up the stack.  */
 154
 155 static void
 156 restart_stack (void *base)
 157 {
 158   scm_dynwinds = SCM_EOL;
 159   SCM_DYNENV (scm_rootcont) = SCM_EOL;
 160   SCM_THROW_VALUE (scm_rootcont) = SCM_EOL;
 161 #ifdef DEBUG_EXTENSIONS
 162   SCM_DFRAME (scm_rootcont) = scm_last_debug_frame = 0;
 163 #endif
 164   SCM_BASE (scm_rootcont) = base;
 165 }
 166
 167 static void
 168 start_stack (void *base)
 169 {
 170   SCM root;
 171
 172   root = scm_permanent_object (scm_make_root (SCM_UNDEFINED));
 173   scm_set_root (SCM_ROOT_STATE (root));
 174   scm_stack_base = base;
 175
 176   scm_exitval = SCM_BOOL_F;     /* vestigial */
 177
 178   scm_root->fluids = scm_make_initial_fluids ();
 179
 180   /* Create an object to hold the root continuation.
 181    */
 182   {
 183     scm_t_contregs *contregs = scm_gc_malloc (sizeof (scm_t_contregs),
 184                                               "continuation");
 185     contregs->num_stack_items = 0;
 186     contregs->seq = 0;
 187     SCM_NEWSMOB (scm_rootcont, scm_tc16_continuation, contregs);
 188   }
 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   size_t 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_UNUSED,
 267                 SCM tag SCM_UNUSED,
 268                 SCM throw_args SCM_UNUSED)
 269 {
 270   return SCM_BOOL_F;
 271 }
 272
 273 /* Convert a file descriptor to a port, using scm_fdes_to_port.
 274    - NAME is a C string, not a Guile string
 275    - set the revealed count for FILE's file descriptor to 1, so
 276    that fdes won't be closed when the port object is GC'd.
 277    - catch exceptions: allow Guile to be able to start up even
 278    if it has been handed bogus stdin/stdout/stderr.  replace the
 279    bad ports with void ports.  */
 280 static SCM
 281 scm_standard_stream_to_port (int fdes, char *mode, char *name)
 282 {
 283   SCM port;
 284   stream_body_data body_data;
 285
 286   body_data.fdes = fdes;
 287   body_data.mode = mode;
 288   body_data.name = name;
 289   port = scm_internal_catch (SCM_BOOL_T, stream_body, &body_data,
 290                              stream_handler, NULL);
 291   if (SCM_FALSEP (port))
 292     port = scm_void_port (mode);
 293   return port;
 294 }
 295
 296 /* Create standard ports from stdin, stdout, and stderr.  */
 297 static void
 298 scm_init_standard_ports ()
 299 {
 300   /* From the SCSH manual:
 301
 302      It can be useful to turn I/O buffering off in some cases, for
 303      example when an I/O stream is to be shared by multiple
 304      subprocesses.  For this reason, scsh allocates an unbuffered port
 305      for file descriptor 0 at start-up time.
 306
 307      Because shells frequently share stdin with subprocesses, if the
 308      shell does buffered reads, it might ``steal'' input intended for
 309      a subprocess.  For this reason, all shells, including sh, csh,
 310      and scsh, read stdin unbuffered.  Applications that can tolerate
 311      buffered input on stdin can reset \ex{(current-input-port)} to
 312      block buffering for higher performance.  */
 313
 314   scm_cur_inp
 315     = scm_standard_stream_to_port (0,
 316                                    isatty (0) ? "r0" : "r",
 317                                    "standard input");
 318   scm_cur_outp = scm_standard_stream_to_port (1,
 319                                               isatty (1) ? "w0" : "w",
 320                                               "standard output");
 321   scm_cur_errp = scm_standard_stream_to_port (2,
 322                                               isatty (2) ? "w0" : "w",
 323                                               "standard error");
 324
 325   scm_cur_loadp = SCM_BOOL_F;
 326 }
 327
 328
 329 \f
 330 /* Loading the startup Scheme files.  */
 331
 332 /* The boot code "ice-9/boot-9" is only loaded by scm_boot_guile when
 333    this is false.  The unexec code uses this, to keep ice_9 from being
 334    loaded into dumped guile executables.  */
 335 int scm_ice_9_already_loaded = 0;
 336
 337 void
 338 scm_load_startup_files ()
 339 {
 340   /* We want a path only containing directories from GUILE_LOAD_PATH,
 341      SCM_SITE_DIR and SCM_LIBRARY_DIR when searching for the site init
 342      file, so we do this before loading Ice-9.  */
 343   SCM init_path = scm_sys_search_load_path (scm_makfrom0str ("init.scm"));
 344
 345   /* Load Ice-9.  */
 346   if (!scm_ice_9_already_loaded)
 347     {
 348       scm_primitive_load_path (scm_makfrom0str ("ice-9/boot-9.scm"));
 349
 350       /* Load the init.scm file.  */
 351       if (SCM_NFALSEP (init_path))
 352         scm_primitive_load (init_path);
 353     }
 354 }
 355
 356 \f
 357 /* The main init code.  */
 358
 359 #ifdef _UNICOS
 360 typedef int setjmp_type;
 361 #else
 362 typedef long setjmp_type;
 363 #endif
 364
 365 /* All the data needed to invoke the main function.  */
 366 struct main_func_closure
 367 {
 368   /* the function to call */
 369   void (*main_func)(void *closure, int argc, char **argv);
 370   void *closure;                /* dummy data to pass it */
 371   int argc;
 372   char **argv;                  /* the argument list it should receive */
 373 };
 374
 375
 376 static void scm_init_guile_1 (SCM_STACKITEM *base);
 377 static void scm_boot_guile_1 (SCM_STACKITEM *base,
 378                               struct main_func_closure *closure);
 379 static SCM invoke_main_func(void *body_data);
 380
 381
 382 /* Fire up the Guile Scheme interpreter.
 383
 384    Call MAIN_FUNC, passing it CLOSURE, ARGC, and ARGV.  MAIN_FUNC
 385    should do all the work of the program (initializing other packages,
 386    reading user input, etc.) before returning.  When MAIN_FUNC
 387    returns, call exit (0); this function never returns.  If you want
 388    some other exit value, MAIN_FUNC may call exit itself.
 389
 390    scm_boot_guile arranges for program-arguments to return the strings
 391    given by ARGC and ARGV.  If MAIN_FUNC modifies ARGC/ARGV, should
 392    call scm_set_program_arguments with the final list, so Scheme code
 393    will know which arguments have been processed.
 394
 395    scm_boot_guile establishes a catch-all catch handler which prints
 396    an error message and exits the process.  This means that Guile
 397    exits in a coherent way when system errors occur and the user isn't
 398    prepared to handle it.  If the user doesn't like this behavior,
 399    they can establish their own universal catcher to shadow this one.
 400
 401    Why must the caller do all the real work from MAIN_FUNC?  The
 402    garbage collector assumes that all local variables of type SCM will
 403    be above scm_boot_guile's stack frame on the stack.  If you try to
 404    manipulate SCM values after this function returns, it's the luck of
 405    the draw whether the GC will be able to find the objects you
 406    allocate.  So, scm_boot_guile function exits, rather than
 407    returning, to discourage people from making that mistake.  */
 408
 409
 410 void
 411 scm_boot_guile (int argc, char ** argv, void (*main_func) (), void *closure)
 412 {
 413   /* The garbage collector uses the address of this variable as one
 414      end of the stack, and the address of one of its own local
 415      variables as the other end.  */
 416   SCM_STACKITEM dummy;
 417   struct main_func_closure c;
 418
 419   c.main_func = main_func;
 420   c.closure = closure;
 421   c.argc = argc;
 422   c.argv = argv;
 423
 424   scm_boot_guile_1 (&dummy, &c);
 425 }
 426
 427 void
 428 scm_init_guile ()
 429 {
 430   scm_init_guile_1 ((SCM_STACKITEM *)scm_get_stack_base ());
 431 }
 432
 433 int scm_initialized_p = 0;
 434
 435 static void
 436 scm_init_guile_1 (SCM_STACKITEM *base)
 437 {
 438   if (scm_initialized_p)
 439     return;
 440
 441   if (base == NULL)
 442     {
 443       fprintf (stderr, "cannot determine stack base!\n");
 444       abort ();
 445     }
 446
 447   scm_ints_disabled = 1;
 448   scm_block_gc = 1;
 449
 450   scm_ports_prehistory ();
 451   scm_smob_prehistory ();
 452   scm_tables_prehistory ();
 453 #ifdef GUILE_DEBUG_MALLOC
 454   scm_debug_malloc_prehistory ();
 455 #endif
 456   if (scm_init_storage ())                /* requires smob_prehistory */
 457     abort ();
 458
 459   scm_struct_prehistory ();       /* requires storage */
 460   scm_symbols_prehistory ();      /* requires storage */
 461   scm_weaks_prehistory ();        /* requires storage */
 462   scm_init_subr_table ();
 463   scm_environments_prehistory (); /* requires storage */
 464   scm_modules_prehistory ();      /* requires storage */
 465   scm_init_variable ();           /* all bindings need variables */
 466   scm_init_continuations ();
 467   scm_init_root ();               /* requires continuations */
 468 #ifdef USE_THREADS
 469   scm_init_threads (base);
 470 #endif
 471   start_stack (base);
 472   scm_init_gsubr ();
 473   scm_init_thread_procs ();    /* Requires gsubrs */
 474   scm_init_procprop ();
 475   scm_init_environments ();
 476   scm_init_feature ();
 477   scm_init_alist ();
 478   scm_init_arbiters ();
 479   scm_init_async ();
 480   scm_init_boolean ();
 481   scm_init_chars ();
 482 #ifdef GUILE_DEBUG_MALLOC
 483   scm_init_debug_malloc ();
 484 #endif
 485   scm_init_dynwind ();
 486   scm_init_eq ();
 487   scm_init_error ();
 488   scm_init_fluids ();
 489   scm_init_backtrace ();        /* Requires fluids */
 490   scm_init_fports ();
 491   scm_init_strports ();
 492   scm_init_gdbint ();           /* Requires strports */
 493   scm_init_hash ();
 494   scm_init_hashtab ();
 495   scm_init_deprecation ();      /* Requires hashtabs */
 496   scm_init_objprop ();
 497   scm_init_properties ();
 498   scm_init_hooks ();            /* Requires smob_prehistory */
 499   scm_init_gc ();               /* Requires hooks, async */
 500 #ifdef GUILE_ISELECT
 501   scm_init_iselect ();
 502 #endif
 503   scm_init_ioext ();
 504   scm_init_keywords ();
 505   scm_init_list ();
 506   scm_init_macros ();
 507   scm_init_mallocs ();
 508   scm_init_modules ();
 509   scm_init_numbers ();
 510   scm_init_options ();
 511   scm_init_pairs ();
 512   scm_init_ports ();
 513 #ifdef HAVE_POSIX
 514   scm_init_filesys ();
 515   scm_init_posix ();
 516 #endif
 517 #ifdef HAVE_REGCOMP
 518   scm_init_regex_posix ();
 519 #endif
 520   scm_init_procs ();
 521   scm_init_scmsigs ();
 522 #ifdef HAVE_NETWORKING
 523   scm_init_net_db ();
 524   scm_init_socket ();
 525 #endif
 526   scm_init_sort ();
 527 #ifdef DEBUG_EXTENSIONS
 528   scm_init_srcprop ();
 529 #endif
 530   scm_init_stackchk ();
 531   scm_init_strings ();
 532   scm_init_struct ();   /* Requires strings */
 533   scm_init_stacks ();   /* Requires strings, struct */
 534   scm_init_symbols ();
 535   scm_init_values ();   /* Requires struct */
 536   scm_init_load ();     /* Requires strings */
 537   scm_init_objects ();  /* Requires struct */
 538   scm_init_print ();    /* Requires strings, struct */
 539   scm_init_read ();
 540   scm_init_stime ();
 541   scm_init_strorder ();
 542   scm_init_strop ();
 543   scm_init_throw ();
 544   scm_init_vectors ();
 545   scm_init_version ();
 546   scm_init_weaks ();
 547   scm_init_guardians ();
 548   scm_init_vports ();
 549   scm_init_eval ();
 550   scm_init_evalext ();
 551 #ifdef DEBUG_EXTENSIONS
 552   scm_init_debug ();    /* Requires macro smobs */
 553 #endif
 554   scm_init_random ();
 555 #ifdef HAVE_ARRAYS
 556   scm_init_ramap ();
 557   scm_init_unif ();
 558 #endif
 559   scm_init_simpos ();
 560   scm_init_load_path ();
 561   scm_init_standard_ports ();  /* Requires fports */
 562 #ifdef DYNAMIC_LINKING
 563   scm_init_dynamic_linking ();
 564 #endif
 565 #ifdef SCM_ENABLE_ELISP
 566   scm_init_lang ();
 567 #endif /* SCM_ENABLE_ELISP */
 568   scm_init_script ();
 569
 570   scm_init_goops ();
 571
 572   scm_initialized_p = 1;
 573
 574   scm_block_gc = 0;             /* permit the gc to run */
 575   /* ints still disabled */
 576
 577 #ifdef STACK_CHECKING
 578   scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
 579 #endif
 580
 581   scm_init_rdelim ();
 582   scm_init_rw ();
 583   scm_init_extensions ();
 584
 585   scm_load_startup_files ();
 586 }
 587
 588 /* Record here whether SCM_BOOT_GUILE_1 has already been called.  This
 589    variable is now here and not inside SCM_BOOT_GUILE_1 so that one
 590    can tweak it. This is necessary for unexec to work. (Hey, "1-live"
 591    is the name of a local radiostation...) */
 592
 593 int scm_boot_guile_1_live = 0;
 594
 595 static void
 596 scm_boot_guile_1 (SCM_STACKITEM *base, struct main_func_closure *closure)
 597 {
 598   scm_init_guile_1 (base);
 599
 600   /* This function is not re-entrant. */
 601   if (scm_boot_guile_1_live)
 602     abort ();
 603
 604   scm_boot_guile_1_live = 1;
 605
 606   scm_set_program_arguments (closure->argc, closure->argv, 0);
 607   invoke_main_func (closure);
 608
 609   scm_restore_signals ();
 610
 611   /* This tick gives any pending
 612    * asyncs a chance to run.  This must be done after
 613    * the call to scm_restore_signals.
 614    */
 615   SCM_ASYNC_TICK;
 616
 617   /* If the caller doesn't want this, they should return from
 618      main_func themselves.  */
 619   exit (0);
 620 }
 621
 622 static SCM
 623 invoke_main_func (void *body_data)
 624 {
 625   struct main_func_closure *closure = (struct main_func_closure *) body_data;
 626
 627   (*closure->main_func) (closure->closure, closure->argc, closure->argv);
 628
 629   /* never reached */
 630   return SCM_UNDEFINED;
 631 }
 632
 633 /*
 634   Local Variables:
 635   c-file-style: "gnu"
 636   End:
 637 */