#include <MCDisassembler.h>

Inheritance diagram for llvm::MCDisassembler:

Collaboration diagram for llvm::MCDisassembler:

Public Types
enum	DecodeStatus { Fail = 0, SoftFail = 1, Success = 3 }
Public Member Functions
	MCDisassembler (const MCSubtargetInfo &STI, MCContext &Ctx)
	Constructor - Performs initial setup for the disassembler.
virtual	~MCDisassembler ()
virtual DecodeStatus	getInstruction (MCInst &instr, uint64_t &size, const MemoryObject &region, uint64_t address, raw_ostream &vStream, raw_ostream &cStream) const =0
bool	tryAddingSymbolicOperand (MCInst &Inst, int64_t Value, uint64_t Address, bool IsBranch, uint64_t Offset, uint64_t InstSize) const
void	tryAddingPcLoadReferenceComment (int64_t Value, uint64_t Address) const
void	setSymbolizer (std::unique_ptr< MCSymbolizer > Symzer)
MCContext &	getContext () const
const MCSubtargetInfo &	getSubtargetInfo () const
Public Attributes
raw_ostream *	CommentStream
Protected Attributes
const MCSubtargetInfo &	STI
std::unique_ptr< MCSymbolizer >	Symbolizer

Detailed Description

MCDisassembler - Superclass for all disassemblers. Consumes a memory region and provides an array of assembly instructions.

Definition at line 27 of file MCDisassembler.h.

Member Enumeration Documentation

enum llvm::MCDisassembler::DecodeStatus

Ternary decode status. Most backends will just use Fail and Success, however some have a concept of an instruction with understandable semantics but which is architecturally incorrect. An example of this is ARM UNPREDICTABLE instructions which are disassemblable but cause undefined behaviour.

Because it makes sense to disassemble these instructions, there is a "soft fail" failure mode that indicates the MCInst& is valid but architecturally incorrect.

The enum numbers are deliberately chosen such that reduction from Success->SoftFail ->Fail can be done with a simple bitwise-AND:

LEFT & TOP = | Success Unpredictable Fail --------------+----------------------------------- Success | Success Unpredictable Fail Unpredictable | Unpredictable Unpredictable Fail Fail | Fail Fail Fail

An easy way of encoding this is as 0b11, 0b01, 0b00 for Success, SoftFail, Fail respectively.

Enumerator:

Fail
SoftFail
Success

Definition at line 51 of file MCDisassembler.h.

Constructor & Destructor Documentation

llvm::MCDisassembler::MCDisassembler	(	const MCSubtargetInfo &	STI,
		MCContext &	Ctx
	)		`[inline]`

Constructor - Performs initial setup for the disassembler.

Definition at line 58 of file MCDisassembler.h.

MCDisassembler::~MCDisassembler ( ) [virtual]

Definition at line 16 of file MCDisassembler.cpp.

Member Function Documentation

MCContext& llvm::MCDisassembler::getContext ( ) const [inline]

Definition at line 106 of file MCDisassembler.h.

virtual DecodeStatus llvm::MCDisassembler::getInstruction	(	MCInst &	instr,
		uint64_t &	size,
		const MemoryObject &	region,
		uint64_t	address,
		raw_ostream &	vStream,
		raw_ostream &	cStream
	)		const `[pure virtual]`

getInstruction - Returns the disassembly of a single instruction.

Parameters:

instr	- An MCInst to populate with the contents of the instruction.
size	- A value to populate with the size of the instruction, or the number of bytes consumed while attempting to decode an invalid instruction.
region	- The memory object to use as a source for machine code.
address	- The address, in the memory space of region, of the first byte of the instruction.
vStream	- The stream to print warnings and diagnostic messages on.
cStream	- The stream to print comments and annotations on.

Returns:: - MCDisassembler::Success if the instruction is valid, MCDisassembler::SoftFail if the instruction was disassemblable but invalid, MCDisassembler::Fail if the instruction was invalid.

Implemented in llvm::X86Disassembler::X86GenericDisassembler, and llvm::AArch64Disassembler.

Referenced by LLVMDisasmInstruction().

const MCSubtargetInfo& llvm::MCDisassembler::getSubtargetInfo ( ) const [inline]

Definition at line 108 of file MCDisassembler.h.

References STI.

Referenced by DecodeMRSSystemRegister(), and DecodeMSRSystemRegister().

void MCDisassembler::setSymbolizer ( std::unique_ptr< MCSymbolizer > Symzer )

Set Symzer as the current symbolizer. This takes ownership of Symzer, and deletes the previously set one.

Definition at line 37 of file MCDisassembler.cpp.

References Symbolizer.

Referenced by LLVMCreateDisasmCPU().

void MCDisassembler::tryAddingPcLoadReferenceComment	(	int64_t	Value,
		uint64_t	Address
	)		const

Definition at line 30 of file MCDisassembler.cpp.

References CommentStream, llvm::nulls(), and Symbolizer.

Referenced by tryAddingPcLoadReferenceComment().

bool MCDisassembler::tryAddingSymbolicOperand	(	MCInst &	Inst,
		int64_t	Value,
		uint64_t	Address,
		bool	IsBranch,
		uint64_t	Offset,
		uint64_t	InstSize
	)		const