#include "X86Disassembler.h"
#include "X86DisassemblerDecoder.h"
#include "llvm/MC/MCContext.h"
#include "llvm/MC/MCDisassembler.h"
#include "llvm/MC/MCExpr.h"
#include "llvm/MC/MCInst.h"
#include "llvm/MC/MCInstrInfo.h"
#include "llvm/MC/MCSubtargetInfo.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/MemoryObject.h"
#include "llvm/Support/TargetRegistry.h"
#include "llvm/Support/raw_ostream.h"
#include "X86GenRegisterInfo.inc"
#include "X86GenInstrInfo.inc"
#include "X86GenSubtargetInfo.inc"

Include dependency graph for X86Disassembler.cpp:

Namespaces
namespace	llvm
	List of target independent CodeGen pass IDs.
namespace	llvm::X86
	Define some predicates that are used for node matching.
Defines
#define	DEBUG_TYPE "x86-disassembler"
#define	GET_REGINFO_ENUM
#define	GET_INSTRINFO_ENUM
#define	GET_SUBTARGETINFO_ENUM
#define	debug(s) DEBUG(Debug(__FILE__, __LINE__, s));
#define	ENTRY(x) X86::x,
#define	ENTRY(x) case EA_BASE_##x:
#define	ENTRY(x)
#define	ENTRY(x)
#define	ENTRY(x)
#define	ENTRY(x)
#define	ENTRY(x) case EA_REG_##x:
Enumerations
enum	{ llvm::X86::BX_SI = 500, llvm::X86::BX_DI = 501, llvm::X86::BP_SI = 502, llvm::X86::BP_DI = 503, llvm::X86::sib = 504, llvm::X86::sib64 = 505 }
Functions
static bool	translateInstruction (MCInst &target, InternalInstruction &source, const MCDisassembler *Dis)
static int	regionReader (const void arg, uint8_t byte, uint64_t address)
static void	logger (void arg, const char log)
static void	translateRegister (MCInst &mcInst, Reg reg)
static bool	tryAddingSymbolicOperand (int64_t Value, bool isBranch, uint64_t Address, uint64_t Offset, uint64_t Width, MCInst &MI, const MCDisassembler *Dis)
static void	tryAddingPcLoadReferenceComment (uint64_t Address, uint64_t Value, const void *Decoder)
static bool	translateSrcIndex (MCInst &mcInst, InternalInstruction &insn)
static bool	translateDstIndex (MCInst &mcInst, InternalInstruction &insn)
static void	translateImmediate (MCInst &mcInst, uint64_t immediate, const OperandSpecifier &operand, InternalInstruction &insn, const MCDisassembler *Dis)
static bool	translateRMRegister (MCInst &mcInst, InternalInstruction &insn)
static bool	translateRMMemory (MCInst &mcInst, InternalInstruction &insn, const MCDisassembler *Dis)
static bool	translateRM (MCInst &mcInst, const OperandSpecifier &operand, InternalInstruction &insn, const MCDisassembler *Dis)
static void	translateFPRegister (MCInst &mcInst, uint8_t stackPos)
static bool	translateMaskRegister (MCInst &mcInst, uint8_t maskRegNum)
static bool	translateOperand (MCInst &mcInst, const OperandSpecifier &operand, InternalInstruction &insn, const MCDisassembler *Dis)
static MCDisassembler *	createX86Disassembler (const Target &T, const MCSubtargetInfo &STI, MCContext &Ctx)
void	LLVMInitializeX86Disassembler ()
Variables
Target	llvm::TheX86_32Target
Target	llvm::TheX86_64Target
static const uint8_t	segmentRegnums [SEG_OVERRIDE_max]

Define Documentation

#define debug ( s ) DEBUG(Debug(__FILE__, __LINE__, s));

Definition at line 53 of file X86Disassembler.cpp.

Referenced by translateInstruction(), translateMaskRegister(), translateOperand(), translateRM(), translateRMMemory(), and translateRMRegister().

#define DEBUG_TYPE "x86-disassembler"

Definition at line 33 of file X86Disassembler.cpp.

#define ENTRY ( x ) X86::x,

#define ENTRY ( x ) case EA_BASE_##x:

#define ENTRY ( x )

Value:

case EA_REG_##x:                                                    \
    mcInst.addOperand(MCOperand::CreateReg(X86::x)); break;

