mono/sgen/sgen-debug.c

   1 /*
   2  * sgen-debug.c: Collector debugging
   3  *
   4  * Author:
   5  *      Paolo Molaro (lupus@ximian.com)
   6  *  Rodrigo Kumpera (kumpera@gmail.com)
   7  *
   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
  12  *
  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;
  16  *
  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.
  21  *
  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.
  25  */
  26
  27 #include "config.h"
  28 #ifdef HAVE_SGEN_GC
  29
  30 #include <string.h>
  31
  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"
  38
  39 #define LOAD_VTABLE     SGEN_LOAD_VTABLE
  40
  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
  44
  45 void describe_ptr (char *ptr);
  46 void check_object (GCObject *obj);
  47
  48 /*
  49  * ######################################################################
  50  * ########  Collector debugging
  51  * ######################################################################
  52  */
  53
  54 static const char*descriptor_types [] = {
  55         "INVALID",
  56         "run length",
  57         "bitmap",
  58         "small pointer-free",
  59         "complex",
  60         "vector",
  61         "complex arrray",
  62         "complex pointer-free"
  63 };
  64
  65 static char* describe_nursery_ptr (char *ptr, gboolean need_setup);
  66
  67 static void
  68 describe_pointer (char *ptr, gboolean need_setup)
  69 {
  70         GCVTable vtable;
  71         SgenDescriptor desc;
  72         int type;
  73         char *start;
  74         char *forwarded;
  75         mword size;
  76
  77  restart:
  78         if (sgen_ptr_in_nursery (ptr)) {
  79                 start = describe_nursery_ptr (ptr, need_setup);
  80                 if (!start)
  81                         return;
  82                 ptr = start;
  83                 vtable = LOAD_VTABLE ((GCObject*)ptr);
  84         } else {
  85                 if (sgen_ptr_is_in_los (ptr, &start)) {
  86                         if (ptr == start)
  87                                 printf ("Pointer is the start of object %p in LOS space.\n", start);
  88                         else
  89                                 printf ("Pointer is at offset 0x%x of object %p in LOS space.\n", (int)(ptr - start), start);
  90                         ptr = 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)) {
  94                         if (ptr == start)
  95                                 printf ("Pointer is the start of object %p in oldspace.\n", start);
  96                         else if (start)
  97                                 printf ("Pointer is at offset 0x%x of object %p in oldspace.\n", (int)(ptr - start), start);
  98                         else
  99                                 printf ("Pointer inside oldspace.\n");
 100                         if (start)
 101                                 ptr = start;
 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);
 107                 } else {
 108                         printf ("Pointer unknown.\n");
 109                         return;
 110                 }
 111         }
 112
 113         if (object_is_pinned (ptr))
 114                 printf ("Object is pinned.\n");
 115
 116         if ((forwarded = (char *)object_is_forwarded (ptr))) {
 117                 printf ("Object is forwarded to %p:\n", forwarded);
 118                 ptr = forwarded;
 119                 goto restart;
 120         }
 121
 122         printf ("VTable: %p\n", vtable);
 123         if (vtable == NULL) {
 124                 printf ("VTable is invalid (empty).\n");
 125                 goto invalid_vtable;
 126         }
 127         if (sgen_ptr_in_nursery (vtable)) {
 128                 printf ("VTable is invalid (points inside nursery).\n");
 129                 goto invalid_vtable;
 130         }
 131         printf ("Class: %s.%s\n", sgen_client_vtable_get_namespace (vtable), sgen_client_vtable_get_name (vtable));
 132
 133         desc = sgen_vtable_get_descriptor (vtable);
 134         printf ("Descriptor: %lx\n", (long)desc);
 135
 136         type = desc & DESC_TYPE_MASK;
 137         printf ("Descriptor type: %d (%s)\n", type, descriptor_types [type]);
 138
 139         size = sgen_safe_object_get_size ((GCObject*)ptr);
 140         printf ("Size: %d\n", (int)size);
 141
 142  invalid_vtable:
 143         ;
 144         sgen_client_describe_invalid_pointer ((GCObject *) ptr);
 145 }
 146
 147 void
 148 describe_ptr (char *ptr)
 149 {
 150         describe_pointer (ptr, TRUE);
 151 }
 152
 153 static gboolean missing_remsets;
 154
 155 /*
 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.
 160  */
 161 #undef HANDLE_PTR
 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;                                                                 \
 170                 }                                                                                                                               \
 171         }                                                                                                                                       \
 172         } while (0)
 173
 174 /*
 175  * Check that each object reference which points into the nursery can
 176  * be found in the remembered sets.
 177  */
 178 static void
 179 check_consistency_callback (GCObject *obj, size_t size, void *dummy)
 180 {
 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));
 185
 186 #include "sgen-scan-object.h"
 187 }
 188
 189 /*
 190  * Perform consistency check of the heap.
 191  *
 192  * Assumes the world is stopped.
 193  */
 194 void
 195 sgen_check_consistency (void)
 196 {
 197         // Need to add more checks
 198
 199         missing_remsets = FALSE;
 200
 201         SGEN_LOG (1, "Begin heap consistency check...");
 202
 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);
 205
 206         sgen_los_iterate_objects ((IterateObjectCallbackFunc)check_consistency_callback, NULL);
 207
 208         SGEN_LOG (1, "Heap consistency check done.");
 209
 210         if (!binary_protocol_is_enabled ())
 211                 g_assert (!missing_remsets);
 212 }
 213
 214 static gboolean
 215 is_major_or_los_object_marked (GCObject *obj)
 216 {
 217         if (sgen_safe_object_get_size ((GCObject*)obj) > SGEN_MAX_SMALL_OBJ_SIZE) {
 218                 return sgen_los_object_is_pinned (obj);
 219         } else {
 220                 return sgen_get_major_collector ()->is_object_live (obj);
 221         }
 222 }
 223
 224 #undef HANDLE_PTR
 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;                         \
 232                 }                                                                                                                               \
 233         }                                                                                                                                       \
 234         } while (0)
 235
 236 static void
 237 check_mod_union_callback (GCObject *obj, size_t size, void *dummy)
 238 {
 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);
 243         guint8 *cards;
 244         SGEN_LOG (8, "Scanning object %p, vtable: %p (%s)", obj, vt, sgen_client_vtable_get_name (vt));
 245
 246         if (!is_major_or_los_object_marked (obj))
 247                 return;
 248
 249         if (in_los)
 250                 cards = sgen_los_header_for_object (obj)->cardtable_mod_union;
 251         else
 252                 cards = sgen_get_major_collector ()->get_cardtable_mod_union_for_reference (start);
 253
 254         SGEN_ASSERT (0, cards, "we must have mod union for marked major objects");
 255
 256 #include "sgen-scan-object.h"
 257 }
 258
 259 void
 260 sgen_check_mod_union_consistency (void)
 261 {
 262         missing_remsets = FALSE;
 263
 264         major_collector.iterate_objects (ITERATE_OBJECTS_ALL, (IterateObjectCallbackFunc)check_mod_union_callback, (void*)FALSE);
 265
 266         sgen_los_iterate_objects ((IterateObjectCallbackFunc)check_mod_union_callback, (void*)TRUE);
 267
 268         if (!binary_protocol_is_enabled ())
 269                 g_assert (!missing_remsets);
 270 }
 271
 272 #undef HANDLE_PTR
 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)); \
 276         } while (0)
 277
 278 static void
 279 check_major_refs_callback (GCObject *obj, size_t size, void *dummy)
 280 {
 281         char *start = (char*)obj;
 282         SgenDescriptor desc = sgen_obj_get_descriptor (obj);
 283
 284 #include "sgen-scan-object.h"
 285 }
 286
 287 void
 288 sgen_check_major_refs (void)
 289 {
 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);
 292 }
 293
 294 /* Check that the reference is valid */
 295 #undef HANDLE_PTR
 296 #define HANDLE_PTR(ptr,obj)     do {    \
 297                 if (*(ptr)) {   \
 298                         g_assert (sgen_client_vtable_get_namespace (SGEN_LOAD_VTABLE_UNCHECKED (*(ptr))));      \
 299                 }       \
 300         } while (0)
 301
 302 /*
 303  * check_object:
 304  *
 305  *   Perform consistency check on an object. Currently we only check that the
 306  * reference fields are valid.
 307  */
 308 void
 309 check_object (GCObject *obj)
 310 {
 311         char *start = (char*)obj;
 312         SgenDescriptor desc;
 313
 314         if (!start)
 315                 return;
 316
 317         desc = sgen_obj_get_descriptor (obj);
 318
 319 #include "sgen-scan-object.h"
 320 }
 321
 322
 323 static GCObject **valid_nursery_objects;
 324 static int valid_nursery_object_count;
 325 static gboolean broken_heap;
 326
 327 static void
 328 setup_mono_sgen_scan_area_with_callback (GCObject *object, size_t size, void *data)
 329 {
 330         valid_nursery_objects [valid_nursery_object_count++] = object;
 331 }
 332
 333 static void
 334 setup_valid_nursery_objects (void)
 335 {
 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);
 340 }
 341
 342 static gboolean
 343 find_object_in_nursery_dump (char *object)
 344 {
 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])
 349                         return TRUE;
 350
 351                 if (object < (char*)valid_nursery_objects [middle])
 352                         last = middle;
 353                 else
 354                         first = middle + 1;
 355         }
 356         g_assert (first == last);
 357         return FALSE;
 358 }
 359
 360 static void
 361 iterate_valid_nursery_objects (IterateObjectCallbackFunc callback, void *data)
 362 {
 363         int i;
 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);
 367         }
 368 }
 369
 370 static char*
 371 describe_nursery_ptr (char *ptr, gboolean need_setup)
 372 {
 373         int i;
 374
 375         if (need_setup)
 376                 setup_valid_nursery_objects ();
 377
 378         for (i = 0; i < valid_nursery_object_count - 1; ++i) {
 379                 if ((char*)valid_nursery_objects [i + 1] > ptr)
 380                         break;
 381         }
 382
 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)");
 385                 return NULL;
 386         } else {
 387                 GCObject *obj = valid_nursery_objects [i];
 388                 if ((char*)obj == ptr)
 389                         SGEN_LOG (0, "nursery-ptr %p", obj);
 390                 else
 391                         SGEN_LOG (0, "nursery-ptr %p (interior-ptr offset %zd)", obj, ptr - (char*)obj);
 392                 return (char*)obj;
 393         }
 394 }
 395
 396 static gboolean
 397 is_valid_object_pointer (char *object)
 398 {
 399         if (sgen_ptr_in_nursery (object))
 400                 return find_object_in_nursery_dump (object);
 401
 402         if (sgen_los_is_valid_object (object))
 403                 return TRUE;
 404
 405         if (major_collector.is_valid_object (object))
 406                 return TRUE;
 407         return FALSE;
 408 }
 409
 410 static void
 411 bad_pointer_spew (char *obj, char **slot)
 412 {
 413         char *ptr = *slot;
 414         GCVTable vtable = LOAD_VTABLE ((GCObject*)obj);
 415
 416         SGEN_LOG (0, "Invalid object pointer %p at offset %zd in object %p (%s.%s):", ptr,
 417                         (char*)slot - obj,
 418                         obj, sgen_client_vtable_get_namespace (vtable), sgen_client_vtable_get_name (vtable));
 419         describe_pointer (ptr, FALSE);
 420         broken_heap = TRUE;
 421 }
 422
 423 static void
 424 missing_remset_spew (char *obj, char **slot)
 425 {
 426         char *ptr = *slot;
 427         GCVTable vtable = LOAD_VTABLE ((GCObject*)obj);
 428
 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));
 432
 433         broken_heap = TRUE;
 434 }
 435
 436 /*
 437 FIXME Flag missing remsets due to pinning as non fatal
 438 */
 439 #undef HANDLE_PTR
 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);  \
 447                         }       \
 448         } \
 449         } while (0)
 450
 451 static void
 452 verify_object_pointers_callback (GCObject *obj, size_t size, void *data)
 453 {
 454         char *start = (char*)obj;
 455         gboolean allow_missing_pinned = (gboolean) (size_t) data;
 456         SgenDescriptor desc = sgen_obj_get_descriptor (obj);
 457
 458 #include "sgen-scan-object.h"
 459 }
 460
 461 /*
 462 FIXME:
 463 -This heap checker is racy regarding inlined write barriers and other JIT tricks that
 464 depend on OP_DUMMY_USE.
 465 */
 466 void
 467 sgen_check_whole_heap (gboolean allow_missing_pinned)
 468 {
 469         setup_valid_nursery_objects ();
 470
 471         broken_heap = FALSE;
 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);
 475
 476         g_assert (!broken_heap);
 477 }
 478
 479 static gboolean
 480 ptr_in_heap (char *object)
 481 {
 482         if (sgen_ptr_in_nursery (object))
 483                 return TRUE;
 484
 485         if (sgen_los_is_valid_object (object))
 486                 return TRUE;
 487
 488         if (major_collector.is_valid_object (object))
 489                 return TRUE;
 490         return FALSE;
 491 }
 492
 493 /*
 494  * sgen_check_objref:
 495  *   Do consistency checks on the object reference OBJ. Assert on failure.
 496  */
 497 void
 498 sgen_check_objref (char *obj)
 499 {
 500         g_assert (ptr_in_heap (obj));
 501 }
 502
 503 static void
 504 find_pinning_ref_from_thread (char *obj, size_t size)
 505 {
 506 #ifndef SGEN_WITHOUT_MONO
 507         int j;
 508         char *endobj = obj + size;
 509
 510         FOREACH_THREAD (info) {
 511                 char **start = (char**)info->client_info.stack_start;
 512                 if (info->client_info.skip || info->client_info.gc_disabled)
 513                         continue;
 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);
 517                         start++;
 518                 }
 519
 520                 for (j = 0; j < ARCH_NUM_REGS; ++j) {
 521 #ifdef USE_MONO_CTX
 522                         mword w = ((mword*)&info->client_info.ctx) [j];
 523 #else
 524                         mword w = (mword)&info->client_info.regs [j];
 525 #endif
 526
 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));
 529                 }
 530         } FOREACH_THREAD_END
 531 #endif
 532 }
 533
 534 /*
 535  * Debugging function: find in the conservative roots where @obj is being pinned.
 536  */
 537 static G_GNUC_UNUSED void
 538 find_pinning_reference (char *obj, size_t size)
 539 {
 540         char **start;
 541         RootRecord *root;
 542         char *endobj = obj + size;
 543
 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);
 550                                 }
 551                                 start++;
 552                         }
 553                 }
 554         } SGEN_HASH_TABLE_FOREACH_END;
 555
 556         find_pinning_ref_from_thread (obj, size);
 557 }
 558
 559 #undef HANDLE_PTR
 560 #define HANDLE_PTR(ptr,obj)     do {                                    \
 561                 char* __target = *(char**)ptr;                          \
 562                 if (__target) {                                         \
 563                         if (sgen_ptr_in_nursery (__target)) {           \
 564                                 g_assert (!SGEN_OBJECT_IS_FORWARDED (__target)); \
 565                         } else {                                        \
 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)); \
 569                                 else                                    \
 570                                         g_assert (sgen_los_object_is_pinned ((GCObject*)__target)); \
 571                         }                                               \
 572                 }                                                       \
 573         } while (0)
 574
 575 static void
 576 check_marked_callback (GCObject *obj, size_t size, void *dummy)
 577 {
 578         char *start = (char*)obj;
 579         gboolean flag = (gboolean) (size_t) dummy;
 580         SgenDescriptor desc;
 581
 582         if (sgen_ptr_in_nursery (start)) {
 583                 if (flag)
 584                         SGEN_ASSERT (0, SGEN_OBJECT_IS_PINNED (obj), "All objects remaining in the nursery must be pinned");
 585         } else if (flag) {
 586                 if (!sgen_los_object_is_pinned (obj))
 587                         return;
 588         } else {
 589                 if (!major_collector.is_object_live (obj))
 590                         return;
 591         }
 592
 593         desc = sgen_obj_get_descriptor_safe (obj);
 594
 595 #include "sgen-scan-object.h"
 596 }
 597
 598 void
 599 sgen_check_heap_marked (gboolean nursery_must_be_pinned)
 600 {
 601         setup_valid_nursery_objects ();
 602
 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);
 606 }
 607
 608 static void
 609 check_nursery_objects_pinned_callback (char *obj, size_t size, void *data /* ScanCopyContext *ctx */)
 610 {
 611         gboolean pinned = (gboolean) (size_t) data;
 612
 613         g_assert (!SGEN_OBJECT_IS_FORWARDED (obj));
 614         if (pinned)
 615                 g_assert (SGEN_OBJECT_IS_PINNED (obj));
 616         else
 617                 g_assert (!SGEN_OBJECT_IS_PINNED (obj));
 618 }
 619
 620 void
 621 sgen_check_nursery_objects_pinned (gboolean pinned)
 622 {
 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);
 626 }
 627
 628 static void
 629 verify_scan_starts (char *start, char *end)
 630 {
 631         size_t i;
 632
 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);
 637         }
 638 }
 639
 640 void
 641 sgen_debug_verify_nursery (gboolean do_dump_nursery_content)
 642 {
 643         char *start, *end, *cur, *hole_start;
 644
 645         if (nursery_canaries_enabled ())
 646                 SGEN_LOG (0, "Checking nursery canaries...");
 647
 648         /*This cleans up unused fragments */
 649         sgen_nursery_allocator_prepare_for_pinning ();
 650
 651         hole_start = start = cur = sgen_get_nursery_start ();
 652         end = sgen_get_nursery_end ();
 653
 654         while (cur < end) {
 655                 size_t ss, size;
 656                 gboolean is_array_fill;
 657
 658                 if (!*(void**)cur) {
 659                         cur += sizeof (void*);
 660                         continue;
 661                 }
 662
 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);
 667
 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),
 678                                         is_array_fill);
 679                 }
 680                 if (nursery_canaries_enabled () && !is_array_fill) {
 681                         CHECK_CANARY_FOR_OBJECT ((GCObject*)cur, TRUE);
 682                         CANARIFY_SIZE (size);
 683                 }
 684                 cur += size;
 685                 hole_start = cur;
 686         }
 687 }
 688
 689 /*
 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.
 694  */
 695 void
 696 sgen_debug_check_nursery_is_clean (void)
 697 {
 698         char *end, *cur;
 699
 700         cur = sgen_get_nursery_start ();
 701         end = sgen_get_nursery_end ();
 702
 703         while (cur < end) {
 704                 size_t size;
 705
 706                 if (!*(void**)cur) {
 707                         cur += sizeof (void*);
 708                         continue;
 709                 }
 710
 711                 g_assert (!object_is_forwarded (cur));
 712                 g_assert (!object_is_pinned (cur));
 713
 714                 size = SGEN_ALIGN_UP (safe_object_get_size ((GCObject*)cur));
 715                 verify_scan_starts (cur, cur + size);
 716
 717                 cur += size;
 718         }
 719 }
 720
 721 static gboolean scan_object_for_specific_ref_precise = TRUE;
 722
 723 #undef HANDLE_PTR
 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))); \
 729                 }                                                       \
 730         } while (0)
 731
 732 static void
 733 scan_object_for_specific_ref (GCObject *obj, GCObject *key)
 734 {
 735         GCObject *forwarded;
 736
 737         if ((forwarded = SGEN_OBJECT_IS_FORWARDED (obj)))
 738                 obj = forwarded;
 739
 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"
 744         } else {
 745                 mword *words = (mword*)obj;
 746                 size_t size = safe_object_get_size (obj);
 747                 int i;
 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));
 753                         }
 754                 }
 755         }
 756 }
 757
 758 static void
 759 scan_object_for_specific_ref_callback (GCObject *obj, size_t size, GCObject *key)
 760 {
 761         scan_object_for_specific_ref (obj, key);
 762 }
 763
 764 static void
 765 check_root_obj_specific_ref (RootRecord *root, GCObject *key, GCObject *obj)
 766 {
 767         if (key != obj)
 768                 return;
 769         g_print ("found ref to %p in root record %p\n", key, root);
 770 }
 771
 772 static GCObject *check_key = NULL;
 773 static RootRecord *check_root = NULL;
 774
 775 static void
 776 check_root_obj_specific_ref_from_marker (GCObject **obj, void *gc_data)
 777 {
 778         check_root_obj_specific_ref (check_root, check_key, *obj);
 779 }
 780
 781 static void
 782 scan_roots_for_specific_ref (GCObject *key, int root_type)
 783 {
 784         void **start_root;
 785         RootRecord *root;
 786         check_key = key;
 787
 788         SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], void **, start_root, RootRecord *, root) {
 789                 SgenDescriptor desc = root->root_desc;
 790
 791                 check_root = root;
 792
 793                 switch (desc & ROOT_DESC_TYPE_MASK) {
 794                 case ROOT_DESC_BITMAP:
 795                         desc >>= ROOT_DESC_TYPE_SHIFT;
 796                         while (desc) {
 797                                 if (desc & 1)
 798                                         check_root_obj_specific_ref (root, key, (GCObject *)*start_root);
 799                                 desc >>= 1;
 800                                 start_root++;
 801                         }
 802                         return;
 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;
 807                         bitmap_data++;
 808                         while (bwords-- > 0) {
 809                                 gsize bmap = *bitmap_data++;
 810                                 void **objptr = start_run;
 811                                 while (bmap) {
 812                                         if (bmap & 1)
 813                                                 check_root_obj_specific_ref (root, key, (GCObject *)*objptr);
 814                                         bmap >>= 1;
 815                                         ++objptr;
 816                                 }
 817                                 start_run += GC_BITS_PER_WORD;
 818                         }
 819                         break;
 820                 }
 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);
 824                         break;
 825                 }
 826                 case ROOT_DESC_RUN_LEN:
 827                         g_assert_not_reached ();
 828                 default:
 829                         g_assert_not_reached ();
 830                 }
 831         } SGEN_HASH_TABLE_FOREACH_END;
 832
 833         check_key = NULL;
 834         check_root = NULL;
 835 }
 836
 837 void
 838 mono_gc_scan_for_specific_ref (GCObject *key, gboolean precise)
 839 {
 840         void **ptr;
 841         RootRecord *root;
 842
 843         scan_object_for_specific_ref_precise = precise;
 844
 845         sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
 846                         (IterateObjectCallbackFunc)scan_object_for_specific_ref_callback, key, TRUE, FALSE);
 847
 848         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, (IterateObjectCallbackFunc)scan_object_for_specific_ref_callback, key);
 849
 850         sgen_los_iterate_objects ((IterateObjectCallbackFunc)scan_object_for_specific_ref_callback, key);
 851
 852         scan_roots_for_specific_ref (key, ROOT_TYPE_NORMAL);
 853         scan_roots_for_specific_ref (key, ROOT_TYPE_WBARRIER);
 854
 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);
 858                         ++ptr;
 859                 }
 860         } SGEN_HASH_TABLE_FOREACH_END;
 861
 862         if (sgen_is_world_stopped ())
 863                 find_pinning_ref_from_thread ((char*)key, sizeof (GCObject));
 864 }
 865
 866 #ifndef SGEN_WITHOUT_MONO
 867
 868 static MonoDomain *check_domain = NULL;
 869
 870 static void
 871 check_obj_not_in_domain (MonoObject **o)
 872 {
 873         g_assert (((*o))->vtable->domain != check_domain);
 874 }
 875
 876
 877 static void
 878 check_obj_not_in_domain_callback (GCObject **o, void *gc_data)
 879 {
 880         g_assert ((*o)->vtable->domain != check_domain);
 881 }
 882
 883 void
 884 sgen_scan_for_registered_roots_in_domain (MonoDomain *domain, int root_type)
 885 {
 886         void **start_root;
 887         RootRecord *root;
 888         check_domain = domain;
 889         SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], void **, start_root, RootRecord *, root) {
 890                 SgenDescriptor desc = root->root_desc;
 891
 892                 /* The MonoDomain struct is allowed to hold
 893                    references to objects in its own domain. */
 894                 if (start_root == (void**)domain)
 895                         continue;
 896
 897                 switch (desc & ROOT_DESC_TYPE_MASK) {
 898                 case ROOT_DESC_BITMAP:
 899                         desc >>= ROOT_DESC_TYPE_SHIFT;
 900                         while (desc) {
 901                                 if ((desc & 1) && *start_root)
 902                                         check_obj_not_in_domain ((MonoObject **)*start_root);
 903                                 desc >>= 1;
 904                                 start_root++;
 905                         }
 906                         break;
 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;
 911                         bitmap_data++;
 912                         while (bwords-- > 0) {
 913                                 gsize bmap = *bitmap_data++;
 914                                 void **objptr = start_run;
 915                                 while (bmap) {
 916                                         if ((bmap & 1) && *objptr)
 917                                                 check_obj_not_in_domain ((MonoObject **)*objptr);
 918                                         bmap >>= 1;
 919                                         ++objptr;
 920                                 }
 921                                 start_run += GC_BITS_PER_WORD;
 922                         }
 923                         break;
 924                 }
 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);
 928                         break;
 929                 }
 930                 case ROOT_DESC_RUN_LEN:
 931                         g_assert_not_reached ();
 932                 default:
 933                         g_assert_not_reached ();
 934                 }
 935         } SGEN_HASH_TABLE_FOREACH_END;
 936
 937         check_domain = NULL;
 938 }
 939
 940 static gboolean
 941 is_xdomain_ref_allowed (GCObject **ptr, GCObject *obj, MonoDomain *domain)
 942 {
 943         MonoObject *o = (MonoObject*)(obj);
 944         MonoObject *ref = *ptr;
 945         size_t offset = (char*)(ptr) - (char*)o;
 946
 947         if (o->vtable->klass == mono_defaults.thread_class && offset == G_STRUCT_OFFSET (MonoThread, internal_thread))
 948                 return TRUE;
 949         if (o->vtable->klass == mono_defaults.internal_thread_class && offset == G_STRUCT_OFFSET (MonoInternalThread, current_appcontext))
 950                 return TRUE;
 951
 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))
 955                 return TRUE;
 956 #endif
 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[]"))
 962                 return TRUE;
 963         /*
 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>
 973          */
 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"))
 978                 return TRUE;
 979         return FALSE;
 980 }
 981
 982 static void
 983 check_reference_for_xdomain (GCObject **ptr, GCObject *obj, MonoDomain *domain)
 984 {
 985         MonoObject *ref = *ptr;
 986         size_t offset = (char*)(ptr) - (char*)obj;
 987         MonoClass *klass;
 988         MonoClassField *field;
 989         char *str;
 990
 991         if (!ref || ref->vtable->domain == domain)
 992                 return;
 993         if (is_xdomain_ref_allowed (ptr, obj, domain))
 994                 return;
 995
 996         field = NULL;
 997         for (klass = obj->vtable->klass; klass; klass = klass->parent) {
 998                 int i;
 999
1000                 for (i = 0; i < klass->field.count; ++i) {
1001                         if (klass->fields[i].offset == offset) {
1002                                 field = &klass->fields[i];
1003                                 break;
1004                         }
1005                 }
1006                 if (field)
1007                         break;
1008         }
1009
1010         if (ref->vtable->klass == mono_defaults.string_class)
1011                 str = mono_string_to_utf8 ((MonoString*)ref);
1012         else
1013                 str = NULL;
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);
1019         if (str)
1020                 g_free (str);
1021 }
1022
1023 #undef HANDLE_PTR
1024 #define HANDLE_PTR(ptr,obj)     check_reference_for_xdomain ((ptr), (obj), domain)
1025
1026 static void
1027 scan_object_for_xdomain_refs (GCObject *obj, mword size, void *data)
1028 {
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);
1033
1034         #include "sgen-scan-object.h"
1035 }
1036
1037 void
1038 sgen_check_for_xdomain_refs (void)
1039 {
1040         LOSObject *bigobj;
1041
1042         sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
1043                         (IterateObjectCallbackFunc)scan_object_for_xdomain_refs, NULL, FALSE, TRUE);
1044
1045         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, (IterateObjectCallbackFunc)scan_object_for_xdomain_refs, NULL);
1046
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);
1049 }
1050
1051 #endif
1052
1053 /* If not null, dump the heap after each collection into this file */
1054 static FILE *heap_dump_file = NULL;
1055
1056 void
1057 sgen_dump_occupied (char *start, char *end, char *section_start)
1058 {
1059         fprintf (heap_dump_file, "<occupied offset=\"%zd\" size=\"%zd\"/>\n", start - section_start, end - start);
1060 }
1061
1062 void
1063 sgen_dump_section (GCMemSection *section, const char *type)
1064 {
1065         char *start = section->data;
1066         char *end = section->data + section->size;
1067         char *occ_start = NULL;
1068
1069         fprintf (heap_dump_file, "<section type=\"%s\" size=\"%lu\">\n", type, (unsigned long)section->size);
1070
1071         while (start < end) {
1072                 guint size;
1073                 //GCVTable vt;
1074                 //MonoClass *class;
1075
1076                 if (!*(void**)start) {
1077                         if (occ_start) {
1078                                 sgen_dump_occupied (occ_start, start, section->data);
1079                                 occ_start = NULL;
1080                         }
1081                         start += sizeof (void*); /* should be ALLOC_ALIGN, really */
1082                         continue;
1083                 }
1084                 g_assert (start < section->next_data);
1085
1086                 if (!occ_start)
1087                         occ_start = start;
1088
1089                 //vt = SGEN_LOAD_VTABLE (start);
1090                 //class = vt->klass;
1091
1092                 size = SGEN_ALIGN_UP (safe_object_get_size ((GCObject*) start));
1093
1094                 /*
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,
1098                                 size);
1099                 */
1100
1101                 start += size;
1102         }
1103         if (occ_start)
1104                 sgen_dump_occupied (occ_start, start, section->data);
1105
1106         fprintf (heap_dump_file, "</section>\n");
1107 }
1108
1109 static void
1110 dump_object (GCObject *obj, gboolean dump_location)
1111 {
1112 #ifndef SGEN_WITHOUT_MONO
1113         static char class_name [1024];
1114
1115         MonoClass *klass = mono_object_class (obj);
1116         int i, j;
1117
1118         /*
1119          * Python's XML parser is too stupid to parse angle brackets
1120          * in strings, so we just ignore them;
1121          */
1122         i = j = 0;
1123         while (klass->name [i] && j < sizeof (class_name) - 1) {
1124                 if (!strchr ("<>\"", klass->name [i]))
1125                         class_name [j++] = klass->name [i];
1126                 ++i;
1127         }
1128         g_assert (j < sizeof (class_name));
1129         class_name [j] = 0;
1130
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)
1139                         location = "major";
1140                 else
1141                         location = "LOS";
1142                 fprintf (heap_dump_file, " location=\"%s\"", location);
1143         }
1144         fprintf (heap_dump_file, "/>\n");
1145 #endif
1146 }
1147
1148 void
1149 sgen_debug_enable_heap_dump (const char *filename)
1150 {
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 ();
1155         }
1156 }
1157
1158 void
1159 sgen_debug_dump_heap (const char *type, int num, const char *reason)
1160 {
1161         SgenPointerQueue *pinned_objects;
1162         LOSObject *bigobj;
1163         int i;
1164
1165         if (!heap_dump_file)
1166                 return;
1167
1168         fprintf (heap_dump_file, "<collection type=\"%s\" num=\"%d\"", type, num);
1169         if (reason)
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 ());
1174 #endif
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));
1179
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");
1185
1186         sgen_dump_section (nursery_section, "nursery");
1187
1188         major_collector.dump_heap (heap_dump_file);
1189
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");
1194
1195         fprintf (heap_dump_file, "</collection>\n");
1196 }
1197
1198 static GCObject *found_obj;
1199
1200 static void
1201 find_object_for_ptr_callback (GCObject *obj, size_t size, void *user_data)
1202 {
1203         char *ptr = (char *)user_data;
1204
1205         if (ptr >= (char*)obj && ptr < (char*)obj + size) {
1206                 g_assert (!found_obj);
1207                 found_obj = obj;
1208         }
1209 }
1210
1211 /* for use in the debugger */
1212 GCObject*
1213 sgen_find_object_for_ptr (char *ptr)
1214 {
1215         if (ptr >= nursery_section->data && ptr < nursery_section->end_data) {
1216                 found_obj = NULL;
1217                 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
1218                                 find_object_for_ptr_callback, ptr, TRUE, FALSE);
1219                 if (found_obj)
1220                         return found_obj;
1221         }
1222
1223         found_obj = NULL;
1224         sgen_los_iterate_objects (find_object_for_ptr_callback, ptr);
1225         if (found_obj)
1226                 return found_obj;
1227
1228         /*
1229          * Very inefficient, but this is debugging code, supposed to
1230          * be called from gdb, so we don't care.
1231          */
1232         found_obj = NULL;
1233         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, find_object_for_ptr_callback, ptr);
1234         return found_obj;
1235 }
1236
1237 #endif /*HAVE_SGEN_GC*/