Class ThumbWriter

Generates machine code for arm.

Hierarchy (View Summary)

ThumbWriter
- StalkerThumbIterator

Index

Constructors

Properties

base code offset pc

Methods

canBranchDirectlyBetween commitLabel dispose flush putAddRegImm putAddRegReg putAddRegRegImm putAddRegRegReg putAndRegRegImm putBCondLabel putBCondLabelWide putBeqLabel putBImm putBkptImm putBLabel putBLabelWide putBlImm putBlLabel putBlxImm putBlxReg putBneLabel putBranchAddress putBreakpoint putBxReg putBytes putCallAddressWithArguments putCallRegWithArguments putCbnzRegLabel putCbzRegLabel putCmpRegImm putInstruction putInstructionWide putLabel putLdmiaRegMask putLdrbRegReg putLdrRegAddress putLdrRegReg putLdrRegRegOffset putLdrRegU32 putLslRegRegImm putLslsRegRegImm putLsrsRegRegImm putMovCpsrReg putMovRegCpsr putMovRegReg putMovRegU8 putMrsRegReg putMsrRegReg putNop putOrRegRegImm putPopRegs putPushRegs putStrRegReg putStrRegRegOffset putSubRegImm putSubRegReg putSubRegRegImm putSubRegRegReg putVldrRegRegOffset putVpopRange putVpushRange reset skip

Constructors

constructor

new ThumbWriter(
codeAddress: NativePointerValue,
options?: ThumbWriterOptions,
): ThumbWriter
Creates a new code writer for generating ARM machine code written directly to memory at codeAddress.
Parameters
- codeAddress: NativePointerValue
  Memory address to write generated code to.
- Optionaloptions: ThumbWriterOptions
  Options for customizing code generation.
Returns ThumbWriter

Properties

base

base: NativePointer

Memory location of the first byte of output.

code

code: NativePointer

Memory location of the next byte of output.

offset

offset: number

Current offset in bytes.

pc

pc: NativePointer

Program counter at the next byte of output.

Methods

canBranchDirectlyBetween

canBranchDirectlyBetween(
from: NativePointerValue,
to: NativePointerValue,
): boolean
Determines whether a direct branch is possible between the two given memory locations.
Parameters
- from: NativePointerValue
- to: NativePointerValue
Returns boolean

commitLabel

commitLabel(id: string): boolean
Commits the first pending reference to the given label, returning true on success. Returns false if the given label hasn't been defined yet, or there are no more pending references to it.
Parameters
- id: string
Returns boolean

dispose

dispose(): void
Eagerly cleans up memory.

Returns void

flush

flush(): void
Resolves label references and writes pending data to memory. You should always call this once you've finished generating code. It is usually also desirable to do this between pieces of unrelated code, e.g. when generating multiple functions in one go.

Returns void

putAddRegImm

putAddRegImm(dstReg: ArmRegister, immValue: number | Int64 | UInt64): void
Puts an ADD instruction.
Parameters
- dstReg: ArmRegister
- immValue: number | Int64 | UInt64
Returns void

putAddRegReg

putAddRegReg(dstReg: ArmRegister, srcReg: ArmRegister): void
Puts an ADD instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
Returns void

putAddRegRegImm

putAddRegRegImm(
    dstReg: ArmRegister,
    leftReg: ArmRegister,
    rightValue: number | Int64 | UInt64,
): void
Puts an ADD instruction.
Parameters
- dstReg: ArmRegister
- leftReg: ArmRegister
- rightValue: number | Int64 | UInt64
Returns void

putAddRegRegReg

putAddRegRegReg(
    dstReg: ArmRegister,
    leftReg: ArmRegister,
    rightReg: ArmRegister,
): void
Puts an ADD instruction.
Parameters
- dstReg: ArmRegister
- leftReg: ArmRegister
- rightReg: ArmRegister
Returns void

putAndRegRegImm

putAndRegRegImm(
    dstReg: ArmRegister,
    leftReg: ArmRegister,
    rightValue: number | Int64 | UInt64,
): void
Puts an AND instruction.
Parameters
- dstReg: ArmRegister
- leftReg: ArmRegister
- rightValue: number | Int64 | UInt64
Returns void

putBCondLabel

putBCondLabel(cc: ArmConditionCode, labelId: string): void
Puts a B COND instruction referencing labelId, defined by a past or future putLabel().
Parameters
- cc: ArmConditionCode
- labelId: string
Returns void

putBCondLabelWide

putBCondLabelWide(cc: ArmConditionCode, labelId: string): void
Puts a B COND WIDE instruction.
Parameters
- cc: ArmConditionCode
- labelId: string
Returns void

putBeqLabel

putBeqLabel(labelId: string): void
Puts a BEQ instruction referencing labelId, defined by a past or future putLabel().
Parameters
- labelId: string
Returns void

putBImm

putBImm(target: NativePointerValue): void
Puts a B instruction.
Parameters
- target: NativePointerValue
Returns void

putBkptImm

putBkptImm(imm: number): void
Puts a BKPT instruction.
Parameters
- imm: number
Returns void

