mono/metadata/sgen-gc.c

   1 /*
   2  * sgen-gc.c: Simple generational GC.
   3  *
   4  * Author:
   5  *      Paolo Molaro (lupus@ximian.com)
   6  *  Rodrigo Kumpera (kumpera@gmail.com)
   7  *
   8  * Copyright 2005-2011 Novell, Inc (http://www.novell.com)
   9  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
  10  *
  11  * Thread start/stop adapted from Boehm's GC:
  12  * Copyright (c) 1994 by Xerox Corporation.  All rights reserved.
  13  * Copyright (c) 1996 by Silicon Graphics.  All rights reserved.
  14  * Copyright (c) 1998 by Fergus Henderson.  All rights reserved.
  15  * Copyright (c) 2000-2004 by Hewlett-Packard Company.  All rights reserved.
  16  * Copyright 2001-2003 Ximian, Inc
  17  * Copyright 2003-2010 Novell, Inc.
  18  * Copyright 2011 Xamarin, Inc.
  19  * Copyright (C) 2012 Xamarin Inc
  20  *
  21  * This library is free software; you can redistribute it and/or
  22  * modify it under the terms of the GNU Library General Public
  23  * License 2.0 as published by the Free Software Foundation;
  24  *
  25  * This library is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  28  * Library General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU Library General Public
  31  * License 2.0 along with this library; if not, write to the Free
  32  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  33  *
  34  * Important: allocation provides always zeroed memory, having to do
  35  * a memset after allocation is deadly for performance.
  36  * Memory usage at startup is currently as follows:
  37  * 64 KB pinned space
  38  * 64 KB internal space
  39  * size of nursery
  40  * We should provide a small memory config with half the sizes
  41  *
  42  * We currently try to make as few mono assumptions as possible:
  43  * 1) 2-word header with no GC pointers in it (first vtable, second to store the
  44  *    forwarding ptr)
  45  * 2) gc descriptor is the second word in the vtable (first word in the class)
  46  * 3) 8 byte alignment is the minimum and enough (not true for special structures (SIMD), FIXME)
  47  * 4) there is a function to get an object's size and the number of
  48  *    elements in an array.
  49  * 5) we know the special way bounds are allocated for complex arrays
  50  * 6) we know about proxies and how to treat them when domains are unloaded
  51  *
  52  * Always try to keep stack usage to a minimum: no recursive behaviour
  53  * and no large stack allocs.
  54  *
  55  * General description.
  56  * Objects are initially allocated in a nursery using a fast bump-pointer technique.
  57  * When the nursery is full we start a nursery collection: this is performed with a
  58  * copying GC.
  59  * When the old generation is full we start a copying GC of the old generation as well:
  60  * this will be changed to mark&sweep with copying when fragmentation becomes to severe
  61  * in the future.  Maybe we'll even do both during the same collection like IMMIX.
  62  *
  63  * The things that complicate this description are:
  64  * *) pinned objects: we can't move them so we need to keep track of them
  65  * *) no precise info of the thread stacks and registers: we need to be able to
  66  *    quickly find the objects that may be referenced conservatively and pin them
  67  *    (this makes the first issues more important)
  68  * *) large objects are too expensive to be dealt with using copying GC: we handle them
  69  *    with mark/sweep during major collections
  70  * *) some objects need to not move even if they are small (interned strings, Type handles):
  71  *    we use mark/sweep for them, too: they are not allocated in the nursery, but inside
  72  *    PinnedChunks regions
  73  */
  74
  75 /*
  76  * TODO:
  77
  78  *) we could have a function pointer in MonoClass to implement
  79   customized write barriers for value types
  80
  81  *) investigate the stuff needed to advance a thread to a GC-safe
  82   point (single-stepping, read from unmapped memory etc) and implement it.
  83   This would enable us to inline allocations and write barriers, for example,
  84   or at least parts of them, like the write barrier checks.
  85   We may need this also for handling precise info on stacks, even simple things
  86   as having uninitialized data on the stack and having to wait for the prolog
  87   to zero it. Not an issue for the last frame that we scan conservatively.
  88   We could always not trust the value in the slots anyway.
  89
  90  *) modify the jit to save info about references in stack locations:
  91   this can be done just for locals as a start, so that at least
  92   part of the stack is handled precisely.
  93
  94  *) test/fix endianess issues
  95
  96  *) Implement a card table as the write barrier instead of remembered
  97     sets?  Card tables are not easy to implement with our current
  98     memory layout.  We have several different kinds of major heap
  99     objects: Small objects in regular blocks, small objects in pinned
 100     chunks and LOS objects.  If we just have a pointer we have no way
 101     to tell which kind of object it points into, therefore we cannot
 102     know where its card table is.  The least we have to do to make
 103     this happen is to get rid of write barriers for indirect stores.
 104     (See next item)
 105
 106  *) Get rid of write barriers for indirect stores.  We can do this by
 107     telling the GC to wbarrier-register an object once we do an ldloca
 108     or ldelema on it, and to unregister it once it's not used anymore
 109     (it can only travel downwards on the stack).  The problem with
 110     unregistering is that it needs to happen eventually no matter
 111     what, even if exceptions are thrown, the thread aborts, etc.
 112     Rodrigo suggested that we could do only the registering part and
 113     let the collector find out (pessimistically) when it's safe to
 114     unregister, namely when the stack pointer of the thread that
 115     registered the object is higher than it was when the registering
 116     happened.  This might make for a good first implementation to get
 117     some data on performance.
 118
 119  *) Some sort of blacklist support?  Blacklists is a concept from the
 120     Boehm GC: if during a conservative scan we find pointers to an
 121     area which we might use as heap, we mark that area as unusable, so
 122     pointer retention by random pinning pointers is reduced.
 123
 124  *) experiment with max small object size (very small right now - 2kb,
 125     because it's tied to the max freelist size)
 126
 127   *) add an option to mmap the whole heap in one chunk: it makes for many
 128      simplifications in the checks (put the nursery at the top and just use a single
 129      check for inclusion/exclusion): the issue this has is that on 32 bit systems it's
 130      not flexible (too much of the address space may be used by default or we can't
 131      increase the heap as needed) and we'd need a race-free mechanism to return memory
 132      back to the system (mprotect(PROT_NONE) will still keep the memory allocated if it
 133      was written to, munmap is needed, but the following mmap may not find the same segment
 134      free...)
 135
 136  *) memzero the major fragments after restarting the world and optionally a smaller
 137     chunk at a time
 138
 139  *) investigate having fragment zeroing threads
 140
 141  *) separate locks for finalization and other minor stuff to reduce
 142     lock contention
 143
 144  *) try a different copying order to improve memory locality
 145
 146  *) a thread abort after a store but before the write barrier will
 147     prevent the write barrier from executing
 148
 149  *) specialized dynamically generated markers/copiers
 150
 151  *) Dynamically adjust TLAB size to the number of threads.  If we have
 152     too many threads that do allocation, we might need smaller TLABs,
 153     and we might get better performance with larger TLABs if we only
 154     have a handful of threads.  We could sum up the space left in all
 155     assigned TLABs and if that's more than some percentage of the
 156     nursery size, reduce the TLAB size.
 157
 158  *) Explore placing unreachable objects on unused nursery memory.
 159         Instead of memset'ng a region to zero, place an int[] covering it.
 160         A good place to start is add_nursery_frag. The tricky thing here is
 161         placing those objects atomically outside of a collection.
 162
 163  *) Allocation should use asymmetric Dekker synchronization:
 164         http://blogs.oracle.com/dave/resource/Asymmetric-Dekker-Synchronization.txt
 165         This should help weak consistency archs.
 166  */
 167 #include "config.h"
 168 #ifdef HAVE_SGEN_GC
 169
 170 #ifdef __MACH__
 171 #undef _XOPEN_SOURCE
 172 #define _XOPEN_SOURCE
 173 #define _DARWIN_C_SOURCE
 174 #endif
 175
 176 #ifdef HAVE_UNISTD_H
 177 #include <unistd.h>
 178 #endif
 179 #ifdef HAVE_PTHREAD_H
 180 #include <pthread.h>
 181 #endif
 182 #ifdef HAVE_PTHREAD_NP_H
 183 #include <pthread_np.h>
 184 #endif
 185 #ifdef HAVE_SEMAPHORE_H
 186 #include <semaphore.h>
 187 #endif
 188 #include <stdio.h>
 189 #include <string.h>
 190 #include <errno.h>
 191 #include <assert.h>
 192
 193 #include "metadata/sgen-gc.h"
 194 #include "metadata/metadata-internals.h"
 195 #include "metadata/class-internals.h"
 196 #include "metadata/gc-internal.h"
 197 #include "metadata/object-internals.h"
 198 #include "metadata/threads.h"
 199 #include "metadata/sgen-cardtable.h"
 200 #include "metadata/sgen-protocol.h"
 201 #include "metadata/sgen-archdep.h"
 202 #include "metadata/sgen-bridge.h"
 203 #include "metadata/sgen-memory-governor.h"
 204 #include "metadata/sgen-hash-table.h"
 205 #include "metadata/mono-gc.h"
 206 #include "metadata/method-builder.h"
 207 #include "metadata/profiler-private.h"
 208 #include "metadata/monitor.h"
 209 #include "metadata/mempool-internals.h"
 210 #include "metadata/marshal.h"
 211 #include "metadata/runtime.h"
 212 #include "metadata/sgen-cardtable.h"
 213 #include "metadata/sgen-pinning.h"
 214 #include "metadata/sgen-workers.h"
 215 #include "metadata/sgen-layout-stats.h"
 216 #include "utils/mono-mmap.h"
 217 #include "utils/mono-time.h"
 218 #include "utils/mono-semaphore.h"
 219 #include "utils/mono-counters.h"
 220 #include "utils/mono-proclib.h"
 221 #include "utils/mono-memory-model.h"
 222 #include "utils/mono-logger-internal.h"
 223 #include "utils/dtrace.h"
 224
 225 #include <mono/utils/mono-logger-internal.h>
 226 #include <mono/utils/memcheck.h>
 227
 228 #if defined(__MACH__)
 229 #include "utils/mach-support.h"
 230 #endif
 231
 232 #define OPDEF(a,b,c,d,e,f,g,h,i,j) \
 233         a = i,
 234
 235 enum {
 236 #include "mono/cil/opcode.def"
 237         CEE_LAST
 238 };
 239
 240 #undef OPDEF
 241
 242 #undef pthread_create
 243 #undef pthread_join
 244 #undef pthread_detach
 245
 246 /*
 247  * ######################################################################
 248  * ########  Types and constants used by the GC.
 249  * ######################################################################
 250  */
 251
 252 /* 0 means not initialized, 1 is initialized, -1 means in progress */
 253 static int gc_initialized = 0;
 254 /* If set, check if we need to do something every X allocations */
 255 gboolean has_per_allocation_action;
 256 /* If set, do a heap check every X allocation */
 257 guint32 verify_before_allocs = 0;
 258 /* If set, do a minor collection before every X allocation */
 259 guint32 collect_before_allocs = 0;
 260 /* If set, do a whole heap check before each collection */
 261 static gboolean whole_heap_check_before_collection = FALSE;
 262 /* If set, do a heap consistency check before each minor collection */
 263 static gboolean consistency_check_at_minor_collection = FALSE;
 264 /* If set, do a mod union consistency check before each finishing collection pause */
 265 static gboolean mod_union_consistency_check = FALSE;
 266 /* If set, check whether mark bits are consistent after major collections */
 267 static gboolean check_mark_bits_after_major_collection = FALSE;
 268 /* If set, check that all nursery objects are pinned/not pinned, depending on context */
 269 static gboolean check_nursery_objects_pinned = FALSE;
 270 /* If set, do a few checks when the concurrent collector is used */
 271 static gboolean do_concurrent_checks = FALSE;
 272 /* If set, check that there are no references to the domain left at domain unload */
 273 static gboolean xdomain_checks = FALSE;
 274 /* If not null, dump the heap after each collection into this file */
 275 static FILE *heap_dump_file = NULL;
 276 /* If set, mark stacks conservatively, even if precise marking is possible */
 277 static gboolean conservative_stack_mark = FALSE;
 278 /* If set, do a plausibility check on the scan_starts before and after
 279    each collection */
 280 static gboolean do_scan_starts_check = FALSE;
 281
 282 /*
 283  * If the major collector is concurrent and this is FALSE, we will
 284  * never initiate a synchronous major collection, unless requested via
 285  * GC.Collect().
 286  */
 287 static gboolean allow_synchronous_major = TRUE;
 288 static gboolean disable_minor_collections = FALSE;
 289 static gboolean disable_major_collections = FALSE;
 290 gboolean do_pin_stats = FALSE;
 291 static gboolean do_verify_nursery = FALSE;
 292 static gboolean do_dump_nursery_content = FALSE;
 293 static gboolean enable_nursery_canaries = FALSE;
 294
 295 #ifdef HEAVY_STATISTICS
 296 guint64 stat_objects_alloced_degraded = 0;
 297 guint64 stat_bytes_alloced_degraded = 0;
 298
 299 guint64 stat_copy_object_called_nursery = 0;
 300 guint64 stat_objects_copied_nursery = 0;
 301 guint64 stat_copy_object_called_major = 0;
 302 guint64 stat_objects_copied_major = 0;
 303
 304 guint64 stat_scan_object_called_nursery = 0;
 305 guint64 stat_scan_object_called_major = 0;
 306
 307 guint64 stat_slots_allocated_in_vain;
 308
 309 guint64 stat_nursery_copy_object_failed_from_space = 0;
 310 guint64 stat_nursery_copy_object_failed_forwarded = 0;
 311 guint64 stat_nursery_copy_object_failed_pinned = 0;
 312 guint64 stat_nursery_copy_object_failed_to_space = 0;
 313
 314 static int stat_wbarrier_add_to_global_remset = 0;
 315 static int stat_wbarrier_set_field = 0;
 316 static int stat_wbarrier_set_arrayref = 0;
 317 static int stat_wbarrier_arrayref_copy = 0;
 318 static int stat_wbarrier_generic_store = 0;
 319 static int stat_wbarrier_generic_store_atomic = 0;
 320 static int stat_wbarrier_set_root = 0;
 321 static int stat_wbarrier_value_copy = 0;
 322 static int stat_wbarrier_object_copy = 0;
 323 #endif
 324
 325 static guint64 stat_pinned_objects = 0;
 326
 327 static guint64 time_minor_pre_collection_fragment_clear = 0;
 328 static guint64 time_minor_pinning = 0;
 329 static guint64 time_minor_scan_remsets = 0;
 330 static guint64 time_minor_scan_pinned = 0;
 331 static guint64 time_minor_scan_registered_roots = 0;
 332 static guint64 time_minor_scan_thread_data = 0;
 333 static guint64 time_minor_finish_gray_stack = 0;
 334 static guint64 time_minor_fragment_creation = 0;
 335
 336 static guint64 time_major_pre_collection_fragment_clear = 0;
 337 static guint64 time_major_pinning = 0;
 338 static guint64 time_major_scan_pinned = 0;
 339 static guint64 time_major_scan_registered_roots = 0;
 340 static guint64 time_major_scan_thread_data = 0;
 341 static guint64 time_major_scan_alloc_pinned = 0;
 342 static guint64 time_major_scan_finalized = 0;
 343 static guint64 time_major_scan_big_objects = 0;
 344 static guint64 time_major_finish_gray_stack = 0;
 345 static guint64 time_major_free_bigobjs = 0;
 346 static guint64 time_major_los_sweep = 0;
 347 static guint64 time_major_sweep = 0;
 348 static guint64 time_major_fragment_creation = 0;
 349
 350 static guint64 time_max = 0;
 351
 352 static SGEN_TV_DECLARE (time_major_conc_collection_start);
 353 static SGEN_TV_DECLARE (time_major_conc_collection_end);
 354
 355 static SGEN_TV_DECLARE (last_minor_collection_start_tv);
 356 static SGEN_TV_DECLARE (last_minor_collection_end_tv);
 357
 358 int gc_debug_level = 0;
 359 FILE* gc_debug_file;
 360
 361 static MonoGCFinalizerCallbacks fin_callbacks;
 362
 363 /*
 364 void
 365 mono_gc_flush_info (void)
 366 {
 367         fflush (gc_debug_file);
 368 }
 369 */
 370
 371 #define TV_DECLARE SGEN_TV_DECLARE
 372 #define TV_GETTIME SGEN_TV_GETTIME
 373 #define TV_ELAPSED SGEN_TV_ELAPSED
 374
 375 SGEN_TV_DECLARE (sgen_init_timestamp);
 376
 377 #define ALIGN_TO(val,align) ((((guint64)val) + ((align) - 1)) & ~((align) - 1))
 378
 379 NurseryClearPolicy nursery_clear_policy = CLEAR_AT_TLAB_CREATION;
 380
 381 #define object_is_forwarded     SGEN_OBJECT_IS_FORWARDED
 382 #define object_is_pinned        SGEN_OBJECT_IS_PINNED
 383 #define pin_object              SGEN_PIN_OBJECT
 384
 385 #define ptr_in_nursery sgen_ptr_in_nursery
 386
 387 #define LOAD_VTABLE     SGEN_LOAD_VTABLE
 388
 389 static const char*
 390 safe_name (void* obj)
 391 {
 392         MonoVTable *vt = (MonoVTable*)LOAD_VTABLE (obj);
 393         return vt->klass->name;
 394 }
 395
 396 gboolean
 397 nursery_canaries_enabled (void)
 398 {
 399         return enable_nursery_canaries;
 400 }
 401
 402 #define safe_object_get_size    sgen_safe_object_get_size
 403
 404 const char*
 405 sgen_safe_name (void* obj)
 406 {
 407         return safe_name (obj);
 408 }
 409
 410 /*
 411  * ######################################################################
 412  * ########  Global data.
 413  * ######################################################################
 414  */
 415 LOCK_DECLARE (gc_mutex);
 416 gboolean sgen_try_free_some_memory;
 417
 418 #define SCAN_START_SIZE SGEN_SCAN_START_SIZE
 419
 420 static mword pagesize = 4096;
 421 size_t degraded_mode = 0;
 422
 423 static mword bytes_pinned_from_failed_allocation = 0;
 424
 425 GCMemSection *nursery_section = NULL;
 426 static volatile mword lowest_heap_address = ~(mword)0;
 427 static volatile mword highest_heap_address = 0;
 428
 429 LOCK_DECLARE (sgen_interruption_mutex);
 430
 431 typedef struct _FinalizeReadyEntry FinalizeReadyEntry;
 432 struct _FinalizeReadyEntry {
 433         FinalizeReadyEntry *next;
 434         void *object;
 435 };
 436
 437 typedef struct _EphemeronLinkNode EphemeronLinkNode;
 438
 439 struct _EphemeronLinkNode {
 440         EphemeronLinkNode *next;
 441         char *array;
 442 };
 443
 444 typedef struct {
 445        void *key;
 446        void *value;
 447 } Ephemeron;
 448
 449 int current_collection_generation = -1;
 450 volatile gboolean concurrent_collection_in_progress = FALSE;
 451
 452 /* objects that are ready to be finalized */
 453 static FinalizeReadyEntry *fin_ready_list = NULL;
 454 static FinalizeReadyEntry *critical_fin_list = NULL;
 455
 456 static EphemeronLinkNode *ephemeron_list;
 457
 458 /* registered roots: the key to the hash is the root start address */
 459 /*
 460  * Different kinds of roots are kept separate to speed up pin_from_roots () for example.
 461  */
 462 SgenHashTable roots_hash [ROOT_TYPE_NUM] = {
 463         SGEN_HASH_TABLE_INIT (INTERNAL_MEM_ROOTS_TABLE, INTERNAL_MEM_ROOT_RECORD, sizeof (RootRecord), mono_aligned_addr_hash, NULL),
 464         SGEN_HASH_TABLE_INIT (INTERNAL_MEM_ROOTS_TABLE, INTERNAL_MEM_ROOT_RECORD, sizeof (RootRecord), mono_aligned_addr_hash, NULL),
 465         SGEN_HASH_TABLE_INIT (INTERNAL_MEM_ROOTS_TABLE, INTERNAL_MEM_ROOT_RECORD, sizeof (RootRecord), mono_aligned_addr_hash, NULL)
 466 };
 467 static mword roots_size = 0; /* amount of memory in the root set */
 468
 469 #define GC_ROOT_NUM 32
 470 typedef struct {
 471         int count;              /* must be the first field */
 472         void *objects [GC_ROOT_NUM];
 473         int root_types [GC_ROOT_NUM];
 474         uintptr_t extra_info [GC_ROOT_NUM];
 475 } GCRootReport;
 476
 477 static void
 478 notify_gc_roots (GCRootReport *report)
 479 {
 480         if (!report->count)
 481                 return;
 482         mono_profiler_gc_roots (report->count, report->objects, report->root_types, report->extra_info);
 483         report->count = 0;
 484 }
 485
 486 static void
 487 add_profile_gc_root (GCRootReport *report, void *object, int rtype, uintptr_t extra_info)
 488 {
 489         if (report->count == GC_ROOT_NUM)
 490                 notify_gc_roots (report);
 491         report->objects [report->count] = object;
 492         report->root_types [report->count] = rtype;
 493         report->extra_info [report->count++] = (uintptr_t)((MonoVTable*)LOAD_VTABLE (object))->klass;
 494 }
 495
 496 MonoNativeTlsKey thread_info_key;
 497
 498 #ifdef HAVE_KW_THREAD
 499 __thread SgenThreadInfo *sgen_thread_info;
 500 __thread char *stack_end;
 501 #endif
 502
 503 /* The size of a TLAB */
 504 /* The bigger the value, the less often we have to go to the slow path to allocate a new
 505  * one, but the more space is wasted by threads not allocating much memory.
 506  * FIXME: Tune this.
 507  * FIXME: Make this self-tuning for each thread.
 508  */
 509 guint32 tlab_size = (1024 * 4);
 510
 511 #define MAX_SMALL_OBJ_SIZE      SGEN_MAX_SMALL_OBJ_SIZE
 512
 513 /* Functions supplied by the runtime to be called by the GC */
 514 static MonoGCCallbacks gc_callbacks;
 515
 516 #define ALLOC_ALIGN             SGEN_ALLOC_ALIGN
 517
 518 #define ALIGN_UP                SGEN_ALIGN_UP
 519
 520 #define MOVED_OBJECTS_NUM 64
 521 static void *moved_objects [MOVED_OBJECTS_NUM];
 522 static int moved_objects_idx = 0;
 523
 524 /* Vtable of the objects used to fill out nursery fragments before a collection */
 525 static MonoVTable *array_fill_vtable;
 526
 527 #ifdef SGEN_DEBUG_INTERNAL_ALLOC
 528 MonoNativeThreadId main_gc_thread = NULL;
 529 #endif
 530
 531 /*Object was pinned during the current collection*/
 532 static mword objects_pinned;
 533
 534 /*
 535  * ######################################################################
 536  * ########  Macros and function declarations.
 537  * ######################################################################
 538  */
 539
 540 typedef SgenGrayQueue GrayQueue;
 541
 542 /* forward declarations */
 543 static void scan_thread_data (void *start_nursery, void *end_nursery, gboolean precise, GrayQueue *queue);
 544 static void scan_from_registered_roots (char *addr_start, char *addr_end, int root_type, ScanCopyContext ctx);
 545 static void scan_finalizer_entries (FinalizeReadyEntry *list, ScanCopyContext ctx);
 546 static void report_finalizer_roots (void);
 547 static void report_registered_roots (void);
 548
 549 static void pin_from_roots (void *start_nursery, void *end_nursery, GrayQueue *queue);
 550 static void finish_gray_stack (int generation, GrayQueue *queue);
 551
 552 void mono_gc_scan_for_specific_ref (MonoObject *key, gboolean precise);
 553
 554
 555 static void init_stats (void);
 556
 557 static int mark_ephemerons_in_range (ScanCopyContext ctx);
 558 static void clear_unreachable_ephemerons (ScanCopyContext ctx);
 559 static void null_ephemerons_for_domain (MonoDomain *domain);
 560
 561 SgenObjectOperations current_object_ops;
 562 SgenMajorCollector major_collector;
 563 SgenMinorCollector sgen_minor_collector;
 564 static GrayQueue gray_queue;
 565
 566 static SgenRememberedSet remset;
 567
 568 /* The gray queue to use from the main collection thread. */
 569 #define WORKERS_DISTRIBUTE_GRAY_QUEUE   (&gray_queue)
 570
 571 /*
 572  * The gray queue a worker job must use.  If we're not parallel or
 573  * concurrent, we use the main gray queue.
 574  */
 575 static SgenGrayQueue*
 576 sgen_workers_get_job_gray_queue (WorkerData *worker_data)
 577 {
 578         return worker_data ? &worker_data->private_gray_queue : WORKERS_DISTRIBUTE_GRAY_QUEUE;
 579 }
 580
 581 static void
 582 gray_queue_redirect (SgenGrayQueue *queue)
 583 {
 584         gboolean wake = FALSE;
 585
 586         for (;;) {
 587                 GrayQueueSection *section = sgen_gray_object_dequeue_section (queue);
 588                 if (!section)
 589                         break;
 590                 sgen_section_gray_queue_enqueue (queue->alloc_prepare_data, section);
 591                 wake = TRUE;
 592         }
 593
 594         if (wake) {
 595                 g_assert (concurrent_collection_in_progress);
 596                 if (sgen_workers_have_started ()) {
 597                         sgen_workers_ensure_awake ();
 598                 } else {
 599                         if (concurrent_collection_in_progress)
 600                                 g_assert (current_collection_generation == -1);
 601                 }
 602         }
 603 }
 604
 605 static void
 606 gray_queue_enable_redirect (SgenGrayQueue *queue)
 607 {
 608         if (!concurrent_collection_in_progress)
 609                 return;
 610
 611         sgen_gray_queue_set_alloc_prepare (queue, gray_queue_redirect, sgen_workers_get_distribute_section_gray_queue ());
 612         gray_queue_redirect (queue);
 613 }
 614
 615 void
 616 sgen_scan_area_with_callback (char *start, char *end, IterateObjectCallbackFunc callback, void *data, gboolean allow_flags)
 617 {
 618         while (start < end) {
 619                 size_t size;
 620                 char *obj;
 621
 622                 if (!*(void**)start) {
 623                         start += sizeof (void*); /* should be ALLOC_ALIGN, really */
 624                         continue;
 625                 }
 626
 627                 if (allow_flags) {
 628                         if (!(obj = SGEN_OBJECT_IS_FORWARDED (start)))
 629                                 obj = start;
 630                 } else {
 631                         obj = start;
 632                 }
 633
 634                 if ((MonoVTable*)SGEN_LOAD_VTABLE (obj) != array_fill_vtable) {
 635                         CHECK_CANARY_FOR_OBJECT (obj);
 636                         size = ALIGN_UP (safe_object_get_size ((MonoObject*)obj));
 637                         callback (obj, size, data);
 638                         CANARIFY_SIZE (size);
 639                 } else {
 640                         size = ALIGN_UP (safe_object_get_size ((MonoObject*)obj));
 641                 }
 642
 643                 start += size;
 644         }
 645 }
 646
 647 static gboolean
 648 need_remove_object_for_domain (char *start, MonoDomain *domain)
 649 {
 650         if (mono_object_domain (start) == domain) {
 651                 SGEN_LOG (4, "Need to cleanup object %p", start);
 652                 binary_protocol_cleanup (start, (gpointer)LOAD_VTABLE (start), safe_object_get_size ((MonoObject*)start));
 653                 return TRUE;
 654         }
 655         return FALSE;
 656 }
 657
 658 static void
 659 process_object_for_domain_clearing (char *start, MonoDomain *domain)
 660 {
 661         GCVTable *vt = (GCVTable*)LOAD_VTABLE (start);
 662         if (vt->klass == mono_defaults.internal_thread_class)
 663                 g_assert (mono_object_domain (start) == mono_get_root_domain ());
 664         /* The object could be a proxy for an object in the domain
 665            we're deleting. */
 666 #ifndef DISABLE_REMOTING
 667         if (mono_defaults.real_proxy_class->supertypes && mono_class_has_parent_fast (vt->klass, mono_defaults.real_proxy_class)) {
 668                 MonoObject *server = ((MonoRealProxy*)start)->unwrapped_server;
 669
 670                 /* The server could already have been zeroed out, so
 671                    we need to check for that, too. */
 672                 if (server && (!LOAD_VTABLE (server) || mono_object_domain (server) == domain)) {
 673                         SGEN_LOG (4, "Cleaning up remote pointer in %p to object %p", start, server);
 674                         ((MonoRealProxy*)start)->unwrapped_server = NULL;
 675                 }
 676         }
 677 #endif
 678 }
 679
 680 static gboolean
 681 clear_domain_process_object (char *obj, MonoDomain *domain)
 682 {
 683         gboolean remove;
 684
 685         process_object_for_domain_clearing (obj, domain);
 686         remove = need_remove_object_for_domain (obj, domain);
 687
 688         if (remove && ((MonoObject*)obj)->synchronisation) {
 689                 void **dislink = mono_monitor_get_object_monitor_weak_link ((MonoObject*)obj);
 690                 if (dislink)
 691                         sgen_register_disappearing_link (NULL, dislink, FALSE, TRUE);
 692         }
 693
 694         return remove;
 695 }
 696
 697 static void
 698 clear_domain_process_minor_object_callback (char *obj, size_t size, MonoDomain *domain)
 699 {
 700         if (clear_domain_process_object (obj, domain)) {
 701                 CANARIFY_SIZE (size);
 702                 memset (obj, 0, size);
 703         }
 704 }
 705
 706 static void
 707 clear_domain_process_major_object_callback (char *obj, size_t size, MonoDomain *domain)
 708 {
 709         clear_domain_process_object (obj, domain);
 710 }
 711
 712 static void
 713 clear_domain_free_major_non_pinned_object_callback (char *obj, size_t size, MonoDomain *domain)
 714 {
 715         if (need_remove_object_for_domain (obj, domain))
 716                 major_collector.free_non_pinned_object (obj, size);
 717 }
 718
 719 static void
 720 clear_domain_free_major_pinned_object_callback (char *obj, size_t size, MonoDomain *domain)
 721 {
 722         if (need_remove_object_for_domain (obj, domain))
 723                 major_collector.free_pinned_object (obj, size);
 724 }
 725
 726 /*
 727  * When appdomains are unloaded we can easily remove objects that have finalizers,
 728  * but all the others could still be present in random places on the heap.
 729  * We need a sweep to get rid of them even though it's going to be costly
 730  * with big heaps.
 731  * The reason we need to remove them is because we access the vtable and class
 732  * structures to know the object size and the reference bitmap: once the domain is
 733  * unloaded the point to random memory.
 734  */
 735 void
 736 mono_gc_clear_domain (MonoDomain * domain)
 737 {
 738         LOSObject *bigobj, *prev;
 739         int i;
 740
 741         LOCK_GC;
 742
 743         binary_protocol_domain_unload_begin (domain);
 744
 745         sgen_stop_world (0);
 746
 747         if (concurrent_collection_in_progress)
 748                 sgen_perform_collection (0, GENERATION_OLD, "clear domain", TRUE);
 749         g_assert (!concurrent_collection_in_progress);
 750
 751         sgen_process_fin_stage_entries ();
 752         sgen_process_dislink_stage_entries ();
 753
 754         sgen_clear_nursery_fragments ();
 755
 756         if (xdomain_checks && domain != mono_get_root_domain ()) {
 757                 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_NORMAL);
 758                 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_WBARRIER);
 759                 sgen_check_for_xdomain_refs ();
 760         }
 761
 762         /*Ephemerons and dislinks must be processed before LOS since they might end up pointing
 763         to memory returned to the OS.*/
 764         null_ephemerons_for_domain (domain);
 765
 766         for (i = GENERATION_NURSERY; i < GENERATION_MAX; ++i)
 767                 sgen_null_links_for_domain (domain, i);
 768
 769         for (i = GENERATION_NURSERY; i < GENERATION_MAX; ++i)
 770                 sgen_remove_finalizers_for_domain (domain, i);
 771
 772         sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
 773                         (IterateObjectCallbackFunc)clear_domain_process_minor_object_callback, domain, FALSE);
 774
 775         /* We need two passes over major and large objects because
 776            freeing such objects might give their memory back to the OS
 777            (in the case of large objects) or obliterate its vtable
 778            (pinned objects with major-copying or pinned and non-pinned
 779            objects with major-mark&sweep), but we might need to
 780            dereference a pointer from an object to another object if
 781            the first object is a proxy. */
 782         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, (IterateObjectCallbackFunc)clear_domain_process_major_object_callback, domain);
 783         for (bigobj = los_object_list; bigobj; bigobj = bigobj->next)
 784                 clear_domain_process_object (bigobj->data, domain);
 785
 786         prev = NULL;
 787         for (bigobj = los_object_list; bigobj;) {
 788                 if (need_remove_object_for_domain (bigobj->data, domain)) {
 789                         LOSObject *to_free = bigobj;
 790                         if (prev)
 791                                 prev->next = bigobj->next;
 792                         else
 793                                 los_object_list = bigobj->next;
 794                         bigobj = bigobj->next;
 795                         SGEN_LOG (4, "Freeing large object %p", bigobj->data);
 796                         sgen_los_free_object (to_free);
 797                         continue;
 798                 }
 799                 prev = bigobj;
 800                 bigobj = bigobj->next;
 801         }
 802         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_NON_PINNED, (IterateObjectCallbackFunc)clear_domain_free_major_non_pinned_object_callback, domain);
 803         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_PINNED, (IterateObjectCallbackFunc)clear_domain_free_major_pinned_object_callback, domain);
 804
 805         if (domain == mono_get_root_domain ()) {
 806                 if (G_UNLIKELY (do_pin_stats))
 807                         sgen_pin_stats_print_class_stats ();
 808                 sgen_object_layout_dump (stdout);
 809         }
 810
 811         sgen_restart_world (0, NULL);
 812
 813         binary_protocol_domain_unload_end (domain);
 814         binary_protocol_flush_buffers (FALSE);
 815
 816         UNLOCK_GC;
 817 }
 818
 819 /*
 820  * sgen_add_to_global_remset:
 821  *
 822  *   The global remset contains locations which point into newspace after
 823  * a minor collection. This can happen if the objects they point to are pinned.
 824  *
 825  * LOCKING: If called from a parallel collector, the global remset
 826  * lock must be held.  For serial collectors that is not necessary.
 827  */
 828 void
 829 sgen_add_to_global_remset (gpointer ptr, gpointer obj)
 830 {
 831         SGEN_ASSERT (5, sgen_ptr_in_nursery (obj), "Target pointer of global remset must be in the nursery");
 832
 833         HEAVY_STAT (++stat_wbarrier_add_to_global_remset);
 834
 835         if (!major_collector.is_concurrent) {
 836                 SGEN_ASSERT (5, current_collection_generation != -1, "Global remsets can only be added during collections");
 837         } else {
 838                 if (current_collection_generation == -1)
 839                         SGEN_ASSERT (5, sgen_concurrent_collection_in_progress (), "Global remsets outside of collection pauses can only be added by the concurrent collector");
 840         }
 841
 842         if (!object_is_pinned (obj))
 843                 SGEN_ASSERT (5, sgen_minor_collector.is_split || sgen_concurrent_collection_in_progress (), "Non-pinned objects can only remain in nursery if it is a split nursery");
 844         else if (sgen_cement_lookup_or_register (obj))
 845                 return;
 846
 847         remset.record_pointer (ptr);
 848
 849         if (G_UNLIKELY (do_pin_stats))
 850                 sgen_pin_stats_register_global_remset (obj);
 851
 852         SGEN_LOG (8, "Adding global remset for %p", ptr);
 853         binary_protocol_global_remset (ptr, obj, (gpointer)SGEN_LOAD_VTABLE (obj));
 854
 855
 856 #ifdef ENABLE_DTRACE
 857         if (G_UNLIKELY (MONO_GC_GLOBAL_REMSET_ADD_ENABLED ())) {
 858                 MonoVTable *vt = (MonoVTable*)LOAD_VTABLE (obj);
 859                 MONO_GC_GLOBAL_REMSET_ADD ((mword)ptr, (mword)obj, sgen_safe_object_get_size (obj),
 860                                 vt->klass->name_space, vt->klass->name);
 861         }
 862 #endif
 863 }
 864
 865 /*
 866  * sgen_drain_gray_stack:
 867  *
 868  *   Scan objects in the gray stack until the stack is empty. This should be called
 869  * frequently after each object is copied, to achieve better locality and cache
 870  * usage.
 871  *
 872  * max_objs is the maximum number of objects to scan, or -1 to scan until the stack is
 873  * empty.
 874  */
 875 gboolean
 876 sgen_drain_gray_stack (int max_objs, ScanCopyContext ctx)
 877 {
 878         ScanObjectFunc scan_func = ctx.scan_func;
 879         GrayQueue *queue = ctx.queue;
 880
 881         if (current_collection_generation == GENERATION_OLD && major_collector.drain_gray_stack)
 882                 return major_collector.drain_gray_stack (ctx);
 883
 884         do {
 885                 int i;
 886                 for (i = 0; i != max_objs; ++i) {
 887                         char *obj;
 888                         mword desc;
 889                         GRAY_OBJECT_DEQUEUE (queue, &obj, &desc);
 890                         if (!obj)
 891                                 return TRUE;
 892                         SGEN_LOG (9, "Precise gray object scan %p (%s)", obj, safe_name (obj));
 893                         scan_func (obj, desc, queue);
 894                 }
 895         } while (max_objs < 0);
 896         return FALSE;
 897 }
 898
 899 /*
 900  * Addresses in the pin queue are already sorted. This function finds
 901  * the object header for each address and pins the object. The
 902  * addresses must be inside the nursery section.  The (start of the)
 903  * address array is overwritten with the addresses of the actually
 904  * pinned objects.  Return the number of pinned objects.
 905  */
 906 static int
 907 pin_objects_from_nursery_pin_queue (ScanCopyContext ctx)
 908 {
 909         GCMemSection *section = nursery_section;
 910         void **start =  sgen_pinning_get_entry (section->pin_queue_first_entry);
 911         void **end = sgen_pinning_get_entry (section->pin_queue_last_entry);
 912         void *start_nursery = section->data;
 913         void *end_nursery = section->next_data;
 914         void *last = NULL;
 915         int count = 0;
 916         void *search_start;
 917         void *addr;
 918         void *pinning_front = start_nursery;
 919         size_t idx;
 920         void **definitely_pinned = start;
 921         ScanObjectFunc scan_func = ctx.scan_func;
 922         SgenGrayQueue *queue = ctx.queue;
 923
 924         sgen_nursery_allocator_prepare_for_pinning ();
 925
 926         while (start < end) {
 927                 void *obj_to_pin = NULL;
 928                 size_t obj_to_pin_size = 0;
 929                 mword desc;
 930
 931                 addr = *start;
 932
 933                 SGEN_ASSERT (0, addr >= start_nursery && addr < end_nursery, "Potential pinning address out of range");
 934                 SGEN_ASSERT (0, addr >= last, "Pin queue not sorted");
 935
 936                 if (addr == last) {
 937                         ++start;
 938                         continue;
 939                 }
 940
 941                 SGEN_LOG (5, "Considering pinning addr %p", addr);
 942                 /* We've already processed everything up to pinning_front. */
 943                 if (addr < pinning_front) {
 944                         start++;
 945                         continue;
 946                 }
 947
 948                 /*
 949                  * Find the closest scan start <= addr.  We might search backward in the
 950                  * scan_starts array because entries might be NULL.  In the worst case we
 951                  * start at start_nursery.
 952                  */
 953                 idx = ((char*)addr - (char*)section->data) / SCAN_START_SIZE;
 954                 SGEN_ASSERT (0, idx < section->num_scan_start, "Scan start index out of range");
 955                 search_start = (void*)section->scan_starts [idx];
 956                 if (!search_start || search_start > addr) {
 957                         while (idx) {
 958                                 --idx;
 959                                 search_start = section->scan_starts [idx];
 960                                 if (search_start && search_start <= addr)
 961                                         break;
 962                         }
 963                         if (!search_start || search_start > addr)
 964                                 search_start = start_nursery;
 965                 }
 966
 967                 /*
 968                  * If the pinning front is closer than the scan start we found, start
 969                  * searching at the front.
 970                  */
 971                 if (search_start < pinning_front)
 972                         search_start = pinning_front;
 973
 974                 /*
 975                  * Now addr should be in an object a short distance from search_start.
 976                  *
 977                  * search_start must point to zeroed mem or point to an object.
 978                  */
 979                 do {
 980                         size_t obj_size, canarified_obj_size;
 981
 982                         /* Skip zeros. */
 983                         if (!*(void**)search_start) {
 984                                 search_start = (void*)ALIGN_UP ((mword)search_start + sizeof (gpointer));
 985                                 /* The loop condition makes sure we don't overrun addr. */
 986                                 continue;
 987                         }
 988
 989                         canarified_obj_size = obj_size = ALIGN_UP (safe_object_get_size ((MonoObject*)search_start));
 990
 991                         /*
 992                          * Filler arrays are marked by an invalid sync word.  We don't
 993                          * consider them for pinning.  They are not delimited by canaries,
 994                          * either.
 995                          */
 996                         if (((MonoObject*)search_start)->synchronisation != GINT_TO_POINTER (-1)) {
 997                                 CHECK_CANARY_FOR_OBJECT (search_start);
 998                                 CANARIFY_SIZE (canarified_obj_size);
 999
1000                                 if (addr >= search_start && (char*)addr < (char*)search_start + obj_size) {
1001                                         /* This is the object we're looking for. */
1002                                         obj_to_pin = search_start;
1003                                         obj_to_pin_size = canarified_obj_size;
1004                                         break;
1005                                 }
1006                         }
1007
1008                         /* Skip to the next object */
1009                         search_start = (void*)((char*)search_start + canarified_obj_size);
1010                 } while (search_start <= addr);
1011
1012                 /* We've searched past the address we were looking for. */
1013                 if (!obj_to_pin) {
1014                         pinning_front = search_start;
1015                         goto next_pin_queue_entry;
1016                 }
1017
1018                 /*
1019                  * We've found an object to pin.  It might still be a dummy array, but we
1020                  * can advance the pinning front in any case.
1021                  */
1022                 pinning_front = (char*)obj_to_pin + obj_to_pin_size;
1023
1024                 /*
1025                  * If this is a dummy array marking the beginning of a nursery
1026                  * fragment, we don't pin it.
1027                  */
1028                 if (((MonoObject*)obj_to_pin)->synchronisation == GINT_TO_POINTER (-1))
1029                         goto next_pin_queue_entry;
1030
1031                 /*
1032                  * Finally - pin the object!
1033                  */
1034                 desc = sgen_obj_get_descriptor_safe (obj_to_pin);
1035                 if (scan_func) {
1036                         scan_func (obj_to_pin, desc, queue);
1037                 } else {
1038                         SGEN_LOG (4, "Pinned object %p, vtable %p (%s), count %d\n",
1039                                         obj_to_pin, *(void**)obj_to_pin, safe_name (obj_to_pin), count);
1040                         binary_protocol_pin (obj_to_pin,
1041                                         (gpointer)LOAD_VTABLE (obj_to_pin),
1042                                         safe_object_get_size (obj_to_pin));
1043
1044 #ifdef ENABLE_DTRACE
1045                         if (G_UNLIKELY (MONO_GC_OBJ_PINNED_ENABLED ())) {
1046                                 int gen = sgen_ptr_in_nursery (obj_to_pin) ? GENERATION_NURSERY : GENERATION_OLD;
1047                                 MonoVTable *vt = (MonoVTable*)LOAD_VTABLE (obj_to_pin);
1048                                 MONO_GC_OBJ_PINNED ((mword)obj_to_pin,
1049                                                 sgen_safe_object_get_size (obj_to_pin),
1050                                                 vt->klass->name_space, vt->klass->name, gen);
1051                         }
1052 #endif
1053
1054                         pin_object (obj_to_pin);
1055                         GRAY_OBJECT_ENQUEUE (queue, obj_to_pin, desc);
1056                         if (G_UNLIKELY (do_pin_stats))
1057                                 sgen_pin_stats_register_object (obj_to_pin, obj_to_pin_size);
1058                         definitely_pinned [count] = obj_to_pin;
1059                         count++;
1060                 }
1061
1062         next_pin_queue_entry:
1063                 last = addr;
1064                 ++start;
1065         }
1066         //printf ("effective pinned: %d (at the end: %d)\n", count, (char*)end_nursery - (char*)last);
1067         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS) {
1068                 GCRootReport report;
1069                 report.count = 0;
1070                 for (idx = 0; idx < count; ++idx)
1071                         add_profile_gc_root (&report, definitely_pinned [idx], MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
1072                 notify_gc_roots (&report);
1073         }
1074         stat_pinned_objects += count;
1075         return count;
1076 }
1077
1078 static void
1079 pin_objects_in_nursery (ScanCopyContext ctx)
1080 {
1081         size_t reduced_to;
1082
1083         if (nursery_section->pin_queue_first_entry == nursery_section->pin_queue_last_entry)
1084                 return;
1085
1086         reduced_to = pin_objects_from_nursery_pin_queue (ctx);
1087         nursery_section->pin_queue_last_entry = nursery_section->pin_queue_first_entry + reduced_to;
1088 }
1089
1090 /*
1091  * This function is only ever called (via `collector_pin_object()` in `sgen-copy-object.h`)
1092  * when we can't promote an object because we're out of memory.
1093  */
1094 void
1095 sgen_pin_object (void *object, GrayQueue *queue)
1096 {
1097         /*
1098          * All pinned objects are assumed to have been staged, so we need to stage as well.
1099          * Also, the count of staged objects shows that "late pinning" happened.
1100          */
1101         sgen_pin_stage_ptr (object);
1102
1103         SGEN_PIN_OBJECT (object);
1104         binary_protocol_pin (object, (gpointer)LOAD_VTABLE (object), safe_object_get_size (object));
1105
1106         ++objects_pinned;
1107         if (G_UNLIKELY (do_pin_stats))
1108                 sgen_pin_stats_register_object (object, safe_object_get_size (object));
1109
1110         GRAY_OBJECT_ENQUEUE (queue, object, sgen_obj_get_descriptor_safe (object));
1111
1112 #ifdef ENABLE_DTRACE
1113         if (G_UNLIKELY (MONO_GC_OBJ_PINNED_ENABLED ())) {
1114                 int gen = sgen_ptr_in_nursery (object) ? GENERATION_NURSERY : GENERATION_OLD;
1115                 MonoVTable *vt = (MonoVTable*)LOAD_VTABLE (object);
1116                 MONO_GC_OBJ_PINNED ((mword)object, sgen_safe_object_get_size (object), vt->klass->name_space, vt->klass->name, gen);
1117         }
1118 #endif
1119 }
1120
1121 /* Sort the addresses in array in increasing order.
1122  * Done using a by-the book heap sort. Which has decent and stable performance, is pretty cache efficient.
1123  */
1124 void
1125 sgen_sort_addresses (void **array, size_t size)
1126 {
1127         size_t i;
1128         void *tmp;
1129
1130         for (i = 1; i < size; ++i) {
1131                 size_t child = i;
1132                 while (child > 0) {
1133                         size_t parent = (child - 1) / 2;
1134
1135                         if (array [parent] >= array [child])
1136                                 break;
1137
1138                         tmp = array [parent];
1139                         array [parent] = array [child];
1140                         array [child] = tmp;
1141
1142                         child = parent;
1143                 }
1144         }
1145
1146         for (i = size - 1; i > 0; --i) {
1147                 size_t end, root;
1148                 tmp = array [i];
1149                 array [i] = array [0];
1150                 array [0] = tmp;
1151
1152                 end = i - 1;
1153                 root = 0;
1154
1155                 while (root * 2 + 1 <= end) {
1156                         size_t child = root * 2 + 1;
1157
1158                         if (child < end && array [child] < array [child + 1])
1159                                 ++child;
1160                         if (array [root] >= array [child])
1161                                 break;
1162
1163                         tmp = array [root];
1164                         array [root] = array [child];
1165                         array [child] = tmp;
1166
1167                         root = child;
1168                 }
1169         }
1170 }
1171
1172 /*
1173  * Scan the memory between start and end and queue values which could be pointers
1174  * to the area between start_nursery and end_nursery for later consideration.
1175  * Typically used for thread stacks.
1176  */
1177 static void
1178 conservatively_pin_objects_from (void **start, void **end, void *start_nursery, void *end_nursery, int pin_type)
1179 {
1180         int count = 0;
1181
1182 #ifdef VALGRIND_MAKE_MEM_DEFINED_IF_ADDRESSABLE
1183         VALGRIND_MAKE_MEM_DEFINED_IF_ADDRESSABLE (start, (char*)end - (char*)start);
1184 #endif
1185
1186         while (start < end) {
1187                 if (*start >= start_nursery && *start < end_nursery) {
1188                         /*
1189                          * *start can point to the middle of an object
1190                          * note: should we handle pointing at the end of an object?
1191                          * pinning in C# code disallows pointing at the end of an object
1192                          * but there is some small chance that an optimizing C compiler
1193                          * may keep the only reference to an object by pointing
1194                          * at the end of it. We ignore this small chance for now.
1195                          * Pointers to the end of an object are indistinguishable
1196                          * from pointers to the start of the next object in memory
1197                          * so if we allow that we'd need to pin two objects...
1198                          * We queue the pointer in an array, the
1199                          * array will then be sorted and uniqued. This way
1200                          * we can coalesce several pinning pointers and it should
1201                          * be faster since we'd do a memory scan with increasing
1202                          * addresses. Note: we can align the address to the allocation
1203                          * alignment, so the unique process is more effective.
1204                          */
1205                         mword addr = (mword)*start;
1206                         addr &= ~(ALLOC_ALIGN - 1);
1207                         if (addr >= (mword)start_nursery && addr < (mword)end_nursery) {
1208                                 SGEN_LOG (6, "Pinning address %p from %p", (void*)addr, start);
1209                                 sgen_pin_stage_ptr ((void*)addr);
1210                                 binary_protocol_pin_stage (start, (void*)addr);
1211                                 count++;
1212                         }
1213                         if (G_UNLIKELY (do_pin_stats)) {
1214                                 if (ptr_in_nursery ((void*)addr))
1215                                         sgen_pin_stats_register_address ((char*)addr, pin_type);
1216                         }
1217                 }
1218                 start++;
1219         }
1220         if (count)
1221                 SGEN_LOG (7, "found %d potential pinned heap pointers", count);
1222 }
1223
1224 /*
1225  * The first thing we do in a collection is to identify pinned objects.
1226  * This function considers all the areas of memory that need to be
1227  * conservatively scanned.
1228  */
1229 static void
1230 pin_from_roots (void *start_nursery, void *end_nursery, GrayQueue *queue)
1231 {
1232         void **start_root;
1233         RootRecord *root;
1234         SGEN_LOG (2, "Scanning pinned roots (%d bytes, %d/%d entries)", (int)roots_size, roots_hash [ROOT_TYPE_NORMAL].num_entries, roots_hash [ROOT_TYPE_PINNED].num_entries);
1235         /* objects pinned from the API are inside these roots */
1236         SGEN_HASH_TABLE_FOREACH (&roots_hash [ROOT_TYPE_PINNED], start_root, root) {
1237                 SGEN_LOG (6, "Pinned roots %p-%p", start_root, root->end_root);
1238                 conservatively_pin_objects_from (start_root, (void**)root->end_root, start_nursery, end_nursery, PIN_TYPE_OTHER);
1239         } SGEN_HASH_TABLE_FOREACH_END;
1240         /* now deal with the thread stacks
1241          * in the future we should be able to conservatively scan only:
1242          * *) the cpu registers
1243          * *) the unmanaged stack frames
1244          * *) the _last_ managed stack frame
1245          * *) pointers slots in managed frames
1246          */
1247         scan_thread_data (start_nursery, end_nursery, FALSE, queue);
1248 }
1249
1250 static void
1251 unpin_objects_from_queue (SgenGrayQueue *queue)
1252 {
1253         for (;;) {
1254                 char *addr;
1255                 mword desc;
1256                 GRAY_OBJECT_DEQUEUE (queue, &addr, &desc);
1257                 if (!addr)
1258                         break;
1259                 g_assert (SGEN_OBJECT_IS_PINNED (addr));
1260                 SGEN_UNPIN_OBJECT (addr);
1261         }
1262 }
1263
1264 typedef struct {
1265         CopyOrMarkObjectFunc func;
1266         GrayQueue *queue;
1267 } UserCopyOrMarkData;
1268
1269 static void
1270 single_arg_user_copy_or_mark (void **obj, void *gc_data)
1271 {
1272         UserCopyOrMarkData *data = gc_data;
1273
1274         data->func (obj, data->queue);
1275 }
1276
1277 /*
1278  * The memory area from start_root to end_root contains pointers to objects.
1279  * Their position is precisely described by @desc (this means that the pointer
1280  * can be either NULL or the pointer to the start of an object).
1281  * This functions copies them to to_space updates them.
1282  *
1283  * This function is not thread-safe!
1284  */
1285 static void
1286 precisely_scan_objects_from (void** start_root, void** end_root, char* n_start, char *n_end, mword desc, ScanCopyContext ctx)
1287 {
1288         CopyOrMarkObjectFunc copy_func = ctx.copy_func;
1289         SgenGrayQueue *queue = ctx.queue;
1290
1291         switch (desc & ROOT_DESC_TYPE_MASK) {
1292         case ROOT_DESC_BITMAP:
1293                 desc >>= ROOT_DESC_TYPE_SHIFT;
1294                 while (desc) {
1295                         if ((desc & 1) && *start_root) {
1296                                 copy_func (start_root, queue);
1297                                 SGEN_LOG (9, "Overwrote root at %p with %p", start_root, *start_root);
1298                         }
1299                         desc >>= 1;
1300                         start_root++;
1301                 }
1302                 return;
1303         case ROOT_DESC_COMPLEX: {
1304                 gsize *bitmap_data = sgen_get_complex_descriptor_bitmap (desc);
1305                 gsize bwords = (*bitmap_data) - 1;
1306                 void **start_run = start_root;
1307                 bitmap_data++;
1308                 while (bwords-- > 0) {
1309                         gsize bmap = *bitmap_data++;
1310                         void **objptr = start_run;
1311                         while (bmap) {
1312                                 if ((bmap & 1) && *objptr) {
1313                                         copy_func (objptr, queue);
1314                                         SGEN_LOG (9, "Overwrote root at %p with %p", objptr, *objptr);
1315                                 }
1316                                 bmap >>= 1;
1317                                 ++objptr;
1318                         }
1319                         start_run += GC_BITS_PER_WORD;
1320                 }
1321                 break;
1322         }
1323         case ROOT_DESC_USER: {
1324                 UserCopyOrMarkData data = { copy_func, queue };
1325                 MonoGCRootMarkFunc marker = sgen_get_user_descriptor_func (desc);
1326                 marker (start_root, single_arg_user_copy_or_mark, &data);
1327                 break;
1328         }
1329         case ROOT_DESC_RUN_LEN:
1330                 g_assert_not_reached ();
1331         default:
1332                 g_assert_not_reached ();
1333         }
1334 }
1335
1336 static void
1337 reset_heap_boundaries (void)
1338 {
1339         lowest_heap_address = ~(mword)0;
1340         highest_heap_address = 0;
1341 }
1342
1343 void
1344 sgen_update_heap_boundaries (mword low, mword high)
1345 {
1346         mword old;
1347
1348         do {
1349                 old = lowest_heap_address;
1350                 if (low >= old)
1351                         break;
1352         } while (SGEN_CAS_PTR ((gpointer*)&lowest_heap_address, (gpointer)low, (gpointer)old) != (gpointer)old);
1353
1354         do {
1355                 old = highest_heap_address;
1356                 if (high <= old)
1357                         break;
1358         } while (SGEN_CAS_PTR ((gpointer*)&highest_heap_address, (gpointer)high, (gpointer)old) != (gpointer)old);
1359 }
1360
1361 /*
1362  * Allocate and setup the data structures needed to be able to allocate objects
1363  * in the nursery. The nursery is stored in nursery_section.
1364  */
1365 static void
1366 alloc_nursery (void)
1367 {
1368         GCMemSection *section;
1369         char *data;
1370         size_t scan_starts;
1371         size_t alloc_size;
1372
1373         if (nursery_section)
1374                 return;
1375         SGEN_LOG (2, "Allocating nursery size: %zu", (size_t)sgen_nursery_size);
1376         /* later we will alloc a larger area for the nursery but only activate
1377          * what we need. The rest will be used as expansion if we have too many pinned
1378          * objects in the existing nursery.
1379          */
1380         /* FIXME: handle OOM */
1381         section = sgen_alloc_internal (INTERNAL_MEM_SECTION);
1382
1383         alloc_size = sgen_nursery_size;
1384
1385         /* If there isn't enough space even for the nursery we should simply abort. */
1386         g_assert (sgen_memgov_try_alloc_space (alloc_size, SPACE_NURSERY));
1387
1388         data = major_collector.alloc_heap (alloc_size, alloc_size, DEFAULT_NURSERY_BITS);
1389         sgen_update_heap_boundaries ((mword)data, (mword)(data + sgen_nursery_size));
1390         SGEN_LOG (4, "Expanding nursery size (%p-%p): %lu, total: %lu", data, data + alloc_size, (unsigned long)sgen_nursery_size, (unsigned long)mono_gc_get_heap_size ());
1391         section->data = section->next_data = data;
1392         section->size = alloc_size;
1393         section->end_data = data + sgen_nursery_size;
1394         scan_starts = (alloc_size + SCAN_START_SIZE - 1) / SCAN_START_SIZE;
1395         section->scan_starts = sgen_alloc_internal_dynamic (sizeof (char*) * scan_starts, INTERNAL_MEM_SCAN_STARTS, TRUE);
1396         section->num_scan_start = scan_starts;
1397
1398         nursery_section = section;
1399
1400         sgen_nursery_allocator_set_nursery_bounds (data, data + sgen_nursery_size);
1401 }
1402
1403 void*
1404 mono_gc_get_nursery (int *shift_bits, size_t *size)
1405 {
1406         *size = sgen_nursery_size;
1407         *shift_bits = DEFAULT_NURSERY_BITS;
1408         return sgen_get_nursery_start ();
1409 }
1410
1411 void
1412 mono_gc_set_current_thread_appdomain (MonoDomain *domain)
1413 {
1414         SgenThreadInfo *info = mono_thread_info_current ();
1415
1416         /* Could be called from sgen_thread_unregister () with a NULL info */
1417         if (domain) {
1418                 g_assert (info);
1419                 info->stopped_domain = domain;
1420         }
1421 }
1422
1423 gboolean
1424 mono_gc_precise_stack_mark_enabled (void)
1425 {
1426         return !conservative_stack_mark;
1427 }
1428
1429 FILE *
1430 mono_gc_get_logfile (void)
1431 {
1432         return gc_debug_file;
1433 }
1434
1435 static void
1436 report_finalizer_roots_list (FinalizeReadyEntry *list)
1437 {
1438         GCRootReport report;
1439         FinalizeReadyEntry *fin;
1440
1441         report.count = 0;
1442         for (fin = list; fin; fin = fin->next) {
1443                 if (!fin->object)
1444                         continue;
1445                 add_profile_gc_root (&report, fin->object, MONO_PROFILE_GC_ROOT_FINALIZER, 0);
1446         }
1447         notify_gc_roots (&report);
1448 }
1449
1450 static void
1451 report_finalizer_roots (void)
1452 {
1453         report_finalizer_roots_list (fin_ready_list);
1454         report_finalizer_roots_list (critical_fin_list);
1455 }
1456
1457 static GCRootReport *root_report;
1458
1459 static void
1460 single_arg_report_root (void **obj, void *gc_data)
1461 {
1462         if (*obj)
1463                 add_profile_gc_root (root_report, *obj, MONO_PROFILE_GC_ROOT_OTHER, 0);
1464 }
1465
1466 static void
1467 precisely_report_roots_from (GCRootReport *report, void** start_root, void** end_root, mword desc)
1468 {
1469         switch (desc & ROOT_DESC_TYPE_MASK) {
1470         case ROOT_DESC_BITMAP:
1471                 desc >>= ROOT_DESC_TYPE_SHIFT;
1472                 while (desc) {
1473                         if ((desc & 1) && *start_root) {
1474                                 add_profile_gc_root (report, *start_root, MONO_PROFILE_GC_ROOT_OTHER, 0);
1475                         }
1476                         desc >>= 1;
1477                         start_root++;
1478                 }
1479                 return;
1480         case ROOT_DESC_COMPLEX: {
1481                 gsize *bitmap_data = sgen_get_complex_descriptor_bitmap (desc);
1482                 gsize bwords = (*bitmap_data) - 1;
1483                 void **start_run = start_root;
1484                 bitmap_data++;
1485                 while (bwords-- > 0) {
1486                         gsize bmap = *bitmap_data++;
1487                         void **objptr = start_run;
1488                         while (bmap) {
1489                                 if ((bmap & 1) && *objptr) {
1490                                         add_profile_gc_root (report, *objptr, MONO_PROFILE_GC_ROOT_OTHER, 0);
1491                                 }
1492                                 bmap >>= 1;
1493                                 ++objptr;
1494                         }
1495                         start_run += GC_BITS_PER_WORD;
1496                 }
1497                 break;
1498         }
1499         case ROOT_DESC_USER: {
1500                 MonoGCRootMarkFunc marker = sgen_get_user_descriptor_func (desc);
1501                 root_report = report;
1502                 marker (start_root, single_arg_report_root, NULL);
1503                 break;
1504         }
1505         case ROOT_DESC_RUN_LEN:
1506                 g_assert_not_reached ();
1507         default:
1508                 g_assert_not_reached ();
1509         }
1510 }
1511
1512 static void
1513 report_registered_roots_by_type (int root_type)
1514 {
1515         GCRootReport report;
1516         void **start_root;
1517         RootRecord *root;
1518         report.count = 0;
1519         SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], start_root, root) {
1520                 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
1521                 precisely_report_roots_from (&report, start_root, (void**)root->end_root, root->root_desc);
1522         } SGEN_HASH_TABLE_FOREACH_END;
1523         notify_gc_roots (&report);
1524 }
1525
1526 static void
1527 report_registered_roots (void)
1528 {
1529         report_registered_roots_by_type (ROOT_TYPE_NORMAL);
1530         report_registered_roots_by_type (ROOT_TYPE_WBARRIER);
1531 }
1532
1533 static void
1534 scan_finalizer_entries (FinalizeReadyEntry *list, ScanCopyContext ctx)
1535 {
1536         CopyOrMarkObjectFunc copy_func = ctx.copy_func;
1537         SgenGrayQueue *queue = ctx.queue;
1538         FinalizeReadyEntry *fin;
1539
1540         for (fin = list; fin; fin = fin->next) {
1541                 if (!fin->object)
1542                         continue;
1543                 SGEN_LOG (5, "Scan of fin ready object: %p (%s)\n", fin->object, safe_name (fin->object));
1544                 copy_func (&fin->object, queue);
1545         }
1546 }
1547
1548 static const char*
1549 generation_name (int generation)
1550 {
1551         switch (generation) {
1552         case GENERATION_NURSERY: return "nursery";
1553         case GENERATION_OLD: return "old";
1554         default: g_assert_not_reached ();
1555         }
1556 }
1557
1558 const char*
1559 sgen_generation_name (int generation)
1560 {
1561         return generation_name (generation);
1562 }
1563
1564 SgenObjectOperations *
1565 sgen_get_current_object_ops (void){
1566         return &current_object_ops;
1567 }
1568
1569
1570 static void
1571 finish_gray_stack (int generation, GrayQueue *queue)
1572 {
1573         TV_DECLARE (atv);
1574         TV_DECLARE (btv);
1575         int done_with_ephemerons, ephemeron_rounds = 0;
1576         CopyOrMarkObjectFunc copy_func = current_object_ops.copy_or_mark_object;
1577         ScanObjectFunc scan_func = current_object_ops.scan_object;
1578         ScanCopyContext ctx = { scan_func, copy_func, queue };
1579         char *start_addr = generation == GENERATION_NURSERY ? sgen_get_nursery_start () : NULL;
1580         char *end_addr = generation == GENERATION_NURSERY ? sgen_get_nursery_end () : (char*)-1;
1581
1582         /*
1583          * We copied all the reachable objects. Now it's the time to copy
1584          * the objects that were not referenced by the roots, but by the copied objects.
1585          * we built a stack of objects pointed to by gray_start: they are
1586          * additional roots and we may add more items as we go.
1587          * We loop until gray_start == gray_objects which means no more objects have
1588          * been added. Note this is iterative: no recursion is involved.
1589          * We need to walk the LO list as well in search of marked big objects
1590          * (use a flag since this is needed only on major collections). We need to loop
1591          * here as well, so keep a counter of marked LO (increasing it in copy_object).
1592          *   To achieve better cache locality and cache usage, we drain the gray stack
1593          * frequently, after each object is copied, and just finish the work here.
1594          */
1595         sgen_drain_gray_stack (-1, ctx);
1596         TV_GETTIME (atv);
1597         SGEN_LOG (2, "%s generation done", generation_name (generation));
1598
1599         /*
1600         Reset bridge data, we might have lingering data from a previous collection if this is a major
1601         collection trigged by minor overflow.
1602
1603         We must reset the gathered bridges since their original block might be evacuated due to major
1604         fragmentation in the meanwhile and the bridge code should not have to deal with that.
1605         */
1606         if (sgen_need_bridge_processing ())
1607                 sgen_bridge_reset_data ();
1608
1609         /*
1610          * Walk the ephemeron tables marking all values with reachable keys. This must be completely done
1611          * before processing finalizable objects and non-tracking weak links to avoid finalizing/clearing
1612          * objects that are in fact reachable.
1613          */
1614         done_with_ephemerons = 0;
1615         do {
1616                 done_with_ephemerons = mark_ephemerons_in_range (ctx);
1617                 sgen_drain_gray_stack (-1, ctx);
1618                 ++ephemeron_rounds;
1619         } while (!done_with_ephemerons);
1620
1621         sgen_mark_togglerefs (start_addr, end_addr, ctx);
1622
1623         if (sgen_need_bridge_processing ()) {
1624                 /*Make sure the gray stack is empty before we process bridge objects so we get liveness right*/
1625                 sgen_drain_gray_stack (-1, ctx);
1626                 sgen_collect_bridge_objects (generation, ctx);
1627                 if (generation == GENERATION_OLD)
1628                         sgen_collect_bridge_objects (GENERATION_NURSERY, ctx);
1629
1630                 /*
1631                 Do the first bridge step here, as the collector liveness state will become useless after that.
1632
1633                 An important optimization is to only proccess the possibly dead part of the object graph and skip
1634                 over all live objects as we transitively know everything they point must be alive too.
1635
1636                 The above invariant is completely wrong if we let the gray queue be drained and mark/copy everything.
1637
1638                 This has the unfortunate side effect of making overflow collections perform the first step twice, but
1639                 given we now have heuristics that perform major GC in anticipation of minor overflows this should not
1640                 be a big deal.
1641                 */
1642                 sgen_bridge_processing_stw_step ();
1643         }
1644
1645         /*
1646         Make sure we drain the gray stack before processing disappearing links and finalizers.
1647         If we don't make sure it is empty we might wrongly see a live object as dead.
1648         */
1649         sgen_drain_gray_stack (-1, ctx);
1650
1651         /*
1652         We must clear weak links that don't track resurrection before processing object ready for
1653         finalization so they can be cleared before that.
1654         */
1655         sgen_null_link_in_range (generation, TRUE, ctx);
1656         if (generation == GENERATION_OLD)
1657                 sgen_null_link_in_range (GENERATION_NURSERY, TRUE, ctx);
1658
1659
1660         /* walk the finalization queue and move also the objects that need to be
1661          * finalized: use the finalized objects as new roots so the objects they depend
1662          * on are also not reclaimed. As with the roots above, only objects in the nursery
1663          * are marked/copied.
1664          */
1665         sgen_finalize_in_range (generation, ctx);
1666         if (generation == GENERATION_OLD)
1667                 sgen_finalize_in_range (GENERATION_NURSERY, ctx);
1668         /* drain the new stack that might have been created */
1669         SGEN_LOG (6, "Precise scan of gray area post fin");
1670         sgen_drain_gray_stack (-1, ctx);
1671
1672         /*
1673          * This must be done again after processing finalizable objects since CWL slots are cleared only after the key is finalized.
1674          */
1675         done_with_ephemerons = 0;
1676         do {
1677                 done_with_ephemerons = mark_ephemerons_in_range (ctx);
1678                 sgen_drain_gray_stack (-1, ctx);
1679                 ++ephemeron_rounds;
1680         } while (!done_with_ephemerons);
1681
1682         /*
1683          * Clear ephemeron pairs with unreachable keys.
1684          * We pass the copy func so we can figure out if an array was promoted or not.
1685          */
1686         clear_unreachable_ephemerons (ctx);
1687
1688         /*
1689          * We clear togglerefs only after all possible chances of revival are done.
1690          * This is semantically more inline with what users expect and it allows for
1691          * user finalizers to correctly interact with TR objects.
1692         */
1693         sgen_clear_togglerefs (start_addr, end_addr, ctx);
1694
1695         TV_GETTIME (btv);
1696         SGEN_LOG (2, "Finalize queue handling scan for %s generation: %d usecs %d ephemeron rounds", generation_name (generation), TV_ELAPSED (atv, btv), ephemeron_rounds);
1697
1698         /*
1699          * handle disappearing links
1700          * Note we do this after checking the finalization queue because if an object
1701          * survives (at least long enough to be finalized) we don't clear the link.
1702          * This also deals with a possible issue with the monitor reclamation: with the Boehm
1703          * GC a finalized object my lose the monitor because it is cleared before the finalizer is
1704          * called.
1705          */
1706         g_assert (sgen_gray_object_queue_is_empty (queue));
1707         for (;;) {
1708                 sgen_null_link_in_range (generation, FALSE, ctx);
1709                 if (generation == GENERATION_OLD)
1710                         sgen_null_link_in_range (GENERATION_NURSERY, FALSE, ctx);
1711                 if (sgen_gray_object_queue_is_empty (queue))
1712                         break;
1713                 sgen_drain_gray_stack (-1, ctx);
1714         }
1715
1716         g_assert (sgen_gray_object_queue_is_empty (queue));
1717
1718         sgen_gray_object_queue_trim_free_list (queue);
1719 }
1720
1721 void
1722 sgen_check_section_scan_starts (GCMemSection *section)
1723 {
1724         size_t i;
1725         for (i = 0; i < section->num_scan_start; ++i) {
1726                 if (section->scan_starts [i]) {
1727                         mword size = safe_object_get_size ((MonoObject*) section->scan_starts [i]);
1728                         g_assert (size >= sizeof (MonoObject) && size <= MAX_SMALL_OBJ_SIZE);
1729                 }
1730         }
1731 }
1732
1733 static void
1734 check_scan_starts (void)
1735 {
1736         if (!do_scan_starts_check)
1737                 return;
1738         sgen_check_section_scan_starts (nursery_section);
1739         major_collector.check_scan_starts ();
1740 }
1741
1742 static void
1743 scan_from_registered_roots (char *addr_start, char *addr_end, int root_type, ScanCopyContext ctx)
1744 {
1745         void **start_root;
1746         RootRecord *root;
1747         SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], start_root, root) {
1748                 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
1749                 precisely_scan_objects_from (start_root, (void**)root->end_root, addr_start, addr_end, root->root_desc, ctx);
1750         } SGEN_HASH_TABLE_FOREACH_END;
1751 }
1752
1753 void
1754 sgen_dump_occupied (char *start, char *end, char *section_start)
1755 {
1756         fprintf (heap_dump_file, "<occupied offset=\"%td\" size=\"%td\"/>\n", start - section_start, end - start);
1757 }
1758
1759 void
1760 sgen_dump_section (GCMemSection *section, const char *type)
1761 {
1762         char *start = section->data;
1763         char *end = section->data + section->size;
1764         char *occ_start = NULL;
1765         GCVTable *vt;
1766         char *old_start G_GNUC_UNUSED = NULL; /* just for debugging */
1767
1768         fprintf (heap_dump_file, "<section type=\"%s\" size=\"%lu\">\n", type, (unsigned long)section->size);
1769
1770         while (start < end) {
1771                 guint size;
1772                 MonoClass *class G_GNUC_UNUSED;
1773
1774                 if (!*(void**)start) {
1775                         if (occ_start) {
1776                                 sgen_dump_occupied (occ_start, start, section->data);
1777                                 occ_start = NULL;
1778                         }
1779                         start += sizeof (void*); /* should be ALLOC_ALIGN, really */
1780                         continue;
1781                 }
1782                 g_assert (start < section->next_data);
1783
1784                 if (!occ_start)
1785                         occ_start = start;
1786
1787                 vt = (GCVTable*)LOAD_VTABLE (start);
1788                 class = vt->klass;
1789
1790                 size = ALIGN_UP (safe_object_get_size ((MonoObject*) start));
1791
1792                 /*
1793                 fprintf (heap_dump_file, "<object offset=\"%d\" class=\"%s.%s\" size=\"%d\"/>\n",
1794                                 start - section->data,
1795                                 vt->klass->name_space, vt->klass->name,
1796                                 size);
1797                 */
1798
1799                 old_start = start;
1800                 start += size;
1801         }
1802         if (occ_start)
1803                 sgen_dump_occupied (occ_start, start, section->data);
1804
1805         fprintf (heap_dump_file, "</section>\n");
1806 }
1807
1808 static void
1809 dump_object (MonoObject *obj, gboolean dump_location)
1810 {
1811         static char class_name [1024];
1812
1813         MonoClass *class = mono_object_class (obj);
1814         int i, j;
1815
1816         /*
1817          * Python's XML parser is too stupid to parse angle brackets
1818          * in strings, so we just ignore them;
1819          */
1820         i = j = 0;
1821         while (class->name [i] && j < sizeof (class_name) - 1) {
1822                 if (!strchr ("<>\"", class->name [i]))
1823                         class_name [j++] = class->name [i];
1824                 ++i;
1825         }
1826         g_assert (j < sizeof (class_name));
1827         class_name [j] = 0;
1828
1829         fprintf (heap_dump_file, "<object class=\"%s.%s\" size=\"%zd\"",
1830                         class->name_space, class_name,
1831                         safe_object_get_size (obj));
1832         if (dump_location) {
1833                 const char *location;
1834                 if (ptr_in_nursery (obj))
1835                         location = "nursery";
1836                 else if (safe_object_get_size (obj) <= MAX_SMALL_OBJ_SIZE)
1837                         location = "major";
1838                 else
1839                         location = "LOS";
1840                 fprintf (heap_dump_file, " location=\"%s\"", location);
1841         }
1842         fprintf (heap_dump_file, "/>\n");
1843 }
1844
1845 static void
1846 dump_heap (const char *type, int num, const char *reason)
1847 {
1848         ObjectList *list;
1849         LOSObject *bigobj;
1850
1851         fprintf (heap_dump_file, "<collection type=\"%s\" num=\"%d\"", type, num);
1852         if (reason)
1853                 fprintf (heap_dump_file, " reason=\"%s\"", reason);
1854         fprintf (heap_dump_file, ">\n");
1855         fprintf (heap_dump_file, "<other-mem-usage type=\"mempools\" size=\"%ld\"/>\n", mono_mempool_get_bytes_allocated ());
1856         sgen_dump_internal_mem_usage (heap_dump_file);
1857         fprintf (heap_dump_file, "<pinned type=\"stack\" bytes=\"%zu\"/>\n", sgen_pin_stats_get_pinned_byte_count (PIN_TYPE_STACK));
1858         /* fprintf (heap_dump_file, "<pinned type=\"static-data\" bytes=\"%d\"/>\n", pinned_byte_counts [PIN_TYPE_STATIC_DATA]); */
1859         fprintf (heap_dump_file, "<pinned type=\"other\" bytes=\"%zu\"/>\n", sgen_pin_stats_get_pinned_byte_count (PIN_TYPE_OTHER));
1860
1861         fprintf (heap_dump_file, "<pinned-objects>\n");
1862         for (list = sgen_pin_stats_get_object_list (); list; list = list->next)
1863                 dump_object (list->obj, TRUE);
1864         fprintf (heap_dump_file, "</pinned-objects>\n");
1865
1866         sgen_dump_section (nursery_section, "nursery");
1867
1868         major_collector.dump_heap (heap_dump_file);
1869
1870         fprintf (heap_dump_file, "<los>\n");
1871         for (bigobj = los_object_list; bigobj; bigobj = bigobj->next)
1872                 dump_object ((MonoObject*)bigobj->data, FALSE);
1873         fprintf (heap_dump_file, "</los>\n");
1874
1875         fprintf (heap_dump_file, "</collection>\n");
1876 }
1877
1878 void
1879 sgen_register_moved_object (void *obj, void *destination)
1880 {
1881         g_assert (mono_profiler_events & MONO_PROFILE_GC_MOVES);
1882
1883         if (moved_objects_idx == MOVED_OBJECTS_NUM) {
1884                 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
1885                 moved_objects_idx = 0;
1886         }
1887         moved_objects [moved_objects_idx++] = obj;
1888         moved_objects [moved_objects_idx++] = destination;
1889 }
1890
1891 static void
1892 init_stats (void)
1893 {
1894         static gboolean inited = FALSE;
1895
1896         if (inited)
1897                 return;
1898
1899         mono_counters_register ("Collection max time",  MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME | MONO_COUNTER_MONOTONIC, &time_max);
1900
1901         mono_counters_register ("Minor fragment clear", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_pre_collection_fragment_clear);
1902         mono_counters_register ("Minor pinning", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_pinning);
1903         mono_counters_register ("Minor scan remembered set", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_remsets);
1904         mono_counters_register ("Minor scan pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_pinned);
1905         mono_counters_register ("Minor scan registered roots", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_registered_roots);
1906         mono_counters_register ("Minor scan thread data", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_thread_data);
1907         mono_counters_register ("Minor finish gray stack", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_finish_gray_stack);
1908         mono_counters_register ("Minor fragment creation", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_fragment_creation);
1909
1910         mono_counters_register ("Major fragment clear", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_pre_collection_fragment_clear);
1911         mono_counters_register ("Major pinning", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_pinning);
1912         mono_counters_register ("Major scan pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_pinned);
1913         mono_counters_register ("Major scan registered roots", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_registered_roots);
1914         mono_counters_register ("Major scan thread data", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_thread_data);
1915         mono_counters_register ("Major scan alloc_pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_alloc_pinned);
1916         mono_counters_register ("Major scan finalized", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_finalized);
1917         mono_counters_register ("Major scan big objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_big_objects);
1918         mono_counters_register ("Major finish gray stack", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_finish_gray_stack);
1919         mono_counters_register ("Major free big objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_free_bigobjs);
1920         mono_counters_register ("Major LOS sweep", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_los_sweep);
1921         mono_counters_register ("Major sweep", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_sweep);
1922         mono_counters_register ("Major fragment creation", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_fragment_creation);
1923
1924         mono_counters_register ("Number of pinned objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_pinned_objects);
1925
1926 #ifdef HEAVY_STATISTICS
1927         mono_counters_register ("WBarrier remember pointer", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_add_to_global_remset);
1928         mono_counters_register ("WBarrier set field", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_set_field);
1929         mono_counters_register ("WBarrier set arrayref", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_set_arrayref);
1930         mono_counters_register ("WBarrier arrayref copy", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_arrayref_copy);
1931         mono_counters_register ("WBarrier generic store called", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_generic_store);
1932         mono_counters_register ("WBarrier generic atomic store called", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_generic_store_atomic);
1933         mono_counters_register ("WBarrier set root", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_set_root);
1934         mono_counters_register ("WBarrier value copy", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_value_copy);
1935         mono_counters_register ("WBarrier object copy", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_object_copy);
1936
1937         mono_counters_register ("# objects allocated degraded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_alloced_degraded);
1938         mono_counters_register ("bytes allocated degraded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_bytes_alloced_degraded);
1939
1940         mono_counters_register ("# copy_object() called (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copy_object_called_nursery);
1941         mono_counters_register ("# objects copied (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_copied_nursery);
1942         mono_counters_register ("# copy_object() called (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copy_object_called_major);
1943         mono_counters_register ("# objects copied (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_copied_major);
1944
1945         mono_counters_register ("# scan_object() called (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scan_object_called_nursery);
1946         mono_counters_register ("# scan_object() called (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scan_object_called_major);
1947
1948         mono_counters_register ("Slots allocated in vain", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_slots_allocated_in_vain);
1949
1950         mono_counters_register ("# nursery copy_object() failed from space", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_from_space);
1951         mono_counters_register ("# nursery copy_object() failed forwarded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_forwarded);
1952         mono_counters_register ("# nursery copy_object() failed pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_pinned);
1953         mono_counters_register ("# nursery copy_object() failed to space", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_to_space);
1954
1955         sgen_nursery_allocator_init_heavy_stats ();
1956         sgen_alloc_init_heavy_stats ();
1957 #endif
1958
1959         inited = TRUE;
1960 }
1961
1962
1963 static void
1964 reset_pinned_from_failed_allocation (void)
1965 {
1966         bytes_pinned_from_failed_allocation = 0;
1967 }
1968
1969 void
1970 sgen_set_pinned_from_failed_allocation (mword objsize)
1971 {
1972         bytes_pinned_from_failed_allocation += objsize;
1973 }
1974
1975 gboolean
1976 sgen_collection_is_concurrent (void)
1977 {
1978         switch (current_collection_generation) {
1979         case GENERATION_NURSERY:
1980                 return FALSE;
1981         case GENERATION_OLD:
1982                 return concurrent_collection_in_progress;
1983         default:
1984                 g_error ("Invalid current generation %d", current_collection_generation);
1985         }
1986 }
1987
1988 gboolean
1989 sgen_concurrent_collection_in_progress (void)
1990 {
1991         return concurrent_collection_in_progress;
1992 }
1993
1994 static void
1995 job_remembered_set_scan (WorkerData *worker_data, void *dummy)
1996 {
1997         remset.scan_remsets (sgen_workers_get_job_gray_queue (worker_data));
1998 }
1999
2000 typedef struct
2001 {
2002         CopyOrMarkObjectFunc copy_or_mark_func;
2003         ScanObjectFunc scan_func;
2004         char *heap_start;
2005         char *heap_end;
2006         int root_type;
2007 } ScanFromRegisteredRootsJobData;
2008
2009 static void
2010 job_scan_from_registered_roots (WorkerData *worker_data, void *job_data_untyped)
2011 {
2012         ScanFromRegisteredRootsJobData *job_data = job_data_untyped;
2013         ScanCopyContext ctx = { job_data->scan_func, job_data->copy_or_mark_func,
2014                 sgen_workers_get_job_gray_queue (worker_data) };
2015
2016         scan_from_registered_roots (job_data->heap_start, job_data->heap_end, job_data->root_type, ctx);
2017         sgen_free_internal_dynamic (job_data, sizeof (ScanFromRegisteredRootsJobData), INTERNAL_MEM_WORKER_JOB_DATA);
2018 }
2019
2020 typedef struct
2021 {
2022         char *heap_start;
2023         char *heap_end;
2024 } ScanThreadDataJobData;
2025
2026 static void
2027 job_scan_thread_data (WorkerData *worker_data, void *job_data_untyped)
2028 {
2029         ScanThreadDataJobData *job_data = job_data_untyped;
2030
2031         scan_thread_data (job_data->heap_start, job_data->heap_end, TRUE,
2032                         sgen_workers_get_job_gray_queue (worker_data));
2033         sgen_free_internal_dynamic (job_data, sizeof (ScanThreadDataJobData), INTERNAL_MEM_WORKER_JOB_DATA);
2034 }
2035
2036 static void
2037 job_scan_finalizer_entries (WorkerData *worker_data, void *job_data_untyped)
2038 {
2039         FinalizeReadyEntry *list = job_data_untyped;
2040         ScanCopyContext ctx = { NULL, current_object_ops.copy_or_mark_object, sgen_workers_get_job_gray_queue (worker_data) };
2041
2042         scan_finalizer_entries (list, ctx);
2043 }
2044
2045 static void
2046 job_scan_major_mod_union_cardtable (WorkerData *worker_data, void *job_data_untyped)
2047 {
2048         g_assert (concurrent_collection_in_progress);
2049         major_collector.scan_card_table (TRUE, sgen_workers_get_job_gray_queue (worker_data));
2050 }
2051
2052 static void
2053 job_scan_los_mod_union_cardtable (WorkerData *worker_data, void *job_data_untyped)
2054 {
2055         g_assert (concurrent_collection_in_progress);
2056         sgen_los_scan_card_table (TRUE, sgen_workers_get_job_gray_queue (worker_data));
2057 }
2058
2059 static void
2060 verify_scan_starts (char *start, char *end)
2061 {
2062         size_t i;
2063
2064         for (i = 0; i < nursery_section->num_scan_start; ++i) {
2065                 char *addr = nursery_section->scan_starts [i];
2066                 if (addr > start && addr < end)
2067                         SGEN_LOG (1, "NFC-BAD SCAN START [%zu] %p for obj [%p %p]", i, addr, start, end);
2068         }
2069 }
2070
2071 static void
2072 verify_nursery (void)
2073 {
2074         char *start, *end, *cur, *hole_start;
2075
2076         if (!do_verify_nursery)
2077                 return;
2078
2079         if (nursery_canaries_enabled ())
2080                 SGEN_LOG (1, "Checking nursery canaries...");
2081
2082         /*This cleans up unused fragments */
2083         sgen_nursery_allocator_prepare_for_pinning ();
2084
2085         hole_start = start = cur = sgen_get_nursery_start ();
2086         end = sgen_get_nursery_end ();
2087
2088         while (cur < end) {
2089                 size_t ss, size;
2090
2091                 if (!*(void**)cur) {
2092                         cur += sizeof (void*);
2093                         continue;
2094                 }
2095
2096                 if (object_is_forwarded (cur))
2097                         SGEN_LOG (1, "FORWARDED OBJ %p", cur);
2098                 else if (object_is_pinned (cur))
2099                         SGEN_LOG (1, "PINNED OBJ %p", cur);
2100
2101                 ss = safe_object_get_size ((MonoObject*)cur);
2102                 size = ALIGN_UP (safe_object_get_size ((MonoObject*)cur));
2103                 verify_scan_starts (cur, cur + size);
2104                 if (do_dump_nursery_content) {
2105                         if (cur > hole_start)
2106                                 SGEN_LOG (1, "HOLE [%p %p %d]", hole_start, cur, (int)(cur - hole_start));
2107                         SGEN_LOG (1, "OBJ  [%p %p %d %d %s %d]", cur, cur + size, (int)size, (int)ss, sgen_safe_name ((MonoObject*)cur), (gpointer)LOAD_VTABLE (cur) == sgen_get_array_fill_vtable ());
2108                 }
2109                 if (nursery_canaries_enabled () && (MonoVTable*)SGEN_LOAD_VTABLE (cur) != array_fill_vtable) {
2110                         CHECK_CANARY_FOR_OBJECT (cur);
2111                         CANARIFY_SIZE (size);
2112                 }
2113                 cur += size;
2114                 hole_start = cur;
2115         }
2116 }
2117
2118 /*
2119  * Checks that no objects in the nursery are fowarded or pinned.  This
2120  * is a precondition to restarting the mutator while doing a
2121  * concurrent collection.  Note that we don't clear fragments because
2122  * we depend on that having happened earlier.
2123  */
2124 static void
2125 check_nursery_is_clean (void)
2126 {
2127         char *end, *cur;
2128
2129         cur = sgen_get_nursery_start ();
2130         end = sgen_get_nursery_end ();
2131
2132         while (cur < end) {
2133                 size_t size;
2134
2135                 if (!*(void**)cur) {
2136                         cur += sizeof (void*);
2137                         continue;
2138                 }
2139
2140                 g_assert (!object_is_forwarded (cur));
2141                 g_assert (!object_is_pinned (cur));
2142
2143                 size = ALIGN_UP (safe_object_get_size ((MonoObject*)cur));
2144                 verify_scan_starts (cur, cur + size);
2145
2146                 cur += size;
2147         }
2148 }
2149
2150 static void
2151 init_gray_queue (void)
2152 {
2153         if (sgen_collection_is_concurrent ())
2154                 sgen_workers_init_distribute_gray_queue ();
2155         sgen_gray_object_queue_init (&gray_queue, NULL);
2156 }
2157
2158 /*
2159  * Perform a nursery collection.
2160  *
2161  * Return whether any objects were late-pinned due to being out of memory.
2162  */
2163 static gboolean
2164 collect_nursery (SgenGrayQueue *unpin_queue, gboolean finish_up_concurrent_mark)
2165 {
2166         gboolean needs_major;
2167         size_t max_garbage_amount;
2168         char *nursery_next;
2169         ScanFromRegisteredRootsJobData *scrrjd_normal, *scrrjd_wbarrier;
2170         ScanThreadDataJobData *stdjd;
2171         mword fragment_total;
2172         ScanCopyContext ctx;
2173         TV_DECLARE (atv);
2174         TV_DECLARE (btv);
2175
2176         if (disable_minor_collections)
2177                 return TRUE;
2178
2179         TV_GETTIME (last_minor_collection_start_tv);
2180         atv = last_minor_collection_start_tv;
2181
2182         MONO_GC_BEGIN (GENERATION_NURSERY);
2183         binary_protocol_collection_begin (gc_stats.minor_gc_count, GENERATION_NURSERY);
2184
2185         verify_nursery ();
2186
2187 #ifndef DISABLE_PERFCOUNTERS
2188         mono_perfcounters->gc_collections0++;
2189 #endif
2190
2191         current_collection_generation = GENERATION_NURSERY;
2192         current_object_ops = sgen_minor_collector.serial_ops;
2193
2194         reset_pinned_from_failed_allocation ();
2195
2196         check_scan_starts ();
2197
2198         sgen_nursery_alloc_prepare_for_minor ();
2199
2200         degraded_mode = 0;
2201         objects_pinned = 0;
2202         nursery_next = sgen_nursery_alloc_get_upper_alloc_bound ();
2203         /* FIXME: optimize later to use the higher address where an object can be present */
2204         nursery_next = MAX (nursery_next, sgen_get_nursery_end ());
2205
2206         SGEN_LOG (1, "Start nursery collection %d %p-%p, size: %d", gc_stats.minor_gc_count, sgen_get_nursery_start (), nursery_next, (int)(nursery_next - sgen_get_nursery_start ()));
2207         max_garbage_amount = nursery_next - sgen_get_nursery_start ();
2208         g_assert (nursery_section->size >= max_garbage_amount);
2209
2210         /* world must be stopped already */
2211         TV_GETTIME (btv);
2212         time_minor_pre_collection_fragment_clear += TV_ELAPSED (atv, btv);
2213
2214         if (xdomain_checks) {
2215                 sgen_clear_nursery_fragments ();
2216                 sgen_check_for_xdomain_refs ();
2217         }
2218
2219         nursery_section->next_data = nursery_next;
2220
2221         major_collector.start_nursery_collection ();
2222
2223         sgen_memgov_minor_collection_start ();
2224
2225         init_gray_queue ();
2226
2227         gc_stats.minor_gc_count ++;
2228
2229         if (whole_heap_check_before_collection) {
2230                 sgen_clear_nursery_fragments ();
2231                 sgen_check_whole_heap (finish_up_concurrent_mark);
2232         }
2233         if (consistency_check_at_minor_collection)
2234                 sgen_check_consistency ();
2235
2236         MONO_GC_CHECKPOINT_1 (GENERATION_NURSERY);
2237
2238         sgen_process_fin_stage_entries ();
2239         sgen_process_dislink_stage_entries ();
2240
2241         MONO_GC_CHECKPOINT_2 (GENERATION_NURSERY);
2242
2243         /* pin from pinned handles */
2244         sgen_init_pinning ();
2245         mono_profiler_gc_event (MONO_GC_EVENT_MARK_START, 0);
2246         pin_from_roots (sgen_get_nursery_start (), nursery_next, WORKERS_DISTRIBUTE_GRAY_QUEUE);
2247         /* pin cemented objects */
2248         sgen_pin_cemented_objects ();
2249         /* identify pinned objects */
2250         sgen_optimize_pin_queue ();
2251         sgen_pinning_setup_section (nursery_section);
2252         ctx.scan_func = NULL;
2253         ctx.copy_func = NULL;
2254         ctx.queue = WORKERS_DISTRIBUTE_GRAY_QUEUE;
2255         pin_objects_in_nursery (ctx);
2256         sgen_pinning_trim_queue_to_section (nursery_section);
2257
2258         TV_GETTIME (atv);
2259         time_minor_pinning += TV_ELAPSED (btv, atv);
2260         SGEN_LOG (2, "Finding pinned pointers: %zd in %d usecs", sgen_get_pinned_count (), TV_ELAPSED (btv, atv));
2261         SGEN_LOG (4, "Start scan with %zd pinned objects", sgen_get_pinned_count ());
2262
2263         MONO_GC_CHECKPOINT_3 (GENERATION_NURSERY);
2264
2265         /*
2266          * FIXME: When we finish a concurrent collection we do a nursery collection first,
2267          * as part of which we scan the card table.  Then, later, we scan the mod union
2268          * cardtable.  We should only have to do one.
2269          */
2270         sgen_workers_enqueue_job ("scan remset", job_remembered_set_scan, NULL);
2271
2272         /* we don't have complete write barrier yet, so we scan all the old generation sections */
2273         TV_GETTIME (btv);
2274         time_minor_scan_remsets += TV_ELAPSED (atv, btv);
2275         SGEN_LOG (2, "Old generation scan: %d usecs", TV_ELAPSED (atv, btv));
2276
2277         MONO_GC_CHECKPOINT_4 (GENERATION_NURSERY);
2278
2279         /* FIXME: why is this here? */
2280         ctx.scan_func = current_object_ops.scan_object;
2281         ctx.copy_func = NULL;
2282         ctx.queue = &gray_queue;
2283         sgen_drain_gray_stack (-1, ctx);
2284
2285         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2286                 report_registered_roots ();
2287         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2288                 report_finalizer_roots ();
2289         TV_GETTIME (atv);
2290         time_minor_scan_pinned += TV_ELAPSED (btv, atv);
2291
2292         MONO_GC_CHECKPOINT_5 (GENERATION_NURSERY);
2293
2294         /* registered roots, this includes static fields */
2295         scrrjd_normal = sgen_alloc_internal_dynamic (sizeof (ScanFromRegisteredRootsJobData), INTERNAL_MEM_WORKER_JOB_DATA, TRUE);
2296         scrrjd_normal->copy_or_mark_func = current_object_ops.copy_or_mark_object;
2297         scrrjd_normal->scan_func = current_object_ops.scan_object;
2298         scrrjd_normal->heap_start = sgen_get_nursery_start ();
2299         scrrjd_normal->heap_end = nursery_next;
2300         scrrjd_normal->root_type = ROOT_TYPE_NORMAL;
2301         sgen_workers_enqueue_job ("scan from registered roots normal", job_scan_from_registered_roots, scrrjd_normal);
2302
2303         scrrjd_wbarrier = sgen_alloc_internal_dynamic (sizeof (ScanFromRegisteredRootsJobData), INTERNAL_MEM_WORKER_JOB_DATA, TRUE);
2304         scrrjd_wbarrier->copy_or_mark_func = current_object_ops.copy_or_mark_object;
2305         scrrjd_wbarrier->scan_func = current_object_ops.scan_object;
2306         scrrjd_wbarrier->heap_start = sgen_get_nursery_start ();
2307         scrrjd_wbarrier->heap_end = nursery_next;
2308         scrrjd_wbarrier->root_type = ROOT_TYPE_WBARRIER;
2309         sgen_workers_enqueue_job ("scan from registered roots wbarrier", job_scan_from_registered_roots, scrrjd_wbarrier);
2310
2311         TV_GETTIME (btv);
2312         time_minor_scan_registered_roots += TV_ELAPSED (atv, btv);
2313
2314         MONO_GC_CHECKPOINT_6 (GENERATION_NURSERY);
2315
2316         /* thread data */
2317         stdjd = sgen_alloc_internal_dynamic (sizeof (ScanThreadDataJobData), INTERNAL_MEM_WORKER_JOB_DATA, TRUE);
2318         stdjd->heap_start = sgen_get_nursery_start ();
2319         stdjd->heap_end = nursery_next;
2320         sgen_workers_enqueue_job ("scan thread data", job_scan_thread_data, stdjd);
2321
2322         TV_GETTIME (atv);
2323         time_minor_scan_thread_data += TV_ELAPSED (btv, atv);
2324         btv = atv;
2325
2326         MONO_GC_CHECKPOINT_7 (GENERATION_NURSERY);
2327
2328         g_assert (!sgen_collection_is_concurrent ());
2329
2330         /* Scan the list of objects ready for finalization. If */
2331         sgen_workers_enqueue_job ("scan finalizer entries", job_scan_finalizer_entries, fin_ready_list);
2332         sgen_workers_enqueue_job ("scan criticial finalizer entries", job_scan_finalizer_entries, critical_fin_list);
2333
2334         MONO_GC_CHECKPOINT_8 (GENERATION_NURSERY);
2335
2336         finish_gray_stack (GENERATION_NURSERY, &gray_queue);
2337         TV_GETTIME (atv);
2338         time_minor_finish_gray_stack += TV_ELAPSED (btv, atv);
2339         mono_profiler_gc_event (MONO_GC_EVENT_MARK_END, 0);
2340
2341         MONO_GC_CHECKPOINT_9 (GENERATION_NURSERY);
2342
2343         /*
2344          * The (single-threaded) finalization code might have done
2345          * some copying/marking so we can only reset the GC thread's
2346          * worker data here instead of earlier when we joined the
2347          * workers.
2348          */
2349         sgen_workers_reset_data ();
2350
2351         if (objects_pinned) {
2352                 sgen_optimize_pin_queue ();
2353                 sgen_pinning_setup_section (nursery_section);
2354         }
2355
2356         /* walk the pin_queue, build up the fragment list of free memory, unmark
2357          * pinned objects as we go, memzero() the empty fragments so they are ready for the
2358          * next allocations.
2359          */
2360         mono_profiler_gc_event (MONO_GC_EVENT_RECLAIM_START, 0);
2361         fragment_total = sgen_build_nursery_fragments (nursery_section, unpin_queue);
2362         if (!fragment_total)
2363                 degraded_mode = 1;
2364
2365         /* Clear TLABs for all threads */
2366         sgen_clear_tlabs ();
2367
2368         mono_profiler_gc_event (MONO_GC_EVENT_RECLAIM_END, 0);
2369         TV_GETTIME (btv);
2370         time_minor_fragment_creation += TV_ELAPSED (atv, btv);
2371         SGEN_LOG (2, "Fragment creation: %d usecs, %lu bytes available", TV_ELAPSED (atv, btv), (unsigned long)fragment_total);
2372
2373         if (consistency_check_at_minor_collection)
2374                 sgen_check_major_refs ();
2375
2376         major_collector.finish_nursery_collection ();
2377
2378         TV_GETTIME (last_minor_collection_end_tv);
2379         gc_stats.minor_gc_time += TV_ELAPSED (last_minor_collection_start_tv, last_minor_collection_end_tv);
2380
2381         if (heap_dump_file)
2382                 dump_heap ("minor", gc_stats.minor_gc_count - 1, NULL);
2383
2384         /* prepare the pin queue for the next collection */
2385         sgen_finish_pinning ();
2386         if (fin_ready_list || critical_fin_list) {
2387                 SGEN_LOG (4, "Finalizer-thread wakeup: ready %d", num_ready_finalizers);
2388                 mono_gc_finalize_notify ();
2389         }
2390         sgen_pin_stats_reset ();
2391         /* clear cemented hash */
2392         sgen_cement_clear_below_threshold ();
2393
2394         g_assert (sgen_gray_object_queue_is_empty (&gray_queue));
2395
2396         remset.finish_minor_collection ();
2397
2398         check_scan_starts ();
2399
2400         binary_protocol_flush_buffers (FALSE);
2401
2402         sgen_memgov_minor_collection_end ();
2403
2404         /*objects are late pinned because of lack of memory, so a major is a good call*/
2405         needs_major = objects_pinned > 0;
2406         current_collection_generation = -1;
2407         objects_pinned = 0;
2408
2409         MONO_GC_END (GENERATION_NURSERY);
2410         binary_protocol_collection_end (gc_stats.minor_gc_count - 1, GENERATION_NURSERY, 0, 0);
2411
2412         if (check_nursery_objects_pinned && !sgen_minor_collector.is_split)
2413                 sgen_check_nursery_objects_pinned (unpin_queue != NULL);
2414
2415         return needs_major;
2416 }
2417
2418 static void
2419 scan_nursery_objects_callback (char *obj, size_t size, ScanCopyContext *ctx)
2420 {
2421         /*
2422          * This is called on all objects in the nursery, including pinned ones, so we need
2423          * to use sgen_obj_get_descriptor_safe(), which masks out the vtable tag bits.
2424          */
2425         ctx->scan_func (obj, sgen_obj_get_descriptor_safe (obj), ctx->queue);
2426 }
2427
2428 static void
2429 scan_nursery_objects (ScanCopyContext ctx)
2430 {
2431         sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
2432                         (IterateObjectCallbackFunc)scan_nursery_objects_callback, (void*)&ctx, FALSE);
2433 }
2434
2435 static void
2436 major_copy_or_mark_from_roots (size_t *old_next_pin_slot, gboolean start_concurrent_mark, gboolean finish_up_concurrent_mark, gboolean scan_mod_union, gboolean scan_whole_nursery)
2437 {
2438         LOSObject *bigobj;
2439         TV_DECLARE (atv);
2440         TV_DECLARE (btv);
2441         /* FIXME: only use these values for the precise scan
2442          * note that to_space pointers should be excluded anyway...
2443          */
2444         char *heap_start = NULL;
2445         char *heap_end = (char*)-1;
2446         gboolean profile_roots = mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS;
2447         GCRootReport root_report = { 0 };
2448         ScanFromRegisteredRootsJobData *scrrjd_normal, *scrrjd_wbarrier;
2449         ScanThreadDataJobData *stdjd;
2450         ScanCopyContext ctx;
2451
2452         if (concurrent_collection_in_progress) {
2453                 /*This cleans up unused fragments */
2454                 sgen_nursery_allocator_prepare_for_pinning ();
2455
2456                 if (do_concurrent_checks)
2457                         check_nursery_is_clean ();
2458         } else {
2459                 /* The concurrent collector doesn't touch the nursery. */
2460                 sgen_nursery_alloc_prepare_for_major ();
2461         }
2462
2463         init_gray_queue ();
2464
2465         TV_GETTIME (atv);
2466
2467         /* Pinning depends on this */
2468         sgen_clear_nursery_fragments ();
2469
2470         if (whole_heap_check_before_collection)
2471                 sgen_check_whole_heap (finish_up_concurrent_mark);
2472
2473         TV_GETTIME (btv);
2474         time_major_pre_collection_fragment_clear += TV_ELAPSED (atv, btv);
2475
2476         if (!sgen_collection_is_concurrent ())
2477                 nursery_section->next_data = sgen_get_nursery_end ();
2478         /* we should also coalesce scanning from sections close to each other
2479          * and deal with pointers outside of the sections later.
2480          */
2481
2482         objects_pinned = 0;
2483
2484         if (xdomain_checks) {
2485                 sgen_clear_nursery_fragments ();
2486                 sgen_check_for_xdomain_refs ();
2487         }
2488
2489         if (!concurrent_collection_in_progress) {
2490                 /* Remsets are not useful for a major collection */
2491                 remset.clear_cards ();
2492         }
2493
2494         sgen_process_fin_stage_entries ();
2495         sgen_process_dislink_stage_entries ();
2496
2497         TV_GETTIME (atv);
2498         sgen_init_pinning ();
2499         SGEN_LOG (6, "Collecting pinned addresses");
2500         pin_from_roots ((void*)lowest_heap_address, (void*)highest_heap_address, WORKERS_DISTRIBUTE_GRAY_QUEUE);
2501
2502         if (!concurrent_collection_in_progress || finish_up_concurrent_mark) {
2503                 if (major_collector.is_concurrent) {
2504                         /*
2505                          * The concurrent major collector cannot evict
2506                          * yet, so we need to pin cemented objects to
2507                          * not break some asserts.
2508                          *
2509                          * FIXME: We could evict now!
2510                          */
2511                         sgen_pin_cemented_objects ();
2512                 }
2513         }
2514
2515         sgen_optimize_pin_queue ();
2516
2517         /*
2518          * pin_queue now contains all candidate pointers, sorted and
2519          * uniqued.  We must do two passes now to figure out which
2520          * objects are pinned.
2521          *
2522          * The first is to find within the pin_queue the area for each
2523          * section.  This requires that the pin_queue be sorted.  We
2524          * also process the LOS objects and pinned chunks here.
2525          *
2526          * The second, destructive, pass is to reduce the section
2527          * areas to pointers to the actually pinned objects.
2528          */
2529         SGEN_LOG (6, "Pinning from sections");
2530         /* first pass for the sections */
2531         sgen_find_section_pin_queue_start_end (nursery_section);
2532         /* identify possible pointers to the insize of large objects */
2533         SGEN_LOG (6, "Pinning from large objects");
2534         for (bigobj = los_object_list; bigobj; bigobj = bigobj->next) {
2535                 size_t dummy;
2536                 if (sgen_find_optimized_pin_queue_area (bigobj->data, (char*)bigobj->data + sgen_los_object_size (bigobj), &dummy, &dummy)) {
2537                         binary_protocol_pin (bigobj->data, (gpointer)LOAD_VTABLE (bigobj->data), safe_object_get_size (((MonoObject*)(bigobj->data))));
2538
2539 #ifdef ENABLE_DTRACE
2540                         if (G_UNLIKELY (MONO_GC_OBJ_PINNED_ENABLED ())) {
2541                                 MonoVTable *vt = (MonoVTable*)LOAD_VTABLE (bigobj->data);
2542                                 MONO_GC_OBJ_PINNED ((mword)bigobj->data, sgen_safe_object_get_size ((MonoObject*)bigobj->data), vt->klass->name_space, vt->klass->name, GENERATION_OLD);
2543                         }
2544 #endif
2545
2546                         if (sgen_los_object_is_pinned (bigobj->data)) {
2547                                 g_assert (finish_up_concurrent_mark);
2548                                 continue;
2549                         }
2550                         sgen_los_pin_object (bigobj->data);
2551                         if (SGEN_OBJECT_HAS_REFERENCES (bigobj->data))
2552                                 GRAY_OBJECT_ENQUEUE (WORKERS_DISTRIBUTE_GRAY_QUEUE, bigobj->data, sgen_obj_get_descriptor (bigobj->data));
2553                         if (G_UNLIKELY (do_pin_stats))
2554                                 sgen_pin_stats_register_object ((char*) bigobj->data, safe_object_get_size ((MonoObject*) bigobj->data));
2555                         SGEN_LOG (6, "Marked large object %p (%s) size: %lu from roots", bigobj->data, safe_name (bigobj->data), (unsigned long)sgen_los_object_size (bigobj));
2556
2557                         if (profile_roots)
2558                                 add_profile_gc_root (&root_report, bigobj->data, MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
2559                 }
2560         }
2561         if (profile_roots)
2562                 notify_gc_roots (&root_report);
2563         /* second pass for the sections */
2564         ctx.scan_func = concurrent_collection_in_progress ? current_object_ops.scan_object : NULL;
2565         ctx.copy_func = NULL;
2566         ctx.queue = WORKERS_DISTRIBUTE_GRAY_QUEUE;
2567
2568         /*
2569          * Concurrent mark never follows references into the nursery.  In the start and
2570          * finish pauses we must scan live nursery objects, though.
2571          *
2572          * In the finish pause we do this conservatively by scanning all nursery objects.
2573          * Previously we would only scan pinned objects here.  We assumed that all objects
2574          * that were pinned during the nursery collection immediately preceding this finish
2575          * mark would be pinned again here.  Due to the way we get the stack end for the GC
2576          * thread, however, that's not necessarily the case: we scan part of the stack used
2577          * by the GC itself, which changes constantly, so pinning isn't entirely
2578          * deterministic.
2579          *
2580          * The split nursery also complicates things because non-pinned objects can survive
2581          * in the nursery.  That's why we need to do a full scan of the nursery for it, too.
2582          *
2583          * In the future we shouldn't do a preceding nursery collection at all and instead
2584          * do the finish pause with promotion from the nursery.
2585          *
2586          * A further complication arises when we have late-pinned objects from the preceding
2587          * nursery collection.  Those are the result of being out of memory when trying to
2588          * evacuate objects.  They won't be found from the roots, so we just scan the whole
2589          * nursery.
2590          *
2591          * Non-concurrent mark evacuates from the nursery, so it's
2592          * sufficient to just scan pinned nursery objects.
2593          */
2594         if (scan_whole_nursery || finish_up_concurrent_mark || (concurrent_collection_in_progress && sgen_minor_collector.is_split)) {
2595                 scan_nursery_objects (ctx);
2596         } else {
2597                 pin_objects_in_nursery (ctx);
2598                 if (check_nursery_objects_pinned && !sgen_minor_collector.is_split)
2599                         sgen_check_nursery_objects_pinned (!concurrent_collection_in_progress || finish_up_concurrent_mark);
2600         }
2601
2602         major_collector.pin_objects (WORKERS_DISTRIBUTE_GRAY_QUEUE);
2603         if (old_next_pin_slot)
2604                 *old_next_pin_slot = sgen_get_pinned_count ();
2605
2606         TV_GETTIME (btv);
2607         time_major_pinning += TV_ELAPSED (atv, btv);
2608         SGEN_LOG (2, "Finding pinned pointers: %zd in %d usecs", sgen_get_pinned_count (), TV_ELAPSED (atv, btv));
2609         SGEN_LOG (4, "Start scan with %zd pinned objects", sgen_get_pinned_count ());
2610
2611         major_collector.init_to_space ();
2612
2613         /*
2614          * The concurrent collector doesn't move objects, neither on
2615          * the major heap nor in the nursery, so we can mark even
2616          * before pinning has finished.  For the non-concurrent
2617          * collector we start the workers after pinning.
2618          */
2619         if (start_concurrent_mark) {
2620                 sgen_workers_start_all_workers ();
2621                 gray_queue_enable_redirect (WORKERS_DISTRIBUTE_GRAY_QUEUE);
2622         }
2623
2624 #ifdef SGEN_DEBUG_INTERNAL_ALLOC
2625         main_gc_thread = mono_native_thread_self ();
2626 #endif
2627
2628         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2629                 report_registered_roots ();
2630         TV_GETTIME (atv);
2631         time_major_scan_pinned += TV_ELAPSED (btv, atv);
2632
2633         /* registered roots, this includes static fields */
2634         scrrjd_normal = sgen_alloc_internal_dynamic (sizeof (ScanFromRegisteredRootsJobData), INTERNAL_MEM_WORKER_JOB_DATA, TRUE);
2635         scrrjd_normal->copy_or_mark_func = current_object_ops.copy_or_mark_object;
2636         scrrjd_normal->scan_func = current_object_ops.scan_object;
2637         scrrjd_normal->heap_start = heap_start;
2638         scrrjd_normal->heap_end = heap_end;
2639         scrrjd_normal->root_type = ROOT_TYPE_NORMAL;
2640         sgen_workers_enqueue_job ("scan from registered roots normal", job_scan_from_registered_roots, scrrjd_normal);
2641
2642         scrrjd_wbarrier = sgen_alloc_internal_dynamic (sizeof (ScanFromRegisteredRootsJobData), INTERNAL_MEM_WORKER_JOB_DATA, TRUE);
2643         scrrjd_wbarrier->copy_or_mark_func = current_object_ops.copy_or_mark_object;
2644         scrrjd_wbarrier->scan_func = current_object_ops.scan_object;
2645         scrrjd_wbarrier->heap_start = heap_start;
2646         scrrjd_wbarrier->heap_end = heap_end;
2647         scrrjd_wbarrier->root_type = ROOT_TYPE_WBARRIER;
2648         sgen_workers_enqueue_job ("scan from registered roots wbarrier", job_scan_from_registered_roots, scrrjd_wbarrier);
2649
2650         TV_GETTIME (btv);
2651         time_major_scan_registered_roots += TV_ELAPSED (atv, btv);
2652
2653         /* Threads */
2654         stdjd = sgen_alloc_internal_dynamic (sizeof (ScanThreadDataJobData), INTERNAL_MEM_WORKER_JOB_DATA, TRUE);
2655         stdjd->heap_start = heap_start;
2656         stdjd->heap_end = heap_end;
2657         sgen_workers_enqueue_job ("scan thread data", job_scan_thread_data, stdjd);
2658
2659         TV_GETTIME (atv);
2660         time_major_scan_thread_data += TV_ELAPSED (btv, atv);
2661
2662         TV_GETTIME (btv);
2663         time_major_scan_alloc_pinned += TV_ELAPSED (atv, btv);
2664
2665         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2666                 report_finalizer_roots ();
2667
2668         /* scan the list of objects ready for finalization */
2669         sgen_workers_enqueue_job ("scan finalizer entries", job_scan_finalizer_entries, fin_ready_list);
2670         sgen_workers_enqueue_job ("scan critical finalizer entries", job_scan_finalizer_entries, critical_fin_list);
2671
2672         if (scan_mod_union) {
2673                 g_assert (finish_up_concurrent_mark);
2674
2675                 /* Mod union card table */
2676                 sgen_workers_enqueue_job ("scan mod union cardtable", job_scan_major_mod_union_cardtable, NULL);
2677                 sgen_workers_enqueue_job ("scan LOS mod union cardtable", job_scan_los_mod_union_cardtable, NULL);
2678         }
2679
2680         TV_GETTIME (atv);
2681         time_major_scan_finalized += TV_ELAPSED (btv, atv);
2682         SGEN_LOG (2, "Root scan: %d usecs", TV_ELAPSED (btv, atv));
2683
2684         TV_GETTIME (btv);
2685         time_major_scan_big_objects += TV_ELAPSED (atv, btv);
2686 }
2687
2688 static void
2689 major_finish_copy_or_mark (void)
2690 {
2691         if (!concurrent_collection_in_progress)
2692                 return;
2693
2694         /*
2695          * Prepare the pin queue for the next collection.  Since pinning runs on the worker
2696          * threads we must wait for the jobs to finish before we can reset it.
2697          */
2698         sgen_workers_wait_for_jobs_finished ();
2699         sgen_finish_pinning ();
2700
2701         sgen_pin_stats_reset ();
2702
2703         if (do_concurrent_checks)
2704                 check_nursery_is_clean ();
2705 }
2706
2707 static void
2708 major_start_collection (gboolean concurrent, size_t *old_next_pin_slot)
2709 {
2710         MONO_GC_BEGIN (GENERATION_OLD);
2711         binary_protocol_collection_begin (gc_stats.major_gc_count, GENERATION_OLD);
2712
2713         current_collection_generation = GENERATION_OLD;
2714 #ifndef DISABLE_PERFCOUNTERS
2715         mono_perfcounters->gc_collections1++;
2716 #endif
2717
2718         g_assert (sgen_section_gray_queue_is_empty (sgen_workers_get_distribute_section_gray_queue ()));
2719
2720         sgen_cement_reset ();
2721
2722         if (concurrent) {
2723                 g_assert (major_collector.is_concurrent);
2724                 concurrent_collection_in_progress = TRUE;
2725
2726                 current_object_ops = major_collector.major_concurrent_ops;
2727         } else {
2728                 current_object_ops = major_collector.major_ops;
2729         }
2730
2731         reset_pinned_from_failed_allocation ();
2732
2733         sgen_memgov_major_collection_start ();
2734
2735         //count_ref_nonref_objs ();
2736         //consistency_check ();
2737
2738         check_scan_starts ();
2739
2740         degraded_mode = 0;
2741         SGEN_LOG (1, "Start major collection %d", gc_stats.major_gc_count);
2742         gc_stats.major_gc_count ++;
2743
2744         if (major_collector.start_major_collection)
2745                 major_collector.start_major_collection ();
2746
2747         major_copy_or_mark_from_roots (old_next_pin_slot, concurrent, FALSE, FALSE, FALSE);
2748         major_finish_copy_or_mark ();
2749 }
2750
2751 static void
2752 wait_for_workers_to_finish (void)
2753 {
2754         while (!sgen_workers_all_done ())
2755                 g_usleep (200);
2756 }
2757
2758 static void
2759 major_finish_collection (const char *reason, size_t old_next_pin_slot, gboolean scan_whole_nursery)
2760 {
2761         ScannedObjectCounts counts;
2762         LOSObject *bigobj, *prevbo;
2763         TV_DECLARE (atv);
2764         TV_DECLARE (btv);
2765
2766         TV_GETTIME (btv);
2767
2768         if (concurrent_collection_in_progress) {
2769                 sgen_workers_signal_start_nursery_collection_and_wait ();
2770
2771                 current_object_ops = major_collector.major_concurrent_ops;
2772
2773                 major_copy_or_mark_from_roots (NULL, FALSE, TRUE, TRUE, scan_whole_nursery);
2774
2775                 sgen_workers_signal_finish_nursery_collection ();
2776
2777                 major_finish_copy_or_mark ();
2778                 gray_queue_enable_redirect (WORKERS_DISTRIBUTE_GRAY_QUEUE);
2779
2780                 sgen_workers_join ();
2781
2782                 SGEN_ASSERT (0, sgen_gray_object_queue_is_empty (&gray_queue), "Why is the gray queue not empty after workers have finished working?");
2783
2784 #ifdef SGEN_DEBUG_INTERNAL_ALLOC
2785                 main_gc_thread = NULL;
2786 #endif
2787
2788                 if (do_concurrent_checks)
2789                         check_nursery_is_clean ();
2790         } else {
2791                 SGEN_ASSERT (0, !scan_whole_nursery, "scan_whole_nursery only applies to concurrent collections");
2792                 current_object_ops = major_collector.major_ops;
2793         }
2794
2795         /*
2796          * The workers have stopped so we need to finish gray queue
2797          * work that might result from finalization in the main GC
2798          * thread.  Redirection must therefore be turned off.
2799          */
2800         sgen_gray_object_queue_disable_alloc_prepare (&gray_queue);
2801         g_assert (sgen_section_gray_queue_is_empty (sgen_workers_get_distribute_section_gray_queue ()));
2802
2803         /* all the objects in the heap */
2804         finish_gray_stack (GENERATION_OLD, &gray_queue);
2805         TV_GETTIME (atv);
2806         time_major_finish_gray_stack += TV_ELAPSED (btv, atv);
2807
2808         SGEN_ASSERT (0, sgen_workers_all_done (), "Can't have workers working after joining");
2809
2810         /*
2811          * The (single-threaded) finalization code might have done
2812          * some copying/marking so we can only reset the GC thread's
2813          * worker data here instead of earlier when we joined the
2814          * workers.
2815          */
2816         sgen_workers_reset_data ();
2817
2818         if (objects_pinned) {
2819                 g_assert (!concurrent_collection_in_progress);
2820
2821                 /*
2822                  * This is slow, but we just OOM'd.
2823                  *
2824                  * See comment at `sgen_pin_queue_clear_discarded_entries` for how the pin
2825                  * queue is laid out at this point.
2826                  */
2827                 sgen_pin_queue_clear_discarded_entries (nursery_section, old_next_pin_slot);
2828                 /*
2829                  * We need to reestablish all pinned nursery objects in the pin queue
2830                  * because they're needed for fragment creation.  Unpinning happens by
2831                  * walking the whole queue, so it's not necessary to reestablish where major
2832                  * heap block pins are - all we care is that they're still in there
2833                  * somewhere.
2834                  */
2835                 sgen_optimize_pin_queue ();
2836                 sgen_find_section_pin_queue_start_end (nursery_section);
2837                 objects_pinned = 0;
2838         }
2839
2840         reset_heap_boundaries ();
2841         sgen_update_heap_boundaries ((mword)sgen_get_nursery_start (), (mword)sgen_get_nursery_end ());
2842
2843         if (!concurrent_collection_in_progress) {
2844                 /* walk the pin_queue, build up the fragment list of free memory, unmark
2845                  * pinned objects as we go, memzero() the empty fragments so they are ready for the
2846                  * next allocations.
2847                  */
2848                 if (!sgen_build_nursery_fragments (nursery_section, NULL))
2849                         degraded_mode = 1;
2850
2851                 /* prepare the pin queue for the next collection */
2852                 sgen_finish_pinning ();
2853
2854                 /* Clear TLABs for all threads */
2855                 sgen_clear_tlabs ();
2856
2857                 sgen_pin_stats_reset ();
2858         }
2859
2860         sgen_cement_clear_below_threshold ();
2861
2862         if (check_mark_bits_after_major_collection)
2863                 sgen_check_heap_marked (concurrent_collection_in_progress);
2864
2865         TV_GETTIME (btv);
2866         time_major_fragment_creation += TV_ELAPSED (atv, btv);
2867
2868
2869         MONO_GC_SWEEP_BEGIN (GENERATION_OLD, !major_collector.sweeps_lazily);
2870
2871         /* sweep the big objects list */
2872         prevbo = NULL;
2873         for (bigobj = los_object_list; bigobj;) {
2874                 g_assert (!object_is_pinned (bigobj->data));
2875                 if (sgen_los_object_is_pinned (bigobj->data)) {
2876                         sgen_los_unpin_object (bigobj->data);
2877                         sgen_update_heap_boundaries ((mword)bigobj->data, (mword)bigobj->data + sgen_los_object_size (bigobj));
2878                 } else {
2879                         LOSObject *to_free;
2880                         /* not referenced anywhere, so we can free it */
2881                         if (prevbo)
2882                                 prevbo->next = bigobj->next;
2883                         else
2884                                 los_object_list = bigobj->next;
2885                         to_free = bigobj;
2886                         bigobj = bigobj->next;
2887                         sgen_los_free_object (to_free);
2888                         continue;
2889                 }
2890                 prevbo = bigobj;
2891                 bigobj = bigobj->next;
2892         }
2893
2894         TV_GETTIME (atv);
2895         time_major_free_bigobjs += TV_ELAPSED (btv, atv);
2896
2897         sgen_los_sweep ();
2898
2899         TV_GETTIME (btv);
2900         time_major_los_sweep += TV_ELAPSED (atv, btv);
2901
2902         major_collector.sweep ();
2903
2904         MONO_GC_SWEEP_END (GENERATION_OLD, !major_collector.sweeps_lazily);
2905
2906         TV_GETTIME (atv);
2907         time_major_sweep += TV_ELAPSED (btv, atv);
2908
2909         if (heap_dump_file)
2910                 dump_heap ("major", gc_stats.major_gc_count - 1, reason);
2911
2912         if (fin_ready_list || critical_fin_list) {
2913                 SGEN_LOG (4, "Finalizer-thread wakeup: ready %d", num_ready_finalizers);
2914                 mono_gc_finalize_notify ();
2915         }
2916
2917         g_assert (sgen_gray_object_queue_is_empty (&gray_queue));
2918
2919         sgen_memgov_major_collection_end ();
2920         current_collection_generation = -1;
2921
2922         memset (&counts, 0, sizeof (ScannedObjectCounts));
2923         major_collector.finish_major_collection (&counts);
2924
2925         g_assert (sgen_section_gray_queue_is_empty (sgen_workers_get_distribute_section_gray_queue ()));
2926
2927         SGEN_ASSERT (0, sgen_workers_all_done (), "Can't have workers working after major collection has finished");
2928         if (concurrent_collection_in_progress)
2929                 concurrent_collection_in_progress = FALSE;
2930
2931         check_scan_starts ();
2932
2933         binary_protocol_flush_buffers (FALSE);
2934
2935         //consistency_check ();
2936
2937         MONO_GC_END (GENERATION_OLD);
2938         binary_protocol_collection_end (gc_stats.major_gc_count - 1, GENERATION_OLD, counts.num_scanned_objects, counts.num_unique_scanned_objects);
2939 }
2940
2941 static gboolean
2942 major_do_collection (const char *reason)
2943 {
2944         TV_DECLARE (time_start);
2945         TV_DECLARE (time_end);
2946         size_t old_next_pin_slot;
2947
2948         if (disable_major_collections)
2949                 return FALSE;
2950
2951         if (major_collector.get_and_reset_num_major_objects_marked) {
2952                 long long num_marked = major_collector.get_and_reset_num_major_objects_marked ();
2953                 g_assert (!num_marked);
2954         }
2955
2956         /* world must be stopped already */
2957         TV_GETTIME (time_start);
2958
2959         major_start_collection (FALSE, &old_next_pin_slot);
2960         major_finish_collection (reason, old_next_pin_slot, FALSE);
2961
2962         TV_GETTIME (time_end);
2963         gc_stats.major_gc_time += TV_ELAPSED (time_start, time_end);
2964
2965         /* FIXME: also report this to the user, preferably in gc-end. */
2966         if (major_collector.get_and_reset_num_major_objects_marked)
2967                 major_collector.get_and_reset_num_major_objects_marked ();
2968
2969         return bytes_pinned_from_failed_allocation > 0;
2970 }
2971
2972 static void
2973 major_start_concurrent_collection (const char *reason)
2974 {
2975         TV_DECLARE (time_start);
2976         TV_DECLARE (time_end);
2977         long long num_objects_marked;
2978
2979         if (disable_major_collections)
2980                 return;
2981
2982         TV_GETTIME (time_start);
2983         SGEN_TV_GETTIME (time_major_conc_collection_start);
2984
2985         num_objects_marked = major_collector.get_and_reset_num_major_objects_marked ();
2986         g_assert (num_objects_marked == 0);
2987
2988         MONO_GC_CONCURRENT_START_BEGIN (GENERATION_OLD);
2989         binary_protocol_concurrent_start ();
2990
2991         // FIXME: store reason and pass it when finishing
2992         major_start_collection (TRUE, NULL);
2993
2994         gray_queue_redirect (&gray_queue);
2995
2996         num_objects_marked = major_collector.get_and_reset_num_major_objects_marked ();
2997         MONO_GC_CONCURRENT_START_END (GENERATION_OLD, num_objects_marked);
2998
2999         TV_GETTIME (time_end);
3000         gc_stats.major_gc_time += TV_ELAPSED (time_start, time_end);
3001
3002         current_collection_generation = -1;
3003 }
3004
3005 /*
3006  * Returns whether the major collection has finished.
3007  */
3008 static gboolean
3009 major_should_finish_concurrent_collection (void)
3010 {
3011         SGEN_ASSERT (0, sgen_gray_object_queue_is_empty (&gray_queue), "Why is the gray queue not empty before we have started doing anything?");
3012         return sgen_workers_all_done ();
3013 }
3014
3015 static void
3016 major_update_concurrent_collection (void)
3017 {
3018         TV_DECLARE (total_start);
3019         TV_DECLARE (total_end);
3020
3021         TV_GETTIME (total_start);
3022
3023         MONO_GC_CONCURRENT_UPDATE_FINISH_BEGIN (GENERATION_OLD, major_collector.get_and_reset_num_major_objects_marked ());
3024         binary_protocol_concurrent_update ();
3025
3026         major_collector.update_cardtable_mod_union ();
3027         sgen_los_update_cardtable_mod_union ();
3028
3029         MONO_GC_CONCURRENT_UPDATE_END (GENERATION_OLD, major_collector.get_and_reset_num_major_objects_marked ());
3030
3031         TV_GETTIME (total_end);
3032         gc_stats.major_gc_time += TV_ELAPSED (total_start, total_end);
3033 }
3034
3035 static void
3036 major_finish_concurrent_collection (void)
3037 {
3038         TV_DECLARE (total_start);
3039         TV_DECLARE (total_end);
3040         gboolean late_pinned;
3041         SgenGrayQueue unpin_queue;
3042         memset (&unpin_queue, 0, sizeof (unpin_queue));
3043
3044         TV_GETTIME (total_start);
3045
3046         MONO_GC_CONCURRENT_UPDATE_FINISH_BEGIN (GENERATION_OLD, major_collector.get_and_reset_num_major_objects_marked ());
3047         binary_protocol_concurrent_finish ();
3048
3049         /*
3050          * The major collector can add global remsets which are processed in the finishing
3051          * nursery collection, below.  That implies that the workers must have finished
3052          * marking before the nursery collection is allowed to run, otherwise we might miss
3053          * some remsets.
3054          */
3055         wait_for_workers_to_finish ();
3056
3057         SGEN_TV_GETTIME (time_major_conc_collection_end);
3058         gc_stats.major_gc_time_concurrent += SGEN_TV_ELAPSED (time_major_conc_collection_start, time_major_conc_collection_end);
3059
3060         major_collector.update_cardtable_mod_union ();
3061         sgen_los_update_cardtable_mod_union ();
3062
3063         late_pinned = collect_nursery (&unpin_queue, TRUE);
3064
3065         if (mod_union_consistency_check)
3066                 sgen_check_mod_union_consistency ();
3067
3068         current_collection_generation = GENERATION_OLD;
3069         major_finish_collection ("finishing", -1, late_pinned);
3070
3071         if (whole_heap_check_before_collection)
3072                 sgen_check_whole_heap (FALSE);
3073
3074         unpin_objects_from_queue (&unpin_queue);
3075         sgen_gray_object_queue_deinit (&unpin_queue);
3076
3077         MONO_GC_CONCURRENT_FINISH_END (GENERATION_OLD, major_collector.get_and_reset_num_major_objects_marked ());
3078
3079         TV_GETTIME (total_end);
3080         gc_stats.major_gc_time += TV_ELAPSED (total_start, total_end) - TV_ELAPSED (last_minor_collection_start_tv, last_minor_collection_end_tv);
3081
3082         current_collection_generation = -1;
3083 }
3084
3085 /*
3086  * Ensure an allocation request for @size will succeed by freeing enough memory.
3087  *
3088  * LOCKING: The GC lock MUST be held.
3089  */
3090 void
3091 sgen_ensure_free_space (size_t size)
3092 {
3093         int generation_to_collect = -1;
3094         const char *reason = NULL;
3095
3096
3097         if (size > SGEN_MAX_SMALL_OBJ_SIZE) {
3098                 if (sgen_need_major_collection (size)) {
3099                         reason = "LOS overflow";
3100                         generation_to_collect = GENERATION_OLD;
3101                 }
3102         } else {
3103                 if (degraded_mode) {
3104                         if (sgen_need_major_collection (size)) {
3105                                 reason = "Degraded mode overflow";
3106                                 generation_to_collect = GENERATION_OLD;
3107                         }
3108                 } else if (sgen_need_major_collection (size)) {
3109                         reason = "Minor allowance";
3110                         generation_to_collect = GENERATION_OLD;
3111                 } else {
3112                         generation_to_collect = GENERATION_NURSERY;
3113                         reason = "Nursery full";
3114                 }
3115         }
3116
3117         if (generation_to_collect == -1) {
3118                 if (concurrent_collection_in_progress && sgen_workers_all_done ()) {
3119                         generation_to_collect = GENERATION_OLD;
3120                         reason = "Finish concurrent collection";
3121                 }
3122         }
3123
3124         if (generation_to_collect == -1)
3125                 return;
3126         sgen_perform_collection (size, generation_to_collect, reason, FALSE);
3127 }
3128
3129 /*
3130  * LOCKING: Assumes the GC lock is held.
3131  */
3132 void
3133 sgen_perform_collection (size_t requested_size, int generation_to_collect, const char *reason, gboolean wait_to_finish)
3134 {
3135         TV_DECLARE (gc_start);
3136         TV_DECLARE (gc_end);
3137         TV_DECLARE (gc_total_start);
3138         TV_DECLARE (gc_total_end);
3139         GGTimingInfo infos [2];
3140         int overflow_generation_to_collect = -1;
3141         int oldest_generation_collected = generation_to_collect;
3142         const char *overflow_reason = NULL;
3143
3144         MONO_GC_REQUESTED (generation_to_collect, requested_size, wait_to_finish ? 1 : 0);
3145         if (wait_to_finish)
3146                 binary_protocol_collection_force (generation_to_collect);
3147
3148         SGEN_ASSERT (0, generation_to_collect == GENERATION_NURSERY || generation_to_collect == GENERATION_OLD, "What generation is this?");
3149
3150         mono_profiler_gc_event (MONO_GC_EVENT_START, generation_to_collect);
3151
3152         TV_GETTIME (gc_start);
3153
3154         sgen_stop_world (generation_to_collect);
3155
3156         TV_GETTIME (gc_total_start);
3157
3158         if (concurrent_collection_in_progress) {
3159                 /*
3160                  * We update the concurrent collection.  If it finished, we're done.  If
3161                  * not, and we've been asked to do a nursery collection, we do that.
3162                  */
3163                 gboolean finish = major_should_finish_concurrent_collection () || (wait_to_finish && generation_to_collect == GENERATION_OLD);
3164
3165                 if (finish) {
3166                         major_finish_concurrent_collection ();
3167                         oldest_generation_collected = GENERATION_OLD;
3168                 } else {
3169                         sgen_workers_signal_start_nursery_collection_and_wait ();
3170
3171                         major_update_concurrent_collection ();
3172                         if (generation_to_collect == GENERATION_NURSERY)
3173                                 collect_nursery (NULL, FALSE);
3174
3175                         sgen_workers_signal_finish_nursery_collection ();
3176                 }
3177
3178                 goto done;
3179         }
3180
3181         /*
3182          * If we've been asked to do a major collection, and the major collector wants to
3183          * run synchronously (to evacuate), we set the flag to do that.
3184          */
3185         if (generation_to_collect == GENERATION_OLD &&
3186                         allow_synchronous_major &&
3187                         major_collector.want_synchronous_collection &&
3188                         *major_collector.want_synchronous_collection) {
3189                 wait_to_finish = TRUE;
3190         }
3191
3192         SGEN_ASSERT (0, !concurrent_collection_in_progress, "Why did this not get handled above?");
3193
3194         /*
3195          * There's no concurrent collection in progress.  Collect the generation we're asked
3196          * to collect.  If the major collector is concurrent and we're not forced to wait,
3197          * start a concurrent collection.
3198          */
3199         // FIXME: extract overflow reason
3200         if (generation_to_collect == GENERATION_NURSERY) {
3201                 if (collect_nursery (NULL, FALSE)) {
3202                         overflow_generation_to_collect = GENERATION_OLD;
3203                         overflow_reason = "Minor overflow";
3204                 }
3205         } else {
3206                 if (major_collector.is_concurrent && !wait_to_finish) {
3207                         collect_nursery (NULL, FALSE);
3208                         major_start_concurrent_collection (reason);
3209                         // FIXME: set infos[0] properly
3210                         goto done;
3211                 }
3212
3213                 if (major_do_collection (reason)) {
3214                         overflow_generation_to_collect = GENERATION_NURSERY;
3215                         overflow_reason = "Excessive pinning";
3216                 }
3217         }
3218
3219         TV_GETTIME (gc_end);
3220
3221         memset (infos, 0, sizeof (infos));
3222         infos [0].generation = generation_to_collect;
3223         infos [0].reason = reason;
3224         infos [0].is_overflow = FALSE;
3225         infos [1].generation = -1;
3226         infos [0].total_time = SGEN_TV_ELAPSED (gc_start, gc_end);
3227
3228         SGEN_ASSERT (0, !concurrent_collection_in_progress, "Why did this not get handled above?");
3229
3230         if (overflow_generation_to_collect != -1) {
3231                 /*
3232                  * We need to do an overflow collection, either because we ran out of memory
3233                  * or the nursery is fully pinned.
3234                  */
3235
3236                 mono_profiler_gc_event (MONO_GC_EVENT_START, overflow_generation_to_collect);
3237                 infos [1].generation = overflow_generation_to_collect;
3238                 infos [1].reason = overflow_reason;
3239                 infos [1].is_overflow = TRUE;
3240                 infos [1].total_time = gc_end;
3241
3242                 if (overflow_generation_to_collect == GENERATION_NURSERY)
3243                         collect_nursery (NULL, FALSE);
3244                 else
3245                         major_do_collection (overflow_reason);
3246
3247                 TV_GETTIME (gc_end);
3248                 infos [1].total_time = SGEN_TV_ELAPSED (infos [1].total_time, gc_end);
3249
3250                 /* keep events symmetric */
3251                 mono_profiler_gc_event (MONO_GC_EVENT_END, overflow_generation_to_collect);
3252
3253                 oldest_generation_collected = MAX (oldest_generation_collected, overflow_generation_to_collect);
3254         }
3255
3256         SGEN_LOG (2, "Heap size: %lu, LOS size: %lu", (unsigned long)mono_gc_get_heap_size (), (unsigned long)los_memory_usage);
3257
3258         /* this also sets the proper pointers for the next allocation */
3259         if (generation_to_collect == GENERATION_NURSERY && !sgen_can_alloc_size (requested_size)) {
3260                 /* TypeBuilder and MonoMethod are killing mcs with fragmentation */
3261                 SGEN_LOG (1, "nursery collection didn't find enough room for %zd alloc (%zd pinned)", requested_size, sgen_get_pinned_count ());
3262                 sgen_dump_pin_queue ();
3263                 degraded_mode = 1;
3264         }
3265
3266  done:
3267         g_assert (sgen_gray_object_queue_is_empty (&gray_queue));
3268
3269         TV_GETTIME (gc_total_end);
3270         time_max = MAX (time_max, TV_ELAPSED (gc_total_start, gc_total_end));
3271
3272         sgen_restart_world (oldest_generation_collected, infos);
3273
3274         mono_profiler_gc_event (MONO_GC_EVENT_END, generation_to_collect);
3275 }
3276
3277 /*
3278  * ######################################################################
3279  * ########  Memory allocation from the OS
3280  * ######################################################################
3281  * This section of code deals with getting memory from the OS and
3282  * allocating memory for GC-internal data structures.
3283  * Internal memory can be handled with a freelist for small objects.
3284  */
3285
3286 /*
3287  * Debug reporting.
3288  */
3289 G_GNUC_UNUSED static void
3290 report_internal_mem_usage (void)
3291 {
3292         printf ("Internal memory usage:\n");
3293         sgen_report_internal_mem_usage ();
3294         printf ("Pinned memory usage:\n");
3295         major_collector.report_pinned_memory_usage ();
3296 }
3297
3298 /*
3299  * ######################################################################
3300  * ########  Finalization support
3301  * ######################################################################
3302  */
3303
3304 static inline gboolean
3305 sgen_major_is_object_alive (void *object)
3306 {
3307         mword objsize;
3308
3309         /* Oldgen objects can be pinned and forwarded too */
3310         if (SGEN_OBJECT_IS_PINNED (object) || SGEN_OBJECT_IS_FORWARDED (object))
3311                 return TRUE;
3312
3313         /*
3314          * FIXME: major_collector.is_object_live() also calculates the
3315          * size.  Avoid the double calculation.
3316          */
3317         objsize = SGEN_ALIGN_UP (sgen_safe_object_get_size ((MonoObject*)object));
3318         if (objsize > SGEN_MAX_SMALL_OBJ_SIZE)
3319                 return sgen_los_object_is_pinned (object);
3320
3321         return major_collector.is_object_live (object);
3322 }
3323
3324 /*
3325  * If the object has been forwarded it means it's still referenced from a root.
3326  * If it is pinned it's still alive as well.
3327  * A LOS object is only alive if we have pinned it.
3328  * Return TRUE if @obj is ready to be finalized.
3329  */
3330 static inline gboolean
3331 sgen_is_object_alive (void *object)
3332 {
3333         if (ptr_in_nursery (object))
3334                 return sgen_nursery_is_object_alive (object);
3335
3336         return sgen_major_is_object_alive (object);
3337 }
3338
3339 /*
3340  * This function returns true if @object is either alive or it belongs to the old gen
3341  * and we're currently doing a minor collection.
3342  */
3343 static inline int
3344 sgen_is_object_alive_for_current_gen (char *object)
3345 {
3346         if (ptr_in_nursery (object))
3347                 return sgen_nursery_is_object_alive (object);
3348
3349         if (current_collection_generation == GENERATION_NURSERY)
3350                 return TRUE;
3351
3352         return sgen_major_is_object_alive (object);
3353 }
3354
3355 /*
3356  * This function returns true if @object is either alive and belongs to the
3357  * current collection - major collections are full heap, so old gen objects
3358  * are never alive during a minor collection.
3359  */
3360 static inline int
3361 sgen_is_object_alive_and_on_current_collection (char *object)
3362 {
3363         if (ptr_in_nursery (object))
3364                 return sgen_nursery_is_object_alive (object);
3365
3366         if (current_collection_generation == GENERATION_NURSERY)
3367                 return FALSE;
3368
3369         return sgen_major_is_object_alive (object);
3370 }
3371
3372
3373 gboolean
3374 sgen_gc_is_object_ready_for_finalization (void *object)
3375 {
3376         return !sgen_is_object_alive (object);
3377 }
3378
3379 static gboolean
3380 has_critical_finalizer (MonoObject *obj)
3381 {
3382         MonoClass *class;
3383
3384         if (!mono_defaults.critical_finalizer_object)
3385                 return FALSE;
3386
3387         class = ((MonoVTable*)LOAD_VTABLE (obj))->klass;
3388
3389         return mono_class_has_parent_fast (class, mono_defaults.critical_finalizer_object);
3390 }
3391
3392 static gboolean
3393 is_finalization_aware (MonoObject *obj)
3394 {
3395         MonoVTable *vt = ((MonoVTable*)LOAD_VTABLE (obj));
3396         return (vt->gc_bits & SGEN_GC_BIT_FINALIZER_AWARE) == SGEN_GC_BIT_FINALIZER_AWARE;
3397 }
3398
3399 void
3400 sgen_queue_finalization_entry (MonoObject *obj)
3401 {
3402         FinalizeReadyEntry *entry = sgen_alloc_internal (INTERNAL_MEM_FINALIZE_READY_ENTRY);
3403         gboolean critical = has_critical_finalizer (obj);
3404         entry->object = obj;
3405         if (critical) {
3406                 entry->next = critical_fin_list;
3407                 critical_fin_list = entry;
3408         } else {
3409                 entry->next = fin_ready_list;
3410                 fin_ready_list = entry;
3411         }
3412
3413         if (fin_callbacks.object_queued_for_finalization && is_finalization_aware (obj))
3414                 fin_callbacks.object_queued_for_finalization (obj);
3415
3416 #ifdef ENABLE_DTRACE
3417         if (G_UNLIKELY (MONO_GC_FINALIZE_ENQUEUE_ENABLED ())) {
3418                 int gen = sgen_ptr_in_nursery (obj) ? GENERATION_NURSERY : GENERATION_OLD;
3419                 MonoVTable *vt = (MonoVTable*)LOAD_VTABLE (obj);
3420                 MONO_GC_FINALIZE_ENQUEUE ((mword)obj, sgen_safe_object_get_size (obj),
3421                                 vt->klass->name_space, vt->klass->name, gen, critical);
3422         }
3423 #endif
3424 }
3425
3426 gboolean
3427 sgen_object_is_live (void *obj)
3428 {
3429         return sgen_is_object_alive_and_on_current_collection (obj);
3430 }
3431
3432 /* LOCKING: requires that the GC lock is held */
3433 static void
3434 null_ephemerons_for_domain (MonoDomain *domain)
3435 {
3436         EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
3437
3438         while (current) {
3439                 MonoObject *object = (MonoObject*)current->array;
3440
3441                 if (object)
3442                         SGEN_ASSERT (0, object->vtable, "Can't have objects without vtables.");
3443
3444                 if (object && object->vtable->domain == domain) {
3445                         EphemeronLinkNode *tmp = current;
3446
3447                         if (prev)
3448                                 prev->next = current->next;
3449                         else
3450                                 ephemeron_list = current->next;
3451
3452                         current = current->next;
3453                         sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
3454                 } else {
3455                         prev = current;
3456                         current = current->next;
3457                 }
3458         }
3459 }
3460
3461 /* LOCKING: requires that the GC lock is held */
3462 static void
3463 clear_unreachable_ephemerons (ScanCopyContext ctx)
3464 {
3465         CopyOrMarkObjectFunc copy_func = ctx.copy_func;
3466         GrayQueue *queue = ctx.queue;
3467         EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
3468         MonoArray *array;
3469         Ephemeron *cur, *array_end;
3470         char *tombstone;
3471
3472         while (current) {
3473                 char *object = current->array;
3474
3475                 if (!sgen_is_object_alive_for_current_gen (object)) {
3476                         EphemeronLinkNode *tmp = current;
3477
3478                         SGEN_LOG (5, "Dead Ephemeron array at %p", object);
3479
3480                         if (prev)
3481                                 prev->next = current->next;
3482                         else
3483                                 ephemeron_list = current->next;
3484
3485                         current = current->next;
3486                         sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
3487
3488                         continue;
3489                 }
3490
3491                 copy_func ((void**)&object, queue);
3492                 current->array = object;
3493
3494                 SGEN_LOG (5, "Clearing unreachable entries for ephemeron array at %p", object);
3495
3496                 array = (MonoArray*)object;
3497                 cur = mono_array_addr (array, Ephemeron, 0);
3498                 array_end = cur + mono_array_length_fast (array);
3499                 tombstone = (char*)((MonoVTable*)LOAD_VTABLE (object))->domain->ephemeron_tombstone;
3500
3501                 for (; cur < array_end; ++cur) {
3502                         char *key = (char*)cur->key;
3503
3504                         if (!key || key == tombstone)
3505                                 continue;
3506
3507                         SGEN_LOG (5, "[%td] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
3508                                 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
3509                                 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
3510
3511                         if (!sgen_is_object_alive_for_current_gen (key)) {
3512                                 cur->key = tombstone;
3513                                 cur->value = NULL;
3514                                 continue;
3515                         }
3516                 }
3517                 prev = current;
3518                 current = current->next;
3519         }
3520 }
3521
3522 /*
3523 LOCKING: requires that the GC lock is held
3524
3525 Limitations: We scan all ephemerons on every collection since the current design doesn't allow for a simple nursery/mature split.
3526 */
3527 static int
3528 mark_ephemerons_in_range (ScanCopyContext ctx)
3529 {
3530         CopyOrMarkObjectFunc copy_func = ctx.copy_func;
3531         GrayQueue *queue = ctx.queue;
3532         int nothing_marked = 1;
3533         EphemeronLinkNode *current = ephemeron_list;
3534         MonoArray *array;
3535         Ephemeron *cur, *array_end;
3536         char *tombstone;
3537
3538         for (current = ephemeron_list; current; current = current->next) {
3539                 char *object = current->array;
3540                 SGEN_LOG (5, "Ephemeron array at %p", object);
3541
3542                 /*It has to be alive*/
3543                 if (!sgen_is_object_alive_for_current_gen (object)) {
3544                         SGEN_LOG (5, "\tnot reachable");
3545                         continue;
3546                 }
3547
3548                 copy_func ((void**)&object, queue);
3549
3550                 array = (MonoArray*)object;
3551                 cur = mono_array_addr (array, Ephemeron, 0);
3552                 array_end = cur + mono_array_length_fast (array);
3553                 tombstone = (char*)((MonoVTable*)LOAD_VTABLE (object))->domain->ephemeron_tombstone;
3554
3555                 for (; cur < array_end; ++cur) {
3556                         char *key = cur->key;
3557
3558                         if (!key || key == tombstone)
3559                                 continue;
3560
3561                         SGEN_LOG (5, "[%td] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
3562                                 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
3563                                 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
3564
3565                         if (sgen_is_object_alive_for_current_gen (key)) {
3566                                 char *value = cur->value;
3567
3568                                 copy_func ((void**)&cur->key, queue);
3569                                 if (value) {
3570                                         if (!sgen_is_object_alive_for_current_gen (value))
3571                                                 nothing_marked = 0;
3572                                         copy_func ((void**)&cur->value, queue);
3573                                 }
3574                         }
3575                 }
3576         }
3577
3578         SGEN_LOG (5, "Ephemeron run finished. Is it done %d", nothing_marked);
3579         return nothing_marked;
3580 }
3581
3582 int
3583 mono_gc_invoke_finalizers (void)
3584 {
3585         FinalizeReadyEntry *entry = NULL;
3586         gboolean entry_is_critical = FALSE;
3587         int count = 0;
3588         void *obj;
3589         /* FIXME: batch to reduce lock contention */
3590         while (fin_ready_list || critical_fin_list) {
3591                 LOCK_GC;
3592
3593                 if (entry) {
3594                         FinalizeReadyEntry **list = entry_is_critical ? &critical_fin_list : &fin_ready_list;
3595
3596                         /* We have finalized entry in the last
3597                            interation, now we need to remove it from
3598                            the list. */
3599                         if (*list == entry)
3600                                 *list = entry->next;
3601                         else {
3602                                 FinalizeReadyEntry *e = *list;
3603                                 while (e->next != entry)
3604                                         e = e->next;
3605                                 e->next = entry->next;
3606                         }
3607                         sgen_free_internal (entry, INTERNAL_MEM_FINALIZE_READY_ENTRY);
3608                         entry = NULL;
3609                 }
3610
3611                 /* Now look for the first non-null entry. */
3612                 for (entry = fin_ready_list; entry && !entry->object; entry = entry->next)
3613                         ;
3614                 if (entry) {
3615                         entry_is_critical = FALSE;
3616                 } else {
3617                         entry_is_critical = TRUE;
3618                         for (entry = critical_fin_list; entry && !entry->object; entry = entry->next)
3619                                 ;
3620                 }
3621
3622                 if (entry) {
3623                         g_assert (entry->object);
3624                         num_ready_finalizers--;
3625                         obj = entry->object;
3626                         entry->object = NULL;
3627                         SGEN_LOG (7, "Finalizing object %p (%s)", obj, safe_name (obj));
3628                 }
3629
3630                 UNLOCK_GC;
3631
3632                 if (!entry)
3633                         break;
3634
3635                 g_assert (entry->object == NULL);
3636                 count++;
3637                 /* the object is on the stack so it is pinned */
3638                 /*g_print ("Calling finalizer for object: %p (%s)\n", entry->object, safe_name (entry->object));*/
3639                 mono_gc_run_finalize (obj, NULL);
3640         }
3641         g_assert (!entry);
3642         return count;
3643 }
3644
3645 gboolean
3646 mono_gc_pending_finalizers (void)
3647 {
3648         return fin_ready_list || critical_fin_list;
3649 }
3650
3651 /*
3652  * ######################################################################
3653  * ########  registered roots support
3654  * ######################################################################
3655  */
3656
3657 /*
3658  * We do not coalesce roots.
3659  */
3660 static int
3661 mono_gc_register_root_inner (char *start, size_t size, void *descr, int root_type)
3662 {
3663         RootRecord new_root;
3664         int i;
3665         LOCK_GC;
3666         for (i = 0; i < ROOT_TYPE_NUM; ++i) {
3667                 RootRecord *root = sgen_hash_table_lookup (&roots_hash [i], start);
3668                 /* we allow changing the size and the descriptor (for thread statics etc) */
3669                 if (root) {
3670                         size_t old_size = root->end_root - start;
3671                         root->end_root = start + size;
3672                         g_assert (((root->root_desc != 0) && (descr != NULL)) ||
3673                                           ((root->root_desc == 0) && (descr == NULL)));
3674                         root->root_desc = (mword)descr;
3675                         roots_size += size;
3676                         roots_size -= old_size;
3677                         UNLOCK_GC;
3678                         return TRUE;
3679                 }
3680         }
3681
3682         new_root.end_root = start + size;
3683         new_root.root_desc = (mword)descr;
3684
3685         sgen_hash_table_replace (&roots_hash [root_type], start, &new_root, NULL);
3686         roots_size += size;
3687
3688         SGEN_LOG (3, "Added root for range: %p-%p, descr: %p  (%d/%d bytes)", start, new_root.end_root, descr, (int)size, (int)roots_size);
3689
3690         UNLOCK_GC;
3691         return TRUE;
3692 }
3693
3694 int
3695 mono_gc_register_root (char *start, size_t size, void *descr)
3696 {
3697         return mono_gc_register_root_inner (start, size, descr, descr ? ROOT_TYPE_NORMAL : ROOT_TYPE_PINNED);
3698 }
3699
3700 int
3701 mono_gc_register_root_wbarrier (char *start, size_t size, void *descr)
3702 {
3703         return mono_gc_register_root_inner (start, size, descr, ROOT_TYPE_WBARRIER);
3704 }
3705
3706 void
3707 mono_gc_deregister_root (char* addr)
3708 {
3709         int root_type;
3710         RootRecord root;
3711
3712         LOCK_GC;
3713         for (root_type = 0; root_type < ROOT_TYPE_NUM; ++root_type) {
3714                 if (sgen_hash_table_remove (&roots_hash [root_type], addr, &root))
3715                         roots_size -= (root.end_root - addr);
3716         }
3717         UNLOCK_GC;
3718 }
3719
3720 /*
3721  * ######################################################################
3722  * ########  Thread handling (stop/start code)
3723  * ######################################################################
3724  */
3725
3726 unsigned int sgen_global_stop_count = 0;
3727
3728 int
3729 sgen_get_current_collection_generation (void)
3730 {
3731         return current_collection_generation;
3732 }
3733
3734 void
3735 mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks)
3736 {
3737         gc_callbacks = *callbacks;
3738 }
3739
3740 MonoGCCallbacks *
3741 mono_gc_get_gc_callbacks ()
3742 {
3743         return &gc_callbacks;
3744 }
3745
3746 /* Variables holding start/end nursery so it won't have to be passed at every call */
3747 static void *scan_area_arg_start, *scan_area_arg_end;
3748
3749 void
3750 mono_gc_conservatively_scan_area (void *start, void *end)
3751 {
3752         conservatively_pin_objects_from (start, end, scan_area_arg_start, scan_area_arg_end, PIN_TYPE_STACK);
3753 }
3754
3755 void*
3756 mono_gc_scan_object (void *obj, void *gc_data)
3757 {
3758         UserCopyOrMarkData *data = gc_data;
3759         current_object_ops.copy_or_mark_object (&obj, data->queue);
3760         return obj;
3761 }
3762
3763 /*
3764  * Mark from thread stacks and registers.
3765  */
3766 static void
3767 scan_thread_data (void *start_nursery, void *end_nursery, gboolean precise, GrayQueue *queue)
3768 {
3769         SgenThreadInfo *info;
3770
3771         scan_area_arg_start = start_nursery;
3772         scan_area_arg_end = end_nursery;
3773
3774         FOREACH_THREAD (info) {
3775                 if (info->skip) {
3776                         SGEN_LOG (3, "Skipping dead thread %p, range: %p-%p, size: %td", info, info->stack_start, info->stack_end, (char*)info->stack_end - (char*)info->stack_start);
3777                         continue;
3778                 }
3779                 if (info->gc_disabled) {
3780                         SGEN_LOG (3, "GC disabled for thread %p, range: %p-%p, size: %td", info, info->stack_start, info->stack_end, (char*)info->stack_end - (char*)info->stack_start);
3781                         continue;
3782                 }
3783                 if (!mono_thread_info_is_live (info)) {
3784                         SGEN_LOG (3, "Skipping non-running thread %p, range: %p-%p, size: %td (state %x)", info, info->stack_start, info->stack_end, (char*)info->stack_end - (char*)info->stack_start, info->info.thread_state);
3785                         continue;
3786                 }
3787                 g_assert (info->suspend_done);
3788                 SGEN_LOG (3, "Scanning thread %p, range: %p-%p, size: %td, pinned=%zd", info, info->stack_start, info->stack_end, (char*)info->stack_end - (char*)info->stack_start, sgen_get_pinned_count ());
3789                 if (gc_callbacks.thread_mark_func && !conservative_stack_mark) {
3790                         UserCopyOrMarkData data = { NULL, queue };
3791                         gc_callbacks.thread_mark_func (info->runtime_data, info->stack_start, info->stack_end, precise, &data);
3792                 } else if (!precise) {
3793                         if (!conservative_stack_mark) {
3794                                 fprintf (stderr, "Precise stack mark not supported - disabling.\n");
3795                                 conservative_stack_mark = TRUE;
3796                         }
3797                         conservatively_pin_objects_from (info->stack_start, info->stack_end, start_nursery, end_nursery, PIN_TYPE_STACK);
3798                 }
3799
3800                 if (!precise) {
3801 #ifdef USE_MONO_CTX
3802                         conservatively_pin_objects_from ((void**)&info->ctx, (void**)&info->ctx + ARCH_NUM_REGS,
3803                                 start_nursery, end_nursery, PIN_TYPE_STACK);
3804 #else
3805                         conservatively_pin_objects_from ((void**)&info->regs, (void**)&info->regs + ARCH_NUM_REGS,
3806                                         start_nursery, end_nursery, PIN_TYPE_STACK);
3807 #endif
3808                 }
3809         } END_FOREACH_THREAD
3810 }
3811
3812 static gboolean
3813 ptr_on_stack (void *ptr)
3814 {
3815         gpointer stack_start = &stack_start;
3816         SgenThreadInfo *info = mono_thread_info_current ();
3817
3818         if (ptr >= stack_start && ptr < (gpointer)info->stack_end)
3819                 return TRUE;
3820         return FALSE;
3821 }
3822
3823 static void*
3824 sgen_thread_register (SgenThreadInfo* info, void *addr)
3825 {
3826         size_t stsize = 0;
3827         guint8 *staddr = NULL;
3828
3829 #ifndef HAVE_KW_THREAD
3830         info->tlab_start = info->tlab_next = info->tlab_temp_end = info->tlab_real_end = NULL;
3831
3832         g_assert (!mono_native_tls_get_value (thread_info_key));
3833         mono_native_tls_set_value (thread_info_key, info);
3834 #else
3835         sgen_thread_info = info;
3836 #endif
3837
3838 #ifdef SGEN_POSIX_STW
3839         info->stop_count = -1;
3840         info->signal = 0;
3841 #endif
3842         info->skip = 0;
3843         info->stack_start = NULL;
3844         info->stopped_ip = NULL;
3845         info->stopped_domain = NULL;
3846 #ifdef USE_MONO_CTX
3847         memset (&info->ctx, 0, sizeof (MonoContext));
3848 #else
3849         memset (&info->regs, 0, sizeof (info->regs));
3850 #endif
3851
3852         sgen_init_tlab_info (info);
3853
3854         binary_protocol_thread_register ((gpointer)mono_thread_info_get_tid (info));
3855
3856         /* On win32, stack_start_limit should be 0, since the stack can grow dynamically */
3857         mono_thread_info_get_stack_bounds (&staddr, &stsize);
3858         if (staddr) {
3859 #ifndef HOST_WIN32
3860                 info->stack_start_limit = staddr;
3861 #endif
3862                 info->stack_end = staddr + stsize;
3863         } else {
3864                 gsize stack_bottom = (gsize)addr;
3865                 stack_bottom += 4095;
3866                 stack_bottom &= ~4095;
3867                 info->stack_end = (char*)stack_bottom;
3868         }
3869
3870 #ifdef HAVE_KW_THREAD
3871         stack_end = info->stack_end;
3872 #endif
3873
3874         SGEN_LOG (3, "registered thread %p (%p) stack end %p", info, (gpointer)mono_thread_info_get_tid (info), info->stack_end);
3875
3876         if (gc_callbacks.thread_attach_func)
3877                 info->runtime_data = gc_callbacks.thread_attach_func ();
3878         return info;
3879 }
3880
3881 static void
3882 sgen_thread_detach (SgenThreadInfo *p)
3883 {
3884         /* If a delegate is passed to native code and invoked on a thread we dont
3885          * know about, the jit will register it with mono_jit_thread_attach, but
3886          * we have no way of knowing when that thread goes away.  SGen has a TSD
3887          * so we assume that if the domain is still registered, we can detach
3888          * the thread
3889          */
3890         if (mono_domain_get ())
3891                 mono_thread_detach_internal (mono_thread_internal_current ());
3892 }
3893
3894 static void
3895 sgen_thread_unregister (SgenThreadInfo *p)
3896 {
3897         MonoNativeThreadId tid;
3898
3899         tid = mono_thread_info_get_tid (p);
3900         binary_protocol_thread_unregister ((gpointer)tid);
3901         SGEN_LOG (3, "unregister thread %p (%p)", p, (gpointer)tid);
3902
3903 #ifndef HAVE_KW_THREAD
3904         mono_native_tls_set_value (thread_info_key, NULL);
3905 #else
3906         sgen_thread_info = NULL;
3907 #endif
3908
3909         if (p->info.runtime_thread)
3910                 mono_threads_add_joinable_thread ((gpointer)tid);
3911
3912         if (gc_callbacks.thread_detach_func) {
3913                 gc_callbacks.thread_detach_func (p->runtime_data);
3914                 p->runtime_data = NULL;
3915         }
3916 }
3917
3918
3919 static void
3920 sgen_thread_attach (SgenThreadInfo *info)
3921 {
3922         LOCK_GC;
3923         /*this is odd, can we get attached before the gc is inited?*/
3924         init_stats ();
3925         UNLOCK_GC;
3926
3927         if (gc_callbacks.thread_attach_func && !info->runtime_data)
3928                 info->runtime_data = gc_callbacks.thread_attach_func ();
3929 }
3930 gboolean
3931 mono_gc_register_thread (void *baseptr)
3932 {
3933         return mono_thread_info_attach (baseptr) != NULL;
3934 }
3935
3936 /*
3937  * mono_gc_set_stack_end:
3938  *
3939  *   Set the end of the current threads stack to STACK_END. The stack space between
3940  * STACK_END and the real end of the threads stack will not be scanned during collections.
3941  */
3942 void
3943 mono_gc_set_stack_end (void *stack_end)
3944 {
3945         SgenThreadInfo *info;
3946
3947         LOCK_GC;
3948         info = mono_thread_info_current ();
3949         if (info) {
3950                 g_assert (stack_end < info->stack_end);
3951                 info->stack_end = stack_end;
3952         }
3953         UNLOCK_GC;
3954 }
3955
3956 #if USE_PTHREAD_INTERCEPT
3957
3958
3959 int
3960 mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
3961 {
3962         return pthread_create (new_thread, attr, start_routine, arg);
3963 }
3964
3965 int
3966 mono_gc_pthread_join (pthread_t thread, void **retval)
3967 {
3968         return pthread_join (thread, retval);
3969 }
3970
3971 int
3972 mono_gc_pthread_detach (pthread_t thread)
3973 {
3974         return pthread_detach (thread);
3975 }
3976
3977 void
3978 mono_gc_pthread_exit (void *retval)
3979 {
3980         mono_thread_info_detach ();
3981         pthread_exit (retval);
3982         g_assert_not_reached ();
3983 }
3984
3985 #endif /* USE_PTHREAD_INTERCEPT */
3986
3987 /*
3988  * ######################################################################
3989  * ########  Write barriers
3990  * ######################################################################
3991  */
3992
3993 /*
3994  * Note: the write barriers first do the needed GC work and then do the actual store:
3995  * this way the value is visible to the conservative GC scan after the write barrier
3996  * itself. If a GC interrupts the barrier in the middle, value will be kept alive by
3997  * the conservative scan, otherwise by the remembered set scan.
3998  */
3999 void
4000 mono_gc_wbarrier_set_field (MonoObject *obj, gpointer field_ptr, MonoObject* value)
4001 {
4002         HEAVY_STAT (++stat_wbarrier_set_field);
4003         if (ptr_in_nursery (field_ptr)) {
4004                 *(void**)field_ptr = value;
4005                 return;
4006         }
4007         SGEN_LOG (8, "Adding remset at %p", field_ptr);
4008         if (value)
4009                 binary_protocol_wbarrier (field_ptr, value, value->vtable);
4010
4011         remset.wbarrier_set_field (obj, field_ptr, value);
4012 }
4013
4014 void
4015 mono_gc_wbarrier_set_arrayref (MonoArray *arr, gpointer slot_ptr, MonoObject* value)
4016 {
4017         HEAVY_STAT (++stat_wbarrier_set_arrayref);
4018         if (ptr_in_nursery (slot_ptr)) {
4019                 *(void**)slot_ptr = value;
4020                 return;
4021         }
4022         SGEN_LOG (8, "Adding remset at %p", slot_ptr);
4023         if (value)
4024                 binary_protocol_wbarrier (slot_ptr, value, value->vtable);
4025
4026         remset.wbarrier_set_arrayref (arr, slot_ptr, value);
4027 }
4028
4029 void
4030 mono_gc_wbarrier_arrayref_copy (gpointer dest_ptr, gpointer src_ptr, int count)
4031 {
4032         HEAVY_STAT (++stat_wbarrier_arrayref_copy);
4033         /*This check can be done without taking a lock since dest_ptr array is pinned*/
4034         if (ptr_in_nursery (dest_ptr) || count <= 0) {
4035                 mono_gc_memmove_aligned (dest_ptr, src_ptr, count * sizeof (gpointer));
4036                 return;
4037         }
4038
4039 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
4040         if (binary_protocol_is_heavy_enabled ()) {
4041                 int i;
4042                 for (i = 0; i < count; ++i) {
4043                         gpointer dest = (gpointer*)dest_ptr + i;
4044                         gpointer obj = *((gpointer*)src_ptr + i);
4045                         if (obj)
4046                                 binary_protocol_wbarrier (dest, obj, (gpointer)LOAD_VTABLE (obj));
4047                 }
4048         }
4049 #endif
4050
4051         remset.wbarrier_arrayref_copy (dest_ptr, src_ptr, count);
4052 }
4053
4054 void
4055 mono_gc_wbarrier_generic_nostore (gpointer ptr)
4056 {
4057         gpointer obj;
4058
4059         HEAVY_STAT (++stat_wbarrier_generic_store);
4060
4061 #ifdef XDOMAIN_CHECKS_IN_WBARRIER
4062         /* FIXME: ptr_in_heap must be called with the GC lock held */
4063         if (xdomain_checks && *(MonoObject**)ptr && ptr_in_heap (ptr)) {
4064                 char *start = sgen_find_object_for_ptr (ptr);
4065                 MonoObject *value = *(MonoObject**)ptr;
4066                 LOCK_GC;
4067                 g_assert (start);
4068                 if (start) {
4069                         MonoObject *obj = (MonoObject*)start;
4070                         if (obj->vtable->domain != value->vtable->domain)
4071                                 g_assert (is_xdomain_ref_allowed (ptr, start, obj->vtable->domain));
4072                 }
4073                 UNLOCK_GC;
4074         }
4075 #endif
4076
4077         obj = *(gpointer*)ptr;
4078         if (obj)
4079                 binary_protocol_wbarrier (ptr, obj, (gpointer)LOAD_VTABLE (obj));
4080
4081         if (ptr_in_nursery (ptr) || ptr_on_stack (ptr)) {
4082                 SGEN_LOG (8, "Skipping remset at %p", ptr);
4083                 return;
4084         }
4085
4086         /*
4087          * We need to record old->old pointer locations for the
4088          * concurrent collector.
4089          */
4090         if (!ptr_in_nursery (obj) && !concurrent_collection_in_progress) {
4091                 SGEN_LOG (8, "Skipping remset at %p", ptr);
4092                 return;
4093         }
4094
4095         SGEN_LOG (8, "Adding remset at %p", ptr);
4096
4097         remset.wbarrier_generic_nostore (ptr);
4098 }
4099
4100 void
4101 mono_gc_wbarrier_generic_store (gpointer ptr, MonoObject* value)
4102 {
4103         SGEN_LOG (8, "Wbarrier store at %p to %p (%s)", ptr, value, value ? safe_name (value) : "null");
4104         SGEN_UPDATE_REFERENCE_ALLOW_NULL (ptr, value);
4105         if (ptr_in_nursery (value))
4106                 mono_gc_wbarrier_generic_nostore (ptr);
4107         sgen_dummy_use (value);
4108 }
4109
4110 /* Same as mono_gc_wbarrier_generic_store () but performs the store
4111  * as an atomic operation with release semantics.
4112  */
4113 void
4114 mono_gc_wbarrier_generic_store_atomic (gpointer ptr, MonoObject *value)
4115 {
4116         HEAVY_STAT (++stat_wbarrier_generic_store_atomic);
4117
4118         SGEN_LOG (8, "Wbarrier atomic store at %p to %p (%s)", ptr, value, value ? safe_name (value) : "null");
4119
4120         InterlockedWritePointer (ptr, value);
4121
4122         if (ptr_in_nursery (value))
4123                 mono_gc_wbarrier_generic_nostore (ptr);
4124
4125         sgen_dummy_use (value);
4126 }
4127
4128 void mono_gc_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap)
4129 {
4130         mword *dest = _dest;
4131         mword *src = _src;
4132
4133         while (size) {
4134                 if (bitmap & 0x1)
4135                         mono_gc_wbarrier_generic_store (dest, (MonoObject*)*src);
4136                 else
4137                         SGEN_UPDATE_REFERENCE_ALLOW_NULL (dest, *src);
4138                 ++src;
4139                 ++dest;
4140                 size -= SIZEOF_VOID_P;
4141                 bitmap >>= 1;
4142         }
4143 }
4144
4145 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
4146 #undef HANDLE_PTR
4147 #define HANDLE_PTR(ptr,obj) do {                                        \
4148                 gpointer o = *(gpointer*)(ptr);                         \
4149                 if ((o)) {                                              \
4150                         gpointer d = ((char*)dest) + ((char*)(ptr) - (char*)(obj)); \
4151                         binary_protocol_wbarrier (d, o, (gpointer) LOAD_VTABLE (o)); \
4152                 }                                                       \
4153         } while (0)
4154
4155 static void
4156 scan_object_for_binary_protocol_copy_wbarrier (gpointer dest, char *start, mword desc)
4157 {
4158 #define SCAN_OBJECT_NOVTABLE
4159 #include "sgen-scan-object.h"
4160 }
4161 #endif
4162
4163 void
4164 mono_gc_wbarrier_value_copy (gpointer dest, gpointer src, int count, MonoClass *klass)
4165 {
4166         HEAVY_STAT (++stat_wbarrier_value_copy);
4167         g_assert (klass->valuetype);
4168
4169         SGEN_LOG (8, "Adding value remset at %p, count %d, descr %p for class %s (%p)", dest, count, klass->gc_descr, klass->name, klass);
4170
4171         if (ptr_in_nursery (dest) || ptr_on_stack (dest) || !SGEN_CLASS_HAS_REFERENCES (klass)) {
4172                 size_t element_size = mono_class_value_size (klass, NULL);
4173                 size_t size = count * element_size;
4174                 mono_gc_memmove_atomic (dest, src, size);
4175                 return;
4176         }
4177
4178 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
4179         if (binary_protocol_is_heavy_enabled ()) {
4180                 size_t element_size = mono_class_value_size (klass, NULL);
4181                 int i;
4182                 for (i = 0; i < count; ++i) {
4183                         scan_object_for_binary_protocol_copy_wbarrier ((char*)dest + i * element_size,
4184                                         (char*)src + i * element_size - sizeof (MonoObject),
4185                                         (mword) klass->gc_descr);
4186                 }
4187         }
4188 #endif
4189
4190         remset.wbarrier_value_copy (dest, src, count, klass);
4191 }
4192
4193 /**
4194  * mono_gc_wbarrier_object_copy:
4195  *
4196  * Write barrier to call when obj is the result of a clone or copy of an object.
4197  */
4198 void
4199 mono_gc_wbarrier_object_copy (MonoObject* obj, MonoObject *src)
4200 {
4201         int size;
4202
4203         HEAVY_STAT (++stat_wbarrier_object_copy);
4204
4205         if (ptr_in_nursery (obj) || ptr_on_stack (obj)) {
4206                 size = mono_object_class (obj)->instance_size;
4207                 mono_gc_memmove_aligned ((char*)obj + sizeof (MonoObject), (char*)src + sizeof (MonoObject),
4208                                 size - sizeof (MonoObject));
4209                 return;
4210         }
4211
4212 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
4213         if (binary_protocol_is_heavy_enabled ())
4214                 scan_object_for_binary_protocol_copy_wbarrier (obj, (char*)src, (mword) src->vtable->gc_descr);
4215 #endif
4216
4217         remset.wbarrier_object_copy (obj, src);
4218 }
4219
4220
4221 /*
4222  * ######################################################################
4223  * ########  Other mono public interface functions.
4224  * ######################################################################
4225  */
4226
4227 #define REFS_SIZE 128
4228 typedef struct {
4229         void *data;
4230         MonoGCReferences callback;
4231         int flags;
4232         int count;
4233         int called;
4234         MonoObject *refs [REFS_SIZE];
4235         uintptr_t offsets [REFS_SIZE];
4236 } HeapWalkInfo;
4237
4238 #undef HANDLE_PTR
4239 #define HANDLE_PTR(ptr,obj)     do {    \
4240                 if (*(ptr)) {   \
4241                         if (hwi->count == REFS_SIZE) {  \
4242                                 hwi->callback ((MonoObject*)start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);    \
4243                                 hwi->count = 0; \
4244                                 hwi->called = 1;        \
4245                         }       \
4246                         hwi->offsets [hwi->count] = (char*)(ptr)-(char*)start;  \
4247                         hwi->refs [hwi->count++] = *(ptr);      \
4248                 }       \
4249         } while (0)
4250
4251 static void
4252 collect_references (HeapWalkInfo *hwi, char *start, size_t size)
4253 {
4254         mword desc = sgen_obj_get_descriptor (start);
4255
4256 #include "sgen-scan-object.h"
4257 }
4258
4259 static void
4260 walk_references (char *start, size_t size, void *data)
4261 {
4262         HeapWalkInfo *hwi = data;
4263         hwi->called = 0;
4264         hwi->count = 0;
4265         collect_references (hwi, start, size);
4266         if (hwi->count || !hwi->called)
4267                 hwi->callback ((MonoObject*)start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);
4268 }
4269
4270 /**
4271  * mono_gc_walk_heap:
4272  * @flags: flags for future use
4273  * @callback: a function pointer called for each object in the heap
4274  * @data: a user data pointer that is passed to callback
4275  *
4276  * This function can be used to iterate over all the live objects in the heap:
4277  * for each object, @callback is invoked, providing info about the object's
4278  * location in memory, its class, its size and the objects it references.
4279  * For each referenced object it's offset from the object address is
4280  * reported in the offsets array.
4281  * The object references may be buffered, so the callback may be invoked
4282  * multiple times for the same object: in all but the first call, the size
4283  * argument will be zero.
4284  * Note that this function can be only called in the #MONO_GC_EVENT_PRE_START_WORLD
4285  * profiler event handler.
4286  *
4287  * Returns: a non-zero value if the GC doesn't support heap walking
4288  */
4289 int
4290 mono_gc_walk_heap (int flags, MonoGCReferences callback, void *data)
4291 {
4292         HeapWalkInfo hwi;
4293
4294         hwi.flags = flags;
4295         hwi.callback = callback;
4296         hwi.data = data;
4297
4298         sgen_clear_nursery_fragments ();
4299         sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data, walk_references, &hwi, FALSE);
4300
4301         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, walk_references, &hwi);
4302         sgen_los_iterate_objects (walk_references, &hwi);
4303
4304         return 0;
4305 }
4306
4307 void
4308 mono_gc_collect (int generation)
4309 {
4310         LOCK_GC;
4311         if (generation > 1)
4312                 generation = 1;
4313         sgen_perform_collection (0, generation, "user request", TRUE);
4314         UNLOCK_GC;
4315 }
4316
4317 int
4318 mono_gc_max_generation (void)
4319 {
4320         return 1;
4321 }
4322
4323 int
4324 mono_gc_collection_count (int generation)
4325 {
4326         if (generation == 0)
4327                 return gc_stats.minor_gc_count;
4328         return gc_stats.major_gc_count;
4329 }
4330
4331 int64_t
4332 mono_gc_get_used_size (void)
4333 {
4334         gint64 tot = 0;
4335         LOCK_GC;
4336         tot = los_memory_usage;
4337         tot += nursery_section->next_data - nursery_section->data;
4338         tot += major_collector.get_used_size ();
4339         /* FIXME: account for pinned objects */
4340         UNLOCK_GC;
4341         return tot;
4342 }
4343
4344 int
4345 mono_gc_get_los_limit (void)
4346 {
4347         return MAX_SMALL_OBJ_SIZE;
4348 }
4349
4350 void
4351 mono_gc_set_string_length (MonoString *str, gint32 new_length)
4352 {
4353         mono_unichar2 *new_end = str->chars + new_length;
4354
4355         /* zero the discarded string. This null-delimits the string and allows
4356          * the space to be reclaimed by SGen. */
4357
4358         if (nursery_canaries_enabled () && sgen_ptr_in_nursery (str)) {
4359                 CHECK_CANARY_FOR_OBJECT (str);
4360                 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2) + CANARY_SIZE);
4361                 memcpy (new_end + 1 , CANARY_STRING, CANARY_SIZE);
4362         } else {
4363                 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2));
4364         }
4365
4366         str->length = new_length;
4367 }
4368
4369 gboolean
4370 mono_gc_user_markers_supported (void)
4371 {
4372         return TRUE;
4373 }
4374
4375 gboolean
4376 mono_object_is_alive (MonoObject* o)
4377 {
4378         return TRUE;
4379 }
4380
4381 int
4382 mono_gc_get_generation (MonoObject *obj)
4383 {
4384         if (ptr_in_nursery (obj))
4385                 return 0;
4386         return 1;
4387 }
4388
4389 void
4390 mono_gc_enable_events (void)
4391 {
4392 }
4393
4394 void
4395 mono_gc_weak_link_add (void **link_addr, MonoObject *obj, gboolean track)
4396 {
4397         sgen_register_disappearing_link (obj, link_addr, track, FALSE);
4398 }
4399
4400 void
4401 mono_gc_weak_link_remove (void **link_addr, gboolean track)
4402 {
4403         sgen_register_disappearing_link (NULL, link_addr, track, FALSE);
4404 }
4405
4406 MonoObject*
4407 mono_gc_weak_link_get (void **link_addr)
4408 {
4409         void * volatile *link_addr_volatile;
4410         void *ptr;
4411         MonoObject *obj;
4412  retry:
4413         link_addr_volatile = link_addr;
4414         ptr = (void*)*link_addr_volatile;
4415         /*
4416          * At this point we have a hidden pointer.  If the GC runs
4417          * here, it will not recognize the hidden pointer as a
4418          * reference, and if the object behind it is not referenced
4419          * elsewhere, it will be freed.  Once the world is restarted
4420          * we reveal the pointer, giving us a pointer to a freed
4421          * object.  To make sure we don't return it, we load the
4422          * hidden pointer again.  If it's still the same, we can be
4423          * sure the object reference is valid.
4424          */
4425         if (ptr)
4426                 obj = (MonoObject*) REVEAL_POINTER (ptr);
4427         else
4428                 return NULL;
4429
4430         mono_memory_barrier ();
4431
4432         /*
4433          * During the second bridge processing step the world is
4434          * running again.  That step processes all weak links once
4435          * more to null those that refer to dead objects.  Before that
4436          * is completed, those links must not be followed, so we
4437          * conservatively wait for bridge processing when any weak
4438          * link is dereferenced.
4439          */
4440         if (G_UNLIKELY (bridge_processing_in_progress))
4441                 mono_gc_wait_for_bridge_processing ();
4442
4443         if ((void*)*link_addr_volatile != ptr)
4444                 goto retry;
4445
4446         return obj;
4447 }
4448
4449 gboolean
4450 mono_gc_ephemeron_array_add (MonoObject *obj)
4451 {
4452         EphemeronLinkNode *node;
4453
4454         LOCK_GC;
4455
4456         node = sgen_alloc_internal (INTERNAL_MEM_EPHEMERON_LINK);
4457         if (!node) {
4458                 UNLOCK_GC;
4459                 return FALSE;
4460         }
4461         node->array = (char*)obj;
4462         node->next = ephemeron_list;
4463         ephemeron_list = node;
4464
4465         SGEN_LOG (5, "Registered ephemeron array %p", obj);
4466
4467         UNLOCK_GC;
4468         return TRUE;
4469 }
4470
4471 gboolean
4472 mono_gc_set_allow_synchronous_major (gboolean flag)
4473 {
4474         if (!major_collector.is_concurrent)
4475                 return flag;
4476
4477         allow_synchronous_major = flag;
4478         return TRUE;
4479 }
4480
4481 void*
4482 mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data)
4483 {
4484         void *result;
4485         LOCK_INTERRUPTION;
4486         result = func (data);
4487         UNLOCK_INTERRUPTION;
4488         return result;
4489 }
4490
4491 gboolean
4492 mono_gc_is_gc_thread (void)
4493 {
4494         gboolean result;
4495         LOCK_GC;
4496         result = mono_thread_info_current () != NULL;
4497         UNLOCK_GC;
4498         return result;
4499 }
4500
4501 static gboolean
4502 is_critical_method (MonoMethod *method)
4503 {
4504         return mono_runtime_is_critical_method (method) || sgen_is_critical_method (method);
4505 }
4506
4507 void
4508 sgen_env_var_error (const char *env_var, const char *fallback, const char *description_format, ...)
4509 {
4510         va_list ap;
4511
4512         va_start (ap, description_format);
4513
4514         fprintf (stderr, "Warning: In environment variable `%s': ", env_var);
4515         vfprintf (stderr, description_format, ap);
4516         if (fallback)
4517                 fprintf (stderr, " - %s", fallback);
4518         fprintf (stderr, "\n");
4519
4520         va_end (ap);
4521 }
4522
4523 static gboolean
4524 parse_double_in_interval (const char *env_var, const char *opt_name, const char *opt, double min, double max, double *result)
4525 {
4526         char *endptr;
4527         double val = strtod (opt, &endptr);
4528         if (endptr == opt) {
4529                 sgen_env_var_error (env_var, "Using default value.", "`%s` must be a number.", opt_name);
4530                 return FALSE;
4531         }
4532         else if (val < min || val > max) {
4533                 sgen_env_var_error (env_var, "Using default value.", "`%s` must be between %.2f - %.2f.", opt_name, min, max);
4534                 return FALSE;
4535         }
4536         *result = val;
4537         return TRUE;
4538 }
4539
4540 static gboolean
4541 thread_in_critical_region (SgenThreadInfo *info)
4542 {
4543         return info->in_critical_region;
4544 }
4545
4546 void
4547 mono_gc_base_init (void)
4548 {
4549         MonoThreadInfoCallbacks cb;
4550         const char *env;
4551         char **opts, **ptr;
4552         char *major_collector_opt = NULL;
4553         char *minor_collector_opt = NULL;
4554         size_t max_heap = 0;
4555         size_t soft_limit = 0;
4556         int result;
4557         int dummy;
4558         gboolean debug_print_allowance = FALSE;
4559         double allowance_ratio = 0, save_target = 0;
4560         gboolean cement_enabled = TRUE;
4561
4562         mono_counters_init ();
4563
4564         do {
4565                 result = InterlockedCompareExchange (&gc_initialized, -1, 0);
4566                 switch (result) {
4567                 case 1:
4568                         /* already inited */
4569                         return;
4570                 case -1:
4571                         /* being inited by another thread */
4572                         g_usleep (1000);
4573                         break;
4574                 case 0:
4575                         /* we will init it */
4576                         break;
4577                 default:
4578                         g_assert_not_reached ();
4579                 }
4580         } while (result != 0);
4581
4582         SGEN_TV_GETTIME (sgen_init_timestamp);
4583
4584         LOCK_INIT (gc_mutex);
4585
4586         pagesize = mono_pagesize ();
4587         gc_debug_file = stderr;
4588
4589         cb.thread_register = sgen_thread_register;
4590         cb.thread_detach = sgen_thread_detach;
4591         cb.thread_unregister = sgen_thread_unregister;
4592         cb.thread_attach = sgen_thread_attach;
4593         cb.mono_method_is_critical = (gpointer)is_critical_method;
4594         cb.mono_thread_in_critical_region = thread_in_critical_region;
4595 #ifndef HOST_WIN32
4596         cb.thread_exit = mono_gc_pthread_exit;
4597         cb.mono_gc_pthread_create = (gpointer)mono_gc_pthread_create;
4598 #endif
4599
4600         mono_threads_init (&cb, sizeof (SgenThreadInfo));
4601
4602         LOCK_INIT (sgen_interruption_mutex);
4603
4604         if ((env = g_getenv (MONO_GC_PARAMS_NAME))) {
4605                 opts = g_strsplit (env, ",", -1);
4606                 for (ptr = opts; *ptr; ++ptr) {
4607                         char *opt = *ptr;
4608                         if (g_str_has_prefix (opt, "major=")) {
4609                                 opt = strchr (opt, '=') + 1;
4610                                 major_collector_opt = g_strdup (opt);
4611                         } else if (g_str_has_prefix (opt, "minor=")) {
4612                                 opt = strchr (opt, '=') + 1;
4613                                 minor_collector_opt = g_strdup (opt);
4614                         }
4615                 }
4616         } else {
4617                 opts = NULL;
4618         }
4619
4620         init_stats ();
4621         sgen_init_internal_allocator ();
4622         sgen_init_nursery_allocator ();
4623         sgen_init_fin_weak_hash ();
4624         sgen_init_stw ();
4625         sgen_init_hash_table ();
4626         sgen_init_descriptors ();
4627         sgen_init_gray_queues ();
4628
4629         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_SECTION, SGEN_SIZEOF_GC_MEM_SECTION);
4630         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_FINALIZE_READY_ENTRY, sizeof (FinalizeReadyEntry));
4631         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_GRAY_QUEUE, sizeof (GrayQueueSection));
4632         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_EPHEMERON_LINK, sizeof (EphemeronLinkNode));
4633
4634 #ifndef HAVE_KW_THREAD
4635         mono_native_tls_alloc (&thread_info_key, NULL);
4636 #if defined(__APPLE__) || defined (HOST_WIN32)
4637         /*
4638          * CEE_MONO_TLS requires the tls offset, not the key, so the code below only works on darwin,
4639          * where the two are the same.
4640          */
4641         mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, thread_info_key);
4642 #endif
4643 #else
4644         {
4645                 int tls_offset = -1;
4646                 MONO_THREAD_VAR_OFFSET (sgen_thread_info, tls_offset);
4647                 mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, tls_offset);
4648         }
4649 #endif
4650
4651         /*
4652          * This needs to happen before any internal allocations because
4653          * it inits the small id which is required for hazard pointer
4654          * operations.
4655          */
4656         sgen_os_init ();
4657
4658         mono_thread_info_attach (&dummy);
4659
4660         if (!minor_collector_opt) {
4661                 sgen_simple_nursery_init (&sgen_minor_collector);
4662         } else {
4663                 if (!strcmp (minor_collector_opt, "simple")) {
4664                 use_simple_nursery:
4665                         sgen_simple_nursery_init (&sgen_minor_collector);
4666                 } else if (!strcmp (minor_collector_opt, "split")) {
4667                         sgen_split_nursery_init (&sgen_minor_collector);
4668                 } else {
4669                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using `simple` instead.", "Unknown minor collector `%s'.", minor_collector_opt);
4670                         goto use_simple_nursery;
4671                 }
4672         }
4673
4674         if (!major_collector_opt || !strcmp (major_collector_opt, "marksweep")) {
4675         use_marksweep_major:
4676                 sgen_marksweep_init (&major_collector);
4677         } else if (!major_collector_opt || !strcmp (major_collector_opt, "marksweep-conc")) {
4678                 sgen_marksweep_conc_init (&major_collector);
4679         } else {
4680                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using `marksweep` instead.", "Unknown major collector `%s'.", major_collector_opt);
4681                 goto use_marksweep_major;
4682         }
4683
4684         ///* Keep this the default for now */
4685         /* Precise marking is broken on all supported targets. Disable until fixed. */
4686         conservative_stack_mark = TRUE;
4687
4688         sgen_nursery_size = DEFAULT_NURSERY_SIZE;
4689
4690         if (major_collector.is_concurrent)
4691                 cement_enabled = FALSE;
4692
4693         if (opts) {
4694                 gboolean usage_printed = FALSE;
4695
4696                 for (ptr = opts; *ptr; ++ptr) {
4697                         char *opt = *ptr;
4698                         if (!strcmp (opt, ""))
4699                                 continue;
4700                         if (g_str_has_prefix (opt, "major="))
4701                                 continue;
4702                         if (g_str_has_prefix (opt, "minor="))
4703                                 continue;
4704                         if (g_str_has_prefix (opt, "max-heap-size=")) {
4705                                 size_t max_heap_candidate = 0;
4706                                 opt = strchr (opt, '=') + 1;
4707                                 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &max_heap_candidate)) {
4708                                         max_heap = (max_heap_candidate + mono_pagesize () - 1) & ~(size_t)(mono_pagesize () - 1);
4709                                         if (max_heap != max_heap_candidate)
4710                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Rounding up.", "`max-heap-size` size must be a multiple of %d.", mono_pagesize ());
4711                                 } else {
4712                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`max-heap-size` must be an integer.");
4713                                 }
4714                                 continue;
4715                         }
4716                         if (g_str_has_prefix (opt, "soft-heap-limit=")) {
4717                                 opt = strchr (opt, '=') + 1;
4718                                 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &soft_limit)) {
4719                                         if (soft_limit <= 0) {
4720                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`soft-heap-limit` must be positive.");
4721                                                 soft_limit = 0;
4722                                         }
4723                                 } else {
4724                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`soft-heap-limit` must be an integer.");
4725                                 }
4726                                 continue;
4727                         }
4728                         if (g_str_has_prefix (opt, "stack-mark=")) {
4729                                 opt = strchr (opt, '=') + 1;
4730                                 if (!strcmp (opt, "precise")) {
4731                                         conservative_stack_mark = FALSE;
4732                                 } else if (!strcmp (opt, "conservative")) {
4733                                         conservative_stack_mark = TRUE;
4734                                 } else {
4735                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, conservative_stack_mark ? "Using `conservative`." : "Using `precise`.",
4736                                                         "Invalid value `%s` for `stack-mark` option, possible values are: `precise`, `conservative`.", opt);
4737                                 }
4738                                 continue;
4739                         }
4740                         if (g_str_has_prefix (opt, "bridge-implementation=")) {
4741                                 opt = strchr (opt, '=') + 1;
4742                                 sgen_set_bridge_implementation (opt);
4743                                 continue;
4744                         }
4745                         if (g_str_has_prefix (opt, "toggleref-test")) {
4746                                 sgen_register_test_toggleref_callback ();
4747                                 continue;
4748                         }
4749
4750 #ifdef USER_CONFIG
4751                         if (g_str_has_prefix (opt, "nursery-size=")) {
4752                                 size_t val;
4753                                 opt = strchr (opt, '=') + 1;
4754                                 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &val)) {
4755                                         if ((val & (val - 1))) {
4756                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.", "`nursery-size` must be a power of two.");
4757                                                 continue;
4758                                         }
4759
4760                                         if (val < SGEN_MAX_NURSERY_WASTE) {
4761                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.",
4762                                                                 "`nursery-size` must be at least %d bytes.", SGEN_MAX_NURSERY_WASTE);
4763                                                 continue;
4764                                         }
4765
4766                                         sgen_nursery_size = val;
4767                                         sgen_nursery_bits = 0;
4768                                         while (ONE_P << (++ sgen_nursery_bits) != sgen_nursery_size)
4769                                                 ;
4770                                 } else {
4771                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.", "`nursery-size` must be an integer.");
4772                                         continue;
4773                                 }
4774                                 continue;
4775                         }
4776 #endif
4777                         if (g_str_has_prefix (opt, "save-target-ratio=")) {
4778                                 double val;
4779                                 opt = strchr (opt, '=') + 1;
4780                                 if (parse_double_in_interval (MONO_GC_PARAMS_NAME, "save-target-ratio", opt,
4781                                                 SGEN_MIN_SAVE_TARGET_RATIO, SGEN_MAX_SAVE_TARGET_RATIO, &val)) {
4782                                         save_target = val;
4783                                 }
4784                                 continue;
4785                         }
4786                         if (g_str_has_prefix (opt, "default-allowance-ratio=")) {
4787                                 double val;
4788                                 opt = strchr (opt, '=') + 1;
4789                                 if (parse_double_in_interval (MONO_GC_PARAMS_NAME, "default-allowance-ratio", opt,
4790                                                 SGEN_MIN_ALLOWANCE_NURSERY_SIZE_RATIO, SGEN_MIN_ALLOWANCE_NURSERY_SIZE_RATIO, &val)) {
4791                                         allowance_ratio = val;
4792                                 }
4793                                 continue;
4794                         }
4795                         if (g_str_has_prefix (opt, "allow-synchronous-major=")) {
4796                                 if (!major_collector.is_concurrent) {
4797                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Ignoring.", "`allow-synchronous-major` is only valid for the concurrent major collector.");
4798                                         continue;
4799                                 }
4800
4801                                 opt = strchr (opt, '=') + 1;
4802
4803                                 if (!strcmp (opt, "yes")) {
4804                                         allow_synchronous_major = TRUE;
4805                                 } else if (!strcmp (opt, "no")) {
4806                                         allow_synchronous_major = FALSE;
4807                                 } else {
4808                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.", "`allow-synchronous-major` must be either `yes' or `no'.");
4809                                         continue;
4810                                 }
4811                         }
4812
4813                         if (!strcmp (opt, "cementing")) {
4814                                 cement_enabled = TRUE;
4815                                 continue;
4816                         }
4817                         if (!strcmp (opt, "no-cementing")) {
4818                                 cement_enabled = FALSE;
4819                                 continue;
4820                         }
4821
4822                         if (major_collector.handle_gc_param && major_collector.handle_gc_param (opt))
4823                                 continue;
4824
4825                         if (sgen_minor_collector.handle_gc_param && sgen_minor_collector.handle_gc_param (opt))
4826                                 continue;
4827
4828                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Ignoring.", "Unknown option `%s`.", opt);
4829
4830                         if (usage_printed)
4831                                 continue;
4832
4833                         fprintf (stderr, "\n%s must be a comma-delimited list of one or more of the following:\n", MONO_GC_PARAMS_NAME);
4834                         fprintf (stderr, "  max-heap-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
4835                         fprintf (stderr, "  soft-heap-limit=n (where N is an integer, possibly with a k, m or a g suffix)\n");
4836                         fprintf (stderr, "  nursery-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
4837                         fprintf (stderr, "  major=COLLECTOR (where COLLECTOR is `marksweep', `marksweep-conc', `marksweep-par')\n");
4838                         fprintf (stderr, "  minor=COLLECTOR (where COLLECTOR is `simple' or `split')\n");
4839                         fprintf (stderr, "  wbarrier=WBARRIER (where WBARRIER is `remset' or `cardtable')\n");
4840                         fprintf (stderr, "  stack-mark=MARK-METHOD (where MARK-METHOD is 'precise' or 'conservative')\n");
4841                         fprintf (stderr, "  [no-]cementing\n");
4842                         if (major_collector.is_concurrent)
4843                                 fprintf (stderr, "  allow-synchronous-major=FLAG (where FLAG is `yes' or `no')\n");
4844                         if (major_collector.print_gc_param_usage)
4845                                 major_collector.print_gc_param_usage ();
4846                         if (sgen_minor_collector.print_gc_param_usage)
4847                                 sgen_minor_collector.print_gc_param_usage ();
4848                         fprintf (stderr, " Experimental options:\n");
4849                         fprintf (stderr, "  save-target-ratio=R (where R must be between %.2f - %.2f).\n", SGEN_MIN_SAVE_TARGET_RATIO, SGEN_MAX_SAVE_TARGET_RATIO);
4850                         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);
4851                         fprintf (stderr, "\n");
4852
4853                         usage_printed = TRUE;
4854                 }
4855                 g_strfreev (opts);
4856         }
4857
4858         if (major_collector.is_concurrent)
4859                 sgen_workers_init (1);
4860
4861         if (major_collector_opt)
4862                 g_free (major_collector_opt);
4863
4864         if (minor_collector_opt)
4865                 g_free (minor_collector_opt);
4866
4867         alloc_nursery ();
4868
4869         if (major_collector.is_concurrent && cement_enabled) {
4870                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Ignoring.", "`cementing` is not supported on concurrent major collectors.");
4871                 cement_enabled = FALSE;
4872         }
4873
4874         sgen_cement_init (cement_enabled);
4875
4876         if ((env = g_getenv (MONO_GC_DEBUG_NAME))) {
4877                 gboolean usage_printed = FALSE;
4878
4879                 opts = g_strsplit (env, ",", -1);
4880                 for (ptr = opts; ptr && *ptr; ptr ++) {
4881                         char *opt = *ptr;
4882                         if (!strcmp (opt, ""))
4883                                 continue;
4884                         if (opt [0] >= '0' && opt [0] <= '9') {
4885                                 gc_debug_level = atoi (opt);
4886                                 opt++;
4887                                 if (opt [0] == ':')
4888                                         opt++;
4889                                 if (opt [0]) {
4890                                         char *rf = g_strdup_printf ("%s.%d", opt, mono_process_current_pid ());
4891                                         gc_debug_file = fopen (rf, "wb");
4892                                         if (!gc_debug_file)
4893                                                 gc_debug_file = stderr;
4894                                         g_free (rf);
4895                                 }
4896                         } else if (!strcmp (opt, "print-allowance")) {
4897                                 debug_print_allowance = TRUE;
4898                         } else if (!strcmp (opt, "print-pinning")) {
4899                                 do_pin_stats = TRUE;
4900                         } else if (!strcmp (opt, "verify-before-allocs")) {
4901                                 verify_before_allocs = 1;
4902                                 has_per_allocation_action = TRUE;
4903                         } else if (g_str_has_prefix (opt, "verify-before-allocs=")) {
4904                                 char *arg = strchr (opt, '=') + 1;
4905                                 verify_before_allocs = atoi (arg);
4906                                 has_per_allocation_action = TRUE;
4907                         } else if (!strcmp (opt, "collect-before-allocs")) {
4908                                 collect_before_allocs = 1;
4909                                 has_per_allocation_action = TRUE;
4910                         } else if (g_str_has_prefix (opt, "collect-before-allocs=")) {
4911                                 char *arg = strchr (opt, '=') + 1;
4912                                 has_per_allocation_action = TRUE;
4913                                 collect_before_allocs = atoi (arg);
4914                         } else if (!strcmp (opt, "verify-before-collections")) {
4915                                 whole_heap_check_before_collection = TRUE;
4916                         } else if (!strcmp (opt, "check-at-minor-collections")) {
4917                                 consistency_check_at_minor_collection = TRUE;
4918                                 nursery_clear_policy = CLEAR_AT_GC;
4919                         } else if (!strcmp (opt, "mod-union-consistency-check")) {
4920                                 if (!major_collector.is_concurrent) {
4921                                         sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "`mod-union-consistency-check` only works with concurrent major collector.");
4922                                         continue;
4923                                 }
4924                                 mod_union_consistency_check = TRUE;
4925                         } else if (!strcmp (opt, "check-mark-bits")) {
4926                                 check_mark_bits_after_major_collection = TRUE;
4927                         } else if (!strcmp (opt, "check-nursery-pinned")) {
4928                                 check_nursery_objects_pinned = TRUE;
4929                         } else if (!strcmp (opt, "xdomain-checks")) {
4930                                 xdomain_checks = TRUE;
4931                         } else if (!strcmp (opt, "clear-at-gc")) {
4932                                 nursery_clear_policy = CLEAR_AT_GC;
4933                         } else if (!strcmp (opt, "clear-nursery-at-gc")) {
4934                                 nursery_clear_policy = CLEAR_AT_GC;
4935                         } else if (!strcmp (opt, "clear-at-tlab-creation")) {
4936                                 nursery_clear_policy = CLEAR_AT_TLAB_CREATION;
4937                         } else if (!strcmp (opt, "debug-clear-at-tlab-creation")) {
4938                                 nursery_clear_policy = CLEAR_AT_TLAB_CREATION_DEBUG;
4939                         } else if (!strcmp (opt, "check-scan-starts")) {
4940                                 do_scan_starts_check = TRUE;
4941                         } else if (!strcmp (opt, "verify-nursery-at-minor-gc")) {
4942                                 do_verify_nursery = TRUE;
4943                         } else if (!strcmp (opt, "check-concurrent")) {
4944                                 if (!major_collector.is_concurrent) {
4945                                         sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "`check-concurrent` only works with concurrent major collectors.");
4946                                         continue;
4947                                 }
4948                                 do_concurrent_checks = TRUE;
4949                         } else if (!strcmp (opt, "dump-nursery-at-minor-gc")) {
4950                                 do_dump_nursery_content = TRUE;
4951                         } else if (!strcmp (opt, "no-managed-allocator")) {
4952                                 sgen_set_use_managed_allocator (FALSE);
4953                         } else if (!strcmp (opt, "disable-minor")) {
4954                                 disable_minor_collections = TRUE;
4955                         } else if (!strcmp (opt, "disable-major")) {
4956                                 disable_major_collections = TRUE;
4957                         } else if (g_str_has_prefix (opt, "heap-dump=")) {
4958                                 char *filename = strchr (opt, '=') + 1;
4959                                 nursery_clear_policy = CLEAR_AT_GC;
4960                                 heap_dump_file = fopen (filename, "w");
4961                                 if (heap_dump_file) {
4962                                         fprintf (heap_dump_file, "<sgen-dump>\n");
4963                                         do_pin_stats = TRUE;
4964                                 }
4965                         } else if (g_str_has_prefix (opt, "binary-protocol=")) {
4966                                 char *filename = strchr (opt, '=') + 1;
4967                                 char *colon = strrchr (filename, ':');
4968                                 size_t limit = -1;
4969                                 if (colon) {
4970                                         if (!mono_gc_parse_environment_string_extract_number (colon + 1, &limit)) {
4971                                                 sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring limit.", "Binary protocol file size limit must be an integer.");
4972                                                 limit = -1;
4973                                         }
4974                                         *colon = '\0';
4975                                 }
4976                                 binary_protocol_init (filename, (long long)limit);
4977                         } else if (!strcmp (opt, "nursery-canaries")) {
4978                                 do_verify_nursery = TRUE;
4979                                 sgen_set_use_managed_allocator (FALSE);
4980                                 enable_nursery_canaries = TRUE;
4981                         } else if (!strcmp (opt, "do-not-finalize")) {
4982                                 do_not_finalize = TRUE;
4983                         } else if (!strcmp (opt, "log-finalizers")) {
4984                                 log_finalizers = TRUE;
4985                         } else if (!sgen_bridge_handle_gc_debug (opt)) {
4986                                 sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "Unknown option `%s`.", opt);
4987
4988                                 if (usage_printed)
4989                                         continue;
4990
4991                                 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);
4992                                 fprintf (stderr, "Valid <option>s are:\n");
4993                                 fprintf (stderr, "  collect-before-allocs[=<n>]\n");
4994                                 fprintf (stderr, "  verify-before-allocs[=<n>]\n");
4995                                 fprintf (stderr, "  check-at-minor-collections\n");
4996                                 fprintf (stderr, "  check-mark-bits\n");
4997                                 fprintf (stderr, "  check-nursery-pinned\n");
4998                                 fprintf (stderr, "  verify-before-collections\n");
4999                                 fprintf (stderr, "  verify-nursery-at-minor-gc\n");
5000                                 fprintf (stderr, "  dump-nursery-at-minor-gc\n");
5001                                 fprintf (stderr, "  disable-minor\n");
5002                                 fprintf (stderr, "  disable-major\n");
5003                                 fprintf (stderr, "  xdomain-checks\n");
5004                                 fprintf (stderr, "  check-concurrent\n");
5005                                 fprintf (stderr, "  clear-[nursery-]at-gc\n");
5006                                 fprintf (stderr, "  clear-at-tlab-creation\n");
5007                                 fprintf (stderr, "  debug-clear-at-tlab-creation\n");
5008                                 fprintf (stderr, "  check-scan-starts\n");
5009                                 fprintf (stderr, "  no-managed-allocator\n");
5010                                 fprintf (stderr, "  print-allowance\n");
5011                                 fprintf (stderr, "  print-pinning\n");
5012                                 fprintf (stderr, "  heap-dump=<filename>\n");
5013                                 fprintf (stderr, "  binary-protocol=<filename>[:<file-size-limit>]\n");
5014                                 fprintf (stderr, "  nursery-canaries\n");
5015                                 fprintf (stderr, "  do-not-finalize\n");
5016                                 fprintf (stderr, "  log-finalizers\n");
5017                                 sgen_bridge_print_gc_debug_usage ();
5018                                 fprintf (stderr, "\n");
5019
5020                                 usage_printed = TRUE;
5021                         }
5022                 }
5023                 g_strfreev (opts);
5024         }
5025
5026         if (check_mark_bits_after_major_collection)
5027                 nursery_clear_policy = CLEAR_AT_GC;
5028
5029         if (major_collector.post_param_init)
5030                 major_collector.post_param_init (&major_collector);
5031
5032         sgen_memgov_init (max_heap, soft_limit, debug_print_allowance, allowance_ratio, save_target);
5033
5034         memset (&remset, 0, sizeof (remset));
5035
5036         sgen_card_table_init (&remset);
5037
5038         gc_initialized = 1;
5039 }
5040
5041 const char *
5042 mono_gc_get_gc_name (void)
5043 {
5044         return "sgen";
5045 }
5046
5047 static MonoMethod *write_barrier_conc_method;
5048 static MonoMethod *write_barrier_noconc_method;
5049
5050 gboolean
5051 sgen_is_critical_method (MonoMethod *method)
5052 {
5053         return (method == write_barrier_conc_method || method == write_barrier_noconc_method || sgen_is_managed_allocator (method));
5054 }
5055
5056 gboolean
5057 sgen_has_critical_method (void)
5058 {
5059         return write_barrier_conc_method || write_barrier_noconc_method || sgen_has_managed_allocator ();
5060 }
5061
5062 #ifndef DISABLE_JIT
5063
5064 static void
5065 emit_nursery_check (MonoMethodBuilder *mb, int *nursery_check_return_labels, gboolean is_concurrent)
5066 {
5067         int shifted_nursery_start = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
5068
5069         memset (nursery_check_return_labels, 0, sizeof (int) * 2);
5070         // if (ptr_in_nursery (ptr)) return;
5071         /*
5072          * Masking out the bits might be faster, but we would have to use 64 bit
5073          * immediates, which might be slower.
5074          */
5075         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
5076         mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_START);
5077         mono_mb_emit_icon (mb, DEFAULT_NURSERY_BITS);
5078         mono_mb_emit_byte (mb, CEE_SHR_UN);
5079         mono_mb_emit_stloc (mb, shifted_nursery_start);
5080
5081         mono_mb_emit_ldarg (mb, 0);
5082         mono_mb_emit_icon (mb, DEFAULT_NURSERY_BITS);
5083         mono_mb_emit_byte (mb, CEE_SHR_UN);
5084         mono_mb_emit_ldloc (mb, shifted_nursery_start);
5085         nursery_check_return_labels [0] = mono_mb_emit_branch (mb, CEE_BEQ);
5086
5087         if (!is_concurrent) {
5088                 // if (!ptr_in_nursery (*ptr)) return;
5089                 mono_mb_emit_ldarg (mb, 0);
5090                 mono_mb_emit_byte (mb, CEE_LDIND_I);
5091                 mono_mb_emit_icon (mb, DEFAULT_NURSERY_BITS);
5092                 mono_mb_emit_byte (mb, CEE_SHR_UN);
5093                 mono_mb_emit_ldloc (mb, shifted_nursery_start);
5094                 nursery_check_return_labels [1] = mono_mb_emit_branch (mb, CEE_BNE_UN);
5095         }
5096 }
5097 #endif
5098
5099 MonoMethod*
5100 mono_gc_get_specific_write_barrier (gboolean is_concurrent)
5101 {
5102         MonoMethod *res;
5103         MonoMethodBuilder *mb;
5104         MonoMethodSignature *sig;
5105         MonoMethod **write_barrier_method_addr;
5106 #ifdef MANAGED_WBARRIER
5107         int i, nursery_check_labels [2];
5108
5109 #ifdef HAVE_KW_THREAD
5110         int stack_end_offset = -1;
5111
5112         MONO_THREAD_VAR_OFFSET (stack_end, stack_end_offset);
5113         g_assert (stack_end_offset != -1);
5114 #endif
5115 #endif
5116
5117         // FIXME: Maybe create a separate version for ctors (the branch would be
5118         // correctly predicted more times)
5119         if (is_concurrent)
5120                 write_barrier_method_addr = &write_barrier_conc_method;
5121         else
5122                 write_barrier_method_addr = &write_barrier_noconc_method;
5123
5124         if (*write_barrier_method_addr)
5125                 return *write_barrier_method_addr;
5126
5127         /* Create the IL version of mono_gc_barrier_generic_store () */
5128         sig = mono_metadata_signature_alloc (mono_defaults.corlib, 1);
5129         sig->ret = &mono_defaults.void_class->byval_arg;
5130         sig->params [0] = &mono_defaults.int_class->byval_arg;
5131
5132         if (is_concurrent)
5133                 mb = mono_mb_new (mono_defaults.object_class, "wbarrier_conc", MONO_WRAPPER_WRITE_BARRIER);
5134         else
5135                 mb = mono_mb_new (mono_defaults.object_class, "wbarrier_noconc", MONO_WRAPPER_WRITE_BARRIER);
5136
5137 #ifndef DISABLE_JIT
5138 #ifdef MANAGED_WBARRIER
5139         emit_nursery_check (mb, nursery_check_labels, is_concurrent);
5140         /*
5141         addr = sgen_cardtable + ((address >> CARD_BITS) & CARD_MASK)
5142         *addr = 1;
5143
5144         sgen_cardtable:
5145                 LDC_PTR sgen_cardtable
5146
5147         address >> CARD_BITS
5148                 LDARG_0
5149                 LDC_I4 CARD_BITS
5150                 SHR_UN
5151         if (SGEN_HAVE_OVERLAPPING_CARDS) {
5152                 LDC_PTR card_table_mask
5153                 AND
5154         }
5155         AND
5156         ldc_i4_1
5157         stind_i1
5158         */
5159         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
5160         mono_mb_emit_byte (mb, CEE_MONO_LDPTR_CARD_TABLE);
5161         mono_mb_emit_ldarg (mb, 0);
5162         mono_mb_emit_icon (mb, CARD_BITS);
5163         mono_mb_emit_byte (mb, CEE_SHR_UN);
5164         mono_mb_emit_byte (mb, CEE_CONV_I);
5165 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
5166 #if SIZEOF_VOID_P == 8
5167         mono_mb_emit_icon8 (mb, CARD_MASK);
5168 #else
5169         mono_mb_emit_icon (mb, CARD_MASK);
5170 #endif
5171         mono_mb_emit_byte (mb, CEE_CONV_I);
5172         mono_mb_emit_byte (mb, CEE_AND);
5173 #endif
5174         mono_mb_emit_byte (mb, CEE_ADD);
5175         mono_mb_emit_icon (mb, 1);
5176         mono_mb_emit_byte (mb, CEE_STIND_I1);
5177
5178         // return;
5179         for (i = 0; i < 2; ++i) {
5180                 if (nursery_check_labels [i])
5181                         mono_mb_patch_branch (mb, nursery_check_labels [i]);
5182         }
5183         mono_mb_emit_byte (mb, CEE_RET);
5184 #else
5185         mono_mb_emit_ldarg (mb, 0);
5186         mono_mb_emit_icall (mb, mono_gc_wbarrier_generic_nostore);
5187         mono_mb_emit_byte (mb, CEE_RET);
5188 #endif
5189 #endif
5190         res = mono_mb_create_method (mb, sig, 16);
5191         mono_mb_free (mb);
5192
5193         LOCK_GC;
5194         if (*write_barrier_method_addr) {
5195                 /* Already created */
5196                 mono_free_method (res);
5197         } else {
5198                 /* double-checked locking */
5199                 mono_memory_barrier ();
5200                 *write_barrier_method_addr = res;
5201         }
5202         UNLOCK_GC;
5203
5204         return *write_barrier_method_addr;
5205 }
5206
5207 MonoMethod*
5208 mono_gc_get_write_barrier (void)
5209 {
5210         return mono_gc_get_specific_write_barrier (major_collector.is_concurrent);
5211 }
5212
5213 char*
5214 mono_gc_get_description (void)
5215 {
5216         return g_strdup ("sgen");
5217 }
5218
5219 void
5220 mono_gc_set_desktop_mode (void)
5221 {
5222 }
5223
5224 gboolean
5225 mono_gc_is_moving (void)
5226 {
5227         return TRUE;
5228 }
5229
5230 gboolean
5231 mono_gc_is_disabled (void)
5232 {
5233         return FALSE;
5234 }
5235
5236 #ifdef HOST_WIN32
5237 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved)
5238 {
5239         return TRUE;
5240 }
5241 #endif
5242
5243 NurseryClearPolicy
5244 sgen_get_nursery_clear_policy (void)
5245 {
5246         return nursery_clear_policy;
5247 }
5248
5249 MonoVTable*
5250 sgen_get_array_fill_vtable (void)
5251 {
5252         if (!array_fill_vtable) {
5253                 static MonoClass klass;
5254                 static char _vtable[sizeof(MonoVTable)+8];
5255                 MonoVTable* vtable = (MonoVTable*) ALIGN_TO(_vtable, 8);
5256                 gsize bmap;
5257
5258                 MonoDomain *domain = mono_get_root_domain ();
5259                 g_assert (domain);
5260
5261                 klass.element_class = mono_defaults.byte_class;
5262                 klass.rank = 1;
5263                 klass.instance_size = sizeof (MonoArray);
5264                 klass.sizes.element_size = 1;
5265                 klass.name = "array_filler_type";
5266
5267                 vtable->klass = &klass;
5268                 bmap = 0;
5269                 vtable->gc_descr = mono_gc_make_descr_for_array (TRUE, &bmap, 0, 1);
5270                 vtable->rank = 1;
5271
5272                 array_fill_vtable = vtable;
5273         }
5274         return array_fill_vtable;
5275 }
5276
5277 void
5278 sgen_gc_lock (void)
5279 {
5280         LOCK_GC;
5281 }
5282
5283 void
5284 sgen_gc_unlock (void)
5285 {
5286         gboolean try_free = sgen_try_free_some_memory;
5287         sgen_try_free_some_memory = FALSE;
5288         mono_mutex_unlock (&gc_mutex);
5289         MONO_GC_UNLOCKED ();
5290         if (try_free)
5291                 mono_thread_hazardous_try_free_some ();
5292 }
5293
5294 void
5295 sgen_major_collector_iterate_live_block_ranges (sgen_cardtable_block_callback callback)
5296 {
5297         major_collector.iterate_live_block_ranges (callback);
5298 }
5299
5300 void
5301 sgen_major_collector_scan_card_table (SgenGrayQueue *queue)
5302 {
5303         major_collector.scan_card_table (FALSE, queue);
5304 }
5305
5306 SgenMajorCollector*
5307 sgen_get_major_collector (void)
5308 {
5309         return &major_collector;
5310 }
5311
5312 void mono_gc_set_skip_thread (gboolean skip)
5313 {
5314         SgenThreadInfo *info = mono_thread_info_current ();
5315
5316         LOCK_GC;
5317         info->gc_disabled = skip;
5318         UNLOCK_GC;
5319 }
5320
5321 SgenRememberedSet*
5322 sgen_get_remset (void)
5323 {
5324         return &remset;
5325 }
5326
5327 guint
5328 mono_gc_get_vtable_bits (MonoClass *class)
5329 {
5330         guint res = 0;
5331         /* FIXME move this to the bridge code */
5332         if (sgen_need_bridge_processing ()) {
5333                 switch (sgen_bridge_class_kind (class)) {
5334                 case GC_BRIDGE_TRANSPARENT_BRIDGE_CLASS:
5335                 case GC_BRIDGE_OPAQUE_BRIDGE_CLASS:
5336                         res = SGEN_GC_BIT_BRIDGE_OBJECT;
5337                         break;
5338                 case GC_BRIDGE_OPAQUE_CLASS:
5339                         res = SGEN_GC_BIT_BRIDGE_OPAQUE_OBJECT;
5340                         break;
5341                 case GC_BRIDGE_TRANSPARENT_CLASS:
5342                         break;
5343                 }
5344         }
5345         if (fin_callbacks.is_class_finalization_aware) {
5346                 if (fin_callbacks.is_class_finalization_aware (class))
5347                         res |= SGEN_GC_BIT_FINALIZER_AWARE;
5348         }
5349         return res;
5350 }
5351
5352 void
5353 mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size)
5354 {
5355         // FIXME:
5356 }
5357
5358
5359 void
5360 sgen_check_whole_heap_stw (void)
5361 {
5362         sgen_stop_world (0);
5363         sgen_clear_nursery_fragments ();
5364         sgen_check_whole_heap (FALSE);
5365         sgen_restart_world (0, NULL);
5366 }
5367
5368 void
5369 sgen_gc_event_moves (void)
5370 {
5371         if (moved_objects_idx) {
5372                 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
5373                 moved_objects_idx = 0;
5374         }
5375 }
5376
5377 gint64
5378 sgen_timestamp (void)
5379 {
5380         SGEN_TV_DECLARE (timestamp);
5381         SGEN_TV_GETTIME (timestamp);
5382         return SGEN_TV_ELAPSED (sgen_init_timestamp, timestamp);
5383 }
5384
5385 void
5386 mono_gc_register_finalizer_callbacks (MonoGCFinalizerCallbacks *callbacks)
5387 {
5388         if (callbacks->version != MONO_GC_FINALIZER_EXTENSION_VERSION)
5389                 g_error ("Invalid finalizer callback version. Expected %d but got %d\n", MONO_GC_FINALIZER_EXTENSION_VERSION, callbacks->version);
5390
5391         fin_callbacks = *callbacks;
5392 }
5393
5394
5395
5396
5397
5398 #endif /* HAVE_SGEN_GC */