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