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 "utils/mono-threads-coop.h"
30 #include "sgen/sgen-thread-pool.h"
32 #ifdef HEAVY_STATISTICS
33 static guint64 stat_wbarrier_set_arrayref = 0;
34 static guint64 stat_wbarrier_value_copy = 0;
35 static guint64 stat_wbarrier_object_copy = 0;
37 static guint64 los_marked_cards;
38 static guint64 los_array_cards;
39 static guint64 los_array_remsets;
42 /* If set, mark stacks conservatively, even if precise marking is possible */
43 static gboolean conservative_stack_mark = FALSE;
44 /* If set, check that there are no references to the domain left at domain unload */
45 gboolean sgen_mono_xdomain_checks = FALSE;
47 /* Functions supplied by the runtime to be called by the GC */
48 static MonoGCCallbacks gc_callbacks;
51 __thread SgenThreadInfo *sgen_thread_info;
53 MonoNativeTlsKey thread_info_key;
56 #define ALIGN_TO(val,align) ((((guint64)val) + ((align) - 1)) & ~((align) - 1))
58 #define OPDEF(a,b,c,d,e,f,g,h,i,j) \
62 #include "mono/cil/opcode.def"
73 ptr_on_stack (void *ptr)
75 gpointer stack_start = &stack_start;
76 SgenThreadInfo *info = mono_thread_info_current ();
78 if (ptr >= stack_start && ptr < (gpointer)info->client_info.stack_end)
83 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
85 #define HANDLE_PTR(ptr,obj) do { \
86 gpointer o = *(gpointer*)(ptr); \
88 gpointer d = ((char*)dest) + ((char*)(ptr) - (char*)(obj)); \
89 binary_protocol_wbarrier (d, o, (gpointer) SGEN_LOAD_VTABLE (o)); \
94 scan_object_for_binary_protocol_copy_wbarrier (gpointer dest, char *start, mword desc)
96 #define SCAN_OBJECT_NOVTABLE
97 #include "sgen/sgen-scan-object.h"
102 mono_gc_wbarrier_value_copy (gpointer dest, gpointer src, int count, MonoClass *klass)
104 HEAVY_STAT (++stat_wbarrier_value_copy);
105 g_assert (klass->valuetype);
107 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);
109 if (sgen_ptr_in_nursery (dest) || ptr_on_stack (dest) || !sgen_gc_descr_has_references ((mword)klass->gc_descr)) {
110 size_t element_size = mono_class_value_size (klass, NULL);
111 size_t size = count * element_size;
112 mono_gc_memmove_atomic (dest, src, size);
116 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
117 if (binary_protocol_is_heavy_enabled ()) {
118 size_t element_size = mono_class_value_size (klass, NULL);
120 for (i = 0; i < count; ++i) {
121 scan_object_for_binary_protocol_copy_wbarrier ((char*)dest + i * element_size,
122 (char*)src + i * element_size - sizeof (MonoObject),
123 (mword) klass->gc_descr);
128 sgen_get_remset ()->wbarrier_value_copy (dest, src, count, mono_class_value_size (klass, NULL));
132 * mono_gc_wbarrier_object_copy:
134 * Write barrier to call when obj is the result of a clone or copy of an object.
137 mono_gc_wbarrier_object_copy (MonoObject* obj, MonoObject *src)
141 HEAVY_STAT (++stat_wbarrier_object_copy);
143 if (sgen_ptr_in_nursery (obj) || ptr_on_stack (obj) || !SGEN_OBJECT_HAS_REFERENCES (src)) {
144 size = mono_object_class (obj)->instance_size;
145 mono_gc_memmove_aligned ((char*)obj + sizeof (MonoObject), (char*)src + sizeof (MonoObject),
146 size - sizeof (MonoObject));
150 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
151 if (binary_protocol_is_heavy_enabled ())
152 scan_object_for_binary_protocol_copy_wbarrier (obj, (char*)src, (mword) src->vtable->gc_descr);
155 sgen_get_remset ()->wbarrier_object_copy (obj, src);
159 mono_gc_wbarrier_set_arrayref (MonoArray *arr, gpointer slot_ptr, MonoObject* value)
161 HEAVY_STAT (++stat_wbarrier_set_arrayref);
162 if (sgen_ptr_in_nursery (slot_ptr)) {
163 *(void**)slot_ptr = value;
166 SGEN_LOG (8, "Adding remset at %p", slot_ptr);
168 binary_protocol_wbarrier (slot_ptr, value, value->vtable);
170 sgen_get_remset ()->wbarrier_set_field ((GCObject*)arr, slot_ptr, value);
174 mono_gc_wbarrier_set_field (MonoObject *obj, gpointer field_ptr, MonoObject* value)
176 mono_gc_wbarrier_set_arrayref ((MonoArray*)obj, field_ptr, value);
180 mono_gc_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap)
182 sgen_wbarrier_value_copy_bitmap (_dest, _src, size, bitmap);
185 static MonoMethod *write_barrier_conc_method;
186 static MonoMethod *write_barrier_noconc_method;
189 sgen_is_critical_method (MonoMethod *method)
191 return (method == write_barrier_conc_method || method == write_barrier_noconc_method || sgen_is_managed_allocator (method));
195 sgen_has_critical_method (void)
197 return write_barrier_conc_method || write_barrier_noconc_method || sgen_has_managed_allocator ();
203 emit_nursery_check (MonoMethodBuilder *mb, int *nursery_check_return_labels, gboolean is_concurrent)
205 int shifted_nursery_start = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
207 memset (nursery_check_return_labels, 0, sizeof (int) * 2);
208 // if (ptr_in_nursery (ptr)) return;
210 * Masking out the bits might be faster, but we would have to use 64 bit
211 * immediates, which might be slower.
213 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
214 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_START);
215 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
216 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_BITS);
217 mono_mb_emit_byte (mb, CEE_SHR_UN);
218 mono_mb_emit_stloc (mb, shifted_nursery_start);
220 mono_mb_emit_ldarg (mb, 0);
221 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
222 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_BITS);
223 mono_mb_emit_byte (mb, CEE_SHR_UN);
224 mono_mb_emit_ldloc (mb, shifted_nursery_start);
225 nursery_check_return_labels [0] = mono_mb_emit_branch (mb, CEE_BEQ);
227 if (!is_concurrent) {
228 // if (!ptr_in_nursery (*ptr)) return;
229 mono_mb_emit_ldarg (mb, 0);
230 mono_mb_emit_byte (mb, CEE_LDIND_I);
231 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
232 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_BITS);
233 mono_mb_emit_byte (mb, CEE_SHR_UN);
234 mono_mb_emit_ldloc (mb, shifted_nursery_start);
235 nursery_check_return_labels [1] = mono_mb_emit_branch (mb, CEE_BNE_UN);
241 mono_gc_get_specific_write_barrier (gboolean is_concurrent)
244 MonoMethodBuilder *mb;
245 MonoMethodSignature *sig;
246 MonoMethod **write_barrier_method_addr;
248 #ifdef MANAGED_WBARRIER
249 int i, nursery_check_labels [2];
252 // FIXME: Maybe create a separate version for ctors (the branch would be
253 // correctly predicted more times)
255 write_barrier_method_addr = &write_barrier_conc_method;
257 write_barrier_method_addr = &write_barrier_noconc_method;
259 if (*write_barrier_method_addr)
260 return *write_barrier_method_addr;
262 /* Create the IL version of mono_gc_barrier_generic_store () */
263 sig = mono_metadata_signature_alloc (mono_defaults.corlib, 1);
264 sig->ret = &mono_defaults.void_class->byval_arg;
265 sig->params [0] = &mono_defaults.int_class->byval_arg;
268 mb = mono_mb_new (mono_defaults.object_class, "wbarrier_conc", MONO_WRAPPER_WRITE_BARRIER);
270 mb = mono_mb_new (mono_defaults.object_class, "wbarrier_noconc", MONO_WRAPPER_WRITE_BARRIER);
273 #ifdef MANAGED_WBARRIER
274 emit_nursery_check (mb, nursery_check_labels, is_concurrent);
276 addr = sgen_cardtable + ((address >> CARD_BITS) & CARD_MASK)
280 LDC_PTR sgen_cardtable
286 if (SGEN_HAVE_OVERLAPPING_CARDS) {
287 LDC_PTR card_table_mask
294 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
295 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_CARD_TABLE);
296 mono_mb_emit_ldarg (mb, 0);
297 mono_mb_emit_icon (mb, CARD_BITS);
298 mono_mb_emit_byte (mb, CEE_SHR_UN);
299 mono_mb_emit_byte (mb, CEE_CONV_I);
300 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
301 #if SIZEOF_VOID_P == 8
302 mono_mb_emit_icon8 (mb, CARD_MASK);
304 mono_mb_emit_icon (mb, CARD_MASK);
306 mono_mb_emit_byte (mb, CEE_CONV_I);
307 mono_mb_emit_byte (mb, CEE_AND);
309 mono_mb_emit_byte (mb, CEE_ADD);
310 mono_mb_emit_icon (mb, 1);
311 mono_mb_emit_byte (mb, CEE_STIND_I1);
314 for (i = 0; i < 2; ++i) {
315 if (nursery_check_labels [i])
316 mono_mb_patch_branch (mb, nursery_check_labels [i]);
318 mono_mb_emit_byte (mb, CEE_RET);
320 mono_mb_emit_ldarg (mb, 0);
321 mono_mb_emit_icall (mb, mono_gc_wbarrier_generic_nostore);
322 mono_mb_emit_byte (mb, CEE_RET);
325 res = mono_mb_create_method (mb, sig, 16);
326 info = mono_wrapper_info_create (mb, WRAPPER_SUBTYPE_NONE);
327 mono_marshal_set_wrapper_info (res, info);
331 if (*write_barrier_method_addr) {
332 /* Already created */
333 mono_free_method (res);
335 /* double-checked locking */
336 mono_memory_barrier ();
337 *write_barrier_method_addr = res;
341 return *write_barrier_method_addr;
345 mono_gc_get_write_barrier (void)
347 return mono_gc_get_specific_write_barrier (major_collector.is_concurrent);
351 * Dummy filler objects
354 /* Vtable of the objects used to fill out nursery fragments before a collection */
355 static GCVTable array_fill_vtable;
358 get_array_fill_vtable (void)
360 if (!array_fill_vtable) {
361 static MonoClass klass;
362 static char _vtable[sizeof(MonoVTable)+8];
363 MonoVTable* vtable = (MonoVTable*) ALIGN_TO((mword)_vtable, 8);
366 MonoDomain *domain = mono_get_root_domain ();
369 klass.element_class = mono_defaults.byte_class;
371 klass.instance_size = MONO_SIZEOF_MONO_ARRAY;
372 klass.sizes.element_size = 1;
373 klass.name = "array_filler_type";
375 vtable->klass = &klass;
377 vtable->gc_descr = mono_gc_make_descr_for_array (TRUE, &bmap, 0, 1);
380 array_fill_vtable = vtable;
382 return array_fill_vtable;
386 sgen_client_array_fill_range (char *start, size_t size)
390 if (size < MONO_SIZEOF_MONO_ARRAY) {
391 memset (start, 0, size);
395 o = (MonoArray*)start;
396 o->obj.vtable = (MonoVTable*)get_array_fill_vtable ();
397 /* Mark this as not a real object */
398 o->obj.synchronisation = (MonoThreadsSync *)GINT_TO_POINTER (-1);
400 o->max_length = (mono_array_size_t)(size - MONO_SIZEOF_MONO_ARRAY);
406 sgen_client_zero_array_fill_header (void *p, size_t size)
408 if (size >= MONO_SIZEOF_MONO_ARRAY) {
409 memset (p, 0, MONO_SIZEOF_MONO_ARRAY);
411 static guint8 zeros [MONO_SIZEOF_MONO_ARRAY];
413 SGEN_ASSERT (0, !memcmp (p, zeros, size), "TLAB segment must be zeroed out.");
421 static MonoGCFinalizerCallbacks fin_callbacks;
424 mono_gc_get_vtable_bits (MonoClass *klass)
427 /* FIXME move this to the bridge code */
428 if (sgen_need_bridge_processing ()) {
429 switch (sgen_bridge_class_kind (klass)) {
430 case GC_BRIDGE_TRANSPARENT_BRIDGE_CLASS:
431 case GC_BRIDGE_OPAQUE_BRIDGE_CLASS:
432 res = SGEN_GC_BIT_BRIDGE_OBJECT;
434 case GC_BRIDGE_OPAQUE_CLASS:
435 res = SGEN_GC_BIT_BRIDGE_OPAQUE_OBJECT;
437 case GC_BRIDGE_TRANSPARENT_CLASS:
441 if (fin_callbacks.is_class_finalization_aware) {
442 if (fin_callbacks.is_class_finalization_aware (klass))
443 res |= SGEN_GC_BIT_FINALIZER_AWARE;
449 is_finalization_aware (MonoObject *obj)
451 MonoVTable *vt = SGEN_LOAD_VTABLE (obj);
452 return (vt->gc_bits & SGEN_GC_BIT_FINALIZER_AWARE) == SGEN_GC_BIT_FINALIZER_AWARE;
456 sgen_client_object_queued_for_finalization (GCObject *obj)
458 if (fin_callbacks.object_queued_for_finalization && is_finalization_aware (obj))
459 fin_callbacks.object_queued_for_finalization (obj);
462 if (G_UNLIKELY (MONO_GC_FINALIZE_ENQUEUE_ENABLED ())) {
463 int gen = sgen_ptr_in_nursery (obj) ? GENERATION_NURSERY : GENERATION_OLD;
464 GCVTable vt = SGEN_LOAD_VTABLE (obj);
465 MONO_GC_FINALIZE_ENQUEUE ((mword)obj, sgen_safe_object_get_size (obj),
466 sgen_client_vtable_get_namespace (vt), sgen_client_vtable_get_name (vt), gen,
467 sgen_client_object_has_critical_finalizer (obj));
473 mono_gc_register_finalizer_callbacks (MonoGCFinalizerCallbacks *callbacks)
475 if (callbacks->version != MONO_GC_FINALIZER_EXTENSION_VERSION)
476 g_error ("Invalid finalizer callback version. Expected %d but got %d\n", MONO_GC_FINALIZER_EXTENSION_VERSION, callbacks->version);
478 fin_callbacks = *callbacks;
482 sgen_client_run_finalize (MonoObject *obj)
484 mono_gc_run_finalize (obj, NULL);
488 mono_gc_invoke_finalizers (void)
490 return sgen_gc_invoke_finalizers ();
494 mono_gc_pending_finalizers (void)
496 return sgen_have_pending_finalizers ();
500 sgen_client_finalize_notify (void)
502 mono_gc_finalize_notify ();
506 mono_gc_register_for_finalization (MonoObject *obj, void *user_data)
508 sgen_object_register_for_finalization (obj, user_data);
512 object_in_domain_predicate (MonoObject *obj, void *user_data)
514 MonoDomain *domain = (MonoDomain *)user_data;
515 if (mono_object_domain (obj) == domain) {
516 SGEN_LOG (5, "Unregistering finalizer for object: %p (%s)", obj, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj)));
523 * mono_gc_finalizers_for_domain:
524 * @domain: the unloading appdomain
525 * @out_array: output array
526 * @out_size: size of output array
528 * Enqueue for finalization all objects that belong to the unloading appdomain @domain
529 * @suspend is used for early termination of the enqueuing process.
532 mono_gc_finalize_domain (MonoDomain *domain, volatile gboolean *suspend)
534 sgen_finalize_if (object_in_domain_predicate, domain, suspend);
541 typedef struct _EphemeronLinkNode EphemeronLinkNode;
543 struct _EphemeronLinkNode {
544 EphemeronLinkNode *next;
553 static EphemeronLinkNode *ephemeron_list;
555 /* LOCKING: requires that the GC lock is held */
557 null_ephemerons_for_domain (MonoDomain *domain)
559 EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
562 MonoObject *object = (MonoObject*)current->array;
565 SGEN_ASSERT (0, object->vtable, "Can't have objects without vtables.");
567 if (object && object->vtable->domain == domain) {
568 EphemeronLinkNode *tmp = current;
571 prev->next = current->next;
573 ephemeron_list = current->next;
575 current = current->next;
576 sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
579 current = current->next;
584 /* LOCKING: requires that the GC lock is held */
586 sgen_client_clear_unreachable_ephemerons (ScanCopyContext ctx)
588 CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
589 SgenGrayQueue *queue = ctx.queue;
590 EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
591 Ephemeron *cur, *array_end;
595 MonoArray *array = current->array;
597 if (!sgen_is_object_alive_for_current_gen ((GCObject*)array)) {
598 EphemeronLinkNode *tmp = current;
600 SGEN_LOG (5, "Dead Ephemeron array at %p", array);
603 prev->next = current->next;
605 ephemeron_list = current->next;
607 current = current->next;
608 sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
613 copy_func ((GCObject**)&array, queue);
614 current->array = array;
616 SGEN_LOG (5, "Clearing unreachable entries for ephemeron array at %p", array);
618 cur = mono_array_addr (array, Ephemeron, 0);
619 array_end = cur + mono_array_length_fast (array);
620 tombstone = SGEN_LOAD_VTABLE ((GCObject*)array)->domain->ephemeron_tombstone;
622 for (; cur < array_end; ++cur) {
623 GCObject *key = cur->key;
625 if (!key || key == tombstone)
628 SGEN_LOG (5, "[%zd] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
629 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
630 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
632 if (!sgen_is_object_alive_for_current_gen (key)) {
633 cur->key = tombstone;
639 current = current->next;
644 LOCKING: requires that the GC lock is held
646 Limitations: We scan all ephemerons on every collection since the current design doesn't allow for a simple nursery/mature split.
649 sgen_client_mark_ephemerons (ScanCopyContext ctx)
651 CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
652 SgenGrayQueue *queue = ctx.queue;
653 gboolean nothing_marked = TRUE;
654 EphemeronLinkNode *current = ephemeron_list;
655 Ephemeron *cur, *array_end;
658 for (current = ephemeron_list; current; current = current->next) {
659 MonoArray *array = current->array;
660 SGEN_LOG (5, "Ephemeron array at %p", array);
662 /*It has to be alive*/
663 if (!sgen_is_object_alive_for_current_gen ((GCObject*)array)) {
664 SGEN_LOG (5, "\tnot reachable");
668 copy_func ((GCObject**)&array, queue);
670 cur = mono_array_addr (array, Ephemeron, 0);
671 array_end = cur + mono_array_length_fast (array);
672 tombstone = SGEN_LOAD_VTABLE ((GCObject*)array)->domain->ephemeron_tombstone;
674 for (; cur < array_end; ++cur) {
675 GCObject *key = cur->key;
677 if (!key || key == tombstone)
680 SGEN_LOG (5, "[%zd] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
681 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
682 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
684 if (sgen_is_object_alive_for_current_gen (key)) {
685 GCObject *value = cur->value;
687 copy_func (&cur->key, queue);
689 if (!sgen_is_object_alive_for_current_gen (value))
690 nothing_marked = FALSE;
691 copy_func (&cur->value, queue);
697 SGEN_LOG (5, "Ephemeron run finished. Is it done %d", nothing_marked);
698 return nothing_marked;
702 mono_gc_ephemeron_array_add (MonoObject *obj)
704 EphemeronLinkNode *node;
708 node = (EphemeronLinkNode *)sgen_alloc_internal (INTERNAL_MEM_EPHEMERON_LINK);
713 node->array = (MonoArray*)obj;
714 node->next = ephemeron_list;
715 ephemeron_list = node;
717 SGEN_LOG (5, "Registered ephemeron array %p", obj);
728 mono_gc_set_current_thread_appdomain (MonoDomain *domain)
730 SgenThreadInfo *info = mono_thread_info_current ();
732 /* Could be called from sgen_thread_unregister () with a NULL info */
735 info->client_info.stopped_domain = domain;
740 need_remove_object_for_domain (GCObject *start, MonoDomain *domain)
742 if (mono_object_domain (start) == domain) {
743 SGEN_LOG (4, "Need to cleanup object %p", start);
744 binary_protocol_cleanup (start, (gpointer)SGEN_LOAD_VTABLE (start), sgen_safe_object_get_size ((GCObject*)start));
751 process_object_for_domain_clearing (GCObject *start, MonoDomain *domain)
753 MonoVTable *vt = SGEN_LOAD_VTABLE (start);
754 if (vt->klass == mono_defaults.internal_thread_class)
755 g_assert (mono_object_domain (start) == mono_get_root_domain ());
756 /* The object could be a proxy for an object in the domain
758 #ifndef DISABLE_REMOTING
759 if (mono_defaults.real_proxy_class->supertypes && mono_class_has_parent_fast (vt->klass, mono_defaults.real_proxy_class)) {
760 MonoObject *server = ((MonoRealProxy*)start)->unwrapped_server;
762 /* The server could already have been zeroed out, so
763 we need to check for that, too. */
764 if (server && (!SGEN_LOAD_VTABLE (server) || mono_object_domain (server) == domain)) {
765 SGEN_LOG (4, "Cleaning up remote pointer in %p to object %p", start, server);
766 ((MonoRealProxy*)start)->unwrapped_server = NULL;
773 clear_domain_process_object (GCObject *obj, MonoDomain *domain)
777 process_object_for_domain_clearing (obj, domain);
778 remove = need_remove_object_for_domain (obj, domain);
780 if (remove && obj->synchronisation) {
781 guint32 dislink = mono_monitor_get_object_monitor_gchandle (obj);
783 mono_gchandle_free (dislink);
790 clear_domain_process_minor_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
792 if (clear_domain_process_object (obj, domain)) {
793 CANARIFY_SIZE (size);
794 memset (obj, 0, size);
799 clear_domain_process_major_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
801 clear_domain_process_object (obj, domain);
805 clear_domain_free_major_non_pinned_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
807 if (need_remove_object_for_domain (obj, domain))
808 major_collector.free_non_pinned_object (obj, size);
812 clear_domain_free_major_pinned_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
814 if (need_remove_object_for_domain (obj, domain))
815 major_collector.free_pinned_object (obj, size);
819 * When appdomains are unloaded we can easily remove objects that have finalizers,
820 * but all the others could still be present in random places on the heap.
821 * We need a sweep to get rid of them even though it's going to be costly
823 * The reason we need to remove them is because we access the vtable and class
824 * structures to know the object size and the reference bitmap: once the domain is
825 * unloaded the point to random memory.
828 mono_gc_clear_domain (MonoDomain * domain)
830 LOSObject *bigobj, *prev;
835 binary_protocol_domain_unload_begin (domain);
839 if (sgen_concurrent_collection_in_progress ())
840 sgen_perform_collection (0, GENERATION_OLD, "clear domain", TRUE, FALSE);
841 SGEN_ASSERT (0, !sgen_concurrent_collection_in_progress (), "We just ordered a synchronous collection. Why are we collecting concurrently?");
843 major_collector.finish_sweeping ();
845 sgen_process_fin_stage_entries ();
847 sgen_clear_nursery_fragments ();
849 if (sgen_mono_xdomain_checks && domain != mono_get_root_domain ()) {
850 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_NORMAL);
851 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_WBARRIER);
852 sgen_check_for_xdomain_refs ();
855 /*Ephemerons and dislinks must be processed before LOS since they might end up pointing
856 to memory returned to the OS.*/
857 null_ephemerons_for_domain (domain);
858 sgen_null_links_for_domain (domain);
860 for (i = GENERATION_NURSERY; i < GENERATION_MAX; ++i)
861 sgen_remove_finalizers_if (object_in_domain_predicate, domain, i);
863 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
864 (IterateObjectCallbackFunc)clear_domain_process_minor_object_callback, domain, FALSE, TRUE);
866 /* We need two passes over major and large objects because
867 freeing such objects might give their memory back to the OS
868 (in the case of large objects) or obliterate its vtable
869 (pinned objects with major-copying or pinned and non-pinned
870 objects with major-mark&sweep), but we might need to
871 dereference a pointer from an object to another object if
872 the first object is a proxy. */
873 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, (IterateObjectCallbackFunc)clear_domain_process_major_object_callback, domain);
874 for (bigobj = los_object_list; bigobj; bigobj = bigobj->next)
875 clear_domain_process_object ((GCObject*)bigobj->data, domain);
878 for (bigobj = los_object_list; bigobj;) {
879 if (need_remove_object_for_domain ((GCObject*)bigobj->data, domain)) {
880 LOSObject *to_free = bigobj;
882 prev->next = bigobj->next;
884 los_object_list = bigobj->next;
885 bigobj = bigobj->next;
886 SGEN_LOG (4, "Freeing large object %p", bigobj->data);
887 sgen_los_free_object (to_free);
891 bigobj = bigobj->next;
893 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_NON_PINNED, (IterateObjectCallbackFunc)clear_domain_free_major_non_pinned_object_callback, domain);
894 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_PINNED, (IterateObjectCallbackFunc)clear_domain_free_major_pinned_object_callback, domain);
896 if (domain == mono_get_root_domain ()) {
897 sgen_pin_stats_report ();
898 sgen_object_layout_dump (stdout);
901 sgen_restart_world (0);
903 binary_protocol_domain_unload_end (domain);
904 binary_protocol_flush_buffers (FALSE);
913 static gboolean alloc_events = FALSE;
916 mono_gc_enable_alloc_events (void)
922 mono_gc_alloc_obj (MonoVTable *vtable, size_t size)
924 MonoObject *obj = sgen_alloc_obj (vtable, size);
926 if (G_UNLIKELY (alloc_events)) {
928 mono_profiler_allocation (obj);
935 mono_gc_alloc_pinned_obj (MonoVTable *vtable, size_t size)
937 MonoObject *obj = sgen_alloc_obj_pinned (vtable, size);
939 if (G_UNLIKELY (alloc_events)) {
941 mono_profiler_allocation (obj);
948 mono_gc_alloc_mature (MonoVTable *vtable, size_t size)
950 MonoObject *obj = sgen_alloc_obj_mature (vtable, size);
952 if (G_UNLIKELY (alloc_events)) {
954 mono_profiler_allocation (obj);
961 mono_gc_alloc_fixed (size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
963 /* FIXME: do a single allocation */
964 void *res = calloc (1, size);
967 if (!mono_gc_register_root ((char *)res, size, descr, source, msg)) {
975 mono_gc_free_fixed (void* addr)
977 mono_gc_deregister_root ((char *)addr);
985 static MonoMethod* alloc_method_cache [ATYPE_NUM];
986 static MonoMethod* slowpath_alloc_method_cache [ATYPE_NUM];
987 static gboolean use_managed_allocator = TRUE;
989 #ifdef MANAGED_ALLOCATION
991 #ifdef HAVE_KW_THREAD
993 #define EMIT_TLS_ACCESS_VAR(_mb, _var) /* nothing to do */
995 #define EMIT_TLS_ACCESS_IN_CRITICAL_REGION_ADDR(mb, _var) \
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_IN_CRITICAL_REGION_ADDR); \
1002 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb, _var) 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_NEXT_ADDR); \
1008 #define EMIT_TLS_ACCESS_TEMP_END(mb, _var) do { \
1009 mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX); \
1010 mono_mb_emit_byte ((mb), CEE_MONO_TLS); \
1011 mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_TLAB_TEMP_END); \
1016 #if defined(TARGET_OSX) || defined(TARGET_WIN32) || defined(TARGET_ANDROID) || defined(TARGET_IOS)
1018 // Cache the SgenThreadInfo pointer in a local 'var'.
1019 #define EMIT_TLS_ACCESS_VAR(mb, var) \
1021 var = mono_mb_add_local ((mb), &mono_defaults.int_class->byval_arg); \
1022 mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX); \
1023 mono_mb_emit_byte ((mb), CEE_MONO_TLS); \
1024 mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_THREAD_INFO); \
1025 mono_mb_emit_stloc ((mb), (var)); \
1028 #define EMIT_TLS_ACCESS_IN_CRITICAL_REGION_ADDR(mb, var) \
1030 mono_mb_emit_ldloc ((mb), (var)); \
1031 mono_mb_emit_icon ((mb), MONO_STRUCT_OFFSET (SgenClientThreadInfo, in_critical_region)); \
1032 mono_mb_emit_byte ((mb), CEE_ADD); \
1035 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb, var) do { \
1036 mono_mb_emit_ldloc ((mb), (var)); \
1037 mono_mb_emit_icon ((mb), MONO_STRUCT_OFFSET (SgenThreadInfo, tlab_next_addr)); \
1038 mono_mb_emit_byte ((mb), CEE_ADD); \
1039 mono_mb_emit_byte ((mb), CEE_LDIND_I); \
1042 #define EMIT_TLS_ACCESS_TEMP_END(mb, var) do { \
1043 mono_mb_emit_ldloc ((mb), (var)); \
1044 mono_mb_emit_icon ((mb), MONO_STRUCT_OFFSET (SgenThreadInfo, tlab_temp_end)); \
1045 mono_mb_emit_byte ((mb), CEE_ADD); \
1046 mono_mb_emit_byte ((mb), CEE_LDIND_I); \
1050 #define EMIT_TLS_ACCESS_VAR(mb, _var) do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1051 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb, _var) do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1052 #define EMIT_TLS_ACCESS_TEMP_END(mb, _var) do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1053 #define EMIT_TLS_ACCESS_IN_CRITICAL_REGION_ADDR(mb, _var) do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1058 /* FIXME: Do this in the JIT, where specialized allocation sequences can be created
1059 * for each class. This is currently not easy to do, as it is hard to generate basic
1060 * blocks + branches, but it is easy with the linear IL codebase.
1062 * For this to work we'd need to solve the TLAB race, first. Now we
1063 * require the allocator to be in a few known methods to make sure
1064 * that they are executed atomically via the restart mechanism.
1067 create_allocator (int atype, ManagedAllocatorVariant variant)
1069 int p_var, size_var, thread_var G_GNUC_UNUSED;
1070 gboolean slowpath = variant == MANAGED_ALLOCATOR_SLOW_PATH;
1071 guint32 slowpath_branch, max_size_branch;
1072 MonoMethodBuilder *mb;
1074 MonoMethodSignature *csig;
1075 static gboolean registered = FALSE;
1076 int tlab_next_addr_var, new_next_var;
1077 const char *name = NULL;
1082 mono_register_jit_icall (mono_gc_alloc_obj, "mono_gc_alloc_obj", mono_create_icall_signature ("object ptr int"), FALSE);
1083 mono_register_jit_icall (mono_gc_alloc_vector, "mono_gc_alloc_vector", mono_create_icall_signature ("object ptr int int"), FALSE);
1084 mono_register_jit_icall (mono_gc_alloc_string, "mono_gc_alloc_string", mono_create_icall_signature ("object ptr int int32"), FALSE);
1088 if (atype == ATYPE_SMALL) {
1089 name = slowpath ? "SlowAllocSmall" : "AllocSmall";
1090 } else if (atype == ATYPE_NORMAL) {
1091 name = slowpath ? "SlowAlloc" : "Alloc";
1092 } else if (atype == ATYPE_VECTOR) {
1093 name = slowpath ? "SlowAllocVector" : "AllocVector";
1094 } else if (atype == ATYPE_STRING) {
1095 name = slowpath ? "SlowAllocString" : "AllocString";
1097 g_assert_not_reached ();
1100 if (atype == ATYPE_NORMAL)
1105 csig = mono_metadata_signature_alloc (mono_defaults.corlib, num_params);
1106 if (atype == ATYPE_STRING) {
1107 csig->ret = &mono_defaults.string_class->byval_arg;
1108 csig->params [0] = &mono_defaults.int_class->byval_arg;
1109 csig->params [1] = &mono_defaults.int32_class->byval_arg;
1111 csig->ret = &mono_defaults.object_class->byval_arg;
1112 for (i = 0; i < num_params; i++)
1113 csig->params [i] = &mono_defaults.int_class->byval_arg;
1116 mb = mono_mb_new (mono_defaults.object_class, name, MONO_WRAPPER_ALLOC);
1123 mono_mb_emit_ldarg (mb, 0);
1124 mono_mb_emit_icall (mb, ves_icall_object_new_specific);
1127 mono_mb_emit_ldarg (mb, 0);
1128 mono_mb_emit_ldarg (mb, 1);
1129 mono_mb_emit_icall (mb, ves_icall_array_new_specific);
1132 mono_mb_emit_ldarg (mb, 1);
1133 mono_mb_emit_icall (mb, ves_icall_string_alloc);
1136 g_assert_not_reached ();
1142 EMIT_TLS_ACCESS_VAR (mb, thread_var);
1144 size_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1145 if (atype == ATYPE_SMALL) {
1146 /* size_var = size_arg */
1147 mono_mb_emit_ldarg (mb, 1);
1148 mono_mb_emit_stloc (mb, size_var);
1149 } else if (atype == ATYPE_NORMAL) {
1150 /* size = vtable->klass->instance_size; */
1151 mono_mb_emit_ldarg (mb, 0);
1152 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoVTable, klass));
1153 mono_mb_emit_byte (mb, CEE_ADD);
1154 mono_mb_emit_byte (mb, CEE_LDIND_I);
1155 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoClass, instance_size));
1156 mono_mb_emit_byte (mb, CEE_ADD);
1157 /* FIXME: assert instance_size stays a 4 byte integer */
1158 mono_mb_emit_byte (mb, CEE_LDIND_U4);
1159 mono_mb_emit_byte (mb, CEE_CONV_I);
1160 mono_mb_emit_stloc (mb, size_var);
1161 } else if (atype == ATYPE_VECTOR) {
1162 MonoExceptionClause *clause;
1163 int pos, pos_leave, pos_error;
1164 MonoClass *oom_exc_class;
1168 * n > MONO_ARRAY_MAX_INDEX => OutOfMemoryException
1169 * n < 0 => OverflowException
1171 * We can do an unsigned comparison to catch both cases, then in the error
1172 * case compare signed to distinguish between them.
1174 mono_mb_emit_ldarg (mb, 1);
1175 mono_mb_emit_icon (mb, MONO_ARRAY_MAX_INDEX);
1176 mono_mb_emit_byte (mb, CEE_CONV_U);
1177 pos = mono_mb_emit_short_branch (mb, CEE_BLE_UN_S);
1179 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1180 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1181 mono_mb_emit_ldarg (mb, 1);
1182 mono_mb_emit_icon (mb, 0);
1183 pos_error = mono_mb_emit_short_branch (mb, CEE_BLT_S);
1184 mono_mb_emit_exception (mb, "OutOfMemoryException", NULL);
1185 mono_mb_patch_short_branch (mb, pos_error);
1186 mono_mb_emit_exception (mb, "OverflowException", NULL);
1188 mono_mb_patch_short_branch (mb, pos);
1190 clause = (MonoExceptionClause *)mono_image_alloc0 (mono_defaults.corlib, sizeof (MonoExceptionClause));
1191 clause->try_offset = mono_mb_get_label (mb);
1193 /* vtable->klass->sizes.element_size */
1194 mono_mb_emit_ldarg (mb, 0);
1195 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoVTable, klass));
1196 mono_mb_emit_byte (mb, CEE_ADD);
1197 mono_mb_emit_byte (mb, CEE_LDIND_I);
1198 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoClass, sizes));
1199 mono_mb_emit_byte (mb, CEE_ADD);
1200 mono_mb_emit_byte (mb, CEE_LDIND_U4);
1201 mono_mb_emit_byte (mb, CEE_CONV_I);
1204 mono_mb_emit_ldarg (mb, 1);
1205 mono_mb_emit_byte (mb, CEE_MUL_OVF_UN);
1206 /* + sizeof (MonoArray) */
1207 mono_mb_emit_icon (mb, MONO_SIZEOF_MONO_ARRAY);
1208 mono_mb_emit_byte (mb, CEE_ADD_OVF_UN);
1209 mono_mb_emit_stloc (mb, size_var);
1211 pos_leave = mono_mb_emit_branch (mb, CEE_LEAVE);
1214 clause->flags = MONO_EXCEPTION_CLAUSE_NONE;
1215 clause->try_len = mono_mb_get_pos (mb) - clause->try_offset;
1216 clause->data.catch_class = mono_class_load_from_name (mono_defaults.corlib,
1217 "System", "OverflowException");
1218 clause->handler_offset = mono_mb_get_label (mb);
1220 oom_exc_class = mono_class_load_from_name (mono_defaults.corlib,
1221 "System", "OutOfMemoryException");
1222 ctor = mono_class_get_method_from_name (oom_exc_class, ".ctor", 0);
1225 mono_mb_emit_byte (mb, CEE_POP);
1226 mono_mb_emit_op (mb, CEE_NEWOBJ, ctor);
1227 mono_mb_emit_byte (mb, CEE_THROW);
1229 clause->handler_len = mono_mb_get_pos (mb) - clause->handler_offset;
1230 mono_mb_set_clauses (mb, 1, clause);
1231 mono_mb_patch_branch (mb, pos_leave);
1233 } else if (atype == ATYPE_STRING) {
1237 * a string allocator method takes the args: (vtable, len)
1239 * bytes = offsetof (MonoString, chars) + ((len + 1) * 2)
1243 * bytes <= INT32_MAX - (SGEN_ALLOC_ALIGN - 1)
1247 * offsetof (MonoString, chars) + ((len + 1) * 2) <= INT32_MAX - (SGEN_ALLOC_ALIGN - 1)
1248 * len <= (INT32_MAX - (SGEN_ALLOC_ALIGN - 1) - offsetof (MonoString, chars)) / 2 - 1
1250 mono_mb_emit_ldarg (mb, 1);
1251 mono_mb_emit_icon (mb, (INT32_MAX - (SGEN_ALLOC_ALIGN - 1) - MONO_STRUCT_OFFSET (MonoString, chars)) / 2 - 1);
1252 pos = mono_mb_emit_short_branch (mb, MONO_CEE_BLE_UN_S);
1254 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1255 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1256 mono_mb_emit_exception (mb, "OutOfMemoryException", NULL);
1257 mono_mb_patch_short_branch (mb, pos);
1259 mono_mb_emit_ldarg (mb, 1);
1260 mono_mb_emit_icon (mb, 1);
1261 mono_mb_emit_byte (mb, MONO_CEE_SHL);
1262 //WE manually fold the above + 2 here
1263 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoString, chars) + 2);
1264 mono_mb_emit_byte (mb, CEE_ADD);
1265 mono_mb_emit_stloc (mb, size_var);
1267 g_assert_not_reached ();
1270 #ifdef MANAGED_ALLOCATOR_CAN_USE_CRITICAL_REGION
1271 EMIT_TLS_ACCESS_IN_CRITICAL_REGION_ADDR (mb, thread_var);
1272 mono_mb_emit_byte (mb, CEE_LDC_I4_1);
1273 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1274 mono_mb_emit_byte (mb, CEE_MONO_ATOMIC_STORE_I4);
1275 mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_NONE);
1278 /* size += ALLOC_ALIGN - 1; */
1279 mono_mb_emit_ldloc (mb, size_var);
1280 mono_mb_emit_icon (mb, SGEN_ALLOC_ALIGN - 1);
1281 mono_mb_emit_byte (mb, CEE_ADD);
1282 /* size &= ~(ALLOC_ALIGN - 1); */
1283 mono_mb_emit_icon (mb, ~(SGEN_ALLOC_ALIGN - 1));
1284 mono_mb_emit_byte (mb, CEE_AND);
1285 mono_mb_emit_stloc (mb, size_var);
1287 /* if (size > MAX_SMALL_OBJ_SIZE) goto slowpath */
1288 if (atype != ATYPE_SMALL) {
1289 mono_mb_emit_ldloc (mb, size_var);
1290 mono_mb_emit_icon (mb, SGEN_MAX_SMALL_OBJ_SIZE);
1291 max_size_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BGT_UN_S);
1295 * We need to modify tlab_next, but the JIT only supports reading, so we read
1296 * another tls var holding its address instead.
1299 /* tlab_next_addr (local) = tlab_next_addr (TLS var) */
1300 tlab_next_addr_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1301 EMIT_TLS_ACCESS_NEXT_ADDR (mb, thread_var);
1302 mono_mb_emit_stloc (mb, tlab_next_addr_var);
1304 /* p = (void**)tlab_next; */
1305 p_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1306 mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1307 mono_mb_emit_byte (mb, CEE_LDIND_I);
1308 mono_mb_emit_stloc (mb, p_var);
1310 /* new_next = (char*)p + size; */
1311 new_next_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1312 mono_mb_emit_ldloc (mb, p_var);
1313 mono_mb_emit_ldloc (mb, size_var);
1314 mono_mb_emit_byte (mb, CEE_CONV_I);
1315 mono_mb_emit_byte (mb, CEE_ADD);
1316 mono_mb_emit_stloc (mb, new_next_var);
1318 /* if (G_LIKELY (new_next < tlab_temp_end)) */
1319 mono_mb_emit_ldloc (mb, new_next_var);
1320 EMIT_TLS_ACCESS_TEMP_END (mb, thread_var);
1321 slowpath_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLT_UN_S);
1324 if (atype != ATYPE_SMALL)
1325 mono_mb_patch_short_branch (mb, max_size_branch);
1327 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1328 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1330 * We are no longer in a critical section. We need to do this before calling
1331 * to unmanaged land in order to avoid stw deadlocks since unmanaged code
1334 #ifdef MANAGED_ALLOCATOR_CAN_USE_CRITICAL_REGION
1335 EMIT_TLS_ACCESS_IN_CRITICAL_REGION_ADDR (mb, thread_var);
1336 mono_mb_emit_byte (mb, CEE_LDC_I4_0);
1337 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1338 mono_mb_emit_byte (mb, CEE_MONO_ATOMIC_STORE_I4);
1339 mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_NONE);
1342 /* FIXME: mono_gc_alloc_obj takes a 'size_t' as an argument, not an int32 */
1343 mono_mb_emit_ldarg (mb, 0);
1344 mono_mb_emit_ldloc (mb, size_var);
1345 if (atype == ATYPE_NORMAL || atype == ATYPE_SMALL) {
1346 mono_mb_emit_icall (mb, mono_gc_alloc_obj);
1347 } else if (atype == ATYPE_VECTOR) {
1348 mono_mb_emit_ldarg (mb, 1);
1349 mono_mb_emit_icall (mb, mono_gc_alloc_vector);
1350 } else if (atype == ATYPE_STRING) {
1351 mono_mb_emit_ldarg (mb, 1);
1352 mono_mb_emit_icall (mb, mono_gc_alloc_string);
1354 g_assert_not_reached ();
1356 mono_mb_emit_byte (mb, CEE_RET);
1359 mono_mb_patch_short_branch (mb, slowpath_branch);
1361 /* FIXME: Memory barrier */
1363 /* tlab_next = new_next */
1364 mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1365 mono_mb_emit_ldloc (mb, new_next_var);
1366 mono_mb_emit_byte (mb, CEE_STIND_I);
1369 mono_mb_emit_ldloc (mb, p_var);
1370 mono_mb_emit_ldarg (mb, 0);
1371 mono_mb_emit_byte (mb, CEE_STIND_I);
1373 if (atype == ATYPE_VECTOR) {
1374 /* arr->max_length = max_length; */
1375 mono_mb_emit_ldloc (mb, p_var);
1376 mono_mb_emit_ldflda (mb, MONO_STRUCT_OFFSET (MonoArray, max_length));
1377 mono_mb_emit_ldarg (mb, 1);
1378 #ifdef MONO_BIG_ARRAYS
1379 mono_mb_emit_byte (mb, CEE_STIND_I);
1381 mono_mb_emit_byte (mb, CEE_STIND_I4);
1383 } else if (atype == ATYPE_STRING) {
1384 /* need to set length and clear the last char */
1385 /* s->length = len; */
1386 mono_mb_emit_ldloc (mb, p_var);
1387 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoString, length));
1388 mono_mb_emit_byte (mb, MONO_CEE_ADD);
1389 mono_mb_emit_ldarg (mb, 1);
1390 mono_mb_emit_byte (mb, MONO_CEE_STIND_I4);
1393 #ifdef MANAGED_ALLOCATOR_CAN_USE_CRITICAL_REGION
1394 EMIT_TLS_ACCESS_IN_CRITICAL_REGION_ADDR (mb, thread_var);
1395 mono_mb_emit_byte (mb, CEE_LDC_I4_0);
1396 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1397 mono_mb_emit_byte (mb, CEE_MONO_ATOMIC_STORE_I4);
1399 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1400 mono_mb_emit_byte (mb, CEE_MONO_MEMORY_BARRIER);
1403 We must make sure both vtable and max_length are globaly visible before returning to managed land.
1405 mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_REL);
1408 mono_mb_emit_ldloc (mb, p_var);
1411 mono_mb_emit_byte (mb, CEE_RET);
1414 info = mono_wrapper_info_create (mb, WRAPPER_SUBTYPE_NONE);
1415 info->d.alloc.gc_name = "sgen";
1416 info->d.alloc.alloc_type = atype;
1419 mb->init_locals = FALSE;
1422 res = mono_mb_create (mb, csig, 8, info);
1431 mono_gc_get_aligned_size_for_allocator (int size)
1433 return SGEN_ALIGN_UP (size);
1437 * Generate an allocator method implementing the fast path of mono_gc_alloc_obj ().
1438 * The signature of the called method is:
1439 * object allocate (MonoVTable *vtable)
1442 mono_gc_get_managed_allocator (MonoClass *klass, gboolean for_box, gboolean known_instance_size)
1444 #ifdef MANAGED_ALLOCATION
1445 if (collect_before_allocs)
1447 if (!mono_runtime_has_tls_get ())
1449 if (klass->instance_size > tlab_size)
1451 if (known_instance_size && ALIGN_TO (klass->instance_size, SGEN_ALLOC_ALIGN) >= SGEN_MAX_SMALL_OBJ_SIZE)
1453 if (mono_class_has_finalizer (klass) || mono_class_is_marshalbyref (klass))
1457 if (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS)
1459 if (klass->byval_arg.type == MONO_TYPE_STRING)
1460 return mono_gc_get_managed_allocator_by_type (ATYPE_STRING, MANAGED_ALLOCATOR_REGULAR);
1461 /* Generic classes have dynamic field and can go above MAX_SMALL_OBJ_SIZE. */
1462 if (known_instance_size)
1463 return mono_gc_get_managed_allocator_by_type (ATYPE_SMALL, MANAGED_ALLOCATOR_REGULAR);
1465 return mono_gc_get_managed_allocator_by_type (ATYPE_NORMAL, MANAGED_ALLOCATOR_REGULAR);
1472 mono_gc_get_managed_array_allocator (MonoClass *klass)
1474 #ifdef MANAGED_ALLOCATION
1475 if (klass->rank != 1)
1477 if (!mono_runtime_has_tls_get ())
1479 if (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS)
1481 if (has_per_allocation_action)
1483 g_assert (!mono_class_has_finalizer (klass) && !mono_class_is_marshalbyref (klass));
1485 return mono_gc_get_managed_allocator_by_type (ATYPE_VECTOR, MANAGED_ALLOCATOR_REGULAR);
1492 sgen_set_use_managed_allocator (gboolean flag)
1494 use_managed_allocator = flag;
1498 mono_gc_get_managed_allocator_by_type (int atype, ManagedAllocatorVariant variant)
1500 #ifdef MANAGED_ALLOCATION
1504 if (!use_managed_allocator)
1507 if (!mono_runtime_has_tls_get ())
1511 case MANAGED_ALLOCATOR_REGULAR: cache = alloc_method_cache; break;
1512 case MANAGED_ALLOCATOR_SLOW_PATH: cache = slowpath_alloc_method_cache; break;
1513 default: g_assert_not_reached (); break;
1516 res = cache [atype];
1520 res = create_allocator (atype, variant);
1522 if (cache [atype]) {
1523 mono_free_method (res);
1524 res = cache [atype];
1526 mono_memory_barrier ();
1527 cache [atype] = res;
1538 mono_gc_get_managed_allocator_types (void)
1544 sgen_is_managed_allocator (MonoMethod *method)
1548 for (i = 0; i < ATYPE_NUM; ++i)
1549 if (method == alloc_method_cache [i] || method == slowpath_alloc_method_cache [i])
1555 sgen_has_managed_allocator (void)
1559 for (i = 0; i < ATYPE_NUM; ++i)
1560 if (alloc_method_cache [i] || slowpath_alloc_method_cache [i])
1566 * Cardtable scanning
1569 #define MWORD_MASK (sizeof (mword) - 1)
1572 find_card_offset (mword card)
1574 /*XXX Use assembly as this generates some pretty bad code */
1575 #if defined(__i386__) && defined(__GNUC__)
1576 return (__builtin_ffs (card) - 1) / 8;
1577 #elif defined(__x86_64__) && defined(__GNUC__)
1578 return (__builtin_ffsll (card) - 1) / 8;
1579 #elif defined(__s390x__)
1580 return (__builtin_ffsll (GUINT64_TO_LE(card)) - 1) / 8;
1583 guint8 *ptr = (guint8 *) &card;
1584 for (i = 0; i < sizeof (mword); ++i) {
1593 find_next_card (guint8 *card_data, guint8 *end)
1595 mword *cards, *cards_end;
1598 while ((((mword)card_data) & MWORD_MASK) && card_data < end) {
1604 if (card_data == end)
1607 cards = (mword*)card_data;
1608 cards_end = (mword*)((mword)end & ~MWORD_MASK);
1609 while (cards < cards_end) {
1612 return (guint8*)cards + find_card_offset (card);
1616 card_data = (guint8*)cards_end;
1617 while (card_data < end) {
1626 #define ARRAY_OBJ_INDEX(ptr,array,elem_size) (((char*)(ptr) - ((char*)(array) + G_STRUCT_OFFSET (MonoArray, vector))) / (elem_size))
1629 sgen_client_cardtable_scan_object (GCObject *obj, mword block_obj_size, guint8 *cards, ScanCopyContext ctx)
1631 MonoVTable *vt = SGEN_LOAD_VTABLE (obj);
1632 MonoClass *klass = vt->klass;
1634 SGEN_ASSERT (0, SGEN_VTABLE_HAS_REFERENCES (vt), "Why would we ever call this on reference-free objects?");
1637 MonoArray *arr = (MonoArray*)obj;
1638 guint8 *card_data, *card_base;
1639 guint8 *card_data_end;
1640 char *obj_start = (char *)sgen_card_table_align_pointer (obj);
1642 mword obj_size = sgen_mono_array_size (vt, arr, &bounds_size, sgen_vtable_get_descriptor (vt));
1643 /* We don't want to scan the bounds entries at the end of multidimensional arrays */
1644 char *obj_end = (char*)obj + obj_size - bounds_size;
1646 size_t extra_idx = 0;
1648 mword desc = (mword)klass->element_class->gc_descr;
1649 int elem_size = mono_array_element_size (klass);
1651 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1652 guint8 *overflow_scan_end = NULL;
1655 #ifdef SGEN_OBJECT_LAYOUT_STATISTICS
1656 if (klass->element_class->valuetype)
1657 sgen_object_layout_scanned_vtype_array ();
1659 sgen_object_layout_scanned_ref_array ();
1665 card_data = sgen_card_table_get_card_scan_address ((mword)obj);
1667 card_base = card_data;
1668 card_count = sgen_card_table_number_of_cards_in_range ((mword)obj, obj_size);
1669 card_data_end = card_data + card_count;
1672 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1673 /*Check for overflow and if so, setup to scan in two steps*/
1674 if (!cards && card_data_end >= SGEN_SHADOW_CARDTABLE_END) {
1675 overflow_scan_end = sgen_shadow_cardtable + (card_data_end - SGEN_SHADOW_CARDTABLE_END);
1676 card_data_end = SGEN_SHADOW_CARDTABLE_END;
1682 card_data = find_next_card (card_data, card_data_end);
1683 for (; card_data < card_data_end; card_data = find_next_card (card_data + 1, card_data_end)) {
1685 size_t idx = (card_data - card_base) + extra_idx;
1686 char *start = (char*)(obj_start + idx * CARD_SIZE_IN_BYTES);
1687 char *card_end = start + CARD_SIZE_IN_BYTES;
1688 char *first_elem, *elem;
1690 HEAVY_STAT (++los_marked_cards);
1693 sgen_card_table_prepare_card_for_scanning (card_data);
1695 card_end = MIN (card_end, obj_end);
1697 if (start <= (char*)arr->vector)
1700 index = ARRAY_OBJ_INDEX (start, obj, elem_size);
1702 elem = first_elem = (char*)mono_array_addr_with_size_fast ((MonoArray*)obj, elem_size, index);
1703 if (klass->element_class->valuetype) {
1704 ScanVTypeFunc scan_vtype_func = ctx.ops->scan_vtype;
1706 for (; elem < card_end; elem += elem_size)
1707 scan_vtype_func (obj, elem, desc, ctx.queue BINARY_PROTOCOL_ARG (elem_size));
1709 ScanPtrFieldFunc scan_ptr_field_func = ctx.ops->scan_ptr_field;
1711 HEAVY_STAT (++los_array_cards);
1712 for (; elem < card_end; elem += SIZEOF_VOID_P)
1713 scan_ptr_field_func (obj, (GCObject**)elem, ctx.queue);
1716 binary_protocol_card_scan (first_elem, elem - first_elem);
1719 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1720 if (overflow_scan_end) {
1721 extra_idx = card_data - card_base;
1722 card_base = card_data = sgen_shadow_cardtable;
1723 card_data_end = overflow_scan_end;
1724 overflow_scan_end = NULL;
1735 * Array and string allocation
1739 mono_gc_alloc_vector (MonoVTable *vtable, size_t size, uintptr_t max_length)
1744 if (!SGEN_CAN_ALIGN_UP (size))
1747 #ifndef DISABLE_CRITICAL_REGION
1748 ENTER_CRITICAL_REGION;
1749 arr = (MonoArray*)sgen_try_alloc_obj_nolock (vtable, size);
1751 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1752 arr->max_length = (mono_array_size_t)max_length;
1753 EXIT_CRITICAL_REGION;
1756 EXIT_CRITICAL_REGION;
1761 arr = (MonoArray*)sgen_alloc_obj_nolock (vtable, size);
1762 if (G_UNLIKELY (!arr)) {
1767 arr->max_length = (mono_array_size_t)max_length;
1772 if (G_UNLIKELY (alloc_events))
1773 mono_profiler_allocation (&arr->obj);
1775 SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size (vtable, (GCObject*)arr)), "Vector has incorrect size.");
1780 mono_gc_alloc_array (MonoVTable *vtable, size_t size, uintptr_t max_length, uintptr_t bounds_size)
1783 MonoArrayBounds *bounds;
1786 if (!SGEN_CAN_ALIGN_UP (size))
1789 #ifndef DISABLE_CRITICAL_REGION
1790 ENTER_CRITICAL_REGION;
1791 arr = (MonoArray*)sgen_try_alloc_obj_nolock (vtable, size);
1793 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1794 arr->max_length = (mono_array_size_t)max_length;
1796 bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1797 arr->bounds = bounds;
1798 EXIT_CRITICAL_REGION;
1801 EXIT_CRITICAL_REGION;
1806 arr = (MonoArray*)sgen_alloc_obj_nolock (vtable, size);
1807 if (G_UNLIKELY (!arr)) {
1812 arr->max_length = (mono_array_size_t)max_length;
1814 bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1815 arr->bounds = bounds;
1820 if (G_UNLIKELY (alloc_events))
1821 mono_profiler_allocation (&arr->obj);
1823 SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size (vtable, (GCObject*)arr)), "Array has incorrect size.");
1828 mono_gc_alloc_string (MonoVTable *vtable, size_t size, gint32 len)
1833 if (!SGEN_CAN_ALIGN_UP (size))
1836 #ifndef DISABLE_CRITICAL_REGION
1837 ENTER_CRITICAL_REGION;
1838 str = (MonoString*)sgen_try_alloc_obj_nolock (vtable, size);
1840 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1842 EXIT_CRITICAL_REGION;
1845 EXIT_CRITICAL_REGION;
1850 str = (MonoString*)sgen_alloc_obj_nolock (vtable, size);
1851 if (G_UNLIKELY (!str)) {
1861 if (G_UNLIKELY (alloc_events))
1862 mono_profiler_allocation (&str->object);
1872 mono_gc_set_string_length (MonoString *str, gint32 new_length)
1874 mono_unichar2 *new_end = str->chars + new_length;
1876 /* zero the discarded string. This null-delimits the string and allows
1877 * the space to be reclaimed by SGen. */
1879 if (nursery_canaries_enabled () && sgen_ptr_in_nursery (str)) {
1880 CHECK_CANARY_FOR_OBJECT ((GCObject*)str, TRUE);
1881 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2) + CANARY_SIZE);
1882 memcpy (new_end + 1 , CANARY_STRING, CANARY_SIZE);
1884 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2));
1887 str->length = new_length;
1894 #define GC_ROOT_NUM 32
1896 int count; /* must be the first field */
1897 void *objects [GC_ROOT_NUM];
1898 int root_types [GC_ROOT_NUM];
1899 uintptr_t extra_info [GC_ROOT_NUM];
1903 notify_gc_roots (GCRootReport *report)
1907 mono_profiler_gc_roots (report->count, report->objects, report->root_types, report->extra_info);
1912 add_profile_gc_root (GCRootReport *report, void *object, int rtype, uintptr_t extra_info)
1914 if (report->count == GC_ROOT_NUM)
1915 notify_gc_roots (report);
1916 report->objects [report->count] = object;
1917 report->root_types [report->count] = rtype;
1918 report->extra_info [report->count++] = (uintptr_t)SGEN_LOAD_VTABLE (object)->klass;
1922 sgen_client_nursery_objects_pinned (void **definitely_pinned, int count)
1924 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS) {
1925 GCRootReport report;
1928 for (idx = 0; idx < count; ++idx)
1929 add_profile_gc_root (&report, definitely_pinned [idx], MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
1930 notify_gc_roots (&report);
1935 report_finalizer_roots_from_queue (SgenPointerQueue *queue)
1937 GCRootReport report;
1941 for (i = 0; i < queue->next_slot; ++i) {
1942 void *obj = queue->data [i];
1945 add_profile_gc_root (&report, obj, MONO_PROFILE_GC_ROOT_FINALIZER, 0);
1947 notify_gc_roots (&report);
1951 report_finalizer_roots (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
1953 report_finalizer_roots_from_queue (fin_ready_queue);
1954 report_finalizer_roots_from_queue (critical_fin_queue);
1957 static GCRootReport *root_report;
1960 single_arg_report_root (MonoObject **obj, void *gc_data)
1963 add_profile_gc_root (root_report, *obj, MONO_PROFILE_GC_ROOT_OTHER, 0);
1967 precisely_report_roots_from (GCRootReport *report, void** start_root, void** end_root, mword desc)
1969 switch (desc & ROOT_DESC_TYPE_MASK) {
1970 case ROOT_DESC_BITMAP:
1971 desc >>= ROOT_DESC_TYPE_SHIFT;
1973 if ((desc & 1) && *start_root) {
1974 add_profile_gc_root (report, *start_root, MONO_PROFILE_GC_ROOT_OTHER, 0);
1980 case ROOT_DESC_COMPLEX: {
1981 gsize *bitmap_data = (gsize *)sgen_get_complex_descriptor_bitmap (desc);
1982 gsize bwords = (*bitmap_data) - 1;
1983 void **start_run = start_root;
1985 while (bwords-- > 0) {
1986 gsize bmap = *bitmap_data++;
1987 void **objptr = start_run;
1989 if ((bmap & 1) && *objptr) {
1990 add_profile_gc_root (report, *objptr, MONO_PROFILE_GC_ROOT_OTHER, 0);
1995 start_run += GC_BITS_PER_WORD;
1999 case ROOT_DESC_USER: {
2000 MonoGCRootMarkFunc marker = (MonoGCRootMarkFunc)sgen_get_user_descriptor_func (desc);
2001 root_report = report;
2002 marker ((MonoObject**)start_root, single_arg_report_root, NULL);
2005 case ROOT_DESC_RUN_LEN:
2006 g_assert_not_reached ();
2008 g_assert_not_reached ();
2013 report_registered_roots_by_type (int root_type)
2015 GCRootReport report;
2019 SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], void **, start_root, RootRecord *, root) {
2020 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
2021 precisely_report_roots_from (&report, start_root, (void**)root->end_root, root->root_desc);
2022 } SGEN_HASH_TABLE_FOREACH_END;
2023 notify_gc_roots (&report);
2027 report_registered_roots (void)
2029 report_registered_roots_by_type (ROOT_TYPE_NORMAL);
2030 report_registered_roots_by_type (ROOT_TYPE_WBARRIER);
2034 sgen_client_collecting_minor (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
2036 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2037 report_registered_roots ();
2038 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2039 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
2042 static GCRootReport major_root_report;
2043 static gboolean profile_roots;
2046 sgen_client_collecting_major_1 (void)
2048 profile_roots = mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS;
2049 memset (&major_root_report, 0, sizeof (GCRootReport));
2053 sgen_client_pinned_los_object (GCObject *obj)
2056 add_profile_gc_root (&major_root_report, (char*)obj, MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
2060 sgen_client_collecting_major_2 (void)
2063 notify_gc_roots (&major_root_report);
2065 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2066 report_registered_roots ();
2070 sgen_client_collecting_major_3 (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
2072 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2073 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
2076 #define MOVED_OBJECTS_NUM 64
2077 static void *moved_objects [MOVED_OBJECTS_NUM];
2078 static int moved_objects_idx = 0;
2081 mono_sgen_register_moved_object (void *obj, void *destination)
2083 g_assert (mono_profiler_events & MONO_PROFILE_GC_MOVES);
2085 if (moved_objects_idx == MOVED_OBJECTS_NUM) {
2086 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2087 moved_objects_idx = 0;
2089 moved_objects [moved_objects_idx++] = obj;
2090 moved_objects [moved_objects_idx++] = destination;
2094 mono_sgen_gc_event_moves (void)
2096 if (moved_objects_idx) {
2097 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2098 moved_objects_idx = 0;
2106 #define REFS_SIZE 128
2109 MonoGCReferences callback;
2113 MonoObject *refs [REFS_SIZE];
2114 uintptr_t offsets [REFS_SIZE];
2118 #define HANDLE_PTR(ptr,obj) do { \
2120 if (hwi->count == REFS_SIZE) { \
2121 hwi->callback ((MonoObject*)start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data); \
2125 hwi->offsets [hwi->count] = (char*)(ptr)-(char*)start; \
2126 hwi->refs [hwi->count++] = *(ptr); \
2131 collect_references (HeapWalkInfo *hwi, GCObject *obj, size_t size)
2133 char *start = (char*)obj;
2134 mword desc = sgen_obj_get_descriptor (obj);
2136 #include "sgen/sgen-scan-object.h"
2140 walk_references (GCObject *start, size_t size, void *data)
2142 HeapWalkInfo *hwi = (HeapWalkInfo *)data;
2145 collect_references (hwi, start, size);
2146 if (hwi->count || !hwi->called)
2147 hwi->callback (start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);
2151 * mono_gc_walk_heap:
2152 * @flags: flags for future use
2153 * @callback: a function pointer called for each object in the heap
2154 * @data: a user data pointer that is passed to callback
2156 * This function can be used to iterate over all the live objects in the heap:
2157 * for each object, @callback is invoked, providing info about the object's
2158 * location in memory, its class, its size and the objects it references.
2159 * For each referenced object it's offset from the object address is
2160 * reported in the offsets array.
2161 * The object references may be buffered, so the callback may be invoked
2162 * multiple times for the same object: in all but the first call, the size
2163 * argument will be zero.
2164 * Note that this function can be only called in the #MONO_GC_EVENT_PRE_START_WORLD
2165 * profiler event handler.
2167 * Returns: a non-zero value if the GC doesn't support heap walking
2170 mono_gc_walk_heap (int flags, MonoGCReferences callback, void *data)
2175 hwi.callback = callback;
2178 sgen_clear_nursery_fragments ();
2179 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data, walk_references, &hwi, FALSE, TRUE);
2181 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, walk_references, &hwi);
2182 sgen_los_iterate_objects (walk_references, &hwi);
2192 mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks)
2194 gc_callbacks = *callbacks;
2198 mono_gc_get_gc_callbacks ()
2200 return &gc_callbacks;
2204 sgen_client_thread_register (SgenThreadInfo* info, void *stack_bottom_fallback)
2207 guint8 *staddr = NULL;
2209 #ifndef HAVE_KW_THREAD
2210 g_assert (!mono_native_tls_get_value (thread_info_key));
2211 mono_native_tls_set_value (thread_info_key, info);
2213 sgen_thread_info = info;
2216 info->client_info.skip = 0;
2217 info->client_info.stopped_ip = NULL;
2218 info->client_info.stopped_domain = NULL;
2220 info->client_info.stack_start = NULL;
2222 #ifdef SGEN_POSIX_STW
2223 info->client_info.stop_count = -1;
2224 info->client_info.signal = 0;
2227 /* On win32, stack_start_limit should be 0, since the stack can grow dynamically */
2228 mono_thread_info_get_stack_bounds (&staddr, &stsize);
2231 info->client_info.stack_start_limit = staddr;
2233 info->client_info.stack_end = staddr + stsize;
2235 gsize stack_bottom = (gsize)stack_bottom_fallback;
2236 stack_bottom += 4095;
2237 stack_bottom &= ~4095;
2238 info->client_info.stack_end = (char*)stack_bottom;
2241 memset (&info->client_info.ctx, 0, sizeof (MonoContext));
2243 if (mono_gc_get_gc_callbacks ()->thread_attach_func)
2244 info->client_info.runtime_data = mono_gc_get_gc_callbacks ()->thread_attach_func ();
2246 binary_protocol_thread_register ((gpointer)mono_thread_info_get_tid (info));
2248 SGEN_LOG (3, "registered thread %p (%p) stack end %p", info, (gpointer)mono_thread_info_get_tid (info), info->client_info.stack_end);
2250 info->client_info.info.handle_stack = mono_handle_stack_alloc ();
2254 sgen_client_thread_unregister (SgenThreadInfo *p)
2256 MonoNativeThreadId tid;
2258 #ifndef HAVE_KW_THREAD
2259 mono_native_tls_set_value (thread_info_key, NULL);
2261 sgen_thread_info = NULL;
2264 tid = mono_thread_info_get_tid (p);
2266 if (p->client_info.info.runtime_thread)
2267 mono_threads_add_joinable_thread ((gpointer)tid);
2269 if (mono_gc_get_gc_callbacks ()->thread_detach_func) {
2270 mono_gc_get_gc_callbacks ()->thread_detach_func (p->client_info.runtime_data);
2271 p->client_info.runtime_data = NULL;
2274 binary_protocol_thread_unregister ((gpointer)tid);
2275 SGEN_LOG (3, "unregister thread %p (%p)", p, (gpointer)tid);
2277 HandleStack *handles = (HandleStack*) p->client_info.info.handle_stack;
2278 p->client_info.info.handle_stack = NULL;
2279 mono_handle_stack_free (handles);
2283 mono_gc_set_skip_thread (gboolean skip)
2285 SgenThreadInfo *info = mono_thread_info_current ();
2288 info->client_info.gc_disabled = skip;
2293 is_critical_method (MonoMethod *method)
2295 return mono_runtime_is_critical_method (method) || sgen_is_critical_method (method);
2299 thread_in_critical_region (SgenThreadInfo *info)
2301 return info->client_info.in_critical_region;
2305 sgen_thread_attach (SgenThreadInfo *info)
2307 if (mono_gc_get_gc_callbacks ()->thread_attach_func && !info->client_info.runtime_data)
2308 info->client_info.runtime_data = mono_gc_get_gc_callbacks ()->thread_attach_func ();
2312 sgen_thread_detach (SgenThreadInfo *p)
2314 /* If a delegate is passed to native code and invoked on a thread we dont
2315 * know about, marshal will register it with mono_threads_attach_coop, but
2316 * we have no way of knowing when that thread goes away. SGen has a TSD
2317 * so we assume that if the domain is still registered, we can detach
2320 if (mono_domain_get ())
2321 mono_thread_detach_internal (mono_thread_internal_current ());
2325 mono_gc_register_thread (void *baseptr)
2327 return mono_thread_info_attach (baseptr) != NULL;
2331 mono_gc_is_gc_thread (void)
2335 result = mono_thread_info_current () != NULL;
2341 sgen_client_thread_register_worker (void)
2343 mono_thread_info_register_small_id ();
2344 mono_native_thread_set_name (mono_native_thread_id_get (), "SGen worker");
2347 /* Variables holding start/end nursery so it won't have to be passed at every call */
2348 static void *scan_area_arg_start, *scan_area_arg_end;
2351 mono_gc_conservatively_scan_area (void *start, void *end)
2353 sgen_conservatively_pin_objects_from ((void **)start, (void **)end, scan_area_arg_start, scan_area_arg_end, PIN_TYPE_STACK);
2357 mono_gc_scan_object (void *obj, void *gc_data)
2359 ScanCopyContext *ctx = (ScanCopyContext *)gc_data;
2360 ctx->ops->copy_or_mark_object ((GCObject**)&obj, ctx->queue);
2365 * Mark from thread stacks and registers.
2368 sgen_client_scan_thread_data (void *start_nursery, void *end_nursery, gboolean precise, ScanCopyContext ctx)
2370 scan_area_arg_start = start_nursery;
2371 scan_area_arg_end = end_nursery;
2373 FOREACH_THREAD (info) {
2374 int skip_reason = 0;
2375 void *aligned_stack_start;
2377 if (info->client_info.skip) {
2378 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);
2380 } else if (info->client_info.gc_disabled) {
2381 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);
2383 } else if (!mono_thread_info_is_live (info)) {
2384 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);
2386 } else if (!info->client_info.stack_start) {
2387 SGEN_LOG (3, "Skipping starting or detaching thread %p", info);
2391 binary_protocol_scan_stack ((gpointer)mono_thread_info_get_tid (info), info->client_info.stack_start, info->client_info.stack_end, skip_reason);
2396 g_assert (info->client_info.stack_start);
2397 g_assert (info->client_info.stack_end);
2399 aligned_stack_start = (void*)(mword) ALIGN_TO ((mword)info->client_info.stack_start, SIZEOF_VOID_P);
2401 g_assert (info->client_info.suspend_done);
2402 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 ());
2403 if (mono_gc_get_gc_callbacks ()->thread_mark_func && !conservative_stack_mark) {
2404 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);
2405 } else if (!precise) {
2406 if (!conservative_stack_mark) {
2407 fprintf (stderr, "Precise stack mark not supported - disabling.\n");
2408 conservative_stack_mark = TRUE;
2410 //FIXME we should eventually use the new stack_mark from coop
2411 sgen_conservatively_pin_objects_from ((void **)aligned_stack_start, (void **)info->client_info.stack_end, start_nursery, end_nursery, PIN_TYPE_STACK);
2415 sgen_conservatively_pin_objects_from ((void**)&info->client_info.ctx, (void**)(&info->client_info.ctx + 1),
2416 start_nursery, end_nursery, PIN_TYPE_STACK);
2419 // This is used on Coop GC for platforms where we cannot get the data for individual registers.
2420 // We force a spill of all registers into the stack and pass a chunk of data into sgen.
2421 //FIXME under coop, for now, what we need to ensure is that we scan any extra memory from info->client_info.stack_end to stack_mark
2422 MonoThreadUnwindState *state = &info->client_info.info.thread_saved_state [SELF_SUSPEND_STATE_INDEX];
2423 if (state && state->gc_stackdata) {
2424 sgen_conservatively_pin_objects_from ((void **)state->gc_stackdata, (void**)((char*)state->gc_stackdata + state->gc_stackdata_size),
2425 start_nursery, end_nursery, PIN_TYPE_STACK);
2429 if (precise && info->client_info.info.handle_stack) {
2430 mono_handle_stack_scan ((HandleStack*)info->client_info.info.handle_stack, (GcScanFunc)ctx.ops->copy_or_mark_object, ctx.queue);
2432 } FOREACH_THREAD_END
2436 * mono_gc_set_stack_end:
2438 * Set the end of the current threads stack to STACK_END. The stack space between
2439 * STACK_END and the real end of the threads stack will not be scanned during collections.
2442 mono_gc_set_stack_end (void *stack_end)
2444 SgenThreadInfo *info;
2447 info = mono_thread_info_current ();
2449 SGEN_ASSERT (0, stack_end < info->client_info.stack_end, "Can only lower stack end");
2450 info->client_info.stack_end = stack_end;
2460 mono_gc_register_root (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
2462 return sgen_register_root (start, size, descr, descr ? ROOT_TYPE_NORMAL : ROOT_TYPE_PINNED, source, msg);
2466 mono_gc_register_root_wbarrier (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
2468 return sgen_register_root (start, size, descr, ROOT_TYPE_WBARRIER, source, msg);
2472 mono_gc_deregister_root (char* addr)
2474 sgen_deregister_root (addr);
2483 mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
2485 return pthread_create (new_thread, attr, start_routine, arg);
2494 sgen_client_total_allocated_heap_changed (size_t allocated_heap)
2496 mono_runtime_resource_check_limit (MONO_RESOURCE_GC_HEAP, allocated_heap);
2500 mono_gc_user_markers_supported (void)
2506 mono_object_is_alive (MonoObject* o)
2512 mono_gc_get_generation (MonoObject *obj)
2514 if (sgen_ptr_in_nursery (obj))
2520 mono_gc_enable_events (void)
2525 mono_gc_get_gc_name (void)
2531 mono_gc_get_description (void)
2533 #ifdef HAVE_CONC_GC_AS_DEFAULT
2534 return g_strdup ("sgen (concurrent by default)");
2536 return g_strdup ("sgen");
2541 mono_gc_set_desktop_mode (void)
2546 mono_gc_is_moving (void)
2552 mono_gc_is_disabled (void)
2558 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved)
2565 mono_gc_max_generation (void)
2571 mono_gc_precise_stack_mark_enabled (void)
2573 return !conservative_stack_mark;
2577 mono_gc_collect (int generation)
2579 sgen_gc_collect (generation);
2583 mono_gc_collection_count (int generation)
2585 return sgen_gc_collection_count (generation);
2589 mono_gc_get_used_size (void)
2591 return (int64_t)sgen_gc_get_used_size ();
2595 mono_gc_get_heap_size (void)
2597 return (int64_t)sgen_gc_get_total_heap_allocation ();
2601 mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker)
2603 return sgen_make_user_root_descriptor (marker);
2607 mono_gc_make_descr_for_string (gsize *bitmap, int numbits)
2609 return SGEN_DESC_STRING;
2613 mono_gc_get_nursery (int *shift_bits, size_t *size)
2615 *size = sgen_nursery_size;
2616 *shift_bits = DEFAULT_NURSERY_BITS;
2617 return sgen_get_nursery_start ();
2621 mono_gc_get_los_limit (void)
2623 return SGEN_MAX_SMALL_OBJ_SIZE;
2627 sgen_client_default_metadata (void)
2629 return mono_domain_get ();
2633 sgen_client_metadata_for_object (GCObject *obj)
2635 return mono_object_domain (obj);
2639 * mono_gchandle_is_in_domain:
2640 * @gchandle: a GCHandle's handle.
2641 * @domain: An application domain.
2643 * Returns: TRUE if the object wrapped by the @gchandle belongs to the specific @domain.
2646 mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain)
2648 MonoDomain *gchandle_domain = (MonoDomain *)sgen_gchandle_get_metadata (gchandle);
2649 return domain->domain_id == gchandle_domain->domain_id;
2653 * mono_gchandle_free_domain:
2654 * @unloading: domain that is unloading
2656 * Function used internally to cleanup any GC handle for objects belonging
2657 * to the specified domain during appdomain unload.
2660 mono_gchandle_free_domain (MonoDomain *unloading)
2665 null_link_if_in_domain (gpointer hidden, GCHandleType handle_type, int max_generation, gpointer user)
2667 MonoDomain *unloading_domain = (MonoDomain *)user;
2668 MonoDomain *obj_domain;
2669 gboolean is_weak = MONO_GC_HANDLE_TYPE_IS_WEAK (handle_type);
2670 if (MONO_GC_HANDLE_IS_OBJECT_POINTER (hidden)) {
2671 MonoObject *obj = (MonoObject *)MONO_GC_REVEAL_POINTER (hidden, is_weak);
2672 obj_domain = mono_object_domain (obj);
2674 obj_domain = (MonoDomain *)MONO_GC_REVEAL_POINTER (hidden, is_weak);
2676 if (unloading_domain->domain_id == obj_domain->domain_id)
2682 sgen_null_links_for_domain (MonoDomain *domain)
2685 for (type = HANDLE_TYPE_MIN; type < HANDLE_TYPE_MAX; ++type)
2686 sgen_gchandle_iterate ((GCHandleType)type, GENERATION_OLD, null_link_if_in_domain, domain);
2690 mono_gchandle_set_target (guint32 gchandle, MonoObject *obj)
2692 sgen_gchandle_set_target (gchandle, obj);
2696 sgen_client_gchandle_created (int handle_type, GCObject *obj, guint32 handle)
2698 #ifndef DISABLE_PERFCOUNTERS
2699 mono_perfcounters->gc_num_handles++;
2701 mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_CREATED, handle_type, handle, obj);
2705 sgen_client_gchandle_destroyed (int handle_type, guint32 handle)
2707 #ifndef DISABLE_PERFCOUNTERS
2708 mono_perfcounters->gc_num_handles--;
2710 mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_DESTROYED, handle_type, handle, NULL);
2714 sgen_client_ensure_weak_gchandles_accessible (void)
2717 * During the second bridge processing step the world is
2718 * running again. That step processes all weak links once
2719 * more to null those that refer to dead objects. Before that
2720 * is completed, those links must not be followed, so we
2721 * conservatively wait for bridge processing when any weak
2722 * link is dereferenced.
2724 /* FIXME: A GC can occur after this check fails, in which case we
2725 * should wait for bridge processing but would fail to do so.
2727 if (G_UNLIKELY (bridge_processing_in_progress))
2728 mono_gc_wait_for_bridge_processing ();
2732 mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data)
2736 result = func (data);
2737 UNLOCK_INTERRUPTION;
2742 mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size)
2748 mono_gc_get_card_table (int *shift_bits, gpointer *mask)
2750 return sgen_get_card_table_configuration (shift_bits, mask);
2754 mono_gc_card_table_nursery_check (void)
2756 return !sgen_get_major_collector ()->is_concurrent;
2759 /* Negative value to remove */
2761 mono_gc_add_memory_pressure (gint64 value)
2763 /* FIXME: Implement at some point? */
2771 sgen_client_degraded_allocation (size_t size)
2773 static int last_major_gc_warned = -1;
2774 static int num_degraded = 0;
2776 if (last_major_gc_warned < (int)gc_stats.major_gc_count) {
2778 if (num_degraded == 1 || num_degraded == 3)
2779 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Degraded allocation. Consider increasing nursery-size if the warning persists.");
2780 else if (num_degraded == 10)
2781 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Repeated degraded allocation. Consider increasing nursery-size.");
2782 last_major_gc_warned = gc_stats.major_gc_count;
2791 sgen_client_description_for_internal_mem_type (int type)
2794 case INTERNAL_MEM_EPHEMERON_LINK: return "ephemeron-link";
2801 sgen_client_pre_collection_checks (void)
2803 if (sgen_mono_xdomain_checks) {
2804 sgen_clear_nursery_fragments ();
2805 sgen_check_for_xdomain_refs ();
2810 sgen_client_vtable_is_inited (MonoVTable *vt)
2812 return vt->klass->inited;
2816 sgen_client_vtable_get_namespace (MonoVTable *vt)
2818 return vt->klass->name_space;
2822 sgen_client_vtable_get_name (MonoVTable *vt)
2824 return vt->klass->name;
2832 sgen_client_init (void)
2835 MonoThreadInfoCallbacks cb;
2837 cb.thread_register = sgen_thread_register;
2838 cb.thread_detach = sgen_thread_detach;
2839 cb.thread_unregister = sgen_thread_unregister;
2840 cb.thread_attach = sgen_thread_attach;
2841 cb.mono_method_is_critical = (gboolean (*)(void *))is_critical_method;
2842 cb.mono_thread_in_critical_region = thread_in_critical_region;
2844 mono_threads_init (&cb, sizeof (SgenThreadInfo));
2846 ///* Keep this the default for now */
2847 /* Precise marking is broken on all supported targets. Disable until fixed. */
2848 conservative_stack_mark = TRUE;
2850 sgen_register_fixed_internal_mem_type (INTERNAL_MEM_EPHEMERON_LINK, sizeof (EphemeronLinkNode));
2852 mono_sgen_init_stw ();
2854 #ifndef HAVE_KW_THREAD
2855 mono_native_tls_alloc (&thread_info_key, NULL);
2856 #if defined(TARGET_OSX) || defined(TARGET_WIN32) || defined(TARGET_ANDROID) || defined(TARGET_IOS)
2858 * CEE_MONO_TLS requires the tls offset, not the key, so the code below only works on darwin,
2859 * where the two are the same.
2861 mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, thread_info_key);
2865 int tls_offset = -1;
2866 MONO_THREAD_VAR_OFFSET (sgen_thread_info, tls_offset);
2867 mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, tls_offset);
2872 * This needs to happen before any internal allocations because
2873 * it inits the small id which is required for hazard pointer
2878 mono_gc_register_thread (&dummy);
2882 sgen_client_handle_gc_param (const char *opt)
2884 if (g_str_has_prefix (opt, "stack-mark=")) {
2885 opt = strchr (opt, '=') + 1;
2886 if (!strcmp (opt, "precise")) {
2887 conservative_stack_mark = FALSE;
2888 } else if (!strcmp (opt, "conservative")) {
2889 conservative_stack_mark = TRUE;
2891 sgen_env_var_error (MONO_GC_PARAMS_NAME, conservative_stack_mark ? "Using `conservative`." : "Using `precise`.",
2892 "Invalid value `%s` for `stack-mark` option, possible values are: `precise`, `conservative`.", opt);
2894 } else if (g_str_has_prefix (opt, "bridge-implementation=")) {
2895 opt = strchr (opt, '=') + 1;
2896 sgen_set_bridge_implementation (opt);
2897 } else if (g_str_has_prefix (opt, "toggleref-test")) {
2898 /* FIXME: This should probably in MONO_GC_DEBUG */
2899 sgen_register_test_toggleref_callback ();
2907 sgen_client_print_gc_params_usage (void)
2909 fprintf (stderr, " stack-mark=MARK-METHOD (where MARK-METHOD is 'precise' or 'conservative')\n");
2913 sgen_client_handle_gc_debug (const char *opt)
2915 if (!strcmp (opt, "xdomain-checks")) {
2916 sgen_mono_xdomain_checks = TRUE;
2917 } else if (!strcmp (opt, "do-not-finalize")) {
2918 mono_do_not_finalize = TRUE;
2919 } else if (g_str_has_prefix (opt, "do-not-finalize=")) {
2920 opt = strchr (opt, '=') + 1;
2921 mono_do_not_finalize = TRUE;
2922 mono_do_not_finalize_class_names = g_strsplit (opt, ",", 0);
2923 } else if (!strcmp (opt, "log-finalizers")) {
2924 log_finalizers = TRUE;
2925 } else if (!strcmp (opt, "no-managed-allocator")) {
2926 sgen_set_use_managed_allocator (FALSE);
2927 } else if (!sgen_bridge_handle_gc_debug (opt)) {
2934 sgen_client_print_gc_debug_usage (void)
2936 fprintf (stderr, " xdomain-checks\n");
2937 fprintf (stderr, " do-not-finalize\n");
2938 fprintf (stderr, " log-finalizers\n");
2939 fprintf (stderr, " no-managed-allocator\n");
2940 sgen_bridge_print_gc_debug_usage ();
2945 sgen_client_get_provenance (void)
2947 #ifdef SGEN_OBJECT_PROVENANCE
2948 MonoGCCallbacks *cb = mono_gc_get_gc_callbacks ();
2949 gpointer (*get_provenance_func) (void);
2952 get_provenance_func = cb->get_provenance_func;
2953 if (get_provenance_func)
2954 return get_provenance_func ();
2962 sgen_client_describe_invalid_pointer (GCObject *ptr)
2964 sgen_bridge_describe_pointer (ptr);
2967 static gboolean gc_inited;
2970 mono_gc_base_init (void)
2975 mono_counters_init ();
2977 #ifdef HEAVY_STATISTICS
2978 mono_counters_register ("los marked cards", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_marked_cards);
2979 mono_counters_register ("los array cards scanned ", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_cards);
2980 mono_counters_register ("los array remsets", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_remsets);
2982 mono_counters_register ("WBarrier set arrayref", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_set_arrayref);
2983 mono_counters_register ("WBarrier value copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_value_copy);
2984 mono_counters_register ("WBarrier object copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_object_copy);
2989 if (nursery_canaries_enabled ())
2990 sgen_set_use_managed_allocator (FALSE);
2992 #if defined(HAVE_KW_THREAD)
2993 /* This can happen with using libmonosgen.so */
2994 if (mono_tls_key_get_offset (TLS_KEY_SGEN_TLAB_NEXT_ADDR) == -1)
2995 sgen_set_use_managed_allocator (FALSE);
3002 mono_gc_base_cleanup (void)
3004 sgen_thread_pool_shutdown ();
3008 mono_gc_is_null (void)