2 * sgen-mono.c: SGen features specific to Mono.
4 * Copyright (C) 2014 Xamarin Inc
6 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
12 #include "sgen/sgen-gc.h"
13 #include "sgen/sgen-protocol.h"
14 #include "metadata/monitor.h"
15 #include "sgen/sgen-layout-stats.h"
16 #include "sgen/sgen-client.h"
17 #include "sgen/sgen-cardtable.h"
18 #include "sgen/sgen-pinning.h"
19 #include "metadata/marshal.h"
20 #include "metadata/method-builder.h"
21 #include "metadata/abi-details.h"
22 #include "metadata/mono-gc.h"
23 #include "metadata/runtime.h"
24 #include "metadata/sgen-bridge-internals.h"
25 #include "metadata/gc-internals.h"
26 #include "metadata/handle.h"
27 #include "utils/mono-memory-model.h"
28 #include "utils/mono-logger-internals.h"
29 #include "sgen/sgen-thread-pool.h"
31 #ifdef HEAVY_STATISTICS
32 static guint64 stat_wbarrier_set_arrayref = 0;
33 static guint64 stat_wbarrier_value_copy = 0;
34 static guint64 stat_wbarrier_object_copy = 0;
36 static guint64 los_marked_cards;
37 static guint64 los_array_cards;
38 static guint64 los_array_remsets;
41 /* If set, mark stacks conservatively, even if precise marking is possible */
42 static gboolean conservative_stack_mark = FALSE;
43 /* If set, check that there are no references to the domain left at domain unload */
44 gboolean sgen_mono_xdomain_checks = FALSE;
46 /* Functions supplied by the runtime to be called by the GC */
47 static MonoGCCallbacks gc_callbacks;
50 __thread SgenThreadInfo *sgen_thread_info;
52 MonoNativeTlsKey thread_info_key;
55 #define ALIGN_TO(val,align) ((((guint64)val) + ((align) - 1)) & ~((align) - 1))
57 #define OPDEF(a,b,c,d,e,f,g,h,i,j) \
61 #include "mono/cil/opcode.def"
72 ptr_on_stack (void *ptr)
74 gpointer stack_start = &stack_start;
75 SgenThreadInfo *info = mono_thread_info_current ();
77 if (ptr >= stack_start && ptr < (gpointer)info->client_info.stack_end)
82 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
84 #define HANDLE_PTR(ptr,obj) do { \
85 gpointer o = *(gpointer*)(ptr); \
87 gpointer d = ((char*)dest) + ((char*)(ptr) - (char*)(obj)); \
88 binary_protocol_wbarrier (d, o, (gpointer) SGEN_LOAD_VTABLE (o)); \
93 scan_object_for_binary_protocol_copy_wbarrier (gpointer dest, char *start, mword desc)
95 #define SCAN_OBJECT_NOVTABLE
96 #include "sgen/sgen-scan-object.h"
101 mono_gc_wbarrier_value_copy (gpointer dest, gpointer src, int count, MonoClass *klass)
103 HEAVY_STAT (++stat_wbarrier_value_copy);
104 g_assert (klass->valuetype);
106 SGEN_LOG (8, "Adding value remset at %p, count %d, descr %p for class %s (%p)", dest, count, (gpointer)klass->gc_descr, klass->name, klass);
108 if (sgen_ptr_in_nursery (dest) || ptr_on_stack (dest) || !sgen_gc_descr_has_references ((mword)klass->gc_descr)) {
109 size_t element_size = mono_class_value_size (klass, NULL);
110 size_t size = count * element_size;
111 mono_gc_memmove_atomic (dest, src, size);
115 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
116 if (binary_protocol_is_heavy_enabled ()) {
117 size_t element_size = mono_class_value_size (klass, NULL);
119 for (i = 0; i < count; ++i) {
120 scan_object_for_binary_protocol_copy_wbarrier ((char*)dest + i * element_size,
121 (char*)src + i * element_size - sizeof (MonoObject),
122 (mword) klass->gc_descr);
127 sgen_get_remset ()->wbarrier_value_copy (dest, src, count, mono_class_value_size (klass, NULL));
131 * mono_gc_wbarrier_object_copy:
133 * Write barrier to call when obj is the result of a clone or copy of an object.
136 mono_gc_wbarrier_object_copy (MonoObject* obj, MonoObject *src)
140 HEAVY_STAT (++stat_wbarrier_object_copy);
142 if (sgen_ptr_in_nursery (obj) || ptr_on_stack (obj) || !SGEN_OBJECT_HAS_REFERENCES (src)) {
143 size = mono_object_class (obj)->instance_size;
144 mono_gc_memmove_aligned ((char*)obj + sizeof (MonoObject), (char*)src + sizeof (MonoObject),
145 size - sizeof (MonoObject));
149 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
150 if (binary_protocol_is_heavy_enabled ())
151 scan_object_for_binary_protocol_copy_wbarrier (obj, (char*)src, (mword) src->vtable->gc_descr);
154 sgen_get_remset ()->wbarrier_object_copy (obj, src);
158 mono_gc_wbarrier_set_arrayref (MonoArray *arr, gpointer slot_ptr, MonoObject* value)
160 HEAVY_STAT (++stat_wbarrier_set_arrayref);
161 if (sgen_ptr_in_nursery (slot_ptr)) {
162 *(void**)slot_ptr = value;
165 SGEN_LOG (8, "Adding remset at %p", slot_ptr);
167 binary_protocol_wbarrier (slot_ptr, value, value->vtable);
169 sgen_get_remset ()->wbarrier_set_field ((GCObject*)arr, slot_ptr, value);
173 mono_gc_wbarrier_set_field (MonoObject *obj, gpointer field_ptr, MonoObject* value)
175 mono_gc_wbarrier_set_arrayref ((MonoArray*)obj, field_ptr, value);
179 mono_gc_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap)
181 sgen_wbarrier_value_copy_bitmap (_dest, _src, size, bitmap);
184 static MonoMethod *write_barrier_conc_method;
185 static MonoMethod *write_barrier_noconc_method;
188 sgen_is_critical_method (MonoMethod *method)
190 return (method == write_barrier_conc_method || method == write_barrier_noconc_method || sgen_is_managed_allocator (method));
194 sgen_has_critical_method (void)
196 return write_barrier_conc_method || write_barrier_noconc_method || sgen_has_managed_allocator ();
202 emit_nursery_check (MonoMethodBuilder *mb, int *nursery_check_return_labels, gboolean is_concurrent)
204 int shifted_nursery_start = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
206 memset (nursery_check_return_labels, 0, sizeof (int) * 2);
207 // if (ptr_in_nursery (ptr)) return;
209 * Masking out the bits might be faster, but we would have to use 64 bit
210 * immediates, which might be slower.
212 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
213 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_START);
214 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
215 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_BITS);
216 mono_mb_emit_byte (mb, CEE_SHR_UN);
217 mono_mb_emit_stloc (mb, shifted_nursery_start);
219 mono_mb_emit_ldarg (mb, 0);
220 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
221 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_BITS);
222 mono_mb_emit_byte (mb, CEE_SHR_UN);
223 mono_mb_emit_ldloc (mb, shifted_nursery_start);
224 nursery_check_return_labels [0] = mono_mb_emit_branch (mb, CEE_BEQ);
226 if (!is_concurrent) {
227 // if (!ptr_in_nursery (*ptr)) return;
228 mono_mb_emit_ldarg (mb, 0);
229 mono_mb_emit_byte (mb, CEE_LDIND_I);
230 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
231 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_BITS);
232 mono_mb_emit_byte (mb, CEE_SHR_UN);
233 mono_mb_emit_ldloc (mb, shifted_nursery_start);
234 nursery_check_return_labels [1] = mono_mb_emit_branch (mb, CEE_BNE_UN);
240 mono_gc_get_specific_write_barrier (gboolean is_concurrent)
243 MonoMethodBuilder *mb;
244 MonoMethodSignature *sig;
245 MonoMethod **write_barrier_method_addr;
247 #ifdef MANAGED_WBARRIER
248 int i, nursery_check_labels [2];
251 // FIXME: Maybe create a separate version for ctors (the branch would be
252 // correctly predicted more times)
254 write_barrier_method_addr = &write_barrier_conc_method;
256 write_barrier_method_addr = &write_barrier_noconc_method;
258 if (*write_barrier_method_addr)
259 return *write_barrier_method_addr;
261 /* Create the IL version of mono_gc_barrier_generic_store () */
262 sig = mono_metadata_signature_alloc (mono_defaults.corlib, 1);
263 sig->ret = &mono_defaults.void_class->byval_arg;
264 sig->params [0] = &mono_defaults.int_class->byval_arg;
267 mb = mono_mb_new (mono_defaults.object_class, "wbarrier_conc", MONO_WRAPPER_WRITE_BARRIER);
269 mb = mono_mb_new (mono_defaults.object_class, "wbarrier_noconc", MONO_WRAPPER_WRITE_BARRIER);
272 #ifdef MANAGED_WBARRIER
273 emit_nursery_check (mb, nursery_check_labels, is_concurrent);
275 addr = sgen_cardtable + ((address >> CARD_BITS) & CARD_MASK)
279 LDC_PTR sgen_cardtable
285 if (SGEN_HAVE_OVERLAPPING_CARDS) {
286 LDC_PTR card_table_mask
293 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
294 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_CARD_TABLE);
295 mono_mb_emit_ldarg (mb, 0);
296 mono_mb_emit_icon (mb, CARD_BITS);
297 mono_mb_emit_byte (mb, CEE_SHR_UN);
298 mono_mb_emit_byte (mb, CEE_CONV_I);
299 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
300 #if SIZEOF_VOID_P == 8
301 mono_mb_emit_icon8 (mb, CARD_MASK);
303 mono_mb_emit_icon (mb, CARD_MASK);
305 mono_mb_emit_byte (mb, CEE_CONV_I);
306 mono_mb_emit_byte (mb, CEE_AND);
308 mono_mb_emit_byte (mb, CEE_ADD);
309 mono_mb_emit_icon (mb, 1);
310 mono_mb_emit_byte (mb, CEE_STIND_I1);
313 for (i = 0; i < 2; ++i) {
314 if (nursery_check_labels [i])
315 mono_mb_patch_branch (mb, nursery_check_labels [i]);
317 mono_mb_emit_byte (mb, CEE_RET);
319 mono_mb_emit_ldarg (mb, 0);
320 mono_mb_emit_icall (mb, mono_gc_wbarrier_generic_nostore);
321 mono_mb_emit_byte (mb, CEE_RET);
324 res = mono_mb_create_method (mb, sig, 16);
325 info = mono_wrapper_info_create (mb, WRAPPER_SUBTYPE_NONE);
326 mono_marshal_set_wrapper_info (res, info);
330 if (*write_barrier_method_addr) {
331 /* Already created */
332 mono_free_method (res);
334 /* double-checked locking */
335 mono_memory_barrier ();
336 *write_barrier_method_addr = res;
340 return *write_barrier_method_addr;
344 mono_gc_get_write_barrier (void)
346 return mono_gc_get_specific_write_barrier (major_collector.is_concurrent);
350 * Dummy filler objects
353 /* Vtable of the objects used to fill out nursery fragments before a collection */
354 static GCVTable array_fill_vtable;
357 get_array_fill_vtable (void)
359 if (!array_fill_vtable) {
360 static MonoClass klass;
361 static char _vtable[sizeof(MonoVTable)+8];
362 MonoVTable* vtable = (MonoVTable*) ALIGN_TO((mword)_vtable, 8);
365 MonoDomain *domain = mono_get_root_domain ();
368 klass.element_class = mono_defaults.byte_class;
370 klass.instance_size = MONO_SIZEOF_MONO_ARRAY;
371 klass.sizes.element_size = 1;
372 klass.name = "array_filler_type";
374 vtable->klass = &klass;
376 vtable->gc_descr = mono_gc_make_descr_for_array (TRUE, &bmap, 0, 1);
379 array_fill_vtable = vtable;
381 return array_fill_vtable;
385 sgen_client_array_fill_range (char *start, size_t size)
389 if (size < MONO_SIZEOF_MONO_ARRAY) {
390 memset (start, 0, size);
394 o = (MonoArray*)start;
395 o->obj.vtable = (MonoVTable*)get_array_fill_vtable ();
396 /* Mark this as not a real object */
397 o->obj.synchronisation = (MonoThreadsSync *)GINT_TO_POINTER (-1);
399 o->max_length = (mono_array_size_t)(size - MONO_SIZEOF_MONO_ARRAY);
405 sgen_client_zero_array_fill_header (void *p, size_t size)
407 if (size >= MONO_SIZEOF_MONO_ARRAY) {
408 memset (p, 0, MONO_SIZEOF_MONO_ARRAY);
410 static guint8 zeros [MONO_SIZEOF_MONO_ARRAY];
412 SGEN_ASSERT (0, !memcmp (p, zeros, size), "TLAB segment must be zeroed out.");
420 static MonoGCFinalizerCallbacks fin_callbacks;
423 mono_gc_get_vtable_bits (MonoClass *klass)
426 /* FIXME move this to the bridge code */
427 if (sgen_need_bridge_processing ()) {
428 switch (sgen_bridge_class_kind (klass)) {
429 case GC_BRIDGE_TRANSPARENT_BRIDGE_CLASS:
430 case GC_BRIDGE_OPAQUE_BRIDGE_CLASS:
431 res = SGEN_GC_BIT_BRIDGE_OBJECT;
433 case GC_BRIDGE_OPAQUE_CLASS:
434 res = SGEN_GC_BIT_BRIDGE_OPAQUE_OBJECT;
436 case GC_BRIDGE_TRANSPARENT_CLASS:
440 if (fin_callbacks.is_class_finalization_aware) {
441 if (fin_callbacks.is_class_finalization_aware (klass))
442 res |= SGEN_GC_BIT_FINALIZER_AWARE;
448 is_finalization_aware (MonoObject *obj)
450 MonoVTable *vt = SGEN_LOAD_VTABLE (obj);
451 return (vt->gc_bits & SGEN_GC_BIT_FINALIZER_AWARE) == SGEN_GC_BIT_FINALIZER_AWARE;
455 sgen_client_object_queued_for_finalization (GCObject *obj)
457 if (fin_callbacks.object_queued_for_finalization && is_finalization_aware (obj))
458 fin_callbacks.object_queued_for_finalization (obj);
461 if (G_UNLIKELY (MONO_GC_FINALIZE_ENQUEUE_ENABLED ())) {
462 int gen = sgen_ptr_in_nursery (obj) ? GENERATION_NURSERY : GENERATION_OLD;
463 GCVTable vt = SGEN_LOAD_VTABLE (obj);
464 MONO_GC_FINALIZE_ENQUEUE ((mword)obj, sgen_safe_object_get_size (obj),
465 sgen_client_vtable_get_namespace (vt), sgen_client_vtable_get_name (vt), gen,
466 sgen_client_object_has_critical_finalizer (obj));
472 mono_gc_register_finalizer_callbacks (MonoGCFinalizerCallbacks *callbacks)
474 if (callbacks->version != MONO_GC_FINALIZER_EXTENSION_VERSION)
475 g_error ("Invalid finalizer callback version. Expected %d but got %d\n", MONO_GC_FINALIZER_EXTENSION_VERSION, callbacks->version);
477 fin_callbacks = *callbacks;
481 sgen_client_run_finalize (MonoObject *obj)
483 mono_gc_run_finalize (obj, NULL);
487 mono_gc_invoke_finalizers (void)
489 return sgen_gc_invoke_finalizers ();
493 mono_gc_pending_finalizers (void)
495 return sgen_have_pending_finalizers ();
499 sgen_client_finalize_notify (void)
501 mono_gc_finalize_notify ();
505 mono_gc_register_for_finalization (MonoObject *obj, void *user_data)
507 sgen_object_register_for_finalization (obj, user_data);
511 object_in_domain_predicate (MonoObject *obj, void *user_data)
513 MonoDomain *domain = (MonoDomain *)user_data;
514 if (mono_object_domain (obj) == domain) {
515 SGEN_LOG (5, "Unregistering finalizer for object: %p (%s)", obj, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj)));
522 * mono_gc_finalizers_for_domain:
523 * @domain: the unloading appdomain
524 * @out_array: output array
525 * @out_size: size of output array
527 * Store inside @out_array up to @out_size objects that belong to the unloading
528 * appdomain @domain. Returns the number of stored items. Can be called repeteadly
529 * until it returns 0.
530 * The items are removed from the finalizer data structure, so the caller is supposed
532 * @out_array should be on the stack to allow the GC to know the objects are still alive.
535 mono_gc_finalizers_for_domain (MonoDomain *domain, MonoObject **out_array, int out_size)
537 return sgen_gather_finalizers_if (object_in_domain_predicate, domain, out_array, out_size);
544 typedef struct _EphemeronLinkNode EphemeronLinkNode;
546 struct _EphemeronLinkNode {
547 EphemeronLinkNode *next;
556 static EphemeronLinkNode *ephemeron_list;
558 /* LOCKING: requires that the GC lock is held */
560 null_ephemerons_for_domain (MonoDomain *domain)
562 EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
565 MonoObject *object = (MonoObject*)current->array;
568 SGEN_ASSERT (0, object->vtable, "Can't have objects without vtables.");
570 if (object && object->vtable->domain == domain) {
571 EphemeronLinkNode *tmp = current;
574 prev->next = current->next;
576 ephemeron_list = current->next;
578 current = current->next;
579 sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
582 current = current->next;
587 /* LOCKING: requires that the GC lock is held */
589 sgen_client_clear_unreachable_ephemerons (ScanCopyContext ctx)
591 CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
592 SgenGrayQueue *queue = ctx.queue;
593 EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
594 Ephemeron *cur, *array_end;
598 MonoArray *array = current->array;
600 if (!sgen_is_object_alive_for_current_gen ((GCObject*)array)) {
601 EphemeronLinkNode *tmp = current;
603 SGEN_LOG (5, "Dead Ephemeron array at %p", array);
606 prev->next = current->next;
608 ephemeron_list = current->next;
610 current = current->next;
611 sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
616 copy_func ((GCObject**)&array, queue);
617 current->array = array;
619 SGEN_LOG (5, "Clearing unreachable entries for ephemeron array at %p", array);
621 cur = mono_array_addr (array, Ephemeron, 0);
622 array_end = cur + mono_array_length_fast (array);
623 tombstone = SGEN_LOAD_VTABLE ((GCObject*)array)->domain->ephemeron_tombstone;
625 for (; cur < array_end; ++cur) {
626 GCObject *key = cur->key;
628 if (!key || key == tombstone)
631 SGEN_LOG (5, "[%zd] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
632 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
633 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
635 if (!sgen_is_object_alive_for_current_gen (key)) {
636 cur->key = tombstone;
642 current = current->next;
647 LOCKING: requires that the GC lock is held
649 Limitations: We scan all ephemerons on every collection since the current design doesn't allow for a simple nursery/mature split.
652 sgen_client_mark_ephemerons (ScanCopyContext ctx)
654 CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
655 SgenGrayQueue *queue = ctx.queue;
656 gboolean nothing_marked = TRUE;
657 EphemeronLinkNode *current = ephemeron_list;
658 Ephemeron *cur, *array_end;
661 for (current = ephemeron_list; current; current = current->next) {
662 MonoArray *array = current->array;
663 SGEN_LOG (5, "Ephemeron array at %p", array);
665 /*It has to be alive*/
666 if (!sgen_is_object_alive_for_current_gen ((GCObject*)array)) {
667 SGEN_LOG (5, "\tnot reachable");
671 copy_func ((GCObject**)&array, queue);
673 cur = mono_array_addr (array, Ephemeron, 0);
674 array_end = cur + mono_array_length_fast (array);
675 tombstone = SGEN_LOAD_VTABLE ((GCObject*)array)->domain->ephemeron_tombstone;
677 for (; cur < array_end; ++cur) {
678 GCObject *key = cur->key;
680 if (!key || key == tombstone)
683 SGEN_LOG (5, "[%zd] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
684 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
685 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
687 if (sgen_is_object_alive_for_current_gen (key)) {
688 GCObject *value = cur->value;
690 copy_func (&cur->key, queue);
692 if (!sgen_is_object_alive_for_current_gen (value))
693 nothing_marked = FALSE;
694 copy_func (&cur->value, queue);
700 SGEN_LOG (5, "Ephemeron run finished. Is it done %d", nothing_marked);
701 return nothing_marked;
705 mono_gc_ephemeron_array_add (MonoObject *obj)
707 EphemeronLinkNode *node;
711 node = (EphemeronLinkNode *)sgen_alloc_internal (INTERNAL_MEM_EPHEMERON_LINK);
716 node->array = (MonoArray*)obj;
717 node->next = ephemeron_list;
718 ephemeron_list = node;
720 SGEN_LOG (5, "Registered ephemeron array %p", obj);
731 mono_gc_set_current_thread_appdomain (MonoDomain *domain)
733 SgenThreadInfo *info = mono_thread_info_current ();
735 /* Could be called from sgen_thread_unregister () with a NULL info */
738 info->client_info.stopped_domain = domain;
743 need_remove_object_for_domain (GCObject *start, MonoDomain *domain)
745 if (mono_object_domain (start) == domain) {
746 SGEN_LOG (4, "Need to cleanup object %p", start);
747 binary_protocol_cleanup (start, (gpointer)SGEN_LOAD_VTABLE (start), sgen_safe_object_get_size ((GCObject*)start));
754 process_object_for_domain_clearing (GCObject *start, MonoDomain *domain)
756 MonoVTable *vt = SGEN_LOAD_VTABLE (start);
757 if (vt->klass == mono_defaults.internal_thread_class)
758 g_assert (mono_object_domain (start) == mono_get_root_domain ());
759 /* The object could be a proxy for an object in the domain
761 #ifndef DISABLE_REMOTING
762 if (mono_defaults.real_proxy_class->supertypes && mono_class_has_parent_fast (vt->klass, mono_defaults.real_proxy_class)) {
763 MonoObject *server = ((MonoRealProxy*)start)->unwrapped_server;
765 /* The server could already have been zeroed out, so
766 we need to check for that, too. */
767 if (server && (!SGEN_LOAD_VTABLE (server) || mono_object_domain (server) == domain)) {
768 SGEN_LOG (4, "Cleaning up remote pointer in %p to object %p", start, server);
769 ((MonoRealProxy*)start)->unwrapped_server = NULL;
776 clear_domain_process_object (GCObject *obj, MonoDomain *domain)
780 process_object_for_domain_clearing (obj, domain);
781 remove = need_remove_object_for_domain (obj, domain);
783 if (remove && obj->synchronisation) {
784 guint32 dislink = mono_monitor_get_object_monitor_gchandle (obj);
786 mono_gchandle_free (dislink);
793 clear_domain_process_minor_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
795 if (clear_domain_process_object (obj, domain)) {
796 CANARIFY_SIZE (size);
797 memset (obj, 0, size);
802 clear_domain_process_major_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
804 clear_domain_process_object (obj, domain);
808 clear_domain_free_major_non_pinned_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
810 if (need_remove_object_for_domain (obj, domain))
811 major_collector.free_non_pinned_object (obj, size);
815 clear_domain_free_major_pinned_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
817 if (need_remove_object_for_domain (obj, domain))
818 major_collector.free_pinned_object (obj, size);
822 * When appdomains are unloaded we can easily remove objects that have finalizers,
823 * but all the others could still be present in random places on the heap.
824 * We need a sweep to get rid of them even though it's going to be costly
826 * The reason we need to remove them is because we access the vtable and class
827 * structures to know the object size and the reference bitmap: once the domain is
828 * unloaded the point to random memory.
831 mono_gc_clear_domain (MonoDomain * domain)
833 LOSObject *bigobj, *prev;
838 binary_protocol_domain_unload_begin (domain);
842 if (sgen_concurrent_collection_in_progress ())
843 sgen_perform_collection (0, GENERATION_OLD, "clear domain", TRUE);
844 SGEN_ASSERT (0, !sgen_concurrent_collection_in_progress (), "We just ordered a synchronous collection. Why are we collecting concurrently?");
846 major_collector.finish_sweeping ();
848 sgen_process_fin_stage_entries ();
850 sgen_clear_nursery_fragments ();
852 if (sgen_mono_xdomain_checks && domain != mono_get_root_domain ()) {
853 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_NORMAL);
854 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_WBARRIER);
855 sgen_check_for_xdomain_refs ();
858 /*Ephemerons and dislinks must be processed before LOS since they might end up pointing
859 to memory returned to the OS.*/
860 null_ephemerons_for_domain (domain);
861 sgen_null_links_for_domain (domain);
863 for (i = GENERATION_NURSERY; i < GENERATION_MAX; ++i)
864 sgen_remove_finalizers_if (object_in_domain_predicate, domain, i);
866 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
867 (IterateObjectCallbackFunc)clear_domain_process_minor_object_callback, domain, FALSE, TRUE);
869 /* We need two passes over major and large objects because
870 freeing such objects might give their memory back to the OS
871 (in the case of large objects) or obliterate its vtable
872 (pinned objects with major-copying or pinned and non-pinned
873 objects with major-mark&sweep), but we might need to
874 dereference a pointer from an object to another object if
875 the first object is a proxy. */
876 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, (IterateObjectCallbackFunc)clear_domain_process_major_object_callback, domain);
877 for (bigobj = los_object_list; bigobj; bigobj = bigobj->next)
878 clear_domain_process_object ((GCObject*)bigobj->data, domain);
881 for (bigobj = los_object_list; bigobj;) {
882 if (need_remove_object_for_domain ((GCObject*)bigobj->data, domain)) {
883 LOSObject *to_free = bigobj;
885 prev->next = bigobj->next;
887 los_object_list = bigobj->next;
888 bigobj = bigobj->next;
889 SGEN_LOG (4, "Freeing large object %p", bigobj->data);
890 sgen_los_free_object (to_free);
894 bigobj = bigobj->next;
896 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_NON_PINNED, (IterateObjectCallbackFunc)clear_domain_free_major_non_pinned_object_callback, domain);
897 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_PINNED, (IterateObjectCallbackFunc)clear_domain_free_major_pinned_object_callback, domain);
899 if (domain == mono_get_root_domain ()) {
900 sgen_pin_stats_print_class_stats ();
901 sgen_object_layout_dump (stdout);
904 sgen_restart_world (0, NULL);
906 binary_protocol_domain_unload_end (domain);
907 binary_protocol_flush_buffers (FALSE);
916 static gboolean alloc_events = FALSE;
919 mono_gc_enable_alloc_events (void)
925 mono_gc_alloc_obj (MonoVTable *vtable, size_t size)
927 MonoObject *obj = sgen_alloc_obj (vtable, size);
929 if (G_UNLIKELY (alloc_events)) {
931 mono_profiler_allocation (obj);
938 mono_gc_alloc_pinned_obj (MonoVTable *vtable, size_t size)
940 MonoObject *obj = sgen_alloc_obj_pinned (vtable, size);
942 if (G_UNLIKELY (alloc_events)) {
944 mono_profiler_allocation (obj);
951 mono_gc_alloc_mature (MonoVTable *vtable, size_t size)
953 MonoObject *obj = sgen_alloc_obj_mature (vtable, size);
955 if (G_UNLIKELY (alloc_events)) {
957 mono_profiler_allocation (obj);
964 mono_gc_alloc_fixed (size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
966 /* FIXME: do a single allocation */
967 void *res = calloc (1, size);
970 if (!mono_gc_register_root ((char *)res, size, descr, source, msg)) {
978 mono_gc_free_fixed (void* addr)
980 mono_gc_deregister_root ((char *)addr);
988 static MonoMethod* alloc_method_cache [ATYPE_NUM];
989 static MonoMethod* slowpath_alloc_method_cache [ATYPE_NUM];
990 static gboolean use_managed_allocator = TRUE;
992 #ifdef MANAGED_ALLOCATION
994 #ifdef HAVE_KW_THREAD
996 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb) do { \
997 mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX); \
998 mono_mb_emit_byte ((mb), CEE_MONO_TLS); \
999 mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_TLAB_NEXT_ADDR); \
1002 #define EMIT_TLS_ACCESS_TEMP_END(mb) do { \
1003 mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX); \
1004 mono_mb_emit_byte ((mb), CEE_MONO_TLS); \
1005 mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_TLAB_TEMP_END); \
1010 #if defined(TARGET_OSX) || defined(TARGET_WIN32) || defined(TARGET_ANDROID) || defined(TARGET_IOS)
1011 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb) do { \
1012 mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX); \
1013 mono_mb_emit_byte ((mb), CEE_MONO_TLS); \
1014 mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_THREAD_INFO); \
1015 mono_mb_emit_icon ((mb), MONO_STRUCT_OFFSET (SgenThreadInfo, tlab_next_addr)); \
1016 mono_mb_emit_byte ((mb), CEE_ADD); \
1017 mono_mb_emit_byte ((mb), CEE_LDIND_I); \
1020 #define EMIT_TLS_ACCESS_TEMP_END(mb) do { \
1021 mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX); \
1022 mono_mb_emit_byte ((mb), CEE_MONO_TLS); \
1023 mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_THREAD_INFO); \
1024 mono_mb_emit_icon ((mb), MONO_STRUCT_OFFSET (SgenThreadInfo, tlab_temp_end)); \
1025 mono_mb_emit_byte ((mb), CEE_ADD); \
1026 mono_mb_emit_byte ((mb), CEE_LDIND_I); \
1030 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb) do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1031 #define EMIT_TLS_ACCESS_TEMP_END(mb) do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1036 /* FIXME: Do this in the JIT, where specialized allocation sequences can be created
1037 * for each class. This is currently not easy to do, as it is hard to generate basic
1038 * blocks + branches, but it is easy with the linear IL codebase.
1040 * For this to work we'd need to solve the TLAB race, first. Now we
1041 * require the allocator to be in a few known methods to make sure
1042 * that they are executed atomically via the restart mechanism.
1045 create_allocator (int atype, gboolean slowpath)
1047 int p_var, size_var;
1048 guint32 slowpath_branch, max_size_branch;
1049 MonoMethodBuilder *mb;
1051 MonoMethodSignature *csig;
1052 static gboolean registered = FALSE;
1053 int tlab_next_addr_var, new_next_var;
1054 const char *name = NULL;
1059 mono_register_jit_icall (mono_gc_alloc_obj, "mono_gc_alloc_obj", mono_create_icall_signature ("object ptr int"), FALSE);
1060 mono_register_jit_icall (mono_gc_alloc_vector, "mono_gc_alloc_vector", mono_create_icall_signature ("object ptr int int"), FALSE);
1061 mono_register_jit_icall (mono_gc_alloc_string, "mono_gc_alloc_string", mono_create_icall_signature ("object ptr int int32"), FALSE);
1065 if (atype == ATYPE_SMALL) {
1066 name = slowpath ? "SlowAllocSmall" : "AllocSmall";
1067 } else if (atype == ATYPE_NORMAL) {
1068 name = slowpath ? "SlowAlloc" : "Alloc";
1069 } else if (atype == ATYPE_VECTOR) {
1070 name = slowpath ? "SlowAllocVector" : "AllocVector";
1071 } else if (atype == ATYPE_STRING) {
1072 name = slowpath ? "SlowAllocString" : "AllocString";
1074 g_assert_not_reached ();
1077 if (atype == ATYPE_NORMAL)
1082 csig = mono_metadata_signature_alloc (mono_defaults.corlib, num_params);
1083 if (atype == ATYPE_STRING) {
1084 csig->ret = &mono_defaults.string_class->byval_arg;
1085 csig->params [0] = &mono_defaults.int_class->byval_arg;
1086 csig->params [1] = &mono_defaults.int32_class->byval_arg;
1088 csig->ret = &mono_defaults.object_class->byval_arg;
1089 for (i = 0; i < num_params; i++)
1090 csig->params [i] = &mono_defaults.int_class->byval_arg;
1093 mb = mono_mb_new (mono_defaults.object_class, name, MONO_WRAPPER_ALLOC);
1100 mono_mb_emit_ldarg (mb, 0);
1101 mono_mb_emit_icall (mb, ves_icall_object_new_specific);
1104 mono_mb_emit_ldarg (mb, 0);
1105 mono_mb_emit_ldarg (mb, 1);
1106 mono_mb_emit_icall (mb, ves_icall_array_new_specific);
1109 mono_mb_emit_ldarg (mb, 1);
1110 mono_mb_emit_icall (mb, ves_icall_string_alloc);
1113 g_assert_not_reached ();
1119 size_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1120 if (atype == ATYPE_SMALL) {
1121 /* size_var = size_arg */
1122 mono_mb_emit_ldarg (mb, 1);
1123 mono_mb_emit_stloc (mb, size_var);
1124 } else if (atype == ATYPE_NORMAL) {
1125 /* size = vtable->klass->instance_size; */
1126 mono_mb_emit_ldarg (mb, 0);
1127 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoVTable, klass));
1128 mono_mb_emit_byte (mb, CEE_ADD);
1129 mono_mb_emit_byte (mb, CEE_LDIND_I);
1130 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoClass, instance_size));
1131 mono_mb_emit_byte (mb, CEE_ADD);
1132 /* FIXME: assert instance_size stays a 4 byte integer */
1133 mono_mb_emit_byte (mb, CEE_LDIND_U4);
1134 mono_mb_emit_byte (mb, CEE_CONV_I);
1135 mono_mb_emit_stloc (mb, size_var);
1136 } else if (atype == ATYPE_VECTOR) {
1137 MonoExceptionClause *clause;
1138 int pos, pos_leave, pos_error;
1139 MonoClass *oom_exc_class;
1143 * n > MONO_ARRAY_MAX_INDEX => OutOfMemoryException
1144 * n < 0 => OverflowException
1146 * We can do an unsigned comparison to catch both cases, then in the error
1147 * case compare signed to distinguish between them.
1149 mono_mb_emit_ldarg (mb, 1);
1150 mono_mb_emit_icon (mb, MONO_ARRAY_MAX_INDEX);
1151 mono_mb_emit_byte (mb, CEE_CONV_U);
1152 pos = mono_mb_emit_short_branch (mb, CEE_BLE_UN_S);
1154 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1155 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1156 mono_mb_emit_ldarg (mb, 1);
1157 mono_mb_emit_icon (mb, 0);
1158 pos_error = mono_mb_emit_short_branch (mb, CEE_BLT_S);
1159 mono_mb_emit_exception (mb, "OutOfMemoryException", NULL);
1160 mono_mb_patch_short_branch (mb, pos_error);
1161 mono_mb_emit_exception (mb, "OverflowException", NULL);
1163 mono_mb_patch_short_branch (mb, pos);
1165 clause = (MonoExceptionClause *)mono_image_alloc0 (mono_defaults.corlib, sizeof (MonoExceptionClause));
1166 clause->try_offset = mono_mb_get_label (mb);
1168 /* vtable->klass->sizes.element_size */
1169 mono_mb_emit_ldarg (mb, 0);
1170 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoVTable, klass));
1171 mono_mb_emit_byte (mb, CEE_ADD);
1172 mono_mb_emit_byte (mb, CEE_LDIND_I);
1173 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoClass, sizes));
1174 mono_mb_emit_byte (mb, CEE_ADD);
1175 mono_mb_emit_byte (mb, CEE_LDIND_U4);
1176 mono_mb_emit_byte (mb, CEE_CONV_I);
1179 mono_mb_emit_ldarg (mb, 1);
1180 mono_mb_emit_byte (mb, CEE_MUL_OVF_UN);
1181 /* + sizeof (MonoArray) */
1182 mono_mb_emit_icon (mb, MONO_SIZEOF_MONO_ARRAY);
1183 mono_mb_emit_byte (mb, CEE_ADD_OVF_UN);
1184 mono_mb_emit_stloc (mb, size_var);
1186 pos_leave = mono_mb_emit_branch (mb, CEE_LEAVE);
1189 clause->flags = MONO_EXCEPTION_CLAUSE_NONE;
1190 clause->try_len = mono_mb_get_pos (mb) - clause->try_offset;
1191 clause->data.catch_class = mono_class_load_from_name (mono_defaults.corlib,
1192 "System", "OverflowException");
1193 clause->handler_offset = mono_mb_get_label (mb);
1195 oom_exc_class = mono_class_load_from_name (mono_defaults.corlib,
1196 "System", "OutOfMemoryException");
1197 ctor = mono_class_get_method_from_name (oom_exc_class, ".ctor", 0);
1200 mono_mb_emit_byte (mb, CEE_POP);
1201 mono_mb_emit_op (mb, CEE_NEWOBJ, ctor);
1202 mono_mb_emit_byte (mb, CEE_THROW);
1204 clause->handler_len = mono_mb_get_pos (mb) - clause->handler_offset;
1205 mono_mb_set_clauses (mb, 1, clause);
1206 mono_mb_patch_branch (mb, pos_leave);
1208 } else if (atype == ATYPE_STRING) {
1212 * a string allocator method takes the args: (vtable, len)
1214 * bytes = offsetof (MonoString, chars) + ((len + 1) * 2)
1218 * bytes <= INT32_MAX - (SGEN_ALLOC_ALIGN - 1)
1222 * offsetof (MonoString, chars) + ((len + 1) * 2) <= INT32_MAX - (SGEN_ALLOC_ALIGN - 1)
1223 * len <= (INT32_MAX - (SGEN_ALLOC_ALIGN - 1) - offsetof (MonoString, chars)) / 2 - 1
1225 mono_mb_emit_ldarg (mb, 1);
1226 mono_mb_emit_icon (mb, (INT32_MAX - (SGEN_ALLOC_ALIGN - 1) - MONO_STRUCT_OFFSET (MonoString, chars)) / 2 - 1);
1227 pos = mono_mb_emit_short_branch (mb, MONO_CEE_BLE_UN_S);
1229 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1230 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1231 mono_mb_emit_exception (mb, "OutOfMemoryException", NULL);
1232 mono_mb_patch_short_branch (mb, pos);
1234 mono_mb_emit_ldarg (mb, 1);
1235 mono_mb_emit_icon (mb, 1);
1236 mono_mb_emit_byte (mb, MONO_CEE_SHL);
1237 //WE manually fold the above + 2 here
1238 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoString, chars) + 2);
1239 mono_mb_emit_byte (mb, CEE_ADD);
1240 mono_mb_emit_stloc (mb, size_var);
1242 g_assert_not_reached ();
1245 /* size += ALLOC_ALIGN - 1; */
1246 mono_mb_emit_ldloc (mb, size_var);
1247 mono_mb_emit_icon (mb, SGEN_ALLOC_ALIGN - 1);
1248 mono_mb_emit_byte (mb, CEE_ADD);
1249 /* size &= ~(ALLOC_ALIGN - 1); */
1250 mono_mb_emit_icon (mb, ~(SGEN_ALLOC_ALIGN - 1));
1251 mono_mb_emit_byte (mb, CEE_AND);
1252 mono_mb_emit_stloc (mb, size_var);
1254 /* if (size > MAX_SMALL_OBJ_SIZE) goto slowpath */
1255 if (atype != ATYPE_SMALL) {
1256 mono_mb_emit_ldloc (mb, size_var);
1257 mono_mb_emit_icon (mb, SGEN_MAX_SMALL_OBJ_SIZE);
1258 max_size_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BGT_UN_S);
1262 * We need to modify tlab_next, but the JIT only supports reading, so we read
1263 * another tls var holding its address instead.
1266 /* tlab_next_addr (local) = tlab_next_addr (TLS var) */
1267 tlab_next_addr_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1268 EMIT_TLS_ACCESS_NEXT_ADDR (mb);
1269 mono_mb_emit_stloc (mb, tlab_next_addr_var);
1271 /* p = (void**)tlab_next; */
1272 p_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1273 mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1274 mono_mb_emit_byte (mb, CEE_LDIND_I);
1275 mono_mb_emit_stloc (mb, p_var);
1277 /* new_next = (char*)p + size; */
1278 new_next_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1279 mono_mb_emit_ldloc (mb, p_var);
1280 mono_mb_emit_ldloc (mb, size_var);
1281 mono_mb_emit_byte (mb, CEE_CONV_I);
1282 mono_mb_emit_byte (mb, CEE_ADD);
1283 mono_mb_emit_stloc (mb, new_next_var);
1285 /* if (G_LIKELY (new_next < tlab_temp_end)) */
1286 mono_mb_emit_ldloc (mb, new_next_var);
1287 EMIT_TLS_ACCESS_TEMP_END (mb);
1288 slowpath_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLT_UN_S);
1291 if (atype != ATYPE_SMALL)
1292 mono_mb_patch_short_branch (mb, max_size_branch);
1294 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1295 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1297 /* FIXME: mono_gc_alloc_obj takes a 'size_t' as an argument, not an int32 */
1298 mono_mb_emit_ldarg (mb, 0);
1299 mono_mb_emit_ldloc (mb, size_var);
1300 if (atype == ATYPE_NORMAL || atype == ATYPE_SMALL) {
1301 mono_mb_emit_icall (mb, mono_gc_alloc_obj);
1302 } else if (atype == ATYPE_VECTOR) {
1303 mono_mb_emit_ldarg (mb, 1);
1304 mono_mb_emit_icall (mb, mono_gc_alloc_vector);
1305 } else if (atype == ATYPE_STRING) {
1306 mono_mb_emit_ldarg (mb, 1);
1307 mono_mb_emit_icall (mb, mono_gc_alloc_string);
1309 g_assert_not_reached ();
1311 mono_mb_emit_byte (mb, CEE_RET);
1314 mono_mb_patch_short_branch (mb, slowpath_branch);
1316 /* FIXME: Memory barrier */
1318 /* tlab_next = new_next */
1319 mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1320 mono_mb_emit_ldloc (mb, new_next_var);
1321 mono_mb_emit_byte (mb, CEE_STIND_I);
1323 /*The tlab store must be visible before the the vtable store. This could be replaced with a DDS but doing it with IL would be tricky. */
1324 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1325 mono_mb_emit_byte (mb, CEE_MONO_MEMORY_BARRIER);
1326 mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_REL);
1329 mono_mb_emit_ldloc (mb, p_var);
1330 mono_mb_emit_ldarg (mb, 0);
1331 mono_mb_emit_byte (mb, CEE_STIND_I);
1333 if (atype == ATYPE_VECTOR) {
1334 /* arr->max_length = max_length; */
1335 mono_mb_emit_ldloc (mb, p_var);
1336 mono_mb_emit_ldflda (mb, MONO_STRUCT_OFFSET (MonoArray, max_length));
1337 mono_mb_emit_ldarg (mb, 1);
1338 #ifdef MONO_BIG_ARRAYS
1339 mono_mb_emit_byte (mb, CEE_STIND_I);
1341 mono_mb_emit_byte (mb, CEE_STIND_I4);
1343 } else if (atype == ATYPE_STRING) {
1344 /* need to set length and clear the last char */
1345 /* s->length = len; */
1346 mono_mb_emit_ldloc (mb, p_var);
1347 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoString, length));
1348 mono_mb_emit_byte (mb, MONO_CEE_ADD);
1349 mono_mb_emit_ldarg (mb, 1);
1350 mono_mb_emit_byte (mb, MONO_CEE_STIND_I4);
1354 We must make sure both vtable and max_length are globaly visible before returning to managed land.
1356 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1357 mono_mb_emit_byte (mb, CEE_MONO_MEMORY_BARRIER);
1358 mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_REL);
1361 mono_mb_emit_ldloc (mb, p_var);
1364 mono_mb_emit_byte (mb, CEE_RET);
1367 info = mono_wrapper_info_create (mb, WRAPPER_SUBTYPE_NONE);
1368 info->d.alloc.gc_name = "sgen";
1369 info->d.alloc.alloc_type = atype;
1372 mb->init_locals = FALSE;
1375 res = mono_mb_create (mb, csig, 8, info);
1384 mono_gc_get_aligned_size_for_allocator (int size)
1386 return SGEN_ALIGN_UP (size);
1390 * Generate an allocator method implementing the fast path of mono_gc_alloc_obj ().
1391 * The signature of the called method is:
1392 * object allocate (MonoVTable *vtable)
1395 mono_gc_get_managed_allocator (MonoClass *klass, gboolean for_box, gboolean known_instance_size)
1397 #ifdef MANAGED_ALLOCATION
1398 if (collect_before_allocs)
1400 if (!mono_runtime_has_tls_get ())
1402 if (klass->instance_size > tlab_size)
1404 if (known_instance_size && ALIGN_TO (klass->instance_size, SGEN_ALLOC_ALIGN) >= SGEN_MAX_SMALL_OBJ_SIZE)
1406 if (mono_class_has_finalizer (klass) || mono_class_is_marshalbyref (klass) || (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS))
1410 if (klass->byval_arg.type == MONO_TYPE_STRING)
1411 return mono_gc_get_managed_allocator_by_type (ATYPE_STRING, FALSE);
1412 /* Generic classes have dynamic field and can go above MAX_SMALL_OBJ_SIZE. */
1413 if (known_instance_size)
1414 return mono_gc_get_managed_allocator_by_type (ATYPE_SMALL, FALSE);
1416 return mono_gc_get_managed_allocator_by_type (ATYPE_NORMAL, FALSE);
1423 mono_gc_get_managed_array_allocator (MonoClass *klass)
1425 #ifdef MANAGED_ALLOCATION
1426 if (klass->rank != 1)
1428 if (!mono_runtime_has_tls_get ())
1430 if (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS)
1432 if (has_per_allocation_action)
1434 g_assert (!mono_class_has_finalizer (klass) && !mono_class_is_marshalbyref (klass));
1436 return mono_gc_get_managed_allocator_by_type (ATYPE_VECTOR, FALSE);
1443 sgen_set_use_managed_allocator (gboolean flag)
1445 use_managed_allocator = flag;
1449 mono_gc_get_managed_allocator_by_type (int atype, gboolean slowpath)
1451 #ifdef MANAGED_ALLOCATION
1453 MonoMethod **cache = slowpath ? slowpath_alloc_method_cache : alloc_method_cache;
1455 if (!use_managed_allocator)
1458 if (!mono_runtime_has_tls_get ())
1461 res = cache [atype];
1465 res = create_allocator (atype, slowpath);
1467 if (cache [atype]) {
1468 mono_free_method (res);
1469 res = cache [atype];
1471 mono_memory_barrier ();
1472 cache [atype] = res;
1483 mono_gc_get_managed_allocator_types (void)
1489 sgen_is_managed_allocator (MonoMethod *method)
1493 for (i = 0; i < ATYPE_NUM; ++i)
1494 if (method == alloc_method_cache [i] || method == slowpath_alloc_method_cache [i])
1500 sgen_has_managed_allocator (void)
1504 for (i = 0; i < ATYPE_NUM; ++i)
1505 if (alloc_method_cache [i] || slowpath_alloc_method_cache [i])
1511 * Cardtable scanning
1514 #define MWORD_MASK (sizeof (mword) - 1)
1517 find_card_offset (mword card)
1519 /*XXX Use assembly as this generates some pretty bad code */
1520 #if defined(__i386__) && defined(__GNUC__)
1521 return (__builtin_ffs (card) - 1) / 8;
1522 #elif defined(__x86_64__) && defined(__GNUC__)
1523 return (__builtin_ffsll (card) - 1) / 8;
1524 #elif defined(__s390x__)
1525 return (__builtin_ffsll (GUINT64_TO_LE(card)) - 1) / 8;
1528 guint8 *ptr = (guint8 *) &card;
1529 for (i = 0; i < sizeof (mword); ++i) {
1538 find_next_card (guint8 *card_data, guint8 *end)
1540 mword *cards, *cards_end;
1543 while ((((mword)card_data) & MWORD_MASK) && card_data < end) {
1549 if (card_data == end)
1552 cards = (mword*)card_data;
1553 cards_end = (mword*)((mword)end & ~MWORD_MASK);
1554 while (cards < cards_end) {
1557 return (guint8*)cards + find_card_offset (card);
1561 card_data = (guint8*)cards_end;
1562 while (card_data < end) {
1571 #define ARRAY_OBJ_INDEX(ptr,array,elem_size) (((char*)(ptr) - ((char*)(array) + G_STRUCT_OFFSET (MonoArray, vector))) / (elem_size))
1574 sgen_client_cardtable_scan_object (GCObject *obj, mword block_obj_size, guint8 *cards, ScanCopyContext ctx)
1576 MonoVTable *vt = SGEN_LOAD_VTABLE (obj);
1577 MonoClass *klass = vt->klass;
1579 SGEN_ASSERT (0, SGEN_VTABLE_HAS_REFERENCES (vt), "Why would we ever call this on reference-free objects?");
1582 MonoArray *arr = (MonoArray*)obj;
1583 guint8 *card_data, *card_base;
1584 guint8 *card_data_end;
1585 char *obj_start = (char *)sgen_card_table_align_pointer (obj);
1587 mword obj_size = sgen_mono_array_size (vt, arr, &bounds_size, sgen_vtable_get_descriptor (vt));
1588 /* We don't want to scan the bounds entries at the end of multidimensional arrays */
1589 char *obj_end = (char*)obj + obj_size - bounds_size;
1591 size_t extra_idx = 0;
1593 mword desc = (mword)klass->element_class->gc_descr;
1594 int elem_size = mono_array_element_size (klass);
1596 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1597 guint8 *overflow_scan_end = NULL;
1600 #ifdef SGEN_OBJECT_LAYOUT_STATISTICS
1601 if (klass->element_class->valuetype)
1602 sgen_object_layout_scanned_vtype_array ();
1604 sgen_object_layout_scanned_ref_array ();
1610 card_data = sgen_card_table_get_card_scan_address ((mword)obj);
1612 card_base = card_data;
1613 card_count = sgen_card_table_number_of_cards_in_range ((mword)obj, obj_size);
1614 card_data_end = card_data + card_count;
1617 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1618 /*Check for overflow and if so, setup to scan in two steps*/
1619 if (!cards && card_data_end >= SGEN_SHADOW_CARDTABLE_END) {
1620 overflow_scan_end = sgen_shadow_cardtable + (card_data_end - SGEN_SHADOW_CARDTABLE_END);
1621 card_data_end = SGEN_SHADOW_CARDTABLE_END;
1627 card_data = find_next_card (card_data, card_data_end);
1628 for (; card_data < card_data_end; card_data = find_next_card (card_data + 1, card_data_end)) {
1630 size_t idx = (card_data - card_base) + extra_idx;
1631 char *start = (char*)(obj_start + idx * CARD_SIZE_IN_BYTES);
1632 char *card_end = start + CARD_SIZE_IN_BYTES;
1633 char *first_elem, *elem;
1635 HEAVY_STAT (++los_marked_cards);
1638 sgen_card_table_prepare_card_for_scanning (card_data);
1640 card_end = MIN (card_end, obj_end);
1642 if (start <= (char*)arr->vector)
1645 index = ARRAY_OBJ_INDEX (start, obj, elem_size);
1647 elem = first_elem = (char*)mono_array_addr_with_size_fast ((MonoArray*)obj, elem_size, index);
1648 if (klass->element_class->valuetype) {
1649 ScanVTypeFunc scan_vtype_func = ctx.ops->scan_vtype;
1651 for (; elem < card_end; elem += elem_size)
1652 scan_vtype_func (obj, elem, desc, ctx.queue BINARY_PROTOCOL_ARG (elem_size));
1654 ScanPtrFieldFunc scan_ptr_field_func = ctx.ops->scan_ptr_field;
1656 HEAVY_STAT (++los_array_cards);
1657 for (; elem < card_end; elem += SIZEOF_VOID_P)
1658 scan_ptr_field_func (obj, (GCObject**)elem, ctx.queue);
1661 binary_protocol_card_scan (first_elem, elem - first_elem);
1664 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1665 if (overflow_scan_end) {
1666 extra_idx = card_data - card_base;
1667 card_base = card_data = sgen_shadow_cardtable;
1668 card_data_end = overflow_scan_end;
1669 overflow_scan_end = NULL;
1680 * Array and string allocation
1684 mono_gc_alloc_vector (MonoVTable *vtable, size_t size, uintptr_t max_length)
1689 if (!SGEN_CAN_ALIGN_UP (size))
1692 #ifndef DISABLE_CRITICAL_REGION
1693 ENTER_CRITICAL_REGION;
1694 arr = (MonoArray*)sgen_try_alloc_obj_nolock (vtable, size);
1696 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1697 arr->max_length = (mono_array_size_t)max_length;
1698 EXIT_CRITICAL_REGION;
1701 EXIT_CRITICAL_REGION;
1706 arr = (MonoArray*)sgen_alloc_obj_nolock (vtable, size);
1707 if (G_UNLIKELY (!arr)) {
1712 arr->max_length = (mono_array_size_t)max_length;
1717 if (G_UNLIKELY (alloc_events))
1718 mono_profiler_allocation (&arr->obj);
1720 SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size (vtable, (GCObject*)arr)), "Vector has incorrect size.");
1725 mono_gc_alloc_array (MonoVTable *vtable, size_t size, uintptr_t max_length, uintptr_t bounds_size)
1728 MonoArrayBounds *bounds;
1731 if (!SGEN_CAN_ALIGN_UP (size))
1734 #ifndef DISABLE_CRITICAL_REGION
1735 ENTER_CRITICAL_REGION;
1736 arr = (MonoArray*)sgen_try_alloc_obj_nolock (vtable, size);
1738 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1739 arr->max_length = (mono_array_size_t)max_length;
1741 bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1742 arr->bounds = bounds;
1743 EXIT_CRITICAL_REGION;
1746 EXIT_CRITICAL_REGION;
1751 arr = (MonoArray*)sgen_alloc_obj_nolock (vtable, size);
1752 if (G_UNLIKELY (!arr)) {
1757 arr->max_length = (mono_array_size_t)max_length;
1759 bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1760 arr->bounds = bounds;
1765 if (G_UNLIKELY (alloc_events))
1766 mono_profiler_allocation (&arr->obj);
1768 SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size (vtable, (GCObject*)arr)), "Array has incorrect size.");
1773 mono_gc_alloc_string (MonoVTable *vtable, size_t size, gint32 len)
1778 if (!SGEN_CAN_ALIGN_UP (size))
1781 #ifndef DISABLE_CRITICAL_REGION
1782 ENTER_CRITICAL_REGION;
1783 str = (MonoString*)sgen_try_alloc_obj_nolock (vtable, size);
1785 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1787 EXIT_CRITICAL_REGION;
1790 EXIT_CRITICAL_REGION;
1795 str = (MonoString*)sgen_alloc_obj_nolock (vtable, size);
1796 if (G_UNLIKELY (!str)) {
1806 if (G_UNLIKELY (alloc_events))
1807 mono_profiler_allocation (&str->object);
1817 mono_gc_set_string_length (MonoString *str, gint32 new_length)
1819 mono_unichar2 *new_end = str->chars + new_length;
1821 /* zero the discarded string. This null-delimits the string and allows
1822 * the space to be reclaimed by SGen. */
1824 if (nursery_canaries_enabled () && sgen_ptr_in_nursery (str)) {
1825 CHECK_CANARY_FOR_OBJECT ((GCObject*)str, TRUE);
1826 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2) + CANARY_SIZE);
1827 memcpy (new_end + 1 , CANARY_STRING, CANARY_SIZE);
1829 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2));
1832 str->length = new_length;
1839 #define GC_ROOT_NUM 32
1841 int count; /* must be the first field */
1842 void *objects [GC_ROOT_NUM];
1843 int root_types [GC_ROOT_NUM];
1844 uintptr_t extra_info [GC_ROOT_NUM];
1848 notify_gc_roots (GCRootReport *report)
1852 mono_profiler_gc_roots (report->count, report->objects, report->root_types, report->extra_info);
1857 add_profile_gc_root (GCRootReport *report, void *object, int rtype, uintptr_t extra_info)
1859 if (report->count == GC_ROOT_NUM)
1860 notify_gc_roots (report);
1861 report->objects [report->count] = object;
1862 report->root_types [report->count] = rtype;
1863 report->extra_info [report->count++] = (uintptr_t)SGEN_LOAD_VTABLE (object)->klass;
1867 sgen_client_nursery_objects_pinned (void **definitely_pinned, int count)
1869 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS) {
1870 GCRootReport report;
1873 for (idx = 0; idx < count; ++idx)
1874 add_profile_gc_root (&report, definitely_pinned [idx], MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
1875 notify_gc_roots (&report);
1880 report_finalizer_roots_from_queue (SgenPointerQueue *queue)
1882 GCRootReport report;
1886 for (i = 0; i < queue->next_slot; ++i) {
1887 void *obj = queue->data [i];
1890 add_profile_gc_root (&report, obj, MONO_PROFILE_GC_ROOT_FINALIZER, 0);
1892 notify_gc_roots (&report);
1896 report_finalizer_roots (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
1898 report_finalizer_roots_from_queue (fin_ready_queue);
1899 report_finalizer_roots_from_queue (critical_fin_queue);
1902 static GCRootReport *root_report;
1905 single_arg_report_root (MonoObject **obj, void *gc_data)
1908 add_profile_gc_root (root_report, *obj, MONO_PROFILE_GC_ROOT_OTHER, 0);
1912 precisely_report_roots_from (GCRootReport *report, void** start_root, void** end_root, mword desc)
1914 switch (desc & ROOT_DESC_TYPE_MASK) {
1915 case ROOT_DESC_BITMAP:
1916 desc >>= ROOT_DESC_TYPE_SHIFT;
1918 if ((desc & 1) && *start_root) {
1919 add_profile_gc_root (report, *start_root, MONO_PROFILE_GC_ROOT_OTHER, 0);
1925 case ROOT_DESC_COMPLEX: {
1926 gsize *bitmap_data = (gsize *)sgen_get_complex_descriptor_bitmap (desc);
1927 gsize bwords = (*bitmap_data) - 1;
1928 void **start_run = start_root;
1930 while (bwords-- > 0) {
1931 gsize bmap = *bitmap_data++;
1932 void **objptr = start_run;
1934 if ((bmap & 1) && *objptr) {
1935 add_profile_gc_root (report, *objptr, MONO_PROFILE_GC_ROOT_OTHER, 0);
1940 start_run += GC_BITS_PER_WORD;
1944 case ROOT_DESC_USER: {
1945 MonoGCRootMarkFunc marker = (MonoGCRootMarkFunc)sgen_get_user_descriptor_func (desc);
1946 root_report = report;
1947 marker ((MonoObject**)start_root, single_arg_report_root, NULL);
1950 case ROOT_DESC_RUN_LEN:
1951 g_assert_not_reached ();
1953 g_assert_not_reached ();
1958 report_registered_roots_by_type (int root_type)
1960 GCRootReport report;
1964 SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], void **, start_root, RootRecord *, root) {
1965 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
1966 precisely_report_roots_from (&report, start_root, (void**)root->end_root, root->root_desc);
1967 } SGEN_HASH_TABLE_FOREACH_END;
1968 notify_gc_roots (&report);
1972 report_registered_roots (void)
1974 report_registered_roots_by_type (ROOT_TYPE_NORMAL);
1975 report_registered_roots_by_type (ROOT_TYPE_WBARRIER);
1979 sgen_client_collecting_minor (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
1981 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
1982 report_registered_roots ();
1983 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
1984 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
1987 static GCRootReport major_root_report;
1988 static gboolean profile_roots;
1991 sgen_client_collecting_major_1 (void)
1993 profile_roots = mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS;
1994 memset (&major_root_report, 0, sizeof (GCRootReport));
1998 sgen_client_pinned_los_object (GCObject *obj)
2001 add_profile_gc_root (&major_root_report, (char*)obj, MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
2005 sgen_client_collecting_major_2 (void)
2008 notify_gc_roots (&major_root_report);
2010 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2011 report_registered_roots ();
2015 sgen_client_collecting_major_3 (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
2017 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2018 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
2021 #define MOVED_OBJECTS_NUM 64
2022 static void *moved_objects [MOVED_OBJECTS_NUM];
2023 static int moved_objects_idx = 0;
2026 mono_sgen_register_moved_object (void *obj, void *destination)
2028 g_assert (mono_profiler_events & MONO_PROFILE_GC_MOVES);
2030 if (moved_objects_idx == MOVED_OBJECTS_NUM) {
2031 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2032 moved_objects_idx = 0;
2034 moved_objects [moved_objects_idx++] = obj;
2035 moved_objects [moved_objects_idx++] = destination;
2039 mono_sgen_gc_event_moves (void)
2041 if (moved_objects_idx) {
2042 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2043 moved_objects_idx = 0;
2051 #define REFS_SIZE 128
2054 MonoGCReferences callback;
2058 MonoObject *refs [REFS_SIZE];
2059 uintptr_t offsets [REFS_SIZE];
2063 #define HANDLE_PTR(ptr,obj) do { \
2065 if (hwi->count == REFS_SIZE) { \
2066 hwi->callback ((MonoObject*)start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data); \
2070 hwi->offsets [hwi->count] = (char*)(ptr)-(char*)start; \
2071 hwi->refs [hwi->count++] = *(ptr); \
2076 collect_references (HeapWalkInfo *hwi, GCObject *obj, size_t size)
2078 char *start = (char*)obj;
2079 mword desc = sgen_obj_get_descriptor (obj);
2081 #include "sgen/sgen-scan-object.h"
2085 walk_references (GCObject *start, size_t size, void *data)
2087 HeapWalkInfo *hwi = (HeapWalkInfo *)data;
2090 collect_references (hwi, start, size);
2091 if (hwi->count || !hwi->called)
2092 hwi->callback (start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);
2096 * mono_gc_walk_heap:
2097 * @flags: flags for future use
2098 * @callback: a function pointer called for each object in the heap
2099 * @data: a user data pointer that is passed to callback
2101 * This function can be used to iterate over all the live objects in the heap:
2102 * for each object, @callback is invoked, providing info about the object's
2103 * location in memory, its class, its size and the objects it references.
2104 * For each referenced object it's offset from the object address is
2105 * reported in the offsets array.
2106 * The object references may be buffered, so the callback may be invoked
2107 * multiple times for the same object: in all but the first call, the size
2108 * argument will be zero.
2109 * Note that this function can be only called in the #MONO_GC_EVENT_PRE_START_WORLD
2110 * profiler event handler.
2112 * Returns: a non-zero value if the GC doesn't support heap walking
2115 mono_gc_walk_heap (int flags, MonoGCReferences callback, void *data)
2120 hwi.callback = callback;
2123 sgen_clear_nursery_fragments ();
2124 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data, walk_references, &hwi, FALSE, TRUE);
2126 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, walk_references, &hwi);
2127 sgen_los_iterate_objects (walk_references, &hwi);
2137 mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks)
2139 gc_callbacks = *callbacks;
2143 mono_gc_get_gc_callbacks ()
2145 return &gc_callbacks;
2149 sgen_client_thread_register (SgenThreadInfo* info, void *stack_bottom_fallback)
2152 guint8 *staddr = NULL;
2154 #ifndef HAVE_KW_THREAD
2155 g_assert (!mono_native_tls_get_value (thread_info_key));
2156 mono_native_tls_set_value (thread_info_key, info);
2158 sgen_thread_info = info;
2161 info->client_info.skip = 0;
2162 info->client_info.stopped_ip = NULL;
2163 info->client_info.stopped_domain = NULL;
2165 info->client_info.stack_start = NULL;
2167 #ifdef SGEN_POSIX_STW
2168 info->client_info.stop_count = -1;
2169 info->client_info.signal = 0;
2172 /* On win32, stack_start_limit should be 0, since the stack can grow dynamically */
2173 mono_thread_info_get_stack_bounds (&staddr, &stsize);
2176 info->client_info.stack_start_limit = staddr;
2178 info->client_info.stack_end = staddr + stsize;
2180 gsize stack_bottom = (gsize)stack_bottom_fallback;
2181 stack_bottom += 4095;
2182 stack_bottom &= ~4095;
2183 info->client_info.stack_end = (char*)stack_bottom;
2186 memset (&info->client_info.ctx, 0, sizeof (MonoContext));
2188 if (mono_gc_get_gc_callbacks ()->thread_attach_func)
2189 info->client_info.runtime_data = mono_gc_get_gc_callbacks ()->thread_attach_func ();
2191 binary_protocol_thread_register ((gpointer)mono_thread_info_get_tid (info));
2193 SGEN_LOG (3, "registered thread %p (%p) stack end %p", info, (gpointer)mono_thread_info_get_tid (info), info->client_info.stack_end);
2197 sgen_client_thread_unregister (SgenThreadInfo *p)
2199 MonoNativeThreadId tid;
2201 #ifndef HAVE_KW_THREAD
2202 mono_native_tls_set_value (thread_info_key, NULL);
2204 sgen_thread_info = NULL;
2207 tid = mono_thread_info_get_tid (p);
2209 if (p->client_info.info.runtime_thread)
2210 mono_threads_add_joinable_thread ((gpointer)tid);
2212 if (mono_gc_get_gc_callbacks ()->thread_detach_func) {
2213 mono_gc_get_gc_callbacks ()->thread_detach_func (p->client_info.runtime_data);
2214 p->client_info.runtime_data = NULL;
2217 binary_protocol_thread_unregister ((gpointer)tid);
2218 SGEN_LOG (3, "unregister thread %p (%p)", p, (gpointer)tid);
2222 mono_gc_set_skip_thread (gboolean skip)
2224 SgenThreadInfo *info = mono_thread_info_current ();
2227 info->client_info.gc_disabled = skip;
2232 is_critical_method (MonoMethod *method)
2234 return mono_runtime_is_critical_method (method) || sgen_is_critical_method (method);
2238 thread_in_critical_region (SgenThreadInfo *info)
2240 return info->client_info.in_critical_region;
2244 sgen_thread_attach (SgenThreadInfo *info)
2246 mono_handle_arena_init ((MonoHandleArena**) &info->client_info.info.handle_arena);
2248 if (mono_gc_get_gc_callbacks ()->thread_attach_func && !info->client_info.runtime_data)
2249 info->client_info.runtime_data = mono_gc_get_gc_callbacks ()->thread_attach_func ();
2253 sgen_thread_detach (SgenThreadInfo *p)
2255 /* If a delegate is passed to native code and invoked on a thread we dont
2256 * know about, the jit will register it with mono_jit_thread_attach, but
2257 * we have no way of knowing when that thread goes away. SGen has a TSD
2258 * so we assume that if the domain is still registered, we can detach
2261 if (mono_domain_get ())
2262 mono_thread_detach_internal (mono_thread_internal_current ());
2264 mono_handle_arena_cleanup ((MonoHandleArena**) &p->client_info.info.handle_arena);
2268 mono_gc_register_thread (void *baseptr)
2270 return mono_thread_info_attach (baseptr) != NULL;
2274 mono_gc_is_gc_thread (void)
2278 result = mono_thread_info_current () != NULL;
2284 sgen_client_thread_register_worker (void)
2286 mono_thread_info_register_small_id ();
2287 mono_thread_info_set_name (mono_native_thread_id_get (), "SGen worker");
2290 /* Variables holding start/end nursery so it won't have to be passed at every call */
2291 static void *scan_area_arg_start, *scan_area_arg_end;
2294 mono_gc_conservatively_scan_area (void *start, void *end)
2296 sgen_conservatively_pin_objects_from ((void **)start, (void **)end, scan_area_arg_start, scan_area_arg_end, PIN_TYPE_STACK);
2300 mono_gc_scan_object (void *obj, void *gc_data)
2302 ScanCopyContext *ctx = (ScanCopyContext *)gc_data;
2303 ctx->ops->copy_or_mark_object ((GCObject**)&obj, ctx->queue);
2308 * Mark from thread stacks and registers.
2311 sgen_client_scan_thread_data (void *start_nursery, void *end_nursery, gboolean precise, ScanCopyContext ctx)
2313 scan_area_arg_start = start_nursery;
2314 scan_area_arg_end = end_nursery;
2316 FOREACH_THREAD (info) {
2317 int skip_reason = 0;
2318 void *aligned_stack_start = (void*)(mword) ALIGN_TO ((mword)info->client_info.stack_start, SIZEOF_VOID_P);
2320 if (info->client_info.skip) {
2321 SGEN_LOG (3, "Skipping dead thread %p, range: %p-%p, size: %zd", info, info->client_info.stack_start, info->client_info.stack_end, (char*)info->client_info.stack_end - (char*)info->client_info.stack_start);
2323 } else if (info->client_info.gc_disabled) {
2324 SGEN_LOG (3, "GC disabled for thread %p, range: %p-%p, size: %zd", info, info->client_info.stack_start, info->client_info.stack_end, (char*)info->client_info.stack_end - (char*)info->client_info.stack_start);
2326 } else if (!mono_thread_info_is_live (info)) {
2327 SGEN_LOG (3, "Skipping non-running thread %p, range: %p-%p, size: %zd (state %x)", info, info->client_info.stack_start, info->client_info.stack_end, (char*)info->client_info.stack_end - (char*)info->client_info.stack_start, info->client_info.info.thread_state);
2331 binary_protocol_scan_stack ((gpointer)mono_thread_info_get_tid (info), info->client_info.stack_start, info->client_info.stack_end, skip_reason);
2336 g_assert (info->client_info.suspend_done);
2337 SGEN_LOG (3, "Scanning thread %p, range: %p-%p, size: %zd, pinned=%zd", info, info->client_info.stack_start, info->client_info.stack_end, (char*)info->client_info.stack_end - (char*)info->client_info.stack_start, sgen_get_pinned_count ());
2338 if (mono_gc_get_gc_callbacks ()->thread_mark_func && !conservative_stack_mark) {
2339 mono_gc_get_gc_callbacks ()->thread_mark_func (info->client_info.runtime_data, (guint8 *)aligned_stack_start, (guint8 *)info->client_info.stack_end, precise, &ctx);
2340 } else if (!precise) {
2341 if (!conservative_stack_mark) {
2342 fprintf (stderr, "Precise stack mark not supported - disabling.\n");
2343 conservative_stack_mark = TRUE;
2345 sgen_conservatively_pin_objects_from ((void **)aligned_stack_start, (void **)info->client_info.stack_end, start_nursery, end_nursery, PIN_TYPE_STACK);
2349 sgen_conservatively_pin_objects_from ((void**)&info->client_info.ctx, (void**)(&info->client_info.ctx + 1),
2350 start_nursery, end_nursery, PIN_TYPE_STACK);
2353 // This is used on Coop GC for platforms where we cannot get the data for individual registers.
2354 // We force a spill of all registers into the stack and pass a chunk of data into sgen.
2355 MonoThreadUnwindState *state = &info->client_info.info.thread_saved_state [SELF_SUSPEND_STATE_INDEX];
2356 if (state && state->gc_stackdata) {
2357 sgen_conservatively_pin_objects_from ((void **)state->gc_stackdata, (void**)((char*)state->gc_stackdata + state->gc_stackdata_size),
2358 start_nursery, end_nursery, PIN_TYPE_STACK);
2362 } FOREACH_THREAD_END
2366 * mono_gc_set_stack_end:
2368 * Set the end of the current threads stack to STACK_END. The stack space between
2369 * STACK_END and the real end of the threads stack will not be scanned during collections.
2372 mono_gc_set_stack_end (void *stack_end)
2374 SgenThreadInfo *info;
2377 info = mono_thread_info_current ();
2379 SGEN_ASSERT (0, stack_end < info->client_info.stack_end, "Can only lower stack end");
2380 info->client_info.stack_end = stack_end;
2390 mono_gc_register_root (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
2392 return sgen_register_root (start, size, descr, descr ? ROOT_TYPE_NORMAL : ROOT_TYPE_PINNED, source, msg);
2396 mono_gc_register_root_wbarrier (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
2398 return sgen_register_root (start, size, descr, ROOT_TYPE_WBARRIER, source, msg);
2402 mono_gc_deregister_root (char* addr)
2404 sgen_deregister_root (addr);
2413 mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
2415 return pthread_create (new_thread, attr, start_routine, arg);
2424 sgen_client_total_allocated_heap_changed (size_t allocated_heap)
2426 mono_runtime_resource_check_limit (MONO_RESOURCE_GC_HEAP, allocated_heap);
2430 mono_gc_user_markers_supported (void)
2436 mono_object_is_alive (MonoObject* o)
2442 mono_gc_get_generation (MonoObject *obj)
2444 if (sgen_ptr_in_nursery (obj))
2450 mono_gc_enable_events (void)
2455 mono_gc_get_gc_name (void)
2461 mono_gc_get_description (void)
2463 return g_strdup ("sgen");
2467 mono_gc_set_desktop_mode (void)
2472 mono_gc_is_moving (void)
2478 mono_gc_is_disabled (void)
2484 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved)
2491 mono_gc_max_generation (void)
2497 mono_gc_precise_stack_mark_enabled (void)
2499 return !conservative_stack_mark;
2503 mono_gc_collect (int generation)
2505 sgen_gc_collect (generation);
2509 mono_gc_collection_count (int generation)
2511 return sgen_gc_collection_count (generation);
2515 mono_gc_get_used_size (void)
2517 return (int64_t)sgen_gc_get_used_size ();
2521 mono_gc_get_heap_size (void)
2523 return (int64_t)sgen_gc_get_total_heap_allocation ();
2527 mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker)
2529 return sgen_make_user_root_descriptor (marker);
2533 mono_gc_make_descr_for_string (gsize *bitmap, int numbits)
2535 return SGEN_DESC_STRING;
2539 mono_gc_get_nursery (int *shift_bits, size_t *size)
2541 *size = sgen_nursery_size;
2542 *shift_bits = DEFAULT_NURSERY_BITS;
2543 return sgen_get_nursery_start ();
2547 mono_gc_get_los_limit (void)
2549 return SGEN_MAX_SMALL_OBJ_SIZE;
2553 sgen_client_default_metadata (void)
2555 return mono_domain_get ();
2559 sgen_client_metadata_for_object (GCObject *obj)
2561 return mono_object_domain (obj);
2565 * mono_gchandle_is_in_domain:
2566 * @gchandle: a GCHandle's handle.
2567 * @domain: An application domain.
2569 * Returns: TRUE if the object wrapped by the @gchandle belongs to the specific @domain.
2572 mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain)
2574 MonoDomain *gchandle_domain = (MonoDomain *)sgen_gchandle_get_metadata (gchandle);
2575 return domain->domain_id == gchandle_domain->domain_id;
2579 * mono_gchandle_free_domain:
2580 * @unloading: domain that is unloading
2582 * Function used internally to cleanup any GC handle for objects belonging
2583 * to the specified domain during appdomain unload.
2586 mono_gchandle_free_domain (MonoDomain *unloading)
2591 null_link_if_in_domain (gpointer hidden, GCHandleType handle_type, int max_generation, gpointer user)
2593 MonoDomain *unloading_domain = (MonoDomain *)user;
2594 MonoDomain *obj_domain;
2595 gboolean is_weak = MONO_GC_HANDLE_TYPE_IS_WEAK (handle_type);
2596 if (MONO_GC_HANDLE_IS_OBJECT_POINTER (hidden)) {
2597 MonoObject *obj = (MonoObject *)MONO_GC_REVEAL_POINTER (hidden, is_weak);
2598 obj_domain = mono_object_domain (obj);
2600 obj_domain = (MonoDomain *)MONO_GC_REVEAL_POINTER (hidden, is_weak);
2602 if (unloading_domain->domain_id == obj_domain->domain_id)
2608 sgen_null_links_for_domain (MonoDomain *domain)
2611 for (type = HANDLE_TYPE_MIN; type < HANDLE_TYPE_MAX; ++type)
2612 sgen_gchandle_iterate ((GCHandleType)type, GENERATION_OLD, null_link_if_in_domain, domain);
2616 mono_gchandle_set_target (guint32 gchandle, MonoObject *obj)
2618 sgen_gchandle_set_target (gchandle, obj);
2622 sgen_client_gchandle_created (int handle_type, GCObject *obj, guint32 handle)
2624 #ifndef DISABLE_PERFCOUNTERS
2625 mono_perfcounters->gc_num_handles++;
2627 mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_CREATED, handle_type, handle, obj);
2631 sgen_client_gchandle_destroyed (int handle_type, guint32 handle)
2633 #ifndef DISABLE_PERFCOUNTERS
2634 mono_perfcounters->gc_num_handles--;
2636 mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_DESTROYED, handle_type, handle, NULL);
2640 sgen_client_ensure_weak_gchandles_accessible (void)
2643 * During the second bridge processing step the world is
2644 * running again. That step processes all weak links once
2645 * more to null those that refer to dead objects. Before that
2646 * is completed, those links must not be followed, so we
2647 * conservatively wait for bridge processing when any weak
2648 * link is dereferenced.
2650 /* FIXME: A GC can occur after this check fails, in which case we
2651 * should wait for bridge processing but would fail to do so.
2653 if (G_UNLIKELY (bridge_processing_in_progress))
2654 mono_gc_wait_for_bridge_processing ();
2658 mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data)
2662 result = func (data);
2663 UNLOCK_INTERRUPTION;
2668 mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size)
2674 mono_gc_get_card_table (int *shift_bits, gpointer *mask)
2676 return sgen_get_card_table_configuration (shift_bits, mask);
2680 mono_gc_card_table_nursery_check (void)
2682 return !sgen_get_major_collector ()->is_concurrent;
2685 /* Negative value to remove */
2687 mono_gc_add_memory_pressure (gint64 value)
2689 /* FIXME: Implement at some point? */
2697 sgen_client_degraded_allocation (size_t size)
2699 static int last_major_gc_warned = -1;
2700 static int num_degraded = 0;
2702 if (last_major_gc_warned < (int)gc_stats.major_gc_count) {
2704 if (num_degraded == 1 || num_degraded == 3)
2705 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Degraded allocation. Consider increasing nursery-size if the warning persists.");
2706 else if (num_degraded == 10)
2707 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Repeated degraded allocation. Consider increasing nursery-size.");
2708 last_major_gc_warned = gc_stats.major_gc_count;
2713 sgen_client_log_timing (GGTimingInfo *info, mword last_major_num_sections, mword last_los_memory_usage)
2715 SgenMajorCollector *major_collector = sgen_get_major_collector ();
2716 mword num_major_sections = major_collector->get_num_major_sections ();
2717 char full_timing_buff [1024];
2718 full_timing_buff [0] = '\0';
2720 if (!info->is_overflow)
2721 sprintf (full_timing_buff, "total %.2fms, bridge %.2fms", info->stw_time / 10000.0f, (int)info->bridge_time / 10000.0f);
2722 if (info->generation == GENERATION_OLD)
2723 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "GC_MAJOR%s: (%s) pause %.2fms, %s los %dK/%dK",
2724 info->is_overflow ? "_OVERFLOW" : "",
2725 info->reason ? info->reason : "",
2726 (int)info->total_time / 10000.0f,
2728 los_memory_usage / 1024,
2729 last_los_memory_usage / 1024);
2731 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "GC_MINOR%s: (%s) pause %.2fms, %s promoted %dK major %dK los %dK",
2732 info->is_overflow ? "_OVERFLOW" : "",
2733 info->reason ? info->reason : "",
2734 (int)info->total_time / 10000.0f,
2736 (num_major_sections - last_major_num_sections) * major_collector->section_size / 1024,
2737 major_collector->section_size * num_major_sections / 1024,
2738 los_memory_usage / 1024);
2746 sgen_client_description_for_internal_mem_type (int type)
2749 case INTERNAL_MEM_EPHEMERON_LINK: return "ephemeron-link";
2756 sgen_client_pre_collection_checks (void)
2758 if (sgen_mono_xdomain_checks) {
2759 sgen_clear_nursery_fragments ();
2760 sgen_check_for_xdomain_refs ();
2765 sgen_client_vtable_is_inited (MonoVTable *vt)
2767 return vt->klass->inited;
2771 sgen_client_vtable_get_namespace (MonoVTable *vt)
2773 return vt->klass->name_space;
2777 sgen_client_vtable_get_name (MonoVTable *vt)
2779 return vt->klass->name;
2787 sgen_client_init (void)
2790 MonoThreadInfoCallbacks cb;
2792 cb.thread_register = sgen_thread_register;
2793 cb.thread_detach = sgen_thread_detach;
2794 cb.thread_unregister = sgen_thread_unregister;
2795 cb.thread_attach = sgen_thread_attach;
2796 cb.mono_method_is_critical = (gboolean (*)(void *))is_critical_method;
2797 cb.mono_thread_in_critical_region = thread_in_critical_region;
2799 mono_threads_init (&cb, sizeof (SgenThreadInfo));
2801 ///* Keep this the default for now */
2802 /* Precise marking is broken on all supported targets. Disable until fixed. */
2803 conservative_stack_mark = TRUE;
2805 sgen_register_fixed_internal_mem_type (INTERNAL_MEM_EPHEMERON_LINK, sizeof (EphemeronLinkNode));
2807 mono_sgen_init_stw ();
2809 #ifndef HAVE_KW_THREAD
2810 mono_native_tls_alloc (&thread_info_key, NULL);
2811 #if defined(TARGET_OSX) || defined(TARGET_WIN32) || defined(TARGET_ANDROID) || defined(TARGET_IOS)
2813 * CEE_MONO_TLS requires the tls offset, not the key, so the code below only works on darwin,
2814 * where the two are the same.
2816 mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, thread_info_key);
2820 int tls_offset = -1;
2821 MONO_THREAD_VAR_OFFSET (sgen_thread_info, tls_offset);
2822 mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, tls_offset);
2827 * This needs to happen before any internal allocations because
2828 * it inits the small id which is required for hazard pointer
2833 mono_gc_register_thread (&dummy);
2837 sgen_client_handle_gc_param (const char *opt)
2839 if (g_str_has_prefix (opt, "stack-mark=")) {
2840 opt = strchr (opt, '=') + 1;
2841 if (!strcmp (opt, "precise")) {
2842 conservative_stack_mark = FALSE;
2843 } else if (!strcmp (opt, "conservative")) {
2844 conservative_stack_mark = TRUE;
2846 sgen_env_var_error (MONO_GC_PARAMS_NAME, conservative_stack_mark ? "Using `conservative`." : "Using `precise`.",
2847 "Invalid value `%s` for `stack-mark` option, possible values are: `precise`, `conservative`.", opt);
2849 } else if (g_str_has_prefix (opt, "bridge-implementation=")) {
2850 opt = strchr (opt, '=') + 1;
2851 sgen_set_bridge_implementation (opt);
2852 } else if (g_str_has_prefix (opt, "toggleref-test")) {
2853 /* FIXME: This should probably in MONO_GC_DEBUG */
2854 sgen_register_test_toggleref_callback ();
2862 sgen_client_print_gc_params_usage (void)
2864 fprintf (stderr, " stack-mark=MARK-METHOD (where MARK-METHOD is 'precise' or 'conservative')\n");
2868 sgen_client_handle_gc_debug (const char *opt)
2870 if (!strcmp (opt, "xdomain-checks")) {
2871 sgen_mono_xdomain_checks = TRUE;
2872 } else if (!strcmp (opt, "do-not-finalize")) {
2873 mono_do_not_finalize = TRUE;
2874 } else if (g_str_has_prefix (opt, "do-not-finalize=")) {
2875 opt = strchr (opt, '=') + 1;
2876 mono_do_not_finalize = TRUE;
2877 mono_do_not_finalize_class_names = g_strsplit (opt, ",", 0);
2878 } else if (!strcmp (opt, "log-finalizers")) {
2879 log_finalizers = TRUE;
2880 } else if (!strcmp (opt, "no-managed-allocator")) {
2881 sgen_set_use_managed_allocator (FALSE);
2882 } else if (!sgen_bridge_handle_gc_debug (opt)) {
2889 sgen_client_print_gc_debug_usage (void)
2891 fprintf (stderr, " xdomain-checks\n");
2892 fprintf (stderr, " do-not-finalize\n");
2893 fprintf (stderr, " log-finalizers\n");
2894 fprintf (stderr, " no-managed-allocator\n");
2895 sgen_bridge_print_gc_debug_usage ();
2900 sgen_client_get_provenance (void)
2902 #ifdef SGEN_OBJECT_PROVENANCE
2903 MonoGCCallbacks *cb = mono_gc_get_gc_callbacks ();
2904 gpointer (*get_provenance_func) (void);
2907 get_provenance_func = cb->get_provenance_func;
2908 if (get_provenance_func)
2909 return get_provenance_func ();
2917 sgen_client_describe_invalid_pointer (GCObject *ptr)
2919 sgen_bridge_describe_pointer (ptr);
2922 static gboolean gc_inited;
2925 mono_gc_base_init (void)
2930 mono_counters_init ();
2932 #ifdef HEAVY_STATISTICS
2933 mono_counters_register ("los marked cards", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_marked_cards);
2934 mono_counters_register ("los array cards scanned ", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_cards);
2935 mono_counters_register ("los array remsets", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_remsets);
2937 mono_counters_register ("WBarrier set arrayref", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_set_arrayref);
2938 mono_counters_register ("WBarrier value copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_value_copy);
2939 mono_counters_register ("WBarrier object copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_object_copy);
2944 if (nursery_canaries_enabled ())
2945 sgen_set_use_managed_allocator (FALSE);
2947 #if defined(HAVE_KW_THREAD)
2948 /* This can happen with using libmonosgen.so */
2949 if (mono_tls_key_get_offset (TLS_KEY_SGEN_TLAB_NEXT_ADDR) == -1)
2950 sgen_set_use_managed_allocator (FALSE);
2957 mono_gc_base_cleanup (void)
2959 sgen_thread_pool_shutdown ();
2963 mono_gc_is_null (void)