libguile/init.c

   1 /*      Copyright (C) 1995,1996,1997 Free Software Foundation, Inc.
   2  *
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2, or (at your option)
   6  * any later version.
   7  *
   8  * This program 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
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this software; see the file COPYING.  If not, write to
  15  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  16  * Boston, MA 02111-1307 USA
  17  *
  18  * As a special exception, the Free Software Foundation gives permission
  19  * for additional uses of the text contained in its release of GUILE.
  20  *
  21  * The exception is that, if you link the GUILE library with other files
  22  * to produce an executable, this does not by itself cause the
  23  * resulting executable to be covered by the GNU General Public License.
  24  * Your use of that executable is in no way restricted on account of
  25  * linking the GUILE library code into it.
  26  *
  27  * This exception does not however invalidate any other reasons why
  28  * the executable file might be covered by the GNU General Public License.
  29  *
  30  * This exception applies only to the code released by the
  31  * Free Software Foundation under the name GUILE.  If you copy
  32  * code from other Free Software Foundation releases into a copy of
  33  * GUILE, as the General Public License permits, the exception does
  34  * not apply to the code that you add in this way.  To avoid misleading
  35  * anyone as to the status of such modified files, you must delete
  36  * this exception notice from them.
  37  *
  38  * If you write modifications of your own for GUILE, it is your choice
  39  * whether to permit this exception to apply to your modifications.
  40  * If you do not wish that, delete this exception notice.  */
  41 \f
  42
  43 #include <stdio.h>
  44 #include "_scm.h"
  45
  46 /* Everybody has an init function.  */
  47 #include "alist.h"
  48 #include "arbiters.h"
  49 #include "async.h"
  50 #include "backtrace.h"
  51 #include "boolean.h"
  52 #include "chars.h"
  53 #include "continuations.h"
  54 #ifdef DEBUG_EXTENSIONS
  55 #include "debug.h"
  56 #endif
  57 #include "dynl.h"
  58 #include "dynwind.h"
  59 #include "eq.h"
  60 #include "error.h"
  61 #include "eval.h"
  62 #include "feature.h"
  63 #include "filesys.h"
  64 #include "fluids.h"
  65 #include "fports.h"
  66 #include "gc.h"
  67 #include "gdbint.h"
  68 #include "gsubr.h"
  69 #include "hash.h"
  70 #include "hashtab.h"
  71 #ifdef GUILE_ISELECT
  72 #include "iselect.h"
  73 #endif
  74 #include "ioext.h"
  75 #include "kw.h"
  76 #include "list.h"
  77 #include "load.h"
  78 #include "mallocs.h"
  79 #include "net_db.h"
  80 #include "numbers.h"
  81 #include "objects.h"
  82 #include "objprop.h"
  83 #include "options.h"
  84 #include "pairs.h"
  85 #include "ports.h"
  86 #include "posix.h"
  87 #ifdef HAVE_REGCOMP
  88 #include "regex-posix.h"
  89 #endif
  90 #include "print.h"
  91 #include "procprop.h"
  92 #include "procs.h"
  93 #include "ramap.h"
  94 #include "read.h"
  95 #include "readline.h"
  96 #include "scmsigs.h"
  97 #include "script.h"
  98 #include "simpos.h"
  99 #include "smob.h"
 100 #include "socket.h"
 101 #include "srcprop.h"
 102 #include "stackchk.h"
 103 #include "stacks.h"
 104 #include "stime.h"
 105 #include "strings.h"
 106 #include "strop.h"
 107 #include "strorder.h"
 108 #include "strports.h"
 109 #include "struct.h"
 110 #include "symbols.h"
 111 #include "tag.h"
 112 #include "throw.h"
 113 #include "unif.h"
 114 #include "variable.h"
 115 #include "vectors.h"
 116 #include "version.h"
 117 #include "vports.h"
 118 #include "weaks.h"
 119
 120 #include "init.h"
 121
 122 #ifdef HAVE_STRING_H
 123 #include <string.h>
 124 #endif
 125 #ifdef HAVE_UNISTD_H
 126 #include <unistd.h>
 127 #endif
 128 \f
 129
 130 static void start_stack SCM_P ((void *base));
 131 static void restart_stack SCM_P ((void * base));
 132
 133 static void
 134 start_stack (base)
 135      void * base;
 136 {
 137   SCM root;
 138
 139   root = scm_permanent_object (scm_make_root (SCM_UNDEFINED));
 140   scm_set_root (SCM_ROOT_STATE (root));
 141   scm_stack_base = base;
 142
 143   scm_exitval = SCM_BOOL_F;     /* vestigial */
 144
 145   scm_top_level_lookup_closure_var = SCM_BOOL_F;
 146   scm_system_transformer = SCM_BOOL_F;
 147
 148   scm_root->fluids = scm_make_initial_fluids ();
 149
 150   /* Create an object to hold the root continuation.
 151    */
 152   SCM_NEWCELL (scm_rootcont);
 153   SCM_SETJMPBUF (scm_rootcont, scm_must_malloc ((long) sizeof (scm_contregs),
 154                                                 "continuation"));
 155   SCM_SETCAR (scm_rootcont, scm_tc7_contin);
 156   SCM_SEQ (scm_rootcont) = 0;
 157   /* The root continuation if further initialized by restart_stack. */
 158
 159   /* Create the look-aside stack for variables that are shared between
 160    * captured continuations.
 161    */
 162   scm_continuation_stack = scm_make_vector (SCM_MAKINUM (512), SCM_UNDEFINED);
 163   /* The continuation stack is further initialized by restart_stack. */
 164
 165   /* The remainder of stack initialization is factored out to another
 166    * function so that if this stack is ever exitted, it can be
 167    * re-entered using restart_stack.  */
 168   restart_stack (base);
 169 }
 170
 171
 172 static void
 173 restart_stack (base)
 174      void * base;
 175 {
 176   scm_dynwinds = SCM_EOL;
 177   SCM_DYNENV (scm_rootcont) = SCM_EOL;
 178   SCM_THROW_VALUE (scm_rootcont) = SCM_EOL;
 179 #ifdef DEBUG_EXTENSIONS
 180   SCM_DFRAME (scm_rootcont) = scm_last_debug_frame = 0;
 181 #endif
 182   SCM_BASE (scm_rootcont) = base;
 183   scm_continuation_stack_ptr = SCM_MAKINUM (0);
 184 }
 185
 186 #if 0
 187 static char remsg[] = "remove\n#define ", addmsg[] = "add\n#define ";
 188
 189
 190 static void fixconfig SCM_P ((char *s1, char *s2, int s));
 191
 192 static void
 193 fixconfig (s1, s2, s)
 194      char *s1;
 195      char *s2;
 196      int s;
 197 {
 198   fputs (s1, stderr);
 199   fputs (s2, stderr);
 200   fputs ("\nin ", stderr);
 201   fputs (s ? "setjump" : "scmfig", stderr);
 202   fputs (".h and recompile scm\n", stderr);
 203   exit (1);
 204 }
 205
 206
 207 static void check_config SCM_P ((void));
 208
 209 static void
 210 check_config ()
 211 {
 212   scm_sizet j;
 213
 214   j = HEAP_SEG_SIZE;
 215   if (HEAP_SEG_SIZE != j)
 216     fixconfig ("reduce", "size of HEAP_SEG_SIZE", 0);
 217
 218 #ifdef SCM_SINGLES
 219   if (sizeof (float) != sizeof (long))
 220       fixconfig (remsg, "SCM_SINGLES", 0);
 221 #endif /* def SCM_SINGLES */
 222
 223
 224 #ifdef SCM_BIGDIG
 225   if (2 * SCM_BITSPERDIG / SCM_CHAR_BIT > sizeof (long))
 226       fixconfig (remsg, "SCM_BIGDIG", 0);
 227 #ifndef SCM_DIGSTOOBIG
 228   if (SCM_DIGSPERLONG * sizeof (SCM_BIGDIG) > sizeof (long))
 229       fixconfig (addmsg, "SCM_DIGSTOOBIG", 0);
 230 #endif
 231 #endif
 232
 233 #ifdef SCM_STACK_GROWS_UP
 234   if (((SCM_STACKITEM *) & j - stack_start_ptr) < 0)
 235     fixconfig (remsg, "SCM_STACK_GROWS_UP", 1);
 236 #else
 237   if ((stack_start_ptr - (SCM_STACKITEM *) & j) < 0)
 238     fixconfig (addmsg, "SCM_STACK_GROWS_UP", 1);
 239 #endif
 240 }
 241 #endif
 242
 243
 244 \f
 245 /* initializing standard and current I/O ports */
 246
 247 /* Create standard ports from stdio stdin, stdout, and stderr.  */
 248 static void
 249 scm_init_standard_ports ()
 250 {
 251   /* From the SCSH manual:
 252
 253      It can be useful to turn I/O buffering off in some cases, for
 254      example when an I/O stream is to be shared by multiple
 255      subprocesses.  For this reason, scsh allocates an unbuffered port
 256      for file descriptor 0 at start-up time.
 257
 258      Because shells frequently share stdin with subprocesses, if the
 259      shell does buffered reads, it might ``steal'' input intended for
 260      a subprocess.  For this reason, all shells, including sh, csh,
 261      and scsh, read stdin unbuffered.  Applications that can tolerate
 262      buffered input on stdin can reset \ex{(current-input-port)} to
 263      block buffering for higher performance.  */
 264   scm_def_inp = scm_stdio_to_port (stdin,
 265                                    (isatty (fileno (stdin)) ? "r0" : "r"),
 266                                    "standard input");
 267   scm_def_outp = scm_stdio_to_port (stdout, "w", "standard output");
 268   scm_def_errp = scm_stdio_to_port (stderr, "w", "standard error");
 269
 270   scm_cur_inp = scm_def_inp;
 271   scm_cur_outp = scm_def_outp;
 272   scm_cur_errp = scm_def_errp;
 273   scm_cur_loadp = SCM_BOOL_F;
 274 }
 275
 276
 277 \f
 278 #ifdef _UNICOS
 279 typedef int setjmp_type;
 280 #else
 281 typedef long setjmp_type;
 282 #endif
 283
 284 /* All the data needed to invoke the main function.  */
 285 struct main_func_closure
 286 {
 287   /* the function to call */
 288   void (*main_func) SCM_P ((void *closure, int argc, char **argv));
 289   void *closure;                /* dummy data to pass it */
 290   int argc;
 291   char **argv;                  /* the argument list it should receive */
 292 };
 293
 294
 295 static void scm_boot_guile_1 SCM_P ((SCM_STACKITEM *base,
 296                                      struct main_func_closure *closure));
 297 static SCM invoke_main_func SCM_P ((void *body_data));
 298
 299
 300 /* Fire up the Guile Scheme interpreter.
 301
 302    Call MAIN_FUNC, passing it CLOSURE, ARGC, and ARGV.  MAIN_FUNC
 303    should do all the work of the program (initializing other packages,
 304    reading user input, etc.) before returning.  When MAIN_FUNC
 305    returns, call exit (0); this function never returns.  If you want
 306    some other exit value, MAIN_FUNC may call exit itself.
 307
 308    scm_boot_guile arranges for program-arguments to return the strings
 309    given by ARGC and ARGV.  If MAIN_FUNC modifies ARGC/ARGV, should
 310    call scm_set_program_arguments with the final list, so Scheme code
 311    will know which arguments have been processed.
 312
 313    scm_boot_guile establishes a catch-all catch handler which prints
 314    an error message and exits the process.  This means that Guile
 315    exits in a coherent way when system errors occur and the user isn't
 316    prepared to handle it.  If the user doesn't like this behavior,
 317    they can establish their own universal catcher to shadow this one.
 318
 319    Why must the caller do all the real work from MAIN_FUNC?  The
 320    garbage collector assumes that all local variables of type SCM will
 321    be above scm_boot_guile's stack frame on the stack.  If you try to
 322    manipulate SCM values after this function returns, it's the luck of
 323    the draw whether the GC will be able to find the objects you
 324    allocate.  So, scm_boot_guile function exits, rather than
 325    returning, to discourage people from making that mistake.  */
 326
 327
 328 void
 329 scm_boot_guile (argc, argv, main_func, closure)
 330      int argc;
 331      char ** argv;
 332      void (*main_func) ();
 333      void *closure;
 334 {
 335   /* The garbage collector uses the address of this variable as one
 336      end of the stack, and the address of one of its own local
 337      variables as the other end.  */
 338   SCM_STACKITEM dummy;
 339   struct main_func_closure c;
 340
 341   c.main_func = main_func;
 342   c.closure = closure;
 343   c.argc = argc;
 344   c.argv = argv;
 345
 346   scm_boot_guile_1 (&dummy, &c);
 347 }
 348
 349
 350 /* Record here whether SCM_BOOT_GUILE_1 has already been called.  This
 351    variable is now here and not inside SCM_BOOT_GUILE_1 so that one
 352    can tweak it. This is necessary for unexec to work. (Hey, "1-live"
 353    is the name of a local radiostation...) */
 354
 355 int scm_boot_guile_1_live = 0;
 356
 357 static void
 358 scm_boot_guile_1 (base, closure)
 359      SCM_STACKITEM *base;
 360      struct main_func_closure *closure;
 361 {
 362   static int initialized = 0;
 363   /* static int live = 0; */
 364   setjmp_type setjmp_val;
 365
 366   /* This function is not re-entrant. */
 367   if (scm_boot_guile_1_live)
 368     abort ();
 369
 370   scm_boot_guile_1_live = 1;
 371
 372   scm_ints_disabled = 1;
 373   scm_block_gc = 1;
 374
 375   if (initialized)
 376     {
 377       restart_stack (base);
 378     }
 379   else
 380     {
 381       scm_ports_prehistory ();
 382       scm_smob_prehistory ();
 383       scm_tables_prehistory ();
 384       scm_init_storage (0);
 385       scm_init_root ();
 386 #ifdef USE_THREADS
 387       scm_init_threads (base);
 388 #endif
 389       start_stack (base);
 390       scm_init_gsubr ();
 391       scm_init_feature ();
 392       scm_init_alist ();
 393       scm_init_arbiters ();
 394       scm_init_async ();
 395       scm_init_boolean ();
 396       scm_init_chars ();
 397       scm_init_continuations ();
 398       scm_init_dynwind ();
 399       scm_init_eq ();
 400       scm_init_error ();
 401       scm_init_fluids ();
 402       scm_init_backtrace ();    /* Requires fluids */
 403       scm_init_fports ();
 404       scm_init_filesys ();
 405       scm_init_gc ();
 406       scm_init_gdbint ();
 407       scm_init_hash ();
 408       scm_init_hashtab ();
 409 #ifdef GUILE_ISELECT
 410       scm_init_iselect ();
 411 #endif
 412       scm_init_ioext ();
 413       scm_init_kw ();
 414       scm_init_list ();
 415       scm_init_mallocs ();
 416       scm_init_net_db ();
 417       scm_init_numbers ();
 418       scm_init_objprop ();
 419       scm_init_options ();
 420       scm_init_pairs ();
 421       scm_init_ports ();
 422       scm_init_posix ();
 423 #ifdef HAVE_REGCOMP
 424       scm_init_regex_posix ();
 425 #endif
 426       scm_init_procs ();
 427       scm_init_procprop ();
 428       scm_init_scmsigs ();
 429       scm_init_socket ();
 430 #ifdef DEBUG_EXTENSIONS
 431       scm_init_srcprop ();
 432 #endif
 433       scm_init_stackchk ();
 434       scm_init_struct ();       /* Requires struct */
 435       scm_init_stacks ();
 436       scm_init_strports ();
 437       scm_init_symbols ();
 438       scm_init_tag ();
 439       scm_init_load ();
 440       scm_init_objects ();      /* Requires struct */
 441       scm_init_print ();        /* Requires struct */
 442       scm_init_read ();
 443       scm_init_stime ();
 444       scm_init_strings ();
 445       scm_init_strorder ();
 446       scm_init_strop ();
 447       scm_init_throw ();
 448       scm_init_variable ();
 449       scm_init_vectors ();
 450       scm_init_version ();
 451       scm_init_weaks ();
 452       scm_init_vports ();
 453       scm_init_eval ();
 454 #ifdef DEBUG_EXTENSIONS
 455       scm_init_debug ();        /* Requires macro smobs */
 456 #endif
 457       scm_init_ramap ();
 458       scm_init_unif ();
 459       scm_init_simpos ();
 460       scm_init_load_path ();
 461 #if defined (HAVE_RL_GETC_FUNCTION) || defined (TOTORO)
 462       /* The test for TOTORO is a kludge to make totoro.red-bean.com
 463          generate snapshots correctly. */
 464       scm_init_readline ();
 465 #endif
 466       scm_init_standard_ports ();
 467       scm_init_dynamic_linking ();
 468       scm_init_script ();
 469       initialized = 1;
 470     }
 471
 472   scm_block_gc = 0;             /* permit the gc to run */
 473   /* ints still disabled */
 474
 475 #ifdef STACK_CHECKING
 476   scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
 477 #endif
 478
 479   setjmp_val = setjmp (SCM_JMPBUF (scm_rootcont));
 480   if (!setjmp_val)
 481     {
 482       scm_set_program_arguments (closure->argc, closure->argv, 0);
 483       scm_internal_catch (SCM_BOOL_T, invoke_main_func, closure,
 484                           scm_handle_by_message, 0);
 485     }
 486
 487   scm_restore_signals ();
 488
 489   /* This tick gives any pending
 490    * asyncs a chance to run.  This must be done after
 491    * the call to scm_restore_signals.
 492    */
 493   SCM_ASYNC_TICK;
 494
 495   /* If the caller doesn't want this, they should return from
 496      main_func themselves.  */
 497   exit (0);
 498 }
 499
 500
 501 static SCM
 502 invoke_main_func (body_data)
 503      void *body_data;
 504 {
 505   struct main_func_closure *closure = (struct main_func_closure *) body_data;
 506
 507   (*closure->main_func) (closure->closure, closure->argc, closure->argv);
 508
 509   /* never reached */
 510   return SCM_UNDEFINED;
 511 }