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