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