mono/metadata/sgen-mono.c

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