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