Class ArmWriter

Generates machine code for arm.

Hierarchy (View Summary)

ArmWriter
- StalkerArmIterator

Constructors

constructor

new ArmWriter(
codeAddress: NativePointerValue,
options?: ArmWriterOptions,
): ArmWriter
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: ArmWriterOptions
  Options for customizing code generation.
Returns ArmWriter

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

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

putAddRegRegImm

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

putAddRegRegReg

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

putAddRegRegRegShift

putAddRegRegRegShift(
    dstReg: ArmRegister,
    srcReg1: ArmRegister,
    srcReg2: ArmRegister,
    shift: ArmShifter,
    shiftValue: number,
): void
Puts an ADD SHIFT instruction.
Parameters
- dstReg: ArmRegister
- srcReg1: ArmRegister
- srcReg2: ArmRegister
- shift: ArmShifter
- shiftValue: number
Returns void

putAddRegU16

putAddRegU16(dstReg: ArmRegister, val: number): void
Puts an ADD U16 instruction.
Parameters
- dstReg: ArmRegister
- val: number
Returns void

putAddRegU32

putAddRegU32(dstReg: ArmRegister, val: number): void
Puts an ADD instruction.
Parameters
- dstReg: ArmRegister
- val: number
Returns void

putAndsRegRegImm

putAndsRegRegImm(dstReg: ArmRegister, srcReg: ArmRegister, immVal: number): void
Puts an ANDS instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
- immVal: number
Returns void

putBCondImm

putBCondImm(cc: ArmConditionCode, target: NativePointerValue): void
Puts a B COND instruction.
Parameters
- cc: ArmConditionCode
- target: NativePointerValue
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

putBImm

putBImm(target: NativePointerValue): void
Puts a B instruction.
Parameters
- target: NativePointerValue
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

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

putBlReg

putBlReg(reg: ArmRegister): void
Puts a BL instruction.
Parameters
- reg: ArmRegister
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

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

putBrkImm

putBrkImm(imm: number): void
Puts a BRK instruction.
Parameters
- imm: number
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

putCallReg

putCallReg(reg: ArmRegister): void
Puts a CALL instruction.
Parameters
- reg: ArmRegister
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

putCmpRegImm

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

putInstruction

putInstruction(insn: number): void
Puts a raw instruction.
Parameters
- insn: 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

putLdmiaRegMaskWb

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

putLdrCondRegRegOffset

putLdrCondRegRegOffset(
    cc: ArmConditionCode,
    dstReg: ArmRegister,
    srcReg: ArmRegister,
    srcOffset: number | Int64 | UInt64,
): void
Puts an LDR COND instruction.
Parameters
- cc: ArmConditionCode
- dstReg: ArmRegister
- srcReg: ArmRegister
- srcOffset: number | Int64 | UInt64
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

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

putMovRegRegShift

putMovRegRegShift(
    dstReg: ArmRegister,
    srcReg: ArmRegister,
    shift: ArmShifter,
    shiftValue: number,
): void
Puts a MOV SHIFT instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
- shift: ArmShifter
- shiftValue: number
Returns void

putNop

putNop(): void
Puts a NOP instruction.

Returns void

putRet

putRet(): void
Puts a RET instruction.

Returns void

putRsbRegRegImm

putRsbRegRegImm(dstReg: ArmRegister, srcReg: ArmRegister, immVal: number): void
Puts a RSB instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
- immVal: number
Returns void

putStrCondRegRegOffset

putStrCondRegRegOffset(
    cc: ArmConditionCode,
    srcReg: ArmRegister,
    dstReg: ArmRegister,
    dstOffset: number | Int64 | UInt64,
): void
Puts a STR COND instruction.
Parameters
- cc: ArmConditionCode
- srcReg: ArmRegister
- dstReg: ArmRegister
- dstOffset: number | Int64 | UInt64
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

putSubRegRegImm

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

putSubRegRegReg

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

putSubRegU16

putSubRegU16(dstReg: ArmRegister, val: number): void
Puts a SUB U16 instruction.
Parameters
- dstReg: ArmRegister
- val: number
Returns void

putSubRegU32

putSubRegU32(dstReg: ArmRegister, val: number): void
Puts a SUB instruction.
Parameters
- dstReg: ArmRegister
- val: number
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?: ArmWriterOptions): void
Recycles instance.
Parameters
- codeAddress: NativePointerValue
- Optionaloptions: ArmWriterOptions
Returns void

skip

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