mono/metadata/sgen-mono.c

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