src/mm/cacao-gc/gc.h

   1 /* src/mm/cacao-gc/gc.h - main garbage collector header
   2
   3    Copyright (C) 2006 R. Grafl, A. Krall, C. Kruegel,
   4    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
   5    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
   6    J. Wenninger, Institut f. Computersprachen - TU Wien
   7
   8    This file is part of CACAO.
   9
  10    This program is free software; you can redistribute it and/or
  11    modify it under the terms of the GNU General Public License as
  12    published by the Free Software Foundation; either version 2, or (at
  13    your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful, but
  16    WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18    General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23    02110-1301, USA.
  24
  25    Contact: cacao@cacaojvm.org
  26
  27    Authors: Michael Starzinger
  28
  29    $Id$
  30
  31 */
  32
  33
  34 #ifdef GC_CONST
  35 # error Why is the BoehmGC header included???
  36 #endif
  37
  38
  39 #ifndef _GC_H
  40 #define _GC_H
  41
  42
  43 /* Configuration Switches *****************************************************/
  44
  45 /*#define GCCONF_FINALIZER*/
  46
  47
  48 /* Debugging ******************************************************************/
  49
  50 #define GC_DEBUGGING
  51 /*#define GC_DEBUGGING2*/
  52
  53 #if !defined(NDEBUG) && defined(GC_DEBUGGING)
  54 # include <assert.h>
  55 # include "vmcore/options.h"
  56 # define GC_LOG(code) if (opt_verbosegc) { code; }
  57 # define GC_ASSERT(assertion) assert(assertion)
  58 #else
  59 # define GC_LOG(code)
  60 # define GC_ASSERT(assertion)
  61 #endif
  62
  63 #if !defined(NDEBUG) && defined(GC_DEBUGGING2)
  64 # define GC_LOG2(code) GC_LOG(code)
  65 #else
  66 # define GC_LOG2(code)
  67 #endif
  68
  69
  70 /* Development Break **********************************************************/
  71
  72 #if 0 && defined(ENABLE_THREADS)
  73 # error "GC does not work with threads enabled!"
  74 #endif
  75
  76 #if 1 && defined(ENABLE_INTRP)
  77 # error "GC does not work with interpreter enabled!"
  78 #endif
  79
  80 #if 1 && defined(ENABLE_JVMTI)
  81 # error "GC does not work with JVMTI enabled!"
  82 #endif
  83
  84 #if 1 && !defined(ENABLE_REPLACEMENT)
  85 # error "GC does only work with replacement enabled!"
  86 #endif
  87
  88 #if 1 && !defined(__I386__)
  89 # error "GC was only ported to i386 so far!"
  90 #endif
  91
  92
  93 /* Helper Macros **************************************************************/
  94
  95 #define GC_SET_FLAGS(obj, flags)   ((obj)->hdrflags |=  (flags))
  96 #define GC_CLEAR_FLAGS(obj, flags) ((obj)->hdrflags &= ~(flags))
  97 #define GC_TEST_FLAGS(obj, flags)  ((obj)->hdrflags  &  (flags))
  98
  99 #define POINTS_INTO(ptr, ptr_start, ptr_end) \
 100         ((void *) (ptr) > (ptr_start) && (void *) (ptr) < (ptr_end))
 101
 102
 103 /* Global Variables ***********************************************************/
 104
 105 extern bool gc_notify_finalizer;
 106
 107
 108 /* Statistics *****************************************************************/
 109
 110 #if defined(ENABLE_STATISTICS)
 111
 112 #define GCSTAT_INIT(cnt)  { (cnt) = 0; }
 113 #define GCSTAT_COUNT(cnt) { (cnt)++; }
 114 #define GCSTAT_DEC(cnt)   { (cnt)--; GC_ASSERT((cnt) >= 0); }
 115 #define GCSTAT_COUNT_MAX(cnt,max) { (cnt)++; if ((cnt) > (max)) (max) = (cnt); }
 116
 117 extern int gcstat_mark_depth;
 118 extern int gcstat_mark_depth_max;
 119 extern int gcstat_mark_count;
 120
 121 void gcstat_println();
 122
 123 #endif /* defined(ENABLE_STATISTICS) */
 124
 125
 126 #endif /* _GC_H */
 127
 128 /*
 129  * These are local overrides for various environment variables in Emacs.
 130  * Please do not remove this and leave it at the end of the file, where
 131  * Emacs will automagically detect them.
 132  * ---------------------------------------------------------------------
 133  * Local variables:
 134  * mode: c
 135  * indent-tabs-mode: t
 136  * c-basic-offset: 4
 137  * tab-width: 4
 138  * End:
 139  * vim:noexpandtab:sw=4:ts=4:
 140  */