src/mm/gc-common.h

   1 /* src/mm/gc-common.h - gc independant interface for heap managment
   2
   3    Copyright (C) 1996-2005, 2006, 2007 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 */
  26
  27
  28 #ifndef _GC_COMMON_H
  29 #define _GC_COMMON_H
  30
  31 #include "config.h"
  32 #include "vm/types.h"
  33
  34 #include "vm/global.h"
  35
  36 #include "vmcore/method.h"
  37
  38
  39 /* reference types ************************************************************/
  40
  41 #define GC_REFTYPE_THREADOBJECT  1
  42 #define GC_REFTYPE_CLASSLOADER   2
  43 #define GC_REFTYPE_JNI_GLOBALREF 3
  44 #define GC_REFTYPE_FINALIZER     4
  45 #define GC_REFTYPE_LOCALREF      5
  46 #define GC_REFTYPE_STACK         6
  47 #define GC_REFTYPE_CLASSREF      7
  48
  49
  50 /* function prototypes ********************************************************/
  51
  52 void  gc_init(u4 heapmaxsize, u4 heapstartsize);
  53
  54 void *heap_alloc_uncollectable(u4 size);
  55 void *heap_alloc(u4 size, u4 references, methodinfo *finalizer, bool collect);
  56 void  heap_free(void *p);
  57
  58 #if defined(ENABLE_GC_CACAO)
  59 void  heap_init_objectheader(java_object_t *o, u4 size);
  60 s4    heap_get_hashcode(java_object_t *o);
  61
  62 void  gc_reference_register(java_object_t **ref, int32_t reftype);
  63 void  gc_reference_unregister(java_object_t **ref);
  64 #endif
  65
  66 void  gc_call(void);
  67 s8    gc_get_heap_size(void);
  68 s8    gc_get_free_bytes(void);
  69 s8    gc_get_total_bytes(void);
  70 s8    gc_get_max_heap_size(void);
  71 void  gc_invoke_finalizers(void);
  72 void  gc_finalize_all(void);
  73 void *gc_out_of_memory(size_t bytes_requested);
  74
  75 #endif /* _GC_COMMON_H */
  76
  77
  78 /*
  79  * These are local overrides for various environment variables in Emacs.
  80  * Please do not remove this and leave it at the end of the file, where
  81  * Emacs will automagically detect them.
  82  * ---------------------------------------------------------------------
  83  * Local variables:
  84  * mode: c
  85  * indent-tabs-mode: t
  86  * c-basic-offset: 4
  87  * tab-width: 4
  88  * End:
  89  */