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/threads.h>
  15 #include <mono/metadata/tabledefs.h>
  16 #include <mono/metadata/exception.h>
  17 #define GC_I_HIDE_POINTERS
  18 #include <mono/os/gc_wrapper.h>
  19
  20 #ifndef HIDE_POINTER
  21 #define HIDE_POINTER(v)         (v)
  22 #define REVEAL_POINTER(v)       (v)
  23 #endif
  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 int finalize_slot = -1;
  38
  39 static gboolean gc_disabled = FALSE;
  40
  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 #if HAVE_BOEHM_GC
  50 static void finalize_notify (void);
  51 static HANDLE pending_done_event;
  52 static HANDLE shutdown_event;
  53 static HANDLE thread_started_event;
  54 #endif
  55
  56 /*
  57  * actually, we might want to queue the finalize requests in a separate thread,
  58  * but we need to be careful about the execution domain of the thread...
  59  */
  60 static void
  61 run_finalize (void *obj, void *data)
  62 {
  63         MonoObject *exc = NULL;
  64         MonoObject *o, *o2;
  65         o = (MonoObject*)((char*)obj + GPOINTER_TO_UINT (data));
  66
  67         if (finalize_slot < 0) {
  68                 int i;
  69                 for (i = 0; i < mono_defaults.object_class->vtable_size; ++i) {
  70                         MonoMethod *cm = mono_defaults.object_class->vtable [i];
  71
  72                         if (!strcmp (cm->name, "Finalize")) {
  73                                 finalize_slot = i;
  74                                 break;
  75                         }
  76                 }
  77         }
  78
  79         mono_domain_lock (o->vtable->domain);
  80
  81         o2 = g_hash_table_lookup (o->vtable->domain->finalizable_objects_hash, o);
  82
  83         mono_domain_unlock (o->vtable->domain);
  84
  85         if (!o2)
  86                 /* Already finalized somehow */
  87                 return;
  88
  89         /* make sure the finalizer is not called again if the object is resurrected */
  90         object_register_finalizer (obj, NULL);
  91         /* speedup later... and use a timeout */
  92         /* g_print ("Finalize run on %p %s.%s\n", o, mono_object_class (o)->name_space, mono_object_class (o)->name); */
  93
  94         /* Use _internal here, since this thread can enter a doomed appdomain */
  95         mono_domain_set_internal (mono_object_domain (o));
  96
  97         mono_runtime_invoke (o->vtable->klass->vtable [finalize_slot], o, NULL, &exc);
  98
  99         if (exc) {
 100                 /* fixme: do something useful */
 101         }
 102 }
 103
 104 /*
 105  * Some of our objects may point to a different address than the address returned by GC_malloc()
 106  * (because of the GetHashCode hack), but we need to pass the real address to register_finalizer.
 107  * This also means that in the callback we need to adjust the pointer to get back the real
 108  * MonoObject*.
 109  * We also need to be consistent in the use of the GC_debug* variants of malloc and register_finalizer,
 110  * since that, too, can cause the underlying pointer to be offset.
 111  */
 112 static void
 113 object_register_finalizer (MonoObject *obj, void (*callback)(void *, void*))
 114 {
 115 #if HAVE_BOEHM_GC
 116         guint offset = 0;
 117
 118 #ifndef GC_DEBUG
 119         /* This assertion is not valid when GC_DEBUG is defined */
 120         g_assert (GC_base (obj) == (char*)obj - offset);
 121 #endif
 122
 123         if (mono_domain_is_unloading (obj->vtable->domain) && (callback != NULL))
 124                 /*
 125                  * Can't register finalizers in a dying appdomain, since they
 126                  * could be invoked after the appdomain has been unloaded.
 127                  */
 128                 return;
 129
 130         mono_domain_lock (obj->vtable->domain);
 131
 132         if (callback)
 133                 g_hash_table_insert (obj->vtable->domain->finalizable_objects_hash, obj,
 134                                                          obj);
 135         else
 136                 g_hash_table_remove (obj->vtable->domain->finalizable_objects_hash, obj);
 137
 138         mono_domain_unlock (obj->vtable->domain);
 139
 140         GC_REGISTER_FINALIZER_NO_ORDER ((char*)obj - offset, callback, GUINT_TO_POINTER (offset), NULL, NULL);
 141 #endif
 142 }
 143
 144 void
 145 mono_object_register_finalizer (MonoObject *obj)
 146 {
 147         /* g_print ("Registered finalizer on %p %s.%s\n", obj, mono_object_class (obj)->name_space, mono_object_class (obj)->name); */
 148         object_register_finalizer (obj, run_finalize);
 149 }
 150
 151 /*
 152  * mono_domain_finalize:
 153  *
 154  *  Request finalization of all finalizable objects inside @domain. Wait
 155  * @timeout msecs for the finalization to complete.
 156  * Returns: TRUE if succeeded, FALSE if there was a timeout
 157  */
 158
 159 gboolean
 160 mono_domain_finalize (MonoDomain *domain, guint32 timeout)
 161 {
 162         DomainFinalizationReq *req;
 163         guint32 res;
 164         HANDLE done_event;
 165
 166         /*
 167          * No need to create another thread 'cause the finalizer thread
 168          * is still working and will take care of running the finalizers
 169          */
 170
 171 #if HAVE_BOEHM_GC
 172         if (gc_disabled)
 173                 return TRUE;
 174
 175         GC_gcollect ();
 176
 177         done_event = CreateEvent (NULL, TRUE, FALSE, NULL);
 178
 179         req = g_new0 (DomainFinalizationReq, 1);
 180         req->domain = domain;
 181         req->done_event = done_event;
 182
 183         EnterCriticalSection (&finalizer_mutex);
 184
 185         domains_to_finalize = g_slist_append (domains_to_finalize, req);
 186
 187         LeaveCriticalSection (&finalizer_mutex);
 188
 189         /* Tell the finalizer thread to finalize this appdomain */
 190         finalize_notify ();
 191
 192         res = WaitForSingleObject (done_event, timeout);
 193
 194         //printf ("WAIT RES: %d.\n", res);
 195         if (res == WAIT_TIMEOUT)
 196                 return FALSE;
 197         else
 198                 return TRUE;
 199 #else
 200         /* We don't support domain finalization without a GC */
 201         return FALSE;
 202 #endif
 203 }
 204
 205 void
 206 ves_icall_System_GC_InternalCollect (int generation)
 207 {
 208         MONO_ARCH_SAVE_REGS;
 209
 210 #if HAVE_BOEHM_GC
 211         GC_gcollect ();
 212 #endif
 213 }
 214
 215 gint64
 216 ves_icall_System_GC_GetTotalMemory (MonoBoolean forceCollection)
 217 {
 218         MONO_ARCH_SAVE_REGS;
 219
 220 #if HAVE_BOEHM_GC
 221         if (forceCollection)
 222                 GC_gcollect ();
 223         return GC_get_heap_size () - GC_get_free_bytes ();
 224 #else
 225         return 0;
 226 #endif
 227 }
 228
 229 void
 230 ves_icall_System_GC_KeepAlive (MonoObject *obj)
 231 {
 232         MONO_ARCH_SAVE_REGS;
 233
 234         /*
 235          * Does nothing.
 236          */
 237 }
 238
 239 void
 240 ves_icall_System_GC_ReRegisterForFinalize (MonoObject *obj)
 241 {
 242         MONO_ARCH_SAVE_REGS;
 243
 244         object_register_finalizer (obj, run_finalize);
 245 }
 246
 247 void
 248 ves_icall_System_GC_SuppressFinalize (MonoObject *obj)
 249 {
 250         MONO_ARCH_SAVE_REGS;
 251
 252         object_register_finalizer (obj, NULL);
 253 }
 254
 255 void
 256 ves_icall_System_GC_WaitForPendingFinalizers (void)
 257 {
 258         MONO_ARCH_SAVE_REGS;
 259
 260 #if HAVE_BOEHM_GC
 261         if (!GC_should_invoke_finalizers ())
 262                 return;
 263
 264         if (mono_thread_current () == gc_thread)
 265                 /* Avoid deadlocks */
 266                 return;
 267
 268         ResetEvent (pending_done_event);
 269         finalize_notify ();
 270         /* g_print ("Waiting for pending finalizers....\n"); */
 271         WaitForSingleObject (pending_done_event, INFINITE);
 272         /* g_print ("Done pending....\n"); */
 273 #else
 274 #endif
 275 }
 276
 277 static CRITICAL_SECTION allocator_section;
 278 static CRITICAL_SECTION handle_section;
 279 static guint32 next_handle = 0;
 280 static gpointer *gc_handles = NULL;
 281 static guint8 *gc_handle_types = NULL;
 282 static guint32 array_size = 0;
 283
 284 /*
 285  * The handle type is encoded in the lower two bits of the handle value:
 286  * 0 -> normal
 287  * 1 -> pinned
 288  * 2 -> weak
 289  */
 290
 291 typedef enum {
 292         HANDLE_WEAK,
 293         HANDLE_WEAK_TRACK,
 294         HANDLE_NORMAL,
 295         HANDLE_PINNED
 296 } HandleType;
 297
 298 /*
 299  * FIXME: make thread safe and reuse the array entries.
 300  */
 301 MonoObject *
 302 ves_icall_System_GCHandle_GetTarget (guint32 handle)
 303 {
 304         MonoObject *obj;
 305         gint32 type;
 306
 307         MONO_ARCH_SAVE_REGS;
 308
 309         if (gc_handles) {
 310                 type = handle & 0x3;
 311                 EnterCriticalSection (&handle_section);
 312                 g_assert (type == gc_handle_types [handle >> 2]);
 313                 obj = gc_handles [handle >> 2];
 314                 LeaveCriticalSection (&handle_section);
 315                 if (!obj)
 316                         return NULL;
 317
 318                 if ((type == HANDLE_WEAK) || (type == HANDLE_WEAK_TRACK))
 319                         return REVEAL_POINTER (obj);
 320                 else
 321                         return obj;
 322         }
 323         return NULL;
 324 }
 325
 326 guint32
 327 ves_icall_System_GCHandle_GetTargetHandle (MonoObject *obj, guint32 handle, gint32 type)
 328 {
 329         gpointer val = obj;
 330         guint32 h, idx;
 331
 332         MONO_ARCH_SAVE_REGS;
 333
 334         EnterCriticalSection (&handle_section);
 335         /* Indexes start from 1 since 0 means the handle is not allocated */
 336         idx = ++next_handle;
 337         if (idx >= array_size) {
 338 #if HAVE_BOEHM_GC
 339                 gpointer *new_array;
 340                 guint8 *new_type_array;
 341                 if (!array_size)
 342                         array_size = 16;
 343                 new_array = GC_MALLOC (sizeof (gpointer) * (array_size * 2));
 344                 new_type_array = GC_MALLOC (sizeof (guint8) * (array_size * 2));
 345                 if (gc_handles) {
 346                         int i;
 347                         memcpy (new_array, gc_handles, sizeof (gpointer) * array_size);
 348                         memcpy (new_type_array, gc_handle_types, sizeof (guint8) * array_size);
 349                         /* need to re-register links for weak refs. test if GC_realloc needs the same */
 350                         for (i = 0; i < array_size; ++i) {
 351 #if 0 /* This breaks the threaded finalizer, by causing segfaults deep
 352        * inside libgc.  I assume it will also break without the
 353        * threaded finalizer, just that the stress test (bug 31333)
 354        * deadlocks too early without it.  Reverting to the previous
 355        * version here stops the segfault.
 356        */
 357                                 if ((gc_handle_types[i] == HANDLE_WEAK) || (gc_handle_types[i] == HANDLE_WEAK_TRACK)) { /* all and only disguised pointers have it set */
 358 #else
 359                                 if (((gulong)new_array [i]) & 0x1) {
 360 #endif
 361                                         if (gc_handles [i] != (gpointer)-1)
 362                                                 GC_unregister_disappearing_link (&(gc_handles [i]));
 363                                         if (new_array [i] != (gpointer)-1)
 364                                                 GC_GENERAL_REGISTER_DISAPPEARING_LINK (&(new_array [i]), REVEAL_POINTER (new_array [i]));
 365                                 }
 366                         }
 367                 }
 368                 array_size *= 2;
 369                 gc_handles = new_array;
 370                 gc_handle_types = new_type_array;
 371 #else
 372                 mono_raise_exception (mono_get_exception_execution_engine ("No GCHandle support built-in"));
 373 #endif
 374         }
 375
 376         /* resuse the type from the old target */
 377         if (type == -1)
 378                 type =  handle & 0x3;
 379         h = (idx << 2) | type;
 380         switch (type) {
 381         case HANDLE_WEAK:
 382         case HANDLE_WEAK_TRACK:
 383                 val = (gpointer)HIDE_POINTER (val);
 384                 gc_handles [idx] = val;
 385                 gc_handle_types [idx] = type;
 386 #if HAVE_BOEHM_GC
 387                 if (gc_handles [idx] != (gpointer)-1)
 388                         GC_GENERAL_REGISTER_DISAPPEARING_LINK (&(gc_handles [idx]), obj);
 389 #else
 390                 mono_raise_exception (mono_get_exception_execution_engine ("No weakref support"));
 391 #endif
 392                 break;
 393         default:
 394                 gc_handles [idx] = val;
 395                 gc_handle_types [idx] = type;
 396                 break;
 397         }
 398         LeaveCriticalSection (&handle_section);
 399         return h;
 400 }
 401
 402 void
 403 ves_icall_System_GCHandle_FreeHandle (guint32 handle)
 404 {
 405         int idx = handle >> 2;
 406         int type = handle & 0x3;
 407
 408         MONO_ARCH_SAVE_REGS;
 409
 410         EnterCriticalSection (&handle_section);
 411
 412 #ifdef HAVE_BOEHM_GC
 413         g_assert (type == gc_handle_types [idx]);
 414         if ((type == HANDLE_WEAK) || (type == HANDLE_WEAK_TRACK)) {
 415                 if (gc_handles [idx] != (gpointer)-1)
 416                         GC_unregister_disappearing_link (&(gc_handles [idx]));
 417         }
 418 #else
 419         LeaveCriticalSection (&handle_section);
 420         mono_raise_exception (mono_get_exception_execution_engine ("No GCHandle support"));
 421 #endif
 422
 423         gc_handles [idx] = (gpointer)-1;
 424         gc_handle_types [idx] = (guint8)-1;
 425         LeaveCriticalSection (&handle_section);
 426 }
 427
 428 gpointer
 429 ves_icall_System_GCHandle_GetAddrOfPinnedObject (guint32 handle)
 430 {
 431         MonoObject *obj;
 432         int type = handle & 0x3;
 433
 434         MONO_ARCH_SAVE_REGS;
 435
 436         if (gc_handles) {
 437                 EnterCriticalSection (&handle_section);
 438                 obj = gc_handles [handle >> 2];
 439                 g_assert (gc_handle_types [handle >> 2] == type);
 440                 LeaveCriticalSection (&handle_section);
 441                 if ((type == HANDLE_WEAK) || (type == HANDLE_WEAK_TRACK)) {
 442                         obj = REVEAL_POINTER (obj);
 443                         if (obj == (MonoObject *) -1)
 444                                 return NULL;
 445                 }
 446                 return obj;
 447         }
 448         return NULL;
 449 }
 450
 451 #if HAVE_BOEHM_GC
 452
 453 static HANDLE finalizer_event;
 454 static volatile gboolean finished=FALSE;
 455
 456 static void finalize_notify (void)
 457 {
 458 #ifdef DEBUG
 459         g_message (G_GNUC_PRETTY_FUNCTION ": prodding finalizer");
 460 #endif
 461
 462         SetEvent (finalizer_event);
 463 }
 464
 465 static void
 466 collect_objects (gpointer key, gpointer value, gpointer user_data)
 467 {
 468         GPtrArray *arr = (GPtrArray*)user_data;
 469         g_ptr_array_add (arr, key);
 470 }
 471
 472 /*
 473  * finalize_domain_objects:
 474  *
 475  *  Run the finalizers of all finalizable objects in req->domain.
 476  */
 477 static void
 478 finalize_domain_objects (DomainFinalizationReq *req)
 479 {
 480         int i;
 481         GPtrArray *objs;
 482         MonoDomain *domain = req->domain;
 483
 484         while (g_hash_table_size (domain->finalizable_objects_hash) > 0) {
 485                 /*
 486                  * Since the domain is unloading, nobody is allowed to put
 487                  * new entries into the hash table. But finalize_object might
 488                  * remove entries from the hash table, so we make a copy.
 489                  */
 490                 objs = g_ptr_array_new ();
 491                 g_hash_table_foreach (domain->finalizable_objects_hash,
 492                                                           collect_objects, objs);
 493                 //printf ("FINALIZING %d OBJECTS.\n", objs->len);
 494
 495                 for (i = 0; i < objs->len; ++i) {
 496                         MonoObject *o = (MonoObject*)g_ptr_array_index (objs, i);
 497                         /* FIXME: Avoid finalizing threads, etc */
 498                         run_finalize (o, 0);
 499                 }
 500
 501                 g_ptr_array_free (objs, TRUE);
 502         }
 503
 504         //printf ("DONE.\n");
 505         SetEvent (req->done_event);
 506
 507         /* FIXME: How to delete the event ? */
 508         g_free (req);
 509 }
 510
 511 static guint32 finalizer_thread (gpointer unused)
 512 {
 513         guint32 stack_start;
 514
 515         gc_thread = mono_thread_current ();
 516
 517         SetEvent (thread_started_event);
 518
 519         while(!finished) {
 520                 /* Wait to be notified that there's at least one
 521                  * finaliser to run
 522                  */
 523                 WaitForSingleObject (finalizer_event, INFINITE);
 524
 525                 if (domains_to_finalize) {
 526                         EnterCriticalSection (&finalizer_mutex);
 527                         if (domains_to_finalize) {
 528                                 DomainFinalizationReq *req = domains_to_finalize->data;
 529                                 domains_to_finalize = g_slist_remove (domains_to_finalize, req);
 530                                 LeaveCriticalSection (&finalizer_mutex);
 531
 532                                 finalize_domain_objects (req);
 533                         }
 534                         else
 535                                 LeaveCriticalSection (&finalizer_mutex);
 536                 }
 537
 538 #ifdef DEBUG
 539                 g_message (G_GNUC_PRETTY_FUNCTION ": invoking finalizers");
 540 #endif
 541
 542                 /* If finished == TRUE, mono_gc_cleanup has been called (from mono_runtime_cleanup),
 543                  * before the domain is unloaded.
 544                  *
 545                  * There is a bug in GC_invoke_finalizer () in versions <= 6.2alpha4:
 546                  * the 'mem_freed' variable is not initialized when there are no
 547                  * objects to finalize, which leads to strange behavior later on.
 548                  * The check is necessary to work around that bug.
 549                  */
 550                 if (GC_should_invoke_finalizers ()) {
 551                         GC_invoke_finalizers ();
 552                 }
 553
 554                 SetEvent (pending_done_event);
 555         }
 556
 557         SetEvent (shutdown_event);
 558
 559         return(0);
 560 }
 561
 562 /*
 563  * Enable or disable the separate finalizer thread.
 564  * It's currently disabled because it still requires some
 565  * work in the rest of the runtime.
 566  */
 567 #define ENABLE_FINALIZER_THREAD
 568
 569 #ifdef WITH_INCLUDED_LIBGC
 570 /* from threads.c */
 571 extern void mono_gc_stop_world (void);
 572 extern void mono_gc_start_world (void);
 573 extern void mono_gc_push_all_stacks (void);
 574
 575 static void mono_gc_lock (void)
 576 {
 577         EnterCriticalSection (&allocator_section);
 578 }
 579
 580 static void mono_gc_unlock (void)
 581 {
 582         LeaveCriticalSection (&allocator_section);
 583 }
 584
 585 static GCThreadFunctions mono_gc_thread_vtable = {
 586         NULL,
 587
 588         mono_gc_lock,
 589         mono_gc_unlock,
 590
 591         mono_gc_stop_world,
 592         NULL,
 593         mono_gc_push_all_stacks,
 594         mono_gc_start_world
 595 };
 596 #endif /* WITH_INCLUDED_LIBGC */
 597
 598 void mono_gc_init (void)
 599 {
 600         InitializeCriticalSection (&handle_section);
 601         InitializeCriticalSection (&allocator_section);
 602
 603         InitializeCriticalSection (&finalizer_mutex);
 604
 605 #ifdef WITH_INCLUDED_LIBGC
 606         gc_thread_vtable = &mono_gc_thread_vtable;
 607 #endif
 608
 609 #ifdef ENABLE_FINALIZER_THREAD
 610
 611         if (getenv ("GC_DONT_GC")) {
 612                 gc_disabled = TRUE;
 613                 return;
 614         }
 615
 616         finalizer_event = CreateEvent (NULL, FALSE, FALSE, NULL);
 617         pending_done_event = CreateEvent (NULL, TRUE, FALSE, NULL);
 618         shutdown_event = CreateEvent (NULL, TRUE, FALSE, NULL);
 619         thread_started_event = CreateEvent (NULL, TRUE, FALSE, NULL);
 620         if (finalizer_event == NULL || pending_done_event == NULL || shutdown_event == NULL || thread_started_event == NULL) {
 621                 g_assert_not_reached ();
 622         }
 623
 624         GC_finalize_on_demand = 1;
 625         GC_finalizer_notifier = finalize_notify;
 626
 627         mono_thread_create (mono_domain_get (), finalizer_thread, NULL);
 628         /*
 629          * Wait until the finalizer thread sets gc_thread since its value is needed
 630          * by mono_thread_attach ()
 631          */
 632         WaitForSingleObject (thread_started_event, INFINITE);
 633 #endif
 634 }
 635
 636 void mono_gc_cleanup (void)
 637 {
 638 #ifdef DEBUG
 639         g_message (G_GNUC_PRETTY_FUNCTION ": cleaning up finalizer");
 640 #endif
 641
 642 #ifdef ENABLE_FINALIZER_THREAD
 643         if (!gc_disabled) {
 644                 ResetEvent (shutdown_event);
 645                 finished = TRUE;
 646                 finalize_notify ();
 647                 /* Finishing the finalizer thread, so wait a little bit... */
 648                 /* MS seems to wait for about 2 seconds */
 649                 /*
 650                  * FIXME: This is not thread safe. If the finalizer thread keeps
 651                  * running, and the runtime is shut down, it will lead to a crash.
 652                  */
 653                 WaitForSingleObject (shutdown_event, 2000);
 654         }
 655
 656 #endif
 657 }
 658
 659 #else
 660
 661 /* no Boehm GC support. */
 662 void mono_gc_init (void)
 663 {
 664         InitializeCriticalSection (&handle_section);
 665 }
 666
 667 void mono_gc_cleanup (void)
 668 {
 669 }
 670
 671 #endif
 672
 673 gboolean
 674 mono_gc_is_finalizer_thread (MonoThread *thread)
 675 {
 676         return thread == gc_thread;
 677 }
 678
 679