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  */
   9
  10 #include <config.h>
  11 #include <glib.h>
  12 #include <string.h>
  13
  14 #include <mono/metadata/gc-internal.h>
  15 #include <mono/metadata/mono-gc.h>
  16 #include <mono/metadata/threads.h>
  17 #include <mono/metadata/tabledefs.h>
  18 #include <mono/metadata/exception.h>
  19 #include <mono/metadata/profiler-private.h>
  20 #include <mono/metadata/domain-internals.h>
  21 #include <mono/metadata/class-internals.h>
  22 #include <mono/metadata/metadata-internals.h>
  23 #include <mono/metadata/mono-mlist.h>
  24 #include <mono/metadata/threadpool.h>
  25 #include <mono/metadata/threads-types.h>
  26 #include <mono/utils/mono-logger.h>
  27 #include <mono/metadata/gc-internal.h>
  28 #include <mono/metadata/marshal.h> /* for mono_delegate_free_ftnptr () */
  29 #include <mono/metadata/attach.h>
  30 #include <mono/utils/mono-semaphore.h>
  31
  32 #ifndef HOST_WIN32
  33 #include <pthread.h>
  34 #endif
  35
  36 typedef struct DomainFinalizationReq {
  37         MonoDomain *domain;
  38         HANDLE done_event;
  39 } DomainFinalizationReq;
  40
  41 #ifdef PLATFORM_WINCE /* FIXME: add accessors to gc.dll API */
  42 extern void (*__imp_GC_finalizer_notifier)(void);
  43 #define GC_finalizer_notifier __imp_GC_finalizer_notifier
  44 extern int __imp_GC_finalize_on_demand;
  45 #define GC_finalize_on_demand __imp_GC_finalize_on_demand
  46 #endif
  47
  48 static gboolean gc_disabled = FALSE;
  49
  50 static gboolean finalizing_root_domain = FALSE;
  51
  52 #define mono_finalizer_lock() EnterCriticalSection (&finalizer_mutex)
  53 #define mono_finalizer_unlock() LeaveCriticalSection (&finalizer_mutex)
  54 static CRITICAL_SECTION finalizer_mutex;
  55
  56 static GSList *domains_to_finalize= NULL;
  57 static MonoMList *threads_to_finalize = NULL;
  58
  59 static MonoInternalThread *gc_thread;
  60
  61 static void object_register_finalizer (MonoObject *obj, void (*callback)(void *, void*));
  62
  63 static void mono_gchandle_set_target (guint32 gchandle, MonoObject *obj);
  64
  65 #ifndef HAVE_NULL_GC
  66 static HANDLE pending_done_event;
  67 static HANDLE shutdown_event;
  68 #endif
  69
  70 static void
  71 add_thread_to_finalize (MonoInternalThread *thread)
  72 {
  73         mono_finalizer_lock ();
  74         if (!threads_to_finalize)
  75                 MONO_GC_REGISTER_ROOT (threads_to_finalize);
  76         threads_to_finalize = mono_mlist_append (threads_to_finalize, (MonoObject*)thread);
  77         mono_finalizer_unlock ();
  78 }
  79
  80 static gboolean suspend_finalizers = FALSE;
  81 /*
  82  * actually, we might want to queue the finalize requests in a separate thread,
  83  * but we need to be careful about the execution domain of the thread...
  84  */
  85 void
  86 mono_gc_run_finalize (void *obj, void *data)
  87 {
  88         MonoObject *exc = NULL;
  89         MonoObject *o;
  90 #ifndef HAVE_SGEN_GC
  91         MonoObject *o2;
  92 #endif
  93         MonoMethod* finalizer = NULL;
  94         MonoDomain *caller_domain = mono_domain_get ();
  95         MonoDomain *domain;
  96         RuntimeInvokeFunction runtime_invoke;
  97         GSList *l, *refs = NULL;
  98
  99         o = (MonoObject*)((char*)obj + GPOINTER_TO_UINT (data));
 100
 101         if (suspend_finalizers)
 102                 return;
 103
 104         domain = o->vtable->domain;
 105
 106 #ifndef HAVE_SGEN_GC
 107         mono_domain_finalizers_lock (domain);
 108
 109         o2 = g_hash_table_lookup (domain->finalizable_objects_hash, o);
 110
 111         refs = mono_gc_remove_weak_track_object (domain, o);
 112
 113         mono_domain_finalizers_unlock (domain);
 114
 115         if (!o2)
 116                 /* Already finalized somehow */
 117                 return;
 118 #endif
 119
 120         if (refs) {
 121                 /*
 122                  * Support for GCHandles of type WeakTrackResurrection:
 123                  *
 124                  *   Its not exactly clear how these are supposed to work, or how their
 125                  * semantics can be implemented. We only implement one crucial thing:
 126                  * these handles are only cleared after the finalizer has ran.
 127                  */
 128                 for (l = refs; l; l = l->next) {
 129                         guint32 gchandle = GPOINTER_TO_UINT (l->data);
 130
 131                         mono_gchandle_set_target (gchandle, o);
 132                 }
 133
 134                 g_slist_free (refs);
 135         }
 136
 137         /* make sure the finalizer is not called again if the object is resurrected */
 138         object_register_finalizer (obj, NULL);
 139
 140         if (o->vtable->klass == mono_defaults.internal_thread_class) {
 141                 MonoInternalThread *t = (MonoInternalThread*)o;
 142
 143                 if (mono_gc_is_finalizer_internal_thread (t))
 144                         /* Avoid finalizing ourselves */
 145                         return;
 146
 147                 if (t->threadpool_thread && finalizing_root_domain) {
 148                         /* Don't finalize threadpool threads when
 149                            shutting down - they're finalized when the
 150                            threadpool shuts down. */
 151                         add_thread_to_finalize (t);
 152                         return;
 153                 }
 154         }
 155
 156         if (o->vtable->klass->image == mono_defaults.corlib && !strcmp (o->vtable->klass->name, "DynamicMethod") && finalizing_root_domain) {
 157                 /*
 158                  * These can't be finalized during unloading/shutdown, since that would
 159                  * free the native code which can still be referenced by other
 160                  * finalizers.
 161                  * FIXME: This is not perfect, objects dying at the same time as
 162                  * dynamic methods can still reference them even when !shutdown.
 163                  */
 164                 return;
 165         }
 166
 167         if (mono_runtime_get_no_exec ())
 168                 return;
 169
 170         /* speedup later... and use a timeout */
 171         /* g_print ("Finalize run on %p %s.%s\n", o, mono_object_class (o)->name_space, mono_object_class (o)->name); */
 172
 173         /* Use _internal here, since this thread can enter a doomed appdomain */
 174         mono_domain_set_internal (mono_object_domain (o));
 175
 176         /* delegates that have a native function pointer allocated are
 177          * registered for finalization, but they don't have a Finalize
 178          * method, because in most cases it's not needed and it's just a waste.
 179          */
 180         if (o->vtable->klass->delegate) {
 181                 MonoDelegate* del = (MonoDelegate*)o;
 182                 if (del->delegate_trampoline)
 183                         mono_delegate_free_ftnptr ((MonoDelegate*)o);
 184                 mono_domain_set_internal (caller_domain);
 185                 return;
 186         }
 187
 188         finalizer = mono_class_get_finalizer (o->vtable->klass);
 189
 190 #ifndef DISABLE_COM
 191         /* If object has a CCW but has no finalizer, it was only
 192          * registered for finalization in order to free the CCW.
 193          * Else it needs the regular finalizer run.
 194          * FIXME: what to do about ressurection and suppression
 195          * of finalizer on object with CCW.
 196          */
 197         if (mono_marshal_free_ccw (o) && !finalizer) {
 198                 mono_domain_set_internal (caller_domain);
 199                 return;
 200         }
 201 #endif
 202
 203         /*
 204          * To avoid the locking plus the other overhead of mono_runtime_invoke (),
 205          * create and precompile a wrapper which calls the finalize method using
 206          * a CALLVIRT.
 207          */
 208         if (!domain->finalize_runtime_invoke) {
 209                 MonoMethod *invoke = mono_marshal_get_runtime_invoke (mono_class_get_method_from_name_flags (mono_defaults.object_class, "Finalize", 0, 0), TRUE);
 210
 211                 domain->finalize_runtime_invoke = mono_compile_method (invoke);
 212         }
 213
 214         runtime_invoke = domain->finalize_runtime_invoke;
 215
 216         mono_runtime_class_init (o->vtable);
 217
 218         runtime_invoke (o, NULL, &exc, NULL);
 219
 220         if (exc) {
 221                 /* fixme: do something useful */
 222         }
 223
 224         mono_domain_set_internal (caller_domain);
 225 }
 226
 227 void
 228 mono_gc_finalize_threadpool_threads (void)
 229 {
 230         while (threads_to_finalize) {
 231                 MonoInternalThread *thread = (MonoInternalThread*) mono_mlist_get_data (threads_to_finalize);
 232
 233                 /* Force finalization of the thread. */
 234                 thread->threadpool_thread = FALSE;
 235                 mono_object_register_finalizer ((MonoObject*)thread);
 236
 237                 mono_gc_run_finalize (thread, NULL);
 238
 239                 threads_to_finalize = mono_mlist_next (threads_to_finalize);
 240         }
 241 }
 242
 243 gpointer
 244 mono_gc_out_of_memory (size_t size)
 245 {
 246         /*
 247          * we could allocate at program startup some memory that we could release
 248          * back to the system at this point if we're really low on memory (ie, size is
 249          * lower than the memory we set apart)
 250          */
 251         mono_raise_exception (mono_domain_get ()->out_of_memory_ex);
 252
 253         return NULL;
 254 }
 255
 256 /*
 257  * Some of our objects may point to a different address than the address returned by GC_malloc()
 258  * (because of the GetHashCode hack), but we need to pass the real address to register_finalizer.
 259  * This also means that in the callback we need to adjust the pointer to get back the real
 260  * MonoObject*.
 261  * We also need to be consistent in the use of the GC_debug* variants of malloc and register_finalizer,
 262  * since that, too, can cause the underlying pointer to be offset.
 263  */
 264 static void
 265 object_register_finalizer (MonoObject *obj, void (*callback)(void *, void*))
 266 {
 267 #if HAVE_BOEHM_GC
 268         guint offset = 0;
 269         MonoDomain *domain;
 270
 271         if (obj == NULL)
 272                 mono_raise_exception (mono_get_exception_argument_null ("obj"));
 273
 274         domain = obj->vtable->domain;
 275
 276 #ifndef GC_DEBUG
 277         /* This assertion is not valid when GC_DEBUG is defined */
 278         g_assert (GC_base (obj) == (char*)obj - offset);
 279 #endif
 280
 281         if (mono_domain_is_unloading (domain) && (callback != NULL))
 282                 /*
 283                  * Can't register finalizers in a dying appdomain, since they
 284                  * could be invoked after the appdomain has been unloaded.
 285                  */
 286                 return;
 287
 288         mono_domain_finalizers_lock (domain);
 289
 290         if (callback)
 291                 g_hash_table_insert (domain->finalizable_objects_hash, obj, obj);
 292         else
 293                 g_hash_table_remove (domain->finalizable_objects_hash, obj);
 294
 295         mono_domain_finalizers_unlock (domain);
 296
 297         GC_REGISTER_FINALIZER_NO_ORDER ((char*)obj - offset, callback, GUINT_TO_POINTER (offset), NULL, NULL);
 298 #elif defined(HAVE_SGEN_GC)
 299         if (obj == NULL)
 300                 mono_raise_exception (mono_get_exception_argument_null ("obj"));
 301
 302         mono_gc_register_for_finalization (obj, callback);
 303 #endif
 304 }
 305
 306 /**
 307  * mono_object_register_finalizer:
 308  * @obj: object to register
 309  *
 310  * Records that object @obj has a finalizer, this will call the
 311  * Finalize method when the garbage collector disposes the object.
 312  *
 313  */
 314 void
 315 mono_object_register_finalizer (MonoObject *obj)
 316 {
 317         /* g_print ("Registered finalizer on %p %s.%s\n", obj, mono_object_class (obj)->name_space, mono_object_class (obj)->name); */
 318         object_register_finalizer (obj, mono_gc_run_finalize);
 319 }
 320
 321 /**
 322  * mono_domain_finalize:
 323  * @domain: the domain to finalize
 324  * @timeout: msects to wait for the finalization to complete, -1 to wait indefinitely
 325  *
 326  *  Request finalization of all finalizable objects inside @domain. Wait
 327  * @timeout msecs for the finalization to complete.
 328  *
 329  * Returns: TRUE if succeeded, FALSE if there was a timeout
 330  */
 331
 332 gboolean
 333 mono_domain_finalize (MonoDomain *domain, guint32 timeout)
 334 {
 335         DomainFinalizationReq *req;
 336         guint32 res;
 337         HANDLE done_event;
 338
 339         if (mono_thread_internal_current () == gc_thread)
 340                 /* We are called from inside a finalizer, not much we can do here */
 341                 return FALSE;
 342
 343         /*
 344          * No need to create another thread 'cause the finalizer thread
 345          * is still working and will take care of running the finalizers
 346          */
 347
 348 #ifndef HAVE_NULL_GC
 349         if (gc_disabled)
 350                 return TRUE;
 351
 352         mono_gc_collect (mono_gc_max_generation ());
 353
 354         done_event = CreateEvent (NULL, TRUE, FALSE, NULL);
 355         if (done_event == NULL) {
 356                 return FALSE;
 357         }
 358
 359         req = g_new0 (DomainFinalizationReq, 1);
 360         req->domain = domain;
 361         req->done_event = done_event;
 362
 363         if (domain == mono_get_root_domain ())
 364                 finalizing_root_domain = TRUE;
 365
 366         mono_finalizer_lock ();
 367
 368         domains_to_finalize = g_slist_append (domains_to_finalize, req);
 369
 370         mono_finalizer_unlock ();
 371
 372         /* Tell the finalizer thread to finalize this appdomain */
 373         mono_gc_finalize_notify ();
 374
 375         if (timeout == -1)
 376                 timeout = INFINITE;
 377
 378         res = WaitForSingleObjectEx (done_event, timeout, TRUE);
 379
 380         /* printf ("WAIT RES: %d.\n", res); */
 381         if (res == WAIT_TIMEOUT) {
 382                 /* We leak the handle here */
 383                 return FALSE;
 384         }
 385
 386         CloseHandle (done_event);
 387
 388         if (domain == mono_get_root_domain ()) {
 389                 mono_thread_pool_cleanup ();
 390                 mono_gc_finalize_threadpool_threads ();
 391         }
 392
 393         return TRUE;
 394 #else
 395         /* We don't support domain finalization without a GC */
 396         return FALSE;
 397 #endif
 398 }
 399
 400 void
 401 ves_icall_System_GC_InternalCollect (int generation)
 402 {
 403         mono_gc_collect (generation);
 404 }
 405
 406 gint64
 407 ves_icall_System_GC_GetTotalMemory (MonoBoolean forceCollection)
 408 {
 409         MONO_ARCH_SAVE_REGS;
 410
 411         if (forceCollection)
 412                 mono_gc_collect (mono_gc_max_generation ());
 413         return mono_gc_get_used_size ();
 414 }
 415
 416 void
 417 ves_icall_System_GC_KeepAlive (MonoObject *obj)
 418 {
 419         MONO_ARCH_SAVE_REGS;
 420
 421         /*
 422          * Does nothing.
 423          */
 424 }
 425
 426 void
 427 ves_icall_System_GC_ReRegisterForFinalize (MonoObject *obj)
 428 {
 429         if (!obj)
 430                 mono_raise_exception (mono_get_exception_argument_null ("obj"));
 431
 432         object_register_finalizer (obj, mono_gc_run_finalize);
 433 }
 434
 435 void
 436 ves_icall_System_GC_SuppressFinalize (MonoObject *obj)
 437 {
 438         if (!obj)
 439                 mono_raise_exception (mono_get_exception_argument_null ("obj"));
 440
 441         /* delegates have no finalizers, but we register them to deal with the
 442          * unmanaged->managed trampoline. We don't let the user suppress it
 443          * otherwise we'd leak it.
 444          */
 445         if (obj->vtable->klass->delegate)
 446                 return;
 447
 448         /* FIXME: Need to handle case where obj has COM Callable Wrapper
 449          * generated for it that needs cleaned up, but user wants to suppress
 450          * their derived object finalizer. */
 451
 452         object_register_finalizer (obj, NULL);
 453 }
 454
 455 void
 456 ves_icall_System_GC_WaitForPendingFinalizers (void)
 457 {
 458 #ifndef HAVE_NULL_GC
 459         if (!mono_gc_pending_finalizers ())
 460                 return;
 461
 462         if (mono_thread_internal_current () == gc_thread)
 463                 /* Avoid deadlocks */
 464                 return;
 465
 466         ResetEvent (pending_done_event);
 467         mono_gc_finalize_notify ();
 468         /* g_print ("Waiting for pending finalizers....\n"); */
 469         WaitForSingleObjectEx (pending_done_event, INFINITE, TRUE);
 470         /* g_print ("Done pending....\n"); */
 471 #endif
 472 }
 473
 474 #define mono_allocator_lock() EnterCriticalSection (&allocator_section)
 475 #define mono_allocator_unlock() LeaveCriticalSection (&allocator_section)
 476 static CRITICAL_SECTION allocator_section;
 477 static CRITICAL_SECTION handle_section;
 478
 479 typedef enum {
 480         HANDLE_WEAK,
 481         HANDLE_WEAK_TRACK,
 482         HANDLE_NORMAL,
 483         HANDLE_PINNED
 484 } HandleType;
 485
 486 static HandleType mono_gchandle_get_type (guint32 gchandle);
 487
 488 MonoObject *
 489 ves_icall_System_GCHandle_GetTarget (guint32 handle)
 490 {
 491         return mono_gchandle_get_target (handle);
 492 }
 493
 494 /*
 495  * if type == -1, change the target of the handle, otherwise allocate a new handle.
 496  */
 497 guint32
 498 ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint32 type)
 499 {
 500         if (type == -1) {
 501                 mono_gchandle_set_target (handle, obj);
 502                 /* the handle doesn't change */
 503                 return handle;
 504         }
 505         switch (type) {
 506         case HANDLE_WEAK:
 507                 return mono_gchandle_new_weakref (obj, FALSE);
 508         case HANDLE_WEAK_TRACK:
 509                 return mono_gchandle_new_weakref (obj, TRUE);
 510         case HANDLE_NORMAL:
 511                 return mono_gchandle_new (obj, FALSE);
 512         case HANDLE_PINNED:
 513                 return mono_gchandle_new (obj, TRUE);
 514         default:
 515                 g_assert_not_reached ();
 516         }
 517         return 0;
 518 }
 519
 520 void
 521 ves_icall_System_GCHandle_FreeHandle (guint32 handle)
 522 {
 523         mono_gchandle_free (handle);
 524 }
 525
 526 gpointer
 527 ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle)
 528 {
 529         MonoObject *obj;
 530
 531         if (mono_gchandle_get_type (handle) != HANDLE_PINNED)
 532                 return (gpointer)-2;
 533         obj = mono_gchandle_get_target (handle);
 534         if (obj) {
 535                 MonoClass *klass = mono_object_class (obj);
 536                 if (klass == mono_defaults.string_class) {
 537                         return mono_string_chars ((MonoString*)obj);
 538                 } else if (klass->rank) {
 539                         return mono_array_addr ((MonoArray*)obj, char, 0);
 540                 } else {
 541                         /* the C# code will check and throw the exception */
 542                         /* FIXME: missing !klass->blittable test, see bug #61134 */
 543                         if ((klass->flags & TYPE_ATTRIBUTE_LAYOUT_MASK) == TYPE_ATTRIBUTE_AUTO_LAYOUT)
 544                                 return (gpointer)-1;
 545                         return (char*)obj + sizeof (MonoObject);
 546                 }
 547         }
 548         return NULL;
 549 }
 550
 551 typedef struct {
 552         guint32  *bitmap;
 553         gpointer *entries;
 554         guint32   size;
 555         guint8    type;
 556         guint     slot_hint : 24; /* starting slot for search */
 557         /* 2^16 appdomains should be enough for everyone (though I know I'll regret this in 20 years) */
 558         /* we alloc this only for weak refs, since we can get the domain directly in the other cases */
 559         guint16  *domain_ids;
 560 } HandleData;
 561
 562 /* weak and weak-track arrays will be allocated in malloc memory
 563  */
 564 static HandleData gc_handles [] = {
 565         {NULL, NULL, 0, HANDLE_WEAK, 0},
 566         {NULL, NULL, 0, HANDLE_WEAK_TRACK, 0},
 567         {NULL, NULL, 0, HANDLE_NORMAL, 0},
 568         {NULL, NULL, 0, HANDLE_PINNED, 0}
 569 };
 570
 571 #define lock_handles(handles) EnterCriticalSection (&handle_section)
 572 #define unlock_handles(handles) LeaveCriticalSection (&handle_section)
 573
 574 static int
 575 find_first_unset (guint32 bitmap)
 576 {
 577         int i;
 578         for (i = 0; i < 32; ++i) {
 579                 if (!(bitmap & (1 << i)))
 580                         return i;
 581         }
 582         return -1;
 583 }
 584
 585 static guint32
 586 alloc_handle (HandleData *handles, MonoObject *obj, gboolean track)
 587 {
 588         gint slot, i;
 589         lock_handles (handles);
 590         if (!handles->size) {
 591                 handles->size = 32;
 592                 if (handles->type > HANDLE_WEAK_TRACK) {
 593                         handles->entries = mono_gc_alloc_fixed (sizeof (gpointer) * handles->size, NULL);
 594                 } else {
 595                         handles->entries = g_malloc0 (sizeof (gpointer) * handles->size);
 596                         handles->domain_ids = g_malloc0 (sizeof (guint16) * handles->size);
 597                 }
 598                 handles->bitmap = g_malloc0 (handles->size / 8);
 599         }
 600         i = -1;
 601         for (slot = handles->slot_hint; slot < handles->size / 32; ++slot) {
 602                 if (handles->bitmap [slot] != 0xffffffff) {
 603                         i = find_first_unset (handles->bitmap [slot]);
 604                         handles->slot_hint = slot;
 605                         break;
 606                 }
 607         }
 608         if (i == -1 && handles->slot_hint != 0) {
 609                 for (slot = 0; slot < handles->slot_hint; ++slot) {
 610                         if (handles->bitmap [slot] != 0xffffffff) {
 611                                 i = find_first_unset (handles->bitmap [slot]);
 612                                 handles->slot_hint = slot;
 613                                 break;
 614                         }
 615                 }
 616         }
 617         if (i == -1) {
 618                 guint32 *new_bitmap;
 619                 guint32 new_size = handles->size * 2; /* always double: we memset to 0 based on this below */
 620
 621                 /* resize and copy the bitmap */
 622                 new_bitmap = g_malloc0 (new_size / 8);
 623                 memcpy (new_bitmap, handles->bitmap, handles->size / 8);
 624                 g_free (handles->bitmap);
 625                 handles->bitmap = new_bitmap;
 626
 627                 /* resize and copy the entries */
 628                 if (handles->type > HANDLE_WEAK_TRACK) {
 629                         gpointer *entries;
 630                         entries = mono_gc_alloc_fixed (sizeof (gpointer) * new_size, NULL);
 631                         memcpy (entries, handles->entries, sizeof (gpointer) * handles->size);
 632                         handles->entries = entries;
 633                 } else {
 634                         gpointer *entries;
 635                         guint16 *domain_ids;
 636                         domain_ids = g_malloc0 (sizeof (guint16) * new_size);
 637                         entries = g_malloc (sizeof (gpointer) * new_size);
 638                         /* we disable GC because we could lose some disappearing link updates */
 639                         mono_gc_disable ();
 640                         memcpy (entries, handles->entries, sizeof (gpointer) * handles->size);
 641                         memset (entries + handles->size, 0, sizeof (gpointer) * handles->size);
 642                         memcpy (domain_ids, handles->domain_ids, sizeof (guint16) * handles->size);
 643                         for (i = 0; i < handles->size; ++i) {
 644                                 MonoObject *obj = mono_gc_weak_link_get (&(handles->entries [i]));
 645                                 if (handles->entries [i])
 646                                         mono_gc_weak_link_remove (&(handles->entries [i]));
 647                                 /*g_print ("reg/unreg entry %d of type %d at %p to object %p (%p), was: %p\n", i, handles->type, &(entries [i]), obj, entries [i], handles->entries [i]);*/
 648                                 if (obj) {
 649                                         mono_gc_weak_link_add (&(entries [i]), obj, track);
 650                                 }
 651                         }
 652                         g_free (handles->entries);
 653                         g_free (handles->domain_ids);
 654                         handles->entries = entries;
 655                         handles->domain_ids = domain_ids;
 656                         mono_gc_enable ();
 657                 }
 658
 659                 /* set i and slot to the next free position */
 660                 i = 0;
 661                 slot = (handles->size + 1) / 32;
 662                 handles->slot_hint = handles->size + 1;
 663                 handles->size = new_size;
 664         }
 665         handles->bitmap [slot] |= 1 << i;
 666         slot = slot * 32 + i;
 667         handles->entries [slot] = obj;
 668         if (handles->type <= HANDLE_WEAK_TRACK) {
 669                 if (obj)
 670                         mono_gc_weak_link_add (&(handles->entries [slot]), obj, track);
 671         }
 672
 673         mono_perfcounters->gc_num_handles++;
 674         unlock_handles (handles);
 675         /*g_print ("allocated entry %d of type %d to object %p (in slot: %p)\n", slot, handles->type, obj, handles->entries [slot]);*/
 676         return (slot << 3) | (handles->type + 1);
 677 }
 678
 679 /**
 680  * mono_gchandle_new:
 681  * @obj: managed object to get a handle for
 682  * @pinned: whether the object should be pinned
 683  *
 684  * This returns a handle that wraps the object, this is used to keep a
 685  * reference to a managed object from the unmanaged world and preventing the
 686  * object from being disposed.
 687  *
 688  * If @pinned is false the address of the object can not be obtained, if it is
 689  * true the address of the object can be obtained.  This will also pin the
 690  * object so it will not be possible by a moving garbage collector to move the
 691  * object.
 692  *
 693  * Returns: a handle that can be used to access the object from
 694  * unmanaged code.
 695  */
 696 guint32
 697 mono_gchandle_new (MonoObject *obj, gboolean pinned)
 698 {
 699         return alloc_handle (&gc_handles [pinned? HANDLE_PINNED: HANDLE_NORMAL], obj, FALSE);
 700 }
 701
 702 /**
 703  * mono_gchandle_new_weakref:
 704  * @obj: managed object to get a handle for
 705  * @pinned: whether the object should be pinned
 706  *
 707  * This returns a weak handle that wraps the object, this is used to
 708  * keep a reference to a managed object from the unmanaged world.
 709  * Unlike the mono_gchandle_new the object can be reclaimed by the
 710  * garbage collector.  In this case the value of the GCHandle will be
 711  * set to zero.
 712  *
 713  * If @pinned is false the address of the object can not be obtained, if it is
 714  * true the address of the object can be obtained.  This will also pin the
 715  * object so it will not be possible by a moving garbage collector to move the
 716  * object.
 717  *
 718  * Returns: a handle that can be used to access the object from
 719  * unmanaged code.
 720  */
 721 guint32
 722 mono_gchandle_new_weakref (MonoObject *obj, gboolean track_resurrection)
 723 {
 724         guint32 handle = alloc_handle (&gc_handles [track_resurrection? HANDLE_WEAK_TRACK: HANDLE_WEAK], obj, track_resurrection);
 725
 726 #ifndef HAVE_SGEN_GC
 727         if (track_resurrection)
 728                 mono_gc_add_weak_track_handle (obj, handle);
 729 #endif
 730
 731         return handle;
 732 }
 733
 734 static HandleType
 735 mono_gchandle_get_type (guint32 gchandle)
 736 {
 737         guint type = (gchandle & 7) - 1;
 738
 739         return type;
 740 }
 741
 742 /**
 743  * mono_gchandle_get_target:
 744  * @gchandle: a GCHandle's handle.
 745  *
 746  * The handle was previously created by calling mono_gchandle_new or
 747  * mono_gchandle_new_weakref.
 748  *
 749  * Returns a pointer to the MonoObject represented by the handle or
 750  * NULL for a collected object if using a weakref handle.
 751  */
 752 MonoObject*
 753 mono_gchandle_get_target (guint32 gchandle)
 754 {
 755         guint slot = gchandle >> 3;
 756         guint type = (gchandle & 7) - 1;
 757         HandleData *handles = &gc_handles [type];
 758         MonoObject *obj = NULL;
 759         if (type > 3)
 760                 return NULL;
 761         lock_handles (handles);
 762         if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
 763                 if (handles->type <= HANDLE_WEAK_TRACK) {
 764                         obj = mono_gc_weak_link_get (&handles->entries [slot]);
 765                 } else {
 766                         obj = handles->entries [slot];
 767                 }
 768         } else {
 769                 /* print a warning? */
 770         }
 771         unlock_handles (handles);
 772         /*g_print ("get target of entry %d of type %d: %p\n", slot, handles->type, obj);*/
 773         return obj;
 774 }
 775
 776 static void
 777 mono_gchandle_set_target (guint32 gchandle, MonoObject *obj)
 778 {
 779         guint slot = gchandle >> 3;
 780         guint type = (gchandle & 7) - 1;
 781         HandleData *handles = &gc_handles [type];
 782         MonoObject *old_obj = NULL;
 783
 784         if (type > 3)
 785                 return;
 786         lock_handles (handles);
 787         if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
 788                 if (handles->type <= HANDLE_WEAK_TRACK) {
 789                         old_obj = handles->entries [slot];
 790                         if (handles->entries [slot])
 791                                 mono_gc_weak_link_remove (&handles->entries [slot]);
 792                         if (obj)
 793                                 mono_gc_weak_link_add (&handles->entries [slot], obj, handles->type == HANDLE_WEAK_TRACK);
 794                 } else {
 795                         handles->entries [slot] = obj;
 796                 }
 797         } else {
 798                 /* print a warning? */
 799         }
 800         /*g_print ("changed entry %d of type %d to object %p (in slot: %p)\n", slot, handles->type, obj, handles->entries [slot]);*/
 801         unlock_handles (handles);
 802
 803 #ifndef HAVE_SGEN_GC
 804         if (type == HANDLE_WEAK_TRACK)
 805                 mono_gc_change_weak_track_handle (old_obj, obj, gchandle);
 806 #endif
 807 }
 808
 809 /**
 810  * mono_gchandle_is_in_domain:
 811  * @gchandle: a GCHandle's handle.
 812  * @domain: An application domain.
 813  *
 814  * Returns: true if the object wrapped by the @gchandle belongs to the specific @domain.
 815  */
 816 gboolean
 817 mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain)
 818 {
 819         guint slot = gchandle >> 3;
 820         guint type = (gchandle & 7) - 1;
 821         HandleData *handles = &gc_handles [type];
 822         gboolean result = FALSE;
 823         if (type > 3)
 824                 return FALSE;
 825         lock_handles (handles);
 826         if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
 827                 if (handles->type <= HANDLE_WEAK_TRACK) {
 828                         result = domain->domain_id == handles->domain_ids [slot];
 829                 } else {
 830                         MonoObject *obj;
 831                         obj = handles->entries [slot];
 832                         if (obj == NULL)
 833                                 result = TRUE;
 834                         else
 835                                 result = domain == mono_object_domain (obj);
 836                 }
 837         } else {
 838                 /* print a warning? */
 839         }
 840         unlock_handles (handles);
 841         return result;
 842 }
 843
 844 /**
 845  * mono_gchandle_free:
 846  * @gchandle: a GCHandle's handle.
 847  *
 848  * Frees the @gchandle handle.  If there are no outstanding
 849  * references, the garbage collector can reclaim the memory of the
 850  * object wrapped.
 851  */
 852 void
 853 mono_gchandle_free (guint32 gchandle)
 854 {
 855         guint slot = gchandle >> 3;
 856         guint type = (gchandle & 7) - 1;
 857         HandleData *handles = &gc_handles [type];
 858         if (type > 3)
 859                 return;
 860 #ifndef HAVE_SGEN_GC
 861         if (type == HANDLE_WEAK_TRACK)
 862                 mono_gc_remove_weak_track_handle (gchandle);
 863 #endif
 864
 865         lock_handles (handles);
 866         if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
 867                 if (handles->type <= HANDLE_WEAK_TRACK) {
 868                         if (handles->entries [slot])
 869                                 mono_gc_weak_link_remove (&handles->entries [slot]);
 870                 } else {
 871                         handles->entries [slot] = NULL;
 872                 }
 873                 handles->bitmap [slot / 32] &= ~(1 << (slot % 32));
 874         } else {
 875                 /* print a warning? */
 876         }
 877         mono_perfcounters->gc_num_handles--;
 878         /*g_print ("freed entry %d of type %d\n", slot, handles->type);*/
 879         unlock_handles (handles);
 880 }
 881
 882 /**
 883  * mono_gchandle_free_domain:
 884  * @domain: domain that is unloading
 885  *
 886  * Function used internally to cleanup any GC handle for objects belonging
 887  * to the specified domain during appdomain unload.
 888  */
 889 void
 890 mono_gchandle_free_domain (MonoDomain *domain)
 891 {
 892         guint type;
 893
 894         for (type = 0; type < 3; ++type) {
 895                 guint slot;
 896                 HandleData *handles = &gc_handles [type];
 897                 lock_handles (handles);
 898                 for (slot = 0; slot < handles->size; ++slot) {
 899                         if (!(handles->bitmap [slot / 32] & (1 << (slot % 32))))
 900                                 continue;
 901                         if (type <= HANDLE_WEAK_TRACK) {
 902                                 if (domain->domain_id == handles->domain_ids [slot]) {
 903                                         handles->bitmap [slot / 32] &= ~(1 << (slot % 32));
 904                                         if (handles->entries [slot])
 905                                                 mono_gc_weak_link_remove (&handles->entries [slot]);
 906                                 }
 907                         } else {
 908                                 if (handles->entries [slot] && mono_object_domain (handles->entries [slot]) == domain) {
 909                                         handles->bitmap [slot / 32] &= ~(1 << (slot % 32));
 910                                         handles->entries [slot] = NULL;
 911                                 }
 912                         }
 913                 }
 914                 unlock_handles (handles);
 915         }
 916
 917 }
 918
 919 MonoBoolean
 920 GCHandle_CheckCurrentDomain (guint32 gchandle)
 921 {
 922         return mono_gchandle_is_in_domain (gchandle, mono_domain_get ());
 923 }
 924
 925 #ifndef HAVE_NULL_GC
 926
 927 #ifdef MONO_HAS_SEMAPHORES
 928 static MonoSemType finalizer_sem;
 929 #endif
 930 static HANDLE finalizer_event;
 931 static volatile gboolean finished=FALSE;
 932
 933 void
 934 mono_gc_finalize_notify (void)
 935 {
 936 #ifdef DEBUG
 937         g_message ( "%s: prodding finalizer", __func__);
 938 #endif
 939
 940 #ifdef MONO_HAS_SEMAPHORES
 941         MONO_SEM_POST (&finalizer_sem);
 942 #else
 943         SetEvent (finalizer_event);
 944 #endif
 945 }
 946
 947 #ifdef HAVE_BOEHM_GC
 948
 949 static void
 950 collect_objects (gpointer key, gpointer value, gpointer user_data)
 951 {
 952         GPtrArray *arr = (GPtrArray*)user_data;
 953         g_ptr_array_add (arr, key);
 954 }
 955
 956 #endif
 957
 958 /*
 959  * finalize_domain_objects:
 960  *
 961  *  Run the finalizers of all finalizable objects in req->domain.
 962  */
 963 static void
 964 finalize_domain_objects (DomainFinalizationReq *req)
 965 {
 966         MonoDomain *domain = req->domain;
 967
 968 #ifdef HAVE_BOEHM_GC
 969         while (g_hash_table_size (domain->finalizable_objects_hash) > 0) {
 970                 int i;
 971                 GPtrArray *objs;
 972                 /*
 973                  * Since the domain is unloading, nobody is allowed to put
 974                  * new entries into the hash table. But finalize_object might
 975                  * remove entries from the hash table, so we make a copy.
 976                  */
 977                 objs = g_ptr_array_new ();
 978                 g_hash_table_foreach (domain->finalizable_objects_hash, collect_objects, objs);
 979                 /* printf ("FINALIZING %d OBJECTS.\n", objs->len); */
 980
 981                 for (i = 0; i < objs->len; ++i) {
 982                         MonoObject *o = (MonoObject*)g_ptr_array_index (objs, i);
 983                         /* FIXME: Avoid finalizing threads, etc */
 984                         mono_gc_run_finalize (o, 0);
 985                 }
 986
 987                 g_ptr_array_free (objs, TRUE);
 988         }
 989 #elif defined(HAVE_SGEN_GC)
 990 #define NUM_FOBJECTS 64
 991         MonoObject *to_finalize [NUM_FOBJECTS];
 992         int count;
 993         while ((count = mono_gc_finalizers_for_domain (domain, to_finalize, NUM_FOBJECTS))) {
 994                 int i;
 995                 for (i = 0; i < count; ++i) {
 996                         mono_gc_run_finalize (to_finalize [i], 0);
 997                 }
 998         }
 999 #endif
1000
1001         /* Process finalizers which are already in the queue */
1002         mono_gc_invoke_finalizers ();
1003
1004         /* printf ("DONE.\n"); */
1005         SetEvent (req->done_event);
1006
1007         /* The event is closed in mono_domain_finalize if we get here */
1008         g_free (req);
1009 }
1010
1011 static guint32
1012 finalizer_thread (gpointer unused)
1013 {
1014         while (!finished) {
1015                 /* Wait to be notified that there's at least one
1016                  * finaliser to run
1017                  */
1018
1019                 g_assert (mono_domain_get () == mono_get_root_domain ());
1020
1021 #ifdef MONO_HAS_SEMAPHORES
1022                 MONO_SEM_WAIT (&finalizer_sem);
1023 #else
1024                 /* Use alertable=FALSE since we will be asked to exit using the event too */
1025                 WaitForSingleObjectEx (finalizer_event, INFINITE, FALSE);
1026 #endif
1027
1028 #ifndef DISABLE_ATTACH
1029                 mono_attach_maybe_start ();
1030 #endif
1031
1032                 if (domains_to_finalize) {
1033                         mono_finalizer_lock ();
1034                         if (domains_to_finalize) {
1035                                 DomainFinalizationReq *req = domains_to_finalize->data;
1036                                 domains_to_finalize = g_slist_remove (domains_to_finalize, req);
1037                                 mono_finalizer_unlock ();
1038
1039                                 finalize_domain_objects (req);
1040                         } else {
1041                                 mono_finalizer_unlock ();
1042                         }
1043                 }
1044
1045                 /* If finished == TRUE, mono_gc_cleanup has been called (from mono_runtime_cleanup),
1046                  * before the domain is unloaded.
1047                  */
1048                 mono_gc_invoke_finalizers ();
1049
1050                 SetEvent (pending_done_event);
1051         }
1052
1053         SetEvent (shutdown_event);
1054         return 0;
1055 }
1056
1057 #ifdef HAVE_SGEN_GC
1058 #define GC_dont_gc 0
1059 #endif
1060
1061 void
1062 mono_gc_init (void)
1063 {
1064         InitializeCriticalSection (&handle_section);
1065         InitializeCriticalSection (&allocator_section);
1066
1067         InitializeCriticalSection (&finalizer_mutex);
1068
1069         MONO_GC_REGISTER_ROOT (gc_handles [HANDLE_NORMAL].entries);
1070         MONO_GC_REGISTER_ROOT (gc_handles [HANDLE_PINNED].entries);
1071
1072         mono_gc_base_init ();
1073
1074         if (GC_dont_gc || g_getenv ("GC_DONT_GC")) {
1075                 gc_disabled = TRUE;
1076                 return;
1077         }
1078
1079         finalizer_event = CreateEvent (NULL, FALSE, FALSE, NULL);
1080         pending_done_event = CreateEvent (NULL, TRUE, FALSE, NULL);
1081         shutdown_event = CreateEvent (NULL, TRUE, FALSE, NULL);
1082         if (finalizer_event == NULL || pending_done_event == NULL || shutdown_event == NULL) {
1083                 g_assert_not_reached ();
1084         }
1085 #ifdef MONO_HAS_SEMAPHORES
1086         MONO_SEM_INIT (&finalizer_sem, 0);
1087 #endif
1088
1089         gc_thread = mono_thread_create_internal (mono_domain_get (), finalizer_thread, NULL, FALSE);
1090 }
1091
1092 void
1093 mono_gc_cleanup (void)
1094 {
1095 #ifdef DEBUG
1096         g_message ("%s: cleaning up finalizer", __func__);
1097 #endif
1098
1099         if (!gc_disabled) {
1100                 ResetEvent (shutdown_event);
1101                 finished = TRUE;
1102                 if (mono_thread_internal_current () != gc_thread) {
1103                         mono_gc_finalize_notify ();
1104                         /* Finishing the finalizer thread, so wait a little bit... */
1105                         /* MS seems to wait for about 2 seconds */
1106                         if (WaitForSingleObjectEx (shutdown_event, 2000, FALSE) == WAIT_TIMEOUT) {
1107                                 int ret;
1108
1109                                 /* Set a flag which the finalizer thread can check */
1110                                 suspend_finalizers = TRUE;
1111
1112                                 /* Try to abort the thread, in the hope that it is running managed code */
1113                                 mono_thread_internal_stop (gc_thread);
1114
1115                                 /* Wait for it to stop */
1116                                 ret = WaitForSingleObjectEx (gc_thread->handle, 100, TRUE);
1117
1118                                 if (ret == WAIT_TIMEOUT) {
1119                                         /*
1120                                          * The finalizer thread refused to die. There is not much we
1121                                          * can do here, since the runtime is shutting down so the
1122                                          * state the finalizer thread depends on will vanish.
1123                                          */
1124                                         g_warning ("Shutting down finalizer thread timed out.");
1125                                 } else {
1126                                         /*
1127                                          * FIXME: On unix, when the above wait returns, the thread
1128                                          * might still be running io-layer code, or pthreads code.
1129                                          */
1130                                         Sleep (100);
1131                                 }
1132
1133                         }
1134                 }
1135                 gc_thread = NULL;
1136 #ifdef HAVE_BOEHM_GC
1137                 GC_finalizer_notifier = NULL;
1138 #endif
1139         }
1140
1141         DeleteCriticalSection (&handle_section);
1142         DeleteCriticalSection (&allocator_section);
1143         DeleteCriticalSection (&finalizer_mutex);
1144 }
1145
1146 #else
1147
1148 /* Null GC dummy functions */
1149 void
1150 mono_gc_finalize_notify (void)
1151 {
1152 }
1153
1154 void mono_gc_init (void)
1155 {
1156         InitializeCriticalSection (&handle_section);
1157 }
1158
1159 void mono_gc_cleanup (void)
1160 {
1161 }
1162
1163 #endif
1164
1165 gboolean
1166 mono_gc_is_finalizer_internal_thread (MonoInternalThread *thread)
1167 {
1168         return thread == gc_thread;
1169 }
1170
1171 /**
1172  * mono_gc_is_finalizer_thread:
1173  * @thread: the thread to test.
1174  *
1175  * In Mono objects are finalized asynchronously on a separate thread.
1176  * This routine tests whether the @thread argument represents the
1177  * finalization thread.
1178  *
1179  * Returns true if @thread is the finalization thread.
1180  */
1181 gboolean
1182 mono_gc_is_finalizer_thread (MonoThread *thread)
1183 {
1184         return mono_gc_is_finalizer_internal_thread (thread->internal_thread);
1185 }