ghc-6.12.3: The GHC APISource codeContentsIndex
The IdDetails type
The IdInfo type
Zapping various forms of Info
The ArityInfo type
Demand and strictness Info
The WorkerInfo type
Unfolding Info
The InlinePragInfo type
The OccInfo type
The SpecInfo type
The CAFInfo type
The LBVarInfo type
Tick-box Info
data IdDetails
= VanillaId
| RecSelId {
sel_tycon :: TyCon
sel_naughty :: Bool
| DataConWorkId DataCon
| DataConWrapId DataCon
| ClassOpId Class
| PrimOpId PrimOp
| FCallId ForeignCall
| TickBoxOpId TickBoxOp
| DFunId
pprIdDetails :: IdDetails -> SDoc
data IdInfo
vanillaIdInfo :: IdInfo
noCafIdInfo :: IdInfo
seqIdInfo :: IdInfo -> ()
megaSeqIdInfo :: IdInfo -> ()
zapLamInfo :: IdInfo -> Maybe IdInfo
zapDemandInfo :: IdInfo -> Maybe IdInfo
zapFragileInfo :: IdInfo -> Maybe IdInfo
type ArityInfo = Arity
unknownArity :: Arity
arityInfo :: IdInfo -> ArityInfo
setArityInfo :: IdInfo -> ArityInfo -> IdInfo
ppArityInfo :: Int -> SDoc
newStrictnessInfo :: IdInfo -> Maybe StrictSig
setNewStrictnessInfo :: IdInfo -> Maybe StrictSig -> IdInfo
newDemandInfo :: IdInfo -> Maybe Demand
setNewDemandInfo :: IdInfo -> Maybe Demand -> IdInfo
pprNewStrictness :: Maybe StrictSig -> SDoc
setAllStrictnessInfo :: IdInfo -> Maybe StrictSig -> IdInfo
data WorkerInfo
= NoWorker
| HasWorker Id Arity
workerExists :: WorkerInfo -> Bool
wrapperArity :: WorkerInfo -> Arity
workerId :: WorkerInfo -> Id
workerInfo :: IdInfo -> WorkerInfo
setWorkerInfo :: IdInfo -> WorkerInfo -> IdInfo
ppWorkerInfo :: WorkerInfo -> SDoc
unfoldingInfo :: IdInfo -> Unfolding
setUnfoldingInfo :: IdInfo -> Unfolding -> IdInfo
setUnfoldingInfoLazily :: IdInfo -> Unfolding -> IdInfo
type InlinePragInfo = InlinePragma
inlinePragInfo :: IdInfo -> InlinePragma
setInlinePragInfo :: IdInfo -> InlinePragma -> IdInfo
data OccInfo
= NoOccInfo
| IAmDead
| OneOcc !InsideLam !OneBranch !InterestingCxt
| IAmALoopBreaker !RulesOnly
isFragileOcc :: OccInfo -> Bool
isDeadOcc :: OccInfo -> Bool
isLoopBreaker :: OccInfo -> Bool
occInfo :: IdInfo -> OccInfo
setOccInfo :: IdInfo -> OccInfo -> IdInfo
type InsideLam = Bool
type OneBranch = Bool
insideLam :: InsideLam
notInsideLam :: InsideLam
oneBranch :: OneBranch
notOneBranch :: OneBranch
data SpecInfo = SpecInfo [CoreRule] VarSet
isEmptySpecInfo :: SpecInfo -> Bool
specInfoFreeVars :: SpecInfo -> VarSet
specInfoRules :: SpecInfo -> [CoreRule]
seqSpecInfo :: SpecInfo -> ()
setSpecInfoHead :: Name -> SpecInfo -> SpecInfo
specInfo :: IdInfo -> SpecInfo
setSpecInfo :: IdInfo -> SpecInfo -> IdInfo
data CafInfo
= MayHaveCafRefs
| NoCafRefs
ppCafInfo :: CafInfo -> SDoc
mayHaveCafRefs :: CafInfo -> Bool
cafInfo :: IdInfo -> CafInfo
setCafInfo :: IdInfo -> CafInfo -> IdInfo
data LBVarInfo
= NoLBVarInfo
| IsOneShotLambda
noLBVarInfo :: LBVarInfo
hasNoLBVarInfo :: LBVarInfo -> Bool
lbvarInfo :: IdInfo -> LBVarInfo
setLBVarInfo :: IdInfo -> LBVarInfo -> IdInfo
data TickBoxOp = TickBox Module !TickBoxId
type TickBoxId = Int
The IdDetails type
data IdDetails Source
The IdDetails of an Id give stable, and necessary, information about the Id.
RecSelIdThe Id for a record selector
sel_tycon :: TyConFor a data type family, this is the instance TyCon not the family TyCon
sel_naughty :: Bool
DataConWorkId DataConThe Id is for a data constructor worker
DataConWrapId DataConThe Id is for a data constructor wrapper
ClassOpId ClassThe Id is an operation of a class
PrimOpId PrimOpThe Id is for a primitive operator
FCallId ForeignCallThe Id is for a foreign call
TickBoxOpId TickBoxOpThe Id is for a HPC tick box (both traditional and binary)
DFunIdA dictionary function. We don't use this in an essential way, currently, but it's kind of nice that we can keep track of which Ids are DFuns, across module boundaries too
show/hide Instances
pprIdDetails :: IdDetails -> SDocSource
The IdInfo type
data IdInfo Source

An IdInfo gives optional information about an Id. If present it never lies, but it may not be present, in which case there is always a conservative assumption which can be made.

Two Ids may have different info even though they have the same Unique (and are hence the same Id); for example, one might lack the properties attached to the other.

The IdInfo gives information about the value, or definition, of the Id. It does not contain information about the Id's usage, except for demandInfo and lbvarInfo.

vanillaIdInfo :: IdInfoSource
Basic IdInfo that carries no useful information whatsoever
noCafIdInfo :: IdInfoSource
More informative IdInfo we can use when we know the Id has no CAF references
seqIdInfo :: IdInfo -> ()Source
Just evaluate the IdInfo to WHNF
megaSeqIdInfo :: IdInfo -> ()Source
Evaluate all the fields of the IdInfo that are generally demanded by the compiler
Zapping various forms of Info
zapLamInfo :: IdInfo -> Maybe IdInfoSource

This is used to remove information on lambda binders that we have setup as part of a lambda group, assuming they will be applied all at once, but turn out to be part of an unsaturated lambda as in e.g:

 (\x1. \x2. e) arg1
zapDemandInfo :: IdInfo -> Maybe IdInfoSource
Remove demand info on the IdInfo if it is present, otherwise return Nothing
zapFragileInfo :: IdInfo -> Maybe IdInfoSource
Zap info that depends on free variables
The ArityInfo type
type ArityInfo = AritySource

An ArityInfo of n tells us that partial application of this Id to up to n-1 value arguments does essentially no work.

That is not necessarily the same as saying that it has n leading lambdas, because coerces may get in the way.

The arity might increase later in the compilation process, if an extra lambda floats up to the binding site.

unknownArity :: AritySource
It is always safe to assume that an Id has an arity of 0
arityInfo :: IdInfo -> ArityInfoSource
Id arity
setArityInfo :: IdInfo -> ArityInfo -> IdInfoSource
ppArityInfo :: Int -> SDocSource
Demand and strictness Info
newStrictnessInfo :: IdInfo -> Maybe StrictSigSource
Id strictness information. Reason for Maybe: the DmdAnal phase needs to know whether this is the first visit, so it can assign botSig. Other customers want topSig. So Nothing is good.
setNewStrictnessInfo :: IdInfo -> Maybe StrictSig -> IdInfoSource
newDemandInfo :: IdInfo -> Maybe DemandSource
Id demand information. Similarly we want to know if there's no known demand yet, for when we are looking for CPR info
setNewDemandInfo :: IdInfo -> Maybe Demand -> IdInfoSource
pprNewStrictness :: Maybe StrictSig -> SDocSource
setAllStrictnessInfo :: IdInfo -> Maybe StrictSig -> IdInfoSource
Set old and new strictness information together
The WorkerInfo type
data WorkerInfo Source
If this Id has a worker then we store a reference to it. Worker functions are generated by the worker/wrapper pass, using information information from strictness analysis.
NoWorkerNo known worker function
HasWorker Id ArityThe Arity is the arity of the wrapper at the moment of the worker/wrapper split, which may be different from the current Id Aritiy
workerExists :: WorkerInfo -> BoolSource
wrapperArity :: WorkerInfo -> AritySource
The Arity of the worker function at the time of the split if it exists, or a panic otherwise
workerId :: WorkerInfo -> IdSource
The Id of the worker function if it exists, or a panic otherwise
workerInfo :: IdInfo -> WorkerInfoSource
Pointer to worker function. Within one module this is irrelevant; the inlining of a worker is handled via the Unfolding. However, when the module is imported by others, the WorkerInfo is used only to indicate the form of the RHS, so that interface files don't actually need to contain the RHS; it can be derived from the strictness info
setWorkerInfo :: IdInfo -> WorkerInfo -> IdInfoSource
ppWorkerInfo :: WorkerInfo -> SDocSource
Unfolding Info
unfoldingInfo :: IdInfo -> UnfoldingSource
The Ids unfolding
setUnfoldingInfo :: IdInfo -> Unfolding -> IdInfoSource
setUnfoldingInfoLazily :: IdInfo -> Unfolding -> IdInfoSource
The InlinePragInfo type
type InlinePragInfo = InlinePragmaSource

Tells when the inlining is active. When it is active the thing may be inlined, depending on how big it is.

If there was an INLINE pragma, then as a separate matter, the RHS will have been made to look small with a Core inline Note

The default InlinePragInfo is AlwaysActive, so the info serves entirely as a way to inhibit inlining until we want it

inlinePragInfo :: IdInfo -> InlinePragmaSource
Any inline pragma atached to the Id
setInlinePragInfo :: IdInfo -> InlinePragma -> IdInfoSource
The OccInfo type
data OccInfo Source
Identifier occurrence information
NoOccInfoThere are many occurrences, or unknown occurences
IAmDeadMarks unused variables. Sometimes useful for lambda and case-bound variables.
OneOcc !InsideLam !OneBranch !InterestingCxtOccurs exactly once, not inside a rule
IAmALoopBreaker !RulesOnlyThis identifier breaks a loop of mutually recursive functions. The field marks whether it is only a loop breaker due to a reference in a rule
show/hide Instances
isFragileOcc :: OccInfo -> BoolSource
isDeadOcc :: OccInfo -> BoolSource
isLoopBreaker :: OccInfo -> BoolSource
occInfo :: IdInfo -> OccInfoSource
How the Id occurs in the program
setOccInfo :: IdInfo -> OccInfo -> IdInfoSource
type InsideLam = BoolSource
type OneBranch = BoolSource
insideLam :: InsideLamSource
notInsideLam :: InsideLamSource
oneBranch :: OneBranchSource
notOneBranch :: OneBranchSource
The SpecInfo type
data SpecInfo Source
Records the specializations of this Id that we know about in the form of rewrite CoreRules that target them
SpecInfo [CoreRule] VarSet
isEmptySpecInfo :: SpecInfo -> BoolSource
specInfoFreeVars :: SpecInfo -> VarSetSource
Retrieve the locally-defined free variables of both the left and right hand sides of the specialization rules
specInfoRules :: SpecInfo -> [CoreRule]Source
seqSpecInfo :: SpecInfo -> ()Source
setSpecInfoHead :: Name -> SpecInfo -> SpecInfoSource
Change the name of the function the rule is keyed on on all of the CoreRules
specInfo :: IdInfo -> SpecInfoSource
Specialisations of the Ids function which exist
setSpecInfo :: IdInfo -> SpecInfo -> IdInfoSource
The CAFInfo type
data CafInfo Source
Records whether an Id makes Constant Applicative Form references

Indicates that the Id is for either:

1. A function or static constructor that refers to one or more CAFs, or

2. A real live CAF

NoCafRefsA function or static constructor that refers to no CAFs.
show/hide Instances
ppCafInfo :: CafInfo -> SDocSource
mayHaveCafRefs :: CafInfo -> BoolSource
cafInfo :: IdInfo -> CafInfoSource
Id CAF info
setCafInfo :: IdInfo -> CafInfo -> IdInfoSource
The LBVarInfo type
data LBVarInfo Source

If the Id is a lambda-bound variable then it may have lambda-bound variable info. Sometimes we know whether the lambda binding this variable is a "one-shot" lambda; that is, whether it is applied at most once.

This information may be useful in optimisation, as computations may safely be floated inside such a lambda without risk of duplicating work.

NoLBVarInfoNo information
IsOneShotLambdaThe lambda is applied at most once).
show/hide Instances
noLBVarInfo :: LBVarInfoSource
It is always safe to assume that an Id has no lambda-bound variable information
hasNoLBVarInfo :: LBVarInfo -> BoolSource
lbvarInfo :: IdInfo -> LBVarInfoSource
Info about a lambda-bound variable, if the Id is one
setLBVarInfo :: IdInfo -> LBVarInfo -> IdInfoSource
Tick-box Info
data TickBoxOp Source
Tick box for Hpc-style coverage
TickBox Module !TickBoxId
show/hide Instances
type TickBoxId = IntSource
Produced by Haddock version 2.6.1