Safe Haskell	Safe-Inferred
Language	Haskell2010

GHC.Prof

Contents

Parser
Cost-centre tree
Types

Synopsis

decode :: Text -> Either String Profile
decode' :: Text -> Either String Profile
profile :: Parser Profile
data CostCentreTree
aggregatedCostCentres :: Profile -> [AggregatedCostCentre]
aggregatedCostCentresOrderBy :: Ord a => (AggregatedCostCentre -> a) -> Profile -> [AggregatedCostCentre]
costCentres :: Profile -> Maybe (Tree CostCentre)
costCentresOrderBy :: Ord a => (CostCentre -> a) -> Profile -> Maybe (Tree CostCentre)
aggregateCallSites :: Text -> Text -> Profile -> Maybe (AggregatedCostCentre, [CallSite AggregatedCostCentre])
aggregateCallSitesOrderBy :: Ord a => (CallSite AggregatedCostCentre -> a) -> Text -> Text -> Profile -> Maybe (AggregatedCostCentre, [CallSite AggregatedCostCentre])
callSites :: Text -> Text -> Profile -> Maybe (AggregatedCostCentre, [CallSite CostCentre])
callSitesOrderBy :: Ord a => (CallSite CostCentre -> a) -> Text -> Text -> Profile -> Maybe (AggregatedCostCentre, [CallSite CostCentre])
aggregateModules :: Profile -> [AggregateModule]
aggregateModulesOrderBy :: Ord a => (AggregateModule -> a) -> Profile -> [AggregateModule]
data Profile = Profile {
- profileTimestamp :: !LocalTime
- profileCommandLine :: !Text
- profileTotalTime :: !TotalTime
- profileTotalAlloc :: !TotalAlloc
- profileTopCostCentres :: [AggregatedCostCentre]
- profileCostCentreTree :: !CostCentreTree
}
data TotalTime = TotalTime {
- totalTimeElapsed :: !DiffTime
- totalTimeTicks :: !Integer
- totalTimeResolution :: !DiffTime
- totalTimeProcessors :: !(Maybe Int)
}
newtype TotalAlloc = TotalAlloc {
- totalAllocBytes :: Integer
}
data AggregatedCostCentre = AggregatedCostCentre {
- aggregatedCostCentreName :: !Text
- aggregatedCostCentreModule :: !Text
- aggregatedCostCentreSrc :: !(Maybe Text)
- aggregatedCostCentreEntries :: !(Maybe Integer)
- aggregatedCostCentreTime :: !Scientific
- aggregatedCostCentreAlloc :: !Scientific
- aggregatedCostCentreTicks :: !(Maybe Integer)
- aggregatedCostCentreBytes :: !(Maybe Integer)
}
data CostCentre = CostCentre {
- costCentreNo :: !CostCentreNo
- costCentreName :: !Text
- costCentreModule :: !Text
- costCentreSrc :: !(Maybe Text)
- costCentreEntries :: !Integer
- costCentreIndTime :: !Scientific
- costCentreIndAlloc :: !Scientific
- costCentreInhTime :: !Scientific
- costCentreInhAlloc :: !Scientific
- costCentreTicks :: !(Maybe Integer)
- costCentreBytes :: !(Maybe Integer)
}
type CostCentreNo = Int
data CallSite cc = CallSite {
- callSiteCostCentre :: cc
- callSiteContribEntries :: !Integer
- callSiteContribTime :: !Scientific
- callSiteContribAlloc :: !Scientific
- callSiteContribTicks :: !(Maybe Integer)
- callSiteContribBytes :: !(Maybe Integer)
}
data AggregateModule = AggregateModule {
- aggregateModuleName :: !Text
- aggregateModuleEntries :: !(Maybe Integer)
- aggregateModuleTime :: !Scientific
- aggregateModuleAlloc :: !Scientific
- aggregateModuleTicks :: !(Maybe Integer)
- aggregateModuleBytes :: !(Maybe Integer)
}

Documentation

decode :: Text -> Either String Profile Source #

Decode a GHC time allocation profiling report from a lazy Text

decode' :: Text -> Either String Profile Source #

Decode a GHC time allocation profiling report from a strict Text

Parser

profile :: Parser Profile Source #

Parse a GHC time-allocation profiling report

Cost-centre tree

data CostCentreTree Source #

Instances

Instances details

Show CostCentreTree Source #
Instance details Defined in GHC.Prof.Types Methods showsPrec :: Int -> CostCentreTree -> ShowS # show :: CostCentreTree -> String # showList :: [CostCentreTree] -> ShowS #

