(environ): Use _NSGetEnviron in Darwin
[bpt/guile.git] / libguile / continuations.c
index 7b33d72..60322b3 100644 (file)
@@ -1,52 +1,28 @@
-/*     Copyright (C) 1995,1996,1998, 2000 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1998,2000,2001 Free Software Foundation, Inc.
  * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 USA
- *
- * As a special exception, the Free Software Foundation gives permission
- * for additional uses of the text contained in its release of GUILE.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
- *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * If you write modifications of your own for GUILE, it is your choice
- * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  */
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
 
-/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
-   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
 
 \f
 
+#include "libguile/_scm.h"
+
 #include <string.h>
 
-#include "libguile/_scm.h"
+#include "libguile/debug.h"
 #include "libguile/root.h"
 #include "libguile/stackchk.h"
 #include "libguile/smob.h"
 #include "libguile/dynwind.h"
 #include "libguile/values.h"
 
-#ifdef DEBUG_EXTENSIONS
-#include "libguile/debug.h"
-#endif
-
 #include "libguile/validate.h"
 #include "libguile/continuations.h"
 
 /* {Continuations}
  */
 
-scm_bits_t scm_tc16_continuation;
+scm_t_bits scm_tc16_continuation;
 
 static SCM
 continuation_mark (SCM obj)
 {
-  scm_contregs_t *continuation = SCM_CONTREGS (obj);
+  scm_t_contregs *continuation = SCM_CONTREGS (obj);
 
   scm_gc_mark (continuation->throw_value);
   scm_mark_locations (continuation->stack, continuation->num_stack_items);
+#ifdef __ia64__
+  if (continuation->backing_store)
+    scm_mark_locations (continuation->backing_store, 
+                        continuation->backing_store_size / 
+                        sizeof (SCM_STACKITEM));
+#endif /* __ia64__ */
   return continuation->dynenv;
 }
 
 static size_t
 continuation_free (SCM obj)
 {
-  scm_contregs_t *continuation = SCM_CONTREGS (obj);
+  scm_t_contregs *continuation = SCM_CONTREGS (obj);
   /* stack array size is 1 if num_stack_items is 0 (rootcont).  */
   size_t extra_items = (continuation->num_stack_items > 0)
     ? (continuation->num_stack_items - 1)
     : 0;
-  size_t bytes_free = sizeof (scm_contregs_t)
+  size_t bytes_free = sizeof (scm_t_contregs)
     + extra_items * sizeof (SCM_STACKITEM);
-  
-  scm_must_free (continuation);
-  return bytes_free;
+
+#ifdef __ia64__
+  scm_gc_free (continuation->backing_store, continuation->backing_store_size,
+              "continuation backing store");
+#endif /* __ia64__ */ 
+  scm_gc_free (continuation, bytes_free, "continuation");
+  return 0;
 }
 
 static int
-continuation_print (SCM obj, SCM port, scm_print_state *state)
+continuation_print (SCM obj, SCM port, scm_print_state *state SCM_UNUSED)
 {
-  scm_contregs_t *continuation = SCM_CONTREGS (obj);
+  scm_t_contregs *continuation = SCM_CONTREGS (obj);
 
   scm_puts ("#<continuation ", port);
   scm_intprint (continuation->num_stack_items, 10, port);
@@ -106,6 +88,18 @@ continuation_print (SCM obj, SCM port, scm_print_state *state)
   return 1;
 }
 
+#ifdef __ia64__
+/* Extern declaration of getcontext()/setcontext() in order to redefine
+   getcontext() since on ia64-linux the second return value indicates whether
+   it returned from getcontext() itself or by running setcontext(). */
+struct rv
+{
+  long retval;
+  long first_return;
+};
+extern struct rv ia64_getcontext (ucontext_t *) __asm__ ("getcontext");
+#endif /* __ia64__ */
+
 /* this may return more than once: the first time with the escape
    procedure, then subsequently with the value to be passed to the
    continuation.  */
