Class Arm64Writer

Generates machine code for arm64.

Hierarchy (View Summary)

Arm64Writer
- StalkerArm64Iterator

Index

Constructors

Properties

base code offset pc

Methods

canBranchDirectlyBetween dispose flush putAddRegRegImm putAddRegRegReg putAdrpRegAddress putAndRegRegImm putBCondLabel putBImm putBLabel putBlImm putBlLabel putBlrReg putBlrRegNoAuth putBranchAddress putBrkImm putBrReg putBrRegNoAuth putBytes putCallAddressWithArguments putCallRegWithArguments putCbnzRegImm putCbnzRegLabel putCbzRegImm putCbzRegLabel putCmpRegReg putEorRegRegReg putInstruction putLabel putLdpRegRegRegOffset putLdrRegAddress putLdrRegRef putLdrRegReg putLdrRegRegOffset putLdrRegRegOffsetMode putLdrRegU32 putLdrRegU32Ptr putLdrRegU64 putLdrRegU64Ptr putLdrRegValue putLdrswRegRegOffset putLslRegImm putLsrRegImm putMovNzcvReg putMovRegNzcv putMovRegReg putMrs putNop putPopAllQRegisters putPopAllXRegisters putPopRegReg putPushAllQRegisters putPushAllXRegisters putPushRegReg putRet putRetReg putStpRegRegRegOffset putStrRegReg putStrRegRegOffset putStrRegRegOffsetMode putSubRegRegImm putSubRegRegReg putTbnzRegImmImm putTbnzRegImmLabel putTbzRegImmImm putTbzRegImmLabel putTstRegImm putUbfm putUxtwRegReg putXpaciReg reset sign skip

Constructors

constructor

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

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: Arm64Register,
    leftReg: Arm64Register,
    rightValue: number | Int64 | UInt64,
): void
Puts an ADD instruction.
Parameters
- dstReg: Arm64Register
- leftReg: Arm64Register
- rightValue: number | Int64 | UInt64
Returns void

putAddRegRegReg

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

putAdrpRegAddress

putAdrpRegAddress(reg: Arm64Register, address: NativePointerValue): void
Puts an ADRP instruction.
Parameters
- reg: Arm64Register
- address: NativePointerValue
Returns void

putAndRegRegImm

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

putBCondLabel

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

putBImm

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

putBlrReg

putBlrReg(reg: Arm64Register): void
Puts a BLR instruction.
Parameters
- reg: Arm64Register
Returns void

putBlrRegNoAuth

putBlrRegNoAuth(reg: Arm64Register): void
Puts a BLR instruction expecting a raw pointer without any authentication bits.
Parameters
- reg: Arm64Register
Returns void

putBranchAddress

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

putBrkImm

putBrkImm(imm: number): void
Puts a BRK instruction.
Parameters
- imm: number
Returns void

putBrReg

putBrReg(reg: Arm64Register): void
Puts a BR instruction.
Parameters
- reg: Arm64Register
Returns void

putBrRegNoAuth

putBrRegNoAuth(reg: Arm64Register): void
Puts a BR instruction expecting a raw pointer without any authentication bits.
Parameters
- reg: Arm64Register
Returns void

putBytes

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

putCallAddressWithArguments

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

putCallRegWithArguments

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

putCbnzRegImm

putCbnzRegImm(reg: Arm64Register, target: NativePointerValue): void
Puts a CBNZ instruction.
Parameters
- reg: Arm64Register
- target: NativePointerValue
Returns void

putCbnzRegLabel

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

putCbzRegImm

putCbzRegImm(reg: Arm64Register, target: NativePointerValue): void
Puts a CBZ instruction.
Parameters
- reg: Arm64Register
- target: NativePointerValue
Returns void

putCbzRegLabel

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

putCmpRegReg

putCmpRegReg(regA: Arm64Register, regB: Arm64Register): void
Puts a CMP instruction.
Parameters
- regA: Arm64Register
- regB: Arm64Register
Returns void

putEorRegRegReg

putEorRegRegReg(
    dstReg: Arm64Register,
    leftReg: Arm64Register,
    rightReg: Arm64Register,
): void
Puts an EOR instruction.
Parameters
- dstReg: Arm64Register
- leftReg: Arm64Register
- rightReg: Arm64Register
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

