ghc-9.6.0.20230128: The GHC API
Safe HaskellSafe-Inferred
LanguageHaskell2010

GHC.Cmm

Synopsis

Cmm top-level datatypes

type CmmProgram = [CmmGroup] Source #

type CmmGroup = GenCmmGroup CmmStatics CmmTopInfo CmmGraph Source #

Cmm group before SRT generation

type CmmGroupSRTs = GenCmmGroup RawCmmStatics CmmTopInfo CmmGraph Source #

Cmm group with SRTs

type RawCmmGroup = GenCmmGroup RawCmmStatics (LabelMap RawCmmStatics) CmmGraph Source #

Raw cmm group (TODO (osa): not sure what that means)

type GenCmmGroup d h g = [GenCmmDecl d h g] Source #

type CmmDecl = GenCmmDecl CmmStatics CmmTopInfo CmmGraph Source #

type CmmDeclSRTs = GenCmmDecl RawCmmStatics CmmTopInfo CmmGraph Source #

data GenCmmDecl d h g Source #

A top-level chunk, abstracted over the type of the contents of the basic blocks (Cmm or instructions are the likely instantiations).

Constructors

CmmProc h CLabel [GlobalReg] g 
CmmData Section d 

Instances

Instances details
(OutputableP Platform d, OutputableP Platform info, OutputableP Platform i) => OutputableP Platform (GenCmmDecl d info i) Source # 
Instance details

Defined in GHC.Cmm

Methods

pdoc :: Platform -> GenCmmDecl d info i -> SDoc Source #

Functor (GenCmmDecl d h) Source # 
Instance details

Defined in GHC.Cmm

Methods

fmap :: (a -> b) -> GenCmmDecl d h a -> GenCmmDecl d h b Source #

(<$) :: a -> GenCmmDecl d h b -> GenCmmDecl d h a Source #

type CmmDataDecl = GenCmmDataDecl CmmStatics Source #

cmmDataDeclCmmDecl :: GenCmmDataDecl d -> GenCmmDecl d h g Source #

type CmmGraph = GenCmmGraph CmmNode Source #

data GenCmmGraph n Source #

Constructors

CmmGraph 

Fields

Instances

Instances details
OutputableP Platform CmmGraph Source # 
Instance details

Defined in GHC.Cmm

Methods

pdoc :: Platform -> CmmGraph -> SDoc Source #

toBlockMap :: CmmGraph -> LabelMap CmmBlock Source #

revPostorder :: CmmGraph -> [CmmBlock] Source #

toBlockList :: CmmGraph -> [CmmBlock] Source #

type CmmBlock = Block CmmNode C C Source #

type RawCmmDecl = GenCmmDecl RawCmmStatics (LabelMap RawCmmStatics) CmmGraph Source #

data Section Source #

Constructors

Section SectionType CLabel 

data SectionType Source #

Constructors

Text 
Data 
ReadOnlyData 
RelocatableReadOnlyData 
UninitialisedData 
InitArray 
FiniArray 
CString 
OtherSection String 

Instances

Instances details
Show SectionType Source # 
Instance details

Defined in GHC.Cmm

Methods

showsPrec :: Int -> SectionType -> ShowS Source #

show :: SectionType -> String Source #

showList :: [SectionType] -> ShowS Source #

data GenCmmStatics (rawOnly :: Bool) where Source #

Constructors

CmmStatics :: CLabel -> CmmInfoTable -> CostCentreStack -> [CmmLit] -> [CmmLit] -> GenCmmStatics 'False 
CmmStaticsRaw :: CLabel -> [CmmStatic] -> GenCmmStatics a

Static data, after SRTs are generated

Instances

Instances details
OutputableP Platform (GenCmmStatics a) Source # 
Instance details

Defined in GHC.Cmm

Methods

pdoc :: Platform -> GenCmmStatics a -> SDoc Source #

type CmmStatics = GenCmmStatics 'False Source #

type RawCmmStatics = GenCmmStatics 'True Source #

data CmmStatic Source #

Constructors

CmmStaticLit CmmLit

a literal value, size given by cmmLitRep of the literal.

CmmUninitialised Int

uninitialised data, N bytes long

CmmString ByteString

string of 8-bit values only, not zero terminated.

CmmFileEmbed FilePath Int

an embedded binary file and its byte length

Instances

Instances details
Outputable CmmStatic Source # 
Instance details

Defined in GHC.Cmm

Methods

ppr :: CmmStatic -> SDoc Source #

OutputableP Platform CmmStatic Source # 
Instance details

Defined in GHC.Cmm

Methods

pdoc :: Platform -> CmmStatic -> SDoc Source #

data SectionProtection Source #

Constructors

ReadWriteSection 
ReadOnlySection 
WriteProtectedSection 

Instances

Instances details
Eq SectionProtection Source # 
Instance details

Defined in GHC.Cmm

Methods

