2 * boehm-gc.c: GC implementation using either the installed or included Boehm GC.
7 #define GC_I_HIDE_POINTERS
8 #include <mono/metadata/gc-internal.h>
9 #include <mono/metadata/mono-gc.h>
10 #include <mono/metadata/gc-internal.h>
11 #include <mono/metadata/profiler-private.h>
12 #include <mono/metadata/class-internals.h>
13 #include <mono/metadata/method-builder.h>
14 #include <mono/metadata/opcodes.h>
15 #include <mono/utils/mono-logger.h>
19 #ifdef USE_INCLUDED_LIBGC
22 #define THREAD_LOCAL_ALLOC 1
23 #include "private/pthread_support.h"
26 #define GC_NO_DESCRIPTOR ((gpointer)(0 | GC_DS_LENGTH))
28 static gboolean gc_initialized = FALSE;
31 mono_gc_warning (char *msg, GC_word arg)
33 mono_trace (G_LOG_LEVEL_WARNING, MONO_TRACE_GC, msg, (unsigned long)arg);
37 mono_gc_base_init (void)
43 * Handle the case when we are called from a thread different from the main thread,
45 * FIXME: Move this to libgc where it belongs.
47 * we used to do this only when running on valgrind,
48 * but it happens also in other setups.
50 #if defined(HAVE_PTHREAD_GETATTR_NP) && defined(HAVE_PTHREAD_ATTR_GETSTACK)
55 pthread_getattr_np (pthread_self (), &attr);
56 pthread_attr_getstack (&attr, &sstart, &size);
57 pthread_attr_destroy (&attr);
58 /*g_print ("stackbottom pth is: %p\n", (char*)sstart + size);*/
61 * The calculation above doesn't seem to work on ia64, also we need to set
62 * GC_register_stackbottom as well, but don't know how.
65 /* apparently with some linuxthreads implementations sstart can be NULL,
66 * fallback to the more imprecise method (bug# 78096).
69 GC_stackbottom = (char*)sstart + size;
72 gsize stack_bottom = (gsize)&dummy;
74 stack_bottom &= ~4095;
75 GC_stackbottom = (char*)stack_bottom;
79 #elif defined(HAVE_PTHREAD_GET_STACKSIZE_NP) && defined(HAVE_PTHREAD_GET_STACKADDR_NP)
80 GC_stackbottom = (char*)pthread_get_stackaddr_np (pthread_self ());
84 gsize stack_bottom = (gsize)&dummy;
86 stack_bottom &= ~4095;
87 /*g_print ("stackbottom is: %p\n", (char*)stack_bottom);*/
88 GC_stackbottom = (char*)stack_bottom;
94 GC_oom_fn = mono_gc_out_of_memory;
95 GC_set_warn_proc (mono_gc_warning);
96 GC_finalize_on_demand = 1;
97 GC_finalizer_notifier = mono_gc_finalize_notify;
99 #ifdef HAVE_GC_GCJ_MALLOC
100 GC_init_gcj_malloc (5, NULL);
103 gc_initialized = TRUE;
107 mono_gc_collect (int generation)
113 mono_gc_max_generation (void)
119 mono_gc_get_generation (MonoObject *object)
125 mono_gc_collection_count (int generation)
131 mono_gc_add_memory_pressure (gint64 value)
136 mono_gc_get_used_size (void)
138 return GC_get_heap_size () - GC_get_free_bytes ();
142 mono_gc_get_heap_size (void)
144 return GC_get_heap_size ();
148 mono_gc_disable (void)
150 #ifdef HAVE_GC_ENABLE
153 g_assert_not_reached ();
158 mono_gc_enable (void)
160 #ifdef HAVE_GC_ENABLE
163 g_assert_not_reached ();
168 mono_gc_is_gc_thread (void)
170 #if GC_VERSION_MAJOR >= 7
172 #elif defined(USE_INCLUDED_LIBGC)
173 return GC_thread_is_registered ();
179 extern int GC_thread_register_foreign (void *base_addr);
182 mono_gc_register_thread (void *baseptr)
184 #if GC_VERSION_MAJOR >= 7
185 struct GC_stack_base sb;
188 res = GC_get_stack_base (&sb);
189 if (res != GC_SUCCESS) {
190 sb.mem_base = baseptr;
192 /* Can't determine the register stack bounds */
193 g_error ("mono_gc_register_thread failed ().\n");
196 res = GC_register_my_thread (&sb);
197 if ((res != GC_SUCCESS) && (res != GC_DUPLICATE)) {
198 g_warning ("GC_register_my_thread () failed.\n");
203 if (mono_gc_is_gc_thread())
205 #if defined(USE_INCLUDED_LIBGC) && !defined(PLATFORM_WIN32)
206 return GC_thread_register_foreign (baseptr);
214 mono_object_is_alive (MonoObject* o)
216 #ifdef USE_INCLUDED_LIBGC
217 return GC_is_marked ((gpointer)o);
223 #ifdef USE_INCLUDED_LIBGC
226 on_gc_notification (GCEventType event)
228 mono_profiler_gc_event ((MonoGCEvent) event, 0);
232 on_gc_heap_resize (size_t new_size)
234 mono_profiler_gc_heap_resize (new_size);
238 mono_gc_enable_events (void)
240 GC_notify_event = on_gc_notification;
241 GC_on_heap_resize = on_gc_heap_resize;
247 mono_gc_enable_events (void)
254 mono_gc_register_root (char *start, size_t size, void *descr)
256 /* for some strange reason, they want one extra byte on the end */
257 GC_add_roots (start, start + size + 1);
263 mono_gc_deregister_root (char* addr)
265 #ifndef PLATFORM_WIN32
266 /* FIXME: libgc doesn't define this work win32 for some reason */
267 /* FIXME: No size info */
268 GC_remove_roots (addr, addr + sizeof (gpointer) + 1);
273 mono_gc_weak_link_add (void **link_addr, MonoObject *obj)
275 /* libgc requires that we use HIDE_POINTER... */
276 *link_addr = (void*)HIDE_POINTER (obj);
277 GC_GENERAL_REGISTER_DISAPPEARING_LINK (link_addr, obj);
281 mono_gc_weak_link_remove (void **link_addr)
283 GC_unregister_disappearing_link (link_addr);
288 mono_gc_weak_link_get (void **link_addr)
290 MonoObject *obj = REVEAL_POINTER (*link_addr);
291 if (obj == (MonoObject *) -1)
297 mono_gc_make_descr_for_string (gsize *bitmap, int numbits)
299 return mono_gc_make_descr_from_bitmap (bitmap, numbits);
303 mono_gc_make_descr_for_object (gsize *bitmap, int numbits, size_t obj_size)
305 return mono_gc_make_descr_from_bitmap (bitmap, numbits);
309 mono_gc_make_descr_for_array (int vector, gsize *elem_bitmap, int numbits, size_t elem_size)
311 /* libgc has no usable support for arrays... */
312 return GC_NO_DESCRIPTOR;
316 mono_gc_make_descr_from_bitmap (gsize *bitmap, int numbits)
318 #ifdef HAVE_GC_GCJ_MALLOC
319 /* It seems there are issues when the bitmap doesn't fit: play it safe */
321 return GC_NO_DESCRIPTOR;
323 return (gpointer)GC_make_descriptor ((GC_bitmap)bitmap, numbits);
330 mono_gc_alloc_fixed (size_t size, void *descr)
332 return GC_MALLOC (size);
336 mono_gc_free_fixed (void* addr)
341 mono_gc_invoke_finalizers (void)
343 /* There is a bug in GC_invoke_finalizer () in versions <= 6.2alpha4:
344 * the 'mem_freed' variable is not initialized when there are no
345 * objects to finalize, which leads to strange behavior later on.
346 * The check is necessary to work around that bug.
348 if (GC_should_invoke_finalizers ())
349 return GC_invoke_finalizers ();
354 mono_gc_pending_finalizers (void)
356 return GC_should_invoke_finalizers ();
360 mono_gc_wbarrier_set_field (MonoObject *obj, gpointer field_ptr, MonoObject* value)
362 *(void**)field_ptr = value;
366 mono_gc_wbarrier_set_arrayref (MonoArray *arr, gpointer slot_ptr, MonoObject* value)
368 *(void**)slot_ptr = value;
372 mono_gc_wbarrier_arrayref_copy (MonoArray *arr, gpointer slot_ptr, int count)
374 /* no need to do anything */
378 mono_gc_wbarrier_generic_store (gpointer ptr, MonoObject* value)
380 *(void**)ptr = value;
384 mono_gc_wbarrier_value_copy (gpointer dest, gpointer src, int count, MonoClass *klass)
389 mono_gc_wbarrier_object (MonoObject *object)
393 #if defined(USE_INCLUDED_LIBGC) && defined(USE_COMPILER_TLS) && defined(__linux__) && (defined(__i386__) || defined(__x86_64__))
394 extern __thread MONO_TLS_FAST void* GC_thread_tls;
395 #include "metadata-internals.h"
401 while (!(v & (1 << i)))
408 ATYPE_FREEPTR_FOR_BOX,
416 create_allocator (int atype, int offset)
418 int index_var, bytes_var, my_fl_var, my_entry_var;
419 guint32 no_freelist_branch, not_small_enough_branch = 0;
420 guint32 size_overflow_branch = 0;
421 MonoMethodBuilder *mb;
423 MonoMethodSignature *csig;
425 if (atype == ATYPE_STRING) {
426 csig = mono_metadata_signature_alloc (mono_defaults.corlib, 2);
427 csig->ret = &mono_defaults.string_class->byval_arg;
428 csig->params [0] = &mono_defaults.int_class->byval_arg;
429 csig->params [1] = &mono_defaults.int32_class->byval_arg;
431 csig = mono_metadata_signature_alloc (mono_defaults.corlib, 1);
432 csig->ret = &mono_defaults.object_class->byval_arg;
433 csig->params [0] = &mono_defaults.int_class->byval_arg;
436 mb = mono_mb_new (mono_defaults.object_class, "Alloc", MONO_WRAPPER_ALLOC);
437 bytes_var = mono_mb_add_local (mb, &mono_defaults.int32_class->byval_arg);
438 if (atype == ATYPE_STRING) {
439 /* a string alloator method takes the args: (vtable, len) */
440 /* bytes = (sizeof (MonoString) + ((len + 1) * 2)); */
441 mono_mb_emit_ldarg (mb, 1);
442 mono_mb_emit_icon (mb, 1);
443 mono_mb_emit_byte (mb, MONO_CEE_ADD);
444 mono_mb_emit_icon (mb, 1);
445 mono_mb_emit_byte (mb, MONO_CEE_SHL);
446 // sizeof (MonoString) might include padding
447 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoString, chars));
448 mono_mb_emit_byte (mb, MONO_CEE_ADD);
449 mono_mb_emit_stloc (mb, bytes_var);
451 /* bytes = vtable->klass->instance_size */
452 mono_mb_emit_ldarg (mb, 0);
453 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoVTable, klass));
454 mono_mb_emit_byte (mb, MONO_CEE_ADD);
455 mono_mb_emit_byte (mb, MONO_CEE_LDIND_I);
456 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoClass, instance_size));
457 mono_mb_emit_byte (mb, MONO_CEE_ADD);
458 /* FIXME: assert instance_size stays a 4 byte integer */
459 mono_mb_emit_byte (mb, MONO_CEE_LDIND_U4);
460 mono_mb_emit_stloc (mb, bytes_var);
463 /* this is needed for strings/arrays only as the other big types are never allocated with this method */
464 if (atype == ATYPE_STRING) {
466 /* if (!SMALL_ENOUGH (bytes)) jump slow_path;*/
467 mono_mb_emit_ldloc (mb, bytes_var);
468 mono_mb_emit_icon (mb, (NFREELISTS-1) * GRANULARITY);
469 not_small_enough_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BGT_UN_S);
470 /* check for overflow */
471 mono_mb_emit_ldloc (mb, bytes_var);
472 mono_mb_emit_icon (mb, sizeof (MonoString));
473 size_overflow_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLE_UN_S);
476 /* int index = INDEX_FROM_BYTES(bytes); */
477 index_var = mono_mb_add_local (mb, &mono_defaults.int32_class->byval_arg);
479 mono_mb_emit_ldloc (mb, bytes_var);
480 mono_mb_emit_icon (mb, GRANULARITY - 1);
481 mono_mb_emit_byte (mb, MONO_CEE_ADD);
482 mono_mb_emit_icon (mb, shift_amount (GRANULARITY));
483 mono_mb_emit_byte (mb, MONO_CEE_SHR_UN);
484 mono_mb_emit_icon (mb, shift_amount (sizeof (gpointer)));
485 mono_mb_emit_byte (mb, MONO_CEE_SHL);
486 /* index var is already adjusted into bytes */
487 mono_mb_emit_stloc (mb, index_var);
489 my_fl_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
490 my_entry_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
491 /* my_fl = ((GC_thread)tsd) -> ptrfree_freelists + index; */
492 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
493 mono_mb_emit_byte (mb, 0x0D); /* CEE_MONO_TLS */
494 mono_mb_emit_i4 (mb, offset);
495 if (atype == ATYPE_FREEPTR || atype == ATYPE_FREEPTR_FOR_BOX || atype == ATYPE_STRING)
496 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, ptrfree_freelists));
497 else if (atype == ATYPE_NORMAL)
498 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, normal_freelists));
499 else if (atype == ATYPE_GCJ)
500 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, gcj_freelists));
502 g_assert_not_reached ();
503 mono_mb_emit_byte (mb, MONO_CEE_ADD);
504 mono_mb_emit_ldloc (mb, index_var);
505 mono_mb_emit_byte (mb, MONO_CEE_ADD);
506 mono_mb_emit_stloc (mb, my_fl_var);
508 /* my_entry = *my_fl; */
509 mono_mb_emit_ldloc (mb, my_fl_var);
510 mono_mb_emit_byte (mb, MONO_CEE_LDIND_I);
511 mono_mb_emit_stloc (mb, my_entry_var);
513 /* if (EXPECT((word)my_entry >= HBLKSIZE, 1)) { */
514 mono_mb_emit_ldloc (mb, my_entry_var);
515 mono_mb_emit_icon (mb, HBLKSIZE);
516 no_freelist_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLT_UN_S);
518 /* ptr_t next = obj_link(my_entry); *my_fl = next; */
519 mono_mb_emit_ldloc (mb, my_fl_var);
520 mono_mb_emit_ldloc (mb, my_entry_var);
521 mono_mb_emit_byte (mb, MONO_CEE_LDIND_I);
522 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
524 /* set the vtable and clear the words in the object */
525 mono_mb_emit_ldloc (mb, my_entry_var);
526 mono_mb_emit_ldarg (mb, 0);
527 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
529 if (atype == ATYPE_FREEPTR) {
530 int start_var, end_var, start_loop;
531 /* end = my_entry + bytes; start = my_entry + sizeof (gpointer);
533 start_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
534 end_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
535 mono_mb_emit_ldloc (mb, my_entry_var);
536 mono_mb_emit_ldloc (mb, bytes_var);
537 mono_mb_emit_byte (mb, MONO_CEE_ADD);
538 mono_mb_emit_stloc (mb, end_var);
539 mono_mb_emit_ldloc (mb, my_entry_var);
540 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoObject, synchronisation));
541 mono_mb_emit_byte (mb, MONO_CEE_ADD);
542 mono_mb_emit_stloc (mb, start_var);
546 * } while (start < end);
548 start_loop = mono_mb_get_label (mb);
549 mono_mb_emit_ldloc (mb, start_var);
550 mono_mb_emit_icon (mb, 0);
551 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
552 mono_mb_emit_ldloc (mb, start_var);
553 mono_mb_emit_icon (mb, sizeof (gpointer));
554 mono_mb_emit_byte (mb, MONO_CEE_ADD);
555 mono_mb_emit_stloc (mb, start_var);
557 mono_mb_emit_ldloc (mb, start_var);
558 mono_mb_emit_ldloc (mb, end_var);
559 mono_mb_emit_byte (mb, MONO_CEE_BLT_UN_S);
560 mono_mb_emit_byte (mb, start_loop - (mono_mb_get_label (mb) + 1));
561 } else if (atype == ATYPE_FREEPTR_FOR_BOX || atype == ATYPE_STRING) {
562 /* need to clear just the sync pointer */
563 mono_mb_emit_ldloc (mb, my_entry_var);
564 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoObject, synchronisation));
565 mono_mb_emit_byte (mb, MONO_CEE_ADD);
566 mono_mb_emit_icon (mb, 0);
567 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
570 if (atype == ATYPE_STRING) {
571 /* need to set length and clear the last char */
572 /* s->length = len; */
573 mono_mb_emit_ldloc (mb, my_entry_var);
574 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoString, length));
575 mono_mb_emit_byte (mb, MONO_CEE_ADD);
576 mono_mb_emit_ldarg (mb, 1);
577 mono_mb_emit_byte (mb, MONO_CEE_STIND_I4);
578 /* s->chars [len] = 0; */
579 mono_mb_emit_ldloc (mb, my_entry_var);
580 mono_mb_emit_ldloc (mb, bytes_var);
581 mono_mb_emit_icon (mb, 2);
582 mono_mb_emit_byte (mb, MONO_CEE_SUB);
583 mono_mb_emit_byte (mb, MONO_CEE_ADD);
584 mono_mb_emit_icon (mb, 0);
585 mono_mb_emit_byte (mb, MONO_CEE_STIND_I2);
588 /* return my_entry; */
589 mono_mb_emit_ldloc (mb, my_entry_var);
590 mono_mb_emit_byte (mb, MONO_CEE_RET);
592 mono_mb_patch_short_branch (mb, no_freelist_branch);
593 if (not_small_enough_branch > 0)
594 mono_mb_patch_short_branch (mb, not_small_enough_branch);
595 if (size_overflow_branch > 0)
596 mono_mb_patch_short_branch (mb, size_overflow_branch);
597 /* the slow path: we just call back into the runtime */
598 if (atype == ATYPE_STRING) {
599 mono_mb_emit_ldarg (mb, 1);
600 mono_mb_emit_icall (mb, mono_string_alloc);
602 mono_mb_emit_ldarg (mb, 0);
603 mono_mb_emit_icall (mb, mono_object_new_specific);
606 mono_mb_emit_byte (mb, MONO_CEE_RET);
608 res = mono_mb_create_method (mb, csig, 8);
610 mono_method_get_header (res)->init_locals = FALSE;
614 static MonoMethod* alloc_method_cache [ATYPE_NUM];
617 * If possible, generate a managed method that can quickly allocate objects in class
618 * @klass. The method will typically have an thread-local inline allocation sequence.
619 * The signature of the called method is:
620 * object allocate (MonoVTable *vtable)
621 * Some of the logic here is similar to mono_class_get_allocation_ftn () i object.c,
623 * The thread local alloc logic is taken from libgc/pthread_support.c.
627 mono_gc_get_managed_allocator (MonoVTable *vtable, gboolean for_box)
631 MonoClass *klass = vtable->klass;
632 MONO_THREAD_VAR_OFFSET (GC_thread_tls, offset);
634 /*g_print ("thread tls: %d\n", offset);*/
637 if (!SMALL_ENOUGH (klass->instance_size))
639 if (klass->has_finalize || klass->marshalbyref || (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS))
643 if (klass->byval_arg.type == MONO_TYPE_STRING) {
644 atype = ATYPE_STRING;
645 } else if (!klass->has_references) {
647 atype = ATYPE_FREEPTR_FOR_BOX;
649 atype = ATYPE_FREEPTR;
653 * disabled because we currently do a runtime choice anyway, to
654 * deal with multiple appdomains.
655 if (vtable->gc_descr != GC_NO_DESCRIPTOR)
658 atype = ATYPE_NORMAL;
661 return mono_gc_get_managed_allocator_by_type (atype);
665 * mono_gc_get_managed_allocator_id:
667 * Return a type for the managed allocator method MANAGED_ALLOC which can later be passed
668 * to mono_gc_get_managed_allocator_by_type () to get back this allocator method. This can be
669 * used by the AOT code to encode references to managed allocator methods.
672 mono_gc_get_managed_allocator_type (MonoMethod *managed_alloc)
677 for (i = 0; i < ATYPE_NUM; ++i) {
678 if (alloc_method_cache [i] == managed_alloc) {
679 mono_loader_unlock ();
683 mono_loader_unlock ();
689 * mono_gc_get_managed_allocator_by_type:
691 * Return a managed allocator method corresponding to allocator type ATYPE.
694 mono_gc_get_managed_allocator_by_type (int atype)
698 MONO_THREAD_VAR_OFFSET (GC_thread_tls, offset);
701 res = alloc_method_cache [atype];
703 res = alloc_method_cache [atype] = create_allocator (atype, offset);
704 mono_loader_unlock ();
711 mono_gc_get_managed_allocator (MonoVTable *vtable, gboolean for_box)
717 mono_gc_get_managed_allocator_type (MonoMethod *managed_alloc)
723 mono_gc_get_managed_allocator_by_type (int atype)
730 #endif /* no Boehm GC */