libguile/init.c

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