libguile/init.c

   1 /* Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
   2  *   2004, 2006, 2009, 2010, 2011, 2012 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/gdbint.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/iselect.h"
  79 #include "libguile/ioext.h"
  80 #include "libguile/keywords.h"
  81 #include "libguile/list.h"
  82 #include "libguile/load.h"
  83 #include "libguile/macros.h"
  84 #include "libguile/mallocs.h"
  85 #include "libguile/memoize.h"
  86 #include "libguile/modules.h"
  87 #include "libguile/net_db.h"
  88 #include "libguile/numbers.h"
  89 #include "libguile/objcodes.h"
  90 #include "libguile/objprop.h"
  91 #include "libguile/options.h"
  92 #include "libguile/pairs.h"
  93 #include "libguile/poll.h"
  94 #include "libguile/ports.h"
  95 #include "libguile/posix.h"
  96 #ifdef ENABLE_REGEX
  97 #include "libguile/regex-posix.h"
  98 #endif
  99 #include "libguile/print.h"
 100 #include "libguile/procprop.h"
 101 #include "libguile/procs.h"
 102 #include "libguile/programs.h"
 103 #include "libguile/promises.h"
 104 #include "libguile/array-map.h"
 105 #include "libguile/random.h"
 106 #include "libguile/rdelim.h"
 107 #include "libguile/read.h"
 108 #include "libguile/rw.h"
 109 #include "libguile/scmsigs.h"
 110 #include "libguile/script.h"
 111 #include "libguile/simpos.h"
 112 #include "libguile/smob.h"
 113 #include "libguile/socket.h"
 114 #include "libguile/sort.h"
 115 #include "libguile/srcprop.h"
 116 #include "libguile/stackchk.h"
 117 #include "libguile/stacks.h"
 118 #include "libguile/stime.h"
 119 #include "libguile/strings.h"
 120 #include "libguile/srfi-1.h"
 121 #include "libguile/srfi-4.h"
 122 #include "libguile/srfi-13.h"
 123 #include "libguile/srfi-14.h"
 124 #include "libguile/srfi-60.h"
 125 #include "libguile/strorder.h"
 126 #include "libguile/strports.h"
 127 #include "libguile/struct.h"
 128 #include "libguile/symbols.h"
 129 #include "libguile/throw.h"
 130 #include "libguile/arrays.h"
 131 #include "libguile/trees.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/weaks.h"
 139 #include "libguile/guardians.h"
 140 #include "libguile/extensions.h"
 141 #include "libguile/uniform.h"
 142 #include "libguile/deprecated.h"
 143
 144 #include "libguile/init.h"
 145 #include "libguile/private-options.h"
 146
 147 #ifdef HAVE_STRING_H
 148 #include <string.h>
 149 #endif
 150 #ifdef HAVE_UNISTD_H
 151 #include <unistd.h>
 152 #endif
 153
 154
 155 \f
 156 /* initializing standard and current I/O ports */
 157
 158 typedef struct
 159 {
 160   int fdes;
 161   char *mode;
 162 } stream_body_data;
 163
 164 /* proc to be called in scope of exception handler stream_handler. */
 165 static SCM
 166 stream_body (void *data)
 167 {
 168   stream_body_data *body_data = (stream_body_data *) data;
 169   SCM port = scm_fdes_to_port (body_data->fdes, body_data->mode, SCM_BOOL_F);
 170
 171   SCM_REVEALED (port) = 1;
 172   return port;
 173 }
 174
 175 /* exception handler for stream_body.  */
 176 static SCM
 177 stream_handler (void *data SCM_UNUSED,
 178                 SCM tag SCM_UNUSED,
 179                 SCM throw_args SCM_UNUSED)
 180 {
 181   return SCM_BOOL_F;
 182 }
 183
 184 /* Convert a file descriptor to a port, using scm_fdes_to_port.
 185    - set the revealed count for FILE's file descriptor to 1, so
 186    that fdes won't be closed when the port object is GC'd.
 187    - catch exceptions: allow Guile to be able to start up even
 188    if it has been handed bogus stdin/stdout/stderr.  replace the
 189    bad ports with void ports.  */
 190 static SCM
 191 scm_standard_stream_to_port (int fdes, char *mode)
 192 {
 193   SCM port;
 194   stream_body_data body_data;
 195
 196   body_data.fdes = fdes;
 197   body_data.mode = mode;
 198   port = scm_internal_catch (SCM_BOOL_T, stream_body, &body_data,
 199                              stream_handler, NULL);
 200   if (scm_is_false (port))
 201     port = scm_void_port (mode);
 202   return port;
 203 }
 204
 205 /* Create standard ports from stdin, stdout, and stderr.  */
 206 static void
 207 scm_init_standard_ports ()
 208 {
 209   /* From the SCSH manual:
 210
 211      It can be useful to turn I/O buffering off in some cases, for
 212      example when an I/O stream is to be shared by multiple
 213      subprocesses.  For this reason, scsh allocates an unbuffered port
 214      for file descriptor 0 at start-up time.
 215
 216      Because shells frequently share stdin with subprocesses, if the
 217      shell does buffered reads, it might ``steal'' input intended for
 218      a subprocess.  For this reason, all shells, including sh, csh,
 219      and scsh, read stdin unbuffered.  Applications that can tolerate
 220      buffered input on stdin can reset \ex{(current-input-port)} to
 221      block buffering for higher performance.  */
 222
 223   scm_set_current_input_port
 224     (scm_standard_stream_to_port (0, isatty (0) ? "r0" : "r"));
 225   scm_set_current_output_port
 226     (scm_standard_stream_to_port (1, isatty (1) ? "w0" : "w"));
 227   scm_set_current_error_port
 228     (scm_standard_stream_to_port (2, isatty (2) ? "w0" : "w"));
 229 }
 230
 231
 232 \f
 233 /* Loading the startup Scheme files.  */
 234
 235 /* The boot code "ice-9/boot-9" is only loaded by scm_boot_guile when
 236    this is false.  The unexec code uses this, to keep ice_9 from being
 237    loaded into dumped guile executables.  */
 238 int scm_ice_9_already_loaded = 0;
 239
 240 void
 241 scm_load_startup_files ()
 242 {
 243   /* We want a path only containing directories from GUILE_LOAD_PATH,
 244      SCM_SITE_DIR and SCM_LIBRARY_DIR when searching for the site init
 245      file, so we do this before loading Ice-9.  */
 246   SCM init_path =
 247     scm_sys_search_load_path (scm_from_locale_string ("init.scm"));
 248
 249   /* Load Ice-9.  */
 250   if (!scm_ice_9_already_loaded)
 251     {
 252       scm_c_primitive_load_path ("ice-9/boot-9");
 253
 254       /* Load the init.scm file.  */
 255       if (scm_is_true (init_path))
 256         scm_primitive_load (init_path);
 257     }
 258 }
 259
 260 \f
 261 /* The main init code.  */
 262
 263 #ifdef _UNICOS
 264 typedef int setjmp_type;
 265 #else
 266 typedef long setjmp_type;
 267 #endif
 268
 269 /* All the data needed to invoke the main function.  */
 270 struct main_func_closure
 271 {
 272   /* the function to call */
 273   void (*main_func)(void *closure, int argc, char **argv);
 274   void *closure;                /* dummy data to pass it */
 275   int argc;
 276   char **argv;                  /* the argument list it should receive */
 277 };
 278
 279 static void *invoke_main_func(void *body_data);
 280
 281
 282 /* Fire up the Guile Scheme interpreter.
 283
 284    Call MAIN_FUNC, passing it CLOSURE, ARGC, and ARGV.  MAIN_FUNC
 285    should do all the work of the program (initializing other packages,
 286    reading user input, etc.) before returning.  When MAIN_FUNC
 287    returns, call exit (EXIT_FAILURE); this function never returns.
 288    If you want some other exit value, MAIN_FUNC may call exit itself.
 289
 290    scm_boot_guile arranges for program-arguments to return the strings
 291    given by ARGC and ARGV.  If MAIN_FUNC modifies ARGC/ARGV, should
 292    call scm_set_program_arguments with the final list, so Scheme code
 293    will know which arguments have been processed.
 294
 295    scm_boot_guile establishes a catch-all catch handler which prints
 296    an error message and exits the process.  This means that Guile
 297    exits in a coherent way when system errors occur and the user isn't
 298    prepared to handle it.  If the user doesn't like this behavior,
 299    they can establish their own universal catcher to shadow this one.
 300
 301    Why must the caller do all the real work from MAIN_FUNC?  The
 302    garbage collector assumes that all local variables of type SCM will
 303    be above scm_boot_guile's stack frame on the stack.  If you try to
 304    manipulate SCM values after this function returns, it's the luck of
 305    the draw whether the GC will be able to find the objects you
 306    allocate.  So, scm_boot_guile function exits, rather than
 307    returning, to discourage people from making that mistake.  */
 308
 309
 310 void
 311 scm_boot_guile (int argc, char ** argv, void (*main_func) (), void *closure)
 312 {
 313   void *res;
 314   struct main_func_closure c;
 315
 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_weaks_prehistory ();        /* requires storage_prehistory */
 389 #ifdef GUILE_DEBUG_MALLOC
 390   scm_debug_malloc_prehistory ();
 391 #endif
 392   scm_symbols_prehistory ();      /* requires weaks_prehistory */
 393   scm_modules_prehistory ();
 394   scm_init_array_handle ();
 395   scm_bootstrap_bytevectors ();   /* Requires array-handle */
 396   scm_bootstrap_instructions ();
 397   scm_bootstrap_objcodes ();
 398   scm_bootstrap_programs ();
 399   scm_bootstrap_vm ();
 400   scm_register_r6rs_ports ();
 401   scm_register_foreign ();
 402   scm_register_srfi_1 ();
 403   scm_register_srfi_60 ();
 404   scm_register_poll ();
 405
 406   scm_init_strings ();            /* Requires array-handle */
 407   scm_init_struct ();             /* Requires strings */
 408   scm_smob_prehistory ();
 409   scm_init_variable ();
 410   scm_init_continuations ();      /* requires smob_prehistory */
 411   scm_init_root ();               /* requires continuations */
 412   scm_init_threads ();            /* requires smob_prehistory */
 413   scm_init_gsubr ();
 414   scm_init_thread_procs ();       /* requires gsubrs */
 415   scm_init_procprop ();
 416   scm_init_alist ();
 417   scm_init_arbiters ();           /* requires smob_prehistory */
 418   scm_init_async ();              /* requires smob_prehistory */
 419   scm_init_boolean ();
 420   scm_init_chars ();
 421 #ifdef GUILE_DEBUG_MALLOC
 422   scm_init_debug_malloc ();
 423 #endif
 424   scm_init_dynwind ();            /* requires smob_prehistory */
 425   scm_init_eq ();
 426   scm_init_error ();
 427   scm_init_finalizers ();
 428   scm_init_fluids ();
 429   scm_init_control ();            /* requires fluids */
 430   scm_init_feature ();
 431   scm_init_backtrace ();
 432   scm_init_fports ();
 433   scm_init_strports ();
 434   scm_init_ports ();
 435   scm_init_hash ();
 436   scm_init_hashtab ();
 437   scm_init_deprecation ();
 438   scm_init_objprop ();
 439   scm_init_promises ();         /* requires smob_prehistory */
 440   scm_init_hooks ();            /* Requires smob_prehistory */
 441   scm_init_stime ();
 442   scm_init_gc ();               /* Requires hooks and `get_internal_run_time' */
 443   scm_init_gc_protect_object ();  /* requires threads_prehistory */
 444   scm_init_gdbint ();           /* Requires strports, gc_protect_object */
 445   scm_init_gettext ();
 446   scm_init_ioext ();
 447   scm_init_keywords ();    /* Requires smob_prehistory */
 448   scm_init_list ();
 449   scm_init_random ();      /* Requires smob_prehistory */
 450   scm_init_macros ();      /* Requires smob_prehistory and random */
 451   scm_init_mallocs ();     /* Requires smob_prehistory */
 452   scm_init_modules ();     /* Requires smob_prehistory */
 453   scm_init_numbers ();
 454   scm_init_options ();
 455   scm_init_pairs ();
 456   scm_init_filesys ();     /* Requires smob_prehistory */
 457 #ifdef HAVE_POSIX
 458   scm_init_posix ();
 459 #endif
 460 #ifdef ENABLE_REGEX
 461   scm_init_regex_posix (); /* Requires smob_prehistory */
 462 #endif
 463   scm_init_procs ();
 464   scm_init_scmsigs ();
 465 #ifdef HAVE_NETWORKING
 466   scm_init_net_db ();
 467   scm_init_socket ();
 468 #endif
 469   scm_init_sort ();
 470   scm_init_srcprop ();     /* requires smob_prehistory */
 471   scm_init_stackchk ();
 472
 473   scm_init_generalized_arrays ();
 474   scm_init_generalized_vectors ();
 475   scm_init_vectors ();  /* Requires array-handle, */
 476   scm_init_uniform ();
 477   scm_init_bitvectors ();  /* Requires smob_prehistory, array-handle */
 478   scm_init_srfi_4 ();  /* Requires smob_prehistory, array-handle */
 479   scm_init_arrays ();    /* Requires smob_prehistory, array-handle */
 480   scm_init_array_map ();
 481
 482   scm_init_frames ();   /* Requires smob_prehistory */
 483   scm_init_stacks ();   /* Requires strings, struct, frames */
 484   scm_init_symbols ();
 485   scm_init_values ();   /* Requires struct */
 486   scm_init_load ();     /* Requires strings */
 487   scm_init_print ();    /* Requires strings, struct, smob */
 488   scm_init_read ();
 489   scm_init_strorder ();
 490   scm_init_srfi_13 ();
 491   scm_init_srfi_14 ();  /* Requires smob_prehistory */
 492   scm_init_throw ();    /* Requires smob_prehistory */
 493   scm_init_trees ();
 494   scm_init_version ();
 495   scm_init_weaks ();
 496   scm_init_guardians (); /* requires smob_prehistory */
 497   scm_init_vports ();
 498   scm_init_standard_ports ();  /* Requires fports */
 499   scm_init_expand ();   /* Requires structs */
 500   scm_init_memoize ();  /* Requires smob_prehistory */
 501   scm_init_eval ();     /* Requires smob_prehistory */
 502   scm_init_load_path ();
 503   scm_init_eval_in_scheme ();
 504   scm_init_evalext ();
 505   scm_init_debug ();    /* Requires macro smobs */
 506   scm_init_simpos ();
 507 #if HAVE_MODULES
 508   scm_init_dynamic_linking (); /* Requires smob_prehistory */
 509 #endif
 510   scm_bootstrap_i18n ();
 511   scm_init_script ();
 512
 513   scm_init_goops ();
 514
 515 #if SCM_ENABLE_DEPRECATED == 1
 516   scm_i_init_deprecated ();
 517 #endif
 518
 519   scm_initialized_p = 1;
 520
 521 #ifdef STACK_CHECKING
 522   scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
 523 #endif
 524
 525   scm_init_rdelim ();
 526   scm_init_rw ();
 527   scm_init_extensions ();
 528
 529   atexit (cleanup_for_exit);
 530   scm_load_startup_files ();
 531   scm_init_load_should_auto_compile ();
 532
 533   /* Capture the dynamic state after loading boot-9, so that new threads end up
 534      in the guile-user module. */
 535   scm_init_threads_default_dynamic_state ();
 536 }
 537
 538 /*
 539   Local Variables:
 540   c-file-style: "gnu"
 541   End:
 542 */