Class ThumbWriter

Generates machine code for arm.

Hierarchy

ThumbWriter
- StalkerThumbIterator

Index

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.
- Optional options: ThumbWriterOptions
  
  Options for customizing code generation.
Returns ThumbWriter
- Defined in index.ts:6227

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

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

dispose

dispose(): void
Eagerly cleans up memory.

Returns void
- Defined in index.ts:6237

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:6245

putAddRegImm

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

putAddRegReg

putAddRegReg(dstReg: ArmRegister, srcReg: ArmRegister): void
Puts an ADD instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
Returns void
- Defined in index.ts:6460

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

putAddRegRegReg

putAddRegRegReg(dstReg: ArmRegister, leftReg: ArmRegister, rightReg: ArmRegister): void
Puts an ADD instruction.
Parameters
- dstReg: ArmRegister
- leftReg: ArmRegister
- rightReg: ArmRegister
Returns void
- Defined in index.ts:6465

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

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:6358

putBCondLabelWide

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

putBImm

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

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:6304

putBLabelWide

putBLabelWide(labelId: string): void
Puts a B WIDE instruction.
Parameters
- labelId: string
Returns void
- Defined in index.ts:6309

putBeqLabel

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

putBkptImm

putBkptImm(imm: number): void
Puts a BKPT instruction.
Parameters
- imm: number
Returns void
- Defined in index.ts:6525

putBlImm

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

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:6325

putBlxImm

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

putBlxReg

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

putBneLabel

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

putBreakpoint

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

Returns void
- Defined in index.ts:6530

putBxReg

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

putBytes

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

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:6288

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

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

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

putCmpRegImm

putCmpRegImm(reg: ArmRegister, immValue: number): void
Puts a CMP instruction.
Parameters
- reg: ArmRegister
- immValue: number
Returns void
- Defined in index.ts:6340

putInstruction

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

putInstructionWide

putInstructionWide(upper: number, lower: number): void
Puts a raw Thumb-2 instruction.
Parameters
- upper: number
- lower: number
Returns void
- Defined in index.ts:6540

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:6276

putLdmiaRegMask

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

putLdrRegAddress

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

putLdrRegReg

putLdrRegReg(dstReg: ArmRegister, srcReg: ArmRegister): void
Puts an LDR instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
Returns void
- Defined in index.ts:6400

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:6405

putLdrRegU32

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

putLdrbRegReg

putLdrbRegReg(dstReg: ArmRegister, srcReg: ArmRegister): void
Puts an LDRB instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
Returns void
- Defined in index.ts:6410

putLslsRegRegImm

putLslsRegRegImm(dstReg: ArmRegister, leftReg: ArmRegister, rightValue: number): void
Puts a LSLS instruction.
Parameters
- dstReg: ArmRegister
- leftReg: ArmRegister
- rightValue: number
Returns void
- Defined in index.ts:6500

putLsrsRegRegImm

putLsrsRegRegImm(dstReg: ArmRegister, leftReg: ArmRegister, rightValue: number): void
Puts a LSRS instruction.
Parameters
- dstReg: ArmRegister
- leftReg: ArmRegister
- rightValue: number
Returns void
- Defined in index.ts:6505

putMovCpsrReg

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

putMovRegCpsr

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

putMovRegReg

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

putMovRegU8

putMovRegU8(dstReg: ArmRegister, immValue: number): void
Puts a MOV instruction.
Parameters
- dstReg: ArmRegister
- immValue: number
Returns void
- Defined in index.ts:6440

putMrsRegReg

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

putMsrRegReg

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

putNop

putNop(): void
Puts a NOP instruction.

Returns void
- Defined in index.ts:6520

putPopRegs

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

putPushRegs

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

putStrRegReg

putStrRegReg(srcReg: ArmRegister, dstReg: ArmRegister): void
Puts a STR instruction.
Parameters
- srcReg: ArmRegister
- dstReg: ArmRegister
Returns void
- Defined in index.ts:6425

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:6430

putSubRegImm

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

putSubRegReg

putSubRegReg(dstReg: ArmRegister, srcReg: ArmRegister): void
Puts a SUB instruction.
Parameters
- dstReg: ArmRegister
- srcReg: ArmRegister
Returns void
- Defined in index.ts:6480

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

putSubRegRegReg

putSubRegRegReg(dstReg: ArmRegister, leftReg: ArmRegister, rightReg: ArmRegister): void
Puts a SUB instruction.
Parameters
- dstReg: ArmRegister
- leftReg: ArmRegister
- rightReg: ArmRegister
Returns void
- Defined in index.ts:6485

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

reset

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

skip

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

Generated using TypeDoc