LLVM: Disassembler (original) (raw)

Classes
struct	LLVMOpInfoSymbol1
	The initial support in LLVM MC for the most general form of a relocatable expression is "AddSymbol - SubtractSymbol + Offset". More...

struct	LLVMOpInfo1

Macros
#define	LLVMDisassembler_Option_UseMarkup 1

#define	LLVMDisassembler_Option_PrintImmHex 2

#define	LLVMDisassembler_Option_AsmPrinterVariant 4

#define	LLVMDisassembler_Option_SetInstrComments 8

#define	LLVMDisassembler_Option_PrintLatency 16

#define	LLVMDisassembler_Option_Color 32

#define	LLVMDisassembler_VariantKind_None 0 /* all targets */
	The operand VariantKinds for symbolic disassembly.

#define	LLVMDisassembler_VariantKind_ARM_HI16 1 /* :upper16: */
	The ARM target VariantKinds.

#define	LLVMDisassembler_VariantKind_ARM_LO16 2 /* :lower16: */

#define	LLVMDisassembler_VariantKind_ARM64_PAGE 1 /* @page */
	The ARM64 target VariantKinds.

#define	LLVMDisassembler_VariantKind_ARM64_PAGEOFF 2 /* @pageoff */

#define	LLVMDisassembler_VariantKind_ARM64_GOTPAGE 3 /* @gotpage */

#define	LLVMDisassembler_VariantKind_ARM64_GOTPAGEOFF 4 /* @gotpageoff */

#define	LLVMDisassembler_VariantKind_ARM64_TLVP 5 /* @tvlppage */

#define	LLVMDisassembler_VariantKind_ARM64_TLVOFF 6 /* @tvlppageoff */

#define	LLVMDisassembler_ReferenceType_InOut_None 0
	The reference types on input and output.

#define	LLVMDisassembler_ReferenceType_In_Branch 1

#define	LLVMDisassembler_ReferenceType_In_PCrel_Load 2

#define	LLVMDisassembler_ReferenceType_In_ARM64_ADRP 0x100000001

#define	LLVMDisassembler_ReferenceType_In_ARM64_ADDXri 0x100000002

#define	LLVMDisassembler_ReferenceType_In_ARM64_LDRXui 0x100000003

#define	LLVMDisassembler_ReferenceType_In_ARM64_LDRXl 0x100000004

#define	LLVMDisassembler_ReferenceType_In_ARM64_ADR 0x100000005

#define	LLVMDisassembler_ReferenceType_Out_SymbolStub 1

#define	LLVMDisassembler_ReferenceType_Out_LitPool_SymAddr 2

#define	LLVMDisassembler_ReferenceType_Out_LitPool_CstrAddr 3

#define	LLVMDisassembler_ReferenceType_Out_Objc_CFString_Ref 4

#define	LLVMDisassembler_ReferenceType_Out_Objc_Message 5

#define	LLVMDisassembler_ReferenceType_Out_Objc_Message_Ref 6

#define	LLVMDisassembler_ReferenceType_Out_Objc_Selector_Ref 7

#define	LLVMDisassembler_ReferenceType_Out_Objc_Class_Ref 8

#define	LLVMDisassembler_ReferenceType_DeMangled_Name 9

Typedefs
typedef void *	LLVMDisasmContextRef
	An opaque reference to a disassembler context.

typedef int(*	LLVMOpInfoCallback) (void DisInfo, uint64_t PC, uint64_t Offset, uint64_t OpSize, uint64_t InstSize, int TagType, void TagBuf)
	The type for the operand information call back function.

typedef const char (	LLVMSymbolLookupCallback) (void DisInfo, uint64_t ReferenceValue, uint64_t ReferenceType, uint64_t ReferencePC, const char **ReferenceName)
	The type for the symbol lookup function.

Functions
LLVM_C_EXTERN_C_BEGIN LLVMDisasmContextRef	LLVMCreateDisasm (const char TripleName, void DisInfo, int TagType, LLVMOpInfoCallback GetOpInfo, LLVMSymbolLookupCallback SymbolLookUp)
	Create a disassembler for the TripleName.

LLVMDisasmContextRef	LLVMCreateDisasmCPU (const char Triple, const char CPU, void *DisInfo, int TagType, LLVMOpInfoCallback GetOpInfo, LLVMSymbolLookupCallback SymbolLookUp)
	Create a disassembler for the TripleName and a specific CPU.

LLVMDisasmContextRef	LLVMCreateDisasmCPUFeatures (const char Triple, const char CPU, const char Features, void DisInfo, int TagType, LLVMOpInfoCallback GetOpInfo, LLVMSymbolLookupCallback SymbolLookUp)
	Create a disassembler for the TripleName, a specific CPU and specific feature string.

int	LLVMSetDisasmOptions (LLVMDisasmContextRef DC, uint64_t Options)
	Set the disassembler's options.

void	LLVMDisasmDispose (LLVMDisasmContextRef DC)
	Dispose of a disassembler context.

size_t	LLVMDisasmInstruction (LLVMDisasmContextRef DC, uint8_t Bytes, uint64_t BytesSize, uint64_t PC, char OutString, size_t OutStringSize)
	Disassemble a single instruction using the disassembler context specified in the parameter DC.

