mono/metadata/sgen-cardtable.c

   1 /*
   2  * sgen-cardtable.c: Card table implementation for sgen
   3  *
   4  * Author:
   5  *      Rodrigo Kumpera (rkumpera@novell.com)
   6  *
   7  * SGen is licensed under the terms of the MIT X11 license
   8  *
   9  * Copyright 2001-2003 Ximian, Inc
  10  * Copyright 2003-2010 Novell, Inc.
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining
  13  * a copy of this software and associated documentation files (the
  14  * "Software"), to deal in the Software without restriction, including
  15  * without limitation the rights to use, copy, modify, merge, publish,
  16  * distribute, sublicense, and/or sell copies of the Software, and to
  17  * permit persons to whom the Software is furnished to do so, subject to
  18  * the following conditions:
  19  *
  20  * The above copyright notice and this permission notice shall be
  21  * included in all copies or substantial portions of the Software.
  22  *
  23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  27  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  28  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  29  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  30  */
  31
  32 #ifdef SGEN_HAVE_CARDTABLE
  33
  34 //#define CARDTABLE_STATS
  35
  36 #include <unistd.h>
  37 #ifdef HAVE_SYS_MMAN_H
  38 #include <sys/mman.h>
  39 #endif
  40 #include <sys/types.h>
  41
  42 guint8 *sgen_cardtable;
  43
  44
  45 #ifdef HEAVY_STATISTICS
  46 long long marked_cards;
  47 long long scanned_cards;
  48 long long scanned_objects;
  49
  50 static long long los_marked_cards;
  51 static long long large_objects;
  52 static long long bloby_objects;
  53 static long long los_array_cards;
  54 static long long los_array_remsets;
  55
  56 #endif
  57 static long long major_card_scan_time;
  58 static long long los_card_scan_time;
  59
  60 static long long last_major_scan_time;
  61 static long long last_los_scan_time;
  62 /*WARNING: This function returns the number of cards regardless of overflow in case of overlapping cards.*/
  63 static mword
  64 cards_in_range (mword address, mword size)
  65 {
  66         mword end = address + MAX (1, size) - 1;
  67         return (end >> CARD_BITS) - (address >> CARD_BITS) + 1;
  68 }
  69
  70 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
  71
  72 guint8 *sgen_shadow_cardtable;
  73
  74 #define SGEN_SHADOW_CARDTABLE_END (sgen_shadow_cardtable + CARD_COUNT_IN_BYTES)
  75 #define SGEN_CARDTABLE_END (sgen_cardtable + CARD_COUNT_IN_BYTES)
  76
  77 static gboolean
  78 sgen_card_table_region_begin_scanning (mword start, mword end)
  79 {
  80         /*XXX this can be improved to work on words and have a single loop induction var */
  81         while (start <= end) {
  82                 if (sgen_card_table_card_begin_scanning (start))
  83                         return TRUE;
  84                 start += CARD_SIZE_IN_BYTES;
  85         }
  86         return FALSE;
  87 }
  88
  89 #else
  90
  91 static gboolean
  92 sgen_card_table_region_begin_scanning (mword start, mword size)
  93 {
  94         gboolean res = FALSE;
  95         guint8 *card = sgen_card_table_get_card_address (start);
  96         guint8 *end = card + cards_in_range (start, size);
  97
  98         /*XXX this can be improved to work on words and have a branchless body */
  99         while (card != end) {
 100                 if (*card++) {
 101                         res = TRUE;
 102                         break;
 103                 }
 104         }
 105
 106         memset (sgen_card_table_get_card_address (start), 0, size >> CARD_BITS);
 107
 108         return res;
 109 }
 110
 111 #endif
 112
 113 /*FIXME this assumes that major blocks are multiple of 4K which is pretty reasonable */
 114 gboolean
 115 sgen_card_table_get_card_data (guint8 *data_dest, mword address, mword cards)
 116 {
 117         mword *start = (mword*)sgen_card_table_get_card_scan_address (address);
 118         mword *dest = (mword*)data_dest;
 119         mword *end = (mword*)(data_dest + cards);
 120         mword mask = 0;
 121
 122         for (; dest < end; ++dest, ++start) {
 123                 mword v = *start;
 124                 *dest = v;
 125                 mask |= v;
 126
 127 #ifndef SGEN_HAVE_OVERLAPPING_CARDS
 128                 *start = 0;
 129 #endif
 130         }
 131
 132         return mask;
 133 }
 134
 135 static gboolean
 136 sgen_card_table_address_is_marked (mword address)
 137 {
 138         return *sgen_card_table_get_card_address (address) != 0;
 139 }
 140
 141 void
 142 sgen_card_table_mark_address (mword address)
 143 {
 144         *sgen_card_table_get_card_address (address) = 1;
 145 }
 146
 147 void*
 148 sgen_card_table_align_pointer (void *ptr)
 149 {
 150         return (void*)((mword)ptr & ~(CARD_SIZE_IN_BYTES - 1));
 151 }
 152
 153 void
 154 sgen_card_table_mark_range (mword address, mword size)
 155 {
 156         mword end = address + size;
 157         do {
 158                 sgen_card_table_mark_address (address);
 159                 address += CARD_SIZE_IN_BYTES;
 160         } while (address < end);
 161 }
 162
 163 static gboolean
 164 sgen_card_table_is_range_marked (guint8 *cards, mword address, mword size)
 165 {
 166         guint8 *end = cards + cards_in_range (address, size);
 167
 168         /*This is safe since this function is only called by code that only passes continuous card blocks*/
 169         while (cards != end) {
 170                 if (*cards++)
 171                         return TRUE;
 172         }
 173         return FALSE;
 174
 175 }
 176
 177 static void
 178 card_table_init (void)
 179 {
 180         sgen_cardtable = mono_sgen_alloc_os_memory (CARD_COUNT_IN_BYTES, TRUE);
 181
 182 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
 183         sgen_shadow_cardtable = mono_sgen_alloc_os_memory (CARD_COUNT_IN_BYTES, TRUE);
 184 #endif
 185
 186 #ifdef HEAVY_STATISTICS
 187         mono_counters_register ("marked cards", MONO_COUNTER_GC | MONO_COUNTER_LONG, &marked_cards);
 188         mono_counters_register ("scanned cards", MONO_COUNTER_GC | MONO_COUNTER_LONG, &scanned_cards);
 189         mono_counters_register ("los marked cards", MONO_COUNTER_GC | MONO_COUNTER_LONG, &los_marked_cards);
 190         mono_counters_register ("los array cards scanned ", MONO_COUNTER_GC | MONO_COUNTER_LONG, &los_array_cards);
 191         mono_counters_register ("los array remsets", MONO_COUNTER_GC | MONO_COUNTER_LONG, &los_array_remsets);
 192         mono_counters_register ("cardtable scanned objects", MONO_COUNTER_GC | MONO_COUNTER_LONG, &scanned_objects);
 193         mono_counters_register ("cardtable large objects", MONO_COUNTER_GC | MONO_COUNTER_LONG, &large_objects);
 194         mono_counters_register ("cardtable bloby objects", MONO_COUNTER_GC | MONO_COUNTER_LONG, &bloby_objects);
 195 #endif
 196         mono_counters_register ("cardtable major scan time", MONO_COUNTER_GC | MONO_COUNTER_LONG, &major_card_scan_time);
 197         mono_counters_register ("cardtable los scan time", MONO_COUNTER_GC | MONO_COUNTER_LONG, &los_card_scan_time);
 198 }
 199
 200 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
 201
 202 static void
 203 move_cards_to_shadow_table (mword start, mword size)
 204 {
 205         guint8 *from = sgen_card_table_get_card_address (start);
 206         guint8 *to = sgen_card_table_get_shadow_card_address (start);
 207         size_t bytes = cards_in_range (start, size);
 208
 209         if (to + bytes > SGEN_SHADOW_CARDTABLE_END) {
 210                 size_t first_chunk = SGEN_SHADOW_CARDTABLE_END - to;
 211                 size_t second_chunk = MIN (CARD_COUNT_IN_BYTES, bytes) - first_chunk;
 212
 213                 memcpy (to, from, first_chunk);
 214                 memcpy (sgen_shadow_cardtable, sgen_cardtable, second_chunk);
 215         } else {
 216                 memcpy (to, from, bytes);
 217         }
 218 }
 219
 220 static void
 221 clear_cards (mword start, mword size)
 222 {
 223         guint8 *addr = sgen_card_table_get_card_address (start);
 224         size_t bytes = cards_in_range (start, size);
 225
 226         if (addr + bytes > SGEN_CARDTABLE_END) {
 227                 size_t first_chunk = SGEN_CARDTABLE_END - addr;
 228
 229                 memset (addr, 0, first_chunk);
 230                 memset (sgen_cardtable, 0, bytes - first_chunk);
 231         } else {
 232                 memset (addr, 0, bytes);
 233         }
 234 }
 235
 236
 237 #else
 238
 239 static void
 240 clear_cards (mword start, mword size)
 241 {
 242         memset (sgen_card_table_get_card_address (start), 0, cards_in_range (start, size));
 243 }
 244
 245
 246 #endif
 247
 248 static void
 249 card_table_clear (void)
 250 {
 251         /*XXX we could do this in 2 ways. using mincore or iterating over all sections/los objects */
 252         if (use_cardtable) {
 253                 major_collector.iterate_live_block_ranges (clear_cards);
 254                 mono_sgen_los_iterate_live_block_ranges (clear_cards);
 255         }
 256 }
 257 static void
 258 scan_from_card_tables (void *start_nursery, void *end_nursery, GrayQueue *queue)
 259 {
 260         if (use_cardtable) {
 261                 TV_DECLARE (atv);
 262                 TV_DECLARE (btv);
 263
 264 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
 265         /*FIXME we should have a bit on each block/los object telling if the object have marked cards.*/
 266         /*First we copy*/
 267         major_collector.iterate_live_block_ranges (move_cards_to_shadow_table);
 268         mono_sgen_los_iterate_live_block_ranges (move_cards_to_shadow_table);
 269
 270         /*Then we clear*/
 271         card_table_clear ();
 272 #endif
 273                 TV_GETTIME (atv);
 274                 major_collector.scan_card_table (queue);
 275                 TV_GETTIME (btv);
 276                 last_major_scan_time = TV_ELAPSED_MS (atv, btv);
 277                 major_card_scan_time += last_major_scan_time;
 278                 mono_sgen_los_scan_card_table (queue);
 279                 TV_GETTIME (atv);
 280                 last_los_scan_time = TV_ELAPSED_MS (btv, atv);
 281                 los_card_scan_time += last_los_scan_time;
 282         }
 283 }
 284
 285 guint8*
 286 mono_gc_get_card_table (int *shift_bits, gpointer *mask)
 287 {
 288         if (!use_cardtable)
 289                 return NULL;
 290
 291         g_assert (sgen_cardtable);
 292         *shift_bits = CARD_BITS;
 293 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
 294         *mask = (gpointer)CARD_MASK;
 295 #else
 296         *mask = NULL;
 297 #endif
 298
 299         return sgen_cardtable;
 300 }
 301
 302 #if 0
 303 static void
 304 collect_faulted_cards (void)
 305 {
 306 #define CARD_PAGES (CARD_COUNT_IN_BYTES / 4096)
 307         int i, count = 0;
 308         unsigned char faulted [CARD_PAGES] = { 0 };
 309         mincore (sgen_cardtable, CARD_COUNT_IN_BYTES, faulted);
 310
 311         for (i = 0; i < CARD_PAGES; ++i) {
 312                 if (faulted [i])
 313                         ++count;
 314         }
 315
 316         printf ("TOTAL card pages %d faulted %d\n", CARD_PAGES, count);
 317 }
 318 #endif
 319
 320 #define MWORD_MASK (sizeof (mword) - 1)
 321
 322 static inline int
 323 find_card_offset (mword card)
 324 {
 325 /*XXX Use assembly as this generates some pretty bad code */
 326 #if defined(__i386__) && defined(__GNUC__)
 327         return  (__builtin_ffs (card) - 1) / 8;
 328 #elif defined(__x86_64__) && defined(__GNUC__)
 329         return (__builtin_ffsll (card) - 1) / 8;
 330 #elif defined(__s390x__)
 331         return (__builtin_ffsll (GUINT64_TO_LE(card)) - 1) / 8;
 332 #else
 333         // FIXME:
 334         g_assert_not_reached ();
 335         /*
 336         int i;
 337         guint8 *ptr = (guint *) &card;
 338         for (i = 0; i < sizeof (mword); ++i) {
 339                 if (ptr[i])
 340                         return i;
 341         }
 342         */
 343         return 0;
 344 #endif
 345 }
 346
 347 static guint8*
 348 find_next_card (guint8 *card_data, guint8 *end)
 349 {
 350         mword *cards, *cards_end;
 351         mword card;
 352
 353         while ((((mword)card_data) & MWORD_MASK) && card_data < end) {
 354                 if (*card_data)
 355                         return card_data;
 356                 ++card_data;
 357         }
 358
 359         if (card_data == end)
 360                 return end;
 361
 362         cards = (mword*)card_data;
 363         cards_end = (mword*)((mword)end & ~MWORD_MASK);
 364         while (cards < cards_end) {
 365                 card = *cards;
 366                 if (card)
 367                         return (guint8*)cards + find_card_offset (card);
 368                 ++cards;
 369         }
 370
 371         card_data = (guint8*)cards_end;
 372         while (card_data < end) {
 373                 if (*card_data)
 374                         return card_data;
 375                 ++card_data;
 376         }
 377
 378         return end;
 379 }
 380
 381 void
 382 sgen_cardtable_scan_object (char *obj, mword block_obj_size, guint8 *cards, SgenGrayQueue *queue)
 383 {
 384         MonoVTable *vt = (MonoVTable*)LOAD_VTABLE (obj);
 385         MonoClass *klass = vt->klass;
 386         CopyOrMarkObjectFunc copy_func = mono_sgen_get_copy_object ();
 387         ScanObjectFunc scan_object_func = mono_sgen_get_minor_scan_object ();
 388         ScanVTypeFunc scan_vtype_func = mono_sgen_get_minor_scan_vtype ();
 389
 390         HEAVY_STAT (++large_objects);
 391
 392         if (!SGEN_VTABLE_HAS_REFERENCES (vt))
 393                 return;
 394
 395         if (vt->rank) {
 396                 guint8 *card_data, *card_base;
 397                 guint8 *card_data_end;
 398                 char *obj_start = sgen_card_table_align_pointer (obj);
 399                 mword obj_size = mono_sgen_par_object_get_size (vt, (MonoObject*)obj);
 400                 char *obj_end = obj + obj_size;
 401                 size_t card_count;
 402                 int extra_idx = 0;
 403
 404                 MonoArray *arr = (MonoArray*)obj;
 405                 mword desc = (mword)klass->element_class->gc_descr;
 406                 int elem_size = mono_array_element_size (klass);
 407
 408 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
 409                 guint8 *overflow_scan_end = NULL;
 410 #endif
 411
 412                 if (cards)
 413                         card_data = cards;
 414                 else
 415                         card_data = sgen_card_table_get_card_scan_address ((mword)obj);
 416
 417                 card_base = card_data;
 418                 card_count = cards_in_range ((mword)obj, obj_size);
 419                 card_data_end = card_data + card_count;
 420
 421
 422 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
 423                 /*Check for overflow and if so, setup to scan in two steps*/
 424                 if (!cards && card_data_end >= SGEN_SHADOW_CARDTABLE_END) {
 425                         overflow_scan_end = sgen_shadow_cardtable + (card_data_end - SGEN_SHADOW_CARDTABLE_END);
 426                         card_data_end = SGEN_SHADOW_CARDTABLE_END;
 427                 }
 428
 429 LOOP_HEAD:
 430 #endif
 431
 432                 card_data = find_next_card (card_data, card_data_end);
 433                 for (; card_data < card_data_end; card_data = find_next_card (card_data + 1, card_data_end)) {
 434                         int index;
 435                         int idx = (card_data - card_base) + extra_idx;
 436                         char *start = (char*)(obj_start + idx * CARD_SIZE_IN_BYTES);
 437                         char *card_end = start + CARD_SIZE_IN_BYTES;
 438                         char *elem;
 439
 440                         HEAVY_STAT (++los_marked_cards);
 441
 442                         if (!cards)
 443                                 sgen_card_table_prepare_card_for_scanning (card_data);
 444
 445                         card_end = MIN (card_end, obj_end);
 446
 447                         if (start <= (char*)arr->vector)
 448                                 index = 0;
 449                         else
 450                                 index = ARRAY_OBJ_INDEX (start, obj, elem_size);
 451
 452                         elem = (char*)mono_array_addr_with_size ((MonoArray*)obj, elem_size, index);
 453                         if (klass->element_class->valuetype) {
 454                                 for (; elem < card_end; elem += elem_size)
 455                                         scan_vtype_func (elem, desc, queue);
 456                         } else {
 457                                 HEAVY_STAT (++los_array_cards);
 458                                 for (; elem < card_end; elem += SIZEOF_VOID_P) {
 459                                         gpointer new, old = *(gpointer*)elem;
 460                                         if (G_UNLIKELY (ptr_in_nursery (old))) {
 461                                                 HEAVY_STAT (++los_array_remsets);
 462                                                 copy_func ((void**)elem, queue);
 463                                                 new = *(gpointer*)elem;
 464                                                 if (G_UNLIKELY (ptr_in_nursery (new)))
 465                                                         mono_sgen_add_to_global_remset (elem);
 466                                         }
 467                                 }
 468                         }
 469                 }
 470
 471 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
 472                 if (overflow_scan_end) {
 473                         extra_idx = card_data - card_base;
 474                         card_base = card_data = sgen_shadow_cardtable;
 475                         card_data_end = overflow_scan_end;
 476                         overflow_scan_end = NULL;
 477                         goto LOOP_HEAD;
 478                 }
 479 #endif
 480
 481         } else {
 482                 HEAVY_STAT (++bloby_objects);
 483                 if (cards) {
 484                         if (sgen_card_table_is_range_marked (cards, (mword)obj, block_obj_size))
 485                                 scan_object_func (obj, queue);
 486                 } else if (sgen_card_table_region_begin_scanning ((mword)obj, block_obj_size)) {
 487                         scan_object_func (obj, queue);
 488                 }
 489         }
 490 }
 491
 492 #ifdef CARDTABLE_STATS
 493
 494 typedef struct {
 495         int total, marked, remarked;
 496 } card_stats;
 497
 498 static card_stats major_stats, los_stats;
 499 static card_stats *cur_stats;
 500
 501 static void
 502 count_marked_cards (mword start, mword size)
 503 {
 504         mword end = start + size;
 505         while (start <= end) {
 506                 ++cur_stats->total;
 507                 if (sgen_card_table_address_is_marked (start))
 508                         ++cur_stats->marked;
 509                 start += CARD_SIZE_IN_BYTES;
 510         }
 511 }
 512
 513 static void
 514 count_remarked_cards (mword start, mword size)
 515 {
 516         mword end = start + size;
 517         while (start <= end) {
 518                 if (sgen_card_table_address_is_marked (start))
 519                         ++cur_stats->remarked;
 520                 start += CARD_SIZE_IN_BYTES;
 521         }
 522 }
 523
 524 #endif
 525
 526 static void
 527 card_tables_collect_stats (gboolean begin)
 528 {
 529 #ifdef CARDTABLE_STATS
 530         if (begin) {
 531                 memset (&major_stats, 0, sizeof (card_stats));
 532                 memset (&los_stats, 0, sizeof (card_stats));
 533                 cur_stats = &major_stats;
 534                 major_collector.iterate_live_block_ranges (count_marked_cards);
 535                 cur_stats = &los_stats;
 536                 mono_sgen_los_iterate_live_block_ranges (count_marked_cards);
 537         } else {
 538                 cur_stats = &major_stats;
 539                 major_collector.iterate_live_block_ranges (count_marked_cards);
 540                 cur_stats = &los_stats;
 541                 mono_sgen_los_iterate_live_block_ranges (count_remarked_cards);
 542                 printf ("cards major (t %d m %d r %d)  los (t %d m %d r %d) major_scan %lld los_scan %lld\n",
 543                         major_stats.total, major_stats.marked, major_stats.remarked,
 544                         los_stats.total, los_stats.marked, los_stats.remarked,
 545                         last_major_scan_time, last_los_scan_time);
 546         }
 547 #endif
 548 }
 549
 550 #else
 551
 552 void
 553 sgen_card_table_mark_address (mword address)
 554 {
 555         g_assert_not_reached ();
 556 }
 557
 558 void
 559 sgen_card_table_mark_range (mword address, mword size)
 560 {
 561         g_assert_not_reached ();
 562 }
 563
 564 #define sgen_card_table_address_is_marked(p)    FALSE
 565 #define scan_from_card_tables(start,end,queue)
 566 #define card_table_clear()
 567 #define card_table_init()
 568 #define card_tables_collect_stats(begin)
 569
 570 guint8*
 571 mono_gc_get_card_table (int *shift_bits, gpointer *mask)
 572 {
 573         return NULL;
 574 }
 575
 576 #endif