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