mono/metadata/sgen-mono.c

   1 /*
   2  * sgen-mono.c: SGen features specific to Mono.
   3  *
   4  * Copyright (C) 2014 Xamarin Inc
   5  *
   6  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
   7  */
   8
   9 #include "config.h"
  10 #ifdef HAVE_SGEN_GC
  11
  12 #include "sgen/sgen-gc.h"
  13 #include "sgen/sgen-protocol.h"
  14 #include "metadata/monitor.h"
  15 #include "sgen/sgen-layout-stats.h"
  16 #include "sgen/sgen-client.h"
  17 #include "sgen/sgen-cardtable.h"
  18 #include "sgen/sgen-pinning.h"
  19 #include "metadata/marshal.h"
  20 #include "metadata/method-builder.h"
  21 #include "metadata/abi-details.h"
  22 #include "metadata/mono-gc.h"
  23 #include "metadata/runtime.h"
  24 #include "metadata/sgen-bridge-internals.h"
  25 #include "metadata/gc-internals.h"
  26 #include "metadata/handle.h"
  27 #include "utils/mono-memory-model.h"
  28 #include "utils/mono-logger-internals.h"
  29 #include "sgen/sgen-thread-pool.h"
  30
  31 #ifdef HEAVY_STATISTICS
  32 static guint64 stat_wbarrier_set_arrayref = 0;
  33 static guint64 stat_wbarrier_value_copy = 0;
  34 static guint64 stat_wbarrier_object_copy = 0;
  35
  36 static guint64 los_marked_cards;
  37 static guint64 los_array_cards;
  38 static guint64 los_array_remsets;
  39 #endif
  40
  41 /* If set, mark stacks conservatively, even if precise marking is possible */
  42 static gboolean conservative_stack_mark = FALSE;
  43 /* If set, check that there are no references to the domain left at domain unload */
  44 gboolean sgen_mono_xdomain_checks = FALSE;
  45
  46 /* Functions supplied by the runtime to be called by the GC */
  47 static MonoGCCallbacks gc_callbacks;
  48
  49 #ifdef HAVE_KW_THREAD
  50 __thread SgenThreadInfo *sgen_thread_info;
  51 #else
  52 MonoNativeTlsKey thread_info_key;
  53 #endif
  54
  55 #define ALIGN_TO(val,align) ((((guint64)val) + ((align) - 1)) & ~((align) - 1))
  56
  57 #define OPDEF(a,b,c,d,e,f,g,h,i,j) \
  58         a = i,
  59
  60 enum {
  61 #include "mono/cil/opcode.def"
  62         CEE_LAST
  63 };
  64
  65 #undef OPDEF
  66
  67 /*
  68  * Write barriers
  69  */
  70
  71 static gboolean
  72 ptr_on_stack (void *ptr)
  73 {
  74         gpointer stack_start = &stack_start;
  75         SgenThreadInfo *info = mono_thread_info_current ();
  76
  77         if (ptr >= stack_start && ptr < (gpointer)info->client_info.stack_end)
  78                 return TRUE;
  79         return FALSE;
  80 }
  81
  82 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
  83 #undef HANDLE_PTR
  84 #define HANDLE_PTR(ptr,obj) do {                                        \
  85                 gpointer o = *(gpointer*)(ptr);                         \
  86                 if ((o)) {                                              \
  87                         gpointer d = ((char*)dest) + ((char*)(ptr) - (char*)(obj)); \
  88                         binary_protocol_wbarrier (d, o, (gpointer) SGEN_LOAD_VTABLE (o)); \
  89                 }                                                       \
  90         } while (0)
  91
  92 static void
  93 scan_object_for_binary_protocol_copy_wbarrier (gpointer dest, char *start, mword desc)
  94 {
  95 #define SCAN_OBJECT_NOVTABLE
  96 #include "sgen/sgen-scan-object.h"
  97 }
  98 #endif
  99
 100 void
 101 mono_gc_wbarrier_value_copy (gpointer dest, gpointer src, int count, MonoClass *klass)
 102 {
 103         HEAVY_STAT (++stat_wbarrier_value_copy);
 104         g_assert (klass->valuetype);
 105
 106         SGEN_LOG (8, "Adding value remset at %p, count %d, descr %p for class %s (%p)", dest, count, (gpointer)klass->gc_descr, klass->name, klass);
 107
 108         if (sgen_ptr_in_nursery (dest) || ptr_on_stack (dest) || !sgen_gc_descr_has_references ((mword)klass->gc_descr)) {
 109                 size_t element_size = mono_class_value_size (klass, NULL);
 110                 size_t size = count * element_size;
 111                 mono_gc_memmove_atomic (dest, src, size);
 112                 return;
 113         }
 114
 115 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
 116         if (binary_protocol_is_heavy_enabled ()) {
 117                 size_t element_size = mono_class_value_size (klass, NULL);
 118                 int i;
 119                 for (i = 0; i < count; ++i) {
 120                         scan_object_for_binary_protocol_copy_wbarrier ((char*)dest + i * element_size,
 121                                         (char*)src + i * element_size - sizeof (MonoObject),
 122                                         (mword) klass->gc_descr);
 123                 }
 124         }
 125 #endif
 126
 127         sgen_get_remset ()->wbarrier_value_copy (dest, src, count, mono_class_value_size (klass, NULL));
 128 }
 129
 130 /**
 131  * mono_gc_wbarrier_object_copy:
 132  *
 133  * Write barrier to call when obj is the result of a clone or copy of an object.
 134  */
 135 void
 136 mono_gc_wbarrier_object_copy (MonoObject* obj, MonoObject *src)
 137 {
 138         int size;
 139
 140         HEAVY_STAT (++stat_wbarrier_object_copy);
 141
 142         if (sgen_ptr_in_nursery (obj) || ptr_on_stack (obj) || !SGEN_OBJECT_HAS_REFERENCES (src)) {
 143                 size = mono_object_class (obj)->instance_size;
 144                 mono_gc_memmove_aligned ((char*)obj + sizeof (MonoObject), (char*)src + sizeof (MonoObject),
 145                                 size - sizeof (MonoObject));
 146                 return;
 147         }
 148
 149 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
 150         if (binary_protocol_is_heavy_enabled ())
 151                 scan_object_for_binary_protocol_copy_wbarrier (obj, (char*)src, (mword) src->vtable->gc_descr);
 152 #endif
 153
 154         sgen_get_remset ()->wbarrier_object_copy (obj, src);
 155 }
 156
 157 void
 158 mono_gc_wbarrier_set_arrayref (MonoArray *arr, gpointer slot_ptr, MonoObject* value)
 159 {
 160         HEAVY_STAT (++stat_wbarrier_set_arrayref);
 161         if (sgen_ptr_in_nursery (slot_ptr)) {
 162                 *(void**)slot_ptr = value;
 163                 return;
 164         }
 165         SGEN_LOG (8, "Adding remset at %p", slot_ptr);
 166         if (value)
 167                 binary_protocol_wbarrier (slot_ptr, value, value->vtable);
 168
 169         sgen_get_remset ()->wbarrier_set_field ((GCObject*)arr, slot_ptr, value);
 170 }
 171
 172 void
 173 mono_gc_wbarrier_set_field (MonoObject *obj, gpointer field_ptr, MonoObject* value)
 174 {
 175         mono_gc_wbarrier_set_arrayref ((MonoArray*)obj, field_ptr, value);
 176 }
 177
 178 void
 179 mono_gc_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap)
 180 {
 181         sgen_wbarrier_value_copy_bitmap (_dest, _src, size, bitmap);
 182 }
 183
 184 static MonoMethod *write_barrier_conc_method;
 185 static MonoMethod *write_barrier_noconc_method;
 186
 187 gboolean
 188 sgen_is_critical_method (MonoMethod *method)
 189 {
 190         return (method == write_barrier_conc_method || method == write_barrier_noconc_method || sgen_is_managed_allocator (method));
 191 }
 192
 193 gboolean
 194 sgen_has_critical_method (void)
 195 {
 196         return write_barrier_conc_method || write_barrier_noconc_method || sgen_has_managed_allocator ();
 197 }
 198
 199 #ifndef DISABLE_JIT
 200
 201 static void
 202 emit_nursery_check (MonoMethodBuilder *mb, int *nursery_check_return_labels, gboolean is_concurrent)
 203 {
 204         int shifted_nursery_start = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
 205
 206         memset (nursery_check_return_labels, 0, sizeof (int) * 2);
 207         // if (ptr_in_nursery (ptr)) return;
 208         /*
 209          * Masking out the bits might be faster, but we would have to use 64 bit
 210          * immediates, which might be slower.
 211          */
 212         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
 213         mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_START);
 214         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
 215         mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_BITS);
 216         mono_mb_emit_byte (mb, CEE_SHR_UN);
 217         mono_mb_emit_stloc (mb, shifted_nursery_start);
 218
 219         mono_mb_emit_ldarg (mb, 0);
 220         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
 221         mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_BITS);
 222         mono_mb_emit_byte (mb, CEE_SHR_UN);
 223         mono_mb_emit_ldloc (mb, shifted_nursery_start);
 224         nursery_check_return_labels [0] = mono_mb_emit_branch (mb, CEE_BEQ);
 225
 226         if (!is_concurrent) {
 227                 // if (!ptr_in_nursery (*ptr)) return;
 228                 mono_mb_emit_ldarg (mb, 0);
 229                 mono_mb_emit_byte (mb, CEE_LDIND_I);
 230                 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
 231                 mono_mb_emit_byte (mb, CEE_MONO_LDPTR_NURSERY_BITS);
 232                 mono_mb_emit_byte (mb, CEE_SHR_UN);
 233                 mono_mb_emit_ldloc (mb, shifted_nursery_start);
 234                 nursery_check_return_labels [1] = mono_mb_emit_branch (mb, CEE_BNE_UN);
 235         }
 236 }
 237 #endif
 238
 239 MonoMethod*
 240 mono_gc_get_specific_write_barrier (gboolean is_concurrent)
 241 {
 242         MonoMethod *res;
 243         MonoMethodBuilder *mb;
 244         MonoMethodSignature *sig;
 245         MonoMethod **write_barrier_method_addr;
 246         WrapperInfo *info;
 247 #ifdef MANAGED_WBARRIER
 248         int i, nursery_check_labels [2];
 249 #endif
 250
 251         // FIXME: Maybe create a separate version for ctors (the branch would be
 252         // correctly predicted more times)
 253         if (is_concurrent)
 254                 write_barrier_method_addr = &write_barrier_conc_method;
 255         else
 256                 write_barrier_method_addr = &write_barrier_noconc_method;
 257
 258         if (*write_barrier_method_addr)
 259                 return *write_barrier_method_addr;
 260
 261         /* Create the IL version of mono_gc_barrier_generic_store () */
 262         sig = mono_metadata_signature_alloc (mono_defaults.corlib, 1);
 263         sig->ret = &mono_defaults.void_class->byval_arg;
 264         sig->params [0] = &mono_defaults.int_class->byval_arg;
 265
 266         if (is_concurrent)
 267                 mb = mono_mb_new (mono_defaults.object_class, "wbarrier_conc", MONO_WRAPPER_WRITE_BARRIER);
 268         else
 269                 mb = mono_mb_new (mono_defaults.object_class, "wbarrier_noconc", MONO_WRAPPER_WRITE_BARRIER);
 270
 271 #ifndef DISABLE_JIT
 272 #ifdef MANAGED_WBARRIER
 273         emit_nursery_check (mb, nursery_check_labels, is_concurrent);
 274         /*
 275         addr = sgen_cardtable + ((address >> CARD_BITS) & CARD_MASK)
 276         *addr = 1;
 277
 278         sgen_cardtable:
 279                 LDC_PTR sgen_cardtable
 280
 281         address >> CARD_BITS
 282                 LDARG_0
 283                 LDC_I4 CARD_BITS
 284                 SHR_UN
 285         if (SGEN_HAVE_OVERLAPPING_CARDS) {
 286                 LDC_PTR card_table_mask
 287                 AND
 288         }
 289         AND
 290         ldc_i4_1
 291         stind_i1
 292         */
 293         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
 294         mono_mb_emit_byte (mb, CEE_MONO_LDPTR_CARD_TABLE);
 295         mono_mb_emit_ldarg (mb, 0);
 296         mono_mb_emit_icon (mb, CARD_BITS);
 297         mono_mb_emit_byte (mb, CEE_SHR_UN);
 298         mono_mb_emit_byte (mb, CEE_CONV_I);
 299 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
 300 #if SIZEOF_VOID_P == 8
 301         mono_mb_emit_icon8 (mb, CARD_MASK);
 302 #else
 303         mono_mb_emit_icon (mb, CARD_MASK);
 304 #endif
 305         mono_mb_emit_byte (mb, CEE_CONV_I);
 306         mono_mb_emit_byte (mb, CEE_AND);
 307 #endif
 308         mono_mb_emit_byte (mb, CEE_ADD);
 309         mono_mb_emit_icon (mb, 1);
 310         mono_mb_emit_byte (mb, CEE_STIND_I1);
 311
 312         // return;
 313         for (i = 0; i < 2; ++i) {
 314                 if (nursery_check_labels [i])
 315                         mono_mb_patch_branch (mb, nursery_check_labels [i]);
 316         }
 317         mono_mb_emit_byte (mb, CEE_RET);
 318 #else
 319         mono_mb_emit_ldarg (mb, 0);
 320         mono_mb_emit_icall (mb, mono_gc_wbarrier_generic_nostore);
 321         mono_mb_emit_byte (mb, CEE_RET);
 322 #endif
 323 #endif
 324         res = mono_mb_create_method (mb, sig, 16);
 325         info = mono_wrapper_info_create (mb, WRAPPER_SUBTYPE_NONE);
 326         mono_marshal_set_wrapper_info (res, info);
 327         mono_mb_free (mb);
 328
 329         LOCK_GC;
 330         if (*write_barrier_method_addr) {
 331                 /* Already created */
 332                 mono_free_method (res);
 333         } else {
 334                 /* double-checked locking */
 335                 mono_memory_barrier ();
 336                 *write_barrier_method_addr = res;
 337         }
 338         UNLOCK_GC;
 339
 340         return *write_barrier_method_addr;
 341 }
 342
 343 MonoMethod*
 344 mono_gc_get_write_barrier (void)
 345 {
 346         return mono_gc_get_specific_write_barrier (major_collector.is_concurrent);
 347 }
 348
 349 /*
 350  * Dummy filler objects
 351  */
 352
 353 /* Vtable of the objects used to fill out nursery fragments before a collection */
 354 static GCVTable array_fill_vtable;
 355
 356 static GCVTable
 357 get_array_fill_vtable (void)
 358 {
 359         if (!array_fill_vtable) {
 360                 static MonoClass klass;
 361                 static char _vtable[sizeof(MonoVTable)+8];
 362                 MonoVTable* vtable = (MonoVTable*) ALIGN_TO((mword)_vtable, 8);
 363                 gsize bmap;
 364
 365                 MonoDomain *domain = mono_get_root_domain ();
 366                 g_assert (domain);
 367
 368                 klass.element_class = mono_defaults.byte_class;
 369                 klass.rank = 1;
 370                 klass.instance_size = MONO_SIZEOF_MONO_ARRAY;
 371                 klass.sizes.element_size = 1;
 372                 klass.name = "array_filler_type";
 373
 374                 vtable->klass = &klass;
 375                 bmap = 0;
 376                 vtable->gc_descr = mono_gc_make_descr_for_array (TRUE, &bmap, 0, 1);
 377                 vtable->rank = 1;
 378
 379                 array_fill_vtable = vtable;
 380         }
 381         return array_fill_vtable;
 382 }
 383
 384 gboolean
 385 sgen_client_array_fill_range (char *start, size_t size)
 386 {
 387         MonoArray *o;
 388
 389         if (size < MONO_SIZEOF_MONO_ARRAY) {
 390                 memset (start, 0, size);
 391                 return FALSE;
 392         }
 393
 394         o = (MonoArray*)start;
 395         o->obj.vtable = (MonoVTable*)get_array_fill_vtable ();
 396         /* Mark this as not a real object */
 397         o->obj.synchronisation = (MonoThreadsSync *)GINT_TO_POINTER (-1);
 398         o->bounds = NULL;
 399         o->max_length = (mono_array_size_t)(size - MONO_SIZEOF_MONO_ARRAY);
 400
 401         return TRUE;
 402 }
 403
 404 void
 405 sgen_client_zero_array_fill_header (void *p, size_t size)
 406 {
 407         if (size >= MONO_SIZEOF_MONO_ARRAY) {
 408                 memset (p, 0, MONO_SIZEOF_MONO_ARRAY);
 409         } else {
 410                 static guint8 zeros [MONO_SIZEOF_MONO_ARRAY];
 411
 412                 SGEN_ASSERT (0, !memcmp (p, zeros, size), "TLAB segment must be zeroed out.");
 413         }
 414 }
 415
 416 /*
 417  * Finalization
 418  */
 419
 420 static MonoGCFinalizerCallbacks fin_callbacks;
 421
 422 guint
 423 mono_gc_get_vtable_bits (MonoClass *klass)
 424 {
 425         guint res = 0;
 426         /* FIXME move this to the bridge code */
 427         if (sgen_need_bridge_processing ()) {
 428                 switch (sgen_bridge_class_kind (klass)) {
 429                 case GC_BRIDGE_TRANSPARENT_BRIDGE_CLASS:
 430                 case GC_BRIDGE_OPAQUE_BRIDGE_CLASS:
 431                         res = SGEN_GC_BIT_BRIDGE_OBJECT;
 432                         break;
 433                 case GC_BRIDGE_OPAQUE_CLASS:
 434                         res = SGEN_GC_BIT_BRIDGE_OPAQUE_OBJECT;
 435                         break;
 436                 case GC_BRIDGE_TRANSPARENT_CLASS:
 437                         break;
 438                 }
 439         }
 440         if (fin_callbacks.is_class_finalization_aware) {
 441                 if (fin_callbacks.is_class_finalization_aware (klass))
 442                         res |= SGEN_GC_BIT_FINALIZER_AWARE;
 443         }
 444         return res;
 445 }
 446
 447 static gboolean
 448 is_finalization_aware (MonoObject *obj)
 449 {
 450         MonoVTable *vt = SGEN_LOAD_VTABLE (obj);
 451         return (vt->gc_bits & SGEN_GC_BIT_FINALIZER_AWARE) == SGEN_GC_BIT_FINALIZER_AWARE;
 452 }
 453
 454 void
 455 sgen_client_object_queued_for_finalization (GCObject *obj)
 456 {
 457         if (fin_callbacks.object_queued_for_finalization && is_finalization_aware (obj))
 458                 fin_callbacks.object_queued_for_finalization (obj);
 459
 460 #ifdef ENABLE_DTRACE
 461         if (G_UNLIKELY (MONO_GC_FINALIZE_ENQUEUE_ENABLED ())) {
 462                 int gen = sgen_ptr_in_nursery (obj) ? GENERATION_NURSERY : GENERATION_OLD;
 463                 GCVTable vt = SGEN_LOAD_VTABLE (obj);
 464                 MONO_GC_FINALIZE_ENQUEUE ((mword)obj, sgen_safe_object_get_size (obj),
 465                                 sgen_client_vtable_get_namespace (vt), sgen_client_vtable_get_name (vt), gen,
 466                                 sgen_client_object_has_critical_finalizer (obj));
 467         }
 468 #endif
 469 }
 470
 471 void
 472 mono_gc_register_finalizer_callbacks (MonoGCFinalizerCallbacks *callbacks)
 473 {
 474         if (callbacks->version != MONO_GC_FINALIZER_EXTENSION_VERSION)
 475                 g_error ("Invalid finalizer callback version. Expected %d but got %d\n", MONO_GC_FINALIZER_EXTENSION_VERSION, callbacks->version);
 476
 477         fin_callbacks = *callbacks;
 478 }
 479
 480 void
 481 sgen_client_run_finalize (MonoObject *obj)
 482 {
 483         mono_gc_run_finalize (obj, NULL);
 484 }
 485
 486 int
 487 mono_gc_invoke_finalizers (void)
 488 {
 489         return sgen_gc_invoke_finalizers ();
 490 }
 491
 492 gboolean
 493 mono_gc_pending_finalizers (void)
 494 {
 495         return sgen_have_pending_finalizers ();
 496 }
 497
 498 void
 499 sgen_client_finalize_notify (void)
 500 {
 501         mono_gc_finalize_notify ();
 502 }
 503
 504 void
 505 mono_gc_register_for_finalization (MonoObject *obj, void *user_data)
 506 {
 507         sgen_object_register_for_finalization (obj, user_data);
 508 }
 509
 510 static gboolean
 511 object_in_domain_predicate (MonoObject *obj, void *user_data)
 512 {
 513         MonoDomain *domain = (MonoDomain *)user_data;
 514         if (mono_object_domain (obj) == domain) {
 515                 SGEN_LOG (5, "Unregistering finalizer for object: %p (%s)", obj, sgen_client_vtable_get_name (SGEN_LOAD_VTABLE (obj)));
 516                 return TRUE;
 517         }
 518         return FALSE;
 519 }
 520
 521 /**
 522  * mono_gc_finalizers_for_domain:
 523  * @domain: the unloading appdomain
 524  * @out_array: output array
 525  * @out_size: size of output array
 526  *
 527  * Store inside @out_array up to @out_size objects that belong to the unloading
 528  * appdomain @domain. Returns the number of stored items. Can be called repeteadly
 529  * until it returns 0.
 530  * The items are removed from the finalizer data structure, so the caller is supposed
 531  * to finalize them.
 532  * @out_array should be on the stack to allow the GC to know the objects are still alive.
 533  */
 534 int
 535 mono_gc_finalizers_for_domain (MonoDomain *domain, MonoObject **out_array, int out_size)
 536 {
 537         return sgen_gather_finalizers_if (object_in_domain_predicate, domain, out_array, out_size);
 538 }
 539
 540 /*
 541  * Ephemerons
 542  */
 543
 544 typedef struct _EphemeronLinkNode EphemeronLinkNode;
 545
 546 struct _EphemeronLinkNode {
 547         EphemeronLinkNode *next;
 548         MonoArray *array;
 549 };
 550
 551 typedef struct {
 552        GCObject *key;
 553        GCObject *value;
 554 } Ephemeron;
 555
 556 static EphemeronLinkNode *ephemeron_list;
 557
 558 /* LOCKING: requires that the GC lock is held */
 559 static void
 560 null_ephemerons_for_domain (MonoDomain *domain)
 561 {
 562         EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
 563
 564         while (current) {
 565                 MonoObject *object = (MonoObject*)current->array;
 566
 567                 if (object)
 568                         SGEN_ASSERT (0, object->vtable, "Can't have objects without vtables.");
 569
 570                 if (object && object->vtable->domain == domain) {
 571                         EphemeronLinkNode *tmp = current;
 572
 573                         if (prev)
 574                                 prev->next = current->next;
 575                         else
 576                                 ephemeron_list = current->next;
 577
 578                         current = current->next;
 579                         sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
 580                 } else {
 581                         prev = current;
 582                         current = current->next;
 583                 }
 584         }
 585 }
 586
 587 /* LOCKING: requires that the GC lock is held */
 588 void
 589 sgen_client_clear_unreachable_ephemerons (ScanCopyContext ctx)
 590 {
 591         CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
 592         SgenGrayQueue *queue = ctx.queue;
 593         EphemeronLinkNode *current = ephemeron_list, *prev = NULL;
 594         Ephemeron *cur, *array_end;
 595         GCObject *tombstone;
 596
 597         while (current) {
 598                 MonoArray *array = current->array;
 599
 600                 if (!sgen_is_object_alive_for_current_gen ((GCObject*)array)) {
 601                         EphemeronLinkNode *tmp = current;
 602
 603                         SGEN_LOG (5, "Dead Ephemeron array at %p", array);
 604
 605                         if (prev)
 606                                 prev->next = current->next;
 607                         else
 608                                 ephemeron_list = current->next;
 609
 610                         current = current->next;
 611                         sgen_free_internal (tmp, INTERNAL_MEM_EPHEMERON_LINK);
 612
 613                         continue;
 614                 }
 615
 616                 copy_func ((GCObject**)&array, queue);
 617                 current->array = array;
 618
 619                 SGEN_LOG (5, "Clearing unreachable entries for ephemeron array at %p", array);
 620
 621                 cur = mono_array_addr (array, Ephemeron, 0);
 622                 array_end = cur + mono_array_length_fast (array);
 623                 tombstone = SGEN_LOAD_VTABLE ((GCObject*)array)->domain->ephemeron_tombstone;
 624
 625                 for (; cur < array_end; ++cur) {
 626                         GCObject *key = cur->key;
 627
 628                         if (!key || key == tombstone)
 629                                 continue;
 630
 631                         SGEN_LOG (5, "[%zd] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
 632                                 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
 633                                 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
 634
 635                         if (!sgen_is_object_alive_for_current_gen (key)) {
 636                                 cur->key = tombstone;
 637                                 cur->value = NULL;
 638                                 continue;
 639                         }
 640                 }
 641                 prev = current;
 642                 current = current->next;
 643         }
 644 }
 645
 646 /*
 647 LOCKING: requires that the GC lock is held
 648
 649 Limitations: We scan all ephemerons on every collection since the current design doesn't allow for a simple nursery/mature split.
 650 */
 651 gboolean
 652 sgen_client_mark_ephemerons (ScanCopyContext ctx)
 653 {
 654         CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
 655         SgenGrayQueue *queue = ctx.queue;
 656         gboolean nothing_marked = TRUE;
 657         EphemeronLinkNode *current = ephemeron_list;
 658         Ephemeron *cur, *array_end;
 659         GCObject *tombstone;
 660
 661         for (current = ephemeron_list; current; current = current->next) {
 662                 MonoArray *array = current->array;
 663                 SGEN_LOG (5, "Ephemeron array at %p", array);
 664
 665                 /*It has to be alive*/
 666                 if (!sgen_is_object_alive_for_current_gen ((GCObject*)array)) {
 667                         SGEN_LOG (5, "\tnot reachable");
 668                         continue;
 669                 }
 670
 671                 copy_func ((GCObject**)&array, queue);
 672
 673                 cur = mono_array_addr (array, Ephemeron, 0);
 674                 array_end = cur + mono_array_length_fast (array);
 675                 tombstone = SGEN_LOAD_VTABLE ((GCObject*)array)->domain->ephemeron_tombstone;
 676
 677                 for (; cur < array_end; ++cur) {
 678                         GCObject *key = cur->key;
 679
 680                         if (!key || key == tombstone)
 681                                 continue;
 682
 683                         SGEN_LOG (5, "[%zd] key %p (%s) value %p (%s)", cur - mono_array_addr (array, Ephemeron, 0),
 684                                 key, sgen_is_object_alive_for_current_gen (key) ? "reachable" : "unreachable",
 685                                 cur->value, cur->value && sgen_is_object_alive_for_current_gen (cur->value) ? "reachable" : "unreachable");
 686
 687                         if (sgen_is_object_alive_for_current_gen (key)) {
 688                                 GCObject *value = cur->value;
 689
 690                                 copy_func (&cur->key, queue);
 691                                 if (value) {
 692                                         if (!sgen_is_object_alive_for_current_gen (value))
 693                                                 nothing_marked = FALSE;
 694                                         copy_func (&cur->value, queue);
 695                                 }
 696                         }
 697                 }
 698         }
 699
 700         SGEN_LOG (5, "Ephemeron run finished. Is it done %d", nothing_marked);
 701         return nothing_marked;
 702 }
 703
 704 gboolean
 705 mono_gc_ephemeron_array_add (MonoObject *obj)
 706 {
 707         EphemeronLinkNode *node;
 708
 709         LOCK_GC;
 710
 711         node = (EphemeronLinkNode *)sgen_alloc_internal (INTERNAL_MEM_EPHEMERON_LINK);
 712         if (!node) {
 713                 UNLOCK_GC;
 714                 return FALSE;
 715         }
 716         node->array = (MonoArray*)obj;
 717         node->next = ephemeron_list;
 718         ephemeron_list = node;
 719
 720         SGEN_LOG (5, "Registered ephemeron array %p", obj);
 721
 722         UNLOCK_GC;
 723         return TRUE;
 724 }
 725
 726 /*
 727  * Appdomain handling
 728  */
 729
 730 void
 731 mono_gc_set_current_thread_appdomain (MonoDomain *domain)
 732 {
 733         SgenThreadInfo *info = mono_thread_info_current ();
 734
 735         /* Could be called from sgen_thread_unregister () with a NULL info */
 736         if (domain) {
 737                 g_assert (info);
 738                 info->client_info.stopped_domain = domain;
 739         }
 740 }
 741
 742 static gboolean
 743 need_remove_object_for_domain (GCObject *start, MonoDomain *domain)
 744 {
 745         if (mono_object_domain (start) == domain) {
 746                 SGEN_LOG (4, "Need to cleanup object %p", start);
 747                 binary_protocol_cleanup (start, (gpointer)SGEN_LOAD_VTABLE (start), sgen_safe_object_get_size ((GCObject*)start));
 748                 return TRUE;
 749         }
 750         return FALSE;
 751 }
 752
 753 static void
 754 process_object_for_domain_clearing (GCObject *start, MonoDomain *domain)
 755 {
 756         MonoVTable *vt = SGEN_LOAD_VTABLE (start);
 757         if (vt->klass == mono_defaults.internal_thread_class)
 758                 g_assert (mono_object_domain (start) == mono_get_root_domain ());
 759         /* The object could be a proxy for an object in the domain
 760            we're deleting. */
 761 #ifndef DISABLE_REMOTING
 762         if (mono_defaults.real_proxy_class->supertypes && mono_class_has_parent_fast (vt->klass, mono_defaults.real_proxy_class)) {
 763                 MonoObject *server = ((MonoRealProxy*)start)->unwrapped_server;
 764
 765                 /* The server could already have been zeroed out, so
 766                    we need to check for that, too. */
 767                 if (server && (!SGEN_LOAD_VTABLE (server) || mono_object_domain (server) == domain)) {
 768                         SGEN_LOG (4, "Cleaning up remote pointer in %p to object %p", start, server);
 769                         ((MonoRealProxy*)start)->unwrapped_server = NULL;
 770                 }
 771         }
 772 #endif
 773 }
 774
 775 static gboolean
 776 clear_domain_process_object (GCObject *obj, MonoDomain *domain)
 777 {
 778         gboolean remove;
 779
 780         process_object_for_domain_clearing (obj, domain);
 781         remove = need_remove_object_for_domain (obj, domain);
 782
 783         if (remove && obj->synchronisation) {
 784                 guint32 dislink = mono_monitor_get_object_monitor_gchandle (obj);
 785                 if (dislink)
 786                         mono_gchandle_free (dislink);
 787         }
 788
 789         return remove;
 790 }
 791
 792 static void
 793 clear_domain_process_minor_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
 794 {
 795         if (clear_domain_process_object (obj, domain)) {
 796                 CANARIFY_SIZE (size);
 797                 memset (obj, 0, size);
 798         }
 799 }
 800
 801 static void
 802 clear_domain_process_major_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
 803 {
 804         clear_domain_process_object (obj, domain);
 805 }
 806
 807 static void
 808 clear_domain_free_major_non_pinned_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
 809 {
 810         if (need_remove_object_for_domain (obj, domain))
 811                 major_collector.free_non_pinned_object (obj, size);
 812 }
 813
 814 static void
 815 clear_domain_free_major_pinned_object_callback (GCObject *obj, size_t size, MonoDomain *domain)
 816 {
 817         if (need_remove_object_for_domain (obj, domain))
 818                 major_collector.free_pinned_object (obj, size);
 819 }
 820
 821 /*
 822  * When appdomains are unloaded we can easily remove objects that have finalizers,
 823  * but all the others could still be present in random places on the heap.
 824  * We need a sweep to get rid of them even though it's going to be costly
 825  * with big heaps.
 826  * The reason we need to remove them is because we access the vtable and class
 827  * structures to know the object size and the reference bitmap: once the domain is
 828  * unloaded the point to random memory.
 829  */
 830 void
 831 mono_gc_clear_domain (MonoDomain * domain)
 832 {
 833         LOSObject *bigobj, *prev;
 834         int i;
 835
 836         LOCK_GC;
 837
 838         binary_protocol_domain_unload_begin (domain);
 839
 840         sgen_stop_world (0);
 841
 842         if (sgen_concurrent_collection_in_progress ())
 843                 sgen_perform_collection (0, GENERATION_OLD, "clear domain", TRUE);
 844         SGEN_ASSERT (0, !sgen_concurrent_collection_in_progress (), "We just ordered a synchronous collection.  Why are we collecting concurrently?");
 845
 846         major_collector.finish_sweeping ();
 847
 848         sgen_process_fin_stage_entries ();
 849
 850         sgen_clear_nursery_fragments ();
 851
 852         if (sgen_mono_xdomain_checks && domain != mono_get_root_domain ()) {
 853                 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_NORMAL);
 854                 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_WBARRIER);
 855                 sgen_check_for_xdomain_refs ();
 856         }
 857
 858         /*Ephemerons and dislinks must be processed before LOS since they might end up pointing
 859         to memory returned to the OS.*/
 860         null_ephemerons_for_domain (domain);
 861         sgen_null_links_for_domain (domain);
 862
 863         for (i = GENERATION_NURSERY; i < GENERATION_MAX; ++i)
 864                 sgen_remove_finalizers_if (object_in_domain_predicate, domain, i);
 865
 866         sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
 867                         (IterateObjectCallbackFunc)clear_domain_process_minor_object_callback, domain, FALSE, TRUE);
 868
 869         /* We need two passes over major and large objects because
 870            freeing such objects might give their memory back to the OS
 871            (in the case of large objects) or obliterate its vtable
 872            (pinned objects with major-copying or pinned and non-pinned
 873            objects with major-mark&sweep), but we might need to
 874            dereference a pointer from an object to another object if
 875            the first object is a proxy. */
 876         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, (IterateObjectCallbackFunc)clear_domain_process_major_object_callback, domain);
 877         for (bigobj = los_object_list; bigobj; bigobj = bigobj->next)
 878                 clear_domain_process_object ((GCObject*)bigobj->data, domain);
 879
 880         prev = NULL;
 881         for (bigobj = los_object_list; bigobj;) {
 882                 if (need_remove_object_for_domain ((GCObject*)bigobj->data, domain)) {
 883                         LOSObject *to_free = bigobj;
 884                         if (prev)
 885                                 prev->next = bigobj->next;
 886                         else
 887                                 los_object_list = bigobj->next;
 888                         bigobj = bigobj->next;
 889                         SGEN_LOG (4, "Freeing large object %p", bigobj->data);
 890                         sgen_los_free_object (to_free);
 891                         continue;
 892                 }
 893                 prev = bigobj;
 894                 bigobj = bigobj->next;
 895         }
 896         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_NON_PINNED, (IterateObjectCallbackFunc)clear_domain_free_major_non_pinned_object_callback, domain);
 897         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_PINNED, (IterateObjectCallbackFunc)clear_domain_free_major_pinned_object_callback, domain);
 898
 899         if (domain == mono_get_root_domain ()) {
 900                 sgen_pin_stats_print_class_stats ();
 901                 sgen_object_layout_dump (stdout);
 902         }
 903
 904         sgen_restart_world (0, NULL);
 905
 906         binary_protocol_domain_unload_end (domain);
 907         binary_protocol_flush_buffers (FALSE);
 908
 909         UNLOCK_GC;
 910 }
 911
 912 /*
 913  * Allocation
 914  */
 915
 916 static gboolean alloc_events = FALSE;
 917
 918 void
 919 mono_gc_enable_alloc_events (void)
 920 {
 921         alloc_events = TRUE;
 922 }
 923
 924 void*
 925 mono_gc_alloc_obj (MonoVTable *vtable, size_t size)
 926 {
 927         MonoObject *obj = sgen_alloc_obj (vtable, size);
 928
 929         if (G_UNLIKELY (alloc_events)) {
 930                 if (obj)
 931                         mono_profiler_allocation (obj);
 932         }
 933
 934         return obj;
 935 }
 936
 937 void*
 938 mono_gc_alloc_pinned_obj (MonoVTable *vtable, size_t size)
 939 {
 940         MonoObject *obj = sgen_alloc_obj_pinned (vtable, size);
 941
 942         if (G_UNLIKELY (alloc_events)) {
 943                 if (obj)
 944                         mono_profiler_allocation (obj);
 945         }
 946
 947         return obj;
 948 }
 949
 950 void*
 951 mono_gc_alloc_mature (MonoVTable *vtable, size_t size)
 952 {
 953         MonoObject *obj = sgen_alloc_obj_mature (vtable, size);
 954
 955         if (G_UNLIKELY (alloc_events)) {
 956                 if (obj)
 957                         mono_profiler_allocation (obj);
 958         }
 959
 960         return obj;
 961 }
 962
 963 void*
 964 mono_gc_alloc_fixed (size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
 965 {
 966         /* FIXME: do a single allocation */
 967         void *res = calloc (1, size);
 968         if (!res)
 969                 return NULL;
 970         if (!mono_gc_register_root ((char *)res, size, descr, source, msg)) {
 971                 free (res);
 972                 res = NULL;
 973         }
 974         return res;
 975 }
 976
 977 void
 978 mono_gc_free_fixed (void* addr)
 979 {
 980         mono_gc_deregister_root ((char *)addr);
 981         free (addr);
 982 }
 983
 984 /*
 985  * Managed allocator
 986  */
 987
 988 static MonoMethod* alloc_method_cache [ATYPE_NUM];
 989 static MonoMethod* slowpath_alloc_method_cache [ATYPE_NUM];
 990 static gboolean use_managed_allocator = TRUE;
 991
 992 #ifdef MANAGED_ALLOCATION
 993
 994 #ifdef HAVE_KW_THREAD
 995
 996 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb)   do {    \
 997         mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX);   \
 998         mono_mb_emit_byte ((mb), CEE_MONO_TLS);         \
 999         mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_TLAB_NEXT_ADDR);            \
