[runtime] Further removed code that doubted IMT
[mono.git] / mono / metadata / sgen-pinning.c
index d0a38ef426eb94b8b90c82bcedd4490e3fc35ce2..2d7a8ca498c81f01374ad692d400d423fc24e07b 100644 (file)
 #include "metadata/sgen-gc.h"
 #include "metadata/sgen-pinning.h"
 #include "metadata/sgen-protocol.h"
+#include "metadata/sgen-pointer-queue.h"
 
-static void** pin_queue;
-static int pin_queue_size = 0;
-static int next_pin_slot = 0;
-static int last_num_pinned = 0;
+static SgenPointerQueue pin_queue;
+static size_t last_num_pinned = 0;
 
 #define PIN_HASH_SIZE 1024
 static void *pin_hash_filter [PIN_HASH_SIZE];
@@ -38,25 +37,14 @@ void
 sgen_init_pinning (void)
 {
        memset (pin_hash_filter, 0, sizeof (pin_hash_filter));
+       pin_queue.mem_type = INTERNAL_MEM_PIN_QUEUE;
 }
 
 void
 sgen_finish_pinning (void)
 {
-       last_num_pinned = next_pin_slot;
-       next_pin_slot = 0;
-}
-
-static void
-realloc_pin_queue (void)
-{
-       int new_size = pin_queue_size? pin_queue_size + pin_queue_size/2: 1024;
-       void **new_pin = sgen_alloc_internal_dynamic (sizeof (void*) * new_size, INTERNAL_MEM_PIN_QUEUE, TRUE);
-       memcpy (new_pin, pin_queue, sizeof (void*) * next_pin_slot);
-       sgen_free_internal_dynamic (pin_queue, sizeof (void*) * pin_queue_size, INTERNAL_MEM_PIN_QUEUE);
-       pin_queue = new_pin;
-       pin_queue_size = new_size;
-       SGEN_LOG (4, "Reallocated pin queue to size: %d", new_size);
+       last_num_pinned = pin_queue.next_slot;
+       sgen_pointer_queue_clear (&pin_queue);
 }
 
 void
@@ -69,71 +57,92 @@ sgen_pin_stage_ptr (void *ptr)
 
        pin_hash_filter [hash_idx] = ptr;
 
-       if (next_pin_slot >= pin_queue_size)
-               realloc_pin_queue ();
-
-       pin_queue [next_pin_slot++] = ptr;
+       sgen_pointer_queue_add (&pin_queue, ptr);
 }
 
-static int
-optimized_pin_queue_search (void *addr)
+gboolean
+sgen_find_optimized_pin_queue_area (void *start, void *end, size_t *first_out, size_t *last_out)
 {
-       int first = 0, last = next_pin_slot;
-       while (first < last) {
-               int middle = first + ((last - first) >> 1);
-               if (addr <= pin_queue [middle])
-                       last = middle;
-               else
-                       first = middle + 1;
-       }
-       g_assert (first == last);
-       return first;
+       size_t first = sgen_pointer_queue_search (&pin_queue, start);
+       size_t last = sgen_pointer_queue_search (&pin_queue, end);
+       SGEN_ASSERT (0, last == pin_queue.next_slot || pin_queue.data [last] >= end, "Pin queue search gone awry");
+       *first_out = first;
+       *last_out = last;
+       return first != last;
 }
 
 void**
