lib/CodeGen/LiveInterval.cpp

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