ghc-9.6.3: The GHC API

Safe Haskell | Safe-Inferred
Language | Haskell2010

GHC.Cmm.Expr

Synopsis

- data CmmExpr
  - = CmmLit !CmmLit
  - | CmmLoad !CmmExpr !CmmType !AlignmentSpec
  - | CmmReg !CmmReg
  - | CmmMachOp MachOp [CmmExpr]
  - | CmmStackSlot Area !Int
  - | CmmRegOff !CmmReg !Int
- cmmExprType :: Platform -> CmmExpr -> CmmType
- cmmExprWidth :: Platform -> CmmExpr -> Width
- cmmExprAlignment :: CmmExpr -> Alignment
- maybeInvertCmmExpr :: CmmExpr -> Maybe CmmExpr
- data CmmReg
  - = CmmLocal !LocalReg
  - | CmmGlobal GlobalReg
- cmmRegType :: Platform -> CmmReg -> CmmType
- cmmRegWidth :: Platform -> CmmReg -> Width
- data CmmLit
  - = CmmInt !Integer !Width
  - | CmmFloat Rational !Width
  - | CmmVec [CmmLit]
  - | CmmLabel CLabel
  - | CmmLabelOff CLabel !Int
  - | CmmLabelDiffOff CLabel CLabel !Int !Width
  - | CmmBlock !BlockId
  - | CmmHighStackMark
- cmmLitType :: Platform -> CmmLit -> CmmType
- data AlignmentSpec
  - = NaturallyAligned
  - | Unaligned
- data LocalReg = LocalReg !Unique !CmmType
- localRegType :: LocalReg -> CmmType
- data GlobalReg
  - = VanillaReg !Int VGcPtr
  - | FloatReg !Int
  - | DoubleReg !Int
  - | LongReg !Int
  - | XmmReg !Int
  - | YmmReg !Int
  - | ZmmReg !Int
  - | Sp
  - | SpLim
  - | Hp
  - | HpLim
  - | CCCS
  - | CurrentTSO
  - | CurrentNursery
  - | HpAlloc
  - | EagerBlackholeInfo
  - | GCEnter1
  - | GCFun
  - | BaseReg
  - | MachSp
  - | UnwindReturnReg
  - | PicBaseReg
- isArgReg :: GlobalReg -> Bool
- globalRegType :: Platform -> GlobalReg -> CmmType
- spReg :: CmmReg
- hpReg :: CmmReg
- spLimReg :: CmmReg
- hpLimReg :: CmmReg
- nodeReg :: CmmReg
- currentTSOReg :: CmmReg
- currentNurseryReg :: CmmReg
- hpAllocReg :: CmmReg
- cccsReg :: CmmReg
- node :: GlobalReg
- baseReg :: CmmReg
- data VGcPtr
  - = VGcPtr
  - | VNonGcPtr
- class Ord r => DefinerOfRegs r a
- class Ord r => UserOfRegs r a
- foldRegsDefd :: DefinerOfRegs r a => Platform -> (b -> r -> b) -> b -> a -> b
- foldRegsUsed :: UserOfRegs r a => Platform -> (b -> r -> b) -> b -> a -> b
- foldLocalRegsDefd :: DefinerOfRegs LocalReg a => Platform -> (b -> LocalReg -> b) -> b -> a -> b
- foldLocalRegsUsed :: UserOfRegs LocalReg a => Platform -> (b -> LocalReg -> b) -> b -> a -> b
- type RegSet r = Set r
- type LocalRegSet = RegSet LocalReg
- type GlobalRegSet = RegSet GlobalReg
- emptyRegSet :: RegSet r
- elemRegSet :: Ord r => r -> RegSet r -> Bool
- extendRegSet :: Ord r => RegSet r -> r -> RegSet r
- deleteFromRegSet :: Ord r => RegSet r -> r -> RegSet r
- mkRegSet :: Ord r => [r] -> RegSet r
- plusRegSet :: Ord r => RegSet r -> RegSet r -> RegSet r
- minusRegSet :: Ord r => RegSet r -> RegSet r -> RegSet r
- timesRegSet :: Ord r => RegSet r -> RegSet r -> RegSet r
- sizeRegSet :: RegSet r -> Int
- nullRegSet :: RegSet r -> Bool
- regSetToList :: RegSet r -> [r]
- isTrivialCmmExpr :: CmmExpr -> Bool
- hasNoGlobalRegs :: CmmExpr -> Bool
- isLit :: CmmExpr -> Bool
- isComparisonExpr :: CmmExpr -> Bool
- data Area
  - = Old
  - | Young !BlockId
