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