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