- module GHC.Cmm.MachOp
- module GHC.Cmm.Type

# Documentation

data CmmExpr Source #

Constructors

CmmLit !CmmLit |
CmmLoad !CmmExpr !CmmType !AlignmentSpec |
CmmReg !CmmReg |
CmmMachOp MachOp [CmmExpr] |
CmmStackSlot Area !Int |
CmmRegOff !CmmReg !Int |

#### Instances

Instances details

Show CmmExpr Source # |
Instance details Defined in GHC.Cmm.Expr Methods showsPrec :: Int -> CmmExpr -> ShowS Source # show :: CmmExpr -> String Source # showList :: [CmmExpr] -> ShowS Source #
Eq CmmExpr Source # |
Instance details Defined in GHC.Cmm.Expr Methods (==) :: CmmExpr -> CmmExpr -> Bool # (/=) :: CmmExpr -> CmmExpr -> Bool #
(Ord r, UserOfRegs r CmmReg) => UserOfRegs r CmmExpr Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsUsed :: Platform -> (b -> r -> b) -> b -> CmmExpr -> b Source #
OutputableP Platform CmmExpr Source # |
Instance details Defined in GHC.Cmm.Expr Methods pdoc :: Platform -> CmmExpr -> SDoc Source #

cmmExprType :: Platform -> CmmExpr -> CmmType Source #

cmmExprWidth :: Platform -> CmmExpr -> Width Source #

cmmExprAlignment :: CmmExpr -> Alignment Source #

Returns an alignment in bytes of a CmmExpr when it's a statically known integer constant, otherwise returns an alignment of 1 byte. The caller is responsible for using with a sensible CmmExpr argument.

maybeInvertCmmExpr :: CmmExpr -> Maybe CmmExpr Source #

data CmmReg Source #

Constructors

CmmLocal !LocalReg |
CmmGlobal GlobalReg |

#### Instances

Instances details

Show CmmReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods showsPrec :: Int -> CmmReg -> ShowS Source # show :: CmmReg -> String Source # showList :: [CmmReg] -> ShowS Source #
Outputable CmmReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods ppr :: CmmReg -> SDoc Source #
Eq CmmReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods (==) :: CmmReg -> CmmReg -> Bool # (/=) :: CmmReg -> CmmReg -> Bool #
Ord CmmReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods compare :: CmmReg -> CmmReg -> Ordering # (<) :: CmmReg -> CmmReg -> Bool # (<=) :: CmmReg -> CmmReg -> Bool # (>) :: CmmReg -> CmmReg -> Bool # (>=) :: CmmReg -> CmmReg -> Bool # max :: CmmReg -> CmmReg -> CmmReg # min :: CmmReg -> CmmReg -> CmmReg #
DefinerOfRegs GlobalReg CmmReg Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsDefd :: Platform -> (b -> GlobalReg -> b) -> b -> CmmReg -> b Source #
DefinerOfRegs LocalReg CmmReg Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsDefd :: Platform -> (b -> LocalReg -> b) -> b -> CmmReg -> b Source #
UserOfRegs GlobalReg CmmReg Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsUsed :: Platform -> (b -> GlobalReg -> b) -> b -> CmmReg -> b Source #
UserOfRegs LocalReg CmmReg Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsUsed :: Platform -> (b -> LocalReg -> b) -> b -> CmmReg -> b Source #

cmmRegType :: Platform -> CmmReg -> CmmType Source #

cmmRegWidth :: Platform -> CmmReg -> Width Source #

data CmmLit Source #

Constructors

CmmInt !Integer !Width |
CmmFloat Rational !Width |
CmmVec [CmmLit] |
CmmLabel CLabel |
CmmLabelOff CLabel !Int |
CmmLabelDiffOff CLabel CLabel !Int !Width |
CmmBlock !BlockId |
CmmHighStackMark |

#### Instances

Instances details

