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