Class X86Writer

Generates machine code for x86.

Hierarchy

X86Writer
- StalkerX86Iterator

Index

Constructors

Properties

base code offset pc

Methods

dispose flush putAddRegImm putAddRegNearPtr putAddRegReg putAndRegReg putAndRegU32 putBreakpoint putBytes putCallAddress putCallAddressWithAlignedArguments putCallAddressWithArguments putCallIndirect putCallIndirectLabel putCallNearLabel putCallReg putCallRegOffsetPtr putCallRegOffsetPtrWithArguments putCallRegWithAlignedArguments putCallRegWithArguments putClc putCld putCmpImmPtrImmU32 putCmpRegI32 putCmpRegOffsetPtrReg putCmpRegReg putCpuid putDecReg putDecRegPtr putIncReg putIncRegPtr putJccNear putJccNearLabel putJccShort putJccShortLabel putJmpAddress putJmpNearLabel putJmpNearPtr putJmpReg putJmpRegOffsetPtr putJmpRegPtr putJmpShortLabel putLabel putLeaRegRegOffset putLeave putLfence putLockCmpxchgRegPtrReg putLockDecImm32Ptr putLockIncImm32Ptr putLockXaddRegPtrReg putMovFsU32PtrReg putMovGsU32PtrReg putMovNearPtrReg putMovRegAddress putMovRegBaseIndexScaleOffsetPtr putMovRegFsU32Ptr putMovRegGsU32Ptr putMovRegNearPtr putMovRegOffsetPtrReg putMovRegOffsetPtrU32 putMovRegPtrReg putMovRegPtrU32 putMovRegReg putMovRegRegOffsetPtr putMovRegRegPtr putMovRegU32 putMovRegU64 putMovdquEaxOffsetPtrXmm0 putMovdquXmm0EspOffsetPtr putMovqEaxOffsetPtrXmm0 putMovqXmm0EspOffsetPtr putNop putNopPadding putPadding putPause putPopReg putPopax putPopfx putPushImmPtr putPushNearPtr putPushReg putPushU32 putPushax putPushfx putRdtsc putRet putRetImm putS8 putShlRegU8 putShrRegU8 putStc putStd putSubRegImm putSubRegNearPtr putSubRegReg putTestRegReg putTestRegU32 putU8 putXchgRegRegPtr putXorRegReg reset

Constructors

constructor

new X86Writer(codeAddress: NativePointerValue, options?: X86WriterOptions): X86Writer
Creates a new code writer for generating x86 machine code written directly to memory at codeAddress.
Parameters
- codeAddress: NativePointerValue
  
  Memory address to write generated code to.
- Optional options: X86WriterOptions
  
  Options for customizing code generation.
Returns X86Writer
- Defined in index.ts:5127

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

dispose

dispose(): void
Eagerly cleans up memory.

Returns void
- Defined in index.ts:5137

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

putAddRegImm

putAddRegImm(reg: X86Register, immValue: number | Int64 | UInt64): void
Puts an ADD instruction.
Parameters
- reg: X86Register
- immValue: number | Int64 | UInt64
Returns void
- Defined in index.ts:5309

putAddRegNearPtr

putAddRegNearPtr(dstReg: X86Register, srcAddress: NativePointerValue): void
Puts an ADD instruction.
Parameters
- dstReg: X86Register
- srcAddress: NativePointerValue
Returns void
- Defined in index.ts:5319

putAddRegReg

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

putAndRegReg

putAndRegReg(dstReg: X86Register, srcReg: X86Register): void
Puts an AND instruction.
Parameters
- dstReg: X86Register
- srcReg: X86Register
Returns void
- Defined in index.ts:5379

putAndRegU32

putAndRegU32(reg: X86Register, immValue: number): void
Puts an AND instruction.
Parameters
- reg: X86Register
- immValue: number
Returns void
- Defined in index.ts:5384

putBreakpoint

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

Returns void
- Defined in index.ts:5639

putBytes

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

putCallAddress

putCallAddress(address: NativePointerValue): void
Puts a CALL instruction.
Parameters
- address: NativePointerValue
Returns void
- Defined in index.ts:5203

putCallAddressWithAlignedArguments

putCallAddressWithAlignedArguments(func: NativePointerValue, args: X86CallArgument[]): void
Like putCallWithArguments(), but also ensures that the argument list is aligned on a 16 byte boundary.
Parameters
- func: NativePointerValue
- args: X86CallArgument[]
Returns void
- Defined in index.ts:5182

putCallAddressWithArguments

