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