2 * metadata/gc.c: GC icalls.
4 * Author: Paolo Molaro <lupus@ximian.com>
6 * Copyright 2002-2003 Ximian, Inc (http://www.ximian.com)
7 * Copyright 2004-2009 Novell, Inc (http://www.novell.com)
14 #include <mono/metadata/gc-internal.h>
15 #include <mono/metadata/mono-gc.h>
16 #include <mono/metadata/threads.h>
17 #include <mono/metadata/tabledefs.h>
18 #include <mono/metadata/exception.h>
19 #include <mono/metadata/profiler-private.h>
20 #include <mono/metadata/domain-internals.h>
21 #include <mono/metadata/class-internals.h>
22 #include <mono/metadata/metadata-internals.h>
23 #include <mono/metadata/mono-mlist.h>
24 #include <mono/metadata/threadpool.h>
25 #include <mono/metadata/threads-types.h>
26 #include <mono/utils/mono-logger-internal.h>
27 #include <mono/metadata/gc-internal.h>
28 #include <mono/metadata/marshal.h> /* for mono_delegate_free_ftnptr () */
29 #include <mono/metadata/attach.h>
30 #include <mono/metadata/console-io.h>
31 #include <mono/utils/mono-semaphore.h>
37 typedef struct DomainFinalizationReq {
40 } DomainFinalizationReq;
42 #ifdef PLATFORM_WINCE /* FIXME: add accessors to gc.dll API */
43 extern void (*__imp_GC_finalizer_notifier)(void);
44 #define GC_finalizer_notifier __imp_GC_finalizer_notifier
45 extern int __imp_GC_finalize_on_demand;
46 #define GC_finalize_on_demand __imp_GC_finalize_on_demand
49 static gboolean gc_disabled = FALSE;
51 static gboolean finalizing_root_domain = FALSE;
53 #define mono_finalizer_lock() EnterCriticalSection (&finalizer_mutex)
54 #define mono_finalizer_unlock() LeaveCriticalSection (&finalizer_mutex)
55 static CRITICAL_SECTION finalizer_mutex;
57 static GSList *domains_to_finalize= NULL;
58 static MonoMList *threads_to_finalize = NULL;
60 static MonoInternalThread *gc_thread;
62 static void object_register_finalizer (MonoObject *obj, void (*callback)(void *, void*));
64 static void mono_gchandle_set_target (guint32 gchandle, MonoObject *obj);
67 static HANDLE pending_done_event;
68 static HANDLE shutdown_event;
72 add_thread_to_finalize (MonoInternalThread *thread)
74 mono_finalizer_lock ();
75 if (!threads_to_finalize)
76 MONO_GC_REGISTER_ROOT_SINGLE (threads_to_finalize);
77 threads_to_finalize = mono_mlist_append (threads_to_finalize, (MonoObject*)thread);
78 mono_finalizer_unlock ();
81 static gboolean suspend_finalizers = FALSE;
83 * actually, we might want to queue the finalize requests in a separate thread,
84 * but we need to be careful about the execution domain of the thread...
87 mono_gc_run_finalize (void *obj, void *data)
89 MonoObject *exc = NULL;
94 MonoMethod* finalizer = NULL;
95 MonoDomain *caller_domain = mono_domain_get ();
97 RuntimeInvokeFunction runtime_invoke;
98 GSList *l, *refs = NULL;
100 o = (MonoObject*)((char*)obj + GPOINTER_TO_UINT (data));
102 if (suspend_finalizers)
105 domain = o->vtable->domain;
108 mono_domain_finalizers_lock (domain);
110 o2 = g_hash_table_lookup (domain->finalizable_objects_hash, o);
112 refs = mono_gc_remove_weak_track_object (domain, o);
114 mono_domain_finalizers_unlock (domain);
117 /* Already finalized somehow */
123 * Support for GCHandles of type WeakTrackResurrection:
125 * Its not exactly clear how these are supposed to work, or how their
126 * semantics can be implemented. We only implement one crucial thing:
127 * these handles are only cleared after the finalizer has ran.
129 for (l = refs; l; l = l->next) {
130 guint32 gchandle = GPOINTER_TO_UINT (l->data);
132 mono_gchandle_set_target (gchandle, o);
138 /* make sure the finalizer is not called again if the object is resurrected */
139 object_register_finalizer (obj, NULL);
141 if (o->vtable->klass == mono_defaults.internal_thread_class) {
142 MonoInternalThread *t = (MonoInternalThread*)o;
144 if (mono_gc_is_finalizer_internal_thread (t))
145 /* Avoid finalizing ourselves */
148 if (t->threadpool_thread && finalizing_root_domain) {
149 /* Don't finalize threadpool threads when
150 shutting down - they're finalized when the
151 threadpool shuts down. */
152 add_thread_to_finalize (t);
157 if (o->vtable->klass->image == mono_defaults.corlib && !strcmp (o->vtable->klass->name, "DynamicMethod") && finalizing_root_domain) {
159 * These can't be finalized during unloading/shutdown, since that would
160 * free the native code which can still be referenced by other
162 * FIXME: This is not perfect, objects dying at the same time as
163 * dynamic methods can still reference them even when !shutdown.
168 if (mono_runtime_get_no_exec ())
171 /* speedup later... and use a timeout */
172 /* g_print ("Finalize run on %p %s.%s\n", o, mono_object_class (o)->name_space, mono_object_class (o)->name); */
174 /* Use _internal here, since this thread can enter a doomed appdomain */
175 mono_domain_set_internal (mono_object_domain (o));
177 /* delegates that have a native function pointer allocated are
178 * registered for finalization, but they don't have a Finalize
179 * method, because in most cases it's not needed and it's just a waste.
181 if (o->vtable->klass->delegate) {
182 MonoDelegate* del = (MonoDelegate*)o;
183 if (del->delegate_trampoline)
184 mono_delegate_free_ftnptr ((MonoDelegate*)o);
185 mono_domain_set_internal (caller_domain);
189 finalizer = mono_class_get_finalizer (o->vtable->klass);
192 /* If object has a CCW but has no finalizer, it was only
193 * registered for finalization in order to free the CCW.
194 * Else it needs the regular finalizer run.
195 * FIXME: what to do about ressurection and suppression
196 * of finalizer on object with CCW.
198 if (mono_marshal_free_ccw (o) && !finalizer) {
199 mono_domain_set_internal (caller_domain);
205 * To avoid the locking plus the other overhead of mono_runtime_invoke (),
206 * create and precompile a wrapper which calls the finalize method using
209 if (!domain->finalize_runtime_invoke) {
210 MonoMethod *invoke = mono_marshal_get_runtime_invoke (mono_class_get_method_from_name_flags (mono_defaults.object_class, "Finalize", 0, 0), TRUE);
212 domain->finalize_runtime_invoke = mono_compile_method (invoke);
215 runtime_invoke = domain->finalize_runtime_invoke;
217 mono_runtime_class_init (o->vtable);
219 runtime_invoke (o, NULL, &exc, NULL);
222 /* fixme: do something useful */
225 mono_domain_set_internal (caller_domain);
229 mono_gc_finalize_threadpool_threads (void)
231 while (threads_to_finalize) {
232 MonoInternalThread *thread = (MonoInternalThread*) mono_mlist_get_data (threads_to_finalize);
234 /* Force finalization of the thread. */
235 thread->threadpool_thread = FALSE;
236 mono_object_register_finalizer ((MonoObject*)thread);
238 mono_gc_run_finalize (thread, NULL);
240 threads_to_finalize = mono_mlist_next (threads_to_finalize);
245 mono_gc_out_of_memory (size_t size)
248 * we could allocate at program startup some memory that we could release
249 * back to the system at this point if we're really low on memory (ie, size is
250 * lower than the memory we set apart)
252 mono_raise_exception (mono_domain_get ()->out_of_memory_ex);
258 * Some of our objects may point to a different address than the address returned by GC_malloc()
259 * (because of the GetHashCode hack), but we need to pass the real address to register_finalizer.
260 * This also means that in the callback we need to adjust the pointer to get back the real
262 * We also need to be consistent in the use of the GC_debug* variants of malloc and register_finalizer,
263 * since that, too, can cause the underlying pointer to be offset.
266 object_register_finalizer (MonoObject *obj, void (*callback)(void *, void*))
273 mono_raise_exception (mono_get_exception_argument_null ("obj"));
275 domain = obj->vtable->domain;
278 /* This assertion is not valid when GC_DEBUG is defined */
279 g_assert (GC_base (obj) == (char*)obj - offset);
282 if (mono_domain_is_unloading (domain) && (callback != NULL))
284 * Can't register finalizers in a dying appdomain, since they
285 * could be invoked after the appdomain has been unloaded.
289 mono_domain_finalizers_lock (domain);
292 g_hash_table_insert (domain->finalizable_objects_hash, obj, obj);
294 g_hash_table_remove (domain->finalizable_objects_hash, obj);
296 mono_domain_finalizers_unlock (domain);
298 GC_REGISTER_FINALIZER_NO_ORDER ((char*)obj - offset, callback, GUINT_TO_POINTER (offset), NULL, NULL);
299 #elif defined(HAVE_SGEN_GC)
301 mono_raise_exception (mono_get_exception_argument_null ("obj"));
303 mono_gc_register_for_finalization (obj, callback);
308 * mono_object_register_finalizer:
309 * @obj: object to register
311 * Records that object @obj has a finalizer, this will call the
312 * Finalize method when the garbage collector disposes the object.
316 mono_object_register_finalizer (MonoObject *obj)
318 /* g_print ("Registered finalizer on %p %s.%s\n", obj, mono_object_class (obj)->name_space, mono_object_class (obj)->name); */
319 object_register_finalizer (obj, mono_gc_run_finalize);
323 * mono_domain_finalize:
324 * @domain: the domain to finalize
325 * @timeout: msects to wait for the finalization to complete, -1 to wait indefinitely
327 * Request finalization of all finalizable objects inside @domain. Wait
328 * @timeout msecs for the finalization to complete.
330 * Returns: TRUE if succeeded, FALSE if there was a timeout
334 mono_domain_finalize (MonoDomain *domain, guint32 timeout)
336 DomainFinalizationReq *req;
340 if (mono_thread_internal_current () == gc_thread)
341 /* We are called from inside a finalizer, not much we can do here */
345 * No need to create another thread 'cause the finalizer thread
346 * is still working and will take care of running the finalizers
353 mono_gc_collect (mono_gc_max_generation ());
355 done_event = CreateEvent (NULL, TRUE, FALSE, NULL);
356 if (done_event == NULL) {
360 req = g_new0 (DomainFinalizationReq, 1);
361 req->domain = domain;
362 req->done_event = done_event;
364 if (domain == mono_get_root_domain ())
365 finalizing_root_domain = TRUE;
367 mono_finalizer_lock ();
369 domains_to_finalize = g_slist_append (domains_to_finalize, req);
371 mono_finalizer_unlock ();
373 /* Tell the finalizer thread to finalize this appdomain */
374 mono_gc_finalize_notify ();
379 res = WaitForSingleObjectEx (done_event, timeout, TRUE);
381 /* printf ("WAIT RES: %d.\n", res); */
382 if (res == WAIT_TIMEOUT) {
383 /* We leak the handle here */
387 CloseHandle (done_event);
389 if (domain == mono_get_root_domain ()) {
390 mono_thread_pool_cleanup ();
391 mono_gc_finalize_threadpool_threads ();
396 /* We don't support domain finalization without a GC */
402 ves_icall_System_GC_InternalCollect (int generation)
404 mono_gc_collect (generation);
408 ves_icall_System_GC_GetTotalMemory (MonoBoolean forceCollection)
413 mono_gc_collect (mono_gc_max_generation ());
414 return mono_gc_get_used_size ();
418 ves_icall_System_GC_KeepAlive (MonoObject *obj)
428 ves_icall_System_GC_ReRegisterForFinalize (MonoObject *obj)
431 mono_raise_exception (mono_get_exception_argument_null ("obj"));
433 object_register_finalizer (obj, mono_gc_run_finalize);
437 ves_icall_System_GC_SuppressFinalize (MonoObject *obj)
440 mono_raise_exception (mono_get_exception_argument_null ("obj"));
442 /* delegates have no finalizers, but we register them to deal with the
443 * unmanaged->managed trampoline. We don't let the user suppress it
444 * otherwise we'd leak it.
446 if (obj->vtable->klass->delegate)
449 /* FIXME: Need to handle case where obj has COM Callable Wrapper
450 * generated for it that needs cleaned up, but user wants to suppress
451 * their derived object finalizer. */
453 object_register_finalizer (obj, NULL);
457 ves_icall_System_GC_WaitForPendingFinalizers (void)
460 if (!mono_gc_pending_finalizers ())
463 if (mono_thread_internal_current () == gc_thread)
464 /* Avoid deadlocks */
467 ResetEvent (pending_done_event);
468 mono_gc_finalize_notify ();
469 /* g_print ("Waiting for pending finalizers....\n"); */
470 WaitForSingleObjectEx (pending_done_event, INFINITE, TRUE);
471 /* g_print ("Done pending....\n"); */
476 ves_icall_System_GC_register_ephemeron_array (MonoObject *array)
479 if (!mono_gc_ephemeron_array_add (array))
480 mono_raise_exception (mono_object_domain (array)->out_of_memory_ex);
485 ves_icall_System_GC_get_ephemeron_tombstone (void)
487 return mono_domain_get ()->ephemeron_tombstone;
490 #define mono_allocator_lock() EnterCriticalSection (&allocator_section)
491 #define mono_allocator_unlock() LeaveCriticalSection (&allocator_section)
492 static CRITICAL_SECTION allocator_section;
493 static CRITICAL_SECTION handle_section;
502 static HandleType mono_gchandle_get_type (guint32 gchandle);
505 ves_icall_System_GCHandle_GetTarget (guint32 handle)
507 return mono_gchandle_get_target (handle);
511 * if type == -1, change the target of the handle, otherwise allocate a new handle.
514 ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint32 type)
517 mono_gchandle_set_target (handle, obj);
518 /* the handle doesn't change */
523 return mono_gchandle_new_weakref (obj, FALSE);
524 case HANDLE_WEAK_TRACK:
525 return mono_gchandle_new_weakref (obj, TRUE);
527 return mono_gchandle_new (obj, FALSE);
529 return mono_gchandle_new (obj, TRUE);
531 g_assert_not_reached ();
537 ves_icall_System_GCHandle_FreeHandle (guint32 handle)
539 mono_gchandle_free (handle);
543 ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle)
547 if (mono_gchandle_get_type (handle) != HANDLE_PINNED)
549 obj = mono_gchandle_get_target (handle);
551 MonoClass *klass = mono_object_class (obj);
552 if (klass == mono_defaults.string_class) {
553 return mono_string_chars ((MonoString*)obj);
554 } else if (klass->rank) {
555 return mono_array_addr ((MonoArray*)obj, char, 0);
557 /* the C# code will check and throw the exception */
558 /* FIXME: missing !klass->blittable test, see bug #61134 */
559 if ((klass->flags & TYPE_ATTRIBUTE_LAYOUT_MASK) == TYPE_ATTRIBUTE_AUTO_LAYOUT)
561 return (char*)obj + sizeof (MonoObject);
572 guint slot_hint : 24; /* starting slot for search */
573 /* 2^16 appdomains should be enough for everyone (though I know I'll regret this in 20 years) */
574 /* we alloc this only for weak refs, since we can get the domain directly in the other cases */
578 /* weak and weak-track arrays will be allocated in malloc memory
580 static HandleData gc_handles [] = {
581 {NULL, NULL, 0, HANDLE_WEAK, 0},
582 {NULL, NULL, 0, HANDLE_WEAK_TRACK, 0},
583 {NULL, NULL, 0, HANDLE_NORMAL, 0},
584 {NULL, NULL, 0, HANDLE_PINNED, 0}
587 #define lock_handles(handles) EnterCriticalSection (&handle_section)
588 #define unlock_handles(handles) LeaveCriticalSection (&handle_section)
591 find_first_unset (guint32 bitmap)
594 for (i = 0; i < 32; ++i) {
595 if (!(bitmap & (1 << i)))
602 alloc_handle (HandleData *handles, MonoObject *obj, gboolean track)
606 lock_handles (handles);
607 if (!handles->size) {
609 if (handles->type > HANDLE_WEAK_TRACK) {
610 handles->entries = mono_gc_alloc_fixed (sizeof (gpointer) * handles->size, mono_gc_make_root_descr_all_refs (handles->size));
612 handles->entries = g_malloc0 (sizeof (gpointer) * handles->size);
613 handles->domain_ids = g_malloc0 (sizeof (guint16) * handles->size);
615 handles->bitmap = g_malloc0 (handles->size / 8);
618 for (slot = handles->slot_hint; slot < handles->size / 32; ++slot) {
619 if (handles->bitmap [slot] != 0xffffffff) {
620 i = find_first_unset (handles->bitmap [slot]);
621 handles->slot_hint = slot;
625 if (i == -1 && handles->slot_hint != 0) {
626 for (slot = 0; slot < handles->slot_hint; ++slot) {
627 if (handles->bitmap [slot] != 0xffffffff) {
628 i = find_first_unset (handles->bitmap [slot]);
629 handles->slot_hint = slot;
636 guint32 new_size = handles->size * 2; /* always double: we memset to 0 based on this below */
638 /* resize and copy the bitmap */
639 new_bitmap = g_malloc0 (new_size / 8);
640 memcpy (new_bitmap, handles->bitmap, handles->size / 8);
641 g_free (handles->bitmap);
642 handles->bitmap = new_bitmap;
644 /* resize and copy the entries */
645 if (handles->type > HANDLE_WEAK_TRACK) {
648 entries = mono_gc_alloc_fixed (sizeof (gpointer) * new_size, mono_gc_make_root_descr_all_refs (new_size));
649 memcpy (entries, handles->entries, sizeof (gpointer) * handles->size);
651 mono_gc_free_fixed (handles->entries);
652 handles->entries = entries;
656 domain_ids = g_malloc0 (sizeof (guint16) * new_size);
657 entries = g_malloc (sizeof (gpointer) * new_size);
658 /* we disable GC because we could lose some disappearing link updates */
660 memcpy (entries, handles->entries, sizeof (gpointer) * handles->size);
661 memset (entries + handles->size, 0, sizeof (gpointer) * handles->size);
662 memcpy (domain_ids, handles->domain_ids, sizeof (guint16) * handles->size);
663 for (i = 0; i < handles->size; ++i) {
664 MonoObject *obj = mono_gc_weak_link_get (&(handles->entries [i]));
665 if (handles->entries [i])
666 mono_gc_weak_link_remove (&(handles->entries [i]));
667 /*g_print ("reg/unreg entry %d of type %d at %p to object %p (%p), was: %p\n", i, handles->type, &(entries [i]), obj, entries [i], handles->entries [i]);*/
669 mono_gc_weak_link_add (&(entries [i]), obj, track);
672 g_free (handles->entries);
673 g_free (handles->domain_ids);
674 handles->entries = entries;
675 handles->domain_ids = domain_ids;
679 /* set i and slot to the next free position */
681 slot = (handles->size + 1) / 32;
682 handles->slot_hint = handles->size + 1;
683 handles->size = new_size;
685 handles->bitmap [slot] |= 1 << i;
686 slot = slot * 32 + i;
687 handles->entries [slot] = obj;
688 if (handles->type <= HANDLE_WEAK_TRACK) {
690 mono_gc_weak_link_add (&(handles->entries [slot]), obj, track);
693 mono_perfcounters->gc_num_handles++;
694 unlock_handles (handles);
695 /*g_print ("allocated entry %d of type %d to object %p (in slot: %p)\n", slot, handles->type, obj, handles->entries [slot]);*/
696 res = (slot << 3) | (handles->type + 1);
697 mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_CREATED, handles->type, res, obj);
703 * @obj: managed object to get a handle for
704 * @pinned: whether the object should be pinned
706 * This returns a handle that wraps the object, this is used to keep a
707 * reference to a managed object from the unmanaged world and preventing the
708 * object from being disposed.
710 * If @pinned is false the address of the object can not be obtained, if it is
711 * true the address of the object can be obtained. This will also pin the
712 * object so it will not be possible by a moving garbage collector to move the
715 * Returns: a handle that can be used to access the object from
719 mono_gchandle_new (MonoObject *obj, gboolean pinned)
721 return alloc_handle (&gc_handles [pinned? HANDLE_PINNED: HANDLE_NORMAL], obj, FALSE);
725 * mono_gchandle_new_weakref:
726 * @obj: managed object to get a handle for
727 * @pinned: whether the object should be pinned
729 * This returns a weak handle that wraps the object, this is used to
730 * keep a reference to a managed object from the unmanaged world.
731 * Unlike the mono_gchandle_new the object can be reclaimed by the
732 * garbage collector. In this case the value of the GCHandle will be
735 * If @pinned is false the address of the object can not be obtained, if it is
736 * true the address of the object can be obtained. This will also pin the
737 * object so it will not be possible by a moving garbage collector to move the
740 * Returns: a handle that can be used to access the object from
744 mono_gchandle_new_weakref (MonoObject *obj, gboolean track_resurrection)
746 guint32 handle = alloc_handle (&gc_handles [track_resurrection? HANDLE_WEAK_TRACK: HANDLE_WEAK], obj, track_resurrection);
749 if (track_resurrection)
750 mono_gc_add_weak_track_handle (obj, handle);
757 mono_gchandle_get_type (guint32 gchandle)
759 guint type = (gchandle & 7) - 1;
765 * mono_gchandle_get_target:
766 * @gchandle: a GCHandle's handle.
768 * The handle was previously created by calling mono_gchandle_new or
769 * mono_gchandle_new_weakref.
771 * Returns a pointer to the MonoObject represented by the handle or
772 * NULL for a collected object if using a weakref handle.
775 mono_gchandle_get_target (guint32 gchandle)
777 guint slot = gchandle >> 3;
778 guint type = (gchandle & 7) - 1;
779 HandleData *handles = &gc_handles [type];
780 MonoObject *obj = NULL;
783 lock_handles (handles);
784 if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
785 if (handles->type <= HANDLE_WEAK_TRACK) {
786 obj = mono_gc_weak_link_get (&handles->entries [slot]);
788 obj = handles->entries [slot];
791 /* print a warning? */
793 unlock_handles (handles);
794 /*g_print ("get target of entry %d of type %d: %p\n", slot, handles->type, obj);*/
799 mono_gchandle_set_target (guint32 gchandle, MonoObject *obj)
801 guint slot = gchandle >> 3;
802 guint type = (gchandle & 7) - 1;
803 HandleData *handles = &gc_handles [type];
804 MonoObject *old_obj = NULL;
808 lock_handles (handles);
809 if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
810 if (handles->type <= HANDLE_WEAK_TRACK) {
811 old_obj = handles->entries [slot];
812 if (handles->entries [slot])
813 mono_gc_weak_link_remove (&handles->entries [slot]);
815 mono_gc_weak_link_add (&handles->entries [slot], obj, handles->type == HANDLE_WEAK_TRACK);
817 handles->entries [slot] = obj;
820 /* print a warning? */
822 /*g_print ("changed entry %d of type %d to object %p (in slot: %p)\n", slot, handles->type, obj, handles->entries [slot]);*/
823 unlock_handles (handles);
826 if (type == HANDLE_WEAK_TRACK)
827 mono_gc_change_weak_track_handle (old_obj, obj, gchandle);
832 * mono_gchandle_is_in_domain:
833 * @gchandle: a GCHandle's handle.
834 * @domain: An application domain.
836 * Returns: true if the object wrapped by the @gchandle belongs to the specific @domain.
839 mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain)
841 guint slot = gchandle >> 3;
842 guint type = (gchandle & 7) - 1;
843 HandleData *handles = &gc_handles [type];
844 gboolean result = FALSE;
847 lock_handles (handles);
848 if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
849 if (handles->type <= HANDLE_WEAK_TRACK) {
850 result = domain->domain_id == handles->domain_ids [slot];
853 obj = handles->entries [slot];
857 result = domain == mono_object_domain (obj);
860 /* print a warning? */
862 unlock_handles (handles);
867 * mono_gchandle_free:
868 * @gchandle: a GCHandle's handle.
870 * Frees the @gchandle handle. If there are no outstanding
871 * references, the garbage collector can reclaim the memory of the
875 mono_gchandle_free (guint32 gchandle)
877 guint slot = gchandle >> 3;
878 guint type = (gchandle & 7) - 1;
879 HandleData *handles = &gc_handles [type];
883 if (type == HANDLE_WEAK_TRACK)
884 mono_gc_remove_weak_track_handle (gchandle);
887 lock_handles (handles);
888 if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
889 if (handles->type <= HANDLE_WEAK_TRACK) {
890 if (handles->entries [slot])
891 mono_gc_weak_link_remove (&handles->entries [slot]);
893 handles->entries [slot] = NULL;
895 handles->bitmap [slot / 32] &= ~(1 << (slot % 32));
897 /* print a warning? */
899 mono_perfcounters->gc_num_handles--;
900 /*g_print ("freed entry %d of type %d\n", slot, handles->type);*/
901 unlock_handles (handles);
902 mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_DESTROYED, handles->type, gchandle, NULL);
906 * mono_gchandle_free_domain:
907 * @domain: domain that is unloading
909 * Function used internally to cleanup any GC handle for objects belonging
910 * to the specified domain during appdomain unload.
913 mono_gchandle_free_domain (MonoDomain *domain)
917 for (type = 0; type < 3; ++type) {
919 HandleData *handles = &gc_handles [type];
920 lock_handles (handles);
921 for (slot = 0; slot < handles->size; ++slot) {
922 if (!(handles->bitmap [slot / 32] & (1 << (slot % 32))))
924 if (type <= HANDLE_WEAK_TRACK) {
925 if (domain->domain_id == handles->domain_ids [slot]) {
926 handles->bitmap [slot / 32] &= ~(1 << (slot % 32));
927 if (handles->entries [slot])
928 mono_gc_weak_link_remove (&handles->entries [slot]);
931 if (handles->entries [slot] && mono_object_domain (handles->entries [slot]) == domain) {
932 handles->bitmap [slot / 32] &= ~(1 << (slot % 32));
933 handles->entries [slot] = NULL;
937 unlock_handles (handles);
943 GCHandle_CheckCurrentDomain (guint32 gchandle)
945 return mono_gchandle_is_in_domain (gchandle, mono_domain_get ());
950 #ifdef MONO_HAS_SEMAPHORES
951 static MonoSemType finalizer_sem;
953 static HANDLE finalizer_event;
954 static volatile gboolean finished=FALSE;
957 mono_gc_finalize_notify (void)
960 g_message ( "%s: prodding finalizer", __func__);
963 #ifdef MONO_HAS_SEMAPHORES
964 MONO_SEM_POST (&finalizer_sem);
966 SetEvent (finalizer_event);
973 collect_objects (gpointer key, gpointer value, gpointer user_data)
975 GPtrArray *arr = (GPtrArray*)user_data;
976 g_ptr_array_add (arr, key);
982 * finalize_domain_objects:
984 * Run the finalizers of all finalizable objects in req->domain.
987 finalize_domain_objects (DomainFinalizationReq *req)
989 MonoDomain *domain = req->domain;
992 while (g_hash_table_size (domain->finalizable_objects_hash) > 0) {
996 * Since the domain is unloading, nobody is allowed to put
997 * new entries into the hash table. But finalize_object might
998 * remove entries from the hash table, so we make a copy.
1000 objs = g_ptr_array_new ();
1001 g_hash_table_foreach (domain->finalizable_objects_hash, collect_objects, objs);
1002 /* printf ("FINALIZING %d OBJECTS.\n", objs->len); */
1004 for (i = 0; i < objs->len; ++i) {
1005 MonoObject *o = (MonoObject*)g_ptr_array_index (objs, i);
1006 /* FIXME: Avoid finalizing threads, etc */
1007 mono_gc_run_finalize (o, 0);
1010 g_ptr_array_free (objs, TRUE);
1012 #elif defined(HAVE_SGEN_GC)
1013 #define NUM_FOBJECTS 64
1014 MonoObject *to_finalize [NUM_FOBJECTS];
1016 while ((count = mono_gc_finalizers_for_domain (domain, to_finalize, NUM_FOBJECTS))) {
1018 for (i = 0; i < count; ++i) {
1019 mono_gc_run_finalize (to_finalize [i], 0);
1024 /* Process finalizers which are already in the queue */
1025 mono_gc_invoke_finalizers ();
1027 /* printf ("DONE.\n"); */
1028 SetEvent (req->done_event);
1030 /* The event is closed in mono_domain_finalize if we get here */
1035 finalizer_thread (gpointer unused)
1038 /* Wait to be notified that there's at least one
1042 g_assert (mono_domain_get () == mono_get_root_domain ());
1044 #ifdef MONO_HAS_SEMAPHORES
1045 MONO_SEM_WAIT (&finalizer_sem);
1047 /* Use alertable=FALSE since we will be asked to exit using the event too */
1048 WaitForSingleObjectEx (finalizer_event, INFINITE, FALSE);
1051 mono_console_handle_async_ops ();
1053 #ifndef DISABLE_ATTACH
1054 mono_attach_maybe_start ();
1057 if (domains_to_finalize) {
1058 mono_finalizer_lock ();
1059 if (domains_to_finalize) {
1060 DomainFinalizationReq *req = domains_to_finalize->data;
1061 domains_to_finalize = g_slist_remove (domains_to_finalize, req);
1062 mono_finalizer_unlock ();
1064 finalize_domain_objects (req);
1066 mono_finalizer_unlock ();
1070 /* If finished == TRUE, mono_gc_cleanup has been called (from mono_runtime_cleanup),
1071 * before the domain is unloaded.
1073 mono_gc_invoke_finalizers ();
1075 SetEvent (pending_done_event);
1078 SetEvent (shutdown_event);
1085 InitializeCriticalSection (&handle_section);
1086 InitializeCriticalSection (&allocator_section);
1088 InitializeCriticalSection (&finalizer_mutex);
1090 MONO_GC_REGISTER_ROOT_FIXED (gc_handles [HANDLE_NORMAL].entries);
1091 MONO_GC_REGISTER_ROOT_FIXED (gc_handles [HANDLE_PINNED].entries);
1093 mono_gc_base_init ();
1095 if (mono_gc_is_disabled ()) {
1100 finalizer_event = CreateEvent (NULL, FALSE, FALSE, NULL);
1101 pending_done_event = CreateEvent (NULL, TRUE, FALSE, NULL);
1102 shutdown_event = CreateEvent (NULL, TRUE, FALSE, NULL);
1103 if (finalizer_event == NULL || pending_done_event == NULL || shutdown_event == NULL) {
1104 g_assert_not_reached ();
1106 #ifdef MONO_HAS_SEMAPHORES
1107 MONO_SEM_INIT (&finalizer_sem, 0);
1110 gc_thread = mono_thread_create_internal (mono_domain_get (), finalizer_thread, NULL, FALSE);
1114 mono_gc_cleanup (void)
1117 g_message ("%s: cleaning up finalizer", __func__);
1121 ResetEvent (shutdown_event);
1123 if (mono_thread_internal_current () != gc_thread) {
1124 mono_gc_finalize_notify ();
1125 /* Finishing the finalizer thread, so wait a little bit... */
1126 /* MS seems to wait for about 2 seconds */
1127 if (WaitForSingleObjectEx (shutdown_event, 2000, FALSE) == WAIT_TIMEOUT) {
1130 /* Set a flag which the finalizer thread can check */
1131 suspend_finalizers = TRUE;
1133 /* Try to abort the thread, in the hope that it is running managed code */
1134 mono_thread_internal_stop (gc_thread);
1136 /* Wait for it to stop */
1137 ret = WaitForSingleObjectEx (gc_thread->handle, 100, TRUE);
1139 if (ret == WAIT_TIMEOUT) {
1141 * The finalizer thread refused to die. There is not much we
1142 * can do here, since the runtime is shutting down so the
1143 * state the finalizer thread depends on will vanish.
1145 g_warning ("Shutting down finalizer thread timed out.");
1148 * FIXME: On unix, when the above wait returns, the thread
1149 * might still be running io-layer code, or pthreads code.
1157 #ifdef HAVE_BOEHM_GC
1158 GC_finalizer_notifier = NULL;
1162 DeleteCriticalSection (&handle_section);
1163 DeleteCriticalSection (&allocator_section);
1164 DeleteCriticalSection (&finalizer_mutex);
1169 /* Null GC dummy functions */
1171 mono_gc_finalize_notify (void)
1175 void mono_gc_init (void)
1177 InitializeCriticalSection (&handle_section);
1180 void mono_gc_cleanup (void)
1187 mono_gc_is_finalizer_internal_thread (MonoInternalThread *thread)
1189 return thread == gc_thread;
1193 * mono_gc_is_finalizer_thread:
1194 * @thread: the thread to test.
1196 * In Mono objects are finalized asynchronously on a separate thread.
1197 * This routine tests whether the @thread argument represents the
1198 * finalization thread.
1200 * Returns true if @thread is the finalization thread.
1203 mono_gc_is_finalizer_thread (MonoThread *thread)
1205 return mono_gc_is_finalizer_internal_thread (thread->internal_thread);
1208 #if defined(__MACH__)
1209 static pthread_t mach_exception_thread;
1212 mono_gc_register_mach_exception_thread (pthread_t thread)
1214 mach_exception_thread = thread;
1218 mono_gc_get_mach_exception_thread (void)
1220 return mach_exception_thread;