Show CmmLit Source # |
Instance details Defined in GHC.Cmm.Expr Methods showsPrec :: Int -> CmmLit -> ShowS Source # show :: CmmLit -> String Source # showList :: [CmmLit] -> ShowS Source #
Outputable CmmLit Source # |
Instance details Defined in GHC.Cmm.Expr Methods ppr :: CmmLit -> SDoc Source #
Eq CmmLit Source # |
Instance details Defined in GHC.Cmm.Expr Methods (==) :: CmmLit -> CmmLit -> Bool # (/=) :: CmmLit -> CmmLit -> Bool #
OutputableP Platform CmmLit Source # |
Instance details Defined in GHC.Cmm.Expr Methods pdoc :: Platform -> CmmLit -> SDoc Source #

cmmLitType :: Platform -> CmmLit -> CmmType Source #

data AlignmentSpec Source #

Constructors

NaturallyAligned |
Unaligned |

#### Instances

Instances details

Show AlignmentSpec Source # |
Instance details Defined in GHC.Cmm.Expr Methods showsPrec :: Int -> AlignmentSpec -> ShowS Source # show :: AlignmentSpec -> String Source # showList :: [AlignmentSpec] -> ShowS Source #
Eq AlignmentSpec Source # |
Instance details Defined in GHC.Cmm.Expr Methods (==) :: AlignmentSpec -> AlignmentSpec -> Bool # (/=) :: AlignmentSpec -> AlignmentSpec -> Bool #
Ord AlignmentSpec Source # |

Instance details

Defined in GHC.Cmm.Expr

Methods

compare :: AlignmentSpec -> AlignmentSpec -> Ordering #

(<) :: AlignmentSpec -> AlignmentSpec -> Bool #

(<=) :: AlignmentSpec -> AlignmentSpec -> Bool #

(>) :: AlignmentSpec -> AlignmentSpec -> Bool #

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

max :: AlignmentSpec -> AlignmentSpec -> AlignmentSpec #

min :: AlignmentSpec -> AlignmentSpec -> AlignmentSpec #

data LocalReg Source #

Constructors

LocalReg !Unique !CmmType | Parameters: 1. Identifier 2. Type

#### Instances

Instances details

Show LocalReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods showsPrec :: Int -> LocalReg -> ShowS Source # show :: LocalReg -> String Source # showList :: [LocalReg] -> ShowS Source #
Uniquable LocalReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods getUnique :: LocalReg -> Unique Source #
Outputable LocalReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods ppr :: LocalReg -> SDoc Source #
Eq LocalReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods (==) :: LocalReg -> LocalReg -> Bool # (/=) :: LocalReg -> LocalReg -> Bool #
Ord LocalReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods compare :: LocalReg -> LocalReg -> Ordering # (<) :: LocalReg -> LocalReg -> Bool # (<=) :: LocalReg -> LocalReg -> Bool # (>) :: LocalReg -> LocalReg -> Bool # (>=) :: LocalReg -> LocalReg -> Bool # max :: LocalReg -> LocalReg -> LocalReg # min :: LocalReg -> LocalReg -> LocalReg #
DefinerOfRegs LocalReg CmmReg Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsDefd :: Platform -> (b -> LocalReg -> b) -> b -> CmmReg -> b Source #
UserOfRegs LocalReg CmmReg Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsUsed :: Platform -> (b -> LocalReg -> b) -> b -> CmmReg -> b Source #
DefinerOfRegs LocalReg (CmmNode e x) Source # |
Instance details Defined in GHC.Cmm.Node Methods foldRegsDefd :: Platform -> (b -> LocalReg -> b) -> b -> CmmNode e x -> b Source #
UserOfRegs LocalReg (CmmNode e x) Source # |
Instance details Defined in GHC.Cmm.Node Methods foldRegsUsed :: Platform -> (b -> LocalReg -> b) -> b -> CmmNode e x -> b Source #

localRegType :: LocalReg -> CmmType Source #

data GlobalReg Source #

Constructors

VanillaReg !Int VGcPtr |
FloatReg !Int |
DoubleReg !Int |
LongReg !Int |
XmmReg !Int |
YmmReg !Int |
ZmmReg !Int |
Sp |
SpLim |
Hp |
HpLim |
CCCS |
CurrentTSO |
CurrentNursery |
HpAlloc |
EagerBlackholeInfo |
GCEnter1 |
GCFun |
BaseReg |
MachSp |
UnwindReturnReg |
PicBaseReg |

#### Instances

Instances details

