Add live-ins to every BB.
[oota-llvm.git] / lib / CodeGen / RegAllocLinearScan.cpp
1 //===-- RegAllocLinearScan.cpp - Linear Scan register allocator -----------===//
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 a linear scan register allocator.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #define DEBUG_TYPE "regalloc"
15 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
16 #include "PhysRegTracker.h"
17 #include "VirtRegMap.h"
18 #include "llvm/Function.h"
19 #include "llvm/CodeGen/MachineFunctionPass.h"
20 #include "llvm/CodeGen/MachineInstr.h"
21 #include "llvm/CodeGen/Passes.h"
22 #include "llvm/CodeGen/RegAllocRegistry.h"
23 #include "llvm/CodeGen/SSARegMap.h"
24 #include "llvm/Target/MRegisterInfo.h"
25 #include "llvm/Target/TargetMachine.h"
26 #include "llvm/ADT/EquivalenceClasses.h"
27 #include "llvm/ADT/Statistic.h"
28 #include "llvm/ADT/STLExtras.h"
29 #include "llvm/Support/Debug.h"
30 #include "llvm/Support/Compiler.h"
31 #include <algorithm>
32 #include <set>
33 #include <queue>
34 #include <memory>
35 #include <cmath>
36 using namespace llvm;
37
38 STATISTIC(NumIters     , "Number of iterations performed");
39 STATISTIC(NumBacktracks, "Number of times we had to backtrack");
40
41 static RegisterRegAlloc
42 linearscanRegAlloc("linearscan", "  linear scan register allocator",
43                    createLinearScanRegisterAllocator);
44
45 namespace {
46   static unsigned numIterations = 0;
47   static unsigned numIntervals = 0;
48
49   struct VISIBILITY_HIDDEN RA : public MachineFunctionPass {
50     typedef std::pair<LiveInterval*, LiveInterval::iterator> IntervalPtr;
51     typedef std::vector<IntervalPtr> IntervalPtrs;
52   private:
53     /// RelatedRegClasses - This structure is built the first time a function is
54     /// compiled, and keeps track of which register classes have registers that
55     /// belong to multiple classes or have aliases that are in other classes.
56     EquivalenceClasses<const TargetRegisterClass*> RelatedRegClasses;
57     std::map<unsigned, const TargetRegisterClass*> OneClassForEachPhysReg;
58
59     MachineFunction* mf_;
60     const TargetMachine* tm_;
61     const MRegisterInfo* mri_;
62     LiveIntervals* li_;
63     bool *PhysRegsUsed;
64
65     /// handled_ - Intervals are added to the handled_ set in the order of their
66     /// start value.  This is uses for backtracking.
67     std::vector<LiveInterval*> handled_;
68
69     /// fixed_ - Intervals that correspond to machine registers.
70     ///
71     IntervalPtrs fixed_;
72
73     /// active_ - Intervals that are currently being processed, and which have a
74     /// live range active for the current point.
75     IntervalPtrs active_;
76
77     /// inactive_ - Intervals that are currently being processed, but which have
78     /// a hold at the current point.
79     IntervalPtrs inactive_;
80
81     typedef std::priority_queue<LiveInterval*,
82                                 std::vector<LiveInterval*>,
83                                 greater_ptr<LiveInterval> > IntervalHeap;
84     IntervalHeap unhandled_;
85     std::auto_ptr<PhysRegTracker> prt_;
86     std::auto_ptr<VirtRegMap> vrm_;
87     std::auto_ptr<Spiller> spiller_;
88
89   public:
90     virtual const char* getPassName() const {
91       return "Linear Scan Register Allocator";
92     }
93
94     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
95       AU.addRequired<LiveIntervals>();
96       MachineFunctionPass::getAnalysisUsage(AU);
97     }
98
99     /// runOnMachineFunction - register allocate the whole function
100     bool runOnMachineFunction(MachineFunction&);
101
102   private:
103     /// linearScan - the linear scan algorithm
104     void linearScan();
105
106     /// initIntervalSets - initialize the interval sets.
107     ///
108     void initIntervalSets();
109
110     /// processActiveIntervals - expire old intervals and move non-overlapping
111     /// ones to the inactive list.
112     void processActiveIntervals(unsigned CurPoint);
113
114     /// processInactiveIntervals - expire old intervals and move overlapping
115     /// ones to the active list.
116     void processInactiveIntervals(unsigned CurPoint);
117
118     /// assignRegOrStackSlotAtInterval - assign a register if one
119     /// is available, or spill.
120     void assignRegOrStackSlotAtInterval(LiveInterval* cur);
121
122     ///
123     /// register handling helpers
124     ///
125
126     /// getFreePhysReg - return a free physical register for this virtual
127     /// register interval if we have one, otherwise return 0.
128     unsigned getFreePhysReg(LiveInterval* cur);
129
130     /// assignVirt2StackSlot - assigns this virtual register to a
131     /// stack slot. returns the stack slot
132     int assignVirt2StackSlot(unsigned virtReg);
133
134     void ComputeRelatedRegClasses();
135
136     template <typename ItTy>
137     void printIntervals(const char* const str, ItTy i, ItTy e) const {
138       if (str) DOUT << str << " intervals:\n";
139       for (; i != e; ++i) {
140         DOUT << "\t" << *i->first << " -> ";
141         unsigned reg = i->first->reg;
142         if (MRegisterInfo::isVirtualRegister(reg)) {
143           reg = vrm_->getPhys(reg);
144         }
145         DOUT << mri_->getName(reg) << '\n';
146       }
147     }
148   };
149 }
150
151 void RA::ComputeRelatedRegClasses() {
152   const MRegisterInfo &MRI = *mri_;
153   
154   // First pass, add all reg classes to the union, and determine at least one
155   // reg class that each register is in.
156   bool HasAliases = false;
157   for (MRegisterInfo::regclass_iterator RCI = MRI.regclass_begin(),
158        E = MRI.regclass_end(); RCI != E; ++RCI) {
159     RelatedRegClasses.insert(*RCI);
160     for (TargetRegisterClass::iterator I = (*RCI)->begin(), E = (*RCI)->end();
161          I != E; ++I) {
162       HasAliases = HasAliases || *MRI.getAliasSet(*I) != 0;
163       
164       const TargetRegisterClass *&PRC = OneClassForEachPhysReg[*I];
165       if (PRC) {
166         // Already processed this register.  Just make sure we know that
167         // multiple register classes share a register.
168         RelatedRegClasses.unionSets(PRC, *RCI);
169       } else {
170         PRC = *RCI;
171       }
172     }
173   }
174   
175   // Second pass, now that we know conservatively what register classes each reg
176   // belongs to, add info about aliases.  We don't need to do this for targets
177   // without register aliases.
178   if (HasAliases)
179     for (std::map<unsigned, const TargetRegisterClass*>::iterator
180          I = OneClassForEachPhysReg.begin(), E = OneClassForEachPhysReg.end();
181          I != E; ++I)
182       for (const unsigned *AS = MRI.getAliasSet(I->first); *AS; ++AS)
183         RelatedRegClasses.unionSets(I->second, OneClassForEachPhysReg[*AS]);
184 }
185
186 bool RA::runOnMachineFunction(MachineFunction &fn) {
187   mf_ = &fn;
188   tm_ = &fn.getTarget();
189   mri_ = tm_->getRegisterInfo();
190   li_ = &getAnalysis<LiveIntervals>();
191
192   // If this is the first function compiled, compute the related reg classes.
193   if (RelatedRegClasses.empty())
194     ComputeRelatedRegClasses();
195   
196   PhysRegsUsed = new bool[mri_->getNumRegs()];
197   std::fill(PhysRegsUsed, PhysRegsUsed+mri_->getNumRegs(), false);
198   fn.setUsedPhysRegs(PhysRegsUsed);
199
200   if (!prt_.get()) prt_.reset(new PhysRegTracker(*mri_));
201   vrm_.reset(new VirtRegMap(*mf_));
202   if (!spiller_.get()) spiller_.reset(createSpiller());
203
204   initIntervalSets();
205
206   linearScan();
207
208   // Rewrite spill code and update the PhysRegsUsed set.
209   spiller_->runOnMachineFunction(*mf_, *vrm_);
210
211   vrm_.reset();  // Free the VirtRegMap
212
213
214   while (!unhandled_.empty()) unhandled_.pop();
215   fixed_.clear();
216   active_.clear();
217   inactive_.clear();
218   handled_.clear();
219
220   return true;
221 }
222
223 /// initIntervalSets - initialize the interval sets.
224 ///
225 void RA::initIntervalSets()
226 {
227   assert(unhandled_.empty() && fixed_.empty() &&
228          active_.empty() && inactive_.empty() &&
229          "interval sets should be empty on initialization");
230
231   for (LiveIntervals::iterator i = li_->begin(), e = li_->end(); i != e; ++i) {
232     if (MRegisterInfo::isPhysicalRegister(i->second.reg)) {
233       PhysRegsUsed[i->second.reg] = true;
234       fixed_.push_back(std::make_pair(&i->second, i->second.begin()));
235     } else
236       unhandled_.push(&i->second);
237   }
238 }
239
240 void RA::linearScan()
241 {
242   // linear scan algorithm
243   DOUT << "********** LINEAR SCAN **********\n";
244   DOUT << "********** Function: " << mf_->getFunction()->getName() << '\n';
245
246   // DEBUG(printIntervals("unhandled", unhandled_.begin(), unhandled_.end()));
247   DEBUG(printIntervals("fixed", fixed_.begin(), fixed_.end()));
248   DEBUG(printIntervals("active", active_.begin(), active_.end()));
249   DEBUG(printIntervals("inactive", inactive_.begin(), inactive_.end()));
250
251   while (!unhandled_.empty()) {
252     // pick the interval with the earliest start point
253     LiveInterval* cur = unhandled_.top();
254     unhandled_.pop();
255     ++numIterations;
256     DOUT << "\n*** CURRENT ***: " << *cur << '\n';
257
258     processActiveIntervals(cur->beginNumber());
259     processInactiveIntervals(cur->beginNumber());
260
261     assert(MRegisterInfo::isVirtualRegister(cur->reg) &&
262            "Can only allocate virtual registers!");
263
264     // Allocating a virtual register. try to find a free
265     // physical register or spill an interval (possibly this one) in order to
266     // assign it one.
267     assignRegOrStackSlotAtInterval(cur);
268
269     DEBUG(printIntervals("active", active_.begin(), active_.end()));
270     DEBUG(printIntervals("inactive", inactive_.begin(), inactive_.end()));
271   }
272   numIntervals += li_->getNumIntervals();
273   NumIters += numIterations;
274
275   // expire any remaining active intervals
276   for (IntervalPtrs::reverse_iterator
277          i = active_.rbegin(); i != active_.rend(); ) {
278     unsigned reg = i->first->reg;
279     DOUT << "\tinterval " << *i->first << " expired\n";
280     assert(MRegisterInfo::isVirtualRegister(reg) &&
281            "Can only allocate virtual registers!");
282     reg = vrm_->getPhys(reg);
283     prt_->delRegUse(reg);
284     i = IntervalPtrs::reverse_iterator(active_.erase(i.base()-1));
285   }
286
287   // expire any remaining inactive intervals
288   for (IntervalPtrs::reverse_iterator
289          i = inactive_.rbegin(); i != inactive_.rend(); ) {
290     DOUT << "\tinterval " << *i->first << " expired\n";
291     i = IntervalPtrs::reverse_iterator(inactive_.erase(i.base()-1));
292   }
293
294   // A brute force way of adding live-ins to every BB.
295   for (MachineFunction::iterator MBB = mf_->begin(), E = mf_->end();
296        MBB != E; ++MBB) {
297     unsigned StartIdx = li_->getMBBStartIdx(MBB->getNumber());
298     for (IntervalPtrs::iterator i = fixed_.begin(), e = fixed_.end();
299          i != e; ++i)
300       if (i->first->liveAt(StartIdx))
301         MBB->addLiveIn(i->first->reg);
302
303     for (unsigned i = 0, e = handled_.size(); i != e; ++i) { 
304       LiveInterval *HI = handled_[i];
305       if (HI->liveAt(StartIdx)) {
306         unsigned Reg = HI->reg;
307         if (MRegisterInfo::isVirtualRegister(Reg))
308           Reg = vrm_->getPhys(Reg);
309         MBB->addLiveIn(Reg);
310       }
311     }
312   }
313
314   DOUT << *vrm_;
315 }
316
317 /// processActiveIntervals - expire old intervals and move non-overlapping ones
318 /// to the inactive list.
319 void RA::processActiveIntervals(unsigned CurPoint)
320 {
321   DOUT << "\tprocessing active intervals:\n";
322
323   for (unsigned i = 0, e = active_.size(); i != e; ++i) {
324     LiveInterval *Interval = active_[i].first;
325     LiveInterval::iterator IntervalPos = active_[i].second;
326     unsigned reg = Interval->reg;
327
328     IntervalPos = Interval->advanceTo(IntervalPos, CurPoint);
329
330     if (IntervalPos == Interval->end()) {     // Remove expired intervals.
331       DOUT << "\t\tinterval " << *Interval << " expired\n";
332       assert(MRegisterInfo::isVirtualRegister(reg) &&
333              "Can only allocate virtual registers!");
334       reg = vrm_->getPhys(reg);
335       prt_->delRegUse(reg);
336
337       // Pop off the end of the list.
338       active_[i] = active_.back();
339       active_.pop_back();
340       --i; --e;
341
342     } else if (IntervalPos->start > CurPoint) {
343       // Move inactive intervals to inactive list.
344       DOUT << "\t\tinterval " << *Interval << " inactive\n";
345       assert(MRegisterInfo::isVirtualRegister(reg) &&
346              "Can only allocate virtual registers!");
347       reg = vrm_->getPhys(reg);
348       prt_->delRegUse(reg);
349       // add to inactive.
350       inactive_.push_back(std::make_pair(Interval, IntervalPos));
351
352       // Pop off the end of the list.
353       active_[i] = active_.back();
354       active_.pop_back();
355       --i; --e;
356     } else {
357       // Otherwise, just update the iterator position.
358       active_[i].second = IntervalPos;
359     }
360   }
361 }
362
363 /// processInactiveIntervals - expire old intervals and move overlapping
364 /// ones to the active list.
365 void RA::processInactiveIntervals(unsigned CurPoint)
366 {
367   DOUT << "\tprocessing inactive intervals:\n";
368
369   for (unsigned i = 0, e = inactive_.size(); i != e; ++i) {
370     LiveInterval *Interval = inactive_[i].first;
371     LiveInterval::iterator IntervalPos = inactive_[i].second;
372     unsigned reg = Interval->reg;
373
374     IntervalPos = Interval->advanceTo(IntervalPos, CurPoint);
375
376     if (IntervalPos == Interval->end()) {       // remove expired intervals.
377       DOUT << "\t\tinterval " << *Interval << " expired\n";
378
379       // Pop off the end of the list.
380       inactive_[i] = inactive_.back();
381       inactive_.pop_back();
382       --i; --e;
383     } else if (IntervalPos->start <= CurPoint) {
384       // move re-activated intervals in active list
385       DOUT << "\t\tinterval " << *Interval << " active\n";
386       assert(MRegisterInfo::isVirtualRegister(reg) &&
387              "Can only allocate virtual registers!");
388       reg = vrm_->getPhys(reg);
389       prt_->addRegUse(reg);
390       // add to active
391       active_.push_back(std::make_pair(Interval, IntervalPos));
392
393       // Pop off the end of the list.
394       inactive_[i] = inactive_.back();
395       inactive_.pop_back();
396       --i; --e;
397     } else {
398       // Otherwise, just update the iterator position.
399       inactive_[i].second = IntervalPos;
400     }
401   }
402 }
403
404 /// updateSpillWeights - updates the spill weights of the specifed physical
405 /// register and its weight.
406 static void updateSpillWeights(std::vector<float> &Weights,
407                                unsigned reg, float weight,
408                                const MRegisterInfo *MRI) {
409   Weights[reg] += weight;
410   for (const unsigned* as = MRI->getAliasSet(reg); *as; ++as)
411     Weights[*as] += weight;
412 }
413
414 static RA::IntervalPtrs::iterator FindIntervalInVector(RA::IntervalPtrs &IP,
415                                                        LiveInterval *LI) {
416   for (RA::IntervalPtrs::iterator I = IP.begin(), E = IP.end(); I != E; ++I)
417     if (I->first == LI) return I;
418   return IP.end();
419 }
420
421 static void RevertVectorIteratorsTo(RA::IntervalPtrs &V, unsigned Point) {
422   for (unsigned i = 0, e = V.size(); i != e; ++i) {
423     RA::IntervalPtr &IP = V[i];
424     LiveInterval::iterator I = std::upper_bound(IP.first->begin(),
425                                                 IP.second, Point);
426     if (I != IP.first->begin()) --I;
427     IP.second = I;
428   }
429 }
430
431 /// assignRegOrStackSlotAtInterval - assign a register if one is available, or
432 /// spill.
433 void RA::assignRegOrStackSlotAtInterval(LiveInterval* cur)
434 {
435   DOUT << "\tallocating current interval: ";
436
437   PhysRegTracker backupPrt = *prt_;
438
439   std::vector<std::pair<unsigned, float> > SpillWeightsToAdd;
440   unsigned StartPosition = cur->beginNumber();
441   const TargetRegisterClass *RC = mf_->getSSARegMap()->getRegClass(cur->reg);
442   const TargetRegisterClass *RCLeader = RelatedRegClasses.getLeaderValue(RC);
443       
444   // for every interval in inactive we overlap with, mark the
445   // register as not free and update spill weights.
446   for (IntervalPtrs::const_iterator i = inactive_.begin(),
447          e = inactive_.end(); i != e; ++i) {
448     unsigned Reg = i->first->reg;
449     assert(MRegisterInfo::isVirtualRegister(Reg) &&
450            "Can only allocate virtual registers!");
451     const TargetRegisterClass *RegRC = mf_->getSSARegMap()->getRegClass(Reg);
452     // If this is not in a related reg class to the register we're allocating, 
453     // don't check it.
454     if (RelatedRegClasses.getLeaderValue(RegRC) == RCLeader &&
455         cur->overlapsFrom(*i->first, i->second-1)) {
456       Reg = vrm_->getPhys(Reg);
457       prt_->addRegUse(Reg);
458       SpillWeightsToAdd.push_back(std::make_pair(Reg, i->first->weight));
459     }
460   }
461   
462   // Speculatively check to see if we can get a register right now.  If not,
463   // we know we won't be able to by adding more constraints.  If so, we can
464   // check to see if it is valid.  Doing an exhaustive search of the fixed_ list
465   // is very bad (it contains all callee clobbered registers for any functions
466   // with a call), so we want to avoid doing that if possible.
467   unsigned physReg = getFreePhysReg(cur);
468   if (physReg) {
469     // We got a register.  However, if it's in the fixed_ list, we might
470     // conflict with it.  Check to see if we conflict with it or any of its
471     // aliases.
472     std::set<unsigned> RegAliases;
473     for (const unsigned *AS = mri_->getAliasSet(physReg); *AS; ++AS)
474       RegAliases.insert(*AS);
475     
476     bool ConflictsWithFixed = false;
477     for (unsigned i = 0, e = fixed_.size(); i != e; ++i) {
478       IntervalPtr &IP = fixed_[i];
479       if (physReg == IP.first->reg || RegAliases.count(IP.first->reg)) {
480         // Okay, this reg is on the fixed list.  Check to see if we actually
481         // conflict.
482         LiveInterval *I = IP.first;
483         if (I->endNumber() > StartPosition) {
484           LiveInterval::iterator II = I->advanceTo(IP.second, StartPosition);
485           IP.second = II;
486           if (II != I->begin() && II->start > StartPosition)
487             --II;
488           if (cur->overlapsFrom(*I, II)) {
489             ConflictsWithFixed = true;
490             break;
491           }
492         }
493       }
494     }
495     
496     // Okay, the register picked by our speculative getFreePhysReg call turned
497     // out to be in use.  Actually add all of the conflicting fixed registers to
498     // prt so we can do an accurate query.
499     if (ConflictsWithFixed) {
500       // For every interval in fixed we overlap with, mark the register as not
501       // free and update spill weights.
502       for (unsigned i = 0, e = fixed_.size(); i != e; ++i) {
503         IntervalPtr &IP = fixed_[i];
504         LiveInterval *I = IP.first;
505
506         const TargetRegisterClass *RegRC = OneClassForEachPhysReg[I->reg];
507         if (RelatedRegClasses.getLeaderValue(RegRC) == RCLeader &&       
508             I->endNumber() > StartPosition) {
509           LiveInterval::iterator II = I->advanceTo(IP.second, StartPosition);
510           IP.second = II;
511           if (II != I->begin() && II->start > StartPosition)
512             --II;
513           if (cur->overlapsFrom(*I, II)) {
514             unsigned reg = I->reg;
515             prt_->addRegUse(reg);
516             SpillWeightsToAdd.push_back(std::make_pair(reg, I->weight));
517           }
518         }
519       }
520
521       // Using the newly updated prt_ object, which includes conflicts in the
522       // future, see if there are any registers available.
523       physReg = getFreePhysReg(cur);
524     }
525   }
526     
527   // Restore the physical register tracker, removing information about the
528   // future.
529   *prt_ = backupPrt;
530   
531   // if we find a free register, we are done: assign this virtual to
532   // the free physical register and add this interval to the active
533   // list.
534   if (physReg) {
535     DOUT <<  mri_->getName(physReg) << '\n';
536     vrm_->assignVirt2Phys(cur->reg, physReg);
537     prt_->addRegUse(physReg);
538     active_.push_back(std::make_pair(cur, cur->begin()));
539     handled_.push_back(cur);
540     return;
541   }
542   DOUT << "no free registers\n";
543
544   // Compile the spill weights into an array that is better for scanning.
545   std::vector<float> SpillWeights(mri_->getNumRegs(), 0.0);
546   for (std::vector<std::pair<unsigned, float> >::iterator
547        I = SpillWeightsToAdd.begin(), E = SpillWeightsToAdd.end(); I != E; ++I)
548     updateSpillWeights(SpillWeights, I->first, I->second, mri_);
549   
550   // for each interval in active, update spill weights.
551   for (IntervalPtrs::const_iterator i = active_.begin(), e = active_.end();
552        i != e; ++i) {
553     unsigned reg = i->first->reg;
554     assert(MRegisterInfo::isVirtualRegister(reg) &&
555            "Can only allocate virtual registers!");
556     reg = vrm_->getPhys(reg);
557     updateSpillWeights(SpillWeights, reg, i->first->weight, mri_);
558   }
559  
560   DOUT << "\tassigning stack slot at interval "<< *cur << ":\n";
561
562   // Find a register to spill.
563   float minWeight = HUGE_VALF;
564   unsigned minReg = 0;
565   for (TargetRegisterClass::iterator i = RC->allocation_order_begin(*mf_),
566        e = RC->allocation_order_end(*mf_); i != e; ++i) {
567     unsigned reg = *i;
568     if (minWeight > SpillWeights[reg]) {
569       minWeight = SpillWeights[reg];
570       minReg = reg;
571     }
572   }
573   
574   // If we didn't find a register that is spillable, try aliases?
575   if (!minReg) {
576     for (TargetRegisterClass::iterator i = RC->allocation_order_begin(*mf_),
577            e = RC->allocation_order_end(*mf_); i != e; ++i) {
578       unsigned reg = *i;
579       // No need to worry about if the alias register size < regsize of RC.
580       // We are going to spill all registers that alias it anyway.
581       for (const unsigned* as = mri_->getAliasSet(reg); *as; ++as) {
582         if (minWeight > SpillWeights[*as]) {
583           minWeight = SpillWeights[*as];
584           minReg = *as;
585         }
586       }
587     }
588
589     // All registers must have inf weight. Just grab one!
590     if (!minReg)
591       minReg = *RC->allocation_order_begin(*mf_);
592   }
593   
594   DOUT << "\t\tregister with min weight: "
595        << mri_->getName(minReg) << " (" << minWeight << ")\n";
596
597   // if the current has the minimum weight, we need to spill it and
598   // add any added intervals back to unhandled, and restart
599   // linearscan.
600   if (cur->weight != HUGE_VALF && cur->weight <= minWeight) {
601     DOUT << "\t\t\tspilling(c): " << *cur << '\n';
602     int slot = vrm_->assignVirt2StackSlot(cur->reg);
603     std::vector<LiveInterval*> added =
604       li_->addIntervalsForSpills(*cur, *vrm_, slot);
605     if (added.empty())
606       return;  // Early exit if all spills were folded.
607
608     // Merge added with unhandled.  Note that we know that
609     // addIntervalsForSpills returns intervals sorted by their starting
610     // point.
611     for (unsigned i = 0, e = added.size(); i != e; ++i)
612       unhandled_.push(added[i]);
613     return;
614   }
615
616   ++NumBacktracks;
617
618   // push the current interval back to unhandled since we are going
619   // to re-run at least this iteration. Since we didn't modify it it
620   // should go back right in the front of the list
621   unhandled_.push(cur);
622
623   // otherwise we spill all intervals aliasing the register with
624   // minimum weight, rollback to the interval with the earliest
625   // start point and let the linear scan algorithm run again
626   std::vector<LiveInterval*> added;
627   assert(MRegisterInfo::isPhysicalRegister(minReg) &&
628          "did not choose a register to spill?");
629   std::vector<bool> toSpill(mri_->getNumRegs(), false);
630
631   // We are going to spill minReg and all its aliases.
632   toSpill[minReg] = true;
633   for (const unsigned* as = mri_->getAliasSet(minReg); *as; ++as)
634     toSpill[*as] = true;
635
636   // the earliest start of a spilled interval indicates up to where
637   // in handled we need to roll back
638   unsigned earliestStart = cur->beginNumber();
639
640   // set of spilled vregs (used later to rollback properly)
641   std::set<unsigned> spilled;
642
643   // spill live intervals of virtual regs mapped to the physical register we
644   // want to clear (and its aliases).  We only spill those that overlap with the
645   // current interval as the rest do not affect its allocation. we also keep
646   // track of the earliest start of all spilled live intervals since this will
647   // mark our rollback point.
648   for (IntervalPtrs::iterator i = active_.begin(); i != active_.end(); ++i) {
649     unsigned reg = i->first->reg;
650     if (//MRegisterInfo::isVirtualRegister(reg) &&
651         toSpill[vrm_->getPhys(reg)] &&
652         cur->overlapsFrom(*i->first, i->second)) {
653       DOUT << "\t\t\tspilling(a): " << *i->first << '\n';
654       earliestStart = std::min(earliestStart, i->first->beginNumber());
655       int slot = vrm_->assignVirt2StackSlot(i->first->reg);
656       std::vector<LiveInterval*> newIs =
657         li_->addIntervalsForSpills(*i->first, *vrm_, slot);
658       std::copy(newIs.begin(), newIs.end(), std::back_inserter(added));
659       spilled.insert(reg);
660     }
661   }
662   for (IntervalPtrs::iterator i = inactive_.begin(); i != inactive_.end(); ++i){
663     unsigned reg = i->first->reg;
664     if (//MRegisterInfo::isVirtualRegister(reg) &&
665         toSpill[vrm_->getPhys(reg)] &&
666         cur->overlapsFrom(*i->first, i->second-1)) {
667       DOUT << "\t\t\tspilling(i): " << *i->first << '\n';
668       earliestStart = std::min(earliestStart, i->first->beginNumber());
669       int slot = vrm_->assignVirt2StackSlot(reg);
670       std::vector<LiveInterval*> newIs =
671         li_->addIntervalsForSpills(*i->first, *vrm_, slot);
672       std::copy(newIs.begin(), newIs.end(), std::back_inserter(added));
673       spilled.insert(reg);
674     }
675   }
676
677   DOUT << "\t\trolling back to: " << earliestStart << '\n';
678
679   // Scan handled in reverse order up to the earliest start of a
680   // spilled live interval and undo each one, restoring the state of
681   // unhandled.
682   while (!handled_.empty()) {
683     LiveInterval* i = handled_.back();
684     // If this interval starts before t we are done.
685     if (i->beginNumber() < earliestStart)
686       break;
687     DOUT << "\t\t\tundo changes for: " << *i << '\n';
688     handled_.pop_back();
689
690     // When undoing a live interval allocation we must know if it is active or
691     // inactive to properly update the PhysRegTracker and the VirtRegMap.
692     IntervalPtrs::iterator it;
693     if ((it = FindIntervalInVector(active_, i)) != active_.end()) {
694       active_.erase(it);
695       assert(!MRegisterInfo::isPhysicalRegister(i->reg));
696       if (!spilled.count(i->reg))
697         unhandled_.push(i);
698       prt_->delRegUse(vrm_->getPhys(i->reg));
699       vrm_->clearVirt(i->reg);
700     } else if ((it = FindIntervalInVector(inactive_, i)) != inactive_.end()) {
701       inactive_.erase(it);
702       assert(!MRegisterInfo::isPhysicalRegister(i->reg));
703       if (!spilled.count(i->reg))
704         unhandled_.push(i);
705       vrm_->clearVirt(i->reg);
706     } else {
707       assert(MRegisterInfo::isVirtualRegister(i->reg) &&
708              "Can only allocate virtual registers!");
709       vrm_->clearVirt(i->reg);
710       unhandled_.push(i);
711     }
712   }
713
714   // Rewind the iterators in the active, inactive, and fixed lists back to the
715   // point we reverted to.
716   RevertVectorIteratorsTo(active_, earliestStart);
717   RevertVectorIteratorsTo(inactive_, earliestStart);
718   RevertVectorIteratorsTo(fixed_, earliestStart);
719
720   // scan the rest and undo each interval that expired after t and
721   // insert it in active (the next iteration of the algorithm will
722   // put it in inactive if required)
723   for (unsigned i = 0, e = handled_.size(); i != e; ++i) {
724     LiveInterval *HI = handled_[i];
725     if (!HI->expiredAt(earliestStart) &&
726         HI->expiredAt(cur->beginNumber())) {
727       DOUT << "\t\t\tundo changes for: " << *HI << '\n';
728       active_.push_back(std::make_pair(HI, HI->begin()));
729       assert(!MRegisterInfo::isPhysicalRegister(HI->reg));
730       prt_->addRegUse(vrm_->getPhys(HI->reg));
731     }
732   }
733
734   // merge added with unhandled
735   for (unsigned i = 0, e = added.size(); i != e; ++i)
736     unhandled_.push(added[i]);
737 }
738
739 /// getFreePhysReg - return a free physical register for this virtual register
740 /// interval if we have one, otherwise return 0.
741 unsigned RA::getFreePhysReg(LiveInterval *cur) {
742   std::vector<unsigned> inactiveCounts(mri_->getNumRegs(), 0);
743   unsigned MaxInactiveCount = 0;
744   
745   const TargetRegisterClass *RC = mf_->getSSARegMap()->getRegClass(cur->reg);
746   const TargetRegisterClass *RCLeader = RelatedRegClasses.getLeaderValue(RC);
747  
748   for (IntervalPtrs::iterator i = inactive_.begin(), e = inactive_.end();
749        i != e; ++i) {
750     unsigned reg = i->first->reg;
751     assert(MRegisterInfo::isVirtualRegister(reg) &&
752            "Can only allocate virtual registers!");
753
754     // If this is not in a related reg class to the register we're allocating, 
755     // don't check it.
756     const TargetRegisterClass *RegRC = mf_->getSSARegMap()->getRegClass(reg);
757     if (RelatedRegClasses.getLeaderValue(RegRC) == RCLeader) {
758       reg = vrm_->getPhys(reg);
759       ++inactiveCounts[reg];
760       MaxInactiveCount = std::max(MaxInactiveCount, inactiveCounts[reg]);
761     }
762   }
763
764   const TargetRegisterClass* rc = mf_->getSSARegMap()->getRegClass(cur->reg);
765
766   unsigned FreeReg = 0;
767   unsigned FreeRegInactiveCount = 0;
768   
769   // Scan for the first available register.
770   TargetRegisterClass::iterator I = rc->allocation_order_begin(*mf_);
771   TargetRegisterClass::iterator E = rc->allocation_order_end(*mf_);
772   for (; I != E; ++I)
773     if (prt_->isRegAvail(*I)) {
774       FreeReg = *I;
775       FreeRegInactiveCount = inactiveCounts[FreeReg];
776       break;
777     }
778   
779   // If there are no free regs, or if this reg has the max inactive count,
780   // return this register.
781   if (FreeReg == 0 || FreeRegInactiveCount == MaxInactiveCount) return FreeReg;
782   
783   // Continue scanning the registers, looking for the one with the highest
784   // inactive count.  Alkis found that this reduced register pressure very
785   // slightly on X86 (in rev 1.94 of this file), though this should probably be
786   // reevaluated now.
787   for (; I != E; ++I) {
788     unsigned Reg = *I;
789     if (prt_->isRegAvail(Reg) && FreeRegInactiveCount < inactiveCounts[Reg]) {
790       FreeReg = Reg;
791       FreeRegInactiveCount = inactiveCounts[Reg];
792       if (FreeRegInactiveCount == MaxInactiveCount)
793         break;    // We found the one with the max inactive count.
794     }
795   }
796   
797   return FreeReg;
798 }
799
800 FunctionPass* llvm::createLinearScanRegisterAllocator() {
801   return new RA();
802 }