lib/CodeGen/LiveIntervalAnalysis.cpp

   1 //===-- LiveIntervalAnalysis.cpp - Live Interval Analysis -----------------===//
   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 LiveInterval analysis pass which is used
  11 // by the Linear Scan Register allocator. This pass linearizes the
  12 // basic blocks of the function in DFS order and uses the
  13 // LiveVariables pass to conservatively compute live intervals for
  14 // each virtual and physical register.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  19 #include "LiveRangeCalc.h"
  20 #include "llvm/ADT/DenseSet.h"
  21 #include "llvm/ADT/STLExtras.h"
  22 #include "llvm/Analysis/AliasAnalysis.h"
  23 #include "llvm/CodeGen/LiveVariables.h"
  24 #include "llvm/CodeGen/MachineBlockFrequencyInfo.h"
  25 #include "llvm/CodeGen/MachineDominators.h"
  26 #include "llvm/CodeGen/MachineInstr.h"
  27 #include "llvm/CodeGen/MachineRegisterInfo.h"
  28 #include "llvm/CodeGen/Passes.h"
  29 #include "llvm/CodeGen/VirtRegMap.h"
  30 #include "llvm/IR/Value.h"
  31 #include "llvm/Support/BlockFrequency.h"
  32 #include "llvm/Support/CommandLine.h"
  33 #include "llvm/Support/Debug.h"
  34 #include "llvm/Support/ErrorHandling.h"
  35 #include "llvm/Support/Format.h"
  36 #include "llvm/Support/raw_ostream.h"
  37 #include "llvm/Target/TargetInstrInfo.h"
  38 #include "llvm/Target/TargetRegisterInfo.h"
  39 #include "llvm/Target/TargetSubtargetInfo.h"
  40 #include <algorithm>
  41 #include <cmath>
  42 #include <limits>
  43 using namespace llvm;
  44
  45 #define DEBUG_TYPE "regalloc"
  46
  47 char LiveIntervals::ID = 0;
  48 char &llvm::LiveIntervalsID = LiveIntervals::ID;
  49 INITIALIZE_PASS_BEGIN(LiveIntervals, "liveintervals",
  50                 "Live Interval Analysis", false, false)
  51 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
  52 INITIALIZE_PASS_DEPENDENCY(LiveVariables)
  53 INITIALIZE_PASS_DEPENDENCY(MachineDominatorTree)
  54 INITIALIZE_PASS_DEPENDENCY(SlotIndexes)
  55 INITIALIZE_PASS_END(LiveIntervals, "liveintervals",
  56                 "Live Interval Analysis", false, false)
  57
  58 #ifndef NDEBUG
  59 static cl::opt<bool> EnablePrecomputePhysRegs(
  60   "precompute-phys-liveness", cl::Hidden,
  61   cl::desc("Eagerly compute live intervals for all physreg units."));
  62 #else
  63 static bool EnablePrecomputePhysRegs = false;
  64 #endif // NDEBUG
  65
  66 static cl::opt<bool> EnableSubRegLiveness(
  67   "enable-subreg-liveness", cl::Hidden, cl::init(true),
  68   cl::desc("Enable subregister liveness tracking."));
  69
  70 void LiveIntervals::getAnalysisUsage(AnalysisUsage &AU) const {
  71   AU.setPreservesCFG();
  72   AU.addRequired<AliasAnalysis>();
  73   AU.addPreserved<AliasAnalysis>();
  74   // LiveVariables isn't really required by this analysis, it is only required
  75   // here to make sure it is live during TwoAddressInstructionPass and
  76   // PHIElimination. This is temporary.
  77   AU.addRequired<LiveVariables>();
  78   AU.addPreserved<LiveVariables>();
  79   AU.addPreservedID(MachineLoopInfoID);
  80   AU.addRequiredTransitiveID(MachineDominatorsID);
  81   AU.addPreservedID(MachineDominatorsID);
  82   AU.addPreserved<SlotIndexes>();
  83   AU.addRequiredTransitive<SlotIndexes>();
  84   MachineFunctionPass::getAnalysisUsage(AU);
  85 }
  86
  87 LiveIntervals::LiveIntervals() : MachineFunctionPass(ID),
  88   DomTree(nullptr), LRCalc(nullptr) {
  89   initializeLiveIntervalsPass(*PassRegistry::getPassRegistry());
  90 }
  91
  92 LiveIntervals::~LiveIntervals() {
  93   delete LRCalc;
  94 }
  95
  96 void LiveIntervals::releaseMemory() {
  97   // Free the live intervals themselves.
  98   for (unsigned i = 0, e = VirtRegIntervals.size(); i != e; ++i)
  99     delete VirtRegIntervals[TargetRegisterInfo::index2VirtReg(i)];
 100   VirtRegIntervals.clear();
 101   RegMaskSlots.clear();
 102   RegMaskBits.clear();
 103   RegMaskBlocks.clear();
 104
 105   for (unsigned i = 0, e = RegUnitRanges.size(); i != e; ++i)
 106     delete RegUnitRanges[i];
 107   RegUnitRanges.clear();
 108
 109   // Release VNInfo memory regions, VNInfo objects don't need to be dtor'd.
 110   VNInfoAllocator.Reset();
 111 }
 112
 113 /// runOnMachineFunction - calculates LiveIntervals
 114 ///
 115 bool LiveIntervals::runOnMachineFunction(MachineFunction &fn) {
 116   MF = &fn;
 117   MRI = &MF->getRegInfo();
 118   TRI = MF->getSubtarget().getRegisterInfo();
 119   TII = MF->getSubtarget().getInstrInfo();
 120   AA = &getAnalysis<AliasAnalysis>();
 121   Indexes = &getAnalysis<SlotIndexes>();
 122   DomTree = &getAnalysis<MachineDominatorTree>();
 123
 124   if (EnableSubRegLiveness && MF->getSubtarget().enableSubRegLiveness())
 125     MRI->enableSubRegLiveness(true);
 126
 127   if (!LRCalc)
 128     LRCalc = new LiveRangeCalc();
 129
 130   // Allocate space for all virtual registers.
 131   VirtRegIntervals.resize(MRI->getNumVirtRegs());
 132
 133   computeVirtRegs();
 134   computeRegMasks();
 135   computeLiveInRegUnits();
 136
 137   if (EnablePrecomputePhysRegs) {
 138     // For stress testing, precompute live ranges of all physical register
 139     // units, including reserved registers.
 140     for (unsigned i = 0, e = TRI->getNumRegUnits(); i != e; ++i)
 141       getRegUnit(i);
 142   }
 143   DEBUG(dump());
 144   return true;
 145 }
 146
 147 /// print - Implement the dump method.
 148 void LiveIntervals::print(raw_ostream &OS, const Module* ) const {
 149   OS << "********** INTERVALS **********\n";
 150
 151   // Dump the regunits.
 152   for (unsigned i = 0, e = RegUnitRanges.size(); i != e; ++i)
 153     if (LiveRange *LR = RegUnitRanges[i])
 154       OS << PrintRegUnit(i, TRI) << ' ' << *LR << '\n';
 155
 156   // Dump the virtregs.
 157   for (unsigned i = 0, e = MRI->getNumVirtRegs(); i != e; ++i) {
 158     unsigned Reg = TargetRegisterInfo::index2VirtReg(i);
 159     if (hasInterval(Reg))
 160       OS << getInterval(Reg) << '\n';
 161   }
 162
 163   OS << "RegMasks:";
 164   for (unsigned i = 0, e = RegMaskSlots.size(); i != e; ++i)
 165     OS << ' ' << RegMaskSlots[i];
 166   OS << '\n';
 167
 168   printInstrs(OS);
 169 }
 170
 171 void LiveIntervals::printInstrs(raw_ostream &OS) const {
 172   OS << "********** MACHINEINSTRS **********\n";
 173   MF->print(OS, Indexes);
 174 }
 175
 176 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 177 void LiveIntervals::dumpInstrs() const {
 178   printInstrs(dbgs());
 179 }
 180 #endif
 181
 182 LiveInterval* LiveIntervals::createInterval(unsigned reg) {
 183   float Weight = TargetRegisterInfo::isPhysicalRegister(reg) ?
 184                   llvm::huge_valf : 0.0F;
 185   return new LiveInterval(reg, Weight);
 186 }
 187
 188
 189 /// computeVirtRegInterval - Compute the live interval of a virtual register,
 190 /// based on defs and uses.
 191 void LiveIntervals::computeVirtRegInterval(LiveInterval &LI) {
 192   assert(LRCalc && "LRCalc not initialized.");
 193   assert(LI.empty() && "Should only compute empty intervals.");
 194   LRCalc->reset(MF, getSlotIndexes(), DomTree, &getVNInfoAllocator());
 195   LRCalc->calculate(LI);
 196   computeDeadValues(LI, LI);
 197 }
 198
 199 void LiveIntervals::computeVirtRegs() {
 200   for (unsigned i = 0, e = MRI->getNumVirtRegs(); i != e; ++i) {
 201     unsigned Reg = TargetRegisterInfo::index2VirtReg(i);
 202     if (MRI->reg_nodbg_empty(Reg))
 203       continue;
 204     createAndComputeVirtRegInterval(Reg);
 205   }
 206 }
 207
 208 void LiveIntervals::computeRegMasks() {
 209   RegMaskBlocks.resize(MF->getNumBlockIDs());
 210
 211   // Find all instructions with regmask operands.
 212   for (MachineFunction::iterator MBBI = MF->begin(), E = MF->end();
 213        MBBI != E; ++MBBI) {
 214     MachineBasicBlock *MBB = MBBI;
 215     std::pair<unsigned, unsigned> &RMB = RegMaskBlocks[MBB->getNumber()];
 216     RMB.first = RegMaskSlots.size();
 217     for (MachineBasicBlock::iterator MI = MBB->begin(), ME = MBB->end();
 218          MI != ME; ++MI)
 219       for (MIOperands MO(MI); MO.isValid(); ++MO) {
 220         if (!MO->isRegMask())
 221           continue;
 222           RegMaskSlots.push_back(Indexes->getInstructionIndex(MI).getRegSlot());
 223           RegMaskBits.push_back(MO->getRegMask());
 224       }
 225     // Compute the number of register mask instructions in this block.
 226     RMB.second = RegMaskSlots.size() - RMB.first;
 227   }
 228 }
 229
 230 //===----------------------------------------------------------------------===//
 231 //                           Register Unit Liveness
 232 //===----------------------------------------------------------------------===//
 233 //
 234 // Fixed interference typically comes from ABI boundaries: Function arguments
 235 // and return values are passed in fixed registers, and so are exception
 236 // pointers entering landing pads. Certain instructions require values to be
 237 // present in specific registers. That is also represented through fixed
 238 // interference.
 239 //
 240
 241 /// computeRegUnitInterval - Compute the live range of a register unit, based
 242 /// on the uses and defs of aliasing registers.  The range should be empty,
 243 /// or contain only dead phi-defs from ABI blocks.
 244 void LiveIntervals::computeRegUnitRange(LiveRange &LR, unsigned Unit) {
 245   assert(LRCalc && "LRCalc not initialized.");
 246   LRCalc->reset(MF, getSlotIndexes(), DomTree, &getVNInfoAllocator());
 247
 248   // The physregs aliasing Unit are the roots and their super-registers.
 249   // Create all values as dead defs before extending to uses. Note that roots
 250   // may share super-registers. That's OK because createDeadDefs() is
 251   // idempotent. It is very rare for a register unit to have multiple roots, so
 252   // uniquing super-registers is probably not worthwhile.
 253   for (MCRegUnitRootIterator Roots(Unit, TRI); Roots.isValid(); ++Roots) {
 254     for (MCSuperRegIterator Supers(*Roots, TRI, /*IncludeSelf=*/true);
 255          Supers.isValid(); ++Supers) {
 256       if (!MRI->reg_empty(*Supers))
 257         LRCalc->createDeadDefs(LR, *Supers);
 258     }
 259   }
 260
 261   // Now extend LR to reach all uses.
 262   // Ignore uses of reserved registers. We only track defs of those.
 263   for (MCRegUnitRootIterator Roots(Unit, TRI); Roots.isValid(); ++Roots) {
 264     for (MCSuperRegIterator Supers(*Roots, TRI, /*IncludeSelf=*/true);
 265          Supers.isValid(); ++Supers) {
 266       unsigned Reg = *Supers;
 267       if (!MRI->isReserved(Reg) && !MRI->reg_empty(Reg))
 268         LRCalc->extendToUses(LR, Reg);
 269     }
 270   }
 271 }
 272
 273
 274 /// computeLiveInRegUnits - Precompute the live ranges of any register units
 275 /// that are live-in to an ABI block somewhere. Register values can appear
 276 /// without a corresponding def when entering the entry block or a landing pad.
 277 ///
 278 void LiveIntervals::computeLiveInRegUnits() {
 279   RegUnitRanges.resize(TRI->getNumRegUnits());
 280   DEBUG(dbgs() << "Computing live-in reg-units in ABI blocks.\n");
 281
 282   // Keep track of the live range sets allocated.
 283   SmallVector<unsigned, 8> NewRanges;
 284
 285   // Check all basic blocks for live-ins.
 286   for (MachineFunction::const_iterator MFI = MF->begin(), MFE = MF->end();
 287        MFI != MFE; ++MFI) {
 288     const MachineBasicBlock *MBB = MFI;
 289
 290     // We only care about ABI blocks: Entry + landing pads.
 291     if ((MFI != MF->begin() && !MBB->isLandingPad()) || MBB->livein_empty())
 292       continue;
 293
 294     // Create phi-defs at Begin for all live-in registers.
 295     SlotIndex Begin = Indexes->getMBBStartIdx(MBB);
 296     DEBUG(dbgs() << Begin << "\tBB#" << MBB->getNumber());
 297     for (MachineBasicBlock::livein_iterator LII = MBB->livein_begin(),
 298          LIE = MBB->livein_end(); LII != LIE; ++LII) {
 299       for (MCRegUnitIterator Units(*LII, TRI); Units.isValid(); ++Units) {
 300         unsigned Unit = *Units;
 301         LiveRange *LR = RegUnitRanges[Unit];
 302         if (!LR) {
 303           LR = RegUnitRanges[Unit] = new LiveRange();
 304           NewRanges.push_back(Unit);
 305         }
 306         VNInfo *VNI = LR->createDeadDef(Begin, getVNInfoAllocator());
 307         (void)VNI;
 308         DEBUG(dbgs() << ' ' << PrintRegUnit(Unit, TRI) << '#' << VNI->id);
 309       }
 310     }
 311     DEBUG(dbgs() << '\n');
 312   }
 313   DEBUG(dbgs() << "Created " << NewRanges.size() << " new intervals.\n");
 314
 315   // Compute the 'normal' part of the ranges.
 316   for (unsigned i = 0, e = NewRanges.size(); i != e; ++i) {
 317     unsigned Unit = NewRanges[i];
 318     computeRegUnitRange(*RegUnitRanges[Unit], Unit);
 319   }
 320 }
 321
 322
 323 static void createSegmentsForValues(LiveRange &LR,
 324       iterator_range<LiveInterval::vni_iterator> VNIs) {
 325   for (auto VNI : VNIs) {
 326     if (VNI->isUnused())
 327       continue;
 328     SlotIndex Def = VNI->def;
 329     LR.addSegment(LiveRange::Segment(Def, Def.getDeadSlot(), VNI));
 330   }
 331 }
 332
 333 typedef SmallVector<std::pair<SlotIndex, VNInfo*>, 16> ShrinkToUsesWorkList;
 334
 335 static void extendSegmentsToUses(LiveRange &LR, const SlotIndexes &Indexes,
 336                                  ShrinkToUsesWorkList &WorkList,
 337                                  const LiveRange &OldRange) {
 338   // Keep track of the PHIs that are in use.
 339   SmallPtrSet<VNInfo*, 8> UsedPHIs;
 340   // Blocks that have already been added to WorkList as live-out.
 341   SmallPtrSet<MachineBasicBlock*, 16> LiveOut;
 342
 343   // Extend intervals to reach all uses in WorkList.
 344   while (!WorkList.empty()) {
 345     SlotIndex Idx = WorkList.back().first;
 346     VNInfo *VNI = WorkList.back().second;
 347     WorkList.pop_back();
 348     const MachineBasicBlock *MBB = Indexes.getMBBFromIndex(Idx.getPrevSlot());
 349     SlotIndex BlockStart = Indexes.getMBBStartIdx(MBB);
 350
 351     // Extend the live range for VNI to be live at Idx.
 352     if (VNInfo *ExtVNI = LR.extendInBlock(BlockStart, Idx)) {
 353       assert(ExtVNI == VNI && "Unexpected existing value number");
 354       (void)ExtVNI;
 355       // Is this a PHIDef we haven't seen before?
 356       if (!VNI->isPHIDef() || VNI->def != BlockStart ||
 357           !UsedPHIs.insert(VNI).second)
 358         continue;
 359       // The PHI is live, make sure the predecessors are live-out.
 360       for (auto &Pred : MBB->predecessors()) {
 361         if (!LiveOut.insert(Pred).second)
 362           continue;
 363         SlotIndex Stop = Indexes.getMBBEndIdx(Pred);
 364         // A predecessor is not required to have a live-out value for a PHI.
 365         if (VNInfo *PVNI = OldRange.getVNInfoBefore(Stop))
 366           WorkList.push_back(std::make_pair(Stop, PVNI));
 367       }
 368       continue;
 369     }
 370
 371     // VNI is live-in to MBB.
 372     DEBUG(dbgs() << " live-in at " << BlockStart << '\n');
 373     LR.addSegment(LiveRange::Segment(BlockStart, Idx, VNI));
 374
 375     // Make sure VNI is live-out from the predecessors.
 376     for (auto &Pred : MBB->predecessors()) {
 377       if (!LiveOut.insert(Pred).second)
 378         continue;
 379       SlotIndex Stop = Indexes.getMBBEndIdx(Pred);
 380       assert(OldRange.getVNInfoBefore(Stop) == VNI &&
 381              "Wrong value out of predecessor");
 382       WorkList.push_back(std::make_pair(Stop, VNI));
 383     }
 384   }
 385 }
 386
 387 /// shrinkToUses - After removing some uses of a register, shrink its live
 388 /// range to just the remaining uses. This method does not compute reaching
 389 /// defs for new uses, and it doesn't remove dead defs.
 390 bool LiveIntervals::shrinkToUses(LiveInterval *li,
 391                                  SmallVectorImpl<MachineInstr*> *dead) {
 392   DEBUG(dbgs() << "Shrink: " << *li << '\n');
 393   assert(TargetRegisterInfo::isVirtualRegister(li->reg)
 394          && "Can only shrink virtual registers");
 395
 396   // Shrink subregister live ranges.
 397   for (LiveInterval::SubRange &S : li->subranges()) {
 398     shrinkToUses(S, li->reg);
 399   }
 400
 401   // Find all the values used, including PHI kills.
 402   ShrinkToUsesWorkList WorkList;
 403
 404   // Visit all instructions reading li->reg.
 405   for (MachineRegisterInfo::reg_instr_iterator
 406        I = MRI->reg_instr_begin(li->reg), E = MRI->reg_instr_end();
 407        I != E; ) {
 408     MachineInstr *UseMI = &*(I++);
 409     if (UseMI->isDebugValue() || !UseMI->readsVirtualRegister(li->reg))
 410       continue;
 411     SlotIndex Idx = getInstructionIndex(UseMI).getRegSlot();
 412     LiveQueryResult LRQ = li->Query(Idx);
 413     VNInfo *VNI = LRQ.valueIn();
 414     if (!VNI) {
 415       // This shouldn't happen: readsVirtualRegister returns true, but there is
 416       // no live value. It is likely caused by a target getting <undef> flags
 417       // wrong.
 418       DEBUG(dbgs() << Idx << '\t' << *UseMI
 419                    << "Warning: Instr claims to read non-existent value in "
 420                     << *li << '\n');
 421       continue;
 422     }
 423     // Special case: An early-clobber tied operand reads and writes the
 424     // register one slot early.
 425     if (VNInfo *DefVNI = LRQ.valueDefined())
 426       Idx = DefVNI->def;
 427
 428     WorkList.push_back(std::make_pair(Idx, VNI));
 429   }
 430
 431   // Create new live ranges with only minimal live segments per def.
 432   LiveRange NewLR;
 433   createSegmentsForValues(NewLR, make_range(li->vni_begin(), li->vni_end()));
 434   extendSegmentsToUses(NewLR, *Indexes, WorkList, *li);
 435
 436   // Handle dead values.
 437   bool CanSeparate;
 438   computeDeadValues(NewLR, *li, &CanSeparate, li->reg, dead);
 439
 440   // Move the trimmed segments back.
 441   li->segments.swap(NewLR.segments);
 442   DEBUG(dbgs() << "Shrunk: " << *li << '\n');
 443   return CanSeparate;
 444 }
 445
 446 void LiveIntervals::computeDeadValues(LiveRange &Segments, LiveRange &LR,
 447                                       bool *CanSeparateRes, unsigned Reg,
 448                                       SmallVectorImpl<MachineInstr*> *dead) {
 449   bool CanSeparate = false;
 450   for (auto VNI : LR.valnos) {
 451     if (VNI->isUnused())
 452       continue;
 453     LiveRange::iterator LRI = Segments.FindSegmentContaining(VNI->def);
 454     assert(LRI != Segments.end() && "Missing segment for PHI");
 455     if (LRI->end != VNI->def.getDeadSlot())
 456       continue;
 457     if (VNI->isPHIDef()) {
 458       // This is a dead PHI. Remove it.
 459       VNI->markUnused();
 460       Segments.removeSegment(LRI->start, LRI->end);
 461       DEBUG(dbgs() << "Dead PHI at " << VNI->def << " may separate interval\n");
 462       CanSeparate = true;
 463     } else if (dead != nullptr) {
 464       // This is a dead def. Make sure the instruction knows.
 465       MachineInstr *MI = getInstructionFromIndex(VNI->def);
 466       assert(MI && "No instruction defining live value");
 467       MI->addRegisterDead(Reg, TRI);
 468       if (dead && MI->allDefsAreDead()) {
 469         DEBUG(dbgs() << "All defs dead: " << VNI->def << '\t' << *MI);
 470         dead->push_back(MI);
 471       }
 472     }
 473   }
 474   if (CanSeparateRes != nullptr)
 475     *CanSeparateRes = CanSeparate;
 476 }
 477
 478 bool LiveIntervals::shrinkToUses(LiveInterval::SubRange &SR, unsigned Reg)
 479 {
 480   DEBUG(dbgs() << "Shrink: " << SR << '\n');
 481   assert(TargetRegisterInfo::isVirtualRegister(Reg)
 482          && "Can only shrink virtual registers");
 483   // Find all the values used, including PHI kills.
 484   ShrinkToUsesWorkList WorkList;
 485
 486   // Visit all instructions reading Reg.
 487   SlotIndex LastIdx;
 488   for (MachineOperand &MO : MRI->reg_operands(Reg)) {
 489     MachineInstr *UseMI = MO.getParent();
 490     if (UseMI->isDebugValue())
 491       continue;
 492     // Maybe the operand is for a subregister we don't care about.
 493     unsigned SubReg = MO.getSubReg();
 494     if (SubReg != 0) {
 495       unsigned SubRegMask = TRI->getSubRegIndexLaneMask(SubReg);
 496       if ((SubRegMask & SR.LaneMask) == 0)
 497         continue;
 498     }
 499     // We only need to visit each instruction once.
 500     SlotIndex Idx = getInstructionIndex(UseMI).getRegSlot();
 501     if (Idx == LastIdx)
 502       continue;
 503     LastIdx = Idx;
 504
 505     LiveQueryResult LRQ = SR.Query(Idx);
 506     VNInfo *VNI = LRQ.valueIn();
 507     // For Subranges it is possible that only undef values are left in that
 508     // part of the subregister, so there is no real liverange at the use
 509     if (!VNI)
 510       continue;
 511
 512     // Special case: An early-clobber tied operand reads and writes the
 513     // register one slot early.
 514     if (VNInfo *DefVNI = LRQ.valueDefined())
 515       Idx = DefVNI->def;
 516
 517     WorkList.push_back(std::make_pair(Idx, VNI));
 518   }
 519
 520   // Create a new live ranges with only minimal live segments per def.
 521   LiveRange NewLR;
 522   createSegmentsForValues(NewLR, make_range(SR.vni_begin(), SR.vni_end()));
 523   extendSegmentsToUses(NewLR, *Indexes, WorkList, SR);
 524
 525   // Handle dead values.
 526   bool CanSeparate;
 527   computeDeadValues(NewLR, SR, &CanSeparate);
 528
 529   // Move the trimmed ranges back.
 530   SR.segments.swap(NewLR.segments);
 531   DEBUG(dbgs() << "Shrunk: " << SR << '\n');
 532   return CanSeparate;
 533 }
 534
 535 void LiveIntervals::extendToIndices(LiveRange &LR,
 536                                     ArrayRef<SlotIndex> Indices) {
 537   assert(LRCalc && "LRCalc not initialized.");
 538   LRCalc->reset(MF, getSlotIndexes(), DomTree, &getVNInfoAllocator());
 539   for (unsigned i = 0, e = Indices.size(); i != e; ++i)
 540     LRCalc->extend(LR, Indices[i]);
 541 }
 542
 543 void LiveIntervals::pruneValue(LiveRange &LR, SlotIndex Kill,
 544                                SmallVectorImpl<SlotIndex> *EndPoints) {
 545   LiveQueryResult LRQ = LR.Query(Kill);
 546   VNInfo *VNI = LRQ.valueOutOrDead();
 547   if (!VNI)
 548     return;
 549
 550   MachineBasicBlock *KillMBB = Indexes->getMBBFromIndex(Kill);
 551   SlotIndex MBBEnd = Indexes->getMBBEndIdx(KillMBB);
 552
 553   // If VNI isn't live out from KillMBB, the value is trivially pruned.
 554   if (LRQ.endPoint() < MBBEnd) {
 555     LR.removeSegment(Kill, LRQ.endPoint());
 556     if (EndPoints) EndPoints->push_back(LRQ.endPoint());
 557     return;
 558   }
 559
 560   // VNI is live out of KillMBB.
 561   LR.removeSegment(Kill, MBBEnd);
 562   if (EndPoints) EndPoints->push_back(MBBEnd);
 563
 564   // Find all blocks that are reachable from KillMBB without leaving VNI's live
 565   // range. It is possible that KillMBB itself is reachable, so start a DFS
 566   // from each successor.
 567   typedef SmallPtrSet<MachineBasicBlock*, 9> VisitedTy;
 568   VisitedTy Visited;
 569   for (MachineBasicBlock::succ_iterator
 570        SuccI = KillMBB->succ_begin(), SuccE = KillMBB->succ_end();
 571        SuccI != SuccE; ++SuccI) {
 572     for (df_ext_iterator<MachineBasicBlock*, VisitedTy>
 573          I = df_ext_begin(*SuccI, Visited), E = df_ext_end(*SuccI, Visited);
 574          I != E;) {
 575       MachineBasicBlock *MBB = *I;
 576
 577       // Check if VNI is live in to MBB.
 578       SlotIndex MBBStart, MBBEnd;
 579       std::tie(MBBStart, MBBEnd) = Indexes->getMBBRange(MBB);
 580       LiveQueryResult LRQ = LR.Query(MBBStart);
 581       if (LRQ.valueIn() != VNI) {
 582         // This block isn't part of the VNI segment. Prune the search.
 583         I.skipChildren();
 584         continue;
 585       }
 586
 587       // Prune the search if VNI is killed in MBB.
 588       if (LRQ.endPoint() < MBBEnd) {
 589         LR.removeSegment(MBBStart, LRQ.endPoint());
 590         if (EndPoints) EndPoints->push_back(LRQ.endPoint());
 591         I.skipChildren();
 592         continue;
 593       }
 594
 595       // VNI is live through MBB.
 596       LR.removeSegment(MBBStart, MBBEnd);
 597       if (EndPoints) EndPoints->push_back(MBBEnd);
 598       ++I;
 599     }
 600   }
 601 }
 602
 603 void LiveIntervals::pruneValue(LiveInterval &LI, SlotIndex Kill,
 604                                SmallVectorImpl<SlotIndex> *EndPoints) {
 605   pruneValue((LiveRange&)LI, Kill, EndPoints);
 606
 607   for (LiveInterval::SubRange &SR : LI.subranges()) {
 608     pruneValue(SR, Kill, nullptr);
 609   }
 610 }
 611
 612 //===----------------------------------------------------------------------===//
 613 // Register allocator hooks.
 614 //
 615
 616 void LiveIntervals::addKillFlags(const VirtRegMap *VRM) {
 617   // Keep track of regunit ranges.
 618   SmallVector<std::pair<LiveRange*, LiveRange::iterator>, 8> RU;
 619
 620   for (unsigned i = 0, e = MRI->getNumVirtRegs(); i != e; ++i) {
 621     unsigned Reg = TargetRegisterInfo::index2VirtReg(i);
 622     if (MRI->reg_nodbg_empty(Reg))
 623       continue;
 624     LiveInterval *LI = &getInterval(Reg);
 625     if (LI->empty())
 626       continue;
 627
 628     // Find the regunit intervals for the assigned register. They may overlap
 629     // the virtual register live range, cancelling any kills.
 630     RU.clear();
 631     for (MCRegUnitIterator Units(VRM->getPhys(Reg), TRI); Units.isValid();
 632          ++Units) {
 633       LiveRange &RURanges = getRegUnit(*Units);
 634       if (RURanges.empty())
 635         continue;
 636       RU.push_back(std::make_pair(&RURanges, RURanges.find(LI->begin()->end)));
 637     }
 638
 639     // Every instruction that kills Reg corresponds to a segment range end
 640     // point.
 641     for (LiveInterval::iterator RI = LI->begin(), RE = LI->end(); RI != RE;
 642          ++RI) {
 643       // A block index indicates an MBB edge.
 644       if (RI->end.isBlock())
 645         continue;
 646       MachineInstr *MI = getInstructionFromIndex(RI->end);
 647       if (!MI)
 648         continue;
 649
 650       // Check if any of the regunits are live beyond the end of RI. That could
 651       // happen when a physreg is defined as a copy of a virtreg:
 652       //
 653       //   %EAX = COPY %vreg5
 654       //   FOO %vreg5         <--- MI, cancel kill because %EAX is live.
 655       //   BAR %EAX<kill>
 656       //
 657       // There should be no kill flag on FOO when %vreg5 is rewritten as %EAX.
 658       bool CancelKill = false;
 659       for (unsigned u = 0, e = RU.size(); u != e; ++u) {
 660         LiveRange &RRanges = *RU[u].first;
 661         LiveRange::iterator &I = RU[u].second;
 662         if (I == RRanges.end())
 663           continue;
 664         I = RRanges.advanceTo(I, RI->end);
 665         if (I == RRanges.end() || I->start >= RI->end)
 666           continue;
 667         // I is overlapping RI.
 668         CancelKill = true;
 669         break;
 670       }
 671
 672       // If an instruction writes to a subregister, a new segment starts in the
 673       // LiveInterval. In this case adding Kill-Flags is incorrect if no
 674       // super registers defs/uses are appended to the instruction which is
 675       // what we do when subregister liveness tracking is enabled.
 676       if (MRI->tracksSubRegLiveness()) {
 677         // Next segment has to be adjacent in the subregister write case.
 678         LiveRange::iterator N = std::next(RI);
 679         if (N != LI->end() && N->start == RI->end) {
 680           // See if we have a partial write operand
 681           bool IsFullWrite = false;
 682           for (MachineInstr::const_mop_iterator MOp = MI->operands_begin(),
 683                MOpE = MI->operands_end(); MOp != MOpE; ++MOp) {
 684             if (MOp->isReg() && !MOp->isDef() && MOp->getReg() == Reg
 685                 && MOp->getSubReg() == 0) {
 686               IsFullWrite = true;
 687               break;
 688             }
 689           }
 690           if (!IsFullWrite)
 691             CancelKill = true;
 692         }
 693       }
 694
 695       if (CancelKill)
 696         MI->clearRegisterKills(Reg, nullptr);
 697       else
 698         MI->addRegisterKilled(Reg, nullptr);
 699     }
 700   }
 701 }
 702
 703 MachineBasicBlock*
 704 LiveIntervals::intervalIsInOneMBB(const LiveInterval &LI) const {
 705   // A local live range must be fully contained inside the block, meaning it is
 706   // defined and killed at instructions, not at block boundaries. It is not
 707   // live in or or out of any block.
 708   //
 709   // It is technically possible to have a PHI-defined live range identical to a
 710   // single block, but we are going to return false in that case.
 711
 712   SlotIndex Start = LI.beginIndex();
 713   if (Start.isBlock())
 714     return nullptr;
 715
 716   SlotIndex Stop = LI.endIndex();
 717   if (Stop.isBlock())
 718     return nullptr;
 719
 720   // getMBBFromIndex doesn't need to search the MBB table when both indexes
 721   // belong to proper instructions.
 722   MachineBasicBlock *MBB1 = Indexes->getMBBFromIndex(Start);
 723   MachineBasicBlock *MBB2 = Indexes->getMBBFromIndex(Stop);
 724   return MBB1 == MBB2 ? MBB1 : nullptr;
 725 }
 726
 727 bool
 728 LiveIntervals::hasPHIKill(const LiveInterval &LI, const VNInfo *VNI) const {
 729   for (const VNInfo *PHI : LI.valnos) {
 730     if (PHI->isUnused() || !PHI->isPHIDef())
 731       continue;
 732     const MachineBasicBlock *PHIMBB = getMBBFromIndex(PHI->def);
 733     // Conservatively return true instead of scanning huge predecessor lists.
 734     if (PHIMBB->pred_size() > 100)
 735       return true;
 736     for (MachineBasicBlock::const_pred_iterator
 737          PI = PHIMBB->pred_begin(), PE = PHIMBB->pred_end(); PI != PE; ++PI)
 738       if (VNI == LI.getVNInfoBefore(Indexes->getMBBEndIdx(*PI)))
 739         return true;
 740   }
 741   return false;
 742 }
 743
 744 float
 745 LiveIntervals::getSpillWeight(bool isDef, bool isUse,
 746                               const MachineBlockFrequencyInfo *MBFI,
 747                               const MachineInstr *MI) {
 748   BlockFrequency Freq = MBFI->getBlockFreq(MI->getParent());
 749   const float Scale = 1.0f / MBFI->getEntryFreq();
 750   return (isDef + isUse) * (Freq.getFrequency() * Scale);
 751 }
 752
 753 LiveRange::Segment
 754 LiveIntervals::addSegmentToEndOfBlock(unsigned reg, MachineInstr* startInst) {
 755   LiveInterval& Interval = createEmptyInterval(reg);
 756   VNInfo* VN = Interval.getNextValue(
 757     SlotIndex(getInstructionIndex(startInst).getRegSlot()),
 758     getVNInfoAllocator());
 759   LiveRange::Segment S(
 760      SlotIndex(getInstructionIndex(startInst).getRegSlot()),
 761      getMBBEndIdx(startInst->getParent()), VN);
 762   Interval.addSegment(S);
 763
 764   return S;
 765 }
 766
 767
 768 //===----------------------------------------------------------------------===//
 769 //                          Register mask functions
 770 //===----------------------------------------------------------------------===//
 771
 772 bool LiveIntervals::checkRegMaskInterference(LiveInterval &LI,
 773                                              BitVector &UsableRegs) {
 774   if (LI.empty())
 775     return false;
 776   LiveInterval::iterator LiveI = LI.begin(), LiveE = LI.end();
 777
 778   // Use a smaller arrays for local live ranges.
 779   ArrayRef<SlotIndex> Slots;
 780   ArrayRef<const uint32_t*> Bits;
 781   if (MachineBasicBlock *MBB = intervalIsInOneMBB(LI)) {
 782     Slots = getRegMaskSlotsInBlock(MBB->getNumber());
 783     Bits = getRegMaskBitsInBlock(MBB->getNumber());
 784   } else {
 785     Slots = getRegMaskSlots();
 786     Bits = getRegMaskBits();
 787   }
 788
 789   // We are going to enumerate all the register mask slots contained in LI.
 790   // Start with a binary search of RegMaskSlots to find a starting point.
 791   ArrayRef<SlotIndex>::iterator SlotI =
 792     std::lower_bound(Slots.begin(), Slots.end(), LiveI->start);
 793   ArrayRef<SlotIndex>::iterator SlotE = Slots.end();
 794
 795   // No slots in range, LI begins after the last call.
 796   if (SlotI == SlotE)
 797     return false;
 798
 799   bool Found = false;
 800   for (;;) {
 801     assert(*SlotI >= LiveI->start);
 802     // Loop over all slots overlapping this segment.
 803     while (*SlotI < LiveI->end) {
 804       // *SlotI overlaps LI. Collect mask bits.
 805       if (!Found) {
 806         // This is the first overlap. Initialize UsableRegs to all ones.
 807         UsableRegs.clear();
 808         UsableRegs.resize(TRI->getNumRegs(), true);
 809         Found = true;
 810       }
 811       // Remove usable registers clobbered by this mask.
 812       UsableRegs.clearBitsNotInMask(Bits[SlotI-Slots.begin()]);
 813       if (++SlotI == SlotE)
 814         return Found;
 815     }
 816     // *SlotI is beyond the current LI segment.
 817     LiveI = LI.advanceTo(LiveI, *SlotI);
 818     if (LiveI == LiveE)
 819       return Found;
 820     // Advance SlotI until it overlaps.
 821     while (*SlotI < LiveI->start)
 822       if (++SlotI == SlotE)
 823         return Found;
 824   }
 825 }
 826
 827 //===----------------------------------------------------------------------===//
 828 //                         IntervalUpdate class.
 829 //===----------------------------------------------------------------------===//
 830
 831 // HMEditor is a toolkit used by handleMove to trim or extend live intervals.
 832 class LiveIntervals::HMEditor {
 833 private:
 834   LiveIntervals& LIS;
 835   const MachineRegisterInfo& MRI;
 836   const TargetRegisterInfo& TRI;
 837   SlotIndex OldIdx;
 838   SlotIndex NewIdx;
 839   SmallPtrSet<LiveRange*, 8> Updated;
 840   bool UpdateFlags;
 841
 842 public:
 843   HMEditor(LiveIntervals& LIS, const MachineRegisterInfo& MRI,
 844            const TargetRegisterInfo& TRI,
 845            SlotIndex OldIdx, SlotIndex NewIdx, bool UpdateFlags)
 846     : LIS(LIS), MRI(MRI), TRI(TRI), OldIdx(OldIdx), NewIdx(NewIdx),
 847       UpdateFlags(UpdateFlags) {}
 848
 849   // FIXME: UpdateFlags is a workaround that creates live intervals for all
 850   // physregs, even those that aren't needed for regalloc, in order to update
 851   // kill flags. This is wasteful. Eventually, LiveVariables will strip all kill
 852   // flags, and postRA passes will use a live register utility instead.
 853   LiveRange *getRegUnitLI(unsigned Unit) {
 854     if (UpdateFlags)
 855       return &LIS.getRegUnit(Unit);
 856     return LIS.getCachedRegUnit(Unit);
 857   }
 858
 859   /// Update all live ranges touched by MI, assuming a move from OldIdx to
 860   /// NewIdx.
 861   void updateAllRanges(MachineInstr *MI) {
 862     DEBUG(dbgs() << "handleMove " << OldIdx << " -> " << NewIdx << ": " << *MI);
 863     bool hasRegMask = false;
 864     for (MIOperands MO(MI); MO.isValid(); ++MO) {
 865       if (MO->isRegMask())
 866         hasRegMask = true;
 867       if (!MO->isReg())
 868         continue;
 869       // Aggressively clear all kill flags.
 870       // They are reinserted by VirtRegRewriter.
 871       if (MO->isUse())
 872         MO->setIsKill(false);
 873
 874       unsigned Reg = MO->getReg();
 875       if (!Reg)
 876         continue;
 877       if (TargetRegisterInfo::isVirtualRegister(Reg)) {
 878         LiveInterval &LI = LIS.getInterval(Reg);
 879         if (LI.hasSubRanges()) {
 880           unsigned SubReg = MO->getSubReg();
 881           unsigned LaneMask = TRI.getSubRegIndexLaneMask(SubReg);
 882           for (LiveInterval::SubRange &S : LI.subranges()) {
 883             if ((S.LaneMask & LaneMask) == 0)
 884               continue;
 885             updateRange(S, Reg, S.LaneMask);
 886           }
 887         }
 888         updateRange(LI, Reg, 0);
 889         continue;
 890       }
 891
 892       // For physregs, only update the regunits that actually have a
 893       // precomputed live range.
 894       for (MCRegUnitIterator Units(Reg, &TRI); Units.isValid(); ++Units)
 895         if (LiveRange *LR = getRegUnitLI(*Units))
 896           updateRange(*LR, *Units, 0);
 897     }
 898     if (hasRegMask)
 899       updateRegMaskSlots();
 900   }
 901
 902 private:
 903   /// Update a single live range, assuming an instruction has been moved from
 904   /// OldIdx to NewIdx.
 905   void updateRange(LiveRange &LR, unsigned Reg, unsigned LaneMask) {
 906     if (!Updated.insert(&LR).second)
 907       return;
 908     DEBUG({
 909       dbgs() << "     ";
 910       if (TargetRegisterInfo::isVirtualRegister(Reg)) {
 911         dbgs() << PrintReg(Reg);
 912         if (LaneMask != 0)
 913           dbgs() << format(" L%04X", LaneMask);
 914       } else {
 915         dbgs() << PrintRegUnit(Reg, &TRI);
 916       }
 917       dbgs() << ":\t" << LR << '\n';
 918     });
 919     if (SlotIndex::isEarlierInstr(OldIdx, NewIdx))
 920       handleMoveDown(LR);
 921     else
 922       handleMoveUp(LR, Reg, LaneMask);
 923     DEBUG(dbgs() << "        -->\t" << LR << '\n');
 924     LR.verify();
 925   }
 926
 927   /// Update LR to reflect an instruction has been moved downwards from OldIdx
 928   /// to NewIdx.
 929   ///
 930   /// 1. Live def at OldIdx:
 931   ///    Move def to NewIdx, assert endpoint after NewIdx.
 932   ///
 933   /// 2. Live def at OldIdx, killed at NewIdx:
 934   ///    Change to dead def at NewIdx.
 935   ///    (Happens when bundling def+kill together).
 936   ///
 937   /// 3. Dead def at OldIdx:
 938   ///    Move def to NewIdx, possibly across another live value.
 939   ///
 940   /// 4. Def at OldIdx AND at NewIdx:
 941   ///    Remove segment [OldIdx;NewIdx) and value defined at OldIdx.
 942   ///    (Happens when bundling multiple defs together).
 943   ///
 944   /// 5. Value read at OldIdx, killed before NewIdx:
 945   ///    Extend kill to NewIdx.
 946   ///
 947   void handleMoveDown(LiveRange &LR) {
 948     // First look for a kill at OldIdx.
 949     LiveRange::iterator I = LR.find(OldIdx.getBaseIndex());
 950     LiveRange::iterator E = LR.end();
 951     // Is LR even live at OldIdx?
 952     if (I == E || SlotIndex::isEarlierInstr(OldIdx, I->start))
 953       return;
 954
 955     // Handle a live-in value.
 956     if (!SlotIndex::isSameInstr(I->start, OldIdx)) {
 957       bool isKill = SlotIndex::isSameInstr(OldIdx, I->end);
 958       // If the live-in value already extends to NewIdx, there is nothing to do.
 959       if (!SlotIndex::isEarlierInstr(I->end, NewIdx))
 960         return;
 961       // Aggressively remove all kill flags from the old kill point.
 962       // Kill flags shouldn't be used while live intervals exist, they will be
 963       // reinserted by VirtRegRewriter.
 964       if (MachineInstr *KillMI = LIS.getInstructionFromIndex(I->end))
 965         for (MIBundleOperands MO(KillMI); MO.isValid(); ++MO)
 966           if (MO->isReg() && MO->isUse())
 967             MO->setIsKill(false);
 968       // Adjust I->end to reach NewIdx. This may temporarily make LR invalid by
 969       // overlapping ranges. Case 5 above.
 970       I->end = NewIdx.getRegSlot(I->end.isEarlyClobber());
 971       // If this was a kill, there may also be a def. Otherwise we're done.
 972       if (!isKill)
 973         return;
 974       ++I;
 975     }
 976
 977     // Check for a def at OldIdx.
 978     if (I == E || !SlotIndex::isSameInstr(OldIdx, I->start))
 979       return;
 980     // We have a def at OldIdx.
 981     VNInfo *DefVNI = I->valno;
 982     assert(DefVNI->def == I->start && "Inconsistent def");
 983     DefVNI->def = NewIdx.getRegSlot(I->start.isEarlyClobber());
 984     // If the defined value extends beyond NewIdx, just move the def down.
 985     // This is case 1 above.
 986     if (SlotIndex::isEarlierInstr(NewIdx, I->end)) {
 987       I->start = DefVNI->def;
 988       return;
 989     }
 990     // The remaining possibilities are now:
 991     // 2. Live def at OldIdx, killed at NewIdx: isSameInstr(I->end, NewIdx).
 992     // 3. Dead def at OldIdx: I->end = OldIdx.getDeadSlot().
 993     // In either case, it is possible that there is an existing def at NewIdx.
 994     assert((I->end == OldIdx.getDeadSlot() ||
 995             SlotIndex::isSameInstr(I->end, NewIdx)) &&
 996             "Cannot move def below kill");
 997     LiveRange::iterator NewI = LR.advanceTo(I, NewIdx.getRegSlot());
 998     if (NewI != E && SlotIndex::isSameInstr(NewI->start, NewIdx)) {
 999       // There is an existing def at NewIdx, case 4 above. The def at OldIdx is
1000       // coalesced into that value.
1001       assert(NewI->valno != DefVNI && "Multiple defs of value?");
1002       LR.removeValNo(DefVNI);
1003       return;
1004     }
1005     // There was no existing def at NewIdx. Turn *I into a dead def at NewIdx.
1006     // If the def at OldIdx was dead, we allow it to be moved across other LR
1007     // values. The new range should be placed immediately before NewI, move any
1008     // intermediate ranges up.
1009     assert(NewI != I && "Inconsistent iterators");
1010     std::copy(std::next(I), NewI, I);
1011     *std::prev(NewI)
1012       = LiveRange::Segment(DefVNI->def, NewIdx.getDeadSlot(), DefVNI);
1013   }
1014
1015   /// Update LR to reflect an instruction has been moved upwards from OldIdx
1016   /// to NewIdx.
1017   ///
1018   /// 1. Live def at OldIdx:
1019   ///    Hoist def to NewIdx.
1020   ///
1021   /// 2. Dead def at OldIdx:
1022   ///    Hoist def+end to NewIdx, possibly move across other values.
1023   ///
1024   /// 3. Dead def at OldIdx AND existing def at NewIdx:
1025   ///    Remove value defined at OldIdx, coalescing it with existing value.
1026   ///
1027   /// 4. Live def at OldIdx AND existing def at NewIdx:
1028   ///    Remove value defined at NewIdx, hoist OldIdx def to NewIdx.
1029   ///    (Happens when bundling multiple defs together).
1030   ///
1031   /// 5. Value killed at OldIdx:
1032   ///    Hoist kill to NewIdx, then scan for last kill between NewIdx and
1033   ///    OldIdx.
1034   ///
1035   void handleMoveUp(LiveRange &LR, unsigned Reg, unsigned LaneMask) {
1036     // First look for a kill at OldIdx.
1037     LiveRange::iterator I = LR.find(OldIdx.getBaseIndex());
1038     LiveRange::iterator E = LR.end();
1039     // Is LR even live at OldIdx?
1040     if (I == E || SlotIndex::isEarlierInstr(OldIdx, I->start))
1041       return;
1042
1043     // Handle a live-in value.
1044     if (!SlotIndex::isSameInstr(I->start, OldIdx)) {
1045       // If the live-in value isn't killed here, there is nothing to do.
1046       if (!SlotIndex::isSameInstr(OldIdx, I->end))
1047         return;
1048       // Adjust I->end to end at NewIdx. If we are hoisting a kill above
1049       // another use, we need to search for that use. Case 5 above.
1050       I->end = NewIdx.getRegSlot(I->end.isEarlyClobber());
1051       ++I;
1052       // If OldIdx also defines a value, there couldn't have been another use.
1053       if (I == E || !SlotIndex::isSameInstr(I->start, OldIdx)) {
1054         // No def, search for the new kill.
1055         // This can never be an early clobber kill since there is no def.
1056         std::prev(I)->end = findLastUseBefore(Reg, LaneMask).getRegSlot();
1057         return;
1058       }
1059     }
1060
1061     // Now deal with the def at OldIdx.
1062     assert(I != E && SlotIndex::isSameInstr(I->start, OldIdx) && "No def?");
1063     VNInfo *DefVNI = I->valno;
1064     assert(DefVNI->def == I->start && "Inconsistent def");
1065     DefVNI->def = NewIdx.getRegSlot(I->start.isEarlyClobber());
1066
1067     // Check for an existing def at NewIdx.
1068     LiveRange::iterator NewI = LR.find(NewIdx.getRegSlot());
1069     if (SlotIndex::isSameInstr(NewI->start, NewIdx)) {
1070       assert(NewI->valno != DefVNI && "Same value defined more than once?");
1071       // There is an existing def at NewIdx.
1072       if (I->end.isDead()) {
1073         // Case 3: Remove the dead def at OldIdx.
1074         LR.removeValNo(DefVNI);
1075         return;
1076       }
1077       // Case 4: Replace def at NewIdx with live def at OldIdx.
1078       I->start = DefVNI->def;
1079       LR.removeValNo(NewI->valno);
1080       return;
1081     }
1082
1083     // There is no existing def at NewIdx. Hoist DefVNI.
1084     if (!I->end.isDead()) {
1085       // Leave the end point of a live def.
1086       I->start = DefVNI->def;
1087       return;
1088     }
1089
1090     // DefVNI is a dead def. It may have been moved across other values in LR,
1091     // so move I up to NewI. Slide [NewI;I) down one position.
1092     std::copy_backward(NewI, I, std::next(I));
1093     *NewI = LiveRange::Segment(DefVNI->def, NewIdx.getDeadSlot(), DefVNI);
1094   }
1095
1096   void updateRegMaskSlots() {
1097     SmallVectorImpl<SlotIndex>::iterator RI =
1098       std::lower_bound(LIS.RegMaskSlots.begin(), LIS.RegMaskSlots.end(),
1099                        OldIdx);
1100     assert(RI != LIS.RegMaskSlots.end() && *RI == OldIdx.getRegSlot() &&
1101            "No RegMask at OldIdx.");
1102     *RI = NewIdx.getRegSlot();
1103     assert((RI == LIS.RegMaskSlots.begin() ||
1104             SlotIndex::isEarlierInstr(*std::prev(RI), *RI)) &&
1105            "Cannot move regmask instruction above another call");
1106     assert((std::next(RI) == LIS.RegMaskSlots.end() ||
1107             SlotIndex::isEarlierInstr(*RI, *std::next(RI))) &&
1108            "Cannot move regmask instruction below another call");
1109   }
1110
1111   // Return the last use of reg between NewIdx and OldIdx.
1112   SlotIndex findLastUseBefore(unsigned Reg, unsigned LaneMask) {
1113
1114     if (TargetRegisterInfo::isVirtualRegister(Reg)) {
1115       SlotIndex LastUse = NewIdx;
1116       for (MachineOperand &MO : MRI.use_nodbg_operands(Reg)) {
1117         unsigned SubReg = MO.getSubReg();
1118         if (SubReg != 0 && LaneMask != 0
1119             && (TRI.getSubRegIndexLaneMask(SubReg) & LaneMask) == 0)
1120           continue;
1121
1122         const MachineInstr *MI = MO.getParent();
1123         SlotIndex InstSlot = LIS.getSlotIndexes()->getInstructionIndex(MI);
1124         if (InstSlot > LastUse && InstSlot < OldIdx)
1125           LastUse = InstSlot;
1126       }
1127       return LastUse;
1128     }
1129
1130     // This is a regunit interval, so scanning the use list could be very
1131     // expensive. Scan upwards from OldIdx instead.
1132     assert(NewIdx < OldIdx && "Expected upwards move");
1133     SlotIndexes *Indexes = LIS.getSlotIndexes();
1134     MachineBasicBlock *MBB = Indexes->getMBBFromIndex(NewIdx);
1135
1136     // OldIdx may not correspond to an instruction any longer, so set MII to
1137     // point to the next instruction after OldIdx, or MBB->end().
1138     MachineBasicBlock::iterator MII = MBB->end();
1139     if (MachineInstr *MI = Indexes->getInstructionFromIndex(
1140                            Indexes->getNextNonNullIndex(OldIdx)))
1141       if (MI->getParent() == MBB)
1142         MII = MI;
1143
1144     MachineBasicBlock::iterator Begin = MBB->begin();
1145     while (MII != Begin) {
1146       if ((--MII)->isDebugValue())
1147         continue;
1148       SlotIndex Idx = Indexes->getInstructionIndex(MII);
1149
1150       // Stop searching when NewIdx is reached.
1151       if (!SlotIndex::isEarlierInstr(NewIdx, Idx))
1152         return NewIdx;
1153
1154       // Check if MII uses Reg.
1155       for (MIBundleOperands MO(MII); MO.isValid(); ++MO)
1156         if (MO->isReg() &&
1157             TargetRegisterInfo::isPhysicalRegister(MO->getReg()) &&
1158             TRI.hasRegUnit(MO->getReg(), Reg))
1159           return Idx;
1160     }
1161     // Didn't reach NewIdx. It must be the first instruction in the block.
1162     return NewIdx;
1163   }
1164 };
1165
1166 void LiveIntervals::handleMove(MachineInstr* MI, bool UpdateFlags) {
1167   assert(!MI->isBundled() && "Can't handle bundled instructions yet.");
1168   SlotIndex OldIndex = Indexes->getInstructionIndex(MI);
1169   Indexes->removeMachineInstrFromMaps(MI);
1170   SlotIndex NewIndex = Indexes->insertMachineInstrInMaps(MI);
1171   assert(getMBBStartIdx(MI->getParent()) <= OldIndex &&
1172          OldIndex < getMBBEndIdx(MI->getParent()) &&
1173          "Cannot handle moves across basic block boundaries.");
1174
1175   HMEditor HME(*this, *MRI, *TRI, OldIndex, NewIndex, UpdateFlags);
1176   HME.updateAllRanges(MI);
1177 }
1178
1179 void LiveIntervals::handleMoveIntoBundle(MachineInstr* MI,
1180                                          MachineInstr* BundleStart,
1181                                          bool UpdateFlags) {
1182   SlotIndex OldIndex = Indexes->getInstructionIndex(MI);
1183   SlotIndex NewIndex = Indexes->getInstructionIndex(BundleStart);
1184   HMEditor HME(*this, *MRI, *TRI, OldIndex, NewIndex, UpdateFlags);
1185   HME.updateAllRanges(MI);
1186 }
1187
1188 void LiveIntervals::repairOldRegInRange(const MachineBasicBlock::iterator Begin,
1189                                         const MachineBasicBlock::iterator End,
1190                                         const SlotIndex endIdx,
1191                                         LiveRange &LR, const unsigned Reg,
1192                                         const unsigned LaneMask) {
1193   LiveInterval::iterator LII = LR.find(endIdx);
1194   SlotIndex lastUseIdx;
1195   if (LII != LR.end() && LII->start < endIdx)
1196     lastUseIdx = LII->end;
1197   else
1198     --LII;
1199
1200   for (MachineBasicBlock::iterator I = End; I != Begin;) {
1201     --I;
1202     MachineInstr *MI = I;
1203     if (MI->isDebugValue())
1204       continue;
1205
1206     SlotIndex instrIdx = getInstructionIndex(MI);
1207     bool isStartValid = getInstructionFromIndex(LII->start);
1208     bool isEndValid = getInstructionFromIndex(LII->end);
1209
1210     // FIXME: This doesn't currently handle early-clobber or multiple removed
1211     // defs inside of the region to repair.
1212     for (MachineInstr::mop_iterator OI = MI->operands_begin(),
1213          OE = MI->operands_end(); OI != OE; ++OI) {
1214       const MachineOperand &MO = *OI;
1215       if (!MO.isReg() || MO.getReg() != Reg)
1216         continue;
1217
1218       unsigned SubReg = MO.getSubReg();
1219       unsigned Mask = TRI->getSubRegIndexLaneMask(SubReg);
1220       if ((Mask & LaneMask) == 0)
1221         continue;
1222
1223       if (MO.isDef()) {
1224         if (!isStartValid) {
1225           if (LII->end.isDead()) {
1226             SlotIndex prevStart;
1227             if (LII != LR.begin())
1228               prevStart = std::prev(LII)->start;
1229
1230             // FIXME: This could be more efficient if there was a
1231             // removeSegment method that returned an iterator.
1232             LR.removeSegment(*LII, true);
1233             if (prevStart.isValid())
1234               LII = LR.find(prevStart);
1235             else
1236               LII = LR.begin();
1237           } else {
1238             LII->start = instrIdx.getRegSlot();
1239             LII->valno->def = instrIdx.getRegSlot();
1240             if (MO.getSubReg() && !MO.isUndef())
1241               lastUseIdx = instrIdx.getRegSlot();
1242             else
1243               lastUseIdx = SlotIndex();
1244             continue;
1245           }
1246         }
1247
1248         if (!lastUseIdx.isValid()) {
1249           VNInfo *VNI = LR.getNextValue(instrIdx.getRegSlot(), VNInfoAllocator);
1250           LiveRange::Segment S(instrIdx.getRegSlot(),
1251                                instrIdx.getDeadSlot(), VNI);
1252           LII = LR.addSegment(S);
1253         } else if (LII->start != instrIdx.getRegSlot()) {
1254           VNInfo *VNI = LR.getNextValue(instrIdx.getRegSlot(), VNInfoAllocator);
1255           LiveRange::Segment S(instrIdx.getRegSlot(), lastUseIdx, VNI);
1256           LII = LR.addSegment(S);
1257         }
1258
1259         if (MO.getSubReg() && !MO.isUndef())
1260           lastUseIdx = instrIdx.getRegSlot();
1261         else
1262           lastUseIdx = SlotIndex();
1263       } else if (MO.isUse()) {
1264         // FIXME: This should probably be handled outside of this branch,
1265         // either as part of the def case (for defs inside of the region) or
1266         // after the loop over the region.
1267         if (!isEndValid && !LII->end.isBlock())
1268           LII->end = instrIdx.getRegSlot();
1269         if (!lastUseIdx.isValid())
1270           lastUseIdx = instrIdx.getRegSlot();
1271       }
1272     }
1273   }
1274 }
1275
1276 void
1277 LiveIntervals::repairIntervalsInRange(MachineBasicBlock *MBB,
1278                                       MachineBasicBlock::iterator Begin,
1279                                       MachineBasicBlock::iterator End,
1280                                       ArrayRef<unsigned> OrigRegs) {
1281   // Find anchor points, which are at the beginning/end of blocks or at
1282   // instructions that already have indexes.
1283   while (Begin != MBB->begin() && !Indexes->hasIndex(Begin))
1284     --Begin;
1285   while (End != MBB->end() && !Indexes->hasIndex(End))
1286     ++End;
1287
1288   SlotIndex endIdx;
1289   if (End == MBB->end())
1290     endIdx = getMBBEndIdx(MBB).getPrevSlot();
1291   else
1292     endIdx = getInstructionIndex(End);
1293
1294   Indexes->repairIndexesInRange(MBB, Begin, End);
1295
1296   for (MachineBasicBlock::iterator I = End; I != Begin;) {
1297     --I;
1298     MachineInstr *MI = I;
1299     if (MI->isDebugValue())
1300       continue;
1301     for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1302          MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1303       if (MOI->isReg() &&
1304           TargetRegisterInfo::isVirtualRegister(MOI->getReg()) &&
1305           !hasInterval(MOI->getReg())) {
1306         createAndComputeVirtRegInterval(MOI->getReg());
1307       }
1308     }
1309   }
1310
1311   for (unsigned i = 0, e = OrigRegs.size(); i != e; ++i) {
1312     unsigned Reg = OrigRegs[i];
1313     if (!TargetRegisterInfo::isVirtualRegister(Reg))
1314       continue;
1315
1316     LiveInterval &LI = getInterval(Reg);
1317     // FIXME: Should we support undefs that gain defs?
1318     if (!LI.hasAtLeastOneValue())
1319       continue;
1320
1321     for (LiveInterval::SubRange &S : LI.subranges()) {
1322       repairOldRegInRange(Begin, End, endIdx, S, Reg, S.LaneMask);
1323     }
1324     repairOldRegInRange(Begin, End, endIdx, LI, Reg);
1325   }
1326 }