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 "liveintervals"
  19 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  20 #include "VirtRegMap.h"
  21 #include "llvm/Value.h"
  22 #include "llvm/Analysis/AliasAnalysis.h"
  23 #include "llvm/CodeGen/CalcSpillWeights.h"
  24 #include "llvm/CodeGen/LiveVariables.h"
  25 #include "llvm/CodeGen/MachineFrameInfo.h"
  26 #include "llvm/CodeGen/MachineInstr.h"
  27 #include "llvm/CodeGen/MachineInstrBuilder.h"
  28 #include "llvm/CodeGen/MachineLoopInfo.h"
  29 #include "llvm/CodeGen/MachineMemOperand.h"
  30 #include "llvm/CodeGen/MachineRegisterInfo.h"
  31 #include "llvm/CodeGen/Passes.h"
  32 #include "llvm/CodeGen/ProcessImplicitDefs.h"
  33 #include "llvm/Target/TargetRegisterInfo.h"
  34 #include "llvm/Target/TargetInstrInfo.h"
  35 #include "llvm/Target/TargetMachine.h"
  36 #include "llvm/Target/TargetOptions.h"
  37 #include "llvm/Support/CommandLine.h"
  38 #include "llvm/Support/Debug.h"
  39 #include "llvm/Support/ErrorHandling.h"
  40 #include "llvm/Support/raw_ostream.h"
  41 #include "llvm/ADT/DepthFirstIterator.h"
  42 #include "llvm/ADT/SmallSet.h"
  43 #include "llvm/ADT/Statistic.h"
  44 #include "llvm/ADT/STLExtras.h"
  45 #include <algorithm>
  46 #include <limits>
  47 #include <cmath>
  48 using namespace llvm;
  49
  50 // Hidden options for help debugging.
  51 static cl::opt<bool> DisableReMat("disable-rematerialization",
  52                                   cl::init(false), cl::Hidden);
  53
  54 STATISTIC(numIntervals , "Number of original intervals");
  55
  56 char LiveIntervals::ID = 0;
  57 INITIALIZE_PASS_BEGIN(LiveIntervals, "liveintervals",
  58                 "Live Interval Analysis", false, false)
  59 INITIALIZE_PASS_DEPENDENCY(LiveVariables)
  60 INITIALIZE_PASS_DEPENDENCY(MachineLoopInfo)
  61 INITIALIZE_PASS_DEPENDENCY(PHIElimination)
  62 INITIALIZE_PASS_DEPENDENCY(TwoAddressInstructionPass)
  63 INITIALIZE_PASS_DEPENDENCY(ProcessImplicitDefs)
  64 INITIALIZE_PASS_DEPENDENCY(SlotIndexes)
  65 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
  66 INITIALIZE_PASS_END(LiveIntervals, "liveintervals",
  67                 "Live Interval Analysis", false, false)
  68
  69 void LiveIntervals::getAnalysisUsage(AnalysisUsage &AU) const {
  70   AU.setPreservesCFG();
  71   AU.addRequired<AliasAnalysis>();
  72   AU.addPreserved<AliasAnalysis>();
  73   AU.addRequired<LiveVariables>();
  74   AU.addPreserved<LiveVariables>();
  75   AU.addRequired<MachineLoopInfo>();
  76   AU.addPreserved<MachineLoopInfo>();
  77   AU.addPreservedID(MachineDominatorsID);
  78
  79   if (!StrongPHIElim) {
  80     AU.addPreservedID(PHIEliminationID);
  81     AU.addRequiredID(PHIEliminationID);
  82   }
  83
  84   AU.addRequiredID(TwoAddressInstructionPassID);
  85   AU.addPreserved<ProcessImplicitDefs>();
  86   AU.addRequired<ProcessImplicitDefs>();
  87   AU.addPreserved<SlotIndexes>();
  88   AU.addRequiredTransitive<SlotIndexes>();
  89   MachineFunctionPass::getAnalysisUsage(AU);
  90 }
  91
  92 void LiveIntervals::releaseMemory() {
  93   // Free the live intervals themselves.
  94   for (DenseMap<unsigned, LiveInterval*>::iterator I = r2iMap_.begin(),
  95        E = r2iMap_.end(); I != E; ++I)
  96     delete I->second;
  97
  98   r2iMap_.clear();
  99
 100   // Release VNInfo memory regions, VNInfo objects don't need to be dtor'd.
 101   VNInfoAllocator.Reset();
 102   while (!CloneMIs.empty()) {
 103     MachineInstr *MI = CloneMIs.back();
 104     CloneMIs.pop_back();
 105     mf_->DeleteMachineInstr(MI);
 106   }
 107 }
 108
 109 /// runOnMachineFunction - Register allocate the whole function
 110 ///
 111 bool LiveIntervals::runOnMachineFunction(MachineFunction &fn) {
 112   mf_ = &fn;
 113   mri_ = &mf_->getRegInfo();
 114   tm_ = &fn.getTarget();
 115   tri_ = tm_->getRegisterInfo();
 116   tii_ = tm_->getInstrInfo();
 117   aa_ = &getAnalysis<AliasAnalysis>();
 118   lv_ = &getAnalysis<LiveVariables>();
 119   indexes_ = &getAnalysis<SlotIndexes>();
 120   allocatableRegs_ = tri_->getAllocatableSet(fn);
 121
 122   computeIntervals();
 123
 124   numIntervals += getNumIntervals();
 125
 126   DEBUG(dump());
 127   return true;
 128 }
 129
 130 /// print - Implement the dump method.
 131 void LiveIntervals::print(raw_ostream &OS, const Module* ) const {
 132   OS << "********** INTERVALS **********\n";
 133   for (const_iterator I = begin(), E = end(); I != E; ++I) {
 134     I->second->print(OS, tri_);
 135     OS << "\n";
 136   }
 137
 138   printInstrs(OS);
 139 }
 140
 141 void LiveIntervals::printInstrs(raw_ostream &OS) const {
 142   OS << "********** MACHINEINSTRS **********\n";
 143   mf_->print(OS, indexes_);
 144 }
 145
 146 void LiveIntervals::dumpInstrs() const {
 147   printInstrs(dbgs());
 148 }
 149
 150 static
 151 bool MultipleDefsBySameMI(const MachineInstr &MI, unsigned MOIdx) {
 152   unsigned Reg = MI.getOperand(MOIdx).getReg();
 153   for (unsigned i = MOIdx+1, e = MI.getNumOperands(); i < e; ++i) {
 154     const MachineOperand &MO = MI.getOperand(i);
 155     if (!MO.isReg())
 156       continue;
 157     if (MO.getReg() == Reg && MO.isDef()) {
 158       assert(MI.getOperand(MOIdx).getSubReg() != MO.getSubReg() &&
 159              MI.getOperand(MOIdx).getSubReg() &&
 160              (MO.getSubReg() || MO.isImplicit()));
 161       return true;
 162     }
 163   }
 164   return false;
 165 }
 166
 167 /// isPartialRedef - Return true if the specified def at the specific index is
 168 /// partially re-defining the specified live interval. A common case of this is
 169 /// a definition of the sub-register.
 170 bool LiveIntervals::isPartialRedef(SlotIndex MIIdx, MachineOperand &MO,
 171                                    LiveInterval &interval) {
 172   if (!MO.getSubReg() || MO.isEarlyClobber())
 173     return false;
 174
 175   SlotIndex RedefIndex = MIIdx.getDefIndex();
 176   const LiveRange *OldLR =
 177     interval.getLiveRangeContaining(RedefIndex.getUseIndex());
 178   MachineInstr *DefMI = getInstructionFromIndex(OldLR->valno->def);
 179   if (DefMI != 0) {
 180     return DefMI->findRegisterDefOperandIdx(interval.reg) != -1;
 181   }
 182   return false;
 183 }
 184
 185 void LiveIntervals::handleVirtualRegisterDef(MachineBasicBlock *mbb,
 186                                              MachineBasicBlock::iterator mi,
 187                                              SlotIndex MIIdx,
 188                                              MachineOperand& MO,
 189                                              unsigned MOIdx,
 190                                              LiveInterval &interval) {
 191   DEBUG(dbgs() << "\t\tregister: " << PrintReg(interval.reg, tri_));
 192
 193   // Virtual registers may be defined multiple times (due to phi
 194   // elimination and 2-addr elimination).  Much of what we do only has to be
 195   // done once for the vreg.  We use an empty interval to detect the first
 196   // time we see a vreg.
 197   LiveVariables::VarInfo& vi = lv_->getVarInfo(interval.reg);
 198   if (interval.empty()) {
 199     // Get the Idx of the defining instructions.
 200     SlotIndex defIndex = MIIdx.getDefIndex();
 201     // Earlyclobbers move back one, so that they overlap the live range
 202     // of inputs.
 203     if (MO.isEarlyClobber())
 204       defIndex = MIIdx.getUseIndex();
 205
 206     // Make sure the first definition is not a partial redefinition. Add an
 207     // <imp-def> of the full register.
 208     // FIXME: LiveIntervals shouldn't modify the code like this.  Whoever
 209     // created the machine instruction should annotate it with <undef> flags
 210     // as needed.  Then we can simply assert here.  The REG_SEQUENCE lowering
 211     // is the main suspect.
 212     if (MO.getSubReg()) {
 213       mi->addRegisterDefined(interval.reg);
 214       // Mark all defs of interval.reg on this instruction as reading <undef>.
 215       for (unsigned i = MOIdx, e = mi->getNumOperands(); i != e; ++i) {
 216         MachineOperand &MO2 = mi->getOperand(i);
 217         if (MO2.isReg() && MO2.getReg() == interval.reg && MO2.getSubReg())
 218           MO2.setIsUndef();
 219       }
 220     }
 221
 222     MachineInstr *CopyMI = NULL;
 223     if (mi->isCopyLike()) {
 224       CopyMI = mi;
 225     }
 226
 227     VNInfo *ValNo = interval.getNextValue(defIndex, CopyMI, VNInfoAllocator);
 228     assert(ValNo->id == 0 && "First value in interval is not 0?");
 229
 230     // Loop over all of the blocks that the vreg is defined in.  There are
 231     // two cases we have to handle here.  The most common case is a vreg
 232     // whose lifetime is contained within a basic block.  In this case there
 233     // will be a single kill, in MBB, which comes after the definition.
 234     if (vi.Kills.size() == 1 && vi.Kills[0]->getParent() == mbb) {
 235       // FIXME: what about dead vars?
 236       SlotIndex killIdx;
 237       if (vi.Kills[0] != mi)
 238         killIdx = getInstructionIndex(vi.Kills[0]).getDefIndex();
 239       else
 240         killIdx = defIndex.getStoreIndex();
 241
 242       // If the kill happens after the definition, we have an intra-block
 243       // live range.
 244       if (killIdx > defIndex) {
 245         assert(vi.AliveBlocks.empty() &&
 246                "Shouldn't be alive across any blocks!");
 247         LiveRange LR(defIndex, killIdx, ValNo);
 248         interval.addRange(LR);
 249         DEBUG(dbgs() << " +" << LR << "\n");
 250         return;
 251       }
 252     }
 253
 254     // The other case we handle is when a virtual register lives to the end
 255     // of the defining block, potentially live across some blocks, then is
 256     // live into some number of blocks, but gets killed.  Start by adding a
 257     // range that goes from this definition to the end of the defining block.
 258     LiveRange NewLR(defIndex, getMBBEndIdx(mbb), ValNo);
 259     DEBUG(dbgs() << " +" << NewLR);
 260     interval.addRange(NewLR);
 261
 262     bool PHIJoin = lv_->isPHIJoin(interval.reg);
 263
 264     if (PHIJoin) {
 265       // A phi join register is killed at the end of the MBB and revived as a new
 266       // valno in the killing blocks.
 267       assert(vi.AliveBlocks.empty() && "Phi join can't pass through blocks");
 268       DEBUG(dbgs() << " phi-join");
 269       ValNo->setHasPHIKill(true);
 270     } else {
 271       // Iterate over all of the blocks that the variable is completely
 272       // live in, adding [insrtIndex(begin), instrIndex(end)+4) to the
 273       // live interval.
 274       for (SparseBitVector<>::iterator I = vi.AliveBlocks.begin(),
 275                E = vi.AliveBlocks.end(); I != E; ++I) {
 276         MachineBasicBlock *aliveBlock = mf_->getBlockNumbered(*I);
 277         LiveRange LR(getMBBStartIdx(aliveBlock), getMBBEndIdx(aliveBlock), ValNo);
 278         interval.addRange(LR);
 279         DEBUG(dbgs() << " +" << LR);
 280       }
 281     }
 282
 283     // Finally, this virtual register is live from the start of any killing
 284     // block to the 'use' slot of the killing instruction.
 285     for (unsigned i = 0, e = vi.Kills.size(); i != e; ++i) {
 286       MachineInstr *Kill = vi.Kills[i];
 287       SlotIndex Start = getMBBStartIdx(Kill->getParent());
 288       SlotIndex killIdx = getInstructionIndex(Kill).getDefIndex();
 289
 290       // Create interval with one of a NEW value number.  Note that this value
 291       // number isn't actually defined by an instruction, weird huh? :)
 292       if (PHIJoin) {
 293         assert(getInstructionFromIndex(Start) == 0 &&
 294                "PHI def index points at actual instruction.");
 295         ValNo = interval.getNextValue(Start, 0, VNInfoAllocator);
 296         ValNo->setIsPHIDef(true);
 297       }
 298       LiveRange LR(Start, killIdx, ValNo);
 299       interval.addRange(LR);
 300       DEBUG(dbgs() << " +" << LR);
 301     }
 302
 303   } else {
 304     if (MultipleDefsBySameMI(*mi, MOIdx))
 305       // Multiple defs of the same virtual register by the same instruction.
 306       // e.g. %reg1031:5<def>, %reg1031:6<def> = VLD1q16 %reg1024<kill>, ...
 307       // This is likely due to elimination of REG_SEQUENCE instructions. Return
 308       // here since there is nothing to do.
 309       return;
 310
 311     // If this is the second time we see a virtual register definition, it
 312     // must be due to phi elimination or two addr elimination.  If this is
 313     // the result of two address elimination, then the vreg is one of the
 314     // def-and-use register operand.
 315
 316     // It may also be partial redef like this:
 317     // 80  %reg1041:6<def> = VSHRNv4i16 %reg1034<kill>, 12, pred:14, pred:%reg0
 318     // 120 %reg1041:5<def> = VSHRNv4i16 %reg1039<kill>, 12, pred:14, pred:%reg0
 319     bool PartReDef = isPartialRedef(MIIdx, MO, interval);
 320     if (PartReDef || mi->isRegTiedToUseOperand(MOIdx)) {
 321       // If this is a two-address definition, then we have already processed
 322       // the live range.  The only problem is that we didn't realize there
 323       // are actually two values in the live interval.  Because of this we
 324       // need to take the LiveRegion that defines this register and split it
 325       // into two values.
 326       SlotIndex RedefIndex = MIIdx.getDefIndex();
 327       if (MO.isEarlyClobber())
 328         RedefIndex = MIIdx.getUseIndex();
 329
 330       const LiveRange *OldLR =
 331         interval.getLiveRangeContaining(RedefIndex.getUseIndex());
 332       VNInfo *OldValNo = OldLR->valno;
 333       SlotIndex DefIndex = OldValNo->def.getDefIndex();
 334
 335       // Delete the previous value, which should be short and continuous,
 336       // because the 2-addr copy must be in the same MBB as the redef.
 337       interval.removeRange(DefIndex, RedefIndex);
 338
 339       // The new value number (#1) is defined by the instruction we claimed
 340       // defined value #0.
 341       VNInfo *ValNo = interval.createValueCopy(OldValNo, VNInfoAllocator);
 342
 343       // Value#0 is now defined by the 2-addr instruction.
 344       OldValNo->def  = RedefIndex;
 345       OldValNo->setCopy(0);
 346
 347       // A re-def may be a copy. e.g. %reg1030:6<def> = VMOVD %reg1026, ...
 348       if (PartReDef && mi->isCopyLike())
 349         OldValNo->setCopy(&*mi);
 350
 351       // Add the new live interval which replaces the range for the input copy.
 352       LiveRange LR(DefIndex, RedefIndex, ValNo);
 353       DEBUG(dbgs() << " replace range with " << LR);
 354       interval.addRange(LR);
 355
 356       // If this redefinition is dead, we need to add a dummy unit live
 357       // range covering the def slot.
 358       if (MO.isDead())
 359         interval.addRange(LiveRange(RedefIndex, RedefIndex.getStoreIndex(),
 360                                     OldValNo));
 361
 362       DEBUG({
 363           dbgs() << " RESULT: ";
 364           interval.print(dbgs(), tri_);
 365         });
 366     } else if (lv_->isPHIJoin(interval.reg)) {
 367       // In the case of PHI elimination, each variable definition is only
 368       // live until the end of the block.  We've already taken care of the
 369       // rest of the live range.
 370
 371       SlotIndex defIndex = MIIdx.getDefIndex();
 372       if (MO.isEarlyClobber())
 373         defIndex = MIIdx.getUseIndex();
 374
 375       VNInfo *ValNo;
 376       MachineInstr *CopyMI = NULL;
 377       if (mi->isCopyLike())
 378         CopyMI = mi;
 379       ValNo = interval.getNextValue(defIndex, CopyMI, VNInfoAllocator);
 380
 381       SlotIndex killIndex = getMBBEndIdx(mbb);
 382       LiveRange LR(defIndex, killIndex, ValNo);
 383       interval.addRange(LR);
 384       ValNo->setHasPHIKill(true);
 385       DEBUG(dbgs() << " phi-join +" << LR);
 386     } else {
 387       llvm_unreachable("Multiply defined register");
 388     }
 389   }
 390
 391   DEBUG(dbgs() << '\n');
 392 }
 393
 394 void LiveIntervals::handlePhysicalRegisterDef(MachineBasicBlock *MBB,
 395                                               MachineBasicBlock::iterator mi,
 396                                               SlotIndex MIIdx,
 397                                               MachineOperand& MO,
 398                                               LiveInterval &interval,
 399                                               MachineInstr *CopyMI) {
 400   // A physical register cannot be live across basic block, so its
 401   // lifetime must end somewhere in its defining basic block.
 402   DEBUG(dbgs() << "\t\tregister: " << PrintReg(interval.reg, tri_));
 403
 404   SlotIndex baseIndex = MIIdx;
 405   SlotIndex start = baseIndex.getDefIndex();
 406   // Earlyclobbers move back one.
 407   if (MO.isEarlyClobber())
 408     start = MIIdx.getUseIndex();
 409   SlotIndex end = start;
 410
 411   // If it is not used after definition, it is considered dead at
 412   // the instruction defining it. Hence its interval is:
 413   // [defSlot(def), defSlot(def)+1)
 414   // For earlyclobbers, the defSlot was pushed back one; the extra
 415   // advance below compensates.
 416   if (MO.isDead()) {
 417     DEBUG(dbgs() << " dead");
 418     end = start.getStoreIndex();
 419     goto exit;
 420   }
 421
 422   // If it is not dead on definition, it must be killed by a
 423   // subsequent instruction. Hence its interval is:
 424   // [defSlot(def), useSlot(kill)+1)
 425   baseIndex = baseIndex.getNextIndex();
 426   while (++mi != MBB->end()) {
 427
 428     if (mi->isDebugValue())
 429       continue;
 430     if (getInstructionFromIndex(baseIndex) == 0)
 431       baseIndex = indexes_->getNextNonNullIndex(baseIndex);
 432
 433     if (mi->killsRegister(interval.reg, tri_)) {
 434       DEBUG(dbgs() << " killed");
 435       end = baseIndex.getDefIndex();
 436       goto exit;
 437     } else {
 438       int DefIdx = mi->findRegisterDefOperandIdx(interval.reg,false,false,tri_);
 439       if (DefIdx != -1) {
 440         if (mi->isRegTiedToUseOperand(DefIdx)) {
 441           // Two-address instruction.
 442           end = baseIndex.getDefIndex();
 443         } else {
 444           // Another instruction redefines the register before it is ever read.
 445           // Then the register is essentially dead at the instruction that
 446           // defines it. Hence its interval is:
 447           // [defSlot(def), defSlot(def)+1)
 448           DEBUG(dbgs() << " dead");
 449           end = start.getStoreIndex();
 450         }
 451         goto exit;
 452       }
 453     }
 454
 455     baseIndex = baseIndex.getNextIndex();
 456   }
 457
 458   // The only case we should have a dead physreg here without a killing or
 459   // instruction where we know it's dead is if it is live-in to the function
 460   // and never used. Another possible case is the implicit use of the
 461   // physical register has been deleted by two-address pass.
 462   end = start.getStoreIndex();
 463
 464 exit:
 465   assert(start < end && "did not find end of interval?");
 466
 467   // Already exists? Extend old live interval.
 468   VNInfo *ValNo = interval.getVNInfoAt(start);
 469   bool Extend = ValNo != 0;
 470   if (!Extend)
 471     ValNo = interval.getNextValue(start, CopyMI, VNInfoAllocator);
 472   if (Extend && MO.isEarlyClobber())
 473     ValNo->setHasRedefByEC(true);
 474   LiveRange LR(start, end, ValNo);
 475   interval.addRange(LR);
 476   DEBUG(dbgs() << " +" << LR << '\n');
 477 }
 478
 479 void LiveIntervals::handleRegisterDef(MachineBasicBlock *MBB,
 480                                       MachineBasicBlock::iterator MI,
 481                                       SlotIndex MIIdx,
 482                                       MachineOperand& MO,
 483                                       unsigned MOIdx) {
 484   if (TargetRegisterInfo::isVirtualRegister(MO.getReg()))
 485     handleVirtualRegisterDef(MBB, MI, MIIdx, MO, MOIdx,
 486                              getOrCreateInterval(MO.getReg()));
 487   else {
 488     MachineInstr *CopyMI = NULL;
 489     if (MI->isCopyLike())
 490       CopyMI = MI;
 491     handlePhysicalRegisterDef(MBB, MI, MIIdx, MO,
 492                               getOrCreateInterval(MO.getReg()), CopyMI);
 493   }
 494 }
 495
 496 void LiveIntervals::handleLiveInRegister(MachineBasicBlock *MBB,
 497                                          SlotIndex MIIdx,
 498                                          LiveInterval &interval, bool isAlias) {
 499   DEBUG(dbgs() << "\t\tlivein register: " << PrintReg(interval.reg, tri_));
 500
 501   // Look for kills, if it reaches a def before it's killed, then it shouldn't
 502   // be considered a livein.
 503   MachineBasicBlock::iterator mi = MBB->begin();
 504   MachineBasicBlock::iterator E = MBB->end();
 505   // Skip over DBG_VALUE at the start of the MBB.
 506   if (mi != E && mi->isDebugValue()) {
 507     while (++mi != E && mi->isDebugValue())
 508       ;
 509     if (mi == E)
 510       // MBB is empty except for DBG_VALUE's.
 511       return;
 512   }
 513
 514   SlotIndex baseIndex = MIIdx;
 515   SlotIndex start = baseIndex;
 516   if (getInstructionFromIndex(baseIndex) == 0)
 517     baseIndex = indexes_->getNextNonNullIndex(baseIndex);
 518
 519   SlotIndex end = baseIndex;
 520   bool SeenDefUse = false;
 521
 522   while (mi != E) {
 523     if (mi->killsRegister(interval.reg, tri_)) {
 524       DEBUG(dbgs() << " killed");
 525       end = baseIndex.getDefIndex();
 526       SeenDefUse = true;
 527       break;
 528     } else if (mi->definesRegister(interval.reg, tri_)) {
 529       // Another instruction redefines the register before it is ever read.
 530       // Then the register is essentially dead at the instruction that defines
 531       // it. Hence its interval is:
 532       // [defSlot(def), defSlot(def)+1)
 533       DEBUG(dbgs() << " dead");
 534       end = start.getStoreIndex();
 535       SeenDefUse = true;
 536       break;
 537     }
 538
 539     while (++mi != E && mi->isDebugValue())
 540       // Skip over DBG_VALUE.
 541       ;
 542     if (mi != E)
 543       baseIndex = indexes_->getNextNonNullIndex(baseIndex);
 544   }
 545
 546   // Live-in register might not be used at all.
 547   if (!SeenDefUse) {
 548     if (isAlias) {
 549       DEBUG(dbgs() << " dead");
 550       end = MIIdx.getStoreIndex();
 551     } else {
 552       DEBUG(dbgs() << " live through");
 553       end = getMBBEndIdx(MBB);
 554     }
 555   }
 556
 557   SlotIndex defIdx = getMBBStartIdx(MBB);
 558   assert(getInstructionFromIndex(defIdx) == 0 &&
 559          "PHI def index points at actual instruction.");
 560   VNInfo *vni =
 561     interval.getNextValue(defIdx, 0, VNInfoAllocator);
 562   vni->setIsPHIDef(true);
 563   LiveRange LR(start, end, vni);
 564
 565   interval.addRange(LR);
 566   DEBUG(dbgs() << " +" << LR << '\n');
 567 }
 568
 569 /// computeIntervals - computes the live intervals for virtual
 570 /// registers. for some ordering of the machine instructions [1,N] a
 571 /// live interval is an interval [i, j) where 1 <= i <= j < N for
 572 /// which a variable is live
 573 void LiveIntervals::computeIntervals() {
 574   DEBUG(dbgs() << "********** COMPUTING LIVE INTERVALS **********\n"
 575                << "********** Function: "
 576                << ((Value*)mf_->getFunction())->getName() << '\n');
 577
 578   SmallVector<unsigned, 8> UndefUses;
 579   for (MachineFunction::iterator MBBI = mf_->begin(), E = mf_->end();
 580        MBBI != E; ++MBBI) {
 581     MachineBasicBlock *MBB = MBBI;
 582     if (MBB->empty())
 583       continue;
 584
 585     // Track the index of the current machine instr.
 586     SlotIndex MIIndex = getMBBStartIdx(MBB);
 587     DEBUG(dbgs() << "BB#" << MBB->getNumber()
 588           << ":\t\t# derived from " << MBB->getName() << "\n");
 589
 590     // Create intervals for live-ins to this BB first.
 591     for (MachineBasicBlock::livein_iterator LI = MBB->livein_begin(),
 592            LE = MBB->livein_end(); LI != LE; ++LI) {
 593       handleLiveInRegister(MBB, MIIndex, getOrCreateInterval(*LI));
 594       // Multiple live-ins can alias the same register.
 595       for (const unsigned* AS = tri_->getSubRegisters(*LI); *AS; ++AS)
 596         if (!hasInterval(*AS))
 597           handleLiveInRegister(MBB, MIIndex, getOrCreateInterval(*AS),
 598                                true);
 599     }
 600
 601     // Skip over empty initial indices.
 602     if (getInstructionFromIndex(MIIndex) == 0)
 603       MIIndex = indexes_->getNextNonNullIndex(MIIndex);
 604
 605     for (MachineBasicBlock::iterator MI = MBB->begin(), miEnd = MBB->end();
 606          MI != miEnd; ++MI) {
 607       DEBUG(dbgs() << MIIndex << "\t" << *MI);
 608       if (MI->isDebugValue())
 609         continue;
 610
 611       // Handle defs.
 612       for (int i = MI->getNumOperands() - 1; i >= 0; --i) {
 613         MachineOperand &MO = MI->getOperand(i);
 614         if (!MO.isReg() || !MO.getReg())
 615           continue;
 616
 617         // handle register defs - build intervals
 618         if (MO.isDef())
 619           handleRegisterDef(MBB, MI, MIIndex, MO, i);
 620         else if (MO.isUndef())
 621           UndefUses.push_back(MO.getReg());
 622       }
 623
 624       // Move to the next instr slot.
 625       MIIndex = indexes_->getNextNonNullIndex(MIIndex);
 626     }
 627   }
 628
 629   // Create empty intervals for registers defined by implicit_def's (except
 630   // for those implicit_def that define values which are liveout of their
 631   // blocks.
 632   for (unsigned i = 0, e = UndefUses.size(); i != e; ++i) {
 633     unsigned UndefReg = UndefUses[i];
 634     (void)getOrCreateInterval(UndefReg);
 635   }
 636 }
 637
 638 LiveInterval* LiveIntervals::createInterval(unsigned reg) {
 639   float Weight = TargetRegisterInfo::isPhysicalRegister(reg) ? HUGE_VALF : 0.0F;
 640   return new LiveInterval(reg, Weight);
 641 }
 642
 643 /// dupInterval - Duplicate a live interval. The caller is responsible for
 644 /// managing the allocated memory.
 645 LiveInterval* LiveIntervals::dupInterval(LiveInterval *li) {
 646   LiveInterval *NewLI = createInterval(li->reg);
 647   NewLI->Copy(*li, mri_, getVNInfoAllocator());
 648   return NewLI;
 649 }
 650
 651 /// shrinkToUses - After removing some uses of a register, shrink its live
 652 /// range to just the remaining uses. This method does not compute reaching
 653 /// defs for new uses, and it doesn't remove dead defs.
 654 bool LiveIntervals::shrinkToUses(LiveInterval *li,
 655                                  SmallVectorImpl<MachineInstr*> *dead) {
 656   DEBUG(dbgs() << "Shrink: " << *li << '\n');
 657   assert(TargetRegisterInfo::isVirtualRegister(li->reg)
 658          && "Can't only shrink physical registers");
 659   // Find all the values used, including PHI kills.
 660   SmallVector<std::pair<SlotIndex, VNInfo*>, 16> WorkList;
 661
 662   // Blocks that have already been added to WorkList as live-out.
 663   SmallPtrSet<MachineBasicBlock*, 16> LiveOut;
 664
 665   // Visit all instructions reading li->reg.
 666   for (MachineRegisterInfo::reg_iterator I = mri_->reg_begin(li->reg);
 667        MachineInstr *UseMI = I.skipInstruction();) {
 668     if (UseMI->isDebugValue() || !UseMI->readsVirtualRegister(li->reg))
 669       continue;
 670     SlotIndex Idx = getInstructionIndex(UseMI).getUseIndex();
 671     VNInfo *VNI = li->getVNInfoAt(Idx);
 672     if (!VNI) {
 673       // This shouldn't happen: readsVirtualRegister returns true, but there is
 674       // no live value. It is likely caused by a target getting <undef> flags
 675       // wrong.
 676       DEBUG(dbgs() << Idx << '\t' << *UseMI
 677                    << "Warning: Instr claims to read non-existent value in "
 678                     << *li << '\n');
 679       continue;
 680     }
 681     if (VNI->def == Idx) {
 682       // Special case: An early-clobber tied operand reads and writes the
 683       // register one slot early.
 684       Idx = Idx.getPrevSlot();
 685       VNI = li->getVNInfoAt(Idx);
 686       assert(VNI && "Early-clobber tied value not available");
 687     }
 688     WorkList.push_back(std::make_pair(Idx, VNI));
 689   }
 690
 691   // Create a new live interval with only minimal live segments per def.
 692   LiveInterval NewLI(li->reg, 0);
 693   for (LiveInterval::vni_iterator I = li->vni_begin(), E = li->vni_end();
 694        I != E; ++I) {
 695     VNInfo *VNI = *I;
 696     if (VNI->isUnused())
 697       continue;
 698     NewLI.addRange(LiveRange(VNI->def, VNI->def.getNextSlot(), VNI));
 699
 700     // A use tied to an early-clobber def ends at the load slot and isn't caught
 701     // above. Catch it here instead. This probably only ever happens for inline
 702     // assembly.
 703     if (VNI->def.isUse())
 704       if (VNInfo *UVNI = li->getVNInfoAt(VNI->def.getLoadIndex()))
 705         WorkList.push_back(std::make_pair(VNI->def.getLoadIndex(), UVNI));
 706   }
 707
 708   // Keep track of the PHIs that are in use.
 709   SmallPtrSet<VNInfo*, 8> UsedPHIs;
 710
 711   // Extend intervals to reach all uses in WorkList.
 712   while (!WorkList.empty()) {
 713     SlotIndex Idx = WorkList.back().first;
 714     VNInfo *VNI = WorkList.back().second;
 715     WorkList.pop_back();
 716     const MachineBasicBlock *MBB = getMBBFromIndex(Idx);
 717     SlotIndex BlockStart = getMBBStartIdx(MBB);
 718
 719     // Extend the live range for VNI to be live at Idx.
 720     if (VNInfo *ExtVNI = NewLI.extendInBlock(BlockStart, Idx.getNextSlot())) {
 721       (void)ExtVNI;
 722       assert(ExtVNI == VNI && "Unexpected existing value number");
 723       // Is this a PHIDef we haven't seen before?
 724       if (!VNI->isPHIDef() || VNI->def != BlockStart || !UsedPHIs.insert(VNI))
 725         continue;
 726       // The PHI is live, make sure the predecessors are live-out.
 727       for (MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(),
 728            PE = MBB->pred_end(); PI != PE; ++PI) {
 729         if (!LiveOut.insert(*PI))
 730           continue;
 731         SlotIndex Stop = getMBBEndIdx(*PI).getPrevSlot();
 732         // A predecessor is not required to have a live-out value for a PHI.
 733         if (VNInfo *PVNI = li->getVNInfoAt(Stop))
 734           WorkList.push_back(std::make_pair(Stop, PVNI));
 735       }
 736       continue;
 737     }
 738
 739     // VNI is live-in to MBB.
 740     DEBUG(dbgs() << " live-in at " << BlockStart << '\n');
 741     NewLI.addRange(LiveRange(BlockStart, Idx.getNextSlot(), VNI));
 742
 743     // Make sure VNI is live-out from the predecessors.
 744     for (MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(),
 745          PE = MBB->pred_end(); PI != PE; ++PI) {
 746       if (!LiveOut.insert(*PI))
 747         continue;
 748       SlotIndex Stop = getMBBEndIdx(*PI).getPrevSlot();
 749       assert(li->getVNInfoAt(Stop) == VNI && "Wrong value out of predecessor");
 750       WorkList.push_back(std::make_pair(Stop, VNI));
 751     }
 752   }
 753
 754   // Handle dead values.
 755   bool CanSeparate = false;
 756   for (LiveInterval::vni_iterator I = li->vni_begin(), E = li->vni_end();
 757        I != E; ++I) {
 758     VNInfo *VNI = *I;
 759     if (VNI->isUnused())
 760       continue;
 761     LiveInterval::iterator LII = NewLI.FindLiveRangeContaining(VNI->def);
 762     assert(LII != NewLI.end() && "Missing live range for PHI");
 763     if (LII->end != VNI->def.getNextSlot())
 764       continue;
 765     if (VNI->isPHIDef()) {
 766       // This is a dead PHI. Remove it.
 767       VNI->setIsUnused(true);
 768       NewLI.removeRange(*LII);
 769       DEBUG(dbgs() << "Dead PHI at " << VNI->def << " may separate interval\n");
 770       CanSeparate = true;
 771     } else {
 772       // This is a dead def. Make sure the instruction knows.
 773       MachineInstr *MI = getInstructionFromIndex(VNI->def);
 774       assert(MI && "No instruction defining live value");
 775       MI->addRegisterDead(li->reg, tri_);
 776       if (dead && MI->allDefsAreDead()) {
 777         DEBUG(dbgs() << "All defs dead: " << VNI->def << '\t' << *MI);
 778         dead->push_back(MI);
 779       }
 780     }
 781   }
 782
 783   // Move the trimmed ranges back.
 784   li->ranges.swap(NewLI.ranges);
 785   DEBUG(dbgs() << "Shrunk: " << *li << '\n');
 786   return CanSeparate;
 787 }
 788
 789
 790 //===----------------------------------------------------------------------===//
 791 // Register allocator hooks.
 792 //
 793
 794 MachineBasicBlock::iterator
 795 LiveIntervals::getLastSplitPoint(const LiveInterval &li,
 796                                  MachineBasicBlock *mbb) const {
 797   const MachineBasicBlock *lpad = mbb->getLandingPadSuccessor();
 798
 799   // If li is not live into a landing pad, we can insert spill code before the
 800   // first terminator.
 801   if (!lpad || !isLiveInToMBB(li, lpad))
 802     return mbb->getFirstTerminator();
 803
 804   // When there is a landing pad, spill code must go before the call instruction
 805   // that can throw.
 806   MachineBasicBlock::iterator I = mbb->end(), B = mbb->begin();
 807   while (I != B) {
 808     --I;
 809     if (I->getDesc().isCall())
 810       return I;
 811   }
 812   // The block contains no calls that can throw, so use the first terminator.
 813   return mbb->getFirstTerminator();
 814 }
 815
 816 void LiveIntervals::addKillFlags() {
 817   for (iterator I = begin(), E = end(); I != E; ++I) {
 818     unsigned Reg = I->first;
 819     if (TargetRegisterInfo::isPhysicalRegister(Reg))
 820       continue;
 821     if (mri_->reg_nodbg_empty(Reg))
 822       continue;
 823     LiveInterval *LI = I->second;
 824
 825     // Every instruction that kills Reg corresponds to a live range end point.
 826     for (LiveInterval::iterator RI = LI->begin(), RE = LI->end(); RI != RE;
 827          ++RI) {
 828       // A LOAD index indicates an MBB edge.
 829       if (RI->end.isLoad())
 830         continue;
 831       MachineInstr *MI = getInstructionFromIndex(RI->end);
 832       if (!MI)
 833         continue;
 834       MI->addRegisterKilled(Reg, NULL);
 835     }
 836   }
 837 }
 838
 839 /// getReMatImplicitUse - If the remat definition MI has one (for now, we only
 840 /// allow one) virtual register operand, then its uses are implicitly using
 841 /// the register. Returns the virtual register.
 842 unsigned LiveIntervals::getReMatImplicitUse(const LiveInterval &li,
 843                                             MachineInstr *MI) const {
 844   unsigned RegOp = 0;
 845   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 846     MachineOperand &MO = MI->getOperand(i);
 847     if (!MO.isReg() || !MO.isUse())
 848       continue;
 849     unsigned Reg = MO.getReg();
 850     if (Reg == 0 || Reg == li.reg)
 851       continue;
 852
 853     if (TargetRegisterInfo::isPhysicalRegister(Reg) &&
 854         !allocatableRegs_[Reg])
 855       continue;
 856     // FIXME: For now, only remat MI with at most one register operand.
 857     assert(!RegOp &&
 858            "Can't rematerialize instruction with multiple register operand!");
 859     RegOp = MO.getReg();
 860 #ifndef NDEBUG
 861     break;
 862 #endif
 863   }
 864   return RegOp;
 865 }
 866
 867 /// isValNoAvailableAt - Return true if the val# of the specified interval
 868 /// which reaches the given instruction also reaches the specified use index.
 869 bool LiveIntervals::isValNoAvailableAt(const LiveInterval &li, MachineInstr *MI,
 870                                        SlotIndex UseIdx) const {
 871   VNInfo *UValNo = li.getVNInfoAt(UseIdx);
 872   return UValNo && UValNo == li.getVNInfoAt(getInstructionIndex(MI));
 873 }
 874
 875 /// isReMaterializable - Returns true if the definition MI of the specified
 876 /// val# of the specified interval is re-materializable.
 877 bool
 878 LiveIntervals::isReMaterializable(const LiveInterval &li,
 879                                   const VNInfo *ValNo, MachineInstr *MI,
 880                                   const SmallVectorImpl<LiveInterval*> *SpillIs,
 881                                   bool &isLoad) {
 882   if (DisableReMat)
 883     return false;
 884
 885   if (!tii_->isTriviallyReMaterializable(MI, aa_))
 886     return false;
 887
 888   // Target-specific code can mark an instruction as being rematerializable
 889   // if it has one virtual reg use, though it had better be something like
 890   // a PIC base register which is likely to be live everywhere.
 891   unsigned ImpUse = getReMatImplicitUse(li, MI);
 892   if (ImpUse) {
 893     const LiveInterval &ImpLi = getInterval(ImpUse);
 894     for (MachineRegisterInfo::use_nodbg_iterator
 895            ri = mri_->use_nodbg_begin(li.reg), re = mri_->use_nodbg_end();
 896          ri != re; ++ri) {
 897       MachineInstr *UseMI = &*ri;
 898       SlotIndex UseIdx = getInstructionIndex(UseMI);
 899       if (li.getVNInfoAt(UseIdx) != ValNo)
 900         continue;
 901       if (!isValNoAvailableAt(ImpLi, MI, UseIdx))
 902         return false;
 903     }
 904
 905     // If a register operand of the re-materialized instruction is going to
 906     // be spilled next, then it's not legal to re-materialize this instruction.
 907     if (SpillIs)
 908       for (unsigned i = 0, e = SpillIs->size(); i != e; ++i)
 909         if (ImpUse == (*SpillIs)[i]->reg)
 910           return false;
 911   }
 912   return true;
 913 }
 914
 915 /// isReMaterializable - Returns true if every definition of MI of every
 916 /// val# of the specified interval is re-materializable.
 917 bool
 918 LiveIntervals::isReMaterializable(const LiveInterval &li,
 919                                   const SmallVectorImpl<LiveInterval*> *SpillIs,
 920                                   bool &isLoad) {
 921   isLoad = false;
 922   for (LiveInterval::const_vni_iterator i = li.vni_begin(), e = li.vni_end();
 923        i != e; ++i) {
 924     const VNInfo *VNI = *i;
 925     if (VNI->isUnused())
 926       continue; // Dead val#.
 927     // Is the def for the val# rematerializable?
 928     MachineInstr *ReMatDefMI = getInstructionFromIndex(VNI->def);
 929     if (!ReMatDefMI)
 930       return false;
 931     bool DefIsLoad = false;
 932     if (!ReMatDefMI ||
 933         !isReMaterializable(li, VNI, ReMatDefMI, SpillIs, DefIsLoad))
 934       return false;
 935     isLoad |= DefIsLoad;
 936   }
 937   return true;
 938 }
 939
 940 bool LiveIntervals::intervalIsInOneMBB(const LiveInterval &li) const {
 941   LiveInterval::Ranges::const_iterator itr = li.ranges.begin();
 942
 943   MachineBasicBlock *mbb =  indexes_->getMBBCoveringRange(itr->start, itr->end);
 944
 945   if (mbb == 0)
 946     return false;
 947
 948   for (++itr; itr != li.ranges.end(); ++itr) {
 949     MachineBasicBlock *mbb2 =
 950       indexes_->getMBBCoveringRange(itr->start, itr->end);
 951
 952     if (mbb2 != mbb)
 953       return false;
 954   }
 955
 956   return true;
 957 }
 958
 959 float
 960 LiveIntervals::getSpillWeight(bool isDef, bool isUse, unsigned loopDepth) {
 961   // Limit the loop depth ridiculousness.
 962   if (loopDepth > 200)
 963     loopDepth = 200;
 964
 965   // The loop depth is used to roughly estimate the number of times the
 966   // instruction is executed. Something like 10^d is simple, but will quickly
 967   // overflow a float. This expression behaves like 10^d for small d, but is
 968   // more tempered for large d. At d=200 we get 6.7e33 which leaves a bit of
 969   // headroom before overflow.
 970   // By the way, powf() might be unavailable here. For consistency,
 971   // We may take pow(double,double).
 972   float lc = std::pow(1 + (100.0 / (loopDepth + 10)), (double)loopDepth);
 973
 974   return (isDef + isUse) * lc;
 975 }
 976
 977 LiveRange LiveIntervals::addLiveRangeToEndOfBlock(unsigned reg,
 978                                                   MachineInstr* startInst) {
 979   LiveInterval& Interval = getOrCreateInterval(reg);
 980   VNInfo* VN = Interval.getNextValue(
 981     SlotIndex(getInstructionIndex(startInst).getDefIndex()),
 982     startInst, getVNInfoAllocator());
 983   VN->setHasPHIKill(true);
 984   LiveRange LR(
 985      SlotIndex(getInstructionIndex(startInst).getDefIndex()),
 986      getMBBEndIdx(startInst->getParent()), VN);
 987   Interval.addRange(LR);
 988
 989   return LR;
 990 }
 991