Code clean up.
[oota-llvm.git] / 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(LiveInterval &IntA,
103                                                     LiveInterval &IntB,
104                                                     MachineInstr *CopyMI) {
105   SlotIndex CopyIdx = li_->getInstructionIndex(CopyMI).getDefIndex();
106
107   // BValNo is a value number in B that is defined by a copy from A.  'B3' in
108   // the example above.
109   LiveInterval::iterator BLR = IntB.FindLiveRangeContaining(CopyIdx);
110   assert(BLR != IntB.end() && "Live range not found!");
111   VNInfo *BValNo = BLR->valno;
112
113   // Get the location that B is defined at.  Two options: either this value has
114   // an unknown definition point or it is defined at CopyIdx.  If unknown, we
115   // can't process it.
116   if (!BValNo->getCopy()) return false;
117   assert(BValNo->def == CopyIdx && "Copy doesn't define the value?");
118
119   // AValNo is the value number in A that defines the copy, A3 in the example.
120   SlotIndex CopyUseIdx = CopyIdx.getUseIndex();
121   LiveInterval::iterator ALR = IntA.FindLiveRangeContaining(CopyUseIdx);
122   assert(ALR != IntA.end() && "Live range not found!");
123   VNInfo *AValNo = ALR->valno;
124   // If it's re-defined by an early clobber somewhere in the live range, then
125   // it's not safe to eliminate the copy. FIXME: This is a temporary workaround.
126   // See PR3149:
127   // 172     %ECX<def> = MOV32rr %reg1039<kill>
128   // 180     INLINEASM <es:subl $5,$1
129   //         sbbl $3,$0>, 10, %EAX<def>, 14, %ECX<earlyclobber,def>, 9,
130   //         %EAX<kill>,
131   // 36, <fi#0>, 1, %reg0, 0, 9, %ECX<kill>, 36, <fi#1>, 1, %reg0, 0
132   // 188     %EAX<def> = MOV32rr %EAX<kill>
133   // 196     %ECX<def> = MOV32rr %ECX<kill>
134   // 204     %ECX<def> = MOV32rr %ECX<kill>
135   // 212     %EAX<def> = MOV32rr %EAX<kill>
136   // 220     %EAX<def> = MOV32rr %EAX
137   // 228     %reg1039<def> = MOV32rr %ECX<kill>
138   // The early clobber operand ties ECX input to the ECX def.
139   //
140   // The live interval of ECX is represented as this:
141   // %reg20,inf = [46,47:1)[174,230:0)  0@174-(230) 1@46-(47)
142   // The coalescer has no idea there was a def in the middle of [174,230].
143   if (AValNo->hasRedefByEC())
144     return false;
145
146   // If AValNo is defined as a copy from IntB, we can potentially process this.
147   // Get the instruction that defines this value number.
148   unsigned SrcReg = li_->getVNInfoSourceReg(AValNo);
149   if (!SrcReg) return false;  // Not defined by a copy.
150
151   // If the value number is not defined by a copy instruction, ignore it.
152
153   // If the source register comes from an interval other than IntB, we can't
154   // handle this.
155   if (SrcReg != IntB.reg) return false;
156
157   // Get the LiveRange in IntB that this value number starts with.
158   LiveInterval::iterator ValLR =
159     IntB.FindLiveRangeContaining(AValNo->def.getPrevSlot());
160   assert(ValLR != IntB.end() && "Live range not found!");
161
162   // Make sure that the end of the live range is inside the same block as
163   // CopyMI.
164   MachineInstr *ValLREndInst =
165     li_->getInstructionFromIndex(ValLR->end.getPrevSlot());
166   if (!ValLREndInst ||
167       ValLREndInst->getParent() != CopyMI->getParent()) return false;
168
169   // Okay, we now know that ValLR ends in the same block that the CopyMI
170   // live-range starts.  If there are no intervening live ranges between them in
171   // IntB, we can merge them.
172   if (ValLR+1 != BLR) return false;
173
174   // If a live interval is a physical register, conservatively check if any
175   // of its sub-registers is overlapping the live interval of the virtual
176   // register. If so, do not coalesce.
177   if (TargetRegisterInfo::isPhysicalRegister(IntB.reg) &&
178       *tri_->getSubRegisters(IntB.reg)) {
179     for (const unsigned* SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR)
180       if (li_->hasInterval(*SR) && IntA.overlaps(li_->getInterval(*SR))) {
181         DEBUG({
182             dbgs() << "Interfere with sub-register ";
183             li_->getInterval(*SR).print(dbgs(), tri_);
184           });
185         return false;
186       }
187   }
188
189   DEBUG({
190       dbgs() << "\nExtending: ";
191       IntB.print(dbgs(), tri_);
192     });
193
194   SlotIndex FillerStart = ValLR->end, FillerEnd = BLR->start;
195   // We are about to delete CopyMI, so need to remove it as the 'instruction
196   // that defines this value #'. Update the valnum with the new defining
197   // instruction #.
198   BValNo->def  = FillerStart;
199   BValNo->setCopy(0);
200
201   // Okay, we can merge them.  We need to insert a new liverange:
202   // [ValLR.end, BLR.begin) of either value number, then we merge the
203   // two value numbers.
204   IntB.addRange(LiveRange(FillerStart, FillerEnd, BValNo));
205
206   // If the IntB live range is assigned to a physical register, and if that
207   // physreg has sub-registers, update their live intervals as well.
208   if (TargetRegisterInfo::isPhysicalRegister(IntB.reg)) {
209     for (const unsigned *SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR) {
210       LiveInterval &SRLI = li_->getInterval(*SR);
211       SRLI.addRange(LiveRange(FillerStart, FillerEnd,
212                               SRLI.getNextValue(FillerStart, 0, true,
213                                                 li_->getVNInfoAllocator())));
214     }
215   }
216
217   // Okay, merge "B1" into the same value number as "B0".
218   if (BValNo != ValLR->valno) {
219     IntB.addKills(ValLR->valno, BValNo->kills);
220     IntB.MergeValueNumberInto(BValNo, ValLR->valno);
221   }
222   DEBUG({
223       dbgs() << "   result = ";
224       IntB.print(dbgs(), tri_);
225       dbgs() << "\n";
226     });
227
228   // If the source instruction was killing the source register before the
229   // merge, unset the isKill marker given the live range has been extended.
230   int UIdx = ValLREndInst->findRegisterUseOperandIdx(IntB.reg, true);
231   if (UIdx != -1) {
232     ValLREndInst->getOperand(UIdx).setIsKill(false);
233     ValLR->valno->removeKill(FillerStart);
234   }
235
236   // If the copy instruction was killing the destination register before the
237   // merge, find the last use and trim the live range. That will also add the
238   // isKill marker.
239   if (CopyMI->killsRegister(IntA.reg))
240     TrimLiveIntervalToLastUse(CopyUseIdx, CopyMI->getParent(), IntA, ALR);
241
242   ++numExtends;
243   return true;
244 }
245
246 /// HasOtherReachingDefs - Return true if there are definitions of IntB
247 /// other than BValNo val# that can reach uses of AValno val# of IntA.
248 bool SimpleRegisterCoalescing::HasOtherReachingDefs(LiveInterval &IntA,
249                                                     LiveInterval &IntB,
250                                                     VNInfo *AValNo,
251                                                     VNInfo *BValNo) {
252   for (LiveInterval::iterator AI = IntA.begin(), AE = IntA.end();
253        AI != AE; ++AI) {
254     if (AI->valno != AValNo) continue;
255     LiveInterval::Ranges::iterator BI =
256       std::upper_bound(IntB.ranges.begin(), IntB.ranges.end(), AI->start);
257     if (BI != IntB.ranges.begin())
258       --BI;
259     for (; BI != IntB.ranges.end() && AI->end >= BI->start; ++BI) {
260       if (BI->valno == BValNo)
261         continue;
262       if (BI->start <= AI->start && BI->end > AI->start)
263         return true;
264       if (BI->start > AI->start && BI->start < AI->end)
265         return true;
266     }
267   }
268   return false;
269 }
270
271 static void
272 TransferImplicitOps(MachineInstr *MI, MachineInstr *NewMI) {
273   for (unsigned i = MI->getDesc().getNumOperands(), e = MI->getNumOperands();
274        i != e; ++i) {
275     MachineOperand &MO = MI->getOperand(i);
276     if (MO.isReg() && MO.isImplicit())
277       NewMI->addOperand(MO);
278   }
279 }
280
281 /// RemoveCopyByCommutingDef - We found a non-trivially-coalescable copy with
282 /// IntA being the source and IntB being the dest, thus this defines a value
283 /// number in IntB.  If the source value number (in IntA) is defined by a
284 /// commutable instruction and its other operand is coalesced to the copy dest
285 /// register, see if we can transform the copy into a noop by commuting the
286 /// definition. For example,
287 ///
288 ///  A3 = op A2 B0<kill>
289 ///    ...
290 ///  B1 = A3      <- this copy
291 ///    ...
292 ///     = op A3   <- more uses
293 ///
294 /// ==>
295 ///
296 ///  B2 = op B0 A2<kill>
297 ///    ...
298 ///  B1 = B2      <- now an identify copy
299 ///    ...
300 ///     = op B2   <- more uses
301 ///
302 /// This returns true if an interval was modified.
303 ///
304 bool SimpleRegisterCoalescing::RemoveCopyByCommutingDef(LiveInterval &IntA,
305                                                         LiveInterval &IntB,
306                                                         MachineInstr *CopyMI) {
307   SlotIndex CopyIdx =
308     li_->getInstructionIndex(CopyMI).getDefIndex();
309
310   // FIXME: For now, only eliminate the copy by commuting its def when the
311   // source register is a virtual register. We want to guard against cases
312   // where the copy is a back edge copy and commuting the def lengthen the
313   // live interval of the source register to the entire loop.
314   if (TargetRegisterInfo::isPhysicalRegister(IntA.reg))
315     return false;
316
317   // BValNo is a value number in B that is defined by a copy from A. 'B3' in
318   // the example above.
319   LiveInterval::iterator BLR = IntB.FindLiveRangeContaining(CopyIdx);
320   assert(BLR != IntB.end() && "Live range not found!");
321   VNInfo *BValNo = BLR->valno;
322
323   // Get the location that B is defined at.  Two options: either this value has
324   // an unknown definition point or it is defined at CopyIdx.  If unknown, we
325   // can't process it.
326   if (!BValNo->getCopy()) return false;
327   assert(BValNo->def == CopyIdx && "Copy doesn't define the value?");
328
329   // AValNo is the value number in A that defines the copy, A3 in the example.
330   LiveInterval::iterator ALR =
331     IntA.FindLiveRangeContaining(CopyIdx.getUseIndex()); // 
332
333   assert(ALR != IntA.end() && "Live range not found!");
334   VNInfo *AValNo = ALR->valno;
335   // If other defs can reach uses of this def, then it's not safe to perform
336   // the optimization. FIXME: Do isPHIDef and isDefAccurate both need to be
337   // tested?
338   if (AValNo->isPHIDef() || !AValNo->isDefAccurate() ||
339       AValNo->isUnused() || AValNo->hasPHIKill())
340     return false;
341   MachineInstr *DefMI = li_->getInstructionFromIndex(AValNo->def);
342   const TargetInstrDesc &TID = DefMI->getDesc();
343   if (!TID.isCommutable())
344     return false;
345   // If DefMI is a two-address instruction then commuting it will change the
346   // destination register.
347   int DefIdx = DefMI->findRegisterDefOperandIdx(IntA.reg);
348   assert(DefIdx != -1);
349   unsigned UseOpIdx;
350   if (!DefMI->isRegTiedToUseOperand(DefIdx, &UseOpIdx))
351     return false;
352   unsigned Op1, Op2, NewDstIdx;
353   if (!tii_->findCommutedOpIndices(DefMI, Op1, Op2))
354     return false;
355   if (Op1 == UseOpIdx)
356     NewDstIdx = Op2;
357   else if (Op2 == UseOpIdx)
358     NewDstIdx = Op1;
359   else
360     return false;
361
362   MachineOperand &NewDstMO = DefMI->getOperand(NewDstIdx);
363   unsigned NewReg = NewDstMO.getReg();
364   if (NewReg != IntB.reg || !NewDstMO.isKill())
365     return false;
366
367   // Make sure there are no other definitions of IntB that would reach the
368   // uses which the new definition can reach.
369   if (HasOtherReachingDefs(IntA, IntB, AValNo, BValNo))
370     return false;
371
372   // If some of the uses of IntA.reg is already coalesced away, return false.
373   // It's not possible to determine whether it's safe to perform the coalescing.
374   for (MachineRegisterInfo::use_nodbg_iterator UI = 
375          mri_->use_nodbg_begin(IntA.reg), 
376        UE = mri_->use_nodbg_end(); UI != UE; ++UI) {
377     MachineInstr *UseMI = &*UI;
378     SlotIndex UseIdx = li_->getInstructionIndex(UseMI);
379     LiveInterval::iterator ULR = IntA.FindLiveRangeContaining(UseIdx);
380     if (ULR == IntA.end())
381       continue;
382     if (ULR->valno == AValNo && JoinedCopies.count(UseMI))
383       return false;
384   }
385
386   // At this point we have decided that it is legal to do this
387   // transformation.  Start by commuting the instruction.
388   MachineBasicBlock *MBB = DefMI->getParent();
389   MachineInstr *NewMI = tii_->commuteInstruction(DefMI);
390   if (!NewMI)
391     return false;
392   if (NewMI != DefMI) {
393     li_->ReplaceMachineInstrInMaps(DefMI, NewMI);
394     MBB->insert(DefMI, NewMI);
395     MBB->erase(DefMI);
396   }
397   unsigned OpIdx = NewMI->findRegisterUseOperandIdx(IntA.reg, false);
398   NewMI->getOperand(OpIdx).setIsKill();
399
400   bool BHasPHIKill = BValNo->hasPHIKill();
401   SmallVector<VNInfo*, 4> BDeadValNos;
402   VNInfo::KillSet BKills;
403   std::map<SlotIndex, SlotIndex> BExtend;
404
405   // If ALR and BLR overlaps and end of BLR extends beyond end of ALR, e.g.
406   // A = or A, B
407   // ...
408   // B = A
409   // ...
410   // C = A<kill>
411   // ...
412   //   = B
413   //
414   // then do not add kills of A to the newly created B interval.
415   bool Extended = BLR->end > ALR->end && ALR->end != ALR->start;
416   if (Extended)
417     BExtend[ALR->end] = BLR->end;
418
419   // Update uses of IntA of the specific Val# with IntB.
420   bool BHasSubRegs = false;
421   if (TargetRegisterInfo::isPhysicalRegister(IntB.reg))
422     BHasSubRegs = *tri_->getSubRegisters(IntB.reg);
423   for (MachineRegisterInfo::use_iterator UI = mri_->use_begin(IntA.reg),
424          UE = mri_->use_end(); UI != UE;) {
425     MachineOperand &UseMO = UI.getOperand();
426     MachineInstr *UseMI = &*UI;
427     ++UI;
428     if (JoinedCopies.count(UseMI))
429       continue;
430     if (UseMI->isDebugValue()) {
431       // FIXME These don't have an instruction index.  Not clear we have enough
432       // info to decide whether to do this replacement or not.  For now do it.
433       UseMO.setReg(NewReg);
434       continue;
435     }
436     SlotIndex UseIdx = li_->getInstructionIndex(UseMI).getUseIndex();
437     LiveInterval::iterator ULR = IntA.FindLiveRangeContaining(UseIdx);
438     if (ULR == IntA.end() || ULR->valno != AValNo)
439       continue;
440     UseMO.setReg(NewReg);
441     if (UseMI == CopyMI)
442       continue;
443     if (UseMO.isKill()) {
444       if (Extended)
445         UseMO.setIsKill(false);
446       else
447         BKills.push_back(UseIdx.getDefIndex());
448     }
449     unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
450     if (!tii_->isMoveInstr(*UseMI, SrcReg, DstReg, SrcSubIdx, DstSubIdx))
451       continue;
452     if (DstReg == IntB.reg) {
453       // This copy will become a noop. If it's defining a new val#,
454       // remove that val# as well. However this live range is being
455       // extended to the end of the existing live range defined by the copy.
456       SlotIndex DefIdx = UseIdx.getDefIndex();
457       const LiveRange *DLR = IntB.getLiveRangeContaining(DefIdx);
458       BHasPHIKill |= DLR->valno->hasPHIKill();
459       assert(DLR->valno->def == DefIdx);
460       BDeadValNos.push_back(DLR->valno);
461       BExtend[DLR->start] = DLR->end;
462       JoinedCopies.insert(UseMI);
463       // If this is a kill but it's going to be removed, the last use
464       // of the same val# is the new kill.
465       if (UseMO.isKill())
466         BKills.pop_back();
467     }
468   }
469
470   // We need to insert a new liverange: [ALR.start, LastUse). It may be we can
471   // simply extend BLR if CopyMI doesn't end the range.
472   DEBUG({
473       dbgs() << "\nExtending: ";
474       IntB.print(dbgs(), tri_);
475     });
476
477   // Remove val#'s defined by copies that will be coalesced away.
478   for (unsigned i = 0, e = BDeadValNos.size(); i != e; ++i) {
479     VNInfo *DeadVNI = BDeadValNos[i];
480     if (BHasSubRegs) {
481       for (const unsigned *SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR) {
482         LiveInterval &SRLI = li_->getInterval(*SR);
483         const LiveRange *SRLR = SRLI.getLiveRangeContaining(DeadVNI->def);
484         SRLI.removeValNo(SRLR->valno);
485       }
486     }
487     IntB.removeValNo(BDeadValNos[i]);
488   }
489
490   // Extend BValNo by merging in IntA live ranges of AValNo. Val# definition
491   // is updated. Kills are also updated.
492   VNInfo *ValNo = BValNo;
493   ValNo->def = AValNo->def;
494   ValNo->setCopy(0);
495   for (unsigned j = 0, ee = ValNo->kills.size(); j != ee; ++j) {
496     if (ValNo->kills[j] != BLR->end)
497       BKills.push_back(ValNo->kills[j]);
498   }
499   ValNo->kills.clear();
500   for (LiveInterval::iterator AI = IntA.begin(), AE = IntA.end();
501        AI != AE; ++AI) {
502     if (AI->valno != AValNo) continue;
503     SlotIndex End = AI->end;
504     std::map<SlotIndex, SlotIndex>::iterator
505       EI = BExtend.find(End);
506     if (EI != BExtend.end())
507       End = EI->second;
508     IntB.addRange(LiveRange(AI->start, End, ValNo));
509
510     // If the IntB live range is assigned to a physical register, and if that
511     // physreg has sub-registers, update their live intervals as well.
512     if (BHasSubRegs) {
513       for (const unsigned *SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR) {
514         LiveInterval &SRLI = li_->getInterval(*SR);
515         SRLI.MergeInClobberRange(*li_, AI->start, End,
516                                  li_->getVNInfoAllocator());
517       }
518     }
519   }
520   IntB.addKills(ValNo, BKills);
521   ValNo->setHasPHIKill(BHasPHIKill);
522
523   DEBUG({
524       dbgs() << "   result = ";
525       IntB.print(dbgs(), tri_);
526       dbgs() << '\n';
527       dbgs() << "\nShortening: ";
528       IntA.print(dbgs(), tri_);
529     });
530
531   IntA.removeValNo(AValNo);
532
533   DEBUG({
534       dbgs() << "   result = ";
535       IntA.print(dbgs(), tri_);
536       dbgs() << '\n';
537     });
538
539   ++numCommutes;
540   return true;
541 }
542
543 /// isSameOrFallThroughBB - Return true if MBB == SuccMBB or MBB simply
544 /// fallthoughs to SuccMBB.
545 static bool isSameOrFallThroughBB(MachineBasicBlock *MBB,
546                                   MachineBasicBlock *SuccMBB,
547                                   const TargetInstrInfo *tii_) {
548   if (MBB == SuccMBB)
549     return true;
550   MachineBasicBlock *TBB = 0, *FBB = 0;
551   SmallVector<MachineOperand, 4> Cond;
552   return !tii_->AnalyzeBranch(*MBB, TBB, FBB, Cond) && !TBB && !FBB &&
553     MBB->isSuccessor(SuccMBB);
554 }
555
556 /// removeRange - Wrapper for LiveInterval::removeRange. This removes a range
557 /// from a physical register live interval as well as from the live intervals
558 /// of its sub-registers.
559 static void removeRange(LiveInterval &li,
560                         SlotIndex Start, SlotIndex End,
561                         LiveIntervals *li_, const TargetRegisterInfo *tri_) {
562   li.removeRange(Start, End, true);
563   if (TargetRegisterInfo::isPhysicalRegister(li.reg)) {
564     for (const unsigned* SR = tri_->getSubRegisters(li.reg); *SR; ++SR) {
565       if (!li_->hasInterval(*SR))
566         continue;
567       LiveInterval &sli = li_->getInterval(*SR);
568       SlotIndex RemoveStart = Start;
569       SlotIndex RemoveEnd = Start;
570
571       while (RemoveEnd != End) {
572         LiveInterval::iterator LR = sli.FindLiveRangeContaining(RemoveStart);
573         if (LR == sli.end())
574           break;
575         RemoveEnd = (LR->end < End) ? LR->end : End;
576         sli.removeRange(RemoveStart, RemoveEnd, true);
577         RemoveStart = RemoveEnd;
578       }
579     }
580   }
581 }
582
583 /// TrimLiveIntervalToLastUse - If there is a last use in the same basic block
584 /// as the copy instruction, trim the live interval to the last use and return
585 /// true.
586 bool
587 SimpleRegisterCoalescing::TrimLiveIntervalToLastUse(SlotIndex CopyIdx,
588                                                     MachineBasicBlock *CopyMBB,
589                                                     LiveInterval &li,
590                                                     const LiveRange *LR) {
591   SlotIndex MBBStart = li_->getMBBStartIdx(CopyMBB);
592   SlotIndex LastUseIdx;
593   MachineOperand *LastUse =
594     lastRegisterUse(LR->start, CopyIdx.getPrevSlot(), li.reg, LastUseIdx);
595   if (LastUse) {
596     MachineInstr *LastUseMI = LastUse->getParent();
597     if (!isSameOrFallThroughBB(LastUseMI->getParent(), CopyMBB, tii_)) {
598       // r1024 = op
599       // ...
600       // BB1:
601       //       = r1024
602       //
603       // BB2:
604       // r1025<dead> = r1024<kill>
605       if (MBBStart < LR->end)
606         removeRange(li, MBBStart, LR->end, li_, tri_);
607       return true;
608     }
609
610     // There are uses before the copy, just shorten the live range to the end
611     // of last use.
612     LastUse->setIsKill();
613     removeRange(li, LastUseIdx.getDefIndex(), LR->end, li_, tri_);
614     LR->valno->addKill(LastUseIdx.getDefIndex());
615     unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
616     if (tii_->isMoveInstr(*LastUseMI, SrcReg, DstReg, SrcSubIdx, DstSubIdx) &&
617         DstReg == li.reg) {
618       // Last use is itself an identity code.
619       int DeadIdx = LastUseMI->findRegisterDefOperandIdx(li.reg, false, tri_);
620       LastUseMI->getOperand(DeadIdx).setIsDead();
621     }
622     return true;
623   }
624
625   // Is it livein?
626   if (LR->start <= MBBStart && LR->end > MBBStart) {
627     if (LR->start == li_->getZeroIndex()) {
628       assert(TargetRegisterInfo::isPhysicalRegister(li.reg));
629       // Live-in to the function but dead. Remove it from entry live-in set.
630       mf_->begin()->removeLiveIn(li.reg);
631     }
632     // FIXME: Shorten intervals in BBs that reaches this BB.
633   }
634
635   return false;
636 }
637
638 /// ReMaterializeTrivialDef - If the source of a copy is defined by a trivial
639 /// computation, replace the copy by rematerialize the definition.
640 bool SimpleRegisterCoalescing::ReMaterializeTrivialDef(LiveInterval &SrcInt,
641                                                        unsigned DstReg,
642                                                        unsigned DstSubIdx,
643                                                        MachineInstr *CopyMI) {
644   SlotIndex CopyIdx = li_->getInstructionIndex(CopyMI).getUseIndex();
645   LiveInterval::iterator SrcLR = SrcInt.FindLiveRangeContaining(CopyIdx);
646   assert(SrcLR != SrcInt.end() && "Live range not found!");
647   VNInfo *ValNo = SrcLR->valno;
648   // If other defs can reach uses of this def, then it's not safe to perform
649   // the optimization. FIXME: Do isPHIDef and isDefAccurate both need to be
650   // tested?
651   if (ValNo->isPHIDef() || !ValNo->isDefAccurate() ||
652       ValNo->isUnused() || ValNo->hasPHIKill())
653     return false;
654   MachineInstr *DefMI = li_->getInstructionFromIndex(ValNo->def);
655   const TargetInstrDesc &TID = DefMI->getDesc();
656   if (!TID.isAsCheapAsAMove())
657     return false;
658   if (!tii_->isTriviallyReMaterializable(DefMI, AA))
659     return false;
660   bool SawStore = false;
661   if (!DefMI->isSafeToMove(tii_, AA, SawStore))
662     return false;
663   if (TID.getNumDefs() != 1)
664     return false;
665   if (!DefMI->isImplicitDef()) {
666     // Make sure the copy destination register class fits the instruction
667     // definition register class. The mismatch can happen as a result of earlier
668     // extract_subreg, insert_subreg, subreg_to_reg coalescing.
669     const TargetRegisterClass *RC = TID.OpInfo[0].getRegClass(tri_);
670     if (TargetRegisterInfo::isVirtualRegister(DstReg)) {
671       if (mri_->getRegClass(DstReg) != RC)
672         return false;
673     } else if (!RC->contains(DstReg))
674       return false;
675   }
676
677   // If destination register has a sub-register index on it, make sure it mtches
678   // the instruction register class.
679   if (DstSubIdx) {
680     const TargetInstrDesc &TID = DefMI->getDesc();
681     if (TID.getNumDefs() != 1)
682       return false;
683     const TargetRegisterClass *DstRC = mri_->getRegClass(DstReg);
684     const TargetRegisterClass *DstSubRC =
685       DstRC->getSubRegisterRegClass(DstSubIdx);
686     const TargetRegisterClass *DefRC = TID.OpInfo[0].getRegClass(tri_);
687     if (DefRC == DstRC)
688       DstSubIdx = 0;
689     else if (DefRC != DstSubRC)
690       return false;
691   }
692
693   SlotIndex DefIdx = CopyIdx.getDefIndex();
694   const LiveRange *DLR= li_->getInterval(DstReg).getLiveRangeContaining(DefIdx);
695   DLR->valno->setCopy(0);
696   // Don't forget to update sub-register intervals.
697   if (TargetRegisterInfo::isPhysicalRegister(DstReg)) {
698     for (const unsigned* SR = tri_->getSubRegisters(DstReg); *SR; ++SR) {
699       if (!li_->hasInterval(*SR))
700         continue;
701       const LiveRange *DLR =
702           li_->getInterval(*SR).getLiveRangeContaining(DefIdx);
703       if (DLR && DLR->valno->getCopy() == CopyMI)
704         DLR->valno->setCopy(0);
705     }
706   }
707
708   // If copy kills the source register, find the last use and propagate
709   // kill.
710   bool checkForDeadDef = false;
711   MachineBasicBlock *MBB = CopyMI->getParent();
712   if (CopyMI->killsRegister(SrcInt.reg))
713     if (!TrimLiveIntervalToLastUse(CopyIdx, MBB, SrcInt, SrcLR)) {
714       checkForDeadDef = true;
715     }
716
717   MachineBasicBlock::iterator MII =
718     llvm::next(MachineBasicBlock::iterator(CopyMI));
719   tii_->reMaterialize(*MBB, MII, DstReg, DstSubIdx, DefMI, tri_);
720   MachineInstr *NewMI = prior(MII);
721
722   if (checkForDeadDef) {
723     // PR4090 fix: Trim interval failed because there was no use of the
724     // source interval in this MBB. If the def is in this MBB too then we
725     // should mark it dead:
726     if (DefMI->getParent() == MBB) {
727       DefMI->addRegisterDead(SrcInt.reg, tri_);
728       SrcLR->end = SrcLR->start.getNextSlot();
729     }
730   }
731
732   // CopyMI may have implicit operands, transfer them over to the newly
733   // rematerialized instruction. And update implicit def interval valnos.
734   for (unsigned i = CopyMI->getDesc().getNumOperands(),
735          e = CopyMI->getNumOperands(); i != e; ++i) {
736     MachineOperand &MO = CopyMI->getOperand(i);
737     if (MO.isReg() && MO.isImplicit())
738       NewMI->addOperand(MO);
739     if (MO.isDef() && li_->hasInterval(MO.getReg())) {
740       unsigned Reg = MO.getReg();
741       const LiveRange *DLR =
742           li_->getInterval(Reg).getLiveRangeContaining(DefIdx);
743       if (DLR && DLR->valno->getCopy() == CopyMI)
744         DLR->valno->setCopy(0);
745       // Handle subregs as well
746       if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
747         for (const unsigned* SR = tri_->getSubRegisters(Reg); *SR; ++SR) {
748           if (!li_->hasInterval(*SR))
749             continue;
750           const LiveRange *DLR =
751               li_->getInterval(*SR).getLiveRangeContaining(DefIdx);
752           if (DLR && DLR->valno->getCopy() == CopyMI)
753             DLR->valno->setCopy(0);
754         }
755       }
756     }
757   }
758
759   TransferImplicitOps(CopyMI, NewMI);
760   li_->ReplaceMachineInstrInMaps(CopyMI, NewMI);
761   CopyMI->eraseFromParent();
762   ReMatCopies.insert(CopyMI);
763   ReMatDefs.insert(DefMI);
764   DEBUG(dbgs() << "Remat: " << *NewMI);
765   ++NumReMats;
766   return true;
767 }
768
769 /// UpdateRegDefsUses - Replace all defs and uses of SrcReg to DstReg and
770 /// update the subregister number if it is not zero. If DstReg is a
771 /// physical register and the existing subregister number of the def / use
772 /// being updated is not zero, make sure to set it to the correct physical
773 /// subregister.
774 void
775 SimpleRegisterCoalescing::UpdateRegDefsUses(unsigned SrcReg, unsigned DstReg,
776                                             unsigned SubIdx) {
777   bool DstIsPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
778   if (DstIsPhys && SubIdx) {
779     // Figure out the real physical register we are updating with.
780     DstReg = tri_->getSubReg(DstReg, SubIdx);
781     SubIdx = 0;
782   }
783
784   // Copy the register use-list before traversing it. We may be adding operands
785   // and invalidating pointers.
786   SmallVector<std::pair<MachineInstr*, unsigned>, 32> reglist;
787   for (MachineRegisterInfo::reg_iterator I = mri_->reg_begin(SrcReg),
788          E = mri_->reg_end(); I != E; ++I)
789     reglist.push_back(std::make_pair(&*I, I.getOperandNo()));
790
791   for (unsigned N=0; N != reglist.size(); ++N) {
792     MachineInstr *UseMI = reglist[N].first;
793     MachineOperand &O = UseMI->getOperand(reglist[N].second);
794     unsigned OldSubIdx = O.getSubReg();
795     if (DstIsPhys) {
796       unsigned UseDstReg = DstReg;
797       if (OldSubIdx)
798           UseDstReg = tri_->getSubReg(DstReg, OldSubIdx);
799
800       unsigned CopySrcReg, CopyDstReg, CopySrcSubIdx, CopyDstSubIdx;
801       if (tii_->isMoveInstr(*UseMI, CopySrcReg, CopyDstReg,
802                             CopySrcSubIdx, CopyDstSubIdx) &&
803           CopySrcReg != CopyDstReg &&
804           CopySrcReg == SrcReg && CopyDstReg != UseDstReg) {
805         // If the use is a copy and it won't be coalesced away, and its source
806         // is defined by a trivial computation, try to rematerialize it instead.
807         if (ReMaterializeTrivialDef(li_->getInterval(SrcReg), CopyDstReg,
808                                     CopyDstSubIdx, UseMI))
809           continue;
810       }
811
812       O.setReg(UseDstReg);
813       O.setSubReg(0);
814       if (OldSubIdx) {
815         // Def and kill of subregister of a virtual register actually defs and
816         // kills the whole register. Add imp-defs and imp-kills as needed.
817         if (O.isDef()) {
818           if(O.isDead())
819             UseMI->addRegisterDead(DstReg, tri_, true);
820           else
821             UseMI->addRegisterDefined(DstReg, tri_);
822         } else if (!O.isUndef() &&
823                    (O.isKill() ||
824                     UseMI->isRegTiedToDefOperand(&O-&UseMI->getOperand(0))))
825           UseMI->addRegisterKilled(DstReg, tri_, true);
826       }
827       continue;
828     }
829
830     // Sub-register indexes goes from small to large. e.g.
831     // RAX: 1 -> AL, 2 -> AX, 3 -> EAX
832     // EAX: 1 -> AL, 2 -> AX
833     // So RAX's sub-register 2 is AX, RAX's sub-regsiter 3 is EAX, whose
834     // sub-register 2 is also AX.
835     if (SubIdx && OldSubIdx && SubIdx != OldSubIdx)
836       assert(OldSubIdx < SubIdx && "Conflicting sub-register index!");
837     else if (SubIdx)
838       O.setSubReg(SubIdx);
839     // Remove would-be duplicated kill marker.
840     if (O.isKill() && UseMI->killsRegister(DstReg))
841       O.setIsKill(false);
842     O.setReg(DstReg);
843
844     // After updating the operand, check if the machine instruction has
845     // become a copy. If so, update its val# information.
846     if (JoinedCopies.count(UseMI))
847       continue;
848
849     const TargetInstrDesc &TID = UseMI->getDesc();
850     unsigned CopySrcReg, CopyDstReg, CopySrcSubIdx, CopyDstSubIdx;
851     if (TID.getNumDefs() == 1 && TID.getNumOperands() > 2 &&
852         tii_->isMoveInstr(*UseMI, CopySrcReg, CopyDstReg,
853                           CopySrcSubIdx, CopyDstSubIdx) &&
854         CopySrcReg != CopyDstReg &&
855         (TargetRegisterInfo::isVirtualRegister(CopyDstReg) ||
856          allocatableRegs_[CopyDstReg])) {
857       LiveInterval &LI = li_->getInterval(CopyDstReg);
858       SlotIndex DefIdx =
859         li_->getInstructionIndex(UseMI).getDefIndex();
860       if (const LiveRange *DLR = LI.getLiveRangeContaining(DefIdx)) {
861         if (DLR->valno->def == DefIdx)
862           DLR->valno->setCopy(UseMI);
863       }
864     }
865   }
866 }
867
868 /// RemoveUnnecessaryKills - Remove kill markers that are no longer accurate
869 /// due to live range lengthening as the result of coalescing.
870 void SimpleRegisterCoalescing::RemoveUnnecessaryKills(unsigned Reg,
871                                                       LiveInterval &LI) {
872   for (MachineRegisterInfo::use_iterator UI = mri_->use_begin(Reg),
873          UE = mri_->use_end(); UI != UE; ++UI) {
874     MachineOperand &UseMO = UI.getOperand();
875     if (!UseMO.isKill())
876       continue;
877     MachineInstr *UseMI = UseMO.getParent();
878     SlotIndex UseIdx =
879       li_->getInstructionIndex(UseMI).getUseIndex();
880     const LiveRange *LR = LI.getLiveRangeContaining(UseIdx);
881     if (!LR ||
882         (!LR->valno->isKill(UseIdx.getDefIndex()) &&
883          LR->valno->def != UseIdx.getDefIndex())) {
884       // Interesting problem. After coalescing reg1027's def and kill are both
885       // at the same point:  %reg1027,0.000000e+00 = [56,814:0)  0@70-(814)
886       //
887       // bb5:
888       // 60   %reg1027<def> = t2MOVr %reg1027, 14, %reg0, %reg0
889       // 68   %reg1027<def> = t2LDRi12 %reg1027<kill>, 8, 14, %reg0
890       // 76   t2CMPzri %reg1038<kill,undef>, 0, 14, %reg0, %CPSR<imp-def>
891       // 84   %reg1027<def> = t2MOVr %reg1027, 14, %reg0, %reg0
892       // 96   t2Bcc mbb<bb5,0x2030910>, 1, %CPSR<kill>
893       //
894       // Do not remove the kill marker on t2LDRi12.
895       UseMO.setIsKill(false);
896     }
897   }
898 }
899
900 /// removeIntervalIfEmpty - Check if the live interval of a physical register
901 /// is empty, if so remove it and also remove the empty intervals of its
902 /// sub-registers. Return true if live interval is removed.
903 static bool removeIntervalIfEmpty(LiveInterval &li, LiveIntervals *li_,
904                                   const TargetRegisterInfo *tri_) {
905   if (li.empty()) {
906     if (TargetRegisterInfo::isPhysicalRegister(li.reg))
907       for (const unsigned* SR = tri_->getSubRegisters(li.reg); *SR; ++SR) {
908         if (!li_->hasInterval(*SR))
909           continue;
910         LiveInterval &sli = li_->getInterval(*SR);
911         if (sli.empty())
912           li_->removeInterval(*SR);
913       }
914     li_->removeInterval(li.reg);
915     return true;
916   }
917   return false;
918 }
919
920 /// ShortenDeadCopyLiveRange - Shorten a live range defined by a dead copy.
921 /// Return true if live interval is removed.
922 bool SimpleRegisterCoalescing::ShortenDeadCopyLiveRange(LiveInterval &li,
923                                                         MachineInstr *CopyMI) {
924   SlotIndex CopyIdx = li_->getInstructionIndex(CopyMI);
925   LiveInterval::iterator MLR =
926     li.FindLiveRangeContaining(CopyIdx.getDefIndex());
927   if (MLR == li.end())
928     return false;  // Already removed by ShortenDeadCopySrcLiveRange.
929   SlotIndex RemoveStart = MLR->start;
930   SlotIndex RemoveEnd = MLR->end;
931   SlotIndex DefIdx = CopyIdx.getDefIndex();
932   // Remove the liverange that's defined by this.
933   if (RemoveStart == DefIdx && RemoveEnd == DefIdx.getStoreIndex()) {
934     removeRange(li, RemoveStart, RemoveEnd, li_, tri_);
935     return removeIntervalIfEmpty(li, li_, tri_);
936   }
937   return false;
938 }
939
940 /// RemoveDeadDef - If a def of a live interval is now determined dead, remove
941 /// the val# it defines. If the live interval becomes empty, remove it as well.
942 bool SimpleRegisterCoalescing::RemoveDeadDef(LiveInterval &li,
943                                              MachineInstr *DefMI) {
944   SlotIndex DefIdx = li_->getInstructionIndex(DefMI).getDefIndex();
945   LiveInterval::iterator MLR = li.FindLiveRangeContaining(DefIdx);
946   if (DefIdx != MLR->valno->def)
947     return false;
948   li.removeValNo(MLR->valno);
949   return removeIntervalIfEmpty(li, li_, tri_);
950 }
951
952 /// PropagateDeadness - Propagate the dead marker to the instruction which
953 /// defines the val#.
954 static void PropagateDeadness(LiveInterval &li, MachineInstr *CopyMI,
955                               SlotIndex &LRStart, LiveIntervals *li_,
956                               const TargetRegisterInfo* tri_) {
957   MachineInstr *DefMI =
958     li_->getInstructionFromIndex(LRStart.getDefIndex());
959   if (DefMI && DefMI != CopyMI) {
960     int DeadIdx = DefMI->findRegisterDefOperandIdx(li.reg, false);
961     if (DeadIdx != -1)
962       DefMI->getOperand(DeadIdx).setIsDead();
963     else
964       DefMI->addOperand(MachineOperand::CreateReg(li.reg,
965                    /*def*/true, /*implicit*/true, /*kill*/false, /*dead*/true));
966     LRStart = LRStart.getNextSlot();
967   }
968 }
969
970 /// ShortenDeadCopySrcLiveRange - Shorten a live range as it's artificially
971 /// extended by a dead copy. Mark the last use (if any) of the val# as kill as
972 /// ends the live range there. If there isn't another use, then this live range
973 /// is dead. Return true if live interval is removed.
974 bool
975 SimpleRegisterCoalescing::ShortenDeadCopySrcLiveRange(LiveInterval &li,
976                                                       MachineInstr *CopyMI) {
977   SlotIndex CopyIdx = li_->getInstructionIndex(CopyMI);
978   if (CopyIdx == SlotIndex()) {
979     // FIXME: special case: function live in. It can be a general case if the
980     // first instruction index starts at > 0 value.
981     assert(TargetRegisterInfo::isPhysicalRegister(li.reg));
982     // Live-in to the function but dead. Remove it from entry live-in set.
983     if (mf_->begin()->isLiveIn(li.reg))
984       mf_->begin()->removeLiveIn(li.reg);
985     const LiveRange *LR = li.getLiveRangeContaining(CopyIdx);
986     removeRange(li, LR->start, LR->end, li_, tri_);
987     return removeIntervalIfEmpty(li, li_, tri_);
988   }
989
990   LiveInterval::iterator LR =
991     li.FindLiveRangeContaining(CopyIdx.getPrevIndex().getStoreIndex());
992   if (LR == li.end())
993     // Livein but defined by a phi.
994     return false;
995
996   SlotIndex RemoveStart = LR->start;
997   SlotIndex RemoveEnd = CopyIdx.getStoreIndex();
998   if (LR->end > RemoveEnd)
999     // More uses past this copy? Nothing to do.
1000     return false;
1001
1002   // If there is a last use in the same bb, we can't remove the live range.
1003   // Shorten the live interval and return.
1004   MachineBasicBlock *CopyMBB = CopyMI->getParent();
1005   if (TrimLiveIntervalToLastUse(CopyIdx, CopyMBB, li, LR))
1006     return false;
1007
1008   // There are other kills of the val#. Nothing to do.
1009   if (!li.isOnlyLROfValNo(LR))
1010     return false;
1011
1012   MachineBasicBlock *StartMBB = li_->getMBBFromIndex(RemoveStart);
1013   if (!isSameOrFallThroughBB(StartMBB, CopyMBB, tii_))
1014     // If the live range starts in another mbb and the copy mbb is not a fall
1015     // through mbb, then we can only cut the range from the beginning of the
1016     // copy mbb.
1017     RemoveStart = li_->getMBBStartIdx(CopyMBB).getNextIndex().getBaseIndex();
1018
1019   if (LR->valno->def == RemoveStart) {
1020     // If the def MI defines the val# and this copy is the only kill of the
1021     // val#, then propagate the dead marker.
1022     PropagateDeadness(li, CopyMI, RemoveStart, li_, tri_);
1023     ++numDeadValNo;
1024
1025     if (LR->valno->isKill(RemoveEnd))
1026       LR->valno->removeKill(RemoveEnd);
1027   }
1028
1029   removeRange(li, RemoveStart, RemoveEnd, li_, tri_);
1030   return removeIntervalIfEmpty(li, li_, tri_);
1031 }
1032
1033 /// CanCoalesceWithImpDef - Returns true if the specified copy instruction
1034 /// from an implicit def to another register can be coalesced away.
1035 bool SimpleRegisterCoalescing::CanCoalesceWithImpDef(MachineInstr *CopyMI,
1036                                                      LiveInterval &li,
1037                                                      LiveInterval &ImpLi) const{
1038   if (!CopyMI->killsRegister(ImpLi.reg))
1039     return false;
1040   // Make sure this is the only use.
1041   for (MachineRegisterInfo::use_iterator UI = mri_->use_begin(ImpLi.reg),
1042          UE = mri_->use_end(); UI != UE;) {
1043     MachineInstr *UseMI = &*UI;
1044     ++UI;
1045     if (CopyMI == UseMI || JoinedCopies.count(UseMI))
1046       continue;
1047     return false;
1048   }
1049   return true;
1050 }
1051
1052
1053 /// isWinToJoinVRWithSrcPhysReg - Return true if it's worth while to join a
1054 /// a virtual destination register with physical source register.
1055 bool
1056 SimpleRegisterCoalescing::isWinToJoinVRWithSrcPhysReg(MachineInstr *CopyMI,
1057                                                      MachineBasicBlock *CopyMBB,
1058                                                      LiveInterval &DstInt,
1059                                                      LiveInterval &SrcInt) {
1060   // If the virtual register live interval is long but it has low use desity,
1061   // do not join them, instead mark the physical register as its allocation
1062   // preference.
1063   const TargetRegisterClass *RC = mri_->getRegClass(DstInt.reg);
1064   unsigned Threshold = allocatableRCRegs_[RC].count() * 2;
1065   unsigned Length = li_->getApproximateInstructionCount(DstInt);
1066   if (Length > Threshold &&
1067       (((float)std::distance(mri_->use_nodbg_begin(DstInt.reg),
1068                              mri_->use_nodbg_end()) / Length) < 
1069         (1.0 / Threshold)))
1070     return false;
1071
1072   // If the virtual register live interval extends into a loop, turn down
1073   // aggressiveness.
1074   SlotIndex CopyIdx =
1075     li_->getInstructionIndex(CopyMI).getDefIndex();
1076   const MachineLoop *L = loopInfo->getLoopFor(CopyMBB);
1077   if (!L) {
1078     // Let's see if the virtual register live interval extends into the loop.
1079     LiveInterval::iterator DLR = DstInt.FindLiveRangeContaining(CopyIdx);
1080     assert(DLR != DstInt.end() && "Live range not found!");
1081     DLR = DstInt.FindLiveRangeContaining(DLR->end.getNextSlot());
1082     if (DLR != DstInt.end()) {
1083       CopyMBB = li_->getMBBFromIndex(DLR->start);
1084       L = loopInfo->getLoopFor(CopyMBB);
1085     }
1086   }
1087
1088   if (!L || Length <= Threshold)
1089     return true;
1090
1091   SlotIndex UseIdx = CopyIdx.getUseIndex();
1092   LiveInterval::iterator SLR = SrcInt.FindLiveRangeContaining(UseIdx);
1093   MachineBasicBlock *SMBB = li_->getMBBFromIndex(SLR->start);
1094   if (loopInfo->getLoopFor(SMBB) != L) {
1095     if (!loopInfo->isLoopHeader(CopyMBB))
1096       return false;
1097     // If vr's live interval extends pass the loop header, do not join.
1098     for (MachineBasicBlock::succ_iterator SI = CopyMBB->succ_begin(),
1099            SE = CopyMBB->succ_end(); SI != SE; ++SI) {
1100       MachineBasicBlock *SuccMBB = *SI;
1101       if (SuccMBB == CopyMBB)
1102         continue;
1103       if (DstInt.overlaps(li_->getMBBStartIdx(SuccMBB),
1104                           li_->getMBBEndIdx(SuccMBB)))
1105         return false;
1106     }
1107   }
1108   return true;
1109 }
1110
1111 /// isWinToJoinVRWithDstPhysReg - Return true if it's worth while to join a
1112 /// copy from a virtual source register to a physical destination register.
1113 bool
1114 SimpleRegisterCoalescing::isWinToJoinVRWithDstPhysReg(MachineInstr *CopyMI,
1115                                                      MachineBasicBlock *CopyMBB,
1116                                                      LiveInterval &DstInt,
1117                                                      LiveInterval &SrcInt) {
1118   // If the virtual register live interval is long but it has low use density,
1119   // do not join them, instead mark the physical register as its allocation
1120   // preference.
1121   const TargetRegisterClass *RC = mri_->getRegClass(SrcInt.reg);
1122   unsigned Threshold = allocatableRCRegs_[RC].count() * 2;
1123   unsigned Length = li_->getApproximateInstructionCount(SrcInt);
1124   if (Length > Threshold &&
1125       (((float)std::distance(mri_->use_nodbg_begin(SrcInt.reg),
1126                              mri_->use_nodbg_end()) / Length) < 
1127           (1.0 / Threshold)))
1128     return false;
1129
1130   if (SrcInt.empty())
1131     // Must be implicit_def.
1132     return false;
1133
1134   // If the virtual register live interval is defined or cross a loop, turn
1135   // down aggressiveness.
1136   SlotIndex CopyIdx =
1137     li_->getInstructionIndex(CopyMI).getDefIndex();
1138   SlotIndex UseIdx = CopyIdx.getUseIndex();
1139   LiveInterval::iterator SLR = SrcInt.FindLiveRangeContaining(UseIdx);
1140   assert(SLR != SrcInt.end() && "Live range not found!");
1141   SLR = SrcInt.FindLiveRangeContaining(SLR->start.getPrevSlot());
1142   if (SLR == SrcInt.end())
1143     return true;
1144   MachineBasicBlock *SMBB = li_->getMBBFromIndex(SLR->start);
1145   const MachineLoop *L = loopInfo->getLoopFor(SMBB);
1146
1147   if (!L || Length <= Threshold)
1148     return true;
1149
1150   if (loopInfo->getLoopFor(CopyMBB) != L) {
1151     if (SMBB != L->getLoopLatch())
1152       return false;
1153     // If vr's live interval is extended from before the loop latch, do not
1154     // join.
1155     for (MachineBasicBlock::pred_iterator PI = SMBB->pred_begin(),
1156            PE = SMBB->pred_end(); PI != PE; ++PI) {
1157       MachineBasicBlock *PredMBB = *PI;
1158       if (PredMBB == SMBB)
1159         continue;
1160       if (SrcInt.overlaps(li_->getMBBStartIdx(PredMBB),
1161                           li_->getMBBEndIdx(PredMBB)))
1162         return false;
1163     }
1164   }
1165   return true;
1166 }
1167
1168 /// isWinToJoinCrossClass - Return true if it's profitable to coalesce
1169 /// two virtual registers from different register classes.
1170 bool
1171 SimpleRegisterCoalescing::isWinToJoinCrossClass(unsigned LargeReg,
1172                                                 unsigned SmallReg,
1173                                                 unsigned Threshold) {
1174   // Then make sure the intervals are *short*.
1175   LiveInterval &LargeInt = li_->getInterval(LargeReg);
1176   LiveInterval &SmallInt = li_->getInterval(SmallReg);
1177   unsigned LargeSize = li_->getApproximateInstructionCount(LargeInt);
1178   unsigned SmallSize = li_->getApproximateInstructionCount(SmallInt);
1179   if (LargeSize > Threshold) {
1180     unsigned SmallUses = std::distance(mri_->use_nodbg_begin(SmallReg),
1181                                        mri_->use_nodbg_end());
1182     unsigned LargeUses = std::distance(mri_->use_nodbg_begin(LargeReg),
1183                                        mri_->use_nodbg_end());
1184     if (SmallUses*LargeSize < LargeUses*SmallSize)
1185       return false;
1186   }
1187   return true;
1188 }
1189
1190 /// HasIncompatibleSubRegDefUse - If we are trying to coalesce a virtual
1191 /// register with a physical register, check if any of the virtual register
1192 /// operand is a sub-register use or def. If so, make sure it won't result
1193 /// in an illegal extract_subreg or insert_subreg instruction. e.g.
1194 /// vr1024 = extract_subreg vr1025, 1
1195 /// ...
1196 /// vr1024 = mov8rr AH
1197 /// If vr1024 is coalesced with AH, the extract_subreg is now illegal since
1198 /// AH does not have a super-reg whose sub-register 1 is AH.
1199 bool
1200 SimpleRegisterCoalescing::HasIncompatibleSubRegDefUse(MachineInstr *CopyMI,
1201                                                       unsigned VirtReg,
1202                                                       unsigned PhysReg) {
1203   for (MachineRegisterInfo::reg_iterator I = mri_->reg_begin(VirtReg),
1204          E = mri_->reg_end(); I != E; ++I) {
1205     MachineOperand &O = I.getOperand();
1206     if (O.isDebug())
1207       continue;
1208     MachineInstr *MI = &*I;
1209     if (MI == CopyMI || JoinedCopies.count(MI))
1210       continue;
1211     unsigned SubIdx = O.getSubReg();
1212     if (SubIdx && !tri_->getSubReg(PhysReg, SubIdx))
1213       return true;
1214     if (MI->isExtractSubreg()) {
1215       SubIdx = MI->getOperand(2).getImm();
1216       if (O.isUse() && !tri_->getSubReg(PhysReg, SubIdx))
1217         return true;
1218       if (O.isDef()) {
1219         unsigned SrcReg = MI->getOperand(1).getReg();
1220         const TargetRegisterClass *RC =
1221           TargetRegisterInfo::isPhysicalRegister(SrcReg)
1222           ? tri_->getPhysicalRegisterRegClass(SrcReg)
1223           : mri_->getRegClass(SrcReg);
1224         if (!tri_->getMatchingSuperReg(PhysReg, SubIdx, RC))
1225           return true;
1226       }
1227     }
1228     if (MI->isInsertSubreg() || MI->isSubregToReg()) {
1229       SubIdx = MI->getOperand(3).getImm();
1230       if (VirtReg == MI->getOperand(0).getReg()) {
1231         if (!tri_->getSubReg(PhysReg, SubIdx))
1232           return true;
1233       } else {
1234         unsigned DstReg = MI->getOperand(0).getReg();
1235         const TargetRegisterClass *RC =
1236           TargetRegisterInfo::isPhysicalRegister(DstReg)
1237           ? tri_->getPhysicalRegisterRegClass(DstReg)
1238           : mri_->getRegClass(DstReg);
1239         if (!tri_->getMatchingSuperReg(PhysReg, SubIdx, RC))
1240           return true;
1241       }
1242     }
1243   }
1244   return false;
1245 }
1246
1247
1248 /// CanJoinExtractSubRegToPhysReg - Return true if it's possible to coalesce
1249 /// an extract_subreg where dst is a physical register, e.g.
1250 /// cl = EXTRACT_SUBREG reg1024, 1
1251 bool
1252 SimpleRegisterCoalescing::CanJoinExtractSubRegToPhysReg(unsigned DstReg,
1253                                                unsigned SrcReg, unsigned SubIdx,
1254                                                unsigned &RealDstReg) {
1255   const TargetRegisterClass *RC = mri_->getRegClass(SrcReg);
1256   RealDstReg = tri_->getMatchingSuperReg(DstReg, SubIdx, RC);
1257   assert(RealDstReg && "Invalid extract_subreg instruction!");
1258
1259   LiveInterval &RHS = li_->getInterval(SrcReg);
1260   // For this type of EXTRACT_SUBREG, conservatively
1261   // check if the live interval of the source register interfere with the
1262   // actual super physical register we are trying to coalesce with.
1263   if (li_->hasInterval(RealDstReg) &&
1264       RHS.overlaps(li_->getInterval(RealDstReg))) {
1265     DEBUG({
1266         dbgs() << "Interfere with register ";
1267         li_->getInterval(RealDstReg).print(dbgs(), tri_);
1268       });
1269     return false; // Not coalescable
1270   }
1271   for (const unsigned* SR = tri_->getSubRegisters(RealDstReg); *SR; ++SR)
1272     // Do not check DstReg or its sub-register. JoinIntervals() will take care
1273     // of that.
1274     if (*SR != DstReg &&
1275         !tri_->isSubRegister(DstReg, *SR) &&
1276         li_->hasInterval(*SR) && RHS.overlaps(li_->getInterval(*SR))) {
1277       DEBUG({
1278           dbgs() << "Interfere with sub-register ";
1279           li_->getInterval(*SR).print(dbgs(), tri_);
1280         });
1281       return false; // Not coalescable
1282     }
1283   return true;
1284 }
1285
1286 /// CanJoinInsertSubRegToPhysReg - Return true if it's possible to coalesce
1287 /// an insert_subreg where src is a physical register, e.g.
1288 /// reg1024 = INSERT_SUBREG reg1024, c1, 0
1289 bool
1290 SimpleRegisterCoalescing::CanJoinInsertSubRegToPhysReg(unsigned DstReg,
1291                                                unsigned SrcReg, unsigned SubIdx,
1292                                                unsigned &RealSrcReg) {
1293   const TargetRegisterClass *RC = mri_->getRegClass(DstReg);
1294   RealSrcReg = tri_->getMatchingSuperReg(SrcReg, SubIdx, RC);
1295   assert(RealSrcReg && "Invalid extract_subreg instruction!");
1296
1297   LiveInterval &LHS = li_->getInterval(DstReg);
1298   if (li_->hasInterval(RealSrcReg) &&
1299       LHS.overlaps(li_->getInterval(RealSrcReg))) {
1300     DEBUG({
1301         dbgs() << "Interfere with register ";
1302         li_->getInterval(RealSrcReg).print(dbgs(), tri_);
1303       });
1304     return false; // Not coalescable
1305   }
1306   for (const unsigned* SR = tri_->getSubRegisters(RealSrcReg); *SR; ++SR)
1307     // Do not check SrcReg or its sub-register. JoinIntervals() will take care
1308     // of that.
1309     if (*SR != SrcReg &&
1310         !tri_->isSubRegister(SrcReg, *SR) &&
1311         li_->hasInterval(*SR) && LHS.overlaps(li_->getInterval(*SR))) {
1312       DEBUG({
1313           dbgs() << "Interfere with sub-register ";
1314           li_->getInterval(*SR).print(dbgs(), tri_);
1315         });
1316       return false; // Not coalescable
1317     }
1318   return true;
1319 }
1320
1321 /// getRegAllocPreference - Return register allocation preference register.
1322 ///
1323 static unsigned getRegAllocPreference(unsigned Reg, MachineFunction &MF,
1324                                       MachineRegisterInfo *MRI,
1325                                       const TargetRegisterInfo *TRI) {
1326   if (TargetRegisterInfo::isPhysicalRegister(Reg))
1327     return 0;
1328   std::pair<unsigned, unsigned> Hint = MRI->getRegAllocationHint(Reg);
1329   return TRI->ResolveRegAllocHint(Hint.first, Hint.second, MF);
1330 }
1331
1332 /// JoinCopy - Attempt to join intervals corresponding to SrcReg/DstReg,
1333 /// which are the src/dst of the copy instruction CopyMI.  This returns true
1334 /// if the copy was successfully coalesced away. If it is not currently
1335 /// possible to coalesce this interval, but it may be possible if other
1336 /// things get coalesced, then it returns true by reference in 'Again'.
1337 bool SimpleRegisterCoalescing::JoinCopy(CopyRec &TheCopy, bool &Again) {
1338   MachineInstr *CopyMI = TheCopy.MI;
1339
1340   Again = false;
1341   if (JoinedCopies.count(CopyMI) || ReMatCopies.count(CopyMI))
1342     return false; // Already done.
1343
1344   DEBUG(dbgs() << li_->getInstructionIndex(CopyMI) << '\t' << *CopyMI);
1345
1346   unsigned SrcReg, DstReg, SrcSubIdx = 0, DstSubIdx = 0;
1347   bool isExtSubReg = CopyMI->isExtractSubreg();
1348   bool isInsSubReg = CopyMI->isInsertSubreg();
1349   bool isSubRegToReg = CopyMI->isSubregToReg();
1350   unsigned SubIdx = 0;
1351   if (isExtSubReg) {
1352     DstReg    = CopyMI->getOperand(0).getReg();
1353     DstSubIdx = CopyMI->getOperand(0).getSubReg();
1354     SrcReg    = CopyMI->getOperand(1).getReg();
1355     SrcSubIdx = CopyMI->getOperand(2).getImm();
1356   } else if (isInsSubReg || isSubRegToReg) {
1357     DstReg    = CopyMI->getOperand(0).getReg();
1358     DstSubIdx = CopyMI->getOperand(3).getImm();
1359     SrcReg    = CopyMI->getOperand(2).getReg();
1360     SrcSubIdx = CopyMI->getOperand(2).getSubReg();
1361     if (SrcSubIdx && SrcSubIdx != DstSubIdx) {
1362       // r1025 = INSERT_SUBREG r1025, r1024<2>, 2 Then r1024 has already been
1363       // coalesced to a larger register so the subreg indices cancel out.
1364       DEBUG(dbgs() << "\tSource of insert_subreg or subreg_to_reg is already "
1365                       "coalesced to another register.\n");
1366       return false;  // Not coalescable.
1367     }
1368   } else if (tii_->isMoveInstr(*CopyMI, SrcReg, DstReg, SrcSubIdx, DstSubIdx)) {
1369     if (SrcSubIdx && DstSubIdx && SrcSubIdx != DstSubIdx) {
1370       // e.g. %reg16404:1<def> = MOV8rr %reg16412:2<kill>
1371       Again = true;
1372       return false;  // Not coalescable.
1373     }
1374   } else {
1375     llvm_unreachable("Unrecognized copy instruction!");
1376   }
1377
1378   // If they are already joined we continue.
1379   if (SrcReg == DstReg) {
1380     DEBUG(dbgs() << "\tCopy already coalesced.\n");
1381     return false;  // Not coalescable.
1382   }
1383
1384   bool SrcIsPhys = TargetRegisterInfo::isPhysicalRegister(SrcReg);
1385   bool DstIsPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
1386
1387   // If they are both physical registers, we cannot join them.
1388   if (SrcIsPhys && DstIsPhys) {
1389     DEBUG(dbgs() << "\tCan not coalesce physregs.\n");
1390     return false;  // Not coalescable.
1391   }
1392
1393   // We only join virtual registers with allocatable physical registers.
1394   if (SrcIsPhys && !allocatableRegs_[SrcReg]) {
1395     DEBUG(dbgs() << "\tSrc reg is unallocatable physreg.\n");
1396     return false;  // Not coalescable.
1397   }
1398   if (DstIsPhys && !allocatableRegs_[DstReg]) {
1399     DEBUG(dbgs() << "\tDst reg is unallocatable physreg.\n");
1400     return false;  // Not coalescable.
1401   }
1402
1403   // Check that a physical source register is compatible with dst regclass
1404   if (SrcIsPhys) {
1405     unsigned SrcSubReg = SrcSubIdx ?
1406       tri_->getSubReg(SrcReg, SrcSubIdx) : SrcReg;
1407     const TargetRegisterClass *DstRC = mri_->getRegClass(DstReg);
1408     const TargetRegisterClass *DstSubRC = DstRC;
1409     if (DstSubIdx)
1410       DstSubRC = DstRC->getSubRegisterRegClass(DstSubIdx);
1411     assert(DstSubRC && "Illegal subregister index");
1412     if (!DstSubRC->contains(SrcSubReg)) {
1413       DEBUG(dbgs() << "\tIncompatible destination regclass: "
1414                    << tri_->getName(SrcSubReg) << " not in "
1415                    << DstSubRC->getName() << ".\n");
1416       return false;             // Not coalescable.
1417     }
1418   }
1419
1420   // Check that a physical dst register is compatible with source regclass
1421   if (DstIsPhys) {
1422     unsigned DstSubReg = DstSubIdx ?
1423       tri_->getSubReg(DstReg, DstSubIdx) : DstReg;
1424     const TargetRegisterClass *SrcRC = mri_->getRegClass(SrcReg);
1425     const TargetRegisterClass *SrcSubRC = SrcRC;
1426     if (SrcSubIdx)
1427       SrcSubRC = SrcRC->getSubRegisterRegClass(SrcSubIdx);
1428     assert(SrcSubRC && "Illegal subregister index");
1429     if (!SrcSubRC->contains(DstSubReg)) {
1430       DEBUG(dbgs() << "\tIncompatible source regclass: "
1431                    << tri_->getName(DstSubReg) << " not in "
1432                    << SrcSubRC->getName() << ".\n");
1433       (void)DstSubReg;
1434       return false;             // Not coalescable.
1435     }
1436   }
1437
1438   // Should be non-null only when coalescing to a sub-register class.
1439   bool CrossRC = false;
1440   const TargetRegisterClass *SrcRC= SrcIsPhys ? 0 : mri_->getRegClass(SrcReg);
1441   const TargetRegisterClass *DstRC= DstIsPhys ? 0 : mri_->getRegClass(DstReg);
1442   const TargetRegisterClass *NewRC = NULL;
1443   unsigned RealDstReg = 0;
1444   unsigned RealSrcReg = 0;
1445   if (isExtSubReg || isInsSubReg || isSubRegToReg) {
1446     SubIdx = CopyMI->getOperand(isExtSubReg ? 2 : 3).getImm();
1447     if (SrcIsPhys && isExtSubReg) {
1448       // r1024 = EXTRACT_SUBREG EAX, 0 then r1024 is really going to be
1449       // coalesced with AX.
1450       unsigned DstSubIdx = CopyMI->getOperand(0).getSubReg();
1451       if (DstSubIdx) {
1452         // r1024<2> = EXTRACT_SUBREG EAX, 2. Then r1024 has already been
1453         // coalesced to a larger register so the subreg indices cancel out.
1454         if (DstSubIdx != SubIdx) {
1455           DEBUG(dbgs() << "\t Sub-register indices mismatch.\n");
1456           return false; // Not coalescable.
1457         }
1458       } else
1459         SrcReg = tri_->getSubReg(SrcReg, SubIdx);
1460       SubIdx = 0;
1461     } else if (DstIsPhys && (isInsSubReg || isSubRegToReg)) {
1462       // EAX = INSERT_SUBREG EAX, r1024, 0
1463       unsigned SrcSubIdx = CopyMI->getOperand(2).getSubReg();
1464       if (SrcSubIdx) {
1465         // EAX = INSERT_SUBREG EAX, r1024<2>, 2 Then r1024 has already been
1466         // coalesced to a larger register so the subreg indices cancel out.
1467         if (SrcSubIdx != SubIdx) {
1468           DEBUG(dbgs() << "\t Sub-register indices mismatch.\n");
1469           return false; // Not coalescable.
1470         }
1471       } else
1472         DstReg = tri_->getSubReg(DstReg, SubIdx);
1473       SubIdx = 0;
1474     } else if ((DstIsPhys && isExtSubReg) ||
1475                (SrcIsPhys && (isInsSubReg || isSubRegToReg))) {
1476       if (!isSubRegToReg && CopyMI->getOperand(1).getSubReg()) {
1477         DEBUG(dbgs() << "\tSrc of extract_subreg already coalesced with reg"
1478                      << " of a super-class.\n");
1479         return false; // Not coalescable.
1480       }
1481
1482       // FIXME: The following checks are somewhat conservative. Perhaps a better
1483       // way to implement this is to treat this as coalescing a vr with the
1484       // super physical register.
1485       if (isExtSubReg) {
1486         if (!CanJoinExtractSubRegToPhysReg(DstReg, SrcReg, SubIdx, RealDstReg))
1487           return false; // Not coalescable
1488       } else {
1489         if (!CanJoinInsertSubRegToPhysReg(DstReg, SrcReg, SubIdx, RealSrcReg))
1490           return false; // Not coalescable
1491       }
1492       SubIdx = 0;
1493     } else {
1494       unsigned OldSubIdx = isExtSubReg ? CopyMI->getOperand(0).getSubReg()
1495         : CopyMI->getOperand(2).getSubReg();
1496       if (OldSubIdx) {
1497         if (OldSubIdx == SubIdx && !differingRegisterClasses(SrcReg, DstReg))
1498           // r1024<2> = EXTRACT_SUBREG r1025, 2. Then r1024 has already been
1499           // coalesced to a larger register so the subreg indices cancel out.
1500           // Also check if the other larger register is of the same register
1501           // class as the would be resulting register.
1502           SubIdx = 0;
1503         else {
1504           DEBUG(dbgs() << "\t Sub-register indices mismatch.\n");
1505           return false; // Not coalescable.
1506         }
1507       }
1508       if (SubIdx) {
1509         if (!DstIsPhys && !SrcIsPhys) {
1510           if (isInsSubReg || isSubRegToReg) {
1511             NewRC = tri_->getMatchingSuperRegClass(DstRC, SrcRC, SubIdx);
1512           } else // extract_subreg {
1513             NewRC = tri_->getMatchingSuperRegClass(SrcRC, DstRC, SubIdx);
1514           }
1515         if (!NewRC) {
1516           DEBUG(dbgs() << "\t Conflicting sub-register indices.\n");
1517           return false;  // Not coalescable
1518         }
1519
1520         unsigned LargeReg = isExtSubReg ? SrcReg : DstReg;
1521         unsigned SmallReg = isExtSubReg ? DstReg : SrcReg;
1522         unsigned Limit= allocatableRCRegs_[mri_->getRegClass(SmallReg)].count();
1523         if (!isWinToJoinCrossClass(LargeReg, SmallReg, Limit)) {
1524           Again = true;  // May be possible to coalesce later.
1525           return false;
1526         }
1527       }
1528     }
1529   } else if (differingRegisterClasses(SrcReg, DstReg)) {
1530     if (DisableCrossClassJoin)
1531       return false;
1532     CrossRC = true;
1533
1534     // FIXME: What if the result of a EXTRACT_SUBREG is then coalesced
1535     // with another? If it's the resulting destination register, then
1536     // the subidx must be propagated to uses (but only those defined
1537     // by the EXTRACT_SUBREG). If it's being coalesced into another
1538     // register, it should be safe because register is assumed to have
1539     // the register class of the super-register.
1540
1541     // Process moves where one of the registers have a sub-register index.
1542     MachineOperand *DstMO = CopyMI->findRegisterDefOperand(DstReg);
1543     MachineOperand *SrcMO = CopyMI->findRegisterUseOperand(SrcReg);
1544     SubIdx = DstMO->getSubReg();
1545     if (SubIdx) {
1546       if (SrcMO->getSubReg())
1547         // FIXME: can we handle this?
1548         return false;
1549       // This is not an insert_subreg but it looks like one.
1550       // e.g. %reg1024:4 = MOV32rr %EAX
1551       isInsSubReg = true;
1552       if (SrcIsPhys) {
1553         if (!CanJoinInsertSubRegToPhysReg(DstReg, SrcReg, SubIdx, RealSrcReg))
1554           return false; // Not coalescable
1555         SubIdx = 0;
1556       }
1557     } else {
1558       SubIdx = SrcMO->getSubReg();
1559       if (SubIdx) {
1560         // This is not a extract_subreg but it looks like one.
1561         // e.g. %cl = MOV16rr %reg1024:1
1562         isExtSubReg = true;
1563         if (DstIsPhys) {
1564           if (!CanJoinExtractSubRegToPhysReg(DstReg, SrcReg, SubIdx,RealDstReg))
1565             return false; // Not coalescable
1566           SubIdx = 0;
1567         }
1568       }
1569     }
1570
1571     unsigned LargeReg = SrcReg;
1572     unsigned SmallReg = DstReg;
1573
1574     // Now determine the register class of the joined register.
1575     if (isExtSubReg) {
1576       if (SubIdx && DstRC && DstRC->isASubClass()) {
1577         // This is a move to a sub-register class. However, the source is a
1578         // sub-register of a larger register class. We don't know what should
1579         // the register class be. FIXME.
1580         Again = true;
1581         return false;
1582       }
1583       if (!DstIsPhys && !SrcIsPhys)
1584         NewRC = SrcRC;
1585     } else if (!SrcIsPhys && !DstIsPhys) {
1586       NewRC = getCommonSubClass(SrcRC, DstRC);
1587       if (!NewRC) {
1588         DEBUG(dbgs() << "\tDisjoint regclasses: "
1589                      << SrcRC->getName() << ", "
1590                      << DstRC->getName() << ".\n");
1591         return false;           // Not coalescable.
1592       }
1593       if (DstRC->getSize() > SrcRC->getSize())
1594         std::swap(LargeReg, SmallReg);
1595     }
1596
1597     // If we are joining two virtual registers and the resulting register
1598     // class is more restrictive (fewer register, smaller size). Check if it's
1599     // worth doing the merge.
1600     if (!SrcIsPhys && !DstIsPhys &&
1601         (isExtSubReg || DstRC->isASubClass()) &&
1602         !isWinToJoinCrossClass(LargeReg, SmallReg,
1603                                allocatableRCRegs_[NewRC].count())) {
1604       DEBUG(dbgs() << "\tSrc/Dest are different register classes: "
1605                    << SrcRC->getName() << "/"
1606                    << DstRC->getName() << " -> "
1607                    << NewRC->getName() << ".\n");
1608       // Allow the coalescer to try again in case either side gets coalesced to
1609       // a physical register that's compatible with the other side. e.g.
1610       // r1024 = MOV32to32_ r1025
1611       // But later r1024 is assigned EAX then r1025 may be coalesced with EAX.
1612       Again = true;  // May be possible to coalesce later.
1613       return false;
1614     }
1615   }
1616
1617   // Will it create illegal extract_subreg / insert_subreg?
1618   if (SrcIsPhys && HasIncompatibleSubRegDefUse(CopyMI, DstReg, SrcReg))
1619     return false;
1620   if (DstIsPhys && HasIncompatibleSubRegDefUse(CopyMI, SrcReg, DstReg))
1621     return false;
1622
1623   LiveInterval &SrcInt = li_->getInterval(SrcReg);
1624   LiveInterval &DstInt = li_->getInterval(DstReg);
1625   assert(SrcInt.reg == SrcReg && DstInt.reg == DstReg &&
1626          "Register mapping is horribly broken!");
1627
1628   DEBUG({
1629       dbgs() << "\t\tInspecting "; SrcInt.print(dbgs(), tri_);
1630       dbgs() << " and "; DstInt.print(dbgs(), tri_);
1631       dbgs() << ": ";
1632     });
1633
1634   // Save a copy of the virtual register live interval. We'll manually
1635   // merge this into the "real" physical register live interval this is
1636   // coalesced with.
1637   OwningPtr<LiveInterval> SavedLI;
1638   if (RealDstReg)
1639     SavedLI.reset(li_->dupInterval(&SrcInt));
1640   else if (RealSrcReg)
1641     SavedLI.reset(li_->dupInterval(&DstInt));
1642
1643   if (!isExtSubReg && !isInsSubReg && !isSubRegToReg) {
1644     // Check if it is necessary to propagate "isDead" property.
1645     MachineOperand *mopd = CopyMI->findRegisterDefOperand(DstReg, false);
1646     bool isDead = mopd->isDead();
1647
1648     // We need to be careful about coalescing a source physical register with a
1649     // virtual register. Once the coalescing is done, it cannot be broken and
1650     // these are not spillable! If the destination interval uses are far away,
1651     // think twice about coalescing them!
1652     if (!isDead && (SrcIsPhys || DstIsPhys)) {
1653       // If the virtual register live interval is long but it has low use
1654       // density, do not join them, instead mark the physical register as its
1655       // allocation preference.
1656       LiveInterval &JoinVInt = SrcIsPhys ? DstInt : SrcInt;
1657       LiveInterval &JoinPInt = SrcIsPhys ? SrcInt : DstInt;
1658       unsigned JoinVReg = SrcIsPhys ? DstReg : SrcReg;
1659       unsigned JoinPReg = SrcIsPhys ? SrcReg : DstReg;
1660
1661       // Don't join with physregs that have a ridiculous number of live
1662       // ranges. The data structure performance is really bad when that
1663       // happens.
1664       if (JoinPInt.ranges.size() > 1000) {
1665         mri_->setRegAllocationHint(JoinVInt.reg, 0, JoinPReg);
1666         ++numAborts;
1667         DEBUG(dbgs() << "\tPhysical register too complicated, abort!\n");
1668         return false;
1669       }
1670
1671       const TargetRegisterClass *RC = mri_->getRegClass(JoinVReg);
1672       unsigned Threshold = allocatableRCRegs_[RC].count() * 2;
1673       unsigned Length = li_->getApproximateInstructionCount(JoinVInt);
1674       float Ratio = 1.0 / Threshold;
1675       if (Length > Threshold &&
1676           (((float)std::distance(mri_->use_nodbg_begin(JoinVReg),
1677                                  mri_->use_nodbg_end()) / Length) < Ratio)) {
1678         mri_->setRegAllocationHint(JoinVInt.reg, 0, JoinPReg);
1679         ++numAborts;
1680         DEBUG(dbgs() << "\tMay tie down a physical register, abort!\n");
1681         Again = true;  // May be possible to coalesce later.
1682         return false;
1683       }
1684     }
1685   }
1686
1687   // Okay, attempt to join these two intervals.  On failure, this returns false.
1688   // Otherwise, if one of the intervals being joined is a physreg, this method
1689   // always canonicalizes DstInt to be it.  The output "SrcInt" will not have
1690   // been modified, so we can use this information below to update aliases.
1691   bool Swapped = false;
1692   // If SrcInt is implicitly defined, it's safe to coalesce.
1693   if (SrcInt.empty()) {
1694     if (!CanCoalesceWithImpDef(CopyMI, DstInt, SrcInt)) {
1695       // Only coalesce an empty interval (defined by implicit_def) with
1696       // another interval which has a valno defined by the CopyMI and the CopyMI
1697       // is a kill of the implicit def.
1698       DEBUG(dbgs() << "Not profitable!\n");
1699       return false;
1700     }
1701   } else if (!JoinIntervals(DstInt, SrcInt, Swapped)) {
1702     // Coalescing failed.
1703
1704     // If definition of source is defined by trivial computation, try
1705     // rematerializing it.
1706     if (!isExtSubReg && !isInsSubReg && !isSubRegToReg &&
1707         ReMaterializeTrivialDef(SrcInt, DstReg, DstSubIdx, CopyMI))
1708       return true;
1709
1710     // If we can eliminate the copy without merging the live ranges, do so now.
1711     if (!isExtSubReg && !isInsSubReg && !isSubRegToReg &&
1712         (AdjustCopiesBackFrom(SrcInt, DstInt, CopyMI) ||
1713          RemoveCopyByCommutingDef(SrcInt, DstInt, CopyMI))) {
1714       JoinedCopies.insert(CopyMI);
1715       DEBUG(dbgs() << "Trivial!\n");
1716       return true;
1717     }
1718
1719     // Otherwise, we are unable to join the intervals.
1720     DEBUG(dbgs() << "Interference!\n");
1721     Again = true;  // May be possible to coalesce later.
1722     return false;
1723   }
1724
1725   LiveInterval *ResSrcInt = &SrcInt;
1726   LiveInterval *ResDstInt = &DstInt;
1727   if (Swapped) {
1728     std::swap(SrcReg, DstReg);
1729     std::swap(ResSrcInt, ResDstInt);
1730   }
1731   assert(TargetRegisterInfo::isVirtualRegister(SrcReg) &&
1732          "LiveInterval::join didn't work right!");
1733
1734   // If we're about to merge live ranges into a physical register live interval,
1735   // we have to update any aliased register's live ranges to indicate that they
1736   // have clobbered values for this range.
1737   if (TargetRegisterInfo::isPhysicalRegister(DstReg)) {
1738     // If this is a extract_subreg where dst is a physical register, e.g.
1739     // cl = EXTRACT_SUBREG reg1024, 1
1740     // then create and update the actual physical register allocated to RHS.
1741     if (RealDstReg || RealSrcReg) {
1742       LiveInterval &RealInt =
1743         li_->getOrCreateInterval(RealDstReg ? RealDstReg : RealSrcReg);
1744       for (LiveInterval::const_vni_iterator I = SavedLI->vni_begin(),
1745              E = SavedLI->vni_end(); I != E; ++I) {
1746         const VNInfo *ValNo = *I;
1747         VNInfo *NewValNo = RealInt.getNextValue(ValNo->def, ValNo->getCopy(),
1748                                                 false, // updated at *
1749                                                 li_->getVNInfoAllocator());
1750         NewValNo->setFlags(ValNo->getFlags()); // * updated here.
1751         RealInt.addKills(NewValNo, ValNo->kills);
1752         RealInt.MergeValueInAsValue(*SavedLI, ValNo, NewValNo);
1753       }
1754       RealInt.weight += SavedLI->weight;
1755       DstReg = RealDstReg ? RealDstReg : RealSrcReg;
1756     }
1757
1758     // Update the liveintervals of sub-registers.
1759     for (const unsigned *AS = tri_->getSubRegisters(DstReg); *AS; ++AS)
1760       li_->getOrCreateInterval(*AS).MergeInClobberRanges(*li_, *ResSrcInt,
1761                                                  li_->getVNInfoAllocator());
1762   }
1763
1764   // If this is a EXTRACT_SUBREG, make sure the result of coalescing is the
1765   // larger super-register.
1766   if ((isExtSubReg || isInsSubReg || isSubRegToReg) &&
1767       !SrcIsPhys && !DstIsPhys) {
1768     if ((isExtSubReg && !Swapped) ||
1769         ((isInsSubReg || isSubRegToReg) && Swapped)) {
1770       ResSrcInt->Copy(*ResDstInt, mri_, li_->getVNInfoAllocator());
1771       std::swap(SrcReg, DstReg);
1772       std::swap(ResSrcInt, ResDstInt);
1773     }
1774   }
1775
1776   // Coalescing to a virtual register that is of a sub-register class of the
1777   // other. Make sure the resulting register is set to the right register class.
1778   if (CrossRC)
1779     ++numCrossRCs;
1780
1781   // This may happen even if it's cross-rc coalescing. e.g.
1782   // %reg1026<def> = SUBREG_TO_REG 0, %reg1037<kill>, 4
1783   // reg1026 -> GR64, reg1037 -> GR32_ABCD. The resulting register will have to
1784   // be allocate a register from GR64_ABCD.
1785   if (NewRC)
1786     mri_->setRegClass(DstReg, NewRC);
1787
1788   // Remember to delete the copy instruction.
1789   JoinedCopies.insert(CopyMI);
1790
1791   // Some live range has been lengthened due to colaescing, eliminate the
1792   // unnecessary kills.
1793   RemoveUnnecessaryKills(SrcReg, *ResDstInt);
1794   if (TargetRegisterInfo::isVirtualRegister(DstReg))
1795     RemoveUnnecessaryKills(DstReg, *ResDstInt);
1796
1797   UpdateRegDefsUses(SrcReg, DstReg, SubIdx);
1798
1799   // If we have extended the live range of a physical register, make sure we
1800   // update live-in lists as well.
1801   if (TargetRegisterInfo::isPhysicalRegister(DstReg)) {
1802     const LiveInterval &VRegInterval = li_->getInterval(SrcReg);
1803     SmallVector<MachineBasicBlock*, 16> BlockSeq;
1804     for (LiveInterval::const_iterator I = VRegInterval.begin(),
1805            E = VRegInterval.end(); I != E; ++I ) {
1806       li_->findLiveInMBBs(I->start, I->end, BlockSeq);
1807       for (unsigned idx = 0, size = BlockSeq.size(); idx != size; ++idx) {
1808         MachineBasicBlock &block = *BlockSeq[idx];
1809         if (!block.isLiveIn(DstReg))
1810           block.addLiveIn(DstReg);
1811       }
1812       BlockSeq.clear();
1813     }
1814   }
1815
1816   // SrcReg is guarateed to be the register whose live interval that is
1817   // being merged.
1818   li_->removeInterval(SrcReg);
1819
1820   // Update regalloc hint.
1821   tri_->UpdateRegAllocHint(SrcReg, DstReg, *mf_);
1822
1823   // Manually deleted the live interval copy.
1824   if (SavedLI) {
1825     SavedLI->clear();
1826     SavedLI.reset();
1827   }
1828
1829   // If resulting interval has a preference that no longer fits because of subreg
1830   // coalescing, just clear the preference.
1831   unsigned Preference = getRegAllocPreference(ResDstInt->reg, *mf_, mri_, tri_);
1832   if (Preference && (isExtSubReg || isInsSubReg || isSubRegToReg) &&
1833       TargetRegisterInfo::isVirtualRegister(ResDstInt->reg)) {
1834     const TargetRegisterClass *RC = mri_->getRegClass(ResDstInt->reg);
1835     if (!RC->contains(Preference))
1836       mri_->setRegAllocationHint(ResDstInt->reg, 0, 0);
1837   }
1838
1839   DEBUG({
1840       dbgs() << "\n\t\tJoined.  Result = ";
1841       ResDstInt->print(dbgs(), tri_);
1842       dbgs() << "\n";
1843     });
1844
1845   ++numJoins;
1846   return true;
1847 }
1848
1849 /// ComputeUltimateVN - Assuming we are going to join two live intervals,
1850 /// compute what the resultant value numbers for each value in the input two
1851 /// ranges will be.  This is complicated by copies between the two which can
1852 /// and will commonly cause multiple value numbers to be merged into one.
1853 ///
1854 /// VN is the value number that we're trying to resolve.  InstDefiningValue
1855 /// keeps track of the new InstDefiningValue assignment for the result
1856 /// LiveInterval.  ThisFromOther/OtherFromThis are sets that keep track of
1857 /// whether a value in this or other is a copy from the opposite set.
1858 /// ThisValNoAssignments/OtherValNoAssignments keep track of value #'s that have
1859 /// already been assigned.
1860 ///
1861 /// ThisFromOther[x] - If x is defined as a copy from the other interval, this
1862 /// contains the value number the copy is from.
1863 ///
1864 static unsigned ComputeUltimateVN(VNInfo *VNI,
1865                                   SmallVector<VNInfo*, 16> &NewVNInfo,
1866                                   DenseMap<VNInfo*, VNInfo*> &ThisFromOther,
1867                                   DenseMap<VNInfo*, VNInfo*> &OtherFromThis,
1868                                   SmallVector<int, 16> &ThisValNoAssignments,
1869                                   SmallVector<int, 16> &OtherValNoAssignments) {
1870   unsigned VN = VNI->id;
1871
1872   // If the VN has already been computed, just return it.
1873   if (ThisValNoAssignments[VN] >= 0)
1874     return ThisValNoAssignments[VN];
1875   assert(ThisValNoAssignments[VN] != -2 && "Cyclic value numbers");
1876
1877   // If this val is not a copy from the other val, then it must be a new value
1878   // number in the destination.
1879   DenseMap<VNInfo*, VNInfo*>::iterator I = ThisFromOther.find(VNI);
1880   if (I == ThisFromOther.end()) {
1881     NewVNInfo.push_back(VNI);
1882     return ThisValNoAssignments[VN] = NewVNInfo.size()-1;
1883   }
1884   VNInfo *OtherValNo = I->second;
1885
1886   // Otherwise, this *is* a copy from the RHS.  If the other side has already
1887   // been computed, return it.
1888   if (OtherValNoAssignments[OtherValNo->id] >= 0)
1889     return ThisValNoAssignments[VN] = OtherValNoAssignments[OtherValNo->id];
1890
1891   // Mark this value number as currently being computed, then ask what the
1892   // ultimate value # of the other value is.
1893   ThisValNoAssignments[VN] = -2;
1894   unsigned UltimateVN =
1895     ComputeUltimateVN(OtherValNo, NewVNInfo, OtherFromThis, ThisFromOther,
1896                       OtherValNoAssignments, ThisValNoAssignments);
1897   return ThisValNoAssignments[VN] = UltimateVN;
1898 }
1899
1900 static bool InVector(VNInfo *Val, const SmallVector<VNInfo*, 8> &V) {
1901   return std::find(V.begin(), V.end(), Val) != V.end();
1902 }
1903
1904 static bool isValNoDefMove(const MachineInstr *MI, unsigned DR, unsigned SR,
1905                            const TargetInstrInfo *TII,
1906                            const TargetRegisterInfo *TRI) {
1907   unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1908   if (TII->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx))
1909     ;
1910   else if (MI->isExtractSubreg()) {
1911     DstReg = MI->getOperand(0).getReg();
1912     SrcReg = MI->getOperand(1).getReg();
1913   } else if (MI->isSubregToReg() ||
1914              MI->isInsertSubreg()) {
1915     DstReg = MI->getOperand(0).getReg();
1916     SrcReg = MI->getOperand(2).getReg();
1917   } else
1918     return false;
1919   return (SrcReg == SR || TRI->isSuperRegister(SR, SrcReg)) &&
1920          (DstReg == DR || TRI->isSuperRegister(DR, DstReg));
1921 }
1922
1923 /// RangeIsDefinedByCopyFromReg - Return true if the specified live range of
1924 /// the specified live interval is defined by a copy from the specified
1925 /// register.
1926 bool SimpleRegisterCoalescing::RangeIsDefinedByCopyFromReg(LiveInterval &li,
1927                                                            LiveRange *LR,
1928                                                            unsigned Reg) {
1929   unsigned SrcReg = li_->getVNInfoSourceReg(LR->valno);
1930   if (SrcReg == Reg)
1931     return true;
1932   // FIXME: Do isPHIDef and isDefAccurate both need to be tested?
1933   if ((LR->valno->isPHIDef() || !LR->valno->isDefAccurate()) &&
1934       TargetRegisterInfo::isPhysicalRegister(li.reg) &&
1935       *tri_->getSuperRegisters(li.reg)) {
1936     // It's a sub-register live interval, we may not have precise information.
1937     // Re-compute it.
1938     MachineInstr *DefMI = li_->getInstructionFromIndex(LR->start);
1939     if (DefMI && isValNoDefMove(DefMI, li.reg, Reg, tii_, tri_)) {
1940       // Cache computed info.
1941       LR->valno->def = LR->start;
1942       LR->valno->setCopy(DefMI);
1943       return true;
1944     }
1945   }
1946   return false;
1947 }
1948
1949
1950 /// ValueLiveAt - Return true if the LiveRange pointed to by the given
1951 /// iterator, or any subsequent range with the same value number,
1952 /// is live at the given point.
1953 bool SimpleRegisterCoalescing::ValueLiveAt(LiveInterval::iterator LRItr,
1954                                            LiveInterval::iterator LREnd,
1955                                            SlotIndex defPoint) const {
1956   for (const VNInfo *valno = LRItr->valno;
1957        (LRItr != LREnd) && (LRItr->valno == valno); ++LRItr) {
1958     if (LRItr->contains(defPoint))
1959       return true;
1960   }
1961
1962   return false;
1963 }
1964
1965
1966 /// SimpleJoin - Attempt to joint the specified interval into this one. The
1967 /// caller of this method must guarantee that the RHS only contains a single
1968 /// value number and that the RHS is not defined by a copy from this
1969 /// interval.  This returns false if the intervals are not joinable, or it
1970 /// joins them and returns true.
1971 bool SimpleRegisterCoalescing::SimpleJoin(LiveInterval &LHS, LiveInterval &RHS){
1972   assert(RHS.containsOneValue());
1973
1974   // Some number (potentially more than one) value numbers in the current
1975   // interval may be defined as copies from the RHS.  Scan the overlapping
1976   // portions of the LHS and RHS, keeping track of this and looking for
1977   // overlapping live ranges that are NOT defined as copies.  If these exist, we
1978   // cannot coalesce.
1979
1980   LiveInterval::iterator LHSIt = LHS.begin(), LHSEnd = LHS.end();
1981   LiveInterval::iterator RHSIt = RHS.begin(), RHSEnd = RHS.end();
1982
1983   if (LHSIt->start < RHSIt->start) {
1984     LHSIt = std::upper_bound(LHSIt, LHSEnd, RHSIt->start);
1985     if (LHSIt != LHS.begin()) --LHSIt;
1986   } else if (RHSIt->start < LHSIt->start) {
1987     RHSIt = std::upper_bound(RHSIt, RHSEnd, LHSIt->start);
1988     if (RHSIt != RHS.begin()) --RHSIt;
1989   }
1990
1991   SmallVector<VNInfo*, 8> EliminatedLHSVals;
1992
1993   while (1) {
1994     // Determine if these live intervals overlap.
1995     bool Overlaps = false;
1996     if (LHSIt->start <= RHSIt->start)
1997       Overlaps = LHSIt->end > RHSIt->start;
1998     else
1999       Overlaps = RHSIt->end > LHSIt->start;
2000
2001     // If the live intervals overlap, there are two interesting cases: if the
2002     // LHS interval is defined by a copy from the RHS, it's ok and we record
2003     // that the LHS value # is the same as the RHS.  If it's not, then we cannot
2004     // coalesce these live ranges and we bail out.
2005     if (Overlaps) {
2006       // If we haven't already recorded that this value # is safe, check it.
2007       if (!InVector(LHSIt->valno, EliminatedLHSVals)) {
2008         // If it's re-defined by an early clobber somewhere in the live range,
2009         // then conservatively abort coalescing.
2010         if (LHSIt->valno->hasRedefByEC())
2011           return false;
2012         // Copy from the RHS?
2013         if (!RangeIsDefinedByCopyFromReg(LHS, LHSIt, RHS.reg))
2014           return false;    // Nope, bail out.
2015
2016         if (ValueLiveAt(LHSIt, LHS.end(), RHSIt->valno->def))
2017           // Here is an interesting situation:
2018           // BB1:
2019           //   vr1025 = copy vr1024
2020           //   ..
2021           // BB2:
2022           //   vr1024 = op
2023           //          = vr1025
2024           // Even though vr1025 is copied from vr1024, it's not safe to
2025           // coalesce them since the live range of vr1025 intersects the
2026           // def of vr1024. This happens because vr1025 is assigned the
2027           // value of the previous iteration of vr1024.
2028           return false;
2029         EliminatedLHSVals.push_back(LHSIt->valno);
2030       }
2031
2032       // We know this entire LHS live range is okay, so skip it now.
2033       if (++LHSIt == LHSEnd) break;
2034       continue;
2035     }
2036
2037     if (LHSIt->end < RHSIt->end) {
2038       if (++LHSIt == LHSEnd) break;
2039     } else {
2040       // One interesting case to check here.  It's possible that we have
2041       // something like "X3 = Y" which defines a new value number in the LHS,
2042       // and is the last use of this liverange of the RHS.  In this case, we
2043       // want to notice this copy (so that it gets coalesced away) even though
2044       // the live ranges don't actually overlap.
2045       if (LHSIt->start == RHSIt->end) {
2046         if (InVector(LHSIt->valno, EliminatedLHSVals)) {
2047           // We already know that this value number is going to be merged in
2048           // if coalescing succeeds.  Just skip the liverange.
2049           if (++LHSIt == LHSEnd) break;
2050         } else {
2051           // If it's re-defined by an early clobber somewhere in the live range,
2052           // then conservatively abort coalescing.
2053           if (LHSIt->valno->hasRedefByEC())
2054             return false;
2055           // Otherwise, if this is a copy from the RHS, mark it as being merged
2056           // in.
2057           if (RangeIsDefinedByCopyFromReg(LHS, LHSIt, RHS.reg)) {
2058             if (ValueLiveAt(LHSIt, LHS.end(), RHSIt->valno->def))
2059               // Here is an interesting situation:
2060               // BB1:
2061               //   vr1025 = copy vr1024
2062               //   ..
2063               // BB2:
2064               //   vr1024 = op
2065               //          = vr1025
2066               // Even though vr1025 is copied from vr1024, it's not safe to
2067               // coalesced them since live range of vr1025 intersects the
2068               // def of vr1024. This happens because vr1025 is assigned the
2069               // value of the previous iteration of vr1024.
2070               return false;
2071             EliminatedLHSVals.push_back(LHSIt->valno);
2072
2073             // We know this entire LHS live range is okay, so skip it now.
2074             if (++LHSIt == LHSEnd) break;
2075           }
2076         }
2077       }
2078
2079       if (++RHSIt == RHSEnd) break;
2080     }
2081   }
2082
2083   // If we got here, we know that the coalescing will be successful and that
2084   // the value numbers in EliminatedLHSVals will all be merged together.  Since
2085   // the most common case is that EliminatedLHSVals has a single number, we
2086   // optimize for it: if there is more than one value, we merge them all into
2087   // the lowest numbered one, then handle the interval as if we were merging
2088   // with one value number.
2089   VNInfo *LHSValNo = NULL;
2090   if (EliminatedLHSVals.size() > 1) {
2091     // Loop through all the equal value numbers merging them into the smallest
2092     // one.
2093     VNInfo *Smallest = EliminatedLHSVals[0];
2094     for (unsigned i = 1, e = EliminatedLHSVals.size(); i != e; ++i) {
2095       if (EliminatedLHSVals[i]->id < Smallest->id) {
2096         // Merge the current notion of the smallest into the smaller one.
2097         LHS.MergeValueNumberInto(Smallest, EliminatedLHSVals[i]);
2098         Smallest = EliminatedLHSVals[i];
2099       } else {
2100         // Merge into the smallest.
2101         LHS.MergeValueNumberInto(EliminatedLHSVals[i], Smallest);
2102       }
2103     }
2104     LHSValNo = Smallest;
2105   } else if (EliminatedLHSVals.empty()) {
2106     if (TargetRegisterInfo::isPhysicalRegister(LHS.reg) &&
2107         *tri_->getSuperRegisters(LHS.reg))
2108       // Imprecise sub-register information. Can't handle it.
2109       return false;
2110     llvm_unreachable("No copies from the RHS?");
2111   } else {
2112     LHSValNo = EliminatedLHSVals[0];
2113   }
2114
2115   // Okay, now that there is a single LHS value number that we're merging the
2116   // RHS into, update the value number info for the LHS to indicate that the
2117   // value number is defined where the RHS value number was.
2118   const VNInfo *VNI = RHS.getValNumInfo(0);
2119   LHSValNo->def  = VNI->def;
2120   LHSValNo->setCopy(VNI->getCopy());
2121
2122   // Okay, the final step is to loop over the RHS live intervals, adding them to
2123   // the LHS.
2124   if (VNI->hasPHIKill())
2125     LHSValNo->setHasPHIKill(true);
2126   LHS.addKills(LHSValNo, VNI->kills);
2127   LHS.MergeRangesInAsValue(RHS, LHSValNo);
2128
2129   LHS.ComputeJoinedWeight(RHS);
2130
2131   // Update regalloc hint if both are virtual registers.
2132   if (TargetRegisterInfo::isVirtualRegister(LHS.reg) &&
2133       TargetRegisterInfo::isVirtualRegister(RHS.reg)) {
2134     std::pair<unsigned, unsigned> RHSPref = mri_->getRegAllocationHint(RHS.reg);
2135     std::pair<unsigned, unsigned> LHSPref = mri_->getRegAllocationHint(LHS.reg);
2136     if (RHSPref != LHSPref)
2137       mri_->setRegAllocationHint(LHS.reg, RHSPref.first, RHSPref.second);
2138   }
2139
2140   // Update the liveintervals of sub-registers.
2141   if (TargetRegisterInfo::isPhysicalRegister(LHS.reg))
2142     for (const unsigned *AS = tri_->getSubRegisters(LHS.reg); *AS; ++AS)
2143       li_->getOrCreateInterval(*AS).MergeInClobberRanges(*li_, LHS,
2144                                                     li_->getVNInfoAllocator());
2145
2146   return true;
2147 }
2148
2149 /// JoinIntervals - Attempt to join these two intervals.  On failure, this
2150 /// returns false.  Otherwise, if one of the intervals being joined is a
2151 /// physreg, this method always canonicalizes LHS to be it.  The output
2152 /// "RHS" will not have been modified, so we can use this information
2153 /// below to update aliases.
2154 bool
2155 SimpleRegisterCoalescing::JoinIntervals(LiveInterval &LHS, LiveInterval &RHS,
2156                                         bool &Swapped) {
2157   // Compute the final value assignment, assuming that the live ranges can be
2158   // coalesced.
2159   SmallVector<int, 16> LHSValNoAssignments;
2160   SmallVector<int, 16> RHSValNoAssignments;
2161   DenseMap<VNInfo*, VNInfo*> LHSValsDefinedFromRHS;
2162   DenseMap<VNInfo*, VNInfo*> RHSValsDefinedFromLHS;
2163   SmallVector<VNInfo*, 16> NewVNInfo;
2164
2165   // If a live interval is a physical register, conservatively check if any
2166   // of its sub-registers is overlapping the live interval of the virtual
2167   // register. If so, do not coalesce.
2168   if (TargetRegisterInfo::isPhysicalRegister(LHS.reg) &&
2169       *tri_->getSubRegisters(LHS.reg)) {
2170     // If it's coalescing a virtual register to a physical register, estimate
2171     // its live interval length. This is the *cost* of scanning an entire live
2172     // interval. If the cost is low, we'll do an exhaustive check instead.
2173
2174     // If this is something like this:
2175     // BB1:
2176     // v1024 = op
2177     // ...
2178     // BB2:
2179     // ...
2180     // RAX   = v1024
2181     //
2182     // That is, the live interval of v1024 crosses a bb. Then we can't rely on
2183     // less conservative check. It's possible a sub-register is defined before
2184     // v1024 (or live in) and live out of BB1.
2185     if (RHS.containsOneValue() &&
2186         li_->intervalIsInOneMBB(RHS) &&
2187         li_->getApproximateInstructionCount(RHS) <= 10) {
2188       // Perform a more exhaustive check for some common cases.
2189       if (li_->conflictsWithSubPhysRegRef(RHS, LHS.reg, true, JoinedCopies))
2190         return false;
2191     } else {
2192       for (const unsigned* SR = tri_->getSubRegisters(LHS.reg); *SR; ++SR)
2193         if (li_->hasInterval(*SR) && RHS.overlaps(li_->getInterval(*SR))) {
2194           DEBUG({
2195               dbgs() << "Interfere with sub-register ";
2196               li_->getInterval(*SR).print(dbgs(), tri_);
2197             });
2198           return false;
2199         }
2200     }
2201   } else if (TargetRegisterInfo::isPhysicalRegister(RHS.reg) &&
2202              *tri_->getSubRegisters(RHS.reg)) {
2203     if (LHS.containsOneValue() &&
2204         li_->getApproximateInstructionCount(LHS) <= 10) {
2205       // Perform a more exhaustive check for some common cases.
2206       if (li_->conflictsWithSubPhysRegRef(LHS, RHS.reg, false, JoinedCopies))
2207         return false;
2208     } else {
2209       for (const unsigned* SR = tri_->getSubRegisters(RHS.reg); *SR; ++SR)
2210         if (li_->hasInterval(*SR) && LHS.overlaps(li_->getInterval(*SR))) {
2211           DEBUG({
2212               dbgs() << "Interfere with sub-register ";
2213               li_->getInterval(*SR).print(dbgs(), tri_);
2214             });
2215           return false;
2216         }
2217     }
2218   }
2219
2220   // Compute ultimate value numbers for the LHS and RHS values.
2221   if (RHS.containsOneValue()) {
2222     // Copies from a liveinterval with a single value are simple to handle and
2223     // very common, handle the special case here.  This is important, because
2224     // often RHS is small and LHS is large (e.g. a physreg).
2225
2226     // Find out if the RHS is defined as a copy from some value in the LHS.
2227     int RHSVal0DefinedFromLHS = -1;
2228     int RHSValID = -1;
2229     VNInfo *RHSValNoInfo = NULL;
2230     VNInfo *RHSValNoInfo0 = RHS.getValNumInfo(0);
2231     unsigned RHSSrcReg = li_->getVNInfoSourceReg(RHSValNoInfo0);
2232     if (RHSSrcReg == 0 || RHSSrcReg != LHS.reg) {
2233       // If RHS is not defined as a copy from the LHS, we can use simpler and
2234       // faster checks to see if the live ranges are coalescable.  This joiner
2235       // can't swap the LHS/RHS intervals though.
2236       if (!TargetRegisterInfo::isPhysicalRegister(RHS.reg)) {
2237         return SimpleJoin(LHS, RHS);
2238       } else {
2239         RHSValNoInfo = RHSValNoInfo0;
2240       }
2241     } else {
2242       // It was defined as a copy from the LHS, find out what value # it is.
2243       RHSValNoInfo =
2244         LHS.getLiveRangeContaining(RHSValNoInfo0->def.getPrevSlot())->valno;
2245       RHSValID = RHSValNoInfo->id;
2246       RHSVal0DefinedFromLHS = RHSValID;
2247     }
2248
2249     LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
2250     RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
2251     NewVNInfo.resize(LHS.getNumValNums(), NULL);
2252
2253     // Okay, *all* of the values in LHS that are defined as a copy from RHS
2254     // should now get updated.
2255     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
2256          i != e; ++i) {
2257       VNInfo *VNI = *i;
2258       unsigned VN = VNI->id;
2259       if (unsigned LHSSrcReg = li_->getVNInfoSourceReg(VNI)) {
2260         if (LHSSrcReg != RHS.reg) {
2261           // If this is not a copy from the RHS, its value number will be
2262           // unmodified by the coalescing.
2263           NewVNInfo[VN] = VNI;
2264           LHSValNoAssignments[VN] = VN;
2265         } else if (RHSValID == -1) {
2266           // Otherwise, it is a copy from the RHS, and we don't already have a
2267           // value# for it.  Keep the current value number, but remember it.
2268           LHSValNoAssignments[VN] = RHSValID = VN;
2269           NewVNInfo[VN] = RHSValNoInfo;
2270           LHSValsDefinedFromRHS[VNI] = RHSValNoInfo0;
2271         } else {
2272           // Otherwise, use the specified value #.
2273           LHSValNoAssignments[VN] = RHSValID;
2274           if (VN == (unsigned)RHSValID) {  // Else this val# is dead.
2275             NewVNInfo[VN] = RHSValNoInfo;
2276             LHSValsDefinedFromRHS[VNI] = RHSValNoInfo0;
2277           }
2278         }
2279       } else {
2280         NewVNInfo[VN] = VNI;
2281         LHSValNoAssignments[VN] = VN;
2282       }
2283     }
2284
2285     assert(RHSValID != -1 && "Didn't find value #?");
2286     RHSValNoAssignments[0] = RHSValID;
2287     if (RHSVal0DefinedFromLHS != -1) {
2288       // This path doesn't go through ComputeUltimateVN so just set
2289       // it to anything.
2290       RHSValsDefinedFromLHS[RHSValNoInfo0] = (VNInfo*)1;
2291     }
2292   } else {
2293     // Loop over the value numbers of the LHS, seeing if any are defined from
2294     // the RHS.
2295     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
2296          i != e; ++i) {
2297       VNInfo *VNI = *i;
2298       if (VNI->isUnused() || VNI->getCopy() == 0)  // Src not defined by a copy?
2299         continue;
2300
2301       // DstReg is known to be a register in the LHS interval.  If the src is
2302       // from the RHS interval, we can use its value #.
2303       if (li_->getVNInfoSourceReg(VNI) != RHS.reg)
2304         continue;
2305
2306       // Figure out the value # from the RHS.
2307       LiveRange *lr = RHS.getLiveRangeContaining(VNI->def.getPrevSlot());
2308       assert(lr && "Cannot find live range");
2309       LHSValsDefinedFromRHS[VNI] = lr->valno;
2310     }
2311
2312     // Loop over the value numbers of the RHS, seeing if any are defined from
2313     // the LHS.
2314     for (LiveInterval::vni_iterator i = RHS.vni_begin(), e = RHS.vni_end();
2315          i != e; ++i) {
2316       VNInfo *VNI = *i;
2317       if (VNI->isUnused() || VNI->getCopy() == 0)  // Src not defined by a copy?
2318         continue;
2319
2320       // DstReg is known to be a register in the RHS interval.  If the src is
2321       // from the LHS interval, we can use its value #.
2322       if (li_->getVNInfoSourceReg(VNI) != LHS.reg)
2323         continue;
2324
2325       // Figure out the value # from the LHS.
2326       LiveRange *lr = LHS.getLiveRangeContaining(VNI->def.getPrevSlot());
2327       assert(lr && "Cannot find live range");
2328       RHSValsDefinedFromLHS[VNI] = lr->valno;
2329     }
2330
2331     LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
2332     RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
2333     NewVNInfo.reserve(LHS.getNumValNums() + RHS.getNumValNums());
2334
2335     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
2336          i != e; ++i) {
2337       VNInfo *VNI = *i;
2338       unsigned VN = VNI->id;
2339       if (LHSValNoAssignments[VN] >= 0 || VNI->isUnused())
2340         continue;
2341       ComputeUltimateVN(VNI, NewVNInfo,
2342                         LHSValsDefinedFromRHS, RHSValsDefinedFromLHS,
2343                         LHSValNoAssignments, RHSValNoAssignments);
2344     }
2345     for (LiveInterval::vni_iterator i = RHS.vni_begin(), e = RHS.vni_end();
2346          i != e; ++i) {
2347       VNInfo *VNI = *i;
2348       unsigned VN = VNI->id;
2349       if (RHSValNoAssignments[VN] >= 0 || VNI->isUnused())
2350         continue;
2351       // If this value number isn't a copy from the LHS, it's a new number.
2352       if (RHSValsDefinedFromLHS.find(VNI) == RHSValsDefinedFromLHS.end()) {
2353         NewVNInfo.push_back(VNI);
2354         RHSValNoAssignments[VN] = NewVNInfo.size()-1;
2355         continue;
2356       }
2357
2358       ComputeUltimateVN(VNI, NewVNInfo,
2359                         RHSValsDefinedFromLHS, LHSValsDefinedFromRHS,
2360                         RHSValNoAssignments, LHSValNoAssignments);
2361     }
2362   }
2363
2364   // Armed with the mappings of LHS/RHS values to ultimate values, walk the
2365   // interval lists to see if these intervals are coalescable.
2366   LiveInterval::const_iterator I = LHS.begin();
2367   LiveInterval::const_iterator IE = LHS.end();
2368   LiveInterval::const_iterator J = RHS.begin();
2369   LiveInterval::const_iterator JE = RHS.end();
2370
2371   // Skip ahead until the first place of potential sharing.
2372   if (I->start < J->start) {
2373     I = std::upper_bound(I, IE, J->start);
2374     if (I != LHS.begin()) --I;
2375   } else if (J->start < I->start) {
2376     J = std::upper_bound(J, JE, I->start);
2377     if (J != RHS.begin()) --J;
2378   }
2379
2380   while (1) {
2381     // Determine if these two live ranges overlap.
2382     bool Overlaps;
2383     if (I->start < J->start) {
2384       Overlaps = I->end > J->start;
2385     } else {
2386       Overlaps = J->end > I->start;
2387     }
2388
2389     // If so, check value # info to determine if they are really different.
2390     if (Overlaps) {
2391       // If the live range overlap will map to the same value number in the
2392       // result liverange, we can still coalesce them.  If not, we can't.
2393       if (LHSValNoAssignments[I->valno->id] !=
2394           RHSValNoAssignments[J->valno->id])
2395         return false;
2396       // If it's re-defined by an early clobber somewhere in the live range,
2397       // then conservatively abort coalescing.
2398       if (NewVNInfo[LHSValNoAssignments[I->valno->id]]->hasRedefByEC())
2399         return false;
2400     }
2401
2402     if (I->end < J->end) {
2403       ++I;
2404       if (I == IE) break;
2405     } else {
2406       ++J;
2407       if (J == JE) break;
2408     }
2409   }
2410
2411   // Update kill info. Some live ranges are extended due to copy coalescing.
2412   for (DenseMap<VNInfo*, VNInfo*>::iterator I = LHSValsDefinedFromRHS.begin(),
2413          E = LHSValsDefinedFromRHS.end(); I != E; ++I) {
2414     VNInfo *VNI = I->first;
2415     unsigned LHSValID = LHSValNoAssignments[VNI->id];
2416     NewVNInfo[LHSValID]->removeKill(VNI->def);
2417     if (VNI->hasPHIKill())
2418       NewVNInfo[LHSValID]->setHasPHIKill(true);
2419     RHS.addKills(NewVNInfo[LHSValID], VNI->kills);
2420   }
2421
2422   // Update kill info. Some live ranges are extended due to copy coalescing.
2423   for (DenseMap<VNInfo*, VNInfo*>::iterator I = RHSValsDefinedFromLHS.begin(),
2424          E = RHSValsDefinedFromLHS.end(); I != E; ++I) {
2425     VNInfo *VNI = I->first;
2426     unsigned RHSValID = RHSValNoAssignments[VNI->id];
2427     NewVNInfo[RHSValID]->removeKill(VNI->def);
2428     if (VNI->hasPHIKill())
2429       NewVNInfo[RHSValID]->setHasPHIKill(true);
2430     LHS.addKills(NewVNInfo[RHSValID], VNI->kills);
2431   }
2432
2433   // If we get here, we know that we can coalesce the live ranges.  Ask the
2434   // intervals to coalesce themselves now.
2435   if ((RHS.ranges.size() > LHS.ranges.size() &&
2436       TargetRegisterInfo::isVirtualRegister(LHS.reg)) ||
2437       TargetRegisterInfo::isPhysicalRegister(RHS.reg)) {
2438     RHS.join(LHS, &RHSValNoAssignments[0], &LHSValNoAssignments[0], NewVNInfo,
2439              mri_);
2440     Swapped = true;
2441   } else {
2442     LHS.join(RHS, &LHSValNoAssignments[0], &RHSValNoAssignments[0], NewVNInfo,
2443              mri_);
2444     Swapped = false;
2445   }
2446   return true;
2447 }
2448
2449 namespace {
2450   // DepthMBBCompare - Comparison predicate that sort first based on the loop
2451   // depth of the basic block (the unsigned), and then on the MBB number.
2452   struct DepthMBBCompare {
2453     typedef std::pair<unsigned, MachineBasicBlock*> DepthMBBPair;
2454     bool operator()(const DepthMBBPair &LHS, const DepthMBBPair &RHS) const {
2455       // Deeper loops first
2456       if (LHS.first != RHS.first)
2457         return LHS.first > RHS.first;
2458
2459       // Prefer blocks that are more connected in the CFG. This takes care of
2460       // the most difficult copies first while intervals are short.
2461       unsigned cl = LHS.second->pred_size() + LHS.second->succ_size();
2462       unsigned cr = RHS.second->pred_size() + RHS.second->succ_size();
2463       if (cl != cr)
2464         return cl > cr;
2465
2466       // As a last resort, sort by block number.
2467       return LHS.second->getNumber() < RHS.second->getNumber();
2468     }
2469   };
2470 }
2471
2472 void SimpleRegisterCoalescing::CopyCoalesceInMBB(MachineBasicBlock *MBB,
2473                                                std::vector<CopyRec> &TryAgain) {
2474   DEBUG(dbgs() << MBB->getName() << ":\n");
2475
2476   std::vector<CopyRec> VirtCopies;
2477   std::vector<CopyRec> PhysCopies;
2478   std::vector<CopyRec> ImpDefCopies;
2479   for (MachineBasicBlock::iterator MII = MBB->begin(), E = MBB->end();
2480        MII != E;) {
2481     MachineInstr *Inst = MII++;
2482
2483     // If this isn't a copy nor a extract_subreg, we can't join intervals.
2484     unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
2485     bool isInsUndef = false;
2486     if (Inst->isExtractSubreg()) {
2487       DstReg = Inst->getOperand(0).getReg();
2488       SrcReg = Inst->getOperand(1).getReg();
2489     } else if (Inst->isInsertSubreg()) {
2490       DstReg = Inst->getOperand(0).getReg();
2491       SrcReg = Inst->getOperand(2).getReg();
2492       if (Inst->getOperand(1).isUndef())
2493         isInsUndef = true;
2494     } else if (Inst->isInsertSubreg() || Inst->isSubregToReg()) {
2495       DstReg = Inst->getOperand(0).getReg();
2496       SrcReg = Inst->getOperand(2).getReg();
2497     } else if (!tii_->isMoveInstr(*Inst, SrcReg, DstReg, SrcSubIdx, DstSubIdx))
2498       continue;
2499
2500     bool SrcIsPhys = TargetRegisterInfo::isPhysicalRegister(SrcReg);
2501     bool DstIsPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
2502     if (isInsUndef ||
2503         (li_->hasInterval(SrcReg) && li_->getInterval(SrcReg).empty()))
2504       ImpDefCopies.push_back(CopyRec(Inst, 0));
2505     else if (SrcIsPhys || DstIsPhys)
2506       PhysCopies.push_back(CopyRec(Inst, 0));
2507     else
2508       VirtCopies.push_back(CopyRec(Inst, 0));
2509   }
2510
2511   // Try coalescing implicit copies and insert_subreg <undef> first,
2512   // followed by copies to / from physical registers, then finally copies
2513   // from virtual registers to virtual registers.
2514   for (unsigned i = 0, e = ImpDefCopies.size(); i != e; ++i) {
2515     CopyRec &TheCopy = ImpDefCopies[i];
2516     bool Again = false;
2517     if (!JoinCopy(TheCopy, Again))
2518       if (Again)
2519         TryAgain.push_back(TheCopy);
2520   }
2521   for (unsigned i = 0, e = PhysCopies.size(); i != e; ++i) {
2522     CopyRec &TheCopy = PhysCopies[i];
2523     bool Again = false;
2524     if (!JoinCopy(TheCopy, Again))
2525       if (Again)
2526         TryAgain.push_back(TheCopy);
2527   }
2528   for (unsigned i = 0, e = VirtCopies.size(); i != e; ++i) {
2529     CopyRec &TheCopy = VirtCopies[i];
2530     bool Again = false;
2531     if (!JoinCopy(TheCopy, Again))
2532       if (Again)
2533         TryAgain.push_back(TheCopy);
2534   }
2535 }
2536
2537 void SimpleRegisterCoalescing::joinIntervals() {
2538   DEBUG(dbgs() << "********** JOINING INTERVALS ***********\n");
2539
2540   std::vector<CopyRec> TryAgainList;
2541   if (loopInfo->empty()) {
2542     // If there are no loops in the function, join intervals in function order.
2543     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();
2544          I != E; ++I)
2545       CopyCoalesceInMBB(I, TryAgainList);
2546   } else {
2547     // Otherwise, join intervals in inner loops before other intervals.
2548     // Unfortunately we can't just iterate over loop hierarchy here because
2549     // there may be more MBB's than BB's.  Collect MBB's for sorting.
2550
2551     // Join intervals in the function prolog first. We want to join physical
2552     // registers with virtual registers before the intervals got too long.
2553     std::vector<std::pair<unsigned, MachineBasicBlock*> > MBBs;
2554     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();I != E;++I){
2555       MachineBasicBlock *MBB = I;
2556       MBBs.push_back(std::make_pair(loopInfo->getLoopDepth(MBB), I));
2557     }
2558
2559     // Sort by loop depth.
2560     std::sort(MBBs.begin(), MBBs.end(), DepthMBBCompare());
2561
2562     // Finally, join intervals in loop nest order.
2563     for (unsigned i = 0, e = MBBs.size(); i != e; ++i)
2564       CopyCoalesceInMBB(MBBs[i].second, TryAgainList);
2565   }
2566
2567   // Joining intervals can allow other intervals to be joined.  Iteratively join
2568   // until we make no progress.
2569   bool ProgressMade = true;
2570   while (ProgressMade) {
2571     ProgressMade = false;
2572
2573     for (unsigned i = 0, e = TryAgainList.size(); i != e; ++i) {
2574       CopyRec &TheCopy = TryAgainList[i];
2575       if (!TheCopy.MI)
2576         continue;
2577
2578       bool Again = false;
2579       bool Success = JoinCopy(TheCopy, Again);
2580       if (Success || !Again) {
2581         TheCopy.MI = 0;   // Mark this one as done.
2582         ProgressMade = true;
2583       }
2584     }
2585   }
2586 }
2587
2588 /// Return true if the two specified registers belong to different register
2589 /// classes.  The registers may be either phys or virt regs.
2590 bool
2591 SimpleRegisterCoalescing::differingRegisterClasses(unsigned RegA,
2592                                                    unsigned RegB) const {
2593   // Get the register classes for the first reg.
2594   if (TargetRegisterInfo::isPhysicalRegister(RegA)) {
2595     assert(TargetRegisterInfo::isVirtualRegister(RegB) &&
2596            "Shouldn't consider two physregs!");
2597     return !mri_->getRegClass(RegB)->contains(RegA);
2598   }
2599
2600   // Compare against the regclass for the second reg.
2601   const TargetRegisterClass *RegClassA = mri_->getRegClass(RegA);
2602   if (TargetRegisterInfo::isVirtualRegister(RegB)) {
2603     const TargetRegisterClass *RegClassB = mri_->getRegClass(RegB);
2604     return RegClassA != RegClassB;
2605   }
2606   return !RegClassA->contains(RegB);
2607 }
2608
2609 /// lastRegisterUse - Returns the last (non-debug) use of the specific register
2610 /// between cycles Start and End or NULL if there are no uses.
2611 MachineOperand *
2612 SimpleRegisterCoalescing::lastRegisterUse(SlotIndex Start,
2613                                           SlotIndex End,
2614                                           unsigned Reg,
2615                                           SlotIndex &UseIdx) const{
2616   UseIdx = SlotIndex();
2617   if (TargetRegisterInfo::isVirtualRegister(Reg)) {
2618     MachineOperand *LastUse = NULL;
2619     for (MachineRegisterInfo::use_nodbg_iterator I = mri_->use_nodbg_begin(Reg),
2620            E = mri_->use_nodbg_end(); I != E; ++I) {
2621       MachineOperand &Use = I.getOperand();
2622       MachineInstr *UseMI = Use.getParent();
2623       unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
2624       if (tii_->isMoveInstr(*UseMI, SrcReg, DstReg, SrcSubIdx, DstSubIdx) &&
2625           SrcReg == DstReg)
2626         // Ignore identity copies.
2627         continue;
2628       SlotIndex Idx = li_->getInstructionIndex(UseMI);
2629       // FIXME: Should this be Idx != UseIdx? SlotIndex() will return something
2630       // that compares higher than any other interval.
2631       if (Idx >= Start && Idx < End && Idx >= UseIdx) {
2632         LastUse = &Use;
2633         UseIdx = Idx.getUseIndex();
2634       }
2635     }
2636     return LastUse;
2637   }
2638
2639   SlotIndex s = Start;
2640   SlotIndex e = End.getPrevSlot().getBaseIndex();
2641   while (e >= s) {
2642     // Skip deleted instructions
2643     MachineInstr *MI = li_->getInstructionFromIndex(e);
2644     while (e != SlotIndex() && e.getPrevIndex() >= s && !MI) {
2645       e = e.getPrevIndex();
2646       MI = li_->getInstructionFromIndex(e);
2647     }
2648     if (e < s || MI == NULL)
2649       return NULL;
2650
2651     // Ignore identity copies.
2652     unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
2653     if (!(tii_->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx) &&
2654           SrcReg == DstReg))
2655       for (unsigned i = 0, NumOps = MI->getNumOperands(); i != NumOps; ++i) {
2656         MachineOperand &Use = MI->getOperand(i);
2657         if (Use.isReg() && Use.isUse() && Use.getReg() &&
2658             tri_->regsOverlap(Use.getReg(), Reg)) {
2659           UseIdx = e.getUseIndex();
2660           return &Use;
2661         }
2662       }
2663
2664     e = e.getPrevIndex();
2665   }
2666
2667   return NULL;
2668 }
2669
2670 void SimpleRegisterCoalescing::printRegName(unsigned reg) const {
2671   if (TargetRegisterInfo::isPhysicalRegister(reg))
2672     dbgs() << tri_->getName(reg);
2673   else
2674     dbgs() << "%reg" << reg;
2675 }
2676
2677 void SimpleRegisterCoalescing::releaseMemory() {
2678   JoinedCopies.clear();
2679   ReMatCopies.clear();
2680   ReMatDefs.clear();
2681 }
2682
2683 bool SimpleRegisterCoalescing::runOnMachineFunction(MachineFunction &fn) {
2684   mf_ = &fn;
2685   mri_ = &fn.getRegInfo();
2686   tm_ = &fn.getTarget();
2687   tri_ = tm_->getRegisterInfo();
2688   tii_ = tm_->getInstrInfo();
2689   li_ = &getAnalysis<LiveIntervals>();
2690   AA = &getAnalysis<AliasAnalysis>();
2691   loopInfo = &getAnalysis<MachineLoopInfo>();
2692
2693   DEBUG(dbgs() << "********** SIMPLE REGISTER COALESCING **********\n"
2694                << "********** Function: "
2695                << ((Value*)mf_->getFunction())->getName() << '\n');
2696
2697   allocatableRegs_ = tri_->getAllocatableSet(fn);
2698   for (TargetRegisterInfo::regclass_iterator I = tri_->regclass_begin(),
2699          E = tri_->regclass_end(); I != E; ++I)
2700     allocatableRCRegs_.insert(std::make_pair(*I,
2701                                              tri_->getAllocatableSet(fn, *I)));
2702
2703   // Join (coalesce) intervals if requested.
2704   if (EnableJoining) {
2705     joinIntervals();
2706     DEBUG({
2707         dbgs() << "********** INTERVALS POST JOINING **********\n";
2708         for (LiveIntervals::iterator I = li_->begin(), E = li_->end();
2709              I != E; ++I){
2710           I->second->print(dbgs(), tri_);
2711           dbgs() << "\n";
2712         }
2713       });
2714   }
2715
2716   // Perform a final pass over the instructions and compute spill weights
2717   // and remove identity moves.
2718   SmallVector<unsigned, 4> DeadDefs;
2719   for (MachineFunction::iterator mbbi = mf_->begin(), mbbe = mf_->end();
2720        mbbi != mbbe; ++mbbi) {
2721     MachineBasicBlock* mbb = mbbi;
2722     for (MachineBasicBlock::iterator mii = mbb->begin(), mie = mbb->end();
2723          mii != mie; ) {
2724       MachineInstr *MI = mii;
2725       unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
2726       if (JoinedCopies.count(MI)) {
2727         // Delete all coalesced copies.
2728         bool DoDelete = true;
2729         if (!tii_->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx)) {
2730           assert((MI->isExtractSubreg() || MI->isInsertSubreg() ||
2731                   MI->isSubregToReg()) && "Unrecognized copy instruction");
2732           DstReg = MI->getOperand(0).getReg();
2733           if (TargetRegisterInfo::isPhysicalRegister(DstReg))
2734             // Do not delete extract_subreg, insert_subreg of physical
2735             // registers unless the definition is dead. e.g.
2736             // %DO<def> = INSERT_SUBREG %D0<undef>, %S0<kill>, 1
2737             // or else the scavenger may complain. LowerSubregs will
2738             // delete them later.
2739             DoDelete = false;
2740         }
2741         if (MI->registerDefIsDead(DstReg)) {
2742           LiveInterval &li = li_->getInterval(DstReg);
2743           if (!ShortenDeadCopySrcLiveRange(li, MI))
2744             ShortenDeadCopyLiveRange(li, MI);
2745           DoDelete = true;
2746         }
2747         if (!DoDelete)
2748           mii = llvm::next(mii);
2749         else {
2750           li_->RemoveMachineInstrFromMaps(MI);
2751           mii = mbbi->erase(mii);
2752           ++numPeep;
2753         }
2754         continue;
2755       }
2756
2757       // Now check if this is a remat'ed def instruction which is now dead.
2758       if (ReMatDefs.count(MI)) {
2759         bool isDead = true;
2760         for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
2761           const MachineOperand &MO = MI->getOperand(i);
2762           if (!MO.isReg())
2763             continue;
2764           unsigned Reg = MO.getReg();
2765           if (!Reg)
2766             continue;
2767           if (TargetRegisterInfo::isVirtualRegister(Reg))
2768             DeadDefs.push_back(Reg);
2769           if (MO.isDead())
2770             continue;
2771           if (TargetRegisterInfo::isPhysicalRegister(Reg) ||
2772               !mri_->use_nodbg_empty(Reg)) {
2773             isDead = false;
2774             break;
2775           }
2776         }
2777         if (isDead) {
2778           while (!DeadDefs.empty()) {
2779             unsigned DeadDef = DeadDefs.back();
2780             DeadDefs.pop_back();
2781             RemoveDeadDef(li_->getInterval(DeadDef), MI);
2782           }
2783           li_->RemoveMachineInstrFromMaps(mii);
2784           mii = mbbi->erase(mii);
2785           continue;
2786         } else
2787           DeadDefs.clear();
2788       }
2789
2790       // If the move will be an identity move delete it
2791       bool isMove= tii_->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx);
2792       if (isMove && SrcReg == DstReg) {
2793         if (li_->hasInterval(SrcReg)) {
2794           LiveInterval &RegInt = li_->getInterval(SrcReg);
2795           // If def of this move instruction is dead, remove its live range
2796           // from the dstination register's live interval.
2797           if (MI->registerDefIsDead(DstReg)) {
2798             if (!ShortenDeadCopySrcLiveRange(RegInt, MI))
2799               ShortenDeadCopyLiveRange(RegInt, MI);
2800           }
2801         }
2802         li_->RemoveMachineInstrFromMaps(MI);
2803         mii = mbbi->erase(mii);
2804         ++numPeep;
2805       } else {
2806         ++mii;
2807       }
2808     }
2809   }
2810
2811   DEBUG(dump());
2812   return true;
2813 }
2814
2815 /// print - Implement the dump method.
2816 void SimpleRegisterCoalescing::print(raw_ostream &O, const Module* m) const {
2817    li_->print(O, m);
2818 }
2819
2820 RegisterCoalescer* llvm::createSimpleRegisterCoalescer() {
2821   return new SimpleRegisterCoalescing();
2822 }
2823
2824 // Make sure that anything that uses RegisterCoalescer pulls in this file...
2825 DEFINING_FILE_FOR(SimpleRegisterCoalescing)