mono/metadata/gc.c

   1 /*
   2  * metadata/gc.c: GC icalls.
   3  *
   4  * Author: Paolo Molaro <lupus@ximian.com>
   5  *
   6  * Copyright 2002-2003 Ximian, Inc (http://www.ximian.com)
   7  * Copyright 2004-2009 Novell, Inc (http://www.novell.com)
   8  * Copyright 2012 Xamarin Inc (http://www.xamarin.com)
   9  */
  10
  11 #include <config.h>
  12 #include <glib.h>
  13 #include <string.h>
  14
  15 #include <mono/metadata/gc-internal.h>
  16 #include <mono/metadata/mono-gc.h>
  17 #include <mono/metadata/threads.h>
  18 #include <mono/metadata/tabledefs.h>
  19 #include <mono/metadata/exception.h>
  20 #include <mono/metadata/profiler-private.h>
  21 #include <mono/metadata/domain-internals.h>
  22 #include <mono/metadata/class-internals.h>
  23 #include <mono/metadata/metadata-internals.h>
  24 #include <mono/metadata/mono-mlist.h>
  25 #include <mono/metadata/threadpool.h>
  26 #include <mono/metadata/threadpool-internals.h>
  27 #include <mono/metadata/threads-types.h>
  28 #include <mono/sgen/sgen-conf.h>
  29 #include <mono/utils/mono-logger-internal.h>
  30 #include <mono/metadata/gc-internal.h>
  31 #include <mono/metadata/marshal.h> /* for mono_delegate_free_ftnptr () */
  32 #include <mono/metadata/attach.h>
  33 #include <mono/metadata/console-io.h>
  34 #include <mono/utils/mono-semaphore.h>
  35 #include <mono/utils/mono-memory-model.h>
  36 #include <mono/utils/mono-counters.h>
  37 #include <mono/utils/mono-time.h>
  38 #include <mono/utils/dtrace.h>
  39 #include <mono/utils/mono-threads.h>
  40 #include <mono/utils/atomic.h>
  41
  42 #ifndef HOST_WIN32
  43 #include <pthread.h>
  44 #endif
  45
  46 typedef struct DomainFinalizationReq {
  47         MonoDomain *domain;
  48         HANDLE done_event;
  49 } DomainFinalizationReq;
  50
  51 #ifdef PLATFORM_WINCE /* FIXME: add accessors to gc.dll API */
  52 extern void (*__imp_GC_finalizer_notifier)(void);
  53 #define GC_finalizer_notifier __imp_GC_finalizer_notifier
  54 extern int __imp_GC_finalize_on_demand;
  55 #define GC_finalize_on_demand __imp_GC_finalize_on_demand
  56 #endif
  57
  58 static gboolean gc_disabled = FALSE;
  59
  60 static gboolean finalizing_root_domain = FALSE;
  61
  62 gboolean log_finalizers = FALSE;
  63 gboolean do_not_finalize = FALSE;
  64
  65 #define mono_finalizer_lock() mono_mutex_lock (&finalizer_mutex)
  66 #define mono_finalizer_unlock() mono_mutex_unlock (&finalizer_mutex)
  67 static mono_mutex_t finalizer_mutex;
  68 static mono_mutex_t reference_queue_mutex;
  69
  70 static GSList *domains_to_finalize= NULL;
  71 static MonoMList *threads_to_finalize = NULL;
  72
  73 static gboolean finalizer_thread_exited;
  74 /* Uses finalizer_mutex */
  75 static mono_cond_t exited_cond;
  76
  77 static MonoInternalThread *gc_thread;
  78
  79 static void object_register_finalizer (MonoObject *obj, void (*callback)(void *, void*));
  80
  81 static void mono_gchandle_set_target (guint32 gchandle, MonoObject *obj);
  82
  83 static void reference_queue_proccess_all (void);
  84 static void mono_reference_queue_cleanup (void);
  85 static void reference_queue_clear_for_domain (MonoDomain *domain);
  86 static HANDLE pending_done_event;
  87
  88 static guint32
  89 guarded_wait (HANDLE handle, guint32 timeout, gboolean alertable)
  90 {
  91         guint32 result;
  92
  93         MONO_PREPARE_BLOCKING
  94         result = WaitForSingleObjectEx (handle, timeout, alertable);
  95         MONO_FINISH_BLOCKING
  96
  97         return result;
  98 }
  99
 100 static void
 101 add_thread_to_finalize (MonoInternalThread *thread)
 102 {
 103         mono_finalizer_lock ();
 104         if (!threads_to_finalize)
 105                 MONO_GC_REGISTER_ROOT_SINGLE (threads_to_finalize);
 106         threads_to_finalize = mono_mlist_append (threads_to_finalize, (MonoObject*)thread);
 107         mono_finalizer_unlock ();
 108 }
 109
 110 static gboolean suspend_finalizers = FALSE;
 111 /*
 112  * actually, we might want to queue the finalize requests in a separate thread,
 113  * but we need to be careful about the execution domain of the thread...
 114  */
 115 void
 116 mono_gc_run_finalize (void *obj, void *data)
 117 {
 118         if (do_not_finalize)
 119                 return;
 120
 121         MonoObject *exc = NULL;
 122         MonoObject *o;
 123 #ifndef HAVE_SGEN_GC
 124         MonoObject *o2;
 125 #endif
 126         MonoMethod* finalizer = NULL;
 127         MonoDomain *caller_domain = mono_domain_get ();
 128         MonoDomain *domain;
 129         RuntimeInvokeFunction runtime_invoke;
 130
 131         o = (MonoObject*)((char*)obj + GPOINTER_TO_UINT (data));
 132
 133         if (log_finalizers)
 134                 g_log ("mono-gc-finalizers", G_LOG_LEVEL_DEBUG, "<%s at %p> Starting finalizer checks.", o->vtable->klass->name, o);
 135
 136         if (suspend_finalizers)
 137                 return;
 138
 139         domain = o->vtable->domain;
 140
 141 #ifndef HAVE_SGEN_GC
 142         mono_domain_finalizers_lock (domain);
 143
 144         o2 = g_hash_table_lookup (domain->finalizable_objects_hash, o);
 145
 146         mono_domain_finalizers_unlock (domain);
 147
 148         if (!o2)
 149                 /* Already finalized somehow */
 150                 return;
 151 #endif
 152
 153         /* make sure the finalizer is not called again if the object is resurrected */
 154         object_register_finalizer (obj, NULL);
 155
 156         if (log_finalizers)
 157                 g_log ("mono-gc-finalizers", G_LOG_LEVEL_MESSAGE, "<%s at %p> Registered finalizer as processed.", o->vtable->klass->name, o);
 158
 159         if (o->vtable->klass == mono_defaults.internal_thread_class) {
 160                 MonoInternalThread *t = (MonoInternalThread*)o;
 161
 162                 if (mono_gc_is_finalizer_internal_thread (t))
 163                         /* Avoid finalizing ourselves */
 164                         return;
 165
 166                 if (t->threadpool_thread && finalizing_root_domain) {
 167                         /* Don't finalize threadpool threads when
 168                            shutting down - they're finalized when the
 169                            threadpool shuts down. */
 170                         add_thread_to_finalize (t);
 171                         return;
 172                 }
 173         }
 174
 175         if (o->vtable->klass->image == mono_defaults.corlib && !strcmp (o->vtable->klass->name, "DynamicMethod") && finalizing_root_domain) {
 176                 /*
 177                  * These can't be finalized during unloading/shutdown, since that would
 178                  * free the native code which can still be referenced by other
 179                  * finalizers.
 180                  * FIXME: This is not perfect, objects dying at the same time as
 181                  * dynamic methods can still reference them even when !shutdown.
 182                  */
 183                 return;
 184         }
 185
 186         if (mono_runtime_get_no_exec ())
 187                 return;
 188
 189         /* speedup later... and use a timeout */
 190         /* g_print ("Finalize run on %p %s.%s\n", o, mono_object_class (o)->name_space, mono_object_class (o)->name); */
 191
 192         /* Use _internal here, since this thread can enter a doomed appdomain */
 193         mono_domain_set_internal (mono_object_domain (o));
 194
 195         /* delegates that have a native function pointer allocated are
 196          * registered for finalization, but they don't have a Finalize
 197          * method, because in most cases it's not needed and it's just a waste.
 198          */
 199         if (o->vtable->klass->delegate) {
 200                 MonoDelegate* del = (MonoDelegate*)o;
 201                 if (del->delegate_trampoline)
 202                         mono_delegate_free_ftnptr ((MonoDelegate*)o);
 203                 mono_domain_set_internal (caller_domain);
 204                 return;
 205         }
 206
 207         finalizer = mono_class_get_finalizer (o->vtable->klass);
 208
 209 #ifndef DISABLE_COM
 210         /* If object has a CCW but has no finalizer, it was only
 211          * registered for finalization in order to free the CCW.
 212          * Else it needs the regular finalizer run.
 213          * FIXME: what to do about ressurection and suppression
 214          * of finalizer on object with CCW.
 215          */
 216         if (mono_marshal_free_ccw (o) && !finalizer) {
 217                 mono_domain_set_internal (caller_domain);
 218                 return;
 219         }
 220 #endif
 221
 222         /*
 223          * To avoid the locking plus the other overhead of mono_runtime_invoke (),
 224          * create and precompile a wrapper which calls the finalize method using
 225          * a CALLVIRT.
 226          */
 227         if (log_finalizers)
 228                 g_log ("mono-gc-finalizers", G_LOG_LEVEL_MESSAGE, "<%s at %p> Compiling finalizer.", o->vtable->klass->name, o);
 229
 230         if (!domain->finalize_runtime_invoke) {
 231                 MonoMethod *invoke = mono_marshal_get_runtime_invoke (mono_class_get_method_from_name_flags (mono_defaults.object_class, "Finalize", 0, 0), TRUE);
 232
 233                 domain->finalize_runtime_invoke = mono_compile_method (invoke);
 234         }
 235
 236         runtime_invoke = domain->finalize_runtime_invoke;
 237
 238         mono_runtime_class_init (o->vtable);
 239
 240         if (G_UNLIKELY (MONO_GC_FINALIZE_INVOKE_ENABLED ())) {
 241                 MONO_GC_FINALIZE_INVOKE ((unsigned long)o, mono_object_get_size (o),
 242                                 o->vtable->klass->name_space, o->vtable->klass->name);
 243         }
 244
 245         if (log_finalizers)
 246                 g_log ("mono-gc-finalizers", G_LOG_LEVEL_MESSAGE, "<%s at %p> Calling finalizer.", o->vtable->klass->name, o);
 247
 248         runtime_invoke (o, NULL, &exc, NULL);
 249
 250         if (log_finalizers)
 251                 g_log ("mono-gc-finalizers", G_LOG_LEVEL_MESSAGE, "<%s at %p> Returned from finalizer.", o->vtable->klass->name, o);
 252
 253         if (exc)
 254                 mono_internal_thread_unhandled_exception (exc);
 255
 256         mono_domain_set_internal (caller_domain);
 257 }
 258
 259 void
 260 mono_gc_finalize_threadpool_threads (void)
 261 {
 262         while (threads_to_finalize) {
 263                 MonoInternalThread *thread = (MonoInternalThread*) mono_mlist_get_data (threads_to_finalize);
 264
 265                 /* Force finalization of the thread. */
 266                 thread->threadpool_thread = FALSE;
 267                 mono_object_register_finalizer ((MonoObject*)thread);
 268
 269                 mono_gc_run_finalize (thread, NULL);
 270
 271                 threads_to_finalize = mono_mlist_next (threads_to_finalize);
 272         }
 273 }
 274
 275 gpointer
 276 mono_gc_out_of_memory (size_t size)
 277 {
 278         /*
 279          * we could allocate at program startup some memory that we could release
 280          * back to the system at this point if we're really low on memory (ie, size is
 281          * lower than the memory we set apart)
 282          */
 283         mono_raise_exception (mono_domain_get ()->out_of_memory_ex);
 284
 285         return NULL;
 286 }
 287
 288 /*
 289  * Some of our objects may point to a different address than the address returned by GC_malloc()
 290  * (because of the GetHashCode hack), but we need to pass the real address to register_finalizer.
 291  * This also means that in the callback we need to adjust the pointer to get back the real
 292  * MonoObject*.
 293  * We also need to be consistent in the use of the GC_debug* variants of malloc and register_finalizer,
 294  * since that, too, can cause the underlying pointer to be offset.
 295  */
 296 static void
 297 object_register_finalizer (MonoObject *obj, void (*callback)(void *, void*))
 298 {
 299         MonoDomain *domain;
 300
 301         if (obj == NULL)
 302                 mono_raise_exception (mono_get_exception_argument_null ("obj"));
 303
 304         domain = obj->vtable->domain;
 305
 306 #if HAVE_BOEHM_GC
 307         if (mono_domain_is_unloading (domain) && (callback != NULL))
 308                 /*
 309                  * Can't register finalizers in a dying appdomain, since they
 310                  * could be invoked after the appdomain has been unloaded.
 311                  */
 312                 return;
 313
 314         mono_domain_finalizers_lock (domain);
 315
 316         if (callback)
 317                 g_hash_table_insert (domain->finalizable_objects_hash, obj, obj);
 318         else
 319                 g_hash_table_remove (domain->finalizable_objects_hash, obj);
 320
 321         mono_domain_finalizers_unlock (domain);
 322
 323         mono_gc_register_for_finalization (obj, callback);
 324 #elif defined(HAVE_SGEN_GC)
 325         /*
 326          * If we register finalizers for domains that are unloading we might
 327          * end up running them while or after the domain is being cleared, so
 328          * the objects will not be valid anymore.
 329          */
 330         if (!mono_domain_is_unloading (domain))
 331                 mono_gc_register_for_finalization (obj, callback);
 332 #endif
 333 }
 334
 335 /**
 336  * mono_object_register_finalizer:
 337  * @obj: object to register
 338  *
 339  * Records that object @obj has a finalizer, this will call the
 340  * Finalize method when the garbage collector disposes the object.
 341  *
 342  */
 343 void
 344 mono_object_register_finalizer (MonoObject *obj)
 345 {
 346         /* g_print ("Registered finalizer on %p %s.%s\n", obj, mono_object_class (obj)->name_space, mono_object_class (obj)->name); */
 347         object_register_finalizer (obj, mono_gc_run_finalize);
 348 }
 349
 350 /**
 351  * mono_domain_finalize:
 352  * @domain: the domain to finalize
 353  * @timeout: msects to wait for the finalization to complete, -1 to wait indefinitely
 354  *
 355  *  Request finalization of all finalizable objects inside @domain. Wait
 356  * @timeout msecs for the finalization to complete.
 357  *
 358  * Returns: TRUE if succeeded, FALSE if there was a timeout
 359  */
 360
 361 gboolean
 362 mono_domain_finalize (MonoDomain *domain, guint32 timeout)
 363 {
 364         DomainFinalizationReq *req;
 365         guint32 res;
 366         HANDLE done_event;
 367         MonoInternalThread *thread = mono_thread_internal_current ();
 368
 369 #if defined(__native_client__)
 370         return FALSE;
 371 #endif
 372
 373         if (mono_thread_internal_current () == gc_thread)
 374                 /* We are called from inside a finalizer, not much we can do here */
 375                 return FALSE;
 376
 377         /*
 378          * No need to create another thread 'cause the finalizer thread
 379          * is still working and will take care of running the finalizers
 380          */
 381
 382         if (gc_disabled)
 383                 return TRUE;
 384
 385         /* We don't support domain finalization without a GC */
 386         if (mono_gc_is_null ())
 387                 return FALSE;
 388
 389         mono_gc_collect (mono_gc_max_generation ());
 390
 391         done_event = CreateEvent (NULL, TRUE, FALSE, NULL);
 392         if (done_event == NULL) {
 393                 return FALSE;
 394         }
 395
 396         req = g_new0 (DomainFinalizationReq, 1);
 397         req->domain = domain;
 398         req->done_event = done_event;
 399
 400         if (domain == mono_get_root_domain ())
 401                 finalizing_root_domain = TRUE;
 402
 403         mono_finalizer_lock ();
 404
 405         domains_to_finalize = g_slist_append (domains_to_finalize, req);
 406
 407         mono_finalizer_unlock ();
 408
 409         /* Tell the finalizer thread to finalize this appdomain */
 410         mono_gc_finalize_notify ();
 411
 412         if (timeout == -1)
 413                 timeout = INFINITE;
 414
 415         while (TRUE) {
 416                 res = guarded_wait (done_event, timeout, TRUE);
 417                 /* printf ("WAIT RES: %d.\n", res); */
 418
 419                 if (res == WAIT_IO_COMPLETION) {
 420                         if ((thread->state & (ThreadState_StopRequested | ThreadState_SuspendRequested)) != 0)
 421                                 return FALSE;
 422                 } else if (res == WAIT_TIMEOUT) {
 423                         /* We leak the handle here */
 424                         return FALSE;
 425                 } else {
 426                         break;
 427                 }
 428         }
 429
 430         CloseHandle (done_event);
 431
 432         if (domain == mono_get_root_domain ()) {
 433                 mono_thread_pool_cleanup ();
 434                 mono_gc_finalize_threadpool_threads ();
 435         }
 436
 437         return TRUE;
 438 }
 439
 440 void
 441 ves_icall_System_GC_InternalCollect (int generation)
 442 {
 443         mono_gc_collect (generation);
 444 }
 445
 446 gint64
 447 ves_icall_System_GC_GetTotalMemory (MonoBoolean forceCollection)
 448 {
 449         if (forceCollection)
 450                 mono_gc_collect (mono_gc_max_generation ());
 451         return mono_gc_get_used_size ();
 452 }
 453
 454 void
 455 ves_icall_System_GC_KeepAlive (MonoObject *obj)
 456 {
 457         /*
 458          * Does nothing.
 459          */
 460 }
 461
 462 void
 463 ves_icall_System_GC_ReRegisterForFinalize (MonoObject *obj)
 464 {
 465         MONO_CHECK_ARG_NULL (obj,);
 466
 467         object_register_finalizer (obj, mono_gc_run_finalize);
 468 }
 469
 470 void
 471 ves_icall_System_GC_SuppressFinalize (MonoObject *obj)
 472 {
 473         MONO_CHECK_ARG_NULL (obj,);
 474
 475         /* delegates have no finalizers, but we register them to deal with the
 476          * unmanaged->managed trampoline. We don't let the user suppress it
 477          * otherwise we'd leak it.
 478          */
 479         if (obj->vtable->klass->delegate)
 480                 return;
 481
 482         /* FIXME: Need to handle case where obj has COM Callable Wrapper
 483          * generated for it that needs cleaned up, but user wants to suppress
 484          * their derived object finalizer. */
 485
 486         object_register_finalizer (obj, NULL);
 487 }
 488
 489 void
 490 ves_icall_System_GC_WaitForPendingFinalizers (void)
 491 {
 492         if (mono_gc_is_null ())
 493                 return;
 494
 495         if (!mono_gc_pending_finalizers ())
 496                 return;
 497
 498         if (mono_thread_internal_current () == gc_thread)
 499                 /* Avoid deadlocks */
 500                 return;
 501
 502         /*
 503         If the finalizer thread is not live, lets pretend no finalizers are pending since the current thread might
 504         be the one responsible for starting it up.
 505         */
 506         if (gc_thread == NULL)
 507                 return;
 508
 509         ResetEvent (pending_done_event);
 510         mono_gc_finalize_notify ();
 511         /* g_print ("Waiting for pending finalizers....\n"); */
 512         guarded_wait (pending_done_event, INFINITE, TRUE);
 513         /* g_print ("Done pending....\n"); */
 514 }
 515
 516 void
 517 ves_icall_System_GC_register_ephemeron_array (MonoObject *array)
 518 {
 519 #ifdef HAVE_SGEN_GC
 520         if (!mono_gc_ephemeron_array_add (array)) {
 521                 mono_set_pending_exception (mono_object_domain (array)->out_of_memory_ex);
 522                 return;
 523         }
 524 #endif
 525 }
 526
 527 MonoObject*
 528 ves_icall_System_GC_get_ephemeron_tombstone (void)
 529 {
 530         return mono_domain_get ()->ephemeron_tombstone;
 531 }
 532
 533 #define mono_allocator_lock() mono_mutex_lock (&allocator_section)
 534 #define mono_allocator_unlock() mono_mutex_unlock (&allocator_section)
 535 static mono_mutex_t allocator_section;
 536 static mono_mutex_t handle_section;
 537
 538 typedef enum {
 539         HANDLE_WEAK,
 540         HANDLE_WEAK_TRACK,
 541         HANDLE_NORMAL,
 542         HANDLE_PINNED
 543 } HandleType;
 544
 545 static HandleType mono_gchandle_get_type (guint32 gchandle);
 546
 547 MonoObject *
 548 ves_icall_System_GCHandle_GetTarget (guint32 handle)
 549 {
 550         return mono_gchandle_get_target (handle);
 551 }
 552
 553 /*
 554  * if type == -1, change the target of the handle, otherwise allocate a new handle.
 555  */
 556 guint32
 557 ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint32 type)
 558 {
 559         if (type == -1) {
 560                 mono_gchandle_set_target (handle, obj);
 561                 /* the handle doesn't change */
 562                 return handle;
 563         }
 564         switch (type) {
 565         case HANDLE_WEAK:
 566                 return mono_gchandle_new_weakref (obj, FALSE);
 567         case HANDLE_WEAK_TRACK:
 568                 return mono_gchandle_new_weakref (obj, TRUE);
 569         case HANDLE_NORMAL:
 570                 return mono_gchandle_new (obj, FALSE);
 571         case HANDLE_PINNED:
 572                 return mono_gchandle_new (obj, TRUE);
 573         default:
 574                 g_assert_not_reached ();
 575         }
 576         return 0;
 577 }
 578
 579 void
 580 ves_icall_System_GCHandle_FreeHandle (guint32 handle)
 581 {
 582         mono_gchandle_free (handle);
 583 }
 584
 585 gpointer
 586 ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle)
 587 {
 588         MonoObject *obj;
 589
 590         if (mono_gchandle_get_type (handle) != HANDLE_PINNED)
 591                 return (gpointer)-2;
 592         obj = mono_gchandle_get_target (handle);
 593         if (obj) {
 594                 MonoClass *klass = mono_object_class (obj);
 595                 if (klass == mono_defaults.string_class) {
 596                         return mono_string_chars ((MonoString*)obj);
 597                 } else if (klass->rank) {
 598                         return mono_array_addr ((MonoArray*)obj, char, 0);
 599                 } else {
 600                         /* the C# code will check and throw the exception */
 601                         /* FIXME: missing !klass->blittable test, see bug #61134 */
 602                         if ((klass->flags & TYPE_ATTRIBUTE_LAYOUT_MASK) == TYPE_ATTRIBUTE_AUTO_LAYOUT)
 603                                 return (gpointer)-1;
 604                         return (char*)obj + sizeof (MonoObject);
 605                 }
 606         }
 607         return NULL;
 608 }
 609
 610 MonoBoolean
 611 ves_icall_Mono_Runtime_SetGCAllowSynchronousMajor (MonoBoolean flag)
 612 {
 613         return mono_gc_set_allow_synchronous_major (flag);
 614 }
 615
 616 typedef struct {
 617         guint32  *bitmap;
 618         gpointer *entries;
 619         guint32   size;
 620         guint8    type;
 621         guint     slot_hint : 24; /* starting slot for search */
 622         /* 2^16 appdomains should be enough for everyone (though I know I'll regret this in 20 years) */
 623         /* we alloc this only for weak refs, since we can get the domain directly in the other cases */
 624         guint16  *domain_ids;
 625 } HandleData;
 626
 627 /* weak and weak-track arrays will be allocated in malloc memory
 628  */
 629 static HandleData gc_handles [] = {
 630         {NULL, NULL, 0, HANDLE_WEAK, 0},
 631         {NULL, NULL, 0, HANDLE_WEAK_TRACK, 0},
 632         {NULL, NULL, 0, HANDLE_NORMAL, 0},
 633         {NULL, NULL, 0, HANDLE_PINNED, 0}
 634 };
 635
 636 #define lock_handles(handles) mono_mutex_lock (&handle_section)
 637 #define unlock_handles(handles) mono_mutex_unlock (&handle_section)
 638
 639 static int
 640 find_first_unset (guint32 bitmap)
 641 {
 642         int i;
 643         for (i = 0; i < 32; ++i) {
 644                 if (!(bitmap & (1 << i)))
 645                         return i;
 646         }
 647         return -1;
 648 }
 649
 650 static void*
 651 make_root_descr_all_refs (int numbits, gboolean pinned)
 652 {
 653 #ifdef HAVE_SGEN_GC
 654         if (pinned)
 655                 return NULL;
 656 #endif
 657         return mono_gc_make_root_descr_all_refs (numbits);
 658 }
 659
 660 static guint32
 661 alloc_handle (HandleData *handles, MonoObject *obj, gboolean track)
 662 {
 663         gint slot, i;
 664         guint32 res;
 665         lock_handles (handles);
 666         if (!handles->size) {
 667                 handles->size = 32;
 668                 if (handles->type > HANDLE_WEAK_TRACK) {
 669                         handles->entries = mono_gc_alloc_fixed (sizeof (gpointer) * handles->size, make_root_descr_all_refs (handles->size, handles->type == HANDLE_PINNED));
 670                 } else {
 671                         handles->entries = g_malloc0 (sizeof (gpointer) * handles->size);
 672                         handles->domain_ids = g_malloc0 (sizeof (guint16) * handles->size);
 673                 }
 674                 handles->bitmap = g_malloc0 (handles->size / 8);
 675         }
 676         i = -1;
 677         for (slot = handles->slot_hint; slot < handles->size / 32; ++slot) {
 678                 if (handles->bitmap [slot] != 0xffffffff) {
 679                         i = find_first_unset (handles->bitmap [slot]);
 680                         handles->slot_hint = slot;
 681                         break;
 682                 }
 683         }
 684         if (i == -1 && handles->slot_hint != 0) {
 685                 for (slot = 0; slot < handles->slot_hint; ++slot) {
 686                         if (handles->bitmap [slot] != 0xffffffff) {
 687                                 i = find_first_unset (handles->bitmap [slot]);
 688                                 handles->slot_hint = slot;
 689                                 break;
 690                         }
 691                 }
 692         }
 693         if (i == -1) {
 694                 guint32 *new_bitmap;
 695                 guint32 new_size = handles->size * 2; /* always double: we memset to 0 based on this below */
 696
 697                 /* resize and copy the bitmap */
 698                 new_bitmap = g_malloc0 (new_size / 8);
 699                 memcpy (new_bitmap, handles->bitmap, handles->size / 8);
 700                 g_free (handles->bitmap);
 701                 handles->bitmap = new_bitmap;
 702
 703                 /* resize and copy the entries */
 704                 if (handles->type > HANDLE_WEAK_TRACK) {
 705                         gpointer *entries;
 706
 707                         entries = mono_gc_alloc_fixed (sizeof (gpointer) * new_size, make_root_descr_all_refs (new_size, handles->type == HANDLE_PINNED));
 708                         mono_gc_memmove_aligned (entries, handles->entries, sizeof (gpointer) * handles->size);
 709
 710                         mono_gc_free_fixed (handles->entries);
 711                         handles->entries = entries;
 712                 } else {
 713                         gpointer *entries;
 714                         guint16 *domain_ids;
 715                         domain_ids = g_malloc0 (sizeof (guint16) * new_size);
 716                         entries = g_malloc0 (sizeof (gpointer) * new_size);
 717                         memcpy (domain_ids, handles->domain_ids, sizeof (guint16) * handles->size);
 718                         for (i = 0; i < handles->size; ++i) {
 719                                 MonoObject *obj = mono_gc_weak_link_get (&(handles->entries [i]));
 720                                 if (obj) {
 721                                         mono_gc_weak_link_add (&(entries [i]), obj, track);
 722                                         mono_gc_weak_link_remove (&(handles->entries [i]), track);
 723                                 } else {
 724                                         g_assert (!handles->entries [i]);
 725                                 }
 726                         }
 727                         g_free (handles->entries);
 728                         g_free (handles->domain_ids);
 729                         handles->entries = entries;
 730                         handles->domain_ids = domain_ids;
 731                 }
 732
 733                 /* set i and slot to the next free position */
 734                 i = 0;
 735                 slot = (handles->size + 1) / 32;
 736                 handles->slot_hint = handles->size + 1;
 737                 handles->size = new_size;
 738         }
 739         handles->bitmap [slot] |= 1 << i;
 740         slot = slot * 32 + i;
 741         handles->entries [slot] = NULL;
 742         if (handles->type <= HANDLE_WEAK_TRACK) {
 743                 /*FIXME, what to use when obj == null?*/
 744                 handles->domain_ids [slot] = (obj ? mono_object_get_domain (obj) : mono_domain_get ())->domain_id;
 745                 if (obj)
 746                         mono_gc_weak_link_add (&(handles->entries [slot]), obj, track);
 747         } else {
 748                 handles->entries [slot] = obj;
 749         }
 750
 751 #ifndef DISABLE_PERFCOUNTERS
 752         mono_perfcounters->gc_num_handles++;
 753 #endif
 754         unlock_handles (handles);
 755         /*g_print ("allocated entry %d of type %d to object %p (in slot: %p)\n", slot, handles->type, obj, handles->entries [slot]);*/
 756         res = (slot << 3) | (handles->type + 1);
 757         mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_CREATED, handles->type, res, obj);
 758         return res;
 759 }
 760
 761 /**
 762  * mono_gchandle_new:
 763  * @obj: managed object to get a handle for
 764  * @pinned: whether the object should be pinned
 765  *
 766  * This returns a handle that wraps the object, this is used to keep a
 767  * reference to a managed object from the unmanaged world and preventing the
 768  * object from being disposed.
 769  *
 770  * If @pinned is false the address of the object can not be obtained, if it is
 771  * true the address of the object can be obtained.  This will also pin the
 772  * object so it will not be possible by a moving garbage collector to move the
 773  * object.
 774  *
 775  * Returns: a handle that can be used to access the object from
 776  * unmanaged code.
 777  */
 778 guint32
 779 mono_gchandle_new (MonoObject *obj, gboolean pinned)
 780 {
 781         return alloc_handle (&gc_handles [pinned? HANDLE_PINNED: HANDLE_NORMAL], obj, FALSE);
 782 }
 783
 784 /**
 785  * mono_gchandle_new_weakref:
 786  * @obj: managed object to get a handle for
 787  * @pinned: whether the object should be pinned
 788  *
 789  * This returns a weak handle that wraps the object, this is used to
 790  * keep a reference to a managed object from the unmanaged world.
 791  * Unlike the mono_gchandle_new the object can be reclaimed by the
 792  * garbage collector.  In this case the value of the GCHandle will be
 793  * set to zero.
 794  *
 795  * If @pinned is false the address of the object can not be obtained, if it is
 796  * true the address of the object can be obtained.  This will also pin the
 797  * object so it will not be possible by a moving garbage collector to move the
 798  * object.
 799  *
 800  * Returns: a handle that can be used to access the object from
 801  * unmanaged code.
 802  */
 803 guint32
 804 mono_gchandle_new_weakref (MonoObject *obj, gboolean track_resurrection)
 805 {
 806         guint32 handle = alloc_handle (&gc_handles [track_resurrection? HANDLE_WEAK_TRACK: HANDLE_WEAK], obj, track_resurrection);
 807
 808         return handle;
 809 }
 810
 811 static HandleType
 812 mono_gchandle_get_type (guint32 gchandle)
 813 {
 814         guint type = (gchandle & 7) - 1;
 815
 816         return type;
 817 }
 818
 819 /**
 820  * mono_gchandle_get_target:
 821  * @gchandle: a GCHandle's handle.
 822  *
 823  * The handle was previously created by calling mono_gchandle_new or
 824  * mono_gchandle_new_weakref.
 825  *
 826  * Returns a pointer to the MonoObject represented by the handle or
 827  * NULL for a collected object if using a weakref handle.
 828  */
 829 MonoObject*
 830 mono_gchandle_get_target (guint32 gchandle)
 831 {
 832         guint slot = gchandle >> 3;
 833         guint type = (gchandle & 7) - 1;
 834         HandleData *handles = &gc_handles [type];
 835         MonoObject *obj = NULL;
 836         if (type > 3)
 837                 return NULL;
 838         lock_handles (handles);
 839         if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
 840                 if (handles->type <= HANDLE_WEAK_TRACK) {
 841                         obj = mono_gc_weak_link_get (&handles->entries [slot]);
 842                 } else {
 843                         obj = handles->entries [slot];
 844                 }
 845         } else {
 846                 /* print a warning? */
 847         }
 848         unlock_handles (handles);
 849         /*g_print ("get target of entry %d of type %d: %p\n", slot, handles->type, obj);*/
 850         return obj;
 851 }
 852
 853 static void
 854 mono_gchandle_set_target (guint32 gchandle, MonoObject *obj)
 855 {
 856         guint slot = gchandle >> 3;
 857         guint type = (gchandle & 7) - 1;
 858         HandleData *handles = &gc_handles [type];
 859
 860         if (type > 3)
 861                 return;
 862         lock_handles (handles);
 863         if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
 864                 if (handles->type <= HANDLE_WEAK_TRACK) {
 865                         if (handles->entries [slot])
 866                                 mono_gc_weak_link_remove (&handles->entries [slot], handles->type == HANDLE_WEAK_TRACK);
 867                         if (obj)
 868                                 mono_gc_weak_link_add (&handles->entries [slot], obj, handles->type == HANDLE_WEAK_TRACK);
 869                         /*FIXME, what to use when obj == null?*/
 870                         handles->domain_ids [slot] = (obj ? mono_object_get_domain (obj) : mono_domain_get ())->domain_id;
 871                 } else {
 872                         handles->entries [slot] = obj;
 873                 }
 874         } else {
 875                 /* print a warning? */
 876         }
 877         /*g_print ("changed entry %d of type %d to object %p (in slot: %p)\n", slot, handles->type, obj, handles->entries [slot]);*/
 878         unlock_handles (handles);
 879 }
 880
 881 /**
 882  * mono_gchandle_is_in_domain:
 883  * @gchandle: a GCHandle's handle.
 884  * @domain: An application domain.
 885  *
 886  * Returns: true if the object wrapped by the @gchandle belongs to the specific @domain.
 887  */
 888 gboolean
 889 mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain)
 890 {
 891         guint slot = gchandle >> 3;
 892         guint type = (gchandle & 7) - 1;
 893         HandleData *handles = &gc_handles [type];
 894         gboolean result = FALSE;
 895         if (type > 3)
 896                 return FALSE;
 897         lock_handles (handles);
 898         if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
 899                 if (handles->type <= HANDLE_WEAK_TRACK) {
 900                         result = domain->domain_id == handles->domain_ids [slot];
 901                 } else {
 902                         MonoObject *obj;
 903                         obj = handles->entries [slot];
 904                         if (obj == NULL)
 905                                 result = TRUE;
 906                         else
 907                                 result = domain == mono_object_domain (obj);
 908                 }
 909         } else {
 910                 /* print a warning? */
 911         }
 912         unlock_handles (handles);
 913         return result;
 914 }
 915
 916 /**
 917  * mono_gchandle_free:
 918  * @gchandle: a GCHandle's handle.
 919  *
 920  * Frees the @gchandle handle.  If there are no outstanding
 921  * references, the garbage collector can reclaim the memory of the
 922  * object wrapped.
 923  */
 924 void
 925 mono_gchandle_free (guint32 gchandle)
 926 {
 927         guint slot = gchandle >> 3;
 928         guint type = (gchandle & 7) - 1;
 929         HandleData *handles = &gc_handles [type];
 930         if (type > 3)
 931                 return;
 932
 933         lock_handles (handles);
 934         if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
 935                 if (handles->type <= HANDLE_WEAK_TRACK) {
 936                         if (handles->entries [slot])
 937                                 mono_gc_weak_link_remove (&handles->entries [slot], handles->type == HANDLE_WEAK_TRACK);
 938                 } else {
 939                         handles->entries [slot] = NULL;
 940                 }
 941                 handles->bitmap [slot / 32] &= ~(1 << (slot % 32));
 942         } else {
 943                 /* print a warning? */
 944         }
 945 #ifndef DISABLE_PERFCOUNTERS
 946         mono_perfcounters->gc_num_handles--;
 947 #endif
 948         /*g_print ("freed entry %d of type %d\n", slot, handles->type);*/
 949         unlock_handles (handles);
 950         mono_profiler_gc_handle (MONO_PROFILER_GC_HANDLE_DESTROYED, handles->type, gchandle, NULL);
 951 }
 952
 953 /**
 954  * mono_gchandle_free_domain:
 955  * @domain: domain that is unloading
 956  *
 957  * Function used internally to cleanup any GC handle for objects belonging
 958  * to the specified domain during appdomain unload.
 959  */
 960 void
 961 mono_gchandle_free_domain (MonoDomain *domain)
 962 {
 963         guint type;
 964
 965         for (type = 0; type < 3; ++type) {
 966                 guint slot;
 967                 HandleData *handles = &gc_handles [type];
 968                 lock_handles (handles);
 969                 for (slot = 0; slot < handles->size; ++slot) {
 970                         if (!(handles->bitmap [slot / 32] & (1 << (slot % 32))))
 971                                 continue;
 972                         if (type <= HANDLE_WEAK_TRACK) {
 973                                 if (domain->domain_id == handles->domain_ids [slot]) {
 974                                         handles->bitmap [slot / 32] &= ~(1 << (slot % 32));
 975                                         if (handles->entries [slot])
 976                                                 mono_gc_weak_link_remove (&handles->entries [slot], handles->type == HANDLE_WEAK_TRACK);
 977                                 }
 978                         } else {
 979                                 if (handles->entries [slot] && mono_object_domain (handles->entries [slot]) == domain) {
 980                                         handles->bitmap [slot / 32] &= ~(1 << (slot % 32));
 981                                         handles->entries [slot] = NULL;
 982                                 }
 983                         }
 984                 }
 985                 unlock_handles (handles);
 986         }
 987
 988 }
 989
 990 MonoBoolean
 991 mono_gc_GCHandle_CheckCurrentDomain (guint32 gchandle)
 992 {
 993         return mono_gchandle_is_in_domain (gchandle, mono_domain_get ());
 994 }
 995
 996 #ifdef MONO_HAS_SEMAPHORES
 997 static MonoSemType finalizer_sem;
 998 #endif
 999 static HANDLE finalizer_event;