putCallAddressWithArguments(func: NativePointerValue, args: X86CallArgument[]): void
Puts code needed for calling a C function with the specified args.
Parameters
- func: NativePointerValue
- args: X86CallArgument[]
Returns void
- Defined in index.ts:5176

putCallIndirect

putCallIndirect(addr: NativePointerValue): void
Puts a CALL instruction.
Parameters
- addr: NativePointerValue
Returns void
- Defined in index.ts:5218

putCallIndirectLabel

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

putCallNearLabel

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

putCallReg

putCallReg(reg: X86Register): void
Puts a CALL instruction.
Parameters
- reg: X86Register
Returns void
- Defined in index.ts:5208

putCallRegOffsetPtr

putCallRegOffsetPtr(reg: X86Register, offset: number | Int64 | UInt64): void
Puts a CALL instruction.
Parameters
- reg: X86Register
- offset: number | Int64 | UInt64
Returns void
- Defined in index.ts:5213

putCallRegOffsetPtrWithArguments

putCallRegOffsetPtrWithArguments(reg: X86Register, offset: number | Int64 | UInt64, args: X86CallArgument[]): void
Puts code needed for calling a C function with the specified args.
Parameters
- reg: X86Register
- offset: number | Int64 | UInt64
- args: X86CallArgument[]
Returns void
- Defined in index.ts:5198

putCallRegWithAlignedArguments

putCallRegWithAlignedArguments(reg: X86Register, args: X86CallArgument[]): void
Like putCallWithArguments(), but also ensures that the argument list is aligned on a 16 byte boundary.
Parameters
- reg: X86Register
- args: X86CallArgument[]
Returns void
- Defined in index.ts:5193

putCallRegWithArguments

putCallRegWithArguments(reg: X86Register, args: X86CallArgument[]): void
Puts code needed for calling a C function with the specified args.
Parameters
- reg: X86Register
- args: X86CallArgument[]
Returns void
- Defined in index.ts:5187

putClc

putClc(): void
Puts a CLC instruction.

Returns void
- Defined in index.ts:5594

putCld

putCld(): void
Puts a CLD instruction.

Returns void
- Defined in index.ts:5604

putCmpImmPtrImmU32

putCmpImmPtrImmU32(immPtr: NativePointerValue, immValue: number): void
Puts a CMP instruction.
Parameters
- immPtr: NativePointerValue
- immValue: number
Returns void
- Defined in index.ts:5584

putCmpRegI32

putCmpRegI32(reg: X86Register, immValue: number): void
Puts a CMP instruction.
Parameters
- reg: X86Register
- immValue: number
Returns void
- Defined in index.ts:5574

putCmpRegOffsetPtrReg

putCmpRegOffsetPtrReg(regA: X86Register, offset: number | Int64 | UInt64, regB: X86Register): void
Puts a CMP instruction.
Parameters
- regA: X86Register
- offset: number | Int64 | UInt64
- regB: X86Register
Returns void
- Defined in index.ts:5579

putCmpRegReg

putCmpRegReg(regA: X86Register, regB: X86Register): void
Puts a CMP instruction.
Parameters
- regA: X86Register
- regB: X86Register
Returns void
- Defined in index.ts:5589

putCpuid

putCpuid(): void
Puts a CPUID instruction.

Returns void
- Defined in index.ts:5614

putDecReg

putDecReg(reg: X86Register): void
Puts a DEC instruction.
Parameters
- reg: X86Register
Returns void
- Defined in index.ts:5344

putDecRegPtr

putDecRegPtr(target: X86PointerTarget, reg: X86Register): void
Puts a DEC instruction.
Parameters
- target: X86PointerTarget
- reg: X86Register
Returns void
- Defined in index.ts:5354

putIncReg

putIncReg(reg: X86Register): void
Puts an INC instruction.
Parameters
- reg: X86Register
Returns void
- Defined in index.ts:5339

putIncRegPtr

putIncRegPtr(target: X86PointerTarget, reg: X86Register): void
Puts an INC instruction.
Parameters
- target: X86PointerTarget
- reg: X86Register
Returns void
- Defined in index.ts:5349

putJccNear

putJccNear(instructionId: X86InstructionId, target: NativePointerValue, hint: X86BranchHint): void
Puts a JCC instruction.
Parameters
- instructionId: X86InstructionId
- target: NativePointerValue
- hint: X86BranchHint
Returns void
- Defined in index.ts:5292

putJccNearLabel

putJccNearLabel(instructionId: X86InstructionId, labelId: string, hint: X86BranchHint): void
Puts a JCC instruction referencing labelId, defined by a past or future putLabel().
Parameters
- instructionId: X86InstructionId
- labelId: string
- hint: X86BranchHint
Returns void
- Defined in index.ts:5304

