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