mono/metadata/sgen-mono.c

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