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 "VirtRegMap.h"
  16 #include "VirtRegRewriter.h"
  17 #include "Spiller.h"
  18 #include "llvm/Function.h"
  19 #include "llvm/CodeGen/CalcSpillWeights.h"
  20 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  21 #include "llvm/CodeGen/LiveStackAnalysis.h"
  22 #include "llvm/CodeGen/MachineFunctionPass.h"
  23 #include "llvm/CodeGen/MachineInstr.h"
  24 #include "llvm/CodeGen/MachineLoopInfo.h"
  25 #include "llvm/CodeGen/MachineRegisterInfo.h"
  26 #include "llvm/CodeGen/Passes.h"
  27 #include "llvm/CodeGen/RegAllocRegistry.h"
  28 #include "llvm/CodeGen/RegisterCoalescer.h"
  29 #include "llvm/Target/TargetRegisterInfo.h"
  30 #include "llvm/Target/TargetMachine.h"
  31 #include "llvm/Target/TargetOptions.h"
  32 #include "llvm/Target/TargetInstrInfo.h"
  33 #include "llvm/ADT/EquivalenceClasses.h"
  34 #include "llvm/ADT/SmallSet.h"
  35 #include "llvm/ADT/Statistic.h"
  36 #include "llvm/ADT/STLExtras.h"
  37 #include "llvm/Support/Debug.h"
  38 #include "llvm/Support/ErrorHandling.h"
  39 #include "llvm/Support/raw_ostream.h"
  40 #include <algorithm>
  41 #include <set>
  42 #include <queue>
  43 #include <memory>
  44 #include <cmath>
  45
  46 using namespace llvm;
  47
  48 STATISTIC(NumIters     , "Number of iterations performed");
  49 STATISTIC(NumBacktracks, "Number of times we had to backtrack");
  50 STATISTIC(NumCoalesce,   "Number of copies coalesced");
  51 STATISTIC(NumDowngrade,  "Number of registers downgraded");
  52
  53 static cl::opt<bool>
  54 NewHeuristic("new-spilling-heuristic",
  55              cl::desc("Use new spilling heuristic"),
  56              cl::init(false), cl::Hidden);
  57
  58 static cl::opt<bool>
  59 PreSplitIntervals("pre-alloc-split",
  60                   cl::desc("Pre-register allocation live interval splitting"),
  61                   cl::init(false), cl::Hidden);
  62
  63 static cl::opt<bool>
  64 TrivCoalesceEnds("trivial-coalesce-ends",
  65                   cl::desc("Attempt trivial coalescing of interval ends"),
  66                   cl::init(false), cl::Hidden);
  67
  68 static RegisterRegAlloc
  69 linearscanRegAlloc("linearscan", "linear scan register allocator",
  70                    createLinearScanRegisterAllocator);
  71
  72 namespace {
  73   // When we allocate a register, add it to a fixed-size queue of
  74   // registers to skip in subsequent allocations. This trades a small
  75   // amount of register pressure and increased spills for flexibility in
  76   // the post-pass scheduler.
  77   //
  78   // Note that in a the number of registers used for reloading spills
  79   // will be one greater than the value of this option.
  80   //
  81   // One big limitation of this is that it doesn't differentiate between
  82   // different register classes. So on x86-64, if there is xmm register
  83   // pressure, it can caused fewer GPRs to be held in the queue.
  84   static cl::opt<unsigned>
  85   NumRecentlyUsedRegs("linearscan-skip-count",
  86                       cl::desc("Number of registers for linearscan to remember"
  87                                "to skip."),
  88                       cl::init(0),
  89                       cl::Hidden);
  90
  91   struct RALinScan : public MachineFunctionPass {
  92     static char ID;
  93     RALinScan() : MachineFunctionPass(ID) {
  94       // Initialize the queue to record recently-used registers.
  95       if (NumRecentlyUsedRegs > 0)
  96         RecentRegs.resize(NumRecentlyUsedRegs, 0);
  97       RecentNext = RecentRegs.begin();
  98     }
  99
 100     typedef std::pair<LiveInterval*, LiveInterval::iterator> IntervalPtr;
 101     typedef SmallVector<IntervalPtr, 32> IntervalPtrs;
 102   private:
 103     /// RelatedRegClasses - This structure is built the first time a function is
 104     /// compiled, and keeps track of which register classes have registers that
 105     /// belong to multiple classes or have aliases that are in other classes.
 106     EquivalenceClasses<const TargetRegisterClass*> RelatedRegClasses;
 107     DenseMap<unsigned, const TargetRegisterClass*> OneClassForEachPhysReg;
 108
 109     // NextReloadMap - For each register in the map, it maps to the another
 110     // register which is defined by a reload from the same stack slot and
 111     // both reloads are in the same basic block.
 112     DenseMap<unsigned, unsigned> NextReloadMap;
 113
 114     // DowngradedRegs - A set of registers which are being "downgraded", i.e.
 115     // un-favored for allocation.
 116     SmallSet<unsigned, 8> DowngradedRegs;
 117
 118     // DowngradeMap - A map from virtual registers to physical registers being
 119     // downgraded for the virtual registers.
 120     DenseMap<unsigned, unsigned> DowngradeMap;
 121
 122     MachineFunction* mf_;
 123     MachineRegisterInfo* mri_;
 124     const TargetMachine* tm_;
 125     const TargetRegisterInfo* tri_;
 126     const TargetInstrInfo* tii_;
 127     BitVector allocatableRegs_;
 128     BitVector reservedRegs_;
 129     LiveIntervals* li_;
 130     LiveStacks* ls_;
 131     MachineLoopInfo *loopInfo;
 132
 133     /// handled_ - Intervals are added to the handled_ set in the order of their
 134     /// start value.  This is uses for backtracking.
 135     std::vector<LiveInterval*> handled_;
 136
 137     /// fixed_ - Intervals that correspond to machine registers.
 138     ///
 139     IntervalPtrs fixed_;
 140
 141     /// active_ - Intervals that are currently being processed, and which have a
 142     /// live range active for the current point.
 143     IntervalPtrs active_;
 144
 145     /// inactive_ - Intervals that are currently being processed, but which have
 146     /// a hold at the current point.
 147     IntervalPtrs inactive_;
 148
 149     typedef std::priority_queue<LiveInterval*,
 150                                 SmallVector<LiveInterval*, 64>,
 151                                 greater_ptr<LiveInterval> > IntervalHeap;
 152     IntervalHeap unhandled_;
 153
 154     /// regUse_ - Tracks register usage.
 155     SmallVector<unsigned, 32> regUse_;
 156     SmallVector<unsigned, 32> regUseBackUp_;
 157
 158     /// vrm_ - Tracks register assignments.
 159     VirtRegMap* vrm_;
 160
 161     std::auto_ptr<VirtRegRewriter> rewriter_;
 162
 163     std::auto_ptr<Spiller> spiller_;
 164
 165     // The queue of recently-used registers.
 166     SmallVector<unsigned, 4> RecentRegs;
 167     SmallVector<unsigned, 4>::iterator RecentNext;
 168
 169     // Record that we just picked this register.
 170     void recordRecentlyUsed(unsigned reg) {
 171       assert(reg != 0 && "Recently used register is NOREG!");
 172       if (!RecentRegs.empty()) {
 173         *RecentNext++ = reg;
 174         if (RecentNext == RecentRegs.end())
 175           RecentNext = RecentRegs.begin();
 176       }
 177     }
 178
 179   public:
 180     virtual const char* getPassName() const {
 181       return "Linear Scan Register Allocator";
 182     }
 183
 184     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 185       AU.setPreservesCFG();
 186       AU.addRequired<LiveIntervals>();
 187       AU.addPreserved<SlotIndexes>();
 188       if (StrongPHIElim)
 189         AU.addRequiredID(StrongPHIEliminationID);
 190       // Make sure PassManager knows which analyses to make available
 191       // to coalescing and which analyses coalescing invalidates.
 192       AU.addRequiredTransitive<RegisterCoalescer>();
 193       AU.addRequired<CalculateSpillWeights>();
 194       if (PreSplitIntervals)
 195         AU.addRequiredID(PreAllocSplittingID);
 196       AU.addRequired<LiveStacks>();
 197       AU.addPreserved<LiveStacks>();
 198       AU.addRequired<MachineLoopInfo>();
 199       AU.addPreserved<MachineLoopInfo>();
 200       AU.addRequired<VirtRegMap>();
 201       AU.addPreserved<VirtRegMap>();
 202       AU.addPreservedID(MachineDominatorsID);
 203       MachineFunctionPass::getAnalysisUsage(AU);
 204     }
 205
 206     /// runOnMachineFunction - register allocate the whole function
 207     bool runOnMachineFunction(MachineFunction&);
 208
 209     // Determine if we skip this register due to its being recently used.
 210     bool isRecentlyUsed(unsigned reg) const {
 211       return std::find(RecentRegs.begin(), RecentRegs.end(), reg) !=
 212              RecentRegs.end();
 213     }
 214
 215   private:
 216     /// linearScan - the linear scan algorithm
 217     void linearScan();
 218
 219     /// initIntervalSets - initialize the interval sets.
 220     ///
 221     void initIntervalSets();
 222
 223     /// processActiveIntervals - expire old intervals and move non-overlapping
 224     /// ones to the inactive list.
 225     void processActiveIntervals(SlotIndex CurPoint);
 226
 227     /// processInactiveIntervals - expire old intervals and move overlapping
 228     /// ones to the active list.
 229     void processInactiveIntervals(SlotIndex CurPoint);
 230
 231     /// hasNextReloadInterval - Return the next liveinterval that's being
 232     /// defined by a reload from the same SS as the specified one.
 233     LiveInterval *hasNextReloadInterval(LiveInterval *cur);
 234
 235     /// DowngradeRegister - Downgrade a register for allocation.
 236     void DowngradeRegister(LiveInterval *li, unsigned Reg);
 237
 238     /// UpgradeRegister - Upgrade a register for allocation.
 239     void UpgradeRegister(unsigned Reg);
 240
 241     /// assignRegOrStackSlotAtInterval - assign a register if one
 242     /// is available, or spill.
 243     void assignRegOrStackSlotAtInterval(LiveInterval* cur);
 244
 245     void updateSpillWeights(std::vector<float> &Weights,
 246                             unsigned reg, float weight,
 247                             const TargetRegisterClass *RC);
 248
 249     /// findIntervalsToSpill - Determine the intervals to spill for the
 250     /// specified interval. It's passed the physical registers whose spill
 251     /// weight is the lowest among all the registers whose live intervals
 252     /// conflict with the interval.
 253     void findIntervalsToSpill(LiveInterval *cur,
 254                             std::vector<std::pair<unsigned,float> > &Candidates,
 255                             unsigned NumCands,
 256                             SmallVector<LiveInterval*, 8> &SpillIntervals);
 257
 258     /// attemptTrivialCoalescing - If a simple interval is defined by a copy,
 259     /// try to allocate the definition to the same register as the source,
 260     /// if the register is not defined during the life time of the interval.
 261     /// This eliminates a copy, and is used to coalesce copies which were not
 262     /// coalesced away before allocation either due to dest and src being in
 263     /// different register classes or because the coalescer was overly
 264     /// conservative.
 265     unsigned attemptTrivialCoalescing(LiveInterval &cur, unsigned Reg);
 266
 267     ///
 268     /// Register usage / availability tracking helpers.
 269     ///
 270
 271     void initRegUses() {
 272       regUse_.resize(tri_->getNumRegs(), 0);
 273       regUseBackUp_.resize(tri_->getNumRegs(), 0);
 274     }
 275
 276     void finalizeRegUses() {
 277 #ifndef NDEBUG
 278       // Verify all the registers are "freed".
 279       bool Error = false;
 280       for (unsigned i = 0, e = tri_->getNumRegs(); i != e; ++i) {
 281         if (regUse_[i] != 0) {
 282           dbgs() << tri_->getName(i) << " is still in use!\n";
 283           Error = true;
 284         }
 285       }
 286       if (Error)
 287         llvm_unreachable(0);
 288 #endif
 289       regUse_.clear();
 290       regUseBackUp_.clear();
 291     }
 292
 293     void addRegUse(unsigned physReg) {
 294       assert(TargetRegisterInfo::isPhysicalRegister(physReg) &&
 295              "should be physical register!");
 296       ++regUse_[physReg];
 297       for (const unsigned* as = tri_->getAliasSet(physReg); *as; ++as)
 298         ++regUse_[*as];
 299     }
 300
 301     void delRegUse(unsigned physReg) {
 302       assert(TargetRegisterInfo::isPhysicalRegister(physReg) &&
 303              "should be physical register!");
 304       assert(regUse_[physReg] != 0);
 305       --regUse_[physReg];
 306       for (const unsigned* as = tri_->getAliasSet(physReg); *as; ++as) {
 307         assert(regUse_[*as] != 0);
 308         --regUse_[*as];
 309       }
 310     }
 311
 312     bool isRegAvail(unsigned physReg) const {
 313       assert(TargetRegisterInfo::isPhysicalRegister(physReg) &&
 314              "should be physical register!");
 315       return regUse_[physReg] == 0;
 316     }
 317
 318     void backUpRegUses() {
 319       regUseBackUp_ = regUse_;
 320     }
 321
 322     void restoreRegUses() {
 323       regUse_ = regUseBackUp_;
 324     }
 325
 326     ///
 327     /// Register handling helpers.
 328     ///
 329
 330     /// getFreePhysReg - return a free physical register for this virtual
 331     /// register interval if we have one, otherwise return 0.
 332     unsigned getFreePhysReg(LiveInterval* cur);
 333     unsigned getFreePhysReg(LiveInterval* cur,
 334                             const TargetRegisterClass *RC,
 335                             unsigned MaxInactiveCount,
 336                             SmallVector<unsigned, 256> &inactiveCounts,
 337                             bool SkipDGRegs);
 338
 339     /// getFirstNonReservedPhysReg - return the first non-reserved physical
 340     /// register in the register class.
 341     unsigned getFirstNonReservedPhysReg(const TargetRegisterClass *RC) {
 342         TargetRegisterClass::iterator aoe = RC->allocation_order_end(*mf_);
 343         TargetRegisterClass::iterator i = RC->allocation_order_begin(*mf_);
 344         while (i != aoe && reservedRegs_.test(*i))
 345           ++i;
 346         assert(i != aoe && "All registers reserved?!");
 347         return *i;
 348       }
 349
 350     void ComputeRelatedRegClasses();
 351
 352     template <typename ItTy>
 353     void printIntervals(const char* const str, ItTy i, ItTy e) const {
 354       DEBUG({
 355           if (str)
 356             dbgs() << str << " intervals:\n";
 357
 358           for (; i != e; ++i) {
 359             dbgs() << "\t" << *i->first << " -> ";
 360
 361             unsigned reg = i->first->reg;
 362             if (TargetRegisterInfo::isVirtualRegister(reg))
 363               reg = vrm_->getPhys(reg);
 364
 365             dbgs() << tri_->getName(reg) << '\n';
 366           }
 367         });
 368     }
 369   };
 370   char RALinScan::ID = 0;
 371 }
 372
 373 INITIALIZE_PASS(RALinScan, "linearscan-regalloc",
 374                 "Linear Scan Register Allocator", false, false);
 375
 376 void RALinScan::ComputeRelatedRegClasses() {
 377   // First pass, add all reg classes to the union, and determine at least one
 378   // reg class that each register is in.
 379   bool HasAliases = false;
 380   for (TargetRegisterInfo::regclass_iterator RCI = tri_->regclass_begin(),
 381        E = tri_->regclass_end(); RCI != E; ++RCI) {
 382     RelatedRegClasses.insert(*RCI);
 383     for (TargetRegisterClass::iterator I = (*RCI)->begin(), E = (*RCI)->end();
 384          I != E; ++I) {
 385       HasAliases = HasAliases || *tri_->getAliasSet(*I) != 0;
 386
 387       const TargetRegisterClass *&PRC = OneClassForEachPhysReg[*I];
 388       if (PRC) {
 389         // Already processed this register.  Just make sure we know that
 390         // multiple register classes share a register.
 391         RelatedRegClasses.unionSets(PRC, *RCI);
 392       } else {
 393         PRC = *RCI;
 394       }
 395     }
 396   }
 397
 398   // Second pass, now that we know conservatively what register classes each reg
 399   // belongs to, add info about aliases.  We don't need to do this for targets
 400   // without register aliases.
 401   if (HasAliases)
 402     for (DenseMap<unsigned, const TargetRegisterClass*>::iterator
 403          I = OneClassForEachPhysReg.begin(), E = OneClassForEachPhysReg.end();
 404          I != E; ++I)
 405       for (const unsigned *AS = tri_->getAliasSet(I->first); *AS; ++AS)
 406         RelatedRegClasses.unionSets(I->second, OneClassForEachPhysReg[*AS]);
 407 }
 408
 409 /// attemptTrivialCoalescing - If a simple interval is defined by a copy, try
 410 /// allocate the definition the same register as the source register if the
 411 /// register is not defined during live time of the interval. If the interval is
 412 /// killed by a copy, try to use the destination register. This eliminates a
 413 /// copy. This is used to coalesce copies which were not coalesced away before
 414 /// allocation either due to dest and src being in different register classes or
 415 /// because the coalescer was overly conservative.
 416 unsigned RALinScan::attemptTrivialCoalescing(LiveInterval &cur, unsigned Reg) {
 417   unsigned Preference = vrm_->getRegAllocPref(cur.reg);
 418   if ((Preference && Preference == Reg) || !cur.containsOneValue())
 419     return Reg;
 420
 421   // We cannot handle complicated live ranges. Simple linear stuff only.
 422   if (cur.ranges.size() != 1)
 423     return Reg;
 424
 425   const LiveRange &range = cur.ranges.front();
 426
 427   VNInfo *vni = range.valno;
 428   if (vni->isUnused())
 429     return Reg;
 430
 431   unsigned CandReg;
 432   {
 433     MachineInstr *CopyMI;
 434     if ((CopyMI = li_->getInstructionFromIndex(vni->def)) && CopyMI->isCopy())
 435       // Defined by a copy, try to extend SrcReg forward
 436       CandReg = CopyMI->getOperand(1).getReg();
 437     else if (TrivCoalesceEnds &&
 438             (CopyMI = li_->getInstructionFromIndex(range.end.getBaseIndex())) &&
 439              CopyMI->isCopy() && cur.reg == CopyMI->getOperand(1).getReg())
 440       // Only used by a copy, try to extend DstReg backwards
 441       CandReg = CopyMI->getOperand(0).getReg();
 442     else
 443       return Reg;
 444   }
 445
 446   if (TargetRegisterInfo::isVirtualRegister(CandReg)) {
 447     if (!vrm_->isAssignedReg(CandReg))
 448       return Reg;
 449     CandReg = vrm_->getPhys(CandReg);
 450   }
 451   if (Reg == CandReg)
 452     return Reg;
 453
 454   const TargetRegisterClass *RC = mri_->getRegClass(cur.reg);
 455   if (!RC->contains(CandReg))
 456     return Reg;
 457
 458   if (li_->conflictsWithPhysReg(cur, *vrm_, CandReg))
 459     return Reg;
 460
 461   // Try to coalesce.
 462   DEBUG(dbgs() << "Coalescing: " << cur << " -> " << tri_->getName(CandReg)
 463         << '\n');
 464   vrm_->clearVirt(cur.reg);
 465   vrm_->assignVirt2Phys(cur.reg, CandReg);
 466
 467   ++NumCoalesce;
 468   return CandReg;
 469 }
 470
 471 bool RALinScan::runOnMachineFunction(MachineFunction &fn) {
 472   mf_ = &fn;
 473   mri_ = &fn.getRegInfo();
 474   tm_ = &fn.getTarget();
 475   tri_ = tm_->getRegisterInfo();
 476   tii_ = tm_->getInstrInfo();
 477   allocatableRegs_ = tri_->getAllocatableSet(fn);
 478   reservedRegs_ = tri_->getReservedRegs(fn);
 479   li_ = &getAnalysis<LiveIntervals>();
 480   ls_ = &getAnalysis<LiveStacks>();
 481   loopInfo = &getAnalysis<MachineLoopInfo>();
 482
 483   // We don't run the coalescer here because we have no reason to
 484   // interact with it.  If the coalescer requires interaction, it
 485   // won't do anything.  If it doesn't require interaction, we assume
 486   // it was run as a separate pass.
 487
 488   // If this is the first function compiled, compute the related reg classes.
 489   if (RelatedRegClasses.empty())
 490     ComputeRelatedRegClasses();
 491
 492   // Also resize register usage trackers.
 493   initRegUses();
 494
 495   vrm_ = &getAnalysis<VirtRegMap>();
 496   if (!rewriter_.get()) rewriter_.reset(createVirtRegRewriter());
 497
 498   spiller_.reset(createSpiller(*this, *mf_, *vrm_));
 499
 500   initIntervalSets();
 501
 502   linearScan();
 503
 504   // Rewrite spill code and update the PhysRegsUsed set.
 505   rewriter_->runOnMachineFunction(*mf_, *vrm_, li_);
 506
 507   assert(unhandled_.empty() && "Unhandled live intervals remain!");
 508
 509   finalizeRegUses();
 510
 511   fixed_.clear();
 512   active_.clear();
 513   inactive_.clear();
 514   handled_.clear();
 515   NextReloadMap.clear();
 516   DowngradedRegs.clear();
 517   DowngradeMap.clear();
 518   spiller_.reset(0);
 519
 520   return true;
 521 }
 522
 523 /// initIntervalSets - initialize the interval sets.
 524 ///
 525 void RALinScan::initIntervalSets()
 526 {
 527   assert(unhandled_.empty() && fixed_.empty() &&
 528          active_.empty() && inactive_.empty() &&
 529          "interval sets should be empty on initialization");
 530
 531   handled_.reserve(li_->getNumIntervals());
 532
 533   for (LiveIntervals::iterator i = li_->begin(), e = li_->end(); i != e; ++i) {
 534     if (TargetRegisterInfo::isPhysicalRegister(i->second->reg)) {
 535       if (!i->second->empty()) {
 536         mri_->setPhysRegUsed(i->second->reg);
 537         fixed_.push_back(std::make_pair(i->second, i->second->begin()));
 538       }
 539     } else {
 540       if (i->second->empty()) {
 541         assignRegOrStackSlotAtInterval(i->second);
 542       }
 543       else
 544         unhandled_.push(i->second);
 545     }
 546   }
 547 }
 548
 549 void RALinScan::linearScan() {
 550   // linear scan algorithm
 551   DEBUG({
 552       dbgs() << "********** LINEAR SCAN **********\n"
 553              << "********** Function: "
 554              << mf_->getFunction()->getName() << '\n';
 555       printIntervals("fixed", fixed_.begin(), fixed_.end());
 556     });
 557
 558   while (!unhandled_.empty()) {
 559     // pick the interval with the earliest start point
 560     LiveInterval* cur = unhandled_.top();
 561     unhandled_.pop();
 562     ++NumIters;
 563     DEBUG(dbgs() << "\n*** CURRENT ***: " << *cur << '\n');
 564
 565     assert(!cur->empty() && "Empty interval in unhandled set.");
 566
 567     processActiveIntervals(cur->beginIndex());
 568     processInactiveIntervals(cur->beginIndex());
 569
 570     assert(TargetRegisterInfo::isVirtualRegister(cur->reg) &&
 571            "Can only allocate virtual registers!");
 572
 573     // Allocating a virtual register. try to find a free
 574     // physical register or spill an interval (possibly this one) in order to
 575     // assign it one.
 576     assignRegOrStackSlotAtInterval(cur);
 577
 578     DEBUG({
 579         printIntervals("active", active_.begin(), active_.end());
 580         printIntervals("inactive", inactive_.begin(), inactive_.end());
 581       });
 582   }
 583
 584   // Expire any remaining active intervals
 585   while (!active_.empty()) {
 586     IntervalPtr &IP = active_.back();
 587     unsigned reg = IP.first->reg;
 588     DEBUG(dbgs() << "\tinterval " << *IP.first << " expired\n");
 589     assert(TargetRegisterInfo::isVirtualRegister(reg) &&
 590            "Can only allocate virtual registers!");
 591     reg = vrm_->getPhys(reg);
 592     delRegUse(reg);
 593     active_.pop_back();
 594   }
 595
 596   // Expire any remaining inactive intervals
 597   DEBUG({
 598       for (IntervalPtrs::reverse_iterator
 599              i = inactive_.rbegin(); i != inactive_.rend(); ++i)
 600         dbgs() << "\tinterval " << *i->first << " expired\n";
 601     });
 602   inactive_.clear();
 603
 604   // Add live-ins to every BB except for entry. Also perform trivial coalescing.
 605   MachineFunction::iterator EntryMBB = mf_->begin();
 606   SmallVector<MachineBasicBlock*, 8> LiveInMBBs;
 607   for (LiveIntervals::iterator i = li_->begin(), e = li_->end(); i != e; ++i) {
 608     LiveInterval &cur = *i->second;
 609     unsigned Reg = 0;
 610     bool isPhys = TargetRegisterInfo::isPhysicalRegister(cur.reg);
 611     if (isPhys)
 612       Reg = cur.reg;
 613     else if (vrm_->isAssignedReg(cur.reg))
 614       Reg = attemptTrivialCoalescing(cur, vrm_->getPhys(cur.reg));
 615     if (!Reg)
 616       continue;
 617     // Ignore splited live intervals.
 618     if (!isPhys && vrm_->getPreSplitReg(cur.reg))
 619       continue;
 620
 621     for (LiveInterval::Ranges::const_iterator I = cur.begin(), E = cur.end();
 622          I != E; ++I) {
 623       const LiveRange &LR = *I;
 624       if (li_->findLiveInMBBs(LR.start, LR.end, LiveInMBBs)) {
 625         for (unsigned i = 0, e = LiveInMBBs.size(); i != e; ++i)
 626           if (LiveInMBBs[i] != EntryMBB) {
 627             assert(TargetRegisterInfo::isPhysicalRegister(Reg) &&
 628                    "Adding a virtual register to livein set?");
 629             LiveInMBBs[i]->addLiveIn(Reg);
 630           }
 631         LiveInMBBs.clear();
 632       }
 633     }
 634   }
 635
 636   DEBUG(dbgs() << *vrm_);
 637
 638   // Look for physical registers that end up not being allocated even though
 639   // register allocator had to spill other registers in its register class.
 640   if (ls_->getNumIntervals() == 0)
 641     return;
 642   if (!vrm_->FindUnusedRegisters(li_))
 643     return;
 644 }
 645
 646 /// processActiveIntervals - expire old intervals and move non-overlapping ones
 647 /// to the inactive list.
 648 void RALinScan::processActiveIntervals(SlotIndex CurPoint)
 649 {
 650   DEBUG(dbgs() << "\tprocessing active intervals:\n");
 651
 652   for (unsigned i = 0, e = active_.size(); i != e; ++i) {
 653     LiveInterval *Interval = active_[i].first;
 654     LiveInterval::iterator IntervalPos = active_[i].second;
 655     unsigned reg = Interval->reg;
 656
 657     IntervalPos = Interval->advanceTo(IntervalPos, CurPoint);
 658
 659     if (IntervalPos == Interval->end()) {     // Remove expired intervals.
 660       DEBUG(dbgs() << "\t\tinterval " << *Interval << " expired\n");
 661       assert(TargetRegisterInfo::isVirtualRegister(reg) &&
 662              "Can only allocate virtual registers!");
 663       reg = vrm_->getPhys(reg);
 664       delRegUse(reg);
 665
 666       // Pop off the end of the list.
 667       active_[i] = active_.back();
 668       active_.pop_back();
 669       --i; --e;
 670
 671     } else if (IntervalPos->start > CurPoint) {
 672       // Move inactive intervals to inactive list.
 673       DEBUG(dbgs() << "\t\tinterval " << *Interval << " inactive\n");
 674       assert(TargetRegisterInfo::isVirtualRegister(reg) &&
 675              "Can only allocate virtual registers!");
 676       reg = vrm_->getPhys(reg);
 677       delRegUse(reg);
 678       // add to inactive.
 679       inactive_.push_back(std::make_pair(Interval, IntervalPos));
 680
 681       // Pop off the end of the list.
 682       active_[i] = active_.back();
 683       active_.pop_back();
 684       --i; --e;
 685     } else {
 686       // Otherwise, just update the iterator position.
 687       active_[i].second = IntervalPos;
 688     }
 689   }
 690 }
 691
 692 /// processInactiveIntervals - expire old intervals and move overlapping
 693 /// ones to the active list.
 694 void RALinScan::processInactiveIntervals(SlotIndex CurPoint)
 695 {
 696   DEBUG(dbgs() << "\tprocessing inactive intervals:\n");
 697
 698   for (unsigned i = 0, e = inactive_.size(); i != e; ++i) {
 699     LiveInterval *Interval = inactive_[i].first;
 700     LiveInterval::iterator IntervalPos = inactive_[i].second;
 701     unsigned reg = Interval->reg;
 702
 703     IntervalPos = Interval->advanceTo(IntervalPos, CurPoint);
 704
 705     if (IntervalPos == Interval->end()) {       // remove expired intervals.
 706       DEBUG(dbgs() << "\t\tinterval " << *Interval << " expired\n");
 707
 708       // Pop off the end of the list.
 709       inactive_[i] = inactive_.back();
 710       inactive_.pop_back();
 711       --i; --e;
 712     } else if (IntervalPos->start <= CurPoint) {
 713       // move re-activated intervals in active list
 714       DEBUG(dbgs() << "\t\tinterval " << *Interval << " active\n");
 715       assert(TargetRegisterInfo::isVirtualRegister(reg) &&
 716              "Can only allocate virtual registers!");
 717       reg = vrm_->getPhys(reg);
 718       addRegUse(reg);
 719       // add to active
 720       active_.push_back(std::make_pair(Interval, IntervalPos));
 721
 722       // Pop off the end of the list.
 723       inactive_[i] = inactive_.back();
 724       inactive_.pop_back();
 725       --i; --e;
 726     } else {
 727       // Otherwise, just update the iterator position.
 728       inactive_[i].second = IntervalPos;
 729     }
 730   }
 731 }
 732
 733 /// updateSpillWeights - updates the spill weights of the specifed physical
 734 /// register and its weight.
 735 void RALinScan::updateSpillWeights(std::vector<float> &Weights,
 736                                    unsigned reg, float weight,
 737                                    const TargetRegisterClass *RC) {
 738   SmallSet<unsigned, 4> Processed;
 739   SmallSet<unsigned, 4> SuperAdded;
 740   SmallVector<unsigned, 4> Supers;
 741   Weights[reg] += weight;
 742   Processed.insert(reg);
 743   for (const unsigned* as = tri_->getAliasSet(reg); *as; ++as) {
 744     Weights[*as] += weight;
 745     Processed.insert(*as);
 746     if (tri_->isSubRegister(*as, reg) &&
 747         SuperAdded.insert(*as) &&
 748         RC->contains(*as)) {
 749       Supers.push_back(*as);
 750     }
 751   }
 752
 753   // If the alias is a super-register, and the super-register is in the
 754   // register class we are trying to allocate. Then add the weight to all
 755   // sub-registers of the super-register even if they are not aliases.
 756   // e.g. allocating for GR32, bh is not used, updating bl spill weight.
 757   //      bl should get the same spill weight otherwise it will be choosen
 758   //      as a spill candidate since spilling bh doesn't make ebx available.
 759   for (unsigned i = 0, e = Supers.size(); i != e; ++i) {
 760     for (const unsigned *sr = tri_->getSubRegisters(Supers[i]); *sr; ++sr)
 761       if (!Processed.count(*sr))
 762         Weights[*sr] += weight;
 763   }
 764 }
 765
 766 static
 767 RALinScan::IntervalPtrs::iterator
 768 FindIntervalInVector(RALinScan::IntervalPtrs &IP, LiveInterval *LI) {
 769   for (RALinScan::IntervalPtrs::iterator I = IP.begin(), E = IP.end();
 770        I != E; ++I)
 771     if (I->first == LI) return I;
 772   return IP.end();
 773 }
 774
 775 static void RevertVectorIteratorsTo(RALinScan::IntervalPtrs &V,
 776                                     SlotIndex Point){
 777   for (unsigned i = 0, e = V.size(); i != e; ++i) {
 778     RALinScan::IntervalPtr &IP = V[i];
 779     LiveInterval::iterator I = std::upper_bound(IP.first->begin(),
 780                                                 IP.second, Point);
 781     if (I != IP.first->begin()) --I;
 782     IP.second = I;
 783   }
 784 }
 785
 786 /// addStackInterval - Create a LiveInterval for stack if the specified live
 787 /// interval has been spilled.
 788 static void addStackInterval(LiveInterval *cur, LiveStacks *ls_,
 789                              LiveIntervals *li_,
 790                              MachineRegisterInfo* mri_, VirtRegMap &vrm_) {
 791   int SS = vrm_.getStackSlot(cur->reg);
 792   if (SS == VirtRegMap::NO_STACK_SLOT)
 793     return;
 794
 795   const TargetRegisterClass *RC = mri_->getRegClass(cur->reg);
 796   LiveInterval &SI = ls_->getOrCreateInterval(SS, RC);
 797
 798   VNInfo *VNI;
 799   if (SI.hasAtLeastOneValue())
 800     VNI = SI.getValNumInfo(0);
 801   else
 802     VNI = SI.getNextValue(SlotIndex(), 0,
 803                           ls_->getVNInfoAllocator());
 804
 805   LiveInterval &RI = li_->getInterval(cur->reg);
 806   // FIXME: This may be overly conservative.
 807   SI.MergeRangesInAsValue(RI, VNI);
 808 }
 809
 810 /// getConflictWeight - Return the number of conflicts between cur
 811 /// live interval and defs and uses of Reg weighted by loop depthes.
 812 static
 813 float getConflictWeight(LiveInterval *cur, unsigned Reg, LiveIntervals *li_,
 814                         MachineRegisterInfo *mri_,
 815                         MachineLoopInfo *loopInfo) {
 816   float Conflicts = 0;
 817   for (MachineRegisterInfo::reg_iterator I = mri_->reg_begin(Reg),
 818          E = mri_->reg_end(); I != E; ++I) {
 819     MachineInstr *MI = &*I;
 820     if (cur->liveAt(li_->getInstructionIndex(MI))) {
 821       unsigned loopDepth = loopInfo->getLoopDepth(MI->getParent());
 822       Conflicts += std::pow(10.0f, (float)loopDepth);
 823     }
 824   }
 825   return Conflicts;
 826 }
 827
 828 /// findIntervalsToSpill - Determine the intervals to spill for the
 829 /// specified interval. It's passed the physical registers whose spill
 830 /// weight is the lowest among all the registers whose live intervals
 831 /// conflict with the interval.
 832 void RALinScan::findIntervalsToSpill(LiveInterval *cur,
 833                             std::vector<std::pair<unsigned,float> > &Candidates,
 834                             unsigned NumCands,
 835                             SmallVector<LiveInterval*, 8> &SpillIntervals) {
 836   // We have figured out the *best* register to spill. But there are other
 837   // registers that are pretty good as well (spill weight within 3%). Spill
 838   // the one that has fewest defs and uses that conflict with cur.
 839   float Conflicts[3] = { 0.0f, 0.0f, 0.0f };
 840   SmallVector<LiveInterval*, 8> SLIs[3];
 841
 842   DEBUG({
 843       dbgs() << "\tConsidering " << NumCands << " candidates: ";
 844       for (unsigned i = 0; i != NumCands; ++i)
 845         dbgs() << tri_->getName(Candidates[i].first) << " ";
 846       dbgs() << "\n";
 847     });
 848
 849   // Calculate the number of conflicts of each candidate.
 850   for (IntervalPtrs::iterator i = active_.begin(); i != active_.end(); ++i) {
 851     unsigned Reg = i->first->reg;
 852     unsigned PhysReg = vrm_->getPhys(Reg);
 853     if (!cur->overlapsFrom(*i->first, i->second))
 854       continue;
 855     for (unsigned j = 0; j < NumCands; ++j) {
 856       unsigned Candidate = Candidates[j].first;
 857       if (tri_->regsOverlap(PhysReg, Candidate)) {
 858         if (NumCands > 1)
 859           Conflicts[j] += getConflictWeight(cur, Reg, li_, mri_, loopInfo);
 860         SLIs[j].push_back(i->first);
 861       }
 862     }
 863   }
 864
 865   for (IntervalPtrs::iterator i = inactive_.begin(); i != inactive_.end(); ++i){
 866     unsigned Reg = i->first->reg;
 867     unsigned PhysReg = vrm_->getPhys(Reg);
 868     if (!cur->overlapsFrom(*i->first, i->second-1))
 869       continue;
 870     for (unsigned j = 0; j < NumCands; ++j) {
 871       unsigned Candidate = Candidates[j].first;
 872       if (tri_->regsOverlap(PhysReg, Candidate)) {
 873         if (NumCands > 1)
 874           Conflicts[j] += getConflictWeight(cur, Reg, li_, mri_, loopInfo);
 875         SLIs[j].push_back(i->first);
 876       }
 877     }
 878   }
 879
 880   // Which is the best candidate?
 881   unsigned BestCandidate = 0;
 882   float MinConflicts = Conflicts[0];
 883   for (unsigned i = 1; i != NumCands; ++i) {
 884     if (Conflicts[i] < MinConflicts) {
 885       BestCandidate = i;
 886       MinConflicts = Conflicts[i];
 887     }
 888   }
 889
 890   std::copy(SLIs[BestCandidate].begin(), SLIs[BestCandidate].end(),
 891             std::back_inserter(SpillIntervals));
 892 }
 893
 894 namespace {
 895   struct WeightCompare {
 896   private:
 897     const RALinScan &Allocator;
 898
 899   public:
 900     WeightCompare(const RALinScan &Alloc) : Allocator(Alloc) {}
 901
 902     typedef std::pair<unsigned, float> RegWeightPair;
 903     bool operator()(const RegWeightPair &LHS, const RegWeightPair &RHS) const {
 904       return LHS.second < RHS.second && !Allocator.isRecentlyUsed(LHS.first);
 905     }
 906   };
 907 }
 908
 909 static bool weightsAreClose(float w1, float w2) {
 910   if (!NewHeuristic)
 911     return false;
 912
 913   float diff = w1 - w2;
 914   if (diff <= 0.02f)  // Within 0.02f
 915     return true;
 916   return (diff / w2) <= 0.05f;  // Within 5%.
 917 }
 918
 919 LiveInterval *RALinScan::hasNextReloadInterval(LiveInterval *cur) {
 920   DenseMap<unsigned, unsigned>::iterator I = NextReloadMap.find(cur->reg);
 921   if (I == NextReloadMap.end())
 922     return 0;
 923   return &li_->getInterval(I->second);
 924 }
 925
 926 void RALinScan::DowngradeRegister(LiveInterval *li, unsigned Reg) {
 927   bool isNew = DowngradedRegs.insert(Reg);
 928   isNew = isNew; // Silence compiler warning.
 929   assert(isNew && "Multiple reloads holding the same register?");
 930   DowngradeMap.insert(std::make_pair(li->reg, Reg));
 931   for (const unsigned *AS = tri_->getAliasSet(Reg); *AS; ++AS) {
 932     isNew = DowngradedRegs.insert(*AS);
 933     isNew = isNew; // Silence compiler warning.
 934     assert(isNew && "Multiple reloads holding the same register?");
 935     DowngradeMap.insert(std::make_pair(li->reg, *AS));
 936   }
 937   ++NumDowngrade;
 938 }
 939
 940 void RALinScan::UpgradeRegister(unsigned Reg) {
 941   if (Reg) {
 942     DowngradedRegs.erase(Reg);
 943     for (const unsigned *AS = tri_->getAliasSet(Reg); *AS; ++AS)
 944       DowngradedRegs.erase(*AS);
 945   }
 946 }
 947
 948 namespace {
 949   struct LISorter {
 950     bool operator()(LiveInterval* A, LiveInterval* B) {
 951       return A->beginIndex() < B->beginIndex();
 952     }
 953   };
 954 }
 955
 956 /// assignRegOrStackSlotAtInterval - assign a register if one is available, or
 957 /// spill.
 958 void RALinScan::assignRegOrStackSlotAtInterval(LiveInterval* cur) {
 959   DEBUG(dbgs() << "\tallocating current interval: ");
 960
 961   // This is an implicitly defined live interval, just assign any register.
 962   const TargetRegisterClass *RC = mri_->getRegClass(cur->reg);
 963   if (cur->empty()) {
 964     unsigned physReg = vrm_->getRegAllocPref(cur->reg);
 965     if (!physReg)
 966       physReg = getFirstNonReservedPhysReg(RC);
 967     DEBUG(dbgs() <<  tri_->getName(physReg) << '\n');
 968     // Note the register is not really in use.
 969     vrm_->assignVirt2Phys(cur->reg, physReg);
 970     return;
 971   }
 972
 973   backUpRegUses();
 974
 975   std::vector<std::pair<unsigned, float> > SpillWeightsToAdd;
 976   SlotIndex StartPosition = cur->beginIndex();
 977   const TargetRegisterClass *RCLeader = RelatedRegClasses.getLeaderValue(RC);
 978
 979   // If start of this live interval is defined by a move instruction and its
 980   // source is assigned a physical register that is compatible with the target
 981   // register class, then we should try to assign it the same register.
 982   // This can happen when the move is from a larger register class to a smaller
 983   // one, e.g. X86::mov32to32_. These move instructions are not coalescable.
 984   if (!vrm_->getRegAllocPref(cur->reg) && cur->hasAtLeastOneValue()) {
 985     VNInfo *vni = cur->begin()->valno;
 986     if (!vni->isUnused()) {
 987       MachineInstr *CopyMI = li_->getInstructionFromIndex(vni->def);
 988       if (CopyMI && CopyMI->isCopy()) {
 989         unsigned DstSubReg = CopyMI->getOperand(0).getSubReg();
 990         unsigned SrcReg = CopyMI->getOperand(1).getReg();
 991         unsigned SrcSubReg = CopyMI->getOperand(1).getSubReg();
 992         unsigned Reg = 0;
 993         if (TargetRegisterInfo::isPhysicalRegister(SrcReg))
 994           Reg = SrcReg;
 995         else if (vrm_->isAssignedReg(SrcReg))
 996           Reg = vrm_->getPhys(SrcReg);
 997         if (Reg) {
 998           if (SrcSubReg)
 999             Reg = tri_->getSubReg(Reg, SrcSubReg);
1000           if (DstSubReg)
1001             Reg = tri_->getMatchingSuperReg(Reg, DstSubReg, RC);
1002           if (Reg && allocatableRegs_[Reg] && RC->contains(Reg))
1003             mri_->setRegAllocationHint(cur->reg, 0, Reg);
1004         }
1005       }
1006     }
1007   }
1008
1009   // For every interval in inactive we overlap with, mark the
1010   // register as not free and update spill weights.
1011   for (IntervalPtrs::const_iterator i = inactive_.begin(),
1012          e = inactive_.end(); i != e; ++i) {
1013     unsigned Reg = i->first->reg;
1014     assert(TargetRegisterInfo::isVirtualRegister(Reg) &&
1015            "Can only allocate virtual registers!");
1016     const TargetRegisterClass *RegRC = mri_->getRegClass(Reg);
1017     // If this is not in a related reg class to the register we're allocating,
1018     // don't check it.
1019     if (RelatedRegClasses.getLeaderValue(RegRC) == RCLeader &&
1020         cur->overlapsFrom(*i->first, i->second-1)) {
1021       Reg = vrm_->getPhys(Reg);
1022       addRegUse(Reg);
1023       SpillWeightsToAdd.push_back(std::make_pair(Reg, i->first->weight));
1024     }
1025   }
1026
1027   // Speculatively check to see if we can get a register right now.  If not,
1028   // we know we won't be able to by adding more constraints.  If so, we can
1029   // check to see if it is valid.  Doing an exhaustive search of the fixed_ list
1030   // is very bad (it contains all callee clobbered registers for any functions
1031   // with a call), so we want to avoid doing that if possible.
1032   unsigned physReg = getFreePhysReg(cur);
1033   unsigned BestPhysReg = physReg;
1034   if (physReg) {
1035     // We got a register.  However, if it's in the fixed_ list, we might
1036     // conflict with it.  Check to see if we conflict with it or any of its
1037     // aliases.
1038     SmallSet<unsigned, 8> RegAliases;
1039     for (const unsigned *AS = tri_->getAliasSet(physReg); *AS; ++AS)
1040       RegAliases.insert(*AS);
1041
1042     bool ConflictsWithFixed = false;
1043     for (unsigned i = 0, e = fixed_.size(); i != e; ++i) {
1044       IntervalPtr &IP = fixed_[i];
1045       if (physReg == IP.first->reg || RegAliases.count(IP.first->reg)) {
1046         // Okay, this reg is on the fixed list.  Check to see if we actually
1047         // conflict.
1048         LiveInterval *I = IP.first;
1049         if (I->endIndex() > StartPosition) {
1050           LiveInterval::iterator II = I->advanceTo(IP.second, StartPosition);
1051           IP.second = II;
1052           if (II != I->begin() && II->start > StartPosition)
1053             --II;
1054           if (cur->overlapsFrom(*I, II)) {
1055             ConflictsWithFixed = true;
1056             break;
1057           }
1058         }
1059       }
1060     }
1061
1062     // Okay, the register picked by our speculative getFreePhysReg call turned
1063     // out to be in use.  Actually add all of the conflicting fixed registers to
1064     // regUse_ so we can do an accurate query.
1065     if (ConflictsWithFixed) {
1066       // For every interval in fixed we overlap with, mark the register as not
1067       // free and update spill weights.
1068       for (unsigned i = 0, e = fixed_.size(); i != e; ++i) {
1069         IntervalPtr &IP = fixed_[i];
1070         LiveInterval *I = IP.first;
1071
1072         const TargetRegisterClass *RegRC = OneClassForEachPhysReg[I->reg];
1073         if (RelatedRegClasses.getLeaderValue(RegRC) == RCLeader &&
1074             I->endIndex() > StartPosition) {
1075           LiveInterval::iterator II = I->advanceTo(IP.second, StartPosition);
1076           IP.second = II;
1077           if (II != I->begin() && II->start > StartPosition)
1078             --II;
1079           if (cur->overlapsFrom(*I, II)) {
1080             unsigned reg = I->reg;
1081             addRegUse(reg);
1082             SpillWeightsToAdd.push_back(std::make_pair(reg, I->weight));
1083           }
1084         }
1085       }
1086
1087       // Using the newly updated regUse_ object, which includes conflicts in the
1088       // future, see if there are any registers available.
1089       physReg = getFreePhysReg(cur);
1090     }
1091   }
1092
1093   // Restore the physical register tracker, removing information about the
1094   // future.
1095   restoreRegUses();
1096
1097   // If we find a free register, we are done: assign this virtual to
1098   // the free physical register and add this interval to the active
1099   // list.
1100   if (physReg) {
1101     DEBUG(dbgs() <<  tri_->getName(physReg) << '\n');
1102     vrm_->assignVirt2Phys(cur->reg, physReg);
1103     addRegUse(physReg);
1104     active_.push_back(std::make_pair(cur, cur->begin()));
1105     handled_.push_back(cur);
1106
1107     // "Upgrade" the physical register since it has been allocated.
1108     UpgradeRegister(physReg);
1109     if (LiveInterval *NextReloadLI = hasNextReloadInterval(cur)) {
1110       // "Downgrade" physReg to try to keep physReg from being allocated until
1111       // the next reload from the same SS is allocated.
1112       mri_->setRegAllocationHint(NextReloadLI->reg, 0, physReg);
1113       DowngradeRegister(cur, physReg);
1114     }
1115     return;
1116   }
1117   DEBUG(dbgs() << "no free registers\n");
1118
1119   // Compile the spill weights into an array that is better for scanning.
1120   std::vector<float> SpillWeights(tri_->getNumRegs(), 0.0f);
1121   for (std::vector<std::pair<unsigned, float> >::iterator
1122        I = SpillWeightsToAdd.begin(), E = SpillWeightsToAdd.end(); I != E; ++I)
1123     updateSpillWeights(SpillWeights, I->first, I->second, RC);
1124
1125   // for each interval in active, update spill weights.
1126   for (IntervalPtrs::const_iterator i = active_.begin(), e = active_.end();
1127        i != e; ++i) {
1128     unsigned reg = i->first->reg;
1129     assert(TargetRegisterInfo::isVirtualRegister(reg) &&
1130            "Can only allocate virtual registers!");
1131     reg = vrm_->getPhys(reg);
1132     updateSpillWeights(SpillWeights, reg, i->first->weight, RC);
1133   }
1134
1135   DEBUG(dbgs() << "\tassigning stack slot at interval "<< *cur << ":\n");
1136
1137   // Find a register to spill.
1138   float minWeight = HUGE_VALF;
1139   unsigned minReg = 0;
1140
1141   bool Found = false;
1142   std::vector<std::pair<unsigned,float> > RegsWeights;
1143   if (!minReg || SpillWeights[minReg] == HUGE_VALF)
1144     for (TargetRegisterClass::iterator i = RC->allocation_order_begin(*mf_),
1145            e = RC->allocation_order_end(*mf_); i != e; ++i) {
1146       unsigned reg = *i;
1147       float regWeight = SpillWeights[reg];
1148       // Don't even consider reserved regs.
1149       if (reservedRegs_.test(reg))
1150         continue;
1151       // Skip recently allocated registers and reserved registers.
1152       if (minWeight > regWeight && !isRecentlyUsed(reg))
1153         Found = true;
1154       RegsWeights.push_back(std::make_pair(reg, regWeight));
1155     }
1156
1157   // If we didn't find a register that is spillable, try aliases?
1158   if (!Found) {
1159     for (TargetRegisterClass::iterator i = RC->allocation_order_begin(*mf_),
1160            e = RC->allocation_order_end(*mf_); i != e; ++i) {
1161       unsigned reg = *i;
1162       if (reservedRegs_.test(reg))
1163         continue;
1164       // No need to worry about if the alias register size < regsize of RC.
1165       // We are going to spill all registers that alias it anyway.
1166       for (const unsigned* as = tri_->getAliasSet(reg); *as; ++as)
1167         RegsWeights.push_back(std::make_pair(*as, SpillWeights[*as]));
1168     }
1169   }
1170
1171   // Sort all potential spill candidates by weight.
1172   std::sort(RegsWeights.begin(), RegsWeights.end(), WeightCompare(*this));
1173   minReg = RegsWeights[0].first;
1174   minWeight = RegsWeights[0].second;
1175   if (minWeight == HUGE_VALF) {
1176     // All registers must have inf weight. Just grab one!
1177     minReg = BestPhysReg ? BestPhysReg : getFirstNonReservedPhysReg(RC);
1178     if (cur->weight == HUGE_VALF ||
1179         li_->getApproximateInstructionCount(*cur) == 0) {
1180       // Spill a physical register around defs and uses.
1181       if (li_->spillPhysRegAroundRegDefsUses(*cur, minReg, *vrm_)) {
1182         // spillPhysRegAroundRegDefsUses may have invalidated iterator stored
1183         // in fixed_. Reset them.
1184         for (unsigned i = 0, e = fixed_.size(); i != e; ++i) {
1185           IntervalPtr &IP = fixed_[i];
1186           LiveInterval *I = IP.first;
1187           if (I->reg == minReg || tri_->isSubRegister(minReg, I->reg))
1188             IP.second = I->advanceTo(I->begin(), StartPosition);
1189         }
1190
1191         DowngradedRegs.clear();
1192         assignRegOrStackSlotAtInterval(cur);
1193       } else {
1194         assert(false && "Ran out of registers during register allocation!");
1195         report_fatal_error("Ran out of registers during register allocation!");
1196       }
1197       return;
1198     }
1199   }
1200
1201   // Find up to 3 registers to consider as spill candidates.
1202   unsigned LastCandidate = RegsWeights.size() >= 3 ? 3 : 1;
1203   while (LastCandidate > 1) {
1204     if (weightsAreClose(RegsWeights[LastCandidate-1].second, minWeight))
1205       break;
1206     --LastCandidate;
1207   }
1208
1209   DEBUG({
1210       dbgs() << "\t\tregister(s) with min weight(s): ";
1211
1212       for (unsigned i = 0; i != LastCandidate; ++i)
1213         dbgs() << tri_->getName(RegsWeights[i].first)
1214                << " (" << RegsWeights[i].second << ")\n";
1215     });
1216
1217   // If the current has the minimum weight, we need to spill it and
1218   // add any added intervals back to unhandled, and restart
1219   // linearscan.
1220   if (cur->weight != HUGE_VALF && cur->weight <= minWeight) {
1221     DEBUG(dbgs() << "\t\t\tspilling(c): " << *cur << '\n');
1222     SmallVector<LiveInterval*, 8> spillIs, added;
1223     spiller_->spill(cur, added, spillIs);
1224
1225     std::sort(added.begin(), added.end(), LISorter());
1226     addStackInterval(cur, ls_, li_, mri_, *vrm_);
1227     if (added.empty())
1228       return;  // Early exit if all spills were folded.
1229
1230     // Merge added with unhandled.  Note that we have already sorted
1231     // intervals returned by addIntervalsForSpills by their starting
1232     // point.
1233     // This also update the NextReloadMap. That is, it adds mapping from a
1234     // register defined by a reload from SS to the next reload from SS in the
1235     // same basic block.
1236     MachineBasicBlock *LastReloadMBB = 0;
1237     LiveInterval *LastReload = 0;
1238     int LastReloadSS = VirtRegMap::NO_STACK_SLOT;
1239     for (unsigned i = 0, e = added.size(); i != e; ++i) {
1240       LiveInterval *ReloadLi = added[i];
1241       if (ReloadLi->weight == HUGE_VALF &&
1242           li_->getApproximateInstructionCount(*ReloadLi) == 0) {
1243         SlotIndex ReloadIdx = ReloadLi->beginIndex();
1244         MachineBasicBlock *ReloadMBB = li_->getMBBFromIndex(ReloadIdx);
1245         int ReloadSS = vrm_->getStackSlot(ReloadLi->reg);
1246         if (LastReloadMBB == ReloadMBB && LastReloadSS == ReloadSS) {
1247           // Last reload of same SS is in the same MBB. We want to try to
1248           // allocate both reloads the same register and make sure the reg
1249           // isn't clobbered in between if at all possible.
1250           assert(LastReload->beginIndex() < ReloadIdx);
1251           NextReloadMap.insert(std::make_pair(LastReload->reg, ReloadLi->reg));
1252         }
1253         LastReloadMBB = ReloadMBB;
1254         LastReload = ReloadLi;
1255         LastReloadSS = ReloadSS;
1256       }
1257       unhandled_.push(ReloadLi);
1258     }
1259     return;
1260   }
1261
1262   ++NumBacktracks;
1263
1264   // Push the current interval back to unhandled since we are going
1265   // to re-run at least this iteration. Since we didn't modify it it
1266   // should go back right in the front of the list
1267   unhandled_.push(cur);
1268
1269   assert(TargetRegisterInfo::isPhysicalRegister(minReg) &&
1270          "did not choose a register to spill?");
1271
1272   // We spill all intervals aliasing the register with
1273   // minimum weight, rollback to the interval with the earliest
1274   // start point and let the linear scan algorithm run again
1275   SmallVector<LiveInterval*, 8> spillIs;
1276
1277   // Determine which intervals have to be spilled.
1278   findIntervalsToSpill(cur, RegsWeights, LastCandidate, spillIs);
1279
1280   // Set of spilled vregs (used later to rollback properly)
1281   SmallSet<unsigned, 8> spilled;
1282
1283   // The earliest start of a Spilled interval indicates up to where
1284   // in handled we need to roll back
1285   assert(!spillIs.empty() && "No spill intervals?");
1286   SlotIndex earliestStart = spillIs[0]->beginIndex();
1287
1288   // Spill live intervals of virtual regs mapped to the physical register we
1289   // want to clear (and its aliases).  We only spill those that overlap with the
1290   // current interval as the rest do not affect its allocation. we also keep
1291   // track of the earliest start of all spilled live intervals since this will
1292   // mark our rollback point.
1293   SmallVector<LiveInterval*, 8> added;
1294   while (!spillIs.empty()) {
1295     LiveInterval *sli = spillIs.back();
1296     spillIs.pop_back();
1297     DEBUG(dbgs() << "\t\t\tspilling(a): " << *sli << '\n');
1298     if (sli->beginIndex() < earliestStart)
1299       earliestStart = sli->beginIndex();
1300     spiller_->spill(sli, added, spillIs);
1301     addStackInterval(sli, ls_, li_, mri_, *vrm_);
1302     spilled.insert(sli->reg);
1303   }
1304
1305   // Include any added intervals in earliestStart.
1306   for (unsigned i = 0, e = added.size(); i != e; ++i) {
1307     SlotIndex SI = added[i]->beginIndex();
1308     if (SI < earliestStart)
1309       earliestStart = SI;
1310   }
1311
1312   DEBUG(dbgs() << "\t\trolling back to: " << earliestStart << '\n');
1313
1314   // Scan handled in reverse order up to the earliest start of a
1315   // spilled live interval and undo each one, restoring the state of
1316   // unhandled.
1317   while (!handled_.empty()) {
1318     LiveInterval* i = handled_.back();
1319     // If this interval starts before t we are done.
1320     if (!i->empty() && i->beginIndex() < earliestStart)
1321       break;
1322     DEBUG(dbgs() << "\t\t\tundo changes for: " << *i << '\n');
1323     handled_.pop_back();
1324
1325     // When undoing a live interval allocation we must know if it is active or
1326     // inactive to properly update regUse_ and the VirtRegMap.
1327     IntervalPtrs::iterator it;
1328     if ((it = FindIntervalInVector(active_, i)) != active_.end()) {
1329       active_.erase(it);
1330       assert(!TargetRegisterInfo::isPhysicalRegister(i->reg));
1331       if (!spilled.count(i->reg))
1332         unhandled_.push(i);
1333       delRegUse(vrm_->getPhys(i->reg));
1334       vrm_->clearVirt(i->reg);
1335     } else if ((it = FindIntervalInVector(inactive_, i)) != inactive_.end()) {
1336       inactive_.erase(it);
1337       assert(!TargetRegisterInfo::isPhysicalRegister(i->reg));
1338       if (!spilled.count(i->reg))
1339         unhandled_.push(i);
1340       vrm_->clearVirt(i->reg);
1341     } else {
1342       assert(TargetRegisterInfo::isVirtualRegister(i->reg) &&
1343              "Can only allocate virtual registers!");
1344       vrm_->clearVirt(i->reg);
1345       unhandled_.push(i);
1346     }
1347
1348     DenseMap<unsigned, unsigned>::iterator ii = DowngradeMap.find(i->reg);
1349     if (ii == DowngradeMap.end())
1350       // It interval has a preference, it must be defined by a copy. Clear the
1351       // preference now since the source interval allocation may have been
1352       // undone as well.
1353       mri_->setRegAllocationHint(i->reg, 0, 0);
1354     else {
1355       UpgradeRegister(ii->second);
1356     }
1357   }
1358
1359   // Rewind the iterators in the active, inactive, and fixed lists back to the
1360   // point we reverted to.
1361   RevertVectorIteratorsTo(active_, earliestStart);
1362   RevertVectorIteratorsTo(inactive_, earliestStart);
1363   RevertVectorIteratorsTo(fixed_, earliestStart);
1364
1365   // Scan the rest and undo each interval that expired after t and
1366   // insert it in active (the next iteration of the algorithm will
1367   // put it in inactive if required)
1368   for (unsigned i = 0, e = handled_.size(); i != e; ++i) {
1369     LiveInterval *HI = handled_[i];
1370     if (!HI->expiredAt(earliestStart) &&
1371         HI->expiredAt(cur->beginIndex())) {
1372       DEBUG(dbgs() << "\t\t\tundo changes for: " << *HI << '\n');
1373       active_.push_back(std::make_pair(HI, HI->begin()));
1374       assert(!TargetRegisterInfo::isPhysicalRegister(HI->reg));
1375       addRegUse(vrm_->getPhys(HI->reg));
1376     }
1377   }
1378
1379   // Merge added with unhandled.
1380   // This also update the NextReloadMap. That is, it adds mapping from a
1381   // register defined by a reload from SS to the next reload from SS in the
1382   // same basic block.
1383   MachineBasicBlock *LastReloadMBB = 0;
1384   LiveInterval *LastReload = 0;
1385   int LastReloadSS = VirtRegMap::NO_STACK_SLOT;
1386   std::sort(added.begin(), added.end(), LISorter());
1387   for (unsigned i = 0, e = added.size(); i != e; ++i) {
1388     LiveInterval *ReloadLi = added[i];
1389     if (ReloadLi->weight == HUGE_VALF &&
1390         li_->getApproximateInstructionCount(*ReloadLi) == 0) {
1391       SlotIndex ReloadIdx = ReloadLi->beginIndex();
1392       MachineBasicBlock *ReloadMBB = li_->getMBBFromIndex(ReloadIdx);
1393       int ReloadSS = vrm_->getStackSlot(ReloadLi->reg);
1394       if (LastReloadMBB == ReloadMBB && LastReloadSS == ReloadSS) {
1395         // Last reload of same SS is in the same MBB. We want to try to
1396         // allocate both reloads the same register and make sure the reg
1397         // isn't clobbered in between if at all possible.
1398         assert(LastReload->beginIndex() < ReloadIdx);
1399         NextReloadMap.insert(std::make_pair(LastReload->reg, ReloadLi->reg));
1400       }
1401       LastReloadMBB = ReloadMBB;
1402       LastReload = ReloadLi;
1403       LastReloadSS = ReloadSS;
1404     }
1405     unhandled_.push(ReloadLi);
1406   }
1407 }
1408
1409 unsigned RALinScan::getFreePhysReg(LiveInterval* cur,
1410                                    const TargetRegisterClass *RC,
1411                                    unsigned MaxInactiveCount,
1412                                    SmallVector<unsigned, 256> &inactiveCounts,
1413                                    bool SkipDGRegs) {
1414   unsigned FreeReg = 0;
1415   unsigned FreeRegInactiveCount = 0;
1416
1417   std::pair<unsigned, unsigned> Hint = mri_->getRegAllocationHint(cur->reg);
1418   // Resolve second part of the hint (if possible) given the current allocation.
1419   unsigned physReg = Hint.second;
1420   if (physReg &&
1421       TargetRegisterInfo::isVirtualRegister(physReg) && vrm_->hasPhys(physReg))
1422     physReg = vrm_->getPhys(physReg);
1423
1424   TargetRegisterClass::iterator I, E;
1425   tie(I, E) = tri_->getAllocationOrder(RC, Hint.first, physReg, *mf_);
1426   assert(I != E && "No allocatable register in this register class!");
1427
1428   // Scan for the first available register.
1429   for (; I != E; ++I) {
1430     unsigned Reg = *I;
1431     // Ignore "downgraded" registers.
1432     if (SkipDGRegs && DowngradedRegs.count(Reg))
1433       continue;
1434     // Skip reserved registers.
1435     if (reservedRegs_.test(Reg))
1436       continue;
1437     // Skip recently allocated registers.
1438     if (isRegAvail(Reg) && !isRecentlyUsed(Reg)) {
1439       FreeReg = Reg;
1440       if (FreeReg < inactiveCounts.size())
1441         FreeRegInactiveCount = inactiveCounts[FreeReg];
1442       else
1443         FreeRegInactiveCount = 0;
1444       break;
1445     }
1446   }
1447
1448   // If there are no free regs, or if this reg has the max inactive count,
1449   // return this register.
1450   if (FreeReg == 0 || FreeRegInactiveCount == MaxInactiveCount) {
1451     // Remember what register we picked so we can skip it next time.
1452     if (FreeReg != 0) recordRecentlyUsed(FreeReg);
1453     return FreeReg;
1454   }
1455
1456   // Continue scanning the registers, looking for the one with the highest
1457   // inactive count.  Alkis found that this reduced register pressure very
1458   // slightly on X86 (in rev 1.94 of this file), though this should probably be
1459   // reevaluated now.
1460   for (; I != E; ++I) {
1461     unsigned Reg = *I;
1462     // Ignore "downgraded" registers.
1463     if (SkipDGRegs && DowngradedRegs.count(Reg))
1464       continue;
1465     // Skip reserved registers.
1466     if (reservedRegs_.test(Reg))
1467       continue;
1468     if (isRegAvail(Reg) && Reg < inactiveCounts.size() &&
1469         FreeRegInactiveCount < inactiveCounts[Reg] && !isRecentlyUsed(Reg)) {
1470       FreeReg = Reg;
1471       FreeRegInactiveCount = inactiveCounts[Reg];
1472       if (FreeRegInactiveCount == MaxInactiveCount)
1473         break;    // We found the one with the max inactive count.
1474     }
1475   }
1476
1477   // Remember what register we picked so we can skip it next time.
1478   recordRecentlyUsed(FreeReg);
1479
1480   return FreeReg;
1481 }
1482
1483 /// getFreePhysReg - return a free physical register for this virtual register
1484 /// interval if we have one, otherwise return 0.
1485 unsigned RALinScan::getFreePhysReg(LiveInterval *cur) {
1486   SmallVector<unsigned, 256> inactiveCounts;
1487   unsigned MaxInactiveCount = 0;
1488
1489   const TargetRegisterClass *RC = mri_->getRegClass(cur->reg);
1490   const TargetRegisterClass *RCLeader = RelatedRegClasses.getLeaderValue(RC);
1491
1492   for (IntervalPtrs::iterator i = inactive_.begin(), e = inactive_.end();
1493        i != e; ++i) {
1494     unsigned reg = i->first->reg;
1495     assert(TargetRegisterInfo::isVirtualRegister(reg) &&
1496            "Can only allocate virtual registers!");
1497
1498     // If this is not in a related reg class to the register we're allocating,
1499     // don't check it.
1500     const TargetRegisterClass *RegRC = mri_->getRegClass(reg);
1501     if (RelatedRegClasses.getLeaderValue(RegRC) == RCLeader) {
1502       reg = vrm_->getPhys(reg);
1503       if (inactiveCounts.size() <= reg)
1504         inactiveCounts.resize(reg+1);
1505       ++inactiveCounts[reg];
1506       MaxInactiveCount = std::max(MaxInactiveCount, inactiveCounts[reg]);
1507     }
1508   }
1509
1510   // If copy coalescer has assigned a "preferred" register, check if it's
1511   // available first.
1512   unsigned Preference = vrm_->getRegAllocPref(cur->reg);
1513   if (Preference) {
1514     DEBUG(dbgs() << "(preferred: " << tri_->getName(Preference) << ") ");
1515     if (isRegAvail(Preference) &&
1516         RC->contains(Preference))
1517       return Preference;
1518   }
1519
1520   if (!DowngradedRegs.empty()) {
1521     unsigned FreeReg = getFreePhysReg(cur, RC, MaxInactiveCount, inactiveCounts,
1522                                       true);
1523     if (FreeReg)
1524       return FreeReg;
1525   }
1526   return getFreePhysReg(cur, RC, MaxInactiveCount, inactiveCounts, false);
1527 }
1528
1529 FunctionPass* llvm::createLinearScanRegisterAllocator() {
1530   return new RALinScan();
1531 }