mono/metadata/sgen-mono.c

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