Class MipsWriter

Generates machine code for mips.

Constructors

constructor

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

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

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

putAddiRegImm

putAddiRegImm(dstReg: MipsRegister, imm: number): void
Puts an ADDI instruction.
Parameters
- dstReg: MipsRegister
- imm: number
Returns void

putAddiRegRegImm

putAddiRegRegImm(dstReg: MipsRegister, leftReg: MipsRegister, imm: number): void
Puts an ADDI instruction.
Parameters
- dstReg: MipsRegister
- leftReg: MipsRegister
- imm: number
Returns void

putAdduRegRegReg

putAdduRegRegReg(
    dstReg: MipsRegister,
    leftReg: MipsRegister,
    rightReg: MipsRegister,
): void
Puts an ADDU instruction.
Parameters
- dstReg: MipsRegister
- leftReg: MipsRegister
- rightReg: MipsRegister
Returns void

putBeqRegRegLabel

putBeqRegRegLabel(
    rightReg: MipsRegister,
    leftReg: MipsRegister,
    labelId: string,
): void
Puts a BEQ instruction referencing labelId, defined by a past or future putLabel().
Parameters
- rightReg: MipsRegister
- leftReg: MipsRegister
- labelId: string
Returns void

putBOffset

putBOffset(offset: number): void
Puts a B instruction.
Parameters
- offset: number
Returns void

putBreak

putBreak(): void
Puts a BREAK instruction.

Returns void

putBytes

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

putCallAddressWithArguments

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

putCallRegWithArguments

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

putDsllRegReg

putDsllRegReg(dstReg: MipsRegister, srcReg: MipsRegister, amount: number): void
Puts a DSLL instruction.
Parameters
- dstReg: MipsRegister
- srcReg: MipsRegister
- amount: number
Returns void

putInstruction

putInstruction(insn: number): void
Puts a raw instruction.
Parameters
- insn: number
Returns void

putJAddress

putJAddress(address: NativePointerValue): void
Puts a J instruction.
Parameters
- address: NativePointerValue
Returns void

putJAddressWithoutNop

putJAddressWithoutNop(address: NativePointerValue): void
Puts a J WITHOUT NOP instruction.
Parameters
- address: NativePointerValue
Returns void

putJalAddress

putJalAddress(address: number): void
Puts a JAL instruction.
Parameters
- address: number
Returns void

putJalrReg

putJalrReg(reg: MipsRegister): void
Puts a JALR instruction.
Parameters
- reg: MipsRegister
Returns void

putJLabel

putJLabel(labelId: string): void
Puts a J instruction referencing labelId, defined by a past or future putLabel().
Parameters
- labelId: string
Returns void

putJrReg

putJrReg(reg: MipsRegister): void
Puts a JR instruction.
Parameters
- reg: MipsRegister
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

putLaRegAddress

putLaRegAddress(reg: MipsRegister, address: NativePointerValue): void
Puts a LA instruction.
Parameters
- reg: MipsRegister
- address: NativePointerValue
Returns void

putLdRegRegOffset

putLdRegRegOffset(
    dstReg: MipsRegister,
    srcReg: MipsRegister,
    srcOffset: number | Int64 | UInt64,
): void
Puts an LD instruction.
Parameters
- dstReg: MipsRegister
- srcReg: MipsRegister
- srcOffset: number | Int64 | UInt64
Returns void

putLuiRegImm

putLuiRegImm(reg: MipsRegister, imm: number): void
Puts a LUI instruction.
Parameters
- reg: MipsRegister
- imm: number
Returns void

putLwRegRegOffset

putLwRegRegOffset(
    dstReg: MipsRegister,
    srcReg: MipsRegister,
    srcOffset: number | Int64 | UInt64,
): void
Puts a LW instruction.
Parameters
- dstReg: MipsRegister
- srcReg: MipsRegister
- srcOffset: number | Int64 | UInt64
Returns void

putMfhiReg

putMfhiReg(reg: MipsRegister): void
Puts a MFHI instruction.
Parameters
- reg: MipsRegister
Returns void

putMfloReg

putMfloReg(reg: MipsRegister): void
Puts a MFLO instruction.
Parameters
- reg: MipsRegister
Returns void

putMoveRegReg

putMoveRegReg(dstReg: MipsRegister, srcReg: MipsRegister): void
Puts a MOVE instruction.
Parameters
- dstReg: MipsRegister
- srcReg: MipsRegister
Returns void

putMthiReg

putMthiReg(reg: MipsRegister): void
Puts a MTHI instruction.
Parameters
- reg: MipsRegister
Returns void

putMtloReg

putMtloReg(reg: MipsRegister): void
Puts a MTLO instruction.
Parameters
- reg: MipsRegister
Returns void

putNop

putNop(): void
Puts a NOP instruction.

Returns void

putOriRegRegImm

putOriRegRegImm(rt: MipsRegister, rs: MipsRegister, imm: number): void
Puts an ORI instruction.
Parameters
- rt: MipsRegister
- rs: MipsRegister
- imm: number
Returns void

putPopReg

putPopReg(reg: MipsRegister): void
Puts a POP instruction.
Parameters
- reg: MipsRegister
Returns void

putPrologueTrampoline

putPrologueTrampoline(reg: MipsRegister, address: NativePointerValue): void
Puts a minimal sized trampoline for vectoring to the given address.
Parameters
- reg: MipsRegister
- address: NativePointerValue
Returns void

putPushReg

putPushReg(reg: MipsRegister): void
Puts a PUSH instruction.
Parameters
- reg: MipsRegister
Returns void

putRet

putRet(): void
Puts a RET instruction.

Returns void

putSubRegRegImm

putSubRegRegImm(dstReg: MipsRegister, leftReg: MipsRegister, imm: number): void
Puts a SUB instruction.
Parameters
- dstReg: MipsRegister
- leftReg: MipsRegister
- imm: number
Returns void

putSwRegRegOffset

putSwRegRegOffset(
    srcReg: MipsRegister,
    dstReg: MipsRegister,
    dstOffset: number | Int64 | UInt64,
): void
Puts a SW instruction.
Parameters
- srcReg: MipsRegister
- dstReg: MipsRegister
- dstOffset: number | Int64 | UInt64
Returns void

reset

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

skip

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