◆ LLVMDisassembler_Option_AsmPrinterVariant

#define LLVMDisassembler_Option_AsmPrinterVariant 4

◆ LLVMDisassembler_Option_Color

#define LLVMDisassembler_Option_Color 32

◆ LLVMDisassembler_Option_PrintImmHex

#define LLVMDisassembler_Option_PrintImmHex 2

◆ LLVMDisassembler_Option_PrintLatency

#define LLVMDisassembler_Option_PrintLatency 16

◆ LLVMDisassembler_Option_SetInstrComments

#define LLVMDisassembler_Option_SetInstrComments 8

◆ LLVMDisassembler_Option_UseMarkup

#define LLVMDisassembler_Option_UseMarkup 1

◆ LLVMDisassembler_ReferenceType_DeMangled_Name

#define LLVMDisassembler_ReferenceType_DeMangled_Name 9

◆ LLVMDisassembler_ReferenceType_In_ARM64_ADDXri

#define LLVMDisassembler_ReferenceType_In_ARM64_ADDXri 0x100000002

◆ LLVMDisassembler_ReferenceType_In_ARM64_ADR

#define LLVMDisassembler_ReferenceType_In_ARM64_ADR 0x100000005

◆ LLVMDisassembler_ReferenceType_In_ARM64_ADRP

#define LLVMDisassembler_ReferenceType_In_ARM64_ADRP 0x100000001

◆ LLVMDisassembler_ReferenceType_In_ARM64_LDRXl

#define LLVMDisassembler_ReferenceType_In_ARM64_LDRXl 0x100000004

◆ LLVMDisassembler_ReferenceType_In_ARM64_LDRXui

#define LLVMDisassembler_ReferenceType_In_ARM64_LDRXui 0x100000003

◆ LLVMDisassembler_ReferenceType_In_Branch

#define LLVMDisassembler_ReferenceType_In_Branch 1

◆ LLVMDisassembler_ReferenceType_In_PCrel_Load

#define LLVMDisassembler_ReferenceType_In_PCrel_Load 2

◆ LLVMDisassembler_ReferenceType_InOut_None

#define LLVMDisassembler_ReferenceType_InOut_None 0

◆ LLVMDisassembler_ReferenceType_Out_LitPool_CstrAddr

#define LLVMDisassembler_ReferenceType_Out_LitPool_CstrAddr 3

◆ LLVMDisassembler_ReferenceType_Out_LitPool_SymAddr

#define LLVMDisassembler_ReferenceType_Out_LitPool_SymAddr 2

◆ LLVMDisassembler_ReferenceType_Out_Objc_CFString_Ref

#define LLVMDisassembler_ReferenceType_Out_Objc_CFString_Ref 4

◆ LLVMDisassembler_ReferenceType_Out_Objc_Class_Ref

#define LLVMDisassembler_ReferenceType_Out_Objc_Class_Ref 8

◆ LLVMDisassembler_ReferenceType_Out_Objc_Message

#define LLVMDisassembler_ReferenceType_Out_Objc_Message 5

◆ LLVMDisassembler_ReferenceType_Out_Objc_Message_Ref

#define LLVMDisassembler_ReferenceType_Out_Objc_Message_Ref 6

◆ LLVMDisassembler_ReferenceType_Out_Objc_Selector_Ref

#define LLVMDisassembler_ReferenceType_Out_Objc_Selector_Ref 7

◆ LLVMDisassembler_ReferenceType_Out_SymbolStub

#define LLVMDisassembler_ReferenceType_Out_SymbolStub 1

◆ LLVMDisassembler_VariantKind_ARM64_GOTPAGE

#define LLVMDisassembler_VariantKind_ARM64_GOTPAGE 3 /* @gotpage */

◆ LLVMDisassembler_VariantKind_ARM64_GOTPAGEOFF

#define LLVMDisassembler_VariantKind_ARM64_GOTPAGEOFF 4 /* @gotpageoff */

◆ LLVMDisassembler_VariantKind_ARM64_PAGE

#define LLVMDisassembler_VariantKind_ARM64_PAGE 1 /* @page */

◆ LLVMDisassembler_VariantKind_ARM64_PAGEOFF

#define LLVMDisassembler_VariantKind_ARM64_PAGEOFF 2 /* @pageoff */

◆ LLVMDisassembler_VariantKind_ARM64_TLVOFF

#define LLVMDisassembler_VariantKind_ARM64_TLVOFF 6 /* @tvlppageoff */

◆ LLVMDisassembler_VariantKind_ARM64_TLVP

#define LLVMDisassembler_VariantKind_ARM64_TLVP 5 /* @tvlppage */

◆ LLVMDisassembler_VariantKind_ARM_HI16

#define LLVMDisassembler_VariantKind_ARM_HI16 1 /* :upper16: */

◆ LLVMDisassembler_VariantKind_ARM_LO16

#define LLVMDisassembler_VariantKind_ARM_LO16 2 /* :lower16: */

◆ LLVMDisassembler_VariantKind_None

