lib/CodeGen/VirtRegMap.cpp

   1 //===-- llvm/CodeGen/VirtRegMap.cpp - Virtual Register Map ----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the VirtRegMap class.
  11 //
  12 // It also contains implementations of the the Spiller interface, which, given a
  13 // virtual register map and a machine function, eliminates all virtual
  14 // references by replacing them with physical register references - adding spill
  15 // code as necessary.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #define DEBUG_TYPE "spiller"
  20 #include "VirtRegMap.h"
  21 #include "llvm/Function.h"
  22 #include "llvm/CodeGen/MachineFrameInfo.h"
  23 #include "llvm/CodeGen/MachineFunction.h"
  24 #include "llvm/CodeGen/SSARegMap.h"
  25 #include "llvm/Target/TargetMachine.h"
  26 #include "llvm/Target/TargetInstrInfo.h"
  27 #include "llvm/Support/CommandLine.h"
  28 #include "llvm/Support/Debug.h"
  29 #include "llvm/Support/Compiler.h"
  30 #include "llvm/ADT/BitVector.h"
  31 #include "llvm/ADT/Statistic.h"
  32 #include "llvm/ADT/STLExtras.h"
  33 #include "llvm/ADT/SmallSet.h"
  34 #include <algorithm>
  35 using namespace llvm;
  36
  37 STATISTIC(NumSpills, "Number of register spills");
  38 STATISTIC(NumReMats, "Number of re-materialization");
  39 STATISTIC(NumDRM   , "Number of re-materializable defs elided");
  40 STATISTIC(NumStores, "Number of stores added");
  41 STATISTIC(NumLoads , "Number of loads added");
  42 STATISTIC(NumReused, "Number of values reused");
  43 STATISTIC(NumDSE   , "Number of dead stores elided");
  44 STATISTIC(NumDCE   , "Number of copies elided");
  45
  46 namespace {
  47   enum SpillerName { simple, local };
  48
  49   static cl::opt<SpillerName>
  50   SpillerOpt("spiller",
  51              cl::desc("Spiller to use: (default: local)"),
  52              cl::Prefix,
  53              cl::values(clEnumVal(simple, "  simple spiller"),
  54                         clEnumVal(local,  "  local spiller"),
  55                         clEnumValEnd),
  56              cl::init(local));
  57 }
  58
  59 //===----------------------------------------------------------------------===//
  60 //  VirtRegMap implementation
  61 //===----------------------------------------------------------------------===//
  62
  63 VirtRegMap::VirtRegMap(MachineFunction &mf)
  64   : TII(*mf.getTarget().getInstrInfo()), MF(mf),
  65     Virt2PhysMap(NO_PHYS_REG), Virt2StackSlotMap(NO_STACK_SLOT),
  66     Virt2ReMatIdMap(NO_STACK_SLOT), ReMatMap(NULL),
  67     ReMatId(MAX_STACK_SLOT+1) {
  68   grow();
  69 }
  70
  71 void VirtRegMap::grow() {
  72   unsigned LastVirtReg = MF.getSSARegMap()->getLastVirtReg();
  73   Virt2PhysMap.grow(LastVirtReg);
  74   Virt2StackSlotMap.grow(LastVirtReg);
  75   Virt2ReMatIdMap.grow(LastVirtReg);
  76   ReMatMap.grow(LastVirtReg);
  77 }
  78
  79 int VirtRegMap::assignVirt2StackSlot(unsigned virtReg) {
  80   assert(MRegisterInfo::isVirtualRegister(virtReg));
  81   assert(Virt2StackSlotMap[virtReg] == NO_STACK_SLOT &&
  82          "attempt to assign stack slot to already spilled register");
  83   const TargetRegisterClass* RC = MF.getSSARegMap()->getRegClass(virtReg);
  84   int frameIndex = MF.getFrameInfo()->CreateStackObject(RC->getSize(),
  85                                                         RC->getAlignment());
  86   Virt2StackSlotMap[virtReg] = frameIndex;
  87   ++NumSpills;
  88   return frameIndex;
  89 }
  90
  91 void VirtRegMap::assignVirt2StackSlot(unsigned virtReg, int frameIndex) {
  92   assert(MRegisterInfo::isVirtualRegister(virtReg));
  93   assert(Virt2StackSlotMap[virtReg] == NO_STACK_SLOT &&
  94          "attempt to assign stack slot to already spilled register");
  95   assert((frameIndex >= 0 ||
  96           (frameIndex >= MF.getFrameInfo()->getObjectIndexBegin())) &&
  97          "illegal fixed frame index");
  98   Virt2StackSlotMap[virtReg] = frameIndex;
  99 }
 100
 101 int VirtRegMap::assignVirtReMatId(unsigned virtReg) {
 102   assert(MRegisterInfo::isVirtualRegister(virtReg));
 103   assert(Virt2ReMatIdMap[virtReg] == NO_STACK_SLOT &&
 104          "attempt to assign re-mat id to already spilled register");
 105   Virt2ReMatIdMap[virtReg] = ReMatId;
 106   return ReMatId++;
 107 }
 108
 109 void VirtRegMap::assignVirtReMatId(unsigned virtReg, int id) {
 110   assert(MRegisterInfo::isVirtualRegister(virtReg));
 111   assert(Virt2ReMatIdMap[virtReg] == NO_STACK_SLOT &&
 112          "attempt to assign re-mat id to already spilled register");
 113   Virt2ReMatIdMap[virtReg] = id;
 114 }
 115
 116 void VirtRegMap::virtFolded(unsigned VirtReg, MachineInstr *OldMI,
 117                             unsigned OpNo, MachineInstr *NewMI) {
 118   // Move previous memory references folded to new instruction.
 119   MI2VirtMapTy::iterator IP = MI2VirtMap.lower_bound(NewMI);
 120   for (MI2VirtMapTy::iterator I = MI2VirtMap.lower_bound(OldMI),
 121          E = MI2VirtMap.end(); I != E && I->first == OldMI; ) {
 122     MI2VirtMap.insert(IP, std::make_pair(NewMI, I->second));
 123     MI2VirtMap.erase(I++);
 124   }
 125
 126   ModRef MRInfo;
 127   const TargetInstrDescriptor *TID = OldMI->getInstrDescriptor();
 128   if (TID->getOperandConstraint(OpNo, TOI::TIED_TO) != -1 ||
 129       TID->findTiedToSrcOperand(OpNo) != -1) {
 130     // Folded a two-address operand.
 131     MRInfo = isModRef;
 132   } else if (OldMI->getOperand(OpNo).isDef()) {
 133     MRInfo = isMod;
 134   } else {
 135     MRInfo = isRef;
 136   }
 137
 138   // add new memory reference
 139   MI2VirtMap.insert(IP, std::make_pair(NewMI, std::make_pair(VirtReg, MRInfo)));
 140 }
 141
 142 void VirtRegMap::virtFolded(unsigned VirtReg, MachineInstr *MI, ModRef MRInfo) {
 143   MI2VirtMapTy::iterator IP = MI2VirtMap.lower_bound(MI);
 144   MI2VirtMap.insert(IP, std::make_pair(MI, std::make_pair(VirtReg, MRInfo)));
 145 }
 146
 147 void VirtRegMap::print(std::ostream &OS) const {
 148   const MRegisterInfo* MRI = MF.getTarget().getRegisterInfo();
 149
 150   OS << "********** REGISTER MAP **********\n";
 151   for (unsigned i = MRegisterInfo::FirstVirtualRegister,
 152          e = MF.getSSARegMap()->getLastVirtReg(); i <= e; ++i) {
 153     if (Virt2PhysMap[i] != (unsigned)VirtRegMap::NO_PHYS_REG)
 154       OS << "[reg" << i << " -> " << MRI->getName(Virt2PhysMap[i]) << "]\n";
 155
 156   }
 157
 158   for (unsigned i = MRegisterInfo::FirstVirtualRegister,
 159          e = MF.getSSARegMap()->getLastVirtReg(); i <= e; ++i)
 160     if (Virt2StackSlotMap[i] != VirtRegMap::NO_STACK_SLOT)
 161       OS << "[reg" << i << " -> fi#" << Virt2StackSlotMap[i] << "]\n";
 162   OS << '\n';
 163 }
 164
 165 void VirtRegMap::dump() const {
 166   print(DOUT);
 167 }
 168
 169
 170 //===----------------------------------------------------------------------===//
 171 // Simple Spiller Implementation
 172 //===----------------------------------------------------------------------===//
 173
 174 Spiller::~Spiller() {}
 175
 176 namespace {
 177   struct VISIBILITY_HIDDEN SimpleSpiller : public Spiller {
 178     bool runOnMachineFunction(MachineFunction& mf, VirtRegMap &VRM);
 179   };
 180 }
 181
 182 bool SimpleSpiller::runOnMachineFunction(MachineFunction &MF, VirtRegMap &VRM) {
 183   DOUT << "********** REWRITE MACHINE CODE **********\n";
 184   DOUT << "********** Function: " << MF.getFunction()->getName() << '\n';
 185   const TargetMachine &TM = MF.getTarget();
 186   const MRegisterInfo &MRI = *TM.getRegisterInfo();
 187
 188   // LoadedRegs - Keep track of which vregs are loaded, so that we only load
 189   // each vreg once (in the case where a spilled vreg is used by multiple
 190   // operands).  This is always smaller than the number of operands to the
 191   // current machine instr, so it should be small.
 192   std::vector<unsigned> LoadedRegs;
 193
 194   for (MachineFunction::iterator MBBI = MF.begin(), E = MF.end();
 195        MBBI != E; ++MBBI) {
 196     DOUT << MBBI->getBasicBlock()->getName() << ":\n";
 197     MachineBasicBlock &MBB = *MBBI;
 198     for (MachineBasicBlock::iterator MII = MBB.begin(),
 199            E = MBB.end(); MII != E; ++MII) {
 200       MachineInstr &MI = *MII;
 201       for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
 202         MachineOperand &MO = MI.getOperand(i);
 203         if (MO.isRegister() && MO.getReg())
 204           if (MRegisterInfo::isVirtualRegister(MO.getReg())) {
 205             unsigned VirtReg = MO.getReg();
 206             unsigned PhysReg = VRM.getPhys(VirtReg);
 207             if (!VRM.isAssignedReg(VirtReg)) {
 208               int StackSlot = VRM.getStackSlot(VirtReg);
 209               const TargetRegisterClass* RC =
 210                 MF.getSSARegMap()->getRegClass(VirtReg);
 211
 212               if (MO.isUse() &&
 213                   std::find(LoadedRegs.begin(), LoadedRegs.end(), VirtReg)
 214                   == LoadedRegs.end()) {
 215                 MRI.loadRegFromStackSlot(MBB, &MI, PhysReg, StackSlot, RC);
 216                 LoadedRegs.push_back(VirtReg);
 217                 ++NumLoads;
 218                 DOUT << '\t' << *prior(MII);
 219               }
 220
 221               if (MO.isDef()) {
 222                 MRI.storeRegToStackSlot(MBB, next(MII), PhysReg, StackSlot, RC);
 223                 ++NumStores;
 224               }
 225             }
 226             MF.setPhysRegUsed(PhysReg);
 227             MI.getOperand(i).setReg(PhysReg);
 228           } else {
 229             MF.setPhysRegUsed(MO.getReg());
 230           }
 231       }
 232
 233       DOUT << '\t' << MI;
 234       LoadedRegs.clear();
 235     }
 236   }
 237   return true;
 238 }
 239
 240 //===----------------------------------------------------------------------===//
 241 //  Local Spiller Implementation
 242 //===----------------------------------------------------------------------===//
 243
 244 namespace {
 245   class AvailableSpills;
 246
 247   /// LocalSpiller - This spiller does a simple pass over the machine basic
 248   /// block to attempt to keep spills in registers as much as possible for
 249   /// blocks that have low register pressure (the vreg may be spilled due to
 250   /// register pressure in other blocks).
 251   class VISIBILITY_HIDDEN LocalSpiller : public Spiller {
 252     SSARegMap *RegMap;
 253     const MRegisterInfo *MRI;
 254     const TargetInstrInfo *TII;
 255   public:
 256     bool runOnMachineFunction(MachineFunction &MF, VirtRegMap &VRM) {
 257       RegMap = MF.getSSARegMap();
 258       MRI = MF.getTarget().getRegisterInfo();
 259       TII = MF.getTarget().getInstrInfo();
 260       DOUT << "\n**** Local spiller rewriting function '"
 261            << MF.getFunction()->getName() << "':\n";
 262       DOUT << "**** Machine Instrs (NOTE! Does not include spills and reloads!) ****\n";
 263       DEBUG(MF.dump());
 264
 265       for (MachineFunction::iterator MBB = MF.begin(), E = MF.end();
 266            MBB != E; ++MBB)
 267         RewriteMBB(*MBB, VRM);
 268
 269       DOUT << "**** Post Machine Instrs ****\n";
 270       DEBUG(MF.dump());
 271
 272       return true;
 273     }
 274   private:
 275     bool PrepForUnfoldOpti(MachineBasicBlock &MBB,
 276                            MachineBasicBlock::iterator &MII,
 277                            std::vector<MachineInstr*> &MaybeDeadStores,
 278                            AvailableSpills &Spills, BitVector &RegKills,
 279                            std::vector<MachineOperand*> &KillOps,
 280                            VirtRegMap &VRM);
 281     void RewriteMBB(MachineBasicBlock &MBB, VirtRegMap &VRM);
 282   };
 283 }
 284
 285 /// AvailableSpills - As the local spiller is scanning and rewriting an MBB from
 286 /// top down, keep track of which spills slots or remat are available in each
 287 /// register.
 288 ///
 289 /// Note that not all physregs are created equal here.  In particular, some
 290 /// physregs are reloads that we are allowed to clobber or ignore at any time.
 291 /// Other physregs are values that the register allocated program is using that
 292 /// we cannot CHANGE, but we can read if we like.  We keep track of this on a
 293 /// per-stack-slot / remat id basis as the low bit in the value of the
 294 /// SpillSlotsAvailable entries.  The predicate 'canClobberPhysReg()' checks
 295 /// this bit and addAvailable sets it if.
 296 namespace {
 297 class VISIBILITY_HIDDEN AvailableSpills {
 298   const MRegisterInfo *MRI;
 299   const TargetInstrInfo *TII;
 300
 301   // SpillSlotsOrReMatsAvailable - This map keeps track of all of the spilled
 302   // or remat'ed virtual register values that are still available, due to being
 303   // loaded or stored to, but not invalidated yet.
 304   std::map<int, unsigned> SpillSlotsOrReMatsAvailable;
 305
 306   // PhysRegsAvailable - This is the inverse of SpillSlotsOrReMatsAvailable,
 307   // indicating which stack slot values are currently held by a physreg.  This
 308   // is used to invalidate entries in SpillSlotsOrReMatsAvailable when a
 309   // physreg is modified.
 310   std::multimap<unsigned, int> PhysRegsAvailable;
 311
 312   void disallowClobberPhysRegOnly(unsigned PhysReg);
 313
 314   void ClobberPhysRegOnly(unsigned PhysReg);
 315 public:
 316   AvailableSpills(const MRegisterInfo *mri, const TargetInstrInfo *tii)
 317     : MRI(mri), TII(tii) {
 318   }
 319
 320   const MRegisterInfo *getRegInfo() const { return MRI; }
 321
 322   /// getSpillSlotOrReMatPhysReg - If the specified stack slot or remat is
 323   /// available in a  physical register, return that PhysReg, otherwise
 324   /// return 0.
 325   unsigned getSpillSlotOrReMatPhysReg(int Slot) const {
 326     std::map<int, unsigned>::const_iterator I =
 327       SpillSlotsOrReMatsAvailable.find(Slot);
 328     if (I != SpillSlotsOrReMatsAvailable.end()) {
 329       return I->second >> 1;  // Remove the CanClobber bit.
 330     }
 331     return 0;
 332   }
 333
 334   /// addAvailable - Mark that the specified stack slot / remat is available in
 335   /// the specified physreg.  If CanClobber is true, the physreg can be modified
 336   /// at any time without changing the semantics of the program.
 337   void addAvailable(int SlotOrReMat, MachineInstr *MI, unsigned Reg,
 338                     bool CanClobber = true) {
 339     // If this stack slot is thought to be available in some other physreg,
 340     // remove its record.
 341     ModifyStackSlotOrReMat(SlotOrReMat);
 342
 343     PhysRegsAvailable.insert(std::make_pair(Reg, SlotOrReMat));
 344     SpillSlotsOrReMatsAvailable[SlotOrReMat]= (Reg << 1) | (unsigned)CanClobber;
 345
 346     if (SlotOrReMat > VirtRegMap::MAX_STACK_SLOT)
 347       DOUT << "Remembering RM#" << SlotOrReMat-VirtRegMap::MAX_STACK_SLOT-1;
 348     else
 349       DOUT << "Remembering SS#" << SlotOrReMat;
 350     DOUT << " in physreg " << MRI->getName(Reg) << "\n";
 351   }
 352
 353   /// canClobberPhysReg - Return true if the spiller is allowed to change the
 354   /// value of the specified stackslot register if it desires.  The specified
 355   /// stack slot must be available in a physreg for this query to make sense.
 356   bool canClobberPhysReg(int SlotOrReMat) const {
 357     assert(SpillSlotsOrReMatsAvailable.count(SlotOrReMat) &&
 358            "Value not available!");
 359     return SpillSlotsOrReMatsAvailable.find(SlotOrReMat)->second & 1;
 360   }
 361
 362   /// disallowClobberPhysReg - Unset the CanClobber bit of the specified
 363   /// stackslot register. The register is still available but is no longer
 364   /// allowed to be modifed.
 365   void disallowClobberPhysReg(unsigned PhysReg);
 366
 367   /// ClobberPhysReg - This is called when the specified physreg changes
 368   /// value.  We use this to invalidate any info about stuff that lives in
 369   /// it and any of its aliases.
 370   void ClobberPhysReg(unsigned PhysReg);
 371
 372   /// ModifyStackSlotOrReMat - This method is called when the value in a stack
 373   /// slot changes.  This removes information about which register the previous
 374   /// value for this slot lives in (as the previous value is dead now).
 375   void ModifyStackSlotOrReMat(int SlotOrReMat);
 376 };
 377 }
 378
 379 /// disallowClobberPhysRegOnly - Unset the CanClobber bit of the specified
 380 /// stackslot register. The register is still available but is no longer
 381 /// allowed to be modifed.
 382 void AvailableSpills::disallowClobberPhysRegOnly(unsigned PhysReg) {
 383   std::multimap<unsigned, int>::iterator I =
 384     PhysRegsAvailable.lower_bound(PhysReg);
 385   while (I != PhysRegsAvailable.end() && I->first == PhysReg) {
 386     int SlotOrReMat = I->second;
 387     I++;
 388     assert((SpillSlotsOrReMatsAvailable[SlotOrReMat] >> 1) == PhysReg &&
 389            "Bidirectional map mismatch!");
 390     SpillSlotsOrReMatsAvailable[SlotOrReMat] &= ~1;
 391     DOUT << "PhysReg " << MRI->getName(PhysReg)
 392          << " copied, it is available for use but can no longer be modified\n";
 393   }
 394 }
 395
 396 /// disallowClobberPhysReg - Unset the CanClobber bit of the specified
 397 /// stackslot register and its aliases. The register and its aliases may
 398 /// still available but is no longer allowed to be modifed.
 399 void AvailableSpills::disallowClobberPhysReg(unsigned PhysReg) {
 400   for (const unsigned *AS = MRI->getAliasSet(PhysReg); *AS; ++AS)
 401     disallowClobberPhysRegOnly(*AS);
 402   disallowClobberPhysRegOnly(PhysReg);
 403 }
 404
 405 /// ClobberPhysRegOnly - This is called when the specified physreg changes
 406 /// value.  We use this to invalidate any info about stuff we thing lives in it.
 407 void AvailableSpills::ClobberPhysRegOnly(unsigned PhysReg) {
 408   std::multimap<unsigned, int>::iterator I =
 409     PhysRegsAvailable.lower_bound(PhysReg);
 410   while (I != PhysRegsAvailable.end() && I->first == PhysReg) {
 411     int SlotOrReMat = I->second;
 412     PhysRegsAvailable.erase(I++);
 413     assert((SpillSlotsOrReMatsAvailable[SlotOrReMat] >> 1) == PhysReg &&
 414            "Bidirectional map mismatch!");
 415     SpillSlotsOrReMatsAvailable.erase(SlotOrReMat);
 416     DOUT << "PhysReg " << MRI->getName(PhysReg)
 417          << " clobbered, invalidating ";
 418     if (SlotOrReMat > VirtRegMap::MAX_STACK_SLOT)
 419       DOUT << "RM#" << SlotOrReMat-VirtRegMap::MAX_STACK_SLOT-1 << "\n";
 420     else
 421       DOUT << "SS#" << SlotOrReMat << "\n";
 422   }
 423 }
 424
 425 /// ClobberPhysReg - This is called when the specified physreg changes
 426 /// value.  We use this to invalidate any info about stuff we thing lives in
 427 /// it and any of its aliases.
 428 void AvailableSpills::ClobberPhysReg(unsigned PhysReg) {
 429   for (const unsigned *AS = MRI->getAliasSet(PhysReg); *AS; ++AS)
 430     ClobberPhysRegOnly(*AS);
 431   ClobberPhysRegOnly(PhysReg);
 432 }
 433
 434 /// ModifyStackSlotOrReMat - This method is called when the value in a stack
 435 /// slot changes.  This removes information about which register the previous
 436 /// value for this slot lives in (as the previous value is dead now).
 437 void AvailableSpills::ModifyStackSlotOrReMat(int SlotOrReMat) {
 438   std::map<int, unsigned>::iterator It =
 439     SpillSlotsOrReMatsAvailable.find(SlotOrReMat);
 440   if (It == SpillSlotsOrReMatsAvailable.end()) return;
 441   unsigned Reg = It->second >> 1;
 442   SpillSlotsOrReMatsAvailable.erase(It);
 443
 444   // This register may hold the value of multiple stack slots, only remove this
 445   // stack slot from the set of values the register contains.
 446   std::multimap<unsigned, int>::iterator I = PhysRegsAvailable.lower_bound(Reg);
 447   for (; ; ++I) {
 448     assert(I != PhysRegsAvailable.end() && I->first == Reg &&
 449            "Map inverse broken!");
 450     if (I->second == SlotOrReMat) break;
 451   }
 452   PhysRegsAvailable.erase(I);
 453 }
 454
 455
 456
 457 /// InvalidateKills - MI is going to be deleted. If any of its operands are
 458 /// marked kill, then invalidate the information.
 459 static void InvalidateKills(MachineInstr &MI, BitVector &RegKills,
 460                             std::vector<MachineOperand*> &KillOps,
 461                             SmallVector<unsigned, 2> *KillRegs = NULL) {
 462   for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
 463     MachineOperand &MO = MI.getOperand(i);
 464     if (!MO.isRegister() || !MO.isUse() || !MO.isKill())
 465       continue;
 466     unsigned Reg = MO.getReg();
 467     if (KillRegs)
 468       KillRegs->push_back(Reg);
 469     if (KillOps[Reg] == &MO) {
 470       RegKills.reset(Reg);
 471       KillOps[Reg] = NULL;
 472     }
 473   }
 474 }
 475
 476 /// InvalidateRegDef - If the def operand of the specified def MI is now dead
 477 /// (since it's spill instruction is removed), mark it isDead. Also checks if
 478 /// the def MI has other definition operands that are not dead. Returns it by
 479 /// reference.
 480 static bool InvalidateRegDef(MachineBasicBlock::iterator I,
 481                              MachineInstr &NewDef, unsigned Reg,
 482                              bool &HasLiveDef) {
 483   // Due to remat, it's possible this reg isn't being reused. That is,
 484   // the def of this reg (by prev MI) is now dead.
 485   MachineInstr *DefMI = I;
 486   MachineOperand *DefOp = NULL;
 487   for (unsigned i = 0, e = DefMI->getNumOperands(); i != e; ++i) {
 488     MachineOperand &MO = DefMI->getOperand(i);
 489     if (MO.isRegister() && MO.isDef()) {
 490       if (MO.getReg() == Reg)
 491         DefOp = &MO;
 492       else if (!MO.isDead())
 493         HasLiveDef = true;
 494     }
 495   }
 496   if (!DefOp)
 497     return false;
 498
 499   bool FoundUse = false, Done = false;
 500   MachineBasicBlock::iterator E = NewDef;
 501   ++I; ++E;
 502   for (; !Done && I != E; ++I) {
 503     MachineInstr *NMI = I;
 504     for (unsigned j = 0, ee = NMI->getNumOperands(); j != ee; ++j) {
 505       MachineOperand &MO = NMI->getOperand(j);
 506       if (!MO.isRegister() || MO.getReg() != Reg)
 507         continue;
 508       if (MO.isUse())
 509         FoundUse = true;
 510       Done = true; // Stop after scanning all the operands of this MI.
 511     }
 512   }
 513   if (!FoundUse) {
 514     // Def is dead!
 515     DefOp->setIsDead();
 516     return true;
 517   }
 518   return false;
 519 }
 520
 521 /// UpdateKills - Track and update kill info. If a MI reads a register that is
 522 /// marked kill, then it must be due to register reuse. Transfer the kill info
 523 /// over.
 524 static void UpdateKills(MachineInstr &MI, BitVector &RegKills,
 525                         std::vector<MachineOperand*> &KillOps) {
 526   const TargetInstrDescriptor *TID = MI.getInstrDescriptor();
 527   for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
 528     MachineOperand &MO = MI.getOperand(i);
 529     if (!MO.isRegister() || !MO.isUse())
 530       continue;
 531     unsigned Reg = MO.getReg();
 532     if (Reg == 0)
 533       continue;
 534
 535     if (RegKills[Reg]) {
 536       // That can't be right. Register is killed but not re-defined and it's
 537       // being reused. Let's fix that.
 538       KillOps[Reg]->unsetIsKill();
 539       if (i < TID->numOperands &&
 540           TID->getOperandConstraint(i, TOI::TIED_TO) == -1)
 541         // Unless it's a two-address operand, this is the new kill.
 542         MO.setIsKill();
 543     }
 544
 545     if (MO.isKill()) {
 546       RegKills.set(Reg);
 547       KillOps[Reg] = &MO;
 548     }
 549   }
 550
 551   for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
 552     const MachineOperand &MO = MI.getOperand(i);
 553     if (!MO.isRegister() || !MO.isDef())
 554       continue;
 555     unsigned Reg = MO.getReg();
 556     RegKills.reset(Reg);
 557     KillOps[Reg] = NULL;
 558   }
 559 }
 560
 561
 562 // ReusedOp - For each reused operand, we keep track of a bit of information, in
 563 // case we need to rollback upon processing a new operand.  See comments below.
 564 namespace {
 565   struct ReusedOp {
 566     // The MachineInstr operand that reused an available value.
 567     unsigned Operand;
 568
 569     // StackSlotOrReMat - The spill slot or remat id of the value being reused.
 570     unsigned StackSlotOrReMat;
 571
 572     // PhysRegReused - The physical register the value was available in.
 573     unsigned PhysRegReused;
 574
 575     // AssignedPhysReg - The physreg that was assigned for use by the reload.
 576     unsigned AssignedPhysReg;
 577
 578     // VirtReg - The virtual register itself.
 579     unsigned VirtReg;
 580
 581     ReusedOp(unsigned o, unsigned ss, unsigned prr, unsigned apr,
 582              unsigned vreg)
 583       : Operand(o), StackSlotOrReMat(ss), PhysRegReused(prr),
 584         AssignedPhysReg(apr), VirtReg(vreg) {}
 585   };
 586
 587   /// ReuseInfo - This maintains a collection of ReuseOp's for each operand that
 588   /// is reused instead of reloaded.
 589   class VISIBILITY_HIDDEN ReuseInfo {
 590     MachineInstr &MI;
 591     std::vector<ReusedOp> Reuses;
 592     BitVector PhysRegsClobbered;
 593   public:
 594     ReuseInfo(MachineInstr &mi, const MRegisterInfo *mri) : MI(mi) {
 595       PhysRegsClobbered.resize(mri->getNumRegs());
 596     }
 597
 598     bool hasReuses() const {
 599       return !Reuses.empty();
 600     }
 601
 602     /// addReuse - If we choose to reuse a virtual register that is already
 603     /// available instead of reloading it, remember that we did so.
 604     void addReuse(unsigned OpNo, unsigned StackSlotOrReMat,
 605                   unsigned PhysRegReused, unsigned AssignedPhysReg,
 606                   unsigned VirtReg) {
 607       // If the reload is to the assigned register anyway, no undo will be
 608       // required.
 609       if (PhysRegReused == AssignedPhysReg) return;
 610
 611       // Otherwise, remember this.
 612       Reuses.push_back(ReusedOp(OpNo, StackSlotOrReMat, PhysRegReused,
 613                                 AssignedPhysReg, VirtReg));
 614     }
 615
 616     void markClobbered(unsigned PhysReg) {
 617       PhysRegsClobbered.set(PhysReg);
 618     }
 619
 620     bool isClobbered(unsigned PhysReg) const {
 621       return PhysRegsClobbered.test(PhysReg);
 622     }
 623
 624     /// GetRegForReload - We are about to emit a reload into PhysReg.  If there
 625     /// is some other operand that is using the specified register, either pick
 626     /// a new register to use, or evict the previous reload and use this reg.
 627     unsigned GetRegForReload(unsigned PhysReg, MachineInstr *MI,
 628                              AvailableSpills &Spills,
 629                              std::vector<MachineInstr*> &MaybeDeadStores,
 630                              SmallSet<unsigned, 8> &Rejected,
 631                              BitVector &RegKills,
 632                              std::vector<MachineOperand*> &KillOps,
 633                              VirtRegMap &VRM) {
 634       if (Reuses.empty()) return PhysReg;  // This is most often empty.
 635
 636       for (unsigned ro = 0, e = Reuses.size(); ro != e; ++ro) {
 637         ReusedOp &Op = Reuses[ro];
 638         // If we find some other reuse that was supposed to use this register
 639         // exactly for its reload, we can change this reload to use ITS reload
 640         // register. That is, unless its reload register has already been
 641         // considered and subsequently rejected because it has also been reused
 642         // by another operand.
 643         if (Op.PhysRegReused == PhysReg &&
 644             Rejected.count(Op.AssignedPhysReg) == 0) {
 645           // Yup, use the reload register that we didn't use before.
 646           unsigned NewReg = Op.AssignedPhysReg;
 647           Rejected.insert(PhysReg);
 648           return GetRegForReload(NewReg, MI, Spills, MaybeDeadStores, Rejected,
 649                                  RegKills, KillOps, VRM);
 650         } else {
 651           // Otherwise, we might also have a problem if a previously reused
 652           // value aliases the new register.  If so, codegen the previous reload
 653           // and use this one.
 654           unsigned PRRU = Op.PhysRegReused;
 655           const MRegisterInfo *MRI = Spills.getRegInfo();
 656           if (MRI->areAliases(PRRU, PhysReg)) {
 657             // Okay, we found out that an alias of a reused register
 658             // was used.  This isn't good because it means we have
 659             // to undo a previous reuse.
 660             MachineBasicBlock *MBB = MI->getParent();
 661             const TargetRegisterClass *AliasRC =
 662               MBB->getParent()->getSSARegMap()->getRegClass(Op.VirtReg);
 663
 664             // Copy Op out of the vector and remove it, we're going to insert an
 665             // explicit load for it.
 666             ReusedOp NewOp = Op;
 667             Reuses.erase(Reuses.begin()+ro);
 668
 669             // Ok, we're going to try to reload the assigned physreg into the
 670             // slot that we were supposed to in the first place.  However, that
 671             // register could hold a reuse.  Check to see if it conflicts or
 672             // would prefer us to use a different register.
 673             unsigned NewPhysReg = GetRegForReload(NewOp.AssignedPhysReg,
 674                                                   MI, Spills, MaybeDeadStores,
 675                                               Rejected, RegKills, KillOps, VRM);
 676
 677             if (NewOp.StackSlotOrReMat > VirtRegMap::MAX_STACK_SLOT) {
 678               MRI->reMaterialize(*MBB, MI, NewPhysReg,
 679                                  VRM.getReMaterializedMI(NewOp.VirtReg));
 680               ++NumReMats;
 681             } else {
 682               MRI->loadRegFromStackSlot(*MBB, MI, NewPhysReg,
 683                                         NewOp.StackSlotOrReMat, AliasRC);
 684               // Any stores to this stack slot are not dead anymore.
 685               MaybeDeadStores[NewOp.StackSlotOrReMat] = NULL;
 686               ++NumLoads;
 687             }
 688             Spills.ClobberPhysReg(NewPhysReg);
 689             Spills.ClobberPhysReg(NewOp.PhysRegReused);
 690
 691             MI->getOperand(NewOp.Operand).setReg(NewPhysReg);
 692
 693             Spills.addAvailable(NewOp.StackSlotOrReMat, MI, NewPhysReg);
 694             MachineBasicBlock::iterator MII = MI;
 695             --MII;
 696             UpdateKills(*MII, RegKills, KillOps);
 697             DOUT << '\t' << *MII;
 698
 699             DOUT << "Reuse undone!\n";
 700             --NumReused;
 701
 702             // Finally, PhysReg is now available, go ahead and use it.
 703             return PhysReg;
 704           }
 705         }
 706       }
 707       return PhysReg;
 708     }
 709
 710     /// GetRegForReload - Helper for the above GetRegForReload(). Add a
 711     /// 'Rejected' set to remember which registers have been considered and
 712     /// rejected for the reload. This avoids infinite looping in case like
 713     /// this:
 714     /// t1 := op t2, t3
 715     /// t2 <- assigned r0 for use by the reload but ended up reuse r1
 716     /// t3 <- assigned r1 for use by the reload but ended up reuse r0
 717     /// t1 <- desires r1
 718     ///       sees r1 is taken by t2, tries t2's reload register r0
 719     ///       sees r0 is taken by t3, tries t3's reload register r1
 720     ///       sees r1 is taken by t2, tries t2's reload register r0 ...
 721     unsigned GetRegForReload(unsigned PhysReg, MachineInstr *MI,
 722                              AvailableSpills &Spills,
 723                              std::vector<MachineInstr*> &MaybeDeadStores,
 724                              BitVector &RegKills,
 725                              std::vector<MachineOperand*> &KillOps,
 726                              VirtRegMap &VRM) {
 727       SmallSet<unsigned, 8> Rejected;
 728       return GetRegForReload(PhysReg, MI, Spills, MaybeDeadStores, Rejected,
 729                              RegKills, KillOps, VRM);
 730     }
 731   };
 732 }
 733
 734 /// PrepForUnfoldOpti - Turn a store folding instruction into a load folding
 735 /// instruction. e.g.
 736 ///     xorl  %edi, %eax
 737 ///     movl  %eax, -32(%ebp)
 738 ///     movl  -36(%ebp), %eax
 739 ///     orl   %eax, -32(%ebp)
 740 /// ==>
 741 ///     xorl  %edi, %eax
 742 ///     orl   -36(%ebp), %eax
 743 ///     mov   %eax, -32(%ebp)
 744 /// This enables unfolding optimization for a subsequent instruction which will
 745 /// also eliminate the newly introduced store instruction.
 746 bool LocalSpiller::PrepForUnfoldOpti(MachineBasicBlock &MBB,
 747                                      MachineBasicBlock::iterator &MII,
 748                                     std::vector<MachineInstr*> &MaybeDeadStores,
 749                                      AvailableSpills &Spills,
 750                                      BitVector &RegKills,
 751                                      std::vector<MachineOperand*> &KillOps,
 752                                      VirtRegMap &VRM) {
 753   MachineFunction &MF = *MBB.getParent();
 754   MachineInstr &MI = *MII;
 755   unsigned UnfoldedOpc = 0;
 756   unsigned UnfoldPR = 0;
 757   unsigned UnfoldVR = 0;
 758   int FoldedSS = VirtRegMap::NO_STACK_SLOT;
 759   VirtRegMap::MI2VirtMapTy::const_iterator I, End;
 760   for (tie(I, End) = VRM.getFoldedVirts(&MI); I != End; ++I) {
 761     // Only transform a MI that folds a single register.
 762     if (UnfoldedOpc)
 763       return false;
 764     UnfoldVR = I->second.first;
 765     VirtRegMap::ModRef MR = I->second.second;
 766     if (VRM.isAssignedReg(UnfoldVR))
 767       continue;
 768     // If this reference is not a use, any previous store is now dead.
 769     // Otherwise, the store to this stack slot is not dead anymore.
 770     FoldedSS = VRM.getStackSlot(UnfoldVR);
 771     MachineInstr* DeadStore = MaybeDeadStores[FoldedSS];
 772     if (DeadStore && (MR & VirtRegMap::isModRef)) {
 773       unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(FoldedSS);
 774       if (!PhysReg ||
 775           DeadStore->findRegisterUseOperandIdx(PhysReg, true) == -1)
 776         continue;
 777       UnfoldPR = PhysReg;
 778       UnfoldedOpc = MRI->getOpcodeAfterMemoryUnfold(MI.getOpcode(),
 779                                                     false, true);
 780     }
 781   }
 782
 783   if (!UnfoldedOpc)
 784     return false;
 785
 786   for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
 787     MachineOperand &MO = MI.getOperand(i);
 788     if (!MO.isRegister() || MO.getReg() == 0 || !MO.isUse())
 789       continue;
 790     unsigned VirtReg = MO.getReg();
 791     if (MRegisterInfo::isPhysicalRegister(VirtReg) || MO.getSubReg())
 792       continue;
 793     if (VRM.isAssignedReg(VirtReg)) {
 794       unsigned PhysReg = VRM.getPhys(VirtReg);
 795       if (PhysReg && MRI->regsOverlap(PhysReg, UnfoldPR))
 796         return false;
 797     } else if (VRM.isReMaterialized(VirtReg))
 798       continue;
 799     int SS = VRM.getStackSlot(VirtReg);
 800     unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(SS);
 801     if (PhysReg) {
 802       if (MRI->regsOverlap(PhysReg, UnfoldPR))
 803         return false;
 804       continue;
 805     }
 806     PhysReg = VRM.getPhys(VirtReg);
 807     if (!MRI->regsOverlap(PhysReg, UnfoldPR))
 808       continue;
 809
 810     // Ok, we'll need to reload the value into a register which makes
 811     // it impossible to perform the store unfolding optimization later.
 812     // Let's see if it is possible to fold the load if the store is
 813     // unfolded. This allows us to perform the store unfolding
 814     // optimization.
 815     SmallVector<MachineInstr*, 4> NewMIs;
 816     if (MRI->unfoldMemoryOperand(MF, &MI, UnfoldVR, false, false, NewMIs)) {
 817       assert(NewMIs.size() == 1);
 818       MachineInstr *NewMI = NewMIs.back();
 819       NewMIs.clear();
 820       unsigned Idx = NewMI->findRegisterUseOperandIdx(VirtReg);
 821       MachineInstr *FoldedMI = MRI->foldMemoryOperand(NewMI, Idx, SS);
 822       if (FoldedMI) {
 823         if (!VRM.hasPhys(UnfoldVR))
 824           VRM.assignVirt2Phys(UnfoldVR, UnfoldPR);
 825         VRM.virtFolded(VirtReg, FoldedMI, VirtRegMap::isRef);
 826         MII = MBB.insert(MII, FoldedMI);
 827         VRM.RemoveFromFoldedVirtMap(&MI);
 828         MBB.erase(&MI);
 829         return true;
 830       }
 831       delete NewMI;
 832     }
 833   }
 834   return false;
 835 }
 836
 837 /// findSuperReg - Find the SubReg's super-register of given register class
 838 /// where its SubIdx sub-register is SubReg.
 839 static unsigned findSuperReg(const TargetRegisterClass *RC, unsigned SubReg,
 840                              unsigned SubIdx, const MRegisterInfo *MRI) {
 841   for (TargetRegisterClass::iterator I = RC->begin(), E = RC->end();
 842        I != E; ++I) {
 843     unsigned Reg = *I;
 844     if (MRI->getSubReg(Reg, SubIdx) == SubReg)
 845       return Reg;
 846   }
 847   return 0;
 848 }
 849
 850 /// rewriteMBB - Keep track of which spills are available even after the
 851 /// register allocator is done with them.  If possible, avoid reloading vregs.
 852 void LocalSpiller::RewriteMBB(MachineBasicBlock &MBB, VirtRegMap &VRM) {
 853   DOUT << MBB.getBasicBlock()->getName() << ":\n";
 854
 855   MachineFunction &MF = *MBB.getParent();
 856
 857   // Spills - Keep track of which spilled values are available in physregs so
 858   // that we can choose to reuse the physregs instead of emitting reloads.
 859   AvailableSpills Spills(MRI, TII);
 860
 861   // MaybeDeadStores - When we need to write a value back into a stack slot,
 862   // keep track of the inserted store.  If the stack slot value is never read
 863   // (because the value was used from some available register, for example), and
 864   // subsequently stored to, the original store is dead.  This map keeps track
 865   // of inserted stores that are not used.  If we see a subsequent store to the
 866   // same stack slot, the original store is deleted.
 867   std::vector<MachineInstr*> MaybeDeadStores;
 868   MaybeDeadStores.resize(MF.getFrameInfo()->getObjectIndexEnd(), NULL);
 869
 870   // ReMatDefs - These are rematerializable def MIs which are not deleted.
 871   SmallSet<MachineInstr*, 4> ReMatDefs;
 872
 873   // Keep track of kill information.
 874   BitVector RegKills(MRI->getNumRegs());
 875   std::vector<MachineOperand*>  KillOps;
 876   KillOps.resize(MRI->getNumRegs(), NULL);
 877
 878   for (MachineBasicBlock::iterator MII = MBB.begin(), E = MBB.end();
 879        MII != E; ) {
 880     MachineBasicBlock::iterator NextMII = MII; ++NextMII;
 881
 882     VirtRegMap::MI2VirtMapTy::const_iterator I, End;
 883     bool Erased = false;
 884     bool BackTracked = false;
 885     if (PrepForUnfoldOpti(MBB, MII,
 886                           MaybeDeadStores, Spills, RegKills, KillOps, VRM))
 887       NextMII = next(MII);
 888
 889     /// ReusedOperands - Keep track of operand reuse in case we need to undo
 890     /// reuse.
 891     MachineInstr &MI = *MII;
 892     ReuseInfo ReusedOperands(MI, MRI);
 893
 894     const TargetInstrDescriptor *TID = MI.getInstrDescriptor();
 895
 896     // Process all of the spilled uses and all non spilled reg references.
 897     for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
 898       MachineOperand &MO = MI.getOperand(i);
 899       if (!MO.isRegister() || MO.getReg() == 0)
 900         continue;   // Ignore non-register operands.
 901
 902       unsigned VirtReg = MO.getReg();
 903       if (MRegisterInfo::isPhysicalRegister(VirtReg)) {
 904         // Ignore physregs for spilling, but remember that it is used by this
 905         // function.
 906         MF.setPhysRegUsed(VirtReg);
 907         continue;
 908       }
 909
 910       assert(MRegisterInfo::isVirtualRegister(VirtReg) &&
 911              "Not a virtual or a physical register?");
 912
 913       unsigned SubIdx = MO.getSubReg();
 914       if (VRM.isAssignedReg(VirtReg)) {
 915         // This virtual register was assigned a physreg!
 916         unsigned Phys = VRM.getPhys(VirtReg);
 917         MF.setPhysRegUsed(Phys);
 918         if (MO.isDef())
 919           ReusedOperands.markClobbered(Phys);
 920         unsigned RReg = SubIdx ? MRI->getSubReg(Phys, SubIdx) : Phys;
 921         MI.getOperand(i).setReg(RReg);
 922         continue;
 923       }
 924
 925       // This virtual register is now known to be a spilled value.
 926       if (!MO.isUse())
 927         continue;  // Handle defs in the loop below (handle use&def here though)
 928
 929       bool DoReMat = VRM.isReMaterialized(VirtReg);
 930       int SSorRMId = DoReMat
 931         ? VRM.getReMatId(VirtReg) : VRM.getStackSlot(VirtReg);
 932       int ReuseSlot = SSorRMId;
 933
 934       // Check to see if this stack slot is available.
 935       unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(SSorRMId);
 936       if (!PhysReg && DoReMat) {
 937         // This use is rematerializable. But perhaps the value is available in
 938         // a register if the definition is not deleted. If so, check if we can
 939         // reuse the value.
 940         ReuseSlot = VRM.getStackSlot(VirtReg);
 941         if (ReuseSlot != VirtRegMap::NO_STACK_SLOT)
 942           PhysReg = Spills.getSpillSlotOrReMatPhysReg(ReuseSlot);
 943       }
 944
 945       // If this is a sub-register use, make sure the reuse register is in the
 946       // right register class. For example, for x86 not all of the 32-bit
 947       // registers have accessible sub-registers.
 948       // Similarly so for EXTRACT_SUBREG. Consider this:
 949       // EDI = op
 950       // MOV32_mr fi#1, EDI
 951       // ...
 952       //       = EXTRACT_SUBREG fi#1
 953       // fi#1 is available in EDI, but it cannot be reused because it's not in
 954       // the right register file.
 955       if (PhysReg &&
 956           (SubIdx || MI.getOpcode() == TargetInstrInfo::EXTRACT_SUBREG)) {
 957         const TargetRegisterClass* RC = RegMap->getRegClass(VirtReg);
 958         if (!RC->contains(PhysReg))
 959           PhysReg = 0;
 960       }
 961
 962       if (PhysReg) {
 963         // This spilled operand might be part of a two-address operand.  If this
 964         // is the case, then changing it will necessarily require changing the
 965         // def part of the instruction as well.  However, in some cases, we
 966         // aren't allowed to modify the reused register.  If none of these cases
 967         // apply, reuse it.
 968         bool CanReuse = true;
 969         int ti = TID->getOperandConstraint(i, TOI::TIED_TO);
 970         if (ti != -1 &&
 971             MI.getOperand(ti).isRegister() &&
 972             MI.getOperand(ti).getReg() == VirtReg) {
 973           // Okay, we have a two address operand.  We can reuse this physreg as
 974           // long as we are allowed to clobber the value and there isn't an
 975           // earlier def that has already clobbered the physreg.
 976           CanReuse = Spills.canClobberPhysReg(ReuseSlot) &&
 977             !ReusedOperands.isClobbered(PhysReg);
 978         }
 979
 980         if (CanReuse) {
 981           // If this stack slot value is already available, reuse it!
 982           if (ReuseSlot > VirtRegMap::MAX_STACK_SLOT)
 983             DOUT << "Reusing RM#" << ReuseSlot-VirtRegMap::MAX_STACK_SLOT-1;
 984           else
 985             DOUT << "Reusing SS#" << ReuseSlot;
 986           DOUT << " from physreg "
 987                << MRI->getName(PhysReg) << " for vreg"
 988                << VirtReg <<" instead of reloading into physreg "
 989                << MRI->getName(VRM.getPhys(VirtReg)) << "\n";
 990           unsigned RReg = SubIdx ? MRI->getSubReg(PhysReg, SubIdx) : PhysReg;
 991           MI.getOperand(i).setReg(RReg);
 992
 993           // The only technical detail we have is that we don't know that
 994           // PhysReg won't be clobbered by a reloaded stack slot that occurs
 995           // later in the instruction.  In particular, consider 'op V1, V2'.
 996           // If V1 is available in physreg R0, we would choose to reuse it
 997           // here, instead of reloading it into the register the allocator
 998           // indicated (say R1).  However, V2 might have to be reloaded
 999           // later, and it might indicate that it needs to live in R0.  When
1000           // this occurs, we need to have information available that
1001           // indicates it is safe to use R1 for the reload instead of R0.
1002           //
1003           // To further complicate matters, we might conflict with an alias,
1004           // or R0 and R1 might not be compatible with each other.  In this
1005           // case, we actually insert a reload for V1 in R1, ensuring that
1006           // we can get at R0 or its alias.
1007           ReusedOperands.addReuse(i, ReuseSlot, PhysReg,
1008                                   VRM.getPhys(VirtReg), VirtReg);
1009           if (ti != -1)
1010             // Only mark it clobbered if this is a use&def operand.
1011             ReusedOperands.markClobbered(PhysReg);
1012           ++NumReused;
1013
1014           if (MI.getOperand(i).isKill() &&
1015               ReuseSlot <= VirtRegMap::MAX_STACK_SLOT) {
1016             // This was the last use and the spilled value is still available
1017             // for reuse. That means the spill was unnecessary!
1018             MachineInstr* DeadStore = MaybeDeadStores[ReuseSlot];
1019             if (DeadStore) {
1020               DOUT << "Removed dead store:\t" << *DeadStore;
1021               InvalidateKills(*DeadStore, RegKills, KillOps);
1022               VRM.RemoveFromFoldedVirtMap(DeadStore);
1023               MBB.erase(DeadStore);
1024               MaybeDeadStores[ReuseSlot] = NULL;
1025               ++NumDSE;
1026             }
1027           }
1028           continue;
1029         }  // CanReuse
1030
1031         // Otherwise we have a situation where we have a two-address instruction
1032         // whose mod/ref operand needs to be reloaded.  This reload is already
1033         // available in some register "PhysReg", but if we used PhysReg as the
1034         // operand to our 2-addr instruction, the instruction would modify
1035         // PhysReg.  This isn't cool if something later uses PhysReg and expects
1036         // to get its initial value.
1037         //
1038         // To avoid this problem, and to avoid doing a load right after a store,
1039         // we emit a copy from PhysReg into the designated register for this
1040         // operand.
1041         unsigned DesignatedReg = VRM.getPhys(VirtReg);
1042         assert(DesignatedReg && "Must map virtreg to physreg!");
1043
1044         // Note that, if we reused a register for a previous operand, the
1045         // register we want to reload into might not actually be
1046         // available.  If this occurs, use the register indicated by the
1047         // reuser.
1048         if (ReusedOperands.hasReuses())
1049           DesignatedReg = ReusedOperands.GetRegForReload(DesignatedReg, &MI,
1050                                Spills, MaybeDeadStores, RegKills, KillOps, VRM);
1051
1052         // If the mapped designated register is actually the physreg we have
1053         // incoming, we don't need to inserted a dead copy.
1054         if (DesignatedReg == PhysReg) {
1055           // If this stack slot value is already available, reuse it!
1056           if (ReuseSlot > VirtRegMap::MAX_STACK_SLOT)
1057             DOUT << "Reusing RM#" << ReuseSlot-VirtRegMap::MAX_STACK_SLOT-1;
1058           else
1059             DOUT << "Reusing SS#" << ReuseSlot;
1060           DOUT << " from physreg " << MRI->getName(PhysReg) << " for vreg"
1061                << VirtReg
1062                << " instead of reloading into same physreg.\n";
1063           unsigned RReg = SubIdx ? MRI->getSubReg(PhysReg, SubIdx) : PhysReg;
1064           MI.getOperand(i).setReg(RReg);
1065           ReusedOperands.markClobbered(RReg);
1066           ++NumReused;
1067           continue;
1068         }
1069
1070         const TargetRegisterClass* RC = RegMap->getRegClass(VirtReg);
1071         MF.setPhysRegUsed(DesignatedReg);
1072         ReusedOperands.markClobbered(DesignatedReg);
1073         MRI->copyRegToReg(MBB, &MI, DesignatedReg, PhysReg, RC, RC);
1074
1075         MachineInstr *CopyMI = prior(MII);
1076         UpdateKills(*CopyMI, RegKills, KillOps);
1077
1078         // This invalidates DesignatedReg.
1079         Spills.ClobberPhysReg(DesignatedReg);
1080
1081         Spills.addAvailable(ReuseSlot, &MI, DesignatedReg);
1082         unsigned RReg =
1083           SubIdx ? MRI->getSubReg(DesignatedReg, SubIdx) : DesignatedReg;
1084         MI.getOperand(i).setReg(RReg);
1085         DOUT << '\t' << *prior(MII);
1086         ++NumReused;
1087         continue;
1088       } // if (PhysReg)
1089
1090       // Otherwise, reload it and remember that we have it.
1091       PhysReg = VRM.getPhys(VirtReg);
1092       assert(PhysReg && "Must map virtreg to physreg!");
1093
1094       // Note that, if we reused a register for a previous operand, the
1095       // register we want to reload into might not actually be
1096       // available.  If this occurs, use the register indicated by the
1097       // reuser.
1098       if (ReusedOperands.hasReuses())
1099         PhysReg = ReusedOperands.GetRegForReload(PhysReg, &MI,
1100                                Spills, MaybeDeadStores, RegKills, KillOps, VRM);
1101
1102       MF.setPhysRegUsed(PhysReg);
1103       ReusedOperands.markClobbered(PhysReg);
1104       if (DoReMat) {
1105         MRI->reMaterialize(MBB, &MI, PhysReg, VRM.getReMaterializedMI(VirtReg));
1106         ++NumReMats;
1107       } else {
1108         const TargetRegisterClass* RC = RegMap->getRegClass(VirtReg);
1109         MRI->loadRegFromStackSlot(MBB, &MI, PhysReg, SSorRMId, RC);
1110         ++NumLoads;
1111       }
1112       // This invalidates PhysReg.
1113       Spills.ClobberPhysReg(PhysReg);
1114
1115       // Any stores to this stack slot are not dead anymore.
1116       if (!DoReMat)
1117         MaybeDeadStores[SSorRMId] = NULL;
1118       Spills.addAvailable(SSorRMId, &MI, PhysReg);
1119       // Assumes this is the last use. IsKill will be unset if reg is reused
1120       // unless it's a two-address operand.
1121       if (TID->getOperandConstraint(i, TOI::TIED_TO) == -1)
1122         MI.getOperand(i).setIsKill();
1123       unsigned RReg = SubIdx ? MRI->getSubReg(PhysReg, SubIdx) : PhysReg;
1124       MI.getOperand(i).setReg(RReg);
1125       UpdateKills(*prior(MII), RegKills, KillOps);
1126       DOUT << '\t' << *prior(MII);
1127     }
1128
1129     DOUT << '\t' << MI;
1130
1131     // If we have folded references to memory operands, make sure we clear all
1132     // physical registers that may contain the value of the spilled virtual
1133     // register
1134     SmallSet<int, 2> FoldedSS;
1135     for (tie(I, End) = VRM.getFoldedVirts(&MI); I != End; ++I) {
1136       unsigned VirtReg = I->second.first;
1137       VirtRegMap::ModRef MR = I->second.second;
1138       DOUT << "Folded vreg: " << VirtReg << "  MR: " << MR;
1139       if (VRM.isAssignedReg(VirtReg)) {
1140         DOUT << ": No stack slot!\n";
1141         continue;
1142       }
1143       int SS = VRM.getStackSlot(VirtReg);
1144       FoldedSS.insert(SS);
1145       DOUT << " - StackSlot: " << SS << "\n";
1146
1147       // If this folded instruction is just a use, check to see if it's a
1148       // straight load from the virt reg slot.
1149       if ((MR & VirtRegMap::isRef) && !(MR & VirtRegMap::isMod)) {
1150         int FrameIdx;
1151         unsigned DestReg = TII->isLoadFromStackSlot(&MI, FrameIdx);
1152         if (DestReg && FrameIdx == SS) {
1153           // If this spill slot is available, turn it into a copy (or nothing)
1154           // instead of leaving it as a load!
1155           if (unsigned InReg = Spills.getSpillSlotOrReMatPhysReg(SS)) {
1156             DOUT << "Promoted Load To Copy: " << MI;
1157             if (DestReg != InReg) {
1158               const TargetRegisterClass *RC = RegMap->getRegClass(VirtReg);
1159               MRI->copyRegToReg(MBB, &MI, DestReg, InReg, RC, RC);
1160               // Revisit the copy so we make sure to notice the effects of the
1161               // operation on the destreg (either needing to RA it if it's
1162               // virtual or needing to clobber any values if it's physical).
1163               NextMII = &MI;
1164               --NextMII;  // backtrack to the copy.
1165               BackTracked = true;
1166             } else
1167               DOUT << "Removing now-noop copy: " << MI;
1168
1169             VRM.RemoveFromFoldedVirtMap(&MI);
1170             MBB.erase(&MI);
1171             Erased = true;
1172             goto ProcessNextInst;
1173           }
1174         } else {
1175           unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(SS);
1176           SmallVector<MachineInstr*, 4> NewMIs;
1177           if (PhysReg &&
1178               MRI->unfoldMemoryOperand(MF, &MI, PhysReg, false, false, NewMIs)) {
1179             MBB.insert(MII, NewMIs[0]);
1180             VRM.RemoveFromFoldedVirtMap(&MI);
1181             MBB.erase(&MI);
1182             Erased = true;
1183             --NextMII;  // backtrack to the unfolded instruction.
1184             BackTracked = true;
1185             goto ProcessNextInst;
1186           }
1187         }
1188       }
1189
1190       // If this reference is not a use, any previous store is now dead.
1191       // Otherwise, the store to this stack slot is not dead anymore.
1192       MachineInstr* DeadStore = MaybeDeadStores[SS];
1193       if (DeadStore) {
1194         bool isDead = !(MR & VirtRegMap::isRef);
1195         MachineInstr *NewStore = NULL;
1196         if (MR & VirtRegMap::isModRef) {
1197           unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(SS);
1198           SmallVector<MachineInstr*, 4> NewMIs;
1199           if (PhysReg &&
1200               DeadStore->findRegisterUseOperandIdx(PhysReg, true) != -1 &&
1201               MRI->unfoldMemoryOperand(MF, &MI, PhysReg, false, true, NewMIs)) {
1202             MBB.insert(MII, NewMIs[0]);
1203             NewStore = NewMIs[1];
1204             MBB.insert(MII, NewStore);
1205             VRM.RemoveFromFoldedVirtMap(&MI);
1206             MBB.erase(&MI);
1207             Erased = true;
1208             --NextMII;
1209             --NextMII;  // backtrack to the unfolded instruction.
1210             BackTracked = true;
1211             isDead = true;
1212           }
1213         }
1214
1215         if (isDead) {  // Previous store is dead.
1216           // If we get here, the store is dead, nuke it now.
1217           DOUT << "Removed dead store:\t" << *DeadStore;
1218           InvalidateKills(*DeadStore, RegKills, KillOps);
1219           VRM.RemoveFromFoldedVirtMap(DeadStore);
1220           MBB.erase(DeadStore);
1221           if (!NewStore)
1222             ++NumDSE;
1223         }
1224
1225         MaybeDeadStores[SS] = NULL;
1226         if (NewStore) {
1227           // Treat this store as a spill merged into a copy. That makes the
1228           // stack slot value available.
1229           VRM.virtFolded(VirtReg, NewStore, VirtRegMap::isMod);
1230           goto ProcessNextInst;
1231         }
1232       }
1233
1234       // If the spill slot value is available, and this is a new definition of
1235       // the value, the value is not available anymore.
1236       if (MR & VirtRegMap::isMod) {
1237         // Notice that the value in this stack slot has been modified.
1238         Spills.ModifyStackSlotOrReMat(SS);
1239
1240         // If this is *just* a mod of the value, check to see if this is just a
1241         // store to the spill slot (i.e. the spill got merged into the copy). If
1242         // so, realize that the vreg is available now, and add the store to the
1243         // MaybeDeadStore info.
1244         int StackSlot;
1245         if (!(MR & VirtRegMap::isRef)) {
1246           if (unsigned SrcReg = TII->isStoreToStackSlot(&MI, StackSlot)) {
1247             assert(MRegisterInfo::isPhysicalRegister(SrcReg) &&
1248                    "Src hasn't been allocated yet?");
1249             // Okay, this is certainly a store of SrcReg to [StackSlot].  Mark
1250             // this as a potentially dead store in case there is a subsequent
1251             // store into the stack slot without a read from it.
1252             MaybeDeadStores[StackSlot] = &MI;
1253
1254             // If the stack slot value was previously available in some other
1255             // register, change it now.  Otherwise, make the register available,
1256             // in PhysReg.
1257             Spills.addAvailable(StackSlot, &MI, SrcReg, false/*don't clobber*/);
1258           }
1259         }
1260       }
1261     }
1262
1263     // Process all of the spilled defs.
1264     for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
1265       MachineOperand &MO = MI.getOperand(i);
1266       if (!(MO.isRegister() && MO.getReg() && MO.isDef()))
1267         continue;
1268
1269       unsigned VirtReg = MO.getReg();
1270       if (!MRegisterInfo::isVirtualRegister(VirtReg)) {
1271         // Check to see if this is a noop copy.  If so, eliminate the
1272         // instruction before considering the dest reg to be changed.
1273         unsigned Src, Dst;
1274         if (TII->isMoveInstr(MI, Src, Dst) && Src == Dst) {
1275           ++NumDCE;
1276           DOUT << "Removing now-noop copy: " << MI;
1277           MBB.erase(&MI);
1278           Erased = true;
1279           VRM.RemoveFromFoldedVirtMap(&MI);
1280           Spills.disallowClobberPhysReg(VirtReg);
1281           goto ProcessNextInst;
1282         }
1283
1284         // If it's not a no-op copy, it clobbers the value in the destreg.
1285         Spills.ClobberPhysReg(VirtReg);
1286         ReusedOperands.markClobbered(VirtReg);
1287
1288         // Check to see if this instruction is a load from a stack slot into
1289         // a register.  If so, this provides the stack slot value in the reg.
1290         int FrameIdx;
1291         if (unsigned DestReg = TII->isLoadFromStackSlot(&MI, FrameIdx)) {
1292           assert(DestReg == VirtReg && "Unknown load situation!");
1293
1294           // If it is a folded reference, then it's not safe to clobber.
1295           bool Folded = FoldedSS.count(FrameIdx);
1296           // Otherwise, if it wasn't available, remember that it is now!
1297           Spills.addAvailable(FrameIdx, &MI, DestReg, !Folded);
1298           goto ProcessNextInst;
1299         }
1300
1301         continue;
1302       }
1303
1304       unsigned SubIdx = MO.getSubReg();
1305       bool DoReMat = VRM.isReMaterialized(VirtReg);
1306       if (DoReMat)
1307         ReMatDefs.insert(&MI);
1308
1309       // The only vregs left are stack slot definitions.
1310       int StackSlot = VRM.getStackSlot(VirtReg);
1311       const TargetRegisterClass *RC = RegMap->getRegClass(VirtReg);
1312
1313       // If this def is part of a two-address operand, make sure to execute
1314       // the store from the correct physical register.
1315       unsigned PhysReg;
1316       int TiedOp = MI.getInstrDescriptor()->findTiedToSrcOperand(i);
1317       if (TiedOp != -1) {
1318         PhysReg = MI.getOperand(TiedOp).getReg();
1319         if (SubIdx) {
1320           unsigned SuperReg = findSuperReg(RC, PhysReg, SubIdx, MRI);
1321           assert(SuperReg && MRI->getSubReg(SuperReg, SubIdx) == PhysReg &&
1322                  "Can't find corresponding super-register!");
1323           PhysReg = SuperReg;
1324         }
1325       } else {
1326         PhysReg = VRM.getPhys(VirtReg);
1327         if (ReusedOperands.isClobbered(PhysReg)) {
1328           // Another def has taken the assigned physreg. It must have been a
1329           // use&def which got it due to reuse. Undo the reuse!
1330           PhysReg = ReusedOperands.GetRegForReload(PhysReg, &MI,
1331                                Spills, MaybeDeadStores, RegKills, KillOps, VRM);
1332         }
1333       }
1334
1335       MF.setPhysRegUsed(PhysReg);
1336       unsigned RReg = SubIdx ? MRI->getSubReg(PhysReg, SubIdx) : PhysReg;
1337       ReusedOperands.markClobbered(RReg);
1338       MI.getOperand(i).setReg(RReg);
1339
1340       if (!MO.isDead()) {
1341         MRI->storeRegToStackSlot(MBB, next(MII), PhysReg, StackSlot, RC);
1342         DOUT << "Store:\t" << *next(MII);
1343
1344         // If there is a dead store to this stack slot, nuke it now.
1345         MachineInstr *&LastStore = MaybeDeadStores[StackSlot];
1346         if (LastStore) {
1347           DOUT << "Removed dead store:\t" << *LastStore;
1348           ++NumDSE;
1349           SmallVector<unsigned, 2> KillRegs;
1350           InvalidateKills(*LastStore, RegKills, KillOps, &KillRegs);
1351           MachineBasicBlock::iterator PrevMII = LastStore;
1352           bool CheckDef = PrevMII != MBB.begin();
1353           if (CheckDef)
1354             --PrevMII;
1355           MBB.erase(LastStore);
1356           VRM.RemoveFromFoldedVirtMap(LastStore);
1357           if (CheckDef) {
1358             // Look at defs of killed registers on the store. Mark the defs
1359             // as dead since the store has been deleted and they aren't
1360             // being reused.
1361             for (unsigned j = 0, ee = KillRegs.size(); j != ee; ++j) {
1362               bool HasOtherDef = false;
1363               if (InvalidateRegDef(PrevMII, MI, KillRegs[j], HasOtherDef)) {
1364                 MachineInstr *DeadDef = PrevMII;
1365                 if (ReMatDefs.count(DeadDef) && !HasOtherDef) {
1366                   // FIXME: This assumes a remat def does not have side
1367                   // effects.
1368                   MBB.erase(DeadDef);
1369                   VRM.RemoveFromFoldedVirtMap(DeadDef);
1370                   ++NumDRM;
1371                 }
1372               }
1373             }
1374           }
1375         }
1376         LastStore = next(MII);
1377
1378         // If the stack slot value was previously available in some other
1379         // register, change it now.  Otherwise, make the register available,
1380         // in PhysReg.
1381         Spills.ModifyStackSlotOrReMat(StackSlot);
1382         Spills.ClobberPhysReg(PhysReg);
1383         Spills.addAvailable(StackSlot, LastStore, PhysReg);
1384         ++NumStores;
1385
1386         // Check to see if this is a noop copy.  If so, eliminate the
1387         // instruction before considering the dest reg to be changed.
1388         {
1389           unsigned Src, Dst;
1390           if (TII->isMoveInstr(MI, Src, Dst) && Src == Dst) {
1391             ++NumDCE;
1392             DOUT << "Removing now-noop copy: " << MI;
1393             MBB.erase(&MI);
1394             Erased = true;
1395             VRM.RemoveFromFoldedVirtMap(&MI);
1396             UpdateKills(*LastStore, RegKills, KillOps);
1397             goto ProcessNextInst;
1398           }
1399         }
1400       }
1401     }
1402   ProcessNextInst:
1403     if (!Erased && !BackTracked)
1404       for (MachineBasicBlock::iterator II = MI; II != NextMII; ++II)
1405         UpdateKills(*II, RegKills, KillOps);
1406     MII = NextMII;
1407   }
1408 }
1409
1410
1411 llvm::Spiller* llvm::createSpiller() {
1412   switch (SpillerOpt) {
1413   default: assert(0 && "Unreachable!");
1414   case local:
1415     return new LocalSpiller();
1416   case simple:
1417     return new SimpleSpiller();
1418   }
1419 }