Skip to content
  • chevalier@alum.wellesley.edu's avatar
    Lightweight ticky-ticky profiling · 5ddee764
    chevalier@alum.wellesley.edu authored
    The following changes restore ticky-ticky profiling to functionality
    from its formerly bit-rotted state. Sort of. (It got bit-rotted as part
    of the switch to the C-- back-end.)
    
    The way that ticky-ticky is supposed to work is documented in Section 5.7
    of the GHC manual (though the manual doesn't mention that it hasn't worked
    since sometime around 6.0, alas). Changes from this are as follows (which
    I'll document on the wiki):
    
    * In the past, you had to build all of the libraries with way=t in order to
    use ticky-ticky, because it entailed a different closure layout. No longer.
    You still need to do make way=t in rts/ in order to build the ticky RTS,
    but you should now be able to mix ticky and non-ticky modules.
    
    * Some of the counters that worked in the past aren't implemented yet.
    I was originally just trying to get entry counts to work, so those should
    be correct. The list of counters was never documented in the first place,
    so I hope it's not too much of a disaster that some don't appear anymore.
    Someday, someone (perhaps me) should document all the counters and what 
    they do. For now, all of the counters are either accurate (or at least as
    accurate as they always were), zero, or missing from the ticky profiling
    report altogether.
    
    This hasn't been particularly well-tested, but these changes shouldn't
    affect anything except when compiling with -fticky-ticky (famous last
    words...)
    
    Implementation details:
    
    I got rid of StgTicky.h, which in the past had the macros and declarations 
    for all of the ticky counters. Now, those macros are defined in Cmm.h.
    StgTicky.h was still there for inclusion in C code. Now, any remaining C
    code simply cannot call the ticky macros -- or rather, they do call those
    macros, but from the perspective of C code, they're defined as no-ops. 
    (This shouldn't be too big a problem.)
    
    I added a new file TickyCounter.h that has all the declarations for ticky
    counters, as well as dummy macros for use in C code. Someday, these 
    declarations should really be automatically generated, since they need
    to be kept consistent with the macros defined in Cmm.h.
    
    Other changes include getting rid of the header that was getting added to
    closures before, and getting rid of various code having to do with eager
    blackholing and permanent indirections (the changes under compiler/ 
    and rts/Updates.*).
    5ddee764