(==) :: SectionProtection -> SectionProtection -> Bool #

(/=) :: SectionProtection -> SectionProtection -> Bool #

sectionProtection :: Section -> SectionProtection Source #

Should a data in this section be considered constant at runtime

Blocks containing lists

data GenBasicBlock i Source #

Constructors

BasicBlock BlockId [i] 

Instances

Instances details
Functor GenBasicBlock Source # 
Instance details

Defined in GHC.Cmm

Methods

fmap :: (a -> b) -> GenBasicBlock a -> GenBasicBlock b Source #

(<$) :: a -> GenBasicBlock b -> GenBasicBlock a Source #

OutputableP env instr => OutputableP env (GenBasicBlock instr) Source # 
Instance details

Defined in GHC.Cmm

Methods

pdoc :: env -> GenBasicBlock instr -> SDoc Source #

Outputable instr => Outputable (GenBasicBlock instr) Source # 
Instance details

Defined in GHC.Cmm

Methods

ppr :: GenBasicBlock instr -> SDoc Source #

blockId :: GenBasicBlock i -> BlockId Source #

The branch block id is that of the first block in the branch, which is that branch's entry point

newtype ListGraph i Source #

Constructors

ListGraph [GenBasicBlock i] 

Instances

Instances details
Functor ListGraph Source # 
Instance details

Defined in GHC.Cmm

Methods

fmap :: (a -> b) -> ListGraph a -> ListGraph b Source #

(<$) :: a -> ListGraph b -> ListGraph a Source #

OutputableP env instr => OutputableP env (ListGraph instr) Source # 
Instance details

Defined in GHC.Cmm

Methods

pdoc :: env -> ListGraph instr -> SDoc Source #

Outputable instr => Outputable (ListGraph instr) Source # 
Instance details

Defined in GHC.Cmm

Methods

ppr :: ListGraph instr -> SDoc Source #

pprBBlock :: Outputable stmt => GenBasicBlock stmt -> SDoc Source #

Info Tables

data CmmTopInfo Source #

CmmTopInfo is attached to each CmmDecl (see defn of CmmGroup), and contains the extra info (beyond the executable code) that belongs to that CmmDecl.

Constructors

TopInfo 

Fields

Instances

Instances details
OutputableP Platform CmmTopInfo Source # 
Instance details

Defined in GHC.Cmm

Methods

pdoc :: Platform -> CmmTopInfo -> SDoc Source #

data CmmStackInfo Source #

Constructors

StackInfo 

Fields

Instances

Instances details
Outputable CmmStackInfo Source # 
Instance details

Defined in GHC.Cmm

Methods

ppr :: CmmStackInfo -> SDoc Source #

data CmmInfoTable Source #

Info table as a haskell data type

Constructors

CmmInfoTable 

Fields

Instances

Instances details
Eq CmmInfoTable Source # 
Instance details

Defined in GHC.Cmm

Methods

(==) :: CmmInfoTable -> CmmInfoTable -> Bool #

(/=) :: CmmInfoTable -> CmmInfoTable -> Bool #

OutputableP Platform CmmInfoTable Source # 
Instance details

Defined in GHC.Cmm

Methods

pdoc :: Platform -> CmmInfoTable -> SDoc Source #

topInfoTable :: GenCmmDecl a CmmTopInfo (GenCmmGraph n) -> Maybe CmmInfoTable Source #

data ClosureTypeInfo Source #

Constructors

Constr ConTagZ ConstrDescription 
Fun FunArity ArgDescr 
Thunk 
ThunkSelector SelectorOffset 
BlackHole 
IndStatic 

Instances

Instances details
Outputable ClosureTypeInfo Source # 
Instance details

Defined in GHC.Runtime.Heap.Layout

Methods

ppr :: ClosureTypeInfo -> SDoc Source #

Eq ClosureTypeInfo Source # 
Instance details

Defined in GHC.Runtime.Heap.Layout

Methods

(==) :: ClosureTypeInfo -> ClosureTypeInfo -> Bool #

(/=) :: ClosureTypeInfo -> ClosureTypeInfo -> Bool #

data ProfilingInfo Source #

Constructors

NoProfilingInfo 
ProfilingInfo ByteString ByteString 

Instances

Instances details
Eq ProfilingInfo Source # 
Instance details

Defined in GHC.Cmm

Methods

(==) :: ProfilingInfo -> ProfilingInfo -> Bool #

(/=) :: ProfilingInfo -> ProfilingInfo -> Bool #

type ConstrDescription = ByteString Source #

Statements, expressions and types

module GHC.Cmm.Node

module GHC.Cmm.Expr

Pretty-printing

pprCmmGroup :: (OutputableP Platform d, OutputableP Platform info, OutputableP Platform g) => Platform -> GenCmmGroup d info g -> SDoc Source #

pprSection :: Platform -> Section -> SDoc Source #

pprStatic :: Platform -> CmmStatic -> SDoc Source #