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