mono/sgen/sgen-gc.h

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