[sgen] Remove CARDTABLE_STATS
[mono.git] / mono / sgen / sgen-cardtable.c
1 /**
2  * \file
3  * Card table implementation for sgen
4  *
5  * Author:
6  *      Rodrigo Kumpera (rkumpera@novell.com)
7  *
8  * Copyright 2001-2003 Ximian, Inc
9  * Copyright 2003-2010 Novell, Inc.
10  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
11  * Copyright (C) 2012 Xamarin Inc
12  *
13  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
14  */
15
16 #include "config.h"
17 #ifdef HAVE_SGEN_GC
18
19 #include <string.h>
20
21 #include "mono/sgen/sgen-gc.h"
22 #include "mono/sgen/sgen-cardtable.h"
23 #include "mono/sgen/sgen-memory-governor.h"
24 #include "mono/sgen/sgen-protocol.h"
25 #include "mono/sgen/sgen-layout-stats.h"
26 #include "mono/sgen/sgen-client.h"
27 #include "mono/sgen/gc-internal-agnostic.h"
28 #include "mono/utils/mono-memory-model.h"
29
30 //#define CARDTABLE_STATS
31
32 #ifdef HAVE_UNISTD_H
33 #include <unistd.h>
34 #endif
35 #ifdef HAVE_SYS_MMAN_H
36 #include <sys/mman.h>
37 #endif
38 #include <sys/types.h>
39
40 guint8 *sgen_cardtable;
41
42 static gboolean need_mod_union;
43
44 #ifdef HEAVY_STATISTICS
45 guint64 marked_cards;
46 guint64 scanned_cards;
47 guint64 scanned_objects;
48 guint64 remarked_cards;
49 static guint64 large_objects;
50 static guint64 bloby_objects;
51 #endif
52 static guint64 major_card_scan_time;
53 static guint64 los_card_scan_time;
54
55 static guint64 last_major_scan_time;
56 static guint64 last_los_scan_time;
57
58 mword
59 sgen_card_table_number_of_cards_in_range (mword address, mword size)
60 {
61         mword end = address + MAX (1, size) - 1;
62         return (end >> CARD_BITS) - (address >> CARD_BITS) + 1;
63 }
64
65 static void
66 sgen_card_table_wbarrier_set_field (GCObject *obj, gpointer field_ptr, GCObject* value)
67 {
68         *(void**)field_ptr = value;
69         if (need_mod_union || sgen_ptr_in_nursery (value))
70                 sgen_card_table_mark_address ((mword)field_ptr);
71         sgen_dummy_use (value);
72 }
73
74 static void
75 sgen_card_table_wbarrier_arrayref_copy (gpointer dest_ptr, gpointer src_ptr, int count)
76 {
77         gpointer *dest = (gpointer *)dest_ptr;
78         gpointer *src = (gpointer *)src_ptr;
79
80         /*overlapping that required backward copying*/
81         if (src < dest && (src + count) > dest) {
82                 gpointer *start = dest;
83                 dest += count - 1;
84                 src += count - 1;
85
86                 for (; dest >= start; --src, --dest) {
87                         gpointer value = *src;
88                         SGEN_UPDATE_REFERENCE_ALLOW_NULL (dest, value);
89                         if (need_mod_union || sgen_ptr_in_nursery (value))
90                                 sgen_card_table_mark_address ((mword)dest);
91                         sgen_dummy_use (value);
92                 }
93         } else {
94                 gpointer *end = dest + count;
95                 for (; dest < end; ++src, ++dest) {
96                         gpointer value = *src;
97                         SGEN_UPDATE_REFERENCE_ALLOW_NULL (dest, value);
98                         if (need_mod_union || sgen_ptr_in_nursery (value))
99                                 sgen_card_table_mark_address ((mword)dest);
100                         sgen_dummy_use (value);
101                 }
102         }       
103 }
104
105 static void
106 sgen_card_table_wbarrier_value_copy (gpointer dest, gpointer src, int count, size_t element_size)
107 {
108         size_t size = count * element_size;
109
110         TLAB_ACCESS_INIT;
111         ENTER_CRITICAL_REGION;
112
113         mono_gc_memmove_atomic (dest, src, size);
114         sgen_card_table_mark_range ((mword)dest, size);
115
116         EXIT_CRITICAL_REGION;
117 }
118
119 static void
120 sgen_card_table_wbarrier_object_copy (GCObject* obj, GCObject *src)
121 {
122         size_t size = sgen_client_par_object_get_size (SGEN_LOAD_VTABLE_UNCHECKED (obj), obj);
123
124         TLAB_ACCESS_INIT;
125         ENTER_CRITICAL_REGION;
126
127         mono_gc_memmove_aligned ((char*)obj + SGEN_CLIENT_OBJECT_HEADER_SIZE, (char*)src + SGEN_CLIENT_OBJECT_HEADER_SIZE,
128                         size - SGEN_CLIENT_OBJECT_HEADER_SIZE);
129         sgen_card_table_mark_range ((mword)obj, size);
130
131         EXIT_CRITICAL_REGION;
132 }
133
134 static void
135 sgen_card_table_wbarrier_generic_nostore (gpointer ptr)
136 {
137         sgen_card_table_mark_address ((mword)ptr);      
138 }
139
140 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
141
142 guint8 *sgen_shadow_cardtable;
143
144 #define SGEN_CARDTABLE_END (sgen_cardtable + CARD_COUNT_IN_BYTES)
145
146 static gboolean
147 sgen_card_table_region_begin_scanning (mword start, mword size)
148 {
149         mword end = start + size;
150         /*XXX this can be improved to work on words and have a single loop induction var */
151         while (start < end) {
152                 if (sgen_card_table_card_begin_scanning (start))
153                         return TRUE;
154                 start += CARD_SIZE_IN_BYTES;
155         }
156         return FALSE;
157 }
158
159 #else
160
161 static gboolean
162 sgen_card_table_region_begin_scanning (mword start, mword size)
163 {
164         gboolean res = FALSE;
165         guint8 *card = sgen_card_table_get_card_address (start);
166         guint8 *end = card + sgen_card_table_number_of_cards_in_range (start, size);
167
168         /*XXX this can be improved to work on words and have a branchless body */
169         while (card != end) {
170                 if (*card++) {
171                         res = TRUE;
172                         break;
173                 }
174         }
175
176         memset (sgen_card_table_get_card_address (start), 0, size >> CARD_BITS);
177
178         return res;
179 }
180
181 #endif
182
183 /*FIXME this assumes that major blocks are multiple of 4K which is pretty reasonable */
184 gboolean
185 sgen_card_table_get_card_data (guint8 *data_dest, mword address, mword cards)
186 {
187         mword *start = (mword*)sgen_card_table_get_card_scan_address (address);
188         mword *dest = (mword*)data_dest;
189         mword *end = (mword*)(data_dest + cards);
190         mword mask = 0;
191
192         for (; dest < end; ++dest, ++start) {
193                 mword v = *start;
194                 *dest = v;
195                 mask |= v;
196
197 #ifndef SGEN_HAVE_OVERLAPPING_CARDS
198                 *start = 0;
199 #endif
200         }
201
202         return mask != 0;
203 }
204
205 void*
206 sgen_card_table_align_pointer (void *ptr)
207 {
208         return (void*)((mword)ptr & ~(CARD_SIZE_IN_BYTES - 1));
209 }
210
211 void
212 sgen_card_table_mark_range (mword address, mword size)
213 {
214         mword num_cards = sgen_card_table_number_of_cards_in_range (address, size);
215         guint8 *start = sgen_card_table_get_card_address (address);
216
217 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
218         /*
219          * FIXME: There's a theoretical bug here, namely that the card table is allocated so
220          * far toward the end of the address space that start + num_cards overflows.
221          */
222         guint8 *end = start + num_cards;
223         SGEN_ASSERT (0, num_cards <= CARD_COUNT_IN_BYTES, "How did we get an object larger than the card table?");
224         if (end > SGEN_CARDTABLE_END) {
225                 memset (start, 1, SGEN_CARDTABLE_END - start);
226                 memset (sgen_cardtable, 1, end - SGEN_CARDTABLE_END);
227                 return;
228         }
229 #endif
230
231         memset (start, 1, num_cards);
232 }
233
234 static gboolean
235 sgen_card_table_is_range_marked (guint8 *cards, mword address, mword size)
236 {
237         guint8 *end = cards + sgen_card_table_number_of_cards_in_range (address, size);
238
239         /*This is safe since this function is only called by code that only passes continuous card blocks*/
240         while (cards != end) {
241                 if (*cards++)
242                         return TRUE;
243         }
244         return FALSE;
245
246 }
247
248 static void
249 sgen_card_table_record_pointer (gpointer address)
250 {
251         *sgen_card_table_get_card_address ((mword)address) = 1;
252 }
253
254 static gboolean
255 sgen_card_table_find_address (char *addr)
256 {
257         return sgen_card_table_address_is_marked ((mword)addr);
258 }
259
260 static gboolean
261 sgen_card_table_find_address_with_cards (char *cards_start, guint8 *cards, char *addr)
262 {
263         cards_start = (char *)sgen_card_table_align_pointer (cards_start);
264         return cards [(addr - cards_start) >> CARD_BITS];
265 }
266
267 static void
268 update_mod_union (guint8 *dest, guint8 *start_card, size_t num_cards)
269 {
270         int i;
271         /* Marking from another thread can happen while we mark here */
272         for (i = 0; i < num_cards; ++i) {
273                 if (start_card [i])
274                         dest [i] = 1;
275         }
276 }
277
278 guint8*
279 sgen_card_table_alloc_mod_union (char *obj, mword obj_size)
280 {
281         size_t num_cards = sgen_card_table_number_of_cards_in_range ((mword) obj, obj_size);
282         guint8 *mod_union = (guint8 *)sgen_alloc_internal_dynamic (num_cards, INTERNAL_MEM_CARDTABLE_MOD_UNION, TRUE);
283         memset (mod_union, 0, num_cards);
284         return mod_union;
285 }
286
287 void
288 sgen_card_table_free_mod_union (guint8 *mod_union, char *obj, mword obj_size)
289 {
290         size_t num_cards = sgen_card_table_number_of_cards_in_range ((mword) obj, obj_size);
291         sgen_free_internal_dynamic (mod_union, num_cards, INTERNAL_MEM_CARDTABLE_MOD_UNION);
292 }
293
294 void
295 sgen_card_table_update_mod_union_from_cards (guint8 *dest, guint8 *start_card, size_t num_cards)
296 {
297         SGEN_ASSERT (0, dest, "Why don't we have a mod union?");
298         update_mod_union (dest, start_card, num_cards);
299 }
300
301 void
302 sgen_card_table_update_mod_union (guint8 *dest, char *obj, mword obj_size, size_t *out_num_cards)
303 {
304         guint8 *start_card = sgen_card_table_get_card_address ((mword)obj);
305 #ifndef SGEN_HAVE_OVERLAPPING_CARDS
306         guint8 *end_card = sgen_card_table_get_card_address ((mword)obj + obj_size - 1) + 1;
307 #endif
308         size_t num_cards;
309
310 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
311         size_t rest;
312
313         rest = num_cards = sgen_card_table_number_of_cards_in_range ((mword) obj, obj_size);
314
315         while (start_card + rest > SGEN_CARDTABLE_END) {
316                 size_t count = SGEN_CARDTABLE_END - start_card;
317                 sgen_card_table_update_mod_union_from_cards (dest, start_card, count);
318                 dest += count;
319                 rest -= count;
320                 start_card = sgen_cardtable;
321         }
322         num_cards = rest;
323 #else
324         num_cards = end_card - start_card;
325 #endif
326
327         sgen_card_table_update_mod_union_from_cards (dest, start_card, num_cards);
328
329         if (out_num_cards)
330                 *out_num_cards = num_cards;
331 }
332
333 /* Preclean cards and saves the cards that need to be scanned afterwards in cards_preclean */
334 void
335 sgen_card_table_preclean_mod_union (guint8 *cards, guint8 *cards_preclean, size_t num_cards)
336 {
337         size_t i;
338
339         memcpy (cards_preclean, cards, num_cards);
340         for (i = 0; i < num_cards; i++) {
341                 if (cards_preclean [i]) {
342                         cards [i] = 0;
343                 }
344         }
345         /*
346          * When precleaning we need to make sure the card cleaning
347          * takes place before the object is scanned. If we don't
348          * do this we could finish scanning the object and, before
349          * the cleaning of the card takes place, another thread
350          * could dirty the object, mark the mod_union card only for
351          * us to clean it back, without scanning the object again.
352          */
353         mono_memory_barrier ();
354 }
355
356 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
357
358 static void
359 move_cards_to_shadow_table (mword start, mword size)
360 {
361         guint8 *from = sgen_card_table_get_card_address (start);
362         guint8 *to = sgen_card_table_get_shadow_card_address (start);
363         size_t bytes = sgen_card_table_number_of_cards_in_range (start, size);
364
365         if (bytes >= CARD_COUNT_IN_BYTES) {
366                 memcpy (sgen_shadow_cardtable, sgen_cardtable, CARD_COUNT_IN_BYTES);
367         } else if (to + bytes > SGEN_SHADOW_CARDTABLE_END) {
368                 size_t first_chunk = SGEN_SHADOW_CARDTABLE_END - to;
369                 size_t second_chunk = MIN (CARD_COUNT_IN_BYTES, bytes) - first_chunk;
370
371                 memcpy (to, from, first_chunk);
372                 memcpy (sgen_shadow_cardtable, sgen_cardtable, second_chunk);
373         } else {
374                 memcpy (to, from, bytes);
375         }
376 }
377
378 static void
379 clear_cards (mword start, mword size)
380 {
381         guint8 *addr = sgen_card_table_get_card_address (start);
382         size_t bytes = sgen_card_table_number_of_cards_in_range (start, size);
383
384         if (bytes >= CARD_COUNT_IN_BYTES) {
385                 memset (sgen_cardtable, 0, CARD_COUNT_IN_BYTES);
386         } else if (addr + bytes > SGEN_CARDTABLE_END) {
387                 size_t first_chunk = SGEN_CARDTABLE_END - addr;
388
389                 memset (addr, 0, first_chunk);
390                 memset (sgen_cardtable, 0, bytes - first_chunk);
391         } else {
392                 memset (addr, 0, bytes);
393         }
394 }
395
396
397 #else
398
399 static void
400 clear_cards (mword start, mword size)
401 {
402         memset (sgen_card_table_get_card_address (start), 0, sgen_card_table_number_of_cards_in_range (start, size));
403 }
404
405
406 #endif
407
408 static void
409 sgen_card_table_clear_cards (void)
410 {
411         /*XXX we could do this in 2 ways. using mincore or iterating over all sections/los objects */
412         sgen_major_collector_iterate_block_ranges (clear_cards);
413         sgen_los_iterate_live_block_ranges (clear_cards);
414         sgen_wbroots_iterate_live_block_ranges (clear_cards);
415 }
416
417 static void
418 sgen_card_table_scan_remsets (ScanCopyContext ctx)
419 {
420         SGEN_TV_DECLARE (atv);
421         SGEN_TV_DECLARE (btv);
422
423 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
424         /*FIXME we should have a bit on each block/los object telling if the object have marked cards.*/
425         /*First we copy*/
426         sgen_major_collector_iterate_block_ranges (move_cards_to_shadow_table);
427         sgen_los_iterate_live_block_ranges (move_cards_to_shadow_table);
428         sgen_wbroots_iterate_live_block_ranges (move_cards_to_shadow_table);
429
430         /*Then we clear*/
431         sgen_card_table_clear_cards ();
432 #endif
433         SGEN_TV_GETTIME (atv);
434         sgen_get_major_collector ()->scan_card_table (CARDTABLE_SCAN_GLOBAL, ctx, 0, 1);
435         SGEN_TV_GETTIME (btv);
436         last_major_scan_time = SGEN_TV_ELAPSED (atv, btv); 
437         major_card_scan_time += last_major_scan_time;
438         sgen_los_scan_card_table (CARDTABLE_SCAN_GLOBAL, ctx, 0, 1);
439         SGEN_TV_GETTIME (atv);
440         last_los_scan_time = SGEN_TV_ELAPSED (btv, atv);
441         los_card_scan_time += last_los_scan_time;
442
443         sgen_wbroots_scan_card_table (ctx);
444 }
445
446 guint8*
447 sgen_get_card_table_configuration (int *shift_bits, gpointer *mask)
448 {
449 #ifndef MANAGED_WBARRIER
450         return NULL;
451 #else
452         if (!sgen_cardtable)
453                 return NULL;
454
455         *shift_bits = CARD_BITS;
456 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
457         *mask = (gpointer)CARD_MASK;
458 #else
459         *mask = NULL;
460 #endif
461
462         return sgen_cardtable;
463 #endif
464 }
465
466 #if 0
467 void
468 sgen_card_table_dump_obj_card (GCObject *object, size_t size, void *dummy)
469 {
470         guint8 *start = sgen_card_table_get_card_scan_address (object);
471         guint8 *end = start + sgen_card_table_number_of_cards_in_range (object, size);
472         int cnt = 0;
473         printf ("--obj %p %d cards [%p %p]--", object, size, start, end);
474         for (; start < end; ++start) {
475                 if (cnt == 0)
476                         printf ("\n\t[%p] ", start);
477                 printf ("%x ", *start);
478                 ++cnt;
479                 if (cnt == 8)
480                         cnt = 0;
481         }
482         printf ("\n");
483 }
484 #endif
485
486 /*
487  * Cardtable scanning
488  */
489
490 #define MWORD_MASK (sizeof (mword) - 1)
491
492 static inline int
493 find_card_offset (mword card)
494 {
495 /*XXX Use assembly as this generates some pretty bad code */
496 #if (defined(__i386__) || defined(__arm__)) && defined(__GNUC__)
497         return  (__builtin_ffs (card) - 1) / 8;
498 #elif (defined(__x86_64__) || defined(__aarch64__)) && defined(__GNUC__)
499         return (__builtin_ffsll (card) - 1) / 8;
500 #elif defined(__s390x__)
501         return (__builtin_ffsll (GUINT64_TO_LE(card)) - 1) / 8;
502 #else
503         int i;
504         guint8 *ptr = (guint8 *) &card;
505         for (i = 0; i < sizeof (mword); ++i) {
506                 if (ptr[i])
507                         return i;
508         }
509         return 0;
510 #endif
511 }
512
513 guint8*
514 sgen_find_next_card (guint8 *card_data, guint8 *end)
515 {
516         mword *cards, *cards_end;
517         mword card;
518
519         while ((((mword)card_data) & MWORD_MASK) && card_data < end) {
520                 if (*card_data)
521                         return card_data;
522                 ++card_data;
523         }
524
525         if (card_data == end)
526                 return end;
527
528         cards = (mword*)card_data;
529         cards_end = (mword*)((mword)end & ~MWORD_MASK);
530         while (cards < cards_end) {
531                 card = *cards;
532                 if (card)
533                         return (guint8*)cards + find_card_offset (card);
534                 ++cards;
535         }
536
537         card_data = (guint8*)cards_end;
538         while (card_data < end) {
539                 if (*card_data)
540                         return card_data;
541                 ++card_data;
542         }
543
544         return end;
545 }
546
547 void
548 sgen_cardtable_scan_object (GCObject *obj, mword block_obj_size, guint8 *cards, ScanCopyContext ctx)
549 {
550         HEAVY_STAT (++large_objects);
551
552         if (sgen_client_cardtable_scan_object (obj, cards, ctx))
553                 return;
554
555         HEAVY_STAT (++bloby_objects);
556         if (cards) {
557                 if (sgen_card_table_is_range_marked (cards, (mword)obj, block_obj_size))
558                         ctx.ops->scan_object (obj, sgen_obj_get_descriptor (obj), ctx.queue);
559         } else if (sgen_card_table_region_begin_scanning ((mword)obj, block_obj_size)) {
560                 ctx.ops->scan_object (obj, sgen_obj_get_descriptor (obj), ctx.queue);
561         }
562
563         binary_protocol_card_scan (obj, sgen_safe_object_get_size (obj));
564 }
565
566 void
567 sgen_card_table_init (SgenRememberedSet *remset)
568 {
569         sgen_cardtable = (guint8 *)sgen_alloc_os_memory (CARD_COUNT_IN_BYTES, (SgenAllocFlags)(SGEN_ALLOC_INTERNAL | SGEN_ALLOC_ACTIVATE), "card table", MONO_MEM_ACCOUNT_SGEN_CARD_TABLE);
570
571 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
572         sgen_shadow_cardtable = (guint8 *)sgen_alloc_os_memory (CARD_COUNT_IN_BYTES, (SgenAllocFlags)(SGEN_ALLOC_INTERNAL | SGEN_ALLOC_ACTIVATE), "shadow card table", MONO_MEM_ACCOUNT_SGEN_SHADOW_CARD_TABLE);
573 #endif
574
575 #ifdef HEAVY_STATISTICS
576         mono_counters_register ("marked cards", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &marked_cards);
577         mono_counters_register ("scanned cards", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &scanned_cards);
578         mono_counters_register ("remarked cards", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &remarked_cards);
579
580         mono_counters_register ("cardtable scanned objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &scanned_objects);
581         mono_counters_register ("cardtable large objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &large_objects);
582         mono_counters_register ("cardtable bloby objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &bloby_objects);
583 #endif
584         mono_counters_register ("cardtable major scan time", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &major_card_scan_time);
585         mono_counters_register ("cardtable los scan time", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &los_card_scan_time);
586
587
588         remset->wbarrier_set_field = sgen_card_table_wbarrier_set_field;
589         remset->wbarrier_arrayref_copy = sgen_card_table_wbarrier_arrayref_copy;
590         remset->wbarrier_value_copy = sgen_card_table_wbarrier_value_copy;
591         remset->wbarrier_object_copy = sgen_card_table_wbarrier_object_copy;
592         remset->wbarrier_generic_nostore = sgen_card_table_wbarrier_generic_nostore;
593         remset->record_pointer = sgen_card_table_record_pointer;
594
595         remset->scan_remsets = sgen_card_table_scan_remsets;
596
597         remset->clear_cards = sgen_card_table_clear_cards;
598
599         remset->find_address = sgen_card_table_find_address;
600         remset->find_address_with_cards = sgen_card_table_find_address_with_cards;
601
602         need_mod_union = sgen_get_major_collector ()->is_concurrent;
603 }
604
605 #endif /*HAVE_SGEN_GC*/