2 * sgen-mono.c: SGen features specific to Mono.
4 * Copyright (C) 2014 Xamarin Inc
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License 2.0 as published by the Free Software Foundation;
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License 2.0 along with this library; if not, write to the Free
17 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #include "sgen/sgen-gc.h"
24 #include "sgen/sgen-protocol.h"
25 #include "metadata/monitor.h"
26 #include "sgen/sgen-layout-stats.h"
27 #include "sgen/sgen-client.h"
28 #include "sgen/sgen-cardtable.h"
29 #include "sgen/sgen-pinning.h"
30 #include "metadata/marshal.h"
31 #include "metadata/method-builder.h"
32 #include "metadata/abi-details.h"
33 #include "metadata/mono-gc.h"
34 #include "metadata/runtime.h"
35 #include "metadata/sgen-bridge-internals.h"
36 #include "metadata/gc-internals.h"
37 #include "metadata/handle.h"
38 #include "utils/mono-memory-model.h"
39 #include "utils/mono-logger-internals.h"
41 #ifdef HEAVY_STATISTICS
42 static guint64 stat_wbarrier_set_arrayref = 0;
43 static guint64 stat_wbarrier_value_copy = 0;
44 static guint64 stat_wbarrier_object_copy = 0;
46 static guint64 los_marked_cards;
47 static guint64 los_array_cards;
48 static guint64 los_array_remsets;
51 /* If set, mark stacks conservatively, even if precise marking is possible */
52 static gboolean conservative_stack_mark = FALSE;
53 /* If set, check that there are no references to the domain left at domain unload */
54 gboolean sgen_mono_xdomain_checks = FALSE;
56 /* Functions supplied by the runtime to be called by the GC */
57 static MonoGCCallbacks gc_callbacks;
60 __thread SgenThreadInfo *sgen_thread_info;
62 MonoNativeTlsKey thread_info_key;
65 #define ALIGN_TO(val,align) ((((guint64)val) + ((align) - 1)) & ~((align) - 1))
67 #define OPDEF(a,b,c,d,e,f,g,h,i,j) \
71 #include "mono/cil/opcode.def"
82 ptr_on_stack (void *ptr)
84 gpointer stack_start = &stack_start;
85 SgenThreadInfo *info = mono_thread_info_current ();
87 if (ptr >= stack_start && ptr < (gpointer)info->client_info.stack_end)
92 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
94 #define HANDLE_PTR(ptr,obj) do { \
95 gpointer o = *(gpointer*)(ptr); \
97 gpointer d = ((char*)dest) + ((char*)(ptr) - (char*)(obj)); \
98 binary_protocol_wbarrier (d, o, (gpointer) SGEN_LOAD_VTABLE (o)); \
103 scan_object_for_binary_protocol_copy_wbarrier (gpointer dest, char *start, mword desc)
105 #define SCAN_OBJECT_NOVTABLE
106 #include "sgen/sgen-scan-object.h"
111 mono_gc_wbarrier_value_copy (gpointer dest, gpointer src, int count, MonoClass *klass)
113 HEAVY_STAT (++stat_wbarrier_value_copy);
114 g_assert (klass->valuetype);
116 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);
118 if (sgen_ptr_in_nursery (dest) || ptr_on_stack (dest) || !sgen_gc_descr_has_references ((mword)klass->gc_descr)) {
119 size_t element_size = mono_class_value_size (klass, NULL);
120 size_t size = count * element_size;
121 mono_gc_memmove_atomic (dest, src, size);
125 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
126 if (binary_protocol_is_heavy_enabled ()) {
127 size_t element_size = mono_class_value_size (klass, NULL);
129 for (i = 0; i < count; ++i) {
130 scan_object_for_binary_protocol_copy_wbarrier ((char*)dest + i * element_size,
131 (char*)src + i * element_size - sizeof (MonoObject),
132 (mword) klass->gc_descr);
137 sgen_get_remset ()->wbarrier_value_copy (dest, src, count, mono_class_value_size (klass, NULL));
141 * mono_gc_wbarrier_object_copy:
143 * Write barrier to call when obj is the result of a clone or copy of an object.
146 mono_gc_wbarrier_object_copy (MonoObject* obj, MonoObject *src)
150 HEAVY_STAT (++stat_wbarrier_object_copy);
152 if (sgen_ptr_in_nursery (obj) || ptr_on_stack (obj) || !SGEN_OBJECT_HAS_REFERENCES (src)) {
153 size = mono_object_class (obj)->instance_size;
154 mono_gc_memmove_aligned ((char*)obj + sizeof (MonoObject), (char*)src + sizeof (MonoObject),
155 size - sizeof (MonoObject));
159 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
160 if (binary_protocol_is_heavy_enabled ())
161 scan_object_for_binary_protocol_copy_wbarrier (obj, (char*)src, (mword) src->vtable->gc_descr);
164 sgen_get_remset ()->wbarrier_object_copy (obj, src);
168 mono_gc_wbarrier_set_arrayref (MonoArray *arr, gpointer slot_ptr, MonoObject* value)
170 HEAVY_STAT (++stat_wbarrier_set_arrayref);
171 if (sgen_ptr_in_nursery (slot_ptr)) {
172 *(void**)slot_ptr = value;
175 SGEN_LOG (8, "Adding remset at %p", slot_ptr);
177 binary_protocol_wbarrier (slot_ptr, value, value->vtable);
179 sgen_get_remset ()->wbarrier_set_field ((GCObject*)arr, slot_ptr, value);
183 mono_gc_wbarrier_set_field (MonoObject *obj, gpointer field_ptr, MonoObject* value)
185 mono_gc_wbarrier_set_arrayref ((MonoArray*)obj, field_ptr, value);
189 mono_gc_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap)
191 sgen_wbarrier_value_copy_bitmap (_dest, _src, size, bitmap);
194 static MonoMethod *write_barrier_conc_method;
195 static MonoMethod *write_barrier_noconc_method;
198 sgen_is_critical_method (MonoMethod *method)
200 return (method == write_barrier_conc_method || method == write_barrier_noconc_method || sgen_is_managed_allocator (method));
204 sgen_has_critical_method (void)
206 return write_barrier_conc_method || write_barrier_noconc_method || sgen_has_managed_allocator ();
212 emit_nursery_check (MonoMethodBuilder *mb, int *nursery_check_return_labels, gboolean is_concurrent)
214 int shifted_nursery_start = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
216 memset (nursery_check_return_labels, 0, sizeof (int) * 2);
217 // if (ptr_in_nursery (ptr)) return;
219 * Masking out the bits might be faster, but we would have to use 64 bit
220 * immediates, which might be slower.
222 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
223 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_START);
224 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
225 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_BITS);
226 mono_mb_emit_byte (mb, CEE_SHR_UN);
227 mono_mb_emit_stloc (mb, shifted_nursery_start);
229 mono_mb_emit_ldarg (mb, 0);
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 [0] = mono_mb_emit_branch (mb, CEE_BEQ);
236 if (!is_concurrent) {
237 // if (!ptr_in_nursery (*ptr)) return;
238 mono_mb_emit_ldarg (mb, 0);
239 mono_mb_emit_byte (mb, CEE_LDIND_I);
240 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
241 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_BITS);
242 mono_mb_emit_byte (mb, CEE_SHR_UN);
243 mono_mb_emit_ldloc (mb, shifted_nursery_start);
244 nursery_check_return_labels [1] = mono_mb_emit_branch (mb, CEE_BNE_UN);
250 mono_gc_get_specific_write_barrier (gboolean is_concurrent)
253 MonoMethodBuilder *mb;
254 MonoMethodSignature *sig;
255 MonoMethod **write_barrier_method_addr;
257 #ifdef MANAGED_WBARRIER
258 int i, nursery_check_labels [2];
261 // FIXME: Maybe create a separate version for ctors (the branch would be
262 // correctly predicted more times)
264 write_barrier_method_addr = &write_barrier_conc_method;
266 write_barrier_method_addr = &write_barrier_noconc_method;
268 if (*write_barrier_method_addr)
269 return *write_barrier_method_addr;
271 /* Create the IL version of mono_gc_barrier_generic_store () */
272 sig = mono_metadata_signature_alloc (mono_defaults.corlib, 1);
273 sig->ret = &mono_defaults.void_class->byval_arg;
274 sig->params [0] = &mono_defaults.int_class->byval_arg;
277 mb = mono_mb_new (mono_defaults.object_class, "wbarrier_conc", MONO_WRAPPER_WRITE_BARRIER);
279 mb = mono_mb_new (mono_defaults.object_class, "wbarrier_noconc", MONO_WRAPPER_WRITE_BARRIER);
282 #ifdef MANAGED_WBARRIER
283 emit_nursery_check (mb, nursery_check_labels, is_concurrent);
285 addr = sgen_cardtable + ((address >> CARD_BITS) & CARD_MASK)
289 LDC_PTR sgen_cardtable
295 if (SGEN_HAVE_OVERLAPPING_CARDS) {
296 LDC_PTR card_table_mask
303 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
304 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_CARD_TABLE);
305 mono_mb_emit_ldarg (mb, 0);
306 mono_mb_emit_icon (mb, CARD_BITS);
307 mono_mb_emit_byte (mb, CEE_SHR_UN);
308 mono_mb_emit_byte (mb, CEE_CONV_I);
309 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
310 #if SIZEOF_VOID_P == 8
311 mono_mb_emit_icon8 (mb, CARD_MASK);
313 mono_mb_emit_icon (mb, CARD_MASK);
315 mono_mb_emit_byte (mb, CEE_CONV_I);
316 mono_mb_emit_byte (mb, CEE_AND);
318 mono_mb_emit_byte (mb, CEE_ADD);
319 mono_mb_emit_icon (mb, 1);
320 mono_mb_emit_byte (mb, CEE_STIND_I1);
323 for (i = 0; i < 2; ++i) {
324 if (nursery_check_labels [i])
325 mono_mb_patch_branch (mb, nursery_check_labels [i]);
327 mono_mb_emit_byte (mb, CEE_RET);
329 mono_mb_emit_ldarg (mb, 0);
330 mono_mb_emit_icall (mb, mono_gc_wbarrier_generic_nostore);
331 mono_mb_emit_byte (mb, CEE_RET);
334 res = mono_mb_create_method (mb, sig, 16);
335 info = mono_wrapper_info_create (mb, WRAPPER_SUBTYPE_NONE);
336 mono_marshal_set_wrapper_info (res, info);
340 if (*write_barrier_method_addr) {
341 /* Already created */
342 mono_free_method (res);
344 /* double-checked locking */
345 mono_memory_barrier ();
346 *write_barrier_method_addr = res;
350 return *write_barrier_method_addr;
354 mono_gc_get_write_barrier (void)
356 return mono_gc_get_specific_write_barrier (major_collector.is_concurrent);
360 * Dummy filler objects
363 /* Vtable of the objects used to fill out nursery fragments before a collection */
364 static GCVTable array_fill_vtable;
367 get_array_fill_vtable (void)
369 if (!array_fill_vtable) {
370 static MonoClass klass;
371 static char _vtable[sizeof(MonoVTable)+8];
372 MonoVTable* vtable = (MonoVTable*) ALIGN_TO((mword)_vtable, 8);
375 MonoDomain *domain = mono_get_root_domain ();
378 klass.element_class = mono_defaults.byte_class;
380 klass.instance_size = MONO_SIZEOF_MONO_ARRAY;
381 klass.sizes.element_size = 1;
382 klass.name = "array_filler_type";
384 vtable->klass = &klass;
386 vtable->gc_descr = mono_gc_make_descr_for_array (TRUE, &bmap, 0, 1);
389 array_fill_vtable = vtable;
391 return array_fill_vtable;
395 sgen_client_array_fill_range (char *start, size_t size)
399 if (size < MONO_SIZEOF_MONO_ARRAY) {
400 memset (start, 0, size);
404 o = (MonoArray*)start;
405 o->obj.vtable = (MonoVTable*)get_array_fill_vtable ();
406 /* Mark this as not a real object */
407 o->obj.synchronisation = (MonoThreadsSync *)GINT_TO_POINTER (-1);
409 o->max_length = (mono_array_size_t)(size - MONO_SIZEOF_MONO_ARRAY);
415 sgen_client_zero_array_fill_header (void *p, size_t size)
417 if (size >= MONO_SIZEOF_MONO_ARRAY) {
418 memset (p, 0, MONO_SIZEOF_MONO_ARRAY);
420 static guint8 zeros [MONO_SIZEOF_MONO_ARRAY];
422 SGEN_ASSERT (0, !memcmp (p, zeros, size), "TLAB segment must be zeroed out.");
430 static MonoGCFinalizerCallbacks fin_callbacks;
433 mono_gc_get_vtable_bits (MonoClass *klass)
436 /* FIXME move this to the bridge code */
437 if (sgen_need_bridge_processing ()) {
438 switch (sgen_bridge_class_kind (klass)) {
439 case GC_BRIDGE_TRANSPARENT_BRIDGE_CLASS:
440 case GC_BRIDGE_OPAQUE_BRIDGE_CLASS:
441 res = SGEN_GC_BIT_BRIDGE_OBJECT;
443 case GC_BRIDGE_OPAQUE_CLASS:
444 res = SGEN_GC_BIT_BRIDGE_OPAQUE_OBJECT;
446 case GC_BRIDGE_TRANSPARENT_CLASS:
450 if (fin_callbacks.is_class_finalization_aware) {
451 if (fin_callbacks.is_class_finalization_aware (klass))
452 res |= SGEN_GC_BIT_FINALIZER_AWARE;
458 is_finalization_aware (MonoObject *obj)
460 MonoVTable *vt = SGEN_LOAD_VTABLE (obj);
461 return (vt->gc_bits & SGEN_GC_BIT_FINALIZER_AWARE) == SGEN_GC_BIT_FINALIZER_AWARE;
465 sgen_client_object_queued_for_finalization (GCObject *obj)
467 if (fin_callbacks.object_queued_for_finalization && is_finalization_aware (obj))
468 fin_callbacks.object_queued_for_finalization (obj);
471 if (G_UNLIKELY (MONO_GC_FINALIZE_ENQUEUE_ENABLED ())) {
472 int gen = sgen_ptr_in_nursery (obj) ? GENERATION_NURSERY : GENERATION_OLD;
473 GCVTable vt = SGEN_LOAD_VTABLE (obj);
474 MONO_GC_FINALIZE_ENQUEUE ((mword)obj, sgen_safe_object_get_size (obj),
475 sgen_client_vtable_get_namespace (vt), sgen_client_vtable_get_name (vt), gen,
476 sgen_client_object_has_critical_finalizer (obj));
482 mono_gc_register_finalizer_callbacks (MonoGCFinalizerCallbacks *callbacks)
484 if (callbacks->version != MONO_GC_FINALIZER_EXTENSION_VERSION)
485 g_error ("Invalid finalizer callback version. Expected %d but got %d\n", MONO_GC_FINALIZER_EXTENSION_VERSION, callbacks->version);
487 fin_callbacks = *callbacks;
491 sgen_client_run_finalize (MonoObject *obj)
493 mono_gc_run_finalize (obj, NULL);
497 mono_gc_invoke_finalizers (void)
499 return sgen_gc_invoke_finalizers ();
503 mono_gc_pending_finalizers (void)
505 return sgen_have_pending_finalizers ();
509 sgen_client_finalize_notify (void)
511 mono_gc_finalize_notify ();
515 mono_gc_register_for_finalization (MonoObject *obj, void *user_data)
517 sgen_object_register_for_finalization (obj, user_data);
521 object_in_domain_predicate (MonoObject *obj, void *user_data)
523 MonoDomain *domain = (MonoDomain *)user_data;
524 if (mono_object_domain (obj) == domain) {
525 SGEN_LOG (5, "Unregistering finalizer for object: %p (%s)", obj, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj)));
532 * mono_gc_finalizers_for_domain:
533 * @domain: the unloading appdomain
534 * @out_array: output array
535 * @out_size: size of output array
537 * Store inside @out_array up to @out_size objects that belong to the unloading
538 * appdomain @domain. Returns the number of stored items. Can be called repeteadly
539 * until it returns 0.
540 * The items are removed from the finalizer data structure, so the caller is supposed
542 * @out_array should be on the stack to allow the GC to know the objects are still alive.
545 mono_gc_finalizers_for_domain (MonoDomain *domain, MonoObject **out_array, int out_size)
547 return sgen_gather_finalizers_if (object_in_domain_predicate, domain, out_array, out_size);
554 typedef struct _EphemeronLinkNode EphemeronLinkNode;
556 struct _EphemeronLinkNode {
557 EphemeronLinkNode *next;
566 static EphemeronLinkNode *ephemeron_list;
568 /* LOCKING: requires that the GC lock is held */
570 null_ephemerons_for_domain (MonoDomain *domain)
572 EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
575 MonoObject *object = (MonoObject*)current->array;
578 SGEN_ASSERT (0, object->vtable, "Can't have objects without vtables.");
580 if (object && object->vtable->domain == domain) {
581 EphemeronLinkNode *tmp = current;
584 prev->next = current->next;
586 ephemeron_list = current->next;
588 current = current->next;
589 sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
592 current = current->next;
597 /* LOCKING: requires that the GC lock is held */
599 sgen_client_clear_unreachable_ephemerons (ScanCopyContext ctx)
601 CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
602 SgenGrayQueue *queue = ctx.queue;
603 EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
604 Ephemeron *cur, *array_end;
608 MonoArray *array = current->array;
610 if (!sgen_is_object_alive_for_current_gen ((GCObject*)array)) {
611 EphemeronLinkNode *tmp = current;
613 SGEN_LOG (5, "Dead Ephemeron array at %p", array);
616 prev->next = current->next;
618 ephemeron_list = current->next;
620 current = current->next;
621 sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
626 copy_func ((GCObject**)&array, queue);
627 current->array = array;
629 SGEN_LOG (5, "Clearing unreachable entries for ephemeron array at %p", array);
631 cur = mono_array_addr (array, Ephemeron, 0);
632 array_end = cur + mono_array_length_fast (array);
633 tombstone = SGEN_LOAD_VTABLE ((GCObject*)array)->domain->ephemeron_tombstone;
635 for (; cur < array_end; ++cur) {
636 GCObject *key = cur->key;
638 if (!key || key == tombstone)
641 SGEN_LOG (5, "[%zd] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
642 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
643 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
645 if (!sgen_is_object_alive_for_current_gen (key)) {
646 cur->key = tombstone;
652 current = current->next;
657 LOCKING: requires that the GC lock is held
659 Limitations: We scan all ephemerons on every collection since the current design doesn't allow for a simple nursery/mature split.
662 sgen_client_mark_ephemerons (ScanCopyContext ctx)
664 CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
665 SgenGrayQueue *queue = ctx.queue;
666 gboolean nothing_marked = TRUE;
667 EphemeronLinkNode *current = ephemeron_list;
668 Ephemeron *cur, *array_end;
671 for (current = ephemeron_list; current; current = current->next) {
672 MonoArray *array = current->array;
673 SGEN_LOG (5, "Ephemeron array at %p", array);
675 /*It has to be alive*/
676 if (!sgen_is_object_alive_for_current_gen ((GCObject*)array)) {
677 SGEN_LOG (5, "\tnot reachable");
681 copy_func ((GCObject**)&array, queue);
683 cur = mono_array_addr (array, Ephemeron, 0);
684 array_end = cur + mono_array_length_fast (array);
685 tombstone = SGEN_LOAD_VTABLE ((GCObject*)array)->domain->ephemeron_tombstone;
687 for (; cur < array_end; ++cur) {
688 GCObject *key = cur->key;
690 if (!key || key == tombstone)
693 SGEN_LOG (5, "[%zd] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
694 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
695 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
697 if (sgen_is_object_alive_for_current_gen (key)) {
698 GCObject *value = cur->value;
700 copy_func (&cur->key, queue);
702 if (!sgen_is_object_alive_for_current_gen (value))
703 nothing_marked = FALSE;
704 copy_func (&cur->value, queue);
710 SGEN_LOG (5, "Ephemeron run finished. Is it done %d", nothing_marked);
711 return nothing_marked;
715 mono_gc_ephemeron_array_add (MonoObject *obj)
717 EphemeronLinkNode *node;
721 node = (EphemeronLinkNode *)sgen_alloc_internal (INTERNAL_MEM_EPHEMERON_LINK);
726 node->array = (MonoArray*)obj;
727 node->next = ephemeron_list;
728 ephemeron_list = node;
730 SGEN_LOG (5, "Registered ephemeron array %p", obj);
741 mono_gc_set_current_thread_appdomain (MonoDomain *domain)
743 SgenThreadInfo *info = mono_thread_info_current ();
745 /* Could be called from sgen_thread_unregister () with a NULL info */
748 info->client_info.stopped_domain = domain;
753 need_remove_object_for_domain (GCObject *start, MonoDomain *domain)
755 if (mono_object_domain (start) == domain) {
756 SGEN_LOG (4, "Need to cleanup object %p", start);
757 binary_protocol_cleanup (start, (gpointer)SGEN_LOAD_VTABLE (start), sgen_safe_object_get_size ((GCObject*)start));
764 process_object_for_domain_clearing (GCObject *start, MonoDomain *domain)
766 MonoVTable *vt = SGEN_LOAD_VTABLE (start);
767 if (vt->klass == mono_defaults.internal_thread_class)
768 g_assert (mono_object_domain (start) == mono_get_root_domain ());
769 /* The object could be a proxy for an object in the domain
771 #ifndef DISABLE_REMOTING
772 if (mono_defaults.real_proxy_class->supertypes && mono_class_has_parent_fast (vt->klass, mono_defaults.real_proxy_class)) {
773 MonoObject *server = ((MonoRealProxy*)start)->unwrapped_server;
775 /* The server could already have been zeroed out, so
776 we need to check for that, too. */
777 if (server && (!SGEN_LOAD_VTABLE (server) || mono_object_domain (server) == domain)) {
778 SGEN_LOG (4, "Cleaning up remote pointer in %p to object %p", start, server);
779 ((MonoRealProxy*)start)->unwrapped_server = NULL;
786 clear_domain_process_object (GCObject *obj, MonoDomain *domain)
790 process_object_for_domain_clearing (obj, domain);
791 remove = need_remove_object_for_domain (obj, domain);
793 if (remove && obj->synchronisation) {
794 guint32 dislink = mono_monitor_get_object_monitor_gchandle (obj);
796 mono_gchandle_free (dislink);
803 clear_domain_process_minor_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
805 if (clear_domain_process_object (obj, domain)) {
806 CANARIFY_SIZE (size);
807 memset (obj, 0, size);
812 clear_domain_process_major_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
814 clear_domain_process_object (obj, domain);
818 clear_domain_free_major_non_pinned_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
820 if (need_remove_object_for_domain (obj, domain))
821 major_collector.free_non_pinned_object (obj, size);
825 clear_domain_free_major_pinned_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
827 if (need_remove_object_for_domain (obj, domain))
828 major_collector.free_pinned_object (obj, size);
832 * When appdomains are unloaded we can easily remove objects that have finalizers,
833 * but all the others could still be present in random places on the heap.
834 * We need a sweep to get rid of them even though it's going to be costly
836 * The reason we need to remove them is because we access the vtable and class
837 * structures to know the object size and the reference bitmap: once the domain is
838 * unloaded the point to random memory.
841 mono_gc_clear_domain (MonoDomain * domain)
843 LOSObject *bigobj, *prev;
848 binary_protocol_domain_unload_begin (domain);
852 if (sgen_concurrent_collection_in_progress ())
853 sgen_perform_collection (0, GENERATION_OLD, "clear domain", TRUE);
854 SGEN_ASSERT (0, !sgen_concurrent_collection_in_progress (), "We just ordered a synchronous collection. Why are we collecting concurrently?");
856 major_collector.finish_sweeping ();
858 sgen_process_fin_stage_entries ();
860 sgen_clear_nursery_fragments ();
862 if (sgen_mono_xdomain_checks && domain != mono_get_root_domain ()) {
863 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_NORMAL);
864 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_WBARRIER);
865 sgen_check_for_xdomain_refs ();
868 /*Ephemerons and dislinks must be processed before LOS since they might end up pointing
869 to memory returned to the OS.*/
870 null_ephemerons_for_domain (domain);
871 sgen_null_links_for_domain (domain);
873 for (i = GENERATION_NURSERY; i < GENERATION_MAX; ++i)
874 sgen_remove_finalizers_if (object_in_domain_predicate, domain, i);
876 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
877 (IterateObjectCallbackFunc)clear_domain_process_minor_object_callback, domain, FALSE, TRUE);
879 /* We need two passes over major and large objects because
880 freeing such objects might give their memory back to the OS
881 (in the case of large objects) or obliterate its vtable
882 (pinned objects with major-copying or pinned and non-pinned
883 objects with major-mark&sweep), but we might need to
884 dereference a pointer from an object to another object if
885 the first object is a proxy. */
886 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, (IterateObjectCallbackFunc)clear_domain_process_major_object_callback, domain);
887 for (bigobj = los_object_list; bigobj; bigobj = bigobj->next)
888 clear_domain_process_object ((GCObject*)bigobj->data, domain);
891 for (bigobj = los_object_list; bigobj;) {
892 if (need_remove_object_for_domain ((GCObject*)bigobj->data, domain)) {
893 LOSObject *to_free = bigobj;
895 prev->next = bigobj->next;
897 los_object_list = bigobj->next;
898 bigobj = bigobj->next;
899 SGEN_LOG (4, "Freeing large object %p", bigobj->data);
900 sgen_los_free_object (to_free);
904 bigobj = bigobj->next;
906 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_NON_PINNED, (IterateObjectCallbackFunc)clear_domain_free_major_non_pinned_object_callback, domain);
907 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_PINNED, (IterateObjectCallbackFunc)clear_domain_free_major_pinned_object_callback, domain);
909 if (domain == mono_get_root_domain ()) {
910 sgen_pin_stats_print_class_stats ();
911 sgen_object_layout_dump (stdout);
914 sgen_restart_world (0, NULL);
916 binary_protocol_domain_unload_end (domain);
917 binary_protocol_flush_buffers (FALSE);
926 static gboolean alloc_events = FALSE;
929 mono_gc_enable_alloc_events (void)
935 mono_gc_alloc_obj (MonoVTable *vtable, size_t size)
937 MonoObject *obj = sgen_alloc_obj (vtable, size);
939 if (G_UNLIKELY (alloc_events)) {
941 mono_profiler_allocation (obj);
948 mono_gc_alloc_pinned_obj (MonoVTable *vtable, size_t size)
950 MonoObject *obj = sgen_alloc_obj_pinned (vtable, size);
952 if (G_UNLIKELY (alloc_events)) {
954 mono_profiler_allocation (obj);
961 mono_gc_alloc_mature (MonoVTable *vtable, size_t size)
963 MonoObject *obj = sgen_alloc_obj_mature (vtable, size);
965 if (G_UNLIKELY (alloc_events)) {
967 mono_profiler_allocation (obj);
974 mono_gc_alloc_fixed (size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
976 /* FIXME: do a single allocation */
977 void *res = calloc (1, size);
980 if (!mono_gc_register_root ((char *)res, size, descr, source, msg)) {
988 mono_gc_free_fixed (void* addr)
990 mono_gc_deregister_root ((char *)addr);
998 static MonoMethod* alloc_method_cache [ATYPE_NUM];
999 static MonoMethod* slowpath_alloc_method_cache [ATYPE_NUM];
1000 static gboolean use_managed_allocator = TRUE;
1002 #ifdef MANAGED_ALLOCATION
1004 #ifdef HAVE_KW_THREAD
1006 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb) do { \
1007 mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX); \
1008 mono_mb_emit_byte ((mb), CEE_MONO_TLS); \
1009 mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_TLAB_NEXT_ADDR); \
1012 #define EMIT_TLS_ACCESS_TEMP_END(mb) do { \
1013 mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX); \
1014 mono_mb_emit_byte ((mb), CEE_MONO_TLS); \
1015 mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_TLAB_TEMP_END); \
1020 #if defined(TARGET_OSX) || defined(TARGET_WIN32) || defined(TARGET_ANDROID) || defined(TARGET_IOS)
1021 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb) do { \
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_icon ((mb), MONO_STRUCT_OFFSET (SgenThreadInfo, tlab_next_addr)); \
1026 mono_mb_emit_byte ((mb), CEE_ADD); \
1027 mono_mb_emit_byte ((mb), CEE_LDIND_I); \
1030 #define EMIT_TLS_ACCESS_TEMP_END(mb) do { \
1031 mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX); \
1032 mono_mb_emit_byte ((mb), CEE_MONO_TLS); \
1033 mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_THREAD_INFO); \
1034 mono_mb_emit_icon ((mb), MONO_STRUCT_OFFSET (SgenThreadInfo, tlab_temp_end)); \
1035 mono_mb_emit_byte ((mb), CEE_ADD); \
1036 mono_mb_emit_byte ((mb), CEE_LDIND_I); \
1040 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb) do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1041 #define EMIT_TLS_ACCESS_TEMP_END(mb) do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1046 /* FIXME: Do this in the JIT, where specialized allocation sequences can be created
1047 * for each class. This is currently not easy to do, as it is hard to generate basic
1048 * blocks + branches, but it is easy with the linear IL codebase.
1050 * For this to work we'd need to solve the TLAB race, first. Now we
1051 * require the allocator to be in a few known methods to make sure
1052 * that they are executed atomically via the restart mechanism.
1055 create_allocator (int atype, gboolean slowpath)
1057 int p_var, size_var, real_size_var;
1058 guint32 slowpath_branch, max_size_branch;
1059 MonoMethodBuilder *mb;
1061 MonoMethodSignature *csig;
1062 static gboolean registered = FALSE;
1063 int tlab_next_addr_var, new_next_var;
1064 const char *name = NULL;
1069 mono_register_jit_icall (mono_gc_alloc_obj, "mono_gc_alloc_obj", mono_create_icall_signature ("object ptr int"), FALSE);
1070 mono_register_jit_icall (mono_gc_alloc_vector, "mono_gc_alloc_vector", mono_create_icall_signature ("object ptr int int"), FALSE);
1071 mono_register_jit_icall (mono_gc_alloc_string, "mono_gc_alloc_string", mono_create_icall_signature ("object ptr int int32"), FALSE);
1075 if (atype == ATYPE_SMALL) {
1076 name = slowpath ? "SlowAllocSmall" : "AllocSmall";
1077 } else if (atype == ATYPE_NORMAL) {
1078 name = slowpath ? "SlowAlloc" : "Alloc";
1079 } else if (atype == ATYPE_VECTOR) {
1080 name = slowpath ? "SlowAllocVector" : "AllocVector";
1081 } else if (atype == ATYPE_STRING) {
1082 name = slowpath ? "SlowAllocString" : "AllocString";
1084 g_assert_not_reached ();
1087 if (atype == ATYPE_NORMAL)
1092 csig = mono_metadata_signature_alloc (mono_defaults.corlib, num_params);
1093 if (atype == ATYPE_STRING) {
1094 csig->ret = &mono_defaults.string_class->byval_arg;
1095 csig->params [0] = &mono_defaults.int_class->byval_arg;
1096 csig->params [1] = &mono_defaults.int32_class->byval_arg;
1098 csig->ret = &mono_defaults.object_class->byval_arg;
1099 for (i = 0; i < num_params; i++)
1100 csig->params [i] = &mono_defaults.int_class->byval_arg;
1103 mb = mono_mb_new (mono_defaults.object_class, name, MONO_WRAPPER_ALLOC);
1110 mono_mb_emit_ldarg (mb, 0);
1111 mono_mb_emit_icall (mb, ves_icall_object_new_specific);
1114 mono_mb_emit_ldarg (mb, 0);
1115 mono_mb_emit_ldarg (mb, 1);
1116 mono_mb_emit_icall (mb, ves_icall_array_new_specific);
1119 mono_mb_emit_ldarg (mb, 1);
1120 mono_mb_emit_icall (mb, ves_icall_string_alloc);
1123 g_assert_not_reached ();
1129 size_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1130 if (atype == ATYPE_SMALL) {
1131 /* size_var = size_arg */
1132 mono_mb_emit_ldarg (mb, 1);
1133 mono_mb_emit_stloc (mb, size_var);
1134 } else if (atype == ATYPE_NORMAL) {
1135 /* size = vtable->klass->instance_size; */
1136 mono_mb_emit_ldarg (mb, 0);
1137 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoVTable, klass));
1138 mono_mb_emit_byte (mb, CEE_ADD);
1139 mono_mb_emit_byte (mb, CEE_LDIND_I);
1140 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoClass, instance_size));
1141 mono_mb_emit_byte (mb, CEE_ADD);
1142 /* FIXME: assert instance_size stays a 4 byte integer */
1143 mono_mb_emit_byte (mb, CEE_LDIND_U4);
1144 mono_mb_emit_byte (mb, CEE_CONV_I);
1145 mono_mb_emit_stloc (mb, size_var);
1146 } else if (atype == ATYPE_VECTOR) {
1147 MonoExceptionClause *clause;
1148 int pos, pos_leave, pos_error;
1149 MonoClass *oom_exc_class;
1153 * n > MONO_ARRAY_MAX_INDEX => OutOfMemoryException
1154 * n < 0 => OverflowException
1156 * We can do an unsigned comparison to catch both cases, then in the error
1157 * case compare signed to distinguish between them.
1159 mono_mb_emit_ldarg (mb, 1);
1160 mono_mb_emit_icon (mb, MONO_ARRAY_MAX_INDEX);
1161 mono_mb_emit_byte (mb, CEE_CONV_U);
1162 pos = mono_mb_emit_short_branch (mb, CEE_BLE_UN_S);
1164 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1165 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1166 mono_mb_emit_ldarg (mb, 1);
1167 mono_mb_emit_icon (mb, 0);
1168 pos_error = mono_mb_emit_short_branch (mb, CEE_BLT_S);
1169 mono_mb_emit_exception (mb, "OutOfMemoryException", NULL);
1170 mono_mb_patch_short_branch (mb, pos_error);
1171 mono_mb_emit_exception (mb, "OverflowException", NULL);
1173 mono_mb_patch_short_branch (mb, pos);
1175 clause = (MonoExceptionClause *)mono_image_alloc0 (mono_defaults.corlib, sizeof (MonoExceptionClause));
1176 clause->try_offset = mono_mb_get_label (mb);
1178 /* vtable->klass->sizes.element_size */
1179 mono_mb_emit_ldarg (mb, 0);
1180 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoVTable, klass));
1181 mono_mb_emit_byte (mb, CEE_ADD);
1182 mono_mb_emit_byte (mb, CEE_LDIND_I);
1183 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoClass, sizes));
1184 mono_mb_emit_byte (mb, CEE_ADD);
1185 mono_mb_emit_byte (mb, CEE_LDIND_U4);
1186 mono_mb_emit_byte (mb, CEE_CONV_I);
1189 mono_mb_emit_ldarg (mb, 1);
1190 mono_mb_emit_byte (mb, CEE_MUL_OVF_UN);
1191 /* + sizeof (MonoArray) */
1192 mono_mb_emit_icon (mb, MONO_SIZEOF_MONO_ARRAY);
1193 mono_mb_emit_byte (mb, CEE_ADD_OVF_UN);
1194 mono_mb_emit_stloc (mb, size_var);
1196 pos_leave = mono_mb_emit_branch (mb, CEE_LEAVE);
1199 clause->flags = MONO_EXCEPTION_CLAUSE_NONE;
1200 clause->try_len = mono_mb_get_pos (mb) - clause->try_offset;
1201 clause->data.catch_class = mono_class_load_from_name (mono_defaults.corlib,
1202 "System", "OverflowException");
1203 clause->handler_offset = mono_mb_get_label (mb);
1205 oom_exc_class = mono_class_load_from_name (mono_defaults.corlib,
1206 "System", "OutOfMemoryException");
1207 ctor = mono_class_get_method_from_name (oom_exc_class, ".ctor", 0);
1210 mono_mb_emit_byte (mb, CEE_POP);
1211 mono_mb_emit_op (mb, CEE_NEWOBJ, ctor);
1212 mono_mb_emit_byte (mb, CEE_THROW);
1214 clause->handler_len = mono_mb_get_pos (mb) - clause->handler_offset;
1215 mono_mb_set_clauses (mb, 1, clause);
1216 mono_mb_patch_branch (mb, pos_leave);
1218 } else if (atype == ATYPE_STRING) {
1222 * a string allocator method takes the args: (vtable, len)
1224 * bytes = offsetof (MonoString, chars) + ((len + 1) * 2)
1228 * bytes <= INT32_MAX - (SGEN_ALLOC_ALIGN - 1)
1232 * offsetof (MonoString, chars) + ((len + 1) * 2) <= INT32_MAX - (SGEN_ALLOC_ALIGN - 1)
1233 * len <= (INT32_MAX - (SGEN_ALLOC_ALIGN - 1) - offsetof (MonoString, chars)) / 2 - 1
1235 mono_mb_emit_ldarg (mb, 1);
1236 mono_mb_emit_icon (mb, (INT32_MAX - (SGEN_ALLOC_ALIGN - 1) - MONO_STRUCT_OFFSET (MonoString, chars)) / 2 - 1);
1237 pos = mono_mb_emit_short_branch (mb, MONO_CEE_BLE_UN_S);
1239 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1240 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1241 mono_mb_emit_exception (mb, "OutOfMemoryException", NULL);
1242 mono_mb_patch_short_branch (mb, pos);
1244 mono_mb_emit_ldarg (mb, 1);
1245 mono_mb_emit_icon (mb, 1);
1246 mono_mb_emit_byte (mb, MONO_CEE_SHL);
1247 //WE manually fold the above + 2 here
1248 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoString, chars) + 2);
1249 mono_mb_emit_byte (mb, CEE_ADD);
1250 mono_mb_emit_stloc (mb, size_var);
1252 g_assert_not_reached ();
1255 if (nursery_canaries_enabled ()) {
1256 real_size_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1257 mono_mb_emit_ldloc (mb, size_var);
1258 mono_mb_emit_stloc(mb, real_size_var);
1261 real_size_var = size_var;
1263 /* size += ALLOC_ALIGN - 1; */
1264 mono_mb_emit_ldloc (mb, size_var);
1265 mono_mb_emit_icon (mb, SGEN_ALLOC_ALIGN - 1);
1266 mono_mb_emit_byte (mb, CEE_ADD);
1267 /* size &= ~(ALLOC_ALIGN - 1); */
1268 mono_mb_emit_icon (mb, ~(SGEN_ALLOC_ALIGN - 1));
1269 mono_mb_emit_byte (mb, CEE_AND);
1270 mono_mb_emit_stloc (mb, size_var);
1272 /* if (size > MAX_SMALL_OBJ_SIZE) goto slowpath */
1273 if (atype != ATYPE_SMALL) {
1274 mono_mb_emit_ldloc (mb, size_var);
1275 mono_mb_emit_icon (mb, SGEN_MAX_SMALL_OBJ_SIZE);
1276 max_size_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BGT_UN_S);
1280 * We need to modify tlab_next, but the JIT only supports reading, so we read
1281 * another tls var holding its address instead.
1284 /* tlab_next_addr (local) = tlab_next_addr (TLS var) */
1285 tlab_next_addr_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1286 EMIT_TLS_ACCESS_NEXT_ADDR (mb);
1287 mono_mb_emit_stloc (mb, tlab_next_addr_var);
1289 /* p = (void**)tlab_next; */
1290 p_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1291 mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1292 mono_mb_emit_byte (mb, CEE_LDIND_I);
1293 mono_mb_emit_stloc (mb, p_var);
1295 /* new_next = (char*)p + size; */
1296 new_next_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1297 mono_mb_emit_ldloc (mb, p_var);
1298 mono_mb_emit_ldloc (mb, size_var);
1299 mono_mb_emit_byte (mb, CEE_CONV_I);
1300 mono_mb_emit_byte (mb, CEE_ADD);
1302 if (nursery_canaries_enabled ()) {
1303 mono_mb_emit_icon (mb, CANARY_SIZE);
1304 mono_mb_emit_byte (mb, CEE_ADD);
1306 mono_mb_emit_stloc (mb, new_next_var);
1308 /* if (G_LIKELY (new_next < tlab_temp_end)) */
1309 mono_mb_emit_ldloc (mb, new_next_var);
1310 EMIT_TLS_ACCESS_TEMP_END (mb);
1311 slowpath_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLT_UN_S);
1314 if (atype != ATYPE_SMALL)
1315 mono_mb_patch_short_branch (mb, max_size_branch);
1317 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1318 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1320 /* FIXME: mono_gc_alloc_obj takes a 'size_t' as an argument, not an int32 */
1321 mono_mb_emit_ldarg (mb, 0);
1322 mono_mb_emit_ldloc (mb, real_size_var);
1323 if (atype == ATYPE_NORMAL || atype == ATYPE_SMALL) {
1324 mono_mb_emit_icall (mb, mono_gc_alloc_obj);
1325 } else if (atype == ATYPE_VECTOR) {
1326 mono_mb_emit_ldarg (mb, 1);
1327 mono_mb_emit_icall (mb, mono_gc_alloc_vector);
1328 } else if (atype == ATYPE_STRING) {
1329 mono_mb_emit_ldarg (mb, 1);
1330 mono_mb_emit_icall (mb, mono_gc_alloc_string);
1332 g_assert_not_reached ();
1334 mono_mb_emit_byte (mb, CEE_RET);
1337 mono_mb_patch_short_branch (mb, slowpath_branch);
1339 /* FIXME: Memory barrier */
1341 /* tlab_next = new_next */
1342 mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1343 mono_mb_emit_ldloc (mb, new_next_var);
1344 mono_mb_emit_byte (mb, CEE_STIND_I);
1346 /*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. */
1347 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1348 mono_mb_emit_byte (mb, CEE_MONO_MEMORY_BARRIER);
1349 mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_REL);
1352 mono_mb_emit_ldloc (mb, p_var);
1353 mono_mb_emit_ldarg (mb, 0);
1354 mono_mb_emit_byte (mb, CEE_STIND_I);
1356 /* mark object end with nursery word */
1357 if (nursery_canaries_enabled ()) {
1358 mono_mb_emit_ldloc (mb, p_var);
1359 mono_mb_emit_ldloc (mb, real_size_var);
1360 mono_mb_emit_byte (mb, MONO_CEE_ADD);
1361 mono_mb_emit_icon8 (mb, (mword) CANARY_STRING);
1362 mono_mb_emit_icon (mb, CANARY_SIZE);
1363 mono_mb_emit_byte (mb, MONO_CEE_PREFIX1);
1364 mono_mb_emit_byte (mb, CEE_CPBLK);
1367 if (atype == ATYPE_VECTOR) {
1368 /* arr->max_length = max_length; */
1369 mono_mb_emit_ldloc (mb, p_var);
1370 mono_mb_emit_ldflda (mb, MONO_STRUCT_OFFSET (MonoArray, max_length));
1371 mono_mb_emit_ldarg (mb, 1);
1372 #ifdef MONO_BIG_ARRAYS
1373 mono_mb_emit_byte (mb, CEE_STIND_I);
1375 mono_mb_emit_byte (mb, CEE_STIND_I4);
1377 } else if (atype == ATYPE_STRING) {
1378 /* need to set length and clear the last char */
1379 /* s->length = len; */
1380 mono_mb_emit_ldloc (mb, p_var);
1381 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoString, length));
1382 mono_mb_emit_byte (mb, MONO_CEE_ADD);
1383 mono_mb_emit_ldarg (mb, 1);
1384 mono_mb_emit_byte (mb, MONO_CEE_STIND_I4);
1385 /* s->chars [len] = 0; */
1386 mono_mb_emit_ldloc (mb, p_var);
1387 mono_mb_emit_ldloc (mb, size_var);
1388 mono_mb_emit_icon (mb, 2);
1389 mono_mb_emit_byte (mb, MONO_CEE_SUB);
1390 mono_mb_emit_byte (mb, MONO_CEE_ADD);
1391 mono_mb_emit_icon (mb, 0);
1392 mono_mb_emit_byte (mb, MONO_CEE_STIND_I2);
1396 We must make sure both vtable and max_length are globaly visible before returning to managed land.
1398 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1399 mono_mb_emit_byte (mb, CEE_MONO_MEMORY_BARRIER);
1400 mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_REL);
1403 mono_mb_emit_ldloc (mb, p_var);
1406 mono_mb_emit_byte (mb, CEE_RET);
1409 info = mono_wrapper_info_create (mb, WRAPPER_SUBTYPE_NONE);
1410 info->d.alloc.gc_name = "sgen";
1411 info->d.alloc.alloc_type = atype;
1414 mb->init_locals = FALSE;
1417 res = mono_mb_create (mb, csig, 8, info);
1426 mono_gc_get_aligned_size_for_allocator (int size)
1428 return SGEN_ALIGN_UP (size);
1432 * Generate an allocator method implementing the fast path of mono_gc_alloc_obj ().
1433 * The signature of the called method is:
1434 * object allocate (MonoVTable *vtable)
1437 mono_gc_get_managed_allocator (MonoClass *klass, gboolean for_box, gboolean known_instance_size)
1439 #ifdef MANAGED_ALLOCATION
1440 if (collect_before_allocs)
1442 if (!mono_runtime_has_tls_get ())
1444 if (klass->instance_size > tlab_size)
1446 if (known_instance_size && ALIGN_TO (klass->instance_size, SGEN_ALLOC_ALIGN) >= SGEN_MAX_SMALL_OBJ_SIZE)
1448 if (mono_class_has_finalizer (klass) || mono_class_is_marshalbyref (klass) || (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS))
1452 if (klass->byval_arg.type == MONO_TYPE_STRING)
1453 return mono_gc_get_managed_allocator_by_type (ATYPE_STRING, FALSE);
1454 /* Generic classes have dynamic field and can go above MAX_SMALL_OBJ_SIZE. */
1455 if (known_instance_size)
1456 return mono_gc_get_managed_allocator_by_type (ATYPE_SMALL, FALSE);
1458 return mono_gc_get_managed_allocator_by_type (ATYPE_NORMAL, FALSE);
1465 mono_gc_get_managed_array_allocator (MonoClass *klass)
1467 #ifdef MANAGED_ALLOCATION
1468 if (klass->rank != 1)
1470 if (!mono_runtime_has_tls_get ())
1472 if (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS)
1474 if (has_per_allocation_action)
1476 g_assert (!mono_class_has_finalizer (klass) && !mono_class_is_marshalbyref (klass));
1478 return mono_gc_get_managed_allocator_by_type (ATYPE_VECTOR, FALSE);
1485 sgen_set_use_managed_allocator (gboolean flag)
1487 use_managed_allocator = flag;
1491 mono_gc_get_managed_allocator_by_type (int atype, gboolean slowpath)
1493 #ifdef MANAGED_ALLOCATION
1495 MonoMethod **cache = slowpath ? slowpath_alloc_method_cache : alloc_method_cache;
1497 if (!use_managed_allocator)
1500 if (!mono_runtime_has_tls_get ())
1503 res = cache [atype];
1507 res = create_allocator (atype, slowpath);
1509 if (cache [atype]) {
1510 mono_free_method (res);
1511 res = cache [atype];
1513 mono_memory_barrier ();
1514 cache [atype] = res;
1525 mono_gc_get_managed_allocator_types (void)
1531 sgen_is_managed_allocator (MonoMethod *method)
1535 for (i = 0; i < ATYPE_NUM; ++i)
1536 if (method == alloc_method_cache [i] || method == slowpath_alloc_method_cache [i])
1542 sgen_has_managed_allocator (void)
1546 for (i = 0; i < ATYPE_NUM; ++i)
1547 if (alloc_method_cache [i] || slowpath_alloc_method_cache [i])
1553 * Cardtable scanning
1556 #define MWORD_MASK (sizeof (mword) - 1)
1559 find_card_offset (mword card)
1561 /*XXX Use assembly as this generates some pretty bad code */
1562 #if defined(__i386__) && defined(__GNUC__)
1563 return (__builtin_ffs (card) - 1) / 8;
1564 #elif defined(__x86_64__) && defined(__GNUC__)
1565 return (__builtin_ffsll (card) - 1) / 8;
1566 #elif defined(__s390x__)
1567 return (__builtin_ffsll (GUINT64_TO_LE(card)) - 1) / 8;
1570 guint8 *ptr = (guint8 *) &card;
1571 for (i = 0; i < sizeof (mword); ++i) {
1580 find_next_card (guint8 *card_data, guint8 *end)
1582 mword *cards, *cards_end;
1585 while ((((mword)card_data) & MWORD_MASK) && card_data < end) {
1591 if (card_data == end)
1594 cards = (mword*)card_data;
1595 cards_end = (mword*)((mword)end & ~MWORD_MASK);
1596 while (cards < cards_end) {
1599 return (guint8*)cards + find_card_offset (card);
1603 card_data = (guint8*)cards_end;
1604 while (card_data < end) {
1613 #define ARRAY_OBJ_INDEX(ptr,array,elem_size) (((char*)(ptr) - ((char*)(array) + G_STRUCT_OFFSET (MonoArray, vector))) / (elem_size))
1616 sgen_client_cardtable_scan_object (GCObject *obj, mword block_obj_size, guint8 *cards, gboolean mod_union, ScanCopyContext ctx)
1618 MonoVTable *vt = SGEN_LOAD_VTABLE (obj);
1619 MonoClass *klass = vt->klass;
1621 SGEN_ASSERT (0, SGEN_VTABLE_HAS_REFERENCES (vt), "Why would we ever call this on reference-free objects?");
1624 MonoArray *arr = (MonoArray*)obj;
1625 guint8 *card_data, *card_base;
1626 guint8 *card_data_end;
1627 char *obj_start = (char *)sgen_card_table_align_pointer (obj);
1629 mword obj_size = sgen_mono_array_size (vt, arr, &bounds_size, sgen_vtable_get_descriptor (vt));
1630 /* We don't want to scan the bounds entries at the end of multidimensional arrays */
1631 char *obj_end = (char*)obj + obj_size - bounds_size;
1633 size_t extra_idx = 0;
1635 mword desc = (mword)klass->element_class->gc_descr;
1636 int elem_size = mono_array_element_size (klass);
1638 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1639 guint8 *overflow_scan_end = NULL;
1642 #ifdef SGEN_OBJECT_LAYOUT_STATISTICS
1643 if (klass->element_class->valuetype)
1644 sgen_object_layout_scanned_vtype_array ();
1646 sgen_object_layout_scanned_ref_array ();
1652 card_data = sgen_card_table_get_card_scan_address ((mword)obj);
1654 card_base = card_data;
1655 card_count = sgen_card_table_number_of_cards_in_range ((mword)obj, obj_size);
1656 card_data_end = card_data + card_count;
1659 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1660 /*Check for overflow and if so, setup to scan in two steps*/
1661 if (!cards && card_data_end >= SGEN_SHADOW_CARDTABLE_END) {
1662 overflow_scan_end = sgen_shadow_cardtable + (card_data_end - SGEN_SHADOW_CARDTABLE_END);
1663 card_data_end = SGEN_SHADOW_CARDTABLE_END;
1669 card_data = find_next_card (card_data, card_data_end);
1670 for (; card_data < card_data_end; card_data = find_next_card (card_data + 1, card_data_end)) {
1672 size_t idx = (card_data - card_base) + extra_idx;
1673 char *start = (char*)(obj_start + idx * CARD_SIZE_IN_BYTES);
1674 char *card_end = start + CARD_SIZE_IN_BYTES;
1675 char *first_elem, *elem;
1677 HEAVY_STAT (++los_marked_cards);
1680 sgen_card_table_prepare_card_for_scanning (card_data);
1682 card_end = MIN (card_end, obj_end);
1684 if (start <= (char*)arr->vector)
1687 index = ARRAY_OBJ_INDEX (start, obj, elem_size);
1689 elem = first_elem = (char*)mono_array_addr_with_size_fast ((MonoArray*)obj, elem_size, index);
1690 if (klass->element_class->valuetype) {
1691 ScanVTypeFunc scan_vtype_func = ctx.ops->scan_vtype;
1693 for (; elem < card_end; elem += elem_size)
1694 scan_vtype_func (obj, elem, desc, ctx.queue BINARY_PROTOCOL_ARG (elem_size));
1696 CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
1698 HEAVY_STAT (++los_array_cards);
1699 for (; elem < card_end; elem += SIZEOF_VOID_P) {
1701 gpointer old = *(gpointer*)elem;
1702 if ((mod_union && old) || G_UNLIKELY (sgen_ptr_in_nursery (old))) {
1703 HEAVY_STAT (++los_array_remsets);
1704 copy_func ((GCObject**)elem, ctx.queue);
1705 new_ = *(GCObject **)elem;
1706 if (G_UNLIKELY (sgen_ptr_in_nursery (new_)))
1707 sgen_add_to_global_remset (elem, new_);
1712 binary_protocol_card_scan (first_elem, elem - first_elem);
1715 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1716 if (overflow_scan_end) {
1717 extra_idx = card_data - card_base;
1718 card_base = card_data = sgen_shadow_cardtable;
1719 card_data_end = overflow_scan_end;
1720 overflow_scan_end = NULL;
1731 * Array and string allocation
1735 mono_gc_alloc_vector (MonoVTable *vtable, size_t size, uintptr_t max_length)
1740 if (!SGEN_CAN_ALIGN_UP (size))
1743 #ifndef DISABLE_CRITICAL_REGION
1744 ENTER_CRITICAL_REGION;
1745 arr = (MonoArray*)sgen_try_alloc_obj_nolock (vtable, size);
1747 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1748 arr->max_length = (mono_array_size_t)max_length;
1749 EXIT_CRITICAL_REGION;
1752 EXIT_CRITICAL_REGION;
1757 arr = (MonoArray*)sgen_alloc_obj_nolock (vtable, size);
1758 if (G_UNLIKELY (!arr)) {
1763 arr->max_length = (mono_array_size_t)max_length;
1768 if (G_UNLIKELY (alloc_events))
1769 mono_profiler_allocation (&arr->obj);
1771 SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size (vtable, (GCObject*)arr)), "Vector has incorrect size.");
1776 mono_gc_alloc_array (MonoVTable *vtable, size_t size, uintptr_t max_length, uintptr_t bounds_size)
1779 MonoArrayBounds *bounds;
1782 if (!SGEN_CAN_ALIGN_UP (size))
1785 #ifndef DISABLE_CRITICAL_REGION
1786 ENTER_CRITICAL_REGION;
1787 arr = (MonoArray*)sgen_try_alloc_obj_nolock (vtable, size);
1789 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1790 arr->max_length = (mono_array_size_t)max_length;
1792 bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1793 arr->bounds = bounds;
1794 EXIT_CRITICAL_REGION;
1797 EXIT_CRITICAL_REGION;
1802 arr = (MonoArray*)sgen_alloc_obj_nolock (vtable, size);
1803 if (G_UNLIKELY (!arr)) {
1808 arr->max_length = (mono_array_size_t)max_length;
1810 bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1811 arr->bounds = bounds;
1816 if (G_UNLIKELY (alloc_events))
1817 mono_profiler_allocation (&arr->obj);
1819 SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size (vtable, (GCObject*)arr)), "Array has incorrect size.");
1824 mono_gc_alloc_string (MonoVTable *vtable, size_t size, gint32 len)
1829 if (!SGEN_CAN_ALIGN_UP (size))
1832 #ifndef DISABLE_CRITICAL_REGION
1833 ENTER_CRITICAL_REGION;
1834 str = (MonoString*)sgen_try_alloc_obj_nolock (vtable, size);
1836 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1838 EXIT_CRITICAL_REGION;
1841 EXIT_CRITICAL_REGION;
1846 str = (MonoString*)sgen_alloc_obj_nolock (vtable, size);
1847 if (G_UNLIKELY (!str)) {
1857 if (G_UNLIKELY (alloc_events))
1858 mono_profiler_allocation (&str->object);
1868 mono_gc_set_string_length (MonoString *str, gint32 new_length)
1870 mono_unichar2 *new_end = str->chars + new_length;
1872 /* zero the discarded string. This null-delimits the string and allows
1873 * the space to be reclaimed by SGen. */
1875 if (nursery_canaries_enabled () && sgen_ptr_in_nursery (str)) {
1876 CHECK_CANARY_FOR_OBJECT ((GCObject*)str, TRUE);
1877 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2) + CANARY_SIZE);
1878 memcpy (new_end + 1 , CANARY_STRING, CANARY_SIZE);
1880 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2));
1883 str->length = new_length;
1890 #define GC_ROOT_NUM 32
1892 int count; /* must be the first field */
1893 void *objects [GC_ROOT_NUM];
1894 int root_types [GC_ROOT_NUM];
1895 uintptr_t extra_info [GC_ROOT_NUM];
1899 notify_gc_roots (GCRootReport *report)
1903 mono_profiler_gc_roots (report->count, report->objects, report->root_types, report->extra_info);
1908 add_profile_gc_root (GCRootReport *report, void *object, int rtype, uintptr_t extra_info)
1910 if (report->count == GC_ROOT_NUM)
1911 notify_gc_roots (report);
1912 report->objects [report->count] = object;
1913 report->root_types [report->count] = rtype;
1914 report->extra_info [report->count++] = (uintptr_t)SGEN_LOAD_VTABLE (object)->klass;
1918 sgen_client_nursery_objects_pinned (void **definitely_pinned, int count)
1920 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS) {
1921 GCRootReport report;
1924 for (idx = 0; idx < count; ++idx)
1925 add_profile_gc_root (&report, definitely_pinned [idx], MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
1926 notify_gc_roots (&report);
1931 report_finalizer_roots_from_queue (SgenPointerQueue *queue)
1933 GCRootReport report;
1937 for (i = 0; i < queue->next_slot; ++i) {
1938 void *obj = queue->data [i];
1941 add_profile_gc_root (&report, obj, MONO_PROFILE_GC_ROOT_FINALIZER, 0);
1943 notify_gc_roots (&report);
1947 report_finalizer_roots (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
1949 report_finalizer_roots_from_queue (fin_ready_queue);
1950 report_finalizer_roots_from_queue (critical_fin_queue);
1953 static GCRootReport *root_report;
1956 single_arg_report_root (MonoObject **obj, void *gc_data)
1959 add_profile_gc_root (root_report, *obj, MONO_PROFILE_GC_ROOT_OTHER, 0);
1963 precisely_report_roots_from (GCRootReport *report, void** start_root, void** end_root, mword desc)
1965 switch (desc & ROOT_DESC_TYPE_MASK) {
1966 case ROOT_DESC_BITMAP:
1967 desc >>= ROOT_DESC_TYPE_SHIFT;
1969 if ((desc & 1) && *start_root) {
1970 add_profile_gc_root (report, *start_root, MONO_PROFILE_GC_ROOT_OTHER, 0);
1976 case ROOT_DESC_COMPLEX: {
1977 gsize *bitmap_data = (gsize *)sgen_get_complex_descriptor_bitmap (desc);
1978 gsize bwords = (*bitmap_data) - 1;
1979 void **start_run = start_root;
1981 while (bwords-- > 0) {
1982 gsize bmap = *bitmap_data++;
1983 void **objptr = start_run;
1985 if ((bmap & 1) && *objptr) {
1986 add_profile_gc_root (report, *objptr, MONO_PROFILE_GC_ROOT_OTHER, 0);
1991 start_run += GC_BITS_PER_WORD;
1995 case ROOT_DESC_USER: {
1996 MonoGCRootMarkFunc marker = (MonoGCRootMarkFunc)sgen_get_user_descriptor_func (desc);
1997 root_report = report;
1998 marker ((MonoObject**)start_root, single_arg_report_root, NULL);
2001 case ROOT_DESC_RUN_LEN:
2002 g_assert_not_reached ();
2004 g_assert_not_reached ();
2009 report_registered_roots_by_type (int root_type)
2011 GCRootReport report;
2015 SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], void **, start_root, RootRecord *, root) {
2016 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
2017 precisely_report_roots_from (&report, start_root, (void**)root->end_root, root->root_desc);
2018 } SGEN_HASH_TABLE_FOREACH_END;
2019 notify_gc_roots (&report);
2023 report_registered_roots (void)
2025 report_registered_roots_by_type (ROOT_TYPE_NORMAL);
2026 report_registered_roots_by_type (ROOT_TYPE_WBARRIER);
2030 sgen_client_collecting_minor (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
2032 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2033 report_registered_roots ();
2034 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2035 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
2038 static GCRootReport major_root_report;
2039 static gboolean profile_roots;
2042 sgen_client_collecting_major_1 (void)
2044 profile_roots = mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS;
2045 memset (&major_root_report, 0, sizeof (GCRootReport));
2049 sgen_client_pinned_los_object (GCObject *obj)
2052 add_profile_gc_root (&major_root_report, (char*)obj, MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
2056 sgen_client_collecting_major_2 (void)
2059 notify_gc_roots (&major_root_report);
2061 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2062 report_registered_roots ();
2066 sgen_client_collecting_major_3 (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
2068 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2069 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
2072 #define MOVED_OBJECTS_NUM 64
2073 static void *moved_objects [MOVED_OBJECTS_NUM];
2074 static int moved_objects_idx = 0;
2077 mono_sgen_register_moved_object (void *obj, void *destination)
2079 g_assert (mono_profiler_events & MONO_PROFILE_GC_MOVES);
2081 if (moved_objects_idx == MOVED_OBJECTS_NUM) {
2082 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2083 moved_objects_idx = 0;
2085 moved_objects [moved_objects_idx++] = obj;
2086 moved_objects [moved_objects_idx++] = destination;
2090 mono_sgen_gc_event_moves (void)
2092 if (moved_objects_idx) {
2093 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2094 moved_objects_idx = 0;
2102 #define REFS_SIZE 128
2105 MonoGCReferences callback;
2109 MonoObject *refs [REFS_SIZE];
2110 uintptr_t offsets [REFS_SIZE];
2114 #define HANDLE_PTR(ptr,obj) do { \
2116 if (hwi->count == REFS_SIZE) { \
2117 hwi->callback ((MonoObject*)start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data); \
2121 hwi->offsets [hwi->count] = (char*)(ptr)-(char*)start; \
2122 hwi->refs [hwi->count++] = *(ptr); \
2127 collect_references (HeapWalkInfo *hwi, GCObject *obj, size_t size)
2129 char *start = (char*)obj;
2130 mword desc = sgen_obj_get_descriptor (obj);
2132 #include "sgen/sgen-scan-object.h"
2136 walk_references (GCObject *start, size_t size, void *data)
2138 HeapWalkInfo *hwi = (HeapWalkInfo *)data;
2141 collect_references (hwi, start, size);
2142 if (hwi->count || !hwi->called)
2143 hwi->callback (start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);
2147 * mono_gc_walk_heap:
2148 * @flags: flags for future use
2149 * @callback: a function pointer called for each object in the heap
2150 * @data: a user data pointer that is passed to callback
2152 * This function can be used to iterate over all the live objects in the heap:
2153 * for each object, @callback is invoked, providing info about the object's
2154 * location in memory, its class, its size and the objects it references.
2155 * For each referenced object it's offset from the object address is
2156 * reported in the offsets array.
2157 * The object references may be buffered, so the callback may be invoked
2158 * multiple times for the same object: in all but the first call, the size
2159 * argument will be zero.
2160 * Note that this function can be only called in the #MONO_GC_EVENT_PRE_START_WORLD
2161 * profiler event handler.
2163 * Returns: a non-zero value if the GC doesn't support heap walking
2166 mono_gc_walk_heap (int flags, MonoGCReferences callback, void *data)
2171 hwi.callback = callback;
2174 sgen_clear_nursery_fragments ();
2175 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data, walk_references, &hwi, FALSE, TRUE);
2177 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, walk_references, &hwi);
2178 sgen_los_iterate_objects (walk_references, &hwi);
2188 mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks)
2190 gc_callbacks = *callbacks;
2194 mono_gc_get_gc_callbacks ()
2196 return &gc_callbacks;
2200 sgen_client_thread_register (SgenThreadInfo* info, void *stack_bottom_fallback)
2203 guint8 *staddr = NULL;
2205 #ifndef HAVE_KW_THREAD
2206 g_assert (!mono_native_tls_get_value (thread_info_key));
2207 mono_native_tls_set_value (thread_info_key, info);
2209 sgen_thread_info = info;
2212 info->client_info.skip = 0;
2213 info->client_info.stopped_ip = NULL;
2214 info->client_info.stopped_domain = NULL;
2216 info->client_info.stack_start = NULL;
2218 #ifdef SGEN_POSIX_STW
2219 info->client_info.stop_count = -1;
2220 info->client_info.signal = 0;
2223 /* On win32, stack_start_limit should be 0, since the stack can grow dynamically */
2224 mono_thread_info_get_stack_bounds (&staddr, &stsize);
2227 info->client_info.stack_start_limit = staddr;
2229 info->client_info.stack_end = staddr + stsize;
2231 gsize stack_bottom = (gsize)stack_bottom_fallback;
2232 stack_bottom += 4095;
2233 stack_bottom &= ~4095;
2234 info->client_info.stack_end = (char*)stack_bottom;
2238 memset (&info->client_info.ctx, 0, sizeof (MonoContext));
2240 memset (&info->client_info.regs, 0, sizeof (info->client_info.regs));
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);
2252 sgen_client_thread_unregister (SgenThreadInfo *p)
2254 MonoNativeThreadId tid;
2256 #ifndef HAVE_KW_THREAD
2257 mono_native_tls_set_value (thread_info_key, NULL);
2259 sgen_thread_info = NULL;
2262 tid = mono_thread_info_get_tid (p);
2264 if (p->client_info.info.runtime_thread)
2265 mono_threads_add_joinable_thread ((gpointer)tid);
2267 if (mono_gc_get_gc_callbacks ()->thread_detach_func) {
2268 mono_gc_get_gc_callbacks ()->thread_detach_func (p->client_info.runtime_data);
2269 p->client_info.runtime_data = NULL;
2272 binary_protocol_thread_unregister ((gpointer)tid);
2273 SGEN_LOG (3, "unregister thread %p (%p)", p, (gpointer)tid);
2277 mono_gc_set_skip_thread (gboolean skip)
2279 SgenThreadInfo *info = mono_thread_info_current ();
2282 info->client_info.gc_disabled = skip;
2287 is_critical_method (MonoMethod *method)
2289 return mono_runtime_is_critical_method (method) || sgen_is_critical_method (method);
2293 thread_in_critical_region (SgenThreadInfo *info)
2295 return info->client_info.in_critical_region;
2299 sgen_thread_attach (SgenThreadInfo *info)
2301 mono_handle_arena_init ((MonoHandleArena**) &info->client_info.info.handle_arena);
2303 if (mono_gc_get_gc_callbacks ()->thread_attach_func && !info->client_info.runtime_data)
2304 info->client_info.runtime_data = mono_gc_get_gc_callbacks ()->thread_attach_func ();
2308 sgen_thread_detach (SgenThreadInfo *p)
2310 /* If a delegate is passed to native code and invoked on a thread we dont
2311 * know about, the jit will register it with mono_jit_thread_attach, but
2312 * we have no way of knowing when that thread goes away. SGen has a TSD
2313 * so we assume that if the domain is still registered, we can detach
2316 if (mono_domain_get ())
2317 mono_thread_detach_internal (mono_thread_internal_current ());
2319 mono_handle_arena_cleanup ((MonoHandleArena**) &p->client_info.info.handle_arena);
2323 mono_gc_register_thread (void *baseptr)
2325 return mono_thread_info_attach (baseptr) != NULL;
2329 mono_gc_is_gc_thread (void)
2333 result = mono_thread_info_current () != NULL;
2339 sgen_client_thread_register_worker (void)
2341 mono_thread_info_register_small_id ();
2344 /* Variables holding start/end nursery so it won't have to be passed at every call */
2345 static void *scan_area_arg_start, *scan_area_arg_end;
2348 mono_gc_conservatively_scan_area (void *start, void *end)
2350 sgen_conservatively_pin_objects_from ((void **)start, (void **)end, scan_area_arg_start, scan_area_arg_end, PIN_TYPE_STACK);
2354 mono_gc_scan_object (void *obj, void *gc_data)
2356 ScanCopyContext *ctx = (ScanCopyContext *)gc_data;
2357 ctx->ops->copy_or_mark_object ((GCObject**)&obj, ctx->queue);
2362 * Mark from thread stacks and registers.
2365 sgen_client_scan_thread_data (void *start_nursery, void *end_nursery, gboolean precise, ScanCopyContext ctx)
2367 scan_area_arg_start = start_nursery;
2368 scan_area_arg_end = end_nursery;
2370 FOREACH_THREAD (info) {
2371 int skip_reason = 0;
2372 void *aligned_stack_start = (void*)(mword) ALIGN_TO ((mword)info->client_info.stack_start, SIZEOF_VOID_P);
2374 if (info->client_info.skip) {
2375 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);
2377 } else if (info->client_info.gc_disabled) {
2378 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);
2380 } else if (!mono_thread_info_is_live (info)) {
2381 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);
2385 binary_protocol_scan_stack ((gpointer)mono_thread_info_get_tid (info), info->client_info.stack_start, info->client_info.stack_end, skip_reason);
2390 g_assert (info->client_info.suspend_done);
2391 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 ());
2392 if (mono_gc_get_gc_callbacks ()->thread_mark_func && !conservative_stack_mark) {
2393 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);
2394 } else if (!precise) {
2395 if (!conservative_stack_mark) {
2396 fprintf (stderr, "Precise stack mark not supported - disabling.\n");
2397 conservative_stack_mark = TRUE;
2399 sgen_conservatively_pin_objects_from ((void **)aligned_stack_start, (void **)info->client_info.stack_end, start_nursery, end_nursery, PIN_TYPE_STACK);
2404 sgen_conservatively_pin_objects_from ((void**)&info->client_info.ctx, (void**)(&info->client_info.ctx + 1),
2405 start_nursery, end_nursery, PIN_TYPE_STACK);
2407 sgen_conservatively_pin_objects_from ((void**)&info->client_info.regs, (void**)&info->client_info.regs + ARCH_NUM_REGS,
2408 start_nursery, end_nursery, PIN_TYPE_STACK);
2411 // This is used on Coop GC for platforms where we cannot get the data for individual registers.
2412 // We force a spill of all registers into the stack and pass a chunk of data into sgen.
2413 MonoThreadUnwindState *state = &info->client_info.info.thread_saved_state [SELF_SUSPEND_STATE_INDEX];
2414 if (state && state->gc_stackdata) {
2415 sgen_conservatively_pin_objects_from ((void **)state->gc_stackdata, (void**)((char*)state->gc_stackdata + state->gc_stackdata_size),
2416 start_nursery, end_nursery, PIN_TYPE_STACK);
2420 } FOREACH_THREAD_END
2424 * mono_gc_set_stack_end:
2426 * Set the end of the current threads stack to STACK_END. The stack space between
2427 * STACK_END and the real end of the threads stack will not be scanned during collections.
2430 mono_gc_set_stack_end (void *stack_end)
2432 SgenThreadInfo *info;
2435 info = mono_thread_info_current ();
2437 SGEN_ASSERT (0, stack_end < info->client_info.stack_end, "Can only lower stack end");
2438 info->client_info.stack_end = stack_end;
2448 mono_gc_register_root (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
2450 return sgen_register_root (start, size, descr, descr ? ROOT_TYPE_NORMAL : ROOT_TYPE_PINNED, source, msg);
2454 mono_gc_register_root_wbarrier (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
2456 return sgen_register_root (start, size, descr, ROOT_TYPE_WBARRIER, source, msg);
2460 mono_gc_deregister_root (char* addr)
2462 sgen_deregister_root (addr);
2471 mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
2473 return pthread_create (new_thread, attr, start_routine, arg);
2482 sgen_client_total_allocated_heap_changed (size_t allocated_heap)
2484 mono_runtime_resource_check_limit (MONO_RESOURCE_GC_HEAP, allocated_heap);
2488 mono_gc_user_markers_supported (void)
2494 mono_object_is_alive (MonoObject* o)
2500 mono_gc_get_generation (MonoObject *obj)
2502 if (sgen_ptr_in_nursery (obj))
2508 mono_gc_enable_events (void)
2513 mono_gc_get_gc_name (void)
2519 mono_gc_get_description (void)
2521 return g_strdup ("sgen");
2525 mono_gc_set_desktop_mode (void)
2530 mono_gc_is_moving (void)
2536 mono_gc_is_disabled (void)
2542 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved)
2549 mono_gc_max_generation (void)
2555 mono_gc_precise_stack_mark_enabled (void)
2557 return !conservative_stack_mark;
2561 mono_gc_collect (int generation)
2563 sgen_gc_collect (generation);
2567 mono_gc_collection_count (int generation)
2569 return sgen_gc_collection_count (generation);
2573 mono_gc_get_used_size (void)
2575 return (int64_t)sgen_gc_get_used_size ();
2579 mono_gc_get_heap_size (void)
2581 return (int64_t)sgen_gc_get_total_heap_allocation ();
2585 mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker)
2587 return sgen_make_user_root_descriptor (marker);
2591 mono_gc_make_descr_for_string (gsize *bitmap, int numbits)
2593 return SGEN_DESC_STRING;
2597 mono_gc_get_nursery (int *shift_bits, size_t *size)
2599 *size = sgen_nursery_size;
2600 *shift_bits = DEFAULT_NURSERY_BITS;
2601 return sgen_get_nursery_start ();
2605 mono_gc_get_los_limit (void)
2607 return SGEN_MAX_SMALL_OBJ_SIZE;
2611 sgen_client_default_metadata (void)
2613 return mono_domain_get ();
2617 sgen_client_metadata_for_object (GCObject *obj)
2619 return mono_object_domain (obj);
2623 * mono_gchandle_is_in_domain:
2624 * @gchandle: a GCHandle's handle.
2625 * @domain: An application domain.
2627 * Returns: TRUE if the object wrapped by the @gchandle belongs to the specific @domain.
2630 mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain)
2632 MonoDomain *gchandle_domain = (MonoDomain *)sgen_gchandle_get_metadata (gchandle);
2633 return domain->domain_id == gchandle_domain->domain_id;
2637 * mono_gchandle_free_domain:
2638 * @unloading: domain that is unloading
2640 * Function used internally to cleanup any GC handle for objects belonging
2641 * to the specified domain during appdomain unload.
2644 mono_gchandle_free_domain (MonoDomain *unloading)
2649 null_link_if_in_domain (gpointer hidden, GCHandleType handle_type, int max_generation, gpointer user)
2651 MonoDomain *unloading_domain = (MonoDomain *)user;
2652 MonoDomain *obj_domain;
2653 gboolean is_weak = MONO_GC_HANDLE_TYPE_IS_WEAK (handle_type);
2654 if (MONO_GC_HANDLE_IS_OBJECT_POINTER (hidden)) {
2655 MonoObject *obj = (MonoObject *)MONO_GC_REVEAL_POINTER (hidden, is_weak);
2656 obj_domain = mono_object_domain (obj);
2658 obj_domain = (MonoDomain *)MONO_GC_REVEAL_POINTER (hidden, is_weak);
2660 if (unloading_domain->domain_id == obj_domain->domain_id)
2666 sgen_null_links_for_domain (MonoDomain *domain)
2669 for (type = HANDLE_TYPE_MIN; type < HANDLE_TYPE_MAX; ++type)
2670 sgen_gchandle_iterate ((GCHandleType)type, GENERATION_OLD, null_link_if_in_domain, domain);
2674 mono_gchandle_set_target (guint32 gchandle, MonoObject *obj)
2676 sgen_gchandle_set_target (gchandle, obj);
2680 sgen_client_gchandle_created (int handle_type, GCObject *obj, guint32 handle)
2682 #ifndef DISABLE_PERFCOUNTERS
2683 mono_perfcounters->gc_num_handles++;
2685 mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_CREATED, handle_type, handle, obj);
2689 sgen_client_gchandle_destroyed (int handle_type, guint32 handle)
2691 #ifndef DISABLE_PERFCOUNTERS
2692 mono_perfcounters->gc_num_handles--;
2694 mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_DESTROYED, handle_type, handle, NULL);
2698 sgen_client_ensure_weak_gchandles_accessible (void)
2701 * During the second bridge processing step the world is
2702 * running again. That step processes all weak links once
2703 * more to null those that refer to dead objects. Before that
2704 * is completed, those links must not be followed, so we
2705 * conservatively wait for bridge processing when any weak
2706 * link is dereferenced.
2708 /* FIXME: A GC can occur after this check fails, in which case we
2709 * should wait for bridge processing but would fail to do so.
2711 if (G_UNLIKELY (bridge_processing_in_progress))
2712 mono_gc_wait_for_bridge_processing ();
2716 mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data)
2720 result = func (data);
2721 UNLOCK_INTERRUPTION;
2726 mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size)
2732 mono_gc_get_card_table (int *shift_bits, gpointer *mask)
2734 return sgen_get_card_table_configuration (shift_bits, mask);
2738 mono_gc_card_table_nursery_check (void)
2740 return !sgen_get_major_collector ()->is_concurrent;
2743 /* Negative value to remove */
2745 mono_gc_add_memory_pressure (gint64 value)
2747 /* FIXME: Implement at some point? */
2755 sgen_client_degraded_allocation (size_t size)
2757 static int last_major_gc_warned = -1;
2758 static int num_degraded = 0;
2760 if (last_major_gc_warned < (int)gc_stats.major_gc_count) {
2762 if (num_degraded == 1 || num_degraded == 3)
2763 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Degraded allocation. Consider increasing nursery-size if the warning persists.");
2764 else if (num_degraded == 10)
2765 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Repeated degraded allocation. Consider increasing nursery-size.");
2766 last_major_gc_warned = gc_stats.major_gc_count;
2771 sgen_client_log_timing (GGTimingInfo *info, mword last_major_num_sections, mword last_los_memory_usage)
2773 SgenMajorCollector *major_collector = sgen_get_major_collector ();
2774 mword num_major_sections = major_collector->get_num_major_sections ();
2775 char full_timing_buff [1024];
2776 full_timing_buff [0] = '\0';
2778 if (!info->is_overflow)
2779 sprintf (full_timing_buff, "total %.2fms, bridge %.2fms", info->stw_time / 10000.0f, (int)info->bridge_time / 10000.0f);
2780 if (info->generation == GENERATION_OLD)
2781 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "GC_MAJOR%s: (%s) pause %.2fms, %s major %dK/%dK los %dK/%dK",
2782 info->is_overflow ? "_OVERFLOW" : "",
2783 info->reason ? info->reason : "",
2784 (int)info->total_time / 10000.0f,
2786 major_collector->section_size * num_major_sections / 1024,
2787 major_collector->section_size * last_major_num_sections / 1024,
2788 los_memory_usage / 1024,
2789 last_los_memory_usage / 1024);
2791 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "GC_MINOR%s: (%s) pause %.2fms, %s promoted %dK major %dK los %dK",
2792 info->is_overflow ? "_OVERFLOW" : "",
2793 info->reason ? info->reason : "",
2794 (int)info->total_time / 10000.0f,
2796 (num_major_sections - last_major_num_sections) * major_collector->section_size / 1024,
2797 major_collector->section_size * num_major_sections / 1024,
2798 los_memory_usage / 1024);
2806 sgen_client_description_for_internal_mem_type (int type)
2809 case INTERNAL_MEM_EPHEMERON_LINK: return "ephemeron-link";
2816 sgen_client_pre_collection_checks (void)
2818 if (sgen_mono_xdomain_checks) {
2819 sgen_clear_nursery_fragments ();
2820 sgen_check_for_xdomain_refs ();
2825 sgen_client_vtable_is_inited (MonoVTable *vt)
2827 return vt->klass->inited;
2831 sgen_client_vtable_get_namespace (MonoVTable *vt)
2833 return vt->klass->name_space;
2837 sgen_client_vtable_get_name (MonoVTable *vt)
2839 return vt->klass->name;
2847 sgen_client_init (void)
2850 MonoThreadInfoCallbacks cb;
2852 cb.thread_register = sgen_thread_register;
2853 cb.thread_detach = sgen_thread_detach;
2854 cb.thread_unregister = sgen_thread_unregister;
2855 cb.thread_attach = sgen_thread_attach;
2856 cb.mono_method_is_critical = (gboolean (*)(void *))is_critical_method;
2857 cb.mono_thread_in_critical_region = thread_in_critical_region;
2859 mono_threads_init (&cb, sizeof (SgenThreadInfo));
2861 ///* Keep this the default for now */
2862 /* Precise marking is broken on all supported targets. Disable until fixed. */
2863 conservative_stack_mark = TRUE;
2865 sgen_register_fixed_internal_mem_type (INTERNAL_MEM_EPHEMERON_LINK, sizeof (EphemeronLinkNode));
2867 mono_sgen_init_stw ();
2869 #ifndef HAVE_KW_THREAD
2870 mono_native_tls_alloc (&thread_info_key, NULL);
2871 #if defined(TARGET_OSX) || defined(TARGET_WIN32) || defined(TARGET_ANDROID) || defined(TARGET_IOS)
2873 * CEE_MONO_TLS requires the tls offset, not the key, so the code below only works on darwin,
2874 * where the two are the same.
2876 mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, thread_info_key);
2880 int tls_offset = -1;
2881 MONO_THREAD_VAR_OFFSET (sgen_thread_info, tls_offset);
2882 mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, tls_offset);
2887 * This needs to happen before any internal allocations because
2888 * it inits the small id which is required for hazard pointer
2893 mono_gc_register_thread (&dummy);
2897 sgen_client_handle_gc_param (const char *opt)
2899 if (g_str_has_prefix (opt, "stack-mark=")) {
2900 opt = strchr (opt, '=') + 1;
2901 if (!strcmp (opt, "precise")) {
2902 conservative_stack_mark = FALSE;
2903 } else if (!strcmp (opt, "conservative")) {
2904 conservative_stack_mark = TRUE;
2906 sgen_env_var_error (MONO_GC_PARAMS_NAME, conservative_stack_mark ? "Using `conservative`." : "Using `precise`.",
2907 "Invalid value `%s` for `stack-mark` option, possible values are: `precise`, `conservative`.", opt);
2909 } else if (g_str_has_prefix (opt, "bridge-implementation=")) {
2910 opt = strchr (opt, '=') + 1;
2911 sgen_set_bridge_implementation (opt);
2912 } else if (g_str_has_prefix (opt, "toggleref-test")) {
2913 /* FIXME: This should probably in MONO_GC_DEBUG */
2914 sgen_register_test_toggleref_callback ();
2922 sgen_client_print_gc_params_usage (void)
2924 fprintf (stderr, " stack-mark=MARK-METHOD (where MARK-METHOD is 'precise' or 'conservative')\n");
2928 sgen_client_handle_gc_debug (const char *opt)
2930 if (!strcmp (opt, "xdomain-checks")) {
2931 sgen_mono_xdomain_checks = TRUE;
2932 } else if (!strcmp (opt, "do-not-finalize")) {
2933 mono_do_not_finalize = TRUE;
2934 } else if (g_str_has_prefix (opt, "do-not-finalize=")) {
2935 opt = strchr (opt, '=') + 1;
2936 mono_do_not_finalize = TRUE;
2937 mono_do_not_finalize_class_names = g_strsplit (opt, ",", 0);
2938 } else if (!strcmp (opt, "log-finalizers")) {
2939 log_finalizers = TRUE;
2940 } else if (!strcmp (opt, "no-managed-allocator")) {
2941 sgen_set_use_managed_allocator (FALSE);
2942 } else if (!sgen_bridge_handle_gc_debug (opt)) {
2949 sgen_client_print_gc_debug_usage (void)
2951 fprintf (stderr, " xdomain-checks\n");
2952 fprintf (stderr, " do-not-finalize\n");
2953 fprintf (stderr, " log-finalizers\n");
2954 fprintf (stderr, " no-managed-allocator\n");
2955 sgen_bridge_print_gc_debug_usage ();
2960 sgen_client_get_provenance (void)
2962 #ifdef SGEN_OBJECT_PROVENANCE
2963 MonoGCCallbacks *cb = mono_gc_get_gc_callbacks ();
2964 gpointer (*get_provenance_func) (void);
2967 get_provenance_func = cb->get_provenance_func;
2968 if (get_provenance_func)
2969 return get_provenance_func ();
2977 sgen_client_describe_invalid_pointer (GCObject *ptr)
2979 sgen_bridge_describe_pointer (ptr);
2983 mono_gc_base_init (void)
2985 mono_counters_init ();
2987 #ifdef HEAVY_STATISTICS
2988 mono_counters_register ("los marked cards", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_marked_cards);
2989 mono_counters_register ("los array cards scanned ", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_cards);
2990 mono_counters_register ("los array remsets", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_remsets);
2992 mono_counters_register ("WBarrier set arrayref", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_set_arrayref);
2993 mono_counters_register ("WBarrier value copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_value_copy);
2994 mono_counters_register ("WBarrier object copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_object_copy);
2999 #if defined(HAVE_KW_THREAD)
3000 /* This can happen with using libmonosgen.so */
3001 if (mono_tls_key_get_offset (TLS_KEY_SGEN_TLAB_NEXT_ADDR) == -1)
3002 sgen_set_use_managed_allocator (FALSE);
3007 mono_gc_base_cleanup (void)
3012 mono_gc_is_null (void)