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 "sequences.h"
  91 #include "simpos.h"
  92 #include "smob.h"
  93 #include "socket.h"
  94 #include "srcprop.h"
  95 #include "stackchk.h"
  96 #include "stacks.h"
  97 #include "stime.h"
  98 #include "strings.h"
  99 #include "strop.h"
 100 #include "strorder.h"
 101 #include "strports.h"
 102 #include "struct.h"
 103 #include "symbols.h"
 104 #include "tag.h"
 105 #include "throw.h"
 106 #include "unif.h"
 107 #include "variable.h"
 108 #include "vectors.h"
 109 #include "version.h"
 110 #include "vports.h"
 111 #include "weaks.h"
 112
 113 #include "init.h"
 114
 115 #ifdef HAVE_STRING_H
 116 #include <string.h>
 117 #endif
 118 #ifdef HAVE_UNISTD_H
 119 #include <unistd.h>
 120 #endif
 121 \f
 122
 123 static void scm_start_stack SCM_P ((void *base));
 124 static void scm_restart_stack SCM_P ((void * base));
 125
 126 static void
 127 scm_start_stack (base)
 128      void * base;
 129 {
 130   SCM root;
 131
 132   root = scm_permanent_object (scm_make_root (SCM_UNDEFINED));
 133   scm_set_root (SCM_ROOT_STATE (root));
 134   scm_stack_base = base;
 135
 136   scm_exitval = SCM_BOOL_F;     /* vestigial */
 137
 138   scm_top_level_lookup_closure_var = SCM_BOOL_F;
 139   scm_system_transformer = SCM_BOOL_F;
 140
 141   scm_the_last_stack_var = SCM_BOOL_F;
 142
 143   /* Create an object to hold the root continuation.
 144    */
 145   SCM_NEWCELL (scm_rootcont);
 146   SCM_SETJMPBUF (scm_rootcont, scm_must_malloc ((long) sizeof (scm_contregs),
 147                                                 "continuation"));
 148   SCM_SETCAR (scm_rootcont, scm_tc7_contin);
 149   SCM_SEQ (scm_rootcont) = 0;
 150   /* The root continuation if further initialized by scm_restart_stack. */
 151
 152   /* Create the look-aside stack for variables that are shared between
 153    * captured continuations.
 154    */
 155   scm_continuation_stack = scm_make_vector (SCM_MAKINUM (512),
 156                                             SCM_UNDEFINED, SCM_UNDEFINED);
 157   /* The continuation stack is further initialized by scm_restart_stack. */
 158
 159   /* The remainder of stack initialization is factored out to another
 160    * function so that if this stack is ever exitted, it can be
 161    * re-entered using scm_restart_stack.  */
 162   scm_restart_stack (base);
 163 }
 164
 165
 166 static void
 167 scm_restart_stack (base)
 168      void * base;
 169 {
 170   scm_dynwinds = SCM_EOL;
 171   SCM_DYNENV (scm_rootcont) = SCM_EOL;
 172   SCM_THROW_VALUE (scm_rootcont) = SCM_EOL;
 173 #ifdef DEBUG_EXTENSIONS
 174   SCM_DFRAME (scm_rootcont) = scm_last_debug_frame = 0;
 175 #endif
 176   SCM_BASE (scm_rootcont) = base;
 177   scm_continuation_stack_ptr = SCM_MAKINUM (0);
 178 }
 179
 180 #if 0
 181 static char remsg[] = "remove\n#define ", addmsg[] = "add\n#define ";
 182
 183
 184 static void fixconfig SCM_P ((char *s1, char *s2, int s));
 185
 186 static void
 187 fixconfig (s1, s2, s)
 188      char *s1;
 189      char *s2;
 190      int s;
 191 {
 192   fputs (s1, stderr);
 193   fputs (s2, stderr);
 194   fputs ("\nin ", stderr);
 195   fputs (s ? "setjump" : "scmfig", stderr);
 196   fputs (".h and recompile scm\n", stderr);
 197   exit (1);
 198 }
 199
 200
 201 static void check_config SCM_P ((void));
 202
 203 static void
 204 check_config ()
 205 {
 206   scm_sizet j;
 207
 208   j = HEAP_SEG_SIZE;
 209   if (HEAP_SEG_SIZE != j)
 210     fixconfig ("reduce", "size of HEAP_SEG_SIZE", 0);
 211
 212 #ifdef SCM_SINGLES
 213   if (sizeof (float) != sizeof (long))
 214       fixconfig (remsg, "SCM_SINGLES", 0);
 215 #endif /* def SCM_SINGLES */
 216
 217
 218 #ifdef SCM_BIGDIG
 219   if (2 * SCM_BITSPERDIG / SCM_CHAR_BIT > sizeof (long))
 220       fixconfig (remsg, "SCM_BIGDIG", 0);
 221 #ifndef SCM_DIGSTOOBIG
 222   if (SCM_DIGSPERLONG * sizeof (SCM_BIGDIG) > sizeof (long))
 223       fixconfig (addmsg, "SCM_DIGSTOOBIG", 0);
 224 #endif
 225 #endif
 226
 227 #ifdef SCM_STACK_GROWS_UP
 228   if (((SCM_STACKITEM *) & j - stack_start_ptr) < 0)
 229     fixconfig (remsg, "SCM_STACK_GROWS_UP", 1);
 230 #else
 231   if ((stack_start_ptr - (SCM_STACKITEM *) & j) < 0)
 232     fixconfig (addmsg, "SCM_STACK_GROWS_UP", 1);
 233 #endif
 234 }
 235 #endif
 236
 237
 238 \f
 239 /* initializing standard and current I/O ports */
 240
 241 /* Create standard ports from stdio stdin, stdout, and stderr.  */
 242 static void
 243 scm_init_standard_ports ()
 244 {
 245   /* I'm not sure why this should be unbuffered when coming from a
 246      tty; isn't line buffering more common?  */
 247   scm_def_inp = scm_stdio_to_port (stdin,
 248                                    (isatty (fileno (stdin)) ? "r0" : "r"),
 249                                    "standard input");
 250   scm_def_outp = scm_stdio_to_port (stdout, "w", "standard output");
 251   scm_def_errp = scm_stdio_to_port (stderr, "w", "standard error");
 252
 253   scm_cur_inp = scm_def_inp;
 254   scm_cur_outp = scm_def_outp;
 255   scm_cur_errp = scm_def_errp;
 256 }
 257
 258
 259 \f
 260 #ifdef _UNICOS
 261 typedef int setjmp_type;
 262 #else
 263 typedef long setjmp_type;
 264 #endif
 265
 266 /* All the data needed to invoke the main function.  */
 267 struct main_func_closure
 268 {
 269   /* the function to call */
 270   void (*main_func) SCM_P ((void *closure, int argc, char **argv));
 271   void *closure;                /* dummy data to pass it */
 272   int argc;
 273   char **argv;                  /* the argument list it should receive */
 274 };
 275
 276
 277 static void scm_boot_guile_1 SCM_P ((SCM_STACKITEM *base,
 278                                      struct main_func_closure *closure));
 279 static SCM invoke_main_func SCM_P ((void *body_data, SCM jmpbuf));
 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 (0); this function never returns.  If you want
 288    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 (argc, argv, main_func, closure)
 312      int argc;
 313      char ** argv;
 314      void (*main_func) ();
 315      void *closure;
 316 {
 317   /* The garbage collector uses the address of this variable as one
 318      end of the stack, and the address of one of its own local
 319      variables as the other end.  */
 320   SCM_STACKITEM dummy;
 321   struct main_func_closure c;
 322
 323   c.main_func = main_func;
 324   c.closure = closure;
 325   c.argc = argc;
 326   c.argv = argv;
 327
 328   scm_boot_guile_1 (&dummy, &c);
 329 }
 330
 331
 332 /* Record here whether SCM_BOOT_GUILE_1 has already been called.  This
 333    variable is now here and not inside SCM_BOOT_GUILE_1 so that one
 334    can tweak it. This is necessary for unexec to work. (Hey, "1-live"
 335    is the name of a local radiostation...) */
 336
 337 int scm_boot_guile_1_live = 0;
 338
 339 static void
 340 scm_boot_guile_1 (base, closure)
 341      SCM_STACKITEM *base;
 342      struct main_func_closure *closure;
 343 {
 344   static int initialized = 0;
 345   /* static int live = 0; */
 346   setjmp_type setjmp_val;
 347
 348   /* This function is not re-entrant. */
 349   if (scm_boot_guile_1_live)
 350     abort ();
 351
 352   scm_boot_guile_1_live = 1;
 353
 354   scm_ints_disabled = 1;
 355   scm_block_gc = 1;
 356
 357   if (initialized)
 358     {
 359       scm_restart_stack (base);
 360     }
 361   else
 362     {
 363       scm_ports_prehistory ();
 364       scm_smob_prehistory ();
 365       scm_tables_prehistory ();
 366       scm_init_storage (0);
 367       scm_init_root ();
 368 #ifdef USE_THREADS
 369       scm_init_threads (base);
 370 #endif
 371       scm_start_stack (base);
 372       scm_init_gsubr ();
 373       scm_init_feature ();
 374       scm_init_alist ();
 375       scm_init_append ();
 376       scm_init_arbiters ();
 377       scm_init_async ();
 378       scm_init_backtrace ();
 379       scm_init_boolean ();
 380       scm_init_chars ();
 381       scm_init_continuations ();
 382       scm_init_dynwind ();
 383       scm_init_eq ();
 384       scm_init_error ();
 385       scm_init_fports ();
 386       scm_init_filesys ();
 387       scm_init_gc ();
 388       scm_init_gdbint ();
 389       scm_init_hash ();
 390       scm_init_hashtab ();
 391       scm_init_ioext ();
 392       scm_init_kw ();
 393       scm_init_list ();
 394       scm_init_mallocs ();
 395       scm_init_net_db ();
 396       scm_init_numbers ();
 397       scm_init_objprop ();
 398 #if DEBUG_EXTENSIONS
 399       /* Excluding this until it's really needed makes the binary
 400        * smaller after linking.  */
 401       scm_init_options ();
 402 #endif
 403       scm_init_pairs ();
 404       scm_init_ports ();
 405       scm_init_posix ();
 406       scm_init_procs ();
 407       scm_init_procprop ();
 408       scm_init_scmsigs ();
 409       scm_init_socket ();
 410 #ifdef DEBUG_EXTENSIONS
 411       scm_init_srcprop ();
 412 #endif
 413       scm_init_stackchk ();
 414       scm_init_struct ();       /* Requires struct */
 415       scm_init_stacks ();
 416       scm_init_strports ();
 417       scm_init_symbols ();
 418       scm_init_tag ();
 419       scm_init_load ();
 420       scm_init_print ();        /* Requires struct */
 421       scm_init_read ();
 422       scm_init_sequences ();
 423       scm_init_stime ();
 424       scm_init_strings ();
 425       scm_init_strorder ();
 426       scm_init_mbstrings ();
 427       scm_init_strop ();
 428       scm_init_throw ();
 429       scm_init_variable ();
 430       scm_init_vectors ();
 431       scm_init_version ();
 432       scm_init_weaks ();
 433       scm_init_vports ();
 434       scm_init_eval ();
 435 #ifdef DEBUG_EXTENSIONS
 436       scm_init_debug ();        /* Requires macro smobs */
 437 #endif
 438       scm_init_ramap ();
 439       scm_init_unif ();
 440       scm_init_simpos ();
 441       scm_init_load_path ();
 442       scm_init_standard_ports ();
 443       scm_init_dynamic_linking ();
 444       initialized = 1;
 445     }
 446
 447   scm_block_gc = 0;             /* permit the gc to run */
 448   /* ints still disabled */
 449
 450 #ifdef STACK_CHECKING
 451   scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
 452 #endif
 453
 454   setjmp_val = setjmp (SCM_JMPBUF (scm_rootcont));
 455   if (!setjmp_val)
 456     {
 457       scm_init_signals ();
 458
 459       scm_set_program_arguments (closure->argc, closure->argv, 0);
 460       scm_internal_catch (SCM_BOOL_T, invoke_main_func, closure,
 461                           scm_handle_by_message, 0);
 462     }
 463
 464   scm_restore_signals ();
 465
 466   /* This tick gives any pending
 467    * asyncs a chance to run.  This must be done after
 468    * the call to scm_restore_signals.
 469    */
 470   SCM_ASYNC_TICK;
 471
 472   /* If the caller doesn't want this, they should return from
 473      main_func themselves.  */
 474   exit (0);
 475 }
 476
 477
 478 static SCM
 479 invoke_main_func (body_data, jmpbuf)
 480      void *body_data;
 481      SCM jmpbuf;
 482 {
 483   struct main_func_closure *closure = (struct main_func_closure *) body_data;
 484
 485   (*closure->main_func) (closure->closure, closure->argc, closure->argv);
 486
 487   /* never reached */
 488   return SCM_UNDEFINED;
 489 }