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