Wed Apr 9 15:19:41 CEST 2003 Paolo Molaro <lupus@ximian.com>
[mono.git] / mono / metadata / gc.c
index 5cd53882b3234adbac0574139602abd478cde087..49f19786d6458089a978f1586fd3f5b5bfa0e315 100644 (file)
 #include <glib.h>
 #include <string.h>
 
-#include <mono/metadata/gc.h>
+#include <mono/metadata/gc-internal.h>
 #include <mono/metadata/threads.h>
 #include <mono/metadata/tabledefs.h>
+#include <mono/metadata/exception.h>
 #define GC_I_HIDE_POINTERS
 #include <mono/os/gc_wrapper.h>
 
@@ -23,6 +24,8 @@
 
 static int finalize_slot = -1;
 
+static void object_register_finalizer (MonoObject *obj, void (*callback)(void *, void*));
+
 /* 
  * actually, we might want to queue the finalize requests in a separate thread,
  * but we need to be careful about the execution domain of the thread...
@@ -45,8 +48,13 @@ run_finalize (void *obj, void *data)
                        }
                }
        }
+
+       /* make sure the finalizer is not called again if the object is resurrected */
+       object_register_finalizer (obj, NULL);
        /* speedup later... and use a timeout */
        /*g_print ("Finalize run on %p %s.%s\n", o, mono_object_class (o)->name_space, mono_object_class (o)->name);*/
+       mono_domain_set (mono_object_domain (o));
+
        mono_runtime_invoke (o->vtable->klass->vtable [finalize_slot], o, NULL, &exc);
 
        if (exc) {
@@ -69,7 +77,7 @@ object_register_finalizer (MonoObject *obj, void (*callback)(void *, void*))
        guint offset = 0;
 
        g_assert (GC_base (obj) == (char*)obj - offset);
-       GC_register_finalizer ((char*)obj - offset, callback, GUINT_TO_POINTER (offset), NULL, NULL);
+       GC_REGISTER_FINALIZER_NO_ORDER ((char*)obj - offset, callback, GUINT_TO_POINTER (offset), NULL, NULL);
 #endif
 }
 
@@ -150,21 +158,46 @@ finalize_static_data (MonoClass *class, MonoVTable *vtable, GHashTable *todo) {
        finalize_fields (class, vtable->data, FALSE, todo);
 }
 
