[System.Data] use PAL_gssapi.c for SSPI (#9922)
[mono-project.git] / mono / sgen / sgen-gc.c
blob286bf2a63ae5f1d38a006b98dfec0b579d297372
1 /**
2 * \file
3 * Simple generational GC.
5 * Author:
6 * Paolo Molaro (lupus@ximian.com)
7 * Rodrigo Kumpera (kumpera@gmail.com)
9 * Copyright 2005-2011 Novell, Inc (http://www.novell.com)
10 * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
12 * Thread start/stop adapted from Boehm's GC:
13 * Copyright (c) 1994 by Xerox Corporation. All rights reserved.
14 * Copyright (c) 1996 by Silicon Graphics. All rights reserved.
15 * Copyright (c) 1998 by Fergus Henderson. All rights reserved.
16 * Copyright (c) 2000-2004 by Hewlett-Packard Company. All rights reserved.
17 * Copyright 2001-2003 Ximian, Inc
18 * Copyright 2003-2010 Novell, Inc.
19 * Copyright 2011 Xamarin, Inc.
20 * Copyright (C) 2012 Xamarin Inc
22 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
24 * Important: allocation provides always zeroed memory, having to do
25 * a memset after allocation is deadly for performance.
26 * Memory usage at startup is currently as follows:
27 * 64 KB pinned space
28 * 64 KB internal space
29 * size of nursery
30 * We should provide a small memory config with half the sizes
32 * We currently try to make as few mono assumptions as possible:
33 * 1) 2-word header with no GC pointers in it (first vtable, second to store the
34 * forwarding ptr)
35 * 2) gc descriptor is the second word in the vtable (first word in the class)
36 * 3) 8 byte alignment is the minimum and enough (not true for special structures (SIMD), FIXME)
37 * 4) there is a function to get an object's size and the number of
38 * elements in an array.
39 * 5) we know the special way bounds are allocated for complex arrays
40 * 6) we know about proxies and how to treat them when domains are unloaded
42 * Always try to keep stack usage to a minimum: no recursive behaviour
43 * and no large stack allocs.
45 * General description.
46 * Objects are initially allocated in a nursery using a fast bump-pointer technique.
47 * When the nursery is full we start a nursery collection: this is performed with a
48 * copying GC.
49 * When the old generation is full we start a copying GC of the old generation as well:
50 * this will be changed to mark&sweep with copying when fragmentation becomes to severe
51 * in the future. Maybe we'll even do both during the same collection like IMMIX.
53 * The things that complicate this description are:
54 * *) pinned objects: we can't move them so we need to keep track of them
55 * *) no precise info of the thread stacks and registers: we need to be able to
56 * quickly find the objects that may be referenced conservatively and pin them
57 * (this makes the first issues more important)
58 * *) large objects are too expensive to be dealt with using copying GC: we handle them
59 * with mark/sweep during major collections
60 * *) some objects need to not move even if they are small (interned strings, Type handles):
61 * we use mark/sweep for them, too: they are not allocated in the nursery, but inside
62 * PinnedChunks regions
66 * TODO:
68 *) we could have a function pointer in MonoClass to implement
69 customized write barriers for value types
71 *) investigate the stuff needed to advance a thread to a GC-safe
72 point (single-stepping, read from unmapped memory etc) and implement it.
73 This would enable us to inline allocations and write barriers, for example,
74 or at least parts of them, like the write barrier checks.
75 We may need this also for handling precise info on stacks, even simple things
76 as having uninitialized data on the stack and having to wait for the prolog
77 to zero it. Not an issue for the last frame that we scan conservatively.
78 We could always not trust the value in the slots anyway.
80 *) modify the jit to save info about references in stack locations:
81 this can be done just for locals as a start, so that at least
82 part of the stack is handled precisely.
84 *) test/fix endianess issues
86 *) Implement a card table as the write barrier instead of remembered
87 sets? Card tables are not easy to implement with our current
88 memory layout. We have several different kinds of major heap
89 objects: Small objects in regular blocks, small objects in pinned
90 chunks and LOS objects. If we just have a pointer we have no way
91 to tell which kind of object it points into, therefore we cannot
92 know where its card table is. The least we have to do to make
93 this happen is to get rid of write barriers for indirect stores.
94 (See next item)
96 *) Get rid of write barriers for indirect stores. We can do this by
97 telling the GC to wbarrier-register an object once we do an ldloca
98 or ldelema on it, and to unregister it once it's not used anymore
99 (it can only travel downwards on the stack). The problem with
100 unregistering is that it needs to happen eventually no matter
101 what, even if exceptions are thrown, the thread aborts, etc.
102 Rodrigo suggested that we could do only the registering part and
103 let the collector find out (pessimistically) when it's safe to
104 unregister, namely when the stack pointer of the thread that
105 registered the object is higher than it was when the registering
106 happened. This might make for a good first implementation to get
107 some data on performance.
109 *) Some sort of blacklist support? Blacklists is a concept from the
110 Boehm GC: if during a conservative scan we find pointers to an
111 area which we might use as heap, we mark that area as unusable, so
112 pointer retention by random pinning pointers is reduced.
114 *) experiment with max small object size (very small right now - 2kb,
115 because it's tied to the max freelist size)
117 *) add an option to mmap the whole heap in one chunk: it makes for many
118 simplifications in the checks (put the nursery at the top and just use a single
119 check for inclusion/exclusion): the issue this has is that on 32 bit systems it's
120 not flexible (too much of the address space may be used by default or we can't
121 increase the heap as needed) and we'd need a race-free mechanism to return memory
122 back to the system (mprotect(PROT_NONE) will still keep the memory allocated if it
123 was written to, munmap is needed, but the following mmap may not find the same segment
124 free...)
126 *) memzero the major fragments after restarting the world and optionally a smaller
127 chunk at a time
129 *) investigate having fragment zeroing threads
131 *) separate locks for finalization and other minor stuff to reduce
132 lock contention
134 *) try a different copying order to improve memory locality
136 *) a thread abort after a store but before the write barrier will
137 prevent the write barrier from executing
139 *) specialized dynamically generated markers/copiers
141 *) Dynamically adjust TLAB size to the number of threads. If we have
142 too many threads that do allocation, we might need smaller TLABs,
143 and we might get better performance with larger TLABs if we only
144 have a handful of threads. We could sum up the space left in all
145 assigned TLABs and if that's more than some percentage of the
146 nursery size, reduce the TLAB size.
148 *) Explore placing unreachable objects on unused nursery memory.
149 Instead of memset'ng a region to zero, place an int[] covering it.
150 A good place to start is add_nursery_frag. The tricky thing here is
151 placing those objects atomically outside of a collection.
153 *) Allocation should use asymmetric Dekker synchronization:
154 http://blogs.oracle.com/dave/resource/Asymmetric-Dekker-Synchronization.txt
155 This should help weak consistency archs.
157 #include "config.h"
158 #ifdef HAVE_SGEN_GC
160 #ifdef __MACH__
161 #undef _XOPEN_SOURCE
162 #define _XOPEN_SOURCE
163 #define _DARWIN_C_SOURCE
164 #endif
166 #ifdef HAVE_UNISTD_H
167 #include <unistd.h>
168 #endif
169 #ifdef HAVE_PTHREAD_H
170 #include <pthread.h>
171 #endif
172 #ifdef HAVE_PTHREAD_NP_H
173 #include <pthread_np.h>
174 #endif
175 #include <stdio.h>
176 #include <string.h>
177 #include <errno.h>
178 #include <assert.h>
179 #include <stdlib.h>
180 #include <glib.h>
182 #include "mono/sgen/sgen-gc.h"
183 #include "mono/sgen/sgen-cardtable.h"
184 #include "mono/sgen/sgen-protocol.h"
185 #include "mono/sgen/sgen-memory-governor.h"
186 #include "mono/sgen/sgen-hash-table.h"
187 #include "mono/sgen/sgen-pinning.h"
188 #include "mono/sgen/sgen-workers.h"
189 #include "mono/sgen/sgen-client.h"
190 #include "mono/sgen/sgen-pointer-queue.h"
191 #include "mono/sgen/gc-internal-agnostic.h"
192 #include "mono/utils/mono-proclib.h"
193 #include "mono/utils/mono-memory-model.h"
194 #include "mono/utils/hazard-pointer.h"
196 #include <mono/utils/memcheck.h>
197 #include <mono/utils/mono-mmap-internals.h>
198 #include <mono/utils/unlocked.h>
200 #undef pthread_create
201 #undef pthread_join
202 #undef pthread_detach
205 * ######################################################################
206 * ######## Types and constants used by the GC.
207 * ######################################################################
210 /* 0 means not initialized, 1 is initialized, -1 means in progress */
211 static int gc_initialized = 0;
212 /* If set, check if we need to do something every X allocations */
213 gboolean sgen_has_per_allocation_action;
214 /* If set, do a heap check every X allocation */
215 guint32 sgen_verify_before_allocs = 0;
216 /* If set, do a minor collection before every X allocation */
217 guint32 sgen_collect_before_allocs = 0;
218 /* If set, do a whole heap check before each collection */
219 static gboolean whole_heap_check_before_collection = FALSE;
220 /* If set, do a remset consistency check at various opportunities */
221 static gboolean remset_consistency_checks = FALSE;
222 /* If set, do a mod union consistency check before each finishing collection pause */
223 static gboolean mod_union_consistency_check = FALSE;
224 /* If set, check whether mark bits are consistent after major collections */
225 static gboolean check_mark_bits_after_major_collection = FALSE;
226 /* If set, check that all nursery objects are pinned/not pinned, depending on context */
227 static gboolean check_nursery_objects_pinned = FALSE;
228 /* If set, do a few checks when the concurrent collector is used */
229 static gboolean do_concurrent_checks = FALSE;
230 /* If set, do a plausibility check on the scan_starts before and after
231 each collection */
232 static gboolean do_scan_starts_check = FALSE;
234 static gboolean disable_minor_collections = FALSE;
235 static gboolean disable_major_collections = FALSE;
236 static gboolean do_verify_nursery = FALSE;
237 static gboolean do_dump_nursery_content = FALSE;
238 static gboolean enable_nursery_canaries = FALSE;
240 static gboolean precleaning_enabled = TRUE;
241 static gboolean dynamic_nursery = FALSE;
242 static size_t min_nursery_size = 0;
243 static size_t max_nursery_size = 0;
245 #ifdef HEAVY_STATISTICS
246 guint64 stat_objects_alloced_degraded = 0;
247 guint64 stat_bytes_alloced_degraded = 0;
249 guint64 stat_copy_object_called_nursery = 0;
250 guint64 stat_objects_copied_nursery = 0;
251 guint64 stat_copy_object_called_major = 0;
252 guint64 stat_objects_copied_major = 0;
254 guint64 stat_scan_object_called_nursery = 0;
255 guint64 stat_scan_object_called_major = 0;
257 guint64 stat_slots_allocated_in_vain;
259 guint64 stat_nursery_copy_object_failed_from_space = 0;
260 guint64 stat_nursery_copy_object_failed_forwarded = 0;
261 guint64 stat_nursery_copy_object_failed_pinned = 0;
262 guint64 stat_nursery_copy_object_failed_to_space = 0;
264 static guint64 stat_wbarrier_add_to_global_remset = 0;
265 static guint64 stat_wbarrier_arrayref_copy = 0;
266 static guint64 stat_wbarrier_generic_store = 0;
267 static guint64 stat_wbarrier_generic_store_atomic = 0;
268 static guint64 stat_wbarrier_set_root = 0;
269 #endif
271 static guint64 stat_pinned_objects = 0;
273 static guint64 time_minor_pre_collection_fragment_clear = 0;
274 static guint64 time_minor_pinning = 0;
275 static guint64 time_minor_scan_remsets = 0;
276 static guint64 time_minor_scan_major_blocks = 0;
277 static guint64 time_minor_scan_los = 0;
278 static guint64 time_minor_scan_pinned = 0;
279 static guint64 time_minor_scan_roots = 0;
280 static guint64 time_minor_finish_gray_stack = 0;
281 static guint64 time_minor_fragment_creation = 0;
283 static guint64 time_major_pre_collection_fragment_clear = 0;
284 static guint64 time_major_pinning = 0;
285 static guint64 time_major_scan_pinned = 0;
286 static guint64 time_major_scan_roots = 0;
287 static guint64 time_major_scan_mod_union_blocks = 0;
288 static guint64 time_major_scan_mod_union_los = 0;
289 static guint64 time_major_finish_gray_stack = 0;
290 static guint64 time_major_free_bigobjs = 0;
291 static guint64 time_major_los_sweep = 0;
292 static guint64 time_major_sweep = 0;
293 static guint64 time_major_fragment_creation = 0;
295 static guint64 time_max = 0;
297 static int sgen_max_pause_time = SGEN_DEFAULT_MAX_PAUSE_TIME;
298 static float sgen_max_pause_margin = SGEN_DEFAULT_MAX_PAUSE_MARGIN;
300 static SGEN_TV_DECLARE (time_major_conc_collection_start);
301 static SGEN_TV_DECLARE (time_major_conc_collection_end);
303 int sgen_gc_debug_level = 0;
304 FILE* sgen_gc_debug_file;
305 static char* gc_params_options;
306 static char* gc_debug_options;
309 void
310 mono_gc_flush_info (void)
312 fflush (sgen_gc_debug_file);
316 #define TV_DECLARE SGEN_TV_DECLARE
317 #define TV_GETTIME SGEN_TV_GETTIME
318 #define TV_ELAPSED SGEN_TV_ELAPSED
320 static SGEN_TV_DECLARE (sgen_init_timestamp);
322 NurseryClearPolicy sgen_nursery_clear_policy = CLEAR_AT_TLAB_CREATION;
324 #define object_is_forwarded SGEN_OBJECT_IS_FORWARDED
325 #define object_is_pinned SGEN_OBJECT_IS_PINNED
326 #define pin_object SGEN_PIN_OBJECT
328 #define ptr_in_nursery sgen_ptr_in_nursery
330 #define LOAD_VTABLE SGEN_LOAD_VTABLE
332 gboolean
333 sgen_nursery_canaries_enabled (void)
335 return enable_nursery_canaries;
338 #define safe_object_get_size sgen_safe_object_get_size
340 typedef enum {
341 SGEN_MAJOR_DEFAULT,
342 SGEN_MAJOR_SERIAL,
343 SGEN_MAJOR_CONCURRENT,
344 SGEN_MAJOR_CONCURRENT_PARALLEL
345 } SgenMajor;
347 typedef enum {
348 SGEN_MINOR_DEFAULT,
349 SGEN_MINOR_SIMPLE,
350 SGEN_MINOR_SIMPLE_PARALLEL,
351 SGEN_MINOR_SPLIT
352 } SgenMinor;
354 typedef enum {
355 SGEN_MODE_NONE,
356 SGEN_MODE_BALANCED,
357 SGEN_MODE_THROUGHPUT,
358 SGEN_MODE_PAUSE
359 } SgenMode;
362 * ######################################################################
363 * ######## Global data.
364 * ######################################################################
366 MonoCoopMutex sgen_gc_mutex;
368 #define SCAN_START_SIZE SGEN_SCAN_START_SIZE
370 size_t sgen_degraded_mode = 0;
372 static mword bytes_pinned_from_failed_allocation = 0;
374 GCMemSection *sgen_nursery_section = NULL;
375 static volatile mword lowest_heap_address = ~(mword)0;
376 static volatile mword highest_heap_address = 0;
378 MonoCoopMutex sgen_interruption_mutex;
380 int sgen_current_collection_generation = -1;
381 volatile gboolean sgen_concurrent_collection_in_progress = FALSE;
383 /* objects that are ready to be finalized */
384 static SgenPointerQueue fin_ready_queue = SGEN_POINTER_QUEUE_INIT (INTERNAL_MEM_FINALIZE_READY);
385 static SgenPointerQueue critical_fin_queue = SGEN_POINTER_QUEUE_INIT (INTERNAL_MEM_FINALIZE_READY);
387 /* registered roots: the key to the hash is the root start address */
389 * Different kinds of roots are kept separate to speed up pin_from_roots () for example.
391 SgenHashTable sgen_roots_hash [ROOT_TYPE_NUM] = {
392 SGEN_HASH_TABLE_INIT (INTERNAL_MEM_ROOTS_TABLE, INTERNAL_MEM_ROOT_RECORD, sizeof (RootRecord), sgen_aligned_addr_hash, NULL),
393 SGEN_HASH_TABLE_INIT (INTERNAL_MEM_ROOTS_TABLE, INTERNAL_MEM_ROOT_RECORD, sizeof (RootRecord), sgen_aligned_addr_hash, NULL),
394 SGEN_HASH_TABLE_INIT (INTERNAL_MEM_ROOTS_TABLE, INTERNAL_MEM_ROOT_RECORD, sizeof (RootRecord), sgen_aligned_addr_hash, NULL)
396 static mword roots_size = 0; /* amount of memory in the root set */
398 /* The size of a TLAB */
399 /* The bigger the value, the less often we have to go to the slow path to allocate a new
400 * one, but the more space is wasted by threads not allocating much memory.
401 * FIXME: Tune this.
402 * FIXME: Make this self-tuning for each thread.
404 guint32 sgen_tlab_size = (1024 * 4);
406 #define MAX_SMALL_OBJ_SIZE SGEN_MAX_SMALL_OBJ_SIZE
408 #define ALLOC_ALIGN SGEN_ALLOC_ALIGN
410 #define ALIGN_UP SGEN_ALIGN_UP
412 #ifdef SGEN_DEBUG_INTERNAL_ALLOC
413 MonoNativeThreadId main_gc_thread = NULL;
414 #endif
416 /*Object was pinned during the current collection*/
417 static mword objects_pinned;
420 * ######################################################################
421 * ######## Macros and function declarations.
422 * ######################################################################
425 /* forward declarations */
426 static void scan_from_registered_roots (char *addr_start, char *addr_end, int root_type, ScanCopyContext ctx);
428 static void pin_from_roots (void *start_nursery, void *end_nursery, ScanCopyContext ctx);
429 static void finish_gray_stack (int generation, ScanCopyContext ctx);
432 SgenMajorCollector sgen_major_collector;
433 SgenMinorCollector sgen_minor_collector;
435 static SgenRememberedSet remset;
438 * The gray queue a worker job must use. If we're not parallel or
439 * concurrent, we use the main gray queue.
441 static SgenGrayQueue*
442 sgen_workers_get_job_gray_queue (WorkerData *worker_data, SgenGrayQueue *default_gray_queue)
444 if (worker_data)
445 return &worker_data->private_gray_queue;
446 SGEN_ASSERT (0, default_gray_queue, "Why don't we have a default gray queue when we're not running in a worker thread?");
447 return default_gray_queue;
450 static void
451 gray_queue_redirect (SgenGrayQueue *queue)
453 sgen_workers_take_from_queue (sgen_current_collection_generation, queue);
456 void
457 sgen_scan_area_with_callback (char *start, char *end, IterateObjectCallbackFunc callback, void *data, gboolean allow_flags, gboolean fail_on_canaries)
459 while (start < end) {
460 size_t size;
461 char *obj;
463 if (!*(void**)start) {
464 start += sizeof (void*); /* should be ALLOC_ALIGN, really */
465 continue;
468 if (allow_flags) {
469 if (!(obj = (char *)SGEN_OBJECT_IS_FORWARDED (start)))
470 obj = start;
471 } else {
472 obj = start;
475 if (!sgen_client_object_is_array_fill ((GCObject*)obj)) {
476 CHECK_CANARY_FOR_OBJECT ((GCObject*)obj, fail_on_canaries);
477 size = ALIGN_UP (safe_object_get_size ((GCObject*)obj));
478 callback ((GCObject*)obj, size, data);
479 CANARIFY_SIZE (size);
480 } else {
481 size = ALIGN_UP (safe_object_get_size ((GCObject*)obj));
484 start += size;
489 * sgen_add_to_global_remset:
491 * The global remset contains locations which point into newspace after
492 * a minor collection. This can happen if the objects they point to are pinned.
494 * LOCKING: If called from a parallel collector, the global remset
495 * lock must be held. For serial collectors that is not necessary.
497 void
498 sgen_add_to_global_remset (gpointer ptr, GCObject *obj)
500 SGEN_ASSERT (5, sgen_ptr_in_nursery (obj), "Target pointer of global remset must be in the nursery");
502 HEAVY_STAT (++stat_wbarrier_add_to_global_remset);
504 if (!sgen_major_collector.is_concurrent) {
505 SGEN_ASSERT (5, sgen_current_collection_generation != -1, "Global remsets can only be added during collections");
506 } else {
507 if (sgen_current_collection_generation == -1)
508 SGEN_ASSERT (5, sgen_get_concurrent_collection_in_progress (), "Global remsets outside of collection pauses can only be added by the concurrent collector");
511 if (!object_is_pinned (obj))
512 SGEN_ASSERT (5, sgen_minor_collector.is_split || sgen_get_concurrent_collection_in_progress (), "Non-pinned objects can only remain in nursery if it is a split nursery");
513 else if (sgen_cement_lookup_or_register (obj))
514 return;
516 remset.record_pointer (ptr);
518 sgen_pin_stats_register_global_remset (obj);
520 SGEN_LOG (8, "Adding global remset for %p", ptr);
521 sgen_binary_protocol_global_remset (ptr, obj, (gpointer)SGEN_LOAD_VTABLE (obj));
525 * sgen_drain_gray_stack:
527 * Scan objects in the gray stack until the stack is empty. This should be called
528 * frequently after each object is copied, to achieve better locality and cache
529 * usage.
532 gboolean
533 sgen_drain_gray_stack (ScanCopyContext ctx)
535 SGEN_ASSERT (0, ctx.ops->drain_gray_stack, "Why do we have a scan/copy context with a missing drain gray stack function?");
537 return ctx.ops->drain_gray_stack (ctx.queue);
541 * Addresses in the pin queue are already sorted. This function finds
542 * the object header for each address and pins the object. The
543 * addresses must be inside the nursery section. The (start of the)
544 * address array is overwritten with the addresses of the actually
545 * pinned objects. Return the number of pinned objects.
547 static int
548 pin_objects_from_nursery_pin_queue (gboolean do_scan_objects, ScanCopyContext ctx)
550 GCMemSection *section = sgen_nursery_section;
551 void **start = sgen_pinning_get_entry (section->pin_queue_first_entry);
552 void **end = sgen_pinning_get_entry (section->pin_queue_last_entry);
553 void *start_nursery = section->data;
554 void *end_nursery = section->end_data;
555 void *last = NULL;
556 int count = 0;
557 void *search_start;
558 void *addr;
559 void *pinning_front = start_nursery;
560 size_t idx;
561 void **definitely_pinned = start;
562 ScanObjectFunc scan_func = ctx.ops->scan_object;
563 SgenGrayQueue *queue = ctx.queue;
565 sgen_nursery_allocator_prepare_for_pinning ();
567 while (start < end) {
568 GCObject *obj_to_pin = NULL;
569 size_t obj_to_pin_size = 0;
570 SgenDescriptor desc;
572 addr = *start;
574 SGEN_ASSERT (0, addr >= start_nursery && addr < end_nursery, "Potential pinning address out of range");
575 SGEN_ASSERT (0, addr >= last, "Pin queue not sorted");
577 if (addr == last) {
578 ++start;
579 continue;
582 SGEN_LOG (5, "Considering pinning addr %p", addr);
583 /* We've already processed everything up to pinning_front. */
584 if (addr < pinning_front) {
585 start++;
586 continue;
590 * Find the closest scan start <= addr. We might search backward in the
591 * scan_starts array because entries might be NULL. In the worst case we
592 * start at start_nursery.
594 idx = ((char*)addr - (char*)section->data) / SCAN_START_SIZE;
595 SGEN_ASSERT (0, idx < section->num_scan_start, "Scan start index out of range");
596 search_start = (void*)section->scan_starts [idx];
597 if (!search_start || search_start > addr) {
598 while (idx) {
599 --idx;
600 search_start = section->scan_starts [idx];
601 if (search_start && search_start <= addr)
602 break;
604 if (!search_start || search_start > addr)
605 search_start = start_nursery;
609 * If the pinning front is closer than the scan start we found, start
610 * searching at the front.
612 if (search_start < pinning_front)
613 search_start = pinning_front;
616 * Now addr should be in an object a short distance from search_start.
618 * search_start must point to zeroed mem or point to an object.
620 do {
621 size_t obj_size, canarified_obj_size;
623 /* Skip zeros. */
624 if (!*(void**)search_start) {
625 search_start = (void*)ALIGN_UP ((mword)search_start + sizeof (gpointer));
626 /* The loop condition makes sure we don't overrun addr. */
627 continue;
630 canarified_obj_size = obj_size = ALIGN_UP (safe_object_get_size ((GCObject*)search_start));
633 * Filler arrays are marked by an invalid sync word. We don't
634 * consider them for pinning. They are not delimited by canaries,
635 * either.
637 if (!sgen_client_object_is_array_fill ((GCObject*)search_start)) {
638 CHECK_CANARY_FOR_OBJECT (search_start, TRUE);
639 CANARIFY_SIZE (canarified_obj_size);
641 if (addr >= search_start && (char*)addr < (char*)search_start + obj_size) {
642 /* This is the object we're looking for. */
643 obj_to_pin = (GCObject*)search_start;
644 obj_to_pin_size = canarified_obj_size;
645 break;
649 /* Skip to the next object */
650 search_start = (void*)((char*)search_start + canarified_obj_size);
651 } while (search_start <= addr);
653 /* We've searched past the address we were looking for. */
654 if (!obj_to_pin) {
655 pinning_front = search_start;
656 goto next_pin_queue_entry;
660 * We've found an object to pin. It might still be a dummy array, but we
661 * can advance the pinning front in any case.
663 pinning_front = (char*)obj_to_pin + obj_to_pin_size;
666 * If this is a dummy array marking the beginning of a nursery
667 * fragment, we don't pin it.
669 if (sgen_client_object_is_array_fill (obj_to_pin))
670 goto next_pin_queue_entry;
673 * Finally - pin the object!
675 desc = sgen_obj_get_descriptor_safe (obj_to_pin);
677 if (do_scan_objects) {
678 scan_func (obj_to_pin, desc, queue);
679 } else {
680 SGEN_LOG (4, "Pinned object %p, vtable %p (%s), count %d\n",
681 obj_to_pin, *(void**)obj_to_pin, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj_to_pin)), count);
682 sgen_binary_protocol_pin (obj_to_pin,
683 (gpointer)LOAD_VTABLE (obj_to_pin),
684 safe_object_get_size (obj_to_pin));
686 pin_object (obj_to_pin);
687 GRAY_OBJECT_ENQUEUE_SERIAL (queue, obj_to_pin, desc);
688 sgen_pin_stats_register_object (obj_to_pin, GENERATION_NURSERY);
689 definitely_pinned [count] = obj_to_pin;
690 count++;
692 if (sgen_concurrent_collection_in_progress)
693 sgen_pinning_register_pinned_in_nursery (obj_to_pin);
695 next_pin_queue_entry:
696 last = addr;
697 ++start;
699 sgen_client_nursery_objects_pinned (definitely_pinned, count);
700 stat_pinned_objects += count;
701 return count;
704 static void
705 pin_objects_in_nursery (gboolean do_scan_objects, ScanCopyContext ctx)
707 size_t reduced_to;
709 if (sgen_nursery_section->pin_queue_first_entry == sgen_nursery_section->pin_queue_last_entry)
710 return;
712 reduced_to = pin_objects_from_nursery_pin_queue (do_scan_objects, ctx);
713 sgen_nursery_section->pin_queue_last_entry = sgen_nursery_section->pin_queue_first_entry + reduced_to;
717 * This function is only ever called (via `collector_pin_object()` in `sgen-copy-object.h`)
718 * when we can't promote an object because we're out of memory.
720 void
721 sgen_pin_object (GCObject *object, SgenGrayQueue *queue)
723 SGEN_ASSERT (0, sgen_ptr_in_nursery (object), "We're only supposed to use this for pinning nursery objects when out of memory.");
726 * All pinned objects are assumed to have been staged, so we need to stage as well.
727 * Also, the count of staged objects shows that "late pinning" happened.
729 sgen_pin_stage_ptr (object);
731 SGEN_PIN_OBJECT (object);
732 sgen_binary_protocol_pin (object, (gpointer)LOAD_VTABLE (object), safe_object_get_size (object));
734 ++objects_pinned;
735 sgen_pin_stats_register_object (object, GENERATION_NURSERY);
737 GRAY_OBJECT_ENQUEUE_SERIAL (queue, object, sgen_obj_get_descriptor_safe (object));
740 /* Sort the addresses in array in increasing order.
741 * Done using a by-the book heap sort. Which has decent and stable performance, is pretty cache efficient.
743 void
744 sgen_sort_addresses (void **array, size_t size)
746 size_t i;
747 void *tmp;
749 for (i = 1; i < size; ++i) {
750 size_t child = i;
751 while (child > 0) {
752 size_t parent = (child - 1) / 2;
754 if (array [parent] >= array [child])
755 break;
757 tmp = array [parent];
758 array [parent] = array [child];
759 array [child] = tmp;
761 child = parent;
765 for (i = size - 1; i > 0; --i) {
766 size_t end, root;
767 tmp = array [i];
768 array [i] = array [0];
769 array [0] = tmp;
771 end = i - 1;
772 root = 0;
774 while (root * 2 + 1 <= end) {
775 size_t child = root * 2 + 1;
777 if (child < end && array [child] < array [child + 1])
778 ++child;
779 if (array [root] >= array [child])
780 break;
782 tmp = array [root];
783 array [root] = array [child];
784 array [child] = tmp;
786 root = child;
792 * Scan the memory between start and end and queue values which could be pointers
793 * to the area between start_nursery and end_nursery for later consideration.
794 * Typically used for thread stacks.
796 MONO_NO_SANITIZE_ADDRESS
797 void
798 sgen_conservatively_pin_objects_from (void **start, void **end, void *start_nursery, void *end_nursery, int pin_type)
800 int count = 0;
802 SGEN_ASSERT (0, ((mword)start & (SIZEOF_VOID_P - 1)) == 0, "Why are we scanning for references in unaligned memory ?");
804 #if defined(VALGRIND_MAKE_MEM_DEFINED_IF_ADDRESSABLE) && !defined(_WIN64)
805 VALGRIND_MAKE_MEM_DEFINED_IF_ADDRESSABLE (start, (char*)end - (char*)start);
806 #endif
808 while (start < end) {
810 * *start can point to the middle of an object
811 * note: should we handle pointing at the end of an object?
812 * pinning in C# code disallows pointing at the end of an object
813 * but there is some small chance that an optimizing C compiler
814 * may keep the only reference to an object by pointing
815 * at the end of it. We ignore this small chance for now.
816 * Pointers to the end of an object are indistinguishable
817 * from pointers to the start of the next object in memory
818 * so if we allow that we'd need to pin two objects...
819 * We queue the pointer in an array, the
820 * array will then be sorted and uniqued. This way
821 * we can coalesce several pinning pointers and it should
822 * be faster since we'd do a memory scan with increasing
823 * addresses. Note: we can align the address to the allocation
824 * alignment, so the unique process is more effective.
826 mword addr = (mword)*start;
827 addr &= ~(ALLOC_ALIGN - 1);
828 if (addr >= (mword)start_nursery && addr < (mword)end_nursery) {
829 SGEN_LOG (6, "Pinning address %p from %p", (void*)addr, start);
830 sgen_pin_stage_ptr ((void*)addr);
831 sgen_binary_protocol_pin_stage (start, (void*)addr);
832 sgen_pin_stats_register_address ((char*)addr, pin_type);
833 count++;
835 start++;
837 if (count)
838 SGEN_LOG (7, "found %d potential pinned heap pointers", count);
842 * The first thing we do in a collection is to identify pinned objects.
843 * This function considers all the areas of memory that need to be
844 * conservatively scanned.
846 static void
847 pin_from_roots (void *start_nursery, void *end_nursery, ScanCopyContext ctx)
849 void **start_root;
850 RootRecord *root;
851 SGEN_LOG (2, "Scanning pinned roots (%d bytes, %d/%d entries)", (int)roots_size, sgen_roots_hash [ROOT_TYPE_NORMAL].num_entries, sgen_roots_hash [ROOT_TYPE_PINNED].num_entries);
852 /* objects pinned from the API are inside these roots */
853 SGEN_HASH_TABLE_FOREACH (&sgen_roots_hash [ROOT_TYPE_PINNED], void **, start_root, RootRecord *, root) {
854 SGEN_LOG (6, "Pinned roots %p-%p", start_root, root->end_root);
855 sgen_conservatively_pin_objects_from (start_root, (void**)root->end_root, start_nursery, end_nursery, PIN_TYPE_OTHER);
856 } SGEN_HASH_TABLE_FOREACH_END;
857 /* now deal with the thread stacks
858 * in the future we should be able to conservatively scan only:
859 * *) the cpu registers
860 * *) the unmanaged stack frames
861 * *) the _last_ managed stack frame
862 * *) pointers slots in managed frames
864 sgen_client_scan_thread_data (start_nursery, end_nursery, FALSE, ctx);
867 static void
868 single_arg_user_copy_or_mark (GCObject **obj, void *gc_data)
870 ScanCopyContext *ctx = (ScanCopyContext *)gc_data;
871 ctx->ops->copy_or_mark_object (obj, ctx->queue);
875 * The memory area from start_root to end_root contains pointers to objects.
876 * Their position is precisely described by @desc (this means that the pointer
877 * can be either NULL or the pointer to the start of an object).
878 * This functions copies them to to_space updates them.
880 * This function is not thread-safe!
882 static void
883 precisely_scan_objects_from (void** start_root, void** end_root, char* n_start, char *n_end, SgenDescriptor desc, ScanCopyContext ctx)
885 CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
886 ScanPtrFieldFunc scan_field_func = ctx.ops->scan_ptr_field;
887 SgenGrayQueue *queue = ctx.queue;
889 switch (desc & ROOT_DESC_TYPE_MASK) {
890 case ROOT_DESC_BITMAP:
891 desc >>= ROOT_DESC_TYPE_SHIFT;
892 while (desc) {
893 if ((desc & 1) && *start_root) {
894 copy_func ((GCObject**)start_root, queue);
895 SGEN_LOG (9, "Overwrote root at %p with %p", start_root, *start_root);
897 desc >>= 1;
898 start_root++;
900 return;
901 case ROOT_DESC_COMPLEX: {
902 gsize *bitmap_data = (gsize *)sgen_get_complex_descriptor_bitmap (desc);
903 gsize bwords = (*bitmap_data) - 1;
904 void **start_run = start_root;
905 bitmap_data++;
906 while (bwords-- > 0) {
907 gsize bmap = *bitmap_data++;
908 void **objptr = start_run;
909 while (bmap) {
910 if ((bmap & 1) && *objptr) {
911 copy_func ((GCObject**)objptr, queue);
912 SGEN_LOG (9, "Overwrote root at %p with %p", objptr, *objptr);
914 bmap >>= 1;
915 ++objptr;
917 start_run += GC_BITS_PER_WORD;
919 break;
921 case ROOT_DESC_VECTOR: {
922 void **p;
924 for (p = start_root; p < end_root; p++) {
925 if (*p)
926 scan_field_func (NULL, (GCObject**)p, queue);
928 break;
930 case ROOT_DESC_USER: {
931 SgenUserRootMarkFunc marker = sgen_get_user_descriptor_func (desc);
932 marker (start_root, single_arg_user_copy_or_mark, &ctx);
933 break;
935 case ROOT_DESC_RUN_LEN:
936 g_assert_not_reached ();
937 default:
938 g_assert_not_reached ();
942 static void
943 reset_heap_boundaries (void)
945 lowest_heap_address = ~(mword)0;
946 highest_heap_address = 0;
949 void
950 sgen_update_heap_boundaries (mword low, mword high)
952 mword old;
954 do {
955 old = lowest_heap_address;
956 if (low >= old)
957 break;
958 } while (SGEN_CAS_PTR ((gpointer*)&lowest_heap_address, (gpointer)low, (gpointer)old) != (gpointer)old);
960 do {
961 old = highest_heap_address;
962 if (high <= old)
963 break;
964 } while (SGEN_CAS_PTR ((gpointer*)&highest_heap_address, (gpointer)high, (gpointer)old) != (gpointer)old);
968 * Allocate and setup the data structures needed to be able to allocate objects
969 * in the nursery. The nursery is stored in sgen_nursery_section.
971 static void
972 alloc_nursery (gboolean dynamic, size_t min_size, size_t max_size)
974 char *data;
975 size_t scan_starts;
977 if (dynamic) {
978 if (!min_size)
979 min_size = SGEN_DEFAULT_NURSERY_MIN_SIZE;
980 if (!max_size)
981 max_size = SGEN_DEFAULT_NURSERY_MAX_SIZE;
982 } else {
983 SGEN_ASSERT (0, min_size == max_size, "We can't have nursery ranges for static configuration.");
984 if (!min_size)
985 min_size = max_size = SGEN_DEFAULT_NURSERY_SIZE;
988 SGEN_ASSERT (0, !sgen_nursery_section, "Why are we allocating the nursery twice?");
989 SGEN_LOG (2, "Allocating nursery size: %zu, initial %zu", max_size, min_size);
991 /* FIXME: handle OOM */
992 sgen_nursery_section = (GCMemSection *)sgen_alloc_internal (INTERNAL_MEM_SECTION);
994 /* If there isn't enough space even for the nursery we should simply abort. */
995 g_assert (sgen_memgov_try_alloc_space (max_size, SPACE_NURSERY));
998 * The nursery section range represents the memory section where objects
999 * can be found. This is used when iterating for objects in the nursery,
1000 * pinning etc. sgen_nursery_max_size represents the total allocated space
1001 * for the nursery. sgen_nursery_size represents the current size of the
1002 * nursery and it is used for allocation limits, heuristics etc. The
1003 * nursery section is not always identical to the current nursery size
1004 * because it can contain pinned objects from when the nursery was larger.
1006 * sgen_nursery_size <= sgen_nursery_section size <= sgen_nursery_max_size
1008 data = (char *)sgen_major_collector.alloc_heap (max_size, max_size);
1009 sgen_update_heap_boundaries ((mword)data, (mword)(data + max_size));
1010 sgen_nursery_section->data = data;
1011 sgen_nursery_section->end_data = data + min_size;
1012 scan_starts = (max_size + SCAN_START_SIZE - 1) / SCAN_START_SIZE;
1013 sgen_nursery_section->scan_starts = (char **)sgen_alloc_internal_dynamic (sizeof (char*) * scan_starts, INTERNAL_MEM_SCAN_STARTS, TRUE);
1014 sgen_nursery_section->num_scan_start = scan_starts;
1016 sgen_nursery_allocator_set_nursery_bounds (data, min_size, max_size);
1019 FILE *
1020 mono_gc_get_logfile (void)
1022 return sgen_gc_debug_file;
1025 void
1026 mono_gc_params_set (const char* options)
1028 if (gc_params_options)
1029 g_free (gc_params_options);
1031 gc_params_options = g_strdup (options);
1034 void
1035 mono_gc_debug_set (const char* options)
1037 if (gc_debug_options)
1038 g_free (gc_debug_options);
1040 gc_debug_options = g_strdup (options);
1043 static void
1044 scan_finalizer_entries (SgenPointerQueue *fin_queue, ScanCopyContext ctx)
1046 CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
1047 SgenGrayQueue *queue = ctx.queue;
1048 size_t i;
1050 for (i = 0; i < fin_queue->next_slot; ++i) {
1051 GCObject *obj = (GCObject *)fin_queue->data [i];
1052 if (!obj)
1053 continue;
1054 SGEN_LOG (5, "Scan of fin ready object: %p (%s)\n", obj, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj)));
1055 copy_func ((GCObject**)&fin_queue->data [i], queue);
1059 static const char*
1060 generation_name (int generation)
1062 switch (generation) {
1063 case GENERATION_NURSERY: return "nursery";
1064 case GENERATION_OLD: return "old";
1065 default: g_assert_not_reached ();
1069 const char*
1070 sgen_generation_name (int generation)
1072 return generation_name (generation);
1075 static void
1076 finish_gray_stack (int generation, ScanCopyContext ctx)
1078 TV_DECLARE (atv);
1079 TV_DECLARE (btv);
1080 int done_with_ephemerons, ephemeron_rounds = 0;
1081 char *start_addr = generation == GENERATION_NURSERY ? sgen_get_nursery_start () : NULL;
1082 char *end_addr = generation == GENERATION_NURSERY ? sgen_get_nursery_end () : (char*)-1;
1083 SgenGrayQueue *queue = ctx.queue;
1085 sgen_binary_protocol_finish_gray_stack_start (sgen_timestamp (), generation);
1087 * We copied all the reachable objects. Now it's the time to copy
1088 * the objects that were not referenced by the roots, but by the copied objects.
1089 * we built a stack of objects pointed to by gray_start: they are
1090 * additional roots and we may add more items as we go.
1091 * We loop until gray_start == gray_objects which means no more objects have
1092 * been added. Note this is iterative: no recursion is involved.
1093 * We need to walk the LO list as well in search of marked big objects
1094 * (use a flag since this is needed only on major collections). We need to loop
1095 * here as well, so keep a counter of marked LO (increasing it in copy_object).
1096 * To achieve better cache locality and cache usage, we drain the gray stack
1097 * frequently, after each object is copied, and just finish the work here.
1099 sgen_drain_gray_stack (ctx);
1100 TV_GETTIME (atv);
1101 SGEN_LOG (2, "%s generation done", generation_name (generation));
1104 Reset bridge data, we might have lingering data from a previous collection if this is a major
1105 collection trigged by minor overflow.
1107 We must reset the gathered bridges since their original block might be evacuated due to major
1108 fragmentation in the meanwhile and the bridge code should not have to deal with that.
1110 if (sgen_client_bridge_need_processing ())
1111 sgen_client_bridge_reset_data ();
1114 * Mark all strong toggleref objects. This must be done before we walk ephemerons or finalizers
1115 * to ensure they see the full set of live objects.
1117 sgen_client_mark_togglerefs (start_addr, end_addr, ctx);
1120 * Walk the ephemeron tables marking all values with reachable keys. This must be completely done
1121 * before processing finalizable objects and non-tracking weak links to avoid finalizing/clearing
1122 * objects that are in fact reachable.
1124 done_with_ephemerons = 0;
1125 do {
1126 done_with_ephemerons = sgen_client_mark_ephemerons (ctx);
1127 sgen_drain_gray_stack (ctx);
1128 ++ephemeron_rounds;
1129 } while (!done_with_ephemerons);
1131 if (sgen_client_bridge_need_processing ()) {
1132 /*Make sure the gray stack is empty before we process bridge objects so we get liveness right*/
1133 sgen_drain_gray_stack (ctx);
1134 sgen_collect_bridge_objects (generation, ctx);
1135 if (generation == GENERATION_OLD)
1136 sgen_collect_bridge_objects (GENERATION_NURSERY, ctx);
1139 Do the first bridge step here, as the collector liveness state will become useless after that.
1141 An important optimization is to only proccess the possibly dead part of the object graph and skip
1142 over all live objects as we transitively know everything they point must be alive too.
1144 The above invariant is completely wrong if we let the gray queue be drained and mark/copy everything.
1146 This has the unfortunate side effect of making overflow collections perform the first step twice, but
1147 given we now have heuristics that perform major GC in anticipation of minor overflows this should not
1148 be a big deal.
1150 sgen_client_bridge_processing_stw_step ();
1154 Make sure we drain the gray stack before processing disappearing links and finalizers.
1155 If we don't make sure it is empty we might wrongly see a live object as dead.
1157 sgen_drain_gray_stack (ctx);
1160 We must clear weak links that don't track resurrection before processing object ready for
1161 finalization so they can be cleared before that.
1163 sgen_null_link_in_range (generation, ctx, FALSE);
1164 if (generation == GENERATION_OLD)
1165 sgen_null_link_in_range (GENERATION_NURSERY, ctx, FALSE);
1168 /* walk the finalization queue and move also the objects that need to be
1169 * finalized: use the finalized objects as new roots so the objects they depend
1170 * on are also not reclaimed. As with the roots above, only objects in the nursery
1171 * are marked/copied.
1173 sgen_finalize_in_range (generation, ctx);
1174 if (generation == GENERATION_OLD)
1175 sgen_finalize_in_range (GENERATION_NURSERY, ctx);
1176 /* drain the new stack that might have been created */
1177 SGEN_LOG (6, "Precise scan of gray area post fin");
1178 sgen_drain_gray_stack (ctx);
1181 * This must be done again after processing finalizable objects since CWL slots are cleared only after the key is finalized.
1183 done_with_ephemerons = 0;
1184 do {
1185 done_with_ephemerons = sgen_client_mark_ephemerons (ctx);
1186 sgen_drain_gray_stack (ctx);
1187 ++ephemeron_rounds;
1188 } while (!done_with_ephemerons);
1190 sgen_client_clear_unreachable_ephemerons (ctx);
1193 * We clear togglerefs only after all possible chances of revival are done.
1194 * This is semantically more inline with what users expect and it allows for
1195 * user finalizers to correctly interact with TR objects.
1197 sgen_client_clear_togglerefs (start_addr, end_addr, ctx);
1199 TV_GETTIME (btv);
1200 SGEN_LOG (2, "Finalize queue handling scan for %s generation: %lld usecs %d ephemeron rounds", generation_name (generation), (long long)TV_ELAPSED (atv, btv), ephemeron_rounds);
1203 * handle disappearing links
1204 * Note we do this after checking the finalization queue because if an object
1205 * survives (at least long enough to be finalized) we don't clear the link.
1206 * This also deals with a possible issue with the monitor reclamation: with the Boehm
1207 * GC a finalized object my lose the monitor because it is cleared before the finalizer is
1208 * called.
1210 g_assert (sgen_gray_object_queue_is_empty (queue));
1211 for (;;) {
1212 sgen_null_link_in_range (generation, ctx, TRUE);
1213 if (generation == GENERATION_OLD)
1214 sgen_null_link_in_range (GENERATION_NURSERY, ctx, TRUE);
1215 if (sgen_gray_object_queue_is_empty (queue))
1216 break;
1217 sgen_drain_gray_stack (ctx);
1220 g_assert (sgen_gray_object_queue_is_empty (queue));
1222 sgen_binary_protocol_finish_gray_stack_end (sgen_timestamp (), generation);
1225 void
1226 sgen_check_section_scan_starts (GCMemSection *section)
1228 size_t i;
1229 for (i = 0; i < section->num_scan_start; ++i) {
1230 if (section->scan_starts [i]) {
1231 mword size = safe_object_get_size ((GCObject*) section->scan_starts [i]);
1232 SGEN_ASSERT (0, size >= SGEN_CLIENT_MINIMUM_OBJECT_SIZE && size <= MAX_SMALL_OBJ_SIZE, "Weird object size at scan starts.");
1237 static void
1238 check_scan_starts (void)
1240 if (!do_scan_starts_check)
1241 return;
1242 sgen_check_section_scan_starts (sgen_nursery_section);
1243 sgen_major_collector.check_scan_starts ();
1246 static void
1247 scan_from_registered_roots (char *addr_start, char *addr_end, int root_type, ScanCopyContext ctx)
1249 void **start_root;
1250 RootRecord *root;
1251 SGEN_HASH_TABLE_FOREACH (&sgen_roots_hash [root_type], void **, start_root, RootRecord *, root) {
1252 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
1253 precisely_scan_objects_from (start_root, (void**)root->end_root, addr_start, addr_end, root->root_desc, ctx);
1254 } SGEN_HASH_TABLE_FOREACH_END;
1257 static void
1258 init_stats (void)
1260 static gboolean inited = FALSE;
1262 if (inited)
1263 return;
1265 mono_counters_register ("Collection max time", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME | MONO_COUNTER_MONOTONIC, &time_max);
1267 mono_counters_register ("Minor fragment clear", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_pre_collection_fragment_clear);
1268 mono_counters_register ("Minor pinning", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_pinning);
1269 mono_counters_register ("Minor scan remembered set", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_remsets);
1270 mono_counters_register ("Minor scan major blocks", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_major_blocks);
1271 mono_counters_register ("Minor scan los", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_los);
1272 mono_counters_register ("Minor scan pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_pinned);
1273 mono_counters_register ("Minor scan roots", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_roots);
1274 mono_counters_register ("Minor fragment creation", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_fragment_creation);
1276 mono_counters_register ("Major fragment clear", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_pre_collection_fragment_clear);
1277 mono_counters_register ("Major pinning", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_pinning);
1278 mono_counters_register ("Major scan pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_pinned);
1279 mono_counters_register ("Major scan roots", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_roots);
1280 mono_counters_register ("Major scan mod union blocks", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_mod_union_blocks);
1281 mono_counters_register ("Major scan mod union los", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_mod_union_los);
1282 mono_counters_register ("Major finish gray stack", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_finish_gray_stack);
1283 mono_counters_register ("Major free big objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_free_bigobjs);
1284 mono_counters_register ("Major LOS sweep", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_los_sweep);
1285 mono_counters_register ("Major sweep", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_sweep);
1286 mono_counters_register ("Major fragment creation", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_fragment_creation);
1288 mono_counters_register ("Number of pinned objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_pinned_objects);
1290 #ifdef HEAVY_STATISTICS
1291 mono_counters_register ("WBarrier remember pointer", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_add_to_global_remset);
1292 mono_counters_register ("WBarrier arrayref copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_arrayref_copy);
1293 mono_counters_register ("WBarrier generic store called", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_generic_store);
1294 mono_counters_register ("WBarrier generic atomic store called", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_generic_store_atomic);
1295 mono_counters_register ("WBarrier set root", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_set_root);
1297 mono_counters_register ("# objects allocated degraded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_alloced_degraded);
1298 mono_counters_register ("bytes allocated degraded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_bytes_alloced_degraded);
1300 mono_counters_register ("# copy_object() called (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copy_object_called_nursery);
1301 mono_counters_register ("# objects copied (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_copied_nursery);
1302 mono_counters_register ("# copy_object() called (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copy_object_called_major);
1303 mono_counters_register ("# objects copied (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_copied_major);
1305 mono_counters_register ("# scan_object() called (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scan_object_called_nursery);
1306 mono_counters_register ("# scan_object() called (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scan_object_called_major);
1308 mono_counters_register ("Slots allocated in vain", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_slots_allocated_in_vain);
1310 mono_counters_register ("# nursery copy_object() failed from space", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_from_space);
1311 mono_counters_register ("# nursery copy_object() failed forwarded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_forwarded);
1312 mono_counters_register ("# nursery copy_object() failed pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_pinned);
1313 mono_counters_register ("# nursery copy_object() failed to space", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_to_space);
1315 sgen_nursery_allocator_init_heavy_stats ();
1316 #endif
1318 inited = TRUE;
1322 static void
1323 reset_pinned_from_failed_allocation (void)
1325 bytes_pinned_from_failed_allocation = 0;
1328 void
1329 sgen_set_pinned_from_failed_allocation (mword objsize)
1331 bytes_pinned_from_failed_allocation += objsize;
1334 gboolean
1335 sgen_collection_is_concurrent (void)
1337 switch (sgen_current_collection_generation) {
1338 case GENERATION_NURSERY:
1339 return FALSE;
1340 case GENERATION_OLD:
1341 return sgen_concurrent_collection_in_progress;
1342 default:
1343 g_error ("Invalid current generation %d", sgen_current_collection_generation);
1345 return FALSE;
1348 gboolean
1349 sgen_get_concurrent_collection_in_progress (void)
1351 return sgen_concurrent_collection_in_progress;
1354 typedef struct {
1355 SgenThreadPoolJob job;
1356 SgenObjectOperations *ops;
1357 SgenGrayQueue *gc_thread_gray_queue;
1358 } ScanJob;
1360 typedef struct {
1361 ScanJob scan_job;
1362 int job_index, job_split_count;
1363 int data;
1364 } ParallelScanJob;
1366 static ScanCopyContext
1367 scan_copy_context_for_scan_job (void *worker_data_untyped, ScanJob *job)
1369 WorkerData *worker_data = (WorkerData *)worker_data_untyped;
1371 if (!job->ops) {
1373 * For jobs enqueued on workers we set the ops at job runtime in order
1374 * to be able to profit from on the fly optimized object ops or other
1375 * object ops changes, like forced concurrent finish.
1377 SGEN_ASSERT (0, sgen_workers_is_worker_thread (mono_native_thread_id_get ()), "We need a context for the scan job");
1378 job->ops = sgen_workers_get_idle_func_object_ops (worker_data);
1381 return CONTEXT_FROM_OBJECT_OPERATIONS (job->ops, sgen_workers_get_job_gray_queue (worker_data, job->gc_thread_gray_queue));
1384 typedef struct {
1385 ScanJob scan_job;
1386 char *heap_start;
1387 char *heap_end;
1388 int root_type;
1389 } ScanFromRegisteredRootsJob;
1391 static void
1392 job_scan_from_registered_roots (void *worker_data_untyped, SgenThreadPoolJob *job)
1394 ScanFromRegisteredRootsJob *job_data = (ScanFromRegisteredRootsJob*)job;
1395 ScanCopyContext ctx = scan_copy_context_for_scan_job (worker_data_untyped, &job_data->scan_job);
1397 scan_from_registered_roots (job_data->heap_start, job_data->heap_end, job_data->root_type, ctx);
1400 typedef struct {
1401 ScanJob scan_job;
1402 char *heap_start;
1403 char *heap_end;
1404 } ScanThreadDataJob;
1406 static void
1407 job_scan_thread_data (void *worker_data_untyped, SgenThreadPoolJob *job)
1409 ScanThreadDataJob *job_data = (ScanThreadDataJob*)job;
1410 ScanCopyContext ctx = scan_copy_context_for_scan_job (worker_data_untyped, &job_data->scan_job);
1412 sgen_client_scan_thread_data (job_data->heap_start, job_data->heap_end, TRUE, ctx);
1415 typedef struct {
1416 ScanJob scan_job;
1417 SgenPointerQueue *queue;
1418 } ScanFinalizerEntriesJob;
1420 static void
1421 job_scan_finalizer_entries (void *worker_data_untyped, SgenThreadPoolJob *job)
1423 ScanFinalizerEntriesJob *job_data = (ScanFinalizerEntriesJob*)job;
1424 ScanCopyContext ctx = scan_copy_context_for_scan_job (worker_data_untyped, &job_data->scan_job);
1426 scan_finalizer_entries (job_data->queue, ctx);
1429 static void
1430 job_scan_wbroots (void *worker_data_untyped, SgenThreadPoolJob *job)
1432 ScanJob *job_data = (ScanJob*)job;
1433 ScanCopyContext ctx = scan_copy_context_for_scan_job (worker_data_untyped, job_data);
1435 sgen_wbroots_scan_card_table (ctx);
1438 static void
1439 job_scan_major_card_table (void *worker_data_untyped, SgenThreadPoolJob *job)
1441 SGEN_TV_DECLARE (atv);
1442 SGEN_TV_DECLARE (btv);
1443 ParallelScanJob *job_data = (ParallelScanJob*)job;
1444 ScanCopyContext ctx = scan_copy_context_for_scan_job (worker_data_untyped, (ScanJob*)job_data);
1446 SGEN_TV_GETTIME (atv);
1447 sgen_major_collector.scan_card_table (CARDTABLE_SCAN_GLOBAL, ctx, job_data->job_index, job_data->job_split_count, job_data->data);
1448 SGEN_TV_GETTIME (btv);
1449 time_minor_scan_major_blocks += SGEN_TV_ELAPSED (atv, btv);
1451 if (worker_data_untyped)
1452 ((WorkerData*)worker_data_untyped)->major_scan_time += SGEN_TV_ELAPSED (atv, btv);
1455 static void
1456 job_scan_los_card_table (void *worker_data_untyped, SgenThreadPoolJob *job)
1458 SGEN_TV_DECLARE (atv);
1459 SGEN_TV_DECLARE (btv);
1460 ParallelScanJob *job_data = (ParallelScanJob*)job;
1461 ScanCopyContext ctx = scan_copy_context_for_scan_job (worker_data_untyped, (ScanJob*)job_data);
1463 SGEN_TV_GETTIME (atv);
1464 sgen_los_scan_card_table (CARDTABLE_SCAN_GLOBAL, ctx, job_data->job_index, job_data->job_split_count);
1465 SGEN_TV_GETTIME (btv);
1466 time_minor_scan_los += SGEN_TV_ELAPSED (atv, btv);
1468 if (worker_data_untyped)
1469 ((WorkerData*)worker_data_untyped)->los_scan_time += SGEN_TV_ELAPSED (atv, btv);
1472 static void
1473 job_scan_major_mod_union_card_table (void *worker_data_untyped, SgenThreadPoolJob *job)
1475 SGEN_TV_DECLARE (atv);
1476 SGEN_TV_DECLARE (btv);
1477 ParallelScanJob *job_data = (ParallelScanJob*)job;
1478 ScanCopyContext ctx = scan_copy_context_for_scan_job (worker_data_untyped, (ScanJob*)job_data);
1480 g_assert (sgen_concurrent_collection_in_progress);
1481 SGEN_TV_GETTIME (atv);
1482 sgen_major_collector.scan_card_table (CARDTABLE_SCAN_MOD_UNION, ctx, job_data->job_index, job_data->job_split_count, job_data->data);
1483 SGEN_TV_GETTIME (btv);
1484 time_major_scan_mod_union_blocks += SGEN_TV_ELAPSED (atv, btv);
1486 if (worker_data_untyped)
1487 ((WorkerData*)worker_data_untyped)->major_scan_time += SGEN_TV_ELAPSED (atv, btv);
1490 static void
1491 job_scan_los_mod_union_card_table (void *worker_data_untyped, SgenThreadPoolJob *job)
1493 SGEN_TV_DECLARE (atv);
1494 SGEN_TV_DECLARE (btv);
1495 ParallelScanJob *job_data = (ParallelScanJob*)job;
1496 ScanCopyContext ctx = scan_copy_context_for_scan_job (worker_data_untyped, (ScanJob*)job_data);
1498 g_assert (sgen_concurrent_collection_in_progress);
1499 SGEN_TV_GETTIME (atv);
1500 sgen_los_scan_card_table (CARDTABLE_SCAN_MOD_UNION, ctx, job_data->job_index, job_data->job_split_count);
1501 SGEN_TV_GETTIME (btv);
1502 time_major_scan_mod_union_los += SGEN_TV_ELAPSED (atv, btv);
1504 if (worker_data_untyped)
1505 ((WorkerData*)worker_data_untyped)->los_scan_time += SGEN_TV_ELAPSED (atv, btv);
1508 static void
1509 job_major_mod_union_preclean (void *worker_data_untyped, SgenThreadPoolJob *job)
1511 SGEN_TV_DECLARE (atv);
1512 SGEN_TV_DECLARE (btv);
1513 ParallelScanJob *job_data = (ParallelScanJob*)job;
1514 ScanCopyContext ctx = scan_copy_context_for_scan_job (worker_data_untyped, (ScanJob*)job_data);
1516 g_assert (sgen_concurrent_collection_in_progress);
1517 SGEN_TV_GETTIME (atv);
1518 sgen_major_collector.scan_card_table (CARDTABLE_SCAN_MOD_UNION_PRECLEAN, ctx, job_data->job_index, job_data->job_split_count, job_data->data);
1519 SGEN_TV_GETTIME (btv);
1521 g_assert (worker_data_untyped);
1522 ((WorkerData*)worker_data_untyped)->major_scan_time += SGEN_TV_ELAPSED (atv, btv);
1525 static void
1526 job_los_mod_union_preclean (void *worker_data_untyped, SgenThreadPoolJob *job)
1528 SGEN_TV_DECLARE (atv);
1529 SGEN_TV_DECLARE (btv);
1530 ParallelScanJob *job_data = (ParallelScanJob*)job;
1531 ScanCopyContext ctx = scan_copy_context_for_scan_job (worker_data_untyped, (ScanJob*)job_data);
1533 g_assert (sgen_concurrent_collection_in_progress);
1534 SGEN_TV_GETTIME (atv);
1535 sgen_los_scan_card_table (CARDTABLE_SCAN_MOD_UNION_PRECLEAN, ctx, job_data->job_index, job_data->job_split_count);
1536 SGEN_TV_GETTIME (btv);
1538 g_assert (worker_data_untyped);
1539 ((WorkerData*)worker_data_untyped)->los_scan_time += SGEN_TV_ELAPSED (atv, btv);
1542 static void
1543 job_scan_last_pinned (void *worker_data_untyped, SgenThreadPoolJob *job)
1545 ScanJob *job_data = (ScanJob*)job;
1546 ScanCopyContext ctx = scan_copy_context_for_scan_job (worker_data_untyped, job_data);
1548 g_assert (sgen_concurrent_collection_in_progress);
1550 sgen_scan_pin_queue_objects (ctx);
1553 static void
1554 workers_finish_callback (void)
1556 ParallelScanJob *psj;
1557 ScanJob *sj;
1558 size_t num_major_sections = sgen_major_collector.get_num_major_sections ();
1559 int split_count = sgen_workers_get_job_split_count (GENERATION_OLD);
1560 int i;
1561 /* Mod union preclean jobs */
1562 for (i = 0; i < split_count; i++) {
1563 psj = (ParallelScanJob*)sgen_thread_pool_job_alloc ("preclean major mod union cardtable", job_major_mod_union_preclean, sizeof (ParallelScanJob));
1564 psj->scan_job.gc_thread_gray_queue = NULL;
1565 psj->job_index = i;
1566 psj->job_split_count = split_count;
1567 psj->data = num_major_sections / split_count;
1568 sgen_workers_enqueue_job (GENERATION_OLD, &psj->scan_job.job, TRUE);
1571 for (i = 0; i < split_count; i++) {
1572 psj = (ParallelScanJob*)sgen_thread_pool_job_alloc ("preclean los mod union cardtable", job_los_mod_union_preclean, sizeof (ParallelScanJob));
1573 psj->scan_job.gc_thread_gray_queue = NULL;
1574 psj->job_index = i;
1575 psj->job_split_count = split_count;
1576 sgen_workers_enqueue_job (GENERATION_OLD, &psj->scan_job.job, TRUE);
1579 sj = (ScanJob*)sgen_thread_pool_job_alloc ("scan last pinned", job_scan_last_pinned, sizeof (ScanJob));
1580 sj->gc_thread_gray_queue = NULL;
1581 sgen_workers_enqueue_job (GENERATION_OLD, &sj->job, TRUE);
1584 static void
1585 init_gray_queue (SgenGrayQueue *gc_thread_gray_queue)
1587 sgen_gray_object_queue_init (gc_thread_gray_queue, NULL, TRUE);
1590 static void
1591 enqueue_scan_remembered_set_jobs (SgenGrayQueue *gc_thread_gray_queue, SgenObjectOperations *ops, gboolean enqueue)
1593 int i, split_count = sgen_workers_get_job_split_count (GENERATION_NURSERY);
1594 size_t num_major_sections = sgen_major_collector.get_num_major_sections ();
1595 ScanJob *sj;
1597 sj = (ScanJob*)sgen_thread_pool_job_alloc ("scan wbroots", job_scan_wbroots, sizeof (ScanJob));
1598 sj->ops = ops;
1599 sj->gc_thread_gray_queue = gc_thread_gray_queue;
1600 sgen_workers_enqueue_job (GENERATION_NURSERY, &sj->job, enqueue);
1602 for (i = 0; i < split_count; i++) {
1603 ParallelScanJob *psj;
1605 psj = (ParallelScanJob*)sgen_thread_pool_job_alloc ("scan major remsets", job_scan_major_card_table, sizeof (ParallelScanJob));
1606 psj->scan_job.ops = ops;
1607 psj->scan_job.gc_thread_gray_queue = gc_thread_gray_queue;
1608 psj->job_index = i;
1609 psj->job_split_count = split_count;
1610 psj->data = num_major_sections / split_count;
1611 sgen_workers_enqueue_job (GENERATION_NURSERY, &psj->scan_job.job, enqueue);
1613 psj = (ParallelScanJob*)sgen_thread_pool_job_alloc ("scan LOS remsets", job_scan_los_card_table, sizeof (ParallelScanJob));
1614 psj->scan_job.ops = ops;
1615 psj->scan_job.gc_thread_gray_queue = gc_thread_gray_queue;
1616 psj->job_index = i;
1617 psj->job_split_count = split_count;
1618 sgen_workers_enqueue_job (GENERATION_NURSERY, &psj->scan_job.job, enqueue);
1622 static void
1623 enqueue_scan_from_roots_jobs (SgenGrayQueue *gc_thread_gray_queue, char *heap_start, char *heap_end, SgenObjectOperations *ops, gboolean enqueue)
1625 ScanFromRegisteredRootsJob *scrrj;
1626 ScanThreadDataJob *stdj;
1627 ScanFinalizerEntriesJob *sfej;
1629 /* registered roots, this includes static fields */
1631 scrrj = (ScanFromRegisteredRootsJob*)sgen_thread_pool_job_alloc ("scan from registered roots normal", job_scan_from_registered_roots, sizeof (ScanFromRegisteredRootsJob));
1632 scrrj->scan_job.ops = ops;
1633 scrrj->scan_job.gc_thread_gray_queue = gc_thread_gray_queue;
1634 scrrj->heap_start = heap_start;
1635 scrrj->heap_end = heap_end;
1636 scrrj->root_type = ROOT_TYPE_NORMAL;
1637 sgen_workers_enqueue_job (sgen_current_collection_generation, &scrrj->scan_job.job, enqueue);
1639 if (sgen_current_collection_generation == GENERATION_OLD) {
1640 /* During minors we scan the cardtable for these roots instead */
1641 scrrj = (ScanFromRegisteredRootsJob*)sgen_thread_pool_job_alloc ("scan from registered roots wbarrier", job_scan_from_registered_roots, sizeof (ScanFromRegisteredRootsJob));
1642 scrrj->scan_job.ops = ops;
1643 scrrj->scan_job.gc_thread_gray_queue = gc_thread_gray_queue;
1644 scrrj->heap_start = heap_start;
1645 scrrj->heap_end = heap_end;
1646 scrrj->root_type = ROOT_TYPE_WBARRIER;
1647 sgen_workers_enqueue_job (sgen_current_collection_generation, &scrrj->scan_job.job, enqueue);
1650 /* Threads */
1652 stdj = (ScanThreadDataJob*)sgen_thread_pool_job_alloc ("scan thread data", job_scan_thread_data, sizeof (ScanThreadDataJob));
1653 stdj->scan_job.ops = ops;
1654 stdj->scan_job.gc_thread_gray_queue = gc_thread_gray_queue;
1655 stdj->heap_start = heap_start;
1656 stdj->heap_end = heap_end;
1657 sgen_workers_enqueue_job (sgen_current_collection_generation, &stdj->scan_job.job, enqueue);
1659 /* Scan the list of objects ready for finalization. */
1661 sfej = (ScanFinalizerEntriesJob*)sgen_thread_pool_job_alloc ("scan finalizer entries", job_scan_finalizer_entries, sizeof (ScanFinalizerEntriesJob));
1662 sfej->scan_job.ops = ops;
1663 sfej->scan_job.gc_thread_gray_queue = gc_thread_gray_queue;
1664 sfej->queue = &fin_ready_queue;
1665 sgen_workers_enqueue_job (sgen_current_collection_generation, &sfej->scan_job.job, enqueue);
1667 sfej = (ScanFinalizerEntriesJob*)sgen_thread_pool_job_alloc ("scan critical finalizer entries", job_scan_finalizer_entries, sizeof (ScanFinalizerEntriesJob));
1668 sfej->scan_job.ops = ops;
1669 sfej->scan_job.gc_thread_gray_queue = gc_thread_gray_queue;
1670 sfej->queue = &critical_fin_queue;
1671 sgen_workers_enqueue_job (sgen_current_collection_generation, &sfej->scan_job.job, enqueue);
1675 * Perform a nursery collection.
1677 * Return whether any objects were late-pinned due to being out of memory.
1679 static gboolean
1680 collect_nursery (const char *reason, gboolean is_overflow, SgenGrayQueue *unpin_queue)
1682 gboolean needs_major, is_parallel = FALSE;
1683 mword fragment_total;
1684 SgenGrayQueue gc_thread_gray_queue;
1685 SgenObjectOperations *object_ops_nopar, *object_ops_par = NULL;
1686 ScanCopyContext ctx;
1687 TV_DECLARE (atv);
1688 TV_DECLARE (btv);
1689 SGEN_TV_DECLARE (last_minor_collection_start_tv);
1690 SGEN_TV_DECLARE (last_minor_collection_end_tv);
1691 guint64 major_scan_start = time_minor_scan_major_blocks;
1692 guint64 los_scan_start = time_minor_scan_los;
1693 guint64 finish_gray_start = time_minor_finish_gray_stack;
1695 if (disable_minor_collections)
1696 return TRUE;
1698 TV_GETTIME (last_minor_collection_start_tv);
1699 atv = last_minor_collection_start_tv;
1701 sgen_binary_protocol_collection_begin (mono_atomic_load_i32 (&mono_gc_stats.minor_gc_count), GENERATION_NURSERY);
1703 object_ops_nopar = sgen_get_concurrent_collection_in_progress ()
1704 ? &sgen_minor_collector.serial_ops_with_concurrent_major
1705 : &sgen_minor_collector.serial_ops;
1706 if (sgen_minor_collector.is_parallel && sgen_nursery_size >= SGEN_PARALLEL_MINOR_MIN_NURSERY_SIZE) {
1707 object_ops_par = sgen_get_concurrent_collection_in_progress ()
1708 ? &sgen_minor_collector.parallel_ops_with_concurrent_major
1709 : &sgen_minor_collector.parallel_ops;
1710 is_parallel = TRUE;
1713 if (do_verify_nursery || do_dump_nursery_content)
1714 sgen_debug_verify_nursery (do_dump_nursery_content);
1716 sgen_current_collection_generation = GENERATION_NURSERY;
1718 SGEN_ASSERT (0, !sgen_collection_is_concurrent (), "Why is the nursery collection concurrent?");
1720 reset_pinned_from_failed_allocation ();
1722 check_scan_starts ();
1724 sgen_nursery_alloc_prepare_for_minor ();
1726 sgen_degraded_mode = 0;
1727 objects_pinned = 0;
1729 SGEN_LOG (1, "Start nursery collection %" G_GINT32_FORMAT " %p-%p, size: %d", mono_atomic_load_i32 (&mono_gc_stats.minor_gc_count), sgen_nursery_section->data, sgen_nursery_section->end_data, (int)(sgen_nursery_section->end_data - sgen_nursery_section->data));
1731 /* world must be stopped already */
1732 TV_GETTIME (btv);
1733 time_minor_pre_collection_fragment_clear += TV_ELAPSED (atv, btv);
1735 sgen_client_pre_collection_checks ();
1737 sgen_major_collector.start_nursery_collection ();
1739 sgen_memgov_minor_collection_start ();
1741 init_gray_queue (&gc_thread_gray_queue);
1742 ctx = CONTEXT_FROM_OBJECT_OPERATIONS (object_ops_nopar, &gc_thread_gray_queue);
1744 mono_atomic_inc_i32 (&mono_gc_stats.minor_gc_count);
1746 sgen_process_fin_stage_entries ();
1748 /* pin from pinned handles */
1749 sgen_init_pinning ();
1750 if (sgen_concurrent_collection_in_progress)
1751 sgen_init_pinning_for_conc ();
1752 sgen_client_binary_protocol_mark_start (GENERATION_NURSERY);
1753 pin_from_roots (sgen_nursery_section->data, sgen_nursery_section->end_data, ctx);
1754 /* pin cemented objects */
1755 sgen_pin_cemented_objects ();
1756 /* identify pinned objects */
1757 sgen_optimize_pin_queue ();
1758 sgen_pinning_setup_section (sgen_nursery_section);
1760 pin_objects_in_nursery (FALSE, ctx);
1761 sgen_pinning_trim_queue_to_section (sgen_nursery_section);
1762 if (sgen_concurrent_collection_in_progress)
1763 sgen_finish_pinning_for_conc ();
1765 if (remset_consistency_checks)
1766 sgen_check_remset_consistency ();
1768 if (whole_heap_check_before_collection) {
1769 sgen_clear_nursery_fragments ();
1770 sgen_check_whole_heap (FALSE);
1773 TV_GETTIME (atv);
1774 time_minor_pinning += TV_ELAPSED (btv, atv);
1775 SGEN_LOG (2, "Finding pinned pointers: %zd in %lld usecs", sgen_get_pinned_count (), (long long)TV_ELAPSED (btv, atv));
1776 SGEN_LOG (4, "Start scan with %zd pinned objects", sgen_get_pinned_count ());
1777 sgen_client_pinning_end ();
1779 remset.start_scan_remsets ();
1781 enqueue_scan_remembered_set_jobs (&gc_thread_gray_queue, is_parallel ? NULL : object_ops_nopar, is_parallel);
1783 /* we don't have complete write barrier yet, so we scan all the old generation sections */
1784 TV_GETTIME (btv);
1785 time_minor_scan_remsets += TV_ELAPSED (atv, btv);
1786 SGEN_LOG (2, "Old generation scan: %lld usecs", (long long)TV_ELAPSED (atv, btv));
1788 sgen_pin_stats_report ();
1790 TV_GETTIME (atv);
1791 time_minor_scan_pinned += TV_ELAPSED (btv, atv);
1793 enqueue_scan_from_roots_jobs (&gc_thread_gray_queue, sgen_nursery_section->data, sgen_nursery_section->end_data, is_parallel ? NULL : object_ops_nopar, is_parallel);
1795 if (is_parallel) {
1796 gray_queue_redirect (&gc_thread_gray_queue);
1797 sgen_workers_start_all_workers (GENERATION_NURSERY, object_ops_nopar, object_ops_par, NULL);
1798 sgen_workers_join (GENERATION_NURSERY);
1801 TV_GETTIME (btv);
1802 time_minor_scan_roots += TV_ELAPSED (atv, btv);
1804 finish_gray_stack (GENERATION_NURSERY, ctx);
1806 TV_GETTIME (atv);
1807 time_minor_finish_gray_stack += TV_ELAPSED (btv, atv);
1808 sgen_client_binary_protocol_mark_end (GENERATION_NURSERY);
1810 if (objects_pinned) {
1811 sgen_optimize_pin_queue ();
1812 sgen_pinning_setup_section (sgen_nursery_section);
1816 * This is the latest point at which we can do this check, because
1817 * sgen_build_nursery_fragments() unpins nursery objects again.
1819 if (remset_consistency_checks)
1820 sgen_check_remset_consistency ();
1823 if (sgen_max_pause_time) {
1824 int duration;
1826 TV_GETTIME (btv);
1827 duration = (int)(TV_ELAPSED (last_minor_collection_start_tv, btv) / 10000);
1828 if (duration > (sgen_max_pause_time * sgen_max_pause_margin))
1829 sgen_resize_nursery (TRUE);
1830 else
1831 sgen_resize_nursery (FALSE);
1832 } else {
1833 sgen_resize_nursery (FALSE);
1837 * This is used by the profiler to report GC roots.
1838 * Invariants: Heap's finished, no more moves left, objects still pinned in nursery.
1840 sgen_client_collecting_minor_report_roots (&fin_ready_queue, &critical_fin_queue);
1842 /* walk the pin_queue, build up the fragment list of free memory, unmark
1843 * pinned objects as we go, memzero() the empty fragments so they are ready for the
1844 * next allocations.
1846 sgen_client_binary_protocol_reclaim_start (GENERATION_NURSERY);
1847 fragment_total = sgen_build_nursery_fragments (sgen_nursery_section, unpin_queue);
1848 if (!fragment_total)
1849 sgen_degraded_mode = 1;
1851 /* Clear TLABs for all threads */
1852 sgen_clear_tlabs ();
1854 sgen_client_binary_protocol_reclaim_end (GENERATION_NURSERY);
1855 TV_GETTIME (btv);
1856 time_minor_fragment_creation += TV_ELAPSED (atv, btv);
1857 SGEN_LOG (2, "Fragment creation: %lld usecs, %lu bytes available", (long long)TV_ELAPSED (atv, btv), (unsigned long)fragment_total);
1859 if (remset_consistency_checks)
1860 sgen_check_major_refs ();
1862 sgen_major_collector.finish_nursery_collection ();
1864 TV_GETTIME (last_minor_collection_end_tv);
1865 UnlockedAdd64 (&mono_gc_stats.minor_gc_time, TV_ELAPSED (last_minor_collection_start_tv, last_minor_collection_end_tv));
1867 sgen_debug_dump_heap ("minor", mono_atomic_load_i32 (&mono_gc_stats.minor_gc_count) - 1, NULL);
1869 /* prepare the pin queue for the next collection */
1870 sgen_finish_pinning ();
1871 if (sgen_have_pending_finalizers ()) {
1872 SGEN_LOG (4, "Finalizer-thread wakeup");
1873 sgen_client_finalize_notify ();
1875 sgen_pin_stats_reset ();
1876 /* clear cemented hash */
1877 sgen_cement_clear_below_threshold ();
1879 sgen_gray_object_queue_dispose (&gc_thread_gray_queue);
1881 check_scan_starts ();
1883 sgen_binary_protocol_flush_buffers (FALSE);
1885 sgen_memgov_minor_collection_end (reason, is_overflow);
1887 /*objects are late pinned because of lack of memory, so a major is a good call*/
1888 needs_major = objects_pinned > 0;
1889 sgen_current_collection_generation = -1;
1890 objects_pinned = 0;
1892 if (is_parallel)
1893 sgen_binary_protocol_collection_end_stats (0, 0, time_minor_finish_gray_stack - finish_gray_start);
1894 else
1895 sgen_binary_protocol_collection_end_stats (
1896 time_minor_scan_major_blocks - major_scan_start,
1897 time_minor_scan_los - los_scan_start,
1898 time_minor_finish_gray_stack - finish_gray_start);
1900 sgen_binary_protocol_collection_end (mono_atomic_load_i32 (&mono_gc_stats.minor_gc_count) - 1, GENERATION_NURSERY, 0, 0);
1902 if (check_nursery_objects_pinned && !sgen_minor_collector.is_split)
1903 sgen_check_nursery_objects_pinned (unpin_queue != NULL);
1905 return needs_major;
1908 typedef enum {
1909 COPY_OR_MARK_FROM_ROOTS_SERIAL,
1910 COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT,
1911 COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT
1912 } CopyOrMarkFromRootsMode;
1914 static void
1915 major_copy_or_mark_from_roots (SgenGrayQueue *gc_thread_gray_queue, size_t *old_next_pin_slot, CopyOrMarkFromRootsMode mode, SgenObjectOperations *object_ops_nopar, SgenObjectOperations *object_ops_par)
1917 LOSObject *bigobj;
1918 TV_DECLARE (atv);
1919 TV_DECLARE (btv);
1920 /* FIXME: only use these values for the precise scan
1921 * note that to_space pointers should be excluded anyway...
1923 char *heap_start = NULL;
1924 char *heap_end = (char*)-1;
1925 ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (object_ops_nopar, gc_thread_gray_queue);
1926 gboolean concurrent = mode != COPY_OR_MARK_FROM_ROOTS_SERIAL;
1928 SGEN_ASSERT (0, !!concurrent == !!sgen_concurrent_collection_in_progress, "We've been called with the wrong mode.");
1930 if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
1931 /*This cleans up unused fragments */
1932 sgen_nursery_allocator_prepare_for_pinning ();
1934 if (do_concurrent_checks)
1935 sgen_debug_check_nursery_is_clean ();
1936 } else {
1937 /* The concurrent collector doesn't touch the nursery. */
1938 sgen_nursery_alloc_prepare_for_major ();
1941 TV_GETTIME (atv);
1943 /* Pinning depends on this */
1944 sgen_clear_nursery_fragments ();
1946 if (whole_heap_check_before_collection)
1947 sgen_check_whole_heap (TRUE);
1949 TV_GETTIME (btv);
1950 time_major_pre_collection_fragment_clear += TV_ELAPSED (atv, btv);
1952 objects_pinned = 0;
1954 sgen_client_pre_collection_checks ();
1956 if (mode != COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
1957 /* Remsets are not useful for a major collection */
1958 remset.clear_cards ();
1961 sgen_process_fin_stage_entries ();
1963 TV_GETTIME (atv);
1964 sgen_init_pinning ();
1965 if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT)
1966 sgen_init_pinning_for_conc ();
1967 SGEN_LOG (6, "Collecting pinned addresses");
1968 pin_from_roots ((void*)lowest_heap_address, (void*)highest_heap_address, ctx);
1969 if (mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT) {
1970 /* Pin cemented objects that were forced */
1971 sgen_pin_cemented_objects ();
1973 sgen_optimize_pin_queue ();
1974 if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
1976 * Cemented objects that are in the pinned list will be marked. When
1977 * marking concurrently we won't mark mod-union cards for these objects.
1978 * Instead they will remain cemented until the next major collection,
1979 * when we will recheck if they are still pinned in the roots.
1981 sgen_cement_force_pinned ();
1985 * pin_queue now contains all candidate pointers, sorted and
1986 * uniqued. We must do two passes now to figure out which
1987 * objects are pinned.
1989 * The first is to find within the pin_queue the area for each
1990 * section. This requires that the pin_queue be sorted. We
1991 * also process the LOS objects and pinned chunks here.
1993 * The second, destructive, pass is to reduce the section
1994 * areas to pointers to the actually pinned objects.
1996 SGEN_LOG (6, "Pinning from sections");
1997 /* first pass for the sections */
1998 sgen_find_section_pin_queue_start_end (sgen_nursery_section);
1999 /* identify possible pointers to the insize of large objects */
2000 SGEN_LOG (6, "Pinning from large objects");
2001 for (bigobj = sgen_los_object_list; bigobj; bigobj = bigobj->next) {
2002 size_t dummy;
2003 if (sgen_find_optimized_pin_queue_area ((char*)bigobj->data, (char*)bigobj->data + sgen_los_object_size (bigobj), &dummy, &dummy)) {
2004 sgen_binary_protocol_pin (bigobj->data, (gpointer)LOAD_VTABLE (bigobj->data), safe_object_get_size (bigobj->data));
2006 if (sgen_los_object_is_pinned (bigobj->data)) {
2007 SGEN_ASSERT (0, mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT, "LOS objects can only be pinned here after concurrent marking.");
2008 continue;
2010 sgen_los_pin_object (bigobj->data);
2011 if (SGEN_OBJECT_HAS_REFERENCES (bigobj->data))
2012 GRAY_OBJECT_ENQUEUE_SERIAL (gc_thread_gray_queue, bigobj->data, sgen_obj_get_descriptor ((GCObject*)bigobj->data));
2013 sgen_pin_stats_register_object (bigobj->data, GENERATION_OLD);
2014 SGEN_LOG (6, "Marked large object %p (%s) size: %lu from roots", bigobj->data,
2015 sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (bigobj->data)),
2016 (unsigned long)sgen_los_object_size (bigobj));
2018 sgen_client_pinned_los_object (bigobj->data);
2022 pin_objects_in_nursery (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT, ctx);
2023 if (check_nursery_objects_pinned && !sgen_minor_collector.is_split)
2024 sgen_check_nursery_objects_pinned (mode != COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT);
2026 sgen_major_collector.pin_objects (gc_thread_gray_queue);
2027 if (old_next_pin_slot)
2028 *old_next_pin_slot = sgen_get_pinned_count ();
2030 TV_GETTIME (btv);
2031 time_major_pinning += TV_ELAPSED (atv, btv);
2032 SGEN_LOG (2, "Finding pinned pointers: %zd in %lld usecs", sgen_get_pinned_count (), (long long)TV_ELAPSED (atv, btv));
2033 SGEN_LOG (4, "Start scan with %zd pinned objects", sgen_get_pinned_count ());
2034 sgen_client_pinning_end ();
2036 if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT)
2037 sgen_finish_pinning_for_conc ();
2039 sgen_major_collector.init_to_space ();
2041 SGEN_ASSERT (0, sgen_workers_all_done (), "Why are the workers not done when we start or finish a major collection?");
2042 if (mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT) {
2043 if (object_ops_par != NULL)
2044 sgen_workers_set_num_active_workers (GENERATION_OLD, 0);
2045 if (object_ops_par == NULL && sgen_workers_have_idle_work (GENERATION_OLD)) {
2047 * We force the finish of the worker with the new object ops context
2048 * which can also do copying. We need to have finished pinning. On the
2049 * parallel collector, there is no need to drain the private queues
2050 * here, since we can do it as part of the finishing work, achieving
2051 * better work distribution.
2053 sgen_workers_start_all_workers (GENERATION_OLD, object_ops_nopar, object_ops_par, NULL);
2055 sgen_workers_join (GENERATION_OLD);
2059 #ifdef SGEN_DEBUG_INTERNAL_ALLOC
2060 main_gc_thread = mono_native_thread_self ();
2061 #endif
2063 TV_GETTIME (atv);
2064 time_major_scan_pinned += TV_ELAPSED (btv, atv);
2066 enqueue_scan_from_roots_jobs (gc_thread_gray_queue, heap_start, heap_end, object_ops_nopar, FALSE);
2068 TV_GETTIME (btv);
2069 time_major_scan_roots += TV_ELAPSED (atv, btv);
2072 * We start the concurrent worker after pinning and after we scanned the roots
2073 * in order to make sure that the worker does not finish before handling all
2074 * the roots.
2076 if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
2077 sgen_workers_set_num_active_workers (GENERATION_OLD, 1);
2078 gray_queue_redirect (gc_thread_gray_queue);
2079 if (precleaning_enabled) {
2080 sgen_workers_start_all_workers (GENERATION_OLD, object_ops_nopar, object_ops_par, workers_finish_callback);
2081 } else {
2082 sgen_workers_start_all_workers (GENERATION_OLD, object_ops_nopar, object_ops_par, NULL);
2086 if (mode == COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT) {
2087 int i, split_count = sgen_workers_get_job_split_count (GENERATION_OLD);
2088 size_t num_major_sections = sgen_major_collector.get_num_major_sections ();
2089 gboolean parallel = object_ops_par != NULL;
2091 /* If we're not parallel we finish the collection on the gc thread */
2092 if (parallel)
2093 gray_queue_redirect (gc_thread_gray_queue);
2095 /* Mod union card table */
2096 for (i = 0; i < split_count; i++) {
2097 ParallelScanJob *psj;
2099 psj = (ParallelScanJob*)sgen_thread_pool_job_alloc ("scan mod union cardtable", job_scan_major_mod_union_card_table, sizeof (ParallelScanJob));
2100 psj->scan_job.ops = parallel ? NULL : object_ops_nopar;
2101 psj->scan_job.gc_thread_gray_queue = gc_thread_gray_queue;
2102 psj->job_index = i;
2103 psj->job_split_count = split_count;
2104 psj->data = num_major_sections / split_count;
2105 sgen_workers_enqueue_job (GENERATION_OLD, &psj->scan_job.job, parallel);
2107 psj = (ParallelScanJob*)sgen_thread_pool_job_alloc ("scan LOS mod union cardtable", job_scan_los_mod_union_card_table, sizeof (ParallelScanJob));
2108 psj->scan_job.ops = parallel ? NULL : object_ops_nopar;
2109 psj->scan_job.gc_thread_gray_queue = gc_thread_gray_queue;
2110 psj->job_index = i;
2111 psj->job_split_count = split_count;
2112 sgen_workers_enqueue_job (GENERATION_OLD, &psj->scan_job.job, parallel);
2115 if (parallel) {
2117 * If we enqueue a job while workers are running we need to sgen_workers_ensure_awake
2118 * in order to make sure that we are running the idle func and draining all worker
2119 * gray queues. The operation of starting workers implies this, so we start them after
2120 * in order to avoid doing this operation twice. The workers will drain the main gray
2121 * stack that contained roots and pinned objects and also scan the mod union card
2122 * table.
2124 sgen_workers_start_all_workers (GENERATION_OLD, object_ops_nopar, object_ops_par, NULL);
2125 sgen_workers_join (GENERATION_OLD);
2129 sgen_pin_stats_report ();
2131 if (mode == COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT) {
2132 sgen_finish_pinning ();
2134 sgen_pin_stats_reset ();
2136 if (do_concurrent_checks)
2137 sgen_debug_check_nursery_is_clean ();
2141 static void
2142 major_start_collection (SgenGrayQueue *gc_thread_gray_queue, const char *reason, gboolean concurrent, size_t *old_next_pin_slot)
2144 SgenObjectOperations *object_ops_nopar, *object_ops_par = NULL;
2146 if (concurrent) {
2147 g_assert (sgen_major_collector.is_concurrent);
2148 sgen_concurrent_collection_in_progress = TRUE;
2151 sgen_binary_protocol_collection_begin (mono_atomic_load_i32 (&mono_gc_stats.major_gc_count), GENERATION_OLD);
2153 sgen_current_collection_generation = GENERATION_OLD;
2155 sgen_workers_assert_gray_queue_is_empty (GENERATION_OLD);
2157 if (!concurrent)
2158 sgen_cement_reset ();
2160 if (concurrent) {
2161 object_ops_nopar = &sgen_major_collector.major_ops_concurrent_start;
2162 if (sgen_major_collector.is_parallel)
2163 object_ops_par = &sgen_major_collector.major_ops_conc_par_start;
2165 } else {
2166 object_ops_nopar = &sgen_major_collector.major_ops_serial;
2169 reset_pinned_from_failed_allocation ();
2171 sgen_memgov_major_collection_start (concurrent, reason);
2173 //count_ref_nonref_objs ();
2174 //consistency_check ();
2176 check_scan_starts ();
2178 sgen_degraded_mode = 0;
2179 SGEN_LOG (1, "Start major collection %" G_GINT32_FORMAT, mono_atomic_load_i32 (&mono_gc_stats.major_gc_count));
2180 mono_atomic_inc_i32 (&mono_gc_stats.major_gc_count);
2182 if (sgen_major_collector.start_major_collection)
2183 sgen_major_collector.start_major_collection ();
2185 major_copy_or_mark_from_roots (gc_thread_gray_queue, old_next_pin_slot, concurrent ? COPY_OR_MARK_FROM_ROOTS_START_CONCURRENT : COPY_OR_MARK_FROM_ROOTS_SERIAL, object_ops_nopar, object_ops_par);
2188 static void
2189 major_finish_collection (SgenGrayQueue *gc_thread_gray_queue, const char *reason, gboolean is_overflow, size_t old_next_pin_slot, gboolean forced)
2191 ScannedObjectCounts counts;
2192 SgenObjectOperations *object_ops_nopar;
2193 mword fragment_total;
2194 TV_DECLARE (atv);
2195 TV_DECLARE (btv);
2196 guint64 major_scan_start = time_major_scan_mod_union_blocks;
2197 guint64 los_scan_start = time_major_scan_mod_union_los;
2198 guint64 finish_gray_start = time_major_finish_gray_stack;
2200 if (sgen_concurrent_collection_in_progress) {
2201 SgenObjectOperations *object_ops_par = NULL;
2203 object_ops_nopar = &sgen_major_collector.major_ops_concurrent_finish;
2204 if (sgen_major_collector.is_parallel)
2205 object_ops_par = &sgen_major_collector.major_ops_conc_par_finish;
2207 major_copy_or_mark_from_roots (gc_thread_gray_queue, NULL, COPY_OR_MARK_FROM_ROOTS_FINISH_CONCURRENT, object_ops_nopar, object_ops_par);
2209 #ifdef SGEN_DEBUG_INTERNAL_ALLOC
2210 main_gc_thread = NULL;
2211 #endif
2212 } else {
2213 object_ops_nopar = &sgen_major_collector.major_ops_serial;
2216 sgen_workers_assert_gray_queue_is_empty (GENERATION_OLD);
2218 TV_GETTIME (btv);
2219 finish_gray_stack (GENERATION_OLD, CONTEXT_FROM_OBJECT_OPERATIONS (object_ops_nopar, gc_thread_gray_queue));
2220 TV_GETTIME (atv);
2221 time_major_finish_gray_stack += TV_ELAPSED (btv, atv);
2223 SGEN_ASSERT (0, sgen_workers_all_done (), "Can't have workers working after joining");
2225 if (objects_pinned) {
2226 g_assert (!sgen_concurrent_collection_in_progress);
2229 * This is slow, but we just OOM'd.
2231 * See comment at `sgen_pin_queue_clear_discarded_entries` for how the pin
2232 * queue is laid out at this point.
2234 sgen_pin_queue_clear_discarded_entries (sgen_nursery_section, old_next_pin_slot);
2236 * We need to reestablish all pinned nursery objects in the pin queue
2237 * because they're needed for fragment creation. Unpinning happens by
2238 * walking the whole queue, so it's not necessary to reestablish where major
2239 * heap block pins are - all we care is that they're still in there
2240 * somewhere.
2242 sgen_optimize_pin_queue ();
2243 sgen_find_section_pin_queue_start_end (sgen_nursery_section);
2244 objects_pinned = 0;
2247 reset_heap_boundaries ();
2248 sgen_update_heap_boundaries ((mword)sgen_get_nursery_start (), (mword)sgen_get_nursery_end ());
2251 * We collect the roots before unpinning objects in the nursery since we need to have
2252 * object liveness information for ephemeron root reporting.
2254 sgen_client_collecting_major_report_roots (&fin_ready_queue, &critical_fin_queue);
2256 /* walk the pin_queue, build up the fragment list of free memory, unmark
2257 * pinned objects as we go, memzero() the empty fragments so they are ready for the
2258 * next allocations.
2260 fragment_total = sgen_build_nursery_fragments (sgen_nursery_section, NULL);
2261 if (!fragment_total)
2262 sgen_degraded_mode = 1;
2263 SGEN_LOG (4, "Free space in nursery after major %ld", (long)fragment_total);
2265 if (do_concurrent_checks && sgen_concurrent_collection_in_progress)
2266 sgen_debug_check_nursery_is_clean ();
2268 /* prepare the pin queue for the next collection */
2269 sgen_finish_pinning ();
2271 /* Clear TLABs for all threads */
2272 sgen_clear_tlabs ();
2274 sgen_pin_stats_reset ();
2276 sgen_cement_clear_below_threshold ();
2278 if (check_mark_bits_after_major_collection)
2279 sgen_check_heap_marked (sgen_concurrent_collection_in_progress);
2281 TV_GETTIME (btv);
2282 time_major_fragment_creation += TV_ELAPSED (atv, btv);
2284 sgen_binary_protocol_sweep_begin (GENERATION_OLD, !sgen_major_collector.sweeps_lazily);
2285 sgen_memgov_major_pre_sweep ();
2287 TV_GETTIME (atv);
2288 time_major_free_bigobjs += TV_ELAPSED (btv, atv);
2290 sgen_los_sweep ();
2292 TV_GETTIME (btv);
2293 time_major_los_sweep += TV_ELAPSED (atv, btv);
2295 sgen_major_collector.sweep ();
2297 sgen_binary_protocol_sweep_end (GENERATION_OLD, !sgen_major_collector.sweeps_lazily);
2299 TV_GETTIME (atv);
2300 time_major_sweep += TV_ELAPSED (btv, atv);
2302 sgen_debug_dump_heap ("major", mono_atomic_load_i32 (&mono_gc_stats.major_gc_count) - 1, reason);
2304 if (sgen_have_pending_finalizers ()) {
2305 SGEN_LOG (4, "Finalizer-thread wakeup");
2306 sgen_client_finalize_notify ();
2309 sgen_memgov_major_collection_end (forced, sgen_concurrent_collection_in_progress, reason, is_overflow);
2310 sgen_current_collection_generation = -1;
2312 memset (&counts, 0, sizeof (ScannedObjectCounts));
2313 sgen_major_collector.finish_major_collection (&counts);
2315 sgen_workers_assert_gray_queue_is_empty (GENERATION_OLD);
2317 SGEN_ASSERT (0, sgen_workers_all_done (), "Can't have workers working after major collection has finished");
2319 check_scan_starts ();
2321 sgen_binary_protocol_flush_buffers (FALSE);
2323 //consistency_check ();
2324 if (sgen_major_collector.is_parallel)
2325 sgen_binary_protocol_collection_end_stats (0, 0, time_major_finish_gray_stack - finish_gray_start);
2326 else
2327 sgen_binary_protocol_collection_end_stats (
2328 time_major_scan_mod_union_blocks - major_scan_start,
2329 time_major_scan_mod_union_los - los_scan_start,
2330 time_major_finish_gray_stack - finish_gray_start);
2332 sgen_binary_protocol_collection_end (mono_atomic_load_i32 (&mono_gc_stats.major_gc_count) - 1, GENERATION_OLD, counts.num_scanned_objects, counts.num_unique_scanned_objects);
2334 if (sgen_concurrent_collection_in_progress)
2335 sgen_concurrent_collection_in_progress = FALSE;
2338 static gboolean
2339 major_do_collection (const char *reason, gboolean is_overflow, gboolean forced)
2341 TV_DECLARE (time_start);
2342 TV_DECLARE (time_end);
2343 size_t old_next_pin_slot;
2344 SgenGrayQueue gc_thread_gray_queue;
2346 if (disable_major_collections)
2347 return FALSE;
2349 if (sgen_major_collector.get_and_reset_num_major_objects_marked) {
2350 long long num_marked = sgen_major_collector.get_and_reset_num_major_objects_marked ();
2351 g_assert (!num_marked);
2354 /* world must be stopped already */
2355 TV_GETTIME (time_start);
2357 init_gray_queue (&gc_thread_gray_queue);
2358 major_start_collection (&gc_thread_gray_queue, reason, FALSE, &old_next_pin_slot);
2359 major_finish_collection (&gc_thread_gray_queue, reason, is_overflow, old_next_pin_slot, forced);
2360 sgen_gray_object_queue_dispose (&gc_thread_gray_queue);
2362 TV_GETTIME (time_end);
2363 UnlockedAdd64 (&mono_gc_stats.major_gc_time, TV_ELAPSED (time_start, time_end));
2365 /* FIXME: also report this to the user, preferably in gc-end. */
2366 if (sgen_major_collector.get_and_reset_num_major_objects_marked)
2367 sgen_major_collector.get_and_reset_num_major_objects_marked ();
2369 return bytes_pinned_from_failed_allocation > 0;
2372 static void
2373 major_start_concurrent_collection (const char *reason)
2375 TV_DECLARE (time_start);
2376 TV_DECLARE (time_end);
2377 long long num_objects_marked;
2378 SgenGrayQueue gc_thread_gray_queue;
2380 if (disable_major_collections)
2381 return;
2383 TV_GETTIME (time_start);
2384 SGEN_TV_GETTIME (time_major_conc_collection_start);
2386 num_objects_marked = sgen_major_collector.get_and_reset_num_major_objects_marked ();
2387 g_assert (num_objects_marked == 0);
2389 sgen_binary_protocol_concurrent_start ();
2391 init_gray_queue (&gc_thread_gray_queue);
2392 // FIXME: store reason and pass it when finishing
2393 major_start_collection (&gc_thread_gray_queue, reason, TRUE, NULL);
2394 sgen_gray_object_queue_dispose (&gc_thread_gray_queue);
2396 num_objects_marked = sgen_major_collector.get_and_reset_num_major_objects_marked ();
2398 TV_GETTIME (time_end);
2399 UnlockedAdd64 (&mono_gc_stats.major_gc_time, TV_ELAPSED (time_start, time_end));
2401 sgen_current_collection_generation = -1;
2405 * Returns whether the major collection has finished.
2407 static gboolean
2408 major_should_finish_concurrent_collection (void)
2410 return sgen_workers_all_done ();
2413 static void
2414 major_update_concurrent_collection (void)
2416 TV_DECLARE (total_start);
2417 TV_DECLARE (total_end);
2419 TV_GETTIME (total_start);
2421 sgen_binary_protocol_concurrent_update ();
2423 sgen_major_collector.update_cardtable_mod_union ();
2424 sgen_los_update_cardtable_mod_union ();
2426 TV_GETTIME (total_end);
2427 UnlockedAdd64 (&mono_gc_stats.major_gc_time, TV_ELAPSED (total_start, total_end));
2430 static void
2431 major_finish_concurrent_collection (gboolean forced)
2433 SgenGrayQueue gc_thread_gray_queue;
2434 TV_DECLARE (total_start);
2435 TV_DECLARE (total_end);
2437 TV_GETTIME (total_start);
2439 sgen_binary_protocol_concurrent_finish ();
2442 * We need to stop all workers since we're updating the cardtable below.
2443 * The workers will be resumed with a finishing pause context to avoid
2444 * additional cardtable and object scanning.
2446 sgen_workers_stop_all_workers (GENERATION_OLD);
2448 SGEN_TV_GETTIME (time_major_conc_collection_end);
2449 UnlockedAdd64 (&mono_gc_stats.major_gc_time_concurrent, SGEN_TV_ELAPSED (time_major_conc_collection_start, time_major_conc_collection_end));
2451 sgen_major_collector.update_cardtable_mod_union ();
2452 sgen_los_update_cardtable_mod_union ();
2454 if (mod_union_consistency_check)
2455 sgen_check_mod_union_consistency ();
2457 sgen_current_collection_generation = GENERATION_OLD;
2458 sgen_cement_reset ();
2459 init_gray_queue (&gc_thread_gray_queue);
2460 major_finish_collection (&gc_thread_gray_queue, "finishing", FALSE, -1, forced);
2461 sgen_gray_object_queue_dispose (&gc_thread_gray_queue);
2463 TV_GETTIME (total_end);
2464 UnlockedAdd64 (&mono_gc_stats.major_gc_time, TV_ELAPSED (total_start, total_end));
2466 sgen_current_collection_generation = -1;
2470 * Ensure an allocation request for @size will succeed by freeing enough memory.
2472 * LOCKING: The GC lock MUST be held.
2474 void
2475 sgen_ensure_free_space (size_t size, int generation)
2477 int generation_to_collect = -1;
2478 const char *reason = NULL;
2480 if (generation == GENERATION_OLD) {
2481 if (sgen_need_major_collection (size)) {
2482 reason = "LOS overflow";
2483 generation_to_collect = GENERATION_OLD;
2485 } else {
2486 if (sgen_degraded_mode) {
2487 if (sgen_need_major_collection (size)) {
2488 reason = "Degraded mode overflow";
2489 generation_to_collect = GENERATION_OLD;
2491 } else if (sgen_need_major_collection (size)) {
2492 reason = sgen_concurrent_collection_in_progress ? "Forced finish concurrent collection" : "Minor allowance";
2493 generation_to_collect = GENERATION_OLD;
2494 } else {
2495 generation_to_collect = GENERATION_NURSERY;
2496 reason = "Nursery full";
2500 if (generation_to_collect == -1) {
2501 if (sgen_concurrent_collection_in_progress && sgen_workers_all_done ()) {
2502 generation_to_collect = GENERATION_OLD;
2503 reason = "Finish concurrent collection";
2507 if (generation_to_collect == -1)
2508 return;
2509 sgen_perform_collection (size, generation_to_collect, reason, FALSE, TRUE);
2513 * LOCKING: Assumes the GC lock is held.
2515 static void
2516 sgen_perform_collection_inner (size_t requested_size, int generation_to_collect, const char *reason, gboolean forced_serial, gboolean stw)
2518 TV_DECLARE (gc_total_start);
2519 TV_DECLARE (gc_total_end);
2520 int overflow_generation_to_collect = -1;
2521 int oldest_generation_collected = generation_to_collect;
2522 const char *overflow_reason = NULL;
2523 gboolean finish_concurrent = sgen_concurrent_collection_in_progress && (major_should_finish_concurrent_collection () || generation_to_collect == GENERATION_OLD);
2525 sgen_binary_protocol_collection_requested (generation_to_collect, requested_size, forced_serial ? 1 : 0);
2527 SGEN_ASSERT (0, generation_to_collect == GENERATION_NURSERY || generation_to_collect == GENERATION_OLD, "What generation is this?");
2529 if (stw)
2530 sgen_stop_world (generation_to_collect, forced_serial || !sgen_major_collector.is_concurrent);
2531 else
2532 SGEN_ASSERT (0, sgen_is_world_stopped (), "We can only collect if the world is stopped");
2535 TV_GETTIME (gc_total_start);
2537 // FIXME: extract overflow reason
2538 // FIXME: minor overflow for concurrent case
2539 if (generation_to_collect == GENERATION_NURSERY && !finish_concurrent) {
2540 if (sgen_concurrent_collection_in_progress)
2541 major_update_concurrent_collection ();
2543 if (collect_nursery (reason, FALSE, NULL) && !sgen_concurrent_collection_in_progress) {
2544 overflow_generation_to_collect = GENERATION_OLD;
2545 overflow_reason = "Minor overflow";
2547 } else if (finish_concurrent) {
2548 major_finish_concurrent_collection (forced_serial);
2549 oldest_generation_collected = GENERATION_OLD;
2550 if (forced_serial && generation_to_collect == GENERATION_OLD)
2551 major_do_collection (reason, FALSE, TRUE);
2552 } else {
2553 SGEN_ASSERT (0, generation_to_collect == GENERATION_OLD, "We should have handled nursery collections above");
2554 if (sgen_major_collector.is_concurrent && !forced_serial) {
2555 collect_nursery ("Concurrent start", FALSE, NULL);
2556 major_start_concurrent_collection (reason);
2557 oldest_generation_collected = GENERATION_NURSERY;
2558 } else if (major_do_collection (reason, FALSE, forced_serial)) {
2559 overflow_generation_to_collect = GENERATION_NURSERY;
2560 overflow_reason = "Excessive pinning";
2564 if (overflow_generation_to_collect != -1) {
2565 SGEN_ASSERT (0, !sgen_concurrent_collection_in_progress, "We don't yet support overflow collections with the concurrent collector");
2568 * We need to do an overflow collection, either because we ran out of memory
2569 * or the nursery is fully pinned.
2572 if (overflow_generation_to_collect == GENERATION_NURSERY)
2573 collect_nursery (overflow_reason, TRUE, NULL);
2574 else
2575 major_do_collection (overflow_reason, TRUE, forced_serial);
2577 oldest_generation_collected = MAX (oldest_generation_collected, overflow_generation_to_collect);
2580 SGEN_LOG (2, "Heap size: %lu, LOS size: %lu", (unsigned long)sgen_gc_get_total_heap_allocation (), (unsigned long)sgen_los_memory_usage);
2582 /* this also sets the proper pointers for the next allocation */
2583 if (generation_to_collect == GENERATION_NURSERY && !sgen_can_alloc_size (requested_size)) {
2584 /* TypeBuilder and MonoMethod are killing mcs with fragmentation */
2585 SGEN_LOG (1, "nursery collection didn't find enough room for %zd alloc (%zd pinned)", requested_size, sgen_get_pinned_count ());
2586 sgen_dump_pin_queue ();
2587 sgen_degraded_mode = 1;
2590 TV_GETTIME (gc_total_end);
2591 time_max = MAX (time_max, TV_ELAPSED (gc_total_start, gc_total_end));
2593 if (stw)
2594 sgen_restart_world (oldest_generation_collected, forced_serial || !sgen_major_collector.is_concurrent);
2597 #ifdef HOST_WASM
2599 typedef struct {
2600 size_t requested_size;
2601 int generation_to_collect;
2602 const char *reason;
2603 } SgenGcRequest;
2605 static SgenGcRequest gc_request;
2607 #include <emscripten.h>
2609 static void
2610 gc_pump_callback (void)
2612 sgen_perform_collection_inner (gc_request.requested_size, gc_request.generation_to_collect, gc_request.reason, TRUE, TRUE);
2613 gc_request.generation_to_collect = 0;
2615 #endif
2617 void
2618 sgen_perform_collection (size_t requested_size, int generation_to_collect, const char *reason, gboolean forced_serial, gboolean stw)
2620 #ifdef HOST_WASM
2621 g_assert (stw); //can't handle non-stw mode (IE, domain unload)
2622 //we ignore forced_serial
2624 //There's a window for racing where we're executing other bg jobs before the GC, they trigger a GC request and it overrides this one.
2625 //I belive this case to be benign as it will, in the worst case, upgrade a minor to a major collection.
2626 if (gc_request.generation_to_collect <= generation_to_collect) {
2627 gc_request.requested_size = requested_size;
2628 gc_request.generation_to_collect = generation_to_collect;
2629 gc_request.reason = reason;
2630 sgen_client_schedule_background_job (gc_pump_callback);
2633 sgen_degraded_mode = 1; //enable degraded mode so allocation can continue
2634 #else
2635 sgen_perform_collection_inner (requested_size, generation_to_collect, reason, forced_serial, stw);
2636 #endif
2639 * ######################################################################
2640 * ######## Memory allocation from the OS
2641 * ######################################################################
2642 * This section of code deals with getting memory from the OS and
2643 * allocating memory for GC-internal data structures.
2644 * Internal memory can be handled with a freelist for small objects.
2648 * Debug reporting.
2650 G_GNUC_UNUSED static void
2651 report_internal_mem_usage (void)
2653 printf ("Internal memory usage:\n");
2654 sgen_report_internal_mem_usage ();
2655 printf ("Pinned memory usage:\n");
2656 sgen_major_collector.report_pinned_memory_usage ();
2660 * ######################################################################
2661 * ######## Finalization support
2662 * ######################################################################
2666 * This function returns true if @object is either alive and belongs to the
2667 * current collection - major collections are full heap, so old gen objects
2668 * are never alive during a minor collection.
2670 static inline int
2671 sgen_is_object_alive_and_on_current_collection (GCObject *object)
2673 if (ptr_in_nursery (object))
2674 return sgen_nursery_is_object_alive (object);
2676 if (sgen_current_collection_generation == GENERATION_NURSERY)
2677 return FALSE;
2679 return sgen_major_is_object_alive (object);
2683 gboolean
2684 sgen_gc_is_object_ready_for_finalization (GCObject *object)
2686 return !sgen_is_object_alive (object);
2689 void
2690 sgen_queue_finalization_entry (GCObject *obj)
2692 gboolean critical = sgen_client_object_has_critical_finalizer (obj);
2694 sgen_pointer_queue_add (critical ? &critical_fin_queue : &fin_ready_queue, obj);
2696 sgen_client_object_queued_for_finalization (obj);
2699 gboolean
2700 sgen_object_is_live (GCObject *obj)
2702 return sgen_is_object_alive_and_on_current_collection (obj);
2706 * `System.GC.WaitForPendingFinalizers` first checks `sgen_have_pending_finalizers()` to
2707 * determine whether it can exit quickly. The latter must therefore only return FALSE if
2708 * all finalizers have really finished running.
2710 * `sgen_gc_invoke_finalizers()` first dequeues a finalizable object, and then finalizes it.
2711 * This means that just checking whether the queues are empty leaves the possibility that an
2712 * object might have been dequeued but not yet finalized. That's why we need the additional
2713 * flag `pending_unqueued_finalizer`.
2716 static volatile gboolean pending_unqueued_finalizer = FALSE;
2717 volatile gboolean sgen_suspend_finalizers = FALSE;
2719 void
2720 sgen_set_suspend_finalizers (void)
2722 sgen_suspend_finalizers = TRUE;
2726 sgen_gc_invoke_finalizers (void)
2728 int count = 0;
2730 g_assert (!pending_unqueued_finalizer);
2732 /* FIXME: batch to reduce lock contention */
2733 while (sgen_have_pending_finalizers ()) {
2734 GCObject *obj;
2736 LOCK_GC;
2739 * We need to set `pending_unqueued_finalizer` before dequeing the
2740 * finalizable object.
2742 if (!sgen_pointer_queue_is_empty (&fin_ready_queue)) {
2743 pending_unqueued_finalizer = TRUE;
2744 mono_memory_write_barrier ();
2745 obj = (GCObject *)sgen_pointer_queue_pop (&fin_ready_queue);
2746 } else if (!sgen_pointer_queue_is_empty (&critical_fin_queue)) {
2747 pending_unqueued_finalizer = TRUE;
2748 mono_memory_write_barrier ();
2749 obj = (GCObject *)sgen_pointer_queue_pop (&critical_fin_queue);
2750 } else {
2751 obj = NULL;
2754 if (obj)
2755 SGEN_LOG (7, "Finalizing object %p (%s)", obj, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj)));
2757 UNLOCK_GC;
2759 if (!obj)
2760 break;
2762 count++;
2763 /* the object is on the stack so it is pinned */
2764 /*g_print ("Calling finalizer for object: %p (%s)\n", obj, sgen_client_object_safe_name (obj));*/
2765 sgen_client_run_finalize (obj);
2768 if (pending_unqueued_finalizer) {
2769 mono_memory_write_barrier ();
2770 pending_unqueued_finalizer = FALSE;
2773 return count;
2776 gboolean
2777 sgen_have_pending_finalizers (void)
2779 if (sgen_suspend_finalizers)
2780 return FALSE;
2781 return pending_unqueued_finalizer || !sgen_pointer_queue_is_empty (&fin_ready_queue) || !sgen_pointer_queue_is_empty (&critical_fin_queue);
2785 * ######################################################################
2786 * ######## registered roots support
2787 * ######################################################################
2791 * We do not coalesce roots.
2794 sgen_register_root (char *start, size_t size, SgenDescriptor descr, int root_type, MonoGCRootSource source, void *key, const char *msg)
2796 RootRecord new_root;
2797 int i;
2799 sgen_client_root_registered (start, size, source, key, msg);
2801 LOCK_GC;
2802 for (i = 0; i < ROOT_TYPE_NUM; ++i) {
2803 RootRecord *root = (RootRecord *)sgen_hash_table_lookup (&sgen_roots_hash [i], start);
2804 /* we allow changing the size and the descriptor (for thread statics etc) */
2805 if (root) {
2806 size_t old_size = root->end_root - start;
2807 root->end_root = start + size;
2808 SGEN_ASSERT (0, !!root->root_desc == !!descr, "Can't change whether a root is precise or conservative.");
2809 SGEN_ASSERT (0, root->source == source, "Can't change a root's source identifier.");
2810 SGEN_ASSERT (0, !!root->msg == !!msg, "Can't change a root's message.");
2811 root->root_desc = descr;
2812 roots_size += size;
2813 roots_size -= old_size;
2814 UNLOCK_GC;
2815 return TRUE;
2819 new_root.end_root = start + size;
2820 new_root.root_desc = descr;
2821 new_root.source = source;
2822 new_root.msg = msg;
2824 sgen_hash_table_replace (&sgen_roots_hash [root_type], start, &new_root, NULL);
2825 roots_size += size;
2827 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);
2829 UNLOCK_GC;
2830 return TRUE;
2833 void
2834 sgen_deregister_root (char* addr)
2836 int root_type;
2837 RootRecord root;
2839 sgen_client_root_deregistered (addr);
2841 LOCK_GC;
2842 for (root_type = 0; root_type < ROOT_TYPE_NUM; ++root_type) {
2843 if (sgen_hash_table_remove (&sgen_roots_hash [root_type], addr, &root))
2844 roots_size -= (root.end_root - addr);
2846 UNLOCK_GC;
2849 void
2850 sgen_wbroots_iterate_live_block_ranges (sgen_cardtable_block_callback cb)
2852 void **start_root;
2853 RootRecord *root;
2854 SGEN_HASH_TABLE_FOREACH (&sgen_roots_hash [ROOT_TYPE_WBARRIER], void **, start_root, RootRecord *, root) {
2855 cb ((mword)start_root, (mword)root->end_root - (mword)start_root);
2856 } SGEN_HASH_TABLE_FOREACH_END;
2859 /* Root equivalent of sgen_client_cardtable_scan_object */
2860 static void
2861 sgen_wbroot_scan_card_table (void** start_root, mword size, ScanCopyContext ctx)
2863 ScanPtrFieldFunc scan_field_func = ctx.ops->scan_ptr_field;
2864 guint8 *card_data = sgen_card_table_get_card_scan_address ((mword)start_root);
2865 guint8 *card_base = card_data;
2866 mword card_count = sgen_card_table_number_of_cards_in_range ((mword)start_root, size);
2867 guint8 *card_data_end = card_data + card_count;
2868 mword extra_idx = 0;
2869 char *obj_start = (char*)sgen_card_table_align_pointer (start_root);
2870 char *obj_end = (char*)start_root + size;
2871 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
2872 guint8 *overflow_scan_end = NULL;
2873 #endif
2875 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
2876 /*Check for overflow and if so, setup to scan in two steps*/
2877 if (card_data_end >= SGEN_SHADOW_CARDTABLE_END) {
2878 overflow_scan_end = sgen_shadow_cardtable + (card_data_end - SGEN_SHADOW_CARDTABLE_END);
2879 card_data_end = SGEN_SHADOW_CARDTABLE_END;
2882 LOOP_HEAD:
2883 #endif
2885 card_data = sgen_find_next_card (card_data, card_data_end);
2887 for (; card_data < card_data_end; card_data = sgen_find_next_card (card_data + 1, card_data_end)) {
2888 size_t idx = (card_data - card_base) + extra_idx;
2889 char *start = (char*)(obj_start + idx * CARD_SIZE_IN_BYTES);
2890 char *card_end = start + CARD_SIZE_IN_BYTES;
2891 char *elem = start, *first_elem = start;
2894 * Don't clean first and last card on 32bit systems since they
2895 * may also be part from other roots.
2897 if (card_data != card_base && card_data != (card_data_end - 1))
2898 sgen_card_table_prepare_card_for_scanning (card_data);
2900 card_end = MIN (card_end, obj_end);
2902 if (elem < (char*)start_root)
2903 first_elem = elem = (char*)start_root;
2905 for (; elem < card_end; elem += SIZEOF_VOID_P) {
2906 if (*(GCObject**)elem)
2907 scan_field_func (NULL, (GCObject**)elem, ctx.queue);
2910 sgen_binary_protocol_card_scan (first_elem, elem - first_elem);
2913 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
2914 if (overflow_scan_end) {
2915 extra_idx = card_data - card_base;
2916 card_base = card_data = sgen_shadow_cardtable;
2917 card_data_end = overflow_scan_end;
2918 overflow_scan_end = NULL;
2919 goto LOOP_HEAD;
2921 #endif
2924 void
2925 sgen_wbroots_scan_card_table (ScanCopyContext ctx)
2927 void **start_root;
2928 RootRecord *root;
2930 SGEN_HASH_TABLE_FOREACH (&sgen_roots_hash [ROOT_TYPE_WBARRIER], void **, start_root, RootRecord *, root) {
2931 SGEN_ASSERT (0, (root->root_desc & ROOT_DESC_TYPE_MASK) == ROOT_DESC_VECTOR, "Unsupported root type");
2933 sgen_wbroot_scan_card_table (start_root, (mword)root->end_root - (mword)start_root, ctx);
2934 } SGEN_HASH_TABLE_FOREACH_END;
2938 * ######################################################################
2939 * ######## Thread handling (stop/start code)
2940 * ######################################################################
2944 sgen_get_current_collection_generation (void)
2946 return sgen_current_collection_generation;
2949 void*
2950 sgen_thread_attach (SgenThreadInfo* info)
2952 info->tlab_start = info->tlab_next = info->tlab_temp_end = info->tlab_real_end = NULL;
2954 sgen_client_thread_attach (info);
2956 return info;
2959 void
2960 sgen_thread_detach_with_lock (SgenThreadInfo *p)
2962 sgen_client_thread_detach_with_lock (p);
2966 * ######################################################################
2967 * ######## Write barriers
2968 * ######################################################################
2972 * Note: the write barriers first do the needed GC work and then do the actual store:
2973 * this way the value is visible to the conservative GC scan after the write barrier
2974 * itself. If a GC interrupts the barrier in the middle, value will be kept alive by
2975 * the conservative scan, otherwise by the remembered set scan.
2979 * mono_gc_wbarrier_arrayref_copy:
2981 void
2982 mono_gc_wbarrier_arrayref_copy (gpointer dest_ptr, gpointer src_ptr, int count)
2984 HEAVY_STAT (++stat_wbarrier_arrayref_copy);
2985 /*This check can be done without taking a lock since dest_ptr array is pinned*/
2986 if (ptr_in_nursery (dest_ptr) || count <= 0) {
2987 mono_gc_memmove_aligned (dest_ptr, src_ptr, count * sizeof (gpointer));
2988 return;
2991 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
2992 if (sgen_binary_protocol_is_heavy_enabled ()) {
2993 int i;
2994 for (i = 0; i < count; ++i) {
2995 gpointer dest = (gpointer*)dest_ptr + i;
2996 gpointer obj = *((gpointer*)src_ptr + i);
2997 if (obj)
2998 sgen_binary_protocol_wbarrier (dest, obj, (gpointer)LOAD_VTABLE (obj));
3001 #endif
3003 remset.wbarrier_arrayref_copy (dest_ptr, src_ptr, count);
3007 * mono_gc_wbarrier_generic_nostore:
3009 void
3010 mono_gc_wbarrier_generic_nostore (gpointer ptr)
3012 gpointer obj;
3014 HEAVY_STAT (++stat_wbarrier_generic_store);
3016 sgen_client_wbarrier_generic_nostore_check (ptr);
3018 obj = *(gpointer*)ptr;
3019 if (obj)
3020 sgen_binary_protocol_wbarrier (ptr, obj, (gpointer)LOAD_VTABLE (obj));
3023 * We need to record old->old pointer locations for the
3024 * concurrent collector.
3026 if (!ptr_in_nursery (obj) && !sgen_concurrent_collection_in_progress) {
3027 SGEN_LOG (8, "Skipping remset at %p", ptr);
3028 return;
3031 SGEN_LOG (8, "Adding remset at %p", ptr);
3033 remset.wbarrier_generic_nostore (ptr);
3037 * mono_gc_wbarrier_generic_store:
3039 void
3040 mono_gc_wbarrier_generic_store (gpointer ptr, GCObject* value)
3042 SGEN_LOG (8, "Wbarrier store at %p to %p (%s)", ptr, value, value ? sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (value)) : "null");
3043 SGEN_UPDATE_REFERENCE_ALLOW_NULL (ptr, value);
3044 if (ptr_in_nursery (value) || sgen_concurrent_collection_in_progress)
3045 mono_gc_wbarrier_generic_nostore (ptr);
3046 sgen_dummy_use (value);
3050 * mono_gc_wbarrier_generic_store_atomic:
3051 * Same as \c mono_gc_wbarrier_generic_store but performs the store
3052 * as an atomic operation with release semantics.
3054 void
3055 mono_gc_wbarrier_generic_store_atomic (gpointer ptr, GCObject *value)
3057 HEAVY_STAT (++stat_wbarrier_generic_store_atomic);
3059 SGEN_LOG (8, "Wbarrier atomic store at %p to %p (%s)", ptr, value, value ? sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (value)) : "null");
3061 mono_atomic_store_ptr ((volatile gpointer *)ptr, value);
3063 if (ptr_in_nursery (value) || sgen_concurrent_collection_in_progress)
3064 mono_gc_wbarrier_generic_nostore (ptr);
3066 sgen_dummy_use (value);
3069 void
3070 sgen_wbarrier_range_copy (gpointer _dest, gconstpointer _src, int size)
3072 remset.wbarrier_range_copy (_dest,_src, size);
3076 * ######################################################################
3077 * ######## Other mono public interface functions.
3078 * ######################################################################
3081 void
3082 sgen_gc_collect (int generation)
3084 LOCK_GC;
3085 if (generation > 1)
3086 generation = 1;
3087 sgen_perform_collection (0, generation, "user request", TRUE, TRUE);
3088 /* Make sure we don't exceed heap size allowance by promoting */
3089 if (generation == GENERATION_NURSERY && sgen_need_major_collection (0))
3090 sgen_perform_collection (0, GENERATION_OLD, "Minor allowance", FALSE, TRUE);
3091 UNLOCK_GC;
3095 sgen_gc_collection_count (int generation)
3097 return mono_atomic_load_i32 (generation == GENERATION_NURSERY ? &mono_gc_stats.minor_gc_count : &mono_gc_stats.major_gc_count);
3100 size_t
3101 sgen_gc_get_used_size (void)
3103 gint64 tot = 0;
3104 LOCK_GC;
3105 tot = sgen_los_memory_usage;
3106 tot += sgen_nursery_section->end_data - sgen_nursery_section->data;
3107 tot += sgen_major_collector.get_used_size ();
3108 /* FIXME: account for pinned objects */
3109 UNLOCK_GC;
3110 return tot;
3113 void
3114 sgen_env_var_error (const char *env_var, const char *fallback, const char *description_format, ...)
3116 va_list ap;
3118 va_start (ap, description_format);
3120 fprintf (stderr, "Warning: In environment variable `%s': ", env_var);
3121 vfprintf (stderr, description_format, ap);
3122 if (fallback)
3123 fprintf (stderr, " - %s", fallback);
3124 fprintf (stderr, "\n");
3126 va_end (ap);
3129 static gboolean
3130 parse_double_in_interval (const char *env_var, const char *opt_name, const char *opt, double min, double max, double *result)
3132 char *endptr;
3133 double val = strtod (opt, &endptr);
3134 if (endptr == opt) {
3135 sgen_env_var_error (env_var, "Using default value.", "`%s` must be a number.", opt_name);
3136 return FALSE;
3138 else if (val < min || val > max) {
3139 sgen_env_var_error (env_var, "Using default value.", "`%s` must be between %.2f - %.2f.", opt_name, min, max);
3140 return FALSE;
3142 *result = val;
3143 return TRUE;
3146 static SgenMinor
3147 parse_sgen_minor (const char *opt)
3149 if (!opt)
3150 return SGEN_MINOR_DEFAULT;
3152 if (!strcmp (opt, "simple")) {
3153 return SGEN_MINOR_SIMPLE;
3154 } else if (!strcmp (opt, "simple-par")) {
3155 return SGEN_MINOR_SIMPLE_PARALLEL;
3156 } else if (!strcmp (opt, "split")) {
3157 return SGEN_MINOR_SPLIT;
3158 } else {
3159 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default instead.", "Unknown minor collector `%s'.", opt);
3160 return SGEN_MINOR_DEFAULT;
3164 static SgenMajor
3165 parse_sgen_major (const char *opt)
3167 if (!opt)
3168 return SGEN_MAJOR_DEFAULT;
3170 if (!strcmp (opt, "marksweep")) {
3171 return SGEN_MAJOR_SERIAL;
3172 } else if (!strcmp (opt, "marksweep-conc")) {
3173 return SGEN_MAJOR_CONCURRENT;
3174 } else if (!strcmp (opt, "marksweep-conc-par")) {
3175 return SGEN_MAJOR_CONCURRENT_PARALLEL;
3176 } else {
3177 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default instead.", "Unknown major collector `%s'.", opt);
3178 return SGEN_MAJOR_DEFAULT;
3183 static SgenMode
3184 parse_sgen_mode (const char *opt)
3186 if (!opt)
3187 return SGEN_MODE_NONE;
3189 if (!strcmp (opt, "balanced")) {
3190 return SGEN_MODE_BALANCED;
3191 } else if (!strcmp (opt, "throughput")) {
3192 return SGEN_MODE_THROUGHPUT;
3193 } else if (!strcmp (opt, "pause") || g_str_has_prefix (opt, "pause:")) {
3194 return SGEN_MODE_PAUSE;
3195 } else {
3196 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default configurations.", "Unknown mode `%s'.", opt);
3197 return SGEN_MODE_NONE;
3201 static void
3202 init_sgen_minor (SgenMinor minor)
3204 switch (minor) {
3205 case SGEN_MINOR_DEFAULT:
3206 case SGEN_MINOR_SIMPLE:
3207 sgen_simple_nursery_init (&sgen_minor_collector, FALSE);
3208 break;
3209 case SGEN_MINOR_SIMPLE_PARALLEL:
3210 #ifndef DISABLE_SGEN_MAJOR_MARKSWEEP_CONC
3211 sgen_simple_nursery_init (&sgen_minor_collector, TRUE);
3212 #else
3213 g_error ("Sgen was build with concurrent collector disabled");
3214 #endif
3215 break;
3216 case SGEN_MINOR_SPLIT:
3217 #ifndef DISABLE_SGEN_SPLIT_NURSERY
3218 sgen_split_nursery_init (&sgen_minor_collector);
3219 #else
3220 g_error ("Sgenw as build with split nursery disabled");
3221 #endif
3222 break;
3223 default:
3224 g_assert_not_reached ();
3228 static void
3229 init_sgen_major (SgenMajor major)
3231 if (major == SGEN_MAJOR_DEFAULT)
3232 major = DEFAULT_MAJOR;
3234 switch (major) {
3235 case SGEN_MAJOR_SERIAL:
3236 sgen_marksweep_init (&sgen_major_collector);
3237 break;
3238 #ifdef DISABLE_SGEN_MAJOR_MARKSWEEP_CONC
3239 case SGEN_MAJOR_CONCURRENT:
3240 case SGEN_MAJOR_CONCURRENT_PARALLEL:
3241 g_error ("Sgen was build with the concurent collector disabled");
3242 #else
3243 case SGEN_MAJOR_CONCURRENT:
3244 sgen_marksweep_conc_init (&sgen_major_collector);
3245 break;
3246 case SGEN_MAJOR_CONCURRENT_PARALLEL:
3247 sgen_marksweep_conc_par_init (&sgen_major_collector);
3248 break;
3249 #endif
3250 default:
3251 g_assert_not_reached ();
3256 * If sgen mode is set, major/minor configuration is fixed. The other gc_params
3257 * are parsed and processed after major/minor initialization, so it can potentially
3258 * override some knobs set by the sgen mode. We can consider locking out additional
3259 * configurations when gc_modes are used.
3261 static void
3262 init_sgen_mode (SgenMode mode)
3264 SgenMinor minor = SGEN_MINOR_DEFAULT;
3265 SgenMajor major = SGEN_MAJOR_DEFAULT;
3267 switch (mode) {
3268 case SGEN_MODE_BALANCED:
3270 * Use a dynamic parallel nursery with a major concurrent collector.
3271 * This uses the default values for max pause time and nursery size.
3273 minor = SGEN_MINOR_SIMPLE;
3274 major = SGEN_MAJOR_CONCURRENT;
3275 dynamic_nursery = TRUE;
3276 break;
3277 case SGEN_MODE_THROUGHPUT:
3279 * Use concurrent major to let the mutator do more work. Use a larger
3280 * nursery, without pause time constraints, in order to collect more
3281 * objects in parallel and avoid repetitive collection tasks (pinning,
3282 * root scanning etc)
3284 minor = SGEN_MINOR_SIMPLE_PARALLEL;
3285 major = SGEN_MAJOR_CONCURRENT;
3286 dynamic_nursery = TRUE;
3287 sgen_max_pause_time = 0;
3288 break;
3289 case SGEN_MODE_PAUSE:
3291 * Use concurrent major and dynamic nursery with a more
3292 * aggressive shrinking relative to pause times.
3294 minor = SGEN_MINOR_SIMPLE_PARALLEL;
3295 major = SGEN_MAJOR_CONCURRENT;
3296 dynamic_nursery = TRUE;
3297 sgen_max_pause_margin = SGEN_PAUSE_MODE_MAX_PAUSE_MARGIN;
3298 break;
3299 default:
3300 g_assert_not_reached ();
3303 init_sgen_minor (minor);
3304 init_sgen_major (major);
3307 void
3308 sgen_gc_init (void)
3310 char *env;
3311 char **opts, **ptr;
3312 SgenMajor sgen_major = SGEN_MAJOR_DEFAULT;
3313 SgenMinor sgen_minor = SGEN_MINOR_DEFAULT;
3314 SgenMode sgen_mode = SGEN_MODE_NONE;
3315 char *params_opts = NULL;
3316 char *debug_opts = NULL;
3317 size_t max_heap = 0;
3318 size_t soft_limit = 0;
3319 int result;
3320 gboolean debug_print_allowance = FALSE;
3321 double allowance_ratio = 0, save_target = 0;
3322 gboolean cement_enabled = TRUE;
3324 do {
3325 result = mono_atomic_cas_i32 (&gc_initialized, -1, 0);
3326 switch (result) {
3327 case 1:
3328 /* already inited */
3329 return;
3330 case -1:
3331 /* being inited by another thread */
3332 mono_thread_info_usleep (1000);
3333 break;
3334 case 0:
3335 /* we will init it */
3336 break;
3337 default:
3338 g_assert_not_reached ();
3340 } while (result != 0);
3342 SGEN_TV_GETTIME (sgen_init_timestamp);
3344 #ifdef SGEN_WITHOUT_MONO
3345 mono_thread_smr_init ();
3346 #endif
3348 mono_coop_mutex_init (&sgen_gc_mutex);
3350 sgen_gc_debug_file = stderr;
3352 mono_coop_mutex_init (&sgen_interruption_mutex);
3354 if ((env = g_getenv (MONO_GC_PARAMS_NAME)) || gc_params_options) {
3355 params_opts = g_strdup_printf ("%s,%s", gc_params_options ? gc_params_options : "", env ? env : "");
3356 g_free (env);
3359 if (params_opts) {
3360 opts = g_strsplit (params_opts, ",", -1);
3361 for (ptr = opts; *ptr; ++ptr) {
3362 char *opt = *ptr;
3363 if (g_str_has_prefix (opt, "major=")) {
3364 opt = strchr (opt, '=') + 1;
3365 sgen_major = parse_sgen_major (opt);
3366 } else if (g_str_has_prefix (opt, "minor=")) {
3367 opt = strchr (opt, '=') + 1;
3368 sgen_minor = parse_sgen_minor (opt);
3369 } else if (g_str_has_prefix (opt, "mode=")) {
3370 opt = strchr (opt, '=') + 1;
3371 sgen_mode = parse_sgen_mode (opt);
3374 } else {
3375 opts = NULL;
3378 init_stats ();
3379 sgen_init_internal_allocator ();
3380 sgen_init_nursery_allocator ();
3381 sgen_init_fin_weak_hash ();
3382 sgen_init_hash_table ();
3383 sgen_init_descriptors ();
3384 sgen_init_gray_queues ();
3385 sgen_init_allocator ();
3386 sgen_init_gchandles ();
3388 sgen_register_fixed_internal_mem_type (INTERNAL_MEM_SECTION, SGEN_SIZEOF_GC_MEM_SECTION);
3389 sgen_register_fixed_internal_mem_type (INTERNAL_MEM_GRAY_QUEUE, sizeof (GrayQueueSection));
3391 sgen_client_init ();
3393 if (sgen_mode != SGEN_MODE_NONE) {
3394 if (sgen_minor != SGEN_MINOR_DEFAULT || sgen_major != SGEN_MAJOR_DEFAULT)
3395 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Ignoring major/minor configuration", "Major/minor configurations cannot be used with sgen modes");
3396 init_sgen_mode (sgen_mode);
3397 } else {
3398 init_sgen_minor (sgen_minor);
3399 init_sgen_major (sgen_major);
3402 if (opts) {
3403 gboolean usage_printed = FALSE;
3405 for (ptr = opts; *ptr; ++ptr) {
3406 char *opt = *ptr;
3407 if (!strcmp (opt, ""))
3408 continue;
3409 if (g_str_has_prefix (opt, "major="))
3410 continue;
3411 if (g_str_has_prefix (opt, "minor="))
3412 continue;
3413 if (g_str_has_prefix (opt, "mode=")) {
3414 if (g_str_has_prefix (opt, "mode=pause:")) {
3415 char *str_pause = strchr (opt, ':') + 1;
3416 int pause = atoi (str_pause);
3417 if (pause)
3418 sgen_max_pause_time = pause;
3419 else
3420 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default", "Invalid maximum pause time for `pause` sgen mode");
3422 continue;
3424 if (g_str_has_prefix (opt, "max-heap-size=")) {
3425 size_t page_size = mono_pagesize ();
3426 size_t max_heap_candidate = 0;
3427 opt = strchr (opt, '=') + 1;
3428 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &max_heap_candidate)) {
3429 max_heap = (max_heap_candidate + page_size - 1) & ~(size_t)(page_size - 1);
3430 if (max_heap != max_heap_candidate)
3431 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Rounding up.", "`max-heap-size` size must be a multiple of %d.", page_size);
3432 } else {
3433 sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`max-heap-size` must be an integer.");
3435 continue;
3437 if (g_str_has_prefix (opt, "soft-heap-limit=")) {
3438 opt = strchr (opt, '=') + 1;
3439 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &soft_limit)) {
3440 if (soft_limit <= 0) {
3441 sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`soft-heap-limit` must be positive.");
3442 soft_limit = 0;
3444 } else {
3445 sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`soft-heap-limit` must be an integer.");
3447 continue;
3449 if (g_str_has_prefix (opt, "nursery-size=")) {
3450 size_t val;
3451 opt = strchr (opt, '=') + 1;
3452 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &val)) {
3453 if ((val & (val - 1))) {
3454 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.", "`nursery-size` must be a power of two.");
3455 continue;
3458 if (val < SGEN_MAX_NURSERY_WASTE) {
3459 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.",
3460 "`nursery-size` must be at least %d bytes.", SGEN_MAX_NURSERY_WASTE);
3461 continue;
3463 #ifdef SGEN_MAX_NURSERY_SIZE
3464 if (val > SGEN_MAX_NURSERY_SIZE) {
3465 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.",
3466 "`nursery-size` must be smaller than %lld bytes.", SGEN_MAX_NURSERY_SIZE);
3467 continue;
3469 #endif
3470 min_nursery_size = max_nursery_size = val;
3471 dynamic_nursery = FALSE;
3472 } else {
3473 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.", "`nursery-size` must be an integer.");
3474 continue;
3476 continue;
3478 if (g_str_has_prefix (opt, "save-target-ratio=")) {
3479 double val;
3480 opt = strchr (opt, '=') + 1;
3481 if (parse_double_in_interval (MONO_GC_PARAMS_NAME, "save-target-ratio", opt,
3482 SGEN_MIN_SAVE_TARGET_RATIO, SGEN_MAX_SAVE_TARGET_RATIO, &val)) {
3483 save_target = val;
3485 continue;
3487 if (g_str_has_prefix (opt, "default-allowance-ratio=")) {
3488 double val;
3489 opt = strchr (opt, '=') + 1;
3490 if (parse_double_in_interval (MONO_GC_PARAMS_NAME, "default-allowance-ratio", opt,
3491 SGEN_MIN_ALLOWANCE_NURSERY_SIZE_RATIO, SGEN_MAX_ALLOWANCE_NURSERY_SIZE_RATIO, &val)) {
3492 allowance_ratio = val;
3494 continue;
3497 if (!strcmp (opt, "cementing")) {
3498 cement_enabled = TRUE;
3499 continue;
3501 if (!strcmp (opt, "no-cementing")) {
3502 cement_enabled = FALSE;
3503 continue;
3506 if (!strcmp (opt, "precleaning")) {
3507 precleaning_enabled = TRUE;
3508 continue;
3510 if (!strcmp (opt, "no-precleaning")) {
3511 precleaning_enabled = FALSE;
3512 continue;
3515 if (!strcmp (opt, "dynamic-nursery")) {
3516 if (sgen_minor_collector.is_split)
3517 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.",
3518 "dynamic-nursery not supported with split-nursery.");
3519 else
3520 dynamic_nursery = TRUE;
3521 continue;
3523 if (!strcmp (opt, "no-dynamic-nursery")) {
3524 dynamic_nursery = FALSE;
3525 continue;
3528 if (sgen_major_collector.handle_gc_param && sgen_major_collector.handle_gc_param (opt))
3529 continue;
3531 if (sgen_minor_collector.handle_gc_param && sgen_minor_collector.handle_gc_param (opt))
3532 continue;
3534 if (sgen_client_handle_gc_param (opt))
3535 continue;
3537 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Ignoring.", "Unknown option `%s`.", opt);
3539 if (usage_printed)
3540 continue;
3542 fprintf (stderr, "\n%s must be a comma-delimited list of one or more of the following:\n", MONO_GC_PARAMS_NAME);
3543 fprintf (stderr, " max-heap-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
3544 fprintf (stderr, " soft-heap-limit=n (where N is an integer, possibly with a k, m or a g suffix)\n");
3545 fprintf (stderr, " mode=MODE (where MODE is 'balanced', 'throughput' or 'pause[:N]' and N is maximum pause in milliseconds)\n");
3546 fprintf (stderr, " nursery-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
3547 fprintf (stderr, " major=COLLECTOR (where COLLECTOR is `marksweep', `marksweep-conc', `marksweep-par')\n");
3548 fprintf (stderr, " minor=COLLECTOR (where COLLECTOR is `simple' or `split')\n");
3549 fprintf (stderr, " wbarrier=WBARRIER (where WBARRIER is `remset' or `cardtable')\n");
3550 fprintf (stderr, " [no-]cementing\n");
3551 fprintf (stderr, " [no-]dynamic-nursery\n");
3552 if (sgen_major_collector.print_gc_param_usage)
3553 sgen_major_collector.print_gc_param_usage ();
3554 if (sgen_minor_collector.print_gc_param_usage)
3555 sgen_minor_collector.print_gc_param_usage ();
3556 sgen_client_print_gc_params_usage ();
3557 fprintf (stderr, " Experimental options:\n");
3558 fprintf (stderr, " save-target-ratio=R (where R must be between %.2f - %.2f).\n", SGEN_MIN_SAVE_TARGET_RATIO, SGEN_MAX_SAVE_TARGET_RATIO);
3559 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);
3560 fprintf (stderr, "\n");
3562 usage_printed = TRUE;
3564 g_strfreev (opts);
3567 if (params_opts)
3568 g_free (params_opts);
3570 alloc_nursery (dynamic_nursery, min_nursery_size, max_nursery_size);
3572 sgen_pinning_init ();
3573 sgen_cement_init (cement_enabled);
3575 if ((env = g_getenv (MONO_GC_DEBUG_NAME)) || gc_debug_options) {
3576 debug_opts = g_strdup_printf ("%s,%s", gc_debug_options ? gc_debug_options : "", env ? env : "");
3577 g_free (env);
3580 if (debug_opts) {
3581 gboolean usage_printed = FALSE;
3583 opts = g_strsplit (debug_opts, ",", -1);
3584 for (ptr = opts; ptr && *ptr; ptr ++) {
3585 char *opt = *ptr;
3586 if (!strcmp (opt, ""))
3587 continue;
3588 if (opt [0] >= '0' && opt [0] <= '9') {
3589 sgen_gc_debug_level = atoi (opt);
3590 opt++;
3591 if (opt [0] == ':')
3592 opt++;
3593 if (opt [0]) {
3594 char *rf = g_strdup_printf ("%s.%d", opt, mono_process_current_pid ());
3595 sgen_gc_debug_file = fopen (rf, "wb");
3596 if (!sgen_gc_debug_file)
3597 sgen_gc_debug_file = stderr;
3598 g_free (rf);
3600 } else if (!strcmp (opt, "print-allowance")) {
3601 debug_print_allowance = TRUE;
3602 } else if (!strcmp (opt, "print-pinning")) {
3603 sgen_pin_stats_enable ();
3604 } else if (!strcmp (opt, "verify-before-allocs")) {
3605 sgen_verify_before_allocs = 1;
3606 sgen_has_per_allocation_action = TRUE;
3607 } else if (g_str_has_prefix (opt, "max-valloc-size=")) {
3608 size_t max_valloc_size;
3609 char *arg = strchr (opt, '=') + 1;
3610 if (*opt && mono_gc_parse_environment_string_extract_number (arg, &max_valloc_size)) {
3611 mono_valloc_set_limit (max_valloc_size);
3612 } else {
3613 sgen_env_var_error (MONO_GC_DEBUG_NAME, NULL, "`max-valloc-size` must be an integer.");
3615 continue;
3616 } else if (g_str_has_prefix (opt, "verify-before-allocs=")) {
3617 char *arg = strchr (opt, '=') + 1;
3618 sgen_verify_before_allocs = atoi (arg);
3619 sgen_has_per_allocation_action = TRUE;
3620 } else if (!strcmp (opt, "collect-before-allocs")) {
3621 sgen_collect_before_allocs = 1;
3622 sgen_has_per_allocation_action = TRUE;
3623 } else if (g_str_has_prefix (opt, "collect-before-allocs=")) {
3624 char *arg = strchr (opt, '=') + 1;
3625 sgen_has_per_allocation_action = TRUE;
3626 sgen_collect_before_allocs = atoi (arg);
3627 } else if (!strcmp (opt, "verify-before-collections")) {
3628 whole_heap_check_before_collection = TRUE;
3629 } else if (!strcmp (opt, "check-remset-consistency")) {
3630 remset_consistency_checks = TRUE;
3631 sgen_nursery_clear_policy = CLEAR_AT_GC;
3632 } else if (!strcmp (opt, "mod-union-consistency-check")) {
3633 if (!sgen_major_collector.is_concurrent) {
3634 sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "`mod-union-consistency-check` only works with concurrent major collector.");
3635 continue;
3637 mod_union_consistency_check = TRUE;
3638 } else if (!strcmp (opt, "check-mark-bits")) {
3639 check_mark_bits_after_major_collection = TRUE;
3640 } else if (!strcmp (opt, "check-nursery-pinned")) {
3641 check_nursery_objects_pinned = TRUE;
3642 } else if (!strcmp (opt, "clear-at-gc")) {
3643 sgen_nursery_clear_policy = CLEAR_AT_GC;
3644 } else if (!strcmp (opt, "clear-nursery-at-gc")) {
3645 sgen_nursery_clear_policy = CLEAR_AT_GC;
3646 } else if (!strcmp (opt, "clear-at-tlab-creation")) {
3647 sgen_nursery_clear_policy = CLEAR_AT_TLAB_CREATION;
3648 } else if (!strcmp (opt, "debug-clear-at-tlab-creation")) {
3649 sgen_nursery_clear_policy = CLEAR_AT_TLAB_CREATION_DEBUG;
3650 } else if (!strcmp (opt, "check-scan-starts")) {
3651 do_scan_starts_check = TRUE;
3652 } else if (!strcmp (opt, "verify-nursery-at-minor-gc")) {
3653 do_verify_nursery = TRUE;
3654 } else if (!strcmp (opt, "check-concurrent")) {
3655 if (!sgen_major_collector.is_concurrent) {
3656 sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "`check-concurrent` only works with concurrent major collectors.");
3657 continue;
3659 sgen_nursery_clear_policy = CLEAR_AT_GC;
3660 do_concurrent_checks = TRUE;
3661 } else if (!strcmp (opt, "dump-nursery-at-minor-gc")) {
3662 do_dump_nursery_content = TRUE;
3663 } else if (!strcmp (opt, "disable-minor")) {
3664 disable_minor_collections = TRUE;
3665 } else if (!strcmp (opt, "disable-major")) {
3666 disable_major_collections = TRUE;
3667 } else if (g_str_has_prefix (opt, "heap-dump=")) {
3668 char *filename = strchr (opt, '=') + 1;
3669 sgen_nursery_clear_policy = CLEAR_AT_GC;
3670 sgen_debug_enable_heap_dump (filename);
3671 } else if (g_str_has_prefix (opt, "binary-protocol=")) {
3672 char *filename = strchr (opt, '=') + 1;
3673 char *colon = strrchr (filename, ':');
3674 size_t limit = 0;
3675 if (colon) {
3676 if (!mono_gc_parse_environment_string_extract_number (colon + 1, &limit)) {
3677 sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring limit.", "Binary protocol file size limit must be an integer.");
3678 limit = -1;
3680 *colon = '\0';
3682 sgen_binary_protocol_init (filename, (long long)limit);
3683 } else if (!strcmp (opt, "nursery-canaries")) {
3684 do_verify_nursery = TRUE;
3685 enable_nursery_canaries = TRUE;
3686 } else if (!sgen_client_handle_gc_debug (opt)) {
3687 sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "Unknown option `%s`.", opt);
3689 if (usage_printed)
3690 continue;
3692 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);
3693 fprintf (stderr, "Valid <option>s are:\n");
3694 fprintf (stderr, " collect-before-allocs[=<n>]\n");
3695 fprintf (stderr, " verify-before-allocs[=<n>]\n");
3696 fprintf (stderr, " max-valloc-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
3697 fprintf (stderr, " check-remset-consistency\n");
3698 fprintf (stderr, " check-mark-bits\n");
3699 fprintf (stderr, " check-nursery-pinned\n");
3700 fprintf (stderr, " verify-before-collections\n");
3701 fprintf (stderr, " verify-nursery-at-minor-gc\n");
3702 fprintf (stderr, " dump-nursery-at-minor-gc\n");
3703 fprintf (stderr, " disable-minor\n");
3704 fprintf (stderr, " disable-major\n");
3705 fprintf (stderr, " check-concurrent\n");
3706 fprintf (stderr, " clear-[nursery-]at-gc\n");
3707 fprintf (stderr, " clear-at-tlab-creation\n");
3708 fprintf (stderr, " debug-clear-at-tlab-creation\n");
3709 fprintf (stderr, " check-scan-starts\n");
3710 fprintf (stderr, " print-allowance\n");
3711 fprintf (stderr, " print-pinning\n");
3712 fprintf (stderr, " heap-dump=<filename>\n");
3713 fprintf (stderr, " binary-protocol=<filename>[:<file-size-limit>]\n");
3714 fprintf (stderr, " nursery-canaries\n");
3715 sgen_client_print_gc_debug_usage ();
3716 fprintf (stderr, "\n");
3718 usage_printed = TRUE;
3721 g_strfreev (opts);
3724 if (debug_opts)
3725 g_free (debug_opts);
3727 if (check_mark_bits_after_major_collection)
3728 sgen_nursery_clear_policy = CLEAR_AT_GC;
3730 if (sgen_major_collector.post_param_init)
3731 sgen_major_collector.post_param_init (&sgen_major_collector);
3733 sgen_thread_pool_start ();
3735 sgen_memgov_init (max_heap, soft_limit, debug_print_allowance, allowance_ratio, save_target);
3737 memset (&remset, 0, sizeof (remset));
3739 sgen_card_table_init (&remset);
3741 sgen_register_root (NULL, 0, sgen_make_user_root_descriptor (sgen_mark_normal_gc_handles), ROOT_TYPE_NORMAL, MONO_ROOT_SOURCE_GC_HANDLE, NULL, "GC Handles (SGen, Normal)");
3743 gc_initialized = 1;
3745 sgen_init_bridge ();
3748 gboolean
3749 sgen_gc_initialized ()
3751 return gc_initialized > 0;
3754 NurseryClearPolicy
3755 sgen_get_nursery_clear_policy (void)
3757 return sgen_nursery_clear_policy;
3760 void
3761 sgen_gc_lock (void)
3763 mono_coop_mutex_lock (&sgen_gc_mutex);
3766 void
3767 sgen_gc_unlock (void)
3769 mono_coop_mutex_unlock (&sgen_gc_mutex);
3772 void
3773 sgen_major_collector_iterate_live_block_ranges (sgen_cardtable_block_callback callback)
3775 sgen_major_collector.iterate_live_block_ranges (callback);
3778 void
3779 sgen_major_collector_iterate_block_ranges (sgen_cardtable_block_callback callback)
3781 sgen_major_collector.iterate_block_ranges (callback);
3784 SgenMajorCollector*
3785 sgen_get_major_collector (void)
3787 return &sgen_major_collector;
3790 SgenMinorCollector*
3791 sgen_get_minor_collector (void)
3793 return &sgen_minor_collector;
3796 SgenRememberedSet*
3797 sgen_get_remset (void)
3799 return &remset;
3802 static void
3803 count_cards (long long *major_total, long long *major_marked, long long *los_total, long long *los_marked)
3805 sgen_get_major_collector ()->count_cards (major_total, major_marked);
3806 sgen_los_count_cards (los_total, los_marked);
3809 static gboolean world_is_stopped = FALSE;
3811 /* LOCKING: assumes the GC lock is held */
3812 void
3813 sgen_stop_world (int generation, gboolean serial_collection)
3815 long long major_total = -1, major_marked = -1, los_total = -1, los_marked = -1;
3817 SGEN_ASSERT (0, !world_is_stopped, "Why are we stopping a stopped world?");
3819 sgen_binary_protocol_world_stopping (generation, sgen_timestamp (), (gpointer) (gsize) mono_native_thread_id_get ());
3821 sgen_client_stop_world (generation, serial_collection);
3823 world_is_stopped = TRUE;
3825 if (sgen_binary_protocol_is_heavy_enabled ())
3826 count_cards (&major_total, &major_marked, &los_total, &los_marked);
3827 sgen_binary_protocol_world_stopped (generation, sgen_timestamp (), major_total, major_marked, los_total, los_marked);
3830 /* LOCKING: assumes the GC lock is held */
3831 void
3832 sgen_restart_world (int generation, gboolean serial_collection)
3834 long long major_total = -1, major_marked = -1, los_total = -1, los_marked = -1;
3835 gint64 stw_time;
3837 SGEN_ASSERT (0, world_is_stopped, "Why are we restarting a running world?");
3839 if (sgen_binary_protocol_is_heavy_enabled ())
3840 count_cards (&major_total, &major_marked, &los_total, &los_marked);
3841 sgen_binary_protocol_world_restarting (generation, sgen_timestamp (), major_total, major_marked, los_total, los_marked);
3843 world_is_stopped = FALSE;
3845 sgen_client_restart_world (generation, serial_collection, &stw_time);
3847 sgen_binary_protocol_world_restarted (generation, sgen_timestamp ());
3849 if (sgen_client_bridge_need_processing ())
3850 sgen_client_bridge_processing_finish (generation);
3852 sgen_memgov_collection_end (generation, stw_time);
3855 gboolean
3856 sgen_is_world_stopped (void)
3858 return world_is_stopped;
3861 void
3862 sgen_check_whole_heap_stw (void)
3864 sgen_stop_world (0, FALSE);
3865 sgen_clear_nursery_fragments ();
3866 sgen_check_whole_heap (TRUE);
3867 sgen_restart_world (0, FALSE);
3870 gint64
3871 sgen_timestamp (void)
3873 SGEN_TV_DECLARE (timestamp);
3874 SGEN_TV_GETTIME (timestamp);
3875 return SGEN_TV_ELAPSED (sgen_init_timestamp, timestamp);
3878 #endif /* HAVE_SGEN_GC */