ghc-9.0.1: The GHC API
Safe HaskellNone
LanguageHaskell2010

GHC.Types.CostCentre

Synopsis

Documentation

data CostCentre Source #

A Cost Centre is a single {-# SCC #-} 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

Instances

Instances details
Eq CostCentre # 
Instance details

Defined in GHC.Types.CostCentre

Data CostCentre # 
Instance details

Defined in GHC.Types.CostCentre

Methods

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

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

toConstr :: CostCentre -> Constr Source #

dataTypeOf :: CostCentre -> DataType Source #

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

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

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

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

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

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

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

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

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

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

Ord CostCentre # 
Instance details

Defined in GHC.Types.CostCentre

Outputable CostCentre # 
Instance details

Defined in GHC.Types.CostCentre

Binary CostCentre # 
Instance details

Defined in GHC.Types.CostCentre

data CCFlavour Source #

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

Instances details
Eq CCFlavour # 
Instance details

Defined in GHC.Types.CostCentre

Data CCFlavour # 
Instance details

Defined in GHC.Types.CostCentre

Methods

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

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

toConstr :: CCFlavour -> Constr Source #

dataTypeOf :: CCFlavour -> DataType Source #

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

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

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

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

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

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

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

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

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

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

Ord CCFlavour # 
Instance details

Defined in GHC.Types.CostCentre

Binary CCFlavour # 
Instance details

Defined in GHC.Types.CostCentre

data CostCentreStack Source #

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).

isSccCountCC :: CostCentre -> Bool Source #

Is this a cost-centre which records scc counts

sccAbleCC :: CostCentre -> Bool Source #

Is this a cost-centre which can be sccd ?

pprCostCentreCore :: CostCentre -> SDoc Source #

Print a flavour in Core