class MCSymbolizer

Declaration

class MCSymbolizer { /* full declaration omitted */ };

Description

Symbolize and annotate disassembled instructions. For now this mimics the old symbolization logic (from both ARM and x86), that relied on user-provided (C API) callbacks to do the actual symbol lookup in the object file. This was moved to MCExternalSymbolizer. A better API would not rely on actually calling the two methods here from inside each disassembler, but would use the instr info to determine what operands are actually symbolizable, and in what way. I don't think this information exists right now.

Declared at: llvm/include/llvm/MC/MCDisassembler/MCSymbolizer.h:39

Member Variables

protected llvm::MCContext& Ctx
protected std::unique_ptr<MCRelocationInfo> RelInfo

Method Overview

Methods

MCSymbolizer(
    llvm::MCContext& Ctx,
    std::unique_ptr<MCRelocationInfo> RelInfo)

Description

Construct an MCSymbolizer, taking ownership of \p RelInfo.

Declared at: llvm/include/llvm/MC/MCDisassembler/MCSymbolizer.h:46

Parameters

llvm::MCContext& Ctx
std::unique_ptr<MCRelocationInfo> RelInfo

MCSymbolizer(const llvm::MCSymbolizer&)

Declared at: llvm/include/llvm/MC/MCDisassembler/MCSymbolizer.h:50

Parameters

const llvm::MCSymbolizer& 

virtual ArrayRef<uint64_t>
getReferencedAddresses() const

Description

Get the MCSymbolizer's list of addresses that were referenced by symbolizable operands but not resolved to a symbol. The caller (some code that is disassembling a section or other chunk of code) would typically create a synthetic label at each address and add them to its list of symbols in the section, before creating a new MCSymbolizer with the enhanced symbol list and retrying disassembling the section. The returned array is unordered and may have duplicates. The returned ArrayRef stops being valid on any call to or destruction of the MCSymbolizer object.

Declared at: llvm/include/llvm/MC/MCDisassembler/MCSymbolizer.h:90

virtual void tryAddingPcLoadReferenceComment(
    llvm::raw_ostream& cStream,
    int64_t Value,
    uint64_t Address)

Description

Try to add a comment on the PC-relative load. For instance, in Mach-O, this is used to add annotations to instructions that use C string literals, as found in __cstring.

Declared at: llvm/include/llvm/MC/MCDisassembler/MCSymbolizer.h:77

Parameters

llvm::raw_ostream& cStream
int64_t Value
uint64_t Address

virtual bool tryAddingSymbolicOperand(
    llvm::MCInst& Inst,
    llvm::raw_ostream& cStream,
    int64_t Value,
    uint64_t Address,
    bool IsBranch,
    uint64_t Offset,
    uint64_t OpSize,
    uint64_t InstSize)

Description

Try to add a symbolic operand instead of \p Value to the MCInst. Instead of having a difficult to read immediate, a symbolic operand would represent this immediate in a more understandable way, for instance as a symbol or an offset from a symbol. Relocations can also be used to enrich the symbolic expression.

Declared at: llvm/include/llvm/MC/MCDisassembler/MCSymbolizer.h:69

Parameters

llvm::MCInst& Inst
- The MCInst where to insert the symbolic operand.
llvm::raw_ostream& cStream
- Stream to print comments and annotations on.
int64_t Value
- Operand value, pc-adjusted by the caller if necessary.
uint64_t Address
- Load address of the instruction.
bool IsBranch
- Is the instruction a branch?
uint64_t Offset
- Byte offset of the operand inside the inst.
uint64_t OpSize
- Size of the operand in bytes.
uint64_t InstSize
- Size of the instruction in bytes.

Returns

Whether a symbolic operand was added.

virtual ~MCSymbolizer()

Declared at: llvm/include/llvm/MC/MCDisassembler/MCSymbolizer.h:52