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