libguile/init.c

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