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