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     // Don't fold if we are using source or output modifiers. The new VOP2
2076     // instructions don't have them.
2077     if (hasAnyModifiersSet(UseMI))
2078       return false;
2079 
2080     // If this is a free constant, there's no reason to do this.
2081     // TODO: We could fold this here instead of letting SIFoldOperands do it
2082     // later.
2083     MachineOperand *Src0 = getNamedOperand(UseMI, AMDGPU::OpName::src0);
2084 
2085     // Any src operand can be used for the legality check.
2086     if (isInlineConstant(UseMI, *Src0, *ImmOp))
2087       return false;
2088 
2089     bool IsF32 = Opc == AMDGPU::V_MAD_F32 || Opc == AMDGPU::V_MAC_F32_e64;
2090     MachineOperand *Src1 = getNamedOperand(UseMI, AMDGPU::OpName::src1);
2091     MachineOperand *Src2 = getNamedOperand(UseMI, AMDGPU::OpName::src2);
2092 
2093     // Multiplied part is the constant: Use v_madmk_{f16, f32}.
2094     // We should only expect these to be on src0 due to canonicalizations.
2095     if (Src0->isReg() && Src0->getReg() == Reg) {
2096       if (!Src1->isReg() || RI.isSGPRClass(MRI->getRegClass(Src1->getReg())))
2097         return false;
2098 
2099       if (!Src2->isReg() || RI.isSGPRClass(MRI->getRegClass(Src2->getReg())))
2100         return false;
2101 
2102       // We need to swap operands 0 and 1 since madmk constant is at operand 1.
2103 
2104       const int64_t Imm = ImmOp->getImm();
2105 
2106       // FIXME: This would be a lot easier if we could return a new instruction
2107       // instead of having to modify in place.
2108 
2109       // Remove these first since they are at the end.
2110       UseMI.RemoveOperand(
2111           AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::omod));
2112       UseMI.RemoveOperand(
2113           AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::clamp));
2114 
2115       unsigned Src1Reg = Src1->getReg();
2116       unsigned Src1SubReg = Src1->getSubReg();
2117       Src0->setReg(Src1Reg);
2118       Src0->setSubReg(Src1SubReg);
2119       Src0->setIsKill(Src1->isKill());
2120 
2121       if (Opc == AMDGPU::V_MAC_F32_e64 ||
2122           Opc == AMDGPU::V_MAC_F16_e64)
2123         UseMI.untieRegOperand(
2124             AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2));
2125 
2126       Src1->ChangeToImmediate(Imm);
2127 
2128       removeModOperands(UseMI);
2129       UseMI.setDesc(get(IsF32 ? AMDGPU::V_MADMK_F32 : AMDGPU::V_MADMK_F16));
2130 
2131       bool DeleteDef = MRI->hasOneNonDBGUse(Reg);
2132       if (DeleteDef)
2133         DefMI.eraseFromParent();
2134 
2135       return true;
2136     }
2137 
2138     // Added part is the constant: Use v_madak_{f16, f32}.
2139     if (Src2->isReg() && Src2->getReg() == Reg) {
2140       // Not allowed to use constant bus for another operand.
2141       // We can however allow an inline immediate as src0.
2142       bool Src0Inlined = false;
2143       if (Src0->isReg()) {
2144         // Try to inline constant if possible.
2145         // If the Def moves immediate and the use is single
2146         // We are saving VGPR here.
2147         MachineInstr *Def = MRI->getUniqueVRegDef(Src0->getReg());
2148         if (Def && Def->isMoveImmediate() &&
2149           isInlineConstant(Def->getOperand(1)) &&
2150           MRI->hasOneUse(Src0->getReg())) {
2151           Src0->ChangeToImmediate(Def->getOperand(1).getImm());
2152           Src0Inlined = true;
2153         } else if ((RI.isPhysicalRegister(Src0->getReg()) &&
2154             RI.isSGPRClass(RI.getPhysRegClass(Src0->getReg()))) ||
2155             (RI.isVirtualRegister(Src0->getReg()) &&
2156             RI.isSGPRClass(MRI->getRegClass(Src0->getReg()))))
2157           return false;
2158           // VGPR is okay as Src0 - fallthrough
2159       }
2160 
2161       if (Src1->isReg() && !Src0Inlined ) {
2162         // We have one slot for inlinable constant so far - try to fill it
2163         MachineInstr *Def = MRI->getUniqueVRegDef(Src1->getReg());
2164         if (Def && Def->isMoveImmediate() &&
2165             isInlineConstant(Def->getOperand(1)) &&
2166             MRI->hasOneUse(Src1->getReg()) &&
2167             commuteInstruction(UseMI)) {
2168             Src0->ChangeToImmediate(Def->getOperand(1).getImm());
2169         } else if ((RI.isPhysicalRegister(Src1->getReg()) &&
2170             RI.isSGPRClass(RI.getPhysRegClass(Src1->getReg()))) ||
2171             (RI.isVirtualRegister(Src1->getReg()) &&
2172             RI.isSGPRClass(MRI->getRegClass(Src1->getReg()))))
2173           return false;
2174           // VGPR is okay as Src1 - fallthrough
2175       }
2176 
2177       const int64_t Imm = ImmOp->getImm();
2178 
2179       // FIXME: This would be a lot easier if we could return a new instruction
2180       // instead of having to modify in place.
2181 
2182       // Remove these first since they are at the end.
2183       UseMI.RemoveOperand(
2184           AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::omod));
2185       UseMI.RemoveOperand(
2186           AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::clamp));
2187 
2188       if (Opc == AMDGPU::V_MAC_F32_e64 ||
2189           Opc == AMDGPU::V_MAC_F16_e64)
2190         UseMI.untieRegOperand(
2191             AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2));
2192 
2193       // ChangingToImmediate adds Src2 back to the instruction.
2194       Src2->ChangeToImmediate(Imm);
2195 
2196       // These come before src2.
2197       removeModOperands(UseMI);
2198       UseMI.setDesc(get(IsF32 ? AMDGPU::V_MADAK_F32 : AMDGPU::V_MADAK_F16));
2199 
2200       bool DeleteDef = MRI->hasOneNonDBGUse(Reg);
2201       if (DeleteDef)
2202         DefMI.eraseFromParent();
2203 
2204       return true;
2205     }
2206   }
2207 
2208   return false;
2209 }
2210 
2211 static bool offsetsDoNotOverlap(int WidthA, int OffsetA,
2212                                 int WidthB, int OffsetB) {
2213   int LowOffset = OffsetA < OffsetB ? OffsetA : OffsetB;
2214   int HighOffset = OffsetA < OffsetB ? OffsetB : OffsetA;
2215   int LowWidth = (LowOffset == OffsetA) ? WidthA : WidthB;
2216   return LowOffset + LowWidth <= HighOffset;
2217 }
2218 
2219 bool SIInstrInfo::checkInstOffsetsDoNotOverlap(const MachineInstr &MIa,
2220                                                const MachineInstr &MIb) const {
2221   const MachineOperand *BaseOp0, *BaseOp1;
2222   int64_t Offset0, Offset1;
2223 
2224   if (getMemOperandWithOffset(MIa, BaseOp0, Offset0, &RI) &&
2225       getMemOperandWithOffset(MIb, BaseOp1, Offset1, &RI)) {
2226     if (!BaseOp0->isIdenticalTo(*BaseOp1))
2227       return false;
2228 
2229     if (!MIa.hasOneMemOperand() || !MIb.hasOneMemOperand()) {
2230       // FIXME: Handle ds_read2 / ds_write2.
2231       return false;
2232     }
2233     unsigned Width0 = (*MIa.memoperands_begin())->getSize();
2234     unsigned Width1 = (*MIb.memoperands_begin())->getSize();
2235     if (offsetsDoNotOverlap(Width0, Offset0, Width1, Offset1)) {
2236       return true;
2237     }
2238   }
2239 
2240   return false;
2241 }
2242 
2243 bool SIInstrInfo::areMemAccessesTriviallyDisjoint(const MachineInstr &MIa,
2244                                                   const MachineInstr &MIb,
2245                                                   AliasAnalysis *AA) const {
2246   assert((MIa.mayLoad() || MIa.mayStore()) &&
2247          "MIa must load from or modify a memory location");
2248   assert((MIb.mayLoad() || MIb.mayStore()) &&
2249          "MIb must load from or modify a memory location");
2250 
2251   if (MIa.hasUnmodeledSideEffects() || MIb.hasUnmodeledSideEffects())
2252     return false;
2253 
2254   // XXX - Can we relax this between address spaces?
2255   if (MIa.hasOrderedMemoryRef() || MIb.hasOrderedMemoryRef())
2256     return false;
2257 
2258   // TODO: Should we check the address space from the MachineMemOperand? That
2259   // would allow us to distinguish objects we know don't alias based on the
2260   // underlying address space, even if it was lowered to a different one,
2261   // e.g. private accesses lowered to use MUBUF instructions on a scratch
2262   // buffer.
2263   if (isDS(MIa)) {
2264     if (isDS(MIb))
2265       return checkInstOffsetsDoNotOverlap(MIa, MIb);
2266 
2267     return !isFLAT(MIb) || isSegmentSpecificFLAT(MIb);
2268   }
2269 
2270   if (isMUBUF(MIa) || isMTBUF(MIa)) {
2271     if (isMUBUF(MIb) || isMTBUF(MIb))
2272       return checkInstOffsetsDoNotOverlap(MIa, MIb);
2273 
2274     return !isFLAT(MIb) && !isSMRD(MIb);
2275   }
2276 
2277   if (isSMRD(MIa)) {
2278     if (isSMRD(MIb))
2279       return checkInstOffsetsDoNotOverlap(MIa, MIb);
2280 
2281     return !isFLAT(MIb) && !isMUBUF(MIa) && !isMTBUF(MIa);
2282   }
2283 
2284   if (isFLAT(MIa)) {
2285     if (isFLAT(MIb))
2286       return checkInstOffsetsDoNotOverlap(MIa, MIb);
2287 
2288     return false;
2289   }
2290 
2291   return false;
2292 }
2293 
2294 static int64_t getFoldableImm(const MachineOperand* MO) {
2295   if (!MO->isReg())
2296     return false;
2297   const MachineFunction *MF = MO->getParent()->getParent()->getParent();
2298   const MachineRegisterInfo &MRI = MF->getRegInfo();
2299   auto Def = MRI.getUniqueVRegDef(MO->getReg());
2300   if (Def && Def->getOpcode() == AMDGPU::V_MOV_B32_e32 &&
2301       Def->getOperand(1).isImm())
2302     return Def->getOperand(1).getImm();
2303   return AMDGPU::NoRegister;
2304 }
2305 
2306 MachineInstr *SIInstrInfo::convertToThreeAddress(MachineFunction::iterator &MBB,
2307                                                  MachineInstr &MI,
2308                                                  LiveVariables *LV) const {
2309   unsigned Opc = MI.getOpcode();
2310   bool IsF16 = false;
2311   bool IsFMA = Opc == AMDGPU::V_FMAC_F32_e32 || Opc == AMDGPU::V_FMAC_F32_e64;
2312 
2313   switch (Opc) {
2314   default:
2315     return nullptr;
2316   case AMDGPU::V_MAC_F16_e64:
2317     IsF16 = true;
2318     LLVM_FALLTHROUGH;
2319   case AMDGPU::V_MAC_F32_e64:
2320   case AMDGPU::V_FMAC_F32_e64:
2321     break;
2322   case AMDGPU::V_MAC_F16_e32:
2323     IsF16 = true;
2324     LLVM_FALLTHROUGH;
2325   case AMDGPU::V_MAC_F32_e32:
2326   case AMDGPU::V_FMAC_F32_e32: {
2327     int Src0Idx = AMDGPU::getNamedOperandIdx(MI.getOpcode(),
2328                                              AMDGPU::OpName::src0);
2329     const MachineOperand *Src0 = &MI.getOperand(Src0Idx);
2330     if (!Src0->isReg() && !Src0->isImm())
2331       return nullptr;
2332 
2333     if (Src0->isImm() && !isInlineConstant(MI, Src0Idx, *Src0))
2334       return nullptr;
2335 
2336     break;
2337   }
2338   }
2339 
2340   const MachineOperand *Dst = getNamedOperand(MI, AMDGPU::OpName::vdst);
2341   const MachineOperand *Src0 = getNamedOperand(MI, AMDGPU::OpName::src0);
2342   const MachineOperand *Src0Mods =
2343     getNamedOperand(MI, AMDGPU::OpName::src0_modifiers);
2344   const MachineOperand *Src1 = getNamedOperand(MI, AMDGPU::OpName::src1);
2345   const MachineOperand *Src1Mods =
2346     getNamedOperand(MI, AMDGPU::OpName::src1_modifiers);
2347   const MachineOperand *Src2 = getNamedOperand(MI, AMDGPU::OpName::src2);
2348   const MachineOperand *Clamp = getNamedOperand(MI, AMDGPU::OpName::clamp);
2349   const MachineOperand *Omod = getNamedOperand(MI, AMDGPU::OpName::omod);
2350 
2351   if (!IsFMA && !Src0Mods && !Src1Mods && !Clamp && !Omod &&
2352       // If we have an SGPR input, we will violate the constant bus restriction.
2353       (!Src0->isReg() || !RI.isSGPRReg(MBB->getParent()->getRegInfo(), Src0->getReg()))) {
2354     if (auto Imm = getFoldableImm(Src2)) {
2355       return BuildMI(*MBB, MI, MI.getDebugLoc(),
2356                      get(IsF16 ? AMDGPU::V_MADAK_F16 : AMDGPU::V_MADAK_F32))
2357                .add(*Dst)
2358                .add(*Src0)
2359                .add(*Src1)
2360                .addImm(Imm);
2361     }
2362     if (auto Imm = getFoldableImm(Src1)) {
2363       return BuildMI(*MBB, MI, MI.getDebugLoc(),
2364                      get(IsF16 ? AMDGPU::V_MADMK_F16 : AMDGPU::V_MADMK_F32))
2365                .add(*Dst)
2366                .add(*Src0)
2367                .addImm(Imm)
2368                .add(*Src2);
2369     }
2370     if (auto Imm = getFoldableImm(Src0)) {
2371       if (isOperandLegal(MI, AMDGPU::getNamedOperandIdx(AMDGPU::V_MADMK_F32,
2372                            AMDGPU::OpName::src0), Src1))
2373         return BuildMI(*MBB, MI, MI.getDebugLoc(),
2374                        get(IsF16 ? AMDGPU::V_MADMK_F16 : AMDGPU::V_MADMK_F32))
2375                  .add(*Dst)
2376                  .add(*Src1)
2377                  .addImm(Imm)
2378                  .add(*Src2);
2379     }
2380   }
2381 
2382   assert((!IsFMA || !IsF16) && "fmac only expected with f32");
2383   unsigned NewOpc = IsFMA ? AMDGPU::V_FMA_F32 :
2384     (IsF16 ? AMDGPU::V_MAD_F16 : AMDGPU::V_MAD_F32);
2385   return BuildMI(*MBB, MI, MI.getDebugLoc(), get(NewOpc))
2386       .add(*Dst)
2387       .addImm(Src0Mods ? Src0Mods->getImm() : 0)
2388       .add(*Src0)
2389       .addImm(Src1Mods ? Src1Mods->getImm() : 0)
2390       .add(*Src1)
2391       .addImm(0) // Src mods
2392       .add(*Src2)
2393       .addImm(Clamp ? Clamp->getImm() : 0)
2394       .addImm(Omod ? Omod->getImm() : 0);
2395 }
2396 
2397 // It's not generally safe to move VALU instructions across these since it will
2398 // start using the register as a base index rather than directly.
2399 // XXX - Why isn't hasSideEffects sufficient for these?
2400 static bool changesVGPRIndexingMode(const MachineInstr &MI) {
2401   switch (MI.getOpcode()) {
2402   case AMDGPU::S_SET_GPR_IDX_ON:
2403   case AMDGPU::S_SET_GPR_IDX_MODE:
2404   case AMDGPU::S_SET_GPR_IDX_OFF:
2405     return true;
2406   default:
2407     return false;
2408   }
2409 }
2410 
2411 bool SIInstrInfo::isSchedulingBoundary(const MachineInstr &MI,
2412                                        const MachineBasicBlock *MBB,
2413                                        const MachineFunction &MF) const {
2414   // XXX - Do we want the SP check in the base implementation?
2415 
2416   // Target-independent instructions do not have an implicit-use of EXEC, even
2417   // when they operate on VGPRs. Treating EXEC modifications as scheduling
2418   // boundaries prevents incorrect movements of such instructions.
2419   return TargetInstrInfo::isSchedulingBoundary(MI, MBB, MF) ||
2420          MI.modifiesRegister(AMDGPU::EXEC, &RI) ||
2421          MI.getOpcode() == AMDGPU::S_SETREG_IMM32_B32 ||
2422          MI.getOpcode() == AMDGPU::S_SETREG_B32 ||
2423          changesVGPRIndexingMode(MI);
2424 }
2425 
2426 bool SIInstrInfo::isAlwaysGDS(uint16_t Opcode) const {
2427   return Opcode == AMDGPU::DS_ORDERED_COUNT ||
2428          Opcode == AMDGPU::DS_GWS_INIT ||
2429          Opcode == AMDGPU::DS_GWS_SEMA_V ||
2430          Opcode == AMDGPU::DS_GWS_SEMA_BR ||
2431          Opcode == AMDGPU::DS_GWS_SEMA_P ||
2432          Opcode == AMDGPU::DS_GWS_SEMA_RELEASE_ALL ||
2433          Opcode == AMDGPU::DS_GWS_BARRIER;
2434 }
2435 
2436 bool SIInstrInfo::hasUnwantedEffectsWhenEXECEmpty(const MachineInstr &MI) const {
2437   unsigned Opcode = MI.getOpcode();
2438 
2439   if (MI.mayStore() && isSMRD(MI))
2440     return true; // scalar store or atomic
2441 
2442   // These instructions cause shader I/O that may cause hardware lockups
2443   // when executed with an empty EXEC mask.
2444   //
2445   // Note: exp with VM = DONE = 0 is automatically skipped by hardware when
2446   //       EXEC = 0, but checking for that case here seems not worth it
2447   //       given the typical code patterns.
2448   if (Opcode == AMDGPU::S_SENDMSG || Opcode == AMDGPU::S_SENDMSGHALT ||
2449       Opcode == AMDGPU::EXP || Opcode == AMDGPU::EXP_DONE ||
2450       Opcode == AMDGPU::DS_ORDERED_COUNT)
2451     return true;
2452 
2453   if (MI.isInlineAsm())
2454     return true; // conservative assumption
2455 
2456   // These are like SALU instructions in terms of effects, so it's questionable
2457   // whether we should return true for those.
2458   //
2459   // However, executing them with EXEC = 0 causes them to operate on undefined
2460   // data, which we avoid by returning true here.
2461   if (Opcode == AMDGPU::V_READFIRSTLANE_B32 || Opcode == AMDGPU::V_READLANE_B32)
2462     return true;
2463 
2464   return false;
2465 }
2466 
2467 bool SIInstrInfo::mayReadEXEC(const MachineRegisterInfo &MRI,
2468                               const MachineInstr &MI) const {
2469   if (MI.isMetaInstruction())
2470     return false;
2471 
2472   // This won't read exec if this is an SGPR->SGPR copy.
2473   if (MI.isCopyLike()) {
2474     if (!RI.isSGPRReg(MRI, MI.getOperand(0).getReg()))
2475       return true;
2476 
2477     // Make sure this isn't copying exec as a normal operand
2478     return MI.readsRegister(AMDGPU::EXEC, &RI);
2479   }
2480 
2481   // Be conservative with any unhandled generic opcodes.
2482   if (!isTargetSpecificOpcode(MI.getOpcode()))
2483     return true;
2484 
2485   return !isSALU(MI) || MI.readsRegister(AMDGPU::EXEC, &RI);
2486 }
2487 
2488 bool SIInstrInfo::isInlineConstant(const APInt &Imm) const {
2489   switch (Imm.getBitWidth()) {
2490   case 32:
2491     return AMDGPU::isInlinableLiteral32(Imm.getSExtValue(),
2492                                         ST.hasInv2PiInlineImm());
2493   case 64:
2494     return AMDGPU::isInlinableLiteral64(Imm.getSExtValue(),
2495                                         ST.hasInv2PiInlineImm());
2496   case 16:
2497     return ST.has16BitInsts() &&
2498            AMDGPU::isInlinableLiteral16(Imm.getSExtValue(),
2499                                         ST.hasInv2PiInlineImm());
2500   default:
2501     llvm_unreachable("invalid bitwidth");
2502   }
2503 }
2504 
2505 bool SIInstrInfo::isInlineConstant(const MachineOperand &MO,
2506                                    uint8_t OperandType) const {
2507   if (!MO.isImm() ||
2508       OperandType < AMDGPU::OPERAND_SRC_FIRST ||
2509       OperandType > AMDGPU::OPERAND_SRC_LAST)
2510     return false;
2511 
2512   // MachineOperand provides no way to tell the true operand size, since it only
2513   // records a 64-bit value. We need to know the size to determine if a 32-bit
2514   // floating point immediate bit pattern is legal for an integer immediate. It
2515   // would be for any 32-bit integer operand, but would not be for a 64-bit one.
2516 
2517   int64_t Imm = MO.getImm();
2518   switch (OperandType) {
2519   case AMDGPU::OPERAND_REG_IMM_INT32:
2520   case AMDGPU::OPERAND_REG_IMM_FP32:
2521   case AMDGPU::OPERAND_REG_INLINE_C_INT32:
2522   case AMDGPU::OPERAND_REG_INLINE_C_FP32: {
2523     int32_t Trunc = static_cast<int32_t>(Imm);
2524     return AMDGPU::isInlinableLiteral32(Trunc, ST.hasInv2PiInlineImm());
2525   }
2526   case AMDGPU::OPERAND_REG_IMM_INT64:
2527   case AMDGPU::OPERAND_REG_IMM_FP64:
2528   case AMDGPU::OPERAND_REG_INLINE_C_INT64:
2529   case AMDGPU::OPERAND_REG_INLINE_C_FP64:
2530     return AMDGPU::isInlinableLiteral64(MO.getImm(),
2531                                         ST.hasInv2PiInlineImm());
2532   case AMDGPU::OPERAND_REG_IMM_INT16:
2533   case AMDGPU::OPERAND_REG_IMM_FP16:
2534   case AMDGPU::OPERAND_REG_INLINE_C_INT16:
2535   case AMDGPU::OPERAND_REG_INLINE_C_FP16: {
2536     if (isInt<16>(Imm) || isUInt<16>(Imm)) {
2537       // A few special case instructions have 16-bit operands on subtargets
2538       // where 16-bit instructions are not legal.
2539       // TODO: Do the 32-bit immediates work? We shouldn't really need to handle
2540       // constants in these cases
2541       int16_t Trunc = static_cast<int16_t>(Imm);
2542       return ST.has16BitInsts() &&
2543              AMDGPU::isInlinableLiteral16(Trunc, ST.hasInv2PiInlineImm());
2544     }
2545 
2546     return false;
2547   }
2548   case AMDGPU::OPERAND_REG_INLINE_C_V2INT16:
2549   case AMDGPU::OPERAND_REG_INLINE_C_V2FP16: {
2550     if (isUInt<16>(Imm)) {
2551       int16_t Trunc = static_cast<int16_t>(Imm);
2552       return ST.has16BitInsts() &&
2553              AMDGPU::isInlinableLiteral16(Trunc, ST.hasInv2PiInlineImm());
2554     }
2555     if (!(Imm & 0xffff)) {
2556       return ST.has16BitInsts() &&
2557              AMDGPU::isInlinableLiteral16(Imm >> 16, ST.hasInv2PiInlineImm());
2558     }
2559     uint32_t Trunc = static_cast<uint32_t>(Imm);
2560     return  AMDGPU::isInlinableLiteralV216(Trunc, ST.hasInv2PiInlineImm());
2561   }
2562   default:
2563     llvm_unreachable("invalid bitwidth");
2564   }
2565 }
2566 
2567 bool SIInstrInfo::isLiteralConstantLike(const MachineOperand &MO,
2568                                         const MCOperandInfo &OpInfo) const {
2569   switch (MO.getType()) {
2570   case MachineOperand::MO_Register:
2571     return false;
2572   case MachineOperand::MO_Immediate:
2573     return !isInlineConstant(MO, OpInfo);
2574   case MachineOperand::MO_FrameIndex:
2575   case MachineOperand::MO_MachineBasicBlock:
2576   case MachineOperand::MO_ExternalSymbol:
2577   case MachineOperand::MO_GlobalAddress:
2578   case MachineOperand::MO_MCSymbol:
2579     return true;
2580   default:
2581     llvm_unreachable("unexpected operand type");
2582   }
2583 }
2584 
2585 static bool compareMachineOp(const MachineOperand &Op0,
2586                              const MachineOperand &Op1) {
2587   if (Op0.getType() != Op1.getType())
2588     return false;
2589 
2590   switch (Op0.getType()) {
2591   case MachineOperand::MO_Register:
2592     return Op0.getReg() == Op1.getReg();
2593   case MachineOperand::MO_Immediate:
2594     return Op0.getImm() == Op1.getImm();
2595   default:
2596     llvm_unreachable("Didn't expect to be comparing these operand types");
2597   }
2598 }
2599 
2600 bool SIInstrInfo::isImmOperandLegal(const MachineInstr &MI, unsigned OpNo,
2601                                     const MachineOperand &MO) const {
2602   const MCOperandInfo &OpInfo = get(MI.getOpcode()).OpInfo[OpNo];
2603 
2604   assert(MO.isImm() || MO.isTargetIndex() || MO.isFI());
2605 
2606   if (OpInfo.OperandType == MCOI::OPERAND_IMMEDIATE)
2607     return true;
2608 
2609   if (OpInfo.RegClass < 0)
2610     return false;
2611 
2612   if (MO.isImm() && isInlineConstant(MO, OpInfo))
2613     return RI.opCanUseInlineConstant(OpInfo.OperandType);
2614 
2615   return RI.opCanUseLiteralConstant(OpInfo.OperandType);
2616 }
2617 
2618 bool SIInstrInfo::hasVALU32BitEncoding(unsigned Opcode) const {
2619   int Op32 = AMDGPU::getVOPe32(Opcode);
2620   if (Op32 == -1)
2621     return false;
2622 
2623   return pseudoToMCOpcode(Op32) != -1;
2624 }
2625 
2626 bool SIInstrInfo::hasModifiers(unsigned Opcode) const {
2627   // The src0_modifier operand is present on all instructions
2628   // that have modifiers.
2629 
2630   return AMDGPU::getNamedOperandIdx(Opcode,
2631                                     AMDGPU::OpName::src0_modifiers) != -1;
2632 }
2633 
2634 bool SIInstrInfo::hasModifiersSet(const MachineInstr &MI,
2635                                   unsigned OpName) const {
2636   const MachineOperand *Mods = getNamedOperand(MI, OpName);
2637   return Mods && Mods->getImm();
2638 }
2639 
2640 bool SIInstrInfo::hasAnyModifiersSet(const MachineInstr &MI) const {
2641   return hasModifiersSet(MI, AMDGPU::OpName::src0_modifiers) ||
2642          hasModifiersSet(MI, AMDGPU::OpName::src1_modifiers) ||
2643          hasModifiersSet(MI, AMDGPU::OpName::src2_modifiers) ||
2644          hasModifiersSet(MI, AMDGPU::OpName::clamp) ||
2645          hasModifiersSet(MI, AMDGPU::OpName::omod);
2646 }
2647 
2648 bool SIInstrInfo::canShrink(const MachineInstr &MI,
2649                             const MachineRegisterInfo &MRI) const {
2650   const MachineOperand *Src2 = getNamedOperand(MI, AMDGPU::OpName::src2);
2651   // Can't shrink instruction with three operands.
2652   // FIXME: v_cndmask_b32 has 3 operands and is shrinkable, but we need to add
2653   // a special case for it.  It can only be shrunk if the third operand
2654   // is vcc, and src0_modifiers and src1_modifiers are not set.
2655   // We should handle this the same way we handle vopc, by addding
2656   // a register allocation hint pre-regalloc and then do the shrinking
2657   // post-regalloc.
2658   if (Src2) {
2659     switch (MI.getOpcode()) {
2660       default: return false;
2661 
2662       case AMDGPU::V_ADDC_U32_e64:
2663       case AMDGPU::V_SUBB_U32_e64:
2664       case AMDGPU::V_SUBBREV_U32_e64: {
2665         const MachineOperand *Src1
2666           = getNamedOperand(MI, AMDGPU::OpName::src1);
2667         if (!Src1->isReg() || !RI.isVGPR(MRI, Src1->getReg()))
2668           return false;
2669         // Additional verification is needed for sdst/src2.
2670         return true;
2671       }
2672       case AMDGPU::V_MAC_F32_e64:
2673       case AMDGPU::V_MAC_F16_e64:
2674       case AMDGPU::V_FMAC_F32_e64:
2675         if (!Src2->isReg() || !RI.isVGPR(MRI, Src2->getReg()) ||
2676             hasModifiersSet(MI, AMDGPU::OpName::src2_modifiers))
2677           return false;
2678         break;
2679 
2680       case AMDGPU::V_CNDMASK_B32_e64:
2681         break;
2682     }
2683   }
2684 
2685   const MachineOperand *Src1 = getNamedOperand(MI, AMDGPU::OpName::src1);
2686   if (Src1 && (!Src1->isReg() || !RI.isVGPR(MRI, Src1->getReg()) ||
2687                hasModifiersSet(MI, AMDGPU::OpName::src1_modifiers)))
2688     return false;
2689 
2690   // We don't need to check src0, all input types are legal, so just make sure
2691   // src0 isn't using any modifiers.
2692   if (hasModifiersSet(MI, AMDGPU::OpName::src0_modifiers))
2693     return false;
2694 
2695   // Can it be shrunk to a valid 32 bit opcode?
2696   if (!hasVALU32BitEncoding(MI.getOpcode()))
2697     return false;
2698 
2699   // Check output modifiers
2700   return !hasModifiersSet(MI, AMDGPU::OpName::omod) &&
2701          !hasModifiersSet(MI, AMDGPU::OpName::clamp);
2702 }
2703 
2704 // Set VCC operand with all flags from \p Orig, except for setting it as
2705 // implicit.
2706 static void copyFlagsToImplicitVCC(MachineInstr &MI,
2707                                    const MachineOperand &Orig) {
2708 
2709   for (MachineOperand &Use : MI.implicit_operands()) {
2710     if (Use.isUse() && Use.getReg() == AMDGPU::VCC) {
2711       Use.setIsUndef(Orig.isUndef());
2712       Use.setIsKill(Orig.isKill());
2713       return;
2714     }
2715   }
2716 }
2717 
2718 MachineInstr *SIInstrInfo::buildShrunkInst(MachineInstr &MI,
2719                                            unsigned Op32) const {
2720   MachineBasicBlock *MBB = MI.getParent();;
2721   MachineInstrBuilder Inst32 =
2722     BuildMI(*MBB, MI, MI.getDebugLoc(), get(Op32));
2723 
2724   // Add the dst operand if the 32-bit encoding also has an explicit $vdst.
2725   // For VOPC instructions, this is replaced by an implicit def of vcc.
2726   int Op32DstIdx = AMDGPU::getNamedOperandIdx(Op32, AMDGPU::OpName::vdst);
2727   if (Op32DstIdx != -1) {
2728     // dst
2729     Inst32.add(MI.getOperand(0));
2730   } else {
2731     assert(MI.getOperand(0).getReg() == AMDGPU::VCC &&
2732            "Unexpected case");
2733   }
2734 
2735   Inst32.add(*getNamedOperand(MI, AMDGPU::OpName::src0));
2736 
2737   const MachineOperand *Src1 = getNamedOperand(MI, AMDGPU::OpName::src1);
2738   if (Src1)
2739     Inst32.add(*Src1);
2740 
2741   const MachineOperand *Src2 = getNamedOperand(MI, AMDGPU::OpName::src2);
2742 
2743   if (Src2) {
2744     int Op32Src2Idx = AMDGPU::getNamedOperandIdx(Op32, AMDGPU::OpName::src2);
2745     if (Op32Src2Idx != -1) {
2746       Inst32.add(*Src2);
2747     } else {
2748       // In the case of V_CNDMASK_B32_e32, the explicit operand src2 is
2749       // replaced with an implicit read of vcc. This was already added
2750       // during the initial BuildMI, so find it to preserve the flags.
2751       copyFlagsToImplicitVCC(*Inst32, *Src2);
2752     }
2753   }
2754 
2755   return Inst32;
2756 }
2757 
2758 bool SIInstrInfo::usesConstantBus(const MachineRegisterInfo &MRI,
2759                                   const MachineOperand &MO,
2760                                   const MCOperandInfo &OpInfo) const {
2761   // Literal constants use the constant bus.
2762   //if (isLiteralConstantLike(MO, OpInfo))
2763   // return true;
2764   if (MO.isImm())
2765     return !isInlineConstant(MO, OpInfo);
2766 
2767   if (!MO.isReg())
2768     return true; // Misc other operands like FrameIndex
2769 
2770   if (!MO.isUse())
2771     return false;
2772 
2773   if (TargetRegisterInfo::isVirtualRegister(MO.getReg()))
2774     return RI.isSGPRClass(MRI.getRegClass(MO.getReg()));
2775 
2776   // FLAT_SCR is just an SGPR pair.
2777   if (!MO.isImplicit() && (MO.getReg() == AMDGPU::FLAT_SCR))
2778     return true;
2779 
2780   // EXEC register uses the constant bus.
2781   if (!MO.isImplicit() && MO.getReg() == AMDGPU::EXEC)
2782     return true;
2783 
2784   // SGPRs use the constant bus
2785   return (MO.getReg() == AMDGPU::VCC || MO.getReg() == AMDGPU::M0 ||
2786           (!MO.isImplicit() &&
2787            (AMDGPU::SGPR_32RegClass.contains(MO.getReg()) ||
2788             AMDGPU::SGPR_64RegClass.contains(MO.getReg()))));
2789 }
2790 
2791 static unsigned findImplicitSGPRRead(const MachineInstr &MI) {
2792   for (const MachineOperand &MO : MI.implicit_operands()) {
2793     // We only care about reads.
2794     if (MO.isDef())
2795       continue;
2796 
2797     switch (MO.getReg()) {
2798     case AMDGPU::VCC:
2799     case AMDGPU::M0:
2800     case AMDGPU::FLAT_SCR:
2801       return MO.getReg();
2802 
2803     default:
2804       break;
2805     }
2806   }
2807 
2808   return AMDGPU::NoRegister;
2809 }
2810 
2811 static bool shouldReadExec(const MachineInstr &MI) {
2812   if (SIInstrInfo::isVALU(MI)) {
2813     switch (MI.getOpcode()) {
2814     case AMDGPU::V_READLANE_B32:
2815     case AMDGPU::V_READLANE_B32_gfx6_gfx7:
2816     case AMDGPU::V_READLANE_B32_gfx10:
2817     case AMDGPU::V_READLANE_B32_vi:
2818     case AMDGPU::V_WRITELANE_B32:
2819     case AMDGPU::V_WRITELANE_B32_gfx6_gfx7:
2820     case AMDGPU::V_WRITELANE_B32_gfx10:
2821     case AMDGPU::V_WRITELANE_B32_vi:
2822       return false;
2823     }
2824 
2825     return true;
2826   }
2827 
2828   if (SIInstrInfo::isGenericOpcode(MI.getOpcode()) ||
2829       SIInstrInfo::isSALU(MI) ||
2830       SIInstrInfo::isSMRD(MI))
2831     return false;
2832 
2833   return true;
2834 }
2835 
2836 static bool isSubRegOf(const SIRegisterInfo &TRI,
2837                        const MachineOperand &SuperVec,
2838                        const MachineOperand &SubReg) {
2839   if (TargetRegisterInfo::isPhysicalRegister(SubReg.getReg()))
2840     return TRI.isSubRegister(SuperVec.getReg(), SubReg.getReg());
2841 
2842   return SubReg.getSubReg() != AMDGPU::NoSubRegister &&
2843          SubReg.getReg() == SuperVec.getReg();
2844 }
2845 
2846 bool SIInstrInfo::verifyInstruction(const MachineInstr &MI,
2847                                     StringRef &ErrInfo) const {
2848   uint16_t Opcode = MI.getOpcode();
2849   if (SIInstrInfo::isGenericOpcode(MI.getOpcode()))
2850     return true;
2851 
2852   const MachineFunction *MF = MI.getParent()->getParent();
2853   const MachineRegisterInfo &MRI = MF->getRegInfo();
2854 
2855   int Src0Idx = AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::src0);
2856   int Src1Idx = AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::src1);
2857   int Src2Idx = AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::src2);
2858 
2859   // Make sure the number of operands is correct.
2860   const MCInstrDesc &Desc = get(Opcode);
2861   if (!Desc.isVariadic() &&
2862       Desc.getNumOperands() != MI.getNumExplicitOperands()) {
2863     ErrInfo = "Instruction has wrong number of operands.";
2864     return false;
2865   }
2866 
2867   if (MI.isInlineAsm()) {
2868     // Verify register classes for inlineasm constraints.
2869     for (unsigned I = InlineAsm::MIOp_FirstOperand, E = MI.getNumOperands();
2870          I != E; ++I) {
2871       const TargetRegisterClass *RC = MI.getRegClassConstraint(I, this, &RI);
2872       if (!RC)
2873         continue;
2874 
2875       const MachineOperand &Op = MI.getOperand(I);
2876       if (!Op.isReg())
2877         continue;
2878 
2879       unsigned Reg = Op.getReg();
2880       if (!TargetRegisterInfo::isVirtualRegister(Reg) && !RC->contains(Reg)) {
2881         ErrInfo = "inlineasm operand has incorrect register class.";
2882         return false;
2883       }
2884     }
2885 
2886     return true;
2887   }
2888 
2889   // Make sure the register classes are correct.
2890   for (int i = 0, e = Desc.getNumOperands(); i != e; ++i) {
2891     if (MI.getOperand(i).isFPImm()) {
2892       ErrInfo = "FPImm Machine Operands are not supported. ISel should bitcast "
2893                 "all fp values to integers.";
2894       return false;
2895     }
2896 
2897     int RegClass = Desc.OpInfo[i].RegClass;
2898 
2899     switch (Desc.OpInfo[i].OperandType) {
2900     case MCOI::OPERAND_REGISTER:
2901       if (MI.getOperand(i).isImm()) {
2902         ErrInfo = "Illegal immediate value for operand.";
2903         return false;
2904       }
2905       break;
2906     case AMDGPU::OPERAND_REG_IMM_INT32:
2907     case AMDGPU::OPERAND_REG_IMM_FP32:
2908       break;
2909     case AMDGPU::OPERAND_REG_INLINE_C_INT32:
2910     case AMDGPU::OPERAND_REG_INLINE_C_FP32:
2911     case AMDGPU::OPERAND_REG_INLINE_C_INT64:
2912     case AMDGPU::OPERAND_REG_INLINE_C_FP64:
2913     case AMDGPU::OPERAND_REG_INLINE_C_INT16:
2914     case AMDGPU::OPERAND_REG_INLINE_C_FP16: {
2915       const MachineOperand &MO = MI.getOperand(i);
2916       if (!MO.isReg() && (!MO.isImm() || !isInlineConstant(MI, i))) {
2917         ErrInfo = "Illegal immediate value for operand.";
2918         return false;
2919       }
2920       break;
2921     }
2922     case MCOI::OPERAND_IMMEDIATE:
2923     case AMDGPU::OPERAND_KIMM32:
2924       // Check if this operand is an immediate.
2925       // FrameIndex operands will be replaced by immediates, so they are
2926       // allowed.
2927       if (!MI.getOperand(i).isImm() && !MI.getOperand(i).isFI()) {
2928         ErrInfo = "Expected immediate, but got non-immediate";
2929         return false;
2930       }
2931       LLVM_FALLTHROUGH;
2932     default:
2933       continue;
2934     }
2935 
2936     if (!MI.getOperand(i).isReg())
2937       continue;
2938 
2939     if (RegClass != -1) {
2940       unsigned Reg = MI.getOperand(i).getReg();
2941       if (Reg == AMDGPU::NoRegister ||
2942           TargetRegisterInfo::isVirtualRegister(Reg))
2943         continue;
2944 
2945       const TargetRegisterClass *RC = RI.getRegClass(RegClass);
2946       if (!RC->contains(Reg)) {
2947         ErrInfo = "Operand has incorrect register class.";
2948         return false;
2949       }
2950     }
2951   }
2952 
2953   // Verify SDWA
2954   if (isSDWA(MI)) {
2955     if (!ST.hasSDWA()) {
2956       ErrInfo = "SDWA is not supported on this target";
2957       return false;
2958     }
2959 
2960     int DstIdx = AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::vdst);
2961 
2962     const int OpIndicies[] = { DstIdx, Src0Idx, Src1Idx, Src2Idx };
2963 
2964     for (int OpIdx: OpIndicies) {
2965       if (OpIdx == -1)
2966         continue;
2967       const MachineOperand &MO = MI.getOperand(OpIdx);
2968 
2969       if (!ST.hasSDWAScalar()) {
2970         // Only VGPRS on VI
2971         if (!MO.isReg() || !RI.hasVGPRs(RI.getRegClassForReg(MRI, MO.getReg()))) {
2972           ErrInfo = "Only VGPRs allowed as operands in SDWA instructions on VI";
2973           return false;
2974         }
2975       } else {
2976         // No immediates on GFX9
2977         if (!MO.isReg()) {
2978           ErrInfo = "Only reg allowed as operands in SDWA instructions on GFX9";
2979           return false;
2980         }
2981       }
2982     }
2983 
2984     if (!ST.hasSDWAOmod()) {
2985       // No omod allowed on VI
2986       const MachineOperand *OMod = getNamedOperand(MI, AMDGPU::OpName::omod);
2987       if (OMod != nullptr &&
2988         (!OMod->isImm() || OMod->getImm() != 0)) {
2989         ErrInfo = "OMod not allowed in SDWA instructions on VI";
2990         return false;
2991       }
2992     }
2993 
2994     uint16_t BasicOpcode = AMDGPU::getBasicFromSDWAOp(Opcode);
2995     if (isVOPC(BasicOpcode)) {
2996       if (!ST.hasSDWASdst() && DstIdx != -1) {
2997         // Only vcc allowed as dst on VI for VOPC
2998         const MachineOperand &Dst = MI.getOperand(DstIdx);
2999         if (!Dst.isReg() || Dst.getReg() != AMDGPU::VCC) {
3000           ErrInfo = "Only VCC allowed as dst in SDWA instructions on VI";
3001           return false;
3002         }
3003       } else if (!ST.hasSDWAOutModsVOPC()) {
3004         // No clamp allowed on GFX9 for VOPC
3005         const MachineOperand *Clamp = getNamedOperand(MI, AMDGPU::OpName::clamp);
3006         if (Clamp && (!Clamp->isImm() || Clamp->getImm() != 0)) {
3007           ErrInfo = "Clamp not allowed in VOPC SDWA instructions on VI";
3008           return false;
3009         }
3010 
3011         // No omod allowed on GFX9 for VOPC
3012         const MachineOperand *OMod = getNamedOperand(MI, AMDGPU::OpName::omod);
3013         if (OMod && (!OMod->isImm() || OMod->getImm() != 0)) {
3014           ErrInfo = "OMod not allowed in VOPC SDWA instructions on VI";
3015           return false;
3016         }
3017       }
3018     }
3019 
3020     const MachineOperand *DstUnused = getNamedOperand(MI, AMDGPU::OpName::dst_unused);
3021     if (DstUnused && DstUnused->isImm() &&
3022         DstUnused->getImm() == AMDGPU::SDWA::UNUSED_PRESERVE) {
3023       const MachineOperand &Dst = MI.getOperand(DstIdx);
3024       if (!Dst.isReg() || !Dst.isTied()) {
3025         ErrInfo = "Dst register should have tied register";
3026         return false;
3027       }
3028 
3029       const MachineOperand &TiedMO =
3030           MI.getOperand(MI.findTiedOperandIdx(DstIdx));
3031       if (!TiedMO.isReg() || !TiedMO.isImplicit() || !TiedMO.isUse()) {
3032         ErrInfo =
3033             "Dst register should be tied to implicit use of preserved register";
3034         return false;
3035       } else if (TargetRegisterInfo::isPhysicalRegister(TiedMO.getReg()) &&
3036                  Dst.getReg() != TiedMO.getReg()) {
3037         ErrInfo = "Dst register should use same physical register as preserved";
3038         return false;
3039       }
3040     }
3041   }
3042 
3043   // Verify MIMG
3044   if (isMIMG(MI.getOpcode()) && !MI.mayStore()) {
3045     // Ensure that the return type used is large enough for all the options
3046     // being used TFE/LWE require an extra result register.
3047     const MachineOperand *DMask = getNamedOperand(MI, AMDGPU::OpName::dmask);
3048     if (DMask) {
3049       uint64_t DMaskImm = DMask->getImm();
3050       uint32_t RegCount =
3051           isGather4(MI.getOpcode()) ? 4 : countPopulation(DMaskImm);
3052       const MachineOperand *TFE = getNamedOperand(MI, AMDGPU::OpName::tfe);
3053       const MachineOperand *LWE = getNamedOperand(MI, AMDGPU::OpName::lwe);
3054       const MachineOperand *D16 = getNamedOperand(MI, AMDGPU::OpName::d16);
3055 
3056       // Adjust for packed 16 bit values
3057       if (D16 && D16->getImm() && !ST.hasUnpackedD16VMem())
3058         RegCount >>= 1;
3059 
3060       // Adjust if using LWE or TFE
3061       if ((LWE && LWE->getImm()) || (TFE && TFE->getImm()))
3062         RegCount += 1;
3063 
3064       const uint32_t DstIdx =
3065           AMDGPU::getNamedOperandIdx(MI.getOpcode(), AMDGPU::OpName::vdata);
3066       const MachineOperand &Dst = MI.getOperand(DstIdx);
3067       if (Dst.isReg()) {
3068         const TargetRegisterClass *DstRC = getOpRegClass(MI, DstIdx);
3069         uint32_t DstSize = RI.getRegSizeInBits(*DstRC) / 32;
3070         if (RegCount > DstSize) {
3071           ErrInfo = "MIMG instruction returns too many registers for dst "
3072                     "register class";
3073           return false;
3074         }
3075       }
3076     }
3077   }
3078 
3079   // Verify VOP*. Ignore multiple sgpr operands on writelane.
3080   if (Desc.getOpcode() != AMDGPU::V_WRITELANE_B32
3081       && (isVOP1(MI) || isVOP2(MI) || isVOP3(MI) || isVOPC(MI) || isSDWA(MI))) {
3082     // Only look at the true operands. Only a real operand can use the constant
3083     // bus, and we don't want to check pseudo-operands like the source modifier
3084     // flags.
3085     const int OpIndices[] = { Src0Idx, Src1Idx, Src2Idx };
3086 
3087     unsigned ConstantBusCount = 0;
3088     unsigned LiteralCount = 0;
3089 
3090     if (AMDGPU::getNamedOperandIdx(Opcode, AMDGPU::OpName::imm) != -1)
3091       ++ConstantBusCount;
3092 
3093     unsigned SGPRUsed = findImplicitSGPRRead(MI);
3094     if (SGPRUsed != AMDGPU::NoRegister)
3095       ++ConstantBusCount;
3096 
3097     for (int OpIdx : OpIndices) {
3098       if (OpIdx == -1)
3099         break;
3100       const MachineOperand &MO = MI.getOperand(OpIdx);
3101       if (usesConstantBus(MRI, MO, MI.getDesc().OpInfo[OpIdx])) {
3102         if (MO.isReg()) {
3103           if (MO.getReg() != SGPRUsed)
3104             ++ConstantBusCount;
3105           SGPRUsed = MO.getReg();
3106         } else {
3107           ++ConstantBusCount;
3108           ++LiteralCount;
3109         }
3110       }
3111     }
3112     if (ConstantBusCount > 1) {
3113       ErrInfo = "VOP* instruction uses the constant bus more than once";
3114       return false;
3115     }
3116 
3117     if (isVOP3(MI) && LiteralCount) {
3118       ErrInfo = "VOP3 instruction uses literal";
3119       return false;
3120     }
3121   }
3122 
3123   // Verify misc. restrictions on specific instructions.
3124   if (Desc.getOpcode() == AMDGPU::V_DIV_SCALE_F32 ||
3125       Desc.getOpcode() == AMDGPU::V_DIV_SCALE_F64) {
3126     const MachineOperand &Src0 = MI.getOperand(Src0Idx);
3127     const MachineOperand &Src1 = MI.getOperand(Src1Idx);
3128     const MachineOperand &Src2 = MI.getOperand(Src2Idx);
3129     if (Src0.isReg() && Src1.isReg() && Src2.isReg()) {
3130       if (!compareMachineOp(Src0, Src1) &&
3131           !compareMachineOp(Src0, Src2)) {
3132         ErrInfo = "v_div_scale_{f32|f64} require src0 = src1 or src2";
3133         return false;
3134       }
3135     }
3136   }
3137 
3138   if (isSOPK(MI)) {
3139     int64_t Imm = getNamedOperand(MI, AMDGPU::OpName::simm16)->getImm();
3140     if (sopkIsZext(MI)) {
3141       if (!isUInt<16>(Imm)) {
3142         ErrInfo = "invalid immediate for SOPK instruction";
3143         return false;
3144       }
3145     } else {
3146       if (!isInt<16>(Imm)) {
3147         ErrInfo = "invalid immediate for SOPK instruction";
3148         return false;
3149       }
3150     }
3151   }
3152 
3153   if (Desc.getOpcode() == AMDGPU::V_MOVRELS_B32_e32 ||
3154       Desc.getOpcode() == AMDGPU::V_MOVRELS_B32_e64 ||
3155       Desc.getOpcode() == AMDGPU::V_MOVRELD_B32_e32 ||
3156       Desc.getOpcode() == AMDGPU::V_MOVRELD_B32_e64) {
3157     const bool IsDst = Desc.getOpcode() == AMDGPU::V_MOVRELD_B32_e32 ||
3158                        Desc.getOpcode() == AMDGPU::V_MOVRELD_B32_e64;
3159 
3160     const unsigned StaticNumOps = Desc.getNumOperands() +
3161       Desc.getNumImplicitUses();
3162     const unsigned NumImplicitOps = IsDst ? 2 : 1;
3163 
3164     // Allow additional implicit operands. This allows a fixup done by the post
3165     // RA scheduler where the main implicit operand is killed and implicit-defs
3166     // are added for sub-registers that remain live after this instruction.
3167     if (MI.getNumOperands() < StaticNumOps + NumImplicitOps) {
3168       ErrInfo = "missing implicit register operands";
3169       return false;
3170     }
3171 
3172     const MachineOperand *Dst = getNamedOperand(MI, AMDGPU::OpName::vdst);
3173     if (IsDst) {
3174       if (!Dst->isUse()) {
3175         ErrInfo = "v_movreld_b32 vdst should be a use operand";
3176         return false;
3177       }
3178 
3179       unsigned UseOpIdx;
3180       if (!MI.isRegTiedToUseOperand(StaticNumOps, &UseOpIdx) ||
3181           UseOpIdx != StaticNumOps + 1) {
3182         ErrInfo = "movrel implicit operands should be tied";
3183         return false;
3184       }
3185     }
3186 
3187     const MachineOperand &Src0 = MI.getOperand(Src0Idx);
3188     const MachineOperand &ImpUse
3189       = MI.getOperand(StaticNumOps + NumImplicitOps - 1);
3190     if (!ImpUse.isReg() || !ImpUse.isUse() ||
3191         !isSubRegOf(RI, ImpUse, IsDst ? *Dst : Src0)) {
3192       ErrInfo = "src0 should be subreg of implicit vector use";
3193       return false;
3194     }
3195   }
3196 
3197   // Make sure we aren't losing exec uses in the td files. This mostly requires
3198   // being careful when using let Uses to try to add other use registers.
3199   if (shouldReadExec(MI)) {
3200     if (!MI.hasRegisterImplicitUseOperand(AMDGPU::EXEC)) {
3201       ErrInfo = "VALU instruction does not implicitly read exec mask";
3202       return false;
3203     }
3204   }
3205 
3206   if (isSMRD(MI)) {
3207     if (MI.mayStore()) {
3208       // The register offset form of scalar stores may only use m0 as the
3209       // soffset register.
3210       const MachineOperand *Soff = getNamedOperand(MI, AMDGPU::OpName::soff);
3211       if (Soff && Soff->getReg() != AMDGPU::M0) {
3212         ErrInfo = "scalar stores must use m0 as offset register";
3213         return false;
3214       }
3215     }
3216   }
3217 
3218   if (isFLAT(MI) && !MF->getSubtarget<GCNSubtarget>().hasFlatInstOffsets()) {
3219     const MachineOperand *Offset = getNamedOperand(MI, AMDGPU::OpName::offset);
3220     if (Offset->getImm() != 0) {
3221       ErrInfo = "subtarget does not support offsets in flat instructions";
3222       return false;
3223     }
3224   }
3225 
3226   const MachineOperand *DppCt = getNamedOperand(MI, AMDGPU::OpName::dpp_ctrl);
3227   if (DppCt) {
3228     using namespace AMDGPU::DPP;
3229 
3230     unsigned DC = DppCt->getImm();
3231     if (DC == DppCtrl::DPP_UNUSED1 || DC == DppCtrl::DPP_UNUSED2 ||
3232         DC == DppCtrl::DPP_UNUSED3 || DC > DppCtrl::DPP_LAST ||
3233         (DC >= DppCtrl::DPP_UNUSED4_FIRST && DC <= DppCtrl::DPP_UNUSED4_LAST) ||
3234         (DC >= DppCtrl::DPP_UNUSED5_FIRST && DC <= DppCtrl::DPP_UNUSED5_LAST) ||
3235         (DC >= DppCtrl::DPP_UNUSED6_FIRST && DC <= DppCtrl::DPP_UNUSED6_LAST) ||
3236         (DC >= DppCtrl::DPP_UNUSED7_FIRST && DC <= DppCtrl::DPP_UNUSED7_LAST)) {
3237       ErrInfo = "Invalid dpp_ctrl value";
3238       return false;
3239     }
3240   }
3241 
3242   return true;
3243 }
3244 
3245 unsigned SIInstrInfo::getVALUOp(const MachineInstr &MI) const {
3246   switch (MI.getOpcode()) {
3247   default: return AMDGPU::INSTRUCTION_LIST_END;
3248   case AMDGPU::REG_SEQUENCE: return AMDGPU::REG_SEQUENCE;
3249   case AMDGPU::COPY: return AMDGPU::COPY;
3250   case AMDGPU::PHI: return AMDGPU::PHI;
3251   case AMDGPU::INSERT_SUBREG: return AMDGPU::INSERT_SUBREG;
3252   case AMDGPU::WQM: return AMDGPU::WQM;
3253   case AMDGPU::WWM: return AMDGPU::WWM;
3254   case AMDGPU::S_MOV_B32:
3255     return MI.getOperand(1).isReg() ?
3256            AMDGPU::COPY : AMDGPU::V_MOV_B32_e32;
3257   case AMDGPU::S_ADD_I32:
3258     return ST.hasAddNoCarry() ? AMDGPU::V_ADD_U32_e64 : AMDGPU::V_ADD_I32_e32;
3259   case AMDGPU::S_ADDC_U32:
3260     return AMDGPU::V_ADDC_U32_e32;
3261   case AMDGPU::S_SUB_I32:
3262     return ST.hasAddNoCarry() ? AMDGPU::V_SUB_U32_e64 : AMDGPU::V_SUB_I32_e32;
3263     // FIXME: These are not consistently handled, and selected when the carry is
3264     // used.
3265   case AMDGPU::S_ADD_U32:
3266     return AMDGPU::V_ADD_I32_e32;
3267   case AMDGPU::S_SUB_U32:
3268     return AMDGPU::V_SUB_I32_e32;
3269   case AMDGPU::S_SUBB_U32: return AMDGPU::V_SUBB_U32_e32;
3270   case AMDGPU::S_MUL_I32: return AMDGPU::V_MUL_LO_I32;
3271   case AMDGPU::S_MUL_HI_U32: return AMDGPU::V_MUL_HI_U32;
3272   case AMDGPU::S_MUL_HI_I32: return AMDGPU::V_MUL_HI_I32;
3273   case AMDGPU::S_AND_B32: return AMDGPU::V_AND_B32_e64;
3274   case AMDGPU::S_OR_B32: return AMDGPU::V_OR_B32_e64;
3275   case AMDGPU::S_XOR_B32: return AMDGPU::V_XOR_B32_e64;
3276   case AMDGPU::S_XNOR_B32:
3277     return ST.hasDLInsts() ? AMDGPU::V_XNOR_B32_e64 : AMDGPU::INSTRUCTION_LIST_END;
3278   case AMDGPU::S_MIN_I32: return AMDGPU::V_MIN_I32_e64;
3279   case AMDGPU::S_MIN_U32: return AMDGPU::V_MIN_U32_e64;
3280   case AMDGPU::S_MAX_I32: return AMDGPU::V_MAX_I32_e64;
3281   case AMDGPU::S_MAX_U32: return AMDGPU::V_MAX_U32_e64;
3282   case AMDGPU::S_ASHR_I32: return AMDGPU::V_ASHR_I32_e32;
3283   case AMDGPU::S_ASHR_I64: return AMDGPU::V_ASHR_I64;
3284   case AMDGPU::S_LSHL_B32: return AMDGPU::V_LSHL_B32_e32;
3285   case AMDGPU::S_LSHL_B64: return AMDGPU::V_LSHL_B64;
3286   case AMDGPU::S_LSHR_B32: return AMDGPU::V_LSHR_B32_e32;
3287   case AMDGPU::S_LSHR_B64: return AMDGPU::V_LSHR_B64;
3288   case AMDGPU::S_SEXT_I32_I8: return AMDGPU::V_BFE_I32;
3289   case AMDGPU::S_SEXT_I32_I16: return AMDGPU::V_BFE_I32;
3290   case AMDGPU::S_BFE_U32: return AMDGPU::V_BFE_U32;
3291   case AMDGPU::S_BFE_I32: return AMDGPU::V_BFE_I32;
3292   case AMDGPU::S_BFM_B32: return AMDGPU::V_BFM_B32_e64;
3293   case AMDGPU::S_BREV_B32: return AMDGPU::V_BFREV_B32_e32;
3294   case AMDGPU::S_NOT_B32: return AMDGPU::V_NOT_B32_e32;
3295   case AMDGPU::S_NOT_B64: return AMDGPU::V_NOT_B32_e32;
3296   case AMDGPU::S_CMP_EQ_I32: return AMDGPU::V_CMP_EQ_I32_e32;
3297   case AMDGPU::S_CMP_LG_I32: return AMDGPU::V_CMP_NE_I32_e32;
3298   case AMDGPU::S_CMP_GT_I32: return AMDGPU::V_CMP_GT_I32_e32;
3299   case AMDGPU::S_CMP_GE_I32: return AMDGPU::V_CMP_GE_I32_e32;
3300   case AMDGPU::S_CMP_LT_I32: return AMDGPU::V_CMP_LT_I32_e32;
3301   case AMDGPU::S_CMP_LE_I32: return AMDGPU::V_CMP_LE_I32_e32;
3302   case AMDGPU::S_CMP_EQ_U32: return AMDGPU::V_CMP_EQ_U32_e32;
3303   case AMDGPU::S_CMP_LG_U32: return AMDGPU::V_CMP_NE_U32_e32;
3304   case AMDGPU::S_CMP_GT_U32: return AMDGPU::V_CMP_GT_U32_e32;
3305   case AMDGPU::S_CMP_GE_U32: return AMDGPU::V_CMP_GE_U32_e32;
3306   case AMDGPU::S_CMP_LT_U32: return AMDGPU::V_CMP_LT_U32_e32;
3307   case AMDGPU::S_CMP_LE_U32: return AMDGPU::V_CMP_LE_U32_e32;
3308   case AMDGPU::S_CMP_EQ_U64: return AMDGPU::V_CMP_EQ_U64_e32;
3309   case AMDGPU::S_CMP_LG_U64: return AMDGPU::V_CMP_NE_U64_e32;
3310   case AMDGPU::S_BCNT1_I32_B32: return AMDGPU::V_BCNT_U32_B32_e64;
3311   case AMDGPU::S_FF1_I32_B32: return AMDGPU::V_FFBL_B32_e32;
3312   case AMDGPU::S_FLBIT_I32_B32: return AMDGPU::V_FFBH_U32_e32;
3313   case AMDGPU::S_FLBIT_I32: return AMDGPU::V_FFBH_I32_e64;
3314   case AMDGPU::S_CBRANCH_SCC0: return AMDGPU::S_CBRANCH_VCCZ;
3315   case AMDGPU::S_CBRANCH_SCC1: return AMDGPU::S_CBRANCH_VCCNZ;
3316   }
3317   llvm_unreachable(
3318       "Unexpected scalar opcode without corresponding vector one!");
3319 }
3320 
3321 const TargetRegisterClass *SIInstrInfo::getOpRegClass(const MachineInstr &MI,
3322                                                       unsigned OpNo) const {
3323   const MachineRegisterInfo &MRI = MI.getParent()->getParent()->getRegInfo();
3324   const MCInstrDesc &Desc = get(MI.getOpcode());
3325   if (MI.isVariadic() || OpNo >= Desc.getNumOperands() ||
3326       Desc.OpInfo[OpNo].RegClass == -1) {
3327     unsigned Reg = MI.getOperand(OpNo).getReg();
3328 
3329     if (TargetRegisterInfo::isVirtualRegister(Reg))
3330       return MRI.getRegClass(Reg);
3331     return RI.getPhysRegClass(Reg);
3332   }
3333 
3334   unsigned RCID = Desc.OpInfo[OpNo].RegClass;
3335   return RI.getRegClass(RCID);
3336 }
3337 
3338 void SIInstrInfo::legalizeOpWithMove(MachineInstr &MI, unsigned OpIdx) const {
3339   MachineBasicBlock::iterator I = MI;
3340   MachineBasicBlock *MBB = MI.getParent();
3341   MachineOperand &MO = MI.getOperand(OpIdx);
3342   MachineRegisterInfo &MRI = MBB->getParent()->getRegInfo();
3343   unsigned RCID = get(MI.getOpcode()).OpInfo[OpIdx].RegClass;
3344   const TargetRegisterClass *RC = RI.getRegClass(RCID);
3345   unsigned Opcode = AMDGPU::V_MOV_B32_e32;
3346   if (MO.isReg())
3347     Opcode = AMDGPU::COPY;
3348   else if (RI.isSGPRClass(RC))
3349     Opcode = AMDGPU::S_MOV_B32;
3350 
3351   const TargetRegisterClass *VRC = RI.getEquivalentVGPRClass(RC);
3352   if (RI.getCommonSubClass(&AMDGPU::VReg_64RegClass, VRC))
3353     VRC = &AMDGPU::VReg_64RegClass;
3354   else
3355     VRC = &AMDGPU::VGPR_32RegClass;
3356 
3357   unsigned Reg = MRI.createVirtualRegister(VRC);
3358   DebugLoc DL = MBB->findDebugLoc(I);
3359   BuildMI(*MI.getParent(), I, DL, get(Opcode), Reg).add(MO);
3360   MO.ChangeToRegister(Reg, false);
3361 }
3362 
3363 unsigned SIInstrInfo::buildExtractSubReg(MachineBasicBlock::iterator MI,
3364                                          MachineRegisterInfo &MRI,
3365                                          MachineOperand &SuperReg,
3366                                          const TargetRegisterClass *SuperRC,
3367                                          unsigned SubIdx,
3368                                          const TargetRegisterClass *SubRC)
3369                                          const {
3370   MachineBasicBlock *MBB = MI->getParent();
3371   DebugLoc DL = MI->getDebugLoc();
3372   unsigned SubReg = MRI.createVirtualRegister(SubRC);
3373 
3374   if (SuperReg.getSubReg() == AMDGPU::NoSubRegister) {
3375     BuildMI(*MBB, MI, DL, get(TargetOpcode::COPY), SubReg)
3376       .addReg(SuperReg.getReg(), 0, SubIdx);
3377     return SubReg;
3378   }
3379 
3380   // Just in case the super register is itself a sub-register, copy it to a new
3381   // value so we don't need to worry about merging its subreg index with the
3382   // SubIdx passed to this function. The register coalescer should be able to
3383   // eliminate this extra copy.
3384   unsigned NewSuperReg = MRI.createVirtualRegister(SuperRC);
3385 
3386   BuildMI(*MBB, MI, DL, get(TargetOpcode::COPY), NewSuperReg)
3387     .addReg(SuperReg.getReg(), 0, SuperReg.getSubReg());
3388 
3389   BuildMI(*MBB, MI, DL, get(TargetOpcode::COPY), SubReg)
3390     .addReg(NewSuperReg, 0, SubIdx);
3391 
3392   return SubReg;
3393 }
3394 
3395 MachineOperand SIInstrInfo::buildExtractSubRegOrImm(
3396   MachineBasicBlock::iterator MII,
3397   MachineRegisterInfo &MRI,
3398   MachineOperand &Op,
3399   const TargetRegisterClass *SuperRC,
3400   unsigned SubIdx,
3401   const TargetRegisterClass *SubRC) const {
3402   if (Op.isImm()) {
3403     if (SubIdx == AMDGPU::sub0)
3404       return MachineOperand::CreateImm(static_cast<int32_t>(Op.getImm()));
3405     if (SubIdx == AMDGPU::sub1)
3406       return MachineOperand::CreateImm(static_cast<int32_t>(Op.getImm() >> 32));
3407 
3408     llvm_unreachable("Unhandled register index for immediate");
3409   }
3410 
3411   unsigned SubReg = buildExtractSubReg(MII, MRI, Op, SuperRC,
3412                                        SubIdx, SubRC);
3413   return MachineOperand::CreateReg(SubReg, false);
3414 }
3415 
3416 // Change the order of operands from (0, 1, 2) to (0, 2, 1)
3417 void SIInstrInfo::swapOperands(MachineInstr &Inst) const {
3418   assert(Inst.getNumExplicitOperands() == 3);
3419   MachineOperand Op1 = Inst.getOperand(1);
3420   Inst.RemoveOperand(1);
3421   Inst.addOperand(Op1);
3422 }
3423 
3424 bool SIInstrInfo::isLegalRegOperand(const MachineRegisterInfo &MRI,
3425                                     const MCOperandInfo &OpInfo,
3426                                     const MachineOperand &MO) const {
3427   if (!MO.isReg())
3428     return false;
3429 
3430   unsigned Reg = MO.getReg();
3431   const TargetRegisterClass *RC =
3432     TargetRegisterInfo::isVirtualRegister(Reg) ?
3433     MRI.getRegClass(Reg) :
3434     RI.getPhysRegClass(Reg);
3435 
3436   const SIRegisterInfo *TRI =
3437       static_cast<const SIRegisterInfo*>(MRI.getTargetRegisterInfo());
3438   RC = TRI->getSubRegClass(RC, MO.getSubReg());
3439 
3440   // In order to be legal, the common sub-class must be equal to the
3441   // class of the current operand.  For example:
3442   //
3443   // v_mov_b32 s0 ; Operand defined as vsrc_b32
3444   //              ; RI.getCommonSubClass(s0,vsrc_b32) = sgpr ; LEGAL
3445   //
3446   // s_sendmsg 0, s0 ; Operand defined as m0reg
3447   //                 ; RI.getCommonSubClass(s0,m0reg) = m0reg ; NOT LEGAL
3448 
3449   return RI.getCommonSubClass(RC, RI.getRegClass(OpInfo.RegClass)) == RC;
3450 }
3451 
3452 bool SIInstrInfo::isLegalVSrcOperand(const MachineRegisterInfo &MRI,
3453                                      const MCOperandInfo &OpInfo,
3454                                      const MachineOperand &MO) const {
3455   if (MO.isReg())
3456     return isLegalRegOperand(MRI, OpInfo, MO);
3457 
3458   // Handle non-register types that are treated like immediates.
3459   assert(MO.isImm() || MO.isTargetIndex() || MO.isFI());
3460   return true;
3461 }
3462 
3463 bool SIInstrInfo::isOperandLegal(const MachineInstr &MI, unsigned OpIdx,
3464                                  const MachineOperand *MO) const {
3465   const MachineRegisterInfo &MRI = MI.getParent()->getParent()->getRegInfo();
3466   const MCInstrDesc &InstDesc = MI.getDesc();
3467   const MCOperandInfo &OpInfo = InstDesc.OpInfo[OpIdx];
3468   const TargetRegisterClass *DefinedRC =
3469       OpInfo.RegClass != -1 ? RI.getRegClass(OpInfo.RegClass) : nullptr;
3470   if (!MO)
3471     MO = &MI.getOperand(OpIdx);
3472 
3473   if (isVALU(MI) && usesConstantBus(MRI, *MO, OpInfo)) {
3474 
3475     RegSubRegPair SGPRUsed;
3476     if (MO->isReg())
3477       SGPRUsed = RegSubRegPair(MO->getReg(), MO->getSubReg());
3478 
3479     for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
3480       if (i == OpIdx)
3481         continue;
3482       const MachineOperand &Op = MI.getOperand(i);
3483       if (Op.isReg()) {
3484         if ((Op.getReg() != SGPRUsed.Reg || Op.getSubReg() != SGPRUsed.SubReg) &&
3485             usesConstantBus(MRI, Op, InstDesc.OpInfo[i])) {
3486           return false;
3487         }
3488       } else if (InstDesc.OpInfo[i].OperandType == AMDGPU::OPERAND_KIMM32) {
3489         return false;
3490       }
3491     }
3492   }
3493 
3494   if (MO->isReg()) {
3495     assert(DefinedRC);
3496     return isLegalRegOperand(MRI, OpInfo, *MO);
3497   }
3498 
3499   // Handle non-register types that are treated like immediates.
3500   assert(MO->isImm() || MO->isTargetIndex() || MO->isFI());
3501 
3502   if (!DefinedRC) {
3503     // This operand expects an immediate.
3504     return true;
3505   }
3506 
3507   return isImmOperandLegal(MI, OpIdx, *MO);
3508 }
3509 
3510 void SIInstrInfo::legalizeOperandsVOP2(MachineRegisterInfo &MRI,
3511                                        MachineInstr &MI) const {
3512   unsigned Opc = MI.getOpcode();
3513   const MCInstrDesc &InstrDesc = get(Opc);
3514 
3515   int Src1Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1);
3516   MachineOperand &Src1 = MI.getOperand(Src1Idx);
3517 
3518   // If there is an implicit SGPR use such as VCC use for v_addc_u32/v_subb_u32
3519   // we need to only have one constant bus use.
3520   //
3521   // Note we do not need to worry about literal constants here. They are
3522   // disabled for the operand type for instructions because they will always
3523   // violate the one constant bus use rule.
3524   bool HasImplicitSGPR = findImplicitSGPRRead(MI) != AMDGPU::NoRegister;
3525   if (HasImplicitSGPR) {
3526     int Src0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0);
3527     MachineOperand &Src0 = MI.getOperand(Src0Idx);
3528 
3529     if (Src0.isReg() && RI.isSGPRReg(MRI, Src0.getReg()))
3530       legalizeOpWithMove(MI, Src0Idx);
3531   }
3532 
3533   // Special case: V_WRITELANE_B32 accepts only immediate or SGPR operands for
3534   // both the value to write (src0) and lane select (src1).  Fix up non-SGPR
3535   // src0/src1 with V_READFIRSTLANE.
3536   if (Opc == AMDGPU::V_WRITELANE_B32) {
3537     int Src0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0);
3538     MachineOperand &Src0 = MI.getOperand(Src0Idx);
3539     const DebugLoc &DL = MI.getDebugLoc();
3540     if (Src0.isReg() && RI.isVGPR(MRI, Src0.getReg())) {
3541       unsigned Reg = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
3542       BuildMI(*MI.getParent(), MI, DL, get(AMDGPU::V_READFIRSTLANE_B32), Reg)
3543           .add(Src0);
3544       Src0.ChangeToRegister(Reg, false);
3545     }
3546     if (Src1.isReg() && RI.isVGPR(MRI, Src1.getReg())) {
3547       unsigned Reg = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
3548       const DebugLoc &DL = MI.getDebugLoc();
3549       BuildMI(*MI.getParent(), MI, DL, get(AMDGPU::V_READFIRSTLANE_B32), Reg)
3550           .add(Src1);
3551       Src1.ChangeToRegister(Reg, false);
3552     }
3553     return;
3554   }
3555 
3556   // VOP2 src0 instructions support all operand types, so we don't need to check
3557   // their legality. If src1 is already legal, we don't need to do anything.
3558   if (isLegalRegOperand(MRI, InstrDesc.OpInfo[Src1Idx], Src1))
3559     return;
3560 
3561   // Special case: V_READLANE_B32 accepts only immediate or SGPR operands for
3562   // lane select. Fix up using V_READFIRSTLANE, since we assume that the lane
3563   // select is uniform.
3564   if (Opc == AMDGPU::V_READLANE_B32 && Src1.isReg() &&
3565       RI.isVGPR(MRI, Src1.getReg())) {
3566     unsigned Reg = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
3567     const DebugLoc &DL = MI.getDebugLoc();
3568     BuildMI(*MI.getParent(), MI, DL, get(AMDGPU::V_READFIRSTLANE_B32), Reg)
3569         .add(Src1);
3570     Src1.ChangeToRegister(Reg, false);
3571     return;
3572   }
3573 
3574   // We do not use commuteInstruction here because it is too aggressive and will
3575   // commute if it is possible. We only want to commute here if it improves
3576   // legality. This can be called a fairly large number of times so don't waste
3577   // compile time pointlessly swapping and checking legality again.
3578   if (HasImplicitSGPR || !MI.isCommutable()) {
3579     legalizeOpWithMove(MI, Src1Idx);
3580     return;
3581   }
3582 
3583   int Src0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0);
3584   MachineOperand &Src0 = MI.getOperand(Src0Idx);
3585 
3586   // If src0 can be used as src1, commuting will make the operands legal.
3587   // Otherwise we have to give up and insert a move.
3588   //
3589   // TODO: Other immediate-like operand kinds could be commuted if there was a
3590   // MachineOperand::ChangeTo* for them.
3591   if ((!Src1.isImm() && !Src1.isReg()) ||
3592       !isLegalRegOperand(MRI, InstrDesc.OpInfo[Src1Idx], Src0)) {
3593     legalizeOpWithMove(MI, Src1Idx);
3594     return;
3595   }
3596 
3597   int CommutedOpc = commuteOpcode(MI);
3598   if (CommutedOpc == -1) {
3599     legalizeOpWithMove(MI, Src1Idx);
3600     return;
3601   }
3602 
3603   MI.setDesc(get(CommutedOpc));
3604 
3605   unsigned Src0Reg = Src0.getReg();
3606   unsigned Src0SubReg = Src0.getSubReg();
3607   bool Src0Kill = Src0.isKill();
3608 
3609   if (Src1.isImm())
3610     Src0.ChangeToImmediate(Src1.getImm());
3611   else if (Src1.isReg()) {
3612     Src0.ChangeToRegister(Src1.getReg(), false, false, Src1.isKill());
3613     Src0.setSubReg(Src1.getSubReg());
3614   } else
3615     llvm_unreachable("Should only have register or immediate operands");
3616 
3617   Src1.ChangeToRegister(Src0Reg, false, false, Src0Kill);
3618   Src1.setSubReg(Src0SubReg);
3619 }
3620 
3621 // Legalize VOP3 operands. Because all operand types are supported for any
3622 // operand, and since literal constants are not allowed and should never be
3623 // seen, we only need to worry about inserting copies if we use multiple SGPR
3624 // operands.
3625 void SIInstrInfo::legalizeOperandsVOP3(MachineRegisterInfo &MRI,
3626                                        MachineInstr &MI) const {
3627   unsigned Opc = MI.getOpcode();
3628 
3629   int VOP3Idx[3] = {
3630     AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0),
3631     AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1),
3632     AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2)
3633   };
3634 
3635   // Find the one SGPR operand we are allowed to use.
3636   unsigned SGPRReg = findUsedSGPR(MI, VOP3Idx);
3637 
3638   for (unsigned i = 0; i < 3; ++i) {
3639     int Idx = VOP3Idx[i];
3640     if (Idx == -1)
3641       break;
3642     MachineOperand &MO = MI.getOperand(Idx);
3643 
3644     // We should never see a VOP3 instruction with an illegal immediate operand.
3645     if (!MO.isReg())
3646       continue;
3647 
3648     if (!RI.isSGPRClass(MRI.getRegClass(MO.getReg())))
3649       continue; // VGPRs are legal
3650 
3651     if (SGPRReg == AMDGPU::NoRegister || SGPRReg == MO.getReg()) {
3652       SGPRReg = MO.getReg();
3653       // We can use one SGPR in each VOP3 instruction.
3654       continue;
3655     }
3656 
3657     // If we make it this far, then the operand is not legal and we must
3658     // legalize it.
3659     legalizeOpWithMove(MI, Idx);
3660   }
3661 }
3662 
3663 unsigned SIInstrInfo::readlaneVGPRToSGPR(unsigned SrcReg, MachineInstr &UseMI,
3664                                          MachineRegisterInfo &MRI) const {
3665   const TargetRegisterClass *VRC = MRI.getRegClass(SrcReg);
3666   const TargetRegisterClass *SRC = RI.getEquivalentSGPRClass(VRC);
3667   unsigned DstReg = MRI.createVirtualRegister(SRC);
3668   unsigned SubRegs = RI.getRegSizeInBits(*VRC) / 32;
3669 
3670   if (SubRegs == 1) {
3671     BuildMI(*UseMI.getParent(), UseMI, UseMI.getDebugLoc(),
3672             get(AMDGPU::V_READFIRSTLANE_B32), DstReg)
3673         .addReg(SrcReg);
3674     return DstReg;
3675   }
3676 
3677   SmallVector<unsigned, 8> SRegs;
3678   for (unsigned i = 0; i < SubRegs; ++i) {
3679     unsigned SGPR = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
3680     BuildMI(*UseMI.getParent(), UseMI, UseMI.getDebugLoc(),
3681             get(AMDGPU::V_READFIRSTLANE_B32), SGPR)
3682         .addReg(SrcReg, 0, RI.getSubRegFromChannel(i));
3683     SRegs.push_back(SGPR);
3684   }
3685 
3686   MachineInstrBuilder MIB =
3687       BuildMI(*UseMI.getParent(), UseMI, UseMI.getDebugLoc(),
3688               get(AMDGPU::REG_SEQUENCE), DstReg);
3689   for (unsigned i = 0; i < SubRegs; ++i) {
3690     MIB.addReg(SRegs[i]);
3691     MIB.addImm(RI.getSubRegFromChannel(i));
3692   }
3693   return DstReg;
3694 }
3695 
3696 void SIInstrInfo::legalizeOperandsSMRD(MachineRegisterInfo &MRI,
3697                                        MachineInstr &MI) const {
3698 
3699   // If the pointer is store in VGPRs, then we need to move them to
3700   // SGPRs using v_readfirstlane.  This is safe because we only select
3701   // loads with uniform pointers to SMRD instruction so we know the
3702   // pointer value is uniform.
3703   MachineOperand *SBase = getNamedOperand(MI, AMDGPU::OpName::sbase);
3704   if (SBase && !RI.isSGPRClass(MRI.getRegClass(SBase->getReg()))) {
3705     unsigned SGPR = readlaneVGPRToSGPR(SBase->getReg(), MI, MRI);
3706     SBase->setReg(SGPR);
3707   }
3708   MachineOperand *SOff = getNamedOperand(MI, AMDGPU::OpName::soff);
3709   if (SOff && !RI.isSGPRClass(MRI.getRegClass(SOff->getReg()))) {
3710     unsigned SGPR = readlaneVGPRToSGPR(SOff->getReg(), MI, MRI);
3711     SOff->setReg(SGPR);
3712   }
3713 }
3714 
3715 void SIInstrInfo::legalizeGenericOperand(MachineBasicBlock &InsertMBB,
3716                                          MachineBasicBlock::iterator I,
3717                                          const TargetRegisterClass *DstRC,
3718                                          MachineOperand &Op,
3719                                          MachineRegisterInfo &MRI,
3720                                          const DebugLoc &DL) const {
3721   unsigned OpReg = Op.getReg();
3722   unsigned OpSubReg = Op.getSubReg();
3723 
3724   const TargetRegisterClass *OpRC = RI.getSubClassWithSubReg(
3725       RI.getRegClassForReg(MRI, OpReg), OpSubReg);
3726 
3727   // Check if operand is already the correct register class.
3728   if (DstRC == OpRC)
3729     return;
3730 
3731   unsigned DstReg = MRI.createVirtualRegister(DstRC);
3732   MachineInstr *Copy =
3733       BuildMI(InsertMBB, I, DL, get(AMDGPU::COPY), DstReg).add(Op);
3734 
3735   Op.setReg(DstReg);
3736   Op.setSubReg(0);
3737 
3738   MachineInstr *Def = MRI.getVRegDef(OpReg);
3739   if (!Def)
3740     return;
3741 
3742   // Try to eliminate the copy if it is copying an immediate value.
3743   if (Def->isMoveImmediate())
3744     FoldImmediate(*Copy, *Def, OpReg, &MRI);
3745 }
3746 
3747 // Emit the actual waterfall loop, executing the wrapped instruction for each
3748 // unique value of \p Rsrc across all lanes. In the best case we execute 1
3749 // iteration, in the worst case we execute 64 (once per lane).
3750 static void
3751 emitLoadSRsrcFromVGPRLoop(const SIInstrInfo &TII, MachineRegisterInfo &MRI,
3752                           MachineBasicBlock &OrigBB, MachineBasicBlock &LoopBB,
3753                           const DebugLoc &DL, MachineOperand &Rsrc) {
3754   MachineBasicBlock::iterator I = LoopBB.begin();
3755 
3756   unsigned VRsrc = Rsrc.getReg();
3757   unsigned VRsrcUndef = getUndefRegState(Rsrc.isUndef());
3758 
3759   unsigned SaveExec = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
3760   unsigned CondReg0 = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
3761   unsigned CondReg1 = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
3762   unsigned AndCond = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
3763   unsigned SRsrcSub0 = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
3764   unsigned SRsrcSub1 = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
3765   unsigned SRsrcSub2 = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
3766   unsigned SRsrcSub3 = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
3767   unsigned SRsrc = MRI.createVirtualRegister(&AMDGPU::SReg_128RegClass);
3768 
3769   // Beginning of the loop, read the next Rsrc variant.
3770   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::V_READFIRSTLANE_B32), SRsrcSub0)
3771       .addReg(VRsrc, VRsrcUndef, AMDGPU::sub0);
3772   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::V_READFIRSTLANE_B32), SRsrcSub1)
3773       .addReg(VRsrc, VRsrcUndef, AMDGPU::sub1);
3774   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::V_READFIRSTLANE_B32), SRsrcSub2)
3775       .addReg(VRsrc, VRsrcUndef, AMDGPU::sub2);
3776   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::V_READFIRSTLANE_B32), SRsrcSub3)
3777       .addReg(VRsrc, VRsrcUndef, AMDGPU::sub3);
3778 
3779   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::REG_SEQUENCE), SRsrc)
3780       .addReg(SRsrcSub0)
3781       .addImm(AMDGPU::sub0)
3782       .addReg(SRsrcSub1)
3783       .addImm(AMDGPU::sub1)
3784       .addReg(SRsrcSub2)
3785       .addImm(AMDGPU::sub2)
3786       .addReg(SRsrcSub3)
3787       .addImm(AMDGPU::sub3);
3788 
3789   // Update Rsrc operand to use the SGPR Rsrc.
3790   Rsrc.setReg(SRsrc);
3791   Rsrc.setIsKill(true);
3792 
3793   // Identify all lanes with identical Rsrc operands in their VGPRs.
3794   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::V_CMP_EQ_U64_e64), CondReg0)
3795       .addReg(SRsrc, 0, AMDGPU::sub0_sub1)
3796       .addReg(VRsrc, 0, AMDGPU::sub0_sub1);
3797   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::V_CMP_EQ_U64_e64), CondReg1)
3798       .addReg(SRsrc, 0, AMDGPU::sub2_sub3)
3799       .addReg(VRsrc, 0, AMDGPU::sub2_sub3);
3800   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::S_AND_B64), AndCond)
3801       .addReg(CondReg0)
3802       .addReg(CondReg1);
3803 
3804   MRI.setSimpleHint(SaveExec, AndCond);
3805 
3806   // Update EXEC to matching lanes, saving original to SaveExec.
3807   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::S_AND_SAVEEXEC_B64), SaveExec)
3808       .addReg(AndCond, RegState::Kill);
3809 
3810   // The original instruction is here; we insert the terminators after it.
3811   I = LoopBB.end();
3812 
3813   // Update EXEC, switch all done bits to 0 and all todo bits to 1.
3814   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::S_XOR_B64_term), AMDGPU::EXEC)
3815       .addReg(AMDGPU::EXEC)
3816       .addReg(SaveExec);
3817   BuildMI(LoopBB, I, DL, TII.get(AMDGPU::S_CBRANCH_EXECNZ)).addMBB(&LoopBB);
3818 }
3819 
3820 // Build a waterfall loop around \p MI, replacing the VGPR \p Rsrc register
3821 // with SGPRs by iterating over all unique values across all lanes.
3822 static void loadSRsrcFromVGPR(const SIInstrInfo &TII, MachineInstr &MI,
3823                               MachineOperand &Rsrc, MachineDominatorTree *MDT) {
3824   MachineBasicBlock &MBB = *MI.getParent();
3825   MachineFunction &MF = *MBB.getParent();
3826   MachineRegisterInfo &MRI = MF.getRegInfo();
3827   MachineBasicBlock::iterator I(&MI);
3828   const DebugLoc &DL = MI.getDebugLoc();
3829 
3830   unsigned SaveExec = MRI.createVirtualRegister(&AMDGPU::SReg_64_XEXECRegClass);
3831 
3832   // Save the EXEC mask
3833   BuildMI(MBB, I, DL, TII.get(AMDGPU::S_MOV_B64), SaveExec)
3834       .addReg(AMDGPU::EXEC);
3835 
3836   // Killed uses in the instruction we are waterfalling around will be
3837   // incorrect due to the added control-flow.
3838   for (auto &MO : MI.uses()) {
3839     if (MO.isReg() && MO.isUse()) {
3840       MRI.clearKillFlags(MO.getReg());
3841     }
3842   }
3843 
3844   // To insert the loop we need to split the block. Move everything after this
3845   // point to a new block, and insert a new empty block between the two.
3846   MachineBasicBlock *LoopBB = MF.CreateMachineBasicBlock();
3847   MachineBasicBlock *RemainderBB = MF.CreateMachineBasicBlock();
3848   MachineFunction::iterator MBBI(MBB);
3849   ++MBBI;
3850 
3851   MF.insert(MBBI, LoopBB);
3852   MF.insert(MBBI, RemainderBB);
3853 
3854   LoopBB->addSuccessor(LoopBB);
3855   LoopBB->addSuccessor(RemainderBB);
3856 
3857   // Move MI to the LoopBB, and the remainder of the block to RemainderBB.
3858   MachineBasicBlock::iterator J = I++;
3859   RemainderBB->transferSuccessorsAndUpdatePHIs(&MBB);
3860   RemainderBB->splice(RemainderBB->begin(), &MBB, I, MBB.end());
3861   LoopBB->splice(LoopBB->begin(), &MBB, J);
3862 
3863   MBB.addSuccessor(LoopBB);
3864 
3865   // Update dominators. We know that MBB immediately dominates LoopBB, that
3866   // LoopBB immediately dominates RemainderBB, and that RemainderBB immediately
3867   // dominates all of the successors transferred to it from MBB that MBB used
3868   // to dominate.
3869   if (MDT) {
3870     MDT->addNewBlock(LoopBB, &MBB);
3871     MDT->addNewBlock(RemainderBB, LoopBB);
3872     for (auto &Succ : RemainderBB->successors()) {
3873       if (MDT->dominates(&MBB, Succ)) {
3874         MDT->changeImmediateDominator(Succ, RemainderBB);
3875       }
3876     }
3877   }
3878 
3879   emitLoadSRsrcFromVGPRLoop(TII, MRI, MBB, *LoopBB, DL, Rsrc);
3880 
3881   // Restore the EXEC mask
3882   MachineBasicBlock::iterator First = RemainderBB->begin();
3883   BuildMI(*RemainderBB, First, DL, TII.get(AMDGPU::S_MOV_B64), AMDGPU::EXEC)
3884       .addReg(SaveExec);
3885 }
3886 
3887 // Extract pointer from Rsrc and return a zero-value Rsrc replacement.
3888 static std::tuple<unsigned, unsigned>
3889 extractRsrcPtr(const SIInstrInfo &TII, MachineInstr &MI, MachineOperand &Rsrc) {
3890   MachineBasicBlock &MBB = *MI.getParent();
3891   MachineFunction &MF = *MBB.getParent();
3892   MachineRegisterInfo &MRI = MF.getRegInfo();
3893 
3894   // Extract the ptr from the resource descriptor.
3895   unsigned RsrcPtr =
3896       TII.buildExtractSubReg(MI, MRI, Rsrc, &AMDGPU::VReg_128RegClass,
3897                              AMDGPU::sub0_sub1, &AMDGPU::VReg_64RegClass);
3898 
3899   // Create an empty resource descriptor
3900   unsigned Zero64 = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
3901   unsigned SRsrcFormatLo = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
3902   unsigned SRsrcFormatHi = MRI.createVirtualRegister(&AMDGPU::SGPR_32RegClass);
3903   unsigned NewSRsrc = MRI.createVirtualRegister(&AMDGPU::SReg_128RegClass);
3904   uint64_t RsrcDataFormat = TII.getDefaultRsrcDataFormat();
3905 
3906   // Zero64 = 0
3907   BuildMI(MBB, MI, MI.getDebugLoc(), TII.get(AMDGPU::S_MOV_B64), Zero64)
3908       .addImm(0);
3909 
3910   // SRsrcFormatLo = RSRC_DATA_FORMAT{31-0}
3911   BuildMI(MBB, MI, MI.getDebugLoc(), TII.get(AMDGPU::S_MOV_B32), SRsrcFormatLo)
3912       .addImm(RsrcDataFormat & 0xFFFFFFFF);
3913 
3914   // SRsrcFormatHi = RSRC_DATA_FORMAT{63-32}
3915   BuildMI(MBB, MI, MI.getDebugLoc(), TII.get(AMDGPU::S_MOV_B32), SRsrcFormatHi)
3916       .addImm(RsrcDataFormat >> 32);
3917 
3918   // NewSRsrc = {Zero64, SRsrcFormat}
3919   BuildMI(MBB, MI, MI.getDebugLoc(), TII.get(AMDGPU::REG_SEQUENCE), NewSRsrc)
3920       .addReg(Zero64)
3921       .addImm(AMDGPU::sub0_sub1)
3922       .addReg(SRsrcFormatLo)
3923       .addImm(AMDGPU::sub2)
3924       .addReg(SRsrcFormatHi)
3925       .addImm(AMDGPU::sub3);
3926 
3927   return std::make_tuple(RsrcPtr, NewSRsrc);
3928 }
3929 
3930 void SIInstrInfo::legalizeOperands(MachineInstr &MI,
3931                                    MachineDominatorTree *MDT) const {
3932   MachineFunction &MF = *MI.getParent()->getParent();
3933   MachineRegisterInfo &MRI = MF.getRegInfo();
3934 
3935   // Legalize VOP2
3936   if (isVOP2(MI) || isVOPC(MI)) {
3937     legalizeOperandsVOP2(MRI, MI);
3938     return;
3939   }
3940 
3941   // Legalize VOP3
3942   if (isVOP3(MI)) {
3943     legalizeOperandsVOP3(MRI, MI);
3944     return;
3945   }
3946 
3947   // Legalize SMRD
3948   if (isSMRD(MI)) {
3949     legalizeOperandsSMRD(MRI, MI);
3950     return;
3951   }
3952 
3953   // Legalize REG_SEQUENCE and PHI
3954   // The register class of the operands much be the same type as the register
3955   // class of the output.
3956   if (MI.getOpcode() == AMDGPU::PHI) {
3957     const TargetRegisterClass *RC = nullptr, *SRC = nullptr, *VRC = nullptr;
3958     for (unsigned i = 1, e = MI.getNumOperands(); i != e; i += 2) {
3959       if (!MI.getOperand(i).isReg() ||
3960           !TargetRegisterInfo::isVirtualRegister(MI.getOperand(i).getReg()))
3961         continue;
3962       const TargetRegisterClass *OpRC =
3963           MRI.getRegClass(MI.getOperand(i).getReg());
3964       if (RI.hasVGPRs(OpRC)) {
3965         VRC = OpRC;
3966       } else {
3967         SRC = OpRC;
3968       }
3969     }
3970 
3971     // If any of the operands are VGPR registers, then they all most be
3972     // otherwise we will create illegal VGPR->SGPR copies when legalizing
3973     // them.
3974     if (VRC || !RI.isSGPRClass(getOpRegClass(MI, 0))) {
3975       if (!VRC) {
3976         assert(SRC);
3977         VRC = RI.getEquivalentVGPRClass(SRC);
3978       }
3979       RC = VRC;
3980     } else {
3981       RC = SRC;
3982     }
3983 
3984     // Update all the operands so they have the same type.
3985     for (unsigned I = 1, E = MI.getNumOperands(); I != E; I += 2) {
3986       MachineOperand &Op = MI.getOperand(I);
3987       if (!Op.isReg() || !TargetRegisterInfo::isVirtualRegister(Op.getReg()))
3988         continue;
3989 
3990       // MI is a PHI instruction.
3991       MachineBasicBlock *InsertBB = MI.getOperand(I + 1).getMBB();
3992       MachineBasicBlock::iterator Insert = InsertBB->getFirstTerminator();
3993 
3994       // Avoid creating no-op copies with the same src and dst reg class.  These
3995       // confuse some of the machine passes.
3996       legalizeGenericOperand(*InsertBB, Insert, RC, Op, MRI, MI.getDebugLoc());
3997     }
3998   }
3999 
4000   // REG_SEQUENCE doesn't really require operand legalization, but if one has a
4001   // VGPR dest type and SGPR sources, insert copies so all operands are
4002   // VGPRs. This seems to help operand folding / the register coalescer.
4003   if (MI.getOpcode() == AMDGPU::REG_SEQUENCE) {
4004     MachineBasicBlock *MBB = MI.getParent();
4005     const TargetRegisterClass *DstRC = getOpRegClass(MI, 0);
4006     if (RI.hasVGPRs(DstRC)) {
4007       // Update all the operands so they are VGPR register classes. These may
4008       // not be the same register class because REG_SEQUENCE supports mixing
4009       // subregister index types e.g. sub0_sub1 + sub2 + sub3
4010       for (unsigned I = 1, E = MI.getNumOperands(); I != E; I += 2) {
4011         MachineOperand &Op = MI.getOperand(I);
4012         if (!Op.isReg() || !TargetRegisterInfo::isVirtualRegister(Op.getReg()))
4013           continue;
4014 
4015         const TargetRegisterClass *OpRC = MRI.getRegClass(Op.getReg());
4016         const TargetRegisterClass *VRC = RI.getEquivalentVGPRClass(OpRC);
4017         if (VRC == OpRC)
4018           continue;
4019 
4020         legalizeGenericOperand(*MBB, MI, VRC, Op, MRI, MI.getDebugLoc());
4021         Op.setIsKill();
4022       }
4023     }
4024 
4025     return;
4026   }
4027 
4028   // Legalize INSERT_SUBREG
4029   // src0 must have the same register class as dst
4030   if (MI.getOpcode() == AMDGPU::INSERT_SUBREG) {
4031     unsigned Dst = MI.getOperand(0).getReg();
4032     unsigned Src0 = MI.getOperand(1).getReg();
4033     const TargetRegisterClass *DstRC = MRI.getRegClass(Dst);
4034     const TargetRegisterClass *Src0RC = MRI.getRegClass(Src0);
4035     if (DstRC != Src0RC) {
4036       MachineBasicBlock *MBB = MI.getParent();
4037       MachineOperand &Op = MI.getOperand(1);
4038       legalizeGenericOperand(*MBB, MI, DstRC, Op, MRI, MI.getDebugLoc());
4039     }
4040     return;
4041   }
4042 
4043   // Legalize SI_INIT_M0
4044   if (MI.getOpcode() == AMDGPU::SI_INIT_M0) {
4045     MachineOperand &Src = MI.getOperand(0);
4046     if (Src.isReg() && RI.hasVGPRs(MRI.getRegClass(Src.getReg())))
4047       Src.setReg(readlaneVGPRToSGPR(Src.getReg(), MI, MRI));
4048     return;
4049   }
4050 
4051   // Legalize MIMG and MUBUF/MTBUF for shaders.
4052   //
4053   // Shaders only generate MUBUF/MTBUF instructions via intrinsics or via
4054   // scratch memory access. In both cases, the legalization never involves
4055   // conversion to the addr64 form.
4056   if (isMIMG(MI) ||
4057       (AMDGPU::isShader(MF.getFunction().getCallingConv()) &&
4058        (isMUBUF(MI) || isMTBUF(MI)))) {
4059     MachineOperand *SRsrc = getNamedOperand(MI, AMDGPU::OpName::srsrc);
4060     if (SRsrc && !RI.isSGPRClass(MRI.getRegClass(SRsrc->getReg()))) {
4061       unsigned SGPR = readlaneVGPRToSGPR(SRsrc->getReg(), MI, MRI);
4062       SRsrc->setReg(SGPR);
4063     }
4064 
4065     MachineOperand *SSamp = getNamedOperand(MI, AMDGPU::OpName::ssamp);
4066     if (SSamp && !RI.isSGPRClass(MRI.getRegClass(SSamp->getReg()))) {
4067       unsigned SGPR = readlaneVGPRToSGPR(SSamp->getReg(), MI, MRI);
4068       SSamp->setReg(SGPR);
4069     }
4070     return;
4071   }
4072 
4073   // Legalize MUBUF* instructions.
4074   int RsrcIdx =
4075       AMDGPU::getNamedOperandIdx(MI.getOpcode(), AMDGPU::OpName::srsrc);
4076   if (RsrcIdx != -1) {
4077     // We have an MUBUF instruction
4078     MachineOperand *Rsrc = &MI.getOperand(RsrcIdx);
4079     unsigned RsrcRC = get(MI.getOpcode()).OpInfo[RsrcIdx].RegClass;
4080     if (RI.getCommonSubClass(MRI.getRegClass(Rsrc->getReg()),
4081                              RI.getRegClass(RsrcRC))) {
4082       // The operands are legal.
4083       // FIXME: We may need to legalize operands besided srsrc.
4084       return;
4085     }
4086 
4087     // Legalize a VGPR Rsrc.
4088     //
4089     // If the instruction is _ADDR64, we can avoid a waterfall by extracting
4090     // the base pointer from the VGPR Rsrc, adding it to the VAddr, then using
4091     // a zero-value SRsrc.
4092     //
4093     // If the instruction is _OFFSET (both idxen and offen disabled), and we
4094     // support ADDR64 instructions, we can convert to ADDR64 and do the same as
4095     // above.
4096     //
4097     // Otherwise we are on non-ADDR64 hardware, and/or we have
4098     // idxen/offen/bothen and we fall back to a waterfall loop.
4099 
4100     MachineBasicBlock &MBB = *MI.getParent();
4101 
4102     MachineOperand *VAddr = getNamedOperand(MI, AMDGPU::OpName::vaddr);
4103     if (VAddr && AMDGPU::getIfAddr64Inst(MI.getOpcode()) != -1) {
4104       // This is already an ADDR64 instruction so we need to add the pointer
4105       // extracted from the resource descriptor to the current value of VAddr.
4106       unsigned NewVAddrLo = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4107       unsigned NewVAddrHi = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4108       unsigned NewVAddr = MRI.createVirtualRegister(&AMDGPU::VReg_64RegClass);
4109 
4110       unsigned RsrcPtr, NewSRsrc;
4111       std::tie(RsrcPtr, NewSRsrc) = extractRsrcPtr(*this, MI, *Rsrc);
4112 
4113       // NewVaddrLo = RsrcPtr:sub0 + VAddr:sub0
4114       DebugLoc DL = MI.getDebugLoc();
4115       BuildMI(MBB, MI, DL, get(AMDGPU::V_ADD_I32_e32), NewVAddrLo)
4116           .addReg(RsrcPtr, 0, AMDGPU::sub0)
4117           .addReg(VAddr->getReg(), 0, AMDGPU::sub0);
4118 
4119       // NewVaddrHi = RsrcPtr:sub1 + VAddr:sub1
4120       BuildMI(MBB, MI, DL, get(AMDGPU::V_ADDC_U32_e32), NewVAddrHi)
4121           .addReg(RsrcPtr, 0, AMDGPU::sub1)
4122           .addReg(VAddr->getReg(), 0, AMDGPU::sub1);
4123 
4124       // NewVaddr = {NewVaddrHi, NewVaddrLo}
4125       BuildMI(MBB, MI, MI.getDebugLoc(), get(AMDGPU::REG_SEQUENCE), NewVAddr)
4126           .addReg(NewVAddrLo)
4127           .addImm(AMDGPU::sub0)
4128           .addReg(NewVAddrHi)
4129           .addImm(AMDGPU::sub1);
4130 
4131       VAddr->setReg(NewVAddr);
4132       Rsrc->setReg(NewSRsrc);
4133     } else if (!VAddr && ST.hasAddr64()) {
4134       // This instructions is the _OFFSET variant, so we need to convert it to
4135       // ADDR64.
4136       assert(MBB.getParent()->getSubtarget<GCNSubtarget>().getGeneration()
4137              < AMDGPUSubtarget::VOLCANIC_ISLANDS &&
4138              "FIXME: Need to emit flat atomics here");
4139 
4140       unsigned RsrcPtr, NewSRsrc;
4141       std::tie(RsrcPtr, NewSRsrc) = extractRsrcPtr(*this, MI, *Rsrc);
4142 
4143       unsigned NewVAddr = MRI.createVirtualRegister(&AMDGPU::VReg_64RegClass);
4144       MachineOperand *VData = getNamedOperand(MI, AMDGPU::OpName::vdata);
4145       MachineOperand *Offset = getNamedOperand(MI, AMDGPU::OpName::offset);
4146       MachineOperand *SOffset = getNamedOperand(MI, AMDGPU::OpName::soffset);
4147       unsigned Addr64Opcode = AMDGPU::getAddr64Inst(MI.getOpcode());
4148 
4149       // Atomics rith return have have an additional tied operand and are
4150       // missing some of the special bits.
4151       MachineOperand *VDataIn = getNamedOperand(MI, AMDGPU::OpName::vdata_in);
4152       MachineInstr *Addr64;
4153 
4154       if (!VDataIn) {
4155         // Regular buffer load / store.
4156         MachineInstrBuilder MIB =
4157             BuildMI(MBB, MI, MI.getDebugLoc(), get(Addr64Opcode))
4158                 .add(*VData)
4159                 .addReg(NewVAddr)
4160                 .addReg(NewSRsrc)
4161                 .add(*SOffset)
4162                 .add(*Offset);
4163 
4164         // Atomics do not have this operand.
4165         if (const MachineOperand *GLC =
4166                 getNamedOperand(MI, AMDGPU::OpName::glc)) {
4167           MIB.addImm(GLC->getImm());
4168         }
4169         if (const MachineOperand *DLC =
4170                 getNamedOperand(MI, AMDGPU::OpName::dlc)) {
4171           MIB.addImm(DLC->getImm());
4172         }
4173 
4174         MIB.addImm(getNamedImmOperand(MI, AMDGPU::OpName::slc));
4175 
4176         if (const MachineOperand *TFE =
4177                 getNamedOperand(MI, AMDGPU::OpName::tfe)) {
4178           MIB.addImm(TFE->getImm());
4179         }
4180 
4181         MIB.cloneMemRefs(MI);
4182         Addr64 = MIB;
4183       } else {
4184         // Atomics with return.
4185         Addr64 = BuildMI(MBB, MI, MI.getDebugLoc(), get(Addr64Opcode))
4186                      .add(*VData)
4187                      .add(*VDataIn)
4188                      .addReg(NewVAddr)
4189                      .addReg(NewSRsrc)
4190                      .add(*SOffset)
4191                      .add(*Offset)
4192                      .addImm(getNamedImmOperand(MI, AMDGPU::OpName::slc))
4193                      .cloneMemRefs(MI);
4194       }
4195 
4196       MI.removeFromParent();
4197 
4198       // NewVaddr = {NewVaddrHi, NewVaddrLo}
4199       BuildMI(MBB, Addr64, Addr64->getDebugLoc(), get(AMDGPU::REG_SEQUENCE),
4200               NewVAddr)
4201           .addReg(RsrcPtr, 0, AMDGPU::sub0)
4202           .addImm(AMDGPU::sub0)
4203           .addReg(RsrcPtr, 0, AMDGPU::sub1)
4204           .addImm(AMDGPU::sub1);
4205     } else {
4206       // This is another variant; legalize Rsrc with waterfall loop from VGPRs
4207       // to SGPRs.
4208       loadSRsrcFromVGPR(*this, MI, *Rsrc, MDT);
4209     }
4210   }
4211 }
4212 
4213 void SIInstrInfo::moveToVALU(MachineInstr &TopInst,
4214                              MachineDominatorTree *MDT) const {
4215   SetVectorType Worklist;
4216   Worklist.insert(&TopInst);
4217 
4218   while (!Worklist.empty()) {
4219     MachineInstr &Inst = *Worklist.pop_back_val();
4220     MachineBasicBlock *MBB = Inst.getParent();
4221     MachineRegisterInfo &MRI = MBB->getParent()->getRegInfo();
4222 
4223     unsigned Opcode = Inst.getOpcode();
4224     unsigned NewOpcode = getVALUOp(Inst);
4225 
4226     // Handle some special cases
4227     switch (Opcode) {
4228     default:
4229       break;
4230     case AMDGPU::S_ADD_U64_PSEUDO:
4231     case AMDGPU::S_SUB_U64_PSEUDO:
4232       splitScalar64BitAddSub(Worklist, Inst, MDT);
4233       Inst.eraseFromParent();
4234       continue;
4235     case AMDGPU::S_ADD_I32:
4236     case AMDGPU::S_SUB_I32:
4237       // FIXME: The u32 versions currently selected use the carry.
4238       if (moveScalarAddSub(Worklist, Inst, MDT))
4239         continue;
4240 
4241       // Default handling
4242       break;
4243     case AMDGPU::S_AND_B64:
4244       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_AND_B32, MDT);
4245       Inst.eraseFromParent();
4246       continue;
4247 
4248     case AMDGPU::S_OR_B64:
4249       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_OR_B32, MDT);
4250       Inst.eraseFromParent();
4251       continue;
4252 
4253     case AMDGPU::S_XOR_B64:
4254       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_XOR_B32, MDT);
4255       Inst.eraseFromParent();
4256       continue;
4257 
4258     case AMDGPU::S_NAND_B64:
4259       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_NAND_B32, MDT);
4260       Inst.eraseFromParent();
4261       continue;
4262 
4263     case AMDGPU::S_NOR_B64:
4264       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_NOR_B32, MDT);
4265       Inst.eraseFromParent();
4266       continue;
4267 
4268     case AMDGPU::S_XNOR_B64:
4269       if (ST.hasDLInsts())
4270         splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_XNOR_B32, MDT);
4271       else
4272         splitScalar64BitXnor(Worklist, Inst, MDT);
4273       Inst.eraseFromParent();
4274       continue;
4275 
4276     case AMDGPU::S_ANDN2_B64:
4277       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_ANDN2_B32, MDT);
4278       Inst.eraseFromParent();
4279       continue;
4280 
4281     case AMDGPU::S_ORN2_B64:
4282       splitScalar64BitBinaryOp(Worklist, Inst, AMDGPU::S_ORN2_B32, MDT);
4283       Inst.eraseFromParent();
4284       continue;
4285 
4286     case AMDGPU::S_NOT_B64:
4287       splitScalar64BitUnaryOp(Worklist, Inst, AMDGPU::S_NOT_B32);
4288       Inst.eraseFromParent();
4289       continue;
4290 
4291     case AMDGPU::S_BCNT1_I32_B64:
4292       splitScalar64BitBCNT(Worklist, Inst);
4293       Inst.eraseFromParent();
4294       continue;
4295 
4296     case AMDGPU::S_BFE_I64:
4297       splitScalar64BitBFE(Worklist, Inst);
4298       Inst.eraseFromParent();
4299       continue;
4300 
4301     case AMDGPU::S_LSHL_B32:
4302       if (ST.getGeneration() >= AMDGPUSubtarget::VOLCANIC_ISLANDS) {
4303         NewOpcode = AMDGPU::V_LSHLREV_B32_e64;
4304         swapOperands(Inst);
4305       }
4306       break;
4307     case AMDGPU::S_ASHR_I32:
4308       if (ST.getGeneration() >= AMDGPUSubtarget::VOLCANIC_ISLANDS) {
4309         NewOpcode = AMDGPU::V_ASHRREV_I32_e64;
4310         swapOperands(Inst);
4311       }
4312       break;
4313     case AMDGPU::S_LSHR_B32:
4314       if (ST.getGeneration() >= AMDGPUSubtarget::VOLCANIC_ISLANDS) {
4315         NewOpcode = AMDGPU::V_LSHRREV_B32_e64;
4316         swapOperands(Inst);
4317       }
4318       break;
4319     case AMDGPU::S_LSHL_B64:
4320       if (ST.getGeneration() >= AMDGPUSubtarget::VOLCANIC_ISLANDS) {
4321         NewOpcode = AMDGPU::V_LSHLREV_B64;
4322         swapOperands(Inst);
4323       }
4324       break;
4325     case AMDGPU::S_ASHR_I64:
4326       if (ST.getGeneration() >= AMDGPUSubtarget::VOLCANIC_ISLANDS) {
4327         NewOpcode = AMDGPU::V_ASHRREV_I64;
4328         swapOperands(Inst);
4329       }
4330       break;
4331     case AMDGPU::S_LSHR_B64:
4332       if (ST.getGeneration() >= AMDGPUSubtarget::VOLCANIC_ISLANDS) {
4333         NewOpcode = AMDGPU::V_LSHRREV_B64;
4334         swapOperands(Inst);
4335       }
4336       break;
4337 
4338     case AMDGPU::S_ABS_I32:
4339       lowerScalarAbs(Worklist, Inst);
4340       Inst.eraseFromParent();
4341       continue;
4342 
4343     case AMDGPU::S_CBRANCH_SCC0:
4344     case AMDGPU::S_CBRANCH_SCC1:
4345       // Clear unused bits of vcc
4346       BuildMI(*MBB, Inst, Inst.getDebugLoc(), get(AMDGPU::S_AND_B64),
4347               AMDGPU::VCC)
4348           .addReg(AMDGPU::EXEC)
4349           .addReg(AMDGPU::VCC);
4350       break;
4351 
4352     case AMDGPU::S_BFE_U64:
4353     case AMDGPU::S_BFM_B64:
4354       llvm_unreachable("Moving this op to VALU not implemented");
4355 
4356     case AMDGPU::S_PACK_LL_B32_B16:
4357     case AMDGPU::S_PACK_LH_B32_B16:
4358     case AMDGPU::S_PACK_HH_B32_B16:
4359       movePackToVALU(Worklist, MRI, Inst);
4360       Inst.eraseFromParent();
4361       continue;
4362 
4363     case AMDGPU::S_XNOR_B32:
4364       lowerScalarXnor(Worklist, Inst);
4365       Inst.eraseFromParent();
4366       continue;
4367 
4368     case AMDGPU::S_NAND_B32:
4369       splitScalarNotBinop(Worklist, Inst, AMDGPU::S_AND_B32);
4370       Inst.eraseFromParent();
4371       continue;
4372 
4373     case AMDGPU::S_NOR_B32:
4374       splitScalarNotBinop(Worklist, Inst, AMDGPU::S_OR_B32);
4375       Inst.eraseFromParent();
4376       continue;
4377 
4378     case AMDGPU::S_ANDN2_B32:
4379       splitScalarBinOpN2(Worklist, Inst, AMDGPU::S_AND_B32);
4380       Inst.eraseFromParent();
4381       continue;
4382 
4383     case AMDGPU::S_ORN2_B32:
4384       splitScalarBinOpN2(Worklist, Inst, AMDGPU::S_OR_B32);
4385       Inst.eraseFromParent();
4386       continue;
4387     }
4388 
4389     if (NewOpcode == AMDGPU::INSTRUCTION_LIST_END) {
4390       // We cannot move this instruction to the VALU, so we should try to
4391       // legalize its operands instead.
4392       legalizeOperands(Inst, MDT);
4393       continue;
4394     }
4395 
4396     // Use the new VALU Opcode.
4397     const MCInstrDesc &NewDesc = get(NewOpcode);
4398     Inst.setDesc(NewDesc);
4399 
4400     // Remove any references to SCC. Vector instructions can't read from it, and
4401     // We're just about to add the implicit use / defs of VCC, and we don't want
4402     // both.
4403     for (unsigned i = Inst.getNumOperands() - 1; i > 0; --i) {
4404       MachineOperand &Op = Inst.getOperand(i);
4405       if (Op.isReg() && Op.getReg() == AMDGPU::SCC) {
4406         // Only propagate through live-def of SCC.
4407         if (Op.isDef() && !Op.isDead())
4408           addSCCDefUsersToVALUWorklist(Op, Inst, Worklist);
4409         Inst.RemoveOperand(i);
4410       }
4411     }
4412 
4413     if (Opcode == AMDGPU::S_SEXT_I32_I8 || Opcode == AMDGPU::S_SEXT_I32_I16) {
4414       // We are converting these to a BFE, so we need to add the missing
4415       // operands for the size and offset.
4416       unsigned Size = (Opcode == AMDGPU::S_SEXT_I32_I8) ? 8 : 16;
4417       Inst.addOperand(MachineOperand::CreateImm(0));
4418       Inst.addOperand(MachineOperand::CreateImm(Size));
4419 
4420     } else if (Opcode == AMDGPU::S_BCNT1_I32_B32) {
4421       // The VALU version adds the second operand to the result, so insert an
4422       // extra 0 operand.
4423       Inst.addOperand(MachineOperand::CreateImm(0));
4424     }
4425 
4426     Inst.addImplicitDefUseOperands(*Inst.getParent()->getParent());
4427 
4428     if (Opcode == AMDGPU::S_BFE_I32 || Opcode == AMDGPU::S_BFE_U32) {
4429       const MachineOperand &OffsetWidthOp = Inst.getOperand(2);
4430       // If we need to move this to VGPRs, we need to unpack the second operand
4431       // back into the 2 separate ones for bit offset and width.
4432       assert(OffsetWidthOp.isImm() &&
4433              "Scalar BFE is only implemented for constant width and offset");
4434       uint32_t Imm = OffsetWidthOp.getImm();
4435 
4436       uint32_t Offset = Imm & 0x3f; // Extract bits [5:0].
4437       uint32_t BitWidth = (Imm & 0x7f0000) >> 16; // Extract bits [22:16].
4438       Inst.RemoveOperand(2);                     // Remove old immediate.
4439       Inst.addOperand(MachineOperand::CreateImm(Offset));
4440       Inst.addOperand(MachineOperand::CreateImm(BitWidth));
4441     }
4442 
4443     bool HasDst = Inst.getOperand(0).isReg() && Inst.getOperand(0).isDef();
4444     unsigned NewDstReg = AMDGPU::NoRegister;
4445     if (HasDst) {
4446       unsigned DstReg = Inst.getOperand(0).getReg();
4447       if (TargetRegisterInfo::isPhysicalRegister(DstReg))
4448         continue;
4449 
4450       // Update the destination register class.
4451       const TargetRegisterClass *NewDstRC = getDestEquivalentVGPRClass(Inst);
4452       if (!NewDstRC)
4453         continue;
4454 
4455       if (Inst.isCopy() &&
4456           TargetRegisterInfo::isVirtualRegister(Inst.getOperand(1).getReg()) &&
4457           NewDstRC == RI.getRegClassForReg(MRI, Inst.getOperand(1).getReg())) {
4458         // Instead of creating a copy where src and dst are the same register
4459         // class, we just replace all uses of dst with src.  These kinds of
4460         // copies interfere with the heuristics MachineSink uses to decide
4461         // whether or not to split a critical edge.  Since the pass assumes
4462         // that copies will end up as machine instructions and not be
4463         // eliminated.
4464         addUsersToMoveToVALUWorklist(DstReg, MRI, Worklist);
4465         MRI.replaceRegWith(DstReg, Inst.getOperand(1).getReg());
4466         MRI.clearKillFlags(Inst.getOperand(1).getReg());
4467         Inst.getOperand(0).setReg(DstReg);
4468 
4469         // Make sure we don't leave around a dead VGPR->SGPR copy. Normally
4470         // these are deleted later, but at -O0 it would leave a suspicious
4471         // looking illegal copy of an undef register.
4472         for (unsigned I = Inst.getNumOperands() - 1; I != 0; --I)
4473           Inst.RemoveOperand(I);
4474         Inst.setDesc(get(AMDGPU::IMPLICIT_DEF));
4475         continue;
4476       }
4477 
4478       NewDstReg = MRI.createVirtualRegister(NewDstRC);
4479       MRI.replaceRegWith(DstReg, NewDstReg);
4480     }
4481 
4482     // Legalize the operands
4483     legalizeOperands(Inst, MDT);
4484 
4485     if (HasDst)
4486      addUsersToMoveToVALUWorklist(NewDstReg, MRI, Worklist);
4487   }
4488 }
4489 
4490 // Add/sub require special handling to deal with carry outs.
4491 bool SIInstrInfo::moveScalarAddSub(SetVectorType &Worklist, MachineInstr &Inst,
4492                                    MachineDominatorTree *MDT) const {
4493   if (ST.hasAddNoCarry()) {
4494     // Assume there is no user of scc since we don't select this in that case.
4495     // Since scc isn't used, it doesn't really matter if the i32 or u32 variant
4496     // is used.
4497 
4498     MachineBasicBlock &MBB = *Inst.getParent();
4499     MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4500 
4501     unsigned OldDstReg = Inst.getOperand(0).getReg();
4502     unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4503 
4504     unsigned Opc = Inst.getOpcode();
4505     assert(Opc == AMDGPU::S_ADD_I32 || Opc == AMDGPU::S_SUB_I32);
4506 
4507     unsigned NewOpc = Opc == AMDGPU::S_ADD_I32 ?
4508       AMDGPU::V_ADD_U32_e64 : AMDGPU::V_SUB_U32_e64;
4509 
4510     assert(Inst.getOperand(3).getReg() == AMDGPU::SCC);
4511     Inst.RemoveOperand(3);
4512 
4513     Inst.setDesc(get(NewOpc));
4514     Inst.addOperand(MachineOperand::CreateImm(0)); // clamp bit
4515     Inst.addImplicitDefUseOperands(*MBB.getParent());
4516     MRI.replaceRegWith(OldDstReg, ResultReg);
4517     legalizeOperands(Inst, MDT);
4518 
4519     addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
4520     return true;
4521   }
4522 
4523   return false;
4524 }
4525 
4526 void SIInstrInfo::lowerScalarAbs(SetVectorType &Worklist,
4527                                  MachineInstr &Inst) const {
4528   MachineBasicBlock &MBB = *Inst.getParent();
4529   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4530   MachineBasicBlock::iterator MII = Inst;
4531   DebugLoc DL = Inst.getDebugLoc();
4532 
4533   MachineOperand &Dest = Inst.getOperand(0);
4534   MachineOperand &Src = Inst.getOperand(1);
4535   unsigned TmpReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4536   unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4537 
4538   unsigned SubOp = ST.hasAddNoCarry() ?
4539     AMDGPU::V_SUB_U32_e32 : AMDGPU::V_SUB_I32_e32;
4540 
4541   BuildMI(MBB, MII, DL, get(SubOp), TmpReg)
4542     .addImm(0)
4543     .addReg(Src.getReg());
4544 
4545   BuildMI(MBB, MII, DL, get(AMDGPU::V_MAX_I32_e64), ResultReg)
4546     .addReg(Src.getReg())
4547     .addReg(TmpReg);
4548 
4549   MRI.replaceRegWith(Dest.getReg(), ResultReg);
4550   addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
4551 }
4552 
4553 void SIInstrInfo::lowerScalarXnor(SetVectorType &Worklist,
4554                                   MachineInstr &Inst) const {
4555   MachineBasicBlock &MBB = *Inst.getParent();
4556   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4557   MachineBasicBlock::iterator MII = Inst;
4558   const DebugLoc &DL = Inst.getDebugLoc();
4559 
4560   MachineOperand &Dest = Inst.getOperand(0);
4561   MachineOperand &Src0 = Inst.getOperand(1);
4562   MachineOperand &Src1 = Inst.getOperand(2);
4563 
4564   if (ST.hasDLInsts()) {
4565     unsigned NewDest = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4566     legalizeGenericOperand(MBB, MII, &AMDGPU::VGPR_32RegClass, Src0, MRI, DL);
4567     legalizeGenericOperand(MBB, MII, &AMDGPU::VGPR_32RegClass, Src1, MRI, DL);
4568 
4569     BuildMI(MBB, MII, DL, get(AMDGPU::V_XNOR_B32_e64), NewDest)
4570       .add(Src0)
4571       .add(Src1);
4572 
4573     MRI.replaceRegWith(Dest.getReg(), NewDest);
4574     addUsersToMoveToVALUWorklist(NewDest, MRI, Worklist);
4575   } else {
4576     // Using the identity !(x ^ y) == (!x ^ y) == (x ^ !y), we can
4577     // invert either source and then perform the XOR. If either source is a
4578     // scalar register, then we can leave the inversion on the scalar unit to
4579     // acheive a better distrubution of scalar and vector instructions.
4580     bool Src0IsSGPR = Src0.isReg() &&
4581                       RI.isSGPRClass(MRI.getRegClass(Src0.getReg()));
4582     bool Src1IsSGPR = Src1.isReg() &&
4583                       RI.isSGPRClass(MRI.getRegClass(Src1.getReg()));
4584     MachineInstr *Not = nullptr;
4585     MachineInstr *Xor = nullptr;
4586     unsigned Temp = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
4587     unsigned NewDest = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
4588 
4589     // Build a pair of scalar instructions and add them to the work list.
4590     // The next iteration over the work list will lower these to the vector
4591     // unit as necessary.
4592     if (Src0IsSGPR) {
4593       Not = BuildMI(MBB, MII, DL, get(AMDGPU::S_NOT_B32), Temp)
4594         .add(Src0);
4595       Xor = BuildMI(MBB, MII, DL, get(AMDGPU::S_XOR_B32), NewDest)
4596       .addReg(Temp)
4597       .add(Src1);
4598     } else if (Src1IsSGPR) {
4599       Not = BuildMI(MBB, MII, DL, get(AMDGPU::S_NOT_B32), Temp)
4600         .add(Src1);
4601       Xor = BuildMI(MBB, MII, DL, get(AMDGPU::S_XOR_B32), NewDest)
4602       .add(Src0)
4603       .addReg(Temp);
4604     } else {
4605       Xor = BuildMI(MBB, MII, DL, get(AMDGPU::S_XOR_B32), Temp)
4606         .add(Src0)
4607         .add(Src1);
4608       Not = BuildMI(MBB, MII, DL, get(AMDGPU::S_NOT_B32), NewDest)
4609         .addReg(Temp);
4610       Worklist.insert(Not);
4611     }
4612 
4613     MRI.replaceRegWith(Dest.getReg(), NewDest);
4614 
4615     Worklist.insert(Xor);
4616 
4617     addUsersToMoveToVALUWorklist(NewDest, MRI, Worklist);
4618   }
4619 }
4620 
4621 void SIInstrInfo::splitScalarNotBinop(SetVectorType &Worklist,
4622                                       MachineInstr &Inst,
4623                                       unsigned Opcode) const {
4624   MachineBasicBlock &MBB = *Inst.getParent();
4625   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4626   MachineBasicBlock::iterator MII = Inst;
4627   const DebugLoc &DL = Inst.getDebugLoc();
4628 
4629   MachineOperand &Dest = Inst.getOperand(0);
4630   MachineOperand &Src0 = Inst.getOperand(1);
4631   MachineOperand &Src1 = Inst.getOperand(2);
4632 
4633   unsigned NewDest = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
4634   unsigned Interm = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
4635 
4636   MachineInstr &Op = *BuildMI(MBB, MII, DL, get(Opcode), Interm)
4637     .add(Src0)
4638     .add(Src1);
4639 
4640   MachineInstr &Not = *BuildMI(MBB, MII, DL, get(AMDGPU::S_NOT_B32), NewDest)
4641     .addReg(Interm);
4642 
4643   Worklist.insert(&Op);
4644   Worklist.insert(&Not);
4645 
4646   MRI.replaceRegWith(Dest.getReg(), NewDest);
4647   addUsersToMoveToVALUWorklist(NewDest, MRI, Worklist);
4648 }
4649 
4650 void SIInstrInfo::splitScalarBinOpN2(SetVectorType& Worklist,
4651                                      MachineInstr &Inst,
4652                                      unsigned Opcode) const {
4653   MachineBasicBlock &MBB = *Inst.getParent();
4654   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4655   MachineBasicBlock::iterator MII = Inst;
4656   const DebugLoc &DL = Inst.getDebugLoc();
4657 
4658   MachineOperand &Dest = Inst.getOperand(0);
4659   MachineOperand &Src0 = Inst.getOperand(1);
4660   MachineOperand &Src1 = Inst.getOperand(2);
4661 
4662   unsigned NewDest = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
4663   unsigned Interm = MRI.createVirtualRegister(&AMDGPU::SReg_32_XM0RegClass);
4664 
4665   MachineInstr &Not = *BuildMI(MBB, MII, DL, get(AMDGPU::S_NOT_B32), Interm)
4666     .add(Src1);
4667 
4668   MachineInstr &Op = *BuildMI(MBB, MII, DL, get(Opcode), NewDest)
4669     .add(Src0)
4670     .addReg(Interm);
4671 
4672   Worklist.insert(&Not);
4673   Worklist.insert(&Op);
4674 
4675   MRI.replaceRegWith(Dest.getReg(), NewDest);
4676   addUsersToMoveToVALUWorklist(NewDest, MRI, Worklist);
4677 }
4678 
4679 void SIInstrInfo::splitScalar64BitUnaryOp(
4680     SetVectorType &Worklist, MachineInstr &Inst,
4681     unsigned Opcode) const {
4682   MachineBasicBlock &MBB = *Inst.getParent();
4683   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4684 
4685   MachineOperand &Dest = Inst.getOperand(0);
4686   MachineOperand &Src0 = Inst.getOperand(1);
4687   DebugLoc DL = Inst.getDebugLoc();
4688 
4689   MachineBasicBlock::iterator MII = Inst;
4690 
4691   const MCInstrDesc &InstDesc = get(Opcode);
4692   const TargetRegisterClass *Src0RC = Src0.isReg() ?
4693     MRI.getRegClass(Src0.getReg()) :
4694     &AMDGPU::SGPR_32RegClass;
4695 
4696   const TargetRegisterClass *Src0SubRC = RI.getSubRegClass(Src0RC, AMDGPU::sub0);
4697 
4698   MachineOperand SrcReg0Sub0 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
4699                                                        AMDGPU::sub0, Src0SubRC);
4700 
4701   const TargetRegisterClass *DestRC = MRI.getRegClass(Dest.getReg());
4702   const TargetRegisterClass *NewDestRC = RI.getEquivalentVGPRClass(DestRC);
4703   const TargetRegisterClass *NewDestSubRC = RI.getSubRegClass(NewDestRC, AMDGPU::sub0);
4704 
4705   unsigned DestSub0 = MRI.createVirtualRegister(NewDestSubRC);
4706   MachineInstr &LoHalf = *BuildMI(MBB, MII, DL, InstDesc, DestSub0).add(SrcReg0Sub0);
4707 
4708   MachineOperand SrcReg0Sub1 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
4709                                                        AMDGPU::sub1, Src0SubRC);
4710 
4711   unsigned DestSub1 = MRI.createVirtualRegister(NewDestSubRC);
4712   MachineInstr &HiHalf = *BuildMI(MBB, MII, DL, InstDesc, DestSub1).add(SrcReg0Sub1);
4713 
4714   unsigned FullDestReg = MRI.createVirtualRegister(NewDestRC);
4715   BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), FullDestReg)
4716     .addReg(DestSub0)
4717     .addImm(AMDGPU::sub0)
4718     .addReg(DestSub1)
4719     .addImm(AMDGPU::sub1);
4720 
4721   MRI.replaceRegWith(Dest.getReg(), FullDestReg);
4722 
4723   Worklist.insert(&LoHalf);
4724   Worklist.insert(&HiHalf);
4725 
4726   // We don't need to legalizeOperands here because for a single operand, src0
4727   // will support any kind of input.
4728 
4729   // Move all users of this moved value.
4730   addUsersToMoveToVALUWorklist(FullDestReg, MRI, Worklist);
4731 }
4732 
4733 void SIInstrInfo::splitScalar64BitAddSub(SetVectorType &Worklist,
4734                                          MachineInstr &Inst,
4735                                          MachineDominatorTree *MDT) const {
4736   bool IsAdd = (Inst.getOpcode() == AMDGPU::S_ADD_U64_PSEUDO);
4737 
4738   MachineBasicBlock &MBB = *Inst.getParent();
4739   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4740 
4741   unsigned FullDestReg = MRI.createVirtualRegister(&AMDGPU::VReg_64RegClass);
4742   unsigned DestSub0 = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4743   unsigned DestSub1 = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4744 
4745   unsigned CarryReg = MRI.createVirtualRegister(&AMDGPU::SReg_64_XEXECRegClass);
4746   unsigned DeadCarryReg = MRI.createVirtualRegister(&AMDGPU::SReg_64_XEXECRegClass);
4747 
4748   MachineOperand &Dest = Inst.getOperand(0);
4749   MachineOperand &Src0 = Inst.getOperand(1);
4750   MachineOperand &Src1 = Inst.getOperand(2);
4751   const DebugLoc &DL = Inst.getDebugLoc();
4752   MachineBasicBlock::iterator MII = Inst;
4753 
4754   const TargetRegisterClass *Src0RC = MRI.getRegClass(Src0.getReg());
4755   const TargetRegisterClass *Src1RC = MRI.getRegClass(Src1.getReg());
4756   const TargetRegisterClass *Src0SubRC = RI.getSubRegClass(Src0RC, AMDGPU::sub0);
4757   const TargetRegisterClass *Src1SubRC = RI.getSubRegClass(Src1RC, AMDGPU::sub0);
4758 
4759   MachineOperand SrcReg0Sub0 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
4760                                                        AMDGPU::sub0, Src0SubRC);
4761   MachineOperand SrcReg1Sub0 = buildExtractSubRegOrImm(MII, MRI, Src1, Src1RC,
4762                                                        AMDGPU::sub0, Src1SubRC);
4763 
4764 
4765   MachineOperand SrcReg0Sub1 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
4766                                                        AMDGPU::sub1, Src0SubRC);
4767   MachineOperand SrcReg1Sub1 = buildExtractSubRegOrImm(MII, MRI, Src1, Src1RC,
4768                                                        AMDGPU::sub1, Src1SubRC);
4769 
4770   unsigned LoOpc = IsAdd ? AMDGPU::V_ADD_I32_e64 : AMDGPU::V_SUB_I32_e64;
4771   MachineInstr *LoHalf =
4772     BuildMI(MBB, MII, DL, get(LoOpc), DestSub0)
4773     .addReg(CarryReg, RegState::Define)
4774     .add(SrcReg0Sub0)
4775     .add(SrcReg1Sub0)
4776     .addImm(0); // clamp bit
4777 
4778   unsigned HiOpc = IsAdd ? AMDGPU::V_ADDC_U32_e64 : AMDGPU::V_SUBB_U32_e64;
4779   MachineInstr *HiHalf =
4780     BuildMI(MBB, MII, DL, get(HiOpc), DestSub1)
4781     .addReg(DeadCarryReg, RegState::Define | RegState::Dead)
4782     .add(SrcReg0Sub1)
4783     .add(SrcReg1Sub1)
4784     .addReg(CarryReg, RegState::Kill)
4785     .addImm(0); // clamp bit
4786 
4787   BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), FullDestReg)
4788     .addReg(DestSub0)
4789     .addImm(AMDGPU::sub0)
4790     .addReg(DestSub1)
4791     .addImm(AMDGPU::sub1);
4792 
4793   MRI.replaceRegWith(Dest.getReg(), FullDestReg);
4794 
4795   // Try to legalize the operands in case we need to swap the order to keep it
4796   // valid.
4797   legalizeOperands(*LoHalf, MDT);
4798   legalizeOperands(*HiHalf, MDT);
4799 
4800   // Move all users of this moved vlaue.
4801   addUsersToMoveToVALUWorklist(FullDestReg, MRI, Worklist);
4802 }
4803 
4804 void SIInstrInfo::splitScalar64BitBinaryOp(SetVectorType &Worklist,
4805                                            MachineInstr &Inst, unsigned Opcode,
4806                                            MachineDominatorTree *MDT) const {
4807   MachineBasicBlock &MBB = *Inst.getParent();
4808   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4809 
4810   MachineOperand &Dest = Inst.getOperand(0);
4811   MachineOperand &Src0 = Inst.getOperand(1);
4812   MachineOperand &Src1 = Inst.getOperand(2);
4813   DebugLoc DL = Inst.getDebugLoc();
4814 
4815   MachineBasicBlock::iterator MII = Inst;
4816 
4817   const MCInstrDesc &InstDesc = get(Opcode);
4818   const TargetRegisterClass *Src0RC = Src0.isReg() ?
4819     MRI.getRegClass(Src0.getReg()) :
4820     &AMDGPU::SGPR_32RegClass;
4821 
4822   const TargetRegisterClass *Src0SubRC = RI.getSubRegClass(Src0RC, AMDGPU::sub0);
4823   const TargetRegisterClass *Src1RC = Src1.isReg() ?
4824     MRI.getRegClass(Src1.getReg()) :
4825     &AMDGPU::SGPR_32RegClass;
4826 
4827   const TargetRegisterClass *Src1SubRC = RI.getSubRegClass(Src1RC, AMDGPU::sub0);
4828 
4829   MachineOperand SrcReg0Sub0 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
4830                                                        AMDGPU::sub0, Src0SubRC);
4831   MachineOperand SrcReg1Sub0 = buildExtractSubRegOrImm(MII, MRI, Src1, Src1RC,
4832                                                        AMDGPU::sub0, Src1SubRC);
4833   MachineOperand SrcReg0Sub1 = buildExtractSubRegOrImm(MII, MRI, Src0, Src0RC,
4834                                                        AMDGPU::sub1, Src0SubRC);
4835   MachineOperand SrcReg1Sub1 = buildExtractSubRegOrImm(MII, MRI, Src1, Src1RC,
4836                                                        AMDGPU::sub1, Src1SubRC);
4837 
4838   const TargetRegisterClass *DestRC = MRI.getRegClass(Dest.getReg());
4839   const TargetRegisterClass *NewDestRC = RI.getEquivalentVGPRClass(DestRC);
4840   const TargetRegisterClass *NewDestSubRC = RI.getSubRegClass(NewDestRC, AMDGPU::sub0);
4841 
4842   unsigned DestSub0 = MRI.createVirtualRegister(NewDestSubRC);
4843   MachineInstr &LoHalf = *BuildMI(MBB, MII, DL, InstDesc, DestSub0)
4844                               .add(SrcReg0Sub0)
4845                               .add(SrcReg1Sub0);
4846 
4847   unsigned DestSub1 = MRI.createVirtualRegister(NewDestSubRC);
4848   MachineInstr &HiHalf = *BuildMI(MBB, MII, DL, InstDesc, DestSub1)
4849                               .add(SrcReg0Sub1)
4850                               .add(SrcReg1Sub1);
4851 
4852   unsigned FullDestReg = MRI.createVirtualRegister(NewDestRC);
4853   BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), FullDestReg)
4854     .addReg(DestSub0)
4855     .addImm(AMDGPU::sub0)
4856     .addReg(DestSub1)
4857     .addImm(AMDGPU::sub1);
4858 
4859   MRI.replaceRegWith(Dest.getReg(), FullDestReg);
4860 
4861   Worklist.insert(&LoHalf);
4862   Worklist.insert(&HiHalf);
4863 
4864   // Move all users of this moved vlaue.
4865   addUsersToMoveToVALUWorklist(FullDestReg, MRI, Worklist);
4866 }
4867 
4868 void SIInstrInfo::splitScalar64BitXnor(SetVectorType &Worklist,
4869                                        MachineInstr &Inst,
4870                                        MachineDominatorTree *MDT) const {
4871   MachineBasicBlock &MBB = *Inst.getParent();
4872   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4873 
4874   MachineOperand &Dest = Inst.getOperand(0);
4875   MachineOperand &Src0 = Inst.getOperand(1);
4876   MachineOperand &Src1 = Inst.getOperand(2);
4877   const DebugLoc &DL = Inst.getDebugLoc();
4878 
4879   MachineBasicBlock::iterator MII = Inst;
4880 
4881   const TargetRegisterClass *DestRC = MRI.getRegClass(Dest.getReg());
4882 
4883   unsigned Interm = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
4884 
4885   MachineOperand* Op0;
4886   MachineOperand* Op1;
4887 
4888   if (Src0.isReg() && RI.isSGPRReg(MRI, Src0.getReg())) {
4889     Op0 = &Src0;
4890     Op1 = &Src1;
4891   } else {
4892     Op0 = &Src1;
4893     Op1 = &Src0;
4894   }
4895 
4896   BuildMI(MBB, MII, DL, get(AMDGPU::S_NOT_B64), Interm)
4897     .add(*Op0);
4898 
4899   unsigned NewDest = MRI.createVirtualRegister(DestRC);
4900 
4901   MachineInstr &Xor = *BuildMI(MBB, MII, DL, get(AMDGPU::S_XOR_B64), NewDest)
4902     .addReg(Interm)
4903     .add(*Op1);
4904 
4905   MRI.replaceRegWith(Dest.getReg(), NewDest);
4906 
4907   Worklist.insert(&Xor);
4908 }
4909 
4910 void SIInstrInfo::splitScalar64BitBCNT(
4911     SetVectorType &Worklist, MachineInstr &Inst) const {
4912   MachineBasicBlock &MBB = *Inst.getParent();
4913   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4914 
4915   MachineBasicBlock::iterator MII = Inst;
4916   const DebugLoc &DL = Inst.getDebugLoc();
4917 
4918   MachineOperand &Dest = Inst.getOperand(0);
4919   MachineOperand &Src = Inst.getOperand(1);
4920 
4921   const MCInstrDesc &InstDesc = get(AMDGPU::V_BCNT_U32_B32_e64);
4922   const TargetRegisterClass *SrcRC = Src.isReg() ?
4923     MRI.getRegClass(Src.getReg()) :
4924     &AMDGPU::SGPR_32RegClass;
4925 
4926   unsigned MidReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4927   unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4928 
4929   const TargetRegisterClass *SrcSubRC = RI.getSubRegClass(SrcRC, AMDGPU::sub0);
4930 
4931   MachineOperand SrcRegSub0 = buildExtractSubRegOrImm(MII, MRI, Src, SrcRC,
4932                                                       AMDGPU::sub0, SrcSubRC);
4933   MachineOperand SrcRegSub1 = buildExtractSubRegOrImm(MII, MRI, Src, SrcRC,
4934                                                       AMDGPU::sub1, SrcSubRC);
4935 
4936   BuildMI(MBB, MII, DL, InstDesc, MidReg).add(SrcRegSub0).addImm(0);
4937 
4938   BuildMI(MBB, MII, DL, InstDesc, ResultReg).add(SrcRegSub1).addReg(MidReg);
4939 
4940   MRI.replaceRegWith(Dest.getReg(), ResultReg);
4941 
4942   // We don't need to legalize operands here. src0 for etiher instruction can be
4943   // an SGPR, and the second input is unused or determined here.
4944   addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
4945 }
4946 
4947 void SIInstrInfo::splitScalar64BitBFE(SetVectorType &Worklist,
4948                                       MachineInstr &Inst) const {
4949   MachineBasicBlock &MBB = *Inst.getParent();
4950   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
4951   MachineBasicBlock::iterator MII = Inst;
4952   const DebugLoc &DL = Inst.getDebugLoc();
4953 
4954   MachineOperand &Dest = Inst.getOperand(0);
4955   uint32_t Imm = Inst.getOperand(2).getImm();
4956   uint32_t Offset = Imm & 0x3f; // Extract bits [5:0].
4957   uint32_t BitWidth = (Imm & 0x7f0000) >> 16; // Extract bits [22:16].
4958 
4959   (void) Offset;
4960 
4961   // Only sext_inreg cases handled.
4962   assert(Inst.getOpcode() == AMDGPU::S_BFE_I64 && BitWidth <= 32 &&
4963          Offset == 0 && "Not implemented");
4964 
4965   if (BitWidth < 32) {
4966     unsigned MidRegLo = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4967     unsigned MidRegHi = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4968     unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VReg_64RegClass);
4969 
4970     BuildMI(MBB, MII, DL, get(AMDGPU::V_BFE_I32), MidRegLo)
4971         .addReg(Inst.getOperand(1).getReg(), 0, AMDGPU::sub0)
4972         .addImm(0)
4973         .addImm(BitWidth);
4974 
4975     BuildMI(MBB, MII, DL, get(AMDGPU::V_ASHRREV_I32_e32), MidRegHi)
4976       .addImm(31)
4977       .addReg(MidRegLo);
4978 
4979     BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), ResultReg)
4980       .addReg(MidRegLo)
4981       .addImm(AMDGPU::sub0)
4982       .addReg(MidRegHi)
4983       .addImm(AMDGPU::sub1);
4984 
4985     MRI.replaceRegWith(Dest.getReg(), ResultReg);
4986     addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
4987     return;
4988   }
4989 
4990   MachineOperand &Src = Inst.getOperand(1);
4991   unsigned TmpReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
4992   unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VReg_64RegClass);
4993 
4994   BuildMI(MBB, MII, DL, get(AMDGPU::V_ASHRREV_I32_e64), TmpReg)
4995     .addImm(31)
4996     .addReg(Src.getReg(), 0, AMDGPU::sub0);
4997 
4998   BuildMI(MBB, MII, DL, get(TargetOpcode::REG_SEQUENCE), ResultReg)
4999     .addReg(Src.getReg(), 0, AMDGPU::sub0)
5000     .addImm(AMDGPU::sub0)
5001     .addReg(TmpReg)
5002     .addImm(AMDGPU::sub1);
5003 
5004   MRI.replaceRegWith(Dest.getReg(), ResultReg);
5005   addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
5006 }
5007 
5008 void SIInstrInfo::addUsersToMoveToVALUWorklist(
5009   unsigned DstReg,
5010   MachineRegisterInfo &MRI,
5011   SetVectorType &Worklist) const {
5012   for (MachineRegisterInfo::use_iterator I = MRI.use_begin(DstReg),
5013          E = MRI.use_end(); I != E;) {
5014     MachineInstr &UseMI = *I->getParent();
5015 
5016     unsigned OpNo = 0;
5017 
5018     switch (UseMI.getOpcode()) {
5019     case AMDGPU::COPY:
5020     case AMDGPU::WQM:
5021     case AMDGPU::WWM:
5022     case AMDGPU::REG_SEQUENCE:
5023     case AMDGPU::PHI:
5024     case AMDGPU::INSERT_SUBREG:
5025       break;
5026     default:
5027       OpNo = I.getOperandNo();
5028       break;
5029     }
5030 
5031     if (!RI.hasVGPRs(getOpRegClass(UseMI, OpNo))) {
5032       Worklist.insert(&UseMI);
5033 
5034       do {
5035         ++I;
5036       } while (I != E && I->getParent() == &UseMI);
5037     } else {
5038       ++I;
5039     }
5040   }
5041 }
5042 
5043 void SIInstrInfo::movePackToVALU(SetVectorType &Worklist,
5044                                  MachineRegisterInfo &MRI,
5045                                  MachineInstr &Inst) const {
5046   unsigned ResultReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5047   MachineBasicBlock *MBB = Inst.getParent();
5048   MachineOperand &Src0 = Inst.getOperand(1);
5049   MachineOperand &Src1 = Inst.getOperand(2);
5050   const DebugLoc &DL = Inst.getDebugLoc();
5051 
5052   switch (Inst.getOpcode()) {
5053   case AMDGPU::S_PACK_LL_B32_B16: {
5054     unsigned ImmReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5055     unsigned TmpReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5056 
5057     // FIXME: Can do a lot better if we know the high bits of src0 or src1 are
5058     // 0.
5059     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_MOV_B32_e32), ImmReg)
5060       .addImm(0xffff);
5061 
5062     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_AND_B32_e64), TmpReg)
5063       .addReg(ImmReg, RegState::Kill)
5064       .add(Src0);
5065 
5066     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_LSHL_OR_B32), ResultReg)
5067       .add(Src1)
5068       .addImm(16)
5069       .addReg(TmpReg, RegState::Kill);
5070     break;
5071   }
5072   case AMDGPU::S_PACK_LH_B32_B16: {
5073     unsigned ImmReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5074     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_MOV_B32_e32), ImmReg)
5075       .addImm(0xffff);
5076     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_BFI_B32), ResultReg)
5077       .addReg(ImmReg, RegState::Kill)
5078       .add(Src0)
5079       .add(Src1);
5080     break;
5081   }
5082   case AMDGPU::S_PACK_HH_B32_B16: {
5083     unsigned ImmReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5084     unsigned TmpReg = MRI.createVirtualRegister(&AMDGPU::VGPR_32RegClass);
5085     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_LSHRREV_B32_e64), TmpReg)
5086       .addImm(16)
5087       .add(Src0);
5088     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_MOV_B32_e32), ImmReg)
5089       .addImm(0xffff0000);
5090     BuildMI(*MBB, Inst, DL, get(AMDGPU::V_AND_OR_B32), ResultReg)
5091       .add(Src1)
5092       .addReg(ImmReg, RegState::Kill)
5093       .addReg(TmpReg, RegState::Kill);
5094     break;
5095   }
5096   default:
5097     llvm_unreachable("unhandled s_pack_* instruction");
5098   }
5099 
5100   MachineOperand &Dest = Inst.getOperand(0);
5101   MRI.replaceRegWith(Dest.getReg(), ResultReg);
5102   addUsersToMoveToVALUWorklist(ResultReg, MRI, Worklist);
5103 }
5104 
5105 void SIInstrInfo::addSCCDefUsersToVALUWorklist(MachineOperand &Op,
5106                                                MachineInstr &SCCDefInst,
5107                                                SetVectorType &Worklist) const {
5108   // Ensure that def inst defines SCC, which is still live.
5109   assert(Op.isReg() && Op.getReg() == AMDGPU::SCC && Op.isDef() &&
5110          !Op.isDead() && Op.getParent() == &SCCDefInst);
5111   // This assumes that all the users of SCC are in the same block
5112   // as the SCC def.
5113   for (MachineInstr &MI : // Skip the def inst itself.
5114        make_range(std::next(MachineBasicBlock::iterator(SCCDefInst)),
5115                   SCCDefInst.getParent()->end())) {
5116     // Check if SCC is used first.
5117     if (MI.findRegisterUseOperandIdx(AMDGPU::SCC, false, &RI) != -1)
5118       Worklist.insert(&MI);
5119     // Exit if we find another SCC def.
5120     if (MI.findRegisterDefOperandIdx(AMDGPU::SCC, false, false, &RI) != -1)
5121       return;
5122   }
5123 }
5124 
5125 const TargetRegisterClass *SIInstrInfo::getDestEquivalentVGPRClass(
5126   const MachineInstr &Inst) const {
5127   const TargetRegisterClass *NewDstRC = getOpRegClass(Inst, 0);
5128 
5129   switch (Inst.getOpcode()) {
5130   // For target instructions, getOpRegClass just returns the virtual register
5131   // class associated with the operand, so we need to find an equivalent VGPR
5132   // register class in order to move the instruction to the VALU.
5133   case AMDGPU::COPY:
5134   case AMDGPU::PHI:
5135   case AMDGPU::REG_SEQUENCE:
5136   case AMDGPU::INSERT_SUBREG:
5137   case AMDGPU::WQM:
5138   case AMDGPU::WWM:
5139     if (RI.hasVGPRs(NewDstRC))
5140       return nullptr;
5141 
5142     NewDstRC = RI.getEquivalentVGPRClass(NewDstRC);
5143     if (!NewDstRC)
5144       return nullptr;
5145     return NewDstRC;
5146   default:
5147     return NewDstRC;
5148   }
5149 }
5150 
5151 // Find the one SGPR operand we are allowed to use.
5152 unsigned SIInstrInfo::findUsedSGPR(const MachineInstr &MI,
5153                                    int OpIndices[3]) const {
5154   const MCInstrDesc &Desc = MI.getDesc();
5155 
5156   // Find the one SGPR operand we are allowed to use.
5157   //
5158   // First we need to consider the instruction's operand requirements before
5159   // legalizing. Some operands are required to be SGPRs, such as implicit uses
5160   // of VCC, but we are still bound by the constant bus requirement to only use
5161   // one.
5162   //
5163   // If the operand's class is an SGPR, we can never move it.
5164 
5165   unsigned SGPRReg = findImplicitSGPRRead(MI);
5166   if (SGPRReg != AMDGPU::NoRegister)
5167     return SGPRReg;
5168 
5169   unsigned UsedSGPRs[3] = { AMDGPU::NoRegister };
5170   const MachineRegisterInfo &MRI = MI.getParent()->getParent()->getRegInfo();
5171 
5172   for (unsigned i = 0; i < 3; ++i) {
5173     int Idx = OpIndices[i];
5174     if (Idx == -1)
5175       break;
5176 
5177     const MachineOperand &MO = MI.getOperand(Idx);
5178     if (!MO.isReg())
5179       continue;
5180 
5181     // Is this operand statically required to be an SGPR based on the operand
5182     // constraints?
5183     const TargetRegisterClass *OpRC = RI.getRegClass(Desc.OpInfo[Idx].RegClass);
5184     bool IsRequiredSGPR = RI.isSGPRClass(OpRC);
5185     if (IsRequiredSGPR)
5186       return MO.getReg();
5187 
5188     // If this could be a VGPR or an SGPR, Check the dynamic register class.
5189     unsigned Reg = MO.getReg();
5190     const TargetRegisterClass *RegRC = MRI.getRegClass(Reg);
5191     if (RI.isSGPRClass(RegRC))
5192       UsedSGPRs[i] = Reg;
5193   }
5194 
5195   // We don't have a required SGPR operand, so we have a bit more freedom in
5196   // selecting operands to move.
5197 
5198   // Try to select the most used SGPR. If an SGPR is equal to one of the
5199   // others, we choose that.
5200   //
5201   // e.g.
5202   // V_FMA_F32 v0, s0, s0, s0 -> No moves
5203   // V_FMA_F32 v0, s0, s1, s0 -> Move s1
5204 
5205   // TODO: If some of the operands are 64-bit SGPRs and some 32, we should
5206   // prefer those.
5207 
5208   if (UsedSGPRs[0] != AMDGPU::NoRegister) {
5209     if (UsedSGPRs[0] == UsedSGPRs[1] || UsedSGPRs[0] == UsedSGPRs[2])
5210       SGPRReg = UsedSGPRs[0];
5211   }
5212 
5213   if (SGPRReg == AMDGPU::NoRegister && UsedSGPRs[1] != AMDGPU::NoRegister) {
5214     if (UsedSGPRs[1] == UsedSGPRs[2])
5215       SGPRReg = UsedSGPRs[1];
5216   }
5217 
5218   return SGPRReg;
5219 }
5220 
5221 MachineOperand *SIInstrInfo::getNamedOperand(MachineInstr &MI,
5222                                              unsigned OperandName) const {
5223   int Idx = AMDGPU::getNamedOperandIdx(MI.getOpcode(), OperandName);
5224   if (Idx == -1)
5225     return nullptr;
5226 
5227   return &MI.getOperand(Idx);
5228 }
5229 
5230 uint64_t SIInstrInfo::getDefaultRsrcDataFormat() const {
5231   uint64_t RsrcDataFormat = AMDGPU::RSRC_DATA_FORMAT;
5232   if (ST.isAmdHsaOS()) {
5233     // Set ATC = 1. GFX9 doesn't have this bit.
5234     if (ST.getGeneration() <= AMDGPUSubtarget::VOLCANIC_ISLANDS)
5235       RsrcDataFormat |= (1ULL << 56);
5236 
5237     // Set MTYPE = 2 (MTYPE_UC = uncached). GFX9 doesn't have this.
5238     // BTW, it disables TC L2 and therefore decreases performance.
5239     if (ST.getGeneration() == AMDGPUSubtarget::VOLCANIC_ISLANDS)
5240       RsrcDataFormat |= (2ULL << 59);
5241   }
5242 
5243   return RsrcDataFormat;
5244 }
5245 
5246 uint64_t SIInstrInfo::getScratchRsrcWords23() const {
5247   uint64_t Rsrc23 = getDefaultRsrcDataFormat() |
5248                     AMDGPU::RSRC_TID_ENABLE |
5249                     0xffffffff; // Size;
5250 
5251   // GFX9 doesn't have ELEMENT_SIZE.
5252   if (ST.getGeneration() <= AMDGPUSubtarget::VOLCANIC_ISLANDS) {
5253     uint64_t EltSizeValue = Log2_32(ST.getMaxPrivateElementSize()) - 1;
5254     Rsrc23 |= EltSizeValue << AMDGPU::RSRC_ELEMENT_SIZE_SHIFT;
5255   }
5256 
5257   // IndexStride = 64.
5258   Rsrc23 |= UINT64_C(3) << AMDGPU::RSRC_INDEX_STRIDE_SHIFT;
5259 
5260   // If TID_ENABLE is set, DATA_FORMAT specifies stride bits [14:17].
5261   // Clear them unless we want a huge stride.
5262   if (ST.getGeneration() >= AMDGPUSubtarget::VOLCANIC_ISLANDS)
5263     Rsrc23 &= ~AMDGPU::RSRC_DATA_FORMAT;
5264 
5265   return Rsrc23;
5266 }
5267 
5268 bool SIInstrInfo::isLowLatencyInstruction(const MachineInstr &MI) const {
5269   unsigned Opc = MI.getOpcode();
5270 
5271   return isSMRD(Opc);
5272 }
5273 
5274 bool SIInstrInfo::isHighLatencyInstruction(const MachineInstr &MI) const {
5275   unsigned Opc = MI.getOpcode();
5276 
5277   return isMUBUF(Opc) || isMTBUF(Opc) || isMIMG(Opc);
5278 }
5279 
5280 unsigned SIInstrInfo::isStackAccess(const MachineInstr &MI,
5281                                     int &FrameIndex) const {
5282   const MachineOperand *Addr = getNamedOperand(MI, AMDGPU::OpName::vaddr);
5283   if (!Addr || !Addr->isFI())
5284     return AMDGPU::NoRegister;
5285 
5286   assert(!MI.memoperands_empty() &&
5287          (*MI.memoperands_begin())->getAddrSpace() == AMDGPUAS::PRIVATE_ADDRESS);
5288 
5289   FrameIndex = Addr->getIndex();
5290   return getNamedOperand(MI, AMDGPU::OpName::vdata)->getReg();
5291 }
5292 
5293 unsigned SIInstrInfo::isSGPRStackAccess(const MachineInstr &MI,
5294                                         int &FrameIndex) const {
5295   const MachineOperand *Addr = getNamedOperand(MI, AMDGPU::OpName::addr);
5296   assert(Addr && Addr->isFI());
5297   FrameIndex = Addr->getIndex();
5298   return getNamedOperand(MI, AMDGPU::OpName::data)->getReg();
5299 }
5300 
5301 unsigned SIInstrInfo::isLoadFromStackSlot(const MachineInstr &MI,
5302                                           int &FrameIndex) const {
5303   if (!MI.mayLoad())
5304     return AMDGPU::NoRegister;
5305 
5306   if (isMUBUF(MI) || isVGPRSpill(MI))
5307     return isStackAccess(MI, FrameIndex);
5308 
5309   if (isSGPRSpill(MI))
5310     return isSGPRStackAccess(MI, FrameIndex);
5311 
5312   return AMDGPU::NoRegister;
5313 }
5314 
5315 unsigned SIInstrInfo::isStoreToStackSlot(const MachineInstr &MI,
5316                                          int &FrameIndex) const {
5317   if (!MI.mayStore())
5318     return AMDGPU::NoRegister;
5319 
5320   if (isMUBUF(MI) || isVGPRSpill(MI))
5321     return isStackAccess(MI, FrameIndex);
5322 
5323   if (isSGPRSpill(MI))
5324     return isSGPRStackAccess(MI, FrameIndex);
5325 
5326   return AMDGPU::NoRegister;
5327 }
5328 
5329 unsigned SIInstrInfo::getInstBundleSize(const MachineInstr &MI) const {
5330   unsigned Size = 0;
5331   MachineBasicBlock::const_instr_iterator I = MI.getIterator();
5332   MachineBasicBlock::const_instr_iterator E = MI.getParent()->instr_end();
5333   while (++I != E && I->isInsideBundle()) {
5334     assert(!I->isBundle() && "No nested bundle!");
5335     Size += getInstSizeInBytes(*I);
5336   }
5337 
5338   return Size;
5339 }
5340 
5341 unsigned SIInstrInfo::getInstSizeInBytes(const MachineInstr &MI) const {
5342   unsigned Opc = MI.getOpcode();
5343   const MCInstrDesc &Desc = getMCOpcodeFromPseudo(Opc);
5344   unsigned DescSize = Desc.getSize();
5345 
5346   // If we have a definitive size, we can use it. Otherwise we need to inspect
5347   // the operands to know the size.
5348   if (isFixedSize(MI))
5349     return DescSize;
5350 
5351   // 4-byte instructions may have a 32-bit literal encoded after them. Check
5352   // operands that coud ever be literals.
5353   if (isVALU(MI) || isSALU(MI)) {
5354     int Src0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0);
5355     if (Src0Idx == -1)
5356       return DescSize; // No operands.
5357 
5358     if (isLiteralConstantLike(MI.getOperand(Src0Idx), Desc.OpInfo[Src0Idx]))
5359       return DescSize + 4;
5360 
5361     int Src1Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1);
5362     if (Src1Idx == -1)
5363       return DescSize;
5364 
5365     if (isLiteralConstantLike(MI.getOperand(Src1Idx), Desc.OpInfo[Src1Idx]))
5366       return DescSize + 4;
5367 
5368     int Src2Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2);
5369     if (Src2Idx == -1)
5370       return DescSize;
5371 
5372     if (isLiteralConstantLike(MI.getOperand(Src2Idx), Desc.OpInfo[Src2Idx]))
5373       return DescSize + 4;
5374 
5375     return DescSize;
5376   }
5377 
5378   switch (Opc) {
5379   case TargetOpcode::IMPLICIT_DEF:
5380   case TargetOpcode::KILL:
5381   case TargetOpcode::DBG_VALUE:
5382   case TargetOpcode::EH_LABEL:
5383     return 0;
5384   case TargetOpcode::BUNDLE:
5385     return getInstBundleSize(MI);
5386   case TargetOpcode::INLINEASM:
5387   case TargetOpcode::INLINEASM_BR: {
5388     const MachineFunction *MF = MI.getParent()->getParent();
5389     const char *AsmStr = MI.getOperand(0).getSymbolName();
5390     return getInlineAsmLength(AsmStr, *MF->getTarget().getMCAsmInfo());
5391   }
5392   default:
5393     return DescSize;
5394   }
5395 }
5396 
5397 bool SIInstrInfo::mayAccessFlatAddressSpace(const MachineInstr &MI) const {
5398   if (!isFLAT(MI))
5399     return false;
5400 
5401   if (MI.memoperands_empty())
5402     return true;
5403 
5404   for (const MachineMemOperand *MMO : MI.memoperands()) {
5405     if (MMO->getAddrSpace() == AMDGPUAS::FLAT_ADDRESS)
5406       return true;
5407   }
5408   return false;
5409 }
5410 
5411 bool SIInstrInfo::isNonUniformBranchInstr(MachineInstr &Branch) const {
5412   return Branch.getOpcode() == AMDGPU::SI_NON_UNIFORM_BRCOND_PSEUDO;
5413 }
5414 
5415 void SIInstrInfo::convertNonUniformIfRegion(MachineBasicBlock *IfEntry,
5416                                             MachineBasicBlock *IfEnd) const {
5417   MachineBasicBlock::iterator TI = IfEntry->getFirstTerminator();
5418   assert(TI != IfEntry->end());
5419 
5420   MachineInstr *Branch = &(*TI);
5421   MachineFunction *MF = IfEntry->getParent();
5422   MachineRegisterInfo &MRI = IfEntry->getParent()->getRegInfo();
5423 
5424   if (Branch->getOpcode() == AMDGPU::SI_NON_UNIFORM_BRCOND_PSEUDO) {
5425     unsigned DstReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
5426     MachineInstr *SIIF =
5427         BuildMI(*MF, Branch->getDebugLoc(), get(AMDGPU::SI_IF), DstReg)
5428             .add(Branch->getOperand(0))
5429             .add(Branch->getOperand(1));
5430     MachineInstr *SIEND =
5431         BuildMI(*MF, Branch->getDebugLoc(), get(AMDGPU::SI_END_CF))
5432             .addReg(DstReg);
5433 
5434     IfEntry->erase(TI);
5435     IfEntry->insert(IfEntry->end(), SIIF);
5436     IfEnd->insert(IfEnd->getFirstNonPHI(), SIEND);
5437   }
5438 }
5439 
5440 void SIInstrInfo::convertNonUniformLoopRegion(
5441     MachineBasicBlock *LoopEntry, MachineBasicBlock *LoopEnd) const {
5442   MachineBasicBlock::iterator TI = LoopEnd->getFirstTerminator();
5443   // We expect 2 terminators, one conditional and one unconditional.
5444   assert(TI != LoopEnd->end());
5445 
5446   MachineInstr *Branch = &(*TI);
5447   MachineFunction *MF = LoopEnd->getParent();
5448   MachineRegisterInfo &MRI = LoopEnd->getParent()->getRegInfo();
5449 
5450   if (Branch->getOpcode() == AMDGPU::SI_NON_UNIFORM_BRCOND_PSEUDO) {
5451 
5452     unsigned DstReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
5453     unsigned BackEdgeReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
5454     MachineInstrBuilder HeaderPHIBuilder =
5455         BuildMI(*(MF), Branch->getDebugLoc(), get(TargetOpcode::PHI), DstReg);
5456     for (MachineBasicBlock::pred_iterator PI = LoopEntry->pred_begin(),
5457                                           E = LoopEntry->pred_end();
5458          PI != E; ++PI) {
5459       if (*PI == LoopEnd) {
5460         HeaderPHIBuilder.addReg(BackEdgeReg);
5461       } else {
5462         MachineBasicBlock *PMBB = *PI;
5463         unsigned ZeroReg = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
5464         materializeImmediate(*PMBB, PMBB->getFirstTerminator(), DebugLoc(),
5465                              ZeroReg, 0);
5466         HeaderPHIBuilder.addReg(ZeroReg);
5467       }
5468       HeaderPHIBuilder.addMBB(*PI);
5469     }
5470     MachineInstr *HeaderPhi = HeaderPHIBuilder;
5471     MachineInstr *SIIFBREAK = BuildMI(*(MF), Branch->getDebugLoc(),
5472                                       get(AMDGPU::SI_IF_BREAK), BackEdgeReg)
5473                                   .addReg(DstReg)
5474                                   .add(Branch->getOperand(0));
5475     MachineInstr *SILOOP =
5476         BuildMI(*(MF), Branch->getDebugLoc(), get(AMDGPU::SI_LOOP))
5477             .addReg(BackEdgeReg)
5478             .addMBB(LoopEntry);
5479 
5480     LoopEntry->insert(LoopEntry->begin(), HeaderPhi);
5481     LoopEnd->erase(TI);
5482     LoopEnd->insert(LoopEnd->end(), SIIFBREAK);
5483     LoopEnd->insert(LoopEnd->end(), SILOOP);
5484   }
5485 }
5486 
5487 ArrayRef<std::pair<int, const char *>>
5488 SIInstrInfo::getSerializableTargetIndices() const {
5489   static const std::pair<int, const char *> TargetIndices[] = {
5490       {AMDGPU::TI_CONSTDATA_START, "amdgpu-constdata-start"},
5491       {AMDGPU::TI_SCRATCH_RSRC_DWORD0, "amdgpu-scratch-rsrc-dword0"},
5492       {AMDGPU::TI_SCRATCH_RSRC_DWORD1, "amdgpu-scratch-rsrc-dword1"},
5493       {AMDGPU::TI_SCRATCH_RSRC_DWORD2, "amdgpu-scratch-rsrc-dword2"},
5494       {AMDGPU::TI_SCRATCH_RSRC_DWORD3, "amdgpu-scratch-rsrc-dword3"}};
5495   return makeArrayRef(TargetIndices);
5496 }
5497 
5498 /// This is used by the post-RA scheduler (SchedulePostRAList.cpp).  The
5499 /// post-RA version of misched uses CreateTargetMIHazardRecognizer.
5500 ScheduleHazardRecognizer *
5501 SIInstrInfo::CreateTargetPostRAHazardRecognizer(const InstrItineraryData *II,
5502                                             const ScheduleDAG *DAG) const {
5503   return new GCNHazardRecognizer(DAG->MF);
5504 }
5505 
5506 /// This is the hazard recognizer used at -O0 by the PostRAHazardRecognizer
5507 /// pass.
5508 ScheduleHazardRecognizer *
5509 SIInstrInfo::CreateTargetPostRAHazardRecognizer(const MachineFunction &MF) const {
5510   return new GCNHazardRecognizer(MF);
5511 }
5512 
5513 std::pair<unsigned, unsigned>
5514 SIInstrInfo::decomposeMachineOperandsTargetFlags(unsigned TF) const {
5515   return std::make_pair(TF & MO_MASK, TF & ~MO_MASK);
5516 }
5517 
5518 ArrayRef<std::pair<unsigned, const char *>>
5519 SIInstrInfo::getSerializableDirectMachineOperandTargetFlags() const {
5520   static const std::pair<unsigned, const char *> TargetFlags[] = {
5521     { MO_GOTPCREL, "amdgpu-gotprel" },
5522     { MO_GOTPCREL32_LO, "amdgpu-gotprel32-lo" },
5523     { MO_GOTPCREL32_HI, "amdgpu-gotprel32-hi" },
5524     { MO_REL32_LO, "amdgpu-rel32-lo" },
5525     { MO_REL32_HI, "amdgpu-rel32-hi" }
5526   };
5527 
5528   return makeArrayRef(TargetFlags);
5529 }
5530 
5531 bool SIInstrInfo::isBasicBlockPrologue(const MachineInstr &MI) const {
5532   return !MI.isTerminator() && MI.getOpcode() != AMDGPU::COPY &&
5533          MI.modifiesRegister(AMDGPU::EXEC, &RI);
5534 }
5535 
5536 MachineInstrBuilder
5537 SIInstrInfo::getAddNoCarry(MachineBasicBlock &MBB,
5538                            MachineBasicBlock::iterator I,
5539                            const DebugLoc &DL,
5540                            unsigned DestReg) const {
5541   if (ST.hasAddNoCarry())
5542     return BuildMI(MBB, I, DL, get(AMDGPU::V_ADD_U32_e64), DestReg);
5543 
5544   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
5545   unsigned UnusedCarry = MRI.createVirtualRegister(&AMDGPU::SReg_64RegClass);
5546   MRI.setRegAllocationHint(UnusedCarry, 0, AMDGPU::VCC);
5547 
5548   return BuildMI(MBB, I, DL, get(AMDGPU::V_ADD_I32_e64), DestReg)
5549            .addReg(UnusedCarry, RegState::Define | RegState::Dead);
5550 }
5551 
5552 bool SIInstrInfo::isKillTerminator(unsigned Opcode) {
5553   switch (Opcode) {
5554   case AMDGPU::SI_KILL_F32_COND_IMM_TERMINATOR:
5555   case AMDGPU::SI_KILL_I1_TERMINATOR:
5556     return true;
5557   default:
5558     return false;
5559   }
5560 }
5561 
5562 const MCInstrDesc &SIInstrInfo::getKillTerminatorFromPseudo(unsigned Opcode) const {
5563   switch (Opcode) {
5564   case AMDGPU::SI_KILL_F32_COND_IMM_PSEUDO:
5565     return get(AMDGPU::SI_KILL_F32_COND_IMM_TERMINATOR);
5566   case AMDGPU::SI_KILL_I1_PSEUDO:
5567     return get(AMDGPU::SI_KILL_I1_TERMINATOR);
5568   default:
5569     llvm_unreachable("invalid opcode, expected SI_KILL_*_PSEUDO");
5570   }
5571 }
5572 
5573 bool SIInstrInfo::isBufferSMRD(const MachineInstr &MI) const {
5574   if (!isSMRD(MI))
5575     return false;
5576 
5577   // Check that it is using a buffer resource.
5578   int Idx = AMDGPU::getNamedOperandIdx(MI.getOpcode(), AMDGPU::OpName::sbase);
5579   if (Idx == -1) // e.g. s_memtime
5580     return false;
5581 
5582   const auto RCID = MI.getDesc().OpInfo[Idx].RegClass;
5583   return RCID == AMDGPU::SReg_128RegClassID;
5584 }
5585 
5586 // This must be kept in sync with the SIEncodingFamily class in SIInstrInfo.td
5587 enum SIEncodingFamily {
5588   SI = 0,
5589   VI = 1,
5590   SDWA = 2,
5591   SDWA9 = 3,
5592   GFX80 = 4,
5593   GFX9 = 5,
5594   GFX10 = 6,
5595   SDWA10 = 7
5596 };
5597 
5598 static SIEncodingFamily subtargetEncodingFamily(const GCNSubtarget &ST) {
5599   switch (ST.getGeneration()) {
5600   default:
5601     break;
5602   case AMDGPUSubtarget::SOUTHERN_ISLANDS:
5603   case AMDGPUSubtarget::SEA_ISLANDS:
5604     return SIEncodingFamily::SI;
5605   case AMDGPUSubtarget::VOLCANIC_ISLANDS:
5606   case AMDGPUSubtarget::GFX9:
5607     return SIEncodingFamily::VI;
5608   case AMDGPUSubtarget::GFX10:
5609     return SIEncodingFamily::GFX10;
5610   }
5611   llvm_unreachable("Unknown subtarget generation!");
5612 }
5613 
5614 int SIInstrInfo::pseudoToMCOpcode(int Opcode) const {
5615   SIEncodingFamily Gen = subtargetEncodingFamily(ST);
5616 
5617   if ((get(Opcode).TSFlags & SIInstrFlags::renamedInGFX9) != 0 &&
5618     ST.getGeneration() >= AMDGPUSubtarget::GFX9)
5619     Gen = SIEncodingFamily::GFX9;
5620 
5621   if (get(Opcode).TSFlags & SIInstrFlags::SDWA)
5622     Gen = ST.getGeneration() == AMDGPUSubtarget::GFX9 ? SIEncodingFamily::SDWA9
5623                                                       : SIEncodingFamily::SDWA;
5624   // Adjust the encoding family to GFX80 for D16 buffer instructions when the
5625   // subtarget has UnpackedD16VMem feature.
5626   // TODO: remove this when we discard GFX80 encoding.
5627   if (ST.hasUnpackedD16VMem() && (get(Opcode).TSFlags & SIInstrFlags::D16Buf))
5628     Gen = SIEncodingFamily::GFX80;
5629 
5630   int MCOp = AMDGPU::getMCOpcode(Opcode, Gen);
5631 
5632   // -1 means that Opcode is already a native instruction.
5633   if (MCOp == -1)
5634     return Opcode;
5635 
5636   // (uint16_t)-1 means that Opcode is a pseudo instruction that has
5637   // no encoding in the given subtarget generation.
5638   if (MCOp == (uint16_t)-1)
5639     return -1;
5640 
5641   return MCOp;
5642 }
5643 
5644 static
5645 TargetInstrInfo::RegSubRegPair getRegOrUndef(const MachineOperand &RegOpnd) {
5646   assert(RegOpnd.isReg());
5647   return RegOpnd.isUndef() ? TargetInstrInfo::RegSubRegPair() :
5648                              getRegSubRegPair(RegOpnd);
5649 }
5650 
5651 TargetInstrInfo::RegSubRegPair
5652 llvm::getRegSequenceSubReg(MachineInstr &MI, unsigned SubReg) {
5653   assert(MI.isRegSequence());
5654   for (unsigned I = 0, E = (MI.getNumOperands() - 1)/ 2; I < E; ++I)
5655     if (MI.getOperand(1 + 2 * I + 1).getImm() == SubReg) {
5656       auto &RegOp = MI.getOperand(1 + 2 * I);
5657       return getRegOrUndef(RegOp);
5658     }
5659   return TargetInstrInfo::RegSubRegPair();
5660 }
5661 
5662 // Try to find the definition of reg:subreg in subreg-manipulation pseudos
5663 // Following a subreg of reg:subreg isn't supported
5664 static bool followSubRegDef(MachineInstr &MI,
5665                             TargetInstrInfo::RegSubRegPair &RSR) {
5666   if (!RSR.SubReg)
5667     return false;
5668   switch (MI.getOpcode()) {
5669   default: break;
5670   case AMDGPU::REG_SEQUENCE:
5671     RSR = getRegSequenceSubReg(MI, RSR.SubReg);
5672     return true;
5673   // EXTRACT_SUBREG ins't supported as this would follow a subreg of subreg
5674   case AMDGPU::INSERT_SUBREG:
5675     if (RSR.SubReg == (unsigned)MI.getOperand(3).getImm())
5676       // inserted the subreg we're looking for
5677       RSR = getRegOrUndef(MI.getOperand(2));
5678     else { // the subreg in the rest of the reg
5679       auto R1 = getRegOrUndef(MI.getOperand(1));
5680       if (R1.SubReg) // subreg of subreg isn't supported
5681         return false;
5682       RSR.Reg = R1.Reg;
5683     }
5684     return true;
5685   }
5686   return false;
5687 }
5688 
5689 MachineInstr *llvm::getVRegSubRegDef(const TargetInstrInfo::RegSubRegPair &P,
5690                                      MachineRegisterInfo &MRI) {
5691   assert(MRI.isSSA());
5692   if (!TargetRegisterInfo::isVirtualRegister(P.Reg))
5693     return nullptr;
5694 
5695   auto RSR = P;
5696   auto *DefInst = MRI.getVRegDef(RSR.Reg);
5697   while (auto *MI = DefInst) {
5698     DefInst = nullptr;
5699     switch (MI->getOpcode()) {
5700     case AMDGPU::COPY:
5701     case AMDGPU::V_MOV_B32_e32: {
5702       auto &Op1 = MI->getOperand(1);
5703       if (Op1.isReg() &&
5704         TargetRegisterInfo::isVirtualRegister(Op1.getReg())) {
5705         if (Op1.isUndef())
5706           return nullptr;
5707         RSR = getRegSubRegPair(Op1);
5708         DefInst = MRI.getVRegDef(RSR.Reg);
5709       }
5710       break;
5711     }
5712     default:
5713       if (followSubRegDef(*MI, RSR)) {
5714         if (!RSR.Reg)
5715           return nullptr;
5716         DefInst = MRI.getVRegDef(RSR.Reg);
5717       }
5718     }
5719     if (!DefInst)
5720       return MI;
5721   }
5722   return nullptr;
5723 }
5724 
5725 bool llvm::isEXECMaskConstantBetweenDefAndUses(unsigned VReg,
5726                                                MachineRegisterInfo &MRI) {
5727   assert(MRI.isSSA() && "Must be run on SSA");
5728   auto *TRI = MRI.getTargetRegisterInfo();
5729 
5730   auto *DefI = MRI.getVRegDef(VReg);
5731   auto *BB = DefI->getParent();
5732 
5733   DenseSet<MachineInstr*> Uses;
5734   for (auto &Use : MRI.use_nodbg_operands(VReg)) {
5735     auto *I = Use.getParent();
5736     if (I->getParent() != BB)
5737       return false;
5738     Uses.insert(I);
5739   }
5740 
5741   auto E = BB->end();
5742   for (auto I = std::next(DefI->getIterator()); I != E; ++I) {
5743     Uses.erase(&*I);
5744     // don't check the last use
5745     if (Uses.empty() || I->modifiesRegister(AMDGPU::EXEC, TRI))
5746       break;
5747   }
5748   return Uses.empty();
5749 }
5750