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