CostCentre

ghc-8.4.4: The GHC API

Safe Haskell | None
Language | Haskell2010

CostCentre

Synopsis

- data CostCentre
  - = NormalCC {
    - cc_key :: !Int
    - cc_name :: CcName
    - cc_mod :: Module
    - cc_loc :: SrcSpan
    - cc_is_caf :: IsCafCC
    }
  - | AllCafsCC {
    - cc_mod :: Module
    - cc_loc :: SrcSpan
    }
- type CcName = FastString
- data IsCafCC
  - = NotCafCC
  - | CafCC
- data CostCentreStack
- 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 -> Unique -> CostCentre
- mkAutoCC :: Id -> Module -> IsCafCC -> CostCentre
- mkAllCafsCC :: Module -> SrcSpan -> CostCentre
- mkSingletonCCS :: CostCentre -> CostCentreStack
- isCafCCS :: CostCentreStack -> Bool
- isCafCC :: CostCentre -> Bool
- isSccCountCC :: CostCentre -> Bool
- sccAbleCC :: CostCentre -> Bool
- ccFromThisModule :: CostCentre -> Module -> Bool
- pprCostCentreCore :: CostCentre -> SDoc
- costCentreUserName :: CostCentre -> String
- costCentreUserNameFS :: CostCentre -> FastString
- costCentreSrcSpan :: CostCentre -> SrcSpan
- cmpCostCentre :: CostCentre -> CostCentre -> Ordering

# Documentation

data CostCentre #

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

Constructors

NormalCC |
Fields cc_key :: !Int 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 a Unique that is distinct from every other CostCentre in the same module. XXX: should really be using Unique here, but we need to derive Data below and there's no Data instance for Unique. cc_name :: CcName Name of the cost centre itself cc_mod :: Module Name of module defining this CC. cc_loc :: SrcSpan cc_is_caf :: IsCafCC
AllCafsCC |
Fields cc_mod :: Module Name of module defining this CC. cc_loc :: SrcSpan

Instances

Eq CostCentre # |
Instance details Defined in CostCentre Methods (==) :: CostCentre -> CostCentre -> Bool # (/=) :: CostCentre -> CostCentre -> Bool #
Data CostCentre # |
Instance details Defined in 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 :: (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 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 # |
Instance details Defined in CostCentre Methods ppr :: CostCentre -> SDoc # pprPrec :: Rational -> CostCentre -> SDoc #
Binary CostCentre # |
Instance details Defined in CostCentre Methods put_ :: BinHandle -> CostCentre -> IO () # put :: BinHandle -> CostCentre -> IO (Bin CostCentre) # get :: BinHandle -> IO CostCentre #

type CcName = FastString #

data IsCafCC #

Constructors

NotCafCC |
CafCC |

Instances

Eq IsCafCC # |
Instance details Defined in CostCentre Methods (==) :: IsCafCC -> IsCafCC -> Bool # (/=) :: IsCafCC -> IsCafCC -> Bool #
Data IsCafCC # |
Instance details Defined in CostCentre Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IsCafCC -> c IsCafCC Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IsCafCC Source # toConstr :: IsCafCC -> Constr Source # dataTypeOf :: IsCafCC -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c IsCafCC) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IsCafCC) Source # gmapT :: (forall b. Data b => b -> b) -> IsCafCC -> IsCafCC Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IsCafCC -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IsCafCC -> r Source # gmapQ :: (forall d. Data d => d -> u) -> IsCafCC -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> IsCafCC -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> IsCafCC -> m IsCafCC Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IsCafCC -> m IsCafCC Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IsCafCC -> m IsCafCC Source #
Ord IsCafCC # |
Instance details Defined in CostCentre Methods compare :: IsCafCC -> IsCafCC -> Ordering # (<) :: IsCafCC -> IsCafCC -> Bool # (<=) :: IsCafCC -> IsCafCC -> Bool # (>) :: IsCafCC -> IsCafCC -> Bool # (>=) :: IsCafCC -> IsCafCC -> Bool # max :: IsCafCC -> IsCafCC -> IsCafCC # min :: IsCafCC -> IsCafCC -> IsCafCC #
Binary IsCafCC # |
Instance details Defined in CostCentre Methods put_ :: BinHandle -> IsCafCC -> IO () # put :: BinHandle -> IsCafCC -> IO (Bin IsCafCC) # get :: BinHandle -> IO IsCafCC #

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 # |
Instance details Defined in CostCentre Methods (==) :: CostCentreStack -> CostCentreStack -> Bool # (/=) :: CostCentreStack -> CostCentreStack -> Bool #
Ord CostCentreStack # |
Instance details 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 # |
Instance details 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 -> Unique -> CostCentre #

mkAutoCC :: Id -> Module -> IsCafCC -> 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 #

costCentreUserName :: CostCentre -> String #

costCentreUserNameFS :: CostCentre -> FastString #

costCentreSrcSpan :: CostCentre -> SrcSpan #

cmpCostCentre :: CostCentre -> CostCentre -> Ordering #