-sgen_find_optimized_pin_queue_area (void *start, void *end, int *num)
+sgen_pinning_get_entry (size_t index)
 {
-       int first, last;
-       first = optimized_pin_queue_search (start);
-       last = optimized_pin_queue_search (end);
-       *num = last - first;
-       if (first == last)
-               return NULL;
-       return pin_queue + first;
+       SGEN_ASSERT (0, index <= pin_queue.next_slot, "Pin queue entry out of range");
+       return &pin_queue.data [index];
 }
 
 void
 sgen_find_section_pin_queue_start_end (GCMemSection *section)
 {
        SGEN_LOG (6, "Pinning from section %p (%p-%p)", section, section->data, section->end_data);
-       section->pin_queue_start = sgen_find_optimized_pin_queue_area (section->data, section->end_data, &section->pin_queue_num_entries);
-       SGEN_LOG (6, "Found %d pinning addresses in section %p", section->pin_queue_num_entries, section);
+
+       sgen_find_optimized_pin_queue_area (section->data, section->end_data,
+                       &section->pin_queue_first_entry, &section->pin_queue_last_entry);
+
+       SGEN_LOG (6, "Found %zd pinning addresses in section %p",
+                       section->pin_queue_last_entry - section->pin_queue_first_entry, section);
 }
 
 /*This will setup the given section for the while pin queue. */
 void
 sgen_pinning_setup_section (GCMemSection *section)
 {
-       section->pin_queue_start = pin_queue;
-       section->pin_queue_num_entries = next_pin_slot;
+       section->pin_queue_first_entry = 0;
+       section->pin_queue_last_entry = pin_queue.next_slot;
 }
 
 void
 sgen_pinning_trim_queue_to_section (GCMemSection *section)
 {
-       next_pin_slot = section->pin_queue_num_entries;
+       SGEN_ASSERT (0, section->pin_queue_first_entry == 0, "Pin queue trimming assumes the whole pin queue is used by the nursery");
+       pin_queue.next_slot = section->pin_queue_last_entry;
 }
 
+/*
+ * This is called when we've run out of memory during a major collection.
+ *
+ * After collecting potential pin entries and sorting the array, this is what it looks like:
+ *
+ * +--------------------+---------------------------------------------+--------------------+
+ * | major heap entries |               nursery entries               | major heap entries |
+ * +--------------------+---------------------------------------------+--------------------+
+ *
+ * Of course there might not be major heap entries before and/or after the nursery entries,
+ * depending on where the major heap sections are in the address space, and whether there
+ * were any potential pointers there.
+ *
+ * When we pin nursery objects, we compact the nursery part of the pin array, which leaves
+ * discarded entries after the ones that actually pointed to nursery objects:
+ *
+ * +--------------------+-----------------+---------------------------+--------------------+
+ * | major heap entries | nursery entries | discarded nursery entries | major heap entries |
+ * +--------------------+-----------------+---------------------------+--------------------+
+ *
+ * When, due to being out of memory, we late pin more objects, the pin array looks like
+ * this:
+ *
+ * +--------------------+-----------------+---------------------------+--------------------+--------------+
+ * | major heap entries | nursery entries | discarded nursery entries | major heap entries | late entries |
+ * +--------------------+-----------------+---------------------------+--------------------+--------------+
+ *
+ * This function gets rid of the discarded nursery entries by nulling them out.  Note that
+ * we can late pin objects not only in the nursery but also in the major heap, which happens
+ * when evacuation fails.
+ */
 void
