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