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