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