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