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-internals.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/threads-types.h>
  26 #include <mono/metadata/threadpool-ms.h>
  27 #include <mono/sgen/sgen-conf.h>
  28 #include <mono/sgen/sgen-gc.h>
  29 #include <mono/utils/mono-logger-internals.h>
  30 #include <mono/metadata/gc-internals.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-os-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 #include <mono/utils/mono-coop-semaphore.h>
  42
  43 #ifndef HOST_WIN32
  44 #include <pthread.h>
  45 #endif
  46
  47 typedef struct DomainFinalizationReq {
  48         MonoDomain *domain;
  49         HANDLE done_event;
  50 } DomainFinalizationReq;
  51
  52 static gboolean gc_disabled = FALSE;
  53
  54 static gboolean finalizing_root_domain = FALSE;
  55
  56 gboolean log_finalizers = FALSE;
  57 gboolean mono_do_not_finalize = FALSE;
  58 gchar **mono_do_not_finalize_class_names = NULL;
  59
  60 #define mono_finalizer_lock() mono_coop_mutex_lock (&finalizer_mutex)
  61 #define mono_finalizer_unlock() mono_coop_mutex_unlock (&finalizer_mutex)
  62 static MonoCoopMutex finalizer_mutex;
  63 static MonoCoopMutex reference_queue_mutex;
  64
  65 static GSList *domains_to_finalize= NULL;
  66 static MonoMList *threads_to_finalize = NULL;
  67
  68 static gboolean finalizer_thread_exited;
  69 /* Uses finalizer_mutex */
  70 static MonoCoopCond exited_cond;
  71
  72 static MonoInternalThread *gc_thread;
  73
  74 static void object_register_finalizer (MonoObject *obj, void (*callback)(void *, void*));
  75
  76 static void reference_queue_proccess_all (void);
  77 static void mono_reference_queue_cleanup (void);
  78 static void reference_queue_clear_for_domain (MonoDomain *domain);
  79 static HANDLE pending_done_event;
  80
  81 static guint32
  82 guarded_wait (HANDLE handle, guint32 timeout, gboolean alertable)
  83 {
  84         guint32 result;
  85
  86         MONO_PREPARE_BLOCKING;
  87         result = WaitForSingleObjectEx (handle, timeout, alertable);
  88         MONO_FINISH_BLOCKING;
  89
  90         return result;
  91 }
  92
  93 static void
  94 add_thread_to_finalize (MonoInternalThread *thread)
  95 {
  96         mono_finalizer_lock ();
  97         if (!threads_to_finalize)
  98                 MONO_GC_REGISTER_ROOT_SINGLE (threads_to_finalize, MONO_ROOT_SOURCE_FINALIZER_QUEUE, "finalizable threads list");
  99         threads_to_finalize = mono_mlist_append (threads_to_finalize, (MonoObject*)thread);
 100         mono_finalizer_unlock ();
 101 }
 102
 103 static gboolean suspend_finalizers = FALSE;
 104 /*
 105  * actually, we might want to queue the finalize requests in a separate thread,
 106  * but we need to be careful about the execution domain of the thread...
 107  */
 108 void
 109 mono_gc_run_finalize (void *obj, void *data)
 110 {
 111         MonoObject *exc = NULL;
 112         MonoObject *o;
 113 #ifndef HAVE_SGEN_GC
 114         MonoObject *o2;
 115 #endif
 116         MonoMethod* finalizer = NULL;
 117         MonoDomain *caller_domain = mono_domain_get ();
 118         MonoDomain *domain;
 119         RuntimeInvokeFunction runtime_invoke;
 120
 121         // This function is called from the innards of the GC, so our best alternative for now is to do polling here
 122         mono_threads_safepoint ();
 123
 124         o = (MonoObject*)((char*)obj + GPOINTER_TO_UINT (data));
 125
 126         if (mono_do_not_finalize) {
 127                 if (!mono_do_not_finalize_class_names)
 128                         return;
 129
 130                 size_t namespace_len = strlen (o->vtable->klass->name_space);
 131                 for (int i = 0; mono_do_not_finalize_class_names [i]; ++i) {
 132                         const char *name = mono_do_not_finalize_class_names [i];
 133                         if (strncmp (name, o->vtable->klass->name_space, namespace_len))
 134                                 break;
 135                         if (name [namespace_len] != '.')
 136                                 break;
 137                         if (strcmp (name + namespace_len + 1, o->vtable->klass->name))
 138                                 break;
 139                         return;
 140                 }
 141         }
 142
 143         if (log_finalizers)
 144                 g_log ("mono-gc-finalizers", G_LOG_LEVEL_DEBUG, "<%s at %p> Starting finalizer checks.", o->vtable->klass->name, o);
 145
 146         if (suspend_finalizers)
 147                 return;
 148
 149         domain = o->vtable->domain;
 150
 151 #ifndef HAVE_SGEN_GC
 152         mono_domain_finalizers_lock (domain);
 153
 154         o2 = (MonoObject *)g_hash_table_lookup (domain->finalizable_objects_hash, o);
 155
 156         mono_domain_finalizers_unlock (domain);
 157
 158         if (!o2)
 159                 /* Already finalized somehow */
 160                 return;
 161 #endif
 162
 163         /* make sure the finalizer is not called again if the object is resurrected */
 164         object_register_finalizer ((MonoObject *)obj, NULL);
 165
 166         if (log_finalizers)
 167                 g_log ("mono-gc-finalizers", G_LOG_LEVEL_MESSAGE, "<%s at %p> Registered finalizer as processed.", o->vtable->klass->name, o);
 168
 169         if (o->vtable->klass == mono_defaults.internal_thread_class) {
 170                 MonoInternalThread *t = (MonoInternalThread*)o;
 171
 172                 if (mono_gc_is_finalizer_internal_thread (t))
 173                         /* Avoid finalizing ourselves */
 174                         return;
 175
 176                 if (t->threadpool_thread && finalizing_root_domain) {
 177                         /* Don't finalize threadpool threads when
 178                            shutting down - they're finalized when the
 179                            threadpool shuts down. */
 180                         add_thread_to_finalize (t);
 181                         return;
 182                 }
 183         }
 184
 185         if (o->vtable->klass->image == mono_defaults.corlib && !strcmp (o->vtable->klass->name, "DynamicMethod") && finalizing_root_domain) {
 186                 /*
 187                  * These can't be finalized during unloading/shutdown, since that would
 188                  * free the native code which can still be referenced by other
 189                  * finalizers.
 190                  * FIXME: This is not perfect, objects dying at the same time as
 191                  * dynamic methods can still reference them even when !shutdown.
 192                  */
 193                 return;
 194         }
 195
 196         if (mono_runtime_get_no_exec ())
 197                 return;
 198
 199         /* speedup later... and use a timeout */
 200         /* g_print ("Finalize run on %p %s.%s\n", o, mono_object_class (o)->name_space, mono_object_class (o)->name); */
 201
 202         /* Use _internal here, since this thread can enter a doomed appdomain */
 203         mono_domain_set_internal (mono_object_domain (o));
 204
 205         /* delegates that have a native function pointer allocated are
 206          * registered for finalization, but they don't have a Finalize
 207          * method, because in most cases it's not needed and it's just a waste.
 208          */
 209         if (o->vtable->klass->delegate) {
 210                 MonoDelegate* del = (MonoDelegate*)o;
 211                 if (del->delegate_trampoline)
 212                         mono_delegate_free_ftnptr ((MonoDelegate*)o);
 213                 mono_domain_set_internal (caller_domain);
 214                 return;
 215         }
 216
 217         finalizer = mono_class_get_finalizer (o->vtable->klass);
 218
 219         /* If object has a CCW but has no finalizer, it was only
 220          * registered for finalization in order to free the CCW.
 221          * Else it needs the regular finalizer run.
 222          * FIXME: what to do about ressurection and suppression
 223          * of finalizer on object with CCW.
 224          */
 225         if (mono_marshal_free_ccw (o) && !finalizer) {
 226                 mono_domain_set_internal (caller_domain);
 227                 return;
 228         }
 229
 230         /*
 231          * To avoid the locking plus the other overhead of mono_runtime_invoke (),
 232          * create and precompile a wrapper which calls the finalize method using
 233          * a CALLVIRT.
 234          */
 235         if (log_finalizers)
 236                 g_log ("mono-gc-finalizers", G_LOG_LEVEL_MESSAGE, "<%s at %p> Compiling finalizer.", o->vtable->klass->name, o);
 237
 238         if (!domain->finalize_runtime_invoke) {
 239                 MonoMethod *invoke = mono_marshal_get_runtime_invoke (mono_class_get_method_from_name_flags (mono_defaults.object_class, "Finalize", 0, 0), TRUE);
 240
 241                 domain->finalize_runtime_invoke = mono_compile_method (invoke);
 242         }
 243
 244         runtime_invoke = (RuntimeInvokeFunction)domain->finalize_runtime_invoke;
 245
 246         mono_runtime_class_init (o->vtable);
 247
 248         if (G_UNLIKELY (MONO_GC_FINALIZE_INVOKE_ENABLED ())) {
 249                 MONO_GC_FINALIZE_INVOKE ((unsigned long)o, mono_object_get_size (o),
 250                                 o->vtable->klass->name_space, o->vtable->klass->name);
 251         }
 252
 253         if (log_finalizers)
 254                 g_log ("mono-gc-finalizers", G_LOG_LEVEL_MESSAGE, "<%s at %p> Calling finalizer.", o->vtable->klass->name, o);
 255
 256         runtime_invoke (o, NULL, &exc, NULL);
 257
 258         if (log_finalizers)
 259                 g_log ("mono-gc-finalizers", G_LOG_LEVEL_MESSAGE, "<%s at %p> Returned from finalizer.", o->vtable->klass->name, o);
 260
 261         if (exc)
 262                 mono_thread_internal_unhandled_exception (exc);
 263
 264         mono_domain_set_internal (caller_domain);
 265 }
 266
 267 void
 268 mono_gc_finalize_threadpool_threads (void)
 269 {
 270         while (threads_to_finalize) {
 271                 MonoInternalThread *thread = (MonoInternalThread*) mono_mlist_get_data (threads_to_finalize);
 272
 273                 /* Force finalization of the thread. */
 274                 thread->threadpool_thread = FALSE;
 275                 mono_object_register_finalizer ((MonoObject*)thread);
 276
 277                 mono_gc_run_finalize (thread, NULL);
 278
 279                 threads_to_finalize = mono_mlist_next (threads_to_finalize);
 280         }
 281 }
 282
 283 gpointer
 284 mono_gc_out_of_memory (size_t size)
 285 {
 286         /*
 287          * we could allocate at program startup some memory that we could release
 288          * back to the system at this point if we're really low on memory (ie, size is
 289          * lower than the memory we set apart)
 290          */
 291         mono_raise_exception (mono_domain_get ()->out_of_memory_ex);
 292
 293         return NULL;
 294 }
 295
 296 /*
 297  * Some of our objects may point to a different address than the address returned by GC_malloc()
 298  * (because of the GetHashCode hack), but we need to pass the real address to register_finalizer.
 299  * This also means that in the callback we need to adjust the pointer to get back the real
 300  * MonoObject*.
 301  * We also need to be consistent in the use of the GC_debug* variants of malloc and register_finalizer,
 302  * since that, too, can cause the underlying pointer to be offset.
 303  */
 304 static void
 305 object_register_finalizer (MonoObject *obj, void (*callback)(void *, void*))
 306 {
 307         MonoDomain *domain;
 308
 309         if (obj == NULL)
 310                 mono_raise_exception (mono_get_exception_argument_null ("obj"));
 311
 312         domain = obj->vtable->domain;
 313
 314 #if HAVE_BOEHM_GC
 315         if (mono_domain_is_unloading (domain) && (callback != NULL))
 316                 /*
 317                  * Can't register finalizers in a dying appdomain, since they
 318                  * could be invoked after the appdomain has been unloaded.
 319                  */
 320                 return;
 321
 322         mono_domain_finalizers_lock (domain);
 323
 324         if (callback)
 325                 g_hash_table_insert (domain->finalizable_objects_hash, obj, obj);
 326         else
 327                 g_hash_table_remove (domain->finalizable_objects_hash, obj);
 328
 329         mono_domain_finalizers_unlock (domain);
 330
 331         mono_gc_register_for_finalization (obj, callback);
 332 #elif defined(HAVE_SGEN_GC)
 333         /*
 334          * If we register finalizers for domains that are unloading we might
 335          * end up running them while or after the domain is being cleared, so
 336          * the objects will not be valid anymore.
 337          */
 338         if (!mono_domain_is_unloading (domain))
 339                 mono_gc_register_for_finalization (obj, callback);
 340 #endif
 341 }
 342
 343 /**
 344  * mono_object_register_finalizer:
 345  * @obj: object to register
 346  *
 347  * Records that object @obj has a finalizer, this will call the
 348  * Finalize method when the garbage collector disposes the object.
 349  *
 350  */
 351 void
 352 mono_object_register_finalizer (MonoObject *obj)
 353 {
 354         /* g_print ("Registered finalizer on %p %s.%s\n", obj, mono_object_class (obj)->name_space, mono_object_class (obj)->name); */
 355         object_register_finalizer (obj, mono_gc_run_finalize);
 356 }
 357
 358 /**
 359  * mono_domain_finalize:
 360  * @domain: the domain to finalize
 361  * @timeout: msects to wait for the finalization to complete, -1 to wait indefinitely
 362  *
 363  *  Request finalization of all finalizable objects inside @domain. Wait
 364  * @timeout msecs for the finalization to complete.
 365  *
 366  * Returns: TRUE if succeeded, FALSE if there was a timeout
 367  */
 368
 369 gboolean
 370 mono_domain_finalize (MonoDomain *domain, guint32 timeout)
 371 {
 372         DomainFinalizationReq *req;
 373         guint32 res;
 374         HANDLE done_event;
 375         MonoInternalThread *thread = mono_thread_internal_current ();
 376
 377 #if defined(__native_client__)
 378         return FALSE;
 379 #endif
 380
 381         if (mono_thread_internal_current () == gc_thread)
 382                 /* We are called from inside a finalizer, not much we can do here */
 383                 return FALSE;
 384
 385         /*
 386          * No need to create another thread 'cause the finalizer thread
 387          * is still working and will take care of running the finalizers
 388          */
 389
 390         if (gc_disabled)
 391                 return TRUE;
 392
 393         /* We don't support domain finalization without a GC */
 394         if (mono_gc_is_null ())
 395                 return FALSE;
 396
 397         mono_gc_collect (mono_gc_max_generation ());
 398
 399         done_event = CreateEvent (NULL, TRUE, FALSE, NULL);
 400         if (done_event == NULL) {
 401                 return FALSE;
 402         }
 403
 404         req = g_new0 (DomainFinalizationReq, 1);
 405         req->domain = domain;
 406         req->done_event = done_event;
 407
 408         if (domain == mono_get_root_domain ())
 409                 finalizing_root_domain = TRUE;
 410
 411         mono_finalizer_lock ();
 412
 413         domains_to_finalize = g_slist_append (domains_to_finalize, req);
 414
 415         mono_finalizer_unlock ();
 416
 417         /* Tell the finalizer thread to finalize this appdomain */
 418         mono_gc_finalize_notify ();
 419
 420         if (timeout == -1)
 421                 timeout = INFINITE;
 422
 423         while (TRUE) {
 424                 res = guarded_wait (done_event, timeout, TRUE);
 425                 /* printf ("WAIT RES: %d.\n", res); */
 426
 427                 if (res == WAIT_IO_COMPLETION) {
 428                         if ((thread->state & (ThreadState_StopRequested | ThreadState_SuspendRequested)) != 0)
 429                                 return FALSE;
 430                 } else if (res == WAIT_TIMEOUT) {
 431                         /* We leak the handle here */
 432                         return FALSE;
 433                 } else {
 434                         break;
 435                 }
 436         }
 437
 438         CloseHandle (done_event);
 439
 440         if (domain == mono_get_root_domain ()) {
 441                 mono_threadpool_ms_cleanup ();
 442                 mono_gc_finalize_threadpool_threads ();
 443         }
 444
 445         return TRUE;
 446 }
 447
 448 void
 449 ves_icall_System_GC_InternalCollect (int generation)
 450 {
 451         mono_gc_collect (generation);
 452 }
 453
 454 gint64
 455 ves_icall_System_GC_GetTotalMemory (MonoBoolean forceCollection)
 456 {
 457         if (forceCollection)
 458                 mono_gc_collect (mono_gc_max_generation ());
 459         return mono_gc_get_used_size ();
 460 }
 461
 462 void
 463 ves_icall_System_GC_KeepAlive (MonoObject *obj)
 464 {
 465         /*
 466          * Does nothing.
 467          */
 468 }
 469
 470 void
 471 ves_icall_System_GC_ReRegisterForFinalize (MonoObject *obj)
 472 {
 473         MONO_CHECK_ARG_NULL (obj,);
 474
 475         object_register_finalizer (obj, mono_gc_run_finalize);
 476 }
 477
 478 void
 479 ves_icall_System_GC_SuppressFinalize (MonoObject *obj)
 480 {
 481         MONO_CHECK_ARG_NULL (obj,);
 482
 483         /* delegates have no finalizers, but we register them to deal with the
 484          * unmanaged->managed trampoline. We don't let the user suppress it
 485          * otherwise we'd leak it.
 486          */
 487         if (obj->vtable->klass->delegate)
 488                 return;
 489
 490         /* FIXME: Need to handle case where obj has COM Callable Wrapper
 491          * generated for it that needs cleaned up, but user wants to suppress
 492          * their derived object finalizer. */
 493
 494         object_register_finalizer (obj, NULL);
 495 }
 496
 497 void
 498 ves_icall_System_GC_WaitForPendingFinalizers (void)
 499 {
 500         if (mono_gc_is_null ())
 501                 return;
 502
 503         if (!mono_gc_pending_finalizers ())
 504                 return;
 505
 506         if (mono_thread_internal_current () == gc_thread)
 507                 /* Avoid deadlocks */
 508                 return;
 509
 510         /*
 511         If the finalizer thread is not live, lets pretend no finalizers are pending since the current thread might
 512         be the one responsible for starting it up.
 513         */
 514         if (gc_thread == NULL)
 515                 return;
 516
 517         ResetEvent (pending_done_event);
 518         mono_gc_finalize_notify ();
 519         /* g_print ("Waiting for pending finalizers....\n"); */
 520         guarded_wait (pending_done_event, INFINITE, TRUE);
 521         /* g_print ("Done pending....\n"); */
 522 }
 523
 524 void
 525 ves_icall_System_GC_register_ephemeron_array (MonoObject *array)
 526 {
 527 #ifdef HAVE_SGEN_GC
 528         if (!mono_gc_ephemeron_array_add (array)) {
 529                 mono_set_pending_exception (mono_object_domain (array)->out_of_memory_ex);
 530                 return;
 531         }
 532 #endif
 533 }
 534
 535 MonoObject*
 536 ves_icall_System_GC_get_ephemeron_tombstone (void)
 537 {
 538         return mono_domain_get ()->ephemeron_tombstone;
 539 }
 540
 541 MonoObject *
 542 ves_icall_System_GCHandle_GetTarget (guint32 handle)
 543 {
 544         return mono_gchandle_get_target (handle);
 545 }
 546
 547 /*
 548  * if type == -1, change the target of the handle, otherwise allocate a new handle.
 549  */
 550 guint32
 551 ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint32 type)
 552 {
 553         if (type == -1) {
 554                 mono_gchandle_set_target (handle, obj);
 555                 /* the handle doesn't change */
 556                 return handle;
 557         }
 558         switch (type) {
 559         case HANDLE_WEAK:
 560                 return mono_gchandle_new_weakref (obj, FALSE);
 561         case HANDLE_WEAK_TRACK:
 562                 return mono_gchandle_new_weakref (obj, TRUE);
 563         case HANDLE_NORMAL:
 564                 return mono_gchandle_new (obj, FALSE);
 565         case HANDLE_PINNED:
 566                 return mono_gchandle_new (obj, TRUE);
 567         default:
 568                 g_assert_not_reached ();
 569         }
 570         return 0;
 571 }
 572
 573 void
 574 ves_icall_System_GCHandle_FreeHandle (guint32 handle)
 575 {
 576         mono_gchandle_free (handle);
 577 }
 578
 579 gpointer
 580 ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle)
 581 {
 582         MonoObject *obj;
 583
 584         if (MONO_GC_HANDLE_TYPE (handle) != HANDLE_PINNED)
 585                 return (gpointer)-2;
 586         obj = mono_gchandle_get_target (handle);
 587         if (obj) {
 588                 MonoClass *klass = mono_object_class (obj);
 589                 if (klass == mono_defaults.string_class) {
 590                         return mono_string_chars ((MonoString*)obj);
 591                 } else if (klass->rank) {
 592                         return mono_array_addr ((MonoArray*)obj, char, 0);
 593                 } else {
 594                         /* the C# code will check and throw the exception */
 595                         /* FIXME: missing !klass->blittable test, see bug #61134 */
 596                         if ((klass->flags & TYPE_ATTRIBUTE_LAYOUT_MASK) == TYPE_ATTRIBUTE_AUTO_LAYOUT)
 597                                 return (gpointer)-1;
 598                         return (char*)obj + sizeof (MonoObject);
 599                 }
 600         }
 601         return NULL;
 602 }
 603
 604 MonoBoolean
 605 mono_gc_GCHandle_CheckCurrentDomain (guint32 gchandle)
 606 {
 607         return mono_gchandle_is_in_domain (gchandle, mono_domain_get ());
 608 }
 609
 610 static MonoCoopSem finalizer_sem;
 611 static volatile gboolean finished=FALSE;
 612
 613 void
 614 mono_gc_finalize_notify (void)
 615 {
 616 #ifdef DEBUG
 617         g_message ( "%s: prodding finalizer", __func__);
 618 #endif
 619
 620         if (mono_gc_is_null ())
 621                 return;
 622
 623         mono_coop_sem_post (&finalizer_sem);
 624 }
 625
 626 #ifdef HAVE_BOEHM_GC
 627
 628 static void
 629 collect_objects (gpointer key, gpointer value, gpointer user_data)
 630 {
 631         GPtrArray *arr = (GPtrArray*)user_data;
 632         g_ptr_array_add (arr, key);
 633 }
 634
 635 #endif
 636
 637 /*
 638  * finalize_domain_objects:
 639  *
 640  *  Run the finalizers of all finalizable objects in req->domain.
 641  */
 642 static void
 643 finalize_domain_objects (DomainFinalizationReq *req)
 644 {
 645         MonoDomain *domain = req->domain;
 646
 647 #if HAVE_SGEN_GC
 648 #define NUM_FOBJECTS 64
 649         MonoObject *to_finalize [NUM_FOBJECTS];
 650         int count;
 651 #endif
 652
 653         /* Process finalizers which are already in the queue */
 654         mono_gc_invoke_finalizers ();
 655
 656 #ifdef HAVE_BOEHM_GC
 657         while (g_hash_table_size (domain->finalizable_objects_hash) > 0) {
 658                 int i;
 659                 GPtrArray *objs;
 660                 /*
 661                  * Since the domain is unloading, nobody is allowed to put
 662                  * new entries into the hash table. But finalize_object might
 663                  * remove entries from the hash table, so we make a copy.
 664                  */
 665                 objs = g_ptr_array_new ();
 666                 g_hash_table_foreach (domain->finalizable_objects_hash, collect_objects, objs);
 667                 /* printf ("FINALIZING %d OBJECTS.\n", objs->len); */
 668
 669                 for (i = 0; i < objs->len; ++i) {
 670                         MonoObject *o = (MonoObject*)g_ptr_array_index (objs, i);
 671                         /* FIXME: Avoid finalizing threads, etc */
 672                         mono_gc_run_finalize (o, 0);
 673                 }
 674
 675                 g_ptr_array_free (objs, TRUE);
 676         }
 677 #elif defined(HAVE_SGEN_GC)
 678         while ((count = mono_gc_finalizers_for_domain (domain, to_finalize, NUM_FOBJECTS))) {
 679                 int i;
 680                 for (i = 0; i < count; ++i) {
 681                         mono_gc_run_finalize (to_finalize [i], 0);
 682                 }
 683         }
 684 #endif
 685
 686         /* cleanup the reference queue */
 687         reference_queue_clear_for_domain (domain);
 688
 689         /* printf ("DONE.\n"); */
 690         SetEvent (req->done_event);
 691
 692         /* The event is closed in mono_domain_finalize if we get here */
 693         g_free (req);
 694 }
 695
 696 static guint32
 697 finalizer_thread (gpointer unused)
 698 {
 699         gboolean wait = TRUE;
 700
 701         while (!finished) {
 702                 /* Wait to be notified that there's at least one
 703                  * finaliser to run
 704                  */
 705
 706                 g_assert (mono_domain_get () == mono_get_root_domain ());
 707                 mono_gc_set_skip_thread (TRUE);
 708
 709                 if (wait) {
 710                         /* An alertable wait is required so this thread can be suspended on windows */
 711                         mono_coop_sem_wait (&finalizer_sem, MONO_SEM_FLAGS_ALERTABLE);
 712                 }
 713                 wait = TRUE;
 714
 715                 mono_gc_set_skip_thread (FALSE);
 716
 717                 mono_threads_perform_thread_dump ();
 718
 719                 mono_console_handle_async_ops ();
 720
 721                 mono_attach_maybe_start ();
 722
 723                 if (domains_to_finalize) {
 724                         mono_finalizer_lock ();
 725                         if (domains_to_finalize) {
 726                                 DomainFinalizationReq *req = (DomainFinalizationReq *)domains_to_finalize->data;
 727                                 domains_to_finalize = g_slist_remove (domains_to_finalize, req);
 728                                 mono_finalizer_unlock ();
 729
 730                                 finalize_domain_objects (req);
 731                         } else {
 732                                 mono_finalizer_unlock ();
 733                         }
 734                 }
 735
 736                 /* If finished == TRUE, mono_gc_cleanup has been called (from mono_runtime_cleanup),
 737                  * before the domain is unloaded.
 738                  */
 739                 mono_gc_invoke_finalizers ();
 740
 741                 mono_threads_join_threads ();
 742
 743                 reference_queue_proccess_all ();
 744
 745                 /* Avoid posting the pending done event until there are pending finalizers */
 746                 if (mono_coop_sem_timedwait (&finalizer_sem, 0, MONO_SEM_FLAGS_NONE) == 0) {
 747                         /* Don't wait again at the start of the loop */
 748                         wait = FALSE;
 749                 } else {
 750                         SetEvent (pending_done_event);
 751                 }
 752         }
 753
 754         mono_finalizer_lock ();
 755         finalizer_thread_exited = TRUE;
 756         mono_coop_cond_signal (&exited_cond);
 757         mono_finalizer_unlock ();
 758
 759         return 0;
 760 }
 761
 762 #ifndef LAZY_GC_THREAD_CREATION
 763 static
 764 #endif
 765 void
 766 mono_gc_init_finalizer_thread (void)
 767 {
 768         gc_thread = mono_thread_create_internal (mono_domain_get (), finalizer_thread, NULL, FALSE, 0);
 769         ves_icall_System_Threading_Thread_SetName_internal (gc_thread, mono_string_new (mono_domain_get (), "Finalizer"));
 770 }
 771
 772 void
 773 mono_gc_init (void)
 774 {
 775         mono_coop_mutex_init_recursive (&finalizer_mutex);
 776         mono_coop_mutex_init_recursive (&reference_queue_mutex);
 777
 778         mono_counters_register ("Minor GC collections", MONO_COUNTER_GC | MONO_COUNTER_UINT, &gc_stats.minor_gc_count);
 779         mono_counters_register ("Major GC collections", MONO_COUNTER_GC | MONO_COUNTER_UINT, &gc_stats.major_gc_count);
 780         mono_counters_register ("Minor GC time", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &gc_stats.minor_gc_time);
 781         mono_counters_register ("Major GC time", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &gc_stats.major_gc_time);
 782         mono_counters_register ("Major GC time concurrent", MONO_COUNTER_GC | MONO_COUNTER_ULONG | MONO_COUNTER_TIME, &gc_stats.major_gc_time_concurrent);
 783
 784         mono_gc_base_init ();
 785
 786         if (mono_gc_is_disabled ()) {
 787                 gc_disabled = TRUE;
 788                 return;
 789         }
 790
 791         pending_done_event = CreateEvent (NULL, TRUE, FALSE, NULL);
 792         g_assert (pending_done_event);
 793         mono_coop_cond_init (&exited_cond);
 794         mono_coop_sem_init (&finalizer_sem, 0);
 795
 796 #ifndef LAZY_GC_THREAD_CREATION
 797         mono_gc_init_finalizer_thread ();
 798 #endif
 799 }
 800
 801 void
 802 mono_gc_cleanup (void)
 803 {
 804 #ifdef DEBUG
 805         g_message ("%s: cleaning up finalizer", __func__);
 806 #endif
 807
 808         if (mono_gc_is_null ())
 809                 return;
 810
 811         if (!gc_disabled) {
 812                 finished = TRUE;
 813                 if (mono_thread_internal_current () != gc_thread) {
 814                         gboolean timed_out = FALSE;
 815                         guint32 start_ticks = mono_msec_ticks ();
 816                         guint32 end_ticks = start_ticks + 2000;
 817
 818                         mono_gc_finalize_notify ();
 819                         /* Finishing the finalizer thread, so wait a little bit... */
 820                         /* MS seems to wait for about 2 seconds */
 821                         while (!finalizer_thread_exited) {
 822                                 guint32 current_ticks = mono_msec_ticks ();
 823                                 guint32 timeout;
 824
 825                                 if (current_ticks >= end_ticks)
 826                                         break;
 827                                 else
 828                                         timeout = end_ticks - current_ticks;
 829                                 mono_finalizer_lock ();
 830                                 if (!finalizer_thread_exited)
 831                                         mono_coop_cond_timedwait (&exited_cond, &finalizer_mutex, timeout);
 832                                 mono_finalizer_unlock ();
 833                         }
 834
 835                         if (!finalizer_thread_exited) {
 836                                 int ret;
 837
 838                                 /* Set a flag which the finalizer thread can check */
 839                                 suspend_finalizers = TRUE;
 840
 841                                 /* Try to abort the thread, in the hope that it is running managed code */
 842                                 mono_thread_internal_stop (gc_thread);
 843
 844                                 /* Wait for it to stop */
 845                                 ret = guarded_wait (gc_thread->handle, 100, TRUE);
 846
 847                                 if (ret == WAIT_TIMEOUT) {
 848                                         /*
 849                                          * The finalizer thread refused to die. There is not much we
 850                                          * can do here, since the runtime is shutting down so the
 851                                          * state the finalizer thread depends on will vanish.
 852                                          */
 853                                         g_warning ("Shutting down finalizer thread timed out.");
 854                                         timed_out = TRUE;
 855                                 }
 856                         }
 857
 858                         if (!timed_out) {
 859                                 int ret;
 860
 861                                 /* Wait for the thread to actually exit */
 862                                 ret = guarded_wait (gc_thread->handle, INFINITE, TRUE);
 863                                 g_assert (ret == WAIT_OBJECT_0);
 864
 865                                 mono_thread_join (GUINT_TO_POINTER (gc_thread->tid));
 866                         }
 867                         g_assert (finalizer_thread_exited);
 868                 }
 869                 gc_thread = NULL;
 870                 mono_gc_base_cleanup ();
 871         }
 872
 873         mono_reference_queue_cleanup ();
 874
 875         mono_coop_mutex_destroy (&finalizer_mutex);
 876         mono_coop_mutex_destroy (&reference_queue_mutex);
 877 }
 878
 879 gboolean
 880 mono_gc_is_finalizer_internal_thread (MonoInternalThread *thread)
 881 {
 882         return thread == gc_thread;
 883 }
 884
 885 /**
 886  * mono_gc_is_finalizer_thread:
 887  * @thread: the thread to test.
 888  *
 889  * In Mono objects are finalized asynchronously on a separate thread.
 890  * This routine tests whether the @thread argument represents the
 891  * finalization thread.
 892  *
 893  * Returns true if @thread is the finalization thread.
 894  */
 895 gboolean
 896 mono_gc_is_finalizer_thread (MonoThread *thread)
 897 {
 898         return mono_gc_is_finalizer_internal_thread (thread->internal_thread);
 899 }
 900
 901 #if defined(__MACH__)
 902 static pthread_t mach_exception_thread;
 903
 904 void
 905 mono_gc_register_mach_exception_thread (pthread_t thread)
 906 {
 907         mach_exception_thread = thread;
 908 }
 909
 910 pthread_t
 911 mono_gc_get_mach_exception_thread (void)
 912 {
 913         return mach_exception_thread;
 914 }
 915 #endif
 916
 917 static MonoReferenceQueue *ref_queues;
 918
 919 static void
 920 ref_list_remove_element (RefQueueEntry **prev, RefQueueEntry *element)
 921 {
 922         do {
 923                 /* Guard if head is changed concurrently. */
 924                 while (*prev != element)
 925                         prev = &(*prev)->next;
 926         } while (prev && InterlockedCompareExchangePointer ((volatile gpointer *)prev, element->next, element) != element);
 927 }
 928
 929 static void
 930 ref_list_push (RefQueueEntry **head, RefQueueEntry *value)
 931 {
 932         RefQueueEntry *current;
 933         do {
 934                 current = *head;
 935                 value->next = current;
 936                 STORE_STORE_FENCE; /*Must make sure the previous store is visible before the CAS. */
 937         } while (InterlockedCompareExchangePointer ((volatile gpointer *)head, value, current) != current);
 938 }
 939
 940 static void
 941 reference_queue_proccess (MonoReferenceQueue *queue)
 942 {
 943         RefQueueEntry **iter = &queue->queue;
 944         RefQueueEntry *entry;
 945         while ((entry = *iter)) {
 946                 if (queue->should_be_deleted || !mono_gchandle_get_target (entry->gchandle)) {
 947                         mono_gchandle_free ((guint32)entry->gchandle);
 948                         ref_list_remove_element (iter, entry);
 949                         queue->callback (entry->user_data);
 950                         g_free (entry);
 951                 } else {
 952                         iter = &entry->next;
 953                 }
 954         }
 955 }
 956
 957 static void
 958 reference_queue_proccess_all (void)
 959 {
 960         MonoReferenceQueue **iter;
 961         MonoReferenceQueue *queue = ref_queues;
 962         for (; queue; queue = queue->next)
 963                 reference_queue_proccess (queue);
 964
 965 restart:
 966         mono_coop_mutex_lock (&reference_queue_mutex);
 967         for (iter = &ref_queues; *iter;) {
 968                 queue = *iter;
 969                 if (!queue->should_be_deleted) {
 970                         iter = &queue->next;
 971                         continue;
 972                 }
 973                 if (queue->queue) {
 974                         mono_coop_mutex_unlock (&reference_queue_mutex);
 975                         reference_queue_proccess (queue);
 976                         goto restart;
 977                 }
 978                 *iter = queue->next;
 979                 g_free (queue);
 980         }
 981         mono_coop_mutex_unlock (&reference_queue_mutex);
 982 }
 983
 984 static void
 985 mono_reference_queue_cleanup (void)
 986 {
 987         MonoReferenceQueue *queue = ref_queues;
 988         for (; queue; queue = queue->next)
 989                 queue->should_be_deleted = TRUE;
 990         reference_queue_proccess_all ();
 991 }
 992
 993 static void
 994 reference_queue_clear_for_domain (MonoDomain *domain)
 995 {
 996         MonoReferenceQueue *queue = ref_queues;
 997         for (; queue; queue = queue->next) {
 998                 RefQueueEntry **iter = &queue->queue;
 999                 RefQueueEntry *entry;
1000                 while ((entry = *iter)) {
1001                         if (entry->domain == domain) {
1002                                 mono_gchandle_free ((guint32)entry->gchandle);
1003                                 ref_list_remove_element (iter, entry);
1004                                 queue->callback (entry->user_data);
1005                                 g_free (entry);
1006                         } else {
1007                                 iter = &entry->next;
1008                         }
1009                 }
1010         }
1011 }
1012 /**
1013  * mono_gc_reference_queue_new:
1014  * @callback callback used when processing collected entries.
1015  *
1016  * Create a new reference queue used to process collected objects.
1017  * A reference queue let you add a pair of (managed object, user data)
1018  * using the mono_gc_reference_queue_add method.
1019  *
1020  * Once the managed object is collected @callback will be called
1021  * in the finalizer thread with 'user data' as argument.
1022  *
1023  * The callback is called from the finalizer thread without any locks held.
1024  * When a AppDomain is unloaded, all callbacks for objects belonging to it
1025  * will be invoked.
1026  *
1027  * @returns the new queue.
1028  */
1029 MonoReferenceQueue*
1030 mono_gc_reference_queue_new (mono_reference_queue_callback callback)
1031 {
1032         MonoReferenceQueue *res = g_new0 (MonoReferenceQueue, 1);
1033         res->callback = callback;
1034
1035         mono_coop_mutex_lock (&reference_queue_mutex);
1036         res->next = ref_queues;
1037         ref_queues = res;
1038         mono_coop_mutex_unlock (&reference_queue_mutex);
1039
1040         return res;
1041 }
1042
1043 /**
1044  * mono_gc_reference_queue_add:
1045  * @queue the queue to add the reference to.
1046  * @obj the object to be watched for collection
1047  * @user_data parameter to be passed to the queue callback
1048  *
1049  * Queue an object to be watched for collection, when the @obj is
1050  * collected, the callback that was registered for the @queue will
1051  * be invoked with @user_data as argument.
1052  *
1053  * @returns false if the queue is scheduled to be freed.
1054  */
1055 gboolean
1056 mono_gc_reference_queue_add (MonoReferenceQueue *queue, MonoObject *obj, void *user_data)
1057 {
1058         RefQueueEntry *entry;
1059         if (queue->should_be_deleted)
1060                 return FALSE;
1061
1062         entry = g_new0 (RefQueueEntry, 1);
1063         entry->user_data = user_data;
1064         entry->domain = mono_object_domain (obj);
1065
1066         entry->gchandle = mono_gchandle_new_weakref (obj, TRUE);
1067         mono_object_register_finalizer (obj);
1068
1069         ref_list_push (&queue->queue, entry);
1070         return TRUE;
1071 }
1072
1073 /**
1074  * mono_gc_reference_queue_free:
1075  * @queue the queue that should be freed.
1076  *
1077  * This operation signals that @queue should be freed. This operation is deferred
1078  * as it happens on the finalizer thread.
1079  *
1080  * After this call, no further objects can be queued. It's the responsibility of the
1081  * caller to make sure that no further attempt to access queue will be made.
1082  */
1083 void
1084 mono_gc_reference_queue_free (MonoReferenceQueue *queue)
1085 {
1086         queue->should_be_deleted = TRUE;
1087 }