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