Show GlobalReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods showsPrec :: Int -> GlobalReg -> ShowS Source # show :: GlobalReg -> String Source # showList :: [GlobalReg] -> ShowS Source #
Outputable GlobalReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods ppr :: GlobalReg -> SDoc Source #
Eq GlobalReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods (==) :: GlobalReg -> GlobalReg -> Bool # (/=) :: GlobalReg -> GlobalReg -> Bool #
Ord GlobalReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods compare :: GlobalReg -> GlobalReg -> Ordering # (<) :: GlobalReg -> GlobalReg -> Bool # (<=) :: GlobalReg -> GlobalReg -> Bool # (>) :: GlobalReg -> GlobalReg -> Bool # (>=) :: GlobalReg -> GlobalReg -> Bool # max :: GlobalReg -> GlobalReg -> GlobalReg # min :: GlobalReg -> GlobalReg -> GlobalReg #
DefinerOfRegs GlobalReg CmmReg Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsDefd :: Platform -> (b -> GlobalReg -> b) -> b -> CmmReg -> b Source #
UserOfRegs GlobalReg CmmReg Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsUsed :: Platform -> (b -> GlobalReg -> b) -> b -> CmmReg -> b Source #
OutputableP env GlobalReg Source # |
Instance details Defined in GHC.Cmm.Reg Methods pdoc :: env -> GlobalReg -> SDoc Source #
DefinerOfRegs GlobalReg (CmmNode e x) Source # |
Instance details Defined in GHC.Cmm.Node Methods foldRegsDefd :: Platform -> (b -> GlobalReg -> b) -> b -> CmmNode e x -> b Source #
UserOfRegs GlobalReg (CmmNode e x) Source # |
Instance details Defined in GHC.Cmm.Node Methods foldRegsUsed :: Platform -> (b -> GlobalReg -> b) -> b -> CmmNode e x -> b Source #

isArgReg :: GlobalReg -> Bool Source #

globalRegType :: Platform -> GlobalReg -> CmmType Source #

spReg :: CmmReg Source #

hpReg :: CmmReg Source #

spLimReg :: CmmReg Source #

hpLimReg :: CmmReg Source #

nodeReg :: CmmReg Source #

currentTSOReg :: CmmReg Source #

currentNurseryReg :: CmmReg Source #

hpAllocReg :: CmmReg Source #

cccsReg :: CmmReg Source #

node :: GlobalReg Source #

baseReg :: CmmReg Source #

data VGcPtr Source #

Constructors

VGcPtr |
VNonGcPtr |

#### Instances

Instances details

Show VGcPtr Source # |
Instance details Defined in GHC.Cmm.Reg Methods showsPrec :: Int -> VGcPtr -> ShowS Source # show :: VGcPtr -> String Source # showList :: [VGcPtr] -> ShowS Source #
Eq VGcPtr Source # |
Instance details Defined in GHC.Cmm.Reg Methods (==) :: VGcPtr -> VGcPtr -> Bool # (/=) :: VGcPtr -> VGcPtr -> Bool #

class Ord r => DefinerOfRegs r a Source #

Minimal complete definition

foldRegsDefd

#### Instances

Instances details

DefinerOfRegs GlobalReg CmmReg Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsDefd :: Platform -> (b -> GlobalReg -> b) -> b -> CmmReg -> b Source #
DefinerOfRegs LocalReg CmmReg Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsDefd :: Platform -> (b -> LocalReg -> b) -> b -> CmmReg -> b Source #
Ord r => DefinerOfRegs r r Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsDefd :: Platform -> (b -> r -> b) -> b -> r -> b Source #
DefinerOfRegs r a => DefinerOfRegs r [a] Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsDefd :: Platform -> (b -> r -> b) -> b -> [a] -> b Source #
DefinerOfRegs GlobalReg (CmmNode e x) Source # |
Instance details Defined in GHC.Cmm.Node Methods foldRegsDefd :: Platform -> (b -> GlobalReg -> b) -> b -> CmmNode e x -> b Source #
DefinerOfRegs LocalReg (CmmNode e x) Source # |
Instance details Defined in GHC.Cmm.Node Methods foldRegsDefd :: Platform -> (b -> LocalReg -> b) -> b -> CmmNode e x -> b Source #

class Ord r => UserOfRegs r a Source #

Minimal complete definition

foldRegsUsed

#### Instances

Instances details

