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