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/dynl.h"
  70 #include "libguile/dynwind.h"
  71 #include "libguile/environments.h"
  72 #include "libguile/eq.h"
  73 #include "libguile/error.h"
  74 #include "libguile/eval.h"
  75 #include "libguile/evalext.h"
  76 #include "libguile/feature.h"
  77 #include "libguile/filesys.h"
  78 #include "libguile/fluids.h"
  79 #include "libguile/fports.h"
  80 #include "libguile/gc.h"
  81 #include "libguile/gdbint.h"
  82 #include "libguile/goops.h"
  83 #include "libguile/gsubr.h"
  84 #include "libguile/hash.h"
  85 #include "libguile/hashtab.h"
  86 #include "libguile/hooks.h"
  87 #ifdef GUILE_ISELECT
  88 #include "libguile/iselect.h"
  89 #endif
  90 #include "libguile/ioext.h"
  91 #include "libguile/keywords.h"
  92 #include "libguile/lang.h"
  93 #include "libguile/list.h"
  94 #include "libguile/load.h"
  95 #include "libguile/macros.h"
  96 #include "libguile/mallocs.h"
  97 #include "libguile/modules.h"
  98 #include "libguile/net_db.h"
  99 #include "libguile/numbers.h"
 100 #include "libguile/objects.h"
 101 #include "libguile/objprop.h"
 102 #include "libguile/options.h"
 103 #include "libguile/pairs.h"
 104 #include "libguile/ports.h"
 105 #include "libguile/posix.h"
 106 #ifdef HAVE_REGCOMP
 107 #include "libguile/regex-posix.h"
 108 #endif
 109 #include "libguile/print.h"
 110 #include "libguile/procprop.h"
 111 #include "libguile/procs.h"
 112 #include "libguile/properties.h"
 113 #include "libguile/ramap.h"
 114 #include "libguile/random.h"
 115 #include "libguile/rdelim.h"
 116 #include "libguile/read.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/tag.h"
 134 #include "libguile/throw.h"
 135 #include "libguile/unif.h"
 136 #include "libguile/values.h"
 137 #include "libguile/variable.h"
 138 #include "libguile/vectors.h"
 139 #include "libguile/version.h"
 140 #include "libguile/vports.h"
 141 #include "libguile/weaks.h"
 142 #include "libguile/guardians.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   scm_continuation_stack_ptr = SCM_MAKINUM (0);
 166 }
 167
 168 static void
 169 start_stack (void *base)
 170 {
 171   SCM root;
 172
 173   root = scm_permanent_object (scm_make_root (SCM_UNDEFINED));
 174   scm_set_root (SCM_ROOT_STATE (root));
 175   scm_stack_base = base;
 176
 177   scm_exitval = SCM_BOOL_F;     /* vestigial */
 178
 179 #if SCM_DEBUG_DEPRECATED == 0
 180   scm_top_level_lookup_closure_var = SCM_BOOL_F;
 181   scm_system_transformer = SCM_BOOL_F;
 182 #endif
 183
 184   scm_root->fluids = scm_make_initial_fluids ();
 185
 186   /* Create an object to hold the root continuation.
 187    */
 188   {
 189     scm_contregs *contregs = scm_must_malloc (sizeof (scm_contregs),
 190                                               "continuation");
 191     contregs->num_stack_items = 0;
 192     contregs->seq = 0;
 193     SCM_NEWSMOB (scm_rootcont, scm_tc16_continuation, contregs);
 194   }
 195   /* The root continuation is further initialized by restart_stack. */
 196
 197   /* Create the look-aside stack for variables that are shared between
 198    * captured continuations.
 199    */
 200   scm_continuation_stack = scm_c_make_vector (512, SCM_UNDEFINED);
 201   /* The continuation stack is further initialized by restart_stack. */
 202
 203   /* The remainder of stack initialization is factored out to another
 204    * function so that if this stack is ever exitted, it can be
 205    * re-entered using restart_stack.  */
 206   restart_stack (base);
 207 }
 208
 209
 210 #if 0
 211 static char remsg[] = "remove\n#define ", addmsg[] = "add\n#define ";
 212
 213
 214 static void
 215 fixconfig (char *s1,char *s2,int s)
 216 {
 217   fputs (s1, stderr);
 218   fputs (s2, stderr);
 219   fputs ("\nin ", stderr);
 220   fputs (s ? "setjump" : "scmfig", stderr);
 221   fputs (".h and recompile scm\n", stderr);
 222   exit (1);
 223 }
 224
 225
 226 static void
 227 check_config (void)
 228 {
 229   scm_sizet j;
 230
 231   j = HEAP_SEG_SIZE;
 232   if (HEAP_SEG_SIZE != j)
 233     fixconfig ("reduce", "size of HEAP_SEG_SIZE", 0);
 234
 235 #ifdef SCM_BIGDIG
 236   if (2 * SCM_BITSPERDIG / SCM_CHAR_BIT > sizeof (long))
 237       fixconfig (remsg, "SCM_BIGDIG", 0);
 238 #ifndef SCM_DIGSTOOBIG
 239   if (SCM_DIGSPERLONG * sizeof (SCM_BIGDIG) > sizeof (long))
 240       fixconfig (addmsg, "SCM_DIGSTOOBIG", 0);
 241 #endif
 242 #endif
 243
 244 #ifdef SCM_STACK_GROWS_UP
 245   if (((SCM_STACKITEM *) & j - stack_start_ptr) < 0)
 246     fixconfig (remsg, "SCM_STACK_GROWS_UP", 1);
 247 #else
 248   if ((stack_start_ptr - (SCM_STACKITEM *) & j) < 0)
 249     fixconfig (addmsg, "SCM_STACK_GROWS_UP", 1);
 250 #endif
 251 }
 252 #endif
 253
 254
 255 \f
 256 /* initializing standard and current I/O ports */
 257
 258 typedef struct
 259 {
 260   int fdes;
 261   char *mode;
 262   char *name;
 263 } stream_body_data;
 264
 265 /* proc to be called in scope of exception handler stream_handler. */
 266 static SCM
 267 stream_body (void *data)
 268 {
 269   stream_body_data *body_data = (stream_body_data *) data;
 270   SCM port = scm_fdes_to_port (body_data->fdes, body_data->mode,
 271                                scm_makfrom0str (body_data->name));
 272
 273   SCM_REVEALED (port) = 1;
 274   return port;
 275 }
 276
 277 /* exception handler for stream_body.  */
 278 static SCM
 279 stream_handler (void *data, SCM tag, SCM throw_args)
 280 {
 281   return SCM_BOOL_F;
 282 }
 283
 284 /* Convert a file descriptor to a port, using scm_fdes_to_port.
 285    - NAME is a C string, not a Guile string
 286    - set the revealed count for FILE's file descriptor to 1, so
 287    that fdes won't be closed when the port object is GC'd.
 288    - catch exceptions: allow Guile to be able to start up even
 289    if it has been handed bogus stdin/stdout/stderr.  replace the
 290    bad ports with void ports.  */
 291 static SCM
 292 scm_standard_stream_to_port (int fdes, char *mode, char *name)
 293 {
 294   SCM port;
 295   stream_body_data body_data;
 296
 297   body_data.fdes = fdes;
 298   body_data.mode = mode;
 299   body_data.name = name;
 300   port = scm_internal_catch (SCM_BOOL_T, stream_body, &body_data,
 301                              stream_handler, NULL);
 302   if (SCM_FALSEP (port))
 303     port = scm_void_port (mode);
 304   return port;
 305 }
 306
 307 /* Create standard ports from stdin, stdout, and stderr.  */
 308 static void
 309 scm_init_standard_ports ()
 310 {
 311   /* From the SCSH manual:
 312
 313      It can be useful to turn I/O buffering off in some cases, for
 314      example when an I/O stream is to be shared by multiple
 315      subprocesses.  For this reason, scsh allocates an unbuffered port
 316      for file descriptor 0 at start-up time.
 317
 318      Because shells frequently share stdin with subprocesses, if the
 319      shell does buffered reads, it might ``steal'' input intended for
 320      a subprocess.  For this reason, all shells, including sh, csh,
 321      and scsh, read stdin unbuffered.  Applications that can tolerate
 322      buffered input on stdin can reset \ex{(current-input-port)} to
 323      block buffering for higher performance.  */
 324
 325   scm_def_inp
 326     = scm_standard_stream_to_port (0,
 327                                    isatty (0) ? "r0" : "r",
 328                                    "standard input");
 329   scm_def_outp = scm_standard_stream_to_port (1,
 330                                               isatty (1) ? "w0" : "w",
 331                                               "standard output");
 332   scm_def_errp = scm_standard_stream_to_port (2,
 333                                               isatty (2) ? "w0" : "w",
 334                                               "standard error");
 335
 336   scm_cur_inp = scm_def_inp;
 337   scm_cur_outp = scm_def_outp;
 338   scm_cur_errp = scm_def_errp;
 339   scm_cur_loadp = SCM_BOOL_F;
 340 }
 341
 342
 343 \f
 344 /* Loading the startup Scheme files.  */
 345
 346 /* The boot code "ice-9/boot-9" is only loaded by scm_boot_guile when
 347    this is false.  The unexec code uses this, to keep ice_9 from being
 348    loaded into dumped guile executables.  */
 349 int scm_ice_9_already_loaded = 0;
 350
 351 void
 352 scm_load_startup_files ()
 353 {
 354   /* We want a path only containing directories from GUILE_LOAD_PATH,
 355      SCM_SITE_DIR and SCM_LIBRARY_DIR when searching for the site init
 356      file, so we do this before loading Ice-9.  */
 357   SCM init_path = scm_sys_search_load_path (scm_makfrom0str ("init.scm"));
 358
 359   /* Load Ice-9.  */
 360   if (!scm_ice_9_already_loaded)
 361     {
 362       scm_primitive_load_path (scm_makfrom0str ("ice-9/boot-9.scm"));
 363
 364       /* Load the init.scm file.  */
 365       if (SCM_NFALSEP (init_path))
 366         scm_primitive_load (init_path);
 367
 368       scm_post_boot_init_modules ();
 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 ();
 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_init_continuations ();
 479   scm_init_root ();               /* requires continuations */
 480 #ifdef USE_THREADS
 481   scm_init_threads (base);
 482 #endif
 483   start_stack (base);
 484   scm_init_gsubr ();
 485   scm_init_procprop ();
 486   scm_init_environments ();
 487   scm_init_feature ();
 488   scm_init_alist ();
 489   scm_init_arbiters ();
 490   scm_init_async ();
 491   scm_init_boolean ();
 492   scm_init_chars ();
 493 #ifdef GUILE_DEBUG_MALLOC
 494   scm_init_debug_malloc ();
 495 #endif
 496   scm_init_dynwind ();
 497   scm_init_eq ();
 498   scm_init_error ();
 499   scm_init_fluids ();
 500   scm_init_backtrace ();        /* Requires fluids */
 501   scm_init_fports ();
 502   scm_init_strports ();
 503   scm_init_gdbint ();           /* Requires strports */
 504   scm_init_hash ();
 505   scm_init_hashtab ();
 506   scm_init_objprop ();
 507   scm_init_properties ();
 508   scm_init_hooks ();        /* Requires objprop until hook names are removed */
 509   scm_init_gc ();               /* Requires hooks, async */
 510 #ifdef GUILE_ISELECT
 511   scm_init_iselect ();
 512 #endif
 513   scm_init_ioext ();
 514   scm_init_keywords ();
 515   scm_init_list ();
 516   scm_init_macros ();
 517   scm_init_mallocs ();
 518   scm_init_modules ();
 519   scm_init_numbers ();
 520   scm_init_options ();
 521   scm_init_pairs ();
 522   scm_init_ports ();
 523 #ifdef HAVE_POSIX
 524   scm_init_filesys ();
 525   scm_init_posix ();
 526 #endif
 527 #ifdef HAVE_REGCOMP
 528   scm_init_regex_posix ();
 529 #endif
 530   scm_init_procs ();
 531   scm_init_scmsigs ();
 532 #ifdef HAVE_NETWORKING
 533   scm_init_net_db ();
 534   scm_init_socket ();
 535 #endif
 536   scm_init_sort ();
 537 #ifdef DEBUG_EXTENSIONS
 538   scm_init_srcprop ();
 539 #endif
 540   scm_init_stackchk ();
 541   scm_init_struct ();
 542   scm_init_stacks ();   /* Requires struct */
 543   scm_init_symbols ();
 544   scm_init_tag ();
 545   scm_init_values ();   /* Requires struct */
 546   scm_init_load ();
 547   scm_init_objects ();  /* Requires struct */
 548   scm_init_print ();    /* Requires struct */
 549   scm_init_read ();
 550   scm_init_stime ();
 551   scm_init_strings ();
 552   scm_init_strorder ();
 553   scm_init_strop ();
 554   scm_init_throw ();
 555   scm_init_variable ();
 556   scm_init_vectors ();
 557   scm_init_version ();
 558   scm_init_weaks ();
 559   scm_init_guardians ();
 560   scm_init_vports ();
 561   scm_init_eval ();
 562   scm_init_evalext ();
 563 #ifdef DEBUG_EXTENSIONS
 564   scm_init_debug ();    /* Requires macro smobs */
 565 #endif
 566   scm_init_random ();
 567 #ifdef HAVE_ARRAYS
 568   scm_init_ramap ();
 569   scm_init_unif ();
 570 #endif
 571   scm_init_simpos ();
 572   scm_init_load_path ();
 573   scm_init_standard_ports ();  /* Requires fports */
 574   scm_init_dynamic_linking ();
 575   scm_init_lang ();
 576   scm_init_script ();
 577
 578   scm_init_oop_goops_goopscore_module ();
 579
 580   scm_initialized_p = 1;
 581
 582   scm_block_gc = 0;             /* permit the gc to run */
 583   /* ints still disabled */
 584
 585 #ifdef STACK_CHECKING
 586   scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
 587 #endif
 588
 589   scm_load_startup_files ();
 590
 591   /* this is located here, not from a deep understanding of the
 592      module system, but as a way of avoiding segv and other
 593      undesirable side effects that arise from various alternatives.  */
 594   scm_init_rdelim ();
 595 }
 596
 597 /* Record here whether SCM_BOOT_GUILE_1 has already been called.  This
 598    variable is now here and not inside SCM_BOOT_GUILE_1 so that one
 599    can tweak it. This is necessary for unexec to work. (Hey, "1-live"
 600    is the name of a local radiostation...) */
 601
 602 int scm_boot_guile_1_live = 0;
 603
 604 static void
 605 scm_boot_guile_1 (SCM_STACKITEM *base, struct main_func_closure *closure)
 606 {
 607   scm_init_guile_1 (base);
 608
 609   /* This function is not re-entrant. */
 610   if (scm_boot_guile_1_live)
 611     abort ();
 612
 613   scm_boot_guile_1_live = 1;
 614
 615   scm_set_program_arguments (closure->argc, closure->argv, 0);
 616   invoke_main_func (closure);
 617
 618   scm_restore_signals ();
 619
 620   /* This tick gives any pending
 621    * asyncs a chance to run.  This must be done after
 622    * the call to scm_restore_signals.
 623    */
 624   SCM_ASYNC_TICK;
 625
 626   /* If the caller doesn't want this, they should return from
 627      main_func themselves.  */
 628   exit (0);
 629 }
 630
 631 static SCM
 632 invoke_main_func (void *body_data)
 633 {
 634   struct main_func_closure *closure = (struct main_func_closure *) body_data;
 635
 636   (*closure->main_func) (closure->closure, closure->argc, closure->argv);
 637
 638   /* never reached */
 639   return SCM_UNDEFINED;
 640 }
 641
 642 /*
 643   Local Variables:
 644   c-file-style: "gnu"
 645   End:
 646 */