Upgrade Boehm GC to 7.2alpha4.

[cacao.git] / src / mm / boehm-gc / include / gc_backptr.h

diff --git a/src/mm/boehm-gc/include/gc_backptr.h b/src/mm/boehm-gc/include/gc_backptr.h
index 5899496e0fe59db1065ca13d3b681abffdba8499..6256f41668944307622c1d8aaf802215ed4c2a71 100644 (file)
--- a/src/mm/boehm-gc/include/gc_backptr.h
+++ b/src/mm/boehm-gc/include/gc_backptr.h
@@ -1,3 +1,20 @@
+/*
+ * Copyright (c) 1994 by Xerox Corporation.  All rights reserved.
+ * Copyright (c) 1996 by Silicon Graphics.  All rights reserved.
+ * Copyright (c) 1998 by Fergus Henderson.  All rights reserved.
+ * Copyright (c) 2000-2009 by Hewlett-Packard Development Company.
+ * All rights reserved.
+ *
+ * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
+ * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
+ *
+ * Permission is hereby granted to use or copy this program
+ * for any purpose,  provided the above notices are retained on all copies.
+ * Permission to modify the code and to distribute modified code is granted,
+ * provided the above notices are retained, and a notice that the code was
+ * modified is included with the above copyright notice.
+ */
+
 /*
  * This is a simple API to implement pointer back tracing, i.e.
  * to answer questions such as "who is pointing to this" or
@@ -22,44 +39,60 @@
 
 #ifndef GC_BACKPTR_H
 #define GC_BACKPTR_H
+
+#ifndef GC_H
+# include "gc.h"
+#endif
+
+#ifdef __cplusplus
+  extern "C" {
+#endif
+
 /* Store information about the object referencing dest in *base_p     */
 /* and *offset_p.                                                     */
-/* If multiple objects or roots point to dest, the one reported              */
+/* If multiple objects or roots point to dest, the one reported       */
 /* will be the last on used by the garbage collector to trace the     */
-/* object.                                                           */
-/*   source is root ==> *base_p = address, *offset_p = 0             */
+/* object.                                                            */
+/*   source is root ==> *base_p = address, *offset_p = 0              */
 /*   source is heap object ==> *base_p != 0, *offset_p = offset       */
 /*   Returns 1 on success, 0 if source couldn't be determined.        */
 /* Dest can be any address within a heap object.                      */
-typedef enum {  GC_UNREFERENCED, /* No reference info available.       */
-               GC_NO_SPACE,    /* Dest not allocated with debug alloc  */
-               GC_REFD_FROM_ROOT, /* Referenced directly by root *base_p */
-               GC_REFD_FROM_REG,  /* Referenced from a register, i.e.  */
-                                  /* a root without an address.        */
-               GC_REFD_FROM_HEAP, /* Referenced from another heap obj. */
-               GC_FINALIZER_REFD /* Finalizable and hence accessible.  */
+typedef enum {
+    GC_UNREFERENCED,    /* No reference info available.         */
+    GC_NO_SPACE,        /* Dest not allocated with debug alloc. */
+    GC_REFD_FROM_ROOT,  /* Referenced directly by root *base_p. */
+    GC_REFD_FROM_REG,   /* Referenced from a register, i.e.     */
+                        /* a root without an address.           */
+    GC_REFD_FROM_HEAP,  /* Referenced from another heap obj.    */
+    GC_FINALIZER_REFD   /* Finalizable and hence accessible.    */
 } GC_ref_kind;
 
-GC_ref_kind GC_get_back_ptr_info(void *dest, void **base_p, size_t *offset_p);
+GC_API GC_ref_kind GC_CALL GC_get_back_ptr_info(void * /* dest */,
+                                                void ** /* base_p */,
+                                                size_t * /* offset_p */);
 
 /* Generate a random heap address.            */
 /* The resulting address is in the heap, but  */
 /* not necessarily inside a valid object.     */
-void * GC_generate_random_heap_address(void);
+GC_API void * GC_CALL GC_generate_random_heap_address(void);
 
 /* Generate a random address inside a valid marked heap object. */
-void * GC_generate_random_valid_address(void);
+GC_API void * GC_CALL GC_generate_random_valid_address(void);
+
+/* Force a garbage collection and generate a backtrace from a   */
+/* random heap address.                                         */
+/* This uses the GC logging mechanism (GC_printf) to produce    */
+/* output.  It can often be called from a debugger.  The        */
+/* source in dbg_mlc.c also serves as a sample client.          */
+GC_API void GC_CALL GC_generate_random_backtrace(void);
 
-/* Force a garbage collection and generate a backtrace from a */
-/* random heap address.                                       */
-/* This uses the GC logging mechanism (GC_printf) to produce  */
-/* output.  It can often be called from a debugger.  The      */
-/* source in dbg_mlc.c also serves as a sample client.       */
-void GC_generate_random_backtrace(void);
+/* Print a backtrace from a specific address.  Used by the      */
+/* above.  The client should call GC_gcollect() immediately     */
+/* before invocation.                                           */
+GC_API void GC_CALL GC_print_backtrace(void *);
 
-/* Print a backtrace from a specific address.  Used by the     */
-/* above.  The client should call GC_gcollect() immediately    */
-/* before invocation.                                          */
-void GC_print_backtrace(void *);
+#ifdef __cplusplus
+  } /* end of extern "C" */
+#endif
 
 #endif /* GC_BACKPTR_H */