https://github.com/ndmitchell/profiterole

GHC prof manipulation script
https://github.com/ndmitchell/profiterole

Last synced: 10 days ago
JSON representation

GHC prof manipulation script

• Host: GitHub
• URL: https://github.com/ndmitchell/profiterole
• Owner: ndmitchell
• License: other
• Created: 2017-05-25T20:31:02.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-02-04T16:25:11.000Z (9 months ago)
• Last Synced: 2024-10-13T06:15:33.964Z (24 days ago)
• Language: Haskell
• Size: 58.6 KB
• Stars: 30
• Watchers: 7
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.txt
  • License: LICENSE

Awesome Lists containing this project

README

        
# Profiterole [![Hackage version](https://img.shields.io/hackage/v/profiterole.svg?label=Hackage)](https://hackage.haskell.org/package/profiterole) [![Stackage version](https://www.stackage.org/package/profiterole/badge/nightly?label=Stackage)](https://www.stackage.org/package/profiterole) [![Build status](https://img.shields.io/github/actions/workflow/status/ndmitchell/profiterole/ci.yml?branch=master)](https://github.com/ndmitchell/profiterole/actions)

Script for reading and restructuring a GHC profile script.

## The Goal

Given profile data, different ways of looking at it reveal different insights. This tool provides one of those insights - in addition to reading the standard profile output and using other tools such as [Profiteur](https://hackage.haskell.org/package/profiteur).

Profiterole aims to make the profile shorter by combining common subtrees and lifting them to the root - e.g. if you call `parseFile` from 7 places in the code, instead of having 7 pieces of `parseFile` profiling, Profiterole will give you one.

As an example compare [HLint profile input](https://gist.github.com/ndmitchell/308cd9a2774873c9a74ee613ae203b65#file-hlint-prof) to [HLint Profiterole output](https://gist.github.com/ndmitchell/ab790bbfa482a70fa2db020fda623309#file-hlint-profiterole-txt).

## Usage

To run, first install (`cabal update && cabal install profiterole`), generate a GHC profile the [normal way](https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/profiling.html), then run:

    profiterole myprogram.prof

Profiterole will generate `myprogram.profiterole.txt` and `myprogram.profiterole.html` - both contain the same information, but the HTML has hyperlinks. There are three columns of numbers:

* `TOT` is the total time spent in any item under this code, what GHC calls inherited time.

* `INH` is the total time spent in the items that Profiterole did not move out to the top level.

* `IND` is the individual time, just like GHC profiles.

For large programs, using `+RTS -P` (instead of the common `-p`) will give more accurate results.