lib/CodeGen/InlineSpiller.cpp

   1 //===-------- InlineSpiller.cpp - Insert spills and restores inline -------===//
   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 // The inline spiller modifies the machine function directly instead of
  11 // inserting spills and restores in VirtRegMap.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "regalloc"
  16 #include "Spiller.h"
  17 #include "LiveRangeEdit.h"
  18 #include "VirtRegMap.h"
  19 #include "llvm/Analysis/AliasAnalysis.h"
  20 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  21 #include "llvm/CodeGen/LiveStackAnalysis.h"
  22 #include "llvm/CodeGen/MachineDominators.h"
  23 #include "llvm/CodeGen/MachineFrameInfo.h"
  24 #include "llvm/CodeGen/MachineFunction.h"
  25 #include "llvm/CodeGen/MachineLoopInfo.h"
  26 #include "llvm/CodeGen/MachineRegisterInfo.h"
  27 #include "llvm/Target/TargetMachine.h"
  28 #include "llvm/Target/TargetInstrInfo.h"
  29 #include "llvm/Support/Debug.h"
  30 #include "llvm/Support/raw_ostream.h"
  31
  32 using namespace llvm;
  33
  34 namespace {
  35 class InlineSpiller : public Spiller {
  36   MachineFunctionPass &Pass;
  37   MachineFunction &MF;
  38   LiveIntervals &LIS;
  39   LiveStacks &LSS;
  40   AliasAnalysis *AA;
  41   MachineDominatorTree &MDT;
  42   MachineLoopInfo &Loops;
  43   VirtRegMap &VRM;
  44   MachineFrameInfo &MFI;
  45   MachineRegisterInfo &MRI;
  46   const TargetInstrInfo &TII;
  47   const TargetRegisterInfo &TRI;
  48
  49   // Variables that are valid during spill(), but used by multiple methods.
  50   LiveRangeEdit *Edit;
  51   LiveInterval *StackInt;
  52   int StackSlot;
  53   unsigned Original;
  54
  55   // All registers to spill to StackSlot, including the main register.
  56   SmallVector<unsigned, 8> RegsToSpill;
  57
  58   // All COPY instructions to/from snippets.
  59   // They are ignored since both operands refer to the same stack slot.
  60   SmallPtrSet<MachineInstr*, 8> SnippetCopies;
  61
  62   // Values that failed to remat at some point.
  63   SmallPtrSet<VNInfo*, 8> UsedValues;
  64
  65   // Information about a value that was defined by a copy from a sibling
  66   // register.
  67   struct SibValueInfo {
  68     // True when all reaching defs were reloads: No spill is necessary.
  69     bool AllDefsAreReloads;
  70
  71     // The preferred register to spill.
  72     unsigned SpillReg;
  73
  74     // The value of SpillReg that should be spilled.
  75     VNInfo *SpillVNI;
  76
  77     // A defining instruction that is not a sibling copy or a reload, or NULL.
  78     // This can be used as a template for rematerialization.
  79     MachineInstr *DefMI;
  80
  81     SibValueInfo(unsigned Reg, VNInfo *VNI)
  82       : AllDefsAreReloads(false), SpillReg(Reg), SpillVNI(VNI), DefMI(0) {}
  83   };
  84
  85   // Values in RegsToSpill defined by sibling copies.
  86   typedef DenseMap<VNInfo*, SibValueInfo> SibValueMap;
  87   SibValueMap SibValues;
  88
  89   // Dead defs generated during spilling.
  90   SmallVector<MachineInstr*, 8> DeadDefs;
  91
  92   ~InlineSpiller() {}
  93
  94 public:
  95   InlineSpiller(MachineFunctionPass &pass,
  96                 MachineFunction &mf,
  97                 VirtRegMap &vrm)
  98     : Pass(pass),
  99       MF(mf),
 100       LIS(pass.getAnalysis<LiveIntervals>()),
 101       LSS(pass.getAnalysis<LiveStacks>()),
 102       AA(&pass.getAnalysis<AliasAnalysis>()),
 103       MDT(pass.getAnalysis<MachineDominatorTree>()),
 104       Loops(pass.getAnalysis<MachineLoopInfo>()),
 105       VRM(vrm),
 106       MFI(*mf.getFrameInfo()),
 107       MRI(mf.getRegInfo()),
 108       TII(*mf.getTarget().getInstrInfo()),
 109       TRI(*mf.getTarget().getRegisterInfo()) {}
 110
 111   void spill(LiveRangeEdit &);
 112
 113 private:
 114   bool isSnippet(const LiveInterval &SnipLI);
 115   void collectRegsToSpill();
 116
 117   bool isRegToSpill(unsigned Reg) {
 118     return std::find(RegsToSpill.begin(),
 119                      RegsToSpill.end(), Reg) != RegsToSpill.end();
 120   }
 121
 122   bool isSibling(unsigned Reg);
 123   MachineInstr *traceSiblingValue(unsigned, VNInfo*, VNInfo*);
 124   void analyzeSiblingValues();
 125
 126   bool hoistSpill(LiveInterval &SpillLI, MachineInstr *CopyMI);
 127   void eliminateRedundantSpills(LiveInterval &LI, VNInfo *VNI);
 128
 129   void markValueUsed(LiveInterval*, VNInfo*);
 130   bool reMaterializeFor(LiveInterval&, MachineBasicBlock::iterator MI);
 131   void reMaterializeAll();
 132
 133   bool coalesceStackAccess(MachineInstr *MI, unsigned Reg);
 134   bool foldMemoryOperand(MachineBasicBlock::iterator MI,
 135                          const SmallVectorImpl<unsigned> &Ops,
 136                          MachineInstr *LoadMI = 0);
 137   void insertReload(LiveInterval &NewLI, SlotIndex,
 138                     MachineBasicBlock::iterator MI);
 139   void insertSpill(LiveInterval &NewLI, const LiveInterval &OldLI,
 140                    SlotIndex, MachineBasicBlock::iterator MI);
 141
 142   void spillAroundUses(unsigned Reg);
 143   void spillAll();
 144 };
 145 }
 146
 147 namespace llvm {
 148 Spiller *createInlineSpiller(MachineFunctionPass &pass,
 149                              MachineFunction &mf,
 150                              VirtRegMap &vrm) {
 151   return new InlineSpiller(pass, mf, vrm);
 152 }
 153 }
 154
 155 //===----------------------------------------------------------------------===//
 156 //                                Snippets
 157 //===----------------------------------------------------------------------===//
 158
 159 // When spilling a virtual register, we also spill any snippets it is connected
 160 // to. The snippets are small live ranges that only have a single real use,
 161 // leftovers from live range splitting. Spilling them enables memory operand
 162 // folding or tightens the live range around the single use.
 163 //
 164 // This minimizes register pressure and maximizes the store-to-load distance for
 165 // spill slots which can be important in tight loops.
 166
 167 /// isFullCopyOf - If MI is a COPY to or from Reg, return the other register,
 168 /// otherwise return 0.
 169 static unsigned isFullCopyOf(const MachineInstr *MI, unsigned Reg) {
 170   if (!MI->isCopy())
 171     return 0;
 172   if (MI->getOperand(0).getSubReg() != 0)
 173     return 0;
 174   if (MI->getOperand(1).getSubReg() != 0)
 175     return 0;
 176   if (MI->getOperand(0).getReg() == Reg)
 177       return MI->getOperand(1).getReg();
 178   if (MI->getOperand(1).getReg() == Reg)
 179       return MI->getOperand(0).getReg();
 180   return 0;
 181 }
 182
 183 /// isSnippet - Identify if a live interval is a snippet that should be spilled.
 184 /// It is assumed that SnipLI is a virtual register with the same original as
 185 /// Edit->getReg().
 186 bool InlineSpiller::isSnippet(const LiveInterval &SnipLI) {
 187   unsigned Reg = Edit->getReg();
 188
 189   // A snippet is a tiny live range with only a single instruction using it
 190   // besides copies to/from Reg or spills/fills. We accept:
 191   //
 192   //   %snip = COPY %Reg / FILL fi#
 193   //   %snip = USE %snip
 194   //   %Reg = COPY %snip / SPILL %snip, fi#
 195   //
 196   if (SnipLI.getNumValNums() > 2 || !LIS.intervalIsInOneMBB(SnipLI))
 197     return false;
 198
 199   MachineInstr *UseMI = 0;
 200
 201   // Check that all uses satisfy our criteria.
 202   for (MachineRegisterInfo::reg_nodbg_iterator
 203          RI = MRI.reg_nodbg_begin(SnipLI.reg);
 204        MachineInstr *MI = RI.skipInstruction();) {
 205
 206     // Allow copies to/from Reg.
 207     if (isFullCopyOf(MI, Reg))
 208       continue;
 209
 210     // Allow stack slot loads.
 211     int FI;
 212     if (SnipLI.reg == TII.isLoadFromStackSlot(MI, FI) && FI == StackSlot)
 213       continue;
 214
 215     // Allow stack slot stores.
 216     if (SnipLI.reg == TII.isStoreToStackSlot(MI, FI) && FI == StackSlot)
 217       continue;
 218
 219     // Allow a single additional instruction.
 220     if (UseMI && MI != UseMI)
 221       return false;
 222     UseMI = MI;
 223   }
 224   return true;
 225 }
 226
 227 /// collectRegsToSpill - Collect live range snippets that only have a single
 228 /// real use.
 229 void InlineSpiller::collectRegsToSpill() {
 230   unsigned Reg = Edit->getReg();
 231
 232   // Main register always spills.
 233   RegsToSpill.assign(1, Reg);
 234   SnippetCopies.clear();
 235
 236   // Snippets all have the same original, so there can't be any for an original
 237   // register.
 238   if (Original == Reg)
 239     return;
 240
 241   for (MachineRegisterInfo::reg_iterator RI = MRI.reg_begin(Reg);
 242        MachineInstr *MI = RI.skipInstruction();) {
 243     unsigned SnipReg = isFullCopyOf(MI, Reg);
 244     if (!isSibling(SnipReg))
 245       continue;
 246     LiveInterval &SnipLI = LIS.getInterval(SnipReg);
 247     if (!isSnippet(SnipLI))
 248       continue;
 249     SnippetCopies.insert(MI);
 250     if (!isRegToSpill(SnipReg))
 251       RegsToSpill.push_back(SnipReg);
 252
 253     DEBUG(dbgs() << "\talso spill snippet " << SnipLI << '\n');
 254   }
 255 }
 256
 257
 258 //===----------------------------------------------------------------------===//
 259 //                            Sibling Values
 260 //===----------------------------------------------------------------------===//
 261
 262 // After live range splitting, some values to be spilled may be defined by
 263 // copies from sibling registers. We trace the sibling copies back to the
 264 // original value if it still exists. We need it for rematerialization.
 265 //
 266 // Even when the value can't be rematerialized, we still want to determine if
 267 // the value has already been spilled, or we may want to hoist the spill from a
 268 // loop.
 269
 270 bool InlineSpiller::isSibling(unsigned Reg) {
 271   return TargetRegisterInfo::isVirtualRegister(Reg) &&
 272            VRM.getOriginal(Reg) == Original;
 273 }
 274
 275 /// traceSiblingValue - Trace a value that is about to be spilled back to the
 276 /// real defining instructions by looking through sibling copies. Always stay
 277 /// within the range of OrigVNI so the registers are known to carry the same
 278 /// value.
 279 ///
 280 /// Determine if the value is defined by all reloads, so spilling isn't
 281 /// necessary - the value is already in the stack slot.
 282 ///
 283 /// Return a defining instruction that may be a candidate for rematerialization.
 284 ///
 285 MachineInstr *InlineSpiller::traceSiblingValue(unsigned UseReg, VNInfo *UseVNI,
 286                                                VNInfo *OrigVNI) {
 287   DEBUG(dbgs() << "Tracing value " << PrintReg(UseReg) << ':'
 288                << UseVNI->id << '@' << UseVNI->def << '\n');
 289   SmallPtrSet<VNInfo*, 8> Visited;
 290   SmallVector<std::pair<unsigned, VNInfo*>, 8> WorkList;
 291   WorkList.push_back(std::make_pair(UseReg, UseVNI));
 292
 293   // Best spill candidate seen so far. This must dominate UseVNI.
 294   SibValueInfo SVI(UseReg, UseVNI);
 295   MachineBasicBlock *UseMBB = LIS.getMBBFromIndex(UseVNI->def);
 296   unsigned SpillDepth = Loops.getLoopDepth(UseMBB);
 297   bool SeenOrigPHI = false; // Original PHI met.
 298
 299   do {
 300     unsigned Reg;
 301     VNInfo *VNI;
 302     tie(Reg, VNI) = WorkList.pop_back_val();
 303     if (!Visited.insert(VNI))
 304       continue;
 305
 306     // Is this value a better spill candidate?
 307     if (!isRegToSpill(Reg)) {
 308       MachineBasicBlock *MBB = LIS.getMBBFromIndex(VNI->def);
 309       if (MBB != UseMBB && MDT.dominates(MBB, UseMBB)) {
 310         // This is a valid spill location dominating UseVNI.
 311         // Prefer to spill at a smaller loop depth.
 312         unsigned Depth = Loops.getLoopDepth(MBB);
 313         if (Depth < SpillDepth) {
 314           DEBUG(dbgs() << "  spill depth " << Depth << ": " << PrintReg(Reg)
 315                        << ':' << VNI->id << '@' << VNI->def << '\n');
 316           SVI.SpillReg = Reg;
 317           SVI.SpillVNI = VNI;
 318           SpillDepth = Depth;
 319         }
 320       }
 321     }
 322
 323     // Trace through PHI-defs created by live range splitting.
 324     if (VNI->isPHIDef()) {
 325       if (VNI->def == OrigVNI->def) {
 326         DEBUG(dbgs() << "  orig phi value " << PrintReg(Reg) << ':'
 327                      << VNI->id << '@' << VNI->def << '\n');
 328         SeenOrigPHI = true;
 329         continue;
 330       }
 331       // Get values live-out of predecessors.
 332       LiveInterval &LI = LIS.getInterval(Reg);
 333       MachineBasicBlock *MBB = LIS.getMBBFromIndex(VNI->def);
 334       for (MachineBasicBlock::pred_iterator PI = MBB->pred_begin(),
 335              PE = MBB->pred_end(); PI != PE; ++PI) {
 336         VNInfo *PVNI = LI.getVNInfoAt(LIS.getMBBEndIdx(*PI).getPrevSlot());
 337         if (PVNI)
 338           WorkList.push_back(std::make_pair(Reg, PVNI));
 339       }
 340       continue;
 341     }
 342
 343     MachineInstr *MI = LIS.getInstructionFromIndex(VNI->def);
 344     assert(MI && "Missing def");
 345
 346     // Trace through sibling copies.
 347     if (unsigned SrcReg = isFullCopyOf(MI, Reg)) {
 348       if (isSibling(SrcReg)) {
 349         LiveInterval &SrcLI = LIS.getInterval(SrcReg);
 350         VNInfo *SrcVNI = SrcLI.getVNInfoAt(VNI->def.getUseIndex());
 351         assert(SrcVNI && "Copy from non-existing value");
 352         DEBUG(dbgs() << "  copy of " << PrintReg(SrcReg) << ':'
 353                      << SrcVNI->id << '@' << SrcVNI->def << '\n');
 354         WorkList.push_back(std::make_pair(SrcReg, SrcVNI));
 355         continue;
 356       }
 357     }
 358
 359     // Track reachable reloads.
 360     int FI;
 361     if (Reg == TII.isLoadFromStackSlot(MI, FI) && FI == StackSlot) {
 362       DEBUG(dbgs() << "  reload " << PrintReg(Reg) << ':'
 363                    << VNI->id << "@" << VNI->def << '\n');
 364       SVI.AllDefsAreReloads = true;
 365       continue;
 366     }
 367
 368     // We have an 'original' def. Don't record trivial cases.
 369     if (VNI == UseVNI) {
 370       DEBUG(dbgs() << "Not a sibling copy.\n");
 371       return MI;
 372     }
 373
 374     // Potential remat candidate.
 375     DEBUG(dbgs() << "  def " << PrintReg(Reg) << ':'
 376                  << VNI->id << '@' << VNI->def << '\t' << *MI);
 377     SVI.DefMI = MI;
 378   } while (!WorkList.empty());
 379
 380   if (SeenOrigPHI || SVI.DefMI)
 381     SVI.AllDefsAreReloads = false;
 382
 383   DEBUG({
 384     if (SVI.AllDefsAreReloads)
 385       dbgs() << "All defs are reloads.\n";
 386     else
 387       dbgs() << "Prefer to spill " << PrintReg(SVI.SpillReg) << ':'
 388              << SVI.SpillVNI->id << '@' << SVI.SpillVNI->def << '\n';
 389   });
 390   SibValues.insert(std::make_pair(UseVNI, SVI));
 391   return SVI.DefMI;
 392 }
 393
 394 /// analyzeSiblingValues - Trace values defined by sibling copies back to
 395 /// something that isn't a sibling copy.
 396 ///
 397 /// Keep track of values that may be rematerializable.
 398 void InlineSpiller::analyzeSiblingValues() {
 399   SibValues.clear();
 400
 401   // No siblings at all?
 402   if (Edit->getReg() == Original)
 403     return;
 404
 405   LiveInterval &OrigLI = LIS.getInterval(Original);
 406   for (unsigned i = 0, e = RegsToSpill.size(); i != e; ++i) {
 407     unsigned Reg = RegsToSpill[i];
 408     LiveInterval &LI = LIS.getInterval(Reg);
 409     for (LiveInterval::const_vni_iterator VI = LI.vni_begin(),
 410          VE = LI.vni_end(); VI != VE; ++VI) {
 411       VNInfo *VNI = *VI;
 412       if (VNI->isUnused())
 413         continue;
 414       MachineInstr *DefMI = 0;
 415       // Check possible sibling copies.
 416       if (VNI->isPHIDef() || VNI->getCopy()) {
 417         VNInfo *OrigVNI = OrigLI.getVNInfoAt(VNI->def);
 418         if (OrigVNI->def != VNI->def)
 419           DefMI = traceSiblingValue(Reg, VNI, OrigVNI);
 420       }
 421       if (!DefMI && !VNI->isPHIDef())
 422         DefMI = LIS.getInstructionFromIndex(VNI->def);
 423       if (DefMI)
 424         Edit->checkRematerializable(VNI, DefMI, TII, AA);
 425     }
 426   }
 427 }
 428
 429 /// hoistSpill - Given a sibling copy that defines a value to be spilled, insert
 430 /// a spill at a better location.
 431 bool InlineSpiller::hoistSpill(LiveInterval &SpillLI, MachineInstr *CopyMI) {
 432   SlotIndex Idx = LIS.getInstructionIndex(CopyMI);
 433   VNInfo *VNI = SpillLI.getVNInfoAt(Idx.getDefIndex());
 434   assert(VNI && VNI->def == Idx.getDefIndex() && "Not defined by copy");
 435   SibValueMap::const_iterator I = SibValues.find(VNI);
 436   if (I == SibValues.end())
 437     return false;
 438
 439   const SibValueInfo &SVI = I->second;
 440
 441   // Let the normal folding code deal with the boring case.
 442   if (!SVI.AllDefsAreReloads && SVI.SpillVNI == VNI)
 443     return false;
 444
 445   // Conservatively extend the stack slot range to the range of the original
 446   // value. We may be able to do better with stack slot coloring by being more
 447   // careful here.
 448   assert(StackInt && "No stack slot assigned yet.");
 449   LiveInterval &OrigLI = LIS.getInterval(Original);
 450   VNInfo *OrigVNI = OrigLI.getVNInfoAt(Idx);
 451   StackInt->MergeValueInAsValue(OrigLI, OrigVNI, StackInt->getValNumInfo(0));
 452   DEBUG(dbgs() << "\tmerged orig valno " << OrigVNI->id << ": "
 453                << *StackInt << '\n');
 454
 455   // Already spilled everywhere.
 456   if (SVI.AllDefsAreReloads)
 457     return true;
 458
 459   // We are going to spill SVI.SpillVNI immediately after its def, so clear out
 460   // any later spills of the same value.
 461   eliminateRedundantSpills(LIS.getInterval(SVI.SpillReg), SVI.SpillVNI);
 462
 463   MachineBasicBlock *MBB = LIS.getMBBFromIndex(SVI.SpillVNI->def);
 464   MachineBasicBlock::iterator MII;
 465   if (SVI.SpillVNI->isPHIDef())
 466     MII = MBB->SkipPHIsAndLabels(MBB->begin());
 467   else {
 468     MII = LIS.getInstructionFromIndex(SVI.SpillVNI->def);
 469     ++MII;
 470   }
 471   // Insert spill without kill flag immediately after def.
 472   TII.storeRegToStackSlot(*MBB, MII, SVI.SpillReg, false, StackSlot,
 473                           MRI.getRegClass(SVI.SpillReg), &TRI);
 474   --MII; // Point to store instruction.
 475   LIS.InsertMachineInstrInMaps(MII);
 476   VRM.addSpillSlotUse(StackSlot, MII);
 477   DEBUG(dbgs() << "\thoisted: " << SVI.SpillVNI->def << '\t' << *MII);
 478   return true;
 479 }
 480
 481 /// eliminateRedundantSpills - SLI:VNI is known to be on the stack. Remove any
 482 /// redundant spills of this value in SLI.reg and sibling copies.
 483 void InlineSpiller::eliminateRedundantSpills(LiveInterval &SLI, VNInfo *VNI) {
 484   assert(VNI && "Missing value");
 485   SmallVector<std::pair<LiveInterval*, VNInfo*>, 8> WorkList;
 486   WorkList.push_back(std::make_pair(&SLI, VNI));
 487   assert(StackInt && "No stack slot assigned yet.");
 488
 489   do {
 490     LiveInterval *LI;
 491     tie(LI, VNI) = WorkList.pop_back_val();
 492     unsigned Reg = LI->reg;
 493     DEBUG(dbgs() << "Checking redundant spills for " << PrintReg(Reg) << ':'
 494                  << VNI->id << '@' << VNI->def << '\n');
 495
 496     // Regs to spill are taken care of.
 497     if (isRegToSpill(Reg))
 498       continue;
 499
 500     // Add all of VNI's live range to StackInt.
 501     StackInt->MergeValueInAsValue(*LI, VNI, StackInt->getValNumInfo(0));
 502     DEBUG(dbgs() << "Merged to stack int: " << *StackInt << '\n');
 503
 504     // Find all spills and copies of VNI.
 505     for (MachineRegisterInfo::use_nodbg_iterator UI = MRI.use_nodbg_begin(Reg);
 506          MachineInstr *MI = UI.skipInstruction();) {
 507       if (!MI->isCopy() && !MI->getDesc().mayStore())
 508         continue;
 509       SlotIndex Idx = LIS.getInstructionIndex(MI);
 510       if (LI->getVNInfoAt(Idx) != VNI)
 511         continue;
 512
 513       // Follow sibling copies down the dominator tree.
 514       if (unsigned DstReg = isFullCopyOf(MI, Reg)) {
 515         if (isSibling(DstReg)) {
 516            LiveInterval &DstLI = LIS.getInterval(DstReg);
 517            VNInfo *DstVNI = DstLI.getVNInfoAt(Idx.getDefIndex());
 518            assert(DstVNI && "Missing defined value");
 519            assert(DstVNI->def == Idx.getDefIndex() && "Wrong copy def slot");
 520            WorkList.push_back(std::make_pair(&DstLI, DstVNI));
 521         }
 522         continue;
 523       }
 524
 525       // Erase spills.
 526       int FI;
 527       if (Reg == TII.isStoreToStackSlot(MI, FI) && FI == StackSlot) {
 528         DEBUG(dbgs() << "Redundant spill " << Idx << '\t' << *MI);
 529         // eliminateDeadDefs won't normally remove stores, so switch opcode.
 530         MI->setDesc(TII.get(TargetOpcode::KILL));
 531         DeadDefs.push_back(MI);
 532       }
 533     }
 534   } while (!WorkList.empty());
 535 }
 536
 537
 538 //===----------------------------------------------------------------------===//
 539 //                            Rematerialization
 540 //===----------------------------------------------------------------------===//
 541
 542 /// markValueUsed - Remember that VNI failed to rematerialize, so its defining
 543 /// instruction cannot be eliminated. See through snippet copies
 544 void InlineSpiller::markValueUsed(LiveInterval *LI, VNInfo *VNI) {
 545   SmallVector<std::pair<LiveInterval*, VNInfo*>, 8> WorkList;
 546   WorkList.push_back(std::make_pair(LI, VNI));
 547   do {
 548     tie(LI, VNI) = WorkList.pop_back_val();
 549     if (!UsedValues.insert(VNI))
 550       continue;
 551
 552     if (VNI->isPHIDef()) {
 553       MachineBasicBlock *MBB = LIS.getMBBFromIndex(VNI->def);
 554       for (MachineBasicBlock::pred_iterator PI = MBB->pred_begin(),
 555              PE = MBB->pred_end(); PI != PE; ++PI) {
 556         VNInfo *PVNI = LI->getVNInfoAt(LIS.getMBBEndIdx(*PI).getPrevSlot());
 557         if (PVNI)
 558           WorkList.push_back(std::make_pair(LI, PVNI));
 559       }
 560       continue;
 561     }
 562
 563     // Follow snippet copies.
 564     MachineInstr *MI = LIS.getInstructionFromIndex(VNI->def);
 565     if (!SnippetCopies.count(MI))
 566       continue;
 567     LiveInterval &SnipLI = LIS.getInterval(MI->getOperand(1).getReg());
 568     assert(isRegToSpill(SnipLI.reg) && "Unexpected register in copy");
 569     VNInfo *SnipVNI = SnipLI.getVNInfoAt(VNI->def.getUseIndex());
 570     assert(SnipVNI && "Snippet undefined before copy");
 571     WorkList.push_back(std::make_pair(&SnipLI, SnipVNI));
 572   } while (!WorkList.empty());
 573 }
 574
 575 /// reMaterializeFor - Attempt to rematerialize before MI instead of reloading.
 576 bool InlineSpiller::reMaterializeFor(LiveInterval &VirtReg,
 577                                      MachineBasicBlock::iterator MI) {
 578   SlotIndex UseIdx = LIS.getInstructionIndex(MI).getUseIndex();
 579   VNInfo *ParentVNI = VirtReg.getVNInfoAt(UseIdx);
 580
 581   if (!ParentVNI) {
 582     DEBUG(dbgs() << "\tadding <undef> flags: ");
 583     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 584       MachineOperand &MO = MI->getOperand(i);
 585       if (MO.isReg() && MO.isUse() && MO.getReg() == VirtReg.reg)
 586         MO.setIsUndef();
 587     }
 588     DEBUG(dbgs() << UseIdx << '\t' << *MI);
 589     return true;
 590   }
 591
 592   if (SnippetCopies.count(MI))
 593     return false;
 594
 595   // Use an OrigVNI from traceSiblingValue when ParentVNI is a sibling copy.
 596   LiveRangeEdit::Remat RM(ParentVNI);
 597   SibValueMap::const_iterator SibI = SibValues.find(ParentVNI);
 598   if (SibI != SibValues.end())
 599     RM.OrigMI = SibI->second.DefMI;
 600   if (!Edit->canRematerializeAt(RM, UseIdx, false, LIS)) {
 601     markValueUsed(&VirtReg, ParentVNI);
 602     DEBUG(dbgs() << "\tcannot remat for " << UseIdx << '\t' << *MI);
 603     return false;
 604   }
 605
 606   // If the instruction also writes VirtReg.reg, it had better not require the
 607   // same register for uses and defs.
 608   bool Reads, Writes;
 609   SmallVector<unsigned, 8> Ops;
 610   tie(Reads, Writes) = MI->readsWritesVirtualRegister(VirtReg.reg, &Ops);
 611   if (Writes) {
 612     for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
 613       MachineOperand &MO = MI->getOperand(Ops[i]);
 614       if (MO.isUse() ? MI->isRegTiedToDefOperand(Ops[i]) : MO.getSubReg()) {
 615         markValueUsed(&VirtReg, ParentVNI);
 616         DEBUG(dbgs() << "\tcannot remat tied reg: " << UseIdx << '\t' << *MI);
 617         return false;
 618       }
 619     }
 620   }
 621
 622   // Before rematerializing into a register for a single instruction, try to
 623   // fold a load into the instruction. That avoids allocating a new register.
 624   if (RM.OrigMI->getDesc().canFoldAsLoad() &&
 625       foldMemoryOperand(MI, Ops, RM.OrigMI)) {
 626     Edit->markRematerialized(RM.ParentVNI);
 627     return true;
 628   }
 629
 630   // Alocate a new register for the remat.
 631   LiveInterval &NewLI = Edit->createFrom(Original, LIS, VRM);
 632   NewLI.markNotSpillable();
 633
 634   // Finally we can rematerialize OrigMI before MI.
 635   SlotIndex DefIdx = Edit->rematerializeAt(*MI->getParent(), MI, NewLI.reg, RM,
 636                                            LIS, TII, TRI);
 637   DEBUG(dbgs() << "\tremat:  " << DefIdx << '\t'
 638                << *LIS.getInstructionFromIndex(DefIdx));
 639
 640   // Replace operands
 641   for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
 642     MachineOperand &MO = MI->getOperand(Ops[i]);
 643     if (MO.isReg() && MO.isUse() && MO.getReg() == VirtReg.reg) {
 644       MO.setReg(NewLI.reg);
 645       MO.setIsKill();
 646     }
 647   }
 648   DEBUG(dbgs() << "\t        " << UseIdx << '\t' << *MI);
 649
 650   VNInfo *DefVNI = NewLI.getNextValue(DefIdx, 0, LIS.getVNInfoAllocator());
 651   NewLI.addRange(LiveRange(DefIdx, UseIdx.getDefIndex(), DefVNI));
 652   DEBUG(dbgs() << "\tinterval: " << NewLI << '\n');
 653   return true;
 654 }
 655
 656 /// reMaterializeAll - Try to rematerialize as many uses as possible,
 657 /// and trim the live ranges after.
 658 void InlineSpiller::reMaterializeAll() {
 659   // analyzeSiblingValues has already tested all relevant defining instructions.
 660   if (!Edit->anyRematerializable(LIS, TII, AA))
 661     return;
 662
 663   UsedValues.clear();
 664
 665   // Try to remat before all uses of snippets.
 666   bool anyRemat = false;
 667   for (unsigned i = 0, e = RegsToSpill.size(); i != e; ++i) {
 668     unsigned Reg = RegsToSpill[i];
 669     LiveInterval &LI = LIS.getInterval(Reg);
 670     for (MachineRegisterInfo::use_nodbg_iterator
 671          RI = MRI.use_nodbg_begin(Reg);
 672          MachineInstr *MI = RI.skipInstruction();)
 673       anyRemat |= reMaterializeFor(LI, MI);
 674   }
 675   if (!anyRemat)
 676     return;
 677
 678   // Remove any values that were completely rematted.
 679   for (unsigned i = 0, e = RegsToSpill.size(); i != e; ++i) {
 680     unsigned Reg = RegsToSpill[i];
 681     LiveInterval &LI = LIS.getInterval(Reg);
 682     for (LiveInterval::vni_iterator I = LI.vni_begin(), E = LI.vni_end();
 683          I != E; ++I) {
 684       VNInfo *VNI = *I;
 685       if (VNI->isUnused() || VNI->isPHIDef() || UsedValues.count(VNI))
 686         continue;
 687       MachineInstr *MI = LIS.getInstructionFromIndex(VNI->def);
 688       MI->addRegisterDead(Reg, &TRI);
 689       if (!MI->allDefsAreDead())
 690         continue;
 691       DEBUG(dbgs() << "All defs dead: " << *MI);
 692       DeadDefs.push_back(MI);
 693     }
 694   }
 695
 696   // Eliminate dead code after remat. Note that some snippet copies may be
 697   // deleted here.
 698   if (DeadDefs.empty())
 699     return;
 700   DEBUG(dbgs() << "Remat created " << DeadDefs.size() << " dead defs.\n");
 701   Edit->eliminateDeadDefs(DeadDefs, LIS, VRM, TII);
 702
 703   // Get rid of deleted and empty intervals.
 704   for (unsigned i = RegsToSpill.size(); i != 0; --i) {
 705     unsigned Reg = RegsToSpill[i-1];
 706     if (!LIS.hasInterval(Reg)) {
 707       RegsToSpill.erase(RegsToSpill.begin() + (i - 1));
 708       continue;
 709     }
 710     LiveInterval &LI = LIS.getInterval(Reg);
 711     if (!LI.empty())
 712       continue;
 713     Edit->eraseVirtReg(Reg, LIS);
 714     RegsToSpill.erase(RegsToSpill.begin() + (i - 1));
 715   }
 716   DEBUG(dbgs() << RegsToSpill.size() << " registers to spill after remat.\n");
 717 }
 718
 719
 720 //===----------------------------------------------------------------------===//
 721 //                                 Spilling
 722 //===----------------------------------------------------------------------===//
 723
 724 /// If MI is a load or store of StackSlot, it can be removed.
 725 bool InlineSpiller::coalesceStackAccess(MachineInstr *MI, unsigned Reg) {
 726   int FI = 0;
 727   unsigned InstrReg;
 728   if (!(InstrReg = TII.isLoadFromStackSlot(MI, FI)) &&
 729       !(InstrReg = TII.isStoreToStackSlot(MI, FI)))
 730     return false;
 731
 732   // We have a stack access. Is it the right register and slot?
 733   if (InstrReg != Reg || FI != StackSlot)
 734     return false;
 735
 736   DEBUG(dbgs() << "Coalescing stack access: " << *MI);
 737   LIS.RemoveMachineInstrFromMaps(MI);
 738   MI->eraseFromParent();
 739   return true;
 740 }
 741
 742 /// foldMemoryOperand - Try folding stack slot references in Ops into MI.
 743 /// @param MI     Instruction using or defining the current register.
 744 /// @param Ops    Operand indices from readsWritesVirtualRegister().
 745 /// @param LoadMI Load instruction to use instead of stack slot when non-null.
 746 /// @return       True on success, and MI will be erased.
 747 bool InlineSpiller::foldMemoryOperand(MachineBasicBlock::iterator MI,
 748                                       const SmallVectorImpl<unsigned> &Ops,
 749                                       MachineInstr *LoadMI) {
 750   // TargetInstrInfo::foldMemoryOperand only expects explicit, non-tied
 751   // operands.
 752   SmallVector<unsigned, 8> FoldOps;
 753   for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
 754     unsigned Idx = Ops[i];
 755     MachineOperand &MO = MI->getOperand(Idx);
 756     if (MO.isImplicit())
 757       continue;
 758     // FIXME: Teach targets to deal with subregs.
 759     if (MO.getSubReg())
 760       return false;
 761     // We cannot fold a load instruction into a def.
 762     if (LoadMI && MO.isDef())
 763       return false;
 764     // Tied use operands should not be passed to foldMemoryOperand.
 765     if (!MI->isRegTiedToDefOperand(Idx))
 766       FoldOps.push_back(Idx);
 767   }
 768
 769   MachineInstr *FoldMI =
 770                 LoadMI ? TII.foldMemoryOperand(MI, FoldOps, LoadMI)
 771                        : TII.foldMemoryOperand(MI, FoldOps, StackSlot);
 772   if (!FoldMI)
 773     return false;
 774   LIS.ReplaceMachineInstrInMaps(MI, FoldMI);
 775   if (!LoadMI)
 776     VRM.addSpillSlotUse(StackSlot, FoldMI);
 777   MI->eraseFromParent();
 778   DEBUG(dbgs() << "\tfolded: " << *FoldMI);
 779   return true;
 780 }
 781
 782 /// insertReload - Insert a reload of NewLI.reg before MI.
 783 void InlineSpiller::insertReload(LiveInterval &NewLI,
 784                                  SlotIndex Idx,
 785                                  MachineBasicBlock::iterator MI) {
 786   MachineBasicBlock &MBB = *MI->getParent();
 787   TII.loadRegFromStackSlot(MBB, MI, NewLI.reg, StackSlot,
 788                            MRI.getRegClass(NewLI.reg), &TRI);
 789   --MI; // Point to load instruction.
 790   SlotIndex LoadIdx = LIS.InsertMachineInstrInMaps(MI).getDefIndex();
 791   VRM.addSpillSlotUse(StackSlot, MI);
 792   DEBUG(dbgs() << "\treload:  " << LoadIdx << '\t' << *MI);
 793   VNInfo *LoadVNI = NewLI.getNextValue(LoadIdx, 0,
 794                                        LIS.getVNInfoAllocator());
 795   NewLI.addRange(LiveRange(LoadIdx, Idx, LoadVNI));
 796 }
 797
 798 /// insertSpill - Insert a spill of NewLI.reg after MI.
 799 void InlineSpiller::insertSpill(LiveInterval &NewLI, const LiveInterval &OldLI,
 800                                 SlotIndex Idx, MachineBasicBlock::iterator MI) {
 801   MachineBasicBlock &MBB = *MI->getParent();
 802   TII.storeRegToStackSlot(MBB, ++MI, NewLI.reg, true, StackSlot,
 803                           MRI.getRegClass(NewLI.reg), &TRI);
 804   --MI; // Point to store instruction.
 805   SlotIndex StoreIdx = LIS.InsertMachineInstrInMaps(MI).getDefIndex();
 806   VRM.addSpillSlotUse(StackSlot, MI);
 807   DEBUG(dbgs() << "\tspilled: " << StoreIdx << '\t' << *MI);
 808   VNInfo *StoreVNI = NewLI.getNextValue(Idx, 0, LIS.getVNInfoAllocator());
 809   NewLI.addRange(LiveRange(Idx, StoreIdx, StoreVNI));
 810 }
 811
 812 /// spillAroundUses - insert spill code around each use of Reg.
 813 void InlineSpiller::spillAroundUses(unsigned Reg) {
 814   LiveInterval &OldLI = LIS.getInterval(Reg);
 815
 816   // Iterate over instructions using Reg.
 817   for (MachineRegisterInfo::reg_iterator RI = MRI.reg_begin(Reg);
 818        MachineInstr *MI = RI.skipInstruction();) {
 819
 820     // Debug values are not allowed to affect codegen.
 821     if (MI->isDebugValue()) {
 822       // Modify DBG_VALUE now that the value is in a spill slot.
 823       uint64_t Offset = MI->getOperand(1).getImm();
 824       const MDNode *MDPtr = MI->getOperand(2).getMetadata();
 825       DebugLoc DL = MI->getDebugLoc();
 826       if (MachineInstr *NewDV = TII.emitFrameIndexDebugValue(MF, StackSlot,
 827                                                            Offset, MDPtr, DL)) {
 828         DEBUG(dbgs() << "Modifying debug info due to spill:" << "\t" << *MI);
 829         MachineBasicBlock *MBB = MI->getParent();
 830         MBB->insert(MBB->erase(MI), NewDV);
 831       } else {
 832         DEBUG(dbgs() << "Removing debug info due to spill:" << "\t" << *MI);
 833         MI->eraseFromParent();
 834       }
 835       continue;
 836     }
 837
 838     // Ignore copies to/from snippets. We'll delete them.
 839     if (SnippetCopies.count(MI))
 840       continue;
 841
 842     // Stack slot accesses may coalesce away.
 843     if (coalesceStackAccess(MI, Reg))
 844       continue;
 845
 846     // Analyze instruction.
 847     bool Reads, Writes;
 848     SmallVector<unsigned, 8> Ops;
 849     tie(Reads, Writes) = MI->readsWritesVirtualRegister(Reg, &Ops);
 850
 851     // Find the slot index where this instruction reads and writes OldLI.
 852     // This is usually the def slot, except for tied early clobbers.
 853     SlotIndex Idx = LIS.getInstructionIndex(MI).getDefIndex();
 854     if (VNInfo *VNI = OldLI.getVNInfoAt(Idx.getUseIndex()))
 855       if (SlotIndex::isSameInstr(Idx, VNI->def))
 856         Idx = VNI->def;
 857
 858     // Check for a sibling copy.
 859     unsigned SibReg = isFullCopyOf(MI, Reg);
 860     if (SibReg && isSibling(SibReg)) {
 861       if (Writes) {
 862         // Hoist the spill of a sib-reg copy.
 863         if (hoistSpill(OldLI, MI)) {
 864           // This COPY is now dead, the value is already in the stack slot.
 865           MI->getOperand(0).setIsDead();
 866           DeadDefs.push_back(MI);
 867           continue;
 868         }
 869       } else {
 870         // This is a reload for a sib-reg copy. Drop spills downstream.
 871         LiveInterval &SibLI = LIS.getInterval(SibReg);
 872         eliminateRedundantSpills(SibLI, SibLI.getVNInfoAt(Idx));
 873         // The COPY will fold to a reload below.
 874       }
 875     }
 876
 877     // Attempt to fold memory ops.
 878     if (foldMemoryOperand(MI, Ops))
 879       continue;
 880
 881     // Allocate interval around instruction.
 882     // FIXME: Infer regclass from instruction alone.
 883     LiveInterval &NewLI = Edit->createFrom(Reg, LIS, VRM);
 884     NewLI.markNotSpillable();
 885
 886     if (Reads)
 887       insertReload(NewLI, Idx, MI);
 888
 889     // Rewrite instruction operands.
 890     bool hasLiveDef = false;
 891     for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
 892       MachineOperand &MO = MI->getOperand(Ops[i]);
 893       MO.setReg(NewLI.reg);
 894       if (MO.isUse()) {
 895         if (!MI->isRegTiedToDefOperand(Ops[i]))
 896           MO.setIsKill();
 897       } else {
 898         if (!MO.isDead())
 899           hasLiveDef = true;
 900       }
 901     }
 902     DEBUG(dbgs() << "\trewrite: " << Idx << '\t' << *MI);
 903
 904     // FIXME: Use a second vreg if instruction has no tied ops.
 905     if (Writes && hasLiveDef)
 906       insertSpill(NewLI, OldLI, Idx, MI);
 907
 908     DEBUG(dbgs() << "\tinterval: " << NewLI << '\n');
 909   }
 910 }
 911
 912 /// spillAll - Spill all registers remaining after rematerialization.
 913 void InlineSpiller::spillAll() {
 914   // Update LiveStacks now that we are committed to spilling.
 915   if (StackSlot == VirtRegMap::NO_STACK_SLOT) {
 916     StackSlot = VRM.assignVirt2StackSlot(Original);
 917     StackInt = &LSS.getOrCreateInterval(StackSlot, MRI.getRegClass(Original));
 918     StackInt->getNextValue(SlotIndex(), 0, LSS.getVNInfoAllocator());
 919   } else
 920     StackInt = &LSS.getInterval(StackSlot);
 921
 922   if (Original != Edit->getReg())
 923     VRM.assignVirt2StackSlot(Edit->getReg(), StackSlot);
 924
 925   assert(StackInt->getNumValNums() == 1 && "Bad stack interval values");
 926   for (unsigned i = 0, e = RegsToSpill.size(); i != e; ++i)
 927     StackInt->MergeRangesInAsValue(LIS.getInterval(RegsToSpill[i]),
 928                                    StackInt->getValNumInfo(0));
 929   DEBUG(dbgs() << "Merged spilled regs: " << *StackInt << '\n');
 930
 931   // Spill around uses of all RegsToSpill.
 932   for (unsigned i = 0, e = RegsToSpill.size(); i != e; ++i)
 933     spillAroundUses(RegsToSpill[i]);
 934
 935   // Hoisted spills may cause dead code.
 936   if (!DeadDefs.empty()) {
 937     DEBUG(dbgs() << "Eliminating " << DeadDefs.size() << " dead defs\n");
 938     Edit->eliminateDeadDefs(DeadDefs, LIS, VRM, TII);
 939   }
 940
 941   // Finally delete the SnippetCopies.
 942   for (MachineRegisterInfo::reg_iterator RI = MRI.reg_begin(Edit->getReg());
 943        MachineInstr *MI = RI.skipInstruction();) {
 944     assert(SnippetCopies.count(MI) && "Remaining use wasn't a snippet copy");
 945     // FIXME: Do this with a LiveRangeEdit callback.
 946     VRM.RemoveMachineInstrFromMaps(MI);
 947     LIS.RemoveMachineInstrFromMaps(MI);
 948     MI->eraseFromParent();
 949   }
 950
 951   // Delete all spilled registers.
 952   for (unsigned i = 0, e = RegsToSpill.size(); i != e; ++i)
 953     Edit->eraseVirtReg(RegsToSpill[i], LIS);
 954 }
 955
 956 void InlineSpiller::spill(LiveRangeEdit &edit) {
 957   Edit = &edit;
 958   assert(!TargetRegisterInfo::isStackSlot(edit.getReg())
 959          && "Trying to spill a stack slot.");
 960   // Share a stack slot among all descendants of Original.
 961   Original = VRM.getOriginal(edit.getReg());
 962   StackSlot = VRM.getStackSlot(Original);
 963   StackInt = 0;
 964
 965   DEBUG(dbgs() << "Inline spilling "
 966                << MRI.getRegClass(edit.getReg())->getName()
 967                << ':' << edit.getParent() << "\nFrom original "
 968                << LIS.getInterval(Original) << '\n');
 969   assert(edit.getParent().isSpillable() &&
 970          "Attempting to spill already spilled value.");
 971   assert(DeadDefs.empty() && "Previous spill didn't remove dead defs");
 972
 973   collectRegsToSpill();
 974   analyzeSiblingValues();
 975   reMaterializeAll();
 976
 977   // Remat may handle everything.
 978   if (!RegsToSpill.empty())
 979     spillAll();
 980
 981   Edit->calculateRegClassAndHint(MF, LIS, Loops);
 982 }