-sgen_pin_queue_clear_discarded_entries (GCMemSection *section, int max_pin_slot)
+sgen_pin_queue_clear_discarded_entries (GCMemSection *section, size_t max_pin_slot)
 {
-       void **start = section->pin_queue_start + section->pin_queue_num_entries;
-       void **end = pin_queue + max_pin_slot;
+       void **start = sgen_pinning_get_entry (section->pin_queue_last_entry);
+       void **end = sgen_pinning_get_entry (max_pin_slot);
        void *addr;
 
-       if (!start)
-               return;
-
        for (; start < end; ++start) {
                addr = *start;
                if ((char*)addr < section->data || (char*)addr > section->end_data)
@@ -144,30 +153,15 @@ sgen_pin_queue_clear_discarded_entries (GCMemSection *section, int max_pin_slot)
 
 /* reduce the info in the pin queue, removing duplicate pointers and sorting them */
 void
-sgen_optimize_pin_queue (int start_slot)
+sgen_optimize_pin_queue (void)
 {
-       void **start, **cur, **end;
-       /* sort and uniq pin_queue: we just sort and we let the rest discard multiple values */
-       /* it may be better to keep ranges of pinned memory instead of individually pinning objects */
-       SGEN_LOG (5, "Sorting pin queue, size: %d", next_pin_slot);
-       if ((next_pin_slot - start_slot) > 1)
-               sgen_sort_addresses (pin_queue + start_slot, next_pin_slot - start_slot);
-       start = cur = pin_queue + start_slot;
-       end = pin_queue + next_pin_slot;
-       while (cur < end) {
-               *start = *cur++;
-               while (*start == *cur && cur < end)
-                       cur++;
-               start++;
-       };
-       next_pin_slot = start - pin_queue;
-       SGEN_LOG (5, "Pin queue reduced to size: %d", next_pin_slot);
+       sgen_pointer_queue_sort_uniq (&pin_queue);
 }
 
-int
+size_t
 sgen_get_pinned_count (void)
 {
-       return next_pin_slot;
+       return pin_queue.next_slot;
 }
 
 void
@@ -176,8 +170,9 @@ sgen_dump_pin_queue (void)
        int i;
 
        for (i = 0; i < last_num_pinned; ++i) {
-               SGEN_LOG (3, "Bastard pinning obj %p (%s), size: %d", pin_queue [i], sgen_safe_name (pin_queue [i]), sgen_safe_object_get_size (pin_queue [i]));
-       }       
+               void *ptr = pin_queue.data [i];
+               SGEN_LOG (3, "Bastard pinning obj %p (%s), size: %zd", ptr, sgen_safe_name (ptr), sgen_safe_object_get_size (ptr));
+       }
 }
 
 typedef struct _CementHashEntry CementHashEntry;
@@ -187,10 +182,8 @@ struct _CementHashEntry {
 };
 
 static CementHashEntry cement_hash [SGEN_CEMENT_HASH_SIZE];
-static CementHashEntry cement_hash_concurrent [SGEN_CEMENT_HASH_SIZE];
 
 static gboolean cement_enabled = TRUE;
-static gboolean cement_concurrent = FALSE;
 
 void
 sgen_cement_init (gboolean enabled)
@@ -201,52 +194,15 @@ sgen_cement_init (gboolean enabled)
 void
 sgen_cement_reset (void)
 {
-       SGEN_ASSERT (1, !cement_concurrent, "Concurrent cementing cannot simply be reset");
-
        memset (cement_hash, 0, sizeof (cement_hash));
        binary_protocol_cement_reset ();
 }
 
