Merge pull request #2819 from BrzVlad/fix-major-log
[mono.git] / mono / metadata / sgen-bridge.c
index a25cab494cdf715b4713d1997afdaae7f8c53270..3b0487c9243afe496a0f5d842a592cdf5e7dd459 100644 (file)
@@ -3,38 +3,10 @@
  *
  * Copyright 2011 Novell, Inc (http://www.novell.com)
  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
- *
- * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
- * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
- *
- * Permission is hereby granted to use or copy this program
- * for any purpose,  provided the above notices are retained on all copies.
- * Permission to modify the code and to distribute modified code is granted,
- * provided the above notices are retained, and a notice that the code was
- * modified is included with the above copyright notice.
- *
- *
  * Copyright 2001-2003 Ximian, Inc
  * Copyright 2003-2010 Novell, Inc.
  *
- * Permission is hereby granted, free of charge, to any person obtaining
- * a copy of this software and associated documentation files (the
- * "Software"), to deal in the Software without restriction, including
- * without limitation the rights to use, copy, modify, merge, publish,
- * distribute, sublicense, and/or sell copies of the Software, and to
- * permit persons to whom the Software is furnished to do so, subject to
- * the following conditions:
- *
- * The above copyright notice and this permission notice shall be
- * included in all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
- * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
- * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
- * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * Licensed under the MIT license. See LICENSE file in the project root for full license information.
  */
 
 #include "config.h"
 
 #include <stdlib.h>
 
-#include "sgen-gc.h"
-#include "sgen-bridge.h"
-#include "sgen-hash-table.h"
-#include "sgen-qsort.h"
-#include "utils/mono-logger-internal.h"
-#include "utils/mono-time.h"
-#include "utils/mono-compiler.h"
+#include "sgen/sgen-gc.h"
+#include "sgen-bridge-internals.h"
+#include "sgen/sgen-hash-table.h"
+#include "sgen/sgen-qsort.h"
+#include "utils/mono-logger-internals.h"
 
 MonoGCBridgeCallbacks bridge_callbacks;
 static SgenBridgeProcessor bridge_processor;
+static SgenBridgeProcessor compare_to_bridge_processor;
 
-gboolean bridge_processing_in_progress = FALSE;
+volatile gboolean bridge_processing_in_progress = FALSE;
 
 void
 mono_gc_wait_for_bridge_processing (void)
@@ -77,11 +48,37 @@ mono_gc_register_bridge_callbacks (MonoGCBridgeCallbacks *callbacks)
 
        bridge_callbacks = *callbacks;
 
-       sgen_old_bridge_init (&bridge_processor);
+       if (!bridge_processor.reset_data)
+               sgen_new_bridge_init (&bridge_processor);
+}
+
+static gboolean
+init_bridge_processor (SgenBridgeProcessor *processor, const char *name)
+{
+       if (!strcmp ("old", name)) {
+               memset (processor, 0, sizeof (SgenBridgeProcessor));
+               sgen_old_bridge_init (processor);
+       } else if (!strcmp ("new", name)) {
+               memset (processor, 0, sizeof (SgenBridgeProcessor));
+               sgen_new_bridge_init (processor);
+       } else if (!strcmp ("tarjan", name)) {
+               memset (processor, 0, sizeof (SgenBridgeProcessor));
+               sgen_tarjan_bridge_init (processor);
+       } else {
+               return FALSE;
+       }
+       return TRUE;
+}
+
+void
+sgen_set_bridge_implementation (const char *name)
+{
+       if (!init_bridge_processor (&bridge_processor, name))
+               g_warning ("Invalid value for bridge implementation, valid values are: 'new' and 'old'.");
 }
 
 gboolean
-sgen_is_bridge_object (MonoObject *obj)
+sgen_is_bridge_object (GCObject *obj)
 {
        if ((obj->vtable->gc_bits & SGEN_GC_BIT_BRIDGE_OBJECT) != SGEN_GC_BIT_BRIDGE_OBJECT)
                return FALSE;
@@ -94,56 +91,332 @@ sgen_need_bridge_processing (void)
        return bridge_callbacks.cross_references != NULL;
 }
 
