Struct Disassembler

pub struct Disassembler<'a> { /* private fields */ }

Available on crate feature disas only.

A Pulley bytecode disassembler.

This is implemented as an OpVisitor, where you pass a Disassembler to a Decoder in order to disassemble instructions from a bytecode stream.

Alternatively, you can use the Disassembler::disassemble_all method to disassemble a complete bytecode stream.

Implementations

impl<'a> Disassembler<'a>

pub fn disassemble_all(bytecode: &'a [u8]) -> Result<String>

Disassemble every instruction in the given bytecode stream.

pub fn new(bytecode: &'a [u8]) -> Self

Create a new Disassembler that can be used to incrementally disassemble instructions from the given bytecode stream.

pub fn offsets(&mut self, offsets: bool) -> &mut Self

Whether to prefix each instruction’s disassembly with its offset.

True by default.

pub fn hexdump(&mut self, hexdump: bool) -> &mut Self

Whether to include a hexdump of the bytecode in the disassembly.

True by default.

pub fn start_offset(&mut self, offset: usize) -> &mut Self

Configures the offset that this function starts from, if it doesn’t start from 0.

This can possibly be useful when a single function at a time is being disassembled.

pub fn disas(&self) -> &str

Get the disassembly thus far.

Trait Implementations

impl ExtendedOpVisitor for Disassembler<'_>

fn trap(&mut self)

Available on crate feature decode only.

Raise a trap.

fn nop(&mut self)

Available on crate feature decode only.

Do nothing.

fn call_indirect_host(&mut self, sig: u8)

Available on crate feature decode only.

A special opcode to use an indirect function call to reenter the host from the interpreter.

impl<'a> OpVisitor for Disassembler<'a>

type BytecodeStream = SafeBytecodeStream<'a>

Available on crate feature decode only.

The type of this visitor’s bytecode stream.

type Return = ()

Available on crate feature decode only.

The type of values returned by each visitor method.

fn bytecode(&mut self) -> &mut Self::BytecodeStream

Available on crate feature decode only.

Get this visitor’s underlying bytecode stream.

fn before_visit(&mut self)

Available on crate feature decode only.

A callback invoked before starting to decode an instruction.

fn after_visit(&mut self)

Available on crate feature decode only.

A callback invoked after an instruction has been completely decoded.

fn ret(&mut self)

Available on crate feature decode only.

Transfer control the address in the lr register.

fn call(&mut self, offset: PcRelOffset)

Available on crate feature decode only.

Transfer control to the PC at the given offset and set the lr register to the PC just after this instruction.

fn call_indirect(&mut self, reg: XReg)

Available on crate feature decode only.

Transfer control to the PC in reg and set lr to the PC just after this instruction.

fn jump(&mut self, offset: PcRelOffset)

Available on crate feature decode only.

Unconditionally transfer control to the PC at the given offset.

fn br_if(&mut self, cond: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Conditionally transfer control to the given PC offset if cond contains a non-zero value.

fn br_if_not(&mut self, cond: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Conditionally transfer control to the given PC offset if cond contains a zero value.

fn br_if_xeq32(&mut self, a: XReg, b: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Branch if a == b.

fn br_if_xneq32(&mut self, a: XReg, b: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Branch if a != b.

fn br_if_xslt32(&mut self, a: XReg, b: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Branch if signed a < b.

fn br_if_xslteq32(&mut self, a: XReg, b: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Branch if signed a <= b.

fn br_if_xult32(&mut self, a: XReg, b: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Branch if unsigned a < b.

fn br_if_xulteq32(&mut self, a: XReg, b: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Branch if unsigned a <= b.

fn br_if_xeq64(&mut self, a: XReg, b: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Branch if a == b.

fn br_if_xneq64(&mut self, a: XReg, b: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Branch if a != b.

fn br_if_xslt64(&mut self, a: XReg, b: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Branch if signed a < b.

fn br_if_xslteq64(&mut self, a: XReg, b: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Branch if signed a <= b.

fn br_if_xult64(&mut self, a: XReg, b: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Branch if unsigned a < b.

fn br_if_xulteq64(&mut self, a: XReg, b: XReg, offset: PcRelOffset)

Available on crate feature decode only.

Branch if unsigned a <= b.

fn br_table32(&mut self, idx: XReg, amt: u32)

Available on crate feature decode only.

Branch to the label indicated by idx.

fn xmov(&mut self, dst: XReg, src: XReg)

Available on crate feature decode only.

Move between x registers.

fn fmov(&mut self, dst: FReg, src: FReg)

Available on crate feature decode only.

Move between f registers.

fn vmov(&mut self, dst: VReg, src: VReg)

Available on crate feature decode only.

Move between v registers.

fn xconst8(&mut self, dst: XReg, imm: i8)

Available on crate feature decode only.

Set dst = sign_extend(imm8).

fn xconst16(&mut self, dst: XReg, imm: i16)

Available on crate feature decode only.

Set dst = sign_extend(imm16).

fn xconst32(&mut self, dst: XReg, imm: i32)

Available on crate feature decode only.

Set dst = sign_extend(imm32).

fn xconst64(&mut self, dst: XReg, imm: i64)

Available on crate feature decode only.

Set dst = imm64.

fn xadd32(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

32-bit wrapping addition: low32(dst) = low32(src1) + low32(src2).

fn xadd64(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

64-bit wrapping addition: dst = src1 + src2.

fn xeq64(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

64-bit equality.

fn xneq64(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

64-bit inequality.

fn xslt64(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

64-bit signed less-than.

fn xslteq64(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

64-bit signed less-than-equal.

fn xult64(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

64-bit unsigned less-than.

fn xulteq64(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

64-bit unsigned less-than-equal.

fn xeq32(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

32-bit equality.

fn xneq32(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

32-bit inequality.

fn xslt32(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

32-bit signed less-than.

fn xslteq32(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

32-bit signed less-than-equal.

fn xult32(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

32-bit unsigned less-than.

fn xulteq32(&mut self, operands: BinaryOperands<XReg>)

Available on crate feature decode only.

32-bit unsigned less-than-equal.

fn load32_u(&mut self, dst: XReg, ptr: XReg)

Available on crate feature decode only.

dst = zero_extend(load32(ptr))

fn load32_s(&mut self, dst: XReg, ptr: XReg)

Available on crate feature decode only.

dst = sign_extend(load32(ptr))

fn load64(&mut self, dst: XReg, ptr: XReg)

Available on crate feature decode only.

dst = load64(ptr)

fn load32_u_offset8(&mut self, dst: XReg, ptr: XReg, offset: i8)

Available on crate feature decode only.

dst = zero_extend(load32(ptr + offset8))

fn load32_s_offset8(&mut self, dst: XReg, ptr: XReg, offset: i8)

Available on crate feature decode only.

dst = sign_extend(load32(ptr + offset8))

fn load64_offset8(&mut self, dst: XReg, ptr: XReg, offset: i8)

Available on crate feature decode only.

dst = load64(ptr + offset8)

fn load32_u_offset64(&mut self, dst: XReg, ptr: XReg, offset: i64)

Available on crate feature decode only.

dst = zero_extend(load32(ptr + offset64))

fn load32_s_offset64(&mut self, dst: XReg, ptr: XReg, offset: i64)

Available on crate feature decode only.

dst = sign_extend(load32(ptr + offset64))

fn load64_offset64(&mut self, dst: XReg, ptr: XReg, offset: i64)

Available on crate feature decode only.

dst = load64(ptr + offset64)

fn store32(&mut self, ptr: XReg, src: XReg)

Available on crate feature decode only.

*ptr = low32(src)

fn store64(&mut self, ptr: XReg, src: XReg)

Available on crate feature decode only.

*ptr = src

fn store32_offset8(&mut self, ptr: XReg, offset: i8, src: XReg)

Available on crate feature decode only.

*(ptr + sign_extend(offset8)) = low32(src)

fn store64_offset8(&mut self, ptr: XReg, offset: i8, src: XReg)

Available on crate feature decode only.

*(ptr + sign_extend(offset8)) = src

fn store32_offset64(&mut self, ptr: XReg, offset: i64, src: XReg)

Available on crate feature decode only.

*(ptr + sign_extend(offset64)) = low32(src)

fn store64_offset64(&mut self, ptr: XReg, offset: i64, src: XReg)

Available on crate feature decode only.

*(ptr + sign_extend(offset64)) = src

fn push_frame(&mut self)

Available on crate feature decode only.

push lr; push fp; fp = sp

fn pop_frame(&mut self)

Available on crate feature decode only.

sp = fp; pop fp; pop lr

fn xpush32(&mut self, src: XReg)

Available on crate feature decode only.

*sp = low32(src); sp = sp.checked_add(4)

fn xpush32_many(&mut self, srcs: RegSet<XReg>)

Available on crate feature decode only.

for src in srcs { xpush32 src }

fn xpush64(&mut self, src: XReg)

Available on crate feature decode only.

*sp = src; sp = sp.checked_add(8)

fn xpush64_many(&mut self, srcs: RegSet<XReg>)

Available on crate feature decode only.

for src in srcs { xpush64 src }

fn xpop32(&mut self, dst: XReg)

Available on crate feature decode only.

*dst = *sp; sp -= 4

fn xpop32_many(&mut self, dsts: RegSet<XReg>)

Available on crate feature decode only.

for dst in dsts.rev() { xpop32 dst }

fn xpop64(&mut self, dst: XReg)

Available on crate feature decode only.

*dst = *sp; sp -= 8

fn xpop64_many(&mut self, dsts: RegSet<XReg>)

Available on crate feature decode only.

for dst in dsts.rev() { xpop64 dst }

fn bitcast_int_from_float_32(&mut self, dst: XReg, src: FReg)

Available on crate feature decode only.

low32(dst) = bitcast low32(src) as i32

fn bitcast_int_from_float_64(&mut self, dst: XReg, src: FReg)

Available on crate feature decode only.

dst = bitcast src as i64

fn bitcast_float_from_int_32(&mut self, dst: FReg, src: XReg)

Available on crate feature decode only.

low32(dst) = bitcast low32(src) as f32

fn bitcast_float_from_int_64(&mut self, dst: FReg, src: XReg)

Available on crate feature decode only.

dst = bitcast src as f64

fn stack_alloc32(&mut self, amt: u32)

Available on crate feature decode only.

sp = sp.checked_sub(amt)

fn stack_free32(&mut self, amt: u32)

Available on crate feature decode only.

sp = sp + amt