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>
37 #ifdef USE_INCLUDED_LIBGC
40 #define THREAD_LOCAL_ALLOC 1
41 #include "private/pthread_support.h"
44 #if defined(PLATFORM_MACOSX) && defined(HAVE_PTHREAD_GET_STACKADDR_NP)
45 void *pthread_get_stackaddr_np(pthread_t);
48 #define GC_NO_DESCRIPTOR ((gpointer)(0 | GC_DS_LENGTH))
49 /*Boehm max heap cannot be smaller than 16MB*/
50 #define MIN_BOEHM_MAX_HEAP_SIZE_IN_MB 16
51 #define MIN_BOEHM_MAX_HEAP_SIZE (MIN_BOEHM_MAX_HEAP_SIZE_IN_MB << 20)
53 static gboolean gc_initialized = FALSE;
54 static mono_mutex_t mono_gc_lock;
57 boehm_thread_register (MonoThreadInfo* info, void *baseptr);
59 boehm_thread_unregister (MonoThreadInfo *p);
61 register_test_toggleref_callback (void);
63 #define BOEHM_GC_BIT_FINALIZER_AWARE 1
64 static MonoGCFinalizerCallbacks fin_callbacks;
67 mono_gc_warning (char *msg, GC_word arg)
69 mono_trace (G_LOG_LEVEL_WARNING, MONO_TRACE_GC, msg, (unsigned long)arg);
73 mono_gc_base_init (void)
75 MonoThreadInfoCallbacks cb;
82 mono_counters_init ();
85 * Handle the case when we are called from a thread different from the main thread,
87 * FIXME: Move this to libgc where it belongs.
89 * we used to do this only when running on valgrind,
90 * but it happens also in other setups.
92 #if defined(HAVE_PTHREAD_GETATTR_NP) && defined(HAVE_PTHREAD_ATTR_GETSTACK) && !defined(__native_client__)
97 pthread_getattr_np (pthread_self (), &attr);
98 pthread_attr_getstack (&attr, &sstart, &size);
99 pthread_attr_destroy (&attr);
100 /*g_print ("stackbottom pth is: %p\n", (char*)sstart + size);*/
103 * The calculation above doesn't seem to work on ia64, also we need to set
104 * GC_register_stackbottom as well, but don't know how.
107 /* apparently with some linuxthreads implementations sstart can be NULL,
108 * fallback to the more imprecise method (bug# 78096).
111 GC_stackbottom = (char*)sstart + size;
114 gsize stack_bottom = (gsize)&dummy;
115 stack_bottom += 4095;
116 stack_bottom &= ~4095;
117 GC_stackbottom = (char*)stack_bottom;
121 #elif defined(HAVE_PTHREAD_GET_STACKSIZE_NP) && defined(HAVE_PTHREAD_GET_STACKADDR_NP)
122 GC_stackbottom = (char*)pthread_get_stackaddr_np (pthread_self ());
123 #elif defined(__OpenBSD__)
124 # include <pthread_np.h>
129 rslt = pthread_stackseg_np(pthread_self(), &ss);
130 g_assert (rslt == 0);
132 GC_stackbottom = (char*)ss.ss_sp;
134 #elif defined(__native_client__)
135 /* Do nothing, GC_stackbottom is set correctly in libgc */
139 gsize stack_bottom = (gsize)&dummy;
140 stack_bottom += 4095;
141 stack_bottom &= ~4095;
142 /*g_print ("stackbottom is: %p\n", (char*)stack_bottom);*/
143 GC_stackbottom = (char*)stack_bottom;
147 #if !defined(PLATFORM_ANDROID)
148 /* If GC_no_dls is set to true, GC_find_limit is not called. This causes a seg fault on Android. */
152 GC_oom_fn = mono_gc_out_of_memory;
153 GC_set_warn_proc (mono_gc_warning);
154 GC_finalize_on_demand = 1;
155 GC_finalizer_notifier = mono_gc_finalize_notify;
157 #ifdef HAVE_GC_GCJ_MALLOC
158 GC_init_gcj_malloc (5, NULL);
161 #ifdef HAVE_GC_ALLOW_REGISTER_THREADS
162 GC_allow_register_threads();
165 if ((env = g_getenv ("MONO_GC_PARAMS"))) {
166 char **ptr, **opts = g_strsplit (env, ",", -1);
167 for (ptr = opts; *ptr; ++ptr) {
169 if (g_str_has_prefix (opt, "max-heap-size=")) {
172 opt = strchr (opt, '=') + 1;
173 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &max_heap)) {
174 if (max_heap < MIN_BOEHM_MAX_HEAP_SIZE) {
175 fprintf (stderr, "max-heap-size must be at least %dMb.\n", MIN_BOEHM_MAX_HEAP_SIZE_IN_MB);
178 GC_set_max_heap_size (max_heap);
180 fprintf (stderr, "max-heap-size must be an integer.\n");
184 } else if (g_str_has_prefix (opt, "toggleref-test")) {
185 register_test_toggleref_callback ();
188 /* Could be a parameter for sgen */
190 fprintf (stderr, "MONO_GC_PARAMS must be a comma-delimited list of one or more of the following:\n");
191 fprintf (stderr, " max-heap-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
199 memset (&cb, 0, sizeof (cb));
200 cb.thread_register = boehm_thread_register;
201 cb.thread_unregister = boehm_thread_unregister;
202 cb.mono_method_is_critical = (gpointer)mono_runtime_is_critical_method;
204 cb.thread_exit = mono_gc_pthread_exit;
205 cb.mono_gc_pthread_create = (gpointer)mono_gc_pthread_create;
208 mono_threads_init (&cb, sizeof (MonoThreadInfo));
209 mono_mutex_init (&mono_gc_lock);
211 mono_thread_info_attach (&dummy);
213 mono_gc_enable_events ();
214 gc_initialized = TRUE;
219 * @generation: GC generation identifier
221 * Perform a garbage collection for the given generation, higher numbers
222 * mean usually older objects. Collecting a high-numbered generation
223 * implies collecting also the lower-numbered generations.
224 * The maximum value for @generation can be retrieved with a call to
225 * mono_gc_max_generation(), so this function is usually called as:
227 * mono_gc_collect (mono_gc_max_generation ());
230 mono_gc_collect (int generation)
232 #ifndef DISABLE_PERFCOUNTERS
233 mono_perfcounters->gc_induced++;
239 * mono_gc_max_generation:
241 * Get the maximum generation number used by the current garbage
242 * collector. The value will be 0 for the Boehm collector, 1 or more
243 * for the generational collectors.
245 * Returns: the maximum generation number.
248 mono_gc_max_generation (void)
254 * mono_gc_get_generation:
255 * @object: a managed object
257 * Get the garbage collector's generation that @object belongs to.
258 * Use this has a hint only.
260 * Returns: a garbage collector generation number
263 mono_gc_get_generation (MonoObject *object)
269 * mono_gc_collection_count:
270 * @generation: a GC generation number
272 * Get how many times a garbage collection has been performed
273 * for the given @generation number.
275 * Returns: the number of garbage collections
278 mono_gc_collection_count (int generation)
284 * mono_gc_add_memory_pressure:
285 * @value: amount of bytes
287 * Adjust the garbage collector's view of how many bytes of memory
288 * are indirectly referenced by managed objects (for example unmanaged
289 * memory holding image or other binary data).
290 * This is a hint only to the garbage collector algorithm.
291 * Note that negative amounts of @value will decrease the memory
295 mono_gc_add_memory_pressure (gint64 value)
300 * mono_gc_get_used_size:
302 * Get the approximate amount of memory used by managed objects.
304 * Returns: the amount of memory used in bytes
307 mono_gc_get_used_size (void)
309 return GC_get_heap_size () - GC_get_free_bytes ();
313 * mono_gc_get_heap_size:
315 * Get the amount of memory used by the garbage collector.
317 * Returns: the size of the heap in bytes
320 mono_gc_get_heap_size (void)
322 return GC_get_heap_size ();
326 mono_gc_is_gc_thread (void)
328 #if GC_VERSION_MAJOR >= 7
330 #elif defined(USE_INCLUDED_LIBGC)
331 return GC_thread_is_registered ();
337 extern int GC_thread_register_foreign (void *base_addr);
340 mono_gc_register_thread (void *baseptr)
342 return mono_thread_info_attach (baseptr) != NULL;
346 boehm_thread_register (MonoThreadInfo* info, void *baseptr)
348 #if GC_VERSION_MAJOR >= 7
349 struct GC_stack_base sb;
352 res = GC_get_stack_base (&sb);
353 if (res != GC_SUCCESS) {
354 sb.mem_base = baseptr;
356 /* Can't determine the register stack bounds */
357 g_error ("mono_gc_register_thread failed ().\n");
360 res = GC_register_my_thread (&sb);
361 if ((res != GC_SUCCESS) && (res != GC_DUPLICATE)) {
362 g_warning ("GC_register_my_thread () failed.\n");
367 if (mono_gc_is_gc_thread())
369 #if defined(USE_INCLUDED_LIBGC) && !defined(HOST_WIN32)
370 return GC_thread_register_foreign (baseptr) ? info : NULL;
378 boehm_thread_unregister (MonoThreadInfo *p)
380 MonoNativeThreadId tid;
382 tid = mono_thread_info_get_tid (p);
384 if (p->runtime_thread)
385 mono_threads_add_joinable_thread ((gpointer)tid);
389 mono_object_is_alive (MonoObject* o)
391 #ifdef USE_INCLUDED_LIBGC
392 return GC_is_marked ((gpointer)o);
399 mono_gc_walk_heap (int flags, MonoGCReferences callback, void *data)
404 #ifdef USE_INCLUDED_LIBGC
406 static gint64 gc_start_time;
409 on_gc_notification (GCEventType event)
411 MonoGCEvent e = (MonoGCEvent)event;
414 case MONO_GC_EVENT_PRE_STOP_WORLD:
415 MONO_GC_WORLD_STOP_BEGIN ();
416 mono_thread_info_suspend_lock ();
419 case MONO_GC_EVENT_POST_STOP_WORLD:
420 MONO_GC_WORLD_STOP_END ();
423 case MONO_GC_EVENT_PRE_START_WORLD:
424 MONO_GC_WORLD_RESTART_BEGIN (1);
427 case MONO_GC_EVENT_POST_START_WORLD:
428 MONO_GC_WORLD_RESTART_END (1);
429 mono_thread_info_suspend_unlock ();
432 case MONO_GC_EVENT_START:
434 #ifndef DISABLE_PERFCOUNTERS
435 if (mono_perfcounters)
436 mono_perfcounters->gc_collections0++;
438 gc_stats.major_gc_count ++;
439 gc_start_time = mono_100ns_ticks ();
442 case MONO_GC_EVENT_END:
444 #if defined(ENABLE_DTRACE) && defined(__sun__)
445 /* This works around a dtrace -G problem on Solaris.
446 Limit its actual use to when the probe is enabled. */
447 if (MONO_GC_END_ENABLED ())
451 #ifndef DISABLE_PERFCOUNTERS
452 if (mono_perfcounters) {
453 guint64 heap_size = GC_get_heap_size ();
454 guint64 used_size = heap_size - GC_get_free_bytes ();
455 mono_perfcounters->gc_total_bytes = used_size;
456 mono_perfcounters->gc_committed_bytes = heap_size;
457 mono_perfcounters->gc_reserved_bytes = heap_size;
458 mono_perfcounters->gc_gen0size = heap_size;
461 gc_stats.major_gc_time += mono_100ns_ticks () - gc_start_time;
462 mono_trace_message (MONO_TRACE_GC, "gc took %d usecs", (mono_100ns_ticks () - gc_start_time) / 10);
466 mono_profiler_gc_event (e, 0);
470 on_gc_heap_resize (size_t new_size)
472 guint64 heap_size = GC_get_heap_size ();
473 #ifndef DISABLE_PERFCOUNTERS
474 if (mono_perfcounters) {
475 mono_perfcounters->gc_committed_bytes = heap_size;
476 mono_perfcounters->gc_reserved_bytes = heap_size;
477 mono_perfcounters->gc_gen0size = heap_size;
480 mono_profiler_gc_heap_resize (new_size);
484 mono_gc_enable_events (void)
486 GC_notify_event = on_gc_notification;
487 GC_on_heap_resize = on_gc_heap_resize;
493 mono_gc_enable_events (void)
500 mono_gc_register_root (char *start, size_t size, void *descr)
502 /* for some strange reason, they want one extra byte on the end */
503 GC_add_roots (start, start + size + 1);
509 mono_gc_deregister_root (char* addr)
512 /* FIXME: libgc doesn't define this work win32 for some reason */
513 /* FIXME: No size info */
514 GC_remove_roots (addr, addr + sizeof (gpointer) + 1);
519 mono_gc_weak_link_add (void **link_addr, MonoObject *obj, gboolean track)
521 /* libgc requires that we use HIDE_POINTER... */
522 *link_addr = (void*)HIDE_POINTER (obj);
524 GC_REGISTER_LONG_LINK (link_addr, obj);
526 GC_GENERAL_REGISTER_DISAPPEARING_LINK (link_addr, obj);
530 mono_gc_weak_link_remove (void **link_addr, gboolean track)
533 GC_unregister_long_link (link_addr);
535 GC_unregister_disappearing_link (link_addr);
540 reveal_link (gpointer link_addr)
542 void **link_a = link_addr;
543 return REVEAL_POINTER (*link_a);
547 mono_gc_weak_link_get (void **link_addr)
549 MonoObject *obj = GC_call_with_alloc_lock (reveal_link, link_addr);
550 if (obj == (MonoObject *) -1)
556 mono_gc_make_descr_for_string (gsize *bitmap, int numbits)
558 return mono_gc_make_descr_from_bitmap (bitmap, numbits);
562 mono_gc_make_descr_for_object (gsize *bitmap, int numbits, size_t obj_size)
564 return mono_gc_make_descr_from_bitmap (bitmap, numbits);
568 mono_gc_make_descr_for_array (int vector, gsize *elem_bitmap, int numbits, size_t elem_size)
570 /* libgc has no usable support for arrays... */
571 return GC_NO_DESCRIPTOR;
575 mono_gc_make_descr_from_bitmap (gsize *bitmap, int numbits)
577 #ifdef HAVE_GC_GCJ_MALLOC
578 /* It seems there are issues when the bitmap doesn't fit: play it safe */
580 return GC_NO_DESCRIPTOR;
582 return (gpointer)GC_make_descriptor ((GC_bitmap)bitmap, numbits);
589 mono_gc_make_root_descr_all_refs (int numbits)
595 mono_gc_alloc_fixed (size_t size, void *descr)
597 /* To help track down typed allocation bugs */
601 if (count == atoi (g_getenv ("COUNT2")))
603 if (count > atoi (g_getenv ("COUNT2")))
604 return GC_MALLOC (size);
608 return GC_MALLOC_EXPLICITLY_TYPED (size, (GC_descr)descr);
610 return GC_MALLOC (size);
614 mono_gc_free_fixed (void* addr)
619 mono_gc_invoke_finalizers (void)
621 /* There is a bug in GC_invoke_finalizer () in versions <= 6.2alpha4:
622 * the 'mem_freed' variable is not initialized when there are no
623 * objects to finalize, which leads to strange behavior later on.
624 * The check is necessary to work around that bug.
626 if (GC_should_invoke_finalizers ())
627 return GC_invoke_finalizers ();
632 mono_gc_pending_finalizers (void)
634 return GC_should_invoke_finalizers ();
638 mono_gc_wbarrier_set_field (MonoObject *obj, gpointer field_ptr, MonoObject* value)
640 *(void**)field_ptr = value;
644 mono_gc_wbarrier_set_arrayref (MonoArray *arr, gpointer slot_ptr, MonoObject* value)
646 *(void**)slot_ptr = value;
650 mono_gc_wbarrier_arrayref_copy (gpointer dest_ptr, gpointer src_ptr, int count)
652 mono_gc_memmove_aligned (dest_ptr, src_ptr, count * sizeof (gpointer));
656 mono_gc_wbarrier_generic_store (gpointer ptr, MonoObject* value)
658 *(void**)ptr = value;
662 mono_gc_wbarrier_generic_store_atomic (gpointer ptr, MonoObject *value)
664 InterlockedWritePointer (ptr, value);
668 mono_gc_wbarrier_generic_nostore (gpointer ptr)
673 mono_gc_wbarrier_value_copy (gpointer dest, gpointer src, int count, MonoClass *klass)
675 mono_gc_memmove_atomic (dest, src, count * mono_class_value_size (klass, NULL));
679 mono_gc_wbarrier_object_copy (MonoObject* obj, MonoObject *src)
681 /* do not copy the sync state */
682 mono_gc_memmove_aligned ((char*)obj + sizeof (MonoObject), (char*)src + sizeof (MonoObject),
683 mono_object_class (obj)->instance_size - sizeof (MonoObject));
687 mono_gc_clear_domain (MonoDomain *domain)
692 mono_gc_get_suspend_signal (void)
694 #ifdef USE_INCLUDED_GC
695 return GC_get_suspend_signal ();
702 mono_gc_get_restart_signal (void)
704 #ifdef USE_INCLUDED_GC
705 return GC_get_restart_signal ();
711 #if defined(USE_INCLUDED_LIBGC) && defined(USE_COMPILER_TLS) && defined(__linux__) && (defined(__i386__) || defined(__x86_64__))
712 extern __thread MONO_TLS_FAST void* GC_thread_tls;
713 #include "metadata-internals.h"
719 while (!(v & (1 << i)))
726 ATYPE_FREEPTR_FOR_BOX,
734 create_allocator (int atype, int tls_key)
736 int index_var, bytes_var, my_fl_var, my_entry_var;
737 guint32 no_freelist_branch, not_small_enough_branch = 0;
738 guint32 size_overflow_branch = 0;
739 MonoMethodBuilder *mb;
741 MonoMethodSignature *csig;
742 AllocatorWrapperInfo *info;
744 if (atype == ATYPE_STRING) {
745 csig = mono_metadata_signature_alloc (mono_defaults.corlib, 2);
746 csig->ret = &mono_defaults.string_class->byval_arg;
747 csig->params [0] = &mono_defaults.int_class->byval_arg;
748 csig->params [1] = &mono_defaults.int32_class->byval_arg;
750 csig = mono_metadata_signature_alloc (mono_defaults.corlib, 2);
751 csig->ret = &mono_defaults.object_class->byval_arg;
752 csig->params [0] = &mono_defaults.int_class->byval_arg;
753 csig->params [1] = &mono_defaults.int32_class->byval_arg;
756 mb = mono_mb_new (mono_defaults.object_class, "Alloc", MONO_WRAPPER_ALLOC);
757 bytes_var = mono_mb_add_local (mb, &mono_defaults.int32_class->byval_arg);
758 if (atype == ATYPE_STRING) {
759 /* a string alloator method takes the args: (vtable, len) */
760 /* bytes = (offsetof (MonoString, chars) + ((len + 1) * 2)); */
761 mono_mb_emit_ldarg (mb, 1);
762 mono_mb_emit_icon (mb, 1);
763 mono_mb_emit_byte (mb, MONO_CEE_ADD);
764 mono_mb_emit_icon (mb, 1);
765 mono_mb_emit_byte (mb, MONO_CEE_SHL);
766 // sizeof (MonoString) might include padding
767 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoString, chars));
768 mono_mb_emit_byte (mb, MONO_CEE_ADD);
769 mono_mb_emit_stloc (mb, bytes_var);
771 mono_mb_emit_ldarg (mb, 1);
772 mono_mb_emit_stloc (mb, bytes_var);
775 /* this is needed for strings/arrays only as the other big types are never allocated with this method */
776 if (atype == ATYPE_STRING) {
778 /* if (!SMALL_ENOUGH (bytes)) jump slow_path;*/
779 mono_mb_emit_ldloc (mb, bytes_var);
780 mono_mb_emit_icon (mb, (NFREELISTS-1) * GRANULARITY);
781 not_small_enough_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BGT_UN_S);
782 /* check for overflow */
783 mono_mb_emit_ldloc (mb, bytes_var);
784 mono_mb_emit_icon (mb, sizeof (MonoString));
785 size_overflow_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLE_UN_S);
788 /* int index = INDEX_FROM_BYTES(bytes); */
789 index_var = mono_mb_add_local (mb, &mono_defaults.int32_class->byval_arg);
791 mono_mb_emit_ldloc (mb, bytes_var);
792 mono_mb_emit_icon (mb, GRANULARITY - 1);
793 mono_mb_emit_byte (mb, MONO_CEE_ADD);
794 mono_mb_emit_icon (mb, shift_amount (GRANULARITY));
795 mono_mb_emit_byte (mb, MONO_CEE_SHR_UN);
796 mono_mb_emit_icon (mb, shift_amount (sizeof (gpointer)));
797 mono_mb_emit_byte (mb, MONO_CEE_SHL);
798 /* index var is already adjusted into bytes */
799 mono_mb_emit_stloc (mb, index_var);
801 my_fl_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
802 my_entry_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
803 /* my_fl = ((GC_thread)tsd) -> ptrfree_freelists + index; */
804 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
805 mono_mb_emit_byte (mb, 0x0D); /* CEE_MONO_TLS */
806 mono_mb_emit_i4 (mb, tls_key);
807 if (atype == ATYPE_FREEPTR || atype == ATYPE_FREEPTR_FOR_BOX || atype == ATYPE_STRING)
808 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, ptrfree_freelists));
809 else if (atype == ATYPE_NORMAL)
810 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, normal_freelists));
811 else if (atype == ATYPE_GCJ)
812 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, gcj_freelists));
814 g_assert_not_reached ();
815 mono_mb_emit_byte (mb, MONO_CEE_ADD);
816 mono_mb_emit_ldloc (mb, index_var);
817 mono_mb_emit_byte (mb, MONO_CEE_ADD);
818 mono_mb_emit_stloc (mb, my_fl_var);
820 /* my_entry = *my_fl; */
821 mono_mb_emit_ldloc (mb, my_fl_var);
822 mono_mb_emit_byte (mb, MONO_CEE_LDIND_I);
823 mono_mb_emit_stloc (mb, my_entry_var);
825 /* if (EXPECT((word)my_entry >= HBLKSIZE, 1)) { */
826 mono_mb_emit_ldloc (mb, my_entry_var);
827 mono_mb_emit_icon (mb, HBLKSIZE);
828 no_freelist_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLT_UN_S);
830 /* ptr_t next = obj_link(my_entry); *my_fl = next; */
831 mono_mb_emit_ldloc (mb, my_fl_var);
832 mono_mb_emit_ldloc (mb, my_entry_var);
833 mono_mb_emit_byte (mb, MONO_CEE_LDIND_I);
834 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
836 /* set the vtable and clear the words in the object */
837 mono_mb_emit_ldloc (mb, my_entry_var);
838 mono_mb_emit_ldarg (mb, 0);
839 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
841 if (atype == ATYPE_FREEPTR) {
842 int start_var, end_var, start_loop;
843 /* end = my_entry + bytes; start = my_entry + sizeof (gpointer);
845 start_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
846 end_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
847 mono_mb_emit_ldloc (mb, my_entry_var);
848 mono_mb_emit_ldloc (mb, bytes_var);
849 mono_mb_emit_byte (mb, MONO_CEE_ADD);
850 mono_mb_emit_stloc (mb, end_var);
851 mono_mb_emit_ldloc (mb, my_entry_var);
852 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoObject, synchronisation));
853 mono_mb_emit_byte (mb, MONO_CEE_ADD);
854 mono_mb_emit_stloc (mb, start_var);
858 * } while (start < end);
860 start_loop = mono_mb_get_label (mb);
861 mono_mb_emit_ldloc (mb, start_var);
862 mono_mb_emit_icon (mb, 0);
863 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
864 mono_mb_emit_ldloc (mb, start_var);
865 mono_mb_emit_icon (mb, sizeof (gpointer));
866 mono_mb_emit_byte (mb, MONO_CEE_ADD);
867 mono_mb_emit_stloc (mb, start_var);
869 mono_mb_emit_ldloc (mb, start_var);
870 mono_mb_emit_ldloc (mb, end_var);
871 mono_mb_emit_byte (mb, MONO_CEE_BLT_UN_S);
872 mono_mb_emit_byte (mb, start_loop - (mono_mb_get_label (mb) + 1));
873 } else if (atype == ATYPE_FREEPTR_FOR_BOX || atype == ATYPE_STRING) {
874 /* need to clear just the sync pointer */
875 mono_mb_emit_ldloc (mb, my_entry_var);
876 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoObject, synchronisation));
877 mono_mb_emit_byte (mb, MONO_CEE_ADD);
878 mono_mb_emit_icon (mb, 0);
879 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
882 if (atype == ATYPE_STRING) {
883 /* need to set length and clear the last char */
884 /* s->length = len; */
885 mono_mb_emit_ldloc (mb, my_entry_var);
886 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoString, length));
887 mono_mb_emit_byte (mb, MONO_CEE_ADD);
888 mono_mb_emit_ldarg (mb, 1);
889 mono_mb_emit_byte (mb, MONO_CEE_STIND_I4);
890 /* s->chars [len] = 0; */
891 mono_mb_emit_ldloc (mb, my_entry_var);
892 mono_mb_emit_ldloc (mb, bytes_var);
893 mono_mb_emit_icon (mb, 2);
894 mono_mb_emit_byte (mb, MONO_CEE_SUB);
895 mono_mb_emit_byte (mb, MONO_CEE_ADD);
896 mono_mb_emit_icon (mb, 0);
897 mono_mb_emit_byte (mb, MONO_CEE_STIND_I2);
900 /* return my_entry; */
901 mono_mb_emit_ldloc (mb, my_entry_var);
902 mono_mb_emit_byte (mb, MONO_CEE_RET);
904 mono_mb_patch_short_branch (mb, no_freelist_branch);
905 if (not_small_enough_branch > 0)
906 mono_mb_patch_short_branch (mb, not_small_enough_branch);
907 if (size_overflow_branch > 0)
908 mono_mb_patch_short_branch (mb, size_overflow_branch);
909 /* the slow path: we just call back into the runtime */
910 if (atype == ATYPE_STRING) {
911 mono_mb_emit_ldarg (mb, 1);
912 mono_mb_emit_icall (mb, mono_string_alloc);
914 mono_mb_emit_ldarg (mb, 0);
915 mono_mb_emit_icall (mb, mono_object_new_specific);
918 mono_mb_emit_byte (mb, MONO_CEE_RET);
920 res = mono_mb_create_method (mb, csig, 8);
922 mono_method_get_header (res)->init_locals = FALSE;
924 info = mono_image_alloc0 (mono_defaults.corlib, sizeof (AllocatorWrapperInfo));
925 info->gc_name = "boehm";
926 info->alloc_type = atype;
927 mono_marshal_set_wrapper_info (res, info);
932 static MonoMethod* alloc_method_cache [ATYPE_NUM];
934 static G_GNUC_UNUSED gboolean
935 mono_gc_is_critical_method (MonoMethod *method)
939 for (i = 0; i < ATYPE_NUM; ++i)
940 if (method == alloc_method_cache [i])
947 * If possible, generate a managed method that can quickly allocate objects in class
948 * @klass. The method will typically have an thread-local inline allocation sequence.
949 * The signature of the called method is:
950 * object allocate (MonoVTable *vtable)
951 * Some of the logic here is similar to mono_class_get_allocation_ftn () i object.c,
953 * The thread local alloc logic is taken from libgc/pthread_support.c.
957 mono_gc_get_managed_allocator (MonoClass *klass, gboolean for_box, gboolean known_instance_size)
961 MONO_THREAD_VAR_OFFSET (GC_thread_tls, offset);
963 /*g_print ("thread tls: %d\n", offset);*/
966 if (!SMALL_ENOUGH (klass->instance_size))
968 if (mono_class_has_finalizer (klass) || mono_class_is_marshalbyref (klass) || (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS))
972 if (mono_class_is_open_constructed_type (&klass->byval_arg))
974 if (klass->byval_arg.type == MONO_TYPE_STRING) {
975 atype = ATYPE_STRING;
976 } else if (!klass->has_references) {
978 atype = ATYPE_FREEPTR_FOR_BOX;
980 atype = ATYPE_FREEPTR;
984 * disabled because we currently do a runtime choice anyway, to
985 * deal with multiple appdomains.
986 if (vtable->gc_descr != GC_NO_DESCRIPTOR)
989 atype = ATYPE_NORMAL;
992 return mono_gc_get_managed_allocator_by_type (atype);
996 mono_gc_get_managed_array_allocator (MonoClass *klass)
1002 * mono_gc_get_managed_allocator_by_type:
1004 * Return a managed allocator method corresponding to allocator type ATYPE.
1007 mono_gc_get_managed_allocator_by_type (int atype)
1011 MONO_THREAD_VAR_OFFSET (GC_thread_tls, offset);
1013 mono_tls_key_set_offset (TLS_KEY_BOEHM_GC_THREAD, offset);
1015 res = alloc_method_cache [atype];
1019 res = create_allocator (atype, TLS_KEY_BOEHM_GC_THREAD);
1020 mono_mutex_lock (&mono_gc_lock);
1021 if (alloc_method_cache [atype]) {
1022 mono_free_method (res);
1023 res = alloc_method_cache [atype];
1025 mono_memory_barrier ();
1026 alloc_method_cache [atype] = res;
1028 mono_mutex_unlock (&mono_gc_lock);
1033 mono_gc_get_managed_allocator_types (void)
1039 mono_gc_get_write_barrier (void)
1041 g_assert_not_reached ();
1047 static G_GNUC_UNUSED gboolean
1048 mono_gc_is_critical_method (MonoMethod *method)
1054 mono_gc_get_managed_allocator (MonoClass *klass, gboolean for_box, gboolean known_instance_size)
1060 mono_gc_get_managed_array_allocator (MonoClass *klass)
1066 mono_gc_get_managed_allocator_by_type (int atype)
1072 mono_gc_get_managed_allocator_types (void)
1078 mono_gc_get_write_barrier (void)
1080 g_assert_not_reached ();
1087 mono_gc_get_aligned_size_for_allocator (int size)
1093 mono_gc_get_gc_name (void)
1099 mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data)
1101 return GC_call_with_alloc_lock (func, data);
1105 mono_gc_get_description (void)
1107 return g_strdup (DEFAULT_GC_NAME);
1111 mono_gc_set_desktop_mode (void)
1117 mono_gc_is_moving (void)
1123 mono_gc_is_disabled (void)
1125 if (GC_dont_gc || g_getenv ("GC_DONT_GC"))
1132 mono_gc_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap)
1134 g_assert_not_reached ();
1139 mono_gc_get_card_table (int *shift_bits, gpointer *card_mask)
1141 g_assert_not_reached ();
1146 mono_gc_card_table_nursery_check (void)
1148 g_assert_not_reached ();
1153 mono_gc_get_nursery (int *shift_bits, size_t *size)
1159 mono_gc_set_current_thread_appdomain (MonoDomain *domain)
1164 mono_gc_precise_stack_mark_enabled (void)
1170 mono_gc_get_logfile (void)
1176 mono_gc_conservatively_scan_area (void *start, void *end)
1178 g_assert_not_reached ();
1182 mono_gc_scan_object (void *obj, void *gc_data)
1184 g_assert_not_reached ();
1189 mono_gc_get_bitmap_for_descr (void *descr, int *numbits)
1191 g_assert_not_reached ();
1196 mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks)
1201 mono_gc_set_stack_end (void *stack_end)
1205 void mono_gc_set_skip_thread (gboolean value)
1210 mono_gc_register_for_finalization (MonoObject *obj, void *user_data)
1215 /* This assertion is not valid when GC_DEBUG is defined */
1216 g_assert (GC_base (obj) == (char*)obj - offset);
1219 GC_REGISTER_FINALIZER_NO_ORDER ((char*)obj - offset, user_data, GUINT_TO_POINTER (offset), NULL, NULL);
1223 * These will call the redefined versions in libgc.
1229 mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
1231 return pthread_create (new_thread, attr, start_routine, arg);
1235 mono_gc_pthread_join (pthread_t thread, void **retval)
1237 return pthread_join (thread, retval);
1241 mono_gc_pthread_detach (pthread_t thread)
1243 return pthread_detach (thread);
1247 mono_gc_pthread_exit (void *retval)
1249 pthread_exit (retval);
1250 g_assert_not_reached ();
1256 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved)
1258 #ifdef USE_INCLUDED_LIBGC
1259 return GC_DllMain (module_handle, reason, reserved);
1267 mono_gc_get_vtable_bits (MonoClass *class)
1269 if (fin_callbacks.is_class_finalization_aware) {
1270 if (fin_callbacks.is_class_finalization_aware (class))
1271 return BOEHM_GC_BIT_FINALIZER_AWARE;
1277 * mono_gc_register_altstack:
1279 * Register the dimensions of the normal stack and altstack with the collector.
1280 * Currently, STACK/STACK_SIZE is only used when the thread is suspended while it is on an altstack.
1283 mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size)
1285 #ifdef USE_INCLUDED_LIBGC
1286 GC_register_altstack (stack, stack_size, altstack, altstack_size);
1291 mono_gc_get_los_limit (void)
1297 mono_gc_set_string_length (MonoString *str, gint32 new_length)
1299 mono_unichar2 *new_end = str->chars + new_length;
1301 /* zero the discarded string. This null-delimits the string and allows
1302 * the space to be reclaimed by SGen. */
1304 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2));
1305 str->length = new_length;
1309 mono_gc_user_markers_supported (void)
1315 mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker)
1317 g_assert_not_reached ();
1322 mono_gc_set_allow_synchronous_major (gboolean flag)
1326 /* Toggleref support */
1329 mono_gc_toggleref_add (MonoObject *object, mono_bool strong_ref)
1331 GC_toggleref_add ((GC_PTR)object, (int)strong_ref);
1335 mono_gc_toggleref_register_callback (MonoToggleRefStatus (*proccess_toggleref) (MonoObject *obj))
1337 GC_toggleref_register_callback ((int (*) (GC_PTR obj)) proccess_toggleref);
1340 /* Test support code */
1342 static MonoToggleRefStatus
1343 test_toggleref_callback (MonoObject *obj)
1345 static MonoClassField *mono_toggleref_test_field;
1346 int status = MONO_TOGGLE_REF_DROP;
1348 if (!mono_toggleref_test_field) {
1349 mono_toggleref_test_field = mono_class_get_field_from_name (mono_object_get_class (obj), "__test");
1350 g_assert (mono_toggleref_test_field);
1353 mono_field_get_value (obj, mono_toggleref_test_field, &status);
1354 printf ("toggleref-cb obj %d\n", status);
1359 register_test_toggleref_callback (void)
1361 mono_gc_toggleref_register_callback (test_toggleref_callback);
1365 is_finalization_aware (MonoObject *obj)
1367 MonoVTable *vt = obj->vtable;
1368 return (vt->gc_bits & BOEHM_GC_BIT_FINALIZER_AWARE) == BOEHM_GC_BIT_FINALIZER_AWARE;
1372 fin_notifier (MonoObject *obj)
1374 if (is_finalization_aware (obj))
1375 fin_callbacks.object_queued_for_finalization (obj);
1379 mono_gc_register_finalizer_callbacks (MonoGCFinalizerCallbacks *callbacks)
1381 if (callbacks->version != MONO_GC_FINALIZER_EXTENSION_VERSION)
1382 g_error ("Invalid finalizer callback version. Expected %d but got %d\n", MONO_GC_FINALIZER_EXTENSION_VERSION, callbacks->version);
1384 fin_callbacks = *callbacks;
1386 GC_set_finalizer_notify_proc ((void (*) (GC_PTR))fin_notifier);
1389 #endif /* no Boehm GC */