Make some changes suggested by Bill and Evan.
[oota-llvm.git] / lib / CodeGen / LiveInterval.cpp
1 //===-- LiveInterval.cpp - Live Interval Representation -------------------===//
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 the LiveRange and LiveInterval classes.  Given some
11 // numbering of each the machine instructions an interval [i, j) is said to be a
12 // live interval for register v if there is no instruction with number j' > j
13 // such that v is live at j' abd there is no instruction with number i' < i such
14 // that v is live at i'. In this implementation intervals can have holes,
15 // i.e. an interval might look like [1,20), [50,65), [1000,1001).  Each
16 // individual range is represented as an instance of LiveRange, and the whole
17 // interval is represented as an instance of LiveInterval.
18 //
19 //===----------------------------------------------------------------------===//
20
21 #include "llvm/CodeGen/LiveInterval.h"
22 #include "llvm/CodeGen/MachineRegisterInfo.h"
23 #include "llvm/ADT/DenseMap.h"
24 #include "llvm/ADT/SmallSet.h"
25 #include "llvm/ADT/STLExtras.h"
26 #include "llvm/Support/Streams.h"
27 #include "llvm/Target/TargetRegisterInfo.h"
28 #include <algorithm>
29 #include <ostream>
30 using namespace llvm;
31
32 // An example for liveAt():
33 //
34 // this = [1,4), liveAt(0) will return false. The instruction defining this
35 // spans slots [0,3]. The interval belongs to an spilled definition of the
36 // variable it represents. This is because slot 1 is used (def slot) and spans
37 // up to slot 3 (store slot).
38 //
39 bool LiveInterval::liveAt(unsigned I) const {
40   Ranges::const_iterator r = std::upper_bound(ranges.begin(), ranges.end(), I);
41
42   if (r == ranges.begin())
43     return false;
44
45   --r;
46   return r->contains(I);
47 }
48
49 // liveBeforeAndAt - Check if the interval is live at the index and the index
50 // just before it. If index is liveAt, check if it starts a new live range.
51 // If it does, then check if the previous live range ends at index-1.
52 bool LiveInterval::liveBeforeAndAt(unsigned I) const {
53   Ranges::const_iterator r = std::upper_bound(ranges.begin(), ranges.end(), I);
54
55   if (r == ranges.begin())
56     return false;
57
58   --r;
59   if (!r->contains(I))
60     return false;
61   if (I != r->start)
62     return true;
63   // I is the start of a live range. Check if the previous live range ends
64   // at I-1.
65   if (r == ranges.begin())
66     return false;
67   return r->end == I;
68 }
69
70 // overlaps - Return true if the intersection of the two live intervals is
71 // not empty.
72 //
73 // An example for overlaps():
74 //
75 // 0: A = ...
76 // 4: B = ...
77 // 8: C = A + B ;; last use of A
78 //
79 // The live intervals should look like:
80 //
81 // A = [3, 11)
82 // B = [7, x)
83 // C = [11, y)
84 //
85 // A->overlaps(C) should return false since we want to be able to join
86 // A and C.
87 //
88 bool LiveInterval::overlapsFrom(const LiveInterval& other,
89                                 const_iterator StartPos) const {
90   const_iterator i = begin();
91   const_iterator ie = end();
92   const_iterator j = StartPos;
93   const_iterator je = other.end();
94
95   assert((StartPos->start <= i->start || StartPos == other.begin()) &&
96          StartPos != other.end() && "Bogus start position hint!");
97
98   if (i->start < j->start) {
99     i = std::upper_bound(i, ie, j->start);
100     if (i != ranges.begin()) --i;
101   } else if (j->start < i->start) {
102     ++StartPos;
103     if (StartPos != other.end() && StartPos->start <= i->start) {
104       assert(StartPos < other.end() && i < end());
105       j = std::upper_bound(j, je, i->start);
106       if (j != other.ranges.begin()) --j;
107     }
108   } else {
109     return true;
110   }
111
112   if (j == je) return false;
113
114   while (i != ie) {
115     if (i->start > j->start) {
116       std::swap(i, j);
117       std::swap(ie, je);
118     }
119
120     if (i->end > j->start)
121       return true;
122     ++i;
123   }
124
125   return false;
126 }
127
128 /// overlaps - Return true if the live interval overlaps a range specified
129 /// by [Start, End).
130 bool LiveInterval::overlaps(unsigned Start, unsigned End) const {
131   assert(Start < End && "Invalid range");
132   const_iterator I  = begin();
133   const_iterator E  = end();
134   const_iterator si = std::upper_bound(I, E, Start);
135   const_iterator ei = std::upper_bound(I, E, End);
136   if (si != ei)
137     return true;
138   if (si == I)
139     return false;
140   --si;
141   return si->contains(Start);
142 }
143
144 /// extendIntervalEndTo - This method is used when we want to extend the range
145 /// specified by I to end at the specified endpoint.  To do this, we should
146 /// merge and eliminate all ranges that this will overlap with.  The iterator is
147 /// not invalidated.
148 void LiveInterval::extendIntervalEndTo(Ranges::iterator I, unsigned NewEnd) {
149   assert(I != ranges.end() && "Not a valid interval!");
150   VNInfo *ValNo = I->valno;
151   unsigned OldEnd = I->end;
152
153   // Search for the first interval that we can't merge with.
154   Ranges::iterator MergeTo = next(I);
155   for (; MergeTo != ranges.end() && NewEnd >= MergeTo->end; ++MergeTo) {
156     assert(MergeTo->valno == ValNo && "Cannot merge with differing values!");
157   }
158
159   // If NewEnd was in the middle of an interval, make sure to get its endpoint.
160   I->end = std::max(NewEnd, prior(MergeTo)->end);
161
162   // Erase any dead ranges.
163   ranges.erase(next(I), MergeTo);
164
165   // Update kill info.
166   removeKills(ValNo, OldEnd, I->end-1);
167
168   // If the newly formed range now touches the range after it and if they have
169   // the same value number, merge the two ranges into one range.
170   Ranges::iterator Next = next(I);
171   if (Next != ranges.end() && Next->start <= I->end && Next->valno == ValNo) {
172     I->end = Next->end;
173     ranges.erase(Next);
174   }
175 }
176
177
178 /// extendIntervalStartTo - This method is used when we want to extend the range
179 /// specified by I to start at the specified endpoint.  To do this, we should
180 /// merge and eliminate all ranges that this will overlap with.
181 LiveInterval::Ranges::iterator
182 LiveInterval::extendIntervalStartTo(Ranges::iterator I, unsigned NewStart) {
183   assert(I != ranges.end() && "Not a valid interval!");
184   VNInfo *ValNo = I->valno;
185
186   // Search for the first interval that we can't merge with.
187   Ranges::iterator MergeTo = I;
188   do {
189     if (MergeTo == ranges.begin()) {
190       I->start = NewStart;
191       ranges.erase(MergeTo, I);
192       return I;
193     }
194     assert(MergeTo->valno == ValNo && "Cannot merge with differing values!");
195     --MergeTo;
196   } while (NewStart <= MergeTo->start);
197
198   // If we start in the middle of another interval, just delete a range and
199   // extend that interval.
200   if (MergeTo->end >= NewStart && MergeTo->valno == ValNo) {
201     MergeTo->end = I->end;
202   } else {
203     // Otherwise, extend the interval right after.
204     ++MergeTo;
205     MergeTo->start = NewStart;
206     MergeTo->end = I->end;
207   }
208
209   ranges.erase(next(MergeTo), next(I));
210   return MergeTo;
211 }
212
213 LiveInterval::iterator
214 LiveInterval::addRangeFrom(LiveRange LR, iterator From) {
215   unsigned Start = LR.start, End = LR.end;
216   iterator it = std::upper_bound(From, ranges.end(), Start);
217
218   // If the inserted interval starts in the middle or right at the end of
219   // another interval, just extend that interval to contain the range of LR.
220   if (it != ranges.begin()) {
221     iterator B = prior(it);
222     if (LR.valno == B->valno) {
223       if (B->start <= Start && B->end >= Start) {
224         extendIntervalEndTo(B, End);
225         return B;
226       }
227     } else {
228       // Check to make sure that we are not overlapping two live ranges with
229       // different valno's.
230       assert(B->end <= Start &&
231              "Cannot overlap two LiveRanges with differing ValID's"
232              " (did you def the same reg twice in a MachineInstr?)");
233     }
234   }
235
236   // Otherwise, if this range ends in the middle of, or right next to, another
237   // interval, merge it into that interval.
238   if (it != ranges.end()) {
239     if (LR.valno == it->valno) {
240       if (it->start <= End) {
241         it = extendIntervalStartTo(it, Start);
242
243         // If LR is a complete superset of an interval, we may need to grow its
244         // endpoint as well.
245         if (End > it->end)
246           extendIntervalEndTo(it, End);
247         else if (End < it->end)
248           // Overlapping intervals, there might have been a kill here.
249           removeKill(it->valno, End);
250         return it;
251       }
252     } else {
253       // Check to make sure that we are not overlapping two live ranges with
254       // different valno's.
255       assert(it->start >= End &&
256              "Cannot overlap two LiveRanges with differing ValID's");
257     }
258   }
259
260   // Otherwise, this is just a new range that doesn't interact with anything.
261   // Insert it.
262   return ranges.insert(it, LR);
263 }
264
265 /// isInOneLiveRange - Return true if the range specified is entirely in the
266 /// a single LiveRange of the live interval.
267 bool LiveInterval::isInOneLiveRange(unsigned Start, unsigned End) {
268   Ranges::iterator I = std::upper_bound(ranges.begin(), ranges.end(), Start);
269   if (I == ranges.begin())
270     return false;
271   --I;
272   return I->contains(Start) && I->contains(End-1);
273 }
274
275
276 /// removeRange - Remove the specified range from this interval.  Note that
277 /// the range must be in a single LiveRange in its entirety.
278 void LiveInterval::removeRange(unsigned Start, unsigned End,
279                                bool RemoveDeadValNo) {
280   // Find the LiveRange containing this span.
281   Ranges::iterator I = std::upper_bound(ranges.begin(), ranges.end(), Start);
282   assert(I != ranges.begin() && "Range is not in interval!");
283   --I;
284   assert(I->contains(Start) && I->contains(End-1) &&
285          "Range is not entirely in interval!");
286
287   // If the span we are removing is at the start of the LiveRange, adjust it.
288   VNInfo *ValNo = I->valno;
289   if (I->start == Start) {
290     if (I->end == End) {
291       removeKills(I->valno, Start, End);
292       if (RemoveDeadValNo) {
293         // Check if val# is dead.
294         bool isDead = true;
295         for (const_iterator II = begin(), EE = end(); II != EE; ++II)
296           if (II != I && II->valno == ValNo) {
297             isDead = false;
298             break;
299           }          
300         if (isDead) {
301           // Now that ValNo is dead, remove it.  If it is the largest value
302           // number, just nuke it (and any other deleted values neighboring it),
303           // otherwise mark it as ~1U so it can be nuked later.
304           if (ValNo->id == getNumValNums()-1) {
305             do {
306               VNInfo *VNI = valnos.back();
307               valnos.pop_back();
308               VNI->~VNInfo();
309             } while (!valnos.empty() && valnos.back()->isUnused());
310           } else {
311             ValNo->setIsUnused(true);
312           }
313         }
314       }
315
316       ranges.erase(I);  // Removed the whole LiveRange.
317     } else
318       I->start = End;
319     return;
320   }
321
322   // Otherwise if the span we are removing is at the end of the LiveRange,
323   // adjust the other way.
324   if (I->end == End) {
325     removeKills(ValNo, Start, End);
326     I->end = Start;
327     return;
328   }
329
330   // Otherwise, we are splitting the LiveRange into two pieces.
331   unsigned OldEnd = I->end;
332   I->end = Start;   // Trim the old interval.
333
334   // Insert the new one.
335   ranges.insert(next(I), LiveRange(End, OldEnd, ValNo));
336 }
337
338 /// removeValNo - Remove all the ranges defined by the specified value#.
339 /// Also remove the value# from value# list.
340 void LiveInterval::removeValNo(VNInfo *ValNo) {
341   if (empty()) return;
342   Ranges::iterator I = ranges.end();
343   Ranges::iterator E = ranges.begin();
344   do {
345     --I;
346     if (I->valno == ValNo)
347       ranges.erase(I);
348   } while (I != E);
349   // Now that ValNo is dead, remove it.  If it is the largest value
350   // number, just nuke it (and any other deleted values neighboring it),
351   // otherwise mark it as ~1U so it can be nuked later.
352   if (ValNo->id == getNumValNums()-1) {
353     do {
354       VNInfo *VNI = valnos.back();
355       valnos.pop_back();
356       VNI->~VNInfo();
357     } while (!valnos.empty() && valnos.back()->isUnused());
358   } else {
359     ValNo->setIsUnused(true);
360   }
361 }
362  
363 /// scaleNumbering - Renumber VNI and ranges to provide gaps for new
364 /// instructions.                                                   
365 void LiveInterval::scaleNumbering(unsigned factor) {
366   // Scale ranges.                                                            
367   for (iterator RI = begin(), RE = end(); RI != RE; ++RI) {
368     RI->start = InstrSlots::scale(RI->start, factor);
369     RI->end = InstrSlots::scale(RI->end, factor);
370   }
371
372   // Scale VNI info.                                                          
373   for (vni_iterator VNI = vni_begin(), VNIE = vni_end(); VNI != VNIE; ++VNI) {
374     VNInfo *vni = *VNI;
375
376     if (vni->isDefAccurate())
377       vni->def = InstrSlots::scale(vni->def, factor);
378
379     for (unsigned i = 0; i < vni->kills.size(); ++i) {
380       if (!vni->kills[i].isPHIKill)
381         vni->kills[i].killIdx =
382           InstrSlots::scale(vni->kills[i].killIdx, factor);
383     }
384   }
385 }
386
387 /// getLiveRangeContaining - Return the live range that contains the
388 /// specified index, or null if there is none.
389 LiveInterval::const_iterator 
390 LiveInterval::FindLiveRangeContaining(unsigned Idx) const {
391   const_iterator It = std::upper_bound(begin(), end(), Idx);
392   if (It != ranges.begin()) {
393     --It;
394     if (It->contains(Idx))
395       return It;
396   }
397
398   return end();
399 }
400
401 LiveInterval::iterator 
402 LiveInterval::FindLiveRangeContaining(unsigned Idx) {
403   iterator It = std::upper_bound(begin(), end(), Idx);
404   if (It != begin()) {
405     --It;
406     if (It->contains(Idx))
407       return It;
408   }
409   
410   return end();
411 }
412
413 /// findDefinedVNInfo - Find the VNInfo that's defined at the specified index
414 /// (register interval) or defined by the specified register (stack inteval).
415 VNInfo *LiveInterval::findDefinedVNInfo(unsigned DefIdxOrReg) const {
416   VNInfo *VNI = NULL;
417   for (LiveInterval::const_vni_iterator i = vni_begin(), e = vni_end();
418        i != e; ++i)
419     if ((*i)->def == DefIdxOrReg) {
420       VNI = *i;
421       break;
422     }
423   return VNI;
424 }
425
426 /// join - Join two live intervals (this, and other) together.  This applies
427 /// mappings to the value numbers in the LHS/RHS intervals as specified.  If
428 /// the intervals are not joinable, this aborts.
429 void LiveInterval::join(LiveInterval &Other, const int *LHSValNoAssignments,
430                         const int *RHSValNoAssignments, 
431                         SmallVector<VNInfo*, 16> &NewVNInfo,
432                         MachineRegisterInfo *MRI) {
433   // Determine if any of our live range values are mapped.  This is uncommon, so
434   // we want to avoid the interval scan if not. 
435   bool MustMapCurValNos = false;
436   unsigned NumVals = getNumValNums();
437   unsigned NumNewVals = NewVNInfo.size();
438   for (unsigned i = 0; i != NumVals; ++i) {
439     unsigned LHSValID = LHSValNoAssignments[i];
440     if (i != LHSValID ||
441         (NewVNInfo[LHSValID] && NewVNInfo[LHSValID] != getValNumInfo(i)))
442       MustMapCurValNos = true;
443   }
444
445   // If we have to apply a mapping to our base interval assignment, rewrite it
446   // now.
447   if (MustMapCurValNos) {
448     // Map the first live range.
449     iterator OutIt = begin();
450     OutIt->valno = NewVNInfo[LHSValNoAssignments[OutIt->valno->id]];
451     ++OutIt;
452     for (iterator I = OutIt, E = end(); I != E; ++I) {
453       OutIt->valno = NewVNInfo[LHSValNoAssignments[I->valno->id]];
454       
455       // If this live range has the same value # as its immediate predecessor,
456       // and if they are neighbors, remove one LiveRange.  This happens when we
457       // have [0,3:0)[4,7:1) and map 0/1 onto the same value #.
458       if (OutIt->valno == (OutIt-1)->valno && (OutIt-1)->end == OutIt->start) {
459         (OutIt-1)->end = OutIt->end;
460       } else {
461         if (I != OutIt) {
462           OutIt->start = I->start;
463           OutIt->end = I->end;
464         }
465         
466         // Didn't merge, on to the next one.
467         ++OutIt;
468       }
469     }
470     
471     // If we merge some live ranges, chop off the end.
472     ranges.erase(OutIt, end());
473   }
474
475   // Remember assignements because val# ids are changing.
476   SmallVector<unsigned, 16> OtherAssignments;
477   for (iterator I = Other.begin(), E = Other.end(); I != E; ++I)
478     OtherAssignments.push_back(RHSValNoAssignments[I->valno->id]);
479
480   // Update val# info. Renumber them and make sure they all belong to this
481   // LiveInterval now. Also remove dead val#'s.
482   unsigned NumValNos = 0;
483   for (unsigned i = 0; i < NumNewVals; ++i) {
484     VNInfo *VNI = NewVNInfo[i];
485     if (VNI) {
486       if (NumValNos >= NumVals)
487         valnos.push_back(VNI);
488       else 
489         valnos[NumValNos] = VNI;
490       VNI->id = NumValNos++;  // Renumber val#.
491     }
492   }
493   if (NumNewVals < NumVals)
494     valnos.resize(NumNewVals);  // shrinkify
495
496   // Okay, now insert the RHS live ranges into the LHS.
497   iterator InsertPos = begin();
498   unsigned RangeNo = 0;
499   for (iterator I = Other.begin(), E = Other.end(); I != E; ++I, ++RangeNo) {
500     // Map the valno in the other live range to the current live range.
501     I->valno = NewVNInfo[OtherAssignments[RangeNo]];
502     assert(I->valno && "Adding a dead range?");
503     InsertPos = addRangeFrom(*I, InsertPos);
504   }
505
506   ComputeJoinedWeight(Other);
507
508   // Update regalloc hint if currently there isn't one.
509   if (TargetRegisterInfo::isVirtualRegister(reg) &&
510       TargetRegisterInfo::isVirtualRegister(Other.reg)) {
511     std::pair<unsigned, unsigned> Hint = MRI->getRegAllocationHint(reg);
512     if (Hint.first == 0 && Hint.second == 0) {
513       std::pair<unsigned, unsigned> OtherHint =
514         MRI->getRegAllocationHint(Other.reg);
515       if (OtherHint.first || OtherHint.second)
516         MRI->setRegAllocationHint(reg, OtherHint.first, OtherHint.second);
517     }
518   }
519 }
520
521 /// MergeRangesInAsValue - Merge all of the intervals in RHS into this live
522 /// interval as the specified value number.  The LiveRanges in RHS are
523 /// allowed to overlap with LiveRanges in the current interval, but only if
524 /// the overlapping LiveRanges have the specified value number.
525 void LiveInterval::MergeRangesInAsValue(const LiveInterval &RHS, 
526                                         VNInfo *LHSValNo) {
527   // TODO: Make this more efficient.
528   iterator InsertPos = begin();
529   for (const_iterator I = RHS.begin(), E = RHS.end(); I != E; ++I) {
530     // Map the valno in the other live range to the current live range.
531     LiveRange Tmp = *I;
532     Tmp.valno = LHSValNo;
533     InsertPos = addRangeFrom(Tmp, InsertPos);
534   }
535 }
536
537
538 /// MergeValueInAsValue - Merge all of the live ranges of a specific val#
539 /// in RHS into this live interval as the specified value number.
540 /// The LiveRanges in RHS are allowed to overlap with LiveRanges in the
541 /// current interval, it will replace the value numbers of the overlaped
542 /// live ranges with the specified value number.
543 void LiveInterval::MergeValueInAsValue(const LiveInterval &RHS,
544                                      const VNInfo *RHSValNo, VNInfo *LHSValNo) {
545   SmallVector<VNInfo*, 4> ReplacedValNos;
546   iterator IP = begin();
547   for (const_iterator I = RHS.begin(), E = RHS.end(); I != E; ++I) {
548     if (I->valno != RHSValNo)
549       continue;
550     unsigned Start = I->start, End = I->end;
551     IP = std::upper_bound(IP, end(), Start);
552     // If the start of this range overlaps with an existing liverange, trim it.
553     if (IP != begin() && IP[-1].end > Start) {
554       if (IP[-1].valno != LHSValNo) {
555         ReplacedValNos.push_back(IP[-1].valno);
556         IP[-1].valno = LHSValNo; // Update val#.
557       }
558       Start = IP[-1].end;
559       // Trimmed away the whole range?
560       if (Start >= End) continue;
561     }
562     // If the end of this range overlaps with an existing liverange, trim it.
563     if (IP != end() && End > IP->start) {
564       if (IP->valno != LHSValNo) {
565         ReplacedValNos.push_back(IP->valno);
566         IP->valno = LHSValNo;  // Update val#.
567       }
568       End = IP->start;
569       // If this trimmed away the whole range, ignore it.
570       if (Start == End) continue;
571     }
572     
573     // Map the valno in the other live range to the current live range.
574     IP = addRangeFrom(LiveRange(Start, End, LHSValNo), IP);
575   }
576
577
578   SmallSet<VNInfo*, 4> Seen;
579   for (unsigned i = 0, e = ReplacedValNos.size(); i != e; ++i) {
580     VNInfo *V1 = ReplacedValNos[i];
581     if (Seen.insert(V1)) {
582       bool isDead = true;
583       for (const_iterator I = begin(), E = end(); I != E; ++I)
584         if (I->valno == V1) {
585           isDead = false;
586           break;
587         }          
588       if (isDead) {
589         // Now that V1 is dead, remove it.  If it is the largest value number,
590         // just nuke it (and any other deleted values neighboring it), otherwise
591         // mark it as ~1U so it can be nuked later.
592         if (V1->id == getNumValNums()-1) {
593           do {
594             VNInfo *VNI = valnos.back();
595             valnos.pop_back();
596             VNI->~VNInfo();
597           } while (!valnos.empty() && valnos.back()->isUnused());
598         } else {
599           V1->setIsUnused(true);
600         }
601       }
602     }
603   }
604 }
605
606
607 /// MergeInClobberRanges - For any live ranges that are not defined in the
608 /// current interval, but are defined in the Clobbers interval, mark them
609 /// used with an unknown definition value.
610 void LiveInterval::MergeInClobberRanges(const LiveInterval &Clobbers,
611                                         BumpPtrAllocator &VNInfoAllocator) {
612   if (Clobbers.empty()) return;
613   
614   DenseMap<VNInfo*, VNInfo*> ValNoMaps;
615   VNInfo *UnusedValNo = 0;
616   iterator IP = begin();
617   for (const_iterator I = Clobbers.begin(), E = Clobbers.end(); I != E; ++I) {
618     // For every val# in the Clobbers interval, create a new "unknown" val#.
619     VNInfo *ClobberValNo = 0;
620     DenseMap<VNInfo*, VNInfo*>::iterator VI = ValNoMaps.find(I->valno);
621     if (VI != ValNoMaps.end())
622       ClobberValNo = VI->second;
623     else if (UnusedValNo)
624       ClobberValNo = UnusedValNo;
625     else {
626       UnusedValNo = ClobberValNo = getNextValue(0, 0, false, VNInfoAllocator);
627       ValNoMaps.insert(std::make_pair(I->valno, ClobberValNo));
628     }
629
630     bool Done = false;
631     unsigned Start = I->start, End = I->end;
632     // If a clobber range starts before an existing range and ends after
633     // it, the clobber range will need to be split into multiple ranges.
634     // Loop until the entire clobber range is handled.
635     while (!Done) {
636       Done = true;
637       IP = std::upper_bound(IP, end(), Start);
638       unsigned SubRangeStart = Start;
639       unsigned SubRangeEnd = End;
640
641       // If the start of this range overlaps with an existing liverange, trim it.
642       if (IP != begin() && IP[-1].end > SubRangeStart) {
643         SubRangeStart = IP[-1].end;
644         // Trimmed away the whole range?
645         if (SubRangeStart >= SubRangeEnd) continue;
646       }
647       // If the end of this range overlaps with an existing liverange, trim it.
648       if (IP != end() && SubRangeEnd > IP->start) {
649         // If the clobber live range extends beyond the existing live range,
650         // it'll need at least another live range, so set the flag to keep
651         // iterating.
652         if (SubRangeEnd > IP->end) {
653           Start = IP->end;
654           Done = false;
655         }
656         SubRangeEnd = IP->start;
657         // If this trimmed away the whole range, ignore it.
658         if (SubRangeStart == SubRangeEnd) continue;
659       }
660
661       // Insert the clobber interval.
662       IP = addRangeFrom(LiveRange(SubRangeStart, SubRangeEnd, ClobberValNo),
663                         IP);
664       UnusedValNo = 0;
665     }
666   }
667
668   if (UnusedValNo) {
669     // Delete the last unused val#.
670     valnos.pop_back();
671     UnusedValNo->~VNInfo();
672   }
673 }
674
675 void LiveInterval::MergeInClobberRange(unsigned Start, unsigned End,
676                                        BumpPtrAllocator &VNInfoAllocator) {
677   // Find a value # to use for the clobber ranges.  If there is already a value#
678   // for unknown values, use it.
679   VNInfo *ClobberValNo = getNextValue(0, 0, false, VNInfoAllocator);
680   
681   iterator IP = begin();
682   IP = std::upper_bound(IP, end(), Start);
683     
684   // If the start of this range overlaps with an existing liverange, trim it.
685   if (IP != begin() && IP[-1].end > Start) {
686     Start = IP[-1].end;
687     // Trimmed away the whole range?
688     if (Start >= End) return;
689   }
690   // If the end of this range overlaps with an existing liverange, trim it.
691   if (IP != end() && End > IP->start) {
692     End = IP->start;
693     // If this trimmed away the whole range, ignore it.
694     if (Start == End) return;
695   }
696     
697   // Insert the clobber interval.
698   addRangeFrom(LiveRange(Start, End, ClobberValNo), IP);
699 }
700
701 /// MergeValueNumberInto - This method is called when two value nubmers
702 /// are found to be equivalent.  This eliminates V1, replacing all
703 /// LiveRanges with the V1 value number with the V2 value number.  This can
704 /// cause merging of V1/V2 values numbers and compaction of the value space.
705 VNInfo* LiveInterval::MergeValueNumberInto(VNInfo *V1, VNInfo *V2) {
706   assert(V1 != V2 && "Identical value#'s are always equivalent!");
707
708   // This code actually merges the (numerically) larger value number into the
709   // smaller value number, which is likely to allow us to compactify the value
710   // space.  The only thing we have to be careful of is to preserve the
711   // instruction that defines the result value.
712
713   // Make sure V2 is smaller than V1.
714   if (V1->id < V2->id) {
715     copyValNumInfo(V1, V2);
716     std::swap(V1, V2);
717   }
718
719   // Merge V1 live ranges into V2.
720   for (iterator I = begin(); I != end(); ) {
721     iterator LR = I++;
722     if (LR->valno != V1) continue;  // Not a V1 LiveRange.
723     
724     // Okay, we found a V1 live range.  If it had a previous, touching, V2 live
725     // range, extend it.
726     if (LR != begin()) {
727       iterator Prev = LR-1;
728       if (Prev->valno == V2 && Prev->end == LR->start) {
729         Prev->end = LR->end;
730
731         // Erase this live-range.
732         ranges.erase(LR);
733         I = Prev+1;
734         LR = Prev;
735       }
736     }
737     
738     // Okay, now we have a V1 or V2 live range that is maximally merged forward.
739     // Ensure that it is a V2 live-range.
740     LR->valno = V2;
741     
742     // If we can merge it into later V2 live ranges, do so now.  We ignore any
743     // following V1 live ranges, as they will be merged in subsequent iterations
744     // of the loop.
745     if (I != end()) {
746       if (I->start == LR->end && I->valno == V2) {
747         LR->end = I->end;
748         ranges.erase(I);
749         I = LR+1;
750       }
751     }
752   }
753   
754   // Now that V1 is dead, remove it.  If it is the largest value number, just
755   // nuke it (and any other deleted values neighboring it), otherwise mark it as
756   // ~1U so it can be nuked later.
757   if (V1->id == getNumValNums()-1) {
758     do {
759       VNInfo *VNI = valnos.back();
760       valnos.pop_back();
761       VNI->~VNInfo();
762     } while (valnos.back()->isUnused());
763   } else {
764     V1->setIsUnused(true);
765   }
766   
767   return V2;
768 }
769
770 void LiveInterval::Copy(const LiveInterval &RHS,
771                         MachineRegisterInfo *MRI,
772                         BumpPtrAllocator &VNInfoAllocator) {
773   ranges.clear();
774   valnos.clear();
775   std::pair<unsigned, unsigned> Hint = MRI->getRegAllocationHint(RHS.reg);
776   MRI->setRegAllocationHint(reg, Hint.first, Hint.second);
777
778   weight = RHS.weight;
779   for (unsigned i = 0, e = RHS.getNumValNums(); i != e; ++i) {
780     const VNInfo *VNI = RHS.getValNumInfo(i);
781     createValueCopy(VNI, VNInfoAllocator);
782   }
783   for (unsigned i = 0, e = RHS.ranges.size(); i != e; ++i) {
784     const LiveRange &LR = RHS.ranges[i];
785     addRange(LiveRange(LR.start, LR.end, getValNumInfo(LR.valno->id)));
786   }
787 }
788
789 unsigned LiveInterval::getSize() const {
790   unsigned Sum = 0;
791   for (const_iterator I = begin(), E = end(); I != E; ++I)
792     Sum += I->end - I->start;
793   return Sum;
794 }
795
796 /// ComputeJoinedWeight - Set the weight of a live interval Joined
797 /// after Other has been merged into it.
798 void LiveInterval::ComputeJoinedWeight(const LiveInterval &Other) {
799   // If either of these intervals was spilled, the weight is the
800   // weight of the non-spilled interval.  This can only happen with
801   // iterative coalescers.
802
803   if (weight == HUGE_VALF &&
804       !TargetRegisterInfo::isPhysicalRegister(reg)) {
805     // Remove this assert if you have an iterative coalescer
806     assert(0 && "Joining to spilled interval");
807     weight = Other.weight;
808   }
809   else if (Other.weight != HUGE_VALF) {
810     weight += Other.weight;
811   }
812   else {
813     // Otherwise the weight stays the same
814     // Remove this assert if you have an iterative coalescer
815     assert(0 && "Joining from spilled interval");
816   }
817 }
818
819 std::ostream& llvm::operator<<(std::ostream& os, const LiveRange &LR) {
820   return os << '[' << LR.start << ',' << LR.end << ':' << LR.valno->id << ")";
821 }
822
823 void LiveRange::dump() const {
824   cerr << *this << "\n";
825 }
826
827 void LiveInterval::print(std::ostream &OS,
828                          const TargetRegisterInfo *TRI) const {
829   if (isStackSlot())
830     OS << "SS#" << getStackSlotIndex();
831   else if (TRI && TargetRegisterInfo::isPhysicalRegister(reg))
832     OS << TRI->getName(reg);
833   else
834     OS << "%reg" << reg;
835
836   OS << ',' << weight;
837
838   if (empty())
839     OS << " EMPTY";
840   else {
841     OS << " = ";
842     for (LiveInterval::Ranges::const_iterator I = ranges.begin(),
843            E = ranges.end(); I != E; ++I)
844     OS << *I;
845   }
846   
847   // Print value number info.
848   if (getNumValNums()) {
849     OS << "  ";
850     unsigned vnum = 0;
851     for (const_vni_iterator i = vni_begin(), e = vni_end(); i != e;
852          ++i, ++vnum) {
853       const VNInfo *vni = *i;
854       if (vnum) OS << " ";
855       OS << vnum << "@";
856       if (vni->isUnused()) {
857         OS << "x";
858       } else {
859         if (!vni->isDefAccurate())
860           OS << "?";
861         else
862           OS << vni->def;
863         unsigned ee = vni->kills.size();
864         if (ee || vni->hasPHIKill()) {
865           OS << "-(";
866           for (unsigned j = 0; j != ee; ++j) {
867             OS << vni->kills[j].killIdx;
868             if (vni->kills[j].isPHIKill)
869               OS << "*";
870             if (j != ee-1)
871               OS << " ";
872           }
873           if (vni->hasPHIKill()) {
874             if (ee)
875               OS << " ";
876             OS << "phi";
877           }
878           OS << ")";
879         }
880       }
881     }
882   }
883 }
884
885 void LiveInterval::dump() const {
886   cerr << *this << "\n";
887 }
888
889
890 void LiveRange::print(std::ostream &os) const {
891   os << *this;
892 }