mono/metadata/sgen-mono.c

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