ghc-7.8.2: The GHC API

Safe HaskellNone
LanguageHaskell98

CostCentre

Synopsis

Documentation

data CostCentre Source

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

type CcName = FastString Source

data IsCafCC Source

Constructors

NotCafCC 
CafCC 

Instances

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

Instances

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

noCCS :: CostCentreStack Source

currentCCS :: CostCentreStack Source

dontCareCCS :: CostCentreStack Source

noCCSAttached :: CostCentreStack -> Bool Source

isCurrentCCS :: CostCentreStack -> Bool Source

maybeSingletonCCS :: CostCentreStack -> Maybe CostCentre Source

mkUserCC :: FastString -> Module -> SrcSpan -> Unique -> CostCentre Source

mkAutoCC :: Id -> Module -> IsCafCC -> CostCentre Source

mkAllCafsCC :: Module -> SrcSpan -> CostCentre Source

mkSingletonCCS :: CostCentre -> CostCentreStack Source

isCafCCS :: CostCentreStack -> Bool Source

isCafCC :: CostCentre -> Bool Source

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 ?

ccFromThisModule :: CostCentre -> Module -> Bool Source

pprCostCentreCore :: CostCentre -> SDoc Source

costCentreUserName :: CostCentre -> String Source

costCentreUserNameFS :: CostCentre -> FastString Source

costCentreSrcSpan :: CostCentre -> SrcSpan Source

cmpCostCentre :: CostCentre -> CostCentre -> Ordering Source