Merge branch 'master' into boehm-demers-weiser-gc
[bpt/guile.git] / libguile / smob.c
index 16fef9f..0598bae 100644 (file)
@@ -1,53 +1,35 @@
-/* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1998,1999,2000,2001, 2003, 2004, 2006, 2009 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.
+ * 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.
  *
- * 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 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.
  *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
- *
- * 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.
- *
- * 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., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
+ */
 
 
 \f
+#ifdef HAVE_CONFIG_H
+#  include <config.h>
+#endif
 
 #include <stdio.h>
 #include <errno.h>
 
 #include "libguile/_scm.h"
 
+#include "libguile/async.h"
 #include "libguile/objects.h"
+#include "libguile/goops.h"
 #include "libguile/ports.h"
 
 #ifdef HAVE_MALLOC_H
 
 #include "libguile/smob.h"
 
+#include "libguile/boehm-gc.h"
+#include <gc/gc_mark.h>
+
+
 \f
 
 /* scm_smobs scm_numsmob
  * tags for smobjects (if you know a tag you can get an index and conversely).
  */
 
-#define MAX_SMOB_COUNT 256
+#define MAX_SMOB_COUNT SCM_I_MAX_SMOB_TYPE_COUNT
+
 long scm_numsmob;
 scm_smob_descriptor scm_smobs[MAX_SMOB_COUNT];
 
+/* Lower 16 bit of data must be zero. 
+*/
+void
+scm_i_set_smob_flags (SCM x, scm_t_bits data)
+{
+  SCM_SET_CELL_WORD_0 (x, (SCM_CELL_WORD_0 (x) & 0xFFFF) | data);
+}
+
+void
+scm_assert_smob_type (scm_t_bits tag, SCM val)
+{
+  if (!SCM_SMOB_PREDICATE (tag, val))
+    scm_wrong_type_arg_msg (NULL, 0, val, scm_smobs[SCM_TC2SMOBNUM(tag)].name);
+}
+
 /* {Mark}
  */
 
@@ -107,8 +109,11 @@ scm_free0 (SCM ptr SCM_UNUSED)
 size_t
 scm_smob_free (SCM obj)
 {
-  scm_must_free ((char *) SCM_CELL_WORD_1 (obj));
-  return scm_smobs[SCM_SMOBNUM (obj)].size;
+  long n = SCM_SMOBNUM (obj);
+  if (scm_smobs[n].size > 0)
+    scm_gc_free ((void *) SCM_CELL_WORD_1 (obj), 
+                scm_smobs[n].size, SCM_SMOBNAME (n));
+  return 0;
 }
 
 /* {Print}
@@ -122,9 +127,9 @@ scm_smob_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED)
   scm_puts (SCM_SMOBNAME (n) ? SCM_SMOBNAME (n) : "smob", port);
   scm_putc (' ', port);
   if (scm_smobs[n].size)
-    scm_intprint (SCM_CELL_WORD_1 (exp), 16, port);
+    scm_uintprint (SCM_CELL_WORD_1 (exp), 16, port);
   else
-    scm_intprint (SCM_UNPACK (exp), 16, port);
+    scm_uintprint (SCM_UNPACK (exp), 16, port);
   scm_putc ('>', port);
   return 1;
 }
@@ -134,11 +139,11 @@ scm_smob_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED)
 
 #define SCM_SMOB_APPLY0(SMOB) \
   SCM_SMOB_DESCRIPTOR (SMOB).apply (SMOB)
-#define SCM_SMOB_APPLY1(SMOB,A1) \
+#define SCM_SMOB_APPLY1(SMOB, A1) \
   SCM_SMOB_DESCRIPTOR (SMOB).apply (SMOB, A1)
-#define SCM_SMOB_APPLY2(SMOB,A1,A2) \
+#define SCM_SMOB_APPLY2(SMOB, A1, A2) \
   SCM_SMOB_DESCRIPTOR (SMOB).apply (SMOB, A1, A2)
-#define SCM_SMOB_APPLY3(SMOB,A1,A2,A3) \
+#define SCM_SMOB_APPLY3(SMOB, A1, A2, A3) \
   SCM_SMOB_DESCRIPTOR (SMOB).apply (SMOB, A1, A2, A3)
 
 static SCM
@@ -252,7 +257,7 @@ scm_smob_apply_2_error (SCM smob, SCM a1 SCM_UNUSED, SCM a2 SCM_UNUSED)
 static SCM
 scm_smob_apply_3_030 (SCM smob, SCM a1, SCM a2, SCM rst)
 {
-  if (!SCM_NULLP (SCM_CDR (rst)))
+  if (!scm_is_null (SCM_CDR (rst)))
     scm_wrong_num_args (smob);
   return SCM_SMOB_APPLY3 (smob, a1, a2, SCM_CAR (rst));
 }
@@ -287,16 +292,16 @@ scm_smob_apply_3_error (SCM smob,
 \f
 
 scm_t_bits 
-scm_make_smob_type (char *name, size_t size)
+scm_make_smob_type (char const *name, size_t size)
 #define FUNC_NAME "scm_make_smob_type"
 {
   long new_smob;
 
-  SCM_ENTER_A_SECTION;  /* scm_numsmob */
+  SCM_CRITICAL_SECTION_START;
   new_smob = scm_numsmob;
   if (scm_numsmob != MAX_SMOB_COUNT)
     ++scm_numsmob;
