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