+static gboolean
+compare_bridge_processors (void)
+{
+       return compare_to_bridge_processor.reset_data != NULL;
+}
+
 /* Dispatch wrappers */
 void
 sgen_bridge_reset_data (void)
 {
        bridge_processor.reset_data ();
+       if (compare_bridge_processors ())
+               compare_to_bridge_processor.reset_data ();
 }
 
 void
 sgen_bridge_processing_stw_step (void)
 {
+       /*
+        * bridge_processing_in_progress must be set with the world
+        * stopped.  If not there would be race conditions.
+        */
+       bridge_processing_in_progress = TRUE;
+
        bridge_processor.processing_stw_step ();
+       if (compare_bridge_processors ())
+               compare_to_bridge_processor.processing_stw_step ();
+}
+
+static gboolean
+is_bridge_object_dead (GCObject *obj, void *data)
+{
+       SgenHashTable *table = (SgenHashTable *)data;
+       unsigned char *value = (unsigned char *)sgen_hash_table_lookup (table, obj);
+       if (!value)
+               return FALSE;
+       return !*value;
+}
+
+static void
+null_weak_links_to_dead_objects (SgenBridgeProcessor *processor, int generation)
+{
+       int i, j;
+       int num_sccs = processor->num_sccs;
+       MonoGCBridgeSCC **api_sccs = processor->api_sccs;
+       SgenHashTable alive_hash = SGEN_HASH_TABLE_INIT (INTERNAL_MEM_BRIDGE_ALIVE_HASH_TABLE, INTERNAL_MEM_BRIDGE_ALIVE_HASH_TABLE_ENTRY, 1, mono_aligned_addr_hash, NULL);
+
+       for (i = 0; i < num_sccs; ++i) {
+               unsigned char alive = api_sccs [i]->is_alive ? 1 : 0;
+               for (j = 0; j < api_sccs [i]->num_objs; ++j) {
+                       /* Build hash table for nulling weak links. */
+                       sgen_hash_table_replace (&alive_hash, api_sccs [i]->objs [j], &alive, NULL);
+
+                       /* Release for finalization those objects we no longer care. */
+                       if (!api_sccs [i]->is_alive)
+                               sgen_mark_bridge_object (api_sccs [i]->objs [j]);
+               }
+       }
+
+       /* Null weak links to dead objects. */
+       sgen_null_links_if (is_bridge_object_dead, &alive_hash, GENERATION_NURSERY, FALSE);
+       sgen_null_links_if (is_bridge_object_dead, &alive_hash, GENERATION_NURSERY, TRUE);
+       if (generation == GENERATION_OLD) {
+               sgen_null_links_if (is_bridge_object_dead, &alive_hash, GENERATION_OLD, FALSE);
+               sgen_null_links_if (is_bridge_object_dead, &alive_hash, GENERATION_OLD, TRUE);
+       }
+
+       sgen_hash_table_clean (&alive_hash);
+}
+
+static void
+free_callback_data (SgenBridgeProcessor *processor)
+{
+       int i;
+       int num_sccs = processor->num_sccs;
+       int num_xrefs = processor->num_xrefs;
+       MonoGCBridgeSCC **api_sccs = processor->api_sccs;
+       MonoGCBridgeXRef *api_xrefs = processor->api_xrefs;
+
+       for (i = 0; i < num_sccs; ++i) {
+               sgen_free_internal_dynamic (api_sccs [i],
+                               sizeof (MonoGCBridgeSCC) + sizeof (MonoObject*) * api_sccs [i]->num_objs,
+                               INTERNAL_MEM_BRIDGE_DATA);
+       }
+       sgen_free_internal_dynamic (api_sccs, sizeof (MonoGCBridgeSCC*) * num_sccs, INTERNAL_MEM_BRIDGE_DATA);
+
+       sgen_free_internal_dynamic (api_xrefs, sizeof (MonoGCBridgeXRef) * num_xrefs, INTERNAL_MEM_BRIDGE_DATA);
+
+       processor->num_sccs = 0;
+       processor->api_sccs = NULL;
+       processor->num_xrefs = 0;
+       processor->api_xrefs = NULL;
+}
+
+static int
+compare_xrefs (const void *a_ptr, const void *b_ptr)
+{
+       const MonoGCBridgeXRef *a = (const MonoGCBridgeXRef *)a_ptr;
+       const MonoGCBridgeXRef *b = (const MonoGCBridgeXRef *)b_ptr;
+
+       if (a->src_scc_index < b->src_scc_index)
+               return -1;
+       if (a->src_scc_index > b->src_scc_index)
+               return 1;
+
+       if (a->dst_scc_index < b->dst_scc_index)
+               return -1;
+       if (a->dst_scc_index > b->dst_scc_index)
+               return 1;
+
+       return 0;
+}
+
+/*
+static void
+dump_processor_state (SgenBridgeProcessor *p)
+{
+       int i;
+
+       printf ("------\n");
+       printf ("SCCS %d\n", p->num_sccs);
+       for (i = 0; i < p->num_sccs; ++i) {
+               int j;
+               MonoGCBridgeSCC *scc = p->api_sccs [i];
+               printf ("\tSCC %d:", i);
+               for (j = 0; j < scc->num_objs; ++j) {
+                       MonoObject *obj = scc->objs [j];
+                       printf (" %p", obj);
+               }
+               printf ("\n");
+       }
+
+       printf ("XREFS %d\n", p->num_xrefs);
+       for (i = 0; i < p->num_xrefs; ++i)
+               printf ("\t%d -> %d\n", p->api_xrefs [i].src_scc_index, p->api_xrefs [i].dst_scc_index);
+
+       printf ("-------\n");
+}
+*/
+
+static gboolean
+sgen_compare_bridge_processor_results (SgenBridgeProcessor *a, SgenBridgeProcessor *b)
+{
+       int i;
+       SgenHashTable obj_to_a_scc = SGEN_HASH_TABLE_INIT (INTERNAL_MEM_BRIDGE_DEBUG, INTERNAL_MEM_BRIDGE_DEBUG, sizeof (int), mono_aligned_addr_hash, NULL);
+       SgenHashTable b_scc_to_a_scc = SGEN_HASH_TABLE_INIT (INTERNAL_MEM_BRIDGE_DEBUG, INTERNAL_MEM_BRIDGE_DEBUG, sizeof (int), g_direct_hash, NULL);
+       MonoGCBridgeXRef *a_xrefs, *b_xrefs;
+       size_t xrefs_alloc_size;
+
+       // dump_processor_state (a);
+       // dump_processor_state (b);
+
+       if (a->num_sccs != b->num_sccs)
+               g_error ("SCCS count expected %d but got %d", a->num_sccs, b->num_sccs);
+       if (a->num_xrefs != b->num_xrefs)
+               g_error ("SCCS count expected %d but got %d", a->num_xrefs, b->num_xrefs);
+
+       /*
+        * First we build a hash of each object in `a` to its respective SCC index within
+        * `a`.  Along the way we also assert that no object is more than one SCC.
+        */
+       for (i = 0; i < a->num_sccs; ++i) {
+               int j;
+               MonoGCBridgeSCC *scc = a->api_sccs [i];
+
+               g_assert (scc->num_objs > 0);
+
+               for (j = 0; j < scc->num_objs; ++j) {
+                       GCObject *obj = scc->objs [j];
+                       gboolean new_entry = sgen_hash_table_replace (&obj_to_a_scc, obj, &i, NULL);
+                       g_assert (new_entry);
+               }
+       }
+
+       /*
+        * Now we check whether each of the objects in `b` are in `a`, and whether the SCCs
+        * of `b` contain the same sets of objects as those of `a`.
+        *
+        * While we're doing this, build a hash table to map from `b` SCC indexes to `a` SCC
+        * indexes.
+        */
+       for (i = 0; i < b->num_sccs; ++i) {
+               MonoGCBridgeSCC *scc = b->api_sccs [i];
+               MonoGCBridgeSCC *a_scc;
+               int *a_scc_index_ptr;
+               int a_scc_index;
+               int j;
+               gboolean new_entry;
+
+               g_assert (scc->num_objs > 0);
+               a_scc_index_ptr = (int *)sgen_hash_table_lookup (&obj_to_a_scc, scc->objs [0]);
+               g_assert (a_scc_index_ptr);
+               a_scc_index = *a_scc_index_ptr;
+
+               //g_print ("A SCC %d -> B SCC %d\n", a_scc_index, i);
+
+               a_scc = a->api_sccs [a_scc_index];
+               g_assert (a_scc->num_objs == scc->num_objs);
+
+               for (j = 1; j < scc->num_objs; ++j) {
+                       a_scc_index_ptr = (int *)sgen_hash_table_lookup (&obj_to_a_scc, scc->objs [j]);
+                       g_assert (a_scc_index_ptr);
+                       g_assert (*a_scc_index_ptr == a_scc_index);
+               }
+
+               new_entry = sgen_hash_table_replace (&b_scc_to_a_scc, GINT_TO_POINTER (i), &a_scc_index, NULL);
+               g_assert (new_entry);
+       }
+
+       /*
+        * Finally, check that we have the same xrefs.  We do this by making copies of both
+        * xref arrays, and replacing the SCC indexes in the copy for `b` with the
+        * corresponding indexes in `a`.  Then we sort both arrays and assert that they're
+        * the same.
+        *
+        * At the same time, check that no xref is self-referential and that there are no
+        * duplicate ones.
+        */
+
+       xrefs_alloc_size = a->num_xrefs * sizeof (MonoGCBridgeXRef);
+       a_xrefs = (MonoGCBridgeXRef *)sgen_alloc_internal_dynamic (xrefs_alloc_size, INTERNAL_MEM_BRIDGE_DEBUG, TRUE);
+       b_xrefs = (MonoGCBridgeXRef *)sgen_alloc_internal_dynamic (xrefs_alloc_size, INTERNAL_MEM_BRIDGE_DEBUG, TRUE);
+
+       memcpy (a_xrefs, a->api_xrefs, xrefs_alloc_size);
+       for (i = 0; i < b->num_xrefs; ++i) {
+               MonoGCBridgeXRef *xref = &b->api_xrefs [i];
+               int *scc_index_ptr;
+
+               g_assert (xref->src_scc_index != xref->dst_scc_index);
+
+               scc_index_ptr = (int *)sgen_hash_table_lookup (&b_scc_to_a_scc, GINT_TO_POINTER (xref->src_scc_index));
+               g_assert (scc_index_ptr);
+               b_xrefs [i].src_scc_index = *scc_index_ptr;
+
+               scc_index_ptr = (int *)sgen_hash_table_lookup (&b_scc_to_a_scc, GINT_TO_POINTER (xref->dst_scc_index));
+               g_assert (scc_index_ptr);
+               b_xrefs [i].dst_scc_index = *scc_index_ptr;
+       }
+
+       qsort (a_xrefs, a->num_xrefs, sizeof (MonoGCBridgeXRef), compare_xrefs);
+       qsort (b_xrefs, a->num_xrefs, sizeof (MonoGCBridgeXRef), compare_xrefs);
+
+       for (i = 0; i < a->num_xrefs; ++i) {
+               g_assert (a_xrefs [i].src_scc_index == b_xrefs [i].src_scc_index);
+               g_assert (a_xrefs [i].dst_scc_index == b_xrefs [i].dst_scc_index);
+       }
+
+       sgen_hash_table_clean (&obj_to_a_scc);
+       sgen_hash_table_clean (&b_scc_to_a_scc);
+       sgen_free_internal_dynamic (a_xrefs, xrefs_alloc_size, INTERNAL_MEM_BRIDGE_DEBUG);
+       sgen_free_internal_dynamic (b_xrefs, xrefs_alloc_size, INTERNAL_MEM_BRIDGE_DEBUG);
+
+       return TRUE;
 }
 
 void
 sgen_bridge_processing_finish (int generation)
 {
-       bridge_processor.processing_finish (generation);
+       bridge_processor.processing_build_callback_data (generation);
+       if (compare_bridge_processors ())
+               compare_to_bridge_processor.processing_build_callback_data (generation);
+
+       if (bridge_processor.num_sccs == 0) {
+               g_assert (bridge_processor.num_xrefs == 0);
+               goto after_callback;
+       }
+
+       bridge_callbacks.cross_references (bridge_processor.num_sccs, bridge_processor.api_sccs,
+                       bridge_processor.num_xrefs, bridge_processor.api_xrefs);
+
+       if (compare_bridge_processors ())
+               sgen_compare_bridge_processor_results (&bridge_processor, &compare_to_bridge_processor);
+
+       null_weak_links_to_dead_objects (&bridge_processor, generation);
+
+       free_callback_data (&bridge_processor);
+       if (compare_bridge_processors ())
+               free_callback_data (&compare_to_bridge_processor);
+
+ after_callback:
+       bridge_processor.processing_after_callback (generation);
+       if (compare_bridge_processors ())
+               compare_to_bridge_processor.processing_after_callback (generation);
+
+       bridge_processing_in_progress = FALSE;
 }
 
 MonoGCBridgeObjectKind
