libguile/init.c

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