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 #ifdef SGEN_ALIGN_NURSERY
1389         data = major_collector.alloc_heap (alloc_size, alloc_size, DEFAULT_NURSERY_BITS);
1390 #else
1391         data = major_collector.alloc_heap (alloc_size, 0, DEFAULT_NURSERY_BITS);
1392 #endif
1393         sgen_update_heap_boundaries ((mword)data, (mword)(data + sgen_nursery_size));
1394         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 ());
1395         section->data = section->next_data = data;
1396         section->size = alloc_size;
1397         section->end_data = data + sgen_nursery_size;
1398         scan_starts = (alloc_size + SCAN_START_SIZE - 1) / SCAN_START_SIZE;
1399         section->scan_starts = sgen_alloc_internal_dynamic (sizeof (char*) * scan_starts, INTERNAL_MEM_SCAN_STARTS, TRUE);
1400         section->num_scan_start = scan_starts;
1401
1402         nursery_section = section;
1403
1404         sgen_nursery_allocator_set_nursery_bounds (data, data + sgen_nursery_size);
1405 }
1406
1407 void*
1408 mono_gc_get_nursery (int *shift_bits, size_t *size)
1409 {
1410         *size = sgen_nursery_size;
1411 #ifdef SGEN_ALIGN_NURSERY
1412         *shift_bits = DEFAULT_NURSERY_BITS;
1413 #else
1414         *shift_bits = -1;
1415 #endif
1416         return sgen_get_nursery_start ();
1417 }
1418
1419 void
1420 mono_gc_set_current_thread_appdomain (MonoDomain *domain)
1421 {
1422         SgenThreadInfo *info = mono_thread_info_current ();
1423
1424         /* Could be called from sgen_thread_unregister () with a NULL info */
1425         if (domain) {
1426                 g_assert (info);
1427                 info->stopped_domain = domain;
1428         }
1429 }
1430
1431 gboolean
1432 mono_gc_precise_stack_mark_enabled (void)
1433 {
1434         return !conservative_stack_mark;
1435 }
1436
1437 FILE *
1438 mono_gc_get_logfile (void)
1439 {
1440         return gc_debug_file;
1441 }
1442
1443 static void
1444 report_finalizer_roots_list (FinalizeReadyEntry *list)
1445 {
1446         GCRootReport report;
1447         FinalizeReadyEntry *fin;
1448
1449         report.count = 0;
1450         for (fin = list; fin; fin = fin->next) {
1451                 if (!fin->object)
1452                         continue;
1453                 add_profile_gc_root (&report, fin->object, MONO_PROFILE_GC_ROOT_FINALIZER, 0);
1454         }
1455         notify_gc_roots (&report);
1456 }
1457
1458 static void
1459 report_finalizer_roots (void)
1460 {
1461         report_finalizer_roots_list (fin_ready_list);
1462         report_finalizer_roots_list (critical_fin_list);
1463 }
1464
1465 static GCRootReport *root_report;
1466
1467 static void
1468 single_arg_report_root (void **obj, void *gc_data)
1469 {
1470         if (*obj)
1471                 add_profile_gc_root (root_report, *obj, MONO_PROFILE_GC_ROOT_OTHER, 0);
1472 }
1473
1474 static void
1475 precisely_report_roots_from (GCRootReport *report, void** start_root, void** end_root, mword desc)
1476 {
1477         switch (desc & ROOT_DESC_TYPE_MASK) {
1478         case ROOT_DESC_BITMAP:
1479                 desc >>= ROOT_DESC_TYPE_SHIFT;
1480                 while (desc) {
1481                         if ((desc & 1) && *start_root) {
1482                                 add_profile_gc_root (report, *start_root, MONO_PROFILE_GC_ROOT_OTHER, 0);
1483                         }
1484                         desc >>= 1;
1485                         start_root++;
1486                 }
1487                 return;
1488         case ROOT_DESC_COMPLEX: {
1489                 gsize *bitmap_data = sgen_get_complex_descriptor_bitmap (desc);
1490                 gsize bwords = (*bitmap_data) - 1;
1491                 void **start_run = start_root;
1492                 bitmap_data++;
1493                 while (bwords-- > 0) {
1494                         gsize bmap = *bitmap_data++;
1495                         void **objptr = start_run;
1496                         while (bmap) {
1497                                 if ((bmap & 1) && *objptr) {
1498                                         add_profile_gc_root (report, *objptr, MONO_PROFILE_GC_ROOT_OTHER, 0);
1499                                 }
1500                                 bmap >>= 1;
1501                                 ++objptr;
1502                         }
1503                         start_run += GC_BITS_PER_WORD;
1504                 }
1505                 break;
1506         }
1507         case ROOT_DESC_USER: {
1508                 MonoGCRootMarkFunc marker = sgen_get_user_descriptor_func (desc);
1509                 root_report = report;
1510                 marker (start_root, single_arg_report_root, NULL);
1511                 break;
1512         }
1513         case ROOT_DESC_RUN_LEN:
1514                 g_assert_not_reached ();
1515         default:
1516                 g_assert_not_reached ();
1517         }
1518 }
1519
1520 static void
1521 report_registered_roots_by_type (int root_type)
1522 {
1523         GCRootReport report;
1524         void **start_root;
1525         RootRecord *root;
1526         report.count = 0;
1527         SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], start_root, root) {
1528                 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
1529                 precisely_report_roots_from (&report, start_root, (void**)root->end_root, root->root_desc);
1530         } SGEN_HASH_TABLE_FOREACH_END;
1531         notify_gc_roots (&report);
1532 }
1533
1534 static void
1535 report_registered_roots (void)
1536 {
1537         report_registered_roots_by_type (ROOT_TYPE_NORMAL);
1538         report_registered_roots_by_type (ROOT_TYPE_WBARRIER);
1539 }
1540
1541 static void
1542 scan_finalizer_entries (FinalizeReadyEntry *list, ScanCopyContext ctx)
1543 {
1544         CopyOrMarkObjectFunc copy_func = ctx.copy_func;
1545         SgenGrayQueue *queue = ctx.queue;
1546         FinalizeReadyEntry *fin;
1547
1548         for (fin = list; fin; fin = fin->next) {
1549                 if (!fin->object)
1550                         continue;
1551                 SGEN_LOG (5, "Scan of fin ready object: %p (%s)\n", fin->object, safe_name (fin->object));
1552                 copy_func (&fin->object, queue);
1553         }
1554 }
1555
1556 static const char*
1557 generation_name (int generation)
1558 {
1559         switch (generation) {
1560         case GENERATION_NURSERY: return "nursery";
1561         case GENERATION_OLD: return "old";
1562         default: g_assert_not_reached ();
1563         }
1564 }
1565
1566 const char*
1567 sgen_generation_name (int generation)
1568 {
1569         return generation_name (generation);
1570 }
1571
1572 SgenObjectOperations *
1573 sgen_get_current_object_ops (void){
1574         return &current_object_ops;
1575 }
1576
1577
1578 static void
1579 finish_gray_stack (int generation, GrayQueue *queue)
1580 {
1581         TV_DECLARE (atv);
1582         TV_DECLARE (btv);
1583         int done_with_ephemerons, ephemeron_rounds = 0;
1584         CopyOrMarkObjectFunc copy_func = current_object_ops.copy_or_mark_object;
1585         ScanObjectFunc scan_func = current_object_ops.scan_object;
1586         ScanCopyContext ctx = { scan_func, copy_func, queue };
1587         char *start_addr = generation == GENERATION_NURSERY ? sgen_get_nursery_start () : NULL;
1588         char *end_addr = generation == GENERATION_NURSERY ? sgen_get_nursery_end () : (char*)-1;
1589
1590         /*
1591          * We copied all the reachable objects. Now it's the time to copy
1592          * the objects that were not referenced by the roots, but by the copied objects.
1593          * we built a stack of objects pointed to by gray_start: they are
1594          * additional roots and we may add more items as we go.
1595          * We loop until gray_start == gray_objects which means no more objects have
1596          * been added. Note this is iterative: no recursion is involved.
1597          * We need to walk the LO list as well in search of marked big objects
1598          * (use a flag since this is needed only on major collections). We need to loop
1599          * here as well, so keep a counter of marked LO (increasing it in copy_object).
1600          *   To achieve better cache locality and cache usage, we drain the gray stack
1601          * frequently, after each object is copied, and just finish the work here.
1602          */
1603         sgen_drain_gray_stack (-1, ctx);
1604         TV_GETTIME (atv);
1605         SGEN_LOG (2, "%s generation done", generation_name (generation));
1606
1607         /*
1608         Reset bridge data, we might have lingering data from a previous collection if this is a major
1609         collection trigged by minor overflow.
1610
1611         We must reset the gathered bridges since their original block might be evacuated due to major
1612         fragmentation in the meanwhile and the bridge code should not have to deal with that.
1613         */
1614         if (sgen_need_bridge_processing ())
1615                 sgen_bridge_reset_data ();
1616
1617         /*
1618          * Walk the ephemeron tables marking all values with reachable keys. This must be completely done
1619          * before processing finalizable objects and non-tracking weak links to avoid finalizing/clearing
1620          * objects that are in fact reachable.
1621          */
1622         done_with_ephemerons = 0;
1623         do {
1624                 done_with_ephemerons = mark_ephemerons_in_range (ctx);
1625                 sgen_drain_gray_stack (-1, ctx);
1626                 ++ephemeron_rounds;
1627         } while (!done_with_ephemerons);
1628
1629         sgen_mark_togglerefs (start_addr, end_addr, ctx);
1630
1631         if (sgen_need_bridge_processing ()) {
1632                 /*Make sure the gray stack is empty before we process bridge objects so we get liveness right*/
1633                 sgen_drain_gray_stack (-1, ctx);
1634                 sgen_collect_bridge_objects (generation, ctx);
1635                 if (generation == GENERATION_OLD)
1636                         sgen_collect_bridge_objects (GENERATION_NURSERY, ctx);
1637
1638                 /*
1639                 Do the first bridge step here, as the collector liveness state will become useless after that.
1640
1641                 An important optimization is to only proccess the possibly dead part of the object graph and skip
1642                 over all live objects as we transitively know everything they point must be alive too.
1643
1644                 The above invariant is completely wrong if we let the gray queue be drained and mark/copy everything.
1645
1646                 This has the unfortunate side effect of making overflow collections perform the first step twice, but
1647                 given we now have heuristics that perform major GC in anticipation of minor overflows this should not
1648                 be a big deal.
1649                 */
1650                 sgen_bridge_processing_stw_step ();
1651         }
1652
1653         /*
1654         Make sure we drain the gray stack before processing disappearing links and finalizers.
1655         If we don't make sure it is empty we might wrongly see a live object as dead.
1656         */
1657         sgen_drain_gray_stack (-1, ctx);
1658
1659         /*
1660         We must clear weak links that don't track resurrection before processing object ready for
1661         finalization so they can be cleared before that.
1662         */
1663         sgen_null_link_in_range (generation, TRUE, ctx);
1664         if (generation == GENERATION_OLD)
1665                 sgen_null_link_in_range (GENERATION_NURSERY, TRUE, ctx);
1666
1667
1668         /* walk the finalization queue and move also the objects that need to be
1669          * finalized: use the finalized objects as new roots so the objects they depend
1670          * on are also not reclaimed. As with the roots above, only objects in the nursery
1671          * are marked/copied.
1672          */
1673         sgen_finalize_in_range (generation, ctx);
1674         if (generation == GENERATION_OLD)
1675                 sgen_finalize_in_range (GENERATION_NURSERY, ctx);
1676         /* drain the new stack that might have been created */
1677         SGEN_LOG (6, "Precise scan of gray area post fin");
1678         sgen_drain_gray_stack (-1, ctx);
1679
1680         /*
1681          * This must be done again after processing finalizable objects since CWL slots are cleared only after the key is finalized.
1682          */
1683         done_with_ephemerons = 0;
1684         do {
1685                 done_with_ephemerons = mark_ephemerons_in_range (ctx);
1686                 sgen_drain_gray_stack (-1, ctx);
1687                 ++ephemeron_rounds;
1688         } while (!done_with_ephemerons);
1689
1690         /*
1691          * Clear ephemeron pairs with unreachable keys.
1692          * We pass the copy func so we can figure out if an array was promoted or not.
1693          */
1694         clear_unreachable_ephemerons (ctx);
1695
1696         /*
1697          * We clear togglerefs only after all possible chances of revival are done.
1698          * This is semantically more inline with what users expect and it allows for
1699          * user finalizers to correctly interact with TR objects.
1700         */
1701         sgen_clear_togglerefs (start_addr, end_addr, ctx);
1702
1703         TV_GETTIME (btv);
1704         SGEN_LOG (2, "Finalize queue handling scan for %s generation: %d usecs %d ephemeron rounds", generation_name (generation), TV_ELAPSED (atv, btv), ephemeron_rounds);
1705
1706         /*
1707          * handle disappearing links
1708          * Note we do this after checking the finalization queue because if an object
1709          * survives (at least long enough to be finalized) we don't clear the link.
1710          * This also deals with a possible issue with the monitor reclamation: with the Boehm
1711          * GC a finalized object my lose the monitor because it is cleared before the finalizer is
1712          * called.
1713          */
1714         g_assert (sgen_gray_object_queue_is_empty (queue));
1715         for (;;) {
1716                 sgen_null_link_in_range (generation, FALSE, ctx);
1717                 if (generation == GENERATION_OLD)
1718                         sgen_null_link_in_range (GENERATION_NURSERY, FALSE, ctx);
1719                 if (sgen_gray_object_queue_is_empty (queue))
1720                         break;
1721                 sgen_drain_gray_stack (-1, ctx);
1722         }
1723
1724         g_assert (sgen_gray_object_queue_is_empty (queue));
1725
1726         sgen_gray_object_queue_trim_free_list (queue);
1727 }
1728
1729 void
1730 sgen_check_section_scan_starts (GCMemSection *section)
1731 {
1732         size_t i;
1733         for (i = 0; i < section->num_scan_start; ++i) {
1734                 if (section->scan_starts [i]) {
1735                         mword size = safe_object_get_size ((MonoObject*) section->scan_starts [i]);
1736                         g_assert (size >= sizeof (MonoObject) && size <= MAX_SMALL_OBJ_SIZE);
1737                 }
1738         }
1739 }
1740
1741 static void
1742 check_scan_starts (void)
1743 {
1744         if (!do_scan_starts_check)
1745                 return;
1746         sgen_check_section_scan_starts (nursery_section);
1747         major_collector.check_scan_starts ();
1748 }
1749
1750 static void
1751 scan_from_registered_roots (char *addr_start, char *addr_end, int root_type, ScanCopyContext ctx)
1752 {
1753         void **start_root;
1754         RootRecord *root;
1755         SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], start_root, root) {
1756                 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
1757                 precisely_scan_objects_from (start_root, (void**)root->end_root, addr_start, addr_end, root->root_desc, ctx);
1758         } SGEN_HASH_TABLE_FOREACH_END;
1759 }
1760
1761 void
1762 sgen_dump_occupied (char *start, char *end, char *section_start)
1763 {
1764         fprintf (heap_dump_file, "<occupied offset=\"%td\" size=\"%td\"/>\n", start - section_start, end - start);
1765 }
1766
1767 void
1768 sgen_dump_section (GCMemSection *section, const char *type)
1769 {
1770         char *start = section->data;
1771         char *end = section->data + section->size;
1772         char *occ_start = NULL;
1773         GCVTable *vt;
1774         char *old_start G_GNUC_UNUSED = NULL; /* just for debugging */
1775
1776         fprintf (heap_dump_file, "<section type=\"%s\" size=\"%lu\">\n", type, (unsigned long)section->size);
1777
1778         while (start < end) {
1779                 guint size;
1780                 MonoClass *class G_GNUC_UNUSED;
1781
1782                 if (!*(void**)start) {
1783                         if (occ_start) {
1784                                 sgen_dump_occupied (occ_start, start, section->data);
1785                                 occ_start = NULL;
1786                         }
1787                         start += sizeof (void*); /* should be ALLOC_ALIGN, really */
1788                         continue;
1789                 }
1790                 g_assert (start < section->next_data);
1791
1792                 if (!occ_start)
1793                         occ_start = start;
1794
1795                 vt = (GCVTable*)LOAD_VTABLE (start);
1796                 class = vt->klass;
1797
1798                 size = ALIGN_UP (safe_object_get_size ((MonoObject*) start));
1799
1800                 /*
1801                 fprintf (heap_dump_file, "<object offset=\"%d\" class=\"%s.%s\" size=\"%d\"/>\n",
1802                                 start - section->data,
1803                                 vt->klass->name_space, vt->klass->name,
1804                                 size);
1805                 */
1806
1807                 old_start = start;
1808                 start += size;
1809         }
1810         if (occ_start)
1811                 sgen_dump_occupied (occ_start, start, section->data);
1812
1813         fprintf (heap_dump_file, "</section>\n");
1814 }
1815
1816 static void
1817 dump_object (MonoObject *obj, gboolean dump_location)
1818 {
1819         static char class_name [1024];
1820
1821         MonoClass *class = mono_object_class (obj);
1822         int i, j;
1823
1824         /*
1825          * Python's XML parser is too stupid to parse angle brackets
1826          * in strings, so we just ignore them;
1827          */
1828         i = j = 0;
1829         while (class->name [i] && j < sizeof (class_name) - 1) {
1830                 if (!strchr ("<>\"", class->name [i]))
1831                         class_name [j++] = class->name [i];
1832                 ++i;
1833         }
1834         g_assert (j < sizeof (class_name));
1835         class_name [j] = 0;
1836
1837         fprintf (heap_dump_file, "<object class=\"%s.%s\" size=\"%zd\"",
1838                         class->name_space, class_name,
1839                         safe_object_get_size (obj));
1840         if (dump_location) {
1841                 const char *location;
1842                 if (ptr_in_nursery (obj))
1843                         location = "nursery";
1844                 else if (safe_object_get_size (obj) <= MAX_SMALL_OBJ_SIZE)
1845                         location = "major";
1846                 else
1847                         location = "LOS";
1848                 fprintf (heap_dump_file, " location=\"%s\"", location);
1849         }
1850         fprintf (heap_dump_file, "/>\n");
1851 }
1852
1853 static void
1854 dump_heap (const char *type, int num, const char *reason)
1855 {
1856         ObjectList *list;
1857         LOSObject *bigobj;
1858
1859         fprintf (heap_dump_file, "<collection type=\"%s\" num=\"%d\"", type, num);
1860         if (reason)
1861                 fprintf (heap_dump_file, " reason=\"%s\"", reason);
1862         fprintf (heap_dump_file, ">\n");
1863         fprintf (heap_dump_file, "<other-mem-usage type=\"mempools\" size=\"%ld\"/>\n", mono_mempool_get_bytes_allocated ());
1864         sgen_dump_internal_mem_usage (heap_dump_file);
1865         fprintf (heap_dump_file, "<pinned type=\"stack\" bytes=\"%zu\"/>\n", sgen_pin_stats_get_pinned_byte_count (PIN_TYPE_STACK));
1866         /* fprintf (heap_dump_file, "<pinned type=\"static-data\" bytes=\"%d\"/>\n", pinned_byte_counts [PIN_TYPE_STATIC_DATA]); */
1867         fprintf (heap_dump_file, "<pinned type=\"other\" bytes=\"%zu\"/>\n", sgen_pin_stats_get_pinned_byte_count (PIN_TYPE_OTHER));
1868
1869         fprintf (heap_dump_file, "<pinned-objects>\n");
1870         for (list = sgen_pin_stats_get_object_list (); list; list = list->next)
1871                 dump_object (list->obj, TRUE);
1872         fprintf (heap_dump_file, "</pinned-objects>\n");
1873
1874         sgen_dump_section (nursery_section, "nursery");
1875
1876         major_collector.dump_heap (heap_dump_file);
1877
1878         fprintf (heap_dump_file, "<los>\n");
1879         for (bigobj = los_object_list; bigobj; bigobj = bigobj->next)
1880                 dump_object ((MonoObject*)bigobj->data, FALSE);
1881         fprintf (heap_dump_file, "</los>\n");
1882
1883         fprintf (heap_dump_file, "</collection>\n");
1884 }
1885
1886 void
1887 sgen_register_moved_object (void *obj, void *destination)
1888 {
1889         g_assert (mono_profiler_events & MONO_PROFILE_GC_MOVES);
1890
1891         if (moved_objects_idx == MOVED_OBJECTS_NUM) {
1892                 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
1893                 moved_objects_idx = 0;
1894         }
1895         moved_objects [moved_objects_idx++] = obj;
1896         moved_objects [moved_objects_idx++] = destination;
1897 }
1898
1899 static void
1900 init_stats (void)
1901 {
1902         static gboolean inited = FALSE;
1903
1904         if (inited)
1905                 return;
1906
1907         mono_counters_register ("Collection max time",  MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME | MONO_COUNTER_MONOTONIC, &time_max);
1908
1909         mono_counters_register ("Minor fragment clear", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_pre_collection_fragment_clear);
1910         mono_counters_register ("Minor pinning", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_pinning);
1911         mono_counters_register ("Minor scan remembered set", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_remsets);
1912         mono_counters_register ("Minor scan pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_pinned);
1913         mono_counters_register ("Minor scan registered roots", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_registered_roots);
1914         mono_counters_register ("Minor scan thread data", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_scan_thread_data);
1915         mono_counters_register ("Minor finish gray stack", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_finish_gray_stack);
1916         mono_counters_register ("Minor fragment creation", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_minor_fragment_creation);
1917
1918         mono_counters_register ("Major fragment clear", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_pre_collection_fragment_clear);
1919         mono_counters_register ("Major pinning", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_pinning);
1920         mono_counters_register ("Major scan pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_pinned);
1921         mono_counters_register ("Major scan registered roots", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_registered_roots);
1922         mono_counters_register ("Major scan thread data", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_thread_data);
1923         mono_counters_register ("Major scan alloc_pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_alloc_pinned);
1924         mono_counters_register ("Major scan finalized", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_finalized);
1925         mono_counters_register ("Major scan big objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_scan_big_objects);
1926         mono_counters_register ("Major finish gray stack", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_finish_gray_stack);
1927         mono_counters_register ("Major free big objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_free_bigobjs);
1928         mono_counters_register ("Major LOS sweep", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_los_sweep);
1929         mono_counters_register ("Major sweep", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_sweep);
1930         mono_counters_register ("Major fragment creation", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &time_major_fragment_creation);
1931
1932         mono_counters_register ("Number of pinned objects", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_pinned_objects);
1933
1934 #ifdef HEAVY_STATISTICS
1935         mono_counters_register ("WBarrier remember pointer", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_add_to_global_remset);
1936         mono_counters_register ("WBarrier set field", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_set_field);
1937         mono_counters_register ("WBarrier set arrayref", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_set_arrayref);
1938         mono_counters_register ("WBarrier arrayref copy", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_arrayref_copy);
1939         mono_counters_register ("WBarrier generic store called", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_generic_store);
1940         mono_counters_register ("WBarrier generic atomic store called", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_generic_store_atomic);
1941         mono_counters_register ("WBarrier set root", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_set_root);
1942         mono_counters_register ("WBarrier value copy", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_value_copy);
1943         mono_counters_register ("WBarrier object copy", MONO_COUNTER_GC | MONO_COUNTER_INT, &stat_wbarrier_object_copy);
1944
1945         mono_counters_register ("# objects allocated degraded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_alloced_degraded);
1946         mono_counters_register ("bytes allocated degraded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_bytes_alloced_degraded);
1947
1948         mono_counters_register ("# copy_object() called (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copy_object_called_nursery);
1949         mono_counters_register ("# objects copied (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_copied_nursery);
1950         mono_counters_register ("# copy_object() called (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_copy_object_called_major);
1951         mono_counters_register ("# objects copied (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_objects_copied_major);
1952
1953         mono_counters_register ("# scan_object() called (nursery)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scan_object_called_nursery);
1954         mono_counters_register ("# scan_object() called (major)", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_scan_object_called_major);
1955
1956         mono_counters_register ("Slots allocated in vain", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_slots_allocated_in_vain);
1957
1958         mono_counters_register ("# nursery copy_object() failed from space", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_from_space);
1959         mono_counters_register ("# nursery copy_object() failed forwarded", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_forwarded);
1960         mono_counters_register ("# nursery copy_object() failed pinned", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_pinned);
1961         mono_counters_register ("# nursery copy_object() failed to space", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_nursery_copy_object_failed_to_space);
1962
1963         sgen_nursery_allocator_init_heavy_stats ();
1964         sgen_alloc_init_heavy_stats ();
1965 #endif
1966
1967         inited = TRUE;
1968 }
1969
1970
1971 static void
1972 reset_pinned_from_failed_allocation (void)
1973 {
1974         bytes_pinned_from_failed_allocation = 0;
1975 }
1976
1977 void
1978 sgen_set_pinned_from_failed_allocation (mword objsize)
1979 {
1980         bytes_pinned_from_failed_allocation += objsize;
1981 }
1982
1983 gboolean
1984 sgen_collection_is_concurrent (void)
1985 {
1986         switch (current_collection_generation) {
1987         case GENERATION_NURSERY:
1988                 return FALSE;
1989         case GENERATION_OLD:
1990                 return concurrent_collection_in_progress;
1991         default:
1992                 g_error ("Invalid current generation %d", current_collection_generation);
1993         }
1994 }
1995
1996 gboolean
1997 sgen_concurrent_collection_in_progress (void)
1998 {
1999         return concurrent_collection_in_progress;
2000 }
2001
2002 static void
2003 job_remembered_set_scan (WorkerData *worker_data, void *dummy)
2004 {
2005         remset.scan_remsets (sgen_workers_get_job_gray_queue (worker_data));
2006 }
2007
2008 typedef struct
2009 {
2010         CopyOrMarkObjectFunc copy_or_mark_func;
2011         ScanObjectFunc scan_func;
2012         char *heap_start;
2013         char *heap_end;
2014         int root_type;
2015 } ScanFromRegisteredRootsJobData;
2016
2017 static void
2018 job_scan_from_registered_roots (WorkerData *worker_data, void *job_data_untyped)
2019 {
2020         ScanFromRegisteredRootsJobData *job_data = job_data_untyped;
2021         ScanCopyContext ctx = { job_data->scan_func, job_data->copy_or_mark_func,
2022                 sgen_workers_get_job_gray_queue (worker_data) };
2023
2024         scan_from_registered_roots (job_data->heap_start, job_data->heap_end, job_data->root_type, ctx);
2025         sgen_free_internal_dynamic (job_data, sizeof (ScanFromRegisteredRootsJobData), INTERNAL_MEM_WORKER_JOB_DATA);
2026 }
2027
2028 typedef struct
2029 {
2030         char *heap_start;
2031         char *heap_end;
2032 } ScanThreadDataJobData;
2033
2034 static void
2035 job_scan_thread_data (WorkerData *worker_data, void *job_data_untyped)
2036 {
2037         ScanThreadDataJobData *job_data = job_data_untyped;
2038
2039         scan_thread_data (job_data->heap_start, job_data->heap_end, TRUE,
2040                         sgen_workers_get_job_gray_queue (worker_data));
2041         sgen_free_internal_dynamic (job_data, sizeof (ScanThreadDataJobData), INTERNAL_MEM_WORKER_JOB_DATA);
2042 }
2043
2044 static void
2045 job_scan_finalizer_entries (WorkerData *worker_data, void *job_data_untyped)
2046 {
2047         FinalizeReadyEntry *list = job_data_untyped;
2048         ScanCopyContext ctx = { NULL, current_object_ops.copy_or_mark_object, sgen_workers_get_job_gray_queue (worker_data) };
2049
2050         scan_finalizer_entries (list, ctx);
2051 }
2052
2053 static void
2054 job_scan_major_mod_union_cardtable (WorkerData *worker_data, void *job_data_untyped)
2055 {
2056         g_assert (concurrent_collection_in_progress);
2057         major_collector.scan_card_table (TRUE, sgen_workers_get_job_gray_queue (worker_data));
2058 }
2059
2060 static void
2061 job_scan_los_mod_union_cardtable (WorkerData *worker_data, void *job_data_untyped)
2062 {
2063         g_assert (concurrent_collection_in_progress);
2064         sgen_los_scan_card_table (TRUE, sgen_workers_get_job_gray_queue (worker_data));
2065 }
2066
2067 static void
2068 verify_scan_starts (char *start, char *end)
2069 {
2070         size_t i;
2071
2072         for (i = 0; i < nursery_section->num_scan_start; ++i) {
2073                 char *addr = nursery_section->scan_starts [i];
2074                 if (addr > start && addr < end)
2075                         SGEN_LOG (1, "NFC-BAD SCAN START [%zu] %p for obj [%p %p]", i, addr, start, end);
2076         }
2077 }
2078
2079 static void
2080 verify_nursery (void)
2081 {
2082         char *start, *end, *cur, *hole_start;
2083
2084         if (!do_verify_nursery)
2085                 return;
2086
2087         if (nursery_canaries_enabled ())
2088                 SGEN_LOG (1, "Checking nursery canaries...");
2089
2090         /*This cleans up unused fragments */
2091         sgen_nursery_allocator_prepare_for_pinning ();
2092
2093         hole_start = start = cur = sgen_get_nursery_start ();
2094         end = sgen_get_nursery_end ();
2095
2096         while (cur < end) {
2097                 size_t ss, size;
2098
2099                 if (!*(void**)cur) {
2100                         cur += sizeof (void*);
2101                         continue;
2102                 }
2103
2104                 if (object_is_forwarded (cur))
2105                         SGEN_LOG (1, "FORWARDED OBJ %p", cur);
2106                 else if (object_is_pinned (cur))
2107                         SGEN_LOG (1, "PINNED OBJ %p", cur);
2108
2109                 ss = safe_object_get_size ((MonoObject*)cur);
2110                 size = ALIGN_UP (safe_object_get_size ((MonoObject*)cur));
2111                 verify_scan_starts (cur, cur + size);
2112                 if (do_dump_nursery_content) {
2113                         if (cur > hole_start)
2114                                 SGEN_LOG (1, "HOLE [%p %p %d]", hole_start, cur, (int)(cur - hole_start));
2115                         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 ());
2116                 }
2117                 if (nursery_canaries_enabled () && (MonoVTable*)SGEN_LOAD_VTABLE (cur) != array_fill_vtable) {
2118                         CHECK_CANARY_FOR_OBJECT (cur);
2119                         CANARIFY_SIZE (size);
2120                 }
2121                 cur += size;
2122                 hole_start = cur;
2123         }
2124 }
2125
2126 /*
2127  * Checks that no objects in the nursery are fowarded or pinned.  This
2128  * is a precondition to restarting the mutator while doing a
2129  * concurrent collection.  Note that we don't clear fragments because
2130  * we depend on that having happened earlier.
2131  */
2132 static void
2133 check_nursery_is_clean (void)
2134 {
2135         char *end, *cur;
2136
2137         cur = sgen_get_nursery_start ();
2138         end = sgen_get_nursery_end ();
2139
2140         while (cur < end) {
2141                 size_t size;
2142
2143                 if (!*(void**)cur) {
2144                         cur += sizeof (void*);
2145                         continue;
2146                 }
2147
2148                 g_assert (!object_is_forwarded (cur));
2149                 g_assert (!object_is_pinned (cur));
2150
2151                 size = ALIGN_UP (safe_object_get_size ((MonoObject*)cur));
2152                 verify_scan_starts (cur, cur + size);
2153
2154                 cur += size;
2155         }
2156 }
2157
2158 static void
2159 init_gray_queue (void)
2160 {
2161         if (sgen_collection_is_concurrent ())
2162                 sgen_workers_init_distribute_gray_queue ();
2163         sgen_gray_object_queue_init (&gray_queue, NULL);
2164 }
2165
2166 /*
2167  * Perform a nursery collection.
2168  *
2169  * Return whether any objects were late-pinned due to being out of memory.
2170  */
2171 static gboolean
2172 collect_nursery (SgenGrayQueue *unpin_queue, gboolean finish_up_concurrent_mark)
2173 {
2174         gboolean needs_major;
2175         size_t max_garbage_amount;
2176         char *nursery_next;
2177         ScanFromRegisteredRootsJobData *scrrjd_normal, *scrrjd_wbarrier;
2178         ScanThreadDataJobData *stdjd;
2179         mword fragment_total;
2180         ScanCopyContext ctx;
2181         TV_DECLARE (atv);
2182         TV_DECLARE (btv);
2183
2184         if (disable_minor_collections)
2185                 return TRUE;
2186
2187         TV_GETTIME (last_minor_collection_start_tv);
2188         atv = last_minor_collection_start_tv;
2189
2190         MONO_GC_BEGIN (GENERATION_NURSERY);
2191         binary_protocol_collection_begin (gc_stats.minor_gc_count, GENERATION_NURSERY);
2192
2193         verify_nursery ();
2194
2195 #ifndef DISABLE_PERFCOUNTERS
2196         mono_perfcounters->gc_collections0++;
2197 #endif
2198
2199         current_collection_generation = GENERATION_NURSERY;
2200         current_object_ops = sgen_minor_collector.serial_ops;
2201
2202         reset_pinned_from_failed_allocation ();
2203
2204         check_scan_starts ();
2205
2206         sgen_nursery_alloc_prepare_for_minor ();
2207
2208         degraded_mode = 0;
2209         objects_pinned = 0;
2210         nursery_next = sgen_nursery_alloc_get_upper_alloc_bound ();
2211         /* FIXME: optimize later to use the higher address where an object can be present */
2212         nursery_next = MAX (nursery_next, sgen_get_nursery_end ());
2213
2214         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 ()));
2215         max_garbage_amount = nursery_next - sgen_get_nursery_start ();
2216         g_assert (nursery_section->size >= max_garbage_amount);
2217
2218         /* world must be stopped already */
2219         TV_GETTIME (btv);
2220         time_minor_pre_collection_fragment_clear += TV_ELAPSED (atv, btv);
2221
2222         if (xdomain_checks) {
2223                 sgen_clear_nursery_fragments ();
2224                 sgen_check_for_xdomain_refs ();
2225         }
2226
2227         nursery_section->next_data = nursery_next;
2228
2229         major_collector.start_nursery_collection ();
2230
2231         sgen_memgov_minor_collection_start ();
2232
2233         init_gray_queue ();
2234
2235         gc_stats.minor_gc_count ++;
2236
2237         if (whole_heap_check_before_collection) {
2238                 sgen_clear_nursery_fragments ();
2239                 sgen_check_whole_heap (finish_up_concurrent_mark);
2240         }
2241         if (consistency_check_at_minor_collection)
2242                 sgen_check_consistency ();
2243
2244         MONO_GC_CHECKPOINT_1 (GENERATION_NURSERY);
2245
2246         sgen_process_fin_stage_entries ();
2247         sgen_process_dislink_stage_entries ();
2248
2249         MONO_GC_CHECKPOINT_2 (GENERATION_NURSERY);
2250
2251         /* pin from pinned handles */
2252         sgen_init_pinning ();
2253         mono_profiler_gc_event (MONO_GC_EVENT_MARK_START, 0);
2254         pin_from_roots (sgen_get_nursery_start (), nursery_next, WORKERS_DISTRIBUTE_GRAY_QUEUE);
2255         /* pin cemented objects */
2256         sgen_pin_cemented_objects ();
2257         /* identify pinned objects */
2258         sgen_optimize_pin_queue ();
2259         sgen_pinning_setup_section (nursery_section);
2260         ctx.scan_func = NULL;
2261         ctx.copy_func = NULL;
2262         ctx.queue = WORKERS_DISTRIBUTE_GRAY_QUEUE;
2263         pin_objects_in_nursery (ctx);
2264         sgen_pinning_trim_queue_to_section (nursery_section);
2265
2266         TV_GETTIME (atv);
2267         time_minor_pinning += TV_ELAPSED (btv, atv);
2268         SGEN_LOG (2, "Finding pinned pointers: %zd in %d usecs", sgen_get_pinned_count (), TV_ELAPSED (btv, atv));
2269         SGEN_LOG (4, "Start scan with %zd pinned objects", sgen_get_pinned_count ());
2270
2271         MONO_GC_CHECKPOINT_3 (GENERATION_NURSERY);
2272
2273         /*
2274          * FIXME: When we finish a concurrent collection we do a nursery collection first,
2275          * as part of which we scan the card table.  Then, later, we scan the mod union
2276          * cardtable.  We should only have to do one.
2277          */
2278         sgen_workers_enqueue_job ("scan remset", job_remembered_set_scan, NULL);
2279
2280         /* we don't have complete write barrier yet, so we scan all the old generation sections */
2281         TV_GETTIME (btv);
2282         time_minor_scan_remsets += TV_ELAPSED (atv, btv);
2283         SGEN_LOG (2, "Old generation scan: %d usecs", TV_ELAPSED (atv, btv));
2284
2285         MONO_GC_CHECKPOINT_4 (GENERATION_NURSERY);
2286
2287         /* FIXME: why is this here? */
2288         ctx.scan_func = current_object_ops.scan_object;
2289         ctx.copy_func = NULL;
2290         ctx.queue = &gray_queue;
2291         sgen_drain_gray_stack (-1, ctx);
2292
2293         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2294                 report_registered_roots ();
2295         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2296                 report_finalizer_roots ();
2297         TV_GETTIME (atv);
2298         time_minor_scan_pinned += TV_ELAPSED (btv, atv);
2299
2300         MONO_GC_CHECKPOINT_5 (GENERATION_NURSERY);
2301
2302         /* registered roots, this includes static fields */
2303         scrrjd_normal = sgen_alloc_internal_dynamic (sizeof (ScanFromRegisteredRootsJobData), INTERNAL_MEM_WORKER_JOB_DATA, TRUE);
2304         scrrjd_normal->copy_or_mark_func = current_object_ops.copy_or_mark_object;
2305         scrrjd_normal->scan_func = current_object_ops.scan_object;
2306         scrrjd_normal->heap_start = sgen_get_nursery_start ();
2307         scrrjd_normal->heap_end = nursery_next;
2308         scrrjd_normal->root_type = ROOT_TYPE_NORMAL;
2309         sgen_workers_enqueue_job ("scan from registered roots normal", job_scan_from_registered_roots, scrrjd_normal);
2310
2311         scrrjd_wbarrier = sgen_alloc_internal_dynamic (sizeof (ScanFromRegisteredRootsJobData), INTERNAL_MEM_WORKER_JOB_DATA, TRUE);
2312         scrrjd_wbarrier->copy_or_mark_func = current_object_ops.copy_or_mark_object;
2313         scrrjd_wbarrier->scan_func = current_object_ops.scan_object;
2314         scrrjd_wbarrier->heap_start = sgen_get_nursery_start ();
2315         scrrjd_wbarrier->heap_end = nursery_next;
2316         scrrjd_wbarrier->root_type = ROOT_TYPE_WBARRIER;
2317         sgen_workers_enqueue_job ("scan from registered roots wbarrier", job_scan_from_registered_roots, scrrjd_wbarrier);
2318
2319         TV_GETTIME (btv);
2320         time_minor_scan_registered_roots += TV_ELAPSED (atv, btv);
2321
2322         MONO_GC_CHECKPOINT_6 (GENERATION_NURSERY);
2323
2324         /* thread data */
2325         stdjd = sgen_alloc_internal_dynamic (sizeof (ScanThreadDataJobData), INTERNAL_MEM_WORKER_JOB_DATA, TRUE);
2326         stdjd->heap_start = sgen_get_nursery_start ();
2327         stdjd->heap_end = nursery_next;
2328         sgen_workers_enqueue_job ("scan thread data", job_scan_thread_data, stdjd);
2329
2330         TV_GETTIME (atv);
2331         time_minor_scan_thread_data += TV_ELAPSED (btv, atv);
2332         btv = atv;
2333
2334         MONO_GC_CHECKPOINT_7 (GENERATION_NURSERY);
2335
2336         g_assert (!sgen_collection_is_concurrent ());
2337
2338         /* Scan the list of objects ready for finalization. If */
2339         sgen_workers_enqueue_job ("scan finalizer entries", job_scan_finalizer_entries, fin_ready_list);
2340         sgen_workers_enqueue_job ("scan criticial finalizer entries", job_scan_finalizer_entries, critical_fin_list);
2341
2342         MONO_GC_CHECKPOINT_8 (GENERATION_NURSERY);
2343
2344         finish_gray_stack (GENERATION_NURSERY, &gray_queue);
2345         TV_GETTIME (atv);
2346         time_minor_finish_gray_stack += TV_ELAPSED (btv, atv);
2347         mono_profiler_gc_event (MONO_GC_EVENT_MARK_END, 0);
2348
2349         MONO_GC_CHECKPOINT_9 (GENERATION_NURSERY);
2350
2351         /*
2352          * The (single-threaded) finalization code might have done
2353          * some copying/marking so we can only reset the GC thread's
2354          * worker data here instead of earlier when we joined the
2355          * workers.
2356          */
2357         sgen_workers_reset_data ();
2358
2359         if (objects_pinned) {
2360                 sgen_optimize_pin_queue ();
2361                 sgen_pinning_setup_section (nursery_section);
2362         }
2363
2364         /* walk the pin_queue, build up the fragment list of free memory, unmark
2365          * pinned objects as we go, memzero() the empty fragments so they are ready for the
2366          * next allocations.
2367          */
2368         mono_profiler_gc_event (MONO_GC_EVENT_RECLAIM_START, 0);
2369         fragment_total = sgen_build_nursery_fragments (nursery_section, unpin_queue);
2370         if (!fragment_total)
2371                 degraded_mode = 1;
2372
2373         /* Clear TLABs for all threads */
2374         sgen_clear_tlabs ();
2375
2376         mono_profiler_gc_event (MONO_GC_EVENT_RECLAIM_END, 0);
2377         TV_GETTIME (btv);
2378         time_minor_fragment_creation += TV_ELAPSED (atv, btv);
2379         SGEN_LOG (2, "Fragment creation: %d usecs, %lu bytes available", TV_ELAPSED (atv, btv), (unsigned long)fragment_total);
2380
2381         if (consistency_check_at_minor_collection)
2382                 sgen_check_major_refs ();
2383
2384         major_collector.finish_nursery_collection ();
2385
2386         TV_GETTIME (last_minor_collection_end_tv);
2387         gc_stats.minor_gc_time += TV_ELAPSED (last_minor_collection_start_tv, last_minor_collection_end_tv);
2388
2389         if (heap_dump_file)
2390                 dump_heap ("minor", gc_stats.minor_gc_count - 1, NULL);
2391
2392         /* prepare the pin queue for the next collection */
2393         sgen_finish_pinning ();
2394         if (fin_ready_list || critical_fin_list) {
2395                 SGEN_LOG (4, "Finalizer-thread wakeup: ready %d", num_ready_finalizers);
2396                 mono_gc_finalize_notify ();
2397         }
2398         sgen_pin_stats_reset ();
2399         /* clear cemented hash */
2400         sgen_cement_clear_below_threshold ();
2401
2402         g_assert (sgen_gray_object_queue_is_empty (&gray_queue));
2403
2404         remset.finish_minor_collection ();
2405
2406         check_scan_starts ();
2407
2408         binary_protocol_flush_buffers (FALSE);
2409
2410         sgen_memgov_minor_collection_end ();
2411
2412         /*objects are late pinned because of lack of memory, so a major is a good call*/
2413         needs_major = objects_pinned > 0;
2414         current_collection_generation = -1;
2415         objects_pinned = 0;
2416
2417         MONO_GC_END (GENERATION_NURSERY);
2418         binary_protocol_collection_end (gc_stats.minor_gc_count - 1, GENERATION_NURSERY, 0, 0);
2419
2420         if (check_nursery_objects_pinned && !sgen_minor_collector.is_split)
2421                 sgen_check_nursery_objects_pinned (unpin_queue != NULL);
2422
2423         return needs_major;
2424 }
2425
2426 static void
2427 scan_nursery_objects_callback (char *obj, size_t size, ScanCopyContext *ctx)
2428 {
2429         /*
2430          * This is called on all objects in the nursery, including pinned ones, so we need
2431          * to use sgen_obj_get_descriptor_safe(), which masks out the vtable tag bits.
2432          */
2433         ctx->scan_func (obj, sgen_obj_get_descriptor_safe (obj), ctx->queue);
2434 }
2435
2436 static void
2437 scan_nursery_objects (ScanCopyContext ctx)
2438 {
2439         sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
2440                         (IterateObjectCallbackFunc)scan_nursery_objects_callback, (void*)&ctx, FALSE);
2441 }
2442
2443 static void
2444 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)
2445 {
2446         LOSObject *bigobj;
2447         TV_DECLARE (atv);
2448         TV_DECLARE (btv);
2449         /* FIXME: only use these values for the precise scan
2450          * note that to_space pointers should be excluded anyway...
2451          */
2452         char *heap_start = NULL;
2453         char *heap_end = (char*)-1;
2454         gboolean profile_roots = mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS;
2455         GCRootReport root_report = { 0 };
2456         ScanFromRegisteredRootsJobData *scrrjd_normal, *scrrjd_wbarrier;
2457         ScanThreadDataJobData *stdjd;
2458         ScanCopyContext ctx;
2459
2460         if (concurrent_collection_in_progress) {
2461                 /*This cleans up unused fragments */
2462                 sgen_nursery_allocator_prepare_for_pinning ();
2463
2464                 if (do_concurrent_checks)
2465                         check_nursery_is_clean ();
2466         } else {
2467                 /* The concurrent collector doesn't touch the nursery. */
2468                 sgen_nursery_alloc_prepare_for_major ();
2469         }
2470
2471         init_gray_queue ();
2472
2473         TV_GETTIME (atv);
2474
2475         /* Pinning depends on this */
2476         sgen_clear_nursery_fragments ();
2477
2478         if (whole_heap_check_before_collection)
2479                 sgen_check_whole_heap (finish_up_concurrent_mark);
2480
2481         TV_GETTIME (btv);
2482         time_major_pre_collection_fragment_clear += TV_ELAPSED (atv, btv);
2483
2484         if (!sgen_collection_is_concurrent ())
2485                 nursery_section->next_data = sgen_get_nursery_end ();
2486         /* we should also coalesce scanning from sections close to each other
2487          * and deal with pointers outside of the sections later.
2488          */
2489
2490         objects_pinned = 0;
2491
2492         if (xdomain_checks) {
2493                 sgen_clear_nursery_fragments ();
2494                 sgen_check_for_xdomain_refs ();
2495         }
2496
2497         if (!concurrent_collection_in_progress) {
2498                 /* Remsets are not useful for a major collection */
2499                 remset.clear_cards ();
2500         }
2501
2502         sgen_process_fin_stage_entries ();
2503         sgen_process_dislink_stage_entries ();
2504
2505         TV_GETTIME (atv);
2506         sgen_init_pinning ();
2507         SGEN_LOG (6, "Collecting pinned addresses");
2508         pin_from_roots ((void*)lowest_heap_address, (void*)highest_heap_address, WORKERS_DISTRIBUTE_GRAY_QUEUE);
2509
2510         if (!concurrent_collection_in_progress || finish_up_concurrent_mark) {
2511                 if (major_collector.is_concurrent) {
2512                         /*
2513                          * The concurrent major collector cannot evict
2514                          * yet, so we need to pin cemented objects to
2515                          * not break some asserts.
2516                          *
2517                          * FIXME: We could evict now!
2518                          */
2519                         sgen_pin_cemented_objects ();
2520                 }
2521         }
2522
2523         sgen_optimize_pin_queue ();
2524
2525         /*
2526          * pin_queue now contains all candidate pointers, sorted and
2527          * uniqued.  We must do two passes now to figure out which
2528          * objects are pinned.
2529          *
2530          * The first is to find within the pin_queue the area for each
2531          * section.  This requires that the pin_queue be sorted.  We
2532          * also process the LOS objects and pinned chunks here.
2533          *
2534          * The second, destructive, pass is to reduce the section
2535          * areas to pointers to the actually pinned objects.
2536          */
2537         SGEN_LOG (6, "Pinning from sections");
2538         /* first pass for the sections */
2539         sgen_find_section_pin_queue_start_end (nursery_section);
2540         /* identify possible pointers to the insize of large objects */
2541         SGEN_LOG (6, "Pinning from large objects");
2542         for (bigobj = los_object_list; bigobj; bigobj = bigobj->next) {
2543                 size_t dummy;
2544                 if (sgen_find_optimized_pin_queue_area (bigobj->data, (char*)bigobj->data + sgen_los_object_size (bigobj), &dummy, &dummy)) {
2545                         binary_protocol_pin (bigobj->data, (gpointer)LOAD_VTABLE (bigobj->data), safe_object_get_size (((MonoObject*)(bigobj->data))));
2546
2547 #ifdef ENABLE_DTRACE
2548                         if (G_UNLIKELY (MONO_GC_OBJ_PINNED_ENABLED ())) {
2549                                 MonoVTable *vt = (MonoVTable*)LOAD_VTABLE (bigobj->data);
2550                                 MONO_GC_OBJ_PINNED ((mword)bigobj->data, sgen_safe_object_get_size ((MonoObject*)bigobj->data), vt->klass->name_space, vt->klass->name, GENERATION_OLD);
2551                         }
2552 #endif
2553
2554                         if (sgen_los_object_is_pinned (bigobj->data)) {
2555                                 g_assert (finish_up_concurrent_mark);
2556                                 continue;
2557                         }
2558                         sgen_los_pin_object (bigobj->data);
2559                         if (SGEN_OBJECT_HAS_REFERENCES (bigobj->data))
2560                                 GRAY_OBJECT_ENQUEUE (WORKERS_DISTRIBUTE_GRAY_QUEUE, bigobj->data, sgen_obj_get_descriptor (bigobj->data));
2561                         if (G_UNLIKELY (do_pin_stats))
2562                                 sgen_pin_stats_register_object ((char*) bigobj->data, safe_object_get_size ((MonoObject*) bigobj->data));
2563                         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));
2564
2565                         if (profile_roots)
2566                                 add_profile_gc_root (&root_report, bigobj->data, MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
2567                 }
2568         }
2569         if (profile_roots)
2570                 notify_gc_roots (&root_report);
2571         /* second pass for the sections */
2572         ctx.scan_func = concurrent_collection_in_progress ? current_object_ops.scan_object : NULL;
2573         ctx.copy_func = NULL;
2574         ctx.queue = WORKERS_DISTRIBUTE_GRAY_QUEUE;
2575
2576         /*
2577          * Concurrent mark never follows references into the nursery.  In the start and
2578          * finish pauses we must scan live nursery objects, though.
2579          *
2580          * In the finish pause we do this conservatively by scanning all nursery objects.
2581          * Previously we would only scan pinned objects here.  We assumed that all objects
2582          * that were pinned during the nursery collection immediately preceding this finish
2583          * mark would be pinned again here.  Due to the way we get the stack end for the GC
2584          * thread, however, that's not necessarily the case: we scan part of the stack used
2585          * by the GC itself, which changes constantly, so pinning isn't entirely
2586          * deterministic.
2587          *
2588          * The split nursery also complicates things because non-pinned objects can survive
2589          * in the nursery.  That's why we need to do a full scan of the nursery for it, too.
2590          *
2591          * In the future we shouldn't do a preceding nursery collection at all and instead
2592          * do the finish pause with promotion from the nursery.
2593          *
2594          * A further complication arises when we have late-pinned objects from the preceding
2595          * nursery collection.  Those are the result of being out of memory when trying to
2596          * evacuate objects.  They won't be found from the roots, so we just scan the whole
2597          * nursery.
2598          *
2599          * Non-concurrent mark evacuates from the nursery, so it's
2600          * sufficient to just scan pinned nursery objects.
2601          */
2602         if (scan_whole_nursery || finish_up_concurrent_mark || (concurrent_collection_in_progress && sgen_minor_collector.is_split)) {
2603                 scan_nursery_objects (ctx);
2604         } else {
2605                 pin_objects_in_nursery (ctx);
2606                 if (check_nursery_objects_pinned && !sgen_minor_collector.is_split)
2607                         sgen_check_nursery_objects_pinned (!concurrent_collection_in_progress || finish_up_concurrent_mark);
2608         }
2609
2610         major_collector.pin_objects (WORKERS_DISTRIBUTE_GRAY_QUEUE);
2611         if (old_next_pin_slot)
2612                 *old_next_pin_slot = sgen_get_pinned_count ();
2613
2614         TV_GETTIME (btv);
2615         time_major_pinning += TV_ELAPSED (atv, btv);
2616         SGEN_LOG (2, "Finding pinned pointers: %zd in %d usecs", sgen_get_pinned_count (), TV_ELAPSED (atv, btv));
2617         SGEN_LOG (4, "Start scan with %zd pinned objects", sgen_get_pinned_count ());
2618
2619         major_collector.init_to_space ();
2620
2621         /*
2622          * The concurrent collector doesn't move objects, neither on
2623          * the major heap nor in the nursery, so we can mark even
2624          * before pinning has finished.  For the non-concurrent
2625          * collector we start the workers after pinning.
2626          */
2627         if (start_concurrent_mark) {
2628                 sgen_workers_start_all_workers ();
2629                 gray_queue_enable_redirect (WORKERS_DISTRIBUTE_GRAY_QUEUE);
2630         }
2631
2632 #ifdef SGEN_DEBUG_INTERNAL_ALLOC
2633         main_gc_thread = mono_native_thread_self ();
2634 #endif
2635
2636         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2637                 report_registered_roots ();
2638         TV_GETTIME (atv);
2639         time_major_scan_pinned += TV_ELAPSED (btv, atv);
2640
2641         /* registered roots, this includes static fields */
2642         scrrjd_normal = sgen_alloc_internal_dynamic (sizeof (ScanFromRegisteredRootsJobData), INTERNAL_MEM_WORKER_JOB_DATA, TRUE);
2643         scrrjd_normal->copy_or_mark_func = current_object_ops.copy_or_mark_object;
2644         scrrjd_normal->scan_func = current_object_ops.scan_object;
2645         scrrjd_normal->heap_start = heap_start;
2646         scrrjd_normal->heap_end = heap_end;
2647         scrrjd_normal->root_type = ROOT_TYPE_NORMAL;
2648         sgen_workers_enqueue_job ("scan from registered roots normal", job_scan_from_registered_roots, scrrjd_normal);
2649
2650         scrrjd_wbarrier = sgen_alloc_internal_dynamic (sizeof (ScanFromRegisteredRootsJobData), INTERNAL_MEM_WORKER_JOB_DATA, TRUE);
2651         scrrjd_wbarrier->copy_or_mark_func = current_object_ops.copy_or_mark_object;
2652         scrrjd_wbarrier->scan_func = current_object_ops.scan_object;
2653         scrrjd_wbarrier->heap_start = heap_start;
2654         scrrjd_wbarrier->heap_end = heap_end;
2655         scrrjd_wbarrier->root_type = ROOT_TYPE_WBARRIER;
2656         sgen_workers_enqueue_job ("scan from registered roots wbarrier", job_scan_from_registered_roots, scrrjd_wbarrier);
2657
2658         TV_GETTIME (btv);
2659         time_major_scan_registered_roots += TV_ELAPSED (atv, btv);
2660
2661         /* Threads */
2662         stdjd = sgen_alloc_internal_dynamic (sizeof (ScanThreadDataJobData), INTERNAL_MEM_WORKER_JOB_DATA, TRUE);
2663         stdjd->heap_start = heap_start;
2664         stdjd->heap_end = heap_end;
2665         sgen_workers_enqueue_job ("scan thread data", job_scan_thread_data, stdjd);
2666
2667         TV_GETTIME (atv);
2668         time_major_scan_thread_data += TV_ELAPSED (btv, atv);
2669
2670         TV_GETTIME (btv);
2671         time_major_scan_alloc_pinned += TV_ELAPSED (atv, btv);
2672
2673         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2674                 report_finalizer_roots ();
2675
2676         /* scan the list of objects ready for finalization */
2677         sgen_workers_enqueue_job ("scan finalizer entries", job_scan_finalizer_entries, fin_ready_list);
2678         sgen_workers_enqueue_job ("scan critical finalizer entries", job_scan_finalizer_entries, critical_fin_list);
2679
2680         if (scan_mod_union) {
2681                 g_assert (finish_up_concurrent_mark);
2682
2683                 /* Mod union card table */
2684                 sgen_workers_enqueue_job ("scan mod union cardtable", job_scan_major_mod_union_cardtable, NULL);
2685                 sgen_workers_enqueue_job ("scan LOS mod union cardtable", job_scan_los_mod_union_cardtable, NULL);
2686         }
2687
2688         TV_GETTIME (atv);
2689         time_major_scan_finalized += TV_ELAPSED (btv, atv);
2690         SGEN_LOG (2, "Root scan: %d usecs", TV_ELAPSED (btv, atv));
2691
2692         TV_GETTIME (btv);
2693         time_major_scan_big_objects += TV_ELAPSED (atv, btv);
2694 }
2695
2696 static void
2697 major_finish_copy_or_mark (void)
2698 {
2699         if (!concurrent_collection_in_progress)
2700                 return;
2701
2702         /*
2703          * Prepare the pin queue for the next collection.  Since pinning runs on the worker
2704          * threads we must wait for the jobs to finish before we can reset it.
2705          */
2706         sgen_workers_wait_for_jobs_finished ();
2707         sgen_finish_pinning ();
2708
2709         sgen_pin_stats_reset ();
2710
2711         if (do_concurrent_checks)
2712                 check_nursery_is_clean ();
2713 }
2714
2715 static void
2716 major_start_collection (gboolean concurrent, size_t *old_next_pin_slot)
2717 {
2718         MONO_GC_BEGIN (GENERATION_OLD);
2719         binary_protocol_collection_begin (gc_stats.major_gc_count, GENERATION_OLD);
2720
2721         current_collection_generation = GENERATION_OLD;
2722 #ifndef DISABLE_PERFCOUNTERS
2723         mono_perfcounters->gc_collections1++;
2724 #endif
2725
2726         g_assert (sgen_section_gray_queue_is_empty (sgen_workers_get_distribute_section_gray_queue ()));
2727
2728         sgen_cement_reset ();
2729
2730         if (concurrent) {
2731                 g_assert (major_collector.is_concurrent);
2732                 concurrent_collection_in_progress = TRUE;
2733
2734                 current_object_ops = major_collector.major_concurrent_ops;
2735         } else {
2736                 current_object_ops = major_collector.major_ops;
2737         }
2738
2739         reset_pinned_from_failed_allocation ();
2740
2741         sgen_memgov_major_collection_start ();
2742
2743         //count_ref_nonref_objs ();
2744         //consistency_check ();
2745
2746         check_scan_starts ();
2747
2748         degraded_mode = 0;
2749         SGEN_LOG (1, "Start major collection %d", gc_stats.major_gc_count);
2750         gc_stats.major_gc_count ++;
2751
2752         if (major_collector.start_major_collection)
2753                 major_collector.start_major_collection ();
2754
2755         major_copy_or_mark_from_roots (old_next_pin_slot, concurrent, FALSE, FALSE, FALSE);
2756         major_finish_copy_or_mark ();
2757 }
2758
2759 static void
2760 wait_for_workers_to_finish (void)
2761 {
2762         while (!sgen_workers_all_done ())
2763                 g_usleep (200);
2764 }
2765
2766 static void
2767 major_finish_collection (const char *reason, size_t old_next_pin_slot, gboolean scan_whole_nursery)
2768 {
2769         ScannedObjectCounts counts;
2770         LOSObject *bigobj, *prevbo;
2771         TV_DECLARE (atv);
2772         TV_DECLARE (btv);
2773
2774         TV_GETTIME (btv);
2775
2776         if (concurrent_collection_in_progress) {
2777                 sgen_workers_signal_start_nursery_collection_and_wait ();
2778
2779                 current_object_ops = major_collector.major_concurrent_ops;
2780
2781                 major_copy_or_mark_from_roots (NULL, FALSE, TRUE, TRUE, scan_whole_nursery);
2782
2783                 sgen_workers_signal_finish_nursery_collection ();
2784
2785                 major_finish_copy_or_mark ();
2786                 gray_queue_enable_redirect (WORKERS_DISTRIBUTE_GRAY_QUEUE);
2787
2788                 sgen_workers_join ();
2789
2790                 SGEN_ASSERT (0, sgen_gray_object_queue_is_empty (&gray_queue), "Why is the gray queue not empty after workers have finished working?");
2791
2792 #ifdef SGEN_DEBUG_INTERNAL_ALLOC
2793                 main_gc_thread = NULL;
2794 #endif
2795
2796                 if (do_concurrent_checks)
2797                         check_nursery_is_clean ();
2798         } else {
2799                 SGEN_ASSERT (0, !scan_whole_nursery, "scan_whole_nursery only applies to concurrent collections");
2800                 current_object_ops = major_collector.major_ops;
2801         }
2802
2803         /*
2804          * The workers have stopped so we need to finish gray queue
2805          * work that might result from finalization in the main GC
2806          * thread.  Redirection must therefore be turned off.
2807          */
2808         sgen_gray_object_queue_disable_alloc_prepare (&gray_queue);
2809         g_assert (sgen_section_gray_queue_is_empty (sgen_workers_get_distribute_section_gray_queue ()));
2810
2811         /* all the objects in the heap */
2812         finish_gray_stack (GENERATION_OLD, &gray_queue);
2813         TV_GETTIME (atv);
2814         time_major_finish_gray_stack += TV_ELAPSED (btv, atv);
2815
2816         SGEN_ASSERT (0, sgen_workers_all_done (), "Can't have workers working after joining");
2817
2818         /*
2819          * The (single-threaded) finalization code might have done
2820          * some copying/marking so we can only reset the GC thread's
2821          * worker data here instead of earlier when we joined the
2822          * workers.
2823          */
2824         sgen_workers_reset_data ();
2825
2826         if (objects_pinned) {
2827                 g_assert (!concurrent_collection_in_progress);
2828
2829                 /*
2830                  * This is slow, but we just OOM'd.
2831                  *
2832                  * See comment at `sgen_pin_queue_clear_discarded_entries` for how the pin
2833                  * queue is laid out at this point.
2834                  */
2835                 sgen_pin_queue_clear_discarded_entries (nursery_section, old_next_pin_slot);
2836                 /*
2837                  * We need to reestablish all pinned nursery objects in the pin queue
2838                  * because they're needed for fragment creation.  Unpinning happens by
2839                  * walking the whole queue, so it's not necessary to reestablish where major
2840                  * heap block pins are - all we care is that they're still in there
2841                  * somewhere.
2842                  */
2843                 sgen_optimize_pin_queue ();
2844                 sgen_find_section_pin_queue_start_end (nursery_section);
2845                 objects_pinned = 0;
2846         }
2847
2848         reset_heap_boundaries ();
2849         sgen_update_heap_boundaries ((mword)sgen_get_nursery_start (), (mword)sgen_get_nursery_end ());
2850
2851         if (!concurrent_collection_in_progress) {
2852                 /* walk the pin_queue, build up the fragment list of free memory, unmark
2853                  * pinned objects as we go, memzero() the empty fragments so they are ready for the
2854                  * next allocations.
2855                  */
2856                 if (!sgen_build_nursery_fragments (nursery_section, NULL))
2857                         degraded_mode = 1;
2858
2859                 /* prepare the pin queue for the next collection */
2860                 sgen_finish_pinning ();
2861
2862                 /* Clear TLABs for all threads */
2863                 sgen_clear_tlabs ();
2864
2865                 sgen_pin_stats_reset ();
2866         }
2867
2868         sgen_cement_clear_below_threshold ();
2869
2870         if (check_mark_bits_after_major_collection)
2871                 sgen_check_heap_marked (concurrent_collection_in_progress);
2872
2873         TV_GETTIME (btv);
2874         time_major_fragment_creation += TV_ELAPSED (atv, btv);
2875
2876
2877         MONO_GC_SWEEP_BEGIN (GENERATION_OLD, !major_collector.sweeps_lazily);
2878
2879         /* sweep the big objects list */
2880         prevbo = NULL;
2881         for (bigobj = los_object_list; bigobj;) {
2882                 g_assert (!object_is_pinned (bigobj->data));
2883                 if (sgen_los_object_is_pinned (bigobj->data)) {
2884                         sgen_los_unpin_object (bigobj->data);
2885                         sgen_update_heap_boundaries ((mword)bigobj->data, (mword)bigobj->data + sgen_los_object_size (bigobj));
2886                 } else {
2887                         LOSObject *to_free;
2888                         /* not referenced anywhere, so we can free it */
2889                         if (prevbo)
2890                                 prevbo->next = bigobj->next;
2891                         else
2892                                 los_object_list = bigobj->next;
2893                         to_free = bigobj;
2894                         bigobj = bigobj->next;
2895                         sgen_los_free_object (to_free);
2896                         continue;
2897                 }
2898                 prevbo = bigobj;
2899                 bigobj = bigobj->next;
2900         }
2901
2902         TV_GETTIME (atv);
2903         time_major_free_bigobjs += TV_ELAPSED (btv, atv);
2904
2905         sgen_los_sweep ();
2906
2907         TV_GETTIME (btv);
2908         time_major_los_sweep += TV_ELAPSED (atv, btv);
2909
2910         major_collector.sweep ();
2911
2912         MONO_GC_SWEEP_END (GENERATION_OLD, !major_collector.sweeps_lazily);
2913
2914         TV_GETTIME (atv);
2915         time_major_sweep += TV_ELAPSED (btv, atv);
2916
2917         if (heap_dump_file)
2918                 dump_heap ("major", gc_stats.major_gc_count - 1, reason);
2919
2920         if (fin_ready_list || critical_fin_list) {
2921                 SGEN_LOG (4, "Finalizer-thread wakeup: ready %d", num_ready_finalizers);
2922                 mono_gc_finalize_notify ();
2923         }
2924
2925         g_assert (sgen_gray_object_queue_is_empty (&gray_queue));
2926
2927         sgen_memgov_major_collection_end ();
2928         current_collection_generation = -1;
2929
2930         memset (&counts, 0, sizeof (ScannedObjectCounts));
2931         major_collector.finish_major_collection (&counts);
2932
2933         g_assert (sgen_section_gray_queue_is_empty (sgen_workers_get_distribute_section_gray_queue ()));
2934
2935         SGEN_ASSERT (0, sgen_workers_all_done (), "Can't have workers working after major collection has finished");
2936         if (concurrent_collection_in_progress)
2937                 concurrent_collection_in_progress = FALSE;
2938
2939         check_scan_starts ();
2940
2941         binary_protocol_flush_buffers (FALSE);
2942
2943         //consistency_check ();
2944
2945         MONO_GC_END (GENERATION_OLD);
2946         binary_protocol_collection_end (gc_stats.major_gc_count - 1, GENERATION_OLD, counts.num_scanned_objects, counts.num_unique_scanned_objects);
2947 }
2948
2949 static gboolean
2950 major_do_collection (const char *reason)
2951 {
2952         TV_DECLARE (time_start);
2953         TV_DECLARE (time_end);
2954         size_t old_next_pin_slot;
2955
2956         if (disable_major_collections)
2957                 return FALSE;
2958
2959         if (major_collector.get_and_reset_num_major_objects_marked) {
2960                 long long num_marked = major_collector.get_and_reset_num_major_objects_marked ();
2961                 g_assert (!num_marked);
2962         }
2963
2964         /* world must be stopped already */
2965         TV_GETTIME (time_start);
2966
2967         major_start_collection (FALSE, &old_next_pin_slot);
2968         major_finish_collection (reason, old_next_pin_slot, FALSE);
2969
2970         TV_GETTIME (time_end);
2971         gc_stats.major_gc_time += TV_ELAPSED (time_start, time_end);
2972
2973         /* FIXME: also report this to the user, preferably in gc-end. */
2974         if (major_collector.get_and_reset_num_major_objects_marked)
2975                 major_collector.get_and_reset_num_major_objects_marked ();
2976
2977         return bytes_pinned_from_failed_allocation > 0;
2978 }
2979
2980 static void
2981 major_start_concurrent_collection (const char *reason)
2982 {
2983         TV_DECLARE (time_start);
2984         TV_DECLARE (time_end);
2985         long long num_objects_marked;
2986
2987         if (disable_major_collections)
2988                 return;
2989
2990         TV_GETTIME (time_start);
2991         SGEN_TV_GETTIME (time_major_conc_collection_start);
2992
2993         num_objects_marked = major_collector.get_and_reset_num_major_objects_marked ();
2994         g_assert (num_objects_marked == 0);
2995
2996         MONO_GC_CONCURRENT_START_BEGIN (GENERATION_OLD);
2997         binary_protocol_concurrent_start ();
2998
2999         // FIXME: store reason and pass it when finishing
3000         major_start_collection (TRUE, NULL);
3001
3002         gray_queue_redirect (&gray_queue);
3003
3004         num_objects_marked = major_collector.get_and_reset_num_major_objects_marked ();
3005         MONO_GC_CONCURRENT_START_END (GENERATION_OLD, num_objects_marked);
3006
3007         TV_GETTIME (time_end);
3008         gc_stats.major_gc_time += TV_ELAPSED (time_start, time_end);
3009
3010         current_collection_generation = -1;
3011 }
3012
3013 /*
3014  * Returns whether the major collection has finished.
3015  */
3016 static gboolean
3017 major_should_finish_concurrent_collection (void)
3018 {
3019         SGEN_ASSERT (0, sgen_gray_object_queue_is_empty (&gray_queue), "Why is the gray queue not empty before we have started doing anything?");
3020         return sgen_workers_all_done ();
3021 }
3022
3023 static void
3024 major_update_concurrent_collection (void)
3025 {
3026         TV_DECLARE (total_start);
3027         TV_DECLARE (total_end);
3028
3029         TV_GETTIME (total_start);
3030
3031         MONO_GC_CONCURRENT_UPDATE_FINISH_BEGIN (GENERATION_OLD, major_collector.get_and_reset_num_major_objects_marked ());
3032         binary_protocol_concurrent_update ();
3033
3034         major_collector.update_cardtable_mod_union ();
3035         sgen_los_update_cardtable_mod_union ();
3036
3037         MONO_GC_CONCURRENT_UPDATE_END (GENERATION_OLD, major_collector.get_and_reset_num_major_objects_marked ());
3038
3039         TV_GETTIME (total_end);
3040         gc_stats.major_gc_time += TV_ELAPSED (total_start, total_end);
3041 }
3042
3043 static void
3044 major_finish_concurrent_collection (void)
3045 {
3046         TV_DECLARE (total_start);
3047         TV_DECLARE (total_end);
3048         gboolean late_pinned;
3049         SgenGrayQueue unpin_queue;
3050         memset (&unpin_queue, 0, sizeof (unpin_queue));
3051
3052         TV_GETTIME (total_start);
3053
3054         MONO_GC_CONCURRENT_UPDATE_FINISH_BEGIN (GENERATION_OLD, major_collector.get_and_reset_num_major_objects_marked ());
3055         binary_protocol_concurrent_finish ();
3056
3057         /*
3058          * The major collector can add global remsets which are processed in the finishing
3059          * nursery collection, below.  That implies that the workers must have finished
3060          * marking before the nursery collection is allowed to run, otherwise we might miss
3061          * some remsets.
3062          */
3063         wait_for_workers_to_finish ();
3064
3065         SGEN_TV_GETTIME (time_major_conc_collection_end);
3066         gc_stats.major_gc_time_concurrent += SGEN_TV_ELAPSED (time_major_conc_collection_start, time_major_conc_collection_end);
3067
3068         major_collector.update_cardtable_mod_union ();
3069         sgen_los_update_cardtable_mod_union ();
3070
3071         late_pinned = collect_nursery (&unpin_queue, TRUE);
3072
3073         if (mod_union_consistency_check)
3074                 sgen_check_mod_union_consistency ();
3075
3076         current_collection_generation = GENERATION_OLD;
3077         major_finish_collection ("finishing", -1, late_pinned);
3078
3079         if (whole_heap_check_before_collection)
3080                 sgen_check_whole_heap (FALSE);
3081
3082         unpin_objects_from_queue (&unpin_queue);
3083         sgen_gray_object_queue_deinit (&unpin_queue);
3084
3085         MONO_GC_CONCURRENT_FINISH_END (GENERATION_OLD, major_collector.get_and_reset_num_major_objects_marked ());
3086
3087         TV_GETTIME (total_end);
3088         gc_stats.major_gc_time += TV_ELAPSED (total_start, total_end) - TV_ELAPSED (last_minor_collection_start_tv, last_minor_collection_end_tv);
3089
3090         current_collection_generation = -1;
3091 }
3092
3093 /*
3094  * Ensure an allocation request for @size will succeed by freeing enough memory.
3095  *
3096  * LOCKING: The GC lock MUST be held.
3097  */
3098 void
3099 sgen_ensure_free_space (size_t size)
3100 {
3101         int generation_to_collect = -1;
3102         const char *reason = NULL;
3103
3104
3105         if (size > SGEN_MAX_SMALL_OBJ_SIZE) {
3106                 if (sgen_need_major_collection (size)) {
3107                         reason = "LOS overflow";
3108                         generation_to_collect = GENERATION_OLD;
3109                 }
3110         } else {
3111                 if (degraded_mode) {
3112                         if (sgen_need_major_collection (size)) {
3113                                 reason = "Degraded mode overflow";
3114                                 generation_to_collect = GENERATION_OLD;
3115                         }
3116                 } else if (sgen_need_major_collection (size)) {
3117                         reason = "Minor allowance";
3118                         generation_to_collect = GENERATION_OLD;
3119                 } else {
3120                         generation_to_collect = GENERATION_NURSERY;
3121                         reason = "Nursery full";
3122                 }
3123         }
3124
3125         if (generation_to_collect == -1) {
3126                 if (concurrent_collection_in_progress && sgen_workers_all_done ()) {
3127                         generation_to_collect = GENERATION_OLD;
3128                         reason = "Finish concurrent collection";
3129                 }
3130         }
3131
3132         if (generation_to_collect == -1)
3133                 return;
3134         sgen_perform_collection (size, generation_to_collect, reason, FALSE);
3135 }
3136
3137 /*
3138  * LOCKING: Assumes the GC lock is held.
3139  */
3140 void
3141 sgen_perform_collection (size_t requested_size, int generation_to_collect, const char *reason, gboolean wait_to_finish)
3142 {
3143         TV_DECLARE (gc_start);
3144         TV_DECLARE (gc_end);
3145         TV_DECLARE (gc_total_start);
3146         TV_DECLARE (gc_total_end);
3147         GGTimingInfo infos [2];
3148         int overflow_generation_to_collect = -1;
3149         int oldest_generation_collected = generation_to_collect;
3150         const char *overflow_reason = NULL;
3151
3152         MONO_GC_REQUESTED (generation_to_collect, requested_size, wait_to_finish ? 1 : 0);
3153         if (wait_to_finish)
3154                 binary_protocol_collection_force (generation_to_collect);
3155
3156         SGEN_ASSERT (0, generation_to_collect == GENERATION_NURSERY || generation_to_collect == GENERATION_OLD, "What generation is this?");
3157
3158         mono_profiler_gc_event (MONO_GC_EVENT_START, generation_to_collect);
3159
3160         TV_GETTIME (gc_start);
3161
3162         sgen_stop_world (generation_to_collect);
3163
3164         TV_GETTIME (gc_total_start);
3165
3166         if (concurrent_collection_in_progress) {
3167                 /*
3168                  * We update the concurrent collection.  If it finished, we're done.  If
3169                  * not, and we've been asked to do a nursery collection, we do that.
3170                  */
3171                 gboolean finish = major_should_finish_concurrent_collection () || (wait_to_finish && generation_to_collect == GENERATION_OLD);
3172
3173                 if (finish) {
3174                         major_finish_concurrent_collection ();
3175                         oldest_generation_collected = GENERATION_OLD;
3176                 } else {
3177                         sgen_workers_signal_start_nursery_collection_and_wait ();
3178
3179                         major_update_concurrent_collection ();
3180                         if (generation_to_collect == GENERATION_NURSERY)
3181                                 collect_nursery (NULL, FALSE);
3182
3183                         sgen_workers_signal_finish_nursery_collection ();
3184                 }
3185
3186                 goto done;
3187         }
3188
3189         /*
3190          * If we've been asked to do a major collection, and the major collector wants to
3191          * run synchronously (to evacuate), we set the flag to do that.
3192          */
3193         if (generation_to_collect == GENERATION_OLD &&
3194                         allow_synchronous_major &&
3195                         major_collector.want_synchronous_collection &&
3196                         *major_collector.want_synchronous_collection) {
3197                 wait_to_finish = TRUE;
3198         }
3199
3200         SGEN_ASSERT (0, !concurrent_collection_in_progress, "Why did this not get handled above?");
3201
3202         /*
3203          * There's no concurrent collection in progress.  Collect the generation we're asked
3204          * to collect.  If the major collector is concurrent and we're not forced to wait,
3205          * start a concurrent collection.
3206          */
3207         // FIXME: extract overflow reason
3208         if (generation_to_collect == GENERATION_NURSERY) {
3209                 if (collect_nursery (NULL, FALSE)) {
3210                         overflow_generation_to_collect = GENERATION_OLD;
3211                         overflow_reason = "Minor overflow";
3212                 }
3213         } else {
3214                 if (major_collector.is_concurrent && !wait_to_finish) {
3215                         collect_nursery (NULL, FALSE);
3216                         major_start_concurrent_collection (reason);
3217                         // FIXME: set infos[0] properly
3218                         goto done;
3219                 }
3220
3221                 if (major_do_collection (reason)) {
3222                         overflow_generation_to_collect = GENERATION_NURSERY;
3223                         overflow_reason = "Excessive pinning";
3224                 }
3225         }
3226
3227         TV_GETTIME (gc_end);
3228
3229         memset (infos, 0, sizeof (infos));
3230         infos [0].generation = generation_to_collect;
3231         infos [0].reason = reason;
3232         infos [0].is_overflow = FALSE;
3233         infos [1].generation = -1;
3234         infos [0].total_time = SGEN_TV_ELAPSED (gc_start, gc_end);
3235
3236         SGEN_ASSERT (0, !concurrent_collection_in_progress, "Why did this not get handled above?");
3237
3238         if (overflow_generation_to_collect != -1) {
3239                 /*
3240                  * We need to do an overflow collection, either because we ran out of memory
3241                  * or the nursery is fully pinned.
3242                  */
3243
3244                 mono_profiler_gc_event (MONO_GC_EVENT_START, overflow_generation_to_collect);
3245                 infos [1].generation = overflow_generation_to_collect;
3246                 infos [1].reason = overflow_reason;
3247                 infos [1].is_overflow = TRUE;
3248                 infos [1].total_time = gc_end;
3249
3250                 if (overflow_generation_to_collect == GENERATION_NURSERY)
3251                         collect_nursery (NULL, FALSE);
3252                 else
3253                         major_do_collection (overflow_reason);
3254
3255                 TV_GETTIME (gc_end);
3256                 infos [1].total_time = SGEN_TV_ELAPSED (infos [1].total_time, gc_end);
3257
3258                 /* keep events symmetric */
3259                 mono_profiler_gc_event (MONO_GC_EVENT_END, overflow_generation_to_collect);
3260
3261                 oldest_generation_collected = MAX (oldest_generation_collected, overflow_generation_to_collect);
3262         }
3263
3264         SGEN_LOG (2, "Heap size: %lu, LOS size: %lu", (unsigned long)mono_gc_get_heap_size (), (unsigned long)los_memory_usage);
3265
3266         /* this also sets the proper pointers for the next allocation */
3267         if (generation_to_collect == GENERATION_NURSERY && !sgen_can_alloc_size (requested_size)) {
3268                 /* TypeBuilder and MonoMethod are killing mcs with fragmentation */
3269                 SGEN_LOG (1, "nursery collection didn't find enough room for %zd alloc (%zd pinned)", requested_size, sgen_get_pinned_count ());
3270                 sgen_dump_pin_queue ();
3271                 degraded_mode = 1;
3272         }
3273
3274  done:
3275         g_assert (sgen_gray_object_queue_is_empty (&gray_queue));
3276
3277         TV_GETTIME (gc_total_end);
3278         time_max = MAX (time_max, TV_ELAPSED (gc_total_start, gc_total_end));
3279
3280         sgen_restart_world (oldest_generation_collected, infos);
3281
3282         mono_profiler_gc_event (MONO_GC_EVENT_END, generation_to_collect);
3283 }
3284
3285 /*
3286  * ######################################################################
3287  * ########  Memory allocation from the OS
3288  * ######################################################################
3289  * This section of code deals with getting memory from the OS and
3290  * allocating memory for GC-internal data structures.
3291  * Internal memory can be handled with a freelist for small objects.
3292  */
3293
3294 /*
3295  * Debug reporting.
3296  */
3297 G_GNUC_UNUSED static void
3298 report_internal_mem_usage (void)
3299 {
3300         printf ("Internal memory usage:\n");
3301         sgen_report_internal_mem_usage ();
3302         printf ("Pinned memory usage:\n");
3303         major_collector.report_pinned_memory_usage ();
3304 }
3305
3306 /*
3307  * ######################################################################
3308  * ########  Finalization support
3309  * ######################################################################
3310  */
3311
3312 static inline gboolean
3313 sgen_major_is_object_alive (void *object)
3314 {
3315         mword objsize;
3316
3317         /* Oldgen objects can be pinned and forwarded too */
3318         if (SGEN_OBJECT_IS_PINNED (object) || SGEN_OBJECT_IS_FORWARDED (object))
3319                 return TRUE;
3320
3321         /*
3322          * FIXME: major_collector.is_object_live() also calculates the
3323          * size.  Avoid the double calculation.
3324          */
3325         objsize = SGEN_ALIGN_UP (sgen_safe_object_get_size ((MonoObject*)object));
3326         if (objsize > SGEN_MAX_SMALL_OBJ_SIZE)
3327                 return sgen_los_object_is_pinned (object);
3328
3329         return major_collector.is_object_live (object);
3330 }
3331
3332 /*
3333  * If the object has been forwarded it means it's still referenced from a root.
3334  * If it is pinned it's still alive as well.
3335  * A LOS object is only alive if we have pinned it.
3336  * Return TRUE if @obj is ready to be finalized.
3337  */
3338 static inline gboolean
3339 sgen_is_object_alive (void *object)
3340 {
3341         if (ptr_in_nursery (object))
3342                 return sgen_nursery_is_object_alive (object);
3343
3344         return sgen_major_is_object_alive (object);
3345 }
3346
3347 /*
3348  * This function returns true if @object is either alive or it belongs to the old gen
3349  * and we're currently doing a minor collection.
3350  */
3351 static inline int
3352 sgen_is_object_alive_for_current_gen (char *object)
3353 {
3354         if (ptr_in_nursery (object))
3355                 return sgen_nursery_is_object_alive (object);
3356
3357         if (current_collection_generation == GENERATION_NURSERY)
3358                 return TRUE;
3359
3360         return sgen_major_is_object_alive (object);
3361 }
3362
3363 /*
3364  * This function returns true if @object is either alive and belongs to the
3365  * current collection - major collections are full heap, so old gen objects
3366  * are never alive during a minor collection.
3367  */
3368 static inline int
3369 sgen_is_object_alive_and_on_current_collection (char *object)
3370 {
3371         if (ptr_in_nursery (object))
3372                 return sgen_nursery_is_object_alive (object);
3373
3374         if (current_collection_generation == GENERATION_NURSERY)
3375                 return FALSE;
3376
3377         return sgen_major_is_object_alive (object);
3378 }
3379
3380
3381 gboolean
3382 sgen_gc_is_object_ready_for_finalization (void *object)
3383 {
3384         return !sgen_is_object_alive (object);
3385 }
3386
3387 static gboolean
3388 has_critical_finalizer (MonoObject *obj)
3389 {
3390         MonoClass *class;
3391
3392         if (!mono_defaults.critical_finalizer_object)
3393                 return FALSE;
3394
3395         class = ((MonoVTable*)LOAD_VTABLE (obj))->klass;
3396
3397         return mono_class_has_parent_fast (class, mono_defaults.critical_finalizer_object);
3398 }
3399
3400 static gboolean
3401 is_finalization_aware (MonoObject *obj)
3402 {
3403         MonoVTable *vt = ((MonoVTable*)LOAD_VTABLE (obj));
3404         return (vt->gc_bits & SGEN_GC_BIT_FINALIZER_AWARE) == SGEN_GC_BIT_FINALIZER_AWARE;
3405 }
3406
3407 void
3408 sgen_queue_finalization_entry (MonoObject *obj)
3409 {
3410         FinalizeReadyEntry *entry = sgen_alloc_internal (INTERNAL_MEM_FINALIZE_READY_ENTRY);
3411         gboolean critical = has_critical_finalizer (obj);
3412         entry->object = obj;
3413         if (critical) {
3414                 entry->next = critical_fin_list;
3415                 critical_fin_list = entry;
3416         } else {
3417                 entry->next = fin_ready_list;
3418                 fin_ready_list = entry;
3419         }
3420
3421         if (fin_callbacks.object_queued_for_finalization && is_finalization_aware (obj))
3422                 fin_callbacks.object_queued_for_finalization (obj);
3423
3424 #ifdef ENABLE_DTRACE
3425         if (G_UNLIKELY (MONO_GC_FINALIZE_ENQUEUE_ENABLED ())) {
3426                 int gen = sgen_ptr_in_nursery (obj) ? GENERATION_NURSERY : GENERATION_OLD;
3427                 MonoVTable *vt = (MonoVTable*)LOAD_VTABLE (obj);
3428                 MONO_GC_FINALIZE_ENQUEUE ((mword)obj, sgen_safe_object_get_size (obj),
3429                                 vt->klass->name_space, vt->klass->name, gen, critical);
3430         }
3431 #endif
3432 }
3433
3434 gboolean
3435 sgen_object_is_live (void *obj)
3436 {
3437         return sgen_is_object_alive_and_on_current_collection (obj);
3438 }
3439
3440 /* LOCKING: requires that the GC lock is held */
3441 static void
3442 null_ephemerons_for_domain (MonoDomain *domain)
3443 {
3444         EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
3445
3446         while (current) {
3447                 MonoObject *object = (MonoObject*)current->array;
3448
3449                 if (object)
3450                         SGEN_ASSERT (0, object->vtable, "Can't have objects without vtables.");
3451
3452                 if (object && object->vtable->domain == domain) {
3453                         EphemeronLinkNode *tmp = current;
3454
3455                         if (prev)
3456                                 prev->next = current->next;
3457                         else
3458                                 ephemeron_list = current->next;
3459
3460                         current = current->next;
3461                         sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
3462                 } else {
3463                         prev = current;
3464                         current = current->next;
3465                 }
3466         }
3467 }
3468
3469 /* LOCKING: requires that the GC lock is held */
3470 static void
3471 clear_unreachable_ephemerons (ScanCopyContext ctx)
3472 {
3473         CopyOrMarkObjectFunc copy_func = ctx.copy_func;
3474         GrayQueue *queue = ctx.queue;
3475         EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
3476         MonoArray *array;
3477         Ephemeron *cur, *array_end;
3478         char *tombstone;
3479
3480         while (current) {
3481                 char *object = current->array;
3482
3483                 if (!sgen_is_object_alive_for_current_gen (object)) {
3484                         EphemeronLinkNode *tmp = current;
3485
3486                         SGEN_LOG (5, "Dead Ephemeron array at %p", object);
3487
3488                         if (prev)
3489                                 prev->next = current->next;
3490                         else
3491                                 ephemeron_list = current->next;
3492
3493                         current = current->next;
3494                         sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
3495
3496                         continue;
3497                 }
3498
3499                 copy_func ((void**)&object, queue);
3500                 current->array = object;
3501
3502                 SGEN_LOG (5, "Clearing unreachable entries for ephemeron array at %p", object);
3503
3504                 array = (MonoArray*)object;
3505                 cur = mono_array_addr (array, Ephemeron, 0);
3506                 array_end = cur + mono_array_length_fast (array);
3507                 tombstone = (char*)((MonoVTable*)LOAD_VTABLE (object))->domain->ephemeron_tombstone;
3508
3509                 for (; cur < array_end; ++cur) {
3510                         char *key = (char*)cur->key;
3511
3512                         if (!key || key == tombstone)
3513                                 continue;
3514
3515                         SGEN_LOG (5, "[%td] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
3516                                 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
3517                                 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
3518
3519                         if (!sgen_is_object_alive_for_current_gen (key)) {
3520                                 cur->key = tombstone;
3521                                 cur->value = NULL;
3522                                 continue;
3523                         }
3524                 }
3525                 prev = current;
3526                 current = current->next;
3527         }
3528 }
3529
3530 /*
3531 LOCKING: requires that the GC lock is held
3532
3533 Limitations: We scan all ephemerons on every collection since the current design doesn't allow for a simple nursery/mature split.
3534 */
3535 static int
3536 mark_ephemerons_in_range (ScanCopyContext ctx)
3537 {
3538         CopyOrMarkObjectFunc copy_func = ctx.copy_func;
3539         GrayQueue *queue = ctx.queue;
3540         int nothing_marked = 1;
3541         EphemeronLinkNode *current = ephemeron_list;
3542         MonoArray *array;
3543         Ephemeron *cur, *array_end;
3544         char *tombstone;
3545
3546         for (current = ephemeron_list; current; current = current->next) {
3547                 char *object = current->array;
3548                 SGEN_LOG (5, "Ephemeron array at %p", object);
3549
3550                 /*It has to be alive*/
3551                 if (!sgen_is_object_alive_for_current_gen (object)) {
3552                         SGEN_LOG (5, "\tnot reachable");
3553                         continue;
3554                 }
3555
3556                 copy_func ((void**)&object, queue);
3557
3558                 array = (MonoArray*)object;
3559                 cur = mono_array_addr (array, Ephemeron, 0);
3560                 array_end = cur + mono_array_length_fast (array);
3561                 tombstone = (char*)((MonoVTable*)LOAD_VTABLE (object))->domain->ephemeron_tombstone;
3562
3563                 for (; cur < array_end; ++cur) {
3564                         char *key = cur->key;
3565
3566                         if (!key || key == tombstone)
3567                                 continue;
3568
3569                         SGEN_LOG (5, "[%td] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
3570                                 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
3571                                 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
3572
3573                         if (sgen_is_object_alive_for_current_gen (key)) {
3574                                 char *value = cur->value;
3575
3576                                 copy_func ((void**)&cur->key, queue);
3577                                 if (value) {
3578                                         if (!sgen_is_object_alive_for_current_gen (value))
3579                                                 nothing_marked = 0;
3580                                         copy_func ((void**)&cur->value, queue);
3581                                 }
3582                         }
3583                 }
3584         }
3585
3586         SGEN_LOG (5, "Ephemeron run finished. Is it done %d", nothing_marked);
3587         return nothing_marked;
3588 }
3589
3590 int
3591 mono_gc_invoke_finalizers (void)
3592 {
3593         FinalizeReadyEntry *entry = NULL;
3594         gboolean entry_is_critical = FALSE;
3595         int count = 0;
3596         void *obj;
3597         /* FIXME: batch to reduce lock contention */
3598         while (fin_ready_list || critical_fin_list) {
3599                 LOCK_GC;
3600
3601                 if (entry) {
3602                         FinalizeReadyEntry **list = entry_is_critical ? &critical_fin_list : &fin_ready_list;
3603
3604                         /* We have finalized entry in the last
3605                            interation, now we need to remove it from
3606                            the list. */
3607                         if (*list == entry)
3608                                 *list = entry->next;
3609                         else {
3610                                 FinalizeReadyEntry *e = *list;
3611                                 while (e->next != entry)
3612                                         e = e->next;
3613                                 e->next = entry->next;
3614                         }
3615                         sgen_free_internal (entry, INTERNAL_MEM_FINALIZE_READY_ENTRY);
3616                         entry = NULL;
3617                 }
3618
3619                 /* Now look for the first non-null entry. */
3620                 for (entry = fin_ready_list; entry && !entry->object; entry = entry->next)
3621                         ;
3622                 if (entry) {
3623                         entry_is_critical = FALSE;
3624                 } else {
3625                         entry_is_critical = TRUE;
3626                         for (entry = critical_fin_list; entry && !entry->object; entry = entry->next)
3627                                 ;
3628                 }
3629
3630                 if (entry) {
3631                         g_assert (entry->object);
3632                         num_ready_finalizers--;
3633                         obj = entry->object;
3634                         entry->object = NULL;
3635                         SGEN_LOG (7, "Finalizing object %p (%s)", obj, safe_name (obj));
3636                 }
3637
3638                 UNLOCK_GC;
3639
3640                 if (!entry)
3641                         break;
3642
3643                 g_assert (entry->object == NULL);
3644                 count++;
3645                 /* the object is on the stack so it is pinned */
3646                 /*g_print ("Calling finalizer for object: %p (%s)\n", entry->object, safe_name (entry->object));*/
3647                 mono_gc_run_finalize (obj, NULL);
3648         }
3649         g_assert (!entry);
3650         return count;
3651 }
3652
3653 gboolean
3654 mono_gc_pending_finalizers (void)
3655 {
3656         return fin_ready_list || critical_fin_list;
3657 }
3658
3659 /*
3660  * ######################################################################
3661  * ########  registered roots support
3662  * ######################################################################
3663  */
3664
3665 /*
3666  * We do not coalesce roots.
3667  */
3668 static int
3669 mono_gc_register_root_inner (char *start, size_t size, void *descr, int root_type)
3670 {
3671         RootRecord new_root;
3672         int i;
3673         LOCK_GC;
3674         for (i = 0; i < ROOT_TYPE_NUM; ++i) {
3675                 RootRecord *root = sgen_hash_table_lookup (&roots_hash [i], start);
3676                 /* we allow changing the size and the descriptor (for thread statics etc) */
3677                 if (root) {
3678                         size_t old_size = root->end_root - start;
3679                         root->end_root = start + size;
3680                         g_assert (((root->root_desc != 0) && (descr != NULL)) ||
3681                                           ((root->root_desc == 0) && (descr == NULL)));
3682                         root->root_desc = (mword)descr;
3683                         roots_size += size;
3684                         roots_size -= old_size;
3685                         UNLOCK_GC;
3686                         return TRUE;
3687                 }
3688         }
3689
3690         new_root.end_root = start + size;
3691         new_root.root_desc = (mword)descr;
3692
3693         sgen_hash_table_replace (&roots_hash [root_type], start, &new_root, NULL);
3694         roots_size += size;
3695
3696         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);
3697
3698         UNLOCK_GC;
3699         return TRUE;
3700 }
3701
3702 int
3703 mono_gc_register_root (char *start, size_t size, void *descr)
3704 {
3705         return mono_gc_register_root_inner (start, size, descr, descr ? ROOT_TYPE_NORMAL : ROOT_TYPE_PINNED);
3706 }
3707
3708 int
3709 mono_gc_register_root_wbarrier (char *start, size_t size, void *descr)
3710 {
3711         return mono_gc_register_root_inner (start, size, descr, ROOT_TYPE_WBARRIER);
3712 }
3713
3714 void
3715 mono_gc_deregister_root (char* addr)
3716 {
3717         int root_type;
3718         RootRecord root;
3719
3720         LOCK_GC;
3721         for (root_type = 0; root_type < ROOT_TYPE_NUM; ++root_type) {
3722                 if (sgen_hash_table_remove (&roots_hash [root_type], addr, &root))
3723                         roots_size -= (root.end_root - addr);
3724         }
3725         UNLOCK_GC;
3726 }
3727
3728 /*
3729  * ######################################################################
3730  * ########  Thread handling (stop/start code)
3731  * ######################################################################
3732  */
3733
3734 unsigned int sgen_global_stop_count = 0;
3735
3736 int
3737 sgen_get_current_collection_generation (void)
3738 {
3739         return current_collection_generation;
3740 }
3741
3742 void
3743 mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks)
3744 {
3745         gc_callbacks = *callbacks;
3746 }
3747
3748 MonoGCCallbacks *
3749 mono_gc_get_gc_callbacks ()
3750 {
3751         return &gc_callbacks;
3752 }
3753
3754 /* Variables holding start/end nursery so it won't have to be passed at every call */
3755 static void *scan_area_arg_start, *scan_area_arg_end;
3756
3757 void
3758 mono_gc_conservatively_scan_area (void *start, void *end)
3759 {
3760         conservatively_pin_objects_from (start, end, scan_area_arg_start, scan_area_arg_end, PIN_TYPE_STACK);
3761 }
3762
3763 void*
3764 mono_gc_scan_object (void *obj, void *gc_data)
3765 {
3766         UserCopyOrMarkData *data = gc_data;
3767         current_object_ops.copy_or_mark_object (&obj, data->queue);
3768         return obj;
3769 }
3770
3771 /*
3772  * Mark from thread stacks and registers.
3773  */
3774 static void
3775 scan_thread_data (void *start_nursery, void *end_nursery, gboolean precise, GrayQueue *queue)
3776 {
3777         SgenThreadInfo *info;
3778
3779         scan_area_arg_start = start_nursery;
3780         scan_area_arg_end = end_nursery;
3781
3782         FOREACH_THREAD (info) {
3783                 if (info->skip) {
3784                         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);
3785                         continue;
3786                 }
3787                 if (info->gc_disabled) {
3788                         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);
3789                         continue;
3790                 }
3791                 if (!mono_thread_info_is_live (info)) {
3792                         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);
3793                         continue;
3794                 }
3795                 g_assert (info->suspend_done);
3796                 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 ());
3797                 if (gc_callbacks.thread_mark_func && !conservative_stack_mark) {
3798                         UserCopyOrMarkData data = { NULL, queue };
3799                         gc_callbacks.thread_mark_func (info->runtime_data, info->stack_start, info->stack_end, precise, &data);
3800                 } else if (!precise) {
3801                         if (!conservative_stack_mark) {
3802                                 fprintf (stderr, "Precise stack mark not supported - disabling.\n");
3803                                 conservative_stack_mark = TRUE;
3804                         }
3805                         conservatively_pin_objects_from (info->stack_start, info->stack_end, start_nursery, end_nursery, PIN_TYPE_STACK);
3806                 }
3807
3808                 if (!precise) {
3809 #ifdef USE_MONO_CTX
3810                         conservatively_pin_objects_from ((void**)&info->ctx, (void**)&info->ctx + ARCH_NUM_REGS,
3811                                 start_nursery, end_nursery, PIN_TYPE_STACK);
3812 #else
3813                         conservatively_pin_objects_from ((void**)&info->regs, (void**)&info->regs + ARCH_NUM_REGS,
3814                                         start_nursery, end_nursery, PIN_TYPE_STACK);
3815 #endif
3816                 }
3817         } END_FOREACH_THREAD
3818 }
3819
3820 static gboolean
3821 ptr_on_stack (void *ptr)
3822 {
3823         gpointer stack_start = &stack_start;
3824         SgenThreadInfo *info = mono_thread_info_current ();
3825
3826         if (ptr >= stack_start && ptr < (gpointer)info->stack_end)
3827                 return TRUE;
3828         return FALSE;
3829 }
3830
3831 static void*
3832 sgen_thread_register (SgenThreadInfo* info, void *addr)
3833 {
3834         size_t stsize = 0;
3835         guint8 *staddr = NULL;
3836
3837 #ifndef HAVE_KW_THREAD
3838         info->tlab_start = info->tlab_next = info->tlab_temp_end = info->tlab_real_end = NULL;
3839
3840         g_assert (!mono_native_tls_get_value (thread_info_key));
3841         mono_native_tls_set_value (thread_info_key, info);
3842 #else
3843         sgen_thread_info = info;
3844 #endif
3845
3846 #ifdef SGEN_POSIX_STW
3847         info->stop_count = -1;
3848         info->signal = 0;
3849 #endif
3850         info->skip = 0;
3851         info->stack_start = NULL;
3852         info->stopped_ip = NULL;
3853         info->stopped_domain = NULL;
3854 #ifdef USE_MONO_CTX
3855         memset (&info->ctx, 0, sizeof (MonoContext));
3856 #else
3857         memset (&info->regs, 0, sizeof (info->regs));
3858 #endif
3859
3860         sgen_init_tlab_info (info);
3861
3862         binary_protocol_thread_register ((gpointer)mono_thread_info_get_tid (info));
3863
3864         /* On win32, stack_start_limit should be 0, since the stack can grow dynamically */
3865         mono_thread_info_get_stack_bounds (&staddr, &stsize);
3866         if (staddr) {
3867 #ifndef HOST_WIN32
3868                 info->stack_start_limit = staddr;
3869 #endif
3870                 info->stack_end = staddr + stsize;
3871         } else {
3872                 gsize stack_bottom = (gsize)addr;
3873                 stack_bottom += 4095;
3874                 stack_bottom &= ~4095;
3875                 info->stack_end = (char*)stack_bottom;
3876         }
3877
3878 #ifdef HAVE_KW_THREAD
3879         stack_end = info->stack_end;
3880 #endif
3881
3882         SGEN_LOG (3, "registered thread %p (%p) stack end %p", info, (gpointer)mono_thread_info_get_tid (info), info->stack_end);
3883
3884         if (gc_callbacks.thread_attach_func)
3885                 info->runtime_data = gc_callbacks.thread_attach_func ();
3886         return info;
3887 }
3888
3889 static void
3890 sgen_thread_detach (SgenThreadInfo *p)
3891 {
3892         /* If a delegate is passed to native code and invoked on a thread we dont
3893          * know about, the jit will register it with mono_jit_thread_attach, but
3894          * we have no way of knowing when that thread goes away.  SGen has a TSD
3895          * so we assume that if the domain is still registered, we can detach
3896          * the thread
3897          */
3898         if (mono_domain_get ())
3899                 mono_thread_detach_internal (mono_thread_internal_current ());
3900 }
3901
3902 static void
3903 sgen_thread_unregister (SgenThreadInfo *p)
3904 {
3905         MonoNativeThreadId tid;
3906
3907         tid = mono_thread_info_get_tid (p);
3908         binary_protocol_thread_unregister ((gpointer)tid);
3909         SGEN_LOG (3, "unregister thread %p (%p)", p, (gpointer)tid);
3910
3911 #ifndef HAVE_KW_THREAD
3912         mono_native_tls_set_value (thread_info_key, NULL);
3913 #else
3914         sgen_thread_info = NULL;
3915 #endif
3916
3917         if (p->info.runtime_thread)
3918                 mono_threads_add_joinable_thread ((gpointer)tid);
3919
3920         if (gc_callbacks.thread_detach_func) {
3921                 gc_callbacks.thread_detach_func (p->runtime_data);
3922                 p->runtime_data = NULL;
3923         }
3924 }
3925
3926
3927 static void
3928 sgen_thread_attach (SgenThreadInfo *info)
3929 {
3930         LOCK_GC;
3931         /*this is odd, can we get attached before the gc is inited?*/
3932         init_stats ();
3933         UNLOCK_GC;
3934
3935         if (gc_callbacks.thread_attach_func && !info->runtime_data)
3936                 info->runtime_data = gc_callbacks.thread_attach_func ();
3937 }
3938 gboolean
3939 mono_gc_register_thread (void *baseptr)
3940 {
3941         return mono_thread_info_attach (baseptr) != NULL;
3942 }
3943
3944 /*
3945  * mono_gc_set_stack_end:
3946  *
3947  *   Set the end of the current threads stack to STACK_END. The stack space between
3948  * STACK_END and the real end of the threads stack will not be scanned during collections.
3949  */
3950 void
3951 mono_gc_set_stack_end (void *stack_end)
3952 {
3953         SgenThreadInfo *info;
3954
3955         LOCK_GC;
3956         info = mono_thread_info_current ();
3957         if (info) {
3958                 g_assert (stack_end < info->stack_end);
3959                 info->stack_end = stack_end;
3960         }
3961         UNLOCK_GC;
3962 }
3963
3964 #if USE_PTHREAD_INTERCEPT
3965
3966
3967 int
3968 mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
3969 {
3970         return pthread_create (new_thread, attr, start_routine, arg);
3971 }
3972
3973 int
3974 mono_gc_pthread_join (pthread_t thread, void **retval)
3975 {
3976         return pthread_join (thread, retval);
3977 }
3978
3979 int
3980 mono_gc_pthread_detach (pthread_t thread)
3981 {
3982         return pthread_detach (thread);
3983 }
3984
3985 void
3986 mono_gc_pthread_exit (void *retval)
3987 {
3988         mono_thread_info_detach ();
3989         pthread_exit (retval);
3990         g_assert_not_reached ();
3991 }
3992
3993 #endif /* USE_PTHREAD_INTERCEPT */
3994
3995 /*
3996  * ######################################################################
3997  * ########  Write barriers
3998  * ######################################################################
3999  */
4000
4001 /*
4002  * Note: the write barriers first do the needed GC work and then do the actual store:
4003  * this way the value is visible to the conservative GC scan after the write barrier
4004  * itself. If a GC interrupts the barrier in the middle, value will be kept alive by
4005  * the conservative scan, otherwise by the remembered set scan.
4006  */
4007 void
4008 mono_gc_wbarrier_set_field (MonoObject *obj, gpointer field_ptr, MonoObject* value)
4009 {
4010         HEAVY_STAT (++stat_wbarrier_set_field);
4011         if (ptr_in_nursery (field_ptr)) {
4012                 *(void**)field_ptr = value;
4013                 return;
4014         }
4015         SGEN_LOG (8, "Adding remset at %p", field_ptr);
4016         if (value)
4017                 binary_protocol_wbarrier (field_ptr, value, value->vtable);
4018
4019         remset.wbarrier_set_field (obj, field_ptr, value);
4020 }
4021
4022 void
4023 mono_gc_wbarrier_set_arrayref (MonoArray *arr, gpointer slot_ptr, MonoObject* value)
4024 {
4025         HEAVY_STAT (++stat_wbarrier_set_arrayref);
4026         if (ptr_in_nursery (slot_ptr)) {
4027                 *(void**)slot_ptr = value;
4028                 return;
4029         }
4030         SGEN_LOG (8, "Adding remset at %p", slot_ptr);
4031         if (value)
4032                 binary_protocol_wbarrier (slot_ptr, value, value->vtable);
4033
4034         remset.wbarrier_set_arrayref (arr, slot_ptr, value);
4035 }
4036
4037 void
4038 mono_gc_wbarrier_arrayref_copy (gpointer dest_ptr, gpointer src_ptr, int count)
4039 {
4040         HEAVY_STAT (++stat_wbarrier_arrayref_copy);
4041         /*This check can be done without taking a lock since dest_ptr array is pinned*/
4042         if (ptr_in_nursery (dest_ptr) || count <= 0) {
4043                 mono_gc_memmove_aligned (dest_ptr, src_ptr, count * sizeof (gpointer));
4044                 return;
4045         }
4046
4047 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
4048         if (binary_protocol_is_heavy_enabled ()) {
4049                 int i;
4050                 for (i = 0; i < count; ++i) {
4051                         gpointer dest = (gpointer*)dest_ptr + i;
4052                         gpointer obj = *((gpointer*)src_ptr + i);
4053                         if (obj)
4054                                 binary_protocol_wbarrier (dest, obj, (gpointer)LOAD_VTABLE (obj));
4055                 }
4056         }
4057 #endif
4058
4059         remset.wbarrier_arrayref_copy (dest_ptr, src_ptr, count);
4060 }
4061
4062 void
4063 mono_gc_wbarrier_generic_nostore (gpointer ptr)
4064 {
4065         gpointer obj;
4066
4067         HEAVY_STAT (++stat_wbarrier_generic_store);
4068
4069 #ifdef XDOMAIN_CHECKS_IN_WBARRIER
4070         /* FIXME: ptr_in_heap must be called with the GC lock held */
4071         if (xdomain_checks && *(MonoObject**)ptr && ptr_in_heap (ptr)) {
4072                 char *start = sgen_find_object_for_ptr (ptr);
4073                 MonoObject *value = *(MonoObject**)ptr;
4074                 LOCK_GC;
4075                 g_assert (start);
4076                 if (start) {
4077                         MonoObject *obj = (MonoObject*)start;
4078                         if (obj->vtable->domain != value->vtable->domain)
4079                                 g_assert (is_xdomain_ref_allowed (ptr, start, obj->vtable->domain));
4080                 }
4081                 UNLOCK_GC;
4082         }
4083 #endif
4084
4085         obj = *(gpointer*)ptr;
4086         if (obj)
4087                 binary_protocol_wbarrier (ptr, obj, (gpointer)LOAD_VTABLE (obj));
4088
4089         if (ptr_in_nursery (ptr) || ptr_on_stack (ptr)) {
4090                 SGEN_LOG (8, "Skipping remset at %p", ptr);
4091                 return;
4092         }
4093
4094         /*
4095          * We need to record old->old pointer locations for the
4096          * concurrent collector.
4097          */
4098         if (!ptr_in_nursery (obj) && !concurrent_collection_in_progress) {
4099                 SGEN_LOG (8, "Skipping remset at %p", ptr);
4100                 return;
4101         }
4102
4103         SGEN_LOG (8, "Adding remset at %p", ptr);
4104
4105         remset.wbarrier_generic_nostore (ptr);
4106 }
4107
4108 void
4109 mono_gc_wbarrier_generic_store (gpointer ptr, MonoObject* value)
4110 {
4111         SGEN_LOG (8, "Wbarrier store at %p to %p (%s)", ptr, value, value ? safe_name (value) : "null");
4112         SGEN_UPDATE_REFERENCE_ALLOW_NULL (ptr, value);
4113         if (ptr_in_nursery (value))
4114                 mono_gc_wbarrier_generic_nostore (ptr);
4115         sgen_dummy_use (value);
4116 }
4117
4118 /* Same as mono_gc_wbarrier_generic_store () but performs the store
4119  * as an atomic operation with release semantics.
4120  */
4121 void
4122 mono_gc_wbarrier_generic_store_atomic (gpointer ptr, MonoObject *value)
4123 {
4124         HEAVY_STAT (++stat_wbarrier_generic_store_atomic);
4125
4126         SGEN_LOG (8, "Wbarrier atomic store at %p to %p (%s)", ptr, value, value ? safe_name (value) : "null");
4127
4128         InterlockedWritePointer (ptr, value);
4129
4130         if (ptr_in_nursery (value))
4131                 mono_gc_wbarrier_generic_nostore (ptr);
4132
4133         sgen_dummy_use (value);
4134 }
4135
4136 void mono_gc_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap)
4137 {
4138         mword *dest = _dest;
4139         mword *src = _src;
4140
4141         while (size) {
4142                 if (bitmap & 0x1)
4143                         mono_gc_wbarrier_generic_store (dest, (MonoObject*)*src);
4144                 else
4145                         SGEN_UPDATE_REFERENCE_ALLOW_NULL (dest, *src);
4146                 ++src;
4147                 ++dest;
4148                 size -= SIZEOF_VOID_P;
4149                 bitmap >>= 1;
4150         }
4151 }
4152
4153 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
4154 #undef HANDLE_PTR
4155 #define HANDLE_PTR(ptr,obj) do {                                        \
4156                 gpointer o = *(gpointer*)(ptr);                         \
4157                 if ((o)) {                                              \
4158                         gpointer d = ((char*)dest) + ((char*)(ptr) - (char*)(obj)); \
4159                         binary_protocol_wbarrier (d, o, (gpointer) LOAD_VTABLE (o)); \
4160                 }                                                       \
4161         } while (0)
4162
4163 static void
4164 scan_object_for_binary_protocol_copy_wbarrier (gpointer dest, char *start, mword desc)
4165 {
4166 #define SCAN_OBJECT_NOVTABLE
4167 #include "sgen-scan-object.h"
4168 }
4169 #endif
4170
4171 void
4172 mono_gc_wbarrier_value_copy (gpointer dest, gpointer src, int count, MonoClass *klass)
4173 {
4174         HEAVY_STAT (++stat_wbarrier_value_copy);
4175         g_assert (klass->valuetype);
4176
4177         SGEN_LOG (8, "Adding value remset at %p, count %d, descr %p for class %s (%p)", dest, count, klass->gc_descr, klass->name, klass);
4178
4179         if (ptr_in_nursery (dest) || ptr_on_stack (dest) || !SGEN_CLASS_HAS_REFERENCES (klass)) {
4180                 size_t element_size = mono_class_value_size (klass, NULL);
4181                 size_t size = count * element_size;
4182                 mono_gc_memmove_atomic (dest, src, size);
4183                 return;
4184         }
4185
4186 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
4187         if (binary_protocol_is_heavy_enabled ()) {
4188                 size_t element_size = mono_class_value_size (klass, NULL);
4189                 int i;
4190                 for (i = 0; i < count; ++i) {
4191                         scan_object_for_binary_protocol_copy_wbarrier ((char*)dest + i * element_size,
4192                                         (char*)src + i * element_size - sizeof (MonoObject),
4193                                         (mword) klass->gc_descr);
4194                 }
4195         }
4196 #endif
4197
4198         remset.wbarrier_value_copy (dest, src, count, klass);
4199 }
4200
4201 /**
4202  * mono_gc_wbarrier_object_copy:
4203  *
4204  * Write barrier to call when obj is the result of a clone or copy of an object.
4205  */
4206 void
4207 mono_gc_wbarrier_object_copy (MonoObject* obj, MonoObject *src)
4208 {
4209         int size;
4210
4211         HEAVY_STAT (++stat_wbarrier_object_copy);
4212
4213         if (ptr_in_nursery (obj) || ptr_on_stack (obj)) {
4214                 size = mono_object_class (obj)->instance_size;
4215                 mono_gc_memmove_aligned ((char*)obj + sizeof (MonoObject), (char*)src + sizeof (MonoObject),
4216                                 size - sizeof (MonoObject));
4217                 return;
4218         }
4219
4220 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
4221         if (binary_protocol_is_heavy_enabled ())
4222                 scan_object_for_binary_protocol_copy_wbarrier (obj, (char*)src, (mword) src->vtable->gc_descr);
4223 #endif
4224
4225         remset.wbarrier_object_copy (obj, src);
4226 }
4227
4228
4229 /*
4230  * ######################################################################
4231  * ########  Other mono public interface functions.
4232  * ######################################################################
4233  */
4234
4235 #define REFS_SIZE 128
4236 typedef struct {
4237         void *data;
4238         MonoGCReferences callback;
4239         int flags;
4240         int count;
4241         int called;
4242         MonoObject *refs [REFS_SIZE];
4243         uintptr_t offsets [REFS_SIZE];
4244 } HeapWalkInfo;
4245
4246 #undef HANDLE_PTR
4247 #define HANDLE_PTR(ptr,obj)     do {    \
4248                 if (*(ptr)) {   \
4249                         if (hwi->count == REFS_SIZE) {  \
4250                                 hwi->callback ((MonoObject*)start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);    \
4251                                 hwi->count = 0; \
4252                                 hwi->called = 1;        \
4253                         }       \
4254                         hwi->offsets [hwi->count] = (char*)(ptr)-(char*)start;  \
4255                         hwi->refs [hwi->count++] = *(ptr);      \
4256                 }       \
4257         } while (0)
4258
4259 static void
4260 collect_references (HeapWalkInfo *hwi, char *start, size_t size)
4261 {
4262         mword desc = sgen_obj_get_descriptor (start);
4263
4264 #include "sgen-scan-object.h"
4265 }
4266
4267 static void
4268 walk_references (char *start, size_t size, void *data)
4269 {
4270         HeapWalkInfo *hwi = data;
4271         hwi->called = 0;
4272         hwi->count = 0;
4273         collect_references (hwi, start, size);
4274         if (hwi->count || !hwi->called)
4275                 hwi->callback ((MonoObject*)start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);
4276 }
4277
4278 /**
4279  * mono_gc_walk_heap:
4280  * @flags: flags for future use
4281  * @callback: a function pointer called for each object in the heap
4282  * @data: a user data pointer that is passed to callback
4283  *
4284  * This function can be used to iterate over all the live objects in the heap:
4285  * for each object, @callback is invoked, providing info about the object's
4286  * location in memory, its class, its size and the objects it references.
4287  * For each referenced object it's offset from the object address is
4288  * reported in the offsets array.
4289  * The object references may be buffered, so the callback may be invoked
4290  * multiple times for the same object: in all but the first call, the size
4291  * argument will be zero.
4292  * Note that this function can be only called in the #MONO_GC_EVENT_PRE_START_WORLD
4293  * profiler event handler.
4294  *
4295  * Returns: a non-zero value if the GC doesn't support heap walking
4296  */
4297 int
4298 mono_gc_walk_heap (int flags, MonoGCReferences callback, void *data)
4299 {
4300         HeapWalkInfo hwi;
4301
4302         hwi.flags = flags;
4303         hwi.callback = callback;
4304         hwi.data = data;
4305
4306         sgen_clear_nursery_fragments ();
4307         sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data, walk_references, &hwi, FALSE);
4308
4309         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, walk_references, &hwi);
4310         sgen_los_iterate_objects (walk_references, &hwi);
4311
4312         return 0;
4313 }
4314
4315 void
4316 mono_gc_collect (int generation)
4317 {
4318         LOCK_GC;
4319         if (generation > 1)
4320                 generation = 1;
4321         sgen_perform_collection (0, generation, "user request", TRUE);
4322         UNLOCK_GC;
4323 }
4324
4325 int
4326 mono_gc_max_generation (void)
4327 {
4328         return 1;
4329 }
4330
4331 int
4332 mono_gc_collection_count (int generation)
4333 {
4334         if (generation == 0)
4335                 return gc_stats.minor_gc_count;
4336         return gc_stats.major_gc_count;
4337 }
4338
4339 int64_t
4340 mono_gc_get_used_size (void)
4341 {
4342         gint64 tot = 0;
4343         LOCK_GC;
4344         tot = los_memory_usage;
4345         tot += nursery_section->next_data - nursery_section->data;
4346         tot += major_collector.get_used_size ();
4347         /* FIXME: account for pinned objects */
4348         UNLOCK_GC;
4349         return tot;
4350 }
4351
4352 int
4353 mono_gc_get_los_limit (void)
4354 {
4355         return MAX_SMALL_OBJ_SIZE;
4356 }
4357
4358 void
4359 mono_gc_set_string_length (MonoString *str, gint32 new_length)
4360 {
4361         mono_unichar2 *new_end = str->chars + new_length;
4362
4363         /* zero the discarded string. This null-delimits the string and allows
4364          * the space to be reclaimed by SGen. */
4365
4366         if (nursery_canaries_enabled () && sgen_ptr_in_nursery (str)) {
4367                 CHECK_CANARY_FOR_OBJECT (str);
4368                 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2) + CANARY_SIZE);
4369                 memcpy (new_end + 1 , CANARY_STRING, CANARY_SIZE);
4370         } else {
4371                 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2));
4372         }
4373
4374         str->length = new_length;
4375 }
4376
4377 gboolean
4378 mono_gc_user_markers_supported (void)
4379 {
4380         return TRUE;
4381 }
4382
4383 gboolean
4384 mono_object_is_alive (MonoObject* o)
4385 {
4386         return TRUE;
4387 }
4388
4389 int
4390 mono_gc_get_generation (MonoObject *obj)
4391 {
4392         if (ptr_in_nursery (obj))
4393                 return 0;
4394         return 1;
4395 }
4396
4397 void
4398 mono_gc_enable_events (void)
4399 {
4400 }
4401
4402 void
4403 mono_gc_weak_link_add (void **link_addr, MonoObject *obj, gboolean track)
4404 {
4405         sgen_register_disappearing_link (obj, link_addr, track, FALSE);
4406 }
4407
4408 void
4409 mono_gc_weak_link_remove (void **link_addr, gboolean track)
4410 {
4411         sgen_register_disappearing_link (NULL, link_addr, track, FALSE);
4412 }
4413
4414 MonoObject*
4415 mono_gc_weak_link_get (void **link_addr)
4416 {
4417         void * volatile *link_addr_volatile;
4418         void *ptr;
4419         MonoObject *obj;
4420  retry:
4421         link_addr_volatile = link_addr;
4422         ptr = (void*)*link_addr_volatile;
4423         /*
4424          * At this point we have a hidden pointer.  If the GC runs
4425          * here, it will not recognize the hidden pointer as a
4426          * reference, and if the object behind it is not referenced
4427          * elsewhere, it will be freed.  Once the world is restarted
4428          * we reveal the pointer, giving us a pointer to a freed
4429          * object.  To make sure we don't return it, we load the
4430          * hidden pointer again.  If it's still the same, we can be
4431          * sure the object reference is valid.
4432          */
4433         if (ptr)
4434                 obj = (MonoObject*) REVEAL_POINTER (ptr);
4435         else
4436                 return NULL;
4437
4438         mono_memory_barrier ();
4439
4440         /*
4441          * During the second bridge processing step the world is
4442          * running again.  That step processes all weak links once
4443          * more to null those that refer to dead objects.  Before that
4444          * is completed, those links must not be followed, so we
4445          * conservatively wait for bridge processing when any weak
4446          * link is dereferenced.
4447          */
4448         if (G_UNLIKELY (bridge_processing_in_progress))
4449                 mono_gc_wait_for_bridge_processing ();
4450
4451         if ((void*)*link_addr_volatile != ptr)
4452                 goto retry;
4453
4454         return obj;
4455 }
4456
4457 gboolean
4458 mono_gc_ephemeron_array_add (MonoObject *obj)
4459 {
4460         EphemeronLinkNode *node;
4461
4462         LOCK_GC;
4463
4464         node = sgen_alloc_internal (INTERNAL_MEM_EPHEMERON_LINK);
4465         if (!node) {
4466                 UNLOCK_GC;
4467                 return FALSE;
4468         }
4469         node->array = (char*)obj;
4470         node->next = ephemeron_list;
4471         ephemeron_list = node;
4472
4473         SGEN_LOG (5, "Registered ephemeron array %p", obj);
4474
4475         UNLOCK_GC;
4476         return TRUE;
4477 }
4478
4479 gboolean
4480 mono_gc_set_allow_synchronous_major (gboolean flag)
4481 {
4482         if (!major_collector.is_concurrent)
4483                 return flag;
4484
4485         allow_synchronous_major = flag;
4486         return TRUE;
4487 }
4488
4489 void*
4490 mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data)
4491 {
4492         void *result;
4493         LOCK_INTERRUPTION;
4494         result = func (data);
4495         UNLOCK_INTERRUPTION;
4496         return result;
4497 }
4498
4499 gboolean
4500 mono_gc_is_gc_thread (void)
4501 {
4502         gboolean result;
4503         LOCK_GC;
4504         result = mono_thread_info_current () != NULL;
4505         UNLOCK_GC;
4506         return result;
4507 }
4508
4509 static gboolean
4510 is_critical_method (MonoMethod *method)
4511 {
4512         return mono_runtime_is_critical_method (method) || sgen_is_critical_method (method);
4513 }
4514
4515 void
4516 sgen_env_var_error (const char *env_var, const char *fallback, const char *description_format, ...)
4517 {
4518         va_list ap;
4519
4520         va_start (ap, description_format);
4521
4522         fprintf (stderr, "Warning: In environment variable `%s': ", env_var);
4523         vfprintf (stderr, description_format, ap);
4524         if (fallback)
4525                 fprintf (stderr, " - %s", fallback);
4526         fprintf (stderr, "\n");
4527
4528         va_end (ap);
4529 }
4530
4531 static gboolean
4532 parse_double_in_interval (const char *env_var, const char *opt_name, const char *opt, double min, double max, double *result)
4533 {
4534         char *endptr;
4535         double val = strtod (opt, &endptr);
4536         if (endptr == opt) {
4537                 sgen_env_var_error (env_var, "Using default value.", "`%s` must be a number.", opt_name);
4538                 return FALSE;
4539         }
4540         else if (val < min || val > max) {
4541                 sgen_env_var_error (env_var, "Using default value.", "`%s` must be between %.2f - %.2f.", opt_name, min, max);
4542                 return FALSE;
4543         }
4544         *result = val;
4545         return TRUE;
4546 }
4547
4548 static gboolean
4549 thread_in_critical_region (SgenThreadInfo *info)
4550 {
4551         return info->in_critical_region;
4552 }
4553
4554 void
4555 mono_gc_base_init (void)
4556 {
4557         MonoThreadInfoCallbacks cb;
4558         const char *env;
4559         char **opts, **ptr;
4560         char *major_collector_opt = NULL;
4561         char *minor_collector_opt = NULL;
4562         size_t max_heap = 0;
4563         size_t soft_limit = 0;
4564         int result;
4565         int dummy;
4566         gboolean debug_print_allowance = FALSE;
4567         double allowance_ratio = 0, save_target = 0;
4568         gboolean cement_enabled = TRUE;
4569
4570         mono_counters_init ();
4571
4572         do {
4573                 result = InterlockedCompareExchange (&gc_initialized, -1, 0);
4574                 switch (result) {
4575                 case 1:
4576                         /* already inited */
4577                         return;
4578                 case -1:
4579                         /* being inited by another thread */
4580                         g_usleep (1000);
4581                         break;
4582                 case 0:
4583                         /* we will init it */
4584                         break;
4585                 default:
4586                         g_assert_not_reached ();
4587                 }
4588         } while (result != 0);
4589
4590         SGEN_TV_GETTIME (sgen_init_timestamp);
4591
4592         LOCK_INIT (gc_mutex);
4593
4594         pagesize = mono_pagesize ();
4595         gc_debug_file = stderr;
4596
4597         cb.thread_register = sgen_thread_register;
4598         cb.thread_detach = sgen_thread_detach;
4599         cb.thread_unregister = sgen_thread_unregister;
4600         cb.thread_attach = sgen_thread_attach;
4601         cb.mono_method_is_critical = (gpointer)is_critical_method;
4602         cb.mono_thread_in_critical_region = thread_in_critical_region;
4603 #ifndef HOST_WIN32
4604         cb.thread_exit = mono_gc_pthread_exit;
4605         cb.mono_gc_pthread_create = (gpointer)mono_gc_pthread_create;
4606 #endif
4607
4608         mono_threads_init (&cb, sizeof (SgenThreadInfo));
4609
4610         LOCK_INIT (sgen_interruption_mutex);
4611
4612         if ((env = g_getenv (MONO_GC_PARAMS_NAME))) {
4613                 opts = g_strsplit (env, ",", -1);
4614                 for (ptr = opts; *ptr; ++ptr) {
4615                         char *opt = *ptr;
4616                         if (g_str_has_prefix (opt, "major=")) {
4617                                 opt = strchr (opt, '=') + 1;
4618                                 major_collector_opt = g_strdup (opt);
4619                         } else if (g_str_has_prefix (opt, "minor=")) {
4620                                 opt = strchr (opt, '=') + 1;
4621                                 minor_collector_opt = g_strdup (opt);
4622                         }
4623                 }
4624         } else {
4625                 opts = NULL;
4626         }
4627
4628         init_stats ();
4629         sgen_init_internal_allocator ();
4630         sgen_init_nursery_allocator ();
4631         sgen_init_fin_weak_hash ();
4632         sgen_init_stw ();
4633         sgen_init_hash_table ();
4634         sgen_init_descriptors ();
4635         sgen_init_gray_queues ();
4636
4637         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_SECTION, SGEN_SIZEOF_GC_MEM_SECTION);
4638         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_FINALIZE_READY_ENTRY, sizeof (FinalizeReadyEntry));
4639         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_GRAY_QUEUE, sizeof (GrayQueueSection));
4640         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_EPHEMERON_LINK, sizeof (EphemeronLinkNode));
4641
4642 #ifndef HAVE_KW_THREAD
4643         mono_native_tls_alloc (&thread_info_key, NULL);
4644 #if defined(__APPLE__) || defined (HOST_WIN32)
4645         /*
4646          * CEE_MONO_TLS requires the tls offset, not the key, so the code below only works on darwin,
4647          * where the two are the same.
4648          */
4649         mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, thread_info_key);
4650 #endif
4651 #else
4652         {
4653                 int tls_offset = -1;
4654                 MONO_THREAD_VAR_OFFSET (sgen_thread_info, tls_offset);
4655                 mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, tls_offset);
4656         }
4657 #endif
4658
4659         /*
4660          * This needs to happen before any internal allocations because
4661          * it inits the small id which is required for hazard pointer
4662          * operations.
4663          */
4664         sgen_os_init ();
4665
4666         mono_thread_info_attach (&dummy);
4667
4668         if (!minor_collector_opt) {
4669                 sgen_simple_nursery_init (&sgen_minor_collector);
4670         } else {
4671                 if (!strcmp (minor_collector_opt, "simple")) {
4672                 use_simple_nursery:
4673                         sgen_simple_nursery_init (&sgen_minor_collector);
4674                 } else if (!strcmp (minor_collector_opt, "split")) {
4675                         sgen_split_nursery_init (&sgen_minor_collector);
4676                 } else {
4677                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using `simple` instead.", "Unknown minor collector `%s'.", minor_collector_opt);
4678                         goto use_simple_nursery;
4679                 }
4680         }
4681
4682         if (!major_collector_opt || !strcmp (major_collector_opt, "marksweep")) {
4683         use_marksweep_major:
4684                 sgen_marksweep_init (&major_collector);
4685         } else if (!major_collector_opt || !strcmp (major_collector_opt, "marksweep-conc")) {
4686                 sgen_marksweep_conc_init (&major_collector);
4687         } else {
4688                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using `marksweep` instead.", "Unknown major collector `%s'.", major_collector_opt);
4689                 goto use_marksweep_major;
4690         }
4691
4692         ///* Keep this the default for now */
4693         /* Precise marking is broken on all supported targets. Disable until fixed. */
4694         conservative_stack_mark = TRUE;
4695
4696         sgen_nursery_size = DEFAULT_NURSERY_SIZE;
4697
4698         if (major_collector.is_concurrent)
4699                 cement_enabled = FALSE;
4700
4701         if (opts) {
4702                 gboolean usage_printed = FALSE;
4703
4704                 for (ptr = opts; *ptr; ++ptr) {
4705                         char *opt = *ptr;
4706                         if (!strcmp (opt, ""))
4707                                 continue;
4708                         if (g_str_has_prefix (opt, "major="))
4709                                 continue;
4710                         if (g_str_has_prefix (opt, "minor="))
4711                                 continue;
4712                         if (g_str_has_prefix (opt, "max-heap-size=")) {
4713                                 size_t max_heap_candidate = 0;
4714                                 opt = strchr (opt, '=') + 1;
4715                                 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &max_heap_candidate)) {
4716                                         max_heap = (max_heap_candidate + mono_pagesize () - 1) & ~(size_t)(mono_pagesize () - 1);
4717                                         if (max_heap != max_heap_candidate)
4718                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Rounding up.", "`max-heap-size` size must be a multiple of %d.", mono_pagesize ());
4719                                 } else {
4720                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`max-heap-size` must be an integer.");
4721                                 }
4722                                 continue;
4723                         }
4724                         if (g_str_has_prefix (opt, "soft-heap-limit=")) {
4725                                 opt = strchr (opt, '=') + 1;
4726                                 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &soft_limit)) {
4727                                         if (soft_limit <= 0) {
4728                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`soft-heap-limit` must be positive.");
4729                                                 soft_limit = 0;
4730                                         }
4731                                 } else {
4732                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, NULL, "`soft-heap-limit` must be an integer.");
4733                                 }
4734                                 continue;
4735                         }
4736                         if (g_str_has_prefix (opt, "stack-mark=")) {
4737                                 opt = strchr (opt, '=') + 1;
4738                                 if (!strcmp (opt, "precise")) {
4739                                         conservative_stack_mark = FALSE;
4740                                 } else if (!strcmp (opt, "conservative")) {
4741                                         conservative_stack_mark = TRUE;
4742                                 } else {
4743                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, conservative_stack_mark ? "Using `conservative`." : "Using `precise`.",
4744                                                         "Invalid value `%s` for `stack-mark` option, possible values are: `precise`, `conservative`.", opt);
4745                                 }
4746                                 continue;
4747                         }
4748                         if (g_str_has_prefix (opt, "bridge-implementation=")) {
4749                                 opt = strchr (opt, '=') + 1;
4750                                 sgen_set_bridge_implementation (opt);
4751                                 continue;
4752                         }
4753                         if (g_str_has_prefix (opt, "toggleref-test")) {
4754                                 sgen_register_test_toggleref_callback ();
4755                                 continue;
4756                         }
4757
4758 #ifdef USER_CONFIG
4759                         if (g_str_has_prefix (opt, "nursery-size=")) {
4760                                 size_t val;
4761                                 opt = strchr (opt, '=') + 1;
4762                                 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &val)) {
4763 #ifdef SGEN_ALIGN_NURSERY
4764                                         if ((val & (val - 1))) {
4765                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.", "`nursery-size` must be a power of two.");
4766                                                 continue;
4767                                         }
4768
4769                                         if (val < SGEN_MAX_NURSERY_WASTE) {
4770                                                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.",
4771                                                                 "`nursery-size` must be at least %d bytes.", SGEN_MAX_NURSERY_WASTE);
4772                                                 continue;
4773                                         }
4774
4775                                         sgen_nursery_size = val;
4776                                         sgen_nursery_bits = 0;
4777                                         while (ONE_P << (++ sgen_nursery_bits) != sgen_nursery_size)
4778                                                 ;
4779 #else
4780                                         sgen_nursery_size = val;
4781 #endif
4782                                 } else {
4783                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.", "`nursery-size` must be an integer.");
4784                                         continue;
4785                                 }
4786                                 continue;
4787                         }
4788 #endif
4789                         if (g_str_has_prefix (opt, "save-target-ratio=")) {
4790                                 double val;
4791                                 opt = strchr (opt, '=') + 1;
4792                                 if (parse_double_in_interval (MONO_GC_PARAMS_NAME, "save-target-ratio", opt,
4793                                                 SGEN_MIN_SAVE_TARGET_RATIO, SGEN_MAX_SAVE_TARGET_RATIO, &val)) {
4794                                         save_target = val;
4795                                 }
4796                                 continue;
4797                         }
4798                         if (g_str_has_prefix (opt, "default-allowance-ratio=")) {
4799                                 double val;
4800                                 opt = strchr (opt, '=') + 1;
4801                                 if (parse_double_in_interval (MONO_GC_PARAMS_NAME, "default-allowance-ratio", opt,
4802                                                 SGEN_MIN_ALLOWANCE_NURSERY_SIZE_RATIO, SGEN_MIN_ALLOWANCE_NURSERY_SIZE_RATIO, &val)) {
4803                                         allowance_ratio = val;
4804                                 }
4805                                 continue;
4806                         }
4807                         if (g_str_has_prefix (opt, "allow-synchronous-major=")) {
4808                                 if (!major_collector.is_concurrent) {
4809                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Ignoring.", "`allow-synchronous-major` is only valid for the concurrent major collector.");
4810                                         continue;
4811                                 }
4812
4813                                 opt = strchr (opt, '=') + 1;
4814
4815                                 if (!strcmp (opt, "yes")) {
4816                                         allow_synchronous_major = TRUE;
4817                                 } else if (!strcmp (opt, "no")) {
4818                                         allow_synchronous_major = FALSE;
4819                                 } else {
4820                                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Using default value.", "`allow-synchronous-major` must be either `yes' or `no'.");
4821                                         continue;
4822                                 }
4823                         }
4824
4825                         if (!strcmp (opt, "cementing")) {
4826                                 cement_enabled = TRUE;
4827                                 continue;
4828                         }
4829                         if (!strcmp (opt, "no-cementing")) {
4830                                 cement_enabled = FALSE;
4831                                 continue;
4832                         }
4833
4834                         if (major_collector.handle_gc_param && major_collector.handle_gc_param (opt))
4835                                 continue;
4836
4837                         if (sgen_minor_collector.handle_gc_param && sgen_minor_collector.handle_gc_param (opt))
4838                                 continue;
4839
4840                         sgen_env_var_error (MONO_GC_PARAMS_NAME, "Ignoring.", "Unknown option `%s`.", opt);
4841
4842                         if (usage_printed)
4843                                 continue;
4844
4845                         fprintf (stderr, "\n%s must be a comma-delimited list of one or more of the following:\n", MONO_GC_PARAMS_NAME);
4846                         fprintf (stderr, "  max-heap-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
4847                         fprintf (stderr, "  soft-heap-limit=n (where N is an integer, possibly with a k, m or a g suffix)\n");
4848                         fprintf (stderr, "  nursery-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
4849                         fprintf (stderr, "  major=COLLECTOR (where COLLECTOR is `marksweep', `marksweep-conc', `marksweep-par')\n");
4850                         fprintf (stderr, "  minor=COLLECTOR (where COLLECTOR is `simple' or `split')\n");
4851                         fprintf (stderr, "  wbarrier=WBARRIER (where WBARRIER is `remset' or `cardtable')\n");
4852                         fprintf (stderr, "  stack-mark=MARK-METHOD (where MARK-METHOD is 'precise' or 'conservative')\n");
4853                         fprintf (stderr, "  [no-]cementing\n");
4854                         if (major_collector.is_concurrent)
4855                                 fprintf (stderr, "  allow-synchronous-major=FLAG (where FLAG is `yes' or `no')\n");
4856                         if (major_collector.print_gc_param_usage)
4857                                 major_collector.print_gc_param_usage ();
4858                         if (sgen_minor_collector.print_gc_param_usage)
4859                                 sgen_minor_collector.print_gc_param_usage ();
4860                         fprintf (stderr, " Experimental options:\n");
4861                         fprintf (stderr, "  save-target-ratio=R (where R must be between %.2f - %.2f).\n", SGEN_MIN_SAVE_TARGET_RATIO, SGEN_MAX_SAVE_TARGET_RATIO);
4862                         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);
4863                         fprintf (stderr, "\n");
4864
4865                         usage_printed = TRUE;
4866                 }
4867                 g_strfreev (opts);
4868         }
4869
4870         if (major_collector.is_concurrent)
4871                 sgen_workers_init (1);
4872
4873         if (major_collector_opt)
4874                 g_free (major_collector_opt);
4875
4876         if (minor_collector_opt)
4877                 g_free (minor_collector_opt);
4878
4879         alloc_nursery ();
4880
4881         if (major_collector.is_concurrent && cement_enabled) {
4882                 sgen_env_var_error (MONO_GC_PARAMS_NAME, "Ignoring.", "`cementing` is not supported on concurrent major collectors.");
4883                 cement_enabled = FALSE;
4884         }
4885
4886         sgen_cement_init (cement_enabled);
4887
4888         if ((env = g_getenv (MONO_GC_DEBUG_NAME))) {
4889                 gboolean usage_printed = FALSE;
4890
4891                 opts = g_strsplit (env, ",", -1);
4892                 for (ptr = opts; ptr && *ptr; ptr ++) {
4893                         char *opt = *ptr;
4894                         if (!strcmp (opt, ""))
4895                                 continue;
4896                         if (opt [0] >= '0' && opt [0] <= '9') {
4897                                 gc_debug_level = atoi (opt);
4898                                 opt++;
4899                                 if (opt [0] == ':')
4900                                         opt++;
4901                                 if (opt [0]) {
4902                                         char *rf = g_strdup_printf ("%s.%d", opt, mono_process_current_pid ());
4903                                         gc_debug_file = fopen (rf, "wb");
4904                                         if (!gc_debug_file)
4905                                                 gc_debug_file = stderr;
4906                                         g_free (rf);
4907                                 }
4908                         } else if (!strcmp (opt, "print-allowance")) {
4909                                 debug_print_allowance = TRUE;
4910                         } else if (!strcmp (opt, "print-pinning")) {
4911                                 do_pin_stats = TRUE;
4912                         } else if (!strcmp (opt, "verify-before-allocs")) {
4913                                 verify_before_allocs = 1;
4914                                 has_per_allocation_action = TRUE;
4915                         } else if (g_str_has_prefix (opt, "verify-before-allocs=")) {
4916                                 char *arg = strchr (opt, '=') + 1;
4917                                 verify_before_allocs = atoi (arg);
4918                                 has_per_allocation_action = TRUE;
4919                         } else if (!strcmp (opt, "collect-before-allocs")) {
4920                                 collect_before_allocs = 1;
4921                                 has_per_allocation_action = TRUE;
4922                         } else if (g_str_has_prefix (opt, "collect-before-allocs=")) {
4923                                 char *arg = strchr (opt, '=') + 1;
4924                                 has_per_allocation_action = TRUE;
4925                                 collect_before_allocs = atoi (arg);
4926                         } else if (!strcmp (opt, "verify-before-collections")) {
4927                                 whole_heap_check_before_collection = TRUE;
4928                         } else if (!strcmp (opt, "check-at-minor-collections")) {
4929                                 consistency_check_at_minor_collection = TRUE;
4930                                 nursery_clear_policy = CLEAR_AT_GC;
4931                         } else if (!strcmp (opt, "mod-union-consistency-check")) {
4932                                 if (!major_collector.is_concurrent) {
4933                                         sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "`mod-union-consistency-check` only works with concurrent major collector.");
4934                                         continue;
4935                                 }
4936                                 mod_union_consistency_check = TRUE;
4937                         } else if (!strcmp (opt, "check-mark-bits")) {
4938                                 check_mark_bits_after_major_collection = TRUE;
4939                         } else if (!strcmp (opt, "check-nursery-pinned")) {
4940                                 check_nursery_objects_pinned = TRUE;
4941                         } else if (!strcmp (opt, "xdomain-checks")) {
4942                                 xdomain_checks = TRUE;
4943                         } else if (!strcmp (opt, "clear-at-gc")) {
4944                                 nursery_clear_policy = CLEAR_AT_GC;
4945                         } else if (!strcmp (opt, "clear-nursery-at-gc")) {
4946                                 nursery_clear_policy = CLEAR_AT_GC;
4947                         } else if (!strcmp (opt, "clear-at-tlab-creation")) {
4948                                 nursery_clear_policy = CLEAR_AT_TLAB_CREATION;
4949                         } else if (!strcmp (opt, "debug-clear-at-tlab-creation")) {
4950                                 nursery_clear_policy = CLEAR_AT_TLAB_CREATION_DEBUG;
4951                         } else if (!strcmp (opt, "check-scan-starts")) {
4952                                 do_scan_starts_check = TRUE;
4953                         } else if (!strcmp (opt, "verify-nursery-at-minor-gc")) {
4954                                 do_verify_nursery = TRUE;
4955                         } else if (!strcmp (opt, "check-concurrent")) {
4956                                 if (!major_collector.is_concurrent) {
4957                                         sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "`check-concurrent` only works with concurrent major collectors.");
4958                                         continue;
4959                                 }
4960                                 do_concurrent_checks = TRUE;
4961                         } else if (!strcmp (opt, "dump-nursery-at-minor-gc")) {
4962                                 do_dump_nursery_content = TRUE;
4963                         } else if (!strcmp (opt, "no-managed-allocator")) {
4964                                 sgen_set_use_managed_allocator (FALSE);
4965                         } else if (!strcmp (opt, "disable-minor")) {
4966                                 disable_minor_collections = TRUE;
4967                         } else if (!strcmp (opt, "disable-major")) {
4968                                 disable_major_collections = TRUE;
4969                         } else if (g_str_has_prefix (opt, "heap-dump=")) {
4970                                 char *filename = strchr (opt, '=') + 1;
4971                                 nursery_clear_policy = CLEAR_AT_GC;
4972                                 heap_dump_file = fopen (filename, "w");
4973                                 if (heap_dump_file) {
4974                                         fprintf (heap_dump_file, "<sgen-dump>\n");
4975                                         do_pin_stats = TRUE;
4976                                 }
4977                         } else if (g_str_has_prefix (opt, "binary-protocol=")) {
4978                                 char *filename = strchr (opt, '=') + 1;
4979                                 char *colon = strrchr (filename, ':');
4980                                 size_t limit = -1;
4981                                 if (colon) {
4982                                         if (!mono_gc_parse_environment_string_extract_number (colon + 1, &limit)) {
4983                                                 sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring limit.", "Binary protocol file size limit must be an integer.");
4984                                                 limit = -1;
4985                                         }
4986                                         *colon = '\0';
4987                                 }
4988                                 binary_protocol_init (filename, (long long)limit);
4989                         } else if (!strcmp (opt, "nursery-canaries")) {
4990                                 do_verify_nursery = TRUE;
4991                                 sgen_set_use_managed_allocator (FALSE);
4992                                 enable_nursery_canaries = TRUE;
4993                         } else if (!strcmp (opt, "do-not-finalize")) {
4994                                 do_not_finalize = TRUE;
4995                         } else if (!strcmp (opt, "log-finalizers")) {
4996                                 log_finalizers = TRUE;
4997                         } else if (!sgen_bridge_handle_gc_debug (opt)) {
4998                                 sgen_env_var_error (MONO_GC_DEBUG_NAME, "Ignoring.", "Unknown option `%s`.", opt);
4999
5000                                 if (usage_printed)
5001                                         continue;
5002
5003                                 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);
5004                                 fprintf (stderr, "Valid <option>s are:\n");
5005                                 fprintf (stderr, "  collect-before-allocs[=<n>]\n");
5006                                 fprintf (stderr, "  verify-before-allocs[=<n>]\n");
5007                                 fprintf (stderr, "  check-at-minor-collections\n");
5008                                 fprintf (stderr, "  check-mark-bits\n");
5009                                 fprintf (stderr, "  check-nursery-pinned\n");
5010                                 fprintf (stderr, "  verify-before-collections\n");
5011                                 fprintf (stderr, "  verify-nursery-at-minor-gc\n");
5012                                 fprintf (stderr, "  dump-nursery-at-minor-gc\n");
5013                                 fprintf (stderr, "  disable-minor\n");
5014                                 fprintf (stderr, "  disable-major\n");
5015                                 fprintf (stderr, "  xdomain-checks\n");
5016                                 fprintf (stderr, "  check-concurrent\n");
5017                                 fprintf (stderr, "  clear-[nursery-]at-gc\n");
5018                                 fprintf (stderr, "  clear-at-tlab-creation\n");
5019                                 fprintf (stderr, "  debug-clear-at-tlab-creation\n");
5020                                 fprintf (stderr, "  check-scan-starts\n");
5021                                 fprintf (stderr, "  no-managed-allocator\n");
5022                                 fprintf (stderr, "  print-allowance\n");
5023                                 fprintf (stderr, "  print-pinning\n");
5024                                 fprintf (stderr, "  heap-dump=<filename>\n");
5025                                 fprintf (stderr, "  binary-protocol=<filename>[:<file-size-limit>]\n");
5026                                 fprintf (stderr, "  nursery-canaries\n");
5027                                 fprintf (stderr, "  do-not-finalize\n");
5028                                 fprintf (stderr, "  log-finalizers\n");
5029                                 sgen_bridge_print_gc_debug_usage ();
5030                                 fprintf (stderr, "\n");
5031
5032                                 usage_printed = TRUE;
5033                         }
5034                 }
5035                 g_strfreev (opts);
5036         }
5037
5038         if (check_mark_bits_after_major_collection)
5039                 nursery_clear_policy = CLEAR_AT_GC;
5040
5041         if (major_collector.post_param_init)
5042                 major_collector.post_param_init (&major_collector);
5043
5044         sgen_memgov_init (max_heap, soft_limit, debug_print_allowance, allowance_ratio, save_target);
5045
5046         memset (&remset, 0, sizeof (remset));
5047
5048         sgen_card_table_init (&remset);
5049
5050         gc_initialized = 1;
5051 }
5052
5053 const char *
5054 mono_gc_get_gc_name (void)
5055 {
5056         return "sgen";
5057 }
5058
5059 static MonoMethod *write_barrier_method;
5060
5061 gboolean
5062 sgen_is_critical_method (MonoMethod *method)
5063 {
5064         return (method == write_barrier_method || sgen_is_managed_allocator (method));
5065 }
5066
5067 gboolean
5068 sgen_has_critical_method (void)
5069 {
5070         return write_barrier_method || sgen_has_managed_allocator ();
5071 }
5072
5073 #ifndef DISABLE_JIT
5074
5075 static void
5076 emit_nursery_check (MonoMethodBuilder *mb, int *nursery_check_return_labels)
5077 {
5078         memset (nursery_check_return_labels, 0, sizeof (int) * 3);
5079 #ifdef SGEN_ALIGN_NURSERY
5080         // if (ptr_in_nursery (ptr)) return;
5081         /*
5082          * Masking out the bits might be faster, but we would have to use 64 bit
5083          * immediates, which might be slower.
5084          */
5085         mono_mb_emit_ldarg (mb, 0);
5086         mono_mb_emit_icon (mb, DEFAULT_NURSERY_BITS);
5087         mono_mb_emit_byte (mb, CEE_SHR_UN);
5088         mono_mb_emit_ptr (mb, (gpointer)((mword)sgen_get_nursery_start () >> DEFAULT_NURSERY_BITS));
5089         nursery_check_return_labels [0] = mono_mb_emit_branch (mb, CEE_BEQ);
5090
5091         if (!major_collector.is_concurrent) {
5092                 // if (!ptr_in_nursery (*ptr)) return;
5093                 mono_mb_emit_ldarg (mb, 0);
5094                 mono_mb_emit_byte (mb, CEE_LDIND_I);
5095                 mono_mb_emit_icon (mb, DEFAULT_NURSERY_BITS);
5096                 mono_mb_emit_byte (mb, CEE_SHR_UN);
5097                 mono_mb_emit_ptr (mb, (gpointer)((mword)sgen_get_nursery_start () >> DEFAULT_NURSERY_BITS));
5098                 nursery_check_return_labels [1] = mono_mb_emit_branch (mb, CEE_BNE_UN);
5099         }
5100 #else
5101         int label_continue1, label_continue2;
5102         int dereferenced_var;
5103
5104         // if (ptr < (sgen_get_nursery_start ())) goto continue;
5105         mono_mb_emit_ldarg (mb, 0);
5106         mono_mb_emit_ptr (mb, (gpointer) sgen_get_nursery_start ());
5107         label_continue_1 = mono_mb_emit_branch (mb, CEE_BLT);
5108
5109         // if (ptr >= sgen_get_nursery_end ())) goto continue;
5110         mono_mb_emit_ldarg (mb, 0);
5111         mono_mb_emit_ptr (mb, (gpointer) sgen_get_nursery_end ());
5112         label_continue_2 = mono_mb_emit_branch (mb, CEE_BGE);
5113
5114         // Otherwise return
5115         nursery_check_return_labels [0] = mono_mb_emit_branch (mb, CEE_BR);
5116
5117         // continue:
5118         mono_mb_patch_branch (mb, label_continue_1);
5119         mono_mb_patch_branch (mb, label_continue_2);
5120
5121         // Dereference and store in local var
5122         dereferenced_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
5123         mono_mb_emit_ldarg (mb, 0);
5124         mono_mb_emit_byte (mb, CEE_LDIND_I);
5125         mono_mb_emit_stloc (mb, dereferenced_var);
5126
5127         if (!major_collector.is_concurrent) {
5128                 // if (*ptr < sgen_get_nursery_start ()) return;
5129                 mono_mb_emit_ldloc (mb, dereferenced_var);
5130                 mono_mb_emit_ptr (mb, (gpointer) sgen_get_nursery_start ());
5131                 nursery_check_return_labels [1] = mono_mb_emit_branch (mb, CEE_BLT);
5132
5133                 // if (*ptr >= sgen_get_nursery_end ()) return;
5134                 mono_mb_emit_ldloc (mb, dereferenced_var);
5135                 mono_mb_emit_ptr (mb, (gpointer) sgen_get_nursery_end ());
5136                 nursery_check_return_labels [2] = mono_mb_emit_branch (mb, CEE_BGE);
5137         }
5138 #endif
5139 }
5140 #endif
5141
5142 MonoMethod*
5143 mono_gc_get_write_barrier (void)
5144 {
5145         MonoMethod *res;
5146         MonoMethodBuilder *mb;
5147         MonoMethodSignature *sig;
5148 #ifdef MANAGED_WBARRIER
5149         int i, nursery_check_labels [3];
5150
5151 #ifdef HAVE_KW_THREAD
5152         int stack_end_offset = -1;
5153
5154         MONO_THREAD_VAR_OFFSET (stack_end, stack_end_offset);
5155         g_assert (stack_end_offset != -1);
5156 #endif
5157 #endif
5158
5159         // FIXME: Maybe create a separate version for ctors (the branch would be
5160         // correctly predicted more times)
5161         if (write_barrier_method)
5162                 return write_barrier_method;
5163
5164         /* Create the IL version of mono_gc_barrier_generic_store () */
5165         sig = mono_metadata_signature_alloc (mono_defaults.corlib, 1);
5166         sig->ret = &mono_defaults.void_class->byval_arg;
5167         sig->params [0] = &mono_defaults.int_class->byval_arg;
5168
5169         mb = mono_mb_new (mono_defaults.object_class, "wbarrier", MONO_WRAPPER_WRITE_BARRIER);
5170
5171 #ifndef DISABLE_JIT
5172 #ifdef MANAGED_WBARRIER
5173         emit_nursery_check (mb, nursery_check_labels);
5174         /*
5175         addr = sgen_cardtable + ((address >> CARD_BITS) & CARD_MASK)
5176         *addr = 1;
5177
5178         sgen_cardtable:
5179                 LDC_PTR sgen_cardtable
5180
5181         address >> CARD_BITS
5182                 LDARG_0
5183                 LDC_I4 CARD_BITS
5184                 SHR_UN
5185         if (SGEN_HAVE_OVERLAPPING_CARDS) {
5186                 LDC_PTR card_table_mask
5187                 AND
5188         }
5189         AND
5190         ldc_i4_1
5191         stind_i1
5192         */
5193         mono_mb_emit_ptr (mb, sgen_cardtable);
5194         mono_mb_emit_ldarg (mb, 0);
5195         mono_mb_emit_icon (mb, CARD_BITS);
5196         mono_mb_emit_byte (mb, CEE_SHR_UN);
5197 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
5198         mono_mb_emit_ptr (mb, (gpointer)CARD_MASK);
5199         mono_mb_emit_byte (mb, CEE_AND);
5200 #endif
5201         mono_mb_emit_byte (mb, CEE_ADD);
5202         mono_mb_emit_icon (mb, 1);
5203         mono_mb_emit_byte (mb, CEE_STIND_I1);
5204
5205         // return;
5206         for (i = 0; i < 3; ++i) {
5207                 if (nursery_check_labels [i])
5208                         mono_mb_patch_branch (mb, nursery_check_labels [i]);
5209         }
5210         mono_mb_emit_byte (mb, CEE_RET);
5211 #else
5212         mono_mb_emit_ldarg (mb, 0);
5213         mono_mb_emit_icall (mb, mono_gc_wbarrier_generic_nostore);
5214         mono_mb_emit_byte (mb, CEE_RET);
5215 #endif
5216 #endif
5217         res = mono_mb_create_method (mb, sig, 16);
5218         mono_mb_free (mb);
5219
5220         LOCK_GC;
5221         if (write_barrier_method) {
5222                 /* Already created */
5223                 mono_free_method (res);
5224         } else {
5225                 /* double-checked locking */
5226                 mono_memory_barrier ();
5227                 write_barrier_method = res;
5228         }
5229         UNLOCK_GC;
5230
5231         return write_barrier_method;
5232 }
5233
5234 char*
5235 mono_gc_get_description (void)
5236 {
5237         return g_strdup ("sgen");
5238 }
5239
5240 void
5241 mono_gc_set_desktop_mode (void)
5242 {
5243 }
5244
5245 gboolean
5246 mono_gc_is_moving (void)
5247 {
5248         return TRUE;
5249 }
5250
5251 gboolean
5252 mono_gc_is_disabled (void)
5253 {
5254         return FALSE;
5255 }
5256
5257 #ifdef HOST_WIN32
5258 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved)
5259 {
5260         return TRUE;
5261 }
5262 #endif
5263
5264 NurseryClearPolicy
5265 sgen_get_nursery_clear_policy (void)
5266 {
5267         return nursery_clear_policy;
5268 }
5269
5270 MonoVTable*
5271 sgen_get_array_fill_vtable (void)
5272 {
5273         if (!array_fill_vtable) {
5274                 static MonoClass klass;
5275                 static char _vtable[sizeof(MonoVTable)+8];
5276                 MonoVTable* vtable = (MonoVTable*) ALIGN_TO(_vtable, 8);
5277                 gsize bmap;
5278
5279                 MonoDomain *domain = mono_get_root_domain ();
5280                 g_assert (domain);
5281
5282                 klass.element_class = mono_defaults.byte_class;
5283                 klass.rank = 1;
5284                 klass.instance_size = sizeof (MonoArray);
5285                 klass.sizes.element_size = 1;
5286                 klass.name = "array_filler_type";
5287
5288                 vtable->klass = &klass;
5289                 bmap = 0;
5290                 vtable->gc_descr = mono_gc_make_descr_for_array (TRUE, &bmap, 0, 1);
5291                 vtable->rank = 1;
5292
5293                 array_fill_vtable = vtable;
5294         }
5295         return array_fill_vtable;
5296 }
5297
5298 void
5299 sgen_gc_lock (void)
5300 {
5301         LOCK_GC;
5302 }
5303
5304 void
5305 sgen_gc_unlock (void)
5306 {
5307         gboolean try_free = sgen_try_free_some_memory;
5308         sgen_try_free_some_memory = FALSE;
5309         mono_mutex_unlock (&gc_mutex);
5310         MONO_GC_UNLOCKED ();
5311         if (try_free)
5312                 mono_thread_hazardous_try_free_some ();
5313 }
5314
5315 void
5316 sgen_major_collector_iterate_live_block_ranges (sgen_cardtable_block_callback callback)
5317 {
5318         major_collector.iterate_live_block_ranges (callback);
5319 }
5320
5321 void
5322 sgen_major_collector_scan_card_table (SgenGrayQueue *queue)
5323 {
5324         major_collector.scan_card_table (FALSE, queue);
5325 }
5326
5327 SgenMajorCollector*
5328 sgen_get_major_collector (void)
5329 {
5330         return &major_collector;
5331 }
5332
5333 void mono_gc_set_skip_thread (gboolean skip)
5334 {
5335         SgenThreadInfo *info = mono_thread_info_current ();
5336
5337         LOCK_GC;
5338         info->gc_disabled = skip;
5339         UNLOCK_GC;
5340 }
5341
5342 SgenRememberedSet*
5343 sgen_get_remset (void)
5344 {
5345         return &remset;
5346 }
5347
5348 guint
5349 mono_gc_get_vtable_bits (MonoClass *class)
5350 {
5351         guint res = 0;
5352         /* FIXME move this to the bridge code */
5353         if (sgen_need_bridge_processing ()) {
5354                 switch (sgen_bridge_class_kind (class)) {
5355                 case GC_BRIDGE_TRANSPARENT_BRIDGE_CLASS:
5356                 case GC_BRIDGE_OPAQUE_BRIDGE_CLASS:
5357                         res = SGEN_GC_BIT_BRIDGE_OBJECT;
5358                         break;
5359                 case GC_BRIDGE_OPAQUE_CLASS:
5360                         res = SGEN_GC_BIT_BRIDGE_OPAQUE_OBJECT;
5361                         break;
5362                 case GC_BRIDGE_TRANSPARENT_CLASS:
5363                         break;
5364                 }
5365         }
5366         if (fin_callbacks.is_class_finalization_aware) {
5367                 if (fin_callbacks.is_class_finalization_aware (class))
5368                         res |= SGEN_GC_BIT_FINALIZER_AWARE;
5369         }
5370         return res;
5371 }
5372
5373 void
5374 mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size)
5375 {
5376         // FIXME:
5377 }
5378
5379
5380 void
5381 sgen_check_whole_heap_stw (void)
5382 {
5383         sgen_stop_world (0);
5384         sgen_clear_nursery_fragments ();
5385         sgen_check_whole_heap (FALSE);
5386         sgen_restart_world (0, NULL);
5387 }
5388
5389 void
5390 sgen_gc_event_moves (void)
5391 {
5392         if (moved_objects_idx) {
5393                 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
5394                 moved_objects_idx = 0;
5395         }
5396 }
5397
5398 gint64
5399 sgen_timestamp (void)
5400 {
5401         SGEN_TV_DECLARE (timestamp);
5402         SGEN_TV_GETTIME (timestamp);
5403         return SGEN_TV_ELAPSED (sgen_init_timestamp, timestamp);
5404 }
5405
5406 void
5407 mono_gc_register_finalizer_callbacks (MonoGCFinalizerCallbacks *callbacks)
5408 {
5409         if (callbacks->version != MONO_GC_FINALIZER_EXTENSION_VERSION)
5410                 g_error ("Invalid finalizer callback version. Expected %d but got %d\n", MONO_GC_FINALIZER_EXTENSION_VERSION, callbacks->version);
5411
5412         fin_callbacks = *callbacks;
5413 }
5414
5415
5416
5417
5418
5419 #endif /* HAVE_SGEN_GC */