a1f06a22ed091237f7339cbe9f4083e0e072c332
[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(numCommutes , "Number of instruction commuting performed");
40 STATISTIC(numExtends  , "Number of copies extended");
41 STATISTIC(numPeep     , "Number of identity moves eliminated after coalescing");
42 STATISTIC(numAborts   , "Number of times interval joining aborted");
43
44 char SimpleRegisterCoalescing::ID = 0;
45 namespace {
46   static cl::opt<bool>
47   EnableJoining("join-liveintervals",
48                 cl::desc("Coalesce copies (default=true)"),
49                 cl::init(true));
50
51   static cl::opt<bool>
52   NewHeuristic("new-coalescer-heuristic",
53                 cl::desc("Use new coalescer heuristic"),
54                 cl::init(false));
55
56   RegisterPass<SimpleRegisterCoalescing> 
57   X("simple-register-coalescing", "Simple Register Coalescing");
58
59   // Declare that we implement the RegisterCoalescer interface
60   RegisterAnalysisGroup<RegisterCoalescer, true/*The Default*/> V(X);
61 }
62
63 const PassInfo *llvm::SimpleRegisterCoalescingID = X.getPassInfo();
64
65 void SimpleRegisterCoalescing::getAnalysisUsage(AnalysisUsage &AU) const {
66   AU.addPreserved<LiveIntervals>();
67   AU.addPreserved<MachineLoopInfo>();
68   AU.addPreservedID(MachineDominatorsID);
69   AU.addPreservedID(PHIEliminationID);
70   AU.addPreservedID(TwoAddressInstructionPassID);
71   AU.addRequired<LiveVariables>();
72   AU.addRequired<LiveIntervals>();
73   AU.addRequired<MachineLoopInfo>();
74   MachineFunctionPass::getAnalysisUsage(AU);
75 }
76
77 /// AdjustCopiesBackFrom - We found a non-trivially-coalescable copy with IntA
78 /// being the source and IntB being the dest, thus this defines a value number
79 /// in IntB.  If the source value number (in IntA) is defined by a copy from B,
80 /// see if we can merge these two pieces of B into a single value number,
81 /// eliminating a copy.  For example:
82 ///
83 ///  A3 = B0
84 ///    ...
85 ///  B1 = A3      <- this copy
86 ///
87 /// In this case, B0 can be extended to where the B1 copy lives, allowing the B1
88 /// value number to be replaced with B0 (which simplifies the B liveinterval).
89 ///
90 /// This returns true if an interval was modified.
91 ///
92 bool SimpleRegisterCoalescing::AdjustCopiesBackFrom(LiveInterval &IntA,
93                                                     LiveInterval &IntB,
94                                                     MachineInstr *CopyMI) {
95   unsigned CopyIdx = li_->getDefIndex(li_->getInstructionIndex(CopyMI));
96
97   // BValNo is a value number in B that is defined by a copy from A.  'B3' in
98   // the example above.
99   LiveInterval::iterator BLR = IntB.FindLiveRangeContaining(CopyIdx);
100   if (BLR == IntB.end()) // Should never happen!
101     return false;
102   VNInfo *BValNo = BLR->valno;
103   
104   // Get the location that B is defined at.  Two options: either this value has
105   // an unknown definition point or it is defined at CopyIdx.  If unknown, we 
106   // can't process it.
107   if (!BValNo->copy) return false;
108   assert(BValNo->def == CopyIdx && "Copy doesn't define the value?");
109   
110   // AValNo is the value number in A that defines the copy, A3 in the example.
111   LiveInterval::iterator ALR = IntA.FindLiveRangeContaining(CopyIdx-1);
112   if (ALR == IntA.end()) // Should never happen!
113     return false;
114   VNInfo *AValNo = ALR->valno;
115   
116   // If AValNo is defined as a copy from IntB, we can potentially process this.  
117   // Get the instruction that defines this value number.
118   unsigned SrcReg = li_->getVNInfoSourceReg(AValNo);
119   if (!SrcReg) return false;  // Not defined by a copy.
120     
121   // If the value number is not defined by a copy instruction, ignore it.
122
123   // If the source register comes from an interval other than IntB, we can't
124   // handle this.
125   if (SrcReg != IntB.reg) return false;
126   
127   // Get the LiveRange in IntB that this value number starts with.
128   LiveInterval::iterator ValLR = IntB.FindLiveRangeContaining(AValNo->def-1);
129   if (ValLR == IntB.end()) // Should never happen!
130     return false;
131   
132   // Make sure that the end of the live range is inside the same block as
133   // CopyMI.
134   MachineInstr *ValLREndInst = li_->getInstructionFromIndex(ValLR->end-1);
135   if (!ValLREndInst || 
136       ValLREndInst->getParent() != CopyMI->getParent()) return false;
137
138   // Okay, we now know that ValLR ends in the same block that the CopyMI
139   // live-range starts.  If there are no intervening live ranges between them in
140   // IntB, we can merge them.
141   if (ValLR+1 != BLR) return false;
142
143   // If a live interval is a physical register, conservatively check if any
144   // of its sub-registers is overlapping the live interval of the virtual
145   // register. If so, do not coalesce.
146   if (TargetRegisterInfo::isPhysicalRegister(IntB.reg) &&
147       *tri_->getSubRegisters(IntB.reg)) {
148     for (const unsigned* SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR)
149       if (li_->hasInterval(*SR) && IntA.overlaps(li_->getInterval(*SR))) {
150         DOUT << "Interfere with sub-register ";
151         DEBUG(li_->getInterval(*SR).print(DOUT, tri_));
152         return false;
153       }
154   }
155   
156   DOUT << "\nExtending: "; IntB.print(DOUT, tri_);
157   
158   unsigned FillerStart = ValLR->end, FillerEnd = BLR->start;
159   // We are about to delete CopyMI, so need to remove it as the 'instruction
160   // that defines this value #'. Update the the valnum with the new defining
161   // instruction #.
162   BValNo->def  = FillerStart;
163   BValNo->copy = NULL;
164   
165   // Okay, we can merge them.  We need to insert a new liverange:
166   // [ValLR.end, BLR.begin) of either value number, then we merge the
167   // two value numbers.
168   IntB.addRange(LiveRange(FillerStart, FillerEnd, BValNo));
169
170   // If the IntB live range is assigned to a physical register, and if that
171   // physreg has aliases, 
172   if (TargetRegisterInfo::isPhysicalRegister(IntB.reg)) {
173     // Update the liveintervals of sub-registers.
174     for (const unsigned *AS = tri_->getSubRegisters(IntB.reg); *AS; ++AS) {
175       LiveInterval &AliasLI = li_->getInterval(*AS);
176       AliasLI.addRange(LiveRange(FillerStart, FillerEnd,
177               AliasLI.getNextValue(FillerStart, 0, li_->getVNInfoAllocator())));
178     }
179   }
180
181   // Okay, merge "B1" into the same value number as "B0".
182   if (BValNo != ValLR->valno)
183     IntB.MergeValueNumberInto(BValNo, ValLR->valno);
184   DOUT << "   result = "; IntB.print(DOUT, tri_);
185   DOUT << "\n";
186
187   // If the source instruction was killing the source register before the
188   // merge, unset the isKill marker given the live range has been extended.
189   int UIdx = ValLREndInst->findRegisterUseOperandIdx(IntB.reg, true);
190   if (UIdx != -1)
191     ValLREndInst->getOperand(UIdx).setIsKill(false);
192
193   ++numExtends;
194   return true;
195 }
196
197 /// HasOtherReachingDefs - Return true if there are definitions of IntB
198 /// other than BValNo val# that can reach uses of AValno val# of IntA.
199 bool SimpleRegisterCoalescing::HasOtherReachingDefs(LiveInterval &IntA,
200                                                     LiveInterval &IntB,
201                                                     VNInfo *AValNo,
202                                                     VNInfo *BValNo) {
203   for (LiveInterval::iterator AI = IntA.begin(), AE = IntA.end();
204        AI != AE; ++AI) {
205     if (AI->valno != AValNo) continue;
206     LiveInterval::Ranges::iterator BI =
207       std::upper_bound(IntB.ranges.begin(), IntB.ranges.end(), AI->start);
208     if (BI != IntB.ranges.begin())
209       --BI;
210     for (; BI != IntB.ranges.end() && AI->end >= BI->start; ++BI) {
211       if (BI->valno == BValNo)
212         continue;
213       if (BI->start <= AI->start && BI->end > AI->start)
214         return true;
215       if (BI->start > AI->start && BI->start < AI->end)
216         return true;
217     }
218   }
219   return false;
220 }
221
222 /// RemoveCopyByCommutingDef - We found a non-trivially-coalescable copy with IntA
223 /// being the source and IntB being the dest, thus this defines a value number
224 /// in IntB.  If the source value number (in IntA) is defined by a commutable
225 /// instruction and its other operand is coalesced to the copy dest register,
226 /// see if we can transform the copy into a noop by commuting the definition. For
227 /// example,
228 ///
229 ///  A3 = op A2 B0<kill>
230 ///    ...
231 ///  B1 = A3      <- this copy
232 ///    ...
233 ///     = op A3   <- more uses
234 ///
235 /// ==>
236 ///
237 ///  B2 = op B0 A2<kill>
238 ///    ...
239 ///  B1 = B2      <- now an identify copy
240 ///    ...
241 ///     = op B2   <- more uses
242 ///
243 /// This returns true if an interval was modified.
244 ///
245 bool SimpleRegisterCoalescing::RemoveCopyByCommutingDef(LiveInterval &IntA,
246                                                         LiveInterval &IntB,
247                                                         MachineInstr *CopyMI) {
248   unsigned CopyIdx = li_->getDefIndex(li_->getInstructionIndex(CopyMI));
249
250   // FIXME: For now, only eliminate the copy by commuting its def when the
251   // source register is a virtual register. We want to guard against cases
252   // where the copy is a back edge copy and commuting the def lengthen the
253   // live interval of the source register to the entire loop.
254   if (TargetRegisterInfo::isPhysicalRegister(IntA.reg))
255     return false;
256
257   // BValNo is a value number in B that is defined by a copy from A. 'B3' in
258   // the example above.
259   LiveInterval::iterator BLR = IntB.FindLiveRangeContaining(CopyIdx);
260   if (BLR == IntB.end()) // Should never happen!
261     return false;
262   VNInfo *BValNo = BLR->valno;
263   
264   // Get the location that B is defined at.  Two options: either this value has
265   // an unknown definition point or it is defined at CopyIdx.  If unknown, we 
266   // can't process it.
267   if (!BValNo->copy) return false;
268   assert(BValNo->def == CopyIdx && "Copy doesn't define the value?");
269   
270   // AValNo is the value number in A that defines the copy, A3 in the example.
271   LiveInterval::iterator ALR = IntA.FindLiveRangeContaining(CopyIdx-1);
272   if (ALR == IntA.end()) // Should never happen!
273     return false;
274   VNInfo *AValNo = ALR->valno;
275   // If other defs can reach uses of this def, then it's not safe to perform
276   // the optimization.
277   if (AValNo->def == ~0U || AValNo->def == ~1U || AValNo->hasPHIKill)
278     return false;
279   MachineInstr *DefMI = li_->getInstructionFromIndex(AValNo->def);
280   const TargetInstrDesc &TID = DefMI->getDesc();
281   unsigned NewDstIdx;
282   if (!TID.isCommutable() ||
283       !tii_->CommuteChangesDestination(DefMI, NewDstIdx))
284     return false;
285
286   MachineOperand &NewDstMO = DefMI->getOperand(NewDstIdx);
287   unsigned NewReg = NewDstMO.getReg();
288   if (NewReg != IntB.reg || !NewDstMO.isKill())
289     return false;
290
291   // Make sure there are no other definitions of IntB that would reach the
292   // uses which the new definition can reach.
293   if (HasOtherReachingDefs(IntA, IntB, AValNo, BValNo))
294     return false;
295
296   // If some of the uses of IntA.reg is already coalesced away, return false.
297   // It's not possible to determine whether it's safe to perform the coalescing.
298   for (MachineRegisterInfo::use_iterator UI = mri_->use_begin(IntA.reg),
299          UE = mri_->use_end(); UI != UE; ++UI) {
300     MachineInstr *UseMI = &*UI;
301     unsigned UseIdx = li_->getInstructionIndex(UseMI);
302     LiveInterval::iterator ULR = IntA.FindLiveRangeContaining(UseIdx);
303     if (ULR == IntA.end())
304       continue;
305     if (ULR->valno == AValNo && JoinedCopies.count(UseMI))
306       return false;
307   }
308
309   // At this point we have decided that it is legal to do this
310   // transformation.  Start by commuting the instruction.
311   MachineBasicBlock *MBB = DefMI->getParent();
312   MachineInstr *NewMI = tii_->commuteInstruction(DefMI);
313   if (!NewMI)
314     return false;
315   if (NewMI != DefMI) {
316     li_->ReplaceMachineInstrInMaps(DefMI, NewMI);
317     MBB->insert(DefMI, NewMI);
318     MBB->erase(DefMI);
319   }
320   unsigned OpIdx = NewMI->findRegisterUseOperandIdx(IntA.reg, false);
321   NewMI->getOperand(OpIdx).setIsKill();
322
323   bool BHasPHIKill = BValNo->hasPHIKill;
324   SmallVector<VNInfo*, 4> BDeadValNos;
325   SmallVector<unsigned, 4> BKills;
326   std::map<unsigned, unsigned> BExtend;
327
328   // If ALR and BLR overlaps and end of BLR extends beyond end of ALR, e.g.
329   // A = or A, B
330   // ...
331   // B = A
332   // ...
333   // C = A<kill>
334   // ...
335   //   = B
336   //
337   // then do not add kills of A to the newly created B interval.
338   bool Extended = BLR->end > ALR->end && ALR->end != ALR->start;
339   if (Extended)
340     BExtend[ALR->end] = BLR->end;
341
342   // Update uses of IntA of the specific Val# with IntB.
343   for (MachineRegisterInfo::use_iterator UI = mri_->use_begin(IntA.reg),
344          UE = mri_->use_end(); UI != UE;) {
345     MachineOperand &UseMO = UI.getOperand();
346     MachineInstr *UseMI = &*UI;
347     ++UI;
348     if (JoinedCopies.count(UseMI))
349       continue;
350     unsigned UseIdx = li_->getInstructionIndex(UseMI);
351     LiveInterval::iterator ULR = IntA.FindLiveRangeContaining(UseIdx);
352     if (ULR == IntA.end() || ULR->valno != AValNo)
353       continue;
354     UseMO.setReg(NewReg);
355     if (UseMI == CopyMI)
356       continue;
357     if (UseMO.isKill()) {
358       if (Extended)
359         UseMO.setIsKill(false);
360       else
361         BKills.push_back(li_->getUseIndex(UseIdx)+1);
362     }
363     unsigned SrcReg, DstReg;
364     if (!tii_->isMoveInstr(*UseMI, SrcReg, DstReg))
365       continue;
366     if (DstReg == IntB.reg) {
367       // This copy will become a noop. If it's defining a new val#,
368       // remove that val# as well. However this live range is being
369       // extended to the end of the existing live range defined by the copy.
370       unsigned DefIdx = li_->getDefIndex(UseIdx);
371       const LiveRange *DLR = IntB.getLiveRangeContaining(DefIdx);
372       BHasPHIKill |= DLR->valno->hasPHIKill;
373       assert(DLR->valno->def == DefIdx);
374       BDeadValNos.push_back(DLR->valno);
375       BExtend[DLR->start] = DLR->end;
376       JoinedCopies.insert(UseMI);
377       // If this is a kill but it's going to be removed, the last use
378       // of the same val# is the new kill.
379       if (UseMO.isKill())
380         BKills.pop_back();
381     }
382   }
383
384   // We need to insert a new liverange: [ALR.start, LastUse). It may be we can
385   // simply extend BLR if CopyMI doesn't end the range.
386   DOUT << "\nExtending: "; IntB.print(DOUT, tri_);
387
388   IntB.removeValNo(BValNo);
389   for (unsigned i = 0, e = BDeadValNos.size(); i != e; ++i)
390     IntB.removeValNo(BDeadValNos[i]);
391   VNInfo *ValNo = IntB.getNextValue(AValNo->def, 0, li_->getVNInfoAllocator());
392   for (LiveInterval::iterator AI = IntA.begin(), AE = IntA.end();
393        AI != AE; ++AI) {
394     if (AI->valno != AValNo) continue;
395     unsigned End = AI->end;
396     std::map<unsigned, unsigned>::iterator EI = BExtend.find(End);
397     if (EI != BExtend.end())
398       End = EI->second;
399     IntB.addRange(LiveRange(AI->start, End, ValNo));
400   }
401   IntB.addKills(ValNo, BKills);
402   ValNo->hasPHIKill = BHasPHIKill;
403
404   DOUT << "   result = "; IntB.print(DOUT, tri_);
405   DOUT << "\n";
406
407   DOUT << "\nShortening: "; IntA.print(DOUT, tri_);
408   IntA.removeValNo(AValNo);
409   DOUT << "   result = "; IntA.print(DOUT, tri_);
410   DOUT << "\n";
411
412   ++numCommutes;
413   return true;
414 }
415
416 /// isBackEdgeCopy - Returns true if CopyMI is a back edge copy.
417 ///
418 bool SimpleRegisterCoalescing::isBackEdgeCopy(MachineInstr *CopyMI,
419                                               unsigned DstReg) const {
420   MachineBasicBlock *MBB = CopyMI->getParent();
421   const MachineLoop *L = loopInfo->getLoopFor(MBB);
422   if (!L)
423     return false;
424   if (MBB != L->getLoopLatch())
425     return false;
426
427   LiveInterval &LI = li_->getInterval(DstReg);
428   unsigned DefIdx = li_->getInstructionIndex(CopyMI);
429   LiveInterval::const_iterator DstLR =
430     LI.FindLiveRangeContaining(li_->getDefIndex(DefIdx));
431   if (DstLR == LI.end())
432     return false;
433   unsigned KillIdx = li_->getInstructionIndex(&MBB->back()) + InstrSlots::NUM;
434   if (DstLR->valno->kills.size() == 1 &&
435       DstLR->valno->kills[0] == KillIdx && DstLR->valno->hasPHIKill)
436     return true;
437   return false;
438 }
439
440 /// UpdateRegDefsUses - Replace all defs and uses of SrcReg to DstReg and
441 /// update the subregister number if it is not zero. If DstReg is a
442 /// physical register and the existing subregister number of the def / use
443 /// being updated is not zero, make sure to set it to the correct physical
444 /// subregister.
445 void
446 SimpleRegisterCoalescing::UpdateRegDefsUses(unsigned SrcReg, unsigned DstReg,
447                                             unsigned SubIdx) {
448   bool DstIsPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
449   if (DstIsPhys && SubIdx) {
450     // Figure out the real physical register we are updating with.
451     DstReg = tri_->getSubReg(DstReg, SubIdx);
452     SubIdx = 0;
453   }
454
455   for (MachineRegisterInfo::reg_iterator I = mri_->reg_begin(SrcReg),
456          E = mri_->reg_end(); I != E; ) {
457     MachineOperand &O = I.getOperand();
458     MachineInstr *UseMI = &*I;
459     ++I;
460     unsigned OldSubIdx = O.getSubReg();
461     if (DstIsPhys) {
462       unsigned UseDstReg = DstReg;
463       if (OldSubIdx)
464           UseDstReg = tri_->getSubReg(DstReg, OldSubIdx);
465       O.setReg(UseDstReg);
466       O.setSubReg(0);
467     } else {
468       // Sub-register indexes goes from small to large. e.g.
469       // RAX: 0 -> AL, 1 -> AH, 2 -> AX, 3 -> EAX
470       // EAX: 0 -> AL, 1 -> AH, 2 -> AX
471       // So RAX's sub-register 2 is AX, RAX's sub-regsiter 3 is EAX, whose
472       // sub-register 2 is also AX.
473       if (SubIdx && OldSubIdx && SubIdx != OldSubIdx)
474         assert(OldSubIdx < SubIdx && "Conflicting sub-register index!");
475       else if (SubIdx)
476         O.setSubReg(SubIdx);
477       // Remove would-be duplicated kill marker.
478       if (O.isKill() && UseMI->killsRegister(DstReg))
479         O.setIsKill(false);
480       O.setReg(DstReg);
481     }
482   }
483 }
484
485 /// RemoveDeadImpDef - Remove implicit_def instructions which are "re-defining"
486 /// registers due to insert_subreg coalescing. e.g.
487 /// r1024 = op
488 /// r1025 = implicit_def
489 /// r1025 = insert_subreg r1025, r1024
490 ///       = op r1025
491 /// =>
492 /// r1025 = op
493 /// r1025 = implicit_def
494 /// r1025 = insert_subreg r1025, r1025
495 ///       = op r1025
496 void
497 SimpleRegisterCoalescing::RemoveDeadImpDef(unsigned Reg, LiveInterval &LI) {
498   for (MachineRegisterInfo::reg_iterator I = mri_->reg_begin(Reg),
499          E = mri_->reg_end(); I != E; ) {
500     MachineOperand &O = I.getOperand();
501     MachineInstr *DefMI = &*I;
502     ++I;
503     if (!O.isDef())
504       continue;
505     if (DefMI->getOpcode() != TargetInstrInfo::IMPLICIT_DEF)
506       continue;
507     if (!LI.liveBeforeAndAt(li_->getInstructionIndex(DefMI)))
508       continue;
509     li_->RemoveMachineInstrFromMaps(DefMI);
510     DefMI->eraseFromParent();
511   }
512 }
513
514 /// RemoveUnnecessaryKills - Remove kill markers that are no longer accurate
515 /// due to live range lengthening as the result of coalescing.
516 void SimpleRegisterCoalescing::RemoveUnnecessaryKills(unsigned Reg,
517                                                       LiveInterval &LI) {
518   for (MachineRegisterInfo::use_iterator UI = mri_->use_begin(Reg),
519          UE = mri_->use_end(); UI != UE; ++UI) {
520     MachineOperand &UseMO = UI.getOperand();
521     if (UseMO.isKill()) {
522       MachineInstr *UseMI = UseMO.getParent();
523       unsigned SReg, DReg;
524       if (!tii_->isMoveInstr(*UseMI, SReg, DReg))
525         continue;
526       unsigned UseIdx = li_->getUseIndex(li_->getInstructionIndex(UseMI));
527       if (JoinedCopies.count(UseMI))
528         continue;
529       const LiveRange *UI = LI.getLiveRangeContaining(UseIdx);
530       if (!LI.isKill(UI->valno, UseIdx+1))
531         UseMO.setIsKill(false);
532     }
533   }
534 }
535
536 /// removeRange - Wrapper for LiveInterval::removeRange. This removes a range
537 /// from a physical register live interval as well as from the live intervals
538 /// of its sub-registers.
539 static void removeRange(LiveInterval &li, unsigned Start, unsigned End,
540                         LiveIntervals *li_, const TargetRegisterInfo *tri_) {
541   li.removeRange(Start, End, true);
542   if (TargetRegisterInfo::isPhysicalRegister(li.reg)) {
543     for (const unsigned* SR = tri_->getSubRegisters(li.reg); *SR; ++SR) {
544       if (!li_->hasInterval(*SR))
545         continue;
546       LiveInterval &sli = li_->getInterval(*SR);
547       unsigned RemoveEnd = Start;
548       while (RemoveEnd != End) {
549         LiveInterval::iterator LR = sli.FindLiveRangeContaining(Start);
550         if (LR == sli.end())
551           break;
552         RemoveEnd = (LR->end < End) ? LR->end : End;
553         sli.removeRange(Start, RemoveEnd, true);
554         Start = RemoveEnd;
555       }
556     }
557   }
558 }
559
560 /// removeIntervalIfEmpty - Check if the live interval of a physical register
561 /// is empty, if so remove it and also remove the empty intervals of its
562 /// sub-registers. Return true if live interval is removed.
563 static bool removeIntervalIfEmpty(LiveInterval &li, LiveIntervals *li_,
564                                   const TargetRegisterInfo *tri_) {
565   if (li.empty()) {
566     if (TargetRegisterInfo::isPhysicalRegister(li.reg))
567       for (const unsigned* SR = tri_->getSubRegisters(li.reg); *SR; ++SR) {
568         if (!li_->hasInterval(*SR))
569           continue;
570         LiveInterval &sli = li_->getInterval(*SR);
571         if (sli.empty())
572           li_->removeInterval(*SR);
573       }
574     li_->removeInterval(li.reg);
575     return true;
576   }
577   return false;
578 }
579
580 /// ShortenDeadCopyLiveRange - Shorten a live range defined by a dead copy.
581 /// Return true if live interval is removed.
582 bool SimpleRegisterCoalescing::ShortenDeadCopyLiveRange(LiveInterval &li,
583                                                         MachineInstr *CopyMI) {
584   unsigned CopyIdx = li_->getInstructionIndex(CopyMI);
585   LiveInterval::iterator MLR =
586     li.FindLiveRangeContaining(li_->getDefIndex(CopyIdx));
587   if (MLR == li.end())
588     return false;  // Already removed by ShortenDeadCopySrcLiveRange.
589   unsigned RemoveStart = MLR->start;
590   unsigned RemoveEnd = MLR->end;
591   // Remove the liverange that's defined by this.
592   if (RemoveEnd == li_->getDefIndex(CopyIdx)+1) {
593     removeRange(li, RemoveStart, RemoveEnd, li_, tri_);
594     return removeIntervalIfEmpty(li, li_, tri_);
595   }
596   return false;
597 }
598
599 /// PropagateDeadness - Propagate the dead marker to the instruction which
600 /// defines the val#.
601 static void PropagateDeadness(LiveInterval &li, MachineInstr *CopyMI,
602                               unsigned &LRStart, LiveIntervals *li_,
603                               const TargetRegisterInfo* tri_) {
604   MachineInstr *DefMI =
605     li_->getInstructionFromIndex(li_->getDefIndex(LRStart));
606   if (DefMI && DefMI != CopyMI) {
607     int DeadIdx = DefMI->findRegisterDefOperandIdx(li.reg, false, tri_);
608     if (DeadIdx != -1) {
609       DefMI->getOperand(DeadIdx).setIsDead();
610       // A dead def should have a single cycle interval.
611       ++LRStart;
612     }
613   }
614 }
615
616 /// ShortenDeadCopyLiveRange - Shorten a live range as it's artificially
617 /// extended by a dead copy. Mark the last use (if any) of the val# as kill
618 /// as ends the live range there. If there isn't another use, then this
619 /// live range is dead. Return true if live interval is removed.
620 bool
621 SimpleRegisterCoalescing::ShortenDeadCopySrcLiveRange(LiveInterval &li,
622                                                       MachineInstr *CopyMI) {
623   unsigned CopyIdx = li_->getInstructionIndex(CopyMI);
624   if (CopyIdx == 0) {
625     // FIXME: special case: function live in. It can be a general case if the
626     // first instruction index starts at > 0 value.
627     assert(TargetRegisterInfo::isPhysicalRegister(li.reg));
628     // Live-in to the function but dead. Remove it from entry live-in set.
629     mf_->begin()->removeLiveIn(li.reg);
630     const LiveRange *LR = li.getLiveRangeContaining(CopyIdx);
631     removeRange(li, LR->start, LR->end, li_, tri_);
632     return removeIntervalIfEmpty(li, li_, tri_);
633   }
634
635   LiveInterval::iterator LR = li.FindLiveRangeContaining(CopyIdx-1);
636   if (LR == li.end())
637     // Livein but defined by a phi.
638     return false;
639
640   unsigned RemoveStart = LR->start;
641   unsigned RemoveEnd = li_->getDefIndex(CopyIdx)+1;
642   if (LR->end > RemoveEnd)
643     // More uses past this copy? Nothing to do.
644     return false;
645
646   unsigned LastUseIdx;
647   MachineOperand *LastUse = lastRegisterUse(LR->start, CopyIdx-1, li.reg,
648                                             LastUseIdx);
649   if (LastUse) {
650     // There are uses before the copy, just shorten the live range to the end
651     // of last use.
652     LastUse->setIsKill();
653     MachineInstr *LastUseMI = LastUse->getParent();
654     removeRange(li, li_->getDefIndex(LastUseIdx), LR->end, li_, tri_);
655     unsigned SrcReg, DstReg;
656     if (tii_->isMoveInstr(*LastUseMI, SrcReg, DstReg) &&
657         DstReg == li.reg) {
658       // Last use is itself an identity code.
659       int DeadIdx = LastUseMI->findRegisterDefOperandIdx(li.reg, false, tri_);
660       LastUseMI->getOperand(DeadIdx).setIsDead();
661     }
662     return false;
663   }
664
665   // Is it livein?
666   MachineBasicBlock *CopyMBB = CopyMI->getParent();
667   unsigned MBBStart = li_->getMBBStartIdx(CopyMBB);
668   if (LR->start <= MBBStart && LR->end > MBBStart) {
669     if (LR->start == 0) {
670       assert(TargetRegisterInfo::isPhysicalRegister(li.reg));
671       // Live-in to the function but dead. Remove it from entry live-in set.
672       mf_->begin()->removeLiveIn(li.reg);
673     }
674     // FIXME: Shorten intervals in BBs that reaches this BB.
675   }
676
677   if (LR->valno->def == RemoveStart)
678     // If the def MI defines the val#, propagate the dead marker.
679     PropagateDeadness(li, CopyMI, RemoveStart, li_, tri_);
680
681   removeRange(li, RemoveStart, LR->end, li_, tri_);
682   return removeIntervalIfEmpty(li, li_, tri_);
683 }
684
685 /// CanCoalesceWithImpDef - Returns true if the specified copy instruction
686 /// from an implicit def to another register can be coalesced away.
687 bool SimpleRegisterCoalescing::CanCoalesceWithImpDef(MachineInstr *CopyMI,
688                                                      LiveInterval &li,
689                                                      LiveInterval &ImpLi) const{
690   if (!CopyMI->killsRegister(ImpLi.reg))
691     return false;
692   unsigned CopyIdx = li_->getDefIndex(li_->getInstructionIndex(CopyMI));
693   LiveInterval::iterator LR = li.FindLiveRangeContaining(CopyIdx);
694   if (LR == li.end())
695     return false;
696   if (LR->valno->hasPHIKill)
697     return false;
698   if (LR->valno->def != CopyIdx)
699     return false;
700   // Make sure all of val# uses are copies.
701   for (MachineRegisterInfo::use_iterator UI = mri_->use_begin(li.reg),
702          UE = mri_->use_end(); UI != UE;) {
703     MachineInstr *UseMI = &*UI;
704     ++UI;
705     if (JoinedCopies.count(UseMI))
706       continue;
707     unsigned UseIdx = li_->getUseIndex(li_->getInstructionIndex(UseMI));
708     LiveInterval::iterator ULR = li.FindLiveRangeContaining(UseIdx);
709     if (ULR == li.end() || ULR->valno != LR->valno)
710       continue;
711     // If the use is not a use, then it's not safe to coalesce the move.
712     unsigned SrcReg, DstReg;
713     if (!tii_->isMoveInstr(*UseMI, SrcReg, DstReg)) {
714       if (UseMI->getOpcode() == TargetInstrInfo::INSERT_SUBREG &&
715           UseMI->getOperand(1).getReg() == li.reg)
716         continue;
717       return false;
718     }
719   }
720   return true;
721 }
722
723
724 /// RemoveCopiesFromValNo - The specified value# is defined by an implicit
725 /// def and it is being removed. Turn all copies from this value# into
726 /// identity copies so they will be removed.
727 void SimpleRegisterCoalescing::RemoveCopiesFromValNo(LiveInterval &li,
728                                                      VNInfo *VNI) {
729   MachineInstr *ImpDef = NULL;
730   MachineOperand *LastUse = NULL;
731   unsigned LastUseIdx = li_->getUseIndex(VNI->def);
732   for (MachineRegisterInfo::reg_iterator RI = mri_->reg_begin(li.reg),
733          RE = mri_->reg_end(); RI != RE;) {
734     MachineOperand *MO = &RI.getOperand();
735     MachineInstr *MI = &*RI;
736     ++RI;
737     if (MO->isDef()) {
738       if (MI->getOpcode() == TargetInstrInfo::IMPLICIT_DEF) {
739         assert(!ImpDef && "Multiple implicit_def defining same register?");
740         ImpDef = MI;
741       }
742       continue;
743     }
744     if (JoinedCopies.count(MI))
745       continue;
746     unsigned UseIdx = li_->getUseIndex(li_->getInstructionIndex(MI));
747     LiveInterval::iterator ULR = li.FindLiveRangeContaining(UseIdx);
748     if (ULR == li.end() || ULR->valno != VNI)
749       continue;
750     // If the use is a copy, turn it into an identity copy.
751     unsigned SrcReg, DstReg;
752     if (tii_->isMoveInstr(*MI, SrcReg, DstReg) && SrcReg == li.reg) {
753       // Each use MI may have multiple uses of this register. Change them all.
754       for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
755         MachineOperand &MO = MI->getOperand(i);
756         if (MO.isReg() && MO.getReg() == li.reg)
757           MO.setReg(DstReg);
758       }
759       JoinedCopies.insert(MI);
760     } else if (UseIdx > LastUseIdx) {
761       LastUseIdx = UseIdx;
762       LastUse = MO;
763     }
764   }
765   if (LastUse)
766     LastUse->setIsKill();
767   else {
768     // Remove dead implicit_def.
769     li_->RemoveMachineInstrFromMaps(ImpDef);
770     ImpDef->eraseFromParent();
771   }
772 }
773
774 static unsigned getMatchingSuperReg(unsigned Reg, unsigned SubIdx, 
775                                     const TargetRegisterClass *RC,
776                                     const TargetRegisterInfo* TRI) {
777   for (const unsigned *SRs = TRI->getSuperRegisters(Reg);
778        unsigned SR = *SRs; ++SRs)
779     if (Reg == TRI->getSubReg(SR, SubIdx) && RC->contains(SR))
780       return SR;
781   return 0;
782 }
783
784 /// JoinCopy - Attempt to join intervals corresponding to SrcReg/DstReg,
785 /// which are the src/dst of the copy instruction CopyMI.  This returns true
786 /// if the copy was successfully coalesced away. If it is not currently
787 /// possible to coalesce this interval, but it may be possible if other
788 /// things get coalesced, then it returns true by reference in 'Again'.
789 bool SimpleRegisterCoalescing::JoinCopy(CopyRec &TheCopy, bool &Again) {
790   MachineInstr *CopyMI = TheCopy.MI;
791
792   Again = false;
793   if (JoinedCopies.count(CopyMI))
794     return false; // Already done.
795
796   DOUT << li_->getInstructionIndex(CopyMI) << '\t' << *CopyMI;
797
798   unsigned SrcReg;
799   unsigned DstReg;
800   bool isExtSubReg = CopyMI->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG;
801   bool isInsSubReg = CopyMI->getOpcode() == TargetInstrInfo::INSERT_SUBREG;
802   unsigned SubIdx = 0;
803   if (isExtSubReg) {
804     DstReg = CopyMI->getOperand(0).getReg();
805     SrcReg = CopyMI->getOperand(1).getReg();
806   } else if (isInsSubReg) {
807     if (CopyMI->getOperand(2).getSubReg()) {
808       DOUT << "\tSource of insert_subreg is already coalesced "
809            << "to another register.\n";
810       return false;  // Not coalescable.
811     }
812     DstReg = CopyMI->getOperand(0).getReg();
813     SrcReg = CopyMI->getOperand(2).getReg();
814   } else if (!tii_->isMoveInstr(*CopyMI, SrcReg, DstReg)) {
815     assert(0 && "Unrecognized copy instruction!");
816     return false;
817   }
818
819   // If they are already joined we continue.
820   if (SrcReg == DstReg) {
821     DOUT << "\tCopy already coalesced.\n";
822     return false;  // Not coalescable.
823   }
824   
825   bool SrcIsPhys = TargetRegisterInfo::isPhysicalRegister(SrcReg);
826   bool DstIsPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
827
828   // If they are both physical registers, we cannot join them.
829   if (SrcIsPhys && DstIsPhys) {
830     DOUT << "\tCan not coalesce physregs.\n";
831     return false;  // Not coalescable.
832   }
833   
834   // We only join virtual registers with allocatable physical registers.
835   if (SrcIsPhys && !allocatableRegs_[SrcReg]) {
836     DOUT << "\tSrc reg is unallocatable physreg.\n";
837     return false;  // Not coalescable.
838   }
839   if (DstIsPhys && !allocatableRegs_[DstReg]) {
840     DOUT << "\tDst reg is unallocatable physreg.\n";
841     return false;  // Not coalescable.
842   }
843
844   unsigned RealDstReg = 0;
845   unsigned RealSrcReg = 0;
846   if (isExtSubReg || isInsSubReg) {
847     SubIdx = CopyMI->getOperand(isExtSubReg ? 2 : 3).getImm();
848     if (SrcIsPhys && isExtSubReg) {
849       // r1024 = EXTRACT_SUBREG EAX, 0 then r1024 is really going to be
850       // coalesced with AX.
851       unsigned DstSubIdx = CopyMI->getOperand(0).getSubReg();
852       assert(!DstSubIdx || DstSubIdx == SubIdx);
853       if (DstSubIdx != SubIdx)
854         // r1024<2> = EXTRACT_SUBREG EAX, 0. Then r1024 has already been
855         // coalesced to an INSERT_SUBREG so the subreg indices cancel out.
856         SrcReg = tri_->getSubReg(SrcReg, SubIdx);
857       SubIdx = 0;
858     } else if (DstIsPhys && isInsSubReg) {
859       // EAX = INSERT_SUBREG EAX, r1024, 0
860       unsigned SrcSubIdx = CopyMI->getOperand(2).getSubReg();
861       assert(!SrcSubIdx || SrcSubIdx == SubIdx);
862       if (SrcSubIdx != SubIdx)
863         // EAX = INSERT_SUBREG EAX, r1024<2>, 0 Then r1024 has already been
864         // coalesced to an EXTRACT_SUBREG so the subreg indices cancel out.
865       DstReg = tri_->getSubReg(DstReg, SubIdx);
866       SubIdx = 0;
867     } else if ((DstIsPhys && isExtSubReg) || (SrcIsPhys && isInsSubReg)) {
868       // If this is a extract_subreg where dst is a physical register, e.g.
869       // cl = EXTRACT_SUBREG reg1024, 1
870       // then create and update the actual physical register allocated to RHS.
871       // Ditto for
872       // reg1024 = INSERT_SUBREG r1024, cl, 1
873       const TargetRegisterClass *RC =
874         mri_->getRegClass(isExtSubReg ? SrcReg : DstReg);
875       if (isExtSubReg) {
876         RealDstReg = getMatchingSuperReg(DstReg, SubIdx, RC, tri_);
877         assert(RealDstReg && "Invalid extra_subreg instruction!");
878       } else {
879         RealSrcReg = getMatchingSuperReg(SrcReg, SubIdx, RC, tri_);
880         assert(RealSrcReg && "Invalid extra_subreg instruction!");
881       }
882
883       // For this type of EXTRACT_SUBREG, conservatively
884       // check if the live interval of the source register interfere with the
885       // actual super physical register we are trying to coalesce with.
886       unsigned PhysReg = isExtSubReg ? RealDstReg : RealSrcReg;
887       LiveInterval &RHS = li_->getInterval(isExtSubReg ? SrcReg : DstReg);
888       if (li_->hasInterval(PhysReg) &&
889           RHS.overlaps(li_->getInterval(PhysReg))) {
890         DOUT << "Interfere with register ";
891         DEBUG(li_->getInterval(PhysReg).print(DOUT, tri_));
892         return false; // Not coalescable
893       }
894       for (const unsigned* SR = tri_->getSubRegisters(PhysReg); *SR; ++SR)
895         if (li_->hasInterval(*SR) && RHS.overlaps(li_->getInterval(*SR))) {
896           DOUT << "Interfere with sub-register ";
897           DEBUG(li_->getInterval(*SR).print(DOUT, tri_));
898           return false; // Not coalescable
899         }
900       SubIdx = 0;
901     } else {
902       unsigned LargeReg = isExtSubReg ? SrcReg : DstReg;
903       unsigned SmallReg = isExtSubReg ? DstReg : SrcReg;
904       unsigned LargeRegSize =
905         li_->getInterval(LargeReg).getSize() / InstrSlots::NUM;
906       unsigned SmallRegSize =
907         li_->getInterval(SmallReg).getSize() / InstrSlots::NUM;
908       const TargetRegisterClass *RC = mri_->getRegClass(SmallReg);
909       unsigned Threshold = allocatableRCRegs_[RC].count();
910       // Be conservative. If both sides are virtual registers, do not coalesce
911       // if this will cause a high use density interval to target a smaller set
912       // of registers.
913       if (SmallRegSize > Threshold || LargeRegSize > Threshold) {
914         LiveVariables::VarInfo &svi = lv_->getVarInfo(LargeReg);
915         LiveVariables::VarInfo &dvi = lv_->getVarInfo(SmallReg);
916         if ((float)dvi.NumUses / SmallRegSize <
917             (float)svi.NumUses / LargeRegSize) {
918           Again = true;  // May be possible to coalesce later.
919           return false;
920         }
921       }
922     }
923   } else if (differingRegisterClasses(SrcReg, DstReg)) {
924     // FIXME: What if the resul of a EXTRACT_SUBREG is then coalesced
925     // with another? If it's the resulting destination register, then
926     // the subidx must be propagated to uses (but only those defined
927     // by the EXTRACT_SUBREG). If it's being coalesced into another
928     // register, it should be safe because register is assumed to have
929     // the register class of the super-register.
930
931     // If they are not of the same register class, we cannot join them.
932     DOUT << "\tSrc/Dest are different register classes.\n";
933     // Allow the coalescer to try again in case either side gets coalesced to
934     // a physical register that's compatible with the other side. e.g.
935     // r1024 = MOV32to32_ r1025
936     // but later r1024 is assigned EAX then r1025 may be coalesced with EAX.
937     Again = true;  // May be possible to coalesce later.
938     return false;
939   }
940   
941   LiveInterval &SrcInt = li_->getInterval(SrcReg);
942   LiveInterval &DstInt = li_->getInterval(DstReg);
943   assert(SrcInt.reg == SrcReg && DstInt.reg == DstReg &&
944          "Register mapping is horribly broken!");
945
946   DOUT << "\t\tInspecting "; SrcInt.print(DOUT, tri_);
947   DOUT << " and "; DstInt.print(DOUT, tri_);
948   DOUT << ": ";
949
950   // Check if it is necessary to propagate "isDead" property.
951   if (!isExtSubReg && !isInsSubReg) {
952     MachineOperand *mopd = CopyMI->findRegisterDefOperand(DstReg, false);
953     bool isDead = mopd->isDead();
954
955     // We need to be careful about coalescing a source physical register with a
956     // virtual register. Once the coalescing is done, it cannot be broken and
957     // these are not spillable! If the destination interval uses are far away,
958     // think twice about coalescing them!
959     if (!isDead && (SrcIsPhys || DstIsPhys)) {
960       LiveInterval &JoinVInt = SrcIsPhys ? DstInt : SrcInt;
961       unsigned JoinVReg = SrcIsPhys ? DstReg : SrcReg;
962       unsigned JoinPReg = SrcIsPhys ? SrcReg : DstReg;
963       const TargetRegisterClass *RC = mri_->getRegClass(JoinVReg);
964       unsigned Threshold = allocatableRCRegs_[RC].count() * 2;
965       if (TheCopy.isBackEdge)
966         Threshold *= 2; // Favors back edge copies.
967
968       // If the virtual register live interval is long but it has low use desity,
969       // do not join them, instead mark the physical register as its allocation
970       // preference.
971       unsigned Length = JoinVInt.getSize() / InstrSlots::NUM;
972       LiveVariables::VarInfo &vi = lv_->getVarInfo(JoinVReg);
973       if (Length > Threshold &&
974           (((float)vi.NumUses / Length) < (1.0 / Threshold))) {
975         JoinVInt.preference = JoinPReg;
976         ++numAborts;
977         DOUT << "\tMay tie down a physical register, abort!\n";
978         Again = true;  // May be possible to coalesce later.
979         return false;
980       }
981     }
982   }
983
984   // Okay, attempt to join these two intervals.  On failure, this returns false.
985   // Otherwise, if one of the intervals being joined is a physreg, this method
986   // always canonicalizes DstInt to be it.  The output "SrcInt" will not have
987   // been modified, so we can use this information below to update aliases.
988   bool Swapped = false;
989   // If SrcInt is implicitly defined, it's safe to coalesce.
990   bool isEmpty = SrcInt.empty();
991   if (isEmpty && !CanCoalesceWithImpDef(CopyMI, DstInt, SrcInt)) {
992     // Only coalesce an empty interval (defined by implicit_def) with
993     // another interval which has a valno defined by the CopyMI and the CopyMI
994     // is a kill of the implicit def.
995     DOUT << "Not profitable!\n";
996     return false;
997   }
998
999   if (!isEmpty && !JoinIntervals(DstInt, SrcInt, Swapped)) {
1000     // Coalescing failed.
1001     
1002     // If we can eliminate the copy without merging the live ranges, do so now.
1003     if (!isExtSubReg && !isInsSubReg &&
1004         (AdjustCopiesBackFrom(SrcInt, DstInt, CopyMI) ||
1005          RemoveCopyByCommutingDef(SrcInt, DstInt, CopyMI))) {
1006       JoinedCopies.insert(CopyMI);
1007       return true;
1008     }
1009     
1010     // Otherwise, we are unable to join the intervals.
1011     DOUT << "Interference!\n";
1012     Again = true;  // May be possible to coalesce later.
1013     return false;
1014   }
1015
1016   LiveInterval *ResSrcInt = &SrcInt;
1017   LiveInterval *ResDstInt = &DstInt;
1018   if (Swapped) {
1019     std::swap(SrcReg, DstReg);
1020     std::swap(ResSrcInt, ResDstInt);
1021   }
1022   assert(TargetRegisterInfo::isVirtualRegister(SrcReg) &&
1023          "LiveInterval::join didn't work right!");
1024                                
1025   // If we're about to merge live ranges into a physical register live range,
1026   // we have to update any aliased register's live ranges to indicate that they
1027   // have clobbered values for this range.
1028   if (TargetRegisterInfo::isPhysicalRegister(DstReg)) {
1029     // If this is a extract_subreg where dst is a physical register, e.g.
1030     // cl = EXTRACT_SUBREG reg1024, 1
1031     // then create and update the actual physical register allocated to RHS.
1032     if (RealDstReg || RealSrcReg) {
1033       LiveInterval &RealInt =
1034         li_->getOrCreateInterval(RealDstReg ? RealDstReg : RealSrcReg);
1035       SmallSet<const VNInfo*, 4> CopiedValNos;
1036       for (LiveInterval::Ranges::const_iterator I = ResSrcInt->ranges.begin(),
1037              E = ResSrcInt->ranges.end(); I != E; ++I) {
1038         const LiveRange *DstLR = ResDstInt->getLiveRangeContaining(I->start);
1039         assert(DstLR  && "Invalid joined interval!");
1040         const VNInfo *DstValNo = DstLR->valno;
1041         if (CopiedValNos.insert(DstValNo)) {
1042           VNInfo *ValNo = RealInt.getNextValue(DstValNo->def, DstValNo->copy,
1043                                                li_->getVNInfoAllocator());
1044           ValNo->hasPHIKill = DstValNo->hasPHIKill;
1045           RealInt.addKills(ValNo, DstValNo->kills);
1046           RealInt.MergeValueInAsValue(*ResDstInt, DstValNo, ValNo);
1047         }
1048       }
1049       
1050       DstReg = RealDstReg ? RealDstReg : RealSrcReg;
1051     }
1052
1053     // Update the liveintervals of sub-registers.
1054     for (const unsigned *AS = tri_->getSubRegisters(DstReg); *AS; ++AS)
1055       li_->getOrCreateInterval(*AS).MergeInClobberRanges(*ResSrcInt,
1056                                                  li_->getVNInfoAllocator());
1057   } else {
1058     // Merge use info if the destination is a virtual register.
1059     LiveVariables::VarInfo& dVI = lv_->getVarInfo(DstReg);
1060     LiveVariables::VarInfo& sVI = lv_->getVarInfo(SrcReg);
1061     dVI.NumUses += sVI.NumUses;
1062   }
1063
1064   // If this is a EXTRACT_SUBREG, make sure the result of coalescing is the
1065   // larger super-register.
1066   if ((isExtSubReg || isInsSubReg) && !SrcIsPhys && !DstIsPhys) {
1067     if ((isExtSubReg && !Swapped) || (isInsSubReg && Swapped)) {
1068       ResSrcInt->Copy(*ResDstInt, li_->getVNInfoAllocator());
1069       std::swap(SrcReg, DstReg);
1070       std::swap(ResSrcInt, ResDstInt);
1071     }
1072   }
1073
1074   if (NewHeuristic) {
1075     // Add all copies that define val# in the source interval into the queue.
1076     for (LiveInterval::const_vni_iterator i = ResSrcInt->vni_begin(),
1077            e = ResSrcInt->vni_end(); i != e; ++i) {
1078       const VNInfo *vni = *i;
1079       if (!vni->def || vni->def == ~1U || vni->def == ~0U)
1080         continue;
1081       MachineInstr *CopyMI = li_->getInstructionFromIndex(vni->def);
1082       unsigned NewSrcReg, NewDstReg;
1083       if (CopyMI &&
1084           JoinedCopies.count(CopyMI) == 0 &&
1085           tii_->isMoveInstr(*CopyMI, NewSrcReg, NewDstReg)) {
1086         unsigned LoopDepth = loopInfo->getLoopDepth(CopyMI->getParent());
1087         JoinQueue->push(CopyRec(CopyMI, LoopDepth,
1088                                 isBackEdgeCopy(CopyMI, DstReg)));
1089       }
1090     }
1091   }
1092
1093   // Remember to delete the copy instruction.
1094   JoinedCopies.insert(CopyMI);
1095
1096   // Some live range has been lengthened due to colaescing, eliminate the
1097   // unnecessary kills.
1098   RemoveUnnecessaryKills(SrcReg, *ResDstInt);
1099   if (TargetRegisterInfo::isVirtualRegister(DstReg))
1100     RemoveUnnecessaryKills(DstReg, *ResDstInt);
1101
1102   // SrcReg is guarateed to be the register whose live interval that is
1103   // being merged.
1104   li_->removeInterval(SrcReg);
1105   if (isInsSubReg)
1106     // Avoid:
1107     // r1024 = op
1108     // r1024 = implicit_def
1109     // ...
1110     //       = r1024
1111     RemoveDeadImpDef(DstReg, *ResDstInt);
1112   UpdateRegDefsUses(SrcReg, DstReg, SubIdx);
1113
1114   if (isEmpty) {
1115     // Now the copy is being coalesced away, the val# previously defined
1116     // by the copy is being defined by an IMPLICIT_DEF which defines a zero
1117     // length interval. Remove the val#.
1118     unsigned CopyIdx = li_->getDefIndex(li_->getInstructionIndex(CopyMI));
1119     const LiveRange *LR = ResDstInt->getLiveRangeContaining(CopyIdx);
1120     VNInfo *ImpVal = LR->valno;
1121     assert(ImpVal->def == CopyIdx);
1122     unsigned NextDef = LR->end;
1123     RemoveCopiesFromValNo(*ResDstInt, ImpVal);
1124     ResDstInt->removeValNo(ImpVal);
1125     LR = ResDstInt->FindLiveRangeContaining(NextDef);
1126     if (LR != ResDstInt->end() && LR->valno->def == NextDef) {
1127       // Special case: vr1024 = implicit_def
1128       //               vr1024 = insert_subreg vr1024, vr1025, c
1129       // The insert_subreg becomes a "copy" that defines a val# which can itself
1130       // be coalesced away.
1131       MachineInstr *DefMI = li_->getInstructionFromIndex(NextDef);
1132       if (DefMI->getOpcode() == TargetInstrInfo::INSERT_SUBREG)
1133         LR->valno->copy = DefMI;
1134     }
1135   }
1136
1137   DOUT << "\n\t\tJoined.  Result = "; ResDstInt->print(DOUT, tri_);
1138   DOUT << "\n";
1139
1140   ++numJoins;
1141   return true;
1142 }
1143
1144 /// ComputeUltimateVN - Assuming we are going to join two live intervals,
1145 /// compute what the resultant value numbers for each value in the input two
1146 /// ranges will be.  This is complicated by copies between the two which can
1147 /// and will commonly cause multiple value numbers to be merged into one.
1148 ///
1149 /// VN is the value number that we're trying to resolve.  InstDefiningValue
1150 /// keeps track of the new InstDefiningValue assignment for the result
1151 /// LiveInterval.  ThisFromOther/OtherFromThis are sets that keep track of
1152 /// whether a value in this or other is a copy from the opposite set.
1153 /// ThisValNoAssignments/OtherValNoAssignments keep track of value #'s that have
1154 /// already been assigned.
1155 ///
1156 /// ThisFromOther[x] - If x is defined as a copy from the other interval, this
1157 /// contains the value number the copy is from.
1158 ///
1159 static unsigned ComputeUltimateVN(VNInfo *VNI,
1160                                   SmallVector<VNInfo*, 16> &NewVNInfo,
1161                                   DenseMap<VNInfo*, VNInfo*> &ThisFromOther,
1162                                   DenseMap<VNInfo*, VNInfo*> &OtherFromThis,
1163                                   SmallVector<int, 16> &ThisValNoAssignments,
1164                                   SmallVector<int, 16> &OtherValNoAssignments) {
1165   unsigned VN = VNI->id;
1166
1167   // If the VN has already been computed, just return it.
1168   if (ThisValNoAssignments[VN] >= 0)
1169     return ThisValNoAssignments[VN];
1170 //  assert(ThisValNoAssignments[VN] != -2 && "Cyclic case?");
1171
1172   // If this val is not a copy from the other val, then it must be a new value
1173   // number in the destination.
1174   DenseMap<VNInfo*, VNInfo*>::iterator I = ThisFromOther.find(VNI);
1175   if (I == ThisFromOther.end()) {
1176     NewVNInfo.push_back(VNI);
1177     return ThisValNoAssignments[VN] = NewVNInfo.size()-1;
1178   }
1179   VNInfo *OtherValNo = I->second;
1180
1181   // Otherwise, this *is* a copy from the RHS.  If the other side has already
1182   // been computed, return it.
1183   if (OtherValNoAssignments[OtherValNo->id] >= 0)
1184     return ThisValNoAssignments[VN] = OtherValNoAssignments[OtherValNo->id];
1185   
1186   // Mark this value number as currently being computed, then ask what the
1187   // ultimate value # of the other value is.
1188   ThisValNoAssignments[VN] = -2;
1189   unsigned UltimateVN =
1190     ComputeUltimateVN(OtherValNo, NewVNInfo, OtherFromThis, ThisFromOther,
1191                       OtherValNoAssignments, ThisValNoAssignments);
1192   return ThisValNoAssignments[VN] = UltimateVN;
1193 }
1194
1195 static bool InVector(VNInfo *Val, const SmallVector<VNInfo*, 8> &V) {
1196   return std::find(V.begin(), V.end(), Val) != V.end();
1197 }
1198
1199 /// RangeIsDefinedByCopyFromReg - Return true if the specified live range of
1200 /// the specified live interval is defined by a copy from the specified
1201 /// register.
1202 bool SimpleRegisterCoalescing::RangeIsDefinedByCopyFromReg(LiveInterval &li,
1203                                                            LiveRange *LR,
1204                                                            unsigned Reg) {
1205   unsigned SrcReg = li_->getVNInfoSourceReg(LR->valno);
1206   if (SrcReg == Reg)
1207     return true;
1208   if (LR->valno->def == ~0U &&
1209       TargetRegisterInfo::isPhysicalRegister(li.reg) &&
1210       *tri_->getSuperRegisters(li.reg)) {
1211     // It's a sub-register live interval, we may not have precise information.
1212     // Re-compute it.
1213     MachineInstr *DefMI = li_->getInstructionFromIndex(LR->start);
1214     unsigned SrcReg, DstReg;
1215     if (tii_->isMoveInstr(*DefMI, SrcReg, DstReg) &&
1216         DstReg == li.reg && SrcReg == Reg) {
1217       // Cache computed info.
1218       LR->valno->def  = LR->start;
1219       LR->valno->copy = DefMI;
1220       return true;
1221     }
1222   }
1223   return false;
1224 }
1225
1226 /// SimpleJoin - Attempt to joint the specified interval into this one. The
1227 /// caller of this method must guarantee that the RHS only contains a single
1228 /// value number and that the RHS is not defined by a copy from this
1229 /// interval.  This returns false if the intervals are not joinable, or it
1230 /// joins them and returns true.
1231 bool SimpleRegisterCoalescing::SimpleJoin(LiveInterval &LHS, LiveInterval &RHS){
1232   assert(RHS.containsOneValue());
1233   
1234   // Some number (potentially more than one) value numbers in the current
1235   // interval may be defined as copies from the RHS.  Scan the overlapping
1236   // portions of the LHS and RHS, keeping track of this and looking for
1237   // overlapping live ranges that are NOT defined as copies.  If these exist, we
1238   // cannot coalesce.
1239   
1240   LiveInterval::iterator LHSIt = LHS.begin(), LHSEnd = LHS.end();
1241   LiveInterval::iterator RHSIt = RHS.begin(), RHSEnd = RHS.end();
1242   
1243   if (LHSIt->start < RHSIt->start) {
1244     LHSIt = std::upper_bound(LHSIt, LHSEnd, RHSIt->start);
1245     if (LHSIt != LHS.begin()) --LHSIt;
1246   } else if (RHSIt->start < LHSIt->start) {
1247     RHSIt = std::upper_bound(RHSIt, RHSEnd, LHSIt->start);
1248     if (RHSIt != RHS.begin()) --RHSIt;
1249   }
1250   
1251   SmallVector<VNInfo*, 8> EliminatedLHSVals;
1252   
1253   while (1) {
1254     // Determine if these live intervals overlap.
1255     bool Overlaps = false;
1256     if (LHSIt->start <= RHSIt->start)
1257       Overlaps = LHSIt->end > RHSIt->start;
1258     else
1259       Overlaps = RHSIt->end > LHSIt->start;
1260     
1261     // If the live intervals overlap, there are two interesting cases: if the
1262     // LHS interval is defined by a copy from the RHS, it's ok and we record
1263     // that the LHS value # is the same as the RHS.  If it's not, then we cannot
1264     // coalesce these live ranges and we bail out.
1265     if (Overlaps) {
1266       // If we haven't already recorded that this value # is safe, check it.
1267       if (!InVector(LHSIt->valno, EliminatedLHSVals)) {
1268         // Copy from the RHS?
1269         if (!RangeIsDefinedByCopyFromReg(LHS, LHSIt, RHS.reg))
1270           return false;    // Nope, bail out.
1271         
1272         EliminatedLHSVals.push_back(LHSIt->valno);
1273       }
1274       
1275       // We know this entire LHS live range is okay, so skip it now.
1276       if (++LHSIt == LHSEnd) break;
1277       continue;
1278     }
1279     
1280     if (LHSIt->end < RHSIt->end) {
1281       if (++LHSIt == LHSEnd) break;
1282     } else {
1283       // One interesting case to check here.  It's possible that we have
1284       // something like "X3 = Y" which defines a new value number in the LHS,
1285       // and is the last use of this liverange of the RHS.  In this case, we
1286       // want to notice this copy (so that it gets coalesced away) even though
1287       // the live ranges don't actually overlap.
1288       if (LHSIt->start == RHSIt->end) {
1289         if (InVector(LHSIt->valno, EliminatedLHSVals)) {
1290           // We already know that this value number is going to be merged in
1291           // if coalescing succeeds.  Just skip the liverange.
1292           if (++LHSIt == LHSEnd) break;
1293         } else {
1294           // Otherwise, if this is a copy from the RHS, mark it as being merged
1295           // in.
1296           if (RangeIsDefinedByCopyFromReg(LHS, LHSIt, RHS.reg)) {
1297             EliminatedLHSVals.push_back(LHSIt->valno);
1298
1299             // We know this entire LHS live range is okay, so skip it now.
1300             if (++LHSIt == LHSEnd) break;
1301           }
1302         }
1303       }
1304       
1305       if (++RHSIt == RHSEnd) break;
1306     }
1307   }
1308   
1309   // If we got here, we know that the coalescing will be successful and that
1310   // the value numbers in EliminatedLHSVals will all be merged together.  Since
1311   // the most common case is that EliminatedLHSVals has a single number, we
1312   // optimize for it: if there is more than one value, we merge them all into
1313   // the lowest numbered one, then handle the interval as if we were merging
1314   // with one value number.
1315   VNInfo *LHSValNo;
1316   if (EliminatedLHSVals.size() > 1) {
1317     // Loop through all the equal value numbers merging them into the smallest
1318     // one.
1319     VNInfo *Smallest = EliminatedLHSVals[0];
1320     for (unsigned i = 1, e = EliminatedLHSVals.size(); i != e; ++i) {
1321       if (EliminatedLHSVals[i]->id < Smallest->id) {
1322         // Merge the current notion of the smallest into the smaller one.
1323         LHS.MergeValueNumberInto(Smallest, EliminatedLHSVals[i]);
1324         Smallest = EliminatedLHSVals[i];
1325       } else {
1326         // Merge into the smallest.
1327         LHS.MergeValueNumberInto(EliminatedLHSVals[i], Smallest);
1328       }
1329     }
1330     LHSValNo = Smallest;
1331   } else if (EliminatedLHSVals.empty()) {
1332     if (TargetRegisterInfo::isPhysicalRegister(LHS.reg) &&
1333         *tri_->getSuperRegisters(LHS.reg))
1334       // Imprecise sub-register information. Can't handle it.
1335       return false;
1336     assert(0 && "No copies from the RHS?");
1337   } else {
1338     LHSValNo = EliminatedLHSVals[0];
1339   }
1340   
1341   // Okay, now that there is a single LHS value number that we're merging the
1342   // RHS into, update the value number info for the LHS to indicate that the
1343   // value number is defined where the RHS value number was.
1344   const VNInfo *VNI = RHS.getValNumInfo(0);
1345   LHSValNo->def  = VNI->def;
1346   LHSValNo->copy = VNI->copy;
1347   
1348   // Okay, the final step is to loop over the RHS live intervals, adding them to
1349   // the LHS.
1350   LHSValNo->hasPHIKill |= VNI->hasPHIKill;
1351   LHS.addKills(LHSValNo, VNI->kills);
1352   LHS.MergeRangesInAsValue(RHS, LHSValNo);
1353   LHS.weight += RHS.weight;
1354   if (RHS.preference && !LHS.preference)
1355     LHS.preference = RHS.preference;
1356   
1357   return true;
1358 }
1359
1360 /// JoinIntervals - Attempt to join these two intervals.  On failure, this
1361 /// returns false.  Otherwise, if one of the intervals being joined is a
1362 /// physreg, this method always canonicalizes LHS to be it.  The output
1363 /// "RHS" will not have been modified, so we can use this information
1364 /// below to update aliases.
1365 bool SimpleRegisterCoalescing::JoinIntervals(LiveInterval &LHS,
1366                                              LiveInterval &RHS, bool &Swapped) {
1367   // Compute the final value assignment, assuming that the live ranges can be
1368   // coalesced.
1369   SmallVector<int, 16> LHSValNoAssignments;
1370   SmallVector<int, 16> RHSValNoAssignments;
1371   DenseMap<VNInfo*, VNInfo*> LHSValsDefinedFromRHS;
1372   DenseMap<VNInfo*, VNInfo*> RHSValsDefinedFromLHS;
1373   SmallVector<VNInfo*, 16> NewVNInfo;
1374                           
1375   // If a live interval is a physical register, conservatively check if any
1376   // of its sub-registers is overlapping the live interval of the virtual
1377   // register. If so, do not coalesce.
1378   if (TargetRegisterInfo::isPhysicalRegister(LHS.reg) &&
1379       *tri_->getSubRegisters(LHS.reg)) {
1380     for (const unsigned* SR = tri_->getSubRegisters(LHS.reg); *SR; ++SR)
1381       if (li_->hasInterval(*SR) && RHS.overlaps(li_->getInterval(*SR))) {
1382         DOUT << "Interfere with sub-register ";
1383         DEBUG(li_->getInterval(*SR).print(DOUT, tri_));
1384         return false;
1385       }
1386   } else if (TargetRegisterInfo::isPhysicalRegister(RHS.reg) &&
1387              *tri_->getSubRegisters(RHS.reg)) {
1388     for (const unsigned* SR = tri_->getSubRegisters(RHS.reg); *SR; ++SR)
1389       if (li_->hasInterval(*SR) && LHS.overlaps(li_->getInterval(*SR))) {
1390         DOUT << "Interfere with sub-register ";
1391         DEBUG(li_->getInterval(*SR).print(DOUT, tri_));
1392         return false;
1393       }
1394   }
1395                           
1396   // Compute ultimate value numbers for the LHS and RHS values.
1397   if (RHS.containsOneValue()) {
1398     // Copies from a liveinterval with a single value are simple to handle and
1399     // very common, handle the special case here.  This is important, because
1400     // often RHS is small and LHS is large (e.g. a physreg).
1401     
1402     // Find out if the RHS is defined as a copy from some value in the LHS.
1403     int RHSVal0DefinedFromLHS = -1;
1404     int RHSValID = -1;
1405     VNInfo *RHSValNoInfo = NULL;
1406     VNInfo *RHSValNoInfo0 = RHS.getValNumInfo(0);
1407     unsigned RHSSrcReg = li_->getVNInfoSourceReg(RHSValNoInfo0);
1408     if ((RHSSrcReg == 0 || RHSSrcReg != LHS.reg)) {
1409       // If RHS is not defined as a copy from the LHS, we can use simpler and
1410       // faster checks to see if the live ranges are coalescable.  This joiner
1411       // can't swap the LHS/RHS intervals though.
1412       if (!TargetRegisterInfo::isPhysicalRegister(RHS.reg)) {
1413         return SimpleJoin(LHS, RHS);
1414       } else {
1415         RHSValNoInfo = RHSValNoInfo0;
1416       }
1417     } else {
1418       // It was defined as a copy from the LHS, find out what value # it is.
1419       RHSValNoInfo = LHS.getLiveRangeContaining(RHSValNoInfo0->def-1)->valno;
1420       RHSValID = RHSValNoInfo->id;
1421       RHSVal0DefinedFromLHS = RHSValID;
1422     }
1423     
1424     LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
1425     RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
1426     NewVNInfo.resize(LHS.getNumValNums(), NULL);
1427     
1428     // Okay, *all* of the values in LHS that are defined as a copy from RHS
1429     // should now get updated.
1430     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
1431          i != e; ++i) {
1432       VNInfo *VNI = *i;
1433       unsigned VN = VNI->id;
1434       if (unsigned LHSSrcReg = li_->getVNInfoSourceReg(VNI)) {
1435         if (LHSSrcReg != RHS.reg) {
1436           // If this is not a copy from the RHS, its value number will be
1437           // unmodified by the coalescing.
1438           NewVNInfo[VN] = VNI;
1439           LHSValNoAssignments[VN] = VN;
1440         } else if (RHSValID == -1) {
1441           // Otherwise, it is a copy from the RHS, and we don't already have a
1442           // value# for it.  Keep the current value number, but remember it.
1443           LHSValNoAssignments[VN] = RHSValID = VN;
1444           NewVNInfo[VN] = RHSValNoInfo;
1445           LHSValsDefinedFromRHS[VNI] = RHSValNoInfo0;
1446         } else {
1447           // Otherwise, use the specified value #.
1448           LHSValNoAssignments[VN] = RHSValID;
1449           if (VN == (unsigned)RHSValID) {  // Else this val# is dead.
1450             NewVNInfo[VN] = RHSValNoInfo;
1451             LHSValsDefinedFromRHS[VNI] = RHSValNoInfo0;
1452           }
1453         }
1454       } else {
1455         NewVNInfo[VN] = VNI;
1456         LHSValNoAssignments[VN] = VN;
1457       }
1458     }
1459     
1460     assert(RHSValID != -1 && "Didn't find value #?");
1461     RHSValNoAssignments[0] = RHSValID;
1462     if (RHSVal0DefinedFromLHS != -1) {
1463       // This path doesn't go through ComputeUltimateVN so just set
1464       // it to anything.
1465       RHSValsDefinedFromLHS[RHSValNoInfo0] = (VNInfo*)1;
1466     }
1467   } else {
1468     // Loop over the value numbers of the LHS, seeing if any are defined from
1469     // the RHS.
1470     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
1471          i != e; ++i) {
1472       VNInfo *VNI = *i;
1473       if (VNI->def == ~1U || VNI->copy == 0)  // Src not defined by a copy?
1474         continue;
1475       
1476       // DstReg is known to be a register in the LHS interval.  If the src is
1477       // from the RHS interval, we can use its value #.
1478       if (li_->getVNInfoSourceReg(VNI) != RHS.reg)
1479         continue;
1480       
1481       // Figure out the value # from the RHS.
1482       LHSValsDefinedFromRHS[VNI]=RHS.getLiveRangeContaining(VNI->def-1)->valno;
1483     }
1484     
1485     // Loop over the value numbers of the RHS, seeing if any are defined from
1486     // the LHS.
1487     for (LiveInterval::vni_iterator i = RHS.vni_begin(), e = RHS.vni_end();
1488          i != e; ++i) {
1489       VNInfo *VNI = *i;
1490       if (VNI->def == ~1U || VNI->copy == 0)  // Src not defined by a copy?
1491         continue;
1492       
1493       // DstReg is known to be a register in the RHS interval.  If the src is
1494       // from the LHS interval, we can use its value #.
1495       if (li_->getVNInfoSourceReg(VNI) != LHS.reg)
1496         continue;
1497       
1498       // Figure out the value # from the LHS.
1499       RHSValsDefinedFromLHS[VNI]=LHS.getLiveRangeContaining(VNI->def-1)->valno;
1500     }
1501     
1502     LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
1503     RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
1504     NewVNInfo.reserve(LHS.getNumValNums() + RHS.getNumValNums());
1505     
1506     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
1507          i != e; ++i) {
1508       VNInfo *VNI = *i;
1509       unsigned VN = VNI->id;
1510       if (LHSValNoAssignments[VN] >= 0 || VNI->def == ~1U) 
1511         continue;
1512       ComputeUltimateVN(VNI, NewVNInfo,
1513                         LHSValsDefinedFromRHS, RHSValsDefinedFromLHS,
1514                         LHSValNoAssignments, RHSValNoAssignments);
1515     }
1516     for (LiveInterval::vni_iterator i = RHS.vni_begin(), e = RHS.vni_end();
1517          i != e; ++i) {
1518       VNInfo *VNI = *i;
1519       unsigned VN = VNI->id;
1520       if (RHSValNoAssignments[VN] >= 0 || VNI->def == ~1U)
1521         continue;
1522       // If this value number isn't a copy from the LHS, it's a new number.
1523       if (RHSValsDefinedFromLHS.find(VNI) == RHSValsDefinedFromLHS.end()) {
1524         NewVNInfo.push_back(VNI);
1525         RHSValNoAssignments[VN] = NewVNInfo.size()-1;
1526         continue;
1527       }
1528       
1529       ComputeUltimateVN(VNI, NewVNInfo,
1530                         RHSValsDefinedFromLHS, LHSValsDefinedFromRHS,
1531                         RHSValNoAssignments, LHSValNoAssignments);
1532     }
1533   }
1534   
1535   // Armed with the mappings of LHS/RHS values to ultimate values, walk the
1536   // interval lists to see if these intervals are coalescable.
1537   LiveInterval::const_iterator I = LHS.begin();
1538   LiveInterval::const_iterator IE = LHS.end();
1539   LiveInterval::const_iterator J = RHS.begin();
1540   LiveInterval::const_iterator JE = RHS.end();
1541   
1542   // Skip ahead until the first place of potential sharing.
1543   if (I->start < J->start) {
1544     I = std::upper_bound(I, IE, J->start);
1545     if (I != LHS.begin()) --I;
1546   } else if (J->start < I->start) {
1547     J = std::upper_bound(J, JE, I->start);
1548     if (J != RHS.begin()) --J;
1549   }
1550   
1551   while (1) {
1552     // Determine if these two live ranges overlap.
1553     bool Overlaps;
1554     if (I->start < J->start) {
1555       Overlaps = I->end > J->start;
1556     } else {
1557       Overlaps = J->end > I->start;
1558     }
1559
1560     // If so, check value # info to determine if they are really different.
1561     if (Overlaps) {
1562       // If the live range overlap will map to the same value number in the
1563       // result liverange, we can still coalesce them.  If not, we can't.
1564       if (LHSValNoAssignments[I->valno->id] !=
1565           RHSValNoAssignments[J->valno->id])
1566         return false;
1567     }
1568     
1569     if (I->end < J->end) {
1570       ++I;
1571       if (I == IE) break;
1572     } else {
1573       ++J;
1574       if (J == JE) break;
1575     }
1576   }
1577
1578   // Update kill info. Some live ranges are extended due to copy coalescing.
1579   for (DenseMap<VNInfo*, VNInfo*>::iterator I = LHSValsDefinedFromRHS.begin(),
1580          E = LHSValsDefinedFromRHS.end(); I != E; ++I) {
1581     VNInfo *VNI = I->first;
1582     unsigned LHSValID = LHSValNoAssignments[VNI->id];
1583     LiveInterval::removeKill(NewVNInfo[LHSValID], VNI->def);
1584     NewVNInfo[LHSValID]->hasPHIKill |= VNI->hasPHIKill;
1585     RHS.addKills(NewVNInfo[LHSValID], VNI->kills);
1586   }
1587
1588   // Update kill info. Some live ranges are extended due to copy coalescing.
1589   for (DenseMap<VNInfo*, VNInfo*>::iterator I = RHSValsDefinedFromLHS.begin(),
1590          E = RHSValsDefinedFromLHS.end(); I != E; ++I) {
1591     VNInfo *VNI = I->first;
1592     unsigned RHSValID = RHSValNoAssignments[VNI->id];
1593     LiveInterval::removeKill(NewVNInfo[RHSValID], VNI->def);
1594     NewVNInfo[RHSValID]->hasPHIKill |= VNI->hasPHIKill;
1595     LHS.addKills(NewVNInfo[RHSValID], VNI->kills);
1596   }
1597
1598   // If we get here, we know that we can coalesce the live ranges.  Ask the
1599   // intervals to coalesce themselves now.
1600   if ((RHS.ranges.size() > LHS.ranges.size() &&
1601       TargetRegisterInfo::isVirtualRegister(LHS.reg)) ||
1602       TargetRegisterInfo::isPhysicalRegister(RHS.reg)) {
1603     RHS.join(LHS, &RHSValNoAssignments[0], &LHSValNoAssignments[0], NewVNInfo);
1604     Swapped = true;
1605   } else {
1606     LHS.join(RHS, &LHSValNoAssignments[0], &RHSValNoAssignments[0], NewVNInfo);
1607     Swapped = false;
1608   }
1609   return true;
1610 }
1611
1612 namespace {
1613   // DepthMBBCompare - Comparison predicate that sort first based on the loop
1614   // depth of the basic block (the unsigned), and then on the MBB number.
1615   struct DepthMBBCompare {
1616     typedef std::pair<unsigned, MachineBasicBlock*> DepthMBBPair;
1617     bool operator()(const DepthMBBPair &LHS, const DepthMBBPair &RHS) const {
1618       if (LHS.first > RHS.first) return true;   // Deeper loops first
1619       return LHS.first == RHS.first &&
1620         LHS.second->getNumber() < RHS.second->getNumber();
1621     }
1622   };
1623 }
1624
1625 /// getRepIntervalSize - Returns the size of the interval that represents the
1626 /// specified register.
1627 template<class SF>
1628 unsigned JoinPriorityQueue<SF>::getRepIntervalSize(unsigned Reg) {
1629   return Rc->getRepIntervalSize(Reg);
1630 }
1631
1632 /// CopyRecSort::operator - Join priority queue sorting function.
1633 ///
1634 bool CopyRecSort::operator()(CopyRec left, CopyRec right) const {
1635   // Inner loops first.
1636   if (left.LoopDepth > right.LoopDepth)
1637     return false;
1638   else if (left.LoopDepth == right.LoopDepth)
1639     if (left.isBackEdge && !right.isBackEdge)
1640       return false;
1641   return true;
1642 }
1643
1644 void SimpleRegisterCoalescing::CopyCoalesceInMBB(MachineBasicBlock *MBB,
1645                                                std::vector<CopyRec> &TryAgain) {
1646   DOUT << ((Value*)MBB->getBasicBlock())->getName() << ":\n";
1647
1648   std::vector<CopyRec> VirtCopies;
1649   std::vector<CopyRec> PhysCopies;
1650   std::vector<CopyRec> ImpDefCopies;
1651   unsigned LoopDepth = loopInfo->getLoopDepth(MBB);
1652   for (MachineBasicBlock::iterator MII = MBB->begin(), E = MBB->end();
1653        MII != E;) {
1654     MachineInstr *Inst = MII++;
1655     
1656     // If this isn't a copy nor a extract_subreg, we can't join intervals.
1657     unsigned SrcReg, DstReg;
1658     if (Inst->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG) {
1659       DstReg = Inst->getOperand(0).getReg();
1660       SrcReg = Inst->getOperand(1).getReg();
1661     } else if (Inst->getOpcode() == TargetInstrInfo::INSERT_SUBREG) {
1662       DstReg = Inst->getOperand(0).getReg();
1663       SrcReg = Inst->getOperand(2).getReg();
1664     } else if (!tii_->isMoveInstr(*Inst, SrcReg, DstReg))
1665       continue;
1666
1667     bool SrcIsPhys = TargetRegisterInfo::isPhysicalRegister(SrcReg);
1668     bool DstIsPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
1669     if (NewHeuristic) {
1670       JoinQueue->push(CopyRec(Inst, LoopDepth, isBackEdgeCopy(Inst, DstReg)));
1671     } else {
1672       if (li_->hasInterval(SrcReg) && li_->getInterval(SrcReg).empty())
1673         ImpDefCopies.push_back(CopyRec(Inst, 0, false));
1674       else if (SrcIsPhys || DstIsPhys)
1675         PhysCopies.push_back(CopyRec(Inst, 0, false));
1676       else
1677         VirtCopies.push_back(CopyRec(Inst, 0, false));
1678     }
1679   }
1680
1681   if (NewHeuristic)
1682     return;
1683
1684   // Try coalescing implicit copies first, followed by copies to / from
1685   // physical registers, then finally copies from virtual registers to
1686   // virtual registers.
1687   for (unsigned i = 0, e = ImpDefCopies.size(); i != e; ++i) {
1688     CopyRec &TheCopy = ImpDefCopies[i];
1689     bool Again = false;
1690     if (!JoinCopy(TheCopy, Again))
1691       if (Again)
1692         TryAgain.push_back(TheCopy);
1693   }
1694   for (unsigned i = 0, e = PhysCopies.size(); i != e; ++i) {
1695     CopyRec &TheCopy = PhysCopies[i];
1696     bool Again = false;
1697     if (!JoinCopy(TheCopy, Again))
1698       if (Again)
1699         TryAgain.push_back(TheCopy);
1700   }
1701   for (unsigned i = 0, e = VirtCopies.size(); i != e; ++i) {
1702     CopyRec &TheCopy = VirtCopies[i];
1703     bool Again = false;
1704     if (!JoinCopy(TheCopy, Again))
1705       if (Again)
1706         TryAgain.push_back(TheCopy);
1707   }
1708 }
1709
1710 void SimpleRegisterCoalescing::joinIntervals() {
1711   DOUT << "********** JOINING INTERVALS ***********\n";
1712
1713   if (NewHeuristic)
1714     JoinQueue = new JoinPriorityQueue<CopyRecSort>(this);
1715
1716   std::vector<CopyRec> TryAgainList;
1717   if (loopInfo->begin() == loopInfo->end()) {
1718     // If there are no loops in the function, join intervals in function order.
1719     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();
1720          I != E; ++I)
1721       CopyCoalesceInMBB(I, TryAgainList);
1722   } else {
1723     // Otherwise, join intervals in inner loops before other intervals.
1724     // Unfortunately we can't just iterate over loop hierarchy here because
1725     // there may be more MBB's than BB's.  Collect MBB's for sorting.
1726
1727     // Join intervals in the function prolog first. We want to join physical
1728     // registers with virtual registers before the intervals got too long.
1729     std::vector<std::pair<unsigned, MachineBasicBlock*> > MBBs;
1730     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();I != E;++I){
1731       MachineBasicBlock *MBB = I;
1732       MBBs.push_back(std::make_pair(loopInfo->getLoopDepth(MBB), I));
1733     }
1734
1735     // Sort by loop depth.
1736     std::sort(MBBs.begin(), MBBs.end(), DepthMBBCompare());
1737
1738     // Finally, join intervals in loop nest order.
1739     for (unsigned i = 0, e = MBBs.size(); i != e; ++i)
1740       CopyCoalesceInMBB(MBBs[i].second, TryAgainList);
1741   }
1742   
1743   // Joining intervals can allow other intervals to be joined.  Iteratively join
1744   // until we make no progress.
1745   if (NewHeuristic) {
1746     SmallVector<CopyRec, 16> TryAgain;
1747     bool ProgressMade = true;
1748     while (ProgressMade) {
1749       ProgressMade = false;
1750       while (!JoinQueue->empty()) {
1751         CopyRec R = JoinQueue->pop();
1752         bool Again = false;
1753         bool Success = JoinCopy(R, Again);
1754         if (Success)
1755           ProgressMade = true;
1756         else if (Again)
1757           TryAgain.push_back(R);
1758       }
1759
1760       if (ProgressMade) {
1761         while (!TryAgain.empty()) {
1762           JoinQueue->push(TryAgain.back());
1763           TryAgain.pop_back();
1764         }
1765       }
1766     }
1767   } else {
1768     bool ProgressMade = true;
1769     while (ProgressMade) {
1770       ProgressMade = false;
1771
1772       for (unsigned i = 0, e = TryAgainList.size(); i != e; ++i) {
1773         CopyRec &TheCopy = TryAgainList[i];
1774         if (TheCopy.MI) {
1775           bool Again = false;
1776           bool Success = JoinCopy(TheCopy, Again);
1777           if (Success || !Again) {
1778             TheCopy.MI = 0;   // Mark this one as done.
1779             ProgressMade = true;
1780           }
1781         }
1782       }
1783     }
1784   }
1785
1786   if (NewHeuristic)
1787     delete JoinQueue;  
1788 }
1789
1790 /// Return true if the two specified registers belong to different register
1791 /// classes.  The registers may be either phys or virt regs.
1792 bool SimpleRegisterCoalescing::differingRegisterClasses(unsigned RegA,
1793                                                         unsigned RegB) const {
1794
1795   // Get the register classes for the first reg.
1796   if (TargetRegisterInfo::isPhysicalRegister(RegA)) {
1797     assert(TargetRegisterInfo::isVirtualRegister(RegB) &&
1798            "Shouldn't consider two physregs!");
1799     return !mri_->getRegClass(RegB)->contains(RegA);
1800   }
1801
1802   // Compare against the regclass for the second reg.
1803   const TargetRegisterClass *RegClass = mri_->getRegClass(RegA);
1804   if (TargetRegisterInfo::isVirtualRegister(RegB))
1805     return RegClass != mri_->getRegClass(RegB);
1806   else
1807     return !RegClass->contains(RegB);
1808 }
1809
1810 /// lastRegisterUse - Returns the last use of the specific register between
1811 /// cycles Start and End or NULL if there are no uses.
1812 MachineOperand *
1813 SimpleRegisterCoalescing::lastRegisterUse(unsigned Start, unsigned End,
1814                                           unsigned Reg, unsigned &UseIdx) const{
1815   UseIdx = 0;
1816   if (TargetRegisterInfo::isVirtualRegister(Reg)) {
1817     MachineOperand *LastUse = NULL;
1818     for (MachineRegisterInfo::use_iterator I = mri_->use_begin(Reg),
1819            E = mri_->use_end(); I != E; ++I) {
1820       MachineOperand &Use = I.getOperand();
1821       MachineInstr *UseMI = Use.getParent();
1822       unsigned SrcReg, DstReg;
1823       if (tii_->isMoveInstr(*UseMI, SrcReg, DstReg) && SrcReg == DstReg)
1824         // Ignore identity copies.
1825         continue;
1826       unsigned Idx = li_->getInstructionIndex(UseMI);
1827       if (Idx >= Start && Idx < End && Idx >= UseIdx) {
1828         LastUse = &Use;
1829         UseIdx = Idx;
1830       }
1831     }
1832     return LastUse;
1833   }
1834
1835   int e = (End-1) / InstrSlots::NUM * InstrSlots::NUM;
1836   int s = Start;
1837   while (e >= s) {
1838     // Skip deleted instructions
1839     MachineInstr *MI = li_->getInstructionFromIndex(e);
1840     while ((e - InstrSlots::NUM) >= s && !MI) {
1841       e -= InstrSlots::NUM;
1842       MI = li_->getInstructionFromIndex(e);
1843     }
1844     if (e < s || MI == NULL)
1845       return NULL;
1846
1847     // Ignore identity copies.
1848     unsigned SrcReg, DstReg;
1849     if (!(tii_->isMoveInstr(*MI, SrcReg, DstReg) && SrcReg == DstReg))
1850       for (unsigned i = 0, NumOps = MI->getNumOperands(); i != NumOps; ++i) {
1851         MachineOperand &Use = MI->getOperand(i);
1852         if (Use.isRegister() && Use.isUse() && Use.getReg() &&
1853             tri_->regsOverlap(Use.getReg(), Reg)) {
1854           UseIdx = e;
1855           return &Use;
1856         }
1857       }
1858
1859     e -= InstrSlots::NUM;
1860   }
1861
1862   return NULL;
1863 }
1864
1865
1866 void SimpleRegisterCoalescing::printRegName(unsigned reg) const {
1867   if (TargetRegisterInfo::isPhysicalRegister(reg))
1868     cerr << tri_->getName(reg);
1869   else
1870     cerr << "%reg" << reg;
1871 }
1872
1873 void SimpleRegisterCoalescing::releaseMemory() {
1874   JoinedCopies.clear();
1875 }
1876
1877 static bool isZeroLengthInterval(LiveInterval *li) {
1878   for (LiveInterval::Ranges::const_iterator
1879          i = li->ranges.begin(), e = li->ranges.end(); i != e; ++i)
1880     if (i->end - i->start > LiveIntervals::InstrSlots::NUM)
1881       return false;
1882   return true;
1883 }
1884
1885 /// TurnCopyIntoImpDef - If source of the specified copy is an implicit def,
1886 /// turn the copy into an implicit def.
1887 bool
1888 SimpleRegisterCoalescing::TurnCopyIntoImpDef(MachineBasicBlock::iterator &I,
1889                                              MachineBasicBlock *MBB,
1890                                              unsigned DstReg, unsigned SrcReg) {
1891   MachineInstr *CopyMI = &*I;
1892   unsigned CopyIdx = li_->getDefIndex(li_->getInstructionIndex(CopyMI));
1893   if (!li_->hasInterval(SrcReg))
1894     return false;
1895   LiveInterval &SrcInt = li_->getInterval(SrcReg);
1896   if (!SrcInt.empty())
1897     return false;
1898   if (!li_->hasInterval(DstReg))
1899     return false;
1900   LiveInterval &DstInt = li_->getInterval(DstReg);
1901   const LiveRange *DstLR = DstInt.getLiveRangeContaining(CopyIdx);
1902   DstInt.removeValNo(DstLR->valno);
1903   CopyMI->setDesc(tii_->get(TargetInstrInfo::IMPLICIT_DEF));
1904   for (int i = CopyMI->getNumOperands() - 1, e = 0; i > e; --i)
1905     CopyMI->RemoveOperand(i);
1906   bool NoUse = mri_->use_begin(SrcReg) == mri_->use_end();
1907   if (NoUse) {
1908     for (MachineRegisterInfo::reg_iterator I = mri_->reg_begin(SrcReg),
1909            E = mri_->reg_end(); I != E; ) {
1910       assert(I.getOperand().isDef());
1911       MachineInstr *DefMI = &*I;
1912       ++I;
1913       // The implicit_def source has no other uses, delete it.
1914       assert(DefMI->getOpcode() == TargetInstrInfo::IMPLICIT_DEF);
1915       li_->RemoveMachineInstrFromMaps(DefMI);
1916       DefMI->eraseFromParent();
1917     }
1918   }
1919   ++I;
1920   return true;
1921 }
1922
1923
1924 bool SimpleRegisterCoalescing::runOnMachineFunction(MachineFunction &fn) {
1925   mf_ = &fn;
1926   mri_ = &fn.getRegInfo();
1927   tm_ = &fn.getTarget();
1928   tri_ = tm_->getRegisterInfo();
1929   tii_ = tm_->getInstrInfo();
1930   li_ = &getAnalysis<LiveIntervals>();
1931   lv_ = &getAnalysis<LiveVariables>();
1932   loopInfo = &getAnalysis<MachineLoopInfo>();
1933
1934   DOUT << "********** SIMPLE REGISTER COALESCING **********\n"
1935        << "********** Function: "
1936        << ((Value*)mf_->getFunction())->getName() << '\n';
1937
1938   allocatableRegs_ = tri_->getAllocatableSet(fn);
1939   for (TargetRegisterInfo::regclass_iterator I = tri_->regclass_begin(),
1940          E = tri_->regclass_end(); I != E; ++I)
1941     allocatableRCRegs_.insert(std::make_pair(*I,
1942                                              tri_->getAllocatableSet(fn, *I)));
1943
1944   // Join (coalesce) intervals if requested.
1945   if (EnableJoining) {
1946     joinIntervals();
1947     DOUT << "********** INTERVALS POST JOINING **********\n";
1948     for (LiveIntervals::iterator I = li_->begin(), E = li_->end(); I != E; ++I){
1949       I->second.print(DOUT, tri_);
1950       DOUT << "\n";
1951     }
1952
1953     // Delete all coalesced copies.
1954     for (SmallPtrSet<MachineInstr*,32>::iterator I = JoinedCopies.begin(),
1955            E = JoinedCopies.end(); I != E; ++I) {
1956       MachineInstr *CopyMI = *I;
1957       unsigned SrcReg, DstReg;
1958       if (!tii_->isMoveInstr(*CopyMI, SrcReg, DstReg)) {
1959         assert((CopyMI->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG ||
1960                 CopyMI->getOpcode() == TargetInstrInfo::INSERT_SUBREG) &&
1961                "Unrecognized copy instruction");
1962         DstReg = CopyMI->getOperand(0).getReg();
1963       }
1964       if (CopyMI->registerDefIsDead(DstReg)) {
1965         LiveInterval &li = li_->getInterval(DstReg);
1966         if (!ShortenDeadCopySrcLiveRange(li, CopyMI))
1967           ShortenDeadCopyLiveRange(li, CopyMI);
1968       }
1969       li_->RemoveMachineInstrFromMaps(*I);
1970       (*I)->eraseFromParent();
1971       ++numPeep;
1972     }
1973   }
1974
1975   // Perform a final pass over the instructions and compute spill weights
1976   // and remove identity moves.
1977   for (MachineFunction::iterator mbbi = mf_->begin(), mbbe = mf_->end();
1978        mbbi != mbbe; ++mbbi) {
1979     MachineBasicBlock* mbb = mbbi;
1980     unsigned loopDepth = loopInfo->getLoopDepth(mbb);
1981
1982     for (MachineBasicBlock::iterator mii = mbb->begin(), mie = mbb->end();
1983          mii != mie; ) {
1984       // if the move will be an identity move delete it
1985       unsigned srcReg, dstReg;
1986       bool isMove = tii_->isMoveInstr(*mii, srcReg, dstReg);
1987       if (isMove && srcReg == dstReg) {
1988         if (li_->hasInterval(srcReg)) {
1989           LiveInterval &RegInt = li_->getInterval(srcReg);
1990           // If def of this move instruction is dead, remove its live range
1991           // from the dstination register's live interval.
1992           if (mii->registerDefIsDead(dstReg)) {
1993             if (!ShortenDeadCopySrcLiveRange(RegInt, mii))
1994               ShortenDeadCopyLiveRange(RegInt, mii);
1995           }
1996         }
1997         li_->RemoveMachineInstrFromMaps(mii);
1998         mii = mbbi->erase(mii);
1999         ++numPeep;
2000       } else if (!isMove || !TurnCopyIntoImpDef(mii, mbb, dstReg, srcReg)) {
2001         SmallSet<unsigned, 4> UniqueUses;
2002         for (unsigned i = 0, e = mii->getNumOperands(); i != e; ++i) {
2003           const MachineOperand &mop = mii->getOperand(i);
2004           if (mop.isRegister() && mop.getReg() &&
2005               TargetRegisterInfo::isVirtualRegister(mop.getReg())) {
2006             unsigned reg = mop.getReg();
2007             // Multiple uses of reg by the same instruction. It should not
2008             // contribute to spill weight again.
2009             if (UniqueUses.count(reg) != 0)
2010               continue;
2011             LiveInterval &RegInt = li_->getInterval(reg);
2012             RegInt.weight +=
2013               li_->getSpillWeight(mop.isDef(), mop.isUse(), loopDepth);
2014             UniqueUses.insert(reg);
2015           }
2016         }
2017         ++mii;
2018       }
2019     }
2020   }
2021
2022   for (LiveIntervals::iterator I = li_->begin(), E = li_->end(); I != E; ++I) {
2023     LiveInterval &LI = I->second;
2024     if (TargetRegisterInfo::isVirtualRegister(LI.reg)) {
2025       // If the live interval length is essentially zero, i.e. in every live
2026       // range the use follows def immediately, it doesn't make sense to spill
2027       // it and hope it will be easier to allocate for this li.
2028       if (isZeroLengthInterval(&LI))
2029         LI.weight = HUGE_VALF;
2030       else {
2031         bool isLoad = false;
2032         if (li_->isReMaterializable(LI, isLoad)) {
2033           // If all of the definitions of the interval are re-materializable,
2034           // it is a preferred candidate for spilling. If non of the defs are
2035           // loads, then it's potentially very cheap to re-materialize.
2036           // FIXME: this gets much more complicated once we support non-trivial
2037           // re-materialization.
2038           if (isLoad)
2039             LI.weight *= 0.9F;
2040           else
2041             LI.weight *= 0.5F;
2042         }
2043       }
2044
2045       // Slightly prefer live interval that has been assigned a preferred reg.
2046       if (LI.preference)
2047         LI.weight *= 1.01F;
2048
2049       // Divide the weight of the interval by its size.  This encourages 
2050       // spilling of intervals that are large and have few uses, and
2051       // discourages spilling of small intervals with many uses.
2052       LI.weight /= LI.getSize();
2053     }
2054   }
2055
2056   DEBUG(dump());
2057   return true;
2058 }
2059
2060 /// print - Implement the dump method.
2061 void SimpleRegisterCoalescing::print(std::ostream &O, const Module* m) const {
2062    li_->print(O, m);
2063 }
2064
2065 RegisterCoalescer* llvm::createSimpleRegisterCoalescer() {
2066   return new SimpleRegisterCoalescing();
2067 }
2068
2069 // Make sure that anything that uses RegisterCoalescer pulls in this file...
2070 DEFINING_FILE_FOR(SimpleRegisterCoalescing)