libgc/alloc.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) 1998 by Silicon Graphics.  All rights reserved.
   5  * Copyright (c) 1999 by Hewlett-Packard Company. All rights reserved.
   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
  18
  19 # include "private/gc_priv.h"
  20
  21 # include <stdio.h>
  22 # if !defined(MACOS) && !defined(MSWINCE)
  23 #   include <signal.h>
  24 #   include <sys/types.h>
  25 # endif
  26
  27 /*
  28  * Separate free lists are maintained for different sized objects
  29  * up to MAXOBJSZ.
  30  * The call GC_allocobj(i,k) ensures that the freelist for
  31  * kind k objects of size i points to a non-empty
  32  * free list. It returns a pointer to the first entry on the free list.
  33  * In a single-threaded world, GC_allocobj may be called to allocate
  34  * an object of (small) size i as follows:
  35  *
  36  *            opp = &(GC_objfreelist[i]);
  37  *            if (*opp == 0) GC_allocobj(i, NORMAL);
  38  *            ptr = *opp;
  39  *            *opp = obj_link(ptr);
  40  *
  41  * Note that this is very fast if the free list is non-empty; it should
  42  * only involve the execution of 4 or 5 simple instructions.
  43  * All composite objects on freelists are cleared, except for
  44  * their first word.
  45  */
  46
  47 /*
  48  *  The allocator uses GC_allochblk to allocate large chunks of objects.
  49  * These chunks all start on addresses which are multiples of
  50  * HBLKSZ.   Each allocated chunk has an associated header,
  51  * which can be located quickly based on the address of the chunk.
  52  * (See headers.c for details.)
  53  * This makes it possible to check quickly whether an
  54  * arbitrary address corresponds to an object administered by the
  55  * allocator.
  56  */
  57
  58 word GC_non_gc_bytes = 0;  /* Number of bytes not intended to be collected */
  59
  60 word GC_gc_no = 0;
  61
  62 #ifndef SMALL_CONFIG
  63   int GC_incremental = 0;  /* By default, stop the world.       */
  64 #endif
  65
  66 int GC_parallel = FALSE;   /* By default, parallel GC is off.   */
  67
  68 int GC_full_freq = 19;     /* Every 20th collection is a full   */
  69                            /* collection, whether we need it    */
  70                            /* or not.                           */
  71
  72 GC_bool GC_need_full_gc = FALSE;
  73                            /* Need full GC do to heap growth.   */
  74
  75 #ifdef THREADS
  76   GC_bool GC_world_stopped = FALSE;
  77 # define IF_THREADS(x) x
  78 #else
  79 # define IF_THREADS(x)
  80 #endif
  81
  82 word GC_used_heap_size_after_full = 0;
  83
  84 char * GC_copyright[] =
  85 {"Copyright 1988,1989 Hans-J. Boehm and Alan J. Demers ",
  86 "Copyright (c) 1991-1995 by Xerox Corporation.  All rights reserved. ",
  87 "Copyright (c) 1996-1998 by Silicon Graphics.  All rights reserved. ",
  88 "Copyright (c) 1999-2001 by Hewlett-Packard Company.  All rights reserved. ",
  89 "THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY",
  90 " EXPRESSED OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.",
  91 "See source code for details." };
  92
  93 # include "version.h"
  94
  95 #if defined(SAVE_CALL_CHAIN) && \
  96         !(defined(REDIRECT_MALLOC) && defined(GC_HAVE_BUILTIN_BACKTRACE))
  97 #   define SAVE_CALL_CHAIN_IN_GC
  98     /* This is only safe if the call chain save mechanism won't end up  */
  99     /* calling GC_malloc.  The GNU C library documentation suggests     */
 100     /* that backtrace doesn't use malloc, but at least the initial      */
 101     /* call in some versions does seem to invoke the dynamic linker,    */
 102     /* which uses malloc.                                               */
 103 #endif
 104
 105 /* some more variables */
 106
 107 extern signed_word GC_mem_found;  /* Number of reclaimed longwords      */
 108                                   /* after garbage collection           */
 109
 110 GC_bool GC_dont_expand = 0;
 111
 112 word GC_free_space_divisor = 3;
 113
 114 extern GC_bool GC_collection_in_progress();
 115                 /* Collection is in progress, or was abandoned. */
 116
 117 int GC_never_stop_func GC_PROTO((void)) { return(0); }
 118
 119 unsigned long GC_time_limit = TIME_LIMIT;
 120
 121 CLOCK_TYPE GC_start_time;       /* Time at which we stopped world.      */
 122                                 /* used only in GC_timeout_stop_func.   */
 123
 124 int GC_n_attempts = 0;          /* Number of attempts at finishing      */
 125                                 /* collection within GC_time_limit.     */
 126
 127 #if defined(SMALL_CONFIG) || defined(NO_CLOCK)
 128 #   define GC_timeout_stop_func GC_never_stop_func
 129 #else
 130   int GC_timeout_stop_func GC_PROTO((void))
 131   {
 132     CLOCK_TYPE current_time;
 133     static unsigned count = 0;
 134     unsigned long time_diff;
 135
 136     if ((count++ & 3) != 0) return(0);
 137     GET_TIME(current_time);
 138     time_diff = MS_TIME_DIFF(current_time,GC_start_time);
 139     if (time_diff >= GC_time_limit) {
 140 #       ifdef CONDPRINT
 141           if (GC_print_stats) {
 142             GC_printf0("Abandoning stopped marking after ");
 143             GC_printf1("%lu msecs", (unsigned long)time_diff);
 144             GC_printf1("(attempt %ld)\n", (unsigned long) GC_n_attempts);
 145           }
 146 #       endif
 147         return(1);
 148     }
 149     return(0);
 150   }
 151 #endif /* !SMALL_CONFIG */
 152
 153 /* Return the minimum number of words that must be allocated between    */
 154 /* collections to amortize the collection cost.                         */
 155 static word min_words_allocd()
 156 {
 157 #   ifdef THREADS
 158         /* We punt, for now. */
 159         register signed_word stack_size = 10000;
 160 #   else
 161         int dummy;
 162         register signed_word stack_size = (ptr_t)(&dummy) - GC_stackbottom;
 163 #   endif
 164     word total_root_size;           /* includes double stack size,      */
 165                                     /* since the stack is expensive     */
 166                                     /* to scan.                         */
 167     word scan_size;             /* Estimate of memory to be scanned     */
 168                                 /* during normal GC.                    */
 169
 170     if (stack_size < 0) stack_size = -stack_size;
 171     total_root_size = 2 * stack_size + GC_root_size;
 172     scan_size = BYTES_TO_WORDS(GC_heapsize - GC_large_free_bytes
 173                                + (GC_large_free_bytes >> 2)
 174                                    /* use a bit more of large empty heap */
 175                                + total_root_size);
 176     if (TRUE_INCREMENTAL) {
 177         return scan_size / (2 * GC_free_space_divisor);
 178     } else {
 179         return scan_size / GC_free_space_divisor;
 180     }
 181 }
 182
 183 /* Return the number of words allocated, adjusted for explicit storage  */
 184 /* management, etc..  This number is used in deciding when to trigger   */
 185 /* collections.                                                         */
 186 word GC_adj_words_allocd()
 187 {
 188     register signed_word result;
 189     register signed_word expl_managed =
 190                 BYTES_TO_WORDS((long)GC_non_gc_bytes
 191                                 - (long)GC_non_gc_bytes_at_gc);
 192
 193     /* Don't count what was explicitly freed, or newly allocated for    */
 194     /* explicit management.  Note that deallocating an explicitly       */
 195     /* managed object should not alter result, assuming the client      */
 196     /* is playing by the rules.                                         */
 197     result = (signed_word)GC_words_allocd
 198              - (signed_word)GC_mem_freed
 199              + (signed_word)GC_finalizer_mem_freed - expl_managed;
 200     if (result > (signed_word)GC_words_allocd) {
 201         result = GC_words_allocd;
 202         /* probably client bug or unfortunate scheduling */
 203     }
 204     result += GC_words_finalized;
 205         /* We count objects enqueued for finalization as though they    */
 206         /* had been reallocated this round. Finalization is user        */
 207         /* visible progress.  And if we don't count this, we have       */
 208         /* stability problems for programs that finalize all objects.   */
 209     if ((GC_words_wasted >> 3) < result)
 210         result += GC_words_wasted;
 211         /* This doesn't reflect useful work.  But if there is lots of   */
 212         /* new fragmentation, the same is probably true of the heap,    */
 213         /* and the collection will be correspondingly cheaper.          */
 214     if (result < (signed_word)(GC_words_allocd >> 3)) {
 215         /* Always count at least 1/8 of the allocations.  We don't want */
 216         /* to collect too infrequently, since that would inhibit        */
 217         /* coalescing of free storage blocks.                           */
 218         /* This also makes us partially robust against client bugs.     */
 219         return(GC_words_allocd >> 3);
 220     } else {
 221         return(result);
 222     }
 223 }
 224
 225
 226 /* Clear up a few frames worth of garbage left at the top of the stack. */
 227 /* This is used to prevent us from accidentally treating garbade left   */
 228 /* on the stack by other parts of the collector as roots.  This         */
 229 /* differs from the code in misc.c, which actually tries to keep the    */
 230 /* stack clear of long-lived, client-generated garbage.                 */
 231 void GC_clear_a_few_frames()
 232 {
 233 #   define NWORDS 64
 234     word frames[NWORDS];
 235     /* Some compilers will warn that frames was set but never used.     */
 236     /* That's the whole idea ...                                        */
 237     register int i;
 238
 239     for (i = 0; i < NWORDS; i++) frames[i] = 0;
 240 }
 241
 242 /* Heap size at which we need a collection to avoid expanding past      */
 243 /* limits used by blacklisting.                                         */
 244 static word GC_collect_at_heapsize = (word)(-1);
 245
 246 /* Have we allocated enough to amortize a collection? */
 247 GC_bool GC_should_collect()
 248 {
 249     return(GC_adj_words_allocd() >= min_words_allocd()
 250            || GC_heapsize >= GC_collect_at_heapsize);
 251 }
 252
 253
 254 void GC_notify_full_gc()
 255 {
 256     if (GC_start_call_back != (void (*) GC_PROTO((void)))0) {
 257         (*GC_start_call_back)();
 258     }
 259 }
 260
 261 GC_bool GC_is_full_gc = FALSE;
 262
 263 /*
 264  * Initiate a garbage collection if appropriate.
 265  * Choose judiciously
 266  * between partial, full, and stop-world collections.
 267  * Assumes lock held, signals disabled.
 268  */
 269 void GC_maybe_gc()
 270 {
 271     static int n_partial_gcs = 0;
 272
 273     if (GC_should_collect()) {
 274         if (!GC_incremental) {
 275             GC_gcollect_inner();
 276             n_partial_gcs = 0;
 277             return;
 278         } else {
 279 #         ifdef PARALLEL_MARK
 280             GC_wait_for_reclaim();
 281 #         endif
 282           if (GC_need_full_gc || n_partial_gcs >= GC_full_freq) {
 283 #           ifdef CONDPRINT
 284               if (GC_print_stats) {
 285                 GC_printf2(
 286                   "***>Full mark for collection %lu after %ld allocd bytes\n",
 287                   (unsigned long) GC_gc_no+1,
 288                   (long)WORDS_TO_BYTES(GC_words_allocd));
 289               }
 290 #           endif
 291             GC_promote_black_lists();
 292             (void)GC_reclaim_all((GC_stop_func)0, TRUE);
 293             GC_clear_marks();
 294             n_partial_gcs = 0;
 295             GC_notify_full_gc();
 296             GC_is_full_gc = TRUE;
 297           } else {
 298             n_partial_gcs++;
 299           }
 300         }
 301         /* We try to mark with the world stopped.       */
 302         /* If we run out of time, this turns into       */
 303         /* incremental marking.                 */
 304 #       ifndef NO_CLOCK
 305           if (GC_time_limit != GC_TIME_UNLIMITED) { GET_TIME(GC_start_time); }
 306 #       endif
 307         if (GC_stopped_mark(GC_time_limit == GC_TIME_UNLIMITED?
 308                             GC_never_stop_func : GC_timeout_stop_func)) {
 309 #           ifdef SAVE_CALL_CHAIN_IN_GC
 310                 GC_save_callers(GC_last_stack);
 311 #           endif
 312             GC_finish_collection();
 313         } else {
 314             if (!GC_is_full_gc) {
 315                 /* Count this as the first attempt */
 316                 GC_n_attempts++;
 317             }
 318         }
 319     }
 320 }
 321
 322
 323 /*
 324  * Stop the world garbage collection.  Assumes lock held, signals disabled.
 325  * If stop_func is not GC_never_stop_func, then abort if stop_func returns TRUE.
 326  * Return TRUE if we successfully completed the collection.
 327  */
 328 GC_bool GC_try_to_collect_inner(stop_func)
 329 GC_stop_func stop_func;
 330 {
 331 #   ifdef CONDPRINT
 332         CLOCK_TYPE start_time, current_time;
 333 #   endif
 334     if (GC_dont_gc) return FALSE;
 335
 336     if (GC_notify_event)
 337         GC_notify_event (GC_EVENT_START);
 338
 339     if (GC_incremental && GC_collection_in_progress()) {
 340 #   ifdef CONDPRINT
 341       if (GC_print_stats) {
 342         GC_printf0(
 343             "GC_try_to_collect_inner: finishing collection in progress\n");
 344       }
 345 #   endif /* CONDPRINT */
 346       /* Just finish collection already in progress.    */
 347         while(GC_collection_in_progress()) {
 348             if (stop_func()) return(FALSE);
 349             GC_collect_a_little_inner(1);
 350         }
 351     }
 352     if (stop_func == GC_never_stop_func) GC_notify_full_gc();
 353 #   ifdef CONDPRINT
 354       if (GC_print_stats) {
 355         if (GC_print_stats) GET_TIME(start_time);
 356         GC_printf2(
 357            "Initiating full world-stop collection %lu after %ld allocd bytes\n",
 358            (unsigned long) GC_gc_no+1,
 359            (long)WORDS_TO_BYTES(GC_words_allocd));
 360       }
 361 #   endif
 362     GC_promote_black_lists();
 363     /* Make sure all blocks have been reclaimed, so sweep routines      */
 364     /* don't see cleared mark bits.                                     */
 365     /* If we're guaranteed to finish, then this is unnecessary.         */
 366     /* In the find_leak case, we have to finish to guarantee that       */
 367     /* previously unmarked objects are not reported as leaks.           */
 368 #       ifdef PARALLEL_MARK
 369             GC_wait_for_reclaim();
 370 #       endif
 371         if ((GC_find_leak || stop_func != GC_never_stop_func)
 372             && !GC_reclaim_all(stop_func, FALSE)) {
 373             /* Aborted.  So far everything is still consistent. */
 374             return(FALSE);
 375         }
 376     GC_invalidate_mark_state();  /* Flush mark stack.   */
 377     GC_clear_marks();
 378 #   ifdef SAVE_CALL_CHAIN_IN_GC
 379         GC_save_callers(GC_last_stack);
 380 #   endif
 381     GC_is_full_gc = TRUE;
 382     if (!GC_stopped_mark(stop_func)) {
 383       if (!GC_incremental) {
 384         /* We're partially done and have no way to complete or use      */
 385         /* current work.  Reestablish invariants as cheaply as          */
 386         /* possible.                                                    */
 387         GC_invalidate_mark_state();
 388         GC_unpromote_black_lists();
 389       } /* else we claim the world is already still consistent.  We'll  */
 390         /* finish incrementally.                                        */
 391       return(FALSE);
 392     }
 393     GC_finish_collection();
 394 #   if defined(CONDPRINT)
 395       if (GC_print_stats) {
 396         GET_TIME(current_time);
 397         GC_printf1("Complete collection took %lu msecs\n",
 398                    MS_TIME_DIFF(current_time,start_time));
 399       }
 400 #   endif
 401     if (GC_notify_event)
 402         GC_notify_event (GC_EVENT_END);
 403
 404     return(TRUE);
 405 }
 406
 407
 408
 409 /*
 410  * Perform n units of garbage collection work.  A unit is intended to touch
 411  * roughly GC_RATE pages.  Every once in a while, we do more than that.
 412  * This needa to be a fairly large number with our current incremental
 413  * GC strategy, since otherwise we allocate too much during GC, and the
 414  * cleanup gets expensive.
 415  */
 416 # define GC_RATE 10
 417 # define MAX_PRIOR_ATTEMPTS 1
 418         /* Maximum number of prior attempts at world stop marking       */
 419         /* A value of 1 means that we finish the second time, no matter */
 420         /* how long it takes.  Doesn't count the initial root scan      */
 421         /* for a full GC.                                               */
 422
 423 int GC_deficit = 0;     /* The number of extra calls to GC_mark_some    */
 424                         /* that we have made.                           */
 425
 426 void GC_collect_a_little_inner(n)
 427 int n;
 428 {
 429     register int i;
 430
 431     if (GC_dont_gc) return;
 432     if (GC_incremental && GC_collection_in_progress()) {
 433         for (i = GC_deficit; i < GC_RATE*n; i++) {
 434             if (GC_mark_some((ptr_t)0)) {
 435                 /* Need to finish a collection */
 436 #               ifdef SAVE_CALL_CHAIN_IN_GC
 437                     GC_save_callers(GC_last_stack);
 438 #               endif
 439 #               ifdef PARALLEL_MARK
 440                     GC_wait_for_reclaim();
 441 #               endif
 442                 if (GC_n_attempts < MAX_PRIOR_ATTEMPTS
 443                     && GC_time_limit != GC_TIME_UNLIMITED) {
 444                   GET_TIME(GC_start_time);
 445                   if (!GC_stopped_mark(GC_timeout_stop_func)) {
 446                     GC_n_attempts++;
 447                     break;
 448                   }
 449                 } else {
 450                   (void)GC_stopped_mark(GC_never_stop_func);
 451                 }
 452                 GC_finish_collection();
 453                 break;
 454             }
 455         }
 456         if (GC_deficit > 0) GC_deficit -= GC_RATE*n;
 457         if (GC_deficit < 0) GC_deficit = 0;
 458     } else {
 459         GC_maybe_gc();
 460     }
 461 }
 462
 463 int GC_collect_a_little GC_PROTO(())
 464 {
 465     int result;
 466     DCL_LOCK_STATE;
 467
 468     DISABLE_SIGNALS();
 469     LOCK();
 470     GC_collect_a_little_inner(1);
 471     result = (int)GC_collection_in_progress();
 472     UNLOCK();
 473     ENABLE_SIGNALS();
 474     if (!result && GC_debugging_started) GC_print_all_smashed();
 475     return(result);
 476 }
 477
 478 /*
 479  * Assumes lock is held, signals are disabled.
 480  * We stop the world.
 481  * If stop_func() ever returns TRUE, we may fail and return FALSE.
 482  * Increment GC_gc_no if we succeed.
 483  */
 484 GC_bool GC_stopped_mark(stop_func)
 485 GC_stop_func stop_func;
 486 {
 487     register int i;
 488     int dummy;
 489 #   if defined(PRINTTIMES) || defined(CONDPRINT)
 490         CLOCK_TYPE start_time, current_time;
 491 #   endif
 492
 493 #   ifdef PRINTTIMES
 494         GET_TIME(start_time);
 495 #   endif
 496 #   if defined(CONDPRINT) && !defined(PRINTTIMES)
 497         if (GC_print_stats) GET_TIME(start_time);
 498 #   endif
 499
 500 #   if defined(REGISTER_LIBRARIES_EARLY)
 501         GC_cond_register_dynamic_libraries();
 502 #   endif
 503     STOP_WORLD();
 504     IF_THREADS(GC_world_stopped = TRUE);
 505
 506         if (GC_notify_event)
 507                 GC_notify_event (GC_EVENT_MARK_START);
 508
 509 #   ifdef CONDPRINT
 510       if (GC_print_stats) {
 511         GC_printf1("--> Marking for collection %lu ",
 512                    (unsigned long) GC_gc_no + 1);
 513         GC_printf2("after %lu allocd bytes + %lu wasted bytes\n",
 514                    (unsigned long) WORDS_TO_BYTES(GC_words_allocd),
 515                    (unsigned long) WORDS_TO_BYTES(GC_words_wasted));
 516       }
 517 #   endif
 518 #   ifdef MAKE_BACK_GRAPH
 519       if (GC_print_back_height) {
 520         GC_build_back_graph();
 521       }
 522 #   endif
 523
 524     /* Mark from all roots.  */
 525         /* Minimize junk left in my registers and on the stack */
 526             GC_clear_a_few_frames();
 527             GC_noop(0,0,0,0,0,0);
 528         GC_initiate_gc();
 529         for(i = 0;;i++) {
 530             if ((*stop_func)()) {
 531 #                   ifdef CONDPRINT
 532                       if (GC_print_stats) {
 533                         GC_printf0("Abandoned stopped marking after ");
 534                         GC_printf1("%lu iterations\n",
 535                                    (unsigned long)i);
 536                       }
 537 #                   endif
 538                     GC_deficit = i; /* Give the mutator a chance. */
 539                     IF_THREADS(GC_world_stopped = FALSE);
 540                     START_WORLD();
 541                     return(FALSE);
 542             }
 543             if (GC_mark_some((ptr_t)(&dummy))) break;
 544         }
 545
 546     GC_gc_no++;
 547 #   ifdef PRINTSTATS
 548       GC_printf2("Collection %lu reclaimed %ld bytes",
 549                   (unsigned long) GC_gc_no - 1,
 550                   (long)WORDS_TO_BYTES(GC_mem_found));
 551 #   else
 552 #     ifdef CONDPRINT
 553         if (GC_print_stats) {
 554           GC_printf1("Collection %lu finished", (unsigned long) GC_gc_no - 1);
 555         }
 556 #     endif
 557 #   endif /* !PRINTSTATS */
 558 #   ifdef CONDPRINT
 559       if (GC_print_stats) {
 560         GC_printf1(" ---> heapsize = %lu bytes\n",
 561                    (unsigned long) GC_heapsize);
 562         /* Printf arguments may be pushed in funny places.  Clear the   */
 563         /* space.                                                       */
 564         GC_printf0("");
 565       }
 566 #   endif  /* CONDPRINT  */
 567
 568     /* Check all debugged objects for consistency */
 569         if (GC_debugging_started) {
 570             (*GC_check_heap)();
 571         }
 572
 573
 574         if (GC_notify_event)
 575                 GC_notify_event (GC_EVENT_MARK_END);
 576
 577     IF_THREADS(GC_world_stopped = FALSE);
 578     START_WORLD();
 579 #   ifdef PRINTTIMES
 580         GET_TIME(current_time);
 581         GC_printf1("World-stopped marking took %lu msecs\n",
 582                    MS_TIME_DIFF(current_time,start_time));
 583 #   else
 584 #     ifdef CONDPRINT
 585         if (GC_print_stats) {
 586           GET_TIME(current_time);
 587           GC_printf1("World-stopped marking took %lu msecs\n",
 588                      MS_TIME_DIFF(current_time,start_time));
 589         }
 590 #     endif
 591 #   endif
 592     return(TRUE);
 593 }
 594
 595 /* Set all mark bits for the free list whose first entry is q   */
 596 #ifdef __STDC__
 597   void GC_set_fl_marks(ptr_t q)
 598 #else
 599   void GC_set_fl_marks(q)
 600   ptr_t q;
 601 #endif
 602 {
 603    ptr_t p;
 604    struct hblk * h, * last_h = 0;
 605    hdr *hhdr;
 606    int word_no;
 607
 608    for (p = q; p != 0; p = obj_link(p)){
 609         h = HBLKPTR(p);
 610         if (h != last_h) {
 611           last_h = h;
 612           hhdr = HDR(h);
 613         }
 614         word_no = (((word *)p) - ((word *)h));
 615         set_mark_bit_from_hdr(hhdr, word_no);
 616    }
 617 }
 618
 619 /* Clear all mark bits for the free list whose first entry is q */
 620 /* Decrement GC_mem_found by number of words on free list.      */
 621 #ifdef __STDC__
 622   void GC_clear_fl_marks(ptr_t q)
 623 #else
 624   void GC_clear_fl_marks(q)
 625   ptr_t q;
 626 #endif
 627 {
 628    ptr_t p;
 629    struct hblk * h, * last_h = 0;
 630    hdr *hhdr;
 631    int word_no;
 632
 633    for (p = q; p != 0; p = obj_link(p)){
 634         h = HBLKPTR(p);
 635         if (h != last_h) {
 636           last_h = h;
 637           hhdr = HDR(h);
 638         }
 639         word_no = (((word *)p) - ((word *)h));
 640         clear_mark_bit_from_hdr(hhdr, word_no);
 641 #       ifdef GATHERSTATS
 642             GC_mem_found -= hhdr -> hb_sz;
 643 #       endif
 644    }
 645 }
 646
 647 void (*GC_notify_event) GC_PROTO((GC_EventType e));
 648 void (*GC_on_heap_resize) GC_PROTO((size_t new_size));
 649
 650 GC_API void GC_set_on_collection_event (void (*fn) (GC_EventType))
 651 {
 652         DCL_LOCK_STATE;
 653         LOCK();
 654         GC_notify_event = fn;
 655         UNLOCK();
 656 }
 657
 658 /* Finish up a collection.  Assumes lock is held, signals are disabled, */
 659 /* but the world is otherwise running.                                  */
 660 void GC_finish_collection()
 661 {
 662 #   ifdef PRINTTIMES
 663         CLOCK_TYPE start_time;
 664         CLOCK_TYPE finalize_time;
 665         CLOCK_TYPE done_time;
 666
 667         GET_TIME(start_time);
 668         finalize_time = start_time;
 669 #   endif
 670
 671
 672         if (GC_notify_event)
 673                 GC_notify_event (GC_EVENT_RECLAIM_START);
 674
 675 #   ifdef GATHERSTATS
 676         GC_mem_found = 0;
 677 #   endif
 678 #   if defined(LINUX) && defined(__ELF__) && !defined(SMALL_CONFIG)
 679         if (getenv("GC_PRINT_ADDRESS_MAP") != 0) {
 680           GC_print_address_map();
 681         }
 682 #   endif
 683
 684     COND_DUMP;
 685     if (GC_find_leak) {
 686       /* Mark all objects on the free list.  All objects should be */
 687       /* marked when we're done.                                   */
 688         {
 689           register word size;           /* current object size          */
 690           int kind;
 691           ptr_t q;
 692
 693           for (kind = 0; kind < GC_n_kinds; kind++) {
 694             for (size = 1; size <= MAXOBJSZ; size++) {
 695               q = GC_obj_kinds[kind].ok_freelist[size];
 696               if (q != 0) GC_set_fl_marks(q);
 697             }
 698           }
 699         }
 700         GC_start_reclaim(TRUE);
 701           /* The above just checks; it doesn't really reclaim anything. */
 702     }
 703
 704     GC_finalize();
 705 #   ifdef STUBBORN_ALLOC
 706       GC_clean_changing_list();
 707 #   endif
 708
 709 #   ifdef PRINTTIMES
 710       GET_TIME(finalize_time);
 711 #   endif
 712
 713     if (GC_print_back_height) {
 714 #     ifdef MAKE_BACK_GRAPH
 715         GC_traverse_back_graph();
 716 #     else
 717 #       ifndef SMALL_CONFIG
 718           GC_err_printf0("Back height not available: "
 719                          "Rebuild collector with -DMAKE_BACK_GRAPH\n");
 720 #       endif
 721 #     endif
 722     }
 723
 724     /* Clear free list mark bits, in case they got accidentally marked   */
 725     /* (or GC_find_leak is set and they were intentionally marked).      */
 726     /* Also subtract memory remaining from GC_mem_found count.           */
 727     /* Note that composite objects on free list are cleared.             */
 728     /* Thus accidentally marking a free list is not a problem;  only     */
 729     /* objects on the list itself will be marked, and that's fixed here. */
 730       {
 731         register word size;             /* current object size          */
 732         register ptr_t q;       /* pointer to current object    */
 733         int kind;
 734
 735         for (kind = 0; kind < GC_n_kinds; kind++) {
 736           for (size = 1; size <= MAXOBJSZ; size++) {
 737             q = GC_obj_kinds[kind].ok_freelist[size];
 738             if (q != 0) GC_clear_fl_marks(q);
 739           }
 740         }
 741       }
 742
 743
 744 #   ifdef PRINTSTATS
 745         GC_printf1("Bytes recovered before sweep - f.l. count = %ld\n",
 746                   (long)WORDS_TO_BYTES(GC_mem_found));
 747 #   endif
 748     /* Reconstruct free lists to contain everything not marked */
 749         GC_start_reclaim(FALSE);
 750         if (GC_is_full_gc)  {
 751             GC_used_heap_size_after_full = USED_HEAP_SIZE;
 752             GC_need_full_gc = FALSE;
 753         } else {
 754             GC_need_full_gc =
 755                  BYTES_TO_WORDS(USED_HEAP_SIZE - GC_used_heap_size_after_full)
 756                  > min_words_allocd();
 757         }
 758
 759 #   ifdef PRINTSTATS
 760         GC_printf2(
 761                   "Immediately reclaimed %ld bytes in heap of size %lu bytes",
 762                   (long)WORDS_TO_BYTES(GC_mem_found),
 763                   (unsigned long)GC_heapsize);
 764 #       ifdef USE_MUNMAP
 765           GC_printf1("(%lu unmapped)", GC_unmapped_bytes);
 766 #       endif
 767         GC_printf2(
 768                 "\n%lu (atomic) + %lu (composite) collectable bytes in use\n",
 769                 (unsigned long)WORDS_TO_BYTES(GC_atomic_in_use),
 770                 (unsigned long)WORDS_TO_BYTES(GC_composite_in_use));
 771 #   endif
 772
 773       GC_n_attempts = 0;
 774       GC_is_full_gc = FALSE;
 775     /* Reset or increment counters for next cycle */
 776       GC_words_allocd_before_gc += GC_words_allocd;
 777       GC_non_gc_bytes_at_gc = GC_non_gc_bytes;
 778       GC_words_allocd = 0;
 779       GC_words_wasted = 0;
 780       GC_mem_freed = 0;
 781       GC_finalizer_mem_freed = 0;
 782
 783 #   ifdef USE_MUNMAP
 784       GC_unmap_old();
 785 #   endif
 786
 787         if (GC_notify_event)
 788                 GC_notify_event (GC_EVENT_RECLAIM_END);
 789
 790 #   ifdef PRINTTIMES
 791         GET_TIME(done_time);
 792         GC_printf2("Finalize + initiate sweep took %lu + %lu msecs\n",
 793                    MS_TIME_DIFF(finalize_time,start_time),
 794                    MS_TIME_DIFF(done_time,finalize_time));
 795 #   endif
 796 }
 797
 798 /* Externally callable routine to invoke full, stop-world collection */
 799 # if defined(__STDC__) || defined(__cplusplus)
 800     int GC_try_to_collect(GC_stop_func stop_func)
 801 # else
 802     int GC_try_to_collect(stop_func)
 803     GC_stop_func stop_func;
 804 # endif
 805 {
 806     int result;
 807     DCL_LOCK_STATE;
 808
 809     if (GC_debugging_started) GC_print_all_smashed();
 810     GC_INVOKE_FINALIZERS();
 811     DISABLE_SIGNALS();
 812     LOCK();
 813     ENTER_GC();
 814     if (!GC_is_initialized) GC_init_inner();
 815     /* Minimize junk left in my registers */
 816       GC_noop(0,0,0,0,0,0);
 817     result = (int)GC_try_to_collect_inner(stop_func);
 818     EXIT_GC();
 819     UNLOCK();
 820     ENABLE_SIGNALS();
 821     if(result) {
 822         if (GC_debugging_started) GC_print_all_smashed();
 823         GC_INVOKE_FINALIZERS();
 824     }
 825     return(result);
 826 }
 827
 828 void GC_gcollect GC_PROTO(())
 829 {
 830     (void)GC_try_to_collect(GC_never_stop_func);
 831     if (GC_have_errors) GC_print_all_errors();
 832 }
 833
 834 word GC_n_heap_sects = 0;       /* Number of sections currently in heap. */
 835
 836 /*
 837  * Use the chunk of memory starting at p of size bytes as part of the heap.
 838  * Assumes p is HBLKSIZE aligned, and bytes is a multiple of HBLKSIZE.
 839  */
 840 void GC_add_to_heap(p, bytes)
 841 struct hblk *p;
 842 word bytes;
 843 {
 844     word words;
 845     hdr * phdr;
 846
 847     if (GC_n_heap_sects >= MAX_HEAP_SECTS) {
 848         ABORT("Too many heap sections: Increase MAXHINCR or MAX_HEAP_SECTS");
 849     }
 850     phdr = GC_install_header(p);
 851     if (0 == phdr) {
 852         /* This is extremely unlikely. Can't add it.  This will         */
 853         /* almost certainly result in a 0 return from the allocator,    */
 854         /* which is entirely appropriate.                               */
 855         return;
 856     }
 857     GC_heap_sects[GC_n_heap_sects].hs_start = (ptr_t)p;
 858     GC_heap_sects[GC_n_heap_sects].hs_bytes = bytes;
 859     GC_n_heap_sects++;
 860     words = BYTES_TO_WORDS(bytes);
 861     phdr -> hb_sz = words;
 862     phdr -> hb_map = (unsigned char *)1;   /* A value != GC_invalid_map */
 863     phdr -> hb_flags = 0;
 864     GC_freehblk(p);
 865     GC_heapsize += bytes;
 866     if ((ptr_t)p <= (ptr_t)GC_least_plausible_heap_addr
 867         || GC_least_plausible_heap_addr == 0) {
 868         GC_least_plausible_heap_addr = (GC_PTR)((ptr_t)p - sizeof(word));
 869                 /* Making it a little smaller than necessary prevents   */
 870                 /* us from getting a false hit from the variable        */
 871                 /* itself.  There's some unintentional reflection       */
 872                 /* here.                                                */
 873     }
 874     if ((ptr_t)p + bytes >= (ptr_t)GC_greatest_plausible_heap_addr) {
 875         GC_greatest_plausible_heap_addr = (GC_PTR)((ptr_t)p + bytes);
 876     }
 877 }
 878
 879 # if !defined(NO_DEBUGGING)
 880 void GC_print_heap_sects()
 881 {
 882     register unsigned i;
 883
 884     GC_printf1("Total heap size: %lu\n", (unsigned long) GC_heapsize);
 885     for (i = 0; i < GC_n_heap_sects; i++) {
 886         unsigned long start = (unsigned long) GC_heap_sects[i].hs_start;
 887         unsigned long len = (unsigned long) GC_heap_sects[i].hs_bytes;
 888         struct hblk *h;
 889         unsigned nbl = 0;
 890
 891         GC_printf3("Section %ld from 0x%lx to 0x%lx ", (unsigned long)i,
 892                    start, (unsigned long)(start + len));
 893         for (h = (struct hblk *)start; h < (struct hblk *)(start + len); h++) {
 894             if (GC_is_black_listed(h, HBLKSIZE)) nbl++;
 895         }
 896         GC_printf2("%lu/%lu blacklisted\n", (unsigned long)nbl,
 897                    (unsigned long)(len/HBLKSIZE));
 898     }
 899 }
 900 # endif
 901
 902 GC_PTR GC_least_plausible_heap_addr = (GC_PTR)ONES;
 903 GC_PTR GC_greatest_plausible_heap_addr = 0;
 904
 905 ptr_t GC_max(x,y)
 906 ptr_t x, y;
 907 {
 908     return(x > y? x : y);
 909 }
 910
 911 ptr_t GC_min(x,y)
 912 ptr_t x, y;
 913 {
 914     return(x < y? x : y);
 915 }
 916
 917 # if defined(__STDC__) || defined(__cplusplus)
 918     void GC_set_max_heap_size(GC_word n)
 919 # else
 920     void GC_set_max_heap_size(n)
 921     GC_word n;
 922 # endif
 923 {
 924     GC_max_heapsize = n;
 925 }
 926
 927 GC_word GC_max_retries = 0;
 928
 929 /*
 930  * this explicitly increases the size of the heap.  It is used
 931  * internally, but may also be invoked from GC_expand_hp by the user.
 932  * The argument is in units of HBLKSIZE.
 933  * Tiny values of n are rounded up.
 934  * Returns FALSE on failure.
 935  */
 936 GC_bool GC_expand_hp_inner(n)
 937 word n;
 938 {
 939     word bytes;
 940     struct hblk * space;
 941     word expansion_slop;        /* Number of bytes by which we expect the */
 942                                 /* heap to expand soon.                   */
 943
 944     if (n < MINHINCR) n = MINHINCR;
 945     bytes = n * HBLKSIZE;
 946     /* Make sure bytes is a multiple of GC_page_size */
 947       {
 948         word mask = GC_page_size - 1;
 949         bytes += mask;
 950         bytes &= ~mask;
 951       }
 952
 953     if (GC_max_heapsize != 0 && GC_heapsize + bytes > GC_max_heapsize) {
 954         /* Exceeded self-imposed limit */
 955         return(FALSE);
 956     }
 957     space = GET_MEM(bytes);
 958     if( space == 0 ) {
 959 #       ifdef CONDPRINT
 960           if (GC_print_stats) {
 961             GC_printf1("Failed to expand heap by %ld bytes\n",
 962                        (unsigned long)bytes);
 963           }
 964 #       endif
 965         return(FALSE);
 966     }
 967 #   ifdef CONDPRINT
 968       if (GC_print_stats) {
 969         GC_printf2("Increasing heap size by %lu after %lu allocated bytes\n",
 970                    (unsigned long)bytes,
 971                    (unsigned long)WORDS_TO_BYTES(GC_words_allocd));
 972 #       ifdef UNDEFINED
 973           GC_printf1("Root size = %lu\n", GC_root_size);
 974           GC_print_block_list(); GC_print_hblkfreelist();
 975           GC_printf0("\n");
 976 #       endif
 977       }
 978 #   endif
 979     expansion_slop = WORDS_TO_BYTES(min_words_allocd()) + 4*MAXHINCR*HBLKSIZE;
 980     if ((GC_last_heap_addr == 0 && !((word)space & SIGNB))
 981         || (GC_last_heap_addr != 0 && GC_last_heap_addr < (ptr_t)space)) {
 982         /* Assume the heap is growing up */
 983         GC_greatest_plausible_heap_addr =
 984             (GC_PTR)GC_max((ptr_t)GC_greatest_plausible_heap_addr,
 985                            (ptr_t)space + bytes + expansion_slop);
 986     } else {
 987         /* Heap is growing down */
 988         GC_least_plausible_heap_addr =
 989             (GC_PTR)GC_min((ptr_t)GC_least_plausible_heap_addr,
 990                            (ptr_t)space - expansion_slop);
 991     }
 992 #   if defined(LARGE_CONFIG)
 993       if (((ptr_t)GC_greatest_plausible_heap_addr <= (ptr_t)space + bytes
 994            || (ptr_t)GC_least_plausible_heap_addr >= (ptr_t)space)
 995           && GC_heapsize > 0) {
 996         /* GC_add_to_heap will fix this, but ... */
 997         WARN("Too close to address space limit: blacklisting ineffective\n", 0);
 998       }
 999 #   endif
1000     GC_prev_heap_addr = GC_last_heap_addr;
1001     GC_last_heap_addr = (ptr_t)space;
1002     GC_add_to_heap(space, bytes);
1003     /* Force GC before we are likely to allocate past expansion_slop */
1004       GC_collect_at_heapsize =
1005          GC_heapsize + expansion_slop - 2*MAXHINCR*HBLKSIZE;
1006 #     if defined(LARGE_CONFIG)
1007         if (GC_collect_at_heapsize < GC_heapsize /* wrapped */)
1008          GC_collect_at_heapsize = (word)(-1);
1009 #     endif
1010         if (GC_on_heap_resize)
1011                 GC_on_heap_resize (GC_heapsize);
1012
1013     return(TRUE);
1014 }
1015
1016 /* Really returns a bool, but it's externally visible, so that's clumsy. */
1017 /* Arguments is in bytes.                                               */
1018 # if defined(__STDC__) || defined(__cplusplus)
1019   int GC_expand_hp(size_t bytes)
1020 # else
1021   int GC_expand_hp(bytes)
1022   size_t bytes;
1023 # endif
1024 {
1025     int result;
1026     DCL_LOCK_STATE;
1027
1028     DISABLE_SIGNALS();
1029     LOCK();
1030     if (!GC_is_initialized) GC_init_inner();
1031     result = (int)GC_expand_hp_inner(divHBLKSZ((word)bytes));
1032     if (result) GC_requested_heapsize += bytes;
1033     UNLOCK();
1034     ENABLE_SIGNALS();
1035     return(result);
1036 }
1037
1038 unsigned GC_fail_count = 0;
1039                         /* How many consecutive GC/expansion failures?  */
1040                         /* Reset by GC_allochblk.                       */
1041
1042 static word last_fo_entries = 0;
1043 static word last_words_finalized = 0;
1044
1045 GC_bool GC_collect_or_expand(needed_blocks, ignore_off_page)
1046 word needed_blocks;
1047 GC_bool ignore_off_page;
1048 {
1049     if (!GC_incremental && !GC_dont_gc &&
1050         ((GC_dont_expand && GC_words_allocd > 0)
1051          || (GC_fo_entries > (last_fo_entries + 500) && (last_words_finalized  || GC_words_finalized))
1052          || GC_should_collect())) {
1053       GC_gcollect_inner();
1054       last_fo_entries = GC_fo_entries;
1055       last_words_finalized = GC_words_finalized;
1056     } else {
1057       word blocks_to_get = GC_heapsize/(HBLKSIZE*GC_free_space_divisor)
1058                            + needed_blocks;
1059
1060       if (blocks_to_get > MAXHINCR) {
1061           word slop;
1062
1063           /* Get the minimum required to make it likely that we         */
1064           /* can satisfy the current request in the presence of black-  */
1065           /* listing.  This will probably be more than MAXHINCR.        */
1066           if (ignore_off_page) {
1067               slop = 4;
1068           } else {
1069               slop = 2*divHBLKSZ(BL_LIMIT);
1070               if (slop > needed_blocks) slop = needed_blocks;
1071           }
1072           if (needed_blocks + slop > MAXHINCR) {
1073               blocks_to_get = needed_blocks + slop;
1074           } else {
1075               blocks_to_get = MAXHINCR;
1076           }
1077       }
1078       if (!GC_expand_hp_inner(blocks_to_get)
1079         && !GC_expand_hp_inner(needed_blocks)) {
1080         if (GC_fail_count++ < GC_max_retries) {
1081             WARN("Out of Memory!  Trying to continue ...\n", 0);
1082             GC_gcollect_inner();
1083         } else {
1084 #           if !defined(AMIGA) || !defined(GC_AMIGA_FASTALLOC)
1085               WARN("Out of Memory!  Returning NIL!\n", 0);
1086 #           endif
1087             return(FALSE);
1088         }
1089       } else {
1090 #         ifdef CONDPRINT
1091             if (GC_fail_count && GC_print_stats) {
1092               GC_printf0("Memory available again ...\n");
1093             }
1094 #         endif
1095       }
1096     }
1097     return(TRUE);
1098 }
1099
1100 /*
1101  * Make sure the object free list for sz is not empty.
1102  * Return a pointer to the first object on the free list.
1103  * The object MUST BE REMOVED FROM THE FREE LIST BY THE CALLER.
1104  * Assumes we hold the allocator lock and signals are disabled.
1105  *
1106  */
1107 ptr_t GC_allocobj(sz, kind)
1108 word sz;
1109 int kind;
1110 {
1111     ptr_t * flh = &(GC_obj_kinds[kind].ok_freelist[sz]);
1112     GC_bool tried_minor = FALSE;
1113
1114     if (sz == 0) return(0);
1115
1116     while (*flh == 0) {
1117       ENTER_GC();
1118       /* Do our share of marking work */
1119         if(TRUE_INCREMENTAL) GC_collect_a_little_inner(1);
1120       /* Sweep blocks for objects of this size */
1121         GC_continue_reclaim(sz, kind);
1122       EXIT_GC();
1123       if (*flh == 0) {
1124         GC_new_hblk(sz, kind);
1125       }
1126       if (*flh == 0) {
1127         ENTER_GC();
1128         if (GC_incremental && GC_time_limit == GC_TIME_UNLIMITED
1129             && ! tried_minor ) {
1130             GC_collect_a_little_inner(1);
1131             tried_minor = TRUE;
1132         } else {
1133           if (!GC_collect_or_expand((word)1,FALSE)) {
1134             EXIT_GC();
1135             return(0);
1136           }
1137         }
1138         EXIT_GC();
1139       }
1140     }
1141     /* Successful allocation; reset failure count.      */
1142     GC_fail_count = 0;
1143
1144     return(*flh);
1145 }