3 * Simple generational GC.
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
10 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
12 #ifndef __MONO_SGENGC_H__
13 #define __MONO_SGENGC_H__
20 typedef struct _SgenThreadInfo SgenThreadInfo;
21 #undef THREAD_INFO_TYPE
22 #define THREAD_INFO_TYPE SgenThreadInfo
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 #include "mono/sgen/sgen-thread-pool.h"
40 /* The method used to clear the nursery */
41 /* Clearing at nursery collections is the safest, but has bad interactions with caches.
42 * Clearing at TLAB creation is much faster, but more complex and it might expose hard
47 CLEAR_AT_TLAB_CREATION,
48 CLEAR_AT_TLAB_CREATION_DEBUG
51 NurseryClearPolicy sgen_get_nursery_clear_policy (void);
53 #if !defined(__MACH__) && !MONO_MACH_ARCH_SUPPORTED && defined(HAVE_PTHREAD_KILL)
54 #define SGEN_POSIX_STW 1
58 * The nursery section uses this struct.
60 typedef struct _GCMemSection GCMemSection;
61 struct _GCMemSection {
64 /* pointer where more data could be allocated if it fits */
68 * scan starts is an array of pointers to objects equally spaced in the allocation area
69 * They let use quickly find pinned objects from pinning pointers.
72 /* in major collections indexes in the pin_queue for objects that pin this section */
73 size_t pin_queue_first_entry;
74 size_t pin_queue_last_entry;
75 size_t num_scan_start;
79 * Recursion is not allowed for the thread lock.
81 #define LOCK_DECLARE(name) mono_mutex_t name
82 /* if changing LOCK_INIT to something that isn't idempotent, look at
83 its use in mono_gc_base_init in sgen-gc.c */
84 #define LOCK_INIT(name) mono_os_mutex_init (&(name))
85 #define LOCK_GC do { sgen_gc_lock (); } while (0)
86 #define UNLOCK_GC do { sgen_gc_unlock (); } while (0)
88 extern MonoCoopMutex sgen_interruption_mutex;
90 #define LOCK_INTERRUPTION mono_coop_mutex_lock (&sgen_interruption_mutex)
91 #define UNLOCK_INTERRUPTION mono_coop_mutex_unlock (&sgen_interruption_mutex)
93 /* FIXME: Use InterlockedAdd & InterlockedAdd64 to reduce the CAS cost. */
94 #define SGEN_CAS InterlockedCompareExchange
95 #define SGEN_CAS_PTR InterlockedCompareExchangePointer
96 #define SGEN_ATOMIC_ADD(x,i) do { \
100 } while (InterlockedCompareExchange (&(x), __old_x + (i), __old_x) != __old_x); \
102 #define SGEN_ATOMIC_ADD_P(x,i) do { \
106 } while (InterlockedCompareExchangePointer ((void**)&(x), (void*)(__old_x + (i)), (void*)__old_x) != (void*)__old_x); \
109 #ifdef HEAVY_STATISTICS
110 extern guint64 stat_objects_alloced_degraded;
111 extern guint64 stat_bytes_alloced_degraded;
112 extern guint64 stat_copy_object_called_major;
113 extern guint64 stat_objects_copied_major;
116 #define SGEN_ASSERT(level, a, ...) do { \
117 if (G_UNLIKELY ((level) <= SGEN_MAX_ASSERT_LEVEL && !(a))) { \
118 g_error (__VA_ARGS__); \
121 #ifdef HAVE_LOCALTIME_R
122 # define LOG_TIMESTAMP \
127 localtime_r(&t, &tod); \
128 strftime(logTime, sizeof(logTime), "%Y-%m-%d %H:%M:%S", &tod); \
131 # define LOG_TIMESTAMP \
136 tod = localtime(&t); \
137 strftime(logTime, sizeof(logTime), "%F %T", tod); \
141 #define SGEN_LOG(level, format, ...) do { \
142 if (G_UNLIKELY ((level) <= SGEN_MAX_DEBUG_LEVEL && (level) <= gc_debug_level)) { \
145 mono_gc_printf (gc_debug_file, "%s " format "\n", logTime, ##__VA_ARGS__); \
148 #define SGEN_COND_LOG(level, cond, format, ...) do { \
149 if (G_UNLIKELY ((level) <= SGEN_MAX_DEBUG_LEVEL && (level) <= gc_debug_level)) { \
153 mono_gc_printf (gc_debug_file, "%s " format "\n", logTime, ##__VA_ARGS__); \
157 extern int gc_debug_level;
158 extern FILE* gc_debug_file;
160 extern int current_collection_generation;
162 extern unsigned int sgen_global_stop_count;
164 #define SGEN_ALIGN_UP_TO(val,align) (((val) + (align - 1)) & ~(align - 1))
165 #define SGEN_ALIGN_DOWN_TO(val,align) ((val) & ~(align - 1))
167 #define SGEN_ALLOC_ALIGN 8
168 #define SGEN_ALLOC_ALIGN_BITS 3
170 /* s must be non-negative */
171 #define SGEN_CAN_ALIGN_UP(s) ((s) <= SIZE_MAX - (SGEN_ALLOC_ALIGN - 1))
172 #define SGEN_ALIGN_UP(s) SGEN_ALIGN_UP_TO(s, SGEN_ALLOC_ALIGN)
173 #define SGEN_ALIGN_DOWN(s) SGEN_ALIGN_DOWN_TO(s, SGEN_ALLOC_ALIGN)
175 #if SIZEOF_VOID_P == 4
182 sgen_aligned_addr_hash (gconstpointer ptr)
184 return GPOINTER_TO_UINT (ptr) >> 3;
187 #define SGEN_PTR_IN_NURSERY(p,bits,start,end) (((mword)(p) & ~(((mword)1 << (bits)) - 1)) == (mword)(start))
189 extern size_t sgen_nursery_size;
190 extern int sgen_nursery_bits;
192 extern char *sgen_nursery_start;
193 extern char *sgen_nursery_end;
195 static inline MONO_ALWAYS_INLINE gboolean
196 sgen_ptr_in_nursery (void *p)
198 return SGEN_PTR_IN_NURSERY ((p), sgen_nursery_bits, sgen_nursery_start, sgen_nursery_end);
201 static inline MONO_ALWAYS_INLINE char*
202 sgen_get_nursery_start (void)
204 return sgen_nursery_start;
207 static inline MONO_ALWAYS_INLINE char*
208 sgen_get_nursery_end (void)
210 return sgen_nursery_end;
214 * We use the lowest three bits in the vtable pointer of objects to tag whether they're
215 * forwarded, pinned, and/or cemented. These are the valid states:
218 * |------------------+------+
220 * | forwarded | 001 |
222 * | pinned, cemented | 110 |
224 * We store them in the vtable slot because the bits are used in the sync block for other
225 * purposes: if we merge them and alloc the sync blocks aligned to 8 bytes, we can change
226 * this and use bit 3 in the syncblock (with the lower two bits both set for forwarded, that
227 * would be an invalid combination for the monitor and hash code).
230 #include "sgen-tagged-pointer.h"
232 #define SGEN_VTABLE_BITS_MASK SGEN_TAGGED_POINTER_MASK
234 #define SGEN_POINTER_IS_TAGGED_FORWARDED(p) SGEN_POINTER_IS_TAGGED_1((p))
235 #define SGEN_POINTER_TAG_FORWARDED(p) SGEN_POINTER_TAG_1((p))
237 #define SGEN_POINTER_IS_TAGGED_PINNED(p) SGEN_POINTER_IS_TAGGED_2((p))
238 #define SGEN_POINTER_TAG_PINNED(p) SGEN_POINTER_TAG_2((p))
240 #define SGEN_POINTER_IS_TAGGED_CEMENTED(p) SGEN_POINTER_IS_TAGGED_4((p))
241 #define SGEN_POINTER_TAG_CEMENTED(p) SGEN_POINTER_TAG_4((p))
243 #define SGEN_POINTER_UNTAG_VTABLE(p) SGEN_POINTER_UNTAG_ALL((p))
245 /* returns NULL if not forwarded, or the forwarded address */
246 #define SGEN_VTABLE_IS_FORWARDED(vtable) ((GCObject *)(SGEN_POINTER_IS_TAGGED_FORWARDED ((vtable)) ? SGEN_POINTER_UNTAG_VTABLE ((vtable)) : NULL))
247 #define SGEN_OBJECT_IS_FORWARDED(obj) ((GCObject *)SGEN_VTABLE_IS_FORWARDED (((mword*)(obj))[0]))
249 #define SGEN_VTABLE_IS_PINNED(vtable) SGEN_POINTER_IS_TAGGED_PINNED ((vtable))
250 #define SGEN_OBJECT_IS_PINNED(obj) (SGEN_VTABLE_IS_PINNED (((mword*)(obj))[0]))
252 #define SGEN_OBJECT_IS_CEMENTED(obj) (SGEN_POINTER_IS_TAGGED_CEMENTED (((mword*)(obj))[0]))
254 /* set the forwarded address fw_addr for object obj */
255 #define SGEN_FORWARD_OBJECT(obj,fw_addr) do { \
256 *(void**)(obj) = SGEN_POINTER_TAG_FORWARDED ((fw_addr)); \
258 #define SGEN_FORWARD_OBJECT_PAR(obj,fw_addr,final_fw_addr) do { \
259 gpointer old_vtable_word = *(gpointer*)obj; \
260 gpointer new_vtable_word; \
261 final_fw_addr = SGEN_VTABLE_IS_FORWARDED (old_vtable_word); \
264 new_vtable_word = SGEN_POINTER_TAG_FORWARDED ((fw_addr)); \
265 old_vtable_word = InterlockedCompareExchangePointer ((gpointer*)obj, new_vtable_word, old_vtable_word); \
266 final_fw_addr = SGEN_VTABLE_IS_FORWARDED (old_vtable_word); \
267 if (!final_fw_addr) \
268 final_fw_addr = (fw_addr); \
270 #define SGEN_PIN_OBJECT(obj) do { \
271 *(void**)(obj) = SGEN_POINTER_TAG_PINNED (*(void**)(obj)); \
273 #define SGEN_CEMENT_OBJECT(obj) do { \
274 *(void**)(obj) = SGEN_POINTER_TAG_CEMENTED (*(void**)(obj)); \
276 /* Unpins and uncements */
277 #define SGEN_UNPIN_OBJECT(obj) do { \
278 *(void**)(obj) = SGEN_POINTER_UNTAG_VTABLE (*(void**)(obj)); \
282 * Since we set bits in the vtable, use the macro to load it from the pointer to
283 * an object that is potentially pinned.
285 #define SGEN_LOAD_VTABLE(obj) ((GCVTable)(SGEN_POINTER_UNTAG_ALL (SGEN_LOAD_VTABLE_UNCHECKED ((GCObject *)(obj)))))
288 List of what each bit on of the vtable gc bits means.
291 // When the Java bridge has determined an object is "bridged", it uses these two bits to cache that information.
292 SGEN_GC_BIT_BRIDGE_OBJECT = 1,
293 SGEN_GC_BIT_BRIDGE_OPAQUE_OBJECT = 2,
294 SGEN_GC_BIT_FINALIZER_AWARE = 4,
297 void sgen_gc_init (void);
299 void sgen_os_init (void);
301 void sgen_update_heap_boundaries (mword low, mword high);
303 void sgen_check_section_scan_starts (GCMemSection *section);
305 void sgen_conservatively_pin_objects_from (void **start, void **end, void *start_nursery, void *end_nursery, int pin_type);
307 gboolean sgen_gc_initialized (void);
309 /* Keep in sync with description_for_type() in sgen-internal.c! */
311 INTERNAL_MEM_PIN_QUEUE,
312 INTERNAL_MEM_FRAGMENT,
313 INTERNAL_MEM_SECTION,
314 INTERNAL_MEM_SCAN_STARTS,
315 INTERNAL_MEM_FIN_TABLE,
316 INTERNAL_MEM_FINALIZE_ENTRY,
317 INTERNAL_MEM_FINALIZE_READY,
318 INTERNAL_MEM_DISLINK_TABLE,
319 INTERNAL_MEM_DISLINK,
320 INTERNAL_MEM_ROOTS_TABLE,
321 INTERNAL_MEM_ROOT_RECORD,
322 INTERNAL_MEM_STATISTICS,
323 INTERNAL_MEM_STAT_PINNED_CLASS,
324 INTERNAL_MEM_STAT_REMSET_CLASS,
325 INTERNAL_MEM_GRAY_QUEUE,
326 INTERNAL_MEM_MS_TABLES,
327 INTERNAL_MEM_MS_BLOCK_INFO,
328 INTERNAL_MEM_MS_BLOCK_INFO_SORT,
329 INTERNAL_MEM_WORKER_DATA,
330 INTERNAL_MEM_THREAD_POOL_JOB,
331 INTERNAL_MEM_BRIDGE_DATA,
332 INTERNAL_MEM_OLD_BRIDGE_HASH_TABLE,
333 INTERNAL_MEM_OLD_BRIDGE_HASH_TABLE_ENTRY,
334 INTERNAL_MEM_BRIDGE_HASH_TABLE,
335 INTERNAL_MEM_BRIDGE_HASH_TABLE_ENTRY,
336 INTERNAL_MEM_BRIDGE_ALIVE_HASH_TABLE,
337 INTERNAL_MEM_BRIDGE_ALIVE_HASH_TABLE_ENTRY,
338 INTERNAL_MEM_TARJAN_BRIDGE_HASH_TABLE,
339 INTERNAL_MEM_TARJAN_BRIDGE_HASH_TABLE_ENTRY,
340 INTERNAL_MEM_TARJAN_OBJ_BUCKET,
341 INTERNAL_MEM_BRIDGE_DEBUG,
342 INTERNAL_MEM_TOGGLEREF_DATA,
343 INTERNAL_MEM_CARDTABLE_MOD_UNION,
344 INTERNAL_MEM_BINARY_PROTOCOL,
345 INTERNAL_MEM_TEMPORARY,
346 INTERNAL_MEM_LOG_ENTRY,
347 INTERNAL_MEM_COMPLEX_DESCRIPTORS,
348 INTERNAL_MEM_FIRST_CLIENT
357 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
358 #define BINARY_PROTOCOL_ARG(x) ,x
360 #define BINARY_PROTOCOL_ARG(x)
363 void sgen_init_internal_allocator (void);
365 #define SGEN_DEFINE_OBJECT_VTABLE
366 #ifdef SGEN_CLIENT_HEADER
367 #include SGEN_CLIENT_HEADER
369 #include "metadata/sgen-client-mono.h"
371 #undef SGEN_DEFINE_OBJECT_VTABLE
373 #include "mono/sgen/sgen-descriptor.h"
374 #include "mono/sgen/sgen-gray.h"
376 /* the runtime can register areas of memory as roots: we keep two lists of roots,
377 * a pinned root set for conservatively scanned roots and a normal one for
378 * precisely scanned roots (currently implemented as a single list).
380 typedef struct _RootRecord RootRecord;
383 SgenDescriptor root_desc;
389 ROOT_TYPE_NORMAL = 0, /* "normal" roots */
390 ROOT_TYPE_PINNED = 1, /* roots without a GC descriptor */
391 ROOT_TYPE_WBARRIER = 2, /* roots with a write barrier */
395 extern SgenHashTable roots_hash [ROOT_TYPE_NUM];
397 int sgen_register_root (char *start, size_t size, SgenDescriptor descr, int root_type, int source, const char *msg);
398 void sgen_deregister_root (char* addr);
400 typedef void (*IterateObjectCallbackFunc) (GCObject*, size_t, void*);
402 void sgen_scan_area_with_callback (char *start, char *end, IterateObjectCallbackFunc callback, void *data, gboolean allow_flags, gboolean fail_on_canaries);
404 /* eventually share with MonoThread? */
406 * This structure extends the MonoThreadInfo structure.
408 struct _SgenThreadInfo {
409 SgenClientThreadInfo client_info;
417 gboolean sgen_is_worker_thread (MonoNativeThreadId thread);
419 typedef void (*CopyOrMarkObjectFunc) (GCObject**, SgenGrayQueue*);
420 typedef void (*ScanObjectFunc) (GCObject *obj, SgenDescriptor desc, SgenGrayQueue*);
421 typedef void (*ScanVTypeFunc) (GCObject *full_object, char *start, SgenDescriptor desc, SgenGrayQueue* BINARY_PROTOCOL_ARG (size_t size));
422 typedef void (*ScanPtrFieldFunc) (GCObject *obj, GCObject **ptr, SgenGrayQueue* queue);
423 typedef gboolean (*DrainGrayStackFunc) (SgenGrayQueue *queue);
426 CopyOrMarkObjectFunc copy_or_mark_object;
427 ScanObjectFunc scan_object;
428 ScanVTypeFunc scan_vtype;
429 ScanPtrFieldFunc scan_ptr_field;
430 /* Drain stack optimized for the above functions */
431 DrainGrayStackFunc drain_gray_stack;
432 /*FIXME add allocation function? */
433 } SgenObjectOperations;
437 SgenObjectOperations *ops;
438 SgenGrayQueue *queue;
441 #define CONTEXT_FROM_OBJECT_OPERATIONS(ops, queue) ((ScanCopyContext) { (ops), (queue) })
443 void sgen_report_internal_mem_usage (void);
444 void sgen_dump_internal_mem_usage (FILE *heap_dump_file);
445 void sgen_dump_section (GCMemSection *section, const char *type);
446 void sgen_dump_occupied (char *start, char *end, char *section_start);
448 void sgen_register_fixed_internal_mem_type (int type, size_t size);
450 void* sgen_alloc_internal (int type);
451 void sgen_free_internal (void *addr, int type);
453 void* sgen_alloc_internal_dynamic (size_t size, int type, gboolean assert_on_failure);
454 void sgen_free_internal_dynamic (void *addr, size_t size, int type);
456 void sgen_pin_stats_enable (void);
457 void sgen_pin_stats_register_object (GCObject *obj, int generation);
458 void sgen_pin_stats_register_global_remset (GCObject *obj);
459 void sgen_pin_stats_report (void);
461 void sgen_sort_addresses (void **array, size_t size);
462 void sgen_add_to_global_remset (gpointer ptr, GCObject *obj);
464 int sgen_get_current_collection_generation (void);
465 gboolean sgen_collection_is_concurrent (void);
466 gboolean sgen_concurrent_collection_in_progress (void);
468 typedef struct _SgenFragment SgenFragment;
470 struct _SgenFragment {
472 char *fragment_start;
473 char *fragment_next; /* the current soft limit for allocation */
475 SgenFragment *next_in_order; /* We use a different entry for all active fragments so we can avoid SMR. */
479 SgenFragment *alloc_head; /* List head to be used when allocating memory. Walk with fragment_next. */
480 SgenFragment *region_head; /* List head of the region used by this allocator. Walk with next_in_order. */
481 } SgenFragmentAllocator;
483 void sgen_fragment_allocator_add (SgenFragmentAllocator *allocator, char *start, char *end);
484 void sgen_fragment_allocator_release (SgenFragmentAllocator *allocator);
485 void* sgen_fragment_allocator_serial_alloc (SgenFragmentAllocator *allocator, size_t size);
486 void* sgen_fragment_allocator_par_alloc (SgenFragmentAllocator *allocator, size_t size);
487 void* sgen_fragment_allocator_serial_range_alloc (SgenFragmentAllocator *allocator, size_t desired_size, size_t minimum_size, size_t *out_alloc_size);
488 void* sgen_fragment_allocator_par_range_alloc (SgenFragmentAllocator *allocator, size_t desired_size, size_t minimum_size, size_t *out_alloc_size);
489 SgenFragment* sgen_fragment_allocator_alloc (void);
490 void sgen_clear_allocator_fragments (SgenFragmentAllocator *allocator);
491 void sgen_clear_range (char *start, char *end);
495 This is a space/speed compromise as we need to make sure the from/to space check is both O(1)
496 and only hit cache hot memory. On a 4Mb nursery it requires 1024 bytes, or 3% of your average
497 L1 cache. On small configs with a 512kb nursery, this goes to 0.4%.
499 Experimental results on how much space we waste with a 4Mb nursery:
501 Note that the wastage applies to the half nursery, or 2Mb:
503 Test 1 (compiling corlib):
508 #define SGEN_TO_SPACE_GRANULE_BITS 9
509 #define SGEN_TO_SPACE_GRANULE_IN_BYTES (1 << SGEN_TO_SPACE_GRANULE_BITS)
511 extern char *sgen_space_bitmap;
512 extern size_t sgen_space_bitmap_size;
514 static inline gboolean
515 sgen_nursery_is_to_space (void *object)
517 size_t idx = ((char*)object - sgen_nursery_start) >> SGEN_TO_SPACE_GRANULE_BITS;
518 size_t byte = idx >> 3;
519 size_t bit = idx & 0x7;
521 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 ());
522 SGEN_ASSERT (4, byte < sgen_space_bitmap_size, "byte index %zd out of range (%zd)", byte, sgen_space_bitmap_size);
524 return (sgen_space_bitmap [byte] & (1 << bit)) != 0;
527 static inline gboolean
528 sgen_nursery_is_from_space (void *object)
530 return !sgen_nursery_is_to_space (object);
533 static inline gboolean
534 sgen_nursery_is_object_alive (GCObject *obj)
536 /* FIXME put this asserts under a non default level */
537 g_assert (sgen_ptr_in_nursery (obj));
539 if (sgen_nursery_is_to_space (obj))
542 if (SGEN_OBJECT_IS_PINNED (obj) || SGEN_OBJECT_IS_FORWARDED (obj))
550 gboolean is_parallel;
552 GCObject* (*alloc_for_promotion) (GCVTable vtable, GCObject *obj, size_t objsize, gboolean has_references);
554 SgenObjectOperations serial_ops;
555 SgenObjectOperations serial_ops_with_concurrent_major;
556 SgenObjectOperations parallel_ops;
558 void (*prepare_to_space) (char *to_space_bitmap, size_t space_bitmap_size);
559 void (*clear_fragments) (void);
560 SgenFragment* (*build_fragments_get_exclude_head) (void);
561 void (*build_fragments_release_exclude_head) (void);
562 void (*build_fragments_finish) (SgenFragmentAllocator *allocator);
563 void (*init_nursery) (SgenFragmentAllocator *allocator, char *start, char *end);
565 gboolean (*handle_gc_param) (const char *opt); /* Optional */
566 void (*print_gc_param_usage) (void); /* Optional */
567 } SgenMinorCollector;
569 extern SgenMinorCollector sgen_minor_collector;
571 void sgen_simple_nursery_init (SgenMinorCollector *collector, gboolean parallel);
572 void sgen_split_nursery_init (SgenMinorCollector *collector);
574 /* Updating references */
576 #ifdef SGEN_CHECK_UPDATE_REFERENCE
577 gboolean sgen_thread_pool_is_thread_pool_thread (MonoNativeThreadId some_thread);
580 sgen_update_reference (GCObject **p, GCObject *o, gboolean allow_null)
583 SGEN_ASSERT (0, o, "Cannot update a reference with a NULL pointer");
584 SGEN_ASSERT (0, !sgen_workers_is_worker_thread (mono_native_thread_id_get ()), "Can't update a reference in the worker thread");
588 #define SGEN_UPDATE_REFERENCE_ALLOW_NULL(p,o) sgen_update_reference ((GCObject**)(p), (GCObject*)(o), TRUE)
589 #define SGEN_UPDATE_REFERENCE(p,o) sgen_update_reference ((GCObject**)(p), (GCObject*)(o), FALSE)
591 #define SGEN_UPDATE_REFERENCE_ALLOW_NULL(p,o) (*(GCObject**)(p) = (GCObject*)(o))
592 #define SGEN_UPDATE_REFERENCE(p,o) SGEN_UPDATE_REFERENCE_ALLOW_NULL ((p), (o))
595 /* Major collector */
597 typedef void (*sgen_cardtable_block_callback) (mword start, mword size);
598 void sgen_major_collector_iterate_live_block_ranges (sgen_cardtable_block_callback callback);
599 void sgen_major_collector_iterate_block_ranges (sgen_cardtable_block_callback callback);
602 ITERATE_OBJECTS_SWEEP = 1,
603 ITERATE_OBJECTS_NON_PINNED = 2,
604 ITERATE_OBJECTS_PINNED = 4,
605 ITERATE_OBJECTS_SWEEP_NON_PINNED = ITERATE_OBJECTS_SWEEP | ITERATE_OBJECTS_NON_PINNED,
606 ITERATE_OBJECTS_SWEEP_PINNED = ITERATE_OBJECTS_SWEEP | ITERATE_OBJECTS_PINNED,
607 ITERATE_OBJECTS_SWEEP_ALL = ITERATE_OBJECTS_SWEEP | ITERATE_OBJECTS_NON_PINNED | ITERATE_OBJECTS_PINNED
608 } IterateObjectsFlags;
612 size_t num_scanned_objects;
613 size_t num_unique_scanned_objects;
614 } ScannedObjectCounts;
617 CARDTABLE_SCAN_GLOBAL = 0,
618 CARDTABLE_SCAN_MOD_UNION = 1,
619 CARDTABLE_SCAN_MOD_UNION_PRECLEAN = CARDTABLE_SCAN_MOD_UNION | 2,
622 typedef struct _SgenMajorCollector SgenMajorCollector;
623 struct _SgenMajorCollector {
625 gboolean is_concurrent;
626 gboolean is_parallel;
627 gboolean supports_cardtable;
628 gboolean sweeps_lazily;
630 void* (*alloc_heap) (mword nursery_size, mword nursery_align, int nursery_bits);
631 gboolean (*is_object_live) (GCObject *obj);
632 GCObject* (*alloc_small_pinned_obj) (GCVTable vtable, size_t size, gboolean has_references);
633 GCObject* (*alloc_degraded) (GCVTable vtable, size_t size);
635 SgenObjectOperations major_ops_serial;
636 SgenObjectOperations major_ops_concurrent_start;
637 SgenObjectOperations major_ops_concurrent_finish;
638 SgenObjectOperations major_ops_conc_par_start;
639 SgenObjectOperations major_ops_conc_par_finish;
641 GCObject* (*alloc_object) (GCVTable vtable, size_t size, gboolean has_references);
642 GCObject* (*alloc_object_par) (GCVTable vtable, size_t size, gboolean has_references);
643 void (*free_pinned_object) (GCObject *obj, size_t size);
646 * This is used for domain unloading, heap walking from the logging profiler, and
647 * debugging. Can assume the world is stopped.
649 void (*iterate_objects) (IterateObjectsFlags flags, IterateObjectCallbackFunc callback, void *data);
651 void (*free_non_pinned_object) (GCObject *obj, size_t size);
652 void (*pin_objects) (SgenGrayQueue *queue);
653 void (*pin_major_object) (GCObject *obj, SgenGrayQueue *queue);
654 void (*scan_card_table) (CardTableScanType scan_type, ScanCopyContext ctx, int job_index, int job_split_count);
655 void (*iterate_live_block_ranges) (sgen_cardtable_block_callback callback);
656 void (*iterate_block_ranges) (sgen_cardtable_block_callback callback);
657 void (*update_cardtable_mod_union) (void);
658 void (*init_to_space) (void);
659 void (*sweep) (void);
660 gboolean (*have_swept) (void);
661 void (*finish_sweeping) (void);
662 void (*free_swept_blocks) (size_t section_reserve);
663 void (*check_scan_starts) (void);
664 void (*dump_heap) (FILE *heap_dump_file);
665 gint64 (*get_used_size) (void);
666 void (*start_nursery_collection) (void);
667 void (*finish_nursery_collection) (void);
668 void (*start_major_collection) (void);
669 void (*finish_major_collection) (ScannedObjectCounts *counts);
670 gboolean (*ptr_is_in_non_pinned_space) (char *ptr, char **start);
671 gboolean (*ptr_is_from_pinned_alloc) (char *ptr);
672 void (*report_pinned_memory_usage) (void);
673 size_t (*get_num_major_sections) (void);
674 size_t (*get_bytes_survived_last_sweep) (void);
675 gboolean (*handle_gc_param) (const char *opt);
676 void (*print_gc_param_usage) (void);
677 void (*post_param_init) (SgenMajorCollector *collector);
678 gboolean (*is_valid_object) (char *ptr);
679 GCVTable (*describe_pointer) (char *pointer);
680 guint8* (*get_cardtable_mod_union_for_reference) (char *object);
681 long long (*get_and_reset_num_major_objects_marked) (void);
682 void (*count_cards) (long long *num_total_cards, long long *num_marked_cards);
683 SgenThreadPool* (*get_sweep_pool) (void);
685 void (*worker_init_cb) (gpointer worker);
688 extern SgenMajorCollector major_collector;
690 void sgen_marksweep_init (SgenMajorCollector *collector);
691 void sgen_marksweep_conc_init (SgenMajorCollector *collector);
692 void sgen_marksweep_conc_par_init (SgenMajorCollector *collector);
693 SgenMajorCollector* sgen_get_major_collector (void);
694 SgenMinorCollector* sgen_get_minor_collector (void);
697 typedef struct _SgenRememberedSet {
698 void (*wbarrier_set_field) (GCObject *obj, gpointer field_ptr, GCObject* value);
699 void (*wbarrier_arrayref_copy) (gpointer dest_ptr, gpointer src_ptr, int count);
700 void (*wbarrier_value_copy) (gpointer dest, gpointer src, int count, size_t element_size);
701 void (*wbarrier_object_copy) (GCObject* obj, GCObject *src);
702 void (*wbarrier_generic_nostore) (gpointer ptr);
703 void (*record_pointer) (gpointer ptr);
704 void (*wbarrier_range_copy) (gpointer dest, gpointer src, int count);
706 void (*start_scan_remsets) (void);
708 void (*clear_cards) (void);
710 gboolean (*find_address) (char *addr);
711 gboolean (*find_address_with_cards) (char *cards_start, guint8 *cards, char *addr);
714 SgenRememberedSet *sgen_get_remset (void);
717 * These must be kept in sync with object.h. They're here for using SGen independently of
720 void mono_gc_wbarrier_arrayref_copy (gpointer dest_ptr, gpointer src_ptr, int count);
721 void mono_gc_wbarrier_generic_nostore (gpointer ptr);
722 void mono_gc_wbarrier_generic_store (gpointer ptr, GCObject* value);
723 void mono_gc_wbarrier_generic_store_atomic (gpointer ptr, GCObject *value);
725 void sgen_wbarrier_range_copy (gpointer _dest, gpointer _src, int size);
727 static inline SgenDescriptor
728 sgen_obj_get_descriptor (GCObject *obj)
730 GCVTable vtable = SGEN_LOAD_VTABLE_UNCHECKED (obj);
731 SGEN_ASSERT (9, !SGEN_POINTER_IS_TAGGED_ANY (vtable), "Object can't be tagged");
732 return sgen_vtable_get_descriptor (vtable);
735 static inline SgenDescriptor
736 sgen_obj_get_descriptor_safe (GCObject *obj)
738 GCVTable vtable = SGEN_LOAD_VTABLE (obj);
739 return sgen_vtable_get_descriptor (vtable);
742 static mword sgen_client_par_object_get_size (GCVTable vtable, GCObject* o);
743 static mword sgen_client_slow_object_get_size (GCVTable vtable, GCObject* o);
746 sgen_safe_object_get_size (GCObject *obj)
749 GCVTable vtable = SGEN_LOAD_VTABLE_UNCHECKED (obj);
752 * Once we load the vtable, we must always use it, in case we are in parallel case.
753 * Otherwise the object might get forwarded in the meantime and we would read an
754 * invalid vtable. An object cannot be forwarded for a second time during same GC.
756 if ((forwarded = SGEN_VTABLE_IS_FORWARDED (vtable)))
757 return sgen_client_par_object_get_size (SGEN_LOAD_VTABLE (forwarded), obj);
759 return sgen_client_par_object_get_size ((GCVTable)SGEN_POINTER_UNTAG_ALL (vtable), obj);
762 static inline gboolean
763 sgen_safe_object_is_small (GCObject *obj, int type)
765 if (type <= DESC_TYPE_MAX_SMALL_OBJ)
767 return SGEN_ALIGN_UP (sgen_safe_object_get_size ((GCObject*)obj)) <= SGEN_MAX_SMALL_OBJ_SIZE;
771 * This variant guarantees to return the exact size of the object
772 * before alignment. Needed for canary support.
775 sgen_safe_object_get_size_unaligned (GCObject *obj)
779 if ((forwarded = SGEN_OBJECT_IS_FORWARDED (obj))) {
780 obj = (GCObject*)forwarded;
783 return sgen_client_slow_object_get_size (SGEN_LOAD_VTABLE (obj), obj);
786 #ifdef SGEN_CLIENT_HEADER
787 #include SGEN_CLIENT_HEADER
789 #include "metadata/sgen-client-mono.h"
792 gboolean sgen_object_is_live (GCObject *obj);
794 void sgen_init_fin_weak_hash (void);
796 /* FIXME: move the toggleref stuff out of here */
797 void sgen_mark_togglerefs (char *start, char *end, ScanCopyContext ctx);
798 void sgen_clear_togglerefs (char *start, char *end, ScanCopyContext ctx);
800 void sgen_process_togglerefs (void);
801 void sgen_register_test_toggleref_callback (void);
803 void sgen_mark_bridge_object (GCObject *obj);
804 void sgen_collect_bridge_objects (int generation, ScanCopyContext ctx);
806 typedef gboolean (*SgenObjectPredicateFunc) (GCObject *obj, void *user_data);
808 void sgen_null_links_if (SgenObjectPredicateFunc predicate, void *data, int generation, gboolean track);
810 gboolean sgen_gc_is_object_ready_for_finalization (GCObject *object);
811 void sgen_gc_lock (void);
812 void sgen_gc_unlock (void);
814 void sgen_queue_finalization_entry (GCObject *obj);
815 const char* sgen_generation_name (int generation);
817 void sgen_finalize_in_range (int generation, ScanCopyContext ctx);
818 void sgen_null_link_in_range (int generation, ScanCopyContext ctx, gboolean track);
819 void sgen_process_fin_stage_entries (void);
820 gboolean sgen_have_pending_finalizers (void);
821 void sgen_object_register_for_finalization (GCObject *obj, void *user_data);
823 void sgen_finalize_if (SgenObjectPredicateFunc predicate, void *user_data);
824 void sgen_remove_finalizers_if (SgenObjectPredicateFunc predicate, void *user_data, int generation);
825 void sgen_set_suspend_finalizers (void);
827 void sgen_wbroots_iterate_live_block_ranges (sgen_cardtable_block_callback cb);
828 void sgen_wbroots_scan_card_table (ScanCopyContext ctx);
830 void sgen_register_disappearing_link (GCObject *obj, void **link, gboolean track, gboolean in_gc);
832 GCObject* sgen_weak_link_get (void **link_addr);
834 gboolean sgen_drain_gray_stack (ScanCopyContext ctx);
842 void sgen_pin_object (GCObject *object, SgenGrayQueue *queue);
843 void sgen_set_pinned_from_failed_allocation (mword objsize);
845 void sgen_ensure_free_space (size_t size, int generation);
846 void sgen_gc_collect (int generation);
847 void sgen_perform_collection (size_t requested_size, int generation_to_collect, const char *reason, gboolean wait_to_finish, gboolean stw);
849 int sgen_gc_collection_count (int generation);
850 /* FIXME: what exactly does this return? */
851 size_t sgen_gc_get_used_size (void);
852 size_t sgen_gc_get_total_heap_allocation (void);
856 void sgen_stop_world (int generation);
857 void sgen_restart_world (int generation);
858 gboolean sgen_is_world_stopped (void);
860 gboolean sgen_set_allow_synchronous_major (gboolean flag);
864 typedef struct _LOSObject LOSObject;
867 mword size; /* this is the object size, lowest bit used for pin/mark */
868 guint8 * volatile cardtable_mod_union; /* only used by the concurrent collector */
869 #if SIZEOF_VOID_P < 8
870 mword dummy; /* to align object to sizeof (double) */
872 GCObject data [MONO_ZERO_LEN_ARRAY];
875 extern LOSObject *los_object_list;
876 extern mword los_memory_usage;
877 extern mword los_memory_usage_total;
879 void sgen_los_free_object (LOSObject *obj);
880 void* sgen_los_alloc_large_inner (GCVTable vtable, size_t size);
881 void sgen_los_sweep (void);
882 gboolean sgen_ptr_is_in_los (char *ptr, char **start);
883 void sgen_los_iterate_objects (IterateObjectCallbackFunc cb, void *user_data);
884 void sgen_los_iterate_live_block_ranges (sgen_cardtable_block_callback callback);
885 void sgen_los_scan_card_table (CardTableScanType scan_type, ScanCopyContext ctx, int job_index, int job_split_count);
886 void sgen_los_update_cardtable_mod_union (void);
887 void sgen_los_count_cards (long long *num_total_cards, long long *num_marked_cards);
888 gboolean sgen_los_is_valid_object (char *object);
889 gboolean mono_sgen_los_describe_pointer (char *ptr);
890 LOSObject* sgen_los_header_for_object (GCObject *data);
891 mword sgen_los_object_size (LOSObject *obj);
892 void sgen_los_pin_object (GCObject *obj);
893 gboolean sgen_los_pin_object_par (GCObject *obj);
894 gboolean sgen_los_object_is_pinned (GCObject *obj);
895 void sgen_los_mark_mod_union_card (GCObject *mono_obj, void **ptr);
898 /* nursery allocator */
900 void sgen_clear_nursery_fragments (void);
901 void sgen_nursery_allocator_prepare_for_pinning (void);
902 void sgen_nursery_allocator_set_nursery_bounds (char *nursery_start, char *nursery_end);
903 mword sgen_build_nursery_fragments (GCMemSection *nursery_section, SgenGrayQueue *unpin_queue);
904 void sgen_init_nursery_allocator (void);
905 void sgen_nursery_allocator_init_heavy_stats (void);
906 void sgen_init_allocator (void);
907 char* sgen_nursery_alloc_get_upper_alloc_bound (void);
908 void* sgen_nursery_alloc (size_t size);
909 void* sgen_nursery_alloc_range (size_t size, size_t min_size, size_t *out_alloc_size);
910 gboolean sgen_can_alloc_size (size_t size);
911 void sgen_nursery_retire_region (void *address, ptrdiff_t size);
913 void sgen_nursery_alloc_prepare_for_minor (void);
914 void sgen_nursery_alloc_prepare_for_major (void);
916 GCObject* sgen_alloc_for_promotion (GCObject *obj, size_t objsize, gboolean has_references);
918 GCObject* sgen_alloc_obj_nolock (GCVTable vtable, size_t size);
919 GCObject* sgen_try_alloc_obj_nolock (GCVTable vtable, size_t size);
923 void* sgen_thread_register (SgenThreadInfo* info, void *addr);
924 void sgen_thread_unregister (SgenThreadInfo *p);
926 /* Finalization/ephemeron support */
928 static inline gboolean
929 sgen_major_is_object_alive (GCObject *object)
933 /* Oldgen objects can be pinned and forwarded too */
934 if (SGEN_OBJECT_IS_PINNED (object) || SGEN_OBJECT_IS_FORWARDED (object))
938 * FIXME: major_collector.is_object_live() also calculates the
939 * size. Avoid the double calculation.
941 objsize = SGEN_ALIGN_UP (sgen_safe_object_get_size (object));
942 if (objsize > SGEN_MAX_SMALL_OBJ_SIZE)
943 return sgen_los_object_is_pinned (object);
945 return major_collector.is_object_live (object);
949 * This function returns true if @object is either alive or it belongs to the old gen
950 * and we're currently doing a minor collection.
953 sgen_is_object_alive_for_current_gen (GCObject *object)
955 if (sgen_ptr_in_nursery (object))
956 return sgen_nursery_is_object_alive (object);
958 if (current_collection_generation == GENERATION_NURSERY)
961 return sgen_major_is_object_alive (object);
964 int sgen_gc_invoke_finalizers (void);
968 void sgen_init_gchandles (void);
970 void sgen_null_links_if (SgenObjectPredicateFunc predicate, void *data, int generation, gboolean track);
972 typedef gpointer (*SgenGCHandleIterateCallback) (gpointer hidden, GCHandleType handle_type, int max_generation, gpointer user);
974 void sgen_gchandle_iterate (GCHandleType handle_type, int max_generation, SgenGCHandleIterateCallback callback, gpointer user);
975 void sgen_gchandle_set_target (guint32 gchandle, GCObject *obj);
976 void sgen_mark_normal_gc_handles (void *addr, SgenUserMarkFunc mark_func, void *gc_data);
977 gpointer sgen_gchandle_get_metadata (guint32 gchandle);
981 extern GCMemSection *nursery_section;
982 extern guint32 collect_before_allocs;
983 extern guint32 verify_before_allocs;
984 extern gboolean has_per_allocation_action;
985 extern size_t degraded_mode;
986 extern int default_nursery_size;
987 extern guint32 tlab_size;
988 extern NurseryClearPolicy nursery_clear_policy;
989 extern gboolean sgen_try_free_some_memory;
990 extern mword total_promoted_size;
991 extern mword total_allocated_major;
992 extern volatile gboolean sgen_suspend_finalizers;
993 extern MonoCoopMutex gc_mutex;
994 extern volatile gboolean concurrent_collection_in_progress;
996 /* Nursery helpers. */
999 sgen_set_nursery_scan_start (char *p)
1001 size_t idx = (p - (char*)nursery_section->data) / SGEN_SCAN_START_SIZE;
1002 char *old = nursery_section->scan_starts [idx];
1003 if (!old || old > p)
1004 nursery_section->scan_starts [idx] = p;
1008 /* Object Allocation */
1016 } SgenAllocatorType;
1018 void sgen_clear_tlabs (void);
1020 GCObject* sgen_alloc_obj (GCVTable vtable, size_t size);
1021 GCObject* sgen_alloc_obj_pinned (GCVTable vtable, size_t size);
1022 GCObject* sgen_alloc_obj_mature (GCVTable vtable, size_t size);
1026 void sgen_check_remset_consistency (void);
1027 void sgen_check_mod_union_consistency (void);
1028 void sgen_check_major_refs (void);
1029 void sgen_check_whole_heap (gboolean allow_missing_pinning);
1030 void sgen_check_whole_heap_stw (void);
1031 void sgen_check_objref (char *obj);
1032 void sgen_check_heap_marked (gboolean nursery_must_be_pinned);
1033 void sgen_check_nursery_objects_pinned (gboolean pinned);
1034 void sgen_check_for_xdomain_refs (void);
1035 GCObject* sgen_find_object_for_ptr (char *ptr);
1037 void mono_gc_scan_for_specific_ref (GCObject *key, gboolean precise);
1039 void sgen_debug_enable_heap_dump (const char *filename);
1040 void sgen_debug_dump_heap (const char *type, int num, const char *reason);
1042 void sgen_debug_verify_nursery (gboolean do_dump_nursery_content);
1043 void sgen_debug_check_nursery_is_clean (void);
1045 /* Environment variable parsing */
1047 #define MONO_GC_PARAMS_NAME "MONO_GC_PARAMS"
1048 #define MONO_GC_DEBUG_NAME "MONO_GC_DEBUG"
1050 void sgen_env_var_error (const char *env_var, const char *fallback, const char *description_format, ...);
1054 void sgen_qsort (void *array, size_t count, size_t element_size, int (*compare) (const void*, const void*));
1055 gint64 sgen_timestamp (void);
1058 * Canary (guard word) support
1060 * - CANARY_SIZE must be multiple of word size in bytes
1061 * - Canary space is not included on checks against SGEN_MAX_SMALL_OBJ_SIZE
1064 gboolean nursery_canaries_enabled (void);
1066 #define CANARY_SIZE 8
1067 #define CANARY_STRING "koupepia"
1069 #define CANARIFY_SIZE(size) if (nursery_canaries_enabled ()) { \
1070 size = size + CANARY_SIZE; \
1073 #define CANARIFY_ALLOC(addr,size) if (nursery_canaries_enabled ()) { \
1074 memcpy ((char*) (addr) + (size), CANARY_STRING, CANARY_SIZE); \
1077 #define CANARY_VALID(addr) (strncmp ((char*) (addr), CANARY_STRING, CANARY_SIZE) == 0)
1079 #define CHECK_CANARY_FOR_OBJECT(addr,fail) if (nursery_canaries_enabled ()) { \
1080 guint size = sgen_safe_object_get_size_unaligned ((GCObject *) (addr)); \
1081 char* canary_ptr = (char*) (addr) + size; \
1082 if (!CANARY_VALID(canary_ptr)) { \
1083 char *window_start, *window_end; \
1084 window_start = (char*)(addr) - 128; \
1085 if (!sgen_ptr_in_nursery (window_start)) \
1086 window_start = sgen_get_nursery_start (); \
1087 window_end = (char*)(addr) + 128; \
1088 if (!sgen_ptr_in_nursery (window_end)) \
1089 window_end = sgen_get_nursery_end (); \
1090 fprintf (stderr, "\nCANARY ERROR - Type:%s Size:%d Address:%p Data:\n", sgen_client_vtable_get_name (SGEN_LOAD_VTABLE ((addr))), size, (char*) addr); \
1091 fwrite (addr, sizeof (char), size, stderr); \
1092 fprintf (stderr, "\nCanary zone (next 12 chars):\n"); \
1093 fwrite (canary_ptr, sizeof (char), 12, stderr); \
1094 fprintf (stderr, "\nOriginal canary string:\n"); \
1095 fwrite (CANARY_STRING, sizeof (char), 8, stderr); \
1096 for (int x = -8; x <= 8; x++) { \
1097 if (canary_ptr + x < (char*) addr); \
1099 if (CANARY_VALID(canary_ptr +x)) \
1100 fprintf (stderr, "\nCANARY ERROR - canary found at offset %d\n", x); \
1102 fprintf (stderr, "\nSurrounding nursery (%p - %p):\n", window_start, window_end); \
1103 fwrite (window_start, sizeof (char), window_end - window_start, stderr); \
1107 * This causes the compile to extend the liveness of 'v' till the call to dummy_use
1110 sgen_dummy_use (gpointer v)
1112 #if defined(__GNUC__)
1113 __asm__ volatile ("" : "=r"(v) : "r"(v));
1114 #elif defined(_MSC_VER)
1115 static volatile gpointer ptr;
1118 #error "Implement sgen_dummy_use for your compiler"
1122 #endif /* HAVE_SGEN_GC */
1124 #endif /* __MONO_SGENGC_H__ */