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