Fix PR1798 - an error in the evaluation of SCEVAddRecExpr at an
[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/CodeGen/LiveVariables.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/Support/CommandLine.h"
30 #include "llvm/Support/Debug.h"
31 #include "llvm/ADT/SmallSet.h"
32 #include "llvm/ADT/Statistic.h"
33 #include "llvm/ADT/STLExtras.h"
34 #include <algorithm>
35 #include <cmath>
36 using namespace llvm;
37
38 STATISTIC(numJoins    , "Number of interval joins performed");
39 STATISTIC(numPeep     , "Number of identity moves eliminated after coalescing");
40 STATISTIC(numAborts   , "Number of times interval joining aborted");
41
42 char SimpleRegisterCoalescing::ID = 0;
43 namespace {
44   static cl::opt<bool>
45   EnableJoining("join-liveintervals",
46                 cl::desc("Coalesce copies (default=true)"),
47                 cl::init(true));
48
49   static cl::opt<bool>
50   NewHeuristic("new-coalescer-heuristic",
51                 cl::desc("Use new coalescer heuristic"),
52                 cl::init(false));
53
54   RegisterPass<SimpleRegisterCoalescing> 
55   X("simple-register-coalescing", "Simple Register Coalescing");
56
57   // Declare that we implement the RegisterCoalescer interface
58   RegisterAnalysisGroup<RegisterCoalescer, true/*The Default*/> V(X);
59 }
60
61 const PassInfo *llvm::SimpleRegisterCoalescingID = X.getPassInfo();
62
63 void SimpleRegisterCoalescing::getAnalysisUsage(AnalysisUsage &AU) const {
64   AU.addPreserved<LiveIntervals>();
65   AU.addPreserved<MachineLoopInfo>();
66   AU.addPreservedID(MachineDominatorsID);
67   AU.addPreservedID(PHIEliminationID);
68   AU.addPreservedID(TwoAddressInstructionPassID);
69   AU.addRequired<LiveVariables>();
70   AU.addRequired<LiveIntervals>();
71   AU.addRequired<MachineLoopInfo>();
72   MachineFunctionPass::getAnalysisUsage(AU);
73 }
74
75 /// AdjustCopiesBackFrom - We found a non-trivially-coalescable copy with IntA
76 /// being the source and IntB being the dest, thus this defines a value number
77 /// in IntB.  If the source value number (in IntA) is defined by a copy from B,
78 /// see if we can merge these two pieces of B into a single value number,
79 /// eliminating a copy.  For example:
80 ///
81 ///  A3 = B0
82 ///    ...
83 ///  B1 = A3      <- this copy
84 ///
85 /// In this case, B0 can be extended to where the B1 copy lives, allowing the B1
86 /// value number to be replaced with B0 (which simplifies the B liveinterval).
87 ///
88 /// This returns true if an interval was modified.
89 ///
90 bool SimpleRegisterCoalescing::AdjustCopiesBackFrom(LiveInterval &IntA,
91                                                     LiveInterval &IntB,
92                                                     MachineInstr *CopyMI) {
93   unsigned CopyIdx = li_->getDefIndex(li_->getInstructionIndex(CopyMI));
94
95   // BValNo is a value number in B that is defined by a copy from A.  'B3' in
96   // the example above.
97   LiveInterval::iterator BLR = IntB.FindLiveRangeContaining(CopyIdx);
98   VNInfo *BValNo = BLR->valno;
99   
100   // Get the location that B is defined at.  Two options: either this value has
101   // an unknown definition point or it is defined at CopyIdx.  If unknown, we 
102   // can't process it.
103   if (!BValNo->reg) return false;
104   assert(BValNo->def == CopyIdx &&
105          "Copy doesn't define the value?");
106   
107   // AValNo is the value number in A that defines the copy, A0 in the example.
108   LiveInterval::iterator AValLR = IntA.FindLiveRangeContaining(CopyIdx-1);
109   VNInfo *AValNo = AValLR->valno;
110   
111   // If AValNo is defined as a copy from IntB, we can potentially process this.
112   
113   // Get the instruction that defines this value number.
114   unsigned SrcReg = AValNo->reg;
115   if (!SrcReg) return false;  // Not defined by a copy.
116     
117   // If the value number is not defined by a copy instruction, ignore it.
118     
119   // If the source register comes from an interval other than IntB, we can't
120   // handle this.
121   if (rep(SrcReg) != IntB.reg) return false;
122   
123   // Get the LiveRange in IntB that this value number starts with.
124   LiveInterval::iterator ValLR = IntB.FindLiveRangeContaining(AValNo->def-1);
125   
126   // Make sure that the end of the live range is inside the same block as
127   // CopyMI.
128   MachineInstr *ValLREndInst = li_->getInstructionFromIndex(ValLR->end-1);
129   if (!ValLREndInst || 
130       ValLREndInst->getParent() != CopyMI->getParent()) return false;
131
132   // Okay, we now know that ValLR ends in the same block that the CopyMI
133   // live-range starts.  If there are no intervening live ranges between them in
134   // IntB, we can merge them.
135   if (ValLR+1 != BLR) return false;
136
137   // If a live interval is a physical register, conservatively check if any
138   // of its sub-registers is overlapping the live interval of the virtual
139   // register. If so, do not coalesce.
140   if (TargetRegisterInfo::isPhysicalRegister(IntB.reg) &&
141       *tri_->getSubRegisters(IntB.reg)) {
142     for (const unsigned* SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR)
143       if (li_->hasInterval(*SR) && IntA.overlaps(li_->getInterval(*SR))) {
144         DOUT << "Interfere with sub-register ";
145         DEBUG(li_->getInterval(*SR).print(DOUT, tri_));
146         return false;
147       }
148   }
149   
150   DOUT << "\nExtending: "; IntB.print(DOUT, tri_);
151   
152   unsigned FillerStart = ValLR->end, FillerEnd = BLR->start;
153   // We are about to delete CopyMI, so need to remove it as the 'instruction
154   // that defines this value #'. Update the the valnum with the new defining
155   // instruction #.
156   BValNo->def = FillerStart;
157   BValNo->reg = 0;
158   
159   // Okay, we can merge them.  We need to insert a new liverange:
160   // [ValLR.end, BLR.begin) of either value number, then we merge the
161   // two value numbers.
162   IntB.addRange(LiveRange(FillerStart, FillerEnd, BValNo));
163
164   // If the IntB live range is assigned to a physical register, and if that
165   // physreg has aliases, 
166   if (TargetRegisterInfo::isPhysicalRegister(IntB.reg)) {
167     // Update the liveintervals of sub-registers.
168     for (const unsigned *AS = tri_->getSubRegisters(IntB.reg); *AS; ++AS) {
169       LiveInterval &AliasLI = li_->getInterval(*AS);
170       AliasLI.addRange(LiveRange(FillerStart, FillerEnd,
171               AliasLI.getNextValue(FillerStart, 0, li_->getVNInfoAllocator())));
172     }
173   }
174
175   // Okay, merge "B1" into the same value number as "B0".
176   if (BValNo != ValLR->valno)
177     IntB.MergeValueNumberInto(BValNo, ValLR->valno);
178   DOUT << "   result = "; IntB.print(DOUT, tri_);
179   DOUT << "\n";
180
181   // If the source instruction was killing the source register before the
182   // merge, unset the isKill marker given the live range has been extended.
183   int UIdx = ValLREndInst->findRegisterUseOperandIdx(IntB.reg, true);
184   if (UIdx != -1)
185     ValLREndInst->getOperand(UIdx).setIsKill(false);
186   
187   ++numPeep;
188   return true;
189 }
190
191 /// AddSubRegIdxPairs - Recursively mark all the registers represented by the
192 /// specified register as sub-registers. The recursion level is expected to be
193 /// shallow.
194 void SimpleRegisterCoalescing::AddSubRegIdxPairs(unsigned Reg, unsigned SubIdx) {
195   std::vector<unsigned> &JoinedRegs = r2rRevMap_[Reg];
196   for (unsigned i = 0, e = JoinedRegs.size(); i != e; ++i) {
197     SubRegIdxes.push_back(std::make_pair(JoinedRegs[i], SubIdx));
198     AddSubRegIdxPairs(JoinedRegs[i], SubIdx);
199   }
200 }
201
202 /// isBackEdgeCopy - Returns true if CopyMI is a back edge copy.
203 ///
204 bool SimpleRegisterCoalescing::isBackEdgeCopy(MachineInstr *CopyMI,
205                                               unsigned DstReg) {
206   MachineBasicBlock *MBB = CopyMI->getParent();
207   const MachineLoop *L = loopInfo->getLoopFor(MBB);
208   if (!L)
209     return false;
210   if (MBB != L->getLoopLatch())
211     return false;
212
213   DstReg = rep(DstReg);
214   LiveInterval &LI = li_->getInterval(DstReg);
215   unsigned DefIdx = li_->getInstructionIndex(CopyMI);
216   LiveInterval::const_iterator DstLR =
217     LI.FindLiveRangeContaining(li_->getDefIndex(DefIdx));
218   if (DstLR == LI.end())
219     return false;
220   unsigned KillIdx = li_->getInstructionIndex(&MBB->back()) + InstrSlots::NUM-1;
221   if (DstLR->valno->kills.size() == 1 && DstLR->valno->kills[0] == KillIdx)
222     return true;
223   return false;
224 }
225
226 /// JoinCopy - Attempt to join intervals corresponding to SrcReg/DstReg,
227 /// which are the src/dst of the copy instruction CopyMI.  This returns true
228 /// if the copy was successfully coalesced away. If it is not currently
229 /// possible to coalesce this interval, but it may be possible if other
230 /// things get coalesced, then it returns true by reference in 'Again'.
231 bool SimpleRegisterCoalescing::JoinCopy(CopyRec TheCopy, bool &Again) {
232   MachineInstr *CopyMI = TheCopy.MI;
233
234   Again = false;
235   if (JoinedCopies.count(CopyMI))
236     return false; // Already done.
237
238   DOUT << li_->getInstructionIndex(CopyMI) << '\t' << *CopyMI;
239
240   // Get representative registers.
241   unsigned SrcReg = TheCopy.SrcReg;
242   unsigned DstReg = TheCopy.DstReg;
243   unsigned repSrcReg = rep(SrcReg);
244   unsigned repDstReg = rep(DstReg);
245   
246   // If they are already joined we continue.
247   if (repSrcReg == repDstReg) {
248     DOUT << "\tCopy already coalesced.\n";
249     return false;  // Not coalescable.
250   }
251   
252   bool SrcIsPhys = TargetRegisterInfo::isPhysicalRegister(repSrcReg);
253   bool DstIsPhys = TargetRegisterInfo::isPhysicalRegister(repDstReg);
254
255   // If they are both physical registers, we cannot join them.
256   if (SrcIsPhys && DstIsPhys) {
257     DOUT << "\tCan not coalesce physregs.\n";
258     return false;  // Not coalescable.
259   }
260   
261   // We only join virtual registers with allocatable physical registers.
262   if (SrcIsPhys && !allocatableRegs_[repSrcReg]) {
263     DOUT << "\tSrc reg is unallocatable physreg.\n";
264     return false;  // Not coalescable.
265   }
266   if (DstIsPhys && !allocatableRegs_[repDstReg]) {
267     DOUT << "\tDst reg is unallocatable physreg.\n";
268     return false;  // Not coalescable.
269   }
270
271   bool isExtSubReg = CopyMI->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG;
272   unsigned RealDstReg = 0;
273   if (isExtSubReg) {
274     unsigned SubIdx = CopyMI->getOperand(2).getImm();
275     if (SrcIsPhys)
276       // r1024 = EXTRACT_SUBREG EAX, 0 then r1024 is really going to be
277       // coalesced with AX.
278       repSrcReg = tri_->getSubReg(repSrcReg, SubIdx);
279     else if (DstIsPhys) {
280       // If this is a extract_subreg where dst is a physical register, e.g.
281       // cl = EXTRACT_SUBREG reg1024, 1
282       // then create and update the actual physical register allocated to RHS.
283       const TargetRegisterClass *RC=mf_->getRegInfo().getRegClass(repSrcReg);
284       for (const unsigned *SRs = tri_->getSuperRegisters(repDstReg);
285            unsigned SR = *SRs; ++SRs) {
286         if (repDstReg == tri_->getSubReg(SR, SubIdx) &&
287             RC->contains(SR)) {
288           RealDstReg = SR;
289           break;
290         }
291       }
292       assert(RealDstReg && "Invalid extra_subreg instruction!");
293
294       // For this type of EXTRACT_SUBREG, conservatively
295       // check if the live interval of the source register interfere with the
296       // actual super physical register we are trying to coalesce with.
297       LiveInterval &RHS = li_->getInterval(repSrcReg);
298       if (li_->hasInterval(RealDstReg) &&
299           RHS.overlaps(li_->getInterval(RealDstReg))) {
300         DOUT << "Interfere with register ";
301         DEBUG(li_->getInterval(RealDstReg).print(DOUT, tri_));
302         return false; // Not coalescable
303       }
304       for (const unsigned* SR = tri_->getSubRegisters(RealDstReg); *SR; ++SR)
305         if (li_->hasInterval(*SR) && RHS.overlaps(li_->getInterval(*SR))) {
306           DOUT << "Interfere with sub-register ";
307           DEBUG(li_->getInterval(*SR).print(DOUT, tri_));
308           return false; // Not coalescable
309         }
310     } else {
311       unsigned SrcSize= li_->getInterval(repSrcReg).getSize() / InstrSlots::NUM;
312       unsigned DstSize= li_->getInterval(repDstReg).getSize() / InstrSlots::NUM;
313       const TargetRegisterClass *RC=mf_->getRegInfo().getRegClass(repDstReg);
314       unsigned Threshold = allocatableRCRegs_[RC].count();
315       // Be conservative. If both sides are virtual registers, do not coalesce
316       // if this will cause a high use density interval to target a smaller set
317       // of registers.
318       if (DstSize > Threshold || SrcSize > Threshold) {
319         LiveVariables::VarInfo &svi = lv_->getVarInfo(repSrcReg);
320         LiveVariables::VarInfo &dvi = lv_->getVarInfo(repDstReg);
321         if ((float)dvi.NumUses / DstSize < (float)svi.NumUses / SrcSize) {
322           Again = true;  // May be possible to coalesce later.
323           return false;
324         }
325       }
326     }
327   } else if (differingRegisterClasses(repSrcReg, repDstReg)) {
328     // If they are not of the same register class, we cannot join them.
329     DOUT << "\tSrc/Dest are different register classes.\n";
330     // Allow the coalescer to try again in case either side gets coalesced to
331     // a physical register that's compatible with the other side. e.g.
332     // r1024 = MOV32to32_ r1025
333     // but later r1024 is assigned EAX then r1025 may be coalesced with EAX.
334     Again = true;  // May be possible to coalesce later.
335     return false;
336   }
337   
338   LiveInterval &SrcInt = li_->getInterval(repSrcReg);
339   LiveInterval &DstInt = li_->getInterval(repDstReg);
340   assert(SrcInt.reg == repSrcReg && DstInt.reg == repDstReg &&
341          "Register mapping is horribly broken!");
342
343   DOUT << "\t\tInspecting "; SrcInt.print(DOUT, tri_);
344   DOUT << " and "; DstInt.print(DOUT, tri_);
345   DOUT << ": ";
346
347   // Check if it is necessary to propagate "isDead" property before intervals
348   // are joined.
349   MachineOperand *mopd = CopyMI->findRegisterDefOperand(DstReg);
350   bool isDead = mopd->isDead();
351   bool isShorten = false;
352   unsigned SrcStart = 0, RemoveStart = 0;
353   unsigned SrcEnd = 0, RemoveEnd = 0;
354   if (isDead) {
355     unsigned CopyIdx = li_->getInstructionIndex(CopyMI);
356     LiveInterval::iterator SrcLR =
357       SrcInt.FindLiveRangeContaining(li_->getUseIndex(CopyIdx));
358     RemoveStart = SrcStart = SrcLR->start;
359     RemoveEnd   = SrcEnd   = SrcLR->end;
360     // The instruction which defines the src is only truly dead if there are
361     // no intermediate uses and there isn't a use beyond the copy.
362     // FIXME: find the last use, mark is kill and shorten the live range.
363     if (SrcEnd > li_->getDefIndex(CopyIdx)) {
364       isDead = false;
365     } else {
366       MachineOperand *MOU;
367       MachineInstr *LastUse= lastRegisterUse(SrcStart, CopyIdx, repSrcReg, MOU);
368       if (LastUse) {
369         // Shorten the liveinterval to the end of last use.
370         MOU->setIsKill();
371         isDead = false;
372         isShorten = true;
373         RemoveStart = li_->getDefIndex(li_->getInstructionIndex(LastUse));
374         RemoveEnd   = SrcEnd;
375       } else {
376         MachineInstr *SrcMI = li_->getInstructionFromIndex(SrcStart);
377         if (SrcMI) {
378           MachineOperand *mops = findDefOperand(SrcMI, repSrcReg);
379           if (mops)
380             // A dead def should have a single cycle interval.
381             ++RemoveStart;
382         }
383       }
384     }
385   }
386
387   // We need to be careful about coalescing a source physical register with a
388   // virtual register. Once the coalescing is done, it cannot be broken and
389   // these are not spillable! If the destination interval uses are far away,
390   // think twice about coalescing them!
391   if (!mopd->isDead() && (SrcIsPhys || DstIsPhys) && !isExtSubReg) {
392     LiveInterval &JoinVInt = SrcIsPhys ? DstInt : SrcInt;
393     unsigned JoinVReg = SrcIsPhys ? repDstReg : repSrcReg;
394     unsigned JoinPReg = SrcIsPhys ? repSrcReg : repDstReg;
395     const TargetRegisterClass *RC = mf_->getRegInfo().getRegClass(JoinVReg);
396     unsigned Threshold = allocatableRCRegs_[RC].count() * 2;
397     if (TheCopy.isBackEdge)
398       Threshold *= 2; // Favors back edge copies.
399
400     // If the virtual register live interval is long but it has low use desity,
401     // do not join them, instead mark the physical register as its allocation
402     // preference.
403     unsigned Length = JoinVInt.getSize() / InstrSlots::NUM;
404     LiveVariables::VarInfo &vi = lv_->getVarInfo(JoinVReg);
405     if (Length > Threshold &&
406         (((float)vi.NumUses / Length) < (1.0 / Threshold))) {
407       JoinVInt.preference = JoinPReg;
408       ++numAborts;
409       DOUT << "\tMay tie down a physical register, abort!\n";
410       Again = true;  // May be possible to coalesce later.
411       return false;
412     }
413   }
414
415   // Okay, attempt to join these two intervals.  On failure, this returns false.
416   // Otherwise, if one of the intervals being joined is a physreg, this method
417   // always canonicalizes DstInt to be it.  The output "SrcInt" will not have
418   // been modified, so we can use this information below to update aliases.
419   bool Swapped = false;
420   if (JoinIntervals(DstInt, SrcInt, Swapped)) {
421     if (isDead) {
422       // Result of the copy is dead. Propagate this property.
423       if (SrcStart == 0) {
424         assert(TargetRegisterInfo::isPhysicalRegister(repSrcReg) &&
425                "Live-in must be a physical register!");
426         // Live-in to the function but dead. Remove it from entry live-in set.
427         // JoinIntervals may end up swapping the two intervals.
428         mf_->begin()->removeLiveIn(repSrcReg);
429       } else {
430         MachineInstr *SrcMI = li_->getInstructionFromIndex(SrcStart);
431         if (SrcMI) {
432           MachineOperand *mops = findDefOperand(SrcMI, repSrcReg);
433           if (mops)
434             mops->setIsDead();
435         }
436       }
437     }
438
439     if (isShorten || isDead) {
440       // Shorten the destination live interval.
441       if (Swapped)
442         SrcInt.removeRange(RemoveStart, RemoveEnd);
443     }
444   } else {
445     // Coalescing failed.
446     
447     // If we can eliminate the copy without merging the live ranges, do so now.
448     if (!isExtSubReg && AdjustCopiesBackFrom(SrcInt, DstInt, CopyMI)) {
449       JoinedCopies.insert(CopyMI);
450       return true;
451     }
452
453     // Otherwise, we are unable to join the intervals.
454     DOUT << "Interference!\n";
455     Again = true;  // May be possible to coalesce later.
456     return false;
457   }
458
459   LiveInterval *ResSrcInt = &SrcInt;
460   LiveInterval *ResDstInt = &DstInt;
461   if (Swapped) {
462     std::swap(repSrcReg, repDstReg);
463     std::swap(ResSrcInt, ResDstInt);
464   }
465   assert(TargetRegisterInfo::isVirtualRegister(repSrcReg) &&
466          "LiveInterval::join didn't work right!");
467                                
468   // If we're about to merge live ranges into a physical register live range,
469   // we have to update any aliased register's live ranges to indicate that they
470   // have clobbered values for this range.
471   if (TargetRegisterInfo::isPhysicalRegister(repDstReg)) {
472     // Unset unnecessary kills.
473     if (!ResDstInt->containsOneValue()) {
474       for (LiveInterval::Ranges::const_iterator I = ResSrcInt->begin(),
475              E = ResSrcInt->end(); I != E; ++I)
476         unsetRegisterKills(I->start, I->end, repDstReg);
477     }
478
479     // If this is a extract_subreg where dst is a physical register, e.g.
480     // cl = EXTRACT_SUBREG reg1024, 1
481     // then create and update the actual physical register allocated to RHS.
482     if (RealDstReg) {
483       LiveInterval &RealDstInt = li_->getOrCreateInterval(RealDstReg);
484       SmallSet<const VNInfo*, 4> CopiedValNos;
485       for (LiveInterval::Ranges::const_iterator I = ResSrcInt->ranges.begin(),
486              E = ResSrcInt->ranges.end(); I != E; ++I) {
487         LiveInterval::const_iterator DstLR =
488           ResDstInt->FindLiveRangeContaining(I->start);
489         assert(DstLR != ResDstInt->end() && "Invalid joined interval!");
490         const VNInfo *DstValNo = DstLR->valno;
491         if (CopiedValNos.insert(DstValNo)) {
492           VNInfo *ValNo = RealDstInt.getNextValue(DstValNo->def, DstValNo->reg,
493                                                   li_->getVNInfoAllocator());
494           ValNo->hasPHIKill = DstValNo->hasPHIKill;
495           RealDstInt.addKills(ValNo, DstValNo->kills);
496           RealDstInt.MergeValueInAsValue(*ResDstInt, DstValNo, ValNo);
497         }
498       }
499       repDstReg = RealDstReg;
500     }
501
502     // Update the liveintervals of sub-registers.
503     for (const unsigned *AS = tri_->getSubRegisters(repDstReg); *AS; ++AS)
504       li_->getOrCreateInterval(*AS).MergeInClobberRanges(*ResSrcInt,
505                                                  li_->getVNInfoAllocator());
506   } else {
507     // Merge use info if the destination is a virtual register.
508     LiveVariables::VarInfo& dVI = lv_->getVarInfo(repDstReg);
509     LiveVariables::VarInfo& sVI = lv_->getVarInfo(repSrcReg);
510     dVI.NumUses += sVI.NumUses;
511   }
512
513   // Remember these liveintervals have been joined.
514   JoinedLIs.set(repSrcReg - TargetRegisterInfo::FirstVirtualRegister);
515   if (TargetRegisterInfo::isVirtualRegister(repDstReg))
516     JoinedLIs.set(repDstReg - TargetRegisterInfo::FirstVirtualRegister);
517
518   if (isExtSubReg && !SrcIsPhys && !DstIsPhys) {
519     if (!Swapped) {
520       // Make sure we allocate the larger super-register.
521       ResSrcInt->Copy(*ResDstInt, li_->getVNInfoAllocator());
522       std::swap(repSrcReg, repDstReg);
523       std::swap(ResSrcInt, ResDstInt);
524     }
525     unsigned SubIdx = CopyMI->getOperand(2).getImm();
526     SubRegIdxes.push_back(std::make_pair(repSrcReg, SubIdx));
527     AddSubRegIdxPairs(repSrcReg, SubIdx);
528   }
529
530   if (NewHeuristic) {
531     for (LiveInterval::const_vni_iterator i = ResSrcInt->vni_begin(),
532            e = ResSrcInt->vni_end(); i != e; ++i) {
533       const VNInfo *vni = *i;
534       if (vni->def && vni->def != ~1U && vni->def != ~0U) {
535         MachineInstr *CopyMI = li_->getInstructionFromIndex(vni->def);
536         unsigned SrcReg, DstReg;
537         if (CopyMI && tii_->isMoveInstr(*CopyMI, SrcReg, DstReg) &&
538             JoinedCopies.count(CopyMI) == 0) {
539           unsigned LoopDepth = loopInfo->getLoopDepth(CopyMI->getParent());
540           JoinQueue->push(CopyRec(CopyMI, SrcReg, DstReg, LoopDepth,
541                                   isBackEdgeCopy(CopyMI, DstReg)));
542         }
543       }
544     }
545   }
546
547   DOUT << "\n\t\tJoined.  Result = "; ResDstInt->print(DOUT, tri_);
548   DOUT << "\n";
549
550   // repSrcReg is guarateed to be the register whose live interval that is
551   // being merged.
552   li_->removeInterval(repSrcReg);
553   r2rMap_[repSrcReg] = repDstReg;
554   r2rRevMap_[repDstReg].push_back(repSrcReg);
555
556   // Finally, delete the copy instruction.
557   JoinedCopies.insert(CopyMI);
558   ++numPeep;
559   ++numJoins;
560   return true;
561 }
562
563 /// ComputeUltimateVN - Assuming we are going to join two live intervals,
564 /// compute what the resultant value numbers for each value in the input two
565 /// ranges will be.  This is complicated by copies between the two which can
566 /// and will commonly cause multiple value numbers to be merged into one.
567 ///
568 /// VN is the value number that we're trying to resolve.  InstDefiningValue
569 /// keeps track of the new InstDefiningValue assignment for the result
570 /// LiveInterval.  ThisFromOther/OtherFromThis are sets that keep track of
571 /// whether a value in this or other is a copy from the opposite set.
572 /// ThisValNoAssignments/OtherValNoAssignments keep track of value #'s that have
573 /// already been assigned.
574 ///
575 /// ThisFromOther[x] - If x is defined as a copy from the other interval, this
576 /// contains the value number the copy is from.
577 ///
578 static unsigned ComputeUltimateVN(VNInfo *VNI,
579                                   SmallVector<VNInfo*, 16> &NewVNInfo,
580                                   DenseMap<VNInfo*, VNInfo*> &ThisFromOther,
581                                   DenseMap<VNInfo*, VNInfo*> &OtherFromThis,
582                                   SmallVector<int, 16> &ThisValNoAssignments,
583                                   SmallVector<int, 16> &OtherValNoAssignments) {
584   unsigned VN = VNI->id;
585
586   // If the VN has already been computed, just return it.
587   if (ThisValNoAssignments[VN] >= 0)
588     return ThisValNoAssignments[VN];
589 //  assert(ThisValNoAssignments[VN] != -2 && "Cyclic case?");
590
591   // If this val is not a copy from the other val, then it must be a new value
592   // number in the destination.
593   DenseMap<VNInfo*, VNInfo*>::iterator I = ThisFromOther.find(VNI);
594   if (I == ThisFromOther.end()) {
595     NewVNInfo.push_back(VNI);
596     return ThisValNoAssignments[VN] = NewVNInfo.size()-1;
597   }
598   VNInfo *OtherValNo = I->second;
599
600   // Otherwise, this *is* a copy from the RHS.  If the other side has already
601   // been computed, return it.
602   if (OtherValNoAssignments[OtherValNo->id] >= 0)
603     return ThisValNoAssignments[VN] = OtherValNoAssignments[OtherValNo->id];
604   
605   // Mark this value number as currently being computed, then ask what the
606   // ultimate value # of the other value is.
607   ThisValNoAssignments[VN] = -2;
608   unsigned UltimateVN =
609     ComputeUltimateVN(OtherValNo, NewVNInfo, OtherFromThis, ThisFromOther,
610                       OtherValNoAssignments, ThisValNoAssignments);
611   return ThisValNoAssignments[VN] = UltimateVN;
612 }
613
614 static bool InVector(VNInfo *Val, const SmallVector<VNInfo*, 8> &V) {
615   return std::find(V.begin(), V.end(), Val) != V.end();
616 }
617
618 /// SimpleJoin - Attempt to joint the specified interval into this one. The
619 /// caller of this method must guarantee that the RHS only contains a single
620 /// value number and that the RHS is not defined by a copy from this
621 /// interval.  This returns false if the intervals are not joinable, or it
622 /// joins them and returns true.
623 bool SimpleRegisterCoalescing::SimpleJoin(LiveInterval &LHS, LiveInterval &RHS){
624   assert(RHS.containsOneValue());
625   
626   // Some number (potentially more than one) value numbers in the current
627   // interval may be defined as copies from the RHS.  Scan the overlapping
628   // portions of the LHS and RHS, keeping track of this and looking for
629   // overlapping live ranges that are NOT defined as copies.  If these exist, we
630   // cannot coalesce.
631   
632   LiveInterval::iterator LHSIt = LHS.begin(), LHSEnd = LHS.end();
633   LiveInterval::iterator RHSIt = RHS.begin(), RHSEnd = RHS.end();
634   
635   if (LHSIt->start < RHSIt->start) {
636     LHSIt = std::upper_bound(LHSIt, LHSEnd, RHSIt->start);
637     if (LHSIt != LHS.begin()) --LHSIt;
638   } else if (RHSIt->start < LHSIt->start) {
639     RHSIt = std::upper_bound(RHSIt, RHSEnd, LHSIt->start);
640     if (RHSIt != RHS.begin()) --RHSIt;
641   }
642   
643   SmallVector<VNInfo*, 8> EliminatedLHSVals;
644   
645   while (1) {
646     // Determine if these live intervals overlap.
647     bool Overlaps = false;
648     if (LHSIt->start <= RHSIt->start)
649       Overlaps = LHSIt->end > RHSIt->start;
650     else
651       Overlaps = RHSIt->end > LHSIt->start;
652     
653     // If the live intervals overlap, there are two interesting cases: if the
654     // LHS interval is defined by a copy from the RHS, it's ok and we record
655     // that the LHS value # is the same as the RHS.  If it's not, then we cannot
656     // coalesce these live ranges and we bail out.
657     if (Overlaps) {
658       // If we haven't already recorded that this value # is safe, check it.
659       if (!InVector(LHSIt->valno, EliminatedLHSVals)) {
660         // Copy from the RHS?
661         unsigned SrcReg = LHSIt->valno->reg;
662         if (rep(SrcReg) != RHS.reg)
663           return false;    // Nope, bail out.
664         
665         EliminatedLHSVals.push_back(LHSIt->valno);
666       }
667       
668       // We know this entire LHS live range is okay, so skip it now.
669       if (++LHSIt == LHSEnd) break;
670       continue;
671     }
672     
673     if (LHSIt->end < RHSIt->end) {
674       if (++LHSIt == LHSEnd) break;
675     } else {
676       // One interesting case to check here.  It's possible that we have
677       // something like "X3 = Y" which defines a new value number in the LHS,
678       // and is the last use of this liverange of the RHS.  In this case, we
679       // want to notice this copy (so that it gets coalesced away) even though
680       // the live ranges don't actually overlap.
681       if (LHSIt->start == RHSIt->end) {
682         if (InVector(LHSIt->valno, EliminatedLHSVals)) {
683           // We already know that this value number is going to be merged in
684           // if coalescing succeeds.  Just skip the liverange.
685           if (++LHSIt == LHSEnd) break;
686         } else {
687           // Otherwise, if this is a copy from the RHS, mark it as being merged
688           // in.
689           if (rep(LHSIt->valno->reg) == RHS.reg) {
690             EliminatedLHSVals.push_back(LHSIt->valno);
691
692             // We know this entire LHS live range is okay, so skip it now.
693             if (++LHSIt == LHSEnd) break;
694           }
695         }
696       }
697       
698       if (++RHSIt == RHSEnd) break;
699     }
700   }
701   
702   // If we got here, we know that the coalescing will be successful and that
703   // the value numbers in EliminatedLHSVals will all be merged together.  Since
704   // the most common case is that EliminatedLHSVals has a single number, we
705   // optimize for it: if there is more than one value, we merge them all into
706   // the lowest numbered one, then handle the interval as if we were merging
707   // with one value number.
708   VNInfo *LHSValNo;
709   if (EliminatedLHSVals.size() > 1) {
710     // Loop through all the equal value numbers merging them into the smallest
711     // one.
712     VNInfo *Smallest = EliminatedLHSVals[0];
713     for (unsigned i = 1, e = EliminatedLHSVals.size(); i != e; ++i) {
714       if (EliminatedLHSVals[i]->id < Smallest->id) {
715         // Merge the current notion of the smallest into the smaller one.
716         LHS.MergeValueNumberInto(Smallest, EliminatedLHSVals[i]);
717         Smallest = EliminatedLHSVals[i];
718       } else {
719         // Merge into the smallest.
720         LHS.MergeValueNumberInto(EliminatedLHSVals[i], Smallest);
721       }
722     }
723     LHSValNo = Smallest;
724   } else {
725     assert(!EliminatedLHSVals.empty() && "No copies from the RHS?");
726     LHSValNo = EliminatedLHSVals[0];
727   }
728   
729   // Okay, now that there is a single LHS value number that we're merging the
730   // RHS into, update the value number info for the LHS to indicate that the
731   // value number is defined where the RHS value number was.
732   const VNInfo *VNI = RHS.getValNumInfo(0);
733   LHSValNo->def = VNI->def;
734   LHSValNo->reg = VNI->reg;
735   
736   // Okay, the final step is to loop over the RHS live intervals, adding them to
737   // the LHS.
738   LHSValNo->hasPHIKill |= VNI->hasPHIKill;
739   LHS.addKills(LHSValNo, VNI->kills);
740   LHS.MergeRangesInAsValue(RHS, LHSValNo);
741   LHS.weight += RHS.weight;
742   if (RHS.preference && !LHS.preference)
743     LHS.preference = RHS.preference;
744   
745   return true;
746 }
747
748 /// JoinIntervals - Attempt to join these two intervals.  On failure, this
749 /// returns false.  Otherwise, if one of the intervals being joined is a
750 /// physreg, this method always canonicalizes LHS to be it.  The output
751 /// "RHS" will not have been modified, so we can use this information
752 /// below to update aliases.
753 bool SimpleRegisterCoalescing::JoinIntervals(LiveInterval &LHS,
754                                              LiveInterval &RHS, bool &Swapped) {
755   // Compute the final value assignment, assuming that the live ranges can be
756   // coalesced.
757   SmallVector<int, 16> LHSValNoAssignments;
758   SmallVector<int, 16> RHSValNoAssignments;
759   DenseMap<VNInfo*, VNInfo*> LHSValsDefinedFromRHS;
760   DenseMap<VNInfo*, VNInfo*> RHSValsDefinedFromLHS;
761   SmallVector<VNInfo*, 16> NewVNInfo;
762                           
763   // If a live interval is a physical register, conservatively check if any
764   // of its sub-registers is overlapping the live interval of the virtual
765   // register. If so, do not coalesce.
766   if (TargetRegisterInfo::isPhysicalRegister(LHS.reg) &&
767       *tri_->getSubRegisters(LHS.reg)) {
768     for (const unsigned* SR = tri_->getSubRegisters(LHS.reg); *SR; ++SR)
769       if (li_->hasInterval(*SR) && RHS.overlaps(li_->getInterval(*SR))) {
770         DOUT << "Interfere with sub-register ";
771         DEBUG(li_->getInterval(*SR).print(DOUT, tri_));
772         return false;
773       }
774   } else if (TargetRegisterInfo::isPhysicalRegister(RHS.reg) &&
775              *tri_->getSubRegisters(RHS.reg)) {
776     for (const unsigned* SR = tri_->getSubRegisters(RHS.reg); *SR; ++SR)
777       if (li_->hasInterval(*SR) && LHS.overlaps(li_->getInterval(*SR))) {
778         DOUT << "Interfere with sub-register ";
779         DEBUG(li_->getInterval(*SR).print(DOUT, tri_));
780         return false;
781       }
782   }
783                           
784   // Compute ultimate value numbers for the LHS and RHS values.
785   if (RHS.containsOneValue()) {
786     // Copies from a liveinterval with a single value are simple to handle and
787     // very common, handle the special case here.  This is important, because
788     // often RHS is small and LHS is large (e.g. a physreg).
789     
790     // Find out if the RHS is defined as a copy from some value in the LHS.
791     int RHSVal0DefinedFromLHS = -1;
792     int RHSValID = -1;
793     VNInfo *RHSValNoInfo = NULL;
794     VNInfo *RHSValNoInfo0 = RHS.getValNumInfo(0);
795     unsigned RHSSrcReg = RHSValNoInfo0->reg;
796     if ((RHSSrcReg == 0 || rep(RHSSrcReg) != LHS.reg)) {
797       // If RHS is not defined as a copy from the LHS, we can use simpler and
798       // faster checks to see if the live ranges are coalescable.  This joiner
799       // can't swap the LHS/RHS intervals though.
800       if (!TargetRegisterInfo::isPhysicalRegister(RHS.reg)) {
801         return SimpleJoin(LHS, RHS);
802       } else {
803         RHSValNoInfo = RHSValNoInfo0;
804       }
805     } else {
806       // It was defined as a copy from the LHS, find out what value # it is.
807       RHSValNoInfo = LHS.getLiveRangeContaining(RHSValNoInfo0->def-1)->valno;
808       RHSValID = RHSValNoInfo->id;
809       RHSVal0DefinedFromLHS = RHSValID;
810     }
811     
812     LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
813     RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
814     NewVNInfo.resize(LHS.getNumValNums(), NULL);
815     
816     // Okay, *all* of the values in LHS that are defined as a copy from RHS
817     // should now get updated.
818     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
819          i != e; ++i) {
820       VNInfo *VNI = *i;
821       unsigned VN = VNI->id;
822       if (unsigned LHSSrcReg = VNI->reg) {
823         if (rep(LHSSrcReg) != RHS.reg) {
824           // If this is not a copy from the RHS, its value number will be
825           // unmodified by the coalescing.
826           NewVNInfo[VN] = VNI;
827           LHSValNoAssignments[VN] = VN;
828         } else if (RHSValID == -1) {
829           // Otherwise, it is a copy from the RHS, and we don't already have a
830           // value# for it.  Keep the current value number, but remember it.
831           LHSValNoAssignments[VN] = RHSValID = VN;
832           NewVNInfo[VN] = RHSValNoInfo;
833           LHSValsDefinedFromRHS[VNI] = RHSValNoInfo0;
834         } else {
835           // Otherwise, use the specified value #.
836           LHSValNoAssignments[VN] = RHSValID;
837           if (VN == (unsigned)RHSValID) {  // Else this val# is dead.
838             NewVNInfo[VN] = RHSValNoInfo;
839             LHSValsDefinedFromRHS[VNI] = RHSValNoInfo0;
840           }
841         }
842       } else {
843         NewVNInfo[VN] = VNI;
844         LHSValNoAssignments[VN] = VN;
845       }
846     }
847     
848     assert(RHSValID != -1 && "Didn't find value #?");
849     RHSValNoAssignments[0] = RHSValID;
850     if (RHSVal0DefinedFromLHS != -1) {
851       // This path doesn't go through ComputeUltimateVN so just set
852       // it to anything.
853       RHSValsDefinedFromLHS[RHSValNoInfo0] = (VNInfo*)1;
854     }
855   } else {
856     // Loop over the value numbers of the LHS, seeing if any are defined from
857     // the RHS.
858     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
859          i != e; ++i) {
860       VNInfo *VNI = *i;
861       unsigned ValSrcReg = VNI->reg;
862       if (VNI->def == ~1U ||ValSrcReg == 0)  // Src not defined by a copy?
863         continue;
864       
865       // DstReg is known to be a register in the LHS interval.  If the src is
866       // from the RHS interval, we can use its value #.
867       if (rep(ValSrcReg) != RHS.reg)
868         continue;
869       
870       // Figure out the value # from the RHS.
871       LHSValsDefinedFromRHS[VNI]=RHS.getLiveRangeContaining(VNI->def-1)->valno;
872     }
873     
874     // Loop over the value numbers of the RHS, seeing if any are defined from
875     // the LHS.
876     for (LiveInterval::vni_iterator i = RHS.vni_begin(), e = RHS.vni_end();
877          i != e; ++i) {
878       VNInfo *VNI = *i;
879       unsigned ValSrcReg = VNI->reg;
880       if (VNI->def == ~1U || ValSrcReg == 0)  // Src not defined by a copy?
881         continue;
882       
883       // DstReg is known to be a register in the RHS interval.  If the src is
884       // from the LHS interval, we can use its value #.
885       if (rep(ValSrcReg) != LHS.reg)
886         continue;
887       
888       // Figure out the value # from the LHS.
889       RHSValsDefinedFromLHS[VNI]=LHS.getLiveRangeContaining(VNI->def-1)->valno;
890     }
891     
892     LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
893     RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
894     NewVNInfo.reserve(LHS.getNumValNums() + RHS.getNumValNums());
895     
896     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
897          i != e; ++i) {
898       VNInfo *VNI = *i;
899       unsigned VN = VNI->id;
900       if (LHSValNoAssignments[VN] >= 0 || VNI->def == ~1U) 
901         continue;
902       ComputeUltimateVN(VNI, NewVNInfo,
903                         LHSValsDefinedFromRHS, RHSValsDefinedFromLHS,
904                         LHSValNoAssignments, RHSValNoAssignments);
905     }
906     for (LiveInterval::vni_iterator i = RHS.vni_begin(), e = RHS.vni_end();
907          i != e; ++i) {
908       VNInfo *VNI = *i;
909       unsigned VN = VNI->id;
910       if (RHSValNoAssignments[VN] >= 0 || VNI->def == ~1U)
911         continue;
912       // If this value number isn't a copy from the LHS, it's a new number.
913       if (RHSValsDefinedFromLHS.find(VNI) == RHSValsDefinedFromLHS.end()) {
914         NewVNInfo.push_back(VNI);
915         RHSValNoAssignments[VN] = NewVNInfo.size()-1;
916         continue;
917       }
918       
919       ComputeUltimateVN(VNI, NewVNInfo,
920                         RHSValsDefinedFromLHS, LHSValsDefinedFromRHS,
921                         RHSValNoAssignments, LHSValNoAssignments);
922     }
923   }
924   
925   // Armed with the mappings of LHS/RHS values to ultimate values, walk the
926   // interval lists to see if these intervals are coalescable.
927   LiveInterval::const_iterator I = LHS.begin();
928   LiveInterval::const_iterator IE = LHS.end();
929   LiveInterval::const_iterator J = RHS.begin();
930   LiveInterval::const_iterator JE = RHS.end();
931   
932   // Skip ahead until the first place of potential sharing.
933   if (I->start < J->start) {
934     I = std::upper_bound(I, IE, J->start);
935     if (I != LHS.begin()) --I;
936   } else if (J->start < I->start) {
937     J = std::upper_bound(J, JE, I->start);
938     if (J != RHS.begin()) --J;
939   }
940   
941   while (1) {
942     // Determine if these two live ranges overlap.
943     bool Overlaps;
944     if (I->start < J->start) {
945       Overlaps = I->end > J->start;
946     } else {
947       Overlaps = J->end > I->start;
948     }
949
950     // If so, check value # info to determine if they are really different.
951     if (Overlaps) {
952       // If the live range overlap will map to the same value number in the
953       // result liverange, we can still coalesce them.  If not, we can't.
954       if (LHSValNoAssignments[I->valno->id] !=
955           RHSValNoAssignments[J->valno->id])
956         return false;
957     }
958     
959     if (I->end < J->end) {
960       ++I;
961       if (I == IE) break;
962     } else {
963       ++J;
964       if (J == JE) break;
965     }
966   }
967
968   // Update kill info. Some live ranges are extended due to copy coalescing.
969   for (DenseMap<VNInfo*, VNInfo*>::iterator I = LHSValsDefinedFromRHS.begin(),
970          E = LHSValsDefinedFromRHS.end(); I != E; ++I) {
971     VNInfo *VNI = I->first;
972     unsigned LHSValID = LHSValNoAssignments[VNI->id];
973     LiveInterval::removeKill(NewVNInfo[LHSValID], VNI->def);
974     NewVNInfo[LHSValID]->hasPHIKill |= VNI->hasPHIKill;
975     RHS.addKills(NewVNInfo[LHSValID], VNI->kills);
976   }
977
978   // Update kill info. Some live ranges are extended due to copy coalescing.
979   for (DenseMap<VNInfo*, VNInfo*>::iterator I = RHSValsDefinedFromLHS.begin(),
980          E = RHSValsDefinedFromLHS.end(); I != E; ++I) {
981     VNInfo *VNI = I->first;
982     unsigned RHSValID = RHSValNoAssignments[VNI->id];
983     LiveInterval::removeKill(NewVNInfo[RHSValID], VNI->def);
984     NewVNInfo[RHSValID]->hasPHIKill |= VNI->hasPHIKill;
985     LHS.addKills(NewVNInfo[RHSValID], VNI->kills);
986   }
987
988   // If we get here, we know that we can coalesce the live ranges.  Ask the
989   // intervals to coalesce themselves now.
990   if ((RHS.ranges.size() > LHS.ranges.size() &&
991       TargetRegisterInfo::isVirtualRegister(LHS.reg)) ||
992       TargetRegisterInfo::isPhysicalRegister(RHS.reg)) {
993     RHS.join(LHS, &RHSValNoAssignments[0], &LHSValNoAssignments[0], NewVNInfo);
994     Swapped = true;
995   } else {
996     LHS.join(RHS, &LHSValNoAssignments[0], &RHSValNoAssignments[0], NewVNInfo);
997     Swapped = false;
998   }
999   return true;
1000 }
1001
1002 namespace {
1003   // DepthMBBCompare - Comparison predicate that sort first based on the loop
1004   // depth of the basic block (the unsigned), and then on the MBB number.
1005   struct DepthMBBCompare {
1006     typedef std::pair<unsigned, MachineBasicBlock*> DepthMBBPair;
1007     bool operator()(const DepthMBBPair &LHS, const DepthMBBPair &RHS) const {
1008       if (LHS.first > RHS.first) return true;   // Deeper loops first
1009       return LHS.first == RHS.first &&
1010         LHS.second->getNumber() < RHS.second->getNumber();
1011     }
1012   };
1013 }
1014
1015 /// getRepIntervalSize - Returns the size of the interval that represents the
1016 /// specified register.
1017 template<class SF>
1018 unsigned JoinPriorityQueue<SF>::getRepIntervalSize(unsigned Reg) {
1019   return Rc->getRepIntervalSize(Reg);
1020 }
1021
1022 /// CopyRecSort::operator - Join priority queue sorting function.
1023 ///
1024 bool CopyRecSort::operator()(CopyRec left, CopyRec right) const {
1025   // Inner loops first.
1026   if (left.LoopDepth > right.LoopDepth)
1027     return false;
1028   else if (left.LoopDepth == right.LoopDepth) {
1029     if (left.isBackEdge && !right.isBackEdge)
1030       return false;
1031     else if (left.isBackEdge == right.isBackEdge) {
1032       // Join virtuals to physical registers first.
1033       bool LDstIsPhys = TargetRegisterInfo::isPhysicalRegister(left.DstReg);
1034       bool LSrcIsPhys = TargetRegisterInfo::isPhysicalRegister(left.SrcReg);
1035       bool LIsPhys = LDstIsPhys || LSrcIsPhys;
1036       bool RDstIsPhys = TargetRegisterInfo::isPhysicalRegister(right.DstReg);
1037       bool RSrcIsPhys = TargetRegisterInfo::isPhysicalRegister(right.SrcReg);
1038       bool RIsPhys = RDstIsPhys || RSrcIsPhys;
1039       if (LIsPhys && !RIsPhys)
1040         return false;
1041       else if (LIsPhys == RIsPhys) {
1042         // Join shorter intervals first.
1043         unsigned LSize = 0;
1044         unsigned RSize = 0;
1045         if (LIsPhys) {
1046           LSize =  LDstIsPhys ? 0 : JPQ->getRepIntervalSize(left.DstReg);
1047           LSize += LSrcIsPhys ? 0 : JPQ->getRepIntervalSize(left.SrcReg);
1048           RSize =  RDstIsPhys ? 0 : JPQ->getRepIntervalSize(right.DstReg);
1049           RSize += RSrcIsPhys ? 0 : JPQ->getRepIntervalSize(right.SrcReg);
1050         } else {
1051           LSize =  std::min(JPQ->getRepIntervalSize(left.DstReg),
1052                             JPQ->getRepIntervalSize(left.SrcReg));
1053           RSize =  std::min(JPQ->getRepIntervalSize(right.DstReg),
1054                             JPQ->getRepIntervalSize(right.SrcReg));
1055         }
1056         if (LSize < RSize)
1057           return false;
1058       }
1059     }
1060   }
1061   return true;
1062 }
1063
1064 void SimpleRegisterCoalescing::CopyCoalesceInMBB(MachineBasicBlock *MBB,
1065                                                std::vector<CopyRec> &TryAgain) {
1066   DOUT << ((Value*)MBB->getBasicBlock())->getName() << ":\n";
1067
1068   std::vector<CopyRec> VirtCopies;
1069   std::vector<CopyRec> PhysCopies;
1070   unsigned LoopDepth = loopInfo->getLoopDepth(MBB);
1071   for (MachineBasicBlock::iterator MII = MBB->begin(), E = MBB->end();
1072        MII != E;) {
1073     MachineInstr *Inst = MII++;
1074     
1075     // If this isn't a copy nor a extract_subreg, we can't join intervals.
1076     unsigned SrcReg, DstReg;
1077     if (Inst->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG) {
1078       DstReg = Inst->getOperand(0).getReg();
1079       SrcReg = Inst->getOperand(1).getReg();
1080     } else if (!tii_->isMoveInstr(*Inst, SrcReg, DstReg))
1081       continue;
1082
1083     unsigned repSrcReg = rep(SrcReg);
1084     unsigned repDstReg = rep(DstReg);
1085     bool SrcIsPhys = TargetRegisterInfo::isPhysicalRegister(repSrcReg);
1086     bool DstIsPhys = TargetRegisterInfo::isPhysicalRegister(repDstReg);
1087     if (NewHeuristic) {
1088       JoinQueue->push(CopyRec(Inst, SrcReg, DstReg, LoopDepth,
1089                               isBackEdgeCopy(Inst, DstReg)));
1090     } else {
1091       if (SrcIsPhys || DstIsPhys)
1092         PhysCopies.push_back(CopyRec(Inst, SrcReg, DstReg, 0, false));
1093       else
1094         VirtCopies.push_back(CopyRec(Inst, SrcReg, DstReg, 0, false));
1095     }
1096   }
1097
1098   if (NewHeuristic)
1099     return;
1100
1101   // Try coalescing physical register + virtual register first.
1102   for (unsigned i = 0, e = PhysCopies.size(); i != e; ++i) {
1103     CopyRec &TheCopy = PhysCopies[i];
1104     bool Again = false;
1105     if (!JoinCopy(TheCopy, Again))
1106       if (Again)
1107         TryAgain.push_back(TheCopy);
1108   }
1109   for (unsigned i = 0, e = VirtCopies.size(); i != e; ++i) {
1110     CopyRec &TheCopy = VirtCopies[i];
1111     bool Again = false;
1112     if (!JoinCopy(TheCopy, Again))
1113       if (Again)
1114         TryAgain.push_back(TheCopy);
1115   }
1116 }
1117
1118 void SimpleRegisterCoalescing::joinIntervals() {
1119   DOUT << "********** JOINING INTERVALS ***********\n";
1120
1121   if (NewHeuristic)
1122     JoinQueue = new JoinPriorityQueue<CopyRecSort>(this);
1123
1124   JoinedLIs.resize(li_->getNumIntervals());
1125   JoinedLIs.reset();
1126
1127   std::vector<CopyRec> TryAgainList;
1128   if (loopInfo->begin() == loopInfo->end()) {
1129     // If there are no loops in the function, join intervals in function order.
1130     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();
1131          I != E; ++I)
1132       CopyCoalesceInMBB(I, TryAgainList);
1133   } else {
1134     // Otherwise, join intervals in inner loops before other intervals.
1135     // Unfortunately we can't just iterate over loop hierarchy here because
1136     // there may be more MBB's than BB's.  Collect MBB's for sorting.
1137
1138     // Join intervals in the function prolog first. We want to join physical
1139     // registers with virtual registers before the intervals got too long.
1140     std::vector<std::pair<unsigned, MachineBasicBlock*> > MBBs;
1141     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();I != E;++I){
1142       MachineBasicBlock *MBB = I;
1143       MBBs.push_back(std::make_pair(loopInfo->getLoopDepth(MBB), I));
1144     }
1145
1146     // Sort by loop depth.
1147     std::sort(MBBs.begin(), MBBs.end(), DepthMBBCompare());
1148
1149     // Finally, join intervals in loop nest order.
1150     for (unsigned i = 0, e = MBBs.size(); i != e; ++i)
1151       CopyCoalesceInMBB(MBBs[i].second, TryAgainList);
1152   }
1153   
1154   // Joining intervals can allow other intervals to be joined.  Iteratively join
1155   // until we make no progress.
1156   if (NewHeuristic) {
1157     SmallVector<CopyRec, 16> TryAgain;
1158     bool ProgressMade = true;
1159     while (ProgressMade) {
1160       ProgressMade = false;
1161       while (!JoinQueue->empty()) {
1162         CopyRec R = JoinQueue->pop();
1163         bool Again = false;
1164         bool Success = JoinCopy(R, Again);
1165         if (Success)
1166           ProgressMade = true;
1167         else if (Again)
1168           TryAgain.push_back(R);
1169       }
1170
1171       if (ProgressMade) {
1172         while (!TryAgain.empty()) {
1173           JoinQueue->push(TryAgain.back());
1174           TryAgain.pop_back();
1175         }
1176       }
1177     }
1178   } else {
1179     bool ProgressMade = true;
1180     while (ProgressMade) {
1181       ProgressMade = false;
1182
1183       for (unsigned i = 0, e = TryAgainList.size(); i != e; ++i) {
1184         CopyRec &TheCopy = TryAgainList[i];
1185         if (TheCopy.MI) {
1186           bool Again = false;
1187           bool Success = JoinCopy(TheCopy, Again);
1188           if (Success || !Again) {
1189             TheCopy.MI = 0;   // Mark this one as done.
1190             ProgressMade = true;
1191           }
1192         }
1193       }
1194     }
1195   }
1196
1197   // Some live range has been lengthened due to colaescing, eliminate the
1198   // unnecessary kills.
1199   int RegNum = JoinedLIs.find_first();
1200   while (RegNum != -1) {
1201     unsigned Reg = RegNum + TargetRegisterInfo::FirstVirtualRegister;
1202     unsigned repReg = rep(Reg);
1203     LiveInterval &LI = li_->getInterval(repReg);
1204     LiveVariables::VarInfo& svi = lv_->getVarInfo(Reg);
1205     for (unsigned i = 0, e = svi.Kills.size(); i != e; ++i) {
1206       MachineInstr *Kill = svi.Kills[i];
1207       // Suppose vr1 = op vr2, x
1208       // and vr1 and vr2 are coalesced. vr2 should still be marked kill
1209       // unless it is a two-address operand.
1210       if (li_->isRemoved(Kill) || hasRegisterDef(Kill, repReg))
1211         continue;
1212       if (LI.liveAt(li_->getInstructionIndex(Kill) + InstrSlots::NUM))
1213         unsetRegisterKill(Kill, repReg);
1214     }
1215     RegNum = JoinedLIs.find_next(RegNum);
1216   }
1217
1218   if (NewHeuristic)
1219     delete JoinQueue;
1220   
1221   DOUT << "*** Register mapping ***\n";
1222   for (unsigned i = 0, e = r2rMap_.size(); i != e; ++i)
1223     if (r2rMap_[i]) {
1224       DOUT << "  reg " << i << " -> ";
1225       DEBUG(printRegName(r2rMap_[i]));
1226       DOUT << "\n";
1227     }
1228 }
1229
1230 /// Return true if the two specified registers belong to different register
1231 /// classes.  The registers may be either phys or virt regs.
1232 bool SimpleRegisterCoalescing::differingRegisterClasses(unsigned RegA,
1233                                                         unsigned RegB) const {
1234
1235   // Get the register classes for the first reg.
1236   if (TargetRegisterInfo::isPhysicalRegister(RegA)) {
1237     assert(TargetRegisterInfo::isVirtualRegister(RegB) &&
1238            "Shouldn't consider two physregs!");
1239     return !mf_->getRegInfo().getRegClass(RegB)->contains(RegA);
1240   }
1241
1242   // Compare against the regclass for the second reg.
1243   const TargetRegisterClass *RegClass = mf_->getRegInfo().getRegClass(RegA);
1244   if (TargetRegisterInfo::isVirtualRegister(RegB))
1245     return RegClass != mf_->getRegInfo().getRegClass(RegB);
1246   else
1247     return !RegClass->contains(RegB);
1248 }
1249
1250 /// lastRegisterUse - Returns the last use of the specific register between
1251 /// cycles Start and End. It also returns the use operand by reference. It
1252 /// returns NULL if there are no uses.
1253 MachineInstr *
1254 SimpleRegisterCoalescing::lastRegisterUse(unsigned Start, unsigned End,
1255                                           unsigned Reg, MachineOperand *&MOU) {
1256   int e = (End-1) / InstrSlots::NUM * InstrSlots::NUM;
1257   int s = Start;
1258   while (e >= s) {
1259     // Skip deleted instructions
1260     MachineInstr *MI = li_->getInstructionFromIndex(e);
1261     while ((e - InstrSlots::NUM) >= s && !MI) {
1262       e -= InstrSlots::NUM;
1263       MI = li_->getInstructionFromIndex(e);
1264     }
1265     if (e < s || MI == NULL)
1266       return NULL;
1267
1268     for (unsigned i = 0, NumOps = MI->getNumOperands(); i != NumOps; ++i) {
1269       MachineOperand &MO = MI->getOperand(i);
1270       if (MO.isRegister() && MO.isUse() && MO.getReg() &&
1271           tri_->regsOverlap(rep(MO.getReg()), Reg)) {
1272         MOU = &MO;
1273         return MI;
1274       }
1275     }
1276
1277     e -= InstrSlots::NUM;
1278   }
1279
1280   return NULL;
1281 }
1282
1283
1284 /// findDefOperand - Returns the MachineOperand that is a def of the specific
1285 /// register. It returns NULL if the def is not found.
1286 MachineOperand *SimpleRegisterCoalescing::findDefOperand(MachineInstr *MI,
1287                                                          unsigned Reg) {
1288   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1289     MachineOperand &MO = MI->getOperand(i);
1290     if (MO.isRegister() && MO.isDef() &&
1291         tri_->regsOverlap(rep(MO.getReg()), Reg))
1292       return &MO;
1293   }
1294   return NULL;
1295 }
1296
1297 /// unsetRegisterKill - Unset IsKill property of all uses of specific register
1298 /// of the specific instruction.
1299 void SimpleRegisterCoalescing::unsetRegisterKill(MachineInstr *MI,
1300                                                  unsigned Reg) {
1301   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1302     MachineOperand &MO = MI->getOperand(i);
1303     if (MO.isRegister() && MO.isKill() && MO.getReg() &&
1304         tri_->regsOverlap(rep(MO.getReg()), Reg))
1305       MO.setIsKill(false);
1306   }
1307 }
1308
1309 /// unsetRegisterKills - Unset IsKill property of all uses of specific register
1310 /// between cycles Start and End.
1311 void SimpleRegisterCoalescing::unsetRegisterKills(unsigned Start, unsigned End,
1312                                                   unsigned Reg) {
1313   int e = (End-1) / InstrSlots::NUM * InstrSlots::NUM;
1314   int s = Start;
1315   while (e >= s) {
1316     // Skip deleted instructions
1317     MachineInstr *MI = li_->getInstructionFromIndex(e);
1318     while ((e - InstrSlots::NUM) >= s && !MI) {
1319       e -= InstrSlots::NUM;
1320       MI = li_->getInstructionFromIndex(e);
1321     }
1322     if (e < s || MI == NULL)
1323       return;
1324
1325     for (unsigned i = 0, NumOps = MI->getNumOperands(); i != NumOps; ++i) {
1326       MachineOperand &MO = MI->getOperand(i);
1327       if (MO.isRegister() && MO.isKill() && MO.getReg() &&
1328           tri_->regsOverlap(rep(MO.getReg()), Reg)) {
1329         MO.setIsKill(false);
1330       }
1331     }
1332
1333     e -= InstrSlots::NUM;
1334   }
1335 }
1336
1337 /// hasRegisterDef - True if the instruction defines the specific register.
1338 ///
1339 bool SimpleRegisterCoalescing::hasRegisterDef(MachineInstr *MI, unsigned Reg) {
1340   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1341     MachineOperand &MO = MI->getOperand(i);
1342     if (MO.isRegister() && MO.isDef() &&
1343         tri_->regsOverlap(rep(MO.getReg()), Reg))
1344       return true;
1345   }
1346   return false;
1347 }
1348
1349 void SimpleRegisterCoalescing::printRegName(unsigned reg) const {
1350   if (TargetRegisterInfo::isPhysicalRegister(reg))
1351     cerr << tri_->getName(reg);
1352   else
1353     cerr << "%reg" << reg;
1354 }
1355
1356 void SimpleRegisterCoalescing::releaseMemory() {
1357   for (unsigned i = 0, e = r2rMap_.size(); i != e; ++i)
1358     r2rRevMap_[i].clear();
1359   r2rRevMap_.clear();
1360   r2rMap_.clear();
1361   JoinedLIs.clear();
1362   SubRegIdxes.clear();
1363   JoinedCopies.clear();
1364 }
1365
1366 static bool isZeroLengthInterval(LiveInterval *li) {
1367   for (LiveInterval::Ranges::const_iterator
1368          i = li->ranges.begin(), e = li->ranges.end(); i != e; ++i)
1369     if (i->end - i->start > LiveIntervals::InstrSlots::NUM)
1370       return false;
1371   return true;
1372 }
1373
1374 bool SimpleRegisterCoalescing::runOnMachineFunction(MachineFunction &fn) {
1375   mf_ = &fn;
1376   tm_ = &fn.getTarget();
1377   tri_ = tm_->getRegisterInfo();
1378   tii_ = tm_->getInstrInfo();
1379   li_ = &getAnalysis<LiveIntervals>();
1380   lv_ = &getAnalysis<LiveVariables>();
1381   loopInfo = &getAnalysis<MachineLoopInfo>();
1382
1383   DOUT << "********** SIMPLE REGISTER COALESCING **********\n"
1384        << "********** Function: "
1385        << ((Value*)mf_->getFunction())->getName() << '\n';
1386
1387   allocatableRegs_ = tri_->getAllocatableSet(fn);
1388   for (TargetRegisterInfo::regclass_iterator I = tri_->regclass_begin(),
1389          E = tri_->regclass_end(); I != E; ++I)
1390     allocatableRCRegs_.insert(std::make_pair(*I,
1391                                              tri_->getAllocatableSet(fn, *I)));
1392
1393   MachineRegisterInfo &RegInfo = mf_->getRegInfo();
1394   r2rMap_.grow(RegInfo.getLastVirtReg());
1395   r2rRevMap_.grow(RegInfo.getLastVirtReg());
1396
1397   // Join (coalesce) intervals if requested.
1398   IndexedMap<unsigned, VirtReg2IndexFunctor> RegSubIdxMap;
1399   if (EnableJoining) {
1400     joinIntervals();
1401     DOUT << "********** INTERVALS POST JOINING **********\n";
1402     for (LiveIntervals::iterator I = li_->begin(), E = li_->end(); I != E; ++I){
1403       I->second.print(DOUT, tri_);
1404       DOUT << "\n";
1405     }
1406
1407     // Delete all coalesced copies.
1408     for (SmallPtrSet<MachineInstr*,32>::iterator I = JoinedCopies.begin(),
1409            E = JoinedCopies.end(); I != E; ++I) {
1410       li_->RemoveMachineInstrFromMaps(*I);
1411       (*I)->eraseFromParent();
1412     }
1413
1414     // Transfer sub-registers info to MachineRegisterInfo now that coalescing
1415     // information is complete.
1416     RegSubIdxMap.grow(RegInfo.getLastVirtReg()+1);
1417     while (!SubRegIdxes.empty()) {
1418       std::pair<unsigned, unsigned> RI = SubRegIdxes.back();
1419       SubRegIdxes.pop_back();
1420       RegSubIdxMap[RI.first] = RI.second;
1421     }
1422   }
1423
1424   // perform a final pass over the instructions and compute spill
1425   // weights, coalesce virtual registers and remove identity moves.
1426   for (MachineFunction::iterator mbbi = mf_->begin(), mbbe = mf_->end();
1427        mbbi != mbbe; ++mbbi) {
1428     MachineBasicBlock* mbb = mbbi;
1429     unsigned loopDepth = loopInfo->getLoopDepth(mbb);
1430
1431     for (MachineBasicBlock::iterator mii = mbb->begin(), mie = mbb->end();
1432          mii != mie; ) {
1433       // if the move will be an identity move delete it
1434       unsigned srcReg, dstReg, RegRep;
1435       if (tii_->isMoveInstr(*mii, srcReg, dstReg) &&
1436           (RegRep = rep(srcReg)) == rep(dstReg)) {
1437         // remove from def list
1438         LiveInterval &RegInt = li_->getOrCreateInterval(RegRep);
1439         MachineOperand *MO = mii->findRegisterDefOperand(dstReg);
1440         // If def of this move instruction is dead, remove its live range from
1441         // the dstination register's live interval.
1442         if (MO->isDead()) {
1443           unsigned MoveIdx = li_->getDefIndex(li_->getInstructionIndex(mii));
1444           LiveInterval::iterator MLR = RegInt.FindLiveRangeContaining(MoveIdx);
1445           RegInt.removeRange(MLR->start, MoveIdx+1);
1446           if (RegInt.empty())
1447             li_->removeInterval(RegRep);
1448         }
1449         li_->RemoveMachineInstrFromMaps(mii);
1450         mii = mbbi->erase(mii);
1451         ++numPeep;
1452       } else {
1453         SmallSet<unsigned, 4> UniqueUses;
1454         for (unsigned i = 0, e = mii->getNumOperands(); i != e; ++i) {
1455           const MachineOperand &mop = mii->getOperand(i);
1456           if (mop.isRegister() && mop.getReg() &&
1457               TargetRegisterInfo::isVirtualRegister(mop.getReg())) {
1458             // replace register with representative register
1459             unsigned OrigReg = mop.getReg();
1460             unsigned reg = rep(OrigReg);
1461             unsigned SubIdx = RegSubIdxMap[OrigReg];
1462             if (SubIdx && TargetRegisterInfo::isPhysicalRegister(reg))
1463               mii->getOperand(i).setReg(tri_->getSubReg(reg, SubIdx));
1464             else {
1465               mii->getOperand(i).setReg(reg);
1466               mii->getOperand(i).setSubReg(SubIdx);
1467             }
1468
1469             // Multiple uses of reg by the same instruction. It should not
1470             // contribute to spill weight again.
1471             if (UniqueUses.count(reg) != 0)
1472               continue;
1473             LiveInterval &RegInt = li_->getInterval(reg);
1474             RegInt.weight +=
1475               li_->getSpillWeight(mop.isDef(), mop.isUse(), loopDepth);
1476             UniqueUses.insert(reg);
1477           }
1478         }
1479         ++mii;
1480       }
1481     }
1482   }
1483
1484   for (LiveIntervals::iterator I = li_->begin(), E = li_->end(); I != E; ++I) {
1485     LiveInterval &LI = I->second;
1486     if (TargetRegisterInfo::isVirtualRegister(LI.reg)) {
1487       // If the live interval length is essentially zero, i.e. in every live
1488       // range the use follows def immediately, it doesn't make sense to spill
1489       // it and hope it will be easier to allocate for this li.
1490       if (isZeroLengthInterval(&LI))
1491         LI.weight = HUGE_VALF;
1492       else {
1493         bool isLoad = false;
1494         if (li_->isReMaterializable(LI, isLoad)) {
1495           // If all of the definitions of the interval are re-materializable,
1496           // it is a preferred candidate for spilling. If non of the defs are
1497           // loads, then it's potentially very cheap to re-materialize.
1498           // FIXME: this gets much more complicated once we support non-trivial
1499           // re-materialization.
1500           if (isLoad)
1501             LI.weight *= 0.9F;
1502           else
1503             LI.weight *= 0.5F;
1504         }
1505       }
1506
1507       // Slightly prefer live interval that has been assigned a preferred reg.
1508       if (LI.preference)
1509         LI.weight *= 1.01F;
1510
1511       // Divide the weight of the interval by its size.  This encourages 
1512       // spilling of intervals that are large and have few uses, and
1513       // discourages spilling of small intervals with many uses.
1514       LI.weight /= LI.getSize();
1515     }
1516   }
1517
1518   DEBUG(dump());
1519   return true;
1520 }
1521
1522 /// print - Implement the dump method.
1523 void SimpleRegisterCoalescing::print(std::ostream &O, const Module* m) const {
1524    li_->print(O, m);
1525 }
1526
1527 RegisterCoalescer* llvm::createSimpleRegisterCoalescer() {
1528   return new SimpleRegisterCoalescing();
1529 }
1530
1531 // Make sure that anything that uses RegisterCoalescer pulls in this file...
1532 DEFINING_FILE_FOR(SimpleRegisterCoalescing)