lib/CodeGen/SimpleRegisterCoalescing.cpp

   1 //===-- SimpleRegisterCoalescing.cpp - Register Coalescing ----------------===//
   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 a simple register coalescing pass that attempts to
  11 // aggressively coalesce every register copy that it can.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "regcoalescing"
  16 #include "SimpleRegisterCoalescing.h"
  17 #include "VirtRegMap.h"
  18 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  19 #include "llvm/Value.h"
  20 #include "llvm/Analysis/AliasAnalysis.h"
  21 #include "llvm/CodeGen/MachineFrameInfo.h"
  22 #include "llvm/CodeGen/MachineInstr.h"
  23 #include "llvm/CodeGen/MachineLoopInfo.h"
  24 #include "llvm/CodeGen/MachineRegisterInfo.h"
  25 #include "llvm/CodeGen/Passes.h"
  26 #include "llvm/CodeGen/RegisterCoalescer.h"
  27 #include "llvm/Target/TargetInstrInfo.h"
  28 #include "llvm/Target/TargetMachine.h"
  29 #include "llvm/Target/TargetOptions.h"
  30 #include "llvm/Support/CommandLine.h"
  31 #include "llvm/Support/Debug.h"
  32 #include "llvm/Support/ErrorHandling.h"
  33 #include "llvm/Support/raw_ostream.h"
  34 #include "llvm/ADT/OwningPtr.h"
  35 #include "llvm/ADT/SmallSet.h"
  36 #include "llvm/ADT/Statistic.h"
  37 #include "llvm/ADT/STLExtras.h"
  38 #include <algorithm>
  39 #include <cmath>
  40 using namespace llvm;
  41
  42 STATISTIC(numJoins    , "Number of interval joins performed");
  43 STATISTIC(numCrossRCs , "Number of cross class joins performed");
  44 STATISTIC(numCommutes , "Number of instruction commuting performed");
  45 STATISTIC(numExtends  , "Number of copies extended");
  46 STATISTIC(NumReMats   , "Number of instructions re-materialized");
  47 STATISTIC(numPeep     , "Number of identity moves eliminated after coalescing");
  48 STATISTIC(numAborts   , "Number of times interval joining aborted");
  49 STATISTIC(numDeadValNo, "Number of valno def marked dead");
  50
  51 char SimpleRegisterCoalescing::ID = 0;
  52 static cl::opt<bool>
  53 EnableJoining("join-liveintervals",
  54               cl::desc("Coalesce copies (default=true)"),
  55               cl::init(true));
  56
  57 static cl::opt<bool>
  58 DisableCrossClassJoin("disable-cross-class-join",
  59                cl::desc("Avoid coalescing cross register class copies"),
  60                cl::init(false), cl::Hidden);
  61
  62 static RegisterPass<SimpleRegisterCoalescing>
  63 X("simple-register-coalescing", "Simple Register Coalescing");
  64
  65 // Declare that we implement the RegisterCoalescer interface
  66 static RegisterAnalysisGroup<RegisterCoalescer, true/*The Default*/> V(X);
  67
  68 const PassInfo *const llvm::SimpleRegisterCoalescingID = &X;
  69
  70 void SimpleRegisterCoalescing::getAnalysisUsage(AnalysisUsage &AU) const {
  71   AU.setPreservesCFG();
  72   AU.addRequired<AliasAnalysis>();
  73   AU.addRequired<LiveIntervals>();
  74   AU.addPreserved<LiveIntervals>();
  75   AU.addPreserved<SlotIndexes>();
  76   AU.addRequired<MachineLoopInfo>();
  77   AU.addPreserved<MachineLoopInfo>();
  78   AU.addPreservedID(MachineDominatorsID);
  79   if (StrongPHIElim)
  80     AU.addPreservedID(StrongPHIEliminationID);
  81   else
  82     AU.addPreservedID(PHIEliminationID);
  83   AU.addPreservedID(TwoAddressInstructionPassID);
  84   MachineFunctionPass::getAnalysisUsage(AU);
  85 }
  86
  87 /// AdjustCopiesBackFrom - We found a non-trivially-coalescable copy with IntA
  88 /// being the source and IntB being the dest, thus this defines a value number
  89 /// in IntB.  If the source value number (in IntA) is defined by a copy from B,
  90 /// see if we can merge these two pieces of B into a single value number,
  91 /// eliminating a copy.  For example:
  92 ///
  93 ///  A3 = B0
  94 ///    ...
  95 ///  B1 = A3      <- this copy
  96 ///
  97 /// In this case, B0 can be extended to where the B1 copy lives, allowing the B1
  98 /// value number to be replaced with B0 (which simplifies the B liveinterval).
  99 ///
 100 /// This returns true if an interval was modified.
 101 ///
 102 bool SimpleRegisterCoalescing::AdjustCopiesBackFrom(const CoalescerPair &CP,
 103                                                     MachineInstr *CopyMI) {
 104   // Bail if there is no dst interval - can happen when merging physical subreg
 105   // operations.
 106   if (!li_->hasInterval(CP.getDstReg()))
 107     return false;
 108
 109   LiveInterval &IntA =
 110     li_->getInterval(CP.isFlipped() ? CP.getDstReg() : CP.getSrcReg());
 111   LiveInterval &IntB =
 112     li_->getInterval(CP.isFlipped() ? CP.getSrcReg() : CP.getDstReg());
 113   SlotIndex CopyIdx = li_->getInstructionIndex(CopyMI).getDefIndex();
 114
 115   // BValNo is a value number in B that is defined by a copy from A.  'B3' in
 116   // the example above.
 117   LiveInterval::iterator BLR = IntB.FindLiveRangeContaining(CopyIdx);
 118   if (BLR == IntB.end()) return false;
 119   VNInfo *BValNo = BLR->valno;
 120
 121   // Get the location that B is defined at.  Two options: either this value has
 122   // an unknown definition point or it is defined at CopyIdx.  If unknown, we
 123   // can't process it.
 124   if (!BValNo->getCopy()) return false;
 125   assert(BValNo->def == CopyIdx && "Copy doesn't define the value?");
 126
 127   // AValNo is the value number in A that defines the copy, A3 in the example.
 128   SlotIndex CopyUseIdx = CopyIdx.getUseIndex();
 129   LiveInterval::iterator ALR = IntA.FindLiveRangeContaining(CopyUseIdx);
 130   // The live range might not exist after fun with physreg coalescing.
 131   if (ALR == IntA.end()) return false;
 132   VNInfo *AValNo = ALR->valno;
 133   // If it's re-defined by an early clobber somewhere in the live range, then
 134   // it's not safe to eliminate the copy. FIXME: This is a temporary workaround.
 135   // See PR3149:
 136   // 172     %ECX<def> = MOV32rr %reg1039<kill>
 137   // 180     INLINEASM <es:subl $5,$1
 138   //         sbbl $3,$0>, 10, %EAX<def>, 14, %ECX<earlyclobber,def>, 9,
 139   //         %EAX<kill>,
 140   // 36, <fi#0>, 1, %reg0, 0, 9, %ECX<kill>, 36, <fi#1>, 1, %reg0, 0
 141   // 188     %EAX<def> = MOV32rr %EAX<kill>
 142   // 196     %ECX<def> = MOV32rr %ECX<kill>
 143   // 204     %ECX<def> = MOV32rr %ECX<kill>
 144   // 212     %EAX<def> = MOV32rr %EAX<kill>
 145   // 220     %EAX<def> = MOV32rr %EAX
 146   // 228     %reg1039<def> = MOV32rr %ECX<kill>
 147   // The early clobber operand ties ECX input to the ECX def.
 148   //
 149   // The live interval of ECX is represented as this:
 150   // %reg20,inf = [46,47:1)[174,230:0)  0@174-(230) 1@46-(47)
 151   // The coalescer has no idea there was a def in the middle of [174,230].
 152   if (AValNo->hasRedefByEC())
 153     return false;
 154
 155   // If AValNo is defined as a copy from IntB, we can potentially process this.
 156   // Get the instruction that defines this value number.
 157   if (!CP.isCoalescable(AValNo->getCopy()))
 158     return false;
 159
 160   // Get the LiveRange in IntB that this value number starts with.
 161   LiveInterval::iterator ValLR =
 162     IntB.FindLiveRangeContaining(AValNo->def.getPrevSlot());
 163   if (ValLR == IntB.end())
 164     return false;
 165
 166   // Make sure that the end of the live range is inside the same block as
 167   // CopyMI.
 168   MachineInstr *ValLREndInst =
 169     li_->getInstructionFromIndex(ValLR->end.getPrevSlot());
 170   if (!ValLREndInst || ValLREndInst->getParent() != CopyMI->getParent())
 171     return false;
 172
 173   // Okay, we now know that ValLR ends in the same block that the CopyMI
 174   // live-range starts.  If there are no intervening live ranges between them in
 175   // IntB, we can merge them.
 176   if (ValLR+1 != BLR) return false;
 177
 178   // If a live interval is a physical register, conservatively check if any
 179   // of its sub-registers is overlapping the live interval of the virtual
 180   // register. If so, do not coalesce.
 181   if (TargetRegisterInfo::isPhysicalRegister(IntB.reg) &&
 182       *tri_->getSubRegisters(IntB.reg)) {
 183     for (const unsigned* SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR)
 184       if (li_->hasInterval(*SR) && IntA.overlaps(li_->getInterval(*SR))) {
 185         DEBUG({
 186             dbgs() << "\t\tInterfere with sub-register ";
 187             li_->getInterval(*SR).print(dbgs(), tri_);
 188           });
 189         return false;
 190       }
 191   }
 192
 193   DEBUG({
 194       dbgs() << "Extending: ";
 195       IntB.print(dbgs(), tri_);
 196     });
 197
 198   SlotIndex FillerStart = ValLR->end, FillerEnd = BLR->start;
 199   // We are about to delete CopyMI, so need to remove it as the 'instruction
 200   // that defines this value #'. Update the valnum with the new defining
 201   // instruction #.
 202   BValNo->def  = FillerStart;
 203   BValNo->setCopy(0);
 204
 205   // Okay, we can merge them.  We need to insert a new liverange:
 206   // [ValLR.end, BLR.begin) of either value number, then we merge the
 207   // two value numbers.
 208   IntB.addRange(LiveRange(FillerStart, FillerEnd, BValNo));
 209
 210   // If the IntB live range is assigned to a physical register, and if that
 211   // physreg has sub-registers, update their live intervals as well.
 212   if (TargetRegisterInfo::isPhysicalRegister(IntB.reg)) {
 213     for (const unsigned *SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR) {
 214       if (!li_->hasInterval(*SR))
 215         continue;
 216       LiveInterval &SRLI = li_->getInterval(*SR);
 217       SRLI.addRange(LiveRange(FillerStart, FillerEnd,
 218                               SRLI.getNextValue(FillerStart, 0, true,
 219                                                 li_->getVNInfoAllocator())));
 220     }
 221   }
 222
 223   // Okay, merge "B1" into the same value number as "B0".
 224   if (BValNo != ValLR->valno) {
 225     IntB.MergeValueNumberInto(BValNo, ValLR->valno);
 226   }
 227   DEBUG({
 228       dbgs() << "   result = ";
 229       IntB.print(dbgs(), tri_);
 230       dbgs() << "\n";
 231     });
 232
 233   // If the source instruction was killing the source register before the
 234   // merge, unset the isKill marker given the live range has been extended.
 235   int UIdx = ValLREndInst->findRegisterUseOperandIdx(IntB.reg, true);
 236   if (UIdx != -1) {
 237     ValLREndInst->getOperand(UIdx).setIsKill(false);
 238   }
 239
 240   // If the copy instruction was killing the destination register before the
 241   // merge, find the last use and trim the live range. That will also add the
 242   // isKill marker.
 243   if (ALR->end == CopyIdx)
 244     TrimLiveIntervalToLastUse(CopyUseIdx, CopyMI->getParent(), IntA, ALR);
 245
 246   ++numExtends;
 247   return true;
 248 }
 249
 250 /// HasOtherReachingDefs - Return true if there are definitions of IntB
 251 /// other than BValNo val# that can reach uses of AValno val# of IntA.
 252 bool SimpleRegisterCoalescing::HasOtherReachingDefs(LiveInterval &IntA,
 253                                                     LiveInterval &IntB,
 254                                                     VNInfo *AValNo,
 255                                                     VNInfo *BValNo) {
 256   for (LiveInterval::iterator AI = IntA.begin(), AE = IntA.end();
 257        AI != AE; ++AI) {
 258     if (AI->valno != AValNo) continue;
 259     LiveInterval::Ranges::iterator BI =
 260       std::upper_bound(IntB.ranges.begin(), IntB.ranges.end(), AI->start);
 261     if (BI != IntB.ranges.begin())
 262       --BI;
 263     for (; BI != IntB.ranges.end() && AI->end >= BI->start; ++BI) {
 264       if (BI->valno == BValNo)
 265         continue;
 266       // When BValNo is null, we're looking for a dummy clobber-value for a subreg.
 267       if (!BValNo && !BI->valno->isDefAccurate() && !BI->valno->getCopy())
 268         continue;
 269       if (BI->start <= AI->start && BI->end > AI->start)
 270         return true;
 271       if (BI->start > AI->start && BI->start < AI->end)
 272         return true;
 273     }
 274   }
 275   return false;
 276 }
 277
 278 static void
 279 TransferImplicitOps(MachineInstr *MI, MachineInstr *NewMI) {
 280   for (unsigned i = MI->getDesc().getNumOperands(), e = MI->getNumOperands();
 281        i != e; ++i) {
 282     MachineOperand &MO = MI->getOperand(i);
 283     if (MO.isReg() && MO.isImplicit())
 284       NewMI->addOperand(MO);
 285   }
 286 }
 287
 288 /// RemoveCopyByCommutingDef - We found a non-trivially-coalescable copy with
 289 /// IntA being the source and IntB being the dest, thus this defines a value
 290 /// number in IntB.  If the source value number (in IntA) is defined by a
 291 /// commutable instruction and its other operand is coalesced to the copy dest
 292 /// register, see if we can transform the copy into a noop by commuting the
 293 /// definition. For example,
 294 ///
 295 ///  A3 = op A2 B0<kill>
 296 ///    ...
 297 ///  B1 = A3      <- this copy
 298 ///    ...
 299 ///     = op A3   <- more uses
 300 ///
 301 /// ==>
 302 ///
 303 ///  B2 = op B0 A2<kill>
 304 ///    ...
 305 ///  B1 = B2      <- now an identify copy
 306 ///    ...
 307 ///     = op B2   <- more uses
 308 ///
 309 /// This returns true if an interval was modified.
 310 ///
 311 bool SimpleRegisterCoalescing::RemoveCopyByCommutingDef(const CoalescerPair &CP,
 312                                                         MachineInstr *CopyMI) {
 313   // FIXME: For now, only eliminate the copy by commuting its def when the
 314   // source register is a virtual register. We want to guard against cases
 315   // where the copy is a back edge copy and commuting the def lengthen the
 316   // live interval of the source register to the entire loop.
 317   if (CP.isPhys() && CP.isFlipped())
 318     return false;
 319
 320   // Bail if there is no dst interval.
 321   if (!li_->hasInterval(CP.getDstReg()))
 322     return false;
 323
 324   SlotIndex CopyIdx =
 325     li_->getInstructionIndex(CopyMI).getDefIndex();
 326
 327   LiveInterval &IntA =
 328     li_->getInterval(CP.isFlipped() ? CP.getDstReg() : CP.getSrcReg());
 329   LiveInterval &IntB =
 330     li_->getInterval(CP.isFlipped() ? CP.getSrcReg() : CP.getDstReg());
 331
 332   // BValNo is a value number in B that is defined by a copy from A. 'B3' in
 333   // the example above.
 334   LiveInterval::iterator BLR = IntB.FindLiveRangeContaining(CopyIdx);
 335   if (BLR == IntB.end()) return false;
 336   VNInfo *BValNo = BLR->valno;
 337
 338   // Get the location that B is defined at.  Two options: either this value has
 339   // an unknown definition point or it is defined at CopyIdx.  If unknown, we
 340   // can't process it.
 341   if (!BValNo->getCopy()) return false;
 342   assert(BValNo->def == CopyIdx && "Copy doesn't define the value?");
 343
 344   // AValNo is the value number in A that defines the copy, A3 in the example.
 345   LiveInterval::iterator ALR =
 346     IntA.FindLiveRangeContaining(CopyIdx.getUseIndex()); //
 347
 348   assert(ALR != IntA.end() && "Live range not found!");
 349   VNInfo *AValNo = ALR->valno;
 350   // If other defs can reach uses of this def, then it's not safe to perform
 351   // the optimization. FIXME: Do isPHIDef and isDefAccurate both need to be
 352   // tested?
 353   if (AValNo->isPHIDef() || !AValNo->isDefAccurate() ||
 354       AValNo->isUnused() || AValNo->hasPHIKill())
 355     return false;
 356   MachineInstr *DefMI = li_->getInstructionFromIndex(AValNo->def);
 357   if (!DefMI)
 358     return false;
 359   const TargetInstrDesc &TID = DefMI->getDesc();
 360   if (!TID.isCommutable())
 361     return false;
 362   // If DefMI is a two-address instruction then commuting it will change the
 363   // destination register.
 364   int DefIdx = DefMI->findRegisterDefOperandIdx(IntA.reg);
 365   assert(DefIdx != -1);
 366   unsigned UseOpIdx;
 367   if (!DefMI->isRegTiedToUseOperand(DefIdx, &UseOpIdx))
 368     return false;
 369   unsigned Op1, Op2, NewDstIdx;
 370   if (!tii_->findCommutedOpIndices(DefMI, Op1, Op2))
 371     return false;
 372   if (Op1 == UseOpIdx)
 373     NewDstIdx = Op2;
 374   else if (Op2 == UseOpIdx)
 375     NewDstIdx = Op1;
 376   else
 377     return false;
 378
 379   MachineOperand &NewDstMO = DefMI->getOperand(NewDstIdx);
 380   unsigned NewReg = NewDstMO.getReg();
 381   if (NewReg != IntB.reg || !NewDstMO.isKill())
 382     return false;
 383
 384   // Make sure there are no other definitions of IntB that would reach the
 385   // uses which the new definition can reach.
 386   if (HasOtherReachingDefs(IntA, IntB, AValNo, BValNo))
 387     return false;
 388
 389   bool BHasSubRegs = false;
 390   if (TargetRegisterInfo::isPhysicalRegister(IntB.reg))
 391     BHasSubRegs = *tri_->getSubRegisters(IntB.reg);
 392
 393   // Abort if the subregisters of IntB.reg have values that are not simply the
 394   // clobbers from the superreg.
 395   if (BHasSubRegs)
 396     for (const unsigned *SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR)
 397       if (li_->hasInterval(*SR) &&
 398           HasOtherReachingDefs(IntA, li_->getInterval(*SR), AValNo, 0))
 399         return false;
 400
 401   // If some of the uses of IntA.reg is already coalesced away, return false.
 402   // It's not possible to determine whether it's safe to perform the coalescing.
 403   for (MachineRegisterInfo::use_nodbg_iterator UI =
 404          mri_->use_nodbg_begin(IntA.reg),
 405        UE = mri_->use_nodbg_end(); UI != UE; ++UI) {
 406     MachineInstr *UseMI = &*UI;
 407     SlotIndex UseIdx = li_->getInstructionIndex(UseMI);
 408     LiveInterval::iterator ULR = IntA.FindLiveRangeContaining(UseIdx);
 409     if (ULR == IntA.end())
 410       continue;
 411     if (ULR->valno == AValNo && JoinedCopies.count(UseMI))
 412       return false;
 413   }
 414
 415   // At this point we have decided that it is legal to do this
 416   // transformation.  Start by commuting the instruction.
 417   MachineBasicBlock *MBB = DefMI->getParent();
 418   MachineInstr *NewMI = tii_->commuteInstruction(DefMI);
 419   if (!NewMI)
 420     return false;
 421   if (NewMI != DefMI) {
 422     li_->ReplaceMachineInstrInMaps(DefMI, NewMI);
 423     MBB->insert(DefMI, NewMI);
 424     MBB->erase(DefMI);
 425   }
 426   unsigned OpIdx = NewMI->findRegisterUseOperandIdx(IntA.reg, false);
 427   NewMI->getOperand(OpIdx).setIsKill();
 428
 429   bool BHasPHIKill = BValNo->hasPHIKill();
 430   SmallVector<VNInfo*, 4> BDeadValNos;
 431   std::map<SlotIndex, SlotIndex> BExtend;
 432
 433   // If ALR and BLR overlaps and end of BLR extends beyond end of ALR, e.g.
 434   // A = or A, B
 435   // ...
 436   // B = A
 437   // ...
 438   // C = A<kill>
 439   // ...
 440   //   = B
 441   bool Extended = BLR->end > ALR->end && ALR->end != ALR->start;
 442   if (Extended)
 443     BExtend[ALR->end] = BLR->end;
 444
 445   // Update uses of IntA of the specific Val# with IntB.
 446   for (MachineRegisterInfo::use_iterator UI = mri_->use_begin(IntA.reg),
 447          UE = mri_->use_end(); UI != UE;) {
 448     MachineOperand &UseMO = UI.getOperand();
 449     MachineInstr *UseMI = &*UI;
 450     ++UI;
 451     if (JoinedCopies.count(UseMI))
 452       continue;
 453     if (UseMI->isDebugValue()) {
 454       // FIXME These don't have an instruction index.  Not clear we have enough
 455       // info to decide whether to do this replacement or not.  For now do it.
 456       UseMO.setReg(NewReg);
 457       continue;
 458     }
 459     SlotIndex UseIdx = li_->getInstructionIndex(UseMI).getUseIndex();
 460     LiveInterval::iterator ULR = IntA.FindLiveRangeContaining(UseIdx);
 461     if (ULR == IntA.end() || ULR->valno != AValNo)
 462       continue;
 463     if (TargetRegisterInfo::isPhysicalRegister(NewReg))
 464       UseMO.substPhysReg(NewReg, *tri_);
 465     else
 466       UseMO.setReg(NewReg);
 467     if (UseMI == CopyMI)
 468       continue;
 469     if (UseMO.isKill()) {
 470       if (Extended)
 471         UseMO.setIsKill(false);
 472     }
 473     unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
 474     if (UseMI->isCopy()) {
 475       if (UseMI->getOperand(0).getReg() != IntB.reg ||
 476           UseMI->getOperand(0).getSubReg())
 477         continue;
 478     } else if (tii_->isMoveInstr(*UseMI, SrcReg, DstReg, SrcSubIdx, DstSubIdx)){
 479       if (DstReg != IntB.reg || DstSubIdx)
 480         continue;
 481     } else
 482       continue;
 483     // This copy will become a noop. If it's defining a new val#,
 484     // remove that val# as well. However this live range is being
 485     // extended to the end of the existing live range defined by the copy.
 486     SlotIndex DefIdx = UseIdx.getDefIndex();
 487     const LiveRange *DLR = IntB.getLiveRangeContaining(DefIdx);
 488     if (!DLR)
 489       continue;
 490     BHasPHIKill |= DLR->valno->hasPHIKill();
 491     assert(DLR->valno->def == DefIdx);
 492     BDeadValNos.push_back(DLR->valno);
 493     BExtend[DLR->start] = DLR->end;
 494     JoinedCopies.insert(UseMI);
 495   }
 496
 497   // We need to insert a new liverange: [ALR.start, LastUse). It may be we can
 498   // simply extend BLR if CopyMI doesn't end the range.
 499   DEBUG({
 500       dbgs() << "Extending: ";
 501       IntB.print(dbgs(), tri_);
 502     });
 503
 504   // Remove val#'s defined by copies that will be coalesced away.
 505   for (unsigned i = 0, e = BDeadValNos.size(); i != e; ++i) {
 506     VNInfo *DeadVNI = BDeadValNos[i];
 507     if (BHasSubRegs) {
 508       for (const unsigned *SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR) {
 509         if (!li_->hasInterval(*SR))
 510           continue;
 511         LiveInterval &SRLI = li_->getInterval(*SR);
 512         if (const LiveRange *SRLR = SRLI.getLiveRangeContaining(DeadVNI->def))
 513           SRLI.removeValNo(SRLR->valno);
 514       }
 515     }
 516     IntB.removeValNo(BDeadValNos[i]);
 517   }
 518
 519   // Extend BValNo by merging in IntA live ranges of AValNo. Val# definition
 520   // is updated.
 521   VNInfo *ValNo = BValNo;
 522   ValNo->def = AValNo->def;
 523   ValNo->setCopy(0);
 524   for (LiveInterval::iterator AI = IntA.begin(), AE = IntA.end();
 525        AI != AE; ++AI) {
 526     if (AI->valno != AValNo) continue;
 527     SlotIndex End = AI->end;
 528     std::map<SlotIndex, SlotIndex>::iterator
 529       EI = BExtend.find(End);
 530     if (EI != BExtend.end())
 531       End = EI->second;
 532     IntB.addRange(LiveRange(AI->start, End, ValNo));
 533   }
 534   ValNo->setHasPHIKill(BHasPHIKill);
 535
 536   DEBUG({
 537       dbgs() << "   result = ";
 538       IntB.print(dbgs(), tri_);
 539       dbgs() << "\nShortening: ";
 540       IntA.print(dbgs(), tri_);
 541     });
 542
 543   IntA.removeValNo(AValNo);
 544
 545   DEBUG({
 546       dbgs() << "   result = ";
 547       IntA.print(dbgs(), tri_);
 548       dbgs() << '\n';
 549     });
 550
 551   ++numCommutes;
 552   return true;
 553 }
 554
 555 /// isSameOrFallThroughBB - Return true if MBB == SuccMBB or MBB simply
 556 /// fallthoughs to SuccMBB.
 557 static bool isSameOrFallThroughBB(MachineBasicBlock *MBB,
 558                                   MachineBasicBlock *SuccMBB,
 559                                   const TargetInstrInfo *tii_) {
 560   if (MBB == SuccMBB)
 561     return true;
 562   MachineBasicBlock *TBB = 0, *FBB = 0;
 563   SmallVector<MachineOperand, 4> Cond;
 564   return !tii_->AnalyzeBranch(*MBB, TBB, FBB, Cond) && !TBB && !FBB &&
 565     MBB->isSuccessor(SuccMBB);
 566 }
 567
 568 /// removeRange - Wrapper for LiveInterval::removeRange. This removes a range
 569 /// from a physical register live interval as well as from the live intervals
 570 /// of its sub-registers.
 571 static void removeRange(LiveInterval &li,
 572                         SlotIndex Start, SlotIndex End,
 573                         LiveIntervals *li_, const TargetRegisterInfo *tri_) {
 574   li.removeRange(Start, End, true);
 575   if (TargetRegisterInfo::isPhysicalRegister(li.reg)) {
 576     for (const unsigned* SR = tri_->getSubRegisters(li.reg); *SR; ++SR) {
 577       if (!li_->hasInterval(*SR))
 578         continue;
 579       LiveInterval &sli = li_->getInterval(*SR);
 580       SlotIndex RemoveStart = Start;
 581       SlotIndex RemoveEnd = Start;
 582
 583       while (RemoveEnd != End) {
 584         LiveInterval::iterator LR = sli.FindLiveRangeContaining(RemoveStart);
 585         if (LR == sli.end())
 586           break;
 587         RemoveEnd = (LR->end < End) ? LR->end : End;
 588         sli.removeRange(RemoveStart, RemoveEnd, true);
 589         RemoveStart = RemoveEnd;
 590       }
 591     }
 592   }
 593 }
 594
 595 /// TrimLiveIntervalToLastUse - If there is a last use in the same basic block
 596 /// as the copy instruction, trim the live interval to the last use and return
 597 /// true.
 598 bool
 599 SimpleRegisterCoalescing::TrimLiveIntervalToLastUse(SlotIndex CopyIdx,
 600                                                     MachineBasicBlock *CopyMBB,
 601                                                     LiveInterval &li,
 602                                                     const LiveRange *LR) {
 603   SlotIndex MBBStart = li_->getMBBStartIdx(CopyMBB);
 604   SlotIndex LastUseIdx;
 605   MachineOperand *LastUse =
 606     lastRegisterUse(LR->start, CopyIdx.getPrevSlot(), li.reg, LastUseIdx);
 607   if (LastUse) {
 608     MachineInstr *LastUseMI = LastUse->getParent();
 609     if (!isSameOrFallThroughBB(LastUseMI->getParent(), CopyMBB, tii_)) {
 610       // r1024 = op
 611       // ...
 612       // BB1:
 613       //       = r1024
 614       //
 615       // BB2:
 616       // r1025<dead> = r1024<kill>
 617       if (MBBStart < LR->end)
 618         removeRange(li, MBBStart, LR->end, li_, tri_);
 619       return true;
 620     }
 621
 622     // There are uses before the copy, just shorten the live range to the end
 623     // of last use.
 624     LastUse->setIsKill();
 625     removeRange(li, LastUseIdx.getDefIndex(), LR->end, li_, tri_);
 626     if (LastUseMI->isCopy()) {
 627       MachineOperand &DefMO = LastUseMI->getOperand(0);
 628       if (DefMO.getReg() == li.reg && !DefMO.getSubReg())
 629         DefMO.setIsDead();
 630     }
 631     unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
 632     if (tii_->isMoveInstr(*LastUseMI, SrcReg, DstReg, SrcSubIdx, DstSubIdx) &&
 633         DstReg == li.reg && DstSubIdx == 0) {
 634       // Last use is itself an identity code.
 635       int DeadIdx = LastUseMI->findRegisterDefOperandIdx(li.reg,
 636                                                          false, false, tri_);
 637       LastUseMI->getOperand(DeadIdx).setIsDead();
 638     }
 639     return true;
 640   }
 641
 642   // Is it livein?
 643   if (LR->start <= MBBStart && LR->end > MBBStart) {
 644     if (LR->start == li_->getZeroIndex()) {
 645       assert(TargetRegisterInfo::isPhysicalRegister(li.reg));
 646       // Live-in to the function but dead. Remove it from entry live-in set.
 647       mf_->begin()->removeLiveIn(li.reg);
 648     }
 649     // FIXME: Shorten intervals in BBs that reaches this BB.
 650   }
 651
 652   return false;
 653 }
 654
 655 /// ReMaterializeTrivialDef - If the source of a copy is defined by a trivial
 656 /// computation, replace the copy by rematerialize the definition.
 657 bool SimpleRegisterCoalescing::ReMaterializeTrivialDef(LiveInterval &SrcInt,
 658                                                        unsigned DstReg,
 659                                                        unsigned DstSubIdx,
 660                                                        MachineInstr *CopyMI) {
 661   SlotIndex CopyIdx = li_->getInstructionIndex(CopyMI).getUseIndex();
 662   LiveInterval::iterator SrcLR = SrcInt.FindLiveRangeContaining(CopyIdx);
 663   assert(SrcLR != SrcInt.end() && "Live range not found!");
 664   VNInfo *ValNo = SrcLR->valno;
 665   // If other defs can reach uses of this def, then it's not safe to perform
 666   // the optimization. FIXME: Do isPHIDef and isDefAccurate both need to be
 667   // tested?
 668   if (ValNo->isPHIDef() || !ValNo->isDefAccurate() ||
 669       ValNo->isUnused() || ValNo->hasPHIKill())
 670     return false;
 671   MachineInstr *DefMI = li_->getInstructionFromIndex(ValNo->def);
 672   assert(DefMI && "Defining instruction disappeared");
 673   const TargetInstrDesc &TID = DefMI->getDesc();
 674   if (!TID.isAsCheapAsAMove())
 675     return false;
 676   if (!tii_->isTriviallyReMaterializable(DefMI, AA))
 677     return false;
 678   bool SawStore = false;
 679   if (!DefMI->isSafeToMove(tii_, AA, SawStore))
 680     return false;
 681   if (TID.getNumDefs() != 1)
 682     return false;
 683   if (!DefMI->isImplicitDef()) {
 684     // Make sure the copy destination register class fits the instruction
 685     // definition register class. The mismatch can happen as a result of earlier
 686     // extract_subreg, insert_subreg, subreg_to_reg coalescing.
 687     const TargetRegisterClass *RC = TID.OpInfo[0].getRegClass(tri_);
 688     if (TargetRegisterInfo::isVirtualRegister(DstReg)) {
 689       if (mri_->getRegClass(DstReg) != RC)
 690         return false;
 691     } else if (!RC->contains(DstReg))
 692       return false;
 693   }
 694
 695   // If destination register has a sub-register index on it, make sure it mtches
 696   // the instruction register class.
 697   if (DstSubIdx) {
 698     const TargetInstrDesc &TID = DefMI->getDesc();
 699     if (TID.getNumDefs() != 1)
 700       return false;
 701     const TargetRegisterClass *DstRC = mri_->getRegClass(DstReg);
 702     const TargetRegisterClass *DstSubRC =
 703       DstRC->getSubRegisterRegClass(DstSubIdx);
 704     const TargetRegisterClass *DefRC = TID.OpInfo[0].getRegClass(tri_);
 705     if (DefRC == DstRC)
 706       DstSubIdx = 0;
 707     else if (DefRC != DstSubRC)
 708       return false;
 709   }
 710
 711   RemoveCopyFlag(DstReg, CopyMI);
 712
 713   // If copy kills the source register, find the last use and propagate
 714   // kill.
 715   bool checkForDeadDef = false;
 716   MachineBasicBlock *MBB = CopyMI->getParent();
 717   if (SrcLR->end == CopyIdx.getDefIndex())
 718     if (!TrimLiveIntervalToLastUse(CopyIdx, MBB, SrcInt, SrcLR)) {
 719       checkForDeadDef = true;
 720     }
 721
 722   MachineBasicBlock::iterator MII =
 723     llvm::next(MachineBasicBlock::iterator(CopyMI));
 724   tii_->reMaterialize(*MBB, MII, DstReg, DstSubIdx, DefMI, *tri_);
 725   MachineInstr *NewMI = prior(MII);
 726
 727   if (checkForDeadDef) {
 728     // PR4090 fix: Trim interval failed because there was no use of the
 729     // source interval in this MBB. If the def is in this MBB too then we
 730     // should mark it dead:
 731     if (DefMI->getParent() == MBB) {
 732       DefMI->addRegisterDead(SrcInt.reg, tri_);
 733       SrcLR->end = SrcLR->start.getNextSlot();
 734     }
 735   }
 736
 737   // CopyMI may have implicit operands, transfer them over to the newly
 738   // rematerialized instruction. And update implicit def interval valnos.
 739   for (unsigned i = CopyMI->getDesc().getNumOperands(),
 740          e = CopyMI->getNumOperands(); i != e; ++i) {
 741     MachineOperand &MO = CopyMI->getOperand(i);
 742     if (MO.isReg() && MO.isImplicit())
 743       NewMI->addOperand(MO);
 744     if (MO.isDef())
 745       RemoveCopyFlag(MO.getReg(), CopyMI);
 746   }
 747
 748   TransferImplicitOps(CopyMI, NewMI);
 749   li_->ReplaceMachineInstrInMaps(CopyMI, NewMI);
 750   CopyMI->eraseFromParent();
 751   ReMatCopies.insert(CopyMI);
 752   ReMatDefs.insert(DefMI);
 753   DEBUG(dbgs() << "Remat: " << *NewMI);
 754   ++NumReMats;
 755   return true;
 756 }
 757
 758 /// UpdateRegDefsUses - Replace all defs and uses of SrcReg to DstReg and
 759 /// update the subregister number if it is not zero. If DstReg is a
 760 /// physical register and the existing subregister number of the def / use
 761 /// being updated is not zero, make sure to set it to the correct physical
 762 /// subregister.
 763 void
 764 SimpleRegisterCoalescing::UpdateRegDefsUses(const CoalescerPair &CP) {
 765   bool DstIsPhys = CP.isPhys();
 766   unsigned SrcReg = CP.getSrcReg();
 767   unsigned DstReg = CP.getDstReg();
 768   unsigned SubIdx = CP.getSubIdx();
 769
 770   for (MachineRegisterInfo::reg_iterator I = mri_->reg_begin(SrcReg);
 771        MachineInstr *UseMI = I.skipInstruction();) {
 772     // A PhysReg copy that won't be coalesced can perhaps be rematerialized
 773     // instead.
 774     if (DstIsPhys) {
 775       unsigned CopySrcReg, CopyDstReg, CopySrcSubIdx, CopyDstSubIdx;
 776       if (tii_->isMoveInstr(*UseMI, CopySrcReg, CopyDstReg,
 777                             CopySrcSubIdx, CopyDstSubIdx) &&
 778           CopySrcSubIdx == 0 && CopyDstSubIdx == 0 &&
 779           CopySrcReg != CopyDstReg && CopySrcReg == SrcReg &&
 780           CopyDstReg != DstReg && !JoinedCopies.count(UseMI) &&
 781           ReMaterializeTrivialDef(li_->getInterval(SrcReg), CopyDstReg, 0,
 782                                   UseMI))
 783         continue;
 784     }
 785
 786     SmallVector<unsigned,8> Ops;
 787     bool Reads, Writes;
 788     tie(Reads, Writes) = UseMI->readsWritesVirtualRegister(SrcReg, &Ops);
 789     bool Kills = false, Deads = false;
 790
 791     // Replace SrcReg with DstReg in all UseMI operands.
 792     for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
 793       MachineOperand &MO = UseMI->getOperand(Ops[i]);
 794       Kills |= MO.isKill();
 795       Deads |= MO.isDead();
 796
 797       if (DstIsPhys)
 798         MO.substPhysReg(DstReg, *tri_);
 799       else
 800         MO.substVirtReg(DstReg, SubIdx, *tri_);
 801     }
 802
 803     // This instruction is a copy that will be removed.
 804     if (JoinedCopies.count(UseMI))
 805       continue;
 806
 807     if (SubIdx) {
 808       // If UseMI was a simple SrcReg def, make sure we didn't turn it into a
 809       // read-modify-write of DstReg.
 810       if (Deads)
 811         UseMI->addRegisterDead(DstReg, tri_);
 812       else if (!Reads && Writes)
 813         UseMI->addRegisterDefined(DstReg, tri_);
 814
 815       // Kill flags apply to the whole physical register.
 816       if (DstIsPhys && Kills)
 817         UseMI->addRegisterKilled(DstReg, tri_);
 818     }
 819
 820     DEBUG({
 821         dbgs() << "\t\tupdated: ";
 822         if (!UseMI->isDebugValue())
 823           dbgs() << li_->getInstructionIndex(UseMI) << "\t";
 824         dbgs() << *UseMI;
 825       });
 826
 827
 828     // After updating the operand, check if the machine instruction has
 829     // become a copy. If so, update its val# information.
 830     const TargetInstrDesc &TID = UseMI->getDesc();
 831     if (DstIsPhys || TID.getNumDefs() != 1 || TID.getNumOperands() <= 2)
 832       continue;
 833
 834     unsigned CopySrcReg, CopyDstReg, CopySrcSubIdx, CopyDstSubIdx;
 835     if (tii_->isMoveInstr(*UseMI, CopySrcReg, CopyDstReg,
 836                           CopySrcSubIdx, CopyDstSubIdx) &&
 837         CopySrcReg != CopyDstReg &&
 838         (TargetRegisterInfo::isVirtualRegister(CopyDstReg) ||
 839          allocatableRegs_[CopyDstReg])) {
 840       LiveInterval &LI = li_->getInterval(CopyDstReg);
 841       SlotIndex DefIdx =
 842         li_->getInstructionIndex(UseMI).getDefIndex();
 843       if (const LiveRange *DLR = LI.getLiveRangeContaining(DefIdx)) {
 844         if (DLR->valno->def == DefIdx)
 845           DLR->valno->setCopy(UseMI);
 846       }
 847     }
 848   }
 849 }
 850
 851 /// removeIntervalIfEmpty - Check if the live interval of a physical register
 852 /// is empty, if so remove it and also remove the empty intervals of its
 853 /// sub-registers. Return true if live interval is removed.
 854 static bool removeIntervalIfEmpty(LiveInterval &li, LiveIntervals *li_,
 855                                   const TargetRegisterInfo *tri_) {
 856   if (li.empty()) {
 857     if (TargetRegisterInfo::isPhysicalRegister(li.reg))
 858       for (const unsigned* SR = tri_->getSubRegisters(li.reg); *SR; ++SR) {
 859         if (!li_->hasInterval(*SR))
 860           continue;
 861         LiveInterval &sli = li_->getInterval(*SR);
 862         if (sli.empty())
 863           li_->removeInterval(*SR);
 864       }
 865     li_->removeInterval(li.reg);
 866     return true;
 867   }
 868   return false;
 869 }
 870
 871 /// ShortenDeadCopyLiveRange - Shorten a live range defined by a dead copy.
 872 /// Return true if live interval is removed.
 873 bool SimpleRegisterCoalescing::ShortenDeadCopyLiveRange(LiveInterval &li,
 874                                                         MachineInstr *CopyMI) {
 875   SlotIndex CopyIdx = li_->getInstructionIndex(CopyMI);
 876   LiveInterval::iterator MLR =
 877     li.FindLiveRangeContaining(CopyIdx.getDefIndex());
 878   if (MLR == li.end())
 879     return false;  // Already removed by ShortenDeadCopySrcLiveRange.
 880   SlotIndex RemoveStart = MLR->start;
 881   SlotIndex RemoveEnd = MLR->end;
 882   SlotIndex DefIdx = CopyIdx.getDefIndex();
 883   // Remove the liverange that's defined by this.
 884   if (RemoveStart == DefIdx && RemoveEnd == DefIdx.getStoreIndex()) {
 885     removeRange(li, RemoveStart, RemoveEnd, li_, tri_);
 886     return removeIntervalIfEmpty(li, li_, tri_);
 887   }
 888   return false;
 889 }
 890
 891 /// RemoveDeadDef - If a def of a live interval is now determined dead, remove
 892 /// the val# it defines. If the live interval becomes empty, remove it as well.
 893 bool SimpleRegisterCoalescing::RemoveDeadDef(LiveInterval &li,
 894                                              MachineInstr *DefMI) {
 895   SlotIndex DefIdx = li_->getInstructionIndex(DefMI).getDefIndex();
 896   LiveInterval::iterator MLR = li.FindLiveRangeContaining(DefIdx);
 897   if (DefIdx != MLR->valno->def)
 898     return false;
 899   li.removeValNo(MLR->valno);
 900   return removeIntervalIfEmpty(li, li_, tri_);
 901 }
 902
 903 void SimpleRegisterCoalescing::RemoveCopyFlag(unsigned DstReg,
 904                                               const MachineInstr *CopyMI) {
 905   SlotIndex DefIdx = li_->getInstructionIndex(CopyMI).getDefIndex();
 906   if (li_->hasInterval(DstReg)) {
 907     LiveInterval &LI = li_->getInterval(DstReg);
 908     if (const LiveRange *LR = LI.getLiveRangeContaining(DefIdx))
 909       if (LR->valno->getCopy() == CopyMI)
 910         LR->valno->setCopy(0);
 911   }
 912   if (!TargetRegisterInfo::isPhysicalRegister(DstReg))
 913     return;
 914   for (const unsigned* AS = tri_->getAliasSet(DstReg); *AS; ++AS) {
 915     if (!li_->hasInterval(*AS))
 916       continue;
 917     LiveInterval &LI = li_->getInterval(*AS);
 918     if (const LiveRange *LR = LI.getLiveRangeContaining(DefIdx))
 919       if (LR->valno->getCopy() == CopyMI)
 920         LR->valno->setCopy(0);
 921   }
 922 }
 923
 924 /// PropagateDeadness - Propagate the dead marker to the instruction which
 925 /// defines the val#.
 926 static void PropagateDeadness(LiveInterval &li, MachineInstr *CopyMI,
 927                               SlotIndex &LRStart, LiveIntervals *li_,
 928                               const TargetRegisterInfo* tri_) {
 929   MachineInstr *DefMI =
 930     li_->getInstructionFromIndex(LRStart.getDefIndex());
 931   if (DefMI && DefMI != CopyMI) {
 932     int DeadIdx = DefMI->findRegisterDefOperandIdx(li.reg);
 933     if (DeadIdx != -1)
 934       DefMI->getOperand(DeadIdx).setIsDead();
 935     else
 936       DefMI->addOperand(MachineOperand::CreateReg(li.reg,
 937                    /*def*/true, /*implicit*/true, /*kill*/false, /*dead*/true));
 938     LRStart = LRStart.getNextSlot();
 939   }
 940 }
 941
 942 /// ShortenDeadCopySrcLiveRange - Shorten a live range as it's artificially
 943 /// extended by a dead copy. Mark the last use (if any) of the val# as kill as
 944 /// ends the live range there. If there isn't another use, then this live range
 945 /// is dead. Return true if live interval is removed.
 946 bool
 947 SimpleRegisterCoalescing::ShortenDeadCopySrcLiveRange(LiveInterval &li,
 948                                                       MachineInstr *CopyMI) {
 949   SlotIndex CopyIdx = li_->getInstructionIndex(CopyMI);
 950   if (CopyIdx == SlotIndex()) {
 951     // FIXME: special case: function live in. It can be a general case if the
 952     // first instruction index starts at > 0 value.
 953     assert(TargetRegisterInfo::isPhysicalRegister(li.reg));
 954     // Live-in to the function but dead. Remove it from entry live-in set.
 955     if (mf_->begin()->isLiveIn(li.reg))
 956       mf_->begin()->removeLiveIn(li.reg);
 957     if (const LiveRange *LR = li.getLiveRangeContaining(CopyIdx))
 958       removeRange(li, LR->start, LR->end, li_, tri_);
 959     return removeIntervalIfEmpty(li, li_, tri_);
 960   }
 961
 962   LiveInterval::iterator LR =
 963     li.FindLiveRangeContaining(CopyIdx.getPrevIndex().getStoreIndex());
 964   if (LR == li.end())
 965     // Livein but defined by a phi.
 966     return false;
 967
 968   SlotIndex RemoveStart = LR->start;
 969   SlotIndex RemoveEnd = CopyIdx.getStoreIndex();
 970   if (LR->end > RemoveEnd)
 971     // More uses past this copy? Nothing to do.
 972     return false;
 973
 974   // If there is a last use in the same bb, we can't remove the live range.
 975   // Shorten the live interval and return.
 976   MachineBasicBlock *CopyMBB = CopyMI->getParent();
 977   if (TrimLiveIntervalToLastUse(CopyIdx, CopyMBB, li, LR))
 978     return false;
 979
 980   // There are other kills of the val#. Nothing to do.
 981   if (!li.isOnlyLROfValNo(LR))
 982     return false;
 983
 984   MachineBasicBlock *StartMBB = li_->getMBBFromIndex(RemoveStart);
 985   if (!isSameOrFallThroughBB(StartMBB, CopyMBB, tii_))
 986     // If the live range starts in another mbb and the copy mbb is not a fall
 987     // through mbb, then we can only cut the range from the beginning of the
 988     // copy mbb.
 989     RemoveStart = li_->getMBBStartIdx(CopyMBB).getNextIndex().getBaseIndex();
 990
 991   if (LR->valno->def == RemoveStart) {
 992     // If the def MI defines the val# and this copy is the only kill of the
 993     // val#, then propagate the dead marker.
 994     PropagateDeadness(li, CopyMI, RemoveStart, li_, tri_);
 995     ++numDeadValNo;
 996   }
 997
 998   removeRange(li, RemoveStart, RemoveEnd, li_, tri_);
 999   return removeIntervalIfEmpty(li, li_, tri_);
1000 }
1001
1002
1003 /// isWinToJoinCrossClass - Return true if it's profitable to coalesce
1004 /// two virtual registers from different register classes.
1005 bool
1006 SimpleRegisterCoalescing::isWinToJoinCrossClass(unsigned SrcReg,
1007                                                 unsigned DstReg,
1008                                              const TargetRegisterClass *SrcRC,
1009                                              const TargetRegisterClass *DstRC,
1010                                              const TargetRegisterClass *NewRC) {
1011   unsigned NewRCCount = allocatableRCRegs_[NewRC].count();
1012   // This heuristics is good enough in practice, but it's obviously not *right*.
1013   // 4 is a magic number that works well enough for x86, ARM, etc. It filter
1014   // out all but the most restrictive register classes.
1015   if (NewRCCount > 4 ||
1016       // Early exit if the function is fairly small, coalesce aggressively if
1017       // that's the case. For really special register classes with 3 or
1018       // fewer registers, be a bit more careful.
1019       (li_->getFuncInstructionCount() / NewRCCount) < 8)
1020     return true;
1021   LiveInterval &SrcInt = li_->getInterval(SrcReg);
1022   LiveInterval &DstInt = li_->getInterval(DstReg);
1023   unsigned SrcSize = li_->getApproximateInstructionCount(SrcInt);
1024   unsigned DstSize = li_->getApproximateInstructionCount(DstInt);
1025   if (SrcSize <= NewRCCount && DstSize <= NewRCCount)
1026     return true;
1027   // Estimate *register use density*. If it doubles or more, abort.
1028   unsigned SrcUses = std::distance(mri_->use_nodbg_begin(SrcReg),
1029                                    mri_->use_nodbg_end());
1030   unsigned DstUses = std::distance(mri_->use_nodbg_begin(DstReg),
1031                                    mri_->use_nodbg_end());
1032   unsigned NewUses = SrcUses + DstUses;
1033   unsigned NewSize = SrcSize + DstSize;
1034   if (SrcRC != NewRC && SrcSize > NewRCCount) {
1035     unsigned SrcRCCount = allocatableRCRegs_[SrcRC].count();
1036     if (NewUses*SrcSize*SrcRCCount > 2*SrcUses*NewSize*NewRCCount)
1037       return false;
1038   }
1039   if (DstRC != NewRC && DstSize > NewRCCount) {
1040     unsigned DstRCCount = allocatableRCRegs_[DstRC].count();
1041     if (NewUses*DstSize*DstRCCount > 2*DstUses*NewSize*NewRCCount)
1042       return false;
1043   }
1044   return true;
1045 }
1046
1047
1048 /// JoinCopy - Attempt to join intervals corresponding to SrcReg/DstReg,
1049 /// which are the src/dst of the copy instruction CopyMI.  This returns true
1050 /// if the copy was successfully coalesced away. If it is not currently
1051 /// possible to coalesce this interval, but it may be possible if other
1052 /// things get coalesced, then it returns true by reference in 'Again'.
1053 bool SimpleRegisterCoalescing::JoinCopy(CopyRec &TheCopy, bool &Again) {
1054   MachineInstr *CopyMI = TheCopy.MI;
1055
1056   Again = false;
1057   if (JoinedCopies.count(CopyMI) || ReMatCopies.count(CopyMI))
1058     return false; // Already done.
1059
1060   DEBUG(dbgs() << li_->getInstructionIndex(CopyMI) << '\t' << *CopyMI);
1061
1062   CoalescerPair CP(*tii_, *tri_);
1063   if (!CP.setRegisters(CopyMI)) {
1064     DEBUG(dbgs() << "\tNot coalescable.\n");
1065     return false;
1066   }
1067
1068   // If they are already joined we continue.
1069   if (CP.getSrcReg() == CP.getDstReg()) {
1070     DEBUG(dbgs() << "\tCopy already coalesced.\n");
1071     return false;  // Not coalescable.
1072   }
1073
1074   DEBUG(dbgs() << "\tConsidering merging %reg" << CP.getSrcReg());
1075
1076   // Enforce policies.
1077   if (CP.isPhys()) {
1078     DEBUG(dbgs() <<" with physreg %" << tri_->getName(CP.getDstReg()) << "\n");
1079     // Only coalesce to allocatable physreg.
1080     if (!allocatableRegs_[CP.getDstReg()]) {
1081       DEBUG(dbgs() << "\tRegister is an unallocatable physreg.\n");
1082       return false;  // Not coalescable.
1083     }
1084   } else {
1085     DEBUG({
1086       dbgs() << " with reg%" << CP.getDstReg();
1087       if (CP.getSubIdx())
1088         dbgs() << ":" << tri_->getSubRegIndexName(CP.getSubIdx());
1089       dbgs() << " to " << CP.getNewRC()->getName() << "\n";
1090     });
1091
1092     // Avoid constraining virtual register regclass too much.
1093     if (CP.isCrossClass()) {
1094       if (DisableCrossClassJoin) {
1095         DEBUG(dbgs() << "\tCross-class joins disabled.\n");
1096         return false;
1097       }
1098       if (!isWinToJoinCrossClass(CP.getSrcReg(), CP.getDstReg(),
1099                                  mri_->getRegClass(CP.getSrcReg()),
1100                                  mri_->getRegClass(CP.getDstReg()),
1101                                  CP.getNewRC())) {
1102         DEBUG(dbgs() << "\tAvoid coalescing to constrained register class: "
1103                      << CP.getNewRC()->getName() << ".\n");
1104         Again = true;  // May be possible to coalesce later.
1105         return false;
1106       }
1107     }
1108
1109     // When possible, let DstReg be the larger interval.
1110     if (!CP.getSubIdx() && li_->getInterval(CP.getSrcReg()).ranges.size() >
1111                            li_->getInterval(CP.getDstReg()).ranges.size())
1112       CP.flip();
1113   }
1114
1115   // We need to be careful about coalescing a source physical register with a
1116   // virtual register. Once the coalescing is done, it cannot be broken and
1117   // these are not spillable! If the destination interval uses are far away,
1118   // think twice about coalescing them!
1119   // FIXME: Why are we skipping this test for partial copies?
1120   //        CodeGen/X86/phys_subreg_coalesce-3.ll needs it.
1121   if (!CP.isPartial() && CP.isPhys()) {
1122     LiveInterval &JoinVInt = li_->getInterval(CP.getSrcReg());
1123
1124     // Don't join with physregs that have a ridiculous number of live
1125     // ranges. The data structure performance is really bad when that
1126     // happens.
1127     if (li_->hasInterval(CP.getDstReg()) &&
1128         li_->getInterval(CP.getDstReg()).ranges.size() > 1000) {
1129       mri_->setRegAllocationHint(CP.getSrcReg(), 0, CP.getDstReg());
1130       ++numAborts;
1131       DEBUG(dbgs()
1132            << "\tPhysical register live interval too complicated, abort!\n");
1133       return false;
1134     }
1135
1136     const TargetRegisterClass *RC = mri_->getRegClass(CP.getSrcReg());
1137     unsigned Threshold = allocatableRCRegs_[RC].count() * 2;
1138     unsigned Length = li_->getApproximateInstructionCount(JoinVInt);
1139     if (Length > Threshold &&
1140         std::distance(mri_->use_nodbg_begin(CP.getSrcReg()),
1141                       mri_->use_nodbg_end()) * Threshold < Length) {
1142       // Before giving up coalescing, if definition of source is defined by
1143       // trivial computation, try rematerializing it.
1144       if (!CP.isFlipped() &&
1145           ReMaterializeTrivialDef(JoinVInt, CP.getDstReg(), 0, CopyMI))
1146         return true;
1147
1148       mri_->setRegAllocationHint(CP.getSrcReg(), 0, CP.getDstReg());
1149       ++numAborts;
1150       DEBUG(dbgs() << "\tMay tie down a physical register, abort!\n");
1151       Again = true;  // May be possible to coalesce later.
1152       return false;
1153     }
1154   }
1155
1156   // Okay, attempt to join these two intervals.  On failure, this returns false.
1157   // Otherwise, if one of the intervals being joined is a physreg, this method
1158   // always canonicalizes DstInt to be it.  The output "SrcInt" will not have
1159   // been modified, so we can use this information below to update aliases.
1160   if (!JoinIntervals(CP)) {
1161     // Coalescing failed.
1162
1163     // If definition of source is defined by trivial computation, try
1164     // rematerializing it.
1165     if (!CP.isFlipped() &&
1166         ReMaterializeTrivialDef(li_->getInterval(CP.getSrcReg()),
1167                                 CP.getDstReg(), 0, CopyMI))
1168       return true;
1169
1170     // If we can eliminate the copy without merging the live ranges, do so now.
1171     if (!CP.isPartial()) {
1172       if (AdjustCopiesBackFrom(CP, CopyMI) ||
1173           RemoveCopyByCommutingDef(CP, CopyMI)) {
1174         JoinedCopies.insert(CopyMI);
1175         DEBUG(dbgs() << "\tTrivial!\n");
1176         return true;
1177       }
1178     }
1179
1180     // Otherwise, we are unable to join the intervals.
1181     DEBUG(dbgs() << "\tInterference!\n");
1182     Again = true;  // May be possible to coalesce later.
1183     return false;
1184   }
1185
1186   // Coalescing to a virtual register that is of a sub-register class of the
1187   // other. Make sure the resulting register is set to the right register class.
1188   if (CP.isCrossClass()) {
1189     ++numCrossRCs;
1190     mri_->setRegClass(CP.getDstReg(), CP.getNewRC());
1191   }
1192
1193   // Remember to delete the copy instruction.
1194   JoinedCopies.insert(CopyMI);
1195
1196   UpdateRegDefsUses(CP);
1197
1198   // If we have extended the live range of a physical register, make sure we
1199   // update live-in lists as well.
1200   if (CP.isPhys()) {
1201     SmallVector<MachineBasicBlock*, 16> BlockSeq;
1202     // JoinIntervals invalidates the VNInfos in SrcInt, but we only need the
1203     // ranges for this, and they are preserved.
1204     LiveInterval &SrcInt = li_->getInterval(CP.getSrcReg());
1205     for (LiveInterval::const_iterator I = SrcInt.begin(), E = SrcInt.end();
1206          I != E; ++I ) {
1207       li_->findLiveInMBBs(I->start, I->end, BlockSeq);
1208       for (unsigned idx = 0, size = BlockSeq.size(); idx != size; ++idx) {
1209         MachineBasicBlock &block = *BlockSeq[idx];
1210         if (!block.isLiveIn(CP.getDstReg()))
1211           block.addLiveIn(CP.getDstReg());
1212       }
1213       BlockSeq.clear();
1214     }
1215   }
1216
1217   // SrcReg is guarateed to be the register whose live interval that is
1218   // being merged.
1219   li_->removeInterval(CP.getSrcReg());
1220
1221   // Update regalloc hint.
1222   tri_->UpdateRegAllocHint(CP.getSrcReg(), CP.getDstReg(), *mf_);
1223
1224   DEBUG({
1225     LiveInterval &DstInt = li_->getInterval(CP.getDstReg());
1226     dbgs() << "\tJoined. Result = ";
1227     DstInt.print(dbgs(), tri_);
1228     dbgs() << "\n";
1229   });
1230
1231   ++numJoins;
1232   return true;
1233 }
1234
1235 /// ComputeUltimateVN - Assuming we are going to join two live intervals,
1236 /// compute what the resultant value numbers for each value in the input two
1237 /// ranges will be.  This is complicated by copies between the two which can
1238 /// and will commonly cause multiple value numbers to be merged into one.
1239 ///
1240 /// VN is the value number that we're trying to resolve.  InstDefiningValue
1241 /// keeps track of the new InstDefiningValue assignment for the result
1242 /// LiveInterval.  ThisFromOther/OtherFromThis are sets that keep track of
1243 /// whether a value in this or other is a copy from the opposite set.
1244 /// ThisValNoAssignments/OtherValNoAssignments keep track of value #'s that have
1245 /// already been assigned.
1246 ///
1247 /// ThisFromOther[x] - If x is defined as a copy from the other interval, this
1248 /// contains the value number the copy is from.
1249 ///
1250 static unsigned ComputeUltimateVN(VNInfo *VNI,
1251                                   SmallVector<VNInfo*, 16> &NewVNInfo,
1252                                   DenseMap<VNInfo*, VNInfo*> &ThisFromOther,
1253                                   DenseMap<VNInfo*, VNInfo*> &OtherFromThis,
1254                                   SmallVector<int, 16> &ThisValNoAssignments,
1255                                   SmallVector<int, 16> &OtherValNoAssignments) {
1256   unsigned VN = VNI->id;
1257
1258   // If the VN has already been computed, just return it.
1259   if (ThisValNoAssignments[VN] >= 0)
1260     return ThisValNoAssignments[VN];
1261   assert(ThisValNoAssignments[VN] != -2 && "Cyclic value numbers");
1262
1263   // If this val is not a copy from the other val, then it must be a new value
1264   // number in the destination.
1265   DenseMap<VNInfo*, VNInfo*>::iterator I = ThisFromOther.find(VNI);
1266   if (I == ThisFromOther.end()) {
1267     NewVNInfo.push_back(VNI);
1268     return ThisValNoAssignments[VN] = NewVNInfo.size()-1;
1269   }
1270   VNInfo *OtherValNo = I->second;
1271
1272   // Otherwise, this *is* a copy from the RHS.  If the other side has already
1273   // been computed, return it.
1274   if (OtherValNoAssignments[OtherValNo->id] >= 0)
1275     return ThisValNoAssignments[VN] = OtherValNoAssignments[OtherValNo->id];
1276
1277   // Mark this value number as currently being computed, then ask what the
1278   // ultimate value # of the other value is.
1279   ThisValNoAssignments[VN] = -2;
1280   unsigned UltimateVN =
1281     ComputeUltimateVN(OtherValNo, NewVNInfo, OtherFromThis, ThisFromOther,
1282                       OtherValNoAssignments, ThisValNoAssignments);
1283   return ThisValNoAssignments[VN] = UltimateVN;
1284 }
1285
1286 /// JoinIntervals - Attempt to join these two intervals.  On failure, this
1287 /// returns false.
1288 bool SimpleRegisterCoalescing::JoinIntervals(CoalescerPair &CP) {
1289   LiveInterval &RHS = li_->getInterval(CP.getSrcReg());
1290   DEBUG({ dbgs() << "\t\tRHS = "; RHS.print(dbgs(), tri_); dbgs() << "\n"; });
1291
1292   // If a live interval is a physical register, check for interference with any
1293   // aliases. The interference check implemented here is a bit more conservative
1294   // than the full interfeence check below. We allow overlapping live ranges
1295   // only when one is a copy of the other.
1296   if (CP.isPhys()) {
1297     for (const unsigned *AS = tri_->getAliasSet(CP.getDstReg()); *AS; ++AS){
1298       if (!li_->hasInterval(*AS))
1299         continue;
1300       const LiveInterval &LHS = li_->getInterval(*AS);
1301       LiveInterval::const_iterator LI = LHS.begin();
1302       for (LiveInterval::const_iterator RI = RHS.begin(), RE = RHS.end();
1303            RI != RE; ++RI) {
1304         LI = std::lower_bound(LI, LHS.end(), RI->start);
1305         // Does LHS have an overlapping live range starting before RI?
1306         if ((LI != LHS.begin() && LI[-1].end > RI->start) &&
1307             (RI->start != RI->valno->def ||
1308              !CP.isCoalescable(li_->getInstructionFromIndex(RI->start)))) {
1309           DEBUG({
1310             dbgs() << "\t\tInterference from alias: ";
1311             LHS.print(dbgs(), tri_);
1312             dbgs() << "\n\t\tOverlap at " << RI->start << " and no copy.\n";
1313           });
1314           return false;
1315         }
1316
1317         // Check that LHS ranges beginning in this range are copies.
1318         for (; LI != LHS.end() && LI->start < RI->end; ++LI) {
1319           if (LI->start != LI->valno->def ||
1320               !CP.isCoalescable(li_->getInstructionFromIndex(LI->start))) {
1321             DEBUG({
1322               dbgs() << "\t\tInterference from alias: ";
1323               LHS.print(dbgs(), tri_);
1324               dbgs() << "\n\t\tDef at " << LI->start << " is not a copy.\n";
1325             });
1326             return false;
1327           }
1328         }
1329       }
1330     }
1331   }
1332
1333   // Compute the final value assignment, assuming that the live ranges can be
1334   // coalesced.
1335   SmallVector<int, 16> LHSValNoAssignments;
1336   SmallVector<int, 16> RHSValNoAssignments;
1337   DenseMap<VNInfo*, VNInfo*> LHSValsDefinedFromRHS;
1338   DenseMap<VNInfo*, VNInfo*> RHSValsDefinedFromLHS;
1339   SmallVector<VNInfo*, 16> NewVNInfo;
1340
1341   LiveInterval &LHS = li_->getOrCreateInterval(CP.getDstReg());
1342   DEBUG({ dbgs() << "\t\tLHS = "; LHS.print(dbgs(), tri_); dbgs() << "\n"; });
1343
1344   // Loop over the value numbers of the LHS, seeing if any are defined from
1345   // the RHS.
1346   for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
1347        i != e; ++i) {
1348     VNInfo *VNI = *i;
1349     if (VNI->isUnused() || VNI->getCopy() == 0)  // Src not defined by a copy?
1350       continue;
1351
1352     // Never join with a register that has EarlyClobber redefs.
1353     if (VNI->hasRedefByEC())
1354       return false;
1355
1356     // DstReg is known to be a register in the LHS interval.  If the src is
1357     // from the RHS interval, we can use its value #.
1358     if (!CP.isCoalescable(VNI->getCopy()))
1359       continue;
1360
1361     // Figure out the value # from the RHS.
1362     LiveRange *lr = RHS.getLiveRangeContaining(VNI->def.getPrevSlot());
1363     // The copy could be to an aliased physreg.
1364     if (!lr) continue;
1365     LHSValsDefinedFromRHS[VNI] = lr->valno;
1366   }
1367
1368   // Loop over the value numbers of the RHS, seeing if any are defined from
1369   // the LHS.
1370   for (LiveInterval::vni_iterator i = RHS.vni_begin(), e = RHS.vni_end();
1371        i != e; ++i) {
1372     VNInfo *VNI = *i;
1373     if (VNI->isUnused() || VNI->getCopy() == 0)  // Src not defined by a copy?
1374       continue;
1375
1376     // Never join with a register that has EarlyClobber redefs.
1377     if (VNI->hasRedefByEC())
1378       return false;
1379
1380     // DstReg is known to be a register in the RHS interval.  If the src is
1381     // from the LHS interval, we can use its value #.
1382     if (!CP.isCoalescable(VNI->getCopy()))
1383       continue;
1384
1385     // Figure out the value # from the LHS.
1386     LiveRange *lr = LHS.getLiveRangeContaining(VNI->def.getPrevSlot());
1387     // The copy could be to an aliased physreg.
1388     if (!lr) continue;
1389     RHSValsDefinedFromLHS[VNI] = lr->valno;
1390   }
1391
1392   LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
1393   RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
1394   NewVNInfo.reserve(LHS.getNumValNums() + RHS.getNumValNums());
1395
1396   for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
1397        i != e; ++i) {
1398     VNInfo *VNI = *i;
1399     unsigned VN = VNI->id;
1400     if (LHSValNoAssignments[VN] >= 0 || VNI->isUnused())
1401       continue;
1402     ComputeUltimateVN(VNI, NewVNInfo,
1403                       LHSValsDefinedFromRHS, RHSValsDefinedFromLHS,
1404                       LHSValNoAssignments, RHSValNoAssignments);
1405   }
1406   for (LiveInterval::vni_iterator i = RHS.vni_begin(), e = RHS.vni_end();
1407        i != e; ++i) {
1408     VNInfo *VNI = *i;
1409     unsigned VN = VNI->id;
1410     if (RHSValNoAssignments[VN] >= 0 || VNI->isUnused())
1411       continue;
1412     // If this value number isn't a copy from the LHS, it's a new number.
1413     if (RHSValsDefinedFromLHS.find(VNI) == RHSValsDefinedFromLHS.end()) {
1414       NewVNInfo.push_back(VNI);
1415       RHSValNoAssignments[VN] = NewVNInfo.size()-1;
1416       continue;
1417     }
1418
1419     ComputeUltimateVN(VNI, NewVNInfo,
1420                       RHSValsDefinedFromLHS, LHSValsDefinedFromRHS,
1421                       RHSValNoAssignments, LHSValNoAssignments);
1422   }
1423
1424   // Armed with the mappings of LHS/RHS values to ultimate values, walk the
1425   // interval lists to see if these intervals are coalescable.
1426   LiveInterval::const_iterator I = LHS.begin();
1427   LiveInterval::const_iterator IE = LHS.end();
1428   LiveInterval::const_iterator J = RHS.begin();
1429   LiveInterval::const_iterator JE = RHS.end();
1430
1431   // Skip ahead until the first place of potential sharing.
1432   if (I != IE && J != JE) {
1433     if (I->start < J->start) {
1434       I = std::upper_bound(I, IE, J->start);
1435       if (I != LHS.begin()) --I;
1436     } else if (J->start < I->start) {
1437       J = std::upper_bound(J, JE, I->start);
1438       if (J != RHS.begin()) --J;
1439     }
1440   }
1441
1442   while (I != IE && J != JE) {
1443     // Determine if these two live ranges overlap.
1444     bool Overlaps;
1445     if (I->start < J->start) {
1446       Overlaps = I->end > J->start;
1447     } else {
1448       Overlaps = J->end > I->start;
1449     }
1450
1451     // If so, check value # info to determine if they are really different.
1452     if (Overlaps) {
1453       // If the live range overlap will map to the same value number in the
1454       // result liverange, we can still coalesce them.  If not, we can't.
1455       if (LHSValNoAssignments[I->valno->id] !=
1456           RHSValNoAssignments[J->valno->id])
1457         return false;
1458       // If it's re-defined by an early clobber somewhere in the live range,
1459       // then conservatively abort coalescing.
1460       if (NewVNInfo[LHSValNoAssignments[I->valno->id]]->hasRedefByEC())
1461         return false;
1462     }
1463
1464     if (I->end < J->end)
1465       ++I;
1466     else
1467       ++J;
1468   }
1469
1470   // Update kill info. Some live ranges are extended due to copy coalescing.
1471   for (DenseMap<VNInfo*, VNInfo*>::iterator I = LHSValsDefinedFromRHS.begin(),
1472          E = LHSValsDefinedFromRHS.end(); I != E; ++I) {
1473     VNInfo *VNI = I->first;
1474     unsigned LHSValID = LHSValNoAssignments[VNI->id];
1475     if (VNI->hasPHIKill())
1476       NewVNInfo[LHSValID]->setHasPHIKill(true);
1477   }
1478
1479   // Update kill info. Some live ranges are extended due to copy coalescing.
1480   for (DenseMap<VNInfo*, VNInfo*>::iterator I = RHSValsDefinedFromLHS.begin(),
1481          E = RHSValsDefinedFromLHS.end(); I != E; ++I) {
1482     VNInfo *VNI = I->first;
1483     unsigned RHSValID = RHSValNoAssignments[VNI->id];
1484     if (VNI->hasPHIKill())
1485       NewVNInfo[RHSValID]->setHasPHIKill(true);
1486   }
1487
1488   if (LHSValNoAssignments.empty())
1489     LHSValNoAssignments.push_back(-1);
1490   if (RHSValNoAssignments.empty())
1491     RHSValNoAssignments.push_back(-1);
1492
1493   // If we get here, we know that we can coalesce the live ranges.  Ask the
1494   // intervals to coalesce themselves now.
1495   LHS.join(RHS, &LHSValNoAssignments[0], &RHSValNoAssignments[0], NewVNInfo,
1496            mri_);
1497   return true;
1498 }
1499
1500 namespace {
1501   // DepthMBBCompare - Comparison predicate that sort first based on the loop
1502   // depth of the basic block (the unsigned), and then on the MBB number.
1503   struct DepthMBBCompare {
1504     typedef std::pair<unsigned, MachineBasicBlock*> DepthMBBPair;
1505     bool operator()(const DepthMBBPair &LHS, const DepthMBBPair &RHS) const {
1506       // Deeper loops first
1507       if (LHS.first != RHS.first)
1508         return LHS.first > RHS.first;
1509
1510       // Prefer blocks that are more connected in the CFG. This takes care of
1511       // the most difficult copies first while intervals are short.
1512       unsigned cl = LHS.second->pred_size() + LHS.second->succ_size();
1513       unsigned cr = RHS.second->pred_size() + RHS.second->succ_size();
1514       if (cl != cr)
1515         return cl > cr;
1516
1517       // As a last resort, sort by block number.
1518       return LHS.second->getNumber() < RHS.second->getNumber();
1519     }
1520   };
1521 }
1522
1523 void SimpleRegisterCoalescing::CopyCoalesceInMBB(MachineBasicBlock *MBB,
1524                                                std::vector<CopyRec> &TryAgain) {
1525   DEBUG(dbgs() << MBB->getName() << ":\n");
1526
1527   std::vector<CopyRec> VirtCopies;
1528   std::vector<CopyRec> PhysCopies;
1529   std::vector<CopyRec> ImpDefCopies;
1530   for (MachineBasicBlock::iterator MII = MBB->begin(), E = MBB->end();
1531        MII != E;) {
1532     MachineInstr *Inst = MII++;
1533
1534     // If this isn't a copy nor a extract_subreg, we can't join intervals.
1535     unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1536     bool isInsUndef = false;
1537     if (Inst->isCopy()) {
1538       DstReg = Inst->getOperand(0).getReg();
1539       SrcReg = Inst->getOperand(1).getReg();
1540     } else if (Inst->isSubregToReg()) {
1541       DstReg = Inst->getOperand(0).getReg();
1542       SrcReg = Inst->getOperand(2).getReg();
1543     } else if (!tii_->isMoveInstr(*Inst, SrcReg, DstReg, SrcSubIdx, DstSubIdx))
1544       continue;
1545
1546     bool SrcIsPhys = TargetRegisterInfo::isPhysicalRegister(SrcReg);
1547     bool DstIsPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
1548     if (isInsUndef ||
1549         (li_->hasInterval(SrcReg) && li_->getInterval(SrcReg).empty()))
1550       ImpDefCopies.push_back(CopyRec(Inst, 0));
1551     else if (SrcIsPhys || DstIsPhys)
1552       PhysCopies.push_back(CopyRec(Inst, 0));
1553     else
1554       VirtCopies.push_back(CopyRec(Inst, 0));
1555   }
1556
1557   // Try coalescing implicit copies and insert_subreg <undef> first,
1558   // followed by copies to / from physical registers, then finally copies
1559   // from virtual registers to virtual registers.
1560   for (unsigned i = 0, e = ImpDefCopies.size(); i != e; ++i) {
1561     CopyRec &TheCopy = ImpDefCopies[i];
1562     bool Again = false;
1563     if (!JoinCopy(TheCopy, Again))
1564       if (Again)
1565         TryAgain.push_back(TheCopy);
1566   }
1567   for (unsigned i = 0, e = PhysCopies.size(); i != e; ++i) {
1568     CopyRec &TheCopy = PhysCopies[i];
1569     bool Again = false;
1570     if (!JoinCopy(TheCopy, Again))
1571       if (Again)
1572         TryAgain.push_back(TheCopy);
1573   }
1574   for (unsigned i = 0, e = VirtCopies.size(); i != e; ++i) {
1575     CopyRec &TheCopy = VirtCopies[i];
1576     bool Again = false;
1577     if (!JoinCopy(TheCopy, Again))
1578       if (Again)
1579         TryAgain.push_back(TheCopy);
1580   }
1581 }
1582
1583 void SimpleRegisterCoalescing::joinIntervals() {
1584   DEBUG(dbgs() << "********** JOINING INTERVALS ***********\n");
1585
1586   std::vector<CopyRec> TryAgainList;
1587   if (loopInfo->empty()) {
1588     // If there are no loops in the function, join intervals in function order.
1589     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();
1590          I != E; ++I)
1591       CopyCoalesceInMBB(I, TryAgainList);
1592   } else {
1593     // Otherwise, join intervals in inner loops before other intervals.
1594     // Unfortunately we can't just iterate over loop hierarchy here because
1595     // there may be more MBB's than BB's.  Collect MBB's for sorting.
1596
1597     // Join intervals in the function prolog first. We want to join physical
1598     // registers with virtual registers before the intervals got too long.
1599     std::vector<std::pair<unsigned, MachineBasicBlock*> > MBBs;
1600     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();I != E;++I){
1601       MachineBasicBlock *MBB = I;
1602       MBBs.push_back(std::make_pair(loopInfo->getLoopDepth(MBB), I));
1603     }
1604
1605     // Sort by loop depth.
1606     std::sort(MBBs.begin(), MBBs.end(), DepthMBBCompare());
1607
1608     // Finally, join intervals in loop nest order.
1609     for (unsigned i = 0, e = MBBs.size(); i != e; ++i)
1610       CopyCoalesceInMBB(MBBs[i].second, TryAgainList);
1611   }
1612
1613   // Joining intervals can allow other intervals to be joined.  Iteratively join
1614   // until we make no progress.
1615   bool ProgressMade = true;
1616   while (ProgressMade) {
1617     ProgressMade = false;
1618
1619     for (unsigned i = 0, e = TryAgainList.size(); i != e; ++i) {
1620       CopyRec &TheCopy = TryAgainList[i];
1621       if (!TheCopy.MI)
1622         continue;
1623
1624       bool Again = false;
1625       bool Success = JoinCopy(TheCopy, Again);
1626       if (Success || !Again) {
1627         TheCopy.MI = 0;   // Mark this one as done.
1628         ProgressMade = true;
1629       }
1630     }
1631   }
1632 }
1633
1634 /// Return true if the two specified registers belong to different register
1635 /// classes.  The registers may be either phys or virt regs.
1636 bool
1637 SimpleRegisterCoalescing::differingRegisterClasses(unsigned RegA,
1638                                                    unsigned RegB) const {
1639   // Get the register classes for the first reg.
1640   if (TargetRegisterInfo::isPhysicalRegister(RegA)) {
1641     assert(TargetRegisterInfo::isVirtualRegister(RegB) &&
1642            "Shouldn't consider two physregs!");
1643     return !mri_->getRegClass(RegB)->contains(RegA);
1644   }
1645
1646   // Compare against the regclass for the second reg.
1647   const TargetRegisterClass *RegClassA = mri_->getRegClass(RegA);
1648   if (TargetRegisterInfo::isVirtualRegister(RegB)) {
1649     const TargetRegisterClass *RegClassB = mri_->getRegClass(RegB);
1650     return RegClassA != RegClassB;
1651   }
1652   return !RegClassA->contains(RegB);
1653 }
1654
1655 /// lastRegisterUse - Returns the last (non-debug) use of the specific register
1656 /// between cycles Start and End or NULL if there are no uses.
1657 MachineOperand *
1658 SimpleRegisterCoalescing::lastRegisterUse(SlotIndex Start,
1659                                           SlotIndex End,
1660                                           unsigned Reg,
1661                                           SlotIndex &UseIdx) const{
1662   UseIdx = SlotIndex();
1663   if (TargetRegisterInfo::isVirtualRegister(Reg)) {
1664     MachineOperand *LastUse = NULL;
1665     for (MachineRegisterInfo::use_nodbg_iterator I = mri_->use_nodbg_begin(Reg),
1666            E = mri_->use_nodbg_end(); I != E; ++I) {
1667       MachineOperand &Use = I.getOperand();
1668       MachineInstr *UseMI = Use.getParent();
1669       if (UseMI->isIdentityCopy())
1670         continue;
1671       unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1672       if (tii_->isMoveInstr(*UseMI, SrcReg, DstReg, SrcSubIdx, DstSubIdx) &&
1673           SrcReg == DstReg && SrcSubIdx == DstSubIdx)
1674         // Ignore identity copies.
1675         continue;
1676       SlotIndex Idx = li_->getInstructionIndex(UseMI);
1677       // FIXME: Should this be Idx != UseIdx? SlotIndex() will return something
1678       // that compares higher than any other interval.
1679       if (Idx >= Start && Idx < End && Idx >= UseIdx) {
1680         LastUse = &Use;
1681         UseIdx = Idx.getUseIndex();
1682       }
1683     }
1684     return LastUse;
1685   }
1686
1687   SlotIndex s = Start;
1688   SlotIndex e = End.getPrevSlot().getBaseIndex();
1689   while (e >= s) {
1690     // Skip deleted instructions
1691     MachineInstr *MI = li_->getInstructionFromIndex(e);
1692     while (e != SlotIndex() && e.getPrevIndex() >= s && !MI) {
1693       e = e.getPrevIndex();
1694       MI = li_->getInstructionFromIndex(e);
1695     }
1696     if (e < s || MI == NULL)
1697       return NULL;
1698
1699     // Ignore identity copies.
1700     unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1701     if (!MI->isIdentityCopy() &&
1702         !(tii_->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx) &&
1703           SrcReg == DstReg && SrcSubIdx == DstSubIdx))
1704       for (unsigned i = 0, NumOps = MI->getNumOperands(); i != NumOps; ++i) {
1705         MachineOperand &Use = MI->getOperand(i);
1706         if (Use.isReg() && Use.isUse() && Use.getReg() &&
1707             tri_->regsOverlap(Use.getReg(), Reg)) {
1708           UseIdx = e.getUseIndex();
1709           return &Use;
1710         }
1711       }
1712
1713     e = e.getPrevIndex();
1714   }
1715
1716   return NULL;
1717 }
1718
1719 void SimpleRegisterCoalescing::releaseMemory() {
1720   JoinedCopies.clear();
1721   ReMatCopies.clear();
1722   ReMatDefs.clear();
1723 }
1724
1725 bool SimpleRegisterCoalescing::runOnMachineFunction(MachineFunction &fn) {
1726   mf_ = &fn;
1727   mri_ = &fn.getRegInfo();
1728   tm_ = &fn.getTarget();
1729   tri_ = tm_->getRegisterInfo();
1730   tii_ = tm_->getInstrInfo();
1731   li_ = &getAnalysis<LiveIntervals>();
1732   AA = &getAnalysis<AliasAnalysis>();
1733   loopInfo = &getAnalysis<MachineLoopInfo>();
1734
1735   DEBUG(dbgs() << "********** SIMPLE REGISTER COALESCING **********\n"
1736                << "********** Function: "
1737                << ((Value*)mf_->getFunction())->getName() << '\n');
1738
1739   allocatableRegs_ = tri_->getAllocatableSet(fn);
1740   for (TargetRegisterInfo::regclass_iterator I = tri_->regclass_begin(),
1741          E = tri_->regclass_end(); I != E; ++I)
1742     allocatableRCRegs_.insert(std::make_pair(*I,
1743                                              tri_->getAllocatableSet(fn, *I)));
1744
1745   // Join (coalesce) intervals if requested.
1746   if (EnableJoining) {
1747     joinIntervals();
1748     DEBUG({
1749         dbgs() << "********** INTERVALS POST JOINING **********\n";
1750         for (LiveIntervals::iterator I = li_->begin(), E = li_->end();
1751              I != E; ++I){
1752           I->second->print(dbgs(), tri_);
1753           dbgs() << "\n";
1754         }
1755       });
1756   }
1757
1758   // Perform a final pass over the instructions and compute spill weights
1759   // and remove identity moves.
1760   SmallVector<unsigned, 4> DeadDefs;
1761   for (MachineFunction::iterator mbbi = mf_->begin(), mbbe = mf_->end();
1762        mbbi != mbbe; ++mbbi) {
1763     MachineBasicBlock* mbb = mbbi;
1764     for (MachineBasicBlock::iterator mii = mbb->begin(), mie = mbb->end();
1765          mii != mie; ) {
1766       MachineInstr *MI = mii;
1767       unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1768       if (JoinedCopies.count(MI)) {
1769         // Delete all coalesced copies.
1770         bool DoDelete = true;
1771         if (!tii_->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx)) {
1772           assert(MI->isCopyLike() && "Unrecognized copy instruction");
1773           SrcReg = MI->getOperand(MI->isSubregToReg() ? 2 : 1).getReg();
1774           if (TargetRegisterInfo::isPhysicalRegister(SrcReg))
1775             // Do not delete extract_subreg, insert_subreg of physical
1776             // registers unless the definition is dead. e.g.
1777             // %DO<def> = INSERT_SUBREG %D0<undef>, %S0<kill>, 1
1778             // or else the scavenger may complain. LowerSubregs will
1779             // delete them later.
1780             DoDelete = false;
1781         }
1782         if (MI->allDefsAreDead()) {
1783           LiveInterval &li = li_->getInterval(SrcReg);
1784           if (!ShortenDeadCopySrcLiveRange(li, MI))
1785             ShortenDeadCopyLiveRange(li, MI);
1786           DoDelete = true;
1787         }
1788         if (!DoDelete)
1789           mii = llvm::next(mii);
1790         else {
1791           li_->RemoveMachineInstrFromMaps(MI);
1792           mii = mbbi->erase(mii);
1793           ++numPeep;
1794         }
1795         continue;
1796       }
1797
1798       // Now check if this is a remat'ed def instruction which is now dead.
1799       if (ReMatDefs.count(MI)) {
1800         bool isDead = true;
1801         for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1802           const MachineOperand &MO = MI->getOperand(i);
1803           if (!MO.isReg())
1804             continue;
1805           unsigned Reg = MO.getReg();
1806           if (!Reg)
1807             continue;
1808           if (TargetRegisterInfo::isVirtualRegister(Reg))
1809             DeadDefs.push_back(Reg);
1810           if (MO.isDead())
1811             continue;
1812           if (TargetRegisterInfo::isPhysicalRegister(Reg) ||
1813               !mri_->use_nodbg_empty(Reg)) {
1814             isDead = false;
1815             break;
1816           }
1817         }
1818         if (isDead) {
1819           while (!DeadDefs.empty()) {
1820             unsigned DeadDef = DeadDefs.back();
1821             DeadDefs.pop_back();
1822             RemoveDeadDef(li_->getInterval(DeadDef), MI);
1823           }
1824           li_->RemoveMachineInstrFromMaps(mii);
1825           mii = mbbi->erase(mii);
1826           continue;
1827         } else
1828           DeadDefs.clear();
1829       }
1830
1831       // If the move will be an identity move delete it
1832       bool isMove= tii_->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx);
1833       if (MI->isIdentityCopy() ||
1834           (isMove && SrcReg == DstReg && SrcSubIdx == DstSubIdx)) {
1835         if (li_->hasInterval(SrcReg)) {
1836           LiveInterval &RegInt = li_->getInterval(SrcReg);
1837           // If def of this move instruction is dead, remove its live range
1838           // from the destination register's live interval.
1839           if (MI->allDefsAreDead()) {
1840             if (!ShortenDeadCopySrcLiveRange(RegInt, MI))
1841               ShortenDeadCopyLiveRange(RegInt, MI);
1842           }
1843         }
1844         li_->RemoveMachineInstrFromMaps(MI);
1845         mii = mbbi->erase(mii);
1846         ++numPeep;
1847         continue;
1848       }
1849
1850       ++mii;
1851
1852       // Check for now unnecessary kill flags.
1853       if (li_->isNotInMIMap(MI)) continue;
1854       SlotIndex DefIdx = li_->getInstructionIndex(MI).getDefIndex();
1855       for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1856         MachineOperand &MO = MI->getOperand(i);
1857         if (!MO.isReg() || !MO.isKill()) continue;
1858         unsigned reg = MO.getReg();
1859         if (!reg || !li_->hasInterval(reg)) continue;
1860         if (!li_->getInterval(reg).killedAt(DefIdx))
1861           MO.setIsKill(false);
1862       }
1863     }
1864   }
1865
1866   DEBUG(dump());
1867   return true;
1868 }
1869
1870 /// print - Implement the dump method.
1871 void SimpleRegisterCoalescing::print(raw_ostream &O, const Module* m) const {
1872    li_->print(O, m);
1873 }
1874
1875 RegisterCoalescer* llvm::createSimpleRegisterCoalescer() {
1876   return new SimpleRegisterCoalescing();
1877 }
1878
1879 // Make sure that anything that uses RegisterCoalescer pulls in this file...
1880 DEFINING_FILE_FOR(SimpleRegisterCoalescing)