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