-/*
- * The reason we cannot simply reset cementing at the start of a
- * concurrent collection is that the nursery collections running
- * concurrently must keep pinning the cemented objects, because we
- * don't have the global remsets that point to them anymore - if the
- * nursery collector moved the cemented objects, we'd have invalid
- * pointers in the major heap.
- *
- * What we do instead is to reset cementing at the start of concurrent
- * collections in such a way that nursery collections happening during
- * the major collection still pin the formerly cemented objects.  We
- * have a shadow cementing table for that purpose.  The nursery
- * collections still work with the old cementing table, while the
- * major collector builds up a new cementing table, adding global
- * remsets whenever needed like usual.  When the major collector
- * finishes, the old cementing table is replaced by the new one.
- */
-
-void
-sgen_cement_concurrent_start (void)
-{
-       SGEN_ASSERT (1, !cement_concurrent, "Concurrent cementing has already been started");
-       cement_concurrent = TRUE;
-
-       memset (cement_hash_concurrent, 0, sizeof (cement_hash));
-}
-
-void
-sgen_cement_concurrent_finish (void)
-{
-       SGEN_ASSERT (1, cement_concurrent, "Concurrent cementing hasn't been started");
-       cement_concurrent = FALSE;
-
-       memcpy (cement_hash, cement_hash_concurrent, sizeof (cement_hash));
-}
-
 gboolean
 sgen_cement_lookup (char *obj)
 {
-       int i = mono_aligned_addr_hash (obj) % SGEN_CEMENT_HASH_SIZE;
+       guint hv = mono_aligned_addr_hash (obj);
+       int i = SGEN_CEMENT_HASH (hv);
 
        SGEN_ASSERT (5, sgen_ptr_in_nursery (obj), "Looking up cementing for non-nursery objects makes no sense");
 
@@ -264,32 +220,15 @@ sgen_cement_lookup (char *obj)
 gboolean
 sgen_cement_lookup_or_register (char *obj)
 {
+       guint hv;
        int i;
-       CementHashEntry *hash;
-       gboolean concurrent_cementing = sgen_concurrent_collection_in_progress ();
+       CementHashEntry *hash = cement_hash;
 
        if (!cement_enabled)
                return FALSE;
 
-       if (concurrent_cementing)
-               SGEN_ASSERT (5, cement_concurrent, "Cementing wasn't inited with concurrent flag");
-
-       if (concurrent_cementing)
-               hash = cement_hash_concurrent;
-       else
-               hash = cement_hash;
-
-       /*
-        * We use modulus hashing, which is fine with constants as gcc
-        * can optimize them to multiplication, but with variable
-        * values it would be a bad idea given armv7 has no hardware
-        * for division, making it 20x slower than a multiplication.
-        *
-        * This code path can be quite hot, depending on the workload,
-        * so if we make the hash size user-adjustable we should
-        * figure out something not involving division.
-        */
-       i = mono_aligned_addr_hash (obj) % SGEN_CEMENT_HASH_SIZE;
+       hv = mono_aligned_addr_hash (obj);
+       i = SGEN_CEMENT_HASH (hv);
 
        SGEN_ASSERT (5, sgen_ptr_in_nursery (obj), "Can only cement pointers to nursery objects");
 
@@ -305,32 +244,47 @@ sgen_cement_lookup_or_register (char *obj)
 
        ++hash [i].count;
        if (hash [i].count == SGEN_CEMENT_THRESHOLD) {
+               SGEN_ASSERT (9, sgen_get_current_collection_generation () >= 0, "We can only cement objects when we're in a collection pause.");
+               SGEN_ASSERT (9, SGEN_OBJECT_IS_PINNED (obj), "Can only cement pinned objects");
+               SGEN_CEMENT_OBJECT (obj);
+
                if (G_UNLIKELY (MONO_GC_OBJ_CEMENTED_ENABLED())) {
                        MonoVTable *vt G_GNUC_UNUSED = (MonoVTable*)SGEN_LOAD_VTABLE (obj);
                        MONO_GC_OBJ_CEMENTED ((mword)obj, sgen_safe_object_get_size ((MonoObject*)obj),
                                        vt->klass->name_space, vt->klass->name);
                }
                binary_protocol_cement (obj, (gpointer)SGEN_LOAD_VTABLE (obj),
-                               sgen_safe_object_get_size ((MonoObject*)obj));
+                               (int)sgen_safe_object_get_size ((MonoObject*)obj));
        }
 
        return FALSE;
 }
 
-void
-sgen_cement_iterate (IterateObjectCallbackFunc callback, void *callback_data)
+static void
+pin_from_hash (CementHashEntry *hash, gboolean has_been_reset)
 {
        int i;
        for (i = 0; i < SGEN_CEMENT_HASH_SIZE; ++i) {
-               if (!cement_hash [i].count)
+               if (!hash [i].count)
                        continue;
 
-               SGEN_ASSERT (5, cement_hash [i].count >= SGEN_CEMENT_THRESHOLD, "Cementing hash inconsistent");
+               if (has_been_reset)
+                       SGEN_ASSERT (5, hash [i].count >= SGEN_CEMENT_THRESHOLD, "Cementing hash inconsistent");
 
-               callback (cement_hash [i].obj, 0, callback_data);
+               sgen_pin_stage_ptr (hash [i].obj);
+               binary_protocol_cement_stage (hash [i].obj);
+               /* FIXME: do pin stats if enabled */
+
+               SGEN_CEMENT_OBJECT (hash [i].obj);
        }
 }
 
+void
+sgen_pin_cemented_objects (void)
+{
+       pin_from_hash (cement_hash, TRUE);
+}
+
 void
 sgen_cement_clear_below_threshold (void)
 {