7d8e12dc8ee6dea75793d6f05c24180311ec1b3f
[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, 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(_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                 void **dislink = mono_monitor_get_object_monitor_weak_link (obj);
788                 if (dislink)
789                         sgen_register_disappearing_link (NULL, dislink, FALSE, TRUE);
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         sgen_process_dislink_stage_entries ();
853
854         sgen_clear_nursery_fragments ();
855
856         if (sgen_mono_xdomain_checks && domain != mono_get_root_domain ()) {
857                 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_NORMAL);
858                 sgen_scan_for_registered_roots_in_domain (domain, ROOT_TYPE_WBARRIER);
859                 sgen_check_for_xdomain_refs ();
860         }
861
862         /*Ephemerons and dislinks must be processed before LOS since they might end up pointing
863         to memory returned to the OS.*/
864         null_ephemerons_for_domain (domain);
865
866         for (i = GENERATION_NURSERY; i < GENERATION_MAX; ++i)
867                 sgen_null_links_if (object_in_domain_predicate, domain, i);
868
869         for (i = GENERATION_NURSERY; i < GENERATION_MAX; ++i)
870                 sgen_remove_finalizers_if (object_in_domain_predicate, domain, i);
871
872         sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data,
873                         (IterateObjectCallbackFunc)clear_domain_process_minor_object_callback, domain, FALSE);
874
875         /* We need two passes over major and large objects because
876            freeing such objects might give their memory back to the OS
877            (in the case of large objects) or obliterate its vtable
878            (pinned objects with major-copying or pinned and non-pinned
879            objects with major-mark&sweep), but we might need to
880            dereference a pointer from an object to another object if
881            the first object is a proxy. */
882         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, (IterateObjectCallbackFunc)clear_domain_process_major_object_callback, domain);
883         for (bigobj = los_object_list; bigobj; bigobj = bigobj->next)
884                 clear_domain_process_object ((GCObject*)bigobj->data, domain);
885
886         prev = NULL;
887         for (bigobj = los_object_list; bigobj;) {
888                 if (need_remove_object_for_domain ((GCObject*)bigobj->data, domain)) {
889                         LOSObject *to_free = bigobj;
890                         if (prev)
891                                 prev->next = bigobj->next;
892                         else
893                                 los_object_list = bigobj->next;
894                         bigobj = bigobj->next;
895                         SGEN_LOG (4, "Freeing large object %p", bigobj->data);
896                         sgen_los_free_object (to_free);
897                         continue;
898                 }
899                 prev = bigobj;
900                 bigobj = bigobj->next;
901         }
902         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_NON_PINNED, (IterateObjectCallbackFunc)clear_domain_free_major_non_pinned_object_callback, domain);
903         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_PINNED, (IterateObjectCallbackFunc)clear_domain_free_major_pinned_object_callback, domain);
904
905         if (domain == mono_get_root_domain ()) {
906                 sgen_pin_stats_print_class_stats ();
907                 sgen_object_layout_dump (stdout);
908         }
909
910         sgen_restart_world (0, NULL);
911
912         binary_protocol_domain_unload_end (domain);
913         binary_protocol_flush_buffers (FALSE);
914
915         UNLOCK_GC;
916 }
917
918 /*
919  * Allocation
920  */
921
922 static gboolean alloc_events = FALSE;
923
924 void
925 mono_gc_enable_alloc_events (void)
926 {
927         alloc_events = TRUE;
928 }
929
930 void*
931 mono_gc_alloc_obj (MonoVTable *vtable, size_t size)
932 {
933         MonoObject *obj = sgen_alloc_obj (vtable, size);
934
935         if (G_UNLIKELY (alloc_events))
936                 mono_profiler_allocation (obj);
937
938         return obj;
939 }
940
941 void*
942 mono_gc_alloc_pinned_obj (MonoVTable *vtable, size_t size)
943 {
944         MonoObject *obj = sgen_alloc_obj_pinned (vtable, size);
945
946         if (G_UNLIKELY (alloc_events))
947                 mono_profiler_allocation (obj);
948
949         return obj;
950 }
951
952 void*
953 mono_gc_alloc_mature (MonoVTable *vtable)
954 {
955         MonoObject *obj = sgen_alloc_obj_mature (vtable, vtable->klass->instance_size);
956
957         if (obj && G_UNLIKELY (obj->vtable->klass->has_finalize))
958                 mono_object_register_finalizer (obj);
959
960         if (G_UNLIKELY (alloc_events))
961                 mono_profiler_allocation (obj);
962
963         return obj;
964 }
965
966 void*
967 mono_gc_alloc_fixed (size_t size, void *descr)
968 {
969         /* FIXME: do a single allocation */
970         void *res = calloc (1, size);
971         if (!res)
972                 return NULL;
973         if (!mono_gc_register_root (res, size, descr)) {
974                 free (res);
975                 res = NULL;
976         }
977         return res;
978 }
979
980 void
981 mono_gc_free_fixed (void* addr)
982 {
983         mono_gc_deregister_root (addr);
984         free (addr);
985 }
986
987 /*
988  * Managed allocator
989  */
990
991 static MonoMethod* alloc_method_cache [ATYPE_NUM];
992 static MonoMethod* slowpath_alloc_method_cache [ATYPE_NUM];
993 static gboolean use_managed_allocator = TRUE;
994
995 #ifdef MANAGED_ALLOCATION
996
997 #ifdef HAVE_KW_THREAD
998
999 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb)   do {    \
1000         mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX);   \
1001         mono_mb_emit_byte ((mb), CEE_MONO_TLS);         \
1002         mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_TLAB_NEXT_ADDR);            \
1003         } while (0)
1004
1005 #define EMIT_TLS_ACCESS_TEMP_END(mb)    do {    \
1006         mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX);   \
1007         mono_mb_emit_byte ((mb), CEE_MONO_TLS);         \
1008         mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_TLAB_TEMP_END);             \
1009         } while (0)
1010
1011 #else
1012
1013 #if defined(__APPLE__) || defined (HOST_WIN32)
1014 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb)   do {    \
1015         mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX);   \
1016         mono_mb_emit_byte ((mb), CEE_MONO_TLS);         \
1017         mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_THREAD_INFO);       \
1018         mono_mb_emit_icon ((mb), MONO_STRUCT_OFFSET (SgenThreadInfo, tlab_next_addr));  \
1019         mono_mb_emit_byte ((mb), CEE_ADD);              \
1020         mono_mb_emit_byte ((mb), CEE_LDIND_I);          \
1021         } while (0)
1022
1023 #define EMIT_TLS_ACCESS_TEMP_END(mb)    do {    \
1024         mono_mb_emit_byte ((mb), MONO_CUSTOM_PREFIX);   \
1025         mono_mb_emit_byte ((mb), CEE_MONO_TLS);         \
1026         mono_mb_emit_i4 ((mb), TLS_KEY_SGEN_THREAD_INFO);       \
1027         mono_mb_emit_icon ((mb), MONO_STRUCT_OFFSET (SgenThreadInfo, tlab_temp_end));   \
1028         mono_mb_emit_byte ((mb), CEE_ADD);              \
1029         mono_mb_emit_byte ((mb), CEE_LDIND_I);          \
1030         } while (0)
1031
1032 #else
1033 #define EMIT_TLS_ACCESS_NEXT_ADDR(mb)   do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1034 #define EMIT_TLS_ACCESS_TEMP_END(mb)    do { g_error ("sgen is not supported when using --with-tls=pthread.\n"); } while (0)
1035 #endif
1036
1037 #endif
1038
1039 /* FIXME: Do this in the JIT, where specialized allocation sequences can be created
1040  * for each class. This is currently not easy to do, as it is hard to generate basic 
1041  * blocks + branches, but it is easy with the linear IL codebase.
1042  *
1043  * For this to work we'd need to solve the TLAB race, first.  Now we
1044  * require the allocator to be in a few known methods to make sure
1045  * that they are executed atomically via the restart mechanism.
1046  */
1047 static MonoMethod*
1048 create_allocator (int atype, gboolean slowpath)
1049 {
1050         int p_var, size_var;
1051         guint32 slowpath_branch, max_size_branch;
1052         MonoMethodBuilder *mb;
1053         MonoMethod *res;
1054         MonoMethodSignature *csig;
1055         static gboolean registered = FALSE;
1056         int tlab_next_addr_var, new_next_var;
1057         const char *name = NULL;
1058         AllocatorWrapperInfo *info;
1059         int num_params, i;
1060
1061         if (!registered) {
1062                 mono_register_jit_icall (mono_gc_alloc_obj, "mono_gc_alloc_obj", mono_create_icall_signature ("object ptr int"), FALSE);
1063                 mono_register_jit_icall (mono_gc_alloc_vector, "mono_gc_alloc_vector", mono_create_icall_signature ("object ptr int int"), FALSE);
1064                 mono_register_jit_icall (mono_gc_alloc_string, "mono_gc_alloc_string", mono_create_icall_signature ("object ptr int int32"), FALSE);
1065                 registered = TRUE;
1066         }
1067
1068         if (atype == ATYPE_SMALL) {
1069                 name = slowpath ? "SlowAllocSmall" : "AllocSmall";
1070         } else if (atype == ATYPE_NORMAL) {
1071                 name = slowpath ? "SlowAlloc" : "Alloc";
1072         } else if (atype == ATYPE_VECTOR) {
1073                 name = slowpath ? "SlowAllocVector" : "AllocVector";
1074         } else if (atype == ATYPE_STRING) {
1075                 name = slowpath ? "SlowAllocString" : "AllocString";
1076         } else {
1077                 g_assert_not_reached ();
1078         }
1079
1080         if (atype == ATYPE_NORMAL)
1081                 num_params = 1;
1082         else
1083                 num_params = 2;
1084
1085         csig = mono_metadata_signature_alloc (mono_defaults.corlib, num_params);
1086         if (atype == ATYPE_STRING) {
1087                 csig->ret = &mono_defaults.string_class->byval_arg;
1088                 csig->params [0] = &mono_defaults.int_class->byval_arg;
1089                 csig->params [1] = &mono_defaults.int32_class->byval_arg;
1090         } else {
1091                 csig->ret = &mono_defaults.object_class->byval_arg;
1092                 for (i = 0; i < num_params; i++)
1093                         csig->params [i] = &mono_defaults.int_class->byval_arg;
1094         }
1095
1096         mb = mono_mb_new (mono_defaults.object_class, name, MONO_WRAPPER_ALLOC);
1097
1098 #ifndef DISABLE_JIT
1099         if (slowpath) {
1100                 switch (atype) {
1101                 case ATYPE_NORMAL:
1102                 case ATYPE_SMALL:
1103                         mono_mb_emit_ldarg (mb, 0);
1104                         mono_mb_emit_icall (mb, mono_object_new_specific);
1105                         break;
1106                 case ATYPE_VECTOR:
1107                         mono_mb_emit_ldarg (mb, 0);
1108                         mono_mb_emit_ldarg (mb, 1);
1109                         mono_mb_emit_icall (mb, mono_array_new_specific);
1110                         break;
1111                 case ATYPE_STRING:
1112                         mono_mb_emit_ldarg (mb, 1);
1113                         mono_mb_emit_icall (mb, mono_string_alloc);
1114                         break;
1115                 default:
1116                         g_assert_not_reached ();
1117                 }
1118
1119                 goto done;
1120         }
1121
1122         size_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1123         if (atype == ATYPE_SMALL) {
1124                 /* size_var = size_arg */
1125                 mono_mb_emit_ldarg (mb, 1);
1126                 mono_mb_emit_stloc (mb, size_var);
1127         } else if (atype == ATYPE_NORMAL) {
1128                 /* size = vtable->klass->instance_size; */
1129                 mono_mb_emit_ldarg (mb, 0);
1130                 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoVTable, klass));
1131                 mono_mb_emit_byte (mb, CEE_ADD);
1132                 mono_mb_emit_byte (mb, CEE_LDIND_I);
1133                 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoClass, instance_size));
1134                 mono_mb_emit_byte (mb, CEE_ADD);
1135                 /* FIXME: assert instance_size stays a 4 byte integer */
1136                 mono_mb_emit_byte (mb, CEE_LDIND_U4);
1137                 mono_mb_emit_byte (mb, CEE_CONV_I);
1138                 mono_mb_emit_stloc (mb, size_var);
1139         } else if (atype == ATYPE_VECTOR) {
1140                 MonoExceptionClause *clause;
1141                 int pos, pos_leave, pos_error;
1142                 MonoClass *oom_exc_class;
1143                 MonoMethod *ctor;
1144
1145                 /*
1146                  * n > MONO_ARRAY_MAX_INDEX => OutOfMemoryException
1147                  * n < 0                    => OverflowException
1148                  *
1149                  * We can do an unsigned comparison to catch both cases, then in the error
1150                  * case compare signed to distinguish between them.
1151                  */
1152                 mono_mb_emit_ldarg (mb, 1);
1153                 mono_mb_emit_icon (mb, MONO_ARRAY_MAX_INDEX);
1154                 mono_mb_emit_byte (mb, CEE_CONV_U);
1155                 pos = mono_mb_emit_short_branch (mb, CEE_BLE_UN_S);
1156
1157                 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1158                 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1159                 mono_mb_emit_ldarg (mb, 1);
1160                 mono_mb_emit_icon (mb, 0);
1161                 pos_error = mono_mb_emit_short_branch (mb, CEE_BLT_S);
1162                 mono_mb_emit_exception (mb, "OutOfMemoryException", NULL);
1163                 mono_mb_patch_short_branch (mb, pos_error);
1164                 mono_mb_emit_exception (mb, "OverflowException", NULL);
1165
1166                 mono_mb_patch_short_branch (mb, pos);
1167
1168                 clause = mono_image_alloc0 (mono_defaults.corlib, sizeof (MonoExceptionClause));
1169                 clause->try_offset = mono_mb_get_label (mb);
1170
1171                 /* vtable->klass->sizes.element_size */
1172                 mono_mb_emit_ldarg (mb, 0);
1173                 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoVTable, klass));
1174                 mono_mb_emit_byte (mb, CEE_ADD);
1175                 mono_mb_emit_byte (mb, CEE_LDIND_I);
1176                 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoClass, sizes));
1177                 mono_mb_emit_byte (mb, CEE_ADD);
1178                 mono_mb_emit_byte (mb, CEE_LDIND_U4);
1179                 mono_mb_emit_byte (mb, CEE_CONV_I);
1180
1181                 /* * n */
1182                 mono_mb_emit_ldarg (mb, 1);
1183                 mono_mb_emit_byte (mb, CEE_MUL_OVF_UN);
1184                 /* + sizeof (MonoArray) */
1185                 mono_mb_emit_icon (mb, sizeof (MonoArray));
1186                 mono_mb_emit_byte (mb, CEE_ADD_OVF_UN);
1187                 mono_mb_emit_stloc (mb, size_var);
1188
1189                 pos_leave = mono_mb_emit_branch (mb, CEE_LEAVE);
1190
1191                 /* catch */
1192                 clause->flags = MONO_EXCEPTION_CLAUSE_NONE;
1193                 clause->try_len = mono_mb_get_pos (mb) - clause->try_offset;
1194                 clause->data.catch_class = mono_class_from_name (mono_defaults.corlib,
1195                                 "System", "OverflowException");
1196                 g_assert (clause->data.catch_class);
1197                 clause->handler_offset = mono_mb_get_label (mb);
1198
1199                 oom_exc_class = mono_class_from_name (mono_defaults.corlib,
1200                                 "System", "OutOfMemoryException");
1201                 g_assert (oom_exc_class);
1202                 ctor = mono_class_get_method_from_name (oom_exc_class, ".ctor", 0);
1203                 g_assert (ctor);
1204
1205                 mono_mb_emit_byte (mb, CEE_POP);
1206                 mono_mb_emit_op (mb, CEE_NEWOBJ, ctor);
1207                 mono_mb_emit_byte (mb, CEE_THROW);
1208
1209                 clause->handler_len = mono_mb_get_pos (mb) - clause->handler_offset;
1210                 mono_mb_set_clauses (mb, 1, clause);
1211                 mono_mb_patch_branch (mb, pos_leave);
1212                 /* end catch */
1213         } else if (atype == ATYPE_STRING) {
1214                 int pos;
1215
1216                 /*
1217                  * a string allocator method takes the args: (vtable, len)
1218                  *
1219                  * bytes = offsetof (MonoString, chars) + ((len + 1) * 2)
1220                  *
1221                  * condition:
1222                  *
1223                  * bytes <= INT32_MAX - (SGEN_ALLOC_ALIGN - 1)
1224                  *
1225                  * therefore:
1226                  *
1227                  * offsetof (MonoString, chars) + ((len + 1) * 2) <= INT32_MAX - (SGEN_ALLOC_ALIGN - 1)
1228                  * len <= (INT32_MAX - (SGEN_ALLOC_ALIGN - 1) - offsetof (MonoString, chars)) / 2 - 1
1229                  */
1230                 mono_mb_emit_ldarg (mb, 1);
1231                 mono_mb_emit_icon (mb, (INT32_MAX - (SGEN_ALLOC_ALIGN - 1) - MONO_STRUCT_OFFSET (MonoString, chars)) / 2 - 1);
1232                 pos = mono_mb_emit_short_branch (mb, MONO_CEE_BLE_UN_S);
1233
1234                 mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1235                 mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1236                 mono_mb_emit_exception (mb, "OutOfMemoryException", NULL);
1237                 mono_mb_patch_short_branch (mb, pos);
1238
1239                 mono_mb_emit_ldarg (mb, 1);
1240                 mono_mb_emit_icon (mb, 1);
1241                 mono_mb_emit_byte (mb, MONO_CEE_SHL);
1242                 //WE manually fold the above + 2 here
1243                 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoString, chars) + 2);
1244                 mono_mb_emit_byte (mb, CEE_ADD);
1245                 mono_mb_emit_stloc (mb, size_var);
1246         } else {
1247                 g_assert_not_reached ();
1248         }
1249
1250         if (atype != ATYPE_SMALL) {
1251                 /* size += ALLOC_ALIGN - 1; */
1252                 mono_mb_emit_ldloc (mb, size_var);
1253                 mono_mb_emit_icon (mb, SGEN_ALLOC_ALIGN - 1);
1254                 mono_mb_emit_byte (mb, CEE_ADD);
1255                 /* size &= ~(ALLOC_ALIGN - 1); */
1256                 mono_mb_emit_icon (mb, ~(SGEN_ALLOC_ALIGN - 1));
1257                 mono_mb_emit_byte (mb, CEE_AND);
1258                 mono_mb_emit_stloc (mb, size_var);
1259         }
1260
1261         /* if (size > MAX_SMALL_OBJ_SIZE) goto slowpath */
1262         if (atype != ATYPE_SMALL) {
1263                 mono_mb_emit_ldloc (mb, size_var);
1264                 mono_mb_emit_icon (mb, SGEN_MAX_SMALL_OBJ_SIZE);
1265                 max_size_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BGT_UN_S);
1266         }
1267
1268         /*
1269          * We need to modify tlab_next, but the JIT only supports reading, so we read
1270          * another tls var holding its address instead.
1271          */
1272
1273         /* tlab_next_addr (local) = tlab_next_addr (TLS var) */
1274         tlab_next_addr_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1275         EMIT_TLS_ACCESS_NEXT_ADDR (mb);
1276         mono_mb_emit_stloc (mb, tlab_next_addr_var);
1277
1278         /* p = (void**)tlab_next; */
1279         p_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1280         mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1281         mono_mb_emit_byte (mb, CEE_LDIND_I);
1282         mono_mb_emit_stloc (mb, p_var);
1283         
1284         /* new_next = (char*)p + size; */
1285         new_next_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
1286         mono_mb_emit_ldloc (mb, p_var);
1287         mono_mb_emit_ldloc (mb, size_var);
1288         mono_mb_emit_byte (mb, CEE_CONV_I);
1289         mono_mb_emit_byte (mb, CEE_ADD);
1290         mono_mb_emit_stloc (mb, new_next_var);
1291
1292         /* if (G_LIKELY (new_next < tlab_temp_end)) */
1293         mono_mb_emit_ldloc (mb, new_next_var);
1294         EMIT_TLS_ACCESS_TEMP_END (mb);
1295         slowpath_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLT_UN_S);
1296
1297         /* Slowpath */
1298         if (atype != ATYPE_SMALL)
1299                 mono_mb_patch_short_branch (mb, max_size_branch);
1300
1301         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1302         mono_mb_emit_byte (mb, CEE_MONO_NOT_TAKEN);
1303
1304         /* FIXME: mono_gc_alloc_obj takes a 'size_t' as an argument, not an int32 */
1305         mono_mb_emit_ldarg (mb, 0);
1306         mono_mb_emit_ldloc (mb, size_var);
1307         if (atype == ATYPE_NORMAL || atype == ATYPE_SMALL) {
1308                 mono_mb_emit_icall (mb, mono_gc_alloc_obj);
1309         } else if (atype == ATYPE_VECTOR) {
1310                 mono_mb_emit_ldarg (mb, 1);
1311                 mono_mb_emit_icall (mb, mono_gc_alloc_vector);
1312         } else if (atype == ATYPE_STRING) {
1313                 mono_mb_emit_ldarg (mb, 1);
1314                 mono_mb_emit_icall (mb, mono_gc_alloc_string);
1315         } else {
1316                 g_assert_not_reached ();
1317         }
1318         mono_mb_emit_byte (mb, CEE_RET);
1319
1320         /* Fastpath */
1321         mono_mb_patch_short_branch (mb, slowpath_branch);
1322
1323         /* FIXME: Memory barrier */
1324
1325         /* tlab_next = new_next */
1326         mono_mb_emit_ldloc (mb, tlab_next_addr_var);
1327         mono_mb_emit_ldloc (mb, new_next_var);
1328         mono_mb_emit_byte (mb, CEE_STIND_I);
1329
1330         /*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. */
1331         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1332         mono_mb_emit_byte (mb, CEE_MONO_MEMORY_BARRIER);
1333         mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_REL);
1334
1335         /* *p = vtable; */
1336         mono_mb_emit_ldloc (mb, p_var);
1337         mono_mb_emit_ldarg (mb, 0);
1338         mono_mb_emit_byte (mb, CEE_STIND_I);
1339
1340         if (atype == ATYPE_VECTOR) {
1341                 /* arr->max_length = max_length; */
1342                 mono_mb_emit_ldloc (mb, p_var);
1343                 mono_mb_emit_ldflda (mb, MONO_STRUCT_OFFSET (MonoArray, max_length));
1344                 mono_mb_emit_ldarg (mb, 1);
1345 #ifdef MONO_BIG_ARRAYS
1346                 mono_mb_emit_byte (mb, CEE_STIND_I);
1347 #else
1348                 mono_mb_emit_byte (mb, CEE_STIND_I4);
1349 #endif
1350         } else  if (atype == ATYPE_STRING) {
1351                 /* need to set length and clear the last char */
1352                 /* s->length = len; */
1353                 mono_mb_emit_ldloc (mb, p_var);
1354                 mono_mb_emit_icon (mb, MONO_STRUCT_OFFSET (MonoString, length));
1355                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
1356                 mono_mb_emit_ldarg (mb, 1);
1357                 mono_mb_emit_byte (mb, MONO_CEE_STIND_I4);
1358                 /* s->chars [len] = 0; */
1359                 mono_mb_emit_ldloc (mb, p_var);
1360                 mono_mb_emit_ldloc (mb, size_var);
1361                 mono_mb_emit_icon (mb, 2);
1362                 mono_mb_emit_byte (mb, MONO_CEE_SUB);
1363                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
1364                 mono_mb_emit_icon (mb, 0);
1365                 mono_mb_emit_byte (mb, MONO_CEE_STIND_I2);
1366         }
1367
1368         /*
1369         We must make sure both vtable and max_length are globaly visible before returning to managed land.
1370         */
1371         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
1372         mono_mb_emit_byte (mb, CEE_MONO_MEMORY_BARRIER);
1373         mono_mb_emit_i4 (mb, MONO_MEMORY_BARRIER_REL);
1374
1375         /* return p */
1376         mono_mb_emit_ldloc (mb, p_var);
1377
1378  done:
1379         mono_mb_emit_byte (mb, CEE_RET);
1380 #endif
1381
1382         res = mono_mb_create_method (mb, csig, 8);
1383         mono_mb_free (mb);
1384         mono_method_get_header (res)->init_locals = FALSE;
1385
1386         info = mono_image_alloc0 (mono_defaults.corlib, sizeof (AllocatorWrapperInfo));
1387         info->gc_name = "sgen";
1388         info->alloc_type = atype;
1389         mono_marshal_set_wrapper_info (res, info);
1390
1391         return res;
1392 }
1393 #endif
1394
1395 int
1396 mono_gc_get_aligned_size_for_allocator (int size)
1397 {
1398         int aligned_size = size;
1399         aligned_size += SGEN_ALLOC_ALIGN - 1;
1400         aligned_size &= ~(SGEN_ALLOC_ALIGN - 1);
1401         return aligned_size;
1402 }
1403
1404 /*
1405  * Generate an allocator method implementing the fast path of mono_gc_alloc_obj ().
1406  * The signature of the called method is:
1407  *      object allocate (MonoVTable *vtable)
1408  */
1409 MonoMethod*
1410 mono_gc_get_managed_allocator (MonoClass *klass, gboolean for_box, gboolean known_instance_size)
1411 {
1412 #ifdef MANAGED_ALLOCATION
1413         if (collect_before_allocs)
1414                 return NULL;
1415         if (!mono_runtime_has_tls_get ())
1416                 return NULL;
1417         if (klass->instance_size > tlab_size)
1418                 return NULL;
1419         if (known_instance_size && ALIGN_TO (klass->instance_size, SGEN_ALLOC_ALIGN) >= SGEN_MAX_SMALL_OBJ_SIZE)
1420                 return NULL;
1421         if (mono_class_has_finalizer (klass) || mono_class_is_marshalbyref (klass) || (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS))
1422                 return NULL;
1423         if (klass->rank)
1424                 return NULL;
1425         if (klass->byval_arg.type == MONO_TYPE_STRING)
1426                 return mono_gc_get_managed_allocator_by_type (ATYPE_STRING, FALSE);
1427         /* Generic classes have dynamic field and can go above MAX_SMALL_OBJ_SIZE. */
1428         if (known_instance_size)
1429                 return mono_gc_get_managed_allocator_by_type (ATYPE_SMALL, FALSE);
1430         else
1431                 return mono_gc_get_managed_allocator_by_type (ATYPE_NORMAL, FALSE);
1432 #else
1433         return NULL;
1434 #endif
1435 }
1436
1437 MonoMethod*
1438 mono_gc_get_managed_array_allocator (MonoClass *klass)
1439 {
1440 #ifdef MANAGED_ALLOCATION
1441         if (klass->rank != 1)
1442                 return NULL;
1443         if (!mono_runtime_has_tls_get ())
1444                 return NULL;
1445         if (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS)
1446                 return NULL;
1447         if (has_per_allocation_action)
1448                 return NULL;
1449         g_assert (!mono_class_has_finalizer (klass) && !mono_class_is_marshalbyref (klass));
1450
1451         return mono_gc_get_managed_allocator_by_type (ATYPE_VECTOR, FALSE);
1452 #else
1453         return NULL;
1454 #endif
1455 }
1456
1457 void
1458 sgen_set_use_managed_allocator (gboolean flag)
1459 {
1460         use_managed_allocator = flag;
1461 }
1462
1463 MonoMethod*
1464 mono_gc_get_managed_allocator_by_type (int atype, gboolean slowpath)
1465 {
1466 #ifdef MANAGED_ALLOCATION
1467         MonoMethod *res;
1468         MonoMethod **cache = slowpath ? slowpath_alloc_method_cache : alloc_method_cache;
1469
1470         if (!use_managed_allocator)
1471                 return NULL;
1472
1473         if (!mono_runtime_has_tls_get ())
1474                 return NULL;
1475
1476         res = cache [atype];
1477         if (res)
1478                 return res;
1479
1480         res = create_allocator (atype, slowpath);
1481         LOCK_GC;
1482         if (cache [atype]) {
1483                 mono_free_method (res);
1484                 res = cache [atype];
1485         } else {
1486                 mono_memory_barrier ();
1487                 cache [atype] = res;
1488         }
1489         UNLOCK_GC;
1490
1491         return res;
1492 #else
1493         return NULL;
1494 #endif
1495 }
1496
1497 guint32
1498 mono_gc_get_managed_allocator_types (void)
1499 {
1500         return ATYPE_NUM;
1501 }
1502
1503 gboolean
1504 sgen_is_managed_allocator (MonoMethod *method)
1505 {
1506         int i;
1507
1508         for (i = 0; i < ATYPE_NUM; ++i)
1509                 if (method == alloc_method_cache [i] || method == slowpath_alloc_method_cache [i])
1510                         return TRUE;
1511         return FALSE;
1512 }
1513
1514 gboolean
1515 sgen_has_managed_allocator (void)
1516 {
1517         int i;
1518
1519         for (i = 0; i < ATYPE_NUM; ++i)
1520                 if (alloc_method_cache [i] || slowpath_alloc_method_cache [i])
1521                         return TRUE;
1522         return FALSE;
1523 }
1524
1525 /*
1526  * Cardtable scanning
1527  */
1528
1529 #define MWORD_MASK (sizeof (mword) - 1)
1530
1531 static inline int
1532 find_card_offset (mword card)
1533 {
1534 /*XXX Use assembly as this generates some pretty bad code */
1535 #if defined(__i386__) && defined(__GNUC__)
1536         return  (__builtin_ffs (card) - 1) / 8;
1537 #elif defined(__x86_64__) && defined(__GNUC__)
1538         return (__builtin_ffsll (card) - 1) / 8;
1539 #elif defined(__s390x__)
1540         return (__builtin_ffsll (GUINT64_TO_LE(card)) - 1) / 8;
1541 #else
1542         int i;
1543         guint8 *ptr = (guint8 *) &card;
1544         for (i = 0; i < sizeof (mword); ++i) {
1545                 if (ptr[i])
1546                         return i;
1547         }
1548         return 0;
1549 #endif
1550 }
1551
1552 static guint8*
1553 find_next_card (guint8 *card_data, guint8 *end)
1554 {
1555         mword *cards, *cards_end;
1556         mword card;
1557
1558         while ((((mword)card_data) & MWORD_MASK) && card_data < end) {
1559                 if (*card_data)
1560                         return card_data;
1561                 ++card_data;
1562         }
1563
1564         if (card_data == end)
1565                 return end;
1566
1567         cards = (mword*)card_data;
1568         cards_end = (mword*)((mword)end & ~MWORD_MASK);
1569         while (cards < cards_end) {
1570                 card = *cards;
1571                 if (card)
1572                         return (guint8*)cards + find_card_offset (card);
1573                 ++cards;
1574         }
1575
1576         card_data = (guint8*)cards_end;
1577         while (card_data < end) {
1578                 if (*card_data)
1579                         return card_data;
1580                 ++card_data;
1581         }
1582
1583         return end;
1584 }
1585
1586 #define ARRAY_OBJ_INDEX(ptr,array,elem_size) (((char*)(ptr) - ((char*)(array) + G_STRUCT_OFFSET (MonoArray, vector))) / (elem_size))
1587
1588 gboolean
1589 sgen_client_cardtable_scan_object (GCObject *obj, mword block_obj_size, guint8 *cards, gboolean mod_union, ScanCopyContext ctx)
1590 {
1591         MonoVTable *vt = SGEN_LOAD_VTABLE (obj);
1592         MonoClass *klass = vt->klass;
1593
1594         SGEN_ASSERT (0, SGEN_VTABLE_HAS_REFERENCES (vt), "Why would we ever call this on reference-free objects?");
1595
1596         if (vt->rank) {
1597                 guint8 *card_data, *card_base;
1598                 guint8 *card_data_end;
1599                 char *obj_start = sgen_card_table_align_pointer (obj);
1600                 mword obj_size = sgen_client_par_object_get_size (vt, obj);
1601                 char *obj_end = (char*)obj + obj_size;
1602                 size_t card_count;
1603                 size_t extra_idx = 0;
1604
1605                 MonoArray *arr = (MonoArray*)obj;
1606                 mword desc = (mword)klass->element_class->gc_descr;
1607                 int elem_size = mono_array_element_size (klass);
1608
1609 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1610                 guint8 *overflow_scan_end = NULL;
1611 #endif
1612
1613 #ifdef SGEN_OBJECT_LAYOUT_STATISTICS
1614                 if (klass->element_class->valuetype)
1615                         sgen_object_layout_scanned_vtype_array ();
1616                 else
1617                         sgen_object_layout_scanned_ref_array ();
1618 #endif
1619
1620                 if (cards)
1621                         card_data = cards;
1622                 else
1623                         card_data = sgen_card_table_get_card_scan_address ((mword)obj);
1624
1625                 card_base = card_data;
1626                 card_count = sgen_card_table_number_of_cards_in_range ((mword)obj, obj_size);
1627                 card_data_end = card_data + card_count;
1628
1629
1630 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1631                 /*Check for overflow and if so, setup to scan in two steps*/
1632                 if (!cards && card_data_end >= SGEN_SHADOW_CARDTABLE_END) {
1633                         overflow_scan_end = sgen_shadow_cardtable + (card_data_end - SGEN_SHADOW_CARDTABLE_END);
1634                         card_data_end = SGEN_SHADOW_CARDTABLE_END;
1635                 }
1636
1637 LOOP_HEAD:
1638 #endif
1639
1640                 card_data = find_next_card (card_data, card_data_end);
1641                 for (; card_data < card_data_end; card_data = find_next_card (card_data + 1, card_data_end)) {
1642                         size_t index;
1643                         size_t idx = (card_data - card_base) + extra_idx;
1644                         char *start = (char*)(obj_start + idx * CARD_SIZE_IN_BYTES);
1645                         char *card_end = start + CARD_SIZE_IN_BYTES;
1646                         char *first_elem, *elem;
1647
1648                         HEAVY_STAT (++los_marked_cards);
1649
1650                         if (!cards)
1651                                 sgen_card_table_prepare_card_for_scanning (card_data);
1652
1653                         card_end = MIN (card_end, obj_end);
1654
1655                         if (start <= (char*)arr->vector)
1656                                 index = 0;
1657                         else
1658                                 index = ARRAY_OBJ_INDEX (start, obj, elem_size);
1659
1660                         elem = first_elem = (char*)mono_array_addr_with_size_fast ((MonoArray*)obj, elem_size, index);
1661                         if (klass->element_class->valuetype) {
1662                                 ScanVTypeFunc scan_vtype_func = ctx.ops->scan_vtype;
1663
1664                                 for (; elem < card_end; elem += elem_size)
1665                                         scan_vtype_func (obj, elem, desc, ctx.queue BINARY_PROTOCOL_ARG (elem_size));
1666                         } else {
1667                                 CopyOrMarkObjectFunc copy_func = ctx.ops->copy_or_mark_object;
1668
1669                                 HEAVY_STAT (++los_array_cards);
1670                                 for (; elem < card_end; elem += SIZEOF_VOID_P) {
1671                                         gpointer new, old = *(gpointer*)elem;
1672                                         if ((mod_union && old) || G_UNLIKELY (sgen_ptr_in_nursery (old))) {
1673                                                 HEAVY_STAT (++los_array_remsets);
1674                                                 copy_func ((GCObject**)elem, ctx.queue);
1675                                                 new = *(gpointer*)elem;
1676                                                 if (G_UNLIKELY (sgen_ptr_in_nursery (new)))
1677                                                         sgen_add_to_global_remset (elem, new);
1678                                         }
1679                                 }
1680                         }
1681
1682                         binary_protocol_card_scan (first_elem, elem - first_elem);
1683                 }
1684
1685 #ifdef SGEN_HAVE_OVERLAPPING_CARDS
1686                 if (overflow_scan_end) {
1687                         extra_idx = card_data - card_base;
1688                         card_base = card_data = sgen_shadow_cardtable;
1689                         card_data_end = overflow_scan_end;
1690                         overflow_scan_end = NULL;
1691                         goto LOOP_HEAD;
1692                 }
1693 #endif
1694                 return TRUE;
1695         }
1696
1697         return FALSE;
1698 }
1699
1700 /*
1701  * Array and string allocation
1702  */
1703
1704 void*
1705 mono_gc_alloc_vector (MonoVTable *vtable, size_t size, uintptr_t max_length)
1706 {
1707         MonoArray *arr;
1708         TLAB_ACCESS_INIT;
1709
1710         if (!SGEN_CAN_ALIGN_UP (size))
1711                 return NULL;
1712
1713 #ifndef DISABLE_CRITICAL_REGION
1714         ENTER_CRITICAL_REGION;
1715         arr = sgen_try_alloc_obj_nolock (vtable, size);
1716         if (arr) {
1717                 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1718                 arr->max_length = (mono_array_size_t)max_length;
1719                 EXIT_CRITICAL_REGION;
1720                 goto done;
1721         }
1722         EXIT_CRITICAL_REGION;
1723 #endif
1724
1725         LOCK_GC;
1726
1727         arr = sgen_alloc_obj_nolock (vtable, size);
1728         if (G_UNLIKELY (!arr)) {
1729                 UNLOCK_GC;
1730                 return mono_gc_out_of_memory (size);
1731         }
1732
1733         arr->max_length = (mono_array_size_t)max_length;
1734
1735         UNLOCK_GC;
1736
1737  done:
1738         if (G_UNLIKELY (alloc_events))
1739                 mono_profiler_allocation (&arr->obj);
1740
1741         SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size (vtable, (GCObject*)arr)), "Vector has incorrect size.");
1742         return arr;
1743 }
1744
1745 void*
1746 mono_gc_alloc_array (MonoVTable *vtable, size_t size, uintptr_t max_length, uintptr_t bounds_size)
1747 {
1748         MonoArray *arr;
1749         MonoArrayBounds *bounds;
1750         TLAB_ACCESS_INIT;
1751
1752         if (!SGEN_CAN_ALIGN_UP (size))
1753                 return NULL;
1754
1755 #ifndef DISABLE_CRITICAL_REGION
1756         ENTER_CRITICAL_REGION;
1757         arr = sgen_try_alloc_obj_nolock (vtable, size);
1758         if (arr) {
1759                 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1760                 arr->max_length = (mono_array_size_t)max_length;
1761
1762                 bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1763                 arr->bounds = bounds;
1764                 EXIT_CRITICAL_REGION;
1765                 goto done;
1766         }
1767         EXIT_CRITICAL_REGION;
1768 #endif
1769
1770         LOCK_GC;
1771
1772         arr = sgen_alloc_obj_nolock (vtable, size);
1773         if (G_UNLIKELY (!arr)) {
1774                 UNLOCK_GC;
1775                 return mono_gc_out_of_memory (size);
1776         }
1777
1778         arr->max_length = (mono_array_size_t)max_length;
1779
1780         bounds = (MonoArrayBounds*)((char*)arr + size - bounds_size);
1781         arr->bounds = bounds;
1782
1783         UNLOCK_GC;
1784
1785  done:
1786         if (G_UNLIKELY (alloc_events))
1787                 mono_profiler_allocation (&arr->obj);
1788
1789         SGEN_ASSERT (6, SGEN_ALIGN_UP (size) == SGEN_ALIGN_UP (sgen_client_par_object_get_size (vtable, (GCObject*)arr)), "Array has incorrect size.");
1790         return arr;
1791 }
1792
1793 void*
1794 mono_gc_alloc_string (MonoVTable *vtable, size_t size, gint32 len)
1795 {
1796         MonoString *str;
1797         TLAB_ACCESS_INIT;
1798
1799         if (!SGEN_CAN_ALIGN_UP (size))
1800                 return NULL;
1801
1802 #ifndef DISABLE_CRITICAL_REGION
1803         ENTER_CRITICAL_REGION;
1804         str = sgen_try_alloc_obj_nolock (vtable, size);
1805         if (str) {
1806                 /*This doesn't require fencing since EXIT_CRITICAL_REGION already does it for us*/
1807                 str->length = len;
1808                 EXIT_CRITICAL_REGION;
1809                 goto done;
1810         }
1811         EXIT_CRITICAL_REGION;
1812 #endif
1813
1814         LOCK_GC;
1815
1816         str = sgen_alloc_obj_nolock (vtable, size);
1817         if (G_UNLIKELY (!str)) {
1818                 UNLOCK_GC;
1819                 return mono_gc_out_of_memory (size);
1820         }
1821
1822         str->length = len;
1823
1824         UNLOCK_GC;
1825
1826  done:
1827         if (G_UNLIKELY (alloc_events))
1828                 mono_profiler_allocation (&str->object);
1829
1830         return str;
1831 }
1832
1833 /*
1834  * Strings
1835  */
1836
1837 void
1838 mono_gc_set_string_length (MonoString *str, gint32 new_length)
1839 {
1840         mono_unichar2 *new_end = str->chars + new_length;
1841
1842         /* zero the discarded string. This null-delimits the string and allows
1843          * the space to be reclaimed by SGen. */
1844
1845         if (nursery_canaries_enabled () && sgen_ptr_in_nursery (str)) {
1846                 CHECK_CANARY_FOR_OBJECT ((GCObject*)str);
1847                 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2) + CANARY_SIZE);
1848                 memcpy (new_end + 1 , CANARY_STRING, CANARY_SIZE);
1849         } else {
1850                 memset (new_end, 0, (str->length - new_length + 1) * sizeof (mono_unichar2));
1851         }
1852
1853         str->length = new_length;
1854 }
1855
1856 /*
1857  * Profiling
1858  */
1859
1860 #define GC_ROOT_NUM 32
1861 typedef struct {
1862         int count;              /* must be the first field */
1863         void *objects [GC_ROOT_NUM];
1864         int root_types [GC_ROOT_NUM];
1865         uintptr_t extra_info [GC_ROOT_NUM];
1866 } GCRootReport;
1867
1868 static void
1869 notify_gc_roots (GCRootReport *report)
1870 {
1871         if (!report->count)
1872                 return;
1873         mono_profiler_gc_roots (report->count, report->objects, report->root_types, report->extra_info);
1874         report->count = 0;
1875 }
1876
1877 static void
1878 add_profile_gc_root (GCRootReport *report, void *object, int rtype, uintptr_t extra_info)
1879 {
1880         if (report->count == GC_ROOT_NUM)
1881                 notify_gc_roots (report);
1882         report->objects [report->count] = object;
1883         report->root_types [report->count] = rtype;
1884         report->extra_info [report->count++] = (uintptr_t)SGEN_LOAD_VTABLE (object)->klass;
1885 }
1886
1887 void
1888 sgen_client_nursery_objects_pinned (void **definitely_pinned, int count)
1889 {
1890         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS) {
1891                 GCRootReport report;
1892                 int idx;
1893                 report.count = 0;
1894                 for (idx = 0; idx < count; ++idx)
1895                         add_profile_gc_root (&report, definitely_pinned [idx], MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
1896                 notify_gc_roots (&report);
1897         }
1898 }
1899
1900 static void
1901 report_finalizer_roots_from_queue (SgenPointerQueue *queue)
1902 {
1903         GCRootReport report;
1904         size_t i;
1905
1906         report.count = 0;
1907         for (i = 0; i < queue->next_slot; ++i) {
1908                 void *obj = queue->data [i];
1909                 if (!obj)
1910                         continue;
1911                 add_profile_gc_root (&report, obj, MONO_PROFILE_GC_ROOT_FINALIZER, 0);
1912         }
1913         notify_gc_roots (&report);
1914 }
1915
1916 static void
1917 report_finalizer_roots (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
1918 {
1919         report_finalizer_roots_from_queue (fin_ready_queue);
1920         report_finalizer_roots_from_queue (critical_fin_queue);
1921 }
1922
1923 static GCRootReport *root_report;
1924
1925 static void
1926 single_arg_report_root (void **obj, void *gc_data)
1927 {
1928         if (*obj)
1929                 add_profile_gc_root (root_report, *obj, MONO_PROFILE_GC_ROOT_OTHER, 0);
1930 }
1931
1932 static void
1933 precisely_report_roots_from (GCRootReport *report, void** start_root, void** end_root, mword desc)
1934 {
1935         switch (desc & ROOT_DESC_TYPE_MASK) {
1936         case ROOT_DESC_BITMAP:
1937                 desc >>= ROOT_DESC_TYPE_SHIFT;
1938                 while (desc) {
1939                         if ((desc & 1) && *start_root) {
1940                                 add_profile_gc_root (report, *start_root, MONO_PROFILE_GC_ROOT_OTHER, 0);
1941                         }
1942                         desc >>= 1;
1943                         start_root++;
1944                 }
1945                 return;
1946         case ROOT_DESC_COMPLEX: {
1947                 gsize *bitmap_data = sgen_get_complex_descriptor_bitmap (desc);
1948                 gsize bwords = (*bitmap_data) - 1;
1949                 void **start_run = start_root;
1950                 bitmap_data++;
1951                 while (bwords-- > 0) {
1952                         gsize bmap = *bitmap_data++;
1953                         void **objptr = start_run;
1954                         while (bmap) {
1955                                 if ((bmap & 1) && *objptr) {
1956                                         add_profile_gc_root (report, *objptr, MONO_PROFILE_GC_ROOT_OTHER, 0);
1957                                 }
1958                                 bmap >>= 1;
1959                                 ++objptr;
1960                         }
1961                         start_run += GC_BITS_PER_WORD;
1962                 }
1963                 break;
1964         }
1965         case ROOT_DESC_USER: {
1966                 MonoGCRootMarkFunc marker = (MonoGCRootMarkFunc)sgen_get_user_descriptor_func (desc);
1967                 root_report = report;
1968                 marker (start_root, single_arg_report_root, NULL);
1969                 break;
1970         }
1971         case ROOT_DESC_RUN_LEN:
1972                 g_assert_not_reached ();
1973         default:
1974                 g_assert_not_reached ();
1975         }
1976 }
1977
1978 static void
1979 report_registered_roots_by_type (int root_type)
1980 {
1981         GCRootReport report;
1982         void **start_root;
1983         RootRecord *root;
1984         report.count = 0;
1985         SGEN_HASH_TABLE_FOREACH (&roots_hash [root_type], start_root, root) {
1986                 SGEN_LOG (6, "Precise root scan %p-%p (desc: %p)", start_root, root->end_root, (void*)root->root_desc);
1987                 precisely_report_roots_from (&report, start_root, (void**)root->end_root, root->root_desc);
1988         } SGEN_HASH_TABLE_FOREACH_END;
1989         notify_gc_roots (&report);
1990 }
1991
1992 static void
1993 report_registered_roots (void)
1994 {
1995         report_registered_roots_by_type (ROOT_TYPE_NORMAL);
1996         report_registered_roots_by_type (ROOT_TYPE_WBARRIER);
1997 }
1998
1999 void
2000 sgen_client_collecting_minor (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
2001 {
2002         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2003                 report_registered_roots ();
2004         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2005                 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
2006 }
2007
2008 static GCRootReport major_root_report;
2009 static gboolean profile_roots;
2010
2011 void
2012 sgen_client_collecting_major_1 (void)
2013 {
2014         profile_roots = mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS;
2015         memset (&major_root_report, 0, sizeof (GCRootReport));
2016 }
2017
2018 void
2019 sgen_client_pinned_los_object (GCObject *obj)
2020 {
2021         if (profile_roots)
2022                 add_profile_gc_root (&major_root_report, (char*)obj, MONO_PROFILE_GC_ROOT_PINNING | MONO_PROFILE_GC_ROOT_MISC, 0);
2023 }
2024
2025 void
2026 sgen_client_collecting_major_2 (void)
2027 {
2028         if (profile_roots)
2029                 notify_gc_roots (&major_root_report);
2030
2031         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2032                 report_registered_roots ();
2033 }
2034
2035 void
2036 sgen_client_collecting_major_3 (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue)
2037 {
2038         if (mono_profiler_get_events () & MONO_PROFILE_GC_ROOTS)
2039                 report_finalizer_roots (fin_ready_queue, critical_fin_queue);
2040 }
2041
2042 #define MOVED_OBJECTS_NUM 64
2043 static void *moved_objects [MOVED_OBJECTS_NUM];
2044 static int moved_objects_idx = 0;
2045
2046 void
2047 mono_sgen_register_moved_object (void *obj, void *destination)
2048 {
2049         g_assert (mono_profiler_events & MONO_PROFILE_GC_MOVES);
2050
2051         if (moved_objects_idx == MOVED_OBJECTS_NUM) {
2052                 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2053                 moved_objects_idx = 0;
2054         }
2055         moved_objects [moved_objects_idx++] = obj;
2056         moved_objects [moved_objects_idx++] = destination;
2057 }
2058
2059 void
2060 mono_sgen_gc_event_moves (void)
2061 {
2062         if (moved_objects_idx) {
2063                 mono_profiler_gc_moves (moved_objects, moved_objects_idx);
2064                 moved_objects_idx = 0;
2065         }
2066 }
2067
2068 /*
2069  * Heap walking
2070  */
2071
2072 #define REFS_SIZE 128
2073 typedef struct {
2074         void *data;
2075         MonoGCReferences callback;
2076         int flags;
2077         int count;
2078         int called;
2079         MonoObject *refs [REFS_SIZE];
2080         uintptr_t offsets [REFS_SIZE];
2081 } HeapWalkInfo;
2082
2083 #undef HANDLE_PTR
2084 #define HANDLE_PTR(ptr,obj)     do {    \
2085                 if (*(ptr)) {   \
2086                         if (hwi->count == REFS_SIZE) {  \
2087                                 hwi->callback ((MonoObject*)start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);    \
2088                                 hwi->count = 0; \
2089                                 hwi->called = 1;        \
2090                         }       \
2091                         hwi->offsets [hwi->count] = (char*)(ptr)-(char*)start;  \
2092                         hwi->refs [hwi->count++] = *(ptr);      \
2093                 }       \
2094         } while (0)
2095
2096 static void
2097 collect_references (HeapWalkInfo *hwi, GCObject *obj, size_t size)
2098 {
2099         char *start = (char*)obj;
2100         mword desc = sgen_obj_get_descriptor (obj);
2101
2102 #include "sgen/sgen-scan-object.h"
2103 }
2104
2105 static void
2106 walk_references (GCObject *start, size_t size, void *data)
2107 {
2108         HeapWalkInfo *hwi = data;
2109         hwi->called = 0;
2110         hwi->count = 0;
2111         collect_references (hwi, start, size);
2112         if (hwi->count || !hwi->called)
2113                 hwi->callback (start, mono_object_class (start), hwi->called? 0: size, hwi->count, hwi->refs, hwi->offsets, hwi->data);
2114 }
2115
2116 /**
2117  * mono_gc_walk_heap:
2118  * @flags: flags for future use
2119  * @callback: a function pointer called for each object in the heap
2120  * @data: a user data pointer that is passed to callback
2121  *
2122  * This function can be used to iterate over all the live objects in the heap:
2123  * for each object, @callback is invoked, providing info about the object's
2124  * location in memory, its class, its size and the objects it references.
2125  * For each referenced object it's offset from the object address is
2126  * reported in the offsets array.
2127  * The object references may be buffered, so the callback may be invoked
2128  * multiple times for the same object: in all but the first call, the size
2129  * argument will be zero.
2130  * Note that this function can be only called in the #MONO_GC_EVENT_PRE_START_WORLD
2131  * profiler event handler.
2132  *
2133  * Returns: a non-zero value if the GC doesn't support heap walking
2134  */
2135 int
2136 mono_gc_walk_heap (int flags, MonoGCReferences callback, void *data)
2137 {
2138         HeapWalkInfo hwi;
2139
2140         hwi.flags = flags;
2141         hwi.callback = callback;
2142         hwi.data = data;
2143
2144         sgen_clear_nursery_fragments ();
2145         sgen_scan_area_with_callback (nursery_section->data, nursery_section->end_data, walk_references, &hwi, FALSE);
2146
2147         major_collector.iterate_objects (ITERATE_OBJECTS_SWEEP_ALL, walk_references, &hwi);
2148         sgen_los_iterate_objects (walk_references, &hwi);
2149
2150         return 0;
2151 }
2152
2153 /*
2154  * Threads
2155  */
2156
2157 void
2158 mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks)
2159 {
2160         gc_callbacks = *callbacks;
2161 }
2162
2163 MonoGCCallbacks *
2164 mono_gc_get_gc_callbacks ()
2165 {
2166         return &gc_callbacks;
2167 }
2168
2169 void
2170 sgen_client_thread_register (SgenThreadInfo* info, void *stack_bottom_fallback)
2171 {
2172         size_t stsize = 0;
2173         guint8 *staddr = NULL;
2174
2175 #ifndef HAVE_KW_THREAD
2176         g_assert (!mono_native_tls_get_value (thread_info_key));
2177         mono_native_tls_set_value (thread_info_key, info);
2178 #else
2179         sgen_thread_info = info;
2180 #endif
2181
2182         info->client_info.skip = 0;
2183         info->client_info.stopped_ip = NULL;
2184         info->client_info.stopped_domain = NULL;
2185
2186         info->client_info.stack_start = NULL;
2187
2188 #ifdef SGEN_POSIX_STW
2189         info->client_info.stop_count = -1;
2190         info->client_info.signal = 0;
2191 #endif
2192
2193         /* On win32, stack_start_limit should be 0, since the stack can grow dynamically */
2194         mono_thread_info_get_stack_bounds (&staddr, &stsize);
2195         if (staddr) {
2196 #ifndef HOST_WIN32
2197                 info->client_info.stack_start_limit = staddr;
2198 #endif
2199                 info->client_info.stack_end = staddr + stsize;
2200         } else {
2201                 gsize stack_bottom = (gsize)stack_bottom_fallback;
2202                 stack_bottom += 4095;
2203                 stack_bottom &= ~4095;
2204                 info->client_info.stack_end = (char*)stack_bottom;
2205         }
2206
2207 #ifdef USE_MONO_CTX
2208         memset (&info->client_info.ctx, 0, sizeof (MonoContext));
2209 #else
2210         memset (&info->client_info.regs, 0, sizeof (info->client_info.regs));
2211 #endif
2212
2213         if (mono_gc_get_gc_callbacks ()->thread_attach_func)
2214                 info->client_info.runtime_data = mono_gc_get_gc_callbacks ()->thread_attach_func ();
2215
2216         binary_protocol_thread_register ((gpointer)mono_thread_info_get_tid (info));
2217
2218         SGEN_LOG (3, "registered thread %p (%p) stack end %p", info, (gpointer)mono_thread_info_get_tid (info), info->client_info.stack_end);
2219 }
2220
2221 void
2222 sgen_client_thread_unregister (SgenThreadInfo *p)
2223 {
2224         MonoNativeThreadId tid;
2225
2226 #ifndef HAVE_KW_THREAD
2227         mono_native_tls_set_value (thread_info_key, NULL);
2228 #else
2229         sgen_thread_info = NULL;
2230 #endif
2231
2232         tid = mono_thread_info_get_tid (p);
2233
2234         if (p->client_info.info.runtime_thread)
2235                 mono_threads_add_joinable_thread ((gpointer)tid);
2236
2237         if (mono_gc_get_gc_callbacks ()->thread_detach_func) {
2238                 mono_gc_get_gc_callbacks ()->thread_detach_func (p->client_info.runtime_data);
2239                 p->client_info.runtime_data = NULL;
2240         }
2241
2242         binary_protocol_thread_unregister ((gpointer)tid);
2243         SGEN_LOG (3, "unregister thread %p (%p)", p, (gpointer)tid);
2244 }
2245
2246 void
2247 mono_gc_set_skip_thread (gboolean skip)
2248 {
2249         SgenThreadInfo *info = mono_thread_info_current ();
2250
2251         LOCK_GC;
2252         info->client_info.gc_disabled = skip;
2253         UNLOCK_GC;
2254 }
2255
2256 static gboolean
2257 is_critical_method (MonoMethod *method)
2258 {
2259         return mono_runtime_is_critical_method (method) || sgen_is_critical_method (method);
2260 }
2261
2262 static gboolean
2263 thread_in_critical_region (SgenThreadInfo *info)
2264 {
2265         return info->client_info.in_critical_region;
2266 }
2267
2268 static void
2269 sgen_thread_attach (SgenThreadInfo *info)
2270 {
2271         if (mono_gc_get_gc_callbacks ()->thread_attach_func && !info->client_info.runtime_data)
2272                 info->client_info.runtime_data = mono_gc_get_gc_callbacks ()->thread_attach_func ();
2273 }
2274
2275 static void
2276 sgen_thread_detach (SgenThreadInfo *p)
2277 {
2278         /* If a delegate is passed to native code and invoked on a thread we dont
2279          * know about, the jit will register it with mono_jit_thread_attach, but
2280          * we have no way of knowing when that thread goes away.  SGen has a TSD
2281          * so we assume that if the domain is still registered, we can detach
2282          * the thread
2283          */
2284         if (mono_domain_get ())
2285                 mono_thread_detach_internal (mono_thread_internal_current ());
2286 }
2287
2288 gboolean
2289 mono_gc_register_thread (void *baseptr)
2290 {
2291         return mono_thread_info_attach (baseptr) != NULL;
2292 }
2293
2294 gboolean
2295 mono_gc_is_gc_thread (void)
2296 {
2297         gboolean result;
2298         LOCK_GC;
2299         result = mono_thread_info_current () != NULL;
2300         UNLOCK_GC;
2301         return result;
2302 }
2303
2304 void
2305 sgen_client_thread_register_worker (void)
2306 {
2307         mono_thread_info_register_small_id ();
2308 }
2309
2310 /* Variables holding start/end nursery so it won't have to be passed at every call */
2311 static void *scan_area_arg_start, *scan_area_arg_end;
2312
2313 void
2314 mono_gc_conservatively_scan_area (void *start, void *end)
2315 {
2316         sgen_conservatively_pin_objects_from (start, end, scan_area_arg_start, scan_area_arg_end, PIN_TYPE_STACK);
2317 }
2318
2319 void*
2320 mono_gc_scan_object (void *obj, void *gc_data)
2321 {
2322         ScanCopyContext *ctx = gc_data;
2323         ctx->ops->copy_or_mark_object ((GCObject**)&obj, ctx->queue);
2324         return obj;
2325 }
2326
2327 /*
2328  * Mark from thread stacks and registers.
2329  */
2330 void
2331 sgen_client_scan_thread_data (void *start_nursery, void *end_nursery, gboolean precise, ScanCopyContext ctx)
2332 {
2333         SgenThreadInfo *info;
2334
2335         scan_area_arg_start = start_nursery;
2336         scan_area_arg_end = end_nursery;
2337
2338         FOREACH_THREAD (info) {
2339                 int skip_reason = 0;
2340                 if (info->client_info.skip) {
2341                         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);
2342                         skip_reason = 1;
2343                 } else if (info->client_info.gc_disabled) {
2344                         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);
2345                         skip_reason = 2;
2346                 } else if (!mono_thread_info_is_live (info)) {
2347                         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);
2348                         skip_reason = 3;
2349                 }
2350
2351                 binary_protocol_scan_stack ((gpointer)mono_thread_info_get_tid (info), info->client_info.stack_start, info->client_info.stack_end, skip_reason);
2352
2353                 if (skip_reason)
2354                         continue;
2355
2356                 g_assert (info->client_info.suspend_done);
2357                 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 ());
2358                 if (mono_gc_get_gc_callbacks ()->thread_mark_func && !conservative_stack_mark) {
2359                         mono_gc_get_gc_callbacks ()->thread_mark_func (info->client_info.runtime_data, info->client_info.stack_start, info->client_info.stack_end, precise, &ctx);
2360                 } else if (!precise) {
2361                         if (!conservative_stack_mark) {
2362                                 fprintf (stderr, "Precise stack mark not supported - disabling.\n");
2363                                 conservative_stack_mark = TRUE;
2364                         }
2365                         sgen_conservatively_pin_objects_from (info->client_info.stack_start, info->client_info.stack_end, start_nursery, end_nursery, PIN_TYPE_STACK);
2366                 }
2367
2368                 if (!precise) {
2369 #ifdef USE_MONO_CTX
2370                         sgen_conservatively_pin_objects_from ((void**)&info->client_info.ctx, (void**)&info->client_info.ctx + ARCH_NUM_REGS,
2371                                 start_nursery, end_nursery, PIN_TYPE_STACK);
2372 #else
2373                         sgen_conservatively_pin_objects_from ((void**)&info->client_info.regs, (void**)&info->client_info.regs + ARCH_NUM_REGS,
2374                                         start_nursery, end_nursery, PIN_TYPE_STACK);
2375 #endif
2376                 }
2377         } END_FOREACH_THREAD
2378 }
2379
2380 /*
2381  * mono_gc_set_stack_end:
2382  *
2383  *   Set the end of the current threads stack to STACK_END. The stack space between 
2384  * STACK_END and the real end of the threads stack will not be scanned during collections.
2385  */
2386 void
2387 mono_gc_set_stack_end (void *stack_end)
2388 {
2389         SgenThreadInfo *info;
2390
2391         LOCK_GC;
2392         info = mono_thread_info_current ();
2393         if (info) {
2394                 SGEN_ASSERT (0, stack_end < info->client_info.stack_end, "Can only lower stack end");
2395                 info->client_info.stack_end = stack_end;
2396         }
2397         UNLOCK_GC;
2398 }
2399
2400 /*
2401  * Roots
2402  */
2403
2404 int
2405 mono_gc_register_root (char *start, size_t size, void *descr)
2406 {
2407         return sgen_register_root (start, size, (SgenDescriptor)descr, descr ? ROOT_TYPE_NORMAL : ROOT_TYPE_PINNED);
2408 }
2409
2410 int
2411 mono_gc_register_root_wbarrier (char *start, size_t size, void *descr)
2412 {
2413         return sgen_register_root (start, size, (SgenDescriptor)descr, ROOT_TYPE_WBARRIER);
2414 }
2415
2416 void
2417 mono_gc_deregister_root (char* addr)
2418 {
2419         sgen_deregister_root (addr);
2420 }
2421
2422 /*
2423  * PThreads
2424  */
2425
2426 #ifndef HOST_WIN32
2427 int
2428 mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
2429 {
2430         return pthread_create (new_thread, attr, start_routine, arg);
2431 }
2432 #endif
2433
2434 /*
2435  * Miscellaneous
2436  */
2437
2438 void
2439 sgen_client_total_allocated_heap_changed (size_t allocated_heap)
2440 {
2441         mono_runtime_resource_check_limit (MONO_RESOURCE_GC_HEAP, allocated_heap);
2442 }
2443
2444 gboolean
2445 mono_gc_user_markers_supported (void)
2446 {
2447         return TRUE;
2448 }
2449
2450 gboolean
2451 mono_object_is_alive (MonoObject* o)
2452 {
2453         return TRUE;
2454 }
2455
2456 int
2457 mono_gc_get_generation (MonoObject *obj)
2458 {
2459         if (sgen_ptr_in_nursery (obj))
2460                 return 0;
2461         return 1;
2462 }
2463
2464 void
2465 mono_gc_enable_events (void)
2466 {
2467 }
2468
2469 const char *
2470 mono_gc_get_gc_name (void)
2471 {
2472         return "sgen";
2473 }
2474
2475 char*
2476 mono_gc_get_description (void)
2477 {
2478         return g_strdup ("sgen");
2479 }
2480
2481 void
2482 mono_gc_set_desktop_mode (void)
2483 {
2484 }
2485
2486 gboolean
2487 mono_gc_is_moving (void)
2488 {
2489         return TRUE;
2490 }
2491
2492 gboolean
2493 mono_gc_is_disabled (void)
2494 {
2495         return FALSE;
2496 }
2497
2498 #ifdef HOST_WIN32
2499 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved)
2500 {
2501         return TRUE;
2502 }
2503 #endif
2504
2505 int
2506 mono_gc_max_generation (void)
2507 {
2508         return 1;
2509 }
2510
2511 gboolean
2512 mono_gc_precise_stack_mark_enabled (void)
2513 {
2514         return !conservative_stack_mark;
2515 }
2516
2517 void
2518 mono_gc_collect (int generation)
2519 {
2520         sgen_gc_collect (generation);
2521 }
2522
2523 int
2524 mono_gc_collection_count (int generation)
2525 {
2526         return sgen_gc_collection_count (generation);
2527 }
2528
2529 int64_t
2530 mono_gc_get_used_size (void)
2531 {
2532         return (int64_t)sgen_gc_get_used_size ();
2533 }
2534
2535 int64_t
2536 mono_gc_get_heap_size (void)
2537 {
2538         return (int64_t)sgen_gc_get_total_heap_allocation ();
2539 }
2540
2541 void*
2542 mono_gc_make_root_descr_user (MonoGCRootMarkFunc marker)
2543 {
2544         return (void*)sgen_make_user_root_descriptor ((SgenUserRootMarkFunc)marker);
2545 }
2546
2547 void*
2548 mono_gc_make_descr_for_string (gsize *bitmap, int numbits)
2549 {
2550         return (void*)SGEN_DESC_STRING;
2551 }
2552
2553 void*
2554 mono_gc_get_nursery (int *shift_bits, size_t *size)
2555 {
2556         *size = sgen_nursery_size;
2557         *shift_bits = DEFAULT_NURSERY_BITS;
2558         return sgen_get_nursery_start ();
2559 }
2560
2561 int
2562 mono_gc_get_los_limit (void)
2563 {
2564         return SGEN_MAX_SMALL_OBJ_SIZE;
2565 }
2566
2567 void
2568 mono_gc_weak_link_add (void **link_addr, MonoObject *obj, gboolean track)
2569 {
2570         sgen_register_disappearing_link (obj, link_addr, track, FALSE);
2571 }
2572
2573 void
2574 mono_gc_weak_link_remove (void **link_addr, gboolean track)
2575 {
2576         sgen_register_disappearing_link (NULL, link_addr, track, FALSE);
2577 }
2578
2579 MonoObject*
2580 mono_gc_weak_link_get (void **link_addr)
2581 {
2582         return sgen_weak_link_get (link_addr);
2583 }
2584
2585 gboolean
2586 mono_gc_set_allow_synchronous_major (gboolean flag)
2587 {
2588         return sgen_set_allow_synchronous_major (flag);
2589 }
2590
2591 void*
2592 mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data)
2593 {
2594         void *result;
2595         LOCK_INTERRUPTION;
2596         result = func (data);
2597         UNLOCK_INTERRUPTION;
2598         return result;
2599 }
2600
2601 void
2602 mono_gc_register_altstack (gpointer stack, gint32 stack_size, gpointer altstack, gint32 altstack_size)
2603 {
2604         // FIXME:
2605 }
2606
2607 void
2608 sgen_client_out_of_memory (size_t size)
2609 {
2610         mono_gc_out_of_memory (size);
2611 }
2612
2613 guint8*
2614 mono_gc_get_card_table (int *shift_bits, gpointer *mask)
2615 {
2616         return sgen_get_card_table_configuration (shift_bits, mask);
2617 }
2618
2619 gboolean
2620 mono_gc_card_table_nursery_check (void)
2621 {
2622         return !sgen_get_major_collector ()->is_concurrent;
2623 }
2624
2625 /* Negative value to remove */
2626 void
2627 mono_gc_add_memory_pressure (gint64 value)
2628 {
2629         /* FIXME: Implement at some point? */
2630 }
2631
2632 /*
2633  * Logging
2634  */
2635
2636 void
2637 sgen_client_degraded_allocation (size_t size)
2638 {
2639         static int last_major_gc_warned = -1;
2640         static int num_degraded = 0;
2641
2642         if (last_major_gc_warned < gc_stats.major_gc_count) {
2643                 ++num_degraded;
2644                 if (num_degraded == 1 || num_degraded == 3)
2645                         mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Degraded allocation.  Consider increasing nursery-size if the warning persists.");
2646                 else if (num_degraded == 10)
2647                         mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "Warning: Repeated degraded allocation.  Consider increasing nursery-size.");
2648                 last_major_gc_warned = gc_stats.major_gc_count;
2649         }
2650 }
2651
2652 void
2653 sgen_client_log_timing (GGTimingInfo *info, mword last_major_num_sections, mword last_los_memory_usage)
2654 {
2655         SgenMajorCollector *major_collector = sgen_get_major_collector ();
2656         mword num_major_sections = major_collector->get_num_major_sections ();
2657         char full_timing_buff [1024];
2658         full_timing_buff [0] = '\0';
2659
2660         if (!info->is_overflow)
2661                 sprintf (full_timing_buff, "total %.2fms, bridge %.2fms", info->stw_time / 10000.0f, (int)info->bridge_time / 10000.0f);
2662         if (info->generation == GENERATION_OLD)
2663                 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "GC_MAJOR%s: (%s) pause %.2fms, %s major %dK/%dK los %dK/%dK",
2664                         info->is_overflow ? "_OVERFLOW" : "",
2665                         info->reason ? info->reason : "",
2666                         (int)info->total_time / 10000.0f,
2667                         full_timing_buff,
2668                         major_collector->section_size * num_major_sections / 1024,
2669                         major_collector->section_size * last_major_num_sections / 1024,
2670                         los_memory_usage / 1024,
2671                         last_los_memory_usage / 1024);
2672         else
2673                 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_GC, "GC_MINOR%s: (%s) pause %.2fms, %s promoted %dK major %dK los %dK",
2674                                 info->is_overflow ? "_OVERFLOW" : "",
2675                         info->reason ? info->reason : "",
2676                         (int)info->total_time / 10000.0f,
2677                         full_timing_buff,
2678                         (num_major_sections - last_major_num_sections) * major_collector->section_size / 1024,
2679                         major_collector->section_size * num_major_sections / 1024,
2680                         los_memory_usage / 1024);
2681 }
2682
2683 /*
2684  * Debugging
2685  */
2686
2687 const char*
2688 sgen_client_description_for_internal_mem_type (int type)
2689 {
2690         switch (type) {
2691         case INTERNAL_MEM_EPHEMERON_LINK: return "ephemeron-link";
2692         default:
2693                 return NULL;
2694         }
2695 }
2696
2697 void
2698 sgen_client_pre_collection_checks (void)
2699 {
2700         if (sgen_mono_xdomain_checks) {
2701                 sgen_clear_nursery_fragments ();
2702                 sgen_check_for_xdomain_refs ();
2703         }
2704 }
2705
2706 gboolean
2707 sgen_client_vtable_is_inited (MonoVTable *vt)
2708 {
2709         return vt->klass->inited;
2710 }
2711
2712 const char*
2713 sgen_client_vtable_get_namespace (MonoVTable *vt)
2714 {
2715         return vt->klass->name_space;
2716 }
2717
2718 const char*
2719 sgen_client_vtable_get_name (MonoVTable *vt)
2720 {
2721         return vt->klass->name;
2722 }
2723
2724 /*
2725  * Initialization
2726  */
2727
2728 void
2729 sgen_client_init (void)
2730 {
2731         int dummy;
2732         MonoThreadInfoCallbacks cb;
2733
2734         cb.thread_register = sgen_thread_register;
2735         cb.thread_detach = sgen_thread_detach;
2736         cb.thread_unregister = sgen_thread_unregister;
2737         cb.thread_attach = sgen_thread_attach;
2738         cb.mono_method_is_critical = (gpointer)is_critical_method;
2739         cb.mono_thread_in_critical_region = thread_in_critical_region;
2740
2741         mono_threads_init (&cb, sizeof (SgenThreadInfo));
2742
2743         ///* Keep this the default for now */
2744         /* Precise marking is broken on all supported targets. Disable until fixed. */
2745         conservative_stack_mark = TRUE;
2746
2747         sgen_register_fixed_internal_mem_type (INTERNAL_MEM_EPHEMERON_LINK, sizeof (EphemeronLinkNode));
2748
2749         mono_sgen_init_stw ();
2750
2751 #ifndef HAVE_KW_THREAD
2752         mono_native_tls_alloc (&thread_info_key, NULL);
2753 #if defined(__APPLE__) || defined (HOST_WIN32)
2754         /* 
2755          * CEE_MONO_TLS requires the tls offset, not the key, so the code below only works on darwin,
2756          * where the two are the same.
2757          */
2758         mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, thread_info_key);
2759 #endif
2760 #else
2761         {
2762                 int tls_offset = -1;
2763                 MONO_THREAD_VAR_OFFSET (sgen_thread_info, tls_offset);
2764                 mono_tls_key_set_offset (TLS_KEY_SGEN_THREAD_INFO, tls_offset);
2765         }
2766 #endif
2767
2768         /*
2769          * This needs to happen before any internal allocations because
2770          * it inits the small id which is required for hazard pointer
2771          * operations.
2772          */
2773         sgen_os_init ();
2774
2775         mono_gc_register_thread (&dummy);
2776 }
2777
2778 gboolean
2779 sgen_client_handle_gc_param (const char *opt)
2780 {
2781         if (g_str_has_prefix (opt, "stack-mark=")) {
2782                 opt = strchr (opt, '=') + 1;
2783                 if (!strcmp (opt, "precise")) {
2784                         conservative_stack_mark = FALSE;
2785                 } else if (!strcmp (opt, "conservative")) {
2786                         conservative_stack_mark = TRUE;
2787                 } else {
2788                         sgen_env_var_error (MONO_GC_PARAMS_NAME, conservative_stack_mark ? "Using `conservative`." : "Using `precise`.",
2789                                         "Invalid value `%s` for `stack-mark` option, possible values are: `precise`, `conservative`.", opt);
2790                 }
2791         } else if (g_str_has_prefix (opt, "bridge-implementation=")) {
2792                 opt = strchr (opt, '=') + 1;
2793                 sgen_set_bridge_implementation (opt);
2794         } else if (g_str_has_prefix (opt, "toggleref-test")) {
2795                 /* FIXME: This should probably in MONO_GC_DEBUG */
2796                 sgen_register_test_toggleref_callback ();
2797         } else {
2798                 return FALSE;
2799         }
2800         return TRUE;
2801 }
2802
2803 void
2804 sgen_client_print_gc_params_usage (void)
2805 {
2806         fprintf (stderr, "  stack-mark=MARK-METHOD (where MARK-METHOD is 'precise' or 'conservative')\n");
2807 }
2808
2809 gboolean
2810 sgen_client_handle_gc_debug (const char *opt)
2811 {
2812         if (!strcmp (opt, "xdomain-checks")) {
2813                 sgen_mono_xdomain_checks = TRUE;
2814         } else if (!strcmp (opt, "do-not-finalize")) {
2815                 do_not_finalize = TRUE;
2816         } else if (!strcmp (opt, "log-finalizers")) {
2817                 log_finalizers = TRUE;
2818         } else if (!strcmp (opt, "no-managed-allocator")) {
2819                 sgen_set_use_managed_allocator (FALSE);
2820         } else if (!sgen_bridge_handle_gc_debug (opt)) {
2821                 return FALSE;
2822         }
2823         return TRUE;
2824 }
2825
2826 void
2827 sgen_client_print_gc_debug_usage (void)
2828 {
2829         fprintf (stderr, "  xdomain-checks\n");
2830         fprintf (stderr, "  do-not-finalize\n");
2831         fprintf (stderr, "  log-finalizers\n");
2832         fprintf (stderr, "  no-managed-allocator\n");
2833         sgen_bridge_print_gc_debug_usage ();
2834 }
2835
2836
2837 gpointer
2838 sgen_client_get_provenance (void)
2839 {
2840 #ifdef SGEN_OBJECT_PROVENANCE
2841         MonoGCCallbacks *cb = mono_gc_get_gc_callbacks ();
2842         gpointer (*get_provenance_func) (void);
2843         if (!cb)
2844                 return NULL;
2845         get_provenance_func = cb->get_provenance_func;
2846         if (get_provenance_func)
2847                 return get_provenance_func ();
2848         return NULL;
2849 #else
2850         return NULL;
2851 #endif
2852 }
2853
2854 void
2855 sgen_client_describe_invalid_pointer (GCObject *ptr)
2856 {
2857         sgen_bridge_describe_pointer (ptr);
2858 }
2859
2860 void
2861 mono_gc_base_init (void)
2862 {
2863         mono_counters_init ();
2864
2865 #ifdef HEAVY_STATISTICS
2866         mono_counters_register ("los marked cards", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_marked_cards);
2867         mono_counters_register ("los array cards scanned ", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_cards);
2868         mono_counters_register ("los array remsets", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &los_array_remsets);
2869
2870         mono_counters_register ("WBarrier set arrayref", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_set_arrayref);
2871         mono_counters_register ("WBarrier value copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_value_copy);
2872         mono_counters_register ("WBarrier object copy", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_wbarrier_object_copy);
2873 #endif
2874
2875         sgen_gc_init ();
2876
2877         if (nursery_canaries_enabled ())
2878                 sgen_set_use_managed_allocator (FALSE);
2879 }
2880
2881 void
2882 mono_gc_base_cleanup (void)
2883 {
2884 }
2885
2886 gboolean
2887 mono_gc_is_null (void)
2888 {
2889         return FALSE;
2890 }
2891
2892 #endif