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),
 163                                             SCM_UNDEFINED, SCM_UNDEFINED);
 164   /* The continuation stack is further initialized by restart_stack. */
 165
 166   /* The remainder of stack initialization is factored out to another
 167    * function so that if this stack is ever exitted, it can be
 168    * re-entered using restart_stack.  */
 169   restart_stack (base);
 170 }
 171
 172
 173 static void
 174 restart_stack (base)
 175      void * base;
 176 {
 177   scm_dynwinds = SCM_EOL;
 178   SCM_DYNENV (scm_rootcont) = SCM_EOL;
 179   SCM_THROW_VALUE (scm_rootcont) = SCM_EOL;
 180 #ifdef DEBUG_EXTENSIONS
 181   SCM_DFRAME (scm_rootcont) = scm_last_debug_frame = 0;
 182 #endif
 183   SCM_BASE (scm_rootcont) = base;
 184   scm_continuation_stack_ptr = SCM_MAKINUM (0);
 185 }
 186
 187 #if 0
 188 static char remsg[] = "remove\n#define ", addmsg[] = "add\n#define ";
 189
 190
 191 static void fixconfig SCM_P ((char *s1, char *s2, int s));
 192
 193 static void
 194 fixconfig (s1, s2, s)
 195      char *s1;
 196      char *s2;
 197      int s;
 198 {
 199   fputs (s1, stderr);
 200   fputs (s2, stderr);
 201   fputs ("\nin ", stderr);
 202   fputs (s ? "setjump" : "scmfig", stderr);
 203   fputs (".h and recompile scm\n", stderr);
 204   exit (1);
 205 }
 206
 207
 208 static void check_config SCM_P ((void));
 209
 210 static void
 211 check_config ()
 212 {
 213   scm_sizet j;
 214
 215   j = HEAP_SEG_SIZE;
 216   if (HEAP_SEG_SIZE != j)
 217     fixconfig ("reduce", "size of HEAP_SEG_SIZE", 0);
 218
 219 #ifdef SCM_SINGLES
 220   if (sizeof (float) != sizeof (long))
 221       fixconfig (remsg, "SCM_SINGLES", 0);
 222 #endif /* def SCM_SINGLES */
 223
 224
 225 #ifdef SCM_BIGDIG
 226   if (2 * SCM_BITSPERDIG / SCM_CHAR_BIT > sizeof (long))
 227       fixconfig (remsg, "SCM_BIGDIG", 0);
 228 #ifndef SCM_DIGSTOOBIG
 229   if (SCM_DIGSPERLONG * sizeof (SCM_BIGDIG) > sizeof (long))
 230       fixconfig (addmsg, "SCM_DIGSTOOBIG", 0);
 231 #endif
 232 #endif
 233
 234 #ifdef SCM_STACK_GROWS_UP
 235   if (((SCM_STACKITEM *) & j - stack_start_ptr) < 0)
 236     fixconfig (remsg, "SCM_STACK_GROWS_UP", 1);
 237 #else
 238   if ((stack_start_ptr - (SCM_STACKITEM *) & j) < 0)
 239     fixconfig (addmsg, "SCM_STACK_GROWS_UP", 1);
 240 #endif
 241 }
 242 #endif
 243
 244
 245 \f
 246 /* initializing standard and current I/O ports */
 247
 248 /* Create standard ports from stdio stdin, stdout, and stderr.  */
 249 static void
 250 scm_init_standard_ports ()
 251 {
 252   /* From the SCSH manual:
 253
 254      It can be useful to turn I/O buffering off in some cases, for
 255      example when an I/O stream is to be shared by multiple
 256      subprocesses.  For this reason, scsh allocates an unbuffered port
 257      for file descriptor 0 at start-up time.
 258
 259      Because shells frequently share stdin with subprocesses, if the
 260      shell does buffered reads, it might ``steal'' input intended for
 261      a subprocess.  For this reason, all shells, including sh, csh,
 262      and scsh, read stdin unbuffered.  Applications that can tolerate
 263      buffered input on stdin can reset \ex{(current-input-port)} to
 264      block buffering for higher performance.  */
 265   scm_def_inp = scm_stdio_to_port (stdin,
 266                                    (isatty (fileno (stdin)) ? "r0" : "r"),
 267                                    "standard input");
 268   scm_def_outp = scm_stdio_to_port (stdout, "w", "standard output");
 269   scm_def_errp = scm_stdio_to_port (stderr, "w", "standard error");
 270
 271   scm_cur_inp = scm_def_inp;
 272   scm_cur_outp = scm_def_outp;
 273   scm_cur_errp = scm_def_errp;
 274   scm_cur_loadp = SCM_BOOL_F;
 275 }
 276
 277
 278 \f
 279 #ifdef _UNICOS
 280 typedef int setjmp_type;
 281 #else
 282 typedef long setjmp_type;
 283 #endif
 284
 285 /* All the data needed to invoke the main function.  */
 286 struct main_func_closure
 287 {
 288   /* the function to call */
 289   void (*main_func) SCM_P ((void *closure, int argc, char **argv));
 290   void *closure;                /* dummy data to pass it */
 291   int argc;
 292   char **argv;                  /* the argument list it should receive */
 293 };
 294
 295
 296 static void scm_boot_guile_1 SCM_P ((SCM_STACKITEM *base,
 297                                      struct main_func_closure *closure));
 298 static SCM invoke_main_func SCM_P ((void *body_data));
 299
 300
 301 /* Fire up the Guile Scheme interpreter.
 302
 303    Call MAIN_FUNC, passing it CLOSURE, ARGC, and ARGV.  MAIN_FUNC
 304    should do all the work of the program (initializing other packages,
 305    reading user input, etc.) before returning.  When MAIN_FUNC
 306    returns, call exit (0); this function never returns.  If you want
 307    some other exit value, MAIN_FUNC may call exit itself.
 308
 309    scm_boot_guile arranges for program-arguments to return the strings
 310    given by ARGC and ARGV.  If MAIN_FUNC modifies ARGC/ARGV, should
 311    call scm_set_program_arguments with the final list, so Scheme code
 312    will know which arguments have been processed.
 313
 314    scm_boot_guile establishes a catch-all catch handler which prints
 315    an error message and exits the process.  This means that Guile
 316    exits in a coherent way when system errors occur and the user isn't
 317    prepared to handle it.  If the user doesn't like this behavior,
 318    they can establish their own universal catcher to shadow this one.
 319
 320    Why must the caller do all the real work from MAIN_FUNC?  The
 321    garbage collector assumes that all local variables of type SCM will
 322    be above scm_boot_guile's stack frame on the stack.  If you try to
 323    manipulate SCM values after this function returns, it's the luck of
 324    the draw whether the GC will be able to find the objects you
 325    allocate.  So, scm_boot_guile function exits, rather than
 326    returning, to discourage people from making that mistake.  */
 327
 328
 329 void
 330 scm_boot_guile (argc, argv, main_func, closure)
 331      int argc;
 332      char ** argv;
 333      void (*main_func) ();
 334      void *closure;
 335 {
 336   /* The garbage collector uses the address of this variable as one
 337      end of the stack, and the address of one of its own local
 338      variables as the other end.  */
 339   SCM_STACKITEM dummy;
 340   struct main_func_closure c;
 341
 342   c.main_func = main_func;
 343   c.closure = closure;
 344   c.argc = argc;
 345   c.argv = argv;
 346
 347   scm_boot_guile_1 (&dummy, &c);
 348 }
 349
 350
 351 /* Record here whether SCM_BOOT_GUILE_1 has already been called.  This
 352    variable is now here and not inside SCM_BOOT_GUILE_1 so that one
 353    can tweak it. This is necessary for unexec to work. (Hey, "1-live"
 354    is the name of a local radiostation...) */
 355
 356 int scm_boot_guile_1_live = 0;
 357
 358 static void
 359 scm_boot_guile_1 (base, closure)
 360      SCM_STACKITEM *base;
 361      struct main_func_closure *closure;
 362 {
 363   static int initialized = 0;
 364   /* static int live = 0; */
 365   setjmp_type setjmp_val;
 366
 367   /* This function is not re-entrant. */
 368   if (scm_boot_guile_1_live)
 369     abort ();
 370
 371   scm_boot_guile_1_live = 1;
 372
 373   scm_ints_disabled = 1;
 374   scm_block_gc = 1;
 375
 376   if (initialized)
 377     {
 378       restart_stack (base);
 379     }
 380   else
 381     {
 382       scm_ports_prehistory ();
 383       scm_smob_prehistory ();
 384       scm_tables_prehistory ();
 385       scm_init_storage (0);
 386       scm_init_root ();
 387 #ifdef USE_THREADS
 388       scm_init_threads (base);
 389 #endif
 390       start_stack (base);
 391       scm_init_gsubr ();
 392       scm_init_feature ();
 393       scm_init_alist ();
 394       scm_init_arbiters ();
 395       scm_init_async ();
 396       scm_init_boolean ();
 397       scm_init_chars ();
 398       scm_init_continuations ();
 399       scm_init_dynwind ();
 400       scm_init_eq ();
 401       scm_init_error ();
 402       scm_init_fluids ();
 403       scm_init_backtrace ();    /* Requires fluids */
 404       scm_init_fports ();
 405       scm_init_filesys ();
 406       scm_init_gc ();
 407       scm_init_gdbint ();
 408       scm_init_hash ();
 409       scm_init_hashtab ();
 410 #ifdef GUILE_ISELECT
 411       scm_init_iselect ();
 412 #endif
 413       scm_init_ioext ();
 414       scm_init_kw ();
 415       scm_init_list ();
 416       scm_init_mallocs ();
 417       scm_init_net_db ();
 418       scm_init_numbers ();
 419       scm_init_objprop ();
 420       scm_init_options ();
 421       scm_init_pairs ();
 422       scm_init_ports ();
 423       scm_init_posix ();
 424 #ifdef HAVE_REGCOMP
 425       scm_init_regex_posix ();
 426 #endif
 427       scm_init_procs ();
 428       scm_init_procprop ();
 429       scm_init_scmsigs ();
 430       scm_init_socket ();
 431 #ifdef DEBUG_EXTENSIONS
 432       scm_init_srcprop ();
 433 #endif
 434       scm_init_stackchk ();
 435       scm_init_struct ();       /* Requires struct */
 436       scm_init_stacks ();
 437       scm_init_strports ();
 438       scm_init_symbols ();
 439       scm_init_tag ();
 440       scm_init_load ();
 441       scm_init_objects ();      /* Requires struct */
 442       scm_init_print ();        /* Requires struct */
 443       scm_init_read ();
 444       scm_init_stime ();
 445       scm_init_strings ();
 446       scm_init_strorder ();
 447       scm_init_strop ();
 448       scm_init_throw ();
 449       scm_init_variable ();
 450       scm_init_vectors ();
 451       scm_init_version ();
 452       scm_init_weaks ();
 453       scm_init_vports ();
 454       scm_init_eval ();
 455 #ifdef DEBUG_EXTENSIONS
 456       scm_init_debug ();        /* Requires macro smobs */
 457 #endif
 458       scm_init_ramap ();
 459       scm_init_unif ();
 460       scm_init_simpos ();
 461       scm_init_load_path ();
 462 #ifdef HAVE_RL_GETC_FUNCTION
 463       scm_init_readline ();
 464 #endif
 465       scm_init_standard_ports ();
 466       scm_init_dynamic_linking ();
 467       scm_init_script ();
 468       initialized = 1;
 469     }
 470
 471   scm_block_gc = 0;             /* permit the gc to run */
 472   /* ints still disabled */
 473
 474 #ifdef STACK_CHECKING
 475   scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
 476 #endif
 477
 478   setjmp_val = setjmp (SCM_JMPBUF (scm_rootcont));
 479   if (!setjmp_val)
 480     {
 481       scm_set_program_arguments (closure->argc, closure->argv, 0);
 482       scm_internal_catch (SCM_BOOL_T, invoke_main_func, closure,
 483                           scm_handle_by_message, 0);
 484     }
 485
 486   scm_restore_signals ();
 487
 488   /* This tick gives any pending
 489    * asyncs a chance to run.  This must be done after
 490    * the call to scm_restore_signals.
 491    */
 492   SCM_ASYNC_TICK;
 493
 494   /* If the caller doesn't want this, they should return from
 495      main_func themselves.  */
 496   exit (0);
 497 }
 498
 499
 500 static SCM
 501 invoke_main_func (body_data)
 502      void *body_data;
 503 {
 504   struct main_func_closure *closure = (struct main_func_closure *) body_data;
 505
 506   (*closure->main_func) (closure->closure, closure->argc, closure->argv);
 507
 508   /* never reached */
 509   return SCM_UNDEFINED;
 510 }