putBLabel

putBLabel(labelId: string): void
Puts a B instruction referencing labelId, defined by a past or future putLabel().
Parameters
- labelId: string
Returns void

putBLabelWide

putBLabelWide(labelId: string): void
Puts a B WIDE instruction.
Parameters
- labelId: string
Returns void

putBlImm

putBlImm(target: NativePointerValue): void
Puts a BL instruction.
Parameters
- target: NativePointerValue
Returns void

putBlLabel

putBlLabel(labelId: string): void
Puts a BL instruction referencing labelId, defined by a past or future putLabel().
Parameters
- labelId: string
Returns void

putBlxImm

putBlxImm(target: NativePointerValue): void
Puts a BLX instruction.
Parameters
- target: NativePointerValue
Returns void

putBlxReg

putBlxReg(reg: ArmRegister): void
Puts a BLX instruction.
Parameters
- reg: ArmRegister
Returns void

putBneLabel

putBneLabel(labelId: string): void
Puts a BNE instruction referencing labelId, defined by a past or future putLabel().
Parameters
- labelId: string
Returns void

putBranchAddress

putBranchAddress(address: NativePointerValue): void
Puts code needed for branching/jumping to the given address.
Parameters
- address: NativePointerValue
Returns void

putBreakpoint

putBreakpoint(): void
Puts an OS/architecture-specific breakpoint instruction.

Returns void

putBxReg

putBxReg(reg: ArmRegister): void
Puts a BX instruction.
Parameters
- reg: ArmRegister
Returns void

putBytes

putBytes(data: string | ArrayBuffer | number[]): void
Puts raw data.
Parameters
- data: string | ArrayBuffer | number[]
Returns void

putCallAddressWithArguments

putCallAddressWithArguments(
func: NativePointerValue,
args: ArmCallArgument[],
): void
Puts code needed for calling a C function with the specified args.
Parameters
- func: NativePointerValue
- args: ArmCallArgument[]
Returns void

putCallRegWithArguments

putCallRegWithArguments(reg: ArmRegister, args: ArmCallArgument[]): void
Puts code needed for calling a C function with the specified args.
Parameters
- reg: ArmRegister
- args: ArmCallArgument[]
Returns void

putCbnzRegLabel

putCbnzRegLabel(reg: ArmRegister, labelId: string): void
Puts a CBNZ instruction referencing labelId, defined by a past or future putLabel().
Parameters
- reg: ArmRegister
- labelId: string
Returns void

putCbzRegLabel

putCbzRegLabel(reg: ArmRegister, labelId: string): void
Puts a CBZ instruction referencing labelId, defined by a past or future putLabel().
Parameters
- reg: ArmRegister
- labelId: string
Returns void

putCmpRegImm

putCmpRegImm(reg: ArmRegister, immValue: number): void
Puts a CMP instruction.
Parameters
- reg: ArmRegister
- immValue: number
Returns void

putInstruction

putInstruction(insn: number): void
Puts a raw instruction.
Parameters
- insn: number
Returns void

putInstructionWide

putInstructionWide(upper: number, lower: number): void
Puts a raw Thumb-2 instruction.
Parameters
- upper: number
- lower: number
Returns void

putLabel

putLabel(id: string): void
Puts a label at the current position, where id is an identifier that may be referenced in past and future put*Label() calls.
Parameters
- id: string
Returns void

putLdmiaRegMask

putLdmiaRegMask(reg: ArmRegister, mask: number): void
Puts an LDMIA MASK instruction.
Parameters
- reg: ArmRegister
- mask: number
Returns void

putLdrbRegReg

putLdrbRegReg(dstReg: ArmRegister, srcReg: ArmRegister): void
Puts an LDRB instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
Returns void

putLdrRegAddress

putLdrRegAddress(reg: ArmRegister, address: NativePointerValue): void
Puts an LDR instruction.
Parameters
- reg: ArmRegister
- address: NativePointerValue
Returns void

putLdrRegReg

putLdrRegReg(dstReg: ArmRegister, srcReg: ArmRegister): void
Puts an LDR instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
Returns void

putLdrRegRegOffset

putLdrRegRegOffset(
    dstReg: ArmRegister,
    srcReg: ArmRegister,
    srcOffset: number | Int64 | UInt64,
): void
Puts an LDR instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
- srcOffset: number | Int64 | UInt64
Returns void

putLdrRegU32

putLdrRegU32(reg: ArmRegister, val: number): void
Puts an LDR instruction.
Parameters
- reg: ArmRegister
- val: number
Returns void

putLslRegRegImm

putLslRegRegImm(
    dstReg: ArmRegister,
    leftReg: ArmRegister,
    rightValue: number,
): void
Puts a LSL instruction.
Parameters
- dstReg: ArmRegister
- leftReg: ArmRegister
- rightValue: number
Returns void

putLslsRegRegImm

putLslsRegRegImm(
    dstReg: ArmRegister,
    leftReg: ArmRegister,
    rightValue: number,
): void
Puts a LSLS instruction.
Parameters
- dstReg: ArmRegister
- leftReg: ArmRegister
- rightValue: number
Returns void

