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