2 * sgen-fin-weak-hash.c: Finalizers and weak links.
5 * Paolo Molaro (lupus@ximian.com)
6 * Rodrigo Kumpera (kumpera@gmail.com)
8 * Copyright 2005-2011 Novell, Inc (http://www.novell.com)
9 * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
10 * Copyright 2011 Xamarin, Inc.
11 * Copyright (C) 2012 Xamarin Inc
13 * This library is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU Library General Public
15 * License 2.0 as published by the Free Software Foundation;
17 * This library is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Library General Public License for more details.
22 * You should have received a copy of the GNU Library General Public
23 * License 2.0 along with this library; if not, write to the Free
24 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
30 #include "metadata/sgen-gc.h"
31 #include "metadata/sgen-gray.h"
32 #include "utils/dtrace.h"
34 #define ptr_in_nursery sgen_ptr_in_nursery
36 typedef SgenGrayQueue GrayQueue;
38 int num_ready_finalizers = 0;
39 static int no_finalize = 0;
41 #define DISLINK_OBJECT(l) (REVEAL_POINTER (*(void**)(l)))
42 #define DISLINK_TRACK(l) ((~(gulong)(*(void**)(l))) & 1)
45 * The finalizable hash has the object as the key, the
46 * disappearing_link hash, has the link address as key.
48 * Copyright 2011 Xamarin Inc.
51 #define TAG_MASK ((mword)0x1)
53 static inline MonoObject*
54 tagged_object_get_object (MonoObject *object)
56 return (MonoObject*)(((mword)object) & ~TAG_MASK);
60 tagged_object_get_tag (MonoObject *object)
62 return ((mword)object) & TAG_MASK;
65 static inline MonoObject*
66 tagged_object_apply (void *object, int tag_bits)
68 return (MonoObject*)((mword)object | (mword)tag_bits);
72 tagged_object_hash (MonoObject *o)
74 return mono_object_hash (tagged_object_get_object (o));
78 tagged_object_equals (MonoObject *a, MonoObject *b)
80 return tagged_object_get_object (a) == tagged_object_get_object (b);
83 static SgenHashTable minor_finalizable_hash = SGEN_HASH_TABLE_INIT (INTERNAL_MEM_FIN_TABLE, INTERNAL_MEM_FINALIZE_ENTRY, 0, (GHashFunc)tagged_object_hash, (GEqualFunc)tagged_object_equals);
84 static SgenHashTable major_finalizable_hash = SGEN_HASH_TABLE_INIT (INTERNAL_MEM_FIN_TABLE, INTERNAL_MEM_FINALIZE_ENTRY, 0, (GHashFunc)tagged_object_hash, (GEqualFunc)tagged_object_equals);
87 get_finalize_entry_hash_table (int generation)
90 case GENERATION_NURSERY: return &minor_finalizable_hash;
91 case GENERATION_OLD: return &major_finalizable_hash;
92 default: g_assert_not_reached ();
96 #define BRIDGE_OBJECT_MARKED 0x1
98 /* LOCKING: requires that the GC lock is held */
100 sgen_mark_bridge_object (MonoObject *obj)
102 SgenHashTable *hash_table = get_finalize_entry_hash_table (ptr_in_nursery (obj) ? GENERATION_NURSERY : GENERATION_OLD);
104 sgen_hash_table_set_key (hash_table, obj, tagged_object_apply (obj, BRIDGE_OBJECT_MARKED));
107 /* LOCKING: requires that the GC lock is held */
109 sgen_collect_bridge_objects (CopyOrMarkObjectFunc copy_func, char *start, char *end, int generation, GrayQueue *queue)
111 SgenHashTable *hash_table = get_finalize_entry_hash_table (generation);
119 SGEN_HASH_TABLE_FOREACH (hash_table, object, dummy) {
120 int tag = tagged_object_get_tag (object);
121 object = tagged_object_get_object (object);
123 /* Bridge code told us to ignore this one */
124 if (tag == BRIDGE_OBJECT_MARKED)
127 /* Object is a bridge object and major heap says it's dead */
128 if (!((char*)object >= start && (char*)object < end && !major_collector.is_object_live ((char*)object)))
131 /* Nursery says the object is dead. */
132 if (!sgen_gc_is_object_ready_for_finalization (object))
135 if (!sgen_is_bridge_object (object))
138 copy = (char*)object;
139 copy_func ((void**)©, queue);
141 sgen_bridge_register_finalized_object ((MonoObject*)copy);
143 if (hash_table == &minor_finalizable_hash && !ptr_in_nursery (copy)) {
144 /* remove from the list */
145 SGEN_HASH_TABLE_FOREACH_REMOVE (TRUE);
147 /* insert it into the major hash */
148 sgen_hash_table_replace (&major_finalizable_hash, tagged_object_apply (copy, tag), NULL, NULL);
150 SGEN_LOG (5, "Promoting finalization of object %p (%s) (was at %p) to major table", copy, sgen_safe_name (copy), object);
155 SGEN_LOG (5, "Updating object for finalization: %p (%s) (was at %p)", copy, sgen_safe_name (copy), object);
156 SGEN_HASH_TABLE_FOREACH_SET_KEY (tagged_object_apply (copy, tag));
158 } SGEN_HASH_TABLE_FOREACH_END;
162 /* LOCKING: requires that the GC lock is held */
164 sgen_finalize_in_range (CopyOrMarkObjectFunc copy_func, char *start, char *end, int generation, GrayQueue *queue)
166 SgenHashTable *hash_table = get_finalize_entry_hash_table (generation);
172 SGEN_HASH_TABLE_FOREACH (hash_table, object, dummy) {
173 int tag = tagged_object_get_tag (object);
174 object = tagged_object_get_object (object);
175 if ((char*)object >= start && (char*)object < end && !major_collector.is_object_live ((char*)object)) {
176 gboolean is_fin_ready = sgen_gc_is_object_ready_for_finalization (object);
177 MonoObject *copy = object;
178 copy_func ((void**)©, queue);
180 /* remove and put in fin_ready_list */
181 SGEN_HASH_TABLE_FOREACH_REMOVE (TRUE);
182 num_ready_finalizers++;
183 sgen_queue_finalization_entry (copy);
184 /* Make it survive */
185 SGEN_LOG (5, "Queueing object for finalization: %p (%s) (was at %p) (%d/%d)", copy, sgen_safe_name (copy), object, num_ready_finalizers, sgen_hash_table_num_entries (hash_table));
188 if (hash_table == &minor_finalizable_hash && !ptr_in_nursery (copy)) {
189 /* remove from the list */
190 SGEN_HASH_TABLE_FOREACH_REMOVE (TRUE);
192 /* insert it into the major hash */
193 sgen_hash_table_replace (&major_finalizable_hash, tagged_object_apply (copy, tag), NULL, NULL);
195 SGEN_LOG (5, "Promoting finalization of object %p (%s) (was at %p) to major table", copy, sgen_safe_name (copy), object);
200 SGEN_LOG (5, "Updating object for finalization: %p (%s) (was at %p)", copy, sgen_safe_name (copy), object);
201 SGEN_HASH_TABLE_FOREACH_SET_KEY (tagged_object_apply (copy, tag));
205 } SGEN_HASH_TABLE_FOREACH_END;
208 /* LOCKING: requires that the GC lock is held */
210 register_for_finalization (MonoObject *obj, void *user_data, int generation)
212 SgenHashTable *hash_table = get_finalize_entry_hash_table (generation);
217 g_assert (user_data == NULL || user_data == mono_gc_run_finalize);
220 if (sgen_hash_table_replace (hash_table, obj, NULL, NULL))
221 SGEN_LOG (5, "Added finalizer for object: %p (%s) (%d) to %s table", obj, obj->vtable->klass->name, hash_table->num_entries, sgen_generation_name (generation));
223 if (sgen_hash_table_remove (hash_table, obj, NULL))
224 SGEN_LOG (5, "Removed finalizer for object: %p (%s) (%d)", obj, obj->vtable->klass->name, hash_table->num_entries);
228 #define STAGE_ENTRY_FREE 0
229 #define STAGE_ENTRY_BUSY 1
230 #define STAGE_ENTRY_USED 2
238 #define NUM_FIN_STAGE_ENTRIES 1024
240 static volatile gint32 next_fin_stage_entry = 0;
241 static StageEntry fin_stage_entries [NUM_FIN_STAGE_ENTRIES];
243 /* LOCKING: requires that the GC lock is held */
245 process_stage_entries (int num_entries, volatile gint32 *next_entry, StageEntry *entries, void (*process_func) (MonoObject*, void*))
248 int num_registered = 0;
251 for (i = 0; i < num_entries; ++i) {
252 gint32 state = entries [i].state;
254 if (state == STAGE_ENTRY_BUSY)
257 if (state != STAGE_ENTRY_USED ||
258 InterlockedCompareExchange (&entries [i].state, STAGE_ENTRY_BUSY, STAGE_ENTRY_USED) != STAGE_ENTRY_USED) {
262 process_func (entries [i].obj, entries [i].user_data);
264 entries [i].obj = NULL;
265 entries [i].user_data = NULL;
267 mono_memory_write_barrier ();
269 entries [i].state = STAGE_ENTRY_FREE;
276 /* g_print ("stage busy %d reg %d\n", num_busy, num_registered); */
280 add_stage_entry (int num_entries, volatile gint32 *next_entry, StageEntry *entries, MonoObject *obj, void *user_data)
287 if (index >= num_entries)
289 } while (InterlockedCompareExchange (next_entry, index + 1, index) != index);
292 * We don't need a write barrier here. *next_entry is just a
293 * help for finding an index, its value is irrelevant for
296 } while (entries [index].state != STAGE_ENTRY_FREE ||
297 InterlockedCompareExchange (&entries [index].state, STAGE_ENTRY_BUSY, STAGE_ENTRY_FREE) != STAGE_ENTRY_FREE);
299 entries [index].obj = obj;
300 entries [index].user_data = user_data;
302 mono_memory_write_barrier ();
304 entries [index].state = STAGE_ENTRY_USED;
309 /* LOCKING: requires that the GC lock is held */
311 process_fin_stage_entry (MonoObject *obj, void *user_data)
313 if (ptr_in_nursery (obj))
314 register_for_finalization (obj, user_data, GENERATION_NURSERY);
316 register_for_finalization (obj, user_data, GENERATION_OLD);
319 /* LOCKING: requires that the GC lock is held */
321 sgen_process_fin_stage_entries (void)
323 process_stage_entries (NUM_FIN_STAGE_ENTRIES, &next_fin_stage_entry, fin_stage_entries, process_fin_stage_entry);
327 mono_gc_register_for_finalization (MonoObject *obj, void *user_data)
329 while (!add_stage_entry (NUM_FIN_STAGE_ENTRIES, &next_fin_stage_entry, fin_stage_entries, obj, user_data)) {
331 sgen_process_fin_stage_entries ();
336 /* LOCKING: requires that the GC lock is held */
338 finalizers_for_domain (MonoDomain *domain, MonoObject **out_array, int out_size,
339 SgenHashTable *hash_table)
345 if (no_finalize || !out_size || !out_array)
348 SGEN_HASH_TABLE_FOREACH (hash_table, object, dummy) {
349 object = tagged_object_get_object (object);
351 if (mono_object_domain (object) == domain) {
352 /* remove and put in out_array */
353 SGEN_HASH_TABLE_FOREACH_REMOVE (TRUE);
354 out_array [count ++] = object;
355 SGEN_LOG (5, "Collecting object for finalization: %p (%s) (%d/%d)", object, sgen_safe_name (object), num_ready_finalizers, sgen_hash_table_num_entries (hash_table));
356 if (count == out_size)
360 } SGEN_HASH_TABLE_FOREACH_END;
365 * mono_gc_finalizers_for_domain:
366 * @domain: the unloading appdomain
367 * @out_array: output array
368 * @out_size: size of output array
370 * Store inside @out_array up to @out_size objects that belong to the unloading
371 * appdomain @domain. Returns the number of stored items. Can be called repeteadly
372 * until it returns 0.
373 * The items are removed from the finalizer data structure, so the caller is supposed
375 * @out_array should be on the stack to allow the GC to know the objects are still alive.
378 mono_gc_finalizers_for_domain (MonoDomain *domain, MonoObject **out_array, int out_size)
383 sgen_process_fin_stage_entries ();
384 result = finalizers_for_domain (domain, out_array, out_size, &minor_finalizable_hash);
385 if (result < out_size) {
386 result += finalizers_for_domain (domain, out_array + result, out_size - result,
387 &major_finalizable_hash);
394 static SgenHashTable minor_disappearing_link_hash = SGEN_HASH_TABLE_INIT (INTERNAL_MEM_DISLINK_TABLE, INTERNAL_MEM_DISLINK, 0, mono_aligned_addr_hash, NULL);
395 static SgenHashTable major_disappearing_link_hash = SGEN_HASH_TABLE_INIT (INTERNAL_MEM_DISLINK_TABLE, INTERNAL_MEM_DISLINK, 0, mono_aligned_addr_hash, NULL);
397 static SgenHashTable*
398 get_dislink_hash_table (int generation)
400 switch (generation) {
401 case GENERATION_NURSERY: return &minor_disappearing_link_hash;
402 case GENERATION_OLD: return &major_disappearing_link_hash;
403 default: g_assert_not_reached ();
407 /* LOCKING: assumes the GC lock is held */
409 add_or_remove_disappearing_link (MonoObject *obj, void **link, int generation)
411 SgenHashTable *hash_table = get_dislink_hash_table (generation);
414 if (sgen_hash_table_remove (hash_table, link, NULL)) {
415 SGEN_LOG (5, "Removed dislink %p (%d) from %s table",
416 link, hash_table->num_entries, sgen_generation_name (generation));
421 sgen_hash_table_replace (hash_table, link, NULL, NULL);
422 SGEN_LOG (5, "Added dislink for object: %p (%s) at %p to %s table",
423 obj, obj->vtable->klass->name, link, sgen_generation_name (generation));
426 /* LOCKING: requires that the GC lock is held */
428 sgen_null_link_in_range (CopyOrMarkObjectFunc copy_func, char *start, char *end, int generation, gboolean before_finalization, GrayQueue *queue)
432 SgenHashTable *hash = get_dislink_hash_table (generation);
434 SGEN_HASH_TABLE_FOREACH (hash, link, dummy) {
436 gboolean track = DISLINK_TRACK (link);
439 * Tracked references are processed after
440 * finalization handling whereas standard weak
441 * references are processed before. If an
442 * object is still not marked after finalization
443 * handling it means that it either doesn't have
444 * a finalizer or the finalizer has already run,
445 * so we must null a tracking reference.
447 if (track != before_finalization) {
448 object = DISLINK_OBJECT (link);
450 if (object >= start && object < end && !major_collector.is_object_live (object)) {
451 if (sgen_gc_is_object_ready_for_finalization (object)) {
453 SGEN_LOG (5, "Dislink nullified at %p to GCed object %p", link, object);
454 SGEN_HASH_TABLE_FOREACH_REMOVE (TRUE);
458 copy_func ((void**)©, queue);
460 /* Update pointer if it's moved. If the object
461 * has been moved out of the nursery, we need to
462 * remove the link from the minor hash table to
465 * FIXME: what if an object is moved earlier?
468 if (hash == &minor_disappearing_link_hash && !ptr_in_nursery (copy)) {
469 SGEN_HASH_TABLE_FOREACH_REMOVE (TRUE);
472 *link = HIDE_POINTER (copy, track);
473 add_or_remove_disappearing_link ((MonoObject*)copy, link, GENERATION_OLD);
475 SGEN_LOG (5, "Upgraded dislink at %p to major because object %p moved to %p", link, object, copy);
479 *link = HIDE_POINTER (copy, track);
480 SGEN_LOG (5, "Updated dislink at %p to %p", link, DISLINK_OBJECT (link));
485 } SGEN_HASH_TABLE_FOREACH_END;
488 /* LOCKING: requires that the GC lock is held */
490 sgen_null_links_for_domain (MonoDomain *domain, int generation)
494 SgenHashTable *hash = get_dislink_hash_table (generation);
495 SGEN_HASH_TABLE_FOREACH (hash, link, dummy) {
496 char *object = DISLINK_OBJECT (link);
497 if (object && !((MonoObject*)object)->vtable) {
498 gboolean free = TRUE;
504 * This can happen if finalizers are not ran, i.e. Environment.Exit ()
505 * is called from finalizer like in finalizer-abort.cs.
507 SGEN_LOG (5, "Disappearing link %p not freed", link);
510 SGEN_HASH_TABLE_FOREACH_REMOVE (free);
514 } SGEN_HASH_TABLE_FOREACH_END;
517 /* LOCKING: requires that the GC lock is held */
519 sgen_null_links_with_predicate (int generation, WeakLinkAlivePredicateFunc predicate, void *data)
523 SgenHashTable *hash = get_dislink_hash_table (generation);
524 SGEN_HASH_TABLE_FOREACH (hash, link, dummy) {
525 char *object = DISLINK_OBJECT (link);
526 mono_bool is_alive = predicate ((MonoObject*)object, data);
530 SGEN_LOG (5, "Dislink nullified by predicate at %p to GCed object %p", link, object);
531 SGEN_HASH_TABLE_FOREACH_REMOVE (TRUE);
534 } SGEN_HASH_TABLE_FOREACH_END;
538 sgen_remove_finalizers_for_domain (MonoDomain *domain, int generation)
540 SgenHashTable *hash_table = get_finalize_entry_hash_table (generation);
544 SGEN_HASH_TABLE_FOREACH (hash_table, object, dummy) {
545 object = tagged_object_get_object (object);
547 if (mono_object_domain (object) == domain) {
548 SGEN_LOG (5, "Unregistering finalizer for object: %p (%s)", object, sgen_safe_name (object));
550 SGEN_HASH_TABLE_FOREACH_REMOVE (TRUE);
553 } SGEN_HASH_TABLE_FOREACH_END;
556 /* LOCKING: requires that the GC lock is held */
558 process_dislink_stage_entry (MonoObject *obj, void *_link)
562 add_or_remove_disappearing_link (NULL, link, GENERATION_NURSERY);
563 add_or_remove_disappearing_link (NULL, link, GENERATION_OLD);
565 if (ptr_in_nursery (obj))
566 add_or_remove_disappearing_link (obj, link, GENERATION_NURSERY);
568 add_or_remove_disappearing_link (obj, link, GENERATION_OLD);
572 #define NUM_DISLINK_STAGE_ENTRIES 1024
574 static volatile gint32 next_dislink_stage_entry = 0;
575 static StageEntry dislink_stage_entries [NUM_DISLINK_STAGE_ENTRIES];
577 /* LOCKING: requires that the GC lock is held */
579 sgen_process_dislink_stage_entries (void)
581 process_stage_entries (NUM_DISLINK_STAGE_ENTRIES, &next_dislink_stage_entry, dislink_stage_entries, process_dislink_stage_entry);
585 sgen_register_disappearing_link (MonoObject *obj, void **link, gboolean track, gboolean in_gc)
587 if (MONO_GC_WEAK_UPDATE_ENABLED ()) {
588 MonoVTable *vt = obj ? (MonoVTable*)SGEN_LOAD_VTABLE (obj) : NULL;
589 MONO_GC_WEAK_UPDATE ((mword)link,
590 *link ? (mword)DISLINK_OBJECT (link) : (mword)0,
592 obj ? (mword)sgen_safe_object_get_size (obj) : (mword)0,
593 obj ? vt->klass->name_space : NULL,
594 obj ? vt->klass->name : NULL,
599 *link = HIDE_POINTER (obj, track);
605 process_dislink_stage_entry (obj, link);
607 while (!add_stage_entry (NUM_DISLINK_STAGE_ENTRIES, &next_dislink_stage_entry, dislink_stage_entries, obj, link)) {
609 sgen_process_dislink_stage_entries ();
616 process_dislink_stage_entry (obj, link);
622 #endif /* HAVE_SGEN_GC */