2 * sgen-gc.c: Simple generational GC.
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
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;
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.
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.
22 #ifndef __MONO_SGENGC_H__
23 #define __MONO_SGENGC_H__
30 typedef struct _SgenThreadInfo SgenThreadInfo;
31 #undef THREAD_INFO_TYPE
32 #define THREAD_INFO_TYPE SgenThreadInfo
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"
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
56 CLEAR_AT_TLAB_CREATION,
57 CLEAR_AT_TLAB_CREATION_DEBUG
60 NurseryClearPolicy sgen_get_nursery_clear_policy (void);
62 #if !defined(__MACH__) && !MONO_MACH_ARCH_SUPPORTED && defined(HAVE_PTHREAD_KILL)
63 #define SGEN_POSIX_STW 1
67 * The nursery section uses this struct.
69 typedef struct _GCMemSection GCMemSection;
70 struct _GCMemSection {
73 /* pointer where more data could be allocated if it fits */
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.
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;
88 * Recursion is not allowed for the thread lock.
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)
97 extern MonoCoopMutex sgen_interruption_mutex;
99 #define LOCK_INTERRUPTION mono_coop_mutex_lock (&sgen_interruption_mutex)
100 #define UNLOCK_INTERRUPTION mono_coop_mutex_unlock (&sgen_interruption_mutex)
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 { \
109 } while (InterlockedCompareExchange (&(x), __old_x + (i), __old_x) != __old_x); \
111 #define SGEN_ATOMIC_ADD_P(x,i) do { \
115 } while (InterlockedCompareExchangePointer ((void**)&(x), (void*)(__old_x + (i)), (void*)__old_x) != (void*)__old_x); \
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;
125 #define SGEN_ASSERT(level, a, ...) do { \
126 if (G_UNLIKELY ((level) <= SGEN_MAX_ASSERT_LEVEL && !(a))) { \
127 g_error (__VA_ARGS__); \
131 #define SGEN_LOG(level, format, ...) do { \
132 if (G_UNLIKELY ((level) <= SGEN_MAX_DEBUG_LEVEL && (level) <= gc_debug_level)) { \
133 mono_gc_printf (gc_debug_file, format "\n", ##__VA_ARGS__); \
136 #define SGEN_COND_LOG(level, cond, format, ...) do { \
137 if (G_UNLIKELY ((level) <= SGEN_MAX_DEBUG_LEVEL && (level) <= gc_debug_level)) { \
139 mono_gc_printf (gc_debug_file, format "\n", ##__VA_ARGS__); \
142 extern int gc_debug_level;
143 extern FILE* gc_debug_file;
145 extern int current_collection_generation;
147 extern unsigned int sgen_global_stop_count;
149 #define SGEN_ALIGN_UP_TO(val,align) (((val) + (align - 1)) & ~(align - 1))
150 #define SGEN_ALIGN_DOWN_TO(val,align) ((val) & ~(align - 1))
152 #define SGEN_ALLOC_ALIGN 8
153 #define SGEN_ALLOC_ALIGN_BITS 3
155 /* s must be non-negative */
156 #define SGEN_CAN_ALIGN_UP(s) ((s) <= SIZE_MAX - (SGEN_ALLOC_ALIGN - 1))
157 #define SGEN_ALIGN_UP(s) SGEN_ALIGN_UP_TO(s, SGEN_ALLOC_ALIGN)
158 #define SGEN_ALIGN_DOWN(s) SGEN_ALIGN_DOWN_TO(s, SGEN_ALLOC_ALIGN)
160 #if SIZEOF_VOID_P == 4
167 sgen_aligned_addr_hash (gconstpointer ptr)
169 return GPOINTER_TO_UINT (ptr) >> 3;
172 #define SGEN_PTR_IN_NURSERY(p,bits,start,end) (((mword)(p) & ~((1 << (bits)) - 1)) == (mword)(start))
176 /* good sizes are 512KB-1MB: larger ones increase a lot memzeroing time */
177 #define DEFAULT_NURSERY_SIZE (sgen_nursery_size)
178 extern size_t sgen_nursery_size;
179 /* The number of trailing 0 bits in DEFAULT_NURSERY_SIZE */
180 #define DEFAULT_NURSERY_BITS (sgen_nursery_bits)
181 extern int sgen_nursery_bits;
185 #define DEFAULT_NURSERY_SIZE (4*1024*1024)
186 #define DEFAULT_NURSERY_BITS 22
190 extern char *sgen_nursery_start;
191 extern char *sgen_nursery_end;
193 static inline MONO_ALWAYS_INLINE gboolean
194 sgen_ptr_in_nursery (void *p)
196 return SGEN_PTR_IN_NURSERY ((p), DEFAULT_NURSERY_BITS, sgen_nursery_start, sgen_nursery_end);
199 static inline MONO_ALWAYS_INLINE char*
200 sgen_get_nursery_start (void)
202 return sgen_nursery_start;
205 static inline MONO_ALWAYS_INLINE char*
206 sgen_get_nursery_end (void)
208 return sgen_nursery_end;
212 * We use the lowest three bits in the vtable pointer of objects to tag whether they're
213 * forwarded, pinned, and/or cemented. These are the valid states:
216 * |------------------+------+
218 * | forwarded | 001 |
220 * | pinned, cemented | 110 |
222 * We store them in the vtable slot because the bits are used in the sync block for other
223 * purposes: if we merge them and alloc the sync blocks aligned to 8 bytes, we can change
224 * this and use bit 3 in the syncblock (with the lower two bits both set for forwarded, that
225 * would be an invalid combination for the monitor and hash code).
228 #include "sgen-tagged-pointer.h"
230 #define SGEN_VTABLE_BITS_MASK SGEN_TAGGED_POINTER_MASK
232 #define SGEN_POINTER_IS_TAGGED_FORWARDED(p) SGEN_POINTER_IS_TAGGED_1((p))
233 #define SGEN_POINTER_TAG_FORWARDED(p) SGEN_POINTER_TAG_1((p))
235 #define SGEN_POINTER_IS_TAGGED_PINNED(p) SGEN_POINTER_IS_TAGGED_2((p))
236 #define SGEN_POINTER_TAG_PINNED(p) SGEN_POINTER_TAG_2((p))
238 #define SGEN_POINTER_IS_TAGGED_CEMENTED(p) SGEN_POINTER_IS_TAGGED_4((p))
239 #define SGEN_POINTER_TAG_CEMENTED(p) SGEN_POINTER_TAG_4((p))
241 #define SGEN_POINTER_UNTAG_VTABLE(p) SGEN_POINTER_UNTAG_ALL((p))
243 /* returns NULL if not forwarded, or the forwarded address */
244 #define SGEN_VTABLE_IS_FORWARDED(vtable) ((GCVTable *)(SGEN_POINTER_IS_TAGGED_FORWARDED ((vtable)) ? SGEN_POINTER_UNTAG_VTABLE ((vtable)) : NULL))
245 #define SGEN_OBJECT_IS_FORWARDED(obj) ((GCObject *)SGEN_VTABLE_IS_FORWARDED (((mword*)(obj))[0]))
247 #define SGEN_VTABLE_IS_PINNED(vtable) SGEN_POINTER_IS_TAGGED_PINNED ((vtable))
248 #define SGEN_OBJECT_IS_PINNED(obj) (SGEN_VTABLE_IS_PINNED (((mword*)(obj))[0]))
250 #define SGEN_OBJECT_IS_CEMENTED(obj) (SGEN_POINTER_IS_TAGGED_CEMENTED (((mword*)(obj))[0]))
252 /* set the forwarded address fw_addr for object obj */
253 #define SGEN_FORWARD_OBJECT(obj,fw_addr) do { \
254 *(void**)(obj) = SGEN_POINTER_TAG_FORWARDED ((fw_addr)); \
256 #define SGEN_PIN_OBJECT(obj) do { \
257 *(void**)(obj) = SGEN_POINTER_TAG_PINNED (*(void**)(obj)); \
259 #define SGEN_CEMENT_OBJECT(obj) do { \
260 *(void**)(obj) = SGEN_POINTER_TAG_CEMENTED (*(void**)(obj)); \
262 /* Unpins and uncements */
263 #define SGEN_UNPIN_OBJECT(obj) do { \
264 *(void**)(obj) = SGEN_POINTER_UNTAG_VTABLE (*(void**)(obj)); \
268 * Since we set bits in the vtable, use the macro to load it from the pointer to
269 * an object that is potentially pinned.
271 #define SGEN_LOAD_VTABLE(obj) ((GCVTable)(SGEN_POINTER_UNTAG_ALL (SGEN_LOAD_VTABLE_UNCHECKED ((GCObject *)(obj)))))
274 List of what each bit on of the vtable gc bits means.
277 SGEN_GC_BIT_BRIDGE_OBJECT = 1,
278 SGEN_GC_BIT_BRIDGE_OPAQUE_OBJECT = 2,
279 SGEN_GC_BIT_FINALIZER_AWARE = 4,
282 void sgen_gc_init (void);
284 void sgen_os_init (void);
286 void sgen_update_heap_boundaries (mword low, mword high);
288 void sgen_check_section_scan_starts (GCMemSection *section);
290 void sgen_conservatively_pin_objects_from (void **start, void **end, void *start_nursery, void *end_nursery, int pin_type);
292 /* Keep in sync with description_for_type() in sgen-internal.c! */
294 INTERNAL_MEM_PIN_QUEUE,
295 INTERNAL_MEM_FRAGMENT,
296 INTERNAL_MEM_SECTION,
297 INTERNAL_MEM_SCAN_STARTS,
298 INTERNAL_MEM_FIN_TABLE,
299 INTERNAL_MEM_FINALIZE_ENTRY,
300 INTERNAL_MEM_FINALIZE_READY,
301 INTERNAL_MEM_DISLINK_TABLE,
302 INTERNAL_MEM_DISLINK,
303 INTERNAL_MEM_ROOTS_TABLE,
304 INTERNAL_MEM_ROOT_RECORD,
305 INTERNAL_MEM_STATISTICS,
306 INTERNAL_MEM_STAT_PINNED_CLASS,
307 INTERNAL_MEM_STAT_REMSET_CLASS,
308 INTERNAL_MEM_GRAY_QUEUE,
309 INTERNAL_MEM_MS_TABLES,
310 INTERNAL_MEM_MS_BLOCK_INFO,
311 INTERNAL_MEM_MS_BLOCK_INFO_SORT,
312 INTERNAL_MEM_WORKER_DATA,
313 INTERNAL_MEM_THREAD_POOL_JOB,
314 INTERNAL_MEM_BRIDGE_DATA,
315 INTERNAL_MEM_OLD_BRIDGE_HASH_TABLE,
316 INTERNAL_MEM_OLD_BRIDGE_HASH_TABLE_ENTRY,
317 INTERNAL_MEM_BRIDGE_HASH_TABLE,
318 INTERNAL_MEM_BRIDGE_HASH_TABLE_ENTRY,
319 INTERNAL_MEM_BRIDGE_ALIVE_HASH_TABLE,
320 INTERNAL_MEM_BRIDGE_ALIVE_HASH_TABLE_ENTRY,
321 INTERNAL_MEM_TARJAN_BRIDGE_HASH_TABLE,
322 INTERNAL_MEM_TARJAN_BRIDGE_HASH_TABLE_ENTRY,
323 INTERNAL_MEM_TARJAN_OBJ_BUCKET,
324 INTERNAL_MEM_BRIDGE_DEBUG,
325 INTERNAL_MEM_TOGGLEREF_DATA,
326 INTERNAL_MEM_CARDTABLE_MOD_UNION,
327 INTERNAL_MEM_BINARY_PROTOCOL,
328 INTERNAL_MEM_TEMPORARY,
329 INTERNAL_MEM_FIRST_CLIENT
338 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
339 #define BINARY_PROTOCOL_ARG(x) ,x
341 #define BINARY_PROTOCOL_ARG(x)
344 void sgen_init_internal_allocator (void);
346 #define SGEN_DEFINE_OBJECT_VTABLE
347 #ifdef SGEN_CLIENT_HEADER
348 #include SGEN_CLIENT_HEADER
350 #include "metadata/sgen-client-mono.h"
352 #undef SGEN_DEFINE_OBJECT_VTABLE
354 #include "mono/sgen/sgen-descriptor.h"
355 #include "mono/sgen/sgen-gray.h"
357 /* the runtime can register areas of memory as roots: we keep two lists of roots,
358 * a pinned root set for conservatively scanned roots and a normal one for
359 * precisely scanned roots (currently implemented as a single list).
361 typedef struct _RootRecord RootRecord;
364 SgenDescriptor root_desc;
370 ROOT_TYPE_NORMAL = 0, /* "normal" roots */
371 ROOT_TYPE_PINNED = 1, /* roots without a GC descriptor */
372 ROOT_TYPE_WBARRIER = 2, /* roots with a write barrier */
376 extern SgenHashTable roots_hash [ROOT_TYPE_NUM];
378 int sgen_register_root (char *start, size_t size, SgenDescriptor descr, int root_type, int source, const char *msg);
379 void sgen_deregister_root (char* addr);
381 typedef void (*IterateObjectCallbackFunc) (GCObject*, size_t, void*);
383 void sgen_scan_area_with_callback (char *start, char *end, IterateObjectCallbackFunc callback, void *data, gboolean allow_flags, gboolean fail_on_canaries);
385 /* eventually share with MonoThread? */
387 * This structure extends the MonoThreadInfo structure.
389 struct _SgenThreadInfo {
390 SgenClientThreadInfo client_info;
392 char **tlab_next_addr;
393 char **tlab_start_addr;
394 char **tlab_temp_end_addr;
395 char **tlab_real_end_addr;
397 #ifndef HAVE_KW_THREAD
405 gboolean sgen_is_worker_thread (MonoNativeThreadId thread);
407 typedef void (*CopyOrMarkObjectFunc) (GCObject**, SgenGrayQueue*);
408 typedef void (*ScanObjectFunc) (GCObject *obj, SgenDescriptor desc, SgenGrayQueue*);
409 typedef void (*ScanVTypeFunc) (GCObject *full_object, char *start, SgenDescriptor desc, SgenGrayQueue* BINARY_PROTOCOL_ARG (size_t size));
410 typedef void (*ScanPtrFieldFunc) (GCObject *obj, GCObject **ptr, SgenGrayQueue* queue);
411 typedef gboolean (*DrainGrayStackFunc) (SgenGrayQueue *queue);
414 CopyOrMarkObjectFunc copy_or_mark_object;
415 ScanObjectFunc scan_object;
416 ScanVTypeFunc scan_vtype;
417 ScanPtrFieldFunc scan_ptr_field;
418 /* Drain stack optimized for the above functions */
419 DrainGrayStackFunc drain_gray_stack;
420 /*FIXME add allocation function? */
421 } SgenObjectOperations;
425 SgenObjectOperations *ops;
426 SgenGrayQueue *queue;
429 #define CONTEXT_FROM_OBJECT_OPERATIONS(ops, queue) ((ScanCopyContext) { (ops), (queue) })
431 void sgen_report_internal_mem_usage (void);
432 void sgen_dump_internal_mem_usage (FILE *heap_dump_file);
433 void sgen_dump_section (GCMemSection *section, const char *type);
434 void sgen_dump_occupied (char *start, char *end, char *section_start);
436 void sgen_register_fixed_internal_mem_type (int type, size_t size);
438 void* sgen_alloc_internal (int type);
439 void sgen_free_internal (void *addr, int type);
441 void* sgen_alloc_internal_dynamic (size_t size, int type, gboolean assert_on_failure);
442 void sgen_free_internal_dynamic (void *addr, size_t size, int type);
444 void sgen_pin_stats_enable (void);
445 void sgen_pin_stats_register_object (GCObject *obj, size_t size);
446 void sgen_pin_stats_register_global_remset (GCObject *obj);
447 void sgen_pin_stats_print_class_stats (void);
449 void sgen_sort_addresses (void **array, size_t size);
450 void sgen_add_to_global_remset (gpointer ptr, GCObject *obj);
452 int sgen_get_current_collection_generation (void);
453 gboolean sgen_collection_is_concurrent (void);
454 gboolean sgen_concurrent_collection_in_progress (void);
456 typedef struct _SgenFragment SgenFragment;
458 struct _SgenFragment {
460 char *fragment_start;
461 char *fragment_next; /* the current soft limit for allocation */
463 SgenFragment *next_in_order; /* We use a different entry for all active fragments so we can avoid SMR. */
467 SgenFragment *alloc_head; /* List head to be used when allocating memory. Walk with fragment_next. */
468 SgenFragment *region_head; /* List head of the region used by this allocator. Walk with next_in_order. */
469 } SgenFragmentAllocator;
471 void sgen_fragment_allocator_add (SgenFragmentAllocator *allocator, char *start, char *end);
472 void sgen_fragment_allocator_release (SgenFragmentAllocator *allocator);
473 void* sgen_fragment_allocator_serial_alloc (SgenFragmentAllocator *allocator, size_t size);
474 void* sgen_fragment_allocator_par_alloc (SgenFragmentAllocator *allocator, size_t size);
475 void* sgen_fragment_allocator_serial_range_alloc (SgenFragmentAllocator *allocator, size_t desired_size, size_t minimum_size, size_t *out_alloc_size);
476 void* sgen_fragment_allocator_par_range_alloc (SgenFragmentAllocator *allocator, size_t desired_size, size_t minimum_size, size_t *out_alloc_size);
477 SgenFragment* sgen_fragment_allocator_alloc (void);
478 void sgen_clear_allocator_fragments (SgenFragmentAllocator *allocator);
479 void sgen_clear_range (char *start, char *end);
483 This is a space/speed compromise as we need to make sure the from/to space check is both O(1)
484 and only hit cache hot memory. On a 4Mb nursery it requires 1024 bytes, or 3% of your average
485 L1 cache. On small configs with a 512kb nursery, this goes to 0.4%.
487 Experimental results on how much space we waste with a 4Mb nursery:
489 Note that the wastage applies to the half nursery, or 2Mb:
491 Test 1 (compiling corlib):
496 #define SGEN_TO_SPACE_GRANULE_BITS 9
497 #define SGEN_TO_SPACE_GRANULE_IN_BYTES (1 << SGEN_TO_SPACE_GRANULE_BITS)
499 extern char *sgen_space_bitmap;
500 extern size_t sgen_space_bitmap_size;
502 static inline gboolean
503 sgen_nursery_is_to_space (void *object)
505 size_t idx = ((char*)object - sgen_nursery_start) >> SGEN_TO_SPACE_GRANULE_BITS;
506 size_t byte = idx >> 3;
507 size_t bit = idx & 0x7;
509 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 ());
510 SGEN_ASSERT (4, byte < sgen_space_bitmap_size, "byte index %zd out of range (%zd)", byte, sgen_space_bitmap_size);
512 return (sgen_space_bitmap [byte] & (1 << bit)) != 0;
515 static inline gboolean
516 sgen_nursery_is_from_space (void *object)
518 return !sgen_nursery_is_to_space (object);
521 static inline gboolean
522 sgen_nursery_is_object_alive (GCObject *obj)
524 /* FIXME put this asserts under a non default level */
525 g_assert (sgen_ptr_in_nursery (obj));
527 if (sgen_nursery_is_to_space (obj))
530 if (SGEN_OBJECT_IS_PINNED (obj) || SGEN_OBJECT_IS_FORWARDED (obj))
539 GCObject* (*alloc_for_promotion) (GCVTable vtable, GCObject *obj, size_t objsize, gboolean has_references);
541 SgenObjectOperations serial_ops;
543 void (*prepare_to_space) (char *to_space_bitmap, size_t space_bitmap_size);
544 void (*clear_fragments) (void);
545 SgenFragment* (*build_fragments_get_exclude_head) (void);
546 void (*build_fragments_release_exclude_head) (void);
547 void (*build_fragments_finish) (SgenFragmentAllocator *allocator);
548 void (*init_nursery) (SgenFragmentAllocator *allocator, char *start, char *end);
550 gboolean (*handle_gc_param) (const char *opt); /* Optional */
551 void (*print_gc_param_usage) (void); /* Optional */
552 } SgenMinorCollector;
554 extern SgenMinorCollector sgen_minor_collector;
556 void sgen_simple_nursery_init (SgenMinorCollector *collector);
557 void sgen_split_nursery_init (SgenMinorCollector *collector);
559 /* Updating references */
561 #ifdef SGEN_CHECK_UPDATE_REFERENCE
562 gboolean sgen_thread_pool_is_thread_pool_thread (MonoNativeThreadId some_thread) MONO_INTERNAL;
564 sgen_update_reference (GCObject **p, GCObject *o, gboolean allow_null)
567 SGEN_ASSERT (0, o, "Cannot update a reference with a NULL pointer");
568 SGEN_ASSERT (0, !sgen_thread_pool_is_thread_pool_thread (mono_native_thread_id_get ()), "Can't update a reference in the worker thread");
572 #define SGEN_UPDATE_REFERENCE_ALLOW_NULL(p,o) sgen_update_reference ((GCObject**)(p), (GCObject*)(o), TRUE)
573 #define SGEN_UPDATE_REFERENCE(p,o) sgen_update_reference ((GCObject**)(p), (GCObject*)(o), FALSE)
575 #define SGEN_UPDATE_REFERENCE_ALLOW_NULL(p,o) (*(GCObject**)(p) = (GCObject*)(o))
576 #define SGEN_UPDATE_REFERENCE(p,o) SGEN_UPDATE_REFERENCE_ALLOW_NULL ((p), (o))
579 /* Major collector */
581 typedef void (*sgen_cardtable_block_callback) (mword start, mword size);
582 void sgen_major_collector_iterate_live_block_ranges (sgen_cardtable_block_callback callback);
585 ITERATE_OBJECTS_SWEEP = 1,
586 ITERATE_OBJECTS_NON_PINNED = 2,
587 ITERATE_OBJECTS_PINNED = 4,
588 ITERATE_OBJECTS_ALL = ITERATE_OBJECTS_NON_PINNED | ITERATE_OBJECTS_PINNED,
589 ITERATE_OBJECTS_SWEEP_NON_PINNED = ITERATE_OBJECTS_SWEEP | ITERATE_OBJECTS_NON_PINNED,
590 ITERATE_OBJECTS_SWEEP_PINNED = ITERATE_OBJECTS_SWEEP | ITERATE_OBJECTS_PINNED,
591 ITERATE_OBJECTS_SWEEP_ALL = ITERATE_OBJECTS_SWEEP | ITERATE_OBJECTS_NON_PINNED | ITERATE_OBJECTS_PINNED
592 } IterateObjectsFlags;
596 size_t num_scanned_objects;
597 size_t num_unique_scanned_objects;
598 } ScannedObjectCounts;
601 CARDTABLE_SCAN_GLOBAL = 0,
602 CARDTABLE_SCAN_MOD_UNION = 1,
603 CARDTABLE_SCAN_MOD_UNION_PRECLEAN = CARDTABLE_SCAN_MOD_UNION | 2,
606 typedef struct _SgenMajorCollector SgenMajorCollector;
607 struct _SgenMajorCollector {
609 gboolean is_concurrent;
610 gboolean needs_thread_pool;
611 gboolean supports_cardtable;
612 gboolean sweeps_lazily;
614 void* (*alloc_heap) (mword nursery_size, mword nursery_align, int nursery_bits);
615 gboolean (*is_object_live) (GCObject *obj);
616 GCObject* (*alloc_small_pinned_obj) (GCVTable vtable, size_t size, gboolean has_references);
617 GCObject* (*alloc_degraded) (GCVTable vtable, size_t size);
619 SgenObjectOperations major_ops_serial;
620 SgenObjectOperations major_ops_concurrent_start;
621 SgenObjectOperations major_ops_concurrent_finish;
623 GCObject* (*alloc_object) (GCVTable vtable, size_t size, gboolean has_references);
624 void (*free_pinned_object) (GCObject *obj, size_t size);
627 * This is used for domain unloading, heap walking from the logging profiler, and
628 * debugging. Can assume the world is stopped.
630 void (*iterate_objects) (IterateObjectsFlags flags, IterateObjectCallbackFunc callback, void *data);
632 void (*free_non_pinned_object) (GCObject *obj, size_t size);
633 void (*pin_objects) (SgenGrayQueue *queue);
634 void (*pin_major_object) (GCObject *obj, SgenGrayQueue *queue);
635 void (*scan_card_table) (CardTableScanType scan_type, ScanCopyContext ctx);
636 void (*iterate_live_block_ranges) (sgen_cardtable_block_callback callback);
637 void (*update_cardtable_mod_union) (void);
638 void (*init_to_space) (void);
639 void (*sweep) (void);
640 gboolean (*have_swept) (void);
641 void (*finish_sweeping) (void);
642 void (*free_swept_blocks) (size_t allowance);
643 void (*check_scan_starts) (void);
644 void (*dump_heap) (FILE *heap_dump_file);
645 gint64 (*get_used_size) (void);
646 void (*start_nursery_collection) (void);
647 void (*finish_nursery_collection) (void);
648 void (*start_major_collection) (void);
649 void (*finish_major_collection) (ScannedObjectCounts *counts);
650 gboolean (*ptr_is_in_non_pinned_space) (char *ptr, char **start);
651 gboolean (*ptr_is_from_pinned_alloc) (char *ptr);
652 void (*report_pinned_memory_usage) (void);
653 size_t (*get_num_major_sections) (void);
654 size_t (*get_bytes_survived_last_sweep) (void);
655 gboolean (*handle_gc_param) (const char *opt);
656 void (*print_gc_param_usage) (void);
657 void (*post_param_init) (SgenMajorCollector *collector);
658 gboolean (*is_valid_object) (char *ptr);
659 GCVTable (*describe_pointer) (char *pointer);
660 guint8* (*get_cardtable_mod_union_for_reference) (char *object);
661 long long (*get_and_reset_num_major_objects_marked) (void);
662 void (*count_cards) (long long *num_total_cards, long long *num_marked_cards);
665 extern SgenMajorCollector major_collector;
667 void sgen_marksweep_init (SgenMajorCollector *collector);
668 void sgen_marksweep_fixed_init (SgenMajorCollector *collector);
669 void sgen_marksweep_par_init (SgenMajorCollector *collector);
670 void sgen_marksweep_fixed_par_init (SgenMajorCollector *collector);
671 void sgen_marksweep_conc_init (SgenMajorCollector *collector);
672 SgenMajorCollector* sgen_get_major_collector (void);
675 typedef struct _SgenRememberedSet {
676 void (*wbarrier_set_field) (GCObject *obj, gpointer field_ptr, GCObject* value);
677 void (*wbarrier_arrayref_copy) (gpointer dest_ptr, gpointer src_ptr, int count);
678 void (*wbarrier_value_copy) (gpointer dest, gpointer src, int count, size_t element_size);
679 void (*wbarrier_object_copy) (GCObject* obj, GCObject *src);
680 void (*wbarrier_generic_nostore) (gpointer ptr);
681 void (*record_pointer) (gpointer ptr);
683 void (*scan_remsets) (ScanCopyContext ctx);
685 void (*clear_cards) (void);
687 void (*finish_minor_collection) (void);
688 gboolean (*find_address) (char *addr);
689 gboolean (*find_address_with_cards) (char *cards_start, guint8 *cards, char *addr);
692 SgenRememberedSet *sgen_get_remset (void);
695 * These must be kept in sync with object.h. They're here for using SGen independently of
698 void mono_gc_wbarrier_arrayref_copy (gpointer dest_ptr, gpointer src_ptr, int count);
699 void mono_gc_wbarrier_generic_nostore (gpointer ptr);
700 void mono_gc_wbarrier_generic_store (gpointer ptr, GCObject* value);
701 void mono_gc_wbarrier_generic_store_atomic (gpointer ptr, GCObject *value);
703 void sgen_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap);
705 static inline SgenDescriptor
706 sgen_obj_get_descriptor (GCObject *obj)
708 GCVTable vtable = SGEN_LOAD_VTABLE_UNCHECKED (obj);
709 SGEN_ASSERT (9, !SGEN_POINTER_IS_TAGGED_ANY (vtable), "Object can't be tagged");
710 return sgen_vtable_get_descriptor (vtable);
713 static inline SgenDescriptor
714 sgen_obj_get_descriptor_safe (GCObject *obj)
716 GCVTable vtable = SGEN_LOAD_VTABLE (obj);
717 return sgen_vtable_get_descriptor (vtable);
720 static mword sgen_client_par_object_get_size (GCVTable vtable, GCObject* o);
721 static mword sgen_client_slow_object_get_size (GCVTable vtable, GCObject* o);
724 sgen_safe_object_get_size (GCObject *obj)
728 if ((forwarded = SGEN_OBJECT_IS_FORWARDED (obj)))
731 return sgen_client_par_object_get_size (SGEN_LOAD_VTABLE (obj), obj);
734 static inline gboolean
735 sgen_safe_object_is_small (GCObject *obj, int type)
737 if (type <= DESC_TYPE_MAX_SMALL_OBJ)
739 return SGEN_ALIGN_UP (sgen_safe_object_get_size ((GCObject*)obj)) <= SGEN_MAX_SMALL_OBJ_SIZE;
743 * This variant guarantees to return the exact size of the object
744 * before alignment. Needed for canary support.
747 sgen_safe_object_get_size_unaligned (GCObject *obj)
751 if ((forwarded = SGEN_OBJECT_IS_FORWARDED (obj))) {
752 obj = (GCObject*)forwarded;
755 return sgen_client_slow_object_get_size (SGEN_LOAD_VTABLE (obj), obj);
758 #ifdef SGEN_CLIENT_HEADER
759 #include SGEN_CLIENT_HEADER
761 #include "metadata/sgen-client-mono.h"
764 gboolean sgen_object_is_live (GCObject *obj);
766 void sgen_init_fin_weak_hash (void);
768 /* FIXME: move the toggleref stuff out of here */
769 void sgen_mark_togglerefs (char *start, char *end, ScanCopyContext ctx);
770 void sgen_clear_togglerefs (char *start, char *end, ScanCopyContext ctx);
772 void sgen_process_togglerefs (void);
773 void sgen_register_test_toggleref_callback (void);
775 void sgen_mark_bridge_object (GCObject *obj);
776 void sgen_collect_bridge_objects (int generation, ScanCopyContext ctx);
778 typedef gboolean (*SgenObjectPredicateFunc) (GCObject *obj, void *user_data);
780 void sgen_null_links_if (SgenObjectPredicateFunc predicate, void *data, int generation, gboolean track);
782 gboolean sgen_gc_is_object_ready_for_finalization (GCObject *object);
783 void sgen_gc_lock (void);
784 void sgen_gc_unlock (void);
786 void sgen_queue_finalization_entry (GCObject *obj);
787 const char* sgen_generation_name (int generation);
789 void sgen_finalize_in_range (int generation, ScanCopyContext ctx);
790 void sgen_null_link_in_range (int generation, ScanCopyContext ctx, gboolean track);
791 void sgen_process_fin_stage_entries (void);
792 gboolean sgen_have_pending_finalizers (void);
793 void sgen_object_register_for_finalization (GCObject *obj, void *user_data);
795 int sgen_gather_finalizers_if (SgenObjectPredicateFunc predicate, void *user_data, GCObject **out_array, int out_size);
796 void sgen_remove_finalizers_if (SgenObjectPredicateFunc predicate, void *user_data, int generation);
798 void sgen_register_disappearing_link (GCObject *obj, void **link, gboolean track, gboolean in_gc);
800 GCObject* sgen_weak_link_get (void **link_addr);
802 gboolean sgen_drain_gray_stack (ScanCopyContext ctx);
810 void sgen_pin_object (GCObject *object, SgenGrayQueue *queue);
811 void sgen_set_pinned_from_failed_allocation (mword objsize);
813 void sgen_ensure_free_space (size_t size, int generation);
814 void sgen_gc_collect (int generation);
815 void sgen_perform_collection (size_t requested_size, int generation_to_collect, const char *reason, gboolean wait_to_finish);
817 int sgen_gc_collection_count (int generation);
818 /* FIXME: what exactly does this return? */
819 size_t sgen_gc_get_used_size (void);
820 size_t sgen_gc_get_total_heap_allocation (void);
827 gboolean is_overflow;
833 void sgen_stop_world (int generation);
834 void sgen_restart_world (int generation, GGTimingInfo *timing);
835 gboolean sgen_is_world_stopped (void);
837 gboolean sgen_set_allow_synchronous_major (gboolean flag);
841 typedef struct _LOSObject LOSObject;
844 mword size; /* this is the object size, lowest bit used for pin/mark */
845 guint8 * volatile cardtable_mod_union; /* only used by the concurrent collector */
846 #if SIZEOF_VOID_P < 8
847 mword dummy; /* to align object to sizeof (double) */
849 GCObject data [MONO_ZERO_LEN_ARRAY];
852 extern LOSObject *los_object_list;
853 extern mword los_memory_usage;
855 void sgen_los_free_object (LOSObject *obj);
856 void* sgen_los_alloc_large_inner (GCVTable vtable, size_t size);
857 void sgen_los_sweep (void);
858 gboolean sgen_ptr_is_in_los (char *ptr, char **start);
859 void sgen_los_iterate_objects (IterateObjectCallbackFunc cb, void *user_data);
860 void sgen_los_iterate_live_block_ranges (sgen_cardtable_block_callback callback);
861 void sgen_los_scan_card_table (CardTableScanType scan_type, ScanCopyContext ctx);
862 void sgen_los_update_cardtable_mod_union (void);
863 void sgen_los_count_cards (long long *num_total_cards, long long *num_marked_cards);
864 gboolean sgen_los_is_valid_object (char *object);
865 gboolean mono_sgen_los_describe_pointer (char *ptr);
866 LOSObject* sgen_los_header_for_object (GCObject *data);
867 mword sgen_los_object_size (LOSObject *obj);
868 void sgen_los_pin_object (GCObject *obj);
869 gboolean sgen_los_object_is_pinned (GCObject *obj);
870 void sgen_los_mark_mod_union_card (GCObject *mono_obj, void **ptr);
873 /* nursery allocator */
875 void sgen_clear_nursery_fragments (void);
876 void sgen_nursery_allocator_prepare_for_pinning (void);
877 void sgen_nursery_allocator_set_nursery_bounds (char *nursery_start, char *nursery_end);
878 mword sgen_build_nursery_fragments (GCMemSection *nursery_section, SgenGrayQueue *unpin_queue);
879 void sgen_init_nursery_allocator (void);
880 void sgen_nursery_allocator_init_heavy_stats (void);
881 void sgen_init_allocator (void);
882 char* sgen_nursery_alloc_get_upper_alloc_bound (void);
883 void* sgen_nursery_alloc (size_t size);
884 void* sgen_nursery_alloc_range (size_t size, size_t min_size, size_t *out_alloc_size);
885 gboolean sgen_can_alloc_size (size_t size);
886 void sgen_nursery_retire_region (void *address, ptrdiff_t size);
888 void sgen_nursery_alloc_prepare_for_minor (void);
889 void sgen_nursery_alloc_prepare_for_major (void);
891 GCObject* sgen_alloc_for_promotion (GCObject *obj, size_t objsize, gboolean has_references);
893 GCObject* sgen_alloc_obj_nolock (GCVTable vtable, size_t size);
894 GCObject* sgen_try_alloc_obj_nolock (GCVTable vtable, size_t size);
898 void* sgen_thread_register (SgenThreadInfo* info, void *addr);
899 void sgen_thread_unregister (SgenThreadInfo *p);
901 /* Finalization/ephemeron support */
903 static inline gboolean
904 sgen_major_is_object_alive (GCObject *object)
908 /* Oldgen objects can be pinned and forwarded too */
909 if (SGEN_OBJECT_IS_PINNED (object) || SGEN_OBJECT_IS_FORWARDED (object))
913 * FIXME: major_collector.is_object_live() also calculates the
914 * size. Avoid the double calculation.
916 objsize = SGEN_ALIGN_UP (sgen_safe_object_get_size (object));
917 if (objsize > SGEN_MAX_SMALL_OBJ_SIZE)
918 return sgen_los_object_is_pinned (object);
920 return major_collector.is_object_live (object);
924 * This function returns true if @object is either alive or it belongs to the old gen
925 * and we're currently doing a minor collection.
928 sgen_is_object_alive_for_current_gen (GCObject *object)
930 if (sgen_ptr_in_nursery (object))
931 return sgen_nursery_is_object_alive (object);
933 if (current_collection_generation == GENERATION_NURSERY)
936 return sgen_major_is_object_alive (object);
939 int sgen_gc_invoke_finalizers (void);
943 void sgen_init_gchandles (void);
945 void sgen_null_links_if (SgenObjectPredicateFunc predicate, void *data, int generation, gboolean track);
947 typedef gpointer (*SgenGCHandleIterateCallback) (gpointer hidden, GCHandleType handle_type, int max_generation, gpointer user);
949 void sgen_gchandle_iterate (GCHandleType handle_type, int max_generation, SgenGCHandleIterateCallback callback, gpointer user);
950 void sgen_gchandle_set_target (guint32 gchandle, GCObject *obj);
951 void sgen_mark_normal_gc_handles (void *addr, SgenUserMarkFunc mark_func, void *gc_data);
952 gpointer sgen_gchandle_get_metadata (guint32 gchandle);
956 extern GCMemSection *nursery_section;
957 extern guint32 collect_before_allocs;
958 extern guint32 verify_before_allocs;
959 extern gboolean has_per_allocation_action;
960 extern size_t degraded_mode;
961 extern int default_nursery_size;
962 extern guint32 tlab_size;
963 extern NurseryClearPolicy nursery_clear_policy;
964 extern gboolean sgen_try_free_some_memory;
966 extern MonoCoopMutex gc_mutex;
968 /* Nursery helpers. */
971 sgen_set_nursery_scan_start (char *p)
973 size_t idx = (p - (char*)nursery_section->data) / SGEN_SCAN_START_SIZE;
974 char *old = nursery_section->scan_starts [idx];
976 nursery_section->scan_starts [idx] = p;
980 /* Object Allocation */
990 void sgen_init_tlab_info (SgenThreadInfo* info);
991 void sgen_clear_tlabs (void);
993 GCObject* sgen_alloc_obj (GCVTable vtable, size_t size);
994 GCObject* sgen_alloc_obj_pinned (GCVTable vtable, size_t size);
995 GCObject* sgen_alloc_obj_mature (GCVTable vtable, size_t size);
999 void sgen_check_consistency (void);
1000 void sgen_check_mod_union_consistency (void);
1001 void sgen_check_major_refs (void);
1002 void sgen_check_whole_heap (gboolean allow_missing_pinning);
1003 void sgen_check_whole_heap_stw (void);
1004 void sgen_check_objref (char *obj);
1005 void sgen_check_heap_marked (gboolean nursery_must_be_pinned);
1006 void sgen_check_nursery_objects_pinned (gboolean pinned);
1007 void sgen_check_for_xdomain_refs (void);
1008 GCObject* sgen_find_object_for_ptr (char *ptr);
1010 void mono_gc_scan_for_specific_ref (GCObject *key, gboolean precise);
1012 void sgen_debug_enable_heap_dump (const char *filename);
1013 void sgen_debug_dump_heap (const char *type, int num, const char *reason);
1015 void sgen_debug_verify_nursery (gboolean do_dump_nursery_content);
1016 void sgen_debug_check_nursery_is_clean (void);
1018 /* Environment variable parsing */
1020 #define MONO_GC_PARAMS_NAME "MONO_GC_PARAMS"
1021 #define MONO_GC_DEBUG_NAME "MONO_GC_DEBUG"
1023 void sgen_env_var_error (const char *env_var, const char *fallback, const char *description_format, ...);
1027 void sgen_qsort (void *base, size_t nel, size_t width, int (*compar) (const void*, const void*));
1028 gint64 sgen_timestamp (void);
1031 * Canary (guard word) support
1033 * - CANARY_SIZE must be multiple of word size in bytes
1034 * - Canary space is not included on checks against SGEN_MAX_SMALL_OBJ_SIZE
1037 gboolean nursery_canaries_enabled (void);
1039 #define CANARY_SIZE 8
1040 #define CANARY_STRING "koupepia"
1042 #define CANARIFY_SIZE(size) if (nursery_canaries_enabled ()) { \
1043 size = size + CANARY_SIZE; \
1046 #define CANARIFY_ALLOC(addr,size) if (nursery_canaries_enabled ()) { \
1047 memcpy ((char*) (addr) + (size), CANARY_STRING, CANARY_SIZE); \
1050 #define CANARY_VALID(addr) (strncmp ((char*) (addr), CANARY_STRING, CANARY_SIZE) == 0)
1052 #define CHECK_CANARY_FOR_OBJECT(addr,fail) if (nursery_canaries_enabled ()) { \
1053 char* canary_ptr = (char*) (addr) + sgen_safe_object_get_size_unaligned ((GCObject *) (addr)); \
1054 if (!CANARY_VALID(canary_ptr)) { \
1055 char canary_copy[CANARY_SIZE +1]; \
1056 strncpy (canary_copy, canary_ptr, CANARY_SIZE); \
1057 canary_copy[CANARY_SIZE] = 0; \
1059 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); \
1061 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); \
1065 * This causes the compile to extend the liveness of 'v' till the call to dummy_use
1068 sgen_dummy_use (gpointer v)
1070 #if defined(__GNUC__)
1071 __asm__ volatile ("" : "=r"(v) : "r"(v));
1072 #elif defined(_MSC_VER)
1073 static volatile gpointer ptr;
1076 #error "Implement sgen_dummy_use for your compiler"
1080 #endif /* HAVE_SGEN_GC */
1082 #endif /* __MONO_SGENGC_H__ */