ghc/rts/ProfHeap.c

   1 /* -----------------------------------------------------------------------------
   2  * $Id: ProfHeap.c,v 1.43 2003/02/20 15:39:59 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        // We must check that the retainer set is valid here.  One
 597        // reason it might not be valid is if this closure is a
 598        // a newly deceased weak pointer (i.e. a DEAD_WEAK), since
 599        // these aren't reached by the retainer profiler's traversal.
 600        if (isRetainerSetFieldValid((StgClosure *)p)) {
 601            rs = retainerSetOf((StgClosure *)p);
 602            if (rs != NULL) {
 603                for (i = 0; i < rs->num; i++) {
 604                    b = strMatchesSelector( rs->element[i]->cc->label,
 605                                            RtsFlags.ProfFlags.retainerSelector );
 606                    if (b) return rtsTrue;
 607                }
 608            }
 609        }
 610        return rtsFalse;
 611    }
 612    return rtsTrue;
 613 #endif /* PROFILING */
 614 }
 615
 616 /* -----------------------------------------------------------------------------
 617  * Aggregate the heap census info for biographical profiling
 618  * -------------------------------------------------------------------------- */
 619 #ifdef PROFILING
 620 static void
 621 aggregateCensusInfo( void )
 622 {
 623     HashTable *acc;
 624     nat t;
 625     counter *c, *d, *ctrs;
 626     Arena *arena;
 627
 628     if (!doingLDVProfiling()) return;
 629
 630     // Aggregate the LDV counters when displaying by biography.
 631     if (RtsFlags.ProfFlags.doHeapProfile == HEAP_BY_LDV) {
 632         int void_total, drag_total;
 633
 634         // Now we compute void_total and drag_total for each census
 635         void_total = 0;
 636         drag_total = 0;
 637         for (t = 1; t < era; t++) { // note: start at 1, not 0
 638             void_total += censuses[t].void_total;
 639             drag_total += censuses[t].drag_total;
 640             censuses[t].void_total = void_total;
 641             censuses[t].drag_total = drag_total;
 642             ASSERT( censuses[t].void_total <= censuses[t].not_used );
 643             ASSERT( censuses[t].drag_total <= censuses[t].used );
 644         }
 645
 646         return;
 647     }
 648
 649     // otherwise... we're doing a heap profile that is restricted to
 650     // some combination of lag, drag, void or use.  We've kept all the
 651     // census info for all censuses so far, but we still need to
 652     // aggregate the counters forwards.
 653
 654     arena = newArena();
 655     acc = allocHashTable();
 656     ctrs = NULL;
 657
 658     for (t = 1; t < era; t++) {
 659
 660         // first look through all the counters we're aggregating
 661         for (c = ctrs; c != NULL; c = c->next) {
 662             // if one of the totals is non-zero, then this closure
 663             // type must be present in the heap at this census time...
 664             d = lookupHashTable(censuses[t].hash, (StgWord)c->identity);
 665
 666             if (d == NULL) {
 667                 // if this closure identity isn't present in the
 668                 // census for this time period, then our running
 669                 // totals *must* be zero.
 670                 ASSERT(c->c.ldv.void_total == 0 && c->c.ldv.drag_total == 0);
 671
 672                 // fprintCCS(stderr,c->identity);
 673                 // fprintf(stderr," census=%d void_total=%d drag_total=%d\n",
 674                 //         t, c->c.ldv.void_total, c->c.ldv.drag_total);
 675             } else {
 676                 d->c.ldv.void_total += c->c.ldv.void_total;
 677                 d->c.ldv.drag_total += c->c.ldv.drag_total;
 678                 c->c.ldv.void_total =  d->c.ldv.void_total;
 679                 c->c.ldv.drag_total =  d->c.ldv.drag_total;
 680
 681                 ASSERT( c->c.ldv.void_total >= 0 );
 682                 ASSERT( c->c.ldv.drag_total >= 0 );
 683             }
 684         }
 685
 686         // now look through the counters in this census to find new ones
 687         for (c = censuses[t].ctrs; c != NULL; c = c->next) {
 688             d = lookupHashTable(acc, (StgWord)c->identity);
 689             if (d == NULL) {
 690                 d = arenaAlloc( arena, sizeof(counter) );
 691                 initLDVCtr(d);
 692                 insertHashTable( acc, (StgWord)c->identity, d );
 693                 d->identity = c->identity;
 694                 d->next = ctrs;
 695                 ctrs = d;
 696                 d->c.ldv.void_total = c->c.ldv.void_total;
 697                 d->c.ldv.drag_total = c->c.ldv.drag_total;
 698             }
 699             ASSERT( c->c.ldv.void_total >= 0 );
 700             ASSERT( c->c.ldv.drag_total >= 0 );
 701         }
 702     }
 703
 704     freeHashTable(acc, NULL);
 705     arenaFree(arena);
 706 }
 707 #endif
 708
 709 /* -----------------------------------------------------------------------------
 710  * Print out the results of a heap census.
 711  * -------------------------------------------------------------------------- */
 712 static void
 713 dumpCensus( Census *census )
 714 {
 715     counter *ctr;
 716     int count;
 717
 718     fprintf(hp_file, "BEGIN_SAMPLE %0.2f\n", census->time);
 719
 720 #ifdef PROFILING
 721     if (RtsFlags.ProfFlags.doHeapProfile == HEAP_BY_LDV) {
 722         fprintf(hp_file, "VOID\t%u\n", census->void_total * sizeof(W_));
 723         fprintf(hp_file, "LAG\t%u\n",
 724                 (census->not_used - census->void_total) * sizeof(W_));
 725         fprintf(hp_file, "USE\t%u\n",
 726                 (census->used - census->drag_total) * sizeof(W_));
 727         fprintf(hp_file, "INHERENT_USE\t%u\n",
 728                 census->prim * sizeof(W_));
 729         fprintf(hp_file, "DRAG\t%u\n", census->drag_total *
 730                 sizeof(W_));
 731         fprintf(hp_file, "END_SAMPLE %0.2f\n", census->time);
 732         return;
 733     }
 734 #endif
 735
 736     for (ctr = census->ctrs; ctr != NULL; ctr = ctr->next) {
 737
 738 #ifdef PROFILING
 739         if (RtsFlags.ProfFlags.bioSelector != NULL) {
 740             count = 0;
 741             if (strMatchesSelector("lag", RtsFlags.ProfFlags.bioSelector))
 742                 count += ctr->c.ldv.not_used - ctr->c.ldv.void_total;
 743             if (strMatchesSelector("drag", RtsFlags.ProfFlags.bioSelector))
 744                 count += ctr->c.ldv.drag_total;
 745             if (strMatchesSelector("void", RtsFlags.ProfFlags.bioSelector))
 746                 count += ctr->c.ldv.void_total;
 747             if (strMatchesSelector("use", RtsFlags.ProfFlags.bioSelector))
 748                 count += ctr->c.ldv.used - ctr->c.ldv.drag_total;
 749         } else
 750 #endif
 751         {
 752             count = ctr->c.resid;
 753         }
 754
 755         ASSERT( count >= 0 );
 756
 757         if (count == 0) continue;
 758
 759 #ifdef DEBUG_HEAP_PROF
 760         switch (RtsFlags.ProfFlags.doHeapProfile) {
 761         case HEAP_BY_INFOPTR:
 762             fprintf(hp_file, "%s", lookupGHCName(ctr->identity));
 763             break;
 764         case HEAP_BY_CLOSURE_TYPE:
 765             fprintf(hp_file, "%s", (char *)ctr->identity);
 766             break;
 767         }
 768 #endif
 769
 770 #ifdef PROFILING
 771         switch (RtsFlags.ProfFlags.doHeapProfile) {
 772         case HEAP_BY_CCS:
 773             fprint_ccs(hp_file, (CostCentreStack *)ctr->identity, 25);
 774             break;
 775         case HEAP_BY_MOD:
 776         case HEAP_BY_DESCR:
 777         case HEAP_BY_TYPE:
 778             fprintf(hp_file, "%s", (char *)ctr->identity);
 779             break;
 780         case HEAP_BY_RETAINER:
 781         {
 782             RetainerSet *rs = (RetainerSet *)ctr->identity;
 783
 784             // it might be the distinguished retainer set rs_MANY:
 785             if (rs == &rs_MANY) {
 786                 fprintf(hp_file, "MANY");
 787                 break;
 788             }
 789
 790             // Mark this retainer set by negating its id, because it
 791             // has appeared in at least one census.  We print the
 792             // values of all such retainer sets into the log file at
 793             // the end.  A retainer set may exist but not feature in
 794             // any censuses if it arose as the intermediate retainer
 795             // set for some closure during retainer set calculation.
 796             if (rs->id > 0)
 797                 rs->id = -(rs->id);
 798
 799             // report in the unit of bytes: * sizeof(StgWord)
 800             printRetainerSetShort(hp_file, rs);
 801             break;
 802         }
 803         default:
 804             barf("dumpCensus; doHeapProfile");
 805         }
 806 #endif
 807
 808         fprintf(hp_file, "\t%d\n", count * sizeof(W_));
 809     }
 810
 811     fprintf(hp_file, "END_SAMPLE %0.2f\n", census->time);
 812 }
 813
 814 /* -----------------------------------------------------------------------------
 815  * Code to perform a heap census.
 816  * -------------------------------------------------------------------------- */
 817 static void
 818 heapCensusChain( Census *census, bdescr *bd )
 819 {
 820     StgPtr p;
 821     StgInfoTable *info;
 822     void *identity;
 823     nat size;
 824     counter *ctr;
 825     nat real_size;
 826     rtsBool prim;
 827
 828     for (; bd != NULL; bd = bd->link) {
 829         p = bd->start;
 830         while (p < bd->free) {
 831             info = get_itbl((StgClosure *)p);
 832             prim = rtsFalse;
 833
 834             switch (info->type) {
 835
 836             case CONSTR:
 837             case FUN:
 838             case THUNK:
 839             case IND_PERM:
 840             case IND_OLDGEN_PERM:
 841             case CAF_BLACKHOLE:
 842             case SE_CAF_BLACKHOLE:
 843             case SE_BLACKHOLE:
 844             case BLACKHOLE:
 845             case BLACKHOLE_BQ:
 846             case CONSTR_INTLIKE:
 847             case CONSTR_CHARLIKE:
 848             case FUN_1_0:
 849             case FUN_0_1:
 850             case FUN_1_1:
 851             case FUN_0_2:
 852             case FUN_2_0:
 853             case THUNK_1_1:
 854             case THUNK_0_2:
 855             case THUNK_2_0:
 856             case CONSTR_1_0:
 857             case CONSTR_0_1:
 858             case CONSTR_1_1:
 859             case CONSTR_0_2:
 860             case CONSTR_2_0:
 861                 size = sizeW_fromITBL(info);
 862                 break;
 863
 864             case BCO:
 865             case MVAR:
 866             case WEAK:
 867             case FOREIGN:
 868             case STABLE_NAME:
 869             case MUT_VAR:
 870             case MUT_CONS:
 871                 prim = rtsTrue;
 872                 size = sizeW_fromITBL(info);
 873                 break;
 874
 875             case THUNK_1_0:             /* ToDo - shouldn't be here */
 876             case THUNK_0_1:             /* "  ditto  " */
 877             case THUNK_SELECTOR:
 878                 size = sizeofW(StgHeader) + MIN_UPD_SIZE;
 879                 break;
 880
 881             case AP:
 882             case PAP:
 883                 size = pap_sizeW((StgPAP *)p);
 884                 break;
 885
 886             case AP_STACK:
 887                 size = ap_stack_sizeW((StgAP_STACK *)p);
 888                 break;
 889
 890             case ARR_WORDS:
 891                 prim = rtsTrue;
 892                 size = arr_words_sizeW(stgCast(StgArrWords*,p));
 893                 break;
 894
 895             case MUT_ARR_PTRS:
 896             case MUT_ARR_PTRS_FROZEN:
 897                 prim = rtsTrue;
 898                 size = mut_arr_ptrs_sizeW((StgMutArrPtrs *)p);
 899                 break;
 900
 901             case TSO:
 902                 prim = rtsTrue;
 903 #ifdef DEBUG_HEAP_PROF
 904                 size = tso_sizeW((StgTSO *)p);
 905                 break;
 906 #else
 907                 if (RtsFlags.ProfFlags.includeTSOs) {
 908                     size = tso_sizeW((StgTSO *)p);
 909                     break;
 910                 } else {
 911                     // Skip this TSO and move on to the next object
 912                     p += tso_sizeW((StgTSO *)p);
 913                     continue;
 914                 }
 915 #endif
 916
 917             default:
 918                 barf("heapCensus");
 919             }
 920
 921             identity = NULL;
 922
 923 #ifdef DEBUG_HEAP_PROF
 924             real_size = size;
 925 #else
 926             // subtract the profiling overhead
 927             real_size = size - sizeofW(StgProfHeader);
 928 #endif
 929
 930             if (closureSatisfiesConstraints((StgClosure*)p)) {
 931 #ifdef PROFILING
 932                 if (RtsFlags.ProfFlags.doHeapProfile == HEAP_BY_LDV) {
 933                     if (prim)
 934                         census->prim += real_size;
 935                     else if ((LDVW(p) & LDV_STATE_MASK) == LDV_STATE_CREATE)
 936                         census->not_used += real_size;
 937                     else
 938                         census->used += real_size;
 939                 } else
 940 #endif
 941                 {
 942                     identity = closureIdentity((StgClosure *)p);
 943
 944                     if (identity != NULL) {
 945                         ctr = lookupHashTable( census->hash, (StgWord)identity );
 946                         if (ctr != NULL) {
 947 #ifdef PROFILING
 948                             if (RtsFlags.ProfFlags.bioSelector != NULL) {
 949                                 if (prim)
 950                                     ctr->c.ldv.prim += real_size;
 951                                 else if ((LDVW(p) & LDV_STATE_MASK) == LDV_STATE_CREATE)
 952                                     ctr->c.ldv.not_used += real_size;
 953                                 else
 954                                     ctr->c.ldv.used += real_size;
 955                             } else
 956 #endif
 957                             {
 958                                 ctr->c.resid += real_size;
 959                             }
 960                         } else {
 961                             ctr = arenaAlloc( census->arena, sizeof(counter) );
 962                             initLDVCtr(ctr);
 963                             insertHashTable( census->hash, (StgWord)identity, ctr );
 964                             ctr->identity = identity;
 965                             ctr->next = census->ctrs;
 966                             census->ctrs = ctr;
 967
 968 #ifdef PROFILING
 969                             if (RtsFlags.ProfFlags.bioSelector != NULL) {
 970                                 if (prim)
 971                                     ctr->c.ldv.prim = real_size;
 972                                 else if ((LDVW(p) & LDV_STATE_MASK) == LDV_STATE_CREATE)
 973                                     ctr->c.ldv.not_used = real_size;
 974                                 else
 975                                     ctr->c.ldv.used = real_size;
 976                             } else
 977 #endif
 978                             {
 979                                 ctr->c.resid = real_size;
 980                             }
 981                         }
 982                     }
 983                 }
 984             }
 985
 986             p += size;
 987         }
 988     }
 989 }
 990
 991 void
 992 heapCensus( void )
 993 {
 994   nat g, s;
 995   Census *census;
 996
 997   census = &censuses[era];
 998   census->time  = mut_user_time();
 999
1000   // calculate retainer sets if necessary
1001 #ifdef PROFILING
1002   if (doingRetainerProfiling()) {
1003       retainerProfile();
1004   }
1005 #endif
1006
1007 #ifdef PROFILING
1008   stat_startHeapCensus();
1009 #endif
1010
1011   // Traverse the heap, collecting the census info
1012
1013   // First the small_alloc_list: we have to fix the free pointer at
1014   // the end by calling tidyAllocatedLists() first.
1015   tidyAllocateLists();
1016   heapCensusChain( census, small_alloc_list );
1017
1018   // Now traverse the heap in each generation/step.
1019   if (RtsFlags.GcFlags.generations == 1) {
1020       heapCensusChain( census, g0s0->to_blocks );
1021   } else {
1022       for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
1023           for (s = 0; s < generations[g].n_steps; s++) {
1024               heapCensusChain( census, generations[g].steps[s].blocks );
1025               // Are we interested in large objects?  might be
1026               // confusing to include the stack in a heap profile.
1027               heapCensusChain( census, generations[g].steps[s].large_objects );
1028           }
1029       }
1030   }
1031
1032   // dump out the census info
1033 #ifdef PROFILING
1034     // We can't generate any info for LDV profiling until
1035     // the end of the run...
1036     if (!doingLDVProfiling())
1037         dumpCensus( census );
1038 #else
1039     dumpCensus( census );
1040 #endif
1041
1042
1043   // free our storage, unless we're keeping all the census info for
1044   // future restriction by biography.
1045 #ifdef PROFILING
1046   if (RtsFlags.ProfFlags.bioSelector == NULL)
1047 #endif
1048   {
1049       freeHashTable( census->hash, NULL/* don't free the elements */ );
1050       arenaFree( census->arena );
1051       census->hash = NULL;
1052       census->arena = NULL;
1053   }
1054
1055   // we're into the next time period now
1056   nextEra();
1057
1058 #ifdef PROFILING
1059   stat_endHeapCensus();
1060 #endif
1061 }
1062
1063 #endif /* PROFILING || DEBUG_HEAP_PROF */
1064