1 //===- SIInstrInfo.cpp - SI Instruction Information  ----------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 /// \file
10 /// SI Implementation of TargetInstrInfo.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "SIInstrInfo.h"
15 #include "AMDGPU.h"
16 #include "AMDGPUSubtarget.h"
17 #include "GCNHazardRecognizer.h"
18 #include "SIDefines.h"
19 #include "SIMachineFunctionInfo.h"
20 #include "SIRegisterInfo.h"
21 #include "MCTargetDesc/AMDGPUMCTargetDesc.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/MachineDominators.h"
33 #include "llvm/CodeGen/MachineFrameInfo.h"
34 #include "llvm/CodeGen/MachineFunction.h"
35 #include "llvm/CodeGen/MachineInstr.h"
36 #include "llvm/CodeGen/MachineInstrBuilder.h"
37 #include "llvm/CodeGen/MachineInstrBundle.h"
38 #include "llvm/CodeGen/MachineMemOperand.h"
39 #include "llvm/CodeGen/MachineOperand.h"
40 #include "llvm/CodeGen/MachineRegisterInfo.h"
41 #include "llvm/CodeGen/RegisterScavenging.h"
42 #include "llvm/CodeGen/ScheduleDAG.h"
43 #include "llvm/CodeGen/SelectionDAGNodes.h"
44 #include "llvm/CodeGen/TargetOpcodes.h"
45 #include "llvm/CodeGen/TargetRegisterInfo.h"
46 #include "llvm/IR/DebugLoc.h"
47 #include "llvm/IR/DiagnosticInfo.h"
48 #include "llvm/IR/Function.h"
49 #include "llvm/IR/InlineAsm.h"
50 #include "llvm/IR/LLVMContext.h"
51 #include "llvm/MC/MCInstrDesc.h"
52 #include "llvm/Support/Casting.h"
53 #include "llvm/Support/CommandLine.h"
54 #include "llvm/Support/Compiler.h"
55 #include "llvm/Support/ErrorHandling.h"
56 #include "llvm/Support/MachineValueType.h"
57 #include "llvm/Support/MathExtras.h"
58 #include "llvm/Target/TargetMachine.h"
59 #include <cassert>
60 #include <cstdint>
61 #include <iterator>
62 #include <utility>
63 
64 using namespace llvm;
65 
66 #define GET_INSTRINFO_CTOR_DTOR
67 #include "AMDGPUGenInstrInfo.inc"
68 
69 namespace llvm {
70 namespace AMDGPU {
71 #define GET_D16ImageDimIntrinsics_IMPL
72 #define GET_ImageDimIntrinsicTable_IMPL
73 #define GET_RsrcIntrinsics_IMPL
74 #include "AMDGPUGenSearchableTables.inc"
75 }
76 }
77 
78 
79 // Must be at least 4 to be able to branch over minimum unconditional branch
80 // code. This is only for making it possible to write reasonably small tests for
81 // long branches.
82 static cl::opt<unsigned>
83 BranchOffsetBits("amdgpu-s-branch-bits", cl::ReallyHidden, cl::init(16),
84                  cl::desc("Restrict range of branch instructions (DEBUG)"));
85 
86 SIInstrInfo::SIInstrInfo(const GCNSubtarget &ST)
87   : AMDGPUGenInstrInfo(AMDGPU::ADJCALLSTACKUP, AMDGPU::ADJCALLSTACKDOWN),
88     RI(ST), ST(ST) {}
89 
90 //===----------------------------------------------------------------------===//
91 // TargetInstrInfo callbacks
92 //===----------------------------------------------------------------------===//
93 
94 static unsigned getNumOperandsNoGlue(SDNode *Node) {
95   unsigned N = Node->getNumOperands();
96   while (N && Node->getOperand(N - 1).getValueType() == MVT::Glue)
97     --N;
98   return N;
99 }
100 
101 /// Returns true if both nodes have the same value for the given
102 ///        operand \p Op, or if both nodes do not have this operand.
103 static bool nodesHaveSameOperandValue(SDNode *N0, SDNode* N1, unsigned OpName) {
104   unsigned Opc0 = N0->getMachineOpcode();
105   unsigned Opc1 = N1->getMachineOpcode();
106 
107   int Op0Idx = AMDGPU::getNamedOperandIdx(Opc0, OpName);
108   int Op1Idx = AMDGPU::getNamedOperandIdx(Opc1, OpName);
109 
110   if (Op0Idx == -1 && Op1Idx == -1)
111     return true;
112 
113 
114   if ((Op0Idx == -1 && Op1Idx != -1) ||
115       (Op1Idx == -1 && Op0Idx != -1))
116     return false;
117 
118   // getNamedOperandIdx returns the index for the MachineInstr's operands,
119   // which includes the result as the first operand. We are indexing into the
120   // MachineSDNode's operands, so we need to skip the result operand to get
121   // the real index.
122   --Op0Idx;
123   --Op1Idx;
124 
125   return N0->getOperand(Op0Idx) == N1->getOperand(Op1Idx);
126 }
127 
128 bool SIInstrInfo::isReallyTriviallyReMaterializable(const MachineInstr &MI,
129                                                     AliasAnalysis *AA) const {
130   // TODO: The generic check fails for VALU instructions that should be
131   // rematerializable due to implicit reads of exec. We really want all of the
132   // generic logic for this except for this.
133   switch (MI.getOpcode()) {
134   case AMDGPU::V_MOV_B32_e32:
135   case AMDGPU::V_MOV_B32_e64:
136   case AMDGPU::V_MOV_B64_PSEUDO:
137     // No implicit operands.
138     return MI.getNumOperands() == MI.getDesc().getNumOperands();
139   default:
140     return false;
141   }
142 }
143 
144 bool SIInstrInfo::areLoadsFromSameBasePtr(SDNode *Load0, SDNode *Load1,
145                                           int64_t &Offset0,
146                                           int64_t &Offset1) const {
147   if (!Load0->isMachineOpcode() || !Load1->isMachineOpcode())
148     return false;
149 
150   unsigned Opc0 = Load0->getMachineOpcode();
151   unsigned Opc1 = Load1->getMachineOpcode();
152 
153   // Make sure both are actually loads.
154   if (!get(Opc0).mayLoad() || !get(Opc1).mayLoad())
155     return false;
156 
157   if (isDS(Opc0) && isDS(Opc1)) {
158 
159     // FIXME: Handle this case:
160     if (getNumOperandsNoGlue(Load0) != getNumOperandsNoGlue(Load1))
161       return false;
162 
163     // Check base reg.
164     if (Load0->getOperand(0) != Load1->getOperand(0))
165       return false;
166 
167     // Skip read2 / write2 variants for simplicity.
168     // TODO: We should report true if the used offsets are adjacent (excluded
169     // st64 versions).
170     int Offset0Idx = AMDGPU::getNamedOperandIdx(Opc0, AMDGPU::OpName::offset);
171     int Offset1Idx = AMDGPU::getNamedOperandIdx(Opc1, AMDGPU::OpName::offset);
172     if (Offset0Idx == -1 || Offset1Idx == -1)
173       return false;
174 
175     // XXX - be careful of datalesss loads
176     // getNamedOperandIdx returns the index for MachineInstrs.  Since they
177     // include the output in the operand list, but SDNodes don't, we need to
178     // subtract the index by one.
179     Offset0Idx -= get(Opc0).NumDefs;
180     Offset1Idx -= get(Opc1).NumDefs;
181     Offset0 = cast<ConstantSDNode>(Load0->getOperand(Offset0Idx))->getZExtValue();
182     Offset1 = cast<ConstantSDNode>(Load1->getOperand(Offset1Idx))->getZExtValue();
183     return true;
184   }
185 
186   if (isSMRD(Opc0) && isSMRD(Opc1)) {
187     // Skip time and cache invalidation instructions.
188     if (AMDGPU::getNamedOperandIdx(Opc0, AMDGPU::OpName::sbase) == -1 ||
189         AMDGPU::getNamedOperandIdx(Opc1, AMDGPU::OpName::sbase) == -1)
190       return false;
191 
192     assert(getNumOperandsNoGlue(Load0) == getNumOperandsNoGlue(Load1));
193 
194     // Check base reg.
195     if (Load0->getOperand(0) != Load1->getOperand(0))
196       return false;
197 
198     const ConstantSDNode *Load0Offset =
199         dyn_cast<ConstantSDNode>(Load0->getOperand(1));
200     const ConstantSDNode *Load1Offset =
201         dyn_cast<ConstantSDNode>(Load1->getOperand(1));
202 
203     if (!Load0Offset || !Load1Offset)
204       return false;
205 
206     Offset0 = Load0Offset->getZExtValue();
207     Offset1 = Load1Offset->getZExtValue();
208     return true;
209   }
210 
211   // MUBUF and MTBUF can access the same addresses.
212   if ((isMUBUF(Opc0) || isMTBUF(Opc0)) && (isMUBUF(Opc1) || isMTBUF(Opc1))) {
213 
214     // MUBUF and MTBUF have vaddr at different indices.
215     if (!nodesHaveSameOperandValue(Load0, Load1, AMDGPU::OpName::soffset) ||
216         !nodesHaveSameOperandValue(Load0, Load1, AMDGPU::OpName::vaddr) ||
217         !nodesHaveSameOperandValue(Load0, Load1, AMDGPU::OpName::srsrc))
218       return false;
219 
220     int OffIdx0 = AMDGPU::getNamedOperandIdx(Opc0, AMDGPU::OpName::offset);
221     int OffIdx1 = AMDGPU::getNamedOperandIdx(Opc1, AMDGPU::OpName::offset);
222 
223     if (OffIdx0 == -1 || OffIdx1 == -1)
224       return false;
225 
226     // getNamedOperandIdx returns the index for MachineInstrs.  Since they
227     // include the output in the operand list, but SDNodes don't, we need to
228     // subtract the index by one.
229     OffIdx0 -= get(Opc0).NumDefs;
230     OffIdx1 -= get(Opc1).NumDefs;
231 
232     SDValue Off0 = Load0->getOperand(OffIdx0);
233     SDValue Off1 = Load1->getOperand(OffIdx1);
234 
235     // The offset might be a FrameIndexSDNode.
236     if (!isa<ConstantSDNode>(Off0) || !isa<ConstantSDNode>(Off1))
237       return false;
238 
239     Offset0 = cast<ConstantSDNode>(Off0)->getZExtValue();
240     Offset1 = cast<ConstantSDNode>(Off1)->getZExtValue();
241     return true;
242   }
243 
244   return false;
245 }
246 
247 static bool isStride64(unsigned Opc) {
248   switch (Opc) {
249   case AMDGPU::DS_READ2ST64_B32:
250   case AMDGPU::DS_READ2ST64_B64:
251   case AMDGPU::DS_WRITE2ST64_B32:
252   case AMDGPU::DS_WRITE2ST64_B64:
253     return true;
254   default:
255     return false;
256   }
257 }
258 
259 bool SIInstrInfo::getMemOperandWithOffset(const MachineInstr &LdSt,
260                                           const MachineOperand *&BaseOp,
261                                           int64_t &Offset,
262                                           const TargetRegisterInfo *TRI) const {
263   unsigned Opc = LdSt.getOpcode();
264 
265   if (isDS(LdSt)) {
266     const MachineOperand *OffsetImm =
267         getNamedOperand(LdSt, AMDGPU::OpName::offset);
268     if (OffsetImm) {
269       // Normal, single offset LDS instruction.
270       BaseOp = getNamedOperand(LdSt, AMDGPU::OpName::addr);
271       // TODO: ds_consume/ds_append use M0 for the base address. Is it safe to
272       // report that here?
273       if (!BaseOp)
274         return false;
275 
276       Offset = OffsetImm->getImm();
277       assert(BaseOp->isReg() && "getMemOperandWithOffset only supports base "
278                                 "operands of type register.");
279       return true;
280     }
281 
282     // The 2 offset instructions use offset0 and offset1 instead. We can treat
283     // these as a load with a single offset if the 2 offsets are consecutive. We
284     // will use this for some partially aligned loads.
285     const MachineOperand *Offset0Imm =
286         getNamedOperand(LdSt, AMDGPU::OpName::offset0);
287     const MachineOperand *Offset1Imm =
288         getNamedOperand(LdSt, AMDGPU::OpName::offset1);
289 
290     uint8_t Offset0 = Offset0Imm->getImm();
291     uint8_t Offset1 = Offset1Imm->getImm();
292 
293     if (Offset1 > Offset0 && Offset1 - Offset0 == 1) {
294       // Each of these offsets is in element sized units, so we need to convert
295       // to bytes of the individual reads.
296 
297       unsigned EltSize;
298       if (LdSt.mayLoad())
299         EltSize = TRI->getRegSizeInBits(*getOpRegClass(LdSt, 0)) / 16;
300       else {
301         assert(LdSt.mayStore());
302         int Data0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::data0);
303         EltSize = TRI->getRegSizeInBits(*getOpRegClass(LdSt, Data0Idx)) / 8;
304       }
305 
306       if (isStride64(Opc))
307         EltSize *= 64;
308 
309       BaseOp = getNamedOperand(LdSt, AMDGPU::OpName::addr);
310       Offset = EltSize * Offset0;
311       assert(BaseOp->isReg() && "getMemOperandWithOffset only supports base "
312                                 "operands of type register.");
313       return true;
314     }
315 
316     return false;
317   }
318 
319   if (isMUBUF(LdSt) || isMTBUF(LdSt)) {
320     const MachineOperand *SOffset = getNamedOperand(LdSt, AMDGPU::OpName::soffset);
321     if (SOffset && SOffset->isReg())
322       return false;
323 
324     const MachineOperand *AddrReg = getNamedOperand(LdSt, AMDGPU::OpName::vaddr);
325     if (!AddrReg)
326       return false;
327 
328     const MachineOperand *OffsetImm =
329         getNamedOperand(LdSt, AMDGPU::OpName::offset);
330     BaseOp = AddrReg;
331     Offset = OffsetImm->getImm();
332 
333     if (SOffset) // soffset can be an inline immediate.
334       Offset += SOffset->getImm();
335 
336     assert(BaseOp->isReg() && "getMemOperandWithOffset only supports base "
337                               "operands of type register.");
338     return true;
339   }
340 
341   if (isSMRD(LdSt)) {
342     const MachineOperand *OffsetImm =
343         getNamedOperand(LdSt, AMDGPU::OpName::offset);
344     if (!OffsetImm)
345       return false;
346 
347     const MachineOperand *SBaseReg = getNamedOperand(LdSt, AMDGPU::OpName::sbase);
348     BaseOp = SBaseReg;
349     Offset = OffsetImm->getImm();
350     assert(BaseOp->isReg() && "getMemOperandWithOffset only supports base "
351                               "operands of type register.");
352     return true;
353   }
354 
355   if (isFLAT(LdSt)) {
356     const MachineOperand *VAddr = getNamedOperand(LdSt, AMDGPU::OpName::vaddr);
357     if (VAddr) {
358       // Can't analyze 2 offsets.
359       if (getNamedOperand(LdSt, AMDGPU::OpName::saddr))
360         return false;
361 
362       BaseOp = VAddr;
363     } else {
364       // scratch instructions have either vaddr or saddr.
365       BaseOp = getNamedOperand(LdSt, AMDGPU::OpName::saddr);
366     }
367 
368     Offset = getNamedOperand(LdSt, AMDGPU::OpName::offset)->getImm();
369     assert(BaseOp->isReg() && "getMemOperandWithOffset only supports base "
370                               "operands of type register.");
371     return true;
372   }
373 
374   return false;
375 }
376 
377 static bool memOpsHaveSameBasePtr(const MachineInstr &MI1,
378                                   const MachineOperand &BaseOp1,
379                                   const MachineInstr &MI2,
380                                   const MachineOperand &BaseOp2) {
381   // Support only base operands with base registers.
382   // Note: this could be extended to support FI operands.
383   if (!BaseOp1.isReg() || !BaseOp2.isReg())
384     return false;
385 
386   if (BaseOp1.isIdenticalTo(BaseOp2))
387     return true;
388 
389   if (!MI1.hasOneMemOperand() || !MI2.hasOneMemOperand())
390     return false;
391 
392   auto MO1 = *MI1.memoperands_begin();
393   auto MO2 = *MI2.memoperands_begin();
394   if (MO1->getAddrSpace() != MO2->getAddrSpace())
395     return false;
396 
397   auto Base1 = MO1->getValue();
398   auto Base2 = MO2->getValue();
399   if (!Base1 || !Base2)
400     return false;
401   const MachineFunction &MF = *MI1.getParent()->getParent();
402   const DataLayout &DL = MF.getFunction().getParent()->getDataLayout();
403   Base1 = GetUnderlyingObject(Base1, DL);
404   Base2 = GetUnderlyingObject(Base1, DL);
405 
406   if (isa<UndefValue>(Base1) || isa<UndefValue>(Base2))
407     return false;
408 
409   return Base1 == Base2;
410 }
411 
412 bool SIInstrInfo::shouldClusterMemOps(const MachineOperand &BaseOp1,
413                                       const MachineOperand &BaseOp2,
414                                       unsigned NumLoads) const {
415   const MachineInstr &FirstLdSt = *BaseOp1.getParent();
416   const MachineInstr &SecondLdSt = *BaseOp2.getParent();
417 
418   if (!memOpsHaveSameBasePtr(FirstLdSt, BaseOp1, SecondLdSt, BaseOp2))
419     return false;
420 
421   const MachineOperand *FirstDst = nullptr;
422   const MachineOperand *SecondDst = nullptr;
423 
424   if ((isMUBUF(FirstLdSt) && isMUBUF(SecondLdSt)) ||
425       (isMTBUF(FirstLdSt) && isMTBUF(SecondLdSt)) ||
426       (isFLAT(FirstLdSt) && isFLAT(SecondLdSt))) {
427     const unsigned MaxGlobalLoadCluster = 6;
428     if (NumLoads > MaxGlobalLoadCluster)
429       return false;
430 
431     FirstDst = getNamedOperand(FirstLdSt, AMDGPU::OpName::vdata);
432     if (!FirstDst)
433       FirstDst = getNamedOperand(FirstLdSt, AMDGPU::OpName::vdst);
434     SecondDst = getNamedOperand(SecondLdSt, AMDGPU::OpName::vdata);
435     if (!SecondDst)
436       SecondDst = getNamedOperand(SecondLdSt, AMDGPU::OpName::vdst);
437   } else if (isSMRD(FirstLdSt) && isSMRD(SecondLdSt)) {
438     FirstDst = getNamedOperand(FirstLdSt, AMDGPU::OpName::sdst);
439     SecondDst = getNamedOperand(SecondLdSt, AMDGPU::OpName::sdst);
440   } else if (isDS(FirstLdSt) && isDS(SecondLdSt)) {
441     FirstDst = getNamedOperand(FirstLdSt, AMDGPU::OpName::vdst);
442     SecondDst = getNamedOperand(SecondLdSt, AMDGPU::OpName::vdst);
443   }
444 
445   if (!FirstDst || !SecondDst)
446     return false;
447 
448   // Try to limit clustering based on the total number of bytes loaded
449   // rather than the number of instructions.  This is done to help reduce
450   // register pressure.  The method used is somewhat inexact, though,
451   // because it assumes that all loads in the cluster will load the
452   // same number of bytes as FirstLdSt.
453 
454   // The unit of this value is bytes.
455   // FIXME: This needs finer tuning.
456   unsigned LoadClusterThreshold = 16;
457 
458   const MachineRegisterInfo &MRI =
459       FirstLdSt.getParent()->getParent()->getRegInfo();
460 
461   const unsigned Reg = FirstDst->getReg();
462 
463   const TargetRegisterClass *DstRC = Register::isVirtualRegister(Reg)
464                                          ? MRI.getRegClass(Reg)
465                                          : RI.getPhysRegClass(Reg);
466 
467   return (NumLoads * (RI.getRegSizeInBits(*DstRC) / 8)) <= LoadClusterThreshold;
468 }
469 
470 // FIXME: This behaves strangely. If, for example, you have 32 load + stores,
471 // the first 16 loads will be interleaved with the stores, and the next 16 will
472 // be clustered as expected. It should really split into 2 16 store batches.
473 //
474 // Loads are clustered until this returns false, rather than trying to schedule
475 // groups of stores. This also means we have to deal with saying different
476 // address space loads should be clustered, and ones which might cause bank
477 // conflicts.
478 //
479 // This might be deprecated so it might not be worth that much effort to fix.
480 bool SIInstrInfo::shouldScheduleLoadsNear(SDNode *Load0, SDNode *Load1,
481                                           int64_t Offset0, int64_t Offset1,
482                                           unsigned NumLoads) const {
483   assert(Offset1 > Offset0 &&
484          "Second offset should be larger than first offset!");
485   // If we have less than 16 loads in a row, and the offsets are within 64
486   // bytes, then schedule together.
487 
488   // A cacheline is 64 bytes (for global memory).
489   return (NumLoads <= 16 && (Offset1 - Offset0) < 64);
490 }
491 
492 static void reportIllegalCopy(const SIInstrInfo *TII, MachineBasicBlock &MBB,
493                               MachineBasicBlock::iterator MI,
494                               const DebugLoc &DL, unsigned DestReg,
495                               unsigned SrcReg, bool KillSrc) {
496   MachineFunction *MF = MBB.getParent();
497   DiagnosticInfoUnsupported IllegalCopy(MF->getFunction(),
498                                         "illegal SGPR to VGPR copy",
499                                         DL, DS_Error);
500   LLVMContext &C = MF->getFunction().getContext();
501   C.diagnose(IllegalCopy);
502 
503   BuildMI(MBB, MI, DL, TII->get(AMDGPU::SI_ILLEGAL_COPY), DestReg)
504     .addReg(SrcReg, getKillRegState(KillSrc));
505 }
506 
507 void SIInstrInfo::copyPhysReg(MachineBasicBlock &MBB,
508                               MachineBasicBlock::iterator MI,
509                               const DebugLoc &DL, unsigned DestReg,
510                               unsigned SrcReg, bool KillSrc) const {
511   const TargetRegisterClass *RC = RI.getPhysRegClass(DestReg);
512 
513   if (RC == &AMDGPU::VGPR_32RegClass) {
514     assert(AMDGPU::VGPR_32RegClass.contains(SrcReg) ||
515            AMDGPU::SReg_32RegClass.contains(SrcReg) ||
516            AMDGPU::AGPR_32RegClass.contains(SrcReg));
517     unsigned Opc = AMDGPU::AGPR_32RegClass.contains(SrcReg) ?
518                      AMDGPU::V_ACCVGPR_READ_B32 : AMDGPU::V_MOV_B32_e32;
519     BuildMI(MBB, MI, DL, get(Opc), DestReg)
520       .addReg(SrcReg, getKillRegState(KillSrc));
521     return;
522   }
523 
524   if (RC == &AMDGPU::SReg_32_XM0RegClass ||
525       RC == &AMDGPU::SReg_32RegClass) {
526     if (SrcReg == AMDGPU::SCC) {
527       BuildMI(MBB, MI, DL, get(AMDGPU::S_CSELECT_B32), DestReg)
528           .addImm(-1)
529           .addImm(0);
530       return;
531     }
532 
533     if (DestReg == AMDGPU::VCC_LO) {
534       if (AMDGPU::SReg_32RegClass.contains(SrcReg)) {
535         BuildMI(MBB, MI, DL, get(AMDGPU::S_MOV_B32), AMDGPU::VCC_LO)
536           .addReg(SrcReg, getKillRegState(KillSrc));
537       } else {
538         // FIXME: Hack until VReg_1 removed.
539         assert(AMDGPU::VGPR_32RegClass.contains(SrcReg));
540         BuildMI(MBB, MI, DL, get(AMDGPU::V_CMP_NE_U32_e32))
541           .addImm(0)
542           .addReg(SrcReg, getKillRegState(KillSrc));
543       }
544 
545       return;
546     }
547 
548     if (!AMDGPU::SReg_32RegClass.contains(SrcReg)) {
549       reportIllegalCopy(this, MBB, MI, DL, DestReg, SrcReg, KillSrc);
550       return;
551     }
552 
553     BuildMI(MBB, MI, DL, get(AMDGPU::S_MOV_B32), DestReg)
554             .addReg(SrcReg, getKillRegState(KillSrc));
555     return;
556   }
557 
558   if (RC == &AMDGPU::SReg_64RegClass) {
559     if (DestReg == AMDGPU::VCC) {
560       if (AMDGPU::SReg_64RegClass.contains(SrcReg)) {
561         BuildMI(MBB, MI, DL, get(AMDGPU::S_MOV_B64), AMDGPU::VCC)
562           .addReg(SrcReg, getKillRegState(KillSrc));
563       } else {
564         // FIXME: Hack until VReg_1 removed.
565         assert(AMDGPU::VGPR_32RegClass.contains(SrcReg));
566         BuildMI(MBB, MI, DL, get(AMDGPU::V_CMP_NE_U32_e32))
567           .addImm(0)
568           .addReg(SrcReg, getKillRegState(KillSrc));
569       }
570 
571       return;
572     }
573 
574     if (!AMDGPU::SReg_64RegClass.contains(SrcReg)) {
575       reportIllegalCopy(this, MBB, MI, DL, DestReg, SrcReg, KillSrc);
576       return;
577     }
578 
579     BuildMI(MBB, MI, DL, get(AMDGPU::S_MOV_B64), DestReg)
580             .addReg(SrcReg, getKillRegState(KillSrc));
581     return;
582   }
583 
584   if (DestReg == AMDGPU::SCC) {
585     assert(AMDGPU::SReg_32RegClass.contains(SrcReg));
586     BuildMI(MBB, MI, DL, get(AMDGPU::S_CMP_LG_U32))
587       .addReg(SrcReg, getKillRegState(KillSrc))
588       .addImm(0);
589     return;
590   }
591 
592   if (RC == &AMDGPU::AGPR_32RegClass) {
593     assert(AMDGPU::VGPR_32RegClass.contains(SrcReg) ||
594            AMDGPU::SReg_32RegClass.contains(SrcReg) ||
595            AMDGPU::AGPR_32RegClass.contains(SrcReg));
596     if (!AMDGPU::VGPR_32RegClass.contains(SrcReg)) {
597       // First try to find defining accvgpr_write to avoid temporary registers.
598       for (auto Def = MI, E = MBB.begin(); Def != E; ) {
599         --Def;
600         if (!Def->definesRegister(SrcReg, &RI))
601           continue;
602         if (Def->getOpcode() != AMDGPU::V_ACCVGPR_WRITE_B32)
603           break;
604 
605         MachineOperand &DefOp = Def->getOperand(1);
606         assert(DefOp.isReg() || DefOp.isImm());
607 
608         if (DefOp.isReg()) {
609           // Check that register source operand if not clobbered before MI.
610           // Immediate operands are always safe to propagate.
611           bool SafeToPropagate = true;
612           for (auto I = Def; I != MI && SafeToPropagate; ++I)
613             if (I->modifiesRegister(DefOp.getReg(), &RI))
614               SafeToPropagate = false;
615 
616           if (!SafeToPropagate)
617             break;
618 
619           DefOp.setIsKill(false);
620         }
621 
622         BuildMI(MBB, MI, DL, get(AMDGPU::V_ACCVGPR_WRITE_B32), DestReg)
623           .add(DefOp);
624         return;
625       }
626 
627       RegScavenger RS;
628       RS.enterBasicBlock(MBB);
629       RS.forward(MI);
630 
631       // Ideally we want to have three registers for a long reg_sequence copy
632       // to hide 2 waitstates between v_mov_b32 and accvgpr_write.
633       unsigned MaxVGPRs = RI.getRegPressureLimit(&AMDGPU::VGPR_32RegClass,
634                                                  *MBB.getParent());
635 
636       // Registers in the sequence are allocated contiguously so we can just
637       // use register number to pick one of three round-robin temps.
638       unsigned RegNo = DestReg % 3;
639       unsigned Tmp = RS.scavengeRegister(&AMDGPU::VGPR_32RegClass, 0);
640       if (!Tmp)
641         report_fatal_error("Cannot scavenge VGPR to copy to AGPR");
642       RS.setRegUsed(Tmp);
643       // Only loop through if there are any free registers left, otherwise
644       // scavenger may report a fatal error without emergency spill slot
645       // or spill with the slot.
646       while (RegNo-- && RS.FindUnusedReg(&AMDGPU::VGPR_32RegClass)) {
647         unsigned Tmp2 = RS.scavengeRegister(&AMDGPU::VGPR_32RegClass, 0);
648         if (!Tmp2 || RI.getHWRegIndex(Tmp2) >= MaxVGPRs)
649           break;
650         Tmp = Tmp2;
651         RS.setRegUsed(Tmp);
652       }
653       copyPhysReg(MBB, MI, DL, Tmp, SrcReg, KillSrc);
654       BuildMI(MBB, MI, DL, get(AMDGPU::V_ACCVGPR_WRITE_B32), DestReg)
655         .addReg(Tmp, RegState::Kill);
656       return;
657     }
658 
659     BuildMI(MBB, MI, DL, get(AMDGPU::V_ACCVGPR_WRITE_B32), DestReg)
660       .addReg(SrcReg, getKillRegState(KillSrc));
661     return;
662   }
663 
664   unsigned EltSize = 4;
665   unsigned Opcode = AMDGPU::V_MOV_B32_e32;
666   if (RI.isSGPRClass(RC)) {
667     // TODO: Copy vec3/vec5 with s_mov_b64s then final s_mov_b32.
668     if (!(RI.getRegSizeInBits(*RC) % 64)) {
669       Opcode =  AMDGPU::S_MOV_B64;
670       EltSize = 8;
671     } else {
672       Opcode = AMDGPU::S_MOV_B32;
673       EltSize = 4;
674     }
675 
676     if (!RI.isSGPRClass(RI.getPhysRegClass(SrcReg))) {
677       reportIllegalCopy(this, MBB, MI, DL, DestReg, SrcReg, KillSrc);
678       return;
679     }
680   } else if (RI.hasAGPRs(RC)) {
681     Opcode = RI.hasVGPRs(RI.getPhysRegClass(SrcReg)) ?
682       AMDGPU::V_ACCVGPR_WRITE_B32 : AMDGPU::COPY;
683   } else if (RI.hasVGPRs(RC) && RI.hasAGPRs(RI.getPhysRegClass(SrcReg))) {
684     Opcode = AMDGPU::V_ACCVGPR_READ_B32;
685   }
686 
687   ArrayRef<int16_t> SubIndices = RI.getRegSplitParts(RC, EltSize);
688   bool Forward = RI.getHWRegIndex(DestReg) <= RI.getHWRegIndex(SrcReg);
689 
690   for (unsigned Idx = 0; Idx < SubIndices.size(); ++Idx) {
691     unsigned SubIdx;
692     if (Forward)
693       SubIdx = SubIndices[Idx];
694     else
695       SubIdx = SubIndices[SubIndices.size() - Idx - 1];
696 
697     if (Opcode == TargetOpcode::COPY) {
698       copyPhysReg(MBB, MI, DL, RI.getSubReg(DestReg, SubIdx),
699                   RI.getSubReg(SrcReg, SubIdx), KillSrc);
700       continue;
701     }
702 
703     MachineInstrBuilder Builder = BuildMI(MBB, MI, DL,
704       get(Opcode), RI.getSubReg(DestReg, SubIdx));
705 
706     Builder.addReg(RI.getSubReg(SrcReg, SubIdx));
707 
708     if (Idx == 0)
709       Builder.addReg(DestReg, RegState::Define | RegState::Implicit);
710 
711     bool UseKill = KillSrc && Idx == SubIndices.size() - 1;
712     Builder.addReg(SrcReg, getKillRegState(UseKill) | RegState::Implicit);
713   }
714 }
715 
716 int SIInstrInfo::commuteOpcode(unsigned Opcode) const {
717   int NewOpc;
718 
719   // Try to map original to commuted opcode
720   NewOpc = AMDGPU::getCommuteRev(Opcode);
721   if (NewOpc != -1)
722     // Check if the commuted (REV) opcode exists on the target.
723     return pseudoToMCOpcode(NewOpc) != -1 ? NewOpc : -1;
724 
725   // Try to map commuted to original opcode
726   NewOpc = AMDGPU::getCommuteOrig(Opcode);
727   if (NewOpc != -1)
728     // Check if the original (non-REV) opcode exists on the target.
729     return pseudoToMCOpcode(NewOpc) != -1 ? NewOpc : -1;
730 
731   return Opcode;
732 }
733 
734 void SIInstrInfo::materializeImmediate(MachineBasicBlock &MBB,
735                                        MachineBasicBlock::iterator MI,
736                                        const DebugLoc &DL, unsigned DestReg,
737                                        int64_t Value) const {
738   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
739   const TargetRegisterClass *RegClass = MRI.getRegClass(DestReg);
740   if (RegClass == &AMDGPU::SReg_32RegClass ||
741       RegClass == &AMDGPU::SGPR_32RegClass ||
742       RegClass == &AMDGPU::SReg_32_XM0RegClass ||
743       RegClass == &AMDGPU::SReg_32_XM0_XEXECRegClass) {
744     BuildMI(MBB, MI, DL, get(AMDGPU::S_MOV_B32), DestReg)
745       .addImm(Value);
746     return;
747   }
748 
749   if (RegClass == &AMDGPU::SReg_64RegClass ||
750       RegClass == &AMDGPU::SGPR_64RegClass ||
751       RegClass == &AMDGPU::SReg_64_XEXECRegClass) {
752     BuildMI(MBB, MI, DL, get(AMDGPU::S_MOV_B64), DestReg)
753       .addImm(Value);
754     return;
755   }
756 
757   if (RegClass == &AMDGPU::VGPR_32RegClass) {
758     BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B32_e32), DestReg)
759       .addImm(Value);
760     return;
761   }
762   if (RegClass == &AMDGPU::VReg_64RegClass) {
763     BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B64_PSEUDO), DestReg)
764       .addImm(Value);
765     return;
766   }
767 
768   unsigned EltSize = 4;
769   unsigned Opcode = AMDGPU::V_MOV_B32_e32;
770   if (RI.isSGPRClass(RegClass)) {
771     if (RI.getRegSizeInBits(*RegClass) > 32) {
772       Opcode =  AMDGPU::S_MOV_B64;
773       EltSize = 8;
774     } else {
775       Opcode = AMDGPU::S_MOV_B32;
776       EltSize = 4;
777     }
778   }
779 
780   ArrayRef<int16_t> SubIndices = RI.getRegSplitParts(RegClass, EltSize);
781   for (unsigned Idx = 0; Idx < SubIndices.size(); ++Idx) {
782     int64_t IdxValue = Idx == 0 ? Value : 0;
783 
784     MachineInstrBuilder Builder = BuildMI(MBB, MI, DL,
785       get(Opcode), RI.getSubReg(DestReg, Idx));
786     Builder.addImm(IdxValue);
787   }
788 }
789 
790 const TargetRegisterClass *
791 SIInstrInfo::getPreferredSelectRegClass(unsigned Size) const {
792   return &AMDGPU::VGPR_32RegClass;
793 }
794 
795 void SIInstrInfo::insertVectorSelect(MachineBasicBlock &MBB,
796                                      MachineBasicBlock::iterator I,
797                                      const DebugLoc &DL, unsigned DstReg,
798                                      ArrayRef<MachineOperand> Cond,
799                                      unsigned TrueReg,
800                                      unsigned FalseReg) const {
801   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
802   MachineFunction *MF = MBB.getParent();
803   const GCNSubtarget &ST = MF->getSubtarget<GCNSubtarget>();
804   const TargetRegisterClass *BoolXExecRC =
805     RI.getRegClass(AMDGPU::SReg_1_XEXECRegClassID);
806   assert(MRI.getRegClass(DstReg) == &AMDGPU::VGPR_32RegClass &&
807          "Not a VGPR32 reg");
808 
809   if (Cond.size() == 1) {
810     unsigned SReg = MRI.createVirtualRegister(BoolXExecRC);
811     BuildMI(MBB, I, DL, get(AMDGPU::COPY), SReg)
812       .add(Cond[0]);
813     BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
814       .addImm(0)
815       .addReg(FalseReg)
816       .addImm(0)
817       .addReg(TrueReg)
818       .addReg(SReg);
819   } else if (Cond.size() == 2) {
820     assert(Cond[0].isImm() && "Cond[0] is not an immediate");
821     switch (Cond[0].getImm()) {
822     case SIInstrInfo::SCC_TRUE: {
823       unsigned SReg = MRI.createVirtualRegister(BoolXExecRC);
824       BuildMI(MBB, I, DL, get(ST.isWave32() ? AMDGPU::S_CSELECT_B32
825                                             : AMDGPU::S_CSELECT_B64), SReg)
826         .addImm(-1)
827         .addImm(0);
828       BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
829         .addImm(0)
830         .addReg(FalseReg)
831         .addImm(0)
832         .addReg(TrueReg)
833         .addReg(SReg);
834       break;
835     }
836     case SIInstrInfo::SCC_FALSE: {
837       unsigned SReg = MRI.createVirtualRegister(BoolXExecRC);
838       BuildMI(MBB, I, DL, get(ST.isWave32() ? AMDGPU::S_CSELECT_B32
839                                             : AMDGPU::S_CSELECT_B64), SReg)
840         .addImm(0)
841         .addImm(-1);
842       BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
843         .addImm(0)
844         .addReg(FalseReg)
845         .addImm(0)
846         .addReg(TrueReg)
847         .addReg(SReg);
848       break;
849     }
850     case SIInstrInfo::VCCNZ: {
851       MachineOperand RegOp = Cond[1];
852       RegOp.setImplicit(false);
853       unsigned SReg = MRI.createVirtualRegister(BoolXExecRC);
854       BuildMI(MBB, I, DL, get(AMDGPU::COPY), SReg)
855         .add(RegOp);
856       BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
857           .addImm(0)
858           .addReg(FalseReg)
859           .addImm(0)
860           .addReg(TrueReg)
861           .addReg(SReg);
862       break;
863     }
864     case SIInstrInfo::VCCZ: {
865       MachineOperand RegOp = Cond[1];
866       RegOp.setImplicit(false);
867       unsigned SReg = MRI.createVirtualRegister(BoolXExecRC);
868       BuildMI(MBB, I, DL, get(AMDGPU::COPY), SReg)
869         .add(RegOp);
870       BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
871           .addImm(0)
872           .addReg(TrueReg)
873           .addImm(0)
874           .addReg(FalseReg)
875           .addReg(SReg);
876       break;
877     }
878     case SIInstrInfo::EXECNZ: {
879       unsigned SReg = MRI.createVirtualRegister(BoolXExecRC);
880       unsigned SReg2 = MRI.createVirtualRegister(RI.getBoolRC());
881       BuildMI(MBB, I, DL, get(ST.isWave32() ? AMDGPU::S_OR_SAVEEXEC_B32
882                                             : AMDGPU::S_OR_SAVEEXEC_B64), SReg2)
883         .addImm(0);
884       BuildMI(MBB, I, DL, get(ST.isWave32() ? AMDGPU::S_CSELECT_B32
885                                             : AMDGPU::S_CSELECT_B64), SReg)
886         .addImm(-1)
887         .addImm(0);
888       BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
889         .addImm(0)
890         .addReg(FalseReg)
891         .addImm(0)
892         .addReg(TrueReg)
893         .addReg(SReg);
894       break;
895     }
896     case SIInstrInfo::EXECZ: {
897       unsigned SReg = MRI.createVirtualRegister(BoolXExecRC);
898       unsigned SReg2 = MRI.createVirtualRegister(RI.getBoolRC());
899       BuildMI(MBB, I, DL, get(ST.isWave32() ? AMDGPU::S_OR_SAVEEXEC_B32
900                                             : AMDGPU::S_OR_SAVEEXEC_B64), SReg2)
901         .addImm(0);
902       BuildMI(MBB, I, DL, get(ST.isWave32() ? AMDGPU::S_CSELECT_B32
903                                             : AMDGPU::S_CSELECT_B64), SReg)
904         .addImm(0)
905         .addImm(-1);
906       BuildMI(MBB, I, DL, get(AMDGPU::V_CNDMASK_B32_e64), DstReg)
907         .addImm(0)
908         .addReg(FalseReg)
909         .addImm(0)
910         .addReg(TrueReg)
911         .addReg(SReg);
912       llvm_unreachable("Unhandled branch predicate EXECZ");
913       break;
914     }
915     default:
916       llvm_unreachable("invalid branch predicate");
917     }
918   } else {
919     llvm_unreachable("Can only handle Cond size 1 or 2");
920   }
921 }
922 
923 unsigned SIInstrInfo::insertEQ(MachineBasicBlock *MBB,
924                                MachineBasicBlock::iterator I,
925                                const DebugLoc &DL,
926                                unsigned SrcReg, int Value) const {
927   MachineRegisterInfo &MRI = MBB->getParent()->getRegInfo();
928   unsigned Reg = MRI.createVirtualRegister(RI.getBoolRC());
929   BuildMI(*MBB, I, DL, get(AMDGPU::V_CMP_EQ_I32_e64), Reg)
930     .addImm(Value)
931     .addReg(SrcReg);
932 
933   return Reg;
934 }
935 
936 unsigned SIInstrInfo::insertNE(MachineBasicBlock *MBB,
937                                MachineBasicBlock::iterator I,
938                                const DebugLoc &DL,
939                                unsigned SrcReg, int Value) const {
940   MachineRegisterInfo &MRI = MBB->getParent()->getRegInfo();
941   unsigned Reg = MRI.createVirtualRegister(RI.getBoolRC());
942   BuildMI(*MBB, I, DL, get(AMDGPU::V_CMP_NE_I32_e64), Reg)
943     .addImm(Value)
944     .addReg(SrcReg);
945 
946   return Reg;
947 }
948 
949 unsigned SIInstrInfo::getMovOpcode(const TargetRegisterClass *DstRC) const {
950 
951   if (RI.hasAGPRs(DstRC))
952     return AMDGPU::COPY;
953   if (RI.getRegSizeInBits(*DstRC) == 32) {
954     return RI.isSGPRClass(DstRC) ? AMDGPU::S_MOV_B32 : AMDGPU::V_MOV_B32_e32;
955   } else if (RI.getRegSizeInBits(*DstRC) == 64 && RI.isSGPRClass(DstRC)) {
956     return AMDGPU::S_MOV_B64;
957   } else if (RI.getRegSizeInBits(*DstRC) == 64 && !RI.isSGPRClass(DstRC)) {
958     return  AMDGPU::V_MOV_B64_PSEUDO;
959   }
960   return AMDGPU::COPY;
961 }
962 
963 static unsigned getSGPRSpillSaveOpcode(unsigned Size) {
964   switch (Size) {
965   case 4:
966     return AMDGPU::SI_SPILL_S32_SAVE;
967   case 8:
968     return AMDGPU::SI_SPILL_S64_SAVE;
969   case 12:
970     return AMDGPU::SI_SPILL_S96_SAVE;
971   case 16:
972     return AMDGPU::SI_SPILL_S128_SAVE;
973   case 20:
974     return AMDGPU::SI_SPILL_S160_SAVE;
975   case 32:
976     return AMDGPU::SI_SPILL_S256_SAVE;
977   case 64:
978     return AMDGPU::SI_SPILL_S512_SAVE;
979   case 128:
980     return AMDGPU::SI_SPILL_S1024_SAVE;
981   default:
982     llvm_unreachable("unknown register size");
983   }
984 }
985 
986 static unsigned getVGPRSpillSaveOpcode(unsigned Size) {
987   switch (Size) {
988   case 4:
989     return AMDGPU::SI_SPILL_V32_SAVE;
990   case 8:
991     return AMDGPU::SI_SPILL_V64_SAVE;
992   case 12:
993     return AMDGPU::SI_SPILL_V96_SAVE;
994   case 16:
995     return AMDGPU::SI_SPILL_V128_SAVE;
996   case 20:
997     return AMDGPU::SI_SPILL_V160_SAVE;
998   case 32:
999     return AMDGPU::SI_SPILL_V256_SAVE;
1000   case 64:
1001     return AMDGPU::SI_SPILL_V512_SAVE;
1002   case 128:
1003     return AMDGPU::SI_SPILL_V1024_SAVE;
1004   default:
1005     llvm_unreachable("unknown register size");
1006   }
1007 }
1008 
1009 static unsigned getAGPRSpillSaveOpcode(unsigned Size) {
1010   switch (Size) {
1011   case 4:
1012     return AMDGPU::SI_SPILL_A32_SAVE;
1013   case 8:
1014     return AMDGPU::SI_SPILL_A64_SAVE;
1015   case 16:
1016     return AMDGPU::SI_SPILL_A128_SAVE;
1017   case 64:
1018     return AMDGPU::SI_SPILL_A512_SAVE;
1019   case 128:
1020     return AMDGPU::SI_SPILL_A1024_SAVE;
1021   default:
1022     llvm_unreachable("unknown register size");
1023   }
1024 }
1025 
1026 void SIInstrInfo::storeRegToStackSlot(MachineBasicBlock &MBB,
1027                                       MachineBasicBlock::iterator MI,
1028                                       unsigned SrcReg, bool isKill,
1029                                       int FrameIndex,
1030                                       const TargetRegisterClass *RC,
1031                                       const TargetRegisterInfo *TRI) const {
1032   MachineFunction *MF = MBB.getParent();
1033   SIMachineFunctionInfo *MFI = MF->getInfo<SIMachineFunctionInfo>();
1034   MachineFrameInfo &FrameInfo = MF->getFrameInfo();
1035   const DebugLoc &DL = MBB.findDebugLoc(MI);
1036 
1037   unsigned Size = FrameInfo.getObjectSize(FrameIndex);
1038   unsigned Align = FrameInfo.getObjectAlignment(FrameIndex);
1039   MachinePointerInfo PtrInfo
1040     = MachinePointerInfo::getFixedStack(*MF, FrameIndex);
1041   MachineMemOperand *MMO
1042     = MF->getMachineMemOperand(PtrInfo, MachineMemOperand::MOStore,
1043                                Size, Align);
1044   unsigned SpillSize = TRI->getSpillSize(*RC);
1045 
1046   if (RI.isSGPRClass(RC)) {
1047     MFI->setHasSpilledSGPRs();
1048 
1049     // We are only allowed to create one new instruction when spilling
1050     // registers, so we need to use pseudo instruction for spilling SGPRs.
1051     const MCInstrDesc &OpDesc = get(getSGPRSpillSaveOpcode(SpillSize));
1052 
1053     // The SGPR spill/restore instructions only work on number sgprs, so we need
1054     // to make sure we are using the correct register class.
1055     if (Register::isVirtualRegister(SrcReg) && SpillSize == 4) {
1056       MachineRegisterInfo &MRI = MF->getRegInfo();
1057       MRI.constrainRegClass(SrcReg, &AMDGPU::SReg_32_XM0RegClass);
1058     }
1059 
1060     MachineInstrBuilder Spill = BuildMI(MBB, MI, DL, OpDesc)
1061       .addReg(SrcReg, getKillRegState(isKill)) // data
1062       .addFrameIndex(FrameIndex)               // addr
1063       .addMemOperand(MMO)
1064       .addReg(MFI->getScratchRSrcReg(), RegState::Implicit)
1065       .addReg(MFI->getStackPtrOffsetReg(), RegState::Implicit);
1066     // Add the scratch resource registers as implicit uses because we may end up
1067     // needing them, and need to ensure that the reserved registers are
1068     // correctly handled.
1069     if (RI.spillSGPRToVGPR())
1070       FrameInfo.setStackID(FrameIndex, TargetStackID::SGPRSpill);
1071     if (ST.hasScalarStores()) {
1072       // m0 is used for offset to scalar stores if used to spill.
1073       Spill.addReg(AMDGPU::M0, RegState::ImplicitDefine | RegState::Dead);
1074     }
1075 
1076     return;
1077   }
1078 
1079   unsigned Opcode = RI.hasAGPRs(RC) ? getAGPRSpillSaveOpcode(SpillSize)
1080                                     : getVGPRSpillSaveOpcode(SpillSize);
1081   MFI->setHasSpilledVGPRs();
1082 
1083   auto MIB = BuildMI(MBB, MI, DL, get(Opcode));
1084   if (RI.hasAGPRs(RC)) {
1085     MachineRegisterInfo &MRI = MF->getRegInfo();
1086     unsigned Tmp = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
1087     MIB.addReg(Tmp, RegState::Define);
1088   }
1089   MIB.addReg(SrcReg, getKillRegState(isKill)) // data
1090      .addFrameIndex(FrameIndex)               // addr
1091      .addReg(MFI->getScratchRSrcReg())        // scratch_rsrc
1092      .addReg(MFI->getStackPtrOffsetReg())     // scratch_offset
1093      .addImm(0)                               // offset
1094      .addMemOperand(MMO);
1095 }
1096 
1097 static unsigned getSGPRSpillRestoreOpcode(unsigned Size) {
1098   switch (Size) {
1099   case 4:
1100     return AMDGPU::SI_SPILL_S32_RESTORE;
1101   case 8:
1102     return AMDGPU::SI_SPILL_S64_RESTORE;
1103   case 12:
1104     return AMDGPU::SI_SPILL_S96_RESTORE;
1105   case 16:
1106     return AMDGPU::SI_SPILL_S128_RESTORE;
1107   case 20:
1108     return AMDGPU::SI_SPILL_S160_RESTORE;
1109   case 32:
1110     return AMDGPU::SI_SPILL_S256_RESTORE;
1111   case 64:
1112     return AMDGPU::SI_SPILL_S512_RESTORE;
1113   case 128:
1114     return AMDGPU::SI_SPILL_S1024_RESTORE;
1115   default:
1116     llvm_unreachable("unknown register size");
1117   }
1118 }
1119 
1120 static unsigned getVGPRSpillRestoreOpcode(unsigned Size) {
1121   switch (Size) {
1122   case 4:
1123     return AMDGPU::SI_SPILL_V32_RESTORE;
1124   case 8:
1125     return AMDGPU::SI_SPILL_V64_RESTORE;
1126   case 12:
1127     return AMDGPU::SI_SPILL_V96_RESTORE;
1128   case 16:
1129     return AMDGPU::SI_SPILL_V128_RESTORE;
1130   case 20:
1131     return AMDGPU::SI_SPILL_V160_RESTORE;
1132   case 32:
1133     return AMDGPU::SI_SPILL_V256_RESTORE;
1134   case 64:
1135     return AMDGPU::SI_SPILL_V512_RESTORE;
1136   case 128:
1137     return AMDGPU::SI_SPILL_V1024_RESTORE;
1138   default:
1139     llvm_unreachable("unknown register size");
1140   }
1141 }
1142 
1143 static unsigned getAGPRSpillRestoreOpcode(unsigned Size) {
1144   switch (Size) {
1145   case 4:
1146     return AMDGPU::SI_SPILL_A32_RESTORE;
1147   case 8:
1148     return AMDGPU::SI_SPILL_A64_RESTORE;
1149   case 16:
1150     return AMDGPU::SI_SPILL_A128_RESTORE;
1151   case 64:
1152     return AMDGPU::SI_SPILL_A512_RESTORE;
1153   case 128:
1154     return AMDGPU::SI_SPILL_A1024_RESTORE;
1155   default:
1156     llvm_unreachable("unknown register size");
1157   }
1158 }
1159 
1160 void SIInstrInfo::loadRegFromStackSlot(MachineBasicBlock &MBB,
1161                                        MachineBasicBlock::iterator MI,
1162                                        unsigned DestReg, int FrameIndex,
1163                                        const TargetRegisterClass *RC,
1164                                        const TargetRegisterInfo *TRI) const {
1165   MachineFunction *MF = MBB.getParent();
1166   SIMachineFunctionInfo *MFI = MF->getInfo<SIMachineFunctionInfo>();
1167   MachineFrameInfo &FrameInfo = MF->getFrameInfo();
1168   const DebugLoc &DL = MBB.findDebugLoc(MI);
1169   unsigned Align = FrameInfo.getObjectAlignment(FrameIndex);
1170   unsigned Size = FrameInfo.getObjectSize(FrameIndex);
1171   unsigned SpillSize = TRI->getSpillSize(*RC);
1172 
1173   MachinePointerInfo PtrInfo
1174     = MachinePointerInfo::getFixedStack(*MF, FrameIndex);
1175 
1176   MachineMemOperand *MMO = MF->getMachineMemOperand(
1177     PtrInfo, MachineMemOperand::MOLoad, Size, Align);
1178 
1179   if (RI.isSGPRClass(RC)) {
1180     MFI->setHasSpilledSGPRs();
1181 
1182     // FIXME: Maybe this should not include a memoperand because it will be
1183     // lowered to non-memory instructions.
1184     const MCInstrDesc &OpDesc = get(getSGPRSpillRestoreOpcode(SpillSize));
1185     if (Register::isVirtualRegister(DestReg) && SpillSize == 4) {
1186       MachineRegisterInfo &MRI = MF->getRegInfo();
1187       MRI.constrainRegClass(DestReg, &AMDGPU::SReg_32_XM0RegClass);
1188     }
1189 
1190     if (RI.spillSGPRToVGPR())
1191       FrameInfo.setStackID(FrameIndex, TargetStackID::SGPRSpill);
1192     MachineInstrBuilder Spill = BuildMI(MBB, MI, DL, OpDesc, DestReg)
1193       .addFrameIndex(FrameIndex) // addr
1194       .addMemOperand(MMO)
1195       .addReg(MFI->getScratchRSrcReg(), RegState::Implicit)
1196       .addReg(MFI->getStackPtrOffsetReg(), RegState::Implicit);
1197 
1198     if (ST.hasScalarStores()) {
1199       // m0 is used for offset to scalar stores if used to spill.
1200       Spill.addReg(AMDGPU::M0, RegState::ImplicitDefine | RegState::Dead);
1201     }
1202 
1203     return;
1204   }
1205 
1206   unsigned Opcode = RI.hasAGPRs(RC) ? getAGPRSpillRestoreOpcode(SpillSize)
1207                                     : getVGPRSpillRestoreOpcode(SpillSize);
1208   auto MIB = BuildMI(MBB, MI, DL, get(Opcode), DestReg);
1209   if (RI.hasAGPRs(RC)) {
1210     MachineRegisterInfo &MRI = MF->getRegInfo();
1211     unsigned Tmp = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
1212     MIB.addReg(Tmp, RegState::Define);
1213   }
1214   MIB.addFrameIndex(FrameIndex)        // vaddr
1215      .addReg(MFI->getScratchRSrcReg()) // scratch_rsrc
1216      .addReg(MFI->getStackPtrOffsetReg()) // scratch_offset
1217      .addImm(0)                           // offset
1218      .addMemOperand(MMO);
1219 }
1220 
1221 /// \param @Offset Offset in bytes of the FrameIndex being spilled
1222 unsigned SIInstrInfo::calculateLDSSpillAddress(
1223     MachineBasicBlock &MBB, MachineInstr &MI, RegScavenger *RS, unsigned TmpReg,
1224     unsigned FrameOffset, unsigned Size) const {
1225   MachineFunction *MF = MBB.getParent();
1226   SIMachineFunctionInfo *MFI = MF->getInfo<SIMachineFunctionInfo>();
1227   const GCNSubtarget &ST = MF->getSubtarget<GCNSubtarget>();
1228   const DebugLoc &DL = MBB.findDebugLoc(MI);
1229   unsigned WorkGroupSize = MFI->getMaxFlatWorkGroupSize();
1230   unsigned WavefrontSize = ST.getWavefrontSize();
1231 
1232   unsigned TIDReg = MFI->getTIDReg();
1233   if (!MFI->hasCalculatedTID()) {
1234     MachineBasicBlock &Entry = MBB.getParent()->front();
1235     MachineBasicBlock::iterator Insert = Entry.front();
1236     const DebugLoc &DL = Insert->getDebugLoc();
1237 
1238     TIDReg = RI.findUnusedRegister(MF->getRegInfo(), &AMDGPU::VGPR_32RegClass,
1239                                    *MF);
1240     if (TIDReg == AMDGPU::NoRegister)
1241       return TIDReg;
1242 
1243     if (!AMDGPU::isShader(MF->getFunction().getCallingConv()) &&
1244         WorkGroupSize > WavefrontSize) {
1245       unsigned TIDIGXReg
1246         = MFI->getPreloadedReg(AMDGPUFunctionArgInfo::WORKGROUP_ID_X);
1247       unsigned TIDIGYReg
1248         = MFI->getPreloadedReg(AMDGPUFunctionArgInfo::WORKGROUP_ID_Y);
1249       unsigned TIDIGZReg
1250         = MFI->getPreloadedReg(AMDGPUFunctionArgInfo::WORKGROUP_ID_Z);
1251       unsigned InputPtrReg =
1252           MFI->getPreloadedReg(AMDGPUFunctionArgInfo::KERNARG_SEGMENT_PTR);
1253       for (unsigned Reg : {TIDIGXReg, TIDIGYReg, TIDIGZReg}) {
1254         if (!Entry.isLiveIn(Reg))
1255           Entry.addLiveIn(Reg);
1256       }
1257 
1258       RS->enterBasicBlock(Entry);
1259       // FIXME: Can we scavenge an SReg_64 and access the subregs?
1260       unsigned STmp0 = RS->scavengeRegister(&AMDGPU::SGPR_32RegClass, 0);
1261       unsigned STmp1 = RS->scavengeRegister(&AMDGPU::SGPR_32RegClass, 0);
1262       BuildMI(Entry, Insert, DL, get(AMDGPU::S_LOAD_DWORD_IMM), STmp0)
1263               .addReg(InputPtrReg)
1264               .addImm(SI::KernelInputOffsets::NGROUPS_Z);
1265       BuildMI(Entry, Insert, DL, get(AMDGPU::S_LOAD_DWORD_IMM), STmp1)
1266               .addReg(InputPtrReg)
1267               .addImm(SI::KernelInputOffsets::NGROUPS_Y);
1268 
1269       // NGROUPS.X * NGROUPS.Y
1270       BuildMI(Entry, Insert, DL, get(AMDGPU::S_MUL_I32), STmp1)
1271               .addReg(STmp1)
1272               .addReg(STmp0);
1273       // (NGROUPS.X * NGROUPS.Y) * TIDIG.X
1274       BuildMI(Entry, Insert, DL, get(AMDGPU::V_MUL_U32_U24_e32), TIDReg)
1275               .addReg(STmp1)
1276               .addReg(TIDIGXReg);
1277       // NGROUPS.Z * TIDIG.Y + (NGROUPS.X * NGROPUS.Y * TIDIG.X)
1278       BuildMI(Entry, Insert, DL, get(AMDGPU::V_MAD_U32_U24), TIDReg)
1279               .addReg(STmp0)
1280               .addReg(TIDIGYReg)
1281               .addReg(TIDReg);
1282       // (NGROUPS.Z * TIDIG.Y + (NGROUPS.X * NGROPUS.Y * TIDIG.X)) + TIDIG.Z
1283       getAddNoCarry(Entry, Insert, DL, TIDReg)
1284         .addReg(TIDReg)
1285         .addReg(TIDIGZReg)
1286         .addImm(0); // clamp bit
1287     } else {
1288       // Get the wave id
1289       BuildMI(Entry, Insert, DL, get(AMDGPU::V_MBCNT_LO_U32_B32_e64),
1290               TIDReg)
1291               .addImm(-1)
1292               .addImm(0);
1293 
1294       BuildMI(Entry, Insert, DL, get(AMDGPU::V_MBCNT_HI_U32_B32_e64),
1295               TIDReg)
1296               .addImm(-1)
1297               .addReg(TIDReg);
1298     }
1299 
1300     BuildMI(Entry, Insert, DL, get(AMDGPU::V_LSHLREV_B32_e32),
1301             TIDReg)
1302             .addImm(2)
1303             .addReg(TIDReg);
1304     MFI->setTIDReg(TIDReg);
1305   }
1306 
1307   // Add FrameIndex to LDS offset
1308   unsigned LDSOffset = MFI->getLDSSize() + (FrameOffset * WorkGroupSize);
1309   getAddNoCarry(MBB, MI, DL, TmpReg)
1310     .addImm(LDSOffset)
1311     .addReg(TIDReg)
1312     .addImm(0); // clamp bit
1313 
1314   return TmpReg;
1315 }
1316 
1317 void SIInstrInfo::insertWaitStates(MachineBasicBlock &MBB,
1318                                    MachineBasicBlock::iterator MI,
1319                                    int Count) const {
1320   DebugLoc DL = MBB.findDebugLoc(MI);
1321   while (Count > 0) {
1322     int Arg;
1323     if (Count >= 8)
1324       Arg = 7;
1325     else
1326       Arg = Count - 1;
1327     Count -= 8;
1328     BuildMI(MBB, MI, DL, get(AMDGPU::S_NOP))
1329             .addImm(Arg);
1330   }
1331 }
1332 
1333 void SIInstrInfo::insertNoop(MachineBasicBlock &MBB,
1334                              MachineBasicBlock::iterator MI) const {
1335   insertWaitStates(MBB, MI, 1);
1336 }
1337 
1338 void SIInstrInfo::insertReturn(MachineBasicBlock &MBB) const {
1339   auto MF = MBB.getParent();
1340   SIMachineFunctionInfo *Info = MF->getInfo<SIMachineFunctionInfo>();
1341 
1342   assert(Info->isEntryFunction());
1343 
1344   if (MBB.succ_empty()) {
1345     bool HasNoTerminator = MBB.getFirstTerminator() == MBB.end();
1346     if (HasNoTerminator) {
1347       if (Info->returnsVoid()) {
1348         BuildMI(MBB, MBB.end(), DebugLoc(), get(AMDGPU::S_ENDPGM)).addImm(0);
1349       } else {
1350         BuildMI(MBB, MBB.end(), DebugLoc(), get(AMDGPU::SI_RETURN_TO_EPILOG));
1351       }
1352     }
1353   }
1354 }
1355 
1356 unsigned SIInstrInfo::getNumWaitStates(const MachineInstr &MI) {
1357   switch (MI.getOpcode()) {
1358   default: return 1; // FIXME: Do wait states equal cycles?
1359 
1360   case AMDGPU::S_NOP:
1361     return MI.getOperand(0).getImm() + 1;
1362   }
1363 }
1364 
1365 bool SIInstrInfo::expandPostRAPseudo(MachineInstr &MI) const {
1366   MachineBasicBlock &MBB = *MI.getParent();
1367   DebugLoc DL = MBB.findDebugLoc(MI);
1368   switch (MI.getOpcode()) {
1369   default: return TargetInstrInfo::expandPostRAPseudo(MI);
1370   case AMDGPU::S_MOV_B64_term:
1371     // This is only a terminator to get the correct spill code placement during
1372     // register allocation.
1373     MI.setDesc(get(AMDGPU::S_MOV_B64));
1374     break;
1375 
1376   case AMDGPU::S_MOV_B32_term:
1377     // This is only a terminator to get the correct spill code placement during
1378     // register allocation.
1379     MI.setDesc(get(AMDGPU::S_MOV_B32));
1380     break;
1381 
1382   case AMDGPU::S_XOR_B64_term:
1383     // This is only a terminator to get the correct spill code placement during
1384     // register allocation.
1385     MI.setDesc(get(AMDGPU::S_XOR_B64));
1386     break;
1387 
1388   case AMDGPU::S_XOR_B32_term:
1389     // This is only a terminator to get the correct spill code placement during
1390     // register allocation.
1391     MI.setDesc(get(AMDGPU::S_XOR_B32));
1392     break;
1393 
1394   case AMDGPU::S_OR_B32_term:
1395     // This is only a terminator to get the correct spill code placement during
1396     // register allocation.
1397     MI.setDesc(get(AMDGPU::S_OR_B32));
1398     break;
1399 
1400   case AMDGPU::S_OR_B64_term:
1401     // This is only a terminator to get the correct spill code placement during
1402     // register allocation.
1403     MI.setDesc(get(AMDGPU::S_OR_B64));
1404     break;
1405 
1406   case AMDGPU::S_ANDN2_B64_term:
1407     // This is only a terminator to get the correct spill code placement during
1408     // register allocation.
1409     MI.setDesc(get(AMDGPU::S_ANDN2_B64));
1410     break;
1411 
1412   case AMDGPU::S_ANDN2_B32_term:
1413     // This is only a terminator to get the correct spill code placement during
1414     // register allocation.
1415     MI.setDesc(get(AMDGPU::S_ANDN2_B32));
1416     break;
1417 
1418   case AMDGPU::V_MOV_B64_PSEUDO: {
1419     unsigned Dst = MI.getOperand(0).getReg();
1420     unsigned DstLo = RI.getSubReg(Dst, AMDGPU::sub0);
1421     unsigned DstHi = RI.getSubReg(Dst, AMDGPU::sub1);
1422 
1423     const MachineOperand &SrcOp = MI.getOperand(1);
1424     // FIXME: Will this work for 64-bit floating point immediates?
1425     assert(!SrcOp.isFPImm());
1426     if (SrcOp.isImm()) {
1427       APInt Imm(64, SrcOp.getImm());
1428       BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B32_e32), DstLo)
1429         .addImm(Imm.getLoBits(32).getZExtValue())
1430         .addReg(Dst, RegState::Implicit | RegState::Define);
1431       BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B32_e32), DstHi)
1432         .addImm(Imm.getHiBits(32).getZExtValue())
1433         .addReg(Dst, RegState::Implicit | RegState::Define);
1434     } else {
1435       assert(SrcOp.isReg());
1436       BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B32_e32), DstLo)
1437         .addReg(RI.getSubReg(SrcOp.getReg(), AMDGPU::sub0))
1438         .addReg(Dst, RegState::Implicit | RegState::Define);
1439       BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B32_e32), DstHi)
1440         .addReg(RI.getSubReg(SrcOp.getReg(), AMDGPU::sub1))
1441         .addReg(Dst, RegState::Implicit | RegState::Define);
1442     }
1443     MI.eraseFromParent();
1444     break;
1445   }
1446   case AMDGPU::V_SET_INACTIVE_B32: {
1447     unsigned NotOpc = ST.isWave32() ? AMDGPU::S_NOT_B32 : AMDGPU::S_NOT_B64;
1448     unsigned Exec = ST.isWave32() ? AMDGPU::EXEC_LO : AMDGPU::EXEC;
1449     BuildMI(MBB, MI, DL, get(NotOpc), Exec)
1450       .addReg(Exec);
1451     BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B32_e32), MI.getOperand(0).getReg())
1452       .add(MI.getOperand(2));
1453     BuildMI(MBB, MI, DL, get(NotOpc), Exec)
1454       .addReg(Exec);
1455     MI.eraseFromParent();
1456     break;
1457   }
1458   case AMDGPU::V_SET_INACTIVE_B64: {
1459     unsigned NotOpc = ST.isWave32() ? AMDGPU::S_NOT_B32 : AMDGPU::S_NOT_B64;
1460     unsigned Exec = ST.isWave32() ? AMDGPU::EXEC_LO : AMDGPU::EXEC;
1461     BuildMI(MBB, MI, DL, get(NotOpc), Exec)
1462       .addReg(Exec);
1463     MachineInstr *Copy = BuildMI(MBB, MI, DL, get(AMDGPU::V_MOV_B64_PSEUDO),
1464                                  MI.getOperand(0).getReg())
1465       .add(MI.getOperand(2));
1466     expandPostRAPseudo(*Copy);
1467     BuildMI(MBB, MI, DL, get(NotOpc), Exec)
1468       .addReg(Exec);
1469     MI.eraseFromParent();
1470     break;
1471   }
1472   case AMDGPU::V_MOVRELD_B32_V1:
1473   case AMDGPU::V_MOVRELD_B32_V2:
1474   case AMDGPU::V_MOVRELD_B32_V4:
1475   case AMDGPU::V_MOVRELD_B32_V8:
1476   case AMDGPU::V_MOVRELD_B32_V16: {
1477     const MCInstrDesc &MovRelDesc = get(AMDGPU::V_MOVRELD_B32_e32);
1478     unsigned VecReg = MI.getOperand(0).getReg();
1479     bool IsUndef = MI.getOperand(1).isUndef();
1480     unsigned SubReg = AMDGPU::sub0 + MI.getOperand(3).getImm();
1481     assert(VecReg == MI.getOperand(1).getReg());
1482 
1483     MachineInstr *MovRel =
1484         BuildMI(MBB, MI, DL, MovRelDesc)
1485             .addReg(RI.getSubReg(VecReg, SubReg), RegState::Undef)
1486             .add(MI.getOperand(2))
1487             .addReg(VecReg, RegState::ImplicitDefine)
1488             .addReg(VecReg,
1489                     RegState::Implicit | (IsUndef ? RegState::Undef : 0));
1490 
1491     const int ImpDefIdx =
1492         MovRelDesc.getNumOperands() + MovRelDesc.getNumImplicitUses();
1493     const int ImpUseIdx = ImpDefIdx + 1;
1494     MovRel->tieOperands(ImpDefIdx, ImpUseIdx);
1495 
1496     MI.eraseFromParent();
1497     break;
1498   }
1499   case AMDGPU::SI_PC_ADD_REL_OFFSET: {
1500     MachineFunction &MF = *MBB.getParent();
1501     unsigned Reg = MI.getOperand(0).getReg();
1502     unsigned RegLo = RI.getSubReg(Reg, AMDGPU::sub0);
1503     unsigned RegHi = RI.getSubReg(Reg, AMDGPU::sub1);
1504 
1505     // Create a bundle so these instructions won't be re-ordered by the
1506     // post-RA scheduler.
1507     MIBundleBuilder Bundler(MBB, MI);
1508     Bundler.append(BuildMI(MF, DL, get(AMDGPU::S_GETPC_B64), Reg));
1509 
1510     // Add 32-bit offset from this instruction to the start of the
1511     // constant data.
1512     Bundler.append(BuildMI(MF, DL, get(AMDGPU::S_ADD_U32), RegLo)
1513                        .addReg(RegLo)
1514                        .add(MI.getOperand(1)));
1515 
1516     MachineInstrBuilder MIB = BuildMI(MF, DL, get(AMDGPU::S_ADDC_U32), RegHi)
1517                                   .addReg(RegHi);
1518     MIB.add(MI.getOperand(2));
1519 
1520     Bundler.append(MIB);
1521     finalizeBundle(MBB, Bundler.begin());
1522 
1523     MI.eraseFromParent();
1524     break;
1525   }
1526   case AMDGPU::ENTER_WWM: {
1527     // This only gets its own opcode so that SIPreAllocateWWMRegs can tell when
1528     // WWM is entered.
1529     MI.setDesc(get(ST.isWave32() ? AMDGPU::S_OR_SAVEEXEC_B32
1530                                  : AMDGPU::S_OR_SAVEEXEC_B64));
1531     break;
1532   }
1533   case AMDGPU::EXIT_WWM: {
1534     // This only gets its own opcode so that SIPreAllocateWWMRegs can tell when
1535     // WWM is exited.
1536     MI.setDesc(get(ST.isWave32() ? AMDGPU::S_MOV_B32 : AMDGPU::S_MOV_B64));
1537     break;
1538   }
1539   case TargetOpcode::BUNDLE: {
1540     if (!MI.mayLoad() || MI.hasUnmodeledSideEffects())
1541       return false;
1542 
1543     // If it is a load it must be a memory clause
1544     for (MachineBasicBlock::instr_iterator I = MI.getIterator();
1545          I->isBundledWithSucc(); ++I) {
1546       I->unbundleFromSucc();
1547       for (MachineOperand &MO : I->operands())
1548         if (MO.isReg())
1549           MO.setIsInternalRead(false);
1550     }
1551 
1552     MI.eraseFromParent();
1553     break;
1554   }
1555   }
1556   return true;
1557 }
1558 
1559 bool SIInstrInfo::swapSourceModifiers(MachineInstr &MI,
1560                                       MachineOperand &Src0,
1561                                       unsigned Src0OpName,
1562                                       MachineOperand &Src1,
1563                                       unsigned Src1OpName) const {
1564   MachineOperand *Src0Mods = getNamedOperand(MI, Src0OpName);
1565   if (!Src0Mods)
1566     return false;
1567 
1568   MachineOperand *Src1Mods = getNamedOperand(MI, Src1OpName);
1569   assert(Src1Mods &&
1570          "All commutable instructions have both src0 and src1 modifiers");
1571 
1572   int Src0ModsVal = Src0Mods->getImm();
1573   int Src1ModsVal = Src1Mods->getImm();
1574 
1575   Src1Mods->setImm(Src0ModsVal);
1576   Src0Mods->setImm(Src1ModsVal);
1577   return true;
1578 }
1579 
1580 static MachineInstr *swapRegAndNonRegOperand(MachineInstr &MI,
1581                                              MachineOperand &RegOp,
1582                                              MachineOperand &NonRegOp) {
1583   unsigned Reg = RegOp.getReg();
1584   unsigned SubReg = RegOp.getSubReg();
1585   bool IsKill = RegOp.isKill();
1586   bool IsDead = RegOp.isDead();
1587   bool IsUndef = RegOp.isUndef();
1588   bool IsDebug = RegOp.isDebug();
1589 
1590   if (NonRegOp.isImm())
1591     RegOp.ChangeToImmediate(NonRegOp.getImm());
1592   else if (NonRegOp.isFI())
1593     RegOp.ChangeToFrameIndex(NonRegOp.getIndex());
1594   else
1595     return nullptr;
1596 
1597   NonRegOp.ChangeToRegister(Reg, false, false, IsKill, IsDead, IsUndef, IsDebug);
1598   NonRegOp.setSubReg(SubReg);
1599 
1600   return &MI;
1601 }
1602 
1603 MachineInstr *SIInstrInfo::commuteInstructionImpl(MachineInstr &MI, bool NewMI,
1604                                                   unsigned Src0Idx,
1605                                                   unsigned Src1Idx) const {
1606   assert(!NewMI && "this should never be used");
1607 
1608   unsigned Opc = MI.getOpcode();
1609   int CommutedOpcode = commuteOpcode(Opc);
1610   if (CommutedOpcode == -1)
1611     return nullptr;
1612 
1613   assert(AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0) ==
1614            static_cast<int>(Src0Idx) &&
1615          AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1) ==
1616            static_cast<int>(Src1Idx) &&
1617          "inconsistency with findCommutedOpIndices");
1618 
1619   MachineOperand &Src0 = MI.getOperand(Src0Idx);
1620   MachineOperand &Src1 = MI.getOperand(Src1Idx);
1621 
1622   MachineInstr *CommutedMI = nullptr;
1623   if (Src0.isReg() && Src1.isReg()) {
1624     if (isOperandLegal(MI, Src1Idx, &Src0)) {
1625       // Be sure to copy the source modifiers to the right place.
1626       CommutedMI
1627         = TargetInstrInfo::commuteInstructionImpl(MI, NewMI, Src0Idx, Src1Idx);
1628     }
1629 
1630   } else if (Src0.isReg() && !Src1.isReg()) {
1631     // src0 should always be able to support any operand type, so no need to
1632     // check operand legality.
1633     CommutedMI = swapRegAndNonRegOperand(MI, Src0, Src1);
1634   } else if (!Src0.isReg() && Src1.isReg()) {
1635     if (isOperandLegal(MI, Src1Idx, &Src0))
1636       CommutedMI = swapRegAndNonRegOperand(MI, Src1, Src0);
1637   } else {
1638     // FIXME: Found two non registers to commute. This does happen.
1639     return nullptr;
1640   }
1641 
1642   if (CommutedMI) {
1643     swapSourceModifiers(MI, Src0, AMDGPU::OpName::src0_modifiers,
1644                         Src1, AMDGPU::OpName::src1_modifiers);
1645 
1646     CommutedMI->setDesc(get(CommutedOpcode));
1647   }
1648 
1649   return CommutedMI;
1650 }
1651 
1652 // This needs to be implemented because the source modifiers may be inserted
1653 // between the true commutable operands, and the base
1654 // TargetInstrInfo::commuteInstruction uses it.
1655 bool SIInstrInfo::findCommutedOpIndices(MachineInstr &MI, unsigned &SrcOpIdx0,
1656                                         unsigned &SrcOpIdx1) const {
1657   return findCommutedOpIndices(MI.getDesc(), SrcOpIdx0, SrcOpIdx1);
1658 }
1659 
1660 bool SIInstrInfo::findCommutedOpIndices(MCInstrDesc Desc, unsigned &SrcOpIdx0,
1661                                         unsigned &SrcOpIdx1) const {
1662   if (!Desc.isCommutable())
1663     return false;
1664 
1665   unsigned Opc = Desc.getOpcode();
1666   int Src0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0);
1667   if (Src0Idx == -1)
1668     return false;
1669 
1670   int Src1Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1);
1671   if (Src1Idx == -1)
1672     return false;
1673 
1674   return fixCommutedOpIndices(SrcOpIdx0, SrcOpIdx1, Src0Idx, Src1Idx);
1675 }
1676 
1677 bool SIInstrInfo::isBranchOffsetInRange(unsigned BranchOp,
1678                                         int64_t BrOffset) const {
1679   // BranchRelaxation should never have to check s_setpc_b64 because its dest
1680   // block is unanalyzable.
1681   assert(BranchOp != AMDGPU::S_SETPC_B64);
1682 
1683   // Convert to dwords.
1684   BrOffset /= 4;
1685 
1686   // The branch instructions do PC += signext(SIMM16 * 4) + 4, so the offset is
1687   // from the next instruction.
1688   BrOffset -= 1;
1689 
1690   return isIntN(BranchOffsetBits, BrOffset);
1691 }
1692 
1693 MachineBasicBlock *SIInstrInfo::getBranchDestBlock(
1694   const MachineInstr &MI) const {
1695   if (MI.getOpcode() == AMDGPU::S_SETPC_B64) {
1696     // This would be a difficult analysis to perform, but can always be legal so
1697     // there's no need to analyze it.
1698     return nullptr;
1699   }
1700 
1701   return MI.getOperand(0).getMBB();
1702 }
1703 
1704 unsigned SIInstrInfo::insertIndirectBranch(MachineBasicBlock &MBB,
1705                                            MachineBasicBlock &DestBB,
1706                                            const DebugLoc &DL,
1707                                            int64_t BrOffset,
1708                                            RegScavenger *RS) const {
1709   assert(RS && "RegScavenger required for long branching");
1710   assert(MBB.empty() &&
1711          "new block should be inserted for expanding unconditional branch");
1712   assert(MBB.pred_size() == 1);
1713 
1714   MachineFunction *MF = MBB.getParent();
1715   MachineRegisterInfo &MRI = MF->getRegInfo();
1716 
1717   // FIXME: Virtual register workaround for RegScavenger not working with empty
1718   // blocks.
1719   unsigned PCReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
1720 
1721   auto I = MBB.end();
1722 
1723   // We need to compute the offset relative to the instruction immediately after
1724   // s_getpc_b64. Insert pc arithmetic code before last terminator.
1725   MachineInstr *GetPC = BuildMI(MBB, I, DL, get(AMDGPU::S_GETPC_B64), PCReg);
1726 
1727   // TODO: Handle > 32-bit block address.
1728   if (BrOffset >= 0) {
1729     BuildMI(MBB, I, DL, get(AMDGPU::S_ADD_U32))
1730       .addReg(PCReg, RegState::Define, AMDGPU::sub0)
1731       .addReg(PCReg, 0, AMDGPU::sub0)
1732       .addMBB(&DestBB, MO_LONG_BRANCH_FORWARD);
1733     BuildMI(MBB, I, DL, get(AMDGPU::S_ADDC_U32))
1734       .addReg(PCReg, RegState::Define, AMDGPU::sub1)
1735       .addReg(PCReg, 0, AMDGPU::sub1)
1736       .addImm(0);
1737   } else {
1738     // Backwards branch.
1739     BuildMI(MBB, I, DL, get(AMDGPU::S_SUB_U32))
1740       .addReg(PCReg, RegState::Define, AMDGPU::sub0)
1741       .addReg(PCReg, 0, AMDGPU::sub0)
1742       .addMBB(&DestBB, MO_LONG_BRANCH_BACKWARD);
1743     BuildMI(MBB, I, DL, get(AMDGPU::S_SUBB_U32))
1744       .addReg(PCReg, RegState::Define, AMDGPU::sub1)
1745       .addReg(PCReg, 0, AMDGPU::sub1)
1746       .addImm(0);
1747   }
1748 
1749   // Insert the indirect branch after the other terminator.
1750   BuildMI(&MBB, DL, get(AMDGPU::S_SETPC_B64))
1751     .addReg(PCReg);
1752 
1753   // FIXME: If spilling is necessary, this will fail because this scavenger has
1754   // no emergency stack slots. It is non-trivial to spill in this situation,
1755   // because the restore code needs to be specially placed after the
1756   // jump. BranchRelaxation then needs to be made aware of the newly inserted
1757   // block.
1758   //
1759   // If a spill is needed for the pc register pair, we need to insert a spill
1760   // restore block right before the destination block, and insert a short branch
1761   // into the old destination block's fallthrough predecessor.
1762   // e.g.:
1763   //
1764   // s_cbranch_scc0 skip_long_branch:
1765   //
1766   // long_branch_bb:
1767   //   spill s[8:9]
1768   //   s_getpc_b64 s[8:9]
1769   //   s_add_u32 s8, s8, restore_bb
1770   //   s_addc_u32 s9, s9, 0
1771   //   s_setpc_b64 s[8:9]
1772   //
1773   // skip_long_branch:
1774   //   foo;
1775   //
1776   // .....
1777   //
1778   // dest_bb_fallthrough_predecessor:
1779   // bar;
1780   // s_branch dest_bb
1781   //
1782   // restore_bb:
1783   //  restore s[8:9]
1784   //  fallthrough dest_bb
1785   ///
1786   // dest_bb:
1787   //   buzz;
1788 
1789   RS->enterBasicBlockEnd(MBB);
1790   unsigned Scav = RS->scavengeRegisterBackwards(
1791     AMDGPU::SReg_64RegClass,
1792     MachineBasicBlock::iterator(GetPC), false, 0);
1793   MRI.replaceRegWith(PCReg, Scav);
1794   MRI.clearVirtRegs();
1795   RS->setRegUsed(Scav);
1796 
1797   return 4 + 8 + 4 + 4;
1798 }
1799 
1800 unsigned SIInstrInfo::getBranchOpcode(SIInstrInfo::BranchPredicate Cond) {
1801   switch (Cond) {
1802   case SIInstrInfo::SCC_TRUE:
1803     return AMDGPU::S_CBRANCH_SCC1;
1804   case SIInstrInfo::SCC_FALSE:
1805     return AMDGPU::S_CBRANCH_SCC0;
1806   case SIInstrInfo::VCCNZ:
1807     return AMDGPU::S_CBRANCH_VCCNZ;
1808   case SIInstrInfo::VCCZ:
1809     return AMDGPU::S_CBRANCH_VCCZ;
1810   case SIInstrInfo::EXECNZ:
1811     return AMDGPU::S_CBRANCH_EXECNZ;
1812   case SIInstrInfo::EXECZ:
1813     return AMDGPU::S_CBRANCH_EXECZ;
1814   default:
1815     llvm_unreachable("invalid branch predicate");
1816   }
1817 }
1818 
1819 SIInstrInfo::BranchPredicate SIInstrInfo::getBranchPredicate(unsigned Opcode) {
1820   switch (Opcode) {
1821   case AMDGPU::S_CBRANCH_SCC0:
1822     return SCC_FALSE;
1823   case AMDGPU::S_CBRANCH_SCC1:
1824     return SCC_TRUE;
1825   case AMDGPU::S_CBRANCH_VCCNZ:
1826     return VCCNZ;
1827   case AMDGPU::S_CBRANCH_VCCZ:
1828     return VCCZ;
1829   case AMDGPU::S_CBRANCH_EXECNZ:
1830     return EXECNZ;
1831   case AMDGPU::S_CBRANCH_EXECZ:
1832     return EXECZ;
1833   default:
1834     return INVALID_BR;
1835   }
1836 }
1837 
1838 bool SIInstrInfo::analyzeBranchImpl(MachineBasicBlock &MBB,
1839                                     MachineBasicBlock::iterator I,
1840                                     MachineBasicBlock *&TBB,
1841                                     MachineBasicBlock *&FBB,
1842                                     SmallVectorImpl<MachineOperand> &Cond,
1843                                     bool AllowModify) const {
1844   if (I->getOpcode() == AMDGPU::S_BRANCH) {
1845     // Unconditional Branch
1846     TBB = I->getOperand(0).getMBB();
1847     return false;
1848   }
1849 
1850   MachineBasicBlock *CondBB = nullptr;
1851 
1852   if (I->getOpcode() == AMDGPU::SI_NON_UNIFORM_BRCOND_PSEUDO) {
1853     CondBB = I->getOperand(1).getMBB();
1854     Cond.push_back(I->getOperand(0));
1855   } else {
1856     BranchPredicate Pred = getBranchPredicate(I->getOpcode());
1857     if (Pred == INVALID_BR)
1858       return true;
1859 
1860     CondBB = I->getOperand(0).getMBB();
1861     Cond.push_back(MachineOperand::CreateImm(Pred));
1862     Cond.push_back(I->getOperand(1)); // Save the branch register.
1863   }
1864   ++I;
1865 
1866   if (I == MBB.end()) {
1867     // Conditional branch followed by fall-through.
1868     TBB = CondBB;
1869     return false;
1870   }
1871 
1872   if (I->getOpcode() == AMDGPU::S_BRANCH) {
1873     TBB = CondBB;
1874     FBB = I->getOperand(0).getMBB();
1875     return false;
1876   }
1877 
1878   return true;
1879 }
1880 
1881 bool SIInstrInfo::analyzeBranch(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
1882                                 MachineBasicBlock *&FBB,
1883                                 SmallVectorImpl<MachineOperand> &Cond,
1884                                 bool AllowModify) const {
1885   MachineBasicBlock::iterator I = MBB.getFirstTerminator();
1886   auto E = MBB.end();
1887   if (I == E)
1888     return false;
1889 
1890   // Skip over the instructions that are artificially terminators for special
1891   // exec management.
1892   while (I != E && !I->isBranch() && !I->isReturn() &&
1893          I->getOpcode() != AMDGPU::SI_MASK_BRANCH) {
1894     switch (I->getOpcode()) {
1895     case AMDGPU::SI_MASK_BRANCH:
1896     case AMDGPU::S_MOV_B64_term:
1897     case AMDGPU::S_XOR_B64_term:
1898     case AMDGPU::S_OR_B64_term:
1899     case AMDGPU::S_ANDN2_B64_term:
1900     case AMDGPU::S_MOV_B32_term:
1901     case AMDGPU::S_XOR_B32_term:
1902     case AMDGPU::S_OR_B32_term:
1903     case AMDGPU::S_ANDN2_B32_term:
1904       break;
1905     case AMDGPU::SI_IF:
1906     case AMDGPU::SI_ELSE:
1907     case AMDGPU::SI_KILL_I1_TERMINATOR:
1908     case AMDGPU::SI_KILL_F32_COND_IMM_TERMINATOR:
1909       // FIXME: It's messy that these need to be considered here at all.
1910       return true;
1911     default:
1912       llvm_unreachable("unexpected non-branch terminator inst");
1913     }
1914 
1915     ++I;
1916   }
1917 
1918   if (I == E)
1919     return false;
1920 
1921   if (I->getOpcode() != AMDGPU::SI_MASK_BRANCH)
1922     return analyzeBranchImpl(MBB, I, TBB, FBB, Cond, AllowModify);
1923 
1924   ++I;
1925 
1926   // TODO: Should be able to treat as fallthrough?
1927   if (I == MBB.end())
1928     return true;
1929 
1930   if (analyzeBranchImpl(MBB, I, TBB, FBB, Cond, AllowModify))
1931     return true;
1932 
1933   MachineBasicBlock *MaskBrDest = I->getOperand(0).getMBB();
1934 
1935   // Specifically handle the case where the conditional branch is to the same
1936   // destination as the mask branch. e.g.
1937   //
1938   // si_mask_branch BB8
1939   // s_cbranch_execz BB8
1940   // s_cbranch BB9
1941   //
1942   // This is required to understand divergent loops which may need the branches
1943   // to be relaxed.
1944   if (TBB != MaskBrDest || Cond.empty())
1945     return true;
1946 
1947   auto Pred = Cond[0].getImm();
1948   return (Pred != EXECZ && Pred != EXECNZ);
1949 }
1950 
1951 unsigned SIInstrInfo::removeBranch(MachineBasicBlock &MBB,
1952                                    int *BytesRemoved) const {
1953   MachineBasicBlock::iterator I = MBB.getFirstTerminator();
1954 
1955   unsigned Count = 0;
1956   unsigned RemovedSize = 0;
1957   while (I != MBB.end()) {
1958     MachineBasicBlock::iterator Next = std::next(I);
1959     if (I->getOpcode() == AMDGPU::SI_MASK_BRANCH) {
1960       I = Next;
1961       continue;
1962     }
1963 
1964     RemovedSize += getInstSizeInBytes(*I);
1965     I->eraseFromParent();
1966     ++Count;
1967     I = Next;
1968   }
1969 
1970   if (BytesRemoved)
1971     *BytesRemoved = RemovedSize;
1972 
1973   return Count;
1974 }
1975 
1976 // Copy the flags onto the implicit condition register operand.
1977 static void preserveCondRegFlags(MachineOperand &CondReg,
1978                                  const MachineOperand &OrigCond) {
1979   CondReg.setIsUndef(OrigCond.isUndef());
1980   CondReg.setIsKill(OrigCond.isKill());
1981 }
1982 
1983 unsigned SIInstrInfo::insertBranch(MachineBasicBlock &MBB,
1984                                    MachineBasicBlock *TBB,
1985                                    MachineBasicBlock *FBB,
1986                                    ArrayRef<MachineOperand> Cond,
1987                                    const DebugLoc &DL,
1988                                    int *BytesAdded) const {
1989   if (!FBB && Cond.empty()) {
1990     BuildMI(&MBB, DL, get(AMDGPU::S_BRANCH))
1991       .addMBB(TBB);
1992     if (BytesAdded)
1993       *BytesAdded = 4;
1994     return 1;
1995   }
1996 
1997   if(Cond.size() == 1 && Cond[0].isReg()) {
1998      BuildMI(&MBB, DL, get(AMDGPU::SI_NON_UNIFORM_BRCOND_PSEUDO))
1999        .add(Cond[0])
2000        .addMBB(TBB);
2001      return 1;
2002   }
2003 
2004   assert(TBB && Cond[0].isImm());
2005 
2006   unsigned Opcode
2007     = getBranchOpcode(static_cast<BranchPredicate>(Cond[0].getImm()));
2008 
2009   if (!FBB) {
2010     Cond[1].isUndef();
2011     MachineInstr *CondBr =
2012       BuildMI(&MBB, DL, get(Opcode))
2013       .addMBB(TBB);
2014 
2015     // Copy the flags onto the implicit condition register operand.
2016     preserveCondRegFlags(CondBr->getOperand(1), Cond[1]);
2017 
2018     if (BytesAdded)
2019       *BytesAdded = 4;
2020     return 1;
2021   }
2022 
2023   assert(TBB && FBB);
2024 
2025   MachineInstr *CondBr =
2026     BuildMI(&MBB, DL, get(Opcode))
2027     .addMBB(TBB);
2028   BuildMI(&MBB, DL, get(AMDGPU::S_BRANCH))
2029     .addMBB(FBB);
2030 
2031   MachineOperand &CondReg = CondBr->getOperand(1);
2032   CondReg.setIsUndef(Cond[1].isUndef());
2033   CondReg.setIsKill(Cond[1].isKill());
2034 
2035   if (BytesAdded)
2036       *BytesAdded = 8;
2037 
2038   return 2;
2039 }
2040 
2041 bool SIInstrInfo::reverseBranchCondition(
2042   SmallVectorImpl<MachineOperand> &Cond) const {
2043   if (Cond.size() != 2) {
2044     return true;
2045   }
2046 
2047   if (Cond[0].isImm()) {
2048     Cond[0].setImm(-Cond[0].getImm());
2049     return false;
2050   }
2051 
2052   return true;
2053 }
2054 
2055 bool SIInstrInfo::canInsertSelect(const MachineBasicBlock &MBB,
2056                                   ArrayRef<MachineOperand> Cond,
2057                                   unsigned TrueReg, unsigned FalseReg,
2058                                   int &CondCycles,
2059                                   int &TrueCycles, int &FalseCycles) const {
2060   switch (Cond[0].getImm()) {
2061   case VCCNZ:
2062   case VCCZ: {
2063     const MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
2064     const TargetRegisterClass *RC = MRI.getRegClass(TrueReg);
2065     assert(MRI.getRegClass(FalseReg) == RC);
2066 
2067     int NumInsts = AMDGPU::getRegBitWidth(RC->getID()) / 32;
2068     CondCycles = TrueCycles = FalseCycles = NumInsts; // ???
2069 
2070     // Limit to equal cost for branch vs. N v_cndmask_b32s.
2071     return RI.hasVGPRs(RC) && NumInsts <= 6;
2072   }
2073   case SCC_TRUE:
2074   case SCC_FALSE: {
2075     // FIXME: We could insert for VGPRs if we could replace the original compare
2076     // with a vector one.
2077     const MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
2078     const TargetRegisterClass *RC = MRI.getRegClass(TrueReg);
2079     assert(MRI.getRegClass(FalseReg) == RC);
2080 
2081     int NumInsts = AMDGPU::getRegBitWidth(RC->getID()) / 32;
2082 
2083     // Multiples of 8 can do s_cselect_b64
2084     if (NumInsts % 2 == 0)
2085       NumInsts /= 2;
2086 
2087     CondCycles = TrueCycles = FalseCycles = NumInsts; // ???
2088     return RI.isSGPRClass(RC);
2089   }
2090   default:
2091     return false;
2092   }
2093 }
2094 
2095 void SIInstrInfo::insertSelect(MachineBasicBlock &MBB,
2096                                MachineBasicBlock::iterator I, const DebugLoc &DL,
2097                                unsigned DstReg, ArrayRef<MachineOperand> Cond,
2098                                unsigned TrueReg, unsigned FalseReg) const {
2099   BranchPredicate Pred = static_cast<BranchPredicate>(Cond[0].getImm());
2100   if (Pred == VCCZ || Pred == SCC_FALSE) {
2101     Pred = static_cast<BranchPredicate>(-Pred);
2102     std::swap(TrueReg, FalseReg);
2103   }
2104 
2105   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
2106   const TargetRegisterClass *DstRC = MRI.getRegClass(DstReg);
2107   unsigned DstSize = RI.getRegSizeInBits(*DstRC);
2108 
2109   if (DstSize == 32) {
2110     unsigned SelOp = Pred == SCC_TRUE ?
2111       AMDGPU::S_CSELECT_B32 : AMDGPU::V_CNDMASK_B32_e32;
2112 
2113     // Instruction's operands are backwards from what is expected.
2114     MachineInstr *Select =
2115       BuildMI(MBB, I, DL, get(SelOp), DstReg)
2116       .addReg(FalseReg)
2117       .addReg(TrueReg);
2118 
2119     preserveCondRegFlags(Select->getOperand(3), Cond[1]);
2120     return;
2121   }
2122 
2123   if (DstSize == 64 && Pred == SCC_TRUE) {
2124     MachineInstr *Select =
2125       BuildMI(MBB, I, DL, get(AMDGPU::S_CSELECT_B64), DstReg)
2126       .addReg(FalseReg)
2127       .addReg(TrueReg);
2128 
2129     preserveCondRegFlags(Select->getOperand(3), Cond[1]);
2130     return;
2131   }
2132 
2133   static const int16_t Sub0_15[] = {
2134     AMDGPU::sub0, AMDGPU::sub1, AMDGPU::sub2, AMDGPU::sub3,
2135     AMDGPU::sub4, AMDGPU::sub5, AMDGPU::sub6, AMDGPU::sub7,
2136     AMDGPU::sub8, AMDGPU::sub9, AMDGPU::sub10, AMDGPU::sub11,
2137     AMDGPU::sub12, AMDGPU::sub13, AMDGPU::sub14, AMDGPU::sub15,
2138   };
2139 
2140   static const int16_t Sub0_15_64[] = {
2141     AMDGPU::sub0_sub1, AMDGPU::sub2_sub3,
2142     AMDGPU::sub4_sub5, AMDGPU::sub6_sub7,
2143     AMDGPU::sub8_sub9, AMDGPU::sub10_sub11,
2144     AMDGPU::sub12_sub13, AMDGPU::sub14_sub15,
2145   };
2146 
2147   unsigned SelOp = AMDGPU::V_CNDMASK_B32_e32;
2148   const TargetRegisterClass *EltRC = &AMDGPU::VGPR_32RegClass;
2149   const int16_t *SubIndices = Sub0_15;
2150   int NElts = DstSize / 32;
2151 
2152   // 64-bit select is only available for SALU.
2153   // TODO: Split 96-bit into 64-bit and 32-bit, not 3x 32-bit.
2154   if (Pred == SCC_TRUE) {
2155     if (NElts % 2) {
2156       SelOp = AMDGPU::S_CSELECT_B32;
2157       EltRC = &AMDGPU::SGPR_32RegClass;
2158     } else {
2159       SelOp = AMDGPU::S_CSELECT_B64;
2160       EltRC = &AMDGPU::SGPR_64RegClass;
2161       SubIndices = Sub0_15_64;
2162       NElts /= 2;
2163     }
2164   }
2165 
2166   MachineInstrBuilder MIB = BuildMI(
2167     MBB, I, DL, get(AMDGPU::REG_SEQUENCE), DstReg);
2168 
2169   I = MIB->getIterator();
2170 
2171   SmallVector<unsigned, 8> Regs;
2172   for (int Idx = 0; Idx != NElts; ++Idx) {
2173     unsigned DstElt = MRI.createVirtualRegister(EltRC);
2174     Regs.push_back(DstElt);
2175 
2176     unsigned SubIdx = SubIndices[Idx];
2177 
2178     MachineInstr *Select =
2179       BuildMI(MBB, I, DL, get(SelOp), DstElt)
2180       .addReg(FalseReg, 0, SubIdx)
2181       .addReg(TrueReg, 0, SubIdx);
2182     preserveCondRegFlags(Select->getOperand(3), Cond[1]);
2183     fixImplicitOperands(*Select);
2184 
2185     MIB.addReg(DstElt)
2186        .addImm(SubIdx);
2187   }
2188 }
2189 
2190 bool SIInstrInfo::isFoldableCopy(const MachineInstr &MI) const {
2191   switch (MI.getOpcode()) {
2192   case AMDGPU::V_MOV_B32_e32:
2193   case AMDGPU::V_MOV_B32_e64:
2194   case AMDGPU::V_MOV_B64_PSEUDO: {
2195     // If there are additional implicit register operands, this may be used for
2196     // register indexing so the source register operand isn't simply copied.
2197     unsigned NumOps = MI.getDesc().getNumOperands() +
2198       MI.getDesc().getNumImplicitUses();
2199 
2200     return MI.getNumOperands() == NumOps;
2201   }
2202   case AMDGPU::S_MOV_B32:
2203   case AMDGPU::S_MOV_B64:
2204   case AMDGPU::COPY:
2205   case AMDGPU::V_ACCVGPR_WRITE_B32:
2206   case AMDGPU::V_ACCVGPR_READ_B32:
2207     return true;
2208   default:
2209     return false;
2210   }
2211 }
2212 
2213 unsigned SIInstrInfo::getAddressSpaceForPseudoSourceKind(
2214     unsigned Kind) const {
2215   switch(Kind) {
2216   case PseudoSourceValue::Stack:
2217   case PseudoSourceValue::FixedStack:
2218     return AMDGPUAS::PRIVATE_ADDRESS;
2219   case PseudoSourceValue::ConstantPool:
2220   case PseudoSourceValue::GOT:
2221   case PseudoSourceValue::JumpTable:
2222   case PseudoSourceValue::GlobalValueCallEntry:
2223   case PseudoSourceValue::ExternalSymbolCallEntry:
2224   case PseudoSourceValue::TargetCustom:
2225     return AMDGPUAS::CONSTANT_ADDRESS;
2226   }
2227   return AMDGPUAS::FLAT_ADDRESS;
2228 }
2229 
2230 static void removeModOperands(MachineInstr &MI) {
2231   unsigned Opc = MI.getOpcode();
2232   int Src0ModIdx = AMDGPU::getNamedOperandIdx(Opc,
2233                                               AMDGPU::OpName::src0_modifiers);
2234   int Src1ModIdx = AMDGPU::getNamedOperandIdx(Opc,
2235                                               AMDGPU::OpName::src1_modifiers);
2236   int Src2ModIdx = AMDGPU::getNamedOperandIdx(Opc,
2237                                               AMDGPU::OpName::src2_modifiers);
2238 
2239   MI.RemoveOperand(Src2ModIdx);
2240   MI.RemoveOperand(Src1ModIdx);
2241   MI.RemoveOperand(Src0ModIdx);
2242 }
2243 
2244 bool SIInstrInfo::FoldImmediate(MachineInstr &UseMI, MachineInstr &DefMI,
2245                                 unsigned Reg, MachineRegisterInfo *MRI) const {
2246   if (!MRI->hasOneNonDBGUse(Reg))
2247     return false;
2248 
2249   switch (DefMI.getOpcode()) {
2250   default:
2251     return false;
2252   case AMDGPU::S_MOV_B64:
2253     // TODO: We could fold 64-bit immediates, but this get compilicated
2254     // when there are sub-registers.
2255     return false;
2256 
2257   case AMDGPU::V_MOV_B32_e32:
2258   case AMDGPU::S_MOV_B32:
2259   case AMDGPU::V_ACCVGPR_WRITE_B32:
2260     break;
2261   }
2262 
2263   const MachineOperand *ImmOp = getNamedOperand(DefMI, AMDGPU::OpName::src0);
2264   assert(ImmOp);
2265   // FIXME: We could handle FrameIndex values here.
2266   if (!ImmOp->isImm())
2267     return false;
2268 
2269   unsigned Opc = UseMI.getOpcode();
2270   if (Opc == AMDGPU::COPY) {
2271     bool isVGPRCopy = RI.isVGPR(*MRI, UseMI.getOperand(0).getReg());
2272     unsigned NewOpc = isVGPRCopy ? AMDGPU::V_MOV_B32_e32 : AMDGPU::S_MOV_B32;
2273     if (RI.isAGPR(*MRI, UseMI.getOperand(0).getReg())) {
2274       if (!isInlineConstant(*ImmOp, AMDGPU::OPERAND_REG_INLINE_AC_INT32))
2275         return false;
2276       NewOpc = AMDGPU::V_ACCVGPR_WRITE_B32;
2277     }
2278     UseMI.setDesc(get(NewOpc));
2279     UseMI.getOperand(1).ChangeToImmediate(ImmOp->getImm());
2280     UseMI.addImplicitDefUseOperands(*UseMI.getParent()->getParent());
2281     return true;
2282   }
2283 
2284   if (Opc == AMDGPU::V_MAD_F32 || Opc == AMDGPU::V_MAC_F32_e64 ||
2285       Opc == AMDGPU::V_MAD_F16 || Opc == AMDGPU::V_MAC_F16_e64 ||
2286       Opc == AMDGPU::V_FMA_F32 || Opc == AMDGPU::V_FMAC_F32_e64 ||
2287       Opc == AMDGPU::V_FMA_F16 || Opc == AMDGPU::V_FMAC_F16_e64) {
2288     // Don't fold if we are using source or output modifiers. The new VOP2
2289     // instructions don't have them.
2290     if (hasAnyModifiersSet(UseMI))
2291       return false;
2292 
2293     // If this is a free constant, there's no reason to do this.
2294     // TODO: We could fold this here instead of letting SIFoldOperands do it
2295     // later.
2296     MachineOperand *Src0 = getNamedOperand(UseMI, AMDGPU::OpName::src0);
2297 
2298     // Any src operand can be used for the legality check.
2299     if (isInlineConstant(UseMI, *Src0, *ImmOp))
2300       return false;
2301 
2302     bool IsF32 = Opc == AMDGPU::V_MAD_F32 || Opc == AMDGPU::V_MAC_F32_e64 ||
2303                  Opc == AMDGPU::V_FMA_F32 || Opc == AMDGPU::V_FMAC_F32_e64;
2304     bool IsFMA = Opc == AMDGPU::V_FMA_F32 || Opc == AMDGPU::V_FMAC_F32_e64 ||
2305                  Opc == AMDGPU::V_FMA_F16 || Opc == AMDGPU::V_FMAC_F16_e64;
2306     MachineOperand *Src1 = getNamedOperand(UseMI, AMDGPU::OpName::src1);
2307     MachineOperand *Src2 = getNamedOperand(UseMI, AMDGPU::OpName::src2);
2308 
2309     // Multiplied part is the constant: Use v_madmk_{f16, f32}.
2310     // We should only expect these to be on src0 due to canonicalizations.
2311     if (Src0->isReg() && Src0->getReg() == Reg) {
2312       if (!Src1->isReg() || RI.isSGPRClass(MRI->getRegClass(Src1->getReg())))
2313         return false;
2314 
2315       if (!Src2->isReg() || RI.isSGPRClass(MRI->getRegClass(Src2->getReg())))
2316         return false;
2317 
2318       unsigned NewOpc =
2319         IsFMA ? (IsF32 ? AMDGPU::V_FMAMK_F32 : AMDGPU::V_FMAMK_F16)
2320               : (IsF32 ? AMDGPU::V_MADMK_F32 : AMDGPU::V_MADMK_F16);
2321       if (pseudoToMCOpcode(NewOpc) == -1)
2322         return false;
2323 
2324       // We need to swap operands 0 and 1 since madmk constant is at operand 1.
2325 
2326       const int64_t Imm = ImmOp->getImm();
2327 
2328       // FIXME: This would be a lot easier if we could return a new instruction
2329       // instead of having to modify in place.
2330 
2331       // Remove these first since they are at the end.
2332       UseMI.RemoveOperand(
2333           AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::omod));
2334       UseMI.RemoveOperand(
2335           AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::clamp));
2336 
2337       unsigned Src1Reg = Src1->getReg();
2338       unsigned Src1SubReg = Src1->getSubReg();
2339       Src0->setReg(Src1Reg);
2340       Src0->setSubReg(Src1SubReg);
2341       Src0->setIsKill(Src1->isKill());
2342 
2343       if (Opc == AMDGPU::V_MAC_F32_e64 ||
2344           Opc == AMDGPU::V_MAC_F16_e64 ||
2345           Opc == AMDGPU::V_FMAC_F32_e64 ||
2346           Opc == AMDGPU::V_FMAC_F16_e64)
2347         UseMI.untieRegOperand(
2348             AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2));
2349 
2350       Src1->ChangeToImmediate(Imm);
2351 
2352       removeModOperands(UseMI);
2353       UseMI.setDesc(get(NewOpc));
2354 
2355       bool DeleteDef = MRI->hasOneNonDBGUse(Reg);
2356       if (DeleteDef)
2357         DefMI.eraseFromParent();
2358 
2359       return true;
2360     }
2361 
2362     // Added part is the constant: Use v_madak_{f16, f32}.
2363     if (Src2->isReg() && Src2->getReg() == Reg) {
2364       // Not allowed to use constant bus for another operand.
2365       // We can however allow an inline immediate as src0.
2366       bool Src0Inlined = false;
2367       if (Src0->isReg()) {
2368         // Try to inline constant if possible.
2369         // If the Def moves immediate and the use is single
2370         // We are saving VGPR here.
2371         MachineInstr *Def = MRI->getUniqueVRegDef(Src0->getReg());
2372         if (Def && Def->isMoveImmediate() &&
2373           isInlineConstant(Def->getOperand(1)) &&
2374           MRI->hasOneUse(Src0->getReg())) {
2375           Src0->ChangeToImmediate(Def->getOperand(1).getImm());
2376           Src0Inlined = true;
2377         } else if ((Register::isPhysicalRegister(Src0->getReg()) &&
2378                     (ST.getConstantBusLimit(Opc) <= 1 &&
2379                      RI.isSGPRClass(RI.getPhysRegClass(Src0->getReg())))) ||
2380                    (Register::isVirtualRegister(Src0->getReg()) &&
2381                     (ST.getConstantBusLimit(Opc) <= 1 &&
2382                      RI.isSGPRClass(MRI->getRegClass(Src0->getReg())))))
2383           return false;
2384           // VGPR is okay as Src0 - fallthrough
2385       }
2386 
2387       if (Src1->isReg() && !Src0Inlined ) {
2388         // We have one slot for inlinable constant so far - try to fill it
2389         MachineInstr *Def = MRI->getUniqueVRegDef(Src1->getReg());
2390         if (Def && Def->isMoveImmediate() &&
2391             isInlineConstant(Def->getOperand(1)) &&
2392             MRI->hasOneUse(Src1->getReg()) &&
2393             commuteInstruction(UseMI)) {
2394             Src0->ChangeToImmediate(Def->getOperand(1).getImm());
2395         } else if ((Register::isPhysicalRegister(Src1->getReg()) &&
2396                     RI.isSGPRClass(RI.getPhysRegClass(Src1->getReg()))) ||
2397                    (Register::isVirtualRegister(Src1->getReg()) &&
2398                     RI.isSGPRClass(MRI->getRegClass(Src1->getReg()))))
2399           return false;
2400           // VGPR is okay as Src1 - fallthrough
2401       }
2402 
2403       unsigned NewOpc =
2404         IsFMA ? (IsF32 ? AMDGPU::V_FMAAK_F32 : AMDGPU::V_FMAAK_F16)
2405               : (IsF32 ? AMDGPU::V_MADAK_F32 : AMDGPU::V_MADAK_F16);
2406       if (pseudoToMCOpcode(NewOpc) == -1)
2407         return false;
2408 
2409       const int64_t Imm = ImmOp->getImm();
2410 
2411       // FIXME: This would be a lot easier if we could return a new instruction
2412       // instead of having to modify in place.
2413 
2414       // Remove these first since they are at the end.
2415       UseMI.RemoveOperand(
2416           AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::omod));
2417       UseMI.RemoveOperand(
2418           AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::clamp));
2419 
2420       if (Opc == AMDGPU::V_MAC_F32_e64 ||
2421           Opc == AMDGPU::V_MAC_F16_e64 ||
2422           Opc == AMDGPU::V_FMAC_F32_e64 ||
2423           Opc == AMDGPU::V_FMAC_F16_e64)
2424         UseMI.untieRegOperand(
2425             AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2));
2426 
2427       // ChangingToImmediate adds Src2 back to the instruction.
2428       Src2->ChangeToImmediate(Imm);
2429 
2430       // These come before src2.
2431       removeModOperands(UseMI);
2432       UseMI.setDesc(get(NewOpc));
2433       // It might happen that UseMI was commuted
2434       // and we now have SGPR as SRC1. If so 2 inlined
2435       // constant and SGPR are illegal.
2436       legalizeOperands(UseMI);
2437 
2438       bool DeleteDef = MRI->hasOneNonDBGUse(Reg);
2439       if (DeleteDef)
2440         DefMI.eraseFromParent();
2441 
2442       return true;
2443     }
2444   }
2445 
2446   return false;
2447 }
2448 
2449 static bool offsetsDoNotOverlap(int WidthA, int OffsetA,
2450                                 int WidthB, int OffsetB) {
2451   int LowOffset = OffsetA < OffsetB ? OffsetA : OffsetB;
2452   int HighOffset = OffsetA < OffsetB ? OffsetB : OffsetA;
2453   int LowWidth = (LowOffset == OffsetA) ? WidthA : WidthB;
2454   return LowOffset + LowWidth <= HighOffset;
2455 }
2456 
2457 bool SIInstrInfo::checkInstOffsetsDoNotOverlap(const MachineInstr &MIa,
2458                                                const MachineInstr &MIb) const {
2459   const MachineOperand *BaseOp0, *BaseOp1;
2460   int64_t Offset0, Offset1;
2461 
2462   if (getMemOperandWithOffset(MIa, BaseOp0, Offset0, &RI) &&
2463       getMemOperandWithOffset(MIb, BaseOp1, Offset1, &RI)) {
2464     if (!BaseOp0->isIdenticalTo(*BaseOp1))
2465       return false;
2466 
2467     if (!MIa.hasOneMemOperand() || !MIb.hasOneMemOperand()) {
2468       // FIXME: Handle ds_read2 / ds_write2.
2469       return false;
2470     }
2471     unsigned Width0 = (*MIa.memoperands_begin())->getSize();
2472     unsigned Width1 = (*MIb.memoperands_begin())->getSize();
2473     if (offsetsDoNotOverlap(Width0, Offset0, Width1, Offset1)) {
2474       return true;
2475     }
2476   }
2477 
2478   return false;
2479 }
2480 
2481 bool SIInstrInfo::areMemAccessesTriviallyDisjoint(const MachineInstr &MIa,
2482                                                   const MachineInstr &MIb,
2483                                                   AliasAnalysis *AA) const {
2484   assert((MIa.mayLoad() || MIa.mayStore()) &&
2485          "MIa must load from or modify a memory location");
2486   assert((MIb.mayLoad() || MIb.mayStore()) &&
2487          "MIb must load from or modify a memory location");
2488 
2489   if (MIa.hasUnmodeledSideEffects() || MIb.hasUnmodeledSideEffects())
2490     return false;
2491 
2492   // XXX - Can we relax this between address spaces?
2493   if (MIa.hasOrderedMemoryRef() || MIb.hasOrderedMemoryRef())
2494     return false;
2495 
2496   // TODO: Should we check the address space from the MachineMemOperand? That
2497   // would allow us to distinguish objects we know don't alias based on the
2498   // underlying address space, even if it was lowered to a different one,
2499   // e.g. private accesses lowered to use MUBUF instructions on a scratch
2500   // buffer.
2501   if (isDS(MIa)) {
2502     if (isDS(MIb))
2503       return checkInstOffsetsDoNotOverlap(MIa, MIb);
2504 
2505     return !isFLAT(MIb) || isSegmentSpecificFLAT(MIb);
2506   }
2507 
2508   if (isMUBUF(MIa) || isMTBUF(MIa)) {
2509     if (isMUBUF(MIb) || isMTBUF(MIb))
2510       return checkInstOffsetsDoNotOverlap(MIa, MIb);
2511 
2512     return !isFLAT(MIb) && !isSMRD(MIb);
2513   }
2514 
2515   if (isSMRD(MIa)) {
2516     if (isSMRD(MIb))
2517       return checkInstOffsetsDoNotOverlap(MIa, MIb);
2518 
2519     return !isFLAT(MIb) && !isMUBUF(MIa) && !isMTBUF(MIa);
2520   }
2521 
2522   if (isFLAT(MIa)) {
2523     if (isFLAT(MIb))
2524       return checkInstOffsetsDoNotOverlap(MIa, MIb);
2525 
2526     return false;
2527   }
2528 
2529   return false;
2530 }
2531 
2532 static int64_t getFoldableImm(const MachineOperand* MO) {
2533   if (!MO->isReg())
2534     return false;
2535   const MachineFunction *MF = MO->getParent()->getParent()->getParent();
2536   const MachineRegisterInfo &MRI = MF->getRegInfo();
2537   auto Def = MRI.getUniqueVRegDef(MO->getReg());
2538   if (Def && Def->getOpcode() == AMDGPU::V_MOV_B32_e32 &&
2539       Def->getOperand(1).isImm())
2540     return Def->getOperand(1).getImm();
2541   return AMDGPU::NoRegister;
2542 }
2543 
2544 MachineInstr *SIInstrInfo::convertToThreeAddress(MachineFunction::iterator &MBB,
2545                                                  MachineInstr &MI,
2546                                                  LiveVariables *LV) const {
2547   unsigned Opc = MI.getOpcode();
2548   bool IsF16 = false;
2549   bool IsFMA = Opc == AMDGPU::V_FMAC_F32_e32 || Opc == AMDGPU::V_FMAC_F32_e64 ||
2550                Opc == AMDGPU::V_FMAC_F16_e32 || Opc == AMDGPU::V_FMAC_F16_e64;
2551 
2552   switch (Opc) {
2553   default:
2554     return nullptr;
2555   case AMDGPU::V_MAC_F16_e64:
2556   case AMDGPU::V_FMAC_F16_e64:
2557     IsF16 = true;
2558     LLVM_FALLTHROUGH;
2559   case AMDGPU::V_MAC_F32_e64:
2560   case AMDGPU::V_FMAC_F32_e64:
2561     break;
2562   case AMDGPU::V_MAC_F16_e32:
2563   case AMDGPU::V_FMAC_F16_e32:
2564     IsF16 = true;
2565     LLVM_FALLTHROUGH;
2566   case AMDGPU::V_MAC_F32_e32:
2567   case AMDGPU::V_FMAC_F32_e32: {
2568     int Src0Idx = AMDGPU::getNamedOperandIdx(MI.getOpcode(),
2569                                              AMDGPU::OpName::src0);
2570     const MachineOperand *Src0 = &MI.getOperand(Src0Idx);
2571     if (!Src0->isReg() && !Src0->isImm())
2572       return nullptr;
2573 
2574     if (Src0->isImm() && !isInlineConstant(MI, Src0Idx, *Src0))
2575       return nullptr;
2576 
2577     break;
2578   }
2579   }
2580 
2581   const MachineOperand *Dst = getNamedOperand(MI, AMDGPU::OpName::vdst);
2582   const MachineOperand *Src0 = getNamedOperand(MI, AMDGPU::OpName::src0);
2583   const MachineOperand *Src0Mods =
2584     getNamedOperand(MI, AMDGPU::OpName::src0_modifiers);
2585   const MachineOperand *Src1 = getNamedOperand(MI, AMDGPU::OpName::src1);
2586   const MachineOperand *Src1Mods =
2587     getNamedOperand(MI, AMDGPU::OpName::src1_modifiers);
2588   const MachineOperand *Src2 = getNamedOperand(MI, AMDGPU::OpName::src2);
2589   const MachineOperand *Clamp = getNamedOperand(MI, AMDGPU::OpName::clamp);
2590   const MachineOperand *Omod = getNamedOperand(MI, AMDGPU::OpName::omod);
2591 
2592   if (!Src0Mods && !Src1Mods && !Clamp && !Omod &&
2593       // If we have an SGPR input, we will violate the constant bus restriction.
2594       (ST.getConstantBusLimit(Opc) > 1 ||
2595        !Src0->isReg() ||
2596        !RI.isSGPRReg(MBB->getParent()->getRegInfo(), Src0->getReg()))) {
2597     if (auto Imm = getFoldableImm(Src2)) {
2598       unsigned NewOpc =
2599          IsFMA ? (IsF16 ? AMDGPU::V_FMAAK_F16 : AMDGPU::V_FMAAK_F32)
2600                : (IsF16 ? AMDGPU::V_MADAK_F16 : AMDGPU::V_MADAK_F32);
2601       if (pseudoToMCOpcode(NewOpc) != -1)
2602         return BuildMI(*MBB, MI, MI.getDebugLoc(), get(NewOpc))
2603                  .add(*Dst)
2604                  .add(*Src0)
2605                  .add(*Src1)
2606                  .addImm(Imm);
2607     }
2608     unsigned NewOpc =
2609       IsFMA ? (IsF16 ? AMDGPU::V_FMAMK_F16 : AMDGPU::V_FMAMK_F32)
2610             : (IsF16 ? AMDGPU::V_MADMK_F16 : AMDGPU::V_MADMK_F32);
2611     if (auto Imm = getFoldableImm(Src1)) {
2612       if (pseudoToMCOpcode(NewOpc) != -1)
2613         return BuildMI(*MBB, MI, MI.getDebugLoc(), get(NewOpc))
2614                  .add(*Dst)
2615                  .add(*Src0)
2616                  .addImm(Imm)
2617                  .add(*Src2);
2618     }
2619     if (auto Imm = getFoldableImm(Src0)) {
2620       if (pseudoToMCOpcode(NewOpc) != -1 &&
2621           isOperandLegal(MI, AMDGPU::getNamedOperandIdx(NewOpc,
2622                            AMDGPU::OpName::src0), Src1))
2623         return BuildMI(*MBB, MI, MI.getDebugLoc(), get(NewOpc))
2624                  .add(*Dst)
2625                  .add(*Src1)
2626                  .addImm(Imm)
2627                  .add(*Src2);
2628     }
2629   }
2630 
2631   unsigned NewOpc = IsFMA ? (IsF16 ? AMDGPU::V_FMA_F16 : AMDGPU::V_FMA_F32)
2632                           : (IsF16 ? AMDGPU::V_MAD_F16 : AMDGPU::V_MAD_F32);
2633   if (pseudoToMCOpcode(NewOpc) == -1)
2634     return nullptr;
2635 
2636   return BuildMI(*MBB, MI, MI.getDebugLoc(), get(NewOpc))
2637       .add(*Dst)
2638       .addImm(Src0Mods ? Src0Mods->getImm() : 0)
2639       .add(*Src0)
2640       .addImm(Src1Mods ? Src1Mods->getImm() : 0)
2641       .add(*Src1)
2642       .addImm(0) // Src mods
2643       .add(*Src2)
2644       .addImm(Clamp ? Clamp->getImm() : 0)
2645       .addImm(Omod ? Omod->getImm() : 0);
2646 }
2647 
2648 // It's not generally safe to move VALU instructions across these since it will
2649 // start using the register as a base index rather than directly.
2650 // XXX - Why isn't hasSideEffects sufficient for these?
2651 static bool changesVGPRIndexingMode(const MachineInstr &MI) {
2652   switch (MI.getOpcode()) {
2653   case AMDGPU::S_SET_GPR_IDX_ON:
2654   case AMDGPU::S_SET_GPR_IDX_MODE:
2655   case AMDGPU::S_SET_GPR_IDX_OFF:
2656     return true;
2657   default:
2658     return false;
2659   }
2660 }
2661 
2662 bool SIInstrInfo::isSchedulingBoundary(const MachineInstr &MI,
2663                                        const MachineBasicBlock *MBB,
2664                                        const MachineFunction &MF) const {
2665   // XXX - Do we want the SP check in the base implementation?
2666 
2667   // Target-independent instructions do not have an implicit-use of EXEC, even
2668   // when they operate on VGPRs. Treating EXEC modifications as scheduling
2669   // boundaries prevents incorrect movements of such instructions.
2670   return TargetInstrInfo::isSchedulingBoundary(MI, MBB, MF) ||
2671          MI.modifiesRegister(AMDGPU::EXEC, &RI) ||
2672          MI.getOpcode() == AMDGPU::S_SETREG_IMM32_B32 ||
2673          MI.getOpcode() == AMDGPU::S_SETREG_B32 ||
2674          changesVGPRIndexingMode(MI);
2675 }
2676 
2677 bool SIInstrInfo::isAlwaysGDS(uint16_t Opcode) const {
2678   return Opcode == AMDGPU::DS_ORDERED_COUNT ||
2679          Opcode == AMDGPU::DS_GWS_INIT ||
2680          Opcode == AMDGPU::DS_GWS_SEMA_V ||
2681          Opcode == AMDGPU::DS_GWS_SEMA_BR ||
2682          Opcode == AMDGPU::DS_GWS_SEMA_P ||
2683          Opcode == AMDGPU::DS_GWS_SEMA_RELEASE_ALL ||
2684          Opcode == AMDGPU::DS_GWS_BARRIER;
2685 }
2686 
2687 bool SIInstrInfo::hasUnwantedEffectsWhenEXECEmpty(const MachineInstr &MI) const {
2688   unsigned Opcode = MI.getOpcode();
2689 
2690   if (MI.mayStore() && isSMRD(MI))
2691     return true; // scalar store or atomic
2692 
2693   // This will terminate the function when other lanes may need to continue.
2694   if (MI.isReturn())
2695     return true;
2696 
2697   // These instructions cause shader I/O that may cause hardware lockups
2698   // when executed with an empty EXEC mask.
2699   //
2700   // Note: exp with VM = DONE = 0 is automatically skipped by hardware when
2701   //       EXEC = 0, but checking for that case here seems not worth it
2702   //       given the typical code patterns.
2703   if (Opcode == AMDGPU::S_SENDMSG || Opcode == AMDGPU::S_SENDMSGHALT ||
2704       Opcode == AMDGPU::EXP || Opcode == AMDGPU::EXP_DONE ||
2705       Opcode == AMDGPU::DS_ORDERED_COUNT || Opcode == AMDGPU::S_TRAP ||
2706       Opcode == AMDGPU::DS_GWS_INIT || Opcode == AMDGPU::DS_GWS_BARRIER)
2707     return true;
2708 
2709   if (MI.isCall() || MI.isInlineAsm())
2710     return true; // conservative assumption
2711 
2712   // These are like SALU instructions in terms of effects, so it's questionable
2713   // whether we should return true for those.
2714   //
2715   // However, executing them with EXEC = 0 causes them to operate on undefined
2716   // data, which we avoid by returning true here.
2717   if (Opcode == AMDGPU::V_READFIRSTLANE_B32 || Opcode == AMDGPU::V_READLANE_B32)
2718     return true;
2719 
2720   return false;
2721 }
2722 
2723 bool SIInstrInfo::mayReadEXEC(const MachineRegisterInfo &MRI,
2724                               const MachineInstr &MI) const {
2725   if (MI.isMetaInstruction())
2726     return false;
2727 
2728   // This won't read exec if this is an SGPR->SGPR copy.
2729   if (MI.isCopyLike()) {
2730     if (!RI.isSGPRReg(MRI, MI.getOperand(0).getReg()))
2731       return true;
2732 
2733     // Make sure this isn't copying exec as a normal operand
2734     return MI.readsRegister(AMDGPU::EXEC, &RI);
2735   }
2736 
2737   // Make a conservative assumption about the callee.
2738   if (MI.isCall())
2739     return true;
2740 
2741   // Be conservative with any unhandled generic opcodes.
2742   if (!isTargetSpecificOpcode(MI.getOpcode()))
2743     return true;
2744 
2745   return !isSALU(MI) || MI.readsRegister(AMDGPU::EXEC, &RI);
2746 }
2747 
2748 bool SIInstrInfo::isInlineConstant(const APInt &Imm) const {
2749   switch (Imm.getBitWidth()) {
2750   case 1: // This likely will be a condition code mask.
2751     return true;
2752 
2753   case 32:
2754     return AMDGPU::isInlinableLiteral32(Imm.getSExtValue(),
2755                                         ST.hasInv2PiInlineImm());
2756   case 64:
2757     return AMDGPU::isInlinableLiteral64(Imm.getSExtValue(),
2758                                         ST.hasInv2PiInlineImm());
2759   case 16:
2760     return ST.has16BitInsts() &&
2761            AMDGPU::isInlinableLiteral16(Imm.getSExtValue(),
2762                                         ST.hasInv2PiInlineImm());
2763   default:
2764     llvm_unreachable("invalid bitwidth");
2765   }
2766 }
2767 
2768 bool SIInstrInfo::isInlineConstant(const MachineOperand &MO,
2769                                    uint8_t OperandType) const {
2770   if (!MO.isImm() ||
2771       OperandType < AMDGPU::OPERAND_SRC_FIRST ||
2772       OperandType > AMDGPU::OPERAND_SRC_LAST)
2773     return false;
2774 
2775   // MachineOperand provides no way to tell the true operand size, since it only
2776   // records a 64-bit value. We need to know the size to determine if a 32-bit
2777   // floating point immediate bit pattern is legal for an integer immediate. It
2778   // would be for any 32-bit integer operand, but would not be for a 64-bit one.
2779 
2780   int64_t Imm = MO.getImm();
2781   switch (OperandType) {
2782   case AMDGPU::OPERAND_REG_IMM_INT32:
2783   case AMDGPU::OPERAND_REG_IMM_FP32:
2784   case AMDGPU::OPERAND_REG_INLINE_C_INT32:
2785   case AMDGPU::OPERAND_REG_INLINE_C_FP32:
2786   case AMDGPU::OPERAND_REG_INLINE_AC_INT32:
2787   case AMDGPU::OPERAND_REG_INLINE_AC_FP32: {
2788     int32_t Trunc = static_cast<int32_t>(Imm);
2789     return AMDGPU::isInlinableLiteral32(Trunc, ST.hasInv2PiInlineImm());
2790   }
2791   case AMDGPU::OPERAND_REG_IMM_INT64:
2792   case AMDGPU::OPERAND_REG_IMM_FP64:
2793   case AMDGPU::OPERAND_REG_INLINE_C_INT64:
2794   case AMDGPU::OPERAND_REG_INLINE_C_FP64:
2795     return AMDGPU::isInlinableLiteral64(MO.getImm(),
2796                                         ST.hasInv2PiInlineImm());
2797   case AMDGPU::OPERAND_REG_IMM_INT16:
2798   case AMDGPU::OPERAND_REG_IMM_FP16:
2799   case AMDGPU::OPERAND_REG_INLINE_C_INT16:
2800   case AMDGPU::OPERAND_REG_INLINE_C_FP16:
2801   case AMDGPU::OPERAND_REG_INLINE_AC_INT16:
2802   case AMDGPU::OPERAND_REG_INLINE_AC_FP16: {
2803     if (isInt<16>(Imm) || isUInt<16>(Imm)) {
2804       // A few special case instructions have 16-bit operands on subtargets
2805       // where 16-bit instructions are not legal.
2806       // TODO: Do the 32-bit immediates work? We shouldn't really need to handle
2807       // constants in these cases
2808       int16_t Trunc = static_cast<int16_t>(Imm);
2809       return ST.has16BitInsts() &&
2810              AMDGPU::isInlinableLiteral16(Trunc, ST.hasInv2PiInlineImm());
2811     }
2812 
2813     return false;
2814   }
2815   case AMDGPU::OPERAND_REG_IMM_V2INT16:
2816   case AMDGPU::OPERAND_REG_IMM_V2FP16:
2817   case AMDGPU::OPERAND_REG_INLINE_C_V2INT16:
2818   case AMDGPU::OPERAND_REG_INLINE_C_V2FP16:
2819   case AMDGPU::OPERAND_REG_INLINE_AC_V2INT16:
2820   case AMDGPU::OPERAND_REG_INLINE_AC_V2FP16: {
2821     uint32_t Trunc = static_cast<uint32_t>(Imm);
2822     return AMDGPU::isInlinableLiteralV216(Trunc, ST.hasInv2PiInlineImm());
2823   }
2824   default:
2825     llvm_unreachable("invalid bitwidth");
2826   }
2827 }
2828 
2829 bool SIInstrInfo::isLiteralConstantLike(const MachineOperand &MO,
2830                                         const MCOperandInfo &OpInfo) const {
2831   switch (MO.getType()) {
2832   case MachineOperand::MO_Register:
2833     return false;
2834   case MachineOperand::MO_Immediate:
2835     return !isInlineConstant(MO, OpInfo);
2836   case MachineOperand::MO_FrameIndex:
2837   case MachineOperand::MO_MachineBasicBlock:
2838   case MachineOperand::MO_ExternalSymbol:
2839   case MachineOperand::MO_GlobalAddress:
2840   case MachineOperand::MO_MCSymbol:
2841     return true;
2842   default:
2843     llvm_unreachable("unexpected operand type");
2844   }
2845 }
2846 
2847 static bool compareMachineOp(const MachineOperand &Op0,
2848                              const MachineOperand &Op1) {
2849   if (Op0.getType() != Op1.getType())
2850     return false;
2851 
2852   switch (Op0.getType()) {
2853   case MachineOperand::MO_Register:
2854     return Op0.getReg() == Op1.getReg();
2855   case MachineOperand::MO_Immediate:
2856     return Op0.getImm() == Op1.getImm();
2857   default:
2858     llvm_unreachable("Didn't expect to be comparing these operand types");
2859   }
2860 }
2861 
2862 bool SIInstrInfo::isImmOperandLegal(const MachineInstr &MI, unsigned OpNo,
2863                                     const MachineOperand &MO) const {
2864   const MCInstrDesc &InstDesc = MI.getDesc();
2865   const MCOperandInfo &OpInfo = InstDesc.OpInfo[OpNo];
2866 
2867   assert(MO.isImm() || MO.isTargetIndex() || MO.isFI() || MO.isGlobal());
2868 
2869   if (OpInfo.OperandType == MCOI::OPERAND_IMMEDIATE)
2870     return true;
2871 
2872   if (OpInfo.RegClass < 0)
2873     return false;
2874 
2875   if (MO.isImm() && isInlineConstant(MO, OpInfo))
2876     return RI.opCanUseInlineConstant(OpInfo.OperandType);
2877 
2878   if (!RI.opCanUseLiteralConstant(OpInfo.OperandType))
2879     return false;
2880 
2881   if (!isVOP3(MI) || !AMDGPU::isSISrcOperand(InstDesc, OpNo))
2882     return true;
2883 
2884   const MachineFunction *MF = MI.getParent()->getParent();
2885   const GCNSubtarget &ST = MF->getSubtarget<GCNSubtarget>();
2886   return ST.hasVOP3Literal();
2887 }
2888 
2889 bool SIInstrInfo::hasVALU32BitEncoding(unsigned Opcode) const {
2890   int Op32 = AMDGPU::getVOPe32(Opcode);
2891   if (Op32 == -1)
2892     return false;
2893 
2894   return pseudoToMCOpcode(Op32) != -1;
2895 }
2896 
2897 bool SIInstrInfo::hasModifiers(unsigned Opcode) const {
2898   // The src0_modifier operand is present on all instructions
2899   // that have modifiers.
2900 
2901   return AMDGPU::getNamedOperandIdx(Opcode,
2902                                     AMDGPU::OpName::src0_modifiers) != -1;
2903 }
2904 
2905 bool SIInstrInfo::hasModifiersSet(const MachineInstr &MI,
2906                                   unsigned OpName) const {
2907   const MachineOperand *Mods = getNamedOperand(MI, OpName);
2908   return Mods && Mods->getImm();
2909 }
2910 
2911 bool SIInstrInfo::hasAnyModifiersSet(const MachineInstr &MI) const {
2912   return hasModifiersSet(MI, AMDGPU::OpName::src0_modifiers) ||
2913          hasModifiersSet(MI, AMDGPU::OpName::src1_modifiers) ||
2914          hasModifiersSet(MI, AMDGPU::OpName::src2_modifiers) ||
2915          hasModifiersSet(MI, AMDGPU::OpName::clamp) ||
2916          hasModifiersSet(MI, AMDGPU::OpName::omod);
2917 }
2918 
2919 bool SIInstrInfo::canShrink(const MachineInstr &MI,
2920                             const MachineRegisterInfo &MRI) const {
2921   const MachineOperand *Src2 = getNamedOperand(MI, AMDGPU::OpName::src2);
2922   // Can't shrink instruction with three operands.
2923   // FIXME: v_cndmask_b32 has 3 operands and is shrinkable, but we need to add
2924   // a special case for it.  It can only be shrunk if the third operand
2925   // is vcc, and src0_modifiers and src1_modifiers are not set.
2926   // We should handle this the same way we handle vopc, by addding
2927   // a register allocation hint pre-regalloc and then do the shrinking
2928   // post-regalloc.
2929   if (Src2) {
2930     switch (MI.getOpcode()) {
2931       default: return false;
2932 
2933       case AMDGPU::V_ADDC_U32_e64:
2934       case AMDGPU::V_SUBB_U32_e64:
2935       case AMDGPU::V_SUBBREV_U32_e64: {
2936         const MachineOperand *Src1
2937           = getNamedOperand(MI, AMDGPU::OpName::src1);
2938         if (!Src1->isReg() || !RI.isVGPR(MRI, Src1->getReg()))
2939           return false;
2940         // Additional verification is needed for sdst/src2.
2941         return true;
2942       }
2943       case AMDGPU::V_MAC_F32_e64:
2944       case AMDGPU::V_MAC_F16_e64:
2945       case AMDGPU::V_FMAC_F32_e64:
2946       case AMDGPU::V_FMAC_F16_e64:
2947         if (!Src2->isReg() || !RI.isVGPR(MRI, Src2->getReg()) ||
2948             hasModifiersSet(MI, AMDGPU::OpName::src2_modifiers))
2949           return false;
2950         break;
2951 
2952       case AMDGPU::V_CNDMASK_B32_e64:
2953         break;
2954     }
2955   }
2956 
2957   const MachineOperand *Src1 = getNamedOperand(MI, AMDGPU::OpName::src1);
2958   if (Src1 && (!Src1->isReg() || !RI.isVGPR(MRI, Src1->getReg()) ||
2959                hasModifiersSet(MI, AMDGPU::OpName::src1_modifiers)))
2960     return false;
2961 
2962   // We don't need to check src0, all input types are legal, so just make sure
2963   // src0 isn't using any modifiers.
2964   if (hasModifiersSet(MI, AMDGPU::OpName::src0_modifiers))
2965     return false;
2966 
2967   // Can it be shrunk to a valid 32 bit opcode?
2968   if (!hasVALU32BitEncoding(MI.getOpcode()))
2969     return false;
2970 
2971   // Check output modifiers
2972   return !hasModifiersSet(MI, AMDGPU::OpName::omod) &&
2973          !hasModifiersSet(MI, AMDGPU::OpName::clamp);
2974 }
2975 
2976 // Set VCC operand with all flags from \p Orig, except for setting it as
2977 // implicit.
2978 static void copyFlagsToImplicitVCC(MachineInstr &MI,
2979                                    const MachineOperand &Orig) {
2980 
2981   for (MachineOperand &Use : MI.implicit_operands()) {
2982     if (Use.isUse() && Use.getReg() == AMDGPU::VCC) {
2983       Use.setIsUndef(Orig.isUndef());
2984       Use.setIsKill(Orig.isKill());
2985       return;
2986     }
2987   }
2988 }
2989 
2990 MachineInstr *SIInstrInfo::buildShrunkInst(MachineInstr &MI,
2991                                            unsigned Op32) const {
2992   MachineBasicBlock *MBB = MI.getParent();;
2993   MachineInstrBuilder Inst32 =
2994     BuildMI(*MBB, MI, MI.getDebugLoc(), get(Op32));
2995 
2996   // Add the dst operand if the 32-bit encoding also has an explicit $vdst.
2997   // For VOPC instructions, this is replaced by an implicit def of vcc.
2998   int Op32DstIdx = AMDGPU::getNamedOperandIdx(Op32, AMDGPU::OpName::vdst);
2999   if (Op32DstIdx != -1) {
3000     // dst
3001     Inst32.add(MI.getOperand(0));
3002   } else {
3003     assert(((MI.getOperand(0).getReg() == AMDGPU::VCC) ||
3004             (MI.getOperand(0).getReg() == AMDGPU::VCC_LO)) &&
3005            "Unexpected case");
3006   }
3007 
3008   Inst32.add(*getNamedOperand(MI, AMDGPU::OpName::src0));
3009 
3010   const MachineOperand *Src1 = getNamedOperand(MI, AMDGPU::OpName::src1);
3011   if (Src1)
3012     Inst32.add(*Src1);
3013 
3014   const MachineOperand *Src2 = getNamedOperand(MI, AMDGPU::OpName::src2);
3015 
3016   if (Src2) {
3017     int Op32Src2Idx = AMDGPU::getNamedOperandIdx(Op32, AMDGPU::OpName::src2);
3018     if (Op32Src2Idx != -1) {
3019       Inst32.add(*Src2);
3020     } else {
3021       // In the case of V_CNDMASK_B32_e32, the explicit operand src2 is
3022       // replaced with an implicit read of vcc. This was already added
3023       // during the initial BuildMI, so find it to preserve the flags.
3024       copyFlagsToImplicitVCC(*Inst32, *Src2);
3025     }
3026   }
3027 
3028   return Inst32;
3029 }
3030 
3031 bool SIInstrInfo::usesConstantBus(const MachineRegisterInfo &MRI,
3032                                   const MachineOperand &MO,
3033                                   const MCOperandInfo &OpInfo) const {
3034   // Literal constants use the constant bus.
3035   //if (isLiteralConstantLike(MO, OpInfo))
3036   // return true;
3037   if (MO.isImm())
3038     return !isInlineConstant(MO, OpInfo);
3039 
3040   if (!MO.isReg())
3041     return true; // Misc other operands like FrameIndex
3042 
3043   if (!MO.isUse())
3044     return false;
3045 
3046   if (Register::isVirtualRegister(MO.getReg()))
3047     return RI.isSGPRClass(MRI.getRegClass(MO.getReg()));
3048 
3049   // Null is free
3050   if (MO.getReg() == AMDGPU::SGPR_NULL)
3051     return false;
3052 
3053   // SGPRs use the constant bus
3054   if (MO.isImplicit()) {
3055     return MO.getReg() == AMDGPU::M0 ||
3056            MO.getReg() == AMDGPU::VCC ||
3057            MO.getReg() == AMDGPU::VCC_LO;
3058   } else {
3059     return AMDGPU::SReg_32RegClass.contains(MO.getReg()) ||
3060            AMDGPU::SReg_64RegClass.contains(MO.getReg());
3061   }
3062 }
3063 
3064 static unsigned findImplicitSGPRRead(const MachineInstr &MI) {
3065   for (const MachineOperand &MO : MI.implicit_operands()) {
3066     // We only care about reads.
3067     if (MO.isDef())
3068       continue;
3069 
3070     switch (MO.getReg()) {
3071     case AMDGPU::VCC:
3072     case AMDGPU::VCC_LO:
3073     case AMDGPU::VCC_HI:
3074     case AMDGPU::M0:
3075     case AMDGPU::FLAT_SCR:
3076       return MO.getReg();
3077 
3078     default:
3079       break;
3080     }
3081   }
3082 
3083   return AMDGPU::NoRegister;
3084 }
3085 
3086 static bool shouldReadExec(const MachineInstr &MI) {
3087   if (SIInstrInfo::isVALU(MI)) {
3088     switch (MI.getOpcode()) {
3089     case AMDGPU::V_READLANE_B32:
3090     case AMDGPU::V_READLANE_B32_gfx6_gfx7:
3091     case AMDGPU::V_READLANE_B32_gfx10:
3092     case AMDGPU::V_READLANE_B32_vi:
3093     case AMDGPU::V_WRITELANE_B32:
3094     case AMDGPU::V_WRITELANE_B32_gfx6_gfx7:
3095     case AMDGPU::V_WRITELANE_B32_gfx10:
3096     case AMDGPU::V_WRITELANE_B32_vi:
3097       return false;
3098     }
3099 
3100     return true;
3101   }
3102 
3103   if (SIInstrInfo::isGenericOpcode(MI.getOpcode()) ||
3104       SIInstrInfo::isSALU(MI) ||
3105       SIInstrInfo::isSMRD(MI))
3106     return false;
3107 
3108   return true;
3109 }
3110 
3111 static bool isSubRegOf(const SIRegisterInfo &TRI,
3112                        const MachineOperand &SuperVec,
3113                        const MachineOperand &SubReg) {
3114   if (Register::isPhysicalRegister(SubReg.getReg()))
3115     return TRI.isSubRegister(SuperVec.getReg(), SubReg.getReg());
3116 
3117   return SubReg.getSubReg() != AMDGPU::NoSubRegister &&
3118          SubReg.getReg() == SuperVec.getReg();
3119 }
3120 
3121 bool SIInstrInfo::verifyInstruction(const MachineInstr &MI,
3122                                     StringRef &ErrInfo) const {
3123   uint16_t Opcode = MI.getOpcode();
3124   if (SIInstrInfo::isGenericOpcode(MI.getOpcode()))
3125     return true;
3126 
3127   const MachineFunction *MF = MI.getParent()->getParent();
3128   const MachineRegisterInfo &MRI = MF->getRegInfo();
3129 
3130   int Src0Idx = AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::src0);
3131   int Src1Idx = AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::src1);
3132   int Src2Idx = AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::src2);
3133 
3134   // Make sure the number of operands is correct.
3135   const MCInstrDesc &Desc = get(Opcode);
3136   if (!Desc.isVariadic() &&
3137       Desc.getNumOperands() != MI.getNumExplicitOperands()) {
3138     ErrInfo = "Instruction has wrong number of operands.";
3139     return false;
3140   }
3141 
3142   if (MI.isInlineAsm()) {
3143     // Verify register classes for inlineasm constraints.
3144     for (unsigned I = InlineAsm::MIOp_FirstOperand, E = MI.getNumOperands();
3145          I != E; ++I) {
3146       const TargetRegisterClass *RC = MI.getRegClassConstraint(I, this, &RI);
3147       if (!RC)
3148         continue;
3149 
3150       const MachineOperand &Op = MI.getOperand(I);
3151       if (!Op.isReg())
3152         continue;
3153 
3154       unsigned Reg = Op.getReg();
3155       if (!Register::isVirtualRegister(Reg) && !RC->contains(Reg)) {
3156         ErrInfo = "inlineasm operand has incorrect register class.";
3157         return false;
3158       }
3159     }
3160 
3161     return true;
3162   }
3163 
3164   // Make sure the register classes are correct.
3165   for (int i = 0, e = Desc.getNumOperands(); i != e; ++i) {
3166     if (MI.getOperand(i).isFPImm()) {
3167       ErrInfo = "FPImm Machine Operands are not supported. ISel should bitcast "
3168                 "all fp values to integers.";
3169       return false;
3170     }
3171 
3172     int RegClass = Desc.OpInfo[i].RegClass;
3173 
3174     switch (Desc.OpInfo[i].OperandType) {
3175     case MCOI::OPERAND_REGISTER:
3176       if (MI.getOperand(i).isImm() || MI.getOperand(i).isGlobal()) {
3177         ErrInfo = "Illegal immediate value for operand.";
3178         return false;
3179       }
3180       break;
3181     case AMDGPU::OPERAND_REG_IMM_INT32:
3182     case AMDGPU::OPERAND_REG_IMM_FP32:
3183       break;
3184     case AMDGPU::OPERAND_REG_INLINE_C_INT32:
3185     case AMDGPU::OPERAND_REG_INLINE_C_FP32:
3186     case AMDGPU::OPERAND_REG_INLINE_C_INT64:
3187     case AMDGPU::OPERAND_REG_INLINE_C_FP64:
3188     case AMDGPU::OPERAND_REG_INLINE_C_INT16:
3189     case AMDGPU::OPERAND_REG_INLINE_C_FP16:
3190     case AMDGPU::OPERAND_REG_INLINE_AC_INT32:
3191     case AMDGPU::OPERAND_REG_INLINE_AC_FP32:
3192     case AMDGPU::OPERAND_REG_INLINE_AC_INT16:
3193     case AMDGPU::OPERAND_REG_INLINE_AC_FP16: {
3194       const MachineOperand &MO = MI.getOperand(i);
3195       if (!MO.isReg() && (!MO.isImm() || !isInlineConstant(MI, i))) {
3196         ErrInfo = "Illegal immediate value for operand.";
3197         return false;
3198       }
3199       break;
3200     }
3201     case MCOI::OPERAND_IMMEDIATE:
3202     case AMDGPU::OPERAND_KIMM32:
3203       // Check if this operand is an immediate.
3204       // FrameIndex operands will be replaced by immediates, so they are
3205       // allowed.
3206       if (!MI.getOperand(i).isImm() && !MI.getOperand(i).isFI()) {
3207         ErrInfo = "Expected immediate, but got non-immediate";
3208         return false;
3209       }
3210       LLVM_FALLTHROUGH;
3211     default:
3212       continue;
3213     }
3214 
3215     if (!MI.getOperand(i).isReg())
3216       continue;
3217 
3218     if (RegClass != -1) {
3219       unsigned Reg = MI.getOperand(i).getReg();
3220       if (Reg == AMDGPU::NoRegister || Register::isVirtualRegister(Reg))
3221         continue;
3222 
3223       const TargetRegisterClass *RC = RI.getRegClass(RegClass);
3224       if (!RC->contains(Reg)) {
3225         ErrInfo = "Operand has incorrect register class.";
3226         return false;
3227       }
3228     }
3229   }
3230 
3231   // Verify SDWA
3232   if (isSDWA(MI)) {
3233     if (!ST.hasSDWA()) {
3234       ErrInfo = "SDWA is not supported on this target";
3235       return false;
3236     }
3237 
3238     int DstIdx = AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::vdst);
3239 
3240     const int OpIndicies[] = { DstIdx, Src0Idx, Src1Idx, Src2Idx };
3241 
3242     for (int OpIdx: OpIndicies) {
3243       if (OpIdx == -1)
3244         continue;
3245       const MachineOperand &MO = MI.getOperand(OpIdx);
3246 
3247       if (!ST.hasSDWAScalar()) {
3248         // Only VGPRS on VI
3249         if (!MO.isReg() || !RI.hasVGPRs(RI.getRegClassForReg(MRI, MO.getReg()))) {
3250           ErrInfo = "Only VGPRs allowed as operands in SDWA instructions on VI";
3251           return false;
3252         }
3253       } else {
3254         // No immediates on GFX9
3255         if (!MO.isReg()) {
3256           ErrInfo = "Only reg allowed as operands in SDWA instructions on GFX9";
3257           return false;
3258         }
3259       }
3260     }
3261 
3262     if (!ST.hasSDWAOmod()) {
3263       // No omod allowed on VI
3264       const MachineOperand *OMod = getNamedOperand(MI, AMDGPU::OpName::omod);
3265       if (OMod != nullptr &&
3266         (!OMod->isImm() || OMod->getImm() != 0)) {
3267         ErrInfo = "OMod not allowed in SDWA instructions on VI";
3268         return false;
3269       }
3270     }
3271 
3272     uint16_t BasicOpcode = AMDGPU::getBasicFromSDWAOp(Opcode);
3273     if (isVOPC(BasicOpcode)) {
3274       if (!ST.hasSDWASdst() && DstIdx != -1) {
3275         // Only vcc allowed as dst on VI for VOPC
3276         const MachineOperand &Dst = MI.getOperand(DstIdx);
3277         if (!Dst.isReg() || Dst.getReg() != AMDGPU::VCC) {
3278           ErrInfo = "Only VCC allowed as dst in SDWA instructions on VI";
3279           return false;
3280         }
3281       } else if (!ST.hasSDWAOutModsVOPC()) {
3282         // No clamp allowed on GFX9 for VOPC
3283         const MachineOperand *Clamp = getNamedOperand(MI, AMDGPU::OpName::clamp);
3284         if (Clamp && (!Clamp->isImm() || Clamp->getImm() != 0)) {
3285           ErrInfo = "Clamp not allowed in VOPC SDWA instructions on VI";
3286           return false;
3287         }
3288 
3289         // No omod allowed on GFX9 for VOPC
3290         const MachineOperand *OMod = getNamedOperand(MI, AMDGPU::OpName::omod);
3291         if (OMod && (!OMod->isImm() || OMod->getImm() != 0)) {
3292           ErrInfo = "OMod not allowed in VOPC SDWA instructions on VI";
3293           return false;
3294         }
3295       }
3296     }
3297 
3298     const MachineOperand *DstUnused = getNamedOperand(MI, AMDGPU::OpName::dst_unused);
3299     if (DstUnused && DstUnused->isImm() &&
3300         DstUnused->getImm() == AMDGPU::SDWA::UNUSED_PRESERVE) {
3301       const MachineOperand &Dst = MI.getOperand(DstIdx);
3302       if (!Dst.isReg() || !Dst.isTied()) {
3303         ErrInfo = "Dst register should have tied register";
3304         return false;
3305       }
3306 
3307       const MachineOperand &TiedMO =
3308           MI.getOperand(MI.findTiedOperandIdx(DstIdx));
3309       if (!TiedMO.isReg() || !TiedMO.isImplicit() || !TiedMO.isUse()) {
3310         ErrInfo =
3311             "Dst register should be tied to implicit use of preserved register";
3312         return false;
3313       } else if (Register::isPhysicalRegister(TiedMO.getReg()) &&
3314                  Dst.getReg() != TiedMO.getReg()) {
3315         ErrInfo = "Dst register should use same physical register as preserved";
3316         return false;
3317       }
3318     }
3319   }
3320 
3321   // Verify MIMG
3322   if (isMIMG(MI.getOpcode()) && !MI.mayStore()) {
3323     // Ensure that the return type used is large enough for all the options
3324     // being used TFE/LWE require an extra result register.
3325     const MachineOperand *DMask = getNamedOperand(MI, AMDGPU::OpName::dmask);
3326     if (DMask) {
3327       uint64_t DMaskImm = DMask->getImm();
3328       uint32_t RegCount =
3329           isGather4(MI.getOpcode()) ? 4 : countPopulation(DMaskImm);
3330       const MachineOperand *TFE = getNamedOperand(MI, AMDGPU::OpName::tfe);
3331       const MachineOperand *LWE = getNamedOperand(MI, AMDGPU::OpName::lwe);
3332       const MachineOperand *D16 = getNamedOperand(MI, AMDGPU::OpName::d16);
3333 
3334       // Adjust for packed 16 bit values
3335       if (D16 && D16->getImm() && !ST.hasUnpackedD16VMem())
3336         RegCount >>= 1;
3337 
3338       // Adjust if using LWE or TFE
3339       if ((LWE && LWE->getImm()) || (TFE && TFE->getImm()))
3340         RegCount += 1;
3341 
3342       const uint32_t DstIdx =
3343           AMDGPU::getNamedOperandIdx(MI.getOpcode(), AMDGPU::OpName::vdata);
3344       const MachineOperand &Dst = MI.getOperand(DstIdx);
3345       if (Dst.isReg()) {
3346         const TargetRegisterClass *DstRC = getOpRegClass(MI, DstIdx);
3347         uint32_t DstSize = RI.getRegSizeInBits(*DstRC) / 32;
3348         if (RegCount > DstSize) {
3349           ErrInfo = "MIMG instruction returns too many registers for dst "
3350                     "register class";
3351           return false;
3352         }
3353       }
3354     }
3355   }
3356 
3357   // Verify VOP*. Ignore multiple sgpr operands on writelane.
3358   if (Desc.getOpcode() != AMDGPU::V_WRITELANE_B32
3359       && (isVOP1(MI) || isVOP2(MI) || isVOP3(MI) || isVOPC(MI) || isSDWA(MI))) {
3360     // Only look at the true operands. Only a real operand can use the constant
3361     // bus, and we don't want to check pseudo-operands like the source modifier
3362     // flags.
3363     const int OpIndices[] = { Src0Idx, Src1Idx, Src2Idx };
3364 
3365     unsigned ConstantBusCount = 0;
3366     unsigned LiteralCount = 0;
3367 
3368     if (AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::imm) != -1)
3369       ++ConstantBusCount;
3370 
3371     SmallVector<unsigned, 2> SGPRsUsed;
3372     unsigned SGPRUsed = findImplicitSGPRRead(MI);
3373     if (SGPRUsed != AMDGPU::NoRegister) {
3374       ++ConstantBusCount;
3375       SGPRsUsed.push_back(SGPRUsed);
3376     }
3377 
3378     for (int OpIdx : OpIndices) {
3379       if (OpIdx == -1)
3380         break;
3381       const MachineOperand &MO = MI.getOperand(OpIdx);
3382       if (usesConstantBus(MRI, MO, MI.getDesc().OpInfo[OpIdx])) {
3383         if (MO.isReg()) {
3384           SGPRUsed = MO.getReg();
3385           if (llvm::all_of(SGPRsUsed, [this, SGPRUsed](unsigned SGPR) {
3386                 return !RI.regsOverlap(SGPRUsed, SGPR);
3387               })) {
3388             ++ConstantBusCount;
3389             SGPRsUsed.push_back(SGPRUsed);
3390           }
3391         } else {
3392           ++ConstantBusCount;
3393           ++LiteralCount;
3394         }
3395       }
3396     }
3397     const GCNSubtarget &ST = MF->getSubtarget<GCNSubtarget>();
3398     // v_writelane_b32 is an exception from constant bus restriction:
3399     // vsrc0 can be sgpr, const or m0 and lane select sgpr, m0 or inline-const
3400     if (ConstantBusCount > ST.getConstantBusLimit(Opcode) &&
3401         Opcode != AMDGPU::V_WRITELANE_B32) {
3402       ErrInfo = "VOP* instruction violates constant bus restriction";
3403       return false;
3404     }
3405 
3406     if (isVOP3(MI) && LiteralCount) {
3407       if (LiteralCount && !ST.hasVOP3Literal()) {
3408         ErrInfo = "VOP3 instruction uses literal";
3409         return false;
3410       }
3411       if (LiteralCount > 1) {
3412         ErrInfo = "VOP3 instruction uses more than one literal";
3413         return false;
3414       }
3415     }
3416   }
3417 
3418   // Verify misc. restrictions on specific instructions.
3419   if (Desc.getOpcode() == AMDGPU::V_DIV_SCALE_F32 ||
3420       Desc.getOpcode() == AMDGPU::V_DIV_SCALE_F64) {
3421     const MachineOperand &Src0 = MI.getOperand(Src0Idx);
3422     const MachineOperand &Src1 = MI.getOperand(Src1Idx);
3423     const MachineOperand &Src2 = MI.getOperand(Src2Idx);
3424     if (Src0.isReg() && Src1.isReg() && Src2.isReg()) {
3425       if (!compareMachineOp(Src0, Src1) &&
3426           !compareMachineOp(Src0, Src2)) {
3427         ErrInfo = "v_div_scale_{f32|f64} require src0 = src1 or src2";
3428         return false;
3429       }
3430     }
3431   }
3432 
3433   if (isSOP2(MI) || isSOPC(MI)) {
3434     const MachineOperand &Src0 = MI.getOperand(Src0Idx);
3435     const MachineOperand &Src1 = MI.getOperand(Src1Idx);
3436     unsigned Immediates = 0;
3437 
3438     if (!Src0.isReg() &&
3439         !isInlineConstant(Src0, Desc.OpInfo[Src0Idx].OperandType))
3440       Immediates++;
3441     if (!Src1.isReg() &&
3442         !isInlineConstant(Src1, Desc.OpInfo[Src1Idx].OperandType))
3443       Immediates++;
3444 
3445     if (Immediates > 1) {
3446       ErrInfo = "SOP2/SOPC instruction requires too many immediate constants";
3447       return false;
3448     }
3449   }
3450 
3451   if (isSOPK(MI)) {
3452     auto Op = getNamedOperand(MI, AMDGPU::OpName::simm16);
3453     if (Desc.isBranch()) {
3454       if (!Op->isMBB()) {
3455         ErrInfo = "invalid branch target for SOPK instruction";
3456         return false;
3457       }
3458     } else {
3459       uint64_t Imm = Op->getImm();
3460       if (sopkIsZext(MI)) {
3461         if (!isUInt<16>(Imm)) {
3462           ErrInfo = "invalid immediate for SOPK instruction";
3463           return false;
3464         }
3465       } else {
3466         if (!isInt<16>(Imm)) {
3467           ErrInfo = "invalid immediate for SOPK instruction";
3468           return false;
3469         }
3470       }
3471     }
3472   }
3473 
3474   if (Desc.getOpcode() == AMDGPU::V_MOVRELS_B32_e32 ||
3475       Desc.getOpcode() == AMDGPU::V_MOVRELS_B32_e64 ||
3476       Desc.getOpcode() == AMDGPU::V_MOVRELD_B32_e32 ||
3477       Desc.getOpcode() == AMDGPU::V_MOVRELD_B32_e64) {
3478     const bool IsDst = Desc.getOpcode() == AMDGPU::V_MOVRELD_B32_e32 ||
3479                        Desc.getOpcode() == AMDGPU::V_MOVRELD_B32_e64;
3480 
3481     const unsigned StaticNumOps = Desc.getNumOperands() +
3482       Desc.getNumImplicitUses();
3483     const unsigned NumImplicitOps = IsDst ? 2 : 1;
3484 
3485     // Allow additional implicit operands. This allows a fixup done by the post
3486     // RA scheduler where the main implicit operand is killed and implicit-defs
3487     // are added for sub-registers that remain live after this instruction.
3488     if (MI.getNumOperands() < StaticNumOps + NumImplicitOps) {
3489       ErrInfo = "missing implicit register operands";
3490       return false;
3491     }
3492 
3493     const MachineOperand *Dst = getNamedOperand(MI, AMDGPU::OpName::vdst);
3494     if (IsDst) {
3495       if (!Dst->isUse()) {
3496         ErrInfo = "v_movreld_b32 vdst should be a use operand";
3497         return false;
3498       }
3499 
3500       unsigned UseOpIdx;
3501       if (!MI.isRegTiedToUseOperand(StaticNumOps, &UseOpIdx) ||
3502           UseOpIdx != StaticNumOps + 1) {
3503         ErrInfo = "movrel implicit operands should be tied";
3504         return false;
3505       }
3506     }
3507 
3508     const MachineOperand &Src0 = MI.getOperand(Src0Idx);
3509     const MachineOperand &ImpUse
3510       = MI.getOperand(StaticNumOps + NumImplicitOps - 1);
3511     if (!ImpUse.isReg() || !ImpUse.isUse() ||
3512         !isSubRegOf(RI, ImpUse, IsDst ? *Dst : Src0)) {
3513       ErrInfo = "src0 should be subreg of implicit vector use";
3514       return false;
3515     }
3516   }
3517 
3518   // Make sure we aren't losing exec uses in the td files. This mostly requires
3519   // being careful when using let Uses to try to add other use registers.
3520   if (shouldReadExec(MI)) {
3521     if (!MI.hasRegisterImplicitUseOperand(AMDGPU::EXEC)) {
3522       ErrInfo = "VALU instruction does not implicitly read exec mask";
3523       return false;
3524     }
3525   }
3526 
3527   if (isSMRD(MI)) {
3528     if (MI.mayStore()) {
3529       // The register offset form of scalar stores may only use m0 as the
3530       // soffset register.
3531       const MachineOperand *Soff = getNamedOperand(MI, AMDGPU::OpName::soff);
3532       if (Soff && Soff->getReg() != AMDGPU::M0) {
3533         ErrInfo = "scalar stores must use m0 as offset register";
3534         return false;
3535       }
3536     }
3537   }
3538 
3539   if (isFLAT(MI) && !MF->getSubtarget<GCNSubtarget>().hasFlatInstOffsets()) {
3540     const MachineOperand *Offset = getNamedOperand(MI, AMDGPU::OpName::offset);
3541     if (Offset->getImm() != 0) {
3542       ErrInfo = "subtarget does not support offsets in flat instructions";
3543       return false;
3544     }
3545   }
3546 
3547   if (isMIMG(MI)) {
3548     const MachineOperand *DimOp = getNamedOperand(MI, AMDGPU::OpName::dim);
3549     if (DimOp) {
3550       int VAddr0Idx = AMDGPU::getNamedOperandIdx(Opcode,
3551                                                  AMDGPU::OpName::vaddr0);
3552       int SRsrcIdx = AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::srsrc);
3553       const AMDGPU::MIMGInfo *Info = AMDGPU::getMIMGInfo(Opcode);
3554       const AMDGPU::MIMGBaseOpcodeInfo *BaseOpcode =
3555           AMDGPU::getMIMGBaseOpcodeInfo(Info->BaseOpcode);
3556       const AMDGPU::MIMGDimInfo *Dim =
3557           AMDGPU::getMIMGDimInfoByEncoding(DimOp->getImm());
3558 
3559       if (!Dim) {
3560         ErrInfo = "dim is out of range";
3561         return false;
3562       }
3563 
3564       bool IsNSA = SRsrcIdx - VAddr0Idx > 1;
3565       unsigned AddrWords = BaseOpcode->NumExtraArgs +
3566                            (BaseOpcode->Gradients ? Dim->NumGradients : 0) +
3567                            (BaseOpcode->Coordinates ? Dim->NumCoords : 0) +
3568                            (BaseOpcode->LodOrClampOrMip ? 1 : 0);
3569 
3570       unsigned VAddrWords;
3571       if (IsNSA) {
3572         VAddrWords = SRsrcIdx - VAddr0Idx;
3573       } else {
3574         const TargetRegisterClass *RC = getOpRegClass(MI, VAddr0Idx);
3575         VAddrWords = MRI.getTargetRegisterInfo()->getRegSizeInBits(*RC) / 32;
3576         if (AddrWords > 8)
3577           AddrWords = 16;
3578         else if (AddrWords > 4)
3579           AddrWords = 8;
3580         else if (AddrWords == 3 && VAddrWords == 4) {
3581           // CodeGen uses the V4 variant of instructions for three addresses,
3582           // because the selection DAG does not support non-power-of-two types.
3583           AddrWords = 4;
3584         }
3585       }
3586 
3587       if (VAddrWords != AddrWords) {
3588         ErrInfo = "bad vaddr size";
3589         return false;
3590       }
3591     }
3592   }
3593 
3594   const MachineOperand *DppCt = getNamedOperand(MI, AMDGPU::OpName::dpp_ctrl);
3595   if (DppCt) {
3596     using namespace AMDGPU::DPP;
3597 
3598     unsigned DC = DppCt->getImm();
3599     if (DC == DppCtrl::DPP_UNUSED1 || DC == DppCtrl::DPP_UNUSED2 ||
3600         DC == DppCtrl::DPP_UNUSED3 || DC > DppCtrl::DPP_LAST ||
3601         (DC >= DppCtrl::DPP_UNUSED4_FIRST && DC <= DppCtrl::DPP_UNUSED4_LAST) ||
3602         (DC >= DppCtrl::DPP_UNUSED5_FIRST && DC <= DppCtrl::DPP_UNUSED5_LAST) ||
3603         (DC >= DppCtrl::DPP_UNUSED6_FIRST && DC <= DppCtrl::DPP_UNUSED6_LAST) ||
3604         (DC >= DppCtrl::DPP_UNUSED7_FIRST && DC <= DppCtrl::DPP_UNUSED7_LAST) ||
3605         (DC >= DppCtrl::DPP_UNUSED8_FIRST && DC <= DppCtrl::DPP_UNUSED8_LAST)) {
3606       ErrInfo = "Invalid dpp_ctrl value";
3607       return false;
3608     }
3609     if (DC >= DppCtrl::WAVE_SHL1 && DC <= DppCtrl::WAVE_ROR1 &&
3610         ST.getGeneration() >= AMDGPUSubtarget::GFX10) {
3611       ErrInfo = "Invalid dpp_ctrl value: "
3612                 "wavefront shifts are not supported on GFX10+";
3613       return false;
3614     }
3615     if (DC >= DppCtrl::BCAST15 && DC <= DppCtrl::BCAST31 &&
3616         ST.getGeneration() >= AMDGPUSubtarget::GFX10) {
3617       ErrInfo = "Invalid dpp_ctrl value: "
3618                 "broadcasts are not supported on GFX10+";
3619       return false;
3620     }
3621     if (DC >= DppCtrl::ROW_SHARE_FIRST && DC <= DppCtrl::ROW_XMASK_LAST &&
3622         ST.getGeneration() < AMDGPUSubtarget::GFX10) {
3623       ErrInfo = "Invalid dpp_ctrl value: "
3624                 "row_share and row_xmask are not supported before GFX10";
3625       return false;
3626     }
3627   }
3628 
3629   return true;
3630 }
3631 
3632 unsigned SIInstrInfo::getVALUOp(const MachineInstr &MI) const {
3633   switch (MI.getOpcode()) {
3634   default: return AMDGPU::INSTRUCTION_LIST_END;
3635   case AMDGPU::REG_SEQUENCE: return AMDGPU::REG_SEQUENCE;
3636   case AMDGPU::COPY: return AMDGPU::COPY;
3637   case AMDGPU::PHI: return AMDGPU::PHI;
3638   case AMDGPU::INSERT_SUBREG: return AMDGPU::INSERT_SUBREG;
3639   case AMDGPU::WQM: return AMDGPU::WQM;
3640   case AMDGPU::SOFT_WQM: return AMDGPU::SOFT_WQM;
3641   case AMDGPU::WWM: return AMDGPU::WWM;
3642   case AMDGPU::S_MOV_B32: {
3643     const MachineRegisterInfo &MRI = MI.getParent()->getParent()->getRegInfo();
3644     return MI.getOperand(1).isReg() ||
3645            RI.isAGPR(MRI, MI.getOperand(0).getReg()) ?
3646            AMDGPU::COPY : AMDGPU::V_MOV_B32_e32;
3647   }
3648   case AMDGPU::S_ADD_I32:
3649     return ST.hasAddNoCarry() ? AMDGPU::V_ADD_U32_e64 : AMDGPU::V_ADD_I32_e32;
3650   case AMDGPU::S_ADDC_U32:
3651     return AMDGPU::V_ADDC_U32_e32;
3652   case AMDGPU::S_SUB_I32:
3653     return ST.hasAddNoCarry() ? AMDGPU::V_SUB_U32_e64 : AMDGPU::V_SUB_I32_e32;
3654     // FIXME: These are not consistently handled, and selected when the carry is
3655     // used.
3656   case AMDGPU::S_ADD_U32:
3657     return AMDGPU::V_ADD_I32_e32;
3658   case AMDGPU::S_SUB_U32:
3659     return AMDGPU::V_SUB_I32_e32;
3660   case AMDGPU::S_SUBB_U32: return AMDGPU::V_SUBB_U32_e32;
3661   case AMDGPU::S_MUL_I32: return AMDGPU::V_MUL_LO_U32;
3662   case AMDGPU::S_MUL_HI_U32: return AMDGPU::V_MUL_HI_U32;
3663   case AMDGPU::S_MUL_HI_I32: return AMDGPU::V_MUL_HI_I32;
3664   case AMDGPU::S_AND_B32: return AMDGPU::V_AND_B32_e64;
3665   case AMDGPU::S_OR_B32: return AMDGPU::V_OR_B32_e64;
3666   case AMDGPU::S_XOR_B32: return AMDGPU::V_XOR_B32_e64;
3667   case AMDGPU::S_XNOR_B32:
3668     return ST.hasDLInsts() ? AMDGPU::V_XNOR_B32_e64 : AMDGPU::INSTRUCTION_LIST_END;
3669   case AMDGPU::S_MIN_I32: return AMDGPU::V_MIN_I32_e64;
3670   case AMDGPU::S_MIN_U32: return AMDGPU::V_MIN_U32_e64;
3671   case AMDGPU::S_MAX_I32: return AMDGPU::V_MAX_I32_e64;
3672   case AMDGPU::S_MAX_U32: return AMDGPU::V_MAX_U32_e64;
3673   case AMDGPU::S_ASHR_I32: return AMDGPU::V_ASHR_I32_e32;
3674   case AMDGPU::S_ASHR_I64: return AMDGPU::V_ASHR_I64;
3675   case AMDGPU::S_LSHL_B32: return AMDGPU::V_LSHL_B32_e32;
3676   case AMDGPU::S_LSHL_B64: return AMDGPU::V_LSHL_B64;
3677   case AMDGPU::S_LSHR_B32: return AMDGPU::V_LSHR_B32_e32;
3678   case AMDGPU::S_LSHR_B64: return AMDGPU::V_LSHR_B64;
3679   case AMDGPU::S_SEXT_I32_I8: return AMDGPU::V_BFE_I32;
3680   case AMDGPU::S_SEXT_I32_I16: return AMDGPU::V_BFE_I32;
3681   case AMDGPU::S_BFE_U32: return AMDGPU::V_BFE_U32;
3682   case AMDGPU::S_BFE_I32: return AMDGPU::V_BFE_I32;
3683   case AMDGPU::S_BFM_B32: return AMDGPU::V_BFM_B32_e64;
3684   case AMDGPU::S_BREV_B32: return AMDGPU::V_BFREV_B32_e32;
3685   case AMDGPU::S_NOT_B32: return AMDGPU::V_NOT_B32_e32;
3686   case AMDGPU::S_NOT_B64: return AMDGPU::V_NOT_B32_e32;
3687   case AMDGPU::S_CMP_EQ_I32: return AMDGPU::V_CMP_EQ_I32_e32;
3688   case AMDGPU::S_CMP_LG_I32: return AMDGPU::V_CMP_NE_I32_e32;
3689   case AMDGPU::S_CMP_GT_I32: return AMDGPU::V_CMP_GT_I32_e32;
3690   case AMDGPU::S_CMP_GE_I32: return AMDGPU::V_CMP_GE_I32_e32;
3691   case AMDGPU::S_CMP_LT_I32: return AMDGPU::V_CMP_LT_I32_e32;
3692   case AMDGPU::S_CMP_LE_I32: return AMDGPU::V_CMP_LE_I32_e32;
3693   case AMDGPU::S_CMP_EQ_U32: return AMDGPU::V_CMP_EQ_U32_e32;
3694   case AMDGPU::S_CMP_LG_U32: return AMDGPU::V_CMP_NE_U32_e32;
3695   case AMDGPU::S_CMP_GT_U32: return AMDGPU::V_CMP_GT_U32_e32;
3696   case AMDGPU::S_CMP_GE_U32: return AMDGPU::V_CMP_GE_U32_e32;
3697   case AMDGPU::S_CMP_LT_U32: return AMDGPU::V_CMP_LT_U32_e32;
3698   case AMDGPU::S_CMP_LE_U32: return AMDGPU::V_CMP_LE_U32_e32;
3699   case AMDGPU::S_CMP_EQ_U64: return AMDGPU::V_CMP_EQ_U64_e32;
3700   case AMDGPU::S_CMP_LG_U64: return AMDGPU::V_CMP_NE_U64_e32;
3701   case AMDGPU::S_BCNT1_I32_B32: return AMDGPU::V_BCNT_U32_B32_e64;
3702   case AMDGPU::S_FF1_I32_B32: return AMDGPU::V_FFBL_B32_e32;
3703   case AMDGPU::S_FLBIT_I32_B32: return AMDGPU::V_FFBH_U32_e32;
3704   case AMDGPU::S_FLBIT_I32: return AMDGPU::V_FFBH_I32_e64;
3705   case AMDGPU::S_CBRANCH_SCC0: return AMDGPU::S_CBRANCH_VCCZ;
3706   case AMDGPU::S_CBRANCH_SCC1: return AMDGPU::S_CBRANCH_VCCNZ;
3707   }
3708   llvm_unreachable(
3709       "Unexpected scalar opcode without corresponding vector one!");
3710 }
3711 
3712 const TargetRegisterClass *SIInstrInfo::getOpRegClass(const MachineInstr &MI,
3713                                                       unsigned OpNo) const {
3714   const MachineRegisterInfo &MRI = MI.getParent()->getParent()->getRegInfo();
3715   const MCInstrDesc &Desc = get(MI.getOpcode());
3716   if (MI.isVariadic() || OpNo >= Desc.getNumOperands() ||
3717       Desc.OpInfo[OpNo].RegClass == -1) {
3718     unsigned Reg = MI.getOperand(OpNo).getReg();
3719 
3720     if (Register::isVirtualRegister(Reg))
3721       return MRI.getRegClass(Reg);
3722     return RI.getPhysRegClass(Reg);
3723   }
3724 
3725   unsigned RCID = Desc.OpInfo[OpNo].RegClass;
3726   return RI.getRegClass(RCID);
3727 }
3728 
3729 void SIInstrInfo::legalizeOpWithMove(MachineInstr &MI, unsigned OpIdx) const {
3730   MachineBasicBlock::iterator I = MI;
3731   MachineBasicBlock *MBB = MI.getParent();
3732   MachineOperand &MO = MI.getOperand(OpIdx);
3733   MachineRegisterInfo &MRI = MBB->getParent()->getRegInfo();
3734   const SIRegisterInfo *TRI =
3735       static_cast<const SIRegisterInfo*>(MRI.getTargetRegisterInfo());
3736   unsigned RCID = get(MI.getOpcode()).OpInfo[OpIdx].RegClass;
3737   const TargetRegisterClass *RC = RI.getRegClass(RCID);
3738   unsigned Size = TRI->getRegSizeInBits(*RC);
3739   unsigned Opcode = (Size == 64) ? AMDGPU::V_MOV_B64_PSEUDO : AMDGPU::V_MOV_B32_e32;
3740   if (MO.isReg())
3741     Opcode = AMDGPU::COPY;
3742   else if (RI.isSGPRClass(RC))
3743     Opcode = (Size == 64) ? AMDGPU::S_MOV_B64 : AMDGPU::S_MOV_B32;
3744 
3745   const TargetRegisterClass *VRC = RI.getEquivalentVGPRClass(RC);
3746   if (RI.getCommonSubClass(&AMDGPU::VReg_64RegClass, VRC))
3747     VRC = &AMDGPU::VReg_64RegClass;
3748   else
3749     VRC = &AMDGPU::VGPR_32RegClass;
3750 
3751   unsigned Reg = MRI.createVirtualRegister(VRC);
3752   DebugLoc DL = MBB->findDebugLoc(I);
3753   BuildMI(*MI.getParent(), I, DL, get(Opcode), Reg).add(MO);
3754   MO.ChangeToRegister(Reg, false);
3755 }
3756 
3757 unsigned SIInstrInfo::buildExtractSubReg(MachineBasicBlock::iterator MI,
3758                                          MachineRegisterInfo &MRI,
3759                                          MachineOperand &SuperReg,
3760                                          const TargetRegisterClass *SuperRC,
3761                                          unsigned SubIdx,
3762                                          const TargetRegisterClass *SubRC)
3763                                          const {
3764   MachineBasicBlock *MBB = MI->getParent();
3765   DebugLoc DL = MI->getDebugLoc();
3766   unsigned SubReg = MRI.createVirtualRegister(SubRC);
3767 
3768   if (SuperReg.getSubReg() == AMDGPU::NoSubRegister) {
3769     BuildMI(*MBB, MI, DL, get(TargetOpcode::COPY), SubReg)
3770       .addReg(SuperReg.getReg(), 0, SubIdx);
3771     return SubReg;
3772   }
3773 
3774   // Just in case the super register is itself a sub-register, copy it to a new
3775   // value so we don't need to worry about merging its subreg index with the
3776   // SubIdx passed to this function. The register coalescer should be able to
3777   // eliminate this extra copy.
3778   unsigned NewSuperReg = MRI.createVirtualRegister(SuperRC);
3779 
3780   BuildMI(*MBB, MI, DL, get(TargetOpcode::COPY), NewSuperReg)
3781     .addReg(SuperReg.getReg(), 0, SuperReg.getSubReg());
3782 
3783   BuildMI(*MBB, MI, DL, get(TargetOpcode::COPY), SubReg)
3784     .addReg(NewSuperReg, 0, SubIdx);
3785 
3786   return SubReg;
3787 }
3788 
3789 MachineOperand SIInstrInfo::buildExtractSubRegOrImm(
3790   MachineBasicBlock::iterator MII,
3791   MachineRegisterInfo &MRI,
3792   MachineOperand &Op,
3793   const TargetRegisterClass *SuperRC,
3794   unsigned SubIdx,
3795   const TargetRegisterClass *SubRC) const {
3796   if (Op.isImm()) {
3797     if (SubIdx == AMDGPU::sub0)
3798       return MachineOperand::CreateImm(static_cast<int32_t>(Op.getImm()));
3799     if (SubIdx == AMDGPU::sub1)
3800       return MachineOperand::CreateImm(static_cast<int32_t>(Op.getImm() >> 32));
3801 
3802     llvm_unreachable("Unhandled register index for immediate");
3803   }
3804 
3805   unsigned SubReg = buildExtractSubReg(MII, MRI, Op, SuperRC,
3806                                        SubIdx, SubRC);
3807   return MachineOperand::CreateReg(SubReg, false);
3808 }
3809 
3810 // Change the order of operands from (0, 1, 2) to (0, 2, 1)
3811 void SIInstrInfo::swapOperands(MachineInstr &Inst) const {
3812   assert(Inst.getNumExplicitOperands() == 3);
3813   MachineOperand Op1 = Inst.getOperand(1);
3814   Inst.RemoveOperand(1);
3815   Inst.addOperand(Op1);
3816 }
3817 
3818 bool SIInstrInfo::isLegalRegOperand(const MachineRegisterInfo &MRI,
3819                                     const MCOperandInfo &OpInfo,
3820                                     const MachineOperand &MO) const {
3821   if (!MO.isReg())
3822     return false;
3823 
3824   unsigned Reg = MO.getReg();
3825   const TargetRegisterClass *RC = Register::isVirtualRegister(Reg)
3826                                       ? MRI.getRegClass(Reg)
3827                                       : RI.getPhysRegClass(Reg);
3828 
3829   const SIRegisterInfo *TRI =
3830       static_cast<const SIRegisterInfo*>(MRI.getTargetRegisterInfo());
3831   RC = TRI->getSubRegClass(RC, MO.getSubReg());
3832 
3833   // In order to be legal, the common sub-class must be equal to the
3834   // class of the current operand.  For example:
3835   //
3836   // v_mov_b32 s0 ; Operand defined as vsrc_b32
3837   //              ; RI.getCommonSubClass(s0,vsrc_b32) = sgpr ; LEGAL
3838   //
3839   // s_sendmsg 0, s0 ; Operand defined as m0reg
3840   //                 ; RI.getCommonSubClass(s0,m0reg) = m0reg ; NOT LEGAL
3841 
3842   return RI.getCommonSubClass(RC, RI.getRegClass(OpInfo.RegClass)) == RC;
3843 }
3844 
3845 bool SIInstrInfo::isLegalVSrcOperand(const MachineRegisterInfo &MRI,
3846                                      const MCOperandInfo &OpInfo,
3847                                      const MachineOperand &MO) const {
3848   if (MO.isReg())
3849     return isLegalRegOperand(MRI, OpInfo, MO);
3850 
3851   // Handle non-register types that are treated like immediates.
3852   assert(MO.isImm() || MO.isTargetIndex() || MO.isFI() || MO.isGlobal());
3853   return true;
3854 }
3855 
3856 bool SIInstrInfo::isOperandLegal(const MachineInstr &MI, unsigned OpIdx,
3857                                  const MachineOperand *MO) const {
3858   const MachineFunction &MF = *MI.getParent()->getParent();
3859   const MachineRegisterInfo &MRI = MF.getRegInfo();
3860   const MCInstrDesc &InstDesc = MI.getDesc();
3861   const MCOperandInfo &OpInfo = InstDesc.OpInfo[OpIdx];
3862   const GCNSubtarget &ST = MF.getSubtarget<GCNSubtarget>();
3863   const TargetRegisterClass *DefinedRC =
3864       OpInfo.RegClass != -1 ? RI.getRegClass(OpInfo.RegClass) : nullptr;
3865   if (!MO)
3866     MO = &MI.getOperand(OpIdx);
3867 
3868   int ConstantBusLimit = ST.getConstantBusLimit(MI.getOpcode());
3869   int VOP3LiteralLimit = ST.hasVOP3Literal() ? 1 : 0;
3870   if (isVALU(MI) && usesConstantBus(MRI, *MO, OpInfo)) {
3871     if (isVOP3(MI) && isLiteralConstantLike(*MO, OpInfo) && !VOP3LiteralLimit--)
3872       return false;
3873 
3874     SmallDenseSet<RegSubRegPair> SGPRsUsed;
3875     if (MO->isReg())
3876       SGPRsUsed.insert(RegSubRegPair(MO->getReg(), MO->getSubReg()));
3877 
3878     for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
3879       if (i == OpIdx)
3880         continue;
3881       const MachineOperand &Op = MI.getOperand(i);
3882       if (Op.isReg()) {
3883         RegSubRegPair SGPR(Op.getReg(), Op.getSubReg());
3884         if (!SGPRsUsed.count(SGPR) &&
3885             usesConstantBus(MRI, Op, InstDesc.OpInfo[i])) {
3886           if (--ConstantBusLimit <= 0)
3887             return false;
3888           SGPRsUsed.insert(SGPR);
3889         }
3890       } else if (InstDesc.OpInfo[i].OperandType == AMDGPU::OPERAND_KIMM32) {
3891         if (--ConstantBusLimit <= 0)
3892           return false;
3893       } else if (isVOP3(MI) && AMDGPU::isSISrcOperand(InstDesc, i) &&
3894                  isLiteralConstantLike(Op, InstDesc.OpInfo[i])) {
3895         if (!VOP3LiteralLimit--)
3896           return false;
3897         if (--ConstantBusLimit <= 0)
3898           return false;
3899       }
3900     }
3901   }
3902 
3903   if (MO->isReg()) {
3904     assert(DefinedRC);
3905     return isLegalRegOperand(MRI, OpInfo, *MO);
3906   }
3907 
3908   // Handle non-register types that are treated like immediates.
3909   assert(MO->isImm() || MO->isTargetIndex() || MO->isFI() || MO->isGlobal());
3910 
3911   if (!DefinedRC) {
3912     // This operand expects an immediate.
3913     return true;
3914   }
3915 
3916   return isImmOperandLegal(MI, OpIdx, *MO);
3917 }
3918 
3919 void SIInstrInfo::legalizeOperandsVOP2(MachineRegisterInfo &MRI,
3920                                        MachineInstr &MI) const {
3921   unsigned Opc = MI.getOpcode();
3922   const MCInstrDesc &InstrDesc = get(Opc);
3923 
3924   int Src0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0);
3925   MachineOperand &Src0 = MI.getOperand(Src0Idx);
3926 
3927   int Src1Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1);
3928   MachineOperand &Src1 = MI.getOperand(Src1Idx);
3929 
3930   // If there is an implicit SGPR use such as VCC use for v_addc_u32/v_subb_u32
3931   // we need to only have one constant bus use before GFX10.
3932   bool HasImplicitSGPR = findImplicitSGPRRead(MI) != AMDGPU::NoRegister;
3933   if (HasImplicitSGPR && ST.getConstantBusLimit(Opc) <= 1 &&
3934       Src0.isReg() && (RI.isSGPRReg(MRI, Src0.getReg()) ||
3935        isLiteralConstantLike(Src0, InstrDesc.OpInfo[Src0Idx])))
3936     legalizeOpWithMove(MI, Src0Idx);
3937 
3938   // Special case: V_WRITELANE_B32 accepts only immediate or SGPR operands for
3939   // both the value to write (src0) and lane select (src1).  Fix up non-SGPR
3940   // src0/src1 with V_READFIRSTLANE.
3941   if (Opc == AMDGPU::V_WRITELANE_B32) {
3942     const DebugLoc &DL = MI.getDebugLoc();
3943     if (Src0.isReg() && RI.isVGPR(MRI, Src0.getReg())) {
3944       unsigned Reg = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
3945       BuildMI(*MI.getParent(), MI, DL, get(AMDGPU::V_READFIRSTLANE_B32), Reg)
3946           .add(Src0);
3947       Src0.ChangeToRegister(Reg, false);
3948     }
3949     if (Src1.isReg() && RI.isVGPR(MRI, Src1.getReg())) {
3950       unsigned Reg = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
3951       const DebugLoc &DL = MI.getDebugLoc();
3952       BuildMI(*MI.getParent(), MI, DL, get(AMDGPU::V_READFIRSTLANE_B32), Reg)
3953           .add(Src1);
3954       Src1.ChangeToRegister(Reg, false);
3955     }
3956     return;
3957   }
3958 
3959   // No VOP2 instructions support AGPRs.
3960   if (Src0.isReg() && RI.isAGPR(MRI, Src0.getReg()))
3961     legalizeOpWithMove(MI, Src0Idx);
3962 
3963   if (Src1.isReg() && RI.isAGPR(MRI, Src1.getReg()))
3964     legalizeOpWithMove(MI, Src1Idx);
3965 
3966   // VOP2 src0 instructions support all operand types, so we don't need to check
3967   // their legality. If src1 is already legal, we don't need to do anything.
3968   if (isLegalRegOperand(MRI, InstrDesc.OpInfo[Src1Idx], Src1))
3969     return;
3970 
3971   // Special case: V_READLANE_B32 accepts only immediate or SGPR operands for
3972   // lane select. Fix up using V_READFIRSTLANE, since we assume that the lane
3973   // select is uniform.
3974   if (Opc == AMDGPU::V_READLANE_B32 && Src1.isReg() &&
3975       RI.isVGPR(MRI, Src1.getReg())) {
3976     unsigned Reg = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
3977     const DebugLoc &DL = MI.getDebugLoc();
3978     BuildMI(*MI.getParent(), MI, DL, get(AMDGPU::V_READFIRSTLANE_B32), Reg)
3979         .add(Src1);
3980     Src1.ChangeToRegister(Reg, false);
3981     return;
3982   }
3983 
3984   // We do not use commuteInstruction here because it is too aggressive and will
3985   // commute if it is possible. We only want to commute here if it improves
3986   // legality. This can be called a fairly large number of times so don't waste
3987   // compile time pointlessly swapping and checking legality again.
3988   if (HasImplicitSGPR || !MI.isCommutable()) {
3989     legalizeOpWithMove(MI, Src1Idx);
3990     return;
3991   }
3992 
3993   // If src0 can be used as src1, commuting will make the operands legal.
3994   // Otherwise we have to give up and insert a move.
3995   //
3996   // TODO: Other immediate-like operand kinds could be commuted if there was a
3997   // MachineOperand::ChangeTo* for them.
3998   if ((!Src1.isImm() && !Src1.isReg()) ||
3999       !isLegalRegOperand(MRI, InstrDesc.OpInfo[Src1Idx], Src0)) {
4000     legalizeOpWithMove(MI, Src1Idx);
4001     return;
4002   }
4003 
4004   int CommutedOpc = commuteOpcode(MI);
4005   if (CommutedOpc == -1) {
4006     legalizeOpWithMove(MI, Src1Idx);
4007     return;
4008   }
4009 
4010   MI.setDesc(get(CommutedOpc));
4011 
4012   unsigned Src0Reg = Src0.getReg();
4013   unsigned Src0SubReg = Src0.getSubReg();
4014   bool Src0Kill = Src0.isKill();
4015 
4016   if (Src1.isImm())
4017     Src0.ChangeToImmediate(Src1.getImm());
4018   else if (Src1.isReg()) {
4019     Src0.ChangeToRegister(Src1.getReg(), false, false, Src1.isKill());
4020     Src0.setSubReg(Src1.getSubReg());
4021   } else
4022     llvm_unreachable("Should only have register or immediate operands");
4023 
4024   Src1.ChangeToRegister(Src0Reg, false, false, Src0Kill);
4025   Src1.setSubReg(Src0SubReg);
4026   fixImplicitOperands(MI);
4027 }
4028 
4029 // Legalize VOP3 operands. All operand types are supported for any operand
4030 // but only one literal constant and only starting from GFX10.
4031 void SIInstrInfo::legalizeOperandsVOP3(MachineRegisterInfo &MRI,
4032                                        MachineInstr &MI) const {
4033   unsigned Opc = MI.getOpcode();
4034 
4035   int VOP3Idx[3] = {
4036     AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0),
4037     AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1),
4038     AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2)
4039   };
4040 
4041   if (Opc == AMDGPU::V_PERMLANE16_B32 ||
4042       Opc == AMDGPU::V_PERMLANEX16_B32) {
4043     // src1 and src2 must be scalar
4044     MachineOperand &Src1 = MI.getOperand(VOP3Idx[1]);
4045     MachineOperand &Src2 = MI.getOperand(VOP3Idx[2]);
4046     const DebugLoc &DL = MI.getDebugLoc();
4047     if (Src1.isReg() && !RI.isSGPRClass(MRI.getRegClass(Src1.getReg()))) {
4048       unsigned Reg = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
4049       BuildMI(*MI.getParent(), MI, DL, get(AMDGPU::V_READFIRSTLANE_B32), Reg)
4050         .add(Src1);
4051       Src1.ChangeToRegister(Reg, false);
4052     }
4053     if (Src2.isReg() && !RI.isSGPRClass(MRI.getRegClass(Src2.getReg()))) {
4054       unsigned Reg = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
4055       BuildMI(*MI.getParent(), MI, DL, get(AMDGPU::V_READFIRSTLANE_B32), Reg)
4056         .add(Src2);
4057       Src2.ChangeToRegister(Reg, false);
4058     }
4059   }
4060 
4061   // Find the one SGPR operand we are allowed to use.
4062   int ConstantBusLimit = ST.getConstantBusLimit(Opc);
4063   int LiteralLimit = ST.hasVOP3Literal() ? 1 : 0;
4064   SmallDenseSet<unsigned> SGPRsUsed;
4065   unsigned SGPRReg = findUsedSGPR(MI, VOP3Idx);
4066   if (SGPRReg != AMDGPU::NoRegister) {
4067     SGPRsUsed.insert(SGPRReg);
4068     --ConstantBusLimit;
4069   }
4070 
4071   for (unsigned i = 0; i < 3; ++i) {
4072     int Idx = VOP3Idx[i];
4073     if (Idx == -1)
4074       break;
4075     MachineOperand &MO = MI.getOperand(Idx);
4076 
4077     if (!MO.isReg()) {
4078       if (!isLiteralConstantLike(MO, get(Opc).OpInfo[Idx]))
4079         continue;
4080 
4081       if (LiteralLimit > 0 && ConstantBusLimit > 0) {
4082         --LiteralLimit;
4083         --ConstantBusLimit;
4084         continue;
4085       }
4086 
4087       --LiteralLimit;
4088       --ConstantBusLimit;
4089       legalizeOpWithMove(MI, Idx);
4090       continue;
4091     }
4092 
4093     if (RI.hasAGPRs(MRI.getRegClass(MO.getReg())) &&
4094         !isOperandLegal(MI, Idx, &MO)) {
4095       legalizeOpWithMove(MI, Idx);
4096       continue;
4097     }
4098 
4099     if (!RI.isSGPRClass(MRI.getRegClass(MO.getReg())))
4100       continue; // VGPRs are legal
4101 
4102     // We can use one SGPR in each VOP3 instruction prior to GFX10
4103     // and two starting from GFX10.
4104     if (SGPRsUsed.count(MO.getReg()))
4105       continue;
4106     if (ConstantBusLimit > 0) {
4107       SGPRsUsed.insert(MO.getReg());
4108       --ConstantBusLimit;
4109       continue;
4110     }
4111 
4112     // If we make it this far, then the operand is not legal and we must
4113     // legalize it.
4114     legalizeOpWithMove(MI, Idx);
4115   }
4116 }
4117 
4118 unsigned SIInstrInfo::readlaneVGPRToSGPR(unsigned SrcReg, MachineInstr &UseMI,
4119                                          MachineRegisterInfo &MRI) const {
4120   const TargetRegisterClass *VRC = MRI.getRegClass(SrcReg);
4121   const TargetRegisterClass *SRC = RI.getEquivalentSGPRClass(VRC);
4122   unsigned DstReg = MRI.createVirtualRegister(SRC);
4123   unsigned SubRegs = RI.getRegSizeInBits(*VRC) / 32;
4124 
4125   if (RI.hasAGPRs(VRC)) {
4126     VRC = RI.getEquivalentVGPRClass(VRC);
4127     unsigned NewSrcReg = MRI.createVirtualRegister(VRC);
4128     BuildMI(*UseMI.getParent(), UseMI, UseMI.getDebugLoc(),
4129             get(TargetOpcode::COPY), NewSrcReg)
4130         .addReg(SrcReg);
4131     SrcReg = NewSrcReg;
4132   }
4133 
4134   if (SubRegs == 1) {
4135     BuildMI(*UseMI.getParent(), UseMI, UseMI.getDebugLoc(),
4136             get(AMDGPU::V_READFIRSTLANE_B32), DstReg)
4137         .addReg(SrcReg);
4138     return DstReg;
4139   }
4140 
4141   SmallVector<unsigned, 8> SRegs;
4142   for (unsigned i = 0; i < SubRegs; ++i) {
4143     unsigned SGPR = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
4144     BuildMI(*UseMI.getParent(), UseMI, UseMI.getDebugLoc(),
4145             get(AMDGPU::V_READFIRSTLANE_B32), SGPR)
4146         .addReg(SrcReg, 0, RI.getSubRegFromChannel(i));
4147     SRegs.push_back(SGPR);
4148   }
4149 
4150   MachineInstrBuilder MIB =
4151       BuildMI(*UseMI.getParent(), UseMI, UseMI.getDebugLoc(),
4152               get(AMDGPU::REG_SEQUENCE), DstReg);
4153   for (unsigned i = 0; i < SubRegs; ++i) {
4154     MIB.addReg(SRegs[i]);
4155     MIB.addImm(RI.getSubRegFromChannel(i));
4156   }
4157   return DstReg;
4158 }
4159 
4160 void SIInstrInfo::legalizeOperandsSMRD(MachineRegisterInfo &MRI,
4161                                        MachineInstr &MI) const {
4162 
4163   // If the pointer is store in VGPRs, then we need to move them to
4164   // SGPRs using v_readfirstlane.  This is safe because we only select
4165   // loads with uniform pointers to SMRD instruction so we know the
4166   // pointer value is uniform.
4167   MachineOperand *SBase = getNamedOperand(MI, AMDGPU::OpName::sbase);
4168   if (SBase && !RI.isSGPRClass(MRI.getRegClass(SBase->getReg()))) {
4169     unsigned SGPR = readlaneVGPRToSGPR(SBase->getReg(), MI, MRI);
4170     SBase->setReg(SGPR);
4171   }
4172   MachineOperand *SOff = getNamedOperand(MI, AMDGPU::OpName::soff);
4173   if (SOff && !RI.isSGPRClass(MRI.getRegClass(SOff->getReg()))) {
4174     unsigned SGPR = readlaneVGPRToSGPR(SOff->getReg(), MI, MRI);
4175     SOff->setReg(SGPR);
4176   }
4177 }
4178 
4179 void SIInstrInfo::legalizeGenericOperand(MachineBasicBlock &InsertMBB,
4180                                          MachineBasicBlock::iterator I,
4181                                          const TargetRegisterClass *DstRC,
4182                                          MachineOperand &Op,
4183                                          MachineRegisterInfo &MRI,
4184                                          const DebugLoc &DL) const {
4185   unsigned OpReg = Op.getReg();
4186   unsigned OpSubReg = Op.getSubReg();
4187 
4188   const TargetRegisterClass *OpRC = RI.getSubClassWithSubReg(
4189       RI.getRegClassForReg(MRI, OpReg), OpSubReg);
4190 
4191   // Check if operand is already the correct register class.
4192   if (DstRC == OpRC)
4193     return;
4194 
4195   unsigned DstReg = MRI.createVirtualRegister(DstRC);
4196   MachineInstr *Copy =
4197       BuildMI(InsertMBB, I, DL, get(AMDGPU::COPY), DstReg).add(Op);
4198 
4199   Op.setReg(DstReg);
4200   Op.setSubReg(0);
4201 
4202   MachineInstr *Def = MRI.getVRegDef(OpReg);
4203   if (!Def)
4204     return;
4205 
4206   // Try to eliminate the copy if it is copying an immediate value.
4207   if (Def->isMoveImmediate())
4208     FoldImmediate(*Copy, *Def, OpReg, &MRI);
4209 }
4210 
4211 // Emit the actual waterfall loop, executing the wrapped instruction for each
4212 // unique value of \p Rsrc across all lanes. In the best case we execute 1
4213 // iteration, in the worst case we execute 64 (once per lane).
4214 static void
4215 emitLoadSRsrcFromVGPRLoop(const SIInstrInfo &TII, MachineRegisterInfo &MRI,
4216                           MachineBasicBlock &OrigBB, MachineBasicBlock &LoopBB,
4217                           const DebugLoc &DL, MachineOperand &Rsrc) {
4218   MachineFunction &MF = *OrigBB.getParent();
4219   const GCNSubtarget &ST = MF.getSubtarget<GCNSubtarget>();
4220   const SIRegisterInfo *TRI = ST.getRegisterInfo();
4221   unsigned Exec = ST.isWave32() ? AMDGPU::EXEC_LO : AMDGPU::EXEC;
4222   unsigned SaveExecOpc =
4223       ST.isWave32() ? AMDGPU::S_AND_SAVEEXEC_B32 : AMDGPU::S_AND_SAVEEXEC_B64;
4224   unsigned XorTermOpc =
4225       ST.isWave32() ? AMDGPU::S_XOR_B32_term : AMDGPU::S_XOR_B64_term;
4226   unsigned AndOpc =
4227       ST.isWave32() ? AMDGPU::S_AND_B32 : AMDGPU::S_AND_B64;
4228   const auto *BoolXExecRC = TRI->getRegClass(AMDGPU::SReg_1_XEXECRegClassID);
4229 
4230   MachineBasicBlock::iterator I = LoopBB.begin();
4231 
4232   unsigned VRsrc = Rsrc.getReg();
4233   unsigned VRsrcUndef = getUndefRegState(Rsrc.isUndef());
4234 
4235   unsigned SaveExec = MRI.createVirtualRegister(BoolXExecRC);
4236   unsigned CondReg0 = MRI.createVirtualRegister(BoolXExecRC);
4237   unsigned CondReg1 = MRI.createVirtualRegister(BoolXExecRC);
4238   unsigned AndCond = MRI.createVirtualRegister(BoolXExecRC);
4239   unsigned SRsrcSub0 = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
4240   unsigned SRsrcSub1 = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
4241   unsigned SRsrcSub2 = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
4242   unsigned SRsrcSub3 = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
4243   unsigned SRsrc = MRI.createVirtualRegister(&AMDGPU::SReg_128RegClass);
4244 
4245   // Beginning of the loop, read the next Rsrc variant.
4246   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::V_READFIRSTLANE_B32), SRsrcSub0)
4247       .addReg(VRsrc, VRsrcUndef, AMDGPU::sub0);
4248   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::V_READFIRSTLANE_B32), SRsrcSub1)
4249       .addReg(VRsrc, VRsrcUndef, AMDGPU::sub1);
4250   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::V_READFIRSTLANE_B32), SRsrcSub2)
4251       .addReg(VRsrc, VRsrcUndef, AMDGPU::sub2);
4252   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::V_READFIRSTLANE_B32), SRsrcSub3)
4253       .addReg(VRsrc, VRsrcUndef, AMDGPU::sub3);
4254 
4255   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::REG_SEQUENCE), SRsrc)
4256       .addReg(SRsrcSub0)
4257       .addImm(AMDGPU::sub0)
4258       .addReg(SRsrcSub1)
4259       .addImm(AMDGPU::sub1)
4260       .addReg(SRsrcSub2)
4261       .addImm(AMDGPU::sub2)
4262       .addReg(SRsrcSub3)
4263       .addImm(AMDGPU::sub3);
4264 
4265   // Update Rsrc operand to use the SGPR Rsrc.
4266   Rsrc.setReg(SRsrc);
4267   Rsrc.setIsKill(true);
4268 
4269   // Identify all lanes with identical Rsrc operands in their VGPRs.
4270   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::V_CMP_EQ_U64_e64), CondReg0)
4271       .addReg(SRsrc, 0, AMDGPU::sub0_sub1)
4272       .addReg(VRsrc, 0, AMDGPU::sub0_sub1);
4273   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::V_CMP_EQ_U64_e64), CondReg1)
4274       .addReg(SRsrc, 0, AMDGPU::sub2_sub3)
4275       .addReg(VRsrc, 0, AMDGPU::sub2_sub3);
4276   BuildMI(LoopBB, I, DL, TII.get(AndOpc), AndCond)
4277       .addReg(CondReg0)
4278       .addReg(CondReg1);
4279 
4280   MRI.setSimpleHint(SaveExec, AndCond);
4281 
4282   // Update EXEC to matching lanes, saving original to SaveExec.
4283   BuildMI(LoopBB, I, DL, TII.get(SaveExecOpc), SaveExec)
4284       .addReg(AndCond, RegState::Kill);
4285 
4286   // The original instruction is here; we insert the terminators after it.
4287   I = LoopBB.end();
4288 
4289   // Update EXEC, switch all done bits to 0 and all todo bits to 1.
4290   BuildMI(LoopBB, I, DL, TII.get(XorTermOpc), Exec)
4291       .addReg(Exec)
4292       .addReg(SaveExec);
4293   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::S_CBRANCH_EXECNZ)).addMBB(&LoopBB);
4294 }
4295 
4296 // Build a waterfall loop around \p MI, replacing the VGPR \p Rsrc register
4297 // with SGPRs by iterating over all unique values across all lanes.
4298 static void loadSRsrcFromVGPR(const SIInstrInfo &TII, MachineInstr &MI,
4299                               MachineOperand &Rsrc, MachineDominatorTree *MDT) {
4300   MachineBasicBlock &MBB = *MI.getParent();
4301   MachineFunction &MF = *MBB.getParent();
4302   const GCNSubtarget &ST = MF.getSubtarget<GCNSubtarget>();
4303   const SIRegisterInfo *TRI = ST.getRegisterInfo();
4304   MachineRegisterInfo &MRI = MF.getRegInfo();
4305   MachineBasicBlock::iterator I(&MI);
4306   const DebugLoc &DL = MI.getDebugLoc();
4307   unsigned Exec = ST.isWave32() ? AMDGPU::EXEC_LO : AMDGPU::EXEC;
4308   unsigned MovExecOpc = ST.isWave32() ? AMDGPU::S_MOV_B32 : AMDGPU::S_MOV_B64;
4309   const auto *BoolXExecRC = TRI->getRegClass(AMDGPU::SReg_1_XEXECRegClassID);
4310 
4311   unsigned SaveExec = MRI.createVirtualRegister(BoolXExecRC);
4312 
4313   // Save the EXEC mask
4314   BuildMI(MBB, I, DL, TII.get(MovExecOpc), SaveExec).addReg(Exec);
4315 
4316   // Killed uses in the instruction we are waterfalling around will be
4317   // incorrect due to the added control-flow.
4318   for (auto &MO : MI.uses()) {
4319     if (MO.isReg() && MO.isUse()) {
4320       MRI.clearKillFlags(MO.getReg());
4321     }
4322   }
4323 
4324   // To insert the loop we need to split the block. Move everything after this
4325   // point to a new block, and insert a new empty block between the two.
4326   MachineBasicBlock *LoopBB = MF.CreateMachineBasicBlock();
4327   MachineBasicBlock *RemainderBB = MF.CreateMachineBasicBlock();
4328   MachineFunction::iterator MBBI(MBB);
4329   ++MBBI;
4330 
4331   MF.insert(MBBI, LoopBB);
4332   MF.insert(MBBI, RemainderBB);
4333 
4334   LoopBB->addSuccessor(LoopBB);
4335   LoopBB->addSuccessor(RemainderBB);
4336 
4337   // Move MI to the LoopBB, and the remainder of the block to RemainderBB.
4338   MachineBasicBlock::iterator J = I++;
4339   RemainderBB->transferSuccessorsAndUpdatePHIs(&MBB);
4340   RemainderBB->splice(RemainderBB->begin(), &MBB, I, MBB.end());
4341   LoopBB->splice(LoopBB->begin(), &MBB, J);
4342 
4343   MBB.addSuccessor(LoopBB);
4344 
4345   // Update dominators. We know that MBB immediately dominates LoopBB, that
4346   // LoopBB immediately dominates RemainderBB, and that RemainderBB immediately
4347   // dominates all of the successors transferred to it from MBB that MBB used
4348   // to dominate.
4349   if (MDT) {
4350     MDT->addNewBlock(LoopBB, &MBB);
4351     MDT->addNewBlock(RemainderBB, LoopBB);
4352     for (auto &Succ : RemainderBB->successors()) {
4353       if (MDT->dominates(&MBB, Succ)) {
4354         MDT->changeImmediateDominator(Succ, RemainderBB);
4355       }
4356     }
4357   }
4358 
4359   emitLoadSRsrcFromVGPRLoop(TII, MRI, MBB, *LoopBB, DL, Rsrc);
4360 
4361   // Restore the EXEC mask
4362   MachineBasicBlock::iterator First = RemainderBB->begin();
4363   BuildMI(*RemainderBB, First, DL, TII.get(MovExecOpc), Exec).addReg(SaveExec);
4364 }
4365 
4366 // Extract pointer from Rsrc and return a zero-value Rsrc replacement.
4367 static std::tuple<unsigned, unsigned>
4368 extractRsrcPtr(const SIInstrInfo &TII, MachineInstr &MI, MachineOperand &Rsrc) {
4369   MachineBasicBlock &MBB = *MI.getParent();
4370   MachineFunction &MF = *MBB.getParent();
4371   MachineRegisterInfo &MRI = MF.getRegInfo();
4372 
4373   // Extract the ptr from the resource descriptor.
4374   unsigned RsrcPtr =
4375       TII.buildExtractSubReg(MI, MRI, Rsrc, &AMDGPU::VReg_128RegClass,
4376                              AMDGPU::sub0_sub1, &AMDGPU::VReg_64RegClass);
4377 
4378   // Create an empty resource descriptor
4379   unsigned Zero64 = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
4380   unsigned SRsrcFormatLo = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
4381   unsigned SRsrcFormatHi = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
4382   unsigned NewSRsrc = MRI.createVirtualRegister(&AMDGPU::SReg_128RegClass);
4383   uint64_t RsrcDataFormat = TII.getDefaultRsrcDataFormat();
4384 
4385   // Zero64 = 0
4386   BuildMI(MBB, MI, MI.getDebugLoc(), TII.get(AMDGPU::S_MOV_B64), Zero64)
4387       .addImm(0);
4388 
4389   // SRsrcFormatLo = RSRC_DATA_FORMAT{31-0}
4390   BuildMI(MBB, MI, MI.getDebugLoc(), TII.get(AMDGPU::S_MOV_B32), SRsrcFormatLo)
4391       .addImm(RsrcDataFormat & 0xFFFFFFFF);
4392 
4393   // SRsrcFormatHi = RSRC_DATA_FORMAT{63-32}
4394   BuildMI(MBB, MI, MI.getDebugLoc(), TII.get(AMDGPU::S_MOV_B32), SRsrcFormatHi)
4395       .addImm(RsrcDataFormat >> 32);
4396 
4397   // NewSRsrc = {Zero64, SRsrcFormat}
4398   BuildMI(MBB, MI, MI.getDebugLoc(), TII.get(AMDGPU::REG_SEQUENCE), NewSRsrc)
4399       .addReg(Zero64)
4400       .addImm(AMDGPU::sub0_sub1)
4401       .addReg(SRsrcFormatLo)
4402       .addImm(AMDGPU::sub2)
4403       .addReg(SRsrcFormatHi)
4404       .addImm(AMDGPU::sub3);
4405 
4406   return std::make_tuple(RsrcPtr, NewSRsrc);
4407 }
4408 
4409 void SIInstrInfo::legalizeOperands(MachineInstr &MI,
4410                                    MachineDominatorTree *MDT) const {
4411   MachineFunction &MF = *MI.getParent()->getParent();
4412   MachineRegisterInfo &MRI = MF.getRegInfo();
4413 
4414   // Legalize VOP2
4415   if (isVOP2(MI) || isVOPC(MI)) {
4416     legalizeOperandsVOP2(MRI, MI);
4417     return;
4418   }
4419 
4420   // Legalize VOP3
4421   if (isVOP3(MI)) {
4422     legalizeOperandsVOP3(MRI, MI);
4423     return;
4424   }
4425 
4426   // Legalize SMRD
4427   if (isSMRD(MI)) {
4428     legalizeOperandsSMRD(MRI, MI);
4429     return;
4430   }
4431 
4432   // Legalize REG_SEQUENCE and PHI
4433   // The register class of the operands much be the same type as the register
4434   // class of the output.
4435   if (MI.getOpcode() == AMDGPU::PHI) {
4436     const TargetRegisterClass *RC = nullptr, *SRC = nullptr, *VRC = nullptr;
4437     for (unsigned i = 1, e = MI.getNumOperands(); i != e; i += 2) {
4438       if (!MI.getOperand(i).isReg() ||
4439           !Register::isVirtualRegister(MI.getOperand(i).getReg()))
4440         continue;
4441       const TargetRegisterClass *OpRC =
4442           MRI.getRegClass(MI.getOperand(i).getReg());
4443       if (RI.hasVectorRegisters(OpRC)) {
4444         VRC = OpRC;
4445       } else {
4446         SRC = OpRC;
4447       }
4448     }
4449 
4450     // If any of the operands are VGPR registers, then they all most be
4451     // otherwise we will create illegal VGPR->SGPR copies when legalizing
4452     // them.
4453     if (VRC || !RI.isSGPRClass(getOpRegClass(MI, 0))) {
4454       if (!VRC) {
4455         assert(SRC);
4456         VRC = RI.hasAGPRs(getOpRegClass(MI, 0)) ? RI.getEquivalentAGPRClass(SRC)
4457                                                 : RI.getEquivalentVGPRClass(SRC);
4458       }
4459       RC = VRC;
4460     } else {
4461       RC = SRC;
4462     }
4463 
4464     // Update all the operands so they have the same type.
4465     for (unsigned I = 1, E = MI.getNumOperands(); I != E; I += 2) {
4466       MachineOperand &Op = MI.getOperand(I);
4467       if (!Op.isReg() || !Register::isVirtualRegister(Op.getReg()))
4468         continue;
4469 
4470       // MI is a PHI instruction.
4471       MachineBasicBlock *InsertBB = MI.getOperand(I + 1).getMBB();
4472       MachineBasicBlock::iterator Insert = InsertBB->getFirstTerminator();
4473 
4474       // Avoid creating no-op copies with the same src and dst reg class.  These
4475       // confuse some of the machine passes.
4476       legalizeGenericOperand(*InsertBB, Insert, RC, Op, MRI, MI.getDebugLoc());
4477     }
4478   }
4479 
4480   // REG_SEQUENCE doesn't really require operand legalization, but if one has a
4481   // VGPR dest type and SGPR sources, insert copies so all operands are
4482   // VGPRs. This seems to help operand folding / the register coalescer.
4483   if (MI.getOpcode() == AMDGPU::REG_SEQUENCE) {
4484     MachineBasicBlock *MBB = MI.getParent();
4485     const TargetRegisterClass *DstRC = getOpRegClass(MI, 0);
4486     if (RI.hasVGPRs(DstRC)) {
4487       // Update all the operands so they are VGPR register classes. These may
4488       // not be the same register class because REG_SEQUENCE supports mixing
4489       // subregister index types e.g. sub0_sub1 + sub2 + sub3
4490       for (unsigned I = 1, E = MI.getNumOperands(); I != E; I += 2) {
4491         MachineOperand &Op = MI.getOperand(I);
4492         if (!Op.isReg() || !Register::isVirtualRegister(Op.getReg()))
4493           continue;
4494 
4495         const TargetRegisterClass *OpRC = MRI.getRegClass(Op.getReg());
4496         const TargetRegisterClass *VRC = RI.getEquivalentVGPRClass(OpRC);
4497         if (VRC == OpRC)
4498           continue;
4499 
4500         legalizeGenericOperand(*MBB, MI, VRC, Op, MRI, MI.getDebugLoc());
4501         Op.setIsKill();
4502       }
4503     }
4504 
4505     return;
4506   }
4507 
4508   // Legalize INSERT_SUBREG
4509   // src0 must have the same register class as dst
4510   if (MI.getOpcode() == AMDGPU::INSERT_SUBREG) {
4511     unsigned Dst = MI.getOperand(0).getReg();
4512     unsigned Src0 = MI.getOperand(1).getReg();
4513     const TargetRegisterClass *DstRC = MRI.getRegClass(Dst);
4514     const TargetRegisterClass *Src0RC = MRI.getRegClass(Src0);
4515     if (DstRC != Src0RC) {
4516       MachineBasicBlock *MBB = MI.getParent();
4517       MachineOperand &Op = MI.getOperand(1);
4518       legalizeGenericOperand(*MBB, MI, DstRC, Op, MRI, MI.getDebugLoc());
4519     }
4520     return;
4521   }
4522 
4523   // Legalize SI_INIT_M0
4524   if (MI.getOpcode() == AMDGPU::SI_INIT_M0) {
4525     MachineOperand &Src = MI.getOperand(0);
4526     if (Src.isReg() && RI.hasVectorRegisters(MRI.getRegClass(Src.getReg())))
4527       Src.setReg(readlaneVGPRToSGPR(Src.getReg(), MI, MRI));
4528     return;
4529   }
4530 
4531   // Legalize MIMG and MUBUF/MTBUF for shaders.
4532   //
4533   // Shaders only generate MUBUF/MTBUF instructions via intrinsics or via
4534   // scratch memory access. In both cases, the legalization never involves
4535   // conversion to the addr64 form.
4536   if (isMIMG(MI) ||
4537       (AMDGPU::isShader(MF.getFunction().getCallingConv()) &&
4538        (isMUBUF(MI) || isMTBUF(MI)))) {
4539     MachineOperand *SRsrc = getNamedOperand(MI, AMDGPU::OpName::srsrc);
4540     if (SRsrc && !RI.isSGPRClass(MRI.getRegClass(SRsrc->getReg()))) {
4541       unsigned SGPR = readlaneVGPRToSGPR(SRsrc->getReg(), MI, MRI);
4542       SRsrc->setReg(SGPR);
4543     }
4544 
4545     MachineOperand *SSamp = getNamedOperand(MI, AMDGPU::OpName::ssamp);
4546     if (SSamp && !RI.isSGPRClass(MRI.getRegClass(SSamp->getReg()))) {
4547       unsigned SGPR = readlaneVGPRToSGPR(SSamp->getReg(), MI, MRI);
4548       SSamp->setReg(SGPR);
4549     }
4550     return;
4551   }
4552 
4553   // Legalize MUBUF* instructions.
4554   int RsrcIdx =
4555       AMDGPU::getNamedOperandIdx(MI.getOpcode(), AMDGPU::OpName::srsrc);
4556   if (RsrcIdx != -1) {
4557     // We have an MUBUF instruction
4558     MachineOperand *Rsrc = &MI.getOperand(RsrcIdx);
4559     unsigned RsrcRC = get(MI.getOpcode()).OpInfo[RsrcIdx].RegClass;
4560     if (RI.getCommonSubClass(MRI.getRegClass(Rsrc->getReg()),
4561                              RI.getRegClass(RsrcRC))) {
4562       // The operands are legal.
4563       // FIXME: We may need to legalize operands besided srsrc.
4564       return;
4565     }
4566 
4567     // Legalize a VGPR Rsrc.
4568     //
4569     // If the instruction is _ADDR64, we can avoid a waterfall by extracting
4570     // the base pointer from the VGPR Rsrc, adding it to the VAddr, then using
4571     // a zero-value SRsrc.
4572     //
4573     // If the instruction is _OFFSET (both idxen and offen disabled), and we
4574     // support ADDR64 instructions, we can convert to ADDR64 and do the same as
4575     // above.
4576     //
4577     // Otherwise we are on non-ADDR64 hardware, and/or we have
4578     // idxen/offen/bothen and we fall back to a waterfall loop.
4579 
4580     MachineBasicBlock &MBB = *MI.getParent();
4581 
4582     MachineOperand *VAddr = getNamedOperand(MI, AMDGPU::OpName::vaddr);
4583     if (VAddr && AMDGPU::getIfAddr64Inst(MI.getOpcode()) != -1) {
4584       // This is already an ADDR64 instruction so we need to add the pointer
4585       // extracted from the resource descriptor to the current value of VAddr.
4586       unsigned NewVAddrLo = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4587       unsigned NewVAddrHi = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4588       unsigned NewVAddr = MRI.createVirtualRegister(&AMDGPU::VReg_64RegClass);
4589 
4590       const auto *BoolXExecRC = RI.getRegClass(AMDGPU::SReg_1_XEXECRegClassID);
4591       unsigned CondReg0 = MRI.createVirtualRegister(BoolXExecRC);
4592       unsigned CondReg1 = MRI.createVirtualRegister(BoolXExecRC);
4593 
4594       unsigned RsrcPtr, NewSRsrc;
4595       std::tie(RsrcPtr, NewSRsrc) = extractRsrcPtr(*this, MI, *Rsrc);
4596 
4597       // NewVaddrLo = RsrcPtr:sub0 + VAddr:sub0
4598       const DebugLoc &DL = MI.getDebugLoc();
4599       BuildMI(MBB, MI, DL, get(AMDGPU::V_ADD_I32_e64), NewVAddrLo)
4600         .addDef(CondReg0)
4601         .addReg(RsrcPtr, 0, AMDGPU::sub0)
4602         .addReg(VAddr->getReg(), 0, AMDGPU::sub0)
4603         .addImm(0);
4604 
4605       // NewVaddrHi = RsrcPtr:sub1 + VAddr:sub1
4606       BuildMI(MBB, MI, DL, get(AMDGPU::V_ADDC_U32_e64), NewVAddrHi)
4607         .addDef(CondReg1, RegState::Dead)
4608         .addReg(RsrcPtr, 0, AMDGPU::sub1)
4609         .addReg(VAddr->getReg(), 0, AMDGPU::sub1)
4610         .addReg(CondReg0, RegState::Kill)
4611         .addImm(0);
4612 
4613       // NewVaddr = {NewVaddrHi, NewVaddrLo}
4614       BuildMI(MBB, MI, MI.getDebugLoc(), get(AMDGPU::REG_SEQUENCE), NewVAddr)
4615           .addReg(NewVAddrLo)
4616           .addImm(AMDGPU::sub0)
4617           .addReg(NewVAddrHi)
4618           .addImm(AMDGPU::sub1);
4619 
4620       VAddr->setReg(NewVAddr);
4621       Rsrc->setReg(NewSRsrc);
4622     } else if (!VAddr && ST.hasAddr64()) {
4623       // This instructions is the _OFFSET variant, so we need to convert it to
4624       // ADDR64.
4625       assert(MBB.getParent()->getSubtarget<GCNSubtarget>().getGeneration()
4626              < AMDGPUSubtarget::VOLCANIC_ISLANDS &&
4627              "FIXME: Need to emit flat atomics here");
4628 
4629       unsigned RsrcPtr, NewSRsrc;
4630       std::tie(RsrcPtr, NewSRsrc) = extractRsrcPtr(*this, MI, *Rsrc);
4631 
4632       unsigned NewVAddr = MRI.createVirtualRegister(&AMDGPU::VReg_64RegClass);
4633       MachineOperand *VData = getNamedOperand(MI, AMDGPU::OpName::vdata);
4634       MachineOperand *Offset = getNamedOperand(MI, AMDGPU::OpName::offset);
4635       MachineOperand *SOffset = getNamedOperand(MI, AMDGPU::OpName::soffset);
4636       unsigned Addr64Opcode = AMDGPU::getAddr64Inst(MI.getOpcode());
4637 
4638       // Atomics rith return have have an additional tied operand and are
4639       // missing some of the special bits.
4640       MachineOperand *VDataIn = getNamedOperand(MI, AMDGPU::OpName::vdata_in);
4641       MachineInstr *Addr64;
4642 
4643       if (!VDataIn) {
4644         // Regular buffer load / store.
4645         MachineInstrBuilder MIB =
4646             BuildMI(MBB, MI, MI.getDebugLoc(), get(Addr64Opcode))
4647                 .add(*VData)
4648                 .addReg(NewVAddr)
4649                 .addReg(NewSRsrc)
4650                 .add(*SOffset)
4651                 .add(*Offset);
4652 
4653         // Atomics do not have this operand.
4654         if (const MachineOperand *GLC =
4655                 getNamedOperand(MI, AMDGPU::OpName::glc)) {
4656           MIB.addImm(GLC->getImm());
4657         }
4658         if (const MachineOperand *DLC =
4659                 getNamedOperand(MI, AMDGPU::OpName::dlc)) {
4660           MIB.addImm(DLC->getImm());
4661         }
4662 
4663         MIB.addImm(getNamedImmOperand(MI, AMDGPU::OpName::slc));
4664 
4665         if (const MachineOperand *TFE =
4666                 getNamedOperand(MI, AMDGPU::OpName::tfe)) {
4667           MIB.addImm(TFE->getImm());
4668         }
4669 
4670         MIB.cloneMemRefs(MI);
4671         Addr64 = MIB;
4672       } else {
4673         // Atomics with return.
4674         Addr64 = BuildMI(MBB, MI, MI.getDebugLoc(), get(Addr64Opcode))
4675                      .add(*VData)
4676                      .add(*VDataIn)
4677                      .addReg(NewVAddr)
4678                      .addReg(NewSRsrc)
4679                      .add(*SOffset)
4680                      .add(*Offset)
4681                      .addImm(getNamedImmOperand(MI, AMDGPU::OpName::slc))
4682                      .cloneMemRefs(MI);
4683       }
4684 
4685       MI.removeFromParent();
4686 
4687       // NewVaddr = {NewVaddrHi, NewVaddrLo}
4688       BuildMI(MBB, Addr64, Addr64->getDebugLoc(), get(AMDGPU::REG_SEQUENCE),
4689               NewVAddr)
4690           .addReg(RsrcPtr, 0, AMDGPU::sub0)
4691           .addImm(AMDGPU::sub0)
4692           .addReg(RsrcPtr, 0, AMDGPU::sub1)
4693           .addImm(AMDGPU::sub1);
4694     } else {
4695       // This is another variant; legalize Rsrc with waterfall loop from VGPRs
4696       // to SGPRs.
4697       loadSRsrcFromVGPR(*this, MI, *Rsrc, MDT);
4698     }
4699   }
4700 }
4701 
4702 void SIInstrInfo::moveToVALU(MachineInstr &TopInst,
4703                              MachineDominatorTree *MDT) const {
4704   SetVectorType Worklist;
4705   Worklist.insert(&TopInst);
4706 
4707   while (!Worklist.empty()) {
4708     MachineInstr &Inst = *Worklist.pop_back_val();
4709     MachineBasicBlock *MBB = Inst.getParent();
4710     MachineRegisterInfo &MRI = MBB->getParent()->getRegInfo();
4711 
4712     unsigned Opcode = Inst.getOpcode();
4713     unsigned NewOpcode = getVALUOp(Inst);
4714 
4715     // Handle some special cases
4716     switch (Opcode) {
4717     default:
4718       break;
4719     case AMDGPU::S_ADD_U64_PSEUDO:
4720     case AMDGPU::S_SUB_U64_PSEUDO:
4721       splitScalar64BitAddSub(Worklist, Inst, MDT);
4722       Inst.eraseFromParent();
4723       continue;
4724     case AMDGPU::S_ADD_I32:
4725     case AMDGPU::S_SUB_I32:
4726       // FIXME: The u32 versions currently selected use the carry.
4727       if (moveScalarAddSub(Worklist, Inst, MDT))
4728         continue;
4729 
4730       // Default handling
4731       break;
4732     case AMDGPU::S_AND_B64:
4733       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_AND_B32, MDT);
4734       Inst.eraseFromParent();
4735       continue;
4736 
4737     case AMDGPU::S_OR_B64:
4738       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_OR_B32, MDT);
4739       Inst.eraseFromParent();
4740       continue;
4741 
4742     case AMDGPU::S_XOR_B64:
4743       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_XOR_B32, MDT);
4744       Inst.eraseFromParent();
4745       continue;
4746 
4747     case AMDGPU::S_NAND_B64:
4748       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_NAND_B32, MDT);
4749       Inst.eraseFromParent();
4750       continue;
4751 
4752     case AMDGPU::S_NOR_B64:
4753       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_NOR_B32, MDT);
4754       Inst.eraseFromParent();
4755       continue;
4756 
4757     case AMDGPU::S_XNOR_B64:
4758       if (ST.hasDLInsts())
4759         splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_XNOR_B32, MDT);
4760       else
4761         splitScalar64BitXnor(Worklist, Inst, MDT);
4762       Inst.eraseFromParent();
4763       continue;
4764 
4765     case AMDGPU::S_ANDN2_B64:
4766       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_ANDN2_B32, MDT);
4767       Inst.eraseFromParent();
4768       continue;
4769 
4770     case AMDGPU::S_ORN2_B64:
4771       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_ORN2_B32, MDT);
4772       Inst.eraseFromParent();
4773       continue;
4774 
4775     case AMDGPU::S_NOT_B64:
4776       splitScalar64BitUnaryOp(Worklist, Inst, AMDGPU::S_NOT_B32);
4777       Inst.eraseFromParent();
4778       continue;
4779 
4780     case AMDGPU::S_BCNT1_I32_B64:
4781       splitScalar64BitBCNT(Worklist, Inst);
4782       Inst.eraseFromParent();
4783       continue;
4784 
4785     case AMDGPU::S_BFE_I64:
4786       splitScalar64BitBFE(Worklist, Inst);
4787       Inst.eraseFromParent();
4788       continue;
4789 
4790     case AMDGPU::S_LSHL_B32:
4791       if (ST.hasOnlyRevVALUShifts()) {
4792         NewOpcode = AMDGPU::V_LSHLREV_B32_e64;
4793         swapOperands(Inst);
4794       }
4795       break;
4796     case AMDGPU::S_ASHR_I32:
4797       if (ST.hasOnlyRevVALUShifts()) {
4798         NewOpcode = AMDGPU::V_ASHRREV_I32_e64;
4799         swapOperands(Inst);
4800       }
4801       break;
4802     case AMDGPU::S_LSHR_B32:
4803       if (ST.hasOnlyRevVALUShifts()) {
4804         NewOpcode = AMDGPU::V_LSHRREV_B32_e64;
4805         swapOperands(Inst);
4806       }
4807       break;
4808     case AMDGPU::S_LSHL_B64:
4809       if (ST.hasOnlyRevVALUShifts()) {
4810         NewOpcode = AMDGPU::V_LSHLREV_B64;
4811         swapOperands(Inst);
4812       }
4813       break;
4814     case AMDGPU::S_ASHR_I64:
4815       if (ST.hasOnlyRevVALUShifts()) {
4816         NewOpcode = AMDGPU::V_ASHRREV_I64;
4817         swapOperands(Inst);
4818       }
4819       break;
4820     case AMDGPU::S_LSHR_B64:
4821       if (ST.hasOnlyRevVALUShifts()) {
4822         NewOpcode = AMDGPU::V_LSHRREV_B64;
4823         swapOperands(Inst);
4824       }
4825       break;
4826 
4827     case AMDGPU::S_ABS_I32:
4828       lowerScalarAbs(Worklist, Inst);
4829       Inst.eraseFromParent();
4830       continue;
4831 
4832     case AMDGPU::S_CBRANCH_SCC0:
4833     case AMDGPU::S_CBRANCH_SCC1:
4834       // Clear unused bits of vcc
4835       if (ST.isWave32())
4836         BuildMI(*MBB, Inst, Inst.getDebugLoc(), get(AMDGPU::S_AND_B32),
4837                 AMDGPU::VCC_LO)
4838             .addReg(AMDGPU::EXEC_LO)
4839             .addReg(AMDGPU::VCC_LO);
4840       else
4841         BuildMI(*MBB, Inst, Inst.getDebugLoc(), get(AMDGPU::S_AND_B64),
4842                 AMDGPU::VCC)
4843             .addReg(AMDGPU::EXEC)
4844             .addReg(AMDGPU::VCC);
4845       break;
4846 
4847     case AMDGPU::S_BFE_U64:
4848     case AMDGPU::S_BFM_B64:
4849       llvm_unreachable("Moving this op to VALU not implemented");
4850 
4851     case AMDGPU::S_PACK_LL_B32_B16:
4852     case AMDGPU::S_PACK_LH_B32_B16:
4853     case AMDGPU::S_PACK_HH_B32_B16:
4854       movePackToVALU(Worklist, MRI, Inst);
4855       Inst.eraseFromParent();
4856       continue;
4857 
4858     case AMDGPU::S_XNOR_B32:
4859       lowerScalarXnor(Worklist, Inst);
4860       Inst.eraseFromParent();
4861       continue;
4862 
4863     case AMDGPU::S_NAND_B32:
4864       splitScalarNotBinop(Worklist, Inst, AMDGPU::S_AND_B32);
4865       Inst.eraseFromParent();
4866       continue;
4867 
4868     case AMDGPU::S_NOR_B32:
4869       splitScalarNotBinop(Worklist, Inst, AMDGPU::S_OR_B32);
4870       Inst.eraseFromParent();
4871       continue;
4872 
4873     case AMDGPU::S_ANDN2_B32:
4874       splitScalarBinOpN2(Worklist, Inst, AMDGPU::S_AND_B32);
4875       Inst.eraseFromParent();
4876       continue;
4877 
4878     case AMDGPU::S_ORN2_B32:
4879       splitScalarBinOpN2(Worklist, Inst, AMDGPU::S_OR_B32);
4880       Inst.eraseFromParent();
4881       continue;
4882     }
4883 
4884     if (NewOpcode == AMDGPU::INSTRUCTION_LIST_END) {
4885       // We cannot move this instruction to the VALU, so we should try to
4886       // legalize its operands instead.
4887       legalizeOperands(Inst, MDT);
4888       continue;
4889     }
4890 
4891     // Use the new VALU Opcode.
4892     const MCInstrDesc &NewDesc = get(NewOpcode);
4893     Inst.setDesc(NewDesc);
4894 
4895     // Remove any references to SCC. Vector instructions can't read from it, and
4896     // We're just about to add the implicit use / defs of VCC, and we don't want
4897     // both.
4898     for (unsigned i = Inst.getNumOperands() - 1; i > 0; --i) {
4899       MachineOperand &Op = Inst.getOperand(i);
4900       if (Op.isReg() && Op.getReg() == AMDGPU::SCC) {
4901         // Only propagate through live-def of SCC.
4902         if (Op.isDef() && !Op.isDead())
4903           addSCCDefUsersToVALUWorklist(Op, Inst, Worklist);
4904         Inst.RemoveOperand(i);
4905       }
4906     }
4907 
4908     if (Opcode == AMDGPU::S_SEXT_I32_I8 || Opcode == AMDGPU::S_SEXT_I32_I16) {
4909       // We are converting these to a BFE, so we need to add the missing
4910       // operands for the size and offset.
4911       unsigned Size = (Opcode == AMDGPU::S_SEXT_I32_I8) ? 8 : 16;
4912       Inst.addOperand(MachineOperand::CreateImm(0));
4913       Inst.addOperand(MachineOperand::CreateImm(Size));
4914 
4915     } else if (Opcode == AMDGPU::S_BCNT1_I32_B32) {
4916       // The VALU version adds the second operand to the result, so insert an
4917       // extra 0 operand.
4918       Inst.addOperand(MachineOperand::CreateImm(0));
4919     }
4920 
4921     Inst.addImplicitDefUseOperands(*Inst.getParent()->getParent());
4922     fixImplicitOperands(Inst);
4923 
4924     if (Opcode == AMDGPU::S_BFE_I32 || Opcode == AMDGPU::S_BFE_U32) {
4925       const MachineOperand &OffsetWidthOp = Inst.getOperand(2);
4926       // If we need to move this to VGPRs, we need to unpack the second operand
4927       // back into the 2 separate ones for bit offset and width.
4928       assert(OffsetWidthOp.isImm() &&
4929              "Scalar BFE is only implemented for constant width and offset");
4930       uint32_t Imm = OffsetWidthOp.getImm();
4931 
4932       uint32_t Offset = Imm & 0x3f; // Extract bits [5:0].
4933       uint32_t BitWidth = (Imm & 0x7f0000) >> 16; // Extract bits [22:16].
4934       Inst.RemoveOperand(2);                     // Remove old immediate.
4935       Inst.addOperand(MachineOperand::CreateImm(Offset));
4936       Inst.addOperand(MachineOperand::CreateImm(BitWidth));
4937     }
4938 
4939     bool HasDst = Inst.getOperand(0).isReg() && Inst.getOperand(0).isDef();
4940     unsigned NewDstReg = AMDGPU::NoRegister;
4941     if (HasDst) {
4942       unsigned DstReg = Inst.getOperand(0).getReg();
4943       if (Register::isPhysicalRegister(DstReg))
4944         continue;
4945 
4946       // Update the destination register class.
4947       const TargetRegisterClass *NewDstRC = getDestEquivalentVGPRClass(Inst);
4948       if (!NewDstRC)
4949         continue;
4950 
4951       if (Inst.isCopy() &&
4952           Register::isVirtualRegister(Inst.getOperand(1).getReg()) &&
4953           NewDstRC == RI.getRegClassForReg(MRI, Inst.getOperand(1).getReg())) {
4954         // Instead of creating a copy where src and dst are the same register
4955         // class, we just replace all uses of dst with src.  These kinds of
4956         // copies interfere with the heuristics MachineSink uses to decide
4957         // whether or not to split a critical edge.  Since the pass assumes
4958         // that copies will end up as machine instructions and not be
4959         // eliminated.
4960         addUsersToMoveToVALUWorklist(DstReg, MRI, Worklist);
4961         MRI.replaceRegWith(DstReg, Inst.getOperand(1).getReg());
4962         MRI.clearKillFlags(Inst.getOperand(1).getReg());
4963         Inst.getOperand(0).setReg(DstReg);
4964 
4965         // Make sure we don't leave around a dead VGPR->SGPR copy. Normally
4966         // these are deleted later, but at -O0 it would leave a suspicious
4967         // looking illegal copy of an undef register.
4968         for (unsigned I = Inst.getNumOperands() - 1; I != 0; --I)
4969           Inst.RemoveOperand(I);
4970         Inst.setDesc(get(AMDGPU::IMPLICIT_DEF));
4971         continue;
4972       }
4973 
4974       NewDstReg = MRI.createVirtualRegister(NewDstRC);
4975       MRI.replaceRegWith(DstReg, NewDstReg);
4976     }
4977 
4978     // Legalize the operands
4979     legalizeOperands(Inst, MDT);
4980 
4981     if (HasDst)
4982      addUsersToMoveToVALUWorklist(NewDstReg, MRI, Worklist);
4983   }
4984 }
4985 
4986 // Add/sub require special handling to deal with carry outs.
4987 bool SIInstrInfo::moveScalarAddSub(SetVectorType &Worklist, MachineInstr &Inst,
4988                                    MachineDominatorTree *MDT) const {
4989   if (ST.hasAddNoCarry()) {
4990     // Assume there is no user of scc since we don't select this in that case.
4991     // Since scc isn't used, it doesn't really matter if the i32 or u32 variant
4992     // is used.
4993 
4994     MachineBasicBlock &MBB = *Inst.getParent();
4995     MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4996 
4997     unsigned OldDstReg = Inst.getOperand(0).getReg();
4998     unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4999 
5000     unsigned Opc = Inst.getOpcode();
5001     assert(Opc == AMDGPU::S_ADD_I32 || Opc == AMDGPU::S_SUB_I32);
5002 
5003     unsigned NewOpc = Opc == AMDGPU::S_ADD_I32 ?
5004       AMDGPU::V_ADD_U32_e64 : AMDGPU::V_SUB_U32_e64;
5005 
5006     assert(Inst.getOperand(3).getReg() == AMDGPU::SCC);
5007     Inst.RemoveOperand(3);
5008 
5009     Inst.setDesc(get(NewOpc));
5010     Inst.addOperand(MachineOperand::CreateImm(0)); // clamp bit
5011     Inst.addImplicitDefUseOperands(*MBB.getParent());
5012     MRI.replaceRegWith(OldDstReg, ResultReg);
5013     legalizeOperands(Inst, MDT);
5014 
5015     addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
5016     return true;
5017   }
5018 
5019   return false;
5020 }
5021 
5022 void SIInstrInfo::lowerScalarAbs(SetVectorType &Worklist,
5023                                  MachineInstr &Inst) const {
5024   MachineBasicBlock &MBB = *Inst.getParent();
5025   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
5026   MachineBasicBlock::iterator MII = Inst;
5027   DebugLoc DL = Inst.getDebugLoc();
5028 
5029   MachineOperand &Dest = Inst.getOperand(0);
5030   MachineOperand &Src = Inst.getOperand(1);
5031   unsigned TmpReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5032   unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5033 
5034   unsigned SubOp = ST.hasAddNoCarry() ?
5035     AMDGPU::V_SUB_U32_e32 : AMDGPU::V_SUB_I32_e32;
5036 
5037   BuildMI(MBB, MII, DL, get(SubOp), TmpReg)
5038     .addImm(0)
5039     .addReg(Src.getReg());
5040 
5041   BuildMI(MBB, MII, DL, get(AMDGPU::V_MAX_I32_e64), ResultReg)
5042     .addReg(Src.getReg())
5043     .addReg(TmpReg);
5044 
5045   MRI.replaceRegWith(Dest.getReg(), ResultReg);
5046   addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
5047 }
5048 
5049 void SIInstrInfo::lowerScalarXnor(SetVectorType &Worklist,
5050                                   MachineInstr &Inst) const {
5051   MachineBasicBlock &MBB = *Inst.getParent();
5052   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
5053   MachineBasicBlock::iterator MII = Inst;
5054   const DebugLoc &DL = Inst.getDebugLoc();
5055 
5056   MachineOperand &Dest = Inst.getOperand(0);
5057   MachineOperand &Src0 = Inst.getOperand(1);
5058   MachineOperand &Src1 = Inst.getOperand(2);
5059 
5060   if (ST.hasDLInsts()) {
5061     unsigned NewDest = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5062     legalizeGenericOperand(MBB, MII, &AMDGPU::VGPR_32RegClass, Src0, MRI, DL);
5063     legalizeGenericOperand(MBB, MII, &AMDGPU::VGPR_32RegClass, Src1, MRI, DL);
5064 
5065     BuildMI(MBB, MII, DL, get(AMDGPU::V_XNOR_B32_e64), NewDest)
5066       .add(Src0)
5067       .add(Src1);
5068 
5069     MRI.replaceRegWith(Dest.getReg(), NewDest);
5070     addUsersToMoveToVALUWorklist(NewDest, MRI, Worklist);
5071   } else {
5072     // Using the identity !(x ^ y) == (!x ^ y) == (x ^ !y), we can
5073     // invert either source and then perform the XOR. If either source is a
5074     // scalar register, then we can leave the inversion on the scalar unit to
5075     // acheive a better distrubution of scalar and vector instructions.
5076     bool Src0IsSGPR = Src0.isReg() &&
5077                       RI.isSGPRClass(MRI.getRegClass(Src0.getReg()));
5078     bool Src1IsSGPR = Src1.isReg() &&
5079                       RI.isSGPRClass(MRI.getRegClass(Src1.getReg()));
5080     MachineInstr *Xor;
5081     unsigned Temp = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
5082     unsigned NewDest = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
5083 
5084     // Build a pair of scalar instructions and add them to the work list.
5085     // The next iteration over the work list will lower these to the vector
5086     // unit as necessary.
5087     if (Src0IsSGPR) {
5088       BuildMI(MBB, MII, DL, get(AMDGPU::S_NOT_B32), Temp).add(Src0);
5089       Xor = BuildMI(MBB, MII, DL, get(AMDGPU::S_XOR_B32), NewDest)
5090       .addReg(Temp)
5091       .add(Src1);
5092     } else if (Src1IsSGPR) {
5093       BuildMI(MBB, MII, DL, get(AMDGPU::S_NOT_B32), Temp).add(Src1);
5094       Xor = BuildMI(MBB, MII, DL, get(AMDGPU::S_XOR_B32), NewDest)
5095       .add(Src0)
5096       .addReg(Temp);
5097     } else {
5098       Xor = BuildMI(MBB, MII, DL, get(AMDGPU::S_XOR_B32), Temp)
5099         .add(Src0)
5100         .add(Src1);
5101       MachineInstr *Not =
5102           BuildMI(MBB, MII, DL, get(AMDGPU::S_NOT_B32), NewDest).addReg(Temp);
5103       Worklist.insert(Not);
5104     }
5105 
5106     MRI.replaceRegWith(Dest.getReg(), NewDest);
5107 
5108     Worklist.insert(Xor);
5109 
5110     addUsersToMoveToVALUWorklist(NewDest, MRI, Worklist);
5111   }
5112 }
5113 
5114 void SIInstrInfo::splitScalarNotBinop(SetVectorType &Worklist,
5115                                       MachineInstr &Inst,
5116                                       unsigned Opcode) const {
5117   MachineBasicBlock &MBB = *Inst.getParent();
5118   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
5119   MachineBasicBlock::iterator MII = Inst;
5120   const DebugLoc &DL = Inst.getDebugLoc();
5121 
5122   MachineOperand &Dest = Inst.getOperand(0);
5123   MachineOperand &Src0 = Inst.getOperand(1);
5124   MachineOperand &Src1 = Inst.getOperand(2);
5125 
5126   unsigned NewDest = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
5127   unsigned Interm = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
5128 
5129   MachineInstr &Op = *BuildMI(MBB, MII, DL, get(Opcode), Interm)
5130     .add(Src0)
5131     .add(Src1);
5132 
5133   MachineInstr &Not = *BuildMI(MBB, MII, DL, get(AMDGPU::S_NOT_B32), NewDest)
5134     .addReg(Interm);
5135 
5136   Worklist.insert(&Op);
5137   Worklist.insert(&Not);
5138 
5139   MRI.replaceRegWith(Dest.getReg(), NewDest);
5140   addUsersToMoveToVALUWorklist(NewDest, MRI, Worklist);
5141 }
5142 
5143 void SIInstrInfo::splitScalarBinOpN2(SetVectorType& Worklist,
5144                                      MachineInstr &Inst,
5145                                      unsigned Opcode) const {
5146   MachineBasicBlock &MBB = *Inst.getParent();
5147   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
5148   MachineBasicBlock::iterator MII = Inst;
5149   const DebugLoc &DL = Inst.getDebugLoc();
5150 
5151   MachineOperand &Dest = Inst.getOperand(0);
5152   MachineOperand &Src0 = Inst.getOperand(1);
5153   MachineOperand &Src1 = Inst.getOperand(2);
5154 
5155   unsigned NewDest = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
5156   unsigned Interm = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
5157 
5158   MachineInstr &Not = *BuildMI(MBB, MII, DL, get(AMDGPU::S_NOT_B32), Interm)
5159     .add(Src1);
5160 
5161   MachineInstr &Op = *BuildMI(MBB, MII, DL, get(Opcode), NewDest)
5162     .add(Src0)
5163     .addReg(Interm);
5164 
5165   Worklist.insert(&Not);
5166   Worklist.insert(&Op);
5167 
5168   MRI.replaceRegWith(Dest.getReg(), NewDest);
5169   addUsersToMoveToVALUWorklist(NewDest, MRI, Worklist);
5170 }
5171 
5172 void SIInstrInfo::splitScalar64BitUnaryOp(
5173     SetVectorType &Worklist, MachineInstr &Inst,
5174     unsigned Opcode) const {
5175   MachineBasicBlock &MBB = *Inst.getParent();
5176   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
5177 
5178   MachineOperand &Dest = Inst.getOperand(0);
5179   MachineOperand &Src0 = Inst.getOperand(1);
5180   DebugLoc DL = Inst.getDebugLoc();
5181 
5182   MachineBasicBlock::iterator MII = Inst;
5183 
5184   const MCInstrDesc &InstDesc = get(Opcode);
5185   const TargetRegisterClass *Src0RC = Src0.isReg() ?
5186     MRI.getRegClass(Src0.getReg()) :
5187     &AMDGPU::SGPR_32RegClass;
5188 
5189   const TargetRegisterClass *Src0SubRC = RI.getSubRegClass(Src0RC, AMDGPU::sub0);
5190 
5191   MachineOperand SrcReg0Sub0 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
5192                                                        AMDGPU::sub0, Src0SubRC);
5193 
5194   const TargetRegisterClass *DestRC = MRI.getRegClass(Dest.getReg());
5195   const TargetRegisterClass *NewDestRC = RI.getEquivalentVGPRClass(DestRC);
5196   const TargetRegisterClass *NewDestSubRC = RI.getSubRegClass(NewDestRC, AMDGPU::sub0);
5197 
5198   unsigned DestSub0 = MRI.createVirtualRegister(NewDestSubRC);
5199   MachineInstr &LoHalf = *BuildMI(MBB, MII, DL, InstDesc, DestSub0).add(SrcReg0Sub0);
5200 
5201   MachineOperand SrcReg0Sub1 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
5202                                                        AMDGPU::sub1, Src0SubRC);
5203 
5204   unsigned DestSub1 = MRI.createVirtualRegister(NewDestSubRC);
5205   MachineInstr &HiHalf = *BuildMI(MBB, MII, DL, InstDesc, DestSub1).add(SrcReg0Sub1);
5206 
5207   unsigned FullDestReg = MRI.createVirtualRegister(NewDestRC);
5208   BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), FullDestReg)
5209     .addReg(DestSub0)
5210     .addImm(AMDGPU::sub0)
5211     .addReg(DestSub1)
5212     .addImm(AMDGPU::sub1);
5213 
5214   MRI.replaceRegWith(Dest.getReg(), FullDestReg);
5215 
5216   Worklist.insert(&LoHalf);
5217   Worklist.insert(&HiHalf);
5218 
5219   // We don't need to legalizeOperands here because for a single operand, src0
5220   // will support any kind of input.
5221 
5222   // Move all users of this moved value.
5223   addUsersToMoveToVALUWorklist(FullDestReg, MRI, Worklist);
5224 }
5225 
5226 void SIInstrInfo::splitScalar64BitAddSub(SetVectorType &Worklist,
5227                                          MachineInstr &Inst,
5228                                          MachineDominatorTree *MDT) const {
5229   bool IsAdd = (Inst.getOpcode() == AMDGPU::S_ADD_U64_PSEUDO);
5230 
5231   MachineBasicBlock &MBB = *Inst.getParent();
5232   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
5233   const auto *CarryRC = RI.getRegClass(AMDGPU::SReg_1_XEXECRegClassID);
5234 
5235   unsigned FullDestReg = MRI.createVirtualRegister(&AMDGPU::VReg_64RegClass);
5236   unsigned DestSub0 = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5237   unsigned DestSub1 = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5238 
5239   unsigned CarryReg = MRI.createVirtualRegister(CarryRC);
5240   unsigned DeadCarryReg = MRI.createVirtualRegister(CarryRC);
5241 
5242   MachineOperand &Dest = Inst.getOperand(0);
5243   MachineOperand &Src0 = Inst.getOperand(1);
5244   MachineOperand &Src1 = Inst.getOperand(2);
5245   const DebugLoc &DL = Inst.getDebugLoc();
5246   MachineBasicBlock::iterator MII = Inst;
5247 
5248   const TargetRegisterClass *Src0RC = MRI.getRegClass(Src0.getReg());
5249   const TargetRegisterClass *Src1RC = MRI.getRegClass(Src1.getReg());
5250   const TargetRegisterClass *Src0SubRC = RI.getSubRegClass(Src0RC, AMDGPU::sub0);
5251   const TargetRegisterClass *Src1SubRC = RI.getSubRegClass(Src1RC, AMDGPU::sub0);
5252 
5253   MachineOperand SrcReg0Sub0 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
5254                                                        AMDGPU::sub0, Src0SubRC);
5255   MachineOperand SrcReg1Sub0 = buildExtractSubRegOrImm(MII, MRI, Src1, Src1RC,
5256                                                        AMDGPU::sub0, Src1SubRC);
5257 
5258 
5259   MachineOperand SrcReg0Sub1 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
5260                                                        AMDGPU::sub1, Src0SubRC);
5261   MachineOperand SrcReg1Sub1 = buildExtractSubRegOrImm(MII, MRI, Src1, Src1RC,
5262                                                        AMDGPU::sub1, Src1SubRC);
5263 
5264   unsigned LoOpc = IsAdd ? AMDGPU::V_ADD_I32_e64 : AMDGPU::V_SUB_I32_e64;
5265   MachineInstr *LoHalf =
5266     BuildMI(MBB, MII, DL, get(LoOpc), DestSub0)
5267     .addReg(CarryReg, RegState::Define)
5268     .add(SrcReg0Sub0)
5269     .add(SrcReg1Sub0)
5270     .addImm(0); // clamp bit
5271 
5272   unsigned HiOpc = IsAdd ? AMDGPU::V_ADDC_U32_e64 : AMDGPU::V_SUBB_U32_e64;
5273   MachineInstr *HiHalf =
5274     BuildMI(MBB, MII, DL, get(HiOpc), DestSub1)
5275     .addReg(DeadCarryReg, RegState::Define | RegState::Dead)
5276     .add(SrcReg0Sub1)
5277     .add(SrcReg1Sub1)
5278     .addReg(CarryReg, RegState::Kill)
5279     .addImm(0); // clamp bit
5280 
5281   BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), FullDestReg)
5282     .addReg(DestSub0)
5283     .addImm(AMDGPU::sub0)
5284     .addReg(DestSub1)
5285     .addImm(AMDGPU::sub1);
5286 
5287   MRI.replaceRegWith(Dest.getReg(), FullDestReg);
5288 
5289   // Try to legalize the operands in case we need to swap the order to keep it
5290   // valid.
5291   legalizeOperands(*LoHalf, MDT);
5292   legalizeOperands(*HiHalf, MDT);
5293 
5294   // Move all users of this moved vlaue.
5295   addUsersToMoveToVALUWorklist(FullDestReg, MRI, Worklist);
5296 }
5297 
5298 void SIInstrInfo::splitScalar64BitBinaryOp(SetVectorType &Worklist,
5299                                            MachineInstr &Inst, unsigned Opcode,
5300                                            MachineDominatorTree *MDT) const {
5301   MachineBasicBlock &MBB = *Inst.getParent();
5302   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
5303 
5304   MachineOperand &Dest = Inst.getOperand(0);
5305   MachineOperand &Src0 = Inst.getOperand(1);
5306   MachineOperand &Src1 = Inst.getOperand(2);
5307   DebugLoc DL = Inst.getDebugLoc();
5308 
5309   MachineBasicBlock::iterator MII = Inst;
5310 
5311   const MCInstrDesc &InstDesc = get(Opcode);
5312   const TargetRegisterClass *Src0RC = Src0.isReg() ?
5313     MRI.getRegClass(Src0.getReg()) :
5314     &AMDGPU::SGPR_32RegClass;
5315 
5316   const TargetRegisterClass *Src0SubRC = RI.getSubRegClass(Src0RC, AMDGPU::sub0);
5317   const TargetRegisterClass *Src1RC = Src1.isReg() ?
5318     MRI.getRegClass(Src1.getReg()) :
5319     &AMDGPU::SGPR_32RegClass;
5320 
5321   const TargetRegisterClass *Src1SubRC = RI.getSubRegClass(Src1RC, AMDGPU::sub0);
5322 
5323   MachineOperand SrcReg0Sub0 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
5324                                                        AMDGPU::sub0, Src0SubRC);
5325   MachineOperand SrcReg1Sub0 = buildExtractSubRegOrImm(MII, MRI, Src1, Src1RC,
5326                                                        AMDGPU::sub0, Src1SubRC);
5327   MachineOperand SrcReg0Sub1 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
5328                                                        AMDGPU::sub1, Src0SubRC);
5329   MachineOperand SrcReg1Sub1 = buildExtractSubRegOrImm(MII, MRI, Src1, Src1RC,
5330                                                        AMDGPU::sub1, Src1SubRC);
5331 
5332   const TargetRegisterClass *DestRC = MRI.getRegClass(Dest.getReg());
5333   const TargetRegisterClass *NewDestRC = RI.getEquivalentVGPRClass(DestRC);
5334   const TargetRegisterClass *NewDestSubRC = RI.getSubRegClass(NewDestRC, AMDGPU::sub0);
5335 
5336   unsigned DestSub0 = MRI.createVirtualRegister(NewDestSubRC);
5337   MachineInstr &LoHalf = *BuildMI(MBB, MII, DL, InstDesc, DestSub0)
5338                               .add(SrcReg0Sub0)
5339                               .add(SrcReg1Sub0);
5340 
5341   unsigned DestSub1 = MRI.createVirtualRegister(NewDestSubRC);
5342   MachineInstr &HiHalf = *BuildMI(MBB, MII, DL, InstDesc, DestSub1)
5343                               .add(SrcReg0Sub1)
5344                               .add(SrcReg1Sub1);
5345 
5346   unsigned FullDestReg = MRI.createVirtualRegister(NewDestRC);
5347   BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), FullDestReg)
5348     .addReg(DestSub0)
5349     .addImm(AMDGPU::sub0)
5350     .addReg(DestSub1)
5351     .addImm(AMDGPU::sub1);
5352 
5353   MRI.replaceRegWith(Dest.getReg(), FullDestReg);
5354 
5355   Worklist.insert(&LoHalf);
5356   Worklist.insert(&HiHalf);
5357 
5358   // Move all users of this moved vlaue.
5359   addUsersToMoveToVALUWorklist(FullDestReg, MRI, Worklist);
5360 }
5361 
5362 void SIInstrInfo::splitScalar64BitXnor(SetVectorType &Worklist,
5363                                        MachineInstr &Inst,
5364                                        MachineDominatorTree *MDT) const {
5365   MachineBasicBlock &MBB = *Inst.getParent();
5366   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
5367 
5368   MachineOperand &Dest = Inst.getOperand(0);
5369   MachineOperand &Src0 = Inst.getOperand(1);
5370   MachineOperand &Src1 = Inst.getOperand(2);
5371   const DebugLoc &DL = Inst.getDebugLoc();
5372 
5373   MachineBasicBlock::iterator MII = Inst;
5374 
5375   const TargetRegisterClass *DestRC = MRI.getRegClass(Dest.getReg());
5376 
5377   unsigned Interm = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
5378 
5379   MachineOperand* Op0;
5380   MachineOperand* Op1;
5381 
5382   if (Src0.isReg() && RI.isSGPRReg(MRI, Src0.getReg())) {
5383     Op0 = &Src0;
5384     Op1 = &Src1;
5385   } else {
5386     Op0 = &Src1;
5387     Op1 = &Src0;
5388   }
5389 
5390   BuildMI(MBB, MII, DL, get(AMDGPU::S_NOT_B64), Interm)
5391     .add(*Op0);
5392 
5393   unsigned NewDest = MRI.createVirtualRegister(DestRC);
5394 
5395   MachineInstr &Xor = *BuildMI(MBB, MII, DL, get(AMDGPU::S_XOR_B64), NewDest)
5396     .addReg(Interm)
5397     .add(*Op1);
5398 
5399   MRI.replaceRegWith(Dest.getReg(), NewDest);
5400 
5401   Worklist.insert(&Xor);
5402 }
5403 
5404 void SIInstrInfo::splitScalar64BitBCNT(
5405     SetVectorType &Worklist, MachineInstr &Inst) const {
5406   MachineBasicBlock &MBB = *Inst.getParent();
5407   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
5408 
5409   MachineBasicBlock::iterator MII = Inst;
5410   const DebugLoc &DL = Inst.getDebugLoc();
5411 
5412   MachineOperand &Dest = Inst.getOperand(0);
5413   MachineOperand &Src = Inst.getOperand(1);
5414 
5415   const MCInstrDesc &InstDesc = get(AMDGPU::V_BCNT_U32_B32_e64);
5416   const TargetRegisterClass *SrcRC = Src.isReg() ?
5417     MRI.getRegClass(Src.getReg()) :
5418     &AMDGPU::SGPR_32RegClass;
5419 
5420   unsigned MidReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5421   unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5422 
5423   const TargetRegisterClass *SrcSubRC = RI.getSubRegClass(SrcRC, AMDGPU::sub0);
5424 
5425   MachineOperand SrcRegSub0 = buildExtractSubRegOrImm(MII, MRI, Src, SrcRC,
5426                                                       AMDGPU::sub0, SrcSubRC);
5427   MachineOperand SrcRegSub1 = buildExtractSubRegOrImm(MII, MRI, Src, SrcRC,
5428                                                       AMDGPU::sub1, SrcSubRC);
5429 
5430   BuildMI(MBB, MII, DL, InstDesc, MidReg).add(SrcRegSub0).addImm(0);
5431 
5432   BuildMI(MBB, MII, DL, InstDesc, ResultReg).add(SrcRegSub1).addReg(MidReg);
5433 
5434   MRI.replaceRegWith(Dest.getReg(), ResultReg);
5435 
5436   // We don't need to legalize operands here. src0 for etiher instruction can be
5437   // an SGPR, and the second input is unused or determined here.
5438   addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
5439 }
5440 
5441 void SIInstrInfo::splitScalar64BitBFE(SetVectorType &Worklist,
5442                                       MachineInstr &Inst) const {
5443   MachineBasicBlock &MBB = *Inst.getParent();
5444   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
5445   MachineBasicBlock::iterator MII = Inst;
5446   const DebugLoc &DL = Inst.getDebugLoc();
5447 
5448   MachineOperand &Dest = Inst.getOperand(0);
5449   uint32_t Imm = Inst.getOperand(2).getImm();
5450   uint32_t Offset = Imm & 0x3f; // Extract bits [5:0].
5451   uint32_t BitWidth = (Imm & 0x7f0000) >> 16; // Extract bits [22:16].
5452 
5453   (void) Offset;
5454 
5455   // Only sext_inreg cases handled.
5456   assert(Inst.getOpcode() == AMDGPU::S_BFE_I64 && BitWidth <= 32 &&
5457          Offset == 0 && "Not implemented");
5458 
5459   if (BitWidth < 32) {
5460     unsigned MidRegLo = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5461     unsigned MidRegHi = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5462     unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VReg_64RegClass);
5463 
5464     BuildMI(MBB, MII, DL, get(AMDGPU::V_BFE_I32), MidRegLo)
5465         .addReg(Inst.getOperand(1).getReg(), 0, AMDGPU::sub0)
5466         .addImm(0)
5467         .addImm(BitWidth);
5468 
5469     BuildMI(MBB, MII, DL, get(AMDGPU::V_ASHRREV_I32_e32), MidRegHi)
5470       .addImm(31)
5471       .addReg(MidRegLo);
5472 
5473     BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), ResultReg)
5474       .addReg(MidRegLo)
5475       .addImm(AMDGPU::sub0)
5476       .addReg(MidRegHi)
5477       .addImm(AMDGPU::sub1);
5478 
5479     MRI.replaceRegWith(Dest.getReg(), ResultReg);
5480     addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
5481     return;
5482   }
5483 
5484   MachineOperand &Src = Inst.getOperand(1);
5485   unsigned TmpReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5486   unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VReg_64RegClass);
5487 
5488   BuildMI(MBB, MII, DL, get(AMDGPU::V_ASHRREV_I32_e64), TmpReg)
5489     .addImm(31)
5490     .addReg(Src.getReg(), 0, AMDGPU::sub0);
5491 
5492   BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), ResultReg)
5493     .addReg(Src.getReg(), 0, AMDGPU::sub0)
5494     .addImm(AMDGPU::sub0)
5495     .addReg(TmpReg)
5496     .addImm(AMDGPU::sub1);
5497 
5498   MRI.replaceRegWith(Dest.getReg(), ResultReg);
5499   addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
5500 }
5501 
5502 void SIInstrInfo::addUsersToMoveToVALUWorklist(
5503   unsigned DstReg,
5504   MachineRegisterInfo &MRI,
5505   SetVectorType &Worklist) const {
5506   for (MachineRegisterInfo::use_iterator I = MRI.use_begin(DstReg),
5507          E = MRI.use_end(); I != E;) {
5508     MachineInstr &UseMI = *I->getParent();
5509 
5510     unsigned OpNo = 0;
5511 
5512     switch (UseMI.getOpcode()) {
5513     case AMDGPU::COPY:
5514     case AMDGPU::WQM:
5515     case AMDGPU::SOFT_WQM:
5516     case AMDGPU::WWM:
5517     case AMDGPU::REG_SEQUENCE:
5518     case AMDGPU::PHI:
5519     case AMDGPU::INSERT_SUBREG:
5520       break;
5521     default:
5522       OpNo = I.getOperandNo();
5523       break;
5524     }
5525 
5526     if (!RI.hasVectorRegisters(getOpRegClass(UseMI, OpNo))) {
5527       Worklist.insert(&UseMI);
5528 
5529       do {
5530         ++I;
5531       } while (I != E && I->getParent() == &UseMI);
5532     } else {
5533       ++I;
5534     }
5535   }
5536 }
5537 
5538 void SIInstrInfo::movePackToVALU(SetVectorType &Worklist,
5539                                  MachineRegisterInfo &MRI,
5540                                  MachineInstr &Inst) const {
5541   unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5542   MachineBasicBlock *MBB = Inst.getParent();
5543   MachineOperand &Src0 = Inst.getOperand(1);
5544   MachineOperand &Src1 = Inst.getOperand(2);
5545   const DebugLoc &DL = Inst.getDebugLoc();
5546 
5547   switch (Inst.getOpcode()) {
5548   case AMDGPU::S_PACK_LL_B32_B16: {
5549     unsigned ImmReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5550     unsigned TmpReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5551 
5552     // FIXME: Can do a lot better if we know the high bits of src0 or src1 are
5553     // 0.
5554     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_MOV_B32_e32), ImmReg)
5555       .addImm(0xffff);
5556 
5557     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_AND_B32_e64), TmpReg)
5558       .addReg(ImmReg, RegState::Kill)
5559       .add(Src0);
5560 
5561     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_LSHL_OR_B32), ResultReg)
5562       .add(Src1)
5563       .addImm(16)
5564       .addReg(TmpReg, RegState::Kill);
5565     break;
5566   }
5567   case AMDGPU::S_PACK_LH_B32_B16: {
5568     unsigned ImmReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5569     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_MOV_B32_e32), ImmReg)
5570       .addImm(0xffff);
5571     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_BFI_B32), ResultReg)
5572       .addReg(ImmReg, RegState::Kill)
5573       .add(Src0)
5574       .add(Src1);
5575     break;
5576   }
5577   case AMDGPU::S_PACK_HH_B32_B16: {
5578     unsigned ImmReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5579     unsigned TmpReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5580     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_LSHRREV_B32_e64), TmpReg)
5581       .addImm(16)
5582       .add(Src0);
5583     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_MOV_B32_e32), ImmReg)
5584       .addImm(0xffff0000);
5585     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_AND_OR_B32), ResultReg)
5586       .add(Src1)
5587       .addReg(ImmReg, RegState::Kill)
5588       .addReg(TmpReg, RegState::Kill);
5589     break;
5590   }
5591   default:
5592     llvm_unreachable("unhandled s_pack_* instruction");
5593   }
5594 
5595   MachineOperand &Dest = Inst.getOperand(0);
5596   MRI.replaceRegWith(Dest.getReg(), ResultReg);
5597   addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
5598 }
5599 
5600 void SIInstrInfo::addSCCDefUsersToVALUWorklist(MachineOperand &Op,
5601                                                MachineInstr &SCCDefInst,
5602                                                SetVectorType &Worklist) const {
5603   // Ensure that def inst defines SCC, which is still live.
5604   assert(Op.isReg() && Op.getReg() == AMDGPU::SCC && Op.isDef() &&
5605          !Op.isDead() && Op.getParent() == &SCCDefInst);
5606   // This assumes that all the users of SCC are in the same block
5607   // as the SCC def.
5608   for (MachineInstr &MI : // Skip the def inst itself.
5609        make_range(std::next(MachineBasicBlock::iterator(SCCDefInst)),
5610                   SCCDefInst.getParent()->end())) {
5611     // Check if SCC is used first.
5612     if (MI.findRegisterUseOperandIdx(AMDGPU::SCC, false, &RI) != -1)
5613       Worklist.insert(&MI);
5614     // Exit if we find another SCC def.
5615     if (MI.findRegisterDefOperandIdx(AMDGPU::SCC, false, false, &RI) != -1)
5616       return;
5617   }
5618 }
5619 
5620 const TargetRegisterClass *SIInstrInfo::getDestEquivalentVGPRClass(
5621   const MachineInstr &Inst) const {
5622   const TargetRegisterClass *NewDstRC = getOpRegClass(Inst, 0);
5623 
5624   switch (Inst.getOpcode()) {
5625   // For target instructions, getOpRegClass just returns the virtual register
5626   // class associated with the operand, so we need to find an equivalent VGPR
5627   // register class in order to move the instruction to the VALU.
5628   case AMDGPU::COPY:
5629   case AMDGPU::PHI:
5630   case AMDGPU::REG_SEQUENCE:
5631   case AMDGPU::INSERT_SUBREG:
5632   case AMDGPU::WQM:
5633   case AMDGPU::SOFT_WQM:
5634   case AMDGPU::WWM: {
5635     const TargetRegisterClass *SrcRC = getOpRegClass(Inst, 1);
5636     if (RI.hasAGPRs(SrcRC)) {
5637       if (RI.hasAGPRs(NewDstRC))
5638         return nullptr;
5639 
5640       NewDstRC = RI.getEquivalentAGPRClass(NewDstRC);
5641       if (!NewDstRC)
5642         return nullptr;
5643     } else {
5644        if (RI.hasVGPRs(NewDstRC))
5645         return nullptr;
5646 
5647       NewDstRC = RI.getEquivalentVGPRClass(NewDstRC);
5648       if (!NewDstRC)
5649         return nullptr;
5650     }
5651 
5652     return NewDstRC;
5653   }
5654   default:
5655     return NewDstRC;
5656   }
5657 }
5658 
5659 // Find the one SGPR operand we are allowed to use.
5660 unsigned SIInstrInfo::findUsedSGPR(const MachineInstr &MI,
5661                                    int OpIndices[3]) const {
5662   const MCInstrDesc &Desc = MI.getDesc();
5663 
5664   // Find the one SGPR operand we are allowed to use.
5665   //
5666   // First we need to consider the instruction's operand requirements before
5667   // legalizing. Some operands are required to be SGPRs, such as implicit uses
5668   // of VCC, but we are still bound by the constant bus requirement to only use
5669   // one.
5670   //
5671   // If the operand's class is an SGPR, we can never move it.
5672 
5673   unsigned SGPRReg = findImplicitSGPRRead(MI);
5674   if (SGPRReg != AMDGPU::NoRegister)
5675     return SGPRReg;
5676 
5677   unsigned UsedSGPRs[3] = { AMDGPU::NoRegister };
5678   const MachineRegisterInfo &MRI = MI.getParent()->getParent()->getRegInfo();
5679 
5680   for (unsigned i = 0; i < 3; ++i) {
5681     int Idx = OpIndices[i];
5682     if (Idx == -1)
5683       break;
5684 
5685     const MachineOperand &MO = MI.getOperand(Idx);
5686     if (!MO.isReg())
5687       continue;
5688 
5689     // Is this operand statically required to be an SGPR based on the operand
5690     // constraints?
5691     const TargetRegisterClass *OpRC = RI.getRegClass(Desc.OpInfo[Idx].RegClass);
5692     bool IsRequiredSGPR = RI.isSGPRClass(OpRC);
5693     if (IsRequiredSGPR)
5694       return MO.getReg();
5695 
5696     // If this could be a VGPR or an SGPR, Check the dynamic register class.
5697     unsigned Reg = MO.getReg();
5698     const TargetRegisterClass *RegRC = MRI.getRegClass(Reg);
5699     if (RI.isSGPRClass(RegRC))
5700       UsedSGPRs[i] = Reg;
5701   }
5702 
5703   // We don't have a required SGPR operand, so we have a bit more freedom in
5704   // selecting operands to move.
5705 
5706   // Try to select the most used SGPR. If an SGPR is equal to one of the
5707   // others, we choose that.
5708   //
5709   // e.g.
5710   // V_FMA_F32 v0, s0, s0, s0 -> No moves
5711   // V_FMA_F32 v0, s0, s1, s0 -> Move s1
5712 
5713   // TODO: If some of the operands are 64-bit SGPRs and some 32, we should
5714   // prefer those.
5715 
5716   if (UsedSGPRs[0] != AMDGPU::NoRegister) {
5717     if (UsedSGPRs[0] == UsedSGPRs[1] || UsedSGPRs[0] == UsedSGPRs[2])
5718       SGPRReg = UsedSGPRs[0];
5719   }
5720 
5721   if (SGPRReg == AMDGPU::NoRegister && UsedSGPRs[1] != AMDGPU::NoRegister) {
5722     if (UsedSGPRs[1] == UsedSGPRs[2])
5723       SGPRReg = UsedSGPRs[1];
5724   }
5725 
5726   return SGPRReg;
5727 }
5728 
5729 MachineOperand *SIInstrInfo::getNamedOperand(MachineInstr &MI,
5730                                              unsigned OperandName) const {
5731   int Idx = AMDGPU::getNamedOperandIdx(MI.getOpcode(), OperandName);
5732   if (Idx == -1)
5733     return nullptr;
5734 
5735   return &MI.getOperand(Idx);
5736 }
5737 
5738 uint64_t SIInstrInfo::getDefaultRsrcDataFormat() const {
5739   if (ST.getGeneration() >= AMDGPUSubtarget::GFX10) {
5740     return (22ULL << 44) | // IMG_FORMAT_32_FLOAT
5741            (1ULL << 56) | // RESOURCE_LEVEL = 1
5742            (3ULL << 60); // OOB_SELECT = 3
5743   }
5744 
5745   uint64_t RsrcDataFormat = AMDGPU::RSRC_DATA_FORMAT;
5746   if (ST.isAmdHsaOS()) {
5747     // Set ATC = 1. GFX9 doesn't have this bit.
5748     if (ST.getGeneration() <= AMDGPUSubtarget::VOLCANIC_ISLANDS)
5749       RsrcDataFormat |= (1ULL << 56);
5750 
5751     // Set MTYPE = 2 (MTYPE_UC = uncached). GFX9 doesn't have this.
5752     // BTW, it disables TC L2 and therefore decreases performance.
5753     if (ST.getGeneration() == AMDGPUSubtarget::VOLCANIC_ISLANDS)
5754       RsrcDataFormat |= (2ULL << 59);
5755   }
5756 
5757   return RsrcDataFormat;
5758 }
5759 
5760 uint64_t SIInstrInfo::getScratchRsrcWords23() const {
5761   uint64_t Rsrc23 = getDefaultRsrcDataFormat() |
5762                     AMDGPU::RSRC_TID_ENABLE |
5763                     0xffffffff; // Size;
5764 
5765   // GFX9 doesn't have ELEMENT_SIZE.
5766   if (ST.getGeneration() <= AMDGPUSubtarget::VOLCANIC_ISLANDS) {
5767     uint64_t EltSizeValue = Log2_32(ST.getMaxPrivateElementSize()) - 1;
5768     Rsrc23 |= EltSizeValue << AMDGPU::RSRC_ELEMENT_SIZE_SHIFT;
5769   }
5770 
5771   // IndexStride = 64 / 32.
5772   uint64_t IndexStride = ST.getWavefrontSize() == 64 ? 3 : 2;
5773   Rsrc23 |= IndexStride << AMDGPU::RSRC_INDEX_STRIDE_SHIFT;
5774 
5775   // If TID_ENABLE is set, DATA_FORMAT specifies stride bits [14:17].
5776   // Clear them unless we want a huge stride.
5777   if (ST.getGeneration() >= AMDGPUSubtarget::VOLCANIC_ISLANDS &&
5778       ST.getGeneration() <= AMDGPUSubtarget::GFX9)
5779     Rsrc23 &= ~AMDGPU::RSRC_DATA_FORMAT;
5780 
5781   return Rsrc23;
5782 }
5783 
5784 bool SIInstrInfo::isLowLatencyInstruction(const MachineInstr &MI) const {
5785   unsigned Opc = MI.getOpcode();
5786 
5787   return isSMRD(Opc);
5788 }
5789 
5790 bool SIInstrInfo::isHighLatencyInstruction(const MachineInstr &MI) const {
5791   unsigned Opc = MI.getOpcode();
5792 
5793   return isMUBUF(Opc) || isMTBUF(Opc) || isMIMG(Opc);
5794 }
5795 
5796 unsigned SIInstrInfo::isStackAccess(const MachineInstr &MI,
5797                                     int &FrameIndex) const {
5798   const MachineOperand *Addr = getNamedOperand(MI, AMDGPU::OpName::vaddr);
5799   if (!Addr || !Addr->isFI())
5800     return AMDGPU::NoRegister;
5801 
5802   assert(!MI.memoperands_empty() &&
5803          (*MI.memoperands_begin())->getAddrSpace() == AMDGPUAS::PRIVATE_ADDRESS);
5804 
5805   FrameIndex = Addr->getIndex();
5806   return getNamedOperand(MI, AMDGPU::OpName::vdata)->getReg();
5807 }
5808 
5809 unsigned SIInstrInfo::isSGPRStackAccess(const MachineInstr &MI,
5810                                         int &FrameIndex) const {
5811   const MachineOperand *Addr = getNamedOperand(MI, AMDGPU::OpName::addr);
5812   assert(Addr && Addr->isFI());
5813   FrameIndex = Addr->getIndex();
5814   return getNamedOperand(MI, AMDGPU::OpName::data)->getReg();
5815 }
5816 
5817 unsigned SIInstrInfo::isLoadFromStackSlot(const MachineInstr &MI,
5818                                           int &FrameIndex) const {
5819   if (!MI.mayLoad())
5820     return AMDGPU::NoRegister;
5821 
5822   if (isMUBUF(MI) || isVGPRSpill(MI))
5823     return isStackAccess(MI, FrameIndex);
5824 
5825   if (isSGPRSpill(MI))
5826     return isSGPRStackAccess(MI, FrameIndex);
5827 
5828   return AMDGPU::NoRegister;
5829 }
5830 
5831 unsigned SIInstrInfo::isStoreToStackSlot(const MachineInstr &MI,
5832                                          int &FrameIndex) const {
5833   if (!MI.mayStore())
5834     return AMDGPU::NoRegister;
5835 
5836   if (isMUBUF(MI) || isVGPRSpill(MI))
5837     return isStackAccess(MI, FrameIndex);
5838 
5839   if (isSGPRSpill(MI))
5840     return isSGPRStackAccess(MI, FrameIndex);
5841 
5842   return AMDGPU::NoRegister;
5843 }
5844 
5845 unsigned SIInstrInfo::getInstBundleSize(const MachineInstr &MI) const {
5846   unsigned Size = 0;
5847   MachineBasicBlock::const_instr_iterator I = MI.getIterator();
5848   MachineBasicBlock::const_instr_iterator E = MI.getParent()->instr_end();
5849   while (++I != E && I->isInsideBundle()) {
5850     assert(!I->isBundle() && "No nested bundle!");
5851     Size += getInstSizeInBytes(*I);
5852   }
5853 
5854   return Size;
5855 }
5856 
5857 unsigned SIInstrInfo::getInstSizeInBytes(const MachineInstr &MI) const {
5858   unsigned Opc = MI.getOpcode();
5859   const MCInstrDesc &Desc = getMCOpcodeFromPseudo(Opc);
5860   unsigned DescSize = Desc.getSize();
5861 
5862   // If we have a definitive size, we can use it. Otherwise we need to inspect
5863   // the operands to know the size.
5864   if (isFixedSize(MI))
5865     return DescSize;
5866 
5867   // 4-byte instructions may have a 32-bit literal encoded after them. Check
5868   // operands that coud ever be literals.
5869   if (isVALU(MI) || isSALU(MI)) {
5870     int Src0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0);
5871     if (Src0Idx == -1)
5872       return DescSize; // No operands.
5873 
5874     if (isLiteralConstantLike(MI.getOperand(Src0Idx), Desc.OpInfo[Src0Idx]))
5875       return isVOP3(MI) ? 12 : (DescSize + 4);
5876 
5877     int Src1Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1);
5878     if (Src1Idx == -1)
5879       return DescSize;
5880 
5881     if (isLiteralConstantLike(MI.getOperand(Src1Idx), Desc.OpInfo[Src1Idx]))
5882       return isVOP3(MI) ? 12 : (DescSize + 4);
5883 
5884     int Src2Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2);
5885     if (Src2Idx == -1)
5886       return DescSize;
5887 
5888     if (isLiteralConstantLike(MI.getOperand(Src2Idx), Desc.OpInfo[Src2Idx]))
5889       return isVOP3(MI) ? 12 : (DescSize + 4);
5890 
5891     return DescSize;
5892   }
5893 
5894   // Check whether we have extra NSA words.
5895   if (isMIMG(MI)) {
5896     int VAddr0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::vaddr0);
5897     if (VAddr0Idx < 0)
5898       return 8;
5899 
5900     int RSrcIdx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::srsrc);
5901     return 8 + 4 * ((RSrcIdx - VAddr0Idx + 2) / 4);
5902   }
5903 
5904   switch (Opc) {
5905   case TargetOpcode::IMPLICIT_DEF:
5906   case TargetOpcode::KILL:
5907   case TargetOpcode::DBG_VALUE:
5908   case TargetOpcode::EH_LABEL:
5909     return 0;
5910   case TargetOpcode::BUNDLE:
5911     return getInstBundleSize(MI);
5912   case TargetOpcode::INLINEASM:
5913   case TargetOpcode::INLINEASM_BR: {
5914     const MachineFunction *MF = MI.getParent()->getParent();
5915     const char *AsmStr = MI.getOperand(0).getSymbolName();
5916     return getInlineAsmLength(AsmStr, *MF->getTarget().getMCAsmInfo(),
5917                               &MF->getSubtarget());
5918   }
5919   default:
5920     return DescSize;
5921   }
5922 }
5923 
5924 bool SIInstrInfo::mayAccessFlatAddressSpace(const MachineInstr &MI) const {
5925   if (!isFLAT(MI))
5926     return false;
5927 
5928   if (MI.memoperands_empty())
5929     return true;
5930 
5931   for (const MachineMemOperand *MMO : MI.memoperands()) {
5932     if (MMO->getAddrSpace() == AMDGPUAS::FLAT_ADDRESS)
5933       return true;
5934   }
5935   return false;
5936 }
5937 
5938 bool SIInstrInfo::isNonUniformBranchInstr(MachineInstr &Branch) const {
5939   return Branch.getOpcode() == AMDGPU::SI_NON_UNIFORM_BRCOND_PSEUDO;
5940 }
5941 
5942 void SIInstrInfo::convertNonUniformIfRegion(MachineBasicBlock *IfEntry,
5943                                             MachineBasicBlock *IfEnd) const {
5944   MachineBasicBlock::iterator TI = IfEntry->getFirstTerminator();
5945   assert(TI != IfEntry->end());
5946 
5947   MachineInstr *Branch = &(*TI);
5948   MachineFunction *MF = IfEntry->getParent();
5949   MachineRegisterInfo &MRI = IfEntry->getParent()->getRegInfo();
5950 
5951   if (Branch->getOpcode() == AMDGPU::SI_NON_UNIFORM_BRCOND_PSEUDO) {
5952     unsigned DstReg = MRI.createVirtualRegister(RI.getBoolRC());
5953     MachineInstr *SIIF =
5954         BuildMI(*MF, Branch->getDebugLoc(), get(AMDGPU::SI_IF), DstReg)
5955             .add(Branch->getOperand(0))
5956             .add(Branch->getOperand(1));
5957     MachineInstr *SIEND =
5958         BuildMI(*MF, Branch->getDebugLoc(), get(AMDGPU::SI_END_CF))
5959             .addReg(DstReg);
5960 
5961     IfEntry->erase(TI);
5962     IfEntry->insert(IfEntry->end(), SIIF);
5963     IfEnd->insert(IfEnd->getFirstNonPHI(), SIEND);
5964   }
5965 }
5966 
5967 void SIInstrInfo::convertNonUniformLoopRegion(
5968     MachineBasicBlock *LoopEntry, MachineBasicBlock *LoopEnd) const {
5969   MachineBasicBlock::iterator TI = LoopEnd->getFirstTerminator();
5970   // We expect 2 terminators, one conditional and one unconditional.
5971   assert(TI != LoopEnd->end());
5972 
5973   MachineInstr *Branch = &(*TI);
5974   MachineFunction *MF = LoopEnd->getParent();
5975   MachineRegisterInfo &MRI = LoopEnd->getParent()->getRegInfo();
5976 
5977   if (Branch->getOpcode() == AMDGPU::SI_NON_UNIFORM_BRCOND_PSEUDO) {
5978 
5979     unsigned DstReg = MRI.createVirtualRegister(RI.getBoolRC());
5980     unsigned BackEdgeReg = MRI.createVirtualRegister(RI.getBoolRC());
5981     MachineInstrBuilder HeaderPHIBuilder =
5982         BuildMI(*(MF), Branch->getDebugLoc(), get(TargetOpcode::PHI), DstReg);
5983     for (MachineBasicBlock::pred_iterator PI = LoopEntry->pred_begin(),
5984                                           E = LoopEntry->pred_end();
5985          PI != E; ++PI) {
5986       if (*PI == LoopEnd) {
5987         HeaderPHIBuilder.addReg(BackEdgeReg);
5988       } else {
5989         MachineBasicBlock *PMBB = *PI;
5990         unsigned ZeroReg = MRI.createVirtualRegister(RI.getBoolRC());
5991         materializeImmediate(*PMBB, PMBB->getFirstTerminator(), DebugLoc(),
5992                              ZeroReg, 0);
5993         HeaderPHIBuilder.addReg(ZeroReg);
5994       }
5995       HeaderPHIBuilder.addMBB(*PI);
5996     }
5997     MachineInstr *HeaderPhi = HeaderPHIBuilder;
5998     MachineInstr *SIIFBREAK = BuildMI(*(MF), Branch->getDebugLoc(),
5999                                       get(AMDGPU::SI_IF_BREAK), BackEdgeReg)
6000                                   .addReg(DstReg)
6001                                   .add(Branch->getOperand(0));
6002     MachineInstr *SILOOP =
6003         BuildMI(*(MF), Branch->getDebugLoc(), get(AMDGPU::SI_LOOP))
6004             .addReg(BackEdgeReg)
6005             .addMBB(LoopEntry);
6006 
6007     LoopEntry->insert(LoopEntry->begin(), HeaderPhi);
6008     LoopEnd->erase(TI);
6009     LoopEnd->insert(LoopEnd->end(), SIIFBREAK);
6010     LoopEnd->insert(LoopEnd->end(), SILOOP);
6011   }
6012 }
6013 
6014 ArrayRef<std::pair<int, const char *>>
6015 SIInstrInfo::getSerializableTargetIndices() const {
6016   static const std::pair<int, const char *> TargetIndices[] = {
6017       {AMDGPU::TI_CONSTDATA_START, "amdgpu-constdata-start"},
6018       {AMDGPU::TI_SCRATCH_RSRC_DWORD0, "amdgpu-scratch-rsrc-dword0"},
6019       {AMDGPU::TI_SCRATCH_RSRC_DWORD1, "amdgpu-scratch-rsrc-dword1"},
6020       {AMDGPU::TI_SCRATCH_RSRC_DWORD2, "amdgpu-scratch-rsrc-dword2"},
6021       {AMDGPU::TI_SCRATCH_RSRC_DWORD3, "amdgpu-scratch-rsrc-dword3"}};
6022   return makeArrayRef(TargetIndices);
6023 }
6024 
6025 /// This is used by the post-RA scheduler (SchedulePostRAList.cpp).  The
6026 /// post-RA version of misched uses CreateTargetMIHazardRecognizer.
6027 ScheduleHazardRecognizer *
6028 SIInstrInfo::CreateTargetPostRAHazardRecognizer(const InstrItineraryData *II,
6029                                             const ScheduleDAG *DAG) const {
6030   return new GCNHazardRecognizer(DAG->MF);
6031 }
6032 
6033 /// This is the hazard recognizer used at -O0 by the PostRAHazardRecognizer
6034 /// pass.
6035 ScheduleHazardRecognizer *
6036 SIInstrInfo::CreateTargetPostRAHazardRecognizer(const MachineFunction &MF) const {
6037   return new GCNHazardRecognizer(MF);
6038 }
6039 
6040 std::pair<unsigned, unsigned>
6041 SIInstrInfo::decomposeMachineOperandsTargetFlags(unsigned TF) const {
6042   return std::make_pair(TF & MO_MASK, TF & ~MO_MASK);
6043 }
6044 
6045 ArrayRef<std::pair<unsigned, const char *>>
6046 SIInstrInfo::getSerializableDirectMachineOperandTargetFlags() const {
6047   static const std::pair<unsigned, const char *> TargetFlags[] = {
6048     { MO_GOTPCREL, "amdgpu-gotprel" },
6049     { MO_GOTPCREL32_LO, "amdgpu-gotprel32-lo" },
6050     { MO_GOTPCREL32_HI, "amdgpu-gotprel32-hi" },
6051     { MO_REL32_LO, "amdgpu-rel32-lo" },
6052     { MO_REL32_HI, "amdgpu-rel32-hi" },
6053     { MO_ABS32_LO, "amdgpu-abs32-lo" },
6054     { MO_ABS32_HI, "amdgpu-abs32-hi" },
6055   };
6056 
6057   return makeArrayRef(TargetFlags);
6058 }
6059 
6060 bool SIInstrInfo::isBasicBlockPrologue(const MachineInstr &MI) const {
6061   return !MI.isTerminator() && MI.getOpcode() != AMDGPU::COPY &&
6062          MI.modifiesRegister(AMDGPU::EXEC, &RI);
6063 }
6064 
6065 MachineInstrBuilder
6066 SIInstrInfo::getAddNoCarry(MachineBasicBlock &MBB,
6067                            MachineBasicBlock::iterator I,
6068                            const DebugLoc &DL,
6069                            unsigned DestReg) const {
6070   if (ST.hasAddNoCarry())
6071     return BuildMI(MBB, I, DL, get(AMDGPU::V_ADD_U32_e64), DestReg);
6072 
6073   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
6074   unsigned UnusedCarry = MRI.createVirtualRegister(RI.getBoolRC());
6075   MRI.setRegAllocationHint(UnusedCarry, 0, RI.getVCC());
6076 
6077   return BuildMI(MBB, I, DL, get(AMDGPU::V_ADD_I32_e64), DestReg)
6078            .addReg(UnusedCarry, RegState::Define | RegState::Dead);
6079 }
6080 
6081 bool SIInstrInfo::isKillTerminator(unsigned Opcode) {
6082   switch (Opcode) {
6083   case AMDGPU::SI_KILL_F32_COND_IMM_TERMINATOR:
6084   case AMDGPU::SI_KILL_I1_TERMINATOR:
6085     return true;
6086   default:
6087     return false;
6088   }
6089 }
6090 
6091 const MCInstrDesc &SIInstrInfo::getKillTerminatorFromPseudo(unsigned Opcode) const {
6092   switch (Opcode) {
6093   case AMDGPU::SI_KILL_F32_COND_IMM_PSEUDO:
6094     return get(AMDGPU::SI_KILL_F32_COND_IMM_TERMINATOR);
6095   case AMDGPU::SI_KILL_I1_PSEUDO:
6096     return get(AMDGPU::SI_KILL_I1_TERMINATOR);
6097   default:
6098     llvm_unreachable("invalid opcode, expected SI_KILL_*_PSEUDO");
6099   }
6100 }
6101 
6102 void SIInstrInfo::fixImplicitOperands(MachineInstr &MI) const {
6103   MachineBasicBlock *MBB = MI.getParent();
6104   MachineFunction *MF = MBB->getParent();
6105   const GCNSubtarget &ST = MF->getSubtarget<GCNSubtarget>();
6106 
6107   if (!ST.isWave32())
6108     return;
6109 
6110   for (auto &Op : MI.implicit_operands()) {
6111     if (Op.isReg() && Op.getReg() == AMDGPU::VCC)
6112       Op.setReg(AMDGPU::VCC_LO);
6113   }
6114 }
6115 
6116 bool SIInstrInfo::isBufferSMRD(const MachineInstr &MI) const {
6117   if (!isSMRD(MI))
6118     return false;
6119 
6120   // Check that it is using a buffer resource.
6121   int Idx = AMDGPU::getNamedOperandIdx(MI.getOpcode(), AMDGPU::OpName::sbase);
6122   if (Idx == -1) // e.g. s_memtime
6123     return false;
6124 
6125   const auto RCID = MI.getDesc().OpInfo[Idx].RegClass;
6126   return RCID == AMDGPU::SReg_128RegClassID;
6127 }
6128 
6129 bool SIInstrInfo::isLegalFLATOffset(int64_t Offset, unsigned AddrSpace,
6130                                     bool Signed) const {
6131   // TODO: Should 0 be special cased?
6132   if (!ST.hasFlatInstOffsets())
6133     return false;
6134 
6135   if (ST.hasFlatSegmentOffsetBug() && AddrSpace == AMDGPUAS::FLAT_ADDRESS)
6136     return false;
6137 
6138   if (ST.getGeneration() >= AMDGPUSubtarget::GFX10) {
6139     return (Signed && isInt<12>(Offset)) ||
6140            (!Signed && isUInt<11>(Offset));
6141   }
6142 
6143   return (Signed && isInt<13>(Offset)) ||
6144          (!Signed && isUInt<12>(Offset));
6145 }
6146 
6147 
6148 // This must be kept in sync with the SIEncodingFamily class in SIInstrInfo.td
6149 enum SIEncodingFamily {
6150   SI = 0,
6151   VI = 1,
6152   SDWA = 2,
6153   SDWA9 = 3,
6154   GFX80 = 4,
6155   GFX9 = 5,
6156   GFX10 = 6,
6157   SDWA10 = 7
6158 };
6159 
6160 static SIEncodingFamily subtargetEncodingFamily(const GCNSubtarget &ST) {
6161   switch (ST.getGeneration()) {
6162   default:
6163     break;
6164   case AMDGPUSubtarget::SOUTHERN_ISLANDS:
6165   case AMDGPUSubtarget::SEA_ISLANDS:
6166     return SIEncodingFamily::SI;
6167   case AMDGPUSubtarget::VOLCANIC_ISLANDS:
6168   case AMDGPUSubtarget::GFX9:
6169     return SIEncodingFamily::VI;
6170   case AMDGPUSubtarget::GFX10:
6171     return SIEncodingFamily::GFX10;
6172   }
6173   llvm_unreachable("Unknown subtarget generation!");
6174 }
6175 
6176 int SIInstrInfo::pseudoToMCOpcode(int Opcode) const {
6177   SIEncodingFamily Gen = subtargetEncodingFamily(ST);
6178 
6179   if ((get(Opcode).TSFlags & SIInstrFlags::renamedInGFX9) != 0 &&
6180     ST.getGeneration() == AMDGPUSubtarget::GFX9)
6181     Gen = SIEncodingFamily::GFX9;
6182 
6183   // Adjust the encoding family to GFX80 for D16 buffer instructions when the
6184   // subtarget has UnpackedD16VMem feature.
6185   // TODO: remove this when we discard GFX80 encoding.
6186   if (ST.hasUnpackedD16VMem() && (get(Opcode).TSFlags & SIInstrFlags::D16Buf))
6187     Gen = SIEncodingFamily::GFX80;
6188 
6189   if (get(Opcode).TSFlags & SIInstrFlags::SDWA) {
6190     switch (ST.getGeneration()) {
6191     default:
6192       Gen = SIEncodingFamily::SDWA;
6193       break;
6194     case AMDGPUSubtarget::GFX9:
6195       Gen = SIEncodingFamily::SDWA9;
6196       break;
6197     case AMDGPUSubtarget::GFX10:
6198       Gen = SIEncodingFamily::SDWA10;
6199       break;
6200     }
6201   }
6202 
6203   int MCOp = AMDGPU::getMCOpcode(Opcode, Gen);
6204 
6205   // -1 means that Opcode is already a native instruction.
6206   if (MCOp == -1)
6207     return Opcode;
6208 
6209   // (uint16_t)-1 means that Opcode is a pseudo instruction that has
6210   // no encoding in the given subtarget generation.
6211   if (MCOp == (uint16_t)-1)
6212     return -1;
6213 
6214   return MCOp;
6215 }
6216 
6217 static
6218 TargetInstrInfo::RegSubRegPair getRegOrUndef(const MachineOperand &RegOpnd) {
6219   assert(RegOpnd.isReg());
6220   return RegOpnd.isUndef() ? TargetInstrInfo::RegSubRegPair() :
6221                              getRegSubRegPair(RegOpnd);
6222 }
6223 
6224 TargetInstrInfo::RegSubRegPair
6225 llvm::getRegSequenceSubReg(MachineInstr &MI, unsigned SubReg) {
6226   assert(MI.isRegSequence());
6227   for (unsigned I = 0, E = (MI.getNumOperands() - 1)/ 2; I < E; ++I)
6228     if (MI.getOperand(1 + 2 * I + 1).getImm() == SubReg) {
6229       auto &RegOp = MI.getOperand(1 + 2 * I);
6230       return getRegOrUndef(RegOp);
6231     }
6232   return TargetInstrInfo::RegSubRegPair();
6233 }
6234 
6235 // Try to find the definition of reg:subreg in subreg-manipulation pseudos
6236 // Following a subreg of reg:subreg isn't supported
6237 static bool followSubRegDef(MachineInstr &MI,
6238                             TargetInstrInfo::RegSubRegPair &RSR) {
6239   if (!RSR.SubReg)
6240     return false;
6241   switch (MI.getOpcode()) {
6242   default: break;
6243   case AMDGPU::REG_SEQUENCE:
6244     RSR = getRegSequenceSubReg(MI, RSR.SubReg);
6245     return true;
6246   // EXTRACT_SUBREG ins't supported as this would follow a subreg of subreg
6247   case AMDGPU::INSERT_SUBREG:
6248     if (RSR.SubReg == (unsigned)MI.getOperand(3).getImm())
6249       // inserted the subreg we're looking for
6250       RSR = getRegOrUndef(MI.getOperand(2));
6251     else { // the subreg in the rest of the reg
6252       auto R1 = getRegOrUndef(MI.getOperand(1));
6253       if (R1.SubReg) // subreg of subreg isn't supported
6254         return false;
6255       RSR.Reg = R1.Reg;
6256     }
6257     return true;
6258   }
6259   return false;
6260 }
6261 
6262 MachineInstr *llvm::getVRegSubRegDef(const TargetInstrInfo::RegSubRegPair &P,
6263                                      MachineRegisterInfo &MRI) {
6264   assert(MRI.isSSA());
6265   if (!Register::isVirtualRegister(P.Reg))
6266     return nullptr;
6267 
6268   auto RSR = P;
6269   auto *DefInst = MRI.getVRegDef(RSR.Reg);
6270   while (auto *MI = DefInst) {
6271     DefInst = nullptr;
6272     switch (MI->getOpcode()) {
6273     case AMDGPU::COPY:
6274     case AMDGPU::V_MOV_B32_e32: {
6275       auto &Op1 = MI->getOperand(1);
6276       if (Op1.isReg() && Register::isVirtualRegister(Op1.getReg())) {
6277         if (Op1.isUndef())
6278           return nullptr;
6279         RSR = getRegSubRegPair(Op1);
6280         DefInst = MRI.getVRegDef(RSR.Reg);
6281       }
6282       break;
6283     }
6284     default:
6285       if (followSubRegDef(*MI, RSR)) {
6286         if (!RSR.Reg)
6287           return nullptr;
6288         DefInst = MRI.getVRegDef(RSR.Reg);
6289       }
6290     }
6291     if (!DefInst)
6292       return MI;
6293   }
6294   return nullptr;
6295 }
6296 
6297 bool llvm::execMayBeModifiedBeforeUse(const MachineRegisterInfo &MRI,
6298                                       Register VReg,
6299                                       const MachineInstr &DefMI,
6300                                       const MachineInstr &UseMI) {
6301   assert(MRI.isSSA() && "Must be run on SSA");
6302 
6303   auto *TRI = MRI.getTargetRegisterInfo();
6304   auto *DefBB = DefMI.getParent();
6305 
6306   // Don't bother searching between blocks, although it is possible this block
6307   // doesn't modify exec.
6308   if (UseMI.getParent() != DefBB)
6309     return true;
6310 
6311   const int MaxInstScan = 20;
6312   int NumInst = 0;
6313 
6314   // Stop scan at the use.
6315   auto E = UseMI.getIterator();
6316   for (auto I = std::next(DefMI.getIterator()); I != E; ++I) {
6317     if (I->isDebugInstr())
6318       continue;
6319 
6320     if (++NumInst > MaxInstScan)
6321       return true;
6322 
6323     if (I->modifiesRegister(AMDGPU::EXEC, TRI))
6324       return true;
6325   }
6326 
6327   return false;
6328 }
6329 
6330 bool llvm::execMayBeModifiedBeforeAnyUse(const MachineRegisterInfo &MRI,
6331                                          Register VReg,
6332                                          const MachineInstr &DefMI) {
6333   assert(MRI.isSSA() && "Must be run on SSA");
6334 
6335   auto *TRI = MRI.getTargetRegisterInfo();
6336   auto *DefBB = DefMI.getParent();
6337 
6338   const int MaxUseInstScan = 10;
6339   int NumUseInst = 0;
6340 
6341   for (auto &UseInst : MRI.use_nodbg_instructions(VReg)) {
6342     // Don't bother searching between blocks, although it is possible this block
6343     // doesn't modify exec.
6344     if (UseInst.getParent() != DefBB)
6345       return true;
6346 
6347     if (++NumUseInst > MaxUseInstScan)
6348       return true;
6349   }
6350 
6351   const int MaxInstScan = 20;
6352   int NumInst = 0;
6353 
6354   // Stop scan when we have seen all the uses.
6355   for (auto I = std::next(DefMI.getIterator()); ; ++I) {
6356     if (I->isDebugInstr())
6357       continue;
6358 
6359     if (++NumInst > MaxInstScan)
6360       return true;
6361 
6362     if (I->readsRegister(VReg))
6363       if (--NumUseInst == 0)
6364         return false;
6365 
6366     if (I->modifiesRegister(AMDGPU::EXEC, TRI))
6367       return true;
6368   }
6369 }
6370