-sgen_bridge_class_kind (MonoClass *class)
+sgen_bridge_class_kind (MonoClass *klass)
 {
-       return bridge_processor.class_kind (class);
+       return bridge_processor.class_kind (klass);
 }
 
 void
-sgen_bridge_register_finalized_object (MonoObject *obj)
+sgen_bridge_register_finalized_object (GCObject *obj)
 {
        bridge_processor.register_finalized_object (obj);
+       if (compare_bridge_processors ())
+               compare_to_bridge_processor.register_finalized_object (obj);
 }
 
 void
-sgen_bridge_describe_pointer (MonoObject *obj)
+sgen_bridge_describe_pointer (GCObject *obj)
 {
-       bridge_processor.describe_pointer (obj);
+       if (bridge_processor.describe_pointer)
+               bridge_processor.describe_pointer (obj);
 }
 
-void
-sgen_enable_bridge_accounting (void)
+static void
+set_dump_prefix (const char *prefix)
 {
-       bridge_processor.enable_accounting ();
+       if (!bridge_processor.set_dump_prefix) {
+               fprintf (stderr, "Warning: Bridge implementation does not support dumping - ignoring.\n");
+               return;
+       }
+
+       bridge_processor.set_dump_prefix (prefix);
 }
 
 /* Test support code */
 static const char *bridge_class;
 
 static MonoGCBridgeObjectKind
