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