Merge remote-tracking branch 'local-2.0/stable-2.0'
[bpt/guile.git] / libguile / frames.c
dissimilarity index 60%
index 76552f5..b90b5a2 100644 (file)
-/* Copyright (C) 2001 Free Software Foundation, Inc.
- * 
- * 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 3 of
- * the License, or (at your option) any later version.
- *
- * 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.
- *
- * 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., 51 Franklin Street, Fifth Floor, Boston, MA
- * 02110-1301 USA
- */
-
-#if HAVE_CONFIG_H
-#  include <config.h>
-#endif
-
-#include <stdlib.h>
-#include <string.h>
-#include "_scm.h"
-#include "vm-bootstrap.h"
-#include "frames.h"
-
-\f
-scm_t_bits scm_tc16_vm_frame;
-
-#define RELOC(frame, val) (val + SCM_VM_FRAME_OFFSET (frame))
-
-SCM
-scm_c_make_vm_frame (SCM stack_holder, SCM *fp, SCM *sp,
-                     scm_byte_t *ip, scm_t_ptrdiff offset)
-{
-  struct scm_vm_frame *p = scm_gc_malloc (sizeof (struct scm_vm_frame),
-                                          "vmframe");
-  p->stack_holder = stack_holder;
-  p->fp = fp;
-  p->sp = sp;
-  p->ip = ip;
-  p->offset = offset;
-  SCM_RETURN_NEWSMOB (scm_tc16_vm_frame, p);
-}
-
-static int
-vm_frame_print (SCM frame, SCM port, scm_print_state *pstate)
-{
-  scm_puts ("#<vm-frame ", port);
-  scm_uintprint (SCM_UNPACK (frame), 16, port);
-  scm_putc (' ', port);
-  scm_write (scm_vm_frame_program (frame), port);
-  /* don't write args, they can get us into trouble. */
-  scm_puts (">", port);
-
-  return 1;
-}
-
-static SCM
-vm_frame_mark (SCM obj)
-{
-  return SCM_VM_FRAME_STACK_HOLDER (obj);
-}
-
-static size_t
-vm_frame_free (SCM obj)
-{
-  struct scm_vm_frame *p = SCM_VM_FRAME_DATA (obj);
-  scm_gc_free (p, sizeof(struct scm_vm_frame), "vmframe");
-  return 0;
-}
-
-/* Scheme interface */
-
-SCM_DEFINE (scm_vm_frame_p, "vm-frame?", 1, 0, 0,
-           (SCM obj),
-           "")
-#define FUNC_NAME s_scm_vm_frame_p
-{
-  return SCM_BOOL (SCM_VM_FRAME_P (obj));
-}
-#undef FUNC_NAME
-
-SCM_DEFINE (scm_vm_frame_program, "vm-frame-program", 1, 0, 0,
-           (SCM frame),
-           "")
-#define FUNC_NAME s_scm_vm_frame_program
-{
-  SCM_VALIDATE_VM_FRAME (1, frame);
-  return SCM_FRAME_PROGRAM (SCM_VM_FRAME_FP (frame));
-}
-#undef FUNC_NAME
-
-SCM_DEFINE (scm_vm_frame_arguments, "vm-frame-arguments", 1, 0, 0,
-           (SCM frame),
-           "")
-#define FUNC_NAME s_scm_vm_frame_arguments
-{
-  SCM *fp;
-  int i;
-  struct scm_objcode *bp;
-  SCM ret;
-  
-  SCM_VALIDATE_VM_FRAME (1, frame);
-
-  fp = SCM_VM_FRAME_FP (frame);
-  bp = SCM_PROGRAM_DATA (SCM_FRAME_PROGRAM (fp));
-
-  if (!bp->nargs)
-    return SCM_EOL;
-  else if (bp->nrest)
-    ret = fp[bp->nargs - 1];
-  else
-    ret = scm_cons (fp[bp->nargs - 1], SCM_EOL);
-  
-  for (i = bp->nargs - 2; i >= 0; i--)
-    ret = scm_cons (fp[i], ret);
-  
-  return ret;
-}
-#undef FUNC_NAME
-
-SCM_DEFINE (scm_vm_frame_source, "vm-frame-source", 1, 0, 0,
-           (SCM frame),
-           "")
-#define FUNC_NAME s_scm_vm_frame_source
-{
-  SCM *fp;
-  struct scm_objcode *bp;
-  
-  SCM_VALIDATE_VM_FRAME (1, frame);
-
-  fp = SCM_VM_FRAME_FP (frame);
-  bp = SCM_PROGRAM_DATA (SCM_FRAME_PROGRAM (fp));
-
-  return scm_c_program_source (SCM_FRAME_PROGRAM (fp),
-                               SCM_VM_FRAME_IP (frame) - bp->base);
-}
-#undef FUNC_NAME
-
-SCM_DEFINE (scm_vm_frame_local_ref, "vm-frame-local-ref", 2, 0, 0,
-           (SCM frame, SCM index),
-           "")
-#define FUNC_NAME s_scm_vm_frame_local_ref
-{
-  SCM *fp;
-  unsigned int i;
-  struct scm_objcode *bp;
-  
-  SCM_VALIDATE_VM_FRAME (1, frame);
-
-  fp = SCM_VM_FRAME_FP (frame);
-  bp = SCM_PROGRAM_DATA (SCM_FRAME_PROGRAM (fp));
-
-  SCM_VALIDATE_UINT_COPY (2, index, i);
-  SCM_ASSERT_RANGE (2, index, i < bp->nargs + bp->nlocs);
-
-  return SCM_FRAME_VARIABLE (fp, i);
-}
-#undef FUNC_NAME
-
-SCM_DEFINE (scm_vm_frame_local_set_x, "vm-frame-local-set!", 3, 0, 0,
-           (SCM frame, SCM index, SCM val),
-           "")
-#define FUNC_NAME s_scm_vm_frame_local_set_x
-{
-  SCM *fp;
-  unsigned int i;
-  struct scm_objcode *bp;
-  
-  SCM_VALIDATE_VM_FRAME (1, frame);
-
-  fp = SCM_VM_FRAME_FP (frame);
-  bp = SCM_PROGRAM_DATA (SCM_FRAME_PROGRAM (fp));
-
-  SCM_VALIDATE_UINT_COPY (2, index, i);
-  SCM_ASSERT_RANGE (2, index, i < bp->nargs + bp->nlocs);
-
-  SCM_FRAME_VARIABLE (fp, i) = val;
-
-  return SCM_UNSPECIFIED;
-}
-#undef FUNC_NAME
-
-SCM_DEFINE (scm_vm_frame_return_address, "vm-frame-return-address", 1, 0, 0,
-           (SCM frame),
-           "")
-#define FUNC_NAME s_scm_vm_frame_return_address
-{
-  SCM_VALIDATE_VM_FRAME (1, frame);
-  return scm_from_ulong ((unsigned long)
-                        (SCM_FRAME_RETURN_ADDRESS
-                         (SCM_VM_FRAME_FP (frame))));
-}
-#undef FUNC_NAME
-
-SCM_DEFINE (scm_vm_frame_mv_return_address, "vm-frame-mv-return-address", 1, 0, 0,
-           (SCM frame),
-           "")
-#define FUNC_NAME s_scm_vm_frame_mv_return_address
-{
-  SCM_VALIDATE_VM_FRAME (1, frame);
-  return scm_from_ulong ((unsigned long)
-                        (SCM_FRAME_MV_RETURN_ADDRESS
-                         (SCM_VM_FRAME_FP (frame))));
-}
-#undef FUNC_NAME
-
-SCM_DEFINE (scm_vm_frame_dynamic_link, "vm-frame-dynamic-link", 1, 0, 0,
-           (SCM frame),
-           "")
-#define FUNC_NAME s_scm_vm_frame_dynamic_link
-{
-  SCM_VALIDATE_VM_FRAME (1, frame);
-  /* fixme: munge fp if holder is a continuation */
-  return scm_from_ulong
-    ((unsigned long)
-     RELOC (frame,
-            SCM_FRAME_DYNAMIC_LINK (SCM_VM_FRAME_FP (frame))));
-}
-#undef FUNC_NAME
-
-SCM_DEFINE (scm_vm_frame_external_link, "vm-frame-external-link", 1, 0, 0,
-           (SCM frame),
-           "")
-#define FUNC_NAME s_scm_vm_frame_external_link
-{
-  SCM_VALIDATE_VM_FRAME (1, frame);
-  return SCM_FRAME_EXTERNAL_LINK (SCM_VM_FRAME_FP (frame));
-}
-#undef FUNC_NAME
-
-SCM_DEFINE (scm_vm_frame_stack, "vm-frame-stack", 1, 0, 0,
-           (SCM frame),
-           "")
-#define FUNC_NAME s_scm_vm_frame_stack
-{
-  SCM *top, *bottom, ret = SCM_EOL;
-
-  SCM_VALIDATE_VM_FRAME (1, frame);
-
-  top = SCM_VM_FRAME_SP (frame);
-  bottom = SCM_FRAME_UPPER_ADDRESS (SCM_VM_FRAME_FP (frame));
-  while (bottom <= top)
-    ret = scm_cons (*bottom++, ret);
-
-  return ret;
-}
-#undef FUNC_NAME
-
-extern SCM
-scm_c_vm_frame_prev (SCM frame)
-{
-  SCM *this_fp, *new_fp, *new_sp;
-  this_fp = SCM_VM_FRAME_FP (frame);
-  new_fp = SCM_FRAME_DYNAMIC_LINK (this_fp);
-  if (new_fp) 
-    { new_fp = RELOC (frame, new_fp);
-      new_sp = SCM_FRAME_LOWER_ADDRESS (this_fp) - 1;
-      return scm_c_make_vm_frame (SCM_VM_FRAME_STACK_HOLDER (frame),
-                                  new_fp, new_sp,
-                                  SCM_FRAME_RETURN_ADDRESS (this_fp),
-                                  SCM_VM_FRAME_OFFSET (frame));
-    }
-  else
-    return SCM_BOOL_F;
-}
-
-\f
-void
-scm_bootstrap_frames (void)
-{
-  scm_tc16_vm_frame = scm_make_smob_type ("vm-frame", 0);
-  scm_set_smob_mark (scm_tc16_vm_frame, vm_frame_mark);
-  scm_set_smob_free (scm_tc16_vm_frame, vm_frame_free);
-  scm_set_smob_print (scm_tc16_vm_frame, vm_frame_print);
-  scm_c_register_extension ("libguile", "scm_init_frames",
-                            (scm_t_extension_init_func)scm_init_frames, NULL);
-}
-
-void
-scm_init_frames (void)
-{
-  scm_bootstrap_vm ();
-
-#ifndef SCM_MAGIC_SNARFER
-#include "libguile/frames.x"
-#endif
-}
-
-/*
-  Local Variables:
-  c-file-style: "gnu"
-  End:
-*/
+/* Copyright (C) 2001, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
+ * 
+ * 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 3 of
+ * the License, or (at your option) any later version.
+ *
+ * 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.
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
+ */
+
+#if HAVE_CONFIG_H
+#  include <config.h>
+#endif
+
+#include <stdlib.h>
+#include <string.h>
+#include "_scm.h"
+#include "frames.h"
+#include <verify.h>
+
+/* Make sure assumptions on the layout of `struct scm_vm_frame' hold.  */
+verify (sizeof (SCM) == sizeof (SCM *));
+verify (sizeof (struct scm_vm_frame) == 5 * sizeof (SCM));
+verify (offsetof (struct scm_vm_frame, dynamic_link) == 0);
+
+\f
+#define RELOC(frame, val)                              \
+  (((SCM *) (val)) + SCM_VM_FRAME_OFFSET (frame))
+
+SCM
+scm_c_make_frame (SCM stack_holder, SCM *fp, SCM *sp,
+                  scm_t_uint8 *ip, scm_t_ptrdiff offset)
+{
+  struct scm_frame *p = scm_gc_malloc (sizeof (struct scm_frame),
+                                       "vmframe");
+  p->stack_holder = stack_holder;
+  p->fp = fp;
+  p->sp = sp;
+  p->ip = ip;
+  p->offset = offset;
+  return scm_cell (scm_tc7_frame, (scm_t_bits)p);
+}
+
+void
+scm_i_frame_print (SCM frame, SCM port, scm_print_state *pstate)
+{
+  scm_puts_unlocked ("#<frame ", port);
+  scm_uintprint (SCM_UNPACK (frame), 16, port);
+  scm_putc_unlocked (' ', port);
+  scm_write (scm_frame_procedure (frame), port);
+  /* don't write args, they can get us into trouble. */
+  scm_puts_unlocked (">", port);
+}
+
+\f
+/* Scheme interface */
+
+SCM_DEFINE (scm_frame_p, "frame?", 1, 0, 0,
+           (SCM obj),
+           "")
+#define FUNC_NAME s_scm_frame_p
+{
+  return scm_from_bool (SCM_VM_FRAME_P (obj));
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_frame_procedure, "frame-procedure", 1, 0, 0,
+           (SCM frame),
+           "")
+#define FUNC_NAME s_scm_frame_procedure
+{
+  SCM_VALIDATE_VM_FRAME (1, frame);
+  return SCM_FRAME_PROGRAM (SCM_VM_FRAME_FP (frame));
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_frame_arguments, "frame-arguments", 1, 0, 0,
+           (SCM frame),
+           "")
+#define FUNC_NAME s_scm_frame_arguments
+{
+  static SCM var = SCM_BOOL_F;
+  
+  SCM_VALIDATE_VM_FRAME (1, frame);
+
+  if (scm_is_false (var))
+    var = scm_c_module_lookup (scm_c_resolve_module ("system vm frame"),
+                               "frame-arguments");
+
+  return scm_call_1 (SCM_VARIABLE_REF (var), frame);
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_frame_source, "frame-source", 1, 0, 0,
+           (SCM frame),
+           "")
+#define FUNC_NAME s_scm_frame_source
+{
+  SCM_VALIDATE_VM_FRAME (1, frame);
+
+  return scm_program_source (scm_frame_procedure (frame),
+                             scm_frame_instruction_pointer (frame),
+                             SCM_UNDEFINED);
+}
+#undef FUNC_NAME
+
+/* The number of locals would be a simple thing to compute, if it weren't for
+   the presence of not-yet-active frames on the stack. So we have a cheap
+   heuristic to detect not-yet-active frames, and skip over them. Perhaps we
+   should represent them more usefully.
+*/
+SCM_DEFINE (scm_frame_num_locals, "frame-num-locals", 1, 0, 0,
+           (SCM frame),
+           "")
+#define FUNC_NAME s_scm_frame_num_locals
+{
+  SCM *sp, *p;
+  unsigned int n = 0;
+
+  SCM_VALIDATE_VM_FRAME (1, frame);
+
+  sp = SCM_VM_FRAME_SP (frame);
+  p = SCM_FRAME_STACK_ADDRESS (SCM_VM_FRAME_FP (frame));
+  while (p <= sp)
+    {
+      if (SCM_UNPACK (p[0]) == 0)
+        /* skip over not-yet-active frame */
+        p += 3;
+      else
+        {
+          p++;
+          n++;
+        }
+    }
+  return scm_from_uint (n);
+}
+#undef FUNC_NAME
+
+/* Need same not-yet-active frame logic here as in frame-num-locals */
+SCM_DEFINE (scm_frame_local_ref, "frame-local-ref", 2, 0, 0,
+           (SCM frame, SCM index),
+           "")
+#define FUNC_NAME s_scm_frame_local_ref
+{
+  SCM *sp, *p;
+  unsigned int n = 0;
+  unsigned int i;
+
+  SCM_VALIDATE_VM_FRAME (1, frame);
+  SCM_VALIDATE_UINT_COPY (2, index, i);
+
+  sp = SCM_VM_FRAME_SP (frame);
+  p = SCM_FRAME_STACK_ADDRESS (SCM_VM_FRAME_FP (frame));
+  while (p <= sp)
+    {
+      if (SCM_UNPACK (p[0]) == 0)
+        /* skip over not-yet-active frame */
+        p += 3;
+      else if (n == i)
+        return *p;
+      else
+        {
+          p++;
+          n++;
+        }
+    }
+  SCM_OUT_OF_RANGE (SCM_ARG2, index);
+}
+#undef FUNC_NAME
+
+/* Need same not-yet-active frame logic here as in frame-num-locals */
+SCM_DEFINE (scm_frame_local_set_x, "frame-local-set!", 3, 0, 0,
+           (SCM frame, SCM index, SCM val),
+           "")
+#define FUNC_NAME s_scm_frame_local_set_x
+{
+  SCM *sp, *p;
+  unsigned int n = 0;
+  unsigned int i;
+
+  SCM_VALIDATE_VM_FRAME (1, frame);
+  SCM_VALIDATE_UINT_COPY (2, index, i);
+
+  sp = SCM_VM_FRAME_SP (frame);
+  p = SCM_FRAME_STACK_ADDRESS (SCM_VM_FRAME_FP (frame));
+  while (p <= sp)
+    {
+      if (SCM_UNPACK (p[0]) == 0)
+        /* skip over not-yet-active frame */
+        p += 3;
+      else if (n == i)
+        {
+          *p = val;
+          return SCM_UNSPECIFIED;
+        }
+      else
+        {
+          p++;
+          n++;
+        }
+    }
+  SCM_OUT_OF_RANGE (SCM_ARG2, index);
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_frame_address, "frame-address", 1, 0, 0,
+           (SCM frame),
+           "Return the frame pointer for @var{frame}.")
+#define FUNC_NAME s_scm_frame_address
+{
+  SCM_VALIDATE_VM_FRAME (1, frame);
+  return scm_from_unsigned_integer ((scm_t_bits) SCM_VM_FRAME_FP (frame));
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_frame_stack_pointer, "frame-stack-pointer", 1, 0, 0,
+           (SCM frame),
+           "")
+#define FUNC_NAME s_scm_frame_stack_pointer
+{
+  SCM_VALIDATE_VM_FRAME (1, frame);
+
+  return scm_from_unsigned_integer ((scm_t_bits) SCM_VM_FRAME_SP (frame));
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_frame_instruction_pointer, "frame-instruction-pointer", 1, 0, 0,
+           (SCM frame),
+           "")
+#define FUNC_NAME s_scm_frame_instruction_pointer
+{
+  SCM program;
+  const struct scm_objcode *c_objcode;
+
+  SCM_VALIDATE_VM_FRAME (1, frame);
+  program = scm_frame_procedure (frame);
+
+  if (!SCM_PROGRAM_P (program))
+    return SCM_INUM0;
+
+  c_objcode = SCM_PROGRAM_DATA (program);
+  return scm_from_unsigned_integer ((SCM_VM_FRAME_IP (frame)
+                                     - SCM_C_OBJCODE_BASE (c_objcode)));
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_frame_return_address, "frame-return-address", 1, 0, 0,
+           (SCM frame),
+           "")
+#define FUNC_NAME s_scm_frame_return_address
+{
+  SCM_VALIDATE_VM_FRAME (1, frame);
+  return scm_from_unsigned_integer ((scm_t_bits)
+                                    (SCM_FRAME_RETURN_ADDRESS
+                                     (SCM_VM_FRAME_FP (frame))));
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_frame_mv_return_address, "frame-mv-return-address", 1, 0, 0,
+           (SCM frame),
+           "")
+#define FUNC_NAME s_scm_frame_mv_return_address
+{
+  SCM_VALIDATE_VM_FRAME (1, frame);
+  return scm_from_unsigned_integer ((scm_t_bits)
+                                    (SCM_FRAME_MV_RETURN_ADDRESS
+                                     (SCM_VM_FRAME_FP (frame))));
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_frame_dynamic_link, "frame-dynamic-link", 1, 0, 0,
+           (SCM frame),
+           "")
+#define FUNC_NAME s_scm_frame_dynamic_link
+{
+  SCM_VALIDATE_VM_FRAME (1, frame);
+  /* fixme: munge fp if holder is a continuation */
+  return scm_from_ulong
+    ((unsigned long)
+     RELOC (frame,
+            SCM_FRAME_DYNAMIC_LINK (SCM_VM_FRAME_FP (frame))));
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_frame_previous, "frame-previous", 1, 0, 0,
+           (SCM frame),
+           "")
+#define FUNC_NAME s_scm_frame_previous
+{
+  SCM *this_fp, *new_fp, *new_sp;
+
+  SCM_VALIDATE_VM_FRAME (1, frame);
+
+ again:
+  this_fp = SCM_VM_FRAME_FP (frame);
+  new_fp = SCM_FRAME_DYNAMIC_LINK (this_fp);
+  if (new_fp) 
+    { new_fp = RELOC (frame, new_fp);
+      new_sp = SCM_FRAME_LOWER_ADDRESS (this_fp) - 1;
+      frame = scm_c_make_frame (SCM_VM_FRAME_STACK_HOLDER (frame),
+                                new_fp, new_sp,
+                                SCM_FRAME_RETURN_ADDRESS (this_fp),
+                                SCM_VM_FRAME_OFFSET (frame));
+      if (SCM_PROGRAM_IS_BOOT (scm_frame_procedure (frame)))
+        goto again;
+      else
+        return frame;
+    }
+  else
+    return SCM_BOOL_F;
+}
+#undef FUNC_NAME
+
+\f
+void
+scm_init_frames (void)
+{
+#ifndef SCM_MAGIC_SNARFER
+#include "libguile/frames.x"
+#endif
+}
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/