LLVM: lib/MC/MCDisassembler/Disassembler.cpp Source File

LLVM 22.0.0git
Disassembler.cpp
Go to the documentation of this file.
1//===-- lib/MC/Disassembler.cpp - Disassembler Public C Interface ---------===//
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#include "Disassembler.h"
10#include "llvm-c/Disassembler.h"
11#include "llvm/ADT/ArrayRef.h"
12#include "llvm/ADT/SmallVector.h"
13#include "llvm/MC/MCAsmInfo.h"
14#include "llvm/MC/MCContext.h"
15#include "llvm/MC/MCDisassembler/MCDisassembler.h"
16#include "llvm/MC/MCDisassembler/MCRelocationInfo.h"
17#include "llvm/MC/MCDisassembler/MCSymbolizer.h"
18#include "llvm/MC/MCInst.h"
19#include "llvm/MC/MCInstPrinter.h"
20#include "llvm/MC/MCInstrInfo.h"
21#include "llvm/MC/MCRegisterInfo.h"
22#include "llvm/MC/MCSchedule.h"
23#include "llvm/MC/MCSubtargetInfo.h"
24#include "llvm/MC/MCTargetOptions.h"
25#include "llvm/MC/TargetRegistry.h"
26#include "llvm/Support/ErrorHandling.h"
27#include "llvm/Support/FormattedStream.h"
28#include "llvm/Support/raw_ostream.h"
29#include "llvm/TargetParser/Triple.h"
30#include <cassert>
31#include <cstring>
32
33using namespace llvm;
34
35// LLVMCreateDisasm() creates a disassembler for the TripleName. Symbolic
36// disassembly is supported by passing a block of information in the DisInfo
37// parameter and specifying the TagType and callback functions as described in
38// the header llvm-c/Disassembler.h . The pointer to the block and the
39// functions can all be passed as NULL. If successful, this returns a
40// disassembler context. If not, it returns NULL.
41//
42LLVMDisasmContextRef
43 LLVMCreateDisasmCPUFeatures(const char *TT, const char *CPU,
44 const char *Features, void *DisInfo, int TagType,
45 LLVMOpInfoCallback GetOpInfo,
46 LLVMSymbolLookupCallback SymbolLookUp) {
47 Triple TheTriple(TT);
48
49 // Get the target.
50 std::string Error;
51 const Target *TheTarget = TargetRegistry::lookupTarget(TheTriple, Error);
52 if (!TheTarget)
53 return nullptr;
54
55 std::unique_ptr<const MCRegisterInfo> MRI(
56 TheTarget->createMCRegInfo(TheTriple));
57 if (!MRI)
58 return nullptr;
59
60 MCTargetOptions MCOptions;
61 // Get the assembler info needed to setup the MCContext.
62 std::unique_ptr<const MCAsmInfo> MAI(
63 TheTarget->createMCAsmInfo(*MRI, TheTriple, MCOptions));
64 if (!MAI)
65 return nullptr;
66
67 std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
68 if (!MII)
69 return nullptr;
70
71 std::unique_ptr<const MCSubtargetInfo> STI(
72 TheTarget->createMCSubtargetInfo(TheTriple, CPU, Features));
73 if (!STI)
74 return nullptr;
75
76 // Set up the MCContext for creating symbols and MCExpr's.
77 std::unique_ptr<MCContext> Ctx(
78 new MCContext(TheTriple, MAI.get(), MRI.get(), STI.get()));
79 if (!Ctx)
80 return nullptr;
81
82 // Set up disassembler.
83 std::unique_ptr<MCDisassembler> DisAsm(
84 TheTarget->createMCDisassembler(*STI, *Ctx));
85 if (!DisAsm)
86 return nullptr;
87
88 std::unique_ptr<MCRelocationInfo> RelInfo(
89 TheTarget->createMCRelocationInfo(TheTriple, *Ctx));
90 if (!RelInfo)
91 return nullptr;
92
93 std::unique_ptr<MCSymbolizer> Symbolizer(
94 TheTarget->createMCSymbolizer(TheTriple, GetOpInfo, SymbolLookUp, DisInfo,
95 Ctx.get(), std::move(RelInfo)));
96 DisAsm->setSymbolizer(std::move(Symbolizer));
97
98 // Set up the instruction printer.
99 int AsmPrinterVariant = MAI->getAssemblerDialect();
100 std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
101 Triple(TT), AsmPrinterVariant, *MAI, *MII, *MRI));
102 if (!IP)
103 return nullptr;
104
106 TT, DisInfo, TagType, GetOpInfo, SymbolLookUp, TheTarget, std::move(MAI),
107 std::move(MRI), std::move(STI), std::move(MII), std::move(Ctx),
108 std::move(DisAsm), std::move(IP));
109 if (!DC)
110 return nullptr;
111
112 DC->setCPU(CPU);
113 return DC;
114}
115
116LLVMDisasmContextRef
117 LLVMCreateDisasmCPU(const char *TT, const char *CPU, void *DisInfo, int TagType,
118 LLVMOpInfoCallback GetOpInfo,
119 LLVMSymbolLookupCallback SymbolLookUp) {
120 return LLVMCreateDisasmCPUFeatures(TT, CPU, "", DisInfo, TagType, GetOpInfo,
121 SymbolLookUp);
122}
123
124 LLVMDisasmContextRef LLVMCreateDisasm(const char *TT, void *DisInfo,
125 int TagType, LLVMOpInfoCallback GetOpInfo,
126 LLVMSymbolLookupCallback SymbolLookUp) {
127 return LLVMCreateDisasmCPUFeatures(TT, "", "", DisInfo, TagType, GetOpInfo,
128 SymbolLookUp);
129}
130
131//
132// LLVMDisasmDispose() disposes of the disassembler specified by the context.
133//
135 LLVMDisasmContext *DC = static_cast<LLVMDisasmContext *>(DCR);
136 delete DC;
137}
138
139/// Emits the comments that are stored in \p DC comment stream.
140/// Each comment in the comment stream must end with a newline.
142 formatted_raw_ostream &FormattedOS) {
143 // Flush the stream before taking its content.
144 StringRef Comments = DC->CommentsToEmit.str();
145 // Get the default information for printing a comment.
146 const MCAsmInfo *MAI = DC->getAsmInfo();
147 StringRef CommentBegin = MAI->getCommentString();
148 unsigned CommentColumn = MAI->getCommentColumn();
149 bool IsFirst = true;
150 while (!Comments.empty()) {
151 if (!IsFirst)
152 FormattedOS << '\n';
153 // Emit a line of comments.
154 FormattedOS.PadToColumn(CommentColumn);
155 size_t Position = Comments.find('\n');
156 FormattedOS << CommentBegin << ' ' << Comments.substr(0, Position);
157 // Move after the newline character.
158 Comments = Comments.substr(Position+1);
159 IsFirst = false;
160 }
161 FormattedOS.flush();
162
163 // Tell the comment stream that the vector changed underneath it.
164 DC->CommentsToEmit.clear();
165}
166
167/// Emits latency information in DC->CommentStream for \p Inst, based
168/// on the information available in \p DC.
169 static void emitLatency(LLVMDisasmContext *DC, const MCInst &Inst) {
170 const MCSubtargetInfo *STI = DC->getSubtargetInfo();
171 const MCInstrInfo *MCII = DC->getInstrInfo();
172 const MCSchedModel &SCModel = STI->getSchedModel();
173 int Latency = SCModel.computeInstrLatency(*STI, *MCII, Inst);
174
175 // Report only interesting latencies.
176 if (Latency < 2)
177 return;
178
179 DC->CommentStream << "Latency: " << Latency << '\n';
180}
181
182//
183// LLVMDisasmInstruction() disassembles a single instruction using the
184// disassembler context specified in the parameter DC. The bytes of the
185// instruction are specified in the parameter Bytes, and contains at least
186// BytesSize number of bytes. The instruction is at the address specified by
187// the PC parameter. If a valid instruction can be disassembled its string is
188// returned indirectly in OutString which whos size is specified in the
189// parameter OutStringSize. This function returns the number of bytes in the
190// instruction or zero if there was no valid instruction. If this function
191// returns zero the caller will have to pick how many bytes they want to step
192// over by printing a .byte, .long etc. to continue.
193//
195 uint64_t BytesSize, uint64_t PC, char *OutString,
196 size_t OutStringSize){
197 LLVMDisasmContext *DC = static_cast<LLVMDisasmContext *>(DCR);
198 // Wrap the pointer to the Bytes, BytesSize and PC in a MemoryObject.
199 ArrayRef<uint8_t> Data(Bytes, BytesSize);
200
202 MCInst Inst;
203 const MCDisassembler *DisAsm = DC->getDisAsm();
204 MCInstPrinter *IP = DC->getIP();
206 SmallVector<char, 64> InsnStr;
208 S = DisAsm->getInstruction(Inst, Size, Data, PC, Annotations);
209 switch (S) {
212 // FIXME: Do something different for soft failure modes?
213 return 0;
214
216 StringRef AnnotationsStr = Annotations.str();
217
218 SmallVector<char, 64> InsnStr;
219 raw_svector_ostream OS(InsnStr);
220 formatted_raw_ostream FormattedOS(OS);
221
223 FormattedOS.enable_colors(true);
224 IP->setUseColor(true);
225 }
226
227 IP->printInst(&Inst, PC, AnnotationsStr, *DC->getSubtargetInfo(),
228 FormattedOS);
229
231 emitLatency(DC, Inst);
232
233 emitComments(DC, FormattedOS);
234
235 assert(OutStringSize != 0 && "Output buffer cannot be zero size");
236 size_t OutputSize = std::min(OutStringSize-1, InsnStr.size());
237 std::memcpy(OutString, InsnStr.data(), OutputSize);
238 OutString[OutputSize] = '0円'; // Terminate string.
239
240 return Size;
241 }
242 }
243 llvm_unreachable("Invalid DecodeStatus!");
244}
245
246//
247// LLVMSetDisasmOptions() sets the disassembler's options. It returns 1 if it
248// can set all the Options and 0 otherwise.
249//
252 LLVMDisasmContext *DC = static_cast<LLVMDisasmContext *>(DCR);
253 MCInstPrinter *IP = DC->getIP();
254 IP->setUseMarkup(true);
257 }
259 LLVMDisasmContext *DC = static_cast<LLVMDisasmContext *>(DCR);
260 MCInstPrinter *IP = DC->getIP();
261 IP->setPrintImmHex(true);
264 }
266 LLVMDisasmContext *DC = static_cast<LLVMDisasmContext *>(DCR);
267 // Try to set up the new instruction printer.
268 const MCAsmInfo *MAI = DC->getAsmInfo();
269 const MCInstrInfo *MII = DC->getInstrInfo();
270 const MCRegisterInfo *MRI = DC->getRegisterInfo();
271 int AsmPrinterVariant = MAI->getAssemblerDialect();
272 AsmPrinterVariant = AsmPrinterVariant == 0 ? 1 : 0;
274 Triple(DC->getTripleName()), AsmPrinterVariant, *MAI, *MII, *MRI);
275 if (IP) {
276 DC->setIP(IP);
279 }
280 }
282 LLVMDisasmContext *DC = static_cast<LLVMDisasmContext *>(DCR);
283 MCInstPrinter *IP = DC->getIP();
287 }
289 LLVMDisasmContext *DC = static_cast<LLVMDisasmContext *>(DCR);
292 }
294 LLVMDisasmContext *DC = static_cast<LLVMDisasmContext *>(DCR);
297 }
298 return (Options == 0);
299}
unsigned const MachineRegisterInfo * MRI
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
static void emitComments(LLVMDisasmContext *DC, formatted_raw_ostream &FormattedOS)
Emits the comments that are stored in DC comment stream.
static void emitLatency(LLVMDisasmContext *DC, const MCInst &Inst)
Emits latency information in DC->CommentStream for Inst, based on the information available in DC.
static LVOptions Options
Definition LVOptions.cpp:25
This file defines the SmallVector class.
Annotations lets you mark points and ranges inside source code, for tests:
Definition Annotations.h:53
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:41
Lightweight error class with error context and mandatory checking.
Definition Error.h:159
const MCDisassembler * getDisAsm() const
Definition Disassembler.h:109
void setCPU(const char *CPU)
Definition Disassembler.h:119
void addOptions(uint64_t Options)
Definition Disassembler.h:117
raw_svector_ostream CommentStream
Definition Disassembler.h:83
void setIP(MCInstPrinter *NewIP)
Definition Disassembler.h:115
const MCSubtargetInfo * getSubtargetInfo() const
Definition Disassembler.h:113
const MCAsmInfo * getAsmInfo() const
Definition Disassembler.h:110
uint64_t getOptions() const
Definition Disassembler.h:116
const MCRegisterInfo * getRegisterInfo() const
Definition Disassembler.h:112
SmallString< 128 > CommentsToEmit
Definition Disassembler.h:82
MCInstPrinter * getIP()
Definition Disassembler.h:114
StringRef getTripleName() const
Definition Disassembler.h:101
const MCInstrInfo * getInstrInfo() const
Definition Disassembler.h:111
const Target * getTarget() const
Definition Disassembler.h:108
This class is intended to be used as a base class for asm properties and features specific to the tar...
Definition MCAsmInfo.h:64
unsigned getAssemblerDialect() const
Definition MCAsmInfo.h:560
StringRef getCommentString() const
Definition MCAsmInfo.h:538
unsigned getCommentColumn() const
Definition MCAsmInfo.h:535
Context object for machine code objects.
Definition MCContext.h:83
Superclass for all disassemblers.
DecodeStatus
Ternary decode status.
virtual DecodeStatus getInstruction(MCInst &Instr, uint64_t &Size, ArrayRef< uint8_t > Bytes, uint64_t Address, raw_ostream &CStream) const =0
Returns the disassembly of a single instruction.
This is an instance of a target assembly language printer that converts an MCInst to valid target ass...
Definition MCInstPrinter.h:46
void setCommentStream(raw_ostream &OS)
Specify a stream to emit comments to.
void setUseColor(bool Value)
void setPrintImmHex(bool Value)
void setUseMarkup(bool Value)
virtual void printInst(const MCInst *MI, uint64_t Address, StringRef Annot, const MCSubtargetInfo &STI, raw_ostream &OS)=0
Print the specified MCInst to the specified raw_ostream.
Instances of this class represent a single low-level machine instruction.
Definition MCInst.h:188
Interface to description of machine instruction set.
Definition MCInstrInfo.h:27
MCRegisterInfo base class - We assume that the target defines a static array of MCRegisterDesc object...
Generic base class for all target subtargets.
const MCSchedModel & getSchedModel() const
Get the machine model for this subtarget's CPU.
StringRef str() const
Explicit conversion to StringRef.
Definition SmallString.h:254
pointer data()
Return a pointer to the vector's buffer, even if empty().
Definition SmallVector.h:290
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition SmallVector.h:1203
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
constexpr StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
Definition StringRef.h:573
constexpr bool empty() const
empty - Check if the string is empty.
Definition StringRef.h:143
size_t find(char C, size_t From=0) const
Search for the first character C in the string.
Definition StringRef.h:293
Target - Wrapper for Target specific information.
MCSubtargetInfo * createMCSubtargetInfo(StringRef TheTriple, StringRef CPU, StringRef Features) const
MCSymbolizer * createMCSymbolizer(StringRef TT, LLVMOpInfoCallback GetOpInfo, LLVMSymbolLookupCallback SymbolLookUp, void *DisInfo, MCContext *Ctx, std::unique_ptr< MCRelocationInfo > &&RelInfo) const
MCRelocationInfo * createMCRelocationInfo(StringRef TT, MCContext &Ctx) const
MCRegisterInfo * createMCRegInfo(StringRef TT) const
MCDisassembler * createMCDisassembler(const MCSubtargetInfo &STI, MCContext &Ctx) const
MCAsmInfo * createMCAsmInfo(const MCRegisterInfo &MRI, StringRef TheTriple, const MCTargetOptions &Options) const
MCInstPrinter * createMCInstPrinter(const Triple &T, unsigned SyntaxVariant, const MCAsmInfo &MAI, const MCInstrInfo &MII, const MCRegisterInfo &MRI) const
MCInstrInfo * createMCInstrInfo() const
createMCInstrInfo - Create a MCInstrInfo implementation.
Triple - Helper class for working with autoconf configuration names.
Definition Triple.h:47
formatted_raw_ostream - A raw_ostream that wraps another one and keeps track of line and column posit...
formatted_raw_ostream & PadToColumn(unsigned NewCol)
PadToColumn - Align the output to some column number.
void flush()
Definition raw_ostream.h:199
virtual void enable_colors(bool enable)
Definition raw_ostream.h:356
A raw_ostream that writes to an SmallVector or SmallString.
Definition raw_ostream.h:692
const char *(* LLVMSymbolLookupCallback)(void *DisInfo, uint64_t ReferenceValue, uint64_t *ReferenceType, uint64_t ReferencePC, const char **ReferenceName)
The type for the symbol lookup function.
#define LLVMDisassembler_Option_PrintImmHex
Definition Disassembler.h:76
#define LLVMDisassembler_Option_UseMarkup
Definition Disassembler.h:74
void LLVMDisasmDispose(LLVMDisasmContextRef DCR)
Dispose of a disassembler context.
int LLVMSetDisasmOptions(LLVMDisasmContextRef DCR, uint64_t Options)
Set the disassembler's options.
#define LLVMDisassembler_Option_PrintLatency
Definition Disassembler.h:82
LLVMDisasmContextRef LLVMCreateDisasmCPUFeatures(const char *TT, 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.
#define LLVMDisassembler_Option_SetInstrComments
Definition Disassembler.h:80
LLVMDisasmContextRef LLVMCreateDisasm(const char *TT, void *DisInfo, int TagType, LLVMOpInfoCallback GetOpInfo, LLVMSymbolLookupCallback SymbolLookUp)
Create a disassembler for the TripleName.
#define LLVMDisassembler_Option_Color
Definition Disassembler.h:84
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.
size_t LLVMDisasmInstruction(LLVMDisasmContextRef DCR, 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.
LLVMDisasmContextRef LLVMCreateDisasmCPU(const char *TT, const char *CPU, void *DisInfo, int TagType, LLVMOpInfoCallback GetOpInfo, LLVMSymbolLookupCallback SymbolLookUp)
Create a disassembler for the TripleName and a specific CPU.
#define LLVMDisassembler_Option_AsmPrinterVariant
Definition Disassembler.h:78
void * LLVMDisasmContextRef
An opaque reference to a disassembler context.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
This is an optimization pass for GlobalISel generic memory operations.
Definition AddressRanges.h:18
FunctionAddr VTableAddr uintptr_t uintptr_t Data
Definition InstrProf.h:189
Machine model for scheduling, bundling, and heuristics.
Definition MCSchedule.h:258
static LLVM_ABI int computeInstrLatency(const MCSubtargetInfo &STI, const MCSchedClassDesc &SCDesc)
Returns the latency value for the scheduling class.
Definition MCSchedule.cpp:43
static const Target * lookupTarget(StringRef TripleStr, std::string &Error)
lookupTarget - Lookup a target based on a target triple.
Generated on for LLVM by doxygen 1.14.0

AltStyle によって変換されたページ (->オリジナル) /