libguile/init.c

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