#define ENTRY ( x )

Value:

case SIB_BASE_##x:                                  \
        baseReg = MCOperand::CreateReg(X86::x); break;

#define ENTRY ( x )

Value:

case SIB_INDEX_##x:                                 \
        indexReg = MCOperand::CreateReg(X86::x); break;

#define ENTRY ( x )

Value:

case EA_BASE_##x:                                 \
        baseReg = MCOperand::CreateReg(X86::x); break;

#define ENTRY ( x ) case EA_REG_##x:

#define GET_INSTRINFO_ENUM

Definition at line 37 of file X86Disassembler.cpp.

#define GET_REGINFO_ENUM

Definition at line 35 of file X86Disassembler.cpp.

#define GET_SUBTARGETINFO_ENUM

Definition at line 39 of file X86Disassembler.cpp.

Function Documentation

static MCDisassembler* createX86Disassembler	(	const Target &	T,
		const MCSubtargetInfo &	STI,
		MCContext &	Ctx
	)		`[static]`

Definition at line 803 of file X86Disassembler.cpp.

References llvm::Target::createMCInstrInfo().

Referenced by LLVMInitializeX86Disassembler().

void LLVMInitializeX86Disassembler ( )

Definition at line 810 of file X86Disassembler.cpp.

References createX86Disassembler(), llvm::TargetRegistry::RegisterMCDisassembler(), llvm::TheX86_32Target, and llvm::TheX86_64Target.

static void logger	(	void *	arg,
		const char *	log
	)		`[static]`

logger - a callback function that wraps the operator<< method from raw_ostream.

Parameters:

arg	- The generic callback parameter. This should be a pointe to a raw_ostream.
log	- A string to be logged. logger() adds a newline.

Definition at line 118 of file X86Disassembler.cpp.

Referenced by llvm::X86Disassembler::decodeInstruction(), and llvm::X86Disassembler::X86GenericDisassembler::getInstruction().

static int regionReader	(	const void *	arg,
		uint8_t *	byte,
		uint64_t	address
	)		`[static]`

regionReader - a callback function that wraps the readByte method from MemoryObject.

Parameters:

arg	- The generic callback parameter. In this case, this should be a pointer to a MemoryObject.
byte	- A pointer to the byte to be read.
address	- The address to be read.

Definition at line 107 of file X86Disassembler.cpp.

References llvm::MemoryObject::readByte().

Referenced by llvm::X86Disassembler::X86GenericDisassembler::getInstruction().

static bool translateDstIndex	(	MCInst &	mcInst,
		InternalInstruction &	insn
	)		`[static]`

translateDstIndex - Appends a destination index operand to an MCInst.

Parameters:

mcInst	- The MCInst to append to.
insn	- The internal instruction.

Definition at line 265 of file X86Disassembler.cpp.

References llvm::MCInst::addOperand(), llvm::MCOperand::CreateReg(), llvm::N86::EDI, llvm::X86Disassembler::InternalInstruction::mode, llvm::X86Disassembler::MODE_16BIT, llvm::X86Disassembler::MODE_32BIT, llvm::X86Disassembler::MODE_64BIT, and llvm::X86Disassembler::InternalInstruction::prefixPresent.

Referenced by translateOperand().

static void translateFPRegister	(	MCInst &	mcInst,
		uint8_t	stackPos
	)		`[static]`

translateFPRegister - Translates a stack position on the FPU stack to its LLVM form, and appends it to an MCInst.

Parameters:

mcInst	- The MCInst to append to.
stackPos	- The stack position to translate.

Definition at line 679 of file X86Disassembler.cpp.

References llvm::MCInst::addOperand(), and llvm::MCOperand::CreateReg().

Referenced by translateOperand().

static void translateImmediate	(	MCInst &	mcInst,
		uint64_t	immediate,
		const OperandSpecifier &	operand,
		InternalInstruction &	insn,
		const MCDisassembler *	Dis
	)		`[static]`

translateImmediate - Appends an immediate operand to an MCInst.

Parameters:

mcInst	- The MCInst to append to.
immediate	- The immediate value to append.
operand	- The operand, as stored in the descriptor table.
insn	- The internal instruction.

Definition at line 287 of file X86Disassembler.cpp.

