Merge pull request #92 from konrad-kruczynski/master
[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_PRE_STOP_WORLD) 
394                 mono_thread_info_suspend_lock ();
395         else if (e == MONO_GC_EVENT_POST_START_WORLD)
396                 mono_thread_info_suspend_unlock ();
397         
398         if (e == MONO_GC_EVENT_START) {
399                 mono_perfcounters->gc_collections0++;
400                 mono_stats.major_gc_count ++;
401                 gc_start_time = mono_100ns_ticks ();
402         } else if (e == MONO_GC_EVENT_END) {
403                 guint64 heap_size = GC_get_heap_size ();
404                 guint64 used_size = heap_size - GC_get_free_bytes ();
405                 mono_perfcounters->gc_total_bytes = used_size;
406                 mono_perfcounters->gc_committed_bytes = heap_size;
407                 mono_perfcounters->gc_reserved_bytes = heap_size;
408                 mono_perfcounters->gc_gen0size = heap_size;
409                 mono_stats.major_gc_time_usecs += (mono_100ns_ticks () - gc_start_time) / 10;
410                 mono_trace_message (MONO_TRACE_GC, "gc took %d usecs", (mono_100ns_ticks () - gc_start_time) / 10);
411         }
412         mono_profiler_gc_event (e, 0);
413 }
414  
415 static void
416 on_gc_heap_resize (size_t new_size)
417 {
418         guint64 heap_size = GC_get_heap_size ();
419         mono_perfcounters->gc_committed_bytes = heap_size;
420         mono_perfcounters->gc_reserved_bytes = heap_size;
421         mono_perfcounters->gc_gen0size = heap_size;
422         mono_profiler_gc_heap_resize (new_size);
423 }
424
425 void
426 mono_gc_enable_events (void)
427 {
428         GC_notify_event = on_gc_notification;
429         GC_on_heap_resize = on_gc_heap_resize;
430 }
431
432 #else
433
434 void
435 mono_gc_enable_events (void)
436 {
437 }
438
439 #endif
440
441 int
442 mono_gc_register_root (char *start, size_t size, void *descr)
443 {
444         /* for some strange reason, they want one extra byte on the end */
445         GC_add_roots (start, start + size + 1);
446
447         return TRUE;
448 }
449
450 void
451 mono_gc_deregister_root (char* addr)
452 {
453 #ifndef HOST_WIN32
454         /* FIXME: libgc doesn't define this work win32 for some reason */
455         /* FIXME: No size info */
456         GC_remove_roots (addr, addr + sizeof (gpointer) + 1);
457 #endif
458 }
459
460 void
461 mono_gc_weak_link_add (void **link_addr, MonoObject *obj, gboolean track)
462 {
463         /* libgc requires that we use HIDE_POINTER... */
464         *link_addr = (void*)HIDE_POINTER (obj);
465         GC_GENERAL_REGISTER_DISAPPEARING_LINK (link_addr, obj);
466 }
467
468 void
469 mono_gc_weak_link_remove (void **link_addr)
470 {
471         GC_unregister_disappearing_link (link_addr);
472         *link_addr = NULL;
473 }
474
475 static gpointer
476 reveal_link (gpointer link_addr)
477 {
478         void **link_a = link_addr;
479         return REVEAL_POINTER (*link_a);
480 }
481
482 MonoObject*
483 mono_gc_weak_link_get (void **link_addr)
484 {
485         MonoObject *obj = GC_call_with_alloc_lock (reveal_link, link_addr);
486         if (obj == (MonoObject *) -1)
487                 return NULL;
488         return obj;
489 }
490
491 void*
492 mono_gc_make_descr_for_string (gsize *bitmap, int numbits)
493 {
494         return mono_gc_make_descr_from_bitmap (bitmap, numbits);
495 }
496
497 void*
498 mono_gc_make_descr_for_object (gsize *bitmap, int numbits, size_t obj_size)
499 {
500         return mono_gc_make_descr_from_bitmap (bitmap, numbits);
501 }
502
503 void*
504 mono_gc_make_descr_for_array (int vector, gsize *elem_bitmap, int numbits, size_t elem_size)
505 {
506         /* libgc has no usable support for arrays... */
507         return GC_NO_DESCRIPTOR;
508 }
509
510 void*
511 mono_gc_make_descr_from_bitmap (gsize *bitmap, int numbits)
512 {
513 #ifdef HAVE_GC_GCJ_MALLOC
514         /* It seems there are issues when the bitmap doesn't fit: play it safe */
515         if (numbits >= 30)
516                 return GC_NO_DESCRIPTOR;
517         else
518                 return (gpointer)GC_make_descriptor ((GC_bitmap)bitmap, numbits);
519 #else
520         return NULL;
521 #endif
522 }
523
524 void*
525 mono_gc_make_root_descr_all_refs (int numbits)
526 {
527         return NULL;
528 }
529
530 void*
531 mono_gc_alloc_fixed (size_t size, void *descr)
532 {
533         /* To help track down typed allocation bugs */
534         /*
535         static int count;
536         count ++;
537         if (count == atoi (getenv ("COUNT2")))
538                 printf ("HIT!\n");
539         if (count > atoi (getenv ("COUNT2")))
540                 return GC_MALLOC (size);
541         */
542
543         if (descr)
544                 return GC_MALLOC_EXPLICITLY_TYPED (size, (GC_descr)descr);
545         else
546                 return GC_MALLOC (size);
547 }
548
549 void
550 mono_gc_free_fixed (void* addr)
551 {
552 }
553
554 int
555 mono_gc_invoke_finalizers (void)
556 {
557         /* There is a bug in GC_invoke_finalizer () in versions <= 6.2alpha4:
558          * the 'mem_freed' variable is not initialized when there are no
559          * objects to finalize, which leads to strange behavior later on.
560          * The check is necessary to work around that bug.
561          */
562         if (GC_should_invoke_finalizers ())
563                 return GC_invoke_finalizers ();
564         return 0;
565 }
566
567 gboolean
568 mono_gc_pending_finalizers (void)
569 {
570         return GC_should_invoke_finalizers ();
571 }
572
573 /*
574  * LOCKING: Assumes the domain_finalizers lock is held.
575  */
576 static void
577 add_weak_track_handle_internal (MonoDomain *domain, MonoObject *obj, guint32 gchandle)
578 {
579         GSList *refs;
580
581         if (!domain->track_resurrection_objects_hash)
582                 domain->track_resurrection_objects_hash = g_hash_table_new (mono_aligned_addr_hash, NULL);
583
584         refs = g_hash_table_lookup (domain->track_resurrection_objects_hash, obj);
585         refs = g_slist_prepend (refs, GUINT_TO_POINTER (gchandle));
586         g_hash_table_insert (domain->track_resurrection_objects_hash, obj, refs);
587 }
588
589 void
590 mono_gc_add_weak_track_handle (MonoObject *obj, guint32 handle)
591 {
592         MonoDomain *domain;
593
594         if (!obj)
595                 return;
596
597         domain = mono_object_get_domain (obj);
598
599         mono_domain_finalizers_lock (domain);
600
601         add_weak_track_handle_internal (domain, obj, handle);
602
603         g_hash_table_insert (domain->track_resurrection_handles_hash, GUINT_TO_POINTER (handle), obj);
604
605         mono_domain_finalizers_unlock (domain);
606 }
607
608 /*
609  * LOCKING: Assumes the domain_finalizers lock is held.
610  */
611 static void
612 remove_weak_track_handle_internal (MonoDomain *domain, MonoObject *obj, guint32 gchandle)
613 {
614         GSList *refs;
615
616         if (!domain->track_resurrection_objects_hash)
617                 return;
618
619         refs = g_hash_table_lookup (domain->track_resurrection_objects_hash, obj);
620         refs = g_slist_remove (refs, GUINT_TO_POINTER (gchandle));
621         g_hash_table_insert (domain->track_resurrection_objects_hash, obj, refs);
622 }
623
624 void
625 mono_gc_change_weak_track_handle (MonoObject *old_obj, MonoObject *obj, guint32 gchandle)
626 {
627         MonoDomain *domain = mono_domain_get ();
628
629         mono_domain_finalizers_lock (domain);
630
631         if (old_obj)
632                 remove_weak_track_handle_internal (domain, old_obj, gchandle);
633         if (obj)
634                 add_weak_track_handle_internal (domain, obj, gchandle);
635
636         mono_domain_finalizers_unlock (domain);
637 }
638
639 void
640 mono_gc_remove_weak_track_handle (guint32 gchandle)
641 {
642         MonoDomain *domain = mono_domain_get ();
643         MonoObject *obj;
644
645         /* Clean our entries in the two hashes in MonoDomain */
646
647         mono_domain_finalizers_lock (domain);
648
649         /* Get the original object this handle pointed to */
650         obj = g_hash_table_lookup (domain->track_resurrection_handles_hash, GUINT_TO_POINTER (gchandle));
651         if (obj) {
652                 g_hash_table_remove (domain->track_resurrection_handles_hash, GUINT_TO_POINTER (gchandle));
653
654                 remove_weak_track_handle_internal (domain, obj, gchandle);
655         }
656
657         mono_domain_finalizers_unlock (domain);
658 }
659
660 GSList*
661 mono_gc_remove_weak_track_object (MonoDomain *domain, MonoObject *obj)
662 {
663         GSList *refs = NULL;
664
665         if (domain->track_resurrection_objects_hash) {
666                 refs = g_hash_table_lookup (domain->track_resurrection_objects_hash, obj);
667
668                 if (refs)
669                         /*
670                          * Since we don't run finalizers again for resurrected objects,
671                          * no need to keep these around.
672                          */
673                         g_hash_table_remove (domain->track_resurrection_objects_hash, obj);
674         }
675
676         return refs;
677 }
678
679 void
680 mono_gc_wbarrier_set_field (MonoObject *obj, gpointer field_ptr, MonoObject* value)
681 {
682         *(void**)field_ptr = value;
683 }
684
685 void
686 mono_gc_wbarrier_set_arrayref (MonoArray *arr, gpointer slot_ptr, MonoObject* value)
687 {
688         *(void**)slot_ptr = value;
689 }
690
691 void
692 mono_gc_wbarrier_arrayref_copy (gpointer dest_ptr, gpointer src_ptr, int count)
693 {
694         memmove (dest_ptr, src_ptr, count * sizeof (gpointer));
695 }
696
697 void
698 mono_gc_wbarrier_generic_store (gpointer ptr, MonoObject* value)
699 {
700         *(void**)ptr = value;
701 }
702
703 void
704 mono_gc_wbarrier_generic_nostore (gpointer ptr)
705 {
706 }
707
708 void
709 mono_gc_wbarrier_value_copy (gpointer dest, gpointer src, int count, MonoClass *klass)
710 {
711         memmove (dest, src, count * mono_class_value_size (klass, NULL));
712 }
713
714 void
715 mono_gc_wbarrier_object_copy (MonoObject* obj, MonoObject *src)
716 {
717         /* do not copy the sync state */
718         memcpy ((char*)obj + sizeof (MonoObject), (char*)src + sizeof (MonoObject),
719                         mono_object_class (obj)->instance_size - sizeof (MonoObject));
720 }
721
722 void
723 mono_gc_clear_domain (MonoDomain *domain)
724 {
725 }
726
727 int
728 mono_gc_get_suspend_signal (void)
729 {
730 #ifdef USE_INCLUDED_GC
731         return GC_get_suspend_signal ();
732 #else
733         return -1;
734 #endif
735 }
736
737 #if defined(USE_INCLUDED_LIBGC) && defined(USE_COMPILER_TLS) && defined(__linux__) && (defined(__i386__) || defined(__x86_64__))
738 extern __thread MONO_TLS_FAST void* GC_thread_tls;
739 #include "metadata-internals.h"
740
741 static int
742 shift_amount (int v)
743 {
744         int i = 0;
745         while (!(v & (1 << i)))
746                 i++;
747         return i;
748 }
749
750 enum {
751         ATYPE_FREEPTR,
752         ATYPE_FREEPTR_FOR_BOX,
753         ATYPE_NORMAL,
754         ATYPE_GCJ,
755         ATYPE_STRING,
756         ATYPE_NUM
757 };
758
759 static MonoMethod*
760 create_allocator (int atype, int offset)
761 {
762         int index_var, bytes_var, my_fl_var, my_entry_var;
763         guint32 no_freelist_branch, not_small_enough_branch = 0;
764         guint32 size_overflow_branch = 0;
765         MonoMethodBuilder *mb;
766         MonoMethod *res;
767         MonoMethodSignature *csig;
768         AllocatorWrapperInfo *info;
769
770         if (atype == ATYPE_STRING) {
771                 csig = mono_metadata_signature_alloc (mono_defaults.corlib, 2);
772                 csig->ret = &mono_defaults.string_class->byval_arg;
773                 csig->params [0] = &mono_defaults.int_class->byval_arg;
774                 csig->params [1] = &mono_defaults.int32_class->byval_arg;
775         } else {
776                 csig = mono_metadata_signature_alloc (mono_defaults.corlib, 1);
777                 csig->ret = &mono_defaults.object_class->byval_arg;
778                 csig->params [0] = &mono_defaults.int_class->byval_arg;
779         }
780
781         mb = mono_mb_new (mono_defaults.object_class, "Alloc", MONO_WRAPPER_ALLOC);
782         bytes_var = mono_mb_add_local (mb, &mono_defaults.int32_class->byval_arg);
783         if (atype == ATYPE_STRING) {
784                 /* a string alloator method takes the args: (vtable, len) */
785                 /* bytes = (sizeof (MonoString) + ((len + 1) * 2)); */
786                 mono_mb_emit_ldarg (mb, 1);
787                 mono_mb_emit_icon (mb, 1);
788                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
789                 mono_mb_emit_icon (mb, 1);
790                 mono_mb_emit_byte (mb, MONO_CEE_SHL);
791                 // sizeof (MonoString) might include padding
792                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoString, chars));
793                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
794                 mono_mb_emit_stloc (mb, bytes_var);
795         } else {
796                 /* bytes = vtable->klass->instance_size */
797                 mono_mb_emit_ldarg (mb, 0);
798                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoVTable, klass));
799                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
800                 mono_mb_emit_byte (mb, MONO_CEE_LDIND_I);
801                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoClass, instance_size));
802                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
803                 /* FIXME: assert instance_size stays a 4 byte integer */
804                 mono_mb_emit_byte (mb, MONO_CEE_LDIND_U4);
805                 mono_mb_emit_stloc (mb, bytes_var);
806         }
807
808         /* this is needed for strings/arrays only as the other big types are never allocated with this method */
809         if (atype == ATYPE_STRING) {
810                 /* check for size */
811                 /* if (!SMALL_ENOUGH (bytes)) jump slow_path;*/
812                 mono_mb_emit_ldloc (mb, bytes_var);
813                 mono_mb_emit_icon (mb, (NFREELISTS-1) * GRANULARITY);
814                 not_small_enough_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BGT_UN_S);
815                 /* check for overflow */
816                 mono_mb_emit_ldloc (mb, bytes_var);
817                 mono_mb_emit_icon (mb, sizeof (MonoString));
818                 size_overflow_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLE_UN_S);
819         }
820
821         /* int index = INDEX_FROM_BYTES(bytes); */
822         index_var = mono_mb_add_local (mb, &mono_defaults.int32_class->byval_arg);
823         
824         mono_mb_emit_ldloc (mb, bytes_var);
825         mono_mb_emit_icon (mb, GRANULARITY - 1);
826         mono_mb_emit_byte (mb, MONO_CEE_ADD);
827         mono_mb_emit_icon (mb, shift_amount (GRANULARITY));
828         mono_mb_emit_byte (mb, MONO_CEE_SHR_UN);
829         mono_mb_emit_icon (mb, shift_amount (sizeof (gpointer)));
830         mono_mb_emit_byte (mb, MONO_CEE_SHL);
831         /* index var is already adjusted into bytes */
832         mono_mb_emit_stloc (mb, index_var);
833
834         my_fl_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
835         my_entry_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
836         /* my_fl = ((GC_thread)tsd) -> ptrfree_freelists + index; */
837         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
838         mono_mb_emit_byte (mb, 0x0D); /* CEE_MONO_TLS */
839         mono_mb_emit_i4 (mb, offset);
840         if (atype == ATYPE_FREEPTR || atype == ATYPE_FREEPTR_FOR_BOX || atype == ATYPE_STRING)
841                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, ptrfree_freelists));
842         else if (atype == ATYPE_NORMAL)
843                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, normal_freelists));
844         else if (atype == ATYPE_GCJ)
845                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (struct GC_Thread_Rep, gcj_freelists));
846         else
847                 g_assert_not_reached ();
848         mono_mb_emit_byte (mb, MONO_CEE_ADD);
849         mono_mb_emit_ldloc (mb, index_var);
850         mono_mb_emit_byte (mb, MONO_CEE_ADD);
851         mono_mb_emit_stloc (mb, my_fl_var);
852
853         /* my_entry = *my_fl; */
854         mono_mb_emit_ldloc (mb, my_fl_var);
855         mono_mb_emit_byte (mb, MONO_CEE_LDIND_I);
856         mono_mb_emit_stloc (mb, my_entry_var);
857
858         /* if (EXPECT((word)my_entry >= HBLKSIZE, 1)) { */
859         mono_mb_emit_ldloc (mb, my_entry_var);
860         mono_mb_emit_icon (mb, HBLKSIZE);
861         no_freelist_branch = mono_mb_emit_short_branch (mb, MONO_CEE_BLT_UN_S);
862
863         /* ptr_t next = obj_link(my_entry); *my_fl = next; */
864         mono_mb_emit_ldloc (mb, my_fl_var);
865         mono_mb_emit_ldloc (mb, my_entry_var);
866         mono_mb_emit_byte (mb, MONO_CEE_LDIND_I);
867         mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
868
869         /* set the vtable and clear the words in the object */
870         mono_mb_emit_ldloc (mb, my_entry_var);
871         mono_mb_emit_ldarg (mb, 0);
872         mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
873
874         if (atype == ATYPE_FREEPTR) {
875                 int start_var, end_var, start_loop;
876                 /* end = my_entry + bytes; start = my_entry + sizeof (gpointer);
877                  */
878                 start_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
879                 end_var = mono_mb_add_local (mb, &mono_defaults.int_class->byval_arg);
880                 mono_mb_emit_ldloc (mb, my_entry_var);
881                 mono_mb_emit_ldloc (mb, bytes_var);
882                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
883                 mono_mb_emit_stloc (mb, end_var);
884                 mono_mb_emit_ldloc (mb, my_entry_var);
885                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoObject, synchronisation));
886                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
887                 mono_mb_emit_stloc (mb, start_var);
888                 /*
889                  * do {
890                  *      *start++ = NULL;
891                  * } while (start < end);
892                  */
893                 start_loop = mono_mb_get_label (mb);
894                 mono_mb_emit_ldloc (mb, start_var);
895                 mono_mb_emit_icon (mb, 0);
896                 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
897                 mono_mb_emit_ldloc (mb, start_var);
898                 mono_mb_emit_icon (mb, sizeof (gpointer));
899                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
900                 mono_mb_emit_stloc (mb, start_var);
901
902                 mono_mb_emit_ldloc (mb, start_var);
903                 mono_mb_emit_ldloc (mb, end_var);
904                 mono_mb_emit_byte (mb, MONO_CEE_BLT_UN_S);
905                 mono_mb_emit_byte (mb, start_loop - (mono_mb_get_label (mb) + 1));
906         } else if (atype == ATYPE_FREEPTR_FOR_BOX || atype == ATYPE_STRING) {
907                 /* need to clear just the sync pointer */
908                 mono_mb_emit_ldloc (mb, my_entry_var);
909                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoObject, synchronisation));
910                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
911                 mono_mb_emit_icon (mb, 0);
912                 mono_mb_emit_byte (mb, MONO_CEE_STIND_I);
913         }
914
915         if (atype == ATYPE_STRING) {
916                 /* need to set length and clear the last char */
917                 /* s->length = len; */
918                 mono_mb_emit_ldloc (mb, my_entry_var);
919                 mono_mb_emit_icon (mb, G_STRUCT_OFFSET (MonoString, length));
920                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
921                 mono_mb_emit_ldarg (mb, 1);
922                 mono_mb_emit_byte (mb, MONO_CEE_STIND_I4);
923                 /* s->chars [len] = 0; */
924                 mono_mb_emit_ldloc (mb, my_entry_var);
925                 mono_mb_emit_ldloc (mb, bytes_var);
926                 mono_mb_emit_icon (mb, 2);
927                 mono_mb_emit_byte (mb, MONO_CEE_SUB);
928                 mono_mb_emit_byte (mb, MONO_CEE_ADD);
929                 mono_mb_emit_icon (mb, 0);
930                 mono_mb_emit_byte (mb, MONO_CEE_STIND_I2);
931         }
932
933         /* return my_entry; */
934         mono_mb_emit_ldloc (mb, my_entry_var);
935         mono_mb_emit_byte (mb, MONO_CEE_RET);
936         
937         mono_mb_patch_short_branch (mb, no_freelist_branch);
938         if (not_small_enough_branch > 0)
939                 mono_mb_patch_short_branch (mb, not_small_enough_branch);
940         if (size_overflow_branch > 0)
941                 mono_mb_patch_short_branch (mb, size_overflow_branch);
942         /* the slow path: we just call back into the runtime */
943         if (atype == ATYPE_STRING) {
944                 mono_mb_emit_ldarg (mb, 1);
945                 mono_mb_emit_icall (mb, mono_string_alloc);
946         } else {
947                 mono_mb_emit_ldarg (mb, 0);
948                 mono_mb_emit_icall (mb, mono_object_new_specific);
949         }
950
951         mono_mb_emit_byte (mb, MONO_CEE_RET);
952
953         res = mono_mb_create_method (mb, csig, 8);
954         mono_mb_free (mb);
955         mono_method_get_header (res)->init_locals = FALSE;
956
957         info = mono_image_alloc0 (mono_defaults.corlib, sizeof (AllocatorWrapperInfo));
958         info->gc_name = "boehm";
959         info->alloc_type = atype;
960         mono_marshal_set_wrapper_info (res, info);
961
962         return res;
963 }
964
965 static MonoMethod* alloc_method_cache [ATYPE_NUM];
966
967 gboolean
968 mono_gc_is_critical_method (MonoMethod *method)
969 {
970         int i;
971
972         for (i = 0; i < ATYPE_NUM; ++i)
973                 if (method == alloc_method_cache [i])
974                         return TRUE;
975
976         return FALSE;
977 }
978
979 /*
980  * If possible, generate a managed method that can quickly allocate objects in class
981  * @klass. The method will typically have an thread-local inline allocation sequence.
982  * The signature of the called method is:
983  *      object allocate (MonoVTable *vtable)
984  * Some of the logic here is similar to mono_class_get_allocation_ftn () i object.c,
985  * keep in sync.
986  * The thread local alloc logic is taken from libgc/pthread_support.c.
987  */
988
989 MonoMethod*
990 mono_gc_get_managed_allocator (MonoVTable *vtable, gboolean for_box)
991 {
992         int offset = -1;
993         int atype;
994         MonoClass *klass = vtable->klass;
995         MONO_THREAD_VAR_OFFSET (GC_thread_tls, offset);
996
997         /*g_print ("thread tls: %d\n", offset);*/
998         if (offset == -1)
999                 return NULL;
1000         if (!SMALL_ENOUGH (klass->instance_size))
1001                 return NULL;
1002         if (mono_class_has_finalizer (klass) || klass->marshalbyref || (mono_profiler_get_events () & MONO_PROFILE_ALLOCATIONS))
1003                 return NULL;
1004         if (klass->rank)
1005                 return NULL;
1006         if (klass->byval_arg.type == MONO_TYPE_STRING) {
1007                 atype = ATYPE_STRING;
1008         } else if (!klass->has_references) {
1009                 if (for_box)
1010                         atype = ATYPE_FREEPTR_FOR_BOX;
1011                 else
1012                         atype = ATYPE_FREEPTR;
1013         } else {
1014                 return NULL;
1015                 /*
1016                  * disabled because we currently do a runtime choice anyway, to
1017                  * deal with multiple appdomains.
1018                 if (vtable->gc_descr != GC_NO_DESCRIPTOR)
1019                         atype = ATYPE_GCJ;
1020                 else
1021                         atype = ATYPE_NORMAL;
1022                 */
1023         }
1024         return mono_gc_get_managed_allocator_by_type (atype);
1025 }
1026
1027 MonoMethod*
1028 mono_gc_get_managed_array_allocator (MonoVTable *vtable, int rank)
1029 {
1030         return NULL;
1031 }
1032
1033 /**
1034  * mono_gc_get_managed_allocator_by_type:
1035  *
1036  *   Return a managed allocator method corresponding to allocator type ATYPE.
1037  */
1038 MonoMethod*
1039 mono_gc_get_managed_allocator_by_type (int atype)
1040 {
1041         int offset = -1;
1042         MonoMethod *res;
1043         MONO_THREAD_VAR_OFFSET (GC_thread_tls, offset);
1044
1045         mono_loader_lock ();
1046         res = alloc_method_cache [atype];
1047         if (!res)
1048                 res = alloc_method_cache [atype] = create_allocator (atype, offset);
1049         mono_loader_unlock ();
1050         return res;
1051 }
1052
1053 guint32
1054 mono_gc_get_managed_allocator_types (void)
1055 {
1056         return ATYPE_NUM;
1057 }
1058
1059 MonoMethod*
1060 mono_gc_get_write_barrier (void)
1061 {
1062         g_assert_not_reached ();
1063         return NULL;
1064 }
1065
1066 #else
1067
1068 gboolean
1069 mono_gc_is_critical_method (MonoMethod *method)
1070 {
1071         return FALSE;
1072 }
1073
1074 MonoMethod*
1075 mono_gc_get_managed_allocator (MonoVTable *vtable, gboolean for_box)
1076 {
1077         return NULL;
1078 }
1079
1080 MonoMethod*
1081 mono_gc_get_managed_array_allocator (MonoVTable *vtable, int rank)
1082 {
1083         return NULL;
1084 }
1085
1086 MonoMethod*
1087 mono_gc_get_managed_allocator_by_type (int atype)
1088 {
1089         return NULL;
1090 }
1091
1092 guint32
1093 mono_gc_get_managed_allocator_types (void)
1094 {
1095         return 0;
1096 }
1097
1098 MonoMethod*
1099 mono_gc_get_write_barrier (void)
1100 {
1101         g_assert_not_reached ();
1102         return NULL;
1103 }
1104
1105 #endif
1106
1107 const char *
1108 mono_gc_get_gc_name (void)
1109 {
1110         return "boehm";
1111 }
1112
1113 void*
1114 mono_gc_invoke_with_gc_lock (MonoGCLockedCallbackFunc func, void *data)
1115 {
1116         return GC_call_with_alloc_lock (func, data);
1117 }
1118
1119 char*
1120 mono_gc_get_description (void)
1121 {
1122         return g_strdup (DEFAULT_GC_NAME);
1123 }
1124
1125 void
1126 mono_gc_set_desktop_mode (void)
1127 {
1128         GC_dont_expand = 1;
1129 }
1130
1131 gboolean
1132 mono_gc_is_moving (void)
1133 {
1134         return FALSE;
1135 }
1136
1137 gboolean
1138 mono_gc_is_disabled (void)
1139 {
1140         if (GC_dont_gc || g_getenv ("GC_DONT_GC"))
1141                 return TRUE;
1142         else
1143                 return FALSE;
1144 }
1145
1146 void
1147 mono_gc_wbarrier_value_copy_bitmap (gpointer _dest, gpointer _src, int size, unsigned bitmap)
1148 {
1149         g_assert_not_reached ();
1150 }
1151
1152
1153 guint8*
1154 mono_gc_get_card_table (int *shift_bits, gpointer *card_mask)
1155 {
1156         g_assert_not_reached ();
1157         return NULL;
1158 }
1159
1160 void*
1161 mono_gc_get_nursery (int *shift_bits, size_t *size)
1162 {
1163         return NULL;
1164 }
1165
1166 gboolean
1167 mono_gc_precise_stack_mark_enabled (void)
1168 {
1169         return FALSE;
1170 }
1171
1172 FILE *
1173 mono_gc_get_logfile (void)
1174 {
1175         return NULL;
1176 }
1177
1178 void
1179 mono_gc_conservatively_scan_area (void *start, void *end)
1180 {
1181         g_assert_not_reached ();
1182 }
1183
1184 void *
1185 mono_gc_scan_object (void *obj)
1186 {
1187         g_assert_not_reached ();
1188         return NULL;
1189 }
1190
1191 gsize*
1192 mono_gc_get_bitmap_for_descr (void *descr, int *numbits)
1193 {
1194         g_assert_not_reached ();
1195         return NULL;
1196 }
1197
1198 void
1199 mono_gc_set_gc_callbacks (MonoGCCallbacks *callbacks)
1200 {
1201 }
1202
1203 /*
1204  * These will call the redefined versions in libgc.
1205  */
1206
1207 #ifndef HOST_WIN32
1208
1209 int
1210 mono_gc_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
1211 {
1212         return mono_threads_pthread_create (new_thread, attr, start_routine, arg);
1213 }
1214
1215 int
1216 mono_gc_pthread_join (pthread_t thread, void **retval)
1217 {
1218         return pthread_join (thread, retval);
1219 }
1220
1221 int
1222 mono_gc_pthread_detach (pthread_t thread)
1223 {
1224         return pthread_detach (thread);
1225 }
1226
1227 #endif
1228
1229 #ifdef HOST_WIN32
1230 BOOL APIENTRY mono_gc_dllmain (HMODULE module_handle, DWORD reason, LPVOID reserved)
1231 {
1232 #ifdef USE_INCLUDED_LIBGC
1233         return GC_DllMain (module_handle, reason, reserved);
1234 #else
1235         return TRUE;
1236 #endif
1237 }
1238 #endif
1239
1240 #endif /* no Boehm GC */