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 #define DEBUG_TYPE "regalloc"
  19 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  20 #include "llvm/Value.h"
  21 #include "llvm/Analysis/AliasAnalysis.h"
  22 #include "llvm/CodeGen/LiveVariables.h"
  23 #include "llvm/CodeGen/MachineDominators.h"
  24 #include "llvm/CodeGen/MachineInstr.h"
  25 #include "llvm/CodeGen/MachineRegisterInfo.h"
  26 #include "llvm/CodeGen/Passes.h"
  27 #include "llvm/Target/TargetRegisterInfo.h"
  28 #include "llvm/Target/TargetInstrInfo.h"
  29 #include "llvm/Target/TargetMachine.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/ErrorHandling.h"
  32 #include "llvm/Support/raw_ostream.h"
  33 #include "llvm/ADT/DenseSet.h"
  34 #include "llvm/ADT/Statistic.h"
  35 #include "llvm/ADT/STLExtras.h"
  36 #include "LiveRangeCalc.h"
  37 #include <algorithm>
  38 #include <limits>
  39 #include <cmath>
  40 using namespace llvm;
  41
  42 STATISTIC(numIntervals , "Number of original intervals");
  43
  44 char LiveIntervals::ID = 0;
  45 INITIALIZE_PASS_BEGIN(LiveIntervals, "liveintervals",
  46                 "Live Interval Analysis", false, false)
  47 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
  48 INITIALIZE_PASS_DEPENDENCY(LiveVariables)
  49 INITIALIZE_PASS_DEPENDENCY(MachineDominatorTree)
  50 INITIALIZE_PASS_DEPENDENCY(SlotIndexes)
  51 INITIALIZE_PASS_END(LiveIntervals, "liveintervals",
  52                 "Live Interval Analysis", false, false)
  53
  54 void LiveIntervals::getAnalysisUsage(AnalysisUsage &AU) const {
  55   AU.setPreservesCFG();
  56   AU.addRequired<AliasAnalysis>();
  57   AU.addPreserved<AliasAnalysis>();
  58   AU.addRequired<LiveVariables>();
  59   AU.addPreserved<LiveVariables>();
  60   AU.addPreservedID(MachineLoopInfoID);
  61   AU.addRequiredTransitiveID(MachineDominatorsID);
  62   AU.addPreservedID(MachineDominatorsID);
  63   AU.addPreserved<SlotIndexes>();
  64   AU.addRequiredTransitive<SlotIndexes>();
  65   MachineFunctionPass::getAnalysisUsage(AU);
  66 }
  67
  68 LiveIntervals::LiveIntervals() : MachineFunctionPass(ID),
  69   DomTree(0), LRCalc(0) {
  70   initializeLiveIntervalsPass(*PassRegistry::getPassRegistry());
  71 }
  72
  73 LiveIntervals::~LiveIntervals() {
  74   delete LRCalc;
  75 }
  76
  77 void LiveIntervals::releaseMemory() {
  78   // Free the live intervals themselves.
  79   for (DenseMap<unsigned, LiveInterval*>::iterator I = R2IMap.begin(),
  80        E = R2IMap.end(); I != E; ++I)
  81     delete I->second;
  82
  83   R2IMap.clear();
  84   RegMaskSlots.clear();
  85   RegMaskBits.clear();
  86   RegMaskBlocks.clear();
  87
  88   for (unsigned i = 0, e = RegUnitIntervals.size(); i != e; ++i)
  89     delete RegUnitIntervals[i];
  90   RegUnitIntervals.clear();
  91
  92   // Release VNInfo memory regions, VNInfo objects don't need to be dtor'd.
  93   VNInfoAllocator.Reset();
  94 }
  95
  96 /// runOnMachineFunction - Register allocate the whole function
  97 ///
  98 bool LiveIntervals::runOnMachineFunction(MachineFunction &fn) {
  99   MF = &fn;
 100   MRI = &MF->getRegInfo();
 101   TM = &fn.getTarget();
 102   TRI = TM->getRegisterInfo();
 103   TII = TM->getInstrInfo();
 104   AA = &getAnalysis<AliasAnalysis>();
 105   LV = &getAnalysis<LiveVariables>();
 106   Indexes = &getAnalysis<SlotIndexes>();
 107   DomTree = &getAnalysis<MachineDominatorTree>();
 108   if (!LRCalc)
 109     LRCalc = new LiveRangeCalc();
 110   AllocatableRegs = TRI->getAllocatableSet(fn);
 111   ReservedRegs = TRI->getReservedRegs(fn);
 112
 113   computeIntervals();
 114
 115   numIntervals += getNumIntervals();
 116
 117   computeLiveInRegUnits();
 118
 119   DEBUG(dump());
 120   return true;
 121 }
 122
 123 /// print - Implement the dump method.
 124 void LiveIntervals::print(raw_ostream &OS, const Module* ) const {
 125   OS << "********** INTERVALS **********\n";
 126
 127   // Dump the physregs.
 128   for (unsigned Reg = 1, RegE = TRI->getNumRegs(); Reg != RegE; ++Reg)
 129     if (const LiveInterval *LI = R2IMap.lookup(Reg))
 130       OS << PrintReg(Reg, TRI) << '\t' << *LI << '\n';
 131
 132   // Dump the regunits.
 133   for (unsigned i = 0, e = RegUnitIntervals.size(); i != e; ++i)
 134     if (LiveInterval *LI = RegUnitIntervals[i])
 135       OS << PrintRegUnit(i, TRI) << " = " << *LI << '\n';
 136
 137   // Dump the virtregs.
 138   for (unsigned Reg = 0, RegE = MRI->getNumVirtRegs(); Reg != RegE; ++Reg)
 139     if (const LiveInterval *LI =
 140         R2IMap.lookup(TargetRegisterInfo::index2VirtReg(Reg)))
 141       OS << PrintReg(LI->reg) << '\t' << *LI << '\n';
 142
 143   printInstrs(OS);
 144 }
 145
 146 void LiveIntervals::printInstrs(raw_ostream &OS) const {
 147   OS << "********** MACHINEINSTRS **********\n";
 148   MF->print(OS, Indexes);
 149 }
 150
 151 void LiveIntervals::dumpInstrs() const {
 152   printInstrs(dbgs());
 153 }
 154
 155 static
 156 bool MultipleDefsBySameMI(const MachineInstr &MI, unsigned MOIdx) {
 157   unsigned Reg = MI.getOperand(MOIdx).getReg();
 158   for (unsigned i = MOIdx+1, e = MI.getNumOperands(); i < e; ++i) {
 159     const MachineOperand &MO = MI.getOperand(i);
 160     if (!MO.isReg())
 161       continue;
 162     if (MO.getReg() == Reg && MO.isDef()) {
 163       assert(MI.getOperand(MOIdx).getSubReg() != MO.getSubReg() &&
 164              MI.getOperand(MOIdx).getSubReg() &&
 165              (MO.getSubReg() || MO.isImplicit()));
 166       return true;
 167     }
 168   }
 169   return false;
 170 }
 171
 172 /// isPartialRedef - Return true if the specified def at the specific index is
 173 /// partially re-defining the specified live interval. A common case of this is
 174 /// a definition of the sub-register.
 175 bool LiveIntervals::isPartialRedef(SlotIndex MIIdx, MachineOperand &MO,
 176                                    LiveInterval &interval) {
 177   if (!MO.getSubReg() || MO.isEarlyClobber())
 178     return false;
 179
 180   SlotIndex RedefIndex = MIIdx.getRegSlot();
 181   const LiveRange *OldLR =
 182     interval.getLiveRangeContaining(RedefIndex.getRegSlot(true));
 183   MachineInstr *DefMI = getInstructionFromIndex(OldLR->valno->def);
 184   if (DefMI != 0) {
 185     return DefMI->findRegisterDefOperandIdx(interval.reg) != -1;
 186   }
 187   return false;
 188 }
 189
 190 void LiveIntervals::handleVirtualRegisterDef(MachineBasicBlock *mbb,
 191                                              MachineBasicBlock::iterator mi,
 192                                              SlotIndex MIIdx,
 193                                              MachineOperand& MO,
 194                                              unsigned MOIdx,
 195                                              LiveInterval &interval) {
 196   DEBUG(dbgs() << "\t\tregister: " << PrintReg(interval.reg, TRI));
 197
 198   // Virtual registers may be defined multiple times (due to phi
 199   // elimination and 2-addr elimination).  Much of what we do only has to be
 200   // done once for the vreg.  We use an empty interval to detect the first
 201   // time we see a vreg.
 202   LiveVariables::VarInfo& vi = LV->getVarInfo(interval.reg);
 203   if (interval.empty()) {
 204     // Get the Idx of the defining instructions.
 205     SlotIndex defIndex = MIIdx.getRegSlot(MO.isEarlyClobber());
 206
 207     // Make sure the first definition is not a partial redefinition.
 208     assert(!MO.readsReg() && "First def cannot also read virtual register "
 209            "missing <undef> flag?");
 210
 211     VNInfo *ValNo = interval.getNextValue(defIndex, VNInfoAllocator);
 212     assert(ValNo->id == 0 && "First value in interval is not 0?");
 213
 214     // Loop over all of the blocks that the vreg is defined in.  There are
 215     // two cases we have to handle here.  The most common case is a vreg
 216     // whose lifetime is contained within a basic block.  In this case there
 217     // will be a single kill, in MBB, which comes after the definition.
 218     if (vi.Kills.size() == 1 && vi.Kills[0]->getParent() == mbb) {
 219       // FIXME: what about dead vars?
 220       SlotIndex killIdx;
 221       if (vi.Kills[0] != mi)
 222         killIdx = getInstructionIndex(vi.Kills[0]).getRegSlot();
 223       else
 224         killIdx = defIndex.getDeadSlot();
 225
 226       // If the kill happens after the definition, we have an intra-block
 227       // live range.
 228       if (killIdx > defIndex) {
 229         assert(vi.AliveBlocks.empty() &&
 230                "Shouldn't be alive across any blocks!");
 231         LiveRange LR(defIndex, killIdx, ValNo);
 232         interval.addRange(LR);
 233         DEBUG(dbgs() << " +" << LR << "\n");
 234         return;
 235       }
 236     }
 237
 238     // The other case we handle is when a virtual register lives to the end
 239     // of the defining block, potentially live across some blocks, then is
 240     // live into some number of blocks, but gets killed.  Start by adding a
 241     // range that goes from this definition to the end of the defining block.
 242     LiveRange NewLR(defIndex, getMBBEndIdx(mbb), ValNo);
 243     DEBUG(dbgs() << " +" << NewLR);
 244     interval.addRange(NewLR);
 245
 246     bool PHIJoin = LV->isPHIJoin(interval.reg);
 247
 248     if (PHIJoin) {
 249       // A phi join register is killed at the end of the MBB and revived as a
 250       // new valno in the killing blocks.
 251       assert(vi.AliveBlocks.empty() && "Phi join can't pass through blocks");
 252       DEBUG(dbgs() << " phi-join");
 253       ValNo->setHasPHIKill(true);
 254     } else {
 255       // Iterate over all of the blocks that the variable is completely
 256       // live in, adding [insrtIndex(begin), instrIndex(end)+4) to the
 257       // live interval.
 258       for (SparseBitVector<>::iterator I = vi.AliveBlocks.begin(),
 259                E = vi.AliveBlocks.end(); I != E; ++I) {
 260         MachineBasicBlock *aliveBlock = MF->getBlockNumbered(*I);
 261         LiveRange LR(getMBBStartIdx(aliveBlock), getMBBEndIdx(aliveBlock),
 262                      ValNo);
 263         interval.addRange(LR);
 264         DEBUG(dbgs() << " +" << LR);
 265       }
 266     }
 267
 268     // Finally, this virtual register is live from the start of any killing
 269     // block to the 'use' slot of the killing instruction.
 270     for (unsigned i = 0, e = vi.Kills.size(); i != e; ++i) {
 271       MachineInstr *Kill = vi.Kills[i];
 272       SlotIndex Start = getMBBStartIdx(Kill->getParent());
 273       SlotIndex killIdx = getInstructionIndex(Kill).getRegSlot();
 274
 275       // Create interval with one of a NEW value number.  Note that this value
 276       // number isn't actually defined by an instruction, weird huh? :)
 277       if (PHIJoin) {
 278         assert(getInstructionFromIndex(Start) == 0 &&
 279                "PHI def index points at actual instruction.");
 280         ValNo = interval.getNextValue(Start, VNInfoAllocator);
 281         ValNo->setIsPHIDef(true);
 282       }
 283       LiveRange LR(Start, killIdx, ValNo);
 284       interval.addRange(LR);
 285       DEBUG(dbgs() << " +" << LR);
 286     }
 287
 288   } else {
 289     if (MultipleDefsBySameMI(*mi, MOIdx))
 290       // Multiple defs of the same virtual register by the same instruction.
 291       // e.g. %reg1031:5<def>, %reg1031:6<def> = VLD1q16 %reg1024<kill>, ...
 292       // This is likely due to elimination of REG_SEQUENCE instructions. Return
 293       // here since there is nothing to do.
 294       return;
 295
 296     // If this is the second time we see a virtual register definition, it
 297     // must be due to phi elimination or two addr elimination.  If this is
 298     // the result of two address elimination, then the vreg is one of the
 299     // def-and-use register operand.
 300
 301     // It may also be partial redef like this:
 302     // 80  %reg1041:6<def> = VSHRNv4i16 %reg1034<kill>, 12, pred:14, pred:%reg0
 303     // 120 %reg1041:5<def> = VSHRNv4i16 %reg1039<kill>, 12, pred:14, pred:%reg0
 304     bool PartReDef = isPartialRedef(MIIdx, MO, interval);
 305     if (PartReDef || mi->isRegTiedToUseOperand(MOIdx)) {
 306       // If this is a two-address definition, then we have already processed
 307       // the live range.  The only problem is that we didn't realize there
 308       // are actually two values in the live interval.  Because of this we
 309       // need to take the LiveRegion that defines this register and split it
 310       // into two values.
 311       SlotIndex RedefIndex = MIIdx.getRegSlot(MO.isEarlyClobber());
 312
 313       const LiveRange *OldLR =
 314         interval.getLiveRangeContaining(RedefIndex.getRegSlot(true));
 315       VNInfo *OldValNo = OldLR->valno;
 316       SlotIndex DefIndex = OldValNo->def.getRegSlot();
 317
 318       // Delete the previous value, which should be short and continuous,
 319       // because the 2-addr copy must be in the same MBB as the redef.
 320       interval.removeRange(DefIndex, RedefIndex);
 321
 322       // The new value number (#1) is defined by the instruction we claimed
 323       // defined value #0.
 324       VNInfo *ValNo = interval.createValueCopy(OldValNo, VNInfoAllocator);
 325
 326       // Value#0 is now defined by the 2-addr instruction.
 327       OldValNo->def = RedefIndex;
 328
 329       // Add the new live interval which replaces the range for the input copy.
 330       LiveRange LR(DefIndex, RedefIndex, ValNo);
 331       DEBUG(dbgs() << " replace range with " << LR);
 332       interval.addRange(LR);
 333
 334       // If this redefinition is dead, we need to add a dummy unit live
 335       // range covering the def slot.
 336       if (MO.isDead())
 337         interval.addRange(LiveRange(RedefIndex, RedefIndex.getDeadSlot(),
 338                                     OldValNo));
 339
 340       DEBUG(dbgs() << " RESULT: " << interval);
 341     } else if (LV->isPHIJoin(interval.reg)) {
 342       // In the case of PHI elimination, each variable definition is only
 343       // live until the end of the block.  We've already taken care of the
 344       // rest of the live range.
 345
 346       SlotIndex defIndex = MIIdx.getRegSlot();
 347       if (MO.isEarlyClobber())
 348         defIndex = MIIdx.getRegSlot(true);
 349
 350       VNInfo *ValNo = interval.getNextValue(defIndex, VNInfoAllocator);
 351
 352       SlotIndex killIndex = getMBBEndIdx(mbb);
 353       LiveRange LR(defIndex, killIndex, ValNo);
 354       interval.addRange(LR);
 355       ValNo->setHasPHIKill(true);
 356       DEBUG(dbgs() << " phi-join +" << LR);
 357     } else {
 358       llvm_unreachable("Multiply defined register");
 359     }
 360   }
 361
 362   DEBUG(dbgs() << '\n');
 363 }
 364
 365 void LiveIntervals::handleRegisterDef(MachineBasicBlock *MBB,
 366                                       MachineBasicBlock::iterator MI,
 367                                       SlotIndex MIIdx,
 368                                       MachineOperand& MO,
 369                                       unsigned MOIdx) {
 370   if (TargetRegisterInfo::isVirtualRegister(MO.getReg()))
 371     handleVirtualRegisterDef(MBB, MI, MIIdx, MO, MOIdx,
 372                              getOrCreateInterval(MO.getReg()));
 373 }
 374
 375 /// computeIntervals - computes the live intervals for virtual
 376 /// registers. for some ordering of the machine instructions [1,N] a
 377 /// live interval is an interval [i, j) where 1 <= i <= j < N for
 378 /// which a variable is live
 379 void LiveIntervals::computeIntervals() {
 380   DEBUG(dbgs() << "********** COMPUTING LIVE INTERVALS **********\n"
 381                << "********** Function: "
 382                << ((Value*)MF->getFunction())->getName() << '\n');
 383
 384   RegMaskBlocks.resize(MF->getNumBlockIDs());
 385
 386   SmallVector<unsigned, 8> UndefUses;
 387   for (MachineFunction::iterator MBBI = MF->begin(), E = MF->end();
 388        MBBI != E; ++MBBI) {
 389     MachineBasicBlock *MBB = MBBI;
 390     RegMaskBlocks[MBB->getNumber()].first = RegMaskSlots.size();
 391
 392     if (MBB->empty())
 393       continue;
 394
 395     // Track the index of the current machine instr.
 396     SlotIndex MIIndex = getMBBStartIdx(MBB);
 397     DEBUG(dbgs() << "BB#" << MBB->getNumber()
 398           << ":\t\t# derived from " << MBB->getName() << "\n");
 399
 400     // Skip over empty initial indices.
 401     if (getInstructionFromIndex(MIIndex) == 0)
 402       MIIndex = Indexes->getNextNonNullIndex(MIIndex);
 403
 404     for (MachineBasicBlock::iterator MI = MBB->begin(), miEnd = MBB->end();
 405          MI != miEnd; ++MI) {
 406       DEBUG(dbgs() << MIIndex << "\t" << *MI);
 407       if (MI->isDebugValue())
 408         continue;
 409       assert(Indexes->getInstructionFromIndex(MIIndex) == MI &&
 410              "Lost SlotIndex synchronization");
 411
 412       // Handle defs.
 413       for (int i = MI->getNumOperands() - 1; i >= 0; --i) {
 414         MachineOperand &MO = MI->getOperand(i);
 415
 416         // Collect register masks.
 417         if (MO.isRegMask()) {
 418           RegMaskSlots.push_back(MIIndex.getRegSlot());
 419           RegMaskBits.push_back(MO.getRegMask());
 420           continue;
 421         }
 422
 423         if (!MO.isReg() || !TargetRegisterInfo::isVirtualRegister(MO.getReg()))
 424           continue;
 425
 426         // handle register defs - build intervals
 427         if (MO.isDef())
 428           handleRegisterDef(MBB, MI, MIIndex, MO, i);
 429         else if (MO.isUndef())
 430           UndefUses.push_back(MO.getReg());
 431       }
 432
 433       // Move to the next instr slot.
 434       MIIndex = Indexes->getNextNonNullIndex(MIIndex);
 435     }
 436
 437     // Compute the number of register mask instructions in this block.
 438     std::pair<unsigned, unsigned> &RMB = RegMaskBlocks[MBB->getNumber()];
 439     RMB.second = RegMaskSlots.size() - RMB.first;;
 440   }
 441
 442   // Create empty intervals for registers defined by implicit_def's (except
 443   // for those implicit_def that define values which are liveout of their
 444   // blocks.
 445   for (unsigned i = 0, e = UndefUses.size(); i != e; ++i) {
 446     unsigned UndefReg = UndefUses[i];
 447     (void)getOrCreateInterval(UndefReg);
 448   }
 449 }
 450
 451 LiveInterval* LiveIntervals::createInterval(unsigned reg) {
 452   float Weight = TargetRegisterInfo::isPhysicalRegister(reg) ? HUGE_VALF : 0.0F;
 453   return new LiveInterval(reg, Weight);
 454 }
 455
 456
 457 //===----------------------------------------------------------------------===//
 458 //                           Register Unit Liveness
 459 //===----------------------------------------------------------------------===//
 460 //
 461 // Fixed interference typically comes from ABI boundaries: Function arguments
 462 // and return values are passed in fixed registers, and so are exception
 463 // pointers entering landing pads. Certain instructions require values to be
 464 // present in specific registers. That is also represented through fixed
 465 // interference.
 466 //
 467
 468 /// computeRegUnitInterval - Compute the live interval of a register unit, based
 469 /// on the uses and defs of aliasing registers.  The interval should be empty,
 470 /// or contain only dead phi-defs from ABI blocks.
 471 void LiveIntervals::computeRegUnitInterval(LiveInterval *LI) {
 472   unsigned Unit = LI->reg;
 473
 474   assert(LRCalc && "LRCalc not initialized.");
 475   LRCalc->reset(MF, getSlotIndexes(), DomTree, &getVNInfoAllocator());
 476
 477   // The physregs aliasing Unit are the roots and their super-registers.
 478   // Create all values as dead defs before extending to uses. Note that roots
 479   // may share super-registers. That's OK because createDeadDefs() is
 480   // idempotent. It is very rare for a register unit to have multiple roots, so
 481   // uniquing super-registers is probably not worthwhile.
 482   for (MCRegUnitRootIterator Roots(Unit, TRI); Roots.isValid(); ++Roots) {
 483     unsigned Root = *Roots;
 484     if (!MRI->reg_empty(Root))
 485       LRCalc->createDeadDefs(LI, Root);
 486     for (MCSuperRegIterator Supers(Root, TRI); Supers.isValid(); ++Supers) {
 487       if (!MRI->reg_empty(*Supers))
 488         LRCalc->createDeadDefs(LI, *Supers);
 489     }
 490   }
 491
 492   // Now extend LI to reach all uses.
 493   // Ignore uses of reserved registers. We only track defs of those.
 494   for (MCRegUnitRootIterator Roots(Unit, TRI); Roots.isValid(); ++Roots) {
 495     unsigned Root = *Roots;
 496     if (!isReserved(Root) && !MRI->reg_empty(Root))
 497       LRCalc->extendToUses(LI, Root);
 498     for (MCSuperRegIterator Supers(Root, TRI); Supers.isValid(); ++Supers) {
 499       unsigned Reg = *Supers;
 500       if (!isReserved(Reg) && !MRI->reg_empty(Reg))
 501         LRCalc->extendToUses(LI, Reg);
 502     }
 503   }
 504 }
 505
 506
 507 /// computeLiveInRegUnits - Precompute the live ranges of any register units
 508 /// that are live-in to an ABI block somewhere. Register values can appear
 509 /// without a corresponding def when entering the entry block or a landing pad.
 510 ///
 511 void LiveIntervals::computeLiveInRegUnits() {
 512   RegUnitIntervals.resize(TRI->getNumRegUnits());
 513   DEBUG(dbgs() << "Computing live-in reg-units in ABI blocks.\n");
 514
 515   // Keep track of the intervals allocated.
 516   SmallVector<LiveInterval*, 8> NewIntvs;
 517
 518   // Check all basic blocks for live-ins.
 519   for (MachineFunction::const_iterator MFI = MF->begin(), MFE = MF->end();
 520        MFI != MFE; ++MFI) {
 521     const MachineBasicBlock *MBB = MFI;
 522
 523     // We only care about ABI blocks: Entry + landing pads.
 524     if ((MFI != MF->begin() && !MBB->isLandingPad()) || MBB->livein_empty())
 525       continue;
 526
 527     // Create phi-defs at Begin for all live-in registers.
 528     SlotIndex Begin = Indexes->getMBBStartIdx(MBB);
 529     DEBUG(dbgs() << Begin << "\tBB#" << MBB->getNumber());
 530     for (MachineBasicBlock::livein_iterator LII = MBB->livein_begin(),
 531          LIE = MBB->livein_end(); LII != LIE; ++LII) {
 532       for (MCRegUnitIterator Units(*LII, TRI); Units.isValid(); ++Units) {
 533         unsigned Unit = *Units;
 534         LiveInterval *Intv = RegUnitIntervals[Unit];
 535         if (!Intv) {
 536           Intv = RegUnitIntervals[Unit] = new LiveInterval(Unit, HUGE_VALF);
 537           NewIntvs.push_back(Intv);
 538         }
 539         VNInfo *VNI = Intv->createDeadDef(Begin, getVNInfoAllocator());
 540         (void)VNI;
 541         DEBUG(dbgs() << ' ' << PrintRegUnit(Unit, TRI) << '#' << VNI->id);
 542       }
 543     }
 544     DEBUG(dbgs() << '\n');
 545   }
 546   DEBUG(dbgs() << "Created " << NewIntvs.size() << " new intervals.\n");
 547
 548   // Compute the 'normal' part of the intervals.
 549   for (unsigned i = 0, e = NewIntvs.size(); i != e; ++i)
 550     computeRegUnitInterval(NewIntvs[i]);
 551 }
 552
 553
 554 /// shrinkToUses - After removing some uses of a register, shrink its live
 555 /// range to just the remaining uses. This method does not compute reaching
 556 /// defs for new uses, and it doesn't remove dead defs.
 557 bool LiveIntervals::shrinkToUses(LiveInterval *li,
 558                                  SmallVectorImpl<MachineInstr*> *dead) {
 559   DEBUG(dbgs() << "Shrink: " << *li << '\n');
 560   assert(TargetRegisterInfo::isVirtualRegister(li->reg)
 561          && "Can only shrink virtual registers");
 562   // Find all the values used, including PHI kills.
 563   SmallVector<std::pair<SlotIndex, VNInfo*>, 16> WorkList;
 564
 565   // Blocks that have already been added to WorkList as live-out.
 566   SmallPtrSet<MachineBasicBlock*, 16> LiveOut;
 567
 568   // Visit all instructions reading li->reg.
 569   for (MachineRegisterInfo::reg_iterator I = MRI->reg_begin(li->reg);
 570        MachineInstr *UseMI = I.skipInstruction();) {
 571     if (UseMI->isDebugValue() || !UseMI->readsVirtualRegister(li->reg))
 572       continue;
 573     SlotIndex Idx = getInstructionIndex(UseMI).getRegSlot();
 574     LiveRangeQuery LRQ(*li, Idx);
 575     VNInfo *VNI = LRQ.valueIn();
 576     if (!VNI) {
 577       // This shouldn't happen: readsVirtualRegister returns true, but there is
 578       // no live value. It is likely caused by a target getting <undef> flags
 579       // wrong.
 580       DEBUG(dbgs() << Idx << '\t' << *UseMI
 581                    << "Warning: Instr claims to read non-existent value in "
 582                     << *li << '\n');
 583       continue;
 584     }
 585     // Special case: An early-clobber tied operand reads and writes the
 586     // register one slot early.
 587     if (VNInfo *DefVNI = LRQ.valueDefined())
 588       Idx = DefVNI->def;
 589
 590     WorkList.push_back(std::make_pair(Idx, VNI));
 591   }
 592
 593   // Create a new live interval with only minimal live segments per def.
 594   LiveInterval NewLI(li->reg, 0);
 595   for (LiveInterval::vni_iterator I = li->vni_begin(), E = li->vni_end();
 596        I != E; ++I) {
 597     VNInfo *VNI = *I;
 598     if (VNI->isUnused())
 599       continue;
 600     NewLI.addRange(LiveRange(VNI->def, VNI->def.getDeadSlot(), VNI));
 601   }
 602
 603   // Keep track of the PHIs that are in use.
 604   SmallPtrSet<VNInfo*, 8> UsedPHIs;
 605
 606   // Extend intervals to reach all uses in WorkList.
 607   while (!WorkList.empty()) {
 608     SlotIndex Idx = WorkList.back().first;
 609     VNInfo *VNI = WorkList.back().second;
 610     WorkList.pop_back();
 611     const MachineBasicBlock *MBB = getMBBFromIndex(Idx.getPrevSlot());
 612     SlotIndex BlockStart = getMBBStartIdx(MBB);
 613
 614     // Extend the live range for VNI to be live at Idx.
 615     if (VNInfo *ExtVNI = NewLI.extendInBlock(BlockStart, Idx)) {
 616       (void)ExtVNI;
 617       assert(ExtVNI == VNI && "Unexpected existing value number");
 618       // Is this a PHIDef we haven't seen before?
 619       if (!VNI->isPHIDef() || VNI->def != BlockStart || !UsedPHIs.insert(VNI))
 620         continue;
 621       // The PHI is live, make sure the predecessors are live-out.
 622       for (MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(),
 623            PE = MBB->pred_end(); PI != PE; ++PI) {
 624         if (!LiveOut.insert(*PI))
 625           continue;
 626         SlotIndex Stop = getMBBEndIdx(*PI);
 627         // A predecessor is not required to have a live-out value for a PHI.
 628         if (VNInfo *PVNI = li->getVNInfoBefore(Stop))
 629           WorkList.push_back(std::make_pair(Stop, PVNI));
 630       }
 631       continue;
 632     }
 633
 634     // VNI is live-in to MBB.
 635     DEBUG(dbgs() << " live-in at " << BlockStart << '\n');
 636     NewLI.addRange(LiveRange(BlockStart, Idx, VNI));
 637
 638     // Make sure VNI is live-out from the predecessors.
 639     for (MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(),
 640          PE = MBB->pred_end(); PI != PE; ++PI) {
 641       if (!LiveOut.insert(*PI))
 642         continue;
 643       SlotIndex Stop = getMBBEndIdx(*PI);
 644       assert(li->getVNInfoBefore(Stop) == VNI &&
 645              "Wrong value out of predecessor");
 646       WorkList.push_back(std::make_pair(Stop, VNI));
 647     }
 648   }
 649
 650   // Handle dead values.
 651   bool CanSeparate = false;
 652   for (LiveInterval::vni_iterator I = li->vni_begin(), E = li->vni_end();
 653        I != E; ++I) {
 654     VNInfo *VNI = *I;
 655     if (VNI->isUnused())
 656       continue;
 657     LiveInterval::iterator LII = NewLI.FindLiveRangeContaining(VNI->def);
 658     assert(LII != NewLI.end() && "Missing live range for PHI");
 659     if (LII->end != VNI->def.getDeadSlot())
 660       continue;
 661     if (VNI->isPHIDef()) {
 662       // This is a dead PHI. Remove it.
 663       VNI->setIsUnused(true);
 664       NewLI.removeRange(*LII);
 665       DEBUG(dbgs() << "Dead PHI at " << VNI->def << " may separate interval\n");
 666       CanSeparate = true;
 667     } else {
 668       // This is a dead def. Make sure the instruction knows.
 669       MachineInstr *MI = getInstructionFromIndex(VNI->def);
 670       assert(MI && "No instruction defining live value");
 671       MI->addRegisterDead(li->reg, TRI);
 672       if (dead && MI->allDefsAreDead()) {
 673         DEBUG(dbgs() << "All defs dead: " << VNI->def << '\t' << *MI);
 674         dead->push_back(MI);
 675       }
 676     }
 677   }
 678
 679   // Move the trimmed ranges back.
 680   li->ranges.swap(NewLI.ranges);
 681   DEBUG(dbgs() << "Shrunk: " << *li << '\n');
 682   return CanSeparate;
 683 }
 684
 685
 686 //===----------------------------------------------------------------------===//
 687 // Register allocator hooks.
 688 //
 689
 690 void LiveIntervals::addKillFlags() {
 691   for (unsigned i = 0, e = MRI->getNumVirtRegs(); i != e; ++i) {
 692     unsigned Reg = TargetRegisterInfo::index2VirtReg(i);
 693     if (MRI->reg_nodbg_empty(Reg))
 694       continue;
 695     LiveInterval *LI = &getInterval(Reg);
 696
 697     // Every instruction that kills Reg corresponds to a live range end point.
 698     for (LiveInterval::iterator RI = LI->begin(), RE = LI->end(); RI != RE;
 699          ++RI) {
 700       // A block index indicates an MBB edge.
 701       if (RI->end.isBlock())
 702         continue;
 703       MachineInstr *MI = getInstructionFromIndex(RI->end);
 704       if (!MI)
 705         continue;
 706       MI->addRegisterKilled(Reg, NULL);
 707     }
 708   }
 709 }
 710
 711 MachineBasicBlock*
 712 LiveIntervals::intervalIsInOneMBB(const LiveInterval &LI) const {
 713   // A local live range must be fully contained inside the block, meaning it is
 714   // defined and killed at instructions, not at block boundaries. It is not
 715   // live in or or out of any block.
 716   //
 717   // It is technically possible to have a PHI-defined live range identical to a
 718   // single block, but we are going to return false in that case.
 719
 720   SlotIndex Start = LI.beginIndex();
 721   if (Start.isBlock())
 722     return NULL;
 723
 724   SlotIndex Stop = LI.endIndex();
 725   if (Stop.isBlock())
 726     return NULL;
 727
 728   // getMBBFromIndex doesn't need to search the MBB table when both indexes
 729   // belong to proper instructions.
 730   MachineBasicBlock *MBB1 = Indexes->getMBBFromIndex(Start);
 731   MachineBasicBlock *MBB2 = Indexes->getMBBFromIndex(Stop);
 732   return MBB1 == MBB2 ? MBB1 : NULL;
 733 }
 734
 735 float
 736 LiveIntervals::getSpillWeight(bool isDef, bool isUse, unsigned loopDepth) {
 737   // Limit the loop depth ridiculousness.
 738   if (loopDepth > 200)
 739     loopDepth = 200;
 740
 741   // The loop depth is used to roughly estimate the number of times the
 742   // instruction is executed. Something like 10^d is simple, but will quickly
 743   // overflow a float. This expression behaves like 10^d for small d, but is
 744   // more tempered for large d. At d=200 we get 6.7e33 which leaves a bit of
 745   // headroom before overflow.
 746   // By the way, powf() might be unavailable here. For consistency,
 747   // We may take pow(double,double).
 748   float lc = std::pow(1 + (100.0 / (loopDepth + 10)), (double)loopDepth);
 749
 750   return (isDef + isUse) * lc;
 751 }
 752
 753 LiveRange LiveIntervals::addLiveRangeToEndOfBlock(unsigned reg,
 754                                                   MachineInstr* startInst) {
 755   LiveInterval& Interval = getOrCreateInterval(reg);
 756   VNInfo* VN = Interval.getNextValue(
 757     SlotIndex(getInstructionIndex(startInst).getRegSlot()),
 758     getVNInfoAllocator());
 759   VN->setHasPHIKill(true);
 760   LiveRange LR(
 761      SlotIndex(getInstructionIndex(startInst).getRegSlot()),
 762      getMBBEndIdx(startInst->getParent()), VN);
 763   Interval.addRange(LR);
 764
 765   return LR;
 766 }
 767
 768
 769 //===----------------------------------------------------------------------===//
 770 //                          Register mask functions
 771 //===----------------------------------------------------------------------===//
 772
 773 bool LiveIntervals::checkRegMaskInterference(LiveInterval &LI,
 774                                              BitVector &UsableRegs) {
 775   if (LI.empty())
 776     return false;
 777   LiveInterval::iterator LiveI = LI.begin(), LiveE = LI.end();
 778
 779   // Use a smaller arrays for local live ranges.
 780   ArrayRef<SlotIndex> Slots;
 781   ArrayRef<const uint32_t*> Bits;
 782   if (MachineBasicBlock *MBB = intervalIsInOneMBB(LI)) {
 783     Slots = getRegMaskSlotsInBlock(MBB->getNumber());
 784     Bits = getRegMaskBitsInBlock(MBB->getNumber());
 785   } else {
 786     Slots = getRegMaskSlots();
 787     Bits = getRegMaskBits();
 788   }
 789
 790   // We are going to enumerate all the register mask slots contained in LI.
 791   // Start with a binary search of RegMaskSlots to find a starting point.
 792   ArrayRef<SlotIndex>::iterator SlotI =
 793     std::lower_bound(Slots.begin(), Slots.end(), LiveI->start);
 794   ArrayRef<SlotIndex>::iterator SlotE = Slots.end();
 795
 796   // No slots in range, LI begins after the last call.
 797   if (SlotI == SlotE)
 798     return false;
 799
 800   bool Found = false;
 801   for (;;) {
 802     assert(*SlotI >= LiveI->start);
 803     // Loop over all slots overlapping this segment.
 804     while (*SlotI < LiveI->end) {
 805       // *SlotI overlaps LI. Collect mask bits.
 806       if (!Found) {
 807         // This is the first overlap. Initialize UsableRegs to all ones.
 808         UsableRegs.clear();
 809         UsableRegs.resize(TRI->getNumRegs(), true);
 810         Found = true;
 811       }
 812       // Remove usable registers clobbered by this mask.
 813       UsableRegs.clearBitsNotInMask(Bits[SlotI-Slots.begin()]);
 814       if (++SlotI == SlotE)
 815         return Found;
 816     }
 817     // *SlotI is beyond the current LI segment.
 818     LiveI = LI.advanceTo(LiveI, *SlotI);
 819     if (LiveI == LiveE)
 820       return Found;
 821     // Advance SlotI until it overlaps.
 822     while (*SlotI < LiveI->start)
 823       if (++SlotI == SlotE)
 824         return Found;
 825   }
 826 }
 827
 828 //===----------------------------------------------------------------------===//
 829 //                         IntervalUpdate class.
 830 //===----------------------------------------------------------------------===//
 831
 832 // HMEditor is a toolkit used by handleMove to trim or extend live intervals.
 833 class LiveIntervals::HMEditor {
 834 private:
 835   LiveIntervals& LIS;
 836   const MachineRegisterInfo& MRI;
 837   const TargetRegisterInfo& TRI;
 838   SlotIndex NewIdx;
 839
 840   typedef std::pair<LiveInterval*, LiveRange*> IntRangePair;
 841   typedef DenseSet<IntRangePair> RangeSet;
 842
 843   struct RegRanges {
 844     LiveRange* Use;
 845     LiveRange* EC;
 846     LiveRange* Dead;
 847     LiveRange* Def;
 848     RegRanges() : Use(0), EC(0), Dead(0), Def(0) {}
 849   };
 850   typedef DenseMap<unsigned, RegRanges> BundleRanges;
 851
 852 public:
 853   HMEditor(LiveIntervals& LIS, const MachineRegisterInfo& MRI,
 854            const TargetRegisterInfo& TRI, SlotIndex NewIdx)
 855     : LIS(LIS), MRI(MRI), TRI(TRI), NewIdx(NewIdx) {}
 856
 857   // Update intervals for all operands of MI from OldIdx to NewIdx.
 858   // This assumes that MI used to be at OldIdx, and now resides at
 859   // NewIdx.
 860   void moveAllRangesFrom(MachineInstr* MI, SlotIndex OldIdx) {
 861     assert(NewIdx != OldIdx && "No-op move? That's a bit strange.");
 862
 863     // Collect the operands.
 864     RangeSet Entering, Internal, Exiting;
 865     bool hasRegMaskOp = false;
 866     collectRanges(MI, Entering, Internal, Exiting, hasRegMaskOp, OldIdx);
 867
 868     // To keep the LiveRanges valid within an interval, move the ranges closest
 869     // to the destination first. This prevents ranges from overlapping, to that
 870     // APIs like removeRange still work.
 871     if (NewIdx < OldIdx) {
 872       moveAllEnteringFrom(OldIdx, Entering);
 873       moveAllInternalFrom(OldIdx, Internal);
 874       moveAllExitingFrom(OldIdx, Exiting);
 875     }
 876     else {
 877       moveAllExitingFrom(OldIdx, Exiting);
 878       moveAllInternalFrom(OldIdx, Internal);
 879       moveAllEnteringFrom(OldIdx, Entering);
 880     }
 881
 882     if (hasRegMaskOp)
 883       updateRegMaskSlots(OldIdx);
 884
 885 #ifndef NDEBUG
 886     LIValidator validator;
 887     validator = std::for_each(Entering.begin(), Entering.end(), validator);
 888     validator = std::for_each(Internal.begin(), Internal.end(), validator);
 889     validator = std::for_each(Exiting.begin(), Exiting.end(), validator);
 890     assert(validator.rangesOk() && "moveAllOperandsFrom broke liveness.");
 891 #endif
 892
 893   }
 894
 895   // Update intervals for all operands of MI to refer to BundleStart's
 896   // SlotIndex.
 897   void moveAllRangesInto(MachineInstr* MI, MachineInstr* BundleStart) {
 898     if (MI == BundleStart)
 899       return; // Bundling instr with itself - nothing to do.
 900
 901     SlotIndex OldIdx = LIS.getSlotIndexes()->getInstructionIndex(MI);
 902     assert(LIS.getSlotIndexes()->getInstructionFromIndex(OldIdx) == MI &&
 903            "SlotIndex <-> Instruction mapping broken for MI");
 904
 905     // Collect all ranges already in the bundle.
 906     MachineBasicBlock::instr_iterator BII(BundleStart);
 907     RangeSet Entering, Internal, Exiting;
 908     bool hasRegMaskOp = false;
 909     collectRanges(BII, Entering, Internal, Exiting, hasRegMaskOp, NewIdx);
 910     assert(!hasRegMaskOp && "Can't have RegMask operand in bundle.");
 911     for (++BII; &*BII == MI || BII->isInsideBundle(); ++BII) {
 912       if (&*BII == MI)
 913         continue;
 914       collectRanges(BII, Entering, Internal, Exiting, hasRegMaskOp, NewIdx);
 915       assert(!hasRegMaskOp && "Can't have RegMask operand in bundle.");
 916     }
 917
 918     BundleRanges BR = createBundleRanges(Entering, Internal, Exiting);
 919
 920     Entering.clear();
 921     Internal.clear();
 922     Exiting.clear();
 923     collectRanges(MI, Entering, Internal, Exiting, hasRegMaskOp, OldIdx);
 924     assert(!hasRegMaskOp && "Can't have RegMask operand in bundle.");
 925
 926     DEBUG(dbgs() << "Entering: " << Entering.size() << "\n");
 927     DEBUG(dbgs() << "Internal: " << Internal.size() << "\n");
 928     DEBUG(dbgs() << "Exiting: " << Exiting.size() << "\n");
 929
 930     moveAllEnteringFromInto(OldIdx, Entering, BR);
 931     moveAllInternalFromInto(OldIdx, Internal, BR);
 932     moveAllExitingFromInto(OldIdx, Exiting, BR);
 933
 934
 935 #ifndef NDEBUG
 936     LIValidator validator;
 937     validator = std::for_each(Entering.begin(), Entering.end(), validator);
 938     validator = std::for_each(Internal.begin(), Internal.end(), validator);
 939     validator = std::for_each(Exiting.begin(), Exiting.end(), validator);
 940     assert(validator.rangesOk() && "moveAllOperandsInto broke liveness.");
 941 #endif
 942   }
 943
 944 private:
 945
 946 #ifndef NDEBUG
 947   class LIValidator {
 948   private:
 949     DenseSet<const LiveInterval*> Checked, Bogus;
 950   public:
 951     void operator()(const IntRangePair& P) {
 952       const LiveInterval* LI = P.first;
 953       if (Checked.count(LI))
 954         return;
 955       Checked.insert(LI);
 956       if (LI->empty())
 957         return;
 958       SlotIndex LastEnd = LI->begin()->start;
 959       for (LiveInterval::const_iterator LRI = LI->begin(), LRE = LI->end();
 960            LRI != LRE; ++LRI) {
 961         const LiveRange& LR = *LRI;
 962         if (LastEnd > LR.start || LR.start >= LR.end)
 963           Bogus.insert(LI);
 964         LastEnd = LR.end;
 965       }
 966     }
 967
 968     bool rangesOk() const {
 969       return Bogus.empty();
 970     }
 971   };
 972 #endif
 973
 974   // Collect IntRangePairs for all operands of MI that may need fixing.
 975   // Treat's MI's index as OldIdx (regardless of what it is in SlotIndexes'
 976   // maps).
 977   void collectRanges(MachineInstr* MI, RangeSet& Entering, RangeSet& Internal,
 978                      RangeSet& Exiting, bool& hasRegMaskOp, SlotIndex OldIdx) {
 979     hasRegMaskOp = false;
 980     for (MachineInstr::mop_iterator MOI = MI->operands_begin(),
 981                                     MOE = MI->operands_end();
 982          MOI != MOE; ++MOI) {
 983       const MachineOperand& MO = *MOI;
 984
 985       if (MO.isRegMask()) {
 986         hasRegMaskOp = true;
 987         continue;
 988       }
 989
 990       if (!MO.isReg() || MO.getReg() == 0)
 991         continue;
 992
 993       unsigned Reg = MO.getReg();
 994
 995       // TODO: Currently we're skipping uses that are reserved or have no
 996       // interval, but we're not updating their kills. This should be
 997       // fixed.
 998       if (TargetRegisterInfo::isPhysicalRegister(Reg) && LIS.isReserved(Reg))
 999         continue;
1000
1001       // Collect ranges for register units. These live ranges are computed on
1002       // demand, so just skip any that haven't been computed yet.
1003       if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
1004         for (MCRegUnitIterator Units(Reg, &TRI); Units.isValid(); ++Units)
1005           if (LiveInterval *LI = LIS.getCachedRegUnit(*Units))
1006             collectRanges(MO, LI, Entering, Internal, Exiting, OldIdx);
1007       } else {
1008         // Collect ranges for individual virtual registers.
1009         collectRanges(MO, &LIS.getInterval(Reg),
1010                       Entering, Internal, Exiting, OldIdx);
1011       }
1012     }
1013   }
1014
1015   void collectRanges(const MachineOperand &MO, LiveInterval *LI,
1016                      RangeSet &Entering, RangeSet &Internal, RangeSet &Exiting,
1017                      SlotIndex OldIdx) {
1018     if (MO.readsReg()) {
1019       LiveRange* LR = LI->getLiveRangeContaining(OldIdx);
1020       if (LR != 0)
1021         Entering.insert(std::make_pair(LI, LR));
1022     }
1023     if (MO.isDef()) {
1024       LiveRange* LR = LI->getLiveRangeContaining(OldIdx.getRegSlot());
1025       assert(LR != 0 && "No live range for def?");
1026       if (LR->end > OldIdx.getDeadSlot())
1027         Exiting.insert(std::make_pair(LI, LR));
1028       else
1029         Internal.insert(std::make_pair(LI, LR));
1030     }
1031   }
1032
1033   BundleRanges createBundleRanges(RangeSet& Entering,
1034                                   RangeSet& Internal,
1035                                   RangeSet& Exiting) {
1036     BundleRanges BR;
1037
1038     for (RangeSet::iterator EI = Entering.begin(), EE = Entering.end();
1039          EI != EE; ++EI) {
1040       LiveInterval* LI = EI->first;
1041       LiveRange* LR = EI->second;
1042       BR[LI->reg].Use = LR;
1043     }
1044
1045     for (RangeSet::iterator II = Internal.begin(), IE = Internal.end();
1046          II != IE; ++II) {
1047       LiveInterval* LI = II->first;
1048       LiveRange* LR = II->second;
1049       if (LR->end.isDead()) {
1050         BR[LI->reg].Dead = LR;
1051       } else {
1052         BR[LI->reg].EC = LR;
1053       }
1054     }
1055
1056     for (RangeSet::iterator EI = Exiting.begin(), EE = Exiting.end();
1057          EI != EE; ++EI) {
1058       LiveInterval* LI = EI->first;
1059       LiveRange* LR = EI->second;
1060       BR[LI->reg].Def = LR;
1061     }
1062
1063     return BR;
1064   }
1065
1066   void moveKillFlags(unsigned reg, SlotIndex OldIdx, SlotIndex newKillIdx) {
1067     MachineInstr* OldKillMI = LIS.getInstructionFromIndex(OldIdx);
1068     if (!OldKillMI->killsRegister(reg))
1069       return; // Bail out if we don't have kill flags on the old register.
1070     MachineInstr* NewKillMI = LIS.getInstructionFromIndex(newKillIdx);
1071     assert(OldKillMI->killsRegister(reg) && "Old 'kill' instr isn't a kill.");
1072     assert(!NewKillMI->killsRegister(reg) &&
1073            "New kill instr is already a kill.");
1074     OldKillMI->clearRegisterKills(reg, &TRI);
1075     NewKillMI->addRegisterKilled(reg, &TRI);
1076   }
1077
1078   void updateRegMaskSlots(SlotIndex OldIdx) {
1079     SmallVectorImpl<SlotIndex>::iterator RI =
1080       std::lower_bound(LIS.RegMaskSlots.begin(), LIS.RegMaskSlots.end(),
1081                        OldIdx);
1082     assert(*RI == OldIdx && "No RegMask at OldIdx.");
1083     *RI = NewIdx;
1084     assert(*prior(RI) < *RI && *RI < *next(RI) &&
1085            "RegSlots out of order. Did you move one call across another?");
1086   }
1087
1088   // Return the last use of reg between NewIdx and OldIdx.
1089   SlotIndex findLastUseBefore(unsigned Reg, SlotIndex OldIdx) {
1090     SlotIndex LastUse = NewIdx;
1091     for (MachineRegisterInfo::use_nodbg_iterator
1092            UI = MRI.use_nodbg_begin(Reg),
1093            UE = MRI.use_nodbg_end();
1094          UI != UE; UI.skipInstruction()) {
1095       const MachineInstr* MI = &*UI;
1096       SlotIndex InstSlot = LIS.getSlotIndexes()->getInstructionIndex(MI);
1097       if (InstSlot > LastUse && InstSlot < OldIdx)
1098         LastUse = InstSlot;
1099     }
1100     return LastUse;
1101   }
1102
1103   void moveEnteringUpFrom(SlotIndex OldIdx, IntRangePair& P) {
1104     LiveInterval* LI = P.first;
1105     LiveRange* LR = P.second;
1106     bool LiveThrough = LR->end > OldIdx.getRegSlot();
1107     if (LiveThrough)
1108       return;
1109     SlotIndex LastUse = findLastUseBefore(LI->reg, OldIdx);
1110     if (LastUse != NewIdx)
1111       moveKillFlags(LI->reg, NewIdx, LastUse);
1112     LR->end = LastUse.getRegSlot();
1113   }
1114
1115   void moveEnteringDownFrom(SlotIndex OldIdx, IntRangePair& P) {
1116     LiveInterval* LI = P.first;
1117     LiveRange* LR = P.second;
1118     // Extend the LiveRange if NewIdx is past the end.
1119     if (NewIdx > LR->end) {
1120       // Move kill flags if OldIdx was not originally the end
1121       // (otherwise LR->end points to an invalid slot).
1122       if (LR->end.getRegSlot() != OldIdx.getRegSlot()) {
1123         assert(LR->end > OldIdx && "LiveRange does not cover original slot");
1124         moveKillFlags(LI->reg, LR->end, NewIdx);
1125       }
1126       LR->end = NewIdx.getRegSlot();
1127     }
1128   }
1129
1130   void moveAllEnteringFrom(SlotIndex OldIdx, RangeSet& Entering) {
1131     bool GoingUp = NewIdx < OldIdx;
1132
1133     if (GoingUp) {
1134       for (RangeSet::iterator EI = Entering.begin(), EE = Entering.end();
1135            EI != EE; ++EI)
1136         moveEnteringUpFrom(OldIdx, *EI);
1137     } else {
1138       for (RangeSet::iterator EI = Entering.begin(), EE = Entering.end();
1139            EI != EE; ++EI)
1140         moveEnteringDownFrom(OldIdx, *EI);
1141     }
1142   }
1143
1144   void moveInternalFrom(SlotIndex OldIdx, IntRangePair& P) {
1145     LiveInterval* LI = P.first;
1146     LiveRange* LR = P.second;
1147     assert(OldIdx < LR->start && LR->start < OldIdx.getDeadSlot() &&
1148            LR->end <= OldIdx.getDeadSlot() &&
1149            "Range should be internal to OldIdx.");
1150     LiveRange Tmp(*LR);
1151     Tmp.start = NewIdx.getRegSlot(LR->start.isEarlyClobber());
1152     Tmp.valno->def = Tmp.start;
1153     Tmp.end = LR->end.isDead() ? NewIdx.getDeadSlot() : NewIdx.getRegSlot();
1154     LI->removeRange(*LR);
1155     LI->addRange(Tmp);
1156   }
1157
1158   void moveAllInternalFrom(SlotIndex OldIdx, RangeSet& Internal) {
1159     for (RangeSet::iterator II = Internal.begin(), IE = Internal.end();
1160          II != IE; ++II)
1161       moveInternalFrom(OldIdx, *II);
1162   }
1163
1164   void moveExitingFrom(SlotIndex OldIdx, IntRangePair& P) {
1165     LiveRange* LR = P.second;
1166     assert(OldIdx < LR->start && LR->start < OldIdx.getDeadSlot() &&
1167            "Range should start in OldIdx.");
1168     assert(LR->end > OldIdx.getDeadSlot() && "Range should exit OldIdx.");
1169     SlotIndex NewStart = NewIdx.getRegSlot(LR->start.isEarlyClobber());
1170     LR->start = NewStart;
1171     LR->valno->def = NewStart;
1172   }
1173
1174   void moveAllExitingFrom(SlotIndex OldIdx, RangeSet& Exiting) {
1175     for (RangeSet::iterator EI = Exiting.begin(), EE = Exiting.end();
1176          EI != EE; ++EI)
1177       moveExitingFrom(OldIdx, *EI);
1178   }
1179
1180   void moveEnteringUpFromInto(SlotIndex OldIdx, IntRangePair& P,
1181                               BundleRanges& BR) {
1182     LiveInterval* LI = P.first;
1183     LiveRange* LR = P.second;
1184     bool LiveThrough = LR->end > OldIdx.getRegSlot();
1185     if (LiveThrough) {
1186       assert((LR->start < NewIdx || BR[LI->reg].Def == LR) &&
1187              "Def in bundle should be def range.");
1188       assert((BR[LI->reg].Use == 0 || BR[LI->reg].Use == LR) &&
1189              "If bundle has use for this reg it should be LR.");
1190       BR[LI->reg].Use = LR;
1191       return;
1192     }
1193
1194     SlotIndex LastUse = findLastUseBefore(LI->reg, OldIdx);
1195     moveKillFlags(LI->reg, OldIdx, LastUse);
1196
1197     if (LR->start < NewIdx) {
1198       // Becoming a new entering range.
1199       assert(BR[LI->reg].Dead == 0 && BR[LI->reg].Def == 0 &&
1200              "Bundle shouldn't be re-defining reg mid-range.");
1201       assert((BR[LI->reg].Use == 0 || BR[LI->reg].Use == LR) &&
1202              "Bundle shouldn't have different use range for same reg.");
1203       LR->end = LastUse.getRegSlot();
1204       BR[LI->reg].Use = LR;
1205     } else {
1206       // Becoming a new Dead-def.
1207       assert(LR->start == NewIdx.getRegSlot(LR->start.isEarlyClobber()) &&
1208              "Live range starting at unexpected slot.");
1209       assert(BR[LI->reg].Def == LR && "Reg should have def range.");
1210       assert(BR[LI->reg].Dead == 0 &&
1211                "Can't have def and dead def of same reg in a bundle.");
1212       LR->end = LastUse.getDeadSlot();
1213       BR[LI->reg].Dead = BR[LI->reg].Def;
1214       BR[LI->reg].Def = 0;
1215     }
1216   }
1217
1218   void moveEnteringDownFromInto(SlotIndex OldIdx, IntRangePair& P,
1219                                 BundleRanges& BR) {
1220     LiveInterval* LI = P.first;
1221     LiveRange* LR = P.second;
1222     if (NewIdx > LR->end) {
1223       // Range extended to bundle. Add to bundle uses.
1224       // Note: Currently adds kill flags to bundle start.
1225       assert(BR[LI->reg].Use == 0 &&
1226              "Bundle already has use range for reg.");
1227       moveKillFlags(LI->reg, LR->end, NewIdx);
1228       LR->end = NewIdx.getRegSlot();
1229       BR[LI->reg].Use = LR;
1230     } else {
1231       assert(BR[LI->reg].Use != 0 &&
1232              "Bundle should already have a use range for reg.");
1233     }
1234   }
1235
1236   void moveAllEnteringFromInto(SlotIndex OldIdx, RangeSet& Entering,
1237                                BundleRanges& BR) {
1238     bool GoingUp = NewIdx < OldIdx;
1239
1240     if (GoingUp) {
1241       for (RangeSet::iterator EI = Entering.begin(), EE = Entering.end();
1242            EI != EE; ++EI)
1243         moveEnteringUpFromInto(OldIdx, *EI, BR);
1244     } else {
1245       for (RangeSet::iterator EI = Entering.begin(), EE = Entering.end();
1246            EI != EE; ++EI)
1247         moveEnteringDownFromInto(OldIdx, *EI, BR);
1248     }
1249   }
1250
1251   void moveInternalFromInto(SlotIndex OldIdx, IntRangePair& P,
1252                             BundleRanges& BR) {
1253     // TODO: Sane rules for moving ranges into bundles.
1254   }
1255
1256   void moveAllInternalFromInto(SlotIndex OldIdx, RangeSet& Internal,
1257                                BundleRanges& BR) {
1258     for (RangeSet::iterator II = Internal.begin(), IE = Internal.end();
1259          II != IE; ++II)
1260       moveInternalFromInto(OldIdx, *II, BR);
1261   }
1262
1263   void moveExitingFromInto(SlotIndex OldIdx, IntRangePair& P,
1264                            BundleRanges& BR) {
1265     LiveInterval* LI = P.first;
1266     LiveRange* LR = P.second;
1267
1268     assert(LR->start.isRegister() &&
1269            "Don't know how to merge exiting ECs into bundles yet.");
1270
1271     if (LR->end > NewIdx.getDeadSlot()) {
1272       // This range is becoming an exiting range on the bundle.
1273       // If there was an old dead-def of this reg, delete it.
1274       if (BR[LI->reg].Dead != 0) {
1275         LI->removeRange(*BR[LI->reg].Dead);
1276         BR[LI->reg].Dead = 0;
1277       }
1278       assert(BR[LI->reg].Def == 0 &&
1279              "Can't have two defs for the same variable exiting a bundle.");
1280       LR->start = NewIdx.getRegSlot();
1281       LR->valno->def = LR->start;
1282       BR[LI->reg].Def = LR;
1283     } else {
1284       // This range is becoming internal to the bundle.
1285       assert(LR->end == NewIdx.getRegSlot() &&
1286              "Can't bundle def whose kill is before the bundle");
1287       if (BR[LI->reg].Dead || BR[LI->reg].Def) {
1288         // Already have a def for this. Just delete range.
1289         LI->removeRange(*LR);
1290       } else {
1291         // Make range dead, record.
1292         LR->end = NewIdx.getDeadSlot();
1293         BR[LI->reg].Dead = LR;
1294         assert(BR[LI->reg].Use == LR &&
1295                "Range becoming dead should currently be use.");
1296       }
1297       // In both cases the range is no longer a use on the bundle.
1298       BR[LI->reg].Use = 0;
1299     }
1300   }
1301
1302   void moveAllExitingFromInto(SlotIndex OldIdx, RangeSet& Exiting,
1303                               BundleRanges& BR) {
1304     for (RangeSet::iterator EI = Exiting.begin(), EE = Exiting.end();
1305          EI != EE; ++EI)
1306       moveExitingFromInto(OldIdx, *EI, BR);
1307   }
1308
1309 };
1310
1311 void LiveIntervals::handleMove(MachineInstr* MI) {
1312   SlotIndex OldIndex = Indexes->getInstructionIndex(MI);
1313   Indexes->removeMachineInstrFromMaps(MI);
1314   SlotIndex NewIndex = MI->isInsideBundle() ?
1315                         Indexes->getInstructionIndex(MI) :
1316                         Indexes->insertMachineInstrInMaps(MI);
1317   assert(getMBBStartIdx(MI->getParent()) <= OldIndex &&
1318          OldIndex < getMBBEndIdx(MI->getParent()) &&
1319          "Cannot handle moves across basic block boundaries.");
1320   assert(!MI->isBundled() && "Can't handle bundled instructions yet.");
1321
1322   HMEditor HME(*this, *MRI, *TRI, NewIndex);
1323   HME.moveAllRangesFrom(MI, OldIndex);
1324 }
1325
1326 void LiveIntervals::handleMoveIntoBundle(MachineInstr* MI,
1327                                          MachineInstr* BundleStart) {
1328   SlotIndex NewIndex = Indexes->getInstructionIndex(BundleStart);
1329   HMEditor HME(*this, *MRI, *TRI, NewIndex);
1330   HME.moveAllRangesInto(MI, BundleStart);
1331 }