UserOfRegs GlobalReg CmmReg Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsUsed :: Platform -> (b -> GlobalReg -> b) -> b -> CmmReg -> b Source #
UserOfRegs LocalReg CmmReg Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsUsed :: Platform -> (b -> LocalReg -> b) -> b -> CmmReg -> b Source #
(Ord r, UserOfRegs r CmmReg) => UserOfRegs r CmmExpr Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsUsed :: Platform -> (b -> r -> b) -> b -> CmmExpr -> b Source #
(Ord r, UserOfRegs r CmmReg) => UserOfRegs r ForeignTarget Source # |
Instance details Defined in GHC.Cmm.Node Methods foldRegsUsed :: Platform -> (b -> r -> b) -> b -> ForeignTarget -> b Source #
Ord r => UserOfRegs r r Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsUsed :: Platform -> (b -> r -> b) -> b -> r -> b Source #
UserOfRegs r a => UserOfRegs r [a] Source # |
Instance details Defined in GHC.Cmm.Expr Methods foldRegsUsed :: Platform -> (b -> r -> b) -> b -> [a] -> b Source #
UserOfRegs GlobalReg (CmmNode e x) Source # |
Instance details Defined in GHC.Cmm.Node Methods foldRegsUsed :: Platform -> (b -> GlobalReg -> b) -> b -> CmmNode e x -> b Source #
UserOfRegs LocalReg (CmmNode e x) Source # |
Instance details Defined in GHC.Cmm.Node Methods foldRegsUsed :: Platform -> (b -> LocalReg -> b) -> b -> CmmNode e x -> b Source #

foldRegsDefd :: DefinerOfRegs r a => Platform -> (b -> r -> b) -> b -> a -> b Source #

foldRegsUsed :: UserOfRegs r a => Platform -> (b -> r -> b) -> b -> a -> b Source #

foldLocalRegsDefd :: DefinerOfRegs LocalReg a => Platform -> (b -> LocalReg -> b) -> b -> a -> b Source #

foldLocalRegsUsed :: UserOfRegs LocalReg a => Platform -> (b -> LocalReg -> b) -> b -> a -> b Source #

type RegSet r = Set r Source #

Sets of registers

type LocalRegSet = RegSet LocalReg Source #

type GlobalRegSet = RegSet GlobalReg Source #

emptyRegSet :: RegSet r Source #

elemRegSet :: Ord r => r -> RegSet r -> Bool Source #

extendRegSet :: Ord r => RegSet r -> r -> RegSet r Source #

deleteFromRegSet :: Ord r => RegSet r -> r -> RegSet r Source #

mkRegSet :: Ord r => [r] -> RegSet r Source #

plusRegSet :: Ord r => RegSet r -> RegSet r -> RegSet r Source #

minusRegSet :: Ord r => RegSet r -> RegSet r -> RegSet r Source #

timesRegSet :: Ord r => RegSet r -> RegSet r -> RegSet r Source #

sizeRegSet :: RegSet r -> Int Source #

nullRegSet :: RegSet r -> Bool Source #

regSetToList :: RegSet r -> [r] Source #

isTrivialCmmExpr :: CmmExpr -> Bool Source #

hasNoGlobalRegs :: CmmExpr -> Bool Source #

isLit :: CmmExpr -> Bool Source #

isComparisonExpr :: CmmExpr -> Bool Source #

data Area Source #

A stack area is either the stack slot where a variable is spilled or the stack space where function arguments and results are passed.

Constructors

Old |
Young !BlockId |

#### Instances

Instances details

Show Area Source # |
Instance details Defined in GHC.Cmm.Expr Methods showsPrec :: Int -> Area -> ShowS Source # show :: Area -> String Source # showList :: [Area] -> ShowS Source #
Outputable Area Source # |
Instance details Defined in GHC.Cmm.Expr Methods ppr :: Area -> SDoc Source #
Eq Area Source # |
Instance details Defined in GHC.Cmm.Expr Methods (==) :: Area -> Area -> Bool # (/=) :: Area -> Area -> Bool #
Ord Area Source # |
Instance details Defined in GHC.Cmm.Expr Methods compare :: Area -> Area -> Ordering # (<) :: Area -> Area -> Bool # (<=) :: Area -> Area -> Bool # (>) :: Area -> Area -> Bool # (>=) :: Area -> Area -> Bool # max :: Area -> Area -> Area # min :: Area -> Area -> Area #

module GHC.Cmm.MachOp

module GHC.Cmm.Type