mono/sgen/sgen-descriptor.c

   1 /*
   2  * sgen-descriptor.c: GC descriptors describe object layout.
   3  *
   4  * Copyright 2001-2003 Ximian, Inc
   5  * Copyright 2003-2010 Novell, Inc.
   6  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
   7  * Copyright (C) 2012 Xamarin Inc
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License 2.0 as published by the Free Software Foundation;
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License 2.0 along with this library; if not, write to the Free
  20  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  */
  22 #include "config.h"
  23 #ifdef HAVE_SGEN_GC
  24
  25 #ifdef HAVE_UNISTD_H
  26 #include <unistd.h>
  27 #endif
  28 #ifdef HAVE_PTHREAD_H
  29 #include <pthread.h>
  30 #endif
  31 #ifdef HAVE_SEMAPHORE_H
  32 #include <semaphore.h>
  33 #endif
  34 #include <stdio.h>
  35 #include <string.h>
  36 #include <errno.h>
  37 #include <assert.h>
  38 #ifdef __MACH__
  39 #undef _XOPEN_SOURCE
  40 #endif
  41 #ifdef __MACH__
  42 #define _XOPEN_SOURCE
  43 #endif
  44
  45 #include "mono/sgen/sgen-gc.h"
  46 #include "mono/sgen/gc-internal-agnostic.h"
  47
  48 #define MAX_USER_DESCRIPTORS 16
  49
  50 #define MAKE_ROOT_DESC(type,val) ((type) | ((val) << ROOT_DESC_TYPE_SHIFT))
  51 #define ALIGN_TO(val,align) ((((guint64)val) + ((align) - 1)) & ~((align) - 1))
  52
  53
  54 static gsize* complex_descriptors = NULL;
  55 static int complex_descriptors_size = 0;
  56 static int complex_descriptors_next = 0;
  57 static SgenUserRootMarkFunc user_descriptors [MAX_USER_DESCRIPTORS];
  58 static int user_descriptors_next = 0;
  59 static SgenDescriptor all_ref_root_descrs [32];
  60
  61 #ifdef HEAVY_STATISTICS
  62 static guint64 stat_scanned_count_per_descriptor [DESC_TYPE_MAX];
  63 static guint64 stat_copied_count_per_descriptor [DESC_TYPE_MAX];
  64 #endif
  65
  66 static int
  67 alloc_complex_descriptor (gsize *bitmap, int numbits)
  68 {
  69         int nwords, res, i;
  70
  71         numbits = ALIGN_TO (numbits, GC_BITS_PER_WORD);
  72         nwords = numbits / GC_BITS_PER_WORD + 1;
  73
  74         sgen_gc_lock ();
  75         res = complex_descriptors_next;
  76         /* linear search, so we don't have duplicates with domain load/unload
  77          * this should not be performance critical or we'd have bigger issues
  78          * (the number and size of complex descriptors should be small).
  79          */
  80         for (i = 0; i < complex_descriptors_next; ) {
  81                 if (complex_descriptors [i] == nwords) {
  82                         int j, found = TRUE;
  83                         for (j = 0; j < nwords - 1; ++j) {
  84                                 if (complex_descriptors [i + 1 + j] != bitmap [j]) {
  85                                         found = FALSE;
  86                                         break;
  87                                 }
  88                         }
  89                         if (found) {
  90                                 sgen_gc_unlock ();
  91                                 return i;
  92                         }
  93                 }
  94                 i += (int)complex_descriptors [i];
  95         }
  96         if (complex_descriptors_next + nwords > complex_descriptors_size) {
  97                 int new_size = complex_descriptors_size * 2 + nwords;
  98                 complex_descriptors = (gsize *)g_realloc (complex_descriptors, new_size * sizeof (gsize));
  99                 complex_descriptors_size = new_size;
 100         }
 101         SGEN_LOG (6, "Complex descriptor %d, size: %d (total desc memory: %d)", res, nwords, complex_descriptors_size);
 102         complex_descriptors_next += nwords;
 103         complex_descriptors [res] = nwords;
 104         for (i = 0; i < nwords - 1; ++i) {
 105                 complex_descriptors [res + 1 + i] = bitmap [i];
 106                 SGEN_LOG (6, "\tvalue: %p", (void*)complex_descriptors [res + 1 + i]);
 107         }
 108         sgen_gc_unlock ();
 109         return res;
 110 }
 111
 112 gsize*
 113 sgen_get_complex_descriptor (SgenDescriptor desc)
 114 {
 115         return complex_descriptors + (desc >> LOW_TYPE_BITS);
 116 }
 117
 118 /*
 119  * Descriptor builders.
 120  */
 121 SgenDescriptor
 122 mono_gc_make_descr_for_object (gsize *bitmap, int numbits, size_t obj_size)
 123 {
 124         int first_set = -1, num_set = 0, last_set = -1, i;
 125         SgenDescriptor desc = 0;
 126         size_t stored_size = obj_size;
 127
 128         stored_size += SGEN_ALLOC_ALIGN - 1;
 129         stored_size &= ~(SGEN_ALLOC_ALIGN - 1);
 130
 131         for (i = 0; i < numbits; ++i) {
 132                 if (bitmap [i / GC_BITS_PER_WORD] & ((gsize)1 << (i % GC_BITS_PER_WORD))) {
 133                         if (first_set < 0)
 134                                 first_set = i;
 135                         last_set = i;
 136                         num_set++;
 137                 }
 138         }
 139
 140         if (first_set < 0) {
 141                 SGEN_LOG (6, "Ptrfree descriptor %p, size: %zd", (void*)desc, stored_size);
 142                 if (stored_size <= MAX_RUNLEN_OBJECT_SIZE && stored_size <= SGEN_MAX_SMALL_OBJ_SIZE)
 143                         return DESC_TYPE_SMALL_PTRFREE | stored_size;
 144                 return DESC_TYPE_COMPLEX_PTRFREE;
 145         }
 146
 147         g_assert (!(stored_size & 0x7));
 148
 149         SGEN_ASSERT (5, stored_size == SGEN_ALIGN_UP (stored_size), "Size is not aligned");
 150
 151         /* we know the 2-word header is ptr-free */
 152         if (last_set < BITMAP_NUM_BITS + OBJECT_HEADER_WORDS && stored_size <= SGEN_MAX_SMALL_OBJ_SIZE) {
 153                 desc = DESC_TYPE_BITMAP | ((*bitmap >> OBJECT_HEADER_WORDS) << LOW_TYPE_BITS);
 154                 SGEN_LOG (6, "Largebitmap descriptor %p, size: %zd, last set: %d", (void*)desc, stored_size, last_set);
 155                 return desc;
 156         }
 157
 158         if (stored_size <= MAX_RUNLEN_OBJECT_SIZE && stored_size <= SGEN_MAX_SMALL_OBJ_SIZE) {
 159                 /* check run-length encoding first: one byte offset, one byte number of pointers
 160                  * on 64 bit archs, we can have 3 runs, just one on 32.
 161                  * It may be better to use nibbles.
 162                  */
 163                 if (first_set < 256 && num_set < 256 && (first_set + num_set == last_set + 1)) {
 164                         desc = DESC_TYPE_RUN_LENGTH | stored_size | (first_set << 16) | (num_set << 24);
 165                         SGEN_LOG (6, "Runlen descriptor %p, size: %zd, first set: %d, num set: %d", (void*)desc, stored_size, first_set, num_set);
 166                         return desc;
 167                 }
 168         }
 169
 170         /* it's a complex object ... */
 171         desc = DESC_TYPE_COMPLEX | (alloc_complex_descriptor (bitmap, last_set + 1) << LOW_TYPE_BITS);
 172         return desc;
 173 }
 174
 175 /* If the array holds references, numbits == 1 and the first bit is set in elem_bitmap */
 176 SgenDescriptor
 177 mono_gc_make_descr_for_array (int vector, gsize *elem_bitmap, int numbits, size_t elem_size)
 178 {
 179         int first_set = -1, num_set = 0, last_set = -1, i;
 180         SgenDescriptor desc = DESC_TYPE_VECTOR | (vector ? VECTOR_KIND_SZARRAY : VECTOR_KIND_ARRAY);
 181         for (i = 0; i < numbits; ++i) {
 182                 if (elem_bitmap [i / GC_BITS_PER_WORD] & ((gsize)1 << (i % GC_BITS_PER_WORD))) {
 183                         if (first_set < 0)
 184                                 first_set = i;
 185                         last_set = i;
 186                         num_set++;
 187                 }
 188         }
 189
 190         if (first_set < 0) {
 191                 if (elem_size <= MAX_ELEMENT_SIZE)
 192                         return desc | VECTOR_SUBTYPE_PTRFREE | (elem_size << VECTOR_ELSIZE_SHIFT);
 193                 return DESC_TYPE_COMPLEX_PTRFREE;
 194         }
 195
 196         if (elem_size <= MAX_ELEMENT_SIZE) {
 197                 desc |= elem_size << VECTOR_ELSIZE_SHIFT;
 198                 if (!num_set) {
 199                         return desc | VECTOR_SUBTYPE_PTRFREE;
 200                 }
 201                 /* Note: we also handle structs with just ref fields */
 202                 if (num_set * sizeof (gpointer) == elem_size) {
 203                         return desc | VECTOR_SUBTYPE_REFS | ((gssize)(-1) << 16);
 204                 }
 205                 /* FIXME: try run-len first */
 206                 /* Note: we can't skip the object header here, because it's not present */
 207                 if (last_set < VECTOR_BITMAP_SIZE) {
 208                         return desc | VECTOR_SUBTYPE_BITMAP | (*elem_bitmap << 16);
 209                 }
 210         }
 211         /* it's am array of complex structs ... */
 212         desc = DESC_TYPE_COMPLEX_ARR;
 213         desc |= alloc_complex_descriptor (elem_bitmap, last_set + 1) << LOW_TYPE_BITS;
 214         return desc;
 215 }
 216
 217 /* Return the bitmap encoded by a descriptor */
 218 gsize*
 219 mono_gc_get_bitmap_for_descr (SgenDescriptor descr, int *numbits)
 220 {
 221         SgenDescriptor d = (SgenDescriptor)descr;
 222         gsize *bitmap;
 223
 224         switch (d & DESC_TYPE_MASK) {
 225         case DESC_TYPE_RUN_LENGTH: {
 226                 int first_set = (d >> 16) & 0xff;
 227                 int num_set = (d >> 24) & 0xff;
 228                 int i;
 229
 230                 bitmap = g_new0 (gsize, (first_set + num_set + 7) / 8);
 231
 232                 for (i = first_set; i < first_set + num_set; ++i)
 233                         bitmap [i / GC_BITS_PER_WORD] |= ((gsize)1 << (i % GC_BITS_PER_WORD));
 234
 235                 *numbits = first_set + num_set;
 236
 237                 return bitmap;
 238         }
 239
 240         case DESC_TYPE_BITMAP: {
 241                 gsize bmap = (d >> LOW_TYPE_BITS) << OBJECT_HEADER_WORDS;
 242
 243                 bitmap = g_new0 (gsize, 1);
 244                 bitmap [0] = bmap;
 245                 *numbits = 0;
 246                 while (bmap) {
 247                         (*numbits) ++;
 248                         bmap >>= 1;
 249                 }
 250                 return bitmap;
 251         }
 252
 253         case DESC_TYPE_COMPLEX: {
 254                 gsize *bitmap_data = sgen_get_complex_descriptor (d);
 255                 int bwords = (int)(*bitmap_data) - 1;//Max scalar object size is 1Mb, which means up to 32k descriptor words
 256                 int i;
 257
 258                 bitmap = g_new0 (gsize, bwords);
 259                 *numbits = bwords * GC_BITS_PER_WORD;
 260
 261                 for (i = 0; i < bwords; ++i) {
 262                         bitmap [i] = bitmap_data [i + 1];
 263                 }
 264
 265                 return bitmap;
 266         }
 267
 268         default:
 269                 g_assert_not_reached ();
 270         }
 271 }
 272
 273 SgenDescriptor
 274 mono_gc_make_descr_from_bitmap (gsize *bitmap, int numbits)
 275 {
 276         if (numbits == 0) {
 277                 return MAKE_ROOT_DESC (ROOT_DESC_BITMAP, 0);
 278         } else if (numbits < ((sizeof (*bitmap) * 8) - ROOT_DESC_TYPE_SHIFT)) {
 279                 return MAKE_ROOT_DESC (ROOT_DESC_BITMAP, bitmap [0]);
 280         } else {
 281                 SgenDescriptor complex = alloc_complex_descriptor (bitmap, numbits);
 282                 return MAKE_ROOT_DESC (ROOT_DESC_COMPLEX, complex);
 283         }
 284 }
 285
 286 SgenDescriptor
 287 mono_gc_make_root_descr_all_refs (int numbits)
 288 {
 289         gsize *gc_bitmap;
 290         SgenDescriptor descr;
 291         int num_bytes = numbits / 8;
 292
 293         if (numbits < 32 && all_ref_root_descrs [numbits])
 294                 return all_ref_root_descrs [numbits];
 295
 296         gc_bitmap = (gsize *)g_malloc0 (ALIGN_TO (ALIGN_TO (numbits, 8) + 1, sizeof (gsize)));
 297         memset (gc_bitmap, 0xff, num_bytes);
 298         if (numbits < ((sizeof (*gc_bitmap) * 8) - ROOT_DESC_TYPE_SHIFT))
 299                 gc_bitmap[0] = GUINT64_TO_LE(gc_bitmap[0]);
 300         else if (numbits && num_bytes % (sizeof (*gc_bitmap)))
 301                 gc_bitmap[num_bytes / 8] = GUINT64_TO_LE(gc_bitmap [num_bytes / 8]);
 302         if (numbits % 8)
 303                 gc_bitmap [numbits / 8] = (1 << (numbits % 8)) - 1;
 304         descr = mono_gc_make_descr_from_bitmap (gc_bitmap, numbits);
 305         g_free (gc_bitmap);
 306
 307         if (numbits < 32)
 308                 all_ref_root_descrs [numbits] = descr;
 309
 310         return descr;
 311 }
 312
 313 SgenDescriptor
 314 sgen_make_user_root_descriptor (SgenUserRootMarkFunc marker)
 315 {
 316         SgenDescriptor descr;
 317
 318         g_assert (user_descriptors_next < MAX_USER_DESCRIPTORS);
 319         descr = MAKE_ROOT_DESC (ROOT_DESC_USER, (SgenDescriptor)user_descriptors_next);
 320         user_descriptors [user_descriptors_next ++] = marker;
 321
 322         return descr;
 323 }
 324
 325 void*
 326 sgen_get_complex_descriptor_bitmap (SgenDescriptor desc)
 327 {
 328         return complex_descriptors + (desc >> ROOT_DESC_TYPE_SHIFT);
 329 }
 330
 331 SgenUserRootMarkFunc
 332 sgen_get_user_descriptor_func (SgenDescriptor desc)
 333 {
 334         return user_descriptors [desc >> ROOT_DESC_TYPE_SHIFT];
 335 }
 336
 337 #ifdef HEAVY_STATISTICS
 338 void
 339 sgen_descriptor_count_scanned_object (SgenDescriptor desc)
 340 {
 341         int type = desc & DESC_TYPE_MASK;
 342         SGEN_ASSERT (0, type, "Descriptor type can't be zero");
 343         ++stat_scanned_count_per_descriptor [type - 1];
 344 }
 345
 346 void
 347 sgen_descriptor_count_copied_object (SgenDescriptor desc)
 348 {
 349         int type = desc & DESC_TYPE_MASK;
 350         SGEN_ASSERT (0, type, "Descriptor type can't be zero");
 351         ++stat_copied_count_per_descriptor [type - 1];
 352 }
 353 #endif
 354
 355 void
 356 sgen_init_descriptors (void)
 357 {
 358 #ifdef HEAVY_STATISTICS
 359         mono_counters_register ("# scanned RUN_LENGTH", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scanned_count_per_descriptor [DESC_TYPE_RUN_LENGTH - 1]);
 360         mono_counters_register ("# scanned SMALL_PTRFREE", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scanned_count_per_descriptor [DESC_TYPE_SMALL_PTRFREE - 1]);
 361         mono_counters_register ("# scanned COMPLEX", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scanned_count_per_descriptor [DESC_TYPE_COMPLEX - 1]);
 362         mono_counters_register ("# scanned VECTOR", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scanned_count_per_descriptor [DESC_TYPE_VECTOR - 1]);
 363         mono_counters_register ("# scanned BITMAP", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scanned_count_per_descriptor [DESC_TYPE_BITMAP - 1]);
 364         mono_counters_register ("# scanned COMPLEX_ARR", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scanned_count_per_descriptor [DESC_TYPE_COMPLEX_ARR - 1]);
 365         mono_counters_register ("# scanned COMPLEX_PTRFREE", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scanned_count_per_descriptor [DESC_TYPE_COMPLEX_PTRFREE - 1]);
 366
 367         mono_counters_register ("# copied RUN_LENGTH", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copied_count_per_descriptor [DESC_TYPE_RUN_LENGTH - 1]);
 368         mono_counters_register ("# copied SMALL_PTRFREE", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copied_count_per_descriptor [DESC_TYPE_SMALL_PTRFREE - 1]);
 369         mono_counters_register ("# copied COMPLEX", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copied_count_per_descriptor [DESC_TYPE_COMPLEX - 1]);
 370         mono_counters_register ("# copied VECTOR", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copied_count_per_descriptor [DESC_TYPE_VECTOR - 1]);
 371         mono_counters_register ("# copied BITMAP", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copied_count_per_descriptor [DESC_TYPE_BITMAP - 1]);
 372         mono_counters_register ("# copied COMPLEX_ARR", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copied_count_per_descriptor [DESC_TYPE_COMPLEX_ARR - 1]);
 373         mono_counters_register ("# copied COMPLEX_PTRFREE", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copied_count_per_descriptor [DESC_TYPE_COMPLEX_PTRFREE - 1]);
 374 #endif
 375 }
 376
 377 #endif