Upgrade Boehm GC to 7.2alpha4.
[cacao.git] / src / mm / boehm-gc / include / gc_gcj.h
index 9bce311d539cb3729e4e5ef230af99fb50269500..78658785d8557aa127f885ac2b6a80f46ffa971a 100644 (file)
@@ -1,4 +1,4 @@
-/* 
+/*
  * Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
  * Copyright (c) 1991-1995 by Xerox Corporation.  All rights reserved.
  * Copyright 1996-1999 by Silicon Graphics.  All rights reserved.
  */
 
 #ifndef GC_GCJ_H
-
 #define GC_GCJ_H
 
-       /* Gcj keeps GC descriptor as second word of vtable.    This    */
-       /* probably needs to be adjusted for other clients.             */
-       /* We currently assume that this offset is such that:           */
-       /*      - all objects of this kind are large enough to have     */
-       /*        a value at that offset, and                           */
-       /*      - it is not zero.                                       */
-       /* These assumptions allow objects on the free list to be       */
-       /* marked normally.                                             */
-
-#ifndef _GC_H
-#   include "gc.h"
+        /* Gcj keeps GC descriptor as second word of vtable.    This    */
+        /* probably needs to be adjusted for other clients.             */
+        /* We currently assume that this offset is such that:           */
+        /*      - all objects of this kind are large enough to have     */
+        /*        a value at that offset, and                           */
+        /*      - it is not zero.                                       */
+        /* These assumptions allow objects on the free list to be       */
+        /* marked normally.                                             */
+
+#ifndef GC_H
+# include "gc.h"
 #endif
 