References llvm::MCInst::addOperand(), llvm::MCOperand::CreateImm(), llvm::MCOperand::CreateReg(), llvm::X86Disassembler::InternalInstruction::displacementSize, llvm::X86Disassembler::OperandSpecifier::encoding, llvm::MCInst::getOpcode(), if(), llvm::X86Disassembler::InternalInstruction::immediateOffset, llvm::X86Disassembler::InternalInstruction::immediateSize, isBranch(), llvm::X86Disassembler::InternalInstruction::segmentOverride, segmentRegnums, llvm::X86Disassembler::InternalInstruction::startLocation, tryAddingSymbolicOperand(), and llvm::X86Disassembler::OperandSpecifier::type.

Referenced by translateOperand().

static bool translateInstruction	(	MCInst &	mcInst,
		InternalInstruction &	insn,
		const MCDisassembler *	Dis
	)		`[static]`

translateInstruction - Translates an internal instruction and all its operands to an MCInst.

Parameters:

mcInst	- The MCInst to populate with the instruction's data.
insn	- The internal instruction.

Returns:: - false on success; true otherwise.

Definition at line 771 of file X86Disassembler.cpp.

References debug, llvm::MCInst::getOpcode(), llvm::X86Disassembler::InternalInstruction::instructionID, llvm::X86Disassembler::InternalInstruction::numImmediatesTranslated, llvm::X86Disassembler::InternalInstruction::operands, llvm::MCInst::setOpcode(), llvm::X86Disassembler::InternalInstruction::spec, translateOperand(), and llvm::X86Disassembler::InternalInstruction::xAcquireRelease.

Referenced by llvm::X86Disassembler::X86GenericDisassembler::getInstruction().

static bool translateMaskRegister	(	MCInst &	mcInst,
		uint8_t	maskRegNum
	)		`[static]`

translateMaskRegister - Translates a 3-bit mask register number to LLVM form, and appends it to an MCInst.

Parameters:

mcInst	- The MCInst to append to.
maskRegNum	- Number of mask register from 0 to 7.

Returns:: - false on success; true otherwise.

Definition at line 690 of file X86Disassembler.cpp.

References llvm::MCInst::addOperand(), llvm::MCOperand::CreateReg(), and debug.

Referenced by translateOperand().

static bool translateOperand	(	MCInst &	mcInst,
		const OperandSpecifier &	operand,
		InternalInstruction &	insn,
		const MCDisassembler *	Dis
	)		`[static]`

translateOperand - Translates an operand stored in an internal instruction to LLVM's format and appends it to an MCInst.

Parameters:

mcInst	- The MCInst to append to.
operand	- The operand, as stored in the descriptor table.
insn	- The internal instruction.

Returns:: - false on success; true otherwise.

Definition at line 708 of file X86Disassembler.cpp.

Referenced by translateInstruction().

static void translateRegister	(	MCInst &	mcInst,
		Reg	reg
	)		`[static]`

translateRegister - Translates an internal register to the appropriate LLVM register, and appends it as an operand to an MCInst.

Parameters:

mcInst	- The MCInst to append to.
reg	- The Reg to append.

Definition at line 174 of file X86Disassembler.cpp.

References llvm::MCInst::addOperand(), ALL_REGS, and llvm::MCOperand::CreateReg().

Referenced by translateOperand().

static bool translateRM	(	MCInst &	mcInst,
		const OperandSpecifier &	operand,
		InternalInstruction &	insn,
		const MCDisassembler *	Dis
	)		`[static]`

translateRM - Translates an operand stored in the R/M (and possibly SIB) byte of an instruction to LLVM form, and appends it to an MCInst.

Parameters:

mcInst	- The MCInst to append to.
operand	- The operand, as stored in the descriptor table.
insn	- The instruction to extract Mod, R/M, and SIB fields from.

Returns:: - 0 on success; nonzero otherwise

Definition at line 625 of file X86Disassembler.cpp.

References debug, translateRMMemory(), translateRMRegister(), and llvm::X86Disassembler::OperandSpecifier::type.

Referenced by translateOperand().

static bool translateRMMemory	(	MCInst &	mcInst,
		InternalInstruction &	insn,
		const MCDisassembler *	Dis
	)		`[static]`

translateRMMemory - Translates a memory operand stored in the Mod and R/M fields of an internal instruction (and possibly its SIB byte) to a memory operand in LLVM's format, and appends it to an MCInst.

