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