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