-  SCM_EXIT_A_SECTION;
+  SCM_CRITICAL_SECTION_END;
 
   if (new_smob == MAX_SMOB_COUNT)
     scm_misc_error (FUNC_NAME, "maximum number of smobs exceeded", SCM_EOL);
@@ -309,8 +314,8 @@ scm_make_smob_type (char *name, size_t size)
     }
 
   /* Make a class object if Goops is present. */
-  if (scm_smob_class)
-    scm_smob_class[new_smob] = scm_make_extended_class (name);
+  if (SCM_UNPACK (scm_smob_class[0]) != 0)
+    scm_smob_class[new_smob] = scm_make_extended_class (name, 0);
 
   return scm_tc7_smob + new_smob * 256;
 }
@@ -449,87 +454,196 @@ scm_set_smob_apply (scm_t_bits tc, SCM (*apply) (),
   scm_smobs[SCM_TC2SMOBNUM (tc)].apply_2 = apply_2;
   scm_smobs[SCM_TC2SMOBNUM (tc)].apply_3 = apply_3;
   scm_smobs[SCM_TC2SMOBNUM (tc)].gsubr_type = type;
+
+  if (SCM_UNPACK (scm_smob_class[0]) != 0)
+    scm_i_inherit_applicable (scm_smob_class[SCM_TC2SMOBNUM (tc)]);
 }
 
 SCM
 scm_make_smob (scm_t_bits tc)
 {
-  long n = SCM_TC2SMOBNUM (tc);
+  scm_t_bits n = SCM_TC2SMOBNUM (tc);
   size_t size = scm_smobs[n].size;
-  SCM z;
-  SCM_NEWCELL (z);
-  if (size != 0)
-    {
-#if 0
-      if (scm_smobs[n].mark != 0)
-       {
-         fprintf
-           (stderr,
-            "forbidden operation for smobs with GC data, use SCM_NEWSMOB\n");
-         abort ();
-       }
-#endif
-      SCM_SET_SMOB_DATA (z, scm_must_malloc (size, SCM_SMOBNAME (n)));
-    }
-  SCM_SET_CELL_TYPE (z, tc);
-  return z;
+  scm_t_bits data = (size > 0
+                    ? (scm_t_bits) scm_gc_malloc (size, SCM_SMOBNAME (n))
+                    : 0);
+
+  SCM_RETURN_NEWSMOB (tc, data);
 }
 
 \f
-/* {Deprecated stuff}
+/* {Initialization for the type of free cells}
  */
 
-#if (SCM_DEBUG_DEPRECATED == 0)
+static int
+free_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED)
+{
+  char buf[100];
+  sprintf (buf, "#<freed cell %p; GC missed a reference>",
+          (void *) SCM_UNPACK (exp));
+  scm_puts (buf, port);
+  
+#if (SCM_DEBUG_CELL_ACCESSES == 1)
+  if (scm_debug_cell_accesses_p)
+    abort();
+#endif
+  
+
+  return 1;
+}
+
+\f
+/* Marking SMOBs using user-supplied mark procedures.  */
+
+
+/* The freelist and GC kind used for SMOB types that provide a custom mark
+   procedure.  */
+static void **smob_freelist = NULL;
+static int    smob_gc_kind = 0;
 
