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