aggregatedCostCentres :: Profile -> [AggregatedCostCentre] Source #

Build a list of cost-centres from a profiling report ordered by the time spent and the amount of allocation.

aggregatedCostCentresOrderBy Source #

Arguments

:: Ord a
=> (AggregatedCostCentre -> a)	Sorting key function
-> Profile
-> [AggregatedCostCentre]

Build a list of cost-centres from a profling report ordered by the given key.

costCentres :: Profile -> Maybe (Tree CostCentre) Source #

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

costCentresOrderBy Source #

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.

aggregateCallSites Source #

Arguments

:: Text	Cost centre name
-> Text	Module name
-> Profile
-> Maybe (AggregatedCostCentre, [CallSite AggregatedCostCentre])

Build a list of call sites (caller functions of a cost centre) aggregated by their cost centre names and module names.

aggregateCallSitesOrderBy Source #

Arguments

:: Ord a
=> (CallSite AggregatedCostCentre -> a)	Sorting key function
-> Text	Cost centre name
-> Text	Module name
-> Profile
-> Maybe (AggregatedCostCentre, [CallSite AggregatedCostCentre])

Build a list of call sites (caller functions of a cost centre) aggregated by their cost centre names and module names. Call sites are sorted by the given key function.

callSites Source #

Arguments

:: Text	Cost-centre name
-> Text	Module name
-> Profile
-> Maybe (AggregatedCostCentre, [CallSite CostCentre])

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

callSitesOrderBy Source #

Arguments

:: Ord a
=> (CallSite CostCentre -> a)	Sorting key function
-> Text	Cost-centre name
-> Text	Module name
-> Profile
-> Maybe (AggregatedCostCentre, [CallSite CostCentre])

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.

aggregateModules :: Profile -> [AggregateModule] Source #

Break down aggregate cost centres by module sorted by total time and allocation.

aggregateModulesOrderBy Source #

Arguments

:: Ord a
=> (AggregateModule -> a)	Sorting key function
-> Profile
-> [AggregateModule]

Break odwn aggregate cost centres by module.

Types

data Profile Source #

Top-level profiling report

Constructors

Profile
Fields profileTimestamp :: !LocalTime profileCommandLine :: !Text profileTotalTime :: !TotalTime profileTotalAlloc :: !TotalAlloc profileTopCostCentres :: [AggregatedCostCentre] profileCostCentreTree :: !CostCentreTree

Instances

Instances details

Show Profile Source #
Instance details Defined in GHC.Prof.Types Methods showsPrec :: Int -> Profile -> ShowS # show :: Profile -> String # showList :: [Profile] -> ShowS #

data TotalTime Source #

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 :: !(Maybe Int) Number of processors

Instances

Instances details

Show TotalTime Source #
Instance details Defined in GHC.Prof.Types Methods showsPrec :: Int -> TotalTime -> ShowS # show :: TotalTime -> String # showList :: [TotalTime] -> ShowS #

newtype TotalAlloc Source #

total alloc in the profiling reports

Constructors

TotalAlloc
Fields totalAllocBytes :: Integer Total memory allocation in bytes

Instances

Instances details

Show TotalAlloc Source #
Instance details Defined in GHC.Prof.Types Methods showsPrec :: Int -> TotalAlloc -> ShowS # show :: TotalAlloc -> String # showList :: [TotalAlloc] -> ShowS #

data AggregatedCostCentre Source #

Constructors

AggregatedCostCentre

Fields

aggregatedCostCentreName :: !Text
Name of the cost-centre
aggregatedCostCentreModule :: !Text
Module name of the cost-centre
aggregatedCostCentreSrc :: !(Maybe Text)
Source location of the cost-centre
aggregatedCostCentreEntries :: !(Maybe Integer)
Number of entries to the cost-centre
aggregatedCostCentreTime :: !Scientific
Total time spent in the cost-centre
aggregatedCostCentreAlloc :: !Scientific
Total allocation in the cost-centre
aggregatedCostCentreTicks :: !(Maybe Integer)
Total ticks in the cost-centre. This number exists only if -P or -Pa option is given at run-time.
aggregatedCostCentreBytes :: !(Maybe Integer)
Total memory allocation in the cost-centre. This number exists only if -P or -Pa option is given at run-time.

Instances

Instances details