-void
-mono_domain_finalize (MonoDomain *domain) {
-
+static guint32
+internal_domain_finalize (gpointer data) {
+       MonoDomain *domain=(MonoDomain *)data;
        GHashTable *todo = g_hash_table_new (NULL, NULL);
+
+       mono_thread_new_init (GetCurrentThreadId (), todo, NULL);
+       
 #if HAVE_BOEHM_GC
        GC_gcollect ();
 #endif
        mono_g_hash_table_foreach (domain->class_vtable_hash, (GHFunc)finalize_static_data, todo);
        /* FIXME: finalize objects in todo... */
        g_hash_table_destroy (todo);
+
+       return(0);
+}
+
+void
+mono_domain_finalize (MonoDomain *domain) 
+{
+       HANDLE finalize_thread;
+       
+       /* Need to run managed code in a subthread.
+        * Mono_domain_finalize() is called from the main thread in
+        * the jit and the embedded example, hence the thread creation
+        * here.
+        */
+       finalize_thread=CreateThread (NULL, 0, internal_domain_finalize, domain, 0, NULL);
+       if(finalize_thread==NULL) {
+               g_assert_not_reached ();
+       }
+       WaitForSingleObject (finalize_thread, INFINITE);
+       CloseHandle (finalize_thread);
 }
 
 void
 ves_icall_System_GC_InternalCollect (int generation)
 {
+       MONO_ARCH_SAVE_REGS;
+
 #if HAVE_BOEHM_GC
        GC_gcollect ();
 #endif
@@ -173,6 +206,8 @@ ves_icall_System_GC_InternalCollect (int generation)
 gint64
 ves_icall_System_GC_GetTotalMemory (MonoBoolean forceCollection)
 {
+       MONO_ARCH_SAVE_REGS;
+
 #if HAVE_BOEHM_GC
        if (forceCollection)
                GC_gcollect ();
@@ -185,6 +220,8 @@ ves_icall_System_GC_GetTotalMemory (MonoBoolean forceCollection)
 void
 ves_icall_System_GC_KeepAlive (MonoObject *obj)
 {
+       MONO_ARCH_SAVE_REGS;
+
        /*
         * Does nothing.
         */
@@ -193,21 +230,27 @@ ves_icall_System_GC_KeepAlive (MonoObject *obj)
 void
 ves_icall_System_GC_ReRegisterForFinalize (MonoObject *obj)
 {
+       MONO_ARCH_SAVE_REGS;
+
        object_register_finalizer (obj, run_finalize);
 }
 
 void
 ves_icall_System_GC_SuppressFinalize (MonoObject *obj)
 {
+       MONO_ARCH_SAVE_REGS;
+
        object_register_finalizer (obj, NULL);
 }
 
 void
 ves_icall_System_GC_WaitForPendingFinalizers (void)
 {
+       MONO_ARCH_SAVE_REGS;
 }
 
-/*static CRITICAL_SECTION handle_section;*/
+static CRITICAL_SECTION allocator_section;
+static CRITICAL_SECTION handle_section;
 static guint32 next_handle = 0;
 static gpointer *gc_handles = NULL;
 static guint8 *gc_handle_types = NULL;
@@ -236,17 +279,21 @@ ves_icall_System_GCHandle_GetTarget (guint32 handle)
        MonoObject *obj;
        gint32 type;
 
+       MONO_ARCH_SAVE_REGS;
+
        if (gc_handles) {
                type = handle & 0x3;
+               EnterCriticalSection (&handle_section);
                g_assert (type == gc_handle_types [handle >> 2]);
                obj = gc_handles [handle >> 2];
+               LeaveCriticalSection (&handle_section);
                if (!obj)
                        return NULL;
 
                if ((type == HANDLE_WEAK) || (type == HANDLE_WEAK_TRACK))
                        return REVEAL_POINTER (obj);
                else
-               return obj;
+                       return obj;
        }
        return NULL;
 }
@@ -255,27 +302,40 @@ guint32
 ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint32 type)
 {
        gpointer val = obj;
-       guint32 h, idx = next_handle++;
+       guint32 h, idx;
 
+       MONO_ARCH_SAVE_REGS;
+
+       EnterCriticalSection (&handle_section);
+       idx = next_handle++;
        if (idx >= array_size) {
 #if HAVE_BOEHM_GC
                gpointer *new_array;
                guint8 *new_type_array;
                if (!array_size)
                        array_size = 16;
-               new_array = GC_malloc (sizeof (gpointer) * (array_size * 2));
-               new_type_array = GC_malloc (sizeof (guint8) * (array_size * 2));
+               new_array = GC_MALLOC (sizeof (gpointer) * (array_size * 2));
+               new_type_array = GC_MALLOC (sizeof (guint8) * (array_size * 2));
                if (gc_handles) {
                        int i;
                        memcpy (new_array, gc_handles, sizeof (gpointer) * array_size);
                        memcpy (new_type_array, gc_handle_types, sizeof (guint8) * array_size);
                        /* need to re-register links for weak refs. test if GC_realloc needs the same */
                        for (i = 0; i < array_size; ++i) {
+#if 0 /* This breaks the threaded finalizer, by causing segfaults deep
+       * inside libgc.  I assume it will also break without the
+       * threaded finalizer, just that the stress test (bug 31333)
+       * deadlocks too early without it.  Reverting to the previous
+       * version here stops the segfault.
+       */
                                if ((gc_handle_types[i] == HANDLE_WEAK) || (gc_handle_types[i] == HANDLE_WEAK_TRACK)) { /* all and only disguised pointers have it set */
+#else
+                               if (((gulong)new_array [i]) & 0x1) {
+#endif
                                        if (gc_handles [i] != (gpointer)-1)
                                                GC_unregister_disappearing_link (&(gc_handles [i]));
                                        if (new_array [i] != (gpointer)-1)
-                                               GC_general_register_disappearing_link (&(new_array [i]), REVEAL_POINTER (new_array [i]));
+                                               GC_GENERAL_REGISTER_DISAPPEARING_LINK (&(new_array [i]), REVEAL_POINTER (new_array [i]));
                                }
                        }
                }
@@ -283,7 +343,7 @@ ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint
                gc_handles = new_array;
                gc_handle_types = new_type_array;
 #else
-               g_error ("No GCHandle support built-in");
+               mono_raise_exception (mono_get_exception_execution_engine ("No GCHandle support built-in"));
 #endif
        }
 
@@ -299,9 +359,9 @@ ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint
                gc_handle_types [idx] = type;
 #if HAVE_BOEHM_GC
                if (gc_handles [idx] != (gpointer)-1)
-                       GC_general_register_disappearing_link (&(gc_handles [idx]), obj);
+                       GC_GENERAL_REGISTER_DISAPPEARING_LINK (&(gc_handles [idx]), obj);
 #else
-               g_error ("No weakref support");
+               mono_raise_exception (mono_get_exception_execution_engine ("No weakref support"));
 #endif
                break;
        default:
@@ -309,6 +369,7 @@ ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint
                gc_handle_types [idx] = type;
                break;
        }
+       LeaveCriticalSection (&handle_section);
        return h;
 }
 
@@ -318,6 +379,10 @@ ves_icall_System_GCHandle_FreeHandle (guint32 handle)
        int idx = handle >> 2;
        int type = handle & 0x3;
 
+       MONO_ARCH_SAVE_REGS;
+
+       EnterCriticalSection (&handle_section);
+
 #ifdef HAVE_BOEHM_GC
        g_assert (type == gc_handle_types [idx]);
        if ((type == HANDLE_WEAK) || (type == HANDLE_WEAK_TRACK)) {
@@ -325,11 +390,12 @@ ves_icall_System_GCHandle_FreeHandle (guint32 handle)
                        GC_unregister_disappearing_link (&(gc_handles [idx]));
        }
 #else
-       g_error ("No GCHandle support");
+       mono_raise_exception (mono_get_exception_execution_engine ("No GCHandle support"));
 #endif
 
        gc_handles [idx] = (gpointer)-1;
        gc_handle_types [idx] = (guint8)-1;
+       LeaveCriticalSection (&handle_section);
 }
 
 gpointer
@@ -338,9 +404,13 @@ ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle)
        MonoObject *obj;
        int type = handle & 0x3;
 
