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