@@ -114,46 +108,88 @@ SCM
 scm_make_continuation (int *first)
 {
   volatile SCM cont;
-  scm_contregs_t *continuation;
-  scm_contregs_t *rootcont = SCM_CONTREGS (scm_rootcont);
+  scm_t_contregs *continuation;
+  scm_t_contregs *rootcont = SCM_CONTREGS (scm_rootcont);
   long stack_size;
   SCM_STACKITEM * src;
+#ifdef __ia64__
+  struct rv rv;
+#endif /* __ia64__ */
 
   SCM_ENTER_A_SECTION;
   SCM_FLUSH_REGISTER_WINDOWS;
   stack_size = scm_stack_size (rootcont->base);
-  continuation = scm_must_malloc (sizeof (scm_contregs_t)
-                                 + (stack_size - 1) * sizeof (SCM_STACKITEM),
-                                 FUNC_NAME);
+  continuation = scm_gc_malloc (sizeof (scm_t_contregs)
+                               + (stack_size - 1) * sizeof (SCM_STACKITEM),
+                               "continuation");
   continuation->num_stack_items = stack_size;
   continuation->dynenv = scm_dynwinds;
   continuation->throw_value = SCM_EOL;
   continuation->base = src = rootcont->base;
   continuation->seq = rootcont->seq;
-#ifdef DEBUG_EXTENSIONS
   continuation->dframe = scm_last_debug_frame;
-#endif
   SCM_NEWSMOB (cont, scm_tc16_continuation, continuation);
   SCM_EXIT_A_SECTION;
 
-#ifndef SCM_STACK_GROWS_UP
+#if ! SCM_STACK_GROWS_UP
   src -= stack_size;
 #endif
   memcpy (continuation->stack, src, sizeof (SCM_STACKITEM) * stack_size);
 
+#ifdef __ia64__
+  rv = ia64_getcontext (&continuation->ctx);
+  if (rv.first_return)
+    {
+      continuation->backing_store_size = 
+        continuation->ctx.uc_mcontext.sc_ar_bsp - 
+        (unsigned long) __libc_ia64_register_backing_store_base;
+      continuation->backing_store = NULL;
+      continuation->backing_store = 
+        scm_gc_malloc (continuation->backing_store_size,
+                      "continuation backing store");
+      memcpy (continuation->backing_store, 
+              (void *) __libc_ia64_register_backing_store_base, 
+              continuation->backing_store_size);
+      *first = 1;
+      return cont;
+    }
+  else
+    {
+      SCM ret = continuation->throw_value;
+      *first = 0;
+      continuation->throw_value = SCM_BOOL_F;
+      return ret;
+    }
+#else /* !__ia64__ */
   if (setjmp (continuation->jmpbuf))
     {
+      SCM ret = continuation->throw_value;
       *first = 0;
-      return continuation->throw_value;
+      continuation->throw_value = SCM_BOOL_F;
+      return ret;
     }
   else
     {
       *first = 1;
       return cont;
     }
+#endif /* !__ia64__ */
 }
 #undef FUNC_NAME
 
+
+/* Invoking a continuation proceeds as follows:
+ *
+ * - the stack is made large enough for the called continuation
+ * - the old windchain is unwound down to the branching point
+ * - the continuation stack is copied into place
+ * - the windchain is rewound up to the continuation's context
+ * - the continuation is invoked via longjmp (or setcontext)
+ *
+ * This order is important so that unwind and rewind handlers are run
+ * with their correct stack.
+ */
+
 static void scm_dynthrow (SCM, SCM);
 
 /* Grow the stack by a fixed amount to provide space to copy in the
@@ -163,14 +199,14 @@ static void scm_dynthrow (SCM, SCM);
  * variable.
  */
 
-scm_bits_t scm_i_dummy;
+scm_t_bits scm_i_dummy;
 
 static void 
 grow_stack (SCM cont, SCM val)
 {
-  scm_bits_t growth[100];
+  scm_t_bits growth[100];
 
-  scm_i_dummy = (scm_bits_t) growth;
+  scm_i_dummy = (scm_t_bits) growth;
   scm_dynthrow (cont, val);
 }
 
@@ -179,22 +215,45 @@ grow_stack (SCM cont, SCM val)
  * within this function is safe, since only stack frames below this function's
  * own frame are overwritten.  Thus, memcpy can be used for best performance.
  */
