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-internal.h"
36 #include "metadata/gc-internal.h"
37 #include "utils/mono-memory-model.h"
38 #include "utils/mono-logger-internal.h"
40 #ifdef HEAVY_STATISTICS
41 static guint64 stat_wbarrier_set_arrayref = 0;
42 static guint64 stat_wbarrier_value_copy = 0;
43 static guint64 stat_wbarrier_object_copy = 0;
45 static guint64 los_marked_cards;
46 static guint64 los_array_cards;
47 static guint64 los_array_remsets;
50 /* If set, mark stacks conservatively, even if precise marking is possible */
51 static gboolean conservative_stack_mark = FALSE;
52 /* If set, check that there are no references to the domain left at domain unload */
53 gboolean sgen_mono_xdomain_checks = FALSE;
55 /* Functions supplied by the runtime to be called by the GC */
56 static MonoGCCallbacks gc_callbacks;
59 __thread SgenThreadInfo *sgen_thread_info;
61 MonoNativeTlsKey thread_info_key;
64 #define ALIGN_TO(val,align) ((((guint64)val) + ((align) - 1)) & ~((align) - 1))
66 #define OPDEF(a,b,c,d,e,f,g,h,i,j) \
70 #include "mono/cil/opcode.def"
81 ptr_on_stack (void *ptr)
83 gpointer stack_start = &stack_start;
84 SgenThreadInfo *info = mono_thread_info_current ();
86 if (ptr >= stack_start && ptr < (gpointer)info->client_info.stack_end)
91 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
93 #define HANDLE_PTR(ptr,obj) do { \
94 gpointer o = *(gpointer*)(ptr); \
96 gpointer d = ((char*)dest) + ((char*)(ptr) - (char*)(obj)); \
97 binary_protocol_wbarrier (d, o, (gpointer) SGEN_LOAD_VTABLE (o)); \
102 scan_object_for_binary_protocol_copy_wbarrier (gpointer dest, char *start, mword desc)
104 #define SCAN_OBJECT_NOVTABLE
105 #include "sgen/sgen-scan-object.h"
110 mono_gc_wbarrier_value_copy (gpointer dest, gpointer src, int count, MonoClass *klass)
112 HEAVY_STAT (++stat_wbarrier_value_copy);
113 g_assert (klass->valuetype);
115 SGEN_LOG (8, "Adding value remset at %p, count %d, descr %p for class %s (%p)", dest, count, klass->gc_descr, klass->name, klass);
117 if (sgen_ptr_in_nursery (dest) || ptr_on_stack (dest) || !sgen_gc_descr_has_references ((mword)klass->gc_descr)) {
118 size_t element_size = mono_class_value_size (klass, NULL);
119 size_t size = count * element_size;
120 mono_gc_memmove_atomic (dest, src, size);
124 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
125 if (binary_protocol_is_heavy_enabled ()) {
126 size_t element_size = mono_class_value_size (klass, NULL);
128 for (i = 0; i < count; ++i) {
129 scan_object_for_binary_protocol_copy_wbarrier ((char*)dest + i * element_size,
130 (char*)src + i * element_size - sizeof (MonoObject),
131 (mword) klass->gc_descr);
136 sgen_get_remset ()->wbarrier_value_copy (dest, src, count, mono_class_value_size (klass, NULL));
140 * mono_gc_wbarrier_object_copy:
142 * Write barrier to call when obj is the result of a clone or copy of an object.
145 mono_gc_wbarrier_object_copy (MonoObject* obj, MonoObject *src)
149 HEAVY_STAT (++stat_wbarrier_object_copy);
151 if (sgen_ptr_in_nursery (obj) || ptr_on_stack (obj) || !SGEN_OBJECT_HAS_REFERENCES (src)) {
152 size = mono_object_class (obj)->instance_size;
153 mono_gc_memmove_aligned ((char*)obj + sizeof (MonoObject), (char*)src + sizeof (MonoObject),
154 size - sizeof (MonoObject));
158 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
159 if (binary_protocol_is_heavy_enabled ())
160 scan_object_for_binary_protocol_copy_wbarrier (obj, (char*)src, (mword) src->vtable->gc_descr);
163 sgen_get_remset ()->wbarrier_object_copy (obj, src);
167 mono_gc_wbarrier_set_arrayref (MonoArray *arr, gpointer slot_ptr, MonoObject* value)
169 HEAVY_STAT (++stat_wbarrier_set_arrayref);
170 if (sgen_ptr_in_nursery (slot_ptr)) {
171 *(void**)slot_ptr = value;
174 SGEN_LOG (8, "Adding remset at %p", slot_ptr);
176 binary_protocol_wbarrier (slot_ptr, value, value->vtable);
178 sgen_get_remset ()->wbarrier_set_field ((GCObject*)arr, slot_ptr, value);
182 mono_gc_wbarrier_set_field (MonoObject *obj, gpointer field_ptr, MonoObject* value)
184 mono_gc_wbarrier_set_arrayref ((MonoArray*)obj, field_ptr, value);
188 mono_gc_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap)
190 sgen_wbarrier_value_copy_bitmap (_dest, _src, size, bitmap);
193 static MonoMethod *write_barrier_conc_method;
194 static MonoMethod *write_barrier_noconc_method;
197 sgen_is_critical_method (MonoMethod *method)
199 return (method == write_barrier_conc_method || method == write_barrier_noconc_method || sgen_is_managed_allocator (method));
203 sgen_has_critical_method (void)
205 return write_barrier_conc_method || write_barrier_noconc_method || sgen_has_managed_allocator ();
211 emit_nursery_check (MonoMethodBuilder *mb, int *nursery_check_return_labels, gboolean is_concurrent)
213 int shifted_nursery_start = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
215 memset (nursery_check_return_labels, 0, sizeof (int) * 2);
216 // if (ptr_in_nursery (ptr)) return;
218 * Masking out the bits might be faster, but we would have to use 64 bit
219 * immediates, which might be slower.
221 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
222 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_START);
223 mono_mb_emit_icon (mb, DEFAULT_NURSERY_BITS);
224 mono_mb_emit_byte (mb, CEE_SHR_UN);
225 mono_mb_emit_stloc (mb, shifted_nursery_start);
227 mono_mb_emit_ldarg (mb, 0);
228 mono_mb_emit_icon (mb, DEFAULT_NURSERY_BITS);
229 mono_mb_emit_byte (mb, CEE_SHR_UN);
230 mono_mb_emit_ldloc (mb, shifted_nursery_start);
231 nursery_check_return_labels [0] = mono_mb_emit_branch (mb, CEE_BEQ);
233 if (!is_concurrent) {
234 // if (!ptr_in_nursery (*ptr)) return;
235 mono_mb_emit_ldarg (mb, 0);
236 mono_mb_emit_byte (mb, CEE_LDIND_I);
237 mono_mb_emit_icon (mb, DEFAULT_NURSERY_BITS);
238 mono_mb_emit_byte (mb, CEE_SHR_UN);
239 mono_mb_emit_ldloc (mb, shifted_nursery_start);
240 nursery_check_return_labels [1] = mono_mb_emit_branch (mb, CEE_BNE_UN);
246 mono_gc_get_specific_write_barrier (gboolean is_concurrent)
249 MonoMethodBuilder *mb;
250 MonoMethodSignature *sig;
251 MonoMethod **write_barrier_method_addr;
252 #ifdef MANAGED_WBARRIER
253 int i, nursery_check_labels [2];
256 // FIXME: Maybe create a separate version for ctors (the branch would be
257 // correctly predicted more times)
259 write_barrier_method_addr = &write_barrier_conc_method;
261 write_barrier_method_addr = &write_barrier_noconc_method;
263 if (*write_barrier_method_addr)
264 return *write_barrier_method_addr;
266 /* Create the IL version of mono_gc_barrier_generic_store () */
267 sig = mono_metadata_signature_alloc (mono_defaults.corlib, 1);
268 sig->ret = &mono_defaults.void_class->byval_arg;
269 sig->params [0] = &mono_defaults.int_class->byval_arg;
272 mb = mono_mb_new (mono_defaults.object_class, "wbarrier_conc", MONO_WRAPPER_WRITE_BARRIER);
274 mb = mono_mb_new (mono_defaults.object_class, "wbarrier_noconc", MONO_WRAPPER_WRITE_BARRIER);
277 #ifdef MANAGED_WBARRIER
278 emit_nursery_check (mb, nursery_check_labels, is_concurrent);
280 addr = sgen_cardtable + ((address >> CARD_BITS) & CARD_MASK)
284 LDC_PTR sgen_cardtable
290 if (SGEN_HAVE_OVERLAPPING_CARDS) {
291 LDC_PTR card_table_mask
298 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
299 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_CARD_TABLE);
300 mono_mb_emit_ldarg (mb, 0);
301 mono_mb_emit_icon (mb, CARD_BITS);
302 mono_mb_emit_byte (mb, CEE_SHR_UN);
303 mono_mb_emit_byte (mb, CEE_CONV_I);
304 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
305 #if SIZEOF_VOID_P == 8
306 mono_mb_emit_icon8 (mb, CARD_MASK);
308 mono_mb_emit_icon (mb, CARD_MASK);
310 mono_mb_emit_byte (mb, CEE_CONV_I);
311 mono_mb_emit_byte (mb, CEE_AND);
313 mono_mb_emit_byte (mb, CEE_ADD);
314 mono_mb_emit_icon (mb, 1);
315 mono_mb_emit_byte (mb, CEE_STIND_I1);
318 for (i = 0; i < 2; ++i) {
319 if (nursery_check_labels [i])
320 mono_mb_patch_branch (mb, nursery_check_labels [i]);
322 mono_mb_emit_byte (mb, CEE_RET);
324 mono_mb_emit_ldarg (mb, 0);
325 mono_mb_emit_icall (mb, mono_gc_wbarrier_generic_nostore);
326 mono_mb_emit_byte (mb, CEE_RET);
329 res = mono_mb_create_method (mb, sig, 16);
333 if (*write_barrier_method_addr) {
334 /* Already created */
335 mono_free_method (res);
337 /* double-checked locking */
338 mono_memory_barrier ();
339 *write_barrier_method_addr = res;
343 return *write_barrier_method_addr;
347 mono_gc_get_write_barrier (void)
349 return mono_gc_get_specific_write_barrier (major_collector.is_concurrent);
353 * Dummy filler objects
356 /* Vtable of the objects used to fill out nursery fragments before a collection */
357 static GCVTable *array_fill_vtable;
360 get_array_fill_vtable (void)
362 if (!array_fill_vtable) {
363 static MonoClass klass;
364 static char _vtable[sizeof(MonoVTable)+8];
365 MonoVTable* vtable = (MonoVTable*) ALIGN_TO(_vtable, 8);
368 MonoDomain *domain = mono_get_root_domain ();
371 klass.element_class = mono_defaults.byte_class;
373 klass.instance_size = sizeof (MonoArray);
374 klass.sizes.element_size = 1;
375 klass.name = "array_filler_type";
377 vtable->klass = &klass;
379 vtable->gc_descr = mono_gc_make_descr_for_array (TRUE, &bmap, 0, 1);
382 array_fill_vtable = (GCVTable*)vtable;
384 return array_fill_vtable;
388 sgen_client_array_fill_range (char *start, size_t size)
392 if (size < sizeof (MonoArray)) {
393 memset (start, 0, size);
397 o = (MonoArray*)start;
398 o->obj.vtable = (MonoVTable*)get_array_fill_vtable ();
399 /* Mark this as not a real object */
400 o->obj.synchronisation = GINT_TO_POINTER (-1);
402 o->max_length = (mono_array_size_t)(size - sizeof (MonoArray));
408 sgen_client_zero_array_fill_header (void *p, size_t size)
410 if (size >= sizeof (MonoArray)) {
411 memset (p, 0, sizeof (MonoArray));
413 static guint8 zeros [sizeof (MonoArray)];
415 SGEN_ASSERT (0, !memcmp (p, zeros, size), "TLAB segment must be zeroed out.");
423 static MonoGCFinalizerCallbacks fin_callbacks;
426 mono_gc_get_vtable_bits (MonoClass *class)
429 /* FIXME move this to the bridge code */
430 if (sgen_need_bridge_processing ()) {
431 switch (sgen_bridge_class_kind (class)) {
432 case GC_BRIDGE_TRANSPARENT_BRIDGE_CLASS:
433 case GC_BRIDGE_OPAQUE_BRIDGE_CLASS:
434 res = SGEN_GC_BIT_BRIDGE_OBJECT;
436 case GC_BRIDGE_OPAQUE_CLASS:
437 res = SGEN_GC_BIT_BRIDGE_OPAQUE_OBJECT;
439 case GC_BRIDGE_TRANSPARENT_CLASS:
443 if (fin_callbacks.is_class_finalization_aware) {
444 if (fin_callbacks.is_class_finalization_aware (class))
445 res |= SGEN_GC_BIT_FINALIZER_AWARE;
451 is_finalization_aware (MonoObject *obj)
453 MonoVTable *vt = ((MonoVTable*)SGEN_LOAD_VTABLE (obj));
454 return (vt->gc_bits & SGEN_GC_BIT_FINALIZER_AWARE) == SGEN_GC_BIT_FINALIZER_AWARE;
458 sgen_client_object_queued_for_finalization (GCObject *obj)
460 if (fin_callbacks.object_queued_for_finalization && is_finalization_aware (obj))
461 fin_callbacks.object_queued_for_finalization (obj);
464 if (G_UNLIKELY (MONO_GC_FINALIZE_ENQUEUE_ENABLED ())) {
465 int gen = sgen_ptr_in_nursery (obj) ? GENERATION_NURSERY : GENERATION_OLD;
466 GCVTable *vt = (GCVTable*)SGEN_LOAD_VTABLE (obj);
467 MONO_GC_FINALIZE_ENQUEUE ((mword)obj, sgen_safe_object_get_size (obj),
468 sgen_client_vtable_get_namespace (vt), sgen_client_vtable_get_name (vt), gen,
469 sgen_client_object_has_critical_finalizer (obj));
475 mono_gc_register_finalizer_callbacks (MonoGCFinalizerCallbacks *callbacks)
477 if (callbacks->version != MONO_GC_FINALIZER_EXTENSION_VERSION)
478 g_error ("Invalid finalizer callback version. Expected %d but got %d\n", MONO_GC_FINALIZER_EXTENSION_VERSION, callbacks->version);
480 fin_callbacks = *callbacks;
484 sgen_client_run_finalize (MonoObject *obj)
486 mono_gc_run_finalize (obj, NULL);
490 mono_gc_invoke_finalizers (void)
492 return sgen_gc_invoke_finalizers ();
496 mono_gc_pending_finalizers (void)
498 return sgen_have_pending_finalizers ();
502 sgen_client_finalize_notify (void)
504 mono_gc_finalize_notify ();
508 mono_gc_register_for_finalization (MonoObject *obj, void *user_data)
510 sgen_object_register_for_finalization (obj, user_data);
514 object_in_domain_predicate (MonoObject *obj, void *user_data)
516 MonoDomain *domain = user_data;
517 if (mono_object_domain (obj) == domain) {
518 SGEN_LOG (5, "Unregistering finalizer for object: %p (%s)", obj, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj)));
525 * mono_gc_finalizers_for_domain:
526 * @domain: the unloading appdomain
527 * @out_array: output array
528 * @out_size: size of output array
530 * Store inside @out_array up to @out_size objects that belong to the unloading
531 * appdomain @domain. Returns the number of stored items. Can be called repeteadly
532 * until it returns 0.
533 * The items are removed from the finalizer data structure, so the caller is supposed
535 * @out_array should be on the stack to allow the GC to know the objects are still alive.
538 mono_gc_finalizers_for_domain (MonoDomain *domain, MonoObject **out_array, int out_size)
540 return sgen_gather_finalizers_if (object_in_domain_predicate, domain, out_array, out_size);
547 typedef struct _EphemeronLinkNode EphemeronLinkNode;
549 struct _EphemeronLinkNode {
550 EphemeronLinkNode *next;
559 static EphemeronLinkNode *ephemeron_list;
561 /* LOCKING: requires that the GC lock is held */
563 null_ephemerons_for_domain (MonoDomain *domain)
565 EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
568 MonoObject *object = (MonoObject*)current->array;
571 SGEN_ASSERT (0, object->vtable, "Can't have objects without vtables.");
573 if (object && object->vtable->domain == domain) {
574 EphemeronLinkNode *tmp = current;
577 prev->next = current->next;
579 ephemeron_list = current->next;
581 current = current->next;
582 sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
585 current = current->next;
590 /* LOCKING: requires that the GC lock is held */
592 sgen_client_clear_unreachable_ephemerons (ScanCopyContext ctx)
594 CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
595 SgenGrayQueue *queue = ctx.queue;
596 EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
598 Ephemeron *cur, *array_end;
602 char *object = current->array;
604 if (!sgen_is_object_alive_for_current_gen (object)) {
605 EphemeronLinkNode *tmp = current;
607 SGEN_LOG (5, "Dead Ephemeron array at %p", object);
610 prev->next = current->next;
612 ephemeron_list = current->next;
614 current = current->next;
615 sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
620 copy_func ((void**)&object, queue);
621 current->array = object;
623 SGEN_LOG (5, "Clearing unreachable entries for ephemeron array at %p", object);
625 array = (MonoArray*)object;
626 cur = mono_array_addr (array, Ephemeron, 0);
627 array_end = cur + mono_array_length_fast (array);
628 tombstone = (char*)((MonoVTable*)SGEN_LOAD_VTABLE (object))->domain->ephemeron_tombstone;
630 for (; cur < array_end; ++cur) {
631 char *key = (char*)cur->key;
633 if (!key || key == tombstone)
636 SGEN_LOG (5, "[%zd] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
637 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
638 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
640 if (!sgen_is_object_alive_for_current_gen (key)) {
641 cur->key = tombstone;
647 current = current->next;
652 LOCKING: requires that the GC lock is held
654 Limitations: We scan all ephemerons on every collection since the current design doesn't allow for a simple nursery/mature split.
657 sgen_client_mark_ephemerons (ScanCopyContext ctx)
659 CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
660 SgenGrayQueue *queue = ctx.queue;
661 gboolean nothing_marked = TRUE;
662 EphemeronLinkNode *current = ephemeron_list;
664 Ephemeron *cur, *array_end;
667 for (current = ephemeron_list; current; current = current->next) {
668 char *object = current->array;
669 SGEN_LOG (5, "Ephemeron array at %p", object);
671 /*It has to be alive*/
672 if (!sgen_is_object_alive_for_current_gen (object)) {
673 SGEN_LOG (5, "\tnot reachable");
677 copy_func ((void**)&object, queue);
679 array = (MonoArray*)object;
680 cur = mono_array_addr (array, Ephemeron, 0);
681 array_end = cur + mono_array_length_fast (array);
682 tombstone = (char*)((MonoVTable*)SGEN_LOAD_VTABLE (object))->domain->ephemeron_tombstone;
684 for (; cur < array_end; ++cur) {
685 char *key = cur->key;
687 if (!key || key == tombstone)
690 SGEN_LOG (5, "[%zd] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
691 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
692 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
694 if (sgen_is_object_alive_for_current_gen (key)) {
695 char *value = cur->value;
697 copy_func ((void**)&cur->key, queue);
699 if (!sgen_is_object_alive_for_current_gen (value))
700 nothing_marked = FALSE;
701 copy_func ((void**)&cur->value, queue);
707 SGEN_LOG (5, "Ephemeron run finished. Is it done %d", nothing_marked);
708 return nothing_marked;
712 mono_gc_ephemeron_array_add (MonoObject *obj)
714 EphemeronLinkNode *node;
718 node = sgen_alloc_internal (INTERNAL_MEM_EPHEMERON_LINK);
723 node->array = (char*)obj;
724 node->next = ephemeron_list;
725 ephemeron_list = node;
727 SGEN_LOG (5, "Registered ephemeron array %p", obj);
738 mono_gc_set_current_thread_appdomain (MonoDomain *domain)
740 SgenThreadInfo *info = mono_thread_info_current ();
742 /* Could be called from sgen_thread_unregister () with a NULL info */
745 info->client_info.stopped_domain = domain;
750 need_remove_object_for_domain (char *start, MonoDomain *domain)
752 if (mono_object_domain (start) == domain) {
753 SGEN_LOG (4, "Need to cleanup object %p", start);
754 binary_protocol_cleanup (start, (gpointer)SGEN_LOAD_VTABLE (start), sgen_safe_object_get_size ((GCObject*)start));
761 process_object_for_domain_clearing (char *start, MonoDomain *domain)
763 MonoVTable *vt = (MonoVTable*)SGEN_LOAD_VTABLE (start);
764 if (vt->klass == mono_defaults.internal_thread_class)
765 g_assert (mono_object_domain (start) == mono_get_root_domain ());
766 /* The object could be a proxy for an object in the domain
768 #ifndef DISABLE_REMOTING
769 if (mono_defaults.real_proxy_class->supertypes && mono_class_has_parent_fast (vt->klass, mono_defaults.real_proxy_class)) {
770 MonoObject *server = ((MonoRealProxy*)start)->unwrapped_server;
772 /* The server could already have been zeroed out, so
773 we need to check for that, too. */
774 if (server && (!SGEN_LOAD_VTABLE (server) || mono_object_domain (server) == domain)) {
775 SGEN_LOG (4, "Cleaning up remote pointer in %p to object %p", start, server);
776 ((MonoRealProxy*)start)->unwrapped_server = NULL;
783 clear_domain_process_object (char *obj, MonoDomain *domain)
787 process_object_for_domain_clearing (obj, domain);
788 remove = need_remove_object_for_domain (obj, domain);
790 if (remove && ((MonoObject*)obj)->synchronisation) {
791 void **dislink = mono_monitor_get_object_monitor_weak_link ((MonoObject*)obj);
793 sgen_register_disappearing_link (NULL, dislink, FALSE, TRUE);
800 clear_domain_process_minor_object_callback (char *obj, size_t size, MonoDomain *domain)
802 if (clear_domain_process_object (obj, domain)) {
803 CANARIFY_SIZE (size);
804 memset (obj, 0, size);
809 clear_domain_process_major_object_callback (char *obj, size_t size, MonoDomain *domain)
811 clear_domain_process_object (obj, domain);
815 clear_domain_free_major_non_pinned_object_callback (char *obj, size_t size, MonoDomain *domain)
817 if (need_remove_object_for_domain (obj, domain))
818 major_collector.free_non_pinned_object (obj, size);
822 clear_domain_free_major_pinned_object_callback (char *obj, size_t size, MonoDomain *domain)
824 if (need_remove_object_for_domain (obj, domain))
825 major_collector.free_pinned_object (obj, size);
829 * When appdomains are unloaded we can easily remove objects that have finalizers,
830 * but all the others could still be present in random places on the heap.
831 * We need a sweep to get rid of them even though it's going to be costly
833 * The reason we need to remove them is because we access the vtable and class
834 * structures to know the object size and the reference bitmap: once the domain is
835 * unloaded the point to random memory.
838 mono_gc_clear_domain (MonoDomain * domain)
840 LOSObject *bigobj, *prev;
845 binary_protocol_domain_unload_begin (domain);
849 if (sgen_concurrent_collection_in_progress ())
850 sgen_perform_collection (0, GENERATION_OLD, "clear domain", TRUE);
851 SGEN_ASSERT (0, !sgen_concurrent_collection_in_progress (), "We just ordered a synchronous collection. Why are we collecting concurrently?");
853 major_collector.finish_sweeping ();
855 sgen_process_fin_stage_entries ();
856 sgen_process_dislink_stage_entries ();
858 sgen_clear_nursery_fragments ();
860 if (sgen_mono_xdomain_checks && domain != mono_get_root_domain ()) {
861 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_NORMAL);
862 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_WBARRIER);
863 sgen_check_for_xdomain_refs ();
866 /*Ephemerons and dislinks must be processed before LOS since they might end up pointing
867 to memory returned to the OS.*/
868 null_ephemerons_for_domain (domain);
870 for (i = GENERATION_NURSERY; i < GENERATION_MAX; ++i)
871 sgen_null_links_if (object_in_domain_predicate, domain, i);
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);
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 (bigobj->data, domain);
891 for (bigobj = los_object_list; bigobj;) {
892 if (need_remove_object_for_domain (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))
940 mono_profiler_allocation (obj);
946 mono_gc_alloc_pinned_obj (MonoVTable *vtable, size_t size)
948 MonoObject *obj = sgen_alloc_obj_pinned (vtable, size);
950 if (G_UNLIKELY (alloc_events))
951 mono_profiler_allocation (obj);
957 mono_gc_alloc_mature (MonoVTable *vtable)
959 MonoObject *obj = sgen_alloc_obj_mature (vtable, vtable->klass->instance_size);
961 if (obj && G_UNLIKELY (obj->vtable->klass->has_finalize))
962 mono_object_register_finalizer (obj);
964 if (G_UNLIKELY (alloc_events))
965 mono_profiler_allocation (obj);
971 mono_gc_alloc_fixed (size_t size, void *descr)
973 /* FIXME: do a single allocation */
974 void *res = calloc (1, size);
977 if (!mono_gc_register_root (res, size, descr)) {
985 mono_gc_free_fixed (void* addr)
987 mono_gc_deregister_root (addr);
995 static MonoMethod* alloc_method_cache [ATYPE_NUM];
996 static MonoMethod* slowpath_alloc_method_cache [ATYPE_NUM];
997 static gboolean use_managed_allocator = TRUE;
999 #ifdef MANAGED_ALLOCATION
1001 #ifdef HAVE_KW_THREAD
1003 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb) do { \
1004 mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX); \
1005 mono_mb_emit_byte ((mb), CEE_MONO_TLS); \
1006 mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_TLAB_NEXT_ADDR); \
1009 #define EMIT_TLS_ACCESS_TEMP_END(mb) do { \
1010 mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX); \
1011 mono_mb_emit_byte ((mb), CEE_MONO_TLS); \
1012 mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_TLAB_TEMP_END); \
1017 #if defined(__APPLE__) || defined (HOST_WIN32)
1018 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb) do { \
1019 mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX); \
1020 mono_mb_emit_byte ((mb), CEE_MONO_TLS); \
1021 mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_THREAD_INFO); \
1022 mono_mb_emit_icon ((mb), MONO_STRUCT_OFFSET (SgenThreadInfo, tlab_next_addr)); \
1023 mono_mb_emit_byte ((mb), CEE_ADD); \
1024 mono_mb_emit_byte ((mb), CEE_LDIND_I); \
1027 #define EMIT_TLS_ACCESS_TEMP_END(mb) do { \
1028 mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX); \
1029 mono_mb_emit_byte ((mb), CEE_MONO_TLS); \
1030 mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_THREAD_INFO); \
1031 mono_mb_emit_icon ((mb), MONO_STRUCT_OFFSET (SgenThreadInfo, tlab_temp_end)); \
1032 mono_mb_emit_byte ((mb), CEE_ADD); \
1033 mono_mb_emit_byte ((mb), CEE_LDIND_I); \
1037 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb) do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1038 #define EMIT_TLS_ACCESS_TEMP_END(mb) do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1043 /* FIXME: Do this in the JIT, where specialized allocation sequences can be created
1044 * for each class. This is currently not easy to do, as it is hard to generate basic
1045 * blocks + branches, but it is easy with the linear IL codebase.
1047 * For this to work we'd need to solve the TLAB race, first. Now we
1048 * require the allocator to be in a few known methods to make sure
1049 * that they are executed atomically via the restart mechanism.
1052 create_allocator (int atype, gboolean slowpath)
1054 int p_var, size_var;
1055 guint32 slowpath_branch, max_size_branch;
1056 MonoMethodBuilder *mb;
1058 MonoMethodSignature *csig;
1059 static gboolean registered = FALSE;
1060 int tlab_next_addr_var, new_next_var;
1061 const char *name = NULL;
1062 AllocatorWrapperInfo *info;
1066 mono_register_jit_icall (mono_gc_alloc_obj, "mono_gc_alloc_obj", mono_create_icall_signature ("object ptr int"), FALSE);
1067 mono_register_jit_icall (mono_gc_alloc_vector, "mono_gc_alloc_vector", mono_create_icall_signature ("object ptr int int"), FALSE);
1068 mono_register_jit_icall (mono_gc_alloc_string, "mono_gc_alloc_string", mono_create_icall_signature ("object ptr int int32"), FALSE);
1072 if (atype == ATYPE_SMALL) {
1073 name = slowpath ? "SlowAllocSmall" : "AllocSmall";
1074 } else if (atype == ATYPE_NORMAL) {
1075 name = slowpath ? "SlowAlloc" : "Alloc";
1076 } else if (atype == ATYPE_VECTOR) {
1077 name = slowpath ? "SlowAllocVector" : "AllocVector";
1078 } else if (atype == ATYPE_STRING) {
1079 name = slowpath ? "SlowAllocString" : "AllocString";
1081 g_assert_not_reached ();
1084 if (atype == ATYPE_NORMAL)
1089 csig = mono_metadata_signature_alloc (mono_defaults.corlib, num_params);
1090 if (atype == ATYPE_STRING) {
1091 csig->ret = &mono_defaults.string_class->byval_arg;
1092 csig->params [0] = &mono_defaults.int_class->byval_arg;
1093 csig->params [1] = &mono_defaults.int32_class->byval_arg;
1095 csig->ret = &mono_defaults.object_class->byval_arg;
1096 for (i = 0; i < num_params; i++)
1097 csig->params [i] = &mono_defaults.int_class->byval_arg;
1100 mb = mono_mb_new (mono_defaults.object_class, name, MONO_WRAPPER_ALLOC);
1107 mono_mb_emit_ldarg (mb, 0);
1108 mono_mb_emit_icall (mb, mono_object_new_specific);
1111 mono_mb_emit_ldarg (mb, 0);
1112 mono_mb_emit_ldarg (mb, 1);
1113 mono_mb_emit_icall (mb, mono_array_new_specific);
1116 mono_mb_emit_ldarg (mb, 1);
1117 mono_mb_emit_icall (mb, mono_string_alloc);
1120 g_assert_not_reached ();
1126 size_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1127 if (atype == ATYPE_SMALL) {
1128 /* size_var = size_arg */
1129 mono_mb_emit_ldarg (mb, 1);
1130 mono_mb_emit_stloc (mb, size_var);
1131 } else if (atype == ATYPE_NORMAL) {
1132 /* size = vtable->klass->instance_size; */
1133 mono_mb_emit_ldarg (mb, 0);
1134 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoVTable, klass));
1135 mono_mb_emit_byte (mb, CEE_ADD);
1136 mono_mb_emit_byte (mb, CEE_LDIND_I);
1137 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoClass, instance_size));
1138 mono_mb_emit_byte (mb, CEE_ADD);
1139 /* FIXME: assert instance_size stays a 4 byte integer */
1140 mono_mb_emit_byte (mb, CEE_LDIND_U4);
1141 mono_mb_emit_byte (mb, CEE_CONV_I);
1142 mono_mb_emit_stloc (mb, size_var);
1143 } else if (atype == ATYPE_VECTOR) {
1144 MonoExceptionClause *clause;
1145 int pos, pos_leave, pos_error;
1146 MonoClass *oom_exc_class;
1150 * n > MONO_ARRAY_MAX_INDEX => OutOfMemoryException
1151 * n < 0 => OverflowException
1153 * We can do an unsigned comparison to catch both cases, then in the error
1154 * case compare signed to distinguish between them.
1156 mono_mb_emit_ldarg (mb, 1);
1157 mono_mb_emit_icon (mb, MONO_ARRAY_MAX_INDEX);
1158 mono_mb_emit_byte (mb, CEE_CONV_U);
1159 pos = mono_mb_emit_short_branch (mb, CEE_BLE_UN_S);
1161 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1162 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1163 mono_mb_emit_ldarg (mb, 1);
1164 mono_mb_emit_icon (mb, 0);
1165 pos_error = mono_mb_emit_short_branch (mb, CEE_BLT_S);
1166 mono_mb_emit_exception (mb, "OutOfMemoryException", NULL);
1167 mono_mb_patch_short_branch (mb, pos_error);
1168 mono_mb_emit_exception (mb, "OverflowException", NULL);
1170 mono_mb_patch_short_branch (mb, pos);
1172 clause = mono_image_alloc0 (mono_defaults.corlib, sizeof (MonoExceptionClause));
1173 clause->try_offset = mono_mb_get_label (mb);
1175 /* vtable->klass->sizes.element_size */
1176 mono_mb_emit_ldarg (mb, 0);
1177 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoVTable, klass));
1178 mono_mb_emit_byte (mb, CEE_ADD);
1179 mono_mb_emit_byte (mb, CEE_LDIND_I);
1180 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoClass, sizes));
1181 mono_mb_emit_byte (mb, CEE_ADD);
1182 mono_mb_emit_byte (mb, CEE_LDIND_U4);
1183 mono_mb_emit_byte (mb, CEE_CONV_I);
1186 mono_mb_emit_ldarg (mb, 1);
1187 mono_mb_emit_byte (mb, CEE_MUL_OVF_UN);
1188 /* + sizeof (MonoArray) */
1189 mono_mb_emit_icon (mb, sizeof (MonoArray));
1190 mono_mb_emit_byte (mb, CEE_ADD_OVF_UN);
1191 mono_mb_emit_stloc (mb, size_var);
1193 pos_leave = mono_mb_emit_branch (mb, CEE_LEAVE);
1196 clause->flags = MONO_EXCEPTION_CLAUSE_NONE;
1197 clause->try_len = mono_mb_get_pos (mb) - clause->try_offset;
1198 clause->data.catch_class = mono_class_from_name (mono_defaults.corlib,
1199 "System", "OverflowException");
1200 g_assert (clause->data.catch_class);
1201 clause->handler_offset = mono_mb_get_label (mb);
1203 oom_exc_class = mono_class_from_name (mono_defaults.corlib,
1204 "System", "OutOfMemoryException");
1205 g_assert (oom_exc_class);
1206 ctor = mono_class_get_method_from_name (oom_exc_class, ".ctor", 0);
1209 mono_mb_emit_byte (mb, CEE_POP);
1210 mono_mb_emit_op (mb, CEE_NEWOBJ, ctor);
1211 mono_mb_emit_byte (mb, CEE_THROW);
1213 clause->handler_len = mono_mb_get_pos (mb) - clause->handler_offset;
1214 mono_mb_set_clauses (mb, 1, clause);
1215 mono_mb_patch_branch (mb, pos_leave);
1217 } else if (atype == ATYPE_STRING) {
1221 * a string allocator method takes the args: (vtable, len)
1223 * bytes = offsetof (MonoString, chars) + ((len + 1) * 2)
1227 * bytes <= INT32_MAX - (SGEN_ALLOC_ALIGN - 1)
1231 * offsetof (MonoString, chars) + ((len + 1) * 2) <= INT32_MAX - (SGEN_ALLOC_ALIGN - 1)
1232 * len <= (INT32_MAX - (SGEN_ALLOC_ALIGN - 1) - offsetof (MonoString, chars)) / 2 - 1
1234 mono_mb_emit_ldarg (mb, 1);
1235 mono_mb_emit_icon (mb, (INT32_MAX - (SGEN_ALLOC_ALIGN - 1) - MONO_STRUCT_OFFSET (MonoString, chars)) / 2 - 1);
1236 pos = mono_mb_emit_short_branch (mb, MONO_CEE_BLE_UN_S);
1238 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1239 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1240 mono_mb_emit_exception (mb, "OutOfMemoryException", NULL);
1241 mono_mb_patch_short_branch (mb, pos);
1243 mono_mb_emit_ldarg (mb, 1);
1244 mono_mb_emit_icon (mb, 1);
1245 mono_mb_emit_byte (mb, MONO_CEE_SHL);
1246 //WE manually fold the above + 2 here
1247 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoString, chars) + 2);
1248 mono_mb_emit_byte (mb, CEE_ADD);
1249 mono_mb_emit_stloc (mb, size_var);
1251 g_assert_not_reached ();
1254 if (atype != ATYPE_SMALL) {
1255 /* size += ALLOC_ALIGN - 1; */
1256 mono_mb_emit_ldloc (mb, size_var);
1257 mono_mb_emit_icon (mb, SGEN_ALLOC_ALIGN - 1);
1258 mono_mb_emit_byte (mb, CEE_ADD);
1259 /* size &= ~(ALLOC_ALIGN - 1); */
1260 mono_mb_emit_icon (mb, ~(SGEN_ALLOC_ALIGN - 1));
1261 mono_mb_emit_byte (mb, CEE_AND);
1262 mono_mb_emit_stloc (mb, size_var);
1265 /* if (size > MAX_SMALL_OBJ_SIZE) goto slowpath */
1266 if (atype != ATYPE_SMALL) {
1267 mono_mb_emit_ldloc (mb, size_var);
1268 mono_mb_emit_icon (mb, SGEN_MAX_SMALL_OBJ_SIZE);
1269 max_size_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BGT_UN_S);
1273 * We need to modify tlab_next, but the JIT only supports reading, so we read
1274 * another tls var holding its address instead.
1277 /* tlab_next_addr (local) = tlab_next_addr (TLS var) */
1278 tlab_next_addr_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1279 EMIT_TLS_ACCESS_NEXT_ADDR (mb);
1280 mono_mb_emit_stloc (mb, tlab_next_addr_var);
1282 /* p = (void**)tlab_next; */
1283 p_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1284 mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1285 mono_mb_emit_byte (mb, CEE_LDIND_I);
1286 mono_mb_emit_stloc (mb, p_var);
1288 /* new_next = (char*)p + size; */
1289 new_next_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1290 mono_mb_emit_ldloc (mb, p_var);
1291 mono_mb_emit_ldloc (mb, size_var);
1292 mono_mb_emit_byte (mb, CEE_CONV_I);
1293 mono_mb_emit_byte (mb, CEE_ADD);
1294 mono_mb_emit_stloc (mb, new_next_var);
1296 /* if (G_LIKELY (new_next < tlab_temp_end)) */
1297 mono_mb_emit_ldloc (mb, new_next_var);
1298 EMIT_TLS_ACCESS_TEMP_END (mb);
1299 slowpath_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLT_UN_S);
1302 if (atype != ATYPE_SMALL)
1303 mono_mb_patch_short_branch (mb, max_size_branch);
1305 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1306 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1308 /* FIXME: mono_gc_alloc_obj takes a 'size_t' as an argument, not an int32 */
1309 mono_mb_emit_ldarg (mb, 0);
1310 mono_mb_emit_ldloc (mb, size_var);
1311 if (atype == ATYPE_NORMAL || atype == ATYPE_SMALL) {
1312 mono_mb_emit_icall (mb, mono_gc_alloc_obj);
1313 } else if (atype == ATYPE_VECTOR) {
1314 mono_mb_emit_ldarg (mb, 1);
1315 mono_mb_emit_icall (mb, mono_gc_alloc_vector);
1316 } else if (atype == ATYPE_STRING) {
1317 mono_mb_emit_ldarg (mb, 1);
1318 mono_mb_emit_icall (mb, mono_gc_alloc_string);
1320 g_assert_not_reached ();
1322 mono_mb_emit_byte (mb, CEE_RET);
1325 mono_mb_patch_short_branch (mb, slowpath_branch);
1327 /* FIXME: Memory barrier */
1329 /* tlab_next = new_next */
1330 mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1331 mono_mb_emit_ldloc (mb, new_next_var);
1332 mono_mb_emit_byte (mb, CEE_STIND_I);
1334 /*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. */
1335 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1336 mono_mb_emit_byte (mb, CEE_MONO_MEMORY_BARRIER);
1337 mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_REL);
1340 mono_mb_emit_ldloc (mb, p_var);
1341 mono_mb_emit_ldarg (mb, 0);
1342 mono_mb_emit_byte (mb, CEE_STIND_I);
1344 if (atype == ATYPE_VECTOR) {
1345 /* arr->max_length = max_length; */
1346 mono_mb_emit_ldloc (mb, p_var);
1347 mono_mb_emit_ldflda (mb, MONO_STRUCT_OFFSET (MonoArray, max_length));
1348 mono_mb_emit_ldarg (mb, 1);
1349 #ifdef MONO_BIG_ARRAYS
1350 mono_mb_emit_byte (mb, CEE_STIND_I);
1352 mono_mb_emit_byte (mb, CEE_STIND_I4);
1354 } else if (atype == ATYPE_STRING) {
1355 /* need to set length and clear the last char */
1356 /* s->length = len; */
1357 mono_mb_emit_ldloc (mb, p_var);
1358 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoString, length));
1359 mono_mb_emit_byte (mb, MONO_CEE_ADD);
1360 mono_mb_emit_ldarg (mb, 1);
1361 mono_mb_emit_byte (mb, MONO_CEE_STIND_I4);
1362 /* s->chars [len] = 0; */
1363 mono_mb_emit_ldloc (mb, p_var);
1364 mono_mb_emit_ldloc (mb, size_var);
1365 mono_mb_emit_icon (mb, 2);
1366 mono_mb_emit_byte (mb, MONO_CEE_SUB);
1367 mono_mb_emit_byte (mb, MONO_CEE_ADD);
1368 mono_mb_emit_icon (mb, 0);
1369 mono_mb_emit_byte (mb, MONO_CEE_STIND_I2);
1373 We must make sure both vtable and max_length are globaly visible before returning to managed land.
1375 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1376 mono_mb_emit_byte (mb, CEE_MONO_MEMORY_BARRIER);
1377 mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_REL);
1380 mono_mb_emit_ldloc (mb, p_var);
1383 mono_mb_emit_byte (mb, CEE_RET);
1386 res = mono_mb_create_method (mb, csig, 8);
1388 mono_method_get_header (res)->init_locals = FALSE;
1390 info = mono_image_alloc0 (mono_defaults.corlib, sizeof (AllocatorWrapperInfo));
1391 info->gc_name = "sgen";
1392 info->alloc_type = atype;
1393 mono_marshal_set_wrapper_info (res, info);
1400 mono_gc_get_aligned_size_for_allocator (int size)
1402 int aligned_size = size;
1403 aligned_size += SGEN_ALLOC_ALIGN - 1;
1404 aligned_size &= ~(SGEN_ALLOC_ALIGN - 1);
1405 return aligned_size;
1409 * Generate an allocator method implementing the fast path of mono_gc_alloc_obj ().
1410 * The signature of the called method is:
1411 * object allocate (MonoVTable *vtable)
1414 mono_gc_get_managed_allocator (MonoClass *klass, gboolean for_box, gboolean known_instance_size)
1416 #ifdef MANAGED_ALLOCATION
1417 if (collect_before_allocs)
1419 if (!mono_runtime_has_tls_get ())
1421 if (klass->instance_size > tlab_size)
1423 if (known_instance_size && ALIGN_TO (klass->instance_size, SGEN_ALLOC_ALIGN) >= SGEN_MAX_SMALL_OBJ_SIZE)
1425 if (mono_class_has_finalizer (klass) || mono_class_is_marshalbyref (klass) || (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS))
1429 if (klass->byval_arg.type == MONO_TYPE_STRING)
1430 return mono_gc_get_managed_allocator_by_type (ATYPE_STRING, FALSE);
1431 /* Generic classes have dynamic field and can go above MAX_SMALL_OBJ_SIZE. */
1432 if (known_instance_size)
1433 return mono_gc_get_managed_allocator_by_type (ATYPE_SMALL, FALSE);
1435 return mono_gc_get_managed_allocator_by_type (ATYPE_NORMAL, FALSE);
1442 mono_gc_get_managed_array_allocator (MonoClass *klass)
1444 #ifdef MANAGED_ALLOCATION
1445 if (klass->rank != 1)
1447 if (!mono_runtime_has_tls_get ())
1449 if (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS)
1451 if (has_per_allocation_action)
1453 g_assert (!mono_class_has_finalizer (klass) && !mono_class_is_marshalbyref (klass));
1455 return mono_gc_get_managed_allocator_by_type (ATYPE_VECTOR, FALSE);
1462 sgen_set_use_managed_allocator (gboolean flag)
1464 use_managed_allocator = flag;
1468 mono_gc_get_managed_allocator_by_type (int atype, gboolean slowpath)
1470 #ifdef MANAGED_ALLOCATION
1472 MonoMethod **cache = slowpath ? slowpath_alloc_method_cache : alloc_method_cache;
1474 if (!use_managed_allocator)
1477 if (!mono_runtime_has_tls_get ())
1480 res = cache [atype];
1484 res = create_allocator (atype, slowpath);
1486 if (cache [atype]) {
1487 mono_free_method (res);
1488 res = cache [atype];
1490 mono_memory_barrier ();
1491 cache [atype] = res;
1502 mono_gc_get_managed_allocator_types (void)
1508 sgen_is_managed_allocator (MonoMethod *method)
1512 for (i = 0; i < ATYPE_NUM; ++i)
1513 if (method == alloc_method_cache [i] || method == slowpath_alloc_method_cache [i])
1519 sgen_has_managed_allocator (void)
1523 for (i = 0; i < ATYPE_NUM; ++i)
1524 if (alloc_method_cache [i] || slowpath_alloc_method_cache [i])
1530 * Cardtable scanning
1533 #define MWORD_MASK (sizeof (mword) - 1)
1536 find_card_offset (mword card)
1538 /*XXX Use assembly as this generates some pretty bad code */
1539 #if defined(__i386__) && defined(__GNUC__)
1540 return (__builtin_ffs (card) - 1) / 8;
1541 #elif defined(__x86_64__) && defined(__GNUC__)
1542 return (__builtin_ffsll (card) - 1) / 8;
1543 #elif defined(__s390x__)
1544 return (__builtin_ffsll (GUINT64_TO_LE(card)) - 1) / 8;
1547 guint8 *ptr = (guint8 *) &card;
1548 for (i = 0; i < sizeof (mword); ++i) {
1557 find_next_card (guint8 *card_data, guint8 *end)
1559 mword *cards, *cards_end;
1562 while ((((mword)card_data) & MWORD_MASK) && card_data < end) {
1568 if (card_data == end)
1571 cards = (mword*)card_data;
1572 cards_end = (mword*)((mword)end & ~MWORD_MASK);
1573 while (cards < cards_end) {
1576 return (guint8*)cards + find_card_offset (card);
1580 card_data = (guint8*)cards_end;
1581 while (card_data < end) {
1590 #define ARRAY_OBJ_INDEX(ptr,array,elem_size) (((char*)(ptr) - ((char*)(array) + G_STRUCT_OFFSET (MonoArray, vector))) / (elem_size))
1593 sgen_client_cardtable_scan_object (char *obj, mword block_obj_size, guint8 *cards, gboolean mod_union, ScanCopyContext ctx)
1595 MonoVTable *vt = (MonoVTable*)SGEN_LOAD_VTABLE (obj);
1596 MonoClass *klass = vt->klass;
1598 SGEN_ASSERT (0, SGEN_VTABLE_HAS_REFERENCES ((GCVTable*)vt), "Why would we ever call this on reference-free objects?");
1601 guint8 *card_data, *card_base;
1602 guint8 *card_data_end;
1603 char *obj_start = sgen_card_table_align_pointer (obj);
1604 mword obj_size = sgen_client_par_object_get_size (vt, (GCObject*)obj);
1605 char *obj_end = obj + obj_size;
1607 size_t extra_idx = 0;
1609 MonoArray *arr = (MonoArray*)obj;
1610 mword desc = (mword)klass->element_class->gc_descr;
1611 int elem_size = mono_array_element_size (klass);
1613 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1614 guint8 *overflow_scan_end = NULL;
1617 #ifdef SGEN_OBJECT_LAYOUT_STATISTICS
1618 if (klass->element_class->valuetype)
1619 sgen_object_layout_scanned_vtype_array ();
1621 sgen_object_layout_scanned_ref_array ();
1627 card_data = sgen_card_table_get_card_scan_address ((mword)obj);
1629 card_base = card_data;
1630 card_count = sgen_card_table_number_of_cards_in_range ((mword)obj, obj_size);
1631 card_data_end = card_data + card_count;
1634 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1635 /*Check for overflow and if so, setup to scan in two steps*/
1636 if (!cards && card_data_end >= SGEN_SHADOW_CARDTABLE_END) {
1637 overflow_scan_end = sgen_shadow_cardtable + (card_data_end - SGEN_SHADOW_CARDTABLE_END);
1638 card_data_end = SGEN_SHADOW_CARDTABLE_END;
1644 card_data = find_next_card (card_data, card_data_end);
1645 for (; card_data < card_data_end; card_data = find_next_card (card_data + 1, card_data_end)) {
1647 size_t idx = (card_data - card_base) + extra_idx;
1648 char *start = (char*)(obj_start + idx * CARD_SIZE_IN_BYTES);
1649 char *card_end = start + CARD_SIZE_IN_BYTES;
1650 char *first_elem, *elem;
1652 HEAVY_STAT (++los_marked_cards);
1655 sgen_card_table_prepare_card_for_scanning (card_data);
1657 card_end = MIN (card_end, obj_end);
1659 if (start <= (char*)arr->vector)
1662 index = ARRAY_OBJ_INDEX (start, obj, elem_size);
1664 elem = first_elem = (char*)mono_array_addr_with_size_fast ((MonoArray*)obj, elem_size, index);
1665 if (klass->element_class->valuetype) {
1666 ScanVTypeFunc scan_vtype_func = ctx.ops->scan_vtype;
1668 for (; elem < card_end; elem += elem_size)
1669 scan_vtype_func (obj, elem, desc, ctx.queue BINARY_PROTOCOL_ARG (elem_size));
1671 CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
1673 HEAVY_STAT (++los_array_cards);
1674 for (; elem < card_end; elem += SIZEOF_VOID_P) {
1675 gpointer new, old = *(gpointer*)elem;
1676 if ((mod_union && old) || G_UNLIKELY (sgen_ptr_in_nursery (old))) {
1677 HEAVY_STAT (++los_array_remsets);
1678 copy_func ((void**)elem, ctx.queue);
1679 new = *(gpointer*)elem;
1680 if (G_UNLIKELY (sgen_ptr_in_nursery (new)))
1681 sgen_add_to_global_remset (elem, new);
1686 binary_protocol_card_scan (first_elem, elem - first_elem);
1689 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1690 if (overflow_scan_end) {
1691 extra_idx = card_data - card_base;
1692 card_base = card_data = sgen_shadow_cardtable;
1693 card_data_end = overflow_scan_end;
1694 overflow_scan_end = NULL;
1705 * Array and string allocation
1709 mono_gc_alloc_vector (MonoVTable *vtable, size_t size, uintptr_t max_length)
1714 if (!SGEN_CAN_ALIGN_UP (size))
1717 #ifndef DISABLE_CRITICAL_REGION
1718 ENTER_CRITICAL_REGION;
1719 arr = sgen_try_alloc_obj_nolock ((GCVTable*)vtable, size);
1721 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1722 arr->max_length = (mono_array_size_t)max_length;
1723 EXIT_CRITICAL_REGION;
1726 EXIT_CRITICAL_REGION;
1731 arr = sgen_alloc_obj_nolock ((GCVTable*)vtable, size);
1732 if (G_UNLIKELY (!arr)) {
1734 return mono_gc_out_of_memory (size);
1737 arr->max_length = (mono_array_size_t)max_length;
1742 if (G_UNLIKELY (alloc_events))
1743 mono_profiler_allocation (&arr->obj);
1745 SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size ((GCVTable*)vtable, (GCObject*)arr)), "Vector has incorrect size.");
1750 mono_gc_alloc_array (MonoVTable *vtable, size_t size, uintptr_t max_length, uintptr_t bounds_size)
1753 MonoArrayBounds *bounds;
1756 if (!SGEN_CAN_ALIGN_UP (size))
1759 #ifndef DISABLE_CRITICAL_REGION
1760 ENTER_CRITICAL_REGION;
1761 arr = sgen_try_alloc_obj_nolock ((GCVTable*)vtable, size);
1763 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1764 arr->max_length = (mono_array_size_t)max_length;
1766 bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1767 arr->bounds = bounds;
1768 EXIT_CRITICAL_REGION;
1771 EXIT_CRITICAL_REGION;
1776 arr = sgen_alloc_obj_nolock ((GCVTable*)vtable, size);
1777 if (G_UNLIKELY (!arr)) {
1779 return mono_gc_out_of_memory (size);
1782 arr->max_length = (mono_array_size_t)max_length;
1784 bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1785 arr->bounds = bounds;
1790 if (G_UNLIKELY (alloc_events))
1791 mono_profiler_allocation (&arr->obj);
1793 SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size ((GCVTable*)vtable, (GCObject*)arr)), "Array has incorrect size.");
1798 mono_gc_alloc_string (MonoVTable *vtable, size_t size, gint32 len)
1803 if (!SGEN_CAN_ALIGN_UP (size))
1806 #ifndef DISABLE_CRITICAL_REGION
1807 ENTER_CRITICAL_REGION;
1808 str = sgen_try_alloc_obj_nolock ((GCVTable*)vtable, size);
1810 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1812 EXIT_CRITICAL_REGION;
1815 EXIT_CRITICAL_REGION;
1820 str = sgen_alloc_obj_nolock ((GCVTable*)vtable, size);
1821 if (G_UNLIKELY (!str)) {
1823 return mono_gc_out_of_memory (size);
1831 if (G_UNLIKELY (alloc_events))
1832 mono_profiler_allocation (&str->object);
1842 mono_gc_set_string_length (MonoString *str, gint32 new_length)
1844 mono_unichar2 *new_end = str->chars + new_length;
1846 /* zero the discarded string. This null-delimits the string and allows
1847 * the space to be reclaimed by SGen. */
1849 if (nursery_canaries_enabled () && sgen_ptr_in_nursery (str)) {
1850 CHECK_CANARY_FOR_OBJECT (str);
1851 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2) + CANARY_SIZE);
1852 memcpy (new_end + 1 , CANARY_STRING, CANARY_SIZE);
1854 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2));
1857 str->length = new_length;
1864 #define GC_ROOT_NUM 32
1866 int count; /* must be the first field */
1867 void *objects [GC_ROOT_NUM];
1868 int root_types [GC_ROOT_NUM];
1869 uintptr_t extra_info [GC_ROOT_NUM];
1873 notify_gc_roots (GCRootReport *report)
1877 mono_profiler_gc_roots (report->count, report->objects, report->root_types, report->extra_info);
1882 add_profile_gc_root (GCRootReport *report, void *object, int rtype, uintptr_t extra_info)
1884 if (report->count == GC_ROOT_NUM)
1885 notify_gc_roots (report);
1886 report->objects [report->count] = object;
1887 report->root_types [report->count] = rtype;
1888 report->extra_info [report->count++] = (uintptr_t)((MonoVTable*)SGEN_LOAD_VTABLE (object))->klass;
1892 sgen_client_nursery_objects_pinned (void **definitely_pinned, int count)
1894 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS) {
1895 GCRootReport report;
1898 for (idx = 0; idx < count; ++idx)
1899 add_profile_gc_root (&report, definitely_pinned [idx], MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
1900 notify_gc_roots (&report);
1905 report_finalizer_roots_from_queue (SgenPointerQueue *queue)
1907 GCRootReport report;
1911 for (i = 0; i < queue->next_slot; ++i) {
1912 void *obj = queue->data [i];
1915 add_profile_gc_root (&report, obj, MONO_PROFILE_GC_ROOT_FINALIZER, 0);
1917 notify_gc_roots (&report);
1921 report_finalizer_roots (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
1923 report_finalizer_roots_from_queue (fin_ready_queue);
1924 report_finalizer_roots_from_queue (critical_fin_queue);
1927 static GCRootReport *root_report;
1930 single_arg_report_root (void **obj, void *gc_data)
1933 add_profile_gc_root (root_report, *obj, MONO_PROFILE_GC_ROOT_OTHER, 0);
1937 precisely_report_roots_from (GCRootReport *report, void** start_root, void** end_root, mword desc)
1939 switch (desc & ROOT_DESC_TYPE_MASK) {
1940 case ROOT_DESC_BITMAP:
1941 desc >>= ROOT_DESC_TYPE_SHIFT;
1943 if ((desc & 1) && *start_root) {
1944 add_profile_gc_root (report, *start_root, MONO_PROFILE_GC_ROOT_OTHER, 0);
1950 case ROOT_DESC_COMPLEX: {
1951 gsize *bitmap_data = sgen_get_complex_descriptor_bitmap (desc);
1952 gsize bwords = (*bitmap_data) - 1;
1953 void **start_run = start_root;
1955 while (bwords-- > 0) {
1956 gsize bmap = *bitmap_data++;
1957 void **objptr = start_run;
1959 if ((bmap & 1) && *objptr) {
1960 add_profile_gc_root (report, *objptr, MONO_PROFILE_GC_ROOT_OTHER, 0);
1965 start_run += GC_BITS_PER_WORD;
1969 case ROOT_DESC_USER: {
1970 MonoGCRootMarkFunc marker = sgen_get_user_descriptor_func (desc);
1971 root_report = report;
1972 marker (start_root, single_arg_report_root, NULL);
1975 case ROOT_DESC_RUN_LEN:
1976 g_assert_not_reached ();
1978 g_assert_not_reached ();
1983 report_registered_roots_by_type (int root_type)
1985 GCRootReport report;
1989 SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], start_root, root) {
1990 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
1991 precisely_report_roots_from (&report, start_root, (void**)root->end_root, root->root_desc);
1992 } SGEN_HASH_TABLE_FOREACH_END;
1993 notify_gc_roots (&report);
1997 report_registered_roots (void)
1999 report_registered_roots_by_type (ROOT_TYPE_NORMAL);
2000 report_registered_roots_by_type (ROOT_TYPE_WBARRIER);
2004 sgen_client_collecting_minor (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
2006 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2007 report_registered_roots ();
2008 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2009 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
2012 static GCRootReport major_root_report;
2013 static gboolean profile_roots;
2016 sgen_client_collecting_major_1 (void)
2018 profile_roots = mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS;
2019 memset (&major_root_report, 0, sizeof (GCRootReport));
2023 sgen_client_pinned_los_object (char *obj)
2026 add_profile_gc_root (&major_root_report, obj, MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
2030 sgen_client_collecting_major_2 (void)
2033 notify_gc_roots (&major_root_report);
2035 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2036 report_registered_roots ();
2040 sgen_client_collecting_major_3 (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
2042 if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2043 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
2046 #define MOVED_OBJECTS_NUM 64
2047 static void *moved_objects [MOVED_OBJECTS_NUM];
2048 static int moved_objects_idx = 0;
2051 mono_sgen_register_moved_object (void *obj, void *destination)
2053 g_assert (mono_profiler_events & MONO_PROFILE_GC_MOVES);
2055 if (moved_objects_idx == MOVED_OBJECTS_NUM) {
2056 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2057 moved_objects_idx = 0;
2059 moved_objects [moved_objects_idx++] = obj;
2060 moved_objects [moved_objects_idx++] = destination;
2064 mono_sgen_gc_event_moves (void)
2066 if (moved_objects_idx) {
2067 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2068 moved_objects_idx = 0;
2076 #define REFS_SIZE 128
2079 MonoGCReferences callback;
2083 MonoObject *refs [REFS_SIZE];
2084 uintptr_t offsets [REFS_SIZE];
2088 #define HANDLE_PTR(ptr,obj) do { \
2090 if (hwi->count == REFS_SIZE) { \
2091 hwi->callback ((MonoObject*)start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data); \
2095 hwi->offsets [hwi->count] = (char*)(ptr)-(char*)start; \
2096 hwi->refs [hwi->count++] = *(ptr); \
2101 collect_references (HeapWalkInfo *hwi, char *start, size_t size)
2103 mword desc = sgen_obj_get_descriptor (start);
2105 #include "sgen/sgen-scan-object.h"
2109 walk_references (char *start, size_t size, void *data)
2111 HeapWalkInfo *hwi = data;
2114 collect_references (hwi, start, size);
2115 if (hwi->count || !hwi->called)
2116 hwi->callback ((MonoObject*)start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);
2120 * mono_gc_walk_heap:
2121 * @flags: flags for future use
2122 * @callback: a function pointer called for each object in the heap
2123 * @data: a user data pointer that is passed to callback
2125 * This function can be used to iterate over all the live objects in the heap:
2126 * for each object, @callback is invoked, providing info about the object's
2127 * location in memory, its class, its size and the objects it references.
2128 * For each referenced object it's offset from the object address is
2129 * reported in the offsets array.
2130 * The object references may be buffered, so the callback may be invoked
2131 * multiple times for the same object: in all but the first call, the size
2132 * argument will be zero.
2133 * Note that this function can be only called in the #MONO_GC_EVENT_PRE_START_WORLD
2134 * profiler event handler.
2136 * Returns: a non-zero value if the GC doesn't support heap walking
2139 mono_gc_walk_heap (int flags, MonoGCReferences callback, void *data)
2144 hwi.callback = callback;
2147 sgen_clear_nursery_fragments ();
2148 sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data, walk_references, &hwi, FALSE);
2150 major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, walk_references, &hwi);
2151 sgen_los_iterate_objects (walk_references, &hwi);
2161 mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks)
2163 gc_callbacks = *callbacks;
2167 mono_gc_get_gc_callbacks ()
2169 return &gc_callbacks;
2173 sgen_client_thread_register (SgenThreadInfo* info, void *stack_bottom_fallback)
2176 guint8 *staddr = NULL;
2178 #ifndef HAVE_KW_THREAD
2179 g_assert (!mono_native_tls_get_value (thread_info_key));
2180 mono_native_tls_set_value (thread_info_key, info);
2182 sgen_thread_info = info;
2185 info->client_info.skip = 0;
2186 info->client_info.stopped_ip = NULL;
2187 info->client_info.stopped_domain = NULL;
2189 info->client_info.stack_start = NULL;
2191 #ifdef SGEN_POSIX_STW
2192 info->client_info.stop_count = -1;
2193 info->client_info.signal = 0;
2196 /* On win32, stack_start_limit should be 0, since the stack can grow dynamically */
2197 mono_thread_info_get_stack_bounds (&staddr, &stsize);
2200 info->client_info.stack_start_limit = staddr;
2202 info->client_info.stack_end = staddr + stsize;
2204 gsize stack_bottom = (gsize)stack_bottom_fallback;
2205 stack_bottom += 4095;
2206 stack_bottom &= ~4095;
2207 info->client_info.stack_end = (char*)stack_bottom;
2211 memset (&info->client_info.ctx, 0, sizeof (MonoContext));
2213 memset (&info->client_info.regs, 0, sizeof (info->client_info.regs));
2216 if (mono_gc_get_gc_callbacks ()->thread_attach_func)
2217 info->client_info.runtime_data = mono_gc_get_gc_callbacks ()->thread_attach_func ();
2219 binary_protocol_thread_register ((gpointer)mono_thread_info_get_tid (info));
2221 SGEN_LOG (3, "registered thread %p (%p) stack end %p", info, (gpointer)mono_thread_info_get_tid (info), info->client_info.stack_end);
2225 sgen_client_thread_unregister (SgenThreadInfo *p)
2227 MonoNativeThreadId tid;
2229 #ifndef HAVE_KW_THREAD
2230 mono_native_tls_set_value (thread_info_key, NULL);
2232 sgen_thread_info = NULL;
2235 tid = mono_thread_info_get_tid (p);
2237 if (p->client_info.info.runtime_thread)
2238 mono_threads_add_joinable_thread ((gpointer)tid);
2240 if (mono_gc_get_gc_callbacks ()->thread_detach_func) {
2241 mono_gc_get_gc_callbacks ()->thread_detach_func (p->client_info.runtime_data);
2242 p->client_info.runtime_data = NULL;
2245 binary_protocol_thread_unregister ((gpointer)tid);
2246 SGEN_LOG (3, "unregister thread %p (%p)", p, (gpointer)tid);
2250 mono_gc_set_skip_thread (gboolean skip)
2252 SgenThreadInfo *info = mono_thread_info_current ();
2255 info->client_info.gc_disabled = skip;
2260 is_critical_method (MonoMethod *method)
2262 return mono_runtime_is_critical_method (method) || sgen_is_critical_method (method);
2266 thread_in_critical_region (SgenThreadInfo *info)
2268 return info->client_info.in_critical_region;
2272 sgen_thread_attach (SgenThreadInfo *info)
2274 if (mono_gc_get_gc_callbacks ()->thread_attach_func && !info->client_info.runtime_data)
2275 info->client_info.runtime_data = mono_gc_get_gc_callbacks ()->thread_attach_func ();
2279 sgen_thread_detach (SgenThreadInfo *p)
2281 /* If a delegate is passed to native code and invoked on a thread we dont
2282 * know about, the jit will register it with mono_jit_thread_attach, but
2283 * we have no way of knowing when that thread goes away. SGen has a TSD
2284 * so we assume that if the domain is still registered, we can detach
2287 if (mono_domain_get ())
2288 mono_thread_detach_internal (mono_thread_internal_current ());
2292 mono_gc_register_thread (void *baseptr)
2294 return mono_thread_info_attach (baseptr) != NULL;
2298 mono_gc_is_gc_thread (void)
2302 result = mono_thread_info_current () != NULL;
2308 sgen_client_thread_register_worker (void)
2310 mono_thread_info_register_small_id ();
2313 /* Variables holding start/end nursery so it won't have to be passed at every call */
2314 static void *scan_area_arg_start, *scan_area_arg_end;
2317 mono_gc_conservatively_scan_area (void *start, void *end)
2319 sgen_conservatively_pin_objects_from (start, end, scan_area_arg_start, scan_area_arg_end, PIN_TYPE_STACK);
2323 mono_gc_scan_object (void *obj, void *gc_data)
2325 ScanCopyContext *ctx = gc_data;
2326 ctx->ops->copy_or_mark_object (&obj, ctx->queue);
2331 * Mark from thread stacks and registers.
2334 sgen_client_scan_thread_data (void *start_nursery, void *end_nursery, gboolean precise, ScanCopyContext ctx)
2336 SgenThreadInfo *info;
2338 scan_area_arg_start = start_nursery;
2339 scan_area_arg_end = end_nursery;
2341 FOREACH_THREAD (info) {
2342 int skip_reason = 0;
2343 if (info->client_info.skip) {
2344 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);
2346 } else if (info->client_info.gc_disabled) {
2347 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);
2349 } else if (!mono_thread_info_is_live (info)) {
2350 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);
2354 binary_protocol_scan_stack ((gpointer)mono_thread_info_get_tid (info), info->client_info.stack_start, info->client_info.stack_end, skip_reason);
2359 g_assert (info->client_info.suspend_done);
2360 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 ());
2361 if (mono_gc_get_gc_callbacks ()->thread_mark_func && !conservative_stack_mark) {
2362 mono_gc_get_gc_callbacks ()->thread_mark_func (info->client_info.runtime_data, info->client_info.stack_start, info->client_info.stack_end, precise, &ctx);
2363 } else if (!precise) {
2364 if (!conservative_stack_mark) {
2365 fprintf (stderr, "Precise stack mark not supported - disabling.\n");
2366 conservative_stack_mark = TRUE;
2368 sgen_conservatively_pin_objects_from (info->client_info.stack_start, info->client_info.stack_end, start_nursery, end_nursery, PIN_TYPE_STACK);
2373 sgen_conservatively_pin_objects_from ((void**)&info->client_info.ctx, (void**)&info->client_info.ctx + ARCH_NUM_REGS,
2374 start_nursery, end_nursery, PIN_TYPE_STACK);
2376 sgen_conservatively_pin_objects_from ((void**)&info->client_info.regs, (void**)&info->client_info.regs + ARCH_NUM_REGS,
2377 start_nursery, end_nursery, PIN_TYPE_STACK);
2380 } END_FOREACH_THREAD
2384 * mono_gc_set_stack_end:
2386 * Set the end of the current threads stack to STACK_END. The stack space between
2387 * STACK_END and the real end of the threads stack will not be scanned during collections.
2390 mono_gc_set_stack_end (void *stack_end)
2392 SgenThreadInfo *info;
2395 info = mono_thread_info_current ();
2397 SGEN_ASSERT (0, stack_end < info->client_info.stack_end, "Can only lower stack end");
2398 info->client_info.stack_end = stack_end;
2408 mono_gc_register_root (char *start, size_t size, void *descr)
2410 return sgen_register_root (start, size, descr, descr ? ROOT_TYPE_NORMAL : ROOT_TYPE_PINNED);
2414 mono_gc_register_root_wbarrier (char *start, size_t size, void *descr)
2416 return sgen_register_root (start, size, descr, ROOT_TYPE_WBARRIER);
2420 mono_gc_deregister_root (char* addr)
2422 sgen_deregister_root (addr);
2431 mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
2433 return pthread_create (new_thread, attr, start_routine, arg);
2442 sgen_client_total_allocated_heap_changed (size_t allocated_heap)
2444 mono_runtime_resource_check_limit (MONO_RESOURCE_GC_HEAP, allocated_heap);
2448 mono_gc_user_markers_supported (void)
2454 mono_object_is_alive (MonoObject* o)
2460 mono_gc_get_generation (MonoObject *obj)
2462 if (sgen_ptr_in_nursery (obj))
2468 mono_gc_enable_events (void)
2473 mono_gc_get_gc_name (void)
2479 mono_gc_get_description (void)
2481 return g_strdup ("sgen");
2485 mono_gc_set_desktop_mode (void)
2490 mono_gc_is_moving (void)
2496 mono_gc_is_disabled (void)
2502 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved)
2509 mono_gc_max_generation (void)
2515 mono_gc_precise_stack_mark_enabled (void)
2517 return !conservative_stack_mark;
2521 mono_gc_collect (int generation)
2523 sgen_gc_collect (generation);
2527 mono_gc_collection_count (int generation)
2529 return sgen_gc_collection_count (generation);
2533 mono_gc_get_used_size (void)
2535 return (int64_t)sgen_gc_get_used_size ();
2539 mono_gc_get_heap_size (void)
2541 return (int64_t)sgen_gc_get_total_heap_allocation ();
2545 mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker)
2547 return sgen_make_user_root_descriptor (marker);
2551 mono_gc_make_descr_for_string (gsize *bitmap, int numbits)
2553 return (void*)SGEN_DESC_STRING;
2557 mono_gc_get_nursery (int *shift_bits, size_t *size)
2559 *size = sgen_nursery_size;
2560 *shift_bits = DEFAULT_NURSERY_BITS;
2561 return sgen_get_nursery_start ();
2565 mono_gc_get_los_limit (void)
2567 return SGEN_MAX_SMALL_OBJ_SIZE;
2571 mono_gc_weak_link_add (void **link_addr, MonoObject *obj, gboolean track)
2573 sgen_register_disappearing_link (obj, link_addr, track, FALSE);
2577 mono_gc_weak_link_remove (void **link_addr, gboolean track)
2579 sgen_register_disappearing_link (NULL, link_addr, track, FALSE);
2583 mono_gc_weak_link_get (void **link_addr)
2585 return sgen_weak_link_get (link_addr);
2589 mono_gc_set_allow_synchronous_major (gboolean flag)
2591 return sgen_set_allow_synchronous_major (flag);
2595 mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data)
2599 result = func (data);
2600 UNLOCK_INTERRUPTION;
2605 mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size)
2611 sgen_client_out_of_memory (size_t size)
2613 mono_gc_out_of_memory (size);
2617 mono_gc_get_card_table (int *shift_bits, gpointer *mask)
2619 return sgen_get_card_table_configuration (shift_bits, mask);
2623 mono_gc_card_table_nursery_check (void)
2625 return !sgen_get_major_collector ()->is_concurrent;
2628 /* Negative value to remove */
2630 mono_gc_add_memory_pressure (gint64 value)
2632 /* FIXME: Implement at some point? */
2640 sgen_client_degraded_allocation (size_t size)
2642 static int last_major_gc_warned = -1;
2643 static int num_degraded = 0;
2645 if (last_major_gc_warned < gc_stats.major_gc_count) {
2647 if (num_degraded == 1 || num_degraded == 3)
2648 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Degraded allocation. Consider increasing nursery-size if the warning persists.");
2649 else if (num_degraded == 10)
2650 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Repeated degraded allocation. Consider increasing nursery-size.");
2651 last_major_gc_warned = gc_stats.major_gc_count;
2656 sgen_client_log_timing (GGTimingInfo *info, mword last_major_num_sections, mword last_los_memory_usage)
2658 SgenMajorCollector *major_collector = sgen_get_major_collector ();
2659 mword num_major_sections = major_collector->get_num_major_sections ();
2660 char full_timing_buff [1024];
2661 full_timing_buff [0] = '\0';
2663 if (!info->is_overflow)
2664 sprintf (full_timing_buff, "total %.2fms, bridge %.2fms", info->stw_time / 10000.0f, (int)info->bridge_time / 10000.0f);
2665 if (info->generation == GENERATION_OLD)
2666 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "GC_MAJOR%s: (%s) pause %.2fms, %s major %dK/%dK los %dK/%dK",
2667 info->is_overflow ? "_OVERFLOW" : "",
2668 info->reason ? info->reason : "",
2669 (int)info->total_time / 10000.0f,
2671 major_collector->section_size * num_major_sections / 1024,
2672 major_collector->section_size * last_major_num_sections / 1024,
2673 los_memory_usage / 1024,
2674 last_los_memory_usage / 1024);
2676 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "GC_MINOR%s: (%s) pause %.2fms, %s promoted %dK major %dK los %dK",
2677 info->is_overflow ? "_OVERFLOW" : "",
2678 info->reason ? info->reason : "",
2679 (int)info->total_time / 10000.0f,
2681 (num_major_sections - last_major_num_sections) * major_collector->section_size / 1024,
2682 major_collector->section_size * num_major_sections / 1024,
2683 los_memory_usage / 1024);
2691 sgen_client_description_for_internal_mem_type (int type)
2694 case INTERNAL_MEM_EPHEMERON_LINK: return "ephemeron-link";
2701 sgen_client_pre_collection_checks (void)
2703 if (sgen_mono_xdomain_checks) {
2704 sgen_clear_nursery_fragments ();
2705 sgen_check_for_xdomain_refs ();
2710 sgen_client_vtable_is_inited (GCVTable *gc_vtable)
2712 MonoVTable *vt = (MonoVTable*)gc_vtable;
2713 return vt->klass->inited;
2717 sgen_client_vtable_get_namespace (GCVTable *gc_vtable)
2719 MonoVTable *vt = (MonoVTable*)gc_vtable;
2720 return vt->klass->name_space;
2724 sgen_client_vtable_get_name (GCVTable *gc_vtable)
2726 MonoVTable *vt = (MonoVTable*)gc_vtable;
2727 return vt->klass->name;
2735 sgen_client_init (void)
2738 MonoThreadInfoCallbacks cb;
2740 cb.thread_register = sgen_thread_register;
2741 cb.thread_detach = sgen_thread_detach;
2742 cb.thread_unregister = sgen_thread_unregister;
2743 cb.thread_attach = sgen_thread_attach;
2744 cb.mono_method_is_critical = (gpointer)is_critical_method;
2745 cb.mono_thread_in_critical_region = thread_in_critical_region;
2747 mono_threads_init (&cb, sizeof (SgenThreadInfo));
2749 ///* Keep this the default for now */
2750 /* Precise marking is broken on all supported targets. Disable until fixed. */
2751 conservative_stack_mark = TRUE;
2753 sgen_register_fixed_internal_mem_type (INTERNAL_MEM_EPHEMERON_LINK, sizeof (EphemeronLinkNode));
2755 mono_sgen_init_stw ();
2757 #ifndef HAVE_KW_THREAD
2758 mono_native_tls_alloc (&thread_info_key, NULL);
2759 #if defined(__APPLE__) || defined (HOST_WIN32)
2761 * CEE_MONO_TLS requires the tls offset, not the key, so the code below only works on darwin,
2762 * where the two are the same.
2764 mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, thread_info_key);
2768 int tls_offset = -1;
2769 MONO_THREAD_VAR_OFFSET (sgen_thread_info, tls_offset);
2770 mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, tls_offset);
2775 * This needs to happen before any internal allocations because
2776 * it inits the small id which is required for hazard pointer
2781 mono_gc_register_thread (&dummy);
2785 sgen_client_handle_gc_param (const char *opt)
2787 if (g_str_has_prefix (opt, "stack-mark=")) {
2788 opt = strchr (opt, '=') + 1;
2789 if (!strcmp (opt, "precise")) {
2790 conservative_stack_mark = FALSE;
2791 } else if (!strcmp (opt, "conservative")) {
2792 conservative_stack_mark = TRUE;
2794 sgen_env_var_error (MONO_GC_PARAMS_NAME, conservative_stack_mark ? "Using `conservative`." : "Using `precise`.",
2795 "Invalid value `%s` for `stack-mark` option, possible values are: `precise`, `conservative`.", opt);
2797 } else if (g_str_has_prefix (opt, "bridge-implementation=")) {
2798 opt = strchr (opt, '=') + 1;
2799 sgen_set_bridge_implementation (opt);
2800 } else if (g_str_has_prefix (opt, "toggleref-test")) {
2801 /* FIXME: This should probably in MONO_GC_DEBUG */
2802 sgen_register_test_toggleref_callback ();
2810 sgen_client_print_gc_params_usage (void)
2812 fprintf (stderr, " stack-mark=MARK-METHOD (where MARK-METHOD is 'precise' or 'conservative')\n");
2816 sgen_client_handle_gc_debug (const char *opt)
2818 if (!strcmp (opt, "xdomain-checks")) {
2819 sgen_mono_xdomain_checks = TRUE;
2820 } else if (!strcmp (opt, "do-not-finalize")) {
2821 do_not_finalize = TRUE;
2822 } else if (!strcmp (opt, "log-finalizers")) {
2823 log_finalizers = TRUE;
2824 } else if (!strcmp (opt, "no-managed-allocator")) {
2825 sgen_set_use_managed_allocator (FALSE);
2826 } else if (!sgen_bridge_handle_gc_debug (opt)) {
2833 sgen_client_print_gc_debug_usage (void)
2835 fprintf (stderr, " xdomain-checks\n");
2836 fprintf (stderr, " do-not-finalize\n");
2837 fprintf (stderr, " log-finalizers\n");
2838 fprintf (stderr, " no-managed-allocator\n");
2839 sgen_bridge_print_gc_debug_usage ();
2844 sgen_client_get_provenance (void)
2846 #ifdef SGEN_OBJECT_PROVENANCE
2847 MonoGCCallbacks *cb = mono_gc_get_gc_callbacks ();
2848 gpointer (*get_provenance_func) (void);
2851 get_provenance_func = cb->get_provenance_func;
2852 if (get_provenance_func)
2853 return get_provenance_func ();
2861 sgen_client_describe_invalid_pointer (GCObject *ptr)
2863 sgen_bridge_describe_pointer (ptr);
2867 mono_gc_base_init (void)
2869 mono_counters_init ();
2871 #ifdef HEAVY_STATISTICS
2872 mono_counters_register ("los marked cards", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_marked_cards);
2873 mono_counters_register ("los array cards scanned ", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_cards);
2874 mono_counters_register ("los array remsets", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_remsets);
2876 mono_counters_register ("WBarrier set arrayref", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_set_arrayref);
2877 mono_counters_register ("WBarrier value copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_value_copy);
2878 mono_counters_register ("WBarrier object copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_object_copy);
2883 if (nursery_canaries_enabled ())
2884 sgen_set_use_managed_allocator (FALSE);
2888 mono_gc_base_cleanup (void)
2893 mono_gc_is_null (void)