Safe Haskell	None
Language	GHC2021

GHC.CmmToAsm

Contents

Test-only exports: see #12744

Description

Note [Native code generator] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The native-code generator has machine-independent and machine-dependent modules.

This module (GHC.CmmToAsm) is the top-level machine-independent module. Before entering machine-dependent land, we do some machine-independent optimisations (defined below) on the CmmStmtss. (Which ideally would be folded into CmmOpt ...)

We convert to the machine-specific Instr datatype with cmmCodeGen, assuming an infinite supply of registers. We then use a (mostly) machine-independent register allocator to rejoin reality. Obviously, regAlloc has machine-specific helper functions (see the used register allocator for details).

Finally, we order the basic blocks of the function so as to minimise the number of jumps between blocks, by utilising fallthrough wherever possible.

The machine-dependent bits are generally contained under GHCCmmToAsmArch/* and generally breaks down as follows:

Regs: Everything about the target platform's machine registers (and immediate operands, and addresses, which tend to intermingle/interact with registers).
Instr: Includes the Instr datatype plus a miscellany of other things (e.g., targetDoubleSize, smStablePtrTable, ...)
CodeGen: is where Cmm stuff turns into machine instructions.
Ppr: pprInstr turns an Instr into text (well, really a SDoc).

The register allocators lives under GHC.CmmToAsm.Reg.*, there is both a Linear and a Graph based register allocator. Both of which have their own notes describing them. They are mostly platform independent but there are some platform specific files encoding architecture details under RegAllocatorArch.hs

}

Synopsis

nativeCodeGen :: Logger -> ToolSettings -> NCGConfig -> ModLocation -> Handle -> CgStream RawCmmGroup a -> UniqDSMT IO a
cmmNativeGen :: forall statics instr jumpDest. (Instruction instr, OutputableP Platform statics, Outputable jumpDest) => Logger -> NcgImpl statics instr jumpDest -> DUniqSupply -> DwarfFiles -> LabelMap DebugBlock -> RawCmmDecl -> Int -> IO (DUniqSupply, DwarfFiles, [NatCmmDecl statics instr], [CLabel], Maybe [RegAllocStats statics instr], Maybe [RegAllocStats], LabelMap [UnwindPoint], Maybe CFG)
data NcgImpl statics instr jumpDest = NcgImpl {
- ncgConfig :: !NCGConfig
- cmmTopCodeGen :: RawCmmDecl -> NatM [NatCmmDecl statics instr]
- generateJumpTableForInstr :: instr -> Maybe (NatCmmDecl statics instr)
- getJumpDestBlockId :: jumpDest -> Maybe BlockId
- canShortcut :: instr -> Maybe jumpDest
- shortcutStatics :: (BlockId -> Maybe jumpDest) -> statics -> statics
- shortcutJump :: (BlockId -> Maybe jumpDest) -> instr -> instr
- pprNatCmmDeclS :: NatCmmDecl statics instr -> SDoc
- pprNatCmmDeclH :: NatCmmDecl statics instr -> HDoc
- maxSpillSlots :: Int
- allocatableRegs :: [RealReg]
- ncgAllocMoreStack :: Int -> NatCmmDecl statics instr -> UniqDSM (NatCmmDecl statics instr, [(BlockId, BlockId)])
- ncgMakeFarBranches :: Platform -> LabelMap RawCmmStatics -> [NatBasicBlock instr] -> UniqDSM [NatBasicBlock instr]
- extractUnwindPoints :: [instr] -> [UnwindPoint]
- invertCondBranches :: Maybe CFG -> LabelMap RawCmmStatics -> [NatBasicBlock instr] -> [NatBasicBlock instr]
}

Documentation

nativeCodeGen :: Logger -> ToolSettings -> NCGConfig -> ModLocation -> Handle -> CgStream RawCmmGroup a -> UniqDSMT IO a Source #

Test-only exports: see #12744

cmmNativeGen Source #

Arguments

:: forall statics instr jumpDest. (Instruction instr, OutputableP Platform statics, Outputable jumpDest)
=> Logger
-> NcgImpl statics instr jumpDest
-> DUniqSupply
-> DwarfFiles
-> LabelMap DebugBlock
-> RawCmmDecl	the cmm to generate code for
-> Int	sequence number of this top thing
-> IO (DUniqSupply, DwarfFiles, [NatCmmDecl statics instr], [CLabel], Maybe [RegAllocStats statics instr], Maybe [RegAllocStats], LabelMap [UnwindPoint], Maybe CFG)

Complete native code generation phase for a single top-level chunk of Cmm. Dumping the output of each stage along the way. Global conflict graph and NGC stats

data NcgImpl statics instr jumpDest Source #

A Native Code Generator implementation is parametrised over * The type of static data (typically related to CmmStatics) * The type of instructions * The type of jump destinations

Constructors

NcgImpl

Fields

ncgConfig :: !NCGConfig
cmmTopCodeGen :: RawCmmDecl -> NatM [NatCmmDecl statics instr]
generateJumpTableForInstr :: instr -> Maybe (NatCmmDecl statics instr)
getJumpDestBlockId :: jumpDest -> Maybe BlockId
Given a jump destination, if it refers to a block, return the block id of the destination.
canShortcut :: instr -> Maybe jumpDest
Does this jump always jump to a single destination and is shortcutable?
We use this to determine whether the given instruction is a shortcutable jump to some destination - See Note [supporting shortcutting] Note that if we return a destination here we *most* support the relevant shortcutting in shortcutStatics for jump tables and shortcutJump for the instructions itself.
shortcutStatics :: (BlockId -> Maybe jumpDest) -> statics -> statics
Replace references to blockIds with other destinations - used to update jump tables.
shortcutJump :: (BlockId -> Maybe jumpDest) -> instr -> instr
Change the jump destination(s) of an instruction.
Rewrites the destination of a jump instruction to another destination, if the given function returns a new jump destination for the BlockId of the original destination.
For instance, for a mapping block_a -> dest_b and a instruction goto block_a we would rewrite the instruction to goto dest_b
pprNatCmmDeclS :: NatCmmDecl statics instr -> SDoc
Module is only for printing internal labels. See Note [Internal proc labels] in CLabel.
pprNatCmmDeclH :: NatCmmDecl statics instr -> HDoc
maxSpillSlots :: Int
allocatableRegs :: [RealReg]
ncgAllocMoreStack :: Int -> NatCmmDecl statics instr -> UniqDSM (NatCmmDecl statics instr, [(BlockId, BlockId)])
The list of block ids records the redirected jumps to allow us to update the CFG.
ncgMakeFarBranches :: Platform -> LabelMap RawCmmStatics -> [NatBasicBlock instr] -> UniqDSM [NatBasicBlock instr]
extractUnwindPoints :: [instr] -> [UnwindPoint]
given the instruction sequence of a block, produce a list of the block's UnwindPoints See Note [What is this unwinding business?] in GHC.Cmm.DebugBlock and Note [Unwinding information in the NCG] in this module.
invertCondBranches :: Maybe CFG -> LabelMap RawCmmStatics -> [NatBasicBlock instr] -> [NatBasicBlock instr]
Turn the sequence of jcc l1; jmp l2 into jncc l2; <block_l1> when possible.