finalize.c

   1 /*
   2  * Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
   3  * Copyright (c) 1991-1996 by Xerox Corporation.  All rights reserved.
   4  * Copyright (c) 1996-1999 by Silicon Graphics.  All rights reserved.
   5  * Copyright (C) 2007 Free Software Foundation, Inc
   6
   7  * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
   8  * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
   9  *
  10  * Permission is hereby granted to use or copy this program
  11  * for any purpose,  provided the above notices are retained on all copies.
  12  * Permission to modify the code and to distribute modified code is granted,
  13  * provided the above notices are retained, and a notice that the code was
  14  * modified is included with the above copyright notice.
  15  */
  16
  17 #include "private/gc_pmark.h"
  18
  19 #ifndef GC_NO_FINALIZATION
  20 # include "javaxfc.h" /* to get GC_finalize_all() as extern "C" */
  21
  22 /* Type of mark procedure used for marking from finalizable object.     */
  23 /* This procedure normally does not mark the object, only its           */
  24 /* descendants.                                                         */
  25 typedef void (* finalization_mark_proc)(ptr_t /* finalizable_obj_ptr */);
  26
  27 #define HASH3(addr,size,log_size) \
  28         ((((word)(addr) >> 3) ^ ((word)(addr) >> (3 + (log_size)))) \
  29          & ((size) - 1))
  30 #define HASH2(addr,log_size) HASH3(addr, (word)1 << (log_size), log_size)
  31
  32 struct hash_chain_entry {
  33     word hidden_key;
  34     struct hash_chain_entry * next;
  35 };
  36
  37 struct disappearing_link {
  38     struct hash_chain_entry prolog;
  39 #   define dl_hidden_link prolog.hidden_key
  40                                 /* Field to be cleared.         */
  41 #   define dl_next(x) (struct disappearing_link *)((x) -> prolog.next)
  42 #   define dl_set_next(x, y) \
  43                 (void)((x)->prolog.next = (struct hash_chain_entry *)(y))
  44     word dl_hidden_obj;         /* Pointer to object base       */
  45 };
  46
  47 struct dl_hashtbl_s {
  48     struct disappearing_link **head;
  49     signed_word log_size;
  50     word entries;
  51 };
  52
  53 STATIC struct dl_hashtbl_s GC_dl_hashtbl = {
  54     /* head */ NULL, /* log_size */ -1, /* entries */ 0 };
  55 #ifndef GC_LONG_REFS_NOT_NEEDED
  56   STATIC struct dl_hashtbl_s GC_ll_hashtbl = { NULL, -1, 0 };
  57 #endif
  58
  59 struct finalizable_object {
  60     struct hash_chain_entry prolog;
  61 #   define fo_hidden_base prolog.hidden_key
  62                                 /* Pointer to object base.      */
  63                                 /* No longer hidden once object */
  64                                 /* is on finalize_now queue.    */
  65 #   define fo_next(x) (struct finalizable_object *)((x) -> prolog.next)
  66 #   define fo_set_next(x,y) ((x)->prolog.next = (struct hash_chain_entry *)(y))
  67     GC_finalization_proc fo_fn; /* Finalizer.                   */
  68     ptr_t fo_client_data;
  69     word fo_object_size;        /* In bytes.                    */
  70     finalization_mark_proc fo_mark_proc;        /* Mark-through procedure */
  71 };
  72
  73 static signed_word log_fo_table_size = -1;
  74
  75 STATIC struct fnlz_roots_s {
  76   struct finalizable_object **fo_head;
  77   /* List of objects that should be finalized now: */
  78   struct finalizable_object *finalize_now;
  79 } GC_fnlz_roots = { NULL, NULL };
  80
  81 #ifdef AO_HAVE_store
  82   /* Update finalize_now atomically as GC_should_invoke_finalizers does */
  83   /* not acquire the allocation lock.                                   */
  84 # define SET_FINALIZE_NOW(fo) \
  85             AO_store((volatile AO_t *)&GC_fnlz_roots.finalize_now, (AO_t)(fo))
  86 #else
  87 # define SET_FINALIZE_NOW(fo) (void)(GC_fnlz_roots.finalize_now = (fo))
  88 #endif /* !THREADS */
  89
  90 GC_API void GC_CALL GC_push_finalizer_structures(void)
  91 {
  92   GC_ASSERT((word)(&GC_dl_hashtbl.head) % sizeof(word) == 0);
  93   GC_ASSERT((word)(&GC_fnlz_roots) % sizeof(word) == 0);
  94 # ifndef GC_LONG_REFS_NOT_NEEDED
  95     GC_ASSERT((word)(&GC_ll_hashtbl.head) % sizeof(word) == 0);
  96     GC_PUSH_ALL_SYM(GC_ll_hashtbl.head);
  97 # endif
  98   GC_PUSH_ALL_SYM(GC_dl_hashtbl.head);
  99   GC_PUSH_ALL_SYM(GC_fnlz_roots);
 100 }
 101
 102 /* Threshold of log_size to initiate full collection before growing     */
 103 /* a hash table.                                                        */
 104 #ifndef GC_ON_GROW_LOG_SIZE_MIN
 105 # define GC_ON_GROW_LOG_SIZE_MIN CPP_LOG_HBLKSIZE
 106 #endif
 107
 108 /* Double the size of a hash table. *log_size_ptr is the log of its     */
 109 /* current size.  May be a no-op.                                       */
 110 /* *table is a pointer to an array of hash headers.  If we succeed, we  */
 111 /* update both *table and *log_size_ptr.  Lock is held.                 */
 112 STATIC void GC_grow_table(struct hash_chain_entry ***table,
 113                           signed_word *log_size_ptr, word *entries_ptr)
 114 {
 115     word i;
 116     struct hash_chain_entry *p;
 117     signed_word log_old_size = *log_size_ptr;
 118     signed_word log_new_size = log_old_size + 1;
 119     word old_size = log_old_size == -1 ? 0 : (word)1 << log_old_size;
 120     word new_size = (word)1 << log_new_size;
 121     /* FIXME: Power of 2 size often gets rounded up to one more page. */
 122     struct hash_chain_entry **new_table;
 123
 124     GC_ASSERT(I_HOLD_LOCK());
 125     /* Avoid growing the table in case of at least 25% of entries can   */
 126     /* be deleted by enforcing a collection.  Ignored for small tables. */
 127     /* In incremental mode we skip this optimization, as we want to     */
 128     /* avoid triggering a full GC whenever possible.                    */
 129     if (log_old_size >= GC_ON_GROW_LOG_SIZE_MIN && !GC_incremental) {
 130       IF_CANCEL(int cancel_state;)
 131
 132       DISABLE_CANCEL(cancel_state);
 133       (void)GC_try_to_collect_inner(GC_never_stop_func);
 134       RESTORE_CANCEL(cancel_state);
 135       /* GC_finalize might decrease entries value.  */
 136       if (*entries_ptr < ((word)1 << log_old_size) - (*entries_ptr >> 2))
 137         return;
 138     }
 139
 140     new_table = (struct hash_chain_entry **)
 141                     GC_INTERNAL_MALLOC_IGNORE_OFF_PAGE(
 142                         (size_t)new_size * sizeof(struct hash_chain_entry *),
 143                         NORMAL);
 144     if (new_table == 0) {
 145         if (*table == 0) {
 146             ABORT("Insufficient space for initial table allocation");
 147         } else {
 148             return;
 149         }
 150     }
 151     for (i = 0; i < old_size; i++) {
 152       p = (*table)[i];
 153       while (p != 0) {
 154         ptr_t real_key = (ptr_t)GC_REVEAL_POINTER(p->hidden_key);
 155         struct hash_chain_entry *next = p -> next;
 156         size_t new_hash = HASH3(real_key, new_size, log_new_size);
 157
 158         p -> next = new_table[new_hash];
 159         GC_dirty(p);
 160         new_table[new_hash] = p;
 161         p = next;
 162       }
 163     }
 164     *log_size_ptr = log_new_size;
 165     *table = new_table;
 166     GC_dirty(new_table); /* entire object */
 167 }
 168
 169 GC_API int GC_CALL GC_register_disappearing_link(void * * link)
 170 {
 171     ptr_t base;
 172
 173     base = (ptr_t)GC_base(link);
 174     if (base == 0)
 175         ABORT("Bad arg to GC_register_disappearing_link");
 176     return(GC_general_register_disappearing_link(link, base));
 177 }
 178
 179 STATIC int GC_register_disappearing_link_inner(
 180                         struct dl_hashtbl_s *dl_hashtbl, void **link,
 181                         const void *obj, const char *tbl_log_name)
 182 {
 183     struct disappearing_link *curr_dl;
 184     size_t index;
 185     struct disappearing_link * new_dl;
 186     DCL_LOCK_STATE;
 187
 188     if (EXPECT(GC_find_leak, FALSE)) return GC_UNIMPLEMENTED;
 189     LOCK();
 190     GC_ASSERT(obj != NULL && GC_base_C(obj) == obj);
 191     if (dl_hashtbl -> log_size == -1
 192         || dl_hashtbl -> entries > ((word)1 << dl_hashtbl -> log_size)) {
 193         GC_grow_table((struct hash_chain_entry ***)&dl_hashtbl -> head,
 194                       &dl_hashtbl -> log_size, &dl_hashtbl -> entries);
 195 #       ifdef LINT2
 196           if (dl_hashtbl->log_size < 0) ABORT("log_size is negative");
 197 #       endif
 198         GC_COND_LOG_PRINTF("Grew %s table to %u entries\n", tbl_log_name,
 199                            1 << (unsigned)dl_hashtbl -> log_size);
 200     }
 201     index = HASH2(link, dl_hashtbl -> log_size);
 202     for (curr_dl = dl_hashtbl -> head[index]; curr_dl != 0;
 203          curr_dl = dl_next(curr_dl)) {
 204         if (curr_dl -> dl_hidden_link == GC_HIDE_POINTER(link)) {
 205             curr_dl -> dl_hidden_obj = GC_HIDE_POINTER(obj);
 206             UNLOCK();
 207             return GC_DUPLICATE;
 208         }
 209     }
 210     new_dl = (struct disappearing_link *)
 211         GC_INTERNAL_MALLOC(sizeof(struct disappearing_link),NORMAL);
 212     if (0 == new_dl) {
 213       GC_oom_func oom_fn = GC_oom_fn;
 214       UNLOCK();
 215       new_dl = (struct disappearing_link *)
 216                 (*oom_fn)(sizeof(struct disappearing_link));
 217       if (0 == new_dl) {
 218         return GC_NO_MEMORY;
 219       }
 220       /* It's not likely we'll make it here, but ... */
 221       LOCK();
 222       /* Recalculate index since the table may grow.    */
 223       index = HASH2(link, dl_hashtbl -> log_size);
 224       /* Check again that our disappearing link not in the table. */
 225       for (curr_dl = dl_hashtbl -> head[index]; curr_dl != 0;
 226            curr_dl = dl_next(curr_dl)) {
 227         if (curr_dl -> dl_hidden_link == GC_HIDE_POINTER(link)) {
 228           curr_dl -> dl_hidden_obj = GC_HIDE_POINTER(obj);
 229           UNLOCK();
 230 #         ifndef DBG_HDRS_ALL
 231             /* Free unused new_dl returned by GC_oom_fn() */
 232             GC_free((void *)new_dl);
 233 #         endif
 234           return GC_DUPLICATE;
 235         }
 236       }
 237     }
 238     new_dl -> dl_hidden_obj = GC_HIDE_POINTER(obj);
 239     new_dl -> dl_hidden_link = GC_HIDE_POINTER(link);
 240     dl_set_next(new_dl, dl_hashtbl -> head[index]);
 241     GC_dirty(new_dl);
 242     dl_hashtbl -> head[index] = new_dl;
 243     dl_hashtbl -> entries++;
 244     GC_dirty(dl_hashtbl->head + index);
 245     UNLOCK();
 246     return GC_SUCCESS;
 247 }
 248
 249 GC_API int GC_CALL GC_general_register_disappearing_link(void * * link,
 250                                                          const void * obj)
 251 {
 252     if (((word)link & (ALIGNMENT-1)) != 0 || !NONNULL_ARG_NOT_NULL(link))
 253         ABORT("Bad arg to GC_general_register_disappearing_link");
 254     return GC_register_disappearing_link_inner(&GC_dl_hashtbl, link, obj,
 255                                                "dl");
 256 }
 257
 258 #ifdef DBG_HDRS_ALL
 259 # define FREE_DL_ENTRY(curr_dl) dl_set_next(curr_dl, NULL)
 260 #else
 261 # define FREE_DL_ENTRY(curr_dl) GC_free(curr_dl)
 262 #endif
 263
 264 /* Unregisters given link and returns the link entry to free.   */
 265 GC_INLINE struct disappearing_link *GC_unregister_disappearing_link_inner(
 266                                 struct dl_hashtbl_s *dl_hashtbl, void **link)
 267 {
 268     struct disappearing_link *curr_dl;
 269     struct disappearing_link *prev_dl = NULL;
 270     size_t index;
 271
 272     GC_ASSERT(I_HOLD_LOCK());
 273     if (dl_hashtbl->log_size == -1)
 274         return NULL; /* prevent integer shift by a negative amount */
 275
 276     index = HASH2(link, dl_hashtbl->log_size);
 277     for (curr_dl = dl_hashtbl -> head[index]; curr_dl;
 278          curr_dl = dl_next(curr_dl)) {
 279         if (curr_dl -> dl_hidden_link == GC_HIDE_POINTER(link)) {
 280             /* Remove found entry from the table. */
 281             if (NULL == prev_dl) {
 282                 dl_hashtbl -> head[index] = dl_next(curr_dl);
 283                 GC_dirty(dl_hashtbl->head + index);
 284             } else {
 285                 dl_set_next(prev_dl, dl_next(curr_dl));
 286                 GC_dirty(prev_dl);
 287             }
 288             dl_hashtbl -> entries--;
 289             break;
 290         }
 291         prev_dl = curr_dl;
 292     }
 293     return curr_dl;
 294 }
 295
 296 GC_API int GC_CALL GC_unregister_disappearing_link(void * * link)
 297 {
 298     struct disappearing_link *curr_dl;
 299     DCL_LOCK_STATE;
 300
 301     if (((word)link & (ALIGNMENT-1)) != 0) return(0); /* Nothing to do. */
 302
 303     LOCK();
 304     curr_dl = GC_unregister_disappearing_link_inner(&GC_dl_hashtbl, link);
 305     UNLOCK();
 306     if (NULL == curr_dl) return 0;
 307     FREE_DL_ENTRY(curr_dl);
 308     return 1;
 309 }
 310
 311 /* Toggle-ref support.  */
 312 #ifndef GC_TOGGLE_REFS_NOT_NEEDED
 313   typedef union {
 314     /* Lowest bit is used to distinguish between choices.       */
 315     void *strong_ref;
 316     GC_hidden_pointer weak_ref;
 317   } GCToggleRef;
 318
 319   STATIC GC_toggleref_func GC_toggleref_callback = 0;
 320   STATIC GCToggleRef *GC_toggleref_arr = NULL;
 321   STATIC int GC_toggleref_array_size = 0;
 322   STATIC int GC_toggleref_array_capacity = 0;
 323
 324   GC_INNER void GC_process_togglerefs(void)
 325   {
 326     int i;
 327     int new_size = 0;
 328     GC_bool needs_barrier = FALSE;
 329
 330     GC_ASSERT(I_HOLD_LOCK());
 331     for (i = 0; i < GC_toggleref_array_size; ++i) {
 332       GCToggleRef r = GC_toggleref_arr[i];
 333       void *obj = r.strong_ref;
 334
 335       if (((word)obj & 1) != 0) {
 336         obj = GC_REVEAL_POINTER(r.weak_ref);
 337       }
 338       if (NULL == obj) {
 339         continue;
 340       }
 341       switch (GC_toggleref_callback(obj)) {
 342       case GC_TOGGLE_REF_DROP:
 343         break;
 344       case GC_TOGGLE_REF_STRONG:
 345         GC_toggleref_arr[new_size++].strong_ref = obj;
 346         needs_barrier = TRUE;
 347         break;
 348       case GC_TOGGLE_REF_WEAK:
 349         GC_toggleref_arr[new_size++].weak_ref = GC_HIDE_POINTER(obj);
 350         break;
 351       default:
 352         ABORT("Bad toggle-ref status returned by callback");
 353       }
 354     }
 355
 356     if (new_size < GC_toggleref_array_size) {
 357       BZERO(&GC_toggleref_arr[new_size],
 358             (GC_toggleref_array_size - new_size) * sizeof(GCToggleRef));
 359       GC_toggleref_array_size = new_size;
 360     }
 361     if (needs_barrier)
 362       GC_dirty(GC_toggleref_arr); /* entire object */
 363   }
 364
 365   STATIC void GC_normal_finalize_mark_proc(ptr_t);
 366
 367   static void push_and_mark_object(void *p)
 368   {
 369     GC_normal_finalize_mark_proc((ptr_t)p);
 370     while (!GC_mark_stack_empty()) {
 371       MARK_FROM_MARK_STACK();
 372     }
 373     GC_set_mark_bit(p);
 374     if (GC_mark_state != MS_NONE) {
 375       while (!GC_mark_some(0)) {
 376         /* Empty. */
 377       }
 378     }
 379   }
 380
 381   STATIC void GC_mark_togglerefs(void)
 382   {
 383     int i;
 384     if (NULL == GC_toggleref_arr)
 385       return;
 386
 387     /* TODO: Hide GC_toggleref_arr to avoid its marking from roots. */
 388     GC_set_mark_bit(GC_toggleref_arr);
 389     for (i = 0; i < GC_toggleref_array_size; ++i) {
 390       void *obj = GC_toggleref_arr[i].strong_ref;
 391       if (obj != NULL && ((word)obj & 1) == 0) {
 392         push_and_mark_object(obj);
 393       }
 394     }
 395   }
 396
 397   STATIC void GC_clear_togglerefs(void)
 398   {
 399     int i;
 400     for (i = 0; i < GC_toggleref_array_size; ++i) {
 401       if ((GC_toggleref_arr[i].weak_ref & 1) != 0) {
 402         if (!GC_is_marked(GC_REVEAL_POINTER(GC_toggleref_arr[i].weak_ref))) {
 403           GC_toggleref_arr[i].weak_ref = 0;
 404         } else {
 405           /* No need to copy, BDWGC is a non-moving collector.    */
 406         }
 407       }
 408     }
 409   }
 410
 411   GC_API void GC_CALL GC_set_toggleref_func(GC_toggleref_func fn)
 412   {
 413     DCL_LOCK_STATE;
 414
 415     LOCK();
 416     GC_toggleref_callback = fn;
 417     UNLOCK();
 418   }
 419
 420   GC_API GC_toggleref_func GC_CALL GC_get_toggleref_func(void)
 421   {
 422     GC_toggleref_func fn;
 423     DCL_LOCK_STATE;
 424
 425     LOCK();
 426     fn = GC_toggleref_callback;
 427     UNLOCK();
 428     return fn;
 429   }
 430
 431   static GC_bool ensure_toggleref_capacity(int capacity_inc)
 432   {
 433     GC_ASSERT(capacity_inc >= 0);
 434     GC_ASSERT(I_HOLD_LOCK());
 435     if (NULL == GC_toggleref_arr) {
 436       GC_toggleref_array_capacity = 32; /* initial capacity */
 437       GC_toggleref_arr = (GCToggleRef *)GC_INTERNAL_MALLOC_IGNORE_OFF_PAGE(
 438                         GC_toggleref_array_capacity * sizeof(GCToggleRef),
 439                         NORMAL);
 440       if (NULL == GC_toggleref_arr)
 441         return FALSE;
 442     }
 443     if ((unsigned)GC_toggleref_array_size + (unsigned)capacity_inc
 444         >= (unsigned)GC_toggleref_array_capacity) {
 445       GCToggleRef *new_array;
 446       while ((unsigned)GC_toggleref_array_capacity
 447               < (unsigned)GC_toggleref_array_size + (unsigned)capacity_inc) {
 448         GC_toggleref_array_capacity *= 2;
 449         if (GC_toggleref_array_capacity < 0) /* overflow */
 450           return FALSE;
 451       }
 452
 453       new_array = (GCToggleRef *)GC_INTERNAL_MALLOC_IGNORE_OFF_PAGE(
 454                         GC_toggleref_array_capacity * sizeof(GCToggleRef),
 455                         NORMAL);
 456       if (NULL == new_array)
 457         return FALSE;
 458       if (EXPECT(GC_toggleref_array_size > 0, TRUE))
 459         BCOPY(GC_toggleref_arr, new_array,
 460               GC_toggleref_array_size * sizeof(GCToggleRef));
 461       GC_INTERNAL_FREE(GC_toggleref_arr);
 462       GC_toggleref_arr = new_array;
 463     }
 464     return TRUE;
 465   }
 466
 467   GC_API int GC_CALL GC_toggleref_add(void *obj, int is_strong_ref)
 468   {
 469     int res = GC_SUCCESS;
 470     DCL_LOCK_STATE;
 471
 472     GC_ASSERT(NONNULL_ARG_NOT_NULL(obj));
 473     LOCK();
 474     if (GC_toggleref_callback != 0) {
 475       if (!ensure_toggleref_capacity(1)) {
 476         res = GC_NO_MEMORY;
 477       } else {
 478         GC_toggleref_arr[GC_toggleref_array_size].strong_ref =
 479                         is_strong_ref ? obj : (void *)GC_HIDE_POINTER(obj);
 480         if (is_strong_ref)
 481           GC_dirty(GC_toggleref_arr + GC_toggleref_array_size);
 482         GC_toggleref_array_size++;
 483       }
 484     }
 485     UNLOCK();
 486     return res;
 487   }
 488 #endif /* !GC_TOGGLE_REFS_NOT_NEEDED */
 489
 490 /* Finalizer callback support. */
 491 STATIC GC_await_finalize_proc GC_object_finalized_proc = 0;
 492
 493 GC_API void GC_CALL GC_set_await_finalize_proc(GC_await_finalize_proc fn)
 494 {
 495   DCL_LOCK_STATE;
 496
 497   LOCK();
 498   GC_object_finalized_proc = fn;
 499   UNLOCK();
 500 }
 501
 502 GC_API GC_await_finalize_proc GC_CALL GC_get_await_finalize_proc(void)
 503 {
 504   GC_await_finalize_proc fn;
 505   DCL_LOCK_STATE;
 506
 507   LOCK();
 508   fn = GC_object_finalized_proc;
 509   UNLOCK();
 510   return fn;
 511 }
 512
 513 #ifndef GC_LONG_REFS_NOT_NEEDED
 514   GC_API int GC_CALL GC_register_long_link(void * * link, const void * obj)
 515   {
 516     if (((word)link & (ALIGNMENT-1)) != 0 || !NONNULL_ARG_NOT_NULL(link))
 517         ABORT("Bad arg to GC_register_long_link");
 518     return GC_register_disappearing_link_inner(&GC_ll_hashtbl, link, obj,
 519                                                "long dl");
 520   }
 521
 522   GC_API int GC_CALL GC_unregister_long_link(void * * link)
 523   {
 524     struct disappearing_link *curr_dl;
 525     DCL_LOCK_STATE;
 526
 527     if (((word)link & (ALIGNMENT-1)) != 0) return(0); /* Nothing to do. */
 528
 529     LOCK();
 530     curr_dl = GC_unregister_disappearing_link_inner(&GC_ll_hashtbl, link);
 531     UNLOCK();
 532     if (NULL == curr_dl) return 0;
 533     FREE_DL_ENTRY(curr_dl);
 534     return 1;
 535   }
 536 #endif /* !GC_LONG_REFS_NOT_NEEDED */
 537
 538 #ifndef GC_MOVE_DISAPPEARING_LINK_NOT_NEEDED
 539   /* Moves a link.  Assume the lock is held.    */
 540   STATIC int GC_move_disappearing_link_inner(
 541                                 struct dl_hashtbl_s *dl_hashtbl,
 542                                 void **link, void **new_link)
 543   {
 544     struct disappearing_link *curr_dl, *prev_dl, *new_dl;
 545     size_t curr_index, new_index;
 546     word curr_hidden_link;
 547     word new_hidden_link;
 548
 549     GC_ASSERT(I_HOLD_LOCK());
 550     if (dl_hashtbl->log_size == -1)
 551         return GC_NOT_FOUND; /* prevent integer shift by a negative amount */
 552
 553     /* Find current link.       */
 554     curr_index = HASH2(link, dl_hashtbl -> log_size);
 555     curr_hidden_link = GC_HIDE_POINTER(link);
 556     prev_dl = NULL;
 557     for (curr_dl = dl_hashtbl -> head[curr_index]; curr_dl;
 558          curr_dl = dl_next(curr_dl)) {
 559       if (curr_dl -> dl_hidden_link == curr_hidden_link)
 560         break;
 561       prev_dl = curr_dl;
 562     }
 563
 564     if (NULL == curr_dl) {
 565       return GC_NOT_FOUND;
 566     }
 567
 568     if (link == new_link) {
 569       return GC_SUCCESS; /* Nothing to do.      */
 570     }
 571
 572     /* link found; now check new_link not present.      */
 573     new_index = HASH2(new_link, dl_hashtbl -> log_size);
 574     new_hidden_link = GC_HIDE_POINTER(new_link);
 575     for (new_dl = dl_hashtbl -> head[new_index]; new_dl;
 576          new_dl = dl_next(new_dl)) {
 577       if (new_dl -> dl_hidden_link == new_hidden_link) {
 578         /* Target already registered; bail.     */
 579         return GC_DUPLICATE;
 580       }
 581     }
 582
 583     /* Remove from old, add to new, update link.        */
 584     if (NULL == prev_dl) {
 585       dl_hashtbl -> head[curr_index] = dl_next(curr_dl);
 586     } else {
 587       dl_set_next(prev_dl, dl_next(curr_dl));
 588       GC_dirty(prev_dl);
 589     }
 590     curr_dl -> dl_hidden_link = new_hidden_link;
 591     dl_set_next(curr_dl, dl_hashtbl -> head[new_index]);
 592     dl_hashtbl -> head[new_index] = curr_dl;
 593     GC_dirty(curr_dl);
 594     GC_dirty(dl_hashtbl->head); /* entire object */
 595     return GC_SUCCESS;
 596   }
 597
 598   GC_API int GC_CALL GC_move_disappearing_link(void **link, void **new_link)
 599   {
 600     int result;
 601     DCL_LOCK_STATE;
 602
 603     if (((word)new_link & (ALIGNMENT-1)) != 0
 604         || !NONNULL_ARG_NOT_NULL(new_link))
 605       ABORT("Bad new_link arg to GC_move_disappearing_link");
 606     if (((word)link & (ALIGNMENT-1)) != 0)
 607       return GC_NOT_FOUND; /* Nothing to do. */
 608
 609     LOCK();
 610     result = GC_move_disappearing_link_inner(&GC_dl_hashtbl, link, new_link);
 611     UNLOCK();
 612     return result;
 613   }
 614
 615 # ifndef GC_LONG_REFS_NOT_NEEDED
 616     GC_API int GC_CALL GC_move_long_link(void **link, void **new_link)
 617     {
 618       int result;
 619       DCL_LOCK_STATE;
 620
 621       if (((word)new_link & (ALIGNMENT-1)) != 0
 622           || !NONNULL_ARG_NOT_NULL(new_link))
 623         ABORT("Bad new_link arg to GC_move_long_link");
 624       if (((word)link & (ALIGNMENT-1)) != 0)
 625         return GC_NOT_FOUND; /* Nothing to do. */
 626
 627       LOCK();
 628       result = GC_move_disappearing_link_inner(&GC_ll_hashtbl, link, new_link);
 629       UNLOCK();
 630       return result;
 631     }
 632 # endif /* !GC_LONG_REFS_NOT_NEEDED */
 633 #endif /* !GC_MOVE_DISAPPEARING_LINK_NOT_NEEDED */
 634
 635 /* Possible finalization_marker procedures.  Note that mark stack       */
 636 /* overflow is handled by the caller, and is not a disaster.            */
 637 STATIC void GC_normal_finalize_mark_proc(ptr_t p)
 638 {
 639 # if defined(_MSC_VER) && defined(I386)
 640     hdr * hhdr = HDR(p);
 641     /* This is a manually inlined variant of GC_push_obj().  Otherwise  */
 642     /* some optimizer bug is tickled in VC for X86 (v19, at least).     */
 643 #   define mark_stack_top GC_mark_stack_top
 644     mse * mark_stack_limit = GC_mark_stack + GC_mark_stack_size;
 645     word descr = hhdr -> hb_descr;
 646
 647     if (descr != 0) {
 648       mark_stack_top++;
 649       if ((word)mark_stack_top >= (word)mark_stack_limit) {
 650         mark_stack_top = GC_signal_mark_stack_overflow(mark_stack_top);
 651       }
 652       mark_stack_top -> mse_start = p;
 653       mark_stack_top -> mse_descr.w = descr;
 654     }
 655 #   undef mark_stack_top
 656 # else
 657     GC_mark_stack_top = GC_push_obj(p, HDR(p), GC_mark_stack_top,
 658                                     GC_mark_stack + GC_mark_stack_size);
 659 # endif
 660 }
 661
 662 /* This only pays very partial attention to the mark descriptor.        */
 663 /* It does the right thing for normal and atomic objects, and treats    */
 664 /* most others as normal.                                               */
 665 STATIC void GC_ignore_self_finalize_mark_proc(ptr_t p)
 666 {
 667     hdr * hhdr = HDR(p);
 668     word descr = hhdr -> hb_descr;
 669     ptr_t q;
 670     ptr_t scan_limit;
 671     ptr_t target_limit = p + hhdr -> hb_sz - 1;
 672
 673     if ((descr & GC_DS_TAGS) == GC_DS_LENGTH) {
 674        scan_limit = p + descr - sizeof(word);
 675     } else {
 676        scan_limit = target_limit + 1 - sizeof(word);
 677     }
 678     for (q = p; (word)q <= (word)scan_limit; q += ALIGNMENT) {
 679         word r = *(word *)q;
 680
 681         if (r < (word)p || r > (word)target_limit) {
 682             GC_PUSH_ONE_HEAP(r, q, GC_mark_stack_top);
 683         }
 684     }
 685 }
 686
 687 STATIC void GC_null_finalize_mark_proc(ptr_t p GC_ATTR_UNUSED) {}
 688
 689 /* Possible finalization_marker procedures.  Note that mark stack       */
 690 /* overflow is handled by the caller, and is not a disaster.            */
 691
 692 /* GC_unreachable_finalize_mark_proc is an alias for normal marking,    */
 693 /* but it is explicitly tested for, and triggers different              */
 694 /* behavior.  Objects registered in this way are not finalized          */
 695 /* if they are reachable by other finalizable objects, even if those    */
 696 /* other objects specify no ordering.                                   */
 697 STATIC void GC_unreachable_finalize_mark_proc(ptr_t p)
 698 {
 699     GC_normal_finalize_mark_proc(p);
 700 }
 701
 702 /* Register a finalization function.  See gc.h for details.     */
 703 /* The last parameter is a procedure that determines            */
 704 /* marking for finalization ordering.  Any objects marked       */
 705 /* by that procedure will be guaranteed to not have been        */
 706 /* finalized when this finalizer is invoked.                    */
 707 STATIC void GC_register_finalizer_inner(void * obj,
 708                                         GC_finalization_proc fn, void *cd,
 709                                         GC_finalization_proc *ofn, void **ocd,
 710                                         finalization_mark_proc mp)
 711 {
 712     struct finalizable_object * curr_fo;
 713     size_t index;
 714     struct finalizable_object *new_fo = 0;
 715     hdr *hhdr = NULL; /* initialized to prevent warning. */
 716     DCL_LOCK_STATE;
 717
 718     if (EXPECT(GC_find_leak, FALSE)) return;
 719     LOCK();
 720     if (log_fo_table_size == -1
 721         || GC_fo_entries > ((word)1 << log_fo_table_size)) {
 722         GC_grow_table((struct hash_chain_entry ***)&GC_fnlz_roots.fo_head,
 723                       &log_fo_table_size, &GC_fo_entries);
 724 #       ifdef LINT2
 725           if (log_fo_table_size < 0) ABORT("log_size is negative");
 726 #       endif
 727         GC_COND_LOG_PRINTF("Grew fo table to %u entries\n",
 728                            1 << (unsigned)log_fo_table_size);
 729     }
 730     /* in the THREADS case we hold allocation lock.             */
 731     for (;;) {
 732       struct finalizable_object *prev_fo = NULL;
 733       GC_oom_func oom_fn;
 734
 735       index = HASH2(obj, log_fo_table_size);
 736       curr_fo = GC_fnlz_roots.fo_head[index];
 737       while (curr_fo != 0) {
 738         GC_ASSERT(GC_size(curr_fo) >= sizeof(struct finalizable_object));
 739         if (curr_fo -> fo_hidden_base == GC_HIDE_POINTER(obj)) {
 740           /* Interruption by a signal in the middle of this     */
 741           /* should be safe.  The client may see only *ocd      */
 742           /* updated, but we'll declare that to be his problem. */
 743           if (ocd) *ocd = (void *) (curr_fo -> fo_client_data);
 744           if (ofn) *ofn = curr_fo -> fo_fn;
 745           /* Delete the structure for obj.      */
 746           if (prev_fo == 0) {
 747             GC_fnlz_roots.fo_head[index] = fo_next(curr_fo);
 748           } else {
 749             fo_set_next(prev_fo, fo_next(curr_fo));
 750             GC_dirty(prev_fo);
 751           }
 752           if (fn == 0) {
 753             GC_fo_entries--;
 754             /* May not happen if we get a signal.  But a high   */
 755             /* estimate will only make the table larger than    */
 756             /* necessary.                                       */
 757 #           if !defined(THREADS) && !defined(DBG_HDRS_ALL)
 758               GC_free((void *)curr_fo);
 759 #           endif
 760           } else {
 761             curr_fo -> fo_fn = fn;
 762             curr_fo -> fo_client_data = (ptr_t)cd;
 763             curr_fo -> fo_mark_proc = mp;
 764             GC_dirty(curr_fo);
 765             /* Reinsert it.  We deleted it first to maintain    */
 766             /* consistency in the event of a signal.            */
 767             if (prev_fo == 0) {
 768               GC_fnlz_roots.fo_head[index] = curr_fo;
 769             } else {
 770               fo_set_next(prev_fo, curr_fo);
 771               GC_dirty(prev_fo);
 772             }
 773           }
 774           if (NULL == prev_fo)
 775             GC_dirty(GC_fnlz_roots.fo_head + index);
 776           UNLOCK();
 777 #         ifndef DBG_HDRS_ALL
 778               /* Free unused new_fo returned by GC_oom_fn() */
 779               GC_free((void *)new_fo);
 780 #         endif
 781           return;
 782         }
 783         prev_fo = curr_fo;
 784         curr_fo = fo_next(curr_fo);
 785       }
 786       if (EXPECT(new_fo != 0, FALSE)) {
 787         /* new_fo is returned by GC_oom_fn().   */
 788         GC_ASSERT(fn != 0);
 789 #       ifdef LINT2
 790           if (NULL == hhdr) ABORT("Bad hhdr in GC_register_finalizer_inner");
 791 #       endif
 792         break;
 793       }
 794       if (fn == 0) {
 795         if (ocd) *ocd = 0;
 796         if (ofn) *ofn = 0;
 797         UNLOCK();
 798         return;
 799       }
 800       GET_HDR(obj, hhdr);
 801       if (EXPECT(0 == hhdr, FALSE)) {
 802         /* We won't collect it, hence finalizer wouldn't be run. */
 803         if (ocd) *ocd = 0;
 804         if (ofn) *ofn = 0;
 805         UNLOCK();
 806         return;
 807       }
 808       new_fo = (struct finalizable_object *)
 809         GC_INTERNAL_MALLOC(sizeof(struct finalizable_object),NORMAL);
 810       if (EXPECT(new_fo != 0, TRUE))
 811         break;
 812       oom_fn = GC_oom_fn;
 813       UNLOCK();
 814       new_fo = (struct finalizable_object *)
 815                 (*oom_fn)(sizeof(struct finalizable_object));
 816       if (0 == new_fo) {
 817         /* No enough memory.  *ocd and *ofn remains unchanged.  */
 818         return;
 819       }
 820       /* It's not likely we'll make it here, but ... */
 821       LOCK();
 822       /* Recalculate index since the table may grow and         */
 823       /* check again that our finalizer is not in the table.    */
 824     }
 825     GC_ASSERT(GC_size(new_fo) >= sizeof(struct finalizable_object));
 826     if (ocd) *ocd = 0;
 827     if (ofn) *ofn = 0;
 828     new_fo -> fo_hidden_base = GC_HIDE_POINTER(obj);
 829     new_fo -> fo_fn = fn;
 830     new_fo -> fo_client_data = (ptr_t)cd;
 831     new_fo -> fo_object_size = hhdr -> hb_sz;
 832     new_fo -> fo_mark_proc = mp;
 833     fo_set_next(new_fo, GC_fnlz_roots.fo_head[index]);
 834     GC_dirty(new_fo);
 835     GC_fo_entries++;
 836     GC_fnlz_roots.fo_head[index] = new_fo;
 837     GC_dirty(GC_fnlz_roots.fo_head + index);
 838     UNLOCK();
 839 }
 840
 841 GC_API void GC_CALL GC_register_finalizer(void * obj,
 842                                   GC_finalization_proc fn, void * cd,
 843                                   GC_finalization_proc *ofn, void ** ocd)
 844 {
 845     GC_register_finalizer_inner(obj, fn, cd, ofn,
 846                                 ocd, GC_normal_finalize_mark_proc);
 847 }
 848
 849 GC_API void GC_CALL GC_register_finalizer_ignore_self(void * obj,
 850                                GC_finalization_proc fn, void * cd,
 851                                GC_finalization_proc *ofn, void ** ocd)
 852 {
 853     GC_register_finalizer_inner(obj, fn, cd, ofn,
 854                                 ocd, GC_ignore_self_finalize_mark_proc);
 855 }
 856
 857 GC_API void GC_CALL GC_register_finalizer_no_order(void * obj,
 858                                GC_finalization_proc fn, void * cd,
 859                                GC_finalization_proc *ofn, void ** ocd)
 860 {
 861     GC_register_finalizer_inner(obj, fn, cd, ofn,
 862                                 ocd, GC_null_finalize_mark_proc);
 863 }
 864
 865 static GC_bool need_unreachable_finalization = FALSE;
 866         /* Avoid the work if this isn't used.   */
 867
 868 GC_API void GC_CALL GC_register_finalizer_unreachable(void * obj,
 869                                GC_finalization_proc fn, void * cd,
 870                                GC_finalization_proc *ofn, void ** ocd)
 871 {
 872     need_unreachable_finalization = TRUE;
 873     GC_ASSERT(GC_java_finalization);
 874     GC_register_finalizer_inner(obj, fn, cd, ofn,
 875                                 ocd, GC_unreachable_finalize_mark_proc);
 876 }
 877
 878 #ifndef NO_DEBUGGING
 879   STATIC void GC_dump_finalization_links(
 880                                 const struct dl_hashtbl_s *dl_hashtbl)
 881   {
 882     size_t dl_size = dl_hashtbl->log_size == -1 ? 0 :
 883                                 (size_t)1 << dl_hashtbl->log_size;
 884     size_t i;
 885
 886     for (i = 0; i < dl_size; i++) {
 887       struct disappearing_link *curr_dl;
 888
 889       for (curr_dl = dl_hashtbl -> head[i]; curr_dl != 0;
 890            curr_dl = dl_next(curr_dl)) {
 891         ptr_t real_ptr = (ptr_t)GC_REVEAL_POINTER(curr_dl->dl_hidden_obj);
 892         ptr_t real_link = (ptr_t)GC_REVEAL_POINTER(curr_dl->dl_hidden_link);
 893
 894         GC_printf("Object: %p, link: %p\n",
 895                   (void *)real_ptr, (void *)real_link);
 896       }
 897     }
 898   }
 899
 900   GC_API void GC_CALL GC_dump_finalization(void)
 901   {
 902     struct finalizable_object * curr_fo;
 903     size_t fo_size = log_fo_table_size == -1 ? 0 :
 904                                 (size_t)1 << log_fo_table_size;
 905     size_t i;
 906
 907     GC_printf("Disappearing (short) links:\n");
 908     GC_dump_finalization_links(&GC_dl_hashtbl);
 909 #   ifndef GC_LONG_REFS_NOT_NEEDED
 910       GC_printf("Disappearing long links:\n");
 911       GC_dump_finalization_links(&GC_ll_hashtbl);
 912 #   endif
 913     GC_printf("Finalizers:\n");
 914     for (i = 0; i < fo_size; i++) {
 915       for (curr_fo = GC_fnlz_roots.fo_head[i];
 916            curr_fo != NULL; curr_fo = fo_next(curr_fo)) {
 917         ptr_t real_ptr = (ptr_t)GC_REVEAL_POINTER(curr_fo->fo_hidden_base);
 918
 919         GC_printf("Finalizable object: %p\n", (void *)real_ptr);
 920       }
 921     }
 922   }
 923 #endif /* !NO_DEBUGGING */
 924
 925 #ifndef SMALL_CONFIG
 926   STATIC word GC_old_dl_entries = 0; /* for stats printing */
 927 # ifndef GC_LONG_REFS_NOT_NEEDED
 928     STATIC word GC_old_ll_entries = 0;
 929 # endif
 930 #endif /* !SMALL_CONFIG */
 931
 932 #ifndef THREADS
 933   /* Global variables to minimize the level of recursion when a client  */
 934   /* finalizer allocates memory.                                        */
 935   STATIC int GC_finalizer_nested = 0;
 936                         /* Only the lowest byte is used, the rest is    */
 937                         /* padding for proper global data alignment     */
 938                         /* required for some compilers (like Watcom).   */
 939   STATIC unsigned GC_finalizer_skipped = 0;
 940
 941   /* Checks and updates the level of finalizers recursion.              */
 942   /* Returns NULL if GC_invoke_finalizers() should not be called by the */
 943   /* collector (to minimize the risk of a deep finalizers recursion),   */
 944   /* otherwise returns a pointer to GC_finalizer_nested.                */
 945   STATIC unsigned char *GC_check_finalizer_nested(void)
 946   {
 947     unsigned nesting_level = *(unsigned char *)&GC_finalizer_nested;
 948     if (nesting_level) {
 949       /* We are inside another GC_invoke_finalizers().          */
 950       /* Skip some implicitly-called GC_invoke_finalizers()     */
 951       /* depending on the nesting (recursion) level.            */
 952       if (++GC_finalizer_skipped < (1U << nesting_level)) return NULL;
 953       GC_finalizer_skipped = 0;
 954     }
 955     *(char *)&GC_finalizer_nested = (char)(nesting_level + 1);
 956     return (unsigned char *)&GC_finalizer_nested;
 957   }
 958 #endif /* THREADS */
 959
 960 GC_INLINE void GC_make_disappearing_links_disappear(
 961                                         struct dl_hashtbl_s* dl_hashtbl,
 962                                         GC_bool is_remove_dangling)
 963 {
 964   size_t i;
 965   size_t dl_size = dl_hashtbl->log_size == -1 ? 0
 966                         : (size_t)1 << dl_hashtbl->log_size;
 967   GC_bool needs_barrier = FALSE;
 968
 969   GC_ASSERT(I_HOLD_LOCK());
 970   for (i = 0; i < dl_size; i++) {
 971     struct disappearing_link *curr_dl, *next_dl;
 972     struct disappearing_link *prev_dl = NULL;
 973
 974     for (curr_dl = dl_hashtbl->head[i]; curr_dl != NULL; curr_dl = next_dl) {
 975       next_dl = dl_next(curr_dl);
 976       if (is_remove_dangling) {
 977         ptr_t real_link = (ptr_t)GC_base(GC_REVEAL_POINTER(
 978                                                 curr_dl->dl_hidden_link));
 979
 980         if (NULL == real_link || EXPECT(GC_is_marked(real_link), TRUE)) {
 981           prev_dl = curr_dl;
 982           continue;
 983         }
 984       } else {
 985         if (EXPECT(GC_is_marked((ptr_t)GC_REVEAL_POINTER(
 986                                         curr_dl->dl_hidden_obj)), TRUE)) {
 987           prev_dl = curr_dl;
 988           continue;
 989         }
 990         *(ptr_t *)GC_REVEAL_POINTER(curr_dl->dl_hidden_link) = NULL;
 991       }
 992
 993       /* Delete curr_dl entry from dl_hashtbl.  */
 994       if (NULL == prev_dl) {
 995         dl_hashtbl -> head[i] = next_dl;
 996         needs_barrier = TRUE;
 997       } else {
 998         dl_set_next(prev_dl, next_dl);
 999         GC_dirty(prev_dl);
1000       }
1001       GC_clear_mark_bit(curr_dl);
1002       dl_hashtbl -> entries--;
1003     }
1004   }
1005   if (needs_barrier)
1006     GC_dirty(dl_hashtbl -> head); /* entire object */
1007 }
1008
1009 /* Called with held lock (but the world is running).                    */
1010 /* Cause disappearing links to disappear and unreachable objects to be  */
1011 /* enqueued for finalization.                                           */
1012 GC_INNER void GC_finalize(void)
1013 {
1014     struct finalizable_object * curr_fo, * prev_fo, * next_fo;
1015     ptr_t real_ptr;
1016     size_t i;
1017     size_t fo_size = log_fo_table_size == -1 ? 0 :
1018                                 (size_t)1 << log_fo_table_size;
1019     GC_bool needs_barrier = FALSE;
1020
1021     GC_ASSERT(I_HOLD_LOCK());
1022 #   ifndef SMALL_CONFIG
1023       /* Save current GC_[dl/ll]_entries value for stats printing */
1024       GC_old_dl_entries = GC_dl_hashtbl.entries;
1025 #     ifndef GC_LONG_REFS_NOT_NEEDED
1026         GC_old_ll_entries = GC_ll_hashtbl.entries;
1027 #     endif
1028 #   endif
1029
1030 #   ifndef GC_TOGGLE_REFS_NOT_NEEDED
1031       GC_mark_togglerefs();
1032 #   endif
1033     GC_make_disappearing_links_disappear(&GC_dl_hashtbl, FALSE);
1034
1035   /* Mark all objects reachable via chains of 1 or more pointers        */
1036   /* from finalizable objects.                                          */
1037     GC_ASSERT(GC_mark_state == MS_NONE);
1038     for (i = 0; i < fo_size; i++) {
1039       for (curr_fo = GC_fnlz_roots.fo_head[i];
1040            curr_fo != NULL; curr_fo = fo_next(curr_fo)) {
1041         GC_ASSERT(GC_size(curr_fo) >= sizeof(struct finalizable_object));
1042         real_ptr = (ptr_t)GC_REVEAL_POINTER(curr_fo->fo_hidden_base);
1043         if (!GC_is_marked(real_ptr)) {
1044             GC_MARKED_FOR_FINALIZATION(real_ptr);
1045             GC_MARK_FO(real_ptr, curr_fo -> fo_mark_proc);
1046             if (GC_is_marked(real_ptr)) {
1047                 WARN("Finalization cycle involving %p\n", real_ptr);
1048             }
1049         }
1050       }
1051     }
1052   /* Enqueue for finalization all objects that are still                */
1053   /* unreachable.                                                       */
1054     GC_bytes_finalized = 0;
1055     for (i = 0; i < fo_size; i++) {
1056       curr_fo = GC_fnlz_roots.fo_head[i];
1057       prev_fo = 0;
1058       while (curr_fo != 0) {
1059         real_ptr = (ptr_t)GC_REVEAL_POINTER(curr_fo->fo_hidden_base);
1060         if (!GC_is_marked(real_ptr)) {
1061             if (!GC_java_finalization) {
1062               GC_set_mark_bit(real_ptr);
1063             }
1064             /* Delete from hash table */
1065               next_fo = fo_next(curr_fo);
1066               if (NULL == prev_fo) {
1067                 GC_fnlz_roots.fo_head[i] = next_fo;
1068                 if (GC_object_finalized_proc) {
1069                   GC_dirty(GC_fnlz_roots.fo_head + i);
1070                 } else {
1071                   needs_barrier = TRUE;
1072                 }
1073               } else {
1074                 fo_set_next(prev_fo, next_fo);
1075                 GC_dirty(prev_fo);
1076               }
1077               GC_fo_entries--;
1078               if (GC_object_finalized_proc)
1079                 GC_object_finalized_proc(real_ptr);
1080
1081             /* Add to list of objects awaiting finalization.    */
1082               fo_set_next(curr_fo, GC_fnlz_roots.finalize_now);
1083               GC_dirty(curr_fo);
1084               SET_FINALIZE_NOW(curr_fo);
1085               /* unhide object pointer so any future collections will   */
1086               /* see it.                                                */
1087               curr_fo -> fo_hidden_base =
1088                         (word)GC_REVEAL_POINTER(curr_fo -> fo_hidden_base);
1089               GC_bytes_finalized +=
1090                         curr_fo -> fo_object_size
1091                         + sizeof(struct finalizable_object);
1092             GC_ASSERT(GC_is_marked(GC_base(curr_fo)));
1093             curr_fo = next_fo;
1094         } else {
1095             prev_fo = curr_fo;
1096             curr_fo = fo_next(curr_fo);
1097         }
1098       }
1099     }
1100
1101   if (GC_java_finalization) {
1102     /* make sure we mark everything reachable from objects finalized
1103        using the no_order mark_proc */
1104       for (curr_fo = GC_fnlz_roots.finalize_now;
1105            curr_fo != NULL; curr_fo = fo_next(curr_fo)) {
1106         real_ptr = (ptr_t)curr_fo -> fo_hidden_base;
1107         if (!GC_is_marked(real_ptr)) {
1108             if (curr_fo -> fo_mark_proc == GC_null_finalize_mark_proc) {
1109                 GC_MARK_FO(real_ptr, GC_normal_finalize_mark_proc);
1110             }
1111             if (curr_fo -> fo_mark_proc != GC_unreachable_finalize_mark_proc) {
1112                 GC_set_mark_bit(real_ptr);
1113             }
1114         }
1115       }
1116
1117     /* now revive finalize-when-unreachable objects reachable from
1118        other finalizable objects */
1119       if (need_unreachable_finalization) {
1120         curr_fo = GC_fnlz_roots.finalize_now;
1121 #       if defined(GC_ASSERTIONS) || defined(LINT2)
1122           if (curr_fo != NULL && log_fo_table_size < 0)
1123             ABORT("log_size is negative");
1124 #       endif
1125         prev_fo = NULL;
1126         while (curr_fo != NULL) {
1127           next_fo = fo_next(curr_fo);
1128           if (curr_fo -> fo_mark_proc == GC_unreachable_finalize_mark_proc) {
1129             real_ptr = (ptr_t)curr_fo -> fo_hidden_base;
1130             if (!GC_is_marked(real_ptr)) {
1131               GC_set_mark_bit(real_ptr);
1132             } else {
1133               if (NULL == prev_fo) {
1134                 SET_FINALIZE_NOW(next_fo);
1135               } else {
1136                 fo_set_next(prev_fo, next_fo);
1137                 GC_dirty(prev_fo);
1138               }
1139               curr_fo -> fo_hidden_base =
1140                                 GC_HIDE_POINTER(curr_fo -> fo_hidden_base);
1141               GC_bytes_finalized -=
1142                   curr_fo->fo_object_size + sizeof(struct finalizable_object);
1143
1144               i = HASH2(real_ptr, log_fo_table_size);
1145               fo_set_next(curr_fo, GC_fnlz_roots.fo_head[i]);
1146               GC_dirty(curr_fo);
1147               GC_fo_entries++;
1148               GC_fnlz_roots.fo_head[i] = curr_fo;
1149               curr_fo = prev_fo;
1150               needs_barrier = TRUE;
1151             }
1152           }
1153           prev_fo = curr_fo;
1154           curr_fo = next_fo;
1155         }
1156       }
1157   }
1158   if (needs_barrier)
1159     GC_dirty(GC_fnlz_roots.fo_head); /* entire object */
1160
1161   /* Remove dangling disappearing links. */
1162   GC_make_disappearing_links_disappear(&GC_dl_hashtbl, TRUE);
1163
1164 # ifndef GC_TOGGLE_REFS_NOT_NEEDED
1165     GC_clear_togglerefs();
1166 # endif
1167 # ifndef GC_LONG_REFS_NOT_NEEDED
1168     GC_make_disappearing_links_disappear(&GC_ll_hashtbl, FALSE);
1169     GC_make_disappearing_links_disappear(&GC_ll_hashtbl, TRUE);
1170 # endif
1171
1172   if (GC_fail_count) {
1173     /* Don't prevent running finalizers if there has been an allocation */
1174     /* failure recently.                                                */
1175 #   ifdef THREADS
1176       GC_reset_finalizer_nested();
1177 #   else
1178       GC_finalizer_nested = 0;
1179 #   endif
1180   }
1181 }
1182
1183 #ifndef JAVA_FINALIZATION_NOT_NEEDED
1184
1185   /* Enqueue all remaining finalizers to be run.        */
1186   STATIC void GC_enqueue_all_finalizers(void)
1187   {
1188     struct finalizable_object * next_fo;
1189     int i;
1190     int fo_size;
1191
1192     GC_ASSERT(I_HOLD_LOCK());
1193     fo_size = log_fo_table_size == -1 ? 0 : 1 << log_fo_table_size;
1194     GC_bytes_finalized = 0;
1195     for (i = 0; i < fo_size; i++) {
1196       struct finalizable_object * curr_fo = GC_fnlz_roots.fo_head[i];
1197
1198       GC_fnlz_roots.fo_head[i] = NULL;
1199       while (curr_fo != NULL) {
1200           ptr_t real_ptr = (ptr_t)GC_REVEAL_POINTER(curr_fo->fo_hidden_base);
1201
1202           GC_MARK_FO(real_ptr, GC_normal_finalize_mark_proc);
1203           GC_set_mark_bit(real_ptr);
1204
1205           next_fo = fo_next(curr_fo);
1206
1207           /* Add to list of objects awaiting finalization.      */
1208           fo_set_next(curr_fo, GC_fnlz_roots.finalize_now);
1209           GC_dirty(curr_fo);
1210           SET_FINALIZE_NOW(curr_fo);
1211
1212           /* unhide object pointer so any future collections will       */
1213           /* see it.                                                    */
1214           curr_fo -> fo_hidden_base =
1215                         (word)GC_REVEAL_POINTER(curr_fo -> fo_hidden_base);
1216           GC_bytes_finalized +=
1217                 curr_fo -> fo_object_size + sizeof(struct finalizable_object);
1218           curr_fo = next_fo;
1219       }
1220     }
1221     GC_fo_entries = 0;  /* all entries deleted from the hash table */
1222   }
1223
1224   /* Invoke all remaining finalizers that haven't yet been run.
1225    * This is needed for strict compliance with the Java standard,
1226    * which can make the runtime guarantee that all finalizers are run.
1227    * Unfortunately, the Java standard implies we have to keep running
1228    * finalizers until there are no more left, a potential infinite loop.
1229    * YUCK.
1230    * Note that this is even more dangerous than the usual Java
1231    * finalizers, in that objects reachable from static variables
1232    * may have been finalized when these finalizers are run.
1233    * Finalizers run at this point must be prepared to deal with a
1234    * mostly broken world.
1235    * This routine is externally callable, so is called without
1236    * the allocation lock.
1237    */
1238   GC_API void GC_CALL GC_finalize_all(void)
1239   {
1240     DCL_LOCK_STATE;
1241
1242     LOCK();
1243     while (GC_fo_entries > 0) {
1244       GC_enqueue_all_finalizers();
1245       UNLOCK();
1246       GC_invoke_finalizers();
1247       /* Running the finalizers in this thread is arguably not a good   */
1248       /* idea when we should be notifying another thread to run them.   */
1249       /* But otherwise we don't have a great way to wait for them to    */
1250       /* run.                                                           */
1251       LOCK();
1252     }
1253     UNLOCK();
1254   }
1255
1256 #endif /* !JAVA_FINALIZATION_NOT_NEEDED */
1257
1258 /* Returns true if it is worth calling GC_invoke_finalizers. (Useful if */
1259 /* finalizers can only be called from some kind of "safe state" and     */
1260 /* getting into that safe state is expensive.)                          */
1261 GC_API int GC_CALL GC_should_invoke_finalizers(void)
1262 {
1263 # ifdef AO_HAVE_load
1264     return AO_load((volatile AO_t *)&GC_fnlz_roots.finalize_now) != 0;
1265 # else
1266     return GC_fnlz_roots.finalize_now != NULL;
1267 # endif /* !THREADS */
1268 }
1269
1270 /* Invoke finalizers for all objects that are ready to be finalized.    */
1271 /* Should be called without allocation lock.                            */
1272 GC_API int GC_CALL GC_invoke_finalizers(void)
1273 {
1274     int count = 0;
1275     word bytes_freed_before = 0; /* initialized to prevent warning. */
1276     DCL_LOCK_STATE;
1277
1278     while (GC_should_invoke_finalizers()) {
1279         struct finalizable_object * curr_fo;
1280
1281 #       ifdef THREADS
1282             LOCK();
1283 #       endif
1284         if (count == 0) {
1285             bytes_freed_before = GC_bytes_freed;
1286             /* Don't do this outside, since we need the lock. */
1287         }
1288         curr_fo = GC_fnlz_roots.finalize_now;
1289 #       ifdef THREADS
1290             if (curr_fo != NULL)
1291                 SET_FINALIZE_NOW(fo_next(curr_fo));
1292             UNLOCK();
1293             if (curr_fo == 0) break;
1294 #       else
1295             GC_fnlz_roots.finalize_now = fo_next(curr_fo);
1296 #       endif
1297         fo_set_next(curr_fo, 0);
1298         (*(curr_fo -> fo_fn))((ptr_t)(curr_fo -> fo_hidden_base),
1299                               curr_fo -> fo_client_data);
1300         curr_fo -> fo_client_data = 0;
1301         ++count;
1302         /* Explicit freeing of curr_fo is probably a bad idea.  */
1303         /* It throws off accounting if nearly all objects are   */
1304         /* finalizable.  Otherwise it should not matter.        */
1305     }
1306     /* bytes_freed_before is initialized whenever count != 0 */
1307     if (count != 0
1308 #         if defined(THREADS) && !defined(THREAD_SANITIZER)
1309             /* A quick check whether some memory was freed.     */
1310             /* The race with GC_free() is safe to be ignored    */
1311             /* because we only need to know if the current      */
1312             /* thread has deallocated something.                */
1313             && bytes_freed_before != GC_bytes_freed
1314 #         endif
1315        ) {
1316         LOCK();
1317         GC_finalizer_bytes_freed += (GC_bytes_freed - bytes_freed_before);
1318         UNLOCK();
1319     }
1320     return count;
1321 }
1322
1323 static word last_finalizer_notification = 0;
1324
1325 GC_INNER void GC_notify_or_invoke_finalizers(void)
1326 {
1327     GC_finalizer_notifier_proc notifier_fn = 0;
1328 #   if defined(KEEP_BACK_PTRS) || defined(MAKE_BACK_GRAPH)
1329       static word last_back_trace_gc_no = 1;    /* Skip first one. */
1330 #   endif
1331     DCL_LOCK_STATE;
1332
1333 #   if defined(THREADS) && !defined(KEEP_BACK_PTRS) \
1334        && !defined(MAKE_BACK_GRAPH)
1335       /* Quick check (while unlocked) for an empty finalization queue.  */
1336       if (!GC_should_invoke_finalizers())
1337         return;
1338 #   endif
1339     LOCK();
1340
1341     /* This is a convenient place to generate backtraces if appropriate, */
1342     /* since that code is not callable with the allocation lock.         */
1343 #   if defined(KEEP_BACK_PTRS) || defined(MAKE_BACK_GRAPH)
1344       if (GC_gc_no > last_back_trace_gc_no) {
1345 #       ifdef KEEP_BACK_PTRS
1346           long i;
1347           /* Stops when GC_gc_no wraps; that's OK.      */
1348           last_back_trace_gc_no = GC_WORD_MAX;  /* disable others. */
1349           for (i = 0; i < GC_backtraces; ++i) {
1350               /* FIXME: This tolerates concurrent heap mutation,        */
1351               /* which may cause occasional mysterious results.         */
1352               /* We need to release the GC lock, since GC_print_callers */
1353               /* acquires it.  It probably shouldn't.                   */
1354               UNLOCK();
1355               GC_generate_random_backtrace_no_gc();
1356               LOCK();
1357           }
1358           last_back_trace_gc_no = GC_gc_no;
1359 #       endif
1360 #       ifdef MAKE_BACK_GRAPH
1361           if (GC_print_back_height) {
1362             GC_print_back_graph_stats();
1363           }
1364 #       endif
1365       }
1366 #   endif
1367     if (NULL == GC_fnlz_roots.finalize_now) {
1368       UNLOCK();
1369       return;
1370     }
1371
1372     if (!GC_finalize_on_demand) {
1373       unsigned char *pnested = GC_check_finalizer_nested();
1374       UNLOCK();
1375       /* Skip GC_invoke_finalizers() if nested */
1376       if (pnested != NULL) {
1377         (void) GC_invoke_finalizers();
1378         *pnested = 0; /* Reset since no more finalizers. */
1379 #       ifndef THREADS
1380           GC_ASSERT(NULL == GC_fnlz_roots.finalize_now);
1381 #       endif   /* Otherwise GC can run concurrently and add more */
1382       }
1383       return;
1384     }
1385
1386     /* These variables require synchronization to avoid data races.     */
1387     if (last_finalizer_notification != GC_gc_no) {
1388         notifier_fn = GC_finalizer_notifier;
1389         last_finalizer_notification = GC_gc_no;
1390     }
1391     UNLOCK();
1392     if (notifier_fn != 0)
1393         (*notifier_fn)(); /* Invoke the notifier */
1394 }
1395
1396 #ifndef SMALL_CONFIG
1397 # ifndef GC_LONG_REFS_NOT_NEEDED
1398 #   define IF_LONG_REFS_PRESENT_ELSE(x,y) (x)
1399 # else
1400 #   define IF_LONG_REFS_PRESENT_ELSE(x,y) (y)
1401 # endif
1402
1403   GC_INNER void GC_print_finalization_stats(void)
1404   {
1405     struct finalizable_object *fo;
1406     unsigned long ready = 0;
1407
1408     GC_log_printf("%lu finalization entries;"
1409                   " %lu/%lu short/long disappearing links alive\n",
1410                   (unsigned long)GC_fo_entries,
1411                   (unsigned long)GC_dl_hashtbl.entries,
1412                   (unsigned long)IF_LONG_REFS_PRESENT_ELSE(
1413                                                 GC_ll_hashtbl.entries, 0));
1414
1415     for (fo = GC_fnlz_roots.finalize_now; fo != NULL; fo = fo_next(fo))
1416       ++ready;
1417     GC_log_printf("%lu finalization-ready objects;"
1418                   " %ld/%ld short/long links cleared\n",
1419                   ready,
1420                   (long)GC_old_dl_entries - (long)GC_dl_hashtbl.entries,
1421                   (long)IF_LONG_REFS_PRESENT_ELSE(
1422                               GC_old_ll_entries - GC_ll_hashtbl.entries, 0));
1423   }
1424 #endif /* !SMALL_CONFIG */
1425
1426 #endif /* !GC_NO_FINALIZATION */