libguile/init.c

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