putJccShort

putJccShort(instructionId: X86InstructionId, target: NativePointerValue, hint: X86BranchHint): void
Puts a JCC instruction.
Parameters
- instructionId: X86InstructionId
- target: NativePointerValue
- hint: X86BranchHint
Returns void
- Defined in index.ts:5287

putJccShortLabel

putJccShortLabel(instructionId: X86InstructionId, labelId: string, hint: X86BranchHint): void
Puts a JCC instruction referencing labelId, defined by a past or future putLabel().
Parameters
- instructionId: X86InstructionId
- labelId: string
- hint: X86BranchHint
Returns void
- Defined in index.ts:5298

putJmpAddress

putJmpAddress(address: NativePointerValue): void
Puts a JMP instruction.
Parameters
- address: NativePointerValue
Returns void
- Defined in index.ts:5250

putJmpNearLabel

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

putJmpNearPtr

putJmpNearPtr(address: NativePointerValue): void
Puts a JMP instruction.
Parameters
- address: NativePointerValue
Returns void
- Defined in index.ts:5282

putJmpReg

putJmpReg(reg: X86Register): void
Puts a JMP instruction.
Parameters
- reg: X86Register
Returns void
- Defined in index.ts:5267

putJmpRegOffsetPtr

putJmpRegOffsetPtr(reg: X86Register, offset: number | Int64 | UInt64): void
Puts a JMP instruction.
Parameters
- reg: X86Register
- offset: number | Int64 | UInt64
Returns void
- Defined in index.ts:5277

putJmpRegPtr

putJmpRegPtr(reg: X86Register): void
Puts a JMP instruction.
Parameters
- reg: X86Register
Returns void
- Defined in index.ts:5272

putJmpShortLabel

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

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

putLeaRegRegOffset

putLeaRegRegOffset(dstReg: X86Register, srcReg: X86Register, srcOffset: number | Int64 | UInt64): void
Puts a LEA instruction.
Parameters
- dstReg: X86Register
- srcReg: X86Register
- srcOffset: number | Int64 | UInt64
Returns void
- Defined in index.ts:5509

putLeave

putLeave(): void
Puts a LEAVE instruction.

Returns void
- Defined in index.ts:5235

putLfence

putLfence(): void
Puts an LFENCE instruction.

Returns void
- Defined in index.ts:5619

putLockCmpxchgRegPtrReg

putLockCmpxchgRegPtrReg(dstReg: X86Register, srcReg: X86Register): void
Puts a LOCK CMPXCHG instruction.
Parameters
- dstReg: X86Register
- srcReg: X86Register
Returns void
- Defined in index.ts:5364

putLockDecImm32Ptr

putLockDecImm32Ptr(target: NativePointerValue): void
Puts a LOCK DEC IMM32 instruction.
Parameters
- target: NativePointerValue
Returns void
- Defined in index.ts:5374

putLockIncImm32Ptr

putLockIncImm32Ptr(target: NativePointerValue): void
Puts a LOCK INC IMM32 instruction.
Parameters
- target: NativePointerValue
Returns void
- Defined in index.ts:5369

putLockXaddRegPtrReg

putLockXaddRegPtrReg(dstReg: X86Register, srcReg: X86Register): void
Puts a LOCK XADD instruction.
Parameters
- dstReg: X86Register
- srcReg: X86Register
Returns void
- Defined in index.ts:5359

putMovFsU32PtrReg

putMovFsU32PtrReg(fsOffset: number, srcReg: X86Register): void
Puts a MOV FS instruction.
Parameters
- fsOffset: number
- srcReg: X86Register
Returns void
- Defined in index.ts:5469

putMovGsU32PtrReg

putMovGsU32PtrReg(fsOffset: number, srcReg: X86Register): void
Puts a MOV GS instruction.
Parameters
- fsOffset: number
- srcReg: X86Register
Returns void
- Defined in index.ts:5479

putMovNearPtrReg

putMovNearPtrReg(dstAddress: NativePointerValue, srcReg: X86Register): void
Puts a MOV instruction.
Parameters
- dstAddress: NativePointerValue
- srcReg: X86Register
Returns void
- Defined in index.ts:5464

putMovRegAddress

putMovRegAddress(dstReg: X86Register, address: NativePointerValue): void
Puts a MOV instruction.
Parameters
- dstReg: X86Register
- address: NativePointerValue
Returns void
- Defined in index.ts:5419

putMovRegBaseIndexScaleOffsetPtr

