1 //===-- AMDGPUInstPrinter.h - AMDGPU MC Inst -> ASM interface ---*- 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 /// \file
10 //===----------------------------------------------------------------------===//
11 
12 #ifndef LLVM_LIB_TARGET_AMDGPU_MCTARGETDESC_AMDGPUINSTPRINTER_H
13 #define LLVM_LIB_TARGET_AMDGPU_MCTARGETDESC_AMDGPUINSTPRINTER_H
14 
15 #include "llvm/MC/MCInstPrinter.h"
16 
17 namespace llvm {
18 
19 class AMDGPUInstPrinter : public MCInstPrinter {
20 public:
21   AMDGPUInstPrinter(const MCAsmInfo &MAI,
22                     const MCInstrInfo &MII, const MCRegisterInfo &MRI)
23     : MCInstPrinter(MAI, MII, MRI) {}
24 
25   //Autogenerated by tblgen
26   void printRegName(raw_ostream &OS, unsigned RegNo) const override;
27   std::pair<const char *, uint64_t> getMnemonic(const MCInst *MI) override;
28   void printInstruction(const MCInst *MI, uint64_t Address,
29                         const MCSubtargetInfo &STI, raw_ostream &O);
30   static const char *getRegisterName(unsigned RegNo);
31 
32   void printInst(const MCInst *MI, uint64_t Address, StringRef Annot,
33                  const MCSubtargetInfo &STI, raw_ostream &O) override;
34   static void printRegOperand(unsigned RegNo, raw_ostream &O,
35                               const MCRegisterInfo &MRI);
36 
37 private:
38   void printU4ImmOperand(const MCInst *MI, unsigned OpNo,
39                          const MCSubtargetInfo &STI, raw_ostream &O);
40   void printU8ImmOperand(const MCInst *MI, unsigned OpNo, raw_ostream &O);
41   void printU16ImmOperand(const MCInst *MI, unsigned OpNo,
42                           const MCSubtargetInfo &STI, raw_ostream &O);
43   void printU4ImmDecOperand(const MCInst *MI, unsigned OpNo, raw_ostream &O);
44   void printU8ImmDecOperand(const MCInst *MI, unsigned OpNo, raw_ostream &O);
45   void printU16ImmDecOperand(const MCInst *MI, unsigned OpNo, raw_ostream &O);
46   void printU32ImmOperand(const MCInst *MI, unsigned OpNo,
47                           const MCSubtargetInfo &STI, raw_ostream &O);
48   void printNamedBit(const MCInst *MI, unsigned OpNo, raw_ostream &O,
49                      StringRef BitName);
50   void printOffen(const MCInst *MI, unsigned OpNo, raw_ostream &O);
51   void printIdxen(const MCInst *MI, unsigned OpNo, raw_ostream &O);
52   void printAddr64(const MCInst *MI, unsigned OpNo, raw_ostream &O);
53   void printMBUFOffset(const MCInst *MI, unsigned OpNo, raw_ostream &O);
54   void printOffset(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
55                    raw_ostream &O);
56   void printFlatOffset(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
57                        raw_ostream &O);
58 
59   void printOffset0(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
60                     raw_ostream &O);
61   void printOffset1(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
62                     raw_ostream &O);
63   void printSMRDOffset8(const MCInst *MI, unsigned OpNo,
64                        const MCSubtargetInfo &STI, raw_ostream &O);
65   void printSMEMOffset(const MCInst *MI, unsigned OpNo,
66                        const MCSubtargetInfo &STI, raw_ostream &O);
67   void printSMEMOffsetMod(const MCInst *MI, unsigned OpNo,
68                           const MCSubtargetInfo &STI, raw_ostream &O);
69   void printSMRDLiteralOffset(const MCInst *MI, unsigned OpNo,
70                               const MCSubtargetInfo &STI, raw_ostream &O);
71   void printGDS(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
72                 raw_ostream &O);
73   void printCPol(const MCInst *MI, unsigned OpNo,
74                  const MCSubtargetInfo &STI, raw_ostream &O);
75   void printSWZ(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
76                 raw_ostream &O);
77   void printTFE(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
78                 raw_ostream &O);
79   void printDMask(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
80                   raw_ostream &O);
81   void printDim(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
82                 raw_ostream &O);
83   void printUNorm(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
84                   raw_ostream &O);
85   void printDA(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
86                raw_ostream &O);
87   void printR128A16(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
88                  raw_ostream &O);
89   void printGFX10A16(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
90                 raw_ostream &O);
91   void printLWE(const MCInst *MI, unsigned OpNo,
92                 const MCSubtargetInfo &STI, raw_ostream &O);
93   void printD16(const MCInst *MI, unsigned OpNo,
94                 const MCSubtargetInfo &STI, raw_ostream &O);
95   void printExpCompr(const MCInst *MI, unsigned OpNo,
96                      const MCSubtargetInfo &STI, raw_ostream &O);
97   void printExpVM(const MCInst *MI, unsigned OpNo,
98                   const MCSubtargetInfo &STI, raw_ostream &O);
99   void printFORMAT(const MCInst *MI, unsigned OpNo,
100                    const MCSubtargetInfo &STI, raw_ostream &O);
101   void printSymbolicFormat(const MCInst *MI,
102                            const MCSubtargetInfo &STI, raw_ostream &O);
103 
104   void printRegOperand(unsigned RegNo, raw_ostream &O);
105   void printVOPDst(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
106                    raw_ostream &O);
107   void printVINTRPDst(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
108                       raw_ostream &O);
109   void printImmediateInt16(uint32_t Imm, const MCSubtargetInfo &STI,
110                            raw_ostream &O);
111   void printImmediate16(uint32_t Imm, const MCSubtargetInfo &STI,
112                         raw_ostream &O);
113   void printImmediateV216(uint32_t Imm, const MCSubtargetInfo &STI,
114                           raw_ostream &O);
115   void printImmediate32(uint32_t Imm, const MCSubtargetInfo &STI,
116                         raw_ostream &O);
117   void printImmediate64(uint64_t Imm, const MCSubtargetInfo &STI,
118                         raw_ostream &O);
119   void printOperand(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
120                     raw_ostream &O);
121   void printOperand(const MCInst *MI, uint64_t /*Address*/, unsigned OpNum,
122                     const MCSubtargetInfo &STI, raw_ostream &O) {
123     printOperand(MI, OpNum, STI, O);
124   }
125   void printOperandAndFPInputMods(const MCInst *MI, unsigned OpNo,
126                                   const MCSubtargetInfo &STI, raw_ostream &O);
127   void printOperandAndIntInputMods(const MCInst *MI, unsigned OpNo,
128                                    const MCSubtargetInfo &STI, raw_ostream &O);
129   void printDPP8(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
130                  raw_ostream &O);
131   void printDPPCtrl(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
132                     raw_ostream &O);
133   void printRowMask(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
134                     raw_ostream &O);
135   void printBankMask(const MCInst *MI, unsigned OpNo,
136                      const MCSubtargetInfo &STI, raw_ostream &O);
137   void printBoundCtrl(const MCInst *MI, unsigned OpNo,
138                       const MCSubtargetInfo &STI, raw_ostream &O);
139   void printFI(const MCInst *MI, unsigned OpNo,
140                const MCSubtargetInfo &STI, raw_ostream &O);
141   void printSDWASel(const MCInst *MI, unsigned OpNo, raw_ostream &O);
142   void printSDWADstSel(const MCInst *MI, unsigned OpNo,
143                        const MCSubtargetInfo &STI, raw_ostream &O);
144   void printSDWASrc0Sel(const MCInst *MI, unsigned OpNo,
145                         const MCSubtargetInfo &STI, raw_ostream &O);
146   void printSDWASrc1Sel(const MCInst *MI, unsigned OpNo,
147                         const MCSubtargetInfo &STI, raw_ostream &O);
148   void printSDWADstUnused(const MCInst *MI, unsigned OpNo,
149                           const MCSubtargetInfo &STI, raw_ostream &O);
150   void printPackedModifier(const MCInst *MI, StringRef Name, unsigned Mod,
151                            raw_ostream &O);
152   void printOpSel(const MCInst *MI, unsigned OpNo,
153                   const MCSubtargetInfo &STI, raw_ostream &O);
154   void printOpSelHi(const MCInst *MI, unsigned OpNo,
155                   const MCSubtargetInfo &STI, raw_ostream &O);
156   void printNegLo(const MCInst *MI, unsigned OpNo,
157                   const MCSubtargetInfo &STI, raw_ostream &O);
158   void printNegHi(const MCInst *MI, unsigned OpNo,
159                   const MCSubtargetInfo &STI, raw_ostream &O);
160   void printInterpSlot(const MCInst *MI, unsigned OpNo,
161                        const MCSubtargetInfo &STI, raw_ostream &O);
162   void printInterpAttr(const MCInst *MI, unsigned OpNo,
163                        const MCSubtargetInfo &STI, raw_ostream &O);
164   void printInterpAttrChan(const MCInst *MI, unsigned OpNo,
165                            const MCSubtargetInfo &STI, raw_ostream &O);
166 
167   void printVGPRIndexMode(const MCInst *MI, unsigned OpNo,
168                           const MCSubtargetInfo &STI, raw_ostream &O);
169   void printMemOperand(const MCInst *MI, unsigned OpNo,
170                        const MCSubtargetInfo &STI, raw_ostream &O);
171   void printBLGP(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
172                  raw_ostream &O);
173   void printCBSZ(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
174                  raw_ostream &O);
175   void printABID(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
176                  raw_ostream &O);
177   void printDefaultVccOperand(unsigned OpNo, const MCSubtargetInfo &STI,
178                               raw_ostream &O);
179 
180   void printExpSrcN(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
181                     raw_ostream &O, unsigned N);
182   void printExpSrc0(const MCInst *MI, unsigned OpNo,
183                     const MCSubtargetInfo &STI, raw_ostream &O);
184   void printExpSrc1(const MCInst *MI, unsigned OpNo,
185                     const MCSubtargetInfo &STI, raw_ostream &O);
186   void printExpSrc2(const MCInst *MI, unsigned OpNo,
187                     const MCSubtargetInfo &STI, raw_ostream &O);
188   void printExpSrc3(const MCInst *MI, unsigned OpNo,
189                     const MCSubtargetInfo &STI, raw_ostream &O);
190   void printExpTgt(const MCInst *MI, unsigned OpNo,
191                    const MCSubtargetInfo &STI, raw_ostream &O);
192 
193 public:
194   static void printIfSet(const MCInst *MI, unsigned OpNo, raw_ostream &O,
195                          StringRef Asm, StringRef Default = "");
196   static void printIfSet(const MCInst *MI, unsigned OpNo, raw_ostream &O,
197                          char Asm);
198 protected:
199   void printAbs(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
200                 raw_ostream &O);
201   void printHigh(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
202                  raw_ostream &O);
203   void printClamp(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
204                   raw_ostream &O);
205   void printClampSI(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
206                     raw_ostream &O);
207   void printOModSI(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
208                    raw_ostream &O);
209   void printLiteral(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
210                     raw_ostream &O);
211   void printLast(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
212                  raw_ostream &O);
213   void printNeg(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
214                 raw_ostream &O);
215   void printOMOD(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
216                  raw_ostream &O);
217   void printRel(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
218                 raw_ostream &O);
219   void printUpdateExecMask(const MCInst *MI, unsigned OpNo,
220                            const MCSubtargetInfo &STI, raw_ostream &O);
221   void printUpdatePred(const MCInst *MI, unsigned OpNo,
222                        const MCSubtargetInfo &STI, raw_ostream &O);
223   void printWrite(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
224                   raw_ostream &O);
225   void printBankSwizzle(const MCInst *MI, unsigned OpNo,
226                         const MCSubtargetInfo &STI, raw_ostream &O);
227   void printRSel(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
228                  raw_ostream &O);
229   void printCT(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
230                raw_ostream &O);
231   void printKCache(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
232                    raw_ostream &O);
233   void printSendMsg(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
234                     raw_ostream &O);
235   void printSwizzle(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
236                     raw_ostream &O);
237   void printWaitFlag(const MCInst *MI, unsigned OpNo,
238                      const MCSubtargetInfo &STI, raw_ostream &O);
239   void printDepCtr(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
240                    raw_ostream &O);
241   void printHwreg(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
242                   raw_ostream &O);
243   void printEndpgm(const MCInst *MI, unsigned OpNo, const MCSubtargetInfo &STI,
244                    raw_ostream &O);
245 };
246 
247 } // End namespace llvm
248 
249 #endif
250