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 /// shrinkToUses - After removing some uses of a register, shrink its live
 630 /// range to just the remaining uses. This method does not compute reaching
 631 /// defs for new uses, and it doesn't remove dead defs.
 632 bool LiveIntervals::shrinkToUses(LiveInterval *li,
 633                                  SmallVectorImpl<MachineInstr*> *dead) {
 634   DEBUG(dbgs() << "Shrink: " << *li << '\n');
 635   assert(TargetRegisterInfo::isVirtualRegister(li->reg)
 636          && "Can only shrink virtual registers");
 637   // Find all the values used, including PHI kills.
 638   SmallVector<std::pair<SlotIndex, VNInfo*>, 16> WorkList;
 639
 640   // Blocks that have already been added to WorkList as live-out.
 641   SmallPtrSet<MachineBasicBlock*, 16> LiveOut;
 642
 643   // Visit all instructions reading li->reg.
 644   for (MachineRegisterInfo::reg_iterator I = MRI->reg_begin(li->reg);
 645        MachineInstr *UseMI = I.skipInstruction();) {
 646     if (UseMI->isDebugValue() || !UseMI->readsVirtualRegister(li->reg))
 647       continue;
 648     SlotIndex Idx = getInstructionIndex(UseMI).getRegSlot();
 649     LiveRangeQuery LRQ(*li, Idx);
 650     VNInfo *VNI = LRQ.valueIn();
 651     if (!VNI) {
 652       // This shouldn't happen: readsVirtualRegister returns true, but there is
 653       // no live value. It is likely caused by a target getting <undef> flags
 654       // wrong.
 655       DEBUG(dbgs() << Idx << '\t' << *UseMI
 656                    << "Warning: Instr claims to read non-existent value in "
 657                     << *li << '\n');
 658       continue;
 659     }
 660     // Special case: An early-clobber tied operand reads and writes the
 661     // register one slot early.
 662     if (VNInfo *DefVNI = LRQ.valueDefined())
 663       Idx = DefVNI->def;
 664
 665     WorkList.push_back(std::make_pair(Idx, VNI));
 666   }
 667
 668   // Create a new live interval with only minimal live segments per def.
 669   LiveInterval NewLI(li->reg, 0);
 670   for (LiveInterval::vni_iterator I = li->vni_begin(), E = li->vni_end();
 671        I != E; ++I) {
 672     VNInfo *VNI = *I;
 673     if (VNI->isUnused())
 674       continue;
 675     NewLI.addRange(LiveRange(VNI->def, VNI->def.getDeadSlot(), VNI));
 676   }
 677
 678   // Keep track of the PHIs that are in use.
 679   SmallPtrSet<VNInfo*, 8> UsedPHIs;
 680
 681   // Extend intervals to reach all uses in WorkList.
 682   while (!WorkList.empty()) {
 683     SlotIndex Idx = WorkList.back().first;
 684     VNInfo *VNI = WorkList.back().second;
 685     WorkList.pop_back();
 686     const MachineBasicBlock *MBB = getMBBFromIndex(Idx.getPrevSlot());
 687     SlotIndex BlockStart = getMBBStartIdx(MBB);
 688
 689     // Extend the live range for VNI to be live at Idx.
 690     if (VNInfo *ExtVNI = NewLI.extendInBlock(BlockStart, Idx)) {
 691       (void)ExtVNI;
 692       assert(ExtVNI == VNI && "Unexpected existing value number");
 693       // Is this a PHIDef we haven't seen before?
 694       if (!VNI->isPHIDef() || VNI->def != BlockStart || !UsedPHIs.insert(VNI))
 695         continue;
 696       // The PHI is live, make sure the predecessors are live-out.
 697       for (MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(),
 698            PE = MBB->pred_end(); PI != PE; ++PI) {
 699         if (!LiveOut.insert(*PI))
 700           continue;
 701         SlotIndex Stop = getMBBEndIdx(*PI);
 702         // A predecessor is not required to have a live-out value for a PHI.
 703         if (VNInfo *PVNI = li->getVNInfoBefore(Stop))
 704           WorkList.push_back(std::make_pair(Stop, PVNI));
 705       }
 706       continue;
 707     }
 708
 709     // VNI is live-in to MBB.
 710     DEBUG(dbgs() << " live-in at " << BlockStart << '\n');
 711     NewLI.addRange(LiveRange(BlockStart, Idx, VNI));
 712
 713     // Make sure VNI is live-out from the predecessors.
 714     for (MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(),
 715          PE = MBB->pred_end(); PI != PE; ++PI) {
 716       if (!LiveOut.insert(*PI))
 717         continue;
 718       SlotIndex Stop = getMBBEndIdx(*PI);
 719       assert(li->getVNInfoBefore(Stop) == VNI &&
 720              "Wrong value out of predecessor");
 721       WorkList.push_back(std::make_pair(Stop, VNI));
 722     }
 723   }
 724
 725   // Handle dead values.
 726   bool CanSeparate = false;
 727   for (LiveInterval::vni_iterator I = li->vni_begin(), E = li->vni_end();
 728        I != E; ++I) {
 729     VNInfo *VNI = *I;
 730     if (VNI->isUnused())
 731       continue;
 732     LiveInterval::iterator LII = NewLI.FindLiveRangeContaining(VNI->def);
 733     assert(LII != NewLI.end() && "Missing live range for PHI");
 734     if (LII->end != VNI->def.getDeadSlot())
 735       continue;
 736     if (VNI->isPHIDef()) {
 737       // This is a dead PHI. Remove it.
 738       VNI->setIsUnused(true);
 739       NewLI.removeRange(*LII);
 740       DEBUG(dbgs() << "Dead PHI at " << VNI->def << " may separate interval\n");
 741       CanSeparate = true;
 742     } else {
 743       // This is a dead def. Make sure the instruction knows.
 744       MachineInstr *MI = getInstructionFromIndex(VNI->def);
 745       assert(MI && "No instruction defining live value");
 746       MI->addRegisterDead(li->reg, TRI);
 747       if (dead && MI->allDefsAreDead()) {
 748         DEBUG(dbgs() << "All defs dead: " << VNI->def << '\t' << *MI);
 749         dead->push_back(MI);
 750       }
 751     }
 752   }
 753
 754   // Move the trimmed ranges back.
 755   li->ranges.swap(NewLI.ranges);
 756   DEBUG(dbgs() << "Shrunk: " << *li << '\n');
 757   return CanSeparate;
 758 }
 759
 760
 761 //===----------------------------------------------------------------------===//
 762 // Register allocator hooks.
 763 //
 764
 765 void LiveIntervals::addKillFlags() {
 766   for (iterator I = begin(), E = end(); I != E; ++I) {
 767     unsigned Reg = I->first;
 768     if (TargetRegisterInfo::isPhysicalRegister(Reg))
 769       continue;
 770     if (MRI->reg_nodbg_empty(Reg))
 771       continue;
 772     LiveInterval *LI = I->second;
 773
 774     // Every instruction that kills Reg corresponds to a live range end point.
 775     for (LiveInterval::iterator RI = LI->begin(), RE = LI->end(); RI != RE;
 776          ++RI) {
 777       // A block index indicates an MBB edge.
 778       if (RI->end.isBlock())
 779         continue;
 780       MachineInstr *MI = getInstructionFromIndex(RI->end);
 781       if (!MI)
 782         continue;
 783       MI->addRegisterKilled(Reg, NULL);
 784     }
 785   }
 786 }
 787
 788 MachineBasicBlock*
 789 LiveIntervals::intervalIsInOneMBB(const LiveInterval &LI) const {
 790   // A local live range must be fully contained inside the block, meaning it is
 791   // defined and killed at instructions, not at block boundaries. It is not
 792   // live in or or out of any block.
 793   //
 794   // It is technically possible to have a PHI-defined live range identical to a
 795   // single block, but we are going to return false in that case.
 796
 797   SlotIndex Start = LI.beginIndex();
 798   if (Start.isBlock())
 799     return NULL;
 800
 801   SlotIndex Stop = LI.endIndex();
 802   if (Stop.isBlock())
 803     return NULL;
 804
 805   // getMBBFromIndex doesn't need to search the MBB table when both indexes
 806   // belong to proper instructions.
 807   MachineBasicBlock *MBB1 = Indexes->getMBBFromIndex(Start);
 808   MachineBasicBlock *MBB2 = Indexes->getMBBFromIndex(Stop);
 809   return MBB1 == MBB2 ? MBB1 : NULL;
 810 }
 811
 812 float
 813 LiveIntervals::getSpillWeight(bool isDef, bool isUse, unsigned loopDepth) {
 814   // Limit the loop depth ridiculousness.
 815   if (loopDepth > 200)
 816     loopDepth = 200;
 817
 818   // The loop depth is used to roughly estimate the number of times the
 819   // instruction is executed. Something like 10^d is simple, but will quickly
 820   // overflow a float. This expression behaves like 10^d for small d, but is
 821   // more tempered for large d. At d=200 we get 6.7e33 which leaves a bit of
 822   // headroom before overflow.
 823   // By the way, powf() might be unavailable here. For consistency,
 824   // We may take pow(double,double).
 825   float lc = std::pow(1 + (100.0 / (loopDepth + 10)), (double)loopDepth);
 826
 827   return (isDef + isUse) * lc;
 828 }
 829
 830 LiveRange LiveIntervals::addLiveRangeToEndOfBlock(unsigned reg,
 831                                                   MachineInstr* startInst) {
 832   LiveInterval& Interval = getOrCreateInterval(reg);
 833   VNInfo* VN = Interval.getNextValue(
 834     SlotIndex(getInstructionIndex(startInst).getRegSlot()),
 835     getVNInfoAllocator());
 836   VN->setHasPHIKill(true);
 837   LiveRange LR(
 838      SlotIndex(getInstructionIndex(startInst).getRegSlot()),
 839      getMBBEndIdx(startInst->getParent()), VN);
 840   Interval.addRange(LR);
 841
 842   return LR;
 843 }
 844
 845
 846 //===----------------------------------------------------------------------===//
 847 //                          Register mask functions
 848 //===----------------------------------------------------------------------===//
 849
 850 bool LiveIntervals::checkRegMaskInterference(LiveInterval &LI,
 851                                              BitVector &UsableRegs) {
 852   if (LI.empty())
 853     return false;
 854   LiveInterval::iterator LiveI = LI.begin(), LiveE = LI.end();
 855
 856   // Use a smaller arrays for local live ranges.
 857   ArrayRef<SlotIndex> Slots;
 858   ArrayRef<const uint32_t*> Bits;
 859   if (MachineBasicBlock *MBB = intervalIsInOneMBB(LI)) {
 860     Slots = getRegMaskSlotsInBlock(MBB->getNumber());
 861     Bits = getRegMaskBitsInBlock(MBB->getNumber());
 862   } else {
 863     Slots = getRegMaskSlots();
 864     Bits = getRegMaskBits();
 865   }
 866
 867   // We are going to enumerate all the register mask slots contained in LI.
 868   // Start with a binary search of RegMaskSlots to find a starting point.
 869   ArrayRef<SlotIndex>::iterator SlotI =
 870     std::lower_bound(Slots.begin(), Slots.end(), LiveI->start);
 871   ArrayRef<SlotIndex>::iterator SlotE = Slots.end();
 872
 873   // No slots in range, LI begins after the last call.
 874   if (SlotI == SlotE)
 875     return false;
 876
 877   bool Found = false;
 878   for (;;) {
 879     assert(*SlotI >= LiveI->start);
 880     // Loop over all slots overlapping this segment.
 881     while (*SlotI < LiveI->end) {
 882       // *SlotI overlaps LI. Collect mask bits.
 883       if (!Found) {
 884         // This is the first overlap. Initialize UsableRegs to all ones.
 885         UsableRegs.clear();
 886         UsableRegs.resize(TRI->getNumRegs(), true);
 887         Found = true;
 888       }
 889       // Remove usable registers clobbered by this mask.
 890       UsableRegs.clearBitsNotInMask(Bits[SlotI-Slots.begin()]);
 891       if (++SlotI == SlotE)
 892         return Found;
 893     }
 894     // *SlotI is beyond the current LI segment.
 895     LiveI = LI.advanceTo(LiveI, *SlotI);
 896     if (LiveI == LiveE)
 897       return Found;
 898     // Advance SlotI until it overlaps.
 899     while (*SlotI < LiveI->start)
 900       if (++SlotI == SlotE)
 901         return Found;
 902   }
 903 }
 904
 905 //===----------------------------------------------------------------------===//
 906 //                         IntervalUpdate class.
 907 //===----------------------------------------------------------------------===//
 908
 909 // HMEditor is a toolkit used by handleMove to trim or extend live intervals.
 910 class LiveIntervals::HMEditor {
 911 private:
 912   LiveIntervals& LIS;
 913   const MachineRegisterInfo& MRI;
 914   const TargetRegisterInfo& TRI;
 915   SlotIndex NewIdx;
 916
 917   typedef std::pair<LiveInterval*, LiveRange*> IntRangePair;
 918   typedef DenseSet<IntRangePair> RangeSet;
 919
 920   struct RegRanges {
 921     LiveRange* Use;
 922     LiveRange* EC;
 923     LiveRange* Dead;
 924     LiveRange* Def;
 925     RegRanges() : Use(0), EC(0), Dead(0), Def(0) {}
 926   };
 927   typedef DenseMap<unsigned, RegRanges> BundleRanges;
 928
 929 public:
 930   HMEditor(LiveIntervals& LIS, const MachineRegisterInfo& MRI,
 931            const TargetRegisterInfo& TRI, SlotIndex NewIdx)
 932     : LIS(LIS), MRI(MRI), TRI(TRI), NewIdx(NewIdx) {}
 933
 934   // Update intervals for all operands of MI from OldIdx to NewIdx.
 935   // This assumes that MI used to be at OldIdx, and now resides at
 936   // NewIdx.
 937   void moveAllRangesFrom(MachineInstr* MI, SlotIndex OldIdx) {
 938     assert(NewIdx != OldIdx && "No-op move? That's a bit strange.");
 939
 940     // Collect the operands.
 941     RangeSet Entering, Internal, Exiting;
 942     bool hasRegMaskOp = false;
 943     collectRanges(MI, Entering, Internal, Exiting, hasRegMaskOp, OldIdx);
 944
 945     // To keep the LiveRanges valid within an interval, move the ranges closest
 946     // to the destination first. This prevents ranges from overlapping, to that
 947     // APIs like removeRange still work.
 948     if (NewIdx < OldIdx) {
 949       moveAllEnteringFrom(OldIdx, Entering);
 950       moveAllInternalFrom(OldIdx, Internal);
 951       moveAllExitingFrom(OldIdx, Exiting);
 952     }
 953     else {
 954       moveAllExitingFrom(OldIdx, Exiting);
 955       moveAllInternalFrom(OldIdx, Internal);
 956       moveAllEnteringFrom(OldIdx, Entering);
 957     }
 958
 959     if (hasRegMaskOp)
 960       updateRegMaskSlots(OldIdx);
 961
 962 #ifndef NDEBUG
 963     LIValidator validator;
 964     validator = std::for_each(Entering.begin(), Entering.end(), validator);
 965     validator = std::for_each(Internal.begin(), Internal.end(), validator);
 966     validator = std::for_each(Exiting.begin(), Exiting.end(), validator);
 967     assert(validator.rangesOk() && "moveAllOperandsFrom broke liveness.");
 968 #endif
 969
 970   }
 971
 972   // Update intervals for all operands of MI to refer to BundleStart's
 973   // SlotIndex.
 974   void moveAllRangesInto(MachineInstr* MI, MachineInstr* BundleStart) {
 975     if (MI == BundleStart)
 976       return; // Bundling instr with itself - nothing to do.
 977
 978     SlotIndex OldIdx = LIS.getSlotIndexes()->getInstructionIndex(MI);
 979     assert(LIS.getSlotIndexes()->getInstructionFromIndex(OldIdx) == MI &&
 980            "SlotIndex <-> Instruction mapping broken for MI");
 981
 982     // Collect all ranges already in the bundle.
 983     MachineBasicBlock::instr_iterator BII(BundleStart);
 984     RangeSet Entering, Internal, Exiting;
 985     bool hasRegMaskOp = false;
 986     collectRanges(BII, Entering, Internal, Exiting, hasRegMaskOp, NewIdx);
 987     assert(!hasRegMaskOp && "Can't have RegMask operand in bundle.");
 988     for (++BII; &*BII == MI || BII->isInsideBundle(); ++BII) {
 989       if (&*BII == MI)
 990         continue;
 991       collectRanges(BII, Entering, Internal, Exiting, hasRegMaskOp, NewIdx);
 992       assert(!hasRegMaskOp && "Can't have RegMask operand in bundle.");
 993     }
 994
 995     BundleRanges BR = createBundleRanges(Entering, Internal, Exiting);
 996
 997     Entering.clear();
 998     Internal.clear();
 999     Exiting.clear();
1000     collectRanges(MI, Entering, Internal, Exiting, hasRegMaskOp, OldIdx);
1001     assert(!hasRegMaskOp && "Can't have RegMask operand in bundle.");
1002
1003     DEBUG(dbgs() << "Entering: " << Entering.size() << "\n");
1004     DEBUG(dbgs() << "Internal: " << Internal.size() << "\n");
1005     DEBUG(dbgs() << "Exiting: " << Exiting.size() << "\n");
1006
1007     moveAllEnteringFromInto(OldIdx, Entering, BR);
1008     moveAllInternalFromInto(OldIdx, Internal, BR);
1009     moveAllExitingFromInto(OldIdx, Exiting, BR);
1010
1011
1012 #ifndef NDEBUG
1013     LIValidator validator;
1014     validator = std::for_each(Entering.begin(), Entering.end(), validator);
1015     validator = std::for_each(Internal.begin(), Internal.end(), validator);
1016     validator = std::for_each(Exiting.begin(), Exiting.end(), validator);
1017     assert(validator.rangesOk() && "moveAllOperandsInto broke liveness.");
1018 #endif
1019   }
1020
1021 private:
1022
1023 #ifndef NDEBUG
1024   class LIValidator {
1025   private:
1026     DenseSet<const LiveInterval*> Checked, Bogus;
1027   public:
1028     void operator()(const IntRangePair& P) {
1029       const LiveInterval* LI = P.first;
1030       if (Checked.count(LI))
1031         return;
1032       Checked.insert(LI);
1033       if (LI->empty())
1034         return;
1035       SlotIndex LastEnd = LI->begin()->start;
1036       for (LiveInterval::const_iterator LRI = LI->begin(), LRE = LI->end();
1037            LRI != LRE; ++LRI) {
1038         const LiveRange& LR = *LRI;
1039         if (LastEnd > LR.start || LR.start >= LR.end)
1040           Bogus.insert(LI);
1041         LastEnd = LR.end;
1042       }
1043     }
1044
1045     bool rangesOk() const {
1046       return Bogus.empty();
1047     }
1048   };
1049 #endif
1050
1051   // Collect IntRangePairs for all operands of MI that may need fixing.
1052   // Treat's MI's index as OldIdx (regardless of what it is in SlotIndexes'
1053   // maps).
1054   void collectRanges(MachineInstr* MI, RangeSet& Entering, RangeSet& Internal,
1055                      RangeSet& Exiting, bool& hasRegMaskOp, SlotIndex OldIdx) {
1056     hasRegMaskOp = false;
1057     for (MachineInstr::mop_iterator MOI = MI->operands_begin(),
1058                                     MOE = MI->operands_end();
1059          MOI != MOE; ++MOI) {
1060       const MachineOperand& MO = *MOI;
1061
1062       if (MO.isRegMask()) {
1063         hasRegMaskOp = true;
1064         continue;
1065       }
1066
1067       if (!MO.isReg() || MO.getReg() == 0)
1068         continue;
1069
1070       unsigned Reg = MO.getReg();
1071
1072       // TODO: Currently we're skipping uses that are reserved or have no
1073       // interval, but we're not updating their kills. This should be
1074       // fixed.
1075       if (!LIS.hasInterval(Reg) ||
1076           (TargetRegisterInfo::isPhysicalRegister(Reg) && LIS.isReserved(Reg)))
1077         continue;
1078
1079       LiveInterval* LI = &LIS.getInterval(Reg);
1080
1081       if (MO.readsReg()) {
1082         LiveRange* LR = LI->getLiveRangeContaining(OldIdx);
1083         if (LR != 0)
1084           Entering.insert(std::make_pair(LI, LR));
1085       }
1086       if (MO.isDef()) {
1087         if (MO.isEarlyClobber()) {
1088           LiveRange* LR = LI->getLiveRangeContaining(OldIdx.getRegSlot(true));
1089           assert(LR != 0 && "No EC range?");
1090           if (LR->end > OldIdx.getDeadSlot())
1091             Exiting.insert(std::make_pair(LI, LR));
1092           else
1093             Internal.insert(std::make_pair(LI, LR));
1094         } else if (MO.isDead()) {
1095           LiveRange* LR = LI->getLiveRangeContaining(OldIdx.getRegSlot());
1096           assert(LR != 0 && "No dead-def range?");
1097           Internal.insert(std::make_pair(LI, LR));
1098         } else {
1099           LiveRange* LR = LI->getLiveRangeContaining(OldIdx.getDeadSlot());
1100           assert(LR && LR->end > OldIdx.getDeadSlot() &&
1101                  "Non-dead-def should have live range exiting.");
1102           Exiting.insert(std::make_pair(LI, LR));
1103         }
1104       }
1105     }
1106   }
1107
1108   // Collect IntRangePairs for all operands of MI that may need fixing.
1109   void collectRangesInBundle(MachineInstr* MI, RangeSet& Entering,
1110                              RangeSet& Exiting, SlotIndex MIStartIdx,
1111                              SlotIndex MIEndIdx) {
1112     for (MachineInstr::mop_iterator MOI = MI->operands_begin(),
1113                                     MOE = MI->operands_end();
1114          MOI != MOE; ++MOI) {
1115       const MachineOperand& MO = *MOI;
1116       assert(!MO.isRegMask() && "Can't have RegMasks in bundles.");
1117       if (!MO.isReg() || MO.getReg() == 0)
1118         continue;
1119
1120       unsigned Reg = MO.getReg();
1121
1122       // TODO: Currently we're skipping uses that are reserved or have no
1123       // interval, but we're not updating their kills. This should be
1124       // fixed.
1125       if (!LIS.hasInterval(Reg) ||
1126           (TargetRegisterInfo::isPhysicalRegister(Reg) && LIS.isReserved(Reg)))
1127         continue;
1128
1129       LiveInterval* LI = &LIS.getInterval(Reg);
1130
1131       if (MO.readsReg()) {
1132         LiveRange* LR = LI->getLiveRangeContaining(MIStartIdx);
1133         if (LR != 0)
1134           Entering.insert(std::make_pair(LI, LR));
1135       }
1136       if (MO.isDef()) {
1137         assert(!MO.isEarlyClobber() && "Early clobbers not allowed in bundles.");
1138         assert(!MO.isDead() && "Dead-defs not allowed in bundles.");
1139         LiveRange* LR = LI->getLiveRangeContaining(MIEndIdx.getDeadSlot());
1140         assert(LR != 0 && "Internal ranges not allowed in bundles.");
1141         Exiting.insert(std::make_pair(LI, LR));
1142       }
1143     }
1144   }
1145
1146   BundleRanges createBundleRanges(RangeSet& Entering, RangeSet& Internal, RangeSet& Exiting) {
1147     BundleRanges BR;
1148
1149     for (RangeSet::iterator EI = Entering.begin(), EE = Entering.end();
1150          EI != EE; ++EI) {
1151       LiveInterval* LI = EI->first;
1152       LiveRange* LR = EI->second;
1153       BR[LI->reg].Use = LR;
1154     }
1155
1156     for (RangeSet::iterator II = Internal.begin(), IE = Internal.end();
1157          II != IE; ++II) {
1158       LiveInterval* LI = II->first;
1159       LiveRange* LR = II->second;
1160       if (LR->end.isDead()) {
1161         BR[LI->reg].Dead = LR;
1162       } else {
1163         BR[LI->reg].EC = LR;
1164       }
1165     }
1166
1167     for (RangeSet::iterator EI = Exiting.begin(), EE = Exiting.end();
1168          EI != EE; ++EI) {
1169       LiveInterval* LI = EI->first;
1170       LiveRange* LR = EI->second;
1171       BR[LI->reg].Def = LR;
1172     }
1173
1174     return BR;
1175   }
1176
1177   void moveKillFlags(unsigned reg, SlotIndex OldIdx, SlotIndex newKillIdx) {
1178     MachineInstr* OldKillMI = LIS.getInstructionFromIndex(OldIdx);
1179     if (!OldKillMI->killsRegister(reg))
1180       return; // Bail out if we don't have kill flags on the old register.
1181     MachineInstr* NewKillMI = LIS.getInstructionFromIndex(newKillIdx);
1182     assert(OldKillMI->killsRegister(reg) && "Old 'kill' instr isn't a kill.");
1183     assert(!NewKillMI->killsRegister(reg) && "New kill instr is already a kill.");
1184     OldKillMI->clearRegisterKills(reg, &TRI);
1185     NewKillMI->addRegisterKilled(reg, &TRI);
1186   }
1187
1188   void updateRegMaskSlots(SlotIndex OldIdx) {
1189     SmallVectorImpl<SlotIndex>::iterator RI =
1190       std::lower_bound(LIS.RegMaskSlots.begin(), LIS.RegMaskSlots.end(),
1191                        OldIdx);
1192     assert(*RI == OldIdx && "No RegMask at OldIdx.");
1193     *RI = NewIdx;
1194     assert(*prior(RI) < *RI && *RI < *next(RI) &&
1195            "RegSlots out of order. Did you move one call across another?");
1196   }
1197
1198   // Return the last use of reg between NewIdx and OldIdx.
1199   SlotIndex findLastUseBefore(unsigned Reg, SlotIndex OldIdx) {
1200     SlotIndex LastUse = NewIdx;
1201     for (MachineRegisterInfo::use_nodbg_iterator
1202            UI = MRI.use_nodbg_begin(Reg),
1203            UE = MRI.use_nodbg_end();
1204          UI != UE; UI.skipInstruction()) {
1205       const MachineInstr* MI = &*UI;
1206       SlotIndex InstSlot = LIS.getSlotIndexes()->getInstructionIndex(MI);
1207       if (InstSlot > LastUse && InstSlot < OldIdx)
1208         LastUse = InstSlot;
1209     }
1210     return LastUse;
1211   }
1212
1213   void moveEnteringUpFrom(SlotIndex OldIdx, IntRangePair& P) {
1214     LiveInterval* LI = P.first;
1215     LiveRange* LR = P.second;
1216     bool LiveThrough = LR->end > OldIdx.getRegSlot();
1217     if (LiveThrough)
1218       return;
1219     SlotIndex LastUse = findLastUseBefore(LI->reg, OldIdx);
1220     if (LastUse != NewIdx)
1221       moveKillFlags(LI->reg, NewIdx, LastUse);
1222     LR->end = LastUse.getRegSlot();
1223   }
1224
1225   void moveEnteringDownFrom(SlotIndex OldIdx, IntRangePair& P) {
1226     LiveInterval* LI = P.first;
1227     LiveRange* LR = P.second;
1228     // Extend the LiveRange if NewIdx is past the end.
1229     if (NewIdx > LR->end) {
1230       // Move kill flags if OldIdx was not originally the end
1231       // (otherwise LR->end points to an invalid slot).
1232       if (LR->end.getRegSlot() != OldIdx.getRegSlot()) {
1233         assert(LR->end > OldIdx && "LiveRange does not cover original slot");
1234         moveKillFlags(LI->reg, LR->end, NewIdx);
1235       }
1236       LR->end = NewIdx.getRegSlot();
1237     }
1238   }
1239
1240   void moveAllEnteringFrom(SlotIndex OldIdx, RangeSet& Entering) {
1241     bool GoingUp = NewIdx < OldIdx;
1242
1243     if (GoingUp) {
1244       for (RangeSet::iterator EI = Entering.begin(), EE = Entering.end();
1245            EI != EE; ++EI)
1246         moveEnteringUpFrom(OldIdx, *EI);
1247     } else {
1248       for (RangeSet::iterator EI = Entering.begin(), EE = Entering.end();
1249            EI != EE; ++EI)
1250         moveEnteringDownFrom(OldIdx, *EI);
1251     }
1252   }
1253
1254   void moveInternalFrom(SlotIndex OldIdx, IntRangePair& P) {
1255     LiveInterval* LI = P.first;
1256     LiveRange* LR = P.second;
1257     assert(OldIdx < LR->start && LR->start < OldIdx.getDeadSlot() &&
1258            LR->end <= OldIdx.getDeadSlot() &&
1259            "Range should be internal to OldIdx.");
1260     LiveRange Tmp(*LR);
1261     Tmp.start = NewIdx.getRegSlot(LR->start.isEarlyClobber());
1262     Tmp.valno->def = Tmp.start;
1263     Tmp.end = LR->end.isDead() ? NewIdx.getDeadSlot() : NewIdx.getRegSlot();
1264     LI->removeRange(*LR);
1265     LI->addRange(Tmp);
1266   }
1267
1268   void moveAllInternalFrom(SlotIndex OldIdx, RangeSet& Internal) {
1269     for (RangeSet::iterator II = Internal.begin(), IE = Internal.end();
1270          II != IE; ++II)
1271       moveInternalFrom(OldIdx, *II);
1272   }
1273
1274   void moveExitingFrom(SlotIndex OldIdx, IntRangePair& P) {
1275     LiveRange* LR = P.second;
1276     assert(OldIdx < LR->start && LR->start < OldIdx.getDeadSlot() &&
1277            "Range should start in OldIdx.");
1278     assert(LR->end > OldIdx.getDeadSlot() && "Range should exit OldIdx.");
1279     SlotIndex NewStart = NewIdx.getRegSlot(LR->start.isEarlyClobber());
1280     LR->start = NewStart;
1281     LR->valno->def = NewStart;
1282   }
1283
1284   void moveAllExitingFrom(SlotIndex OldIdx, RangeSet& Exiting) {
1285     for (RangeSet::iterator EI = Exiting.begin(), EE = Exiting.end();
1286          EI != EE; ++EI)
1287       moveExitingFrom(OldIdx, *EI);
1288   }
1289
1290   void moveEnteringUpFromInto(SlotIndex OldIdx, IntRangePair& P,
1291                               BundleRanges& BR) {
1292     LiveInterval* LI = P.first;
1293     LiveRange* LR = P.second;
1294     bool LiveThrough = LR->end > OldIdx.getRegSlot();
1295     if (LiveThrough) {
1296       assert((LR->start < NewIdx || BR[LI->reg].Def == LR) &&
1297              "Def in bundle should be def range.");
1298       assert((BR[LI->reg].Use == 0 || BR[LI->reg].Use == LR) &&
1299              "If bundle has use for this reg it should be LR.");
1300       BR[LI->reg].Use = LR;
1301       return;
1302     }
1303
1304     SlotIndex LastUse = findLastUseBefore(LI->reg, OldIdx);
1305     moveKillFlags(LI->reg, OldIdx, LastUse);
1306
1307     if (LR->start < NewIdx) {
1308       // Becoming a new entering range.
1309       assert(BR[LI->reg].Dead == 0 && BR[LI->reg].Def == 0 &&
1310              "Bundle shouldn't be re-defining reg mid-range.");
1311       assert((BR[LI->reg].Use == 0 || BR[LI->reg].Use == LR) &&
1312              "Bundle shouldn't have different use range for same reg.");
1313       LR->end = LastUse.getRegSlot();
1314       BR[LI->reg].Use = LR;
1315     } else {
1316       // Becoming a new Dead-def.
1317       assert(LR->start == NewIdx.getRegSlot(LR->start.isEarlyClobber()) &&
1318              "Live range starting at unexpected slot.");
1319       assert(BR[LI->reg].Def == LR && "Reg should have def range.");
1320       assert(BR[LI->reg].Dead == 0 &&
1321                "Can't have def and dead def of same reg in a bundle.");
1322       LR->end = LastUse.getDeadSlot();
1323       BR[LI->reg].Dead = BR[LI->reg].Def;
1324       BR[LI->reg].Def = 0;
1325     }
1326   }
1327
1328   void moveEnteringDownFromInto(SlotIndex OldIdx, IntRangePair& P,
1329                                 BundleRanges& BR) {
1330     LiveInterval* LI = P.first;
1331     LiveRange* LR = P.second;
1332     if (NewIdx > LR->end) {
1333       // Range extended to bundle. Add to bundle uses.
1334       // Note: Currently adds kill flags to bundle start.
1335       assert(BR[LI->reg].Use == 0 &&
1336              "Bundle already has use range for reg.");
1337       moveKillFlags(LI->reg, LR->end, NewIdx);
1338       LR->end = NewIdx.getRegSlot();
1339       BR[LI->reg].Use = LR;
1340     } else {
1341       assert(BR[LI->reg].Use != 0 &&
1342              "Bundle should already have a use range for reg.");
1343     }
1344   }
1345
1346   void moveAllEnteringFromInto(SlotIndex OldIdx, RangeSet& Entering,
1347                                BundleRanges& BR) {
1348     bool GoingUp = NewIdx < OldIdx;
1349
1350     if (GoingUp) {
1351       for (RangeSet::iterator EI = Entering.begin(), EE = Entering.end();
1352            EI != EE; ++EI)
1353         moveEnteringUpFromInto(OldIdx, *EI, BR);
1354     } else {
1355       for (RangeSet::iterator EI = Entering.begin(), EE = Entering.end();
1356            EI != EE; ++EI)
1357         moveEnteringDownFromInto(OldIdx, *EI, BR);
1358     }
1359   }
1360
1361   void moveInternalFromInto(SlotIndex OldIdx, IntRangePair& P,
1362                             BundleRanges& BR) {
1363     // TODO: Sane rules for moving ranges into bundles.
1364   }
1365
1366   void moveAllInternalFromInto(SlotIndex OldIdx, RangeSet& Internal,
1367                                BundleRanges& BR) {
1368     for (RangeSet::iterator II = Internal.begin(), IE = Internal.end();
1369          II != IE; ++II)
1370       moveInternalFromInto(OldIdx, *II, BR);
1371   }
1372
1373   void moveExitingFromInto(SlotIndex OldIdx, IntRangePair& P,
1374                            BundleRanges& BR) {
1375     LiveInterval* LI = P.first;
1376     LiveRange* LR = P.second;
1377
1378     assert(LR->start.isRegister() &&
1379            "Don't know how to merge exiting ECs into bundles yet.");
1380
1381     if (LR->end > NewIdx.getDeadSlot()) {
1382       // This range is becoming an exiting range on the bundle.
1383       // If there was an old dead-def of this reg, delete it.
1384       if (BR[LI->reg].Dead != 0) {
1385         LI->removeRange(*BR[LI->reg].Dead);
1386         BR[LI->reg].Dead = 0;
1387       }
1388       assert(BR[LI->reg].Def == 0 &&
1389              "Can't have two defs for the same variable exiting a bundle.");
1390       LR->start = NewIdx.getRegSlot();
1391       LR->valno->def = LR->start;
1392       BR[LI->reg].Def = LR;
1393     } else {
1394       // This range is becoming internal to the bundle.
1395       assert(LR->end == NewIdx.getRegSlot() &&
1396              "Can't bundle def whose kill is before the bundle");
1397       if (BR[LI->reg].Dead || BR[LI->reg].Def) {
1398         // Already have a def for this. Just delete range.
1399         LI->removeRange(*LR);
1400       } else {
1401         // Make range dead, record.
1402         LR->end = NewIdx.getDeadSlot();
1403         BR[LI->reg].Dead = LR;
1404         assert(BR[LI->reg].Use == LR &&
1405                "Range becoming dead should currently be use.");
1406       }
1407       // In both cases the range is no longer a use on the bundle.
1408       BR[LI->reg].Use = 0;
1409     }
1410   }
1411
1412   void moveAllExitingFromInto(SlotIndex OldIdx, RangeSet& Exiting,
1413                               BundleRanges& BR) {
1414     for (RangeSet::iterator EI = Exiting.begin(), EE = Exiting.end();
1415          EI != EE; ++EI)
1416       moveExitingFromInto(OldIdx, *EI, BR);
1417   }
1418
1419 };
1420
1421 void LiveIntervals::handleMove(MachineInstr* MI) {
1422   SlotIndex OldIndex = Indexes->getInstructionIndex(MI);
1423   Indexes->removeMachineInstrFromMaps(MI);
1424   SlotIndex NewIndex = MI->isInsideBundle() ?
1425                         Indexes->getInstructionIndex(MI) :
1426                         Indexes->insertMachineInstrInMaps(MI);
1427   assert(getMBBStartIdx(MI->getParent()) <= OldIndex &&
1428          OldIndex < getMBBEndIdx(MI->getParent()) &&
1429          "Cannot handle moves across basic block boundaries.");
1430   assert(!MI->isBundled() && "Can't handle bundled instructions yet.");
1431
1432   HMEditor HME(*this, *MRI, *TRI, NewIndex);
1433   HME.moveAllRangesFrom(MI, OldIndex);
1434 }
1435
1436 void LiveIntervals::handleMoveIntoBundle(MachineInstr* MI, MachineInstr* BundleStart) {
1437   SlotIndex NewIndex = Indexes->getInstructionIndex(BundleStart);
1438   HMEditor HME(*this, *MRI, *TRI, NewIndex);
1439   HME.moveAllRangesInto(MI, BundleStart);
1440 }