2 * boehm-gc.c: GC implementation using either the installed or included Boehm GC.
4 * Copyright 2001-2003 Ximian, Inc (http://www.ximian.com)
5 * Copyright 2004-2011 Novell, Inc (http://www.novell.com)
6 * Copyright 2011-2012 Xamarin, Inc (http://www.xamarin.com)
13 #define GC_I_HIDE_POINTERS
14 #include <mono/metadata/gc-internal.h>
15 #include <mono/metadata/mono-gc.h>
16 #include <mono/metadata/profiler-private.h>
17 #include <mono/metadata/class-internals.h>
18 #include <mono/metadata/method-builder.h>
19 #include <mono/metadata/opcodes.h>
20 #include <mono/metadata/domain-internals.h>
21 #include <mono/metadata/metadata-internals.h>
22 #include <mono/metadata/marshal.h>
23 #include <mono/metadata/runtime.h>
24 #include <mono/metadata/sgen-toggleref.h>
25 #include <mono/utils/atomic.h>
26 #include <mono/utils/mono-logger-internal.h>
27 #include <mono/utils/mono-memory-model.h>
28 #include <mono/utils/mono-time.h>
29 #include <mono/utils/mono-threads.h>
30 #include <mono/utils/dtrace.h>
31 #include <mono/utils/gc_wrapper.h>
32 #include <mono/utils/mono-mutex.h>
33 #include <mono/utils/mono-counters.h>
39 #define THREAD_LOCAL_ALLOC 1
40 #include "private/pthread_support.h"
42 #if defined(PLATFORM_MACOSX) && defined(HAVE_PTHREAD_GET_STACKADDR_NP)
43 void *pthread_get_stackaddr_np(pthread_t);
46 #define GC_NO_DESCRIPTOR ((gpointer)(0 | GC_DS_LENGTH))
47 /*Boehm max heap cannot be smaller than 16MB*/
48 #define MIN_BOEHM_MAX_HEAP_SIZE_IN_MB 16
49 #define MIN_BOEHM_MAX_HEAP_SIZE (MIN_BOEHM_MAX_HEAP_SIZE_IN_MB << 20)
51 static gboolean gc_initialized = FALSE;
52 static mono_mutex_t mono_gc_lock;
55 boehm_thread_register (MonoThreadInfo* info, void *baseptr);
57 boehm_thread_unregister (MonoThreadInfo *p);
59 register_test_toggleref_callback (void);
61 #define BOEHM_GC_BIT_FINALIZER_AWARE 1
62 static MonoGCFinalizerCallbacks fin_callbacks;
65 mono_gc_warning (char *msg, GC_word arg)
67 mono_trace (G_LOG_LEVEL_WARNING, MONO_TRACE_GC, msg, (unsigned long)arg);
71 mono_gc_base_init (void)
73 MonoThreadInfoCallbacks cb;
80 mono_counters_init ();
83 * Handle the case when we are called from a thread different from the main thread,
85 * FIXME: Move this to libgc where it belongs.
87 * we used to do this only when running on valgrind,
88 * but it happens also in other setups.
90 #if defined(HAVE_PTHREAD_GETATTR_NP) && defined(HAVE_PTHREAD_ATTR_GETSTACK) && !defined(__native_client__)
95 pthread_getattr_np (pthread_self (), &attr);
96 pthread_attr_getstack (&attr, &sstart, &size);
97 pthread_attr_destroy (&attr);
98 /*g_print ("stackbottom pth is: %p\n", (char*)sstart + size);*/
101 * The calculation above doesn't seem to work on ia64, also we need to set
102 * GC_register_stackbottom as well, but don't know how.
105 /* apparently with some linuxthreads implementations sstart can be NULL,
106 * fallback to the more imprecise method (bug# 78096).
109 GC_stackbottom = (char*)sstart + size;
112 gsize stack_bottom = (gsize)&dummy;
113 stack_bottom += 4095;
114 stack_bottom &= ~4095;
115 GC_stackbottom = (char*)stack_bottom;
119 #elif defined(HAVE_PTHREAD_GET_STACKSIZE_NP) && defined(HAVE_PTHREAD_GET_STACKADDR_NP)
120 GC_stackbottom = (char*)pthread_get_stackaddr_np (pthread_self ());
121 #elif defined(__OpenBSD__)
122 # include <pthread_np.h>
127 rslt = pthread_stackseg_np(pthread_self(), &ss);
128 g_assert (rslt == 0);
130 GC_stackbottom = (char*)ss.ss_sp;
132 #elif defined(__native_client__)
133 /* Do nothing, GC_stackbottom is set correctly in libgc */
137 gsize stack_bottom = (gsize)&dummy;
138 stack_bottom += 4095;
139 stack_bottom &= ~4095;
140 /*g_print ("stackbottom is: %p\n", (char*)stack_bottom);*/
141 GC_stackbottom = (char*)stack_bottom;
145 #if !defined(PLATFORM_ANDROID)
146 /* If GC_no_dls is set to true, GC_find_limit is not called. This causes a seg fault on Android. */
150 if ((env = g_getenv ("MONO_GC_DEBUG"))) {
151 char **opts = g_strsplit (env, ",", -1);
152 for (char **ptr = opts; ptr && *ptr; ptr ++) {
154 if (!strcmp (opt, "do-not-finalize")) {
156 } else if (!strcmp (opt, "log-finalizers")) {
165 GC_oom_fn = mono_gc_out_of_memory;
166 GC_set_warn_proc (mono_gc_warning);
167 GC_finalize_on_demand = 1;
168 GC_finalizer_notifier = mono_gc_finalize_notify;
170 GC_init_gcj_malloc (5, NULL);
172 if ((env = g_getenv ("MONO_GC_PARAMS"))) {
173 char **ptr, **opts = g_strsplit (env, ",", -1);
174 for (ptr = opts; *ptr; ++ptr) {
176 if (g_str_has_prefix (opt, "max-heap-size=")) {
179 opt = strchr (opt, '=') + 1;
180 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &max_heap)) {
181 if (max_heap < MIN_BOEHM_MAX_HEAP_SIZE) {
182 fprintf (stderr, "max-heap-size must be at least %dMb.\n", MIN_BOEHM_MAX_HEAP_SIZE_IN_MB);
185 GC_set_max_heap_size (max_heap);
187 fprintf (stderr, "max-heap-size must be an integer.\n");
191 } else if (g_str_has_prefix (opt, "toggleref-test")) {
192 register_test_toggleref_callback ();
195 /* Could be a parameter for sgen */
197 fprintf (stderr, "MONO_GC_PARAMS must be a comma-delimited list of one or more of the following:\n");
198 fprintf (stderr, " max-heap-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
206 memset (&cb, 0, sizeof (cb));
207 cb.thread_register = boehm_thread_register;
208 cb.thread_unregister = boehm_thread_unregister;
209 cb.mono_method_is_critical = (gpointer)mono_runtime_is_critical_method;
211 mono_threads_init (&cb, sizeof (MonoThreadInfo));
212 mono_mutex_init (&mono_gc_lock);
214 mono_thread_info_attach (&dummy);
216 mono_gc_enable_events ();
217 gc_initialized = TRUE;
221 mono_gc_base_cleanup (void)
223 GC_finalizer_notifier = NULL;
228 * @generation: GC generation identifier
230 * Perform a garbage collection for the given generation, higher numbers
231 * mean usually older objects. Collecting a high-numbered generation
232 * implies collecting also the lower-numbered generations.
233 * The maximum value for @generation can be retrieved with a call to
234 * mono_gc_max_generation(), so this function is usually called as:
236 * mono_gc_collect (mono_gc_max_generation ());
239 mono_gc_collect (int generation)
241 #ifndef DISABLE_PERFCOUNTERS
242 mono_perfcounters->gc_induced++;
248 * mono_gc_max_generation:
250 * Get the maximum generation number used by the current garbage
251 * collector. The value will be 0 for the Boehm collector, 1 or more
252 * for the generational collectors.
254 * Returns: the maximum generation number.
257 mono_gc_max_generation (void)
263 * mono_gc_get_generation:
264 * @object: a managed object
266 * Get the garbage collector's generation that @object belongs to.
267 * Use this has a hint only.
269 * Returns: a garbage collector generation number
272 mono_gc_get_generation (MonoObject *object)
278 * mono_gc_collection_count:
279 * @generation: a GC generation number
281 * Get how many times a garbage collection has been performed
282 * for the given @generation number.
284 * Returns: the number of garbage collections
287 mono_gc_collection_count (int generation)
293 * mono_gc_add_memory_pressure:
294 * @value: amount of bytes
296 * Adjust the garbage collector's view of how many bytes of memory
297 * are indirectly referenced by managed objects (for example unmanaged
298 * memory holding image or other binary data).
299 * This is a hint only to the garbage collector algorithm.
300 * Note that negative amounts of @value will decrease the memory
304 mono_gc_add_memory_pressure (gint64 value)
309 * mono_gc_get_used_size:
311 * Get the approximate amount of memory used by managed objects.
313 * Returns: the amount of memory used in bytes
316 mono_gc_get_used_size (void)
318 return GC_get_heap_size () - GC_get_free_bytes ();
322 * mono_gc_get_heap_size:
324 * Get the amount of memory used by the garbage collector.
326 * Returns: the size of the heap in bytes
329 mono_gc_get_heap_size (void)
331 return GC_get_heap_size ();
335 mono_gc_is_gc_thread (void)
337 return GC_thread_is_registered ();
340 extern int GC_thread_register_foreign (void *base_addr);
343 mono_gc_register_thread (void *baseptr)
345 return mono_thread_info_attach (baseptr) != NULL;
349 boehm_thread_register (MonoThreadInfo* info, void *baseptr)
351 if (mono_gc_is_gc_thread())
353 #if !defined(HOST_WIN32)
354 return GC_thread_register_foreign (baseptr) ? info : NULL;
361 boehm_thread_unregister (MonoThreadInfo *p)
363 MonoNativeThreadId tid;
365 tid = mono_thread_info_get_tid (p);
367 if (p->runtime_thread)
368 mono_threads_add_joinable_thread ((gpointer)tid);
372 mono_object_is_alive (MonoObject* o)
374 return GC_is_marked ((gpointer)o);
378 mono_gc_walk_heap (int flags, MonoGCReferences callback, void *data)
383 static gint64 gc_start_time;
386 on_gc_notification (GCEventType event)
388 MonoGCEvent e = (MonoGCEvent)event;
391 case MONO_GC_EVENT_PRE_STOP_WORLD:
392 MONO_GC_WORLD_STOP_BEGIN ();
393 mono_thread_info_suspend_lock ();
396 case MONO_GC_EVENT_POST_STOP_WORLD:
397 MONO_GC_WORLD_STOP_END ();
400 case MONO_GC_EVENT_PRE_START_WORLD:
401 MONO_GC_WORLD_RESTART_BEGIN (1);
404 case MONO_GC_EVENT_POST_START_WORLD:
405 MONO_GC_WORLD_RESTART_END (1);
406 mono_thread_info_suspend_unlock ();
409 case MONO_GC_EVENT_START:
411 #ifndef DISABLE_PERFCOUNTERS
412 if (mono_perfcounters)
413 mono_perfcounters->gc_collections0++;
415 gc_stats.major_gc_count ++;
416 gc_start_time = mono_100ns_ticks ();
419 case MONO_GC_EVENT_END:
421 #if defined(ENABLE_DTRACE) && defined(__sun__)
422 /* This works around a dtrace -G problem on Solaris.
423 Limit its actual use to when the probe is enabled. */
424 if (MONO_GC_END_ENABLED ())
428 #ifndef DISABLE_PERFCOUNTERS
429 if (mono_perfcounters) {
430 guint64 heap_size = GC_get_heap_size ();
431 guint64 used_size = heap_size - GC_get_free_bytes ();
432 mono_perfcounters->gc_total_bytes = used_size;
433 mono_perfcounters->gc_committed_bytes = heap_size;
434 mono_perfcounters->gc_reserved_bytes = heap_size;
435 mono_perfcounters->gc_gen0size = heap_size;
438 gc_stats.major_gc_time += mono_100ns_ticks () - gc_start_time;
439 mono_trace_message (MONO_TRACE_GC, "gc took %d usecs", (mono_100ns_ticks () - gc_start_time) / 10);
445 mono_profiler_gc_event (e, 0);
449 on_gc_heap_resize (size_t new_size)
451 guint64 heap_size = GC_get_heap_size ();
452 #ifndef DISABLE_PERFCOUNTERS
453 if (mono_perfcounters) {
454 mono_perfcounters->gc_committed_bytes = heap_size;
455 mono_perfcounters->gc_reserved_bytes = heap_size;
456 mono_perfcounters->gc_gen0size = heap_size;
459 mono_profiler_gc_heap_resize (new_size);
463 mono_gc_enable_events (void)
465 GC_notify_event = on_gc_notification;
466 GC_on_heap_resize = on_gc_heap_resize;
469 static gboolean alloc_events = FALSE;
472 mono_gc_enable_alloc_events (void)
478 mono_gc_register_root (char *start, size_t size, void *descr, MonoGCRootSource source, const char *msg)
480 /* for some strange reason, they want one extra byte on the end */
481 GC_add_roots (start, start + size + 1);
487 mono_gc_deregister_root (char* addr)
490 /* FIXME: libgc doesn't define this work win32 for some reason */
491 /* FIXME: No size info */
492 GC_remove_roots (addr, addr + sizeof (gpointer) + 1);
497 mono_gc_weak_link_add (void **link_addr, MonoObject *obj, gboolean track)
499 /* libgc requires that we use HIDE_POINTER... */
500 *link_addr = (void*)HIDE_POINTER (obj);
502 GC_REGISTER_LONG_LINK (link_addr, obj);
504 GC_GENERAL_REGISTER_DISAPPEARING_LINK (link_addr, obj);
508 mono_gc_weak_link_remove (void **link_addr, gboolean track)
511 GC_unregister_long_link (link_addr);
513 GC_unregister_disappearing_link (link_addr);
518 reveal_link (gpointer link_addr)
520 void **link_a = link_addr;
521 return REVEAL_POINTER (*link_a);
525 mono_gc_weak_link_get (void **link_addr)
527 MonoObject *obj = GC_call_with_alloc_lock (reveal_link, link_addr);
528 if (obj == (MonoObject *) -1)
534 mono_gc_make_descr_for_string (gsize *bitmap, int numbits)
536 return mono_gc_make_descr_from_bitmap (bitmap, numbits);
540 mono_gc_make_descr_for_object (gsize *bitmap, int numbits, size_t obj_size)
542 return mono_gc_make_descr_from_bitmap (bitmap, numbits);
546 mono_gc_make_descr_for_array (int vector, gsize *elem_bitmap, int numbits, size_t elem_size)
548 /* libgc has no usable support for arrays... */
549 return GC_NO_DESCRIPTOR;
553 mono_gc_make_descr_from_bitmap (gsize *bitmap, int numbits)
555 /* It seems there are issues when the bitmap doesn't fit: play it safe */
557 return GC_NO_DESCRIPTOR;
559 return (gpointer)GC_make_descriptor ((GC_bitmap)bitmap, numbits);
563 mono_gc_make_root_descr_all_refs (int numbits)
569 mono_gc_alloc_fixed (size_t size, void *descr, MonoGCRootSource source, const char *msg)
571 /* To help track down typed allocation bugs */
575 if (count == atoi (g_getenv ("COUNT2")))
577 if (count > atoi (g_getenv ("COUNT2")))
578 return GC_MALLOC (size);
582 return GC_MALLOC_EXPLICITLY_TYPED (size, (GC_descr)descr);
584 return GC_MALLOC (size);
588 mono_gc_free_fixed (void* addr)
593 mono_gc_alloc_obj (MonoVTable *vtable, size_t size)
597 if (!vtable->klass->has_references) {
598 obj = GC_MALLOC_ATOMIC (size);
600 obj->vtable = vtable;
601 obj->synchronisation = NULL;
603 memset ((char *) obj + sizeof (MonoObject), 0, size - sizeof (MonoObject));
604 } else if (vtable->gc_descr != GC_NO_DESCRIPTOR) {
605 obj = GC_GCJ_MALLOC (size, vtable);
607 obj = GC_MALLOC (size);
609 obj->vtable = vtable;
612 if (G_UNLIKELY (alloc_events))
613 mono_profiler_allocation (obj);
619 mono_gc_alloc_vector (MonoVTable *vtable, size_t size, uintptr_t max_length)
623 if (!vtable->klass->has_references) {
624 obj = GC_MALLOC_ATOMIC (size);
626 obj->obj.vtable = vtable;
627 obj->obj.synchronisation = NULL;
629 memset ((char *) obj + sizeof (MonoObject), 0, size - sizeof (MonoObject));
630 } else if (vtable->gc_descr != GC_NO_DESCRIPTOR) {
631 obj = GC_GCJ_MALLOC (size, vtable);
633 obj = GC_MALLOC (size);
635 obj->obj.vtable = vtable;
638 obj->max_length = max_length;
640 if (G_UNLIKELY (alloc_events))
641 mono_profiler_allocation (&obj->obj);
647 mono_gc_alloc_array (MonoVTable *vtable, size_t size, uintptr_t max_length, uintptr_t bounds_size)
651 if (!vtable->klass->has_references) {
652 obj = GC_MALLOC_ATOMIC (size);
654 obj->obj.vtable = vtable;
655 obj->obj.synchronisation = NULL;
657 memset ((char *) obj + sizeof (MonoObject), 0, size - sizeof (MonoObject));
658 } else if (vtable->gc_descr != GC_NO_DESCRIPTOR) {
659 obj = GC_GCJ_MALLOC (size, vtable);
661 obj = GC_MALLOC (size);
663 obj->obj.vtable = vtable;
666 obj->max_length = max_length;
669 obj->bounds = (MonoArrayBounds *) ((char *) obj + size - bounds_size);
671 if (G_UNLIKELY (alloc_events))
672 mono_profiler_allocation (&obj->obj);
678 mono_gc_alloc_string (MonoVTable *vtable, size_t size, gint32 len)
680 MonoString *obj = GC_MALLOC_ATOMIC (size);
682 obj->object.vtable = vtable;
683 obj->object.synchronisation = NULL;
685 obj->chars [len] = 0;
687 if (G_UNLIKELY (alloc_events))
688 mono_profiler_allocation (&obj->object);
694 mono_gc_invoke_finalizers (void)
696 /* There is a bug in GC_invoke_finalizer () in versions <= 6.2alpha4:
697 * the 'mem_freed' variable is not initialized when there are no
698 * objects to finalize, which leads to strange behavior later on.
699 * The check is necessary to work around that bug.
701 if (GC_should_invoke_finalizers ())
702 return GC_invoke_finalizers ();
707 mono_gc_pending_finalizers (void)
709 return GC_should_invoke_finalizers ();
713 mono_gc_wbarrier_set_field (MonoObject *obj, gpointer field_ptr, MonoObject* value)
715 *(void**)field_ptr = value;
719 mono_gc_wbarrier_set_arrayref (MonoArray *arr, gpointer slot_ptr, MonoObject* value)
721 *(void**)slot_ptr = value;
725 mono_gc_wbarrier_arrayref_copy (gpointer dest_ptr, gpointer src_ptr, int count)
727 mono_gc_memmove_aligned (dest_ptr, src_ptr, count * sizeof (gpointer));
731 mono_gc_wbarrier_generic_store (gpointer ptr, MonoObject* value)
733 *(void**)ptr = value;
737 mono_gc_wbarrier_generic_store_atomic (gpointer ptr, MonoObject *value)
739 InterlockedWritePointer (ptr, value);
743 mono_gc_wbarrier_generic_nostore (gpointer ptr)
748 mono_gc_wbarrier_value_copy (gpointer dest, gpointer src, int count, MonoClass *klass)
750 mono_gc_memmove_atomic (dest, src, count * mono_class_value_size (klass, NULL));
754 mono_gc_wbarrier_object_copy (MonoObject* obj, MonoObject *src)
756 /* do not copy the sync state */
757 mono_gc_memmove_aligned ((char*)obj + sizeof (MonoObject), (char*)src + sizeof (MonoObject),
758 mono_object_class (obj)->instance_size - sizeof (MonoObject));
762 mono_gc_clear_domain (MonoDomain *domain)
767 mono_gc_get_suspend_signal (void)
769 return GC_get_suspend_signal ();
773 mono_gc_get_restart_signal (void)
775 return GC_get_restart_signal ();
778 #if defined(USE_COMPILER_TLS) && defined(__linux__) && (defined(__i386__) || defined(__x86_64__))
779 extern __thread MONO_TLS_FAST void* GC_thread_tls;
780 #include "metadata-internals.h"
786 while (!(v & (1 << i)))
793 ATYPE_FREEPTR_FOR_BOX,
801 create_allocator (int atype, int tls_key, gboolean slowpath)
803 int index_var, bytes_var, my_fl_var, my_entry_var;
804 guint32 no_freelist_branch, not_small_enough_branch = 0;
805 guint32 size_overflow_branch = 0;
806 MonoMethodBuilder *mb;
808 MonoMethodSignature *csig;
809 const char *name = NULL;
810 AllocatorWrapperInfo *info;
812 if (atype == ATYPE_FREEPTR) {
813 name = slowpath ? "SlowAllocPtrfree" : "AllocPtrfree";
814 } else if (atype == ATYPE_FREEPTR_FOR_BOX) {
815 name = slowpath ? "SlowAllocPtrfreeBox" : "AllocPtrfreeBox";
816 } else if (atype == ATYPE_NORMAL) {
817 name = slowpath ? "SlowAlloc" : "Alloc";
818 } else if (atype == ATYPE_GCJ) {
819 name = slowpath ? "SlowAllocGcj" : "AllocGcj";
820 } else if (atype == ATYPE_STRING) {
821 name = slowpath ? "SlowAllocString" : "AllocString";
823 g_assert_not_reached ();
826 csig = mono_metadata_signature_alloc (mono_defaults.corlib, 2);
828 if (atype == ATYPE_STRING) {
829 csig->ret = &mono_defaults.string_class->byval_arg;
830 csig->params [0] = &mono_defaults.int_class->byval_arg;
831 csig->params [1] = &mono_defaults.int32_class->byval_arg;
833 csig->ret = &mono_defaults.object_class->byval_arg;
834 csig->params [0] = &mono_defaults.int_class->byval_arg;
835 csig->params [1] = &mono_defaults.int32_class->byval_arg;
838 mb = mono_mb_new (mono_defaults.object_class, name, MONO_WRAPPER_ALLOC);
841 goto always_slowpath;
843 bytes_var = mono_mb_add_local (mb, &mono_defaults.int32_class->byval_arg);
844 if (atype == ATYPE_STRING) {
845 /* a string alloator method takes the args: (vtable, len) */
846 /* bytes = (offsetof (MonoString, chars) + ((len + 1) * 2)); */
847 mono_mb_emit_ldarg (mb, 1);
848 mono_mb_emit_icon (mb, 1);
849 mono_mb_emit_byte (mb, MONO_CEE_ADD);
850 mono_mb_emit_icon (mb, 1);
851 mono_mb_emit_byte (mb, MONO_CEE_SHL);
852 // sizeof (MonoString) might include padding
853 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoString, chars));
854 mono_mb_emit_byte (mb, MONO_CEE_ADD);
855 mono_mb_emit_stloc (mb, bytes_var);
857 mono_mb_emit_ldarg (mb, 1);
858 mono_mb_emit_stloc (mb, bytes_var);
861 /* this is needed for strings/arrays only as the other big types are never allocated with this method */
862 if (atype == ATYPE_STRING) {
864 /* if (!SMALL_ENOUGH (bytes)) jump slow_path;*/
865 mono_mb_emit_ldloc (mb, bytes_var);
866 mono_mb_emit_icon (mb, (NFREELISTS-1) * GRANULARITY);
867 not_small_enough_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BGT_UN_S);
868 /* check for overflow */
869 mono_mb_emit_ldloc (mb, bytes_var);
870 mono_mb_emit_icon (mb, sizeof (MonoString));
871 size_overflow_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLE_UN_S);
874 /* int index = INDEX_FROM_BYTES(bytes); */
875 index_var = mono_mb_add_local (mb, &mono_defaults.int32_class->byval_arg);
877 mono_mb_emit_ldloc (mb, bytes_var);
878 mono_mb_emit_icon (mb, GRANULARITY - 1);
879 mono_mb_emit_byte (mb, MONO_CEE_ADD);
880 mono_mb_emit_icon (mb, shift_amount (GRANULARITY));
881 mono_mb_emit_byte (mb, MONO_CEE_SHR_UN);
882 mono_mb_emit_icon (mb, shift_amount (sizeof (gpointer)));
883 mono_mb_emit_byte (mb, MONO_CEE_SHL);
884 /* index var is already adjusted into bytes */
885 mono_mb_emit_stloc (mb, index_var);
887 my_fl_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
888 my_entry_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
889 /* my_fl = ((GC_thread)tsd) -> ptrfree_freelists + index; */
890 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
891 mono_mb_emit_byte (mb, 0x0D); /* CEE_MONO_TLS */
892 mono_mb_emit_i4 (mb, tls_key);
893 if (atype == ATYPE_FREEPTR || atype == ATYPE_FREEPTR_FOR_BOX || atype == ATYPE_STRING)
894 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, ptrfree_freelists));
895 else if (atype == ATYPE_NORMAL)
896 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, normal_freelists));
897 else if (atype == ATYPE_GCJ)
898 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, gcj_freelists));
900 g_assert_not_reached ();
901 mono_mb_emit_byte (mb, MONO_CEE_ADD);
902 mono_mb_emit_ldloc (mb, index_var);
903 mono_mb_emit_byte (mb, MONO_CEE_ADD);
904 mono_mb_emit_stloc (mb, my_fl_var);
906 /* my_entry = *my_fl; */
907 mono_mb_emit_ldloc (mb, my_fl_var);
908 mono_mb_emit_byte (mb, MONO_CEE_LDIND_I);
909 mono_mb_emit_stloc (mb, my_entry_var);
911 /* if (EXPECT((word)my_entry >= HBLKSIZE, 1)) { */
912 mono_mb_emit_ldloc (mb, my_entry_var);
913 mono_mb_emit_icon (mb, HBLKSIZE);
914 no_freelist_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLT_UN_S);
916 /* ptr_t next = obj_link(my_entry); *my_fl = next; */
917 mono_mb_emit_ldloc (mb, my_fl_var);
918 mono_mb_emit_ldloc (mb, my_entry_var);
919 mono_mb_emit_byte (mb, MONO_CEE_LDIND_I);
920 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
922 /* set the vtable and clear the words in the object */
923 mono_mb_emit_ldloc (mb, my_entry_var);
924 mono_mb_emit_ldarg (mb, 0);
925 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
927 if (atype == ATYPE_FREEPTR) {
928 int start_var, end_var, start_loop;
929 /* end = my_entry + bytes; start = my_entry + sizeof (gpointer);
931 start_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
932 end_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
933 mono_mb_emit_ldloc (mb, my_entry_var);
934 mono_mb_emit_ldloc (mb, bytes_var);
935 mono_mb_emit_byte (mb, MONO_CEE_ADD);
936 mono_mb_emit_stloc (mb, end_var);
937 mono_mb_emit_ldloc (mb, my_entry_var);
938 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoObject, synchronisation));
939 mono_mb_emit_byte (mb, MONO_CEE_ADD);
940 mono_mb_emit_stloc (mb, start_var);
944 * } while (start < end);
946 start_loop = mono_mb_get_label (mb);
947 mono_mb_emit_ldloc (mb, start_var);
948 mono_mb_emit_icon (mb, 0);
949 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
950 mono_mb_emit_ldloc (mb, start_var);
951 mono_mb_emit_icon (mb, sizeof (gpointer));
952 mono_mb_emit_byte (mb, MONO_CEE_ADD);
953 mono_mb_emit_stloc (mb, start_var);
955 mono_mb_emit_ldloc (mb, start_var);
956 mono_mb_emit_ldloc (mb, end_var);
957 mono_mb_emit_byte (mb, MONO_CEE_BLT_UN_S);
958 mono_mb_emit_byte (mb, start_loop - (mono_mb_get_label (mb) + 1));
959 } else if (atype == ATYPE_FREEPTR_FOR_BOX || atype == ATYPE_STRING) {
960 /* need to clear just the sync pointer */
961 mono_mb_emit_ldloc (mb, my_entry_var);
962 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoObject, synchronisation));
963 mono_mb_emit_byte (mb, MONO_CEE_ADD);
964 mono_mb_emit_icon (mb, 0);
965 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
968 if (atype == ATYPE_STRING) {
969 /* need to set length and clear the last char */
970 /* s->length = len; */
971 mono_mb_emit_ldloc (mb, my_entry_var);
972 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoString, length));
973 mono_mb_emit_byte (mb, MONO_CEE_ADD);
974 mono_mb_emit_ldarg (mb, 1);
975 mono_mb_emit_byte (mb, MONO_CEE_STIND_I4);
976 /* s->chars [len] = 0; */
977 mono_mb_emit_ldloc (mb, my_entry_var);
978 mono_mb_emit_ldloc (mb, bytes_var);
979 mono_mb_emit_icon (mb, 2);
980 mono_mb_emit_byte (mb, MONO_CEE_SUB);
981 mono_mb_emit_byte (mb, MONO_CEE_ADD);
982 mono_mb_emit_icon (mb, 0);
983 mono_mb_emit_byte (mb, MONO_CEE_STIND_I2);
986 /* return my_entry; */
987 mono_mb_emit_ldloc (mb, my_entry_var);
988 mono_mb_emit_byte (mb, MONO_CEE_RET);
990 mono_mb_patch_short_branch (mb, no_freelist_branch);
991 if (not_small_enough_branch > 0)
992 mono_mb_patch_short_branch (mb, not_small_enough_branch);
993 if (size_overflow_branch > 0)
994 mono_mb_patch_short_branch (mb, size_overflow_branch);
996 /* the slow path: we just call back into the runtime */
998 if (atype == ATYPE_STRING) {
999 mono_mb_emit_ldarg (mb, 1);
1000 mono_mb_emit_icall (mb, mono_string_alloc);
1002 mono_mb_emit_ldarg (mb, 0);
1003 mono_mb_emit_icall (mb, mono_object_new_specific);
1006 mono_mb_emit_byte (mb, MONO_CEE_RET);
1008 res = mono_mb_create_method (mb, csig, 8);
1010 mono_method_get_header (res)->init_locals = FALSE;
1012 info = mono_image_alloc0 (mono_defaults.corlib, sizeof (AllocatorWrapperInfo));
1013 info->gc_name = "boehm";
1014 info->alloc_type = atype;
1015 mono_marshal_set_wrapper_info (res, info);
1020 static MonoMethod* alloc_method_cache [ATYPE_NUM];
1021 static MonoMethod* slowpath_alloc_method_cache [ATYPE_NUM];
1023 static G_GNUC_UNUSED gboolean
1024 mono_gc_is_critical_method (MonoMethod *method)
1028 for (i = 0; i < ATYPE_NUM; ++i)
1029 if (method == alloc_method_cache [i] || method == slowpath_alloc_method_cache [i])
1036 * If possible, generate a managed method that can quickly allocate objects in class
1037 * @klass. The method will typically have an thread-local inline allocation sequence.
1038 * The signature of the called method is:
1039 * object allocate (MonoVTable *vtable)
1040 * Some of the logic here is similar to mono_class_get_allocation_ftn () i object.c,
1042 * The thread local alloc logic is taken from libgc/pthread_support.c.
1046 mono_gc_get_managed_allocator (MonoClass *klass, gboolean for_box, gboolean known_instance_size)
1050 MONO_THREAD_VAR_OFFSET (GC_thread_tls, offset);
1052 /*g_print ("thread tls: %d\n", offset);*/
1055 if (!SMALL_ENOUGH (klass->instance_size))
1057 if (mono_class_has_finalizer (klass) || mono_class_is_marshalbyref (klass) || (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS))
1061 if (mono_class_is_open_constructed_type (&klass->byval_arg))
1063 if (klass->byval_arg.type == MONO_TYPE_STRING) {
1064 atype = ATYPE_STRING;
1065 } else if (!known_instance_size) {
1067 } else if (!klass->has_references) {
1069 atype = ATYPE_FREEPTR_FOR_BOX;
1071 atype = ATYPE_FREEPTR;
1075 * disabled because we currently do a runtime choice anyway, to
1076 * deal with multiple appdomains.
1077 if (vtable->gc_descr != GC_NO_DESCRIPTOR)
1080 atype = ATYPE_NORMAL;
1083 return mono_gc_get_managed_allocator_by_type (atype, FALSE);
1087 mono_gc_get_managed_array_allocator (MonoClass *klass)
1093 * mono_gc_get_managed_allocator_by_type:
1095 * Return a managed allocator method corresponding to allocator type ATYPE.
1098 mono_gc_get_managed_allocator_by_type (int atype, gboolean slowpath)
1102 MonoMethod **cache = slowpath ? slowpath_alloc_method_cache : alloc_method_cache;
1103 MONO_THREAD_VAR_OFFSET (GC_thread_tls, offset);
1105 mono_tls_key_set_offset (TLS_KEY_BOEHM_GC_THREAD, offset);
1107 res = cache [atype];
1111 res = create_allocator (atype, TLS_KEY_BOEHM_GC_THREAD, slowpath);
1112 mono_mutex_lock (&mono_gc_lock);
1113 if (cache [atype]) {
1114 mono_free_method (res);
1115 res = cache [atype];
1117 mono_memory_barrier ();
1118 cache [atype] = res;
1120 mono_mutex_unlock (&mono_gc_lock);
1125 mono_gc_get_managed_allocator_types (void)
1131 mono_gc_get_write_barrier (void)
1133 g_assert_not_reached ();
1139 static G_GNUC_UNUSED gboolean
1140 mono_gc_is_critical_method (MonoMethod *method)
1146 mono_gc_get_managed_allocator (MonoClass *klass, gboolean for_box, gboolean known_instance_size)
1152 mono_gc_get_managed_array_allocator (MonoClass *klass)
1158 mono_gc_get_managed_allocator_by_type (int atype, gboolean slowpath)
1164 mono_gc_get_managed_allocator_types (void)
1170 mono_gc_get_write_barrier (void)
1172 g_assert_not_reached ();
1179 mono_gc_get_specific_write_barrier (gboolean is_concurrent)
1181 g_assert_not_reached ();
1186 mono_gc_get_aligned_size_for_allocator (int size)
1192 mono_gc_get_gc_name (void)
1198 mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data)
1200 return GC_call_with_alloc_lock (func, data);
1204 mono_gc_get_description (void)
1206 return g_strdup (DEFAULT_GC_NAME);
1210 mono_gc_set_desktop_mode (void)
1216 mono_gc_is_moving (void)
1222 mono_gc_is_disabled (void)
1224 if (GC_dont_gc || g_getenv ("GC_DONT_GC"))
1231 mono_gc_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap)
1233 g_assert_not_reached ();
1238 mono_gc_get_card_table (int *shift_bits, gpointer *card_mask)
1240 g_assert_not_reached ();
1245 mono_gc_card_table_nursery_check (void)
1247 g_assert_not_reached ();
1252 mono_gc_get_nursery (int *shift_bits, size_t *size)
1258 mono_gc_set_current_thread_appdomain (MonoDomain *domain)
1263 mono_gc_precise_stack_mark_enabled (void)
1269 mono_gc_get_logfile (void)
1275 mono_gc_conservatively_scan_area (void *start, void *end)
1277 g_assert_not_reached ();
1281 mono_gc_scan_object (void *obj, void *gc_data)
1283 g_assert_not_reached ();
1288 mono_gc_get_bitmap_for_descr (void *descr, int *numbits)
1290 g_assert_not_reached ();
1295 mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks)
1300 mono_gc_set_stack_end (void *stack_end)
1304 void mono_gc_set_skip_thread (gboolean value)
1309 mono_gc_register_for_finalization (MonoObject *obj, void *user_data)
1314 /* This assertion is not valid when GC_DEBUG is defined */
1315 g_assert (GC_base (obj) == (char*)obj - offset);
1318 GC_REGISTER_FINALIZER_NO_ORDER ((char*)obj - offset, user_data, GUINT_TO_POINTER (offset), NULL, NULL);
1323 mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
1325 /* it is being replaced by GC_pthread_create on some
1326 * platforms, see libgc/include/gc_pthread_redirects.h */
1327 return pthread_create (new_thread, attr, start_routine, arg);
1332 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved)
1334 return GC_DllMain (module_handle, reason, reserved);
1339 mono_gc_get_vtable_bits (MonoClass *class)
1341 if (fin_callbacks.is_class_finalization_aware) {
1342 if (fin_callbacks.is_class_finalization_aware (class))
1343 return BOEHM_GC_BIT_FINALIZER_AWARE;
1349 * mono_gc_register_altstack:
1351 * Register the dimensions of the normal stack and altstack with the collector.
1352 * Currently, STACK/STACK_SIZE is only used when the thread is suspended while it is on an altstack.
1355 mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size)
1357 GC_register_altstack (stack, stack_size, altstack, altstack_size);
1361 mono_gc_get_los_limit (void)
1367 mono_gc_set_string_length (MonoString *str, gint32 new_length)
1369 mono_unichar2 *new_end = str->chars + new_length;
1371 /* zero the discarded string. This null-delimits the string and allows
1372 * the space to be reclaimed by SGen. */
1374 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2));
1375 str->length = new_length;
1379 mono_gc_user_markers_supported (void)
1385 mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker)
1387 g_assert_not_reached ();
1392 mono_gc_set_allow_synchronous_major (gboolean flag)
1396 /* Toggleref support */
1399 mono_gc_toggleref_add (MonoObject *object, mono_bool strong_ref)
1401 GC_toggleref_add ((GC_PTR)object, (int)strong_ref);
1405 mono_gc_toggleref_register_callback (MonoToggleRefStatus (*proccess_toggleref) (MonoObject *obj))
1407 GC_toggleref_register_callback ((int (*) (GC_PTR obj)) proccess_toggleref);
1410 /* Test support code */
1412 static MonoToggleRefStatus
1413 test_toggleref_callback (MonoObject *obj)
1415 static MonoClassField *mono_toggleref_test_field;
1416 int status = MONO_TOGGLE_REF_DROP;
1418 if (!mono_toggleref_test_field) {
1419 mono_toggleref_test_field = mono_class_get_field_from_name (mono_object_get_class (obj), "__test");
1420 g_assert (mono_toggleref_test_field);
1423 mono_field_get_value (obj, mono_toggleref_test_field, &status);
1424 printf ("toggleref-cb obj %d\n", status);
1429 register_test_toggleref_callback (void)
1431 mono_gc_toggleref_register_callback (test_toggleref_callback);
1435 is_finalization_aware (MonoObject *obj)
1437 MonoVTable *vt = obj->vtable;
1438 return (vt->gc_bits & BOEHM_GC_BIT_FINALIZER_AWARE) == BOEHM_GC_BIT_FINALIZER_AWARE;
1442 fin_notifier (MonoObject *obj)
1444 if (is_finalization_aware (obj))
1445 fin_callbacks.object_queued_for_finalization (obj);
1449 mono_gc_register_finalizer_callbacks (MonoGCFinalizerCallbacks *callbacks)
1451 if (callbacks->version != MONO_GC_FINALIZER_EXTENSION_VERSION)
1452 g_error ("Invalid finalizer callback version. Expected %d but got %d\n", MONO_GC_FINALIZER_EXTENSION_VERSION, callbacks->version);
1454 fin_callbacks = *callbacks;
1456 GC_set_finalizer_notify_proc ((void (*) (GC_PTR))fin_notifier);
1460 mono_gc_is_null (void)
1465 #endif /* no Boehm GC */