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         /* size += ALLOC_ALIGN - 1; */
1246         mono_mb_emit_ldloc (mb, size_var);
1247         mono_mb_emit_icon (mb, SGEN_ALLOC_ALIGN - 1);
1248         mono_mb_emit_byte (mb, CEE_ADD);
1249         /* size &= ~(ALLOC_ALIGN - 1); */
1250         mono_mb_emit_icon (mb, ~(SGEN_ALLOC_ALIGN - 1));
1251         mono_mb_emit_byte (mb, CEE_AND);
1252         mono_mb_emit_stloc (mb, size_var);
1253
1254         /* if (size > MAX_SMALL_OBJ_SIZE) goto slowpath */
1255         if (atype != ATYPE_SMALL) {
1256                 mono_mb_emit_ldloc (mb, size_var);
1257                 mono_mb_emit_icon (mb, SGEN_MAX_SMALL_OBJ_SIZE);
1258                 max_size_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BGT_UN_S);
1259         }
1260
1261         /*
1262          * We need to modify tlab_next, but the JIT only supports reading, so we read
1263          * another tls var holding its address instead.
1264          */
1265
1266         /* tlab_next_addr (local) = tlab_next_addr (TLS var) */
1267         tlab_next_addr_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1268         EMIT_TLS_ACCESS_NEXT_ADDR (mb);
1269         mono_mb_emit_stloc (mb, tlab_next_addr_var);
1270
1271         /* p = (void**)tlab_next; */
1272         p_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1273         mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1274         mono_mb_emit_byte (mb, CEE_LDIND_I);
1275         mono_mb_emit_stloc (mb, p_var);
1276
1277         /* new_next = (char*)p + size; */
1278         new_next_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1279         mono_mb_emit_ldloc (mb, p_var);
1280         mono_mb_emit_ldloc (mb, size_var);
1281         mono_mb_emit_byte (mb, CEE_CONV_I);
1282         mono_mb_emit_byte (mb, CEE_ADD);
1283         mono_mb_emit_stloc (mb, new_next_var);
1284
1285         /* if (G_LIKELY (new_next < tlab_temp_end)) */
1286         mono_mb_emit_ldloc (mb, new_next_var);
1287         EMIT_TLS_ACCESS_TEMP_END (mb);
1288         slowpath_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLT_UN_S);
1289
1290         /* Slowpath */
1291         if (atype != ATYPE_SMALL)
1292                 mono_mb_patch_short_branch (mb, max_size_branch);
1293
1294         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1295         mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1296
1297         /* FIXME: mono_gc_alloc_obj takes a 'size_t' as an argument, not an int32 */
1298         mono_mb_emit_ldarg (mb, 0);
1299         mono_mb_emit_ldloc (mb, size_var);
1300         if (atype == ATYPE_NORMAL || atype == ATYPE_SMALL) {
1301                 mono_mb_emit_icall (mb, mono_gc_alloc_obj);
1302         } else if (atype == ATYPE_VECTOR) {
1303                 mono_mb_emit_ldarg (mb, 1);
1304                 mono_mb_emit_icall (mb, mono_gc_alloc_vector);
1305         } else if (atype == ATYPE_STRING) {
1306                 mono_mb_emit_ldarg (mb, 1);
1307                 mono_mb_emit_icall (mb, mono_gc_alloc_string);
1308         } else {
1309                 g_assert_not_reached ();
1310         }
1311         mono_mb_emit_byte (mb, CEE_RET);
1312
1313         /* Fastpath */
1314         mono_mb_patch_short_branch (mb, slowpath_branch);
1315
1316         /* FIXME: Memory barrier */
1317
1318         /* tlab_next = new_next */
1319         mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1320         mono_mb_emit_ldloc (mb, new_next_var);
1321         mono_mb_emit_byte (mb, CEE_STIND_I);
1322
1323         /*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. */
1324         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1325         mono_mb_emit_byte (mb, CEE_MONO_MEMORY_BARRIER);
1326         mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_REL);
1327
1328         /* *p = vtable; */
1329         mono_mb_emit_ldloc (mb, p_var);
1330         mono_mb_emit_ldarg (mb, 0);
1331         mono_mb_emit_byte (mb, CEE_STIND_I);
1332
1333         if (atype == ATYPE_VECTOR) {
1334                 /* arr->max_length = max_length; */
1335                 mono_mb_emit_ldloc (mb, p_var);
1336                 mono_mb_emit_ldflda (mb, MONO_STRUCT_OFFSET (MonoArray, max_length));
1337                 mono_mb_emit_ldarg (mb, 1);
1338 #ifdef MONO_BIG_ARRAYS
1339                 mono_mb_emit_byte (mb, CEE_STIND_I);
1340 #else
1341                 mono_mb_emit_byte (mb, CEE_STIND_I4);
1342 #endif
1343         } else  if (atype == ATYPE_STRING) {
1344                 /* need to set length and clear the last char */
1345                 /* s->length = len; */
1346                 mono_mb_emit_ldloc (mb, p_var);
1347                 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoString, length));
1348                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
1349                 mono_mb_emit_ldarg (mb, 1);
1350                 mono_mb_emit_byte (mb, MONO_CEE_STIND_I4);
1351         }
1352
1353         /*
1354         We must make sure both vtable and max_length are globaly visible before returning to managed land.
1355         */
1356         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1357         mono_mb_emit_byte (mb, CEE_MONO_MEMORY_BARRIER);
1358         mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_REL);
1359
1360         /* return p */
1361         mono_mb_emit_ldloc (mb, p_var);
1362
1363  done:
1364         mono_mb_emit_byte (mb, CEE_RET);
1365 #endif
1366
1367         info = mono_wrapper_info_create (mb, WRAPPER_SUBTYPE_NONE);
1368         info->d.alloc.gc_name = "sgen";
1369         info->d.alloc.alloc_type = atype;
1370
1371 #ifndef DISABLE_JIT
1372         mb->init_locals = FALSE;
1373 #endif
1374
1375         res = mono_mb_create (mb, csig, 8, info);
1376         mono_mb_free (mb);
1377
1378
1379         return res;
1380 }
1381 #endif
1382
1383 int
1384 mono_gc_get_aligned_size_for_allocator (int size)
1385 {
1386         return SGEN_ALIGN_UP (size);
1387 }
1388
1389 /*
1390  * Generate an allocator method implementing the fast path of mono_gc_alloc_obj ().
1391  * The signature of the called method is:
1392  *      object allocate (MonoVTable *vtable)
1393  */
1394 MonoMethod*
1395 mono_gc_get_managed_allocator (MonoClass *klass, gboolean for_box, gboolean known_instance_size)
1396 {
1397 #ifdef MANAGED_ALLOCATION
1398         if (collect_before_allocs)
1399                 return NULL;
1400         if (!mono_runtime_has_tls_get ())
1401                 return NULL;
1402         if (klass->instance_size > tlab_size)
1403                 return NULL;
1404         if (known_instance_size && ALIGN_TO (klass->instance_size, SGEN_ALLOC_ALIGN) >= SGEN_MAX_SMALL_OBJ_SIZE)
1405                 return NULL;
1406         if (mono_class_has_finalizer (klass) || mono_class_is_marshalbyref (klass) || (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS))
1407                 return NULL;
1408         if (klass->rank)
1409                 return NULL;
1410         if (klass->byval_arg.type == MONO_TYPE_STRING)
1411                 return mono_gc_get_managed_allocator_by_type (ATYPE_STRING, FALSE);
1412         /* Generic classes have dynamic field and can go above MAX_SMALL_OBJ_SIZE. */
1413         if (known_instance_size)
1414                 return mono_gc_get_managed_allocator_by_type (ATYPE_SMALL, FALSE);
1415         else
1416                 return mono_gc_get_managed_allocator_by_type (ATYPE_NORMAL, FALSE);
1417 #else
1418         return NULL;
1419 #endif
1420 }
1421
1422 MonoMethod*
1423 mono_gc_get_managed_array_allocator (MonoClass *klass)
1424 {
1425 #ifdef MANAGED_ALLOCATION
1426         if (klass->rank != 1)
1427                 return NULL;
1428         if (!mono_runtime_has_tls_get ())
1429                 return NULL;
1430         if (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS)
1431                 return NULL;
1432         if (has_per_allocation_action)
1433                 return NULL;
1434         g_assert (!mono_class_has_finalizer (klass) && !mono_class_is_marshalbyref (klass));
1435
1436         return mono_gc_get_managed_allocator_by_type (ATYPE_VECTOR, FALSE);
1437 #else
1438         return NULL;
1439 #endif
1440 }
1441
1442 void
1443 sgen_set_use_managed_allocator (gboolean flag)
1444 {
1445         use_managed_allocator = flag;
1446 }
1447
1448 MonoMethod*
1449 mono_gc_get_managed_allocator_by_type (int atype, gboolean slowpath)
1450 {
1451 #ifdef MANAGED_ALLOCATION
1452         MonoMethod *res;
1453         MonoMethod **cache = slowpath ? slowpath_alloc_method_cache : alloc_method_cache;
1454
1455         if (!use_managed_allocator)
1456                 return NULL;
1457
1458         if (!mono_runtime_has_tls_get ())
1459                 return NULL;
1460
1461         res = cache [atype];
1462         if (res)
1463                 return res;
1464
1465         res = create_allocator (atype, slowpath);
1466         LOCK_GC;
1467         if (cache [atype]) {
1468                 mono_free_method (res);
1469                 res = cache [atype];
1470         } else {
1471                 mono_memory_barrier ();
1472                 cache [atype] = res;
1473         }
1474         UNLOCK_GC;
1475
1476         return res;
1477 #else
1478         return NULL;
1479 #endif
1480 }
1481
1482 guint32
1483 mono_gc_get_managed_allocator_types (void)
1484 {
1485         return ATYPE_NUM;
1486 }
1487
1488 gboolean
1489 sgen_is_managed_allocator (MonoMethod *method)
1490 {
1491         int i;
1492
1493         for (i = 0; i < ATYPE_NUM; ++i)
1494                 if (method == alloc_method_cache [i] || method == slowpath_alloc_method_cache [i])
1495                         return TRUE;
1496         return FALSE;
1497 }
1498
1499 gboolean
1500 sgen_has_managed_allocator (void)
1501 {
1502         int i;
1503
1504         for (i = 0; i < ATYPE_NUM; ++i)
1505                 if (alloc_method_cache [i] || slowpath_alloc_method_cache [i])
1506                         return TRUE;
1507         return FALSE;
1508 }
1509
1510 /*
1511  * Cardtable scanning
1512  */
1513
1514 #define MWORD_MASK (sizeof (mword) - 1)
1515
1516 static inline int
1517 find_card_offset (mword card)
1518 {
1519 /*XXX Use assembly as this generates some pretty bad code */
1520 #if defined(__i386__) && defined(__GNUC__)
1521         return  (__builtin_ffs (card) - 1) / 8;
1522 #elif defined(__x86_64__) && defined(__GNUC__)
1523         return (__builtin_ffsll (card) - 1) / 8;
1524 #elif defined(__s390x__)
1525         return (__builtin_ffsll (GUINT64_TO_LE(card)) - 1) / 8;
1526 #else
1527         int i;
1528         guint8 *ptr = (guint8 *) &card;
1529         for (i = 0; i < sizeof (mword); ++i) {
1530                 if (ptr[i])
1531                         return i;
1532         }
1533         return 0;
1534 #endif
1535 }
1536
1537 static guint8*
1538 find_next_card (guint8 *card_data, guint8 *end)
1539 {
1540         mword *cards, *cards_end;
1541         mword card;
1542
1543         while ((((mword)card_data) & MWORD_MASK) && card_data < end) {
1544                 if (*card_data)
1545                         return card_data;
1546                 ++card_data;
1547         }
1548
1549         if (card_data == end)
1550                 return end;
1551
1552         cards = (mword*)card_data;
1553         cards_end = (mword*)((mword)end & ~MWORD_MASK);
1554         while (cards < cards_end) {
1555                 card = *cards;
1556                 if (card)
1557                         return (guint8*)cards + find_card_offset (card);
1558                 ++cards;
1559         }
1560
1561         card_data = (guint8*)cards_end;
1562         while (card_data < end) {
1563                 if (*card_data)
1564                         return card_data;
1565                 ++card_data;
1566         }
1567
1568         return end;
1569 }
1570
1571 #define ARRAY_OBJ_INDEX(ptr,array,elem_size) (((char*)(ptr) - ((char*)(array) + G_STRUCT_OFFSET (MonoArray, vector))) / (elem_size))
1572
1573 gboolean
1574 sgen_client_cardtable_scan_object (GCObject *obj, mword block_obj_size, guint8 *cards, ScanCopyContext ctx)
1575 {
1576         MonoVTable *vt = SGEN_LOAD_VTABLE (obj);
1577         MonoClass *klass = vt->klass;
1578
1579         SGEN_ASSERT (0, SGEN_VTABLE_HAS_REFERENCES (vt), "Why would we ever call this on reference-free objects?");
1580
1581         if (vt->rank) {
1582                 MonoArray *arr = (MonoArray*)obj;
1583                 guint8 *card_data, *card_base;
1584                 guint8 *card_data_end;
1585                 char *obj_start = (char *)sgen_card_table_align_pointer (obj);
1586                 mword bounds_size;
1587                 mword obj_size = sgen_mono_array_size (vt, arr, &bounds_size, sgen_vtable_get_descriptor (vt));
1588                 /* We don't want to scan the bounds entries at the end of multidimensional arrays */
1589                 char *obj_end = (char*)obj + obj_size - bounds_size;
1590                 size_t card_count;
1591                 size_t extra_idx = 0;
1592
1593                 mword desc = (mword)klass->element_class->gc_descr;
1594                 int elem_size = mono_array_element_size (klass);
1595
1596 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1597                 guint8 *overflow_scan_end = NULL;
1598 #endif
1599
1600 #ifdef SGEN_OBJECT_LAYOUT_STATISTICS
1601                 if (klass->element_class->valuetype)
1602                         sgen_object_layout_scanned_vtype_array ();
1603                 else
1604                         sgen_object_layout_scanned_ref_array ();
1605 #endif
1606
1607                 if (cards)
1608                         card_data = cards;
1609                 else
1610                         card_data = sgen_card_table_get_card_scan_address ((mword)obj);
1611
1612                 card_base = card_data;
1613                 card_count = sgen_card_table_number_of_cards_in_range ((mword)obj, obj_size);
1614                 card_data_end = card_data + card_count;
1615
1616
1617 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1618                 /*Check for overflow and if so, setup to scan in two steps*/
1619                 if (!cards && card_data_end >= SGEN_SHADOW_CARDTABLE_END) {
1620                         overflow_scan_end = sgen_shadow_cardtable + (card_data_end - SGEN_SHADOW_CARDTABLE_END);
1621                         card_data_end = SGEN_SHADOW_CARDTABLE_END;
1622                 }
1623
1624 LOOP_HEAD:
1625 #endif
1626
1627                 card_data = find_next_card (card_data, card_data_end);
1628                 for (; card_data < card_data_end; card_data = find_next_card (card_data + 1, card_data_end)) {
1629                         size_t index;
1630                         size_t idx = (card_data - card_base) + extra_idx;
1631                         char *start = (char*)(obj_start + idx * CARD_SIZE_IN_BYTES);
1632                         char *card_end = start + CARD_SIZE_IN_BYTES;
1633                         char *first_elem, *elem;
1634
1635                         HEAVY_STAT (++los_marked_cards);
1636
1637                         if (!cards)
1638                                 sgen_card_table_prepare_card_for_scanning (card_data);
1639
1640                         card_end = MIN (card_end, obj_end);
1641
1642                         if (start <= (char*)arr->vector)
1643                                 index = 0;
1644                         else
1645                                 index = ARRAY_OBJ_INDEX (start, obj, elem_size);
1646
1647                         elem = first_elem = (char*)mono_array_addr_with_size_fast ((MonoArray*)obj, elem_size, index);
1648                         if (klass->element_class->valuetype) {
1649                                 ScanVTypeFunc scan_vtype_func = ctx.ops->scan_vtype;
1650
1651                                 for (; elem < card_end; elem += elem_size)
1652                                         scan_vtype_func (obj, elem, desc, ctx.queue BINARY_PROTOCOL_ARG (elem_size));
1653                         } else {
1654                                 ScanPtrFieldFunc scan_ptr_field_func = ctx.ops->scan_ptr_field;
1655
1656                                 HEAVY_STAT (++los_array_cards);
1657                                 for (; elem < card_end; elem += SIZEOF_VOID_P)
1658                                         scan_ptr_field_func (obj, (GCObject**)elem, ctx.queue);
1659                         }
1660
1661                         binary_protocol_card_scan (first_elem, elem - first_elem);
1662                 }
1663
1664 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1665                 if (overflow_scan_end) {
1666                         extra_idx = card_data - card_base;
1667                         card_base = card_data = sgen_shadow_cardtable;
1668                         card_data_end = overflow_scan_end;
1669                         overflow_scan_end = NULL;
1670                         goto LOOP_HEAD;
1671                 }
1672 #endif
1673                 return TRUE;
1674         }
1675
1676         return FALSE;
1677 }
1678
1679 /*
1680  * Array and string allocation
1681  */
1682
1683 void*
1684 mono_gc_alloc_vector (MonoVTable *vtable, size_t size, uintptr_t max_length)
1685 {
1686         MonoArray *arr;
1687         TLAB_ACCESS_INIT;
1688
1689         if (!SGEN_CAN_ALIGN_UP (size))
1690                 return NULL;
1691
1692 #ifndef DISABLE_CRITICAL_REGION
1693         ENTER_CRITICAL_REGION;
1694         arr = (MonoArray*)sgen_try_alloc_obj_nolock (vtable, size);
1695         if (arr) {
1696                 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1697                 arr->max_length = (mono_array_size_t)max_length;
1698                 EXIT_CRITICAL_REGION;
1699                 goto done;
1700         }
1701         EXIT_CRITICAL_REGION;
1702 #endif
1703
1704         LOCK_GC;
1705
1706         arr = (MonoArray*)sgen_alloc_obj_nolock (vtable, size);
1707         if (G_UNLIKELY (!arr)) {
1708                 UNLOCK_GC;
1709                 return NULL;
1710         }
1711
1712         arr->max_length = (mono_array_size_t)max_length;
1713
1714         UNLOCK_GC;
1715
1716  done:
1717         if (G_UNLIKELY (alloc_events))
1718                 mono_profiler_allocation (&arr->obj);
1719
1720         SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size (vtable, (GCObject*)arr)), "Vector has incorrect size.");
1721         return arr;
1722 }
1723
1724 void*
1725 mono_gc_alloc_array (MonoVTable *vtable, size_t size, uintptr_t max_length, uintptr_t bounds_size)
1726 {
1727         MonoArray *arr;
1728         MonoArrayBounds *bounds;
1729         TLAB_ACCESS_INIT;
1730
1731         if (!SGEN_CAN_ALIGN_UP (size))
1732                 return NULL;
1733
1734 #ifndef DISABLE_CRITICAL_REGION
1735         ENTER_CRITICAL_REGION;
1736         arr = (MonoArray*)sgen_try_alloc_obj_nolock (vtable, size);
1737         if (arr) {
1738                 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1739                 arr->max_length = (mono_array_size_t)max_length;
1740
1741                 bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1742                 arr->bounds = bounds;
1743                 EXIT_CRITICAL_REGION;
1744                 goto done;
1745         }
1746         EXIT_CRITICAL_REGION;
1747 #endif
1748
1749         LOCK_GC;
1750
1751         arr = (MonoArray*)sgen_alloc_obj_nolock (vtable, size);
1752         if (G_UNLIKELY (!arr)) {
1753                 UNLOCK_GC;
1754                 return NULL;
1755         }
1756
1757         arr->max_length = (mono_array_size_t)max_length;
1758
1759         bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1760         arr->bounds = bounds;
1761
1762         UNLOCK_GC;
1763
1764  done:
1765         if (G_UNLIKELY (alloc_events))
1766                 mono_profiler_allocation (&arr->obj);
1767
1768         SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size (vtable, (GCObject*)arr)), "Array has incorrect size.");
1769         return arr;
1770 }
1771
1772 void*
1773 mono_gc_alloc_string (MonoVTable *vtable, size_t size, gint32 len)
1774 {
1775         MonoString *str;
1776         TLAB_ACCESS_INIT;
1777
1778         if (!SGEN_CAN_ALIGN_UP (size))
1779                 return NULL;
1780
1781 #ifndef DISABLE_CRITICAL_REGION
1782         ENTER_CRITICAL_REGION;
1783         str = (MonoString*)sgen_try_alloc_obj_nolock (vtable, size);
1784         if (str) {
1785                 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1786                 str->length = len;
1787                 EXIT_CRITICAL_REGION;
1788                 goto done;
1789         }
1790         EXIT_CRITICAL_REGION;
1791 #endif
1792
1793         LOCK_GC;
1794
1795         str = (MonoString*)sgen_alloc_obj_nolock (vtable, size);
1796         if (G_UNLIKELY (!str)) {
1797                 UNLOCK_GC;
1798                 return NULL;
1799         }
1800
1801         str->length = len;
1802
1803         UNLOCK_GC;
1804
1805  done:
1806         if (G_UNLIKELY (alloc_events))
1807                 mono_profiler_allocation (&str->object);
1808
1809         return str;
1810 }
1811
1812 /*
1813  * Strings
1814  */
1815
1816 void
1817 mono_gc_set_string_length (MonoString *str, gint32 new_length)
1818 {
1819         mono_unichar2 *new_end = str->chars + new_length;
1820
1821         /* zero the discarded string. This null-delimits the string and allows
1822          * the space to be reclaimed by SGen. */
1823
1824         if (nursery_canaries_enabled () && sgen_ptr_in_nursery (str)) {
1825                 CHECK_CANARY_FOR_OBJECT ((GCObject*)str, TRUE);
1826                 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2) + CANARY_SIZE);
1827                 memcpy (new_end + 1 , CANARY_STRING, CANARY_SIZE);
1828         } else {
1829                 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2));
1830         }
1831
1832         str->length = new_length;
1833 }
1834
1835 /*
1836  * Profiling
1837  */
1838
1839 #define GC_ROOT_NUM 32
1840 typedef struct {
1841         int count;              /* must be the first field */
1842         void *objects [GC_ROOT_NUM];
1843         int root_types [GC_ROOT_NUM];
1844         uintptr_t extra_info [GC_ROOT_NUM];
1845 } GCRootReport;
1846
1847 static void
1848 notify_gc_roots (GCRootReport *report)
1849 {
1850         if (!report->count)
1851                 return;
1852         mono_profiler_gc_roots (report->count, report->objects, report->root_types, report->extra_info);
1853         report->count = 0;
1854 }
1855
1856 static void
1857 add_profile_gc_root (GCRootReport *report, void *object, int rtype, uintptr_t extra_info)
1858 {
1859         if (report->count == GC_ROOT_NUM)
1860                 notify_gc_roots (report);
1861         report->objects [report->count] = object;
1862         report->root_types [report->count] = rtype;
1863         report->extra_info [report->count++] = (uintptr_t)SGEN_LOAD_VTABLE (object)->klass;
1864 }
1865
1866 void
1867 sgen_client_nursery_objects_pinned (void **definitely_pinned, int count)
1868 {
1869         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS) {
1870                 GCRootReport report;
1871                 int idx;
1872                 report.count = 0;
1873                 for (idx = 0; idx < count; ++idx)
1874                         add_profile_gc_root (&report, definitely_pinned [idx], MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
1875                 notify_gc_roots (&report);
1876         }
1877 }
1878
1879 static void
1880 report_finalizer_roots_from_queue (SgenPointerQueue *queue)
1881 {
1882         GCRootReport report;
1883         size_t i;
1884
1885         report.count = 0;
1886         for (i = 0; i < queue->next_slot; ++i) {
1887                 void *obj = queue->data [i];
1888                 if (!obj)
1889                         continue;
1890                 add_profile_gc_root (&report, obj, MONO_PROFILE_GC_ROOT_FINALIZER, 0);
1891         }
1892         notify_gc_roots (&report);
1893 }
1894
1895 static void
1896 report_finalizer_roots (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
1897 {
1898         report_finalizer_roots_from_queue (fin_ready_queue);
1899         report_finalizer_roots_from_queue (critical_fin_queue);
1900 }
1901
1902 static GCRootReport *root_report;
1903
1904 static void
1905 single_arg_report_root (MonoObject **obj, void *gc_data)
1906 {
1907         if (*obj)
1908                 add_profile_gc_root (root_report, *obj, MONO_PROFILE_GC_ROOT_OTHER, 0);
1909 }
1910
1911 static void
1912 precisely_report_roots_from (GCRootReport *report, void** start_root, void** end_root, mword desc)
1913 {
1914         switch (desc & ROOT_DESC_TYPE_MASK) {
1915         case ROOT_DESC_BITMAP:
1916                 desc >>= ROOT_DESC_TYPE_SHIFT;
1917                 while (desc) {
1918                         if ((desc & 1) && *start_root) {
1919                                 add_profile_gc_root (report, *start_root, MONO_PROFILE_GC_ROOT_OTHER, 0);
1920                         }
1921                         desc >>= 1;
1922                         start_root++;
1923                 }
1924                 return;
1925         case ROOT_DESC_COMPLEX: {
1926                 gsize *bitmap_data = (gsize *)sgen_get_complex_descriptor_bitmap (desc);
1927                 gsize bwords = (*bitmap_data) - 1;
1928                 void **start_run = start_root;
1929                 bitmap_data++;
1930                 while (bwords-- > 0) {
1931                         gsize bmap = *bitmap_data++;
1932                         void **objptr = start_run;
1933                         while (bmap) {
1934                                 if ((bmap & 1) && *objptr) {
1935                                         add_profile_gc_root (report, *objptr, MONO_PROFILE_GC_ROOT_OTHER, 0);
1936                                 }
1937                                 bmap >>= 1;
1938                                 ++objptr;
1939                         }
1940                         start_run += GC_BITS_PER_WORD;
1941                 }
1942                 break;
1943         }
1944         case ROOT_DESC_USER: {
1945                 MonoGCRootMarkFunc marker = (MonoGCRootMarkFunc)sgen_get_user_descriptor_func (desc);
1946                 root_report = report;
1947                 marker ((MonoObject**)start_root, single_arg_report_root, NULL);
1948                 break;
1949         }
1950         case ROOT_DESC_RUN_LEN:
1951                 g_assert_not_reached ();
1952         default:
1953                 g_assert_not_reached ();
1954         }
1955 }
1956
1957 static void
1958 report_registered_roots_by_type (int root_type)
1959 {
1960         GCRootReport report;
1961         void **start_root;
1962         RootRecord *root;
1963         report.count = 0;
1964         SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], void **, start_root, RootRecord *, root) {
1965                 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
1966                 precisely_report_roots_from (&report, start_root, (void**)root->end_root, root->root_desc);
1967         } SGEN_HASH_TABLE_FOREACH_END;
1968         notify_gc_roots (&report);
1969 }
1970
1971 static void
1972 report_registered_roots (void)
1973 {
1974         report_registered_roots_by_type (ROOT_TYPE_NORMAL);
1975         report_registered_roots_by_type (ROOT_TYPE_WBARRIER);
1976 }
1977
1978 void
1979 sgen_client_collecting_minor (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
1980 {
1981         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
1982                 report_registered_roots ();
1983         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
1984                 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
1985 }
1986
1987 static GCRootReport major_root_report;
1988 static gboolean profile_roots;
1989
1990 void
1991 sgen_client_collecting_major_1 (void)
1992 {
1993         profile_roots = mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS;
1994         memset (&major_root_report, 0, sizeof (GCRootReport));
1995 }
1996
1997 void
1998 sgen_client_pinned_los_object (GCObject *obj)
1999 {
2000         if (profile_roots)
2001                 add_profile_gc_root (&major_root_report, (char*)obj, MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
2002 }
2003
2004 void
2005 sgen_client_collecting_major_2 (void)
2006 {
2007         if (profile_roots)
2008                 notify_gc_roots (&major_root_report);
2009
2010         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2011                 report_registered_roots ();
2012 }
2013
2014 void
2015 sgen_client_collecting_major_3 (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
2016 {
2017         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2018                 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
2019 }
2020
2021 #define MOVED_OBJECTS_NUM 64
2022 static void *moved_objects [MOVED_OBJECTS_NUM];
2023 static int moved_objects_idx = 0;
2024
2025 void
2026 mono_sgen_register_moved_object (void *obj, void *destination)
2027 {
2028         g_assert (mono_profiler_events & MONO_PROFILE_GC_MOVES);
2029
2030         if (moved_objects_idx == MOVED_OBJECTS_NUM) {
2031                 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2032                 moved_objects_idx = 0;
2033         }
2034         moved_objects [moved_objects_idx++] = obj;
2035         moved_objects [moved_objects_idx++] = destination;
2036 }
2037
2038 void
2039 mono_sgen_gc_event_moves (void)
2040 {
2041         if (moved_objects_idx) {
2042                 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2043                 moved_objects_idx = 0;
2044         }
2045 }
2046
2047 /*
2048  * Heap walking
2049  */
2050
2051 #define REFS_SIZE 128
2052 typedef struct {
2053         void *data;
2054         MonoGCReferences callback;
2055         int flags;
2056         int count;
2057         int called;
2058         MonoObject *refs [REFS_SIZE];
2059         uintptr_t offsets [REFS_SIZE];
2060 } HeapWalkInfo;
2061
2062 #undef HANDLE_PTR
2063 #define HANDLE_PTR(ptr,obj)     do {    \
2064                 if (*(ptr)) {   \
2065                         if (hwi->count == REFS_SIZE) {  \
2066                                 hwi->callback ((MonoObject*)start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);    \
2067                                 hwi->count = 0; \
2068                                 hwi->called = 1;        \
2069                         }       \
2070                         hwi->offsets [hwi->count] = (char*)(ptr)-(char*)start;  \
2071                         hwi->refs [hwi->count++] = *(ptr);      \
2072                 }       \
2073         } while (0)
2074
2075 static void
2076 collect_references (HeapWalkInfo *hwi, GCObject *obj, size_t size)
2077 {
2078         char *start = (char*)obj;
2079         mword desc = sgen_obj_get_descriptor (obj);
2080
2081 #include "sgen/sgen-scan-object.h"
2082 }
2083
2084 static void
2085 walk_references (GCObject *start, size_t size, void *data)
2086 {
2087         HeapWalkInfo *hwi = (HeapWalkInfo *)data;
2088         hwi->called = 0;
2089         hwi->count = 0;
2090         collect_references (hwi, start, size);
2091         if (hwi->count || !hwi->called)
2092                 hwi->callback (start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);
2093 }
2094
2095 /**
2096  * mono_gc_walk_heap:
2097  * @flags: flags for future use
2098  * @callback: a function pointer called for each object in the heap
2099  * @data: a user data pointer that is passed to callback
2100  *
2101  * This function can be used to iterate over all the live objects in the heap:
2102  * for each object, @callback is invoked, providing info about the object's
2103  * location in memory, its class, its size and the objects it references.
2104  * For each referenced object it's offset from the object address is
2105  * reported in the offsets array.
2106  * The object references may be buffered, so the callback may be invoked
2107  * multiple times for the same object: in all but the first call, the size
2108  * argument will be zero.
2109  * Note that this function can be only called in the #MONO_GC_EVENT_PRE_START_WORLD
2110  * profiler event handler.
2111  *
2112  * Returns: a non-zero value if the GC doesn't support heap walking
2113  */
2114 int
2115 mono_gc_walk_heap (int flags, MonoGCReferences callback, void *data)
2116 {
2117         HeapWalkInfo hwi;
2118
2119         hwi.flags = flags;
2120         hwi.callback = callback;
2121         hwi.data = data;
2122
2123         sgen_clear_nursery_fragments ();
2124         sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data, walk_references, &hwi, FALSE, TRUE);
2125
2126         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, walk_references, &hwi);
2127         sgen_los_iterate_objects (walk_references, &hwi);
2128
2129         return 0;
2130 }
2131
2132 /*
2133  * Threads
2134  */
2135
2136 void
2137 mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks)
2138 {
2139         gc_callbacks = *callbacks;
2140 }
2141
2142 MonoGCCallbacks *
2143 mono_gc_get_gc_callbacks ()
2144 {
2145         return &gc_callbacks;
2146 }
2147
2148 void
2149 sgen_client_thread_register (SgenThreadInfo* info, void *stack_bottom_fallback)
2150 {
2151         size_t stsize = 0;
2152         guint8 *staddr = NULL;
2153
2154 #ifndef HAVE_KW_THREAD
2155         g_assert (!mono_native_tls_get_value (thread_info_key));
2156         mono_native_tls_set_value (thread_info_key, info);
2157 #else
2158         sgen_thread_info = info;
2159 #endif
2160
2161         info->client_info.skip = 0;
2162         info->client_info.stopped_ip = NULL;
2163         info->client_info.stopped_domain = NULL;
2164
2165         info->client_info.stack_start = NULL;
2166
2167 #ifdef SGEN_POSIX_STW
2168         info->client_info.stop_count = -1;
2169         info->client_info.signal = 0;
2170 #endif
2171
2172         /* On win32, stack_start_limit should be 0, since the stack can grow dynamically */
2173         mono_thread_info_get_stack_bounds (&staddr, &stsize);
2174         if (staddr) {
2175 #ifndef HOST_WIN32
2176                 info->client_info.stack_start_limit = staddr;
2177 #endif
2178                 info->client_info.stack_end = staddr + stsize;
2179         } else {
2180                 gsize stack_bottom = (gsize)stack_bottom_fallback;
2181                 stack_bottom += 4095;
2182                 stack_bottom &= ~4095;
2183                 info->client_info.stack_end = (char*)stack_bottom;
2184         }
2185
2186 #ifdef USE_MONO_CTX
2187         memset (&info->client_info.ctx, 0, sizeof (MonoContext));
2188 #else
2189         memset (&info->client_info.regs, 0, sizeof (info->client_info.regs));
2190 #endif
2191
2192         if (mono_gc_get_gc_callbacks ()->thread_attach_func)
2193                 info->client_info.runtime_data = mono_gc_get_gc_callbacks ()->thread_attach_func ();
2194
2195         binary_protocol_thread_register ((gpointer)mono_thread_info_get_tid (info));
2196
2197         SGEN_LOG (3, "registered thread %p (%p) stack end %p", info, (gpointer)mono_thread_info_get_tid (info), info->client_info.stack_end);
2198 }
2199
2200 void
2201 sgen_client_thread_unregister (SgenThreadInfo *p)
2202 {
2203         MonoNativeThreadId tid;
2204
2205 #ifndef HAVE_KW_THREAD
2206         mono_native_tls_set_value (thread_info_key, NULL);
2207 #else
2208         sgen_thread_info = NULL;
2209 #endif
2210
2211         tid = mono_thread_info_get_tid (p);
2212
2213         if (p->client_info.info.runtime_thread)
2214                 mono_threads_add_joinable_thread ((gpointer)tid);
2215
2216         if (mono_gc_get_gc_callbacks ()->thread_detach_func) {
2217                 mono_gc_get_gc_callbacks ()->thread_detach_func (p->client_info.runtime_data);
2218                 p->client_info.runtime_data = NULL;
2219         }
2220
2221         binary_protocol_thread_unregister ((gpointer)tid);
2222         SGEN_LOG (3, "unregister thread %p (%p)", p, (gpointer)tid);
2223 }
2224
2225 void
2226 mono_gc_set_skip_thread (gboolean skip)
2227 {
2228         SgenThreadInfo *info = mono_thread_info_current ();
2229
2230         LOCK_GC;
2231         info->client_info.gc_disabled = skip;
2232         UNLOCK_GC;
2233 }
2234
2235 static gboolean
2236 is_critical_method (MonoMethod *method)
2237 {
2238         return mono_runtime_is_critical_method (method) || sgen_is_critical_method (method);
2239 }
2240
2241 static gboolean
2242 thread_in_critical_region (SgenThreadInfo *info)
2243 {
2244         return info->client_info.in_critical_region;
2245 }
2246
2247 static void
2248 sgen_thread_attach (SgenThreadInfo *info)
2249 {
2250         mono_handle_arena_init ((MonoHandleArena**) &info->client_info.info.handle_arena);
2251
2252         if (mono_gc_get_gc_callbacks ()->thread_attach_func && !info->client_info.runtime_data)
2253                 info->client_info.runtime_data = mono_gc_get_gc_callbacks ()->thread_attach_func ();
2254 }
2255
2256 static void
2257 sgen_thread_detach (SgenThreadInfo *p)
2258 {
2259         /* If a delegate is passed to native code and invoked on a thread we dont
2260          * know about, the jit will register it with mono_jit_thread_attach, but
2261          * we have no way of knowing when that thread goes away.  SGen has a TSD
2262          * so we assume that if the domain is still registered, we can detach
2263          * the thread
2264          */
2265         if (mono_domain_get ())
2266                 mono_thread_detach_internal (mono_thread_internal_current ());
2267
2268         mono_handle_arena_cleanup ((MonoHandleArena**) &p->client_info.info.handle_arena);
2269 }
2270
2271 gboolean
2272 mono_gc_register_thread (void *baseptr)
2273 {
2274         return mono_thread_info_attach (baseptr) != NULL;
2275 }
2276
2277 gboolean
2278 mono_gc_is_gc_thread (void)
2279 {
2280         gboolean result;
2281         LOCK_GC;
2282         result = mono_thread_info_current () != NULL;
2283         UNLOCK_GC;
2284         return result;
2285 }
2286
2287 void
2288 sgen_client_thread_register_worker (void)
2289 {
2290         mono_thread_info_register_small_id ();
2291         mono_thread_info_set_name (mono_native_thread_id_get (), "SGen worker");
2292 }
2293
2294 /* Variables holding start/end nursery so it won't have to be passed at every call */
2295 static void *scan_area_arg_start, *scan_area_arg_end;
2296
2297 void
2298 mono_gc_conservatively_scan_area (void *start, void *end)
2299 {
2300         sgen_conservatively_pin_objects_from ((void **)start, (void **)end, scan_area_arg_start, scan_area_arg_end, PIN_TYPE_STACK);
2301 }
2302
2303 void*
2304 mono_gc_scan_object (void *obj, void *gc_data)
2305 {
2306         ScanCopyContext *ctx = (ScanCopyContext *)gc_data;
2307         ctx->ops->copy_or_mark_object ((GCObject**)&obj, ctx->queue);
2308         return obj;
2309 }
2310
2311 /*
2312  * Mark from thread stacks and registers.
2313  */
2314 void
2315 sgen_client_scan_thread_data (void *start_nursery, void *end_nursery, gboolean precise, ScanCopyContext ctx)
2316 {
2317         scan_area_arg_start = start_nursery;
2318         scan_area_arg_end = end_nursery;
2319
2320         FOREACH_THREAD (info) {
2321                 int skip_reason = 0;
2322                 void *aligned_stack_start = (void*)(mword) ALIGN_TO ((mword)info->client_info.stack_start, SIZEOF_VOID_P);
2323
2324                 if (info->client_info.skip) {
2325                         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);
2326                         skip_reason = 1;
2327                 } else if (info->client_info.gc_disabled) {
2328                         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);
2329                         skip_reason = 2;
2330                 } else if (!mono_thread_info_is_live (info)) {
2331                         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);
2332                         skip_reason = 3;
2333                 }
2334
2335                 binary_protocol_scan_stack ((gpointer)mono_thread_info_get_tid (info), info->client_info.stack_start, info->client_info.stack_end, skip_reason);
2336
2337                 if (skip_reason)
2338                         continue;
2339
2340                 g_assert (info->client_info.suspend_done);
2341                 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 ());
2342                 if (mono_gc_get_gc_callbacks ()->thread_mark_func && !conservative_stack_mark) {
2343                         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);
2344                 } else if (!precise) {
2345                         if (!conservative_stack_mark) {
2346                                 fprintf (stderr, "Precise stack mark not supported - disabling.\n");
2347                                 conservative_stack_mark = TRUE;
2348                         }
2349                         sgen_conservatively_pin_objects_from ((void **)aligned_stack_start, (void **)info->client_info.stack_end, start_nursery, end_nursery, PIN_TYPE_STACK);
2350                 }
2351
2352                 if (!precise) {
2353 #ifdef USE_MONO_CTX
2354                         sgen_conservatively_pin_objects_from ((void**)&info->client_info.ctx, (void**)(&info->client_info.ctx + 1),
2355                                 start_nursery, end_nursery, PIN_TYPE_STACK);
2356 #else
2357                         sgen_conservatively_pin_objects_from ((void**)&info->client_info.regs, (void**)&info->client_info.regs + ARCH_NUM_REGS,
2358                                         start_nursery, end_nursery, PIN_TYPE_STACK);
2359 #endif
2360                         {
2361                                 // This is used on Coop GC for platforms where we cannot get the data for individual registers.
2362                                 // We force a spill of all registers into the stack and pass a chunk of data into sgen.
2363                                 MonoThreadUnwindState *state = &info->client_info.info.thread_saved_state [SELF_SUSPEND_STATE_INDEX];
2364                                 if (state && state->gc_stackdata) {
2365                                         sgen_conservatively_pin_objects_from ((void **)state->gc_stackdata, (void**)((char*)state->gc_stackdata + state->gc_stackdata_size),
2366                                                 start_nursery, end_nursery, PIN_TYPE_STACK);
2367                                 }
2368                         }
2369                 }
2370         } FOREACH_THREAD_END
2371 }
2372
2373 /*
2374  * mono_gc_set_stack_end:
2375  *
2376  *   Set the end of the current threads stack to STACK_END. The stack space between
2377  * STACK_END and the real end of the threads stack will not be scanned during collections.
2378  */
2379 void
2380 mono_gc_set_stack_end (void *stack_end)
2381 {
2382         SgenThreadInfo *info;
2383
2384         LOCK_GC;
2385         info = mono_thread_info_current ();
2386         if (info) {
2387                 SGEN_ASSERT (0, stack_end < info->client_info.stack_end, "Can only lower stack end");
2388                 info->client_info.stack_end = stack_end;
2389         }
2390         UNLOCK_GC;
2391 }
2392
2393 /*
2394  * Roots
2395  */
2396
2397 int
2398 mono_gc_register_root (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
2399 {
2400         return sgen_register_root (start, size, descr, descr ? ROOT_TYPE_NORMAL : ROOT_TYPE_PINNED, source, msg);
2401 }
2402
2403 int
2404 mono_gc_register_root_wbarrier (char *start, size_t size, MonoGCDescriptor descr, MonoGCRootSource source, const char *msg)
2405 {
2406         return sgen_register_root (start, size, descr, ROOT_TYPE_WBARRIER, source, msg);
2407 }
2408
2409 void
2410 mono_gc_deregister_root (char* addr)
2411 {
2412         sgen_deregister_root (addr);
2413 }
2414
2415 /*
2416  * PThreads
2417  */
2418
2419 #ifndef HOST_WIN32
2420 int
2421 mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
2422 {
2423         return pthread_create (new_thread, attr, start_routine, arg);
2424 }
2425 #endif
2426
2427 /*
2428  * Miscellaneous
2429  */
2430
2431 void
2432 sgen_client_total_allocated_heap_changed (size_t allocated_heap)
2433 {
2434         mono_runtime_resource_check_limit (MONO_RESOURCE_GC_HEAP, allocated_heap);
2435 }
2436
2437 gboolean
2438 mono_gc_user_markers_supported (void)
2439 {
2440         return TRUE;
2441 }
2442
2443 gboolean
2444 mono_object_is_alive (MonoObject* o)
2445 {
2446         return TRUE;
2447 }
2448
2449 int
2450 mono_gc_get_generation (MonoObject *obj)
2451 {
2452         if (sgen_ptr_in_nursery (obj))
2453                 return 0;
2454         return 1;
2455 }
2456
2457 void
2458 mono_gc_enable_events (void)
2459 {
2460 }
2461
2462 const char *
2463 mono_gc_get_gc_name (void)
2464 {
2465         return "sgen";
2466 }
2467
2468 char*
2469 mono_gc_get_description (void)
2470 {
2471         return g_strdup ("sgen");
2472 }
2473
2474 void
2475 mono_gc_set_desktop_mode (void)
2476 {
2477 }
2478
2479 gboolean
2480 mono_gc_is_moving (void)
2481 {
2482         return TRUE;
2483 }
2484
2485 gboolean
2486 mono_gc_is_disabled (void)
2487 {
2488         return FALSE;
2489 }
2490
2491 #ifdef HOST_WIN32
2492 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved)
2493 {
2494         return TRUE;
2495 }
2496 #endif
2497
2498 int
2499 mono_gc_max_generation (void)
2500 {
2501         return 1;
2502 }
2503
2504 gboolean
2505 mono_gc_precise_stack_mark_enabled (void)
2506 {
2507         return !conservative_stack_mark;
2508 }
2509
2510 void
2511 mono_gc_collect (int generation)
2512 {
2513         sgen_gc_collect (generation);
2514 }
2515
2516 int
2517 mono_gc_collection_count (int generation)
2518 {
2519         return sgen_gc_collection_count (generation);
2520 }
2521
2522 int64_t
2523 mono_gc_get_used_size (void)
2524 {
2525         return (int64_t)sgen_gc_get_used_size ();
2526 }
2527
2528 int64_t
2529 mono_gc_get_heap_size (void)
2530 {
2531         return (int64_t)sgen_gc_get_total_heap_allocation ();
2532 }
2533
2534 MonoGCDescriptor
2535 mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker)
2536 {
2537         return sgen_make_user_root_descriptor (marker);
2538 }
2539
2540 MonoGCDescriptor
2541 mono_gc_make_descr_for_string (gsize *bitmap, int numbits)
2542 {
2543         return SGEN_DESC_STRING;
2544 }
2545
2546 void*
2547 mono_gc_get_nursery (int *shift_bits, size_t *size)
2548 {
2549         *size = sgen_nursery_size;
2550         *shift_bits = DEFAULT_NURSERY_BITS;
2551         return sgen_get_nursery_start ();
2552 }
2553
2554 int
2555 mono_gc_get_los_limit (void)
2556 {
2557         return SGEN_MAX_SMALL_OBJ_SIZE;
2558 }
2559
2560 gpointer
2561 sgen_client_default_metadata (void)
2562 {
2563         return mono_domain_get ();
2564 }
2565
2566 gpointer
2567 sgen_client_metadata_for_object (GCObject *obj)
2568 {
2569         return mono_object_domain (obj);
2570 }
2571
2572 /**
2573  * mono_gchandle_is_in_domain:
2574  * @gchandle: a GCHandle's handle.
2575  * @domain: An application domain.
2576  *
2577  * Returns: TRUE if the object wrapped by the @gchandle belongs to the specific @domain.
2578  */
2579 gboolean
2580 mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain)
2581 {
2582         MonoDomain *gchandle_domain = (MonoDomain *)sgen_gchandle_get_metadata (gchandle);
2583         return domain->domain_id == gchandle_domain->domain_id;
2584 }
2585
2586 /**
2587  * mono_gchandle_free_domain:
2588  * @unloading: domain that is unloading
2589  *
2590  * Function used internally to cleanup any GC handle for objects belonging
2591  * to the specified domain during appdomain unload.
2592  */
2593 void
2594 mono_gchandle_free_domain (MonoDomain *unloading)
2595 {
2596 }
2597
2598 static gpointer
2599 null_link_if_in_domain (gpointer hidden, GCHandleType handle_type, int max_generation, gpointer user)
2600 {
2601         MonoDomain *unloading_domain = (MonoDomain *)user;
2602         MonoDomain *obj_domain;
2603         gboolean is_weak = MONO_GC_HANDLE_TYPE_IS_WEAK (handle_type);
2604         if (MONO_GC_HANDLE_IS_OBJECT_POINTER (hidden)) {
2605                 MonoObject *obj = (MonoObject *)MONO_GC_REVEAL_POINTER (hidden, is_weak);
2606                 obj_domain = mono_object_domain (obj);
2607         } else {
2608                 obj_domain = (MonoDomain *)MONO_GC_REVEAL_POINTER (hidden, is_weak);
2609         }
2610         if (unloading_domain->domain_id == obj_domain->domain_id)
2611                 return NULL;
2612         return hidden;
2613 }
2614
2615 void
2616 sgen_null_links_for_domain (MonoDomain *domain)
2617 {
2618         guint type;
2619         for (type = HANDLE_TYPE_MIN; type < HANDLE_TYPE_MAX; ++type)
2620                 sgen_gchandle_iterate ((GCHandleType)type, GENERATION_OLD, null_link_if_in_domain, domain);
2621 }
2622
2623 void
2624 mono_gchandle_set_target (guint32 gchandle, MonoObject *obj)
2625 {
2626         sgen_gchandle_set_target (gchandle, obj);
2627 }
2628
2629 void
2630 sgen_client_gchandle_created (int handle_type, GCObject *obj, guint32 handle)
2631 {
2632 #ifndef DISABLE_PERFCOUNTERS
2633         mono_perfcounters->gc_num_handles++;
2634 #endif
2635         mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_CREATED, handle_type, handle, obj);
2636 }
2637
2638 void
2639 sgen_client_gchandle_destroyed (int handle_type, guint32 handle)
2640 {
2641 #ifndef DISABLE_PERFCOUNTERS
2642         mono_perfcounters->gc_num_handles--;
2643 #endif
2644         mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_DESTROYED, handle_type, handle, NULL);
2645 }
2646
2647 void
2648 sgen_client_ensure_weak_gchandles_accessible (void)
2649 {
2650         /*
2651          * During the second bridge processing step the world is
2652          * running again.  That step processes all weak links once
2653          * more to null those that refer to dead objects.  Before that
2654          * is completed, those links must not be followed, so we
2655          * conservatively wait for bridge processing when any weak
2656          * link is dereferenced.
2657          */
2658         /* FIXME: A GC can occur after this check fails, in which case we
2659          * should wait for bridge processing but would fail to do so.
2660          */
2661         if (G_UNLIKELY (bridge_processing_in_progress))
2662                 mono_gc_wait_for_bridge_processing ();
2663 }
2664
2665 void*
2666 mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data)
2667 {
2668         void *result;
2669         LOCK_INTERRUPTION;
2670         result = func (data);
2671         UNLOCK_INTERRUPTION;
2672         return result;
2673 }
2674
2675 void
2676 mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size)
2677 {
2678         // FIXME:
2679 }
2680
2681 guint8*
2682 mono_gc_get_card_table (int *shift_bits, gpointer *mask)
2683 {
2684         return sgen_get_card_table_configuration (shift_bits, mask);
2685 }
2686
2687 gboolean
2688 mono_gc_card_table_nursery_check (void)
2689 {
2690         return !sgen_get_major_collector ()->is_concurrent;
2691 }
2692
2693 /* Negative value to remove */
2694 void
2695 mono_gc_add_memory_pressure (gint64 value)
2696 {
2697         /* FIXME: Implement at some point? */
2698 }
2699
2700 /*
2701  * Logging
2702  */
2703
2704 void
2705 sgen_client_degraded_allocation (size_t size)
2706 {
2707         static int last_major_gc_warned = -1;
2708         static int num_degraded = 0;
2709
2710         if (last_major_gc_warned < (int)gc_stats.major_gc_count) {
2711                 ++num_degraded;
2712                 if (num_degraded == 1 || num_degraded == 3)
2713                         mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Degraded allocation.  Consider increasing nursery-size if the warning persists.");
2714                 else if (num_degraded == 10)
2715                         mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Repeated degraded allocation.  Consider increasing nursery-size.");
2716                 last_major_gc_warned = gc_stats.major_gc_count;
2717         }
2718 }
2719
2720 void
2721 sgen_client_log_timing (GGTimingInfo *info, mword promoted_size, mword major_used_size)
2722 {
2723         SgenMajorCollector *major_collector = sgen_get_major_collector ();
2724         mword num_major_sections = major_collector->get_num_major_sections ();
2725         char full_timing_buff [1024];
2726         full_timing_buff [0] = '\0';
2727
2728         if (!info->is_overflow)
2729                 sprintf (full_timing_buff, "total %.2fms, bridge %.2fms", info->stw_time / 10000.0f, (int)info->bridge_time / 10000.0f);
2730         if (info->generation == GENERATION_OLD)
2731                 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "GC_MAJOR%s: (%s) pause %.2fms, %s los size: %dK in use: %dK",
2732                         info->is_overflow ? "_OVERFLOW" : "",
2733                         info->reason ? info->reason : "",
2734                         (int)info->total_time / 10000.0f,
2735                         full_timing_buff,
2736                         los_memory_usage_total / 1024,
2737                         los_memory_usage / 1024);
2738         else
2739                 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "GC_MINOR%s: (%s) pause %.2fms, %s promoted %dK major size: %dK in use: %dK los size: %dK in use: %dK",
2740                                 info->is_overflow ? "_OVERFLOW" : "",
2741                         info->reason ? info->reason : "",
2742                         (int)info->total_time / 10000.0f,
2743                         full_timing_buff,
2744                         (int)promoted_size / 1024,
2745                         major_collector->section_size * num_major_sections / 1024,
2746                         major_used_size / 1024,
2747                         los_memory_usage_total / 1024,
2748                         los_memory_usage / 1024);
2749 }
2750
2751 /*
2752  * Debugging
2753  */
2754
2755 const char*
2756 sgen_client_description_for_internal_mem_type (int type)
2757 {
2758         switch (type) {
2759         case INTERNAL_MEM_EPHEMERON_LINK: return "ephemeron-link";
2760         default:
2761                 return NULL;
2762         }
2763 }
2764
2765 void
2766 sgen_client_pre_collection_checks (void)
2767 {
2768         if (sgen_mono_xdomain_checks) {
2769                 sgen_clear_nursery_fragments ();
2770                 sgen_check_for_xdomain_refs ();
2771         }
2772 }
2773
2774 gboolean
2775 sgen_client_vtable_is_inited (MonoVTable *vt)
2776 {
2777         return vt->klass->inited;
2778 }
2779
2780 const char*
2781 sgen_client_vtable_get_namespace (MonoVTable *vt)
2782 {
2783         return vt->klass->name_space;
2784 }
2785
2786 const char*
2787 sgen_client_vtable_get_name (MonoVTable *vt)
2788 {
2789         return vt->klass->name;
2790 }
2791
2792 /*
2793  * Initialization
2794  */
2795
2796 void
2797 sgen_client_init (void)
2798 {
2799         int dummy;
2800         MonoThreadInfoCallbacks cb;
2801
2802         cb.thread_register = sgen_thread_register;
2803         cb.thread_detach = sgen_thread_detach;
2804         cb.thread_unregister = sgen_thread_unregister;
2805         cb.thread_attach = sgen_thread_attach;
2806         cb.mono_method_is_critical = (gboolean (*)(void *))is_critical_method;
2807         cb.mono_thread_in_critical_region = thread_in_critical_region;
2808
2809         mono_threads_init (&cb, sizeof (SgenThreadInfo));
2810
2811         ///* Keep this the default for now */
2812         /* Precise marking is broken on all supported targets. Disable until fixed. */
2813         conservative_stack_mark = TRUE;
2814
2815         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_EPHEMERON_LINK, sizeof (EphemeronLinkNode));
2816
2817         mono_sgen_init_stw ();
2818
2819 #ifndef HAVE_KW_THREAD
2820         mono_native_tls_alloc (&thread_info_key, NULL);
2821 #if defined(TARGET_OSX) || defined(TARGET_WIN32) || defined(TARGET_ANDROID) || defined(TARGET_IOS)
2822         /*
2823          * CEE_MONO_TLS requires the tls offset, not the key, so the code below only works on darwin,
2824          * where the two are the same.
2825          */
2826         mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, thread_info_key);
2827 #endif
2828 #else
2829         {
2830                 int tls_offset = -1;
2831                 MONO_THREAD_VAR_OFFSET (sgen_thread_info, tls_offset);
2832                 mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, tls_offset);
2833         }
2834 #endif
2835
2836         /*
2837          * This needs to happen before any internal allocations because
2838          * it inits the small id which is required for hazard pointer
2839          * operations.
2840          */
2841         sgen_os_init ();
2842
2843         mono_gc_register_thread (&dummy);
2844 }
2845
2846 gboolean
2847 sgen_client_handle_gc_param (const char *opt)
2848 {
2849         if (g_str_has_prefix (opt, "stack-mark=")) {
2850                 opt = strchr (opt, '=') + 1;
2851                 if (!strcmp (opt, "precise")) {
2852                         conservative_stack_mark = FALSE;
2853                 } else if (!strcmp (opt, "conservative")) {
2854                         conservative_stack_mark = TRUE;
2855                 } else {
2856                         sgen_env_var_error (MONO_GC_PARAMS_NAME, conservative_stack_mark ? "Using `conservative`." : "Using `precise`.",
2857                                         "Invalid value `%s` for `stack-mark` option, possible values are: `precise`, `conservative`.", opt);
2858                 }
2859         } else if (g_str_has_prefix (opt, "bridge-implementation=")) {
2860                 opt = strchr (opt, '=') + 1;
2861                 sgen_set_bridge_implementation (opt);
2862         } else if (g_str_has_prefix (opt, "toggleref-test")) {
2863                 /* FIXME: This should probably in MONO_GC_DEBUG */
2864                 sgen_register_test_toggleref_callback ();
2865         } else {
2866                 return FALSE;
2867         }
2868         return TRUE;
2869 }
2870
2871 void
2872 sgen_client_print_gc_params_usage (void)
2873 {
2874         fprintf (stderr, "  stack-mark=MARK-METHOD (where MARK-METHOD is 'precise' or 'conservative')\n");
2875 }
2876
2877 gboolean
2878 sgen_client_handle_gc_debug (const char *opt)
2879 {
2880         if (!strcmp (opt, "xdomain-checks")) {
2881                 sgen_mono_xdomain_checks = TRUE;
2882         } else if (!strcmp (opt, "do-not-finalize")) {
2883                 mono_do_not_finalize = TRUE;
2884         } else if (g_str_has_prefix (opt, "do-not-finalize=")) {
2885                 opt = strchr (opt, '=') + 1;
2886                 mono_do_not_finalize = TRUE;
2887                 mono_do_not_finalize_class_names = g_strsplit (opt, ",", 0);
2888         } else if (!strcmp (opt, "log-finalizers")) {
2889                 log_finalizers = TRUE;
2890         } else if (!strcmp (opt, "no-managed-allocator")) {
2891                 sgen_set_use_managed_allocator (FALSE);
2892         } else if (!sgen_bridge_handle_gc_debug (opt)) {
2893                 return FALSE;
2894         }
2895         return TRUE;
2896 }
2897
2898 void
2899 sgen_client_print_gc_debug_usage (void)
2900 {
2901         fprintf (stderr, "  xdomain-checks\n");
2902         fprintf (stderr, "  do-not-finalize\n");
2903         fprintf (stderr, "  log-finalizers\n");
2904         fprintf (stderr, "  no-managed-allocator\n");
2905         sgen_bridge_print_gc_debug_usage ();
2906 }
2907
2908
2909 gpointer
2910 sgen_client_get_provenance (void)
2911 {
2912 #ifdef SGEN_OBJECT_PROVENANCE
2913         MonoGCCallbacks *cb = mono_gc_get_gc_callbacks ();
2914         gpointer (*get_provenance_func) (void);
2915         if (!cb)
2916                 return NULL;
2917         get_provenance_func = cb->get_provenance_func;
2918         if (get_provenance_func)
2919                 return get_provenance_func ();
2920         return NULL;
2921 #else
2922         return NULL;
2923 #endif
2924 }
2925
2926 void
2927 sgen_client_describe_invalid_pointer (GCObject *ptr)
2928 {
2929         sgen_bridge_describe_pointer (ptr);
2930 }
2931
2932 static gboolean gc_inited;
2933
2934 void
2935 mono_gc_base_init (void)
2936 {
2937         if (gc_inited)
2938                 return;
2939
2940         mono_counters_init ();
2941
2942 #ifdef HEAVY_STATISTICS
2943         mono_counters_register ("los marked cards", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_marked_cards);
2944         mono_counters_register ("los array cards scanned ", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_cards);
2945         mono_counters_register ("los array remsets", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_remsets);
2946
2947         mono_counters_register ("WBarrier set arrayref", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_set_arrayref);
2948         mono_counters_register ("WBarrier value copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_value_copy);
2949         mono_counters_register ("WBarrier object copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_object_copy);
2950 #endif
2951
2952         sgen_gc_init ();
2953
2954         if (nursery_canaries_enabled ())
2955                 sgen_set_use_managed_allocator (FALSE);
2956
2957 #if defined(HAVE_KW_THREAD)
2958         /* This can happen with using libmonosgen.so */
2959         if (mono_tls_key_get_offset (TLS_KEY_SGEN_TLAB_NEXT_ADDR) == -1)
2960                 sgen_set_use_managed_allocator (FALSE);
2961 #endif
2962
2963         gc_inited = TRUE;
2964 }
2965
2966 void
2967 mono_gc_base_cleanup (void)
2968 {
2969         sgen_thread_pool_shutdown ();
2970 }
2971
2972 gboolean
2973 mono_gc_is_null (void)
2974 {
2975         return FALSE;
2976 }
2977
2978 #endif