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