LLVM 19.0.0git
MCExternalSymbolizer.h
Go to the documentation of this file.
1//===-- llvm/MC/MCExternalSymbolizer.h - ------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file contains the declaration of the MCExternalSymbolizer class, which
10// enables library users to provide callbacks (through the C API) to do the
11// symbolization externally.
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_MC_MCDISASSEMBLER_MCEXTERNALSYMBOLIZER_H
16#define LLVM_MC_MCDISASSEMBLER_MCEXTERNALSYMBOLIZER_H
17
20#include <memory>
21
22namespace llvm {
23
24/// Symbolize using user-provided, C API, callbacks.
25///
26/// See llvm-c/Disassembler.h.
28protected:
29 /// \name Hooks for symbolic disassembly via the public 'C' interface.
30 /// @{
31 /// The function to get the symbolic information for operands.
33 /// The function to lookup a symbol name.
35 /// The pointer to the block of symbolic information for above call back.
36 void *DisInfo;
37 /// @}
38
39public:
41 std::unique_ptr<MCRelocationInfo> RelInfo,
42 LLVMOpInfoCallback getOpInfo,
43 LLVMSymbolLookupCallback symbolLookUp, void *disInfo)
44 : MCSymbolizer(Ctx, std::move(RelInfo)), GetOpInfo(getOpInfo),
45 SymbolLookUp(symbolLookUp), DisInfo(disInfo) {}
46
47 bool tryAddingSymbolicOperand(MCInst &MI, raw_ostream &CommentStream,
48 int64_t Value, uint64_t Address, bool IsBranch,
49 uint64_t Offset, uint64_t OpSize,
50 uint64_t InstSize) override;
52 int64_t Value,
53 uint64_t Address) override;
54};
55
56}
57
58#endif
IRTranslator LLVM IR MI
Context object for machine code objects.
Definition: MCContext.h:83
Symbolize using user-provided, C API, callbacks.
void * DisInfo
The pointer to the block of symbolic information for above call back.
MCExternalSymbolizer(MCContext &Ctx, std::unique_ptr< MCRelocationInfo > RelInfo, LLVMOpInfoCallback getOpInfo, LLVMSymbolLookupCallback symbolLookUp, void *disInfo)
LLVMSymbolLookupCallback SymbolLookUp
The function to lookup a symbol name.
void tryAddingPcLoadReferenceComment(raw_ostream &CommentStream, int64_t Value, uint64_t Address) override
Try to add a comment on the PC-relative load.
bool tryAddingSymbolicOperand(MCInst &MI, raw_ostream &CommentStream, int64_t Value, uint64_t Address, bool IsBranch, uint64_t Offset, uint64_t OpSize, uint64_t InstSize) override
Try to add a symbolic operand instead of Value to the MCInst.
Instances of this class represent a single low-level machine instruction.
Definition: MCInst.h:184
Symbolize and annotate disassembled instructions.
Definition: MCSymbolizer.h:39
std::unique_ptr< MCRelocationInfo > RelInfo
Definition: MCSymbolizer.h:42
MCContext & Ctx
Definition: MCSymbolizer.h:41
LLVM Value Representation.
Definition: Value.h:74
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
const char *(* LLVMSymbolLookupCallback)(void *DisInfo, uint64_t ReferenceValue, uint64_t *ReferenceType, uint64_t ReferencePC, const char **ReferenceName)
The type for the symbol lookup function.
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.
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ Offset
Definition: DWP.cpp:456
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1849
Implement std::hash so that hash_code can be used in STL containers.
Definition: BitVector.h:858