putLdpRegRegRegOffset

putLdpRegRegRegOffset(
    regA: Arm64Register,
    regB: Arm64Register,
    regSrc: Arm64Register,
    srcOffset: number | Int64 | UInt64,
    mode: Arm64IndexMode,
): void
Puts an LDP instruction.
Parameters
- regA: Arm64Register
- regB: Arm64Register
- regSrc: Arm64Register
- srcOffset: number | Int64 | UInt64
- mode: Arm64IndexMode
Returns void

putLdrRegAddress

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

putLdrRegRef

putLdrRegRef(reg: Arm64Register): number
Puts an LDR instruction with a dangling data reference, returning an opaque ref value that should be passed to putLdrRegValue() at the desired location.
Parameters
- reg: Arm64Register
Returns number

putLdrRegReg

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

putLdrRegRegOffset

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

putLdrRegRegOffsetMode

putLdrRegRegOffsetMode(
    dstReg: Arm64Register,
    srcReg: Arm64Register,
    srcOffset: number | Int64 | UInt64,
    mode: Arm64IndexMode,
): void
Puts an LDR MODE instruction.
Parameters
- dstReg: Arm64Register
- srcReg: Arm64Register
- srcOffset: number | Int64 | UInt64
- mode: Arm64IndexMode
Returns void

putLdrRegU32

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

putLdrRegU32Ptr

putLdrRegU32Ptr(reg: Arm64Register, srcAddress: NativePointerValue): void
Puts an LDR instruction.
Parameters
- reg: Arm64Register
- srcAddress: NativePointerValue
Returns void

putLdrRegU64

putLdrRegU64(reg: Arm64Register, val: number | UInt64): void
Puts an LDR instruction.
Parameters
- reg: Arm64Register
- val: number | UInt64
Returns void

putLdrRegU64Ptr

putLdrRegU64Ptr(reg: Arm64Register, srcAddress: NativePointerValue): void
Puts an LDR instruction.
Parameters
- reg: Arm64Register
- srcAddress: NativePointerValue
Returns void

putLdrRegValue

putLdrRegValue(ref: number, value: NativePointerValue): void
Puts the value and updates the LDR instruction from a previous putLdrRegRef().
Parameters
- ref: number
- value: NativePointerValue
Returns void

putLdrswRegRegOffset

putLdrswRegRegOffset(
    dstReg: Arm64Register,
    srcReg: Arm64Register,
    srcOffset: number | Int64 | UInt64,
): void
Puts an LDRSW instruction.
Parameters
- dstReg: Arm64Register
- srcReg: Arm64Register
- srcOffset: number | Int64 | UInt64
Returns void

putLslRegImm

putLslRegImm(dstReg: Arm64Register, srcReg: Arm64Register, shift: number): void
Puts a LSL instruction.
Parameters
- dstReg: Arm64Register
- srcReg: Arm64Register
- shift: number
Returns void

putLsrRegImm

putLsrRegImm(dstReg: Arm64Register, srcReg: Arm64Register, shift: number): void
Puts a LSR instruction.
Parameters
- dstReg: Arm64Register
- srcReg: Arm64Register
- shift: number
Returns void

putMovNzcvReg

putMovNzcvReg(reg: Arm64Register): void
Puts a MOV NZCV instruction.
Parameters
- reg: Arm64Register
Returns void

putMovRegNzcv

putMovRegNzcv(reg: Arm64Register): void
Puts a MOV NZCV instruction.
Parameters
- reg: Arm64Register
Returns void

putMovRegReg

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

putMrs

putMrs(dstReg: Arm64Register, systemReg: number): void
Puts a MRS instruction.
Parameters
- dstReg: Arm64Register
- systemReg: number
Returns void

putNop

putNop(): void
Puts a NOP instruction.

Returns void

putPopAllQRegisters

putPopAllQRegisters(): void
Puts code needed for popping all Q registers off the stack.

Returns void

putPopAllXRegisters

putPopAllXRegisters(): void
Puts code needed for popping all X registers off the stack.

