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