-# ifdef __cplusplus
-    extern "C" {
-# endif
+#ifdef __cplusplus
+  extern "C" {
+#endif
 
-/* The following allocators signal an out of memory condition with     */
-/* return GC_oom_fn(bytes);                                            */
+/* The following allocators signal an out of memory condition with      */
+/* return GC_oom_fn(bytes);                                             */
 
-/* The following function must be called before the gcj allocators     */
-/* can be invoked.                                                     */
-/* mp_index and mp are the index and mark_proc (see gc_mark.h)         */
-/* respectively for the allocated objects.  Mark_proc will be          */
-/* used to build the descriptor for objects allocated through the      */
-/* debugging interface.  The mark_proc will be invoked on all such     */
-/* objects with an "environment" value of 1.  The client may choose    */
+/* The following function must be called before the gcj allocators      */
+/* can be invoked.                                                      */
+/* mp_index and mp are the index and mark_proc (see gc_mark.h)          */
+/* respectively for the allocated objects.  Mark_proc will be           */
+/* used to build the descriptor for objects allocated through the       */
+/* debugging interface.  The mark_proc will be invoked on all such      */
+/* objects with an "environment" value of 1.  The client may choose     */
 /* to use the same mark_proc for some of its generated mark descriptors.*/
-/* In that case, it should use a different "environment" value to      */
-/* detect the presence or absence of the debug header.                 */
-/* Mp is really of type mark_proc, as defined in gc_mark.h.  We don't  */
-/* want to include that here for namespace pollution reasons.          */
-/* Passing in mp_index here instead of having GC_init_gcj_malloc()     */
-/* internally call GC_new_proc() is quite ugly, but in typical usage   */
-/* scenarios a compiler also has to know about mp_index, so            */
-/* generating it dynamically is not acceptable.  Mp_index will         */
-/* typically be an integer < RESERVED_MARK_PROCS, so that it doesn't   */
-/* collide with GC_new_proc allocated indices.  If the application     */
-/* needs no other reserved indices, zero                               */
-/* (GC_GCJ_RESERVED_MARK_PROC_INDEX in gc_mark.h) is an obvious choice.        */ 
-GC_API void GC_CALL GC_init_gcj_malloc(int mp_index,
-                               void * /* really mark_proc */mp);
-
-/* Allocate an object, clear it, and store the pointer to the  */
-/* type structure (vtable in gcj).                             */
+/* In that case, it should use a different "environment" value to       */
+/* detect the presence or absence of the debug header.                  */
+/* Mp is really of type mark_proc, as defined in gc_mark.h.  We don't   */
+/* want to include that here for namespace pollution reasons.           */
+/* Passing in mp_index here instead of having GC_init_gcj_malloc()      */
+/* internally call GC_new_proc() is quite ugly, but in typical usage    */
+/* scenarios a compiler also has to know about mp_index, so             */
+/* generating it dynamically is not acceptable.  Mp_index will          */
+/* typically be an integer < RESERVED_MARK_PROCS, so that it doesn't    */
+/* collide with GC_new_proc allocated indices.  If the application      */
+/* needs no other reserved indices, zero                                */
+/* (GC_GCJ_RESERVED_MARK_PROC_INDEX in gc_mark.h) is an obvious choice. */
+GC_API void GC_CALL GC_init_gcj_malloc(int /* mp_index */,
+                                void * /* really mark_proc */ /* mp */);
+
+/* Allocate an object, clear it, and store the pointer to the   */
+/* type structure (vtable in gcj).                              */
 /* This adds a byte at the end of the object if GC_malloc would.*/
-GC_API void * GC_CALL GC_gcj_malloc(size_t lb,
-                               void * ptr_to_struct_containing_descr);
-/* The debug versions allocate such that the specified mark_proc       */
-/* is always invoked.                                                  */
-GC_API void * GC_CALL GC_debug_gcj_malloc(size_t lb,
-                                 void * ptr_to_struct_containing_descr,
-                                 GC_EXTRA_PARAMS);
-
-/* Similar to GC_gcj_malloc, but assumes that a pointer to near the    */
-/* beginning of the resulting object is always maintained.             */
-GC_API void  * GC_CALL GC_gcj_malloc_ignore_off_page(size_t lb,
-                               void * ptr_to_struct_containing_descr);
-
-/* The kind numbers of normal and debug gcj objects.           */
-/* Useful only for debug support, we hope.                     */
+GC_API void * GC_CALL GC_gcj_malloc(size_t /* lb */,
+                                void * /* ptr_to_struct_containing_descr */)
+                        GC_ATTR_MALLOC GC_ATTR_ALLOC_SIZE(1);
+/* The debug versions allocate such that the specified mark_proc        */
+/* is always invoked.                                                   */
+GC_API void * GC_CALL GC_debug_gcj_malloc(size_t /* lb */,
+                                  void * /* ptr_to_struct_containing_descr */,
+                                  GC_EXTRA_PARAMS)
+                        GC_ATTR_MALLOC GC_ATTR_ALLOC_SIZE(1);
+
+/* Similar to GC_gcj_malloc, but assumes that a pointer to near the     */
+/* beginning of the resulting object is always maintained.              */
+GC_API void  * GC_CALL GC_gcj_malloc_ignore_off_page(size_t /* lb */,
+                                void * /* ptr_to_struct_containing_descr */)
+                        GC_ATTR_MALLOC GC_ATTR_ALLOC_SIZE(1);
+
+/* The kind numbers of normal and debug gcj objects.            */
+/* Useful only for debug support, we hope.                      */
 GC_API int GC_gcj_kind;
 
 GC_API int GC_gcj_debug_kind;
 
-# ifdef GC_DEBUG
-#   define GC_GCJ_MALLOC(s,d) GC_debug_gcj_malloc(s,d,GC_EXTRAS)
-#   define GC_GCJ_MALLOC_IGNORE_OFF_PAGE(s,d) GC_debug_gcj_malloc(s,d,GC_EXTRAS)
-# else
-#   define GC_GCJ_MALLOC(s,d) GC_gcj_malloc(s,d)
-#   define GC_GCJ_MALLOC_IGNORE_OFF_PAGE(s,d) \
-       GC_gcj_malloc_ignore_off_page(s,d)
-# endif
+#ifdef GC_DEBUG
+# define GC_GCJ_MALLOC(s,d) GC_debug_gcj_malloc(s,d,GC_EXTRAS)
+# define GC_GCJ_MALLOC_IGNORE_OFF_PAGE(s,d) GC_debug_gcj_malloc(s,d,GC_EXTRAS)
+#else
+# define GC_GCJ_MALLOC(s,d) GC_gcj_malloc(s,d)
+# define GC_GCJ_MALLOC_IGNORE_OFF_PAGE(s,d) GC_gcj_malloc_ignore_off_page(s,d)
+#endif
 
-# ifdef __cplusplus
-    }  /* end of extern "C" */
-# endif
+#ifdef __cplusplus
+  } /* end of extern "C" */
+#endif
 
 #endif /* GC_GCJ_H */