ghc/rts/ProfHeap.c

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