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