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