mono/metadata/sgen-gc.h

   1 /*
   2  * sgen-gc.c: Simple generational GC.
   3  *
   4  * Copyright 2001-2003 Ximian, Inc
   5  * Copyright 2003-2010 Novell, Inc.
   6  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
   7  * Copyright (C) 2012 Xamarin Inc
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License 2.0 as published by the Free Software Foundation;
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License 2.0 along with this library; if not, write to the Free
  20  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  */
  22 #ifndef __MONO_SGENGC_H__
  23 #define __MONO_SGENGC_H__
  24
  25 /* pthread impl */
  26 #include "config.h"
  27
  28 #ifdef HAVE_SGEN_GC
  29
  30 typedef struct _SgenThreadInfo SgenThreadInfo;
  31 #undef THREAD_INFO_TYPE
  32 #define THREAD_INFO_TYPE SgenThreadInfo
  33
  34 #include <glib.h>
  35 #ifdef HAVE_PTHREAD_H
  36 #include <pthread.h>
  37 #endif
  38 #include <mono/utils/mono-compiler.h>
  39 #include <mono/utils/atomic.h>
  40 #include <mono/utils/mono-mutex.h>
  41 #include <mono/metadata/sgen-conf.h>
  42 #include <mono/metadata/sgen-archdep.h>
  43 #include <mono/metadata/sgen-descriptor.h>
  44 #include <mono/metadata/sgen-gray.h>
  45 #include <mono/metadata/sgen-hash-table.h>
  46 #include <mono/metadata/sgen-bridge.h>
  47 #include <mono/metadata/sgen-protocol.h>
  48
  49 /* The method used to clear the nursery */
  50 /* Clearing at nursery collections is the safest, but has bad interactions with caches.
  51  * Clearing at TLAB creation is much faster, but more complex and it might expose hard
  52  * to find bugs.
  53  */
  54 typedef enum {
  55         CLEAR_AT_GC,
  56         CLEAR_AT_TLAB_CREATION,
  57         CLEAR_AT_TLAB_CREATION_DEBUG
  58 } NurseryClearPolicy;
  59
  60 NurseryClearPolicy sgen_get_nursery_clear_policy (void);
  61
  62 #define SGEN_TV_DECLARE(name) gint64 name
  63 #define SGEN_TV_GETTIME(tv) tv = mono_100ns_ticks ()
  64 #define SGEN_TV_ELAPSED(start,end) (int)((end-start))
  65
  66 #if !defined(__MACH__) && !MONO_MACH_ARCH_SUPPORTED && defined(HAVE_PTHREAD_KILL)
  67 #define SGEN_POSIX_STW 1
  68 #endif
  69
  70 /*
  71  * The nursery section uses this struct.
  72  */
  73 typedef struct _GCMemSection GCMemSection;
  74 struct _GCMemSection {
  75         char *data;
  76         mword size;
  77         /* pointer where more data could be allocated if it fits */
  78         char *next_data;
  79         char *end_data;
  80         /*
  81          * scan starts is an array of pointers to objects equally spaced in the allocation area
  82          * They let use quickly find pinned objects from pinning pointers.
  83          */
  84         char **scan_starts;
  85         /* in major collections indexes in the pin_queue for objects that pin this section */
  86         size_t pin_queue_first_entry;
  87         size_t pin_queue_last_entry;
  88         size_t num_scan_start;
  89 };
  90
  91 /*
  92  * Recursion is not allowed for the thread lock.
  93  */
  94 #define LOCK_DECLARE(name) mono_mutex_t name
  95 /* if changing LOCK_INIT to something that isn't idempotent, look at
  96    its use in mono_gc_base_init in sgen-gc.c */
  97 #define LOCK_INIT(name) mono_mutex_init (&(name))
  98 #define LOCK_GC do {                                            \
  99                 MONO_TRY_BLOCKING       \
 100                 mono_mutex_lock (&gc_mutex);                    \
 101                 MONO_FINISH_TRY_BLOCKING        \
 102         } while (0)
 103 #define UNLOCK_GC do { sgen_gc_unlock (); } while (0)
 104
 105 extern LOCK_DECLARE (sgen_interruption_mutex);
 106
 107 #define LOCK_INTERRUPTION mono_mutex_lock (&sgen_interruption_mutex)
 108 #define UNLOCK_INTERRUPTION mono_mutex_unlock (&sgen_interruption_mutex)
 109
 110 /* FIXME: Use InterlockedAdd & InterlockedAdd64 to reduce the CAS cost. */
 111 #define SGEN_CAS        InterlockedCompareExchange
 112 #define SGEN_CAS_PTR    InterlockedCompareExchangePointer
 113 #define SGEN_ATOMIC_ADD(x,i)    do {                                    \
 114                 int __old_x;                                            \
 115                 do {                                                    \
 116                         __old_x = (x);                                  \
 117                 } while (InterlockedCompareExchange (&(x), __old_x + (i), __old_x) != __old_x); \
 118         } while (0)
 119 #define SGEN_ATOMIC_ADD_P(x,i) do { \
 120                 size_t __old_x;                                            \
 121                 do {                                                    \
 122                         __old_x = (x);                                  \
 123                 } while (InterlockedCompareExchangePointer ((void**)&(x), (void*)(__old_x + (i)), (void*)__old_x) != (void*)__old_x); \
 124         } while (0)
 125
 126
 127 #ifndef HOST_WIN32
 128 /* we intercept pthread_create calls to know which threads exist */
 129 #define USE_PTHREAD_INTERCEPT 1
 130 #endif
 131
 132 #ifdef HEAVY_STATISTICS
 133 extern guint64 stat_objects_alloced_degraded;
 134 extern guint64 stat_bytes_alloced_degraded;
 135 extern guint64 stat_copy_object_called_major;
 136 extern guint64 stat_objects_copied_major;
 137 #endif
 138
 139 #define SGEN_ASSERT(level, a, ...) do { \
 140         if (G_UNLIKELY ((level) <= SGEN_MAX_ASSERT_LEVEL && !(a))) {    \
 141                 g_error (__VA_ARGS__);  \
 142 } } while (0)
 143
 144
 145 #define SGEN_LOG(level, format, ...) do {      \
 146         if (G_UNLIKELY ((level) <= SGEN_MAX_DEBUG_LEVEL && (level) <= gc_debug_level)) {        \
 147                 mono_gc_printf (gc_debug_file, format, ##__VA_ARGS__);  \
 148 } } while (0)
 149
 150 #define SGEN_COND_LOG(level, cond, format, ...) do {    \
 151         if (G_UNLIKELY ((level) <= SGEN_MAX_DEBUG_LEVEL && (level) <= gc_debug_level)) {        \
 152                 if (cond)       \
 153                         mono_gc_printf (gc_debug_file, format, ##__VA_ARGS__);  \
 154 } } while (0)
 155
 156 extern int gc_debug_level;
 157 extern FILE* gc_debug_file;
 158
 159 extern int current_collection_generation;
 160
 161 extern unsigned int sgen_global_stop_count;
 162
 163 extern gboolean bridge_processing_in_progress;
 164 extern MonoGCBridgeCallbacks bridge_callbacks;
 165
 166 #define SGEN_ALLOC_ALIGN                8
 167 #define SGEN_ALLOC_ALIGN_BITS   3
 168
 169 /* s must be non-negative */
 170 #define SGEN_CAN_ALIGN_UP(s)            ((s) <= SIZE_MAX - (SGEN_ALLOC_ALIGN - 1))
 171 #define SGEN_ALIGN_UP(s)                (((s)+(SGEN_ALLOC_ALIGN-1)) & ~(SGEN_ALLOC_ALIGN-1))
 172
 173 #if SIZEOF_VOID_P == 4
 174 #define ONE_P 1
 175 #else
 176 #define ONE_P 1ll
 177 #endif
 178
 179 /*
 180  * The link pointer is hidden by negating each bit.  We use the lowest
 181  * bit of the link (before negation) to store whether it needs
 182  * resurrection tracking.
 183  */
 184 #define HIDE_POINTER(p,t)       ((gpointer)(~((size_t)(p)|((t)?1:0))))
 185 #define REVEAL_POINTER(p)       ((gpointer)((~(size_t)(p))&~3L))
 186
 187 #define SGEN_PTR_IN_NURSERY(p,bits,start,end)   (((mword)(p) & ~((1 << (bits)) - 1)) == (mword)(start))
 188
 189 #ifdef USER_CONFIG
 190
 191 /* good sizes are 512KB-1MB: larger ones increase a lot memzeroing time */
 192 #define DEFAULT_NURSERY_SIZE (sgen_nursery_size)
 193 extern size_t sgen_nursery_size;
 194 /* The number of trailing 0 bits in DEFAULT_NURSERY_SIZE */
 195 #define DEFAULT_NURSERY_BITS (sgen_nursery_bits)
 196 extern int sgen_nursery_bits;
 197
 198 #else
 199
 200 #define DEFAULT_NURSERY_SIZE (4*1024*1024)
 201 #define DEFAULT_NURSERY_BITS 22
 202
 203 #endif
 204
 205 extern char *sgen_nursery_start;
 206 extern char *sgen_nursery_end;
 207
 208 static inline MONO_ALWAYS_INLINE gboolean
 209 sgen_ptr_in_nursery (void *p)
 210 {
 211         return SGEN_PTR_IN_NURSERY ((p), DEFAULT_NURSERY_BITS, sgen_nursery_start, sgen_nursery_end);
 212 }
 213
 214 static inline MONO_ALWAYS_INLINE char*
 215 sgen_get_nursery_start (void)
 216 {
 217         return sgen_nursery_start;
 218 }
 219
 220 static inline MONO_ALWAYS_INLINE char*
 221 sgen_get_nursery_end (void)
 222 {
 223         return sgen_nursery_end;
 224 }
 225
 226 /*
 227  * We use the lowest three bits in the vtable pointer of objects to tag whether they're
 228  * forwarded, pinned, and/or cemented.  These are the valid states:
 229  *
 230  * | State            | bits |
 231  * |------------------+------+
 232  * | default          |  000 |
 233  * | forwarded        |  001 |
 234  * | pinned           |  010 |
 235  * | pinned, cemented |  110 |
 236  *
 237  * We store them in the vtable slot because the bits are used in the sync block for other
 238  * purposes: if we merge them and alloc the sync blocks aligned to 8 bytes, we can change
 239  * this and use bit 3 in the syncblock (with the lower two bits both set for forwarded, that
 240  * would be an invalid combination for the monitor and hash code).
 241  */
 242
 243 #include "sgen-tagged-pointer.h"
 244
 245 #define SGEN_VTABLE_BITS_MASK   SGEN_TAGGED_POINTER_MASK
 246
 247 #define SGEN_POINTER_IS_TAGGED_FORWARDED(p)     SGEN_POINTER_IS_TAGGED_1((p))
 248 #define SGEN_POINTER_TAG_FORWARDED(p)           SGEN_POINTER_TAG_1((p))
 249
 250 #define SGEN_POINTER_IS_TAGGED_PINNED(p)        SGEN_POINTER_IS_TAGGED_2((p))
 251 #define SGEN_POINTER_TAG_PINNED(p)              SGEN_POINTER_TAG_2((p))
 252
 253 #define SGEN_POINTER_IS_TAGGED_CEMENTED(p)      SGEN_POINTER_IS_TAGGED_4((p))
 254 #define SGEN_POINTER_TAG_CEMENTED(p)            SGEN_POINTER_TAG_4((p))
 255
 256 #define SGEN_POINTER_UNTAG_VTABLE(p)            SGEN_POINTER_UNTAG_ALL((p))
 257
 258 /* returns NULL if not forwarded, or the forwarded address */
 259 #define SGEN_VTABLE_IS_FORWARDED(vtable) (SGEN_POINTER_IS_TAGGED_FORWARDED ((vtable)) ? SGEN_POINTER_UNTAG_VTABLE ((vtable)) : NULL)
 260 #define SGEN_OBJECT_IS_FORWARDED(obj) (SGEN_VTABLE_IS_FORWARDED (((mword*)(obj))[0]))
 261
 262 #define SGEN_VTABLE_IS_PINNED(vtable) SGEN_POINTER_IS_TAGGED_PINNED ((vtable))
 263 #define SGEN_OBJECT_IS_PINNED(obj) (SGEN_VTABLE_IS_PINNED (((mword*)(obj))[0]))
 264
 265 #define SGEN_OBJECT_IS_CEMENTED(obj) (SGEN_POINTER_IS_TAGGED_CEMENTED (((mword*)(obj))[0]))
 266
 267 /* set the forwarded address fw_addr for object obj */
 268 #define SGEN_FORWARD_OBJECT(obj,fw_addr) do {                           \
 269                 *(void**)(obj) = SGEN_POINTER_TAG_FORWARDED ((fw_addr));        \
 270         } while (0)
 271 #define SGEN_PIN_OBJECT(obj) do {       \
 272                 *(void**)(obj) = SGEN_POINTER_TAG_PINNED (*(void**)(obj)); \
 273         } while (0)
 274 #define SGEN_CEMENT_OBJECT(obj) do {    \
 275                 *(void**)(obj) = SGEN_POINTER_TAG_CEMENTED (*(void**)(obj)); \
 276         } while (0)
 277 /* Unpins and uncements */
 278 #define SGEN_UNPIN_OBJECT(obj) do {     \
 279                 *(void**)(obj) = SGEN_POINTER_UNTAG_VTABLE (*(void**)(obj)); \
 280         } while (0)
 281
 282 /*
 283  * Since we set bits in the vtable, use the macro to load it from the pointer to
 284  * an object that is potentially pinned.
 285  */
 286 #define SGEN_LOAD_VTABLE(obj)           SGEN_POINTER_UNTAG_ALL (SGEN_LOAD_VTABLE_UNCHECKED ((obj)))
 287
 288 /*
 289 List of what each bit on of the vtable gc bits means.
 290 */
 291 enum {
 292         SGEN_GC_BIT_BRIDGE_OBJECT = 1,
 293         SGEN_GC_BIT_BRIDGE_OPAQUE_OBJECT = 2,
 294         SGEN_GC_BIT_FINALIZER_AWARE = 4,
 295 };
 296
 297 /* the runtime can register areas of memory as roots: we keep two lists of roots,
 298  * a pinned root set for conservatively scanned roots and a normal one for
 299  * precisely scanned roots (currently implemented as a single list).
 300  */
 301 typedef struct _RootRecord RootRecord;
 302 struct _RootRecord {
 303         char *end_root;
 304         mword root_desc;
 305 };
 306
 307 enum {
 308         ROOT_TYPE_NORMAL = 0, /* "normal" roots */
 309         ROOT_TYPE_PINNED = 1, /* roots without a GC descriptor */
 310         ROOT_TYPE_WBARRIER = 2, /* roots with a write barrier */
 311         ROOT_TYPE_NUM
 312 };
 313
 314 extern SgenHashTable roots_hash [ROOT_TYPE_NUM];
 315
 316 typedef void (*IterateObjectCallbackFunc) (char*, size_t, void*);
 317
 318 void sgen_os_init (void);
 319
 320 void sgen_update_heap_boundaries (mword low, mword high);
 321
 322 void sgen_scan_area_with_callback (char *start, char *end, IterateObjectCallbackFunc callback, void *data, gboolean allow_flags);
 323 void sgen_check_section_scan_starts (GCMemSection *section);
 324
 325 void sgen_conservatively_pin_objects_from (void **start, void **end, void *start_nursery, void *end_nursery, int pin_type);
 326
 327 /* Keep in sync with description_for_type() in sgen-internal.c! */
 328 enum {
 329         INTERNAL_MEM_PIN_QUEUE,
 330         INTERNAL_MEM_FRAGMENT,
 331         INTERNAL_MEM_SECTION,
 332         INTERNAL_MEM_SCAN_STARTS,
 333         INTERNAL_MEM_FIN_TABLE,
 334         INTERNAL_MEM_FINALIZE_ENTRY,
 335         INTERNAL_MEM_FINALIZE_READY,
 336         INTERNAL_MEM_DISLINK_TABLE,
 337         INTERNAL_MEM_DISLINK,
 338         INTERNAL_MEM_ROOTS_TABLE,
 339         INTERNAL_MEM_ROOT_RECORD,
 340         INTERNAL_MEM_STATISTICS,
 341         INTERNAL_MEM_STAT_PINNED_CLASS,
 342         INTERNAL_MEM_STAT_REMSET_CLASS,
 343         INTERNAL_MEM_GRAY_QUEUE,
 344         INTERNAL_MEM_MS_TABLES,
 345         INTERNAL_MEM_MS_BLOCK_INFO,
 346         INTERNAL_MEM_MS_BLOCK_INFO_SORT,
 347         INTERNAL_MEM_WORKER_DATA,
 348         INTERNAL_MEM_THREAD_POOL_JOB,
 349         INTERNAL_MEM_BRIDGE_DATA,
 350         INTERNAL_MEM_OLD_BRIDGE_HASH_TABLE,
 351         INTERNAL_MEM_OLD_BRIDGE_HASH_TABLE_ENTRY,
 352         INTERNAL_MEM_BRIDGE_HASH_TABLE,
 353         INTERNAL_MEM_BRIDGE_HASH_TABLE_ENTRY,
 354         INTERNAL_MEM_BRIDGE_ALIVE_HASH_TABLE,
 355         INTERNAL_MEM_BRIDGE_ALIVE_HASH_TABLE_ENTRY,
 356         INTERNAL_MEM_TARJAN_BRIDGE_HASH_TABLE,
 357         INTERNAL_MEM_TARJAN_BRIDGE_HASH_TABLE_ENTRY,
 358         INTERNAL_MEM_TARJAN_OBJ_BUCKET,
 359         INTERNAL_MEM_BRIDGE_DEBUG,
 360         INTERNAL_MEM_TOGGLEREF_DATA,
 361         INTERNAL_MEM_CARDTABLE_MOD_UNION,
 362         INTERNAL_MEM_BINARY_PROTOCOL,
 363         INTERNAL_MEM_TEMPORARY,
 364         INTERNAL_MEM_FIRST_CLIENT
 365 };
 366
 367 enum {
 368         GENERATION_NURSERY,
 369         GENERATION_OLD,
 370         GENERATION_MAX
 371 };
 372
 373 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
 374 #define BINARY_PROTOCOL_ARG(x)  ,x
 375 #else
 376 #define BINARY_PROTOCOL_ARG(x)
 377 #endif
 378
 379 void sgen_init_internal_allocator (void);
 380
 381 #define SGEN_DEFINE_OBJECT_VTABLE
 382 #include "sgen-client-mono.h"
 383 #undef SGEN_DEFINE_OBJECT_VTABLE
 384
 385 /* eventually share with MonoThread? */
 386 /*
 387  * This structure extends the MonoThreadInfo structure.
 388  */
 389 struct _SgenThreadInfo {
 390         SgenClientThreadInfo client_info;
 391
 392         char **tlab_next_addr;
 393         char **tlab_start_addr;
 394         char **tlab_temp_end_addr;
 395         char **tlab_real_end_addr;
 396         gpointer runtime_data;
 397
 398 #ifdef SGEN_POSIX_STW
 399         /* This is -1 until the first suspend. */
 400         int signal;
 401         /* FIXME: kill this, we only use signals on systems that have rt-posix, which doesn't have issues with duplicates. */
 402         unsigned int stop_count; /* to catch duplicate signals. */
 403 #endif
 404
 405         /*FIXME pretty please finish killing ARCH_NUM_REGS */
 406 #ifdef USE_MONO_CTX
 407         MonoContext ctx;                /* ditto */
 408 #else
 409         gpointer regs[ARCH_NUM_REGS];       /* ditto */
 410 #endif
 411
 412 #ifndef HAVE_KW_THREAD
 413         char *tlab_start;
 414         char *tlab_next;
 415         char *tlab_temp_end;
 416         char *tlab_real_end;
 417 #endif
 418 };
 419
 420 gboolean sgen_is_worker_thread (MonoNativeThreadId thread);
 421
 422 typedef void (*CopyOrMarkObjectFunc) (void**, SgenGrayQueue*);
 423 typedef void (*ScanObjectFunc) (char *obj, mword desc, SgenGrayQueue*);
 424 typedef void (*ScanVTypeFunc) (char *full_object, char *start, mword desc, SgenGrayQueue* BINARY_PROTOCOL_ARG (size_t size));
 425
 426 typedef struct {
 427         CopyOrMarkObjectFunc copy_or_mark_object;
 428         ScanObjectFunc scan_object;
 429         ScanVTypeFunc scan_vtype;
 430         /*FIXME add allocation function? */
 431 } SgenObjectOperations;
 432
 433 typedef struct
 434 {
 435         SgenObjectOperations *ops;
 436         SgenGrayQueue *queue;
 437 } ScanCopyContext;
 438
 439 #define CONTEXT_FROM_OBJECT_OPERATIONS(ops, queue) ((ScanCopyContext) { (ops), (queue) })
 440
 441 void sgen_report_internal_mem_usage (void);
 442 void sgen_dump_internal_mem_usage (FILE *heap_dump_file);
 443 void sgen_dump_section (GCMemSection *section, const char *type);
 444 void sgen_dump_occupied (char *start, char *end, char *section_start);
 445
 446 void sgen_register_fixed_internal_mem_type (int type, size_t size);
 447
 448 void* sgen_alloc_internal (int type);
 449 void sgen_free_internal (void *addr, int type);
 450
 451 void* sgen_alloc_internal_dynamic (size_t size, int type, gboolean assert_on_failure);
 452 void sgen_free_internal_dynamic (void *addr, size_t size, int type);
 453
 454 void sgen_pin_stats_enable (void);
 455 void sgen_pin_stats_register_object (char *obj, size_t size);
 456 void sgen_pin_stats_register_global_remset (char *obj);
 457 void sgen_pin_stats_print_class_stats (void);
 458
 459 void sgen_sort_addresses (void **array, size_t size);
 460 void sgen_add_to_global_remset (gpointer ptr, gpointer obj);
 461
 462 int sgen_get_current_collection_generation (void);
 463 gboolean sgen_collection_is_concurrent (void);
 464 gboolean sgen_concurrent_collection_in_progress (void);
 465
 466 typedef struct _SgenFragment SgenFragment;
 467
 468 struct _SgenFragment {
 469         SgenFragment *next;
 470         char *fragment_start;
 471         char *fragment_next; /* the current soft limit for allocation */
 472         char *fragment_end;
 473         SgenFragment *next_in_order; /* We use a different entry for all active fragments so we can avoid SMR. */
 474 };
 475
 476 typedef struct {
 477         SgenFragment *alloc_head; /* List head to be used when allocating memory. Walk with fragment_next. */
 478         SgenFragment *region_head; /* List head of the region used by this allocator. Walk with next_in_order. */
 479 } SgenFragmentAllocator;
 480
 481 void sgen_fragment_allocator_add (SgenFragmentAllocator *allocator, char *start, char *end);
 482 void sgen_fragment_allocator_release (SgenFragmentAllocator *allocator);
 483 void* sgen_fragment_allocator_serial_alloc (SgenFragmentAllocator *allocator, size_t size);
 484 void* sgen_fragment_allocator_par_alloc (SgenFragmentAllocator *allocator, size_t size);
 485 void* sgen_fragment_allocator_serial_range_alloc (SgenFragmentAllocator *allocator, size_t desired_size, size_t minimum_size, size_t *out_alloc_size);
 486 void* sgen_fragment_allocator_par_range_alloc (SgenFragmentAllocator *allocator, size_t desired_size, size_t minimum_size, size_t *out_alloc_size);
 487 SgenFragment* sgen_fragment_allocator_alloc (void);
 488 void sgen_clear_allocator_fragments (SgenFragmentAllocator *allocator);
 489 void sgen_clear_range (char *start, char *end);
 490
 491
 492 /*
 493 This is a space/speed compromise as we need to make sure the from/to space check is both O(1)
 494 and only hit cache hot memory. On a 4Mb nursery it requires 1024 bytes, or 3% of your average
 495 L1 cache. On small configs with a 512kb nursery, this goes to 0.4%.
 496
 497 Experimental results on how much space we waste with a 4Mb nursery:
 498
 499 Note that the wastage applies to the half nursery, or 2Mb:
 500
 501 Test 1 (compiling corlib):
 502 9: avg: 3.1k
 503 8: avg: 1.6k
 504
 505 */
 506 #define SGEN_TO_SPACE_GRANULE_BITS 9
 507 #define SGEN_TO_SPACE_GRANULE_IN_BYTES (1 << SGEN_TO_SPACE_GRANULE_BITS)
 508
 509 extern char *sgen_space_bitmap;
 510 extern size_t sgen_space_bitmap_size;
 511
 512 static inline gboolean
 513 sgen_nursery_is_to_space (char *object)
 514 {
 515         size_t idx = (object - sgen_nursery_start) >> SGEN_TO_SPACE_GRANULE_BITS;
 516         size_t byte = idx >> 3;
 517         size_t bit = idx & 0x7;
 518
 519         SGEN_ASSERT (4, sgen_ptr_in_nursery (object), "object %p is not in nursery [%p - %p]", object, sgen_get_nursery_start (), sgen_get_nursery_end ());
 520         SGEN_ASSERT (4, byte < sgen_space_bitmap_size, "byte index %d out of range", byte, sgen_space_bitmap_size);
 521
 522         return (sgen_space_bitmap [byte] & (1 << bit)) != 0;
 523 }
 524
 525 static inline gboolean
 526 sgen_nursery_is_from_space (char *object)
 527 {
 528         return !sgen_nursery_is_to_space (object);
 529 }
 530
 531 static inline gboolean
 532 sgen_nursery_is_object_alive (char *obj)
 533 {
 534         /* FIXME put this asserts under a non default level */
 535         g_assert (sgen_ptr_in_nursery (obj));
 536
 537         if (sgen_nursery_is_to_space (obj))
 538                 return TRUE;
 539
 540         if (SGEN_OBJECT_IS_PINNED (obj) || SGEN_OBJECT_IS_FORWARDED (obj))
 541                 return TRUE;
 542
 543         return FALSE;
 544 }
 545
 546 typedef struct {
 547         gboolean is_split;
 548
 549         char* (*alloc_for_promotion) (GCVTable *vtable, char *obj, size_t objsize, gboolean has_references);
 550
 551         SgenObjectOperations serial_ops;
 552
 553         void (*prepare_to_space) (char *to_space_bitmap, size_t space_bitmap_size);
 554         void (*clear_fragments) (void);
 555         SgenFragment* (*build_fragments_get_exclude_head) (void);
 556         void (*build_fragments_release_exclude_head) (void);
 557         void (*build_fragments_finish) (SgenFragmentAllocator *allocator);
 558         void (*init_nursery) (SgenFragmentAllocator *allocator, char *start, char *end);
 559
 560         gboolean (*handle_gc_param) (const char *opt); /* Optional */
 561         void (*print_gc_param_usage) (void); /* Optional */
 562 } SgenMinorCollector;
 563
 564 extern SgenMinorCollector sgen_minor_collector;
 565
 566 void sgen_simple_nursery_init (SgenMinorCollector *collector);
 567 void sgen_split_nursery_init (SgenMinorCollector *collector);
 568
 569 /* Updating references */
 570
 571 #ifdef SGEN_CHECK_UPDATE_REFERENCE
 572 gboolean sgen_thread_pool_is_thread_pool_thread (MonoNativeThreadId some_thread) MONO_INTERNAL;
 573 static inline void
 574 sgen_update_reference (void **p, void *o, gboolean allow_null)
 575 {
 576         if (!allow_null)
 577                 SGEN_ASSERT (0, o, "Cannot update a reference with a NULL pointer");
 578         SGEN_ASSERT (0, !sgen_thread_pool_is_thread_pool_thread (mono_native_thread_id_get ()), "Can't update a reference in the worker thread");
 579         *p = o;
 580 }
 581
 582 #define SGEN_UPDATE_REFERENCE_ALLOW_NULL(p,o)   sgen_update_reference ((void**)(p), (void*)(o), TRUE)
 583 #define SGEN_UPDATE_REFERENCE(p,o)              sgen_update_reference ((void**)(p), (void*)(o), FALSE)
 584 #else
 585 #define SGEN_UPDATE_REFERENCE_ALLOW_NULL(p,o)   (*(void**)(p) = (void*)(o))
 586 #define SGEN_UPDATE_REFERENCE(p,o)              SGEN_UPDATE_REFERENCE_ALLOW_NULL ((p), (o))
 587 #endif
 588
 589 /* Major collector */
 590
 591 typedef void (*sgen_cardtable_block_callback) (mword start, mword size);
 592 void sgen_major_collector_iterate_live_block_ranges (sgen_cardtable_block_callback callback);
 593
 594 typedef enum {
 595         ITERATE_OBJECTS_SWEEP = 1,
 596         ITERATE_OBJECTS_NON_PINNED = 2,
 597         ITERATE_OBJECTS_PINNED = 4,
 598         ITERATE_OBJECTS_ALL = ITERATE_OBJECTS_NON_PINNED | ITERATE_OBJECTS_PINNED,
 599         ITERATE_OBJECTS_SWEEP_NON_PINNED = ITERATE_OBJECTS_SWEEP | ITERATE_OBJECTS_NON_PINNED,
 600         ITERATE_OBJECTS_SWEEP_PINNED = ITERATE_OBJECTS_SWEEP | ITERATE_OBJECTS_PINNED,
 601         ITERATE_OBJECTS_SWEEP_ALL = ITERATE_OBJECTS_SWEEP | ITERATE_OBJECTS_NON_PINNED | ITERATE_OBJECTS_PINNED
 602 } IterateObjectsFlags;
 603
 604 typedef struct
 605 {
 606         size_t num_scanned_objects;
 607         size_t num_unique_scanned_objects;
 608 } ScannedObjectCounts;
 609
 610 typedef struct _SgenMajorCollector SgenMajorCollector;
 611 struct _SgenMajorCollector {
 612         size_t section_size;
 613         gboolean is_concurrent;
 614         gboolean needs_thread_pool;
 615         gboolean supports_cardtable;
 616         gboolean sweeps_lazily;
 617
 618         /*
 619          * This is set to TRUE by the sweep if the next major
 620          * collection should be synchronous (for evacuation).  For
 621          * non-concurrent collectors, this should be NULL.
 622          */
 623         gboolean *want_synchronous_collection;
 624
 625         void* (*alloc_heap) (mword nursery_size, mword nursery_align, int nursery_bits);
 626         gboolean (*is_object_live) (char *obj);
 627         void* (*alloc_small_pinned_obj) (GCVTable *vtable, size_t size, gboolean has_references);
 628         void* (*alloc_degraded) (GCVTable *vtable, size_t size);
 629
 630         SgenObjectOperations major_ops_serial;
 631         SgenObjectOperations major_ops_concurrent_start;
 632         SgenObjectOperations major_ops_concurrent;
 633         SgenObjectOperations major_ops_concurrent_finish;
 634
 635         void* (*alloc_object) (GCVTable *vtable, size_t size, gboolean has_references);
 636         void (*free_pinned_object) (char *obj, size_t size);
 637
 638         /*
 639          * This is used for domain unloading, heap walking from the logging profiler, and
 640          * debugging.  Can assume the world is stopped.
 641          */
 642         void (*iterate_objects) (IterateObjectsFlags flags, IterateObjectCallbackFunc callback, void *data);
 643
 644         void (*free_non_pinned_object) (char *obj, size_t size);
 645         void (*pin_objects) (SgenGrayQueue *queue);
 646         void (*pin_major_object) (char *obj, SgenGrayQueue *queue);
 647         void (*scan_card_table) (gboolean mod_union, ScanCopyContext ctx);
 648         void (*iterate_live_block_ranges) (sgen_cardtable_block_callback callback);
 649         void (*update_cardtable_mod_union) (void);
 650         void (*init_to_space) (void);
 651         void (*sweep) (void);
 652         gboolean (*have_swept) (void);
 653         void (*finish_sweeping) (void);
 654         void (*free_swept_blocks) (size_t allowance);
 655         void (*check_scan_starts) (void);
 656         void (*dump_heap) (FILE *heap_dump_file);
 657         gint64 (*get_used_size) (void);
 658         void (*start_nursery_collection) (void);
 659         void (*finish_nursery_collection) (void);
 660         void (*start_major_collection) (void);
 661         void (*finish_major_collection) (ScannedObjectCounts *counts);
 662         gboolean (*drain_gray_stack) (ScanCopyContext ctx);
 663         gboolean (*ptr_is_in_non_pinned_space) (char *ptr, char **start);
 664         gboolean (*obj_is_from_pinned_alloc) (char *obj);
 665         void (*report_pinned_memory_usage) (void);
 666         size_t (*get_num_major_sections) (void);
 667         size_t (*get_bytes_survived_last_sweep) (void);
 668         gboolean (*handle_gc_param) (const char *opt);
 669         void (*print_gc_param_usage) (void);
 670         void (*post_param_init) (SgenMajorCollector *collector);
 671         gboolean (*is_valid_object) (char *object);
 672         GCVTable* (*describe_pointer) (char *pointer);
 673         guint8* (*get_cardtable_mod_union_for_object) (char *object);
 674         long long (*get_and_reset_num_major_objects_marked) (void);
 675         void (*count_cards) (long long *num_total_cards, long long *num_marked_cards);
 676 };
 677
 678 extern SgenMajorCollector major_collector;
 679
 680 void sgen_marksweep_init (SgenMajorCollector *collector);
 681 void sgen_marksweep_fixed_init (SgenMajorCollector *collector);
 682 void sgen_marksweep_par_init (SgenMajorCollector *collector);
 683 void sgen_marksweep_fixed_par_init (SgenMajorCollector *collector);
 684 void sgen_marksweep_conc_init (SgenMajorCollector *collector);
 685 SgenMajorCollector* sgen_get_major_collector (void);
 686
 687
 688 typedef struct _SgenRememberedSet {
 689         void (*wbarrier_set_field) (MonoObject *obj, gpointer field_ptr, MonoObject* value);
 690         void (*wbarrier_arrayref_copy) (gpointer dest_ptr, gpointer src_ptr, int count);
 691         void (*wbarrier_value_copy) (gpointer dest, gpointer src, int count, size_t element_size);
 692         void (*wbarrier_object_copy) (GCObject* obj, GCObject *src);
 693         void (*wbarrier_generic_nostore) (gpointer ptr);
 694         void (*record_pointer) (gpointer ptr);
 695
 696         void (*scan_remsets) (ScanCopyContext ctx);
 697
 698         void (*clear_cards) (void);
 699
 700         void (*finish_minor_collection) (void);
 701         gboolean (*find_address) (char *addr);
 702         gboolean (*find_address_with_cards) (char *cards_start, guint8 *cards, char *addr);
 703 } SgenRememberedSet;
 704
 705 SgenRememberedSet *sgen_get_remset (void);
 706
 707 static inline mword
 708 sgen_obj_get_descriptor (char *obj)
 709 {
 710         GCVTable *vtable = SGEN_LOAD_VTABLE_UNCHECKED (obj);
 711         SGEN_ASSERT (9, !SGEN_POINTER_IS_TAGGED_ANY (vtable), "Object can't be tagged");
 712         return sgen_vtable_get_descriptor (vtable);
 713 }
 714
 715 static inline mword
 716 sgen_obj_get_descriptor_safe (char *obj)
 717 {
 718         GCVTable *vtable = (GCVTable*)SGEN_LOAD_VTABLE (obj);
 719         return sgen_vtable_get_descriptor (vtable);
 720 }
 721
 722 static inline mword
 723 sgen_safe_object_get_size (GCObject *obj)
 724 {
 725        char *forwarded;
 726
 727        if ((forwarded = SGEN_OBJECT_IS_FORWARDED (obj)))
 728                obj = (GCObject*)forwarded;
 729
 730        return sgen_client_par_object_get_size ((GCVTable*)SGEN_LOAD_VTABLE (obj), obj);
 731 }
 732
 733 static inline gboolean
 734 sgen_safe_object_is_small (MonoObject *obj, int type)
 735 {
 736         if (type <= DESC_TYPE_MAX_SMALL_OBJ)
 737                 return TRUE;
 738         return SGEN_ALIGN_UP (sgen_safe_object_get_size ((MonoObject*)obj)) <= SGEN_MAX_SMALL_OBJ_SIZE;
 739 }
 740
 741 /*
 742  * This variant guarantees to return the exact size of the object
 743  * before alignment. Needed for canary support.
 744  */
 745 static inline guint
 746 sgen_safe_object_get_size_unaligned (GCObject *obj)
 747 {
 748        char *forwarded;
 749
 750        if ((forwarded = SGEN_OBJECT_IS_FORWARDED (obj))) {
 751                obj = (GCObject*)forwarded;
 752        }
 753
 754        return sgen_client_slow_object_get_size ((GCVTable*)SGEN_LOAD_VTABLE (obj), obj);
 755 }
 756
 757 #include "metadata/sgen-client-mono.h"
 758
 759 gboolean sgen_object_is_live (void *obj);
 760
 761 void  sgen_init_fin_weak_hash (void);
 762
 763 gboolean sgen_need_bridge_processing (void);
 764 void sgen_bridge_reset_data (void);
 765 void sgen_bridge_processing_stw_step (void);
 766 void sgen_bridge_processing_finish (int generation);
 767 void sgen_register_test_bridge_callbacks (const char *bridge_class_name);
 768 gboolean sgen_is_bridge_object (GCObject *obj);
 769 MonoGCBridgeObjectKind sgen_bridge_class_kind (MonoClass *klass);
 770 void sgen_mark_bridge_object (GCObject *obj);
 771 void sgen_bridge_register_finalized_object (GCObject *object);
 772 void sgen_bridge_describe_pointer (GCObject *object);
 773
 774 void sgen_mark_togglerefs (char *start, char *end, ScanCopyContext ctx);
 775 void sgen_clear_togglerefs (char *start, char *end, ScanCopyContext ctx);
 776
 777 void sgen_process_togglerefs (void);
 778 void sgen_register_test_toggleref_callback (void);
 779
 780 gboolean sgen_is_bridge_object (GCObject *obj);
 781 void sgen_mark_bridge_object (GCObject *obj);
 782
 783 gboolean sgen_bridge_handle_gc_debug (const char *opt);
 784 void sgen_bridge_print_gc_debug_usage (void);
 785
 786 typedef struct {
 787         void (*reset_data) (void);
 788         void (*processing_stw_step) (void);
 789         void (*processing_build_callback_data) (int generation);
 790         void (*processing_after_callback) (int generation);
 791         MonoGCBridgeObjectKind (*class_kind) (MonoClass *class);
 792         void (*register_finalized_object) (GCObject *object);
 793         void (*describe_pointer) (GCObject *object);
 794         void (*enable_accounting) (void);
 795         void (*set_dump_prefix) (const char *prefix);
 796
 797         /*
 798          * These are set by processing_build_callback_data().
 799          */
 800         int num_sccs;
 801         MonoGCBridgeSCC **api_sccs;
 802
 803         int num_xrefs;
 804         MonoGCBridgeXRef *api_xrefs;
 805 } SgenBridgeProcessor;
 806
 807 void sgen_old_bridge_init (SgenBridgeProcessor *collector);
 808 void sgen_new_bridge_init (SgenBridgeProcessor *collector);
 809 void sgen_tarjan_bridge_init (SgenBridgeProcessor *collector);
 810 void sgen_set_bridge_implementation (const char *name);
 811 void sgen_bridge_set_dump_prefix (const char *prefix);
 812
 813 gboolean sgen_compare_bridge_processor_results (SgenBridgeProcessor *a, SgenBridgeProcessor *b);
 814
 815 typedef mono_bool (*WeakLinkAlivePredicateFunc) (GCObject*, void*);
 816
 817 void sgen_null_links_with_predicate (int generation, WeakLinkAlivePredicateFunc predicate, void *data);
 818
 819 gboolean sgen_gc_is_object_ready_for_finalization (void *object);
 820 void sgen_gc_lock (void);
 821 void sgen_gc_unlock (void);
 822
 823 void sgen_queue_finalization_entry (GCObject *obj);
 824 const char* sgen_generation_name (int generation);
 825
 826 void sgen_collect_bridge_objects (int generation, ScanCopyContext ctx);
 827 void sgen_finalize_in_range (int generation, ScanCopyContext ctx);
 828 void sgen_null_link_in_range (int generation, gboolean before_finalization, ScanCopyContext ctx);
 829 void sgen_null_links_for_domain (MonoDomain *domain, int generation);
 830 void sgen_remove_finalizers_for_domain (MonoDomain *domain, int generation);
 831 void sgen_process_fin_stage_entries (void);
 832 void sgen_process_dislink_stage_entries (void);
 833 void sgen_register_disappearing_link (GCObject *obj, void **link, gboolean track, gboolean in_gc);
 834
 835 gboolean sgen_drain_gray_stack (int max_objs, ScanCopyContext ctx);
 836
 837 enum {
 838         SPACE_NURSERY,
 839         SPACE_MAJOR,
 840         SPACE_LOS
 841 };
 842
 843 void sgen_pin_object (void *object, SgenGrayQueue *queue);
 844 void sgen_set_pinned_from_failed_allocation (mword objsize);
 845
 846 void sgen_ensure_free_space (size_t size);
 847 void sgen_perform_collection (size_t requested_size, int generation_to_collect, const char *reason, gboolean wait_to_finish);
 848 gboolean sgen_has_critical_method (void);
 849 gboolean sgen_is_critical_method (MonoMethod *method);
 850
 851 /* STW */
 852
 853 typedef struct {
 854         int generation;
 855         const char *reason;
 856         gboolean is_overflow;
 857         SGEN_TV_DECLARE (total_time);
 858         SGEN_TV_DECLARE (stw_time);
 859         SGEN_TV_DECLARE (bridge_time);
 860 } GGTimingInfo;
 861
 862 int sgen_stop_world (int generation);
 863 int sgen_restart_world (int generation, GGTimingInfo *timing);
 864 gboolean sgen_is_world_stopped (void);
 865
 866 /* LOS */
 867
 868 typedef struct _LOSObject LOSObject;
 869 struct _LOSObject {
 870         LOSObject *next;
 871         mword size; /* this is the object size, lowest bit used for pin/mark */
 872         guint8 * volatile cardtable_mod_union; /* only used by the concurrent collector */
 873 #if SIZEOF_VOID_P < 8
 874         mword dummy;            /* to align object to sizeof (double) */
 875 #endif
 876         char data [MONO_ZERO_LEN_ARRAY];
 877 };
 878
 879 extern LOSObject *los_object_list;
 880 extern mword los_memory_usage;
 881
 882 void sgen_los_free_object (LOSObject *obj);
 883 void* sgen_los_alloc_large_inner (GCVTable *vtable, size_t size);
 884 void sgen_los_sweep (void);
 885 gboolean sgen_ptr_is_in_los (char *ptr, char **start);
 886 void sgen_los_iterate_objects (IterateObjectCallbackFunc cb, void *user_data);
 887 void sgen_los_iterate_live_block_ranges (sgen_cardtable_block_callback callback);
 888 void sgen_los_scan_card_table (gboolean mod_union, ScanCopyContext ctx);
 889 void sgen_los_update_cardtable_mod_union (void);
 890 void sgen_los_count_cards (long long *num_total_cards, long long *num_marked_cards);
 891 gboolean sgen_los_is_valid_object (char *object);
 892 gboolean mono_sgen_los_describe_pointer (char *ptr);
 893 LOSObject* sgen_los_header_for_object (char *data);
 894 mword sgen_los_object_size (LOSObject *obj);
 895 void sgen_los_pin_object (char *obj);
 896 gboolean sgen_los_object_is_pinned (char *obj);
 897 void sgen_los_mark_mod_union_card (MonoObject *mono_obj, void **ptr);
 898
 899
 900 /* nursery allocator */
 901
 902 void sgen_clear_nursery_fragments (void);
 903 void sgen_nursery_allocator_prepare_for_pinning (void);
 904 void sgen_nursery_allocator_set_nursery_bounds (char *nursery_start, char *nursery_end);
 905 mword sgen_build_nursery_fragments (GCMemSection *nursery_section, SgenGrayQueue *unpin_queue);
 906 void sgen_init_nursery_allocator (void);
 907 void sgen_nursery_allocator_init_heavy_stats (void);
 908 void sgen_init_allocator (void);
 909 char* sgen_nursery_alloc_get_upper_alloc_bound (void);
 910 void* sgen_nursery_alloc (size_t size);
 911 void* sgen_nursery_alloc_range (size_t size, size_t min_size, size_t *out_alloc_size);
 912 gboolean sgen_can_alloc_size (size_t size);
 913 void sgen_nursery_retire_region (void *address, ptrdiff_t size);
 914
 915 void sgen_nursery_alloc_prepare_for_minor (void);
 916 void sgen_nursery_alloc_prepare_for_major (void);
 917
 918 char* sgen_alloc_for_promotion (char *obj, size_t objsize, gboolean has_references);
 919
 920 void* sgen_alloc_obj_nolock (GCVTable *vtable, size_t size);
 921 void* sgen_try_alloc_obj_nolock (GCVTable *vtable, size_t size);
 922
 923 /* Threads */
 924
 925 void* sgen_thread_register (SgenThreadInfo* info, void *addr);
 926 void sgen_thread_unregister (SgenThreadInfo *p);
 927 void sgen_thread_attach (SgenThreadInfo *info);
 928
 929 /* Finalization/ephemeron support */
 930
 931 static inline gboolean
 932 sgen_major_is_object_alive (void *object)
 933 {
 934         mword objsize;
 935
 936         /* Oldgen objects can be pinned and forwarded too */
 937         if (SGEN_OBJECT_IS_PINNED (object) || SGEN_OBJECT_IS_FORWARDED (object))
 938                 return TRUE;
 939
 940         /*
 941          * FIXME: major_collector.is_object_live() also calculates the
 942          * size.  Avoid the double calculation.
 943          */
 944         objsize = SGEN_ALIGN_UP (sgen_safe_object_get_size ((GCObject*)object));
 945         if (objsize > SGEN_MAX_SMALL_OBJ_SIZE)
 946                 return sgen_los_object_is_pinned (object);
 947
 948         return major_collector.is_object_live (object);
 949 }
 950
 951 /*
 952  * This function returns true if @object is either alive or it belongs to the old gen
 953  * and we're currently doing a minor collection.
 954  */
 955 static inline int
 956 sgen_is_object_alive_for_current_gen (char *object)
 957 {
 958         if (sgen_ptr_in_nursery (object))
 959                 return sgen_nursery_is_object_alive (object);
 960
 961         if (current_collection_generation == GENERATION_NURSERY)
 962                 return TRUE;
 963
 964         return sgen_major_is_object_alive (object);
 965 }
 966
 967 /* TLS Data */
 968
 969 extern MonoNativeTlsKey thread_info_key;
 970
 971 #ifdef HAVE_KW_THREAD
 972 extern __thread SgenThreadInfo *sgen_thread_info;
 973 #endif
 974
 975 /* Other globals */
 976
 977 extern GCMemSection *nursery_section;
 978 extern guint32 collect_before_allocs;
 979 extern guint32 verify_before_allocs;
 980 extern gboolean has_per_allocation_action;
 981 extern size_t degraded_mode;
 982 extern int default_nursery_size;
 983 extern guint32 tlab_size;
 984 extern NurseryClearPolicy nursery_clear_policy;
 985 extern gboolean sgen_try_free_some_memory;
 986
 987 extern LOCK_DECLARE (gc_mutex);
 988
 989 /* Nursery helpers. */
 990
 991 static inline void
 992 sgen_set_nursery_scan_start (char *p)
 993 {
 994         size_t idx = (p - (char*)nursery_section->data) / SGEN_SCAN_START_SIZE;
 995         char *old = nursery_section->scan_starts [idx];
 996         if (!old || old > p)
 997                 nursery_section->scan_starts [idx] = p;
 998 }
 999
