1 //===-- SIMCCodeEmitter.cpp - SI Code Emitter -------------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 /// \file
11 /// \brief The SI code emitter produces machine code that can be executed
12 /// directly on the GPU device.
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #include "AMDGPU.h"
17 #include "MCTargetDesc/AMDGPUFixupKinds.h"
18 #include "MCTargetDesc/AMDGPUMCCodeEmitter.h"
19 #include "MCTargetDesc/AMDGPUMCTargetDesc.h"
20 #include "SIDefines.h"
21 #include "llvm/MC/MCCodeEmitter.h"
22 #include "llvm/MC/MCContext.h"
23 #include "llvm/MC/MCFixup.h"
24 #include "llvm/MC/MCInst.h"
25 #include "llvm/MC/MCInstrInfo.h"
26 #include "llvm/MC/MCRegisterInfo.h"
27 #include "llvm/MC/MCSubtargetInfo.h"
28 #include "llvm/MC/MCSymbol.h"
29 #include "llvm/Support/raw_ostream.h"
30 
31 using namespace llvm;
32 
33 namespace {
34 
35 class SIMCCodeEmitter : public  AMDGPUMCCodeEmitter {
36   SIMCCodeEmitter(const SIMCCodeEmitter &) = delete;
37   void operator=(const SIMCCodeEmitter &) = delete;
38   const MCInstrInfo &MCII;
39   const MCRegisterInfo &MRI;
40 
41   /// \brief Can this operand also contain immediate values?
42   bool isSrcOperand(const MCInstrDesc &Desc, unsigned OpNo) const;
43 
44   /// \brief Encode an fp or int literal
45   uint32_t getLitEncoding(const MCOperand &MO, unsigned OpSize) const;
46 
47 public:
48   SIMCCodeEmitter(const MCInstrInfo &mcii, const MCRegisterInfo &mri,
49                   MCContext &ctx)
50     : MCII(mcii), MRI(mri) { }
51 
52   ~SIMCCodeEmitter() override {}
53 
54   /// \brief Encode the instruction and write it to the OS.
55   void encodeInstruction(const MCInst &MI, raw_ostream &OS,
56                          SmallVectorImpl<MCFixup> &Fixups,
57                          const MCSubtargetInfo &STI) const override;
58 
59   /// \returns the encoding for an MCOperand.
60   uint64_t getMachineOpValue(const MCInst &MI, const MCOperand &MO,
61                              SmallVectorImpl<MCFixup> &Fixups,
62                              const MCSubtargetInfo &STI) const override;
63 
64   /// \brief Use a fixup to encode the simm16 field for SOPP branch
65   ///        instructions.
66   unsigned getSOPPBrEncoding(const MCInst &MI, unsigned OpNo,
67                              SmallVectorImpl<MCFixup> &Fixups,
68                              const MCSubtargetInfo &STI) const override;
69 };
70 
71 } // End anonymous namespace
72 
73 MCCodeEmitter *llvm::createSIMCCodeEmitter(const MCInstrInfo &MCII,
74                                            const MCRegisterInfo &MRI,
75                                            MCContext &Ctx) {
76   return new SIMCCodeEmitter(MCII, MRI, Ctx);
77 }
78 
79 bool SIMCCodeEmitter::isSrcOperand(const MCInstrDesc &Desc,
80                                    unsigned OpNo) const {
81   unsigned OpType = Desc.OpInfo[OpNo].OperandType;
82 
83   return OpType == AMDGPU::OPERAND_REG_IMM32 ||
84          OpType == AMDGPU::OPERAND_REG_INLINE_C;
85 }
86 
87 // Returns the encoding value to use if the given integer is an integer inline
88 // immediate value, or 0 if it is not.
89 template <typename IntTy>
90 static uint32_t getIntInlineImmEncoding(IntTy Imm) {
91   if (Imm >= 0 && Imm <= 64)
92     return 128 + Imm;
93 
94   if (Imm >= -16 && Imm <= -1)
95     return 192 + std::abs(Imm);
96 
97   return 0;
98 }
99 
100 static uint32_t getLit32Encoding(uint32_t Val) {
101   uint32_t IntImm = getIntInlineImmEncoding(static_cast<int32_t>(Val));
102   if (IntImm != 0)
103     return IntImm;
104 
105   if (Val == FloatToBits(0.5f))
106     return 240;
107 
108   if (Val == FloatToBits(-0.5f))
109     return 241;
110 
111   if (Val == FloatToBits(1.0f))
112     return 242;
113 
114   if (Val == FloatToBits(-1.0f))
115     return 243;
116 
117   if (Val == FloatToBits(2.0f))
118     return 244;
119 
120   if (Val == FloatToBits(-2.0f))
121     return 245;
122 
123   if (Val == FloatToBits(4.0f))
124     return 246;
125 
126   if (Val == FloatToBits(-4.0f))
127     return 247;
128 
129   return 255;
130 }
131 
132 static uint32_t getLit64Encoding(uint64_t Val) {
133   uint32_t IntImm = getIntInlineImmEncoding(static_cast<int64_t>(Val));
134   if (IntImm != 0)
135     return IntImm;
136 
137   if (Val == DoubleToBits(0.5))
138     return 240;
139 
140   if (Val == DoubleToBits(-0.5))
141     return 241;
142 
143   if (Val == DoubleToBits(1.0))
144     return 242;
145 
146   if (Val == DoubleToBits(-1.0))
147     return 243;
148 
149   if (Val == DoubleToBits(2.0))
150     return 244;
151 
152   if (Val == DoubleToBits(-2.0))
153     return 245;
154 
155   if (Val == DoubleToBits(4.0))
156     return 246;
157 
158   if (Val == DoubleToBits(-4.0))
159     return 247;
160 
161   return 255;
162 }
163 
164 uint32_t SIMCCodeEmitter::getLitEncoding(const MCOperand &MO,
165                                          unsigned OpSize) const {
166 
167   int64_t Imm;
168   if (MO.isExpr()) {
169     const MCConstantExpr *C = dyn_cast<MCConstantExpr>(MO.getExpr());
170     if (!C)
171       return 255;
172 
173     Imm = C->getValue();
174   } else {
175 
176     assert(!MO.isFPImm());
177 
178     if (!MO.isImm())
179       return ~0;
180 
181     Imm = MO.getImm();
182   }
183 
184   if (OpSize == 4)
185     return getLit32Encoding(static_cast<uint32_t>(Imm));
186 
187   assert(OpSize == 8);
188 
189   return getLit64Encoding(static_cast<uint64_t>(Imm));
190 }
191 
192 void SIMCCodeEmitter::encodeInstruction(const MCInst &MI, raw_ostream &OS,
193                                        SmallVectorImpl<MCFixup> &Fixups,
194                                        const MCSubtargetInfo &STI) const {
195 
196   uint64_t Encoding = getBinaryCodeForInstr(MI, Fixups, STI);
197   const MCInstrDesc &Desc = MCII.get(MI.getOpcode());
198   unsigned bytes = Desc.getSize();
199 
200   for (unsigned i = 0; i < bytes; i++) {
201     OS.write((uint8_t) ((Encoding >> (8 * i)) & 0xff));
202   }
203 
204   if (bytes > 4)
205     return;
206 
207   // Check for additional literals in SRC0/1/2 (Op 1/2/3)
208   for (unsigned i = 0, e = MI.getNumOperands(); i < e; ++i) {
209 
210     // Check if this operand should be encoded as [SV]Src
211     if (!isSrcOperand(Desc, i))
212       continue;
213 
214     int RCID = Desc.OpInfo[i].RegClass;
215     const MCRegisterClass &RC = MRI.getRegClass(RCID);
216 
217     // Is this operand a literal immediate?
218     const MCOperand &Op = MI.getOperand(i);
219     if (getLitEncoding(Op, RC.getSize()) != 255)
220       continue;
221 
222     // Yes! Encode it
223     int64_t Imm = 0;
224 
225     if (Op.isImm())
226       Imm = Op.getImm();
227     else if (Op.isExpr()) {
228       if (const MCConstantExpr *C = dyn_cast<MCConstantExpr>(Op.getExpr()))
229         Imm = C->getValue();
230 
231     } else if (!Op.isExpr()) // Exprs will be replaced with a fixup value.
232       llvm_unreachable("Must be immediate or expr");
233 
234     for (unsigned j = 0; j < 4; j++) {
235       OS.write((uint8_t) ((Imm >> (8 * j)) & 0xff));
236     }
237 
238     // Only one literal value allowed
239     break;
240   }
241 }
242 
243 unsigned SIMCCodeEmitter::getSOPPBrEncoding(const MCInst &MI, unsigned OpNo,
244                                             SmallVectorImpl<MCFixup> &Fixups,
245                                             const MCSubtargetInfo &STI) const {
246   const MCOperand &MO = MI.getOperand(OpNo);
247 
248   if (MO.isExpr()) {
249     const MCExpr *Expr = MO.getExpr();
250     MCFixupKind Kind = (MCFixupKind)AMDGPU::fixup_si_sopp_br;
251     Fixups.push_back(MCFixup::create(0, Expr, Kind, MI.getLoc()));
252     return 0;
253   }
254 
255   return getMachineOpValue(MI, MO, Fixups, STI);
256 }
257 
258 uint64_t SIMCCodeEmitter::getMachineOpValue(const MCInst &MI,
259                                             const MCOperand &MO,
260                                        SmallVectorImpl<MCFixup> &Fixups,
261                                        const MCSubtargetInfo &STI) const {
262   if (MO.isReg())
263     return MRI.getEncodingValue(MO.getReg());
264 
265   if (MO.isExpr() && MO.getExpr()->getKind() != MCExpr::Constant) {
266     const MCSymbolRefExpr *Expr = dyn_cast<MCSymbolRefExpr>(MO.getExpr());
267     MCFixupKind Kind;
268     if (Expr && Expr->getSymbol().isExternal())
269       Kind = FK_Data_4;
270     else
271       Kind = FK_PCRel_4;
272     Fixups.push_back(MCFixup::create(4, MO.getExpr(), Kind, MI.getLoc()));
273   }
274 
275   // Figure out the operand number, needed for isSrcOperand check
276   unsigned OpNo = 0;
277   for (unsigned e = MI.getNumOperands(); OpNo < e; ++OpNo) {
278     if (&MO == &MI.getOperand(OpNo))
279       break;
280   }
281 
282   const MCInstrDesc &Desc = MCII.get(MI.getOpcode());
283   if (isSrcOperand(Desc, OpNo)) {
284     int RCID = Desc.OpInfo[OpNo].RegClass;
285     const MCRegisterClass &RC = MRI.getRegClass(RCID);
286 
287     uint32_t Enc = getLitEncoding(MO, RC.getSize());
288     if (Enc != ~0U && (Enc != 255 || Desc.getSize() == 4))
289       return Enc;
290 
291   } else if (MO.isImm())
292     return MO.getImm();
293 
294   llvm_unreachable("Encoding of this operand type is not supported yet.");
295   return 0;
296 }
297 
298