mono/metadata/boehm-gc.c

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