src/mm/boehm.c

   1 /* src/mm/boehm.c - interface for boehm gc
   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    $Id: boehm.c 8242 2007-07-31 08:45:35Z twisti $
  26
  27 */
  28
  29
  30 #include "config.h"
  31 #include "vm/types.h"
  32
  33 #if defined(ENABLE_THREADS) && defined(__LINUX__)
  34 #define GC_LINUX_THREADS
  35 #endif
  36 #if defined(ENABLE_THREADS) && defined(__IRIX__)
  37 #define GC_IRIX_THREADS
  38 #endif
  39
  40 #include "boehm-gc/include/gc.h"
  41 #include "mm/gc-common.h"
  42 #include "mm/memory.h"
  43
  44 #include "toolbox/logging.h"
  45
  46 #include "vm/builtin.h"
  47 #include "vm/exceptions.h"
  48 #include "vm/finalizer.h"
  49 #include "vm/global.h"
  50 #include "vm/stringlocal.h"
  51 #include "vm/vm.h"
  52
  53 #include "vmcore/loader.h"
  54 #include "vmcore/options.h"
  55
  56
  57 /* global variables ***********************************************************/
  58
  59 static bool in_gc_out_of_memory = false;    /* is GC out of memory?           */
  60
  61
  62 /* prototype static functions *************************************************/
  63
  64 static void gc_ignore_warnings(char *msg, GC_word arg);
  65
  66
  67 /* gc_init *********************************************************************
  68
  69    Initializes the boehm garbage collector.
  70
  71 *******************************************************************************/
  72
  73 void gc_init(u4 heapmaxsize, u4 heapstartsize)
  74 {
  75         size_t heapcurrentsize;
  76
  77         /* just to be sure (should be set to 1 by JAVA_FINALIZATION macro) */
  78
  79         GC_java_finalization = 1;
  80
  81         /* Ignore pointers that do not point to the start of an object. */
  82
  83         GC_all_interior_pointers = 0;
  84
  85         /* suppress warnings */
  86
  87         GC_set_warn_proc(gc_ignore_warnings);
  88
  89         /* install a GC notifier */
  90
  91         GC_finalize_on_demand = 1;
  92         GC_finalizer_notifier = finalizer_notify;
  93
  94         /* define OOM function */
  95
  96         GC_oom_fn = gc_out_of_memory;
  97
  98         GC_INIT();
  99
 100         /* set the maximal heap size */
 101
 102         GC_set_max_heap_size(heapmaxsize);
 103
 104         /* set the initial heap size */
 105
 106         heapcurrentsize = GC_get_heap_size();
 107
 108         if (heapstartsize > heapcurrentsize)
 109                 GC_expand_hp(heapstartsize - heapcurrentsize);
 110 }
 111
 112
 113 static void gc_ignore_warnings(char *msg, GC_word arg)
 114 {
 115 }
 116
 117
 118 void *heap_alloc_uncollectable(u4 bytelength)
 119 {
 120         void *p;
 121
 122         p = GC_MALLOC_UNCOLLECTABLE(bytelength);
 123
 124         /* clear allocated memory region */
 125
 126         MSET(p, 0, u1, bytelength);
 127
 128         return p;
 129 }
 130
 131
 132 /* heap_allocate ***************************************************************
 133
 134    Allocates memory on the Java heap.
 135
 136 *******************************************************************************/
 137
 138 void *heap_allocate(u4 bytelength, u4 references, methodinfo *finalizer)
 139 {
 140         void *p;
 141
 142         /* We can't use a bool here for references, as it's passed as a
 143            bitmask in builtin_new.  Thus we check for != 0. */
 144
 145         if (references != 0)
 146                 p = GC_MALLOC(bytelength);
 147         else
 148                 p = GC_MALLOC_ATOMIC(bytelength);
 149
 150         if (p == NULL)
 151                 return NULL;
 152
 153         if (finalizer != NULL)
 154                 GC_REGISTER_FINALIZER_NO_ORDER(p, finalizer_run, 0, 0, 0);
 155
 156         /* clear allocated memory region */
 157
 158         MSET(p, 0, u1, bytelength);
 159
 160         return p;
 161 }
 162
 163
 164 void heap_free(void *p)
 165 {
 166         GC_FREE(p);
 167 }
 168
 169 void gc_call(void)
 170 {
 171         if (opt_verbosegc)
 172                 dolog("Garbage Collection:  previous/now = %d / %d ",
 173                           0, 0);
 174
 175         GC_gcollect();
 176 }
 177
 178
 179 s8 gc_get_heap_size(void)
 180 {
 181         return GC_get_heap_size();
 182 }
 183
 184
 185 s8 gc_get_free_bytes(void)
 186 {
 187         return GC_get_free_bytes();
 188 }
 189
 190
 191 /* gc_get_total_bytes **********************************************************
 192
 193    Returns the number of total bytes currently used on the Java heap.
 194
 195 *******************************************************************************/
 196
 197 s8 gc_get_total_bytes(void)
 198 {
 199         return GC_get_total_bytes();
 200 }
 201
 202
 203 s8 gc_get_max_heap_size(void)
 204 {
 205         return GC_get_max_heap_size();
 206 }
 207
 208
 209 void gc_invoke_finalizers(void)
 210 {
 211         GC_invoke_finalizers();
 212 }
 213
 214
 215 void gc_finalize_all(void)
 216 {
 217         GC_finalize_all();
 218 }
 219
 220
 221 /* gc_out_of_memory ************************************************************
 222
 223    This function is called when boehm detects that it is OOM.
 224
 225 *******************************************************************************/
 226
 227 void *gc_out_of_memory(size_t bytes_requested)
 228 {
 229         /* if this happens, we are REALLY out of memory */
 230
 231         if (in_gc_out_of_memory) {
 232                 /* this is all we can do... */
 233                 vm_abort("gc_out_of_memory: out of memory");
 234         }
 235
 236         in_gc_out_of_memory = true;
 237
 238         /* try to release some memory */
 239
 240         gc_call();
 241
 242         /* now instantiate the exception */
 243
 244         exceptions_throw_outofmemoryerror();
 245
 246         in_gc_out_of_memory = false;
 247
 248         return NULL;
 249 }
 250
 251
 252 /*
 253  * These are local overrides for various environment variables in Emacs.
 254  * Please do not remove this and leave it at the end of the file, where
 255  * Emacs will automagically detect them.
 256  * ---------------------------------------------------------------------
 257  * Local variables:
 258  * mode: c
 259  * indent-tabs-mode: t
 260  * c-basic-offset: 4
 261  * tab-width: 4
 262  * End:
 263  */