CostCentre

Documentation

data CostCentre

A Cost Centre is a single {--} annotation.

Constructors

NormalCC

Fields

• cc_flavour :: CCFlavour

  Two cost centres may have the same name and module but different SrcSpans, so we need a way to distinguish them easily and give them different object-code labels. So every CostCentre has an associated flavour that indicates how it was generated, and flavours that allow multiple instances of the same name and module have a deterministic 0-based index.

• cc_name :: CcName

  Name of the cost centre itself

• cc_mod :: Module

  Name of module defining this CC.

• cc_loc :: SrcSpan

AllCafsCC

Fields

• cc_mod :: Module

  Name of module defining this CC.

• cc_loc :: SrcSpan

Instances

Eq CostCentre

Defined in CostCentre

Methods

(==) :: CostCentre -> CostCentre -> Bool

(/=) :: CostCentre -> CostCentre -> Bool

Data CostCentre

Defined in CostCentre

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CostCentre -> c CostCentre

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CostCentre

toConstr :: CostCentre -> Constr

dataTypeOf :: CostCentre -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CostCentre)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CostCentre)

gmapT :: (forall b. Data b => b -> b) -> CostCentre -> CostCentre

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CostCentre -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CostCentre -> r

gmapQ :: (forall d. Data d => d -> u) -> CostCentre -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CostCentre -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CostCentre -> m CostCentre

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CostCentre -> m CostCentre

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CostCentre -> m CostCentre

Ord CostCentre

Defined in CostCentre

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

Outputable CostCentre

Defined in CostCentre

Methods

ppr :: CostCentre -> SDoc

pprPrec :: Rational -> CostCentre -> SDoc

Binary CostCentre

Defined in CostCentre

Methods

put_ :: BinHandle -> CostCentre -> IO ()

put :: BinHandle -> CostCentre -> IO (Bin CostCentre)

get :: BinHandle -> IO CostCentre

type CcName = FastString

data CCFlavour

The flavour of a cost centre.

Index fields represent 0-based indices giving source-code ordering of centres with the same module, name, and flavour.

Constructors

CafCC

Auto-generated top-level thunk

ExprCC !CostCentreIndex

Explicitly annotated expression

DeclCC !CostCentreIndex

Explicitly annotated declaration

HpcCC !CostCentreIndex

Generated by HPC for coverage

Instances

Eq CCFlavour

Defined in CostCentre

Methods

(==) :: CCFlavour -> CCFlavour -> Bool

(/=) :: CCFlavour -> CCFlavour -> Bool

Data CCFlavour

Defined in CostCentre

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CCFlavour -> c CCFlavour

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CCFlavour

toConstr :: CCFlavour -> Constr

dataTypeOf :: CCFlavour -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CCFlavour)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CCFlavour)

gmapT :: (forall b. Data b => b -> b) -> CCFlavour -> CCFlavour

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CCFlavour -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CCFlavour -> r

gmapQ :: (forall d. Data d => d -> u) -> CCFlavour -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CCFlavour -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CCFlavour -> m CCFlavour

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CCFlavour -> m CCFlavour

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CCFlavour -> m CCFlavour

Ord CCFlavour

Defined in CostCentre

Methods

compare :: CCFlavour -> CCFlavour -> Ordering

(<) :: CCFlavour -> CCFlavour -> Bool

(<=) :: CCFlavour -> CCFlavour -> Bool

(>) :: CCFlavour -> CCFlavour -> Bool

(>=) :: CCFlavour -> CCFlavour -> Bool

max :: CCFlavour -> CCFlavour -> CCFlavour

min :: CCFlavour -> CCFlavour -> CCFlavour

Binary CCFlavour

Defined in CostCentre

Methods

put_ :: BinHandle -> CCFlavour -> IO ()

put :: BinHandle -> CCFlavour -> IO (Bin CCFlavour)

get :: BinHandle -> IO CCFlavour

data CostCentreStack

A Cost Centre Stack is something that can be attached to a closure. This is either:

• the current cost centre stack (CCCS)
• a pre-defined cost centre stack (there are several pre-defined CCSs, see below).

Instances

Eq CostCentreStack

Defined in CostCentre

Methods

(==) :: CostCentreStack -> CostCentreStack -> Bool

(/=) :: CostCentreStack -> CostCentreStack -> Bool

Ord CostCentreStack

Defined in CostCentre

Methods

compare :: CostCentreStack -> CostCentreStack -> Ordering

(<) :: CostCentreStack -> CostCentreStack -> Bool

(<=) :: CostCentreStack -> CostCentreStack -> Bool

(>) :: CostCentreStack -> CostCentreStack -> Bool

(>=) :: CostCentreStack -> CostCentreStack -> Bool

max :: CostCentreStack -> CostCentreStack -> CostCentreStack

min :: CostCentreStack -> CostCentreStack -> CostCentreStack

Outputable CostCentreStack

Defined in CostCentre

Methods

ppr :: CostCentreStack -> SDoc

pprPrec :: Rational -> CostCentreStack -> SDoc

type CollectedCCs = ([CostCentre], [CostCentreStack])

emptyCollectedCCs :: CollectedCCs

collectCC :: CostCentre -> CostCentreStack -> CollectedCCs -> CollectedCCs

currentCCS :: CostCentreStack

dontCareCCS :: CostCentreStack

isCurrentCCS :: CostCentreStack -> Bool

maybeSingletonCCS :: CostCentreStack -> Maybe CostCentre

mkUserCC :: FastString -> Module -> SrcSpan -> CCFlavour -> CostCentre

mkAutoCC :: Id -> Module -> CostCentre

mkAllCafsCC :: Module -> SrcSpan -> CostCentre

mkSingletonCCS :: CostCentre -> CostCentreStack

isCafCCS :: CostCentreStack -> Bool

isCafCC :: CostCentre -> Bool

isSccCountCC :: CostCentre -> Bool

Is this a cost-centre which records scc counts

sccAbleCC :: CostCentre -> Bool

Is this a cost-centre which can be sccd ?

ccFromThisModule :: CostCentre -> Module -> Bool

pprCostCentreCore :: CostCentre -> SDoc

Print a flavour in Core

costCentreUserName :: CostCentre -> String

costCentreUserNameFS :: CostCentre -> FastString

costCentreSrcSpan :: CostCentre -> SrcSpan

cmpCostCentre :: CostCentre -> CostCentre -> Ordering