lib/CodeGen/RegAllocGreedy.cpp

   1 //===-- RegAllocGreedy.cpp - greedy 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 defines the RAGreedy function pass for register allocation in
  11 // optimized builds.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "regalloc"
  16 #include "AllocationOrder.h"
  17 #include "InterferenceCache.h"
  18 #include "LiveDebugVariables.h"
  19 #include "LiveRangeEdit.h"
  20 #include "RegAllocBase.h"
  21 #include "Spiller.h"
  22 #include "SpillPlacement.h"
  23 #include "SplitKit.h"
  24 #include "VirtRegMap.h"
  25 #include "RegisterCoalescer.h"
  26 #include "llvm/ADT/Statistic.h"
  27 #include "llvm/Analysis/AliasAnalysis.h"
  28 #include "llvm/Function.h"
  29 #include "llvm/PassAnalysisSupport.h"
  30 #include "llvm/CodeGen/CalcSpillWeights.h"
  31 #include "llvm/CodeGen/EdgeBundles.h"
  32 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  33 #include "llvm/CodeGen/LiveStackAnalysis.h"
  34 #include "llvm/CodeGen/MachineDominators.h"
  35 #include "llvm/CodeGen/MachineFunctionPass.h"
  36 #include "llvm/CodeGen/MachineLoopInfo.h"
  37 #include "llvm/CodeGen/MachineRegisterInfo.h"
  38 #include "llvm/CodeGen/Passes.h"
  39 #include "llvm/CodeGen/RegAllocRegistry.h"
  40 #include "llvm/Target/TargetOptions.h"
  41 #include "llvm/Support/CommandLine.h"
  42 #include "llvm/Support/Debug.h"
  43 #include "llvm/Support/ErrorHandling.h"
  44 #include "llvm/Support/raw_ostream.h"
  45 #include "llvm/Support/Timer.h"
  46
  47 #include <queue>
  48
  49 using namespace llvm;
  50
  51 STATISTIC(NumGlobalSplits, "Number of split global live ranges");
  52 STATISTIC(NumLocalSplits,  "Number of split local live ranges");
  53 STATISTIC(NumEvicted,      "Number of interferences evicted");
  54
  55 cl::opt<bool> CompactRegions("compact-regions");
  56
  57 static RegisterRegAlloc greedyRegAlloc("greedy", "greedy register allocator",
  58                                        createGreedyRegisterAllocator);
  59
  60 namespace {
  61 class RAGreedy : public MachineFunctionPass,
  62                  public RegAllocBase,
  63                  private LiveRangeEdit::Delegate {
  64
  65   // context
  66   MachineFunction *MF;
  67
  68   // analyses
  69   SlotIndexes *Indexes;
  70   LiveStacks *LS;
  71   MachineDominatorTree *DomTree;
  72   MachineLoopInfo *Loops;
  73   EdgeBundles *Bundles;
  74   SpillPlacement *SpillPlacer;
  75   LiveDebugVariables *DebugVars;
  76
  77   // state
  78   std::auto_ptr<Spiller> SpillerInstance;
  79   std::priority_queue<std::pair<unsigned, unsigned> > Queue;
  80   unsigned NextCascade;
  81
  82   // Live ranges pass through a number of stages as we try to allocate them.
  83   // Some of the stages may also create new live ranges:
  84   //
  85   // - Region splitting.
  86   // - Per-block splitting.
  87   // - Local splitting.
  88   // - Spilling.
  89   //
  90   // Ranges produced by one of the stages skip the previous stages when they are
  91   // dequeued. This improves performance because we can skip interference checks
  92   // that are unlikely to give any results. It also guarantees that the live
  93   // range splitting algorithm terminates, something that is otherwise hard to
  94   // ensure.
  95   enum LiveRangeStage {
  96     /// Newly created live range that has never been queued.
  97     RS_New,
  98
  99     /// Only attempt assignment and eviction. Then requeue as RS_Split.
 100     RS_Assign,
 101
 102     /// Attempt live range splitting if assignment is impossible.
 103     RS_Split,
 104
 105     /// Attempt more aggressive live range splitting that is guaranteed to make
 106     /// progress.  This is used for split products that may not be making
 107     /// progress.
 108     RS_Split2,
 109
 110     /// Live range will be spilled.  No more splitting will be attempted.
 111     RS_Spill,
 112
 113     /// There is nothing more we can do to this live range.  Abort compilation
 114     /// if it can't be assigned.
 115     RS_Done
 116   };
 117
 118   static const char *const StageName[];
 119
 120   // RegInfo - Keep additional information about each live range.
 121   struct RegInfo {
 122     LiveRangeStage Stage;
 123
 124     // Cascade - Eviction loop prevention. See canEvictInterference().
 125     unsigned Cascade;
 126
 127     RegInfo() : Stage(RS_New), Cascade(0) {}
 128   };
 129
 130   IndexedMap<RegInfo, VirtReg2IndexFunctor> ExtraRegInfo;
 131
 132   LiveRangeStage getStage(const LiveInterval &VirtReg) const {
 133     return ExtraRegInfo[VirtReg.reg].Stage;
 134   }
 135
 136   void setStage(const LiveInterval &VirtReg, LiveRangeStage Stage) {
 137     ExtraRegInfo.resize(MRI->getNumVirtRegs());
 138     ExtraRegInfo[VirtReg.reg].Stage = Stage;
 139   }
 140
 141   template<typename Iterator>
 142   void setStage(Iterator Begin, Iterator End, LiveRangeStage NewStage) {
 143     ExtraRegInfo.resize(MRI->getNumVirtRegs());
 144     for (;Begin != End; ++Begin) {
 145       unsigned Reg = (*Begin)->reg;
 146       if (ExtraRegInfo[Reg].Stage == RS_New)
 147         ExtraRegInfo[Reg].Stage = NewStage;
 148     }
 149   }
 150
 151   /// Cost of evicting interference.
 152   struct EvictionCost {
 153     unsigned BrokenHints; ///< Total number of broken hints.
 154     float MaxWeight;      ///< Maximum spill weight evicted.
 155
 156     EvictionCost(unsigned B = 0) : BrokenHints(B), MaxWeight(0) {}
 157
 158     bool operator<(const EvictionCost &O) const {
 159       if (BrokenHints != O.BrokenHints)
 160         return BrokenHints < O.BrokenHints;
 161       return MaxWeight < O.MaxWeight;
 162     }
 163   };
 164
 165   // splitting state.
 166   std::auto_ptr<SplitAnalysis> SA;
 167   std::auto_ptr<SplitEditor> SE;
 168
 169   /// Cached per-block interference maps
 170   InterferenceCache IntfCache;
 171
 172   /// All basic blocks where the current register has uses.
 173   SmallVector<SpillPlacement::BlockConstraint, 8> SplitConstraints;
 174
 175   /// Global live range splitting candidate info.
 176   struct GlobalSplitCandidate {
 177     // Register intended for assignment, or 0.
 178     unsigned PhysReg;
 179
 180     // SplitKit interval index for this candidate.
 181     unsigned IntvIdx;
 182
 183     // Interference for PhysReg.
 184     InterferenceCache::Cursor Intf;
 185
 186     // Bundles where this candidate should be live.
 187     BitVector LiveBundles;
 188     SmallVector<unsigned, 8> ActiveBlocks;
 189
 190     void reset(InterferenceCache &Cache, unsigned Reg) {
 191       PhysReg = Reg;
 192       IntvIdx = 0;
 193       Intf.setPhysReg(Cache, Reg);
 194       LiveBundles.clear();
 195       ActiveBlocks.clear();
 196     }
 197
 198     // Set B[i] = C for every live bundle where B[i] was NoCand.
 199     unsigned getBundles(SmallVectorImpl<unsigned> &B, unsigned C) {
 200       unsigned Count = 0;
 201       for (int i = LiveBundles.find_first(); i >= 0;
 202            i = LiveBundles.find_next(i))
 203         if (B[i] == NoCand) {
 204           B[i] = C;
 205           Count++;
 206         }
 207       return Count;
 208     }
 209   };
 210
 211   /// Candidate info for for each PhysReg in AllocationOrder.
 212   /// This vector never shrinks, but grows to the size of the largest register
 213   /// class.
 214   SmallVector<GlobalSplitCandidate, 32> GlobalCand;
 215
 216   enum { NoCand = ~0u };
 217
 218   /// Candidate map. Each edge bundle is assigned to a GlobalCand entry, or to
 219   /// NoCand which indicates the stack interval.
 220   SmallVector<unsigned, 32> BundleCand;
 221
 222 public:
 223   RAGreedy();
 224
 225   /// Return the pass name.
 226   virtual const char* getPassName() const {
 227     return "Greedy Register Allocator";
 228   }
 229
 230   /// RAGreedy analysis usage.
 231   virtual void getAnalysisUsage(AnalysisUsage &AU) const;
 232   virtual void releaseMemory();
 233   virtual Spiller &spiller() { return *SpillerInstance; }
 234   virtual void enqueue(LiveInterval *LI);
 235   virtual LiveInterval *dequeue();
 236   virtual unsigned selectOrSplit(LiveInterval&,
 237                                  SmallVectorImpl<LiveInterval*>&);
 238
 239   /// Perform register allocation.
 240   virtual bool runOnMachineFunction(MachineFunction &mf);
 241
 242   static char ID;
 243
 244 private:
 245   void LRE_WillEraseInstruction(MachineInstr*);
 246   bool LRE_CanEraseVirtReg(unsigned);
 247   void LRE_WillShrinkVirtReg(unsigned);
 248   void LRE_DidCloneVirtReg(unsigned, unsigned);
 249
 250   float calcSpillCost();
 251   bool addSplitConstraints(InterferenceCache::Cursor, float&);
 252   void addThroughConstraints(InterferenceCache::Cursor, ArrayRef<unsigned>);
 253   void growRegion(GlobalSplitCandidate &Cand);
 254   float calcGlobalSplitCost(GlobalSplitCandidate&);
 255   bool calcCompactRegion(GlobalSplitCandidate&);
 256   void splitAroundRegion(LiveRangeEdit&, ArrayRef<unsigned>);
 257   void calcGapWeights(unsigned, SmallVectorImpl<float>&);
 258   bool shouldEvict(LiveInterval &A, bool, LiveInterval &B, bool);
 259   bool canEvictInterference(LiveInterval&, unsigned, bool, EvictionCost&);
 260   void evictInterference(LiveInterval&, unsigned,
 261                          SmallVectorImpl<LiveInterval*>&);
 262
 263   unsigned tryAssign(LiveInterval&, AllocationOrder&,
 264                      SmallVectorImpl<LiveInterval*>&);
 265   unsigned tryEvict(LiveInterval&, AllocationOrder&,
 266                     SmallVectorImpl<LiveInterval*>&, unsigned = ~0u);
 267   unsigned tryRegionSplit(LiveInterval&, AllocationOrder&,
 268                           SmallVectorImpl<LiveInterval*>&);
 269   unsigned tryLocalSplit(LiveInterval&, AllocationOrder&,
 270     SmallVectorImpl<LiveInterval*>&);
 271   unsigned trySplit(LiveInterval&, AllocationOrder&,
 272                     SmallVectorImpl<LiveInterval*>&);
 273 };
 274 } // end anonymous namespace
 275
 276 char RAGreedy::ID = 0;
 277
 278 #ifndef NDEBUG
 279 const char *const RAGreedy::StageName[] = {
 280     "RS_New",
 281     "RS_Assign",
 282     "RS_Split",
 283     "RS_Split2",
 284     "RS_Spill",
 285     "RS_Done"
 286 };
 287 #endif
 288
 289 // Hysteresis to use when comparing floats.
 290 // This helps stabilize decisions based on float comparisons.
 291 const float Hysteresis = 0.98f;
 292
 293
 294 FunctionPass* llvm::createGreedyRegisterAllocator() {
 295   return new RAGreedy();
 296 }
 297
 298 RAGreedy::RAGreedy(): MachineFunctionPass(ID) {
 299   initializeLiveDebugVariablesPass(*PassRegistry::getPassRegistry());
 300   initializeSlotIndexesPass(*PassRegistry::getPassRegistry());
 301   initializeLiveIntervalsPass(*PassRegistry::getPassRegistry());
 302   initializeSlotIndexesPass(*PassRegistry::getPassRegistry());
 303   initializeStrongPHIEliminationPass(*PassRegistry::getPassRegistry());
 304   initializeRegisterCoalescerPass(*PassRegistry::getPassRegistry());
 305   initializeCalculateSpillWeightsPass(*PassRegistry::getPassRegistry());
 306   initializeLiveStacksPass(*PassRegistry::getPassRegistry());
 307   initializeMachineDominatorTreePass(*PassRegistry::getPassRegistry());
 308   initializeMachineLoopInfoPass(*PassRegistry::getPassRegistry());
 309   initializeVirtRegMapPass(*PassRegistry::getPassRegistry());
 310   initializeEdgeBundlesPass(*PassRegistry::getPassRegistry());
 311   initializeSpillPlacementPass(*PassRegistry::getPassRegistry());
 312 }
 313
 314 void RAGreedy::getAnalysisUsage(AnalysisUsage &AU) const {
 315   AU.setPreservesCFG();
 316   AU.addRequired<AliasAnalysis>();
 317   AU.addPreserved<AliasAnalysis>();
 318   AU.addRequired<LiveIntervals>();
 319   AU.addRequired<SlotIndexes>();
 320   AU.addPreserved<SlotIndexes>();
 321   AU.addRequired<LiveDebugVariables>();
 322   AU.addPreserved<LiveDebugVariables>();
 323   if (StrongPHIElim)
 324     AU.addRequiredID(StrongPHIEliminationID);
 325   AU.addRequiredTransitive<RegisterCoalescer>();
 326   AU.addRequired<CalculateSpillWeights>();
 327   AU.addRequired<LiveStacks>();
 328   AU.addPreserved<LiveStacks>();
 329   AU.addRequired<MachineDominatorTree>();
 330   AU.addPreserved<MachineDominatorTree>();
 331   AU.addRequired<MachineLoopInfo>();
 332   AU.addPreserved<MachineLoopInfo>();
 333   AU.addRequired<VirtRegMap>();
 334   AU.addPreserved<VirtRegMap>();
 335   AU.addRequired<EdgeBundles>();
 336   AU.addRequired<SpillPlacement>();
 337   MachineFunctionPass::getAnalysisUsage(AU);
 338 }
 339
 340
 341 //===----------------------------------------------------------------------===//
 342 //                     LiveRangeEdit delegate methods
 343 //===----------------------------------------------------------------------===//
 344
 345 void RAGreedy::LRE_WillEraseInstruction(MachineInstr *MI) {
 346   // LRE itself will remove from SlotIndexes and parent basic block.
 347   VRM->RemoveMachineInstrFromMaps(MI);
 348 }
 349
 350 bool RAGreedy::LRE_CanEraseVirtReg(unsigned VirtReg) {
 351   if (unsigned PhysReg = VRM->getPhys(VirtReg)) {
 352     unassign(LIS->getInterval(VirtReg), PhysReg);
 353     return true;
 354   }
 355   // Unassigned virtreg is probably in the priority queue.
 356   // RegAllocBase will erase it after dequeueing.
 357   return false;
 358 }
 359
 360 void RAGreedy::LRE_WillShrinkVirtReg(unsigned VirtReg) {
 361   unsigned PhysReg = VRM->getPhys(VirtReg);
 362   if (!PhysReg)
 363     return;
 364
 365   // Register is assigned, put it back on the queue for reassignment.
 366   LiveInterval &LI = LIS->getInterval(VirtReg);
 367   unassign(LI, PhysReg);
 368   enqueue(&LI);
 369 }
 370
 371 void RAGreedy::LRE_DidCloneVirtReg(unsigned New, unsigned Old) {
 372   // LRE may clone a virtual register because dead code elimination causes it to
 373   // be split into connected components. The new components are much smaller
 374   // than the original, so they should get a new chance at being assigned.
 375   // same stage as the parent.
 376   ExtraRegInfo[Old].Stage = RS_Assign;
 377   ExtraRegInfo.grow(New);
 378   ExtraRegInfo[New] = ExtraRegInfo[Old];
 379 }
 380
 381 void RAGreedy::releaseMemory() {
 382   SpillerInstance.reset(0);
 383   ExtraRegInfo.clear();
 384   GlobalCand.clear();
 385   RegAllocBase::releaseMemory();
 386 }
 387
 388 void RAGreedy::enqueue(LiveInterval *LI) {
 389   // Prioritize live ranges by size, assigning larger ranges first.
 390   // The queue holds (size, reg) pairs.
 391   const unsigned Size = LI->getSize();
 392   const unsigned Reg = LI->reg;
 393   assert(TargetRegisterInfo::isVirtualRegister(Reg) &&
 394          "Can only enqueue virtual registers");
 395   unsigned Prio;
 396
 397   ExtraRegInfo.grow(Reg);
 398   if (ExtraRegInfo[Reg].Stage == RS_New)
 399     ExtraRegInfo[Reg].Stage = RS_Assign;
 400
 401   if (ExtraRegInfo[Reg].Stage == RS_Split) {
 402     // Unsplit ranges that couldn't be allocated immediately are deferred until
 403     // everything else has been allocated. Long ranges are allocated last so
 404     // they are split against realistic interference.
 405     if (CompactRegions)
 406       Prio = Size;
 407     else
 408       Prio = (1u << 31) - Size;
 409   } else {
 410     // Everything else is allocated in long->short order. Long ranges that don't
 411     // fit should be spilled ASAP so they don't create interference.
 412     Prio = (1u << 31) + Size;
 413
 414     // Boost ranges that have a physical register hint.
 415     if (TargetRegisterInfo::isPhysicalRegister(VRM->getRegAllocPref(Reg)))
 416       Prio |= (1u << 30);
 417   }
 418
 419   Queue.push(std::make_pair(Prio, Reg));
 420 }
 421
 422 LiveInterval *RAGreedy::dequeue() {
 423   if (Queue.empty())
 424     return 0;
 425   LiveInterval *LI = &LIS->getInterval(Queue.top().second);
 426   Queue.pop();
 427   return LI;
 428 }
 429
 430
 431 //===----------------------------------------------------------------------===//
 432 //                            Direct Assignment
 433 //===----------------------------------------------------------------------===//
 434
 435 /// tryAssign - Try to assign VirtReg to an available register.
 436 unsigned RAGreedy::tryAssign(LiveInterval &VirtReg,
 437                              AllocationOrder &Order,
 438                              SmallVectorImpl<LiveInterval*> &NewVRegs) {
 439   Order.rewind();
 440   unsigned PhysReg;
 441   while ((PhysReg = Order.next()))
 442     if (!checkPhysRegInterference(VirtReg, PhysReg))
 443       break;
 444   if (!PhysReg || Order.isHint(PhysReg))
 445     return PhysReg;
 446
 447   // PhysReg is available, but there may be a better choice.
 448
 449   // If we missed a simple hint, try to cheaply evict interference from the
 450   // preferred register.
 451   if (unsigned Hint = MRI->getSimpleHint(VirtReg.reg))
 452     if (Order.isHint(Hint)) {
 453       DEBUG(dbgs() << "missed hint " << PrintReg(Hint, TRI) << '\n');
 454       EvictionCost MaxCost(1);
 455       if (canEvictInterference(VirtReg, Hint, true, MaxCost)) {
 456         evictInterference(VirtReg, Hint, NewVRegs);
 457         return Hint;
 458       }
 459     }
 460
 461   // Try to evict interference from a cheaper alternative.
 462   unsigned Cost = TRI->getCostPerUse(PhysReg);
 463
 464   // Most registers have 0 additional cost.
 465   if (!Cost)
 466     return PhysReg;
 467
 468   DEBUG(dbgs() << PrintReg(PhysReg, TRI) << " is available at cost " << Cost
 469                << '\n');
 470   unsigned CheapReg = tryEvict(VirtReg, Order, NewVRegs, Cost);
 471   return CheapReg ? CheapReg : PhysReg;
 472 }
 473
 474
 475 //===----------------------------------------------------------------------===//
 476 //                         Interference eviction
 477 //===----------------------------------------------------------------------===//
 478
 479 /// shouldEvict - determine if A should evict the assigned live range B. The
 480 /// eviction policy defined by this function together with the allocation order
 481 /// defined by enqueue() decides which registers ultimately end up being split
 482 /// and spilled.
 483 ///
 484 /// Cascade numbers are used to prevent infinite loops if this function is a
 485 /// cyclic relation.
 486 ///
 487 /// @param A          The live range to be assigned.
 488 /// @param IsHint     True when A is about to be assigned to its preferred
 489 ///                   register.
 490 /// @param B          The live range to be evicted.
 491 /// @param BreaksHint True when B is already assigned to its preferred register.
 492 bool RAGreedy::shouldEvict(LiveInterval &A, bool IsHint,
 493                            LiveInterval &B, bool BreaksHint) {
 494   bool CanSplit = getStage(B) < RS_Spill;
 495
 496   // Be fairly aggressive about following hints as long as the evictee can be
 497   // split.
 498   if (CanSplit && IsHint && !BreaksHint)
 499     return true;
 500
 501   return A.weight > B.weight;
 502 }
 503
 504 /// canEvictInterference - Return true if all interferences between VirtReg and
 505 /// PhysReg can be evicted.  When OnlyCheap is set, don't do anything
 506 ///
 507 /// @param VirtReg Live range that is about to be assigned.
 508 /// @param PhysReg Desired register for assignment.
 509 /// @prarm IsHint  True when PhysReg is VirtReg's preferred register.
 510 /// @param MaxCost Only look for cheaper candidates and update with new cost
 511 ///                when returning true.
 512 /// @returns True when interference can be evicted cheaper than MaxCost.
 513 bool RAGreedy::canEvictInterference(LiveInterval &VirtReg, unsigned PhysReg,
 514                                     bool IsHint, EvictionCost &MaxCost) {
 515   // Find VirtReg's cascade number. This will be unassigned if VirtReg was never
 516   // involved in an eviction before. If a cascade number was assigned, deny
 517   // evicting anything with the same or a newer cascade number. This prevents
 518   // infinite eviction loops.
 519   //
 520   // This works out so a register without a cascade number is allowed to evict
 521   // anything, and it can be evicted by anything.
 522   unsigned Cascade = ExtraRegInfo[VirtReg.reg].Cascade;
 523   if (!Cascade)
 524     Cascade = NextCascade;
 525
 526   EvictionCost Cost;
 527   for (const unsigned *AliasI = TRI->getOverlaps(PhysReg); *AliasI; ++AliasI) {
 528     LiveIntervalUnion::Query &Q = query(VirtReg, *AliasI);
 529     // If there is 10 or more interferences, chances are one is heavier.
 530     if (Q.collectInterferingVRegs(10) >= 10)
 531       return false;
 532
 533     // Check if any interfering live range is heavier than MaxWeight.
 534     for (unsigned i = Q.interferingVRegs().size(); i; --i) {
 535       LiveInterval *Intf = Q.interferingVRegs()[i - 1];
 536       if (TargetRegisterInfo::isPhysicalRegister(Intf->reg))
 537         return false;
 538       // Never evict spill products. They cannot split or spill.
 539       if (getStage(*Intf) == RS_Done)
 540         return false;
 541       // Once a live range becomes small enough, it is urgent that we find a
 542       // register for it. This is indicated by an infinite spill weight. These
 543       // urgent live ranges get to evict almost anything.
 544       bool Urgent = !VirtReg.isSpillable() && Intf->isSpillable();
 545       // Only evict older cascades or live ranges without a cascade.
 546       unsigned IntfCascade = ExtraRegInfo[Intf->reg].Cascade;
 547       if (Cascade <= IntfCascade) {
 548         if (!Urgent)
 549           return false;
 550         // We permit breaking cascades for urgent evictions. It should be the
 551         // last resort, though, so make it really expensive.
 552         Cost.BrokenHints += 10;
 553       }
 554       // Would this break a satisfied hint?
 555       bool BreaksHint = VRM->hasPreferredPhys(Intf->reg);
 556       // Update eviction cost.
 557       Cost.BrokenHints += BreaksHint;
 558       Cost.MaxWeight = std::max(Cost.MaxWeight, Intf->weight);
 559       // Abort if this would be too expensive.
 560       if (!(Cost < MaxCost))
 561         return false;
 562       // Finally, apply the eviction policy for non-urgent evictions.
 563       if (!Urgent && !shouldEvict(VirtReg, IsHint, *Intf, BreaksHint))
 564         return false;
 565     }
 566   }
 567   MaxCost = Cost;
 568   return true;
 569 }
 570
 571 /// evictInterference - Evict any interferring registers that prevent VirtReg
 572 /// from being assigned to Physreg. This assumes that canEvictInterference
 573 /// returned true.
 574 void RAGreedy::evictInterference(LiveInterval &VirtReg, unsigned PhysReg,
 575                                  SmallVectorImpl<LiveInterval*> &NewVRegs) {
 576   // Make sure that VirtReg has a cascade number, and assign that cascade
 577   // number to every evicted register. These live ranges than then only be
 578   // evicted by a newer cascade, preventing infinite loops.
 579   unsigned Cascade = ExtraRegInfo[VirtReg.reg].Cascade;
 580   if (!Cascade)
 581     Cascade = ExtraRegInfo[VirtReg.reg].Cascade = NextCascade++;
 582
 583   DEBUG(dbgs() << "evicting " << PrintReg(PhysReg, TRI)
 584                << " interference: Cascade " << Cascade << '\n');
 585   for (const unsigned *AliasI = TRI->getOverlaps(PhysReg); *AliasI; ++AliasI) {
 586     LiveIntervalUnion::Query &Q = query(VirtReg, *AliasI);
 587     assert(Q.seenAllInterferences() && "Didn't check all interfererences.");
 588     for (unsigned i = 0, e = Q.interferingVRegs().size(); i != e; ++i) {
 589       LiveInterval *Intf = Q.interferingVRegs()[i];
 590       unassign(*Intf, VRM->getPhys(Intf->reg));
 591       assert((ExtraRegInfo[Intf->reg].Cascade < Cascade ||
 592               VirtReg.isSpillable() < Intf->isSpillable()) &&
 593              "Cannot decrease cascade number, illegal eviction");
 594       ExtraRegInfo[Intf->reg].Cascade = Cascade;
 595       ++NumEvicted;
 596       NewVRegs.push_back(Intf);
 597     }
 598   }
 599 }
 600
 601 /// tryEvict - Try to evict all interferences for a physreg.
 602 /// @param  VirtReg Currently unassigned virtual register.
 603 /// @param  Order   Physregs to try.
 604 /// @return         Physreg to assign VirtReg, or 0.
 605 unsigned RAGreedy::tryEvict(LiveInterval &VirtReg,
 606                             AllocationOrder &Order,
 607                             SmallVectorImpl<LiveInterval*> &NewVRegs,
 608                             unsigned CostPerUseLimit) {
 609   NamedRegionTimer T("Evict", TimerGroupName, TimePassesIsEnabled);
 610
 611   // Keep track of the cheapest interference seen so far.
 612   EvictionCost BestCost(~0u);
 613   unsigned BestPhys = 0;
 614
 615   // When we are just looking for a reduced cost per use, don't break any
 616   // hints, and only evict smaller spill weights.
 617   if (CostPerUseLimit < ~0u) {
 618     BestCost.BrokenHints = 0;
 619     BestCost.MaxWeight = VirtReg.weight;
 620   }
 621
 622   Order.rewind();
 623   while (unsigned PhysReg = Order.next()) {
 624     if (TRI->getCostPerUse(PhysReg) >= CostPerUseLimit)
 625       continue;
 626     // The first use of a callee-saved register in a function has cost 1.
 627     // Don't start using a CSR when the CostPerUseLimit is low.
 628     if (CostPerUseLimit == 1)
 629      if (unsigned CSR = RegClassInfo.getLastCalleeSavedAlias(PhysReg))
 630        if (!MRI->isPhysRegUsed(CSR)) {
 631          DEBUG(dbgs() << PrintReg(PhysReg, TRI) << " would clobber CSR "
 632                       << PrintReg(CSR, TRI) << '\n');
 633          continue;
 634        }
 635
 636     if (!canEvictInterference(VirtReg, PhysReg, false, BestCost))
 637       continue;
 638
 639     // Best so far.
 640     BestPhys = PhysReg;
 641
 642     // Stop if the hint can be used.
 643     if (Order.isHint(PhysReg))
 644       break;
 645   }
 646
 647   if (!BestPhys)
 648     return 0;
 649
 650   evictInterference(VirtReg, BestPhys, NewVRegs);
 651   return BestPhys;
 652 }
 653
 654
 655 //===----------------------------------------------------------------------===//
 656 //                              Region Splitting
 657 //===----------------------------------------------------------------------===//
 658
 659 /// addSplitConstraints - Fill out the SplitConstraints vector based on the
 660 /// interference pattern in Physreg and its aliases. Add the constraints to
 661 /// SpillPlacement and return the static cost of this split in Cost, assuming
 662 /// that all preferences in SplitConstraints are met.
 663 /// Return false if there are no bundles with positive bias.
 664 bool RAGreedy::addSplitConstraints(InterferenceCache::Cursor Intf,
 665                                    float &Cost) {
 666   ArrayRef<SplitAnalysis::BlockInfo> UseBlocks = SA->getUseBlocks();
 667
 668   // Reset interference dependent info.
 669   SplitConstraints.resize(UseBlocks.size());
 670   float StaticCost = 0;
 671   for (unsigned i = 0; i != UseBlocks.size(); ++i) {
 672     const SplitAnalysis::BlockInfo &BI = UseBlocks[i];
 673     SpillPlacement::BlockConstraint &BC = SplitConstraints[i];
 674
 675     BC.Number = BI.MBB->getNumber();
 676     Intf.moveToBlock(BC.Number);
 677     BC.Entry = BI.LiveIn ? SpillPlacement::PrefReg : SpillPlacement::DontCare;
 678     BC.Exit = BI.LiveOut ? SpillPlacement::PrefReg : SpillPlacement::DontCare;
 679     BC.ChangesValue = BI.FirstDef;
 680
 681     if (!Intf.hasInterference())
 682       continue;
 683
 684     // Number of spill code instructions to insert.
 685     unsigned Ins = 0;
 686
 687     // Interference for the live-in value.
 688     if (BI.LiveIn) {
 689       if (Intf.first() <= Indexes->getMBBStartIdx(BC.Number))
 690         BC.Entry = SpillPlacement::MustSpill, ++Ins;
 691       else if (Intf.first() < BI.FirstInstr)
 692         BC.Entry = SpillPlacement::PrefSpill, ++Ins;
 693       else if (Intf.first() < BI.LastInstr)
 694         ++Ins;
 695     }
 696
 697     // Interference for the live-out value.
 698     if (BI.LiveOut) {
 699       if (Intf.last() >= SA->getLastSplitPoint(BC.Number))
 700         BC.Exit = SpillPlacement::MustSpill, ++Ins;
 701       else if (Intf.last() > BI.LastInstr)
 702         BC.Exit = SpillPlacement::PrefSpill, ++Ins;
 703       else if (Intf.last() > BI.FirstInstr)
 704         ++Ins;
 705     }
 706
 707     // Accumulate the total frequency of inserted spill code.
 708     if (Ins)
 709       StaticCost += Ins * SpillPlacer->getBlockFrequency(BC.Number);
 710   }
 711   Cost = StaticCost;
 712
 713   // Add constraints for use-blocks. Note that these are the only constraints
 714   // that may add a positive bias, it is downhill from here.
 715   SpillPlacer->addConstraints(SplitConstraints);
 716   return SpillPlacer->scanActiveBundles();
 717 }
 718
 719
 720 /// addThroughConstraints - Add constraints and links to SpillPlacer from the
 721 /// live-through blocks in Blocks.
 722 void RAGreedy::addThroughConstraints(InterferenceCache::Cursor Intf,
 723                                      ArrayRef<unsigned> Blocks) {
 724   const unsigned GroupSize = 8;
 725   SpillPlacement::BlockConstraint BCS[GroupSize];
 726   unsigned TBS[GroupSize];
 727   unsigned B = 0, T = 0;
 728
 729   for (unsigned i = 0; i != Blocks.size(); ++i) {
 730     unsigned Number = Blocks[i];
 731     Intf.moveToBlock(Number);
 732
 733     if (!Intf.hasInterference()) {
 734       assert(T < GroupSize && "Array overflow");
 735       TBS[T] = Number;
 736       if (++T == GroupSize) {
 737         SpillPlacer->addLinks(makeArrayRef(TBS, T));
 738         T = 0;
 739       }
 740       continue;
 741     }
 742
 743     assert(B < GroupSize && "Array overflow");
 744     BCS[B].Number = Number;
 745
 746     // Interference for the live-in value.
 747     if (Intf.first() <= Indexes->getMBBStartIdx(Number))
 748       BCS[B].Entry = SpillPlacement::MustSpill;
 749     else
 750       BCS[B].Entry = SpillPlacement::PrefSpill;
 751
 752     // Interference for the live-out value.
 753     if (Intf.last() >= SA->getLastSplitPoint(Number))
 754       BCS[B].Exit = SpillPlacement::MustSpill;
 755     else
 756       BCS[B].Exit = SpillPlacement::PrefSpill;
 757
 758     if (++B == GroupSize) {
 759       ArrayRef<SpillPlacement::BlockConstraint> Array(BCS, B);
 760       SpillPlacer->addConstraints(Array);
 761       B = 0;
 762     }
 763   }
 764
 765   ArrayRef<SpillPlacement::BlockConstraint> Array(BCS, B);
 766   SpillPlacer->addConstraints(Array);
 767   SpillPlacer->addLinks(makeArrayRef(TBS, T));
 768 }
 769
 770 void RAGreedy::growRegion(GlobalSplitCandidate &Cand) {
 771   // Keep track of through blocks that have not been added to SpillPlacer.
 772   BitVector Todo = SA->getThroughBlocks();
 773   SmallVectorImpl<unsigned> &ActiveBlocks = Cand.ActiveBlocks;
 774   unsigned AddedTo = 0;
 775 #ifndef NDEBUG
 776   unsigned Visited = 0;
 777 #endif
 778
 779   for (;;) {
 780     ArrayRef<unsigned> NewBundles = SpillPlacer->getRecentPositive();
 781     // Find new through blocks in the periphery of PrefRegBundles.
 782     for (int i = 0, e = NewBundles.size(); i != e; ++i) {
 783       unsigned Bundle = NewBundles[i];
 784       // Look at all blocks connected to Bundle in the full graph.
 785       ArrayRef<unsigned> Blocks = Bundles->getBlocks(Bundle);
 786       for (ArrayRef<unsigned>::iterator I = Blocks.begin(), E = Blocks.end();
 787            I != E; ++I) {
 788         unsigned Block = *I;
 789         if (!Todo.test(Block))
 790           continue;
 791         Todo.reset(Block);
 792         // This is a new through block. Add it to SpillPlacer later.
 793         ActiveBlocks.push_back(Block);
 794 #ifndef NDEBUG
 795         ++Visited;
 796 #endif
 797       }
 798     }
 799     // Any new blocks to add?
 800     if (ActiveBlocks.size() == AddedTo)
 801       break;
 802
 803     // Compute through constraints from the interference, or assume that all
 804     // through blocks prefer spilling when forming compact regions.
 805     ArrayRef<unsigned> NewBlocks = makeArrayRef(ActiveBlocks).slice(AddedTo);
 806     if (Cand.PhysReg)
 807       addThroughConstraints(Cand.Intf, NewBlocks);
 808     else
 809       SpillPlacer->addPrefSpill(NewBlocks);
 810     AddedTo = ActiveBlocks.size();
 811
 812     // Perhaps iterating can enable more bundles?
 813     SpillPlacer->iterate();
 814   }
 815   DEBUG(dbgs() << ", v=" << Visited);
 816 }
 817
 818 /// calcCompactRegion - Compute the set of edge bundles that should be live
 819 /// when splitting the current live range into compact regions.  Compact
 820 /// regions can be computed without looking at interference.  They are the
 821 /// regions formed by removing all the live-through blocks from the live range.
 822 ///
 823 /// Returns false if the current live range is already compact, or if the
 824 /// compact regions would form single block regions anyway.
 825 bool RAGreedy::calcCompactRegion(GlobalSplitCandidate &Cand) {
 826   // Without any through blocks, the live range is already compact.
 827   if (!SA->getNumThroughBlocks())
 828     return false;
 829
 830   // Compact regions don't correspond to any physreg.
 831   Cand.reset(IntfCache, 0);
 832
 833   DEBUG(dbgs() << "Compact region bundles");
 834
 835   // Use the spill placer to determine the live bundles. GrowRegion pretends
 836   // that all the through blocks have interference when PhysReg is unset.
 837   SpillPlacer->prepare(Cand.LiveBundles);
 838
 839   // The static split cost will be zero since Cand.Intf reports no interference.
 840   float Cost;
 841   if (!addSplitConstraints(Cand.Intf, Cost)) {
 842     DEBUG(dbgs() << ", none.\n");
 843     return false;
 844   }
 845
 846   growRegion(Cand);
 847   SpillPlacer->finish();
 848
 849   if (!Cand.LiveBundles.any()) {
 850     DEBUG(dbgs() << ", none.\n");
 851     return false;
 852   }
 853
 854   DEBUG({
 855     for (int i = Cand.LiveBundles.find_first(); i>=0;
 856          i = Cand.LiveBundles.find_next(i))
 857     dbgs() << " EB#" << i;
 858     dbgs() << ".\n";
 859   });
 860   return true;
 861 }
 862
 863 /// calcSpillCost - Compute how expensive it would be to split the live range in
 864 /// SA around all use blocks instead of forming bundle regions.
 865 float RAGreedy::calcSpillCost() {
 866   float Cost = 0;
 867   ArrayRef<SplitAnalysis::BlockInfo> UseBlocks = SA->getUseBlocks();
 868   for (unsigned i = 0; i != UseBlocks.size(); ++i) {
 869     const SplitAnalysis::BlockInfo &BI = UseBlocks[i];
 870     unsigned Number = BI.MBB->getNumber();
 871     // We normally only need one spill instruction - a load or a store.
 872     Cost += SpillPlacer->getBlockFrequency(Number);
 873
 874     // Unless the value is redefined in the block.
 875     if (BI.LiveIn && BI.LiveOut && BI.FirstDef)
 876       Cost += SpillPlacer->getBlockFrequency(Number);
 877   }
 878   return Cost;
 879 }
 880
 881 /// calcGlobalSplitCost - Return the global split cost of following the split
 882 /// pattern in LiveBundles. This cost should be added to the local cost of the
 883 /// interference pattern in SplitConstraints.
 884 ///
 885 float RAGreedy::calcGlobalSplitCost(GlobalSplitCandidate &Cand) {
 886   float GlobalCost = 0;
 887   const BitVector &LiveBundles = Cand.LiveBundles;
 888   ArrayRef<SplitAnalysis::BlockInfo> UseBlocks = SA->getUseBlocks();
 889   for (unsigned i = 0; i != UseBlocks.size(); ++i) {
 890     const SplitAnalysis::BlockInfo &BI = UseBlocks[i];
 891     SpillPlacement::BlockConstraint &BC = SplitConstraints[i];
 892     bool RegIn  = LiveBundles[Bundles->getBundle(BC.Number, 0)];
 893     bool RegOut = LiveBundles[Bundles->getBundle(BC.Number, 1)];
 894     unsigned Ins = 0;
 895
 896     if (BI.LiveIn)
 897       Ins += RegIn != (BC.Entry == SpillPlacement::PrefReg);
 898     if (BI.LiveOut)
 899       Ins += RegOut != (BC.Exit == SpillPlacement::PrefReg);
 900     if (Ins)
 901       GlobalCost += Ins * SpillPlacer->getBlockFrequency(BC.Number);
 902   }
 903
 904   for (unsigned i = 0, e = Cand.ActiveBlocks.size(); i != e; ++i) {
 905     unsigned Number = Cand.ActiveBlocks[i];
 906     bool RegIn  = LiveBundles[Bundles->getBundle(Number, 0)];
 907     bool RegOut = LiveBundles[Bundles->getBundle(Number, 1)];
 908     if (!RegIn && !RegOut)
 909       continue;
 910     if (RegIn && RegOut) {
 911       // We need double spill code if this block has interference.
 912       Cand.Intf.moveToBlock(Number);
 913       if (Cand.Intf.hasInterference())
 914         GlobalCost += 2*SpillPlacer->getBlockFrequency(Number);
 915       continue;
 916     }
 917     // live-in / stack-out or stack-in live-out.
 918     GlobalCost += SpillPlacer->getBlockFrequency(Number);
 919   }
 920   return GlobalCost;
 921 }
 922
 923 /// splitAroundRegion - Split the current live range around the regions
 924 /// determined by BundleCand and GlobalCand.
 925 ///
 926 /// Before calling this function, GlobalCand and BundleCand must be initialized
 927 /// so each bundle is assigned to a valid candidate, or NoCand for the
 928 /// stack-bound bundles.  The shared SA/SE SplitAnalysis and SplitEditor
 929 /// objects must be initialized for the current live range, and intervals
 930 /// created for the used candidates.
 931 ///
 932 /// @param LREdit    The LiveRangeEdit object handling the current split.
 933 /// @param UsedCands List of used GlobalCand entries. Every BundleCand value
 934 ///                  must appear in this list.
 935 void RAGreedy::splitAroundRegion(LiveRangeEdit &LREdit,
 936                                  ArrayRef<unsigned> UsedCands) {
 937   // These are the intervals created for new global ranges. We may create more
 938   // intervals for local ranges.
 939   const unsigned NumGlobalIntvs = LREdit.size();
 940   DEBUG(dbgs() << "splitAroundRegion with " << NumGlobalIntvs << " globals.\n");
 941   assert(NumGlobalIntvs && "No global intervals configured");
 942
 943   // First handle all the blocks with uses.
 944   ArrayRef<SplitAnalysis::BlockInfo> UseBlocks = SA->getUseBlocks();
 945   for (unsigned i = 0; i != UseBlocks.size(); ++i) {
 946     const SplitAnalysis::BlockInfo &BI = UseBlocks[i];
 947     unsigned Number = BI.MBB->getNumber();
 948     unsigned IntvIn = 0, IntvOut = 0;
 949     SlotIndex IntfIn, IntfOut;
 950     if (BI.LiveIn) {
 951       unsigned CandIn = BundleCand[Bundles->getBundle(Number, 0)];
 952       if (CandIn != NoCand) {
 953         GlobalSplitCandidate &Cand = GlobalCand[CandIn];
 954         IntvIn = Cand.IntvIdx;
 955         Cand.Intf.moveToBlock(Number);
 956         IntfIn = Cand.Intf.first();
 957       }
 958     }
 959     if (BI.LiveOut) {
 960       unsigned CandOut = BundleCand[Bundles->getBundle(Number, 1)];
 961       if (CandOut != NoCand) {
 962         GlobalSplitCandidate &Cand = GlobalCand[CandOut];
 963         IntvOut = Cand.IntvIdx;
 964         Cand.Intf.moveToBlock(Number);
 965         IntfOut = Cand.Intf.last();
 966       }
 967     }
 968
 969     // Create separate intervals for isolated blocks with multiple uses.
 970     if (!IntvIn && !IntvOut) {
 971       DEBUG(dbgs() << "BB#" << BI.MBB->getNumber() << " isolated.\n");
 972       if (!BI.isOneInstr())
 973         SE->splitSingleBlock(BI);
 974       continue;
 975     }
 976
 977     if (IntvIn && IntvOut)
 978       SE->splitLiveThroughBlock(Number, IntvIn, IntfIn, IntvOut, IntfOut);
 979     else if (IntvIn)
 980       SE->splitRegInBlock(BI, IntvIn, IntfIn);
 981     else
 982       SE->splitRegOutBlock(BI, IntvOut, IntfOut);
 983   }
 984
 985   // Handle live-through blocks. The relevant live-through blocks are stored in
 986   // the ActiveBlocks list with each candidate. We need to filter out
 987   // duplicates.
 988   BitVector Todo = SA->getThroughBlocks();
 989   for (unsigned c = 0; c != UsedCands.size(); ++c) {
 990     ArrayRef<unsigned> Blocks = GlobalCand[UsedCands[c]].ActiveBlocks;
 991     for (unsigned i = 0, e = Blocks.size(); i != e; ++i) {
 992       unsigned Number = Blocks[i];
 993       if (!Todo.test(Number))
 994         continue;
 995       Todo.reset(Number);
 996
 997       unsigned IntvIn = 0, IntvOut = 0;
 998       SlotIndex IntfIn, IntfOut;
 999
1000       unsigned CandIn = BundleCand[Bundles->getBundle(Number, 0)];
1001       if (CandIn != NoCand) {
1002         GlobalSplitCandidate &Cand = GlobalCand[CandIn];
1003         IntvIn = Cand.IntvIdx;
1004         Cand.Intf.moveToBlock(Number);
1005         IntfIn = Cand.Intf.first();
1006       }
1007
1008       unsigned CandOut = BundleCand[Bundles->getBundle(Number, 1)];
1009       if (CandOut != NoCand) {
1010         GlobalSplitCandidate &Cand = GlobalCand[CandOut];
1011         IntvOut = Cand.IntvIdx;
1012         Cand.Intf.moveToBlock(Number);
1013         IntfOut = Cand.Intf.last();
1014       }
1015       if (!IntvIn && !IntvOut)
1016         continue;
1017       SE->splitLiveThroughBlock(Number, IntvIn, IntfIn, IntvOut, IntfOut);
1018     }
1019   }
1020
1021   ++NumGlobalSplits;
1022
1023   SmallVector<unsigned, 8> IntvMap;
1024   SE->finish(&IntvMap);
1025   DebugVars->splitRegister(SA->getParent().reg, LREdit.regs());
1026
1027   ExtraRegInfo.resize(MRI->getNumVirtRegs());
1028   unsigned OrigBlocks = SA->getNumLiveBlocks();
1029
1030   // Sort out the new intervals created by splitting. We get four kinds:
1031   // - Remainder intervals should not be split again.
1032   // - Candidate intervals can be assigned to Cand.PhysReg.
1033   // - Block-local splits are candidates for local splitting.
1034   // - DCE leftovers should go back on the queue.
1035   for (unsigned i = 0, e = LREdit.size(); i != e; ++i) {
1036     LiveInterval &Reg = *LREdit.get(i);
1037
1038     // Ignore old intervals from DCE.
1039     if (getStage(Reg) != RS_New)
1040       continue;
1041
1042     // Remainder interval. Don't try splitting again, spill if it doesn't
1043     // allocate.
1044     if (IntvMap[i] == 0) {
1045       setStage(Reg, RS_Spill);
1046       continue;
1047     }
1048
1049     // Global intervals. Allow repeated splitting as long as the number of live
1050     // blocks is strictly decreasing.
1051     if (IntvMap[i] < NumGlobalIntvs) {
1052       if (SA->countLiveBlocks(&Reg) >= OrigBlocks) {
1053         DEBUG(dbgs() << "Main interval covers the same " << OrigBlocks
1054                      << " blocks as original.\n");
1055         // Don't allow repeated splitting as a safe guard against looping.
1056         setStage(Reg, RS_Split2);
1057       }
1058       continue;
1059     }
1060
1061     // Other intervals are treated as new. This includes local intervals created
1062     // for blocks with multiple uses, and anything created by DCE.
1063   }
1064
1065   if (VerifyEnabled)
1066     MF->verify(this, "After splitting live range around region");
1067 }
1068
1069 unsigned RAGreedy::tryRegionSplit(LiveInterval &VirtReg, AllocationOrder &Order,
1070                                   SmallVectorImpl<LiveInterval*> &NewVRegs) {
1071   unsigned NumCands = 0;
1072   unsigned BestCand = NoCand;
1073   float BestCost;
1074   SmallVector<unsigned, 8> UsedCands;
1075
1076   // Check if we can split this live range around a compact region.
1077   bool HasCompact = CompactRegions && calcCompactRegion(GlobalCand.front());
1078   if (HasCompact) {
1079     // Yes, keep GlobalCand[0] as the compact region candidate.
1080     NumCands = 1;
1081     BestCost = HUGE_VALF;
1082   } else {
1083     // No benefit from the compact region, our fallback will be per-block
1084     // splitting. Make sure we find a solution that is cheaper than spilling.
1085     BestCost = Hysteresis * calcSpillCost();
1086     DEBUG(dbgs() << "Cost of isolating all blocks = " << BestCost << '\n');
1087   }
1088
1089   Order.rewind();
1090   while (unsigned PhysReg = Order.next()) {
1091     // Discard bad candidates before we run out of interference cache cursors.
1092     // This will only affect register classes with a lot of registers (>32).
1093     if (NumCands == IntfCache.getMaxCursors()) {
1094       unsigned WorstCount = ~0u;
1095       unsigned Worst = 0;
1096       for (unsigned i = 0; i != NumCands; ++i) {
1097         if (i == BestCand || !GlobalCand[i].PhysReg)
1098           continue;
1099         unsigned Count = GlobalCand[i].LiveBundles.count();
1100         if (Count < WorstCount)
1101           Worst = i, WorstCount = Count;
1102       }
1103       --NumCands;
1104       GlobalCand[Worst] = GlobalCand[NumCands];
1105     }
1106
1107     if (GlobalCand.size() <= NumCands)
1108       GlobalCand.resize(NumCands+1);
1109     GlobalSplitCandidate &Cand = GlobalCand[NumCands];
1110     Cand.reset(IntfCache, PhysReg);
1111
1112     SpillPlacer->prepare(Cand.LiveBundles);
1113     float Cost;
1114     if (!addSplitConstraints(Cand.Intf, Cost)) {
1115       DEBUG(dbgs() << PrintReg(PhysReg, TRI) << "\tno positive bundles\n");
1116       continue;
1117     }
1118     DEBUG(dbgs() << PrintReg(PhysReg, TRI) << "\tstatic = " << Cost);
1119     if (Cost >= BestCost) {
1120       DEBUG({
1121         if (BestCand == NoCand)
1122           dbgs() << " worse than no bundles\n";
1123         else
1124           dbgs() << " worse than "
1125                  << PrintReg(GlobalCand[BestCand].PhysReg, TRI) << '\n';
1126       });
1127       continue;
1128     }
1129     growRegion(Cand);
1130
1131     SpillPlacer->finish();
1132
1133     // No live bundles, defer to splitSingleBlocks().
1134     if (!Cand.LiveBundles.any()) {
1135       DEBUG(dbgs() << " no bundles.\n");
1136       continue;
1137     }
1138
1139     Cost += calcGlobalSplitCost(Cand);
1140     DEBUG({
1141       dbgs() << ", total = " << Cost << " with bundles";
1142       for (int i = Cand.LiveBundles.find_first(); i>=0;
1143            i = Cand.LiveBundles.find_next(i))
1144         dbgs() << " EB#" << i;
1145       dbgs() << ".\n";
1146     });
1147     if (Cost < BestCost) {
1148       BestCand = NumCands;
1149       BestCost = Hysteresis * Cost; // Prevent rounding effects.
1150     }
1151     ++NumCands;
1152   }
1153
1154   // No solutions found, fall back to single block splitting.
1155   if (!HasCompact && BestCand == NoCand)
1156     return 0;
1157
1158   // Prepare split editor.
1159   LiveRangeEdit LREdit(VirtReg, NewVRegs, this);
1160   SE->reset(LREdit);
1161
1162   // Assign all edge bundles to the preferred candidate, or NoCand.
1163   BundleCand.assign(Bundles->getNumBundles(), NoCand);
1164
1165   // Assign bundles for the best candidate region.
1166   if (BestCand != NoCand) {
1167     GlobalSplitCandidate &Cand = GlobalCand[BestCand];
1168     if (unsigned B = Cand.getBundles(BundleCand, BestCand)) {
1169       UsedCands.push_back(BestCand);
1170       Cand.IntvIdx = SE->openIntv();
1171       DEBUG(dbgs() << "Split for " << PrintReg(Cand.PhysReg, TRI) << " in "
1172                    << B << " bundles, intv " << Cand.IntvIdx << ".\n");
1173     }
1174   }
1175
1176   // Assign bundles for the compact region.
1177   if (HasCompact) {
1178     GlobalSplitCandidate &Cand = GlobalCand.front();
1179     assert(!Cand.PhysReg && "Compact region has no physreg");
1180     if (unsigned B = Cand.getBundles(BundleCand, 0)) {
1181       UsedCands.push_back(0);
1182       Cand.IntvIdx = SE->openIntv();
1183       DEBUG(dbgs() << "Split for compact region in " << B << " bundles, intv "
1184                    << Cand.IntvIdx << ".\n");
1185     }
1186   }
1187
1188   splitAroundRegion(LREdit, UsedCands);
1189   return 0;
1190 }
1191
1192
1193 //===----------------------------------------------------------------------===//
1194 //                             Local Splitting
1195 //===----------------------------------------------------------------------===//
1196
1197
1198 /// calcGapWeights - Compute the maximum spill weight that needs to be evicted
1199 /// in order to use PhysReg between two entries in SA->UseSlots.
1200 ///
1201 /// GapWeight[i] represents the gap between UseSlots[i] and UseSlots[i+1].
1202 ///
1203 void RAGreedy::calcGapWeights(unsigned PhysReg,
1204                               SmallVectorImpl<float> &GapWeight) {
1205   assert(SA->getUseBlocks().size() == 1 && "Not a local interval");
1206   const SplitAnalysis::BlockInfo &BI = SA->getUseBlocks().front();
1207   const SmallVectorImpl<SlotIndex> &Uses = SA->UseSlots;
1208   const unsigned NumGaps = Uses.size()-1;
1209
1210   // Start and end points for the interference check.
1211   SlotIndex StartIdx =
1212     BI.LiveIn ? BI.FirstInstr.getBaseIndex() : BI.FirstInstr;
1213   SlotIndex StopIdx =
1214     BI.LiveOut ? BI.LastInstr.getBoundaryIndex() : BI.LastInstr;
1215
1216   GapWeight.assign(NumGaps, 0.0f);
1217
1218   // Add interference from each overlapping register.
1219   for (const unsigned *AI = TRI->getOverlaps(PhysReg); *AI; ++AI) {
1220     if (!query(const_cast<LiveInterval&>(SA->getParent()), *AI)
1221            .checkInterference())
1222       continue;
1223
1224     // We know that VirtReg is a continuous interval from FirstInstr to
1225     // LastInstr, so we don't need InterferenceQuery.
1226     //
1227     // Interference that overlaps an instruction is counted in both gaps
1228     // surrounding the instruction. The exception is interference before
1229     // StartIdx and after StopIdx.
1230     //
1231     LiveIntervalUnion::SegmentIter IntI = PhysReg2LiveUnion[*AI].find(StartIdx);
1232     for (unsigned Gap = 0; IntI.valid() && IntI.start() < StopIdx; ++IntI) {
1233       // Skip the gaps before IntI.
1234       while (Uses[Gap+1].getBoundaryIndex() < IntI.start())
1235         if (++Gap == NumGaps)
1236           break;
1237       if (Gap == NumGaps)
1238         break;
1239
1240       // Update the gaps covered by IntI.
1241       const float weight = IntI.value()->weight;
1242       for (; Gap != NumGaps; ++Gap) {
1243         GapWeight[Gap] = std::max(GapWeight[Gap], weight);
1244         if (Uses[Gap+1].getBaseIndex() >= IntI.stop())
1245           break;
1246       }
1247       if (Gap == NumGaps)
1248         break;
1249     }
1250   }
1251 }
1252
1253 /// tryLocalSplit - Try to split VirtReg into smaller intervals inside its only
1254 /// basic block.
1255 ///
1256 unsigned RAGreedy::tryLocalSplit(LiveInterval &VirtReg, AllocationOrder &Order,
1257                                  SmallVectorImpl<LiveInterval*> &NewVRegs) {
1258   assert(SA->getUseBlocks().size() == 1 && "Not a local interval");
1259   const SplitAnalysis::BlockInfo &BI = SA->getUseBlocks().front();
1260
1261   // Note that it is possible to have an interval that is live-in or live-out
1262   // while only covering a single block - A phi-def can use undef values from
1263   // predecessors, and the block could be a single-block loop.
1264   // We don't bother doing anything clever about such a case, we simply assume
1265   // that the interval is continuous from FirstInstr to LastInstr. We should
1266   // make sure that we don't do anything illegal to such an interval, though.
1267
1268   const SmallVectorImpl<SlotIndex> &Uses = SA->UseSlots;
1269   if (Uses.size() <= 2)
1270     return 0;
1271   const unsigned NumGaps = Uses.size()-1;
1272
1273   DEBUG({
1274     dbgs() << "tryLocalSplit: ";
1275     for (unsigned i = 0, e = Uses.size(); i != e; ++i)
1276       dbgs() << ' ' << SA->UseSlots[i];
1277     dbgs() << '\n';
1278   });
1279
1280   // Since we allow local split results to be split again, there is a risk of
1281   // creating infinite loops. It is tempting to require that the new live
1282   // ranges have less instructions than the original. That would guarantee
1283   // convergence, but it is too strict. A live range with 3 instructions can be
1284   // split 2+3 (including the COPY), and we want to allow that.
1285   //
1286   // Instead we use these rules:
1287   //
1288   // 1. Allow any split for ranges with getStage() < RS_Split2. (Except for the
1289   //    noop split, of course).
1290   // 2. Require progress be made for ranges with getStage() == RS_Split2. All
1291   //    the new ranges must have fewer instructions than before the split.
1292   // 3. New ranges with the same number of instructions are marked RS_Split2,
1293   //    smaller ranges are marked RS_New.
1294   //
1295   // These rules allow a 3 -> 2+3 split once, which we need. They also prevent
1296   // excessive splitting and infinite loops.
1297   //
1298   bool ProgressRequired = getStage(VirtReg) >= RS_Split2;
1299
1300   // Best split candidate.
1301   unsigned BestBefore = NumGaps;
1302   unsigned BestAfter = 0;
1303   float BestDiff = 0;
1304
1305   const float blockFreq = SpillPlacer->getBlockFrequency(BI.MBB->getNumber());
1306   SmallVector<float, 8> GapWeight;
1307
1308   Order.rewind();
1309   while (unsigned PhysReg = Order.next()) {
1310     // Keep track of the largest spill weight that would need to be evicted in
1311     // order to make use of PhysReg between UseSlots[i] and UseSlots[i+1].
1312     calcGapWeights(PhysReg, GapWeight);
1313
1314     // Try to find the best sequence of gaps to close.
1315     // The new spill weight must be larger than any gap interference.
1316
1317     // We will split before Uses[SplitBefore] and after Uses[SplitAfter].
1318     unsigned SplitBefore = 0, SplitAfter = 1;
1319
1320     // MaxGap should always be max(GapWeight[SplitBefore..SplitAfter-1]).
1321     // It is the spill weight that needs to be evicted.
1322     float MaxGap = GapWeight[0];
1323
1324     for (;;) {
1325       // Live before/after split?
1326       const bool LiveBefore = SplitBefore != 0 || BI.LiveIn;
1327       const bool LiveAfter = SplitAfter != NumGaps || BI.LiveOut;
1328
1329       DEBUG(dbgs() << PrintReg(PhysReg, TRI) << ' '
1330                    << Uses[SplitBefore] << '-' << Uses[SplitAfter]
1331                    << " i=" << MaxGap);
1332
1333       // Stop before the interval gets so big we wouldn't be making progress.
1334       if (!LiveBefore && !LiveAfter) {
1335         DEBUG(dbgs() << " all\n");
1336         break;
1337       }
1338       // Should the interval be extended or shrunk?
1339       bool Shrink = true;
1340
1341       // How many gaps would the new range have?
1342       unsigned NewGaps = LiveBefore + SplitAfter - SplitBefore + LiveAfter;
1343
1344       // Legally, without causing looping?
1345       bool Legal = !ProgressRequired || NewGaps < NumGaps;
1346
1347       if (Legal && MaxGap < HUGE_VALF) {
1348         // Estimate the new spill weight. Each instruction reads or writes the
1349         // register. Conservatively assume there are no read-modify-write
1350         // instructions.
1351         //
1352         // Try to guess the size of the new interval.
1353         const float EstWeight = normalizeSpillWeight(blockFreq * (NewGaps + 1),
1354                                  Uses[SplitBefore].distance(Uses[SplitAfter]) +
1355                                  (LiveBefore + LiveAfter)*SlotIndex::InstrDist);
1356         // Would this split be possible to allocate?
1357         // Never allocate all gaps, we wouldn't be making progress.
1358         DEBUG(dbgs() << " w=" << EstWeight);
1359         if (EstWeight * Hysteresis >= MaxGap) {
1360           Shrink = false;
1361           float Diff = EstWeight - MaxGap;
1362           if (Diff > BestDiff) {
1363             DEBUG(dbgs() << " (best)");
1364             BestDiff = Hysteresis * Diff;
1365             BestBefore = SplitBefore;
1366             BestAfter = SplitAfter;
1367           }
1368         }
1369       }
1370
1371       // Try to shrink.
1372       if (Shrink) {
1373         if (++SplitBefore < SplitAfter) {
1374           DEBUG(dbgs() << " shrink\n");
1375           // Recompute the max when necessary.
1376           if (GapWeight[SplitBefore - 1] >= MaxGap) {
1377             MaxGap = GapWeight[SplitBefore];
1378             for (unsigned i = SplitBefore + 1; i != SplitAfter; ++i)
1379               MaxGap = std::max(MaxGap, GapWeight[i]);
1380           }
1381           continue;
1382         }
1383         MaxGap = 0;
1384       }
1385
1386       // Try to extend the interval.
1387       if (SplitAfter >= NumGaps) {
1388         DEBUG(dbgs() << " end\n");
1389         break;
1390       }
1391
1392       DEBUG(dbgs() << " extend\n");
1393       MaxGap = std::max(MaxGap, GapWeight[SplitAfter++]);
1394     }
1395   }
1396
1397   // Didn't find any candidates?
1398   if (BestBefore == NumGaps)
1399     return 0;
1400
1401   DEBUG(dbgs() << "Best local split range: " << Uses[BestBefore]
1402                << '-' << Uses[BestAfter] << ", " << BestDiff
1403                << ", " << (BestAfter - BestBefore + 1) << " instrs\n");
1404
1405   LiveRangeEdit LREdit(VirtReg, NewVRegs, this);
1406   SE->reset(LREdit);
1407
1408   SE->openIntv();
1409   SlotIndex SegStart = SE->enterIntvBefore(Uses[BestBefore]);
1410   SlotIndex SegStop  = SE->leaveIntvAfter(Uses[BestAfter]);
1411   SE->useIntv(SegStart, SegStop);
1412   SmallVector<unsigned, 8> IntvMap;
1413   SE->finish(&IntvMap);
1414   DebugVars->splitRegister(VirtReg.reg, LREdit.regs());
1415
1416   // If the new range has the same number of instructions as before, mark it as
1417   // RS_Split2 so the next split will be forced to make progress. Otherwise,
1418   // leave the new intervals as RS_New so they can compete.
1419   bool LiveBefore = BestBefore != 0 || BI.LiveIn;
1420   bool LiveAfter = BestAfter != NumGaps || BI.LiveOut;
1421   unsigned NewGaps = LiveBefore + BestAfter - BestBefore + LiveAfter;
1422   if (NewGaps >= NumGaps) {
1423     DEBUG(dbgs() << "Tagging non-progress ranges: ");
1424     assert(!ProgressRequired && "Didn't make progress when it was required.");
1425     for (unsigned i = 0, e = IntvMap.size(); i != e; ++i)
1426       if (IntvMap[i] == 1) {
1427         setStage(*LREdit.get(i), RS_Split2);
1428         DEBUG(dbgs() << PrintReg(LREdit.get(i)->reg));
1429       }
1430     DEBUG(dbgs() << '\n');
1431   }
1432   ++NumLocalSplits;
1433
1434   return 0;
1435 }
1436
1437 //===----------------------------------------------------------------------===//
1438 //                          Live Range Splitting
1439 //===----------------------------------------------------------------------===//
1440
1441 /// trySplit - Try to split VirtReg or one of its interferences, making it
1442 /// assignable.
1443 /// @return Physreg when VirtReg may be assigned and/or new NewVRegs.
1444 unsigned RAGreedy::trySplit(LiveInterval &VirtReg, AllocationOrder &Order,
1445                             SmallVectorImpl<LiveInterval*>&NewVRegs) {
1446   // Local intervals are handled separately.
1447   if (LIS->intervalIsInOneMBB(VirtReg)) {
1448     NamedRegionTimer T("Local Splitting", TimerGroupName, TimePassesIsEnabled);
1449     SA->analyze(&VirtReg);
1450     return tryLocalSplit(VirtReg, Order, NewVRegs);
1451   }
1452
1453   NamedRegionTimer T("Global Splitting", TimerGroupName, TimePassesIsEnabled);
1454
1455   // Ranges must be Split2 or less.
1456   if (getStage(VirtReg) >= RS_Spill)
1457     return 0;
1458
1459   SA->analyze(&VirtReg);
1460
1461   // FIXME: SplitAnalysis may repair broken live ranges coming from the
1462   // coalescer. That may cause the range to become allocatable which means that
1463   // tryRegionSplit won't be making progress. This check should be replaced with
1464   // an assertion when the coalescer is fixed.
1465   if (SA->didRepairRange()) {
1466     // VirtReg has changed, so all cached queries are invalid.
1467     invalidateVirtRegs();
1468     if (unsigned PhysReg = tryAssign(VirtReg, Order, NewVRegs))
1469       return PhysReg;
1470   }
1471
1472   // First try to split around a region spanning multiple blocks. RS_Split2
1473   // ranges already made dubious progress with region splitting, so they go
1474   // straight to single block splitting.
1475   if (getStage(VirtReg) < RS_Split2) {
1476     unsigned PhysReg = tryRegionSplit(VirtReg, Order, NewVRegs);
1477     if (PhysReg || !NewVRegs.empty())
1478       return PhysReg;
1479   }
1480
1481   // Then isolate blocks with multiple uses.
1482   SplitAnalysis::BlockPtrSet Blocks;
1483   if (SA->getMultiUseBlocks(Blocks)) {
1484     LiveRangeEdit LREdit(VirtReg, NewVRegs, this);
1485     SE->reset(LREdit);
1486     SE->splitSingleBlocks(Blocks);
1487     setStage(NewVRegs.begin(), NewVRegs.end(), RS_Spill);
1488     if (VerifyEnabled)
1489       MF->verify(this, "After splitting live range around basic blocks");
1490   }
1491
1492   // Don't assign any physregs.
1493   return 0;
1494 }
1495
1496
1497 //===----------------------------------------------------------------------===//
1498 //                            Main Entry Point
1499 //===----------------------------------------------------------------------===//
1500
1501 unsigned RAGreedy::selectOrSplit(LiveInterval &VirtReg,
1502                                  SmallVectorImpl<LiveInterval*> &NewVRegs) {
1503   // First try assigning a free register.
1504   AllocationOrder Order(VirtReg.reg, *VRM, RegClassInfo);
1505   if (unsigned PhysReg = tryAssign(VirtReg, Order, NewVRegs))
1506     return PhysReg;
1507
1508   LiveRangeStage Stage = getStage(VirtReg);
1509   DEBUG(dbgs() << StageName[Stage]
1510                << " Cascade " << ExtraRegInfo[VirtReg.reg].Cascade << '\n');
1511
1512   // Try to evict a less worthy live range, but only for ranges from the primary
1513   // queue. The RS_Split ranges already failed to do this, and they should not
1514   // get a second chance until they have been split.
1515   if (Stage != RS_Split)
1516     if (unsigned PhysReg = tryEvict(VirtReg, Order, NewVRegs))
1517       return PhysReg;
1518
1519   assert(NewVRegs.empty() && "Cannot append to existing NewVRegs");
1520
1521   // The first time we see a live range, don't try to split or spill.
1522   // Wait until the second time, when all smaller ranges have been allocated.
1523   // This gives a better picture of the interference to split around.
1524   if (Stage < RS_Split) {
1525     setStage(VirtReg, RS_Split);
1526     DEBUG(dbgs() << "wait for second round\n");
1527     NewVRegs.push_back(&VirtReg);
1528     return 0;
1529   }
1530
1531   // If we couldn't allocate a register from spilling, there is probably some
1532   // invalid inline assembly. The base class wil report it.
1533   if (Stage >= RS_Done || !VirtReg.isSpillable())
1534     return ~0u;
1535
1536   // Try splitting VirtReg or interferences.
1537   unsigned PhysReg = trySplit(VirtReg, Order, NewVRegs);
1538   if (PhysReg || !NewVRegs.empty())
1539     return PhysReg;
1540
1541   // Finally spill VirtReg itself.
1542   NamedRegionTimer T("Spiller", TimerGroupName, TimePassesIsEnabled);
1543   LiveRangeEdit LRE(VirtReg, NewVRegs, this);
1544   spiller().spill(LRE);
1545   setStage(NewVRegs.begin(), NewVRegs.end(), RS_Done);
1546
1547   if (VerifyEnabled)
1548     MF->verify(this, "After spilling");
1549
1550   // The live virtual register requesting allocation was spilled, so tell
1551   // the caller not to allocate anything during this round.
1552   return 0;
1553 }
1554
1555 bool RAGreedy::runOnMachineFunction(MachineFunction &mf) {
1556   DEBUG(dbgs() << "********** GREEDY REGISTER ALLOCATION **********\n"
1557                << "********** Function: "
1558                << ((Value*)mf.getFunction())->getName() << '\n');
1559
1560   MF = &mf;
1561   if (VerifyEnabled)
1562     MF->verify(this, "Before greedy register allocator");
1563
1564   RegAllocBase::init(getAnalysis<VirtRegMap>(), getAnalysis<LiveIntervals>());
1565   Indexes = &getAnalysis<SlotIndexes>();
1566   DomTree = &getAnalysis<MachineDominatorTree>();
1567   SpillerInstance.reset(createInlineSpiller(*this, *MF, *VRM));
1568   Loops = &getAnalysis<MachineLoopInfo>();
1569   Bundles = &getAnalysis<EdgeBundles>();
1570   SpillPlacer = &getAnalysis<SpillPlacement>();
1571   DebugVars = &getAnalysis<LiveDebugVariables>();
1572
1573   SA.reset(new SplitAnalysis(*VRM, *LIS, *Loops));
1574   SE.reset(new SplitEditor(*SA, *LIS, *VRM, *DomTree));
1575   ExtraRegInfo.clear();
1576   ExtraRegInfo.resize(MRI->getNumVirtRegs());
1577   NextCascade = 1;
1578   IntfCache.init(MF, &PhysReg2LiveUnion[0], Indexes, TRI);
1579   GlobalCand.resize(32);  // This will grow as needed.
1580
1581   allocatePhysRegs();
1582   addMBBLiveIns(MF);
1583   LIS->addKillFlags();
1584
1585   // Run rewriter
1586   {
1587     NamedRegionTimer T("Rewriter", TimerGroupName, TimePassesIsEnabled);
1588     VRM->rewrite(Indexes);
1589   }
1590
1591   // Write out new DBG_VALUE instructions.
1592   {
1593     NamedRegionTimer T("Emit Debug Info", TimerGroupName, TimePassesIsEnabled);
1594     DebugVars->emitDebugValues(VRM);
1595   }
1596
1597   // The pass output is in VirtRegMap. Release all the transient data.
1598   releaseMemory();
1599
1600   return true;
1601 }