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