lib/CodeGen/LiveIntervalAnalysis.cpp

   1 //===-- LiveIntervalAnalysis.cpp - Live Interval Analysis -----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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/LoopInfo.h"
  23 #include "llvm/CodeGen/LiveVariables.h"
  24 #include "llvm/CodeGen/MachineFrameInfo.h"
  25 #include "llvm/CodeGen/MachineInstr.h"
  26 #include "llvm/CodeGen/Passes.h"
  27 #include "llvm/CodeGen/SSARegMap.h"
  28 #include "llvm/Target/MRegisterInfo.h"
  29 #include "llvm/Target/TargetInstrInfo.h"
  30 #include "llvm/Target/TargetMachine.h"
  31 #include "llvm/Support/CommandLine.h"
  32 #include "llvm/Support/Debug.h"
  33 #include "llvm/ADT/Statistic.h"
  34 #include "llvm/ADT/STLExtras.h"
  35 #include <algorithm>
  36 #include <cmath>
  37 #include <iostream>
  38 using namespace llvm;
  39
  40 namespace {
  41   RegisterPass<LiveIntervals> X("liveintervals", "Live Interval Analysis");
  42
  43   static Statistic<> numIntervals
  44   ("liveintervals", "Number of original intervals");
  45
  46   static Statistic<> numIntervalsAfter
  47   ("liveintervals", "Number of intervals after coalescing");
  48
  49   static Statistic<> numJoins
  50   ("liveintervals", "Number of interval joins performed");
  51
  52   static Statistic<> numPeep
  53   ("liveintervals", "Number of identity moves eliminated after coalescing");
  54
  55   static Statistic<> numFolded
  56   ("liveintervals", "Number of loads/stores folded into instructions");
  57
  58   static cl::opt<bool>
  59   EnableJoining("join-liveintervals",
  60                 cl::desc("Coallesce copies (default=true)"),
  61                 cl::init(true));
  62 }
  63
  64 void LiveIntervals::getAnalysisUsage(AnalysisUsage &AU) const {
  65   AU.addRequired<LiveVariables>();
  66   AU.addPreservedID(PHIEliminationID);
  67   AU.addRequiredID(PHIEliminationID);
  68   AU.addRequiredID(TwoAddressInstructionPassID);
  69   AU.addRequired<LoopInfo>();
  70   MachineFunctionPass::getAnalysisUsage(AU);
  71 }
  72
  73 void LiveIntervals::releaseMemory() {
  74   mi2iMap_.clear();
  75   i2miMap_.clear();
  76   r2iMap_.clear();
  77   r2rMap_.clear();
  78 }
  79
  80
  81 static bool isZeroLengthInterval(LiveInterval *li) {
  82   for (LiveInterval::Ranges::const_iterator
  83          i = li->ranges.begin(), e = li->ranges.end(); i != e; ++i)
  84     if (i->end - i->start > LiveIntervals::InstrSlots::NUM)
  85       return false;
  86   return true;
  87 }
  88
  89
  90 /// runOnMachineFunction - Register allocate the whole function
  91 ///
  92 bool LiveIntervals::runOnMachineFunction(MachineFunction &fn) {
  93   mf_ = &fn;
  94   tm_ = &fn.getTarget();
  95   mri_ = tm_->getRegisterInfo();
  96   tii_ = tm_->getInstrInfo();
  97   lv_ = &getAnalysis<LiveVariables>();
  98   allocatableRegs_ = mri_->getAllocatableSet(fn);
  99   r2rMap_.grow(mf_->getSSARegMap()->getLastVirtReg());
 100
 101   // If this function has any live ins, insert a dummy instruction at the
 102   // beginning of the function that we will pretend "defines" the values.  This
 103   // is to make the interval analysis simpler by providing a number.
 104   if (fn.livein_begin() != fn.livein_end()) {
 105     unsigned FirstLiveIn = fn.livein_begin()->first;
 106
 107     // Find a reg class that contains this live in.
 108     const TargetRegisterClass *RC = 0;
 109     for (MRegisterInfo::regclass_iterator RCI = mri_->regclass_begin(),
 110            E = mri_->regclass_end(); RCI != E; ++RCI)
 111       if ((*RCI)->contains(FirstLiveIn)) {
 112         RC = *RCI;
 113         break;
 114       }
 115
 116     MachineInstr *OldFirstMI = fn.begin()->begin();
 117     mri_->copyRegToReg(*fn.begin(), fn.begin()->begin(),
 118                        FirstLiveIn, FirstLiveIn, RC);
 119     assert(OldFirstMI != fn.begin()->begin() &&
 120            "copyRetToReg didn't insert anything!");
 121   }
 122
 123   // Number MachineInstrs and MachineBasicBlocks.
 124   // Initialize MBB indexes to a sentinal.
 125   MBB2IdxMap.resize(mf_->getNumBlockIDs(), ~0U);
 126
 127   unsigned MIIndex = 0;
 128   for (MachineFunction::iterator MBB = mf_->begin(), E = mf_->end();
 129        MBB != E; ++MBB) {
 130     // Set the MBB2IdxMap entry for this MBB.
 131     MBB2IdxMap[MBB->getNumber()] = MIIndex;
 132
 133     for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end();
 134          I != E; ++I) {
 135       bool inserted = mi2iMap_.insert(std::make_pair(I, MIIndex)).second;
 136       assert(inserted && "multiple MachineInstr -> index mappings");
 137       i2miMap_.push_back(I);
 138       MIIndex += InstrSlots::NUM;
 139     }
 140   }
 141
 142   // Note intervals due to live-in values.
 143   if (fn.livein_begin() != fn.livein_end()) {
 144     MachineBasicBlock *Entry = fn.begin();
 145     for (MachineFunction::livein_iterator I = fn.livein_begin(),
 146            E = fn.livein_end(); I != E; ++I) {
 147       handlePhysicalRegisterDef(Entry, Entry->begin(), 0,
 148                                 getOrCreateInterval(I->first), 0);
 149       for (const unsigned* AS = mri_->getAliasSet(I->first); *AS; ++AS)
 150         handlePhysicalRegisterDef(Entry, Entry->begin(), 0,
 151                                   getOrCreateInterval(*AS), 0);
 152     }
 153   }
 154
 155   computeIntervals();
 156
 157   numIntervals += getNumIntervals();
 158
 159   DEBUG(std::cerr << "********** INTERVALS **********\n";
 160         for (iterator I = begin(), E = end(); I != E; ++I) {
 161           I->second.print(std::cerr, mri_);
 162           std::cerr << "\n";
 163         });
 164
 165   // Join (coallesce) intervals if requested.
 166   if (EnableJoining) joinIntervals();
 167
 168   numIntervalsAfter += getNumIntervals();
 169
 170
 171   // perform a final pass over the instructions and compute spill
 172   // weights, coalesce virtual registers and remove identity moves.
 173   const LoopInfo &loopInfo = getAnalysis<LoopInfo>();
 174
 175   for (MachineFunction::iterator mbbi = mf_->begin(), mbbe = mf_->end();
 176        mbbi != mbbe; ++mbbi) {
 177     MachineBasicBlock* mbb = mbbi;
 178     unsigned loopDepth = loopInfo.getLoopDepth(mbb->getBasicBlock());
 179
 180     for (MachineBasicBlock::iterator mii = mbb->begin(), mie = mbb->end();
 181          mii != mie; ) {
 182       // if the move will be an identity move delete it
 183       unsigned srcReg, dstReg, RegRep;
 184       if (tii_->isMoveInstr(*mii, srcReg, dstReg) &&
 185           (RegRep = rep(srcReg)) == rep(dstReg)) {
 186         // remove from def list
 187         getOrCreateInterval(RegRep);
 188         RemoveMachineInstrFromMaps(mii);
 189         mii = mbbi->erase(mii);
 190         ++numPeep;
 191       }
 192       else {
 193         for (unsigned i = 0, e = mii->getNumOperands(); i != e; ++i) {
 194           const MachineOperand &mop = mii->getOperand(i);
 195           if (mop.isRegister() && mop.getReg() &&
 196               MRegisterInfo::isVirtualRegister(mop.getReg())) {
 197             // replace register with representative register
 198             unsigned reg = rep(mop.getReg());
 199             mii->getOperand(i).setReg(reg);
 200
 201             LiveInterval &RegInt = getInterval(reg);
 202             RegInt.weight +=
 203               (mop.isUse() + mop.isDef()) * pow(10.0F, (int)loopDepth);
 204           }
 205         }
 206         ++mii;
 207       }
 208     }
 209   }
 210
 211
 212   for (iterator I = begin(), E = end(); I != E; ++I) {
 213     LiveInterval &LI = I->second;
 214     if (MRegisterInfo::isVirtualRegister(LI.reg)) {
 215       // If the live interval length is essentially zero, i.e. in every live
 216       // range the use follows def immediately, it doesn't make sense to spill
 217       // it and hope it will be easier to allocate for this li.
 218       if (isZeroLengthInterval(&LI))
 219         LI.weight = HUGE_VALF;
 220
 221       // Divide the weight of the interval by its size.  This encourages
 222       // spilling of intervals that are large and have few uses, and
 223       // discourages spilling of small intervals with many uses.
 224       unsigned Size = 0;
 225       for (LiveInterval::iterator II = LI.begin(), E = LI.end(); II != E;++II)
 226         Size += II->end - II->start;
 227
 228       LI.weight /= Size;
 229     }
 230   }
 231
 232   DEBUG(dump());
 233   return true;
 234 }
 235
 236 /// print - Implement the dump method.
 237 void LiveIntervals::print(std::ostream &O, const Module* ) const {
 238   O << "********** INTERVALS **********\n";
 239   for (const_iterator I = begin(), E = end(); I != E; ++I) {
 240     I->second.print(std::cerr, mri_);
 241     std::cerr << "\n";
 242   }
 243
 244   O << "********** MACHINEINSTRS **********\n";
 245   for (MachineFunction::iterator mbbi = mf_->begin(), mbbe = mf_->end();
 246        mbbi != mbbe; ++mbbi) {
 247     O << ((Value*)mbbi->getBasicBlock())->getName() << ":\n";
 248     for (MachineBasicBlock::iterator mii = mbbi->begin(),
 249            mie = mbbi->end(); mii != mie; ++mii) {
 250       O << getInstructionIndex(mii) << '\t' << *mii;
 251     }
 252   }
 253 }
 254
 255 std::vector<LiveInterval*> LiveIntervals::
 256 addIntervalsForSpills(const LiveInterval &li, VirtRegMap &vrm, int slot) {
 257   // since this is called after the analysis is done we don't know if
 258   // LiveVariables is available
 259   lv_ = getAnalysisToUpdate<LiveVariables>();
 260
 261   std::vector<LiveInterval*> added;
 262
 263   assert(li.weight != HUGE_VALF &&
 264          "attempt to spill already spilled interval!");
 265
 266   DEBUG(std::cerr << "\t\t\t\tadding intervals for spills for interval: ";
 267         li.print(std::cerr, mri_); std::cerr << '\n');
 268
 269   const TargetRegisterClass* rc = mf_->getSSARegMap()->getRegClass(li.reg);
 270
 271   for (LiveInterval::Ranges::const_iterator
 272          i = li.ranges.begin(), e = li.ranges.end(); i != e; ++i) {
 273     unsigned index = getBaseIndex(i->start);
 274     unsigned end = getBaseIndex(i->end-1) + InstrSlots::NUM;
 275     for (; index != end; index += InstrSlots::NUM) {
 276       // skip deleted instructions
 277       while (index != end && !getInstructionFromIndex(index))
 278         index += InstrSlots::NUM;
 279       if (index == end) break;
 280
 281       MachineInstr *MI = getInstructionFromIndex(index);
 282
 283     RestartInstruction:
 284       for (unsigned i = 0; i != MI->getNumOperands(); ++i) {
 285         MachineOperand& mop = MI->getOperand(i);
 286         if (mop.isRegister() && mop.getReg() == li.reg) {
 287           if (MachineInstr *fmi = mri_->foldMemoryOperand(MI, i, slot)) {
 288             // Attempt to fold the memory reference into the instruction.  If we
 289             // can do this, we don't need to insert spill code.
 290             if (lv_)
 291               lv_->instructionChanged(MI, fmi);
 292             MachineBasicBlock &MBB = *MI->getParent();
 293             vrm.virtFolded(li.reg, MI, i, fmi);
 294             mi2iMap_.erase(MI);
 295             i2miMap_[index/InstrSlots::NUM] = fmi;
 296             mi2iMap_[fmi] = index;
 297             MI = MBB.insert(MBB.erase(MI), fmi);
 298             ++numFolded;
 299             // Folding the load/store can completely change the instruction in
 300             // unpredictable ways, rescan it from the beginning.
 301             goto RestartInstruction;
 302           } else {
 303             // Create a new virtual register for the spill interval.
 304             unsigned NewVReg = mf_->getSSARegMap()->createVirtualRegister(rc);
 305
 306             // Scan all of the operands of this instruction rewriting operands
 307             // to use NewVReg instead of li.reg as appropriate.  We do this for
 308             // two reasons:
 309             //
 310             //   1. If the instr reads the same spilled vreg multiple times, we
 311             //      want to reuse the NewVReg.
 312             //   2. If the instr is a two-addr instruction, we are required to
 313             //      keep the src/dst regs pinned.
 314             //
 315             // Keep track of whether we replace a use and/or def so that we can
 316             // create the spill interval with the appropriate range.
 317             mop.setReg(NewVReg);
 318
 319             bool HasUse = mop.isUse();
 320             bool HasDef = mop.isDef();
 321             for (unsigned j = i+1, e = MI->getNumOperands(); j != e; ++j) {
 322               if (MI->getOperand(j).isReg() &&
 323                   MI->getOperand(j).getReg() == li.reg) {
 324                 MI->getOperand(j).setReg(NewVReg);
 325                 HasUse |= MI->getOperand(j).isUse();
 326                 HasDef |= MI->getOperand(j).isDef();
 327               }
 328             }
 329
 330             // create a new register for this spill
 331             vrm.grow();
 332             vrm.assignVirt2StackSlot(NewVReg, slot);
 333             LiveInterval &nI = getOrCreateInterval(NewVReg);
 334             assert(nI.empty());
 335
 336             // the spill weight is now infinity as it
 337             // cannot be spilled again
 338             nI.weight = HUGE_VALF;
 339
 340             if (HasUse) {
 341               LiveRange LR(getLoadIndex(index), getUseIndex(index),
 342                            nI.getNextValue(~0U, 0));
 343               DEBUG(std::cerr << " +" << LR);
 344               nI.addRange(LR);
 345             }
 346             if (HasDef) {
 347               LiveRange LR(getDefIndex(index), getStoreIndex(index),
 348                            nI.getNextValue(~0U, 0));
 349               DEBUG(std::cerr << " +" << LR);
 350               nI.addRange(LR);
 351             }
 352
 353             added.push_back(&nI);
 354
 355             // update live variables if it is available
 356             if (lv_)
 357               lv_->addVirtualRegisterKilled(NewVReg, MI);
 358
 359             DEBUG(std::cerr << "\t\t\t\tadded new interval: ";
 360                   nI.print(std::cerr, mri_); std::cerr << '\n');
 361           }
 362         }
 363       }
 364     }
 365   }
 366
 367   return added;
 368 }
 369
 370 void LiveIntervals::printRegName(unsigned reg) const {
 371   if (MRegisterInfo::isPhysicalRegister(reg))
 372     std::cerr << mri_->getName(reg);
 373   else
 374     std::cerr << "%reg" << reg;
 375 }
 376
 377 /// isReDefinedByTwoAddr - Returns true if the Reg re-definition is due to
 378 /// two addr elimination.
 379 static bool isReDefinedByTwoAddr(MachineInstr *MI, unsigned Reg,
 380                                 const TargetInstrInfo *TII) {
 381   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 382     MachineOperand &MO1 = MI->getOperand(i);
 383     if (MO1.isRegister() && MO1.isDef() && MO1.getReg() == Reg) {
 384       for (unsigned j = i+1; j < e; ++j) {
 385         MachineOperand &MO2 = MI->getOperand(j);
 386         if (MO2.isRegister() && MO2.isUse() && MO2.getReg() == Reg &&
 387             TII->getOperandConstraint(MI->getOpcode(), j,
 388                                       TargetInstrInfo::TIED_TO) == (int)i)
 389           return true;
 390       }
 391     }
 392   }
 393   return false;
 394 }
 395
 396 void LiveIntervals::handleVirtualRegisterDef(MachineBasicBlock *mbb,
 397                                              MachineBasicBlock::iterator mi,
 398                                              unsigned MIIdx,
 399                                              LiveInterval &interval) {
 400   DEBUG(std::cerr << "\t\tregister: "; printRegName(interval.reg));
 401   LiveVariables::VarInfo& vi = lv_->getVarInfo(interval.reg);
 402
 403   // Virtual registers may be defined multiple times (due to phi
 404   // elimination and 2-addr elimination).  Much of what we do only has to be
 405   // done once for the vreg.  We use an empty interval to detect the first
 406   // time we see a vreg.
 407   if (interval.empty()) {
 408     // Get the Idx of the defining instructions.
 409     unsigned defIndex = getDefIndex(MIIdx);
 410
 411     unsigned ValNum;
 412     unsigned SrcReg, DstReg;
 413     if (!tii_->isMoveInstr(*mi, SrcReg, DstReg))
 414       ValNum = interval.getNextValue(~0U, 0);
 415     else
 416       ValNum = interval.getNextValue(defIndex, SrcReg);
 417
 418     assert(ValNum == 0 && "First value in interval is not 0?");
 419     ValNum = 0;  // Clue in the optimizer.
 420
 421     // Loop over all of the blocks that the vreg is defined in.  There are
 422     // two cases we have to handle here.  The most common case is a vreg
 423     // whose lifetime is contained within a basic block.  In this case there
 424     // will be a single kill, in MBB, which comes after the definition.
 425     if (vi.Kills.size() == 1 && vi.Kills[0]->getParent() == mbb) {
 426       // FIXME: what about dead vars?
 427       unsigned killIdx;
 428       if (vi.Kills[0] != mi)
 429         killIdx = getUseIndex(getInstructionIndex(vi.Kills[0]))+1;
 430       else
 431         killIdx = defIndex+1;
 432
 433       // If the kill happens after the definition, we have an intra-block
 434       // live range.
 435       if (killIdx > defIndex) {
 436         assert(vi.AliveBlocks.empty() &&
 437                "Shouldn't be alive across any blocks!");
 438         LiveRange LR(defIndex, killIdx, ValNum);
 439         interval.addRange(LR);
 440         DEBUG(std::cerr << " +" << LR << "\n");
 441         return;
 442       }
 443     }
 444
 445     // The other case we handle is when a virtual register lives to the end
 446     // of the defining block, potentially live across some blocks, then is
 447     // live into some number of blocks, but gets killed.  Start by adding a
 448     // range that goes from this definition to the end of the defining block.
 449     LiveRange NewLR(defIndex,
 450                     getInstructionIndex(&mbb->back()) + InstrSlots::NUM,
 451                     ValNum);
 452     DEBUG(std::cerr << " +" << NewLR);
 453     interval.addRange(NewLR);
 454
 455     // Iterate over all of the blocks that the variable is completely
 456     // live in, adding [insrtIndex(begin), instrIndex(end)+4) to the
 457     // live interval.
 458     for (unsigned i = 0, e = vi.AliveBlocks.size(); i != e; ++i) {
 459       if (vi.AliveBlocks[i]) {
 460         MachineBasicBlock *MBB = mf_->getBlockNumbered(i);
 461         if (!MBB->empty()) {
 462           LiveRange LR(getMBBStartIdx(i),
 463                        getInstructionIndex(&MBB->back()) + InstrSlots::NUM,
 464                        ValNum);
 465           interval.addRange(LR);
 466           DEBUG(std::cerr << " +" << LR);
 467         }
 468       }
 469     }
 470
 471     // Finally, this virtual register is live from the start of any killing
 472     // block to the 'use' slot of the killing instruction.
 473     for (unsigned i = 0, e = vi.Kills.size(); i != e; ++i) {
 474       MachineInstr *Kill = vi.Kills[i];
 475       LiveRange LR(getMBBStartIdx(Kill->getParent()),
 476                    getUseIndex(getInstructionIndex(Kill))+1,
 477                    ValNum);
 478       interval.addRange(LR);
 479       DEBUG(std::cerr << " +" << LR);
 480     }
 481
 482   } else {
 483     // If this is the second time we see a virtual register definition, it
 484     // must be due to phi elimination or two addr elimination.  If this is
 485     // the result of two address elimination, then the vreg is one of the
 486     // def-and-use register operand.
 487     if (isReDefinedByTwoAddr(mi, interval.reg, tii_)) {
 488       // If this is a two-address definition, then we have already processed
 489       // the live range.  The only problem is that we didn't realize there
 490       // are actually two values in the live interval.  Because of this we
 491       // need to take the LiveRegion that defines this register and split it
 492       // into two values.
 493       unsigned DefIndex = getDefIndex(getInstructionIndex(vi.DefInst));
 494       unsigned RedefIndex = getDefIndex(MIIdx);
 495
 496       // Delete the initial value, which should be short and continuous,
 497       // because the 2-addr copy must be in the same MBB as the redef.
 498       interval.removeRange(DefIndex, RedefIndex);
 499
 500       // Two-address vregs should always only be redefined once.  This means
 501       // that at this point, there should be exactly one value number in it.
 502       assert(interval.containsOneValue() && "Unexpected 2-addr liveint!");
 503
 504       // The new value number (#1) is defined by the instruction we claimed
 505       // defined value #0.
 506       unsigned ValNo = interval.getNextValue(0, 0);
 507       interval.setValueNumberInfo(1, interval.getValNumInfo(0));
 508
 509       // Value#0 is now defined by the 2-addr instruction.
 510       interval.setValueNumberInfo(0, std::make_pair(~0U, 0U));
 511
 512       // Add the new live interval which replaces the range for the input copy.
 513       LiveRange LR(DefIndex, RedefIndex, ValNo);
 514       DEBUG(std::cerr << " replace range with " << LR);
 515       interval.addRange(LR);
 516
 517       // If this redefinition is dead, we need to add a dummy unit live
 518       // range covering the def slot.
 519       if (lv_->RegisterDefIsDead(mi, interval.reg))
 520         interval.addRange(LiveRange(RedefIndex, RedefIndex+1, 0));
 521
 522       DEBUG(std::cerr << "RESULT: "; interval.print(std::cerr, mri_));
 523
 524     } else {
 525       // Otherwise, this must be because of phi elimination.  If this is the
 526       // first redefinition of the vreg that we have seen, go back and change
 527       // the live range in the PHI block to be a different value number.
 528       if (interval.containsOneValue()) {
 529         assert(vi.Kills.size() == 1 &&
 530                "PHI elimination vreg should have one kill, the PHI itself!");
 531
 532         // Remove the old range that we now know has an incorrect number.
 533         MachineInstr *Killer = vi.Kills[0];
 534         unsigned Start = getMBBStartIdx(Killer->getParent());
 535         unsigned End = getUseIndex(getInstructionIndex(Killer))+1;
 536         DEBUG(std::cerr << "Removing [" << Start << "," << End << "] from: ";
 537               interval.print(std::cerr, mri_); std::cerr << "\n");
 538         interval.removeRange(Start, End);
 539         DEBUG(std::cerr << "RESULT: "; interval.print(std::cerr, mri_));
 540
 541         // Replace the interval with one of a NEW value number.  Note that this
 542         // value number isn't actually defined by an instruction, weird huh? :)
 543         LiveRange LR(Start, End, interval.getNextValue(~0U, 0));
 544         DEBUG(std::cerr << " replace range with " << LR);
 545         interval.addRange(LR);
 546         DEBUG(std::cerr << "RESULT: "; interval.print(std::cerr, mri_));
 547       }
 548
 549       // In the case of PHI elimination, each variable definition is only
 550       // live until the end of the block.  We've already taken care of the
 551       // rest of the live range.
 552       unsigned defIndex = getDefIndex(MIIdx);
 553
 554       unsigned ValNum;
 555       unsigned SrcReg, DstReg;
 556       if (!tii_->isMoveInstr(*mi, SrcReg, DstReg))
 557         ValNum = interval.getNextValue(~0U, 0);
 558       else
 559         ValNum = interval.getNextValue(defIndex, SrcReg);
 560
 561       LiveRange LR(defIndex,
 562                    getInstructionIndex(&mbb->back()) + InstrSlots::NUM, ValNum);
 563       interval.addRange(LR);
 564       DEBUG(std::cerr << " +" << LR);
 565     }
 566   }
 567
 568   DEBUG(std::cerr << '\n');
 569 }
 570
 571 void LiveIntervals::handlePhysicalRegisterDef(MachineBasicBlock *MBB,
 572                                               MachineBasicBlock::iterator mi,
 573                                               unsigned MIIdx,
 574                                               LiveInterval &interval,
 575                                               unsigned SrcReg) {
 576   // A physical register cannot be live across basic block, so its
 577   // lifetime must end somewhere in its defining basic block.
 578   DEBUG(std::cerr << "\t\tregister: "; printRegName(interval.reg));
 579   typedef LiveVariables::killed_iterator KillIter;
 580
 581   unsigned baseIndex = MIIdx;
 582   unsigned start = getDefIndex(baseIndex);
 583   unsigned end = start;
 584
 585   // If it is not used after definition, it is considered dead at
 586   // the instruction defining it. Hence its interval is:
 587   // [defSlot(def), defSlot(def)+1)
 588   if (lv_->RegisterDefIsDead(mi, interval.reg)) {
 589     DEBUG(std::cerr << " dead");
 590     end = getDefIndex(start) + 1;
 591     goto exit;
 592   }
 593
 594   // If it is not dead on definition, it must be killed by a
 595   // subsequent instruction. Hence its interval is:
 596   // [defSlot(def), useSlot(kill)+1)
 597   while (++mi != MBB->end()) {
 598     baseIndex += InstrSlots::NUM;
 599     if (lv_->KillsRegister(mi, interval.reg)) {
 600       DEBUG(std::cerr << " killed");
 601       end = getUseIndex(baseIndex) + 1;
 602       goto exit;
 603     }
 604   }
 605
 606   // The only case we should have a dead physreg here without a killing or
 607   // instruction where we know it's dead is if it is live-in to the function
 608   // and never used.
 609   assert(!SrcReg && "physreg was not killed in defining block!");
 610   end = getDefIndex(start) + 1;  // It's dead.
 611
 612 exit:
 613   assert(start < end && "did not find end of interval?");
 614
 615   LiveRange LR(start, end, interval.getNextValue(SrcReg != 0 ? start : ~0U,
 616                                                  SrcReg));
 617   interval.addRange(LR);
 618   DEBUG(std::cerr << " +" << LR << '\n');
 619 }
 620
 621 void LiveIntervals::handleRegisterDef(MachineBasicBlock *MBB,
 622                                       MachineBasicBlock::iterator MI,
 623                                       unsigned MIIdx,
 624                                       unsigned reg) {
 625   if (MRegisterInfo::isVirtualRegister(reg))
 626     handleVirtualRegisterDef(MBB, MI, MIIdx, getOrCreateInterval(reg));
 627   else if (allocatableRegs_[reg]) {
 628     unsigned SrcReg, DstReg;
 629     if (!tii_->isMoveInstr(*MI, SrcReg, DstReg))
 630       SrcReg = 0;
 631     handlePhysicalRegisterDef(MBB, MI, MIIdx, getOrCreateInterval(reg), SrcReg);
 632     for (const unsigned* AS = mri_->getAliasSet(reg); *AS; ++AS)
 633       handlePhysicalRegisterDef(MBB, MI, MIIdx, getOrCreateInterval(*AS), 0);
 634   }
 635 }
 636
 637 /// computeIntervals - computes the live intervals for virtual
 638 /// registers. for some ordering of the machine instructions [1,N] a
 639 /// live interval is an interval [i, j) where 1 <= i <= j < N for
 640 /// which a variable is live
 641 void LiveIntervals::computeIntervals() {
 642   DEBUG(std::cerr << "********** COMPUTING LIVE INTERVALS **********\n");
 643   DEBUG(std::cerr << "********** Function: "
 644         << ((Value*)mf_->getFunction())->getName() << '\n');
 645   bool IgnoreFirstInstr = mf_->livein_begin() != mf_->livein_end();
 646
 647   // Track the index of the current machine instr.
 648   unsigned MIIndex = 0;
 649   for (MachineFunction::iterator MBBI = mf_->begin(), E = mf_->end();
 650        MBBI != E; ++MBBI) {
 651     MachineBasicBlock *MBB = MBBI;
 652     DEBUG(std::cerr << ((Value*)MBB->getBasicBlock())->getName() << ":\n");
 653
 654     MachineBasicBlock::iterator MI = MBB->begin(), miEnd = MBB->end();
 655     if (IgnoreFirstInstr) {
 656       ++MI;
 657       IgnoreFirstInstr = false;
 658       MIIndex += InstrSlots::NUM;
 659     }
 660
 661     for (; MI != miEnd; ++MI) {
 662       const TargetInstrDescriptor &TID = tii_->get(MI->getOpcode());
 663       DEBUG(std::cerr << MIIndex << "\t" << *MI);
 664
 665       // Handle implicit defs.
 666       if (TID.ImplicitDefs) {
 667         for (const unsigned *ImpDef = TID.ImplicitDefs; *ImpDef; ++ImpDef)
 668           handleRegisterDef(MBB, MI, MIIndex, *ImpDef);
 669       }
 670
 671       // Handle explicit defs.
 672       for (int i = MI->getNumOperands() - 1; i >= 0; --i) {
 673         MachineOperand &MO = MI->getOperand(i);
 674         // handle register defs - build intervals
 675         if (MO.isRegister() && MO.getReg() && MO.isDef())
 676           handleRegisterDef(MBB, MI, MIIndex, MO.getReg());
 677       }
 678
 679       MIIndex += InstrSlots::NUM;
 680     }
 681   }
 682 }
 683
 684 /// AdjustCopiesBackFrom - We found a non-trivially-coallescable copy with IntA
 685 /// being the source and IntB being the dest, thus this defines a value number
 686 /// in IntB.  If the source value number (in IntA) is defined by a copy from B,
 687 /// see if we can merge these two pieces of B into a single value number,
 688 /// eliminating a copy.  For example:
 689 ///
 690 ///  A3 = B0
 691 ///    ...
 692 ///  B1 = A3      <- this copy
 693 ///
 694 /// In this case, B0 can be extended to where the B1 copy lives, allowing the B1
 695 /// value number to be replaced with B0 (which simplifies the B liveinterval).
 696 ///
 697 /// This returns true if an interval was modified.
 698 ///
 699 bool LiveIntervals::AdjustCopiesBackFrom(LiveInterval &IntA, LiveInterval &IntB,
 700                                          MachineInstr *CopyMI) {
 701   unsigned CopyIdx = getDefIndex(getInstructionIndex(CopyMI));
 702
 703   // BValNo is a value number in B that is defined by a copy from A.  'B3' in
 704   // the example above.
 705   LiveInterval::iterator BLR = IntB.FindLiveRangeContaining(CopyIdx);
 706   unsigned BValNo = BLR->ValId;
 707
 708   // Get the location that B is defined at.  Two options: either this value has
 709   // an unknown definition point or it is defined at CopyIdx.  If unknown, we
 710   // can't process it.
 711   unsigned BValNoDefIdx = IntB.getInstForValNum(BValNo);
 712   if (BValNoDefIdx == ~0U) return false;
 713   assert(BValNoDefIdx == CopyIdx &&
 714          "Copy doesn't define the value?");
 715
 716   // AValNo is the value number in A that defines the copy, A0 in the example.
 717   LiveInterval::iterator AValLR = IntA.FindLiveRangeContaining(CopyIdx-1);
 718   unsigned AValNo = AValLR->ValId;
 719
 720   // If AValNo is defined as a copy from IntB, we can potentially process this.
 721
 722   // Get the instruction that defines this value number.
 723   unsigned SrcReg = IntA.getSrcRegForValNum(AValNo);
 724   if (!SrcReg) return false;  // Not defined by a copy.
 725
 726   // If the value number is not defined by a copy instruction, ignore it.
 727
 728   // If the source register comes from an interval other than IntB, we can't
 729   // handle this.
 730   if (rep(SrcReg) != IntB.reg) return false;
 731
 732   // Get the LiveRange in IntB that this value number starts with.
 733   unsigned AValNoInstIdx = IntA.getInstForValNum(AValNo);
 734   LiveInterval::iterator ValLR = IntB.FindLiveRangeContaining(AValNoInstIdx-1);
 735
 736   // Make sure that the end of the live range is inside the same block as
 737   // CopyMI.
 738   MachineInstr *ValLREndInst = getInstructionFromIndex(ValLR->end-1);
 739   if (!ValLREndInst ||
 740       ValLREndInst->getParent() != CopyMI->getParent()) return false;
 741
 742   // Okay, we now know that ValLR ends in the same block that the CopyMI
 743   // live-range starts.  If there are no intervening live ranges between them in
 744   // IntB, we can merge them.
 745   if (ValLR+1 != BLR) return false;
 746
 747   DEBUG(std::cerr << "\nExtending: "; IntB.print(std::cerr, mri_));
 748
 749   // We are about to delete CopyMI, so need to remove it as the 'instruction
 750   // that defines this value #'.
 751   IntB.setValueNumberInfo(BValNo, std::make_pair(~0U, 0));
 752
 753   // Okay, we can merge them.  We need to insert a new liverange:
 754   // [ValLR.end, BLR.begin) of either value number, then we merge the
 755   // two value numbers.
 756   unsigned FillerStart = ValLR->end, FillerEnd = BLR->start;
 757   IntB.addRange(LiveRange(FillerStart, FillerEnd, BValNo));
 758
 759   // If the IntB live range is assigned to a physical register, and if that
 760   // physreg has aliases,
 761   if (MRegisterInfo::isPhysicalRegister(IntB.reg)) {
 762     for (const unsigned *AS = mri_->getAliasSet(IntB.reg); *AS; ++AS) {
 763       LiveInterval &AliasLI = getInterval(*AS);
 764       AliasLI.addRange(LiveRange(FillerStart, FillerEnd,
 765                                  AliasLI.getNextValue(~0U, 0)));
 766     }
 767   }
 768
 769   // Okay, merge "B1" into the same value number as "B0".
 770   if (BValNo != ValLR->ValId)
 771     IntB.MergeValueNumberInto(BValNo, ValLR->ValId);
 772   DEBUG(std::cerr << "   result = "; IntB.print(std::cerr, mri_);
 773         std::cerr << "\n");
 774
 775   // Finally, delete the copy instruction.
 776   RemoveMachineInstrFromMaps(CopyMI);
 777   CopyMI->eraseFromParent();
 778   ++numPeep;
 779   return true;
 780 }
 781
 782
 783 /// JoinCopy - Attempt to join intervals corresponding to SrcReg/DstReg,
 784 /// which are the src/dst of the copy instruction CopyMI.  This returns true
 785 /// if the copy was successfully coallesced away, or if it is never possible
 786 /// to coallesce these this copy, due to register constraints.  It returns
 787 /// false if it is not currently possible to coallesce this interval, but
 788 /// it may be possible if other things get coallesced.
 789 bool LiveIntervals::JoinCopy(MachineInstr *CopyMI,
 790                              unsigned SrcReg, unsigned DstReg) {
 791
 792
 793   DEBUG(std::cerr << getInstructionIndex(CopyMI) << '\t' << *CopyMI);
 794
 795   // Get representative registers.
 796   SrcReg = rep(SrcReg);
 797   DstReg = rep(DstReg);
 798
 799   // If they are already joined we continue.
 800   if (SrcReg == DstReg) {
 801     DEBUG(std::cerr << "\tCopy already coallesced.\n");
 802     return true;  // Not coallescable.
 803   }
 804
 805   // If they are both physical registers, we cannot join them.
 806   if (MRegisterInfo::isPhysicalRegister(SrcReg) &&
 807       MRegisterInfo::isPhysicalRegister(DstReg)) {
 808     DEBUG(std::cerr << "\tCan not coallesce physregs.\n");
 809     return true;  // Not coallescable.
 810   }
 811
 812   // We only join virtual registers with allocatable physical registers.
 813   if (MRegisterInfo::isPhysicalRegister(SrcReg) && !allocatableRegs_[SrcReg]){
 814     DEBUG(std::cerr << "\tSrc reg is unallocatable physreg.\n");
 815     return true;  // Not coallescable.
 816   }
 817   if (MRegisterInfo::isPhysicalRegister(DstReg) && !allocatableRegs_[DstReg]){
 818     DEBUG(std::cerr << "\tDst reg is unallocatable physreg.\n");
 819     return true;  // Not coallescable.
 820   }
 821
 822   // If they are not of the same register class, we cannot join them.
 823   if (differingRegisterClasses(SrcReg, DstReg)) {
 824     DEBUG(std::cerr << "\tSrc/Dest are different register classes.\n");
 825     return true;  // Not coallescable.
 826   }
 827
 828   LiveInterval &SrcInt = getInterval(SrcReg);
 829   LiveInterval &DestInt = getInterval(DstReg);
 830   assert(SrcInt.reg == SrcReg && DestInt.reg == DstReg &&
 831          "Register mapping is horribly broken!");
 832
 833   DEBUG(std::cerr << "\t\tInspecting "; SrcInt.print(std::cerr, mri_);
 834         std::cerr << " and "; DestInt.print(std::cerr, mri_);
 835         std::cerr << ": ");
 836
 837   // Okay, attempt to join these two intervals.  On failure, this returns false.
 838   // Otherwise, if one of the intervals being joined is a physreg, this method
 839   // always canonicalizes DestInt to be it.  The output "SrcInt" will not have
 840   // been modified, so we can use this information below to update aliases.
 841   if (!JoinIntervals(DestInt, SrcInt)) {
 842     // Coallescing failed.
 843
 844     // If we can eliminate the copy without merging the live ranges, do so now.
 845     if (AdjustCopiesBackFrom(SrcInt, DestInt, CopyMI))
 846       return true;
 847
 848     // Otherwise, we are unable to join the intervals.
 849     DEBUG(std::cerr << "Interference!\n");
 850     return false;
 851   }
 852
 853   bool Swapped = SrcReg == DestInt.reg;
 854   if (Swapped)
 855     std::swap(SrcReg, DstReg);
 856   assert(MRegisterInfo::isVirtualRegister(SrcReg) &&
 857          "LiveInterval::join didn't work right!");
 858
 859   // If we're about to merge live ranges into a physical register live range,
 860   // we have to update any aliased register's live ranges to indicate that they
 861   // have clobbered values for this range.
 862   if (MRegisterInfo::isPhysicalRegister(DstReg)) {
 863     for (const unsigned *AS = mri_->getAliasSet(DstReg); *AS; ++AS)
 864       getInterval(*AS).MergeInClobberRanges(SrcInt);
 865   }
 866
 867   DEBUG(std::cerr << "\n\t\tJoined.  Result = "; DestInt.print(std::cerr, mri_);
 868         std::cerr << "\n");
 869
 870   // If the intervals were swapped by Join, swap them back so that the register
 871   // mapping (in the r2i map) is correct.
 872   if (Swapped) SrcInt.swap(DestInt);
 873   r2iMap_.erase(SrcReg);
 874   r2rMap_[SrcReg] = DstReg;
 875
 876   // Finally, delete the copy instruction.
 877   RemoveMachineInstrFromMaps(CopyMI);
 878   CopyMI->eraseFromParent();
 879   ++numPeep;
 880   ++numJoins;
 881   return true;
 882 }
 883
 884 /// ComputeUltimateVN - Assuming we are going to join two live intervals,
 885 /// compute what the resultant value numbers for each value in the input two
 886 /// ranges will be.  This is complicated by copies between the two which can
 887 /// and will commonly cause multiple value numbers to be merged into one.
 888 ///
 889 /// VN is the value number that we're trying to resolve.  InstDefiningValue
 890 /// keeps track of the new InstDefiningValue assignment for the result
 891 /// LiveInterval.  ThisFromOther/OtherFromThis are sets that keep track of
 892 /// whether a value in this or other is a copy from the opposite set.
 893 /// ThisValNoAssignments/OtherValNoAssignments keep track of value #'s that have
 894 /// already been assigned.
 895 ///
 896 /// ThisFromOther[x] - If x is defined as a copy from the other interval, this
 897 /// contains the value number the copy is from.
 898 ///
 899 static unsigned ComputeUltimateVN(unsigned VN,
 900                                   SmallVector<std::pair<unsigned,
 901                                                 unsigned>, 16> &ValueNumberInfo,
 902                                   SmallVector<int, 16> &ThisFromOther,
 903                                   SmallVector<int, 16> &OtherFromThis,
 904                                   SmallVector<int, 16> &ThisValNoAssignments,
 905                                   SmallVector<int, 16> &OtherValNoAssignments,
 906                                   LiveInterval &ThisLI, LiveInterval &OtherLI) {
 907   // If the VN has already been computed, just return it.
 908   if (ThisValNoAssignments[VN] >= 0)
 909     return ThisValNoAssignments[VN];
 910 //  assert(ThisValNoAssignments[VN] != -2 && "Cyclic case?");
 911
 912   // If this val is not a copy from the other val, then it must be a new value
 913   // number in the destination.
 914   int OtherValNo = ThisFromOther[VN];
 915   if (OtherValNo == -1) {
 916     ValueNumberInfo.push_back(ThisLI.getValNumInfo(VN));
 917     return ThisValNoAssignments[VN] = ValueNumberInfo.size()-1;
 918   }
 919
 920   // Otherwise, this *is* a copy from the RHS.  If the other side has already
 921   // been computed, return it.
 922   if (OtherValNoAssignments[OtherValNo] >= 0)
 923     return ThisValNoAssignments[VN] = OtherValNoAssignments[OtherValNo];
 924
 925   // Mark this value number as currently being computed, then ask what the
 926   // ultimate value # of the other value is.
 927   ThisValNoAssignments[VN] = -2;
 928   unsigned UltimateVN =
 929     ComputeUltimateVN(OtherValNo, ValueNumberInfo,
 930                       OtherFromThis, ThisFromOther,
 931                       OtherValNoAssignments, ThisValNoAssignments,
 932                       OtherLI, ThisLI);
 933   return ThisValNoAssignments[VN] = UltimateVN;
 934 }
 935
 936 static bool InVector(unsigned Val, const SmallVector<unsigned, 8> &V) {
 937   return std::find(V.begin(), V.end(), Val) != V.end();
 938 }
 939
 940 /// SimpleJoin - Attempt to joint the specified interval into this one. The
 941 /// caller of this method must guarantee that the RHS only contains a single
 942 /// value number and that the RHS is not defined by a copy from this
 943 /// interval.  This returns false if the intervals are not joinable, or it
 944 /// joins them and returns true.
 945 bool LiveIntervals::SimpleJoin(LiveInterval &LHS, LiveInterval &RHS) {
 946   assert(RHS.containsOneValue());
 947
 948   // Some number (potentially more than one) value numbers in the current
 949   // interval may be defined as copies from the RHS.  Scan the overlapping
 950   // portions of the LHS and RHS, keeping track of this and looking for
 951   // overlapping live ranges that are NOT defined as copies.  If these exist, we
 952   // cannot coallesce.
 953
 954   LiveInterval::iterator LHSIt = LHS.begin(), LHSEnd = LHS.end();
 955   LiveInterval::iterator RHSIt = RHS.begin(), RHSEnd = RHS.end();
 956
 957   if (LHSIt->start < RHSIt->start) {
 958     LHSIt = std::upper_bound(LHSIt, LHSEnd, RHSIt->start);
 959     if (LHSIt != LHS.begin()) --LHSIt;
 960   } else if (RHSIt->start < LHSIt->start) {
 961     RHSIt = std::upper_bound(RHSIt, RHSEnd, LHSIt->start);
 962     if (RHSIt != RHS.begin()) --RHSIt;
 963   }
 964
 965   SmallVector<unsigned, 8> EliminatedLHSVals;
 966
 967   while (1) {
 968     // Determine if these live intervals overlap.
 969     bool Overlaps = false;
 970     if (LHSIt->start <= RHSIt->start)
 971       Overlaps = LHSIt->end > RHSIt->start;
 972     else
 973       Overlaps = RHSIt->end > LHSIt->start;
 974
 975     // If the live intervals overlap, there are two interesting cases: if the
 976     // LHS interval is defined by a copy from the RHS, it's ok and we record
 977     // that the LHS value # is the same as the RHS.  If it's not, then we cannot
 978     // coallesce these live ranges and we bail out.
 979     if (Overlaps) {
 980       // If we haven't already recorded that this value # is safe, check it.
 981       if (!InVector(LHSIt->ValId, EliminatedLHSVals)) {
 982         // Copy from the RHS?
 983         unsigned SrcReg = LHS.getSrcRegForValNum(LHSIt->ValId);
 984         if (rep(SrcReg) != RHS.reg)
 985           return false;    // Nope, bail out.
 986
 987         EliminatedLHSVals.push_back(LHSIt->ValId);
 988       }
 989
 990       // We know this entire LHS live range is okay, so skip it now.
 991       if (++LHSIt == LHSEnd) break;
 992       continue;
 993     }
 994
 995     if (LHSIt->end < RHSIt->end) {
 996       if (++LHSIt == LHSEnd) break;
 997     } else {
 998       // One interesting case to check here.  It's possible that we have
 999       // something like "X3 = Y" which defines a new value number in the LHS,
1000       // and is the last use of this liverange of the RHS.  In this case, we
1001       // want to notice this copy (so that it gets coallesced away) even though
1002       // the live ranges don't actually overlap.
1003       if (LHSIt->start == RHSIt->end) {
1004         if (InVector(LHSIt->ValId, EliminatedLHSVals)) {
1005           // We already know that this value number is going to be merged in
1006           // if coallescing succeeds.  Just skip the liverange.
1007           if (++LHSIt == LHSEnd) break;
1008         } else {
1009           // Otherwise, if this is a copy from the RHS, mark it as being merged
1010           // in.
1011           if (rep(LHS.getSrcRegForValNum(LHSIt->ValId)) == RHS.reg) {
1012             EliminatedLHSVals.push_back(LHSIt->ValId);
1013
1014             // We know this entire LHS live range is okay, so skip it now.
1015             if (++LHSIt == LHSEnd) break;
1016           }
1017         }
1018       }
1019
1020       if (++RHSIt == RHSEnd) break;
1021     }
1022   }
1023
1024   // If we got here, we know that the coallescing will be successful and that
1025   // the value numbers in EliminatedLHSVals will all be merged together.  Since
1026   // the most common case is that EliminatedLHSVals has a single number, we
1027   // optimize for it: if there is more than one value, we merge them all into
1028   // the lowest numbered one, then handle the interval as if we were merging
1029   // with one value number.
1030   unsigned LHSValNo;
1031   if (EliminatedLHSVals.size() > 1) {
1032     // Loop through all the equal value numbers merging them into the smallest
1033     // one.
1034     unsigned Smallest = EliminatedLHSVals[0];
1035     for (unsigned i = 1, e = EliminatedLHSVals.size(); i != e; ++i) {
1036       if (EliminatedLHSVals[i] < Smallest) {
1037         // Merge the current notion of the smallest into the smaller one.
1038         LHS.MergeValueNumberInto(Smallest, EliminatedLHSVals[i]);
1039         Smallest = EliminatedLHSVals[i];
1040       } else {
1041         // Merge into the smallest.
1042         LHS.MergeValueNumberInto(EliminatedLHSVals[i], Smallest);
1043       }
1044     }
1045     LHSValNo = Smallest;
1046   } else {
1047     assert(!EliminatedLHSVals.empty() && "No copies from the RHS?");
1048     LHSValNo = EliminatedLHSVals[0];
1049   }
1050
1051   // Okay, now that there is a single LHS value number that we're merging the
1052   // RHS into, update the value number info for the LHS to indicate that the
1053   // value number is defined where the RHS value number was.
1054   LHS.setValueNumberInfo(LHSValNo, RHS.getValNumInfo(0));
1055
1056   // Okay, the final step is to loop over the RHS live intervals, adding them to
1057   // the LHS.
1058   LHS.MergeRangesInAsValue(RHS, LHSValNo);
1059   LHS.weight += RHS.weight;
1060
1061   return true;
1062 }
1063
1064 /// JoinIntervals - Attempt to join these two intervals.  On failure, this
1065 /// returns false.  Otherwise, if one of the intervals being joined is a
1066 /// physreg, this method always canonicalizes LHS to be it.  The output
1067 /// "RHS" will not have been modified, so we can use this information
1068 /// below to update aliases.
1069 bool LiveIntervals::JoinIntervals(LiveInterval &LHS, LiveInterval &RHS) {
1070   // Compute the final value assignment, assuming that the live ranges can be
1071   // coallesced.
1072   SmallVector<int, 16> LHSValNoAssignments;
1073   SmallVector<int, 16> RHSValNoAssignments;
1074   SmallVector<std::pair<unsigned,unsigned>, 16> ValueNumberInfo;
1075
1076   // Compute ultimate value numbers for the LHS and RHS values.
1077   if (RHS.containsOneValue()) {
1078     // Copies from a liveinterval with a single value are simple to handle and
1079     // very common, handle the special case here.  This is important, because
1080     // often RHS is small and LHS is large (e.g. a physreg).
1081
1082     // Find out if the RHS is defined as a copy from some value in the LHS.
1083     int RHSValID = -1;
1084     std::pair<unsigned,unsigned> RHSValNoInfo;
1085     unsigned RHSSrcReg = RHS.getSrcRegForValNum(0);
1086     if ((RHSSrcReg == 0 || rep(RHSSrcReg) != LHS.reg)) {
1087       // If RHS is not defined as a copy from the LHS, we can use simpler and
1088       // faster checks to see if the live ranges are coallescable.  This joiner
1089       // can't swap the LHS/RHS intervals though.
1090       if (!MRegisterInfo::isPhysicalRegister(RHS.reg)) {
1091         return SimpleJoin(LHS, RHS);
1092       } else {
1093         RHSValNoInfo = RHS.getValNumInfo(0);
1094       }
1095     } else {
1096       // It was defined as a copy from the LHS, find out what value # it is.
1097       unsigned ValInst = RHS.getInstForValNum(0);
1098       RHSValID = LHS.getLiveRangeContaining(ValInst-1)->ValId;
1099       RHSValNoInfo = LHS.getValNumInfo(RHSValID);
1100     }
1101
1102     LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
1103     RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
1104     ValueNumberInfo.resize(LHS.getNumValNums());
1105
1106     // Okay, *all* of the values in LHS that are defined as a copy from RHS
1107     // should now get updated.
1108     for (unsigned VN = 0, e = LHS.getNumValNums(); VN != e; ++VN) {
1109       if (unsigned LHSSrcReg = LHS.getSrcRegForValNum(VN)) {
1110         if (rep(LHSSrcReg) != RHS.reg) {
1111           // If this is not a copy from the RHS, its value number will be
1112           // unmodified by the coallescing.
1113           ValueNumberInfo[VN] = LHS.getValNumInfo(VN);
1114           LHSValNoAssignments[VN] = VN;
1115         } else if (RHSValID == -1) {
1116           // Otherwise, it is a copy from the RHS, and we don't already have a
1117           // value# for it.  Keep the current value number, but remember it.
1118           LHSValNoAssignments[VN] = RHSValID = VN;
1119           ValueNumberInfo[VN] = RHSValNoInfo;
1120         } else {
1121           // Otherwise, use the specified value #.
1122           LHSValNoAssignments[VN] = RHSValID;
1123           if (VN != (unsigned)RHSValID)
1124             ValueNumberInfo[VN].first = ~1U;
1125           else
1126             ValueNumberInfo[VN] = RHSValNoInfo;
1127         }
1128       } else {
1129         ValueNumberInfo[VN] = LHS.getValNumInfo(VN);
1130         LHSValNoAssignments[VN] = VN;
1131       }
1132     }
1133
1134     assert(RHSValID != -1 && "Didn't find value #?");
1135     RHSValNoAssignments[0] = RHSValID;
1136
1137   } else {
1138     // Loop over the value numbers of the LHS, seeing if any are defined from
1139     // the RHS.
1140     SmallVector<int, 16> LHSValsDefinedFromRHS;
1141     LHSValsDefinedFromRHS.resize(LHS.getNumValNums(), -1);
1142     for (unsigned VN = 0, e = LHS.getNumValNums(); VN != e; ++VN) {
1143       unsigned ValSrcReg = LHS.getSrcRegForValNum(VN);
1144       if (ValSrcReg == 0)  // Src not defined by a copy?
1145         continue;
1146
1147       // DstReg is known to be a register in the LHS interval.  If the src is
1148       // from the RHS interval, we can use its value #.
1149       if (rep(ValSrcReg) != RHS.reg)
1150         continue;
1151
1152       // Figure out the value # from the RHS.
1153       unsigned ValInst = LHS.getInstForValNum(VN);
1154       LHSValsDefinedFromRHS[VN] = RHS.getLiveRangeContaining(ValInst-1)->ValId;
1155     }
1156
1157     // Loop over the value numbers of the RHS, seeing if any are defined from
1158     // the LHS.
1159     SmallVector<int, 16> RHSValsDefinedFromLHS;
1160     RHSValsDefinedFromLHS.resize(RHS.getNumValNums(), -1);
1161     for (unsigned VN = 0, e = RHS.getNumValNums(); VN != e; ++VN) {
1162       unsigned ValSrcReg = RHS.getSrcRegForValNum(VN);
1163       if (ValSrcReg == 0)  // Src not defined by a copy?
1164         continue;
1165
1166       // DstReg is known to be a register in the RHS interval.  If the src is
1167       // from the LHS interval, we can use its value #.
1168       if (rep(ValSrcReg) != LHS.reg)
1169         continue;
1170
1171       // Figure out the value # from the LHS.
1172       unsigned ValInst = RHS.getInstForValNum(VN);
1173       RHSValsDefinedFromLHS[VN] = LHS.getLiveRangeContaining(ValInst-1)->ValId;
1174     }
1175
1176     LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
1177     RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
1178     ValueNumberInfo.reserve(LHS.getNumValNums() + RHS.getNumValNums());
1179
1180     for (unsigned VN = 0, e = LHS.getNumValNums(); VN != e; ++VN) {
1181       if (LHSValNoAssignments[VN] >= 0 || LHS.getInstForValNum(VN) == ~2U)
1182         continue;
1183       ComputeUltimateVN(VN, ValueNumberInfo,
1184                         LHSValsDefinedFromRHS, RHSValsDefinedFromLHS,
1185                         LHSValNoAssignments, RHSValNoAssignments, LHS, RHS);
1186     }
1187     for (unsigned VN = 0, e = RHS.getNumValNums(); VN != e; ++VN) {
1188       if (RHSValNoAssignments[VN] >= 0 || RHS.getInstForValNum(VN) == ~2U)
1189         continue;
1190       // If this value number isn't a copy from the LHS, it's a new number.
1191       if (RHSValsDefinedFromLHS[VN] == -1) {
1192         ValueNumberInfo.push_back(RHS.getValNumInfo(VN));
1193         RHSValNoAssignments[VN] = ValueNumberInfo.size()-1;
1194         continue;
1195       }
1196
1197       ComputeUltimateVN(VN, ValueNumberInfo,
1198                         RHSValsDefinedFromLHS, LHSValsDefinedFromRHS,
1199                         RHSValNoAssignments, LHSValNoAssignments, RHS, LHS);
1200     }
1201   }
1202
1203   // Armed with the mappings of LHS/RHS values to ultimate values, walk the
1204   // interval lists to see if these intervals are coallescable.
1205   LiveInterval::const_iterator I = LHS.begin();
1206   LiveInterval::const_iterator IE = LHS.end();
1207   LiveInterval::const_iterator J = RHS.begin();
1208   LiveInterval::const_iterator JE = RHS.end();
1209
1210   // Skip ahead until the first place of potential sharing.
1211   if (I->start < J->start) {
1212     I = std::upper_bound(I, IE, J->start);
1213     if (I != LHS.begin()) --I;
1214   } else if (J->start < I->start) {
1215     J = std::upper_bound(J, JE, I->start);
1216     if (J != RHS.begin()) --J;
1217   }
1218
1219   while (1) {
1220     // Determine if these two live ranges overlap.
1221     bool Overlaps;
1222     if (I->start < J->start) {
1223       Overlaps = I->end > J->start;
1224     } else {
1225       Overlaps = J->end > I->start;
1226     }
1227
1228     // If so, check value # info to determine if they are really different.
1229     if (Overlaps) {
1230       // If the live range overlap will map to the same value number in the
1231       // result liverange, we can still coallesce them.  If not, we can't.
1232       if (LHSValNoAssignments[I->ValId] != RHSValNoAssignments[J->ValId])
1233         return false;
1234     }
1235
1236     if (I->end < J->end) {
1237       ++I;
1238       if (I == IE) break;
1239     } else {
1240       ++J;
1241       if (J == JE) break;
1242     }
1243   }
1244
1245   // If we get here, we know that we can coallesce the live ranges.  Ask the
1246   // intervals to coallesce themselves now.
1247   LHS.join(RHS, &LHSValNoAssignments[0], &RHSValNoAssignments[0],
1248            ValueNumberInfo);
1249   return true;
1250 }
1251
1252
1253 namespace {
1254   // DepthMBBCompare - Comparison predicate that sort first based on the loop
1255   // depth of the basic block (the unsigned), and then on the MBB number.
1256   struct DepthMBBCompare {
1257     typedef std::pair<unsigned, MachineBasicBlock*> DepthMBBPair;
1258     bool operator()(const DepthMBBPair &LHS, const DepthMBBPair &RHS) const {
1259       if (LHS.first > RHS.first) return true;   // Deeper loops first
1260       return LHS.first == RHS.first &&
1261         LHS.second->getNumber() < RHS.second->getNumber();
1262     }
1263   };
1264 }
1265
1266
1267 void LiveIntervals::CopyCoallesceInMBB(MachineBasicBlock *MBB,
1268                                        std::vector<CopyRec> &TryAgain) {
1269   DEBUG(std::cerr << ((Value*)MBB->getBasicBlock())->getName() << ":\n");
1270
1271   for (MachineBasicBlock::iterator MII = MBB->begin(), E = MBB->end();
1272        MII != E;) {
1273     MachineInstr *Inst = MII++;
1274
1275     // If this isn't a copy, we can't join intervals.
1276     unsigned SrcReg, DstReg;
1277     if (!tii_->isMoveInstr(*Inst, SrcReg, DstReg)) continue;
1278
1279     if (!JoinCopy(Inst, SrcReg, DstReg))
1280       TryAgain.push_back(getCopyRec(Inst, SrcReg, DstReg));
1281   }
1282 }
1283
1284
1285 void LiveIntervals::joinIntervals() {
1286   DEBUG(std::cerr << "********** JOINING INTERVALS ***********\n");
1287
1288   std::vector<CopyRec> TryAgainList;
1289
1290   const LoopInfo &LI = getAnalysis<LoopInfo>();
1291   if (LI.begin() == LI.end()) {
1292     // If there are no loops in the function, join intervals in function order.
1293     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();
1294          I != E; ++I)
1295       CopyCoallesceInMBB(I, TryAgainList);
1296   } else {
1297     // Otherwise, join intervals in inner loops before other intervals.
1298     // Unfortunately we can't just iterate over loop hierarchy here because
1299     // there may be more MBB's than BB's.  Collect MBB's for sorting.
1300     std::vector<std::pair<unsigned, MachineBasicBlock*> > MBBs;
1301     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();
1302          I != E; ++I)
1303       MBBs.push_back(std::make_pair(LI.getLoopDepth(I->getBasicBlock()), I));
1304
1305     // Sort by loop depth.
1306     std::sort(MBBs.begin(), MBBs.end(), DepthMBBCompare());
1307
1308     // Finally, join intervals in loop nest order.
1309     for (unsigned i = 0, e = MBBs.size(); i != e; ++i)
1310       CopyCoallesceInMBB(MBBs[i].second, TryAgainList);
1311   }
1312
1313   // Joining intervals can allow other intervals to be joined.  Iteratively join
1314   // until we make no progress.
1315   bool ProgressMade = true;
1316   while (ProgressMade) {
1317     ProgressMade = false;
1318
1319     for (unsigned i = 0, e = TryAgainList.size(); i != e; ++i) {
1320       CopyRec &TheCopy = TryAgainList[i];
1321       if (TheCopy.MI &&
1322           JoinCopy(TheCopy.MI, TheCopy.SrcReg, TheCopy.DstReg)) {
1323         TheCopy.MI = 0;   // Mark this one as done.
1324         ProgressMade = true;
1325       }
1326     }
1327   }
1328
1329   DEBUG(std::cerr << "*** Register mapping ***\n");
1330   DEBUG(for (int i = 0, e = r2rMap_.size(); i != e; ++i)
1331           if (r2rMap_[i]) {
1332             std::cerr << "  reg " << i << " -> ";
1333             printRegName(r2rMap_[i]);
1334             std::cerr << "\n";
1335           });
1336 }
1337
1338 /// Return true if the two specified registers belong to different register
1339 /// classes.  The registers may be either phys or virt regs.
1340 bool LiveIntervals::differingRegisterClasses(unsigned RegA,
1341                                              unsigned RegB) const {
1342
1343   // Get the register classes for the first reg.
1344   if (MRegisterInfo::isPhysicalRegister(RegA)) {
1345     assert(MRegisterInfo::isVirtualRegister(RegB) &&
1346            "Shouldn't consider two physregs!");
1347     return !mf_->getSSARegMap()->getRegClass(RegB)->contains(RegA);
1348   }
1349
1350   // Compare against the regclass for the second reg.
1351   const TargetRegisterClass *RegClass = mf_->getSSARegMap()->getRegClass(RegA);
1352   if (MRegisterInfo::isVirtualRegister(RegB))
1353     return RegClass != mf_->getSSARegMap()->getRegClass(RegB);
1354   else
1355     return !RegClass->contains(RegB);
1356 }
1357
1358 LiveInterval LiveIntervals::createInterval(unsigned reg) {
1359   float Weight = MRegisterInfo::isPhysicalRegister(reg) ?
1360                        HUGE_VALF : 0.0F;
1361   return LiveInterval(reg, Weight);
1362 }