2 * sgen-debug.c: Collector debugging
5 * Paolo Molaro (lupus@ximian.com)
6 * Rodrigo Kumpera (kumpera@gmail.com)
8 * Copyright 2005-2011 Novell, Inc (http://www.novell.com)
9 * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
10 * Copyright 2011 Xamarin, Inc.
11 * Copyright (C) 2012 Xamarin Inc
13 * This library is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU Library General Public
15 * License 2.0 as published by the Free Software Foundation;
17 * This library is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Library General Public License for more details.
22 * You should have received a copy of the GNU Library General Public
23 * License 2.0 along with this library; if not, write to the Free
24 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
32 #include "mono/sgen/sgen-gc.h"
33 #include "mono/sgen/sgen-cardtable.h"
34 #include "mono/sgen/sgen-protocol.h"
35 #include "mono/sgen/sgen-memory-governor.h"
36 #include "mono/sgen/sgen-pinning.h"
37 #include "mono/sgen/sgen-client.h"
39 #define LOAD_VTABLE SGEN_LOAD_VTABLE
41 #define object_is_forwarded SGEN_OBJECT_IS_FORWARDED
42 #define object_is_pinned SGEN_OBJECT_IS_PINNED
43 #define safe_object_get_size sgen_safe_object_get_size
45 void describe_ptr (char *ptr);
46 void check_object (GCObject *obj);
49 * ######################################################################
50 * ######## Collector debugging
51 * ######################################################################
54 static const char*descriptor_types [] = {
62 "complex pointer-free"
65 static char* describe_nursery_ptr (char *ptr, gboolean need_setup);
68 describe_pointer (char *ptr, gboolean need_setup)
78 if (sgen_ptr_in_nursery (ptr)) {
79 start = describe_nursery_ptr (ptr, need_setup);
83 vtable = LOAD_VTABLE ((GCObject*)ptr);
85 if (sgen_ptr_is_in_los (ptr, &start)) {
87 printf ("Pointer is the start of object %p in LOS space.\n", start);
89 printf ("Pointer is at offset 0x%x of object %p in LOS space.\n", (int)(ptr - start), start);
91 mono_sgen_los_describe_pointer (ptr);
92 vtable = LOAD_VTABLE ((GCObject*)ptr);
93 } else if (major_collector.ptr_is_in_non_pinned_space (ptr, &start)) {
95 printf ("Pointer is the start of object %p in oldspace.\n", start);
97 printf ("Pointer is at offset 0x%x of object %p in oldspace.\n", (int)(ptr - start), start);
99 printf ("Pointer inside oldspace.\n");
102 vtable = (GCVTable)major_collector.describe_pointer (ptr);
103 } else if (major_collector.ptr_is_from_pinned_alloc (ptr)) {
104 // FIXME: Handle pointers to the inside of objects
105 printf ("Pointer is inside a pinned chunk.\n");
106 vtable = LOAD_VTABLE ((GCObject*)ptr);
108 printf ("Pointer unknown.\n");
113 if (object_is_pinned (ptr))
114 printf ("Object is pinned.\n");
116 if ((forwarded = (char *)object_is_forwarded (ptr))) {
117 printf ("Object is forwarded to %p:\n", forwarded);
122 printf ("VTable: %p\n", vtable);
123 if (vtable == NULL) {
124 printf ("VTable is invalid (empty).\n");
127 if (sgen_ptr_in_nursery (vtable)) {
128 printf ("VTable is invalid (points inside nursery).\n");
131 printf ("Class: %s.%s\n", sgen_client_vtable_get_namespace (vtable), sgen_client_vtable_get_name (vtable));
133 desc = sgen_vtable_get_descriptor (vtable);
134 printf ("Descriptor: %lx\n", (long)desc);
136 type = desc & DESC_TYPE_MASK;
137 printf ("Descriptor type: %d (%s)\n", type, descriptor_types [type]);
139 size = sgen_safe_object_get_size ((GCObject*)ptr);
140 printf ("Size: %d\n", (int)size);
144 sgen_client_describe_invalid_pointer ((GCObject *) ptr);
148 describe_ptr (char *ptr)
150 describe_pointer (ptr, TRUE);
153 static gboolean missing_remsets;
156 * We let a missing remset slide if the target object is pinned,
157 * because the store might have happened but the remset not yet added,
158 * but in that case the target must be pinned. We might theoretically
159 * miss some missing remsets this way, but it's very unlikely.
162 #define HANDLE_PTR(ptr,obj) do { \
163 if (*(ptr) && sgen_ptr_in_nursery ((char*)*(ptr))) { \
164 if (!sgen_get_remset ()->find_address ((char*)(ptr)) && !sgen_cement_lookup (*(ptr))) { \
165 GCVTable __vt = SGEN_LOAD_VTABLE (obj); \
166 SGEN_LOG (0, "Oldspace->newspace reference %p at offset %zd in object %p (%s.%s) not found in remsets.", *(ptr), (char*)(ptr) - (char*)(obj), (obj), sgen_client_vtable_get_namespace (__vt), sgen_client_vtable_get_name (__vt)); \
167 binary_protocol_missing_remset ((obj), __vt, (int) ((char*)(ptr) - (char*)(obj)), *(ptr), (gpointer)LOAD_VTABLE(*(ptr)), object_is_pinned (*(ptr))); \
168 if (!object_is_pinned (*(ptr))) \
169 missing_remsets = TRUE; \
175 * Check that each object reference which points into the nursery can
176 * be found in the remembered sets.
179 check_consistency_callback (GCObject *obj, size_t size, void *dummy)
181 char *start = (char*)obj;
182 GCVTable vt = LOAD_VTABLE (obj);
183 SgenDescriptor desc = sgen_vtable_get_descriptor (vt);
184 SGEN_LOG (8, "Scanning object %p, vtable: %p (%s)", start, vt, sgen_client_vtable_get_name (vt));
186 #include "sgen-scan-object.h"
190 * Perform consistency check of the heap.
192 * Assumes the world is stopped.
195 sgen_check_consistency (void)
197 // Need to add more checks
199 missing_remsets = FALSE;
201 SGEN_LOG (1, "Begin heap consistency check...");
203 // Check that oldspace->newspace pointers are registered with the collector
204 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, (IterateObjectCallbackFunc)check_consistency_callback, NULL);
206 sgen_los_iterate_objects ((IterateObjectCallbackFunc)check_consistency_callback, NULL);
208 SGEN_LOG (1, "Heap consistency check done.");
210 if (!binary_protocol_is_enabled ())
211 g_assert (!missing_remsets);
215 is_major_or_los_object_marked (GCObject *obj)
217 if (sgen_safe_object_get_size ((GCObject*)obj) > SGEN_MAX_SMALL_OBJ_SIZE) {
218 return sgen_los_object_is_pinned (obj);
220 return sgen_get_major_collector ()->is_object_live (obj);
225 #define HANDLE_PTR(ptr,obj) do { \
226 if (*(ptr) && !sgen_ptr_in_nursery ((char*)*(ptr)) && !is_major_or_los_object_marked ((GCObject*)*(ptr))) { \
227 if (!sgen_get_remset ()->find_address_with_cards (start, cards, (char*)(ptr))) { \
228 GCVTable __vt = SGEN_LOAD_VTABLE (obj); \
229 SGEN_LOG (0, "major->major reference %p at offset %zd in object %p (%s.%s) not found in remsets.", *(ptr), (char*)(ptr) - (char*)(obj), (obj), sgen_client_vtable_get_namespace (__vt), sgen_client_vtable_get_name (__vt)); \
230 binary_protocol_missing_remset ((obj), __vt, (int) ((char*)(ptr) - (char*)(obj)), *(ptr), (gpointer)LOAD_VTABLE(*(ptr)), object_is_pinned (*(ptr))); \
231 missing_remsets = TRUE; \
237 check_mod_union_callback (GCObject *obj, size_t size, void *dummy)
239 char *start = (char*)obj;
240 gboolean in_los = (gboolean) (size_t) dummy;
241 GCVTable vt = LOAD_VTABLE (obj);
242 SgenDescriptor desc = sgen_vtable_get_descriptor (vt);
244 SGEN_LOG (8, "Scanning object %p, vtable: %p (%s)", obj, vt, sgen_client_vtable_get_name (vt));
246 if (!is_major_or_los_object_marked (obj))
250 cards = sgen_los_header_for_object (obj)->cardtable_mod_union;
252 cards = sgen_get_major_collector ()->get_cardtable_mod_union_for_reference (start);
254 SGEN_ASSERT (0, cards, "we must have mod union for marked major objects");
256 #include "sgen-scan-object.h"
260 sgen_check_mod_union_consistency (void)
262 missing_remsets = FALSE;
264 major_collector.iterate_objects (ITERATE_OBJECTS_ALL, (IterateObjectCallbackFunc)check_mod_union_callback, (void*)FALSE);
266 sgen_los_iterate_objects ((IterateObjectCallbackFunc)check_mod_union_callback, (void*)TRUE);
268 if (!binary_protocol_is_enabled ())
269 g_assert (!missing_remsets);
273 #define HANDLE_PTR(ptr,obj) do { \
274 if (*(ptr) && !LOAD_VTABLE (*(ptr))) \
275 g_error ("Could not load vtable for obj %p slot %zd (size %zd)", obj, (char*)ptr - (char*)obj, (size_t)safe_object_get_size ((GCObject*)obj)); \
279 check_major_refs_callback (GCObject *obj, size_t size, void *dummy)
281 char *start = (char*)obj;
282 SgenDescriptor desc = sgen_obj_get_descriptor (obj);
284 #include "sgen-scan-object.h"
288 sgen_check_major_refs (void)
290 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, (IterateObjectCallbackFunc)check_major_refs_callback, NULL);
291 sgen_los_iterate_objects ((IterateObjectCallbackFunc)check_major_refs_callback, NULL);
294 /* Check that the reference is valid */
296 #define HANDLE_PTR(ptr,obj) do { \
298 g_assert (sgen_client_vtable_get_namespace (SGEN_LOAD_VTABLE_UNCHECKED (*(ptr)))); \
305 * Perform consistency check on an object. Currently we only check that the
306 * reference fields are valid.
309 check_object (GCObject *obj)
311 char *start = (char*)obj;
317 desc = sgen_obj_get_descriptor (obj);
319 #include "sgen-scan-object.h"
323 static GCObject **valid_nursery_objects;
324 static int valid_nursery_object_count;
325 static gboolean broken_heap;
328 setup_mono_sgen_scan_area_with_callback (GCObject *object, size_t size, void *data)
330 valid_nursery_objects [valid_nursery_object_count++] = object;
334 setup_valid_nursery_objects (void)
336 if (!valid_nursery_objects)
337 valid_nursery_objects = (GCObject **)sgen_alloc_os_memory (DEFAULT_NURSERY_SIZE, (SgenAllocFlags)(SGEN_ALLOC_INTERNAL | SGEN_ALLOC_ACTIVATE), "debugging data");
338 valid_nursery_object_count = 0;
339 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data, setup_mono_sgen_scan_area_with_callback, NULL, FALSE, FALSE);
343 find_object_in_nursery_dump (char *object)
345 int first = 0, last = valid_nursery_object_count;
346 while (first < last) {
347 int middle = first + ((last - first) >> 1);
348 if (object == (char*)valid_nursery_objects [middle])
351 if (object < (char*)valid_nursery_objects [middle])
356 g_assert (first == last);
361 iterate_valid_nursery_objects (IterateObjectCallbackFunc callback, void *data)
364 for (i = 0; i < valid_nursery_object_count; ++i) {
365 GCObject *obj = valid_nursery_objects [i];
366 callback (obj, safe_object_get_size (obj), data);
371 describe_nursery_ptr (char *ptr, gboolean need_setup)
376 setup_valid_nursery_objects ();
378 for (i = 0; i < valid_nursery_object_count - 1; ++i) {
379 if ((char*)valid_nursery_objects [i + 1] > ptr)
383 if (i >= valid_nursery_object_count || (char*)valid_nursery_objects [i] + safe_object_get_size (valid_nursery_objects [i]) < ptr) {
384 SGEN_LOG (0, "nursery-ptr (unalloc'd-memory)");
387 GCObject *obj = valid_nursery_objects [i];
388 if ((char*)obj == ptr)
389 SGEN_LOG (0, "nursery-ptr %p", obj);
391 SGEN_LOG (0, "nursery-ptr %p (interior-ptr offset %zd)", obj, ptr - (char*)obj);
397 is_valid_object_pointer (char *object)
399 if (sgen_ptr_in_nursery (object))
400 return find_object_in_nursery_dump (object);
402 if (sgen_los_is_valid_object (object))
405 if (major_collector.is_valid_object (object))
411 bad_pointer_spew (char *obj, char **slot)
414 GCVTable vtable = LOAD_VTABLE ((GCObject*)obj);
416 SGEN_LOG (0, "Invalid object pointer %p at offset %zd in object %p (%s.%s):", ptr,
418 obj, sgen_client_vtable_get_namespace (vtable), sgen_client_vtable_get_name (vtable));
419 describe_pointer (ptr, FALSE);
424 missing_remset_spew (char *obj, char **slot)
427 GCVTable vtable = LOAD_VTABLE ((GCObject*)obj);
429 SGEN_LOG (0, "Oldspace->newspace reference %p at offset %zd in object %p (%s.%s) not found in remsets.",
430 ptr, (char*)slot - obj, obj,
431 sgen_client_vtable_get_namespace (vtable), sgen_client_vtable_get_name (vtable));
437 FIXME Flag missing remsets due to pinning as non fatal
440 #define HANDLE_PTR(ptr,obj) do { \
441 if (*(char**)ptr) { \
442 if (!is_valid_object_pointer (*(char**)ptr)) { \
443 bad_pointer_spew ((char*)obj, (char**)ptr); \
444 } else if (!sgen_ptr_in_nursery (obj) && sgen_ptr_in_nursery ((char*)*ptr)) { \
445 if (!sgen_get_remset ()->find_address ((char*)(ptr)) && !sgen_cement_lookup (*(ptr)) && (!allow_missing_pinned || !SGEN_OBJECT_IS_PINNED (*(ptr)))) \
446 missing_remset_spew ((char*)obj, (char**)ptr); \
452 verify_object_pointers_callback (GCObject *obj, size_t size, void *data)
454 char *start = (char*)obj;
455 gboolean allow_missing_pinned = (gboolean) (size_t) data;
456 SgenDescriptor desc = sgen_obj_get_descriptor (obj);
458 #include "sgen-scan-object.h"
463 -This heap checker is racy regarding inlined write barriers and other JIT tricks that
464 depend on OP_DUMMY_USE.
467 sgen_check_whole_heap (gboolean allow_missing_pinned)
469 setup_valid_nursery_objects ();
472 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data, verify_object_pointers_callback, (void*) (size_t) allow_missing_pinned, FALSE, TRUE);
473 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, verify_object_pointers_callback, (void*) (size_t) allow_missing_pinned);
474 sgen_los_iterate_objects (verify_object_pointers_callback, (void*) (size_t) allow_missing_pinned);
476 g_assert (!broken_heap);
480 ptr_in_heap (char *object)
482 if (sgen_ptr_in_nursery (object))
485 if (sgen_los_is_valid_object (object))
488 if (major_collector.is_valid_object (object))
495 * Do consistency checks on the object reference OBJ. Assert on failure.
498 sgen_check_objref (char *obj)
500 g_assert (ptr_in_heap (obj));
504 find_pinning_ref_from_thread (char *obj, size_t size)
506 #ifndef SGEN_WITHOUT_MONO
508 char *endobj = obj + size;
510 FOREACH_THREAD (info) {
511 char **start = (char**)info->client_info.stack_start;
512 if (info->client_info.skip || info->client_info.gc_disabled)
514 while (start < (char**)info->client_info.stack_end) {
515 if (*start >= obj && *start < endobj)
516 SGEN_LOG (0, "Object %p referenced in thread %p (id %p) at %p, stack: %p-%p", obj, info, (gpointer)mono_thread_info_get_tid (info), start, info->client_info.stack_start, info->client_info.stack_end);
520 for (j = 0; j < ARCH_NUM_REGS; ++j) {
522 mword w = ((mword*)&info->client_info.ctx) [j];
524 mword w = (mword)&info->client_info.regs [j];
527 if (w >= (mword)obj && w < (mword)obj + size)
528 SGEN_LOG (0, "Object %p referenced in saved reg %d of thread %p (id %p)", obj, j, info, (gpointer)mono_thread_info_get_tid (info));
535 * Debugging function: find in the conservative roots where @obj is being pinned.
537 static G_GNUC_UNUSED void
538 find_pinning_reference (char *obj, size_t size)
542 char *endobj = obj + size;
544 SGEN_HASH_TABLE_FOREACH (&roots_hash [ROOT_TYPE_NORMAL], char **, start, RootRecord *, root) {
545 /* if desc is non-null it has precise info */
546 if (!root->root_desc) {
547 while (start < (char**)root->end_root) {
548 if (*start >= obj && *start < endobj) {
549 SGEN_LOG (0, "Object %p referenced in pinned roots %p-%p\n", obj, start, root->end_root);
554 } SGEN_HASH_TABLE_FOREACH_END;
556 find_pinning_ref_from_thread (obj, size);
560 #define HANDLE_PTR(ptr,obj) do { \
561 char* __target = *(char**)ptr; \
563 if (sgen_ptr_in_nursery (__target)) { \
564 g_assert (!SGEN_OBJECT_IS_FORWARDED (__target)); \
566 mword __size = sgen_safe_object_get_size ((GCObject*)__target); \
567 if (__size <= SGEN_MAX_SMALL_OBJ_SIZE) \
568 g_assert (major_collector.is_object_live ((GCObject*)__target)); \
570 g_assert (sgen_los_object_is_pinned ((GCObject*)__target)); \
576 check_marked_callback (GCObject *obj, size_t size, void *dummy)
578 char *start = (char*)obj;
579 gboolean flag = (gboolean) (size_t) dummy;
582 if (sgen_ptr_in_nursery (start)) {
584 SGEN_ASSERT (0, SGEN_OBJECT_IS_PINNED (obj), "All objects remaining in the nursery must be pinned");
586 if (!sgen_los_object_is_pinned (obj))
589 if (!major_collector.is_object_live (obj))
593 desc = sgen_obj_get_descriptor_safe (obj);
595 #include "sgen-scan-object.h"
599 sgen_check_heap_marked (gboolean nursery_must_be_pinned)
601 setup_valid_nursery_objects ();
603 iterate_valid_nursery_objects (check_marked_callback, (void*)(size_t)nursery_must_be_pinned);
604 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, check_marked_callback, (void*)FALSE);
605 sgen_los_iterate_objects (check_marked_callback, (void*)TRUE);
609 check_nursery_objects_pinned_callback (char *obj, size_t size, void *data /* ScanCopyContext *ctx */)
611 gboolean pinned = (gboolean) (size_t) data;
613 g_assert (!SGEN_OBJECT_IS_FORWARDED (obj));
615 g_assert (SGEN_OBJECT_IS_PINNED (obj));
617 g_assert (!SGEN_OBJECT_IS_PINNED (obj));
621 sgen_check_nursery_objects_pinned (gboolean pinned)
623 sgen_clear_nursery_fragments ();
624 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
625 (IterateObjectCallbackFunc)check_nursery_objects_pinned_callback, (void*) (size_t) pinned /* (void*)&ctx */, FALSE, TRUE);
629 verify_scan_starts (char *start, char *end)
633 for (i = 0; i < nursery_section->num_scan_start; ++i) {
634 char *addr = nursery_section->scan_starts [i];
635 if (addr > start && addr < end)
636 SGEN_LOG (0, "NFC-BAD SCAN START [%zu] %p for obj [%p %p]", i, addr, start, end);
641 sgen_debug_verify_nursery (gboolean do_dump_nursery_content)
643 char *start, *end, *cur, *hole_start;
645 if (nursery_canaries_enabled ())
646 SGEN_LOG (0, "Checking nursery canaries...");
648 /*This cleans up unused fragments */
649 sgen_nursery_allocator_prepare_for_pinning ();
651 hole_start = start = cur = sgen_get_nursery_start ();
652 end = sgen_get_nursery_end ();
656 gboolean is_array_fill;
659 cur += sizeof (void*);
663 if (object_is_forwarded (cur))
664 SGEN_LOG (0, "FORWARDED OBJ %p", cur);
665 else if (object_is_pinned (cur))
666 SGEN_LOG (0, "PINNED OBJ %p", cur);
668 ss = safe_object_get_size ((GCObject*)cur);
669 size = SGEN_ALIGN_UP (ss);
670 verify_scan_starts (cur, cur + size);
671 is_array_fill = sgen_client_object_is_array_fill ((GCObject*)cur);
672 if (do_dump_nursery_content) {
673 GCVTable vtable = SGEN_LOAD_VTABLE ((GCObject*)cur);
674 if (cur > hole_start)
675 SGEN_LOG (0, "HOLE [%p %p %d]", hole_start, cur, (int)(cur - hole_start));
676 SGEN_LOG (0, "OBJ [%p %p %d %d %s.%s %d]", cur, cur + size, (int)size, (int)ss,
677 sgen_client_vtable_get_namespace (vtable), sgen_client_vtable_get_name (vtable),
680 if (nursery_canaries_enabled () && !is_array_fill) {
681 CHECK_CANARY_FOR_OBJECT ((GCObject*)cur, TRUE);
682 CANARIFY_SIZE (size);
690 * Checks that no objects in the nursery are fowarded or pinned. This
691 * is a precondition to restarting the mutator while doing a
692 * concurrent collection. Note that we don't clear fragments because
693 * we depend on that having happened earlier.
696 sgen_debug_check_nursery_is_clean (void)
700 cur = sgen_get_nursery_start ();
701 end = sgen_get_nursery_end ();
707 cur += sizeof (void*);
711 g_assert (!object_is_forwarded (cur));
712 g_assert (!object_is_pinned (cur));
714 size = SGEN_ALIGN_UP (safe_object_get_size ((GCObject*)cur));
715 verify_scan_starts (cur, cur + size);
721 static gboolean scan_object_for_specific_ref_precise = TRUE;
724 #define HANDLE_PTR(ptr,obj) do { \
725 if ((GCObject*)*(ptr) == key) { \
726 GCVTable vtable = SGEN_LOAD_VTABLE (*(ptr)); \
727 g_print ("found ref to %p in object %p (%s.%s) at offset %zd\n", \
728 key, (obj), sgen_client_vtable_get_namespace (vtable), sgen_client_vtable_get_name (vtable), ((char*)(ptr) - (char*)(obj))); \
733 scan_object_for_specific_ref (GCObject *obj, GCObject *key)
737 if ((forwarded = SGEN_OBJECT_IS_FORWARDED (obj)))
740 if (scan_object_for_specific_ref_precise) {
741 char *start = (char*)obj;
742 SgenDescriptor desc = sgen_obj_get_descriptor_safe (obj);
743 #include "sgen-scan-object.h"
745 mword *words = (mword*)obj;
746 size_t size = safe_object_get_size (obj);
748 for (i = 0; i < size / sizeof (mword); ++i) {
749 if (words [i] == (mword)key) {
750 GCVTable vtable = SGEN_LOAD_VTABLE (obj);
751 g_print ("found possible ref to %p in object %p (%s.%s) at offset %zd\n",
752 key, obj, sgen_client_vtable_get_namespace (vtable), sgen_client_vtable_get_name (vtable), i * sizeof (mword));
759 scan_object_for_specific_ref_callback (GCObject *obj, size_t size, GCObject *key)
761 scan_object_for_specific_ref (obj, key);
765 check_root_obj_specific_ref (RootRecord *root, GCObject *key, GCObject *obj)
769 g_print ("found ref to %p in root record %p\n", key, root);
772 static GCObject *check_key = NULL;
773 static RootRecord *check_root = NULL;
776 check_root_obj_specific_ref_from_marker (GCObject **obj, void *gc_data)
778 check_root_obj_specific_ref (check_root, check_key, *obj);
782 scan_roots_for_specific_ref (GCObject *key, int root_type)
788 SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], void **, start_root, RootRecord *, root) {
789 SgenDescriptor desc = root->root_desc;
793 switch (desc & ROOT_DESC_TYPE_MASK) {
794 case ROOT_DESC_BITMAP:
795 desc >>= ROOT_DESC_TYPE_SHIFT;
798 check_root_obj_specific_ref (root, key, (GCObject *)*start_root);
803 case ROOT_DESC_COMPLEX: {
804 gsize *bitmap_data = (gsize *)sgen_get_complex_descriptor_bitmap (desc);
805 int bwords = (int) ((*bitmap_data) - 1);
806 void **start_run = start_root;
808 while (bwords-- > 0) {
809 gsize bmap = *bitmap_data++;
810 void **objptr = start_run;
813 check_root_obj_specific_ref (root, key, (GCObject *)*objptr);
817 start_run += GC_BITS_PER_WORD;
821 case ROOT_DESC_USER: {
822 SgenUserRootMarkFunc marker = sgen_get_user_descriptor_func (desc);
823 marker (start_root, check_root_obj_specific_ref_from_marker, NULL);
826 case ROOT_DESC_RUN_LEN:
827 g_assert_not_reached ();
829 g_assert_not_reached ();
831 } SGEN_HASH_TABLE_FOREACH_END;
838 mono_gc_scan_for_specific_ref (GCObject *key, gboolean precise)
843 scan_object_for_specific_ref_precise = precise;
845 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
846 (IterateObjectCallbackFunc)scan_object_for_specific_ref_callback, key, TRUE, FALSE);
848 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, (IterateObjectCallbackFunc)scan_object_for_specific_ref_callback, key);
850 sgen_los_iterate_objects ((IterateObjectCallbackFunc)scan_object_for_specific_ref_callback, key);
852 scan_roots_for_specific_ref (key, ROOT_TYPE_NORMAL);
853 scan_roots_for_specific_ref (key, ROOT_TYPE_WBARRIER);
855 SGEN_HASH_TABLE_FOREACH (&roots_hash [ROOT_TYPE_PINNED], void **, ptr, RootRecord *, root) {
856 while (ptr < (void**)root->end_root) {
857 check_root_obj_specific_ref (root, (GCObject *)*ptr, key);
860 } SGEN_HASH_TABLE_FOREACH_END;
862 if (sgen_is_world_stopped ())
863 find_pinning_ref_from_thread ((char*)key, sizeof (GCObject));
866 #ifndef SGEN_WITHOUT_MONO
868 static MonoDomain *check_domain = NULL;
871 check_obj_not_in_domain (MonoObject **o)
873 g_assert (((*o))->vtable->domain != check_domain);
878 check_obj_not_in_domain_callback (GCObject **o, void *gc_data)
880 g_assert ((*o)->vtable->domain != check_domain);
884 sgen_scan_for_registered_roots_in_domain (MonoDomain *domain, int root_type)
888 check_domain = domain;
889 SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], void **, start_root, RootRecord *, root) {
890 SgenDescriptor desc = root->root_desc;
892 /* The MonoDomain struct is allowed to hold
893 references to objects in its own domain. */
894 if (start_root == (void**)domain)
897 switch (desc & ROOT_DESC_TYPE_MASK) {
898 case ROOT_DESC_BITMAP:
899 desc >>= ROOT_DESC_TYPE_SHIFT;
901 if ((desc & 1) && *start_root)
902 check_obj_not_in_domain ((MonoObject **)*start_root);
907 case ROOT_DESC_COMPLEX: {
908 gsize *bitmap_data = (gsize *)sgen_get_complex_descriptor_bitmap (desc);
909 int bwords = (int)((*bitmap_data) - 1);
910 void **start_run = start_root;
912 while (bwords-- > 0) {
913 gsize bmap = *bitmap_data++;
914 void **objptr = start_run;
916 if ((bmap & 1) && *objptr)
917 check_obj_not_in_domain ((MonoObject **)*objptr);
921 start_run += GC_BITS_PER_WORD;
925 case ROOT_DESC_USER: {
926 SgenUserRootMarkFunc marker = sgen_get_user_descriptor_func (desc);
927 marker (start_root, check_obj_not_in_domain_callback, NULL);
930 case ROOT_DESC_RUN_LEN:
931 g_assert_not_reached ();
933 g_assert_not_reached ();
935 } SGEN_HASH_TABLE_FOREACH_END;
941 is_xdomain_ref_allowed (GCObject **ptr, GCObject *obj, MonoDomain *domain)
943 MonoObject *o = (MonoObject*)(obj);
944 MonoObject *ref = *ptr;
945 size_t offset = (char*)(ptr) - (char*)o;
947 if (o->vtable->klass == mono_defaults.thread_class && offset == G_STRUCT_OFFSET (MonoThread, internal_thread))
949 if (o->vtable->klass == mono_defaults.internal_thread_class && offset == G_STRUCT_OFFSET (MonoInternalThread, current_appcontext))
952 #ifndef DISABLE_REMOTING
953 if (mono_defaults.real_proxy_class->supertypes && mono_class_has_parent_fast (o->vtable->klass, mono_defaults.real_proxy_class) &&
954 offset == G_STRUCT_OFFSET (MonoRealProxy, unwrapped_server))
957 /* Thread.cached_culture_info */
958 if (!strcmp (ref->vtable->klass->name_space, "System.Globalization") &&
959 !strcmp (ref->vtable->klass->name, "CultureInfo") &&
960 !strcmp(o->vtable->klass->name_space, "System") &&
961 !strcmp(o->vtable->klass->name, "Object[]"))
964 * at System.IO.MemoryStream.InternalConstructor (byte[],int,int,bool,bool) [0x0004d] in /home/schani/Work/novell/trunk/mcs/class/corlib/System.IO/MemoryStream.cs:121
965 * at System.IO.MemoryStream..ctor (byte[]) [0x00017] in /home/schani/Work/novell/trunk/mcs/class/corlib/System.IO/MemoryStream.cs:81
966 * at (wrapper remoting-invoke-with-check) System.IO.MemoryStream..ctor (byte[]) <IL 0x00020, 0xffffffff>
967 * at System.Runtime.Remoting.Messaging.CADMethodCallMessage.GetArguments () [0x0000d] in /home/schani/Work/novell/trunk/mcs/class/corlib/System.Runtime.Remoting.Messaging/CADMessages.cs:327
968 * at System.Runtime.Remoting.Messaging.MethodCall..ctor (System.Runtime.Remoting.Messaging.CADMethodCallMessage) [0x00017] in /home/schani/Work/novell/trunk/mcs/class/corlib/System.Runtime.Remoting.Messaging/MethodCall.cs:87
969 * at System.AppDomain.ProcessMessageInDomain (byte[],System.Runtime.Remoting.Messaging.CADMethodCallMessage,byte[]&,System.Runtime.Remoting.Messaging.CADMethodReturnMessage&) [0x00018] in /home/schani/Work/novell/trunk/mcs/class/corlib/System/AppDomain.cs:1213
970 * at (wrapper remoting-invoke-with-check) System.AppDomain.ProcessMessageInDomain (byte[],System.Runtime.Remoting.Messaging.CADMethodCallMessage,byte[]&,System.Runtime.Remoting.Messaging.CADMethodReturnMessage&) <IL 0x0003d, 0xffffffff>
971 * at System.Runtime.Remoting.Channels.CrossAppDomainSink.ProcessMessageInDomain (byte[],System.Runtime.Remoting.Messaging.CADMethodCallMessage) [0x00008] in /home/schani/Work/novell/trunk/mcs/class/corlib/System.Runtime.Remoting.Channels/CrossAppDomainChannel.cs:198
972 * at (wrapper runtime-invoke) object.runtime_invoke_CrossAppDomainSink/ProcessMessageRes_object_object (object,intptr,intptr,intptr) <IL 0x0004c, 0xffffffff>
974 if (!strcmp (ref->vtable->klass->name_space, "System") &&
975 !strcmp (ref->vtable->klass->name, "Byte[]") &&
976 !strcmp (o->vtable->klass->name_space, "System.IO") &&
977 !strcmp (o->vtable->klass->name, "MemoryStream"))
983 check_reference_for_xdomain (GCObject **ptr, GCObject *obj, MonoDomain *domain)
985 MonoObject *ref = *ptr;
986 size_t offset = (char*)(ptr) - (char*)obj;
988 MonoClassField *field;
991 if (!ref || ref->vtable->domain == domain)
993 if (is_xdomain_ref_allowed (ptr, obj, domain))
997 for (klass = obj->vtable->klass; klass; klass = klass->parent) {
1000 for (i = 0; i < klass->field.count; ++i) {
1001 if (klass->fields[i].offset == offset) {
1002 field = &klass->fields[i];
1010 if (ref->vtable->klass == mono_defaults.string_class)
1011 str = mono_string_to_utf8 ((MonoString*)ref);
1014 g_print ("xdomain reference in %p (%s.%s) at offset %d (%s) to %p (%s.%s) (%s) - pointed to by:\n",
1015 obj, obj->vtable->klass->name_space, obj->vtable->klass->name,
1016 offset, field ? field->name : "",
1017 ref, ref->vtable->klass->name_space, ref->vtable->klass->name, str ? str : "");
1018 mono_gc_scan_for_specific_ref (obj, TRUE);
1024 #define HANDLE_PTR(ptr,obj) check_reference_for_xdomain ((ptr), (obj), domain)
1027 scan_object_for_xdomain_refs (GCObject *obj, mword size, void *data)
1029 char *start = (char*)obj;
1030 MonoVTable *vt = SGEN_LOAD_VTABLE (obj);
1031 MonoDomain *domain = vt->domain;
1032 SgenDescriptor desc = sgen_vtable_get_descriptor (vt);
1034 #include "sgen-scan-object.h"
1038 sgen_check_for_xdomain_refs (void)
1042 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
1043 (IterateObjectCallbackFunc)scan_object_for_xdomain_refs, NULL, FALSE, TRUE);
1045 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, (IterateObjectCallbackFunc)scan_object_for_xdomain_refs, NULL);
1047 for (bigobj = los_object_list; bigobj; bigobj = bigobj->next)
1048 scan_object_for_xdomain_refs ((GCObject*)bigobj->data, sgen_los_object_size (bigobj), NULL);
1053 /* If not null, dump the heap after each collection into this file */
1054 static FILE *heap_dump_file = NULL;
1057 sgen_dump_occupied (char *start, char *end, char *section_start)
1059 fprintf (heap_dump_file, "<occupied offset=\"%zd\" size=\"%zd\"/>\n", start - section_start, end - start);
1063 sgen_dump_section (GCMemSection *section, const char *type)
1065 char *start = section->data;
1066 char *end = section->data + section->size;
1067 char *occ_start = NULL;
1069 fprintf (heap_dump_file, "<section type=\"%s\" size=\"%lu\">\n", type, (unsigned long)section->size);
1071 while (start < end) {
1076 if (!*(void**)start) {
1078 sgen_dump_occupied (occ_start, start, section->data);
1081 start += sizeof (void*); /* should be ALLOC_ALIGN, really */
1084 g_assert (start < section->next_data);
1089 //vt = SGEN_LOAD_VTABLE (start);
1090 //class = vt->klass;
1092 size = SGEN_ALIGN_UP (safe_object_get_size ((GCObject*) start));
1095 fprintf (heap_dump_file, "<object offset=\"%d\" class=\"%s.%s\" size=\"%d\"/>\n",
1096 start - section->data,
1097 vt->klass->name_space, vt->klass->name,
1104 sgen_dump_occupied (occ_start, start, section->data);
1106 fprintf (heap_dump_file, "</section>\n");
1110 dump_object (GCObject *obj, gboolean dump_location)
1112 #ifndef SGEN_WITHOUT_MONO
1113 static char class_name [1024];
1115 MonoClass *klass = mono_object_class (obj);
1119 * Python's XML parser is too stupid to parse angle brackets
1120 * in strings, so we just ignore them;
1123 while (klass->name [i] && j < sizeof (class_name) - 1) {
1124 if (!strchr ("<>\"", klass->name [i]))
1125 class_name [j++] = klass->name [i];
1128 g_assert (j < sizeof (class_name));
1131 fprintf (heap_dump_file, "<object class=\"%s.%s\" size=\"%zd\"",
1132 klass->name_space, class_name,
1133 safe_object_get_size (obj));
1134 if (dump_location) {
1135 const char *location;
1136 if (sgen_ptr_in_nursery (obj))
1137 location = "nursery";
1138 else if (safe_object_get_size (obj) <= SGEN_MAX_SMALL_OBJ_SIZE)
1142 fprintf (heap_dump_file, " location=\"%s\"", location);
1144 fprintf (heap_dump_file, "/>\n");
1149 sgen_debug_enable_heap_dump (const char *filename)
1151 heap_dump_file = fopen (filename, "w");
1152 if (heap_dump_file) {
1153 fprintf (heap_dump_file, "<sgen-dump>\n");
1154 sgen_pin_stats_enable ();
1159 sgen_debug_dump_heap (const char *type, int num, const char *reason)
1161 SgenPointerQueue *pinned_objects;
1165 if (!heap_dump_file)
1168 fprintf (heap_dump_file, "<collection type=\"%s\" num=\"%d\"", type, num);
1170 fprintf (heap_dump_file, " reason=\"%s\"", reason);
1171 fprintf (heap_dump_file, ">\n");
1172 #ifndef SGEN_WITHOUT_MONO
1173 fprintf (heap_dump_file, "<other-mem-usage type=\"mempools\" size=\"%ld\"/>\n", mono_mempool_get_bytes_allocated ());
1175 sgen_dump_internal_mem_usage (heap_dump_file);
1176 fprintf (heap_dump_file, "<pinned type=\"stack\" bytes=\"%zu\"/>\n", sgen_pin_stats_get_pinned_byte_count (PIN_TYPE_STACK));
1177 /* fprintf (heap_dump_file, "<pinned type=\"static-data\" bytes=\"%d\"/>\n", pinned_byte_counts [PIN_TYPE_STATIC_DATA]); */
1178 fprintf (heap_dump_file, "<pinned type=\"other\" bytes=\"%zu\"/>\n", sgen_pin_stats_get_pinned_byte_count (PIN_TYPE_OTHER));
1180 fprintf (heap_dump_file, "<pinned-objects>\n");
1181 pinned_objects = sgen_pin_stats_get_object_list ();
1182 for (i = 0; i < pinned_objects->next_slot; ++i)
1183 dump_object ((GCObject *)pinned_objects->data [i], TRUE);
1184 fprintf (heap_dump_file, "</pinned-objects>\n");
1186 sgen_dump_section (nursery_section, "nursery");
1188 major_collector.dump_heap (heap_dump_file);
1190 fprintf (heap_dump_file, "<los>\n");
1191 for (bigobj = los_object_list; bigobj; bigobj = bigobj->next)
1192 dump_object ((GCObject*)bigobj->data, FALSE);
1193 fprintf (heap_dump_file, "</los>\n");
1195 fprintf (heap_dump_file, "</collection>\n");
1198 static GCObject *found_obj;
1201 find_object_for_ptr_callback (GCObject *obj, size_t size, void *user_data)
1203 char *ptr = (char *)user_data;
1205 if (ptr >= (char*)obj && ptr < (char*)obj + size) {
1206 g_assert (!found_obj);
1211 /* for use in the debugger */
1213 sgen_find_object_for_ptr (char *ptr)
1215 if (ptr >= nursery_section->data && ptr < nursery_section->end_data) {
1217 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
1218 find_object_for_ptr_callback, ptr, TRUE, FALSE);
1224 sgen_los_iterate_objects (find_object_for_ptr_callback, ptr);
1229 * Very inefficient, but this is debugging code, supposed to
1230 * be called from gdb, so we don't care.
1233 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, find_object_for_ptr_callback, ptr);
1237 #endif /*HAVE_SGEN_GC*/