Returns void

putPopRegReg

putPopRegReg(regA: Arm64Register, regB: Arm64Register): void
Puts a POP instruction.
Parameters
- regA: Arm64Register
- regB: Arm64Register
Returns void

putPushAllQRegisters

putPushAllQRegisters(): void
Puts code needed for pushing all Q registers on the stack.

Returns void

putPushAllXRegisters

putPushAllXRegisters(): void
Puts code needed for pushing all X registers on the stack.

Returns void

putPushRegReg

putPushRegReg(regA: Arm64Register, regB: Arm64Register): void
Puts a PUSH instruction.
Parameters
- regA: Arm64Register
- regB: Arm64Register
Returns void

putRet

putRet(): void
Puts a RET instruction.

Returns void

putRetReg

putRetReg(reg: Arm64Register): void
Puts a RET instruction.
Parameters
- reg: Arm64Register
Returns void

putStpRegRegRegOffset

putStpRegRegRegOffset(
    regA: Arm64Register,
    regB: Arm64Register,
    regDst: Arm64Register,
    dstOffset: number | Int64 | UInt64,
    mode: Arm64IndexMode,
): void
Puts a STP instruction.
Parameters
- regA: Arm64Register
- regB: Arm64Register
- regDst: Arm64Register
- dstOffset: number | Int64 | UInt64
- mode: Arm64IndexMode
Returns void

putStrRegReg

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

putStrRegRegOffset

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

putStrRegRegOffsetMode

putStrRegRegOffsetMode(
    srcReg: Arm64Register,
    dstReg: Arm64Register,
    dstOffset: number | Int64 | UInt64,
    mode: Arm64IndexMode,
): void
Puts a STR MODE instruction.
Parameters
- srcReg: Arm64Register
- dstReg: Arm64Register
- dstOffset: number | Int64 | UInt64
- mode: Arm64IndexMode
Returns void

putSubRegRegImm

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

putSubRegRegReg

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

putTbnzRegImmImm

putTbnzRegImmImm(
    reg: Arm64Register,
    bit: number,
    target: NativePointerValue,
): void
Puts a TBNZ instruction.
Parameters
- reg: Arm64Register
- bit: number
- target: NativePointerValue
Returns void

putTbnzRegImmLabel

putTbnzRegImmLabel(reg: Arm64Register, bit: number, labelId: string): void
Puts a TBNZ instruction referencing labelId, defined by a past or future putLabel().
Parameters
- reg: Arm64Register
- bit: number
- labelId: string
Returns void

putTbzRegImmImm

putTbzRegImmImm(
    reg: Arm64Register,
    bit: number,
    target: NativePointerValue,
): void
Puts a TBZ instruction.
Parameters
- reg: Arm64Register
- bit: number
- target: NativePointerValue
Returns void

putTbzRegImmLabel

putTbzRegImmLabel(reg: Arm64Register, bit: number, labelId: string): void
Puts a TBZ instruction referencing labelId, defined by a past or future putLabel().
Parameters
- reg: Arm64Register
- bit: number
- labelId: string
Returns void

putTstRegImm

putTstRegImm(reg: Arm64Register, immValue: number | UInt64): void
Puts a TST instruction.
Parameters
- reg: Arm64Register
- immValue: number | UInt64
Returns void

putUbfm

putUbfm(
    dstReg: Arm64Register,
    srcReg: Arm64Register,
    imms: number,
    immr: number,
): void
Puts an UBFM instruction.
Parameters
- dstReg: Arm64Register
- srcReg: Arm64Register
- imms: number
- immr: number
Returns void

putUxtwRegReg

putUxtwRegReg(dstReg: Arm64Register, srcReg: Arm64Register): void
Puts an UXTW instruction.
Parameters
- dstReg: Arm64Register
- srcReg: Arm64Register
Returns void

putXpaciReg

putXpaciReg(reg: Arm64Register): void
Puts an XPACI instruction.
Parameters
- reg: Arm64Register
Returns void

reset

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

sign

sign(value: NativePointerValue): NativePointer
Signs the given pointer value.
Parameters
- value: NativePointerValue
Returns NativePointer

skip

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