-long
-scm_make_smob_type_mfpe (char *name, size_t size,
-                        SCM (*mark) (SCM),
-                        size_t (*free) (SCM),
-                        int (*print) (SCM, SCM, scm_print_state *),
-                        SCM (*equalp) (SCM, SCM))
+
+/* The generic SMOB mark procedure that gets called for SMOBs allocated with
+   `scm_i_new_smob_with_mark_proc ()'.  */
+static struct GC_ms_entry *
+smob_mark (GC_word *addr, struct GC_ms_entry *mark_stack_ptr,
+          struct GC_ms_entry *mark_stack_limit, GC_word env)
 {
-  long answer = scm_make_smob_type (name, size);
-  scm_set_smob_mfpe (answer, mark, free, print, equalp);
-  return answer;
+  register SCM cell;
+  register scm_t_bits tc, smobnum;
+
+  cell = PTR2SCM (addr);
+
+  if (SCM_TYP7 (cell) != scm_tc7_smob)
+    /* It is likely that the GC passed us a pointer to a free-list element
+       which we must ignore (see warning in `gc/gc_mark.h').  */
+    return mark_stack_ptr;
+
+  tc = SCM_CELL_WORD_0 (cell);
+  smobnum = SCM_TC2SMOBNUM (tc);
+
+  if (smobnum >= scm_numsmob)
+    /* The first word looks corrupt.  */
+    abort ();
+
+  mark_stack_ptr = GC_MARK_AND_PUSH (SCM2PTR (SCM_CELL_OBJECT_1 (cell)),
+                                    mark_stack_ptr,
+                                    mark_stack_limit, NULL);
+  mark_stack_ptr = GC_MARK_AND_PUSH (SCM2PTR (SCM_CELL_OBJECT_2 (cell)),
+                                    mark_stack_ptr,
+                                    mark_stack_limit, NULL);
+  mark_stack_ptr = GC_MARK_AND_PUSH (SCM2PTR (SCM_CELL_OBJECT_3 (cell)),
+                                    mark_stack_ptr,
+                                    mark_stack_limit, NULL);
+
+  if (scm_smobs[smobnum].mark)
+    {
+      SCM obj;
+
+      SCM_I_CURRENT_THREAD->current_mark_stack_ptr = mark_stack_ptr;
+      SCM_I_CURRENT_THREAD->current_mark_stack_limit = mark_stack_limit;
+
+      /* Invoke the SMOB's mark procedure, which will in turn invoke
+        `scm_gc_mark ()', which may modify `current_mark_stack_ptr'.  */
+      obj = scm_smobs[smobnum].mark (cell);
+
+      mark_stack_ptr = SCM_I_CURRENT_THREAD->current_mark_stack_ptr;
+
+      if (SCM_NIMP (obj))
+       /* Mark the returned object.  */
+       mark_stack_ptr = GC_MARK_AND_PUSH (SCM2PTR (obj),
+                                          mark_stack_ptr,
+                                          mark_stack_limit, NULL);
+
+      SCM_I_CURRENT_THREAD->current_mark_stack_limit = NULL;
+      SCM_I_CURRENT_THREAD->current_mark_stack_ptr = NULL;
+    }
+
+  return mark_stack_ptr;
+
 }
 
+/* Mark object O.  We assume that this function is only called during the
+   mark phase, i.e., from within `smob_mark ()' or one of its
+   descendents.  */
 void
