Merge pull request #2824 from lambdageek/dev/monoerror-icalls-noraise
[mono.git] / mono / sgen / sgen-gc.c
1 /*
2  * sgen-gc.c: Simple generational GC.
3  *
4  * Author:
5  *      Paolo Molaro (lupus@ximian.com)
6  *  Rodrigo Kumpera (kumpera@gmail.com)
7  *
8  * Copyright 2005-2011 Novell, Inc (http://www.novell.com)
9  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
10  *
11  * Thread start/stop adapted from Boehm's GC:
12  * Copyright (c) 1994 by Xerox Corporation.  All rights reserved.
13  * Copyright (c) 1996 by Silicon Graphics.  All rights reserved.
14  * Copyright (c) 1998 by Fergus Henderson.  All rights reserved.
15  * Copyright (c) 2000-2004 by Hewlett-Packard Company.  All rights reserved.
16  * Copyright 2001-2003 Ximian, Inc
17  * Copyright 2003-2010 Novell, Inc.
18  * Copyright 2011 Xamarin, Inc.
19  * Copyright (C) 2012 Xamarin Inc
20  *
21  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
22  *
23  * Important: allocation provides always zeroed memory, having to do
24  * a memset after allocation is deadly for performance.
25  * Memory usage at startup is currently as follows:
26  * 64 KB pinned space
27  * 64 KB internal space
28  * size of nursery
29  * We should provide a small memory config with half the sizes
30  *
31  * We currently try to make as few mono assumptions as possible:
32  * 1) 2-word header with no GC pointers in it (first vtable, second to store the
33  *    forwarding ptr)
34  * 2) gc descriptor is the second word in the vtable (first word in the class)
35  * 3) 8 byte alignment is the minimum and enough (not true for special structures (SIMD), FIXME)
36  * 4) there is a function to get an object's size and the number of
37  *    elements in an array.
38  * 5) we know the special way bounds are allocated for complex arrays
39  * 6) we know about proxies and how to treat them when domains are unloaded
40  *
41  * Always try to keep stack usage to a minimum: no recursive behaviour
42  * and no large stack allocs.
43  *
44  * General description.
45  * Objects are initially allocated in a nursery using a fast bump-pointer technique.
46  * When the nursery is full we start a nursery collection: this is performed with a
47  * copying GC.
48  * When the old generation is full we start a copying GC of the old generation as well:
49  * this will be changed to mark&sweep with copying when fragmentation becomes to severe
50  * in the future.  Maybe we'll even do both during the same collection like IMMIX.
51  *
52  * The things that complicate this description are:
53  * *) pinned objects: we can't move them so we need to keep track of them
54  * *) no precise info of the thread stacks and registers: we need to be able to
55  *    quickly find the objects that may be referenced conservatively and pin them
56  *    (this makes the first issues more important)
57  * *) large objects are too expensive to be dealt with using copying GC: we handle them
58  *    with mark/sweep during major collections
59  * *) some objects need to not move even if they are small (interned strings, Type handles):
60  *    we use mark/sweep for them, too: they are not allocated in the nursery, but inside
61  *    PinnedChunks regions
62  */
63
64 /*
65  * TODO:
66
67  *) we could have a function pointer in MonoClass to implement
68   customized write barriers for value types
69
70  *) investigate the stuff needed to advance a thread to a GC-safe
71   point (single-stepping, read from unmapped memory etc) and implement it.
72   This would enable us to inline allocations and write barriers, for example,
73   or at least parts of them, like the write barrier checks.
74   We may need this also for handling precise info on stacks, even simple things
75   as having uninitialized data on the stack and having to wait for the prolog
76   to zero it. Not an issue for the last frame that we scan conservatively.
77   We could always not trust the value in the slots anyway.
78
79  *) modify the jit to save info about references in stack locations:
80   this can be done just for locals as a start, so that at least
81   part of the stack is handled precisely.
82
83  *) test/fix endianess issues
84
85  *) Implement a card table as the write barrier instead of remembered
86     sets?  Card tables are not easy to implement with our current
87     memory layout.  We have several different kinds of major heap
88     objects: Small objects in regular blocks, small objects in pinned
89     chunks and LOS objects.  If we just have a pointer we have no way
90     to tell which kind of object it points into, therefore we cannot
91     know where its card table is.  The least we have to do to make
92     this happen is to get rid of write barriers for indirect stores.
93     (See next item)
94
95  *) Get rid of write barriers for indirect stores.  We can do this by
96     telling the GC to wbarrier-register an object once we do an ldloca
97     or ldelema on it, and to unregister it once it's not used anymore
98     (it can only travel downwards on the stack).  The problem with
99     unregistering is that it needs to happen eventually no matter
100     what, even if exceptions are thrown, the thread aborts, etc.
101     Rodrigo suggested that we could do only the registering part and
102     let the collector find out (pessimistically) when it's safe to
103     unregister, namely when the stack pointer of the thread that
104     registered the object is higher than it was when the registering
105     happened.  This might make for a good first implementation to get
106     some data on performance.
107
108  *) Some sort of blacklist support?  Blacklists is a concept from the
109     Boehm GC: if during a conservative scan we find pointers to an
110     area which we might use as heap, we mark that area as unusable, so
111     pointer retention by random pinning pointers is reduced.
112
113  *) experiment with max small object size (very small right now - 2kb,
114     because it's tied to the max freelist size)
115
116   *) add an option to mmap the whole heap in one chunk: it makes for many
117      simplifications in the checks (put the nursery at the top and just use a single
118      check for inclusion/exclusion): the issue this has is that on 32 bit systems it's
119      not flexible (too much of the address space may be used by default or we can't
120      increase the heap as needed) and we'd need a race-free mechanism to return memory
121      back to the system (mprotect(PROT_NONE) will still keep the memory allocated if it
122      was written to, munmap is needed, but the following mmap may not find the same segment
123      free...)
124
125  *) memzero the major fragments after restarting the world and optionally a smaller
126     chunk at a time
127
128  *) investigate having fragment zeroing threads
129
130  *) separate locks for finalization and other minor stuff to reduce
131     lock contention
132
133  *) try a different copying order to improve memory locality
134
135  *) a thread abort after a store but before the write barrier will
136     prevent the write barrier from executing
137
138  *) specialized dynamically generated markers/copiers
139
140  *) Dynamically adjust TLAB size to the number of threads.  If we have
141     too many threads that do allocation, we might need smaller TLABs,
142     and we might get better performance with larger TLABs if we only
143     have a handful of threads.  We could sum up the space left in all
144     assigned TLABs and if that's more than some percentage of the
145     nursery size, reduce the TLAB size.
146
147  *) Explore placing unreachable objects on unused nursery memory.
148         Instead of memset'ng a region to zero, place an int[] covering it.
149         A good place to start is add_nursery_frag. The tricky thing here is
150         placing those objects atomically outside of a collection.
151
152  *) Allocation should use asymmetric Dekker synchronization:
153         http://blogs.oracle.com/dave/resource/Asymmetric-Dekker-Synchronization.txt
154         This should help weak consistency archs.
155  */
156 #include "config.h"
157 #ifdef HAVE_SGEN_GC
158
159 #ifdef __MACH__
160 #undef _XOPEN_SOURCE
161 #define _XOPEN_SOURCE
162 #define _DARWIN_C_SOURCE
163 #endif
164
165 #ifdef HAVE_UNISTD_H
166 #include <unistd.h>
167 #endif
168 #ifdef HAVE_PTHREAD_H
169 #include <pthread.h>
170 #endif
171 #ifdef HAVE_PTHREAD_NP_H
172 #include <pthread_np.h>
173 #endif
174 #include <stdio.h>
175 #include <string.h>
176 #include <errno.h>
177 #include <assert.h>
178 #include <stdlib.h>
179
180 #include "mono/sgen/sgen-gc.h"
181 #include "mono/sgen/sgen-cardtable.h"
182 #include "mono/sgen/sgen-protocol.h"
183 #include "mono/sgen/sgen-memory-governor.h"
184 #include "mono/sgen/sgen-hash-table.h"
185 #include "mono/sgen/sgen-cardtable.h"
186 #include "mono/sgen/sgen-pinning.h"
187 #include "mono/sgen/sgen-workers.h"
188 #include "mono/sgen/sgen-client.h"
189 #include "mono/sgen/sgen-pointer-queue.h"
190 #include "mono/sgen/gc-internal-agnostic.h"
191 #include "mono/utils/mono-proclib.h"
192 #include "mono/utils/mono-memory-model.h"
193 #include "mono/utils/hazard-pointer.h"
194
195 #include <mono/utils/memcheck.h>
196
197 #undef pthread_create
198 #undef pthread_join
199 #undef pthread_detach
200
201 /*
202  * ######################################################################
203  * ########  Types and constants used by the GC.
204  * ######################################################################
205  */
206
207 /* 0 means not initialized, 1 is initialized, -1 means in progress */
208 static int gc_initialized = 0;
209 /* If set, check if we need to do something every X allocations */
210 gboolean has_per_allocation_action;
211 /* If set, do a heap check every X allocation */
212 guint32 verify_before_allocs = 0;
213 /* If set, do a minor collection before every X allocation */
214 guint32 collect_before_allocs = 0;
215 /* If set, do a whole heap check before each collection */
216 static gboolean whole_heap_check_before_collection = FALSE;
217 /* If set, do a heap consistency check before each minor collection */
218 static gboolean consistency_check_at_minor_collection = FALSE;
219 /* If set, do a mod union consistency check before each finishing collection pause */
220 static gboolean mod_union_consistency_check = FALSE;
221 /* If set, check whether mark bits are consistent after major collections */
222 static gboolean check_mark_bits_after_major_collection = FALSE;
223 /* If set, check that all nursery objects are pinned/not pinned, depending on context */
224 static gboolean check_nursery_objects_pinned = FALSE;
225 /* If set, do a few checks when the concurrent collector is used */
226 static gboolean do_concurrent_checks = FALSE;
227 /* If set, do a plausibility check on the scan_starts before and after
228    each collection */
229 static gboolean do_scan_starts_check = FALSE;
230
231 static gboolean disable_minor_collections = FALSE;
232 static gboolean disable_major_collections = FALSE;
233 static gboolean do_verify_nursery = FALSE;
234 static gboolean do_dump_nursery_content = FALSE;
235 static gboolean enable_nursery_canaries = FALSE;
236
237 static gboolean precleaning_enabled = TRUE;
238
239 #ifdef HEAVY_STATISTICS
240 guint64 stat_objects_alloced_degraded = 0;
241 guint64 stat_bytes_alloced_degraded = 0;
242
243 guint64 stat_copy_object_called_nursery = 0;
244 guint64 stat_objects_copied_nursery = 0;
245 guint64 stat_copy_object_called_major = 0;
246 guint64 stat_objects_copied_major = 0;
247
248 guint64 stat_scan_object_called_nursery = 0;
249 guint64 stat_scan_object_called_major = 0;
250
251 guint64 stat_slots_allocated_in_vain;
252
253 guint64 stat_nursery_copy_object_failed_from_space = 0;
254 guint64 stat_nursery_copy_object_failed_forwarded = 0;
255 guint64 stat_nursery_copy_object_failed_pinned = 0;
256 guint64 stat_nursery_copy_object_failed_to_space = 0;
257
258 static guint64 stat_wbarrier_add_to_global_remset = 0;
259 static guint64 stat_wbarrier_arrayref_copy = 0;
260 static guint64 stat_wbarrier_generic_store = 0;
261 static guint64 stat_wbarrier_generic_store_atomic = 0;
262 static guint64 stat_wbarrier_set_root = 0;
263 #endif
264
265 static guint64 stat_pinned_objects = 0;
266
267 static guint64 time_minor_pre_collection_fragment_clear = 0;
268 static guint64 time_minor_pinning = 0;
269 static guint64 time_minor_scan_remsets = 0;
270 static guint64 time_minor_scan_pinned = 0;
271 static guint64 time_minor_scan_roots = 0;
272 static guint64 time_minor_finish_gray_stack = 0;
273 static guint64 time_minor_fragment_creation = 0;
274
275 static guint64 time_major_pre_collection_fragment_clear = 0;
276 static guint64 time_major_pinning = 0;
277 static guint64 time_major_scan_pinned = 0;
278 static guint64 time_major_scan_roots = 0;
279 static guint64 time_major_scan_mod_union = 0;
280 static guint64 time_major_finish_gray_stack = 0;
281 static guint64 time_major_free_bigobjs = 0;
282 static guint64 time_major_los_sweep = 0;
283 static guint64 time_major_sweep = 0;
284 static guint64 time_major_fragment_creation = 0;
285
286 static guint64 time_max = 0;
287
288 static SGEN_TV_DECLARE (time_major_conc_collection_start);
289 static SGEN_TV_DECLARE (time_major_conc_collection_end);
290
291 static SGEN_TV_DECLARE (last_minor_collection_start_tv);
292 static SGEN_TV_DECLARE (last_minor_collection_end_tv);
293
294 int gc_debug_level = 0;
295 FILE* gc_debug_file;
296
297 /*
298 void
299 mono_gc_flush_info (void)
300 {
301         fflush (gc_debug_file);
302 }
303 */
304
305 #define TV_DECLARE SGEN_TV_DECLARE
306 #define TV_GETTIME SGEN_TV_GETTIME
307 #define TV_ELAPSED SGEN_TV_ELAPSED
308
309 static SGEN_TV_DECLARE (sgen_init_timestamp);
310
311 NurseryClearPolicy nursery_clear_policy = CLEAR_AT_TLAB_CREATION;
312
313 #define object_is_forwarded     SGEN_OBJECT_IS_FORWARDED
314 #define object_is_pinned        SGEN_OBJECT_IS_PINNED
315 #define pin_object              SGEN_PIN_OBJECT
316
317 #define ptr_in_nursery sgen_ptr_in_nursery
318
319 #define LOAD_VTABLE     SGEN_LOAD_VTABLE
320
321 gboolean
322 nursery_canaries_enabled (void)
323 {
324         return enable_nursery_canaries;
325 }
326
327 #define safe_object_get_size    sgen_safe_object_get_size
328
329 /*
330  * ######################################################################
331  * ########  Global data.
332  * ######################################################################
333  */
334 MonoCoopMutex gc_mutex;
335
336 #define SCAN_START_SIZE SGEN_SCAN_START_SIZE
337
338 size_t degraded_mode = 0;
339
340 static mword bytes_pinned_from_failed_allocation = 0;
341
342 GCMemSection *nursery_section = NULL;
343 static volatile mword lowest_heap_address = ~(mword)0;
344 static volatile mword highest_heap_address = 0;
345
346 MonoCoopMutex sgen_interruption_mutex;
347
348 int current_collection_generation = -1;
349 static volatile gboolean concurrent_collection_in_progress = FALSE;
350
351 /* objects that are ready to be finalized */
352 static SgenPointerQueue fin_ready_queue = SGEN_POINTER_QUEUE_INIT (INTERNAL_MEM_FINALIZE_READY);
353 static SgenPointerQueue critical_fin_queue = SGEN_POINTER_QUEUE_INIT (INTERNAL_MEM_FINALIZE_READY);
354
355 /* registered roots: the key to the hash is the root start address */
356 /* 
357  * Different kinds of roots are kept separate to speed up pin_from_roots () for example.
358  */
359 SgenHashTable roots_hash [ROOT_TYPE_NUM] = {
360         SGEN_HASH_TABLE_INIT (INTERNAL_MEM_ROOTS_TABLE, INTERNAL_MEM_ROOT_RECORD, sizeof (RootRecord), sgen_aligned_addr_hash, NULL),
361         SGEN_HASH_TABLE_INIT (INTERNAL_MEM_ROOTS_TABLE, INTERNAL_MEM_ROOT_RECORD, sizeof (RootRecord), sgen_aligned_addr_hash, NULL),
362         SGEN_HASH_TABLE_INIT (INTERNAL_MEM_ROOTS_TABLE, INTERNAL_MEM_ROOT_RECORD, sizeof (RootRecord), sgen_aligned_addr_hash, NULL)
363 };
364 static mword roots_size = 0; /* amount of memory in the root set */
365
366 /* The size of a TLAB */
367 /* The bigger the value, the less often we have to go to the slow path to allocate a new 
368  * one, but the more space is wasted by threads not allocating much memory.
369  * FIXME: Tune this.
370  * FIXME: Make this self-tuning for each thread.
371  */
372 guint32 tlab_size = (1024 * 4);
373
374 #define MAX_SMALL_OBJ_SIZE      SGEN_MAX_SMALL_OBJ_SIZE
375
376 #define ALLOC_ALIGN             SGEN_ALLOC_ALIGN
377
378 #define ALIGN_UP                SGEN_ALIGN_UP
379
380 #ifdef SGEN_DEBUG_INTERNAL_ALLOC
381 MonoNativeThreadId main_gc_thread = NULL;
382 #endif
383
384 /*Object was pinned during the current collection*/
385 static mword objects_pinned;
386
387 /*
388  * ######################################################################
389  * ########  Macros and function declarations.
390  * ######################################################################
391  */
392
393 typedef SgenGrayQueue GrayQueue;
394
395 /* forward declarations */
396 static void scan_from_registered_roots (char *addr_start, char *addr_end, int root_type, ScanCopyContext ctx);
397
398 static void pin_from_roots (void *start_nursery, void *end_nursery, ScanCopyContext ctx);
399 static void finish_gray_stack (int generation, ScanCopyContext ctx);
400
401
402 SgenMajorCollector major_collector;
403 SgenMinorCollector sgen_minor_collector;
404 /* FIXME: get rid of this */
405 static GrayQueue gray_queue;
406
407 static SgenRememberedSet remset;
408
409 /* The gray queue to use from the main collection thread. */
410 #define WORKERS_DISTRIBUTE_GRAY_QUEUE   (&gray_queue)
411
412 /*
413  * The gray queue a worker job must use.  If we're not parallel or
414  * concurrent, we use the main gray queue.
415  */
416 static SgenGrayQueue*
417 sgen_workers_get_job_gray_queue (WorkerData *worker_data)
418 {
419         return worker_data ? &worker_data->private_gray_queue : WORKERS_DISTRIBUTE_GRAY_QUEUE;
420 }
421
422 static void
423 gray_queue_redirect (SgenGrayQueue *queue)
424 {
425         gboolean wake = FALSE;
426
427         for (;;) {
428                 GrayQueueSection *section = sgen_gray_object_dequeue_section (queue);
429                 if (!section)
430                         break;
431                 sgen_section_gray_queue_enqueue ((SgenSectionGrayQueue *)queue->alloc_prepare_data, section);
432                 wake = TRUE;
433         }
434
435         if (wake) {
436                 g_assert (concurrent_collection_in_progress);
437                 sgen_workers_ensure_awake ();
438         }
439 }
440
441 static void
442 gray_queue_enable_redirect (SgenGrayQueue *queue)
443 {
444         if (!concurrent_collection_in_progress)
445                 return;
446
447         sgen_gray_queue_set_alloc_prepare (queue, gray_queue_redirect, sgen_workers_get_distribute_section_gray_queue ());
448         gray_queue_redirect (queue);
449 }
450
451 void
452 sgen_scan_area_with_callback (char *start, char *end, IterateObjectCallbackFunc callback, void *data, gboolean allow_flags, gboolean fail_on_canaries)
453 {
454         while (start < end) {
455                 size_t size;
456                 char *obj;
457
458                 if (!*(void**)start) {
459                         start += sizeof (void*); /* should be ALLOC_ALIGN, really */
460                         continue;
461                 }
462
463                 if (allow_flags) {
464                         if (!(obj = (char *)SGEN_OBJECT_IS_FORWARDED (start)))
465                                 obj = start;
466                 } else {
467                         obj = start;
468                 }
469
470                 if (!sgen_client_object_is_array_fill ((GCObject*)obj)) {
471                         CHECK_CANARY_FOR_OBJECT ((GCObject*)obj, fail_on_canaries);
472                         size = ALIGN_UP (safe_object_get_size ((GCObject*)obj));
473                         callback ((GCObject*)obj, size, data);
474                         CANARIFY_SIZE (size);
475                 } else {
476                         size = ALIGN_UP (safe_object_get_size ((GCObject*)obj));
477                 }
478
479                 start += size;
480         }
481 }
482
483 /*
484  * sgen_add_to_global_remset:
485  *
486  *   The global remset contains locations which point into newspace after
487  * a minor collection. This can happen if the objects they point to are pinned.
488  *
489  * LOCKING: If called from a parallel collector, the global remset
490  * lock must be held.  For serial collectors that is not necessary.
491  */
492 void
493 sgen_add_to_global_remset (gpointer ptr, GCObject *obj)
494 {
495         SGEN_ASSERT (5, sgen_ptr_in_nursery (obj), "Target pointer of global remset must be in the nursery");
496
497         HEAVY_STAT (++stat_wbarrier_add_to_global_remset);
498
499         if (!major_collector.is_concurrent) {
500                 SGEN_ASSERT (5, current_collection_generation != -1, "Global remsets can only be added during collections");
501         } else {
502                 if (current_collection_generation == -1)
503                         SGEN_ASSERT (5, sgen_concurrent_collection_in_progress (), "Global remsets outside of collection pauses can only be added by the concurrent collector");
504         }
505
506         if (!object_is_pinned (obj))
507                 SGEN_ASSERT (5, sgen_minor_collector.is_split || sgen_concurrent_collection_in_progress (), "Non-pinned objects can only remain in nursery if it is a split nursery");
508         else if (sgen_cement_lookup_or_register (obj))
509                 return;
510
511         remset.record_pointer (ptr);
512
513         sgen_pin_stats_register_global_remset (obj);
514
515         SGEN_LOG (8, "Adding global remset for %p", ptr);
516         binary_protocol_global_remset (ptr, obj, (gpointer)SGEN_LOAD_VTABLE (obj));
517 }
518
519 /*
520  * sgen_drain_gray_stack:
521  *
522  *   Scan objects in the gray stack until the stack is empty. This should be called
523  * frequently after each object is copied, to achieve better locality and cache
524  * usage.
525  *
526  */
527 gboolean
528 sgen_drain_gray_stack (ScanCopyContext ctx)
529 {
530         ScanObjectFunc scan_func = ctx.ops->scan_object;
531         GrayQueue *queue = ctx.queue;
532
533         if (ctx.ops->drain_gray_stack)
534                 return ctx.ops->drain_gray_stack (queue);
535
536         for (;;) {
537                 GCObject *obj;
538                 SgenDescriptor desc;
539                 GRAY_OBJECT_DEQUEUE (queue, &obj, &desc);
540                 if (!obj)
541                         return TRUE;
542                 SGEN_LOG (9, "Precise gray object scan %p (%s)", obj, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj)));
543                 scan_func (obj, desc, queue);
544         }
545         return FALSE;
546 }
547
548 /*
549  * Addresses in the pin queue are already sorted. This function finds
550  * the object header for each address and pins the object. The
551  * addresses must be inside the nursery section.  The (start of the)
552  * address array is overwritten with the addresses of the actually
553  * pinned objects.  Return the number of pinned objects.
554  */
555 static int
556 pin_objects_from_nursery_pin_queue (gboolean do_scan_objects, ScanCopyContext ctx)
557 {
558         GCMemSection *section = nursery_section;
559         void **start =  sgen_pinning_get_entry (section->pin_queue_first_entry);
560         void **end = sgen_pinning_get_entry (section->pin_queue_last_entry);
561         void *start_nursery = section->data;
562         void *end_nursery = section->next_data;
563         void *last = NULL;
564         int count = 0;
565         void *search_start;
566         void *addr;
567         void *pinning_front = start_nursery;
568         size_t idx;
569         void **definitely_pinned = start;
570         ScanObjectFunc scan_func = ctx.ops->scan_object;
571         SgenGrayQueue *queue = ctx.queue;
572
573         sgen_nursery_allocator_prepare_for_pinning ();
574
575         while (start < end) {
576                 GCObject *obj_to_pin = NULL;
577                 size_t obj_to_pin_size = 0;
578                 SgenDescriptor desc;
579
580                 addr = *start;
581
582                 SGEN_ASSERT (0, addr >= start_nursery && addr < end_nursery, "Potential pinning address out of range");
583                 SGEN_ASSERT (0, addr >= last, "Pin queue not sorted");
584
585                 if (addr == last) {
586                         ++start;
587                         continue;
588                 }
589
590                 SGEN_LOG (5, "Considering pinning addr %p", addr);
591                 /* We've already processed everything up to pinning_front. */
592                 if (addr < pinning_front) {
593                         start++;
594                         continue;
595                 }
596
597                 /*
598                  * Find the closest scan start <= addr.  We might search backward in the
599                  * scan_starts array because entries might be NULL.  In the worst case we
600                  * start at start_nursery.
601                  */
602                 idx = ((char*)addr - (char*)section->data) / SCAN_START_SIZE;
603                 SGEN_ASSERT (0, idx < section->num_scan_start, "Scan start index out of range");
604                 search_start = (void*)section->scan_starts [idx];
605                 if (!search_start || search_start > addr) {
606                         while (idx) {
607                                 --idx;
608                                 search_start = section->scan_starts [idx];
609                                 if (search_start && search_start <= addr)
610                                         break;
611                         }
612                         if (!search_start || search_start > addr)
613                                 search_start = start_nursery;
614                 }
615
616                 /*
617                  * If the pinning front is closer than the scan start we found, start
618                  * searching at the front.
619                  */
620                 if (search_start < pinning_front)
621                         search_start = pinning_front;
622
623                 /*
624                  * Now addr should be in an object a short distance from search_start.
625                  *
626                  * search_start must point to zeroed mem or point to an object.
627                  */
628                 do {
629                         size_t obj_size, canarified_obj_size;
630
631                         /* Skip zeros. */
632                         if (!*(void**)search_start) {
633                                 search_start = (void*)ALIGN_UP ((mword)search_start + sizeof (gpointer));
634                                 /* The loop condition makes sure we don't overrun addr. */
635                                 continue;
636                         }
637
638                         canarified_obj_size = obj_size = ALIGN_UP (safe_object_get_size ((GCObject*)search_start));
639
640                         /*
641                          * Filler arrays are marked by an invalid sync word.  We don't
642                          * consider them for pinning.  They are not delimited by canaries,
643                          * either.
644                          */
645                         if (!sgen_client_object_is_array_fill ((GCObject*)search_start)) {
646                                 CHECK_CANARY_FOR_OBJECT (search_start, TRUE);
647                                 CANARIFY_SIZE (canarified_obj_size);
648
649                                 if (addr >= search_start && (char*)addr < (char*)search_start + obj_size) {
650                                         /* This is the object we're looking for. */
651                                         obj_to_pin = (GCObject*)search_start;
652                                         obj_to_pin_size = canarified_obj_size;
653                                         break;
654                                 }
655                         }
656
657                         /* Skip to the next object */
658                         search_start = (void*)((char*)search_start + canarified_obj_size);
659                 } while (search_start <= addr);
660
661                 /* We've searched past the address we were looking for. */
662                 if (!obj_to_pin) {
663                         pinning_front = search_start;
664                         goto next_pin_queue_entry;
665                 }
666
667                 /*
668                  * We've found an object to pin.  It might still be a dummy array, but we
669                  * can advance the pinning front in any case.
670                  */
671                 pinning_front = (char*)obj_to_pin + obj_to_pin_size;
672
673                 /*
674                  * If this is a dummy array marking the beginning of a nursery
675                  * fragment, we don't pin it.
676                  */
677                 if (sgen_client_object_is_array_fill (obj_to_pin))
678                         goto next_pin_queue_entry;
679
680                 /*
681                  * Finally - pin the object!
682                  */
683                 desc = sgen_obj_get_descriptor_safe (obj_to_pin);
684                 if (do_scan_objects) {
685                         scan_func (obj_to_pin, desc, queue);
686                 } else {
687                         SGEN_LOG (4, "Pinned object %p, vtable %p (%s), count %d\n",
688                                         obj_to_pin, *(void**)obj_to_pin, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj_to_pin)), count);
689                         binary_protocol_pin (obj_to_pin,
690                                         (gpointer)LOAD_VTABLE (obj_to_pin),
691                                         safe_object_get_size (obj_to_pin));
692
693                         pin_object (obj_to_pin);
694                         GRAY_OBJECT_ENQUEUE (queue, obj_to_pin, desc);
695                         sgen_pin_stats_register_object (obj_to_pin, obj_to_pin_size);
696                         definitely_pinned [count] = obj_to_pin;
697                         count++;
698                 }
699
700         next_pin_queue_entry:
701                 last = addr;
702                 ++start;
703         }
704         sgen_client_nursery_objects_pinned (definitely_pinned, count);
705         stat_pinned_objects += count;
706         return count;
707 }
708
709 static void
710 pin_objects_in_nursery (gboolean do_scan_objects, ScanCopyContext ctx)
711 {
712         size_t reduced_to;
713
714         if (nursery_section->pin_queue_first_entry == nursery_section->pin_queue_last_entry)
715                 return;
716
717         reduced_to = pin_objects_from_nursery_pin_queue (do_scan_objects, ctx);
718         nursery_section->pin_queue_last_entry = nursery_section->pin_queue_first_entry + reduced_to;
719 }
720
721 /*
722  * This function is only ever called (via `collector_pin_object()` in `sgen-copy-object.h`)
723  * when we can't promote an object because we're out of memory.
724  */
725 void
726 sgen_pin_object (GCObject *object, GrayQueue *queue)
727 {
728         /*
729          * All pinned objects are assumed to have been staged, so we need to stage as well.
730          * Also, the count of staged objects shows that "late pinning" happened.
731          */
732         sgen_pin_stage_ptr (object);
733
734         SGEN_PIN_OBJECT (object);
735         binary_protocol_pin (object, (gpointer)LOAD_VTABLE (object), safe_object_get_size (object));
736
737         ++objects_pinned;
738         sgen_pin_stats_register_object (object, safe_object_get_size (object));
739
740         GRAY_OBJECT_ENQUEUE (queue, object, sgen_obj_get_descriptor_safe (object));
741 }
742
743 /* Sort the addresses in array in increasing order.
744  * Done using a by-the book heap sort. Which has decent and stable performance, is pretty cache efficient.
745  */
746 void
747 sgen_sort_addresses (void **array, size_t size)
748 {
749         size_t i;
750         void *tmp;
751
752         for (i = 1; i < size; ++i) {
753                 size_t child = i;
754                 while (child > 0) {
755                         size_t parent = (child - 1) / 2;
756
757                         if (array [parent] >= array [child])
758                                 break;
759
760                         tmp = array [parent];
761                         array [parent] = array [child];
762                         array [child] = tmp;
763
764                         child = parent;
765                 }
766         }
767
768         for (i = size - 1; i > 0; --i) {
769                 size_t end, root;
770                 tmp = array [i];
771                 array [i] = array [0];
772                 array [0] = tmp;
773
774                 end = i - 1;
775                 root = 0;
776
777                 while (root * 2 + 1 <= end) {
778                         size_t child = root * 2 + 1;
779
780                         if (child < end && array [child] < array [child + 1])
781                                 ++child;
782                         if (array [root] >= array [child])
783                                 break;
784
785                         tmp = array [root];
786                         array [root] = array [child];
787                         array [child] = tmp;
788
789                         root = child;
790                 }
791         }
792 }
793
794 /* 
795  * Scan the memory between start and end and queue values which could be pointers
796  * to the area between start_nursery and end_nursery for later consideration.
797  * Typically used for thread stacks.
798  */
799 void
800 sgen_conservatively_pin_objects_from (void **start, void **end, void *start_nursery, void *end_nursery, int pin_type)
801 {
802         int count = 0;
803
804         SGEN_ASSERT (0, ((mword)start & (SIZEOF_VOID_P - 1)) == 0, "Why are we scanning for references in unaligned memory ?");
805
806 #if defined(VALGRIND_MAKE_MEM_DEFINED_IF_ADDRESSABLE) && !defined(_WIN64)
807         VALGRIND_MAKE_MEM_DEFINED_IF_ADDRESSABLE (start, (char*)end - (char*)start);
808 #endif
809
810         while (start < end) {
811                 /*
812                  * *start can point to the middle of an object
813                  * note: should we handle pointing at the end of an object?
814                  * pinning in C# code disallows pointing at the end of an object
815                  * but there is some small chance that an optimizing C compiler
816                  * may keep the only reference to an object by pointing
817                  * at the end of it. We ignore this small chance for now.
818                  * Pointers to the end of an object are indistinguishable
819                  * from pointers to the start of the next object in memory
820                  * so if we allow that we'd need to pin two objects...
821                  * We queue the pointer in an array, the
822                  * array will then be sorted and uniqued. This way
823                  * we can coalesce several pinning pointers and it should
824                  * be faster since we'd do a memory scan with increasing
825                  * addresses. Note: we can align the address to the allocation
826                  * alignment, so the unique process is more effective.
827                  */
828                 mword addr = (mword)*start;
829                 addr &= ~(ALLOC_ALIGN - 1);
830                 if (addr >= (mword)start_nursery && addr < (mword)end_nursery) {
831                         SGEN_LOG (6, "Pinning address %p from %p", (void*)addr, start);
832                         sgen_pin_stage_ptr ((void*)addr);
833                         binary_protocol_pin_stage (start, (void*)addr);
834                         sgen_pin_stats_register_address ((char*)addr, pin_type);
835                         count++;
836                 }
837                 start++;
838         }
839         if (count)
840                 SGEN_LOG (7, "found %d potential pinned heap pointers", count);
841 }
842
843 /*
844  * The first thing we do in a collection is to identify pinned objects.
845  * This function considers all the areas of memory that need to be
846  * conservatively scanned.
847  */
848 static void
849 pin_from_roots (void *start_nursery, void *end_nursery, ScanCopyContext ctx)
850 {
851         void **start_root;
852         RootRecord *root;
853         SGEN_LOG (2, "Scanning pinned roots (%d bytes, %d/%d entries)", (int)roots_size, roots_hash [ROOT_TYPE_NORMAL].num_entries, roots_hash [ROOT_TYPE_PINNED].num_entries);
854         /* objects pinned from the API are inside these roots */
855         SGEN_HASH_TABLE_FOREACH (&roots_hash [ROOT_TYPE_PINNED], void **, start_root, RootRecord *, root) {
856                 SGEN_LOG (6, "Pinned roots %p-%p", start_root, root->end_root);
857                 sgen_conservatively_pin_objects_from (start_root, (void**)root->end_root, start_nursery, end_nursery, PIN_TYPE_OTHER);
858         } SGEN_HASH_TABLE_FOREACH_END;
859         /* now deal with the thread stacks
860          * in the future we should be able to conservatively scan only:
861          * *) the cpu registers
862          * *) the unmanaged stack frames
863          * *) the _last_ managed stack frame
864          * *) pointers slots in managed frames
865          */
866         sgen_client_scan_thread_data (start_nursery, end_nursery, FALSE, ctx);
867 }
868
869 static void
870 single_arg_user_copy_or_mark (GCObject **obj, void *gc_data)
871 {
872         ScanCopyContext *ctx = (ScanCopyContext *)gc_data;
873         ctx->ops->copy_or_mark_object (obj, ctx->queue);
874 }
875
876 /*
877  * The memory area from start_root to end_root contains pointers to objects.
878  * Their position is precisely described by @desc (this means that the pointer
879  * can be either NULL or the pointer to the start of an object).
880  * This functions copies them to to_space updates them.
881  *
882  * This function is not thread-safe!
883  */
884 static void
885 precisely_scan_objects_from (void** start_root, void** end_root, char* n_start, char *n_end, SgenDescriptor desc, ScanCopyContext ctx)
886 {
887         CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
888         SgenGrayQueue *queue = ctx.queue;
889
890         switch (desc & ROOT_DESC_TYPE_MASK) {
891         case ROOT_DESC_BITMAP:
892                 desc >>= ROOT_DESC_TYPE_SHIFT;
893                 while (desc) {
894                         if ((desc & 1) && *start_root) {
895                                 copy_func ((GCObject**)start_root, queue);
896                                 SGEN_LOG (9, "Overwrote root at %p with %p", start_root, *start_root);
897                         }
898                         desc >>= 1;
899                         start_root++;
900                 }
901                 return;
902         case ROOT_DESC_COMPLEX: {
903                 gsize *bitmap_data = (gsize *)sgen_get_complex_descriptor_bitmap (desc);
904                 gsize bwords = (*bitmap_data) - 1;
905                 void **start_run = start_root;
906                 bitmap_data++;
907                 while (bwords-- > 0) {
908                         gsize bmap = *bitmap_data++;
909                         void **objptr = start_run;
910                         while (bmap) {
911                                 if ((bmap & 1) && *objptr) {
912                                         copy_func ((GCObject**)objptr, queue);
913                                         SGEN_LOG (9, "Overwrote root at %p with %p", objptr, *objptr);
914                                 }
915                                 bmap >>= 1;
916                                 ++objptr;
917                         }
918                         start_run += GC_BITS_PER_WORD;
919                 }
920                 break;
921         }
922         case ROOT_DESC_USER: {
923                 SgenUserRootMarkFunc marker = sgen_get_user_descriptor_func (desc);
924                 marker (start_root, single_arg_user_copy_or_mark, &ctx);
925                 break;
926         }
927         case ROOT_DESC_RUN_LEN:
928                 g_assert_not_reached ();
929         default:
930                 g_assert_not_reached ();
931         }
932 }
933
934 static void
935 reset_heap_boundaries (void)
936 {
937         lowest_heap_address = ~(mword)0;
938         highest_heap_address = 0;
939 }
940
941 void
942 sgen_update_heap_boundaries (mword low, mword high)
943 {
944         mword old;
945
946         do {
947                 old = lowest_heap_address;
948                 if (low >= old)
949                         break;
950         } while (SGEN_CAS_PTR ((gpointer*)&lowest_heap_address, (gpointer)low, (gpointer)old) != (gpointer)old);
951
952         do {
953                 old = highest_heap_address;
954                 if (high <= old)
955                         break;
956         } while (SGEN_CAS_PTR ((gpointer*)&highest_heap_address, (gpointer)high, (gpointer)old) != (gpointer)old);
957 }
958
959 /*
960  * Allocate and setup the data structures needed to be able to allocate objects
961  * in the nursery. The nursery is stored in nursery_section.
962  */
963 static void
964 alloc_nursery (void)
965 {
966         GCMemSection *section;
967         char *data;
968         size_t scan_starts;
969         size_t alloc_size;
970
971         if (nursery_section)
972                 return;
973         SGEN_LOG (2, "Allocating nursery size: %zu", (size_t)sgen_nursery_size);
974         /* later we will alloc a larger area for the nursery but only activate
975          * what we need. The rest will be used as expansion if we have too many pinned
976          * objects in the existing nursery.
977          */
978         /* FIXME: handle OOM */
979         section = (GCMemSection *)sgen_alloc_internal (INTERNAL_MEM_SECTION);
980
981         alloc_size = sgen_nursery_size;
982
983         /* If there isn't enough space even for the nursery we should simply abort. */
984         g_assert (sgen_memgov_try_alloc_space (alloc_size, SPACE_NURSERY));
985
986         data = (char *)major_collector.alloc_heap (alloc_size, alloc_size, DEFAULT_NURSERY_BITS);
987         sgen_update_heap_boundaries ((mword)data, (mword)(data + sgen_nursery_size));
988         SGEN_LOG (4, "Expanding nursery size (%p-%p): %lu, total: %lu", data, data + alloc_size, (unsigned long)sgen_nursery_size, (unsigned long)sgen_gc_get_total_heap_allocation ());
989         section->data = section->next_data = data;
990         section->size = alloc_size;
991         section->end_data = data + sgen_nursery_size;
992         scan_starts = (alloc_size + SCAN_START_SIZE - 1) / SCAN_START_SIZE;
993         section->scan_starts = (char **)sgen_alloc_internal_dynamic (sizeof (char*) * scan_starts, INTERNAL_MEM_SCAN_STARTS, TRUE);
994         section->num_scan_start = scan_starts;
995
996         nursery_section = section;
997
998         sgen_nursery_allocator_set_nursery_bounds (data, data + sgen_nursery_size);
999 }
1000
1001 FILE *
1002 mono_gc_get_logfile (void)
1003 {
1004         return gc_debug_file;
1005 }
1006
1007 static void
1008 scan_finalizer_entries (SgenPointerQueue *fin_queue, ScanCopyContext ctx)
1009 {
1010         CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
1011         SgenGrayQueue *queue = ctx.queue;
1012         size_t i;
1013
1014         for (i = 0; i < fin_queue->next_slot; ++i) {
1015                 GCObject *obj = (GCObject *)fin_queue->data [i];
1016                 if (!obj)
1017                         continue;
1018                 SGEN_LOG (5, "Scan of fin ready object: %p (%s)\n", obj, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj)));
1019                 copy_func ((GCObject**)&fin_queue->data [i], queue);
1020         }
1021 }
1022
1023 static const char*
1024 generation_name (int generation)
1025 {
1026         switch (generation) {
1027         case GENERATION_NURSERY: return "nursery";
1028         case GENERATION_OLD: return "old";
1029         default: g_assert_not_reached ();
1030         }
1031 }
1032
1033 const char*
1034 sgen_generation_name (int generation)
1035 {
1036         return generation_name (generation);
1037 }
1038
1039 static void
1040 finish_gray_stack (int generation, ScanCopyContext ctx)
1041 {
1042         TV_DECLARE (atv);
1043         TV_DECLARE (btv);
1044         int done_with_ephemerons, ephemeron_rounds = 0;
1045         char *start_addr = generation == GENERATION_NURSERY ? sgen_get_nursery_start () : NULL;
1046         char *end_addr = generation == GENERATION_NURSERY ? sgen_get_nursery_end () : (char*)-1;
1047         SgenGrayQueue *queue = ctx.queue;
1048
1049         binary_protocol_finish_gray_stack_start (sgen_timestamp (), generation);
1050         /*
1051          * We copied all the reachable objects. Now it's the time to copy
1052          * the objects that were not referenced by the roots, but by the copied objects.
1053          * we built a stack of objects pointed to by gray_start: they are
1054          * additional roots and we may add more items as we go.
1055          * We loop until gray_start == gray_objects which means no more objects have
1056          * been added. Note this is iterative: no recursion is involved.
1057          * We need to walk the LO list as well in search of marked big objects
1058          * (use a flag since this is needed only on major collections). We need to loop
1059          * here as well, so keep a counter of marked LO (increasing it in copy_object).
1060          *   To achieve better cache locality and cache usage, we drain the gray stack 
1061          * frequently, after each object is copied, and just finish the work here.
1062          */
1063         sgen_drain_gray_stack (ctx);
1064         TV_GETTIME (atv);
1065         SGEN_LOG (2, "%s generation done", generation_name (generation));
1066
1067         /*
1068         Reset bridge data, we might have lingering data from a previous collection if this is a major
1069         collection trigged by minor overflow.
1070
1071         We must reset the gathered bridges since their original block might be evacuated due to major
1072         fragmentation in the meanwhile and the bridge code should not have to deal with that.
1073         */
1074         if (sgen_client_bridge_need_processing ())
1075                 sgen_client_bridge_reset_data ();
1076
1077         /*
1078          * Mark all strong toggleref objects. This must be done before we walk ephemerons or finalizers
1079          * to ensure they see the full set of live objects.
1080          */
1081         sgen_client_mark_togglerefs (start_addr, end_addr, ctx);
1082
1083         /*
1084          * Walk the ephemeron tables marking all values with reachable keys. This must be completely done
1085          * before processing finalizable objects and non-tracking weak links to avoid finalizing/clearing
1086          * objects that are in fact reachable.
1087          */
1088         done_with_ephemerons = 0;
1089         do {
1090                 done_with_ephemerons = sgen_client_mark_ephemerons (ctx);
1091                 sgen_drain_gray_stack (ctx);
1092                 ++ephemeron_rounds;
1093         } while (!done_with_ephemerons);
1094
1095         if (sgen_client_bridge_need_processing ()) {
1096                 /*Make sure the gray stack is empty before we process bridge objects so we get liveness right*/
1097                 sgen_drain_gray_stack (ctx);
1098                 sgen_collect_bridge_objects (generation, ctx);
1099                 if (generation == GENERATION_OLD)
1100                         sgen_collect_bridge_objects (GENERATION_NURSERY, ctx);
1101
1102                 /*
1103                 Do the first bridge step here, as the collector liveness state will become useless after that.
1104
1105                 An important optimization is to only proccess the possibly dead part of the object graph and skip
1106                 over all live objects as we transitively know everything they point must be alive too.
1107
1108                 The above invariant is completely wrong if we let the gray queue be drained and mark/copy everything.
1109
1110                 This has the unfortunate side effect of making overflow collections perform the first step twice, but
1111                 given we now have heuristics that perform major GC in anticipation of minor overflows this should not
1112                 be a big deal.
1113                 */
1114                 sgen_client_bridge_processing_stw_step ();
1115         }
1116
1117         /*
1118         Make sure we drain the gray stack before processing disappearing links and finalizers.
1119         If we don't make sure it is empty we might wrongly see a live object as dead.
1120         */
1121         sgen_drain_gray_stack (ctx);
1122
1123         /*
1124         We must clear weak links that don't track resurrection before processing object ready for
1125         finalization so they can be cleared before that.
1126         */
1127         sgen_null_link_in_range (generation, ctx, FALSE);
1128         if (generation == GENERATION_OLD)
1129                 sgen_null_link_in_range (GENERATION_NURSERY, ctx, FALSE);
1130
1131
1132         /* walk the finalization queue and move also the objects that need to be
1133          * finalized: use the finalized objects as new roots so the objects they depend
1134          * on are also not reclaimed. As with the roots above, only objects in the nursery
1135          * are marked/copied.
1136          */
1137         sgen_finalize_in_range (generation, ctx);
1138         if (generation == GENERATION_OLD)
1139                 sgen_finalize_in_range (GENERATION_NURSERY, ctx);
1140         /* drain the new stack that might have been created */
1141         SGEN_LOG (6, "Precise scan of gray area post fin");
1142         sgen_drain_gray_stack (ctx);
1143
1144         /*
1145          * This must be done again after processing finalizable objects since CWL slots are cleared only after the key is finalized.
1146          */
1147         done_with_ephemerons = 0;
1148         do {
1149                 done_with_ephemerons = sgen_client_mark_ephemerons (ctx);
1150                 sgen_drain_gray_stack (ctx);
1151                 ++ephemeron_rounds;
1152         } while (!done_with_ephemerons);
1153
1154         sgen_client_clear_unreachable_ephemerons (ctx);
1155
1156         /*
1157          * We clear togglerefs only after all possible chances of revival are done. 
1158          * This is semantically more inline with what users expect and it allows for
1159          * user finalizers to correctly interact with TR objects.
1160         */
1161         sgen_client_clear_togglerefs (start_addr, end_addr, ctx);
1162
1163         TV_GETTIME (btv);
1164         SGEN_LOG (2, "Finalize queue handling scan for %s generation: %lld usecs %d ephemeron rounds", generation_name (generation), TV_ELAPSED (atv, btv), ephemeron_rounds);
1165
1166         /*
1167          * handle disappearing links
1168          * Note we do this after checking the finalization queue because if an object
1169          * survives (at least long enough to be finalized) we don't clear the link.
1170          * This also deals with a possible issue with the monitor reclamation: with the Boehm
1171          * GC a finalized object my lose the monitor because it is cleared before the finalizer is
1172          * called.
1173          */
1174         g_assert (sgen_gray_object_queue_is_empty (queue));
1175         for (;;) {
1176                 sgen_null_link_in_range (generation, ctx, TRUE);
1177                 if (generation == GENERATION_OLD)
1178                         sgen_null_link_in_range (GENERATION_NURSERY, ctx, TRUE);
1179                 if (sgen_gray_object_queue_is_empty (queue))
1180                         break;
1181                 sgen_drain_gray_stack (ctx);
1182         }
1183
1184         g_assert (sgen_gray_object_queue_is_empty (queue));
1185
1186         sgen_gray_object_queue_trim_free_list (queue);
1187         binary_protocol_finish_gray_stack_end (sgen_timestamp (), generation);
1188 }
1189
1190 void
1191 sgen_check_section_scan_starts (GCMemSection *section)
1192 {
1193         size_t i;
1194         for (i = 0; i < section->num_scan_start; ++i) {
1195                 if (section->scan_starts [i]) {
1196                         mword size = safe_object_get_size ((GCObject*) section->scan_starts [i]);
1197                         SGEN_ASSERT (0, size >= SGEN_CLIENT_MINIMUM_OBJECT_SIZE && size <= MAX_SMALL_OBJ_SIZE, "Weird object size at scan starts.");
1198                 }
1199         }
1200 }
1201
1202 static void
1203 check_scan_starts (void)
1204 {
1205         if (!do_scan_starts_check)
1206                 return;
1207         sgen_check_section_scan_starts (nursery_section);
1208         major_collector.check_scan_starts ();
1209 }
1210
1211 static void
1212 scan_from_registered_roots (char *addr_start, char *addr_end, int root_type, ScanCopyContext ctx)
1213 {
1214         void **start_root;
1215         RootRecord *root;
1216         SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], void **, start_root, RootRecord *, root) {
1217                 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
1218                 precisely_scan_objects_from (start_root, (void**)root->end_root, addr_start, addr_end, root->root_desc, ctx);
1219         } SGEN_HASH_TABLE_FOREACH_END;
1220 }
1221
1222 static void
1223 init_stats (void)
1224 {
1225         static gboolean inited = FALSE;
1226
1227         if (inited)
1228                 return;
1229
1230         mono_counters_register ("Collection max time",  MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME | MONO_COUNTER_MONOTONIC, &time_max);
1231
1232         mono_counters_register ("Minor fragment clear", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_pre_collection_fragment_clear);
1233         mono_counters_register ("Minor pinning", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_pinning);
1234         mono_counters_register ("Minor scan remembered set", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_remsets);
1235         mono_counters_register ("Minor scan pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_pinned);
1236         mono_counters_register ("Minor scan roots", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_roots);
1237         mono_counters_register ("Minor fragment creation", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_fragment_creation);
1238
1239         mono_counters_register ("Major fragment clear", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_pre_collection_fragment_clear);
1240         mono_counters_register ("Major pinning", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_pinning);
1241         mono_counters_register ("Major scan pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_pinned);
1242         mono_counters_register ("Major scan roots", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_roots);
1243         mono_counters_register ("Major scan mod union", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_mod_union);
1244         mono_counters_register ("Major finish gray stack", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_finish_gray_stack);
1245         mono_counters_register ("Major free big objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_free_bigobjs);
1246         mono_counters_register ("Major LOS sweep", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_los_sweep);
1247         mono_counters_register ("Major sweep", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_sweep);
1248         mono_counters_register ("Major fragment creation", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_fragment_creation);
1249
1250         mono_counters_register ("Number of pinned objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_pinned_objects);
1251
1252 #ifdef HEAVY_STATISTICS
1253         mono_counters_register ("WBarrier remember pointer", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_add_to_global_remset);
1254         mono_counters_register ("WBarrier arrayref copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_arrayref_copy);
1255         mono_counters_register ("WBarrier generic store called", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_generic_store);
1256         mono_counters_register ("WBarrier generic atomic store called", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_generic_store_atomic);
1257         mono_counters_register ("WBarrier set root", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_set_root);
1258
1259         mono_counters_register ("# objects allocated degraded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_alloced_degraded);
1260         mono_counters_register ("bytes allocated degraded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_bytes_alloced_degraded);
1261
1262         mono_counters_register ("# copy_object() called (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copy_object_called_nursery);
1263         mono_counters_register ("# objects copied (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_copied_nursery);
1264         mono_counters_register ("# copy_object() called (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copy_object_called_major);
1265         mono_counters_register ("# objects copied (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_copied_major);
1266
1267         mono_counters_register ("# scan_object() called (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scan_object_called_nursery);
1268         mono_counters_register ("# scan_object() called (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scan_object_called_major);
1269
1270         mono_counters_register ("Slots allocated in vain", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_slots_allocated_in_vain);
1271
1272         mono_counters_register ("# nursery copy_object() failed from space", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_from_space);
1273         mono_counters_register ("# nursery copy_object() failed forwarded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_forwarded);
1274         mono_counters_register ("# nursery copy_object() failed pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_pinned);
1275         mono_counters_register ("# nursery copy_object() failed to space", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_to_space);
1276
1277         sgen_nursery_allocator_init_heavy_stats ();
1278 #endif
1279
1280         inited = TRUE;
1281 }
1282
1283
1284 static void
1285 reset_pinned_from_failed_allocation (void)
1286 {
1287         bytes_pinned_from_failed_allocation = 0;
1288 }
1289
1290 void
1291 sgen_set_pinned_from_failed_allocation (mword objsize)
1292 {
1293         bytes_pinned_from_failed_allocation += objsize;
1294 }
1295
1296 gboolean
1297 sgen_collection_is_concurrent (void)
1298 {
1299         switch (current_collection_generation) {
1300         case GENERATION_NURSERY:
1301                 return FALSE;
1302         case GENERATION_OLD:
1303                 return concurrent_collection_in_progress;
1304         default:
1305                 g_error ("Invalid current generation %d", current_collection_generation);
1306         }
1307         return FALSE;
1308 }
1309
1310 gboolean
1311 sgen_concurrent_collection_in_progress (void)
1312 {
1313         return concurrent_collection_in_progress;
1314 }
1315
1316 typedef struct {
1317         SgenThreadPoolJob job;
1318         SgenObjectOperations *ops;
1319 } ScanJob;
1320
1321 static void
1322 job_remembered_set_scan (void *worker_data_untyped, SgenThreadPoolJob *job)
1323 {
1324         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1325         ScanJob *job_data = (ScanJob*)job;
1326         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1327         remset.scan_remsets (ctx);
1328 }
1329
1330 typedef struct {
1331         SgenThreadPoolJob job;
1332         SgenObjectOperations *ops;
1333         char *heap_start;
1334         char *heap_end;
1335         int root_type;
1336 } ScanFromRegisteredRootsJob;
1337
1338 static void
1339 job_scan_from_registered_roots (void *worker_data_untyped, SgenThreadPoolJob *job)
1340 {
1341         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1342         ScanFromRegisteredRootsJob *job_data = (ScanFromRegisteredRootsJob*)job;
1343         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1344
1345         scan_from_registered_roots (job_data->heap_start, job_data->heap_end, job_data->root_type, ctx);
1346 }
1347
1348 typedef struct {
1349         SgenThreadPoolJob job;
1350         SgenObjectOperations *ops;
1351         char *heap_start;
1352         char *heap_end;
1353 } ScanThreadDataJob;
1354
1355 static void
1356 job_scan_thread_data (void *worker_data_untyped, SgenThreadPoolJob *job)
1357 {
1358         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1359         ScanThreadDataJob *job_data = (ScanThreadDataJob*)job;
1360         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1361
1362         sgen_client_scan_thread_data (job_data->heap_start, job_data->heap_end, TRUE, ctx);
1363 }
1364
1365 typedef struct {
1366         SgenThreadPoolJob job;
1367         SgenObjectOperations *ops;
1368         SgenPointerQueue *queue;
1369 } ScanFinalizerEntriesJob;
1370
1371 static void
1372 job_scan_finalizer_entries (void *worker_data_untyped, SgenThreadPoolJob *job)
1373 {
1374         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1375         ScanFinalizerEntriesJob *job_data = (ScanFinalizerEntriesJob*)job;
1376         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1377
1378         scan_finalizer_entries (job_data->queue, ctx);
1379 }
1380
1381 static void
1382 job_scan_major_mod_union_card_table (void *worker_data_untyped, SgenThreadPoolJob *job)
1383 {
1384         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1385         ScanJob *job_data = (ScanJob*)job;
1386         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1387
1388         g_assert (concurrent_collection_in_progress);
1389         major_collector.scan_card_table (CARDTABLE_SCAN_MOD_UNION, ctx);
1390 }
1391
1392 static void
1393 job_scan_los_mod_union_card_table (void *worker_data_untyped, SgenThreadPoolJob *job)
1394 {
1395         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1396         ScanJob *job_data = (ScanJob*)job;
1397         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1398
1399         g_assert (concurrent_collection_in_progress);
1400         sgen_los_scan_card_table (CARDTABLE_SCAN_MOD_UNION, ctx);
1401 }
1402
1403 static void
1404 job_mod_union_preclean (void *worker_data_untyped, SgenThreadPoolJob *job)
1405 {
1406         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1407         ScanJob *job_data = (ScanJob*)job;
1408         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1409
1410         g_assert (concurrent_collection_in_progress);
1411
1412         major_collector.scan_card_table (CARDTABLE_SCAN_MOD_UNION_PRECLEAN, ctx);
1413         sgen_los_scan_card_table (CARDTABLE_SCAN_MOD_UNION_PRECLEAN, ctx);
1414 }
1415
1416 static void
1417 init_gray_queue (gboolean use_workers)
1418 {
1419         if (use_workers)
1420                 sgen_workers_init_distribute_gray_queue ();
1421         sgen_gray_object_queue_init (&gray_queue, NULL);
1422 }
1423
1424 static void
1425 enqueue_scan_from_roots_jobs (char *heap_start, char *heap_end, SgenObjectOperations *ops, gboolean enqueue)
1426 {
1427         ScanFromRegisteredRootsJob *scrrj;
1428         ScanThreadDataJob *stdj;
1429         ScanFinalizerEntriesJob *sfej;
1430
1431         /* registered roots, this includes static fields */
1432
1433         scrrj = (ScanFromRegisteredRootsJob*)sgen_thread_pool_job_alloc ("scan from registered roots normal", job_scan_from_registered_roots, sizeof (ScanFromRegisteredRootsJob));
1434         scrrj->ops = ops;
1435         scrrj->heap_start = heap_start;
1436         scrrj->heap_end = heap_end;
1437         scrrj->root_type = ROOT_TYPE_NORMAL;
1438         sgen_workers_enqueue_job (&scrrj->job, enqueue);
1439
1440         scrrj = (ScanFromRegisteredRootsJob*)sgen_thread_pool_job_alloc ("scan from registered roots wbarrier", job_scan_from_registered_roots, sizeof (ScanFromRegisteredRootsJob));
1441         scrrj->ops = ops;
1442         scrrj->heap_start = heap_start;
1443         scrrj->heap_end = heap_end;
1444         scrrj->root_type = ROOT_TYPE_WBARRIER;
1445         sgen_workers_enqueue_job (&scrrj->job, enqueue);
1446
1447         /* Threads */
1448
1449         stdj = (ScanThreadDataJob*)sgen_thread_pool_job_alloc ("scan thread data", job_scan_thread_data, sizeof (ScanThreadDataJob));
1450         stdj->heap_start = heap_start;
1451         stdj->heap_end = heap_end;
1452         sgen_workers_enqueue_job (&stdj->job, enqueue);
1453
1454         /* Scan the list of objects ready for finalization. */
1455
1456         sfej = (ScanFinalizerEntriesJob*)sgen_thread_pool_job_alloc ("scan finalizer entries", job_scan_finalizer_entries, sizeof (ScanFinalizerEntriesJob));
1457         sfej->queue = &fin_ready_queue;
1458         sfej->ops = ops;
1459         sgen_workers_enqueue_job (&sfej->job, enqueue);
1460
1461         sfej = (ScanFinalizerEntriesJob*)sgen_thread_pool_job_alloc ("scan critical finalizer entries", job_scan_finalizer_entries, sizeof (ScanFinalizerEntriesJob));
1462         sfej->queue = &critical_fin_queue;
1463         sfej->ops = ops;
1464         sgen_workers_enqueue_job (&sfej->job, enqueue);
1465 }
1466
1467 /*
1468  * Perform a nursery collection.
1469  *
1470  * Return whether any objects were late-pinned due to being out of memory.
1471  */
1472 static gboolean
1473 collect_nursery (SgenGrayQueue *unpin_queue, gboolean finish_up_concurrent_mark)
1474 {
1475         gboolean needs_major;
1476         size_t max_garbage_amount;
1477         char *nursery_next;
1478         mword fragment_total;
1479         ScanJob *sj;
1480         SgenObjectOperations *object_ops = &sgen_minor_collector.serial_ops;
1481         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (object_ops, &gray_queue);
1482         TV_DECLARE (atv);
1483         TV_DECLARE (btv);
1484
1485         if (disable_minor_collections)
1486                 return TRUE;
1487
1488         TV_GETTIME (last_minor_collection_start_tv);
1489         atv = last_minor_collection_start_tv;
1490
1491         binary_protocol_collection_begin (gc_stats.minor_gc_count, GENERATION_NURSERY);
1492
1493         if (do_verify_nursery || do_dump_nursery_content)
1494                 sgen_debug_verify_nursery (do_dump_nursery_content);
1495
1496         current_collection_generation = GENERATION_NURSERY;
1497
1498         SGEN_ASSERT (0, !sgen_collection_is_concurrent (), "Why is the nursery collection concurrent?");
1499
1500         reset_pinned_from_failed_allocation ();
1501
1502         check_scan_starts ();
1503
1504         sgen_nursery_alloc_prepare_for_minor ();
1505
1506         degraded_mode = 0;
1507         objects_pinned = 0;
1508         nursery_next = sgen_nursery_alloc_get_upper_alloc_bound ();
1509         /* FIXME: optimize later to use the higher address where an object can be present */
1510         nursery_next = MAX (nursery_next, sgen_get_nursery_end ());
1511
1512         SGEN_LOG (1, "Start nursery collection %d %p-%p, size: %d", gc_stats.minor_gc_count, sgen_get_nursery_start (), nursery_next, (int)(nursery_next - sgen_get_nursery_start ()));
1513         max_garbage_amount = nursery_next - sgen_get_nursery_start ();
1514         g_assert (nursery_section->size >= max_garbage_amount);
1515
1516         /* world must be stopped already */
1517         TV_GETTIME (btv);
1518         time_minor_pre_collection_fragment_clear += TV_ELAPSED (atv, btv);
1519
1520         sgen_client_pre_collection_checks ();
1521
1522         nursery_section->next_data = nursery_next;
1523
1524         major_collector.start_nursery_collection ();
1525
1526         sgen_memgov_minor_collection_start ();
1527
1528         init_gray_queue (FALSE);
1529
1530         gc_stats.minor_gc_count ++;
1531
1532         if (whole_heap_check_before_collection) {
1533                 sgen_clear_nursery_fragments ();
1534                 sgen_check_whole_heap (finish_up_concurrent_mark);
1535         }
1536         if (consistency_check_at_minor_collection)
1537                 sgen_check_consistency ();
1538
1539         sgen_process_fin_stage_entries ();
1540
1541         /* pin from pinned handles */
1542         sgen_init_pinning ();
1543         sgen_client_binary_protocol_mark_start (GENERATION_NURSERY);
1544         pin_from_roots (sgen_get_nursery_start (), nursery_next, ctx);
1545         /* pin cemented objects */
1546         sgen_pin_cemented_objects ();
1547         /* identify pinned objects */
1548         sgen_optimize_pin_queue ();
1549         sgen_pinning_setup_section (nursery_section);
1550
1551         pin_objects_in_nursery (FALSE, ctx);
1552         sgen_pinning_trim_queue_to_section (nursery_section);
1553
1554         TV_GETTIME (atv);
1555         time_minor_pinning += TV_ELAPSED (btv, atv);
1556         SGEN_LOG (2, "Finding pinned pointers: %zd in %lld usecs", sgen_get_pinned_count (), TV_ELAPSED (btv, atv));
1557         SGEN_LOG (4, "Start scan with %zd pinned objects", sgen_get_pinned_count ());
1558
1559         sj = (ScanJob*)sgen_thread_pool_job_alloc ("scan remset", job_remembered_set_scan, sizeof (ScanJob));
1560         sj->ops = object_ops;
1561         sgen_workers_enqueue_job (&sj->job, FALSE);
1562
1563         /* we don't have complete write barrier yet, so we scan all the old generation sections */
1564         TV_GETTIME (btv);
1565         time_minor_scan_remsets += TV_ELAPSED (atv, btv);
1566         SGEN_LOG (2, "Old generation scan: %lld usecs", TV_ELAPSED (atv, btv));
1567
1568         sgen_pin_stats_print_class_stats ();
1569
1570         /* FIXME: Why do we do this at this specific, seemingly random, point? */
1571         sgen_client_collecting_minor (&fin_ready_queue, &critical_fin_queue);
1572
1573         TV_GETTIME (atv);
1574         time_minor_scan_pinned += TV_ELAPSED (btv, atv);
1575
1576         enqueue_scan_from_roots_jobs (sgen_get_nursery_start (), nursery_next, object_ops, FALSE);
1577
1578         TV_GETTIME (btv);
1579         time_minor_scan_roots += TV_ELAPSED (atv, btv);
1580
1581         finish_gray_stack (GENERATION_NURSERY, ctx);
1582
1583         TV_GETTIME (atv);
1584         time_minor_finish_gray_stack += TV_ELAPSED (btv, atv);
1585         sgen_client_binary_protocol_mark_end (GENERATION_NURSERY);
1586
1587         if (objects_pinned) {
1588                 sgen_optimize_pin_queue ();
1589                 sgen_pinning_setup_section (nursery_section);
1590         }
1591
1592         /* walk the pin_queue, build up the fragment list of free memory, unmark
1593          * pinned objects as we go, memzero() the empty fragments so they are ready for the
1594          * next allocations.
1595          */
1596         sgen_client_binary_protocol_reclaim_start (GENERATION_NURSERY);
1597         fragment_total = sgen_build_nursery_fragments (nursery_section, unpin_queue);
1598         if (!fragment_total)
1599                 degraded_mode = 1;
1600
1601         /* Clear TLABs for all threads */
1602         sgen_clear_tlabs ();
1603
1604         sgen_client_binary_protocol_reclaim_end (GENERATION_NURSERY);
1605         TV_GETTIME (btv);
1606         time_minor_fragment_creation += TV_ELAPSED (atv, btv);
1607         SGEN_LOG (2, "Fragment creation: %lld usecs, %lu bytes available", TV_ELAPSED (atv, btv), (unsigned long)fragment_total);
1608
1609         if (consistency_check_at_minor_collection)
1610                 sgen_check_major_refs ();
1611
1612         major_collector.finish_nursery_collection ();
1613
1614         TV_GETTIME (last_minor_collection_end_tv);
1615         gc_stats.minor_gc_time += TV_ELAPSED (last_minor_collection_start_tv, last_minor_collection_end_tv);
1616
1617         sgen_debug_dump_heap ("minor", gc_stats.minor_gc_count - 1, NULL);
1618
1619         /* prepare the pin queue for the next collection */
1620         sgen_finish_pinning ();
1621         if (sgen_have_pending_finalizers ()) {
1622                 SGEN_LOG (4, "Finalizer-thread wakeup");
1623                 sgen_client_finalize_notify ();
1624         }
1625         sgen_pin_stats_reset ();
1626         /* clear cemented hash */
1627         sgen_cement_clear_below_threshold ();
1628
1629         g_assert (sgen_gray_object_queue_is_empty (&gray_queue));
1630
1631         remset.finish_minor_collection ();
1632
1633         check_scan_starts ();
1634
1635         binary_protocol_flush_buffers (FALSE);
1636
1637         sgen_memgov_minor_collection_end ();
1638
1639         /*objects are late pinned because of lack of memory, so a major is a good call*/
1640         needs_major = objects_pinned > 0;
1641         current_collection_generation = -1;
1642         objects_pinned = 0;
1643
1644         binary_protocol_collection_end (gc_stats.minor_gc_count - 1, GENERATION_NURSERY, 0, 0);
1645
1646         if (check_nursery_objects_pinned && !sgen_minor_collector.is_split)
1647                 sgen_check_nursery_objects_pinned (unpin_queue != NULL);
1648
1649         return needs_major;
1650 }
1651
1652 typedef enum {
1653         COPY_OR_MARK_FROM_ROOTS_SERIAL,
1654         COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT,
1655         COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT
1656 } CopyOrMarkFromRootsMode;
1657
1658 static void
1659 major_copy_or_mark_from_roots (size_t *old_next_pin_slot, CopyOrMarkFromRootsMode mode, SgenObjectOperations *object_ops)
1660 {
1661         LOSObject *bigobj;
1662         TV_DECLARE (atv);
1663         TV_DECLARE (btv);
1664         /* FIXME: only use these values for the precise scan
1665          * note that to_space pointers should be excluded anyway...
1666          */
1667         char *heap_start = NULL;
1668         char *heap_end = (char*)-1;
1669         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (object_ops, WORKERS_DISTRIBUTE_GRAY_QUEUE);
1670         gboolean concurrent = mode != COPY_OR_MARK_FROM_ROOTS_SERIAL;
1671
1672         SGEN_ASSERT (0, !!concurrent == !!concurrent_collection_in_progress, "We've been called with the wrong mode.");
1673
1674         if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
1675                 /*This cleans up unused fragments */
1676                 sgen_nursery_allocator_prepare_for_pinning ();
1677
1678                 if (do_concurrent_checks)
1679                         sgen_debug_check_nursery_is_clean ();
1680         } else {
1681                 /* The concurrent collector doesn't touch the nursery. */
1682                 sgen_nursery_alloc_prepare_for_major ();
1683         }
1684
1685         init_gray_queue (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT);
1686
1687         TV_GETTIME (atv);
1688
1689         /* Pinning depends on this */
1690         sgen_clear_nursery_fragments ();
1691
1692         if (whole_heap_check_before_collection)
1693                 sgen_check_whole_heap (mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT);
1694
1695         TV_GETTIME (btv);
1696         time_major_pre_collection_fragment_clear += TV_ELAPSED (atv, btv);
1697
1698         if (!sgen_collection_is_concurrent ())
1699                 nursery_section->next_data = sgen_get_nursery_end ();
1700         /* we should also coalesce scanning from sections close to each other
1701          * and deal with pointers outside of the sections later.
1702          */
1703
1704         objects_pinned = 0;
1705
1706         sgen_client_pre_collection_checks ();
1707
1708         if (mode != COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
1709                 /* Remsets are not useful for a major collection */
1710                 remset.clear_cards ();
1711         }
1712
1713         sgen_process_fin_stage_entries ();
1714
1715         TV_GETTIME (atv);
1716         sgen_init_pinning ();
1717         SGEN_LOG (6, "Collecting pinned addresses");
1718         pin_from_roots ((void*)lowest_heap_address, (void*)highest_heap_address, ctx);
1719         if (mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT) {
1720                 /* Pin cemented objects that were forced */
1721                 sgen_pin_cemented_objects ();
1722         }
1723         sgen_optimize_pin_queue ();
1724         if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
1725                 /*
1726                  * Cemented objects that are in the pinned list will be marked. When
1727                  * marking concurrently we won't mark mod-union cards for these objects.
1728                  * Instead they will remain cemented until the next major collection,
1729                  * when we will recheck if they are still pinned in the roots.
1730                  */
1731                 sgen_cement_force_pinned ();
1732         }
1733
1734         sgen_client_collecting_major_1 ();
1735
1736         /*
1737          * pin_queue now contains all candidate pointers, sorted and
1738          * uniqued.  We must do two passes now to figure out which
1739          * objects are pinned.
1740          *
1741          * The first is to find within the pin_queue the area for each
1742          * section.  This requires that the pin_queue be sorted.  We
1743          * also process the LOS objects and pinned chunks here.
1744          *
1745          * The second, destructive, pass is to reduce the section
1746          * areas to pointers to the actually pinned objects.
1747          */
1748         SGEN_LOG (6, "Pinning from sections");
1749         /* first pass for the sections */
1750         sgen_find_section_pin_queue_start_end (nursery_section);
1751         /* identify possible pointers to the insize of large objects */
1752         SGEN_LOG (6, "Pinning from large objects");
1753         for (bigobj = los_object_list; bigobj; bigobj = bigobj->next) {
1754                 size_t dummy;
1755                 if (sgen_find_optimized_pin_queue_area ((char*)bigobj->data, (char*)bigobj->data + sgen_los_object_size (bigobj), &dummy, &dummy)) {
1756                         binary_protocol_pin (bigobj->data, (gpointer)LOAD_VTABLE (bigobj->data), safe_object_get_size (bigobj->data));
1757
1758                         if (sgen_los_object_is_pinned (bigobj->data)) {
1759                                 SGEN_ASSERT (0, mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT, "LOS objects can only be pinned here after concurrent marking.");
1760                                 continue;
1761                         }
1762                         sgen_los_pin_object (bigobj->data);
1763                         if (SGEN_OBJECT_HAS_REFERENCES (bigobj->data))
1764                                 GRAY_OBJECT_ENQUEUE (WORKERS_DISTRIBUTE_GRAY_QUEUE, bigobj->data, sgen_obj_get_descriptor ((GCObject*)bigobj->data));
1765                         sgen_pin_stats_register_object (bigobj->data, safe_object_get_size (bigobj->data));
1766                         SGEN_LOG (6, "Marked large object %p (%s) size: %lu from roots", bigobj->data,
1767                                         sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (bigobj->data)),
1768                                         (unsigned long)sgen_los_object_size (bigobj));
1769
1770                         sgen_client_pinned_los_object (bigobj->data);
1771                 }
1772         }
1773
1774         pin_objects_in_nursery (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT, ctx);
1775         if (check_nursery_objects_pinned && !sgen_minor_collector.is_split)
1776                 sgen_check_nursery_objects_pinned (mode != COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT);
1777
1778         major_collector.pin_objects (WORKERS_DISTRIBUTE_GRAY_QUEUE);
1779         if (old_next_pin_slot)
1780                 *old_next_pin_slot = sgen_get_pinned_count ();
1781
1782         TV_GETTIME (btv);
1783         time_major_pinning += TV_ELAPSED (atv, btv);
1784         SGEN_LOG (2, "Finding pinned pointers: %zd in %lld usecs", sgen_get_pinned_count (), TV_ELAPSED (atv, btv));
1785         SGEN_LOG (4, "Start scan with %zd pinned objects", sgen_get_pinned_count ());
1786
1787         major_collector.init_to_space ();
1788
1789         SGEN_ASSERT (0, sgen_workers_all_done (), "Why are the workers not done when we start or finish a major collection?");
1790         if (mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT) {
1791                 if (sgen_workers_have_idle_work ()) {
1792                         /*
1793                          * We force the finish of the worker with the new object ops context
1794                          * which can also do copying. We need to have finished pinning.
1795                          */
1796                         sgen_workers_start_all_workers (object_ops, NULL);
1797                         sgen_workers_join ();
1798                 }
1799         }
1800
1801 #ifdef SGEN_DEBUG_INTERNAL_ALLOC
1802         main_gc_thread = mono_native_thread_self ();
1803 #endif
1804
1805         sgen_client_collecting_major_2 ();
1806
1807         TV_GETTIME (atv);
1808         time_major_scan_pinned += TV_ELAPSED (btv, atv);
1809
1810         sgen_client_collecting_major_3 (&fin_ready_queue, &critical_fin_queue);
1811
1812         enqueue_scan_from_roots_jobs (heap_start, heap_end, object_ops, FALSE);
1813
1814         TV_GETTIME (btv);
1815         time_major_scan_roots += TV_ELAPSED (atv, btv);
1816
1817         /*
1818          * We start the concurrent worker after pinning and after we scanned the roots
1819          * in order to make sure that the worker does not finish before handling all
1820          * the roots.
1821          */
1822         if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
1823                 if (precleaning_enabled) {
1824                         ScanJob *sj;
1825                         /* Mod union preclean job */
1826                         sj = (ScanJob*)sgen_thread_pool_job_alloc ("preclean mod union cardtable", job_mod_union_preclean, sizeof (ScanJob));
1827                         sj->ops = object_ops;
1828                         sgen_workers_start_all_workers (object_ops, &sj->job);
1829                 } else {
1830                         sgen_workers_start_all_workers (object_ops, NULL);
1831                 }
1832                 gray_queue_enable_redirect (WORKERS_DISTRIBUTE_GRAY_QUEUE);
1833         }
1834
1835         if (mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT) {
1836                 ScanJob *sj;
1837
1838                 /* Mod union card table */
1839                 sj = (ScanJob*)sgen_thread_pool_job_alloc ("scan mod union cardtable", job_scan_major_mod_union_card_table, sizeof (ScanJob));
1840                 sj->ops = object_ops;
1841                 sgen_workers_enqueue_job (&sj->job, FALSE);
1842
1843                 sj = (ScanJob*)sgen_thread_pool_job_alloc ("scan LOS mod union cardtable", job_scan_los_mod_union_card_table, sizeof (ScanJob));
1844                 sj->ops = object_ops;
1845                 sgen_workers_enqueue_job (&sj->job, FALSE);
1846
1847                 TV_GETTIME (atv);
1848                 time_major_scan_mod_union += TV_ELAPSED (btv, atv);
1849         }
1850
1851         sgen_pin_stats_print_class_stats ();
1852 }
1853
1854 static void
1855 major_finish_copy_or_mark (CopyOrMarkFromRootsMode mode)
1856 {
1857         if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
1858                 sgen_finish_pinning ();
1859
1860                 sgen_pin_stats_reset ();
1861
1862                 if (do_concurrent_checks)
1863                         sgen_debug_check_nursery_is_clean ();
1864         }
1865 }
1866
1867 static void
1868 major_start_collection (gboolean concurrent, size_t *old_next_pin_slot)
1869 {
1870         SgenObjectOperations *object_ops;
1871
1872         binary_protocol_collection_begin (gc_stats.major_gc_count, GENERATION_OLD);
1873
1874         current_collection_generation = GENERATION_OLD;
1875
1876         g_assert (sgen_section_gray_queue_is_empty (sgen_workers_get_distribute_section_gray_queue ()));
1877
1878         if (!concurrent)
1879                 sgen_cement_reset ();
1880
1881         if (concurrent) {
1882                 g_assert (major_collector.is_concurrent);
1883                 concurrent_collection_in_progress = TRUE;
1884
1885                 object_ops = &major_collector.major_ops_concurrent_start;
1886         } else {
1887                 object_ops = &major_collector.major_ops_serial;
1888         }
1889
1890         reset_pinned_from_failed_allocation ();
1891
1892         sgen_memgov_major_collection_start ();
1893
1894         //count_ref_nonref_objs ();
1895         //consistency_check ();
1896
1897         check_scan_starts ();
1898
1899         degraded_mode = 0;
1900         SGEN_LOG (1, "Start major collection %d", gc_stats.major_gc_count);
1901         gc_stats.major_gc_count ++;
1902
1903         if (major_collector.start_major_collection)
1904                 major_collector.start_major_collection ();
1905
1906         major_copy_or_mark_from_roots (old_next_pin_slot, concurrent ? COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT : COPY_OR_MARK_FROM_ROOTS_SERIAL, object_ops);
1907         major_finish_copy_or_mark (concurrent ? COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT : COPY_OR_MARK_FROM_ROOTS_SERIAL);
1908 }
1909
1910 static void
1911 major_finish_collection (const char *reason, size_t old_next_pin_slot, gboolean forced)
1912 {
1913         ScannedObjectCounts counts;
1914         SgenObjectOperations *object_ops;
1915         mword fragment_total;
1916         TV_DECLARE (atv);
1917         TV_DECLARE (btv);
1918
1919         TV_GETTIME (btv);
1920
1921         if (concurrent_collection_in_progress) {
1922                 object_ops = &major_collector.major_ops_concurrent_finish;
1923
1924                 major_copy_or_mark_from_roots (NULL, COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT, object_ops);
1925
1926                 major_finish_copy_or_mark (COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT);
1927
1928 #ifdef SGEN_DEBUG_INTERNAL_ALLOC
1929                 main_gc_thread = NULL;
1930 #endif
1931         } else {
1932                 object_ops = &major_collector.major_ops_serial;
1933         }
1934
1935         g_assert (sgen_section_gray_queue_is_empty (sgen_workers_get_distribute_section_gray_queue ()));
1936
1937         /* all the objects in the heap */
1938         finish_gray_stack (GENERATION_OLD, CONTEXT_FROM_OBJECT_OPERATIONS (object_ops, &gray_queue));
1939         TV_GETTIME (atv);
1940         time_major_finish_gray_stack += TV_ELAPSED (btv, atv);
1941
1942         SGEN_ASSERT (0, sgen_workers_all_done (), "Can't have workers working after joining");
1943
1944         if (objects_pinned) {
1945                 g_assert (!concurrent_collection_in_progress);
1946
1947                 /*
1948                  * This is slow, but we just OOM'd.
1949                  *
1950                  * See comment at `sgen_pin_queue_clear_discarded_entries` for how the pin
1951                  * queue is laid out at this point.
1952                  */
1953                 sgen_pin_queue_clear_discarded_entries (nursery_section, old_next_pin_slot);
1954                 /*
1955                  * We need to reestablish all pinned nursery objects in the pin queue
1956                  * because they're needed for fragment creation.  Unpinning happens by
1957                  * walking the whole queue, so it's not necessary to reestablish where major
1958                  * heap block pins are - all we care is that they're still in there
1959                  * somewhere.
1960                  */
1961                 sgen_optimize_pin_queue ();
1962                 sgen_find_section_pin_queue_start_end (nursery_section);
1963                 objects_pinned = 0;
1964         }
1965
1966         reset_heap_boundaries ();
1967         sgen_update_heap_boundaries ((mword)sgen_get_nursery_start (), (mword)sgen_get_nursery_end ());
1968
1969         /* walk the pin_queue, build up the fragment list of free memory, unmark
1970          * pinned objects as we go, memzero() the empty fragments so they are ready for the
1971          * next allocations.
1972          */
1973         fragment_total = sgen_build_nursery_fragments (nursery_section, NULL);
1974         if (!fragment_total)
1975                 degraded_mode = 1;
1976         SGEN_LOG (4, "Free space in nursery after major %ld", (long)fragment_total);
1977
1978         if (do_concurrent_checks && concurrent_collection_in_progress)
1979                 sgen_debug_check_nursery_is_clean ();
1980
1981         /* prepare the pin queue for the next collection */
1982         sgen_finish_pinning ();
1983
1984         /* Clear TLABs for all threads */
1985         sgen_clear_tlabs ();
1986
1987         sgen_pin_stats_reset ();
1988
1989         sgen_cement_clear_below_threshold ();
1990
1991         if (check_mark_bits_after_major_collection)
1992                 sgen_check_heap_marked (concurrent_collection_in_progress);
1993
1994         TV_GETTIME (btv);
1995         time_major_fragment_creation += TV_ELAPSED (atv, btv);
1996
1997         binary_protocol_sweep_begin (GENERATION_OLD, !major_collector.sweeps_lazily);
1998         sgen_memgov_major_pre_sweep ();
1999
2000         TV_GETTIME (atv);
2001         time_major_free_bigobjs += TV_ELAPSED (btv, atv);
2002
2003         sgen_los_sweep ();
2004
2005         TV_GETTIME (btv);
2006         time_major_los_sweep += TV_ELAPSED (atv, btv);
2007
2008         major_collector.sweep ();
2009
2010         binary_protocol_sweep_end (GENERATION_OLD, !major_collector.sweeps_lazily);
2011
2012         TV_GETTIME (atv);
2013         time_major_sweep += TV_ELAPSED (btv, atv);
2014
2015         sgen_debug_dump_heap ("major", gc_stats.major_gc_count - 1, reason);
2016
2017         if (sgen_have_pending_finalizers ()) {
2018                 SGEN_LOG (4, "Finalizer-thread wakeup");
2019                 sgen_client_finalize_notify ();
2020         }
2021
2022         g_assert (sgen_gray_object_queue_is_empty (&gray_queue));
2023
2024         sgen_memgov_major_collection_end (forced);
2025         current_collection_generation = -1;
2026
2027         memset (&counts, 0, sizeof (ScannedObjectCounts));
2028         major_collector.finish_major_collection (&counts);
2029
2030         g_assert (sgen_section_gray_queue_is_empty (sgen_workers_get_distribute_section_gray_queue ()));
2031
2032         SGEN_ASSERT (0, sgen_workers_all_done (), "Can't have workers working after major collection has finished");
2033         if (concurrent_collection_in_progress)
2034                 concurrent_collection_in_progress = FALSE;
2035
2036         check_scan_starts ();
2037
2038         binary_protocol_flush_buffers (FALSE);
2039
2040         //consistency_check ();
2041
2042         binary_protocol_collection_end (gc_stats.major_gc_count - 1, GENERATION_OLD, counts.num_scanned_objects, counts.num_unique_scanned_objects);
2043 }
2044
2045 static gboolean
2046 major_do_collection (const char *reason, gboolean forced)
2047 {
2048         TV_DECLARE (time_start);
2049         TV_DECLARE (time_end);
2050         size_t old_next_pin_slot;
2051
2052         if (disable_major_collections)
2053                 return FALSE;
2054
2055         if (major_collector.get_and_reset_num_major_objects_marked) {
2056                 long long num_marked = major_collector.get_and_reset_num_major_objects_marked ();
2057                 g_assert (!num_marked);
2058         }
2059
2060         /* world must be stopped already */
2061         TV_GETTIME (time_start);
2062
2063         major_start_collection (FALSE, &old_next_pin_slot);
2064         major_finish_collection (reason, old_next_pin_slot, forced);
2065
2066         TV_GETTIME (time_end);
2067         gc_stats.major_gc_time += TV_ELAPSED (time_start, time_end);
2068
2069         /* FIXME: also report this to the user, preferably in gc-end. */
2070         if (major_collector.get_and_reset_num_major_objects_marked)
2071                 major_collector.get_and_reset_num_major_objects_marked ();
2072
2073         return bytes_pinned_from_failed_allocation > 0;
2074 }
2075
2076 static void
2077 major_start_concurrent_collection (const char *reason)
2078 {
2079         TV_DECLARE (time_start);
2080         TV_DECLARE (time_end);
2081         long long num_objects_marked;
2082
2083         if (disable_major_collections)
2084                 return;
2085
2086         TV_GETTIME (time_start);
2087         SGEN_TV_GETTIME (time_major_conc_collection_start);
2088
2089         num_objects_marked = major_collector.get_and_reset_num_major_objects_marked ();
2090         g_assert (num_objects_marked == 0);
2091
2092         binary_protocol_concurrent_start ();
2093
2094         // FIXME: store reason and pass it when finishing
2095         major_start_collection (TRUE, NULL);
2096
2097         gray_queue_redirect (&gray_queue);
2098
2099         num_objects_marked = major_collector.get_and_reset_num_major_objects_marked ();
2100
2101         TV_GETTIME (time_end);
2102         gc_stats.major_gc_time += TV_ELAPSED (time_start, time_end);
2103
2104         current_collection_generation = -1;
2105 }
2106
2107 /*
2108  * Returns whether the major collection has finished.
2109  */
2110 static gboolean
2111 major_should_finish_concurrent_collection (void)
2112 {
2113         SGEN_ASSERT (0, sgen_gray_object_queue_is_empty (&gray_queue), "Why is the gray queue not empty before we have started doing anything?");
2114         return sgen_workers_all_done ();
2115 }
2116
2117 static void
2118 major_update_concurrent_collection (void)
2119 {
2120         TV_DECLARE (total_start);
2121         TV_DECLARE (total_end);
2122
2123         TV_GETTIME (total_start);
2124
2125         binary_protocol_concurrent_update ();
2126
2127         major_collector.update_cardtable_mod_union ();
2128         sgen_los_update_cardtable_mod_union ();
2129
2130         TV_GETTIME (total_end);
2131         gc_stats.major_gc_time += TV_ELAPSED (total_start, total_end);
2132 }
2133
2134 static void
2135 major_finish_concurrent_collection (gboolean forced)
2136 {
2137         TV_DECLARE (total_start);
2138         TV_DECLARE (total_end);
2139
2140         TV_GETTIME (total_start);
2141
2142         binary_protocol_concurrent_finish ();
2143
2144         /*
2145          * We need to stop all workers since we're updating the cardtable below.
2146          * The workers will be resumed with a finishing pause context to avoid
2147          * additional cardtable and object scanning.
2148          */
2149         sgen_workers_stop_all_workers ();
2150
2151         SGEN_TV_GETTIME (time_major_conc_collection_end);
2152         gc_stats.major_gc_time_concurrent += SGEN_TV_ELAPSED (time_major_conc_collection_start, time_major_conc_collection_end);
2153
2154         major_collector.update_cardtable_mod_union ();
2155         sgen_los_update_cardtable_mod_union ();
2156
2157         if (mod_union_consistency_check)
2158                 sgen_check_mod_union_consistency ();
2159
2160         current_collection_generation = GENERATION_OLD;
2161         sgen_cement_reset ();
2162         major_finish_collection ("finishing", -1, forced);
2163
2164         if (whole_heap_check_before_collection)
2165                 sgen_check_whole_heap (FALSE);
2166
2167         TV_GETTIME (total_end);
2168         gc_stats.major_gc_time += TV_ELAPSED (total_start, total_end) - TV_ELAPSED (last_minor_collection_start_tv, last_minor_collection_end_tv);
2169
2170         current_collection_generation = -1;
2171 }
2172
2173 /*
2174  * Ensure an allocation request for @size will succeed by freeing enough memory.
2175  *
2176  * LOCKING: The GC lock MUST be held.
2177  */
2178 void
2179 sgen_ensure_free_space (size_t size, int generation)
2180 {
2181         int generation_to_collect = -1;
2182         const char *reason = NULL;
2183
2184         if (generation == GENERATION_OLD) {
2185                 if (sgen_need_major_collection (size)) {
2186                         reason = "LOS overflow";
2187                         generation_to_collect = GENERATION_OLD;
2188                 }
2189         } else {
2190                 if (degraded_mode) {
2191                         if (sgen_need_major_collection (size)) {
2192                                 reason = "Degraded mode overflow";
2193                                 generation_to_collect = GENERATION_OLD;
2194                         }
2195                 } else if (sgen_need_major_collection (size)) {
2196                         reason = concurrent_collection_in_progress ? "Forced finish concurrent collection" : "Minor allowance";
2197                         generation_to_collect = GENERATION_OLD;
2198                 } else {
2199                         generation_to_collect = GENERATION_NURSERY;
2200                         reason = "Nursery full";                        
2201                 }
2202         }
2203
2204         if (generation_to_collect == -1) {
2205                 if (concurrent_collection_in_progress && sgen_workers_all_done ()) {
2206                         generation_to_collect = GENERATION_OLD;
2207                         reason = "Finish concurrent collection";
2208                 }
2209         }
2210
2211         if (generation_to_collect == -1)
2212                 return;
2213         sgen_perform_collection (size, generation_to_collect, reason, FALSE);
2214 }
2215
2216 /*
2217  * LOCKING: Assumes the GC lock is held.
2218  */
2219 void
2220 sgen_perform_collection (size_t requested_size, int generation_to_collect, const char *reason, gboolean wait_to_finish)
2221 {
2222         TV_DECLARE (gc_start);
2223         TV_DECLARE (gc_end);
2224         TV_DECLARE (gc_total_start);
2225         TV_DECLARE (gc_total_end);
2226         GGTimingInfo infos [2];
2227         int overflow_generation_to_collect = -1;
2228         int oldest_generation_collected = generation_to_collect;
2229         const char *overflow_reason = NULL;
2230
2231         binary_protocol_collection_requested (generation_to_collect, requested_size, wait_to_finish ? 1 : 0);
2232
2233         SGEN_ASSERT (0, generation_to_collect == GENERATION_NURSERY || generation_to_collect == GENERATION_OLD, "What generation is this?");
2234
2235         TV_GETTIME (gc_start);
2236
2237         sgen_stop_world (generation_to_collect);
2238
2239         TV_GETTIME (gc_total_start);
2240
2241         if (concurrent_collection_in_progress) {
2242                 /*
2243                  * If the concurrent worker is finished or we are asked to do a major collection
2244                  * then we finish the concurrent collection.
2245                  */
2246                 gboolean finish = major_should_finish_concurrent_collection () || generation_to_collect == GENERATION_OLD;
2247
2248                 if (finish) {
2249                         major_finish_concurrent_collection (wait_to_finish);
2250                         oldest_generation_collected = GENERATION_OLD;
2251                 } else {
2252                         SGEN_ASSERT (0, generation_to_collect == GENERATION_NURSERY, "Why aren't we finishing the concurrent collection?");
2253                         major_update_concurrent_collection ();
2254                         collect_nursery (NULL, FALSE);
2255                 }
2256
2257                 goto done;
2258         }
2259
2260         SGEN_ASSERT (0, !concurrent_collection_in_progress, "Why did this not get handled above?");
2261
2262         /*
2263          * There's no concurrent collection in progress.  Collect the generation we're asked
2264          * to collect.  If the major collector is concurrent and we're not forced to wait,
2265          * start a concurrent collection.
2266          */
2267         // FIXME: extract overflow reason
2268         if (generation_to_collect == GENERATION_NURSERY) {
2269                 if (collect_nursery (NULL, FALSE)) {
2270                         overflow_generation_to_collect = GENERATION_OLD;
2271                         overflow_reason = "Minor overflow";
2272                 }
2273         } else {
2274                 if (major_collector.is_concurrent && !wait_to_finish) {
2275                         collect_nursery (NULL, FALSE);
2276                         major_start_concurrent_collection (reason);
2277                         // FIXME: set infos[0] properly
2278                         goto done;
2279                 }
2280
2281                 if (major_do_collection (reason, wait_to_finish)) {
2282                         overflow_generation_to_collect = GENERATION_NURSERY;
2283                         overflow_reason = "Excessive pinning";
2284                 }
2285         }
2286
2287         TV_GETTIME (gc_end);
2288
2289         memset (infos, 0, sizeof (infos));
2290         infos [0].generation = generation_to_collect;
2291         infos [0].reason = reason;
2292         infos [0].is_overflow = FALSE;
2293         infos [1].generation = -1;
2294         infos [0].total_time = SGEN_TV_ELAPSED (gc_start, gc_end);
2295
2296         SGEN_ASSERT (0, !concurrent_collection_in_progress, "Why did this not get handled above?");
2297
2298         if (overflow_generation_to_collect != -1) {
2299                 /*
2300                  * We need to do an overflow collection, either because we ran out of memory
2301                  * or the nursery is fully pinned.
2302                  */
2303
2304                 infos [1].generation = overflow_generation_to_collect;
2305                 infos [1].reason = overflow_reason;
2306                 infos [1].is_overflow = TRUE;
2307                 gc_start = gc_end;
2308
2309                 if (overflow_generation_to_collect == GENERATION_NURSERY)
2310                         collect_nursery (NULL, FALSE);
2311                 else
2312                         major_do_collection (overflow_reason, wait_to_finish);
2313
2314                 TV_GETTIME (gc_end);
2315                 infos [1].total_time = SGEN_TV_ELAPSED (gc_start, gc_end);
2316
2317                 oldest_generation_collected = MAX (oldest_generation_collected, overflow_generation_to_collect);
2318         }
2319
2320         SGEN_LOG (2, "Heap size: %lu, LOS size: %lu", (unsigned long)sgen_gc_get_total_heap_allocation (), (unsigned long)los_memory_usage);
2321
2322         /* this also sets the proper pointers for the next allocation */
2323         if (generation_to_collect == GENERATION_NURSERY && !sgen_can_alloc_size (requested_size)) {
2324                 /* TypeBuilder and MonoMethod are killing mcs with fragmentation */
2325                 SGEN_LOG (1, "nursery collection didn't find enough room for %zd alloc (%zd pinned)", requested_size, sgen_get_pinned_count ());
2326                 sgen_dump_pin_queue ();
2327                 degraded_mode = 1;
2328         }
2329
2330  done:
2331         g_assert (sgen_gray_object_queue_is_empty (&gray_queue));
2332
2333         TV_GETTIME (gc_total_end);
2334         time_max = MAX (time_max, TV_ELAPSED (gc_total_start, gc_total_end));
2335
2336         sgen_restart_world (oldest_generation_collected, infos);
2337 }
2338
2339 /*
2340  * ######################################################################
2341  * ########  Memory allocation from the OS
2342  * ######################################################################
2343  * This section of code deals with getting memory from the OS and
2344  * allocating memory for GC-internal data structures.
2345  * Internal memory can be handled with a freelist for small objects.
2346  */
2347
2348 /*
2349  * Debug reporting.
2350  */
2351 G_GNUC_UNUSED static void
2352 report_internal_mem_usage (void)
2353 {
2354         printf ("Internal memory usage:\n");
2355         sgen_report_internal_mem_usage ();
2356         printf ("Pinned memory usage:\n");
2357         major_collector.report_pinned_memory_usage ();
2358 }
2359
2360 /*
2361  * ######################################################################
2362  * ########  Finalization support
2363  * ######################################################################
2364  */
2365
2366 /*
2367  * If the object has been forwarded it means it's still referenced from a root. 
2368  * If it is pinned it's still alive as well.
2369  * A LOS object is only alive if we have pinned it.
2370  * Return TRUE if @obj is ready to be finalized.
2371  */
2372 static inline gboolean
2373 sgen_is_object_alive (GCObject *object)
2374 {
2375         if (ptr_in_nursery (object))
2376                 return sgen_nursery_is_object_alive (object);
2377
2378         return sgen_major_is_object_alive (object);
2379 }
2380
2381 /*
2382  * This function returns true if @object is either alive and belongs to the
2383  * current collection - major collections are full heap, so old gen objects
2384  * are never alive during a minor collection.
2385  */
2386 static inline int
2387 sgen_is_object_alive_and_on_current_collection (GCObject *object)
2388 {
2389         if (ptr_in_nursery (object))
2390                 return sgen_nursery_is_object_alive (object);
2391
2392         if (current_collection_generation == GENERATION_NURSERY)
2393                 return FALSE;
2394
2395         return sgen_major_is_object_alive (object);
2396 }
2397
2398
2399 gboolean
2400 sgen_gc_is_object_ready_for_finalization (GCObject *object)
2401 {
2402         return !sgen_is_object_alive (object);
2403 }
2404
2405 void
2406 sgen_queue_finalization_entry (GCObject *obj)
2407 {
2408         gboolean critical = sgen_client_object_has_critical_finalizer (obj);
2409
2410         sgen_pointer_queue_add (critical ? &critical_fin_queue : &fin_ready_queue, obj);
2411
2412         sgen_client_object_queued_for_finalization (obj);
2413 }
2414
2415 gboolean
2416 sgen_object_is_live (GCObject *obj)
2417 {
2418         return sgen_is_object_alive_and_on_current_collection (obj);
2419 }
2420
2421 /*
2422  * `System.GC.WaitForPendingFinalizers` first checks `sgen_have_pending_finalizers()` to
2423  * determine whether it can exit quickly.  The latter must therefore only return FALSE if
2424  * all finalizers have really finished running.
2425  *
2426  * `sgen_gc_invoke_finalizers()` first dequeues a finalizable object, and then finalizes it.
2427  * This means that just checking whether the queues are empty leaves the possibility that an
2428  * object might have been dequeued but not yet finalized.  That's why we need the additional
2429  * flag `pending_unqueued_finalizer`.
2430  */
2431
2432 static volatile gboolean pending_unqueued_finalizer = FALSE;
2433
2434 int
2435 sgen_gc_invoke_finalizers (void)
2436 {
2437         int count = 0;
2438
2439         g_assert (!pending_unqueued_finalizer);
2440
2441         /* FIXME: batch to reduce lock contention */
2442         while (sgen_have_pending_finalizers ()) {
2443                 GCObject *obj;
2444
2445                 LOCK_GC;
2446
2447                 /*
2448                  * We need to set `pending_unqueued_finalizer` before dequeing the
2449                  * finalizable object.
2450                  */
2451                 if (!sgen_pointer_queue_is_empty (&fin_ready_queue)) {
2452                         pending_unqueued_finalizer = TRUE;
2453                         mono_memory_write_barrier ();
2454                         obj = (GCObject *)sgen_pointer_queue_pop (&fin_ready_queue);
2455                 } else if (!sgen_pointer_queue_is_empty (&critical_fin_queue)) {
2456                         pending_unqueued_finalizer = TRUE;
2457                         mono_memory_write_barrier ();
2458                         obj = (GCObject *)sgen_pointer_queue_pop (&critical_fin_queue);
2459                 } else {
2460                         obj = NULL;
2461                 }
2462
2463                 if (obj)
2464                         SGEN_LOG (7, "Finalizing object %p (%s)", obj, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj)));
2465
2466                 UNLOCK_GC;
2467
2468                 if (!obj)
2469                         break;
2470
2471                 count++;
2472                 /* the object is on the stack so it is pinned */
2473                 /*g_print ("Calling finalizer for object: %p (%s)\n", obj, sgen_client_object_safe_name (obj));*/
2474                 sgen_client_run_finalize (obj);
2475         }
2476
2477         if (pending_unqueued_finalizer) {
2478                 mono_memory_write_barrier ();
2479                 pending_unqueued_finalizer = FALSE;
2480         }
2481
2482         return count;
2483 }
2484
2485 gboolean
2486 sgen_have_pending_finalizers (void)
2487 {
2488         return pending_unqueued_finalizer || !sgen_pointer_queue_is_empty (&fin_ready_queue) || !sgen_pointer_queue_is_empty (&critical_fin_queue);
2489 }
2490
2491 /*
2492  * ######################################################################
2493  * ########  registered roots support
2494  * ######################################################################
2495  */
2496
2497 /*
2498  * We do not coalesce roots.
2499  */
2500 int
2501 sgen_register_root (char *start, size_t size, SgenDescriptor descr, int root_type, int source, const char *msg)
2502 {
2503         RootRecord new_root;
2504         int i;
2505         LOCK_GC;
2506         for (i = 0; i < ROOT_TYPE_NUM; ++i) {
2507                 RootRecord *root = (RootRecord *)sgen_hash_table_lookup (&roots_hash [i], start);
2508                 /* we allow changing the size and the descriptor (for thread statics etc) */
2509                 if (root) {
2510                         size_t old_size = root->end_root - start;
2511                         root->end_root = start + size;
2512                         SGEN_ASSERT (0, !!root->root_desc == !!descr, "Can't change whether a root is precise or conservative.");
2513                         SGEN_ASSERT (0, root->source == source, "Can't change a root's source identifier.");
2514                         SGEN_ASSERT (0, !!root->msg == !!msg, "Can't change a root's message.");
2515                         root->root_desc = descr;
2516                         roots_size += size;
2517                         roots_size -= old_size;
2518                         UNLOCK_GC;
2519                         return TRUE;
2520                 }
2521         }
2522
2523         new_root.end_root = start + size;
2524         new_root.root_desc = descr;
2525         new_root.source = source;
2526         new_root.msg = msg;
2527
2528         sgen_hash_table_replace (&roots_hash [root_type], start, &new_root, NULL);
2529         roots_size += size;
2530
2531         SGEN_LOG (3, "Added root for range: %p-%p, descr: %llx  (%d/%d bytes)", start, new_root.end_root, (long long)descr, (int)size, (int)roots_size);
2532
2533         UNLOCK_GC;
2534         return TRUE;
2535 }
2536
2537 void
2538 sgen_deregister_root (char* addr)
2539 {
2540         int root_type;
2541         RootRecord root;
2542
2543         LOCK_GC;
2544         for (root_type = 0; root_type < ROOT_TYPE_NUM; ++root_type) {
2545                 if (sgen_hash_table_remove (&roots_hash [root_type], addr, &root))
2546                         roots_size -= (root.end_root - addr);
2547         }
2548         UNLOCK_GC;
2549 }
2550
2551 /*
2552  * ######################################################################
2553  * ########  Thread handling (stop/start code)
2554  * ######################################################################
2555  */
2556
2557 int
2558 sgen_get_current_collection_generation (void)
2559 {
2560         return current_collection_generation;
2561 }
2562
2563 void*
2564 sgen_thread_register (SgenThreadInfo* info, void *stack_bottom_fallback)
2565 {
2566 #ifndef HAVE_KW_THREAD
2567         info->tlab_start = info->tlab_next = info->tlab_temp_end = info->tlab_real_end = NULL;
2568 #endif
2569
2570         sgen_init_tlab_info (info);
2571
2572         sgen_client_thread_register (info, stack_bottom_fallback);
2573
2574         return info;
2575 }
2576
2577 void
2578 sgen_thread_unregister (SgenThreadInfo *p)
2579 {
2580         sgen_client_thread_unregister (p);
2581 }
2582
2583 /*
2584  * ######################################################################
2585  * ########  Write barriers
2586  * ######################################################################
2587  */
2588
2589 /*
2590  * Note: the write barriers first do the needed GC work and then do the actual store:
2591  * this way the value is visible to the conservative GC scan after the write barrier
2592  * itself. If a GC interrupts the barrier in the middle, value will be kept alive by
2593  * the conservative scan, otherwise by the remembered set scan.
2594  */
2595
2596 void
2597 mono_gc_wbarrier_arrayref_copy (gpointer dest_ptr, gpointer src_ptr, int count)
2598 {
2599         HEAVY_STAT (++stat_wbarrier_arrayref_copy);
2600         /*This check can be done without taking a lock since dest_ptr array is pinned*/
2601         if (ptr_in_nursery (dest_ptr) || count <= 0) {
2602                 mono_gc_memmove_aligned (dest_ptr, src_ptr, count * sizeof (gpointer));
2603                 return;
2604         }
2605
2606 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
2607         if (binary_protocol_is_heavy_enabled ()) {
2608                 int i;
2609                 for (i = 0; i < count; ++i) {
2610                         gpointer dest = (gpointer*)dest_ptr + i;
2611                         gpointer obj = *((gpointer*)src_ptr + i);
2612                         if (obj)
2613                                 binary_protocol_wbarrier (dest, obj, (gpointer)LOAD_VTABLE (obj));
2614                 }
2615         }
2616 #endif
2617
2618         remset.wbarrier_arrayref_copy (dest_ptr, src_ptr, count);
2619 }
2620
2621 void
2622 mono_gc_wbarrier_generic_nostore (gpointer ptr)
2623 {
2624         gpointer obj;
2625
2626         HEAVY_STAT (++stat_wbarrier_generic_store);
2627
2628         sgen_client_wbarrier_generic_nostore_check (ptr);
2629
2630         obj = *(gpointer*)ptr;
2631         if (obj)
2632                 binary_protocol_wbarrier (ptr, obj, (gpointer)LOAD_VTABLE (obj));
2633
2634         /*
2635          * We need to record old->old pointer locations for the
2636          * concurrent collector.
2637          */
2638         if (!ptr_in_nursery (obj) && !concurrent_collection_in_progress) {
2639                 SGEN_LOG (8, "Skipping remset at %p", ptr);
2640                 return;
2641         }
2642
2643         SGEN_LOG (8, "Adding remset at %p", ptr);
2644
2645         remset.wbarrier_generic_nostore (ptr);
2646 }
2647
2648 void
2649 mono_gc_wbarrier_generic_store (gpointer ptr, GCObject* value)
2650 {
2651         SGEN_LOG (8, "Wbarrier store at %p to %p (%s)", ptr, value, value ? sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (value)) : "null");
2652         SGEN_UPDATE_REFERENCE_ALLOW_NULL (ptr, value);
2653         if (ptr_in_nursery (value) || concurrent_collection_in_progress)
2654                 mono_gc_wbarrier_generic_nostore (ptr);
2655         sgen_dummy_use (value);
2656 }
2657
2658 /* Same as mono_gc_wbarrier_generic_store () but performs the store
2659  * as an atomic operation with release semantics.
2660  */
2661 void
2662 mono_gc_wbarrier_generic_store_atomic (gpointer ptr, GCObject *value)
2663 {
2664         HEAVY_STAT (++stat_wbarrier_generic_store_atomic);
2665
2666         SGEN_LOG (8, "Wbarrier atomic store at %p to %p (%s)", ptr, value, value ? sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (value)) : "null");
2667
2668         InterlockedWritePointer ((volatile gpointer *)ptr, value);
2669
2670         if (ptr_in_nursery (value) || concurrent_collection_in_progress)
2671                 mono_gc_wbarrier_generic_nostore (ptr);
2672
2673         sgen_dummy_use (value);
2674 }
2675
2676 void
2677 sgen_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap)
2678 {
2679         GCObject **dest = (GCObject **)_dest;
2680         GCObject **src = (GCObject **)_src;
2681
2682         while (size) {
2683                 if (bitmap & 0x1)
2684                         mono_gc_wbarrier_generic_store (dest, *src);
2685                 else
2686                         *dest = *src;
2687                 ++src;
2688                 ++dest;
2689                 size -= SIZEOF_VOID_P;
2690                 bitmap >>= 1;
2691         }
2692 }
2693
2694 /*
2695  * ######################################################################
2696  * ########  Other mono public interface functions.
2697  * ######################################################################
2698  */
2699
2700 void
2701 sgen_gc_collect (int generation)
2702 {
2703         LOCK_GC;
2704         if (generation > 1)
2705                 generation = 1;
2706         sgen_perform_collection (0, generation, "user request", TRUE);
2707         UNLOCK_GC;
2708 }
2709
2710 int
2711 sgen_gc_collection_count (int generation)
2712 {
2713         if (generation == 0)
2714                 return gc_stats.minor_gc_count;
2715         return gc_stats.major_gc_count;
2716 }
2717
2718 size_t
2719 sgen_gc_get_used_size (void)
2720 {
2721         gint64 tot = 0;
2722         LOCK_GC;
2723         tot = los_memory_usage;
2724         tot += nursery_section->next_data - nursery_section->data;
2725         tot += major_collector.get_used_size ();
2726         /* FIXME: account for pinned objects */
2727         UNLOCK_GC;
2728         return tot;
2729 }
2730
2731 void
2732 sgen_env_var_error (const char *env_var, const char *fallback, const char *description_format, ...)
2733 {
2734         va_list ap;
2735
2736         va_start (ap, description_format);
2737
2738         fprintf (stderr, "Warning: In environment variable `%s': ", env_var);
2739         vfprintf (stderr, description_format, ap);
2740         if (fallback)
2741                 fprintf (stderr, " - %s", fallback);
2742         fprintf (stderr, "\n");
2743
2744         va_end (ap);
2745 }
2746
2747 static gboolean
2748 parse_double_in_interval (const char *env_var, const char *opt_name, const char *opt, double min, double max, double *result)
2749 {
2750         char *endptr;
2751         double val = strtod (opt, &endptr);
2752         if (endptr == opt) {
2753                 sgen_env_var_error (env_var, "Using default value.", "`%s` must be a number.", opt_name);
2754                 return FALSE;
2755         }
2756         else if (val < min || val > max) {
2757                 sgen_env_var_error (env_var, "Using default value.", "`%s` must be between %.2f - %.2f.", opt_name, min, max);
2758                 return FALSE;
2759         }
2760         *result = val;
2761         return TRUE;
2762 }
2763
2764 void
2765 sgen_gc_init (void)
2766 {
2767         const char *env;
2768         char **opts, **ptr;
2769         char *major_collector_opt = NULL;
2770         char *minor_collector_opt = NULL;
2771         size_t max_heap = 0;
2772         size_t soft_limit = 0;
2773         int result;
2774         gboolean debug_print_allowance = FALSE;
2775         double allowance_ratio = 0, save_target = 0;
2776         gboolean cement_enabled = TRUE;
2777
2778         do {
2779                 result = InterlockedCompareExchange (&gc_initialized, -1, 0);
2780                 switch (result) {
2781                 case 1:
2782                         /* already inited */
2783                         return;
2784                 case -1:
2785                         /* being inited by another thread */
2786                         mono_thread_info_usleep (1000);
2787                         break;
2788                 case 0:
2789                         /* we will init it */
2790                         break;
2791                 default:
2792                         g_assert_not_reached ();
2793                 }
2794         } while (result != 0);
2795
2796         SGEN_TV_GETTIME (sgen_init_timestamp);
2797
2798 #ifdef SGEN_WITHOUT_MONO
2799         mono_thread_smr_init ();
2800 #endif
2801
2802         mono_coop_mutex_init (&gc_mutex);
2803
2804         gc_debug_file = stderr;
2805
2806         mono_coop_mutex_init (&sgen_interruption_mutex);
2807
2808         if ((env = g_getenv (MONO_GC_PARAMS_NAME))) {
2809                 opts = g_strsplit (env, ",", -1);
2810                 for (ptr = opts; *ptr; ++ptr) {
2811                         char *opt = *ptr;
2812                         if (g_str_has_prefix (opt, "major=")) {
2813                                 opt = strchr (opt, '=') + 1;
2814                                 major_collector_opt = g_strdup (opt);
2815                         } else if (g_str_has_prefix (opt, "minor=")) {
2816                                 opt = strchr (opt, '=') + 1;
2817                                 minor_collector_opt = g_strdup (opt);
2818                         }
2819                 }
2820         } else {
2821                 opts = NULL;
2822         }
2823
2824         init_stats ();
2825         sgen_init_internal_allocator ();
2826         sgen_init_nursery_allocator ();
2827         sgen_init_fin_weak_hash ();
2828         sgen_init_hash_table ();
2829         sgen_init_descriptors ();
2830         sgen_init_gray_queues ();
2831         sgen_init_allocator ();
2832         sgen_init_gchandles ();
2833
2834         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_SECTION, SGEN_SIZEOF_GC_MEM_SECTION);
2835         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_GRAY_QUEUE, sizeof (GrayQueueSection));
2836
2837         sgen_client_init ();
2838
2839         if (!minor_collector_opt) {
2840                 sgen_simple_nursery_init (&sgen_minor_collector);
2841         } else {
2842                 if (!strcmp (minor_collector_opt, "simple")) {
2843                 use_simple_nursery:
2844                         sgen_simple_nursery_init (&sgen_minor_collector);
2845                 } else if (!strcmp (minor_collector_opt, "split")) {
2846                         sgen_split_nursery_init (&sgen_minor_collector);
2847                 } else {
2848                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using `simple` instead.", "Unknown minor collector `%s'.", minor_collector_opt);
2849                         goto use_simple_nursery;
2850                 }
2851         }
2852
2853         if (!major_collector_opt || !strcmp (major_collector_opt, "marksweep")) {
2854         use_marksweep_major:
2855                 sgen_marksweep_init (&major_collector);
2856         } else if (!major_collector_opt || !strcmp (major_collector_opt, "marksweep-conc")) {
2857                 sgen_marksweep_conc_init (&major_collector);
2858         } else {
2859                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using `marksweep` instead.", "Unknown major collector `%s'.", major_collector_opt);
2860                 goto use_marksweep_major;
2861         }
2862
2863         sgen_nursery_size = DEFAULT_NURSERY_SIZE;
2864
2865         if (opts) {
2866                 gboolean usage_printed = FALSE;
2867
2868                 for (ptr = opts; *ptr; ++ptr) {
2869                         char *opt = *ptr;
2870                         if (!strcmp (opt, ""))
2871                                 continue;
2872                         if (g_str_has_prefix (opt, "major="))
2873                                 continue;
2874                         if (g_str_has_prefix (opt, "minor="))
2875                                 continue;
2876                         if (g_str_has_prefix (opt, "max-heap-size=")) {
2877                                 size_t page_size = mono_pagesize ();
2878                                 size_t max_heap_candidate = 0;
2879                                 opt = strchr (opt, '=') + 1;
2880                                 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &max_heap_candidate)) {
2881                                         max_heap = (max_heap_candidate + page_size - 1) & ~(size_t)(page_size - 1);
2882                                         if (max_heap != max_heap_candidate)
2883                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Rounding up.", "`max-heap-size` size must be a multiple of %d.", page_size);
2884                                 } else {
2885                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`max-heap-size` must be an integer.");
2886                                 }
2887                                 continue;
2888                         }
2889                         if (g_str_has_prefix (opt, "soft-heap-limit=")) {
2890                                 opt = strchr (opt, '=') + 1;
2891                                 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &soft_limit)) {
2892                                         if (soft_limit <= 0) {
2893                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`soft-heap-limit` must be positive.");
2894                                                 soft_limit = 0;
2895                                         }
2896                                 } else {
2897                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`soft-heap-limit` must be an integer.");
2898                                 }
2899                                 continue;
2900                         }
2901
2902 #ifdef USER_CONFIG
2903                         if (g_str_has_prefix (opt, "nursery-size=")) {
2904                                 size_t val;
2905                                 opt = strchr (opt, '=') + 1;
2906                                 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &val)) {
2907                                         if ((val & (val - 1))) {
2908                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.", "`nursery-size` must be a power of two.");
2909                                                 continue;
2910                                         }
2911
2912                                         if (val < SGEN_MAX_NURSERY_WASTE) {
2913                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.",
2914                                                                 "`nursery-size` must be at least %d bytes.", SGEN_MAX_NURSERY_WASTE);
2915                                                 continue;
2916                                         }
2917
2918                                         sgen_nursery_size = val;
2919                                         sgen_nursery_bits = 0;
2920                                         while (ONE_P << (++ sgen_nursery_bits) != sgen_nursery_size)
2921                                                 ;
2922                                 } else {
2923                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.", "`nursery-size` must be an integer.");
2924                                         continue;
2925                                 }
2926                                 continue;
2927                         }
2928 #endif
2929                         if (g_str_has_prefix (opt, "save-target-ratio=")) {
2930                                 double val;
2931                                 opt = strchr (opt, '=') + 1;
2932                                 if (parse_double_in_interval (MONO_GC_PARAMS_NAME, "save-target-ratio", opt,
2933                                                 SGEN_MIN_SAVE_TARGET_RATIO, SGEN_MAX_SAVE_TARGET_RATIO, &val)) {
2934                                         save_target = val;
2935                                 }
2936                                 continue;
2937                         }
2938                         if (g_str_has_prefix (opt, "default-allowance-ratio=")) {
2939                                 double val;
2940                                 opt = strchr (opt, '=') + 1;
2941                                 if (parse_double_in_interval (MONO_GC_PARAMS_NAME, "default-allowance-ratio", opt,
2942                                                 SGEN_MIN_ALLOWANCE_NURSERY_SIZE_RATIO, SGEN_MIN_ALLOWANCE_NURSERY_SIZE_RATIO, &val)) {
2943                                         allowance_ratio = val;
2944                                 }
2945                                 continue;
2946                         }
2947
2948                         if (!strcmp (opt, "cementing")) {
2949                                 cement_enabled = TRUE;
2950                                 continue;
2951                         }
2952                         if (!strcmp (opt, "no-cementing")) {
2953                                 cement_enabled = FALSE;
2954                                 continue;
2955                         }
2956
2957                         if (!strcmp (opt, "precleaning")) {
2958                                 precleaning_enabled = TRUE;
2959                                 continue;
2960                         }
2961                         if (!strcmp (opt, "no-precleaning")) {
2962                                 precleaning_enabled = FALSE;
2963                                 continue;
2964                         }
2965
2966                         if (major_collector.handle_gc_param && major_collector.handle_gc_param (opt))
2967                                 continue;
2968
2969                         if (sgen_minor_collector.handle_gc_param && sgen_minor_collector.handle_gc_param (opt))
2970                                 continue;
2971
2972                         if (sgen_client_handle_gc_param (opt))
2973                                 continue;
2974
2975                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Ignoring.", "Unknown option `%s`.", opt);
2976
2977                         if (usage_printed)
2978                                 continue;
2979
2980                         fprintf (stderr, "\n%s must be a comma-delimited list of one or more of the following:\n", MONO_GC_PARAMS_NAME);
2981                         fprintf (stderr, "  max-heap-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
2982                         fprintf (stderr, "  soft-heap-limit=n (where N is an integer, possibly with a k, m or a g suffix)\n");
2983                         fprintf (stderr, "  nursery-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
2984                         fprintf (stderr, "  major=COLLECTOR (where COLLECTOR is `marksweep', `marksweep-conc', `marksweep-par')\n");
2985                         fprintf (stderr, "  minor=COLLECTOR (where COLLECTOR is `simple' or `split')\n");
2986                         fprintf (stderr, "  wbarrier=WBARRIER (where WBARRIER is `remset' or `cardtable')\n");
2987                         fprintf (stderr, "  [no-]cementing\n");
2988                         if (major_collector.print_gc_param_usage)
2989                                 major_collector.print_gc_param_usage ();
2990                         if (sgen_minor_collector.print_gc_param_usage)
2991                                 sgen_minor_collector.print_gc_param_usage ();
2992                         sgen_client_print_gc_params_usage ();
2993                         fprintf (stderr, " Experimental options:\n");
2994                         fprintf (stderr, "  save-target-ratio=R (where R must be between %.2f - %.2f).\n", SGEN_MIN_SAVE_TARGET_RATIO, SGEN_MAX_SAVE_TARGET_RATIO);
2995                         fprintf (stderr, "  default-allowance-ratio=R (where R must be between %.2f - %.2f).\n", SGEN_MIN_ALLOWANCE_NURSERY_SIZE_RATIO, SGEN_MAX_ALLOWANCE_NURSERY_SIZE_RATIO);
2996                         fprintf (stderr, "\n");
2997
2998                         usage_printed = TRUE;
2999                 }
3000                 g_strfreev (opts);
3001         }
3002
3003         if (major_collector_opt)
3004                 g_free (major_collector_opt);
3005
3006         if (minor_collector_opt)
3007                 g_free (minor_collector_opt);
3008
3009         alloc_nursery ();
3010
3011         sgen_cement_init (cement_enabled);
3012
3013         if ((env = g_getenv (MONO_GC_DEBUG_NAME))) {
3014                 gboolean usage_printed = FALSE;
3015
3016                 opts = g_strsplit (env, ",", -1);
3017                 for (ptr = opts; ptr && *ptr; ptr ++) {
3018                         char *opt = *ptr;
3019                         if (!strcmp (opt, ""))
3020                                 continue;
3021                         if (opt [0] >= '0' && opt [0] <= '9') {
3022                                 gc_debug_level = atoi (opt);
3023                                 opt++;
3024                                 if (opt [0] == ':')
3025                                         opt++;
3026                                 if (opt [0]) {
3027                                         char *rf = g_strdup_printf ("%s.%d", opt, mono_process_current_pid ());
3028                                         gc_debug_file = fopen (rf, "wb");
3029                                         if (!gc_debug_file)
3030                                                 gc_debug_file = stderr;
3031                                         g_free (rf);
3032                                 }
3033                         } else if (!strcmp (opt, "print-allowance")) {
3034                                 debug_print_allowance = TRUE;
3035                         } else if (!strcmp (opt, "print-pinning")) {
3036                                 sgen_pin_stats_enable ();
3037                         } else if (!strcmp (opt, "verify-before-allocs")) {
3038                                 verify_before_allocs = 1;
3039                                 has_per_allocation_action = TRUE;
3040                         } else if (g_str_has_prefix (opt, "verify-before-allocs=")) {
3041                                 char *arg = strchr (opt, '=') + 1;
3042                                 verify_before_allocs = atoi (arg);
3043                                 has_per_allocation_action = TRUE;
3044                         } else if (!strcmp (opt, "collect-before-allocs")) {
3045                                 collect_before_allocs = 1;
3046                                 has_per_allocation_action = TRUE;
3047                         } else if (g_str_has_prefix (opt, "collect-before-allocs=")) {
3048                                 char *arg = strchr (opt, '=') + 1;
3049                                 has_per_allocation_action = TRUE;
3050                                 collect_before_allocs = atoi (arg);
3051                         } else if (!strcmp (opt, "verify-before-collections")) {
3052                                 whole_heap_check_before_collection = TRUE;
3053                         } else if (!strcmp (opt, "check-at-minor-collections")) {
3054                                 consistency_check_at_minor_collection = TRUE;
3055                                 nursery_clear_policy = CLEAR_AT_GC;
3056                         } else if (!strcmp (opt, "mod-union-consistency-check")) {
3057                                 if (!major_collector.is_concurrent) {
3058                                         sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "`mod-union-consistency-check` only works with concurrent major collector.");
3059                                         continue;
3060                                 }
3061                                 mod_union_consistency_check = TRUE;
3062                         } else if (!strcmp (opt, "check-mark-bits")) {
3063                                 check_mark_bits_after_major_collection = TRUE;
3064                         } else if (!strcmp (opt, "check-nursery-pinned")) {
3065                                 check_nursery_objects_pinned = TRUE;
3066                         } else if (!strcmp (opt, "clear-at-gc")) {
3067                                 nursery_clear_policy = CLEAR_AT_GC;
3068                         } else if (!strcmp (opt, "clear-nursery-at-gc")) {
3069                                 nursery_clear_policy = CLEAR_AT_GC;
3070                         } else if (!strcmp (opt, "clear-at-tlab-creation")) {
3071                                 nursery_clear_policy = CLEAR_AT_TLAB_CREATION;
3072                         } else if (!strcmp (opt, "debug-clear-at-tlab-creation")) {
3073                                 nursery_clear_policy = CLEAR_AT_TLAB_CREATION_DEBUG;
3074                         } else if (!strcmp (opt, "check-scan-starts")) {
3075                                 do_scan_starts_check = TRUE;
3076                         } else if (!strcmp (opt, "verify-nursery-at-minor-gc")) {
3077                                 do_verify_nursery = TRUE;
3078                         } else if (!strcmp (opt, "check-concurrent")) {
3079                                 if (!major_collector.is_concurrent) {
3080                                         sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "`check-concurrent` only works with concurrent major collectors.");
3081                                         continue;
3082                                 }
3083                                 nursery_clear_policy = CLEAR_AT_GC;
3084                                 do_concurrent_checks = TRUE;
3085                         } else if (!strcmp (opt, "dump-nursery-at-minor-gc")) {
3086                                 do_dump_nursery_content = TRUE;
3087                         } else if (!strcmp (opt, "disable-minor")) {
3088                                 disable_minor_collections = TRUE;
3089                         } else if (!strcmp (opt, "disable-major")) {
3090                                 disable_major_collections = TRUE;
3091                         } else if (g_str_has_prefix (opt, "heap-dump=")) {
3092                                 char *filename = strchr (opt, '=') + 1;
3093                                 nursery_clear_policy = CLEAR_AT_GC;
3094                                 sgen_debug_enable_heap_dump (filename);
3095                         } else if (g_str_has_prefix (opt, "binary-protocol=")) {
3096                                 char *filename = strchr (opt, '=') + 1;
3097                                 char *colon = strrchr (filename, ':');
3098                                 size_t limit = 0;
3099                                 if (colon) {
3100                                         if (!mono_gc_parse_environment_string_extract_number (colon + 1, &limit)) {
3101                                                 sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring limit.", "Binary protocol file size limit must be an integer.");
3102                                                 limit = -1;
3103                                         }
3104                                         *colon = '\0';
3105                                 }
3106                                 binary_protocol_init (filename, (long long)limit);
3107                         } else if (!strcmp (opt, "nursery-canaries")) {
3108                                 do_verify_nursery = TRUE;
3109                                 enable_nursery_canaries = TRUE;
3110                         } else if (!sgen_client_handle_gc_debug (opt)) {
3111                                 sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "Unknown option `%s`.", opt);
3112
3113                                 if (usage_printed)
3114                                         continue;
3115
3116                                 fprintf (stderr, "\n%s must be of the format [<l>[:<filename>]|<option>]+ where <l> is a debug level 0-9.\n", MONO_GC_DEBUG_NAME);
3117                                 fprintf (stderr, "Valid <option>s are:\n");
3118                                 fprintf (stderr, "  collect-before-allocs[=<n>]\n");
3119                                 fprintf (stderr, "  verify-before-allocs[=<n>]\n");
3120                                 fprintf (stderr, "  check-at-minor-collections\n");
3121                                 fprintf (stderr, "  check-mark-bits\n");
3122                                 fprintf (stderr, "  check-nursery-pinned\n");
3123                                 fprintf (stderr, "  verify-before-collections\n");
3124                                 fprintf (stderr, "  verify-nursery-at-minor-gc\n");
3125                                 fprintf (stderr, "  dump-nursery-at-minor-gc\n");
3126                                 fprintf (stderr, "  disable-minor\n");
3127                                 fprintf (stderr, "  disable-major\n");
3128                                 fprintf (stderr, "  check-concurrent\n");
3129                                 fprintf (stderr, "  clear-[nursery-]at-gc\n");
3130                                 fprintf (stderr, "  clear-at-tlab-creation\n");
3131                                 fprintf (stderr, "  debug-clear-at-tlab-creation\n");
3132                                 fprintf (stderr, "  check-scan-starts\n");
3133                                 fprintf (stderr, "  print-allowance\n");
3134                                 fprintf (stderr, "  print-pinning\n");
3135                                 fprintf (stderr, "  heap-dump=<filename>\n");
3136                                 fprintf (stderr, "  binary-protocol=<filename>[:<file-size-limit>]\n");
3137                                 fprintf (stderr, "  nursery-canaries\n");
3138                                 sgen_client_print_gc_debug_usage ();
3139                                 fprintf (stderr, "\n");
3140
3141                                 usage_printed = TRUE;
3142                         }
3143                 }
3144                 g_strfreev (opts);
3145         }
3146
3147         if (check_mark_bits_after_major_collection)
3148                 nursery_clear_policy = CLEAR_AT_GC;
3149
3150         if (major_collector.post_param_init)
3151                 major_collector.post_param_init (&major_collector);
3152
3153         if (major_collector.needs_thread_pool)
3154                 sgen_workers_init (1);
3155
3156         sgen_memgov_init (max_heap, soft_limit, debug_print_allowance, allowance_ratio, save_target);
3157
3158         memset (&remset, 0, sizeof (remset));
3159
3160         sgen_card_table_init (&remset);
3161
3162         sgen_register_root (NULL, 0, sgen_make_user_root_descriptor (sgen_mark_normal_gc_handles), ROOT_TYPE_NORMAL, MONO_ROOT_SOURCE_GC_HANDLE, "normal gc handles");
3163
3164         gc_initialized = 1;
3165 }
3166
3167 NurseryClearPolicy
3168 sgen_get_nursery_clear_policy (void)
3169 {
3170         return nursery_clear_policy;
3171 }
3172
3173 void
3174 sgen_gc_lock (void)
3175 {
3176         mono_coop_mutex_lock (&gc_mutex);
3177 }
3178
3179 void
3180 sgen_gc_unlock (void)
3181 {
3182         mono_coop_mutex_unlock (&gc_mutex);
3183 }
3184
3185 void
3186 sgen_major_collector_iterate_live_block_ranges (sgen_cardtable_block_callback callback)
3187 {
3188         major_collector.iterate_live_block_ranges (callback);
3189 }
3190
3191 SgenMajorCollector*
3192 sgen_get_major_collector (void)
3193 {
3194         return &major_collector;
3195 }
3196
3197 SgenRememberedSet*
3198 sgen_get_remset (void)
3199 {
3200         return &remset;
3201 }
3202
3203 static void
3204 count_cards (long long *major_total, long long *major_marked, long long *los_total, long long *los_marked)
3205 {
3206         sgen_get_major_collector ()->count_cards (major_total, major_marked);
3207         sgen_los_count_cards (los_total, los_marked);
3208 }
3209
3210 static gboolean world_is_stopped = FALSE;
3211
3212 /* LOCKING: assumes the GC lock is held */
3213 void
3214 sgen_stop_world (int generation)
3215 {
3216         long long major_total = -1, major_marked = -1, los_total = -1, los_marked = -1;
3217
3218         SGEN_ASSERT (0, !world_is_stopped, "Why are we stopping a stopped world?");
3219
3220         binary_protocol_world_stopping (generation, sgen_timestamp (), (gpointer) (gsize) mono_native_thread_id_get ());
3221
3222         sgen_client_stop_world (generation);
3223
3224         world_is_stopped = TRUE;
3225
3226         if (binary_protocol_is_heavy_enabled ())
3227                 count_cards (&major_total, &major_marked, &los_total, &los_marked);
3228         binary_protocol_world_stopped (generation, sgen_timestamp (), major_total, major_marked, los_total, los_marked);
3229 }
3230
3231 /* LOCKING: assumes the GC lock is held */
3232 void
3233 sgen_restart_world (int generation, GGTimingInfo *timing)
3234 {
3235         long long major_total = -1, major_marked = -1, los_total = -1, los_marked = -1;
3236
3237         SGEN_ASSERT (0, world_is_stopped, "Why are we restarting a running world?");
3238
3239         if (binary_protocol_is_heavy_enabled ())
3240                 count_cards (&major_total, &major_marked, &los_total, &los_marked);
3241         binary_protocol_world_restarting (generation, sgen_timestamp (), major_total, major_marked, los_total, los_marked);
3242
3243         sgen_client_restart_world (generation, timing);
3244
3245         world_is_stopped = FALSE;
3246
3247         binary_protocol_world_restarted (generation, sgen_timestamp ());
3248
3249         if (sgen_client_bridge_need_processing ())
3250                 sgen_client_bridge_processing_finish (generation);
3251
3252         sgen_memgov_collection_end (generation, timing, timing ? 2 : 0);
3253 }
3254
3255 gboolean
3256 sgen_is_world_stopped (void)
3257 {
3258         return world_is_stopped;
3259 }
3260
3261 void
3262 sgen_check_whole_heap_stw (void)
3263 {
3264         sgen_stop_world (0);
3265         sgen_clear_nursery_fragments ();
3266         sgen_check_whole_heap (FALSE);
3267         sgen_restart_world (0, NULL);
3268 }
3269
3270 gint64
3271 sgen_timestamp (void)
3272 {
3273         SGEN_TV_DECLARE (timestamp);
3274         SGEN_TV_GETTIME (timestamp);
3275         return SGEN_TV_ELAPSED (sgen_init_timestamp, timestamp);
3276 }
3277
3278 #endif /* HAVE_SGEN_GC */