#define LLVMDisassembler_VariantKind_None 0 /* all targets */

◆ LLVMDisasmContextRef

◆ LLVMOpInfoCallback

The type for the operand information call back function.

This is called to get the symbolic information for an operand of an instruction. Typically this is from the relocation information, symbol table, etc. That block of information is saved when the disassembler context is created and passed to the call back in the DisInfo parameter. The instruction containing operand is at the PC parameter. For some instruction sets, there can be more than one operand with symbolic information. To determine the symbolic operand information for each operand, the bytes for the specific operand in the instruction are specified by the Offset parameter and its byte widith is the OpSize parameter. For instructions sets with fixed widths and one symbolic operand per instruction, the Offset parameter will be zero and InstSize parameter will be the instruction width. The information is returned in TagBuf and is Triple specific with its specific information defined by the value of TagType for that Triple. If symbolic information is returned the function * returns 1, otherwise it returns 0.

Definition at line 48 of file DisassemblerTypes.h.

◆ LLVMSymbolLookupCallback

The type for the symbol lookup function.

This may be called by the disassembler for things like adding a comment for a PC plus a constant offset load instruction to use a symbol name instead of a load address value. It is passed the block information is saved when the disassembler context is created and the ReferenceValue to look up as a symbol. If no symbol is found for the ReferenceValue NULL is returned. The ReferenceType of the instruction is passed indirectly as is the PC of the instruction in ReferencePC. If the output reference can be determined its type is returned indirectly in ReferenceType along with ReferenceName if any, or that is set to NULL.

Definition at line 118 of file DisassemblerTypes.h.

◆ LLVMCreateDisasm()

Create a disassembler for the TripleName.

Symbolic disassembly is supported by passing a block of information in the DisInfo parameter and specifying the TagType and callback functions as described above. These can all be passed as NULL. If successful, this returns a disassembler context. If not, it returns NULL. This function is equivalent to calling LLVMCreateDisasmCPUFeatures() with an empty CPU name and feature set.

Definition at line 121 of file Disassembler.cpp.

References LLVMCreateDisasmCPUFeatures().

◆ LLVMCreateDisasmCPU()

Create a disassembler for the TripleName and a specific CPU.

Symbolic disassembly is supported by passing a block of information in the DisInfo parameter and specifying the TagType and callback functions as described above. These can all be passed * as NULL. If successful, this returns a disassembler context. If not, it returns NULL. This function is equivalent to calling LLVMCreateDisasmCPUFeatures() with an empty feature set.

Definition at line 114 of file Disassembler.cpp.

References LLVMCreateDisasmCPUFeatures().

◆ LLVMCreateDisasmCPUFeatures()

Create a disassembler for the TripleName, a specific CPU and specific feature string.

Symbolic disassembly is supported by passing a block of information in the DisInfo parameter and specifying the TagType and callback functions as described above. These can all be passed * as NULL. If successful, this returns a disassembler context. If not, it returns NULL.

Definition at line 44 of file Disassembler.cpp.

References llvm::Target::createMCAsmInfo(), llvm::Target::createMCDisassembler(), llvm::Target::createMCInstPrinter(), llvm::Target::createMCInstrInfo(), llvm::Target::createMCRegInfo(), llvm::Target::createMCRelocationInfo(), llvm::Target::createMCSubtargetInfo(), llvm::Target::createMCSymbolizer(), llvm::TargetRegistry::lookupTarget(), MRI, and llvm::LLVMDisasmContext::setCPU().

Referenced by LLVMCreateDisasm(), and LLVMCreateDisasmCPU().

◆ LLVMDisasmDispose()

◆ LLVMDisasmInstruction()

Disassemble a single instruction using the disassembler context specified in the parameter DC.

The bytes of the instruction are specified in the parameter Bytes, and contains at least BytesSize number of bytes. The instruction is at the address specified by the PC parameter. If a valid instruction can be disassembled, its string is returned indirectly in OutString whose size is specified in the parameter OutStringSize. This function returns the number of bytes in the instruction or zero if there was no valid instruction.

Definition at line 191 of file Disassembler.cpp.

References assert(), llvm::SmallVectorTemplateCommon< T, typename >::data(), emitComments(), emitLatency(), llvm::raw_ostream::enable_colors(), llvm::MCDisassembler::Fail, llvm::LLVMDisasmContext::getDisAsm(), llvm::MCDisassembler::getInstruction(), llvm::LLVMDisasmContext::getIP(), llvm::LLVMDisasmContext::getOptions(), llvm::LLVMDisasmContext::getSubtargetInfo(), llvm_unreachable, LLVMDisassembler_Option_Color, LLVMDisassembler_Option_PrintLatency, OS, llvm::MCInstPrinter::printInst(), llvm::MCInstPrinter::setUseColor(), llvm::SmallVectorBase< Size_T >::size(), Size, llvm::MCDisassembler::SoftFail, and llvm::MCDisassembler::Success.

◆ LLVMSetDisasmOptions()

Set the disassembler's options.

Returns 1 if it can set the Options and 0 otherwise.

Definition at line 247 of file Disassembler.cpp.