lib/CodeGen/TwoAddressInstructionPass.cpp

   1 //===-- TwoAddressInstructionPass.cpp - Two-Address instruction pass ------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the TwoAddress instruction pass which is used
  11 // by most register allocators. Two-Address instructions are rewritten
  12 // from:
  13 //
  14 //     A = B op C
  15 //
  16 // to:
  17 //
  18 //     A = B
  19 //     A op= C
  20 //
  21 // Note that if a register allocator chooses to use this pass, that it
  22 // has to be capable of handling the non-SSA nature of these rewritten
  23 // virtual registers.
  24 //
  25 // It is also worth noting that the duplicate operand of the two
  26 // address instruction is removed.
  27 //
  28 //===----------------------------------------------------------------------===//
  29
  30 #include "llvm/CodeGen/Passes.h"
  31 #include "llvm/ADT/BitVector.h"
  32 #include "llvm/ADT/DenseMap.h"
  33 #include "llvm/ADT/STLExtras.h"
  34 #include "llvm/ADT/SmallSet.h"
  35 #include "llvm/ADT/Statistic.h"
  36 #include "llvm/Analysis/AliasAnalysis.h"
  37 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  38 #include "llvm/CodeGen/LiveVariables.h"
  39 #include "llvm/CodeGen/MachineFunctionPass.h"
  40 #include "llvm/CodeGen/MachineInstr.h"
  41 #include "llvm/CodeGen/MachineInstrBuilder.h"
  42 #include "llvm/CodeGen/MachineRegisterInfo.h"
  43 #include "llvm/IR/Function.h"
  44 #include "llvm/MC/MCInstrItineraries.h"
  45 #include "llvm/Support/CommandLine.h"
  46 #include "llvm/Support/Debug.h"
  47 #include "llvm/Support/ErrorHandling.h"
  48 #include "llvm/Support/raw_ostream.h"
  49 #include "llvm/Target/TargetInstrInfo.h"
  50 #include "llvm/Target/TargetMachine.h"
  51 #include "llvm/Target/TargetRegisterInfo.h"
  52 #include "llvm/Target/TargetSubtargetInfo.h"
  53 using namespace llvm;
  54
  55 #define DEBUG_TYPE "twoaddrinstr"
  56
  57 STATISTIC(NumTwoAddressInstrs, "Number of two-address instructions");
  58 STATISTIC(NumCommuted        , "Number of instructions commuted to coalesce");
  59 STATISTIC(NumAggrCommuted    , "Number of instructions aggressively commuted");
  60 STATISTIC(NumConvertedTo3Addr, "Number of instructions promoted to 3-address");
  61 STATISTIC(Num3AddrSunk,        "Number of 3-address instructions sunk");
  62 STATISTIC(NumReSchedUps,       "Number of instructions re-scheduled up");
  63 STATISTIC(NumReSchedDowns,     "Number of instructions re-scheduled down");
  64
  65 // Temporary flag to disable rescheduling.
  66 static cl::opt<bool>
  67 EnableRescheduling("twoaddr-reschedule",
  68                    cl::desc("Coalesce copies by rescheduling (default=true)"),
  69                    cl::init(true), cl::Hidden);
  70
  71 namespace {
  72 class TwoAddressInstructionPass : public MachineFunctionPass {
  73   MachineFunction *MF;
  74   const TargetInstrInfo *TII;
  75   const TargetRegisterInfo *TRI;
  76   const InstrItineraryData *InstrItins;
  77   MachineRegisterInfo *MRI;
  78   LiveVariables *LV;
  79   LiveIntervals *LIS;
  80   AliasAnalysis *AA;
  81   CodeGenOpt::Level OptLevel;
  82
  83   // The current basic block being processed.
  84   MachineBasicBlock *MBB;
  85
  86   // DistanceMap - Keep track the distance of a MI from the start of the
  87   // current basic block.
  88   DenseMap<MachineInstr*, unsigned> DistanceMap;
  89
  90   // Set of already processed instructions in the current block.
  91   SmallPtrSet<MachineInstr*, 8> Processed;
  92
  93   // SrcRegMap - A map from virtual registers to physical registers which are
  94   // likely targets to be coalesced to due to copies from physical registers to
  95   // virtual registers. e.g. v1024 = move r0.
  96   DenseMap<unsigned, unsigned> SrcRegMap;
  97
  98   // DstRegMap - A map from virtual registers to physical registers which are
  99   // likely targets to be coalesced to due to copies to physical registers from
 100   // virtual registers. e.g. r1 = move v1024.
 101   DenseMap<unsigned, unsigned> DstRegMap;
 102
 103   bool sink3AddrInstruction(MachineInstr *MI, unsigned Reg,
 104                             MachineBasicBlock::iterator OldPos);
 105
 106   bool isRevCopyChain(unsigned FromReg, unsigned ToReg, int Maxlen);
 107
 108   bool noUseAfterLastDef(unsigned Reg, unsigned Dist, unsigned &LastDef);
 109
 110   bool isProfitableToCommute(unsigned regA, unsigned regB, unsigned regC,
 111                              MachineInstr *MI, unsigned Dist);
 112
 113   bool commuteInstruction(MachineInstr *MI,
 114                           unsigned RegBIdx, unsigned RegCIdx, unsigned Dist);
 115
 116   bool isProfitableToConv3Addr(unsigned RegA, unsigned RegB);
 117
 118   bool convertInstTo3Addr(MachineBasicBlock::iterator &mi,
 119                           MachineBasicBlock::iterator &nmi,
 120                           unsigned RegA, unsigned RegB, unsigned Dist);
 121
 122   bool isDefTooClose(unsigned Reg, unsigned Dist, MachineInstr *MI);
 123
 124   bool rescheduleMIBelowKill(MachineBasicBlock::iterator &mi,
 125                              MachineBasicBlock::iterator &nmi,
 126                              unsigned Reg);
 127   bool rescheduleKillAboveMI(MachineBasicBlock::iterator &mi,
 128                              MachineBasicBlock::iterator &nmi,
 129                              unsigned Reg);
 130
 131   bool tryInstructionTransform(MachineBasicBlock::iterator &mi,
 132                                MachineBasicBlock::iterator &nmi,
 133                                unsigned SrcIdx, unsigned DstIdx,
 134                                unsigned Dist, bool shouldOnlyCommute);
 135
 136   bool tryInstructionCommute(MachineInstr *MI,
 137                              unsigned DstOpIdx,
 138                              unsigned BaseOpIdx,
 139                              bool BaseOpKilled,
 140                              unsigned Dist);
 141   void scanUses(unsigned DstReg);
 142
 143   void processCopy(MachineInstr *MI);
 144
 145   typedef SmallVector<std::pair<unsigned, unsigned>, 4> TiedPairList;
 146   typedef SmallDenseMap<unsigned, TiedPairList> TiedOperandMap;
 147   bool collectTiedOperands(MachineInstr *MI, TiedOperandMap&);
 148   void processTiedPairs(MachineInstr *MI, TiedPairList&, unsigned &Dist);
 149   void eliminateRegSequence(MachineBasicBlock::iterator&);
 150
 151 public:
 152   static char ID; // Pass identification, replacement for typeid
 153   TwoAddressInstructionPass() : MachineFunctionPass(ID) {
 154     initializeTwoAddressInstructionPassPass(*PassRegistry::getPassRegistry());
 155   }
 156
 157   void getAnalysisUsage(AnalysisUsage &AU) const override {
 158     AU.setPreservesCFG();
 159     AU.addRequired<AAResultsWrapperPass>();
 160     AU.addPreserved<LiveVariables>();
 161     AU.addPreserved<SlotIndexes>();
 162     AU.addPreserved<LiveIntervals>();
 163     AU.addPreservedID(MachineLoopInfoID);
 164     AU.addPreservedID(MachineDominatorsID);
 165     MachineFunctionPass::getAnalysisUsage(AU);
 166   }
 167
 168   /// runOnMachineFunction - Pass entry point.
 169   bool runOnMachineFunction(MachineFunction&) override;
 170 };
 171 } // end anonymous namespace
 172
 173 char TwoAddressInstructionPass::ID = 0;
 174 INITIALIZE_PASS_BEGIN(TwoAddressInstructionPass, "twoaddressinstruction",
 175                 "Two-Address instruction pass", false, false)
 176 INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass)
 177 INITIALIZE_PASS_END(TwoAddressInstructionPass, "twoaddressinstruction",
 178                 "Two-Address instruction pass", false, false)
 179
 180 char &llvm::TwoAddressInstructionPassID = TwoAddressInstructionPass::ID;
 181
 182 static bool isPlainlyKilled(MachineInstr *MI, unsigned Reg, LiveIntervals *LIS);
 183
 184 /// sink3AddrInstruction - A two-address instruction has been converted to a
 185 /// three-address instruction to avoid clobbering a register. Try to sink it
 186 /// past the instruction that would kill the above mentioned register to reduce
 187 /// register pressure.
 188 bool TwoAddressInstructionPass::
 189 sink3AddrInstruction(MachineInstr *MI, unsigned SavedReg,
 190                      MachineBasicBlock::iterator OldPos) {
 191   // FIXME: Shouldn't we be trying to do this before we three-addressify the
 192   // instruction?  After this transformation is done, we no longer need
 193   // the instruction to be in three-address form.
 194
 195   // Check if it's safe to move this instruction.
 196   bool SeenStore = true; // Be conservative.
 197   if (!MI->isSafeToMove(AA, SeenStore))
 198     return false;
 199
 200   unsigned DefReg = 0;
 201   SmallSet<unsigned, 4> UseRegs;
 202
 203   for (const MachineOperand &MO : MI->operands()) {
 204     if (!MO.isReg())
 205       continue;
 206     unsigned MOReg = MO.getReg();
 207     if (!MOReg)
 208       continue;
 209     if (MO.isUse() && MOReg != SavedReg)
 210       UseRegs.insert(MO.getReg());
 211     if (!MO.isDef())
 212       continue;
 213     if (MO.isImplicit())
 214       // Don't try to move it if it implicitly defines a register.
 215       return false;
 216     if (DefReg)
 217       // For now, don't move any instructions that define multiple registers.
 218       return false;
 219     DefReg = MO.getReg();
 220   }
 221
 222   // Find the instruction that kills SavedReg.
 223   MachineInstr *KillMI = nullptr;
 224   if (LIS) {
 225     LiveInterval &LI = LIS->getInterval(SavedReg);
 226     assert(LI.end() != LI.begin() &&
 227            "Reg should not have empty live interval.");
 228
 229     SlotIndex MBBEndIdx = LIS->getMBBEndIdx(MBB).getPrevSlot();
 230     LiveInterval::const_iterator I = LI.find(MBBEndIdx);
 231     if (I != LI.end() && I->start < MBBEndIdx)
 232       return false;
 233
 234     --I;
 235     KillMI = LIS->getInstructionFromIndex(I->end);
 236   }
 237   if (!KillMI) {
 238     for (MachineOperand &UseMO : MRI->use_nodbg_operands(SavedReg)) {
 239       if (!UseMO.isKill())
 240         continue;
 241       KillMI = UseMO.getParent();
 242       break;
 243     }
 244   }
 245
 246   // If we find the instruction that kills SavedReg, and it is in an
 247   // appropriate location, we can try to sink the current instruction
 248   // past it.
 249   if (!KillMI || KillMI->getParent() != MBB || KillMI == MI ||
 250       KillMI == OldPos || KillMI->isTerminator())
 251     return false;
 252
 253   // If any of the definitions are used by another instruction between the
 254   // position and the kill use, then it's not safe to sink it.
 255   //
 256   // FIXME: This can be sped up if there is an easy way to query whether an
 257   // instruction is before or after another instruction. Then we can use
 258   // MachineRegisterInfo def / use instead.
 259   MachineOperand *KillMO = nullptr;
 260   MachineBasicBlock::iterator KillPos = KillMI;
 261   ++KillPos;
 262
 263   unsigned NumVisited = 0;
 264   for (MachineBasicBlock::iterator I = std::next(OldPos); I != KillPos; ++I) {
 265     MachineInstr *OtherMI = I;
 266     // DBG_VALUE cannot be counted against the limit.
 267     if (OtherMI->isDebugValue())
 268       continue;
 269     if (NumVisited > 30)  // FIXME: Arbitrary limit to reduce compile time cost.
 270       return false;
 271     ++NumVisited;
 272     for (unsigned i = 0, e = OtherMI->getNumOperands(); i != e; ++i) {
 273       MachineOperand &MO = OtherMI->getOperand(i);
 274       if (!MO.isReg())
 275         continue;
 276       unsigned MOReg = MO.getReg();
 277       if (!MOReg)
 278         continue;
 279       if (DefReg == MOReg)
 280         return false;
 281
 282       if (MO.isKill() || (LIS && isPlainlyKilled(OtherMI, MOReg, LIS))) {
 283         if (OtherMI == KillMI && MOReg == SavedReg)
 284           // Save the operand that kills the register. We want to unset the kill
 285           // marker if we can sink MI past it.
 286           KillMO = &MO;
 287         else if (UseRegs.count(MOReg))
 288           // One of the uses is killed before the destination.
 289           return false;
 290       }
 291     }
 292   }
 293   assert(KillMO && "Didn't find kill");
 294
 295   if (!LIS) {
 296     // Update kill and LV information.
 297     KillMO->setIsKill(false);
 298     KillMO = MI->findRegisterUseOperand(SavedReg, false, TRI);
 299     KillMO->setIsKill(true);
 300
 301     if (LV)
 302       LV->replaceKillInstruction(SavedReg, KillMI, MI);
 303   }
 304
 305   // Move instruction to its destination.
 306   MBB->remove(MI);
 307   MBB->insert(KillPos, MI);
 308
 309   if (LIS)
 310     LIS->handleMove(MI);
 311
 312   ++Num3AddrSunk;
 313   return true;
 314 }
 315
 316 /// getSingleDef -- return the MachineInstr* if it is the single def of the Reg
 317 /// in current BB.
 318 static MachineInstr *getSingleDef(unsigned Reg, MachineBasicBlock *BB,
 319                                   const MachineRegisterInfo *MRI) {
 320   MachineInstr *Ret = nullptr;
 321   for (MachineInstr &DefMI : MRI->def_instructions(Reg)) {
 322     if (DefMI.getParent() != BB || DefMI.isDebugValue())
 323       continue;
 324     if (!Ret)
 325       Ret = &DefMI;
 326     else if (Ret != &DefMI)
 327       return nullptr;
 328   }
 329   return Ret;
 330 }
 331
 332 /// Check if there is a reversed copy chain from FromReg to ToReg:
 333 /// %Tmp1 = copy %Tmp2;
 334 /// %FromReg = copy %Tmp1;
 335 /// %ToReg = add %FromReg ...
 336 /// %Tmp2 = copy %ToReg;
 337 /// MaxLen specifies the maximum length of the copy chain the func
 338 /// can walk through.
 339 bool TwoAddressInstructionPass::isRevCopyChain(unsigned FromReg, unsigned ToReg,
 340                                                int Maxlen) {
 341   unsigned TmpReg = FromReg;
 342   for (int i = 0; i < Maxlen; i++) {
 343     MachineInstr *Def = getSingleDef(TmpReg, MBB, MRI);
 344     if (!Def || !Def->isCopy())
 345       return false;
 346
 347     TmpReg = Def->getOperand(1).getReg();
 348
 349     if (TmpReg == ToReg)
 350       return true;
 351   }
 352   return false;
 353 }
 354
 355 /// noUseAfterLastDef - Return true if there are no intervening uses between the
 356 /// last instruction in the MBB that defines the specified register and the
 357 /// two-address instruction which is being processed. It also returns the last
 358 /// def location by reference
 359 bool TwoAddressInstructionPass::noUseAfterLastDef(unsigned Reg, unsigned Dist,
 360                                                   unsigned &LastDef) {
 361   LastDef = 0;
 362   unsigned LastUse = Dist;
 363   for (MachineOperand &MO : MRI->reg_operands(Reg)) {
 364     MachineInstr *MI = MO.getParent();
 365     if (MI->getParent() != MBB || MI->isDebugValue())
 366       continue;
 367     DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(MI);
 368     if (DI == DistanceMap.end())
 369       continue;
 370     if (MO.isUse() && DI->second < LastUse)
 371       LastUse = DI->second;
 372     if (MO.isDef() && DI->second > LastDef)
 373       LastDef = DI->second;
 374   }
 375
 376   return !(LastUse > LastDef && LastUse < Dist);
 377 }
 378
 379 /// isCopyToReg - Return true if the specified MI is a copy instruction or
 380 /// a extract_subreg instruction. It also returns the source and destination
 381 /// registers and whether they are physical registers by reference.
 382 static bool isCopyToReg(MachineInstr &MI, const TargetInstrInfo *TII,
 383                         unsigned &SrcReg, unsigned &DstReg,
 384                         bool &IsSrcPhys, bool &IsDstPhys) {
 385   SrcReg = 0;
 386   DstReg = 0;
 387   if (MI.isCopy()) {
 388     DstReg = MI.getOperand(0).getReg();
 389     SrcReg = MI.getOperand(1).getReg();
 390   } else if (MI.isInsertSubreg() || MI.isSubregToReg()) {
 391     DstReg = MI.getOperand(0).getReg();
 392     SrcReg = MI.getOperand(2).getReg();
 393   } else
 394     return false;
 395
 396   IsSrcPhys = TargetRegisterInfo::isPhysicalRegister(SrcReg);
 397   IsDstPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
 398   return true;
 399 }
 400
 401 /// isPLainlyKilled - Test if the given register value, which is used by the
 402 // given instruction, is killed by the given instruction.
 403 static bool isPlainlyKilled(MachineInstr *MI, unsigned Reg,
 404                             LiveIntervals *LIS) {
 405   if (LIS && TargetRegisterInfo::isVirtualRegister(Reg) &&
 406       !LIS->isNotInMIMap(MI)) {
 407     // FIXME: Sometimes tryInstructionTransform() will add instructions and
 408     // test whether they can be folded before keeping them. In this case it
 409     // sets a kill before recursively calling tryInstructionTransform() again.
 410     // If there is no interval available, we assume that this instruction is
 411     // one of those. A kill flag is manually inserted on the operand so the
 412     // check below will handle it.
 413     LiveInterval &LI = LIS->getInterval(Reg);
 414     // This is to match the kill flag version where undefs don't have kill
 415     // flags.
 416     if (!LI.hasAtLeastOneValue())
 417       return false;
 418
 419     SlotIndex useIdx = LIS->getInstructionIndex(MI);
 420     LiveInterval::const_iterator I = LI.find(useIdx);
 421     assert(I != LI.end() && "Reg must be live-in to use.");
 422     return !I->end.isBlock() && SlotIndex::isSameInstr(I->end, useIdx);
 423   }
 424
 425   return MI->killsRegister(Reg);
 426 }
 427
 428 /// isKilled - Test if the given register value, which is used by the given
 429 /// instruction, is killed by the given instruction. This looks through
 430 /// coalescable copies to see if the original value is potentially not killed.
 431 ///
 432 /// For example, in this code:
 433 ///
 434 ///   %reg1034 = copy %reg1024
 435 ///   %reg1035 = copy %reg1025<kill>
 436 ///   %reg1036 = add %reg1034<kill>, %reg1035<kill>
 437 ///
 438 /// %reg1034 is not considered to be killed, since it is copied from a
 439 /// register which is not killed. Treating it as not killed lets the
 440 /// normal heuristics commute the (two-address) add, which lets
 441 /// coalescing eliminate the extra copy.
 442 ///
 443 /// If allowFalsePositives is true then likely kills are treated as kills even
 444 /// if it can't be proven that they are kills.
 445 static bool isKilled(MachineInstr &MI, unsigned Reg,
 446                      const MachineRegisterInfo *MRI,
 447                      const TargetInstrInfo *TII,
 448                      LiveIntervals *LIS,
 449                      bool allowFalsePositives) {
 450   MachineInstr *DefMI = &MI;
 451   for (;;) {
 452     // All uses of physical registers are likely to be kills.
 453     if (TargetRegisterInfo::isPhysicalRegister(Reg) &&
 454         (allowFalsePositives || MRI->hasOneUse(Reg)))
 455       return true;
 456     if (!isPlainlyKilled(DefMI, Reg, LIS))
 457       return false;
 458     if (TargetRegisterInfo::isPhysicalRegister(Reg))
 459       return true;
 460     MachineRegisterInfo::def_iterator Begin = MRI->def_begin(Reg);
 461     // If there are multiple defs, we can't do a simple analysis, so just
 462     // go with what the kill flag says.
 463     if (std::next(Begin) != MRI->def_end())
 464       return true;
 465     DefMI = Begin->getParent();
 466     bool IsSrcPhys, IsDstPhys;
 467     unsigned SrcReg,  DstReg;
 468     // If the def is something other than a copy, then it isn't going to
 469     // be coalesced, so follow the kill flag.
 470     if (!isCopyToReg(*DefMI, TII, SrcReg, DstReg, IsSrcPhys, IsDstPhys))
 471       return true;
 472     Reg = SrcReg;
 473   }
 474 }
 475
 476 /// isTwoAddrUse - Return true if the specified MI uses the specified register
 477 /// as a two-address use. If so, return the destination register by reference.
 478 static bool isTwoAddrUse(MachineInstr &MI, unsigned Reg, unsigned &DstReg) {
 479   for (unsigned i = 0, NumOps = MI.getNumOperands(); i != NumOps; ++i) {
 480     const MachineOperand &MO = MI.getOperand(i);
 481     if (!MO.isReg() || !MO.isUse() || MO.getReg() != Reg)
 482       continue;
 483     unsigned ti;
 484     if (MI.isRegTiedToDefOperand(i, &ti)) {
 485       DstReg = MI.getOperand(ti).getReg();
 486       return true;
 487     }
 488   }
 489   return false;
 490 }
 491
 492 /// findOnlyInterestingUse - Given a register, if has a single in-basic block
 493 /// use, return the use instruction if it's a copy or a two-address use.
 494 static
 495 MachineInstr *findOnlyInterestingUse(unsigned Reg, MachineBasicBlock *MBB,
 496                                      MachineRegisterInfo *MRI,
 497                                      const TargetInstrInfo *TII,
 498                                      bool &IsCopy,
 499                                      unsigned &DstReg, bool &IsDstPhys) {
 500   if (!MRI->hasOneNonDBGUse(Reg))
 501     // None or more than one use.
 502     return nullptr;
 503   MachineInstr &UseMI = *MRI->use_instr_nodbg_begin(Reg);
 504   if (UseMI.getParent() != MBB)
 505     return nullptr;
 506   unsigned SrcReg;
 507   bool IsSrcPhys;
 508   if (isCopyToReg(UseMI, TII, SrcReg, DstReg, IsSrcPhys, IsDstPhys)) {
 509     IsCopy = true;
 510     return &UseMI;
 511   }
 512   IsDstPhys = false;
 513   if (isTwoAddrUse(UseMI, Reg, DstReg)) {
 514     IsDstPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
 515     return &UseMI;
 516   }
 517   return nullptr;
 518 }
 519
 520 /// getMappedReg - Return the physical register the specified virtual register
 521 /// might be mapped to.
 522 static unsigned
 523 getMappedReg(unsigned Reg, DenseMap<unsigned, unsigned> &RegMap) {
 524   while (TargetRegisterInfo::isVirtualRegister(Reg))  {
 525     DenseMap<unsigned, unsigned>::iterator SI = RegMap.find(Reg);
 526     if (SI == RegMap.end())
 527       return 0;
 528     Reg = SI->second;
 529   }
 530   if (TargetRegisterInfo::isPhysicalRegister(Reg))
 531     return Reg;
 532   return 0;
 533 }
 534
 535 /// regsAreCompatible - Return true if the two registers are equal or aliased.
 536 ///
 537 static bool
 538 regsAreCompatible(unsigned RegA, unsigned RegB, const TargetRegisterInfo *TRI) {
 539   if (RegA == RegB)
 540     return true;
 541   if (!RegA || !RegB)
 542     return false;
 543   return TRI->regsOverlap(RegA, RegB);
 544 }
 545
 546
 547 /// isProfitableToCommute - Return true if it's potentially profitable to commute
 548 /// the two-address instruction that's being processed.
 549 bool
 550 TwoAddressInstructionPass::
 551 isProfitableToCommute(unsigned regA, unsigned regB, unsigned regC,
 552                       MachineInstr *MI, unsigned Dist) {
 553   if (OptLevel == CodeGenOpt::None)
 554     return false;
 555
 556   // Determine if it's profitable to commute this two address instruction. In
 557   // general, we want no uses between this instruction and the definition of
 558   // the two-address register.
 559   // e.g.
 560   // %reg1028<def> = EXTRACT_SUBREG %reg1027<kill>, 1
 561   // %reg1029<def> = MOV8rr %reg1028
 562   // %reg1029<def> = SHR8ri %reg1029, 7, %EFLAGS<imp-def,dead>
 563   // insert => %reg1030<def> = MOV8rr %reg1028
 564   // %reg1030<def> = ADD8rr %reg1028<kill>, %reg1029<kill>, %EFLAGS<imp-def,dead>
 565   // In this case, it might not be possible to coalesce the second MOV8rr
 566   // instruction if the first one is coalesced. So it would be profitable to
 567   // commute it:
 568   // %reg1028<def> = EXTRACT_SUBREG %reg1027<kill>, 1
 569   // %reg1029<def> = MOV8rr %reg1028
 570   // %reg1029<def> = SHR8ri %reg1029, 7, %EFLAGS<imp-def,dead>
 571   // insert => %reg1030<def> = MOV8rr %reg1029
 572   // %reg1030<def> = ADD8rr %reg1029<kill>, %reg1028<kill>, %EFLAGS<imp-def,dead>
 573
 574   if (!isPlainlyKilled(MI, regC, LIS))
 575     return false;
 576
 577   // Ok, we have something like:
 578   // %reg1030<def> = ADD8rr %reg1028<kill>, %reg1029<kill>, %EFLAGS<imp-def,dead>
 579   // let's see if it's worth commuting it.
 580
 581   // Look for situations like this:
 582   // %reg1024<def> = MOV r1
 583   // %reg1025<def> = MOV r0
 584   // %reg1026<def> = ADD %reg1024, %reg1025
 585   // r0            = MOV %reg1026
 586   // Commute the ADD to hopefully eliminate an otherwise unavoidable copy.
 587   unsigned ToRegA = getMappedReg(regA, DstRegMap);
 588   if (ToRegA) {
 589     unsigned FromRegB = getMappedReg(regB, SrcRegMap);
 590     unsigned FromRegC = getMappedReg(regC, SrcRegMap);
 591     bool CompB = FromRegB && regsAreCompatible(FromRegB, ToRegA, TRI);
 592     bool CompC = FromRegC && regsAreCompatible(FromRegC, ToRegA, TRI);
 593
 594     // Compute if any of the following are true:
 595     // -RegB is not tied to a register and RegC is compatible with RegA.
 596     // -RegB is tied to the wrong physical register, but RegC is.
 597     // -RegB is tied to the wrong physical register, and RegC isn't tied.
 598     if ((!FromRegB && CompC) || (FromRegB && !CompB && (!FromRegC || CompC)))
 599       return true;
 600     // Don't compute if any of the following are true:
 601     // -RegC is not tied to a register and RegB is compatible with RegA.
 602     // -RegC is tied to the wrong physical register, but RegB is.
 603     // -RegC is tied to the wrong physical register, and RegB isn't tied.
 604     if ((!FromRegC && CompB) || (FromRegC && !CompC && (!FromRegB || CompB)))
 605       return false;
 606   }
 607
 608   // If there is a use of regC between its last def (could be livein) and this
 609   // instruction, then bail.
 610   unsigned LastDefC = 0;
 611   if (!noUseAfterLastDef(regC, Dist, LastDefC))
 612     return false;
 613
 614   // If there is a use of regB between its last def (could be livein) and this
 615   // instruction, then go ahead and make this transformation.
 616   unsigned LastDefB = 0;
 617   if (!noUseAfterLastDef(regB, Dist, LastDefB))
 618     return true;
 619
 620   // Look for situation like this:
 621   // %reg101 = MOV %reg100
 622   // %reg102 = ...
 623   // %reg103 = ADD %reg102, %reg101
 624   // ... = %reg103 ...
 625   // %reg100 = MOV %reg103
 626   // If there is a reversed copy chain from reg101 to reg103, commute the ADD
 627   // to eliminate an otherwise unavoidable copy.
 628   // FIXME:
 629   // We can extend the logic further: If an pair of operands in an insn has
 630   // been merged, the insn could be regarded as a virtual copy, and the virtual
 631   // copy could also be used to construct a copy chain.
 632   // To more generally minimize register copies, ideally the logic of two addr
 633   // instruction pass should be integrated with register allocation pass where
 634   // interference graph is available.
 635   if (isRevCopyChain(regC, regA, 3))
 636     return true;
 637
 638   if (isRevCopyChain(regB, regA, 3))
 639     return false;
 640
 641   // Since there are no intervening uses for both registers, then commute
 642   // if the def of regC is closer. Its live interval is shorter.
 643   return LastDefB && LastDefC && LastDefC > LastDefB;
 644 }
 645
 646 /// commuteInstruction - Commute a two-address instruction and update the basic
 647 /// block, distance map, and live variables if needed. Return true if it is
 648 /// successful.
 649 bool TwoAddressInstructionPass::commuteInstruction(MachineInstr *MI,
 650                                                    unsigned RegBIdx,
 651                                                    unsigned RegCIdx,
 652                                                    unsigned Dist) {
 653   unsigned RegC = MI->getOperand(RegCIdx).getReg();
 654   DEBUG(dbgs() << "2addr: COMMUTING  : " << *MI);
 655   MachineInstr *NewMI = TII->commuteInstruction(MI, false, RegBIdx, RegCIdx);
 656
 657   if (NewMI == nullptr) {
 658     DEBUG(dbgs() << "2addr: COMMUTING FAILED!\n");
 659     return false;
 660   }
 661
 662   DEBUG(dbgs() << "2addr: COMMUTED TO: " << *NewMI);
 663   assert(NewMI == MI &&
 664          "TargetInstrInfo::commuteInstruction() should not return a new "
 665          "instruction unless it was requested.");
 666
 667   // Update source register map.
 668   unsigned FromRegC = getMappedReg(RegC, SrcRegMap);
 669   if (FromRegC) {
 670     unsigned RegA = MI->getOperand(0).getReg();
 671     SrcRegMap[RegA] = FromRegC;
 672   }
 673
 674   return true;
 675 }
 676
 677 /// isProfitableToConv3Addr - Return true if it is profitable to convert the
 678 /// given 2-address instruction to a 3-address one.
 679 bool
 680 TwoAddressInstructionPass::isProfitableToConv3Addr(unsigned RegA,unsigned RegB){
 681   // Look for situations like this:
 682   // %reg1024<def> = MOV r1
 683   // %reg1025<def> = MOV r0
 684   // %reg1026<def> = ADD %reg1024, %reg1025
 685   // r2            = MOV %reg1026
 686   // Turn ADD into a 3-address instruction to avoid a copy.
 687   unsigned FromRegB = getMappedReg(RegB, SrcRegMap);
 688   if (!FromRegB)
 689     return false;
 690   unsigned ToRegA = getMappedReg(RegA, DstRegMap);
 691   return (ToRegA && !regsAreCompatible(FromRegB, ToRegA, TRI));
 692 }
 693
 694 /// convertInstTo3Addr - Convert the specified two-address instruction into a
 695 /// three address one. Return true if this transformation was successful.
 696 bool
 697 TwoAddressInstructionPass::convertInstTo3Addr(MachineBasicBlock::iterator &mi,
 698                                               MachineBasicBlock::iterator &nmi,
 699                                               unsigned RegA, unsigned RegB,
 700                                               unsigned Dist) {
 701   // FIXME: Why does convertToThreeAddress() need an iterator reference?
 702   MachineFunction::iterator MFI = MBB;
 703   MachineInstr *NewMI = TII->convertToThreeAddress(MFI, mi, LV);
 704   assert(MBB == MFI && "convertToThreeAddress changed iterator reference");
 705   if (!NewMI)
 706     return false;
 707
 708   DEBUG(dbgs() << "2addr: CONVERTING 2-ADDR: " << *mi);
 709   DEBUG(dbgs() << "2addr:         TO 3-ADDR: " << *NewMI);
 710   bool Sunk = false;
 711
 712   if (LIS)
 713     LIS->ReplaceMachineInstrInMaps(mi, NewMI);
 714
 715   if (NewMI->findRegisterUseOperand(RegB, false, TRI))
 716     // FIXME: Temporary workaround. If the new instruction doesn't
 717     // uses RegB, convertToThreeAddress must have created more
 718     // then one instruction.
 719     Sunk = sink3AddrInstruction(NewMI, RegB, mi);
 720
 721   MBB->erase(mi); // Nuke the old inst.
 722
 723   if (!Sunk) {
 724     DistanceMap.insert(std::make_pair(NewMI, Dist));
 725     mi = NewMI;
 726     nmi = std::next(mi);
 727   }
 728
 729   // Update source and destination register maps.
 730   SrcRegMap.erase(RegA);
 731   DstRegMap.erase(RegB);
 732   return true;
 733 }
 734
 735 /// scanUses - Scan forward recursively for only uses, update maps if the use
 736 /// is a copy or a two-address instruction.
 737 void
 738 TwoAddressInstructionPass::scanUses(unsigned DstReg) {
 739   SmallVector<unsigned, 4> VirtRegPairs;
 740   bool IsDstPhys;
 741   bool IsCopy = false;
 742   unsigned NewReg = 0;
 743   unsigned Reg = DstReg;
 744   while (MachineInstr *UseMI = findOnlyInterestingUse(Reg, MBB, MRI, TII,IsCopy,
 745                                                       NewReg, IsDstPhys)) {
 746     if (IsCopy && !Processed.insert(UseMI).second)
 747       break;
 748
 749     DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(UseMI);
 750     if (DI != DistanceMap.end())
 751       // Earlier in the same MBB.Reached via a back edge.
 752       break;
 753
 754     if (IsDstPhys) {
 755       VirtRegPairs.push_back(NewReg);
 756       break;
 757     }
 758     bool isNew = SrcRegMap.insert(std::make_pair(NewReg, Reg)).second;
 759     if (!isNew)
 760       assert(SrcRegMap[NewReg] == Reg && "Can't map to two src registers!");
 761     VirtRegPairs.push_back(NewReg);
 762     Reg = NewReg;
 763   }
 764
 765   if (!VirtRegPairs.empty()) {
 766     unsigned ToReg = VirtRegPairs.back();
 767     VirtRegPairs.pop_back();
 768     while (!VirtRegPairs.empty()) {
 769       unsigned FromReg = VirtRegPairs.back();
 770       VirtRegPairs.pop_back();
 771       bool isNew = DstRegMap.insert(std::make_pair(FromReg, ToReg)).second;
 772       if (!isNew)
 773         assert(DstRegMap[FromReg] == ToReg &&"Can't map to two dst registers!");
 774       ToReg = FromReg;
 775     }
 776     bool isNew = DstRegMap.insert(std::make_pair(DstReg, ToReg)).second;
 777     if (!isNew)
 778       assert(DstRegMap[DstReg] == ToReg && "Can't map to two dst registers!");
 779   }
 780 }
 781
 782 /// processCopy - If the specified instruction is not yet processed, process it
 783 /// if it's a copy. For a copy instruction, we find the physical registers the
 784 /// source and destination registers might be mapped to. These are kept in
 785 /// point-to maps used to determine future optimizations. e.g.
 786 /// v1024 = mov r0
 787 /// v1025 = mov r1
 788 /// v1026 = add v1024, v1025
 789 /// r1    = mov r1026
 790 /// If 'add' is a two-address instruction, v1024, v1026 are both potentially
 791 /// coalesced to r0 (from the input side). v1025 is mapped to r1. v1026 is
 792 /// potentially joined with r1 on the output side. It's worthwhile to commute
 793 /// 'add' to eliminate a copy.
 794 void TwoAddressInstructionPass::processCopy(MachineInstr *MI) {
 795   if (Processed.count(MI))
 796     return;
 797
 798   bool IsSrcPhys, IsDstPhys;
 799   unsigned SrcReg, DstReg;
 800   if (!isCopyToReg(*MI, TII, SrcReg, DstReg, IsSrcPhys, IsDstPhys))
 801     return;
 802
 803   if (IsDstPhys && !IsSrcPhys)
 804     DstRegMap.insert(std::make_pair(SrcReg, DstReg));
 805   else if (!IsDstPhys && IsSrcPhys) {
 806     bool isNew = SrcRegMap.insert(std::make_pair(DstReg, SrcReg)).second;
 807     if (!isNew)
 808       assert(SrcRegMap[DstReg] == SrcReg &&
 809              "Can't map to two src physical registers!");
 810
 811     scanUses(DstReg);
 812   }
 813
 814   Processed.insert(MI);
 815   return;
 816 }
 817
 818 /// rescheduleMIBelowKill - If there is one more local instruction that reads
 819 /// 'Reg' and it kills 'Reg, consider moving the instruction below the kill
 820 /// instruction in order to eliminate the need for the copy.
 821 bool TwoAddressInstructionPass::
 822 rescheduleMIBelowKill(MachineBasicBlock::iterator &mi,
 823                       MachineBasicBlock::iterator &nmi,
 824                       unsigned Reg) {
 825   // Bail immediately if we don't have LV or LIS available. We use them to find
 826   // kills efficiently.
 827   if (!LV && !LIS)
 828     return false;
 829
 830   MachineInstr *MI = &*mi;
 831   DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(MI);
 832   if (DI == DistanceMap.end())
 833     // Must be created from unfolded load. Don't waste time trying this.
 834     return false;
 835
 836   MachineInstr *KillMI = nullptr;
 837   if (LIS) {
 838     LiveInterval &LI = LIS->getInterval(Reg);
 839     assert(LI.end() != LI.begin() &&
 840            "Reg should not have empty live interval.");
 841
 842     SlotIndex MBBEndIdx = LIS->getMBBEndIdx(MBB).getPrevSlot();
 843     LiveInterval::const_iterator I = LI.find(MBBEndIdx);
 844     if (I != LI.end() && I->start < MBBEndIdx)
 845       return false;
 846
 847     --I;
 848     KillMI = LIS->getInstructionFromIndex(I->end);
 849   } else {
 850     KillMI = LV->getVarInfo(Reg).findKill(MBB);
 851   }
 852   if (!KillMI || MI == KillMI || KillMI->isCopy() || KillMI->isCopyLike())
 853     // Don't mess with copies, they may be coalesced later.
 854     return false;
 855
 856   if (KillMI->hasUnmodeledSideEffects() || KillMI->isCall() ||
 857       KillMI->isBranch() || KillMI->isTerminator())
 858     // Don't move pass calls, etc.
 859     return false;
 860
 861   unsigned DstReg;
 862   if (isTwoAddrUse(*KillMI, Reg, DstReg))
 863     return false;
 864
 865   bool SeenStore = true;
 866   if (!MI->isSafeToMove(AA, SeenStore))
 867     return false;
 868
 869   if (TII->getInstrLatency(InstrItins, MI) > 1)
 870     // FIXME: Needs more sophisticated heuristics.
 871     return false;
 872
 873   SmallSet<unsigned, 2> Uses;
 874   SmallSet<unsigned, 2> Kills;
 875   SmallSet<unsigned, 2> Defs;
 876   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 877     const MachineOperand &MO = MI->getOperand(i);
 878     if (!MO.isReg())
 879       continue;
 880     unsigned MOReg = MO.getReg();
 881     if (!MOReg)
 882       continue;
 883     if (MO.isDef())
 884       Defs.insert(MOReg);
 885     else {
 886       Uses.insert(MOReg);
 887       if (MOReg != Reg && (MO.isKill() ||
 888                            (LIS && isPlainlyKilled(MI, MOReg, LIS))))
 889         Kills.insert(MOReg);
 890     }
 891   }
 892
 893   // Move the copies connected to MI down as well.
 894   MachineBasicBlock::iterator Begin = MI;
 895   MachineBasicBlock::iterator AfterMI = std::next(Begin);
 896
 897   MachineBasicBlock::iterator End = AfterMI;
 898   while (End->isCopy() && Defs.count(End->getOperand(1).getReg())) {
 899     Defs.insert(End->getOperand(0).getReg());
 900     ++End;
 901   }
 902
 903   // Check if the reschedule will not break depedencies.
 904   unsigned NumVisited = 0;
 905   MachineBasicBlock::iterator KillPos = KillMI;
 906   ++KillPos;
 907   for (MachineBasicBlock::iterator I = End; I != KillPos; ++I) {
 908     MachineInstr *OtherMI = I;
 909     // DBG_VALUE cannot be counted against the limit.
 910     if (OtherMI->isDebugValue())
 911       continue;
 912     if (NumVisited > 10)  // FIXME: Arbitrary limit to reduce compile time cost.
 913       return false;
 914     ++NumVisited;
 915     if (OtherMI->hasUnmodeledSideEffects() || OtherMI->isCall() ||
 916         OtherMI->isBranch() || OtherMI->isTerminator())
 917       // Don't move pass calls, etc.
 918       return false;
 919     for (unsigned i = 0, e = OtherMI->getNumOperands(); i != e; ++i) {
 920       const MachineOperand &MO = OtherMI->getOperand(i);
 921       if (!MO.isReg())
 922         continue;
 923       unsigned MOReg = MO.getReg();
 924       if (!MOReg)
 925         continue;
 926       if (MO.isDef()) {
 927         if (Uses.count(MOReg))
 928           // Physical register use would be clobbered.
 929           return false;
 930         if (!MO.isDead() && Defs.count(MOReg))
 931           // May clobber a physical register def.
 932           // FIXME: This may be too conservative. It's ok if the instruction
 933           // is sunken completely below the use.
 934           return false;
 935       } else {
 936         if (Defs.count(MOReg))
 937           return false;
 938         bool isKill = MO.isKill() ||
 939                       (LIS && isPlainlyKilled(OtherMI, MOReg, LIS));
 940         if (MOReg != Reg &&
 941             ((isKill && Uses.count(MOReg)) || Kills.count(MOReg)))
 942           // Don't want to extend other live ranges and update kills.
 943           return false;
 944         if (MOReg == Reg && !isKill)
 945           // We can't schedule across a use of the register in question.
 946           return false;
 947         // Ensure that if this is register in question, its the kill we expect.
 948         assert((MOReg != Reg || OtherMI == KillMI) &&
 949                "Found multiple kills of a register in a basic block");
 950       }
 951     }
 952   }
 953
 954   // Move debug info as well.
 955   while (Begin != MBB->begin() && std::prev(Begin)->isDebugValue())
 956     --Begin;
 957
 958   nmi = End;
 959   MachineBasicBlock::iterator InsertPos = KillPos;
 960   if (LIS) {
 961     // We have to move the copies first so that the MBB is still well-formed
 962     // when calling handleMove().
 963     for (MachineBasicBlock::iterator MBBI = AfterMI; MBBI != End;) {
 964       MachineInstr *CopyMI = MBBI;
 965       ++MBBI;
 966       MBB->splice(InsertPos, MBB, CopyMI);
 967       LIS->handleMove(CopyMI);
 968       InsertPos = CopyMI;
 969     }
 970     End = std::next(MachineBasicBlock::iterator(MI));
 971   }
 972
 973   // Copies following MI may have been moved as well.
 974   MBB->splice(InsertPos, MBB, Begin, End);
 975   DistanceMap.erase(DI);
 976
 977   // Update live variables
 978   if (LIS) {
 979     LIS->handleMove(MI);
 980   } else {
 981     LV->removeVirtualRegisterKilled(Reg, KillMI);
 982     LV->addVirtualRegisterKilled(Reg, MI);
 983   }
 984
 985   DEBUG(dbgs() << "\trescheduled below kill: " << *KillMI);
 986   return true;
 987 }
 988
 989 /// isDefTooClose - Return true if the re-scheduling will put the given
 990 /// instruction too close to the defs of its register dependencies.
 991 bool TwoAddressInstructionPass::isDefTooClose(unsigned Reg, unsigned Dist,
 992                                               MachineInstr *MI) {
 993   for (MachineInstr &DefMI : MRI->def_instructions(Reg)) {
 994     if (DefMI.getParent() != MBB || DefMI.isCopy() || DefMI.isCopyLike())
 995       continue;
 996     if (&DefMI == MI)
 997       return true; // MI is defining something KillMI uses
 998     DenseMap<MachineInstr*, unsigned>::iterator DDI = DistanceMap.find(&DefMI);
 999     if (DDI == DistanceMap.end())
1000       return true;  // Below MI
1001     unsigned DefDist = DDI->second;
1002     assert(Dist > DefDist && "Visited def already?");
1003     if (TII->getInstrLatency(InstrItins, &DefMI) > (Dist - DefDist))
1004       return true;
1005   }
1006   return false;
1007 }
1008
1009 /// rescheduleKillAboveMI - If there is one more local instruction that reads
1010 /// 'Reg' and it kills 'Reg, consider moving the kill instruction above the
1011 /// current two-address instruction in order to eliminate the need for the
1012 /// copy.
1013 bool TwoAddressInstructionPass::
1014 rescheduleKillAboveMI(MachineBasicBlock::iterator &mi,
1015                       MachineBasicBlock::iterator &nmi,
1016                       unsigned Reg) {
1017   // Bail immediately if we don't have LV or LIS available. We use them to find
1018   // kills efficiently.
1019   if (!LV && !LIS)
1020     return false;
1021
1022   MachineInstr *MI = &*mi;
1023   DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(MI);
1024   if (DI == DistanceMap.end())
1025     // Must be created from unfolded load. Don't waste time trying this.
1026     return false;
1027
1028   MachineInstr *KillMI = nullptr;
1029   if (LIS) {
1030     LiveInterval &LI = LIS->getInterval(Reg);
1031     assert(LI.end() != LI.begin() &&
1032            "Reg should not have empty live interval.");
1033
1034     SlotIndex MBBEndIdx = LIS->getMBBEndIdx(MBB).getPrevSlot();
1035     LiveInterval::const_iterator I = LI.find(MBBEndIdx);
1036     if (I != LI.end() && I->start < MBBEndIdx)
1037       return false;
1038
1039     --I;
1040     KillMI = LIS->getInstructionFromIndex(I->end);
1041   } else {
1042     KillMI = LV->getVarInfo(Reg).findKill(MBB);
1043   }
1044   if (!KillMI || MI == KillMI || KillMI->isCopy() || KillMI->isCopyLike())
1045     // Don't mess with copies, they may be coalesced later.
1046     return false;
1047
1048   unsigned DstReg;
1049   if (isTwoAddrUse(*KillMI, Reg, DstReg))
1050     return false;
1051
1052   bool SeenStore = true;
1053   if (!KillMI->isSafeToMove(AA, SeenStore))
1054     return false;
1055
1056   SmallSet<unsigned, 2> Uses;
1057   SmallSet<unsigned, 2> Kills;
1058   SmallSet<unsigned, 2> Defs;
1059   SmallSet<unsigned, 2> LiveDefs;
1060   for (unsigned i = 0, e = KillMI->getNumOperands(); i != e; ++i) {
1061     const MachineOperand &MO = KillMI->getOperand(i);
1062     if (!MO.isReg())
1063       continue;
1064     unsigned MOReg = MO.getReg();
1065     if (MO.isUse()) {
1066       if (!MOReg)
1067         continue;
1068       if (isDefTooClose(MOReg, DI->second, MI))
1069         return false;
1070       bool isKill = MO.isKill() || (LIS && isPlainlyKilled(KillMI, MOReg, LIS));
1071       if (MOReg == Reg && !isKill)
1072         return false;
1073       Uses.insert(MOReg);
1074       if (isKill && MOReg != Reg)
1075         Kills.insert(MOReg);
1076     } else if (TargetRegisterInfo::isPhysicalRegister(MOReg)) {
1077       Defs.insert(MOReg);
1078       if (!MO.isDead())
1079         LiveDefs.insert(MOReg);
1080     }
1081   }
1082
1083   // Check if the reschedule will not break depedencies.
1084   unsigned NumVisited = 0;
1085   MachineBasicBlock::iterator KillPos = KillMI;
1086   for (MachineBasicBlock::iterator I = mi; I != KillPos; ++I) {
1087     MachineInstr *OtherMI = I;
1088     // DBG_VALUE cannot be counted against the limit.
1089     if (OtherMI->isDebugValue())
1090       continue;
1091     if (NumVisited > 10)  // FIXME: Arbitrary limit to reduce compile time cost.
1092       return false;
1093     ++NumVisited;
1094     if (OtherMI->hasUnmodeledSideEffects() || OtherMI->isCall() ||
1095         OtherMI->isBranch() || OtherMI->isTerminator())
1096       // Don't move pass calls, etc.
1097       return false;
1098     SmallVector<unsigned, 2> OtherDefs;
1099     for (unsigned i = 0, e = OtherMI->getNumOperands(); i != e; ++i) {
1100       const MachineOperand &MO = OtherMI->getOperand(i);
1101       if (!MO.isReg())
1102         continue;
1103       unsigned MOReg = MO.getReg();
1104       if (!MOReg)
1105         continue;
1106       if (MO.isUse()) {
1107         if (Defs.count(MOReg))
1108           // Moving KillMI can clobber the physical register if the def has
1109           // not been seen.
1110           return false;
1111         if (Kills.count(MOReg))
1112           // Don't want to extend other live ranges and update kills.
1113           return false;
1114         if (OtherMI != MI && MOReg == Reg &&
1115             !(MO.isKill() || (LIS && isPlainlyKilled(OtherMI, MOReg, LIS))))
1116           // We can't schedule across a use of the register in question.
1117           return false;
1118       } else {
1119         OtherDefs.push_back(MOReg);
1120       }
1121     }
1122
1123     for (unsigned i = 0, e = OtherDefs.size(); i != e; ++i) {
1124       unsigned MOReg = OtherDefs[i];
1125       if (Uses.count(MOReg))
1126         return false;
1127       if (TargetRegisterInfo::isPhysicalRegister(MOReg) &&
1128           LiveDefs.count(MOReg))
1129         return false;
1130       // Physical register def is seen.
1131       Defs.erase(MOReg);
1132     }
1133   }
1134
1135   // Move the old kill above MI, don't forget to move debug info as well.
1136   MachineBasicBlock::iterator InsertPos = mi;
1137   while (InsertPos != MBB->begin() && std::prev(InsertPos)->isDebugValue())
1138     --InsertPos;
1139   MachineBasicBlock::iterator From = KillMI;
1140   MachineBasicBlock::iterator To = std::next(From);
1141   while (std::prev(From)->isDebugValue())
1142     --From;
1143   MBB->splice(InsertPos, MBB, From, To);
1144
1145   nmi = std::prev(InsertPos); // Backtrack so we process the moved instr.
1146   DistanceMap.erase(DI);
1147
1148   // Update live variables
1149   if (LIS) {
1150     LIS->handleMove(KillMI);
1151   } else {
1152     LV->removeVirtualRegisterKilled(Reg, KillMI);
1153     LV->addVirtualRegisterKilled(Reg, MI);
1154   }
1155
1156   DEBUG(dbgs() << "\trescheduled kill: " << *KillMI);
1157   return true;
1158 }
1159
1160 /// Tries to commute the operand 'BaseOpIdx' and some other operand in the
1161 /// given machine instruction to improve opportunities for coalescing and
1162 /// elimination of a register to register copy.
1163 ///
1164 /// 'DstOpIdx' specifies the index of MI def operand.
1165 /// 'BaseOpKilled' specifies if the register associated with 'BaseOpIdx'
1166 /// operand is killed by the given instruction.
1167 /// The 'Dist' arguments provides the distance of MI from the start of the
1168 /// current basic block and it is used to determine if it is profitable
1169 /// to commute operands in the instruction.
1170 ///
1171 /// Returns true if the transformation happened. Otherwise, returns false.
1172 bool TwoAddressInstructionPass::tryInstructionCommute(MachineInstr *MI,
1173                                                       unsigned DstOpIdx,
1174                                                       unsigned BaseOpIdx,
1175                                                       bool BaseOpKilled,
1176                                                       unsigned Dist) {
1177   unsigned DstOpReg = MI->getOperand(DstOpIdx).getReg();
1178   unsigned BaseOpReg = MI->getOperand(BaseOpIdx).getReg();
1179   unsigned OpsNum = MI->getDesc().getNumOperands();
1180   unsigned OtherOpIdx = MI->getDesc().getNumDefs();
1181   for (; OtherOpIdx < OpsNum; OtherOpIdx++) {
1182     // The call of findCommutedOpIndices below only checks if BaseOpIdx
1183     // and OtherOpIdx are commutable, it does not really searches for
1184     // other commutable operands and does not change the values of passed
1185     // variables.
1186     if (OtherOpIdx == BaseOpIdx ||
1187         !TII->findCommutedOpIndices(MI, BaseOpIdx, OtherOpIdx))
1188       continue;
1189
1190     unsigned OtherOpReg = MI->getOperand(OtherOpIdx).getReg();
1191     bool AggressiveCommute = false;
1192
1193     // If OtherOp dies but BaseOp does not, swap the OtherOp and BaseOp
1194     // operands. This makes the live ranges of DstOp and OtherOp joinable.
1195     bool DoCommute =
1196         !BaseOpKilled && isKilled(*MI, OtherOpReg, MRI, TII, LIS, false);
1197
1198     if (!DoCommute &&
1199         isProfitableToCommute(DstOpReg, BaseOpReg, OtherOpReg, MI, Dist)) {
1200       DoCommute = true;
1201       AggressiveCommute = true;
1202     }
1203
1204     // If it's profitable to commute, try to do so.
1205     if (DoCommute && commuteInstruction(MI, BaseOpIdx, OtherOpIdx, Dist)) {
1206       ++NumCommuted;
1207       if (AggressiveCommute)
1208         ++NumAggrCommuted;
1209       return true;
1210     }
1211   }
1212   return false;
1213 }
1214
1215 /// tryInstructionTransform - For the case where an instruction has a single
1216 /// pair of tied register operands, attempt some transformations that may
1217 /// either eliminate the tied operands or improve the opportunities for
1218 /// coalescing away the register copy.  Returns true if no copy needs to be
1219 /// inserted to untie mi's operands (either because they were untied, or
1220 /// because mi was rescheduled, and will be visited again later). If the
1221 /// shouldOnlyCommute flag is true, only instruction commutation is attempted.
1222 bool TwoAddressInstructionPass::
1223 tryInstructionTransform(MachineBasicBlock::iterator &mi,
1224                         MachineBasicBlock::iterator &nmi,
1225                         unsigned SrcIdx, unsigned DstIdx,
1226                         unsigned Dist, bool shouldOnlyCommute) {
1227   if (OptLevel == CodeGenOpt::None)
1228     return false;
1229
1230   MachineInstr &MI = *mi;
1231   unsigned regA = MI.getOperand(DstIdx).getReg();
1232   unsigned regB = MI.getOperand(SrcIdx).getReg();
1233
1234   assert(TargetRegisterInfo::isVirtualRegister(regB) &&
1235          "cannot make instruction into two-address form");
1236   bool regBKilled = isKilled(MI, regB, MRI, TII, LIS, true);
1237
1238   if (TargetRegisterInfo::isVirtualRegister(regA))
1239     scanUses(regA);
1240
1241   bool Commuted = tryInstructionCommute(&MI, DstIdx, SrcIdx, regBKilled, Dist);
1242
1243   // If the instruction is convertible to 3 Addr, instead
1244   // of returning try 3 Addr transformation aggresively and
1245   // use this variable to check later. Because it might be better.
1246   // For example, we can just use `leal (%rsi,%rdi), %eax` and `ret`
1247   // instead of the following code.
1248   //   addl     %esi, %edi
1249   //   movl     %edi, %eax
1250   //   ret
1251   if (Commuted && !MI.isConvertibleTo3Addr())
1252     return false;
1253
1254   if (shouldOnlyCommute)
1255     return false;
1256
1257   // If there is one more use of regB later in the same MBB, consider
1258   // re-schedule this MI below it.
1259   if (!Commuted && EnableRescheduling && rescheduleMIBelowKill(mi, nmi, regB)) {
1260     ++NumReSchedDowns;
1261     return true;
1262   }
1263
1264   // If we commuted, regB may have changed so we should re-sample it to avoid
1265   // confusing the three address conversion below.
1266   if (Commuted) {
1267     regB = MI.getOperand(SrcIdx).getReg();
1268     regBKilled = isKilled(MI, regB, MRI, TII, LIS, true);
1269   }
1270
1271   if (MI.isConvertibleTo3Addr()) {
1272     // This instruction is potentially convertible to a true
1273     // three-address instruction.  Check if it is profitable.
1274     if (!regBKilled || isProfitableToConv3Addr(regA, regB)) {
1275       // Try to convert it.
1276       if (convertInstTo3Addr(mi, nmi, regA, regB, Dist)) {
1277         ++NumConvertedTo3Addr;
1278         return true; // Done with this instruction.
1279       }
1280     }
1281   }
1282
1283   // Return if it is commuted but 3 addr conversion is failed.
1284   if (Commuted)
1285     return false;
1286
1287   // If there is one more use of regB later in the same MBB, consider
1288   // re-schedule it before this MI if it's legal.
1289   if (EnableRescheduling && rescheduleKillAboveMI(mi, nmi, regB)) {
1290     ++NumReSchedUps;
1291     return true;
1292   }
1293
1294   // If this is an instruction with a load folded into it, try unfolding
1295   // the load, e.g. avoid this:
1296   //   movq %rdx, %rcx
1297   //   addq (%rax), %rcx
1298   // in favor of this:
1299   //   movq (%rax), %rcx
1300   //   addq %rdx, %rcx
1301   // because it's preferable to schedule a load than a register copy.
1302   if (MI.mayLoad() && !regBKilled) {
1303     // Determine if a load can be unfolded.
1304     unsigned LoadRegIndex;
1305     unsigned NewOpc =
1306       TII->getOpcodeAfterMemoryUnfold(MI.getOpcode(),
1307                                       /*UnfoldLoad=*/true,
1308                                       /*UnfoldStore=*/false,
1309                                       &LoadRegIndex);
1310     if (NewOpc != 0) {
1311       const MCInstrDesc &UnfoldMCID = TII->get(NewOpc);
1312       if (UnfoldMCID.getNumDefs() == 1) {
1313         // Unfold the load.
1314         DEBUG(dbgs() << "2addr:   UNFOLDING: " << MI);
1315         const TargetRegisterClass *RC =
1316           TRI->getAllocatableClass(
1317             TII->getRegClass(UnfoldMCID, LoadRegIndex, TRI, *MF));
1318         unsigned Reg = MRI->createVirtualRegister(RC);
1319         SmallVector<MachineInstr *, 2> NewMIs;
1320         if (!TII->unfoldMemoryOperand(*MF, &MI, Reg,
1321                                       /*UnfoldLoad=*/true,/*UnfoldStore=*/false,
1322                                       NewMIs)) {
1323           DEBUG(dbgs() << "2addr: ABANDONING UNFOLD\n");
1324           return false;
1325         }
1326         assert(NewMIs.size() == 2 &&
1327                "Unfolded a load into multiple instructions!");
1328         // The load was previously folded, so this is the only use.
1329         NewMIs[1]->addRegisterKilled(Reg, TRI);
1330
1331         // Tentatively insert the instructions into the block so that they
1332         // look "normal" to the transformation logic.
1333         MBB->insert(mi, NewMIs[0]);
1334         MBB->insert(mi, NewMIs[1]);
1335
1336         DEBUG(dbgs() << "2addr:    NEW LOAD: " << *NewMIs[0]
1337                      << "2addr:    NEW INST: " << *NewMIs[1]);
1338
1339         // Transform the instruction, now that it no longer has a load.
1340         unsigned NewDstIdx = NewMIs[1]->findRegisterDefOperandIdx(regA);
1341         unsigned NewSrcIdx = NewMIs[1]->findRegisterUseOperandIdx(regB);
1342         MachineBasicBlock::iterator NewMI = NewMIs[1];
1343         bool TransformResult =
1344           tryInstructionTransform(NewMI, mi, NewSrcIdx, NewDstIdx, Dist, true);
1345         (void)TransformResult;
1346         assert(!TransformResult &&
1347                "tryInstructionTransform() should return false.");
1348         if (NewMIs[1]->getOperand(NewSrcIdx).isKill()) {
1349           // Success, or at least we made an improvement. Keep the unfolded
1350           // instructions and discard the original.
1351           if (LV) {
1352             for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
1353               MachineOperand &MO = MI.getOperand(i);
1354               if (MO.isReg() &&
1355                   TargetRegisterInfo::isVirtualRegister(MO.getReg())) {
1356                 if (MO.isUse()) {
1357                   if (MO.isKill()) {
1358                     if (NewMIs[0]->killsRegister(MO.getReg()))
1359                       LV->replaceKillInstruction(MO.getReg(), &MI, NewMIs[0]);
1360                     else {
1361                       assert(NewMIs[1]->killsRegister(MO.getReg()) &&
1362                              "Kill missing after load unfold!");
1363                       LV->replaceKillInstruction(MO.getReg(), &MI, NewMIs[1]);
1364                     }
1365                   }
1366                 } else if (LV->removeVirtualRegisterDead(MO.getReg(), &MI)) {
1367                   if (NewMIs[1]->registerDefIsDead(MO.getReg()))
1368                     LV->addVirtualRegisterDead(MO.getReg(), NewMIs[1]);
1369                   else {
1370                     assert(NewMIs[0]->registerDefIsDead(MO.getReg()) &&
1371                            "Dead flag missing after load unfold!");
1372                     LV->addVirtualRegisterDead(MO.getReg(), NewMIs[0]);
1373                   }
1374                 }
1375               }
1376             }
1377             LV->addVirtualRegisterKilled(Reg, NewMIs[1]);
1378           }
1379
1380           SmallVector<unsigned, 4> OrigRegs;
1381           if (LIS) {
1382             for (const MachineOperand &MO : MI.operands()) {
1383               if (MO.isReg())
1384                 OrigRegs.push_back(MO.getReg());
1385             }
1386           }
1387
1388           MI.eraseFromParent();
1389
1390           // Update LiveIntervals.
1391           if (LIS) {
1392             MachineBasicBlock::iterator Begin(NewMIs[0]);
1393             MachineBasicBlock::iterator End(NewMIs[1]);
1394             LIS->repairIntervalsInRange(MBB, Begin, End, OrigRegs);
1395           }
1396
1397           mi = NewMIs[1];
1398         } else {
1399           // Transforming didn't eliminate the tie and didn't lead to an
1400           // improvement. Clean up the unfolded instructions and keep the
1401           // original.
1402           DEBUG(dbgs() << "2addr: ABANDONING UNFOLD\n");
1403           NewMIs[0]->eraseFromParent();
1404           NewMIs[1]->eraseFromParent();
1405         }
1406       }
1407     }
1408   }
1409
1410   return false;
1411 }
1412
1413 // Collect tied operands of MI that need to be handled.
1414 // Rewrite trivial cases immediately.
1415 // Return true if any tied operands where found, including the trivial ones.
1416 bool TwoAddressInstructionPass::
1417 collectTiedOperands(MachineInstr *MI, TiedOperandMap &TiedOperands) {
1418   const MCInstrDesc &MCID = MI->getDesc();
1419   bool AnyOps = false;
1420   unsigned NumOps = MI->getNumOperands();
1421
1422   for (unsigned SrcIdx = 0; SrcIdx < NumOps; ++SrcIdx) {
1423     unsigned DstIdx = 0;
1424     if (!MI->isRegTiedToDefOperand(SrcIdx, &DstIdx))
1425       continue;
1426     AnyOps = true;
1427     MachineOperand &SrcMO = MI->getOperand(SrcIdx);
1428     MachineOperand &DstMO = MI->getOperand(DstIdx);
1429     unsigned SrcReg = SrcMO.getReg();
1430     unsigned DstReg = DstMO.getReg();
1431     // Tied constraint already satisfied?
1432     if (SrcReg == DstReg)
1433       continue;
1434
1435     assert(SrcReg && SrcMO.isUse() && "two address instruction invalid");
1436
1437     // Deal with <undef> uses immediately - simply rewrite the src operand.
1438     if (SrcMO.isUndef() && !DstMO.getSubReg()) {
1439       // Constrain the DstReg register class if required.
1440       if (TargetRegisterInfo::isVirtualRegister(DstReg))
1441         if (const TargetRegisterClass *RC = TII->getRegClass(MCID, SrcIdx,
1442                                                              TRI, *MF))
1443           MRI->constrainRegClass(DstReg, RC);
1444       SrcMO.setReg(DstReg);
1445       SrcMO.setSubReg(0);
1446       DEBUG(dbgs() << "\t\trewrite undef:\t" << *MI);
1447       continue;
1448     }
1449     TiedOperands[SrcReg].push_back(std::make_pair(SrcIdx, DstIdx));
1450   }
1451   return AnyOps;
1452 }
1453
1454 // Process a list of tied MI operands that all use the same source register.
1455 // The tied pairs are of the form (SrcIdx, DstIdx).
1456 void
1457 TwoAddressInstructionPass::processTiedPairs(MachineInstr *MI,
1458                                             TiedPairList &TiedPairs,
1459                                             unsigned &Dist) {
1460   bool IsEarlyClobber = false;
1461   for (unsigned tpi = 0, tpe = TiedPairs.size(); tpi != tpe; ++tpi) {
1462     const MachineOperand &DstMO = MI->getOperand(TiedPairs[tpi].second);
1463     IsEarlyClobber |= DstMO.isEarlyClobber();
1464   }
1465
1466   bool RemovedKillFlag = false;
1467   bool AllUsesCopied = true;
1468   unsigned LastCopiedReg = 0;
1469   SlotIndex LastCopyIdx;
1470   unsigned RegB = 0;
1471   unsigned SubRegB = 0;
1472   for (unsigned tpi = 0, tpe = TiedPairs.size(); tpi != tpe; ++tpi) {
1473     unsigned SrcIdx = TiedPairs[tpi].first;
1474     unsigned DstIdx = TiedPairs[tpi].second;
1475
1476     const MachineOperand &DstMO = MI->getOperand(DstIdx);
1477     unsigned RegA = DstMO.getReg();
1478
1479     // Grab RegB from the instruction because it may have changed if the
1480     // instruction was commuted.
1481     RegB = MI->getOperand(SrcIdx).getReg();
1482     SubRegB = MI->getOperand(SrcIdx).getSubReg();
1483
1484     if (RegA == RegB) {
1485       // The register is tied to multiple destinations (or else we would
1486       // not have continued this far), but this use of the register
1487       // already matches the tied destination.  Leave it.
1488       AllUsesCopied = false;
1489       continue;
1490     }
1491     LastCopiedReg = RegA;
1492
1493     assert(TargetRegisterInfo::isVirtualRegister(RegB) &&
1494            "cannot make instruction into two-address form");
1495
1496 #ifndef NDEBUG
1497     // First, verify that we don't have a use of "a" in the instruction
1498     // (a = b + a for example) because our transformation will not
1499     // work. This should never occur because we are in SSA form.
1500     for (unsigned i = 0; i != MI->getNumOperands(); ++i)
1501       assert(i == DstIdx ||
1502              !MI->getOperand(i).isReg() ||
1503              MI->getOperand(i).getReg() != RegA);
1504 #endif
1505
1506     // Emit a copy.
1507     MachineInstrBuilder MIB = BuildMI(*MI->getParent(), MI, MI->getDebugLoc(),
1508                                       TII->get(TargetOpcode::COPY), RegA);
1509     // If this operand is folding a truncation, the truncation now moves to the
1510     // copy so that the register classes remain valid for the operands.
1511     MIB.addReg(RegB, 0, SubRegB);
1512     const TargetRegisterClass *RC = MRI->getRegClass(RegB);
1513     if (SubRegB) {
1514       if (TargetRegisterInfo::isVirtualRegister(RegA)) {
1515         assert(TRI->getMatchingSuperRegClass(RC, MRI->getRegClass(RegA),
1516                                              SubRegB) &&
1517                "tied subregister must be a truncation");
1518         // The superreg class will not be used to constrain the subreg class.
1519         RC = nullptr;
1520       }
1521       else {
1522         assert(TRI->getMatchingSuperReg(RegA, SubRegB, MRI->getRegClass(RegB))
1523                && "tied subregister must be a truncation");
1524       }
1525     }
1526
1527     // Update DistanceMap.
1528     MachineBasicBlock::iterator PrevMI = MI;
1529     --PrevMI;
1530     DistanceMap.insert(std::make_pair(PrevMI, Dist));
1531     DistanceMap[MI] = ++Dist;
1532
1533     if (LIS) {
1534       LastCopyIdx = LIS->InsertMachineInstrInMaps(PrevMI).getRegSlot();
1535
1536       if (TargetRegisterInfo::isVirtualRegister(RegA)) {
1537         LiveInterval &LI = LIS->getInterval(RegA);
1538         VNInfo *VNI = LI.getNextValue(LastCopyIdx, LIS->getVNInfoAllocator());
1539         SlotIndex endIdx =
1540           LIS->getInstructionIndex(MI).getRegSlot(IsEarlyClobber);
1541         LI.addSegment(LiveInterval::Segment(LastCopyIdx, endIdx, VNI));
1542       }
1543     }
1544
1545     DEBUG(dbgs() << "\t\tprepend:\t" << *MIB);
1546
1547     MachineOperand &MO = MI->getOperand(SrcIdx);
1548     assert(MO.isReg() && MO.getReg() == RegB && MO.isUse() &&
1549            "inconsistent operand info for 2-reg pass");
1550     if (MO.isKill()) {
1551       MO.setIsKill(false);
1552       RemovedKillFlag = true;
1553     }
1554
1555     // Make sure regA is a legal regclass for the SrcIdx operand.
1556     if (TargetRegisterInfo::isVirtualRegister(RegA) &&
1557         TargetRegisterInfo::isVirtualRegister(RegB))
1558       MRI->constrainRegClass(RegA, RC);
1559     MO.setReg(RegA);
1560     // The getMatchingSuper asserts guarantee that the register class projected
1561     // by SubRegB is compatible with RegA with no subregister. So regardless of
1562     // whether the dest oper writes a subreg, the source oper should not.
1563     MO.setSubReg(0);
1564
1565     // Propagate SrcRegMap.
1566     SrcRegMap[RegA] = RegB;
1567   }
1568
1569   if (AllUsesCopied) {
1570     if (!IsEarlyClobber) {
1571       // Replace other (un-tied) uses of regB with LastCopiedReg.
1572       for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1573         MachineOperand &MO = MI->getOperand(i);
1574         if (MO.isReg() && MO.getReg() == RegB && MO.getSubReg() == SubRegB &&
1575             MO.isUse()) {
1576           if (MO.isKill()) {
1577             MO.setIsKill(false);
1578             RemovedKillFlag = true;
1579           }
1580           MO.setReg(LastCopiedReg);
1581           MO.setSubReg(0);
1582         }
1583       }
1584     }
1585
1586     // Update live variables for regB.
1587     if (RemovedKillFlag && LV && LV->getVarInfo(RegB).removeKill(MI)) {
1588       MachineBasicBlock::iterator PrevMI = MI;
1589       --PrevMI;
1590       LV->addVirtualRegisterKilled(RegB, PrevMI);
1591     }
1592
1593     // Update LiveIntervals.
1594     if (LIS) {
1595       LiveInterval &LI = LIS->getInterval(RegB);
1596       SlotIndex MIIdx = LIS->getInstructionIndex(MI);
1597       LiveInterval::const_iterator I = LI.find(MIIdx);
1598       assert(I != LI.end() && "RegB must be live-in to use.");
1599
1600       SlotIndex UseIdx = MIIdx.getRegSlot(IsEarlyClobber);
1601       if (I->end == UseIdx)
1602         LI.removeSegment(LastCopyIdx, UseIdx);
1603     }
1604
1605   } else if (RemovedKillFlag) {
1606     // Some tied uses of regB matched their destination registers, so
1607     // regB is still used in this instruction, but a kill flag was
1608     // removed from a different tied use of regB, so now we need to add
1609     // a kill flag to one of the remaining uses of regB.
1610     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1611       MachineOperand &MO = MI->getOperand(i);
1612       if (MO.isReg() && MO.getReg() == RegB && MO.isUse()) {
1613         MO.setIsKill(true);
1614         break;
1615       }
1616     }
1617   }
1618 }
1619
1620 /// runOnMachineFunction - Reduce two-address instructions to two operands.
1621 ///
1622 bool TwoAddressInstructionPass::runOnMachineFunction(MachineFunction &Func) {
1623   MF = &Func;
1624   const TargetMachine &TM = MF->getTarget();
1625   MRI = &MF->getRegInfo();
1626   TII = MF->getSubtarget().getInstrInfo();
1627   TRI = MF->getSubtarget().getRegisterInfo();
1628   InstrItins = MF->getSubtarget().getInstrItineraryData();
1629   LV = getAnalysisIfAvailable<LiveVariables>();
1630   LIS = getAnalysisIfAvailable<LiveIntervals>();
1631   AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
1632   OptLevel = TM.getOptLevel();
1633
1634   bool MadeChange = false;
1635
1636   DEBUG(dbgs() << "********** REWRITING TWO-ADDR INSTRS **********\n");
1637   DEBUG(dbgs() << "********** Function: "
1638         << MF->getName() << '\n');
1639
1640   // This pass takes the function out of SSA form.
1641   MRI->leaveSSA();
1642
1643   TiedOperandMap TiedOperands;
1644   for (MachineFunction::iterator MBBI = MF->begin(), MBBE = MF->end();
1645        MBBI != MBBE; ++MBBI) {
1646     MBB = MBBI;
1647     unsigned Dist = 0;
1648     DistanceMap.clear();
1649     SrcRegMap.clear();
1650     DstRegMap.clear();
1651     Processed.clear();
1652     for (MachineBasicBlock::iterator mi = MBB->begin(), me = MBB->end();
1653          mi != me; ) {
1654       MachineBasicBlock::iterator nmi = std::next(mi);
1655       if (mi->isDebugValue()) {
1656         mi = nmi;
1657         continue;
1658       }
1659
1660       // Expand REG_SEQUENCE instructions. This will position mi at the first
1661       // expanded instruction.
1662       if (mi->isRegSequence())
1663         eliminateRegSequence(mi);
1664
1665       DistanceMap.insert(std::make_pair(mi, ++Dist));
1666
1667       processCopy(&*mi);
1668
1669       // First scan through all the tied register uses in this instruction
1670       // and record a list of pairs of tied operands for each register.
1671       if (!collectTiedOperands(mi, TiedOperands)) {
1672         mi = nmi;
1673         continue;
1674       }
1675
1676       ++NumTwoAddressInstrs;
1677       MadeChange = true;
1678       DEBUG(dbgs() << '\t' << *mi);
1679
1680       // If the instruction has a single pair of tied operands, try some
1681       // transformations that may either eliminate the tied operands or
1682       // improve the opportunities for coalescing away the register copy.
1683       if (TiedOperands.size() == 1) {
1684         SmallVectorImpl<std::pair<unsigned, unsigned> > &TiedPairs
1685           = TiedOperands.begin()->second;
1686         if (TiedPairs.size() == 1) {
1687           unsigned SrcIdx = TiedPairs[0].first;
1688           unsigned DstIdx = TiedPairs[0].second;
1689           unsigned SrcReg = mi->getOperand(SrcIdx).getReg();
1690           unsigned DstReg = mi->getOperand(DstIdx).getReg();
1691           if (SrcReg != DstReg &&
1692               tryInstructionTransform(mi, nmi, SrcIdx, DstIdx, Dist, false)) {
1693             // The tied operands have been eliminated or shifted further down
1694             // the block to ease elimination. Continue processing with 'nmi'.
1695             TiedOperands.clear();
1696             mi = nmi;
1697             continue;
1698           }
1699         }
1700       }
1701
1702       // Now iterate over the information collected above.
1703       for (auto &TO : TiedOperands) {
1704         processTiedPairs(mi, TO.second, Dist);
1705         DEBUG(dbgs() << "\t\trewrite to:\t" << *mi);
1706       }
1707
1708       // Rewrite INSERT_SUBREG as COPY now that we no longer need SSA form.
1709       if (mi->isInsertSubreg()) {
1710         // From %reg = INSERT_SUBREG %reg, %subreg, subidx
1711         // To   %reg:subidx = COPY %subreg
1712         unsigned SubIdx = mi->getOperand(3).getImm();
1713         mi->RemoveOperand(3);
1714         assert(mi->getOperand(0).getSubReg() == 0 && "Unexpected subreg idx");
1715         mi->getOperand(0).setSubReg(SubIdx);
1716         mi->getOperand(0).setIsUndef(mi->getOperand(1).isUndef());
1717         mi->RemoveOperand(1);
1718         mi->setDesc(TII->get(TargetOpcode::COPY));
1719         DEBUG(dbgs() << "\t\tconvert to:\t" << *mi);
1720       }
1721
1722       // Clear TiedOperands here instead of at the top of the loop
1723       // since most instructions do not have tied operands.
1724       TiedOperands.clear();
1725       mi = nmi;
1726     }
1727   }
1728
1729   if (LIS)
1730     MF->verify(this, "After two-address instruction pass");
1731
1732   return MadeChange;
1733 }
1734
1735 /// Eliminate a REG_SEQUENCE instruction as part of the de-ssa process.
1736 ///
1737 /// The instruction is turned into a sequence of sub-register copies:
1738 ///
1739 ///   %dst = REG_SEQUENCE %v1, ssub0, %v2, ssub1
1740 ///
1741 /// Becomes:
1742 ///
1743 ///   %dst:ssub0<def,undef> = COPY %v1
1744 ///   %dst:ssub1<def> = COPY %v2
1745 ///
1746 void TwoAddressInstructionPass::
1747 eliminateRegSequence(MachineBasicBlock::iterator &MBBI) {
1748   MachineInstr *MI = MBBI;
1749   unsigned DstReg = MI->getOperand(0).getReg();
1750   if (MI->getOperand(0).getSubReg() ||
1751       TargetRegisterInfo::isPhysicalRegister(DstReg) ||
1752       !(MI->getNumOperands() & 1)) {
1753     DEBUG(dbgs() << "Illegal REG_SEQUENCE instruction:" << *MI);
1754     llvm_unreachable(nullptr);
1755   }
1756
1757   SmallVector<unsigned, 4> OrigRegs;
1758   if (LIS) {
1759     OrigRegs.push_back(MI->getOperand(0).getReg());
1760     for (unsigned i = 1, e = MI->getNumOperands(); i < e; i += 2)
1761       OrigRegs.push_back(MI->getOperand(i).getReg());
1762   }
1763
1764   bool DefEmitted = false;
1765   for (unsigned i = 1, e = MI->getNumOperands(); i < e; i += 2) {
1766     MachineOperand &UseMO = MI->getOperand(i);
1767     unsigned SrcReg = UseMO.getReg();
1768     unsigned SubIdx = MI->getOperand(i+1).getImm();
1769     // Nothing needs to be inserted for <undef> operands.
1770     if (UseMO.isUndef())
1771       continue;
1772
1773     // Defer any kill flag to the last operand using SrcReg. Otherwise, we
1774     // might insert a COPY that uses SrcReg after is was killed.
1775     bool isKill = UseMO.isKill();
1776     if (isKill)
1777       for (unsigned j = i + 2; j < e; j += 2)
1778         if (MI->getOperand(j).getReg() == SrcReg) {
1779           MI->getOperand(j).setIsKill();
1780           UseMO.setIsKill(false);
1781           isKill = false;
1782           break;
1783         }
1784
1785     // Insert the sub-register copy.
1786     MachineInstr *CopyMI = BuildMI(*MI->getParent(), MI, MI->getDebugLoc(),
1787                                    TII->get(TargetOpcode::COPY))
1788       .addReg(DstReg, RegState::Define, SubIdx)
1789       .addOperand(UseMO);
1790
1791     // The first def needs an <undef> flag because there is no live register
1792     // before it.
1793     if (!DefEmitted) {
1794       CopyMI->getOperand(0).setIsUndef(true);
1795       // Return an iterator pointing to the first inserted instr.
1796       MBBI = CopyMI;
1797     }
1798     DefEmitted = true;
1799
1800     // Update LiveVariables' kill info.
1801     if (LV && isKill && !TargetRegisterInfo::isPhysicalRegister(SrcReg))
1802       LV->replaceKillInstruction(SrcReg, MI, CopyMI);
1803
1804     DEBUG(dbgs() << "Inserted: " << *CopyMI);
1805   }
1806
1807   MachineBasicBlock::iterator EndMBBI =
1808       std::next(MachineBasicBlock::iterator(MI));
1809
1810   if (!DefEmitted) {
1811     DEBUG(dbgs() << "Turned: " << *MI << " into an IMPLICIT_DEF");
1812     MI->setDesc(TII->get(TargetOpcode::IMPLICIT_DEF));
1813     for (int j = MI->getNumOperands() - 1, ee = 0; j > ee; --j)
1814       MI->RemoveOperand(j);
1815   } else {
1816     DEBUG(dbgs() << "Eliminated: " << *MI);
1817     MI->eraseFromParent();
1818   }
1819
1820   // Udpate LiveIntervals.
1821   if (LIS)
1822     LIS->repairIntervalsInRange(MBB, MBBI, EndMBBI, OrigRegs);
1823 }