-scm_set_smob_mfpe (long tc, 
-                  SCM (*mark) (SCM),
-                  size_t (*free) (SCM),
-                  int (*print) (SCM, SCM, scm_print_state *),
-                  SCM (*equalp) (SCM, SCM))
+scm_gc_mark (SCM o)
 {
-  if (mark) scm_set_smob_mark (tc, mark);
-  if (free) scm_set_smob_free (tc, free);
-  if (print) scm_set_smob_print (tc, print);
-  if (equalp) scm_set_smob_equalp (tc, equalp);
+#define CURRENT_MARK_PTR                                                \
+  ((struct GC_ms_entry *)(SCM_I_CURRENT_THREAD->current_mark_stack_ptr))
+#define CURRENT_MARK_LIMIT                                                \
+  ((struct GC_ms_entry *)(SCM_I_CURRENT_THREAD->current_mark_stack_limit))
+
+  if (SCM_NIMP (o))
+    {
+      /* At this point, the `current_mark_*' fields of the current thread
+        must be defined (they are set in `smob_mark ()').  */
+      register struct GC_ms_entry *mark_stack_ptr;
+
+      if (!CURRENT_MARK_PTR)
+       /* The function was not called from a mark procedure.  */
+       abort ();
+
+      mark_stack_ptr = GC_MARK_AND_PUSH (SCM2PTR (o),
+                                        CURRENT_MARK_PTR, CURRENT_MARK_LIMIT,
+                                        NULL);
+      SCM_I_CURRENT_THREAD->current_mark_stack_ptr = mark_stack_ptr;
+    }
+#undef CURRENT_MARK_PTR
+#undef CURRENT_MARK_LIMIT
 }
 
-#endif  /* SCM_DEBUG_DEPRECATED == 0 */
+/* Return a SMOB with typecode TC.  The SMOB type corresponding to TC may
+   provide a custom mark procedure and it will be honored.  */
+SCM
+scm_i_new_smob_with_mark_proc (scm_t_bits tc, scm_t_bits data1,
+                              scm_t_bits data2, scm_t_bits data3)
+{
+  /* Return a double cell.  */
+  SCM cell = SCM_PACK (GC_generic_malloc (2 * sizeof (scm_t_cell),
+                                         smob_gc_kind));
 
-\f
-/* {Initialization for i/o types, float, bignum, the type of free cells}
- */
+  SCM_SET_CELL_WORD_3 (cell, data3);
+  SCM_SET_CELL_WORD_2 (cell, data2);
+  SCM_SET_CELL_WORD_1 (cell, data1);
+  SCM_SET_CELL_WORD_0 (cell, tc);
 
-static int
-free_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED)
+  return cell;
+}
+
+\f
+/* Finalize SMOB by calling its SMOB type's free function, if any.  */
+void
+scm_i_finalize_smob (GC_PTR ptr, GC_PTR data)
 {
-  char buf[100];
+  SCM smob;
+  size_t (* free_smob) (SCM);
 
-  sprintf (buf, "#<freed cell %p; GC missed a reference>",
-          (void *) SCM_UNPACK (exp));
-  scm_puts (buf, port);
+  smob = PTR2SCM (ptr);
+#if 0
+  printf ("finalizing SMOB %p (smobnum: %u)\n",
+         ptr, SCM_SMOBNUM (smob));
+#endif
 
-  return 1;
+  free_smob = scm_smobs[SCM_SMOBNUM (smob)].free;
+  if (free_smob)
+    free_smob (smob);
 }
 
+\f
 void
 scm_smob_prehistory ()
 {
   long i;
   scm_t_bits tc;
 
+  smob_freelist = GC_new_free_list ();
+  smob_gc_kind = GC_new_kind ((void **)smob_freelist,
+                             GC_MAKE_PROC (GC_new_proc (smob_mark), 0),
+                             0,
+                             /* Clear new objects.  As of version 7.1, libgc
+                                doesn't seem to support passing 0 here.  */
+                             1);
+
   scm_numsmob = 0;
   for (i = 0; i < MAX_SMOB_COUNT; ++i)
     {
@@ -547,21 +661,9 @@ scm_smob_prehistory ()
       scm_smobs[i].gsubr_type = 0;
     }
 
-  /* WARNING: These scm_make_smob_type calls must be done in this order */
+  /* WARNING: This scm_make_smob_type call must be done first.  */
   tc = scm_make_smob_type ("free", 0);
   scm_set_smob_print (tc, free_print);
-
-  tc = scm_make_smob_type ("big", 0);  /* freed in gc */
-  scm_set_smob_print (tc, scm_bigprint);
-  scm_set_smob_equalp (tc, scm_bigequal);
-
-  tc = scm_make_smob_type ("real", 0); /* freed in gc */
-  scm_set_smob_print (tc, scm_print_real);
-  scm_set_smob_equalp (tc, scm_real_equalp);
-
-  tc = scm_make_smob_type ("complex", 0);  /* freed in gc */
-  scm_set_smob_print (tc, scm_print_complex);
-  scm_set_smob_equalp (tc, scm_complex_equalp);
 }
 
 /*