lib/CodeGen/RegAllocLinearScan.cpp

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