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