GHC.Cmm.Graph

Documentation

type CmmAGraph = OrdList CgStmt

CmmAGraph is a chunk of code consisting of:

• ordinary statements (assignments, stores etc.)
• jumps
• labels
• out-of-line labelled blocks

The semantics is that control falls through labels and out-of-line blocks. Everything after a jump up to the next label is by definition unreachable code, and will be discarded.

Two CmmAGraphs can be stuck together with *, with the meaning that control flows from the first to the second.

A CmmAGraph can be turned into a CmmGraph (closed at both ends) by providing a label for the entry point and a tick scope; see labelAGraph.

type CmmAGraphScoped = (CmmAGraph, CmmTickScope)

Unlabeled graph with tick scope

data CgStmt

Constructors

CgLabel BlockId CmmTickScope

CgStmt (CmmNode O O)

CgLast (CmmNode O C)

CgFork BlockId CmmAGraph CmmTickScope

(<*>) :: CmmAGraph -> CmmAGraph -> CmmAGraph

catAGraphs :: [CmmAGraph] -> CmmAGraph

mkLabel :: BlockId -> CmmTickScope -> CmmAGraph

creates a sequence "goto id; id:" as an AGraph

mkMiddle :: CmmNode O O -> CmmAGraph

creates an open AGraph from a given node

mkLast :: CmmNode O C -> CmmAGraph

creates a closed AGraph from a given node

outOfLine :: BlockId -> CmmAGraphScoped -> CmmAGraph

A labelled code block; should end in a last node

lgraphOfAGraph :: CmmAGraphScoped -> UniqSM CmmGraph

allocate a fresh label for the entry point

labelAGraph :: BlockId -> CmmAGraphScoped -> CmmGraph

use the given BlockId as the label of the entry point

stackStubExpr :: Width -> CmmExpr

mkNop :: CmmAGraph

mkAssign :: CmmReg -> CmmExpr -> CmmAGraph

mkStore :: CmmExpr -> CmmExpr -> CmmAGraph

Assumes natural alignment

mkUnsafeCall :: ForeignTarget -> [CmmFormal] -> [CmmActual] -> CmmAGraph

mkFinalCall :: Profile -> CmmExpr -> CCallConv -> [CmmExpr] -> UpdFrameOffset -> CmmAGraph

mkCallReturnsTo :: Profile -> CmmExpr -> Convention -> [CmmExpr] -> BlockId -> ByteOff -> UpdFrameOffset -> [CmmExpr] -> CmmAGraph

mkJumpReturnsTo :: Profile -> CmmExpr -> Convention -> [CmmExpr] -> BlockId -> ByteOff -> UpdFrameOffset -> CmmAGraph

mkJump :: Profile -> Convention -> CmmExpr -> [CmmExpr] -> UpdFrameOffset -> CmmAGraph

mkJumpExtra :: Profile -> Convention -> CmmExpr -> [CmmExpr] -> UpdFrameOffset -> [CmmExpr] -> CmmAGraph

mkRawJump :: Profile -> CmmExpr -> UpdFrameOffset -> [GlobalReg] -> CmmAGraph

A jump where the caller says what the live GlobalRegs are. Used for low-level hand-written Cmm.

mkCbranch :: CmmExpr -> BlockId -> BlockId -> Maybe Bool -> CmmAGraph

mkSwitch :: CmmExpr -> SwitchTargets -> CmmAGraph

mkReturn :: Profile -> CmmExpr -> [CmmExpr] -> UpdFrameOffset -> CmmAGraph

mkComment :: FastString -> CmmAGraph

mkCallEntry :: Profile -> Convention -> [CmmFormal] -> [CmmFormal] -> (Int, [GlobalReg], CmmAGraph)

mkBranch :: BlockId -> CmmAGraph

mkUnwind :: GlobalReg -> CmmExpr -> CmmAGraph

Construct a CmmUnwind node for the given register and unwinding expression.

copyInOflow :: Profile -> Convention -> Area -> [CmmFormal] -> [CmmFormal] -> (Int, [GlobalReg], CmmAGraph)

copyOutOflow :: Profile -> Convention -> Transfer -> Area -> [CmmExpr] -> UpdFrameOffset -> [CmmExpr] -> (Int, [GlobalReg], CmmAGraph)

noExtraStack :: [CmmExpr]

toCall :: CmmExpr -> Maybe BlockId -> UpdFrameOffset -> ByteOff -> ByteOff -> [GlobalReg] -> CmmAGraph

data Transfer

Constructors

Call

JumpRet

Jump

Ret

Instances

Eq Transfer

Defined in GHC.Cmm.Graph

Methods

(==) :: Transfer -> Transfer -> Bool

(/=) :: Transfer -> Transfer -> Bool