ghc-lib-9.6.2.20231121: The GHC API, decoupled from GHC versions
Safe HaskellSafe-Inferred
LanguageHaskell2010

GHC.Cmm.Dataflow

Synopsis

Documentation

type C = 'Closed #

type O = 'Open #

data Block (n :: Extensibility -> Extensibility -> Type) (e :: Extensibility) (x :: Extensibility) #

A sequence of nodes. May be any of four shapes (OO, OC, CO, CC). Open at the entry means single entry, mutatis mutandis for exit. A closedclosed block is a basic/ block and can't be extended further. Clients should avoid manipulating blocks and should stick to either nodes or graphs.

Instances

Instances details
OutputableP Platform (Block CmmNode C C) 
Instance details

Defined in GHC.Cmm.Node

Methods

pdoc :: Platform -> Block CmmNode C C -> SDoc #

OutputableP Platform (Block CmmNode C O) 
Instance details

Defined in GHC.Cmm.Node

Methods

pdoc :: Platform -> Block CmmNode C O -> SDoc #

OutputableP Platform (Block CmmNode O C) 
Instance details

Defined in GHC.Cmm.Node

Methods

pdoc :: Platform -> Block CmmNode O C -> SDoc #

OutputableP Platform (Block CmmNode O O) 
Instance details

Defined in GHC.Cmm.Node

Methods

pdoc :: Platform -> Block CmmNode O O -> SDoc #

OutputableP Platform (Graph CmmNode e x) 
Instance details

Defined in GHC.Cmm.Node

Methods

pdoc :: Platform -> Graph CmmNode e x -> SDoc #

NonLocal n => NonLocal (Block n) 
Instance details

Defined in GHC.Cmm.Dataflow.Graph

Methods

entryLabel :: forall (x :: Extensibility). Block n C x -> Label #

successors :: forall (e :: Extensibility). Block n e C -> [Label] #

lastNode :: forall n (x :: Extensibility). Block n x C -> n O C #

entryLabel #

Arguments

:: forall (x :: Extensibility). NonLocal thing 
=> thing C x 
-> Label

The label of a first node or block

foldNodesBwdOO :: (node O O -> f -> f) -> Block node O O -> f -> f Source #

Folds backward over all nodes of an open-open block. Strict in the accumulator.

foldRewriteNodesBwdOO :: forall f node. (node O O -> f -> UniqSM (Block node O O, f)) -> Block node O O -> f -> UniqSM (Block node O O, f) Source #

Folds backward over all the nodes of an open-open block and allows rewriting them. The accumulator is both the block of nodes and f (usually dataflow facts). Strict in both accumulated parts.

data DataflowLattice a Source #

Constructors

DataflowLattice 

Fields

newtype OldFact a Source #

Constructors

OldFact a 

newtype NewFact a Source #

Constructors

NewFact a 

data JoinedFact a Source #

The result of joining OldFact and NewFact.

Constructors

Changed !a

Result is different than OldFact.

NotChanged !a

Result is the same as OldFact.

type RewriteFun f = CmmBlock -> FactBase f -> UniqSM (CmmBlock, FactBase f) Source #

Function for rewriting and analysis combined. To be used with rewriteCmm.

Currently set to work with UniqSM monad, but we could probably abstract that away (if we do that, we might want to specialize the fixpoint algorithms to the particular monads through SPECIALIZE).

type family Fact (x :: Extensibility) f :: Type Source #

Instances

Instances details
type Fact C f Source # 
Instance details

Defined in GHC.Cmm.Dataflow

type Fact C f = FactBase f
type Fact O f Source # 
Instance details

Defined in GHC.Cmm.Dataflow

type Fact O f = f

type FactBase f = LabelMap f #

mkFactBase :: DataflowLattice f -> [(Label, f)] -> FactBase f Source #

Returns the joined facts for each label.

analyzeCmmFwd :: NonLocal node => DataflowLattice f -> TransferFun' node f -> GenCmmGraph node -> FactBase f -> FactBase f Source #

analyzeCmmBwd :: NonLocal node => DataflowLattice f -> TransferFun' node f -> GenCmmGraph node -> FactBase f -> FactBase f Source #

rewriteCmmBwd :: NonLocal node => DataflowLattice f -> RewriteFun' node f -> GenCmmGraph node -> FactBase f -> UniqSM (GenCmmGraph node, FactBase f) Source #

joinOutFacts :: NonLocal n => DataflowLattice f -> n e C -> FactBase f -> f Source #

Returns the result of joining the facts from all the successors of the provided node or block.