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