mono/metadata/gc.c

   1 /*
   2  * metadata/gc.c: GC icalls.
   3  *
   4  * Author: Paolo Molaro <lupus@ximian.com>
   5  *
   6  * (C) 2002 Ximian, Inc.
   7  */
   8
   9 #include <config.h>
  10 #include <glib.h>
  11 #include <string.h>
  12
  13 #include <mono/metadata/gc-internal.h>
  14 #include <mono/metadata/mono-gc.h>
  15 #include <mono/metadata/threads.h>
  16 #include <mono/metadata/tabledefs.h>
  17 #include <mono/metadata/exception.h>
  18 #include <mono/metadata/profiler-private.h>
  19 #include <mono/metadata/domain-internals.h>
  20 #include <mono/metadata/class-internals.h>
  21 #include <mono/utils/mono-logger.h>
  22 #include <mono/os/gc_wrapper.h>
  23 #include <mono/metadata/marshal.h> /* for mono_delegate_free_ftnptr () */
  24
  25 typedef struct DomainFinalizationReq {
  26         MonoDomain *domain;
  27         HANDLE done_event;
  28 } DomainFinalizationReq;
  29
  30 #ifdef PLATFORM_WINCE /* FIXME: add accessors to gc.dll API */
  31 extern void (*__imp_GC_finalizer_notifier)(void);
  32 #define GC_finalizer_notifier __imp_GC_finalizer_notifier
  33 extern int __imp_GC_finalize_on_demand;
  34 #define GC_finalize_on_demand __imp_GC_finalize_on_demand
  35 #endif
  36
  37 static gboolean gc_disabled = FALSE;
  38
  39 #define mono_finalizer_lock() EnterCriticalSection (&finalizer_mutex)
  40 #define mono_finalizer_unlock() LeaveCriticalSection (&finalizer_mutex)
  41 static CRITICAL_SECTION finalizer_mutex;
  42
  43 static GSList *domains_to_finalize= NULL;
  44
  45 static MonoThread *gc_thread;
  46
  47 static void object_register_finalizer (MonoObject *obj, void (*callback)(void *, void*));
  48
  49 #ifndef HAVE_NULL_GC
  50 static HANDLE pending_done_event;
  51 static HANDLE shutdown_event;
  52 static HANDLE thread_started_event;
  53 #endif
  54
  55 /*
  56  * actually, we might want to queue the finalize requests in a separate thread,
  57  * but we need to be careful about the execution domain of the thread...
  58  */
  59 static void
  60 run_finalize (void *obj, void *data)
  61 {
  62         MonoObject *exc = NULL;
  63         MonoObject *o, *o2;
  64         o = (MonoObject*)((char*)obj + GPOINTER_TO_UINT (data));
  65
  66 #ifndef HAVE_SGEN_GC
  67         mono_domain_lock (o->vtable->domain);
  68
  69         o2 = g_hash_table_lookup (o->vtable->domain->finalizable_objects_hash, o);
  70
  71         mono_domain_unlock (o->vtable->domain);
  72
  73         if (!o2)
  74                 /* Already finalized somehow */
  75                 return;
  76 #endif
  77
  78         /* make sure the finalizer is not called again if the object is resurrected */
  79         object_register_finalizer (obj, NULL);
  80
  81         if (o->vtable->klass == mono_get_thread_class ())
  82                 if (mono_gc_is_finalizer_thread ((MonoThread*)o))
  83                         /* Avoid finalizing ourselves */
  84                         return;
  85
  86         /* speedup later... and use a timeout */
  87         /* g_print ("Finalize run on %p %s.%s\n", o, mono_object_class (o)->name_space, mono_object_class (o)->name); */
  88
  89         /* Use _internal here, since this thread can enter a doomed appdomain */
  90         mono_domain_set_internal (mono_object_domain (o));
  91
  92         /* delegates that have a native function pointer allocated are
  93          * registered for finalization, but they don't have a Finalize
  94          * method, because in most cases it's not needed and it's just a waste.
  95          */
  96         if (o->vtable->klass->delegate) {
  97                 MonoDelegate* del = (MonoDelegate*)o;
  98                 if (del->delegate_trampoline)
  99                         mono_delegate_free_ftnptr ((MonoDelegate*)o);
 100                 return;
 101         }
 102
 103         mono_runtime_invoke (mono_class_get_finalizer (o->vtable->klass), o, NULL, &exc);
 104
 105         if (exc) {
 106                 /* fixme: do something useful */
 107         }
 108 }
 109
 110 gpointer
 111 mono_gc_out_of_memory (size_t size)
 112 {
 113         /*
 114          * we could allocate at program startup some memory that we could release
 115          * back to the system at this point if we're really low on memory (ie, size is
 116          * lower than the memory we set apart)
 117          */
 118         mono_raise_exception (mono_domain_get ()->out_of_memory_ex);
 119
 120         return NULL;
 121 }
 122
 123 /*
 124  * Some of our objects may point to a different address than the address returned by GC_malloc()
 125  * (because of the GetHashCode hack), but we need to pass the real address to register_finalizer.
 126  * This also means that in the callback we need to adjust the pointer to get back the real
 127  * MonoObject*.
 128  * We also need to be consistent in the use of the GC_debug* variants of malloc and register_finalizer,
 129  * since that, too, can cause the underlying pointer to be offset.
 130  */
 131 static void
 132 object_register_finalizer (MonoObject *obj, void (*callback)(void *, void*))
 133 {
 134 #if HAVE_BOEHM_GC
 135         guint offset = 0;
 136
 137 #ifndef GC_DEBUG
 138         /* This assertion is not valid when GC_DEBUG is defined */
 139         g_assert (GC_base (obj) == (char*)obj - offset);
 140 #endif
 141
 142         if (mono_domain_is_unloading (obj->vtable->domain) && (callback != NULL))
 143                 /*
 144                  * Can't register finalizers in a dying appdomain, since they
 145                  * could be invoked after the appdomain has been unloaded.
 146                  */
 147                 return;
 148
 149         mono_domain_lock (obj->vtable->domain);
 150
 151         if (callback)
 152                 g_hash_table_insert (obj->vtable->domain->finalizable_objects_hash, obj,
 153                                                          obj);
 154         else
 155                 g_hash_table_remove (obj->vtable->domain->finalizable_objects_hash, obj);
 156
 157         mono_domain_unlock (obj->vtable->domain);
 158
 159         GC_REGISTER_FINALIZER_NO_ORDER ((char*)obj - offset, callback, GUINT_TO_POINTER (offset), NULL, NULL);
 160 #elif defined(HAVE_SGEN_GC)
 161         mono_gc_register_for_finalization (obj, callback);
 162 #endif
 163 }
 164
 165 /**
 166  * mono_object_register_finalizer:
 167  * @obj: object to register
 168  *
 169  * Records that object @obj has a finalizer, this will call the
 170  * Finalize method when the garbage collector disposes the object.
 171  *
 172  */
 173 void
 174 mono_object_register_finalizer (MonoObject *obj)
 175 {
 176         /* g_print ("Registered finalizer on %p %s.%s\n", obj, mono_object_class (obj)->name_space, mono_object_class (obj)->name); */
 177         object_register_finalizer (obj, run_finalize);
 178 }
 179
 180 /**
 181  * mono_domain_finalize:
 182  * @domain: the domain to finalize
 183  * @timeout: msects to wait for the finalization to complete
 184  *
 185  *  Request finalization of all finalizable objects inside @domain. Wait
 186  * @timeout msecs for the finalization to complete.
 187  *
 188  * Returns: TRUE if succeeded, FALSE if there was a timeout
 189  */
 190
 191 gboolean
 192 mono_domain_finalize (MonoDomain *domain, guint32 timeout)
 193 {
 194         DomainFinalizationReq *req;
 195         guint32 res;
 196         HANDLE done_event;
 197
 198         if (mono_thread_current () == gc_thread)
 199                 /* We are called from inside a finalizer, not much we can do here */
 200                 return FALSE;
 201
 202         mono_profiler_appdomain_event (domain, MONO_PROFILE_START_UNLOAD);
 203
 204         /*
 205          * No need to create another thread 'cause the finalizer thread
 206          * is still working and will take care of running the finalizers
 207          */
 208
 209 #ifndef HAVE_NULL_GC
 210         if (gc_disabled)
 211                 return TRUE;
 212
 213         mono_gc_collect (mono_gc_max_generation ());
 214
 215         done_event = CreateEvent (NULL, TRUE, FALSE, NULL);
 216
 217         req = g_new0 (DomainFinalizationReq, 1);
 218         req->domain = domain;
 219         req->done_event = done_event;
 220
 221         mono_finalizer_lock ();
 222
 223         domains_to_finalize = g_slist_append (domains_to_finalize, req);
 224
 225         mono_finalizer_unlock ();
 226
 227         /* Tell the finalizer thread to finalize this appdomain */
 228         mono_gc_finalize_notify ();
 229
 230         res = WaitForSingleObjectEx (done_event, timeout, TRUE);
 231
 232         /* printf ("WAIT RES: %d.\n", res); */
 233         if (res == WAIT_TIMEOUT) {
 234                 /* We leak the handle here */
 235                 return FALSE;
 236         }
 237
 238         CloseHandle (done_event);
 239         return TRUE;
 240 #else
 241         /* We don't support domain finalization without a GC */
 242         return FALSE;
 243 #endif
 244 }
 245
 246 void
 247 ves_icall_System_GC_InternalCollect (int generation)
 248 {
 249         mono_gc_collect (generation);
 250 }
 251
 252 gint64
 253 ves_icall_System_GC_GetTotalMemory (MonoBoolean forceCollection)
 254 {
 255         MONO_ARCH_SAVE_REGS;
 256
 257         if (forceCollection)
 258                 mono_gc_collect (mono_gc_max_generation ());
 259         return mono_gc_get_used_size ();
 260 }
 261
 262 void
 263 ves_icall_System_GC_KeepAlive (MonoObject *obj)
 264 {
 265         MONO_ARCH_SAVE_REGS;
 266
 267         /*
 268          * Does nothing.
 269          */
 270 }
 271
 272 void
 273 ves_icall_System_GC_ReRegisterForFinalize (MonoObject *obj)
 274 {
 275         MONO_ARCH_SAVE_REGS;
 276
 277         object_register_finalizer (obj, run_finalize);
 278 }
 279
 280 void
 281 ves_icall_System_GC_SuppressFinalize (MonoObject *obj)
 282 {
 283         MONO_ARCH_SAVE_REGS;
 284
 285         object_register_finalizer (obj, NULL);
 286 }
 287
 288 void
 289 ves_icall_System_GC_WaitForPendingFinalizers (void)
 290 {
 291         MONO_ARCH_SAVE_REGS;
 292
 293 #ifndef HAVE_NULL_GC
 294         if (!mono_gc_pending_finalizers ())
 295                 return;
 296
 297         if (mono_thread_current () == gc_thread)
 298                 /* Avoid deadlocks */
 299                 return;
 300
 301         ResetEvent (pending_done_event);
 302         mono_gc_finalize_notify ();
 303         /* g_print ("Waiting for pending finalizers....\n"); */
 304         WaitForSingleObjectEx (pending_done_event, INFINITE, TRUE);
 305         /* g_print ("Done pending....\n"); */
 306 #else
 307 #endif
 308 }
 309 #define mono_allocator_lock() EnterCriticalSection (&allocator_section)
 310 #define mono_allocator_unlock() LeaveCriticalSection (&allocator_section)
 311 static CRITICAL_SECTION allocator_section;
 312 static CRITICAL_SECTION handle_section;
 313
 314 typedef enum {
 315         HANDLE_WEAK,
 316         HANDLE_WEAK_TRACK,
 317         HANDLE_NORMAL,
 318         HANDLE_PINNED
 319 } HandleType;
 320
 321 static void mono_gchandle_set_target (guint32 gchandle, MonoObject *obj);
 322
 323 MonoObject *
 324 ves_icall_System_GCHandle_GetTarget (guint32 handle)
 325 {
 326         return mono_gchandle_get_target (handle);
 327 }
 328
 329 /*
 330  * if type == -1, change the target of the handle, otherwise allocate a new handle.
 331  */
 332 guint32
 333 ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint32 type)
 334 {
 335         if (type == -1) {
 336                 mono_gchandle_set_target (handle, obj);
 337                 /* the handle doesn't change */
 338                 return handle;
 339         }
 340         switch (type) {
 341         case HANDLE_WEAK:
 342                 return mono_gchandle_new_weakref (obj, FALSE);
 343         case HANDLE_WEAK_TRACK:
 344                 return mono_gchandle_new_weakref (obj, TRUE);
 345         case HANDLE_NORMAL:
 346                 return mono_gchandle_new (obj, FALSE);
 347         case HANDLE_PINNED:
 348                 return mono_gchandle_new (obj, TRUE);
 349         default:
 350                 g_assert_not_reached ();
 351         }
 352         return 0;
 353 }
 354
 355 void
 356 ves_icall_System_GCHandle_FreeHandle (guint32 handle)
 357 {
 358         mono_gchandle_free (handle);
 359 }
 360
 361 gpointer
 362 ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle)
 363 {
 364         MonoObject *obj;
 365
 366         obj = mono_gchandle_get_target (handle);
 367         if (obj) {
 368                 MonoClass *klass = mono_object_class (obj);
 369                 if (klass == mono_defaults.string_class) {
 370                         return mono_string_chars ((MonoString*)obj);
 371                 } else if (klass->rank) {
 372                         return mono_array_addr ((MonoArray*)obj, char, 0);
 373                 } else {
 374                         /* the C# code will check and throw the exception */
 375                         /* FIXME: missing !klass->blittable test, see bug #61134 */
 376                         if ((klass->flags & TYPE_ATTRIBUTE_LAYOUT_MASK) == TYPE_ATTRIBUTE_AUTO_LAYOUT)
 377                                 return (gpointer)-1;
 378                         return (char*)obj + sizeof (MonoObject);
 379                 }
 380         }
 381         return NULL;
 382 }
 383
 384 typedef struct {
 385         guint32  *bitmap;
 386         gpointer *entries;
 387         guint32   size;
 388         guint8    type;
 389         guint     slot_hint : 24; /* starting slot for search */
 390         /* 2^16 appdomains should be enough for everyone (though I know I'll regret this in 20 years) */
 391         /* we alloc this only for weak refs, since we can get the domain directly in the other cases */
 392         guint16  *domain_ids;
 393 } HandleData;
 394
 395 /* weak and weak-track arrays will be allocated in malloc memory
 396  */
 397 static HandleData gc_handles [] = {
 398         {NULL, NULL, 0, HANDLE_WEAK, 0},
 399         {NULL, NULL, 0, HANDLE_WEAK_TRACK, 0},
 400         {NULL, NULL, 0, HANDLE_NORMAL, 0},
 401         {NULL, NULL, 0, HANDLE_PINNED, 0}
 402 };
 403
 404 #define lock_handles(handles) EnterCriticalSection (&handle_section)
 405 #define unlock_handles(handles) LeaveCriticalSection (&handle_section)
 406
 407 static int
 408 find_first_unset (guint32 bitmap)
 409 {
 410         int i;
 411         for (i = 0; i < 32; ++i) {
 412                 if (!(bitmap & (1 << i)))
 413                         return i;
 414         }
 415         return -1;
 416 }
 417
 418 static guint32
 419 alloc_handle (HandleData *handles, MonoObject *obj)
 420 {
 421         gint slot, i;
 422         lock_handles (handles);
 423         if (!handles->size) {
 424                 handles->size = 32;
 425                 if (handles->type > HANDLE_WEAK_TRACK) {
 426                         handles->entries = mono_gc_alloc_fixed (sizeof (gpointer) * handles->size, NULL);
 427                 } else {
 428                         handles->entries = g_malloc0 (sizeof (gpointer) * handles->size);
 429                         handles->domain_ids = g_malloc0 (sizeof (guint16) * handles->size);
 430                 }
 431                 handles->bitmap = g_malloc0 (handles->size / 8);
 432         }
 433         i = -1;
 434         for (slot = handles->slot_hint; slot < handles->size / 32; ++slot) {
 435                 if (handles->bitmap [slot] != 0xffffffff) {
 436                         i = find_first_unset (handles->bitmap [slot]);
 437                         handles->slot_hint = slot;
 438                         break;
 439                 }
 440         }
 441         if (i == -1 && handles->slot_hint != 0) {
 442                 for (slot = 0; slot < handles->slot_hint; ++slot) {
 443                         if (handles->bitmap [slot] != 0xffffffff) {
 444                                 i = find_first_unset (handles->bitmap [slot]);
 445                                 handles->slot_hint = slot;
 446                                 break;
 447                         }
 448                 }
 449         }
 450         if (i == -1) {
 451                 guint32 *new_bitmap;
 452                 guint32 new_size = handles->size * 2; /* always double: we memset to 0 based on this below */
 453
 454                 /* resize and copy the bitmap */
 455                 new_bitmap = g_malloc0 (new_size / 8);
 456                 memcpy (new_bitmap, handles->bitmap, handles->size / 8);
 457                 g_free (handles->bitmap);
 458                 handles->bitmap = new_bitmap;
 459
 460                 /* resize and copy the entries */
 461                 if (handles->type > HANDLE_WEAK_TRACK) {
 462                         gpointer *entries;
 463                         entries = mono_gc_alloc_fixed (sizeof (gpointer) * new_size, NULL);
 464                         memcpy (entries, handles->entries, sizeof (gpointer) * handles->size);
 465                         handles->entries = entries;
 466                 } else {
 467                         gpointer *entries;
 468                         guint16 *domain_ids;
 469                         domain_ids = g_malloc0 (sizeof (guint16) * new_size);
 470                         entries = g_malloc (sizeof (gpointer) * new_size);
 471                         /* we disable GC because we could lose some disappearing link updates */
 472                         mono_gc_disable ();
 473                         memcpy (entries, handles->entries, sizeof (gpointer) * handles->size);
 474                         memset (entries + handles->size, 0, sizeof (gpointer) * handles->size);
 475                         memcpy (domain_ids, handles->domain_ids, sizeof (guint16) * handles->size);
 476                         for (i = 0; i < handles->size; ++i) {
 477                                 MonoObject *obj = mono_gc_weak_link_get (&(handles->entries [i]));
 478                                 mono_gc_weak_link_remove (&(handles->entries [i]));
 479                                 /*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]);*/
 480                                 if (obj) {
 481                                         mono_gc_weak_link_add (&(entries [i]), obj);
 482                                 }
 483                         }
 484                         g_free (handles->entries);
 485                         g_free (handles->domain_ids);
 486                         handles->entries = entries;
 487                         handles->domain_ids = domain_ids;
 488                         mono_gc_enable ();
 489                 }
 490
 491                 /* set i and slot to the next free position */
 492                 i = 0;
 493                 slot = (handles->size + 1) / 32;
 494                 handles->slot_hint = handles->size + 1;
 495                 handles->size = new_size;
 496         }
 497         handles->bitmap [slot] |= 1 << i;
 498         slot = slot * 32 + i;
 499         handles->entries [slot] = obj;
 500         if (handles->type <= HANDLE_WEAK_TRACK) {
 501                 if (obj)
 502                         mono_gc_weak_link_add (&(handles->entries [slot]), obj);
 503         }
 504
 505         unlock_handles (handles);
 506         /*g_print ("allocated entry %d of type %d to object %p (in slot: %p)\n", slot, handles->type, obj, handles->entries [slot]);*/
 507         return (slot << 3) | (handles->type + 1);
 508 }
 509
 510 /**
 511  * mono_gchandle_new:
 512  * @obj: managed object to get a handle for
 513  * @pinned: whether the object should be pinned
 514  *
 515  * This returns a handle that wraps the object, this is used to keep a
 516  * reference to a managed object from the unmanaged world and preventing the
 517  * object from being disposed.
 518  *
 519  * If @pinned is false the address of the object can not be obtained, if it is
 520  * true the address of the object can be obtained.  This will also pin the
 521  * object so it will not be possible by a moving garbage collector to move the
 522  * object.
 523  *
 524  * Returns: a handle that can be used to access the object from
 525  * unmanaged code.
 526  */
 527 guint32
 528 mono_gchandle_new (MonoObject *obj, gboolean pinned)
 529 {
 530         return alloc_handle (&gc_handles [pinned? HANDLE_PINNED: HANDLE_NORMAL], obj);
 531 }
 532
 533 /**
 534  * mono_gchandle_new_weakref:
 535  * @obj: managed object to get a handle for
 536  * @pinned: whether the object should be pinned
 537  *
 538  * This returns a weak handle that wraps the object, this is used to
 539  * keep a reference to a managed object from the unmanaged world.
 540  * Unlike the mono_gchandle_new the object can be reclaimed by the
 541  * garbage collector.  In this case the value of the GCHandle will be
 542  * set to zero.
 543  *
 544  * If @pinned is false the address of the object can not be obtained, if it is
 545  * true the address of the object can be obtained.  This will also pin the
 546  * object so it will not be possible by a moving garbage collector to move the
 547  * object.
 548  *
 549  * Returns: a handle that can be used to access the object from
 550  * unmanaged code.
 551  */
 552 guint32
 553 mono_gchandle_new_weakref (MonoObject *obj, gboolean track_resurrection)
 554 {
 555         return alloc_handle (&gc_handles [track_resurrection? HANDLE_WEAK_TRACK: HANDLE_WEAK], obj);
 556 }
 557
 558 /**
 559  * mono_gchandle_get_target:
 560  * @gchandle: a GCHandle's handle.
 561  *
 562  * The handle was previously created by calling mono_gchandle_new or
 563  * mono_gchandle_new_weakref.
 564  *
 565  * Returns a pointer to the MonoObject represented by the handle or
 566  * NULL for a collected object if using a weakref handle.
 567  */
 568 MonoObject*
 569 mono_gchandle_get_target (guint32 gchandle)
 570 {
 571         guint slot = gchandle >> 3;
 572         guint type = (gchandle & 7) - 1;
 573         HandleData *handles = &gc_handles [type];
 574         MonoObject *obj = NULL;
 575         if (type > 3)
 576                 return NULL;
 577         lock_handles (handles);
 578         if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
 579                 if (handles->type <= HANDLE_WEAK_TRACK) {
 580                         obj = mono_gc_weak_link_get (&handles->entries [slot]);
 581                 } else {
 582                         obj = handles->entries [slot];
 583                 }
 584         } else {
 585                 /* print a warning? */
 586         }
 587         unlock_handles (handles);
 588         /*g_print ("get target of entry %d of type %d: %p\n", slot, handles->type, obj);*/
 589         return obj;
 590 }
 591
 592 static void
 593 mono_gchandle_set_target (guint32 gchandle, MonoObject *obj)
 594 {
 595         guint slot = gchandle >> 3;
 596         guint type = (gchandle & 7) - 1;
 597         HandleData *handles = &gc_handles [type];
 598         if (type > 3)
 599                 return;
 600         lock_handles (handles);
 601         if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
 602                 if (handles->type <= HANDLE_WEAK_TRACK) {
 603                         mono_gc_weak_link_remove (&handles->entries [slot]);
 604                         if (obj)
 605                                 mono_gc_weak_link_add (&handles->entries [slot], obj);
 606                 } else {
 607                         handles->entries [slot] = obj;
 608                 }
 609         } else {
 610                 /* print a warning? */
 611         }
 612         /*g_print ("changed entry %d of type %d to object %p (in slot: %p)\n", slot, handles->type, obj, handles->entries [slot]);*/
 613         unlock_handles (handles);
 614 }
 615
 616 /**
 617  * mono_gchandle_is_in_domain:
 618  * @gchandle: a GCHandle's handle.
 619  * @domain: An application domain.
 620  *
 621  * Returns: true if the object wrapped by the @gchandle belongs to the specific @domain.
 622  */
 623 gboolean
 624 mono_gchandle_is_in_domain (guint32 gchandle, MonoDomain *domain)
 625 {
 626         guint slot = gchandle >> 3;
 627         guint type = (gchandle & 7) - 1;
 628         HandleData *handles = &gc_handles [type];
 629         gboolean result = FALSE;
 630         if (type > 3)
 631                 return FALSE;
 632         lock_handles (handles);
 633         if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
 634                 if (handles->type <= HANDLE_WEAK_TRACK) {
 635                         result = domain->domain_id == handles->domain_ids [slot];
 636                 } else {
 637                         MonoObject *obj;
 638                         obj = handles->entries [slot];
 639                         if (obj == NULL)
 640                                 result = TRUE;
 641                         else
 642                                 result = domain == mono_object_domain (obj);
 643                 }
 644         } else {
 645                 /* print a warning? */
 646         }
 647         unlock_handles (handles);
 648         return result;
 649 }
 650
 651 /**
 652  * mono_gchandle_free:
 653  * @gchandle: a GCHandle's handle.
 654  *
 655  * Frees the @gchandle handle.  If there are no outstanding
 656  * references, the garbage collector can reclaim the memory of the
 657  * object wrapped.
 658  */
 659 void
 660 mono_gchandle_free (guint32 gchandle)
 661 {
 662         guint slot = gchandle >> 3;
 663         guint type = (gchandle & 7) - 1;
 664         HandleData *handles = &gc_handles [type];
 665         if (type > 3)
 666                 return;
 667         lock_handles (handles);
 668         if (slot < handles->size && (handles->bitmap [slot / 32] & (1 << (slot % 32)))) {
 669                 if (handles->type <= HANDLE_WEAK_TRACK)
 670                         mono_gc_weak_link_remove (&handles->entries [slot]);
 671                 else
 672                         handles->entries [slot] = NULL;
 673                 handles->bitmap [slot / 32] &= ~(1 << (slot % 32));
 674         } else {
 675                 /* print a warning? */
 676         }
 677         /*g_print ("freed entry %d of type %d\n", slot, handles->type);*/
 678         unlock_handles (handles);
 679 }
 680
 681 #ifndef HAVE_NULL_GC
 682
 683 static HANDLE finalizer_event;
 684 static volatile gboolean finished=FALSE;
 685
 686 void
 687 mono_gc_finalize_notify (void)
 688 {
 689 #ifdef DEBUG
 690         g_message (G_GNUC_PRETTY_FUNCTION ": prodding finalizer");
 691 #endif
 692
 693         SetEvent (finalizer_event);
 694 }
 695
 696 static void
 697 collect_objects (gpointer key, gpointer value, gpointer user_data)
 698 {
 699         GPtrArray *arr = (GPtrArray*)user_data;
 700         g_ptr_array_add (arr, key);
 701 }
 702
 703 /*
 704  * finalize_domain_objects:
 705  *
 706  *  Run the finalizers of all finalizable objects in req->domain.
 707  */
 708 static void
 709 finalize_domain_objects (DomainFinalizationReq *req)
 710 {
 711         int i;
 712         GPtrArray *objs;
 713         MonoDomain *domain = req->domain;
 714
 715         while (g_hash_table_size (domain->finalizable_objects_hash) > 0) {
 716                 /*
 717                  * Since the domain is unloading, nobody is allowed to put
 718                  * new entries into the hash table. But finalize_object might
 719                  * remove entries from the hash table, so we make a copy.
 720                  */
 721                 objs = g_ptr_array_new ();
 722                 g_hash_table_foreach (domain->finalizable_objects_hash,
 723                                                           collect_objects, objs);
 724                 /* printf ("FINALIZING %d OBJECTS.\n", objs->len); */
 725
 726                 for (i = 0; i < objs->len; ++i) {
 727                         MonoObject *o = (MonoObject*)g_ptr_array_index (objs, i);
 728                         /* FIXME: Avoid finalizing threads, etc */
 729                         run_finalize (o, 0);
 730                 }
 731
 732                 g_ptr_array_free (objs, TRUE);
 733         }
 734
 735         /* Process finalizers which are already in the queue */
 736         mono_gc_invoke_finalizers ();
 737
 738         /* printf ("DONE.\n"); */
 739         SetEvent (req->done_event);
 740
 741         /* The event is closed in mono_domain_finalize if we get here */
 742         g_free (req);
 743 }
 744
 745 static guint32 finalizer_thread (gpointer unused)
 746 {
 747         gc_thread = mono_thread_current ();
 748
 749         SetEvent (thread_started_event);
 750
 751         while(!finished) {
 752                 /* Wait to be notified that there's at least one
 753                  * finaliser to run
 754                  */
 755                 WaitForSingleObjectEx (finalizer_event, INFINITE, TRUE);
 756
 757                 if (domains_to_finalize) {
 758                         mono_finalizer_lock ();
 759                         if (domains_to_finalize) {
 760                                 DomainFinalizationReq *req = domains_to_finalize->data;
 761                                 domains_to_finalize = g_slist_remove (domains_to_finalize, req);
 762                                 mono_finalizer_unlock ();
 763
 764                                 finalize_domain_objects (req);
 765                         }
 766                         else
 767                                 mono_finalizer_unlock ();
 768                 }
 769
 770 #ifdef DEBUG
 771                 g_message (G_GNUC_PRETTY_FUNCTION ": invoking finalizers");
 772 #endif
 773
 774                 /* If finished == TRUE, mono_gc_cleanup has been called (from mono_runtime_cleanup),
 775                  * before the domain is unloaded.
 776                  */
 777                 mono_gc_invoke_finalizers ();
 778
 779                 SetEvent (pending_done_event);
 780         }
 781
 782         SetEvent (shutdown_event);
 783         return(0);
 784 }
 785
 786 /*
 787  * Enable or disable the separate finalizer thread.
 788  * It's currently disabled because it still requires some
 789  * work in the rest of the runtime.
 790  */
 791 #define ENABLE_FINALIZER_THREAD
 792
 793 void
 794 mono_gc_init (void)
 795 {
 796         InitializeCriticalSection (&handle_section);
 797         InitializeCriticalSection (&allocator_section);
 798
 799         InitializeCriticalSection (&finalizer_mutex);
 800
 801         MONO_GC_REGISTER_ROOT (gc_handles [HANDLE_NORMAL].entries);
 802         MONO_GC_REGISTER_ROOT (gc_handles [HANDLE_PINNED].entries);
 803
 804         mono_gc_base_init ();
 805
 806 #ifdef ENABLE_FINALIZER_THREAD
 807
 808         if (g_getenv ("GC_DONT_GC")) {
 809                 gc_disabled = TRUE;
 810                 return;
 811         }
 812
 813         finalizer_event = CreateEvent (NULL, FALSE, FALSE, NULL);
 814         pending_done_event = CreateEvent (NULL, TRUE, FALSE, NULL);
 815         shutdown_event = CreateEvent (NULL, TRUE, FALSE, NULL);
 816         thread_started_event = CreateEvent (NULL, TRUE, FALSE, NULL);
 817         if (finalizer_event == NULL || pending_done_event == NULL || shutdown_event == NULL || thread_started_event == NULL) {
 818                 g_assert_not_reached ();
 819         }
 820
 821         mono_thread_create (mono_domain_get (), finalizer_thread, NULL);
 822         /*
 823          * Wait until the finalizer thread sets gc_thread since its value is needed
 824          * by mono_thread_attach ()
 825          */
 826         WaitForSingleObjectEx (thread_started_event, INFINITE, FALSE);
 827 #endif
 828 }
 829
 830 void mono_gc_cleanup (void)
 831 {
 832 #ifdef DEBUG
 833         g_message (G_GNUC_PRETTY_FUNCTION ": cleaning up finalizer");
 834 #endif
 835
 836 #ifdef ENABLE_FINALIZER_THREAD
 837         if (!gc_disabled) {
 838                 ResetEvent (shutdown_event);
 839                 finished = TRUE;
 840                 if (mono_thread_current () != gc_thread) {
 841                         mono_gc_finalize_notify ();
 842                         /* Finishing the finalizer thread, so wait a little bit... */
 843                         /* MS seems to wait for about 2 seconds */
 844                         if (WaitForSingleObjectEx (shutdown_event, 2000, FALSE) == WAIT_TIMEOUT) {
 845                                 mono_thread_stop (gc_thread);
 846                         }
 847                 }
 848                 gc_thread = NULL;
 849 #ifdef HAVE_BOEHM_GC
 850                 GC_finalizer_notifier = NULL;
 851 #endif
 852         }
 853
 854 #endif
 855 }
 856
 857 #else
 858
 859 /* no Boehm GC support. */
 860 void mono_gc_init (void)
 861 {
 862         InitializeCriticalSection (&handle_section);
 863 }
 864
 865 void mono_gc_cleanup (void)
 866 {
 867 }
 868
 869 #endif
 870
 871 /**
 872  * mono_gc_is_finalizer_thread:
 873  * @thread: the thread to test.
 874  *
 875  * In Mono objects are finalized asynchronously on a separate thread.
 876  * This routine tests whether the @thread argument represents the
 877  * finalization thread.
 878  *
 879  * Returns true if @thread is the finalization thread.
 880  */
 881 gboolean
 882 mono_gc_is_finalizer_thread (MonoThread *thread)
 883 {
 884         return thread == gc_thread;
 885 }
 886
 887