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 range 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 ranges can have holes,
15 // i.e. a range might look like [1,20), [50,65), [1000,1001).  Each
16 // individual segment is represented as an instance of LiveRange::Segment,
17 // and the whole range is represented as an instance of LiveRange.
18 //
19 //===----------------------------------------------------------------------===//
20 
21 #include "llvm/CodeGen/LiveInterval.h"
22 #include "RegisterCoalescer.h"
23 #include "llvm/ADT/STLExtras.h"
24 #include "llvm/ADT/SmallSet.h"
25 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
26 #include "llvm/CodeGen/MachineRegisterInfo.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 namespace {
34 //===----------------------------------------------------------------------===//
35 // Implementation of various methods necessary for calculation of live ranges.
36 // The implementation of the methods abstracts from the concrete type of the
37 // segment collection.
38 //
39 // Implementation of the class follows the Template design pattern. The base
40 // class contains generic algorithms that call collection-specific methods,
41 // which are provided in concrete subclasses. In order to avoid virtual calls
42 // these methods are provided by means of C++ template instantiation.
43 // The base class calls the methods of the subclass through method impl(),
44 // which casts 'this' pointer to the type of the subclass.
45 //
46 //===----------------------------------------------------------------------===//
47 
48 template <typename ImplT, typename IteratorT, typename CollectionT>
49 class CalcLiveRangeUtilBase {
50 protected:
51   LiveRange *LR;
52 
53 protected:
54   CalcLiveRangeUtilBase(LiveRange *LR) : LR(LR) {}
55 
56 public:
57   typedef LiveRange::Segment Segment;
58   typedef IteratorT iterator;
59 
60   VNInfo *createDeadDef(SlotIndex Def, VNInfo::Allocator &VNInfoAllocator) {
61     assert(!Def.isDead() && "Cannot define a value at the dead slot");
62 
63     iterator I = impl().find(Def);
64     if (I == segments().end()) {
65       VNInfo *VNI = LR->getNextValue(Def, VNInfoAllocator);
66       impl().insertAtEnd(Segment(Def, Def.getDeadSlot(), VNI));
67       return VNI;
68     }
69 
70     Segment *S = segmentAt(I);
71     if (SlotIndex::isSameInstr(Def, S->start)) {
72       assert(S->valno->def == S->start && "Inconsistent existing value def");
73 
74       // It is possible to have both normal and early-clobber defs of the same
75       // register on an instruction. It doesn't make a lot of sense, but it is
76       // possible to specify in inline assembly.
77       //
78       // Just convert everything to early-clobber.
79       Def = std::min(Def, S->start);
80       if (Def != S->start)
81         S->start = S->valno->def = Def;
82       return S->valno;
83     }
84     assert(SlotIndex::isEarlierInstr(Def, S->start) && "Already live at def");
85     VNInfo *VNI = LR->getNextValue(Def, VNInfoAllocator);
86     segments().insert(I, Segment(Def, Def.getDeadSlot(), VNI));
87     return VNI;
88   }
89 
90   VNInfo *extendInBlock(SlotIndex StartIdx, SlotIndex Use) {
91     if (segments().empty())
92       return nullptr;
93     iterator I =
94         impl().findInsertPos(Segment(Use.getPrevSlot(), Use, nullptr));
95     if (I == segments().begin())
96       return nullptr;
97     --I;
98     if (I->end <= StartIdx)
99       return nullptr;
100     if (I->end < Use)
101       extendSegmentEndTo(I, Use);
102     return I->valno;
103   }
104 
105   /// This method is used when we want to extend the segment specified
106   /// by I to end at the specified endpoint. To do this, we should
107   /// merge and eliminate all segments that this will overlap
108   /// with. The iterator is not invalidated.
109   void extendSegmentEndTo(iterator I, SlotIndex NewEnd) {
110     assert(I != segments().end() && "Not a valid segment!");
111     Segment *S = segmentAt(I);
112     VNInfo *ValNo = I->valno;
113 
114     // Search for the first segment that we can't merge with.
115     iterator MergeTo = std::next(I);
116     for (; MergeTo != segments().end() && NewEnd >= MergeTo->end; ++MergeTo)
117       assert(MergeTo->valno == ValNo && "Cannot merge with differing values!");
118 
119     // If NewEnd was in the middle of a segment, make sure to get its endpoint.
120     S->end = std::max(NewEnd, std::prev(MergeTo)->end);
121 
122     // If the newly formed segment now touches the segment after it and if they
123     // have the same value number, merge the two segments into one segment.
124     if (MergeTo != segments().end() && MergeTo->start <= I->end &&
125         MergeTo->valno == ValNo) {
126       S->end = MergeTo->end;
127       ++MergeTo;
128     }
129 
130     // Erase any dead segments.
131     segments().erase(std::next(I), MergeTo);
132   }
133 
134   /// This method is used when we want to extend the segment specified
135   /// by I to start at the specified endpoint.  To do this, we should
136   /// merge and eliminate all segments that this will overlap with.
137   iterator extendSegmentStartTo(iterator I, SlotIndex NewStart) {
138     assert(I != segments().end() && "Not a valid segment!");
139     Segment *S = segmentAt(I);
140     VNInfo *ValNo = I->valno;
141 
142     // Search for the first segment that we can't merge with.
143     iterator MergeTo = I;
144     do {
145       if (MergeTo == segments().begin()) {
146         S->start = NewStart;
147         segments().erase(MergeTo, I);
148         return I;
149       }
150       assert(MergeTo->valno == ValNo && "Cannot merge with differing values!");
151       --MergeTo;
152     } while (NewStart <= MergeTo->start);
153 
154     // If we start in the middle of another segment, just delete a range and
155     // extend that segment.
156     if (MergeTo->end >= NewStart && MergeTo->valno == ValNo) {
157       segmentAt(MergeTo)->end = S->end;
158     } else {
159       // Otherwise, extend the segment right after.
160       ++MergeTo;
161       Segment *MergeToSeg = segmentAt(MergeTo);
162       MergeToSeg->start = NewStart;
163       MergeToSeg->end = S->end;
164     }
165 
166     segments().erase(std::next(MergeTo), std::next(I));
167     return MergeTo;
168   }
169 
170   iterator addSegment(Segment S) {
171     SlotIndex Start = S.start, End = S.end;
172     iterator I = impl().findInsertPos(S);
173 
174     // If the inserted segment starts in the middle or right at the end of
175     // another segment, just extend that segment to contain the segment of S.
176     if (I != segments().begin()) {
177       iterator B = std::prev(I);
178       if (S.valno == B->valno) {
179         if (B->start <= Start && B->end >= Start) {
180           extendSegmentEndTo(B, End);
181           return B;
182         }
183       } else {
184         // Check to make sure that we are not overlapping two live segments with
185         // different valno's.
186         assert(B->end <= Start &&
187                "Cannot overlap two segments with differing ValID's"
188                " (did you def the same reg twice in a MachineInstr?)");
189       }
190     }
191 
192     // Otherwise, if this segment ends in the middle of, or right next
193     // to, another segment, merge it into that segment.
194     if (I != segments().end()) {
195       if (S.valno == I->valno) {
196         if (I->start <= End) {
197           I = extendSegmentStartTo(I, Start);
198 
199           // If S is a complete superset of a segment, we may need to grow its
200           // endpoint as well.
201           if (End > I->end)
202             extendSegmentEndTo(I, End);
203           return I;
204         }
205       } else {
206         // Check to make sure that we are not overlapping two live segments with
207         // different valno's.
208         assert(I->start >= End &&
209                "Cannot overlap two segments with differing ValID's");
210       }
211     }
212 
213     // Otherwise, this is just a new segment that doesn't interact with
214     // anything.
215     // Insert it.
216     return segments().insert(I, S);
217   }
218 
219 private:
220   ImplT &impl() { return *static_cast<ImplT *>(this); }
221 
222   CollectionT &segments() { return impl().segmentsColl(); }
223 
224   Segment *segmentAt(iterator I) { return const_cast<Segment *>(&(*I)); }
225 };
226 
227 //===----------------------------------------------------------------------===//
228 //   Instantiation of the methods for calculation of live ranges
229 //   based on a segment vector.
230 //===----------------------------------------------------------------------===//
231 
232 class CalcLiveRangeUtilVector;
233 typedef CalcLiveRangeUtilBase<CalcLiveRangeUtilVector, LiveRange::iterator,
234                               LiveRange::Segments> CalcLiveRangeUtilVectorBase;
235 
236 class CalcLiveRangeUtilVector : public CalcLiveRangeUtilVectorBase {
237 public:
238   CalcLiveRangeUtilVector(LiveRange *LR) : CalcLiveRangeUtilVectorBase(LR) {}
239 
240 private:
241   friend CalcLiveRangeUtilVectorBase;
242 
243   LiveRange::Segments &segmentsColl() { return LR->segments; }
244 
245   void insertAtEnd(const Segment &S) { LR->segments.push_back(S); }
246 
247   iterator find(SlotIndex Pos) { return LR->find(Pos); }
248 
249   iterator findInsertPos(Segment S) {
250     return std::upper_bound(LR->begin(), LR->end(), S.start);
251   }
252 };
253 
254 //===----------------------------------------------------------------------===//
255 //   Instantiation of the methods for calculation of live ranges
256 //   based on a segment set.
257 //===----------------------------------------------------------------------===//
258 
259 class CalcLiveRangeUtilSet;
260 typedef CalcLiveRangeUtilBase<CalcLiveRangeUtilSet,
261                               LiveRange::SegmentSet::iterator,
262                               LiveRange::SegmentSet> CalcLiveRangeUtilSetBase;
263 
264 class CalcLiveRangeUtilSet : public CalcLiveRangeUtilSetBase {
265 public:
266   CalcLiveRangeUtilSet(LiveRange *LR) : CalcLiveRangeUtilSetBase(LR) {}
267 
268 private:
269   friend CalcLiveRangeUtilSetBase;
270 
271   LiveRange::SegmentSet &segmentsColl() { return *LR->segmentSet; }
272 
273   void insertAtEnd(const Segment &S) {
274     LR->segmentSet->insert(LR->segmentSet->end(), S);
275   }
276 
277   iterator find(SlotIndex Pos) {
278     iterator I =
279         LR->segmentSet->upper_bound(Segment(Pos, Pos.getNextSlot(), nullptr));
280     if (I == LR->segmentSet->begin())
281       return I;
282     iterator PrevI = std::prev(I);
283     if (Pos < (*PrevI).end)
284       return PrevI;
285     return I;
286   }
287 
288   iterator findInsertPos(Segment S) {
289     iterator I = LR->segmentSet->upper_bound(S);
290     if (I != LR->segmentSet->end() && !(S.start < *I))
291       ++I;
292     return I;
293   }
294 };
295 } // namespace
296 
297 //===----------------------------------------------------------------------===//
298 //   LiveRange methods
299 //===----------------------------------------------------------------------===//
300 
301 LiveRange::iterator LiveRange::find(SlotIndex Pos) {
302   // This algorithm is basically std::upper_bound.
303   // Unfortunately, std::upper_bound cannot be used with mixed types until we
304   // adopt C++0x. Many libraries can do it, but not all.
305   if (empty() || Pos >= endIndex())
306     return end();
307   iterator I = begin();
308   size_t Len = size();
309   do {
310     size_t Mid = Len >> 1;
311     if (Pos < I[Mid].end) {
312       Len = Mid;
313     } else {
314       I += Mid + 1;
315       Len -= Mid + 1;
316     }
317   } while (Len);
318   return I;
319 }
320 
321 VNInfo *LiveRange::createDeadDef(SlotIndex Def,
322                                   VNInfo::Allocator &VNInfoAllocator) {
323   // Use the segment set, if it is available.
324   if (segmentSet != nullptr)
325     return CalcLiveRangeUtilSet(this).createDeadDef(Def, VNInfoAllocator);
326   // Otherwise use the segment vector.
327   return CalcLiveRangeUtilVector(this).createDeadDef(Def, VNInfoAllocator);
328 }
329 
330 // overlaps - Return true if the intersection of the two live ranges is
331 // not empty.
332 //
333 // An example for overlaps():
334 //
335 // 0: A = ...
336 // 4: B = ...
337 // 8: C = A + B ;; last use of A
338 //
339 // The live ranges should look like:
340 //
341 // A = [3, 11)
342 // B = [7, x)
343 // C = [11, y)
344 //
345 // A->overlaps(C) should return false since we want to be able to join
346 // A and C.
347 //
348 bool LiveRange::overlapsFrom(const LiveRange& other,
349                              const_iterator StartPos) const {
350   assert(!empty() && "empty range");
351   const_iterator i = begin();
352   const_iterator ie = end();
353   const_iterator j = StartPos;
354   const_iterator je = other.end();
355 
356   assert((StartPos->start <= i->start || StartPos == other.begin()) &&
357          StartPos != other.end() && "Bogus start position hint!");
358 
359   if (i->start < j->start) {
360     i = std::upper_bound(i, ie, j->start);
361     if (i != begin()) --i;
362   } else if (j->start < i->start) {
363     ++StartPos;
364     if (StartPos != other.end() && StartPos->start <= i->start) {
365       assert(StartPos < other.end() && i < end());
366       j = std::upper_bound(j, je, i->start);
367       if (j != other.begin()) --j;
368     }
369   } else {
370     return true;
371   }
372 
373   if (j == je) return false;
374 
375   while (i != ie) {
376     if (i->start > j->start) {
377       std::swap(i, j);
378       std::swap(ie, je);
379     }
380 
381     if (i->end > j->start)
382       return true;
383     ++i;
384   }
385 
386   return false;
387 }
388 
389 bool LiveRange::overlaps(const LiveRange &Other, const CoalescerPair &CP,
390                          const SlotIndexes &Indexes) const {
391   assert(!empty() && "empty range");
392   if (Other.empty())
393     return false;
394 
395   // Use binary searches to find initial positions.
396   const_iterator I = find(Other.beginIndex());
397   const_iterator IE = end();
398   if (I == IE)
399     return false;
400   const_iterator J = Other.find(I->start);
401   const_iterator JE = Other.end();
402   if (J == JE)
403     return false;
404 
405   for (;;) {
406     // J has just been advanced to satisfy:
407     assert(J->end >= I->start);
408     // Check for an overlap.
409     if (J->start < I->end) {
410       // I and J are overlapping. Find the later start.
411       SlotIndex Def = std::max(I->start, J->start);
412       // Allow the overlap if Def is a coalescable copy.
413       if (Def.isBlock() ||
414           !CP.isCoalescable(Indexes.getInstructionFromIndex(Def)))
415         return true;
416     }
417     // Advance the iterator that ends first to check for more overlaps.
418     if (J->end > I->end) {
419       std::swap(I, J);
420       std::swap(IE, JE);
421     }
422     // Advance J until J->end >= I->start.
423     do
424       if (++J == JE)
425         return false;
426     while (J->end < I->start);
427   }
428 }
429 
430 /// overlaps - Return true if the live range overlaps an interval specified
431 /// by [Start, End).
432 bool LiveRange::overlaps(SlotIndex Start, SlotIndex End) const {
433   assert(Start < End && "Invalid range");
434   const_iterator I = std::lower_bound(begin(), end(), End);
435   return I != begin() && (--I)->end > Start;
436 }
437 
438 bool LiveRange::covers(const LiveRange &Other) const {
439   if (empty())
440     return Other.empty();
441 
442   const_iterator I = begin();
443   for (const Segment &O : Other.segments) {
444     I = advanceTo(I, O.start);
445     if (I == end() || I->start > O.start)
446       return false;
447 
448     // Check adjacent live segments and see if we can get behind O.end.
449     while (I->end < O.end) {
450       const_iterator Last = I;
451       // Get next segment and abort if it was not adjacent.
452       ++I;
453       if (I == end() || Last->end != I->start)
454         return false;
455     }
456   }
457   return true;
458 }
459 
460 /// ValNo is dead, remove it.  If it is the largest value number, just nuke it
461 /// (and any other deleted values neighboring it), otherwise mark it as ~1U so
462 /// it can be nuked later.
463 void LiveRange::markValNoForDeletion(VNInfo *ValNo) {
464   if (ValNo->id == getNumValNums()-1) {
465     do {
466       valnos.pop_back();
467     } while (!valnos.empty() && valnos.back()->isUnused());
468   } else {
469     ValNo->markUnused();
470   }
471 }
472 
473 /// RenumberValues - Renumber all values in order of appearance and delete the
474 /// remaining unused values.
475 void LiveRange::RenumberValues() {
476   SmallPtrSet<VNInfo*, 8> Seen;
477   valnos.clear();
478   for (const Segment &S : segments) {
479     VNInfo *VNI = S.valno;
480     if (!Seen.insert(VNI).second)
481       continue;
482     assert(!VNI->isUnused() && "Unused valno used by live segment");
483     VNI->id = (unsigned)valnos.size();
484     valnos.push_back(VNI);
485   }
486 }
487 
488 void LiveRange::addSegmentToSet(Segment S) {
489   CalcLiveRangeUtilSet(this).addSegment(S);
490 }
491 
492 LiveRange::iterator LiveRange::addSegment(Segment S) {
493   // Use the segment set, if it is available.
494   if (segmentSet != nullptr) {
495     addSegmentToSet(S);
496     return end();
497   }
498   // Otherwise use the segment vector.
499   return CalcLiveRangeUtilVector(this).addSegment(S);
500 }
501 
502 void LiveRange::append(const Segment S) {
503   // Check that the segment belongs to the back of the list.
504   assert(segments.empty() || segments.back().end <= S.start);
505   segments.push_back(S);
506 }
507 
508 /// extendInBlock - If this range is live before Kill in the basic
509 /// block that starts at StartIdx, extend it to be live up to Kill and return
510 /// the value. If there is no live range before Kill, return NULL.
511 VNInfo *LiveRange::extendInBlock(SlotIndex StartIdx, SlotIndex Kill) {
512   // Use the segment set, if it is available.
513   if (segmentSet != nullptr)
514     return CalcLiveRangeUtilSet(this).extendInBlock(StartIdx, Kill);
515   // Otherwise use the segment vector.
516   return CalcLiveRangeUtilVector(this).extendInBlock(StartIdx, Kill);
517 }
518 
519 /// Remove the specified segment from this range.  Note that the segment must
520 /// be in a single Segment in its entirety.
521 void LiveRange::removeSegment(SlotIndex Start, SlotIndex End,
522                               bool RemoveDeadValNo) {
523   // Find the Segment containing this span.
524   iterator I = find(Start);
525   assert(I != end() && "Segment is not in range!");
526   assert(I->containsInterval(Start, End)
527          && "Segment is not entirely in range!");
528 
529   // If the span we are removing is at the start of the Segment, adjust it.
530   VNInfo *ValNo = I->valno;
531   if (I->start == Start) {
532     if (I->end == End) {
533       if (RemoveDeadValNo) {
534         // Check if val# is dead.
535         bool isDead = true;
536         for (const_iterator II = begin(), EE = end(); II != EE; ++II)
537           if (II != I && II->valno == ValNo) {
538             isDead = false;
539             break;
540           }
541         if (isDead) {
542           // Now that ValNo is dead, remove it.
543           markValNoForDeletion(ValNo);
544         }
545       }
546 
547       segments.erase(I);  // Removed the whole Segment.
548     } else
549       I->start = End;
550     return;
551   }
552 
553   // Otherwise if the span we are removing is at the end of the Segment,
554   // adjust the other way.
555   if (I->end == End) {
556     I->end = Start;
557     return;
558   }
559 
560   // Otherwise, we are splitting the Segment into two pieces.
561   SlotIndex OldEnd = I->end;
562   I->end = Start;   // Trim the old segment.
563 
564   // Insert the new one.
565   segments.insert(std::next(I), Segment(End, OldEnd, ValNo));
566 }
567 
568 /// removeValNo - Remove all the segments defined by the specified value#.
569 /// Also remove the value# from value# list.
570 void LiveRange::removeValNo(VNInfo *ValNo) {
571   if (empty()) return;
572   segments.erase(std::remove_if(begin(), end(), [ValNo](const Segment &S) {
573     return S.valno == ValNo;
574   }), end());
575   // Now that ValNo is dead, remove it.
576   markValNoForDeletion(ValNo);
577 }
578 
579 void LiveRange::join(LiveRange &Other,
580                      const int *LHSValNoAssignments,
581                      const int *RHSValNoAssignments,
582                      SmallVectorImpl<VNInfo *> &NewVNInfo) {
583   verify();
584 
585   // Determine if any of our values are mapped.  This is uncommon, so we want
586   // to avoid the range scan if not.
587   bool MustMapCurValNos = false;
588   unsigned NumVals = getNumValNums();
589   unsigned NumNewVals = NewVNInfo.size();
590   for (unsigned i = 0; i != NumVals; ++i) {
591     unsigned LHSValID = LHSValNoAssignments[i];
592     if (i != LHSValID ||
593         (NewVNInfo[LHSValID] && NewVNInfo[LHSValID] != getValNumInfo(i))) {
594       MustMapCurValNos = true;
595       break;
596     }
597   }
598 
599   // If we have to apply a mapping to our base range assignment, rewrite it now.
600   if (MustMapCurValNos && !empty()) {
601     // Map the first live range.
602 
603     iterator OutIt = begin();
604     OutIt->valno = NewVNInfo[LHSValNoAssignments[OutIt->valno->id]];
605     for (iterator I = std::next(OutIt), E = end(); I != E; ++I) {
606       VNInfo* nextValNo = NewVNInfo[LHSValNoAssignments[I->valno->id]];
607       assert(nextValNo && "Huh?");
608 
609       // If this live range has the same value # as its immediate predecessor,
610       // and if they are neighbors, remove one Segment.  This happens when we
611       // have [0,4:0)[4,7:1) and map 0/1 onto the same value #.
612       if (OutIt->valno == nextValNo && OutIt->end == I->start) {
613         OutIt->end = I->end;
614       } else {
615         // Didn't merge. Move OutIt to the next segment,
616         ++OutIt;
617         OutIt->valno = nextValNo;
618         if (OutIt != I) {
619           OutIt->start = I->start;
620           OutIt->end = I->end;
621         }
622       }
623     }
624     // If we merge some segments, chop off the end.
625     ++OutIt;
626     segments.erase(OutIt, end());
627   }
628 
629   // Rewrite Other values before changing the VNInfo ids.
630   // This can leave Other in an invalid state because we're not coalescing
631   // touching segments that now have identical values. That's OK since Other is
632   // not supposed to be valid after calling join();
633   for (Segment &S : Other.segments)
634     S.valno = NewVNInfo[RHSValNoAssignments[S.valno->id]];
635 
636   // Update val# info. Renumber them and make sure they all belong to this
637   // LiveRange now. Also remove dead val#'s.
638   unsigned NumValNos = 0;
639   for (unsigned i = 0; i < NumNewVals; ++i) {
640     VNInfo *VNI = NewVNInfo[i];
641     if (VNI) {
642       if (NumValNos >= NumVals)
643         valnos.push_back(VNI);
644       else
645         valnos[NumValNos] = VNI;
646       VNI->id = NumValNos++;  // Renumber val#.
647     }
648   }
649   if (NumNewVals < NumVals)
650     valnos.resize(NumNewVals);  // shrinkify
651 
652   // Okay, now insert the RHS live segments into the LHS.
653   LiveRangeUpdater Updater(this);
654   for (Segment &S : Other.segments)
655     Updater.add(S);
656 }
657 
658 /// Merge all of the segments in RHS into this live range as the specified
659 /// value number.  The segments in RHS are allowed to overlap with segments in
660 /// the current range, but only if the overlapping segments have the
661 /// specified value number.
662 void LiveRange::MergeSegmentsInAsValue(const LiveRange &RHS,
663                                        VNInfo *LHSValNo) {
664   LiveRangeUpdater Updater(this);
665   for (const Segment &S : RHS.segments)
666     Updater.add(S.start, S.end, LHSValNo);
667 }
668 
669 /// MergeValueInAsValue - Merge all of the live segments of a specific val#
670 /// in RHS into this live range as the specified value number.
671 /// The segments in RHS are allowed to overlap with segments in the
672 /// current range, it will replace the value numbers of the overlaped
673 /// segments with the specified value number.
674 void LiveRange::MergeValueInAsValue(const LiveRange &RHS,
675                                     const VNInfo *RHSValNo,
676                                     VNInfo *LHSValNo) {
677   LiveRangeUpdater Updater(this);
678   for (const Segment &S : RHS.segments)
679     if (S.valno == RHSValNo)
680       Updater.add(S.start, S.end, LHSValNo);
681 }
682 
683 /// MergeValueNumberInto - This method is called when two value nubmers
684 /// are found to be equivalent.  This eliminates V1, replacing all
685 /// segments with the V1 value number with the V2 value number.  This can
686 /// cause merging of V1/V2 values numbers and compaction of the value space.
687 VNInfo *LiveRange::MergeValueNumberInto(VNInfo *V1, VNInfo *V2) {
688   assert(V1 != V2 && "Identical value#'s are always equivalent!");
689 
690   // This code actually merges the (numerically) larger value number into the
691   // smaller value number, which is likely to allow us to compactify the value
692   // space.  The only thing we have to be careful of is to preserve the
693   // instruction that defines the result value.
694 
695   // Make sure V2 is smaller than V1.
696   if (V1->id < V2->id) {
697     V1->copyFrom(*V2);
698     std::swap(V1, V2);
699   }
700 
701   // Merge V1 segments into V2.
702   for (iterator I = begin(); I != end(); ) {
703     iterator S = I++;
704     if (S->valno != V1) continue;  // Not a V1 Segment.
705 
706     // Okay, we found a V1 live range.  If it had a previous, touching, V2 live
707     // range, extend it.
708     if (S != begin()) {
709       iterator Prev = S-1;
710       if (Prev->valno == V2 && Prev->end == S->start) {
711         Prev->end = S->end;
712 
713         // Erase this live-range.
714         segments.erase(S);
715         I = Prev+1;
716         S = Prev;
717       }
718     }
719 
720     // Okay, now we have a V1 or V2 live range that is maximally merged forward.
721     // Ensure that it is a V2 live-range.
722     S->valno = V2;
723 
724     // If we can merge it into later V2 segments, do so now.  We ignore any
725     // following V1 segments, as they will be merged in subsequent iterations
726     // of the loop.
727     if (I != end()) {
728       if (I->start == S->end && I->valno == V2) {
729         S->end = I->end;
730         segments.erase(I);
731         I = S+1;
732       }
733     }
734   }
735 
736   // Now that V1 is dead, remove it.
737   markValNoForDeletion(V1);
738 
739   return V2;
740 }
741 
742 void LiveRange::flushSegmentSet() {
743   assert(segmentSet != nullptr && "segment set must have been created");
744   assert(
745       segments.empty() &&
746       "segment set can be used only initially before switching to the array");
747   segments.append(segmentSet->begin(), segmentSet->end());
748   segmentSet = nullptr;
749   verify();
750 }
751 
752 bool LiveRange::isLiveAtIndexes(ArrayRef<SlotIndex> Slots) const {
753   ArrayRef<SlotIndex>::iterator SlotI = Slots.begin();
754   ArrayRef<SlotIndex>::iterator SlotE = Slots.end();
755 
756   // If there are no regmask slots, we have nothing to search.
757   if (SlotI == SlotE)
758     return false;
759 
760   // Start our search at the first segment that ends after the first slot.
761   const_iterator SegmentI = find(*SlotI);
762   const_iterator SegmentE = end();
763 
764   // If there are no segments that end after the first slot, we're done.
765   if (SegmentI == SegmentE)
766     return false;
767 
768   // Look for each slot in the live range.
769   for ( ; SlotI != SlotE; ++SlotI) {
770     // Go to the next segment that ends after the current slot.
771     // The slot may be within a hole in the range.
772     SegmentI = advanceTo(SegmentI, *SlotI);
773     if (SegmentI == SegmentE)
774       return false;
775 
776     // If this segment contains the slot, we're done.
777     if (SegmentI->contains(*SlotI))
778       return true;
779     // Otherwise, look for the next slot.
780   }
781 
782   // We didn't find a segment containing any of the slots.
783   return false;
784 }
785 
786 void LiveInterval::freeSubRange(SubRange *S) {
787   S->~SubRange();
788   // Memory was allocated with BumpPtr allocator and is not freed here.
789 }
790 
791 void LiveInterval::removeEmptySubRanges() {
792   SubRange **NextPtr = &SubRanges;
793   SubRange *I = *NextPtr;
794   while (I != nullptr) {
795     if (!I->empty()) {
796       NextPtr = &I->Next;
797       I = *NextPtr;
798       continue;
799     }
800     // Skip empty subranges until we find the first nonempty one.
801     do {
802       SubRange *Next = I->Next;
803       freeSubRange(I);
804       I = Next;
805     } while (I != nullptr && I->empty());
806     *NextPtr = I;
807   }
808 }
809 
810 void LiveInterval::clearSubRanges() {
811   for (SubRange *I = SubRanges, *Next; I != nullptr; I = Next) {
812     Next = I->Next;
813     freeSubRange(I);
814   }
815   SubRanges = nullptr;
816 }
817 
818 unsigned LiveInterval::getSize() const {
819   unsigned Sum = 0;
820   for (const Segment &S : segments)
821     Sum += S.start.distance(S.end);
822   return Sum;
823 }
824 
825 raw_ostream& llvm::operator<<(raw_ostream& os, const LiveRange::Segment &S) {
826   return os << '[' << S.start << ',' << S.end << ':' << S.valno->id << ")";
827 }
828 
829 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
830 LLVM_DUMP_METHOD void LiveRange::Segment::dump() const {
831   dbgs() << *this << "\n";
832 }
833 #endif
834 
835 void LiveRange::print(raw_ostream &OS) const {
836   if (empty())
837     OS << "EMPTY";
838   else {
839     for (const Segment &S : segments) {
840       OS << S;
841       assert(S.valno == getValNumInfo(S.valno->id) && "Bad VNInfo");
842     }
843   }
844 
845   // Print value number info.
846   if (getNumValNums()) {
847     OS << "  ";
848     unsigned vnum = 0;
849     for (const_vni_iterator i = vni_begin(), e = vni_end(); i != e;
850          ++i, ++vnum) {
851       const VNInfo *vni = *i;
852       if (vnum) OS << " ";
853       OS << vnum << "@";
854       if (vni->isUnused()) {
855         OS << "x";
856       } else {
857         OS << vni->def;
858         if (vni->isPHIDef())
859           OS << "-phi";
860       }
861     }
862   }
863 }
864 
865 void LiveInterval::print(raw_ostream &OS) const {
866   OS << PrintReg(reg) << ' ';
867   super::print(OS);
868   // Print subranges
869   for (const SubRange &SR : subranges()) {
870     OS << " L" << PrintLaneMask(SR.LaneMask) << ' ' << SR;
871   }
872 }
873 
874 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
875 LLVM_DUMP_METHOD void LiveRange::dump() const {
876   dbgs() << *this << "\n";
877 }
878 
879 LLVM_DUMP_METHOD void LiveInterval::dump() const {
880   dbgs() << *this << "\n";
881 }
882 #endif
883 
884 #ifndef NDEBUG
885 void LiveRange::verify() const {
886   for (const_iterator I = begin(), E = end(); I != E; ++I) {
887     assert(I->start.isValid());
888     assert(I->end.isValid());
889     assert(I->start < I->end);
890     assert(I->valno != nullptr);
891     assert(I->valno->id < valnos.size());
892     assert(I->valno == valnos[I->valno->id]);
893     if (std::next(I) != E) {
894       assert(I->end <= std::next(I)->start);
895       if (I->end == std::next(I)->start)
896         assert(I->valno != std::next(I)->valno);
897     }
898   }
899 }
900 
901 void LiveInterval::verify(const MachineRegisterInfo *MRI) const {
902   super::verify();
903 
904   // Make sure SubRanges are fine and LaneMasks are disjunct.
905   LaneBitmask Mask = 0;
906   LaneBitmask MaxMask = MRI != nullptr ? MRI->getMaxLaneMaskForVReg(reg) : ~0u;
907   for (const SubRange &SR : subranges()) {
908     // Subrange lanemask should be disjunct to any previous subrange masks.
909     assert((Mask & SR.LaneMask) == 0);
910     Mask |= SR.LaneMask;
911 
912     // subrange mask should not contained in maximum lane mask for the vreg.
913     assert((Mask & ~MaxMask) == 0);
914     // empty subranges must be removed.
915     assert(!SR.empty());
916 
917     SR.verify();
918     // Main liverange should cover subrange.
919     assert(covers(SR));
920   }
921 }
922 #endif
923 
924 
925 //===----------------------------------------------------------------------===//
926 //                           LiveRangeUpdater class
927 //===----------------------------------------------------------------------===//
928 //
929 // The LiveRangeUpdater class always maintains these invariants:
930 //
931 // - When LastStart is invalid, Spills is empty and the iterators are invalid.
932 //   This is the initial state, and the state created by flush().
933 //   In this state, isDirty() returns false.
934 //
935 // Otherwise, segments are kept in three separate areas:
936 //
937 // 1. [begin; WriteI) at the front of LR.
938 // 2. [ReadI; end) at the back of LR.
939 // 3. Spills.
940 //
941 // - LR.begin() <= WriteI <= ReadI <= LR.end().
942 // - Segments in all three areas are fully ordered and coalesced.
943 // - Segments in area 1 precede and can't coalesce with segments in area 2.
944 // - Segments in Spills precede and can't coalesce with segments in area 2.
945 // - No coalescing is possible between segments in Spills and segments in area
946 //   1, and there are no overlapping segments.
947 //
948 // The segments in Spills are not ordered with respect to the segments in area
949 // 1. They need to be merged.
950 //
951 // When they exist, Spills.back().start <= LastStart,
952 //                 and WriteI[-1].start <= LastStart.
953 
954 void LiveRangeUpdater::print(raw_ostream &OS) const {
955   if (!isDirty()) {
956     if (LR)
957       OS << "Clean updater: " << *LR << '\n';
958     else
959       OS << "Null updater.\n";
960     return;
961   }
962   assert(LR && "Can't have null LR in dirty updater.");
963   OS << " updater with gap = " << (ReadI - WriteI)
964      << ", last start = " << LastStart
965      << ":\n  Area 1:";
966   for (const auto &S : make_range(LR->begin(), WriteI))
967     OS << ' ' << S;
968   OS << "\n  Spills:";
969   for (unsigned I = 0, E = Spills.size(); I != E; ++I)
970     OS << ' ' << Spills[I];
971   OS << "\n  Area 2:";
972   for (const auto &S : make_range(ReadI, LR->end()))
973     OS << ' ' << S;
974   OS << '\n';
975 }
976 
977 LLVM_DUMP_METHOD void LiveRangeUpdater::dump() const {
978   print(errs());
979 }
980 
981 // Determine if A and B should be coalesced.
982 static inline bool coalescable(const LiveRange::Segment &A,
983                                const LiveRange::Segment &B) {
984   assert(A.start <= B.start && "Unordered live segments.");
985   if (A.end == B.start)
986     return A.valno == B.valno;
987   if (A.end < B.start)
988     return false;
989   assert(A.valno == B.valno && "Cannot overlap different values");
990   return true;
991 }
992 
993 void LiveRangeUpdater::add(LiveRange::Segment Seg) {
994   assert(LR && "Cannot add to a null destination");
995 
996   // Fall back to the regular add method if the live range
997   // is using the segment set instead of the segment vector.
998   if (LR->segmentSet != nullptr) {
999     LR->addSegmentToSet(Seg);
1000     return;
1001   }
1002 
1003   // Flush the state if Start moves backwards.
1004   if (!LastStart.isValid() || LastStart > Seg.start) {
1005     if (isDirty())
1006       flush();
1007     // This brings us to an uninitialized state. Reinitialize.
1008     assert(Spills.empty() && "Leftover spilled segments");
1009     WriteI = ReadI = LR->begin();
1010   }
1011 
1012   // Remember start for next time.
1013   LastStart = Seg.start;
1014 
1015   // Advance ReadI until it ends after Seg.start.
1016   LiveRange::iterator E = LR->end();
1017   if (ReadI != E && ReadI->end <= Seg.start) {
1018     // First try to close the gap between WriteI and ReadI with spills.
1019     if (ReadI != WriteI)
1020       mergeSpills();
1021     // Then advance ReadI.
1022     if (ReadI == WriteI)
1023       ReadI = WriteI = LR->find(Seg.start);
1024     else
1025       while (ReadI != E && ReadI->end <= Seg.start)
1026         *WriteI++ = *ReadI++;
1027   }
1028 
1029   assert(ReadI == E || ReadI->end > Seg.start);
1030 
1031   // Check if the ReadI segment begins early.
1032   if (ReadI != E && ReadI->start <= Seg.start) {
1033     assert(ReadI->valno == Seg.valno && "Cannot overlap different values");
1034     // Bail if Seg is completely contained in ReadI.
1035     if (ReadI->end >= Seg.end)
1036       return;
1037     // Coalesce into Seg.
1038     Seg.start = ReadI->start;
1039     ++ReadI;
1040   }
1041 
1042   // Coalesce as much as possible from ReadI into Seg.
1043   while (ReadI != E && coalescable(Seg, *ReadI)) {
1044     Seg.end = std::max(Seg.end, ReadI->end);
1045     ++ReadI;
1046   }
1047 
1048   // Try coalescing Spills.back() into Seg.
1049   if (!Spills.empty() && coalescable(Spills.back(), Seg)) {
1050     Seg.start = Spills.back().start;
1051     Seg.end = std::max(Spills.back().end, Seg.end);
1052     Spills.pop_back();
1053   }
1054 
1055   // Try coalescing Seg into WriteI[-1].
1056   if (WriteI != LR->begin() && coalescable(WriteI[-1], Seg)) {
1057     WriteI[-1].end = std::max(WriteI[-1].end, Seg.end);
1058     return;
1059   }
1060 
1061   // Seg doesn't coalesce with anything, and needs to be inserted somewhere.
1062   if (WriteI != ReadI) {
1063     *WriteI++ = Seg;
1064     return;
1065   }
1066 
1067   // Finally, append to LR or Spills.
1068   if (WriteI == E) {
1069     LR->segments.push_back(Seg);
1070     WriteI = ReadI = LR->end();
1071   } else
1072     Spills.push_back(Seg);
1073 }
1074 
1075 // Merge as many spilled segments as possible into the gap between WriteI
1076 // and ReadI. Advance WriteI to reflect the inserted instructions.
1077 void LiveRangeUpdater::mergeSpills() {
1078   // Perform a backwards merge of Spills and [SpillI;WriteI).
1079   size_t GapSize = ReadI - WriteI;
1080   size_t NumMoved = std::min(Spills.size(), GapSize);
1081   LiveRange::iterator Src = WriteI;
1082   LiveRange::iterator Dst = Src + NumMoved;
1083   LiveRange::iterator SpillSrc = Spills.end();
1084   LiveRange::iterator B = LR->begin();
1085 
1086   // This is the new WriteI position after merging spills.
1087   WriteI = Dst;
1088 
1089   // Now merge Src and Spills backwards.
1090   while (Src != Dst) {
1091     if (Src != B && Src[-1].start > SpillSrc[-1].start)
1092       *--Dst = *--Src;
1093     else
1094       *--Dst = *--SpillSrc;
1095   }
1096   assert(NumMoved == size_t(Spills.end() - SpillSrc));
1097   Spills.erase(SpillSrc, Spills.end());
1098 }
1099 
1100 void LiveRangeUpdater::flush() {
1101   if (!isDirty())
1102     return;
1103   // Clear the dirty state.
1104   LastStart = SlotIndex();
1105 
1106   assert(LR && "Cannot add to a null destination");
1107 
1108   // Nothing to merge?
1109   if (Spills.empty()) {
1110     LR->segments.erase(WriteI, ReadI);
1111     LR->verify();
1112     return;
1113   }
1114 
1115   // Resize the WriteI - ReadI gap to match Spills.
1116   size_t GapSize = ReadI - WriteI;
1117   if (GapSize < Spills.size()) {
1118     // The gap is too small. Make some room.
1119     size_t WritePos = WriteI - LR->begin();
1120     LR->segments.insert(ReadI, Spills.size() - GapSize, LiveRange::Segment());
1121     // This also invalidated ReadI, but it is recomputed below.
1122     WriteI = LR->begin() + WritePos;
1123   } else {
1124     // Shrink the gap if necessary.
1125     LR->segments.erase(WriteI + Spills.size(), ReadI);
1126   }
1127   ReadI = WriteI + Spills.size();
1128   mergeSpills();
1129   LR->verify();
1130 }
1131 
1132 unsigned ConnectedVNInfoEqClasses::Classify(const LiveRange &LR) {
1133   // Create initial equivalence classes.
1134   EqClass.clear();
1135   EqClass.grow(LR.getNumValNums());
1136 
1137   const VNInfo *used = nullptr, *unused = nullptr;
1138 
1139   // Determine connections.
1140   for (const VNInfo *VNI : LR.valnos) {
1141     // Group all unused values into one class.
1142     if (VNI->isUnused()) {
1143       if (unused)
1144         EqClass.join(unused->id, VNI->id);
1145       unused = VNI;
1146       continue;
1147     }
1148     used = VNI;
1149     if (VNI->isPHIDef()) {
1150       const MachineBasicBlock *MBB = LIS.getMBBFromIndex(VNI->def);
1151       assert(MBB && "Phi-def has no defining MBB");
1152       // Connect to values live out of predecessors.
1153       for (MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(),
1154            PE = MBB->pred_end(); PI != PE; ++PI)
1155         if (const VNInfo *PVNI = LR.getVNInfoBefore(LIS.getMBBEndIdx(*PI)))
1156           EqClass.join(VNI->id, PVNI->id);
1157     } else {
1158       // Normal value defined by an instruction. Check for two-addr redef.
1159       // FIXME: This could be coincidental. Should we really check for a tied
1160       // operand constraint?
1161       // Note that VNI->def may be a use slot for an early clobber def.
1162       if (const VNInfo *UVNI = LR.getVNInfoBefore(VNI->def))
1163         EqClass.join(VNI->id, UVNI->id);
1164     }
1165   }
1166 
1167   // Lump all the unused values in with the last used value.
1168   if (used && unused)
1169     EqClass.join(used->id, unused->id);
1170 
1171   EqClass.compress();
1172   return EqClass.getNumClasses();
1173 }
1174 
1175 template<typename LiveRangeT, typename EqClassesT>
1176 static void DistributeRange(LiveRangeT &LR, LiveRangeT *SplitLRs[],
1177                             EqClassesT VNIClasses) {
1178   // Move segments to new intervals.
1179   LiveRange::iterator J = LR.begin(), E = LR.end();
1180   while (J != E && VNIClasses[J->valno->id] == 0)
1181     ++J;
1182   for (LiveRange::iterator I = J; I != E; ++I) {
1183     if (unsigned eq = VNIClasses[I->valno->id]) {
1184       assert((SplitLRs[eq-1]->empty() || SplitLRs[eq-1]->expiredAt(I->start)) &&
1185              "New intervals should be empty");
1186       SplitLRs[eq-1]->segments.push_back(*I);
1187     } else
1188       *J++ = *I;
1189   }
1190   LR.segments.erase(J, E);
1191 
1192   // Transfer VNInfos to their new owners and renumber them.
1193   unsigned j = 0, e = LR.getNumValNums();
1194   while (j != e && VNIClasses[j] == 0)
1195     ++j;
1196   for (unsigned i = j; i != e; ++i) {
1197     VNInfo *VNI = LR.getValNumInfo(i);
1198     if (unsigned eq = VNIClasses[i]) {
1199       VNI->id = SplitLRs[eq-1]->getNumValNums();
1200       SplitLRs[eq-1]->valnos.push_back(VNI);
1201     } else {
1202       VNI->id = j;
1203       LR.valnos[j++] = VNI;
1204     }
1205   }
1206   LR.valnos.resize(j);
1207 }
1208 
1209 void ConnectedVNInfoEqClasses::Distribute(LiveInterval &LI, LiveInterval *LIV[],
1210                                           MachineRegisterInfo &MRI) {
1211   // Rewrite instructions.
1212   for (MachineRegisterInfo::reg_iterator RI = MRI.reg_begin(LI.reg),
1213        RE = MRI.reg_end(); RI != RE;) {
1214     MachineOperand &MO = *RI;
1215     MachineInstr *MI = RI->getParent();
1216     ++RI;
1217     // DBG_VALUE instructions don't have slot indexes, so get the index of the
1218     // instruction before them.
1219     // Normally, DBG_VALUE instructions are removed before this function is
1220     // called, but it is not a requirement.
1221     SlotIndex Idx;
1222     if (MI->isDebugValue())
1223       Idx = LIS.getSlotIndexes()->getIndexBefore(*MI);
1224     else
1225       Idx = LIS.getInstructionIndex(*MI);
1226     LiveQueryResult LRQ = LI.Query(Idx);
1227     const VNInfo *VNI = MO.readsReg() ? LRQ.valueIn() : LRQ.valueDefined();
1228     // In the case of an <undef> use that isn't tied to any def, VNI will be
1229     // NULL. If the use is tied to a def, VNI will be the defined value.
1230     if (!VNI)
1231       continue;
1232     if (unsigned EqClass = getEqClass(VNI))
1233       MO.setReg(LIV[EqClass-1]->reg);
1234   }
1235 
1236   // Distribute subregister liveranges.
1237   if (LI.hasSubRanges()) {
1238     unsigned NumComponents = EqClass.getNumClasses();
1239     SmallVector<unsigned, 8> VNIMapping;
1240     SmallVector<LiveInterval::SubRange*, 8> SubRanges;
1241     BumpPtrAllocator &Allocator = LIS.getVNInfoAllocator();
1242     for (LiveInterval::SubRange &SR : LI.subranges()) {
1243       // Create new subranges in the split intervals and construct a mapping
1244       // for the VNInfos in the subrange.
1245       unsigned NumValNos = SR.valnos.size();
1246       VNIMapping.clear();
1247       VNIMapping.reserve(NumValNos);
1248       SubRanges.clear();
1249       SubRanges.resize(NumComponents-1, nullptr);
1250       for (unsigned I = 0; I < NumValNos; ++I) {
1251         const VNInfo &VNI = *SR.valnos[I];
1252         unsigned ComponentNum;
1253         if (VNI.isUnused()) {
1254           ComponentNum = 0;
1255         } else {
1256           const VNInfo *MainRangeVNI = LI.getVNInfoAt(VNI.def);
1257           assert(MainRangeVNI != nullptr
1258                  && "SubRange def must have corresponding main range def");
1259           ComponentNum = getEqClass(MainRangeVNI);
1260           if (ComponentNum > 0 && SubRanges[ComponentNum-1] == nullptr) {
1261             SubRanges[ComponentNum-1]
1262               = LIV[ComponentNum-1]->createSubRange(Allocator, SR.LaneMask);
1263           }
1264         }
1265         VNIMapping.push_back(ComponentNum);
1266       }
1267       DistributeRange(SR, SubRanges.data(), VNIMapping);
1268     }
1269     LI.removeEmptySubRanges();
1270   }
1271 
1272   // Distribute main liverange.
1273   DistributeRange(LI, LIV, EqClass);
1274 }
1275 
1276 void ConnectedSubRegClasses::renameComponents(LiveInterval &LI) const {
1277   // Shortcut: We cannot have split components with a single definition.
1278   if (LI.valnos.size() < 2)
1279     return;
1280 
1281   SmallVector<SubRangeInfo, 4> SubRangeInfos;
1282   IntEqClasses Classes;
1283   if (!findComponents(Classes, SubRangeInfos, LI))
1284     return;
1285 
1286   // Create a new VReg for each class.
1287   unsigned Reg = LI.reg;
1288   const TargetRegisterClass *RegClass = MRI.getRegClass(Reg);
1289   SmallVector<LiveInterval*, 4> Intervals;
1290   Intervals.push_back(&LI);
1291   for (unsigned I = 1, NumClasses = Classes.getNumClasses(); I < NumClasses;
1292        ++I) {
1293     unsigned NewVReg = MRI.createVirtualRegister(RegClass);
1294     LiveInterval &NewLI = LIS.createEmptyInterval(NewVReg);
1295     Intervals.push_back(&NewLI);
1296   }
1297 
1298   rewriteOperands(Classes, SubRangeInfos, Intervals);
1299   distribute(Classes, SubRangeInfos, Intervals);
1300   computeMainRangesFixFlags(Classes, SubRangeInfos, Intervals);
1301 }
1302 
1303 bool ConnectedSubRegClasses::findComponents(IntEqClasses &Classes,
1304     SmallVectorImpl<ConnectedSubRegClasses::SubRangeInfo> &SubRangeInfos,
1305     LiveInterval &LI) const {
1306   // First step: Create connected components for the VNInfos inside the
1307   // subranges and count the global number of such components.
1308   unsigned NumComponents = 0;
1309   for (LiveInterval::SubRange &SR : LI.subranges()) {
1310     SubRangeInfos.push_back(SubRangeInfo(LIS, SR, NumComponents));
1311     ConnectedVNInfoEqClasses &ConEQ = SubRangeInfos.back().ConEQ;
1312 
1313     unsigned NumSubComponents = ConEQ.Classify(SR);
1314     NumComponents += NumSubComponents;
1315   }
1316   // Shortcut: With only 1 subrange, the normal separate component tests are
1317   // enough and we do not need to perform the union-find on the subregister
1318   // segments.
1319   if (SubRangeInfos.size() < 2)
1320     return false;
1321 
1322   // Next step: Build union-find structure over all subranges and merge classes
1323   // across subranges when they are affected by the same MachineOperand.
1324   const TargetRegisterInfo &TRI = *MRI.getTargetRegisterInfo();
1325   Classes.grow(NumComponents);
1326   unsigned Reg = LI.reg;
1327   for (const MachineOperand &MO : MRI.reg_nodbg_operands(Reg)) {
1328     if (!MO.isDef() && !MO.readsReg())
1329       continue;
1330     unsigned SubRegIdx = MO.getSubReg();
1331     LaneBitmask LaneMask = TRI.getSubRegIndexLaneMask(SubRegIdx);
1332     unsigned MergedID = ~0u;
1333     for (ConnectedSubRegClasses::SubRangeInfo &SRInfo : SubRangeInfos) {
1334       const LiveInterval::SubRange &SR = *SRInfo.SR;
1335       if ((SR.LaneMask & LaneMask) == 0)
1336         continue;
1337       SlotIndex Pos = LIS.getInstructionIndex(*MO.getParent());
1338       Pos = MO.isDef() ? Pos.getRegSlot(MO.isEarlyClobber())
1339                        : Pos.getBaseIndex();
1340       const VNInfo *VNI = SR.getVNInfoAt(Pos);
1341       if (VNI == nullptr)
1342         continue;
1343 
1344       // Map to local representant ID.
1345       unsigned LocalID = SRInfo.ConEQ.getEqClass(VNI);
1346       // Global ID
1347       unsigned ID = LocalID + SRInfo.Index;
1348       // Merge other sets
1349       MergedID = MergedID == ~0u ? ID : Classes.join(MergedID, ID);
1350     }
1351   }
1352 
1353   // Early exit if we ended up with a single equivalence class.
1354   Classes.compress();
1355   unsigned NumClasses = Classes.getNumClasses();
1356   return NumClasses > 1;
1357 }
1358 
1359 void ConnectedSubRegClasses::rewriteOperands(const IntEqClasses &Classes,
1360     const SmallVectorImpl<SubRangeInfo> &SubRangeInfos,
1361     const SmallVectorImpl<LiveInterval*> &Intervals) const {
1362   const TargetRegisterInfo &TRI = *MRI.getTargetRegisterInfo();
1363   unsigned Reg = Intervals[0]->reg;;
1364   for (MachineRegisterInfo::reg_nodbg_iterator I = MRI.reg_nodbg_begin(Reg),
1365        E = MRI.reg_nodbg_end(); I != E; ) {
1366     MachineOperand &MO = *I++;
1367     if (!MO.isDef() && !MO.readsReg())
1368       continue;
1369 
1370     MachineInstr &MI = *MO.getParent();
1371 
1372     SlotIndex Pos = LIS.getInstructionIndex(MI);
1373     unsigned SubRegIdx = MO.getSubReg();
1374     LaneBitmask LaneMask = TRI.getSubRegIndexLaneMask(SubRegIdx);
1375 
1376     unsigned ID = ~0u;
1377     for (const SubRangeInfo &SRInfo : SubRangeInfos) {
1378       const LiveInterval::SubRange &SR = *SRInfo.SR;
1379       if ((SR.LaneMask & LaneMask) == 0)
1380         continue;
1381       LiveRange::const_iterator I = SR.find(Pos);
1382       if (I == SR.end())
1383         continue;
1384 
1385       const VNInfo &VNI = *I->valno;
1386       // Map to local representant ID.
1387       unsigned LocalID = SRInfo.ConEQ.getEqClass(&VNI);
1388       // Global ID
1389       ID = Classes[LocalID + SRInfo.Index];
1390       break;
1391     }
1392 
1393     unsigned VReg = Intervals[ID]->reg;
1394     MO.setReg(VReg);
1395   }
1396 }
1397 
1398 void ConnectedSubRegClasses::distribute(const IntEqClasses &Classes,
1399     const SmallVectorImpl<SubRangeInfo> &SubRangeInfos,
1400     const SmallVectorImpl<LiveInterval*> &Intervals) const {
1401   unsigned NumClasses = Classes.getNumClasses();
1402   SmallVector<unsigned, 8> VNIMapping;
1403   SmallVector<LiveInterval::SubRange*, 8> SubRanges;
1404   BumpPtrAllocator &Allocator = LIS.getVNInfoAllocator();
1405   for (const SubRangeInfo &SRInfo : SubRangeInfos) {
1406     LiveInterval::SubRange &SR = *SRInfo.SR;
1407     unsigned NumValNos = SR.valnos.size();
1408     VNIMapping.clear();
1409     VNIMapping.reserve(NumValNos);
1410     SubRanges.clear();
1411     SubRanges.resize(NumClasses-1, nullptr);
1412     for (unsigned I = 0; I < NumValNos; ++I) {
1413       const VNInfo &VNI = *SR.valnos[I];
1414       unsigned LocalID = SRInfo.ConEQ.getEqClass(&VNI);
1415       unsigned ID = Classes[LocalID + SRInfo.Index];
1416       VNIMapping.push_back(ID);
1417       if (ID > 0 && SubRanges[ID-1] == nullptr)
1418         SubRanges[ID-1] = Intervals[ID]->createSubRange(Allocator, SR.LaneMask);
1419     }
1420     DistributeRange(SR, SubRanges.data(), VNIMapping);
1421   }
1422 }
1423 
1424 static bool subRangeLiveAt(const LiveInterval &LI, SlotIndex Pos) {
1425   for (const LiveInterval::SubRange &SR : LI.subranges()) {
1426     if (SR.liveAt(Pos))
1427       return true;
1428   }
1429   return false;
1430 }
1431 
1432 void ConnectedSubRegClasses::computeMainRangesFixFlags(
1433     const IntEqClasses &Classes,
1434     const SmallVectorImpl<SubRangeInfo> &SubRangeInfos,
1435     const SmallVectorImpl<LiveInterval*> &Intervals) const {
1436   for (size_t I = 0, E = Intervals.size(); I < E; ++I) {
1437     LiveInterval &LI = *Intervals[I];
1438     LI.removeEmptySubRanges();
1439 
1440     for (MachineOperand &MO : MRI.reg_nodbg_operands(LI.reg)) {
1441       if (!MO.isDef())
1442         continue;
1443       unsigned SubRegIdx = MO.getSubReg();
1444       if (SubRegIdx == 0)
1445         continue;
1446       // After assigning the new vreg we may not have any other sublanes living
1447       // in and out of the instruction anymore. We need to add new dead and
1448       // undef flags in these cases.
1449       if (!MO.isUndef()) {
1450         SlotIndex Pos = LIS.getInstructionIndex(*MO.getParent());
1451         if (!subRangeLiveAt(LI, Pos))
1452           MO.setIsUndef();
1453       }
1454       if (!MO.isDead()) {
1455         SlotIndex Pos = LIS.getInstructionIndex(*MO.getParent()).getDeadSlot();
1456         if (!subRangeLiveAt(LI, Pos))
1457           MO.setIsDead();
1458       }
1459     }
1460 
1461     if (I == 0)
1462       LI.clear();
1463     LIS.constructMainRangeFromSubranges(LI);
1464   }
1465 }
1466