libguile/init.c

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