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