putMovRegBaseIndexScaleOffsetPtr(dstReg: X86Register, baseReg: X86Register, indexReg: X86Register, scale: number, offset: number | Int64 | UInt64): void
Puts a MOV instruction.
Parameters
- dstReg: X86Register
- baseReg: X86Register
- indexReg: X86Register
- scale: number
- offset: number | Int64 | UInt64
Returns void
- Defined in index.ts:5454

putMovRegFsU32Ptr

putMovRegFsU32Ptr(dstReg: X86Register, fsOffset: number): void
Puts a MOV FS instruction.
Parameters
- dstReg: X86Register
- fsOffset: number
Returns void
- Defined in index.ts:5474

putMovRegGsU32Ptr

putMovRegGsU32Ptr(dstReg: X86Register, fsOffset: number): void
Puts a MOV GS instruction.
Parameters
- dstReg: X86Register
- fsOffset: number
Returns void
- Defined in index.ts:5484

putMovRegNearPtr

putMovRegNearPtr(dstReg: X86Register, srcAddress: NativePointerValue): void
Puts a MOV instruction.
Parameters
- dstReg: X86Register
- srcAddress: NativePointerValue
Returns void
- Defined in index.ts:5459

putMovRegOffsetPtrReg

putMovRegOffsetPtrReg(dstReg: X86Register, dstOffset: number | Int64 | UInt64, srcReg: X86Register): void
Puts a MOV instruction.
Parameters
- dstReg: X86Register
- dstOffset: number | Int64 | UInt64
- srcReg: X86Register
Returns void
- Defined in index.ts:5439

putMovRegOffsetPtrU32

putMovRegOffsetPtrU32(dstReg: X86Register, dstOffset: number | Int64 | UInt64, immValue: number): void
Puts a MOV instruction.
Parameters
- dstReg: X86Register
- dstOffset: number | Int64 | UInt64
- immValue: number
Returns void
- Defined in index.ts:5429

putMovRegPtrReg

putMovRegPtrReg(dstReg: X86Register, srcReg: X86Register): void
Puts a MOV instruction.
Parameters
- dstReg: X86Register
- srcReg: X86Register
Returns void
- Defined in index.ts:5434

putMovRegPtrU32

putMovRegPtrU32(dstReg: X86Register, immValue: number): void
Puts a MOV instruction.
Parameters
- dstReg: X86Register
- immValue: number
Returns void
- Defined in index.ts:5424

putMovRegReg

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

putMovRegRegOffsetPtr

putMovRegRegOffsetPtr(dstReg: X86Register, srcReg: X86Register, srcOffset: number | Int64 | UInt64): void
Puts a MOV instruction.
Parameters
- dstReg: X86Register
- srcReg: X86Register
- srcOffset: number | Int64 | UInt64
Returns void
- Defined in index.ts:5449

putMovRegRegPtr

putMovRegRegPtr(dstReg: X86Register, srcReg: X86Register): void
Puts a MOV instruction.
Parameters
- dstReg: X86Register
- srcReg: X86Register
Returns void
- Defined in index.ts:5444

putMovRegU32

putMovRegU32(dstReg: X86Register, immValue: number): void
Puts a MOV instruction.
Parameters
- dstReg: X86Register
- immValue: number
Returns void
- Defined in index.ts:5409

putMovRegU64

putMovRegU64(dstReg: X86Register, immValue: number | UInt64): void
Puts a MOV instruction.
Parameters
- dstReg: X86Register
- immValue: number | UInt64
Returns void
- Defined in index.ts:5414

putMovdquEaxOffsetPtrXmm0

putMovdquEaxOffsetPtrXmm0(offset: number): void
Puts a MOVDQU EAX XMM0 instruction.
Parameters
- offset: number
Returns void
- Defined in index.ts:5504

putMovdquXmm0EspOffsetPtr

putMovdquXmm0EspOffsetPtr(offset: number): void
Puts a MOVDQU XMM0 ESP instruction.
Parameters
- offset: number
Returns void
- Defined in index.ts:5499

putMovqEaxOffsetPtrXmm0

putMovqEaxOffsetPtrXmm0(offset: number): void
Puts a MOVQ EAX XMM0 instruction.
Parameters
- offset: number
Returns void
- Defined in index.ts:5494

putMovqXmm0EspOffsetPtr

putMovqXmm0EspOffsetPtr(offset: number): void
Puts a MOVQ XMM0 ESP instruction.
Parameters
- offset: number
Returns void
- Defined in index.ts:5489

putNop

putNop(): void
Puts a NOP instruction.

