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