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   RegisterAnalysis<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("Join compatible live intervals"),
  61                 cl::init(true));
  62 }
  63
  64 void LiveIntervals::getAnalysisUsage(AnalysisUsage &AU) const
  65 {
  66   AU.addRequired<LiveVariables>();
  67   AU.addPreservedID(PHIEliminationID);
  68   AU.addRequiredID(PHIEliminationID);
  69   AU.addRequiredID(TwoAddressInstructionPassID);
  70   AU.addRequired<LoopInfo>();
  71   MachineFunctionPass::getAnalysisUsage(AU);
  72 }
  73
  74 void LiveIntervals::releaseMemory()
  75 {
  76   mi2iMap_.clear();
  77   i2miMap_.clear();
  78   r2iMap_.clear();
  79   r2rMap_.clear();
  80 }
  81
  82
  83 static bool isZeroLengthInterval(LiveInterval *li) {
  84   for (LiveInterval::Ranges::const_iterator
  85          i = li->ranges.begin(), e = li->ranges.end(); i != e; ++i)
  86     if (i->end - i->start > LiveIntervals::InstrSlots::NUM)
  87       return false;
  88   return true;
  89 }
  90
  91
  92 /// runOnMachineFunction - Register allocate the whole function
  93 ///
  94 bool LiveIntervals::runOnMachineFunction(MachineFunction &fn) {
  95   mf_ = &fn;
  96   tm_ = &fn.getTarget();
  97   mri_ = tm_->getRegisterInfo();
  98   tii_ = tm_->getInstrInfo();
  99   lv_ = &getAnalysis<LiveVariables>();
 100   allocatableRegs_ = mri_->getAllocatableSet(fn);
 101   r2rMap_.grow(mf_->getSSARegMap()->getLastVirtReg());
 102
 103   // If this function has any live ins, insert a dummy instruction at the
 104   // beginning of the function that we will pretend "defines" the values.  This
 105   // is to make the interval analysis simpler by providing a number.
 106   if (fn.livein_begin() != fn.livein_end()) {
 107     unsigned FirstLiveIn = fn.livein_begin()->first;
 108
 109     // Find a reg class that contains this live in.
 110     const TargetRegisterClass *RC = 0;
 111     for (MRegisterInfo::regclass_iterator RCI = mri_->regclass_begin(),
 112            E = mri_->regclass_end(); RCI != E; ++RCI)
 113       if ((*RCI)->contains(FirstLiveIn)) {
 114         RC = *RCI;
 115         break;
 116       }
 117
 118     MachineInstr *OldFirstMI = fn.begin()->begin();
 119     mri_->copyRegToReg(*fn.begin(), fn.begin()->begin(),
 120                        FirstLiveIn, FirstLiveIn, RC);
 121     assert(OldFirstMI != fn.begin()->begin() &&
 122            "copyRetToReg didn't insert anything!");
 123   }
 124
 125   // number MachineInstrs
 126   unsigned miIndex = 0;
 127   for (MachineFunction::iterator mbb = mf_->begin(), mbbEnd = mf_->end();
 128        mbb != mbbEnd; ++mbb)
 129     for (MachineBasicBlock::iterator mi = mbb->begin(), miEnd = mbb->end();
 130          mi != miEnd; ++mi) {
 131       bool inserted = mi2iMap_.insert(std::make_pair(mi, miIndex)).second;
 132       assert(inserted && "multiple MachineInstr -> index mappings");
 133       i2miMap_.push_back(mi);
 134       miIndex += InstrSlots::NUM;
 135     }
 136
 137   // Note intervals due to live-in values.
 138   if (fn.livein_begin() != fn.livein_end()) {
 139     MachineBasicBlock *Entry = fn.begin();
 140     for (MachineFunction::livein_iterator I = fn.livein_begin(),
 141            E = fn.livein_end(); I != E; ++I) {
 142       handlePhysicalRegisterDef(Entry, Entry->begin(),
 143                                 getOrCreateInterval(I->first), 0, 0, true);
 144       for (const unsigned* AS = mri_->getAliasSet(I->first); *AS; ++AS)
 145         handlePhysicalRegisterDef(Entry, Entry->begin(),
 146                                   getOrCreateInterval(*AS), 0, 0, true);
 147     }
 148   }
 149
 150   computeIntervals();
 151
 152   numIntervals += getNumIntervals();
 153
 154   DEBUG(std::cerr << "********** INTERVALS **********\n";
 155         for (iterator I = begin(), E = end(); I != E; ++I) {
 156           I->second.print(std::cerr, mri_);
 157           std::cerr << "\n";
 158         });
 159
 160   // join intervals if requested
 161   if (EnableJoining) joinIntervals();
 162
 163   numIntervalsAfter += getNumIntervals();
 164
 165   // perform a final pass over the instructions and compute spill
 166   // weights, coalesce virtual registers and remove identity moves
 167   const LoopInfo& loopInfo = getAnalysis<LoopInfo>();
 168
 169   for (MachineFunction::iterator mbbi = mf_->begin(), mbbe = mf_->end();
 170        mbbi != mbbe; ++mbbi) {
 171     MachineBasicBlock* mbb = mbbi;
 172     unsigned loopDepth = loopInfo.getLoopDepth(mbb->getBasicBlock());
 173
 174     for (MachineBasicBlock::iterator mii = mbb->begin(), mie = mbb->end();
 175          mii != mie; ) {
 176       // if the move will be an identity move delete it
 177       unsigned srcReg, dstReg, RegRep;
 178       if (tii_->isMoveInstr(*mii, srcReg, dstReg) &&
 179           (RegRep = rep(srcReg)) == rep(dstReg)) {
 180         // remove from def list
 181         LiveInterval &interval = getOrCreateInterval(RegRep);
 182         // remove index -> MachineInstr and
 183         // MachineInstr -> index mappings
 184         Mi2IndexMap::iterator mi2i = mi2iMap_.find(mii);
 185         if (mi2i != mi2iMap_.end()) {
 186           i2miMap_[mi2i->second/InstrSlots::NUM] = 0;
 187           mi2iMap_.erase(mi2i);
 188         }
 189         mii = mbbi->erase(mii);
 190         ++numPeep;
 191       }
 192       else {
 193         for (unsigned i = 0; i < mii->getNumOperands(); ++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   for (iterator I = begin(), E = end(); I != E; ++I) {
 212     LiveInterval &li = I->second;
 213     if (MRegisterInfo::isVirtualRegister(li.reg))
 214       // If the live interval legnth is essentially zero, i.e. in every live
 215       // range the use follows def immediately, it doesn't make sense to spill
 216       // it and hope it will be easier to allocate for this li.
 217       if (isZeroLengthInterval(&li))
 218         li.weight = float(HUGE_VAL);
 219   }
 220
 221   DEBUG(dump());
 222   return true;
 223 }
 224
 225 /// print - Implement the dump method.
 226 void LiveIntervals::print(std::ostream &O, const Module* ) const {
 227   O << "********** INTERVALS **********\n";
 228   for (const_iterator I = begin(), E = end(); I != E; ++I) {
 229     I->second.print(std::cerr, mri_);
 230     std::cerr << "\n";
 231   }
 232
 233   O << "********** MACHINEINSTRS **********\n";
 234   for (MachineFunction::iterator mbbi = mf_->begin(), mbbe = mf_->end();
 235        mbbi != mbbe; ++mbbi) {
 236     O << ((Value*)mbbi->getBasicBlock())->getName() << ":\n";
 237     for (MachineBasicBlock::iterator mii = mbbi->begin(),
 238            mie = mbbi->end(); mii != mie; ++mii) {
 239       O << getInstructionIndex(mii) << '\t' << *mii;
 240     }
 241   }
 242 }
 243
 244 std::vector<LiveInterval*> LiveIntervals::
 245 addIntervalsForSpills(const LiveInterval &li, VirtRegMap &vrm, int slot) {
 246   // since this is called after the analysis is done we don't know if
 247   // LiveVariables is available
 248   lv_ = getAnalysisToUpdate<LiveVariables>();
 249
 250   std::vector<LiveInterval*> added;
 251
 252   assert(li.weight != HUGE_VAL &&
 253          "attempt to spill already spilled interval!");
 254
 255   DEBUG(std::cerr << "\t\t\t\tadding intervals for spills for interval: "
 256         << li << '\n');
 257
 258   const TargetRegisterClass* rc = mf_->getSSARegMap()->getRegClass(li.reg);
 259
 260   for (LiveInterval::Ranges::const_iterator
 261          i = li.ranges.begin(), e = li.ranges.end(); i != e; ++i) {
 262     unsigned index = getBaseIndex(i->start);
 263     unsigned end = getBaseIndex(i->end-1) + InstrSlots::NUM;
 264     for (; index != end; index += InstrSlots::NUM) {
 265       // skip deleted instructions
 266       while (index != end && !getInstructionFromIndex(index))
 267         index += InstrSlots::NUM;
 268       if (index == end) break;
 269
 270       MachineInstr *MI = getInstructionFromIndex(index);
 271
 272       // NewRegLiveIn - This instruction might have multiple uses of the spilled
 273       // register.  In this case, for the first use, keep track of the new vreg
 274       // that we reload it into.  If we see a second use, reuse this vreg
 275       // instead of creating live ranges for two reloads.
 276       unsigned NewRegLiveIn = 0;
 277
 278     for_operand:
 279       for (unsigned i = 0; i != MI->getNumOperands(); ++i) {
 280         MachineOperand& mop = MI->getOperand(i);
 281         if (mop.isRegister() && mop.getReg() == li.reg) {
 282           if (NewRegLiveIn && mop.isUse()) {
 283             // We already emitted a reload of this value, reuse it for
 284             // subsequent operands.
 285             MI->getOperand(i).setReg(NewRegLiveIn);
 286             DEBUG(std::cerr << "\t\t\t\treused reload into reg" << NewRegLiveIn
 287                             << " for operand #" << i << '\n');
 288           } else if (MachineInstr* fmi = mri_->foldMemoryOperand(MI, i, slot)) {
 289             // Attempt to fold the memory reference into the instruction.  If we
 290             // can do this, we don't need to insert spill code.
 291             if (lv_)
 292               lv_->instructionChanged(MI, fmi);
 293             MachineBasicBlock &MBB = *MI->getParent();
 294             vrm.virtFolded(li.reg, MI, i, fmi);
 295             mi2iMap_.erase(MI);
 296             i2miMap_[index/InstrSlots::NUM] = fmi;
 297             mi2iMap_[fmi] = index;
 298             MI = MBB.insert(MBB.erase(MI), fmi);
 299             ++numFolded;
 300             // Folding the load/store can completely change the instruction in
 301             // unpredictable ways, rescan it from the beginning.
 302             goto for_operand;
 303           } else {
 304             // This is tricky. We need to add information in the interval about
 305             // the spill code so we have to use our extra load/store slots.
 306             //
 307             // If we have a use we are going to have a load so we start the
 308             // interval from the load slot onwards. Otherwise we start from the
 309             // def slot.
 310             unsigned start = (mop.isUse() ?
 311                               getLoadIndex(index) :
 312                               getDefIndex(index));
 313             // If we have a def we are going to have a store right after it so
 314             // we end the interval after the use of the next
 315             // instruction. Otherwise we end after the use of this instruction.
 316             unsigned end = 1 + (mop.isDef() ?
 317                                 getStoreIndex(index) :
 318                                 getUseIndex(index));
 319
 320             // create a new register for this spill
 321             NewRegLiveIn = mf_->getSSARegMap()->createVirtualRegister(rc);
 322             MI->getOperand(i).setReg(NewRegLiveIn);
 323             vrm.grow();
 324             vrm.assignVirt2StackSlot(NewRegLiveIn, slot);
 325             LiveInterval& nI = getOrCreateInterval(NewRegLiveIn);
 326             assert(nI.empty());
 327
 328             // the spill weight is now infinity as it
 329             // cannot be spilled again
 330             nI.weight = float(HUGE_VAL);
 331             LiveRange LR(start, end, nI.getNextValue(~0U));
 332             DEBUG(std::cerr << " +" << LR);
 333             nI.addRange(LR);
 334             added.push_back(&nI);
 335
 336             // update live variables if it is available
 337             if (lv_)
 338               lv_->addVirtualRegisterKilled(NewRegLiveIn, MI);
 339
 340             // If this is a live in, reuse it for subsequent live-ins.  If it's
 341             // a def, we can't do this.
 342             if (!mop.isUse()) NewRegLiveIn = 0;
 343
 344             DEBUG(std::cerr << "\t\t\t\tadded new interval: " << nI << '\n');
 345           }
 346         }
 347       }
 348     }
 349   }
 350
 351   return added;
 352 }
 353
 354 void LiveIntervals::printRegName(unsigned reg) const {
 355   if (MRegisterInfo::isPhysicalRegister(reg))
 356     std::cerr << mri_->getName(reg);
 357   else
 358     std::cerr << "%reg" << reg;
 359 }
 360
 361 void LiveIntervals::handleVirtualRegisterDef(MachineBasicBlock *mbb,
 362                                              MachineBasicBlock::iterator mi,
 363                                              LiveInterval &interval) {
 364   DEBUG(std::cerr << "\t\tregister: "; printRegName(interval.reg));
 365   LiveVariables::VarInfo& vi = lv_->getVarInfo(interval.reg);
 366
 367   // Virtual registers may be defined multiple times (due to phi
 368   // elimination and 2-addr elimination).  Much of what we do only has to be
 369   // done once for the vreg.  We use an empty interval to detect the first
 370   // time we see a vreg.
 371   if (interval.empty()) {
 372     // Get the Idx of the defining instructions.
 373     unsigned defIndex = getDefIndex(getInstructionIndex(mi));
 374
 375     unsigned ValNum = interval.getNextValue(defIndex);
 376     assert(ValNum == 0 && "First value in interval is not 0?");
 377     ValNum = 0;  // Clue in the optimizer.
 378
 379     // Loop over all of the blocks that the vreg is defined in.  There are
 380     // two cases we have to handle here.  The most common case is a vreg
 381     // whose lifetime is contained within a basic block.  In this case there
 382     // will be a single kill, in MBB, which comes after the definition.
 383     if (vi.Kills.size() == 1 && vi.Kills[0]->getParent() == mbb) {
 384       // FIXME: what about dead vars?
 385       unsigned killIdx;
 386       if (vi.Kills[0] != mi)
 387         killIdx = getUseIndex(getInstructionIndex(vi.Kills[0]))+1;
 388       else
 389         killIdx = defIndex+1;
 390
 391       // If the kill happens after the definition, we have an intra-block
 392       // live range.
 393       if (killIdx > defIndex) {
 394         assert(vi.AliveBlocks.empty() &&
 395                "Shouldn't be alive across any blocks!");
 396         LiveRange LR(defIndex, killIdx, ValNum);
 397         interval.addRange(LR);
 398         DEBUG(std::cerr << " +" << LR << "\n");
 399         return;
 400       }
 401     }
 402
 403     // The other case we handle is when a virtual register lives to the end
 404     // of the defining block, potentially live across some blocks, then is
 405     // live into some number of blocks, but gets killed.  Start by adding a
 406     // range that goes from this definition to the end of the defining block.
 407     LiveRange NewLR(defIndex,
 408                     getInstructionIndex(&mbb->back()) + InstrSlots::NUM,
 409                     ValNum);
 410     DEBUG(std::cerr << " +" << NewLR);
 411     interval.addRange(NewLR);
 412
 413     // Iterate over all of the blocks that the variable is completely
 414     // live in, adding [insrtIndex(begin), instrIndex(end)+4) to the
 415     // live interval.
 416     for (unsigned i = 0, e = vi.AliveBlocks.size(); i != e; ++i) {
 417       if (vi.AliveBlocks[i]) {
 418         MachineBasicBlock* mbb = mf_->getBlockNumbered(i);
 419         if (!mbb->empty()) {
 420           LiveRange LR(getInstructionIndex(&mbb->front()),
 421                        getInstructionIndex(&mbb->back()) + InstrSlots::NUM,
 422                        ValNum);
 423           interval.addRange(LR);
 424           DEBUG(std::cerr << " +" << LR);
 425         }
 426       }
 427     }
 428
 429     // Finally, this virtual register is live from the start of any killing
 430     // block to the 'use' slot of the killing instruction.
 431     for (unsigned i = 0, e = vi.Kills.size(); i != e; ++i) {
 432       MachineInstr *Kill = vi.Kills[i];
 433       LiveRange LR(getInstructionIndex(Kill->getParent()->begin()),
 434                    getUseIndex(getInstructionIndex(Kill))+1,
 435                    ValNum);
 436       interval.addRange(LR);
 437       DEBUG(std::cerr << " +" << LR);
 438     }
 439
 440   } else {
 441     // If this is the second time we see a virtual register definition, it
 442     // must be due to phi elimination or two addr elimination.  If this is
 443     // the result of two address elimination, then the vreg is the first
 444     // operand, and is a def-and-use.
 445     if (mi->getOperand(0).isRegister() &&
 446         mi->getOperand(0).getReg() == interval.reg &&
 447         mi->getOperand(0).isDef() && mi->getOperand(0).isUse()) {
 448       // If this is a two-address definition, then we have already processed
 449       // the live range.  The only problem is that we didn't realize there
 450       // are actually two values in the live interval.  Because of this we
 451       // need to take the LiveRegion that defines this register and split it
 452       // into two values.
 453       unsigned DefIndex = getDefIndex(getInstructionIndex(vi.DefInst));
 454       unsigned RedefIndex = getDefIndex(getInstructionIndex(mi));
 455
 456       // Delete the initial value, which should be short and continuous,
 457       // because the 2-addr copy must be in the same MBB as the redef.
 458       interval.removeRange(DefIndex, RedefIndex);
 459
 460       // Two-address vregs should always only be redefined once.  This means
 461       // that at this point, there should be exactly one value number in it.
 462       assert(interval.containsOneValue() && "Unexpected 2-addr liveint!");
 463
 464       // The new value number is defined by the instruction we claimed defined
 465       // value #0.
 466       unsigned ValNo = interval.getNextValue(DefIndex);
 467
 468       // Value#1 is now defined by the 2-addr instruction.
 469       interval.setInstDefiningValNum(0, RedefIndex);
 470
 471       // Add the new live interval which replaces the range for the input copy.
 472       LiveRange LR(DefIndex, RedefIndex, ValNo);
 473       DEBUG(std::cerr << " replace range with " << LR);
 474       interval.addRange(LR);
 475
 476       // If this redefinition is dead, we need to add a dummy unit live
 477       // range covering the def slot.
 478       if (lv_->RegisterDefIsDead(mi, interval.reg))
 479         interval.addRange(LiveRange(RedefIndex, RedefIndex+1, 0));
 480
 481       DEBUG(std::cerr << "RESULT: " << interval);
 482
 483     } else {
 484       // Otherwise, this must be because of phi elimination.  If this is the
 485       // first redefinition of the vreg that we have seen, go back and change
 486       // the live range in the PHI block to be a different value number.
 487       if (interval.containsOneValue()) {
 488         assert(vi.Kills.size() == 1 &&
 489                "PHI elimination vreg should have one kill, the PHI itself!");
 490
 491         // Remove the old range that we now know has an incorrect number.
 492         MachineInstr *Killer = vi.Kills[0];
 493         unsigned Start = getInstructionIndex(Killer->getParent()->begin());
 494         unsigned End = getUseIndex(getInstructionIndex(Killer))+1;
 495         DEBUG(std::cerr << "Removing [" << Start << "," << End << "] from: "
 496               << interval << "\n");
 497         interval.removeRange(Start, End);
 498         DEBUG(std::cerr << "RESULT: " << interval);
 499
 500         // Replace the interval with one of a NEW value number.  Note that this
 501         // value number isn't actually defined by an instruction, weird huh? :)
 502         LiveRange LR(Start, End, interval.getNextValue(~0U));
 503         DEBUG(std::cerr << " replace range with " << LR);
 504         interval.addRange(LR);
 505         DEBUG(std::cerr << "RESULT: " << interval);
 506       }
 507
 508       // In the case of PHI elimination, each variable definition is only
 509       // live until the end of the block.  We've already taken care of the
 510       // rest of the live range.
 511       unsigned defIndex = getDefIndex(getInstructionIndex(mi));
 512       LiveRange LR(defIndex,
 513                    getInstructionIndex(&mbb->back()) + InstrSlots::NUM,
 514                    interval.getNextValue(defIndex));
 515       interval.addRange(LR);
 516       DEBUG(std::cerr << " +" << LR);
 517     }
 518   }
 519
 520   DEBUG(std::cerr << '\n');
 521 }
 522
 523 void LiveIntervals::handlePhysicalRegisterDef(MachineBasicBlock *MBB,
 524                                               MachineBasicBlock::iterator mi,
 525                                               LiveInterval& interval,
 526                                               unsigned SrcReg, unsigned DestReg,
 527                                               bool isLiveIn) {
 528   // A physical register cannot be live across basic block, so its
 529   // lifetime must end somewhere in its defining basic block.
 530   DEBUG(std::cerr << "\t\tregister: "; printRegName(interval.reg));
 531   typedef LiveVariables::killed_iterator KillIter;
 532
 533   unsigned baseIndex = getInstructionIndex(mi);
 534   unsigned start = getDefIndex(baseIndex);
 535   unsigned end = start;
 536
 537   // If it is not used after definition, it is considered dead at
 538   // the instruction defining it. Hence its interval is:
 539   // [defSlot(def), defSlot(def)+1)
 540   if (lv_->RegisterDefIsDead(mi, interval.reg)) {
 541     DEBUG(std::cerr << " dead");
 542     end = getDefIndex(start) + 1;
 543     goto exit;
 544   }
 545
 546   // If it is not dead on definition, it must be killed by a
 547   // subsequent instruction. Hence its interval is:
 548   // [defSlot(def), useSlot(kill)+1)
 549   while (++mi != MBB->end()) {
 550     baseIndex += InstrSlots::NUM;
 551     if (lv_->KillsRegister(mi, interval.reg)) {
 552       DEBUG(std::cerr << " killed");
 553       end = getUseIndex(baseIndex) + 1;
 554       goto exit;
 555     }
 556   }
 557
 558   // The only case we should have a dead physreg here without a killing or
 559   // instruction where we know it's dead is if it is live-in to the function
 560   // and never used.
 561   assert(isLiveIn && "physreg was not killed in defining block!");
 562   end = getDefIndex(start) + 1;  // It's dead.
 563
 564 exit:
 565   assert(start < end && "did not find end of interval?");
 566
 567   // Finally, if this is defining a new range for the physical register, and if
 568   // that physreg is just a copy from a vreg, and if THAT vreg was a copy from
 569   // the physreg, then the new fragment has the same value as the one copied
 570   // into the vreg.
 571   if (interval.reg == DestReg && !interval.empty() &&
 572       MRegisterInfo::isVirtualRegister(SrcReg)) {
 573
 574     // Get the live interval for the vreg, see if it is defined by a copy.
 575     LiveInterval &SrcInterval = getOrCreateInterval(SrcReg);
 576
 577     if (SrcInterval.containsOneValue()) {
 578       assert(!SrcInterval.empty() && "Can't contain a value and be empty!");
 579
 580       // Get the first index of the first range.  Though the interval may have
 581       // multiple liveranges in it, we only check the first.
 582       unsigned StartIdx = SrcInterval.begin()->start;
 583       MachineInstr *SrcDefMI = getInstructionFromIndex(StartIdx);
 584
 585       // Check to see if the vreg was defined by a copy instruction, and that
 586       // the source was this physreg.
 587       unsigned VRegSrcSrc, VRegSrcDest;
 588       if (tii_->isMoveInstr(*SrcDefMI, VRegSrcSrc, VRegSrcDest) &&
 589           SrcReg == VRegSrcDest && VRegSrcSrc == DestReg) {
 590         // Okay, now we know that the vreg was defined by a copy from this
 591         // physreg.  Find the value number being copied and use it as the value
 592         // for this range.
 593         const LiveRange *DefRange = interval.getLiveRangeContaining(StartIdx-1);
 594         if (DefRange) {
 595           LiveRange LR(start, end, DefRange->ValId);
 596           interval.addRange(LR);
 597           DEBUG(std::cerr << " +" << LR << '\n');
 598           return;
 599         }
 600       }
 601     }
 602   }
 603
 604   LiveRange LR(start, end, interval.getNextValue(start));
 605   interval.addRange(LR);
 606   DEBUG(std::cerr << " +" << LR << '\n');
 607 }
 608
 609 void LiveIntervals::handleRegisterDef(MachineBasicBlock *MBB,
 610                                       MachineBasicBlock::iterator MI,
 611                                       unsigned reg) {
 612   if (MRegisterInfo::isVirtualRegister(reg))
 613     handleVirtualRegisterDef(MBB, MI, getOrCreateInterval(reg));
 614   else if (allocatableRegs_[reg]) {
 615     unsigned SrcReg = 0, DestReg = 0;
 616     if (!tii_->isMoveInstr(*MI, SrcReg, DestReg))
 617       SrcReg = DestReg = 0;
 618
 619     handlePhysicalRegisterDef(MBB, MI, getOrCreateInterval(reg),
 620                               SrcReg, DestReg);
 621     for (const unsigned* AS = mri_->getAliasSet(reg); *AS; ++AS)
 622       handlePhysicalRegisterDef(MBB, MI, getOrCreateInterval(*AS),
 623                                 SrcReg, DestReg);
 624   }
 625 }
 626
 627 /// computeIntervals - computes the live intervals for virtual
 628 /// registers. for some ordering of the machine instructions [1,N] a
 629 /// live interval is an interval [i, j) where 1 <= i <= j < N for
 630 /// which a variable is live
 631 void LiveIntervals::computeIntervals()
 632 {
 633   DEBUG(std::cerr << "********** COMPUTING LIVE INTERVALS **********\n");
 634   DEBUG(std::cerr << "********** Function: "
 635         << ((Value*)mf_->getFunction())->getName() << '\n');
 636   bool IgnoreFirstInstr = mf_->livein_begin() != mf_->livein_end();
 637
 638   for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();
 639        I != E; ++I) {
 640     MachineBasicBlock* mbb = I;
 641     DEBUG(std::cerr << ((Value*)mbb->getBasicBlock())->getName() << ":\n");
 642
 643     MachineBasicBlock::iterator mi = mbb->begin(), miEnd = mbb->end();
 644     if (IgnoreFirstInstr) { ++mi; IgnoreFirstInstr = false; }
 645     for (; mi != miEnd; ++mi) {
 646       const TargetInstrDescriptor& tid =
 647         tm_->getInstrInfo()->get(mi->getOpcode());
 648       DEBUG(std::cerr << getInstructionIndex(mi) << "\t" << *mi);
 649
 650       // handle implicit defs
 651       if (tid.ImplicitDefs) {
 652         for (const unsigned* id = tid.ImplicitDefs; *id; ++id)
 653           handleRegisterDef(mbb, mi, *id);
 654       }
 655
 656       // handle explicit defs
 657       for (int i = mi->getNumOperands() - 1; i >= 0; --i) {
 658         MachineOperand& mop = mi->getOperand(i);
 659         // handle register defs - build intervals
 660         if (mop.isRegister() && mop.getReg() && mop.isDef())
 661           handleRegisterDef(mbb, mi, mop.getReg());
 662       }
 663     }
 664   }
 665 }
 666
 667 /// IntA is defined as a copy from IntB and we know it only has one value
 668 /// number.  If all of the places that IntA and IntB overlap are defined by
 669 /// copies from IntA to IntB, we know that these two ranges can really be
 670 /// merged if we adjust the value numbers.  If it is safe, adjust the value
 671 /// numbers and return true, allowing coalescing to occur.
 672 bool LiveIntervals::
 673 AdjustIfAllOverlappingRangesAreCopiesFrom(LiveInterval &IntA,
 674                                           LiveInterval &IntB,
 675                                           unsigned CopyIdx) {
 676   std::vector<LiveRange*> Ranges;
 677   IntA.getOverlapingRanges(IntB, CopyIdx, Ranges);
 678
 679   assert(!Ranges.empty() && "Why didn't we do a simple join of this?");
 680
 681   unsigned IntBRep = rep(IntB.reg);
 682
 683   // Check to see if all of the overlaps (entries in Ranges) are defined by a
 684   // copy from IntA.  If not, exit.
 685   for (unsigned i = 0, e = Ranges.size(); i != e; ++i) {
 686     unsigned Idx = Ranges[i]->start;
 687     MachineInstr *MI = getInstructionFromIndex(Idx);
 688     unsigned SrcReg, DestReg;
 689     if (!tii_->isMoveInstr(*MI, SrcReg, DestReg)) return false;
 690
 691     // If this copy isn't actually defining this range, it must be a live
 692     // range spanning basic blocks or something.
 693     if (rep(DestReg) != rep(IntA.reg)) return false;
 694
 695     // Check to see if this is coming from IntB.  If not, bail out.
 696     if (rep(SrcReg) != IntBRep) return false;
 697   }
 698
 699   // Okay, we can change this one.  Get the IntB value number that IntA is
 700   // copied from.
 701   unsigned ActualValNo = IntA.getLiveRangeContaining(CopyIdx-1)->ValId;
 702
 703   // Change all of the value numbers to the same as what we IntA is copied from.
 704   for (unsigned i = 0, e = Ranges.size(); i != e; ++i)
 705     Ranges[i]->ValId = ActualValNo;
 706
 707   return true;
 708 }
 709
 710 void LiveIntervals::joinIntervalsInMachineBB(MachineBasicBlock *MBB) {
 711   DEBUG(std::cerr << ((Value*)MBB->getBasicBlock())->getName() << ":\n");
 712
 713   for (MachineBasicBlock::iterator mi = MBB->begin(), mie = MBB->end();
 714        mi != mie; ++mi) {
 715     DEBUG(std::cerr << getInstructionIndex(mi) << '\t' << *mi);
 716
 717     // we only join virtual registers with allocatable
 718     // physical registers since we do not have liveness information
 719     // on not allocatable physical registers
 720     unsigned SrcReg, DestReg;
 721     if (tii_->isMoveInstr(*mi, SrcReg, DestReg) &&
 722         (MRegisterInfo::isVirtualRegister(SrcReg) || allocatableRegs_[SrcReg])&&
 723         (MRegisterInfo::isVirtualRegister(DestReg)||allocatableRegs_[DestReg])){
 724
 725       // Get representative registers.
 726       SrcReg = rep(SrcReg);
 727       DestReg = rep(DestReg);
 728
 729       // If they are already joined we continue.
 730       if (SrcReg == DestReg)
 731         continue;
 732
 733       // If they are both physical registers, we cannot join them.
 734       if (MRegisterInfo::isPhysicalRegister(SrcReg) &&
 735           MRegisterInfo::isPhysicalRegister(DestReg))
 736         continue;
 737
 738       // If they are not of the same register class, we cannot join them.
 739       if (differingRegisterClasses(SrcReg, DestReg))
 740         continue;
 741
 742       LiveInterval &SrcInt = getInterval(SrcReg);
 743       LiveInterval &DestInt = getInterval(DestReg);
 744       assert(SrcInt.reg == SrcReg && DestInt.reg == DestReg &&
 745              "Register mapping is horribly broken!");
 746
 747       DEBUG(std::cerr << "\t\tInspecting "; SrcInt.print(std::cerr, mri_);
 748             std::cerr << " and "; DestInt.print(std::cerr, mri_);
 749             std::cerr << ": ");
 750
 751       // If two intervals contain a single value and are joined by a copy, it
 752       // does not matter if the intervals overlap, they can always be joined.
 753       bool Joinable = SrcInt.containsOneValue() && DestInt.containsOneValue();
 754
 755       unsigned MIDefIdx = getDefIndex(getInstructionIndex(mi));
 756
 757       // If the intervals think that this is joinable, do so now.
 758       if (!Joinable && DestInt.joinable(SrcInt, MIDefIdx))
 759         Joinable = true;
 760
 761       // If DestInt is actually a copy from SrcInt (which we know) that is used
 762       // to define another value of SrcInt, we can change the other range of
 763       // SrcInt to be the value of the range that defines DestInt, allowing a
 764       // coalesce.
 765       if (!Joinable && DestInt.containsOneValue() &&
 766           AdjustIfAllOverlappingRangesAreCopiesFrom(SrcInt, DestInt, MIDefIdx))
 767         Joinable = true;
 768
 769       if (!Joinable || overlapsAliases(&SrcInt, &DestInt)) {
 770         DEBUG(std::cerr << "Interference!\n");
 771       } else {
 772         DestInt.join(SrcInt, MIDefIdx);
 773         DEBUG(std::cerr << "Joined.  Result = " << DestInt << "\n");
 774
 775         if (!MRegisterInfo::isPhysicalRegister(SrcReg)) {
 776           r2iMap_.erase(SrcReg);
 777           r2rMap_[SrcReg] = DestReg;
 778         } else {
 779           // Otherwise merge the data structures the other way so we don't lose
 780           // the physreg information.
 781           r2rMap_[DestReg] = SrcReg;
 782           DestInt.reg = SrcReg;
 783           SrcInt.swap(DestInt);
 784           r2iMap_.erase(DestReg);
 785         }
 786         ++numJoins;
 787       }
 788     }
 789   }
 790 }
 791
 792 namespace {
 793   // DepthMBBCompare - Comparison predicate that sort first based on the loop
 794   // depth of the basic block (the unsigned), and then on the MBB number.
 795   struct DepthMBBCompare {
 796     typedef std::pair<unsigned, MachineBasicBlock*> DepthMBBPair;
 797     bool operator()(const DepthMBBPair &LHS, const DepthMBBPair &RHS) const {
 798       if (LHS.first > RHS.first) return true;   // Deeper loops first
 799       return LHS.first == RHS.first &&
 800         LHS.second->getNumber() < RHS.second->getNumber();
 801     }
 802   };
 803 }
 804
 805 void LiveIntervals::joinIntervals() {
 806   DEBUG(std::cerr << "********** JOINING INTERVALS ***********\n");
 807
 808   const LoopInfo &LI = getAnalysis<LoopInfo>();
 809   if (LI.begin() == LI.end()) {
 810     // If there are no loops in the function, join intervals in function order.
 811     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();
 812          I != E; ++I)
 813       joinIntervalsInMachineBB(I);
 814   } else {
 815     // Otherwise, join intervals in inner loops before other intervals.
 816     // Unfortunately we can't just iterate over loop hierarchy here because
 817     // there may be more MBB's than BB's.  Collect MBB's for sorting.
 818     std::vector<std::pair<unsigned, MachineBasicBlock*> > MBBs;
 819     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();
 820          I != E; ++I)
 821       MBBs.push_back(std::make_pair(LI.getLoopDepth(I->getBasicBlock()), I));
 822
 823     // Sort by loop depth.
 824     std::sort(MBBs.begin(), MBBs.end(), DepthMBBCompare());
 825
 826     // Finally, join intervals in loop nest order.
 827     for (unsigned i = 0, e = MBBs.size(); i != e; ++i)
 828       joinIntervalsInMachineBB(MBBs[i].second);
 829   }
 830
 831   DEBUG(std::cerr << "*** Register mapping ***\n");
 832   DEBUG(for (int i = 0, e = r2rMap_.size(); i != e; ++i)
 833           if (r2rMap_[i]) {
 834             std::cerr << "  reg " << i << " -> ";
 835             printRegName(r2rMap_[i]);
 836             std::cerr << "\n";
 837           });
 838 }
 839
 840 /// Return true if the two specified registers belong to different register
 841 /// classes.  The registers may be either phys or virt regs.
 842 bool LiveIntervals::differingRegisterClasses(unsigned RegA,
 843                                              unsigned RegB) const {
 844
 845   // Get the register classes for the first reg.
 846   if (MRegisterInfo::isPhysicalRegister(RegA)) {
 847     assert(MRegisterInfo::isVirtualRegister(RegB) &&
 848            "Shouldn't consider two physregs!");
 849     return !mf_->getSSARegMap()->getRegClass(RegB)->contains(RegA);
 850   }
 851
 852   // Compare against the regclass for the second reg.
 853   const TargetRegisterClass *RegClass = mf_->getSSARegMap()->getRegClass(RegA);
 854   if (MRegisterInfo::isVirtualRegister(RegB))
 855     return RegClass != mf_->getSSARegMap()->getRegClass(RegB);
 856   else
 857     return !RegClass->contains(RegB);
 858 }
 859
 860 bool LiveIntervals::overlapsAliases(const LiveInterval *LHS,
 861                                     const LiveInterval *RHS) const {
 862   if (!MRegisterInfo::isPhysicalRegister(LHS->reg)) {
 863     if (!MRegisterInfo::isPhysicalRegister(RHS->reg))
 864       return false;   // vreg-vreg merge has no aliases!
 865     std::swap(LHS, RHS);
 866   }
 867
 868   assert(MRegisterInfo::isPhysicalRegister(LHS->reg) &&
 869          MRegisterInfo::isVirtualRegister(RHS->reg) &&
 870          "first interval must describe a physical register");
 871
 872   for (const unsigned *AS = mri_->getAliasSet(LHS->reg); *AS; ++AS)
 873     if (RHS->overlaps(getInterval(*AS)))
 874       return true;
 875
 876   return false;
 877 }
 878
 879 LiveInterval LiveIntervals::createInterval(unsigned reg) {
 880   float Weight = MRegisterInfo::isPhysicalRegister(reg) ?
 881                        (float)HUGE_VAL :0.0F;
 882   return LiveInterval(reg, Weight);
 883 }