Parameters:

mcInst	- The MCInst to append to.
insn	- The instruction to extract Mod, R/M, and SIB fields from.

Returns:: - 0 on success; nonzero otherwise

Definition at line 442 of file X86Disassembler.cpp.

Referenced by translateRM().

static bool translateRMRegister	(	MCInst &	mcInst,
		InternalInstruction &	insn
	)		`[static]`

translateRMRegister - Translates a register stored in the R/M field of the ModR/M byte to its LLVM equivalent and appends it to an MCInst.

Parameters:

mcInst	- The MCInst to append to.
insn	- The internal instruction to extract the R/M field from.

Returns:: - 0 on success; -1 otherwise

Definition at line 404 of file X86Disassembler.cpp.

References ALL_EA_BASES, ALL_REGS, debug, llvm::X86Disassembler::EA_BASE_NONE, and llvm::X86Disassembler::InternalInstruction::eaBase.

Referenced by translateRM().

static bool translateSrcIndex	(	MCInst &	mcInst,
		InternalInstruction &	insn
	)		`[static]`

translateSrcIndex - Appends a source index operand to an MCInst.

Parameters:

mcInst	- The MCInst to append to.
insn	- The internal instruction.

Definition at line 240 of file X86Disassembler.cpp.

References llvm::MCInst::addOperand(), llvm::MCOperand::CreateReg(), llvm::N86::ESI, llvm::X86Disassembler::InternalInstruction::mode, llvm::X86Disassembler::MODE_16BIT, llvm::X86Disassembler::MODE_32BIT, llvm::X86Disassembler::MODE_64BIT, llvm::X86Disassembler::InternalInstruction::prefixPresent, llvm::X86Disassembler::InternalInstruction::segmentOverride, and segmentRegnums.

Referenced by translateOperand().

static void tryAddingPcLoadReferenceComment	(	uint64_t	Address,
		uint64_t	Value,
		const void *	Decoder
	)		`[static]`

tryAddingPcLoadReferenceComment - trys to add a comment as to what is being referenced by a load instruction with the base register that is the rip. These can often be addresses in a literal pool. The Address of the instruction and its immediate Value are used to determine the address being referenced in the literal pool entry. The SymbolLookUp call back will return a pointer to a literal 'C' string if the referenced address is an address into a section with 'C' string literals.

Definition at line 220 of file X86Disassembler.cpp.

References llvm::MCDisassembler::tryAddingPcLoadReferenceComment().

Referenced by translateRMMemory().

static bool tryAddingSymbolicOperand	(	int64_t	Value,
		bool	isBranch,
		uint64_t	Address,
		uint64_t	Offset,
		uint64_t	Width,
		MCInst &	MI,
		const MCDisassembler *	Dis
	)		`[static]`

tryAddingSymbolicOperand - trys to add a symbolic operand in place of the immediate Value in the MCInst.

Parameters:

Value	- The immediate Value, has had any PC adjustment made by the caller.
isBranch	- If the instruction is a branch instruction
Address	- The starting address of the instruction
Offset	- The byte offset to this immediate in the instruction
Width	- The byte width of this immediate in the instruction

If the getOpInfo() function was set when setupForSymbolicDisassembly() was called then that function is called to get any symbolic information for the immediate in the instruction using the Address, Offset and Width. If that returns non-zero then the symbolic information it returns is used to create an MCExpr and that is added as an operand to the MCInst. If getOpInfo() returns zero and isBranch is true then a symbol look up for immediate Value is done and if a symbol is found an MCExpr is created with that, else an MCExpr with the immediate Value is created. This function returns true if it adds an operand to the MCInst and false otherwise.

Definition at line 205 of file X86Disassembler.cpp.

References llvm::MCDisassembler::tryAddingSymbolicOperand().

Referenced by translateImmediate(), and translateRMMemory().

Variable Documentation

const uint8_t segmentRegnums[SEG_OVERRIDE_max] [static]

Initial value:

 {
  0,        
  X86::CS,
  X86::SS,
  X86::DS,
  X86::ES,
  X86::FS,
  X86::GS
}

Definition at line 226 of file X86Disassembler.cpp.

Referenced by translateImmediate(), translateRMMemory(), and translateSrcIndex().

Namespaces

Defines

Enumerations

Functions

Variables

Define Documentation

Function Documentation

Variable Documentation