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