contrib/llvm/lib/Target/AMDGPU/SIFoldOperands.cpp

   1 //===-- SIFoldOperands.cpp - Fold operands --- ----------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 /// \file
   9 //===----------------------------------------------------------------------===//
  10 //
  11
  12 #include "AMDGPU.h"
  13 #include "AMDGPUSubtarget.h"
  14 #include "SIInstrInfo.h"
  15 #include "SIMachineFunctionInfo.h"
  16 #include "llvm/ADT/DepthFirstIterator.h"
  17 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  18 #include "llvm/CodeGen/MachineFunctionPass.h"
  19 #include "llvm/CodeGen/MachineInstrBuilder.h"
  20 #include "llvm/CodeGen/MachineRegisterInfo.h"
  21 #include "llvm/Support/Debug.h"
  22 #include "llvm/Support/raw_ostream.h"
  23 #include "llvm/Target/TargetMachine.h"
  24
  25 #define DEBUG_TYPE "si-fold-operands"
  26 using namespace llvm;
  27
  28 namespace {
  29
  30 struct FoldCandidate {
  31   MachineInstr *UseMI;
  32   union {
  33     MachineOperand *OpToFold;
  34     uint64_t ImmToFold;
  35     int FrameIndexToFold;
  36   };
  37   unsigned char UseOpNo;
  38   MachineOperand::MachineOperandType Kind;
  39   bool Commuted;
  40
  41   FoldCandidate(MachineInstr *MI, unsigned OpNo, MachineOperand *FoldOp,
  42                 bool Commuted_ = false) :
  43     UseMI(MI), OpToFold(nullptr), UseOpNo(OpNo), Kind(FoldOp->getType()),
  44     Commuted(Commuted_) {
  45     if (FoldOp->isImm()) {
  46       ImmToFold = FoldOp->getImm();
  47     } else if (FoldOp->isFI()) {
  48       FrameIndexToFold = FoldOp->getIndex();
  49     } else {
  50       assert(FoldOp->isReg());
  51       OpToFold = FoldOp;
  52     }
  53   }
  54
  55   bool isFI() const {
  56     return Kind == MachineOperand::MO_FrameIndex;
  57   }
  58
  59   bool isImm() const {
  60     return Kind == MachineOperand::MO_Immediate;
  61   }
  62
  63   bool isReg() const {
  64     return Kind == MachineOperand::MO_Register;
  65   }
  66
  67   bool isCommuted() const {
  68     return Commuted;
  69   }
  70 };
  71
  72 class SIFoldOperands : public MachineFunctionPass {
  73 public:
  74   static char ID;
  75   MachineRegisterInfo *MRI;
  76   const SIInstrInfo *TII;
  77   const SIRegisterInfo *TRI;
  78   const SISubtarget *ST;
  79
  80   void foldOperand(MachineOperand &OpToFold,
  81                    MachineInstr *UseMI,
  82                    unsigned UseOpIdx,
  83                    SmallVectorImpl<FoldCandidate> &FoldList,
  84                    SmallVectorImpl<MachineInstr *> &CopiesToReplace) const;
  85
  86   void foldInstOperand(MachineInstr &MI, MachineOperand &OpToFold) const;
  87
  88   const MachineOperand *isClamp(const MachineInstr &MI) const;
  89   bool tryFoldClamp(MachineInstr &MI);
  90
  91   std::pair<const MachineOperand *, int> isOMod(const MachineInstr &MI) const;
  92   bool tryFoldOMod(MachineInstr &MI);
  93
  94 public:
  95   SIFoldOperands() : MachineFunctionPass(ID) {
  96     initializeSIFoldOperandsPass(*PassRegistry::getPassRegistry());
  97   }
  98
  99   bool runOnMachineFunction(MachineFunction &MF) override;
 100
 101   StringRef getPassName() const override { return "SI Fold Operands"; }
 102
 103   void getAnalysisUsage(AnalysisUsage &AU) const override {
 104     AU.setPreservesCFG();
 105     MachineFunctionPass::getAnalysisUsage(AU);
 106   }
 107 };
 108
 109 } // End anonymous namespace.
 110
 111 INITIALIZE_PASS(SIFoldOperands, DEBUG_TYPE,
 112                 "SI Fold Operands", false, false)
 113
 114 char SIFoldOperands::ID = 0;
 115
 116 char &llvm::SIFoldOperandsID = SIFoldOperands::ID;
 117
 118 // Wrapper around isInlineConstant that understands special cases when
 119 // instruction types are replaced during operand folding.
 120 static bool isInlineConstantIfFolded(const SIInstrInfo *TII,
 121                                      const MachineInstr &UseMI,
 122                                      unsigned OpNo,
 123                                      const MachineOperand &OpToFold) {
 124   if (TII->isInlineConstant(UseMI, OpNo, OpToFold))
 125     return true;
 126
 127   unsigned Opc = UseMI.getOpcode();
 128   switch (Opc) {
 129   case AMDGPU::V_MAC_F32_e64:
 130   case AMDGPU::V_MAC_F16_e64: {
 131     // Special case for mac. Since this is replaced with mad when folded into
 132     // src2, we need to check the legality for the final instruction.
 133     int Src2Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2);
 134     if (static_cast<int>(OpNo) == Src2Idx) {
 135       bool IsF32 = Opc == AMDGPU::V_MAC_F32_e64;
 136       const MCInstrDesc &MadDesc
 137         = TII->get(IsF32 ? AMDGPU::V_MAD_F32 : AMDGPU::V_MAD_F16);
 138       return TII->isInlineConstant(OpToFold, MadDesc.OpInfo[OpNo].OperandType);
 139     }
 140     return false;
 141   }
 142   default:
 143     return false;
 144   }
 145 }
 146
 147 FunctionPass *llvm::createSIFoldOperandsPass() {
 148   return new SIFoldOperands();
 149 }
 150
 151 static bool updateOperand(FoldCandidate &Fold,
 152                           const TargetRegisterInfo &TRI) {
 153   MachineInstr *MI = Fold.UseMI;
 154   MachineOperand &Old = MI->getOperand(Fold.UseOpNo);
 155   assert(Old.isReg());
 156
 157   if (Fold.isImm()) {
 158     Old.ChangeToImmediate(Fold.ImmToFold);
 159     return true;
 160   }
 161
 162   if (Fold.isFI()) {
 163     Old.ChangeToFrameIndex(Fold.FrameIndexToFold);
 164     return true;
 165   }
 166
 167   MachineOperand *New = Fold.OpToFold;
 168   if (TargetRegisterInfo::isVirtualRegister(Old.getReg()) &&
 169       TargetRegisterInfo::isVirtualRegister(New->getReg())) {
 170     Old.substVirtReg(New->getReg(), New->getSubReg(), TRI);
 171
 172     Old.setIsUndef(New->isUndef());
 173     return true;
 174   }
 175
 176   // FIXME: Handle physical registers.
 177
 178   return false;
 179 }
 180
 181 static bool isUseMIInFoldList(ArrayRef<FoldCandidate> FoldList,
 182                               const MachineInstr *MI) {
 183   for (auto Candidate : FoldList) {
 184     if (Candidate.UseMI == MI)
 185       return true;
 186   }
 187   return false;
 188 }
 189
 190 static bool tryAddToFoldList(SmallVectorImpl<FoldCandidate> &FoldList,
 191                              MachineInstr *MI, unsigned OpNo,
 192                              MachineOperand *OpToFold,
 193                              const SIInstrInfo *TII) {
 194   if (!TII->isOperandLegal(*MI, OpNo, OpToFold)) {
 195
 196     // Special case for v_mac_{f16, f32}_e64 if we are trying to fold into src2
 197     unsigned Opc = MI->getOpcode();
 198     if ((Opc == AMDGPU::V_MAC_F32_e64 || Opc == AMDGPU::V_MAC_F16_e64) &&
 199         (int)OpNo == AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2)) {
 200       bool IsF32 = Opc == AMDGPU::V_MAC_F32_e64;
 201
 202       // Check if changing this to a v_mad_{f16, f32} instruction will allow us
 203       // to fold the operand.
 204       MI->setDesc(TII->get(IsF32 ? AMDGPU::V_MAD_F32 : AMDGPU::V_MAD_F16));
 205       bool FoldAsMAD = tryAddToFoldList(FoldList, MI, OpNo, OpToFold, TII);
 206       if (FoldAsMAD) {
 207         MI->untieRegOperand(OpNo);
 208         return true;
 209       }
 210       MI->setDesc(TII->get(Opc));
 211     }
 212
 213     // Special case for s_setreg_b32
 214     if (Opc == AMDGPU::S_SETREG_B32 && OpToFold->isImm()) {
 215       MI->setDesc(TII->get(AMDGPU::S_SETREG_IMM32_B32));
 216       FoldList.push_back(FoldCandidate(MI, OpNo, OpToFold));
 217       return true;
 218     }
 219
 220     // If we are already folding into another operand of MI, then
 221     // we can't commute the instruction, otherwise we risk making the
 222     // other fold illegal.
 223     if (isUseMIInFoldList(FoldList, MI))
 224       return false;
 225
 226     // Operand is not legal, so try to commute the instruction to
 227     // see if this makes it possible to fold.
 228     unsigned CommuteIdx0 = TargetInstrInfo::CommuteAnyOperandIndex;
 229     unsigned CommuteIdx1 = TargetInstrInfo::CommuteAnyOperandIndex;
 230     bool CanCommute = TII->findCommutedOpIndices(*MI, CommuteIdx0, CommuteIdx1);
 231
 232     if (CanCommute) {
 233       if (CommuteIdx0 == OpNo)
 234         OpNo = CommuteIdx1;
 235       else if (CommuteIdx1 == OpNo)
 236         OpNo = CommuteIdx0;
 237     }
 238
 239     // One of operands might be an Imm operand, and OpNo may refer to it after
 240     // the call of commuteInstruction() below. Such situations are avoided
 241     // here explicitly as OpNo must be a register operand to be a candidate
 242     // for memory folding.
 243     if (CanCommute && (!MI->getOperand(CommuteIdx0).isReg() ||
 244                        !MI->getOperand(CommuteIdx1).isReg()))
 245       return false;
 246
 247     if (!CanCommute ||
 248         !TII->commuteInstruction(*MI, false, CommuteIdx0, CommuteIdx1))
 249       return false;
 250
 251     if (!TII->isOperandLegal(*MI, OpNo, OpToFold)) {
 252       TII->commuteInstruction(*MI, false, CommuteIdx0, CommuteIdx1);
 253       return false;
 254     }
 255
 256     FoldList.push_back(FoldCandidate(MI, OpNo, OpToFold, true));
 257     return true;
 258   }
 259
 260   FoldList.push_back(FoldCandidate(MI, OpNo, OpToFold));
 261   return true;
 262 }
 263
 264 // If the use operand doesn't care about the value, this may be an operand only
 265 // used for register indexing, in which case it is unsafe to fold.
 266 static bool isUseSafeToFold(const SIInstrInfo *TII,
 267                             const MachineInstr &MI,
 268                             const MachineOperand &UseMO) {
 269   return !UseMO.isUndef() && !TII->isSDWA(MI);
 270   //return !MI.hasRegisterImplicitUseOperand(UseMO.getReg());
 271 }
 272
 273 void SIFoldOperands::foldOperand(
 274   MachineOperand &OpToFold,
 275   MachineInstr *UseMI,
 276   unsigned UseOpIdx,
 277   SmallVectorImpl<FoldCandidate> &FoldList,
 278   SmallVectorImpl<MachineInstr *> &CopiesToReplace) const {
 279   const MachineOperand &UseOp = UseMI->getOperand(UseOpIdx);
 280
 281   if (!isUseSafeToFold(TII, *UseMI, UseOp))
 282     return;
 283
 284   // FIXME: Fold operands with subregs.
 285   if (UseOp.isReg() && OpToFold.isReg()) {
 286     if (UseOp.isImplicit() || UseOp.getSubReg() != AMDGPU::NoSubRegister)
 287       return;
 288
 289     // Don't fold subregister extracts into tied operands, only if it is a full
 290     // copy since a subregister use tied to a full register def doesn't really
 291     // make sense. e.g. don't fold:
 292     //
 293     // %vreg1 = COPY %vreg0:sub1
 294     // %vreg2<tied3> = V_MAC_{F16, F32} %vreg3, %vreg4, %vreg1<tied0>
 295     //
 296     //  into
 297     // %vreg2<tied3> = V_MAC_{F16, F32} %vreg3, %vreg4, %vreg0:sub1<tied0>
 298     if (UseOp.isTied() && OpToFold.getSubReg() != AMDGPU::NoSubRegister)
 299       return;
 300   }
 301
 302   // Special case for REG_SEQUENCE: We can't fold literals into
 303   // REG_SEQUENCE instructions, so we have to fold them into the
 304   // uses of REG_SEQUENCE.
 305   if (UseMI->isRegSequence()) {
 306     unsigned RegSeqDstReg = UseMI->getOperand(0).getReg();
 307     unsigned RegSeqDstSubReg = UseMI->getOperand(UseOpIdx + 1).getImm();
 308
 309     for (MachineRegisterInfo::use_iterator
 310            RSUse = MRI->use_begin(RegSeqDstReg), RSE = MRI->use_end();
 311          RSUse != RSE; ++RSUse) {
 312
 313       MachineInstr *RSUseMI = RSUse->getParent();
 314       if (RSUse->getSubReg() != RegSeqDstSubReg)
 315         continue;
 316
 317       foldOperand(OpToFold, RSUseMI, RSUse.getOperandNo(), FoldList,
 318                   CopiesToReplace);
 319     }
 320
 321     return;
 322   }
 323
 324
 325   bool FoldingImm = OpToFold.isImm();
 326
 327   // In order to fold immediates into copies, we need to change the
 328   // copy to a MOV.
 329   if (FoldingImm && UseMI->isCopy()) {
 330     unsigned DestReg = UseMI->getOperand(0).getReg();
 331     const TargetRegisterClass *DestRC
 332       = TargetRegisterInfo::isVirtualRegister(DestReg) ?
 333       MRI->getRegClass(DestReg) :
 334       TRI->getPhysRegClass(DestReg);
 335
 336     unsigned MovOp = TII->getMovOpcode(DestRC);
 337     if (MovOp == AMDGPU::COPY)
 338       return;
 339
 340     UseMI->setDesc(TII->get(MovOp));
 341     CopiesToReplace.push_back(UseMI);
 342   } else {
 343     const MCInstrDesc &UseDesc = UseMI->getDesc();
 344
 345     // Don't fold into target independent nodes.  Target independent opcodes
 346     // don't have defined register classes.
 347     if (UseDesc.isVariadic() ||
 348         UseDesc.OpInfo[UseOpIdx].RegClass == -1)
 349       return;
 350   }
 351
 352   if (!FoldingImm) {
 353     tryAddToFoldList(FoldList, UseMI, UseOpIdx, &OpToFold, TII);
 354
 355     // FIXME: We could try to change the instruction from 64-bit to 32-bit
 356     // to enable more folding opportunites.  The shrink operands pass
 357     // already does this.
 358     return;
 359   }
 360
 361
 362   const MCInstrDesc &FoldDesc = OpToFold.getParent()->getDesc();
 363   const TargetRegisterClass *FoldRC =
 364     TRI->getRegClass(FoldDesc.OpInfo[0].RegClass);
 365
 366
 367   // Split 64-bit constants into 32-bits for folding.
 368   if (UseOp.getSubReg() && AMDGPU::getRegBitWidth(FoldRC->getID()) == 64) {
 369     unsigned UseReg = UseOp.getReg();
 370     const TargetRegisterClass *UseRC
 371       = TargetRegisterInfo::isVirtualRegister(UseReg) ?
 372       MRI->getRegClass(UseReg) :
 373       TRI->getPhysRegClass(UseReg);
 374
 375     if (AMDGPU::getRegBitWidth(UseRC->getID()) != 64)
 376       return;
 377
 378     APInt Imm(64, OpToFold.getImm());
 379     if (UseOp.getSubReg() == AMDGPU::sub0) {
 380       Imm = Imm.getLoBits(32);
 381     } else {
 382       assert(UseOp.getSubReg() == AMDGPU::sub1);
 383       Imm = Imm.getHiBits(32);
 384     }
 385
 386     MachineOperand ImmOp = MachineOperand::CreateImm(Imm.getSExtValue());
 387     tryAddToFoldList(FoldList, UseMI, UseOpIdx, &ImmOp, TII);
 388     return;
 389   }
 390
 391
 392
 393   tryAddToFoldList(FoldList, UseMI, UseOpIdx, &OpToFold, TII);
 394 }
 395
 396 static bool evalBinaryInstruction(unsigned Opcode, int32_t &Result,
 397                                   uint32_t LHS, uint32_t RHS) {
 398   switch (Opcode) {
 399   case AMDGPU::V_AND_B32_e64:
 400   case AMDGPU::V_AND_B32_e32:
 401   case AMDGPU::S_AND_B32:
 402     Result = LHS & RHS;
 403     return true;
 404   case AMDGPU::V_OR_B32_e64:
 405   case AMDGPU::V_OR_B32_e32:
 406   case AMDGPU::S_OR_B32:
 407     Result = LHS | RHS;
 408     return true;
 409   case AMDGPU::V_XOR_B32_e64:
 410   case AMDGPU::V_XOR_B32_e32:
 411   case AMDGPU::S_XOR_B32:
 412     Result = LHS ^ RHS;
 413     return true;
 414   case AMDGPU::V_LSHL_B32_e64:
 415   case AMDGPU::V_LSHL_B32_e32:
 416   case AMDGPU::S_LSHL_B32:
 417     // The instruction ignores the high bits for out of bounds shifts.
 418     Result = LHS << (RHS & 31);
 419     return true;
 420   case AMDGPU::V_LSHLREV_B32_e64:
 421   case AMDGPU::V_LSHLREV_B32_e32:
 422     Result = RHS << (LHS & 31);
 423     return true;
 424   case AMDGPU::V_LSHR_B32_e64:
 425   case AMDGPU::V_LSHR_B32_e32:
 426   case AMDGPU::S_LSHR_B32:
 427     Result = LHS >> (RHS & 31);
 428     return true;
 429   case AMDGPU::V_LSHRREV_B32_e64:
 430   case AMDGPU::V_LSHRREV_B32_e32:
 431     Result = RHS >> (LHS & 31);
 432     return true;
 433   case AMDGPU::V_ASHR_I32_e64:
 434   case AMDGPU::V_ASHR_I32_e32:
 435   case AMDGPU::S_ASHR_I32:
 436     Result = static_cast<int32_t>(LHS) >> (RHS & 31);
 437     return true;
 438   case AMDGPU::V_ASHRREV_I32_e64:
 439   case AMDGPU::V_ASHRREV_I32_e32:
 440     Result = static_cast<int32_t>(RHS) >> (LHS & 31);
 441     return true;
 442   default:
 443     return false;
 444   }
 445 }
 446
 447 static unsigned getMovOpc(bool IsScalar) {
 448   return IsScalar ? AMDGPU::S_MOV_B32 : AMDGPU::V_MOV_B32_e32;
 449 }
 450
 451 /// Remove any leftover implicit operands from mutating the instruction. e.g.
 452 /// if we replace an s_and_b32 with a copy, we don't need the implicit scc def
 453 /// anymore.
 454 static void stripExtraCopyOperands(MachineInstr &MI) {
 455   const MCInstrDesc &Desc = MI.getDesc();
 456   unsigned NumOps = Desc.getNumOperands() +
 457                     Desc.getNumImplicitUses() +
 458                     Desc.getNumImplicitDefs();
 459
 460   for (unsigned I = MI.getNumOperands() - 1; I >= NumOps; --I)
 461     MI.RemoveOperand(I);
 462 }
 463
 464 static void mutateCopyOp(MachineInstr &MI, const MCInstrDesc &NewDesc) {
 465   MI.setDesc(NewDesc);
 466   stripExtraCopyOperands(MI);
 467 }
 468
 469 static MachineOperand *getImmOrMaterializedImm(MachineRegisterInfo &MRI,
 470                                                MachineOperand &Op) {
 471   if (Op.isReg()) {
 472     // If this has a subregister, it obviously is a register source.
 473     if (Op.getSubReg() != AMDGPU::NoSubRegister)
 474       return &Op;
 475
 476     MachineInstr *Def = MRI.getVRegDef(Op.getReg());
 477     if (Def && Def->isMoveImmediate()) {
 478       MachineOperand &ImmSrc = Def->getOperand(1);
 479       if (ImmSrc.isImm())
 480         return &ImmSrc;
 481     }
 482   }
 483
 484   return &Op;
 485 }
 486
 487 // Try to simplify operations with a constant that may appear after instruction
 488 // selection.
 489 // TODO: See if a frame index with a fixed offset can fold.
 490 static bool tryConstantFoldOp(MachineRegisterInfo &MRI,
 491                               const SIInstrInfo *TII,
 492                               MachineInstr *MI,
 493                               MachineOperand *ImmOp) {
 494   unsigned Opc = MI->getOpcode();
 495   if (Opc == AMDGPU::V_NOT_B32_e64 || Opc == AMDGPU::V_NOT_B32_e32 ||
 496       Opc == AMDGPU::S_NOT_B32) {
 497     MI->getOperand(1).ChangeToImmediate(~ImmOp->getImm());
 498     mutateCopyOp(*MI, TII->get(getMovOpc(Opc == AMDGPU::S_NOT_B32)));
 499     return true;
 500   }
 501
 502   int Src1Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1);
 503   if (Src1Idx == -1)
 504     return false;
 505
 506   int Src0Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src0);
 507   MachineOperand *Src0 = getImmOrMaterializedImm(MRI, MI->getOperand(Src0Idx));
 508   MachineOperand *Src1 = getImmOrMaterializedImm(MRI, MI->getOperand(Src1Idx));
 509
 510   if (!Src0->isImm() && !Src1->isImm())
 511     return false;
 512
 513   // and k0, k1 -> v_mov_b32 (k0 & k1)
 514   // or k0, k1 -> v_mov_b32 (k0 | k1)
 515   // xor k0, k1 -> v_mov_b32 (k0 ^ k1)
 516   if (Src0->isImm() && Src1->isImm()) {
 517     int32_t NewImm;
 518     if (!evalBinaryInstruction(Opc, NewImm, Src0->getImm(), Src1->getImm()))
 519       return false;
 520
 521     const SIRegisterInfo &TRI = TII->getRegisterInfo();
 522     bool IsSGPR = TRI.isSGPRReg(MRI, MI->getOperand(0).getReg());
 523
 524     // Be careful to change the right operand, src0 may belong to a different
 525     // instruction.
 526     MI->getOperand(Src0Idx).ChangeToImmediate(NewImm);
 527     MI->RemoveOperand(Src1Idx);
 528     mutateCopyOp(*MI, TII->get(getMovOpc(IsSGPR)));
 529     return true;
 530   }
 531
 532   if (!MI->isCommutable())
 533     return false;
 534
 535   if (Src0->isImm() && !Src1->isImm()) {
 536     std::swap(Src0, Src1);
 537     std::swap(Src0Idx, Src1Idx);
 538   }
 539
 540   int32_t Src1Val = static_cast<int32_t>(Src1->getImm());
 541   if (Opc == AMDGPU::V_OR_B32_e64 ||
 542       Opc == AMDGPU::V_OR_B32_e32 ||
 543       Opc == AMDGPU::S_OR_B32) {
 544     if (Src1Val == 0) {
 545       // y = or x, 0 => y = copy x
 546       MI->RemoveOperand(Src1Idx);
 547       mutateCopyOp(*MI, TII->get(AMDGPU::COPY));
 548     } else if (Src1Val == -1) {
 549       // y = or x, -1 => y = v_mov_b32 -1
 550       MI->RemoveOperand(Src1Idx);
 551       mutateCopyOp(*MI, TII->get(getMovOpc(Opc == AMDGPU::S_OR_B32)));
 552     } else
 553       return false;
 554
 555     return true;
 556   }
 557
 558   if (MI->getOpcode() == AMDGPU::V_AND_B32_e64 ||
 559       MI->getOpcode() == AMDGPU::V_AND_B32_e32 ||
 560       MI->getOpcode() == AMDGPU::S_AND_B32) {
 561     if (Src1Val == 0) {
 562       // y = and x, 0 => y = v_mov_b32 0
 563       MI->RemoveOperand(Src0Idx);
 564       mutateCopyOp(*MI, TII->get(getMovOpc(Opc == AMDGPU::S_AND_B32)));
 565     } else if (Src1Val == -1) {
 566       // y = and x, -1 => y = copy x
 567       MI->RemoveOperand(Src1Idx);
 568       mutateCopyOp(*MI, TII->get(AMDGPU::COPY));
 569       stripExtraCopyOperands(*MI);
 570     } else
 571       return false;
 572
 573     return true;
 574   }
 575
 576   if (MI->getOpcode() == AMDGPU::V_XOR_B32_e64 ||
 577       MI->getOpcode() == AMDGPU::V_XOR_B32_e32 ||
 578       MI->getOpcode() == AMDGPU::S_XOR_B32) {
 579     if (Src1Val == 0) {
 580       // y = xor x, 0 => y = copy x
 581       MI->RemoveOperand(Src1Idx);
 582       mutateCopyOp(*MI, TII->get(AMDGPU::COPY));
 583       return true;
 584     }
 585   }
 586
 587   return false;
 588 }
 589
 590 // Try to fold an instruction into a simpler one
 591 static bool tryFoldInst(const SIInstrInfo *TII,
 592                         MachineInstr *MI) {
 593   unsigned Opc = MI->getOpcode();
 594
 595   if (Opc == AMDGPU::V_CNDMASK_B32_e32    ||
 596       Opc == AMDGPU::V_CNDMASK_B32_e64    ||
 597       Opc == AMDGPU::V_CNDMASK_B64_PSEUDO) {
 598     const MachineOperand *Src0 = TII->getNamedOperand(*MI, AMDGPU::OpName::src0);
 599     const MachineOperand *Src1 = TII->getNamedOperand(*MI, AMDGPU::OpName::src1);
 600     if (Src1->isIdenticalTo(*Src0)) {
 601       DEBUG(dbgs() << "Folded " << *MI << " into ");
 602       int Src2Idx = AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src2);
 603       if (Src2Idx != -1)
 604         MI->RemoveOperand(Src2Idx);
 605       MI->RemoveOperand(AMDGPU::getNamedOperandIdx(Opc, AMDGPU::OpName::src1));
 606       mutateCopyOp(*MI, TII->get(Src0->isReg() ? (unsigned)AMDGPU::COPY
 607                                                : getMovOpc(false)));
 608       DEBUG(dbgs() << *MI << '\n');
 609       return true;
 610     }
 611   }
 612
 613   return false;
 614 }
 615
 616 void SIFoldOperands::foldInstOperand(MachineInstr &MI,
 617                                      MachineOperand &OpToFold) const {
 618   // We need mutate the operands of new mov instructions to add implicit
 619   // uses of EXEC, but adding them invalidates the use_iterator, so defer
 620   // this.
 621   SmallVector<MachineInstr *, 4> CopiesToReplace;
 622   SmallVector<FoldCandidate, 4> FoldList;
 623   MachineOperand &Dst = MI.getOperand(0);
 624
 625   bool FoldingImm = OpToFold.isImm() || OpToFold.isFI();
 626   if (FoldingImm) {
 627     unsigned NumLiteralUses = 0;
 628     MachineOperand *NonInlineUse = nullptr;
 629     int NonInlineUseOpNo = -1;
 630
 631     MachineRegisterInfo::use_iterator NextUse, NextInstUse;
 632     for (MachineRegisterInfo::use_iterator
 633            Use = MRI->use_begin(Dst.getReg()), E = MRI->use_end();
 634          Use != E; Use = NextUse) {
 635       NextUse = std::next(Use);
 636       MachineInstr *UseMI = Use->getParent();
 637       unsigned OpNo = Use.getOperandNo();
 638
 639       // Folding the immediate may reveal operations that can be constant
 640       // folded or replaced with a copy. This can happen for example after
 641       // frame indices are lowered to constants or from splitting 64-bit
 642       // constants.
 643       //
 644       // We may also encounter cases where one or both operands are
 645       // immediates materialized into a register, which would ordinarily not
 646       // be folded due to multiple uses or operand constraints.
 647
 648       if (OpToFold.isImm() && tryConstantFoldOp(*MRI, TII, UseMI, &OpToFold)) {
 649         DEBUG(dbgs() << "Constant folded " << *UseMI <<'\n');
 650
 651         // Some constant folding cases change the same immediate's use to a new
 652         // instruction, e.g. and x, 0 -> 0. Make sure we re-visit the user
 653         // again. The same constant folded instruction could also have a second
 654         // use operand.
 655         NextUse = MRI->use_begin(Dst.getReg());
 656         FoldList.clear();
 657         continue;
 658       }
 659
 660       // Try to fold any inline immediate uses, and then only fold other
 661       // constants if they have one use.
 662       //
 663       // The legality of the inline immediate must be checked based on the use
 664       // operand, not the defining instruction, because 32-bit instructions
 665       // with 32-bit inline immediate sources may be used to materialize
 666       // constants used in 16-bit operands.
 667       //
 668       // e.g. it is unsafe to fold:
 669       //  s_mov_b32 s0, 1.0    // materializes 0x3f800000
 670       //  v_add_f16 v0, v1, s0 // 1.0 f16 inline immediate sees 0x00003c00
 671
 672       // Folding immediates with more than one use will increase program size.
 673       // FIXME: This will also reduce register usage, which may be better
 674       // in some cases. A better heuristic is needed.
 675       if (isInlineConstantIfFolded(TII, *UseMI, OpNo, OpToFold)) {
 676         foldOperand(OpToFold, UseMI, OpNo, FoldList, CopiesToReplace);
 677       } else {
 678         if (++NumLiteralUses == 1) {
 679           NonInlineUse = &*Use;
 680           NonInlineUseOpNo = OpNo;
 681         }
 682       }
 683     }
 684
 685     if (NumLiteralUses == 1) {
 686       MachineInstr *UseMI = NonInlineUse->getParent();
 687       foldOperand(OpToFold, UseMI, NonInlineUseOpNo, FoldList, CopiesToReplace);
 688     }
 689   } else {
 690     // Folding register.
 691     for (MachineRegisterInfo::use_iterator
 692            Use = MRI->use_begin(Dst.getReg()), E = MRI->use_end();
 693          Use != E; ++Use) {
 694       MachineInstr *UseMI = Use->getParent();
 695
 696       foldOperand(OpToFold, UseMI, Use.getOperandNo(),
 697                   FoldList, CopiesToReplace);
 698     }
 699   }
 700
 701   MachineFunction *MF = MI.getParent()->getParent();
 702   // Make sure we add EXEC uses to any new v_mov instructions created.
 703   for (MachineInstr *Copy : CopiesToReplace)
 704     Copy->addImplicitDefUseOperands(*MF);
 705
 706   for (FoldCandidate &Fold : FoldList) {
 707     if (updateOperand(Fold, *TRI)) {
 708       // Clear kill flags.
 709       if (Fold.isReg()) {
 710         assert(Fold.OpToFold && Fold.OpToFold->isReg());
 711         // FIXME: Probably shouldn't bother trying to fold if not an
 712         // SGPR. PeepholeOptimizer can eliminate redundant VGPR->VGPR
 713         // copies.
 714         MRI->clearKillFlags(Fold.OpToFold->getReg());
 715       }
 716       DEBUG(dbgs() << "Folded source from " << MI << " into OpNo " <<
 717             static_cast<int>(Fold.UseOpNo) << " of " << *Fold.UseMI << '\n');
 718       tryFoldInst(TII, Fold.UseMI);
 719     } else if (Fold.isCommuted()) {
 720       // Restoring instruction's original operand order if fold has failed.
 721       TII->commuteInstruction(*Fold.UseMI, false);
 722     }
 723   }
 724 }
 725
 726 const MachineOperand *SIFoldOperands::isClamp(const MachineInstr &MI) const {
 727   unsigned Op = MI.getOpcode();
 728   switch (Op) {
 729   case AMDGPU::V_MAX_F32_e64:
 730   case AMDGPU::V_MAX_F16_e64:
 731   case AMDGPU::V_MAX_F64: {
 732     if (!TII->getNamedOperand(MI, AMDGPU::OpName::clamp)->getImm())
 733       return nullptr;
 734
 735     // Make sure sources are identical.
 736     const MachineOperand *Src0 = TII->getNamedOperand(MI, AMDGPU::OpName::src0);
 737     const MachineOperand *Src1 = TII->getNamedOperand(MI, AMDGPU::OpName::src1);
 738     if (!Src0->isReg() || !Src1->isReg() ||
 739         Src0->getSubReg() != Src1->getSubReg() ||
 740         Src0->getSubReg() != AMDGPU::NoSubRegister)
 741       return nullptr;
 742
 743     // Can't fold up if we have modifiers.
 744     if (TII->hasModifiersSet(MI, AMDGPU::OpName::src0_modifiers) ||
 745         TII->hasModifiersSet(MI, AMDGPU::OpName::src1_modifiers) ||
 746         TII->hasModifiersSet(MI, AMDGPU::OpName::omod))
 747       return nullptr;
 748     return Src0;
 749   }
 750   default:
 751     return nullptr;
 752   }
 753 }
 754
 755 // We obviously have multiple uses in a clamp since the register is used twice
 756 // in the same instruction.
 757 static bool hasOneNonDBGUseInst(const MachineRegisterInfo &MRI, unsigned Reg) {
 758   int Count = 0;
 759   for (auto I = MRI.use_instr_nodbg_begin(Reg), E = MRI.use_instr_nodbg_end();
 760        I != E; ++I) {
 761     if (++Count > 1)
 762       return false;
 763   }
 764
 765   return true;
 766 }
 767
 768 bool SIFoldOperands::tryFoldClamp(MachineInstr &MI) {
 769   const MachineOperand *ClampSrc = isClamp(MI);
 770   if (!ClampSrc || !hasOneNonDBGUseInst(*MRI, ClampSrc->getReg()))
 771     return false;
 772
 773   MachineInstr *Def = MRI->getVRegDef(ClampSrc->getReg());
 774   if (!TII->hasFPClamp(*Def))
 775     return false;
 776   MachineOperand *DefClamp = TII->getNamedOperand(*Def, AMDGPU::OpName::clamp);
 777   if (!DefClamp)
 778     return false;
 779
 780   DEBUG(dbgs() << "Folding clamp " << *DefClamp << " into " << *Def << '\n');
 781
 782   // Clamp is applied after omod, so it is OK if omod is set.
 783   DefClamp->setImm(1);
 784   MRI->replaceRegWith(MI.getOperand(0).getReg(), Def->getOperand(0).getReg());
 785   MI.eraseFromParent();
 786   return true;
 787 }
 788
 789 static int getOModValue(unsigned Opc, int64_t Val) {
 790   switch (Opc) {
 791   case AMDGPU::V_MUL_F32_e64: {
 792     switch (static_cast<uint32_t>(Val)) {
 793     case 0x3f000000: // 0.5
 794       return SIOutMods::DIV2;
 795     case 0x40000000: // 2.0
 796       return SIOutMods::MUL2;
 797     case 0x40800000: // 4.0
 798       return SIOutMods::MUL4;
 799     default:
 800       return SIOutMods::NONE;
 801     }
 802   }
 803   case AMDGPU::V_MUL_F16_e64: {
 804     switch (static_cast<uint16_t>(Val)) {
 805     case 0x3800: // 0.5
 806       return SIOutMods::DIV2;
 807     case 0x4000: // 2.0
 808       return SIOutMods::MUL2;
 809     case 0x4400: // 4.0
 810       return SIOutMods::MUL4;
 811     default:
 812       return SIOutMods::NONE;
 813     }
 814   }
 815   default:
 816     llvm_unreachable("invalid mul opcode");
 817   }
 818 }
 819
 820 // FIXME: Does this really not support denormals with f16?
 821 // FIXME: Does this need to check IEEE mode bit? SNaNs are generally not
 822 // handled, so will anything other than that break?
 823 std::pair<const MachineOperand *, int>
 824 SIFoldOperands::isOMod(const MachineInstr &MI) const {
 825   unsigned Op = MI.getOpcode();
 826   switch (Op) {
 827   case AMDGPU::V_MUL_F32_e64:
 828   case AMDGPU::V_MUL_F16_e64: {
 829     // If output denormals are enabled, omod is ignored.
 830     if ((Op == AMDGPU::V_MUL_F32_e64 && ST->hasFP32Denormals()) ||
 831         (Op == AMDGPU::V_MUL_F16_e64 && ST->hasFP16Denormals()))
 832       return std::make_pair(nullptr, SIOutMods::NONE);
 833
 834     const MachineOperand *RegOp = nullptr;
 835     const MachineOperand *ImmOp = nullptr;
 836     const MachineOperand *Src0 = TII->getNamedOperand(MI, AMDGPU::OpName::src0);
 837     const MachineOperand *Src1 = TII->getNamedOperand(MI, AMDGPU::OpName::src1);
 838     if (Src0->isImm()) {
 839       ImmOp = Src0;
 840       RegOp = Src1;
 841     } else if (Src1->isImm()) {
 842       ImmOp = Src1;
 843       RegOp = Src0;
 844     } else
 845       return std::make_pair(nullptr, SIOutMods::NONE);
 846
 847     int OMod = getOModValue(Op, ImmOp->getImm());
 848     if (OMod == SIOutMods::NONE ||
 849         TII->hasModifiersSet(MI, AMDGPU::OpName::src0_modifiers) ||
 850         TII->hasModifiersSet(MI, AMDGPU::OpName::src1_modifiers) ||
 851         TII->hasModifiersSet(MI, AMDGPU::OpName::omod) ||
 852         TII->hasModifiersSet(MI, AMDGPU::OpName::clamp))
 853       return std::make_pair(nullptr, SIOutMods::NONE);
 854
 855     return std::make_pair(RegOp, OMod);
 856   }
 857   case AMDGPU::V_ADD_F32_e64:
 858   case AMDGPU::V_ADD_F16_e64: {
 859     // If output denormals are enabled, omod is ignored.
 860     if ((Op == AMDGPU::V_ADD_F32_e64 && ST->hasFP32Denormals()) ||
 861         (Op == AMDGPU::V_ADD_F16_e64 && ST->hasFP16Denormals()))
 862       return std::make_pair(nullptr, SIOutMods::NONE);
 863
 864     // Look through the DAGCombiner canonicalization fmul x, 2 -> fadd x, x
 865     const MachineOperand *Src0 = TII->getNamedOperand(MI, AMDGPU::OpName::src0);
 866     const MachineOperand *Src1 = TII->getNamedOperand(MI, AMDGPU::OpName::src1);
 867
 868     if (Src0->isReg() && Src1->isReg() && Src0->getReg() == Src1->getReg() &&
 869         Src0->getSubReg() == Src1->getSubReg() &&
 870         !TII->hasModifiersSet(MI, AMDGPU::OpName::src0_modifiers) &&
 871         !TII->hasModifiersSet(MI, AMDGPU::OpName::src1_modifiers) &&
 872         !TII->hasModifiersSet(MI, AMDGPU::OpName::clamp) &&
 873         !TII->hasModifiersSet(MI, AMDGPU::OpName::omod))
 874       return std::make_pair(Src0, SIOutMods::MUL2);
 875
 876     return std::make_pair(nullptr, SIOutMods::NONE);
 877   }
 878   default:
 879     return std::make_pair(nullptr, SIOutMods::NONE);
 880   }
 881 }
 882
 883 // FIXME: Does this need to check IEEE bit on function?
 884 bool SIFoldOperands::tryFoldOMod(MachineInstr &MI) {
 885   const MachineOperand *RegOp;
 886   int OMod;
 887   std::tie(RegOp, OMod) = isOMod(MI);
 888   if (OMod == SIOutMods::NONE || !RegOp->isReg() ||
 889       RegOp->getSubReg() != AMDGPU::NoSubRegister ||
 890       !hasOneNonDBGUseInst(*MRI, RegOp->getReg()))
 891     return false;
 892
 893   MachineInstr *Def = MRI->getVRegDef(RegOp->getReg());
 894   MachineOperand *DefOMod = TII->getNamedOperand(*Def, AMDGPU::OpName::omod);
 895   if (!DefOMod || DefOMod->getImm() != SIOutMods::NONE)
 896     return false;
 897
 898   // Clamp is applied after omod. If the source already has clamp set, don't
 899   // fold it.
 900   if (TII->hasModifiersSet(*Def, AMDGPU::OpName::clamp))
 901     return false;
 902
 903   DEBUG(dbgs() << "Folding omod " << MI << " into " << *Def << '\n');
 904
 905   DefOMod->setImm(OMod);
 906   MRI->replaceRegWith(MI.getOperand(0).getReg(), Def->getOperand(0).getReg());
 907   MI.eraseFromParent();
 908   return true;
 909 }
 910
 911 bool SIFoldOperands::runOnMachineFunction(MachineFunction &MF) {
 912   if (skipFunction(*MF.getFunction()))
 913     return false;
 914
 915   MRI = &MF.getRegInfo();
 916   ST = &MF.getSubtarget<SISubtarget>();
 917   TII = ST->getInstrInfo();
 918   TRI = &TII->getRegisterInfo();
 919
 920   const SIMachineFunctionInfo *MFI = MF.getInfo<SIMachineFunctionInfo>();
 921
 922   // omod is ignored by hardware if IEEE bit is enabled. omod also does not
 923   // correctly handle signed zeros.
 924   //
 925   // TODO: Check nsz on instructions when fast math flags are preserved to MI
 926   // level.
 927   bool IsIEEEMode = ST->enableIEEEBit(MF) || !MFI->hasNoSignedZerosFPMath();
 928
 929   for (MachineBasicBlock *MBB : depth_first(&MF)) {
 930     MachineBasicBlock::iterator I, Next;
 931     for (I = MBB->begin(); I != MBB->end(); I = Next) {
 932       Next = std::next(I);
 933       MachineInstr &MI = *I;
 934
 935       tryFoldInst(TII, &MI);
 936
 937       if (!TII->isFoldableCopy(MI)) {
 938         if (IsIEEEMode || !tryFoldOMod(MI))
 939           tryFoldClamp(MI);
 940         continue;
 941       }
 942
 943       MachineOperand &OpToFold = MI.getOperand(1);
 944       bool FoldingImm = OpToFold.isImm() || OpToFold.isFI();
 945
 946       // FIXME: We could also be folding things like TargetIndexes.
 947       if (!FoldingImm && !OpToFold.isReg())
 948         continue;
 949
 950       if (OpToFold.isReg() &&
 951           !TargetRegisterInfo::isVirtualRegister(OpToFold.getReg()))
 952         continue;
 953
 954       // Prevent folding operands backwards in the function. For example,
 955       // the COPY opcode must not be replaced by 1 in this example:
 956       //
 957       //    %vreg3<def> = COPY %VGPR0; VGPR_32:%vreg3
 958       //    ...
 959       //    %VGPR0<def> = V_MOV_B32_e32 1, %EXEC<imp-use>
 960       MachineOperand &Dst = MI.getOperand(0);
 961       if (Dst.isReg() &&
 962           !TargetRegisterInfo::isVirtualRegister(Dst.getReg()))
 963         continue;
 964
 965       foldInstOperand(MI, OpToFold);
 966     }
 967   }
 968   return false;
 969 }