1000
1001 /* Object Allocation */
1002
1003 typedef enum {
1004         ATYPE_NORMAL,
1005         ATYPE_VECTOR,
1006         ATYPE_SMALL,
1007         ATYPE_STRING,
1008         ATYPE_NUM
1009 } SgenAllocatorType;
1010
1011 void sgen_init_tlab_info (SgenThreadInfo* info);
1012 void sgen_clear_tlabs (void);
1013 void sgen_set_use_managed_allocator (gboolean flag);
1014 gboolean sgen_is_managed_allocator (MonoMethod *method);
1015 gboolean sgen_has_managed_allocator (void);
1016
1017 /* Debug support */
1018
1019 void sgen_check_consistency (void);
1020 void sgen_check_mod_union_consistency (void);
1021 void sgen_check_major_refs (void);
1022 void sgen_check_whole_heap (gboolean allow_missing_pinning);
1023 void sgen_check_whole_heap_stw (void);
1024 void sgen_check_objref (char *obj);
1025 void sgen_check_heap_marked (gboolean nursery_must_be_pinned);
1026 void sgen_check_nursery_objects_pinned (gboolean pinned);
1027 void sgen_scan_for_registered_roots_in_domain (MonoDomain *domain, int root_type);
1028 void sgen_check_for_xdomain_refs (void);
1029 char* sgen_find_object_for_ptr (char *ptr);
1030
1031 void mono_gc_scan_for_specific_ref (GCObject *key, gboolean precise);
1032
1033 void sgen_debug_enable_heap_dump (const char *filename);
1034 void sgen_debug_dump_heap (const char *type, int num, const char *reason);
1035
1036 void sgen_debug_verify_nursery (gboolean do_dump_nursery_content);
1037 void sgen_debug_check_nursery_is_clean (void);
1038
1039 /* Write barrier support */
1040
1041 /*
1042  * This causes the compile to extend the liveness of 'v' till the call to dummy_use
1043  */
1044 static inline void
1045 sgen_dummy_use (gpointer v) {
1046 #if defined(__GNUC__)
1047         __asm__ volatile ("" : "=r"(v) : "r"(v));
1048 #elif defined(_MSC_VER)
1049         static volatile gpointer ptr;
1050         ptr = v;
1051 #else
1052 #error "Implement sgen_dummy_use for your compiler"
1053 #endif
1054 }
1055
1056 /* Environment variable parsing */
1057
1058 #define MONO_GC_PARAMS_NAME     "MONO_GC_PARAMS"
1059 #define MONO_GC_DEBUG_NAME      "MONO_GC_DEBUG"
1060
1061 gboolean sgen_parse_environment_string_extract_number (const char *str, size_t *out);
1062 void sgen_env_var_error (const char *env_var, const char *fallback, const char *description_format, ...);
1063
1064 /* Utilities */
1065
1066 void sgen_qsort (void *base, size_t nel, size_t width, int (*compar) (const void*, const void*));
1067 gint64 sgen_timestamp (void);
1068
1069 /*
1070  * Canary (guard word) support
1071  * Notes:
1072  * - CANARY_SIZE must be multiple of word size in bytes
1073  * - Canary space is not included on checks against SGEN_MAX_SMALL_OBJ_SIZE
1074  */
1075
1076 gboolean nursery_canaries_enabled (void);
1077
1078 #define CANARY_SIZE 8
1079 #define CANARY_STRING  "koupepia"
1080
1081 #define CANARIFY_SIZE(size) if (nursery_canaries_enabled ()) {  \
1082                         size = size + CANARY_SIZE;      \
1083                 }
1084
1085 #define CANARIFY_ALLOC(addr,size) if (nursery_canaries_enabled ()) {    \
1086                                 memcpy ((char*) (addr) + (size), CANARY_STRING, CANARY_SIZE);   \
1087                         }
1088
1089 #define CANARY_VALID(addr) (strncmp ((char*) (addr), CANARY_STRING, CANARY_SIZE) == 0)
1090
1091 #define CHECK_CANARY_FOR_OBJECT(addr) if (nursery_canaries_enabled ()) {        \
1092                                 char* canary_ptr = (char*) (addr) + sgen_safe_object_get_size_unaligned ((GCObject *) (addr));  \
1093                                 if (!CANARY_VALID(canary_ptr)) {        \
1094                                         char canary_copy[CANARY_SIZE +1];       \
1095                                         strncpy (canary_copy, canary_ptr, CANARY_SIZE); \
1096                                         canary_copy[CANARY_SIZE] = 0;   \
1097                                         g_error ("CORRUPT CANARY:\naddr->%p\ntype->%s\nexcepted->'%s'\nfound->'%s'\n", (char*) addr, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE ((addr))), CANARY_STRING, canary_copy);      \
1098                                 } }
1099
1100 #endif /* HAVE_SGEN_GC */
1101
1102 #endif /* __MONO_SGENGC_H__ */