HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Moduleghc-9.10.3GHC2021

GHC.CmmToAsm.Instr

  • 1 type
  • 1 class
  • 1 value
  • Packageghc-9.10.3
  • Exports3
  • LanguageGHC2021
  • LicenceBSD-3-Clause
  • SourceInstr.hs
classclass Instruction instr where
#

Common things that we can do with instructions, on all architectures. These are used by the shared parts of the native code generator, specifically the register allocators.

Methods

  • regUsageOfInstr :: Platform -> instr -> RegUsage

    Get the registers that are being used by this instruction. regUsage doesn't need to do any trickery for jumps and such. Just state precisely the regs read and written by that insn. The consequences of control flow transfers, as far as register allocation goes, are taken care of by the register allocator.

  • patchRegsOfInstr :: instr -> (Reg -> Reg) -> instr

    Apply a given mapping to all the register references in this instruction.

  • isJumpishInstr :: instr -> Bool

    Checks whether this instruction is a jump/branch instruction. One that can change the flow of control in a way that the register allocator needs to worry about.

  • jumpDestsOfInstr :: instr -> [BlockId]

    Give the possible *local block* destinations of this jump instruction. Must be defined for all jumpish instructions.

  • canFallthroughTo :: instr -> BlockId -> Bool

    Check if the instr always transfers control flow to the given block. Used by code layout to eliminate jumps that can be replaced by fall through.

  • patchJumpInstr :: instr -> (BlockId -> BlockId) -> instr

    Change the destination of this jump instruction. Used in the linear allocator when adding fixup blocks for join points.

  • mkSpillInstr :: NCGConfig -> Reg -> Int -> Int -> [instr]

    An instruction to spill a register into a spill slot.

  • mkLoadInstr :: NCGConfig -> Reg -> Int -> Int -> [instr]

    An instruction to reload a register from a spill slot.

  • takeDeltaInstr :: instr -> Maybe Int

    See if this instruction is telling us the current C stack delta

  • isMetaInstr :: instr -> Bool

    Check whether this instruction is some meta thing inserted into the instruction stream for other purposes.

    Not something that has to be treated as a real machine instruction and have its registers allocated.

    eg, comments, delta, ldata, etc.

  • mkRegRegMoveInstr :: Platform -> Reg -> Reg -> instr

    Copy the value in a register to another one. Must work for all register classes.

  • takeRegRegMoveInstr :: instr -> Maybe (Reg, Reg)

    Take the source and destination from this reg -> reg move instruction or Nothing if it's not one

  • mkJumpInstr :: BlockId -> [instr]

    Make an unconditional jump instruction. For architectures with branch delay slots, its ok to put a NOP after the jump. Don't fill the delay slot with an instruction that references regs or you'll confuse the linear allocator.

  • mkStackAllocInstr :: Platform -> Int -> [instr]
  • mkStackDeallocInstr :: Platform -> Int -> [instr]
  • pprInstr :: Platform -> instr -> SDoc

    Pretty-print an instruction

  • mkComment :: FastString -> [instr]
Instances4Instruction
  • Instruction InstrDefined in ghc-9.10.3 · GHC.CmmToAsm.AArch64 · orphan

    Instruction instance for aarch64

  • Instruction InstrDefined in ghc-9.10.3 · GHC.CmmToAsm.PPC · orphan

    Instruction instance for powerpc

  • Instruction InstrDefined in ghc-9.10.3 · GHC.CmmToAsm.X86 · orphan

    Instruction instance for x86 instruction set.

  • Instruction instr => Instruction (InstrSR instr)Defined in ghc-9.10.3 · GHC.CmmToAsm.Reg.Liveness
datadata RegUsage
#

Holds a list of source and destination registers used by a particular instruction.

Machine registers that are pre-allocated to stgRegs are filtered out, because they are uninteresting from a register allocation standpoint. (We wouldn't want them to end up on the free list!)

As far as we are concerned, the fixed registers simply don't exist (for allocation purposes, anyway).

Constructors

Instances2Show, Outputable
  • Show RegUsageDefined in ghc-9.10.3 · GHC.CmmToAsm.Instr
  • Outputable RegUsageDefined in ghc-9.10.3 · GHC.CmmToAsm.AArch64.Instr · orphan

    Get the registers that are being used by this instruction. regUsage doesn't need to do any trickery for jumps and such. Just state precisely the regs read and written by that insn. The consequences of control flow transfers, as far as register allocation goes, are taken care of by the register allocator.

    RegUsage = RU [regs] [regs]