Fix PR3391 and PR3864. Reg allocator infinite looping.
[oota-llvm.git] / lib / CodeGen / RegAllocLinearScan.cpp
1 //===-- RegAllocLinearScan.cpp - Linear Scan register allocator -----------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements a linear scan register allocator.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #define DEBUG_TYPE "regalloc"
15 #include "PhysRegTracker.h"
16 #include "VirtRegMap.h"
17 #include "Spiller.h"
18 #include "llvm/Function.h"
19 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
20 #include "llvm/CodeGen/LiveStackAnalysis.h"
21 #include "llvm/CodeGen/MachineFunctionPass.h"
22 #include "llvm/CodeGen/MachineInstr.h"
23 #include "llvm/CodeGen/MachineLoopInfo.h"
24 #include "llvm/CodeGen/MachineRegisterInfo.h"
25 #include "llvm/CodeGen/Passes.h"
26 #include "llvm/CodeGen/RegAllocRegistry.h"
27 #include "llvm/CodeGen/RegisterCoalescer.h"
28 #include "llvm/Target/TargetRegisterInfo.h"
29 #include "llvm/Target/TargetMachine.h"
30 #include "llvm/Target/TargetOptions.h"
31 #include "llvm/Target/TargetInstrInfo.h"
32 #include "llvm/ADT/EquivalenceClasses.h"
33 #include "llvm/ADT/SmallSet.h"
34 #include "llvm/ADT/Statistic.h"
35 #include "llvm/ADT/STLExtras.h"
36 #include "llvm/Support/Debug.h"
37 #include "llvm/Support/Compiler.h"
38 #include <algorithm>
39 #include <set>
40 #include <queue>
41 #include <memory>
42 #include <cmath>
43 using namespace llvm;
44
45 STATISTIC(NumIters     , "Number of iterations performed");
46 STATISTIC(NumBacktracks, "Number of times we had to backtrack");
47 STATISTIC(NumCoalesce,   "Number of copies coalesced");
48
49 static cl::opt<bool>
50 NewHeuristic("new-spilling-heuristic",
51              cl::desc("Use new spilling heuristic"),
52              cl::init(false), cl::Hidden);
53
54 static cl::opt<bool>
55 PreSplitIntervals("pre-alloc-split",
56                   cl::desc("Pre-register allocation live interval splitting"),
57                   cl::init(false), cl::Hidden);
58
59 static RegisterRegAlloc
60 linearscanRegAlloc("linearscan", "linear scan register allocator",
61                    createLinearScanRegisterAllocator);
62
63 namespace {
64   struct VISIBILITY_HIDDEN RALinScan : public MachineFunctionPass {
65     static char ID;
66     RALinScan() : MachineFunctionPass(&ID) {}
67
68     typedef std::pair<LiveInterval*, LiveInterval::iterator> IntervalPtr;
69     typedef SmallVector<IntervalPtr, 32> IntervalPtrs;
70   private:
71     /// RelatedRegClasses - This structure is built the first time a function is
72     /// compiled, and keeps track of which register classes have registers that
73     /// belong to multiple classes or have aliases that are in other classes.
74     EquivalenceClasses<const TargetRegisterClass*> RelatedRegClasses;
75     DenseMap<unsigned, const TargetRegisterClass*> OneClassForEachPhysReg;
76
77     MachineFunction* mf_;
78     MachineRegisterInfo* mri_;
79     const TargetMachine* tm_;
80     const TargetRegisterInfo* tri_;
81     const TargetInstrInfo* tii_;
82     BitVector allocatableRegs_;
83     LiveIntervals* li_;
84     LiveStacks* ls_;
85     const MachineLoopInfo *loopInfo;
86
87     /// handled_ - Intervals are added to the handled_ set in the order of their
88     /// start value.  This is uses for backtracking.
89     std::vector<LiveInterval*> handled_;
90
91     /// fixed_ - Intervals that correspond to machine registers.
92     ///
93     IntervalPtrs fixed_;
94
95     /// active_ - Intervals that are currently being processed, and which have a
96     /// live range active for the current point.
97     IntervalPtrs active_;
98
99     /// inactive_ - Intervals that are currently being processed, but which have
100     /// a hold at the current point.
101     IntervalPtrs inactive_;
102
103     typedef std::priority_queue<LiveInterval*,
104                                 SmallVector<LiveInterval*, 64>,
105                                 greater_ptr<LiveInterval> > IntervalHeap;
106     IntervalHeap unhandled_;
107     std::auto_ptr<PhysRegTracker> prt_;
108     VirtRegMap* vrm_;
109     std::auto_ptr<Spiller> spiller_;
110
111   public:
112     virtual const char* getPassName() const {
113       return "Linear Scan Register Allocator";
114     }
115
116     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
117       AU.addRequired<LiveIntervals>();
118       if (StrongPHIElim)
119         AU.addRequiredID(StrongPHIEliminationID);
120       // Make sure PassManager knows which analyses to make available
121       // to coalescing and which analyses coalescing invalidates.
122       AU.addRequiredTransitive<RegisterCoalescer>();
123       if (PreSplitIntervals)
124         AU.addRequiredID(PreAllocSplittingID);
125       AU.addRequired<LiveStacks>();
126       AU.addPreserved<LiveStacks>();
127       AU.addRequired<MachineLoopInfo>();
128       AU.addPreserved<MachineLoopInfo>();
129       AU.addRequired<VirtRegMap>();
130       AU.addPreserved<VirtRegMap>();
131       AU.addPreservedID(MachineDominatorsID);
132       MachineFunctionPass::getAnalysisUsage(AU);
133     }
134
135     /// runOnMachineFunction - register allocate the whole function
136     bool runOnMachineFunction(MachineFunction&);
137
138   private:
139     /// linearScan - the linear scan algorithm
140     void linearScan();
141
142     /// initIntervalSets - initialize the interval sets.
143     ///
144     void initIntervalSets();
145
146     /// processActiveIntervals - expire old intervals and move non-overlapping
147     /// ones to the inactive list.
148     void processActiveIntervals(unsigned CurPoint);
149
150     /// processInactiveIntervals - expire old intervals and move overlapping
151     /// ones to the active list.
152     void processInactiveIntervals(unsigned CurPoint);
153
154     /// assignRegOrStackSlotAtInterval - assign a register if one
155     /// is available, or spill.
156     void assignRegOrStackSlotAtInterval(LiveInterval* cur);
157
158     /// findIntervalsToSpill - Determine the intervals to spill for the
159     /// specified interval. It's passed the physical registers whose spill
160     /// weight is the lowest among all the registers whose live intervals
161     /// conflict with the interval.
162     void findIntervalsToSpill(LiveInterval *cur,
163                             std::vector<std::pair<unsigned,float> > &Candidates,
164                             unsigned NumCands,
165                             SmallVector<LiveInterval*, 8> &SpillIntervals);
166
167     /// attemptTrivialCoalescing - If a simple interval is defined by a copy,
168     /// try allocate the definition the same register as the source register
169     /// if the register is not defined during live time of the interval. This
170     /// eliminate a copy. This is used to coalesce copies which were not
171     /// coalesced away before allocation either due to dest and src being in
172     /// different register classes or because the coalescer was overly
173     /// conservative.
174     unsigned attemptTrivialCoalescing(LiveInterval &cur, unsigned Reg);
175
176     ///
177     /// register handling helpers
178     ///
179
180     /// getFreePhysReg - return a free physical register for this virtual
181     /// register interval if we have one, otherwise return 0.
182     unsigned getFreePhysReg(LiveInterval* cur);
183
184     /// assignVirt2StackSlot - assigns this virtual register to a
185     /// stack slot. returns the stack slot
186     int assignVirt2StackSlot(unsigned virtReg);
187
188     void ComputeRelatedRegClasses();
189
190     template <typename ItTy>
191     void printIntervals(const char* const str, ItTy i, ItTy e) const {
192       if (str) DOUT << str << " intervals:\n";
193       for (; i != e; ++i) {
194         DOUT << "\t" << *i->first << " -> ";
195         unsigned reg = i->first->reg;
196         if (TargetRegisterInfo::isVirtualRegister(reg)) {
197           reg = vrm_->getPhys(reg);
198         }
199         DOUT << tri_->getName(reg) << '\n';
200       }
201     }
202   };
203   char RALinScan::ID = 0;
204 }
205
206 static RegisterPass<RALinScan>
207 X("linearscan-regalloc", "Linear Scan Register Allocator");
208
209 void RALinScan::ComputeRelatedRegClasses() {
210   const TargetRegisterInfo &TRI = *tri_;
211   
212   // First pass, add all reg classes to the union, and determine at least one
213   // reg class that each register is in.
214   bool HasAliases = false;
215   for (TargetRegisterInfo::regclass_iterator RCI = TRI.regclass_begin(),
216        E = TRI.regclass_end(); RCI != E; ++RCI) {
217     RelatedRegClasses.insert(*RCI);
218     for (TargetRegisterClass::iterator I = (*RCI)->begin(), E = (*RCI)->end();
219          I != E; ++I) {
220       HasAliases = HasAliases || *TRI.getAliasSet(*I) != 0;
221       
222       const TargetRegisterClass *&PRC = OneClassForEachPhysReg[*I];
223       if (PRC) {
224         // Already processed this register.  Just make sure we know that
225         // multiple register classes share a register.
226         RelatedRegClasses.unionSets(PRC, *RCI);
227       } else {
228         PRC = *RCI;
229       }
230     }
231   }
232   
233   // Second pass, now that we know conservatively what register classes each reg
234   // belongs to, add info about aliases.  We don't need to do this for targets
235   // without register aliases.
236   if (HasAliases)
237     for (DenseMap<unsigned, const TargetRegisterClass*>::iterator
238          I = OneClassForEachPhysReg.begin(), E = OneClassForEachPhysReg.end();
239          I != E; ++I)
240       for (const unsigned *AS = TRI.getAliasSet(I->first); *AS; ++AS)
241         RelatedRegClasses.unionSets(I->second, OneClassForEachPhysReg[*AS]);
242 }
243
244 /// attemptTrivialCoalescing - If a simple interval is defined by a copy,
245 /// try allocate the definition the same register as the source register
246 /// if the register is not defined during live time of the interval. This
247 /// eliminate a copy. This is used to coalesce copies which were not
248 /// coalesced away before allocation either due to dest and src being in
249 /// different register classes or because the coalescer was overly
250 /// conservative.
251 unsigned RALinScan::attemptTrivialCoalescing(LiveInterval &cur, unsigned Reg) {
252   if ((cur.preference && cur.preference == Reg) || !cur.containsOneValue())
253     return Reg;
254
255   VNInfo *vni = cur.begin()->valno;
256   if (!vni->def || vni->def == ~1U || vni->def == ~0U)
257     return Reg;
258   MachineInstr *CopyMI = li_->getInstructionFromIndex(vni->def);
259   unsigned SrcReg, DstReg, SrcSubReg, DstSubReg;
260   if (!CopyMI ||
261       !tii_->isMoveInstr(*CopyMI, SrcReg, DstReg, SrcSubReg, DstSubReg))
262     return Reg;
263   if (TargetRegisterInfo::isVirtualRegister(SrcReg)) {
264     if (!vrm_->isAssignedReg(SrcReg))
265       return Reg;
266     else
267       SrcReg = vrm_->getPhys(SrcReg);
268   }
269   if (Reg == SrcReg)
270     return Reg;
271
272   const TargetRegisterClass *RC = mri_->getRegClass(cur.reg);
273   if (!RC->contains(SrcReg))
274     return Reg;
275
276   // Try to coalesce.
277   if (!li_->conflictsWithPhysRegDef(cur, *vrm_, SrcReg)) {
278     DOUT << "Coalescing: " << cur << " -> " << tri_->getName(SrcReg)
279          << '\n';
280     vrm_->clearVirt(cur.reg);
281     vrm_->assignVirt2Phys(cur.reg, SrcReg);
282     ++NumCoalesce;
283     return SrcReg;
284   }
285
286   return Reg;
287 }
288
289 bool RALinScan::runOnMachineFunction(MachineFunction &fn) {
290   mf_ = &fn;
291   mri_ = &fn.getRegInfo();
292   tm_ = &fn.getTarget();
293   tri_ = tm_->getRegisterInfo();
294   tii_ = tm_->getInstrInfo();
295   allocatableRegs_ = tri_->getAllocatableSet(fn);
296   li_ = &getAnalysis<LiveIntervals>();
297   ls_ = &getAnalysis<LiveStacks>();
298   loopInfo = &getAnalysis<MachineLoopInfo>();
299
300   // We don't run the coalescer here because we have no reason to
301   // interact with it.  If the coalescer requires interaction, it
302   // won't do anything.  If it doesn't require interaction, we assume
303   // it was run as a separate pass.
304
305   // If this is the first function compiled, compute the related reg classes.
306   if (RelatedRegClasses.empty())
307     ComputeRelatedRegClasses();
308   
309   if (!prt_.get()) prt_.reset(new PhysRegTracker(*tri_));
310   vrm_ = &getAnalysis<VirtRegMap>();
311   if (!spiller_.get()) spiller_.reset(createSpiller());
312
313   initIntervalSets();
314
315   linearScan();
316
317   // Rewrite spill code and update the PhysRegsUsed set.
318   spiller_->runOnMachineFunction(*mf_, *vrm_);
319
320   assert(unhandled_.empty() && "Unhandled live intervals remain!");
321   fixed_.clear();
322   active_.clear();
323   inactive_.clear();
324   handled_.clear();
325
326   return true;
327 }
328
329 /// initIntervalSets - initialize the interval sets.
330 ///
331 void RALinScan::initIntervalSets()
332 {
333   assert(unhandled_.empty() && fixed_.empty() &&
334          active_.empty() && inactive_.empty() &&
335          "interval sets should be empty on initialization");
336
337   handled_.reserve(li_->getNumIntervals());
338
339   for (LiveIntervals::iterator i = li_->begin(), e = li_->end(); i != e; ++i) {
340     if (TargetRegisterInfo::isPhysicalRegister(i->second->reg)) {
341       mri_->setPhysRegUsed(i->second->reg);
342       fixed_.push_back(std::make_pair(i->second, i->second->begin()));
343     } else
344       unhandled_.push(i->second);
345   }
346 }
347
348 void RALinScan::linearScan()
349 {
350   // linear scan algorithm
351   DOUT << "********** LINEAR SCAN **********\n";
352   DOUT << "********** Function: " << mf_->getFunction()->getName() << '\n';
353
354   DEBUG(printIntervals("fixed", fixed_.begin(), fixed_.end()));
355
356   while (!unhandled_.empty()) {
357     // pick the interval with the earliest start point
358     LiveInterval* cur = unhandled_.top();
359     unhandled_.pop();
360     ++NumIters;
361     DOUT << "\n*** CURRENT ***: " << *cur << '\n';
362
363     if (!cur->empty()) {
364       processActiveIntervals(cur->beginNumber());
365       processInactiveIntervals(cur->beginNumber());
366
367       assert(TargetRegisterInfo::isVirtualRegister(cur->reg) &&
368              "Can only allocate virtual registers!");
369     }
370
371     // Allocating a virtual register. try to find a free
372     // physical register or spill an interval (possibly this one) in order to
373     // assign it one.
374     assignRegOrStackSlotAtInterval(cur);
375
376     DEBUG(printIntervals("active", active_.begin(), active_.end()));
377     DEBUG(printIntervals("inactive", inactive_.begin(), inactive_.end()));
378   }
379
380   // expire any remaining active intervals
381   while (!active_.empty()) {
382     IntervalPtr &IP = active_.back();
383     unsigned reg = IP.first->reg;
384     DOUT << "\tinterval " << *IP.first << " expired\n";
385     assert(TargetRegisterInfo::isVirtualRegister(reg) &&
386            "Can only allocate virtual registers!");
387     reg = vrm_->getPhys(reg);
388     prt_->delRegUse(reg);
389     active_.pop_back();
390   }
391
392   // expire any remaining inactive intervals
393   DEBUG(for (IntervalPtrs::reverse_iterator
394                i = inactive_.rbegin(); i != inactive_.rend(); ++i)
395         DOUT << "\tinterval " << *i->first << " expired\n");
396   inactive_.clear();
397
398   // Add live-ins to every BB except for entry. Also perform trivial coalescing.
399   MachineFunction::iterator EntryMBB = mf_->begin();
400   SmallVector<MachineBasicBlock*, 8> LiveInMBBs;
401   for (LiveIntervals::iterator i = li_->begin(), e = li_->end(); i != e; ++i) {
402     LiveInterval &cur = *i->second;
403     unsigned Reg = 0;
404     bool isPhys = TargetRegisterInfo::isPhysicalRegister(cur.reg);
405     if (isPhys)
406       Reg = cur.reg;
407     else if (vrm_->isAssignedReg(cur.reg))
408       Reg = attemptTrivialCoalescing(cur, vrm_->getPhys(cur.reg));
409     if (!Reg)
410       continue;
411     // Ignore splited live intervals.
412     if (!isPhys && vrm_->getPreSplitReg(cur.reg))
413       continue;
414     for (LiveInterval::Ranges::const_iterator I = cur.begin(), E = cur.end();
415          I != E; ++I) {
416       const LiveRange &LR = *I;
417       if (li_->findLiveInMBBs(LR.start, LR.end, LiveInMBBs)) {
418         for (unsigned i = 0, e = LiveInMBBs.size(); i != e; ++i)
419           if (LiveInMBBs[i] != EntryMBB)
420             LiveInMBBs[i]->addLiveIn(Reg);
421         LiveInMBBs.clear();
422       }
423     }
424   }
425
426   DOUT << *vrm_;
427 }
428
429 /// processActiveIntervals - expire old intervals and move non-overlapping ones
430 /// to the inactive list.
431 void RALinScan::processActiveIntervals(unsigned CurPoint)
432 {
433   DOUT << "\tprocessing active intervals:\n";
434
435   for (unsigned i = 0, e = active_.size(); i != e; ++i) {
436     LiveInterval *Interval = active_[i].first;
437     LiveInterval::iterator IntervalPos = active_[i].second;
438     unsigned reg = Interval->reg;
439
440     IntervalPos = Interval->advanceTo(IntervalPos, CurPoint);
441
442     if (IntervalPos == Interval->end()) {     // Remove expired intervals.
443       DOUT << "\t\tinterval " << *Interval << " expired\n";
444       assert(TargetRegisterInfo::isVirtualRegister(reg) &&
445              "Can only allocate virtual registers!");
446       reg = vrm_->getPhys(reg);
447       prt_->delRegUse(reg);
448
449       // Pop off the end of the list.
450       active_[i] = active_.back();
451       active_.pop_back();
452       --i; --e;
453
454     } else if (IntervalPos->start > CurPoint) {
455       // Move inactive intervals to inactive list.
456       DOUT << "\t\tinterval " << *Interval << " inactive\n";
457       assert(TargetRegisterInfo::isVirtualRegister(reg) &&
458              "Can only allocate virtual registers!");
459       reg = vrm_->getPhys(reg);
460       prt_->delRegUse(reg);
461       // add to inactive.
462       inactive_.push_back(std::make_pair(Interval, IntervalPos));
463
464       // Pop off the end of the list.
465       active_[i] = active_.back();
466       active_.pop_back();
467       --i; --e;
468     } else {
469       // Otherwise, just update the iterator position.
470       active_[i].second = IntervalPos;
471     }
472   }
473 }
474
475 /// processInactiveIntervals - expire old intervals and move overlapping
476 /// ones to the active list.
477 void RALinScan::processInactiveIntervals(unsigned CurPoint)
478 {
479   DOUT << "\tprocessing inactive intervals:\n";
480
481   for (unsigned i = 0, e = inactive_.size(); i != e; ++i) {
482     LiveInterval *Interval = inactive_[i].first;
483     LiveInterval::iterator IntervalPos = inactive_[i].second;
484     unsigned reg = Interval->reg;
485
486     IntervalPos = Interval->advanceTo(IntervalPos, CurPoint);
487
488     if (IntervalPos == Interval->end()) {       // remove expired intervals.
489       DOUT << "\t\tinterval " << *Interval << " expired\n";
490
491       // Pop off the end of the list.
492       inactive_[i] = inactive_.back();
493       inactive_.pop_back();
494       --i; --e;
495     } else if (IntervalPos->start <= CurPoint) {
496       // move re-activated intervals in active list
497       DOUT << "\t\tinterval " << *Interval << " active\n";
498       assert(TargetRegisterInfo::isVirtualRegister(reg) &&
499              "Can only allocate virtual registers!");
500       reg = vrm_->getPhys(reg);
501       prt_->addRegUse(reg);
502       // add to active
503       active_.push_back(std::make_pair(Interval, IntervalPos));
504
505       // Pop off the end of the list.
506       inactive_[i] = inactive_.back();
507       inactive_.pop_back();
508       --i; --e;
509     } else {
510       // Otherwise, just update the iterator position.
511       inactive_[i].second = IntervalPos;
512     }
513   }
514 }
515
516 /// updateSpillWeights - updates the spill weights of the specifed physical
517 /// register and its weight.
518 static void updateSpillWeights(std::vector<float> &Weights,
519                                unsigned reg, float weight,
520                                const TargetRegisterInfo *TRI) {
521   Weights[reg] += weight;
522   for (const unsigned* as = TRI->getAliasSet(reg); *as; ++as)
523     Weights[*as] += weight;
524 }
525
526 static
527 RALinScan::IntervalPtrs::iterator
528 FindIntervalInVector(RALinScan::IntervalPtrs &IP, LiveInterval *LI) {
529   for (RALinScan::IntervalPtrs::iterator I = IP.begin(), E = IP.end();
530        I != E; ++I)
531     if (I->first == LI) return I;
532   return IP.end();
533 }
534
535 static void RevertVectorIteratorsTo(RALinScan::IntervalPtrs &V, unsigned Point){
536   for (unsigned i = 0, e = V.size(); i != e; ++i) {
537     RALinScan::IntervalPtr &IP = V[i];
538     LiveInterval::iterator I = std::upper_bound(IP.first->begin(),
539                                                 IP.second, Point);
540     if (I != IP.first->begin()) --I;
541     IP.second = I;
542   }
543 }
544
545 /// addStackInterval - Create a LiveInterval for stack if the specified live
546 /// interval has been spilled.
547 static void addStackInterval(LiveInterval *cur, LiveStacks *ls_,
548                              LiveIntervals *li_, float &Weight,
549                              VirtRegMap &vrm_) {
550   int SS = vrm_.getStackSlot(cur->reg);
551   if (SS == VirtRegMap::NO_STACK_SLOT)
552     return;
553   LiveInterval &SI = ls_->getOrCreateInterval(SS);
554   SI.weight += Weight;
555
556   VNInfo *VNI;
557   if (SI.hasAtLeastOneValue())
558     VNI = SI.getValNumInfo(0);
559   else
560     VNI = SI.getNextValue(~0U, 0, ls_->getVNInfoAllocator());
561
562   LiveInterval &RI = li_->getInterval(cur->reg);
563   // FIXME: This may be overly conservative.
564   SI.MergeRangesInAsValue(RI, VNI);
565 }
566
567 /// getConflictWeight - Return the number of conflicts between cur
568 /// live interval and defs and uses of Reg weighted by loop depthes.
569 static float getConflictWeight(LiveInterval *cur, unsigned Reg,
570                                   LiveIntervals *li_,
571                                   MachineRegisterInfo *mri_,
572                                   const MachineLoopInfo *loopInfo) {
573   float Conflicts = 0;
574   for (MachineRegisterInfo::reg_iterator I = mri_->reg_begin(Reg),
575          E = mri_->reg_end(); I != E; ++I) {
576     MachineInstr *MI = &*I;
577     if (cur->liveAt(li_->getInstructionIndex(MI))) {
578       unsigned loopDepth = loopInfo->getLoopDepth(MI->getParent());
579       Conflicts += powf(10.0f, (float)loopDepth);
580     }
581   }
582   return Conflicts;
583 }
584
585 /// findIntervalsToSpill - Determine the intervals to spill for the
586 /// specified interval. It's passed the physical registers whose spill
587 /// weight is the lowest among all the registers whose live intervals
588 /// conflict with the interval.
589 void RALinScan::findIntervalsToSpill(LiveInterval *cur,
590                             std::vector<std::pair<unsigned,float> > &Candidates,
591                             unsigned NumCands,
592                             SmallVector<LiveInterval*, 8> &SpillIntervals) {
593   // We have figured out the *best* register to spill. But there are other
594   // registers that are pretty good as well (spill weight within 3%). Spill
595   // the one that has fewest defs and uses that conflict with cur.
596   float Conflicts[3] = { 0.0f, 0.0f, 0.0f };
597   SmallVector<LiveInterval*, 8> SLIs[3];
598
599   DOUT << "\tConsidering " << NumCands << " candidates: ";
600   DEBUG(for (unsigned i = 0; i != NumCands; ++i)
601           DOUT << tri_->getName(Candidates[i].first) << " ";
602         DOUT << "\n";);
603   
604   // Calculate the number of conflicts of each candidate.
605   for (IntervalPtrs::iterator i = active_.begin(); i != active_.end(); ++i) {
606     unsigned Reg = i->first->reg;
607     unsigned PhysReg = vrm_->getPhys(Reg);
608     if (!cur->overlapsFrom(*i->first, i->second))
609       continue;
610     for (unsigned j = 0; j < NumCands; ++j) {
611       unsigned Candidate = Candidates[j].first;
612       if (tri_->regsOverlap(PhysReg, Candidate)) {
613         if (NumCands > 1)
614           Conflicts[j] += getConflictWeight(cur, Reg, li_, mri_, loopInfo);
615         SLIs[j].push_back(i->first);
616       }
617     }
618   }
619
620   for (IntervalPtrs::iterator i = inactive_.begin(); i != inactive_.end(); ++i){
621     unsigned Reg = i->first->reg;
622     unsigned PhysReg = vrm_->getPhys(Reg);
623     if (!cur->overlapsFrom(*i->first, i->second-1))
624       continue;
625     for (unsigned j = 0; j < NumCands; ++j) {
626       unsigned Candidate = Candidates[j].first;
627       if (tri_->regsOverlap(PhysReg, Candidate)) {
628         if (NumCands > 1)
629           Conflicts[j] += getConflictWeight(cur, Reg, li_, mri_, loopInfo);
630         SLIs[j].push_back(i->first);
631       }
632     }
633   }
634
635   // Which is the best candidate?
636   unsigned BestCandidate = 0;
637   float MinConflicts = Conflicts[0];
638   for (unsigned i = 1; i != NumCands; ++i) {
639     if (Conflicts[i] < MinConflicts) {
640       BestCandidate = i;
641       MinConflicts = Conflicts[i];
642     }
643   }
644
645   std::copy(SLIs[BestCandidate].begin(), SLIs[BestCandidate].end(),
646             std::back_inserter(SpillIntervals));
647 }
648
649 namespace {
650   struct WeightCompare {
651     typedef std::pair<unsigned, float> RegWeightPair;
652     bool operator()(const RegWeightPair &LHS, const RegWeightPair &RHS) const {
653       return LHS.second < RHS.second;
654     }
655   };
656 }
657
658 static bool weightsAreClose(float w1, float w2) {
659   if (!NewHeuristic)
660     return false;
661
662   float diff = w1 - w2;
663   if (diff <= 0.02f)  // Within 0.02f
664     return true;
665   return (diff / w2) <= 0.05f;  // Within 5%.
666 }
667
668 /// assignRegOrStackSlotAtInterval - assign a register if one is available, or
669 /// spill.
670 void RALinScan::assignRegOrStackSlotAtInterval(LiveInterval* cur)
671 {
672   DOUT << "\tallocating current interval: ";
673
674   // This is an implicitly defined live interval, just assign any register.
675   const TargetRegisterClass *RC = mri_->getRegClass(cur->reg);
676   if (cur->empty()) {
677     unsigned physReg = cur->preference;
678     if (!physReg)
679       physReg = *RC->allocation_order_begin(*mf_);
680     DOUT <<  tri_->getName(physReg) << '\n';
681     // Note the register is not really in use.
682     vrm_->assignVirt2Phys(cur->reg, physReg);
683     return;
684   }
685
686   PhysRegTracker backupPrt = *prt_;
687
688   std::vector<std::pair<unsigned, float> > SpillWeightsToAdd;
689   unsigned StartPosition = cur->beginNumber();
690   const TargetRegisterClass *RCLeader = RelatedRegClasses.getLeaderValue(RC);
691
692   // If start of this live interval is defined by a move instruction and its
693   // source is assigned a physical register that is compatible with the target
694   // register class, then we should try to assign it the same register.
695   // This can happen when the move is from a larger register class to a smaller
696   // one, e.g. X86::mov32to32_. These move instructions are not coalescable.
697   if (!cur->preference && cur->hasAtLeastOneValue()) {
698     VNInfo *vni = cur->begin()->valno;
699     if (vni->def && vni->def != ~1U && vni->def != ~0U) {
700       MachineInstr *CopyMI = li_->getInstructionFromIndex(vni->def);
701       unsigned SrcReg, DstReg, SrcSubReg, DstSubReg;
702       if (CopyMI &&
703           tii_->isMoveInstr(*CopyMI, SrcReg, DstReg, SrcSubReg, DstSubReg)) {
704         unsigned Reg = 0;
705         if (TargetRegisterInfo::isPhysicalRegister(SrcReg))
706           Reg = SrcReg;
707         else if (vrm_->isAssignedReg(SrcReg))
708           Reg = vrm_->getPhys(SrcReg);
709         if (Reg && allocatableRegs_[Reg] && RC->contains(Reg))
710           cur->preference = Reg;
711       }
712     }
713   }
714
715   // for every interval in inactive we overlap with, mark the
716   // register as not free and update spill weights.
717   for (IntervalPtrs::const_iterator i = inactive_.begin(),
718          e = inactive_.end(); i != e; ++i) {
719     unsigned Reg = i->first->reg;
720     assert(TargetRegisterInfo::isVirtualRegister(Reg) &&
721            "Can only allocate virtual registers!");
722     const TargetRegisterClass *RegRC = mri_->getRegClass(Reg);
723     // If this is not in a related reg class to the register we're allocating, 
724     // don't check it.
725     if (RelatedRegClasses.getLeaderValue(RegRC) == RCLeader &&
726         cur->overlapsFrom(*i->first, i->second-1)) {
727       Reg = vrm_->getPhys(Reg);
728       prt_->addRegUse(Reg);
729       SpillWeightsToAdd.push_back(std::make_pair(Reg, i->first->weight));
730     }
731   }
732   
733   // Speculatively check to see if we can get a register right now.  If not,
734   // we know we won't be able to by adding more constraints.  If so, we can
735   // check to see if it is valid.  Doing an exhaustive search of the fixed_ list
736   // is very bad (it contains all callee clobbered registers for any functions
737   // with a call), so we want to avoid doing that if possible.
738   unsigned physReg = getFreePhysReg(cur);
739   unsigned BestPhysReg = physReg;
740   if (physReg) {
741     // We got a register.  However, if it's in the fixed_ list, we might
742     // conflict with it.  Check to see if we conflict with it or any of its
743     // aliases.
744     SmallSet<unsigned, 8> RegAliases;
745     for (const unsigned *AS = tri_->getAliasSet(physReg); *AS; ++AS)
746       RegAliases.insert(*AS);
747     
748     bool ConflictsWithFixed = false;
749     for (unsigned i = 0, e = fixed_.size(); i != e; ++i) {
750       IntervalPtr &IP = fixed_[i];
751       if (physReg == IP.first->reg || RegAliases.count(IP.first->reg)) {
752         // Okay, this reg is on the fixed list.  Check to see if we actually
753         // conflict.
754         LiveInterval *I = IP.first;
755         if (I->endNumber() > StartPosition) {
756           LiveInterval::iterator II = I->advanceTo(IP.second, StartPosition);
757           IP.second = II;
758           if (II != I->begin() && II->start > StartPosition)
759             --II;
760           if (cur->overlapsFrom(*I, II)) {
761             ConflictsWithFixed = true;
762             break;
763           }
764         }
765       }
766     }
767     
768     // Okay, the register picked by our speculative getFreePhysReg call turned
769     // out to be in use.  Actually add all of the conflicting fixed registers to
770     // prt so we can do an accurate query.
771     if (ConflictsWithFixed) {
772       // For every interval in fixed we overlap with, mark the register as not
773       // free and update spill weights.
774       for (unsigned i = 0, e = fixed_.size(); i != e; ++i) {
775         IntervalPtr &IP = fixed_[i];
776         LiveInterval *I = IP.first;
777
778         const TargetRegisterClass *RegRC = OneClassForEachPhysReg[I->reg];
779         if (RelatedRegClasses.getLeaderValue(RegRC) == RCLeader &&       
780             I->endNumber() > StartPosition) {
781           LiveInterval::iterator II = I->advanceTo(IP.second, StartPosition);
782           IP.second = II;
783           if (II != I->begin() && II->start > StartPosition)
784             --II;
785           if (cur->overlapsFrom(*I, II)) {
786             unsigned reg = I->reg;
787             prt_->addRegUse(reg);
788             SpillWeightsToAdd.push_back(std::make_pair(reg, I->weight));
789           }
790         }
791       }
792
793       // Using the newly updated prt_ object, which includes conflicts in the
794       // future, see if there are any registers available.
795       physReg = getFreePhysReg(cur);
796     }
797   }
798     
799   // Restore the physical register tracker, removing information about the
800   // future.
801   *prt_ = backupPrt;
802   
803   // if we find a free register, we are done: assign this virtual to
804   // the free physical register and add this interval to the active
805   // list.
806   if (physReg) {
807     DOUT <<  tri_->getName(physReg) << '\n';
808     vrm_->assignVirt2Phys(cur->reg, physReg);
809     prt_->addRegUse(physReg);
810     active_.push_back(std::make_pair(cur, cur->begin()));
811     handled_.push_back(cur);
812     return;
813   }
814   DOUT << "no free registers\n";
815
816   // Compile the spill weights into an array that is better for scanning.
817   std::vector<float> SpillWeights(tri_->getNumRegs(), 0.0f);
818   for (std::vector<std::pair<unsigned, float> >::iterator
819        I = SpillWeightsToAdd.begin(), E = SpillWeightsToAdd.end(); I != E; ++I)
820     updateSpillWeights(SpillWeights, I->first, I->second, tri_);
821   
822   // for each interval in active, update spill weights.
823   for (IntervalPtrs::const_iterator i = active_.begin(), e = active_.end();
824        i != e; ++i) {
825     unsigned reg = i->first->reg;
826     assert(TargetRegisterInfo::isVirtualRegister(reg) &&
827            "Can only allocate virtual registers!");
828     reg = vrm_->getPhys(reg);
829     updateSpillWeights(SpillWeights, reg, i->first->weight, tri_);
830   }
831  
832   DOUT << "\tassigning stack slot at interval "<< *cur << ":\n";
833
834   // Find a register to spill.
835   float minWeight = HUGE_VALF;
836   unsigned minReg = 0; /*cur->preference*/;  // Try the preferred register first.
837
838   bool Found = false;
839   std::vector<std::pair<unsigned,float> > RegsWeights;
840   if (!minReg || SpillWeights[minReg] == HUGE_VALF)
841     for (TargetRegisterClass::iterator i = RC->allocation_order_begin(*mf_),
842            e = RC->allocation_order_end(*mf_); i != e; ++i) {
843       unsigned reg = *i;
844       float regWeight = SpillWeights[reg];
845       if (minWeight > regWeight)
846         Found = true;
847       RegsWeights.push_back(std::make_pair(reg, regWeight));
848     }
849   
850   // If we didn't find a register that is spillable, try aliases?
851   if (!Found) {
852     for (TargetRegisterClass::iterator i = RC->allocation_order_begin(*mf_),
853            e = RC->allocation_order_end(*mf_); i != e; ++i) {
854       unsigned reg = *i;
855       // No need to worry about if the alias register size < regsize of RC.
856       // We are going to spill all registers that alias it anyway.
857       for (const unsigned* as = tri_->getAliasSet(reg); *as; ++as)
858         RegsWeights.push_back(std::make_pair(*as, SpillWeights[*as]));
859     }
860   }
861
862   // Sort all potential spill candidates by weight.
863   std::sort(RegsWeights.begin(), RegsWeights.end(), WeightCompare());
864   minReg = RegsWeights[0].first;
865   minWeight = RegsWeights[0].second;
866   if (minWeight == HUGE_VALF) {
867     // All registers must have inf weight. Just grab one!
868     minReg = BestPhysReg ? BestPhysReg : *RC->allocation_order_begin(*mf_);
869     if (cur->weight == HUGE_VALF ||
870         li_->getApproximateInstructionCount(*cur) == 0) {
871       // Spill a physical register around defs and uses.
872       if (li_->spillPhysRegAroundRegDefsUses(*cur, minReg, *vrm_))
873         assignRegOrStackSlotAtInterval(cur);
874       else {
875         cerr << "Ran out of registers during register allocation!\n";
876         exit(1);
877       }
878       return;
879     }
880   }
881
882   // Find up to 3 registers to consider as spill candidates.
883   unsigned LastCandidate = RegsWeights.size() >= 3 ? 3 : 1;
884   while (LastCandidate > 1) {
885     if (weightsAreClose(RegsWeights[LastCandidate-1].second, minWeight))
886       break;
887     --LastCandidate;
888   }
889
890   DOUT << "\t\tregister(s) with min weight(s): ";
891   DEBUG(for (unsigned i = 0; i != LastCandidate; ++i)
892           DOUT << tri_->getName(RegsWeights[i].first)
893                << " (" << RegsWeights[i].second << ")\n");
894
895   // if the current has the minimum weight, we need to spill it and
896   // add any added intervals back to unhandled, and restart
897   // linearscan.
898   if (cur->weight != HUGE_VALF && cur->weight <= minWeight) {
899     DOUT << "\t\t\tspilling(c): " << *cur << '\n';
900     float SSWeight;
901     SmallVector<LiveInterval*, 8> spillIs;
902     std::vector<LiveInterval*> added =
903       li_->addIntervalsForSpills(*cur, spillIs, loopInfo, *vrm_, SSWeight);
904     addStackInterval(cur, ls_, li_, SSWeight, *vrm_);
905     if (added.empty())
906       return;  // Early exit if all spills were folded.
907
908     // Merge added with unhandled.  Note that we know that
909     // addIntervalsForSpills returns intervals sorted by their starting
910     // point.
911     for (unsigned i = 0, e = added.size(); i != e; ++i)
912       unhandled_.push(added[i]);
913     return;
914   }
915
916   ++NumBacktracks;
917
918   // push the current interval back to unhandled since we are going
919   // to re-run at least this iteration. Since we didn't modify it it
920   // should go back right in the front of the list
921   unhandled_.push(cur);
922
923   assert(TargetRegisterInfo::isPhysicalRegister(minReg) &&
924          "did not choose a register to spill?");
925
926   // We spill all intervals aliasing the register with
927   // minimum weight, rollback to the interval with the earliest
928   // start point and let the linear scan algorithm run again
929   SmallVector<LiveInterval*, 8> spillIs;
930
931   // Determine which intervals have to be spilled.
932   findIntervalsToSpill(cur, RegsWeights, LastCandidate, spillIs);
933
934   // Set of spilled vregs (used later to rollback properly)
935   SmallSet<unsigned, 8> spilled;
936
937   // The earliest start of a Spilled interval indicates up to where
938   // in handled we need to roll back
939   unsigned earliestStart = cur->beginNumber();
940
941   // Spill live intervals of virtual regs mapped to the physical register we
942   // want to clear (and its aliases).  We only spill those that overlap with the
943   // current interval as the rest do not affect its allocation. we also keep
944   // track of the earliest start of all spilled live intervals since this will
945   // mark our rollback point.
946   std::vector<LiveInterval*> added;
947   while (!spillIs.empty()) {
948     LiveInterval *sli = spillIs.back();
949     spillIs.pop_back();
950     DOUT << "\t\t\tspilling(a): " << *sli << '\n';
951     earliestStart = std::min(earliestStart, sli->beginNumber());
952     float SSWeight;
953     std::vector<LiveInterval*> newIs =
954       li_->addIntervalsForSpills(*sli, spillIs, loopInfo, *vrm_, SSWeight);
955     addStackInterval(sli, ls_, li_, SSWeight, *vrm_);
956     std::copy(newIs.begin(), newIs.end(), std::back_inserter(added));
957     spilled.insert(sli->reg);
958   }
959
960   DOUT << "\t\trolling back to: " << earliestStart << '\n';
961
962   // Scan handled in reverse order up to the earliest start of a
963   // spilled live interval and undo each one, restoring the state of
964   // unhandled.
965   while (!handled_.empty()) {
966     LiveInterval* i = handled_.back();
967     // If this interval starts before t we are done.
968     if (i->beginNumber() < earliestStart)
969       break;
970     DOUT << "\t\t\tundo changes for: " << *i << '\n';
971     handled_.pop_back();
972
973     // When undoing a live interval allocation we must know if it is active or
974     // inactive to properly update the PhysRegTracker and the VirtRegMap.
975     IntervalPtrs::iterator it;
976     if ((it = FindIntervalInVector(active_, i)) != active_.end()) {
977       active_.erase(it);
978       assert(!TargetRegisterInfo::isPhysicalRegister(i->reg));
979       if (!spilled.count(i->reg))
980         unhandled_.push(i);
981       prt_->delRegUse(vrm_->getPhys(i->reg));
982       vrm_->clearVirt(i->reg);
983     } else if ((it = FindIntervalInVector(inactive_, i)) != inactive_.end()) {
984       inactive_.erase(it);
985       assert(!TargetRegisterInfo::isPhysicalRegister(i->reg));
986       if (!spilled.count(i->reg))
987         unhandled_.push(i);
988       vrm_->clearVirt(i->reg);
989     } else {
990       assert(TargetRegisterInfo::isVirtualRegister(i->reg) &&
991              "Can only allocate virtual registers!");
992       vrm_->clearVirt(i->reg);
993       unhandled_.push(i);
994     }
995
996     // It interval has a preference, it must be defined by a copy. Clear the
997     // preference now since the source interval allocation may have been undone
998     // as well.
999     i->preference = 0;
1000   }
1001
1002   // Rewind the iterators in the active, inactive, and fixed lists back to the
1003   // point we reverted to.
1004   RevertVectorIteratorsTo(active_, earliestStart);
1005   RevertVectorIteratorsTo(inactive_, earliestStart);
1006   RevertVectorIteratorsTo(fixed_, earliestStart);
1007
1008   // scan the rest and undo each interval that expired after t and
1009   // insert it in active (the next iteration of the algorithm will
1010   // put it in inactive if required)
1011   for (unsigned i = 0, e = handled_.size(); i != e; ++i) {
1012     LiveInterval *HI = handled_[i];
1013     if (!HI->expiredAt(earliestStart) &&
1014         HI->expiredAt(cur->beginNumber())) {
1015       DOUT << "\t\t\tundo changes for: " << *HI << '\n';
1016       active_.push_back(std::make_pair(HI, HI->begin()));
1017       assert(!TargetRegisterInfo::isPhysicalRegister(HI->reg));
1018       prt_->addRegUse(vrm_->getPhys(HI->reg));
1019     }
1020   }
1021
1022   // merge added with unhandled
1023   for (unsigned i = 0, e = added.size(); i != e; ++i)
1024     unhandled_.push(added[i]);
1025 }
1026
1027 /// getFreePhysReg - return a free physical register for this virtual register
1028 /// interval if we have one, otherwise return 0.
1029 unsigned RALinScan::getFreePhysReg(LiveInterval *cur) {
1030   SmallVector<unsigned, 256> inactiveCounts;
1031   unsigned MaxInactiveCount = 0;
1032   
1033   const TargetRegisterClass *RC = mri_->getRegClass(cur->reg);
1034   const TargetRegisterClass *RCLeader = RelatedRegClasses.getLeaderValue(RC);
1035  
1036   for (IntervalPtrs::iterator i = inactive_.begin(), e = inactive_.end();
1037        i != e; ++i) {
1038     unsigned reg = i->first->reg;
1039     assert(TargetRegisterInfo::isVirtualRegister(reg) &&
1040            "Can only allocate virtual registers!");
1041
1042     // If this is not in a related reg class to the register we're allocating, 
1043     // don't check it.
1044     const TargetRegisterClass *RegRC = mri_->getRegClass(reg);
1045     if (RelatedRegClasses.getLeaderValue(RegRC) == RCLeader) {
1046       reg = vrm_->getPhys(reg);
1047       if (inactiveCounts.size() <= reg)
1048         inactiveCounts.resize(reg+1);
1049       ++inactiveCounts[reg];
1050       MaxInactiveCount = std::max(MaxInactiveCount, inactiveCounts[reg]);
1051     }
1052   }
1053
1054   unsigned FreeReg = 0;
1055   unsigned FreeRegInactiveCount = 0;
1056
1057   // If copy coalescer has assigned a "preferred" register, check if it's
1058   // available first.
1059   if (cur->preference) {
1060     if (prt_->isRegAvail(cur->preference) && 
1061         RC->contains(cur->preference)) {
1062       DOUT << "\t\tassigned the preferred register: "
1063            << tri_->getName(cur->preference) << "\n";
1064       return cur->preference;
1065     } else
1066       DOUT << "\t\tunable to assign the preferred register: "
1067            << tri_->getName(cur->preference) << "\n";
1068   }
1069
1070   // Scan for the first available register.
1071   TargetRegisterClass::iterator I = RC->allocation_order_begin(*mf_);
1072   TargetRegisterClass::iterator E = RC->allocation_order_end(*mf_);
1073   assert(I != E && "No allocatable register in this register class!");
1074   for (; I != E; ++I)
1075     if (prt_->isRegAvail(*I)) {
1076       FreeReg = *I;
1077       if (FreeReg < inactiveCounts.size())
1078         FreeRegInactiveCount = inactiveCounts[FreeReg];
1079       else
1080         FreeRegInactiveCount = 0;
1081       break;
1082     }
1083
1084   // If there are no free regs, or if this reg has the max inactive count,
1085   // return this register.
1086   if (FreeReg == 0 || FreeRegInactiveCount == MaxInactiveCount) return FreeReg;
1087   
1088   // Continue scanning the registers, looking for the one with the highest
1089   // inactive count.  Alkis found that this reduced register pressure very
1090   // slightly on X86 (in rev 1.94 of this file), though this should probably be
1091   // reevaluated now.
1092   for (; I != E; ++I) {
1093     unsigned Reg = *I;
1094     if (prt_->isRegAvail(Reg) && Reg < inactiveCounts.size() &&
1095         FreeRegInactiveCount < inactiveCounts[Reg]) {
1096       FreeReg = Reg;
1097       FreeRegInactiveCount = inactiveCounts[Reg];
1098       if (FreeRegInactiveCount == MaxInactiveCount)
1099         break;    // We found the one with the max inactive count.
1100     }
1101   }
1102   
1103   return FreeReg;
1104 }
1105
1106 FunctionPass* llvm::createLinearScanRegisterAllocator() {
1107   return new RALinScan();
1108 }