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