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