Merge pull request #93 from konrad-kruczynski/dispatcher_timer_fix
[mono.git] / mono / metadata / boehm-gc.c
1 /*
2  * boehm-gc.c: GC implementation using either the installed or included Boehm GC.
3  *
4  * Copyright 2001-2003 Ximian, Inc (http://www.ximian.com)
5  * Copyright 2004-2009 Novell, Inc (http://www.novell.com)
6  */
7
8 #include "config.h"
9
10 #include <string.h>
11
12 #define GC_I_HIDE_POINTERS
13 #include <mono/metadata/gc-internal.h>
14 #include <mono/metadata/mono-gc.h>
15 #include <mono/metadata/gc-internal.h>
16 #include <mono/metadata/profiler-private.h>
17 #include <mono/metadata/class-internals.h>
18 #include <mono/metadata/method-builder.h>
19 #include <mono/metadata/opcodes.h>
20 #include <mono/metadata/domain-internals.h>
21 #include <mono/metadata/metadata-internals.h>
22 #include <mono/metadata/marshal.h>
23 #include <mono/metadata/runtime.h>
24 #include <mono/utils/mono-logger-internal.h>
25 #include <mono/utils/mono-time.h>
26 #include <mono/utils/mono-threads.h>
27 #include <mono/utils/dtrace.h>
28 #include <mono/utils/gc_wrapper.h>
29
30 #if HAVE_BOEHM_GC
31
32 #ifdef USE_INCLUDED_LIBGC
33 #undef TRUE
34 #undef FALSE
35 #define THREAD_LOCAL_ALLOC 1
36 #include "private/pthread_support.h"
37 #endif
38
39 #define GC_NO_DESCRIPTOR ((gpointer)(0 | GC_DS_LENGTH))
40 /*Boehm max heap cannot be smaller than 16MB*/
41 #define MIN_BOEHM_MAX_HEAP_SIZE_IN_MB 16
42 #define MIN_BOEHM_MAX_HEAP_SIZE (MIN_BOEHM_MAX_HEAP_SIZE_IN_MB << 20)
43
44 static gboolean gc_initialized = FALSE;
45
46 static void*
47 boehm_thread_register (MonoThreadInfo* info, void *baseptr);
48
49 static void
50 mono_gc_warning (char *msg, GC_word arg)
51 {
52         mono_trace (G_LOG_LEVEL_WARNING, MONO_TRACE_GC, msg, (unsigned long)arg);
53 }
54
55 void
56 mono_gc_base_init (void)
57 {
58         MonoThreadInfoCallbacks cb;
59         char *env;
60
61         if (gc_initialized)
62                 return;
63
64         /*
65          * Handle the case when we are called from a thread different from the main thread,
66          * confusing libgc.
67          * FIXME: Move this to libgc where it belongs.
68          *
69          * we used to do this only when running on valgrind,
70          * but it happens also in other setups.
71          */
72 #if defined(HAVE_PTHREAD_GETATTR_NP) && defined(HAVE_PTHREAD_ATTR_GETSTACK)
73         {
74                 size_t size;
75                 void *sstart;
76                 pthread_attr_t attr;
77                 pthread_getattr_np (pthread_self (), &attr);
78                 pthread_attr_getstack (&attr, &sstart, &size);
79                 pthread_attr_destroy (&attr); 
80                 /*g_print ("stackbottom pth is: %p\n", (char*)sstart + size);*/
81 #ifdef __ia64__
82                 /*
83                  * The calculation above doesn't seem to work on ia64, also we need to set
84                  * GC_register_stackbottom as well, but don't know how.
85                  */
86 #else
87                 /* apparently with some linuxthreads implementations sstart can be NULL,
88                  * fallback to the more imprecise method (bug# 78096).
89                  */
90                 if (sstart) {
91                         GC_stackbottom = (char*)sstart + size;
92                 } else {
93                         int dummy;
94                         gsize stack_bottom = (gsize)&dummy;
95                         stack_bottom += 4095;
96                         stack_bottom &= ~4095;
97                         GC_stackbottom = (char*)stack_bottom;
98                 }
99 #endif
100         }
101 #elif defined(HAVE_PTHREAD_GET_STACKSIZE_NP) && defined(HAVE_PTHREAD_GET_STACKADDR_NP)
102                 GC_stackbottom = (char*)pthread_get_stackaddr_np (pthread_self ());
103 #elif defined(__OpenBSD__)
104 #  include <pthread_np.h>
105         {
106                 stack_t ss;
107                 int rslt;
108
109                 rslt = pthread_stackseg_np(pthread_self(), &ss);
110                 g_assert (rslt == 0);
111
112                 GC_stackbottom = (char*)ss.ss_sp;
113         }
114 #elif defined(__native_client__)
115         /* Do nothing, GC_stackbottom is set correctly in libgc */
116 #else
117         {
118                 int dummy;
119                 gsize stack_bottom = (gsize)&dummy;
120                 stack_bottom += 4095;
121                 stack_bottom &= ~4095;
122                 /*g_print ("stackbottom is: %p\n", (char*)stack_bottom);*/
123                 GC_stackbottom = (char*)stack_bottom;
124         }
125 #endif
126
127 #if !defined(PLATFORM_ANDROID)
128         /* If GC_no_dls is set to true, GC_find_limit is not called. This causes a seg fault on Android. */
129         GC_no_dls = TRUE;
130 #endif
131         GC_init ();
132         GC_oom_fn = mono_gc_out_of_memory;
133         GC_set_warn_proc (mono_gc_warning);
134         GC_finalize_on_demand = 1;
135         GC_finalizer_notifier = mono_gc_finalize_notify;
136
137 #ifdef HAVE_GC_GCJ_MALLOC
138         GC_init_gcj_malloc (5, NULL);
139 #endif
140
141 #ifdef HAVE_GC_ALLOW_REGISTER_THREADS
142         GC_allow_register_threads();
143 #endif
144
145         if ((env = getenv ("MONO_GC_PARAMS"))) {
146                 char **ptr, **opts = g_strsplit (env, ",", -1);
147                 for (ptr = opts; *ptr; ++ptr) {
148                         char *opt = *ptr;
149                         if (g_str_has_prefix (opt, "max-heap-size=")) {
150                                 glong max_heap;
151
152                                 opt = strchr (opt, '=') + 1;
153                                 if (*opt && mono_gc_parse_environment_string_extract_number (opt, &max_heap)) {
154                                         if (max_heap < MIN_BOEHM_MAX_HEAP_SIZE) {
155                                                 fprintf (stderr, "max-heap-size must be at least %dMb.\n", MIN_BOEHM_MAX_HEAP_SIZE_IN_MB);
156                                                 exit (1);
157                                         }
158                                         GC_set_max_heap_size (max_heap);
159                                 } else {
160                                         fprintf (stderr, "max-heap-size must be an integer.\n");
161                                         exit (1);
162                                 }
163                                 continue;
164                         } else {
165                                 fprintf (stderr, "MONO_GC_PARAMS must be a comma-delimited list of one or more of the following:\n");
166                                 fprintf (stderr, "  max-heap-size=N (where N is an integer, possibly with a k, m or a g suffix)\n");
167                                 exit (1);
168                         }
169                 }
170                 g_strfreev (opts);
171         }
172
173         memset (&cb, 0, sizeof (cb));
174         cb.thread_register = boehm_thread_register;
175         cb.mono_method_is_critical = (gpointer)mono_runtime_is_critical_method;
176 #ifndef HOST_WIN32
177         cb.mono_gc_pthread_create = (gpointer)mono_gc_pthread_create;
178 #endif
179         
180         mono_threads_init (&cb, sizeof (MonoThreadInfo));
181
182         mono_gc_enable_events ();
183         gc_initialized = TRUE;
184 }
185
186 /**
187  * mono_gc_collect:
188  * @generation: GC generation identifier
189  *
190  * Perform a garbage collection for the given generation, higher numbers
191  * mean usually older objects. Collecting a high-numbered generation
192  * implies collecting also the lower-numbered generations.
193  * The maximum value for @generation can be retrieved with a call to
194  * mono_gc_max_generation(), so this function is usually called as:
195  *
196  *      mono_gc_collect (mono_gc_max_generation ());
197  */
198 void
199 mono_gc_collect (int generation)
200 {
201         MONO_PROBE_GC_BEGIN (generation);
202
203         mono_perfcounters->gc_induced++;
204         GC_gcollect ();
205         
206         MONO_PROBE_GC_END (generation);
207 #if defined(ENABLE_DTRACE) && defined(__sun__)
208         /* This works around a dtrace -G problem on Solaris.
209            Limit its actual use to when the probe is enabled. */
210         if (MONO_PROBE_GC_END_ENABLED ())
211                 sleep(0);
212 #endif
213 }
214
215 /**
216  * mono_gc_max_generation:
217  *
218  * Get the maximum generation number used by the current garbage
219  * collector. The value will be 0 for the Boehm collector, 1 or more
220  * for the generational collectors.
221  *
222  * Returns: the maximum generation number.
223  */
224 int
225 mono_gc_max_generation (void)
226 {
227         return 0;
228 }
229
230 /**
231  * mono_gc_get_generation:
232  * @object: a managed object
233  *
234  * Get the garbage collector's generation that @object belongs to.
235  * Use this has a hint only.
236  *
237  * Returns: a garbage collector generation number
238  */
239 int
240 mono_gc_get_generation  (MonoObject *object)
241 {
242         return 0;
243 }
244
245 /**
246  * mono_gc_collection_count:
247  * @generation: a GC generation number
248  *
249  * Get how many times a garbage collection has been performed
250  * for the given @generation number.
251  *
252  * Returns: the number of garbage collections
253  */
254 int
255 mono_gc_collection_count (int generation)
256 {
257         return GC_gc_no;
258 }
259
260 /**
261  * mono_gc_add_memory_pressure:
262  * @value: amount of bytes
263  *
264  * Adjust the garbage collector's view of how many bytes of memory
265  * are indirectly referenced by managed objects (for example unmanaged
266  * memory holding image or other binary data).
267  * This is a hint only to the garbage collector algorithm.
268  * Note that negative amounts of @value will decrease the memory
269  * pressure.
270  */
271 void
272 mono_gc_add_memory_pressure (gint64 value)
273 {
274 }
275
276 /**
277  * mono_gc_get_used_size:
278  *
279  * Get the approximate amount of memory used by managed objects.
280  *
281  * Returns: the amount of memory used in bytes
282  */
283 int64_t
284 mono_gc_get_used_size (void)
285 {
286         return GC_get_heap_size () - GC_get_free_bytes ();
287 }
288
289 /**
290  * mono_gc_get_heap_size:
291  *
292  * Get the amount of memory used by the garbage collector.
293  *
294  * Returns: the size of the heap in bytes
295  */
296 int64_t
297 mono_gc_get_heap_size (void)
298 {
299         return GC_get_heap_size ();
300 }
301
302 void
303 mono_gc_disable (void)
304 {
305 #ifdef HAVE_GC_ENABLE
306         GC_disable ();
307 #else
308         g_assert_not_reached ();
309 #endif
310 }
311
312 void
313 mono_gc_enable (void)
314 {
315 #ifdef HAVE_GC_ENABLE
316         GC_enable ();
317 #else
318         g_assert_not_reached ();
319 #endif
320 }
321
322 gboolean
323 mono_gc_is_gc_thread (void)
324 {
325 #if GC_VERSION_MAJOR >= 7
326         return TRUE;
327 #elif defined(USE_INCLUDED_LIBGC)
328         return GC_thread_is_registered ();
329 #else
330         return TRUE;
331 #endif
332 }
333
334 extern int GC_thread_register_foreign (void *base_addr);
335
336 gboolean
337 mono_gc_register_thread (void *baseptr)
338 {
339         return mono_thread_info_attach (baseptr) != NULL;
340 }
341
342 static void*
343 boehm_thread_register (MonoThreadInfo* info, void *baseptr)
344 {
345 #if GC_VERSION_MAJOR >= 7
346         struct GC_stack_base sb;
347         int res;
348
349         res = GC_get_stack_base (&sb);
350         if (res != GC_SUCCESS) {
351                 sb.mem_base = baseptr;
352 #ifdef __ia64__
353                 /* Can't determine the register stack bounds */
354                 g_error ("mono_gc_register_thread failed ().\n");
355 #endif
356         }
357         res = GC_register_my_thread (&sb);
358         if ((res != GC_SUCCESS) && (res != GC_DUPLICATE)) {
359                 g_warning ("GC_register_my_thread () failed.\n");
360                 return NULL;
361         }
362         return info;
363 #else
364         if (mono_gc_is_gc_thread())
365                 return info;
366 #if defined(USE_INCLUDED_LIBGC) && !defined(HOST_WIN32)
367         return GC_thread_register_foreign (baseptr) ? info : NULL;
368 #else
369         return NULL;
370 #endif
371 #endif
372 }
373
374 gboolean
375 mono_object_is_alive (MonoObject* o)
376 {
377 #ifdef USE_INCLUDED_LIBGC
378         return GC_is_marked ((gpointer)o);
379 #else
380         return TRUE;
381 #endif
382 }
383
384 int
385 mono_gc_walk_heap (int flags, MonoGCReferences callback, void *data)
386 {
387         return 1;
388 }
389
390 #ifdef USE_INCLUDED_LIBGC
391
392 static gint64 gc_start_time;
393
394 static void
395 on_gc_notification (GCEventType event)
396 {
397         MonoGCEvent e = (MonoGCEvent)event;
398
399         if (e == MONO_GC_EVENT_PRE_STOP_WORLD) 
400                 mono_thread_info_suspend_lock ();
401         else if (e == MONO_GC_EVENT_POST_START_WORLD)
402                 mono_thread_info_suspend_unlock ();
403         
404         if (e == MONO_GC_EVENT_START) {
405                 if (mono_perfcounters)
406                         mono_perfcounters->gc_collections0++;
407                 mono_stats.major_gc_count ++;
408                 gc_start_time = mono_100ns_ticks ();
409         } else if (e == MONO_GC_EVENT_END) {
410                 if (mono_perfcounters) {
411                         guint64 heap_size = GC_get_heap_size ();
412                         guint64 used_size = heap_size - GC_get_free_bytes ();
413                         mono_perfcounters->gc_total_bytes = used_size;
414                         mono_perfcounters->gc_committed_bytes = heap_size;
415                         mono_perfcounters->gc_reserved_bytes = heap_size;
416                         mono_perfcounters->gc_gen0size = heap_size;
417                 }
418                 mono_stats.major_gc_time_usecs += (mono_100ns_ticks () - gc_start_time) / 10;
419                 mono_trace_message (MONO_TRACE_GC, "gc took %d usecs", (mono_100ns_ticks () - gc_start_time) / 10);
420         }
421         mono_profiler_gc_event (e, 0);
422 }
423  
424 static void
425 on_gc_heap_resize (size_t new_size)
426 {
427         guint64 heap_size = GC_get_heap_size ();
428         if (mono_perfcounters) {
429                 mono_perfcounters->gc_committed_bytes = heap_size;
430                 mono_perfcounters->gc_reserved_bytes = heap_size;
431                 mono_perfcounters->gc_gen0size = heap_size;
432         }
433         mono_profiler_gc_heap_resize (new_size);
434 }
435
436 void
437 mono_gc_enable_events (void)
438 {
439         GC_notify_event = on_gc_notification;
440         GC_on_heap_resize = on_gc_heap_resize;
441 }
442
443 #else
444
445 void
446 mono_gc_enable_events (void)
447 {
448 }
449
450 #endif
451
452 int
453 mono_gc_register_root (char *start, size_t size, void *descr)
454 {
455         /* for some strange reason, they want one extra byte on the end */
456         GC_add_roots (start, start + size + 1);
457
458         return TRUE;
459 }
460
461 void
462 mono_gc_deregister_root (char* addr)
463 {
464 #ifndef HOST_WIN32
465         /* FIXME: libgc doesn't define this work win32 for some reason */
466         /* FIXME: No size info */
467         GC_remove_roots (addr, addr + sizeof (gpointer) + 1);
468 #endif
469 }
470
471 void
472 mono_gc_weak_link_add (void **link_addr, MonoObject *obj, gboolean track)
473 {
474         /* libgc requires that we use HIDE_POINTER... */
475         *link_addr = (void*)HIDE_POINTER (obj);
476         GC_GENERAL_REGISTER_DISAPPEARING_LINK (link_addr, obj);
477 }
478
479 void
480 mono_gc_weak_link_remove (void **link_addr)
481 {
482         GC_unregister_disappearing_link (link_addr);
483         *link_addr = NULL;
484 }
485
486 static gpointer
487 reveal_link (gpointer link_addr)
488 {
489         void **link_a = link_addr;
490         return REVEAL_POINTER (*link_a);
491 }
492
493 MonoObject*
494 mono_gc_weak_link_get (void **link_addr)
495 {
496         MonoObject *obj = GC_call_with_alloc_lock (reveal_link, link_addr);
497         if (obj == (MonoObject *) -1)
498                 return NULL;
499         return obj;
500 }
501
502 void*
503 mono_gc_make_descr_for_string (gsize *bitmap, int numbits)
504 {
505         return mono_gc_make_descr_from_bitmap (bitmap, numbits);
506 }
507
508 void*
509 mono_gc_make_descr_for_object (gsize *bitmap, int numbits, size_t obj_size)
510 {
511         return mono_gc_make_descr_from_bitmap (bitmap, numbits);
512 }
513
514 void*
515 mono_gc_make_descr_for_array (int vector, gsize *elem_bitmap, int numbits, size_t elem_size)
516 {
517         /* libgc has no usable support for arrays... */
518         return GC_NO_DESCRIPTOR;
519 }
520
521 void*
522 mono_gc_make_descr_from_bitmap (gsize *bitmap, int numbits)
523 {
524 #ifdef HAVE_GC_GCJ_MALLOC
525         /* It seems there are issues when the bitmap doesn't fit: play it safe */
526         if (numbits >= 30)
527                 return GC_NO_DESCRIPTOR;
528         else
529                 return (gpointer)GC_make_descriptor ((GC_bitmap)bitmap, numbits);
530 #else
531         return NULL;
532 #endif
533 }
534
535 void*
536 mono_gc_make_root_descr_all_refs (int numbits)
537 {
538         return NULL;
539 }
540
541 void*
542 mono_gc_alloc_fixed (size_t size, void *descr)
543 {
544         /* To help track down typed allocation bugs */
545         /*
546         static int count;
547         count ++;
548         if (count == atoi (getenv ("COUNT2")))
549                 printf ("HIT!\n");
550         if (count > atoi (getenv ("COUNT2")))
551                 return GC_MALLOC (size);
552         */
553
554         if (descr)
555                 return GC_MALLOC_EXPLICITLY_TYPED (size, (GC_descr)descr);
556         else
557                 return GC_MALLOC (size);
558 }
559
560 void
561 mono_gc_free_fixed (void* addr)
562 {
563 }
564
565 int
566 mono_gc_invoke_finalizers (void)
567 {
568         /* There is a bug in GC_invoke_finalizer () in versions <= 6.2alpha4:
569          * the 'mem_freed' variable is not initialized when there are no
570          * objects to finalize, which leads to strange behavior later on.
571          * The check is necessary to work around that bug.
572          */
573         if (GC_should_invoke_finalizers ())
574                 return GC_invoke_finalizers ();
575         return 0;
576 }
577
578 gboolean
579 mono_gc_pending_finalizers (void)
580 {
581         return GC_should_invoke_finalizers ();
582 }
583
584 /*
585  * LOCKING: Assumes the domain_finalizers lock is held.
586  */
587 static void
588 add_weak_track_handle_internal (MonoDomain *domain, MonoObject *obj, guint32 gchandle)
589 {
590         GSList *refs;
591
592         if (!domain->track_resurrection_objects_hash)
593                 domain->track_resurrection_objects_hash = g_hash_table_new (mono_aligned_addr_hash, NULL);
594
595         refs = g_hash_table_lookup (domain->track_resurrection_objects_hash, obj);
596         refs = g_slist_prepend (refs, GUINT_TO_POINTER (gchandle));
597         g_hash_table_insert (domain->track_resurrection_objects_hash, obj, refs);
598 }
599
600 void
601 mono_gc_add_weak_track_handle (MonoObject *obj, guint32 handle)
602 {
603         MonoDomain *domain;
604
605         if (!obj)
606                 return;
607
608         domain = mono_object_get_domain (obj);
609
610         mono_domain_finalizers_lock (domain);
611
612         add_weak_track_handle_internal (domain, obj, handle);
613
614         g_hash_table_insert (domain->track_resurrection_handles_hash, GUINT_TO_POINTER (handle), obj);
615
616         mono_domain_finalizers_unlock (domain);
617 }
618
619 /*
620  * LOCKING: Assumes the domain_finalizers lock is held.
621  */
622 static void
623 remove_weak_track_handle_internal (MonoDomain *domain, MonoObject *obj, guint32 gchandle)
624 {
625         GSList *refs;
626
627         if (!domain->track_resurrection_objects_hash)
628                 return;
629
630         refs = g_hash_table_lookup (domain->track_resurrection_objects_hash, obj);
631         refs = g_slist_remove (refs, GUINT_TO_POINTER (gchandle));
632         g_hash_table_insert (domain->track_resurrection_objects_hash, obj, refs);
633 }
634
635 void
636 mono_gc_change_weak_track_handle (MonoObject *old_obj, MonoObject *obj, guint32 gchandle)
637 {
638         MonoDomain *domain = mono_domain_get ();
639
640         mono_domain_finalizers_lock (domain);
641
642         if (old_obj)
643                 remove_weak_track_handle_internal (domain, old_obj, gchandle);
644         if (obj)
645                 add_weak_track_handle_internal (domain, obj, gchandle);
646
647         mono_domain_finalizers_unlock (domain);
648 }
649
650 void
651 mono_gc_remove_weak_track_handle (guint32 gchandle)
652 {
653         MonoDomain *domain = mono_domain_get ();
654         MonoObject *obj;
655
656         /* Clean our entries in the two hashes in MonoDomain */
657
658         mono_domain_finalizers_lock (domain);
659
660         /* Get the original object this handle pointed to */
661         obj = g_hash_table_lookup (domain->track_resurrection_handles_hash, GUINT_TO_POINTER (gchandle));
662         if (obj) {
663                 g_hash_table_remove (domain->track_resurrection_handles_hash, GUINT_TO_POINTER (gchandle));
664
665                 remove_weak_track_handle_internal (domain, obj, gchandle);
666         }
667
668         mono_domain_finalizers_unlock (domain);
669 }
670
671 GSList*
672 mono_gc_remove_weak_track_object (MonoDomain *domain, MonoObject *obj)
673 {
674         GSList *refs = NULL;
675
676         if (domain->track_resurrection_objects_hash) {
677                 refs = g_hash_table_lookup (domain->track_resurrection_objects_hash, obj);
678
679                 if (refs)
680                         /*
681                          * Since we don't run finalizers again for resurrected objects,
682                          * no need to keep these around.
683                          */
684                         g_hash_table_remove (domain->track_resurrection_objects_hash, obj);
685         }
686
687         return refs;
688 }
689
690 void
691 mono_gc_wbarrier_set_field (MonoObject *obj, gpointer field_ptr, MonoObject* value)
692 {
693         *(void**)field_ptr = value;
694 }
695
696 void
697 mono_gc_wbarrier_set_arrayref (MonoArray *arr, gpointer slot_ptr, MonoObject* value)
698 {
699         *(void**)slot_ptr = value;
700 }
701
702 void
703 mono_gc_wbarrier_arrayref_copy (gpointer dest_ptr, gpointer src_ptr, int count)
704 {
705         mono_gc_memmove (dest_ptr, src_ptr, count * sizeof (gpointer));
706 }
707
708 void
709 mono_gc_wbarrier_generic_store (gpointer ptr, MonoObject* value)
710 {
711         *(void**)ptr = value;
712 }
713
714 void
715 mono_gc_wbarrier_generic_nostore (gpointer ptr)
716 {
717 }
718
719 void
720 mono_gc_wbarrier_value_copy (gpointer dest, gpointer src, int count, MonoClass *klass)
721 {
722         mono_gc_memmove (dest, src, count * mono_class_value_size (klass, NULL));
723 }
724
725 void
726 mono_gc_wbarrier_object_copy (MonoObject* obj, MonoObject *src)
727 {
728         /* do not copy the sync state */
729         mono_gc_memmove ((char*)obj + sizeof (MonoObject), (char*)src + sizeof (MonoObject),
730                         mono_object_class (obj)->instance_size - sizeof (MonoObject));
731 }
732
733 void
734 mono_gc_clear_domain (MonoDomain *domain)
735 {
736 }
737
738 int
739 mono_gc_get_suspend_signal (void)
740 {
741 #ifdef USE_INCLUDED_GC
742         return GC_get_suspend_signal ();
743 #else
744         return -1;
745 #endif
746 }
747
748 #if defined(USE_INCLUDED_LIBGC) && defined(USE_COMPILER_TLS) && defined(__linux__) && (defined(__i386__) || defined(__x86_64__))
749 extern __thread MONO_TLS_FAST void* GC_thread_tls;
750 #include "metadata-internals.h"
751
752 static int
753 shift_amount (int v)
754 {
755         int i = 0;
756         while (!(v & (1 << i)))
757                 i++;
758         return i;
759 }
760
761 enum {
762         ATYPE_FREEPTR,
763         ATYPE_FREEPTR_FOR_BOX,
764         ATYPE_NORMAL,
765         ATYPE_GCJ,
766         ATYPE_STRING,
767         ATYPE_NUM
768 };
769
770 static MonoMethod*
771 create_allocator (int atype, int offset)
772 {
773         int index_var, bytes_var, my_fl_var, my_entry_var;
774         guint32 no_freelist_branch, not_small_enough_branch = 0;
775         guint32 size_overflow_branch = 0;
776         MonoMethodBuilder *mb;
777         MonoMethod *res;
778         MonoMethodSignature *csig;
779         AllocatorWrapperInfo *info;
780
781         if (atype == ATYPE_STRING) {
782                 csig = mono_metadata_signature_alloc (mono_defaults.corlib, 2);
783                 csig->ret = &mono_defaults.string_class->byval_arg;
784                 csig->params [0] = &mono_defaults.int_class->byval_arg;
785                 csig->params [1] = &mono_defaults.int32_class->byval_arg;
786         } else {
787                 csig = mono_metadata_signature_alloc (mono_defaults.corlib, 1);
788                 csig->ret = &mono_defaults.object_class->byval_arg;
789                 csig->params [0] = &mono_defaults.int_class->byval_arg;
790         }
791
792         mb = mono_mb_new (mono_defaults.object_class, "Alloc", MONO_WRAPPER_ALLOC);
793         bytes_var = mono_mb_add_local (mb, &mono_defaults.int32_class->byval_arg);
794         if (atype == ATYPE_STRING) {
795                 /* a string alloator method takes the args: (vtable, len) */
796                 /* bytes = (sizeof (MonoString) + ((len + 1) * 2)); */
797                 mono_mb_emit_ldarg (mb, 1);
798                 mono_mb_emit_icon (mb, 1);
799                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
800                 mono_mb_emit_icon (mb, 1);
801                 mono_mb_emit_byte (mb, MONO_CEE_SHL);
802                 // sizeof (MonoString) might include padding
803                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoString, chars));
804                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
805                 mono_mb_emit_stloc (mb, bytes_var);
806         } else {
807                 /* bytes = vtable->klass->instance_size */
808                 mono_mb_emit_ldarg (mb, 0);
809                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoVTable, klass));
810                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
811                 mono_mb_emit_byte (mb, MONO_CEE_LDIND_I);
812                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoClass, instance_size));
813                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
814                 /* FIXME: assert instance_size stays a 4 byte integer */
815                 mono_mb_emit_byte (mb, MONO_CEE_LDIND_U4);
816                 mono_mb_emit_stloc (mb, bytes_var);
817         }
818
819         /* this is needed for strings/arrays only as the other big types are never allocated with this method */
820         if (atype == ATYPE_STRING) {
821                 /* check for size */
822                 /* if (!SMALL_ENOUGH (bytes)) jump slow_path;*/
823                 mono_mb_emit_ldloc (mb, bytes_var);
824                 mono_mb_emit_icon (mb, (NFREELISTS-1) * GRANULARITY);
825                 not_small_enough_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BGT_UN_S);
826                 /* check for overflow */
827                 mono_mb_emit_ldloc (mb, bytes_var);
828                 mono_mb_emit_icon (mb, sizeof (MonoString));
829                 size_overflow_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLE_UN_S);
830         }
831
832         /* int index = INDEX_FROM_BYTES(bytes); */
833         index_var = mono_mb_add_local (mb, &mono_defaults.int32_class->byval_arg);
834         
835         mono_mb_emit_ldloc (mb, bytes_var);
836         mono_mb_emit_icon (mb, GRANULARITY - 1);
837         mono_mb_emit_byte (mb, MONO_CEE_ADD);
838         mono_mb_emit_icon (mb, shift_amount (GRANULARITY));
839         mono_mb_emit_byte (mb, MONO_CEE_SHR_UN);
840         mono_mb_emit_icon (mb, shift_amount (sizeof (gpointer)));
841         mono_mb_emit_byte (mb, MONO_CEE_SHL);
842         /* index var is already adjusted into bytes */
843         mono_mb_emit_stloc (mb, index_var);
844
845         my_fl_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
846         my_entry_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
847         /* my_fl = ((GC_thread)tsd) -> ptrfree_freelists + index; */
848         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
849         mono_mb_emit_byte (mb, 0x0D); /* CEE_MONO_TLS */
850         mono_mb_emit_i4 (mb, offset);
851         if (atype == ATYPE_FREEPTR || atype == ATYPE_FREEPTR_FOR_BOX || atype == ATYPE_STRING)
852                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, ptrfree_freelists));
853         else if (atype == ATYPE_NORMAL)
854                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, normal_freelists));
855         else if (atype == ATYPE_GCJ)
856                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, gcj_freelists));
857         else
858                 g_assert_not_reached ();
859         mono_mb_emit_byte (mb, MONO_CEE_ADD);
860         mono_mb_emit_ldloc (mb, index_var);
861         mono_mb_emit_byte (mb, MONO_CEE_ADD);
862         mono_mb_emit_stloc (mb, my_fl_var);
863
864         /* my_entry = *my_fl; */
865         mono_mb_emit_ldloc (mb, my_fl_var);
866         mono_mb_emit_byte (mb, MONO_CEE_LDIND_I);
867         mono_mb_emit_stloc (mb, my_entry_var);
868
869         /* if (EXPECT((word)my_entry >= HBLKSIZE, 1)) { */
870         mono_mb_emit_ldloc (mb, my_entry_var);
871         mono_mb_emit_icon (mb, HBLKSIZE);
872         no_freelist_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLT_UN_S);
873
874         /* ptr_t next = obj_link(my_entry); *my_fl = next; */
875         mono_mb_emit_ldloc (mb, my_fl_var);
876         mono_mb_emit_ldloc (mb, my_entry_var);
877         mono_mb_emit_byte (mb, MONO_CEE_LDIND_I);
878         mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
879
880         /* set the vtable and clear the words in the object */
881         mono_mb_emit_ldloc (mb, my_entry_var);
882         mono_mb_emit_ldarg (mb, 0);
883         mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
884
885         if (atype == ATYPE_FREEPTR) {
886                 int start_var, end_var, start_loop;
887                 /* end = my_entry + bytes; start = my_entry + sizeof (gpointer);
888                  */
889                 start_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
890                 end_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
891                 mono_mb_emit_ldloc (mb, my_entry_var);
892                 mono_mb_emit_ldloc (mb, bytes_var);
893                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
894                 mono_mb_emit_stloc (mb, end_var);
895                 mono_mb_emit_ldloc (mb, my_entry_var);
896                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoObject, synchronisation));
897                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
898                 mono_mb_emit_stloc (mb, start_var);
899                 /*
900                  * do {
901                  *      *start++ = NULL;
902                  * } while (start < end);
903                  */
904                 start_loop = mono_mb_get_label (mb);
905                 mono_mb_emit_ldloc (mb, start_var);
906                 mono_mb_emit_icon (mb, 0);
907                 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
908                 mono_mb_emit_ldloc (mb, start_var);
909                 mono_mb_emit_icon (mb, sizeof (gpointer));
910                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
911                 mono_mb_emit_stloc (mb, start_var);
912
913                 mono_mb_emit_ldloc (mb, start_var);
914                 mono_mb_emit_ldloc (mb, end_var);
915                 mono_mb_emit_byte (mb, MONO_CEE_BLT_UN_S);
916                 mono_mb_emit_byte (mb, start_loop - (mono_mb_get_label (mb) + 1));
917         } else if (atype == ATYPE_FREEPTR_FOR_BOX || atype == ATYPE_STRING) {
918                 /* need to clear just the sync pointer */
919                 mono_mb_emit_ldloc (mb, my_entry_var);
920                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoObject, synchronisation));
921                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
922                 mono_mb_emit_icon (mb, 0);
923                 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
924         }
925
926         if (atype == ATYPE_STRING) {
927                 /* need to set length and clear the last char */
928                 /* s->length = len; */
929                 mono_mb_emit_ldloc (mb, my_entry_var);
930                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoString, length));
931                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
932                 mono_mb_emit_ldarg (mb, 1);
933                 mono_mb_emit_byte (mb, MONO_CEE_STIND_I4);
934                 /* s->chars [len] = 0; */
935                 mono_mb_emit_ldloc (mb, my_entry_var);
936                 mono_mb_emit_ldloc (mb, bytes_var);
937                 mono_mb_emit_icon (mb, 2);
938                 mono_mb_emit_byte (mb, MONO_CEE_SUB);
939                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
940                 mono_mb_emit_icon (mb, 0);
941                 mono_mb_emit_byte (mb, MONO_CEE_STIND_I2);
942         }
943
944         /* return my_entry; */
945         mono_mb_emit_ldloc (mb, my_entry_var);
946         mono_mb_emit_byte (mb, MONO_CEE_RET);
947         
948         mono_mb_patch_short_branch (mb, no_freelist_branch);
949         if (not_small_enough_branch > 0)
950                 mono_mb_patch_short_branch (mb, not_small_enough_branch);
951         if (size_overflow_branch > 0)
952                 mono_mb_patch_short_branch (mb, size_overflow_branch);
953         /* the slow path: we just call back into the runtime */
954         if (atype == ATYPE_STRING) {
955                 mono_mb_emit_ldarg (mb, 1);
956                 mono_mb_emit_icall (mb, mono_string_alloc);
957         } else {
958                 mono_mb_emit_ldarg (mb, 0);
959                 mono_mb_emit_icall (mb, mono_object_new_specific);
960         }
961
962         mono_mb_emit_byte (mb, MONO_CEE_RET);
963
964         res = mono_mb_create_method (mb, csig, 8);
965         mono_mb_free (mb);
966         mono_method_get_header (res)->init_locals = FALSE;
967
968         info = mono_image_alloc0 (mono_defaults.corlib, sizeof (AllocatorWrapperInfo));
969         info->gc_name = "boehm";
970         info->alloc_type = atype;
971         mono_marshal_set_wrapper_info (res, info);
972
973         return res;
974 }
975
976 static MonoMethod* alloc_method_cache [ATYPE_NUM];
977
978 static G_GNUC_UNUSED gboolean
979 mono_gc_is_critical_method (MonoMethod *method)
980 {
981         int i;
982
983         for (i = 0; i < ATYPE_NUM; ++i)
984                 if (method == alloc_method_cache [i])
985                         return TRUE;
986
987         return FALSE;
988 }
989
990 /*
991  * If possible, generate a managed method that can quickly allocate objects in class
992  * @klass. The method will typically have an thread-local inline allocation sequence.
993  * The signature of the called method is:
994  *      object allocate (MonoVTable *vtable)
995  * Some of the logic here is similar to mono_class_get_allocation_ftn () i object.c,
996  * keep in sync.
997  * The thread local alloc logic is taken from libgc/pthread_support.c.
998  */
999
1000 MonoMethod*
1001 mono_gc_get_managed_allocator (MonoVTable *vtable, gboolean for_box)
1002 {
1003         int offset = -1;
1004         int atype;
1005         MonoClass *klass = vtable->klass;
1006         MONO_THREAD_VAR_OFFSET (GC_thread_tls, offset);
1007
1008         /*g_print ("thread tls: %d\n", offset);*/
1009         if (offset == -1)
1010                 return NULL;
1011         if (!SMALL_ENOUGH (klass->instance_size))
1012                 return NULL;
1013         if (mono_class_has_finalizer (klass) || klass->marshalbyref || (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS))
1014                 return NULL;
1015         if (klass->rank)
1016                 return NULL;
1017         if (klass->byval_arg.type == MONO_TYPE_STRING) {
1018                 atype = ATYPE_STRING;
1019         } else if (!klass->has_references) {
1020                 if (for_box)
1021                         atype = ATYPE_FREEPTR_FOR_BOX;
1022                 else
1023                         atype = ATYPE_FREEPTR;
1024         } else {
1025                 return NULL;
1026                 /*
1027                  * disabled because we currently do a runtime choice anyway, to
1028                  * deal with multiple appdomains.
1029                 if (vtable->gc_descr != GC_NO_DESCRIPTOR)
1030                         atype = ATYPE_GCJ;
1031                 else
1032                         atype = ATYPE_NORMAL;
1033                 */
1034         }
1035         return mono_gc_get_managed_allocator_by_type (atype);
1036 }
1037
1038 MonoMethod*
1039 mono_gc_get_managed_array_allocator (MonoVTable *vtable, int rank)
1040 {
1041         return NULL;
1042 }
1043
1044 /**
1045  * mono_gc_get_managed_allocator_by_type:
1046  *
1047  *   Return a managed allocator method corresponding to allocator type ATYPE.
1048  */
1049 MonoMethod*
1050 mono_gc_get_managed_allocator_by_type (int atype)
1051 {
1052         int offset = -1;
1053         MonoMethod *res;
1054         MONO_THREAD_VAR_OFFSET (GC_thread_tls, offset);
1055
1056         mono_loader_lock ();
1057         res = alloc_method_cache [atype];
1058         if (!res)
1059                 res = alloc_method_cache [atype] = create_allocator (atype, offset);
1060         mono_loader_unlock ();
1061         return res;
1062 }
1063
1064 guint32
1065 mono_gc_get_managed_allocator_types (void)
1066 {
1067         return ATYPE_NUM;
1068 }
1069
1070 MonoMethod*
1071 mono_gc_get_write_barrier (void)
1072 {
1073         g_assert_not_reached ();
1074         return NULL;
1075 }
1076
1077 #else
1078
1079 static G_GNUC_UNUSED gboolean
1080 mono_gc_is_critical_method (MonoMethod *method)
1081 {
1082         return FALSE;
1083 }
1084
1085 MonoMethod*
1086 mono_gc_get_managed_allocator (MonoVTable *vtable, gboolean for_box)
1087 {
1088         return NULL;
1089 }
1090
1091 MonoMethod*
1092 mono_gc_get_managed_array_allocator (MonoVTable *vtable, int rank)
1093 {
1094         return NULL;
1095 }
1096
1097 MonoMethod*
1098 mono_gc_get_managed_allocator_by_type (int atype)
1099 {
1100         return NULL;
1101 }
1102
1103 guint32
1104 mono_gc_get_managed_allocator_types (void)
1105 {
1106         return 0;
1107 }
1108
1109 MonoMethod*
1110 mono_gc_get_write_barrier (void)
1111 {
1112         g_assert_not_reached ();
1113         return NULL;
1114 }
1115
1116 #endif
1117
1118 const char *
1119 mono_gc_get_gc_name (void)
1120 {
1121         return "boehm";
1122 }
1123
1124 void*
1125 mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data)
1126 {
1127         return GC_call_with_alloc_lock (func, data);
1128 }
1129
1130 char*
1131 mono_gc_get_description (void)
1132 {
1133         return g_strdup (DEFAULT_GC_NAME);
1134 }
1135
1136 void
1137 mono_gc_set_desktop_mode (void)
1138 {
1139         GC_dont_expand = 1;
1140 }
1141
1142 gboolean
1143 mono_gc_is_moving (void)
1144 {
1145         return FALSE;
1146 }
1147
1148 gboolean
1149 mono_gc_is_disabled (void)
1150 {
1151         if (GC_dont_gc || g_getenv ("GC_DONT_GC"))
1152                 return TRUE;
1153         else
1154                 return FALSE;
1155 }
1156
1157 void
1158 mono_gc_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap)
1159 {
1160         g_assert_not_reached ();
1161 }
1162
1163
1164 guint8*
1165 mono_gc_get_card_table (int *shift_bits, gpointer *card_mask)
1166 {
1167         g_assert_not_reached ();
1168         return NULL;
1169 }
1170
1171 void*
1172 mono_gc_get_nursery (int *shift_bits, size_t *size)
1173 {
1174         return NULL;
1175 }
1176
1177 gboolean
1178 mono_gc_precise_stack_mark_enabled (void)
1179 {
1180         return FALSE;
1181 }
1182
1183 FILE *
1184 mono_gc_get_logfile (void)
1185 {
1186         return NULL;
1187 }
1188
1189 void
1190 mono_gc_conservatively_scan_area (void *start, void *end)
1191 {
1192         g_assert_not_reached ();
1193 }
1194
1195 void *
1196 mono_gc_scan_object (void *obj)
1197 {
1198         g_assert_not_reached ();
1199         return NULL;
1200 }
1201
1202 gsize*
1203 mono_gc_get_bitmap_for_descr (void *descr, int *numbits)
1204 {
1205         g_assert_not_reached ();
1206         return NULL;
1207 }
1208
1209 void
1210 mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks)
1211 {
1212 }
1213
1214 /*
1215  * These will call the redefined versions in libgc.
1216  */
1217
1218 #ifndef HOST_WIN32
1219
1220 int
1221 mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
1222 {
1223         return pthread_create (new_thread, attr, start_routine, arg);
1224 }
1225
1226 int
1227 mono_gc_pthread_join (pthread_t thread, void **retval)
1228 {
1229         return pthread_join (thread, retval);
1230 }
1231
1232 int
1233 mono_gc_pthread_detach (pthread_t thread)
1234 {
1235         return pthread_detach (thread);
1236 }
1237
1238 #endif
1239
1240 #ifdef HOST_WIN32
1241 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved)
1242 {
1243 #ifdef USE_INCLUDED_LIBGC
1244         return GC_DllMain (module_handle, reason, reserved);
1245 #else
1246         return TRUE;
1247 #endif
1248 }
1249 #endif
1250
1251 #endif /* no Boehm GC */