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