-bridge_test_bridge_class_kind (MonoClass *class)
+bridge_test_bridge_class_kind (MonoClass *klass)
 {
-       if (!strcmp (bridge_class, class->name))
+       if (!strcmp (bridge_class, klass->name))
                return GC_BRIDGE_TRANSPARENT_BRIDGE_CLASS;
        return GC_BRIDGE_TRANSPARENT_CLASS;
 }
@@ -253,8 +526,8 @@ bridge_test_cross_reference2 (int num_sccs, MonoGCBridgeSCC **sccs, int num_xref
                sccs [i]->is_alive = TRUE;
 }
 
-void
-sgen_register_test_bridge_callbacks (const char *bridge_class_name)
+static void
+register_test_bridge_callbacks (const char *bridge_class_name)
 {
        MonoGCBridgeCallbacks callbacks;
        callbacks.bridge_version = SGEN_BRIDGE_VERSION;
@@ -265,4 +538,40 @@ sgen_register_test_bridge_callbacks (const char *bridge_class_name)
        bridge_class = bridge_class_name + (bridge_class_name[0] == '2' ? 1 : 0);
 }
 
+gboolean
+sgen_bridge_handle_gc_debug (const char *opt)
+{
+       if (g_str_has_prefix (opt, "bridge=")) {
+               opt = strchr (opt, '=') + 1;
+               register_test_bridge_callbacks (g_strdup (opt));
+       } else if (!strcmp (opt, "enable-bridge-accounting")) {
+               bridge_processor.enable_accounting ();
+       } else if (g_str_has_prefix (opt, "bridge-dump=")) {
+               char *prefix = strchr (opt, '=') + 1;
+               set_dump_prefix (prefix);
+       } else if (g_str_has_prefix (opt, "bridge-compare-to=")) {
+               const char *name = strchr (opt, '=') + 1;
+               if (init_bridge_processor (&compare_to_bridge_processor, name)) {
+                       if (compare_to_bridge_processor.reset_data == bridge_processor.reset_data) {
+                               g_warning ("Cannot compare bridge implementation to itself - ignoring.");
+                               memset (&compare_to_bridge_processor, 0, sizeof (SgenBridgeProcessor));
+                       }
+               } else {
+                       g_warning ("Invalid bridge implementation to compare against - ignoring.");
+               }
+       } else {
+               return FALSE;
+       }
+       return TRUE;
+}
+
+void
+sgen_bridge_print_gc_debug_usage (void)
+{
+       fprintf (stderr, "  bridge=<class-name>\n");
+       fprintf (stderr, "  enable-bridge-accounting\n");
+       fprintf (stderr, "  bridge-dump=<filename-prefix>\n");
+       fprintf (stderr, "  bridge-compare-to=<implementation>\n");
+}
+
 #endif