Returns void
- Defined in index.ts:5634

putNopPadding

putNopPadding(n: number): void
Puts n NOP instructions.
Parameters
- n: number
Returns void
- Defined in index.ts:5649

putPadding

putPadding(n: number): void
Puts n guard instruction.
Parameters
- n: number
Returns void
- Defined in index.ts:5644

putPause

putPause(): void
Puts a PAUSE instruction.

Returns void
- Defined in index.ts:5629

putPopReg

putPopReg(reg: X86Register): void
Puts a POP instruction.
Parameters
- reg: X86Register
Returns void
- Defined in index.ts:5534

putPopax

putPopax(): void
Puts a POPAX instruction.

Returns void
- Defined in index.ts:5549

putPopfx

putPopfx(): void
Puts a POPFX instruction.

Returns void
- Defined in index.ts:5559

putPushImmPtr

putPushImmPtr(immPtr: NativePointerValue): void
Puts a PUSH instruction.
Parameters
- immPtr: NativePointerValue
Returns void
- Defined in index.ts:5539

putPushNearPtr

putPushNearPtr(address: NativePointerValue): void
Puts a PUSH instruction.
Parameters
- address: NativePointerValue
Returns void
- Defined in index.ts:5524

putPushReg

putPushReg(reg: X86Register): void
Puts a PUSH instruction.
Parameters
- reg: X86Register
Returns void
- Defined in index.ts:5529

putPushU32

putPushU32(immValue: number): void
Puts a PUSH instruction.
Parameters
- immValue: number
Returns void
- Defined in index.ts:5519

putPushax

putPushax(): void
Puts a PUSHAX instruction.

Returns void
- Defined in index.ts:5544

putPushfx

putPushfx(): void
Puts a PUSHFX instruction.

Returns void
- Defined in index.ts:5554

putRdtsc

putRdtsc(): void
Puts an RDTSC instruction.

Returns void
- Defined in index.ts:5624

putRet

putRet(): void
Puts a RET instruction.

Returns void
- Defined in index.ts:5240

putRetImm

putRetImm(immValue: number): void
Puts a RET instruction.
Parameters
- immValue: number
Returns void
- Defined in index.ts:5245

putS8

putS8(value: number): void
Puts an int8.
Parameters
- value: number
Returns void
- Defined in index.ts:5659

putShlRegU8

putShlRegU8(reg: X86Register, immValue: number): void
Puts a SHL instruction.
Parameters
- reg: X86Register
- immValue: number
Returns void
- Defined in index.ts:5389

putShrRegU8

putShrRegU8(reg: X86Register, immValue: number): void
Puts a SHR instruction.
Parameters
- reg: X86Register
- immValue: number
Returns void
- Defined in index.ts:5394

putStc

putStc(): void
Puts a STC instruction.

Returns void
- Defined in index.ts:5599

putStd

putStd(): void
Puts a STD instruction.

Returns void
- Defined in index.ts:5609

putSubRegImm

putSubRegImm(reg: X86Register, immValue: number | Int64 | UInt64): void
Puts a SUB instruction.
Parameters
- reg: X86Register
- immValue: number | Int64 | UInt64
Returns void
- Defined in index.ts:5324

putSubRegNearPtr

putSubRegNearPtr(dstReg: X86Register, srcAddress: NativePointerValue): void
Puts a SUB instruction.
Parameters
- dstReg: X86Register
- srcAddress: NativePointerValue
Returns void
- Defined in index.ts:5334

putSubRegReg

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

putTestRegReg

putTestRegReg(regA: X86Register, regB: X86Register): void
Puts a TEST instruction.
Parameters
- regA: X86Register
- regB: X86Register
Returns void
- Defined in index.ts:5564

putTestRegU32

putTestRegU32(reg: X86Register, immValue: number): void
Puts a TEST instruction.
Parameters
- reg: X86Register
- immValue: number
Returns void
- Defined in index.ts:5569

putU8

putU8(value: number): void
Puts a uint8.
Parameters
- value: number
Returns void
- Defined in index.ts:5654

putXchgRegRegPtr

putXchgRegRegPtr(leftReg: X86Register, rightReg: X86Register): void
Puts an XCHG instruction.
Parameters
- leftReg: X86Register
- rightReg: X86Register
Returns void
- Defined in index.ts:5514

putXorRegReg

putXorRegReg(dstReg: X86Register, srcReg: X86Register): void
Puts an XOR instruction.
Parameters
- dstReg: X86Register
- srcReg: X86Register
Returns void
- Defined in index.ts:5399

reset

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

Generated using TypeDoc