Merge pull request #2803 from BrzVlad/feature-conc-pinned-scan
[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                 if (concurrent_collection_in_progress)
700                         sgen_pinning_register_pinned_in_nursery (obj_to_pin);
701
702         next_pin_queue_entry:
703                 last = addr;
704                 ++start;
705         }
706         sgen_client_nursery_objects_pinned (definitely_pinned, count);
707         stat_pinned_objects += count;
708         return count;
709 }
710
711 static void
712 pin_objects_in_nursery (gboolean do_scan_objects, ScanCopyContext ctx)
713 {
714         size_t reduced_to;
715
716         if (nursery_section->pin_queue_first_entry == nursery_section->pin_queue_last_entry)
717                 return;
718
719         reduced_to = pin_objects_from_nursery_pin_queue (do_scan_objects, ctx);
720         nursery_section->pin_queue_last_entry = nursery_section->pin_queue_first_entry + reduced_to;
721 }
722
723 /*
724  * This function is only ever called (via `collector_pin_object()` in `sgen-copy-object.h`)
725  * when we can't promote an object because we're out of memory.
726  */
727 void
728 sgen_pin_object (GCObject *object, GrayQueue *queue)
729 {
730         /*
731          * All pinned objects are assumed to have been staged, so we need to stage as well.
732          * Also, the count of staged objects shows that "late pinning" happened.
733          */
734         sgen_pin_stage_ptr (object);
735
736         SGEN_PIN_OBJECT (object);
737         binary_protocol_pin (object, (gpointer)LOAD_VTABLE (object), safe_object_get_size (object));
738
739         ++objects_pinned;
740         sgen_pin_stats_register_object (object, safe_object_get_size (object));
741
742         GRAY_OBJECT_ENQUEUE (queue, object, sgen_obj_get_descriptor_safe (object));
743 }
744
745 /* Sort the addresses in array in increasing order.
746  * Done using a by-the book heap sort. Which has decent and stable performance, is pretty cache efficient.
747  */
748 void
749 sgen_sort_addresses (void **array, size_t size)
750 {
751         size_t i;
752         void *tmp;
753
754         for (i = 1; i < size; ++i) {
755                 size_t child = i;
756                 while (child > 0) {
757                         size_t parent = (child - 1) / 2;
758
759                         if (array [parent] >= array [child])
760                                 break;
761
762                         tmp = array [parent];
763                         array [parent] = array [child];
764                         array [child] = tmp;
765
766                         child = parent;
767                 }
768         }
769
770         for (i = size - 1; i > 0; --i) {
771                 size_t end, root;
772                 tmp = array [i];
773                 array [i] = array [0];
774                 array [0] = tmp;
775
776                 end = i - 1;
777                 root = 0;
778
779                 while (root * 2 + 1 <= end) {
780                         size_t child = root * 2 + 1;
781
782                         if (child < end && array [child] < array [child + 1])
783                                 ++child;
784                         if (array [root] >= array [child])
785                                 break;
786
787                         tmp = array [root];
788                         array [root] = array [child];
789                         array [child] = tmp;
790
791                         root = child;
792                 }
793         }
794 }
795
796 /* 
797  * Scan the memory between start and end and queue values which could be pointers
798  * to the area between start_nursery and end_nursery for later consideration.
799  * Typically used for thread stacks.
800  */
801 void
802 sgen_conservatively_pin_objects_from (void **start, void **end, void *start_nursery, void *end_nursery, int pin_type)
803 {
804         int count = 0;
805
806         SGEN_ASSERT (0, ((mword)start & (SIZEOF_VOID_P - 1)) == 0, "Why are we scanning for references in unaligned memory ?");
807
808 #if defined(VALGRIND_MAKE_MEM_DEFINED_IF_ADDRESSABLE) && !defined(_WIN64)
809         VALGRIND_MAKE_MEM_DEFINED_IF_ADDRESSABLE (start, (char*)end - (char*)start);
810 #endif
811
812         while (start < end) {
813                 /*
814                  * *start can point to the middle of an object
815                  * note: should we handle pointing at the end of an object?
816                  * pinning in C# code disallows pointing at the end of an object
817                  * but there is some small chance that an optimizing C compiler
818                  * may keep the only reference to an object by pointing
819                  * at the end of it. We ignore this small chance for now.
820                  * Pointers to the end of an object are indistinguishable
821                  * from pointers to the start of the next object in memory
822                  * so if we allow that we'd need to pin two objects...
823                  * We queue the pointer in an array, the
824                  * array will then be sorted and uniqued. This way
825                  * we can coalesce several pinning pointers and it should
826                  * be faster since we'd do a memory scan with increasing
827                  * addresses. Note: we can align the address to the allocation
828                  * alignment, so the unique process is more effective.
829                  */
830                 mword addr = (mword)*start;
831                 addr &= ~(ALLOC_ALIGN - 1);
832                 if (addr >= (mword)start_nursery && addr < (mword)end_nursery) {
833                         SGEN_LOG (6, "Pinning address %p from %p", (void*)addr, start);
834                         sgen_pin_stage_ptr ((void*)addr);
835                         binary_protocol_pin_stage (start, (void*)addr);
836                         sgen_pin_stats_register_address ((char*)addr, pin_type);
837                         count++;
838                 }
839                 start++;
840         }
841         if (count)
842                 SGEN_LOG (7, "found %d potential pinned heap pointers", count);
843 }
844
845 /*
846  * The first thing we do in a collection is to identify pinned objects.
847  * This function considers all the areas of memory that need to be
848  * conservatively scanned.
849  */
850 static void
851 pin_from_roots (void *start_nursery, void *end_nursery, ScanCopyContext ctx)
852 {
853         void **start_root;
854         RootRecord *root;
855         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);
856         /* objects pinned from the API are inside these roots */
857         SGEN_HASH_TABLE_FOREACH (&roots_hash [ROOT_TYPE_PINNED], void **, start_root, RootRecord *, root) {
858                 SGEN_LOG (6, "Pinned roots %p-%p", start_root, root->end_root);
859                 sgen_conservatively_pin_objects_from (start_root, (void**)root->end_root, start_nursery, end_nursery, PIN_TYPE_OTHER);
860         } SGEN_HASH_TABLE_FOREACH_END;
861         /* now deal with the thread stacks
862          * in the future we should be able to conservatively scan only:
863          * *) the cpu registers
864          * *) the unmanaged stack frames
865          * *) the _last_ managed stack frame
866          * *) pointers slots in managed frames
867          */
868         sgen_client_scan_thread_data (start_nursery, end_nursery, FALSE, ctx);
869 }
870
871 static void
872 single_arg_user_copy_or_mark (GCObject **obj, void *gc_data)
873 {
874         ScanCopyContext *ctx = (ScanCopyContext *)gc_data;
875         ctx->ops->copy_or_mark_object (obj, ctx->queue);
876 }
877
878 /*
879  * The memory area from start_root to end_root contains pointers to objects.
880  * Their position is precisely described by @desc (this means that the pointer
881  * can be either NULL or the pointer to the start of an object).
882  * This functions copies them to to_space updates them.
883  *
884  * This function is not thread-safe!
885  */
886 static void
887 precisely_scan_objects_from (void** start_root, void** end_root, char* n_start, char *n_end, SgenDescriptor desc, ScanCopyContext ctx)
888 {
889         CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
890         SgenGrayQueue *queue = ctx.queue;
891
892         switch (desc & ROOT_DESC_TYPE_MASK) {
893         case ROOT_DESC_BITMAP:
894                 desc >>= ROOT_DESC_TYPE_SHIFT;
895                 while (desc) {
896                         if ((desc & 1) && *start_root) {
897                                 copy_func ((GCObject**)start_root, queue);
898                                 SGEN_LOG (9, "Overwrote root at %p with %p", start_root, *start_root);
899                         }
900                         desc >>= 1;
901                         start_root++;
902                 }
903                 return;
904         case ROOT_DESC_COMPLEX: {
905                 gsize *bitmap_data = (gsize *)sgen_get_complex_descriptor_bitmap (desc);
906                 gsize bwords = (*bitmap_data) - 1;
907                 void **start_run = start_root;
908                 bitmap_data++;
909                 while (bwords-- > 0) {
910                         gsize bmap = *bitmap_data++;
911                         void **objptr = start_run;
912                         while (bmap) {
913                                 if ((bmap & 1) && *objptr) {
914                                         copy_func ((GCObject**)objptr, queue);
915                                         SGEN_LOG (9, "Overwrote root at %p with %p", objptr, *objptr);
916                                 }
917                                 bmap >>= 1;
918                                 ++objptr;
919                         }
920                         start_run += GC_BITS_PER_WORD;
921                 }
922                 break;
923         }
924         case ROOT_DESC_USER: {
925                 SgenUserRootMarkFunc marker = sgen_get_user_descriptor_func (desc);
926                 marker (start_root, single_arg_user_copy_or_mark, &ctx);
927                 break;
928         }
929         case ROOT_DESC_RUN_LEN:
930                 g_assert_not_reached ();
931         default:
932                 g_assert_not_reached ();
933         }
934 }
935
936 static void
937 reset_heap_boundaries (void)
938 {
939         lowest_heap_address = ~(mword)0;
940         highest_heap_address = 0;
941 }
942
943 void
944 sgen_update_heap_boundaries (mword low, mword high)
945 {
946         mword old;
947
948         do {
949                 old = lowest_heap_address;
950                 if (low >= old)
951                         break;
952         } while (SGEN_CAS_PTR ((gpointer*)&lowest_heap_address, (gpointer)low, (gpointer)old) != (gpointer)old);
953
954         do {
955                 old = highest_heap_address;
956                 if (high <= old)
957                         break;
958         } while (SGEN_CAS_PTR ((gpointer*)&highest_heap_address, (gpointer)high, (gpointer)old) != (gpointer)old);
959 }
960
961 /*
962  * Allocate and setup the data structures needed to be able to allocate objects
963  * in the nursery. The nursery is stored in nursery_section.
964  */
965 static void
966 alloc_nursery (void)
967 {
968         GCMemSection *section;
969         char *data;
970         size_t scan_starts;
971         size_t alloc_size;
972
973         if (nursery_section)
974                 return;
975         SGEN_LOG (2, "Allocating nursery size: %zu", (size_t)sgen_nursery_size);
976         /* later we will alloc a larger area for the nursery but only activate
977          * what we need. The rest will be used as expansion if we have too many pinned
978          * objects in the existing nursery.
979          */
980         /* FIXME: handle OOM */
981         section = (GCMemSection *)sgen_alloc_internal (INTERNAL_MEM_SECTION);
982
983         alloc_size = sgen_nursery_size;
984
985         /* If there isn't enough space even for the nursery we should simply abort. */
986         g_assert (sgen_memgov_try_alloc_space (alloc_size, SPACE_NURSERY));
987
988         data = (char *)major_collector.alloc_heap (alloc_size, alloc_size, DEFAULT_NURSERY_BITS);
989         sgen_update_heap_boundaries ((mword)data, (mword)(data + sgen_nursery_size));
990         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 ());
991         section->data = section->next_data = data;
992         section->size = alloc_size;
993         section->end_data = data + sgen_nursery_size;
994         scan_starts = (alloc_size + SCAN_START_SIZE - 1) / SCAN_START_SIZE;
995         section->scan_starts = (char **)sgen_alloc_internal_dynamic (sizeof (char*) * scan_starts, INTERNAL_MEM_SCAN_STARTS, TRUE);
996         section->num_scan_start = scan_starts;
997
998         nursery_section = section;
999
1000         sgen_nursery_allocator_set_nursery_bounds (data, data + sgen_nursery_size);
1001 }
1002
1003 FILE *
1004 mono_gc_get_logfile (void)
1005 {
1006         return gc_debug_file;
1007 }
1008
1009 static void
1010 scan_finalizer_entries (SgenPointerQueue *fin_queue, ScanCopyContext ctx)
1011 {
1012         CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
1013         SgenGrayQueue *queue = ctx.queue;
1014         size_t i;
1015
1016         for (i = 0; i < fin_queue->next_slot; ++i) {
1017                 GCObject *obj = (GCObject *)fin_queue->data [i];
1018                 if (!obj)
1019                         continue;
1020                 SGEN_LOG (5, "Scan of fin ready object: %p (%s)\n", obj, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj)));
1021                 copy_func ((GCObject**)&fin_queue->data [i], queue);
1022         }
1023 }
1024
1025 static const char*
1026 generation_name (int generation)
1027 {
1028         switch (generation) {
1029         case GENERATION_NURSERY: return "nursery";
1030         case GENERATION_OLD: return "old";
1031         default: g_assert_not_reached ();
1032         }
1033 }
1034
1035 const char*
1036 sgen_generation_name (int generation)
1037 {
1038         return generation_name (generation);
1039 }
1040
1041 static void
1042 finish_gray_stack (int generation, ScanCopyContext ctx)
1043 {
1044         TV_DECLARE (atv);
1045         TV_DECLARE (btv);
1046         int done_with_ephemerons, ephemeron_rounds = 0;
1047         char *start_addr = generation == GENERATION_NURSERY ? sgen_get_nursery_start () : NULL;
1048         char *end_addr = generation == GENERATION_NURSERY ? sgen_get_nursery_end () : (char*)-1;
1049         SgenGrayQueue *queue = ctx.queue;
1050
1051         binary_protocol_finish_gray_stack_start (sgen_timestamp (), generation);
1052         /*
1053          * We copied all the reachable objects. Now it's the time to copy
1054          * the objects that were not referenced by the roots, but by the copied objects.
1055          * we built a stack of objects pointed to by gray_start: they are
1056          * additional roots and we may add more items as we go.
1057          * We loop until gray_start == gray_objects which means no more objects have
1058          * been added. Note this is iterative: no recursion is involved.
1059          * We need to walk the LO list as well in search of marked big objects
1060          * (use a flag since this is needed only on major collections). We need to loop
1061          * here as well, so keep a counter of marked LO (increasing it in copy_object).
1062          *   To achieve better cache locality and cache usage, we drain the gray stack 
1063          * frequently, after each object is copied, and just finish the work here.
1064          */
1065         sgen_drain_gray_stack (ctx);
1066         TV_GETTIME (atv);
1067         SGEN_LOG (2, "%s generation done", generation_name (generation));
1068
1069         /*
1070         Reset bridge data, we might have lingering data from a previous collection if this is a major
1071         collection trigged by minor overflow.
1072
1073         We must reset the gathered bridges since their original block might be evacuated due to major
1074         fragmentation in the meanwhile and the bridge code should not have to deal with that.
1075         */
1076         if (sgen_client_bridge_need_processing ())
1077                 sgen_client_bridge_reset_data ();
1078
1079         /*
1080          * Mark all strong toggleref objects. This must be done before we walk ephemerons or finalizers
1081          * to ensure they see the full set of live objects.
1082          */
1083         sgen_client_mark_togglerefs (start_addr, end_addr, ctx);
1084
1085         /*
1086          * Walk the ephemeron tables marking all values with reachable keys. This must be completely done
1087          * before processing finalizable objects and non-tracking weak links to avoid finalizing/clearing
1088          * objects that are in fact reachable.
1089          */
1090         done_with_ephemerons = 0;
1091         do {
1092                 done_with_ephemerons = sgen_client_mark_ephemerons (ctx);
1093                 sgen_drain_gray_stack (ctx);
1094                 ++ephemeron_rounds;
1095         } while (!done_with_ephemerons);
1096
1097         if (sgen_client_bridge_need_processing ()) {
1098                 /*Make sure the gray stack is empty before we process bridge objects so we get liveness right*/
1099                 sgen_drain_gray_stack (ctx);
1100                 sgen_collect_bridge_objects (generation, ctx);
1101                 if (generation == GENERATION_OLD)
1102                         sgen_collect_bridge_objects (GENERATION_NURSERY, ctx);
1103
1104                 /*
1105                 Do the first bridge step here, as the collector liveness state will become useless after that.
1106
1107                 An important optimization is to only proccess the possibly dead part of the object graph and skip
1108                 over all live objects as we transitively know everything they point must be alive too.
1109
1110                 The above invariant is completely wrong if we let the gray queue be drained and mark/copy everything.
1111
1112                 This has the unfortunate side effect of making overflow collections perform the first step twice, but
1113                 given we now have heuristics that perform major GC in anticipation of minor overflows this should not
1114                 be a big deal.
1115                 */
1116                 sgen_client_bridge_processing_stw_step ();
1117         }
1118
1119         /*
1120         Make sure we drain the gray stack before processing disappearing links and finalizers.
1121         If we don't make sure it is empty we might wrongly see a live object as dead.
1122         */
1123         sgen_drain_gray_stack (ctx);
1124
1125         /*
1126         We must clear weak links that don't track resurrection before processing object ready for
1127         finalization so they can be cleared before that.
1128         */
1129         sgen_null_link_in_range (generation, ctx, FALSE);
1130         if (generation == GENERATION_OLD)
1131                 sgen_null_link_in_range (GENERATION_NURSERY, ctx, FALSE);
1132
1133
1134         /* walk the finalization queue and move also the objects that need to be
1135          * finalized: use the finalized objects as new roots so the objects they depend
1136          * on are also not reclaimed. As with the roots above, only objects in the nursery
1137          * are marked/copied.
1138          */
1139         sgen_finalize_in_range (generation, ctx);
1140         if (generation == GENERATION_OLD)
1141                 sgen_finalize_in_range (GENERATION_NURSERY, ctx);
1142         /* drain the new stack that might have been created */
1143         SGEN_LOG (6, "Precise scan of gray area post fin");
1144         sgen_drain_gray_stack (ctx);
1145
1146         /*
1147          * This must be done again after processing finalizable objects since CWL slots are cleared only after the key is finalized.
1148          */
1149         done_with_ephemerons = 0;
1150         do {
1151                 done_with_ephemerons = sgen_client_mark_ephemerons (ctx);
1152                 sgen_drain_gray_stack (ctx);
1153                 ++ephemeron_rounds;
1154         } while (!done_with_ephemerons);
1155
1156         sgen_client_clear_unreachable_ephemerons (ctx);
1157
1158         /*
1159          * We clear togglerefs only after all possible chances of revival are done. 
1160          * This is semantically more inline with what users expect and it allows for
1161          * user finalizers to correctly interact with TR objects.
1162         */
1163         sgen_client_clear_togglerefs (start_addr, end_addr, ctx);
1164
1165         TV_GETTIME (btv);
1166         SGEN_LOG (2, "Finalize queue handling scan for %s generation: %lld usecs %d ephemeron rounds", generation_name (generation), TV_ELAPSED (atv, btv), ephemeron_rounds);
1167
1168         /*
1169          * handle disappearing links
1170          * Note we do this after checking the finalization queue because if an object
1171          * survives (at least long enough to be finalized) we don't clear the link.
1172          * This also deals with a possible issue with the monitor reclamation: with the Boehm
1173          * GC a finalized object my lose the monitor because it is cleared before the finalizer is
1174          * called.
1175          */
1176         g_assert (sgen_gray_object_queue_is_empty (queue));
1177         for (;;) {
1178                 sgen_null_link_in_range (generation, ctx, TRUE);
1179                 if (generation == GENERATION_OLD)
1180                         sgen_null_link_in_range (GENERATION_NURSERY, ctx, TRUE);
1181                 if (sgen_gray_object_queue_is_empty (queue))
1182                         break;
1183                 sgen_drain_gray_stack (ctx);
1184         }
1185
1186         g_assert (sgen_gray_object_queue_is_empty (queue));
1187
1188         sgen_gray_object_queue_trim_free_list (queue);
1189         binary_protocol_finish_gray_stack_end (sgen_timestamp (), generation);
1190 }
1191
1192 void
1193 sgen_check_section_scan_starts (GCMemSection *section)
1194 {
1195         size_t i;
1196         for (i = 0; i < section->num_scan_start; ++i) {
1197                 if (section->scan_starts [i]) {
1198                         mword size = safe_object_get_size ((GCObject*) section->scan_starts [i]);
1199                         SGEN_ASSERT (0, size >= SGEN_CLIENT_MINIMUM_OBJECT_SIZE && size <= MAX_SMALL_OBJ_SIZE, "Weird object size at scan starts.");
1200                 }
1201         }
1202 }
1203
1204 static void
1205 check_scan_starts (void)
1206 {
1207         if (!do_scan_starts_check)
1208                 return;
1209         sgen_check_section_scan_starts (nursery_section);
1210         major_collector.check_scan_starts ();
1211 }
1212
1213 static void
1214 scan_from_registered_roots (char *addr_start, char *addr_end, int root_type, ScanCopyContext ctx)
1215 {
1216         void **start_root;
1217         RootRecord *root;
1218         SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], void **, start_root, RootRecord *, root) {
1219                 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
1220                 precisely_scan_objects_from (start_root, (void**)root->end_root, addr_start, addr_end, root->root_desc, ctx);
1221         } SGEN_HASH_TABLE_FOREACH_END;
1222 }
1223
1224 static void
1225 init_stats (void)
1226 {
1227         static gboolean inited = FALSE;
1228
1229         if (inited)
1230                 return;
1231
1232         mono_counters_register ("Collection max time",  MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME | MONO_COUNTER_MONOTONIC, &time_max);
1233
1234         mono_counters_register ("Minor fragment clear", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_pre_collection_fragment_clear);
1235         mono_counters_register ("Minor pinning", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_pinning);
1236         mono_counters_register ("Minor scan remembered set", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_remsets);
1237         mono_counters_register ("Minor scan pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_pinned);
1238         mono_counters_register ("Minor scan roots", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_roots);
1239         mono_counters_register ("Minor fragment creation", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_fragment_creation);
1240
1241         mono_counters_register ("Major fragment clear", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_pre_collection_fragment_clear);
1242         mono_counters_register ("Major pinning", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_pinning);
1243         mono_counters_register ("Major scan pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_pinned);
1244         mono_counters_register ("Major scan roots", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_roots);
1245         mono_counters_register ("Major scan mod union", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_mod_union);
1246         mono_counters_register ("Major finish gray stack", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_finish_gray_stack);
1247         mono_counters_register ("Major free big objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_free_bigobjs);
1248         mono_counters_register ("Major LOS sweep", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_los_sweep);
1249         mono_counters_register ("Major sweep", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_sweep);
1250         mono_counters_register ("Major fragment creation", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_fragment_creation);
1251
1252         mono_counters_register ("Number of pinned objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_pinned_objects);
1253
1254 #ifdef HEAVY_STATISTICS
1255         mono_counters_register ("WBarrier remember pointer", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_add_to_global_remset);
1256         mono_counters_register ("WBarrier arrayref copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_arrayref_copy);
1257         mono_counters_register ("WBarrier generic store called", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_generic_store);
1258         mono_counters_register ("WBarrier generic atomic store called", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_generic_store_atomic);
1259         mono_counters_register ("WBarrier set root", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_set_root);
1260
1261         mono_counters_register ("# objects allocated degraded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_alloced_degraded);
1262         mono_counters_register ("bytes allocated degraded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_bytes_alloced_degraded);
1263
1264         mono_counters_register ("# copy_object() called (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copy_object_called_nursery);
1265         mono_counters_register ("# objects copied (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_copied_nursery);
1266         mono_counters_register ("# copy_object() called (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copy_object_called_major);
1267         mono_counters_register ("# objects copied (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_copied_major);
1268
1269         mono_counters_register ("# scan_object() called (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scan_object_called_nursery);
1270         mono_counters_register ("# scan_object() called (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scan_object_called_major);
1271
1272         mono_counters_register ("Slots allocated in vain", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_slots_allocated_in_vain);
1273
1274         mono_counters_register ("# nursery copy_object() failed from space", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_from_space);
1275         mono_counters_register ("# nursery copy_object() failed forwarded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_forwarded);
1276         mono_counters_register ("# nursery copy_object() failed pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_pinned);
1277         mono_counters_register ("# nursery copy_object() failed to space", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_to_space);
1278
1279         sgen_nursery_allocator_init_heavy_stats ();
1280 #endif
1281
1282         inited = TRUE;
1283 }
1284
1285
1286 static void
1287 reset_pinned_from_failed_allocation (void)
1288 {
1289         bytes_pinned_from_failed_allocation = 0;
1290 }
1291
1292 void
1293 sgen_set_pinned_from_failed_allocation (mword objsize)
1294 {
1295         bytes_pinned_from_failed_allocation += objsize;
1296 }
1297
1298 gboolean
1299 sgen_collection_is_concurrent (void)
1300 {
1301         switch (current_collection_generation) {
1302         case GENERATION_NURSERY:
1303                 return FALSE;
1304         case GENERATION_OLD:
1305                 return concurrent_collection_in_progress;
1306         default:
1307                 g_error ("Invalid current generation %d", current_collection_generation);
1308         }
1309         return FALSE;
1310 }
1311
1312 gboolean
1313 sgen_concurrent_collection_in_progress (void)
1314 {
1315         return concurrent_collection_in_progress;
1316 }
1317
1318 typedef struct {
1319         SgenThreadPoolJob job;
1320         SgenObjectOperations *ops;
1321 } ScanJob;
1322
1323 static void
1324 job_remembered_set_scan (void *worker_data_untyped, SgenThreadPoolJob *job)
1325 {
1326         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1327         ScanJob *job_data = (ScanJob*)job;
1328         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1329         remset.scan_remsets (ctx);
1330 }
1331
1332 typedef struct {
1333         SgenThreadPoolJob job;
1334         SgenObjectOperations *ops;
1335         char *heap_start;
1336         char *heap_end;
1337         int root_type;
1338 } ScanFromRegisteredRootsJob;
1339
1340 static void
1341 job_scan_from_registered_roots (void *worker_data_untyped, SgenThreadPoolJob *job)
1342 {
1343         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1344         ScanFromRegisteredRootsJob *job_data = (ScanFromRegisteredRootsJob*)job;
1345         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1346
1347         scan_from_registered_roots (job_data->heap_start, job_data->heap_end, job_data->root_type, ctx);
1348 }
1349
1350 typedef struct {
1351         SgenThreadPoolJob job;
1352         SgenObjectOperations *ops;
1353         char *heap_start;
1354         char *heap_end;
1355 } ScanThreadDataJob;
1356
1357 static void
1358 job_scan_thread_data (void *worker_data_untyped, SgenThreadPoolJob *job)
1359 {
1360         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1361         ScanThreadDataJob *job_data = (ScanThreadDataJob*)job;
1362         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1363
1364         sgen_client_scan_thread_data (job_data->heap_start, job_data->heap_end, TRUE, ctx);
1365 }
1366
1367 typedef struct {
1368         SgenThreadPoolJob job;
1369         SgenObjectOperations *ops;
1370         SgenPointerQueue *queue;
1371 } ScanFinalizerEntriesJob;
1372
1373 static void
1374 job_scan_finalizer_entries (void *worker_data_untyped, SgenThreadPoolJob *job)
1375 {
1376         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1377         ScanFinalizerEntriesJob *job_data = (ScanFinalizerEntriesJob*)job;
1378         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1379
1380         scan_finalizer_entries (job_data->queue, ctx);
1381 }
1382
1383 static void
1384 job_scan_major_mod_union_card_table (void *worker_data_untyped, SgenThreadPoolJob *job)
1385 {
1386         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1387         ScanJob *job_data = (ScanJob*)job;
1388         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1389
1390         g_assert (concurrent_collection_in_progress);
1391         major_collector.scan_card_table (CARDTABLE_SCAN_MOD_UNION, ctx);
1392 }
1393
1394 static void
1395 job_scan_los_mod_union_card_table (void *worker_data_untyped, SgenThreadPoolJob *job)
1396 {
1397         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1398         ScanJob *job_data = (ScanJob*)job;
1399         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1400
1401         g_assert (concurrent_collection_in_progress);
1402         sgen_los_scan_card_table (CARDTABLE_SCAN_MOD_UNION, ctx);
1403 }
1404
1405 static void
1406 job_mod_union_preclean (void *worker_data_untyped, SgenThreadPoolJob *job)
1407 {
1408         WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1409         ScanJob *job_data = (ScanJob*)job;
1410         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (job_data->ops, sgen_workers_get_job_gray_queue (worker_data));
1411
1412         g_assert (concurrent_collection_in_progress);
1413
1414         major_collector.scan_card_table (CARDTABLE_SCAN_MOD_UNION_PRECLEAN, ctx);
1415         sgen_los_scan_card_table (CARDTABLE_SCAN_MOD_UNION_PRECLEAN, ctx);
1416
1417         sgen_scan_pin_queue_objects (ctx);
1418 }
1419
1420 static void
1421 init_gray_queue (gboolean use_workers)
1422 {
1423         if (use_workers)
1424                 sgen_workers_init_distribute_gray_queue ();
1425         sgen_gray_object_queue_init (&gray_queue, NULL);
1426 }
1427
1428 static void
1429 enqueue_scan_from_roots_jobs (char *heap_start, char *heap_end, SgenObjectOperations *ops, gboolean enqueue)
1430 {
1431         ScanFromRegisteredRootsJob *scrrj;
1432         ScanThreadDataJob *stdj;
1433         ScanFinalizerEntriesJob *sfej;
1434
1435         /* registered roots, this includes static fields */
1436
1437         scrrj = (ScanFromRegisteredRootsJob*)sgen_thread_pool_job_alloc ("scan from registered roots normal", job_scan_from_registered_roots, sizeof (ScanFromRegisteredRootsJob));
1438         scrrj->ops = ops;
1439         scrrj->heap_start = heap_start;
1440         scrrj->heap_end = heap_end;
1441         scrrj->root_type = ROOT_TYPE_NORMAL;
1442         sgen_workers_enqueue_job (&scrrj->job, enqueue);
1443
1444         scrrj = (ScanFromRegisteredRootsJob*)sgen_thread_pool_job_alloc ("scan from registered roots wbarrier", job_scan_from_registered_roots, sizeof (ScanFromRegisteredRootsJob));
1445         scrrj->ops = ops;
1446         scrrj->heap_start = heap_start;
1447         scrrj->heap_end = heap_end;
1448         scrrj->root_type = ROOT_TYPE_WBARRIER;
1449         sgen_workers_enqueue_job (&scrrj->job, enqueue);
1450
1451         /* Threads */
1452
1453         stdj = (ScanThreadDataJob*)sgen_thread_pool_job_alloc ("scan thread data", job_scan_thread_data, sizeof (ScanThreadDataJob));
1454         stdj->heap_start = heap_start;
1455         stdj->heap_end = heap_end;
1456         sgen_workers_enqueue_job (&stdj->job, enqueue);
1457
1458         /* Scan the list of objects ready for finalization. */
1459
1460         sfej = (ScanFinalizerEntriesJob*)sgen_thread_pool_job_alloc ("scan finalizer entries", job_scan_finalizer_entries, sizeof (ScanFinalizerEntriesJob));
1461         sfej->queue = &fin_ready_queue;
1462         sfej->ops = ops;
1463         sgen_workers_enqueue_job (&sfej->job, enqueue);
1464
1465         sfej = (ScanFinalizerEntriesJob*)sgen_thread_pool_job_alloc ("scan critical finalizer entries", job_scan_finalizer_entries, sizeof (ScanFinalizerEntriesJob));
1466         sfej->queue = &critical_fin_queue;
1467         sfej->ops = ops;
1468         sgen_workers_enqueue_job (&sfej->job, enqueue);
1469 }
1470
1471 /*
1472  * Perform a nursery collection.
1473  *
1474  * Return whether any objects were late-pinned due to being out of memory.
1475  */
1476 static gboolean
1477 collect_nursery (SgenGrayQueue *unpin_queue, gboolean finish_up_concurrent_mark)
1478 {
1479         gboolean needs_major;
1480         size_t max_garbage_amount;
1481         char *nursery_next;
1482         mword fragment_total;
1483         ScanJob *sj;
1484         SgenObjectOperations *object_ops = &sgen_minor_collector.serial_ops;
1485         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (object_ops, &gray_queue);
1486         TV_DECLARE (atv);
1487         TV_DECLARE (btv);
1488
1489         if (disable_minor_collections)
1490                 return TRUE;
1491
1492         TV_GETTIME (last_minor_collection_start_tv);
1493         atv = last_minor_collection_start_tv;
1494
1495         binary_protocol_collection_begin (gc_stats.minor_gc_count, GENERATION_NURSERY);
1496
1497         if (do_verify_nursery || do_dump_nursery_content)
1498                 sgen_debug_verify_nursery (do_dump_nursery_content);
1499
1500         current_collection_generation = GENERATION_NURSERY;
1501
1502         SGEN_ASSERT (0, !sgen_collection_is_concurrent (), "Why is the nursery collection concurrent?");
1503
1504         reset_pinned_from_failed_allocation ();
1505
1506         check_scan_starts ();
1507
1508         sgen_nursery_alloc_prepare_for_minor ();
1509
1510         degraded_mode = 0;
1511         objects_pinned = 0;
1512         nursery_next = sgen_nursery_alloc_get_upper_alloc_bound ();
1513         /* FIXME: optimize later to use the higher address where an object can be present */
1514         nursery_next = MAX (nursery_next, sgen_get_nursery_end ());
1515
1516         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 ()));
1517         max_garbage_amount = nursery_next - sgen_get_nursery_start ();
1518         g_assert (nursery_section->size >= max_garbage_amount);
1519
1520         /* world must be stopped already */
1521         TV_GETTIME (btv);
1522         time_minor_pre_collection_fragment_clear += TV_ELAPSED (atv, btv);
1523
1524         sgen_client_pre_collection_checks ();
1525
1526         nursery_section->next_data = nursery_next;
1527
1528         major_collector.start_nursery_collection ();
1529
1530         sgen_memgov_minor_collection_start ();
1531
1532         init_gray_queue (FALSE);
1533
1534         gc_stats.minor_gc_count ++;
1535
1536         if (whole_heap_check_before_collection) {
1537                 sgen_clear_nursery_fragments ();
1538                 sgen_check_whole_heap (finish_up_concurrent_mark);
1539         }
1540         if (consistency_check_at_minor_collection)
1541                 sgen_check_consistency ();
1542
1543         sgen_process_fin_stage_entries ();
1544
1545         /* pin from pinned handles */
1546         sgen_init_pinning ();
1547         sgen_client_binary_protocol_mark_start (GENERATION_NURSERY);
1548         pin_from_roots (sgen_get_nursery_start (), nursery_next, ctx);
1549         /* pin cemented objects */
1550         sgen_pin_cemented_objects ();
1551         /* identify pinned objects */
1552         sgen_optimize_pin_queue ();
1553         sgen_pinning_setup_section (nursery_section);
1554
1555         pin_objects_in_nursery (FALSE, ctx);
1556         sgen_pinning_trim_queue_to_section (nursery_section);
1557
1558         TV_GETTIME (atv);
1559         time_minor_pinning += TV_ELAPSED (btv, atv);
1560         SGEN_LOG (2, "Finding pinned pointers: %zd in %lld usecs", sgen_get_pinned_count (), TV_ELAPSED (btv, atv));
1561         SGEN_LOG (4, "Start scan with %zd pinned objects", sgen_get_pinned_count ());
1562
1563         sj = (ScanJob*)sgen_thread_pool_job_alloc ("scan remset", job_remembered_set_scan, sizeof (ScanJob));
1564         sj->ops = object_ops;
1565         sgen_workers_enqueue_job (&sj->job, FALSE);
1566
1567         /* we don't have complete write barrier yet, so we scan all the old generation sections */
1568         TV_GETTIME (btv);
1569         time_minor_scan_remsets += TV_ELAPSED (atv, btv);
1570         SGEN_LOG (2, "Old generation scan: %lld usecs", TV_ELAPSED (atv, btv));
1571
1572         sgen_pin_stats_print_class_stats ();
1573
1574         /* FIXME: Why do we do this at this specific, seemingly random, point? */
1575         sgen_client_collecting_minor (&fin_ready_queue, &critical_fin_queue);
1576
1577         TV_GETTIME (atv);
1578         time_minor_scan_pinned += TV_ELAPSED (btv, atv);
1579
1580         enqueue_scan_from_roots_jobs (sgen_get_nursery_start (), nursery_next, object_ops, FALSE);
1581
1582         TV_GETTIME (btv);
1583         time_minor_scan_roots += TV_ELAPSED (atv, btv);
1584
1585         finish_gray_stack (GENERATION_NURSERY, ctx);
1586
1587         TV_GETTIME (atv);
1588         time_minor_finish_gray_stack += TV_ELAPSED (btv, atv);
1589         sgen_client_binary_protocol_mark_end (GENERATION_NURSERY);
1590
1591         if (objects_pinned) {
1592                 sgen_optimize_pin_queue ();
1593                 sgen_pinning_setup_section (nursery_section);
1594         }
1595
1596         /* walk the pin_queue, build up the fragment list of free memory, unmark
1597          * pinned objects as we go, memzero() the empty fragments so they are ready for the
1598          * next allocations.
1599          */
1600         sgen_client_binary_protocol_reclaim_start (GENERATION_NURSERY);
1601         fragment_total = sgen_build_nursery_fragments (nursery_section, unpin_queue);
1602         if (!fragment_total)
1603                 degraded_mode = 1;
1604
1605         /* Clear TLABs for all threads */
1606         sgen_clear_tlabs ();
1607
1608         sgen_client_binary_protocol_reclaim_end (GENERATION_NURSERY);
1609         TV_GETTIME (btv);
1610         time_minor_fragment_creation += TV_ELAPSED (atv, btv);
1611         SGEN_LOG (2, "Fragment creation: %lld usecs, %lu bytes available", TV_ELAPSED (atv, btv), (unsigned long)fragment_total);
1612
1613         if (consistency_check_at_minor_collection)
1614                 sgen_check_major_refs ();
1615
1616         major_collector.finish_nursery_collection ();
1617
1618         TV_GETTIME (last_minor_collection_end_tv);
1619         gc_stats.minor_gc_time += TV_ELAPSED (last_minor_collection_start_tv, last_minor_collection_end_tv);
1620
1621         sgen_debug_dump_heap ("minor", gc_stats.minor_gc_count - 1, NULL);
1622
1623         /* prepare the pin queue for the next collection */
1624         sgen_finish_pinning ();
1625         if (sgen_have_pending_finalizers ()) {
1626                 SGEN_LOG (4, "Finalizer-thread wakeup");
1627                 sgen_client_finalize_notify ();
1628         }
1629         sgen_pin_stats_reset ();
1630         /* clear cemented hash */
1631         sgen_cement_clear_below_threshold ();
1632
1633         g_assert (sgen_gray_object_queue_is_empty (&gray_queue));
1634
1635         remset.finish_minor_collection ();
1636
1637         check_scan_starts ();
1638
1639         binary_protocol_flush_buffers (FALSE);
1640
1641         sgen_memgov_minor_collection_end ();
1642
1643         /*objects are late pinned because of lack of memory, so a major is a good call*/
1644         needs_major = objects_pinned > 0;
1645         current_collection_generation = -1;
1646         objects_pinned = 0;
1647
1648         binary_protocol_collection_end (gc_stats.minor_gc_count - 1, GENERATION_NURSERY, 0, 0);
1649
1650         if (check_nursery_objects_pinned && !sgen_minor_collector.is_split)
1651                 sgen_check_nursery_objects_pinned (unpin_queue != NULL);
1652
1653         return needs_major;
1654 }
1655
1656 typedef enum {
1657         COPY_OR_MARK_FROM_ROOTS_SERIAL,
1658         COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT,
1659         COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT
1660 } CopyOrMarkFromRootsMode;
1661
1662 static void
1663 major_copy_or_mark_from_roots (size_t *old_next_pin_slot, CopyOrMarkFromRootsMode mode, SgenObjectOperations *object_ops)
1664 {
1665         LOSObject *bigobj;
1666         TV_DECLARE (atv);
1667         TV_DECLARE (btv);
1668         /* FIXME: only use these values for the precise scan
1669          * note that to_space pointers should be excluded anyway...
1670          */
1671         char *heap_start = NULL;
1672         char *heap_end = (char*)-1;
1673         ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (object_ops, WORKERS_DISTRIBUTE_GRAY_QUEUE);
1674         gboolean concurrent = mode != COPY_OR_MARK_FROM_ROOTS_SERIAL;
1675
1676         SGEN_ASSERT (0, !!concurrent == !!concurrent_collection_in_progress, "We've been called with the wrong mode.");
1677
1678         if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
1679                 /*This cleans up unused fragments */
1680                 sgen_nursery_allocator_prepare_for_pinning ();
1681
1682                 if (do_concurrent_checks)
1683                         sgen_debug_check_nursery_is_clean ();
1684         } else {
1685                 /* The concurrent collector doesn't touch the nursery. */
1686                 sgen_nursery_alloc_prepare_for_major ();
1687         }
1688
1689         init_gray_queue (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT);
1690
1691         TV_GETTIME (atv);
1692
1693         /* Pinning depends on this */
1694         sgen_clear_nursery_fragments ();
1695
1696         if (whole_heap_check_before_collection)
1697                 sgen_check_whole_heap (mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT);
1698
1699         TV_GETTIME (btv);
1700         time_major_pre_collection_fragment_clear += TV_ELAPSED (atv, btv);
1701
1702         if (!sgen_collection_is_concurrent ())
1703                 nursery_section->next_data = sgen_get_nursery_end ();
1704         /* we should also coalesce scanning from sections close to each other
1705          * and deal with pointers outside of the sections later.
1706          */
1707
1708         objects_pinned = 0;
1709
1710         sgen_client_pre_collection_checks ();
1711
1712         if (mode != COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
1713                 /* Remsets are not useful for a major collection */
1714                 remset.clear_cards ();
1715         }
1716
1717         sgen_process_fin_stage_entries ();
1718
1719         TV_GETTIME (atv);
1720         sgen_init_pinning ();
1721         SGEN_LOG (6, "Collecting pinned addresses");
1722         pin_from_roots ((void*)lowest_heap_address, (void*)highest_heap_address, ctx);
1723         if (mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT) {
1724                 /* Pin cemented objects that were forced */
1725                 sgen_pin_cemented_objects ();
1726         }
1727         sgen_optimize_pin_queue ();
1728         if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
1729                 /*
1730                  * Cemented objects that are in the pinned list will be marked. When
1731                  * marking concurrently we won't mark mod-union cards for these objects.
1732                  * Instead they will remain cemented until the next major collection,
1733                  * when we will recheck if they are still pinned in the roots.
1734                  */
1735                 sgen_cement_force_pinned ();
1736         }
1737
1738         sgen_client_collecting_major_1 ();
1739
1740         /*
1741          * pin_queue now contains all candidate pointers, sorted and
1742          * uniqued.  We must do two passes now to figure out which
1743          * objects are pinned.
1744          *
1745          * The first is to find within the pin_queue the area for each
1746          * section.  This requires that the pin_queue be sorted.  We
1747          * also process the LOS objects and pinned chunks here.
1748          *
1749          * The second, destructive, pass is to reduce the section
1750          * areas to pointers to the actually pinned objects.
1751          */
1752         SGEN_LOG (6, "Pinning from sections");
1753         /* first pass for the sections */
1754         sgen_find_section_pin_queue_start_end (nursery_section);
1755         /* identify possible pointers to the insize of large objects */
1756         SGEN_LOG (6, "Pinning from large objects");
1757         for (bigobj = los_object_list; bigobj; bigobj = bigobj->next) {
1758                 size_t dummy;
1759                 if (sgen_find_optimized_pin_queue_area ((char*)bigobj->data, (char*)bigobj->data + sgen_los_object_size (bigobj), &dummy, &dummy)) {
1760                         binary_protocol_pin (bigobj->data, (gpointer)LOAD_VTABLE (bigobj->data), safe_object_get_size (bigobj->data));
1761
1762                         if (sgen_los_object_is_pinned (bigobj->data)) {
1763                                 SGEN_ASSERT (0, mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT, "LOS objects can only be pinned here after concurrent marking.");
1764                                 continue;
1765                         }
1766                         sgen_los_pin_object (bigobj->data);
1767                         if (SGEN_OBJECT_HAS_REFERENCES (bigobj->data))
1768                                 GRAY_OBJECT_ENQUEUE (WORKERS_DISTRIBUTE_GRAY_QUEUE, bigobj->data, sgen_obj_get_descriptor ((GCObject*)bigobj->data));
1769                         sgen_pin_stats_register_object (bigobj->data, safe_object_get_size (bigobj->data));
1770                         SGEN_LOG (6, "Marked large object %p (%s) size: %lu from roots", bigobj->data,
1771                                         sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (bigobj->data)),
1772                                         (unsigned long)sgen_los_object_size (bigobj));
1773
1774                         sgen_client_pinned_los_object (bigobj->data);
1775                 }
1776         }
1777
1778         pin_objects_in_nursery (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT, ctx);
1779         if (check_nursery_objects_pinned && !sgen_minor_collector.is_split)
1780                 sgen_check_nursery_objects_pinned (mode != COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT);
1781
1782         major_collector.pin_objects (WORKERS_DISTRIBUTE_GRAY_QUEUE);
1783         if (old_next_pin_slot)
1784                 *old_next_pin_slot = sgen_get_pinned_count ();
1785
1786         TV_GETTIME (btv);
1787         time_major_pinning += TV_ELAPSED (atv, btv);
1788         SGEN_LOG (2, "Finding pinned pointers: %zd in %lld usecs", sgen_get_pinned_count (), TV_ELAPSED (atv, btv));
1789         SGEN_LOG (4, "Start scan with %zd pinned objects", sgen_get_pinned_count ());
1790
1791         major_collector.init_to_space ();
1792
1793         SGEN_ASSERT (0, sgen_workers_all_done (), "Why are the workers not done when we start or finish a major collection?");
1794         if (mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT) {
1795                 if (sgen_workers_have_idle_work ()) {
1796                         /*
1797                          * We force the finish of the worker with the new object ops context
1798                          * which can also do copying. We need to have finished pinning.
1799                          */
1800                         sgen_workers_start_all_workers (object_ops, NULL);
1801                         sgen_workers_join ();
1802                 }
1803         }
1804
1805 #ifdef SGEN_DEBUG_INTERNAL_ALLOC
1806         main_gc_thread = mono_native_thread_self ();
1807 #endif
1808
1809         sgen_client_collecting_major_2 ();
1810
1811         TV_GETTIME (atv);
1812         time_major_scan_pinned += TV_ELAPSED (btv, atv);
1813
1814         sgen_client_collecting_major_3 (&fin_ready_queue, &critical_fin_queue);
1815
1816         enqueue_scan_from_roots_jobs (heap_start, heap_end, object_ops, FALSE);
1817
1818         TV_GETTIME (btv);
1819         time_major_scan_roots += TV_ELAPSED (atv, btv);
1820
1821         /*
1822          * We start the concurrent worker after pinning and after we scanned the roots
1823          * in order to make sure that the worker does not finish before handling all
1824          * the roots.
1825          */
1826         if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
1827                 if (precleaning_enabled) {
1828                         ScanJob *sj;
1829                         /* Mod union preclean job */
1830                         sj = (ScanJob*)sgen_thread_pool_job_alloc ("preclean mod union cardtable", job_mod_union_preclean, sizeof (ScanJob));
1831                         sj->ops = object_ops;
1832                         sgen_workers_start_all_workers (object_ops, &sj->job);
1833                 } else {
1834                         sgen_workers_start_all_workers (object_ops, NULL);
1835                 }
1836                 gray_queue_enable_redirect (WORKERS_DISTRIBUTE_GRAY_QUEUE);
1837         }
1838
1839         if (mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT) {
1840                 ScanJob *sj;
1841
1842                 /* Mod union card table */
1843                 sj = (ScanJob*)sgen_thread_pool_job_alloc ("scan mod union cardtable", job_scan_major_mod_union_card_table, sizeof (ScanJob));
1844                 sj->ops = object_ops;
1845                 sgen_workers_enqueue_job (&sj->job, FALSE);
1846
1847                 sj = (ScanJob*)sgen_thread_pool_job_alloc ("scan LOS mod union cardtable", job_scan_los_mod_union_card_table, sizeof (ScanJob));
1848                 sj->ops = object_ops;
1849                 sgen_workers_enqueue_job (&sj->job, FALSE);
1850
1851                 TV_GETTIME (atv);
1852                 time_major_scan_mod_union += TV_ELAPSED (btv, atv);
1853         }
1854
1855         sgen_pin_stats_print_class_stats ();
1856 }
1857
1858 static void
1859 major_finish_copy_or_mark (CopyOrMarkFromRootsMode mode)
1860 {
1861         if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
1862                 sgen_finish_pinning ();
1863
1864                 sgen_pin_stats_reset ();
1865
1866                 if (do_concurrent_checks)
1867                         sgen_debug_check_nursery_is_clean ();
1868         }
1869 }
1870
1871 static void
1872 major_start_collection (gboolean concurrent, size_t *old_next_pin_slot)
1873 {
1874         SgenObjectOperations *object_ops;
1875
1876         binary_protocol_collection_begin (gc_stats.major_gc_count, GENERATION_OLD);
1877
1878         current_collection_generation = GENERATION_OLD;
1879
1880         g_assert (sgen_section_gray_queue_is_empty (sgen_workers_get_distribute_section_gray_queue ()));
1881
1882         if (!concurrent)
1883                 sgen_cement_reset ();
1884
1885         if (concurrent) {
1886                 g_assert (major_collector.is_concurrent);
1887                 concurrent_collection_in_progress = TRUE;
1888
1889                 object_ops = &major_collector.major_ops_concurrent_start;
1890         } else {
1891                 object_ops = &major_collector.major_ops_serial;
1892         }
1893
1894         reset_pinned_from_failed_allocation ();
1895
1896         sgen_memgov_major_collection_start ();
1897
1898         //count_ref_nonref_objs ();
1899         //consistency_check ();
1900
1901         check_scan_starts ();
1902
1903         degraded_mode = 0;
1904         SGEN_LOG (1, "Start major collection %d", gc_stats.major_gc_count);
1905         gc_stats.major_gc_count ++;
1906
1907         if (major_collector.start_major_collection)
1908                 major_collector.start_major_collection ();
1909
1910         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);
1911         major_finish_copy_or_mark (concurrent ? COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT : COPY_OR_MARK_FROM_ROOTS_SERIAL);
1912 }
1913
1914 static void
1915 major_finish_collection (const char *reason, size_t old_next_pin_slot, gboolean forced)
1916 {
1917         ScannedObjectCounts counts;
1918         SgenObjectOperations *object_ops;
1919         mword fragment_total;
1920         TV_DECLARE (atv);
1921         TV_DECLARE (btv);
1922
1923         TV_GETTIME (btv);
1924
1925         if (concurrent_collection_in_progress) {
1926                 object_ops = &major_collector.major_ops_concurrent_finish;
1927
1928                 major_copy_or_mark_from_roots (NULL, COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT, object_ops);
1929
1930                 major_finish_copy_or_mark (COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT);
1931
1932 #ifdef SGEN_DEBUG_INTERNAL_ALLOC
1933                 main_gc_thread = NULL;
1934 #endif
1935         } else {
1936                 object_ops = &major_collector.major_ops_serial;
1937         }
1938
1939         g_assert (sgen_section_gray_queue_is_empty (sgen_workers_get_distribute_section_gray_queue ()));
1940
1941         /* all the objects in the heap */
1942         finish_gray_stack (GENERATION_OLD, CONTEXT_FROM_OBJECT_OPERATIONS (object_ops, &gray_queue));
1943         TV_GETTIME (atv);
1944         time_major_finish_gray_stack += TV_ELAPSED (btv, atv);
1945
1946         SGEN_ASSERT (0, sgen_workers_all_done (), "Can't have workers working after joining");
1947
1948         if (objects_pinned) {
1949                 g_assert (!concurrent_collection_in_progress);
1950
1951                 /*
1952                  * This is slow, but we just OOM'd.
1953                  *
1954                  * See comment at `sgen_pin_queue_clear_discarded_entries` for how the pin
1955                  * queue is laid out at this point.
1956                  */
1957                 sgen_pin_queue_clear_discarded_entries (nursery_section, old_next_pin_slot);
1958                 /*
1959                  * We need to reestablish all pinned nursery objects in the pin queue
1960                  * because they're needed for fragment creation.  Unpinning happens by
1961                  * walking the whole queue, so it's not necessary to reestablish where major
1962                  * heap block pins are - all we care is that they're still in there
1963                  * somewhere.
1964                  */
1965                 sgen_optimize_pin_queue ();
1966                 sgen_find_section_pin_queue_start_end (nursery_section);
1967                 objects_pinned = 0;
1968         }
1969
1970         reset_heap_boundaries ();
1971         sgen_update_heap_boundaries ((mword)sgen_get_nursery_start (), (mword)sgen_get_nursery_end ());
1972
1973         /* walk the pin_queue, build up the fragment list of free memory, unmark
1974          * pinned objects as we go, memzero() the empty fragments so they are ready for the
1975          * next allocations.
1976          */
1977         fragment_total = sgen_build_nursery_fragments (nursery_section, NULL);
1978         if (!fragment_total)
1979                 degraded_mode = 1;
1980         SGEN_LOG (4, "Free space in nursery after major %ld", (long)fragment_total);
1981
1982         if (do_concurrent_checks && concurrent_collection_in_progress)
1983                 sgen_debug_check_nursery_is_clean ();
1984
1985         /* prepare the pin queue for the next collection */
1986         sgen_finish_pinning ();
1987
1988         /* Clear TLABs for all threads */
1989         sgen_clear_tlabs ();
1990
1991         sgen_pin_stats_reset ();
1992
1993         sgen_cement_clear_below_threshold ();
1994
1995         if (check_mark_bits_after_major_collection)
1996                 sgen_check_heap_marked (concurrent_collection_in_progress);
1997
1998         TV_GETTIME (btv);
1999         time_major_fragment_creation += TV_ELAPSED (atv, btv);
2000
2001         binary_protocol_sweep_begin (GENERATION_OLD, !major_collector.sweeps_lazily);
2002         sgen_memgov_major_pre_sweep ();
2003
2004         TV_GETTIME (atv);
2005         time_major_free_bigobjs += TV_ELAPSED (btv, atv);
2006
2007         sgen_los_sweep ();
2008
2009         TV_GETTIME (btv);
2010         time_major_los_sweep += TV_ELAPSED (atv, btv);
2011
2012         major_collector.sweep ();
2013
2014         binary_protocol_sweep_end (GENERATION_OLD, !major_collector.sweeps_lazily);
2015
2016         TV_GETTIME (atv);
2017         time_major_sweep += TV_ELAPSED (btv, atv);
2018
2019         sgen_debug_dump_heap ("major", gc_stats.major_gc_count - 1, reason);
2020
2021         if (sgen_have_pending_finalizers ()) {
2022                 SGEN_LOG (4, "Finalizer-thread wakeup");
2023                 sgen_client_finalize_notify ();
2024         }
2025
2026         g_assert (sgen_gray_object_queue_is_empty (&gray_queue));
2027
2028         sgen_memgov_major_collection_end (forced);
2029         current_collection_generation = -1;
2030
2031         memset (&counts, 0, sizeof (ScannedObjectCounts));
2032         major_collector.finish_major_collection (&counts);
2033
2034         g_assert (sgen_section_gray_queue_is_empty (sgen_workers_get_distribute_section_gray_queue ()));
2035
2036         SGEN_ASSERT (0, sgen_workers_all_done (), "Can't have workers working after major collection has finished");
2037         if (concurrent_collection_in_progress)
2038                 concurrent_collection_in_progress = FALSE;
2039
2040         check_scan_starts ();
2041
2042         binary_protocol_flush_buffers (FALSE);
2043
2044         //consistency_check ();
2045
2046         binary_protocol_collection_end (gc_stats.major_gc_count - 1, GENERATION_OLD, counts.num_scanned_objects, counts.num_unique_scanned_objects);
2047 }
2048
2049 static gboolean
2050 major_do_collection (const char *reason, gboolean forced)
2051 {
2052         TV_DECLARE (time_start);
2053         TV_DECLARE (time_end);
2054         size_t old_next_pin_slot;
2055
2056         if (disable_major_collections)
2057                 return FALSE;
2058
2059         if (major_collector.get_and_reset_num_major_objects_marked) {
2060                 long long num_marked = major_collector.get_and_reset_num_major_objects_marked ();
2061                 g_assert (!num_marked);
2062         }
2063
2064         /* world must be stopped already */
2065         TV_GETTIME (time_start);
2066
2067         major_start_collection (FALSE, &old_next_pin_slot);
2068         major_finish_collection (reason, old_next_pin_slot, forced);
2069
2070         TV_GETTIME (time_end);
2071         gc_stats.major_gc_time += TV_ELAPSED (time_start, time_end);
2072
2073         /* FIXME: also report this to the user, preferably in gc-end. */
2074         if (major_collector.get_and_reset_num_major_objects_marked)
2075                 major_collector.get_and_reset_num_major_objects_marked ();
2076
2077         return bytes_pinned_from_failed_allocation > 0;
2078 }
2079
2080 static void
2081 major_start_concurrent_collection (const char *reason)
2082 {
2083         TV_DECLARE (time_start);
2084         TV_DECLARE (time_end);
2085         long long num_objects_marked;
2086
2087         if (disable_major_collections)
2088                 return;
2089
2090         TV_GETTIME (time_start);
2091         SGEN_TV_GETTIME (time_major_conc_collection_start);
2092
2093         num_objects_marked = major_collector.get_and_reset_num_major_objects_marked ();
2094         g_assert (num_objects_marked == 0);
2095
2096         binary_protocol_concurrent_start ();
2097
2098         // FIXME: store reason and pass it when finishing
2099         major_start_collection (TRUE, NULL);
2100
2101         gray_queue_redirect (&gray_queue);
2102
2103         num_objects_marked = major_collector.get_and_reset_num_major_objects_marked ();
2104
2105         TV_GETTIME (time_end);
2106         gc_stats.major_gc_time += TV_ELAPSED (time_start, time_end);
2107
2108         current_collection_generation = -1;
2109 }
2110
2111 /*
2112  * Returns whether the major collection has finished.
2113  */
2114 static gboolean
2115 major_should_finish_concurrent_collection (void)
2116 {
2117         SGEN_ASSERT (0, sgen_gray_object_queue_is_empty (&gray_queue), "Why is the gray queue not empty before we have started doing anything?");
2118         return sgen_workers_all_done ();
2119 }
2120
2121 static void
2122 major_update_concurrent_collection (void)
2123 {
2124         TV_DECLARE (total_start);
2125         TV_DECLARE (total_end);
2126
2127         TV_GETTIME (total_start);
2128
2129         binary_protocol_concurrent_update ();
2130
2131         major_collector.update_cardtable_mod_union ();
2132         sgen_los_update_cardtable_mod_union ();
2133
2134         TV_GETTIME (total_end);
2135         gc_stats.major_gc_time += TV_ELAPSED (total_start, total_end);
2136 }
2137
2138 static void
2139 major_finish_concurrent_collection (gboolean forced)
2140 {
2141         TV_DECLARE (total_start);
2142         TV_DECLARE (total_end);
2143
2144         TV_GETTIME (total_start);
2145
2146         binary_protocol_concurrent_finish ();
2147
2148         /*
2149          * We need to stop all workers since we're updating the cardtable below.
2150          * The workers will be resumed with a finishing pause context to avoid
2151          * additional cardtable and object scanning.
2152          */
2153         sgen_workers_stop_all_workers ();
2154
2155         SGEN_TV_GETTIME (time_major_conc_collection_end);
2156         gc_stats.major_gc_time_concurrent += SGEN_TV_ELAPSED (time_major_conc_collection_start, time_major_conc_collection_end);
2157
2158         major_collector.update_cardtable_mod_union ();
2159         sgen_los_update_cardtable_mod_union ();
2160
2161         if (mod_union_consistency_check)
2162                 sgen_check_mod_union_consistency ();
2163
2164         current_collection_generation = GENERATION_OLD;
2165         sgen_cement_reset ();
2166         major_finish_collection ("finishing", -1, forced);
2167
2168         if (whole_heap_check_before_collection)
2169                 sgen_check_whole_heap (FALSE);
2170
2171         TV_GETTIME (total_end);
2172         gc_stats.major_gc_time += TV_ELAPSED (total_start, total_end) - TV_ELAPSED (last_minor_collection_start_tv, last_minor_collection_end_tv);
2173
2174         current_collection_generation = -1;
2175 }
2176
2177 /*
2178  * Ensure an allocation request for @size will succeed by freeing enough memory.
2179  *
2180  * LOCKING: The GC lock MUST be held.
2181  */
2182 void
2183 sgen_ensure_free_space (size_t size, int generation)
2184 {
2185         int generation_to_collect = -1;
2186         const char *reason = NULL;
2187
2188         if (generation == GENERATION_OLD) {
2189                 if (sgen_need_major_collection (size)) {
2190                         reason = "LOS overflow";
2191                         generation_to_collect = GENERATION_OLD;
2192                 }
2193         } else {
2194                 if (degraded_mode) {
2195                         if (sgen_need_major_collection (size)) {
2196                                 reason = "Degraded mode overflow";
2197                                 generation_to_collect = GENERATION_OLD;
2198                         }
2199                 } else if (sgen_need_major_collection (size)) {
2200                         reason = concurrent_collection_in_progress ? "Forced finish concurrent collection" : "Minor allowance";
2201                         generation_to_collect = GENERATION_OLD;
2202                 } else {
2203                         generation_to_collect = GENERATION_NURSERY;
2204                         reason = "Nursery full";                        
2205                 }
2206         }
2207
2208         if (generation_to_collect == -1) {
2209                 if (concurrent_collection_in_progress && sgen_workers_all_done ()) {
2210                         generation_to_collect = GENERATION_OLD;
2211                         reason = "Finish concurrent collection";
2212                 }
2213         }
2214
2215         if (generation_to_collect == -1)
2216                 return;
2217         sgen_perform_collection (size, generation_to_collect, reason, FALSE);
2218 }
2219
2220 /*
2221  * LOCKING: Assumes the GC lock is held.
2222  */
2223 void
2224 sgen_perform_collection (size_t requested_size, int generation_to_collect, const char *reason, gboolean wait_to_finish)
2225 {
2226         TV_DECLARE (gc_start);
2227         TV_DECLARE (gc_end);
2228         TV_DECLARE (gc_total_start);
2229         TV_DECLARE (gc_total_end);
2230         GGTimingInfo infos [2];
2231         int overflow_generation_to_collect = -1;
2232         int oldest_generation_collected = generation_to_collect;
2233         const char *overflow_reason = NULL;
2234
2235         binary_protocol_collection_requested (generation_to_collect, requested_size, wait_to_finish ? 1 : 0);
2236
2237         SGEN_ASSERT (0, generation_to_collect == GENERATION_NURSERY || generation_to_collect == GENERATION_OLD, "What generation is this?");
2238
2239         TV_GETTIME (gc_start);
2240
2241         sgen_stop_world (generation_to_collect);
2242
2243         TV_GETTIME (gc_total_start);
2244
2245         if (concurrent_collection_in_progress) {
2246                 /*
2247                  * If the concurrent worker is finished or we are asked to do a major collection
2248                  * then we finish the concurrent collection.
2249                  */
2250                 gboolean finish = major_should_finish_concurrent_collection () || generation_to_collect == GENERATION_OLD;
2251
2252                 if (finish) {
2253                         major_finish_concurrent_collection (wait_to_finish);
2254                         oldest_generation_collected = GENERATION_OLD;
2255                 } else {
2256                         SGEN_ASSERT (0, generation_to_collect == GENERATION_NURSERY, "Why aren't we finishing the concurrent collection?");
2257                         major_update_concurrent_collection ();
2258                         collect_nursery (NULL, FALSE);
2259                 }
2260
2261                 goto done;
2262         }
2263
2264         SGEN_ASSERT (0, !concurrent_collection_in_progress, "Why did this not get handled above?");
2265
2266         /*
2267          * There's no concurrent collection in progress.  Collect the generation we're asked
2268          * to collect.  If the major collector is concurrent and we're not forced to wait,
2269          * start a concurrent collection.
2270          */
2271         // FIXME: extract overflow reason
2272         if (generation_to_collect == GENERATION_NURSERY) {
2273                 if (collect_nursery (NULL, FALSE)) {
2274                         overflow_generation_to_collect = GENERATION_OLD;
2275                         overflow_reason = "Minor overflow";
2276                 }
2277         } else {
2278                 if (major_collector.is_concurrent && !wait_to_finish) {
2279                         collect_nursery (NULL, FALSE);
2280                         major_start_concurrent_collection (reason);
2281                         // FIXME: set infos[0] properly
2282                         goto done;
2283                 }
2284
2285                 if (major_do_collection (reason, wait_to_finish)) {
2286                         overflow_generation_to_collect = GENERATION_NURSERY;
2287                         overflow_reason = "Excessive pinning";
2288                 }
2289         }
2290
2291         TV_GETTIME (gc_end);
2292
2293         memset (infos, 0, sizeof (infos));
2294         infos [0].generation = generation_to_collect;
2295         infos [0].reason = reason;
2296         infos [0].is_overflow = FALSE;
2297         infos [1].generation = -1;
2298         infos [0].total_time = SGEN_TV_ELAPSED (gc_start, gc_end);
2299
2300         SGEN_ASSERT (0, !concurrent_collection_in_progress, "Why did this not get handled above?");
2301
2302         if (overflow_generation_to_collect != -1) {
2303                 /*
2304                  * We need to do an overflow collection, either because we ran out of memory
2305                  * or the nursery is fully pinned.
2306                  */
2307
2308                 infos [1].generation = overflow_generation_to_collect;
2309                 infos [1].reason = overflow_reason;
2310                 infos [1].is_overflow = TRUE;
2311                 gc_start = gc_end;
2312
2313                 if (overflow_generation_to_collect == GENERATION_NURSERY)
2314                         collect_nursery (NULL, FALSE);
2315                 else
2316                         major_do_collection (overflow_reason, wait_to_finish);
2317
2318                 TV_GETTIME (gc_end);
2319                 infos [1].total_time = SGEN_TV_ELAPSED (gc_start, gc_end);
2320
2321                 oldest_generation_collected = MAX (oldest_generation_collected, overflow_generation_to_collect);
2322         }
2323
2324         SGEN_LOG (2, "Heap size: %lu, LOS size: %lu", (unsigned long)sgen_gc_get_total_heap_allocation (), (unsigned long)los_memory_usage);
2325
2326         /* this also sets the proper pointers for the next allocation */
2327         if (generation_to_collect == GENERATION_NURSERY && !sgen_can_alloc_size (requested_size)) {
2328                 /* TypeBuilder and MonoMethod are killing mcs with fragmentation */
2329                 SGEN_LOG (1, "nursery collection didn't find enough room for %zd alloc (%zd pinned)", requested_size, sgen_get_pinned_count ());
2330                 sgen_dump_pin_queue ();
2331                 degraded_mode = 1;
2332         }
2333
2334  done:
2335         g_assert (sgen_gray_object_queue_is_empty (&gray_queue));
2336
2337         TV_GETTIME (gc_total_end);
2338         time_max = MAX (time_max, TV_ELAPSED (gc_total_start, gc_total_end));
2339
2340         sgen_restart_world (oldest_generation_collected, infos);
2341 }
2342
2343 /*
2344  * ######################################################################
2345  * ########  Memory allocation from the OS
2346  * ######################################################################
2347  * This section of code deals with getting memory from the OS and
2348  * allocating memory for GC-internal data structures.
2349  * Internal memory can be handled with a freelist for small objects.
2350  */
2351
2352 /*
2353  * Debug reporting.
2354  */
2355 G_GNUC_UNUSED static void
2356 report_internal_mem_usage (void)
2357 {
2358         printf ("Internal memory usage:\n");
2359         sgen_report_internal_mem_usage ();
2360         printf ("Pinned memory usage:\n");
2361         major_collector.report_pinned_memory_usage ();
2362 }
2363
2364 /*
2365  * ######################################################################
2366  * ########  Finalization support
2367  * ######################################################################
2368  */
2369
2370 /*
2371  * If the object has been forwarded it means it's still referenced from a root. 
2372  * If it is pinned it's still alive as well.
2373  * A LOS object is only alive if we have pinned it.
2374  * Return TRUE if @obj is ready to be finalized.
2375  */
2376 static inline gboolean
2377 sgen_is_object_alive (GCObject *object)
2378 {
2379         if (ptr_in_nursery (object))
2380                 return sgen_nursery_is_object_alive (object);
2381
2382         return sgen_major_is_object_alive (object);
2383 }
2384
2385 /*
2386  * This function returns true if @object is either alive and belongs to the
2387  * current collection - major collections are full heap, so old gen objects
2388  * are never alive during a minor collection.
2389  */
2390 static inline int
2391 sgen_is_object_alive_and_on_current_collection (GCObject *object)
2392 {
2393         if (ptr_in_nursery (object))
2394                 return sgen_nursery_is_object_alive (object);
2395
2396         if (current_collection_generation == GENERATION_NURSERY)
2397                 return FALSE;
2398
2399         return sgen_major_is_object_alive (object);
2400 }
2401
2402
2403 gboolean
2404 sgen_gc_is_object_ready_for_finalization (GCObject *object)
2405 {
2406         return !sgen_is_object_alive (object);
2407 }
2408
2409 void
2410 sgen_queue_finalization_entry (GCObject *obj)
2411 {
2412         gboolean critical = sgen_client_object_has_critical_finalizer (obj);
2413
2414         sgen_pointer_queue_add (critical ? &critical_fin_queue : &fin_ready_queue, obj);
2415
2416         sgen_client_object_queued_for_finalization (obj);
2417 }
2418
2419 gboolean
2420 sgen_object_is_live (GCObject *obj)
2421 {
2422         return sgen_is_object_alive_and_on_current_collection (obj);
2423 }
2424
2425 /*
2426  * `System.GC.WaitForPendingFinalizers` first checks `sgen_have_pending_finalizers()` to
2427  * determine whether it can exit quickly.  The latter must therefore only return FALSE if
2428  * all finalizers have really finished running.
2429  *
2430  * `sgen_gc_invoke_finalizers()` first dequeues a finalizable object, and then finalizes it.
2431  * This means that just checking whether the queues are empty leaves the possibility that an
2432  * object might have been dequeued but not yet finalized.  That's why we need the additional
2433  * flag `pending_unqueued_finalizer`.
2434  */
2435
2436 static volatile gboolean pending_unqueued_finalizer = FALSE;
2437
2438 int
2439 sgen_gc_invoke_finalizers (void)
2440 {
2441         int count = 0;
2442
2443         g_assert (!pending_unqueued_finalizer);
2444
2445         /* FIXME: batch to reduce lock contention */
2446         while (sgen_have_pending_finalizers ()) {
2447                 GCObject *obj;
2448
2449                 LOCK_GC;
2450
2451                 /*
2452                  * We need to set `pending_unqueued_finalizer` before dequeing the
2453                  * finalizable object.
2454                  */
2455                 if (!sgen_pointer_queue_is_empty (&fin_ready_queue)) {
2456                         pending_unqueued_finalizer = TRUE;
2457                         mono_memory_write_barrier ();
2458                         obj = (GCObject *)sgen_pointer_queue_pop (&fin_ready_queue);
2459                 } else if (!sgen_pointer_queue_is_empty (&critical_fin_queue)) {
2460                         pending_unqueued_finalizer = TRUE;
2461                         mono_memory_write_barrier ();
2462                         obj = (GCObject *)sgen_pointer_queue_pop (&critical_fin_queue);
2463                 } else {
2464                         obj = NULL;
2465                 }
2466
2467                 if (obj)
2468                         SGEN_LOG (7, "Finalizing object %p (%s)", obj, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj)));
2469
2470                 UNLOCK_GC;
2471
2472                 if (!obj)
2473                         break;
2474
2475                 count++;
2476                 /* the object is on the stack so it is pinned */
2477                 /*g_print ("Calling finalizer for object: %p (%s)\n", obj, sgen_client_object_safe_name (obj));*/
2478                 sgen_client_run_finalize (obj);
2479         }
2480
2481         if (pending_unqueued_finalizer) {
2482                 mono_memory_write_barrier ();
2483                 pending_unqueued_finalizer = FALSE;
2484         }
2485
2486         return count;
2487 }
2488
2489 gboolean
2490 sgen_have_pending_finalizers (void)
2491 {
2492         return pending_unqueued_finalizer || !sgen_pointer_queue_is_empty (&fin_ready_queue) || !sgen_pointer_queue_is_empty (&critical_fin_queue);
2493 }
2494
2495 /*
2496  * ######################################################################
2497  * ########  registered roots support
2498  * ######################################################################
2499  */
2500
2501 /*
2502  * We do not coalesce roots.
2503  */
2504 int
2505 sgen_register_root (char *start, size_t size, SgenDescriptor descr, int root_type, int source, const char *msg)
2506 {
2507         RootRecord new_root;
2508         int i;
2509         LOCK_GC;
2510         for (i = 0; i < ROOT_TYPE_NUM; ++i) {
2511                 RootRecord *root = (RootRecord *)sgen_hash_table_lookup (&roots_hash [i], start);
2512                 /* we allow changing the size and the descriptor (for thread statics etc) */
2513                 if (root) {
2514                         size_t old_size = root->end_root - start;
2515                         root->end_root = start + size;
2516                         SGEN_ASSERT (0, !!root->root_desc == !!descr, "Can't change whether a root is precise or conservative.");
2517                         SGEN_ASSERT (0, root->source == source, "Can't change a root's source identifier.");
2518                         SGEN_ASSERT (0, !!root->msg == !!msg, "Can't change a root's message.");
2519                         root->root_desc = descr;
2520                         roots_size += size;
2521                         roots_size -= old_size;
2522                         UNLOCK_GC;
2523                         return TRUE;
2524                 }
2525         }
2526
2527         new_root.end_root = start + size;
2528         new_root.root_desc = descr;
2529         new_root.source = source;
2530         new_root.msg = msg;
2531
2532         sgen_hash_table_replace (&roots_hash [root_type], start, &new_root, NULL);
2533         roots_size += size;
2534
2535         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);
2536
2537         UNLOCK_GC;
2538         return TRUE;
2539 }
2540
2541 void
2542 sgen_deregister_root (char* addr)
2543 {
2544         int root_type;
2545         RootRecord root;
2546
2547         LOCK_GC;
2548         for (root_type = 0; root_type < ROOT_TYPE_NUM; ++root_type) {
2549                 if (sgen_hash_table_remove (&roots_hash [root_type], addr, &root))
2550                         roots_size -= (root.end_root - addr);
2551         }
2552         UNLOCK_GC;
2553 }
2554
2555 /*
2556  * ######################################################################
2557  * ########  Thread handling (stop/start code)
2558  * ######################################################################
2559  */
2560
2561 int
2562 sgen_get_current_collection_generation (void)
2563 {
2564         return current_collection_generation;
2565 }
2566
2567 void*
2568 sgen_thread_register (SgenThreadInfo* info, void *stack_bottom_fallback)
2569 {
2570 #ifndef HAVE_KW_THREAD
2571         info->tlab_start = info->tlab_next = info->tlab_temp_end = info->tlab_real_end = NULL;
2572 #endif
2573
2574         sgen_init_tlab_info (info);
2575
2576         sgen_client_thread_register (info, stack_bottom_fallback);
2577
2578         return info;
2579 }
2580
2581 void
2582 sgen_thread_unregister (SgenThreadInfo *p)
2583 {
2584         sgen_client_thread_unregister (p);
2585 }
2586
2587 /*
2588  * ######################################################################
2589  * ########  Write barriers
2590  * ######################################################################
2591  */
2592
2593 /*
2594  * Note: the write barriers first do the needed GC work and then do the actual store:
2595  * this way the value is visible to the conservative GC scan after the write barrier
2596  * itself. If a GC interrupts the barrier in the middle, value will be kept alive by
2597  * the conservative scan, otherwise by the remembered set scan.
2598  */
2599
2600 void
2601 mono_gc_wbarrier_arrayref_copy (gpointer dest_ptr, gpointer src_ptr, int count)
2602 {
2603         HEAVY_STAT (++stat_wbarrier_arrayref_copy);
2604         /*This check can be done without taking a lock since dest_ptr array is pinned*/
2605         if (ptr_in_nursery (dest_ptr) || count <= 0) {
2606                 mono_gc_memmove_aligned (dest_ptr, src_ptr, count * sizeof (gpointer));
2607                 return;
2608         }
2609
2610 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
2611         if (binary_protocol_is_heavy_enabled ()) {
2612                 int i;
2613                 for (i = 0; i < count; ++i) {
2614                         gpointer dest = (gpointer*)dest_ptr + i;
2615                         gpointer obj = *((gpointer*)src_ptr + i);
2616                         if (obj)
2617                                 binary_protocol_wbarrier (dest, obj, (gpointer)LOAD_VTABLE (obj));
2618                 }
2619         }
2620 #endif
2621
2622         remset.wbarrier_arrayref_copy (dest_ptr, src_ptr, count);
2623 }
2624
2625 void
2626 mono_gc_wbarrier_generic_nostore (gpointer ptr)
2627 {
2628         gpointer obj;
2629
2630         HEAVY_STAT (++stat_wbarrier_generic_store);
2631
2632         sgen_client_wbarrier_generic_nostore_check (ptr);
2633
2634         obj = *(gpointer*)ptr;
2635         if (obj)
2636                 binary_protocol_wbarrier (ptr, obj, (gpointer)LOAD_VTABLE (obj));
2637
2638         /*
2639          * We need to record old->old pointer locations for the
2640          * concurrent collector.
2641          */
2642         if (!ptr_in_nursery (obj) && !concurrent_collection_in_progress) {
2643                 SGEN_LOG (8, "Skipping remset at %p", ptr);
2644                 return;
2645         }
2646
2647         SGEN_LOG (8, "Adding remset at %p", ptr);
2648
2649         remset.wbarrier_generic_nostore (ptr);
2650 }
2651
2652 void
2653 mono_gc_wbarrier_generic_store (gpointer ptr, GCObject* value)
2654 {
2655         SGEN_LOG (8, "Wbarrier store at %p to %p (%s)", ptr, value, value ? sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (value)) : "null");
2656         SGEN_UPDATE_REFERENCE_ALLOW_NULL (ptr, value);
2657         if (ptr_in_nursery (value) || concurrent_collection_in_progress)
2658                 mono_gc_wbarrier_generic_nostore (ptr);
2659         sgen_dummy_use (value);
2660 }
2661
2662 /* Same as mono_gc_wbarrier_generic_store () but performs the store
2663  * as an atomic operation with release semantics.
2664  */
2665 void
2666 mono_gc_wbarrier_generic_store_atomic (gpointer ptr, GCObject *value)
2667 {
2668         HEAVY_STAT (++stat_wbarrier_generic_store_atomic);
2669
2670         SGEN_LOG (8, "Wbarrier atomic store at %p to %p (%s)", ptr, value, value ? sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (value)) : "null");
2671
2672         InterlockedWritePointer ((volatile gpointer *)ptr, value);
2673
2674         if (ptr_in_nursery (value) || concurrent_collection_in_progress)
2675                 mono_gc_wbarrier_generic_nostore (ptr);
2676
2677         sgen_dummy_use (value);
2678 }
2679
2680 void
2681 sgen_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap)
2682 {
2683         GCObject **dest = (GCObject **)_dest;
2684         GCObject **src = (GCObject **)_src;
2685
2686         while (size) {
2687                 if (bitmap & 0x1)
2688                         mono_gc_wbarrier_generic_store (dest, *src);
2689                 else
2690                         *dest = *src;
2691                 ++src;
2692                 ++dest;
2693                 size -= SIZEOF_VOID_P;
2694                 bitmap >>= 1;
2695         }
2696 }
2697
2698 /*
2699  * ######################################################################
2700  * ########  Other mono public interface functions.
2701  * ######################################################################
2702  */
2703
2704 void
2705 sgen_gc_collect (int generation)
2706 {
2707         LOCK_GC;
2708         if (generation > 1)
2709                 generation = 1;
2710         sgen_perform_collection (0, generation, "user request", TRUE);
2711         UNLOCK_GC;
2712 }
2713
2714 int
2715 sgen_gc_collection_count (int generation)
2716 {
2717         if (generation == 0)
2718                 return gc_stats.minor_gc_count;
2719         return gc_stats.major_gc_count;
2720 }
2721
2722 size_t
2723 sgen_gc_get_used_size (void)
2724 {
2725         gint64 tot = 0;
2726         LOCK_GC;
2727         tot = los_memory_usage;
2728         tot += nursery_section->next_data - nursery_section->data;
2729         tot += major_collector.get_used_size ();
2730         /* FIXME: account for pinned objects */
2731         UNLOCK_GC;
2732         return tot;
2733 }
2734
2735 void
2736 sgen_env_var_error (const char *env_var, const char *fallback, const char *description_format, ...)
2737 {
2738         va_list ap;
2739
2740         va_start (ap, description_format);
2741
2742         fprintf (stderr, "Warning: In environment variable `%s': ", env_var);
2743         vfprintf (stderr, description_format, ap);
2744         if (fallback)
2745                 fprintf (stderr, " - %s", fallback);
2746         fprintf (stderr, "\n");
2747
2748         va_end (ap);
2749 }
2750
2751 static gboolean
2752 parse_double_in_interval (const char *env_var, const char *opt_name, const char *opt, double min, double max, double *result)
2753 {
2754         char *endptr;
2755         double val = strtod (opt, &endptr);
2756         if (endptr == opt) {
2757                 sgen_env_var_error (env_var, "Using default value.", "`%s` must be a number.", opt_name);
2758                 return FALSE;
2759         }
2760         else if (val < min || val > max) {
2761                 sgen_env_var_error (env_var, "Using default value.", "`%s` must be between %.2f - %.2f.", opt_name, min, max);
2762                 return FALSE;
2763         }
2764         *result = val;
2765         return TRUE;
2766 }
2767
2768 void
2769 sgen_gc_init (void)
2770 {
2771         const char *env;
2772         char **opts, **ptr;
2773         char *major_collector_opt = NULL;
2774         char *minor_collector_opt = NULL;
2775         size_t max_heap = 0;
2776         size_t soft_limit = 0;
2777         int result;
2778         gboolean debug_print_allowance = FALSE;
2779         double allowance_ratio = 0, save_target = 0;
2780         gboolean cement_enabled = TRUE;
2781
2782         do {
2783                 result = InterlockedCompareExchange (&gc_initialized, -1, 0);
2784                 switch (result) {
2785                 case 1:
2786                         /* already inited */
2787                         return;
2788                 case -1:
2789                         /* being inited by another thread */
2790                         mono_thread_info_usleep (1000);
2791                         break;
2792                 case 0:
2793                         /* we will init it */
2794                         break;
2795                 default:
2796                         g_assert_not_reached ();
2797                 }
2798         } while (result != 0);
2799
2800         SGEN_TV_GETTIME (sgen_init_timestamp);
2801
2802 #ifdef SGEN_WITHOUT_MONO
2803         mono_thread_smr_init ();
2804 #endif
2805
2806         mono_coop_mutex_init (&gc_mutex);
2807
2808         gc_debug_file = stderr;
2809
2810         mono_coop_mutex_init (&sgen_interruption_mutex);
2811
2812         if ((env = g_getenv (MONO_GC_PARAMS_NAME))) {
2813                 opts = g_strsplit (env, ",", -1);
2814                 for (ptr = opts; *ptr; ++ptr) {
2815                         char *opt = *ptr;
2816                         if (g_str_has_prefix (opt, "major=")) {
2817                                 opt = strchr (opt, '=') + 1;
2818                                 major_collector_opt = g_strdup (opt);
2819                         } else if (g_str_has_prefix (opt, "minor=")) {
2820                                 opt = strchr (opt, '=') + 1;
2821                                 minor_collector_opt = g_strdup (opt);
2822                         }
2823                 }
2824         } else {
2825                 opts = NULL;
2826         }
2827
2828         init_stats ();
2829         sgen_init_internal_allocator ();
2830         sgen_init_nursery_allocator ();
2831         sgen_init_fin_weak_hash ();
2832         sgen_init_hash_table ();
2833         sgen_init_descriptors ();
2834         sgen_init_gray_queues ();
2835         sgen_init_allocator ();
2836         sgen_init_gchandles ();
2837
2838         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_SECTION, SGEN_SIZEOF_GC_MEM_SECTION);
2839         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_GRAY_QUEUE, sizeof (GrayQueueSection));
2840
2841         sgen_client_init ();
2842
2843         if (!minor_collector_opt) {
2844                 sgen_simple_nursery_init (&sgen_minor_collector);
2845         } else {
2846                 if (!strcmp (minor_collector_opt, "simple")) {
2847                 use_simple_nursery:
2848                         sgen_simple_nursery_init (&sgen_minor_collector);
2849                 } else if (!strcmp (minor_collector_opt, "split")) {
2850                         sgen_split_nursery_init (&sgen_minor_collector);
2851                 } else {
2852                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using `simple` instead.", "Unknown minor collector `%s'.", minor_collector_opt);
2853                         goto use_simple_nursery;
2854                 }
2855         }
2856
2857         if (!major_collector_opt || !strcmp (major_collector_opt, "marksweep")) {
2858         use_marksweep_major:
2859                 sgen_marksweep_init (&major_collector);
2860         } else if (!major_collector_opt || !strcmp (major_collector_opt, "marksweep-conc")) {
2861                 sgen_marksweep_conc_init (&major_collector);
2862         } else {
2863                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using `marksweep` instead.", "Unknown major collector `%s'.", major_collector_opt);
2864                 goto use_marksweep_major;
2865         }
2866
2867         sgen_nursery_size = DEFAULT_NURSERY_SIZE;
2868
2869         if (opts) {
2870                 gboolean usage_printed = FALSE;
2871
2872                 for (ptr = opts; *ptr; ++ptr) {
2873                         char *opt = *ptr;
2874                         if (!strcmp (opt, ""))
2875                                 continue;
2876                         if (g_str_has_prefix (opt, "major="))
2877                                 continue;
2878                         if (g_str_has_prefix (opt, "minor="))
2879                                 continue;
2880                         if (g_str_has_prefix (opt, "max-heap-size=")) {
2881                                 size_t page_size = mono_pagesize ();
2882                                 size_t max_heap_candidate = 0;
2883                                 opt = strchr (opt, '=') + 1;
2884                                 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &max_heap_candidate)) {
2885                                         max_heap = (max_heap_candidate + page_size - 1) & ~(size_t)(page_size - 1);
2886                                         if (max_heap != max_heap_candidate)
2887                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Rounding up.", "`max-heap-size` size must be a multiple of %d.", page_size);
2888                                 } else {
2889                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`max-heap-size` must be an integer.");
2890                                 }
2891                                 continue;
2892                         }
2893                         if (g_str_has_prefix (opt, "soft-heap-limit=")) {
2894                                 opt = strchr (opt, '=') + 1;
2895                                 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &soft_limit)) {
2896                                         if (soft_limit <= 0) {
2897                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`soft-heap-limit` must be positive.");
2898                                                 soft_limit = 0;
2899                                         }
2900                                 } else {
2901                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`soft-heap-limit` must be an integer.");
2902                                 }
2903                                 continue;
2904                         }
2905
2906 #ifdef USER_CONFIG
2907                         if (g_str_has_prefix (opt, "nursery-size=")) {
2908                                 size_t val;
2909                                 opt = strchr (opt, '=') + 1;
2910                                 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &val)) {
2911                                         if ((val & (val - 1))) {
2912                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.", "`nursery-size` must be a power of two.");
2913                                                 continue;
2914                                         }
2915
2916                                         if (val < SGEN_MAX_NURSERY_WASTE) {
2917                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.",
2918                                                                 "`nursery-size` must be at least %d bytes.", SGEN_MAX_NURSERY_WASTE);
2919                                                 continue;
2920                                         }
2921
2922                                         sgen_nursery_size = val;
2923                                         sgen_nursery_bits = 0;
2924                                         while (ONE_P << (++ sgen_nursery_bits) != sgen_nursery_size)
2925                                                 ;
2926                                 } else {
2927                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.", "`nursery-size` must be an integer.");
2928                                         continue;
2929                                 }
2930                                 continue;
2931                         }
2932 #endif
2933                         if (g_str_has_prefix (opt, "save-target-ratio=")) {
2934                                 double val;
2935                                 opt = strchr (opt, '=') + 1;
2936                                 if (parse_double_in_interval (MONO_GC_PARAMS_NAME, "save-target-ratio", opt,
2937                                                 SGEN_MIN_SAVE_TARGET_RATIO, SGEN_MAX_SAVE_TARGET_RATIO, &val)) {
2938                                         save_target = val;
2939                                 }
2940                                 continue;
2941                         }
2942                         if (g_str_has_prefix (opt, "default-allowance-ratio=")) {
2943                                 double val;
2944                                 opt = strchr (opt, '=') + 1;
2945                                 if (parse_double_in_interval (MONO_GC_PARAMS_NAME, "default-allowance-ratio", opt,
2946                                                 SGEN_MIN_ALLOWANCE_NURSERY_SIZE_RATIO, SGEN_MIN_ALLOWANCE_NURSERY_SIZE_RATIO, &val)) {
2947                                         allowance_ratio = val;
2948                                 }
2949                                 continue;
2950                         }
2951
2952                         if (!strcmp (opt, "cementing")) {
2953                                 cement_enabled = TRUE;
2954                                 continue;
2955                         }
2956                         if (!strcmp (opt, "no-cementing")) {
2957                                 cement_enabled = FALSE;
2958                                 continue;
2959                         }
2960
2961                         if (!strcmp (opt, "precleaning")) {
2962                                 precleaning_enabled = TRUE;
2963                                 continue;
2964                         }
2965                         if (!strcmp (opt, "no-precleaning")) {
2966                                 precleaning_enabled = FALSE;
2967                                 continue;
2968                         }
2969
2970                         if (major_collector.handle_gc_param && major_collector.handle_gc_param (opt))
2971                                 continue;
2972
2973                         if (sgen_minor_collector.handle_gc_param && sgen_minor_collector.handle_gc_param (opt))
2974                                 continue;
2975
2976                         if (sgen_client_handle_gc_param (opt))
2977                                 continue;
2978
2979                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Ignoring.", "Unknown option `%s`.", opt);
2980
2981                         if (usage_printed)
2982                                 continue;
2983
2984                         fprintf (stderr, "\n%s must be a comma-delimited list of one or more of the following:\n", MONO_GC_PARAMS_NAME);
2985                         fprintf (stderr, "  max-heap-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
2986                         fprintf (stderr, "  soft-heap-limit=n (where N is an integer, possibly with a k, m or a g suffix)\n");
2987                         fprintf (stderr, "  nursery-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
2988                         fprintf (stderr, "  major=COLLECTOR (where COLLECTOR is `marksweep', `marksweep-conc', `marksweep-par')\n");
2989                         fprintf (stderr, "  minor=COLLECTOR (where COLLECTOR is `simple' or `split')\n");
2990                         fprintf (stderr, "  wbarrier=WBARRIER (where WBARRIER is `remset' or `cardtable')\n");
2991                         fprintf (stderr, "  [no-]cementing\n");
2992                         if (major_collector.print_gc_param_usage)
2993                                 major_collector.print_gc_param_usage ();
2994                         if (sgen_minor_collector.print_gc_param_usage)
2995                                 sgen_minor_collector.print_gc_param_usage ();
2996                         sgen_client_print_gc_params_usage ();
2997                         fprintf (stderr, " Experimental options:\n");
2998                         fprintf (stderr, "  save-target-ratio=R (where R must be between %.2f - %.2f).\n", SGEN_MIN_SAVE_TARGET_RATIO, SGEN_MAX_SAVE_TARGET_RATIO);
2999                         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);
3000                         fprintf (stderr, "\n");
3001
3002                         usage_printed = TRUE;
3003                 }
3004                 g_strfreev (opts);
3005         }
3006
3007         if (major_collector_opt)
3008                 g_free (major_collector_opt);
3009
3010         if (minor_collector_opt)
3011                 g_free (minor_collector_opt);
3012
3013         alloc_nursery ();
3014
3015         sgen_pinning_init ();
3016         sgen_cement_init (cement_enabled);
3017
3018         if ((env = g_getenv (MONO_GC_DEBUG_NAME))) {
3019                 gboolean usage_printed = FALSE;
3020
3021                 opts = g_strsplit (env, ",", -1);
3022                 for (ptr = opts; ptr && *ptr; ptr ++) {
3023                         char *opt = *ptr;
3024                         if (!strcmp (opt, ""))
3025                                 continue;
3026                         if (opt [0] >= '0' && opt [0] <= '9') {
3027                                 gc_debug_level = atoi (opt);
3028                                 opt++;
3029                                 if (opt [0] == ':')
3030                                         opt++;
3031                                 if (opt [0]) {
3032                                         char *rf = g_strdup_printf ("%s.%d", opt, mono_process_current_pid ());
3033                                         gc_debug_file = fopen (rf, "wb");
3034                                         if (!gc_debug_file)
3035                                                 gc_debug_file = stderr;
3036                                         g_free (rf);
3037                                 }
3038                         } else if (!strcmp (opt, "print-allowance")) {
3039                                 debug_print_allowance = TRUE;
3040                         } else if (!strcmp (opt, "print-pinning")) {
3041                                 sgen_pin_stats_enable ();
3042                         } else if (!strcmp (opt, "verify-before-allocs")) {
3043                                 verify_before_allocs = 1;
3044                                 has_per_allocation_action = TRUE;
3045                         } else if (g_str_has_prefix (opt, "verify-before-allocs=")) {
3046                                 char *arg = strchr (opt, '=') + 1;
3047                                 verify_before_allocs = atoi (arg);
3048                                 has_per_allocation_action = TRUE;
3049                         } else if (!strcmp (opt, "collect-before-allocs")) {
3050                                 collect_before_allocs = 1;
3051                                 has_per_allocation_action = TRUE;
3052                         } else if (g_str_has_prefix (opt, "collect-before-allocs=")) {
3053                                 char *arg = strchr (opt, '=') + 1;
3054                                 has_per_allocation_action = TRUE;
3055                                 collect_before_allocs = atoi (arg);
3056                         } else if (!strcmp (opt, "verify-before-collections")) {
3057                                 whole_heap_check_before_collection = TRUE;
3058                         } else if (!strcmp (opt, "check-at-minor-collections")) {
3059                                 consistency_check_at_minor_collection = TRUE;
3060                                 nursery_clear_policy = CLEAR_AT_GC;
3061                         } else if (!strcmp (opt, "mod-union-consistency-check")) {
3062                                 if (!major_collector.is_concurrent) {
3063                                         sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "`mod-union-consistency-check` only works with concurrent major collector.");
3064                                         continue;
3065                                 }
3066                                 mod_union_consistency_check = TRUE;
3067                         } else if (!strcmp (opt, "check-mark-bits")) {
3068                                 check_mark_bits_after_major_collection = TRUE;
3069                         } else if (!strcmp (opt, "check-nursery-pinned")) {
3070                                 check_nursery_objects_pinned = TRUE;
3071                         } else if (!strcmp (opt, "clear-at-gc")) {
3072                                 nursery_clear_policy = CLEAR_AT_GC;
3073                         } else if (!strcmp (opt, "clear-nursery-at-gc")) {
3074                                 nursery_clear_policy = CLEAR_AT_GC;
3075                         } else if (!strcmp (opt, "clear-at-tlab-creation")) {
3076                                 nursery_clear_policy = CLEAR_AT_TLAB_CREATION;
3077                         } else if (!strcmp (opt, "debug-clear-at-tlab-creation")) {
3078                                 nursery_clear_policy = CLEAR_AT_TLAB_CREATION_DEBUG;
3079                         } else if (!strcmp (opt, "check-scan-starts")) {
3080                                 do_scan_starts_check = TRUE;
3081                         } else if (!strcmp (opt, "verify-nursery-at-minor-gc")) {
3082                                 do_verify_nursery = TRUE;
3083                         } else if (!strcmp (opt, "check-concurrent")) {
3084                                 if (!major_collector.is_concurrent) {
3085                                         sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "`check-concurrent` only works with concurrent major collectors.");
3086                                         continue;
3087                                 }
3088                                 nursery_clear_policy = CLEAR_AT_GC;
3089                                 do_concurrent_checks = TRUE;
3090                         } else if (!strcmp (opt, "dump-nursery-at-minor-gc")) {
3091                                 do_dump_nursery_content = TRUE;
3092                         } else if (!strcmp (opt, "disable-minor")) {
3093                                 disable_minor_collections = TRUE;
3094                         } else if (!strcmp (opt, "disable-major")) {
3095                                 disable_major_collections = TRUE;
3096                         } else if (g_str_has_prefix (opt, "heap-dump=")) {
3097                                 char *filename = strchr (opt, '=') + 1;
3098                                 nursery_clear_policy = CLEAR_AT_GC;
3099                                 sgen_debug_enable_heap_dump (filename);
3100                         } else if (g_str_has_prefix (opt, "binary-protocol=")) {
3101                                 char *filename = strchr (opt, '=') + 1;
3102                                 char *colon = strrchr (filename, ':');
3103                                 size_t limit = 0;
3104                                 if (colon) {
3105                                         if (!mono_gc_parse_environment_string_extract_number (colon + 1, &limit)) {
3106                                                 sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring limit.", "Binary protocol file size limit must be an integer.");
3107                                                 limit = -1;
3108                                         }
3109                                         *colon = '\0';
3110                                 }
3111                                 binary_protocol_init (filename, (long long)limit);
3112                         } else if (!strcmp (opt, "nursery-canaries")) {
3113                                 do_verify_nursery = TRUE;
3114                                 enable_nursery_canaries = TRUE;
3115                         } else if (!sgen_client_handle_gc_debug (opt)) {
3116                                 sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "Unknown option `%s`.", opt);
3117
3118                                 if (usage_printed)
3119                                         continue;
3120
3121                                 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);
3122                                 fprintf (stderr, "Valid <option>s are:\n");
3123                                 fprintf (stderr, "  collect-before-allocs[=<n>]\n");
3124                                 fprintf (stderr, "  verify-before-allocs[=<n>]\n");
3125                                 fprintf (stderr, "  check-at-minor-collections\n");
3126                                 fprintf (stderr, "  check-mark-bits\n");
3127                                 fprintf (stderr, "  check-nursery-pinned\n");
3128                                 fprintf (stderr, "  verify-before-collections\n");
3129                                 fprintf (stderr, "  verify-nursery-at-minor-gc\n");
3130                                 fprintf (stderr, "  dump-nursery-at-minor-gc\n");
3131                                 fprintf (stderr, "  disable-minor\n");
3132                                 fprintf (stderr, "  disable-major\n");
3133                                 fprintf (stderr, "  check-concurrent\n");
3134                                 fprintf (stderr, "  clear-[nursery-]at-gc\n");
3135                                 fprintf (stderr, "  clear-at-tlab-creation\n");
3136                                 fprintf (stderr, "  debug-clear-at-tlab-creation\n");
3137                                 fprintf (stderr, "  check-scan-starts\n");
3138                                 fprintf (stderr, "  print-allowance\n");
3139                                 fprintf (stderr, "  print-pinning\n");
3140                                 fprintf (stderr, "  heap-dump=<filename>\n");
3141                                 fprintf (stderr, "  binary-protocol=<filename>[:<file-size-limit>]\n");
3142                                 fprintf (stderr, "  nursery-canaries\n");
3143                                 sgen_client_print_gc_debug_usage ();
3144                                 fprintf (stderr, "\n");
3145
3146                                 usage_printed = TRUE;
3147                         }
3148                 }
3149                 g_strfreev (opts);
3150         }
3151
3152         if (check_mark_bits_after_major_collection)
3153                 nursery_clear_policy = CLEAR_AT_GC;
3154
3155         if (major_collector.post_param_init)
3156                 major_collector.post_param_init (&major_collector);
3157
3158         if (major_collector.needs_thread_pool)
3159                 sgen_workers_init (1);
3160
3161         sgen_memgov_init (max_heap, soft_limit, debug_print_allowance, allowance_ratio, save_target);
3162
3163         memset (&remset, 0, sizeof (remset));
3164
3165         sgen_card_table_init (&remset);
3166
3167         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");
3168
3169         gc_initialized = 1;
3170 }
3171
3172 NurseryClearPolicy
3173 sgen_get_nursery_clear_policy (void)
3174 {
3175         return nursery_clear_policy;
3176 }
3177
3178 void
3179 sgen_gc_lock (void)
3180 {
3181         mono_coop_mutex_lock (&gc_mutex);
3182 }
3183
3184 void
3185 sgen_gc_unlock (void)
3186 {
3187         mono_coop_mutex_unlock (&gc_mutex);
3188 }
3189
3190 void
3191 sgen_major_collector_iterate_live_block_ranges (sgen_cardtable_block_callback callback)
3192 {
3193         major_collector.iterate_live_block_ranges (callback);
3194 }
3195
3196 SgenMajorCollector*
3197 sgen_get_major_collector (void)
3198 {
3199         return &major_collector;
3200 }
3201
3202 SgenRememberedSet*
3203 sgen_get_remset (void)
3204 {
3205         return &remset;
3206 }
3207
3208 static void
3209 count_cards (long long *major_total, long long *major_marked, long long *los_total, long long *los_marked)
3210 {
3211         sgen_get_major_collector ()->count_cards (major_total, major_marked);
3212         sgen_los_count_cards (los_total, los_marked);
3213 }
3214
3215 static gboolean world_is_stopped = FALSE;
3216
3217 /* LOCKING: assumes the GC lock is held */
3218 void
3219 sgen_stop_world (int generation)
3220 {
3221         long long major_total = -1, major_marked = -1, los_total = -1, los_marked = -1;
3222
3223         SGEN_ASSERT (0, !world_is_stopped, "Why are we stopping a stopped world?");
3224
3225         binary_protocol_world_stopping (generation, sgen_timestamp (), (gpointer) (gsize) mono_native_thread_id_get ());
3226
3227         sgen_client_stop_world (generation);
3228
3229         world_is_stopped = TRUE;
3230
3231         if (binary_protocol_is_heavy_enabled ())
3232                 count_cards (&major_total, &major_marked, &los_total, &los_marked);
3233         binary_protocol_world_stopped (generation, sgen_timestamp (), major_total, major_marked, los_total, los_marked);
3234 }
3235
3236 /* LOCKING: assumes the GC lock is held */
3237 void
3238 sgen_restart_world (int generation, GGTimingInfo *timing)
3239 {
3240         long long major_total = -1, major_marked = -1, los_total = -1, los_marked = -1;
3241
3242         SGEN_ASSERT (0, world_is_stopped, "Why are we restarting a running world?");
3243
3244         if (binary_protocol_is_heavy_enabled ())
3245                 count_cards (&major_total, &major_marked, &los_total, &los_marked);
3246         binary_protocol_world_restarting (generation, sgen_timestamp (), major_total, major_marked, los_total, los_marked);
3247
3248         sgen_client_restart_world (generation, timing);
3249
3250         world_is_stopped = FALSE;
3251
3252         binary_protocol_world_restarted (generation, sgen_timestamp ());
3253
3254         if (sgen_client_bridge_need_processing ())
3255                 sgen_client_bridge_processing_finish (generation);
3256
3257         sgen_memgov_collection_end (generation, timing, timing ? 2 : 0);
3258 }
3259
3260 gboolean
3261 sgen_is_world_stopped (void)
3262 {
3263         return world_is_stopped;
3264 }
3265
3266 void
3267 sgen_check_whole_heap_stw (void)
3268 {
3269         sgen_stop_world (0);
3270         sgen_clear_nursery_fragments ();
3271         sgen_check_whole_heap (FALSE);
3272         sgen_restart_world (0, NULL);
3273 }
3274
3275 gint64
3276 sgen_timestamp (void)
3277 {
3278         SGEN_TV_DECLARE (timestamp);
3279         SGEN_TV_GETTIME (timestamp);
3280         return SGEN_TV_ELAPSED (sgen_init_timestamp, timestamp);
3281 }
3282
3283 #endif /* HAVE_SGEN_GC */