Class ArmWriter

Generates machine code for arm.

Hierarchy

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.
- Optional options: ArmWriterOptions
  
  Options for customizing code generation.
Returns ArmWriter
- Defined in index.ts:5863

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
- Defined in index.ts:5928

dispose

dispose(): void
Eagerly cleans up memory.

Returns void
- Defined in index.ts:5873

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
- Defined in index.ts:5881

putAddRegRegImm

putAddRegRegImm(dstReg: ArmRegister, srcReg: ArmRegister, immVal: number): void
Puts an ADD instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
- immVal: number
Returns void
- Defined in index.ts:6051

putAddRegRegReg

putAddRegRegReg(dstReg: ArmRegister, srcReg1: ArmRegister, srcReg2: ArmRegister): void
Puts an ADD instruction.
Parameters
- dstReg: ArmRegister
- srcReg1: ArmRegister
- srcReg2: ArmRegister
Returns void
- Defined in index.ts:6056

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
- Defined in index.ts:6061

putAddRegU16

putAddRegU16(dstReg: ArmRegister, val: number): void
Puts an ADD U16 instruction.
Parameters
- dstReg: ArmRegister
- val: number
Returns void
- Defined in index.ts:6041

putAddRegU32

putAddRegU32(dstReg: ArmRegister, val: number): void
Puts an ADD instruction.
Parameters
- dstReg: ArmRegister
- val: number
Returns void
- Defined in index.ts:6046

putAndsRegRegImm

putAndsRegRegImm(dstReg: ArmRegister, srcReg: ArmRegister, immVal: number): void
Puts an ANDS instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
- immVal: number
Returns void
- Defined in index.ts:6086

putBCondImm

putBCondImm(cc: ArmConditionCode, target: NativePointerValue): void
Puts a B COND instruction.
Parameters
- cc: ArmConditionCode
- target: NativePointerValue
Returns void
- Defined in index.ts:5938

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
- Defined in index.ts:5950

putBImm

putBImm(target: NativePointerValue): void
Puts a B instruction.
Parameters
- target: NativePointerValue
Returns void
- Defined in index.ts:5933

putBLabel

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

putBlImm

putBlImm(target: NativePointerValue): void
Puts a BL instruction.
Parameters
- target: NativePointerValue
Returns void
- Defined in index.ts:5955

putBlLabel

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

putBlxImm

putBlxImm(target: NativePointerValue): void
Puts a BLX instruction.
Parameters
- target: NativePointerValue
Returns void
- Defined in index.ts:5960

putBlxReg

putBlxReg(reg: ArmRegister): void
Puts a BLX instruction.
Parameters
- reg: ArmRegister
Returns void
- Defined in index.ts:5976

putBranchAddress

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

putBreakpoint

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

Returns void
- Defined in index.ts:6101

putBrkImm

putBrkImm(imm: number): void
Puts a BRK instruction.
Parameters
- imm: number
Returns void
- Defined in index.ts:6106

putBxReg

putBxReg(reg: ArmRegister): void
Puts a BX instruction.
Parameters
- reg: ArmRegister
Returns void
- Defined in index.ts:5971

putBytes

putBytes(data: string | number[] | ArrayBuffer): void
Puts raw data.
Parameters
- data: string | number[] | ArrayBuffer
Returns void
- Defined in index.ts:6116

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
- Defined in index.ts:5917

putCmpRegImm

putCmpRegImm(dstReg: ArmRegister, immVal: number): void
Puts a CMP instruction.
Parameters
- dstReg: ArmRegister
- immVal: number
Returns void
- Defined in index.ts:6091

putInstruction

putInstruction(insn: number): void
Puts a raw instruction.
Parameters
- insn: number
Returns void
- Defined in index.ts:6111

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
- Defined in index.ts:5912

putLdmiaRegMask

putLdmiaRegMask(reg: ArmRegister, mask: number): void
Puts an LDMIA MASK instruction.
Parameters
- reg: ArmRegister
- mask: number
Returns void
- Defined in index.ts:6006

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
- Defined in index.ts:6001

putLdrRegAddress

putLdrRegAddress(reg: ArmRegister, address: NativePointerValue): void
Puts an LDR instruction.
Parameters
- reg: ArmRegister
- address: NativePointerValue
Returns void
- Defined in index.ts:5986

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
- Defined in index.ts:5996

putLdrRegU32

putLdrRegU32(reg: ArmRegister, val: number): void
Puts an LDR instruction.
Parameters
- reg: ArmRegister
- val: number
Returns void
- Defined in index.ts:5991

putMovCpsrReg

putMovCpsrReg(reg: ArmRegister): void
Puts a MOV CPSR instruction.
Parameters
- reg: ArmRegister
Returns void
- Defined in index.ts:6036

putMovRegCpsr

putMovRegCpsr(reg: ArmRegister): void
Puts a MOV CPSR instruction.
Parameters
- reg: ArmRegister
Returns void
- Defined in index.ts:6031

putMovRegReg

putMovRegReg(dstReg: ArmRegister, srcReg: ArmRegister): void
Puts a MOV instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
Returns void
- Defined in index.ts:6021

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
- Defined in index.ts:6026

putNop

putNop(): void
Puts a NOP instruction.

Returns void
- Defined in index.ts:6096

putRet

putRet(): void
Puts a RET instruction.

Returns void
- Defined in index.ts:5981

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
- Defined in index.ts:6016

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
- Defined in index.ts:6011

putSubRegRegImm

putSubRegRegImm(dstReg: ArmRegister, srcReg: ArmRegister, immVal: number): void
Puts a SUB instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
- immVal: number
Returns void
- Defined in index.ts:6076

putSubRegRegReg

putSubRegRegReg(dstReg: ArmRegister, srcReg1: ArmRegister, srcReg2: ArmRegister): void
Puts a SUB instruction.
Parameters
- dstReg: ArmRegister
- srcReg1: ArmRegister
- srcReg2: ArmRegister
Returns void
- Defined in index.ts:6081

putSubRegU16

putSubRegU16(dstReg: ArmRegister, val: number): void
Puts a SUB U16 instruction.
Parameters
- dstReg: ArmRegister
- val: number
Returns void
- Defined in index.ts:6066

putSubRegU32

putSubRegU32(dstReg: ArmRegister, val: number): void
Puts a SUB instruction.
Parameters
- dstReg: ArmRegister
- val: number
Returns void
- Defined in index.ts:6071

reset

reset(codeAddress: NativePointerValue, options?: ArmWriterOptions): void
Recycles instance.
Parameters
- codeAddress: NativePointerValue
- Optional options: ArmWriterOptions
Returns void
- Defined in index.ts:5868

skip

skip(nBytes: number): void
Skips nBytes.
Parameters
- nBytes: number
Returns void
- Defined in index.ts:5906

Generated using TypeDoc