libguile/init.c

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