1//===- ARMInstPrinter.h - Convert ARM MCInst to 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// This class prints an ARM MCInst to a .s file.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_LIB_TARGET_ARM_MCTARGETDESC_ARMINSTPRINTER_H
14#define LLVM_LIB_TARGET_ARM_MCTARGETDESC_ARMINSTPRINTER_H
15
16#include "MCTargetDesc/ARMMCTargetDesc.h"
17#include "llvm/MC/MCInstPrinter.h"
18
19namespace llvm {
20
21class ARMInstPrinter : public MCInstPrinter {
22public:
23 ARMInstPrinter(const MCAsmInfo &MAI, const MCInstrInfo &MII,
24 const MCRegisterInfo &MRI);
25
26 bool applyTargetSpecificCLOption(StringRef Opt) override;
27
28 void printInst(const MCInst *MI, uint64_t Address, StringRef Annot,
29 const MCSubtargetInfo &STI, raw_ostream &O) override;
30 void printRegName(raw_ostream &OS, MCRegister Reg) override;
31
32 // Autogenerated by tblgen.
33 std::pair<const char *, uint64_t>
34 getMnemonic(const MCInst &MI) const override;
35 void printInstruction(const MCInst *MI, uint64_t Address,
36 const MCSubtargetInfo &STI, raw_ostream &O);
37 virtual bool printAliasInstr(const MCInst *MI, uint64_t Address,
38 const MCSubtargetInfo &STI, raw_ostream &O);
39 virtual void printCustomAliasOperand(const MCInst *MI, uint64_t Address,
40 unsigned OpIdx, unsigned PrintMethodIdx,
41 const MCSubtargetInfo &STI,
42 raw_ostream &O);
43 static const char *getRegisterName(MCRegister Reg,
44 unsigned AltIdx = ARM::NoRegAltName);
45
46 void printOperand(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
47 raw_ostream &O);
48 void printOperand(const MCInst *MI, uint64_t Address, unsigned OpNum,
49 const MCSubtargetInfo &STI, raw_ostream &O);
50
51 void printSORegRegOperand(const MCInst *MI, unsigned OpNum,
52 const MCSubtargetInfo &STI, raw_ostream &O);
53 void printSORegImmOperand(const MCInst *MI, unsigned OpNum,
54 const MCSubtargetInfo &STI, raw_ostream &O);
55
56 void printAddrModeTBB(const MCInst *MI, unsigned OpNum,
57 const MCSubtargetInfo &STI, raw_ostream &O);
58 void printAddrModeTBH(const MCInst *MI, unsigned OpNum,
59 const MCSubtargetInfo &STI, raw_ostream &O);
60 void printAddrMode2Operand(const MCInst *MI, unsigned OpNum,
61 const MCSubtargetInfo &STI, raw_ostream &O);
62 void printAM2PreOrOffsetIndexOp(const MCInst *MI, unsigned OpNum,
63 const MCSubtargetInfo &STI, raw_ostream &O);
64 void printAddrMode2OffsetOperand(const MCInst *MI, unsigned OpNum,
65 const MCSubtargetInfo &STI, raw_ostream &O);
66 template <bool AlwaysPrintImm0>
67 void printAddrMode3Operand(const MCInst *MI, unsigned OpNum,
68 const MCSubtargetInfo &STI, raw_ostream &O);
69 void printAddrMode3OffsetOperand(const MCInst *MI, unsigned OpNum,
70 const MCSubtargetInfo &STI, raw_ostream &O);
71 void printAM3PreOrOffsetIndexOp(const MCInst *MI, unsigned Op, raw_ostream &O,
72 bool AlwaysPrintImm0);
73 void printPostIdxImm8Operand(const MCInst *MI, unsigned OpNum,
74 const MCSubtargetInfo &STI, raw_ostream &O);
75 void printPostIdxRegOperand(const MCInst *MI, unsigned OpNum,
76 const MCSubtargetInfo &STI, raw_ostream &O);
77 void printPostIdxImm8s4Operand(const MCInst *MI, unsigned OpNum,
78 const MCSubtargetInfo &STI, raw_ostream &O);
79
80 void printLdStmModeOperand(const MCInst *MI, unsigned OpNum,
81 const MCSubtargetInfo &STI, raw_ostream &O);
82 template <bool AlwaysPrintImm0>
83 void printAddrMode5Operand(const MCInst *MI, unsigned OpNum,
84 const MCSubtargetInfo &STI, raw_ostream &O);
85 template <bool AlwaysPrintImm0>
86 void printAddrMode5FP16Operand(const MCInst *MI, unsigned OpNum,
87 const MCSubtargetInfo &STI, raw_ostream &O);
88 void printAddrMode6Operand(const MCInst *MI, unsigned OpNum,
89 const MCSubtargetInfo &STI, raw_ostream &O);
90 void printAddrMode7Operand(const MCInst *MI, unsigned OpNum,
91 const MCSubtargetInfo &STI, raw_ostream &O);
92 void printAddrMode6OffsetOperand(const MCInst *MI, unsigned OpNum,
93 const MCSubtargetInfo &STI, raw_ostream &O);
94
95 void printBitfieldInvMaskImmOperand(const MCInst *MI, unsigned OpNum,
96 const MCSubtargetInfo &STI,
97 raw_ostream &O);
98 void printMemBOption(const MCInst *MI, unsigned OpNum,
99 const MCSubtargetInfo &STI, raw_ostream &O);
100 void printInstSyncBOption(const MCInst *MI, unsigned OpNum,
101 const MCSubtargetInfo &STI, raw_ostream &O);
102 void printTraceSyncBOption(const MCInst *MI, unsigned OpNum,
103 const MCSubtargetInfo &STI, raw_ostream &O);
104 void printShiftImmOperand(const MCInst *MI, unsigned OpNum,
105 const MCSubtargetInfo &STI, raw_ostream &O);
106 void printPKHLSLShiftImm(const MCInst *MI, unsigned OpNum,
107 const MCSubtargetInfo &STI, raw_ostream &O);
108 void printPKHASRShiftImm(const MCInst *MI, unsigned OpNum,
109 const MCSubtargetInfo &STI, raw_ostream &O);
110
111 template <unsigned scale>
112 void printAdrLabelOperand(const MCInst *MI, unsigned OpNum,
113 const MCSubtargetInfo &STI, raw_ostream &O);
114 template <unsigned scale>
115 void printAdrLabelOperand(const MCInst *MI, uint64_t /*Address*/,
116 unsigned OpNum, const MCSubtargetInfo &STI,
117 raw_ostream &O) {
118 printAdrLabelOperand<scale>(MI, OpNum, STI, O);
119 }
120 void printThumbS4ImmOperand(const MCInst *MI, unsigned OpNum,
121 const MCSubtargetInfo &STI, raw_ostream &O);
122 void printThumbSRImm(const MCInst *MI, unsigned OpNum,
123 const MCSubtargetInfo &STI, raw_ostream &O);
124 void printThumbITMask(const MCInst *MI, unsigned OpNum,
125 const MCSubtargetInfo &STI, raw_ostream &O);
126 void printThumbAddrModeRROperand(const MCInst *MI, unsigned OpNum,
127 const MCSubtargetInfo &STI, raw_ostream &O);
128 void printThumbAddrModeImm5SOperand(const MCInst *MI, unsigned OpNum,
129 const MCSubtargetInfo &STI,
130 raw_ostream &O, unsigned Scale);
131 void printThumbAddrModeImm5S1Operand(const MCInst *MI, unsigned OpNum,
132 const MCSubtargetInfo &STI,
133 raw_ostream &O);
134 void printThumbAddrModeImm5S2Operand(const MCInst *MI, unsigned OpNum,
135 const MCSubtargetInfo &STI,
136 raw_ostream &O);
137 void printThumbAddrModeImm5S4Operand(const MCInst *MI, unsigned OpNum,
138 const MCSubtargetInfo &STI,
139 raw_ostream &O);
140 void printThumbAddrModeSPOperand(const MCInst *MI, unsigned OpNum,
141 const MCSubtargetInfo &STI, raw_ostream &O);
142
143 void printT2SOOperand(const MCInst *MI, unsigned OpNum,
144 const MCSubtargetInfo &STI, raw_ostream &O);
145 template <bool AlwaysPrintImm0>
146 void printAddrModeImm12Operand(const MCInst *MI, unsigned OpNum,
147 const MCSubtargetInfo &STI, raw_ostream &O);
148 template <bool AlwaysPrintImm0>
149 void printT2AddrModeImm8Operand(const MCInst *MI, unsigned OpNum,
150 const MCSubtargetInfo &STI, raw_ostream &O);
151 template <bool AlwaysPrintImm0>
152 void printT2AddrModeImm8s4Operand(const MCInst *MI, unsigned OpNum,
153 const MCSubtargetInfo &STI, raw_ostream &O);
154 void printT2AddrModeImm0_1020s4Operand(const MCInst *MI, unsigned OpNum,
155 const MCSubtargetInfo &STI,
156 raw_ostream &O);
157 void printT2AddrModeImm8OffsetOperand(const MCInst *MI, unsigned OpNum,
158 const MCSubtargetInfo &STI,
159 raw_ostream &O);
160 void printT2AddrModeImm8s4OffsetOperand(const MCInst *MI, unsigned OpNum,
161 const MCSubtargetInfo &STI,
162 raw_ostream &O);
163 void printT2AddrModeSoRegOperand(const MCInst *MI, unsigned OpNum,
164 const MCSubtargetInfo &STI, raw_ostream &O);
165
166 void printSetendOperand(const MCInst *MI, unsigned OpNum,
167 const MCSubtargetInfo &STI, raw_ostream &O);
168 void printCPSIMod(const MCInst *MI, unsigned OpNum,
169 const MCSubtargetInfo &STI, raw_ostream &O);
170 void printCPSIFlag(const MCInst *MI, unsigned OpNum,
171 const MCSubtargetInfo &STI, raw_ostream &O);
172 void printMSRMaskOperand(const MCInst *MI, unsigned OpNum,
173 const MCSubtargetInfo &STI, raw_ostream &O);
174 void printBankedRegOperand(const MCInst *MI, unsigned OpNum,
175 const MCSubtargetInfo &STI, raw_ostream &O);
176 void printPredicateOperand(const MCInst *MI, unsigned OpNum,
177 const MCSubtargetInfo &STI, raw_ostream &O);
178 void printMandatoryPredicateOperand(const MCInst *MI, unsigned OpNum,
179 const MCSubtargetInfo &STI,
180 raw_ostream &O);
181 void printMandatoryRestrictedPredicateOperand(const MCInst *MI,
182 unsigned OpNum,
183 const MCSubtargetInfo &STI,
184 raw_ostream &O);
185 void printMandatoryInvertedPredicateOperand(const MCInst *MI, unsigned OpNum,
186 const MCSubtargetInfo &STI,
187 raw_ostream &O);
188 void printSBitModifierOperand(const MCInst *MI, unsigned OpNum,
189 const MCSubtargetInfo &STI, raw_ostream &O);
190 void printRegisterList(const MCInst *MI, unsigned OpNum,
191 const MCSubtargetInfo &STI, raw_ostream &O);
192 void printNoHashImmediate(const MCInst *MI, unsigned OpNum,
193 const MCSubtargetInfo &STI, raw_ostream &O);
194 void printPImmediate(const MCInst *MI, unsigned OpNum,
195 const MCSubtargetInfo &STI, raw_ostream &O);
196 void printCImmediate(const MCInst *MI, unsigned OpNum,
197 const MCSubtargetInfo &STI, raw_ostream &O);
198 void printCoprocOptionImm(const MCInst *MI, unsigned OpNum,
199 const MCSubtargetInfo &STI, raw_ostream &O);
200 void printFPImmOperand(const MCInst *MI, unsigned OpNum,
201 const MCSubtargetInfo &STI, raw_ostream &O);
202 void printVMOVModImmOperand(const MCInst *MI, unsigned OpNum,
203 const MCSubtargetInfo &STI, raw_ostream &O);
204 void printImmPlusOneOperand(const MCInst *MI, unsigned OpNum,
205 const MCSubtargetInfo &STI, raw_ostream &O);
206 void printRotImmOperand(const MCInst *MI, unsigned OpNum,
207 const MCSubtargetInfo &STI, raw_ostream &O);
208 void printModImmOperand(const MCInst *MI, unsigned OpNum,
209 const MCSubtargetInfo &STI, raw_ostream &O);
210 void printGPRPairOperand(const MCInst *MI, unsigned OpNum,
211 const MCSubtargetInfo &STI, raw_ostream &O);
212
213 void printPCLabel(const MCInst *MI, unsigned OpNum,
214 const MCSubtargetInfo &STI, raw_ostream &O);
215 void printThumbLdrLabelOperand(const MCInst *MI, unsigned OpNum,
216 const MCSubtargetInfo &STI, raw_ostream &O);
217 void printThumbLdrLabelOperand(const MCInst *MI, uint64_t /*Address*/,
218 unsigned OpNum, const MCSubtargetInfo &STI,
219 raw_ostream &O) {
220 printThumbLdrLabelOperand(MI, OpNum, STI, O);
221 }
222 void printFBits16(const MCInst *MI, unsigned OpNum,
223 const MCSubtargetInfo &STI, raw_ostream &O);
224 void printFBits32(const MCInst *MI, unsigned OpNum,
225 const MCSubtargetInfo &STI, raw_ostream &O);
226 void printVectorIndex(const MCInst *MI, unsigned OpNum,
227 const MCSubtargetInfo &STI, raw_ostream &O);
228 void printVectorListOne(const MCInst *MI, unsigned OpNum,
229 const MCSubtargetInfo &STI, raw_ostream &O);
230 void printVectorListTwo(const MCInst *MI, unsigned OpNum,
231 const MCSubtargetInfo &STI, raw_ostream &O);
232 void printVectorListTwoSpaced(const MCInst *MI, unsigned OpNum,
233 const MCSubtargetInfo &STI, raw_ostream &O);
234 void printVectorListThree(const MCInst *MI, unsigned OpNum,
235 const MCSubtargetInfo &STI, raw_ostream &O);
236 void printVectorListFour(const MCInst *MI, unsigned OpNum,
237 const MCSubtargetInfo &STI, raw_ostream &O);
238 void printVectorListOneAllLanes(const MCInst *MI, unsigned OpNum,
239 const MCSubtargetInfo &STI, raw_ostream &O);
240 void printVectorListTwoAllLanes(const MCInst *MI, unsigned OpNum,
241 const MCSubtargetInfo &STI, raw_ostream &O);
242 void printVectorListThreeAllLanes(const MCInst *MI, unsigned OpNum,
243 const MCSubtargetInfo &STI, raw_ostream &O);
244 void printVectorListFourAllLanes(const MCInst *MI, unsigned OpNum,
245 const MCSubtargetInfo &STI, raw_ostream &O);
246 void printVectorListTwoSpacedAllLanes(const MCInst *MI, unsigned OpNum,
247 const MCSubtargetInfo &STI,
248 raw_ostream &O);
249 void printVectorListThreeSpacedAllLanes(const MCInst *MI, unsigned OpNum,
250 const MCSubtargetInfo &STI,
251 raw_ostream &O);
252 void printVectorListFourSpacedAllLanes(const MCInst *MI, unsigned OpNum,
253 const MCSubtargetInfo &STI,
254 raw_ostream &O);
255 void printVectorListThreeSpaced(const MCInst *MI, unsigned OpNum,
256 const MCSubtargetInfo &STI, raw_ostream &O);
257 void printVectorListFourSpaced(const MCInst *MI, unsigned OpNum,
258 const MCSubtargetInfo &STI, raw_ostream &O);
259 template<unsigned NumRegs>
260 void printMVEVectorList(const MCInst *MI, unsigned OpNum,
261 const MCSubtargetInfo &STI, raw_ostream &O);
262 template<int64_t Angle, int64_t Remainder>
263 void printComplexRotationOp(const MCInst *MI, unsigned OpNum,
264 const MCSubtargetInfo &STI, raw_ostream &O);
265 // MVE
266 void printVPTPredicateOperand(const MCInst *MI, unsigned OpNum,
267 const MCSubtargetInfo &STI,
268 raw_ostream &O);
269 void printVPTMask(const MCInst *MI, unsigned OpNum,
270 const MCSubtargetInfo &STI, raw_ostream &O);
271 template<int shift>
272 void printMveAddrModeRQOperand(const MCInst *MI, unsigned OpNum,
273 const MCSubtargetInfo &STI, raw_ostream &O);
274 void printMveSaturateOp(const MCInst *MI, unsigned OpNum,
275 const MCSubtargetInfo &STI, raw_ostream &O);
276private:
277 unsigned DefaultAltIdx = ARM::NoRegAltName;
278};
279
280} // end namespace llvm
281
282#endif // LLVM_LIB_TARGET_ARM_MCTARGETDESC_ARMINSTPRINTER_H
283