1000 static volatile gboolean finished=FALSE;
1001
1002 void
1003 mono_gc_finalize_notify (void)
1004 {
1005 #ifdef DEBUG
1006         g_message ( "%s: prodding finalizer", __func__);
1007 #endif
1008
1009         if (mono_gc_is_null ())
1010                 return;
1011
1012 #ifdef MONO_HAS_SEMAPHORES
1013         MONO_SEM_POST (&finalizer_sem);
1014 #else
1015         SetEvent (finalizer_event);
1016 #endif
1017 }
1018
1019 #ifdef HAVE_BOEHM_GC
1020
1021 static void
1022 collect_objects (gpointer key, gpointer value, gpointer user_data)
1023 {
1024         GPtrArray *arr = (GPtrArray*)user_data;
1025         g_ptr_array_add (arr, key);
1026 }
1027
1028 #endif
1029
1030 /*
1031  * finalize_domain_objects:
1032  *
1033  *  Run the finalizers of all finalizable objects in req->domain.
1034  */
1035 static void
1036 finalize_domain_objects (DomainFinalizationReq *req)
1037 {
1038         MonoDomain *domain = req->domain;
1039
1040 #if HAVE_SGEN_GC
1041 #define NUM_FOBJECTS 64
1042         MonoObject *to_finalize [NUM_FOBJECTS];
1043         int count;
1044 #endif
1045
1046         /* Process finalizers which are already in the queue */
1047         mono_gc_invoke_finalizers ();
1048
1049 #ifdef HAVE_BOEHM_GC
1050         while (g_hash_table_size (domain->finalizable_objects_hash) > 0) {
1051                 int i;
1052                 GPtrArray *objs;
1053                 /*
1054                  * Since the domain is unloading, nobody is allowed to put
1055                  * new entries into the hash table. But finalize_object might
1056                  * remove entries from the hash table, so we make a copy.
1057                  */
1058                 objs = g_ptr_array_new ();
1059                 g_hash_table_foreach (domain->finalizable_objects_hash, collect_objects, objs);
1060                 /* printf ("FINALIZING %d OBJECTS.\n", objs->len); */
1061
1062                 for (i = 0; i < objs->len; ++i) {
1063                         MonoObject *o = (MonoObject*)g_ptr_array_index (objs, i);
1064                         /* FIXME: Avoid finalizing threads, etc */
1065                         mono_gc_run_finalize (o, 0);
1066                 }
1067
1068                 g_ptr_array_free (objs, TRUE);
1069         }
1070 #elif defined(HAVE_SGEN_GC)
1071         while ((count = mono_gc_finalizers_for_domain (domain, to_finalize, NUM_FOBJECTS))) {
1072                 int i;
1073                 for (i = 0; i < count; ++i) {
1074                         mono_gc_run_finalize (to_finalize [i], 0);
1075                 }
1076         }
1077 #endif
1078
1079         /* cleanup the reference queue */
1080         reference_queue_clear_for_domain (domain);
1081
1082         /* printf ("DONE.\n"); */
1083         SetEvent (req->done_event);
1084
1085         /* The event is closed in mono_domain_finalize if we get here */
1086         g_free (req);
1087 }
1088
1089 static guint32
1090 finalizer_thread (gpointer unused)
1091 {
1092         gboolean wait = TRUE;
1093
1094         while (!finished) {
1095                 /* Wait to be notified that there's at least one
1096                  * finaliser to run
1097                  */
1098
1099                 g_assert (mono_domain_get () == mono_get_root_domain ());
1100                 mono_gc_set_skip_thread (TRUE);
1101                 MONO_PREPARE_BLOCKING
1102
1103                 if (wait) {
1104                 /* An alertable wait is required so this thread can be suspended on windows */
1105 #ifdef MONO_HAS_SEMAPHORES
1106                         MONO_SEM_WAIT_ALERTABLE (&finalizer_sem, TRUE);
1107 #else
1108                         WaitForSingleObjectEx (finalizer_event, INFINITE, TRUE);
1109 #endif
1110                 }
1111                 wait = TRUE;
1112                 MONO_FINISH_BLOCKING
1113                 mono_gc_set_skip_thread (FALSE);
1114
1115                 mono_threads_perform_thread_dump ();
1116
1117                 mono_console_handle_async_ops ();
1118
1119 #ifndef DISABLE_ATTACH
1120                 mono_attach_maybe_start ();
1121 #endif
1122
1123                 if (domains_to_finalize) {
1124                         mono_finalizer_lock ();
1125                         if (domains_to_finalize) {
1126                                 DomainFinalizationReq *req = domains_to_finalize->data;
1127                                 domains_to_finalize = g_slist_remove (domains_to_finalize, req);
1128                                 mono_finalizer_unlock ();
1129
1130                                 finalize_domain_objects (req);
1131                         } else {
1132                                 mono_finalizer_unlock ();
1133                         }
1134                 }
1135
1136                 /* If finished == TRUE, mono_gc_cleanup has been called (from mono_runtime_cleanup),
1137                  * before the domain is unloaded.
1138                  */
1139                 mono_gc_invoke_finalizers ();
1140
1141                 mono_threads_join_threads ();
1142
1143                 reference_queue_proccess_all ();
1144
1145 #ifdef MONO_HAS_SEMAPHORES
1146                 /* Avoid posting the pending done event until there are pending finalizers */
1147                 if (MONO_SEM_TIMEDWAIT (&finalizer_sem, 0) == 0)
1148                         /* Don't wait again at the start of the loop */
1149                         wait = FALSE;
1150                 else
1151                         SetEvent (pending_done_event);
1152 #else
1153                         SetEvent (pending_done_event);
1154 #endif
1155         }
1156
1157         mono_finalizer_lock ();
1158         finalizer_thread_exited = TRUE;
1159         mono_cond_signal (&exited_cond);
1160         mono_finalizer_unlock ();
1161
1162         return 0;
1163 }
1164
1165 #ifndef LAZY_GC_THREAD_CREATION
1166 static
1167 #endif
1168 void
1169 mono_gc_init_finalizer_thread (void)
1170 {
1171         gc_thread = mono_thread_create_internal (mono_domain_get (), finalizer_thread, NULL, FALSE, 0);
1172         ves_icall_System_Threading_Thread_SetName_internal (gc_thread, mono_string_new (mono_domain_get (), "Finalizer"));
1173 }
1174
1175 void
1176 mono_gc_init (void)
1177 {
1178         mono_mutex_init_recursive (&handle_section);
1179         mono_mutex_init_recursive (&allocator_section);
1180
1181         mono_mutex_init_recursive (&finalizer_mutex);
1182         mono_mutex_init_recursive (&reference_queue_mutex);
1183
1184         MONO_GC_REGISTER_ROOT_FIXED (gc_handles [HANDLE_NORMAL].entries);
1185         MONO_GC_REGISTER_ROOT_FIXED (gc_handles [HANDLE_PINNED].entries);
1186
1187         mono_counters_register ("Minor GC collections", MONO_COUNTER_GC | MONO_COUNTER_UINT, &gc_stats.minor_gc_count);
1188         mono_counters_register ("Major GC collections", MONO_COUNTER_GC | MONO_COUNTER_UINT, &gc_stats.major_gc_count);
1189         mono_counters_register ("Minor GC time", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &gc_stats.minor_gc_time);
1190         mono_counters_register ("Major GC time", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &gc_stats.major_gc_time);
1191         mono_counters_register ("Major GC time concurrent", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &gc_stats.major_gc_time_concurrent);
1192
1193         mono_gc_base_init ();
1194
1195         if (mono_gc_is_disabled ()) {
1196                 gc_disabled = TRUE;
1197                 return;
1198         }
1199
1200         finalizer_event = CreateEvent (NULL, FALSE, FALSE, NULL);
1201         g_assert (finalizer_event);
1202         pending_done_event = CreateEvent (NULL, TRUE, FALSE, NULL);
1203         g_assert (pending_done_event);
1204         mono_cond_init (&exited_cond, 0);
1205 #ifdef MONO_HAS_SEMAPHORES
1206         MONO_SEM_INIT (&finalizer_sem, 0);
1207 #endif
1208
1209 #ifndef LAZY_GC_THREAD_CREATION
1210         mono_gc_init_finalizer_thread ();
1211 #endif
1212 }
1213
1214 void
1215 mono_gc_cleanup (void)
1216 {
1217 #ifdef DEBUG
1218         g_message ("%s: cleaning up finalizer", __func__);
1219 #endif
1220
1221         if (mono_gc_is_null ())
1222                 return;
1223
1224         if (!gc_disabled) {
1225                 finished = TRUE;
1226                 if (mono_thread_internal_current () != gc_thread) {
1227                         gboolean timed_out = FALSE;
1228                         guint32 start_ticks = mono_msec_ticks ();
1229                         guint32 end_ticks = start_ticks + 2000;
1230
1231                         mono_gc_finalize_notify ();
1232                         /* Finishing the finalizer thread, so wait a little bit... */
1233                         /* MS seems to wait for about 2 seconds */
1234                         while (!finalizer_thread_exited) {
1235                                 guint32 current_ticks = mono_msec_ticks ();
1236                                 guint32 timeout;
1237
1238                                 if (current_ticks >= end_ticks)
1239                                         break;
1240                                 else
1241                                         timeout = end_ticks - current_ticks;
1242                                 MONO_PREPARE_BLOCKING;
1243                                 mono_finalizer_lock ();
1244                                 if (!finalizer_thread_exited)
1245                                         mono_cond_timedwait_ms (&exited_cond, &finalizer_mutex, timeout);
1246                                 mono_finalizer_unlock ();
1247                                 MONO_FINISH_BLOCKING;
1248                         }
1249
1250                         if (!finalizer_thread_exited) {
1251                                 int ret;
1252
1253                                 /* Set a flag which the finalizer thread can check */
1254                                 suspend_finalizers = TRUE;
1255
1256                                 /* Try to abort the thread, in the hope that it is running managed code */
1257                                 mono_thread_internal_stop (gc_thread);
1258
1259                                 /* Wait for it to stop */
1260                                 ret = guarded_wait (gc_thread->handle, 100, TRUE);
1261
1262                                 if (ret == WAIT_TIMEOUT) {
1263                                         /*
1264                                          * The finalizer thread refused to die. There is not much we
1265                                          * can do here, since the runtime is shutting down so the
1266                                          * state the finalizer thread depends on will vanish.
1267                                          */
1268                                         g_warning ("Shutting down finalizer thread timed out.");
1269                                         timed_out = TRUE;
1270                                 }
1271                         }
1272
1273                         if (!timed_out) {
1274                                 int ret;
1275
1276                                 /* Wait for the thread to actually exit */
1277                                 ret = guarded_wait (gc_thread->handle, INFINITE, TRUE);
1278                                 g_assert (ret == WAIT_OBJECT_0);
1279
1280                                 mono_thread_join (GUINT_TO_POINTER (gc_thread->tid));
1281                         }
1282                 }
1283                 gc_thread = NULL;
1284 #ifdef HAVE_BOEHM_GC
1285                 GC_finalizer_notifier = NULL;
1286 #endif
1287         }
1288
1289         mono_reference_queue_cleanup ();
1290
1291         mono_mutex_destroy (&handle_section);
1292         mono_mutex_destroy (&allocator_section);
1293         mono_mutex_destroy (&finalizer_mutex);
1294         mono_mutex_destroy (&reference_queue_mutex);
1295 }
1296
1297 gboolean
1298 mono_gc_is_finalizer_internal_thread (MonoInternalThread *thread)
1299 {
1300         return thread == gc_thread;
1301 }
1302
1303 /**
1304  * mono_gc_is_finalizer_thread:
1305  * @thread: the thread to test.
1306  *
1307  * In Mono objects are finalized asynchronously on a separate thread.
1308  * This routine tests whether the @thread argument represents the
1309  * finalization thread.
1310  *
1311  * Returns true if @thread is the finalization thread.
1312  */
1313 gboolean
1314 mono_gc_is_finalizer_thread (MonoThread *thread)
1315 {
1316         return mono_gc_is_finalizer_internal_thread (thread->internal_thread);
1317 }
1318
1319 #if defined(__MACH__)
1320 static pthread_t mach_exception_thread;
1321
1322 void
1323 mono_gc_register_mach_exception_thread (pthread_t thread)
1324 {
1325         mach_exception_thread = thread;
1326 }
1327
1328 pthread_t
1329 mono_gc_get_mach_exception_thread (void)
1330 {
1331         return mach_exception_thread;
1332 }
1333 #endif
1334
1335 #ifndef HAVE_SGEN_GC
1336 void*
1337 mono_gc_alloc_mature (MonoVTable *vtable)
1338 {
1339         return mono_object_new_specific (vtable);
1340 }
1341 #endif
1342
1343
1344 static MonoReferenceQueue *ref_queues;
1345
1346 static void
1347 ref_list_remove_element (RefQueueEntry **prev, RefQueueEntry *element)
1348 {
1349         do {
1350                 /* Guard if head is changed concurrently. */
1351                 while (*prev != element)
1352                         prev = &(*prev)->next;
1353         } while (prev && InterlockedCompareExchangePointer ((void*)prev, element->next, element) != element);
1354 }
1355
1356 static void
1357 ref_list_push (RefQueueEntry **head, RefQueueEntry *value)
1358 {
1359         RefQueueEntry *current;
1360         do {
1361                 current = *head;
1362                 value->next = current;
1363                 STORE_STORE_FENCE; /*Must make sure the previous store is visible before the CAS. */
1364         } while (InterlockedCompareExchangePointer ((void*)head, value, current) != current);
1365 }
1366
1367 static void
1368 reference_queue_proccess (MonoReferenceQueue *queue)
1369 {
1370         RefQueueEntry **iter = &queue->queue;
1371         RefQueueEntry *entry;
1372         while ((entry = *iter)) {
1373 #ifdef HAVE_SGEN_GC
1374                 if (queue->should_be_deleted || !mono_gc_weak_link_get (&entry->dis_link)) {
1375                         mono_gc_weak_link_remove (&entry->dis_link, TRUE);
1376 #else
1377                 if (queue->should_be_deleted || !mono_gchandle_get_target (entry->gchandle)) {
1378                         mono_gchandle_free ((guint32)entry->gchandle);
1379 #endif
1380                         ref_list_remove_element (iter, entry);
1381                         queue->callback (entry->user_data);
1382                         g_free (entry);
1383                 } else {
1384                         iter = &entry->next;
1385                 }
1386         }
1387 }
1388
1389 static void
1390 reference_queue_proccess_all (void)
1391 {
1392         MonoReferenceQueue **iter;
1393         MonoReferenceQueue *queue = ref_queues;
1394         for (; queue; queue = queue->next)
1395                 reference_queue_proccess (queue);
1396
1397 restart:
1398         mono_mutex_lock (&reference_queue_mutex);
1399         for (iter = &ref_queues; *iter;) {
1400                 queue = *iter;
1401                 if (!queue->should_be_deleted) {
1402                         iter = &queue->next;
1403                         continue;
1404                 }
1405                 if (queue->queue) {
1406                         mono_mutex_unlock (&reference_queue_mutex);
1407                         reference_queue_proccess (queue);
1408                         goto restart;
1409                 }
1410                 *iter = queue->next;
1411                 g_free (queue);
1412         }
1413         mono_mutex_unlock (&reference_queue_mutex);
1414 }
1415
1416 static void
1417 mono_reference_queue_cleanup (void)
1418 {
1419         MonoReferenceQueue *queue = ref_queues;
1420         for (; queue; queue = queue->next)
1421                 queue->should_be_deleted = TRUE;
1422         reference_queue_proccess_all ();
1423 }
1424
1425 static void
1426 reference_queue_clear_for_domain (MonoDomain *domain)
1427 {
1428         MonoReferenceQueue *queue = ref_queues;
1429         for (; queue; queue = queue->next) {
1430                 RefQueueEntry **iter = &queue->queue;
1431                 RefQueueEntry *entry;
1432                 while ((entry = *iter)) {
1433                         if (entry->domain == domain) {
1434 #ifdef HAVE_SGEN_GC
1435                                 mono_gc_weak_link_remove (&entry->dis_link, TRUE);
1436 #else
1437                                 mono_gchandle_free ((guint32)entry->gchandle);
1438 #endif
1439                                 ref_list_remove_element (iter, entry);
1440                                 queue->callback (entry->user_data);
1441                                 g_free (entry);
1442                         } else {
1443                                 iter = &entry->next;
1444                         }
1445                 }
1446         }
1447 }
1448 /**
1449  * mono_gc_reference_queue_new:
1450  * @callback callback used when processing collected entries.
1451  *
1452  * Create a new reference queue used to process collected objects.
1453  * A reference queue let you add a pair of (managed object, user data)
1454  * using the mono_gc_reference_queue_add method.
1455  *
1456  * Once the managed object is collected @callback will be called
1457  * in the finalizer thread with 'user data' as argument.
1458  *
1459  * The callback is called from the finalizer thread without any locks held.
1460  * When a AppDomain is unloaded, all callbacks for objects belonging to it
1461  * will be invoked.
1462  *
1463  * @returns the new queue.
1464  */
1465 MonoReferenceQueue*
1466 mono_gc_reference_queue_new (mono_reference_queue_callback callback)
1467 {
1468         MonoReferenceQueue *res = g_new0 (MonoReferenceQueue, 1);
1469         res->callback = callback;
1470
1471         mono_mutex_lock (&reference_queue_mutex);
1472         res->next = ref_queues;
1473         ref_queues = res;
1474         mono_mutex_unlock (&reference_queue_mutex);
1475
1476         return res;
1477 }
1478
1479 /**
1480  * mono_gc_reference_queue_add:
1481  * @queue the queue to add the reference to.
1482  * @obj the object to be watched for collection
1483  * @user_data parameter to be passed to the queue callback
1484  *
1485  * Queue an object to be watched for collection, when the @obj is
1486  * collected, the callback that was registered for the @queue will
1487  * be invoked with @user_data as argument.
1488  *
1489  * @returns false if the queue is scheduled to be freed.
1490  */
1491 gboolean
1492 mono_gc_reference_queue_add (MonoReferenceQueue *queue, MonoObject *obj, void *user_data)
1493 {
1494         RefQueueEntry *entry;
1495         if (queue->should_be_deleted)
1496                 return FALSE;
1497
1498         entry = g_new0 (RefQueueEntry, 1);
1499         entry->user_data = user_data;
1500         entry->domain = mono_object_domain (obj);
1501
1502 #ifdef HAVE_SGEN_GC
1503         mono_gc_weak_link_add (&entry->dis_link, obj, TRUE);
1504 #else
1505         entry->gchandle = mono_gchandle_new_weakref (obj, TRUE);
1506         mono_object_register_finalizer (obj);
1507 #endif
1508
1509         ref_list_push (&queue->queue, entry);
1510         return TRUE;
1511 }
1512
1513 /**
1514  * mono_gc_reference_queue_free:
1515  * @queue the queue that should be freed.
1516  *
1517  * This operation signals that @queue should be freed. This operation is deferred
1518  * as it happens on the finalizer thread.
1519  *
1520  * After this call, no further objects can be queued. It's the responsibility of the
1521  * caller to make sure that no further attempt to access queue will be made.
1522  */
1523 void
1524 mono_gc_reference_queue_free (MonoReferenceQueue *queue)
1525 {
1526         queue->should_be_deleted = TRUE;
1527 }