+       MONO_ARCH_SAVE_REGS;
+
        if (gc_handles) {
+               EnterCriticalSection (&handle_section);
                obj = gc_handles [handle >> 2];
                g_assert (gc_handle_types [handle >> 2] == type);
+               LeaveCriticalSection (&handle_section);
                if ((type == HANDLE_WEAK) || (type == HANDLE_WEAK_TRACK)) {
                        obj = REVEAL_POINTER (obj);
                        if (obj == (MonoObject *) -1)
@@ -351,4 +421,136 @@ ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle)
        return NULL;
 }
 
+#if HAVE_BOEHM_GC
+
+static HANDLE finalizer_event;
+static volatile gboolean finished=FALSE;
+
+static void finalize_notify (void)
+{
+#ifdef DEBUG
+       g_message (G_GNUC_PRETTY_FUNCTION ": prodding finalizer");
+#endif
+
+       SetEvent (finalizer_event);
+}
+
+static guint32 finalizer_thread (gpointer unused)
+{
+       guint32 stack_start;
+       
+       mono_thread_new_init (GetCurrentThreadId (), &stack_start, NULL);
+       
+       while(!finished) {
+               /* Wait to be notified that there's at least one
+                * finaliser to run
+                */
+               WaitForSingleObject (finalizer_event, INFINITE);
+
+#ifdef DEBUG
+               g_message (G_GNUC_PRETTY_FUNCTION ": invoking finalizers");
+#endif
+
+               GC_invoke_finalizers ();
+       }
+       
+       return(0);
+}
+
+/* 
+ * Enable or disable the separate finalizer thread.
+ * It's currently disabled because it still requires some
+ * work in the rest of the runtime.
+ */
+#define ENABLE_FINALIZER_THREAD
+
+#ifdef WITH_INCLUDED_LIBGC
+/* from threads.c */
+extern void mono_gc_stop_world (void);
+extern void mono_gc_start_world (void);
+extern void mono_gc_push_all_stacks (void);
+
+static void mono_gc_lock (void)
+{
+       EnterCriticalSection (&allocator_section);
+}
+
+static void mono_gc_unlock (void)
+{
+       LeaveCriticalSection (&allocator_section);
+}
+
+static GCThreadFunctions mono_gc_thread_vtable = {
+       NULL,
+
+       mono_gc_lock,
+       mono_gc_unlock,
+
+       mono_gc_stop_world,
+       NULL,
+       mono_gc_push_all_stacks,
+       mono_gc_start_world
+};
+#endif /* WITH_INCLUDED_LIBGC */
+
+void mono_gc_init (void)
+{
+       HANDLE gc_thread;
+
+       InitializeCriticalSection (&handle_section);
+       InitializeCriticalSection (&allocator_section);
+
+#ifdef WITH_INCLUDED_LIBGC
+       gc_thread_vtable = &mono_gc_thread_vtable;
+#endif
+
+#ifdef ENABLE_FINALIZER_THREAD
+
+       if (getenv ("GC_DONT_GC"))
+               return;
+       
+       finalizer_event = CreateEvent (NULL, FALSE, FALSE, NULL);
+       if (finalizer_event == NULL) {
+               g_assert_not_reached ();
+       }
+
+       GC_finalize_on_demand = 1;
+       GC_finalizer_notifier = finalize_notify;
+       
+       /* Don't use mono_thread_create here, because we don't want
+        * the runtime to wait for this thread to exit when it's
+        * cleaning up.
+        */
+       gc_thread = CreateThread (NULL, 0, finalizer_thread, NULL, 0, NULL);
+       if (gc_thread == NULL) {
+               g_assert_not_reached ();
+       }
+#endif
+}
+
+void mono_gc_cleanup (void)
+{
+#ifdef DEBUG
+       g_message (G_GNUC_PRETTY_FUNCTION ": cleaning up finalizer");
+#endif
+
+#ifdef ENABLE_FINALIZER_THREAD
+       finished = TRUE;
+       finalize_notify ();
+#endif
+}
+
+#else
+
+/* no Boehm GC support. */
+void mono_gc_init (void)
+{
+       InitializeCriticalSection (&handle_section);
+}
+
+void mono_gc_cleanup (void)
+{
+}
+
+#endif