mono/metadata/sgen-major-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 /*
  32  * This function can be used even if the vtable of obj is not valid
  33  * anymore, which is the case in the parallel collector.
  34  */
  35 static void
  36 par_copy_object_no_checks (char *destination, MonoVTable *vt, void *obj, mword objsize, SgenGrayQueue *queue)
  37 {
  38         static const void *copy_labels [] = { &&LAB_0, &&LAB_1, &&LAB_2, &&LAB_3, &&LAB_4, &&LAB_5, &&LAB_6, &&LAB_7, &&LAB_8 };
  39
  40         DEBUG (9, g_assert (vt->klass->inited));
  41         DEBUG (9, fprintf (gc_debug_file, " (to %p, %s size: %lu)\n", destination, ((MonoObject*)obj)->vtable->klass->name, (unsigned long)objsize));
  42         binary_protocol_copy (obj, destination, vt, objsize);
  43
  44         if (objsize <= sizeof (gpointer) * 8) {
  45                 mword *dest = (mword*)destination;
  46                 goto *copy_labels [objsize / sizeof (gpointer)];
  47         LAB_8:
  48                 (dest) [7] = ((mword*)obj) [7];
  49         LAB_7:
  50                 (dest) [6] = ((mword*)obj) [6];
  51         LAB_6:
  52                 (dest) [5] = ((mword*)obj) [5];
  53         LAB_5:
  54                 (dest) [4] = ((mword*)obj) [4];
  55         LAB_4:
  56                 (dest) [3] = ((mword*)obj) [3];
  57         LAB_3:
  58                 (dest) [2] = ((mword*)obj) [2];
  59         LAB_2:
  60                 (dest) [1] = ((mword*)obj) [1];
  61         LAB_1:
  62                 ;
  63         LAB_0:
  64                 ;
  65         } else {
  66                 /*can't trust memcpy doing word copies */
  67                 mono_gc_memmove (destination + sizeof (mword), (char*)obj + sizeof (mword), objsize - sizeof (mword));
  68         }
  69         /* adjust array->bounds */
  70         DEBUG (9, g_assert (vt->gc_descr));
  71         if (G_UNLIKELY (vt->rank && ((MonoArray*)obj)->bounds)) {
  72                 MonoArray *array = (MonoArray*)destination;
  73                 array->bounds = (MonoArrayBounds*)((char*)destination + ((char*)((MonoArray*)obj)->bounds - (char*)obj));
  74                 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)));
  75         }
  76         if (G_UNLIKELY (mono_profiler_events & MONO_PROFILE_GC_MOVES))
  77                 mono_sgen_register_moved_object (obj, destination);
  78         obj = destination;
  79         if (queue) {
  80                 DEBUG (9, fprintf (gc_debug_file, "Enqueuing gray object %p (%s)\n", obj, mono_sgen_safe_name (obj)));
  81                 GRAY_OBJECT_ENQUEUE (queue, obj);
  82         }
  83 }
  84
  85 static void*
  86 copy_object_no_checks (void *obj, SgenGrayQueue *queue)
  87 {
  88         MonoVTable *vt = ((MonoObject*)obj)->vtable;
  89         gboolean has_references = SGEN_VTABLE_HAS_REFERENCES (vt);
  90         mword objsize = SGEN_ALIGN_UP (mono_sgen_par_object_get_size (vt, (MonoObject*)obj));
  91         char *destination = major_alloc_object (objsize, has_references);
  92
  93         if (G_UNLIKELY (!destination)) {
  94                 mono_sgen_pin_object (obj, queue);
  95                 return obj;
  96         }
  97
  98         *(MonoVTable**)destination = vt;
  99         par_copy_object_no_checks (destination, vt, obj, objsize, has_references ? queue : NULL);
 100
 101         /* set the forwarding pointer */
 102         SGEN_FORWARD_OBJECT (obj, destination);
 103
 104         return destination;
 105 }
 106
 107 /*
 108  * This is how the copying happens from the nursery to the old generation.
 109  * We assume that at this time all the pinned objects have been identified and
 110  * marked as such.
 111  * We run scan_object() for each pinned object so that each referenced
 112  * objects if possible are copied. The new gray objects created can have
 113  * scan_object() run on them right away, too.
 114  * Then we run copy_object() for the precisely tracked roots. At this point
 115  * all the roots are either gray or black. We run scan_object() on the gray
 116  * objects until no more gray objects are created.
 117  * At the end of the process we walk again the pinned list and we unmark
 118  * the pinned flag. As we go we also create the list of free space for use
 119  * in the next allocation runs.
 120  *
 121  * We need to remember objects from the old generation that point to the new one
 122  * (or just addresses?).
 123  *
 124  * copy_object could be made into a macro once debugged (use inline for now).
 125  */
 126
 127 static void
 128 nopar_copy_object (void **obj_slot, SgenGrayQueue *queue)
 129 {
 130         char *forwarded;
 131         char *obj = *obj_slot;
 132
 133         DEBUG (9, g_assert (current_collection_generation == GENERATION_NURSERY));
 134
 135         HEAVY_STAT (++stat_copy_object_called_nursery);
 136
 137         if (!ptr_in_nursery (obj)) {
 138                 HEAVY_STAT (++stat_nursery_copy_object_failed_from_space);
 139                 return;
 140         }
 141
 142         DEBUG (9, fprintf (gc_debug_file, "Precise copy of %p from %p", obj, obj_slot));
 143
 144         /*
 145          * Before we can copy the object we must make sure that we are
 146          * allowed to, i.e. that the object not pinned or not already
 147          * forwarded.
 148          */
 149
 150         if ((forwarded = SGEN_OBJECT_IS_FORWARDED (obj))) {
 151                 DEBUG (9, g_assert (((MonoVTable*)SGEN_LOAD_VTABLE(obj))->gc_descr));
 152                 DEBUG (9, fprintf (gc_debug_file, " (already forwarded to %p)\n", forwarded));
 153                 HEAVY_STAT (++stat_nursery_copy_object_failed_forwarded);
 154                 *obj_slot = forwarded;
 155                 return;
 156         }
 157         if (SGEN_OBJECT_IS_PINNED (obj)) {
 158                 DEBUG (9, g_assert (((MonoVTable*)SGEN_LOAD_VTABLE(obj))->gc_descr));
 159                 DEBUG (9, fprintf (gc_debug_file, " (pinned, no change)\n"));
 160                 HEAVY_STAT (++stat_nursery_copy_object_failed_pinned);
 161                 return;
 162         }
 163
 164         HEAVY_STAT (++stat_objects_copied_nursery);
 165
 166         *obj_slot = copy_object_no_checks (obj, queue);
 167 }
 168
 169 #ifdef SGEN_PARALLEL_MARK
 170 static void
 171 copy_object (void **obj_slot, SgenGrayQueue *queue)
 172 {
 173         char *obj = *obj_slot;
 174         mword vtable_word, objsize;
 175         MonoVTable *vt;
 176         void *destination;
 177         gboolean has_references;
 178
 179         DEBUG (9, g_assert (current_collection_generation == GENERATION_NURSERY));
 180
 181         HEAVY_STAT (++stat_copy_object_called_nursery);
 182
 183         if (!ptr_in_nursery (obj)) {
 184                 HEAVY_STAT (++stat_nursery_copy_object_failed_from_space);
 185                 return;
 186         }
 187
 188         vtable_word = *(mword*)obj;
 189         vt = (MonoVTable*)(vtable_word & ~SGEN_VTABLE_BITS_MASK);
 190
 191         /*
 192          * Before we can copy the object we must make sure that we are
 193          * allowed to, i.e. that the object not pinned or not already
 194          * forwarded.
 195          */
 196
 197         if (vtable_word & SGEN_FORWARDED_BIT) {
 198                 HEAVY_STAT (++stat_nursery_copy_object_failed_forwarded);
 199                 *obj_slot = vt;
 200                 return;
 201         }
 202         if (vtable_word & SGEN_PINNED_BIT) {
 203                 HEAVY_STAT (++stat_nursery_copy_object_failed_pinned);
 204                 return;
 205         }
 206
 207         HEAVY_STAT (++stat_objects_copied_nursery);
 208
 209         objsize = SGEN_ALIGN_UP (mono_sgen_par_object_get_size (vt, (MonoObject*)obj));
 210         has_references = SGEN_VTABLE_HAS_REFERENCES (vt);
 211
 212         destination = alloc_obj_par (objsize, FALSE, has_references);
 213
 214         if (G_UNLIKELY (!destination)) {
 215                 pin_or_update_par (obj_slot, obj, vt, queue);
 216                 return;
 217         }
 218
 219         *(MonoVTable**)destination = vt;
 220
 221         if (SGEN_CAS_PTR ((void*)obj, (void*)((mword)destination | SGEN_FORWARDED_BIT), vt) == vt) {
 222                 par_copy_object_no_checks (destination, vt, obj, objsize, has_references ? queue : NULL);
 223                 obj = destination;
 224                 *obj_slot = obj;
 225         } else {
 226                 /* FIXME: unify with code in major_copy_or_mark_object() */
 227
 228                 /* FIXME: Give destination back to the allocator. */
 229                 *(void**)destination = NULL;
 230
 231                 vtable_word = *(mword*)obj;
 232                 g_assert (vtable_word & SGEN_FORWARDED_BIT);
 233
 234                 obj = (void*)(vtable_word & ~SGEN_VTABLE_BITS_MASK);
 235
 236                 *obj_slot = obj;
 237
 238                 ++stat_slots_allocated_in_vain;
 239         }
 240 }
 241 #else
 242 static void
 243 copy_object (void **obj_slot, SgenGrayQueue *queue)
 244 {
 245         nopar_copy_object (obj_slot, queue);
 246 }
 247 #endif
 248
 249 #define FILL_COLLECTOR_COPY_OBJECT(collector)   do {                    \
 250                 (collector)->copy_object = copy_object;                 \
 251                 (collector)->nopar_copy_object = nopar_copy_object;     \
 252         } while (0)