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