GHC.Prof

Documentation

data Profile

Top-level profiling report

Constructors

Profile

Fields

• profileTimestamp :: !LocalTime
• profileCommandLine :: !Text
• profileTotalTime :: !TotalTime
• profileTotalAlloc :: !TotalAlloc
• profileTopCostCentres :: [AggregateCostCentre]
• profileCostCentreTree :: !CostCentreTree

Instances

Show Profile

Methods

showsPrec :: Int -> Profile -> ShowS

show :: Profile -> String

showList :: [Profile] -> ShowS

data TotalTime

total time in the profiling reports

Constructors

TotalTime

Fields

• totalTimeElapsed :: !DiffTime

  Total elapsed time in seconds

• totalTimeTicks :: !Integer

  Total number of ticks

• totalTimeResolution :: !DiffTime

  Duration of a tick

• totalTimeProcessors :: !Int

  Number of processors

Instances

Show TotalTime

Methods

showsPrec :: Int -> TotalTime -> ShowS

show :: TotalTime -> String

showList :: [TotalTime] -> ShowS

newtype TotalAlloc

total alloc in the profiling reports

Constructors

TotalAlloc

Fields

• totalAllocBytes :: Integer

  Total memory allocation in bytes

Instances

Show TotalAlloc

Methods

showsPrec :: Int -> TotalAlloc -> ShowS

show :: TotalAlloc -> String

showList :: [TotalAlloc] -> ShowS

data AggregateCostCentre

Constructors

AggregateCostCentre

Fields

• aggregateCostCentreName :: !Text

  Name of the cost-centre

• aggregateCostCentreModule :: !Text

  Module name of the cost-centre

• aggregateCostCentreSrc :: !(Maybe Text)

  Source location of the cost-centre

• aggregateCostCentreTime :: !Scientific

  Total time spent in the cost-centre

• aggregateCostCentreAlloc :: !Scientific

  Total allocation in the cost-centre

• aggregateCostCentreTicks :: !(Maybe Integer)

  Total ticks in the cost-centre. This number exists only if -P or -Pa option is given at run-time.

• aggregateCostCentreBytes :: !(Maybe Integer)

  Total memory allocation in the cost-centre. This number exists only if -P or -Pa option is given at run-time.

Instances

Show AggregateCostCentre

Methods

showsPrec :: Int -> AggregateCostCentre -> ShowS

show :: AggregateCostCentre -> String

showList :: [AggregateCostCentre] -> ShowS

data CostCentre

Cost-centre node

Constructors

CostCentre

Fields

• costCentreName :: !Text

  Name of the cost-centre

• costCentreModule :: !Text

  Module name of the cost-centre

• costCentreSrc :: !(Maybe Text)

  Source location of the cost-centre

• costCentreNo :: !CostCentreNo

  Identifier of the cost-centre

• costCentreEntries :: !Integer

  Number of entries to the cost-centre

• costCentreIndTime :: !Scientific

  Time spent in the cost-centre itself

• costCentreIndAlloc :: !Scientific

  Allocation incurred by the cost-centre itself

• costCentreInhTime :: !Scientific

  Time spent in the cost-centre's children

• costCentreInhAlloc :: !Scientific

  Allocation incurred by the cost-centre's children

• costCentreTicks :: !(Maybe Integer)

  Number of ticks in the cost-centre.

• costCentreBytes :: !(Maybe Integer)

  Number of allocated bytes in the cost-centre.

Instances

Show CostCentre

Methods

showsPrec :: Int -> CostCentre -> ShowS

show :: CostCentre -> String

showList :: [CostCentre] -> ShowS

type CostCentreNo = Int

data Callee

Constructors

Callee

Fields

• calleeName :: Text

  Name of the callee function

• calleeModule :: Text

  Module name of the calle function

• calleeEntries :: !Integer

  Number of entries to the callee function

• calleeTime :: !Scientific

  Time spent in the callee function

• calleeAlloc :: !Scientific

  Allocation incurred by the callee function

• calleeTicks :: !(Maybe Integer)

  Number of ticks in the callee function

• calleeBytes :: !(Maybe Integer)

  Number of allocated bytes in the callee function

Instances

Show Callee

Methods

showsPrec :: Int -> Callee -> ShowS

show :: Callee -> String

showList :: [Callee] -> ShowS

data CallSite

Constructors

CallSite

Fields

• callSiteCostCentre :: CostCentre

  Metrics for the caller function

• callSiteContribEntries :: !Integer

  Number of entries contriubted by the caller function

• callSiteContribTime :: !Scientific

  Time contributed by the caller function

• callSiteContribAlloc :: !Scientific

  Allocation contributed by the caller function

• callSiteContribTicks :: !(Maybe Integer)

  Number of tikcs contributed by the caller function

• callSiteContribBytes :: !(Maybe Integer)

  Number of allocated bytes contributed byt hte caller function

Instances

Show CallSite

Methods

showsPrec :: Int -> CallSite -> ShowS

show :: CallSite -> String

showList :: [CallSite] -> ShowS

Parser

profile :: Parser Profile

Cost-centre tree

data CostCentreTree

Instances

Show CostCentreTree

Methods

showsPrec :: Int -> CostCentreTree -> ShowS

show :: CostCentreTree -> String

showList :: [CostCentreTree] -> ShowS

aggregateCostCentres :: Profile -> [AggregateCostCentre]

aggregateCostCentresOrderBy

Arguments

:: Ord a

=> (AggregateCostCentre -> a)

Sorting key function

-> Profile

-> [AggregateCostCentre]

costCentres :: Profile -> Maybe (Tree CostCentre)

Build a tree of cost-centres from a profiling report.

costCentresOrderBy

Arguments

:: Ord a

=> (CostCentre -> a)

Sorting key function

-> Profile

-> Maybe (Tree CostCentre)

Build a tree of cost-centres from a profiling report. Nodes are sorted by the given key function for each level of the tree.

callSites

Arguments

:: Text

Cost-centre name

-> Text

Module name

-> Profile

-> Maybe (Callee, Seq CallSite)

Build a list of call-sites (caller functions) for a specified cost-centre name and module name.

callSitesOrderBy

Arguments

:: Ord a

=> (CostCentre -> a)

Sorting key function

-> Text

Cost-centre name

-> Text

Module name

-> Profile

-> Maybe (Callee, Seq CallSite)

Build a list of call-sites (caller function) for a specified cost-centre name and module name. Nodes are sorted by the given key function.