1000         } while (0)
1001
1002 #define EMIT_TLS_ACCESS_TEMP_END(mb)    do {    \
1003         mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX);   \
1004         mono_mb_emit_byte ((mb), CEE_MONO_TLS);         \
1005         mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_TLAB_TEMP_END);             \
1006         } while (0)
1007
1008 #else
1009
1010 #if defined(TARGET_OSX) || defined(TARGET_WIN32) || defined(TARGET_ANDROID) || defined(TARGET_IOS)
1011 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb)   do {    \
1012         mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX);   \
1013         mono_mb_emit_byte ((mb), CEE_MONO_TLS);         \
1014         mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_THREAD_INFO);       \
1015         mono_mb_emit_icon ((mb), MONO_STRUCT_OFFSET (SgenThreadInfo, tlab_next_addr));  \
1016         mono_mb_emit_byte ((mb), CEE_ADD);              \
1017         mono_mb_emit_byte ((mb), CEE_LDIND_I);          \
1018         } while (0)
1019
1020 #define EMIT_TLS_ACCESS_TEMP_END(mb)    do {    \
1021         mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX);   \
1022         mono_mb_emit_byte ((mb), CEE_MONO_TLS);         \
1023         mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_THREAD_INFO);       \
1024         mono_mb_emit_icon ((mb), MONO_STRUCT_OFFSET (SgenThreadInfo, tlab_temp_end));   \
1025         mono_mb_emit_byte ((mb), CEE_ADD);              \
1026         mono_mb_emit_byte ((mb), CEE_LDIND_I);          \
1027         } while (0)
1028
1029 #else
1030 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb)   do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1031 #define EMIT_TLS_ACCESS_TEMP_END(mb)    do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1032 #endif
1033
1034 #endif
1035
1036 /* FIXME: Do this in the JIT, where specialized allocation sequences can be created
1037  * for each class. This is currently not easy to do, as it is hard to generate basic
1038  * blocks + branches, but it is easy with the linear IL codebase.
1039  *
1040  * For this to work we'd need to solve the TLAB race, first.  Now we
1041  * require the allocator to be in a few known methods to make sure
1042  * that they are executed atomically via the restart mechanism.
1043  */
1044 static MonoMethod*
1045 create_allocator (int atype, gboolean slowpath)
1046 {
1047         int p_var, size_var;
1048         guint32 slowpath_branch, max_size_branch;
1049         MonoMethodBuilder *mb;
1050         MonoMethod *res;
1051         MonoMethodSignature *csig;
1052         static gboolean registered = FALSE;
1053         int tlab_next_addr_var, new_next_var;
1054         const char *name = NULL;
1055         WrapperInfo *info;
1056         int num_params, i;
1057
1058         if (!registered) {
1059                 mono_register_jit_icall (mono_gc_alloc_obj, "mono_gc_alloc_obj", mono_create_icall_signature ("object ptr int"), FALSE);
1060                 mono_register_jit_icall (mono_gc_alloc_vector, "mono_gc_alloc_vector", mono_create_icall_signature ("object ptr int int"), FALSE);
1061                 mono_register_jit_icall (mono_gc_alloc_string, "mono_gc_alloc_string", mono_create_icall_signature ("object ptr int int32"), FALSE);
1062                 registered = TRUE;
1063         }
1064
1065         if (atype == ATYPE_SMALL) {
1066                 name = slowpath ? "SlowAllocSmall" : "AllocSmall";
1067         } else if (atype == ATYPE_NORMAL) {
1068                 name = slowpath ? "SlowAlloc" : "Alloc";
1069         } else if (atype == ATYPE_VECTOR) {
1070                 name = slowpath ? "SlowAllocVector" : "AllocVector";
1071         } else if (atype == ATYPE_STRING) {
1072                 name = slowpath ? "SlowAllocString" : "AllocString";
1073         } else {
1074                 g_assert_not_reached ();
1075         }
1076
1077         if (atype == ATYPE_NORMAL)
1078                 num_params = 1;
1079         else
1080                 num_params = 2;
1081
1082         csig = mono_metadata_signature_alloc (mono_defaults.corlib, num_params);
1083         if (atype == ATYPE_STRING) {
1084                 csig->ret = &mono_defaults.string_class->byval_arg;
1085                 csig->params [0] = &mono_defaults.int_class->byval_arg;
1086                 csig->params [1] = &mono_defaults.int32_class->byval_arg;
1087         } else {
1088                 csig->ret = &mono_defaults.object_class->byval_arg;
1089                 for (i = 0; i < num_params; i++)
1090                         csig->params [i] = &mono_defaults.int_class->byval_arg;
1091         }
1092
1093         mb = mono_mb_new (mono_defaults.object_class, name, MONO_WRAPPER_ALLOC);
1094
1095 #ifndef DISABLE_JIT
1096         if (slowpath) {
1097                 switch (atype) {
1098                 case ATYPE_NORMAL:
1099                 case ATYPE_SMALL:
1100                         mono_mb_emit_ldarg (mb, 0);
1101                         mono_mb_emit_icall (mb, ves_icall_object_new_specific);
1102                         break;
1103                 case ATYPE_VECTOR:
1104                         mono_mb_emit_ldarg (mb, 0);
1105                         mono_mb_emit_ldarg (mb, 1);
1106                         mono_mb_emit_icall (mb, ves_icall_array_new_specific);
1107                         break;
1108                 case ATYPE_STRING:
1109                         mono_mb_emit_ldarg (mb, 1);
1110                         mono_mb_emit_icall (mb, ves_icall_string_alloc);
1111                         break;
1112                 default:
1113                         g_assert_not_reached ();
1114                 }
1115
1116                 goto done;
1117         }
1118
1119         size_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1120         if (atype == ATYPE_SMALL) {
1121                 /* size_var = size_arg */
1122                 mono_mb_emit_ldarg (mb, 1);
1123                 mono_mb_emit_stloc (mb, size_var);
1124         } else if (atype == ATYPE_NORMAL) {
1125                 /* size = vtable->klass->instance_size; */
1126                 mono_mb_emit_ldarg (mb, 0);
1127                 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoVTable, klass));
1128                 mono_mb_emit_byte (mb, CEE_ADD);
1129                 mono_mb_emit_byte (mb, CEE_LDIND_I);
1130                 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoClass, instance_size));
1131                 mono_mb_emit_byte (mb, CEE_ADD);
1132                 /* FIXME: assert instance_size stays a 4 byte integer */
1133                 mono_mb_emit_byte (mb, CEE_LDIND_U4);
1134                 mono_mb_emit_byte (mb, CEE_CONV_I);
1135                 mono_mb_emit_stloc (mb, size_var);
1136         } else if (atype == ATYPE_VECTOR) {
1137                 MonoExceptionClause *clause;
1138                 int pos, pos_leave, pos_error;
1139                 MonoClass *oom_exc_class;
1140                 MonoMethod *ctor;
1141
1142                 /*
1143                  * n > MONO_ARRAY_MAX_INDEX => OutOfMemoryException
1144                  * n < 0                    => OverflowException
1145                  *
1146                  * We can do an unsigned comparison to catch both cases, then in the error
1147                  * case compare signed to distinguish between them.
1148                  */
1149                 mono_mb_emit_ldarg (mb, 1);
1150                 mono_mb_emit_icon (mb, MONO_ARRAY_MAX_INDEX);
1151                 mono_mb_emit_byte (mb, CEE_CONV_U);
1152                 pos = mono_mb_emit_short_branch (mb, CEE_BLE_UN_S);
1153
1154                 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1155                 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1156                 mono_mb_emit_ldarg (mb, 1);
1157                 mono_mb_emit_icon (mb, 0);
1158                 pos_error = mono_mb_emit_short_branch (mb, CEE_BLT_S);
1159                 mono_mb_emit_exception (mb, "OutOfMemoryException", NULL);
1160                 mono_mb_patch_short_branch (mb, pos_error);
1161                 mono_mb_emit_exception (mb, "OverflowException", NULL);
1162
1163                 mono_mb_patch_short_branch (mb, pos);
1164
1165                 clause = (MonoExceptionClause *)mono_image_alloc0 (mono_defaults.corlib, sizeof (MonoExceptionClause));
1166                 clause->try_offset = mono_mb_get_label (mb);
1167
1168                 /* vtable->klass->sizes.element_size */
1169                 mono_mb_emit_ldarg (mb, 0);
1170                 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoVTable, klass));
1171                 mono_mb_emit_byte (mb, CEE_ADD);
1172                 mono_mb_emit_byte (mb, CEE_LDIND_I);
1173                 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoClass, sizes));
1174                 mono_mb_emit_byte (mb, CEE_ADD);
1175                 mono_mb_emit_byte (mb, CEE_LDIND_U4);
1176                 mono_mb_emit_byte (mb, CEE_CONV_I);
1177
1178                 /* * n */
1179                 mono_mb_emit_ldarg (mb, 1);
1180                 mono_mb_emit_byte (mb, CEE_MUL_OVF_UN);
1181                 /* + sizeof (MonoArray) */
1182                 mono_mb_emit_icon (mb, MONO_SIZEOF_MONO_ARRAY);
1183                 mono_mb_emit_byte (mb, CEE_ADD_OVF_UN);
1184                 mono_mb_emit_stloc (mb, size_var);
1185
1186                 pos_leave = mono_mb_emit_branch (mb, CEE_LEAVE);
1187
1188                 /* catch */
1189                 clause->flags = MONO_EXCEPTION_CLAUSE_NONE;
1190                 clause->try_len = mono_mb_get_pos (mb) - clause->try_offset;
1191                 clause->data.catch_class = mono_class_load_from_name (mono_defaults.corlib,
1192                                 "System", "OverflowException");
1193                 clause->handler_offset = mono_mb_get_label (mb);
1194
1195                 oom_exc_class = mono_class_load_from_name (mono_defaults.corlib,
1196                                 "System", "OutOfMemoryException");
1197                 ctor = mono_class_get_method_from_name (oom_exc_class, ".ctor", 0);
1198                 g_assert (ctor);
1199
1200                 mono_mb_emit_byte (mb, CEE_POP);
1201                 mono_mb_emit_op (mb, CEE_NEWOBJ, ctor);
1202                 mono_mb_emit_byte (mb, CEE_THROW);
1203
1204                 clause->handler_len = mono_mb_get_pos (mb) - clause->handler_offset;
1205                 mono_mb_set_clauses (mb, 1, clause);
1206                 mono_mb_patch_branch (mb, pos_leave);
1207                 /* end catch */
1208         } else if (atype == ATYPE_STRING) {
1209                 int pos;
1210
1211                 /*
1212                  * a string allocator method takes the args: (vtable, len)
1213                  *
1214                  * bytes = offsetof (MonoString, chars) + ((len + 1) * 2)
1215                  *
1216                  * condition:
1217                  *
1218                  * bytes <= INT32_MAX - (SGEN_ALLOC_ALIGN - 1)
1219                  *
1220                  * therefore:
1221                  *
1222                  * offsetof (MonoString, chars) + ((len + 1) * 2) <= INT32_MAX - (SGEN_ALLOC_ALIGN - 1)
1223                  * len <= (INT32_MAX - (SGEN_ALLOC_ALIGN - 1) - offsetof (MonoString, chars)) / 2 - 1
1224                  */
1225                 mono_mb_emit_ldarg (mb, 1);
1226                 mono_mb_emit_icon (mb, (INT32_MAX - (SGEN_ALLOC_ALIGN - 1) - MONO_STRUCT_OFFSET (MonoString, chars)) / 2 - 1);
1227                 pos = mono_mb_emit_short_branch (mb, MONO_CEE_BLE_UN_S);
1228
1229                 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1230                 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1231                 mono_mb_emit_exception (mb, "OutOfMemoryException", NULL);
1232                 mono_mb_patch_short_branch (mb, pos);
1233
1234                 mono_mb_emit_ldarg (mb, 1);
1235                 mono_mb_emit_icon (mb, 1);
1236                 mono_mb_emit_byte (mb, MONO_CEE_SHL);
1237                 //WE manually fold the above + 2 here
1238                 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoString, chars) + 2);
1239                 mono_mb_emit_byte (mb, CEE_ADD);
1240                 mono_mb_emit_stloc (mb, size_var);
1241         } else {
1242                 g_assert_not_reached ();
1243         }
1244
1245         if (atype != ATYPE_SMALL) {
1246                 /* size += ALLOC_ALIGN - 1; */
1247                 mono_mb_emit_ldloc (mb, size_var);
1248                 mono_mb_emit_icon (mb, SGEN_ALLOC_ALIGN - 1);
1249                 mono_mb_emit_byte (mb, CEE_ADD);
1250                 /* size &= ~(ALLOC_ALIGN - 1); */
1251                 mono_mb_emit_icon (mb, ~(SGEN_ALLOC_ALIGN - 1));
1252                 mono_mb_emit_byte (mb, CEE_AND);
1253                 mono_mb_emit_stloc (mb, size_var);
1254         }
1255
1256         /* if (size > MAX_SMALL_OBJ_SIZE) goto slowpath */
1257         if (atype != ATYPE_SMALL) {
1258                 mono_mb_emit_ldloc (mb, size_var);
1259                 mono_mb_emit_icon (mb, SGEN_MAX_SMALL_OBJ_SIZE);
1260                 max_size_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BGT_UN_S);
1261         }
1262
1263         /*
1264          * We need to modify tlab_next, but the JIT only supports reading, so we read
1265          * another tls var holding its address instead.
1266          */
1267
1268         /* tlab_next_addr (local) = tlab_next_addr (TLS var) */
1269         tlab_next_addr_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1270         EMIT_TLS_ACCESS_NEXT_ADDR (mb);
1271         mono_mb_emit_stloc (mb, tlab_next_addr_var);
1272
1273         /* p = (void**)tlab_next; */
1274         p_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1275         mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1276         mono_mb_emit_byte (mb, CEE_LDIND_I);
1277         mono_mb_emit_stloc (mb, p_var);
1278
1279         /* new_next = (char*)p + size; */
1280         new_next_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1281         mono_mb_emit_ldloc (mb, p_var);
1282         mono_mb_emit_ldloc (mb, size_var);
1283         mono_mb_emit_byte (mb, CEE_CONV_I);
1284         mono_mb_emit_byte (mb, CEE_ADD);
1285         mono_mb_emit_stloc (mb, new_next_var);
1286
1287         /* if (G_LIKELY (new_next < tlab_temp_end)) */
1288         mono_mb_emit_ldloc (mb, new_next_var);
1289         EMIT_TLS_ACCESS_TEMP_END (mb);
1290         slowpath_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLT_UN_S);
1291
1292         /* Slowpath */
1293         if (atype != ATYPE_SMALL)
1294                 mono_mb_patch_short_branch (mb, max_size_branch);
1295
1296         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1297         mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1298
1299         /* FIXME: mono_gc_alloc_obj takes a 'size_t' as an argument, not an int32 */
1300         mono_mb_emit_ldarg (mb, 0);
1301         mono_mb_emit_ldloc (mb, size_var);
1302         if (atype == ATYPE_NORMAL || atype == ATYPE_SMALL) {
1303                 mono_mb_emit_icall (mb, mono_gc_alloc_obj);
1304         } else if (atype == ATYPE_VECTOR) {
1305                 mono_mb_emit_ldarg (mb, 1);
1306                 mono_mb_emit_icall (mb, mono_gc_alloc_vector);
1307         } else if (atype == ATYPE_STRING) {
1308                 mono_mb_emit_ldarg (mb, 1);
1309                 mono_mb_emit_icall (mb, mono_gc_alloc_string);
1310         } else {
1311                 g_assert_not_reached ();
1312         }
1313         mono_mb_emit_byte (mb, CEE_RET);
1314
1315         /* Fastpath */
1316         mono_mb_patch_short_branch (mb, slowpath_branch);
1317
1318         /* FIXME: Memory barrier */
1319
1320         /* tlab_next = new_next */
1321         mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1322         mono_mb_emit_ldloc (mb, new_next_var);
1323         mono_mb_emit_byte (mb, CEE_STIND_I);
1324
1325         /*The tlab store must be visible before the the vtable store. This could be replaced with a DDS but doing it with IL would be tricky. */
1326         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1327         mono_mb_emit_byte (mb, CEE_MONO_MEMORY_BARRIER);
1328         mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_REL);
1329
1330         /* *p = vtable; */
1331         mono_mb_emit_ldloc (mb, p_var);
1332         mono_mb_emit_ldarg (mb, 0);
1333         mono_mb_emit_byte (mb, CEE_STIND_I);
1334
1335         if (atype == ATYPE_VECTOR) {
1336                 /* arr->max_length = max_length; */
1337                 mono_mb_emit_ldloc (mb, p_var);
1338                 mono_mb_emit_ldflda (mb, MONO_STRUCT_OFFSET (MonoArray, max_length));
1339                 mono_mb_emit_ldarg (mb, 1);
1340 #ifdef MONO_BIG_ARRAYS
1341                 mono_mb_emit_byte (mb, CEE_STIND_I);
1342 #else
1343                 mono_mb_emit_byte (mb, CEE_STIND_I4);
1344 #endif
1345         } else  if (atype == ATYPE_STRING) {
1346                 /* need to set length and clear the last char */
1347                 /* s->length = len; */
1348                 mono_mb_emit_ldloc (mb, p_var);
1349                 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoString, length));
1350                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
1351                 mono_mb_emit_ldarg (mb, 1);
1352                 mono_mb_emit_byte (mb, MONO_CEE_STIND_I4);
1353                 /* s->chars [len] = 0; */
1354                 mono_mb_emit_ldloc (mb, p_var);
1355                 mono_mb_emit_ldloc (mb, size_var);
1356                 mono_mb_emit_icon (mb, 2);
1357                 mono_mb_emit_byte (mb, MONO_CEE_SUB);
1358                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
1359                 mono_mb_emit_icon (mb, 0);
1360                 mono_mb_emit_byte (mb, MONO_CEE_STIND_I2);
1361         }
1362
1363         /*
1364         We must make sure both vtable and max_length are globaly visible before returning to managed land.
1365         */
1366         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1367         mono_mb_emit_byte (mb, CEE_MONO_MEMORY_BARRIER);
1368         mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_REL);
1369
1370         /* return p */
1371         mono_mb_emit_ldloc (mb, p_var);
1372
1373  done:
1374         mono_mb_emit_byte (mb, CEE_RET);
1375 #endif
1376
1377         info = mono_wrapper_info_create (mb, WRAPPER_SUBTYPE_NONE);
1378         info->d.alloc.gc_name = "sgen";
1379         info->d.alloc.alloc_type = atype;
1380
1381 #ifndef DISABLE_JIT
1382         mb->init_locals = FALSE;
1383 #endif
1384
1385         res = mono_mb_create (mb, csig, 8, info);
1386         mono_mb_free (mb);
1387
1388
1389         return res;
1390 }
1391 #endif
1392
1393 int
1394 mono_gc_get_aligned_size_for_allocator (int size)
1395 {
1396         return SGEN_ALIGN_UP (size);
1397 }
1398
1399 /*
1400  * Generate an allocator method implementing the fast path of mono_gc_alloc_obj ().
1401  * The signature of the called method is:
1402  *      object allocate (MonoVTable *vtable)
1403  */
1404 MonoMethod*
1405 mono_gc_get_managed_allocator (MonoClass *klass, gboolean for_box, gboolean known_instance_size)
1406 {
1407 #ifdef MANAGED_ALLOCATION
1408         if (collect_before_allocs)
1409                 return NULL;
1410         if (!mono_runtime_has_tls_get ())
1411                 return NULL;
1412         if (klass->instance_size > tlab_size)
1413                 return NULL;
1414         if (known_instance_size && ALIGN_TO (klass->instance_size, SGEN_ALLOC_ALIGN) >= SGEN_MAX_SMALL_OBJ_SIZE)
1415                 return NULL;
1416         if (mono_class_has_finalizer (klass) || mono_class_is_marshalbyref (klass) || (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS))
1417                 return NULL;
1418         if (klass->rank)
1419                 return NULL;
1420         if (klass->byval_arg.type == MONO_TYPE_STRING)
1421                 return mono_gc_get_managed_allocator_by_type (ATYPE_STRING, FALSE);
1422         /* Generic classes have dynamic field and can go above MAX_SMALL_OBJ_SIZE. */
1423         if (known_instance_size)
1424                 return mono_gc_get_managed_allocator_by_type (ATYPE_SMALL, FALSE);
1425         else
1426                 return mono_gc_get_managed_allocator_by_type (ATYPE_NORMAL, FALSE);
1427 #else
1428         return NULL;
1429 #endif
1430 }
1431
1432 MonoMethod*
1433 mono_gc_get_managed_array_allocator (MonoClass *klass)
1434 {
1435 #ifdef MANAGED_ALLOCATION
1436         if (klass->rank != 1)
1437                 return NULL;
1438         if (!mono_runtime_has_tls_get ())
1439                 return NULL;
1440         if (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS)
1441                 return NULL;
1442         if (has_per_allocation_action)
1443                 return NULL;
1444         g_assert (!mono_class_has_finalizer (klass) && !mono_class_is_marshalbyref (klass));
1445
1446         return mono_gc_get_managed_allocator_by_type (ATYPE_VECTOR, FALSE);
1447 #else
1448         return NULL;
1449 #endif
1450 }
1451
1452 void
1453 sgen_set_use_managed_allocator (gboolean flag)
1454 {
1455         use_managed_allocator = flag;
1456 }
1457
1458 MonoMethod*
1459 mono_gc_get_managed_allocator_by_type (int atype, gboolean slowpath)
1460 {
1461 #ifdef MANAGED_ALLOCATION
1462         MonoMethod *res;
1463         MonoMethod **cache = slowpath ? slowpath_alloc_method_cache : alloc_method_cache;
1464
1465         if (!use_managed_allocator)
1466                 return NULL;
1467
1468         if (!mono_runtime_has_tls_get ())
1469                 return NULL;
1470
1471         res = cache [atype];
1472         if (res)
1473                 return res;
1474
1475         res = create_allocator (atype, slowpath);
1476         LOCK_GC;
1477         if (cache [atype]) {
1478                 mono_free_method (res);
1479                 res = cache [atype];
1480         } else {
1481                 mono_memory_barrier ();
1482                 cache [atype] = res;
1483         }
1484         UNLOCK_GC;
1485
1486         return res;
1487 #else
1488         return NULL;
1489 #endif
1490 }
1491
1492 guint32
1493 mono_gc_get_managed_allocator_types (void)
1494 {
1495         return ATYPE_NUM;
1496 }
1497
1498 gboolean
1499 sgen_is_managed_allocator (MonoMethod *method)
1500 {
1501         int i;
1502
1503         for (i = 0; i < ATYPE_NUM; ++i)
1504                 if (method == alloc_method_cache [i] || method == slowpath_alloc_method_cache [i])
1505                         return TRUE;
1506         return FALSE;
1507 }
1508
1509 gboolean
1510 sgen_has_managed_allocator (void)
1511 {
1512         int i;
1513
1514         for (i = 0; i < ATYPE_NUM; ++i)
1515                 if (alloc_method_cache [i] || slowpath_alloc_method_cache [i])
1516                         return TRUE;
1517         return FALSE;
1518 }
1519
1520 /*
1521  * Cardtable scanning
1522  */
1523
1524 #define MWORD_MASK (sizeof (mword) - 1)
1525
1526 static inline int
1527 find_card_offset (mword card)
1528 {
1529 /*XXX Use assembly as this generates some pretty bad code */
1530 #if defined(__i386__) && defined(__GNUC__)
1531         return  (__builtin_ffs (card) - 1) / 8;
1532 #elif defined(__x86_64__) && defined(__GNUC__)
1533         return (__builtin_ffsll (card) - 1) / 8;
1534 #elif defined(__s390x__)
1535         return (__builtin_ffsll (GUINT64_TO_LE(card)) - 1) / 8;
1536 #else
1537         int i;
1538         guint8 *ptr = (guint8 *) &card;
1539         for (i = 0; i < sizeof (mword); ++i) {
1540                 if (ptr[i])
1541                         return i;
1542         }
1543         return 0;
1544 #endif
1545 }
1546
1547 static guint8*
1548 find_next_card (guint8 *card_data, guint8 *end)
1549 {
1550         mword *cards, *cards_end;
1551         mword card;
1552
1553         while ((((mword)card_data) & MWORD_MASK) && card_data < end) {
1554                 if (*card_data)
1555                         return card_data;
1556                 ++card_data;
1557         }
1558
1559         if (card_data == end)
1560                 return end;
1561
1562         cards = (mword*)card_data;
1563         cards_end = (mword*)((mword)end & ~MWORD_MASK);
1564         while (cards < cards_end) {
1565                 card = *cards;
1566                 if (card)
1567                         return (guint8*)cards + find_card_offset (card);
1568                 ++cards;
1569         }
1570
1571         card_data = (guint8*)cards_end;
1572         while (card_data < end) {
1573                 if (*card_data)
1574                         return card_data;
1575                 ++card_data;
1576         }
1577
1578         return end;
1579 }
1580
1581 #define ARRAY_OBJ_INDEX(ptr,array,elem_size) (((char*)(ptr) - ((char*)(array) + G_STRUCT_OFFSET (MonoArray, vector))) / (elem_size))
1582
1583 gboolean
1584 sgen_client_cardtable_scan_object (GCObject *obj, mword block_obj_size, guint8 *cards, ScanCopyContext ctx)
1585 {
1586         MonoVTable *vt = SGEN_LOAD_VTABLE (obj);
1587         MonoClass *klass = vt->klass;
1588
1589         SGEN_ASSERT (0, SGEN_VTABLE_HAS_REFERENCES (vt), "Why would we ever call this on reference-free objects?");
1590
1591         if (vt->rank) {
1592                 MonoArray *arr = (MonoArray*)obj;
1593                 guint8 *card_data, *card_base;
1594                 guint8 *card_data_end;
1595                 char *obj_start = (char *)sgen_card_table_align_pointer (obj);
1596                 mword bounds_size;
1597                 mword obj_size = sgen_mono_array_size (vt, arr, &bounds_size, sgen_vtable_get_descriptor (vt));
1598                 /* We don't want to scan the bounds entries at the end of multidimensional arrays */
1599                 char *obj_end = (char*)obj + obj_size - bounds_size;
1600                 size_t card_count;
1601                 size_t extra_idx = 0;
1602
1603                 mword desc = (mword)klass->element_class->gc_descr;
1604                 int elem_size = mono_array_element_size (klass);
1605
1606 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1607                 guint8 *overflow_scan_end = NULL;
1608 #endif
1609
1610 #ifdef SGEN_OBJECT_LAYOUT_STATISTICS
1611                 if (klass->element_class->valuetype)
1612                         sgen_object_layout_scanned_vtype_array ();
1613                 else
1614                         sgen_object_layout_scanned_ref_array ();
1615 #endif
1616
1617                 if (cards)
1618                         card_data = cards;
1619                 else
1620                         card_data = sgen_card_table_get_card_scan_address ((mword)obj);
1621
1622                 card_base = card_data;
1623                 card_count = sgen_card_table_number_of_cards_in_range ((mword)obj, obj_size);
1624                 card_data_end = card_data + card_count;
1625
1626
1627 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1628                 /*Check for overflow and if so, setup to scan in two steps*/
1629                 if (!cards && card_data_end >= SGEN_SHADOW_CARDTABLE_END) {
1630                         overflow_scan_end = sgen_shadow_cardtable + (card_data_end - SGEN_SHADOW_CARDTABLE_END);
1631                         card_data_end = SGEN_SHADOW_CARDTABLE_END;
1632                 }
1633
1634 LOOP_HEAD:
1635 #endif
1636
1637                 card_data = find_next_card (card_data, card_data_end);
1638                 for (; card_data < card_data_end; card_data = find_next_card (card_data + 1, card_data_end)) {
1639                         size_t index;
1640                         size_t idx = (card_data - card_base) + extra_idx;
1641                         char *start = (char*)(obj_start + idx * CARD_SIZE_IN_BYTES);
1642                         char *card_end = start + CARD_SIZE_IN_BYTES;
1643                         char *first_elem, *elem;
1644
1645                         HEAVY_STAT (++los_marked_cards);
1646
1647                         if (!cards)
1648                                 sgen_card_table_prepare_card_for_scanning (card_data);
1649
1650                         card_end = MIN (card_end, obj_end);
1651
1652                         if (start <= (char*)arr->vector)
1653                                 index = 0;
1654                         else
1655                                 index = ARRAY_OBJ_INDEX (start, obj, elem_size);
1656
1657                         elem = first_elem = (char*)mono_array_addr_with_size_fast ((MonoArray*)obj, elem_size, index);
1658                         if (klass->element_class->valuetype) {
1659                                 ScanVTypeFunc scan_vtype_func = ctx.ops->scan_vtype;
1660
1661                                 for (; elem < card_end; elem += elem_size)
1662                                         scan_vtype_func (obj, elem, desc, ctx.queue BINARY_PROTOCOL_ARG (elem_size));
1663                         } else {
1664                                 ScanPtrFieldFunc scan_ptr_field_func = ctx.ops->scan_ptr_field;
1665
1666                                 HEAVY_STAT (++los_array_cards);
1667                                 for (; elem < card_end; elem += SIZEOF_VOID_P)
1668                                         scan_ptr_field_func (obj, (GCObject**)elem, ctx.queue);
1669                         }
1670
1671                         binary_protocol_card_scan (first_elem, elem - first_elem);
1672                 }
1673
1674 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1675                 if (overflow_scan_end) {
1676                         extra_idx = card_data - card_base;
1677                         card_base = card_data = sgen_shadow_cardtable;
1678                         card_data_end = overflow_scan_end;
1679                         overflow_scan_end = NULL;
1680                         goto LOOP_HEAD;
1681                 }
1682 #endif
1683                 return TRUE;
1684         }
1685
1686         return FALSE;
1687 }
1688
1689 /*
1690  * Array and string allocation
1691  */
1692
1693 void*
1694 mono_gc_alloc_vector (MonoVTable *vtable, size_t size, uintptr_t max_length)
1695 {
1696         MonoArray *arr;
1697         TLAB_ACCESS_INIT;
1698
1699         if (!SGEN_CAN_ALIGN_UP (size))
1700                 return NULL;
1701
1702 #ifndef DISABLE_CRITICAL_REGION
1703         ENTER_CRITICAL_REGION;
1704         arr = (MonoArray*)sgen_try_alloc_obj_nolock (vtable, size);
1705         if (arr) {
1706                 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1707                 arr->max_length = (mono_array_size_t)max_length;
1708                 EXIT_CRITICAL_REGION;
1709                 goto done;
1710         }
1711         EXIT_CRITICAL_REGION;
1712 #endif
1713
1714         LOCK_GC;
1715
1716         arr = (MonoArray*)sgen_alloc_obj_nolock (vtable, size);
1717         if (G_UNLIKELY (!arr)) {
1718                 UNLOCK_GC;
1719                 return NULL;
1720         }
1721
1722         arr->max_length = (mono_array_size_t)max_length;
1723
1724         UNLOCK_GC;
1725
1726  done:
1727         if (G_UNLIKELY (alloc_events))
1728                 mono_profiler_allocation (&arr->obj);
1729
1730         SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size (vtable, (GCObject*)arr)), "Vector has incorrect size.");
1731         return arr;
1732 }
1733
1734 void*
1735 mono_gc_alloc_array (MonoVTable *vtable, size_t size, uintptr_t max_length, uintptr_t bounds_size)
1736 {
1737         MonoArray *arr;
1738         MonoArrayBounds *bounds;
1739         TLAB_ACCESS_INIT;
1740
1741         if (!SGEN_CAN_ALIGN_UP (size))
1742                 return NULL;
1743
1744 #ifndef DISABLE_CRITICAL_REGION
1745         ENTER_CRITICAL_REGION;
1746         arr = (MonoArray*)sgen_try_alloc_obj_nolock (vtable, size);
1747         if (arr) {
1748                 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1749                 arr->max_length = (mono_array_size_t)max_length;
1750
1751                 bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1752                 arr->bounds = bounds;
1753                 EXIT_CRITICAL_REGION;
1754                 goto done;
1755         }
1756         EXIT_CRITICAL_REGION;
1757 #endif
1758
1759         LOCK_GC;
1760
1761         arr = (MonoArray*)sgen_alloc_obj_nolock (vtable, size);
1762         if (G_UNLIKELY (!arr)) {
1763                 UNLOCK_GC;
1764                 return NULL;
1765         }
1766
1767         arr->max_length = (mono_array_size_t)max_length;
1768
1769         bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1770         arr->bounds = bounds;
1771
1772         UNLOCK_GC;
1773
1774  done:
1775         if (G_UNLIKELY (alloc_events))
1776                 mono_profiler_allocation (&arr->obj);
1777
1778         SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size (vtable, (GCObject*)arr)), "Array has incorrect size.");
1779         return arr;
1780 }
1781
1782 void*
1783 mono_gc_alloc_string (MonoVTable *vtable, size_t size, gint32 len)
1784 {
1785         MonoString *str;
1786         TLAB_ACCESS_INIT;
1787
1788         if (!SGEN_CAN_ALIGN_UP (size))
1789                 return NULL;
1790
1791 #ifndef DISABLE_CRITICAL_REGION
1792         ENTER_CRITICAL_REGION;
1793         str = (MonoString*)sgen_try_alloc_obj_nolock (vtable, size);
1794         if (str) {
1795                 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1796                 str->length = len;
1797                 EXIT_CRITICAL_REGION;
1798                 goto done;
1799         }
1800         EXIT_CRITICAL_REGION;
1801 #endif
1802
1803         LOCK_GC;
1804
1805         str = (MonoString*)sgen_alloc_obj_nolock (vtable, size);
1806         if (G_UNLIKELY (!str)) {
1807                 UNLOCK_GC;
1808                 return NULL;
1809         }
1810
1811         str->length = len;
1812
1813         UNLOCK_GC;
1814
1815  done:
1816         if (G_UNLIKELY (alloc_events))
1817                 mono_profiler_allocation (&str->object);
1818
1819         return str;
1820 }
1821
1822 /*
1823  * Strings
1824  */
1825
1826 void
1827 mono_gc_set_string_length (MonoString *str, gint32 new_length)
1828 {
1829         mono_unichar2 *new_end = str->chars + new_length;
1830
1831         /* zero the discarded string. This null-delimits the string and allows
1832          * the space to be reclaimed by SGen. */
1833
1834         if (nursery_canaries_enabled () && sgen_ptr_in_nursery (str)) {
1835                 CHECK_CANARY_FOR_OBJECT ((GCObject*)str, TRUE);
1836                 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2) + CANARY_SIZE);
1837                 memcpy (new_end + 1 , CANARY_STRING, CANARY_SIZE);
1838         } else {
1839                 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2));
1840         }
1841
1842         str->length = new_length;
1843 }
1844
1845 /*
1846  * Profiling
1847  */
1848
1849 #define GC_ROOT_NUM 32
1850 typedef struct {
1851         int count;              /* must be the first field */
1852         void *objects [GC_ROOT_NUM];
1853         int root_types [GC_ROOT_NUM];
1854         uintptr_t extra_info [GC_ROOT_NUM];
1855 } GCRootReport;
1856
1857 static void
1858 notify_gc_roots (GCRootReport *report)
1859 {
1860         if (!report->count)
1861                 return;
1862         mono_profiler_gc_roots (report->count, report->objects, report->root_types, report->extra_info);
1863         report->count = 0;
1864 }
1865
1866 static void
1867 add_profile_gc_root (GCRootReport *report, void *object, int rtype, uintptr_t extra_info)
1868 {
1869         if (report->count == GC_ROOT_NUM)
1870                 notify_gc_roots (report);
1871         report->objects [report->count] = object;
1872         report->root_types [report->count] = rtype;
1873         report->extra_info [report->count++] = (uintptr_t)SGEN_LOAD_VTABLE (object)->klass;
1874 }
1875
1876 void
1877 sgen_client_nursery_objects_pinned (void **definitely_pinned, int count)
1878 {
1879         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS) {
1880                 GCRootReport report;
1881                 int idx;
1882                 report.count = 0;
1883                 for (idx = 0; idx < count; ++idx)
1884                         add_profile_gc_root (&report, definitely_pinned [idx], MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
1885                 notify_gc_roots (&report);
1886         }
1887 }
1888
1889 static void
1890 report_finalizer_roots_from_queue (SgenPointerQueue *queue)
1891 {
1892         GCRootReport report;
1893         size_t i;
1894
1895         report.count = 0;
1896         for (i = 0; i < queue->next_slot; ++i) {
1897                 void *obj = queue->data [i];
1898                 if (!obj)
1899                         continue;
1900                 add_profile_gc_root (&report, obj, MONO_PROFILE_GC_ROOT_FINALIZER, 0);
1901         }
1902         notify_gc_roots (&report);
1903 }
1904
1905 static void
1906 report_finalizer_roots (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
1907 {
1908         report_finalizer_roots_from_queue (fin_ready_queue);
1909         report_finalizer_roots_from_queue (critical_fin_queue);
1910 }
1911
1912 static GCRootReport *root_report;
1913
1914 static void
1915 single_arg_report_root (MonoObject **obj, void *gc_data)
1916 {
1917         if (*obj)
1918                 add_profile_gc_root (root_report, *obj, MONO_PROFILE_GC_ROOT_OTHER, 0);
1919 }
1920
1921 static void
1922 precisely_report_roots_from (GCRootReport *report, void** start_root, void** end_root, mword desc)
1923 {
1924         switch (desc & ROOT_DESC_TYPE_MASK) {
1925         case ROOT_DESC_BITMAP:
1926                 desc >>= ROOT_DESC_TYPE_SHIFT;
1927                 while (desc) {
1928                         if ((desc & 1) && *start_root) {
1929                                 add_profile_gc_root (report, *start_root, MONO_PROFILE_GC_ROOT_OTHER, 0);
1930                         }
1931                         desc >>= 1;
1932                         start_root++;
1933                 }
1934                 return;
1935         case ROOT_DESC_COMPLEX: {
1936                 gsize *bitmap_data = (gsize *)sgen_get_complex_descriptor_bitmap (desc);
1937                 gsize bwords = (*bitmap_data) - 1;
1938                 void **start_run = start_root;
1939                 bitmap_data++;
1940                 while (bwords-- > 0) {
1941                         gsize bmap = *bitmap_data++;
1942                         void **objptr = start_run;
1943                         while (bmap) {
1944                                 if ((bmap & 1) && *objptr) {
1945                                         add_profile_gc_root (report, *objptr, MONO_PROFILE_GC_ROOT_OTHER, 0);
1946                                 }
1947                                 bmap >>= 1;
1948                                 ++objptr;
1949                         }
1950                         start_run += GC_BITS_PER_WORD;
1951                 }
1952                 break;
1953         }
1954         case ROOT_DESC_USER: {
1955                 MonoGCRootMarkFunc marker = (MonoGCRootMarkFunc)sgen_get_user_descriptor_func (desc);
1956                 root_report = report;
1957                 marker ((MonoObject**)start_root, single_arg_report_root, NULL);
1958                 break;
1959         }
1960         case ROOT_DESC_RUN_LEN:
1961                 g_assert_not_reached ();
1962         default:
1963                 g_assert_not_reached ();
1964         }
1965 }
1966
1967 static void
1968 report_registered_roots_by_type (int root_type)
1969 {
1970         GCRootReport report;
1971         void **start_root;
1972         RootRecord *root;
1973         report.count = 0;
1974         SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], void **, start_root, RootRecord *, root) {
1975                 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
1976                 precisely_report_roots_from (&report, start_root, (void**)root->end_root, root->root_desc);
1977         } SGEN_HASH_TABLE_FOREACH_END;
1978         notify_gc_roots (&report);
1979 }
1980
1981 static void
1982 report_registered_roots (void)
1983 {
1984         report_registered_roots_by_type (ROOT_TYPE_NORMAL);
1985         report_registered_roots_by_type (ROOT_TYPE_WBARRIER);
1986 }
1987
1988 void
1989 sgen_client_collecting_minor (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
1990 {
1991         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
1992                 report_registered_roots ();
1993         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
1994                 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
1995 }
1996
1997 static GCRootReport major_root_report;
1998 static gboolean profile_roots;
1999
2000 void
2001 sgen_client_collecting_major_1 (void)
2002 {
2003         profile_roots = mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS;
2004         memset (&major_root_report, 0, sizeof (GCRootReport));
2005 }
2006
2007 void
2008 sgen_client_pinned_los_object (GCObject *obj)
2009 {
2010         if (profile_roots)
2011                 add_profile_gc_root (&major_root_report, (char*)obj, MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
2012 }
2013
2014 void
2015 sgen_client_collecting_major_2 (void)
2016 {
2017         if (profile_roots)
2018                 notify_gc_roots (&major_root_report);
2019
2020         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2021                 report_registered_roots ();
2022 }
2023
2024 void
2025 sgen_client_collecting_major_3 (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
2026 {
2027         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2028                 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
2029 }
2030
2031 #define MOVED_OBJECTS_NUM 64
2032 static void *moved_objects [MOVED_OBJECTS_NUM];
2033 static int moved_objects_idx = 0;
2034
2035 void
2036 mono_sgen_register_moved_object (void *obj, void *destination)
2037 {
2038         g_assert (mono_profiler_events & MONO_PROFILE_GC_MOVES);
2039
2040         if (moved_objects_idx == MOVED_OBJECTS_NUM) {
2041                 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2042                 moved_objects_idx = 0;
2043         }
2044         moved_objects [moved_objects_idx++] = obj;
2045         moved_objects [moved_objects_idx++] = destination;
2046 }
2047
2048 void
2049 mono_sgen_gc_event_moves (void)
2050 {
2051         if (moved_objects_idx) {
2052                 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2053                 moved_objects_idx = 0;
2054         }
2055 }
2056
2057 /*
2058  * Heap walking
2059  */
2060
2061 #define REFS_SIZE 128
2062 typedef struct {
2063         void *data;
2064         MonoGCReferences callback;
2065         int flags;
2066         int count;
2067         int called;
2068         MonoObject *refs [REFS_SIZE];
2069         uintptr_t offsets [REFS_SIZE];
2070 } HeapWalkInfo;
2071
2072 #undef HANDLE_PTR
2073 #define HANDLE_PTR(ptr,obj)     do {    \
2074                 if (*(ptr)) {   \
2075                         if (hwi->count == REFS_SIZE) {  \
2076                                 hwi->callback ((MonoObject*)start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);    \
2077                                 hwi->count = 0; \
2078                                 hwi->called = 1;        \
2079                         }       \
2080                         hwi->offsets [hwi->count] = (char*)(ptr)-(char*)start;  \
2081                         hwi->refs [hwi->count++] = *(ptr);      \
2082                 }       \
2083         } while (0)
2084
2085 static void
2086 collect_references (HeapWalkInfo *hwi, GCObject *obj, size_t size)
2087 {
2088         char *start = (char*)obj;
2089         mword desc = sgen_obj_get_descriptor (obj);
2090
2091 #include "sgen/sgen-scan-object.h"
2092 }
2093
2094 static void
2095 walk_references (GCObject *start, size_t size, void *data)
2096 {
2097         HeapWalkInfo *hwi = (HeapWalkInfo *)data;
2098         hwi->called = 0;
2099         hwi->count = 0;
2100         collect_references (hwi, start, size);
2101         if (hwi->count || !hwi->called)
2102                 hwi->callback (start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);
2103 }
2104
2105 /**
2106  * mono_gc_walk_heap:
2107  * @flags: flags for future use
2108  * @callback: a function pointer called for each object in the heap
2109  * @data: a user data pointer that is passed to callback
2110  *
2111  * This function can be used to iterate over all the live objects in the heap:
2112  * for each object, @callback is invoked, providing info about the object's
2113  * location in memory, its class, its size and the objects it references.
2114  * For each referenced object it's offset from the object address is
2115  * reported in the offsets array.
2116  * The object references may be buffered, so the callback may be invoked
2117  * multiple times for the same object: in all but the first call, the size
2118  * argument will be zero.
2119  * Note that this function can be only called in the #MONO_GC_EVENT_PRE_START_WORLD
2120  * profiler event handler.
2121  *
2122  * Returns: a non-zero value if the GC doesn't support heap walking
2123  */
2124 int
2125 mono_gc_walk_heap (int flags, MonoGCReferences callback, void *data)
2126 {
2127         HeapWalkInfo hwi;
2128
2129         hwi.flags = flags;
2130         hwi.callback = callback;
2131         hwi.data = data;
2132
2133         sgen_clear_nursery_fragments ();
2134         sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data, walk_references, &hwi, FALSE, TRUE);
2135
2136         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, walk_references, &hwi);
2137         sgen_los_iterate_objects (walk_references, &hwi);
2138
2139         return 0;
2140 }
2141
2142 /*
2143  * Threads
2144  */
2145
2146 void
2147 mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks)
2148 {
2149         gc_callbacks = *callbacks;
2150 }
2151
2152 MonoGCCallbacks *
2153 mono_gc_get_gc_callbacks ()
2154 {
2155         return &gc_callbacks;
2156 }
2157
2158 void
2159 sgen_client_thread_register (SgenThreadInfo* info, void *stack_bottom_fallback)
2160 {
2161         size_t stsize = 0;
2162         guint8 *staddr = NULL;
2163
2164 #ifndef HAVE_KW_THREAD
2165         g_assert (!mono_native_tls_get_value (thread_info_key));
2166         mono_native_tls_set_value (thread_info_key, info);
2167 #else
2168         sgen_thread_info = info;
2169 #endif
2170
2171         info->client_info.skip = 0;
2172         info->client_info.stopped_ip = NULL;
2173         info->client_info.stopped_domain = NULL;
2174
2175         info->client_info.stack_start = NULL;
2176
2177 #ifdef SGEN_POSIX_STW
2178         info->client_info.stop_count = -1;
2179         info->client_info.signal = 0;
2180 #endif
2181
2182         /* On win32, stack_start_limit should be 0, since the stack can grow dynamically */
2183         mono_thread_info_get_stack_bounds (&staddr, &stsize);
2184         if (staddr) {
2185 #ifndef HOST_WIN32
2186                 info->client_info.stack_start_limit = staddr;
2187 #endif
2188                 info->client_info.stack_end = staddr + stsize;
2189         } else {
2190                 gsize stack_bottom = (gsize)stack_bottom_fallback;
2191                 stack_bottom += 4095;
2192                 stack_bottom &= ~4095;
2193                 info->client_info.stack_end = (char*)stack_bottom;
2194         }
2195
2196 #ifdef USE_MONO_CTX
2197         memset (&info->client_info.ctx, 0, sizeof (MonoContext));
2198 #else
2199         memset (&info->client_info.regs, 0, sizeof (info->client_info.regs));
2200 #endif
2201
2202         if (mono_gc_get_gc_callbacks ()->thread_attach_func)
2203                 info->client_info.runtime_data = mono_gc_get_gc_callbacks ()->thread_attach_func ();
2204
2205         binary_protocol_thread_register ((gpointer)mono_thread_info_get_tid (info));
2206
2207         SGEN_LOG (3, "registered thread %p (%p) stack end %p", info, (gpointer)mono_thread_info_get_tid (info), info->client_info.stack_end);
2208 }
2209
2210 void
2211 sgen_client_thread_unregister (SgenThreadInfo *p)
2212 {
2213         MonoNativeThreadId tid;
2214
2215 #ifndef HAVE_KW_THREAD
2216         mono_native_tls_set_value (thread_info_key, NULL);
2217 #else
2218         sgen_thread_info = NULL;
2219 #endif
2220
2221         tid = mono_thread_info_get_tid (p);
2222
2223         if (p->client_info.info.runtime_thread)
2224                 mono_threads_add_joinable_thread ((gpointer)tid);
2225
2226         if (mono_gc_get_gc_callbacks ()->thread_detach_func) {
2227                 mono_gc_get_gc_callbacks ()->thread_detach_func (p->client_info.runtime_data);
2228                 p->client_info.runtime_data = NULL;
2229         }
2230
2231         binary_protocol_thread_unregister ((gpointer)tid);
2232         SGEN_LOG (3, "unregister thread %p (%p)", p, (gpointer)tid);
2233 }
2234
2235 void
2236 mono_gc_set_skip_thread (gboolean skip)
2237 {
2238         SgenThreadInfo *info = mono_thread_info_current ();
2239
2240         LOCK_GC;
2241         info->client_info.gc_disabled = skip;
2242         UNLOCK_GC;
2243 }
2244
2245 static gboolean
2246 is_critical_method (MonoMethod *method)
2247 {
2248         return mono_runtime_is_critical_method (method) || sgen_is_critical_method (method);
2249 }
2250
2251 static gboolean
2252 thread_in_critical_region (SgenThreadInfo *info)
2253 {
2254         return info->client_info.in_critical_region;
2255 }
2256
2257 static void
2258 sgen_thread_attach (SgenThreadInfo *info)
2259 {
2260         mono_handle_arena_init ((MonoHandleArena**) &info->client_info.info.handle_arena);
2261
2262         if (mono_gc_get_gc_callbacks ()->thread_attach_func && !info->client_info.runtime_data)
2263                 info->client_info.runtime_data = mono_gc_get_gc_callbacks ()->thread_attach_func ();
2264 }
2265
2266 static void
2267 sgen_thread_detach (SgenThreadInfo *p)
2268 {
2269         /* If a delegate is passed to native code and invoked on a thread we dont
2270          * know about, the jit will register it with mono_jit_thread_attach, but
2271          * we have no way of knowing when that thread goes away.  SGen has a TSD
2272          * so we assume that if the domain is still registered, we can detach
2273          * the thread
2274          */
2275         if (mono_domain_get ())
2276                 mono_thread_detach_internal (mono_thread_internal_current ());
2277
2278         mono_handle_arena_cleanup ((MonoHandleArena**) &p->client_info.info.handle_arena);
2279 }
2280
2281 gboolean
2282 mono_gc_register_thread (void *baseptr)
2283 {
2284         return mono_thread_info_attach (baseptr) != NULL;
2285 }
2286
2287 gboolean
2288 mono_gc_is_gc_thread (void)
2289 {
2290         gboolean result;
2291         LOCK_GC;
2292         result = mono_thread_info_current () != NULL;
2293         UNLOCK_GC;
2294         return result;
2295 }
2296
2297 void
2298 sgen_client_thread_register_worker (void)
2299 {
2300         mono_thread_info_register_small_id ();
2301         mono_thread_info_set_name (mono_native_thread_id_get (), "SGen worker");
2302 }
2303
2304 /* Variables holding start/end nursery so it won't have to be passed at every call */
2305 static void *scan_area_arg_start, *scan_area_arg_end;
2306
2307 void
2308 mono_gc_conservatively_scan_area (void *start, void *end)
2309 {
2310         sgen_conservatively_pin_objects_from ((void **)start, (void **)end, scan_area_arg_start, scan_area_arg_end, PIN_TYPE_STACK);
2311 }
2312
2313 void*
2314 mono_gc_scan_object (void *obj, void *gc_data)
2315 {
2316         ScanCopyContext *ctx = (ScanCopyContext *)gc_data;
2317         ctx->ops->copy_or_mark_object ((GCObject**)&obj, ctx->queue);
2318         return obj;
2319 }
2320
2321 /*
2322  * Mark from thread stacks and registers.
2323  */
2324 void
2325 sgen_client_scan_thread_data (void *start_nursery, void *end_nursery, gboolean precise, ScanCopyContext ctx)
2326 {
2327         scan_area_arg_start = start_nursery;
2328         scan_area_arg_end = end_nursery;
2329
2330         FOREACH_THREAD (info) {
2331                 int skip_reason = 0;
2332                 void *aligned_stack_start = (void*)(mword) ALIGN_TO ((mword)info->client_info.stack_start, SIZEOF_VOID_P);
2333
2334                 if (info->client_info.skip) {
2335                         SGEN_LOG (3, "Skipping dead thread %p, range: %p-%p, size: %zd", info, info->client_info.stack_start, info->client_info.stack_end, (char*)info->client_info.stack_end - (char*)info->client_info.stack_start);
2336                         skip_reason = 1;
2337                 } else if (info->client_info.gc_disabled) {
2338                         SGEN_LOG (3, "GC disabled for thread %p, range: %p-%p, size: %zd", info, info->client_info.stack_start, info->client_info.stack_end, (char*)info->client_info.stack_end - (char*)info->client_info.stack_start);
2339                         skip_reason = 2;
2340                 } else if (!mono_thread_info_is_live (info)) {
2341                         SGEN_LOG (3, "Skipping non-running thread %p, range: %p-%p, size: %zd (state %x)", info, info->client_info.stack_start, info->client_info.stack_end, (char*)info->client_info.stack_end - (char*)info->client_info.stack_start, info->client_info.info.thread_state);
2342                         skip_reason = 3;
2343                 }
2344
2345                 binary_protocol_scan_stack ((gpointer)mono_thread_info_get_tid (info), info->client_info.stack_start, info->client_info.stack_end, skip_reason);
2346
2347                 if (skip_reason)
2348                         continue;
2349
2350                 g_assert (info->client_info.suspend_done);
2351                 SGEN_LOG (3, "Scanning thread %p, range: %p-%p, size: %zd, pinned=%zd", info, info->client_info.stack_start, info->client_info.stack_end, (char*)info->client_info.stack_end - (char*)info->client_info.stack_start, sgen_get_pinned_count ());
2352                 if (mono_gc_get_gc_callbacks ()->thread_mark_func && !conservative_stack_mark) {
2353                         mono_gc_get_gc_callbacks ()->thread_mark_func (info->client_info.runtime_data, (guint8 *)aligned_stack_start, (guint8 *)info->client_info.stack_end, precise, &ctx);
2354                 } else if (!precise) {
2355                         if (!conservative_stack_mark) {
2356                                 fprintf (stderr, "Precise stack mark not supported - disabling.\n");
2357                                 conservative_stack_mark = TRUE;
2358                         }
2359                         sgen_conservatively_pin_objects_from ((void **)aligned_stack_start, (void **)info->client_info.stack_end, start_nursery, end_nursery, PIN_TYPE_STACK);
2360                 }
2361
2362                 if (!precise) {
2363 #ifdef USE_MONO_CTX
2364                         sgen_conservatively_pin_objects_from ((void**)&info->client_info.ctx, (void**)(&info->client_info.ctx + 1),
2365                                 start_nursery, end_nursery, PIN_TYPE_STACK);
2366 #else
2367                         sgen_conservatively_pin_objects_from ((void**)&info->client_info.regs, (void**)&info->client_info.regs + ARCH_NUM_REGS,
2368                                         start_nursery, end_nursery, PIN_TYPE_STACK);
2369 #endif
2370                         {
2371                                 // This is used on Coop GC for platforms where we cannot get the data for individual registers.
2372                                 // We force a spill of all registers into the stack and pass a chunk of data into sgen.
2373                                 MonoThreadUnwindState *state = &info->client_info.info.thread_saved_state [SELF_SUSPEND_STATE_INDEX];
2374                                 if (state && state->gc_stackdata) {
2375                                         sgen_conservatively_pin_objects_from ((void **)state->gc_stackdata, (void**)((char*)state->gc_stackdata + state->gc_stackdata_size),
2376                                                 start_nursery, end_nursery, PIN_TYPE_STACK);
2377                                 }
2378                         }
2379                 }
2380         } FOREACH_THREAD_END
2381 }
2382
2383 /*
2384  * mono_gc_set_stack_end:
2385  *
2386  *   Set the end of the current threads stack to STACK_END. The stack space between
2387  * STACK_END and the real end of the threads stack will not be scanned during collections.
2388  */
2389 void
2390 mono_gc_set_stack_end (void *stack_end)
2391 {
2392         SgenThreadInfo *info;
2393
2394         LOCK_GC;
2395         info = mono_thread_info_current ();
2396         if (info) {
2397                 SGEN_ASSERT (0, stack_end < info->client_info.stack_end, "Can only lower stack end");
2398                 info->client_info.stack_end = stack_end;
2399         }
2400         UNLOCK_GC;
2401 }
2402
2403 /*
2404  * Roots
2405  */
2406
2407 int
2408 mono_gc_register_root (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
2409 {
2410         return sgen_register_root (start, size, descr, descr ? ROOT_TYPE_NORMAL : ROOT_TYPE_PINNED, source, msg);
2411 }
2412
2413 int
2414 mono_gc_register_root_wbarrier (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
2415 {
2416         return sgen_register_root (start, size, descr, ROOT_TYPE_WBARRIER, source, msg);
2417 }
2418
2419 void
2420 mono_gc_deregister_root (char* addr)
2421 {
2422         sgen_deregister_root (addr);
2423 }
2424
2425 /*
2426  * PThreads
2427  */
2428
2429 #ifndef HOST_WIN32
2430 int
2431 mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
2432 {
2433         return pthread_create (new_thread, attr, start_routine, arg);
2434 }
2435 #endif
2436
2437 /*
2438  * Miscellaneous
2439  */
2440
2441 void
2442 sgen_client_total_allocated_heap_changed (size_t allocated_heap)
2443 {
2444         mono_runtime_resource_check_limit (MONO_RESOURCE_GC_HEAP, allocated_heap);
2445 }
2446
2447 gboolean
2448 mono_gc_user_markers_supported (void)
2449 {
2450         return TRUE;
2451 }
2452
2453 gboolean
2454 mono_object_is_alive (MonoObject* o)
2455 {
2456         return TRUE;
2457 }
2458
2459 int
2460 mono_gc_get_generation (MonoObject *obj)
2461 {
2462         if (sgen_ptr_in_nursery (obj))
2463                 return 0;
2464         return 1;
2465 }
2466
2467 void
2468 mono_gc_enable_events (void)
2469 {
2470 }
2471
2472 const char *
2473 mono_gc_get_gc_name (void)
2474 {
2475         return "sgen";
2476 }
2477
2478 char*
2479 mono_gc_get_description (void)
2480 {
2481         return g_strdup ("sgen");
2482 }
2483
2484 void
2485 mono_gc_set_desktop_mode (void)
2486 {
2487 }
2488
2489 gboolean
2490 mono_gc_is_moving (void)
2491 {
2492         return TRUE;
2493 }
2494
2495 gboolean
2496 mono_gc_is_disabled (void)
2497 {
2498         return FALSE;
2499 }
2500
2501 #ifdef HOST_WIN32
2502 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved)
2503 {
2504         return TRUE;
2505 }
2506 #endif
2507
2508 int
2509 mono_gc_max_generation (void)
2510 {
2511         return 1;
2512 }
2513
2514 gboolean
2515 mono_gc_precise_stack_mark_enabled (void)
2516 {
2517         return !conservative_stack_mark;
2518 }
2519
2520 void
2521 mono_gc_collect (int generation)
2522 {
2523         sgen_gc_collect (generation);
2524 }
2525
2526 int
2527 mono_gc_collection_count (int generation)
2528 {
2529         return sgen_gc_collection_count (generation);
2530 }
2531
2532 int64_t
2533 mono_gc_get_used_size (void)
2534 {
2535         return (int64_t)sgen_gc_get_used_size ();
2536 }
2537
2538 int64_t
2539 mono_gc_get_heap_size (void)
2540 {
2541         return (int64_t)sgen_gc_get_total_heap_allocation ();
2542 }
2543
2544 MonoGCDescriptor
2545 mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker)
2546 {
2547         return sgen_make_user_root_descriptor (marker);
2548 }
2549
2550 MonoGCDescriptor
2551 mono_gc_make_descr_for_string (gsize *bitmap, int numbits)
2552 {
2553         return SGEN_DESC_STRING;
2554 }
2555
2556 void*
2557 mono_gc_get_nursery (int *shift_bits, size_t *size)
2558 {
2559         *size = sgen_nursery_size;
2560         *shift_bits = DEFAULT_NURSERY_BITS;
2561         return sgen_get_nursery_start ();
2562 }
2563
2564 int
2565 mono_gc_get_los_limit (void)
2566 {
2567         return SGEN_MAX_SMALL_OBJ_SIZE;
2568 }
2569
2570 gpointer
2571 sgen_client_default_metadata (void)
2572 {
2573         return mono_domain_get ();
2574 }
2575
2576 gpointer
2577 sgen_client_metadata_for_object (GCObject *obj)
2578 {
2579         return mono_object_domain (obj);
2580 }
2581
2582 /**
2583  * mono_gchandle_is_in_domain:
2584  * @gchandle: a GCHandle's handle.
2585  * @domain: An application domain.
2586  *
2587  * Returns: TRUE if the object wrapped by the @gchandle belongs to the specific @domain.
2588  */
2589 gboolean
2590 mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain)
2591 {
2592         MonoDomain *gchandle_domain = (MonoDomain *)sgen_gchandle_get_metadata (gchandle);
2593         return domain->domain_id == gchandle_domain->domain_id;
2594 }
2595
2596 /**
2597  * mono_gchandle_free_domain:
2598  * @unloading: domain that is unloading
2599  *
2600  * Function used internally to cleanup any GC handle for objects belonging
2601  * to the specified domain during appdomain unload.
2602  */
2603 void
2604 mono_gchandle_free_domain (MonoDomain *unloading)
2605 {
2606 }
2607
2608 static gpointer
2609 null_link_if_in_domain (gpointer hidden, GCHandleType handle_type, int max_generation, gpointer user)
2610 {
2611         MonoDomain *unloading_domain = (MonoDomain *)user;
2612         MonoDomain *obj_domain;
2613         gboolean is_weak = MONO_GC_HANDLE_TYPE_IS_WEAK (handle_type);
2614         if (MONO_GC_HANDLE_IS_OBJECT_POINTER (hidden)) {
2615                 MonoObject *obj = (MonoObject *)MONO_GC_REVEAL_POINTER (hidden, is_weak);
2616                 obj_domain = mono_object_domain (obj);
2617         } else {
2618                 obj_domain = (MonoDomain *)MONO_GC_REVEAL_POINTER (hidden, is_weak);
2619         }
2620         if (unloading_domain->domain_id == obj_domain->domain_id)
2621                 return NULL;
2622         return hidden;
2623 }
2624
2625 void
2626 sgen_null_links_for_domain (MonoDomain *domain)
2627 {
2628         guint type;
2629         for (type = HANDLE_TYPE_MIN; type < HANDLE_TYPE_MAX; ++type)
2630                 sgen_gchandle_iterate ((GCHandleType)type, GENERATION_OLD, null_link_if_in_domain, domain);
2631 }
2632
2633 void
2634 mono_gchandle_set_target (guint32 gchandle, MonoObject *obj)
2635 {
2636         sgen_gchandle_set_target (gchandle, obj);
2637 }
2638
2639 void
2640 sgen_client_gchandle_created (int handle_type, GCObject *obj, guint32 handle)
2641 {
2642 #ifndef DISABLE_PERFCOUNTERS
2643         mono_perfcounters->gc_num_handles++;
2644 #endif
2645         mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_CREATED, handle_type, handle, obj);
2646 }
2647
2648 void
2649 sgen_client_gchandle_destroyed (int handle_type, guint32 handle)
2650 {
2651 #ifndef DISABLE_PERFCOUNTERS
2652         mono_perfcounters->gc_num_handles--;
2653 #endif
2654         mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_DESTROYED, handle_type, handle, NULL);
2655 }
2656
2657 void
2658 sgen_client_ensure_weak_gchandles_accessible (void)
2659 {
2660         /*
2661          * During the second bridge processing step the world is
2662          * running again.  That step processes all weak links once
2663          * more to null those that refer to dead objects.  Before that
2664          * is completed, those links must not be followed, so we
2665          * conservatively wait for bridge processing when any weak
2666          * link is dereferenced.
2667          */
2668         /* FIXME: A GC can occur after this check fails, in which case we
2669          * should wait for bridge processing but would fail to do so.
2670          */
2671         if (G_UNLIKELY (bridge_processing_in_progress))
2672                 mono_gc_wait_for_bridge_processing ();
2673 }
2674
2675 void*
2676 mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data)
2677 {
2678         void *result;
2679         LOCK_INTERRUPTION;
2680         result = func (data);
2681         UNLOCK_INTERRUPTION;
2682         return result;
2683 }
2684
2685 void
2686 mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size)
2687 {
2688         // FIXME:
2689 }
2690
2691 guint8*
2692 mono_gc_get_card_table (int *shift_bits, gpointer *mask)
2693 {
2694         return sgen_get_card_table_configuration (shift_bits, mask);
2695 }
2696
2697 gboolean
2698 mono_gc_card_table_nursery_check (void)
2699 {
2700         return !sgen_get_major_collector ()->is_concurrent;
2701 }
2702
2703 /* Negative value to remove */
2704 void
2705 mono_gc_add_memory_pressure (gint64 value)
2706 {
2707         /* FIXME: Implement at some point? */
2708 }
2709
2710 /*
2711  * Logging
2712  */
2713
2714 void
2715 sgen_client_degraded_allocation (size_t size)
2716 {
2717         static int last_major_gc_warned = -1;
2718         static int num_degraded = 0;
2719
2720         if (last_major_gc_warned < (int)gc_stats.major_gc_count) {
2721                 ++num_degraded;
2722                 if (num_degraded == 1 || num_degraded == 3)
2723                         mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Degraded allocation.  Consider increasing nursery-size if the warning persists.");
2724                 else if (num_degraded == 10)
2725                         mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Repeated degraded allocation.  Consider increasing nursery-size.");
2726                 last_major_gc_warned = gc_stats.major_gc_count;
2727         }
2728 }
2729
2730 void
2731 sgen_client_log_timing (GGTimingInfo *info, mword last_major_num_sections, mword last_los_memory_usage)
2732 {
2733         SgenMajorCollector *major_collector = sgen_get_major_collector ();
2734         mword num_major_sections = major_collector->get_num_major_sections ();
2735         char full_timing_buff [1024];
2736         full_timing_buff [0] = '\0';
2737
2738         if (!info->is_overflow)
2739                 sprintf (full_timing_buff, "total %.2fms, bridge %.2fms", info->stw_time / 10000.0f, (int)info->bridge_time / 10000.0f);
2740         if (info->generation == GENERATION_OLD)
2741                 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "GC_MAJOR%s: (%s) pause %.2fms, %s los %dK/%dK",
2742                         info->is_overflow ? "_OVERFLOW" : "",
2743                         info->reason ? info->reason : "",
2744                         (int)info->total_time / 10000.0f,
2745                         full_timing_buff,
2746                         los_memory_usage / 1024,
2747                         last_los_memory_usage / 1024);
2748         else
2749                 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "GC_MINOR%s: (%s) pause %.2fms, %s promoted %dK major %dK los %dK",
2750                                 info->is_overflow ? "_OVERFLOW" : "",
2751                         info->reason ? info->reason : "",
2752                         (int)info->total_time / 10000.0f,
2753                         full_timing_buff,
2754                         (num_major_sections - last_major_num_sections) * major_collector->section_size / 1024,
2755                         major_collector->section_size * num_major_sections / 1024,
2756                         los_memory_usage / 1024);
2757 }
2758
2759 /*
2760  * Debugging
2761  */
2762
2763 const char*
2764 sgen_client_description_for_internal_mem_type (int type)
2765 {
2766         switch (type) {
2767         case INTERNAL_MEM_EPHEMERON_LINK: return "ephemeron-link";
2768         default:
2769                 return NULL;
2770         }
2771 }
2772
2773 void
2774 sgen_client_pre_collection_checks (void)
2775 {
2776         if (sgen_mono_xdomain_checks) {
2777                 sgen_clear_nursery_fragments ();
2778                 sgen_check_for_xdomain_refs ();
2779         }
2780 }
2781
2782 gboolean
2783 sgen_client_vtable_is_inited (MonoVTable *vt)
2784 {
2785         return vt->klass->inited;
2786 }
2787
2788 const char*
2789 sgen_client_vtable_get_namespace (MonoVTable *vt)
2790 {
2791         return vt->klass->name_space;
2792 }
2793
2794 const char*
2795 sgen_client_vtable_get_name (MonoVTable *vt)
2796 {
2797         return vt->klass->name;
2798 }
2799
2800 /*
2801  * Initialization
2802  */
2803
2804 void
2805 sgen_client_init (void)
2806 {
2807         int dummy;
2808         MonoThreadInfoCallbacks cb;
2809
2810         cb.thread_register = sgen_thread_register;
2811         cb.thread_detach = sgen_thread_detach;
2812         cb.thread_unregister = sgen_thread_unregister;
2813         cb.thread_attach = sgen_thread_attach;
2814         cb.mono_method_is_critical = (gboolean (*)(void *))is_critical_method;
2815         cb.mono_thread_in_critical_region = thread_in_critical_region;
2816
2817         mono_threads_init (&cb, sizeof (SgenThreadInfo));
2818
2819         ///* Keep this the default for now */
2820         /* Precise marking is broken on all supported targets. Disable until fixed. */
2821         conservative_stack_mark = TRUE;
2822
2823         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_EPHEMERON_LINK, sizeof (EphemeronLinkNode));
2824
2825         mono_sgen_init_stw ();
2826
2827 #ifndef HAVE_KW_THREAD
2828         mono_native_tls_alloc (&thread_info_key, NULL);
2829 #if defined(TARGET_OSX) || defined(TARGET_WIN32) || defined(TARGET_ANDROID) || defined(TARGET_IOS)
2830         /*
2831          * CEE_MONO_TLS requires the tls offset, not the key, so the code below only works on darwin,
2832          * where the two are the same.
2833          */
2834         mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, thread_info_key);
2835 #endif
2836 #else
2837         {
2838                 int tls_offset = -1;
2839                 MONO_THREAD_VAR_OFFSET (sgen_thread_info, tls_offset);
2840                 mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, tls_offset);
2841         }
2842 #endif
2843
2844         /*
2845          * This needs to happen before any internal allocations because
2846          * it inits the small id which is required for hazard pointer
2847          * operations.
2848          */
2849         sgen_os_init ();
2850
2851         mono_gc_register_thread (&dummy);
2852 }
2853
2854 gboolean
2855 sgen_client_handle_gc_param (const char *opt)
2856 {
2857         if (g_str_has_prefix (opt, "stack-mark=")) {
2858                 opt = strchr (opt, '=') + 1;
2859                 if (!strcmp (opt, "precise")) {
2860                         conservative_stack_mark = FALSE;
2861                 } else if (!strcmp (opt, "conservative")) {
2862                         conservative_stack_mark = TRUE;
2863                 } else {
2864                         sgen_env_var_error (MONO_GC_PARAMS_NAME, conservative_stack_mark ? "Using `conservative`." : "Using `precise`.",
2865                                         "Invalid value `%s` for `stack-mark` option, possible values are: `precise`, `conservative`.", opt);
2866                 }
2867         } else if (g_str_has_prefix (opt, "bridge-implementation=")) {
2868                 opt = strchr (opt, '=') + 1;
2869                 sgen_set_bridge_implementation (opt);
2870         } else if (g_str_has_prefix (opt, "toggleref-test")) {
2871                 /* FIXME: This should probably in MONO_GC_DEBUG */
2872                 sgen_register_test_toggleref_callback ();
2873         } else {
2874                 return FALSE;
2875         }
2876         return TRUE;
2877 }
2878
2879 void
2880 sgen_client_print_gc_params_usage (void)
2881 {
2882         fprintf (stderr, "  stack-mark=MARK-METHOD (where MARK-METHOD is 'precise' or 'conservative')\n");
2883 }
2884
2885 gboolean
2886 sgen_client_handle_gc_debug (const char *opt)
2887 {
2888         if (!strcmp (opt, "xdomain-checks")) {
2889                 sgen_mono_xdomain_checks = TRUE;
2890         } else if (!strcmp (opt, "do-not-finalize")) {
2891                 mono_do_not_finalize = TRUE;
2892         } else if (g_str_has_prefix (opt, "do-not-finalize=")) {
2893                 opt = strchr (opt, '=') + 1;
2894                 mono_do_not_finalize = TRUE;
2895                 mono_do_not_finalize_class_names = g_strsplit (opt, ",", 0);
2896         } else if (!strcmp (opt, "log-finalizers")) {
2897                 log_finalizers = TRUE;
2898         } else if (!strcmp (opt, "no-managed-allocator")) {
2899                 sgen_set_use_managed_allocator (FALSE);
2900         } else if (!sgen_bridge_handle_gc_debug (opt)) {
2901                 return FALSE;
2902         }
2903         return TRUE;
2904 }
2905
2906 void
2907 sgen_client_print_gc_debug_usage (void)
2908 {
2909         fprintf (stderr, "  xdomain-checks\n");
2910         fprintf (stderr, "  do-not-finalize\n");
2911         fprintf (stderr, "  log-finalizers\n");
2912         fprintf (stderr, "  no-managed-allocator\n");
2913         sgen_bridge_print_gc_debug_usage ();
2914 }
2915
2916
2917 gpointer
2918 sgen_client_get_provenance (void)
2919 {
2920 #ifdef SGEN_OBJECT_PROVENANCE
2921         MonoGCCallbacks *cb = mono_gc_get_gc_callbacks ();
2922         gpointer (*get_provenance_func) (void);
2923         if (!cb)
2924                 return NULL;
2925         get_provenance_func = cb->get_provenance_func;
2926         if (get_provenance_func)
2927                 return get_provenance_func ();
2928         return NULL;
2929 #else
2930         return NULL;
2931 #endif
2932 }
2933
2934 void
2935 sgen_client_describe_invalid_pointer (GCObject *ptr)
2936 {
2937         sgen_bridge_describe_pointer (ptr);
2938 }
2939
2940 static gboolean gc_inited;
2941
2942 void
2943 mono_gc_base_init (void)
2944 {
2945         if (gc_inited)
2946                 return;
2947
2948         mono_counters_init ();
2949
2950 #ifdef HEAVY_STATISTICS
2951         mono_counters_register ("los marked cards", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_marked_cards);
2952         mono_counters_register ("los array cards scanned ", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_cards);
2953         mono_counters_register ("los array remsets", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_remsets);
2954
2955         mono_counters_register ("WBarrier set arrayref", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_set_arrayref);
2956         mono_counters_register ("WBarrier value copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_value_copy);
2957         mono_counters_register ("WBarrier object copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_object_copy);
2958 #endif
2959
2960         sgen_gc_init ();
2961
2962         if (nursery_canaries_enabled ())
2963                 sgen_set_use_managed_allocator (FALSE);
2964
2965 #if defined(HAVE_KW_THREAD)
2966         /* This can happen with using libmonosgen.so */
2967         if (mono_tls_key_get_offset (TLS_KEY_SGEN_TLAB_NEXT_ADDR) == -1)
2968                 sgen_set_use_managed_allocator (FALSE);
2969 #endif
2970
2971         gc_inited = TRUE;
2972 }
2973
2974 void
2975 mono_gc_base_cleanup (void)
2976 {
2977         sgen_thread_pool_shutdown ();
2978 }
2979
2980 gboolean
2981 mono_gc_is_null (void)
2982 {
2983         return FALSE;
2984 }
2985
2986 #endif