+
+typedef struct {
+  scm_t_contregs *continuation;
+  SCM_STACKITEM *dst;
+} copy_stack_data;
+
 static void
-copy_stack_and_call (scm_contregs_t *continuation, SCM val, 
+copy_stack (void *data)
+{
+  copy_stack_data *d = (copy_stack_data *)data;
+  memcpy (d->dst, d->continuation->stack,
+         sizeof (SCM_STACKITEM) * d->continuation->num_stack_items);
+}
+
+static void
+copy_stack_and_call (scm_t_contregs *continuation, SCM val,
                     SCM_STACKITEM * dst)
 {
-  memcpy (dst, continuation->stack,
-         sizeof (SCM_STACKITEM) * continuation->num_stack_items);
+  long delta;
+  copy_stack_data data;
+
+  delta = scm_ilength (scm_dynwinds) - scm_ilength (continuation->dynenv);
+  data.continuation = continuation;
+  data.dst = dst;
+  scm_i_dowinds (continuation->dynenv, delta, copy_stack, &data);
 
-#ifdef DEBUG_EXTENSIONS
   scm_last_debug_frame = continuation->dframe;
-#endif
 
   continuation->throw_value = val;
+#ifdef __ia64__
+  memcpy ((void *) __libc_ia64_register_backing_store_base,
+          continuation->backing_store,
+          continuation->backing_store_size);
+  setcontext (&continuation->ctx);
+#else
   longjmp (continuation->jmpbuf, 1);
+#endif
 }
 
-
 /* Call grow_stack until the stack space is large enough, then, as the current
  * stack frame might get overwritten, let copy_stack_and_call perform the
  * actual copying and continuation calling.
@@ -202,16 +261,16 @@ copy_stack_and_call (scm_contregs_t *continuation, SCM val,
 static void 
 scm_dynthrow (SCM cont, SCM val)
 {
-  scm_contregs_t *continuation = SCM_CONTREGS (cont);
+  scm_t_contregs *continuation = SCM_CONTREGS (cont);
   SCM_STACKITEM * dst = SCM_BASE (scm_rootcont);
   SCM_STACKITEM stack_top_element;
 
-#ifdef SCM_STACK_GROWS_UP
+#if SCM_STACK_GROWS_UP
   if (SCM_PTR_GE (dst + continuation->num_stack_items, &stack_top_element))
     grow_stack (cont, val);
 #else
   dst -= continuation->num_stack_items;
-  if (SCM_PTR_LE (dst, &stack_top_element))
+  if (dst <= &stack_top_element)
     grow_stack (cont, val);
 #endif /* def SCM_STACK_GROWS_UP */
 
@@ -224,21 +283,17 @@ static SCM
 continuation_apply (SCM cont, SCM args)
 #define FUNC_NAME "continuation_apply"
 {
-  scm_contregs_t *continuation = SCM_CONTREGS (cont);
-  scm_contregs_t *rootcont = SCM_CONTREGS (scm_rootcont);
+  scm_t_contregs *continuation = SCM_CONTREGS (cont);
+  scm_t_contregs *rootcont = SCM_CONTREGS (scm_rootcont);
 
   if (continuation->seq != rootcont->seq
       /* this base comparison isn't needed */
       || continuation->base != rootcont->base)
     {
       SCM_MISC_ERROR ("continuation from wrong top level: ~S", 
-                     SCM_LIST1 (cont));
+                     scm_list_1 (cont));
     }
   
-  scm_dowinds (continuation->dynenv,
-              scm_ilength (scm_dynwinds)
-              - scm_ilength (continuation->dynenv));
-  
   scm_dynthrow (cont, scm_values (args));
   return SCM_UNSPECIFIED; /* not reached */
 }
@@ -253,9 +308,7 @@ scm_init_continuations ()
   scm_set_smob_free (scm_tc16_continuation, continuation_free);
   scm_set_smob_print (scm_tc16_continuation, continuation_print);
   scm_set_smob_apply (scm_tc16_continuation, continuation_apply, 0, 0, 1);
-#ifndef SCM_MAGIC_SNARFER
 #include "libguile/continuations.x"
-#endif
 }
 
 /*