1 //===- SIInstrInfo.cpp - SI Instruction Information  ----------------------===//
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 SI Implementation of TargetInstrInfo.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "SIInstrInfo.h"
16 #include "AMDGPU.h"
17 #include "AMDGPUSubtarget.h"
18 #include "GCNHazardRecognizer.h"
19 #include "SIDefines.h"
20 #include "SIMachineFunctionInfo.h"
21 #include "SIRegisterInfo.h"
22 #include "Utils/AMDGPUBaseInfo.h"
23 #include "llvm/ADT/APInt.h"
24 #include "llvm/ADT/ArrayRef.h"
25 #include "llvm/ADT/SmallVector.h"
26 #include "llvm/ADT/StringRef.h"
27 #include "llvm/ADT/iterator_range.h"
28 #include "llvm/Analysis/AliasAnalysis.h"
29 #include "llvm/Analysis/MemoryLocation.h"
30 #include "llvm/Analysis/ValueTracking.h"
31 #include "llvm/CodeGen/MachineBasicBlock.h"
32 #include "llvm/CodeGen/MachineFrameInfo.h"
33 #include "llvm/CodeGen/MachineFunction.h"
34 #include "llvm/CodeGen/MachineInstr.h"
35 #include "llvm/CodeGen/MachineInstrBuilder.h"
36 #include "llvm/CodeGen/MachineInstrBundle.h"
37 #include "llvm/CodeGen/MachineMemOperand.h"
38 #include "llvm/CodeGen/MachineOperand.h"
39 #include "llvm/CodeGen/MachineRegisterInfo.h"
40 #include "llvm/CodeGen/MachineValueType.h"
41 #include "llvm/CodeGen/RegisterScavenging.h"
42 #include "llvm/CodeGen/ScheduleDAG.h"
43 #include "llvm/CodeGen/SelectionDAGNodes.h"
44 #include "llvm/IR/DebugLoc.h"
45 #include "llvm/IR/DiagnosticInfo.h"
46 #include "llvm/IR/Function.h"
47 #include "llvm/IR/InlineAsm.h"
48 #include "llvm/IR/LLVMContext.h"
49 #include "llvm/MC/MCInstrDesc.h"
50 #include "llvm/Support/Casting.h"
51 #include "llvm/Support/CommandLine.h"
52 #include "llvm/Support/Compiler.h"
53 #include "llvm/Support/ErrorHandling.h"
54 #include "llvm/Support/MathExtras.h"
55 #include "llvm/Target/TargetMachine.h"
56 #include "llvm/Target/TargetOpcodes.h"
57 #include "llvm/Target/TargetRegisterInfo.h"
58 #include <cassert>
59 #include <cstdint>
60 #include <iterator>
61 #include <utility>
62 
63 using namespace llvm;
64 
65 // Must be at least 4 to be able to branch over minimum unconditional branch
66 // code. This is only for making it possible to write reasonably small tests for
67 // long branches.
68 static cl::opt<unsigned>
69 BranchOffsetBits("amdgpu-s-branch-bits", cl::ReallyHidden, cl::init(16),
70                  cl::desc("Restrict range of branch instructions (DEBUG)"));
71 
72 SIInstrInfo::SIInstrInfo(const SISubtarget &ST)
73   : AMDGPUInstrInfo(ST), RI(ST), ST(ST) {}
74 
75 //===----------------------------------------------------------------------===//
76 // TargetInstrInfo callbacks
77 //===----------------------------------------------------------------------===//
78 
79 static unsigned getNumOperandsNoGlue(SDNode *Node) {
80   unsigned N = Node->getNumOperands();
81   while (N && Node->getOperand(N - 1).getValueType() == MVT::Glue)
82     --N;
83   return N;
84 }
85 
86 static SDValue findChainOperand(SDNode *Load) {
87   SDValue LastOp = Load->getOperand(getNumOperandsNoGlue(Load) - 1);
88   assert(LastOp.getValueType() == MVT::Other && "Chain missing from load node");
89   return LastOp;
90 }
91 
92 /// \brief Returns true if both nodes have the same value for the given
93 ///        operand \p Op, or if both nodes do not have this operand.
94 static bool nodesHaveSameOperandValue(SDNode *N0, SDNode* N1, unsigned OpName) {
95   unsigned Opc0 = N0->getMachineOpcode();
96   unsigned Opc1 = N1->getMachineOpcode();
97 
98   int Op0Idx = AMDGPU::getNamedOperandIdx(Opc0, OpName);
99   int Op1Idx = AMDGPU::getNamedOperandIdx(Opc1, OpName);
100 
101   if (Op0Idx == -1 && Op1Idx == -1)
102     return true;
103 
104 
105   if ((Op0Idx == -1 && Op1Idx != -1) ||
106       (Op1Idx == -1 && Op0Idx != -1))
107     return false;
108 
109   // getNamedOperandIdx returns the index for the MachineInstr's operands,
110   // which includes the result as the first operand. We are indexing into the
111   // MachineSDNode's operands, so we need to skip the result operand to get
112   // the real index.
113   --Op0Idx;
114   --Op1Idx;
115 
116   return N0->getOperand(Op0Idx) == N1->getOperand(Op1Idx);
117 }
118 
119 bool SIInstrInfo::isReallyTriviallyReMaterializable(const MachineInstr &MI,
120                                                     AliasAnalysis *AA) const {
121   // TODO: The generic check fails for VALU instructions that should be
122   // rematerializable due to implicit reads of exec. We really want all of the
123   // generic logic for this except for this.
124   switch (MI.getOpcode()) {
125   case AMDGPU::V_MOV_B32_e32:
126   case AMDGPU::V_MOV_B32_e64:
127   case AMDGPU::V_MOV_B64_PSEUDO:
128     return true;
129   default:
130     return false;
131   }
132 }
133 
134 bool SIInstrInfo::areLoadsFromSameBasePtr(SDNode *Load0, SDNode *Load1,
135                                           int64_t &Offset0,
136                                           int64_t &Offset1) const {
137   if (!Load0->isMachineOpcode() || !Load1->isMachineOpcode())
138     return false;
139 
140   unsigned Opc0 = Load0->getMachineOpcode();
141   unsigned Opc1 = Load1->getMachineOpcode();
142 
143   // Make sure both are actually loads.
144   if (!get(Opc0).mayLoad() || !get(Opc1).mayLoad())
145     return false;
146 
147   if (isDS(Opc0) && isDS(Opc1)) {
148 
149     // FIXME: Handle this case:
150     if (getNumOperandsNoGlue(Load0) != getNumOperandsNoGlue(Load1))
151       return false;
152 
153     // Check base reg.
154     if (Load0->getOperand(1) != Load1->getOperand(1))
155       return false;
156 
157     // Check chain.
158     if (findChainOperand(Load0) != findChainOperand(Load1))
159       return false;
160 
161     // Skip read2 / write2 variants for simplicity.
162     // TODO: We should report true if the used offsets are adjacent (excluded
163     // st64 versions).
164     if (AMDGPU::getNamedOperandIdx(Opc0, AMDGPU::OpName::data1) != -1 ||
165         AMDGPU::getNamedOperandIdx(Opc1, AMDGPU::OpName::data1) != -1)
166       return false;
167 
168     Offset0 = cast<ConstantSDNode>(Load0->getOperand(2))->getZExtValue();
169     Offset1 = cast<ConstantSDNode>(Load1->getOperand(2))->getZExtValue();
170     return true;
171   }
172 
173   if (isSMRD(Opc0) && isSMRD(Opc1)) {
174     // Skip time and cache invalidation instructions.
175     if (AMDGPU::getNamedOperandIdx(Opc0, AMDGPU::OpName::sbase) == -1 ||
176         AMDGPU::getNamedOperandIdx(Opc1, AMDGPU::OpName::sbase) == -1)
177       return false;
178 
179     assert(getNumOperandsNoGlue(Load0) == getNumOperandsNoGlue(Load1));
180 
181     // Check base reg.
182     if (Load0->getOperand(0) != Load1->getOperand(0))
183       return false;
184 
185     const ConstantSDNode *Load0Offset =
186         dyn_cast<ConstantSDNode>(Load0->getOperand(1));
187     const ConstantSDNode *Load1Offset =
188         dyn_cast<ConstantSDNode>(Load1->getOperand(1));
189 
190     if (!Load0Offset || !Load1Offset)
191       return false;
192 
193     // Check chain.
194     if (findChainOperand(Load0) != findChainOperand(Load1))
195       return false;
196 
197     Offset0 = Load0Offset->getZExtValue();
198     Offset1 = Load1Offset->getZExtValue();
199     return true;
200   }
201 
202   // MUBUF and MTBUF can access the same addresses.
203   if ((isMUBUF(Opc0) || isMTBUF(Opc0)) && (isMUBUF(Opc1) || isMTBUF(Opc1))) {
204 
205     // MUBUF and MTBUF have vaddr at different indices.
206     if (!nodesHaveSameOperandValue(Load0, Load1, AMDGPU::OpName::soffset) ||
207         findChainOperand(Load0) != findChainOperand(Load1) ||
208         !nodesHaveSameOperandValue(Load0, Load1, AMDGPU::OpName::vaddr) ||
209         !nodesHaveSameOperandValue(Load0, Load1, AMDGPU::OpName::srsrc))
210       return false;
211 
212     int OffIdx0 = AMDGPU::getNamedOperandIdx(Opc0, AMDGPU::OpName::offset);
213     int OffIdx1 = AMDGPU::getNamedOperandIdx(Opc1, AMDGPU::OpName::offset);
214 
215     if (OffIdx0 == -1 || OffIdx1 == -1)
216       return false;
217 
218     // getNamedOperandIdx returns the index for MachineInstrs.  Since they
219     // inlcude the output in the operand list, but SDNodes don't, we need to
220     // subtract the index by one.
221     --OffIdx0;
222     --OffIdx1;
223 
224     SDValue Off0 = Load0->getOperand(OffIdx0);
225     SDValue Off1 = Load1->getOperand(OffIdx1);
226 
227     // The offset might be a FrameIndexSDNode.
228     if (!isa<ConstantSDNode>(Off0) || !isa<ConstantSDNode>(Off1))
229       return false;
230 
231     Offset0 = cast<ConstantSDNode>(Off0)->getZExtValue();
232     Offset1 = cast<ConstantSDNode>(Off1)->getZExtValue();
233     return true;
234   }
235 
236   return false;
237 }
238 
239 static bool isStride64(unsigned Opc) {
240   switch (Opc) {
241   case AMDGPU::DS_READ2ST64_B32:
242   case AMDGPU::DS_READ2ST64_B64:
243   case AMDGPU::DS_WRITE2ST64_B32:
244   case AMDGPU::DS_WRITE2ST64_B64:
245     return true;
246   default:
247     return false;
248   }
249 }
250 
251 bool SIInstrInfo::getMemOpBaseRegImmOfs(MachineInstr &LdSt, unsigned &BaseReg,
252                                         int64_t &Offset,
253                                         const TargetRegisterInfo *TRI) const {
254   unsigned Opc = LdSt.getOpcode();
255 
256   if (isDS(LdSt)) {
257     const MachineOperand *OffsetImm =
258         getNamedOperand(LdSt, AMDGPU::OpName::offset);
259     if (OffsetImm) {
260       // Normal, single offset LDS instruction.
261       const MachineOperand *AddrReg =
262           getNamedOperand(LdSt, AMDGPU::OpName::addr);
263 
264       BaseReg = AddrReg->getReg();
265       Offset = OffsetImm->getImm();
266       return true;
267     }
268 
269     // The 2 offset instructions use offset0 and offset1 instead. We can treat
270     // these as a load with a single offset if the 2 offsets are consecutive. We
271     // will use this for some partially aligned loads.
272     const MachineOperand *Offset0Imm =
273         getNamedOperand(LdSt, AMDGPU::OpName::offset0);
274     const MachineOperand *Offset1Imm =
275         getNamedOperand(LdSt, AMDGPU::OpName::offset1);
276 
277     uint8_t Offset0 = Offset0Imm->getImm();
278     uint8_t Offset1 = Offset1Imm->getImm();
279 
280     if (Offset1 > Offset0 && Offset1 - Offset0 == 1) {
281       // Each of these offsets is in element sized units, so we need to convert
282       // to bytes of the individual reads.
283 
284       unsigned EltSize;
285       if (LdSt.mayLoad())
286         EltSize = TRI->getRegSizeInBits(*getOpRegClass(LdSt, 0)) / 16;
287       else {
288         assert(LdSt.mayStore());
289         int Data0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::data0);
290         EltSize = TRI->getRegSizeInBits(*getOpRegClass(LdSt, Data0Idx)) / 8;
291       }
292 
293       if (isStride64(Opc))
294         EltSize *= 64;
295 
296       const MachineOperand *AddrReg =
297           getNamedOperand(LdSt, AMDGPU::OpName::addr);
298       BaseReg = AddrReg->getReg();
299       Offset = EltSize * Offset0;
300       return true;
301     }
302 
303     return false;
304   }
305 
306   if (isMUBUF(LdSt) || isMTBUF(LdSt)) {
307     const MachineOperand *SOffset = getNamedOperand(LdSt, AMDGPU::OpName::soffset);
308     if (SOffset && SOffset->isReg())
309       return false;
310 
311     const MachineOperand *AddrReg =
312         getNamedOperand(LdSt, AMDGPU::OpName::vaddr);
313     if (!AddrReg)
314       return false;
315 
316     const MachineOperand *OffsetImm =
317         getNamedOperand(LdSt, AMDGPU::OpName::offset);
318     BaseReg = AddrReg->getReg();
319     Offset = OffsetImm->getImm();
320 
321     if (SOffset) // soffset can be an inline immediate.
322       Offset += SOffset->getImm();
323 
324     return true;
325   }
326 
327   if (isSMRD(LdSt)) {
328     const MachineOperand *OffsetImm =
329         getNamedOperand(LdSt, AMDGPU::OpName::offset);
330     if (!OffsetImm)
331       return false;
332 
333     const MachineOperand *SBaseReg =
334         getNamedOperand(LdSt, AMDGPU::OpName::sbase);
335     BaseReg = SBaseReg->getReg();
336     Offset = OffsetImm->getImm();
337     return true;
338   }
339 
340   if (isFLAT(LdSt)) {
341     const MachineOperand *VAddr = getNamedOperand(LdSt, AMDGPU::OpName::vaddr);
342     if (VAddr) {
343       // Can't analyze 2 offsets.
344       if (getNamedOperand(LdSt, AMDGPU::OpName::saddr))
345         return false;
346 
347       BaseReg = VAddr->getReg();
348     } else {
349       // scratch instructions have either vaddr or saddr.
350       BaseReg = getNamedOperand(LdSt, AMDGPU::OpName::saddr)->getReg();
351     }
352 
353     Offset = getNamedOperand(LdSt, AMDGPU::OpName::offset)->getImm();
354     return true;
355   }
356 
357   return false;
358 }
359 
360 static bool memOpsHaveSameBasePtr(const MachineInstr &MI1, unsigned BaseReg1,
361                                   const MachineInstr &MI2, unsigned BaseReg2) {
362   if (BaseReg1 == BaseReg2)
363     return true;
364 
365   if (!MI1.hasOneMemOperand() || !MI2.hasOneMemOperand())
366     return false;
367 
368   auto MO1 = *MI1.memoperands_begin();
369   auto MO2 = *MI2.memoperands_begin();
370   if (MO1->getAddrSpace() != MO2->getAddrSpace())
371     return false;
372 
373   auto Base1 = MO1->getValue();
374   auto Base2 = MO2->getValue();
375   if (!Base1 || !Base2)
376     return false;
377   const MachineFunction &MF = *MI1.getParent()->getParent();
378   const DataLayout &DL = MF.getFunction()->getParent()->getDataLayout();
379   Base1 = GetUnderlyingObject(Base1, DL);
380   Base2 = GetUnderlyingObject(Base1, DL);
381 
382   if (isa<UndefValue>(Base1) || isa<UndefValue>(Base2))
383     return false;
384 
385   return Base1 == Base2;
386 }
387 
388 bool SIInstrInfo::shouldClusterMemOps(MachineInstr &FirstLdSt,
389                                       unsigned BaseReg1,
390                                       MachineInstr &SecondLdSt,
391                                       unsigned BaseReg2,
392                                       unsigned NumLoads) const {
393   if (!memOpsHaveSameBasePtr(FirstLdSt, BaseReg1, SecondLdSt, BaseReg2))
394     return false;
395 
396   const MachineOperand *FirstDst = nullptr;
397   const MachineOperand *SecondDst = nullptr;
398 
399   if ((isMUBUF(FirstLdSt) && isMUBUF(SecondLdSt)) ||
400       (isMTBUF(FirstLdSt) && isMTBUF(SecondLdSt)) ||
401       (isFLAT(FirstLdSt) && isFLAT(SecondLdSt))) {
402     const unsigned MaxGlobalLoadCluster = 6;
403     if (NumLoads > MaxGlobalLoadCluster)
404       return false;
405 
406     FirstDst = getNamedOperand(FirstLdSt, AMDGPU::OpName::vdata);
407     if (!FirstDst)
408       FirstDst = getNamedOperand(FirstLdSt, AMDGPU::OpName::vdst);
409     SecondDst = getNamedOperand(SecondLdSt, AMDGPU::OpName::vdata);
410     if (!SecondDst)
411       SecondDst = getNamedOperand(SecondLdSt, AMDGPU::OpName::vdst);
412   } else if (isSMRD(FirstLdSt) && isSMRD(SecondLdSt)) {
413     FirstDst = getNamedOperand(FirstLdSt, AMDGPU::OpName::sdst);
414     SecondDst = getNamedOperand(SecondLdSt, AMDGPU::OpName::sdst);
415   } else if (isDS(FirstLdSt) && isDS(SecondLdSt)) {
416     FirstDst = getNamedOperand(FirstLdSt, AMDGPU::OpName::vdst);
417     SecondDst = getNamedOperand(SecondLdSt, AMDGPU::OpName::vdst);
418   }
419 
420   if (!FirstDst || !SecondDst)
421     return false;
422 
423   // Try to limit clustering based on the total number of bytes loaded
424   // rather than the number of instructions.  This is done to help reduce
425   // register pressure.  The method used is somewhat inexact, though,
426   // because it assumes that all loads in the cluster will load the
427   // same number of bytes as FirstLdSt.
428 
429   // The unit of this value is bytes.
430   // FIXME: This needs finer tuning.
431   unsigned LoadClusterThreshold = 16;
432 
433   const MachineRegisterInfo &MRI =
434       FirstLdSt.getParent()->getParent()->getRegInfo();
435   const TargetRegisterClass *DstRC = MRI.getRegClass(FirstDst->getReg());
436 
437   return (NumLoads * (RI.getRegSizeInBits(*DstRC) / 8)) <= LoadClusterThreshold;
438 }
439 
440 static void reportIllegalCopy(const SIInstrInfo *TII, MachineBasicBlock &MBB,
441                               MachineBasicBlock::iterator MI,
442                               const DebugLoc &DL, unsigned DestReg,
443                               unsigned SrcReg, bool KillSrc) {
444   MachineFunction *MF = MBB.getParent();
445   DiagnosticInfoUnsupported IllegalCopy(*MF->getFunction(),
446                                         "illegal SGPR to VGPR copy",
447                                         DL, DS_Error);
448   LLVMContext &C = MF->getFunction()->getContext();
449   C.diagnose(IllegalCopy);
450 
451   BuildMI(MBB, MI, DL, TII->get(AMDGPU::SI_ILLEGAL_COPY), DestReg)
452     .addReg(SrcReg, getKillRegState(KillSrc));
453 }
454 
455 void SIInstrInfo::copyPhysReg(MachineBasicBlock &MBB,
456                               MachineBasicBlock::iterator MI,
457                               const DebugLoc &DL, unsigned DestReg,
458                               unsigned SrcReg, bool KillSrc) const {
459   const TargetRegisterClass *RC = RI.getPhysRegClass(DestReg);
460 
461   if (RC == &AMDGPU::VGPR_32RegClass) {
462     assert(AMDGPU::VGPR_32RegClass.contains(SrcReg) ||
463            AMDGPU::SReg_32RegClass.contains(SrcReg));
464     BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B32_e32), DestReg)
465       .addReg(SrcReg, getKillRegState(KillSrc));
466     return;
467   }
468 
469   if (RC == &AMDGPU::SReg_32_XM0RegClass ||
470       RC == &AMDGPU::SReg_32RegClass) {
471     if (SrcReg == AMDGPU::SCC) {
472       BuildMI(MBB, MI, DL, get(AMDGPU::S_CSELECT_B32), DestReg)
473           .addImm(-1)
474           .addImm(0);
475       return;
476     }
477 
478     if (!AMDGPU::SReg_32RegClass.contains(SrcReg)) {
479       reportIllegalCopy(this, MBB, MI, DL, DestReg, SrcReg, KillSrc);
480       return;
481     }
482 
483     BuildMI(MBB, MI, DL, get(AMDGPU::S_MOV_B32), DestReg)
484             .addReg(SrcReg, getKillRegState(KillSrc));
485     return;
486   }
487 
488   if (RC == &AMDGPU::SReg_64RegClass) {
489     if (DestReg == AMDGPU::VCC) {
490       if (AMDGPU::SReg_64RegClass.contains(SrcReg)) {
491         BuildMI(MBB, MI, DL, get(AMDGPU::S_MOV_B64), AMDGPU::VCC)
492           .addReg(SrcReg, getKillRegState(KillSrc));
493       } else {
494         // FIXME: Hack until VReg_1 removed.
495         assert(AMDGPU::VGPR_32RegClass.contains(SrcReg));
496         BuildMI(MBB, MI, DL, get(AMDGPU::V_CMP_NE_U32_e32))
497           .addImm(0)
498           .addReg(SrcReg, getKillRegState(KillSrc));
499       }
500 
501       return;
502     }
503 
504     if (!AMDGPU::SReg_64RegClass.contains(SrcReg)) {
505       reportIllegalCopy(this, MBB, MI, DL, DestReg, SrcReg, KillSrc);
506       return;
507     }
508 
509     BuildMI(MBB, MI, DL, get(AMDGPU::S_MOV_B64), DestReg)
510             .addReg(SrcReg, getKillRegState(KillSrc));
511     return;
512   }
513 
514   if (DestReg == AMDGPU::SCC) {
515     assert(AMDGPU::SReg_32RegClass.contains(SrcReg));
516     BuildMI(MBB, MI, DL, get(AMDGPU::S_CMP_LG_U32))
517       .addReg(SrcReg, getKillRegState(KillSrc))
518       .addImm(0);
519     return;
520   }
521 
522   unsigned EltSize = 4;
523   unsigned Opcode = AMDGPU::V_MOV_B32_e32;
524   if (RI.isSGPRClass(RC)) {
525     if (RI.getRegSizeInBits(*RC) > 32) {
526       Opcode =  AMDGPU::S_MOV_B64;
527       EltSize = 8;
528     } else {
529       Opcode = AMDGPU::S_MOV_B32;
530       EltSize = 4;
531     }
532 
533     if (!RI.isSGPRClass(RI.getPhysRegClass(SrcReg))) {
534       reportIllegalCopy(this, MBB, MI, DL, DestReg, SrcReg, KillSrc);
535       return;
536     }
537   }
538 
539   ArrayRef<int16_t> SubIndices = RI.getRegSplitParts(RC, EltSize);
540   bool Forward = RI.getHWRegIndex(DestReg) <= RI.getHWRegIndex(SrcReg);
541 
542   for (unsigned Idx = 0; Idx < SubIndices.size(); ++Idx) {
543     unsigned SubIdx;
544     if (Forward)
545       SubIdx = SubIndices[Idx];
546     else
547       SubIdx = SubIndices[SubIndices.size() - Idx - 1];
548 
549     MachineInstrBuilder Builder = BuildMI(MBB, MI, DL,
550       get(Opcode), RI.getSubReg(DestReg, SubIdx));
551 
552     Builder.addReg(RI.getSubReg(SrcReg, SubIdx));
553 
554     if (Idx == 0)
555       Builder.addReg(DestReg, RegState::Define | RegState::Implicit);
556 
557     bool UseKill = KillSrc && Idx == SubIndices.size() - 1;
558     Builder.addReg(SrcReg, getKillRegState(UseKill) | RegState::Implicit);
559   }
560 }
561 
562 int SIInstrInfo::commuteOpcode(unsigned Opcode) const {
563   int NewOpc;
564 
565   // Try to map original to commuted opcode
566   NewOpc = AMDGPU::getCommuteRev(Opcode);
567   if (NewOpc != -1)
568     // Check if the commuted (REV) opcode exists on the target.
569     return pseudoToMCOpcode(NewOpc) != -1 ? NewOpc : -1;
570 
571   // Try to map commuted to original opcode
572   NewOpc = AMDGPU::getCommuteOrig(Opcode);
573   if (NewOpc != -1)
574     // Check if the original (non-REV) opcode exists on the target.
575     return pseudoToMCOpcode(NewOpc) != -1 ? NewOpc : -1;
576 
577   return Opcode;
578 }
579 
580 void SIInstrInfo::materializeImmediate(MachineBasicBlock &MBB,
581                                        MachineBasicBlock::iterator MI,
582                                        const DebugLoc &DL, unsigned DestReg,
583                                        int64_t Value) const {
584   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
585   const TargetRegisterClass *RegClass = MRI.getRegClass(DestReg);
586   if (RegClass == &AMDGPU::SReg_32RegClass ||
587       RegClass == &AMDGPU::SGPR_32RegClass ||
588       RegClass == &AMDGPU::SReg_32_XM0RegClass ||
589       RegClass == &AMDGPU::SReg_32_XM0_XEXECRegClass) {
590     BuildMI(MBB, MI, DL, get(AMDGPU::S_MOV_B32), DestReg)
591       .addImm(Value);
592     return;
593   }
594 
595   if (RegClass == &AMDGPU::SReg_64RegClass ||
596       RegClass == &AMDGPU::SGPR_64RegClass ||
597       RegClass == &AMDGPU::SReg_64_XEXECRegClass) {
598     BuildMI(MBB, MI, DL, get(AMDGPU::S_MOV_B64), DestReg)
599       .addImm(Value);
600     return;
601   }
602 
603   if (RegClass == &AMDGPU::VGPR_32RegClass) {
604     BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B32_e32), DestReg)
605       .addImm(Value);
606     return;
607   }
608   if (RegClass == &AMDGPU::VReg_64RegClass) {
609     BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B64_PSEUDO), DestReg)
610       .addImm(Value);
611     return;
612   }
613 
614   unsigned EltSize = 4;
615   unsigned Opcode = AMDGPU::V_MOV_B32_e32;
616   if (RI.isSGPRClass(RegClass)) {
617     if (RI.getRegSizeInBits(*RegClass) > 32) {
618       Opcode =  AMDGPU::S_MOV_B64;
619       EltSize = 8;
620     } else {
621       Opcode = AMDGPU::S_MOV_B32;
622       EltSize = 4;
623     }
624   }
625 
626   ArrayRef<int16_t> SubIndices = RI.getRegSplitParts(RegClass, EltSize);
627   for (unsigned Idx = 0; Idx < SubIndices.size(); ++Idx) {
628     int64_t IdxValue = Idx == 0 ? Value : 0;
629 
630     MachineInstrBuilder Builder = BuildMI(MBB, MI, DL,
631       get(Opcode), RI.getSubReg(DestReg, Idx));
632     Builder.addImm(IdxValue);
633   }
634 }
635 
636 const TargetRegisterClass *
637 SIInstrInfo::getPreferredSelectRegClass(unsigned Size) const {
638   return &AMDGPU::VGPR_32RegClass;
639 }
640 
641 void SIInstrInfo::insertVectorSelect(MachineBasicBlock &MBB,
642                                      MachineBasicBlock::iterator I,
643                                      const DebugLoc &DL, unsigned DstReg,
644                                      ArrayRef<MachineOperand> Cond,
645                                      unsigned TrueReg,
646                                      unsigned FalseReg) const {
647   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
648   assert(MRI.getRegClass(DstReg) == &AMDGPU::VGPR_32RegClass &&
649          "Not a VGPR32 reg");
650 
651   if (Cond.size() == 1) {
652     BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
653       .addReg(FalseReg)
654       .addReg(TrueReg)
655       .add(Cond[0]);
656   } else if (Cond.size() == 2) {
657     assert(Cond[0].isImm() && "Cond[0] is not an immediate");
658     switch (Cond[0].getImm()) {
659     case SIInstrInfo::SCC_TRUE: {
660       unsigned SReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
661       BuildMI(MBB, I, DL, get(AMDGPU::S_CSELECT_B64), SReg)
662         .addImm(-1)
663         .addImm(0);
664       BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
665         .addReg(FalseReg)
666         .addReg(TrueReg)
667         .addReg(SReg);
668       break;
669     }
670     case SIInstrInfo::SCC_FALSE: {
671       unsigned SReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
672       BuildMI(MBB, I, DL, get(AMDGPU::S_CSELECT_B64), SReg)
673         .addImm(0)
674         .addImm(-1);
675       BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
676         .addReg(FalseReg)
677         .addReg(TrueReg)
678         .addReg(SReg);
679       break;
680     }
681     case SIInstrInfo::VCCNZ: {
682       MachineOperand RegOp = Cond[1];
683       RegOp.setImplicit(false);
684       BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
685           .addReg(FalseReg)
686           .addReg(TrueReg)
687           .add(RegOp);
688       break;
689     }
690     case SIInstrInfo::VCCZ: {
691       MachineOperand RegOp = Cond[1];
692       RegOp.setImplicit(false);
693       BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
694           .addReg(TrueReg)
695           .addReg(FalseReg)
696           .add(RegOp);
697       break;
698     }
699     case SIInstrInfo::EXECNZ: {
700       unsigned SReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
701       unsigned SReg2 = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
702       BuildMI(MBB, I, DL, get(AMDGPU::S_OR_SAVEEXEC_B64), SReg2)
703         .addImm(0);
704       BuildMI(MBB, I, DL, get(AMDGPU::S_CSELECT_B64), SReg)
705         .addImm(-1)
706         .addImm(0);
707       BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
708         .addReg(FalseReg)
709         .addReg(TrueReg)
710         .addReg(SReg);
711       break;
712     }
713     case SIInstrInfo::EXECZ: {
714       unsigned SReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
715       unsigned SReg2 = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
716       BuildMI(MBB, I, DL, get(AMDGPU::S_OR_SAVEEXEC_B64), SReg2)
717         .addImm(0);
718       BuildMI(MBB, I, DL, get(AMDGPU::S_CSELECT_B64), SReg)
719         .addImm(0)
720         .addImm(-1);
721       BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
722         .addReg(FalseReg)
723         .addReg(TrueReg)
724         .addReg(SReg);
725       llvm_unreachable("Unhandled branch predicate EXECZ");
726       break;
727     }
728     default:
729       llvm_unreachable("invalid branch predicate");
730     }
731   } else {
732     llvm_unreachable("Can only handle Cond size 1 or 2");
733   }
734 }
735 
736 unsigned SIInstrInfo::insertEQ(MachineBasicBlock *MBB,
737                                MachineBasicBlock::iterator I,
738                                const DebugLoc &DL,
739                                unsigned SrcReg, int Value) const {
740   MachineRegisterInfo &MRI = MBB->getParent()->getRegInfo();
741   unsigned Reg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
742   BuildMI(*MBB, I, DL, get(AMDGPU::V_CMP_EQ_I32_e64), Reg)
743     .addImm(Value)
744     .addReg(SrcReg);
745 
746   return Reg;
747 }
748 
749 unsigned SIInstrInfo::insertNE(MachineBasicBlock *MBB,
750                                MachineBasicBlock::iterator I,
751                                const DebugLoc &DL,
752                                unsigned SrcReg, int Value) const {
753   MachineRegisterInfo &MRI = MBB->getParent()->getRegInfo();
754   unsigned Reg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
755   BuildMI(*MBB, I, DL, get(AMDGPU::V_CMP_NE_I32_e64), Reg)
756     .addImm(Value)
757     .addReg(SrcReg);
758 
759   return Reg;
760 }
761 
762 unsigned SIInstrInfo::getMovOpcode(const TargetRegisterClass *DstRC) const {
763 
764   if (RI.getRegSizeInBits(*DstRC) == 32) {
765     return RI.isSGPRClass(DstRC) ? AMDGPU::S_MOV_B32 : AMDGPU::V_MOV_B32_e32;
766   } else if (RI.getRegSizeInBits(*DstRC) == 64 && RI.isSGPRClass(DstRC)) {
767     return AMDGPU::S_MOV_B64;
768   } else if (RI.getRegSizeInBits(*DstRC) == 64 && !RI.isSGPRClass(DstRC)) {
769     return  AMDGPU::V_MOV_B64_PSEUDO;
770   }
771   return AMDGPU::COPY;
772 }
773 
774 static unsigned getSGPRSpillSaveOpcode(unsigned Size) {
775   switch (Size) {
776   case 4:
777     return AMDGPU::SI_SPILL_S32_SAVE;
778   case 8:
779     return AMDGPU::SI_SPILL_S64_SAVE;
780   case 16:
781     return AMDGPU::SI_SPILL_S128_SAVE;
782   case 32:
783     return AMDGPU::SI_SPILL_S256_SAVE;
784   case 64:
785     return AMDGPU::SI_SPILL_S512_SAVE;
786   default:
787     llvm_unreachable("unknown register size");
788   }
789 }
790 
791 static unsigned getVGPRSpillSaveOpcode(unsigned Size) {
792   switch (Size) {
793   case 4:
794     return AMDGPU::SI_SPILL_V32_SAVE;
795   case 8:
796     return AMDGPU::SI_SPILL_V64_SAVE;
797   case 12:
798     return AMDGPU::SI_SPILL_V96_SAVE;
799   case 16:
800     return AMDGPU::SI_SPILL_V128_SAVE;
801   case 32:
802     return AMDGPU::SI_SPILL_V256_SAVE;
803   case 64:
804     return AMDGPU::SI_SPILL_V512_SAVE;
805   default:
806     llvm_unreachable("unknown register size");
807   }
808 }
809 
810 void SIInstrInfo::storeRegToStackSlot(MachineBasicBlock &MBB,
811                                       MachineBasicBlock::iterator MI,
812                                       unsigned SrcReg, bool isKill,
813                                       int FrameIndex,
814                                       const TargetRegisterClass *RC,
815                                       const TargetRegisterInfo *TRI) const {
816   MachineFunction *MF = MBB.getParent();
817   SIMachineFunctionInfo *MFI = MF->getInfo<SIMachineFunctionInfo>();
818   MachineFrameInfo &FrameInfo = MF->getFrameInfo();
819   DebugLoc DL = MBB.findDebugLoc(MI);
820 
821   assert(SrcReg != MFI->getStackPtrOffsetReg() &&
822          SrcReg != MFI->getFrameOffsetReg() &&
823          SrcReg != MFI->getScratchWaveOffsetReg());
824 
825   unsigned Size = FrameInfo.getObjectSize(FrameIndex);
826   unsigned Align = FrameInfo.getObjectAlignment(FrameIndex);
827   MachinePointerInfo PtrInfo
828     = MachinePointerInfo::getFixedStack(*MF, FrameIndex);
829   MachineMemOperand *MMO
830     = MF->getMachineMemOperand(PtrInfo, MachineMemOperand::MOStore,
831                                Size, Align);
832   unsigned SpillSize = TRI->getSpillSize(*RC);
833 
834   if (RI.isSGPRClass(RC)) {
835     MFI->setHasSpilledSGPRs();
836 
837     // We are only allowed to create one new instruction when spilling
838     // registers, so we need to use pseudo instruction for spilling SGPRs.
839     const MCInstrDesc &OpDesc = get(getSGPRSpillSaveOpcode(SpillSize));
840 
841     // The SGPR spill/restore instructions only work on number sgprs, so we need
842     // to make sure we are using the correct register class.
843     if (TargetRegisterInfo::isVirtualRegister(SrcReg) && SpillSize == 4) {
844       MachineRegisterInfo &MRI = MF->getRegInfo();
845       MRI.constrainRegClass(SrcReg, &AMDGPU::SReg_32_XM0RegClass);
846     }
847 
848     MachineInstrBuilder Spill = BuildMI(MBB, MI, DL, OpDesc)
849       .addReg(SrcReg, getKillRegState(isKill)) // data
850       .addFrameIndex(FrameIndex)               // addr
851       .addMemOperand(MMO)
852       .addReg(MFI->getScratchRSrcReg(), RegState::Implicit)
853       .addReg(MFI->getFrameOffsetReg(), RegState::Implicit);
854     // Add the scratch resource registers as implicit uses because we may end up
855     // needing them, and need to ensure that the reserved registers are
856     // correctly handled.
857 
858     FrameInfo.setStackID(FrameIndex, 1);
859     if (ST.hasScalarStores()) {
860       // m0 is used for offset to scalar stores if used to spill.
861       Spill.addReg(AMDGPU::M0, RegState::ImplicitDefine | RegState::Dead);
862     }
863 
864     return;
865   }
866 
867   if (!ST.isVGPRSpillingEnabled(*MF->getFunction())) {
868     LLVMContext &Ctx = MF->getFunction()->getContext();
869     Ctx.emitError("SIInstrInfo::storeRegToStackSlot - Do not know how to"
870                   " spill register");
871     BuildMI(MBB, MI, DL, get(AMDGPU::KILL))
872       .addReg(SrcReg);
873 
874     return;
875   }
876 
877   assert(RI.hasVGPRs(RC) && "Only VGPR spilling expected");
878 
879   unsigned Opcode = getVGPRSpillSaveOpcode(SpillSize);
880   MFI->setHasSpilledVGPRs();
881   BuildMI(MBB, MI, DL, get(Opcode))
882     .addReg(SrcReg, getKillRegState(isKill)) // data
883     .addFrameIndex(FrameIndex)               // addr
884     .addReg(MFI->getScratchRSrcReg())        // scratch_rsrc
885     .addReg(MFI->getFrameOffsetReg())        // scratch_offset
886     .addImm(0)                               // offset
887     .addMemOperand(MMO);
888 }
889 
890 static unsigned getSGPRSpillRestoreOpcode(unsigned Size) {
891   switch (Size) {
892   case 4:
893     return AMDGPU::SI_SPILL_S32_RESTORE;
894   case 8:
895     return AMDGPU::SI_SPILL_S64_RESTORE;
896   case 16:
897     return AMDGPU::SI_SPILL_S128_RESTORE;
898   case 32:
899     return AMDGPU::SI_SPILL_S256_RESTORE;
900   case 64:
901     return AMDGPU::SI_SPILL_S512_RESTORE;
902   default:
903     llvm_unreachable("unknown register size");
904   }
905 }
906 
907 static unsigned getVGPRSpillRestoreOpcode(unsigned Size) {
908   switch (Size) {
909   case 4:
910     return AMDGPU::SI_SPILL_V32_RESTORE;
911   case 8:
912     return AMDGPU::SI_SPILL_V64_RESTORE;
913   case 12:
914     return AMDGPU::SI_SPILL_V96_RESTORE;
915   case 16:
916     return AMDGPU::SI_SPILL_V128_RESTORE;
917   case 32:
918     return AMDGPU::SI_SPILL_V256_RESTORE;
919   case 64:
920     return AMDGPU::SI_SPILL_V512_RESTORE;
921   default:
922     llvm_unreachable("unknown register size");
923   }
924 }
925 
926 void SIInstrInfo::loadRegFromStackSlot(MachineBasicBlock &MBB,
927                                        MachineBasicBlock::iterator MI,
928                                        unsigned DestReg, int FrameIndex,
929                                        const TargetRegisterClass *RC,
930                                        const TargetRegisterInfo *TRI) const {
931   MachineFunction *MF = MBB.getParent();
932   const SIMachineFunctionInfo *MFI = MF->getInfo<SIMachineFunctionInfo>();
933   MachineFrameInfo &FrameInfo = MF->getFrameInfo();
934   DebugLoc DL = MBB.findDebugLoc(MI);
935   unsigned Align = FrameInfo.getObjectAlignment(FrameIndex);
936   unsigned Size = FrameInfo.getObjectSize(FrameIndex);
937   unsigned SpillSize = TRI->getSpillSize(*RC);
938 
939   MachinePointerInfo PtrInfo
940     = MachinePointerInfo::getFixedStack(*MF, FrameIndex);
941 
942   MachineMemOperand *MMO = MF->getMachineMemOperand(
943     PtrInfo, MachineMemOperand::MOLoad, Size, Align);
944 
945   if (RI.isSGPRClass(RC)) {
946     // FIXME: Maybe this should not include a memoperand because it will be
947     // lowered to non-memory instructions.
948     const MCInstrDesc &OpDesc = get(getSGPRSpillRestoreOpcode(SpillSize));
949     if (TargetRegisterInfo::isVirtualRegister(DestReg) && SpillSize == 4) {
950       MachineRegisterInfo &MRI = MF->getRegInfo();
951       MRI.constrainRegClass(DestReg, &AMDGPU::SReg_32_XM0RegClass);
952     }
953 
954     FrameInfo.setStackID(FrameIndex, 1);
955     MachineInstrBuilder Spill = BuildMI(MBB, MI, DL, OpDesc, DestReg)
956       .addFrameIndex(FrameIndex) // addr
957       .addMemOperand(MMO)
958       .addReg(MFI->getScratchRSrcReg(), RegState::Implicit)
959       .addReg(MFI->getFrameOffsetReg(), RegState::Implicit);
960 
961     if (ST.hasScalarStores()) {
962       // m0 is used for offset to scalar stores if used to spill.
963       Spill.addReg(AMDGPU::M0, RegState::ImplicitDefine | RegState::Dead);
964     }
965 
966     return;
967   }
968 
969   if (!ST.isVGPRSpillingEnabled(*MF->getFunction())) {
970     LLVMContext &Ctx = MF->getFunction()->getContext();
971     Ctx.emitError("SIInstrInfo::loadRegFromStackSlot - Do not know how to"
972                   " restore register");
973     BuildMI(MBB, MI, DL, get(AMDGPU::IMPLICIT_DEF), DestReg);
974 
975     return;
976   }
977 
978   assert(RI.hasVGPRs(RC) && "Only VGPR spilling expected");
979 
980   unsigned Opcode = getVGPRSpillRestoreOpcode(SpillSize);
981   BuildMI(MBB, MI, DL, get(Opcode), DestReg)
982     .addFrameIndex(FrameIndex)        // vaddr
983     .addReg(MFI->getScratchRSrcReg()) // scratch_rsrc
984     .addReg(MFI->getFrameOffsetReg()) // scratch_offset
985     .addImm(0)                        // offset
986     .addMemOperand(MMO);
987 }
988 
989 /// \param @Offset Offset in bytes of the FrameIndex being spilled
990 unsigned SIInstrInfo::calculateLDSSpillAddress(
991     MachineBasicBlock &MBB, MachineInstr &MI, RegScavenger *RS, unsigned TmpReg,
992     unsigned FrameOffset, unsigned Size) const {
993   MachineFunction *MF = MBB.getParent();
994   SIMachineFunctionInfo *MFI = MF->getInfo<SIMachineFunctionInfo>();
995   const SISubtarget &ST = MF->getSubtarget<SISubtarget>();
996   DebugLoc DL = MBB.findDebugLoc(MI);
997   unsigned WorkGroupSize = MFI->getMaxFlatWorkGroupSize();
998   unsigned WavefrontSize = ST.getWavefrontSize();
999 
1000   unsigned TIDReg = MFI->getTIDReg();
1001   if (!MFI->hasCalculatedTID()) {
1002     MachineBasicBlock &Entry = MBB.getParent()->front();
1003     MachineBasicBlock::iterator Insert = Entry.front();
1004     DebugLoc DL = Insert->getDebugLoc();
1005 
1006     TIDReg = RI.findUnusedRegister(MF->getRegInfo(), &AMDGPU::VGPR_32RegClass,
1007                                    *MF);
1008     if (TIDReg == AMDGPU::NoRegister)
1009       return TIDReg;
1010 
1011     if (!AMDGPU::isShader(MF->getFunction()->getCallingConv()) &&
1012         WorkGroupSize > WavefrontSize) {
1013       unsigned TIDIGXReg
1014         = MFI->getPreloadedReg(AMDGPUFunctionArgInfo::WORKGROUP_ID_X);
1015       unsigned TIDIGYReg
1016         = MFI->getPreloadedReg(AMDGPUFunctionArgInfo::WORKGROUP_ID_Y);
1017       unsigned TIDIGZReg
1018         = MFI->getPreloadedReg(AMDGPUFunctionArgInfo::WORKGROUP_ID_Z);
1019       unsigned InputPtrReg =
1020           MFI->getPreloadedReg(AMDGPUFunctionArgInfo::KERNARG_SEGMENT_PTR);
1021       for (unsigned Reg : {TIDIGXReg, TIDIGYReg, TIDIGZReg}) {
1022         if (!Entry.isLiveIn(Reg))
1023           Entry.addLiveIn(Reg);
1024       }
1025 
1026       RS->enterBasicBlock(Entry);
1027       // FIXME: Can we scavenge an SReg_64 and access the subregs?
1028       unsigned STmp0 = RS->scavengeRegister(&AMDGPU::SGPR_32RegClass, 0);
1029       unsigned STmp1 = RS->scavengeRegister(&AMDGPU::SGPR_32RegClass, 0);
1030       BuildMI(Entry, Insert, DL, get(AMDGPU::S_LOAD_DWORD_IMM), STmp0)
1031               .addReg(InputPtrReg)
1032               .addImm(SI::KernelInputOffsets::NGROUPS_Z);
1033       BuildMI(Entry, Insert, DL, get(AMDGPU::S_LOAD_DWORD_IMM), STmp1)
1034               .addReg(InputPtrReg)
1035               .addImm(SI::KernelInputOffsets::NGROUPS_Y);
1036 
1037       // NGROUPS.X * NGROUPS.Y
1038       BuildMI(Entry, Insert, DL, get(AMDGPU::S_MUL_I32), STmp1)
1039               .addReg(STmp1)
1040               .addReg(STmp0);
1041       // (NGROUPS.X * NGROUPS.Y) * TIDIG.X
1042       BuildMI(Entry, Insert, DL, get(AMDGPU::V_MUL_U32_U24_e32), TIDReg)
1043               .addReg(STmp1)
1044               .addReg(TIDIGXReg);
1045       // NGROUPS.Z * TIDIG.Y + (NGROUPS.X * NGROPUS.Y * TIDIG.X)
1046       BuildMI(Entry, Insert, DL, get(AMDGPU::V_MAD_U32_U24), TIDReg)
1047               .addReg(STmp0)
1048               .addReg(TIDIGYReg)
1049               .addReg(TIDReg);
1050       // (NGROUPS.Z * TIDIG.Y + (NGROUPS.X * NGROPUS.Y * TIDIG.X)) + TIDIG.Z
1051       BuildMI(Entry, Insert, DL, get(AMDGPU::V_ADD_I32_e32), TIDReg)
1052               .addReg(TIDReg)
1053               .addReg(TIDIGZReg);
1054     } else {
1055       // Get the wave id
1056       BuildMI(Entry, Insert, DL, get(AMDGPU::V_MBCNT_LO_U32_B32_e64),
1057               TIDReg)
1058               .addImm(-1)
1059               .addImm(0);
1060 
1061       BuildMI(Entry, Insert, DL, get(AMDGPU::V_MBCNT_HI_U32_B32_e64),
1062               TIDReg)
1063               .addImm(-1)
1064               .addReg(TIDReg);
1065     }
1066 
1067     BuildMI(Entry, Insert, DL, get(AMDGPU::V_LSHLREV_B32_e32),
1068             TIDReg)
1069             .addImm(2)
1070             .addReg(TIDReg);
1071     MFI->setTIDReg(TIDReg);
1072   }
1073 
1074   // Add FrameIndex to LDS offset
1075   unsigned LDSOffset = MFI->getLDSSize() + (FrameOffset * WorkGroupSize);
1076   BuildMI(MBB, MI, DL, get(AMDGPU::V_ADD_I32_e32), TmpReg)
1077           .addImm(LDSOffset)
1078           .addReg(TIDReg);
1079 
1080   return TmpReg;
1081 }
1082 
1083 void SIInstrInfo::insertWaitStates(MachineBasicBlock &MBB,
1084                                    MachineBasicBlock::iterator MI,
1085                                    int Count) const {
1086   DebugLoc DL = MBB.findDebugLoc(MI);
1087   while (Count > 0) {
1088     int Arg;
1089     if (Count >= 8)
1090       Arg = 7;
1091     else
1092       Arg = Count - 1;
1093     Count -= 8;
1094     BuildMI(MBB, MI, DL, get(AMDGPU::S_NOP))
1095             .addImm(Arg);
1096   }
1097 }
1098 
1099 void SIInstrInfo::insertNoop(MachineBasicBlock &MBB,
1100                              MachineBasicBlock::iterator MI) const {
1101   insertWaitStates(MBB, MI, 1);
1102 }
1103 
1104 void SIInstrInfo::insertReturn(MachineBasicBlock &MBB) const {
1105   auto MF = MBB.getParent();
1106   SIMachineFunctionInfo *Info = MF->getInfo<SIMachineFunctionInfo>();
1107 
1108   assert(Info->isEntryFunction());
1109 
1110   if (MBB.succ_empty()) {
1111     bool HasNoTerminator = MBB.getFirstTerminator() == MBB.end();
1112     if (HasNoTerminator)
1113       BuildMI(MBB, MBB.end(), DebugLoc(),
1114               get(Info->returnsVoid() ? AMDGPU::S_ENDPGM : AMDGPU::SI_RETURN_TO_EPILOG));
1115   }
1116 }
1117 
1118 unsigned SIInstrInfo::getNumWaitStates(const MachineInstr &MI) const {
1119   switch (MI.getOpcode()) {
1120   default: return 1; // FIXME: Do wait states equal cycles?
1121 
1122   case AMDGPU::S_NOP:
1123     return MI.getOperand(0).getImm() + 1;
1124   }
1125 }
1126 
1127 bool SIInstrInfo::expandPostRAPseudo(MachineInstr &MI) const {
1128   MachineBasicBlock &MBB = *MI.getParent();
1129   DebugLoc DL = MBB.findDebugLoc(MI);
1130   switch (MI.getOpcode()) {
1131   default: return AMDGPUInstrInfo::expandPostRAPseudo(MI);
1132   case AMDGPU::S_MOV_B64_term:
1133     // This is only a terminator to get the correct spill code placement during
1134     // register allocation.
1135     MI.setDesc(get(AMDGPU::S_MOV_B64));
1136     break;
1137 
1138   case AMDGPU::S_XOR_B64_term:
1139     // This is only a terminator to get the correct spill code placement during
1140     // register allocation.
1141     MI.setDesc(get(AMDGPU::S_XOR_B64));
1142     break;
1143 
1144   case AMDGPU::S_ANDN2_B64_term:
1145     // This is only a terminator to get the correct spill code placement during
1146     // register allocation.
1147     MI.setDesc(get(AMDGPU::S_ANDN2_B64));
1148     break;
1149 
1150   case AMDGPU::V_MOV_B64_PSEUDO: {
1151     unsigned Dst = MI.getOperand(0).getReg();
1152     unsigned DstLo = RI.getSubReg(Dst, AMDGPU::sub0);
1153     unsigned DstHi = RI.getSubReg(Dst, AMDGPU::sub1);
1154 
1155     const MachineOperand &SrcOp = MI.getOperand(1);
1156     // FIXME: Will this work for 64-bit floating point immediates?
1157     assert(!SrcOp.isFPImm());
1158     if (SrcOp.isImm()) {
1159       APInt Imm(64, SrcOp.getImm());
1160       BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B32_e32), DstLo)
1161         .addImm(Imm.getLoBits(32).getZExtValue())
1162         .addReg(Dst, RegState::Implicit | RegState::Define);
1163       BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B32_e32), DstHi)
1164         .addImm(Imm.getHiBits(32).getZExtValue())
1165         .addReg(Dst, RegState::Implicit | RegState::Define);
1166     } else {
1167       assert(SrcOp.isReg());
1168       BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B32_e32), DstLo)
1169         .addReg(RI.getSubReg(SrcOp.getReg(), AMDGPU::sub0))
1170         .addReg(Dst, RegState::Implicit | RegState::Define);
1171       BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B32_e32), DstHi)
1172         .addReg(RI.getSubReg(SrcOp.getReg(), AMDGPU::sub1))
1173         .addReg(Dst, RegState::Implicit | RegState::Define);
1174     }
1175     MI.eraseFromParent();
1176     break;
1177   }
1178   case AMDGPU::V_SET_INACTIVE_B32: {
1179     BuildMI(MBB, MI, DL, get(AMDGPU::S_NOT_B64), AMDGPU::EXEC)
1180       .addReg(AMDGPU::EXEC);
1181     BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B32_e32), MI.getOperand(0).getReg())
1182       .add(MI.getOperand(2));
1183     BuildMI(MBB, MI, DL, get(AMDGPU::S_NOT_B64), AMDGPU::EXEC)
1184       .addReg(AMDGPU::EXEC);
1185     MI.eraseFromParent();
1186     break;
1187   }
1188   case AMDGPU::V_SET_INACTIVE_B64: {
1189     BuildMI(MBB, MI, DL, get(AMDGPU::S_NOT_B64), AMDGPU::EXEC)
1190       .addReg(AMDGPU::EXEC);
1191     MachineInstr *Copy = BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B64_PSEUDO),
1192                                  MI.getOperand(0).getReg())
1193       .add(MI.getOperand(2));
1194     expandPostRAPseudo(*Copy);
1195     BuildMI(MBB, MI, DL, get(AMDGPU::S_NOT_B64), AMDGPU::EXEC)
1196       .addReg(AMDGPU::EXEC);
1197     MI.eraseFromParent();
1198     break;
1199   }
1200   case AMDGPU::V_MOVRELD_B32_V1:
1201   case AMDGPU::V_MOVRELD_B32_V2:
1202   case AMDGPU::V_MOVRELD_B32_V4:
1203   case AMDGPU::V_MOVRELD_B32_V8:
1204   case AMDGPU::V_MOVRELD_B32_V16: {
1205     const MCInstrDesc &MovRelDesc = get(AMDGPU::V_MOVRELD_B32_e32);
1206     unsigned VecReg = MI.getOperand(0).getReg();
1207     bool IsUndef = MI.getOperand(1).isUndef();
1208     unsigned SubReg = AMDGPU::sub0 + MI.getOperand(3).getImm();
1209     assert(VecReg == MI.getOperand(1).getReg());
1210 
1211     MachineInstr *MovRel =
1212         BuildMI(MBB, MI, DL, MovRelDesc)
1213             .addReg(RI.getSubReg(VecReg, SubReg), RegState::Undef)
1214             .add(MI.getOperand(2))
1215             .addReg(VecReg, RegState::ImplicitDefine)
1216             .addReg(VecReg,
1217                     RegState::Implicit | (IsUndef ? RegState::Undef : 0));
1218 
1219     const int ImpDefIdx =
1220         MovRelDesc.getNumOperands() + MovRelDesc.getNumImplicitUses();
1221     const int ImpUseIdx = ImpDefIdx + 1;
1222     MovRel->tieOperands(ImpDefIdx, ImpUseIdx);
1223 
1224     MI.eraseFromParent();
1225     break;
1226   }
1227   case AMDGPU::SI_PC_ADD_REL_OFFSET: {
1228     MachineFunction &MF = *MBB.getParent();
1229     unsigned Reg = MI.getOperand(0).getReg();
1230     unsigned RegLo = RI.getSubReg(Reg, AMDGPU::sub0);
1231     unsigned RegHi = RI.getSubReg(Reg, AMDGPU::sub1);
1232 
1233     // Create a bundle so these instructions won't be re-ordered by the
1234     // post-RA scheduler.
1235     MIBundleBuilder Bundler(MBB, MI);
1236     Bundler.append(BuildMI(MF, DL, get(AMDGPU::S_GETPC_B64), Reg));
1237 
1238     // Add 32-bit offset from this instruction to the start of the
1239     // constant data.
1240     Bundler.append(BuildMI(MF, DL, get(AMDGPU::S_ADD_U32), RegLo)
1241                        .addReg(RegLo)
1242                        .add(MI.getOperand(1)));
1243 
1244     MachineInstrBuilder MIB = BuildMI(MF, DL, get(AMDGPU::S_ADDC_U32), RegHi)
1245                                   .addReg(RegHi);
1246     if (MI.getOperand(2).getTargetFlags() == SIInstrInfo::MO_NONE)
1247       MIB.addImm(0);
1248     else
1249       MIB.add(MI.getOperand(2));
1250 
1251     Bundler.append(MIB);
1252     finalizeBundle(MBB, Bundler.begin());
1253 
1254     MI.eraseFromParent();
1255     break;
1256   }
1257   case AMDGPU::EXIT_WWM: {
1258     // This only gets its own opcode so that SIFixWWMLiveness can tell when WWM
1259     // is exited.
1260     MI.setDesc(get(AMDGPU::S_MOV_B64));
1261     break;
1262   }
1263   }
1264   return true;
1265 }
1266 
1267 bool SIInstrInfo::swapSourceModifiers(MachineInstr &MI,
1268                                       MachineOperand &Src0,
1269                                       unsigned Src0OpName,
1270                                       MachineOperand &Src1,
1271                                       unsigned Src1OpName) const {
1272   MachineOperand *Src0Mods = getNamedOperand(MI, Src0OpName);
1273   if (!Src0Mods)
1274     return false;
1275 
1276   MachineOperand *Src1Mods = getNamedOperand(MI, Src1OpName);
1277   assert(Src1Mods &&
1278          "All commutable instructions have both src0 and src1 modifiers");
1279 
1280   int Src0ModsVal = Src0Mods->getImm();
1281   int Src1ModsVal = Src1Mods->getImm();
1282 
1283   Src1Mods->setImm(Src0ModsVal);
1284   Src0Mods->setImm(Src1ModsVal);
1285   return true;
1286 }
1287 
1288 static MachineInstr *swapRegAndNonRegOperand(MachineInstr &MI,
1289                                              MachineOperand &RegOp,
1290                                              MachineOperand &NonRegOp) {
1291   unsigned Reg = RegOp.getReg();
1292   unsigned SubReg = RegOp.getSubReg();
1293   bool IsKill = RegOp.isKill();
1294   bool IsDead = RegOp.isDead();
1295   bool IsUndef = RegOp.isUndef();
1296   bool IsDebug = RegOp.isDebug();
1297 
1298   if (NonRegOp.isImm())
1299     RegOp.ChangeToImmediate(NonRegOp.getImm());
1300   else if (NonRegOp.isFI())
1301     RegOp.ChangeToFrameIndex(NonRegOp.getIndex());
1302   else
1303     return nullptr;
1304 
1305   NonRegOp.ChangeToRegister(Reg, false, false, IsKill, IsDead, IsUndef, IsDebug);
1306   NonRegOp.setSubReg(SubReg);
1307 
1308   return &MI;
1309 }
1310 
1311 MachineInstr *SIInstrInfo::commuteInstructionImpl(MachineInstr &MI, bool NewMI,
1312                                                   unsigned Src0Idx,
1313                                                   unsigned Src1Idx) const {
1314   assert(!NewMI && "this should never be used");
1315 
1316   unsigned Opc = MI.getOpcode();
1317   int CommutedOpcode = commuteOpcode(Opc);
1318   if (CommutedOpcode == -1)
1319     return nullptr;
1320 
1321   assert(AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0) ==
1322            static_cast<int>(Src0Idx) &&
1323          AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1) ==
1324            static_cast<int>(Src1Idx) &&
1325          "inconsistency with findCommutedOpIndices");
1326 
1327   MachineOperand &Src0 = MI.getOperand(Src0Idx);
1328   MachineOperand &Src1 = MI.getOperand(Src1Idx);
1329 
1330   MachineInstr *CommutedMI = nullptr;
1331   if (Src0.isReg() && Src1.isReg()) {
1332     if (isOperandLegal(MI, Src1Idx, &Src0)) {
1333       // Be sure to copy the source modifiers to the right place.
1334       CommutedMI
1335         = TargetInstrInfo::commuteInstructionImpl(MI, NewMI, Src0Idx, Src1Idx);
1336     }
1337 
1338   } else if (Src0.isReg() && !Src1.isReg()) {
1339     // src0 should always be able to support any operand type, so no need to
1340     // check operand legality.
1341     CommutedMI = swapRegAndNonRegOperand(MI, Src0, Src1);
1342   } else if (!Src0.isReg() && Src1.isReg()) {
1343     if (isOperandLegal(MI, Src1Idx, &Src0))
1344       CommutedMI = swapRegAndNonRegOperand(MI, Src1, Src0);
1345   } else {
1346     // FIXME: Found two non registers to commute. This does happen.
1347     return nullptr;
1348   }
1349 
1350   if (CommutedMI) {
1351     swapSourceModifiers(MI, Src0, AMDGPU::OpName::src0_modifiers,
1352                         Src1, AMDGPU::OpName::src1_modifiers);
1353 
1354     CommutedMI->setDesc(get(CommutedOpcode));
1355   }
1356 
1357   return CommutedMI;
1358 }
1359 
1360 // This needs to be implemented because the source modifiers may be inserted
1361 // between the true commutable operands, and the base
1362 // TargetInstrInfo::commuteInstruction uses it.
1363 bool SIInstrInfo::findCommutedOpIndices(MachineInstr &MI, unsigned &SrcOpIdx0,
1364                                         unsigned &SrcOpIdx1) const {
1365   if (!MI.isCommutable())
1366     return false;
1367 
1368   unsigned Opc = MI.getOpcode();
1369   int Src0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0);
1370   if (Src0Idx == -1)
1371     return false;
1372 
1373   int Src1Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1);
1374   if (Src1Idx == -1)
1375     return false;
1376 
1377   return fixCommutedOpIndices(SrcOpIdx0, SrcOpIdx1, Src0Idx, Src1Idx);
1378 }
1379 
1380 bool SIInstrInfo::isBranchOffsetInRange(unsigned BranchOp,
1381                                         int64_t BrOffset) const {
1382   // BranchRelaxation should never have to check s_setpc_b64 because its dest
1383   // block is unanalyzable.
1384   assert(BranchOp != AMDGPU::S_SETPC_B64);
1385 
1386   // Convert to dwords.
1387   BrOffset /= 4;
1388 
1389   // The branch instructions do PC += signext(SIMM16 * 4) + 4, so the offset is
1390   // from the next instruction.
1391   BrOffset -= 1;
1392 
1393   return isIntN(BranchOffsetBits, BrOffset);
1394 }
1395 
1396 MachineBasicBlock *SIInstrInfo::getBranchDestBlock(
1397   const MachineInstr &MI) const {
1398   if (MI.getOpcode() == AMDGPU::S_SETPC_B64) {
1399     // This would be a difficult analysis to perform, but can always be legal so
1400     // there's no need to analyze it.
1401     return nullptr;
1402   }
1403 
1404   return MI.getOperand(0).getMBB();
1405 }
1406 
1407 unsigned SIInstrInfo::insertIndirectBranch(MachineBasicBlock &MBB,
1408                                            MachineBasicBlock &DestBB,
1409                                            const DebugLoc &DL,
1410                                            int64_t BrOffset,
1411                                            RegScavenger *RS) const {
1412   assert(RS && "RegScavenger required for long branching");
1413   assert(MBB.empty() &&
1414          "new block should be inserted for expanding unconditional branch");
1415   assert(MBB.pred_size() == 1);
1416 
1417   MachineFunction *MF = MBB.getParent();
1418   MachineRegisterInfo &MRI = MF->getRegInfo();
1419 
1420   // FIXME: Virtual register workaround for RegScavenger not working with empty
1421   // blocks.
1422   unsigned PCReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
1423 
1424   auto I = MBB.end();
1425 
1426   // We need to compute the offset relative to the instruction immediately after
1427   // s_getpc_b64. Insert pc arithmetic code before last terminator.
1428   MachineInstr *GetPC = BuildMI(MBB, I, DL, get(AMDGPU::S_GETPC_B64), PCReg);
1429 
1430   // TODO: Handle > 32-bit block address.
1431   if (BrOffset >= 0) {
1432     BuildMI(MBB, I, DL, get(AMDGPU::S_ADD_U32))
1433       .addReg(PCReg, RegState::Define, AMDGPU::sub0)
1434       .addReg(PCReg, 0, AMDGPU::sub0)
1435       .addMBB(&DestBB, AMDGPU::TF_LONG_BRANCH_FORWARD);
1436     BuildMI(MBB, I, DL, get(AMDGPU::S_ADDC_U32))
1437       .addReg(PCReg, RegState::Define, AMDGPU::sub1)
1438       .addReg(PCReg, 0, AMDGPU::sub1)
1439       .addImm(0);
1440   } else {
1441     // Backwards branch.
1442     BuildMI(MBB, I, DL, get(AMDGPU::S_SUB_U32))
1443       .addReg(PCReg, RegState::Define, AMDGPU::sub0)
1444       .addReg(PCReg, 0, AMDGPU::sub0)
1445       .addMBB(&DestBB, AMDGPU::TF_LONG_BRANCH_BACKWARD);
1446     BuildMI(MBB, I, DL, get(AMDGPU::S_SUBB_U32))
1447       .addReg(PCReg, RegState::Define, AMDGPU::sub1)
1448       .addReg(PCReg, 0, AMDGPU::sub1)
1449       .addImm(0);
1450   }
1451 
1452   // Insert the indirect branch after the other terminator.
1453   BuildMI(&MBB, DL, get(AMDGPU::S_SETPC_B64))
1454     .addReg(PCReg);
1455 
1456   // FIXME: If spilling is necessary, this will fail because this scavenger has
1457   // no emergency stack slots. It is non-trivial to spill in this situation,
1458   // because the restore code needs to be specially placed after the
1459   // jump. BranchRelaxation then needs to be made aware of the newly inserted
1460   // block.
1461   //
1462   // If a spill is needed for the pc register pair, we need to insert a spill
1463   // restore block right before the destination block, and insert a short branch
1464   // into the old destination block's fallthrough predecessor.
1465   // e.g.:
1466   //
1467   // s_cbranch_scc0 skip_long_branch:
1468   //
1469   // long_branch_bb:
1470   //   spill s[8:9]
1471   //   s_getpc_b64 s[8:9]
1472   //   s_add_u32 s8, s8, restore_bb
1473   //   s_addc_u32 s9, s9, 0
1474   //   s_setpc_b64 s[8:9]
1475   //
1476   // skip_long_branch:
1477   //   foo;
1478   //
1479   // .....
1480   //
1481   // dest_bb_fallthrough_predecessor:
1482   // bar;
1483   // s_branch dest_bb
1484   //
1485   // restore_bb:
1486   //  restore s[8:9]
1487   //  fallthrough dest_bb
1488   ///
1489   // dest_bb:
1490   //   buzz;
1491 
1492   RS->enterBasicBlockEnd(MBB);
1493   unsigned Scav = RS->scavengeRegister(&AMDGPU::SReg_64RegClass,
1494                                        MachineBasicBlock::iterator(GetPC), 0);
1495   MRI.replaceRegWith(PCReg, Scav);
1496   MRI.clearVirtRegs();
1497   RS->setRegUsed(Scav);
1498 
1499   return 4 + 8 + 4 + 4;
1500 }
1501 
1502 unsigned SIInstrInfo::getBranchOpcode(SIInstrInfo::BranchPredicate Cond) {
1503   switch (Cond) {
1504   case SIInstrInfo::SCC_TRUE:
1505     return AMDGPU::S_CBRANCH_SCC1;
1506   case SIInstrInfo::SCC_FALSE:
1507     return AMDGPU::S_CBRANCH_SCC0;
1508   case SIInstrInfo::VCCNZ:
1509     return AMDGPU::S_CBRANCH_VCCNZ;
1510   case SIInstrInfo::VCCZ:
1511     return AMDGPU::S_CBRANCH_VCCZ;
1512   case SIInstrInfo::EXECNZ:
1513     return AMDGPU::S_CBRANCH_EXECNZ;
1514   case SIInstrInfo::EXECZ:
1515     return AMDGPU::S_CBRANCH_EXECZ;
1516   default:
1517     llvm_unreachable("invalid branch predicate");
1518   }
1519 }
1520 
1521 SIInstrInfo::BranchPredicate SIInstrInfo::getBranchPredicate(unsigned Opcode) {
1522   switch (Opcode) {
1523   case AMDGPU::S_CBRANCH_SCC0:
1524     return SCC_FALSE;
1525   case AMDGPU::S_CBRANCH_SCC1:
1526     return SCC_TRUE;
1527   case AMDGPU::S_CBRANCH_VCCNZ:
1528     return VCCNZ;
1529   case AMDGPU::S_CBRANCH_VCCZ:
1530     return VCCZ;
1531   case AMDGPU::S_CBRANCH_EXECNZ:
1532     return EXECNZ;
1533   case AMDGPU::S_CBRANCH_EXECZ:
1534     return EXECZ;
1535   default:
1536     return INVALID_BR;
1537   }
1538 }
1539 
1540 bool SIInstrInfo::analyzeBranchImpl(MachineBasicBlock &MBB,
1541                                     MachineBasicBlock::iterator I,
1542                                     MachineBasicBlock *&TBB,
1543                                     MachineBasicBlock *&FBB,
1544                                     SmallVectorImpl<MachineOperand> &Cond,
1545                                     bool AllowModify) const {
1546   if (I->getOpcode() == AMDGPU::S_BRANCH) {
1547     // Unconditional Branch
1548     TBB = I->getOperand(0).getMBB();
1549     return false;
1550   }
1551 
1552   MachineBasicBlock *CondBB = nullptr;
1553 
1554   if (I->getOpcode() == AMDGPU::SI_NON_UNIFORM_BRCOND_PSEUDO) {
1555     CondBB = I->getOperand(1).getMBB();
1556     Cond.push_back(I->getOperand(0));
1557   } else {
1558     BranchPredicate Pred = getBranchPredicate(I->getOpcode());
1559     if (Pred == INVALID_BR)
1560       return true;
1561 
1562     CondBB = I->getOperand(0).getMBB();
1563     Cond.push_back(MachineOperand::CreateImm(Pred));
1564     Cond.push_back(I->getOperand(1)); // Save the branch register.
1565   }
1566   ++I;
1567 
1568   if (I == MBB.end()) {
1569     // Conditional branch followed by fall-through.
1570     TBB = CondBB;
1571     return false;
1572   }
1573 
1574   if (I->getOpcode() == AMDGPU::S_BRANCH) {
1575     TBB = CondBB;
1576     FBB = I->getOperand(0).getMBB();
1577     return false;
1578   }
1579 
1580   return true;
1581 }
1582 
1583 bool SIInstrInfo::analyzeBranch(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
1584                                 MachineBasicBlock *&FBB,
1585                                 SmallVectorImpl<MachineOperand> &Cond,
1586                                 bool AllowModify) const {
1587   MachineBasicBlock::iterator I = MBB.getFirstTerminator();
1588   if (I == MBB.end())
1589     return false;
1590 
1591   if (I->getOpcode() != AMDGPU::SI_MASK_BRANCH)
1592     return analyzeBranchImpl(MBB, I, TBB, FBB, Cond, AllowModify);
1593 
1594   ++I;
1595 
1596   // TODO: Should be able to treat as fallthrough?
1597   if (I == MBB.end())
1598     return true;
1599 
1600   if (analyzeBranchImpl(MBB, I, TBB, FBB, Cond, AllowModify))
1601     return true;
1602 
1603   MachineBasicBlock *MaskBrDest = I->getOperand(0).getMBB();
1604 
1605   // Specifically handle the case where the conditional branch is to the same
1606   // destination as the mask branch. e.g.
1607   //
1608   // si_mask_branch BB8
1609   // s_cbranch_execz BB8
1610   // s_cbranch BB9
1611   //
1612   // This is required to understand divergent loops which may need the branches
1613   // to be relaxed.
1614   if (TBB != MaskBrDest || Cond.empty())
1615     return true;
1616 
1617   auto Pred = Cond[0].getImm();
1618   return (Pred != EXECZ && Pred != EXECNZ);
1619 }
1620 
1621 unsigned SIInstrInfo::removeBranch(MachineBasicBlock &MBB,
1622                                    int *BytesRemoved) const {
1623   MachineBasicBlock::iterator I = MBB.getFirstTerminator();
1624 
1625   unsigned Count = 0;
1626   unsigned RemovedSize = 0;
1627   while (I != MBB.end()) {
1628     MachineBasicBlock::iterator Next = std::next(I);
1629     if (I->getOpcode() == AMDGPU::SI_MASK_BRANCH) {
1630       I = Next;
1631       continue;
1632     }
1633 
1634     RemovedSize += getInstSizeInBytes(*I);
1635     I->eraseFromParent();
1636     ++Count;
1637     I = Next;
1638   }
1639 
1640   if (BytesRemoved)
1641     *BytesRemoved = RemovedSize;
1642 
1643   return Count;
1644 }
1645 
1646 // Copy the flags onto the implicit condition register operand.
1647 static void preserveCondRegFlags(MachineOperand &CondReg,
1648                                  const MachineOperand &OrigCond) {
1649   CondReg.setIsUndef(OrigCond.isUndef());
1650   CondReg.setIsKill(OrigCond.isKill());
1651 }
1652 
1653 unsigned SIInstrInfo::insertBranch(MachineBasicBlock &MBB,
1654                                    MachineBasicBlock *TBB,
1655                                    MachineBasicBlock *FBB,
1656                                    ArrayRef<MachineOperand> Cond,
1657                                    const DebugLoc &DL,
1658                                    int *BytesAdded) const {
1659   if (!FBB && Cond.empty()) {
1660     BuildMI(&MBB, DL, get(AMDGPU::S_BRANCH))
1661       .addMBB(TBB);
1662     if (BytesAdded)
1663       *BytesAdded = 4;
1664     return 1;
1665   }
1666 
1667   if(Cond.size() == 1 && Cond[0].isReg()) {
1668      BuildMI(&MBB, DL, get(AMDGPU::SI_NON_UNIFORM_BRCOND_PSEUDO))
1669        .add(Cond[0])
1670        .addMBB(TBB);
1671      return 1;
1672   }
1673 
1674   assert(TBB && Cond[0].isImm());
1675 
1676   unsigned Opcode
1677     = getBranchOpcode(static_cast<BranchPredicate>(Cond[0].getImm()));
1678 
1679   if (!FBB) {
1680     Cond[1].isUndef();
1681     MachineInstr *CondBr =
1682       BuildMI(&MBB, DL, get(Opcode))
1683       .addMBB(TBB);
1684 
1685     // Copy the flags onto the implicit condition register operand.
1686     preserveCondRegFlags(CondBr->getOperand(1), Cond[1]);
1687 
1688     if (BytesAdded)
1689       *BytesAdded = 4;
1690     return 1;
1691   }
1692 
1693   assert(TBB && FBB);
1694 
1695   MachineInstr *CondBr =
1696     BuildMI(&MBB, DL, get(Opcode))
1697     .addMBB(TBB);
1698   BuildMI(&MBB, DL, get(AMDGPU::S_BRANCH))
1699     .addMBB(FBB);
1700 
1701   MachineOperand &CondReg = CondBr->getOperand(1);
1702   CondReg.setIsUndef(Cond[1].isUndef());
1703   CondReg.setIsKill(Cond[1].isKill());
1704 
1705   if (BytesAdded)
1706       *BytesAdded = 8;
1707 
1708   return 2;
1709 }
1710 
1711 bool SIInstrInfo::reverseBranchCondition(
1712   SmallVectorImpl<MachineOperand> &Cond) const {
1713   if (Cond.size() != 2) {
1714     return true;
1715   }
1716 
1717   if (Cond[0].isImm()) {
1718     Cond[0].setImm(-Cond[0].getImm());
1719     return false;
1720   }
1721 
1722   return true;
1723 }
1724 
1725 bool SIInstrInfo::canInsertSelect(const MachineBasicBlock &MBB,
1726                                   ArrayRef<MachineOperand> Cond,
1727                                   unsigned TrueReg, unsigned FalseReg,
1728                                   int &CondCycles,
1729                                   int &TrueCycles, int &FalseCycles) const {
1730   switch (Cond[0].getImm()) {
1731   case VCCNZ:
1732   case VCCZ: {
1733     const MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
1734     const TargetRegisterClass *RC = MRI.getRegClass(TrueReg);
1735     assert(MRI.getRegClass(FalseReg) == RC);
1736 
1737     int NumInsts = AMDGPU::getRegBitWidth(RC->getID()) / 32;
1738     CondCycles = TrueCycles = FalseCycles = NumInsts; // ???
1739 
1740     // Limit to equal cost for branch vs. N v_cndmask_b32s.
1741     return !RI.isSGPRClass(RC) && NumInsts <= 6;
1742   }
1743   case SCC_TRUE:
1744   case SCC_FALSE: {
1745     // FIXME: We could insert for VGPRs if we could replace the original compare
1746     // with a vector one.
1747     const MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
1748     const TargetRegisterClass *RC = MRI.getRegClass(TrueReg);
1749     assert(MRI.getRegClass(FalseReg) == RC);
1750 
1751     int NumInsts = AMDGPU::getRegBitWidth(RC->getID()) / 32;
1752 
1753     // Multiples of 8 can do s_cselect_b64
1754     if (NumInsts % 2 == 0)
1755       NumInsts /= 2;
1756 
1757     CondCycles = TrueCycles = FalseCycles = NumInsts; // ???
1758     return RI.isSGPRClass(RC);
1759   }
1760   default:
1761     return false;
1762   }
1763 }
1764 
1765 void SIInstrInfo::insertSelect(MachineBasicBlock &MBB,
1766                                MachineBasicBlock::iterator I, const DebugLoc &DL,
1767                                unsigned DstReg, ArrayRef<MachineOperand> Cond,
1768                                unsigned TrueReg, unsigned FalseReg) const {
1769   BranchPredicate Pred = static_cast<BranchPredicate>(Cond[0].getImm());
1770   if (Pred == VCCZ || Pred == SCC_FALSE) {
1771     Pred = static_cast<BranchPredicate>(-Pred);
1772     std::swap(TrueReg, FalseReg);
1773   }
1774 
1775   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
1776   const TargetRegisterClass *DstRC = MRI.getRegClass(DstReg);
1777   unsigned DstSize = RI.getRegSizeInBits(*DstRC);
1778 
1779   if (DstSize == 32) {
1780     unsigned SelOp = Pred == SCC_TRUE ?
1781       AMDGPU::S_CSELECT_B32 : AMDGPU::V_CNDMASK_B32_e32;
1782 
1783     // Instruction's operands are backwards from what is expected.
1784     MachineInstr *Select =
1785       BuildMI(MBB, I, DL, get(SelOp), DstReg)
1786       .addReg(FalseReg)
1787       .addReg(TrueReg);
1788 
1789     preserveCondRegFlags(Select->getOperand(3), Cond[1]);
1790     return;
1791   }
1792 
1793   if (DstSize == 64 && Pred == SCC_TRUE) {
1794     MachineInstr *Select =
1795       BuildMI(MBB, I, DL, get(AMDGPU::S_CSELECT_B64), DstReg)
1796       .addReg(FalseReg)
1797       .addReg(TrueReg);
1798 
1799     preserveCondRegFlags(Select->getOperand(3), Cond[1]);
1800     return;
1801   }
1802 
1803   static const int16_t Sub0_15[] = {
1804     AMDGPU::sub0, AMDGPU::sub1, AMDGPU::sub2, AMDGPU::sub3,
1805     AMDGPU::sub4, AMDGPU::sub5, AMDGPU::sub6, AMDGPU::sub7,
1806     AMDGPU::sub8, AMDGPU::sub9, AMDGPU::sub10, AMDGPU::sub11,
1807     AMDGPU::sub12, AMDGPU::sub13, AMDGPU::sub14, AMDGPU::sub15,
1808   };
1809 
1810   static const int16_t Sub0_15_64[] = {
1811     AMDGPU::sub0_sub1, AMDGPU::sub2_sub3,
1812     AMDGPU::sub4_sub5, AMDGPU::sub6_sub7,
1813     AMDGPU::sub8_sub9, AMDGPU::sub10_sub11,
1814     AMDGPU::sub12_sub13, AMDGPU::sub14_sub15,
1815   };
1816 
1817   unsigned SelOp = AMDGPU::V_CNDMASK_B32_e32;
1818   const TargetRegisterClass *EltRC = &AMDGPU::VGPR_32RegClass;
1819   const int16_t *SubIndices = Sub0_15;
1820   int NElts = DstSize / 32;
1821 
1822   // 64-bit select is only avaialble for SALU.
1823   if (Pred == SCC_TRUE) {
1824     SelOp = AMDGPU::S_CSELECT_B64;
1825     EltRC = &AMDGPU::SGPR_64RegClass;
1826     SubIndices = Sub0_15_64;
1827 
1828     assert(NElts % 2 == 0);
1829     NElts /= 2;
1830   }
1831 
1832   MachineInstrBuilder MIB = BuildMI(
1833     MBB, I, DL, get(AMDGPU::REG_SEQUENCE), DstReg);
1834 
1835   I = MIB->getIterator();
1836 
1837   SmallVector<unsigned, 8> Regs;
1838   for (int Idx = 0; Idx != NElts; ++Idx) {
1839     unsigned DstElt = MRI.createVirtualRegister(EltRC);
1840     Regs.push_back(DstElt);
1841 
1842     unsigned SubIdx = SubIndices[Idx];
1843 
1844     MachineInstr *Select =
1845       BuildMI(MBB, I, DL, get(SelOp), DstElt)
1846       .addReg(FalseReg, 0, SubIdx)
1847       .addReg(TrueReg, 0, SubIdx);
1848     preserveCondRegFlags(Select->getOperand(3), Cond[1]);
1849 
1850     MIB.addReg(DstElt)
1851        .addImm(SubIdx);
1852   }
1853 }
1854 
1855 bool SIInstrInfo::isFoldableCopy(const MachineInstr &MI) const {
1856   switch (MI.getOpcode()) {
1857   case AMDGPU::V_MOV_B32_e32:
1858   case AMDGPU::V_MOV_B32_e64:
1859   case AMDGPU::V_MOV_B64_PSEUDO: {
1860     // If there are additional implicit register operands, this may be used for
1861     // register indexing so the source register operand isn't simply copied.
1862     unsigned NumOps = MI.getDesc().getNumOperands() +
1863       MI.getDesc().getNumImplicitUses();
1864 
1865     return MI.getNumOperands() == NumOps;
1866   }
1867   case AMDGPU::S_MOV_B32:
1868   case AMDGPU::S_MOV_B64:
1869   case AMDGPU::COPY:
1870     return true;
1871   default:
1872     return false;
1873   }
1874 }
1875 
1876 unsigned SIInstrInfo::getAddressSpaceForPseudoSourceKind(
1877     PseudoSourceValue::PSVKind Kind) const {
1878   switch(Kind) {
1879   case PseudoSourceValue::Stack:
1880   case PseudoSourceValue::FixedStack:
1881     return AMDGPUASI.PRIVATE_ADDRESS;
1882   case PseudoSourceValue::ConstantPool:
1883   case PseudoSourceValue::GOT:
1884   case PseudoSourceValue::JumpTable:
1885   case PseudoSourceValue::GlobalValueCallEntry:
1886   case PseudoSourceValue::ExternalSymbolCallEntry:
1887   case PseudoSourceValue::TargetCustom:
1888     return AMDGPUASI.CONSTANT_ADDRESS;
1889   }
1890   return AMDGPUASI.FLAT_ADDRESS;
1891 }
1892 
1893 static void removeModOperands(MachineInstr &MI) {
1894   unsigned Opc = MI.getOpcode();
1895   int Src0ModIdx = AMDGPU::getNamedOperandIdx(Opc,
1896                                               AMDGPU::OpName::src0_modifiers);
1897   int Src1ModIdx = AMDGPU::getNamedOperandIdx(Opc,
1898                                               AMDGPU::OpName::src1_modifiers);
1899   int Src2ModIdx = AMDGPU::getNamedOperandIdx(Opc,
1900                                               AMDGPU::OpName::src2_modifiers);
1901 
1902   MI.RemoveOperand(Src2ModIdx);
1903   MI.RemoveOperand(Src1ModIdx);
1904   MI.RemoveOperand(Src0ModIdx);
1905 }
1906 
1907 bool SIInstrInfo::FoldImmediate(MachineInstr &UseMI, MachineInstr &DefMI,
1908                                 unsigned Reg, MachineRegisterInfo *MRI) const {
1909   if (!MRI->hasOneNonDBGUse(Reg))
1910     return false;
1911 
1912   unsigned Opc = UseMI.getOpcode();
1913   if (Opc == AMDGPU::COPY) {
1914     bool isVGPRCopy = RI.isVGPR(*MRI, UseMI.getOperand(0).getReg());
1915     switch (DefMI.getOpcode()) {
1916     default:
1917       return false;
1918     case AMDGPU::S_MOV_B64:
1919       // TODO: We could fold 64-bit immediates, but this get compilicated
1920       // when there are sub-registers.
1921       return false;
1922 
1923     case AMDGPU::V_MOV_B32_e32:
1924     case AMDGPU::S_MOV_B32:
1925       break;
1926     }
1927     unsigned NewOpc = isVGPRCopy ? AMDGPU::V_MOV_B32_e32 : AMDGPU::S_MOV_B32;
1928     const MachineOperand *ImmOp = getNamedOperand(DefMI, AMDGPU::OpName::src0);
1929     assert(ImmOp);
1930     // FIXME: We could handle FrameIndex values here.
1931     if (!ImmOp->isImm()) {
1932       return false;
1933     }
1934     UseMI.setDesc(get(NewOpc));
1935     UseMI.getOperand(1).ChangeToImmediate(ImmOp->getImm());
1936     UseMI.addImplicitDefUseOperands(*UseMI.getParent()->getParent());
1937     return true;
1938   }
1939 
1940   if (Opc == AMDGPU::V_MAD_F32 || Opc == AMDGPU::V_MAC_F32_e64 ||
1941       Opc == AMDGPU::V_MAD_F16 || Opc == AMDGPU::V_MAC_F16_e64) {
1942     // Don't fold if we are using source or output modifiers. The new VOP2
1943     // instructions don't have them.
1944     if (hasAnyModifiersSet(UseMI))
1945       return false;
1946 
1947     const MachineOperand &ImmOp = DefMI.getOperand(1);
1948 
1949     // If this is a free constant, there's no reason to do this.
1950     // TODO: We could fold this here instead of letting SIFoldOperands do it
1951     // later.
1952     MachineOperand *Src0 = getNamedOperand(UseMI, AMDGPU::OpName::src0);
1953 
1954     // Any src operand can be used for the legality check.
1955     if (isInlineConstant(UseMI, *Src0, ImmOp))
1956       return false;
1957 
1958     bool IsF32 = Opc == AMDGPU::V_MAD_F32 || Opc == AMDGPU::V_MAC_F32_e64;
1959     MachineOperand *Src1 = getNamedOperand(UseMI, AMDGPU::OpName::src1);
1960     MachineOperand *Src2 = getNamedOperand(UseMI, AMDGPU::OpName::src2);
1961 
1962     // Multiplied part is the constant: Use v_madmk_{f16, f32}.
1963     // We should only expect these to be on src0 due to canonicalizations.
1964     if (Src0->isReg() && Src0->getReg() == Reg) {
1965       if (!Src1->isReg() || RI.isSGPRClass(MRI->getRegClass(Src1->getReg())))
1966         return false;
1967 
1968       if (!Src2->isReg() || RI.isSGPRClass(MRI->getRegClass(Src2->getReg())))
1969         return false;
1970 
1971       // We need to swap operands 0 and 1 since madmk constant is at operand 1.
1972 
1973       const int64_t Imm = DefMI.getOperand(1).getImm();
1974 
1975       // FIXME: This would be a lot easier if we could return a new instruction
1976       // instead of having to modify in place.
1977 
1978       // Remove these first since they are at the end.
1979       UseMI.RemoveOperand(
1980           AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::omod));
1981       UseMI.RemoveOperand(
1982           AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::clamp));
1983 
1984       unsigned Src1Reg = Src1->getReg();
1985       unsigned Src1SubReg = Src1->getSubReg();
1986       Src0->setReg(Src1Reg);
1987       Src0->setSubReg(Src1SubReg);
1988       Src0->setIsKill(Src1->isKill());
1989 
1990       if (Opc == AMDGPU::V_MAC_F32_e64 ||
1991           Opc == AMDGPU::V_MAC_F16_e64)
1992         UseMI.untieRegOperand(
1993             AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2));
1994 
1995       Src1->ChangeToImmediate(Imm);
1996 
1997       removeModOperands(UseMI);
1998       UseMI.setDesc(get(IsF32 ? AMDGPU::V_MADMK_F32 : AMDGPU::V_MADMK_F16));
1999 
2000       bool DeleteDef = MRI->hasOneNonDBGUse(Reg);
2001       if (DeleteDef)
2002         DefMI.eraseFromParent();
2003 
2004       return true;
2005     }
2006 
2007     // Added part is the constant: Use v_madak_{f16, f32}.
2008     if (Src2->isReg() && Src2->getReg() == Reg) {
2009       // Not allowed to use constant bus for another operand.
2010       // We can however allow an inline immediate as src0.
2011       if (!Src0->isImm() &&
2012           (Src0->isReg() && RI.isSGPRClass(MRI->getRegClass(Src0->getReg()))))
2013         return false;
2014 
2015       if (!Src1->isReg() || RI.isSGPRClass(MRI->getRegClass(Src1->getReg())))
2016         return false;
2017 
2018       const int64_t Imm = DefMI.getOperand(1).getImm();
2019 
2020       // FIXME: This would be a lot easier if we could return a new instruction
2021       // instead of having to modify in place.
2022 
2023       // Remove these first since they are at the end.
2024       UseMI.RemoveOperand(
2025           AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::omod));
2026       UseMI.RemoveOperand(
2027           AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::clamp));
2028 
2029       if (Opc == AMDGPU::V_MAC_F32_e64 ||
2030           Opc == AMDGPU::V_MAC_F16_e64)
2031         UseMI.untieRegOperand(
2032             AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2));
2033 
2034       // ChangingToImmediate adds Src2 back to the instruction.
2035       Src2->ChangeToImmediate(Imm);
2036 
2037       // These come before src2.
2038       removeModOperands(UseMI);
2039       UseMI.setDesc(get(IsF32 ? AMDGPU::V_MADAK_F32 : AMDGPU::V_MADAK_F16));
2040 
2041       bool DeleteDef = MRI->hasOneNonDBGUse(Reg);
2042       if (DeleteDef)
2043         DefMI.eraseFromParent();
2044 
2045       return true;
2046     }
2047   }
2048 
2049   return false;
2050 }
2051 
2052 static bool offsetsDoNotOverlap(int WidthA, int OffsetA,
2053                                 int WidthB, int OffsetB) {
2054   int LowOffset = OffsetA < OffsetB ? OffsetA : OffsetB;
2055   int HighOffset = OffsetA < OffsetB ? OffsetB : OffsetA;
2056   int LowWidth = (LowOffset == OffsetA) ? WidthA : WidthB;
2057   return LowOffset + LowWidth <= HighOffset;
2058 }
2059 
2060 bool SIInstrInfo::checkInstOffsetsDoNotOverlap(MachineInstr &MIa,
2061                                                MachineInstr &MIb) const {
2062   unsigned BaseReg0, BaseReg1;
2063   int64_t Offset0, Offset1;
2064 
2065   if (getMemOpBaseRegImmOfs(MIa, BaseReg0, Offset0, &RI) &&
2066       getMemOpBaseRegImmOfs(MIb, BaseReg1, Offset1, &RI)) {
2067 
2068     if (!MIa.hasOneMemOperand() || !MIb.hasOneMemOperand()) {
2069       // FIXME: Handle ds_read2 / ds_write2.
2070       return false;
2071     }
2072     unsigned Width0 = (*MIa.memoperands_begin())->getSize();
2073     unsigned Width1 = (*MIb.memoperands_begin())->getSize();
2074     if (BaseReg0 == BaseReg1 &&
2075         offsetsDoNotOverlap(Width0, Offset0, Width1, Offset1)) {
2076       return true;
2077     }
2078   }
2079 
2080   return false;
2081 }
2082 
2083 bool SIInstrInfo::areMemAccessesTriviallyDisjoint(MachineInstr &MIa,
2084                                                   MachineInstr &MIb,
2085                                                   AliasAnalysis *AA) const {
2086   assert((MIa.mayLoad() || MIa.mayStore()) &&
2087          "MIa must load from or modify a memory location");
2088   assert((MIb.mayLoad() || MIb.mayStore()) &&
2089          "MIb must load from or modify a memory location");
2090 
2091   if (MIa.hasUnmodeledSideEffects() || MIb.hasUnmodeledSideEffects())
2092     return false;
2093 
2094   // XXX - Can we relax this between address spaces?
2095   if (MIa.hasOrderedMemoryRef() || MIb.hasOrderedMemoryRef())
2096     return false;
2097 
2098   if (AA && MIa.hasOneMemOperand() && MIb.hasOneMemOperand()) {
2099     const MachineMemOperand *MMOa = *MIa.memoperands_begin();
2100     const MachineMemOperand *MMOb = *MIb.memoperands_begin();
2101     if (MMOa->getValue() && MMOb->getValue()) {
2102       MemoryLocation LocA(MMOa->getValue(), MMOa->getSize(), MMOa->getAAInfo());
2103       MemoryLocation LocB(MMOb->getValue(), MMOb->getSize(), MMOb->getAAInfo());
2104       if (!AA->alias(LocA, LocB))
2105         return true;
2106     }
2107   }
2108 
2109   // TODO: Should we check the address space from the MachineMemOperand? That
2110   // would allow us to distinguish objects we know don't alias based on the
2111   // underlying address space, even if it was lowered to a different one,
2112   // e.g. private accesses lowered to use MUBUF instructions on a scratch
2113   // buffer.
2114   if (isDS(MIa)) {
2115     if (isDS(MIb))
2116       return checkInstOffsetsDoNotOverlap(MIa, MIb);
2117 
2118     return !isFLAT(MIb) || isSegmentSpecificFLAT(MIb);
2119   }
2120 
2121   if (isMUBUF(MIa) || isMTBUF(MIa)) {
2122     if (isMUBUF(MIb) || isMTBUF(MIb))
2123       return checkInstOffsetsDoNotOverlap(MIa, MIb);
2124 
2125     return !isFLAT(MIb) && !isSMRD(MIb);
2126   }
2127 
2128   if (isSMRD(MIa)) {
2129     if (isSMRD(MIb))
2130       return checkInstOffsetsDoNotOverlap(MIa, MIb);
2131 
2132     return !isFLAT(MIb) && !isMUBUF(MIa) && !isMTBUF(MIa);
2133   }
2134 
2135   if (isFLAT(MIa)) {
2136     if (isFLAT(MIb))
2137       return checkInstOffsetsDoNotOverlap(MIa, MIb);
2138 
2139     return false;
2140   }
2141 
2142   return false;
2143 }
2144 
2145 static int64_t getFoldableImm(const MachineOperand* MO) {
2146   if (!MO->isReg())
2147     return false;
2148   const MachineFunction *MF = MO->getParent()->getParent()->getParent();
2149   const MachineRegisterInfo &MRI = MF->getRegInfo();
2150   auto Def = MRI.getUniqueVRegDef(MO->getReg());
2151   if (Def && Def->getOpcode() == AMDGPU::V_MOV_B32_e32 &&
2152       Def->getOperand(1).isImm())
2153     return Def->getOperand(1).getImm();
2154   return AMDGPU::NoRegister;
2155 }
2156 
2157 MachineInstr *SIInstrInfo::convertToThreeAddress(MachineFunction::iterator &MBB,
2158                                                  MachineInstr &MI,
2159                                                  LiveVariables *LV) const {
2160   bool IsF16 = false;
2161 
2162   switch (MI.getOpcode()) {
2163   default:
2164     return nullptr;
2165   case AMDGPU::V_MAC_F16_e64:
2166     IsF16 = true;
2167     LLVM_FALLTHROUGH;
2168   case AMDGPU::V_MAC_F32_e64:
2169     break;
2170   case AMDGPU::V_MAC_F16_e32:
2171     IsF16 = true;
2172     LLVM_FALLTHROUGH;
2173   case AMDGPU::V_MAC_F32_e32: {
2174     int Src0Idx = AMDGPU::getNamedOperandIdx(MI.getOpcode(),
2175                                              AMDGPU::OpName::src0);
2176     const MachineOperand *Src0 = &MI.getOperand(Src0Idx);
2177     if (!Src0->isReg() && !Src0->isImm())
2178       return nullptr;
2179 
2180     if (Src0->isImm() && !isInlineConstant(MI, Src0Idx, *Src0))
2181       return nullptr;
2182 
2183     break;
2184   }
2185   }
2186 
2187   const MachineOperand *Dst = getNamedOperand(MI, AMDGPU::OpName::vdst);
2188   const MachineOperand *Src0 = getNamedOperand(MI, AMDGPU::OpName::src0);
2189   const MachineOperand *Src0Mods =
2190     getNamedOperand(MI, AMDGPU::OpName::src0_modifiers);
2191   const MachineOperand *Src1 = getNamedOperand(MI, AMDGPU::OpName::src1);
2192   const MachineOperand *Src1Mods =
2193     getNamedOperand(MI, AMDGPU::OpName::src1_modifiers);
2194   const MachineOperand *Src2 = getNamedOperand(MI, AMDGPU::OpName::src2);
2195   const MachineOperand *Clamp = getNamedOperand(MI, AMDGPU::OpName::clamp);
2196   const MachineOperand *Omod = getNamedOperand(MI, AMDGPU::OpName::omod);
2197 
2198   if (!Src0Mods && !Src1Mods && !Clamp && !Omod &&
2199       // If we have an SGPR input, we will violate the constant bus restriction.
2200       (!Src0->isReg() || !RI.isSGPRReg(MBB->getParent()->getRegInfo(), Src0->getReg()))) {
2201     if (auto Imm = getFoldableImm(Src2)) {
2202       return BuildMI(*MBB, MI, MI.getDebugLoc(),
2203                      get(IsF16 ? AMDGPU::V_MADAK_F16 : AMDGPU::V_MADAK_F32))
2204                .add(*Dst)
2205                .add(*Src0)
2206                .add(*Src1)
2207                .addImm(Imm);
2208     }
2209     if (auto Imm = getFoldableImm(Src1)) {
2210       return BuildMI(*MBB, MI, MI.getDebugLoc(),
2211                      get(IsF16 ? AMDGPU::V_MADMK_F16 : AMDGPU::V_MADMK_F32))
2212                .add(*Dst)
2213                .add(*Src0)
2214                .addImm(Imm)
2215                .add(*Src2);
2216     }
2217     if (auto Imm = getFoldableImm(Src0)) {
2218       if (isOperandLegal(MI, AMDGPU::getNamedOperandIdx(AMDGPU::V_MADMK_F32,
2219                            AMDGPU::OpName::src0), Src1))
2220         return BuildMI(*MBB, MI, MI.getDebugLoc(),
2221                        get(IsF16 ? AMDGPU::V_MADMK_F16 : AMDGPU::V_MADMK_F32))
2222                  .add(*Dst)
2223                  .add(*Src1)
2224                  .addImm(Imm)
2225                  .add(*Src2);
2226     }
2227   }
2228 
2229   return BuildMI(*MBB, MI, MI.getDebugLoc(),
2230                  get(IsF16 ? AMDGPU::V_MAD_F16 : AMDGPU::V_MAD_F32))
2231       .add(*Dst)
2232       .addImm(Src0Mods ? Src0Mods->getImm() : 0)
2233       .add(*Src0)
2234       .addImm(Src1Mods ? Src1Mods->getImm() : 0)
2235       .add(*Src1)
2236       .addImm(0) // Src mods
2237       .add(*Src2)
2238       .addImm(Clamp ? Clamp->getImm() : 0)
2239       .addImm(Omod ? Omod->getImm() : 0);
2240 }
2241 
2242 // It's not generally safe to move VALU instructions across these since it will
2243 // start using the register as a base index rather than directly.
2244 // XXX - Why isn't hasSideEffects sufficient for these?
2245 static bool changesVGPRIndexingMode(const MachineInstr &MI) {
2246   switch (MI.getOpcode()) {
2247   case AMDGPU::S_SET_GPR_IDX_ON:
2248   case AMDGPU::S_SET_GPR_IDX_MODE:
2249   case AMDGPU::S_SET_GPR_IDX_OFF:
2250     return true;
2251   default:
2252     return false;
2253   }
2254 }
2255 
2256 bool SIInstrInfo::isSchedulingBoundary(const MachineInstr &MI,
2257                                        const MachineBasicBlock *MBB,
2258                                        const MachineFunction &MF) const {
2259   // XXX - Do we want the SP check in the base implementation?
2260 
2261   // Target-independent instructions do not have an implicit-use of EXEC, even
2262   // when they operate on VGPRs. Treating EXEC modifications as scheduling
2263   // boundaries prevents incorrect movements of such instructions.
2264   return TargetInstrInfo::isSchedulingBoundary(MI, MBB, MF) ||
2265          MI.modifiesRegister(AMDGPU::EXEC, &RI) ||
2266          MI.getOpcode() == AMDGPU::S_SETREG_IMM32_B32 ||
2267          MI.getOpcode() == AMDGPU::S_SETREG_B32 ||
2268          changesVGPRIndexingMode(MI);
2269 }
2270 
2271 bool SIInstrInfo::isInlineConstant(const APInt &Imm) const {
2272   switch (Imm.getBitWidth()) {
2273   case 32:
2274     return AMDGPU::isInlinableLiteral32(Imm.getSExtValue(),
2275                                         ST.hasInv2PiInlineImm());
2276   case 64:
2277     return AMDGPU::isInlinableLiteral64(Imm.getSExtValue(),
2278                                         ST.hasInv2PiInlineImm());
2279   case 16:
2280     return ST.has16BitInsts() &&
2281            AMDGPU::isInlinableLiteral16(Imm.getSExtValue(),
2282                                         ST.hasInv2PiInlineImm());
2283   default:
2284     llvm_unreachable("invalid bitwidth");
2285   }
2286 }
2287 
2288 bool SIInstrInfo::isInlineConstant(const MachineOperand &MO,
2289                                    uint8_t OperandType) const {
2290   if (!MO.isImm() ||
2291       OperandType < AMDGPU::OPERAND_SRC_FIRST ||
2292       OperandType > AMDGPU::OPERAND_SRC_LAST)
2293     return false;
2294 
2295   // MachineOperand provides no way to tell the true operand size, since it only
2296   // records a 64-bit value. We need to know the size to determine if a 32-bit
2297   // floating point immediate bit pattern is legal for an integer immediate. It
2298   // would be for any 32-bit integer operand, but would not be for a 64-bit one.
2299 
2300   int64_t Imm = MO.getImm();
2301   switch (OperandType) {
2302   case AMDGPU::OPERAND_REG_IMM_INT32:
2303   case AMDGPU::OPERAND_REG_IMM_FP32:
2304   case AMDGPU::OPERAND_REG_INLINE_C_INT32:
2305   case AMDGPU::OPERAND_REG_INLINE_C_FP32: {
2306     int32_t Trunc = static_cast<int32_t>(Imm);
2307     return Trunc == Imm &&
2308            AMDGPU::isInlinableLiteral32(Trunc, ST.hasInv2PiInlineImm());
2309   }
2310   case AMDGPU::OPERAND_REG_IMM_INT64:
2311   case AMDGPU::OPERAND_REG_IMM_FP64:
2312   case AMDGPU::OPERAND_REG_INLINE_C_INT64:
2313   case AMDGPU::OPERAND_REG_INLINE_C_FP64:
2314     return AMDGPU::isInlinableLiteral64(MO.getImm(),
2315                                         ST.hasInv2PiInlineImm());
2316   case AMDGPU::OPERAND_REG_IMM_INT16:
2317   case AMDGPU::OPERAND_REG_IMM_FP16:
2318   case AMDGPU::OPERAND_REG_INLINE_C_INT16:
2319   case AMDGPU::OPERAND_REG_INLINE_C_FP16: {
2320     if (isInt<16>(Imm) || isUInt<16>(Imm)) {
2321       // A few special case instructions have 16-bit operands on subtargets
2322       // where 16-bit instructions are not legal.
2323       // TODO: Do the 32-bit immediates work? We shouldn't really need to handle
2324       // constants in these cases
2325       int16_t Trunc = static_cast<int16_t>(Imm);
2326       return ST.has16BitInsts() &&
2327              AMDGPU::isInlinableLiteral16(Trunc, ST.hasInv2PiInlineImm());
2328     }
2329 
2330     return false;
2331   }
2332   case AMDGPU::OPERAND_REG_INLINE_C_V2INT16:
2333   case AMDGPU::OPERAND_REG_INLINE_C_V2FP16: {
2334     uint32_t Trunc = static_cast<uint32_t>(Imm);
2335     return  AMDGPU::isInlinableLiteralV216(Trunc, ST.hasInv2PiInlineImm());
2336   }
2337   default:
2338     llvm_unreachable("invalid bitwidth");
2339   }
2340 }
2341 
2342 bool SIInstrInfo::isLiteralConstantLike(const MachineOperand &MO,
2343                                         const MCOperandInfo &OpInfo) const {
2344   switch (MO.getType()) {
2345   case MachineOperand::MO_Register:
2346     return false;
2347   case MachineOperand::MO_Immediate:
2348     return !isInlineConstant(MO, OpInfo);
2349   case MachineOperand::MO_FrameIndex:
2350   case MachineOperand::MO_MachineBasicBlock:
2351   case MachineOperand::MO_ExternalSymbol:
2352   case MachineOperand::MO_GlobalAddress:
2353   case MachineOperand::MO_MCSymbol:
2354     return true;
2355   default:
2356     llvm_unreachable("unexpected operand type");
2357   }
2358 }
2359 
2360 static bool compareMachineOp(const MachineOperand &Op0,
2361                              const MachineOperand &Op1) {
2362   if (Op0.getType() != Op1.getType())
2363     return false;
2364 
2365   switch (Op0.getType()) {
2366   case MachineOperand::MO_Register:
2367     return Op0.getReg() == Op1.getReg();
2368   case MachineOperand::MO_Immediate:
2369     return Op0.getImm() == Op1.getImm();
2370   default:
2371     llvm_unreachable("Didn't expect to be comparing these operand types");
2372   }
2373 }
2374 
2375 bool SIInstrInfo::isImmOperandLegal(const MachineInstr &MI, unsigned OpNo,
2376                                     const MachineOperand &MO) const {
2377   const MCOperandInfo &OpInfo = get(MI.getOpcode()).OpInfo[OpNo];
2378 
2379   assert(MO.isImm() || MO.isTargetIndex() || MO.isFI());
2380 
2381   if (OpInfo.OperandType == MCOI::OPERAND_IMMEDIATE)
2382     return true;
2383 
2384   if (OpInfo.RegClass < 0)
2385     return false;
2386 
2387   if (MO.isImm() && isInlineConstant(MO, OpInfo))
2388     return RI.opCanUseInlineConstant(OpInfo.OperandType);
2389 
2390   return RI.opCanUseLiteralConstant(OpInfo.OperandType);
2391 }
2392 
2393 bool SIInstrInfo::hasVALU32BitEncoding(unsigned Opcode) const {
2394   int Op32 = AMDGPU::getVOPe32(Opcode);
2395   if (Op32 == -1)
2396     return false;
2397 
2398   return pseudoToMCOpcode(Op32) != -1;
2399 }
2400 
2401 bool SIInstrInfo::hasModifiers(unsigned Opcode) const {
2402   // The src0_modifier operand is present on all instructions
2403   // that have modifiers.
2404 
2405   return AMDGPU::getNamedOperandIdx(Opcode,
2406                                     AMDGPU::OpName::src0_modifiers) != -1;
2407 }
2408 
2409 bool SIInstrInfo::hasModifiersSet(const MachineInstr &MI,
2410                                   unsigned OpName) const {
2411   const MachineOperand *Mods = getNamedOperand(MI, OpName);
2412   return Mods && Mods->getImm();
2413 }
2414 
2415 bool SIInstrInfo::hasAnyModifiersSet(const MachineInstr &MI) const {
2416   return hasModifiersSet(MI, AMDGPU::OpName::src0_modifiers) ||
2417          hasModifiersSet(MI, AMDGPU::OpName::src1_modifiers) ||
2418          hasModifiersSet(MI, AMDGPU::OpName::src2_modifiers) ||
2419          hasModifiersSet(MI, AMDGPU::OpName::clamp) ||
2420          hasModifiersSet(MI, AMDGPU::OpName::omod);
2421 }
2422 
2423 bool SIInstrInfo::usesConstantBus(const MachineRegisterInfo &MRI,
2424                                   const MachineOperand &MO,
2425                                   const MCOperandInfo &OpInfo) const {
2426   // Literal constants use the constant bus.
2427   //if (isLiteralConstantLike(MO, OpInfo))
2428   // return true;
2429   if (MO.isImm())
2430     return !isInlineConstant(MO, OpInfo);
2431 
2432   if (!MO.isReg())
2433     return true; // Misc other operands like FrameIndex
2434 
2435   if (!MO.isUse())
2436     return false;
2437 
2438   if (TargetRegisterInfo::isVirtualRegister(MO.getReg()))
2439     return RI.isSGPRClass(MRI.getRegClass(MO.getReg()));
2440 
2441   // FLAT_SCR is just an SGPR pair.
2442   if (!MO.isImplicit() && (MO.getReg() == AMDGPU::FLAT_SCR))
2443     return true;
2444 
2445   // EXEC register uses the constant bus.
2446   if (!MO.isImplicit() && MO.getReg() == AMDGPU::EXEC)
2447     return true;
2448 
2449   // SGPRs use the constant bus
2450   return (MO.getReg() == AMDGPU::VCC || MO.getReg() == AMDGPU::M0 ||
2451           (!MO.isImplicit() &&
2452            (AMDGPU::SGPR_32RegClass.contains(MO.getReg()) ||
2453             AMDGPU::SGPR_64RegClass.contains(MO.getReg()))));
2454 }
2455 
2456 static unsigned findImplicitSGPRRead(const MachineInstr &MI) {
2457   for (const MachineOperand &MO : MI.implicit_operands()) {
2458     // We only care about reads.
2459     if (MO.isDef())
2460       continue;
2461 
2462     switch (MO.getReg()) {
2463     case AMDGPU::VCC:
2464     case AMDGPU::M0:
2465     case AMDGPU::FLAT_SCR:
2466       return MO.getReg();
2467 
2468     default:
2469       break;
2470     }
2471   }
2472 
2473   return AMDGPU::NoRegister;
2474 }
2475 
2476 static bool shouldReadExec(const MachineInstr &MI) {
2477   if (SIInstrInfo::isVALU(MI)) {
2478     switch (MI.getOpcode()) {
2479     case AMDGPU::V_READLANE_B32:
2480     case AMDGPU::V_READLANE_B32_si:
2481     case AMDGPU::V_READLANE_B32_vi:
2482     case AMDGPU::V_WRITELANE_B32:
2483     case AMDGPU::V_WRITELANE_B32_si:
2484     case AMDGPU::V_WRITELANE_B32_vi:
2485       return false;
2486     }
2487 
2488     return true;
2489   }
2490 
2491   if (SIInstrInfo::isGenericOpcode(MI.getOpcode()) ||
2492       SIInstrInfo::isSALU(MI) ||
2493       SIInstrInfo::isSMRD(MI))
2494     return false;
2495 
2496   return true;
2497 }
2498 
2499 static bool isSubRegOf(const SIRegisterInfo &TRI,
2500                        const MachineOperand &SuperVec,
2501                        const MachineOperand &SubReg) {
2502   if (TargetRegisterInfo::isPhysicalRegister(SubReg.getReg()))
2503     return TRI.isSubRegister(SuperVec.getReg(), SubReg.getReg());
2504 
2505   return SubReg.getSubReg() != AMDGPU::NoSubRegister &&
2506          SubReg.getReg() == SuperVec.getReg();
2507 }
2508 
2509 bool SIInstrInfo::verifyInstruction(const MachineInstr &MI,
2510                                     StringRef &ErrInfo) const {
2511   uint16_t Opcode = MI.getOpcode();
2512   if (SIInstrInfo::isGenericOpcode(MI.getOpcode()))
2513     return true;
2514 
2515   const MachineFunction *MF = MI.getParent()->getParent();
2516   const MachineRegisterInfo &MRI = MF->getRegInfo();
2517 
2518   int Src0Idx = AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::src0);
2519   int Src1Idx = AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::src1);
2520   int Src2Idx = AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::src2);
2521 
2522   // Make sure the number of operands is correct.
2523   const MCInstrDesc &Desc = get(Opcode);
2524   if (!Desc.isVariadic() &&
2525       Desc.getNumOperands() != MI.getNumExplicitOperands()) {
2526     ErrInfo = "Instruction has wrong number of operands.";
2527     return false;
2528   }
2529 
2530   if (MI.isInlineAsm()) {
2531     // Verify register classes for inlineasm constraints.
2532     for (unsigned I = InlineAsm::MIOp_FirstOperand, E = MI.getNumOperands();
2533          I != E; ++I) {
2534       const TargetRegisterClass *RC = MI.getRegClassConstraint(I, this, &RI);
2535       if (!RC)
2536         continue;
2537 
2538       const MachineOperand &Op = MI.getOperand(I);
2539       if (!Op.isReg())
2540         continue;
2541 
2542       unsigned Reg = Op.getReg();
2543       if (!TargetRegisterInfo::isVirtualRegister(Reg) && !RC->contains(Reg)) {
2544         ErrInfo = "inlineasm operand has incorrect register class.";
2545         return false;
2546       }
2547     }
2548 
2549     return true;
2550   }
2551 
2552   // Make sure the register classes are correct.
2553   for (int i = 0, e = Desc.getNumOperands(); i != e; ++i) {
2554     if (MI.getOperand(i).isFPImm()) {
2555       ErrInfo = "FPImm Machine Operands are not supported. ISel should bitcast "
2556                 "all fp values to integers.";
2557       return false;
2558     }
2559 
2560     int RegClass = Desc.OpInfo[i].RegClass;
2561 
2562     switch (Desc.OpInfo[i].OperandType) {
2563     case MCOI::OPERAND_REGISTER:
2564       if (MI.getOperand(i).isImm()) {
2565         ErrInfo = "Illegal immediate value for operand.";
2566         return false;
2567       }
2568       break;
2569     case AMDGPU::OPERAND_REG_IMM_INT32:
2570     case AMDGPU::OPERAND_REG_IMM_FP32:
2571       break;
2572     case AMDGPU::OPERAND_REG_INLINE_C_INT32:
2573     case AMDGPU::OPERAND_REG_INLINE_C_FP32:
2574     case AMDGPU::OPERAND_REG_INLINE_C_INT64:
2575     case AMDGPU::OPERAND_REG_INLINE_C_FP64:
2576     case AMDGPU::OPERAND_REG_INLINE_C_INT16:
2577     case AMDGPU::OPERAND_REG_INLINE_C_FP16: {
2578       const MachineOperand &MO = MI.getOperand(i);
2579       if (!MO.isReg() && (!MO.isImm() || !isInlineConstant(MI, i))) {
2580         ErrInfo = "Illegal immediate value for operand.";
2581         return false;
2582       }
2583       break;
2584     }
2585     case MCOI::OPERAND_IMMEDIATE:
2586     case AMDGPU::OPERAND_KIMM32:
2587       // Check if this operand is an immediate.
2588       // FrameIndex operands will be replaced by immediates, so they are
2589       // allowed.
2590       if (!MI.getOperand(i).isImm() && !MI.getOperand(i).isFI()) {
2591         ErrInfo = "Expected immediate, but got non-immediate";
2592         return false;
2593       }
2594       LLVM_FALLTHROUGH;
2595     default:
2596       continue;
2597     }
2598 
2599     if (!MI.getOperand(i).isReg())
2600       continue;
2601 
2602     if (RegClass != -1) {
2603       unsigned Reg = MI.getOperand(i).getReg();
2604       if (Reg == AMDGPU::NoRegister ||
2605           TargetRegisterInfo::isVirtualRegister(Reg))
2606         continue;
2607 
2608       const TargetRegisterClass *RC = RI.getRegClass(RegClass);
2609       if (!RC->contains(Reg)) {
2610         ErrInfo = "Operand has incorrect register class.";
2611         return false;
2612       }
2613     }
2614   }
2615 
2616   // Verify SDWA
2617   if (isSDWA(MI)) {
2618     if (!ST.hasSDWA()) {
2619       ErrInfo = "SDWA is not supported on this target";
2620       return false;
2621     }
2622 
2623     int DstIdx = AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::vdst);
2624 
2625     const int OpIndicies[] = { DstIdx, Src0Idx, Src1Idx, Src2Idx };
2626 
2627     for (int OpIdx: OpIndicies) {
2628       if (OpIdx == -1)
2629         continue;
2630       const MachineOperand &MO = MI.getOperand(OpIdx);
2631 
2632       if (!ST.hasSDWAScalar()) {
2633         // Only VGPRS on VI
2634         if (!MO.isReg() || !RI.hasVGPRs(RI.getRegClassForReg(MRI, MO.getReg()))) {
2635           ErrInfo = "Only VGPRs allowed as operands in SDWA instructions on VI";
2636           return false;
2637         }
2638       } else {
2639         // No immediates on GFX9
2640         if (!MO.isReg()) {
2641           ErrInfo = "Only reg allowed as operands in SDWA instructions on GFX9";
2642           return false;
2643         }
2644       }
2645     }
2646 
2647     if (!ST.hasSDWAOmod()) {
2648       // No omod allowed on VI
2649       const MachineOperand *OMod = getNamedOperand(MI, AMDGPU::OpName::omod);
2650       if (OMod != nullptr &&
2651         (!OMod->isImm() || OMod->getImm() != 0)) {
2652         ErrInfo = "OMod not allowed in SDWA instructions on VI";
2653         return false;
2654       }
2655     }
2656 
2657     uint16_t BasicOpcode = AMDGPU::getBasicFromSDWAOp(Opcode);
2658     if (isVOPC(BasicOpcode)) {
2659       if (!ST.hasSDWASdst() && DstIdx != -1) {
2660         // Only vcc allowed as dst on VI for VOPC
2661         const MachineOperand &Dst = MI.getOperand(DstIdx);
2662         if (!Dst.isReg() || Dst.getReg() != AMDGPU::VCC) {
2663           ErrInfo = "Only VCC allowed as dst in SDWA instructions on VI";
2664           return false;
2665         }
2666       } else if (!ST.hasSDWAOutModsVOPC()) {
2667         // No clamp allowed on GFX9 for VOPC
2668         const MachineOperand *Clamp = getNamedOperand(MI, AMDGPU::OpName::clamp);
2669         if (Clamp && (!Clamp->isImm() || Clamp->getImm() != 0)) {
2670           ErrInfo = "Clamp not allowed in VOPC SDWA instructions on VI";
2671           return false;
2672         }
2673 
2674         // No omod allowed on GFX9 for VOPC
2675         const MachineOperand *OMod = getNamedOperand(MI, AMDGPU::OpName::omod);
2676         if (OMod && (!OMod->isImm() || OMod->getImm() != 0)) {
2677           ErrInfo = "OMod not allowed in VOPC SDWA instructions on VI";
2678           return false;
2679         }
2680       }
2681     }
2682   }
2683 
2684   // Verify VOP*
2685   if (isVOP1(MI) || isVOP2(MI) || isVOP3(MI) || isVOPC(MI) || isSDWA(MI)) {
2686     // Only look at the true operands. Only a real operand can use the constant
2687     // bus, and we don't want to check pseudo-operands like the source modifier
2688     // flags.
2689     const int OpIndices[] = { Src0Idx, Src1Idx, Src2Idx };
2690 
2691     unsigned ConstantBusCount = 0;
2692 
2693     if (AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::imm) != -1)
2694       ++ConstantBusCount;
2695 
2696     unsigned SGPRUsed = findImplicitSGPRRead(MI);
2697     if (SGPRUsed != AMDGPU::NoRegister)
2698       ++ConstantBusCount;
2699 
2700     for (int OpIdx : OpIndices) {
2701       if (OpIdx == -1)
2702         break;
2703       const MachineOperand &MO = MI.getOperand(OpIdx);
2704       if (usesConstantBus(MRI, MO, MI.getDesc().OpInfo[OpIdx])) {
2705         if (MO.isReg()) {
2706           if (MO.getReg() != SGPRUsed)
2707             ++ConstantBusCount;
2708           SGPRUsed = MO.getReg();
2709         } else {
2710           ++ConstantBusCount;
2711         }
2712       }
2713     }
2714     if (ConstantBusCount > 1) {
2715       ErrInfo = "VOP* instruction uses the constant bus more than once";
2716       return false;
2717     }
2718   }
2719 
2720   // Verify misc. restrictions on specific instructions.
2721   if (Desc.getOpcode() == AMDGPU::V_DIV_SCALE_F32 ||
2722       Desc.getOpcode() == AMDGPU::V_DIV_SCALE_F64) {
2723     const MachineOperand &Src0 = MI.getOperand(Src0Idx);
2724     const MachineOperand &Src1 = MI.getOperand(Src1Idx);
2725     const MachineOperand &Src2 = MI.getOperand(Src2Idx);
2726     if (Src0.isReg() && Src1.isReg() && Src2.isReg()) {
2727       if (!compareMachineOp(Src0, Src1) &&
2728           !compareMachineOp(Src0, Src2)) {
2729         ErrInfo = "v_div_scale_{f32|f64} require src0 = src1 or src2";
2730         return false;
2731       }
2732     }
2733   }
2734 
2735   if (isSOPK(MI)) {
2736     int64_t Imm = getNamedOperand(MI, AMDGPU::OpName::simm16)->getImm();
2737     if (sopkIsZext(MI)) {
2738       if (!isUInt<16>(Imm)) {
2739         ErrInfo = "invalid immediate for SOPK instruction";
2740         return false;
2741       }
2742     } else {
2743       if (!isInt<16>(Imm)) {
2744         ErrInfo = "invalid immediate for SOPK instruction";
2745         return false;
2746       }
2747     }
2748   }
2749 
2750   if (Desc.getOpcode() == AMDGPU::V_MOVRELS_B32_e32 ||
2751       Desc.getOpcode() == AMDGPU::V_MOVRELS_B32_e64 ||
2752       Desc.getOpcode() == AMDGPU::V_MOVRELD_B32_e32 ||
2753       Desc.getOpcode() == AMDGPU::V_MOVRELD_B32_e64) {
2754     const bool IsDst = Desc.getOpcode() == AMDGPU::V_MOVRELD_B32_e32 ||
2755                        Desc.getOpcode() == AMDGPU::V_MOVRELD_B32_e64;
2756 
2757     const unsigned StaticNumOps = Desc.getNumOperands() +
2758       Desc.getNumImplicitUses();
2759     const unsigned NumImplicitOps = IsDst ? 2 : 1;
2760 
2761     // Allow additional implicit operands. This allows a fixup done by the post
2762     // RA scheduler where the main implicit operand is killed and implicit-defs
2763     // are added for sub-registers that remain live after this instruction.
2764     if (MI.getNumOperands() < StaticNumOps + NumImplicitOps) {
2765       ErrInfo = "missing implicit register operands";
2766       return false;
2767     }
2768 
2769     const MachineOperand *Dst = getNamedOperand(MI, AMDGPU::OpName::vdst);
2770     if (IsDst) {
2771       if (!Dst->isUse()) {
2772         ErrInfo = "v_movreld_b32 vdst should be a use operand";
2773         return false;
2774       }
2775 
2776       unsigned UseOpIdx;
2777       if (!MI.isRegTiedToUseOperand(StaticNumOps, &UseOpIdx) ||
2778           UseOpIdx != StaticNumOps + 1) {
2779         ErrInfo = "movrel implicit operands should be tied";
2780         return false;
2781       }
2782     }
2783 
2784     const MachineOperand &Src0 = MI.getOperand(Src0Idx);
2785     const MachineOperand &ImpUse
2786       = MI.getOperand(StaticNumOps + NumImplicitOps - 1);
2787     if (!ImpUse.isReg() || !ImpUse.isUse() ||
2788         !isSubRegOf(RI, ImpUse, IsDst ? *Dst : Src0)) {
2789       ErrInfo = "src0 should be subreg of implicit vector use";
2790       return false;
2791     }
2792   }
2793 
2794   // Make sure we aren't losing exec uses in the td files. This mostly requires
2795   // being careful when using let Uses to try to add other use registers.
2796   if (shouldReadExec(MI)) {
2797     if (!MI.hasRegisterImplicitUseOperand(AMDGPU::EXEC)) {
2798       ErrInfo = "VALU instruction does not implicitly read exec mask";
2799       return false;
2800     }
2801   }
2802 
2803   if (isSMRD(MI)) {
2804     if (MI.mayStore()) {
2805       // The register offset form of scalar stores may only use m0 as the
2806       // soffset register.
2807       const MachineOperand *Soff = getNamedOperand(MI, AMDGPU::OpName::soff);
2808       if (Soff && Soff->getReg() != AMDGPU::M0) {
2809         ErrInfo = "scalar stores must use m0 as offset register";
2810         return false;
2811       }
2812     }
2813   }
2814 
2815   if (isFLAT(MI) && !MF->getSubtarget<SISubtarget>().hasFlatInstOffsets()) {
2816     const MachineOperand *Offset = getNamedOperand(MI, AMDGPU::OpName::offset);
2817     if (Offset->getImm() != 0) {
2818       ErrInfo = "subtarget does not support offsets in flat instructions";
2819       return false;
2820     }
2821   }
2822 
2823   return true;
2824 }
2825 
2826 unsigned SIInstrInfo::getVALUOp(const MachineInstr &MI) {
2827   switch (MI.getOpcode()) {
2828   default: return AMDGPU::INSTRUCTION_LIST_END;
2829   case AMDGPU::REG_SEQUENCE: return AMDGPU::REG_SEQUENCE;
2830   case AMDGPU::COPY: return AMDGPU::COPY;
2831   case AMDGPU::PHI: return AMDGPU::PHI;
2832   case AMDGPU::INSERT_SUBREG: return AMDGPU::INSERT_SUBREG;
2833   case AMDGPU::WQM: return AMDGPU::WQM;
2834   case AMDGPU::WWM: return AMDGPU::WWM;
2835   case AMDGPU::S_MOV_B32:
2836     return MI.getOperand(1).isReg() ?
2837            AMDGPU::COPY : AMDGPU::V_MOV_B32_e32;
2838   case AMDGPU::S_ADD_I32:
2839   case AMDGPU::S_ADD_U32: return AMDGPU::V_ADD_I32_e32;
2840   case AMDGPU::S_ADDC_U32: return AMDGPU::V_ADDC_U32_e32;
2841   case AMDGPU::S_SUB_I32:
2842   case AMDGPU::S_SUB_U32: return AMDGPU::V_SUB_I32_e32;
2843   case AMDGPU::S_SUBB_U32: return AMDGPU::V_SUBB_U32_e32;
2844   case AMDGPU::S_MUL_I32: return AMDGPU::V_MUL_LO_I32;
2845   case AMDGPU::S_AND_B32: return AMDGPU::V_AND_B32_e64;
2846   case AMDGPU::S_OR_B32: return AMDGPU::V_OR_B32_e64;
2847   case AMDGPU::S_XOR_B32: return AMDGPU::V_XOR_B32_e64;
2848   case AMDGPU::S_MIN_I32: return AMDGPU::V_MIN_I32_e64;
2849   case AMDGPU::S_MIN_U32: return AMDGPU::V_MIN_U32_e64;
2850   case AMDGPU::S_MAX_I32: return AMDGPU::V_MAX_I32_e64;
2851   case AMDGPU::S_MAX_U32: return AMDGPU::V_MAX_U32_e64;
2852   case AMDGPU::S_ASHR_I32: return AMDGPU::V_ASHR_I32_e32;
2853   case AMDGPU::S_ASHR_I64: return AMDGPU::V_ASHR_I64;
2854   case AMDGPU::S_LSHL_B32: return AMDGPU::V_LSHL_B32_e32;
2855   case AMDGPU::S_LSHL_B64: return AMDGPU::V_LSHL_B64;
2856   case AMDGPU::S_LSHR_B32: return AMDGPU::V_LSHR_B32_e32;
2857   case AMDGPU::S_LSHR_B64: return AMDGPU::V_LSHR_B64;
2858   case AMDGPU::S_SEXT_I32_I8: return AMDGPU::V_BFE_I32;
2859   case AMDGPU::S_SEXT_I32_I16: return AMDGPU::V_BFE_I32;
2860   case AMDGPU::S_BFE_U32: return AMDGPU::V_BFE_U32;
2861   case AMDGPU::S_BFE_I32: return AMDGPU::V_BFE_I32;
2862   case AMDGPU::S_BFM_B32: return AMDGPU::V_BFM_B32_e64;
2863   case AMDGPU::S_BREV_B32: return AMDGPU::V_BFREV_B32_e32;
2864   case AMDGPU::S_NOT_B32: return AMDGPU::V_NOT_B32_e32;
2865   case AMDGPU::S_NOT_B64: return AMDGPU::V_NOT_B32_e32;
2866   case AMDGPU::S_CMP_EQ_I32: return AMDGPU::V_CMP_EQ_I32_e32;
2867   case AMDGPU::S_CMP_LG_I32: return AMDGPU::V_CMP_NE_I32_e32;
2868   case AMDGPU::S_CMP_GT_I32: return AMDGPU::V_CMP_GT_I32_e32;
2869   case AMDGPU::S_CMP_GE_I32: return AMDGPU::V_CMP_GE_I32_e32;
2870   case AMDGPU::S_CMP_LT_I32: return AMDGPU::V_CMP_LT_I32_e32;
2871   case AMDGPU::S_CMP_LE_I32: return AMDGPU::V_CMP_LE_I32_e32;
2872   case AMDGPU::S_CMP_EQ_U32: return AMDGPU::V_CMP_EQ_U32_e32;
2873   case AMDGPU::S_CMP_LG_U32: return AMDGPU::V_CMP_NE_U32_e32;
2874   case AMDGPU::S_CMP_GT_U32: return AMDGPU::V_CMP_GT_U32_e32;
2875   case AMDGPU::S_CMP_GE_U32: return AMDGPU::V_CMP_GE_U32_e32;
2876   case AMDGPU::S_CMP_LT_U32: return AMDGPU::V_CMP_LT_U32_e32;
2877   case AMDGPU::S_CMP_LE_U32: return AMDGPU::V_CMP_LE_U32_e32;
2878   case AMDGPU::S_CMP_EQ_U64: return AMDGPU::V_CMP_EQ_U64_e32;
2879   case AMDGPU::S_CMP_LG_U64: return AMDGPU::V_CMP_NE_U64_e32;
2880   case AMDGPU::S_BCNT1_I32_B32: return AMDGPU::V_BCNT_U32_B32_e64;
2881   case AMDGPU::S_FF1_I32_B32: return AMDGPU::V_FFBL_B32_e32;
2882   case AMDGPU::S_FLBIT_I32_B32: return AMDGPU::V_FFBH_U32_e32;
2883   case AMDGPU::S_FLBIT_I32: return AMDGPU::V_FFBH_I32_e64;
2884   case AMDGPU::S_CBRANCH_SCC0: return AMDGPU::S_CBRANCH_VCCZ;
2885   case AMDGPU::S_CBRANCH_SCC1: return AMDGPU::S_CBRANCH_VCCNZ;
2886   }
2887 }
2888 
2889 bool SIInstrInfo::isSALUOpSupportedOnVALU(const MachineInstr &MI) const {
2890   return getVALUOp(MI) != AMDGPU::INSTRUCTION_LIST_END;
2891 }
2892 
2893 const TargetRegisterClass *SIInstrInfo::getOpRegClass(const MachineInstr &MI,
2894                                                       unsigned OpNo) const {
2895   const MachineRegisterInfo &MRI = MI.getParent()->getParent()->getRegInfo();
2896   const MCInstrDesc &Desc = get(MI.getOpcode());
2897   if (MI.isVariadic() || OpNo >= Desc.getNumOperands() ||
2898       Desc.OpInfo[OpNo].RegClass == -1) {
2899     unsigned Reg = MI.getOperand(OpNo).getReg();
2900 
2901     if (TargetRegisterInfo::isVirtualRegister(Reg))
2902       return MRI.getRegClass(Reg);
2903     return RI.getPhysRegClass(Reg);
2904   }
2905 
2906   unsigned RCID = Desc.OpInfo[OpNo].RegClass;
2907   return RI.getRegClass(RCID);
2908 }
2909 
2910 bool SIInstrInfo::canReadVGPR(const MachineInstr &MI, unsigned OpNo) const {
2911   switch (MI.getOpcode()) {
2912   case AMDGPU::COPY:
2913   case AMDGPU::REG_SEQUENCE:
2914   case AMDGPU::PHI:
2915   case AMDGPU::INSERT_SUBREG:
2916     return RI.hasVGPRs(getOpRegClass(MI, 0));
2917   default:
2918     return RI.hasVGPRs(getOpRegClass(MI, OpNo));
2919   }
2920 }
2921 
2922 void SIInstrInfo::legalizeOpWithMove(MachineInstr &MI, unsigned OpIdx) const {
2923   MachineBasicBlock::iterator I = MI;
2924   MachineBasicBlock *MBB = MI.getParent();
2925   MachineOperand &MO = MI.getOperand(OpIdx);
2926   MachineRegisterInfo &MRI = MBB->getParent()->getRegInfo();
2927   unsigned RCID = get(MI.getOpcode()).OpInfo[OpIdx].RegClass;
2928   const TargetRegisterClass *RC = RI.getRegClass(RCID);
2929   unsigned Opcode = AMDGPU::V_MOV_B32_e32;
2930   if (MO.isReg())
2931     Opcode = AMDGPU::COPY;
2932   else if (RI.isSGPRClass(RC))
2933     Opcode = AMDGPU::S_MOV_B32;
2934 
2935   const TargetRegisterClass *VRC = RI.getEquivalentVGPRClass(RC);
2936   if (RI.getCommonSubClass(&AMDGPU::VReg_64RegClass, VRC))
2937     VRC = &AMDGPU::VReg_64RegClass;
2938   else
2939     VRC = &AMDGPU::VGPR_32RegClass;
2940 
2941   unsigned Reg = MRI.createVirtualRegister(VRC);
2942   DebugLoc DL = MBB->findDebugLoc(I);
2943   BuildMI(*MI.getParent(), I, DL, get(Opcode), Reg).add(MO);
2944   MO.ChangeToRegister(Reg, false);
2945 }
2946 
2947 unsigned SIInstrInfo::buildExtractSubReg(MachineBasicBlock::iterator MI,
2948                                          MachineRegisterInfo &MRI,
2949                                          MachineOperand &SuperReg,
2950                                          const TargetRegisterClass *SuperRC,
2951                                          unsigned SubIdx,
2952                                          const TargetRegisterClass *SubRC)
2953                                          const {
2954   MachineBasicBlock *MBB = MI->getParent();
2955   DebugLoc DL = MI->getDebugLoc();
2956   unsigned SubReg = MRI.createVirtualRegister(SubRC);
2957 
2958   if (SuperReg.getSubReg() == AMDGPU::NoSubRegister) {
2959     BuildMI(*MBB, MI, DL, get(TargetOpcode::COPY), SubReg)
2960       .addReg(SuperReg.getReg(), 0, SubIdx);
2961     return SubReg;
2962   }
2963 
2964   // Just in case the super register is itself a sub-register, copy it to a new
2965   // value so we don't need to worry about merging its subreg index with the
2966   // SubIdx passed to this function. The register coalescer should be able to
2967   // eliminate this extra copy.
2968   unsigned NewSuperReg = MRI.createVirtualRegister(SuperRC);
2969 
2970   BuildMI(*MBB, MI, DL, get(TargetOpcode::COPY), NewSuperReg)
2971     .addReg(SuperReg.getReg(), 0, SuperReg.getSubReg());
2972 
2973   BuildMI(*MBB, MI, DL, get(TargetOpcode::COPY), SubReg)
2974     .addReg(NewSuperReg, 0, SubIdx);
2975 
2976   return SubReg;
2977 }
2978 
2979 MachineOperand SIInstrInfo::buildExtractSubRegOrImm(
2980   MachineBasicBlock::iterator MII,
2981   MachineRegisterInfo &MRI,
2982   MachineOperand &Op,
2983   const TargetRegisterClass *SuperRC,
2984   unsigned SubIdx,
2985   const TargetRegisterClass *SubRC) const {
2986   if (Op.isImm()) {
2987     if (SubIdx == AMDGPU::sub0)
2988       return MachineOperand::CreateImm(static_cast<int32_t>(Op.getImm()));
2989     if (SubIdx == AMDGPU::sub1)
2990       return MachineOperand::CreateImm(static_cast<int32_t>(Op.getImm() >> 32));
2991 
2992     llvm_unreachable("Unhandled register index for immediate");
2993   }
2994 
2995   unsigned SubReg = buildExtractSubReg(MII, MRI, Op, SuperRC,
2996                                        SubIdx, SubRC);
2997   return MachineOperand::CreateReg(SubReg, false);
2998 }
2999 
3000 // Change the order of operands from (0, 1, 2) to (0, 2, 1)
3001 void SIInstrInfo::swapOperands(MachineInstr &Inst) const {
3002   assert(Inst.getNumExplicitOperands() == 3);
3003   MachineOperand Op1 = Inst.getOperand(1);
3004   Inst.RemoveOperand(1);
3005   Inst.addOperand(Op1);
3006 }
3007 
3008 bool SIInstrInfo::isLegalRegOperand(const MachineRegisterInfo &MRI,
3009                                     const MCOperandInfo &OpInfo,
3010                                     const MachineOperand &MO) const {
3011   if (!MO.isReg())
3012     return false;
3013 
3014   unsigned Reg = MO.getReg();
3015   const TargetRegisterClass *RC =
3016     TargetRegisterInfo::isVirtualRegister(Reg) ?
3017     MRI.getRegClass(Reg) :
3018     RI.getPhysRegClass(Reg);
3019 
3020   const SIRegisterInfo *TRI =
3021       static_cast<const SIRegisterInfo*>(MRI.getTargetRegisterInfo());
3022   RC = TRI->getSubRegClass(RC, MO.getSubReg());
3023 
3024   // In order to be legal, the common sub-class must be equal to the
3025   // class of the current operand.  For example:
3026   //
3027   // v_mov_b32 s0 ; Operand defined as vsrc_b32
3028   //              ; RI.getCommonSubClass(s0,vsrc_b32) = sgpr ; LEGAL
3029   //
3030   // s_sendmsg 0, s0 ; Operand defined as m0reg
3031   //                 ; RI.getCommonSubClass(s0,m0reg) = m0reg ; NOT LEGAL
3032 
3033   return RI.getCommonSubClass(RC, RI.getRegClass(OpInfo.RegClass)) == RC;
3034 }
3035 
3036 bool SIInstrInfo::isLegalVSrcOperand(const MachineRegisterInfo &MRI,
3037                                      const MCOperandInfo &OpInfo,
3038                                      const MachineOperand &MO) const {
3039   if (MO.isReg())
3040     return isLegalRegOperand(MRI, OpInfo, MO);
3041 
3042   // Handle non-register types that are treated like immediates.
3043   assert(MO.isImm() || MO.isTargetIndex() || MO.isFI());
3044   return true;
3045 }
3046 
3047 bool SIInstrInfo::isOperandLegal(const MachineInstr &MI, unsigned OpIdx,
3048                                  const MachineOperand *MO) const {
3049   const MachineRegisterInfo &MRI = MI.getParent()->getParent()->getRegInfo();
3050   const MCInstrDesc &InstDesc = MI.getDesc();
3051   const MCOperandInfo &OpInfo = InstDesc.OpInfo[OpIdx];
3052   const TargetRegisterClass *DefinedRC =
3053       OpInfo.RegClass != -1 ? RI.getRegClass(OpInfo.RegClass) : nullptr;
3054   if (!MO)
3055     MO = &MI.getOperand(OpIdx);
3056 
3057   if (isVALU(MI) && usesConstantBus(MRI, *MO, OpInfo)) {
3058 
3059     RegSubRegPair SGPRUsed;
3060     if (MO->isReg())
3061       SGPRUsed = RegSubRegPair(MO->getReg(), MO->getSubReg());
3062 
3063     for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
3064       if (i == OpIdx)
3065         continue;
3066       const MachineOperand &Op = MI.getOperand(i);
3067       if (Op.isReg()) {
3068         if ((Op.getReg() != SGPRUsed.Reg || Op.getSubReg() != SGPRUsed.SubReg) &&
3069             usesConstantBus(MRI, Op, InstDesc.OpInfo[i])) {
3070           return false;
3071         }
3072       } else if (InstDesc.OpInfo[i].OperandType == AMDGPU::OPERAND_KIMM32) {
3073         return false;
3074       }
3075     }
3076   }
3077 
3078   if (MO->isReg()) {
3079     assert(DefinedRC);
3080     return isLegalRegOperand(MRI, OpInfo, *MO);
3081   }
3082 
3083   // Handle non-register types that are treated like immediates.
3084   assert(MO->isImm() || MO->isTargetIndex() || MO->isFI());
3085 
3086   if (!DefinedRC) {
3087     // This operand expects an immediate.
3088     return true;
3089   }
3090 
3091   return isImmOperandLegal(MI, OpIdx, *MO);
3092 }
3093 
3094 void SIInstrInfo::legalizeOperandsVOP2(MachineRegisterInfo &MRI,
3095                                        MachineInstr &MI) const {
3096   unsigned Opc = MI.getOpcode();
3097   const MCInstrDesc &InstrDesc = get(Opc);
3098 
3099   int Src1Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1);
3100   MachineOperand &Src1 = MI.getOperand(Src1Idx);
3101 
3102   // If there is an implicit SGPR use such as VCC use for v_addc_u32/v_subb_u32
3103   // we need to only have one constant bus use.
3104   //
3105   // Note we do not need to worry about literal constants here. They are
3106   // disabled for the operand type for instructions because they will always
3107   // violate the one constant bus use rule.
3108   bool HasImplicitSGPR = findImplicitSGPRRead(MI) != AMDGPU::NoRegister;
3109   if (HasImplicitSGPR) {
3110     int Src0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0);
3111     MachineOperand &Src0 = MI.getOperand(Src0Idx);
3112 
3113     if (Src0.isReg() && RI.isSGPRReg(MRI, Src0.getReg()))
3114       legalizeOpWithMove(MI, Src0Idx);
3115   }
3116 
3117   // VOP2 src0 instructions support all operand types, so we don't need to check
3118   // their legality. If src1 is already legal, we don't need to do anything.
3119   if (isLegalRegOperand(MRI, InstrDesc.OpInfo[Src1Idx], Src1))
3120     return;
3121 
3122   // Special case: V_READLANE_B32 accepts only immediate or SGPR operands for
3123   // lane select. Fix up using V_READFIRSTLANE, since we assume that the lane
3124   // select is uniform.
3125   if (Opc == AMDGPU::V_READLANE_B32 && Src1.isReg() &&
3126       RI.isVGPR(MRI, Src1.getReg())) {
3127     unsigned Reg = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
3128     const DebugLoc &DL = MI.getDebugLoc();
3129     BuildMI(*MI.getParent(), MI, DL, get(AMDGPU::V_READFIRSTLANE_B32), Reg)
3130         .add(Src1);
3131     Src1.ChangeToRegister(Reg, false);
3132     return;
3133   }
3134 
3135   // We do not use commuteInstruction here because it is too aggressive and will
3136   // commute if it is possible. We only want to commute here if it improves
3137   // legality. This can be called a fairly large number of times so don't waste
3138   // compile time pointlessly swapping and checking legality again.
3139   if (HasImplicitSGPR || !MI.isCommutable()) {
3140     legalizeOpWithMove(MI, Src1Idx);
3141     return;
3142   }
3143 
3144   int Src0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0);
3145   MachineOperand &Src0 = MI.getOperand(Src0Idx);
3146 
3147   // If src0 can be used as src1, commuting will make the operands legal.
3148   // Otherwise we have to give up and insert a move.
3149   //
3150   // TODO: Other immediate-like operand kinds could be commuted if there was a
3151   // MachineOperand::ChangeTo* for them.
3152   if ((!Src1.isImm() && !Src1.isReg()) ||
3153       !isLegalRegOperand(MRI, InstrDesc.OpInfo[Src1Idx], Src0)) {
3154     legalizeOpWithMove(MI, Src1Idx);
3155     return;
3156   }
3157 
3158   int CommutedOpc = commuteOpcode(MI);
3159   if (CommutedOpc == -1) {
3160     legalizeOpWithMove(MI, Src1Idx);
3161     return;
3162   }
3163 
3164   MI.setDesc(get(CommutedOpc));
3165 
3166   unsigned Src0Reg = Src0.getReg();
3167   unsigned Src0SubReg = Src0.getSubReg();
3168   bool Src0Kill = Src0.isKill();
3169 
3170   if (Src1.isImm())
3171     Src0.ChangeToImmediate(Src1.getImm());
3172   else if (Src1.isReg()) {
3173     Src0.ChangeToRegister(Src1.getReg(), false, false, Src1.isKill());
3174     Src0.setSubReg(Src1.getSubReg());
3175   } else
3176     llvm_unreachable("Should only have register or immediate operands");
3177 
3178   Src1.ChangeToRegister(Src0Reg, false, false, Src0Kill);
3179   Src1.setSubReg(Src0SubReg);
3180 }
3181 
3182 // Legalize VOP3 operands. Because all operand types are supported for any
3183 // operand, and since literal constants are not allowed and should never be
3184 // seen, we only need to worry about inserting copies if we use multiple SGPR
3185 // operands.
3186 void SIInstrInfo::legalizeOperandsVOP3(MachineRegisterInfo &MRI,
3187                                        MachineInstr &MI) const {
3188   unsigned Opc = MI.getOpcode();
3189 
3190   int VOP3Idx[3] = {
3191     AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0),
3192     AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1),
3193     AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2)
3194   };
3195 
3196   // Find the one SGPR operand we are allowed to use.
3197   unsigned SGPRReg = findUsedSGPR(MI, VOP3Idx);
3198 
3199   for (unsigned i = 0; i < 3; ++i) {
3200     int Idx = VOP3Idx[i];
3201     if (Idx == -1)
3202       break;
3203     MachineOperand &MO = MI.getOperand(Idx);
3204 
3205     // We should never see a VOP3 instruction with an illegal immediate operand.
3206     if (!MO.isReg())
3207       continue;
3208 
3209     if (!RI.isSGPRClass(MRI.getRegClass(MO.getReg())))
3210       continue; // VGPRs are legal
3211 
3212     if (SGPRReg == AMDGPU::NoRegister || SGPRReg == MO.getReg()) {
3213       SGPRReg = MO.getReg();
3214       // We can use one SGPR in each VOP3 instruction.
3215       continue;
3216     }
3217 
3218     // If we make it this far, then the operand is not legal and we must
3219     // legalize it.
3220     legalizeOpWithMove(MI, Idx);
3221   }
3222 }
3223 
3224 unsigned SIInstrInfo::readlaneVGPRToSGPR(unsigned SrcReg, MachineInstr &UseMI,
3225                                          MachineRegisterInfo &MRI) const {
3226   const TargetRegisterClass *VRC = MRI.getRegClass(SrcReg);
3227   const TargetRegisterClass *SRC = RI.getEquivalentSGPRClass(VRC);
3228   unsigned DstReg = MRI.createVirtualRegister(SRC);
3229   unsigned SubRegs = RI.getRegSizeInBits(*VRC) / 32;
3230 
3231   SmallVector<unsigned, 8> SRegs;
3232   for (unsigned i = 0; i < SubRegs; ++i) {
3233     unsigned SGPR = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
3234     BuildMI(*UseMI.getParent(), UseMI, UseMI.getDebugLoc(),
3235             get(AMDGPU::V_READFIRSTLANE_B32), SGPR)
3236         .addReg(SrcReg, 0, RI.getSubRegFromChannel(i));
3237     SRegs.push_back(SGPR);
3238   }
3239 
3240   MachineInstrBuilder MIB =
3241       BuildMI(*UseMI.getParent(), UseMI, UseMI.getDebugLoc(),
3242               get(AMDGPU::REG_SEQUENCE), DstReg);
3243   for (unsigned i = 0; i < SubRegs; ++i) {
3244     MIB.addReg(SRegs[i]);
3245     MIB.addImm(RI.getSubRegFromChannel(i));
3246   }
3247   return DstReg;
3248 }
3249 
3250 void SIInstrInfo::legalizeOperandsSMRD(MachineRegisterInfo &MRI,
3251                                        MachineInstr &MI) const {
3252 
3253   // If the pointer is store in VGPRs, then we need to move them to
3254   // SGPRs using v_readfirstlane.  This is safe because we only select
3255   // loads with uniform pointers to SMRD instruction so we know the
3256   // pointer value is uniform.
3257   MachineOperand *SBase = getNamedOperand(MI, AMDGPU::OpName::sbase);
3258   if (SBase && !RI.isSGPRClass(MRI.getRegClass(SBase->getReg()))) {
3259       unsigned SGPR = readlaneVGPRToSGPR(SBase->getReg(), MI, MRI);
3260       SBase->setReg(SGPR);
3261   }
3262 }
3263 
3264 void SIInstrInfo::legalizeGenericOperand(MachineBasicBlock &InsertMBB,
3265                                          MachineBasicBlock::iterator I,
3266                                          const TargetRegisterClass *DstRC,
3267                                          MachineOperand &Op,
3268                                          MachineRegisterInfo &MRI,
3269                                          const DebugLoc &DL) const {
3270   unsigned OpReg = Op.getReg();
3271   unsigned OpSubReg = Op.getSubReg();
3272 
3273   const TargetRegisterClass *OpRC = RI.getSubClassWithSubReg(
3274       RI.getRegClassForReg(MRI, OpReg), OpSubReg);
3275 
3276   // Check if operand is already the correct register class.
3277   if (DstRC == OpRC)
3278     return;
3279 
3280   unsigned DstReg = MRI.createVirtualRegister(DstRC);
3281   MachineInstr *Copy =
3282       BuildMI(InsertMBB, I, DL, get(AMDGPU::COPY), DstReg).add(Op);
3283 
3284   Op.setReg(DstReg);
3285   Op.setSubReg(0);
3286 
3287   MachineInstr *Def = MRI.getVRegDef(OpReg);
3288   if (!Def)
3289     return;
3290 
3291   // Try to eliminate the copy if it is copying an immediate value.
3292   if (Def->isMoveImmediate())
3293     FoldImmediate(*Copy, *Def, OpReg, &MRI);
3294 }
3295 
3296 void SIInstrInfo::legalizeOperands(MachineInstr &MI) const {
3297   MachineFunction &MF = *MI.getParent()->getParent();
3298   MachineRegisterInfo &MRI = MF.getRegInfo();
3299 
3300   // Legalize VOP2
3301   if (isVOP2(MI) || isVOPC(MI)) {
3302     legalizeOperandsVOP2(MRI, MI);
3303     return;
3304   }
3305 
3306   // Legalize VOP3
3307   if (isVOP3(MI)) {
3308     legalizeOperandsVOP3(MRI, MI);
3309     return;
3310   }
3311 
3312   // Legalize SMRD
3313   if (isSMRD(MI)) {
3314     legalizeOperandsSMRD(MRI, MI);
3315     return;
3316   }
3317 
3318   // Legalize REG_SEQUENCE and PHI
3319   // The register class of the operands much be the same type as the register
3320   // class of the output.
3321   if (MI.getOpcode() == AMDGPU::PHI) {
3322     const TargetRegisterClass *RC = nullptr, *SRC = nullptr, *VRC = nullptr;
3323     for (unsigned i = 1, e = MI.getNumOperands(); i != e; i += 2) {
3324       if (!MI.getOperand(i).isReg() ||
3325           !TargetRegisterInfo::isVirtualRegister(MI.getOperand(i).getReg()))
3326         continue;
3327       const TargetRegisterClass *OpRC =
3328           MRI.getRegClass(MI.getOperand(i).getReg());
3329       if (RI.hasVGPRs(OpRC)) {
3330         VRC = OpRC;
3331       } else {
3332         SRC = OpRC;
3333       }
3334     }
3335 
3336     // If any of the operands are VGPR registers, then they all most be
3337     // otherwise we will create illegal VGPR->SGPR copies when legalizing
3338     // them.
3339     if (VRC || !RI.isSGPRClass(getOpRegClass(MI, 0))) {
3340       if (!VRC) {
3341         assert(SRC);
3342         VRC = RI.getEquivalentVGPRClass(SRC);
3343       }
3344       RC = VRC;
3345     } else {
3346       RC = SRC;
3347     }
3348 
3349     // Update all the operands so they have the same type.
3350     for (unsigned I = 1, E = MI.getNumOperands(); I != E; I += 2) {
3351       MachineOperand &Op = MI.getOperand(I);
3352       if (!Op.isReg() || !TargetRegisterInfo::isVirtualRegister(Op.getReg()))
3353         continue;
3354 
3355       // MI is a PHI instruction.
3356       MachineBasicBlock *InsertBB = MI.getOperand(I + 1).getMBB();
3357       MachineBasicBlock::iterator Insert = InsertBB->getFirstTerminator();
3358 
3359       // Avoid creating no-op copies with the same src and dst reg class.  These
3360       // confuse some of the machine passes.
3361       legalizeGenericOperand(*InsertBB, Insert, RC, Op, MRI, MI.getDebugLoc());
3362     }
3363   }
3364 
3365   // REG_SEQUENCE doesn't really require operand legalization, but if one has a
3366   // VGPR dest type and SGPR sources, insert copies so all operands are
3367   // VGPRs. This seems to help operand folding / the register coalescer.
3368   if (MI.getOpcode() == AMDGPU::REG_SEQUENCE) {
3369     MachineBasicBlock *MBB = MI.getParent();
3370     const TargetRegisterClass *DstRC = getOpRegClass(MI, 0);
3371     if (RI.hasVGPRs(DstRC)) {
3372       // Update all the operands so they are VGPR register classes. These may
3373       // not be the same register class because REG_SEQUENCE supports mixing
3374       // subregister index types e.g. sub0_sub1 + sub2 + sub3
3375       for (unsigned I = 1, E = MI.getNumOperands(); I != E; I += 2) {
3376         MachineOperand &Op = MI.getOperand(I);
3377         if (!Op.isReg() || !TargetRegisterInfo::isVirtualRegister(Op.getReg()))
3378           continue;
3379 
3380         const TargetRegisterClass *OpRC = MRI.getRegClass(Op.getReg());
3381         const TargetRegisterClass *VRC = RI.getEquivalentVGPRClass(OpRC);
3382         if (VRC == OpRC)
3383           continue;
3384 
3385         legalizeGenericOperand(*MBB, MI, VRC, Op, MRI, MI.getDebugLoc());
3386         Op.setIsKill();
3387       }
3388     }
3389 
3390     return;
3391   }
3392 
3393   // Legalize INSERT_SUBREG
3394   // src0 must have the same register class as dst
3395   if (MI.getOpcode() == AMDGPU::INSERT_SUBREG) {
3396     unsigned Dst = MI.getOperand(0).getReg();
3397     unsigned Src0 = MI.getOperand(1).getReg();
3398     const TargetRegisterClass *DstRC = MRI.getRegClass(Dst);
3399     const TargetRegisterClass *Src0RC = MRI.getRegClass(Src0);
3400     if (DstRC != Src0RC) {
3401       MachineBasicBlock *MBB = MI.getParent();
3402       MachineOperand &Op = MI.getOperand(1);
3403       legalizeGenericOperand(*MBB, MI, DstRC, Op, MRI, MI.getDebugLoc());
3404     }
3405     return;
3406   }
3407 
3408   // Legalize MIMG and MUBUF/MTBUF for shaders.
3409   //
3410   // Shaders only generate MUBUF/MTBUF instructions via intrinsics or via
3411   // scratch memory access. In both cases, the legalization never involves
3412   // conversion to the addr64 form.
3413   if (isMIMG(MI) ||
3414       (AMDGPU::isShader(MF.getFunction()->getCallingConv()) &&
3415        (isMUBUF(MI) || isMTBUF(MI)))) {
3416     MachineOperand *SRsrc = getNamedOperand(MI, AMDGPU::OpName::srsrc);
3417     if (SRsrc && !RI.isSGPRClass(MRI.getRegClass(SRsrc->getReg()))) {
3418       unsigned SGPR = readlaneVGPRToSGPR(SRsrc->getReg(), MI, MRI);
3419       SRsrc->setReg(SGPR);
3420     }
3421 
3422     MachineOperand *SSamp = getNamedOperand(MI, AMDGPU::OpName::ssamp);
3423     if (SSamp && !RI.isSGPRClass(MRI.getRegClass(SSamp->getReg()))) {
3424       unsigned SGPR = readlaneVGPRToSGPR(SSamp->getReg(), MI, MRI);
3425       SSamp->setReg(SGPR);
3426     }
3427     return;
3428   }
3429 
3430   // Legalize MUBUF* instructions by converting to addr64 form.
3431   // FIXME: If we start using the non-addr64 instructions for compute, we
3432   // may need to legalize them as above. This especially applies to the
3433   // buffer_load_format_* variants and variants with idxen (or bothen).
3434   int SRsrcIdx =
3435       AMDGPU::getNamedOperandIdx(MI.getOpcode(), AMDGPU::OpName::srsrc);
3436   if (SRsrcIdx != -1) {
3437     // We have an MUBUF instruction
3438     MachineOperand *SRsrc = &MI.getOperand(SRsrcIdx);
3439     unsigned SRsrcRC = get(MI.getOpcode()).OpInfo[SRsrcIdx].RegClass;
3440     if (RI.getCommonSubClass(MRI.getRegClass(SRsrc->getReg()),
3441                                              RI.getRegClass(SRsrcRC))) {
3442       // The operands are legal.
3443       // FIXME: We may need to legalize operands besided srsrc.
3444       return;
3445     }
3446 
3447     MachineBasicBlock &MBB = *MI.getParent();
3448 
3449     // Extract the ptr from the resource descriptor.
3450     unsigned SRsrcPtr = buildExtractSubReg(MI, MRI, *SRsrc,
3451       &AMDGPU::VReg_128RegClass, AMDGPU::sub0_sub1, &AMDGPU::VReg_64RegClass);
3452 
3453     // Create an empty resource descriptor
3454     unsigned Zero64 = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
3455     unsigned SRsrcFormatLo = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
3456     unsigned SRsrcFormatHi = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
3457     unsigned NewSRsrc = MRI.createVirtualRegister(&AMDGPU::SReg_128RegClass);
3458     uint64_t RsrcDataFormat = getDefaultRsrcDataFormat();
3459 
3460     // Zero64 = 0
3461     BuildMI(MBB, MI, MI.getDebugLoc(), get(AMDGPU::S_MOV_B64), Zero64)
3462         .addImm(0);
3463 
3464     // SRsrcFormatLo = RSRC_DATA_FORMAT{31-0}
3465     BuildMI(MBB, MI, MI.getDebugLoc(), get(AMDGPU::S_MOV_B32), SRsrcFormatLo)
3466         .addImm(RsrcDataFormat & 0xFFFFFFFF);
3467 
3468     // SRsrcFormatHi = RSRC_DATA_FORMAT{63-32}
3469     BuildMI(MBB, MI, MI.getDebugLoc(), get(AMDGPU::S_MOV_B32), SRsrcFormatHi)
3470         .addImm(RsrcDataFormat >> 32);
3471 
3472     // NewSRsrc = {Zero64, SRsrcFormat}
3473     BuildMI(MBB, MI, MI.getDebugLoc(), get(AMDGPU::REG_SEQUENCE), NewSRsrc)
3474         .addReg(Zero64)
3475         .addImm(AMDGPU::sub0_sub1)
3476         .addReg(SRsrcFormatLo)
3477         .addImm(AMDGPU::sub2)
3478         .addReg(SRsrcFormatHi)
3479         .addImm(AMDGPU::sub3);
3480 
3481     MachineOperand *VAddr = getNamedOperand(MI, AMDGPU::OpName::vaddr);
3482     unsigned NewVAddr = MRI.createVirtualRegister(&AMDGPU::VReg_64RegClass);
3483     if (VAddr) {
3484       // This is already an ADDR64 instruction so we need to add the pointer
3485       // extracted from the resource descriptor to the current value of VAddr.
3486       unsigned NewVAddrLo = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
3487       unsigned NewVAddrHi = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
3488 
3489       // NewVaddrLo = SRsrcPtr:sub0 + VAddr:sub0
3490       DebugLoc DL = MI.getDebugLoc();
3491       BuildMI(MBB, MI, DL, get(AMDGPU::V_ADD_I32_e32), NewVAddrLo)
3492         .addReg(SRsrcPtr, 0, AMDGPU::sub0)
3493         .addReg(VAddr->getReg(), 0, AMDGPU::sub0);
3494 
3495       // NewVaddrHi = SRsrcPtr:sub1 + VAddr:sub1
3496       BuildMI(MBB, MI, DL, get(AMDGPU::V_ADDC_U32_e32), NewVAddrHi)
3497         .addReg(SRsrcPtr, 0, AMDGPU::sub1)
3498         .addReg(VAddr->getReg(), 0, AMDGPU::sub1);
3499 
3500       // NewVaddr = {NewVaddrHi, NewVaddrLo}
3501       BuildMI(MBB, MI, MI.getDebugLoc(), get(AMDGPU::REG_SEQUENCE), NewVAddr)
3502           .addReg(NewVAddrLo)
3503           .addImm(AMDGPU::sub0)
3504           .addReg(NewVAddrHi)
3505           .addImm(AMDGPU::sub1);
3506     } else {
3507       // This instructions is the _OFFSET variant, so we need to convert it to
3508       // ADDR64.
3509       assert(MBB.getParent()->getSubtarget<SISubtarget>().getGeneration()
3510              < SISubtarget::VOLCANIC_ISLANDS &&
3511              "FIXME: Need to emit flat atomics here");
3512 
3513       MachineOperand *VData = getNamedOperand(MI, AMDGPU::OpName::vdata);
3514       MachineOperand *Offset = getNamedOperand(MI, AMDGPU::OpName::offset);
3515       MachineOperand *SOffset = getNamedOperand(MI, AMDGPU::OpName::soffset);
3516       unsigned Addr64Opcode = AMDGPU::getAddr64Inst(MI.getOpcode());
3517 
3518       // Atomics rith return have have an additional tied operand and are
3519       // missing some of the special bits.
3520       MachineOperand *VDataIn = getNamedOperand(MI, AMDGPU::OpName::vdata_in);
3521       MachineInstr *Addr64;
3522 
3523       if (!VDataIn) {
3524         // Regular buffer load / store.
3525         MachineInstrBuilder MIB =
3526             BuildMI(MBB, MI, MI.getDebugLoc(), get(Addr64Opcode))
3527                 .add(*VData)
3528                 .addReg(AMDGPU::NoRegister) // Dummy value for vaddr.
3529                 // This will be replaced later
3530                 // with the new value of vaddr.
3531                 .add(*SRsrc)
3532                 .add(*SOffset)
3533                 .add(*Offset);
3534 
3535         // Atomics do not have this operand.
3536         if (const MachineOperand *GLC =
3537                 getNamedOperand(MI, AMDGPU::OpName::glc)) {
3538           MIB.addImm(GLC->getImm());
3539         }
3540 
3541         MIB.addImm(getNamedImmOperand(MI, AMDGPU::OpName::slc));
3542 
3543         if (const MachineOperand *TFE =
3544                 getNamedOperand(MI, AMDGPU::OpName::tfe)) {
3545           MIB.addImm(TFE->getImm());
3546         }
3547 
3548         MIB.setMemRefs(MI.memoperands_begin(), MI.memoperands_end());
3549         Addr64 = MIB;
3550       } else {
3551         // Atomics with return.
3552         Addr64 = BuildMI(MBB, MI, MI.getDebugLoc(), get(Addr64Opcode))
3553                      .add(*VData)
3554                      .add(*VDataIn)
3555                      .addReg(AMDGPU::NoRegister) // Dummy value for vaddr.
3556                      // This will be replaced later
3557                      // with the new value of vaddr.
3558                      .add(*SRsrc)
3559                      .add(*SOffset)
3560                      .add(*Offset)
3561                      .addImm(getNamedImmOperand(MI, AMDGPU::OpName::slc))
3562                      .setMemRefs(MI.memoperands_begin(), MI.memoperands_end());
3563       }
3564 
3565       MI.removeFromParent();
3566 
3567       // NewVaddr = {NewVaddrHi, NewVaddrLo}
3568       BuildMI(MBB, Addr64, Addr64->getDebugLoc(), get(AMDGPU::REG_SEQUENCE),
3569               NewVAddr)
3570           .addReg(SRsrcPtr, 0, AMDGPU::sub0)
3571           .addImm(AMDGPU::sub0)
3572           .addReg(SRsrcPtr, 0, AMDGPU::sub1)
3573           .addImm(AMDGPU::sub1);
3574 
3575       VAddr = getNamedOperand(*Addr64, AMDGPU::OpName::vaddr);
3576       SRsrc = getNamedOperand(*Addr64, AMDGPU::OpName::srsrc);
3577     }
3578 
3579     // Update the instruction to use NewVaddr
3580     VAddr->setReg(NewVAddr);
3581     // Update the instruction to use NewSRsrc
3582     SRsrc->setReg(NewSRsrc);
3583   }
3584 }
3585 
3586 void SIInstrInfo::moveToVALU(MachineInstr &TopInst) const {
3587   SetVectorType Worklist;
3588   Worklist.insert(&TopInst);
3589 
3590   while (!Worklist.empty()) {
3591     MachineInstr &Inst = *Worklist.pop_back_val();
3592     MachineBasicBlock *MBB = Inst.getParent();
3593     MachineRegisterInfo &MRI = MBB->getParent()->getRegInfo();
3594 
3595     unsigned Opcode = Inst.getOpcode();
3596     unsigned NewOpcode = getVALUOp(Inst);
3597 
3598     // Handle some special cases
3599     switch (Opcode) {
3600     default:
3601       break;
3602     case AMDGPU::S_AND_B64:
3603       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::V_AND_B32_e64);
3604       Inst.eraseFromParent();
3605       continue;
3606 
3607     case AMDGPU::S_OR_B64:
3608       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::V_OR_B32_e64);
3609       Inst.eraseFromParent();
3610       continue;
3611 
3612     case AMDGPU::S_XOR_B64:
3613       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::V_XOR_B32_e64);
3614       Inst.eraseFromParent();
3615       continue;
3616 
3617     case AMDGPU::S_NOT_B64:
3618       splitScalar64BitUnaryOp(Worklist, Inst, AMDGPU::V_NOT_B32_e32);
3619       Inst.eraseFromParent();
3620       continue;
3621 
3622     case AMDGPU::S_BCNT1_I32_B64:
3623       splitScalar64BitBCNT(Worklist, Inst);
3624       Inst.eraseFromParent();
3625       continue;
3626 
3627     case AMDGPU::S_BFE_I64:
3628       splitScalar64BitBFE(Worklist, Inst);
3629       Inst.eraseFromParent();
3630       continue;
3631 
3632     case AMDGPU::S_LSHL_B32:
3633       if (ST.getGeneration() >= SISubtarget::VOLCANIC_ISLANDS) {
3634         NewOpcode = AMDGPU::V_LSHLREV_B32_e64;
3635         swapOperands(Inst);
3636       }
3637       break;
3638     case AMDGPU::S_ASHR_I32:
3639       if (ST.getGeneration() >= SISubtarget::VOLCANIC_ISLANDS) {
3640         NewOpcode = AMDGPU::V_ASHRREV_I32_e64;
3641         swapOperands(Inst);
3642       }
3643       break;
3644     case AMDGPU::S_LSHR_B32:
3645       if (ST.getGeneration() >= SISubtarget::VOLCANIC_ISLANDS) {
3646         NewOpcode = AMDGPU::V_LSHRREV_B32_e64;
3647         swapOperands(Inst);
3648       }
3649       break;
3650     case AMDGPU::S_LSHL_B64:
3651       if (ST.getGeneration() >= SISubtarget::VOLCANIC_ISLANDS) {
3652         NewOpcode = AMDGPU::V_LSHLREV_B64;
3653         swapOperands(Inst);
3654       }
3655       break;
3656     case AMDGPU::S_ASHR_I64:
3657       if (ST.getGeneration() >= SISubtarget::VOLCANIC_ISLANDS) {
3658         NewOpcode = AMDGPU::V_ASHRREV_I64;
3659         swapOperands(Inst);
3660       }
3661       break;
3662     case AMDGPU::S_LSHR_B64:
3663       if (ST.getGeneration() >= SISubtarget::VOLCANIC_ISLANDS) {
3664         NewOpcode = AMDGPU::V_LSHRREV_B64;
3665         swapOperands(Inst);
3666       }
3667       break;
3668 
3669     case AMDGPU::S_ABS_I32:
3670       lowerScalarAbs(Worklist, Inst);
3671       Inst.eraseFromParent();
3672       continue;
3673 
3674     case AMDGPU::S_CBRANCH_SCC0:
3675     case AMDGPU::S_CBRANCH_SCC1:
3676       // Clear unused bits of vcc
3677       BuildMI(*MBB, Inst, Inst.getDebugLoc(), get(AMDGPU::S_AND_B64),
3678               AMDGPU::VCC)
3679           .addReg(AMDGPU::EXEC)
3680           .addReg(AMDGPU::VCC);
3681       break;
3682 
3683     case AMDGPU::S_BFE_U64:
3684     case AMDGPU::S_BFM_B64:
3685       llvm_unreachable("Moving this op to VALU not implemented");
3686 
3687     case AMDGPU::S_PACK_LL_B32_B16:
3688     case AMDGPU::S_PACK_LH_B32_B16:
3689     case AMDGPU::S_PACK_HH_B32_B16:
3690       movePackToVALU(Worklist, MRI, Inst);
3691       Inst.eraseFromParent();
3692       continue;
3693 
3694     case AMDGPU::S_XNOR_B32:
3695       lowerScalarXnor(Worklist, Inst);
3696       Inst.eraseFromParent();
3697       continue;
3698 
3699     case AMDGPU::S_XNOR_B64:
3700       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_XNOR_B32);
3701       Inst.eraseFromParent();
3702       continue;
3703     }
3704 
3705     if (NewOpcode == AMDGPU::INSTRUCTION_LIST_END) {
3706       // We cannot move this instruction to the VALU, so we should try to
3707       // legalize its operands instead.
3708       legalizeOperands(Inst);
3709       continue;
3710     }
3711 
3712     // Use the new VALU Opcode.
3713     const MCInstrDesc &NewDesc = get(NewOpcode);
3714     Inst.setDesc(NewDesc);
3715 
3716     // Remove any references to SCC. Vector instructions can't read from it, and
3717     // We're just about to add the implicit use / defs of VCC, and we don't want
3718     // both.
3719     for (unsigned i = Inst.getNumOperands() - 1; i > 0; --i) {
3720       MachineOperand &Op = Inst.getOperand(i);
3721       if (Op.isReg() && Op.getReg() == AMDGPU::SCC) {
3722         Inst.RemoveOperand(i);
3723         addSCCDefUsersToVALUWorklist(Inst, Worklist);
3724       }
3725     }
3726 
3727     if (Opcode == AMDGPU::S_SEXT_I32_I8 || Opcode == AMDGPU::S_SEXT_I32_I16) {
3728       // We are converting these to a BFE, so we need to add the missing
3729       // operands for the size and offset.
3730       unsigned Size = (Opcode == AMDGPU::S_SEXT_I32_I8) ? 8 : 16;
3731       Inst.addOperand(MachineOperand::CreateImm(0));
3732       Inst.addOperand(MachineOperand::CreateImm(Size));
3733 
3734     } else if (Opcode == AMDGPU::S_BCNT1_I32_B32) {
3735       // The VALU version adds the second operand to the result, so insert an
3736       // extra 0 operand.
3737       Inst.addOperand(MachineOperand::CreateImm(0));
3738     }
3739 
3740     Inst.addImplicitDefUseOperands(*Inst.getParent()->getParent());
3741 
3742     if (Opcode == AMDGPU::S_BFE_I32 || Opcode == AMDGPU::S_BFE_U32) {
3743       const MachineOperand &OffsetWidthOp = Inst.getOperand(2);
3744       // If we need to move this to VGPRs, we need to unpack the second operand
3745       // back into the 2 separate ones for bit offset and width.
3746       assert(OffsetWidthOp.isImm() &&
3747              "Scalar BFE is only implemented for constant width and offset");
3748       uint32_t Imm = OffsetWidthOp.getImm();
3749 
3750       uint32_t Offset = Imm & 0x3f; // Extract bits [5:0].
3751       uint32_t BitWidth = (Imm & 0x7f0000) >> 16; // Extract bits [22:16].
3752       Inst.RemoveOperand(2);                     // Remove old immediate.
3753       Inst.addOperand(MachineOperand::CreateImm(Offset));
3754       Inst.addOperand(MachineOperand::CreateImm(BitWidth));
3755     }
3756 
3757     bool HasDst = Inst.getOperand(0).isReg() && Inst.getOperand(0).isDef();
3758     unsigned NewDstReg = AMDGPU::NoRegister;
3759     if (HasDst) {
3760       unsigned DstReg = Inst.getOperand(0).getReg();
3761       if (TargetRegisterInfo::isPhysicalRegister(DstReg))
3762         continue;
3763 
3764       // Update the destination register class.
3765       const TargetRegisterClass *NewDstRC = getDestEquivalentVGPRClass(Inst);
3766       if (!NewDstRC)
3767         continue;
3768 
3769       if (Inst.isCopy() &&
3770           TargetRegisterInfo::isVirtualRegister(Inst.getOperand(1).getReg()) &&
3771           NewDstRC == RI.getRegClassForReg(MRI, Inst.getOperand(1).getReg())) {
3772         // Instead of creating a copy where src and dst are the same register
3773         // class, we just replace all uses of dst with src.  These kinds of
3774         // copies interfere with the heuristics MachineSink uses to decide
3775         // whether or not to split a critical edge.  Since the pass assumes
3776         // that copies will end up as machine instructions and not be
3777         // eliminated.
3778         addUsersToMoveToVALUWorklist(DstReg, MRI, Worklist);
3779         MRI.replaceRegWith(DstReg, Inst.getOperand(1).getReg());
3780         MRI.clearKillFlags(Inst.getOperand(1).getReg());
3781         Inst.getOperand(0).setReg(DstReg);
3782         continue;
3783       }
3784 
3785       NewDstReg = MRI.createVirtualRegister(NewDstRC);
3786       MRI.replaceRegWith(DstReg, NewDstReg);
3787     }
3788 
3789     // Legalize the operands
3790     legalizeOperands(Inst);
3791 
3792     if (HasDst)
3793      addUsersToMoveToVALUWorklist(NewDstReg, MRI, Worklist);
3794   }
3795 }
3796 
3797 void SIInstrInfo::lowerScalarAbs(SetVectorType &Worklist,
3798                                  MachineInstr &Inst) const {
3799   MachineBasicBlock &MBB = *Inst.getParent();
3800   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
3801   MachineBasicBlock::iterator MII = Inst;
3802   DebugLoc DL = Inst.getDebugLoc();
3803 
3804   MachineOperand &Dest = Inst.getOperand(0);
3805   MachineOperand &Src = Inst.getOperand(1);
3806   unsigned TmpReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
3807   unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
3808 
3809   BuildMI(MBB, MII, DL, get(AMDGPU::V_SUB_I32_e32), TmpReg)
3810     .addImm(0)
3811     .addReg(Src.getReg());
3812 
3813   BuildMI(MBB, MII, DL, get(AMDGPU::V_MAX_I32_e64), ResultReg)
3814     .addReg(Src.getReg())
3815     .addReg(TmpReg);
3816 
3817   MRI.replaceRegWith(Dest.getReg(), ResultReg);
3818   addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
3819 }
3820 
3821 void SIInstrInfo::lowerScalarXnor(SetVectorType &Worklist,
3822                                   MachineInstr &Inst) const {
3823   MachineBasicBlock &MBB = *Inst.getParent();
3824   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
3825   MachineBasicBlock::iterator MII = Inst;
3826   const DebugLoc &DL = Inst.getDebugLoc();
3827 
3828   MachineOperand &Dest = Inst.getOperand(0);
3829   MachineOperand &Src0 = Inst.getOperand(1);
3830   MachineOperand &Src1 = Inst.getOperand(2);
3831 
3832   legalizeGenericOperand(MBB, MII, &AMDGPU::VGPR_32RegClass, Src0, MRI, DL);
3833   legalizeGenericOperand(MBB, MII, &AMDGPU::VGPR_32RegClass, Src1, MRI, DL);
3834 
3835   unsigned Xor = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
3836   BuildMI(MBB, MII, DL, get(AMDGPU::V_XOR_B32_e64), Xor)
3837     .add(Src0)
3838     .add(Src1);
3839 
3840   unsigned Not = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
3841   BuildMI(MBB, MII, DL, get(AMDGPU::V_NOT_B32_e64), Not)
3842     .addReg(Xor);
3843 
3844   MRI.replaceRegWith(Dest.getReg(), Not);
3845   addUsersToMoveToVALUWorklist(Not, MRI, Worklist);
3846 }
3847 
3848 void SIInstrInfo::splitScalar64BitUnaryOp(
3849     SetVectorType &Worklist, MachineInstr &Inst,
3850     unsigned Opcode) const {
3851   MachineBasicBlock &MBB = *Inst.getParent();
3852   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
3853 
3854   MachineOperand &Dest = Inst.getOperand(0);
3855   MachineOperand &Src0 = Inst.getOperand(1);
3856   DebugLoc DL = Inst.getDebugLoc();
3857 
3858   MachineBasicBlock::iterator MII = Inst;
3859 
3860   const MCInstrDesc &InstDesc = get(Opcode);
3861   const TargetRegisterClass *Src0RC = Src0.isReg() ?
3862     MRI.getRegClass(Src0.getReg()) :
3863     &AMDGPU::SGPR_32RegClass;
3864 
3865   const TargetRegisterClass *Src0SubRC = RI.getSubRegClass(Src0RC, AMDGPU::sub0);
3866 
3867   MachineOperand SrcReg0Sub0 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
3868                                                        AMDGPU::sub0, Src0SubRC);
3869 
3870   const TargetRegisterClass *DestRC = MRI.getRegClass(Dest.getReg());
3871   const TargetRegisterClass *NewDestRC = RI.getEquivalentVGPRClass(DestRC);
3872   const TargetRegisterClass *NewDestSubRC = RI.getSubRegClass(NewDestRC, AMDGPU::sub0);
3873 
3874   unsigned DestSub0 = MRI.createVirtualRegister(NewDestSubRC);
3875   BuildMI(MBB, MII, DL, InstDesc, DestSub0).add(SrcReg0Sub0);
3876 
3877   MachineOperand SrcReg0Sub1 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
3878                                                        AMDGPU::sub1, Src0SubRC);
3879 
3880   unsigned DestSub1 = MRI.createVirtualRegister(NewDestSubRC);
3881   BuildMI(MBB, MII, DL, InstDesc, DestSub1).add(SrcReg0Sub1);
3882 
3883   unsigned FullDestReg = MRI.createVirtualRegister(NewDestRC);
3884   BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), FullDestReg)
3885     .addReg(DestSub0)
3886     .addImm(AMDGPU::sub0)
3887     .addReg(DestSub1)
3888     .addImm(AMDGPU::sub1);
3889 
3890   MRI.replaceRegWith(Dest.getReg(), FullDestReg);
3891 
3892   // We don't need to legalizeOperands here because for a single operand, src0
3893   // will support any kind of input.
3894 
3895   // Move all users of this moved value.
3896   addUsersToMoveToVALUWorklist(FullDestReg, MRI, Worklist);
3897 }
3898 
3899 void SIInstrInfo::splitScalar64BitBinaryOp(
3900     SetVectorType &Worklist, MachineInstr &Inst,
3901     unsigned Opcode) const {
3902   MachineBasicBlock &MBB = *Inst.getParent();
3903   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
3904 
3905   MachineOperand &Dest = Inst.getOperand(0);
3906   MachineOperand &Src0 = Inst.getOperand(1);
3907   MachineOperand &Src1 = Inst.getOperand(2);
3908   DebugLoc DL = Inst.getDebugLoc();
3909 
3910   MachineBasicBlock::iterator MII = Inst;
3911 
3912   const MCInstrDesc &InstDesc = get(Opcode);
3913   const TargetRegisterClass *Src0RC = Src0.isReg() ?
3914     MRI.getRegClass(Src0.getReg()) :
3915     &AMDGPU::SGPR_32RegClass;
3916 
3917   const TargetRegisterClass *Src0SubRC = RI.getSubRegClass(Src0RC, AMDGPU::sub0);
3918   const TargetRegisterClass *Src1RC = Src1.isReg() ?
3919     MRI.getRegClass(Src1.getReg()) :
3920     &AMDGPU::SGPR_32RegClass;
3921 
3922   const TargetRegisterClass *Src1SubRC = RI.getSubRegClass(Src1RC, AMDGPU::sub0);
3923 
3924   MachineOperand SrcReg0Sub0 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
3925                                                        AMDGPU::sub0, Src0SubRC);
3926   MachineOperand SrcReg1Sub0 = buildExtractSubRegOrImm(MII, MRI, Src1, Src1RC,
3927                                                        AMDGPU::sub0, Src1SubRC);
3928 
3929   const TargetRegisterClass *DestRC = MRI.getRegClass(Dest.getReg());
3930   const TargetRegisterClass *NewDestRC = RI.getEquivalentVGPRClass(DestRC);
3931   const TargetRegisterClass *NewDestSubRC = RI.getSubRegClass(NewDestRC, AMDGPU::sub0);
3932 
3933   unsigned DestSub0 = MRI.createVirtualRegister(NewDestSubRC);
3934   MachineInstr &LoHalf = *BuildMI(MBB, MII, DL, InstDesc, DestSub0)
3935                               .add(SrcReg0Sub0)
3936                               .add(SrcReg1Sub0);
3937 
3938   MachineOperand SrcReg0Sub1 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
3939                                                        AMDGPU::sub1, Src0SubRC);
3940   MachineOperand SrcReg1Sub1 = buildExtractSubRegOrImm(MII, MRI, Src1, Src1RC,
3941                                                        AMDGPU::sub1, Src1SubRC);
3942 
3943   unsigned DestSub1 = MRI.createVirtualRegister(NewDestSubRC);
3944   MachineInstr &HiHalf = *BuildMI(MBB, MII, DL, InstDesc, DestSub1)
3945                               .add(SrcReg0Sub1)
3946                               .add(SrcReg1Sub1);
3947 
3948   unsigned FullDestReg = MRI.createVirtualRegister(NewDestRC);
3949   BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), FullDestReg)
3950     .addReg(DestSub0)
3951     .addImm(AMDGPU::sub0)
3952     .addReg(DestSub1)
3953     .addImm(AMDGPU::sub1);
3954 
3955   MRI.replaceRegWith(Dest.getReg(), FullDestReg);
3956 
3957   // Try to legalize the operands in case we need to swap the order to keep it
3958   // valid.
3959   legalizeOperands(LoHalf);
3960   legalizeOperands(HiHalf);
3961 
3962   // Move all users of this moved vlaue.
3963   addUsersToMoveToVALUWorklist(FullDestReg, MRI, Worklist);
3964 }
3965 
3966 void SIInstrInfo::splitScalar64BitBCNT(
3967     SetVectorType &Worklist, MachineInstr &Inst) const {
3968   MachineBasicBlock &MBB = *Inst.getParent();
3969   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
3970 
3971   MachineBasicBlock::iterator MII = Inst;
3972   DebugLoc DL = Inst.getDebugLoc();
3973 
3974   MachineOperand &Dest = Inst.getOperand(0);
3975   MachineOperand &Src = Inst.getOperand(1);
3976 
3977   const MCInstrDesc &InstDesc = get(AMDGPU::V_BCNT_U32_B32_e64);
3978   const TargetRegisterClass *SrcRC = Src.isReg() ?
3979     MRI.getRegClass(Src.getReg()) :
3980     &AMDGPU::SGPR_32RegClass;
3981 
3982   unsigned MidReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
3983   unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
3984 
3985   const TargetRegisterClass *SrcSubRC = RI.getSubRegClass(SrcRC, AMDGPU::sub0);
3986 
3987   MachineOperand SrcRegSub0 = buildExtractSubRegOrImm(MII, MRI, Src, SrcRC,
3988                                                       AMDGPU::sub0, SrcSubRC);
3989   MachineOperand SrcRegSub1 = buildExtractSubRegOrImm(MII, MRI, Src, SrcRC,
3990                                                       AMDGPU::sub1, SrcSubRC);
3991 
3992   BuildMI(MBB, MII, DL, InstDesc, MidReg).add(SrcRegSub0).addImm(0);
3993 
3994   BuildMI(MBB, MII, DL, InstDesc, ResultReg).add(SrcRegSub1).addReg(MidReg);
3995 
3996   MRI.replaceRegWith(Dest.getReg(), ResultReg);
3997 
3998   // We don't need to legalize operands here. src0 for etiher instruction can be
3999   // an SGPR, and the second input is unused or determined here.
4000   addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
4001 }
4002 
4003 void SIInstrInfo::splitScalar64BitBFE(SetVectorType &Worklist,
4004                                       MachineInstr &Inst) const {
4005   MachineBasicBlock &MBB = *Inst.getParent();
4006   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4007   MachineBasicBlock::iterator MII = Inst;
4008   DebugLoc DL = Inst.getDebugLoc();
4009 
4010   MachineOperand &Dest = Inst.getOperand(0);
4011   uint32_t Imm = Inst.getOperand(2).getImm();
4012   uint32_t Offset = Imm & 0x3f; // Extract bits [5:0].
4013   uint32_t BitWidth = (Imm & 0x7f0000) >> 16; // Extract bits [22:16].
4014 
4015   (void) Offset;
4016 
4017   // Only sext_inreg cases handled.
4018   assert(Inst.getOpcode() == AMDGPU::S_BFE_I64 && BitWidth <= 32 &&
4019          Offset == 0 && "Not implemented");
4020 
4021   if (BitWidth < 32) {
4022     unsigned MidRegLo = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4023     unsigned MidRegHi = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4024     unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VReg_64RegClass);
4025 
4026     BuildMI(MBB, MII, DL, get(AMDGPU::V_BFE_I32), MidRegLo)
4027         .addReg(Inst.getOperand(1).getReg(), 0, AMDGPU::sub0)
4028         .addImm(0)
4029         .addImm(BitWidth);
4030 
4031     BuildMI(MBB, MII, DL, get(AMDGPU::V_ASHRREV_I32_e32), MidRegHi)
4032       .addImm(31)
4033       .addReg(MidRegLo);
4034 
4035     BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), ResultReg)
4036       .addReg(MidRegLo)
4037       .addImm(AMDGPU::sub0)
4038       .addReg(MidRegHi)
4039       .addImm(AMDGPU::sub1);
4040 
4041     MRI.replaceRegWith(Dest.getReg(), ResultReg);
4042     addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
4043     return;
4044   }
4045 
4046   MachineOperand &Src = Inst.getOperand(1);
4047   unsigned TmpReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4048   unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VReg_64RegClass);
4049 
4050   BuildMI(MBB, MII, DL, get(AMDGPU::V_ASHRREV_I32_e64), TmpReg)
4051     .addImm(31)
4052     .addReg(Src.getReg(), 0, AMDGPU::sub0);
4053 
4054   BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), ResultReg)
4055     .addReg(Src.getReg(), 0, AMDGPU::sub0)
4056     .addImm(AMDGPU::sub0)
4057     .addReg(TmpReg)
4058     .addImm(AMDGPU::sub1);
4059 
4060   MRI.replaceRegWith(Dest.getReg(), ResultReg);
4061   addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
4062 }
4063 
4064 void SIInstrInfo::addUsersToMoveToVALUWorklist(
4065   unsigned DstReg,
4066   MachineRegisterInfo &MRI,
4067   SetVectorType &Worklist) const {
4068   for (MachineRegisterInfo::use_iterator I = MRI.use_begin(DstReg),
4069          E = MRI.use_end(); I != E;) {
4070     MachineInstr &UseMI = *I->getParent();
4071     if (!canReadVGPR(UseMI, I.getOperandNo())) {
4072       Worklist.insert(&UseMI);
4073 
4074       do {
4075         ++I;
4076       } while (I != E && I->getParent() == &UseMI);
4077     } else {
4078       ++I;
4079     }
4080   }
4081 }
4082 
4083 void SIInstrInfo::movePackToVALU(SetVectorType &Worklist,
4084                                  MachineRegisterInfo &MRI,
4085                                  MachineInstr &Inst) const {
4086   unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4087   MachineBasicBlock *MBB = Inst.getParent();
4088   MachineOperand &Src0 = Inst.getOperand(1);
4089   MachineOperand &Src1 = Inst.getOperand(2);
4090   const DebugLoc &DL = Inst.getDebugLoc();
4091 
4092   switch (Inst.getOpcode()) {
4093   case AMDGPU::S_PACK_LL_B32_B16: {
4094     unsigned ImmReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4095     unsigned TmpReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4096 
4097     // FIXME: Can do a lot better if we know the high bits of src0 or src1 are
4098     // 0.
4099     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_MOV_B32_e32), ImmReg)
4100       .addImm(0xffff);
4101 
4102     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_AND_B32_e64), TmpReg)
4103       .addReg(ImmReg, RegState::Kill)
4104       .add(Src0);
4105 
4106     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_LSHL_OR_B32), ResultReg)
4107       .add(Src1)
4108       .addImm(16)
4109       .addReg(TmpReg, RegState::Kill);
4110     break;
4111   }
4112   case AMDGPU::S_PACK_LH_B32_B16: {
4113     unsigned ImmReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4114     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_MOV_B32_e32), ImmReg)
4115       .addImm(0xffff);
4116     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_BFI_B32), ResultReg)
4117       .addReg(ImmReg, RegState::Kill)
4118       .add(Src0)
4119       .add(Src1);
4120     break;
4121   }
4122   case AMDGPU::S_PACK_HH_B32_B16: {
4123     unsigned ImmReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4124     unsigned TmpReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4125     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_LSHRREV_B32_e64), TmpReg)
4126       .addImm(16)
4127       .add(Src0);
4128     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_MOV_B32_e32), ImmReg)
4129       .addImm(0xffff0000);
4130     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_AND_OR_B32), ResultReg)
4131       .add(Src1)
4132       .addReg(ImmReg, RegState::Kill)
4133       .addReg(TmpReg, RegState::Kill);
4134     break;
4135   }
4136   default:
4137     llvm_unreachable("unhandled s_pack_* instruction");
4138   }
4139 
4140   MachineOperand &Dest = Inst.getOperand(0);
4141   MRI.replaceRegWith(Dest.getReg(), ResultReg);
4142   addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
4143 }
4144 
4145 void SIInstrInfo::addSCCDefUsersToVALUWorklist(
4146     MachineInstr &SCCDefInst, SetVectorType &Worklist) const {
4147   // This assumes that all the users of SCC are in the same block
4148   // as the SCC def.
4149   for (MachineInstr &MI :
4150        make_range(MachineBasicBlock::iterator(SCCDefInst),
4151                       SCCDefInst.getParent()->end())) {
4152     // Exit if we find another SCC def.
4153     if (MI.findRegisterDefOperandIdx(AMDGPU::SCC) != -1)
4154       return;
4155 
4156     if (MI.findRegisterUseOperandIdx(AMDGPU::SCC) != -1)
4157       Worklist.insert(&MI);
4158   }
4159 }
4160 
4161 const TargetRegisterClass *SIInstrInfo::getDestEquivalentVGPRClass(
4162   const MachineInstr &Inst) const {
4163   const TargetRegisterClass *NewDstRC = getOpRegClass(Inst, 0);
4164 
4165   switch (Inst.getOpcode()) {
4166   // For target instructions, getOpRegClass just returns the virtual register
4167   // class associated with the operand, so we need to find an equivalent VGPR
4168   // register class in order to move the instruction to the VALU.
4169   case AMDGPU::COPY:
4170   case AMDGPU::PHI:
4171   case AMDGPU::REG_SEQUENCE:
4172   case AMDGPU::INSERT_SUBREG:
4173   case AMDGPU::WQM:
4174   case AMDGPU::WWM:
4175     if (RI.hasVGPRs(NewDstRC))
4176       return nullptr;
4177 
4178     NewDstRC = RI.getEquivalentVGPRClass(NewDstRC);
4179     if (!NewDstRC)
4180       return nullptr;
4181     return NewDstRC;
4182   default:
4183     return NewDstRC;
4184   }
4185 }
4186 
4187 // Find the one SGPR operand we are allowed to use.
4188 unsigned SIInstrInfo::findUsedSGPR(const MachineInstr &MI,
4189                                    int OpIndices[3]) const {
4190   const MCInstrDesc &Desc = MI.getDesc();
4191 
4192   // Find the one SGPR operand we are allowed to use.
4193   //
4194   // First we need to consider the instruction's operand requirements before
4195   // legalizing. Some operands are required to be SGPRs, such as implicit uses
4196   // of VCC, but we are still bound by the constant bus requirement to only use
4197   // one.
4198   //
4199   // If the operand's class is an SGPR, we can never move it.
4200 
4201   unsigned SGPRReg = findImplicitSGPRRead(MI);
4202   if (SGPRReg != AMDGPU::NoRegister)
4203     return SGPRReg;
4204 
4205   unsigned UsedSGPRs[3] = { AMDGPU::NoRegister };
4206   const MachineRegisterInfo &MRI = MI.getParent()->getParent()->getRegInfo();
4207 
4208   for (unsigned i = 0; i < 3; ++i) {
4209     int Idx = OpIndices[i];
4210     if (Idx == -1)
4211       break;
4212 
4213     const MachineOperand &MO = MI.getOperand(Idx);
4214     if (!MO.isReg())
4215       continue;
4216 
4217     // Is this operand statically required to be an SGPR based on the operand
4218     // constraints?
4219     const TargetRegisterClass *OpRC = RI.getRegClass(Desc.OpInfo[Idx].RegClass);
4220     bool IsRequiredSGPR = RI.isSGPRClass(OpRC);
4221     if (IsRequiredSGPR)
4222       return MO.getReg();
4223 
4224     // If this could be a VGPR or an SGPR, Check the dynamic register class.
4225     unsigned Reg = MO.getReg();
4226     const TargetRegisterClass *RegRC = MRI.getRegClass(Reg);
4227     if (RI.isSGPRClass(RegRC))
4228       UsedSGPRs[i] = Reg;
4229   }
4230 
4231   // We don't have a required SGPR operand, so we have a bit more freedom in
4232   // selecting operands to move.
4233 
4234   // Try to select the most used SGPR. If an SGPR is equal to one of the
4235   // others, we choose that.
4236   //
4237   // e.g.
4238   // V_FMA_F32 v0, s0, s0, s0 -> No moves
4239   // V_FMA_F32 v0, s0, s1, s0 -> Move s1
4240 
4241   // TODO: If some of the operands are 64-bit SGPRs and some 32, we should
4242   // prefer those.
4243 
4244   if (UsedSGPRs[0] != AMDGPU::NoRegister) {
4245     if (UsedSGPRs[0] == UsedSGPRs[1] || UsedSGPRs[0] == UsedSGPRs[2])
4246       SGPRReg = UsedSGPRs[0];
4247   }
4248 
4249   if (SGPRReg == AMDGPU::NoRegister && UsedSGPRs[1] != AMDGPU::NoRegister) {
4250     if (UsedSGPRs[1] == UsedSGPRs[2])
4251       SGPRReg = UsedSGPRs[1];
4252   }
4253 
4254   return SGPRReg;
4255 }
4256 
4257 MachineOperand *SIInstrInfo::getNamedOperand(MachineInstr &MI,
4258                                              unsigned OperandName) const {
4259   int Idx = AMDGPU::getNamedOperandIdx(MI.getOpcode(), OperandName);
4260   if (Idx == -1)
4261     return nullptr;
4262 
4263   return &MI.getOperand(Idx);
4264 }
4265 
4266 uint64_t SIInstrInfo::getDefaultRsrcDataFormat() const {
4267   uint64_t RsrcDataFormat = AMDGPU::RSRC_DATA_FORMAT;
4268   if (ST.isAmdHsaOS()) {
4269     // Set ATC = 1. GFX9 doesn't have this bit.
4270     if (ST.getGeneration() <= SISubtarget::VOLCANIC_ISLANDS)
4271       RsrcDataFormat |= (1ULL << 56);
4272 
4273     // Set MTYPE = 2 (MTYPE_UC = uncached). GFX9 doesn't have this.
4274     // BTW, it disables TC L2 and therefore decreases performance.
4275     if (ST.getGeneration() == SISubtarget::VOLCANIC_ISLANDS)
4276       RsrcDataFormat |= (2ULL << 59);
4277   }
4278 
4279   return RsrcDataFormat;
4280 }
4281 
4282 uint64_t SIInstrInfo::getScratchRsrcWords23() const {
4283   uint64_t Rsrc23 = getDefaultRsrcDataFormat() |
4284                     AMDGPU::RSRC_TID_ENABLE |
4285                     0xffffffff; // Size;
4286 
4287   // GFX9 doesn't have ELEMENT_SIZE.
4288   if (ST.getGeneration() <= SISubtarget::VOLCANIC_ISLANDS) {
4289     uint64_t EltSizeValue = Log2_32(ST.getMaxPrivateElementSize()) - 1;
4290     Rsrc23 |= EltSizeValue << AMDGPU::RSRC_ELEMENT_SIZE_SHIFT;
4291   }
4292 
4293   // IndexStride = 64.
4294   Rsrc23 |= UINT64_C(3) << AMDGPU::RSRC_INDEX_STRIDE_SHIFT;
4295 
4296   // If TID_ENABLE is set, DATA_FORMAT specifies stride bits [14:17].
4297   // Clear them unless we want a huge stride.
4298   if (ST.getGeneration() >= SISubtarget::VOLCANIC_ISLANDS)
4299     Rsrc23 &= ~AMDGPU::RSRC_DATA_FORMAT;
4300 
4301   return Rsrc23;
4302 }
4303 
4304 bool SIInstrInfo::isLowLatencyInstruction(const MachineInstr &MI) const {
4305   unsigned Opc = MI.getOpcode();
4306 
4307   return isSMRD(Opc);
4308 }
4309 
4310 bool SIInstrInfo::isHighLatencyInstruction(const MachineInstr &MI) const {
4311   unsigned Opc = MI.getOpcode();
4312 
4313   return isMUBUF(Opc) || isMTBUF(Opc) || isMIMG(Opc);
4314 }
4315 
4316 unsigned SIInstrInfo::isStackAccess(const MachineInstr &MI,
4317                                     int &FrameIndex) const {
4318   const MachineOperand *Addr = getNamedOperand(MI, AMDGPU::OpName::vaddr);
4319   if (!Addr || !Addr->isFI())
4320     return AMDGPU::NoRegister;
4321 
4322   assert(!MI.memoperands_empty() &&
4323          (*MI.memoperands_begin())->getAddrSpace() == AMDGPUASI.PRIVATE_ADDRESS);
4324 
4325   FrameIndex = Addr->getIndex();
4326   return getNamedOperand(MI, AMDGPU::OpName::vdata)->getReg();
4327 }
4328 
4329 unsigned SIInstrInfo::isSGPRStackAccess(const MachineInstr &MI,
4330                                         int &FrameIndex) const {
4331   const MachineOperand *Addr = getNamedOperand(MI, AMDGPU::OpName::addr);
4332   assert(Addr && Addr->isFI());
4333   FrameIndex = Addr->getIndex();
4334   return getNamedOperand(MI, AMDGPU::OpName::data)->getReg();
4335 }
4336 
4337 unsigned SIInstrInfo::isLoadFromStackSlot(const MachineInstr &MI,
4338                                           int &FrameIndex) const {
4339   if (!MI.mayLoad())
4340     return AMDGPU::NoRegister;
4341 
4342   if (isMUBUF(MI) || isVGPRSpill(MI))
4343     return isStackAccess(MI, FrameIndex);
4344 
4345   if (isSGPRSpill(MI))
4346     return isSGPRStackAccess(MI, FrameIndex);
4347 
4348   return AMDGPU::NoRegister;
4349 }
4350 
4351 unsigned SIInstrInfo::isStoreToStackSlot(const MachineInstr &MI,
4352                                          int &FrameIndex) const {
4353   if (!MI.mayStore())
4354     return AMDGPU::NoRegister;
4355 
4356   if (isMUBUF(MI) || isVGPRSpill(MI))
4357     return isStackAccess(MI, FrameIndex);
4358 
4359   if (isSGPRSpill(MI))
4360     return isSGPRStackAccess(MI, FrameIndex);
4361 
4362   return AMDGPU::NoRegister;
4363 }
4364 
4365 unsigned SIInstrInfo::getInstSizeInBytes(const MachineInstr &MI) const {
4366   unsigned Opc = MI.getOpcode();
4367   const MCInstrDesc &Desc = getMCOpcodeFromPseudo(Opc);
4368   unsigned DescSize = Desc.getSize();
4369 
4370   // If we have a definitive size, we can use it. Otherwise we need to inspect
4371   // the operands to know the size.
4372   //
4373   // FIXME: Instructions that have a base 32-bit encoding report their size as
4374   // 4, even though they are really 8 bytes if they have a literal operand.
4375   if (DescSize != 0 && DescSize != 4)
4376     return DescSize;
4377 
4378   // 4-byte instructions may have a 32-bit literal encoded after them. Check
4379   // operands that coud ever be literals.
4380   if (isVALU(MI) || isSALU(MI)) {
4381     if (isFixedSize(MI))
4382       return DescSize;
4383 
4384     int Src0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0);
4385     if (Src0Idx == -1)
4386       return 4; // No operands.
4387 
4388     if (isLiteralConstantLike(MI.getOperand(Src0Idx), Desc.OpInfo[Src0Idx]))
4389       return 8;
4390 
4391     int Src1Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1);
4392     if (Src1Idx == -1)
4393       return 4;
4394 
4395     if (isLiteralConstantLike(MI.getOperand(Src1Idx), Desc.OpInfo[Src1Idx]))
4396       return 8;
4397 
4398     return 4;
4399   }
4400 
4401   if (DescSize == 4)
4402     return 4;
4403 
4404   switch (Opc) {
4405   case TargetOpcode::IMPLICIT_DEF:
4406   case TargetOpcode::KILL:
4407   case TargetOpcode::DBG_VALUE:
4408   case TargetOpcode::BUNDLE:
4409   case TargetOpcode::EH_LABEL:
4410     return 0;
4411   case TargetOpcode::INLINEASM: {
4412     const MachineFunction *MF = MI.getParent()->getParent();
4413     const char *AsmStr = MI.getOperand(0).getSymbolName();
4414     return getInlineAsmLength(AsmStr, *MF->getTarget().getMCAsmInfo());
4415   }
4416   default:
4417     llvm_unreachable("unable to find instruction size");
4418   }
4419 }
4420 
4421 bool SIInstrInfo::mayAccessFlatAddressSpace(const MachineInstr &MI) const {
4422   if (!isFLAT(MI))
4423     return false;
4424 
4425   if (MI.memoperands_empty())
4426     return true;
4427 
4428   for (const MachineMemOperand *MMO : MI.memoperands()) {
4429     if (MMO->getAddrSpace() == AMDGPUASI.FLAT_ADDRESS)
4430       return true;
4431   }
4432   return false;
4433 }
4434 
4435 bool SIInstrInfo::isNonUniformBranchInstr(MachineInstr &Branch) const {
4436   return Branch.getOpcode() == AMDGPU::SI_NON_UNIFORM_BRCOND_PSEUDO;
4437 }
4438 
4439 void SIInstrInfo::convertNonUniformIfRegion(MachineBasicBlock *IfEntry,
4440                                             MachineBasicBlock *IfEnd) const {
4441   MachineBasicBlock::iterator TI = IfEntry->getFirstTerminator();
4442   assert(TI != IfEntry->end());
4443 
4444   MachineInstr *Branch = &(*TI);
4445   MachineFunction *MF = IfEntry->getParent();
4446   MachineRegisterInfo &MRI = IfEntry->getParent()->getRegInfo();
4447 
4448   if (Branch->getOpcode() == AMDGPU::SI_NON_UNIFORM_BRCOND_PSEUDO) {
4449     unsigned DstReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
4450     MachineInstr *SIIF =
4451         BuildMI(*MF, Branch->getDebugLoc(), get(AMDGPU::SI_IF), DstReg)
4452             .add(Branch->getOperand(0))
4453             .add(Branch->getOperand(1));
4454     MachineInstr *SIEND =
4455         BuildMI(*MF, Branch->getDebugLoc(), get(AMDGPU::SI_END_CF))
4456             .addReg(DstReg);
4457 
4458     IfEntry->erase(TI);
4459     IfEntry->insert(IfEntry->end(), SIIF);
4460     IfEnd->insert(IfEnd->getFirstNonPHI(), SIEND);
4461   }
4462 }
4463 
4464 void SIInstrInfo::convertNonUniformLoopRegion(
4465     MachineBasicBlock *LoopEntry, MachineBasicBlock *LoopEnd) const {
4466   MachineBasicBlock::iterator TI = LoopEnd->getFirstTerminator();
4467   // We expect 2 terminators, one conditional and one unconditional.
4468   assert(TI != LoopEnd->end());
4469 
4470   MachineInstr *Branch = &(*TI);
4471   MachineFunction *MF = LoopEnd->getParent();
4472   MachineRegisterInfo &MRI = LoopEnd->getParent()->getRegInfo();
4473 
4474   if (Branch->getOpcode() == AMDGPU::SI_NON_UNIFORM_BRCOND_PSEUDO) {
4475 
4476     unsigned DstReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
4477     unsigned BackEdgeReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
4478     MachineInstrBuilder HeaderPHIBuilder =
4479         BuildMI(*(MF), Branch->getDebugLoc(), get(TargetOpcode::PHI), DstReg);
4480     for (MachineBasicBlock::pred_iterator PI = LoopEntry->pred_begin(),
4481                                           E = LoopEntry->pred_end();
4482          PI != E; ++PI) {
4483       if (*PI == LoopEnd) {
4484         HeaderPHIBuilder.addReg(BackEdgeReg);
4485       } else {
4486         MachineBasicBlock *PMBB = *PI;
4487         unsigned ZeroReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
4488         materializeImmediate(*PMBB, PMBB->getFirstTerminator(), DebugLoc(),
4489                              ZeroReg, 0);
4490         HeaderPHIBuilder.addReg(ZeroReg);
4491       }
4492       HeaderPHIBuilder.addMBB(*PI);
4493     }
4494     MachineInstr *HeaderPhi = HeaderPHIBuilder;
4495     MachineInstr *SIIFBREAK = BuildMI(*(MF), Branch->getDebugLoc(),
4496                                       get(AMDGPU::SI_IF_BREAK), BackEdgeReg)
4497                                   .addReg(DstReg)
4498                                   .add(Branch->getOperand(0));
4499     MachineInstr *SILOOP =
4500         BuildMI(*(MF), Branch->getDebugLoc(), get(AMDGPU::SI_LOOP))
4501             .addReg(BackEdgeReg)
4502             .addMBB(LoopEntry);
4503 
4504     LoopEntry->insert(LoopEntry->begin(), HeaderPhi);
4505     LoopEnd->erase(TI);
4506     LoopEnd->insert(LoopEnd->end(), SIIFBREAK);
4507     LoopEnd->insert(LoopEnd->end(), SILOOP);
4508   }
4509 }
4510 
4511 ArrayRef<std::pair<int, const char *>>
4512 SIInstrInfo::getSerializableTargetIndices() const {
4513   static const std::pair<int, const char *> TargetIndices[] = {
4514       {AMDGPU::TI_CONSTDATA_START, "amdgpu-constdata-start"},
4515       {AMDGPU::TI_SCRATCH_RSRC_DWORD0, "amdgpu-scratch-rsrc-dword0"},
4516       {AMDGPU::TI_SCRATCH_RSRC_DWORD1, "amdgpu-scratch-rsrc-dword1"},
4517       {AMDGPU::TI_SCRATCH_RSRC_DWORD2, "amdgpu-scratch-rsrc-dword2"},
4518       {AMDGPU::TI_SCRATCH_RSRC_DWORD3, "amdgpu-scratch-rsrc-dword3"}};
4519   return makeArrayRef(TargetIndices);
4520 }
4521 
4522 /// This is used by the post-RA scheduler (SchedulePostRAList.cpp).  The
4523 /// post-RA version of misched uses CreateTargetMIHazardRecognizer.
4524 ScheduleHazardRecognizer *
4525 SIInstrInfo::CreateTargetPostRAHazardRecognizer(const InstrItineraryData *II,
4526                                             const ScheduleDAG *DAG) const {
4527   return new GCNHazardRecognizer(DAG->MF);
4528 }
4529 
4530 /// This is the hazard recognizer used at -O0 by the PostRAHazardRecognizer
4531 /// pass.
4532 ScheduleHazardRecognizer *
4533 SIInstrInfo::CreateTargetPostRAHazardRecognizer(const MachineFunction &MF) const {
4534   return new GCNHazardRecognizer(MF);
4535 }
4536 
4537 std::pair<unsigned, unsigned>
4538 SIInstrInfo::decomposeMachineOperandsTargetFlags(unsigned TF) const {
4539   return std::make_pair(TF & MO_MASK, TF & ~MO_MASK);
4540 }
4541 
4542 ArrayRef<std::pair<unsigned, const char *>>
4543 SIInstrInfo::getSerializableDirectMachineOperandTargetFlags() const {
4544   static const std::pair<unsigned, const char *> TargetFlags[] = {
4545     { MO_GOTPCREL, "amdgpu-gotprel" },
4546     { MO_GOTPCREL32_LO, "amdgpu-gotprel32-lo" },
4547     { MO_GOTPCREL32_HI, "amdgpu-gotprel32-hi" },
4548     { MO_REL32_LO, "amdgpu-rel32-lo" },
4549     { MO_REL32_HI, "amdgpu-rel32-hi" }
4550   };
4551 
4552   return makeArrayRef(TargetFlags);
4553 }
4554 
4555 bool SIInstrInfo::isBasicBlockPrologue(const MachineInstr &MI) const {
4556   return !MI.isTerminator() && MI.getOpcode() != AMDGPU::COPY &&
4557          MI.modifiesRegister(AMDGPU::EXEC, &RI);
4558 }
4559 
4560 MachineInstrBuilder
4561 SIInstrInfo::getAddNoCarry(MachineBasicBlock &MBB,
4562                            MachineBasicBlock::iterator I,
4563                            const DebugLoc &DL,
4564                            unsigned DestReg) const {
4565   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4566 
4567   unsigned UnusedCarry = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
4568 
4569   return BuildMI(MBB, I, DL, get(AMDGPU::V_ADD_I32_e64), DestReg)
4570            .addReg(UnusedCarry, RegState::Define | RegState::Dead);
4571 }
4572