Show AggregatedCostCentre Source #
Instance details Defined in GHC.Prof.Types Methods showsPrec :: Int -> AggregatedCostCentre -> ShowS # show :: AggregatedCostCentre -> String # showList :: [AggregatedCostCentre] -> ShowS #
Eq AggregatedCostCentre Source #
Instance details Defined in GHC.Prof.Types Methods (==) :: AggregatedCostCentre -> AggregatedCostCentre -> Bool # (/=) :: AggregatedCostCentre -> AggregatedCostCentre -> Bool #
Ord AggregatedCostCentre Source #
Instance details Defined in GHC.Prof.Types Methods compare :: AggregatedCostCentre -> AggregatedCostCentre -> Ordering # (<) :: AggregatedCostCentre -> AggregatedCostCentre -> Bool # (<=) :: AggregatedCostCentre -> AggregatedCostCentre -> Bool # (>) :: AggregatedCostCentre -> AggregatedCostCentre -> Bool # (>=) :: AggregatedCostCentre -> AggregatedCostCentre -> Bool # max :: AggregatedCostCentre -> AggregatedCostCentre -> AggregatedCostCentre # min :: AggregatedCostCentre -> AggregatedCostCentre -> AggregatedCostCentre #

data CostCentre Source #

Cost-centre node

Constructors

CostCentre

Fields

costCentreNo :: !CostCentreNo
Identifier of the cost-centre
costCentreName :: !Text
Name of the cost-centre
costCentreModule :: !Text
Module name of the cost-centre
costCentreSrc :: !(Maybe Text)
Source location 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

Instances details

Show CostCentre Source #
Instance details Defined in GHC.Prof.Types Methods showsPrec :: Int -> CostCentre -> ShowS # show :: CostCentre -> String # showList :: [CostCentre] -> ShowS #
Eq CostCentre Source #
Instance details Defined in GHC.Prof.Types Methods (==) :: CostCentre -> CostCentre -> Bool # (/=) :: CostCentre -> CostCentre -> Bool #
Ord CostCentre Source #
Instance details Defined in GHC.Prof.Types Methods compare :: CostCentre -> CostCentre -> Ordering # (<) :: CostCentre -> CostCentre -> Bool # (<=) :: CostCentre -> CostCentre -> Bool # (>) :: CostCentre -> CostCentre -> Bool # (>=) :: CostCentre -> CostCentre -> Bool # max :: CostCentre -> CostCentre -> CostCentre # min :: CostCentre -> CostCentre -> CostCentre #

type CostCentreNo = Int Source #

data CallSite cc Source #

Constructors

CallSite

Fields

callSiteCostCentre :: cc
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

Instances details

Show cc => Show (CallSite cc) Source #
Instance details Defined in GHC.Prof.Types Methods showsPrec :: Int -> CallSite cc -> ShowS # show :: CallSite cc -> String # showList :: [CallSite cc] -> ShowS #

data AggregateModule Source #

Constructors

AggregateModule

Fields

aggregateModuleName :: !Text
Name of the module
aggregateModuleEntries :: !(Maybe Integer)
Total number of entries to cost centres in the module
aggregateModuleTime :: !Scientific
Total time spent on cost centres in the module
aggregateModuleAlloc :: !Scientific
Total allocation on cost centres in the module
aggregateModuleTicks :: !(Maybe Integer)
Total ticks on cost centres in the module. This number exists only if -P or -Pa option is given at run-time.
aggregateModuleBytes :: !(Maybe Integer)
Total memory allocation on cost centres in the module. This number exists only if -P or -Pa option is given at run-time.

Instances

Instances details

Show AggregateModule Source #
Instance details Defined in GHC.Prof.Types Methods showsPrec :: Int -> AggregateModule -> ShowS # show :: AggregateModule -> String # showList :: [AggregateModule] -> ShowS #
Eq AggregateModule Source #
Instance details Defined in GHC.Prof.Types Methods (==) :: AggregateModule -> AggregateModule -> Bool # (/=) :: AggregateModule -> AggregateModule -> Bool #
Ord AggregateModule Source #
Instance details Defined in GHC.Prof.Types Methods compare :: AggregateModule -> AggregateModule -> Ordering # (<) :: AggregateModule -> AggregateModule -> Bool # (<=) :: AggregateModule -> AggregateModule -> Bool # (>) :: AggregateModule -> AggregateModule -> Bool # (>=) :: AggregateModule -> AggregateModule -> Bool # max :: AggregateModule -> AggregateModule -> AggregateModule # min :: AggregateModule -> AggregateModule -> AggregateModule #