rts/ProfHeap.c

   1 /* ----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2003
   4  *
   5  * Support for heap profiling
   6  *
   7  * --------------------------------------------------------------------------*/
   8
   9 #include "PosixSource.h"
  10 #include "Rts.h"
  11 #include "RtsUtils.h"
  12 #include "RtsFlags.h"
  13 #include "Profiling.h"
  14 #include "ProfHeap.h"
  15 #include "Stats.h"
  16 #include "Hash.h"
  17 #include "RetainerProfile.h"
  18 #include "LdvProfile.h"
  19 #include "Arena.h"
  20 #include "Printer.h"
  21
  22 #include <string.h>
  23 #include <stdlib.h>
  24 #include <math.h>
  25
  26 /* -----------------------------------------------------------------------------
  27  * era stores the current time period.  It is the same as the
  28  * number of censuses that have been performed.
  29  *
  30  * RESTRICTION:
  31  *   era must be no longer than LDV_SHIFT (15 or 30) bits.
  32  * Invariants:
  33  *   era is initialized to 1 in initHeapProfiling().
  34  *
  35  * max_era is initialized to 2^LDV_SHIFT in initHeapProfiling().
  36  * When era reaches max_era, the profiling stops because a closure can
  37  * store only up to (max_era - 1) as its creation or last use time.
  38  * -------------------------------------------------------------------------- */
  39 unsigned int era;
  40 static nat max_era;
  41
  42 /* -----------------------------------------------------------------------------
  43  * Counters
  44  *
  45  * For most heap profiles each closure identity gets a simple count
  46  * of live words in the heap at each census.  However, if we're
  47  * selecting by biography, then we have to keep the various
  48  * lag/drag/void counters for each identity.
  49  * -------------------------------------------------------------------------- */
  50 typedef struct _counter {
  51     void *identity;
  52     union {
  53         nat resid;
  54         struct {
  55             int prim;     // total size of 'inherently used' closures
  56             int not_used; // total size of 'never used' closures
  57             int used;     // total size of 'used at least once' closures
  58             int void_total;  // current total size of 'destroyed without being used' closures
  59             int drag_total;  // current total size of 'used at least once and waiting to die'
  60         } ldv;
  61     } c;
  62     struct _counter *next;
  63 } counter;
  64
  65 STATIC_INLINE void
  66 initLDVCtr( counter *ctr )
  67 {
  68     ctr->c.ldv.prim = 0;
  69     ctr->c.ldv.not_used = 0;
  70     ctr->c.ldv.used = 0;
  71     ctr->c.ldv.void_total = 0;
  72     ctr->c.ldv.drag_total = 0;
  73 }
  74
  75 typedef struct {
  76     double      time;    // the time in MUT time when the census is made
  77     HashTable * hash;
  78     counter   * ctrs;
  79     Arena     * arena;
  80
  81     // for LDV profiling, when just displaying by LDV
  82     int       prim;
  83     int       not_used;
  84     int       used;
  85     int       void_total;
  86     int       drag_total;
  87 } Census;
  88
  89 static Census *censuses = NULL;
  90 static nat n_censuses = 0;
  91
  92 #ifdef PROFILING
  93 static void aggregateCensusInfo( void );
  94 #endif
  95
  96 static void dumpCensus( Census *census );
  97
  98 /* ----------------------------------------------------------------------------
  99    Closure Type Profiling;
 100    ------------------------------------------------------------------------- */
 101
 102 static char *type_names[] = {
 103     "INVALID_OBJECT",
 104     "CONSTR",
 105     "CONSTR_1_0",
 106     "CONSTR_0_1",
 107     "CONSTR_2_0",
 108     "CONSTR_1_1",
 109     "CONSTR_0_2",
 110     "CONSTR_STATIC",
 111     "CONSTR_NOCAF_STATIC",
 112     "FUN",
 113     "FUN_1_0",
 114     "FUN_0_1",
 115     "FUN_2_0",
 116     "FUN_1_1",
 117     "FUN_0_2",
 118     "FUN_STATIC",
 119     "THUNK",
 120     "THUNK_1_0",
 121     "THUNK_0_1",
 122     "THUNK_2_0",
 123     "THUNK_1_1",
 124     "THUNK_0_2",
 125     "THUNK_STATIC",
 126     "THUNK_SELECTOR",
 127     "BCO",
 128     "AP",
 129     "PAP",
 130     "AP_STACK",
 131     "IND",
 132     "IND_OLDGEN",
 133     "IND_PERM",
 134     "IND_OLDGEN_PERM",
 135     "IND_STATIC",
 136     "RET_BCO",
 137     "RET_SMALL",
 138     "RET_BIG",
 139     "RET_DYN",
 140     "RET_FUN",
 141     "UPDATE_FRAME",
 142     "CATCH_FRAME",
 143     "STOP_FRAME",
 144     "CAF_BLACKHOLE",
 145     "BLACKHOLE",
 146     "SE_BLACKHOLE",
 147     "SE_CAF_BLACKHOLE",
 148     "MVAR",
 149     "ARR_WORDS",
 150     "MUT_ARR_PTRS_CLEAN",
 151     "MUT_ARR_PTRS_DIRTY",
 152     "MUT_ARR_PTRS_FROZEN0",
 153     "MUT_ARR_PTRS_FROZEN",
 154     "MUT_VAR_CLEAN",
 155     "MUT_VAR_DIRTY",
 156     "WEAK",
 157     "STABLE_NAME",
 158     "TSO",
 159     "BLOCKED_FETCH",
 160     "FETCH_ME",
 161     "FETCH_ME_BQ",
 162     "RBH",
 163     "EVACUATED",
 164     "REMOTE_REF",
 165     "TVAR_WATCH_QUEUE",
 166     "INVARIANT_CHECK_QUEUE",
 167     "ATOMIC_INVARIANT",
 168     "TVAR",
 169     "TREC_CHUNK",
 170     "TREC_HEADER",
 171     "ATOMICALLY_FRAME",
 172     "CATCH_RETRY_FRAME",
 173     "CATCH_STM_FRAME",
 174     "N_CLOSURE_TYPES"
 175   };
 176
 177 /* ----------------------------------------------------------------------------
 178  * Find the "closure identity", which is a unique pointer reresenting
 179  * the band to which this closure's heap space is attributed in the
 180  * heap profile.
 181  * ------------------------------------------------------------------------- */
 182 STATIC_INLINE void *
 183 closureIdentity( StgClosure *p )
 184 {
 185     switch (RtsFlags.ProfFlags.doHeapProfile) {
 186
 187 #ifdef PROFILING
 188     case HEAP_BY_CCS:
 189         return p->header.prof.ccs;
 190     case HEAP_BY_MOD:
 191         return p->header.prof.ccs->cc->module;
 192     case HEAP_BY_DESCR:
 193         return get_itbl(p)->prof.closure_desc;
 194     case HEAP_BY_TYPE:
 195         return get_itbl(p)->prof.closure_type;
 196     case HEAP_BY_RETAINER:
 197         // AFAIK, the only closures in the heap which might not have a
 198         // valid retainer set are DEAD_WEAK closures.
 199         if (isRetainerSetFieldValid(p))
 200             return retainerSetOf(p);
 201         else
 202             return NULL;
 203
 204 #else
 205     case HEAP_BY_CLOSURE_TYPE:
 206     {
 207         StgInfoTable *info;
 208         info = get_itbl(p);
 209         switch (info->type) {
 210         case CONSTR:
 211         case CONSTR_1_0:
 212         case CONSTR_0_1:
 213         case CONSTR_2_0:
 214         case CONSTR_1_1:
 215         case CONSTR_0_2:
 216         case CONSTR_STATIC:
 217         case CONSTR_NOCAF_STATIC:
 218             printf("",strlen(GET_CON_DESC(itbl_to_con_itbl(info))));
 219             return GET_CON_DESC(itbl_to_con_itbl(info));
 220         default:
 221             return type_names[info->type];
 222         }
 223     }
 224
 225 #endif
 226     default:
 227         barf("closureIdentity");
 228     }
 229 }
 230
 231 /* --------------------------------------------------------------------------
 232  * Profiling type predicates
 233  * ----------------------------------------------------------------------- */
 234 #ifdef PROFILING
 235 STATIC_INLINE rtsBool
 236 doingLDVProfiling( void )
 237 {
 238     return (RtsFlags.ProfFlags.doHeapProfile == HEAP_BY_LDV
 239             || RtsFlags.ProfFlags.bioSelector != NULL);
 240 }
 241
 242 STATIC_INLINE rtsBool
 243 doingRetainerProfiling( void )
 244 {
 245     return (RtsFlags.ProfFlags.doHeapProfile == HEAP_BY_RETAINER
 246             || RtsFlags.ProfFlags.retainerSelector != NULL);
 247 }
 248 #endif /* PROFILING */
 249
 250 // Precesses a closure 'c' being destroyed whose size is 'size'.
 251 // Make sure that LDV_recordDead() is not invoked on 'inherently used' closures
 252 // such as TSO; they should not be involved in computing dragNew or voidNew.
 253 //
 254 // Even though era is checked in both LdvCensusForDead() and
 255 // LdvCensusKillAll(), we still need to make sure that era is > 0 because
 256 // LDV_recordDead() may be called from elsewhere in the runtime system. E.g.,
 257 // when a thunk is replaced by an indirection object.
 258
 259 #ifdef PROFILING
 260 void
 261 LDV_recordDead( StgClosure *c, nat size )
 262 {
 263     void *id;
 264     nat t;
 265     counter *ctr;
 266
 267     if (era > 0 && closureSatisfiesConstraints(c)) {
 268         size -= sizeofW(StgProfHeader);
 269         ASSERT(LDVW(c) != 0);
 270         if ((LDVW((c)) & LDV_STATE_MASK) == LDV_STATE_CREATE) {
 271             t = (LDVW((c)) & LDV_CREATE_MASK) >> LDV_SHIFT;
 272             if (t < era) {
 273                 if (RtsFlags.ProfFlags.bioSelector == NULL) {
 274                     censuses[t].void_total   += (int)size;
 275                     censuses[era].void_total -= (int)size;
 276                     ASSERT(censuses[t].void_total < censuses[t].not_used);
 277                 } else {
 278                     id = closureIdentity(c);
 279                     ctr = lookupHashTable(censuses[t].hash, (StgWord)id);
 280                     ASSERT( ctr != NULL );
 281                     ctr->c.ldv.void_total += (int)size;
 282                     ctr = lookupHashTable(censuses[era].hash, (StgWord)id);
 283                     if (ctr == NULL) {
 284                         ctr = arenaAlloc(censuses[era].arena, sizeof(counter));
 285                         initLDVCtr(ctr);
 286                         insertHashTable(censuses[era].hash, (StgWord)id, ctr);
 287                         ctr->identity = id;
 288                         ctr->next = censuses[era].ctrs;
 289                         censuses[era].ctrs = ctr;
 290                     }
 291                     ctr->c.ldv.void_total -= (int)size;
 292                 }
 293             }
 294         } else {
 295             t = LDVW((c)) & LDV_LAST_MASK;
 296             if (t + 1 < era) {
 297                 if (RtsFlags.ProfFlags.bioSelector == NULL) {
 298                     censuses[t+1].drag_total += size;
 299                     censuses[era].drag_total -= size;
 300                 } else {
 301                     void *id;
 302                     id = closureIdentity(c);
 303                     ctr = lookupHashTable(censuses[t+1].hash, (StgWord)id);
 304                     ASSERT( ctr != NULL );
 305                     ctr->c.ldv.drag_total += (int)size;
 306                     ctr = lookupHashTable(censuses[era].hash, (StgWord)id);
 307                     if (ctr == NULL) {
 308                         ctr = arenaAlloc(censuses[era].arena, sizeof(counter));
 309                         initLDVCtr(ctr);
 310                         insertHashTable(censuses[era].hash, (StgWord)id, ctr);
 311                         ctr->identity = id;
 312                         ctr->next = censuses[era].ctrs;
 313                         censuses[era].ctrs = ctr;
 314                     }
 315                     ctr->c.ldv.drag_total -= (int)size;
 316                 }
 317             }
 318         }
 319     }
 320 }
 321 #endif
 322
 323 /* --------------------------------------------------------------------------
 324  * Initialize censuses[era];
 325  * ----------------------------------------------------------------------- */
 326
 327 STATIC_INLINE void
 328 initEra(Census *census)
 329 {
 330     census->hash  = allocHashTable();
 331     census->ctrs  = NULL;
 332     census->arena = newArena();
 333
 334     census->not_used   = 0;
 335     census->used       = 0;
 336     census->prim       = 0;
 337     census->void_total = 0;
 338     census->drag_total = 0;
 339 }
 340
 341 STATIC_INLINE void
 342 freeEra(Census *census)
 343 {
 344     arenaFree(census->arena);
 345     freeHashTable(census->hash, NULL);
 346 }
 347
 348 /* --------------------------------------------------------------------------
 349  * Increases era by 1 and initialize census[era].
 350  * Reallocates gi[] and increases its size if needed.
 351  * ----------------------------------------------------------------------- */
 352
 353 static void
 354 nextEra( void )
 355 {
 356 #ifdef PROFILING
 357     if (doingLDVProfiling()) {
 358         era++;
 359
 360         if (era == max_era) {
 361             errorBelch("maximum number of censuses reached; use +RTS -i to reduce");
 362             stg_exit(EXIT_FAILURE);
 363         }
 364
 365         if (era == n_censuses) {
 366             n_censuses *= 2;
 367             censuses = stgReallocBytes(censuses, sizeof(Census) * n_censuses,
 368                                        "nextEra");
 369         }
 370     }
 371 #endif /* PROFILING */
 372
 373     initEra( &censuses[era] );
 374 }
 375
 376 /* ----------------------------------------------------------------------------
 377  * Heap profiling by info table
 378  * ------------------------------------------------------------------------- */
 379
 380 #if !defined(PROFILING)
 381 FILE *hp_file;
 382 static char *hp_filename;
 383
 384 void initProfiling1 (void)
 385 {
 386 }
 387
 388 void freeProfiling1 (void)
 389 {
 390 }
 391
 392 void initProfiling2 (void)
 393 {
 394   if (RtsFlags.ProfFlags.doHeapProfile) {
 395     /* Initialise the log file name */
 396     hp_filename = stgMallocBytes(strlen(prog_name) + 6, "hpFileName");
 397     sprintf(hp_filename, "%s.hp", prog_name);
 398
 399     /* open the log file */
 400     if ((hp_file = fopen(hp_filename, "w")) == NULL) {
 401       debugBelch("Can't open profiling report file %s\n",
 402               hp_filename);
 403       RtsFlags.ProfFlags.doHeapProfile = 0;
 404       return;
 405     }
 406   }
 407
 408   initHeapProfiling();
 409 }
 410
 411 void endProfiling( void )
 412 {
 413   endHeapProfiling();
 414 }
 415 #endif /* !PROFILING */
 416
 417 static void
 418 printSample(rtsBool beginSample, StgDouble sampleValue)
 419 {
 420     StgDouble fractionalPart, integralPart;
 421     fractionalPart = modf(sampleValue, &integralPart);
 422     fprintf(hp_file, "%s %" FMT_Word64 ".%02" FMT_Word64 "\n",
 423             (beginSample ? "BEGIN_SAMPLE" : "END_SAMPLE"),
 424             (StgWord64)integralPart, (StgWord64)(fractionalPart * 100));
 425 }
 426
 427 /* --------------------------------------------------------------------------
 428  * Initialize the heap profilier
 429  * ----------------------------------------------------------------------- */
 430 nat
 431 initHeapProfiling(void)
 432 {
 433     if (! RtsFlags.ProfFlags.doHeapProfile) {
 434         return 0;
 435     }
 436
 437 #ifdef PROFILING
 438     if (doingLDVProfiling() && doingRetainerProfiling()) {
 439         errorBelch("cannot mix -hb and -hr");
 440         stg_exit(EXIT_FAILURE);
 441     }
 442 #endif
 443
 444     // we only count eras if we're doing LDV profiling.  Otherwise era
 445     // is fixed at zero.
 446 #ifdef PROFILING
 447     if (doingLDVProfiling()) {
 448         era = 1;
 449     } else
 450 #endif
 451     {
 452         era = 0;
 453     }
 454
 455     {   // max_era = 2^LDV_SHIFT
 456         nat p;
 457         max_era = 1;
 458         for (p = 0; p < LDV_SHIFT; p++)
 459             max_era *= 2;
 460     }
 461
 462     n_censuses = 32;
 463     censuses = stgMallocBytes(sizeof(Census) * n_censuses, "initHeapProfiling");
 464
 465     initEra( &censuses[era] );
 466
 467     /* initProfilingLogFile(); */
 468     fprintf(hp_file, "JOB \"%s", prog_name);
 469
 470 #ifdef PROFILING
 471     {
 472         int count;
 473         for(count = 1; count < prog_argc; count++)
 474             fprintf(hp_file, " %s", prog_argv[count]);
 475         fprintf(hp_file, " +RTS");
 476         for(count = 0; count < rts_argc; count++)
 477             fprintf(hp_file, " %s", rts_argv[count]);
 478     }
 479 #endif /* PROFILING */
 480
 481     fprintf(hp_file, "\"\n" );
 482
 483     fprintf(hp_file, "DATE \"%s\"\n", time_str());
 484
 485     fprintf(hp_file, "SAMPLE_UNIT \"seconds\"\n");
 486     fprintf(hp_file, "VALUE_UNIT \"bytes\"\n");
 487
 488     printSample(rtsTrue, 0);
 489     printSample(rtsFalse, 0);
 490
 491 #ifdef PROFILING
 492     if (doingRetainerProfiling()) {
 493         initRetainerProfiling();
 494     }
 495 #endif
 496
 497     return 0;
 498 }
 499
 500 void
 501 endHeapProfiling(void)
 502 {
 503     StgDouble seconds;
 504
 505     if (! RtsFlags.ProfFlags.doHeapProfile) {
 506         return;
 507     }
 508
 509 #ifdef PROFILING
 510     if (doingRetainerProfiling()) {
 511         endRetainerProfiling();
 512     }
 513 #endif
 514
 515 #ifdef PROFILING
 516     if (doingLDVProfiling()) {
 517         nat t;
 518         LdvCensusKillAll();
 519         aggregateCensusInfo();
 520         for (t = 1; t < era; t++) {
 521             dumpCensus( &censuses[t] );
 522         }
 523     }
 524 #endif
 525
 526     if (doingLDVProfiling()) {
 527         nat t;
 528         for (t = 1; t <= era; t++) {
 529             freeEra( &censuses[t] );
 530         }
 531     } else {
 532         freeEra( &censuses[0] );
 533     }
 534     stgFree(censuses);
 535
 536     seconds = mut_user_time();
 537     printSample(rtsTrue, seconds);
 538     printSample(rtsFalse, seconds);
 539     fclose(hp_file);
 540 }
 541
 542
 543
 544 #ifdef PROFILING
 545 static size_t
 546 buf_append(char *p, const char *q, char *end)
 547 {
 548     int m;
 549
 550     for (m = 0; p < end; p++, q++, m++) {
 551         *p = *q;
 552         if (*q == '\0') { break; }
 553     }
 554     return m;
 555 }
 556
 557 static void
 558 fprint_ccs(FILE *fp, CostCentreStack *ccs, nat max_length)
 559 {
 560     char buf[max_length+1], *p, *buf_end;
 561
 562     // MAIN on its own gets printed as "MAIN", otherwise we ignore MAIN.
 563     if (ccs == CCS_MAIN) {
 564         fprintf(fp, "MAIN");
 565         return;
 566     }
 567
 568     fprintf(fp, "(%ld)", ccs->ccsID);
 569
 570     p = buf;
 571     buf_end = buf + max_length + 1;
 572
 573     // keep printing components of the stack until we run out of space
 574     // in the buffer.  If we run out of space, end with "...".
 575     for (; ccs != NULL && ccs != CCS_MAIN; ccs = ccs->prevStack) {
 576
 577         // CAF cost centres print as M.CAF, but we leave the module
 578         // name out of all the others to save space.
 579         if (!strcmp(ccs->cc->label,"CAF")) {
 580             p += buf_append(p, ccs->cc->module, buf_end);
 581             p += buf_append(p, ".CAF", buf_end);
 582         } else {
 583             p += buf_append(p, ccs->cc->label, buf_end);
 584             if (ccs->prevStack != NULL && ccs->prevStack != CCS_MAIN) {
 585                 p += buf_append(p, "/", buf_end);
 586             }
 587         }
 588
 589         if (p >= buf_end) {
 590             sprintf(buf+max_length-4, "...");
 591             break;
 592         }
 593     }
 594     fprintf(fp, "%s", buf);
 595 }
 596 #endif /* PROFILING */
 597
 598 rtsBool
 599 strMatchesSelector( char* str, char* sel )
 600 {
 601    char* p;
 602    // debugBelch("str_matches_selector %s %s\n", str, sel);
 603    while (1) {
 604        // Compare str against wherever we've got to in sel.
 605        p = str;
 606        while (*p != '\0' && *sel != ',' && *sel != '\0' && *p == *sel) {
 607            p++; sel++;
 608        }
 609        // Match if all of str used and have reached the end of a sel fragment.
 610        if (*p == '\0' && (*sel == ',' || *sel == '\0'))
 611            return rtsTrue;
 612
 613        // No match.  Advance sel to the start of the next elem.
 614        while (*sel != ',' && *sel != '\0') sel++;
 615        if (*sel == ',') sel++;
 616
 617        /* Run out of sel ?? */
 618        if (*sel == '\0') return rtsFalse;
 619    }
 620 }
 621
 622 /* -----------------------------------------------------------------------------
 623  * Figure out whether a closure should be counted in this census, by
 624  * testing against all the specified constraints.
 625  * -------------------------------------------------------------------------- */
 626 rtsBool
 627 closureSatisfiesConstraints( StgClosure* p )
 628 {
 629 #if !defined(PROFILING)
 630     (void)p;   /* keep gcc -Wall happy */
 631     return rtsTrue;
 632 #else
 633    rtsBool b;
 634
 635    // The CCS has a selected field to indicate whether this closure is
 636    // deselected by not being mentioned in the module, CC, or CCS
 637    // selectors.
 638    if (!p->header.prof.ccs->selected) {
 639        return rtsFalse;
 640    }
 641
 642    if (RtsFlags.ProfFlags.descrSelector) {
 643        b = strMatchesSelector( (get_itbl((StgClosure *)p))->prof.closure_desc,
 644                                  RtsFlags.ProfFlags.descrSelector );
 645        if (!b) return rtsFalse;
 646    }
 647    if (RtsFlags.ProfFlags.typeSelector) {
 648        b = strMatchesSelector( (get_itbl((StgClosure *)p))->prof.closure_type,
 649                                 RtsFlags.ProfFlags.typeSelector );
 650        if (!b) return rtsFalse;
 651    }
 652    if (RtsFlags.ProfFlags.retainerSelector) {
 653        RetainerSet *rs;
 654        nat i;
 655        // We must check that the retainer set is valid here.  One
 656        // reason it might not be valid is if this closure is a
 657        // a newly deceased weak pointer (i.e. a DEAD_WEAK), since
 658        // these aren't reached by the retainer profiler's traversal.
 659        if (isRetainerSetFieldValid((StgClosure *)p)) {
 660            rs = retainerSetOf((StgClosure *)p);
 661            if (rs != NULL) {
 662                for (i = 0; i < rs->num; i++) {
 663                    b = strMatchesSelector( rs->element[i]->cc->label,
 664                                            RtsFlags.ProfFlags.retainerSelector );
 665                    if (b) return rtsTrue;
 666                }
 667            }
 668        }
 669        return rtsFalse;
 670    }
 671    return rtsTrue;
 672 #endif /* PROFILING */
 673 }
 674
 675 /* -----------------------------------------------------------------------------
 676  * Aggregate the heap census info for biographical profiling
 677  * -------------------------------------------------------------------------- */
 678 #ifdef PROFILING
 679 static void
 680 aggregateCensusInfo( void )
 681 {
 682     HashTable *acc;
 683     nat t;
 684     counter *c, *d, *ctrs;
 685     Arena *arena;
 686
 687     if (!doingLDVProfiling()) return;
 688
 689     // Aggregate the LDV counters when displaying by biography.
 690     if (RtsFlags.ProfFlags.doHeapProfile == HEAP_BY_LDV) {
 691         int void_total, drag_total;
 692
 693         // Now we compute void_total and drag_total for each census
 694         // After the program has finished, the void_total field of
 695         // each census contains the count of words that were *created*
 696         // in this era and were eventually void.  Conversely, if a
 697         // void closure was destroyed in this era, it will be
 698         // represented by a negative count of words in void_total.
 699         //
 700         // To get the count of live words that are void at each
 701         // census, just propagate the void_total count forwards:
 702
 703         void_total = 0;
 704         drag_total = 0;
 705         for (t = 1; t < era; t++) { // note: start at 1, not 0
 706             void_total += censuses[t].void_total;
 707             drag_total += censuses[t].drag_total;
 708             censuses[t].void_total = void_total;
 709             censuses[t].drag_total = drag_total;
 710
 711             ASSERT( censuses[t].void_total <= censuses[t].not_used );
 712             // should be true because: void_total is the count of
 713             // live words that are void at this census, which *must*
 714             // be less than the number of live words that have not
 715             // been used yet.
 716
 717             ASSERT( censuses[t].drag_total <= censuses[t].used );
 718             // similar reasoning as above.
 719         }
 720
 721         return;
 722     }
 723
 724     // otherwise... we're doing a heap profile that is restricted to
 725     // some combination of lag, drag, void or use.  We've kept all the
 726     // census info for all censuses so far, but we still need to
 727     // aggregate the counters forwards.
 728
 729     arena = newArena();
 730     acc = allocHashTable();
 731     ctrs = NULL;
 732
 733     for (t = 1; t < era; t++) {
 734
 735         // first look through all the counters we're aggregating
 736         for (c = ctrs; c != NULL; c = c->next) {
 737             // if one of the totals is non-zero, then this closure
 738             // type must be present in the heap at this census time...
 739             d = lookupHashTable(censuses[t].hash, (StgWord)c->identity);
 740
 741             if (d == NULL) {
 742                 // if this closure identity isn't present in the
 743                 // census for this time period, then our running
 744                 // totals *must* be zero.
 745                 ASSERT(c->c.ldv.void_total == 0 && c->c.ldv.drag_total == 0);
 746
 747                 // debugCCS(c->identity);
 748                 // debugBelch(" census=%d void_total=%d drag_total=%d\n",
 749                 //         t, c->c.ldv.void_total, c->c.ldv.drag_total);
 750             } else {
 751                 d->c.ldv.void_total += c->c.ldv.void_total;
 752                 d->c.ldv.drag_total += c->c.ldv.drag_total;
 753                 c->c.ldv.void_total =  d->c.ldv.void_total;
 754                 c->c.ldv.drag_total =  d->c.ldv.drag_total;
 755
 756                 ASSERT( c->c.ldv.void_total >= 0 );
 757                 ASSERT( c->c.ldv.drag_total >= 0 );
 758             }
 759         }
 760
 761         // now look through the counters in this census to find new ones
 762         for (c = censuses[t].ctrs; c != NULL; c = c->next) {
 763             d = lookupHashTable(acc, (StgWord)c->identity);
 764             if (d == NULL) {
 765                 d = arenaAlloc( arena, sizeof(counter) );
 766                 initLDVCtr(d);
 767                 insertHashTable( acc, (StgWord)c->identity, d );
 768                 d->identity = c->identity;
 769                 d->next = ctrs;
 770                 ctrs = d;
 771                 d->c.ldv.void_total = c->c.ldv.void_total;
 772                 d->c.ldv.drag_total = c->c.ldv.drag_total;
 773             }
 774             ASSERT( c->c.ldv.void_total >= 0 );
 775             ASSERT( c->c.ldv.drag_total >= 0 );
 776         }
 777     }
 778
 779     freeHashTable(acc, NULL);
 780     arenaFree(arena);
 781 }
 782 #endif
 783
 784 /* -----------------------------------------------------------------------------
 785  * Print out the results of a heap census.
 786  * -------------------------------------------------------------------------- */
 787 static void
 788 dumpCensus( Census *census )
 789 {
 790     counter *ctr;
 791     int count;
 792
 793     printSample(rtsTrue, census->time);
 794
 795 #ifdef PROFILING
 796     if (RtsFlags.ProfFlags.doHeapProfile == HEAP_BY_LDV) {
 797       fprintf(hp_file, "VOID\t%lu\n", (unsigned long)(census->void_total) * sizeof(W_));
 798         fprintf(hp_file, "LAG\t%lu\n",
 799                 (unsigned long)(census->not_used - census->void_total) * sizeof(W_));
 800         fprintf(hp_file, "USE\t%lu\n",
 801                 (unsigned long)(census->used - census->drag_total) * sizeof(W_));
 802         fprintf(hp_file, "INHERENT_USE\t%lu\n",
 803                 (unsigned long)(census->prim) * sizeof(W_));
 804         fprintf(hp_file, "DRAG\t%lu\n",
 805                 (unsigned long)(census->drag_total) * sizeof(W_));
 806         printSample(rtsFalse, census->time);
 807         return;
 808     }
 809 #endif
 810
 811     for (ctr = census->ctrs; ctr != NULL; ctr = ctr->next) {
 812
 813 #ifdef PROFILING
 814         if (RtsFlags.ProfFlags.bioSelector != NULL) {
 815             count = 0;
 816             if (strMatchesSelector("lag", RtsFlags.ProfFlags.bioSelector))
 817                 count += ctr->c.ldv.not_used - ctr->c.ldv.void_total;
 818             if (strMatchesSelector("drag", RtsFlags.ProfFlags.bioSelector))
 819                 count += ctr->c.ldv.drag_total;
 820             if (strMatchesSelector("void", RtsFlags.ProfFlags.bioSelector))
 821                 count += ctr->c.ldv.void_total;
 822             if (strMatchesSelector("use", RtsFlags.ProfFlags.bioSelector))
 823                 count += ctr->c.ldv.used - ctr->c.ldv.drag_total;
 824         } else
 825 #endif
 826         {
 827             count = ctr->c.resid;
 828         }
 829
 830         ASSERT( count >= 0 );
 831
 832         if (count == 0) continue;
 833
 834 #if !defined(PROFILING)
 835         switch (RtsFlags.ProfFlags.doHeapProfile) {
 836         case HEAP_BY_CLOSURE_TYPE:
 837             fprintf(hp_file, "%s", (char *)ctr->identity);
 838             break;
 839         }
 840 #endif
 841
 842 #ifdef PROFILING
 843         switch (RtsFlags.ProfFlags.doHeapProfile) {
 844         case HEAP_BY_CCS:
 845             fprint_ccs(hp_file, (CostCentreStack *)ctr->identity, RtsFlags.ProfFlags.ccsLength);
 846             break;
 847         case HEAP_BY_MOD:
 848         case HEAP_BY_DESCR:
 849         case HEAP_BY_TYPE:
 850             fprintf(hp_file, "%s", (char *)ctr->identity);
 851             break;
 852         case HEAP_BY_RETAINER:
 853         {
 854             RetainerSet *rs = (RetainerSet *)ctr->identity;
 855
 856             // it might be the distinguished retainer set rs_MANY:
 857             if (rs == &rs_MANY) {
 858                 fprintf(hp_file, "MANY");
 859                 break;
 860             }
 861
 862             // Mark this retainer set by negating its id, because it
 863             // has appeared in at least one census.  We print the
 864             // values of all such retainer sets into the log file at
 865             // the end.  A retainer set may exist but not feature in
 866             // any censuses if it arose as the intermediate retainer
 867             // set for some closure during retainer set calculation.
 868             if (rs->id > 0)
 869                 rs->id = -(rs->id);
 870
 871             // report in the unit of bytes: * sizeof(StgWord)
 872             printRetainerSetShort(hp_file, rs);
 873             break;
 874         }
 875         default:
 876             barf("dumpCensus; doHeapProfile");
 877         }
 878 #endif
 879
 880         fprintf(hp_file, "\t%lu\n", (unsigned long)count * sizeof(W_));
 881     }
 882
 883     printSample(rtsFalse, census->time);
 884 }
 885
 886 /* -----------------------------------------------------------------------------
 887  * Code to perform a heap census.
 888  * -------------------------------------------------------------------------- */
 889 static void
 890 heapCensusChain( Census *census, bdescr *bd )
 891 {
 892     StgPtr p;
 893     StgInfoTable *info;
 894     void *identity;
 895     nat size;
 896     counter *ctr;
 897     nat real_size;
 898     rtsBool prim;
 899
 900     for (; bd != NULL; bd = bd->link) {
 901
 902         // HACK: ignore pinned blocks, because they contain gaps.
 903         // It's not clear exactly what we'd like to do here, since we
 904         // can't tell which objects in the block are actually alive.
 905         // Perhaps the whole block should be counted as SYSTEM memory.
 906         if (bd->flags & BF_PINNED) {
 907             continue;
 908         }
 909
 910         p = bd->start;
 911         while (p < bd->free) {
 912             info = get_itbl((StgClosure *)p);
 913             prim = rtsFalse;
 914
 915             switch (info->type) {
 916
 917             case THUNK:
 918                 size = thunk_sizeW_fromITBL(info);
 919                 break;
 920
 921             case THUNK_1_1:
 922             case THUNK_0_2:
 923             case THUNK_2_0:
 924                 size = sizeofW(StgThunkHeader) + 2;
 925                 break;
 926
 927             case THUNK_1_0:
 928             case THUNK_0_1:
 929             case THUNK_SELECTOR:
 930                 size = sizeofW(StgThunkHeader) + 1;
 931                 break;
 932
 933             case CONSTR:
 934             case FUN:
 935             case IND_PERM:
 936             case IND_OLDGEN:
 937             case IND_OLDGEN_PERM:
 938             case CAF_BLACKHOLE:
 939             case SE_CAF_BLACKHOLE:
 940             case SE_BLACKHOLE:
 941             case BLACKHOLE:
 942             case FUN_1_0:
 943             case FUN_0_1:
 944             case FUN_1_1:
 945             case FUN_0_2:
 946             case FUN_2_0:
 947             case CONSTR_1_0:
 948             case CONSTR_0_1:
 949             case CONSTR_1_1:
 950             case CONSTR_0_2:
 951             case CONSTR_2_0:
 952                 size = sizeW_fromITBL(info);
 953                 break;
 954
 955             case IND:
 956                 // Special case/Delicate Hack: INDs don't normally
 957                 // appear, since we're doing this heap census right
 958                 // after GC.  However, GarbageCollect() also does
 959                 // resurrectThreads(), which can update some
 960                 // blackholes when it calls raiseAsync() on the
 961                 // resurrected threads.  So we know that any IND will
 962                 // be the size of a BLACKHOLE.
 963                 size = BLACKHOLE_sizeW();
 964                 break;
 965
 966             case BCO:
 967                 prim = rtsTrue;
 968                 size = bco_sizeW((StgBCO *)p);
 969                 break;
 970
 971             case MVAR:
 972             case WEAK:
 973             case STABLE_NAME:
 974             case MUT_VAR_CLEAN:
 975             case MUT_VAR_DIRTY:
 976                 prim = rtsTrue;
 977                 size = sizeW_fromITBL(info);
 978                 break;
 979
 980             case AP:
 981                 size = ap_sizeW((StgAP *)p);
 982                 break;
 983
 984             case PAP:
 985                 size = pap_sizeW((StgPAP *)p);
 986                 break;
 987
 988             case AP_STACK:
 989                 size = ap_stack_sizeW((StgAP_STACK *)p);
 990                 break;
 991
 992             case ARR_WORDS:
 993                 prim = rtsTrue;
 994                 size = arr_words_sizeW(stgCast(StgArrWords*,p));
 995                 break;
 996
 997             case MUT_ARR_PTRS_CLEAN:
 998             case MUT_ARR_PTRS_DIRTY:
 999             case MUT_ARR_PTRS_FROZEN:
1000             case MUT_ARR_PTRS_FROZEN0:
1001                 prim = rtsTrue;
1002                 size = mut_arr_ptrs_sizeW((StgMutArrPtrs *)p);
1003                 break;
1004
1005             case TSO:
1006                 prim = rtsTrue;
1007 #ifdef PROFILING
1008                 if (RtsFlags.ProfFlags.includeTSOs) {
1009                     size = tso_sizeW((StgTSO *)p);
1010                     break;
1011                 } else {
1012                     // Skip this TSO and move on to the next object
1013                     p += tso_sizeW((StgTSO *)p);
1014                     continue;
1015                 }
1016 #else
1017                 size = tso_sizeW((StgTSO *)p);
1018                 break;
1019 #endif
1020
1021             case TREC_HEADER:
1022                 prim = rtsTrue;
1023                 size = sizeofW(StgTRecHeader);
1024                 break;
1025
1026             case TVAR_WATCH_QUEUE:
1027                 prim = rtsTrue;
1028                 size = sizeofW(StgTVarWatchQueue);
1029                 break;
1030
1031             case INVARIANT_CHECK_QUEUE:
1032                 prim = rtsTrue;
1033                 size = sizeofW(StgInvariantCheckQueue);
1034                 break;
1035
1036             case ATOMIC_INVARIANT:
1037                 prim = rtsTrue;
1038                 size = sizeofW(StgAtomicInvariant);
1039                 break;
1040
1041             case TVAR:
1042                 prim = rtsTrue;
1043                 size = sizeofW(StgTVar);
1044                 break;
1045
1046             case TREC_CHUNK:
1047                 prim = rtsTrue;
1048                 size = sizeofW(StgTRecChunk);
1049                 break;
1050
1051             default:
1052                 barf("heapCensus, unknown object: %d", info->type);
1053             }
1054
1055             identity = NULL;
1056
1057 #ifdef PROFILING
1058             // subtract the profiling overhead
1059             real_size = size - sizeofW(StgProfHeader);
1060 #else
1061             real_size = size;
1062 #endif
1063
1064             if (closureSatisfiesConstraints((StgClosure*)p)) {
1065 #ifdef PROFILING
1066                 if (RtsFlags.ProfFlags.doHeapProfile == HEAP_BY_LDV) {
1067                     if (prim)
1068                         census->prim += real_size;
1069                     else if ((LDVW(p) & LDV_STATE_MASK) == LDV_STATE_CREATE)
1070                         census->not_used += real_size;
1071                     else
1072                         census->used += real_size;
1073                 } else
1074 #endif
1075                 {
1076                     identity = closureIdentity((StgClosure *)p);
1077
1078                     if (identity != NULL) {
1079                         ctr = lookupHashTable( census->hash, (StgWord)identity );
1080                         if (ctr != NULL) {
1081 #ifdef PROFILING
1082                             if (RtsFlags.ProfFlags.bioSelector != NULL) {
1083                                 if (prim)
1084                                     ctr->c.ldv.prim += real_size;
1085                                 else if ((LDVW(p) & LDV_STATE_MASK) == LDV_STATE_CREATE)
1086                                     ctr->c.ldv.not_used += real_size;
1087                                 else
1088                                     ctr->c.ldv.used += real_size;
1089                             } else
1090 #endif
1091                             {
1092                                 ctr->c.resid += real_size;
1093                             }
1094                         } else {
1095                             ctr = arenaAlloc( census->arena, sizeof(counter) );
1096                             initLDVCtr(ctr);
1097                             insertHashTable( census->hash, (StgWord)identity, ctr );
1098                             ctr->identity = identity;
1099                             ctr->next = census->ctrs;
1100                             census->ctrs = ctr;
1101
1102 #ifdef PROFILING
1103                             if (RtsFlags.ProfFlags.bioSelector != NULL) {
1104                                 if (prim)
1105                                     ctr->c.ldv.prim = real_size;
1106                                 else if ((LDVW(p) & LDV_STATE_MASK) == LDV_STATE_CREATE)
1107                                     ctr->c.ldv.not_used = real_size;
1108                                 else
1109                                     ctr->c.ldv.used = real_size;
1110                             } else
1111 #endif
1112                             {
1113                                 ctr->c.resid = real_size;
1114                             }
1115                         }
1116                     }
1117                 }
1118             }
1119
1120             p += size;
1121         }
1122     }
1123 }
1124
1125 void
1126 heapCensus( void )
1127 {
1128   nat g, s;
1129   Census *census;
1130
1131   census = &censuses[era];
1132   census->time  = mut_user_time();
1133
1134   // calculate retainer sets if necessary
1135 #ifdef PROFILING
1136   if (doingRetainerProfiling()) {
1137       retainerProfile();
1138   }
1139 #endif
1140
1141 #ifdef PROFILING
1142   stat_startHeapCensus();
1143 #endif
1144
1145   // Traverse the heap, collecting the census info
1146
1147   // First the small_alloc_list: we have to fix the free pointer at
1148   // the end by calling tidyAllocatedLists() first.
1149   tidyAllocateLists();
1150   heapCensusChain( census, small_alloc_list );
1151
1152   // Now traverse the heap in each generation/step.
1153   if (RtsFlags.GcFlags.generations == 1) {
1154       heapCensusChain( census, g0s0->blocks );
1155   } else {
1156       for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
1157           for (s = 0; s < generations[g].n_steps; s++) {
1158               heapCensusChain( census, generations[g].steps[s].blocks );
1159               // Are we interested in large objects?  might be
1160               // confusing to include the stack in a heap profile.
1161               heapCensusChain( census, generations[g].steps[s].large_objects );
1162           }
1163       }
1164   }
1165
1166   // dump out the census info
1167 #ifdef PROFILING
1168     // We can't generate any info for LDV profiling until
1169     // the end of the run...
1170     if (!doingLDVProfiling())
1171         dumpCensus( census );
1172 #else
1173     dumpCensus( census );
1174 #endif
1175
1176
1177   // free our storage, unless we're keeping all the census info for
1178   // future restriction by biography.
1179 #ifdef PROFILING
1180   if (RtsFlags.ProfFlags.bioSelector == NULL)
1181   {
1182       freeHashTable( census->hash, NULL/* don't free the elements */ );
1183       arenaFree( census->arena );
1184       census->hash = NULL;
1185       census->arena = NULL;
1186   }
1187 #endif
1188
1189   // we're into the next time period now
1190   nextEra();
1191
1192 #ifdef PROFILING
1193   stat_endHeapCensus();
1194 #endif
1195 }
1196