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 #include "config.h"
  44 #include "vm/types.h"
  45
  46 #if defined(ENABLE_THREADS)
  47 # include "threads/native/threads.h"
  48 #endif
  49
  50
  51 /* Configuration Switches *****************************************************/
  52
  53 #define GCCONF_FINALIZER
  54 /*#define GCCONF_HDRFLAG_REFERENCING*/
  55
  56
  57 /* Debugging ******************************************************************/
  58
  59 #define GC_DEBUGGING
  60 /*#define GC_DEBUGGING2*/
  61
  62 #if !defined(NDEBUG) && defined(GC_DEBUGGING)
  63 # include <assert.h>
  64 # include "vmcore/options.h"
  65 # define GC_LOG(code) if (opt_verbosegc) { code; }
  66 # define GC_ASSERT(assertion) assert(assertion)
  67 #else
  68 # define GC_LOG(code)
  69 # define GC_ASSERT(assertion)
  70 #endif
  71
  72 #if !defined(NDEBUG) && defined(GC_DEBUGGING2)
  73 # define GC_LOG2(code) GC_LOG(code)
  74 #else
  75 # define GC_LOG2(code)
  76 #endif
  77
  78
  79 /* Development Break **********************************************************/
  80
  81 #if 0 && defined(ENABLE_THREADS)
  82 # error "GC does not work with threads enabled!"
  83 #endif
  84
  85 #if 1 && defined(ENABLE_INTRP)
  86 # error "GC does not work with interpreter enabled!"
  87 #endif
  88
  89 #if 1 && defined(ENABLE_JVMTI)
  90 # error "GC does not work with JVMTI enabled!"
  91 #endif
  92
  93 #if 1 && !defined(ENABLE_REPLACEMENT)
  94 # error "GC does only work with replacement enabled!"
  95 #endif
  96
  97 #if 1 && !defined(__I386__)
  98 # error "GC was only ported to i386 so far!"
  99 #endif
 100
 101
 102 /* Helper Macros **************************************************************/
 103
 104 #define GC_SET_FLAGS(obj, flags)   ((obj)->hdrflags |=  (flags))
 105 #define GC_CLEAR_FLAGS(obj, flags) ((obj)->hdrflags &= ~(flags))
 106 #define GC_TEST_FLAGS(obj, flags)  ((obj)->hdrflags  &  (flags))
 107
 108 #define POINTS_INTO(ptr, ptr_start, ptr_end) \
 109         ((void *) (ptr) >= (ptr_start) && (void *) (ptr) < (ptr_end))
 110
 111
 112 /* Global Variables ***********************************************************/
 113
 114 extern bool gc_pending;
 115 extern bool gc_notify_finalizer;
 116
 117
 118 /* Prototypes *****************************************************************/
 119
 120 #if defined(ENABLE_THREADS)
 121 bool gc_suspend(threadobject *thread, u1 *pc, u1 *sp);
 122 #endif
 123
 124
 125 /* Statistics *****************************************************************/
 126
 127 #if defined(ENABLE_STATISTICS)
 128
 129 #define GCSTAT_INIT(cnt)  { (cnt) = 0; }
 130 #define GCSTAT_COUNT(cnt) { (cnt)++; }
 131 #define GCSTAT_DEC(cnt)   { (cnt)--; GC_ASSERT((cnt) >= 0); }
 132 #define GCSTAT_COUNT_MAX(cnt,max) { (cnt)++; if ((cnt) > (max)) (max) = (cnt); }
 133
 134 extern int gcstat_mark_depth;
 135 extern int gcstat_mark_depth_max;
 136 extern int gcstat_mark_count;
 137
 138 void gcstat_println();
 139
 140 #endif /* defined(ENABLE_STATISTICS) */
 141
 142
 143 #endif /* _GC_H */
 144
 145 /*
 146  * These are local overrides for various environment variables in Emacs.
 147  * Please do not remove this and leave it at the end of the file, where
 148  * Emacs will automagically detect them.
 149  * ---------------------------------------------------------------------
 150  * Local variables:
 151  * mode: c
 152  * indent-tabs-mode: t
 153  * c-basic-offset: 4
 154  * tab-width: 4
 155  * End:
 156  * vim:noexpandtab:sw=4:ts=4:
 157  */