mono/metadata/sgen-copy-object.h

   1 /*
   2  * Copyright 2001-2003 Ximian, Inc
   3  * Copyright 2003-2010 Novell, Inc.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24 extern long long stat_copy_object_called_nursery;
  25 extern long long stat_objects_copied_nursery;
  26
  27 extern long long stat_nursery_copy_object_failed_from_space;
  28 extern long long stat_nursery_copy_object_failed_forwarded;
  29 extern long long stat_nursery_copy_object_failed_pinned;
  30
  31 extern long long stat_slots_allocated_in_vain;
  32
  33 /*
  34  * This function can be used even if the vtable of obj is not valid
  35  * anymore, which is the case in the parallel collector.
  36  */
  37 static inline void
  38 par_copy_object_no_checks (char *destination, MonoVTable *vt, void *obj, mword objsize, SgenGrayQueue *queue)
  39 {
  40 #ifdef __GNUC__
  41         static const void *copy_labels [] = { &&LAB_0, &&LAB_1, &&LAB_2, &&LAB_3, &&LAB_4, &&LAB_5, &&LAB_6, &&LAB_7, &&LAB_8 };
  42 #endif
  43
  44         DEBUG (9, g_assert (vt->klass->inited));
  45         DEBUG (9, fprintf (gc_debug_file, " (to %p, %s size: %lu)\n", destination, ((MonoObject*)obj)->vtable->klass->name, (unsigned long)objsize));
  46         binary_protocol_copy (obj, destination, vt, objsize);
  47
  48         if (G_UNLIKELY (MONO_GC_OBJ_MOVED_ENABLED ())) {
  49                 int dest_gen = sgen_ptr_in_nursery (destination) ? GENERATION_NURSERY : GENERATION_OLD;
  50                 int src_gen = sgen_ptr_in_nursery (obj) ? GENERATION_NURSERY : GENERATION_OLD;
  51                 MONO_GC_OBJ_MOVED ((mword)destination, (mword)obj, dest_gen, src_gen, objsize, vt->klass->name_space, vt->klass->name);
  52         }
  53
  54 #ifdef __GNUC__
  55         if (objsize <= sizeof (gpointer) * 8) {
  56                 mword *dest = (mword*)destination;
  57                 goto *copy_labels [objsize / sizeof (gpointer)];
  58         LAB_8:
  59                 (dest) [7] = ((mword*)obj) [7];
  60         LAB_7:
  61                 (dest) [6] = ((mword*)obj) [6];
  62         LAB_6:
  63                 (dest) [5] = ((mword*)obj) [5];
  64         LAB_5:
  65                 (dest) [4] = ((mword*)obj) [4];
  66         LAB_4:
  67                 (dest) [3] = ((mword*)obj) [3];
  68         LAB_3:
  69                 (dest) [2] = ((mword*)obj) [2];
  70         LAB_2:
  71                 (dest) [1] = ((mword*)obj) [1];
  72         LAB_1:
  73                 ;
  74         LAB_0:
  75                 ;
  76         } else {
  77                 /*can't trust memcpy doing word copies */
  78                 mono_gc_memmove (destination + sizeof (mword), (char*)obj + sizeof (mword), objsize - sizeof (mword));
  79         }
  80 #else
  81                 mono_gc_memmove (destination + sizeof (mword), (char*)obj + sizeof (mword), objsize - sizeof (mword));
  82 #endif
  83         /* adjust array->bounds */
  84         DEBUG (9, g_assert (vt->gc_descr));
  85         if (G_UNLIKELY (vt->rank && ((MonoArray*)obj)->bounds)) {
  86                 MonoArray *array = (MonoArray*)destination;
  87                 array->bounds = (MonoArrayBounds*)((char*)destination + ((char*)((MonoArray*)obj)->bounds - (char*)obj));
  88                 DEBUG (9, fprintf (gc_debug_file, "Array instance %p: size: %lu, rank: %d, length: %lu\n", array, (unsigned long)objsize, vt->rank, (unsigned long)mono_array_length (array)));
  89         }
  90         if (G_UNLIKELY (mono_profiler_events & MONO_PROFILE_GC_MOVES))
  91                 sgen_register_moved_object (obj, destination);
  92         obj = destination;
  93         if (queue) {
  94                 DEBUG (9, fprintf (gc_debug_file, "Enqueuing gray object %p (%s)\n", obj, sgen_safe_name (obj)));
  95                 GRAY_OBJECT_ENQUEUE (queue, obj);
  96         }
  97 }
  98
  99 #ifdef _MSC_VER
 100 static __declspec(noinline) void*
 101 #else
 102 static G_GNUC_UNUSED void* __attribute__((noinline))
 103 #endif
 104 copy_object_no_checks (void *obj, SgenGrayQueue *queue)
 105 {
 106         MonoVTable *vt = ((MonoObject*)obj)->vtable;
 107         gboolean has_references = SGEN_VTABLE_HAS_REFERENCES (vt);
 108         mword objsize = SGEN_ALIGN_UP (sgen_par_object_get_size (vt, (MonoObject*)obj));
 109         char *destination = collector_serial_alloc_for_promotion (obj, objsize, has_references);
 110
 111         if (G_UNLIKELY (!destination)) {
 112                 collector_pin_object (obj, queue);
 113                 sgen_set_pinned_from_failed_allocation (objsize);
 114                 return obj;
 115         }
 116
 117         *(MonoVTable**)destination = vt;
 118         par_copy_object_no_checks (destination, vt, obj, objsize, has_references ? queue : NULL);
 119
 120         /* set the forwarding pointer */
 121         SGEN_FORWARD_OBJECT (obj, destination);
 122
 123         return destination;
 124 }
 125
 126 #ifdef GENERATE_COPY_FUNCTIONS
 127
 128 extern long long stat_nursery_copy_object_failed_to_space; /* from sgen-gc.c */
 129
 130 #if defined(SGEN_SIMPLE_NURSERY)
 131 #define serial_copy_object simple_nursery_serial_copy_object
 132 #define parallel_copy_object simple_nursery_parallel_copy_object
 133
 134 #elif defined (SGEN_SPLIT_NURSERY)
 135
 136 #define serial_copy_object split_nursery_serial_copy_object
 137 #define parallel_copy_object split_nursery_parallel_copy_object
 138
 139 #else
 140 #error "Please define GC_CONF_NAME"
 141 #endif
 142
 143 /*
 144  * This is how the copying happens from the nursery to the old generation.
 145  * We assume that at this time all the pinned objects have been identified and
 146  * marked as such.
 147  * We run scan_object() for each pinned object so that each referenced
 148  * objects if possible are copied. The new gray objects created can have
 149  * scan_object() run on them right away, too.
 150  * Then we run copy_object() for the precisely tracked roots. At this point
 151  * all the roots are either gray or black. We run scan_object() on the gray
 152  * objects until no more gray objects are created.
 153  * At the end of the process we walk again the pinned list and we unmark
 154  * the pinned flag. As we go we also create the list of free space for use
 155  * in the next allocation runs.
 156  *
 157  * We need to remember objects from the old generation that point to the new one
 158  * (or just addresses?).
 159  *
 160  * copy_object could be made into a macro once debugged (use inline for now).
 161  */
 162
 163 #ifdef _MSC_VER
 164 static __forceinline void
 165 #else
 166 static inline void __attribute__((always_inline))
 167 #endif
 168 serial_copy_object (void **obj_slot, SgenGrayQueue *queue)
 169 {
 170         char *forwarded;
 171         char *obj = *obj_slot;
 172
 173         DEBUG (9, g_assert (current_collection_generation == GENERATION_NURSERY));
 174
 175         HEAVY_STAT (++stat_copy_object_called_nursery);
 176
 177         if (!sgen_ptr_in_nursery (obj)) {
 178                 HEAVY_STAT (++stat_nursery_copy_object_failed_from_space);
 179                 return;
 180         }
 181
 182         DEBUG (9, fprintf (gc_debug_file, "Precise copy of %p from %p", obj, obj_slot));
 183
 184         /*
 185          * Before we can copy the object we must make sure that we are
 186          * allowed to, i.e. that the object not pinned, not already
 187          * forwarded or belongs to the nursery To Space.
 188          */
 189
 190         if ((forwarded = SGEN_OBJECT_IS_FORWARDED (obj))) {
 191                 DEBUG (9, g_assert ((*(MonoVTable**)SGEN_LOAD_VTABLE(obj))->gc_descr));
 192                 DEBUG (9, fprintf (gc_debug_file, " (already forwarded to %p)\n", forwarded));
 193                 HEAVY_STAT (++stat_nursery_copy_object_failed_forwarded);
 194                 *obj_slot = forwarded;
 195                 return;
 196         }
 197         if (SGEN_OBJECT_IS_PINNED (obj)) {
 198                 DEBUG (9, g_assert (((MonoVTable*)SGEN_LOAD_VTABLE(obj))->gc_descr));
 199                 DEBUG (9, fprintf (gc_debug_file, " (pinned, no change)\n"));
 200                 HEAVY_STAT (++stat_nursery_copy_object_failed_pinned);
 201                 return;
 202         }
 203
 204         if (sgen_nursery_is_to_space (obj)) {
 205                 DEBUG (9, g_assert (((MonoVTable*)SGEN_LOAD_VTABLE(obj))->gc_descr));
 206                 DEBUG (9, fprintf (gc_debug_file, " (tospace, no change)\n"));
 207                 HEAVY_STAT (++stat_nursery_copy_object_failed_to_space);
 208                 return;
 209         }
 210
 211         HEAVY_STAT (++stat_objects_copied_nursery);
 212
 213         *obj_slot = copy_object_no_checks (obj, queue);
 214 }
 215
 216 static void
 217 parallel_copy_object (void **obj_slot, SgenGrayQueue *queue)
 218 {
 219         char *obj = *obj_slot;
 220         mword vtable_word, objsize;
 221         MonoVTable *vt;
 222         void *destination;
 223         gboolean has_references;
 224
 225         DEBUG (9, g_assert (current_collection_generation == GENERATION_NURSERY));
 226
 227         HEAVY_STAT (++stat_copy_object_called_nursery);
 228
 229         if (!sgen_ptr_in_nursery (obj)) {
 230                 HEAVY_STAT (++stat_nursery_copy_object_failed_from_space);
 231                 return;
 232         }
 233
 234         vtable_word = *(mword*)obj;
 235         vt = (MonoVTable*)(vtable_word & ~SGEN_VTABLE_BITS_MASK);
 236
 237         /*
 238          * Before we can copy the object we must make sure that we are
 239          * allowed to, i.e. that the object not pinned, not already
 240          * forwarded and not in the nursery To Space.
 241          */
 242
 243         if (vtable_word & SGEN_FORWARDED_BIT) {
 244                 HEAVY_STAT (++stat_nursery_copy_object_failed_forwarded);
 245                 *obj_slot = vt;
 246                 return;
 247         }
 248         if (vtable_word & SGEN_PINNED_BIT) {
 249                 HEAVY_STAT (++stat_nursery_copy_object_failed_pinned);
 250                 return;
 251         }
 252
 253         if (sgen_nursery_is_to_space (obj)) {
 254                 HEAVY_STAT (++stat_nursery_copy_object_failed_to_space);
 255                 return;
 256         }
 257
 258         HEAVY_STAT (++stat_objects_copied_nursery);
 259
 260         objsize = SGEN_ALIGN_UP (sgen_par_object_get_size (vt, (MonoObject*)obj));
 261         has_references = SGEN_VTABLE_HAS_REFERENCES (vt);
 262
 263         destination = collector_parallel_alloc_for_promotion (obj, objsize, has_references);
 264
 265         if (G_UNLIKELY (!destination)) {
 266                 sgen_parallel_pin_or_update (obj_slot, obj, vt, queue);
 267                 return;
 268         }
 269
 270         *(MonoVTable**)destination = vt;
 271
 272         if (SGEN_CAS_PTR ((void*)obj, (void*)((mword)destination | SGEN_FORWARDED_BIT), vt) == vt) {
 273                 par_copy_object_no_checks (destination, vt, obj, objsize, has_references ? queue : NULL);
 274                 obj = destination;
 275                 *obj_slot = obj;
 276         } else {
 277                 /* FIXME: unify with code in major_copy_or_mark_object() */
 278
 279                 /* FIXME: Give destination back to the allocator. */
 280                 /*The major collector only needs the first word zeroed and nursery requires all bits to be. */
 281                 if (!sgen_ptr_in_nursery (destination))
 282                         *(void**)destination = NULL;
 283                 else
 284                         memset (destination, 0, objsize);
 285
 286                 vtable_word = *(mword*)obj;
 287                 g_assert (vtable_word & SGEN_FORWARDED_BIT);
 288
 289                 obj = (void*)(vtable_word & ~SGEN_VTABLE_BITS_MASK);
 290
 291                 *obj_slot = obj;
 292
 293                 HEAVY_STAT (++stat_slots_allocated_in_vain);
 294         }
 295 }
 296
 297 #endif