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