putLsrsRegRegImm

putLsrsRegRegImm(
    dstReg: ArmRegister,
    leftReg: ArmRegister,
    rightValue: number,
): void
Puts a LSRS instruction.
Parameters
- dstReg: ArmRegister
- leftReg: ArmRegister
- rightValue: number
Returns void

putMovCpsrReg

putMovCpsrReg(reg: ArmRegister): void
Puts a MOV CPSR instruction.
Parameters
- reg: ArmRegister
Returns void

putMovRegCpsr

putMovRegCpsr(reg: ArmRegister): void
Puts a MOV CPSR instruction.
Parameters
- reg: ArmRegister
Returns void

putMovRegReg

putMovRegReg(dstReg: ArmRegister, srcReg: ArmRegister): void
Puts a MOV instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
Returns void

putMovRegU8

putMovRegU8(dstReg: ArmRegister, immValue: number): void
Puts a MOV instruction.
Parameters
- dstReg: ArmRegister
- immValue: number
Returns void

putMrsRegReg

putMrsRegReg(dstReg: ArmRegister, srcReg: "apsr-nzcvq"): void
Puts a MRS instruction.
Parameters
- dstReg: ArmRegister
- srcReg: "apsr-nzcvq"
Returns void

putMsrRegReg

putMsrRegReg(dstReg: "apsr-nzcvq", srcReg: ArmRegister): void
Puts a MSR instruction.
Parameters
- dstReg: "apsr-nzcvq"
- srcReg: ArmRegister
Returns void

putNop

putNop(): void
Puts a NOP instruction.

Returns void

putOrRegRegImm

putOrRegRegImm(
    dstReg: ArmRegister,
    leftReg: ArmRegister,
    rightValue: number | Int64 | UInt64,
): void
Puts an OR instruction.
Parameters
- dstReg: ArmRegister
- leftReg: ArmRegister
- rightValue: number | Int64 | UInt64
Returns void

putPopRegs

putPopRegs(regs: ArmRegister[]): void
Puts a POP instruction with the specified registers.
Parameters
- regs: ArmRegister[]
Returns void

putPushRegs

putPushRegs(regs: ArmRegister[]): void
Puts a PUSH instruction with the specified registers.
Parameters
- regs: ArmRegister[]
Returns void

putStrRegReg

putStrRegReg(srcReg: ArmRegister, dstReg: ArmRegister): void
Puts a STR instruction.
Parameters
- srcReg: ArmRegister
- dstReg: ArmRegister
Returns void

putStrRegRegOffset

putStrRegRegOffset(
    srcReg: ArmRegister,
    dstReg: ArmRegister,
    dstOffset: number | Int64 | UInt64,
): void
Puts a STR instruction.
Parameters
- srcReg: ArmRegister
- dstReg: ArmRegister
- dstOffset: number | Int64 | UInt64
Returns void

putSubRegImm

putSubRegImm(dstReg: ArmRegister, immValue: number | Int64 | UInt64): void
Puts a SUB instruction.
Parameters
- dstReg: ArmRegister
- immValue: number | Int64 | UInt64
Returns void

putSubRegReg

putSubRegReg(dstReg: ArmRegister, srcReg: ArmRegister): void
Puts a SUB instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
Returns void

putSubRegRegImm

putSubRegRegImm(
    dstReg: ArmRegister,
    leftReg: ArmRegister,
    rightValue: number | Int64 | UInt64,
): void
Puts a SUB instruction.
Parameters
- dstReg: ArmRegister
- leftReg: ArmRegister
- rightValue: number | Int64 | UInt64
Returns void

putSubRegRegReg

putSubRegRegReg(
    dstReg: ArmRegister,
    leftReg: ArmRegister,
    rightReg: ArmRegister,
): void
Puts a SUB instruction.
Parameters
- dstReg: ArmRegister
- leftReg: ArmRegister
- rightReg: ArmRegister
Returns void

putVldrRegRegOffset

putVldrRegRegOffset(
    dstReg: ArmRegister,
    srcReg: ArmRegister,
    srcOffset: number | Int64 | UInt64,
): void
Puts a VLDR instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
- srcOffset: number | Int64 | UInt64
Returns void

putVpopRange

putVpopRange(firstReg: ArmRegister, lastReg: ArmRegister): void
Puts a VPOP RANGE instruction.
Parameters
- firstReg: ArmRegister
- lastReg: ArmRegister
Returns void

putVpushRange

putVpushRange(firstReg: ArmRegister, lastReg: ArmRegister): void
Puts a VPUSH RANGE instruction.
Parameters
- firstReg: ArmRegister
- lastReg: ArmRegister
Returns void

reset

reset(codeAddress: NativePointerValue, options?: ThumbWriterOptions): void
Recycles instance.
Parameters
- codeAddress: NativePointerValue
- Optionaloptions: ThumbWriterOptions
Returns void

skip

skip(nBytes: number): void
Skips nBytes.
Parameters
- nBytes: number
Returns void