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