LLVM: include/llvm/MC/MCInstPrinter.h Source File

LLVM 22.0.0git
MCInstPrinter.h
Go to the documentation of this file.
1//===- MCInstPrinter.h - MCInst to target assembly syntax -------*- 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#ifndef LLVM_MC_MCINSTPRINTER_H
10#define LLVM_MC_MCINSTPRINTER_H
11
12#include "llvm/ADT/SmallVector.h"
13#include "llvm/Support/Compiler.h"
14#include "llvm/Support/Format.h"
15#include "llvm/Support/raw_ostream.h"
16#include <cstdint>
17
18namespace llvm {
19
20class MCAsmInfo;
21class MCInst;
22class MCInstrAnalysis;
23class MCInstrInfo;
24class MCOperand;
25class MCRegister;
26class MCRegisterInfo;
27class MCSubtargetInfo;
28class StringRef;
29
30/// Convert `Bytes' to a hex string and output to `OS'
31LLVM_ABI void dumpBytes(ArrayRef<uint8_t> Bytes, raw_ostream &OS);
32
33 namespace HexStyle {
34
35 enum Style {
36 C, ///< 0xff
37 Asm ///< 0ffh
38};
39
40} // end namespace HexStyle
41
42struct AliasMatchingData;
43
44/// This is an instance of a target assembly language printer that
45/// converts an MCInst to valid target assembly syntax.
47protected:
48 /// A stream that comments can be emitted to if desired. Each comment
49 /// must end with a newline. This will be null if verbose assembly emission
50 /// is disabled.
52 const MCAsmInfo &MAI;
55 const MCInstrAnalysis *MIA = nullptr;
56
57 /// True if we are printing marked up assembly.
58 bool UseMarkup = false;
59
60 /// True if we are printing colored assembly.
61 bool UseColor = false;
62
63 /// True if we prefer aliases (e.g. nop) to raw mnemonics.
64 bool PrintAliases = true;
65
66 /// True if we are printing immediates as hex.
67 bool PrintImmHex = false;
68
69 /// Which style to use for printing hexadecimal values.
71
72 /// If true, a branch immediate (e.g. bl 4) will be printed as a hexadecimal
73 /// address (e.g. bl 0x20004). This is useful for a stream disassembler
74 /// (llvm-objdump -d).
76
77 /// If true, symbolize branch target and memory reference operands.
78 bool SymbolizeOperands = false;
79
81
82 /// Utility function for printing annotations.
83 void printAnnotation(raw_ostream &OS, StringRef Annot);
84
85 /// Helper for matching MCInsts to alias patterns when printing instructions.
86 const char *matchAliasPatterns(const MCInst *MI, const MCSubtargetInfo *STI,
87 const AliasMatchingData &M);
88
89public:
90 MCInstPrinter(const MCAsmInfo &mai, const MCInstrInfo &mii,
91 const MCRegisterInfo &mri) : MAI(mai), MII(mii), MRI(mri) {}
92
93 virtual ~MCInstPrinter();
94
101
103 public:
105 Markup M, bool EnableMarkup,
106 bool EnableColor);
108
109 template <typename T> WithMarkup &operator<<(T &O) {
110 OS << O;
111 return *this;
112 }
113
114 template <typename T> WithMarkup &operator<<(const T &O) {
115 OS << O;
116 return *this;
117 }
118
119 private:
120 MCInstPrinter &IP;
121 raw_ostream &OS;
122 bool EnableMarkup;
123 bool EnableColor;
124 };
125
126 /// Customize the printer according to a command line option.
127 /// @return true if the option is recognized and applied.
128 virtual bool applyTargetSpecificCLOption(StringRef Opt) { return false; }
129
130 /// Specify a stream to emit comments to.
132
133 /// Returns a pair containing the mnemonic for \p MI and the number of bits
134 /// left for further processing by printInstruction (generated by tablegen).
135 virtual std::pair<const char *, uint64_t>
136 getMnemonic(const MCInst &MI) const = 0;
137
138 /// Print the specified MCInst to the specified raw_ostream.
139 ///
140 /// \p Address the address of current instruction on most targets, used to
141 /// print a PC relative immediate as the target address. On targets where a PC
142 /// relative immediate is relative to the next instruction and the length of a
143 /// MCInst is difficult to measure (e.g. x86), this is the address of the next
144 /// instruction. If Address is 0, the immediate will be printed.
145 virtual void printInst(const MCInst *MI, uint64_t Address, StringRef Annot,
146 const MCSubtargetInfo &STI, raw_ostream &OS) = 0;
147
148 /// Return the name of the specified opcode enum (e.g. "MOV32ri") or
149 /// empty if we can't resolve it.
150 StringRef getOpcodeName(unsigned Opcode) const;
151
152 /// Print the assembler register name.
153 virtual void printRegName(raw_ostream &OS, MCRegister Reg);
154
155 bool getUseMarkup() const { return UseMarkup; }
157
158 bool getUseColor() const { return UseColor; }
159 void setUseColor(bool Value) { UseColor = Value; }
160
161 WithMarkup markup(raw_ostream &OS, Markup M);
162
163 bool getPrintImmHex() const { return PrintImmHex; }
165
167
171
174
175 /// Utility function to print immediates in decimal or hex.
179
180 /// Utility functions to print decimal/hexadecimal values.
181 format_object<int64_t> formatDec(int64_t Value) const;
182 format_object<int64_t> formatHex(int64_t Value) const;
183 format_object<uint64_t> formatHex(uint64_t Value) const;
184};
185
186/// Map from opcode to pattern list by binary search.
192
193/// Data for each alias pattern. Includes feature bits, string, number of
194/// operands, and a variadic list of conditions to check.
201
204 K_Feature, // Match only if a feature is enabled.
205 K_NegFeature, // Match only if a feature is disabled.
206 K_OrFeature, // Match only if one of a set of features is enabled.
207 K_OrNegFeature, // Match only if one of a set of features is disabled.
208 K_EndOrFeatures, // Note end of list of K_Or(Neg)?Features.
209 K_Ignore, // Match any operand.
210 K_Reg, // Match a specific register.
211 K_TiedReg, // Match another already matched register.
212 K_Imm, // Match a specific immediate.
213 K_RegClass, // Match registers in a class.
214 K_Custom, // Call custom matcher by index.
215 };
216
219};
220
221/// Tablegenerated data structures needed to match alias patterns.
230
231} // end namespace llvm
232
233#endif // LLVM_MC_MCINSTPRINTER_H
#define LLVM_CTOR_NODISCARD
Definition Compiler.h:441
#define LLVM_ABI
Definition Compiler.h:213
static StringRef getOpcodeName(uint8_t Opcode, uint8_t OpcodeBase)
IRTranslator LLVM IR MI
Register Reg
T
#define T
This file defines the SmallVector class.
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:41
This class is intended to be used as a base class for asm properties and features specific to the tar...
Definition MCAsmInfo.h:64
WithMarkup & operator<<(const T &O)
WithMarkup & operator<<(T &O)
LLVM_CTOR_NODISCARD LLVM_ABI WithMarkup(MCInstPrinter &IP, raw_ostream &OS, Markup M, bool EnableMarkup, bool EnableColor)
void setPrintBranchImmAsAddress(bool Value)
bool UseMarkup
True if we are printing marked up assembly.
Definition MCInstPrinter.h:58
void setMCInstrAnalysis(const MCInstrAnalysis *Value)
format_object< int64_t > formatHex(int64_t Value) const
bool PrintImmHex
True if we are printing immediates as hex.
Definition MCInstPrinter.h:67
bool getUseColor() const
void setCommentStream(raw_ostream &OS)
Specify a stream to emit comments to.
virtual bool applyTargetSpecificCLOption(StringRef Opt)
Customize the printer according to a command line option.
void setUseColor(bool Value)
const MCInstrInfo & MII
Definition MCInstPrinter.h:53
raw_ostream * CommentStream
A stream that comments can be emitted to if desired.
Definition MCInstPrinter.h:51
bool getPrintImmHex() const
void setSymbolizeOperands(bool Value)
bool SymbolizeOperands
If true, symbolize branch target and memory reference operands.
Definition MCInstPrinter.h:78
void setPrintImmHex(bool Value)
virtual ~MCInstPrinter()
SmallVector< raw_ostream::Colors, 4 > ColorStack
Definition MCInstPrinter.h:80
void setUseMarkup(bool Value)
format_object< int64_t > formatDec(int64_t Value) const
Utility functions to print decimal/hexadecimal values.
const MCRegisterInfo & MRI
Definition MCInstPrinter.h:54
const MCAsmInfo & MAI
Definition MCInstPrinter.h:52
format_object< int64_t > formatImm(int64_t Value) const
Utility function to print immediates in decimal or hex.
bool UseColor
True if we are printing colored assembly.
Definition MCInstPrinter.h:61
bool getUseMarkup() const
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.
bool PrintBranchImmAsAddress
If true, a branch immediate (e.g.
Definition MCInstPrinter.h:75
virtual void printRegName(raw_ostream &OS, MCRegister Reg)
Print the assembler register name.
virtual std::pair< const char *, uint64_t > getMnemonic(const MCInst &MI) const =0
Returns a pair containing the mnemonic for MI and the number of bits left for further processing by p...
void setPrintHexStyle(HexStyle::Style Value)
const MCInstrAnalysis * MIA
Definition MCInstPrinter.h:55
MCInstPrinter(const MCAsmInfo &mai, const MCInstrInfo &mii, const MCRegisterInfo &mri)
Definition MCInstPrinter.h:90
HexStyle::Style PrintHexStyle
Which style to use for printing hexadecimal values.
Definition MCInstPrinter.h:70
bool PrintAliases
True if we prefer aliases (e.g. nop) to raw mnemonics.
Definition MCInstPrinter.h:64
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
Instances of this class represent operands of the MCInst class.
Definition MCInst.h:40
MCRegisterInfo base class - We assume that the target defines a static array of MCRegisterDesc object...
Wrapper class representing physical registers. Should be passed by value.
Definition MCRegister.h:33
Generic base class for all target subtargets.
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
LLVM Value Representation.
Definition Value.h:75
Definition Format.h:93
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
@ RESET
Definition raw_ostream.h:112
This is an optimization pass for GlobalISel generic memory operations.
Definition AddressRanges.h:18
LLVM_ABI void dumpBytes(ArrayRef< uint8_t > Bytes, raw_ostream &OS)
Convert ‘Bytes’ to a hex string and output to ‘OS’.
Tablegenerated data structures needed to match alias patterns.
ArrayRef< AliasPatternCond > PatternConds
bool(* ValidateMCOperand)(const MCOperand &MCOp, const MCSubtargetInfo &STI, unsigned PredicateIndex)
ArrayRef< PatternsForOpcode > OpToPatterns
ArrayRef< AliasPattern > Patterns
Data for each alias pattern.
uint32_t AsmStrOffset
uint32_t AliasCondStart
Map from opcode to pattern list by binary search.
Generated on for LLVM by doxygen 1.14.0

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