mono/metadata/sgen-mono.c

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