granicus.if.org Git - gc/blob - gcj_mlc.c

   1 /*
   2  * Copyright (c) 1991-1994 by Xerox Corporation.  All rights reserved.
   3  * Copyright (c) 1999-2004 Hewlett-Packard Development Company, L.P.
   4  *
   5  * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
   6  * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
   7  *
   8  * Permission is hereby granted to use or copy this program
   9  * for any purpose,  provided the above notices are retained on all copies.
  10  * Permission to modify the code and to distribute modified code is granted,
  11  * provided the above notices are retained, and a notice that the code was
  12  * modified is included with the above copyright notice.
  13  *
  14  */
  15
  16 #include "private/gc_pmark.h"  /* includes gc_priv.h */
  17
  18 #ifdef GC_GCJ_SUPPORT
  19
  20 /*
  21  * This is an allocator interface tuned for gcj (the GNU static
  22  * java compiler).
  23  *
  24  * Each allocated object has a pointer in its first word to a vtable,
  25  * which for our purposes is simply a structure describing the type of
  26  * the object.
  27  * This descriptor structure contains a GC marking descriptor at offset
  28  * MARK_DESCR_OFFSET.
  29  *
  30  * It is hoped that this interface may also be useful for other systems,
  31  * possibly with some tuning of the constants.  But the immediate goal
  32  * is to get better gcj performance.
  33  *
  34  * We assume:
  35  *  1) Counting on explicit initialization of this interface is OK;
  36  *  2) FASTLOCK is not a significant win.
  37  */
  38
  39 #include "gc_gcj.h"
  40 #include "private/dbg_mlc.h"
  41
  42 #ifdef GC_ASSERTIONS
  43   GC_INNER /* variable is also used in thread_local_alloc.c */
  44 #else
  45   STATIC
  46 #endif
  47 GC_bool GC_gcj_malloc_initialized = FALSE;
  48
  49 int GC_gcj_kind = 0;    /* Object kind for objects with descriptors     */
  50                         /* in "vtable".                                 */
  51 int GC_gcj_debug_kind = 0;
  52                         /* The kind of objects that is always marked    */
  53                         /* with a mark proc call.                       */
  54
  55 GC_INNER ptr_t * GC_gcjobjfreelist = NULL;
  56
  57 STATIC struct GC_ms_entry * GC_gcj_fake_mark_proc(word * addr GC_ATTR_UNUSED,
  58                         struct GC_ms_entry *mark_stack_ptr,
  59                         struct GC_ms_entry * mark_stack_limit GC_ATTR_UNUSED,
  60                         word env GC_ATTR_UNUSED)
  61 {
  62     ABORT_RET("No client gcj mark proc is specified");
  63     return mark_stack_ptr;
  64 }
  65
  66 /* Caller does not hold allocation lock. */
  67 GC_API void GC_CALL GC_init_gcj_malloc(int mp_index,
  68                                        void * /* really GC_mark_proc */mp)
  69 {
  70 #   ifndef GC_IGNORE_GCJ_INFO
  71       GC_bool ignore_gcj_info;
  72 #   endif
  73     DCL_LOCK_STATE;
  74
  75     if (mp == 0)        /* In case GC_DS_PROC is unused.        */
  76       mp = (void *)(word)GC_gcj_fake_mark_proc;
  77
  78     GC_init();  /* In case it's not already done.       */
  79     LOCK();
  80     if (GC_gcj_malloc_initialized) {
  81       UNLOCK();
  82       return;
  83     }
  84     GC_gcj_malloc_initialized = TRUE;
  85 #   ifdef GC_IGNORE_GCJ_INFO
  86       /* This is useful for debugging on platforms with missing getenv(). */
  87 #     define ignore_gcj_info TRUE
  88 #   else
  89       ignore_gcj_info = (0 != GETENV("GC_IGNORE_GCJ_INFO"));
  90 #   endif
  91     if (ignore_gcj_info) {
  92       GC_COND_LOG_PRINTF("Gcj-style type information is disabled!\n");
  93     }
  94     GC_ASSERT(GC_mark_procs[mp_index] == (GC_mark_proc)0); /* unused */
  95     GC_mark_procs[mp_index] = (GC_mark_proc)(word)mp;
  96     if ((unsigned)mp_index >= GC_n_mark_procs)
  97         ABORT("GC_init_gcj_malloc: bad index");
  98     /* Set up object kind gcj-style indirect descriptor. */
  99       GC_gcjobjfreelist = (ptr_t *)GC_new_free_list_inner();
 100       if (ignore_gcj_info) {
 101         /* Use a simple length-based descriptor, thus forcing a fully   */
 102         /* conservative scan.                                           */
 103         GC_gcj_kind = GC_new_kind_inner((void **)GC_gcjobjfreelist,
 104                                         /* 0 | */ GC_DS_LENGTH,
 105                                         TRUE, TRUE);
 106       } else {
 107         GC_gcj_kind = GC_new_kind_inner(
 108                         (void **)GC_gcjobjfreelist,
 109                         (((word)(-(signed_word)MARK_DESCR_OFFSET
 110                                  - GC_INDIR_PER_OBJ_BIAS))
 111                          | GC_DS_PER_OBJECT),
 112                         FALSE, TRUE);
 113       }
 114     /* Set up object kind for objects that require mark proc call.      */
 115       if (ignore_gcj_info) {
 116         GC_gcj_debug_kind = GC_gcj_kind;
 117       } else {
 118         GC_gcj_debug_kind = GC_new_kind_inner(GC_new_free_list_inner(),
 119                                 GC_MAKE_PROC(mp_index,
 120                                              1 /* allocated with debug info */),
 121                                 FALSE, TRUE);
 122       }
 123     UNLOCK();
 124 #   undef ignore_gcj_info
 125 }
 126
 127 #define GENERAL_MALLOC_INNER(lb,k) \
 128     GC_clear_stack(GC_generic_malloc_inner(lb, k))
 129
 130 #define GENERAL_MALLOC_INNER_IOP(lb,k) \
 131     GC_clear_stack(GC_generic_malloc_inner_ignore_off_page(lb, k))
 132
 133 /* We need a mechanism to release the lock and invoke finalizers.       */
 134 /* We don't really have an opportunity to do this on a rarely executed  */
 135 /* path on which the lock is not held.  Thus we check at a              */
 136 /* rarely executed point at which it is safe to release the lock.       */
 137 /* We do this even where we could just call GC_INVOKE_FINALIZERS,       */
 138 /* since it's probably cheaper and certainly more uniform.              */
 139 /* TODO: Consider doing the same elsewhere? */
 140 static void maybe_finalize(void)
 141 {
 142    static word last_finalized_no = 0;
 143    DCL_LOCK_STATE;
 144
 145    if (GC_gc_no == last_finalized_no ||
 146        !EXPECT(GC_is_initialized, TRUE)) return;
 147    UNLOCK();
 148    GC_INVOKE_FINALIZERS();
 149    LOCK();
 150    last_finalized_no = GC_gc_no;
 151 }
 152
 153 /* Allocate an object, clear it, and store the pointer to the   */
 154 /* type structure (vtable in gcj).                              */
 155 /* This adds a byte at the end of the object if GC_malloc would.*/
 156 #ifdef THREAD_LOCAL_ALLOC
 157   GC_INNER void * GC_core_gcj_malloc(size_t lb,
 158                                      void * ptr_to_struct_containing_descr)
 159 #else
 160   GC_API GC_ATTR_MALLOC void * GC_CALL GC_gcj_malloc(size_t lb,
 161                                       void * ptr_to_struct_containing_descr)
 162 #endif
 163 {
 164     ptr_t op;
 165     DCL_LOCK_STATE;
 166
 167     GC_DBG_COLLECT_AT_MALLOC(lb);
 168     if(SMALL_OBJ(lb)) {
 169         word lg;
 170
 171         LOCK();
 172         lg = GC_size_map[lb];
 173         op = GC_gcjobjfreelist[lg];
 174         if(EXPECT(0 == op, FALSE)) {
 175             maybe_finalize();
 176             op = (ptr_t)GENERAL_MALLOC_INNER((word)lb, GC_gcj_kind);
 177             if (0 == op) {
 178                 GC_oom_func oom_fn = GC_oom_fn;
 179                 UNLOCK();
 180                 return((*oom_fn)(lb));
 181             }
 182         } else {
 183             GC_gcjobjfreelist[lg] = (ptr_t)obj_link(op);
 184             GC_bytes_allocd += GRANULES_TO_BYTES((word)lg);
 185         }
 186         GC_ASSERT(((void **)op)[1] == 0);
 187     } else {
 188         LOCK();
 189         maybe_finalize();
 190         op = (ptr_t)GENERAL_MALLOC_INNER((word)lb, GC_gcj_kind);
 191         if (0 == op) {
 192             GC_oom_func oom_fn = GC_oom_fn;
 193             UNLOCK();
 194             return((*oom_fn)(lb));
 195         }
 196     }
 197     *(void **)op = ptr_to_struct_containing_descr;
 198     UNLOCK();
 199     GC_dirty(op);
 200     REACHABLE_AFTER_DIRTY(ptr_to_struct_containing_descr);
 201     return (void *)op;
 202 }
 203
 204 /* Similar to GC_gcj_malloc, but add debug info.  This is allocated     */
 205 /* with GC_gcj_debug_kind.                                              */
 206 GC_API GC_ATTR_MALLOC void * GC_CALL GC_debug_gcj_malloc(size_t lb,
 207                 void * ptr_to_struct_containing_descr, GC_EXTRA_PARAMS)
 208 {
 209     void * result;
 210     DCL_LOCK_STATE;
 211
 212     /* We're careful to avoid extra calls, which could          */
 213     /* confuse the backtrace.                                   */
 214     LOCK();
 215     maybe_finalize();
 216     result = GC_generic_malloc_inner(SIZET_SAT_ADD(lb, DEBUG_BYTES),
 217                                      GC_gcj_debug_kind);
 218     if (result == 0) {
 219         GC_oom_func oom_fn = GC_oom_fn;
 220         UNLOCK();
 221         GC_err_printf("GC_debug_gcj_malloc(%lu, %p) returning NULL (%s:%d)\n",
 222                 (unsigned long)lb, ptr_to_struct_containing_descr, s, i);
 223         return((*oom_fn)(lb));
 224     }
 225     *((void **)((ptr_t)result + sizeof(oh))) = ptr_to_struct_containing_descr;
 226     if (!GC_debugging_started) {
 227         GC_start_debugging_inner();
 228     }
 229     ADD_CALL_CHAIN(result, ra);
 230     result = GC_store_debug_info_inner(result, (word)lb, s, i);
 231     UNLOCK();
 232     GC_dirty(result);
 233     REACHABLE_AFTER_DIRTY(ptr_to_struct_containing_descr);
 234     return result;
 235 }
 236
 237 /* There is no THREAD_LOCAL_ALLOC for GC_gcj_malloc_ignore_off_page().  */
 238 GC_API GC_ATTR_MALLOC void * GC_CALL GC_gcj_malloc_ignore_off_page(size_t lb,
 239                                      void * ptr_to_struct_containing_descr)
 240 {
 241     ptr_t op;
 242     DCL_LOCK_STATE;
 243
 244     GC_DBG_COLLECT_AT_MALLOC(lb);
 245     if(SMALL_OBJ(lb)) {
 246         word lg;
 247
 248         LOCK();
 249         lg = GC_size_map[lb];
 250         op = GC_gcjobjfreelist[lg];
 251         if (EXPECT(0 == op, FALSE)) {
 252             maybe_finalize();
 253             op = (ptr_t)GENERAL_MALLOC_INNER_IOP(lb, GC_gcj_kind);
 254             if (0 == op) {
 255                 GC_oom_func oom_fn = GC_oom_fn;
 256                 UNLOCK();
 257                 return((*oom_fn)(lb));
 258             }
 259         } else {
 260             GC_gcjobjfreelist[lg] = (ptr_t)obj_link(op);
 261             GC_bytes_allocd += GRANULES_TO_BYTES((word)lg);
 262         }
 263     } else {
 264         LOCK();
 265         maybe_finalize();
 266         op = (ptr_t)GENERAL_MALLOC_INNER_IOP(lb, GC_gcj_kind);
 267         if (0 == op) {
 268             GC_oom_func oom_fn = GC_oom_fn;
 269             UNLOCK();
 270             return((*oom_fn)(lb));
 271         }
 272     }
 273     *(void **)op = ptr_to_struct_containing_descr;
 274     UNLOCK();
 275     GC_dirty(op);
 276     REACHABLE_AFTER_DIRTY(ptr_to_struct_containing_descr);
 277     return (void *)op;
 278 }
 279
 280 #endif  /* GC_GCJ_SUPPORT */