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) ||
 792         RegMap->isSubRegister(VirtReg))
 793       continue;
 794     if (VRM.isAssignedReg(VirtReg)) {
 795       unsigned PhysReg = VRM.getPhys(VirtReg);
 796       if (PhysReg && MRI->regsOverlap(PhysReg, UnfoldPR))
 797         return false;
 798     } else if (VRM.isReMaterialized(VirtReg))
 799       continue;
 800     int SS = VRM.getStackSlot(VirtReg);
 801     unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(SS);
 802     if (PhysReg) {
 803       if (MRI->regsOverlap(PhysReg, UnfoldPR))
 804         return false;
 805       continue;
 806     }
 807     PhysReg = VRM.getPhys(VirtReg);
 808     if (!MRI->regsOverlap(PhysReg, UnfoldPR))
 809       continue;
 810
 811     // Ok, we'll need to reload the value into a register which makes
 812     // it impossible to perform the store unfolding optimization later.
 813     // Let's see if it is possible to fold the load if the store is
 814     // unfolded. This allows us to perform the store unfolding
 815     // optimization.
 816     SmallVector<MachineInstr*, 4> NewMIs;
 817     if (MRI->unfoldMemoryOperand(MF, &MI, UnfoldVR, false, false, NewMIs)) {
 818       assert(NewMIs.size() == 1);
 819       MachineInstr *NewMI = NewMIs.back();
 820       NewMIs.clear();
 821       unsigned Idx = NewMI->findRegisterUseOperandIdx(VirtReg);
 822       MachineInstr *FoldedMI = MRI->foldMemoryOperand(NewMI, Idx, SS);
 823       if (FoldedMI) {
 824         if (!VRM.hasPhys(UnfoldVR))
 825           VRM.assignVirt2Phys(UnfoldVR, UnfoldPR);
 826         VRM.virtFolded(VirtReg, FoldedMI, VirtRegMap::isRef);
 827         MII = MBB.insert(MII, FoldedMI);
 828         VRM.RemoveFromFoldedVirtMap(&MI);
 829         MBB.erase(&MI);
 830         return true;
 831       }
 832       delete NewMI;
 833     }
 834   }
 835   return false;
 836 }
 837
 838 /// rewriteMBB - Keep track of which spills are available even after the
 839 /// register allocator is done with them.  If possible, avoid reloading vregs.
 840 void LocalSpiller::RewriteMBB(MachineBasicBlock &MBB, VirtRegMap &VRM) {
 841   DOUT << MBB.getBasicBlock()->getName() << ":\n";
 842
 843   MachineFunction &MF = *MBB.getParent();
 844
 845   // Spills - Keep track of which spilled values are available in physregs so
 846   // that we can choose to reuse the physregs instead of emitting reloads.
 847   AvailableSpills Spills(MRI, TII);
 848
 849   // MaybeDeadStores - When we need to write a value back into a stack slot,
 850   // keep track of the inserted store.  If the stack slot value is never read
 851   // (because the value was used from some available register, for example), and
 852   // subsequently stored to, the original store is dead.  This map keeps track
 853   // of inserted stores that are not used.  If we see a subsequent store to the
 854   // same stack slot, the original store is deleted.
 855   std::vector<MachineInstr*> MaybeDeadStores;
 856   MaybeDeadStores.resize(MF.getFrameInfo()->getObjectIndexEnd(), NULL);
 857
 858   // ReMatDefs - These are rematerializable def MIs which are not deleted.
 859   SmallSet<MachineInstr*, 4> ReMatDefs;
 860
 861   // Keep track of kill information.
 862   BitVector RegKills(MRI->getNumRegs());
 863   std::vector<MachineOperand*>  KillOps;
 864   KillOps.resize(MRI->getNumRegs(), NULL);
 865
 866   for (MachineBasicBlock::iterator MII = MBB.begin(), E = MBB.end();
 867        MII != E; ) {
 868     MachineBasicBlock::iterator NextMII = MII; ++NextMII;
 869
 870     VirtRegMap::MI2VirtMapTy::const_iterator I, End;
 871     bool Erased = false;
 872     bool BackTracked = false;
 873     if (PrepForUnfoldOpti(MBB, MII,
 874                           MaybeDeadStores, Spills, RegKills, KillOps, VRM))
 875       NextMII = next(MII);
 876
 877     /// ReusedOperands - Keep track of operand reuse in case we need to undo
 878     /// reuse.
 879     MachineInstr &MI = *MII;
 880     ReuseInfo ReusedOperands(MI, MRI);
 881
 882     const TargetInstrDescriptor *TID = MI.getInstrDescriptor();
 883
 884     // Process all of the spilled uses and all non spilled reg references.
 885     for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
 886       MachineOperand &MO = MI.getOperand(i);
 887       if (!MO.isRegister() || MO.getReg() == 0)
 888         continue;   // Ignore non-register operands.
 889
 890       unsigned VirtReg = MO.getReg();
 891       if (MRegisterInfo::isPhysicalRegister(VirtReg)) {
 892         // Ignore physregs for spilling, but remember that it is used by this
 893         // function.
 894         MF.setPhysRegUsed(VirtReg);
 895         continue;
 896       }
 897
 898       assert(MRegisterInfo::isVirtualRegister(VirtReg) &&
 899              "Not a virtual or a physical register?");
 900
 901       unsigned SubIdx = 0;
 902       bool isSubReg = RegMap->isSubRegister(VirtReg);
 903       if (isSubReg) {
 904         SubIdx = RegMap->getSubRegisterIndex(VirtReg);
 905         VirtReg = RegMap->getSuperRegister(VirtReg);
 906       }
 907
 908       if (VRM.isAssignedReg(VirtReg)) {
 909         // This virtual register was assigned a physreg!
 910         unsigned Phys = VRM.getPhys(VirtReg);
 911         MF.setPhysRegUsed(Phys);
 912         if (MO.isDef())
 913           ReusedOperands.markClobbered(Phys);
 914         unsigned RReg = isSubReg ? MRI->getSubReg(Phys, SubIdx) : Phys;
 915         MI.getOperand(i).setReg(RReg);
 916         continue;
 917       }
 918
 919       // This virtual register is now known to be a spilled value.
 920       if (!MO.isUse())
 921         continue;  // Handle defs in the loop below (handle use&def here though)
 922
 923       bool DoReMat = VRM.isReMaterialized(VirtReg);
 924       int SSorRMId = DoReMat
 925         ? VRM.getReMatId(VirtReg) : VRM.getStackSlot(VirtReg);
 926       int ReuseSlot = SSorRMId;
 927
 928       // Check to see if this stack slot is available.
 929       unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(SSorRMId);
 930       if (!PhysReg && DoReMat) {
 931         // This use is rematerializable. But perhaps the value is available in
 932         // a register if the definition is not deleted. If so, check if we can
 933         // reuse the value.
 934         ReuseSlot = VRM.getStackSlot(VirtReg);
 935         if (ReuseSlot != VirtRegMap::NO_STACK_SLOT)
 936           PhysReg = Spills.getSpillSlotOrReMatPhysReg(ReuseSlot);
 937       }
 938
 939       // If this is a sub-register use, make sure the reuse register is in the
 940       // right register class. For example, for x86 not all of the 32-bit
 941       // registers have accessible sub-registers.
 942       // Similarly so for EXTRACT_SUBREG. Consider this:
 943       // EDI = op
 944       // MOV32_mr fi#1, EDI
 945       // ...
 946       //       = EXTRACT_SUBREG fi#1
 947       // fi#1 is available in EDI, but it cannot be reused because it's not in
 948       // the right register file.
 949       if (PhysReg &&
 950           (isSubReg || MI.getOpcode() == TargetInstrInfo::EXTRACT_SUBREG)) {
 951         const TargetRegisterClass* RC = RegMap->getRegClass(VirtReg);
 952         if (!RC->contains(PhysReg))
 953           PhysReg = 0;
 954       }
 955
 956       if (PhysReg) {
 957         // This spilled operand might be part of a two-address operand.  If this
 958         // is the case, then changing it will necessarily require changing the
 959         // def part of the instruction as well.  However, in some cases, we
 960         // aren't allowed to modify the reused register.  If none of these cases
 961         // apply, reuse it.
 962         bool CanReuse = true;
 963         int ti = TID->getOperandConstraint(i, TOI::TIED_TO);
 964         if (ti != -1 &&
 965             MI.getOperand(ti).isRegister() &&
 966             MI.getOperand(ti).getReg() == VirtReg) {
 967           // Okay, we have a two address operand.  We can reuse this physreg as
 968           // long as we are allowed to clobber the value and there isn't an
 969           // earlier def that has already clobbered the physreg.
 970           CanReuse = Spills.canClobberPhysReg(ReuseSlot) &&
 971             !ReusedOperands.isClobbered(PhysReg);
 972         }
 973
 974         if (CanReuse) {
 975           // If this stack slot value is already available, reuse it!
 976           if (ReuseSlot > VirtRegMap::MAX_STACK_SLOT)
 977             DOUT << "Reusing RM#" << ReuseSlot-VirtRegMap::MAX_STACK_SLOT-1;
 978           else
 979             DOUT << "Reusing SS#" << ReuseSlot;
 980           DOUT << " from physreg "
 981                << MRI->getName(PhysReg) << " for vreg"
 982                << VirtReg <<" instead of reloading into physreg "
 983                << MRI->getName(VRM.getPhys(VirtReg)) << "\n";
 984           unsigned RReg = isSubReg ? MRI->getSubReg(PhysReg, SubIdx) : PhysReg;
 985           MI.getOperand(i).setReg(RReg);
 986
 987           // The only technical detail we have is that we don't know that
 988           // PhysReg won't be clobbered by a reloaded stack slot that occurs
 989           // later in the instruction.  In particular, consider 'op V1, V2'.
 990           // If V1 is available in physreg R0, we would choose to reuse it
 991           // here, instead of reloading it into the register the allocator
 992           // indicated (say R1).  However, V2 might have to be reloaded
 993           // later, and it might indicate that it needs to live in R0.  When
 994           // this occurs, we need to have information available that
 995           // indicates it is safe to use R1 for the reload instead of R0.
 996           //
 997           // To further complicate matters, we might conflict with an alias,
 998           // or R0 and R1 might not be compatible with each other.  In this
 999           // case, we actually insert a reload for V1 in R1, ensuring that
1000           // we can get at R0 or its alias.
1001           ReusedOperands.addReuse(i, ReuseSlot, PhysReg,
1002                                   VRM.getPhys(VirtReg), VirtReg);
1003           if (ti != -1)
1004             // Only mark it clobbered if this is a use&def operand.
1005             ReusedOperands.markClobbered(PhysReg);
1006           ++NumReused;
1007
1008           if (MI.getOperand(i).isKill() &&
1009               ReuseSlot <= VirtRegMap::MAX_STACK_SLOT) {
1010             // This was the last use and the spilled value is still available
1011             // for reuse. That means the spill was unnecessary!
1012             MachineInstr* DeadStore = MaybeDeadStores[ReuseSlot];
1013             if (DeadStore) {
1014               DOUT << "Removed dead store:\t" << *DeadStore;
1015               InvalidateKills(*DeadStore, RegKills, KillOps);
1016               VRM.RemoveFromFoldedVirtMap(DeadStore);
1017               MBB.erase(DeadStore);
1018               MaybeDeadStores[ReuseSlot] = NULL;
1019               ++NumDSE;
1020             }
1021           }
1022           continue;
1023         }  // CanReuse
1024
1025         // Otherwise we have a situation where we have a two-address instruction
1026         // whose mod/ref operand needs to be reloaded.  This reload is already
1027         // available in some register "PhysReg", but if we used PhysReg as the
1028         // operand to our 2-addr instruction, the instruction would modify
1029         // PhysReg.  This isn't cool if something later uses PhysReg and expects
1030         // to get its initial value.
1031         //
1032         // To avoid this problem, and to avoid doing a load right after a store,
1033         // we emit a copy from PhysReg into the designated register for this
1034         // operand.
1035         unsigned DesignatedReg = VRM.getPhys(VirtReg);
1036         assert(DesignatedReg && "Must map virtreg to physreg!");
1037
1038         // Note that, if we reused a register for a previous operand, the
1039         // register we want to reload into might not actually be
1040         // available.  If this occurs, use the register indicated by the
1041         // reuser.
1042         if (ReusedOperands.hasReuses())
1043           DesignatedReg = ReusedOperands.GetRegForReload(DesignatedReg, &MI,
1044                                Spills, MaybeDeadStores, RegKills, KillOps, VRM);
1045
1046         // If the mapped designated register is actually the physreg we have
1047         // incoming, we don't need to inserted a dead copy.
1048         if (DesignatedReg == PhysReg) {
1049           // If this stack slot value is already available, reuse it!
1050           if (ReuseSlot > VirtRegMap::MAX_STACK_SLOT)
1051             DOUT << "Reusing RM#" << ReuseSlot-VirtRegMap::MAX_STACK_SLOT-1;
1052           else
1053             DOUT << "Reusing SS#" << ReuseSlot;
1054           DOUT << " from physreg " << MRI->getName(PhysReg) << " for vreg"
1055                << VirtReg
1056                << " instead of reloading into same physreg.\n";
1057           unsigned RReg = isSubReg ? MRI->getSubReg(PhysReg, SubIdx) : PhysReg;
1058           MI.getOperand(i).setReg(RReg);
1059           ReusedOperands.markClobbered(PhysReg);
1060           ++NumReused;
1061           continue;
1062         }
1063
1064         const TargetRegisterClass* RC = RegMap->getRegClass(VirtReg);
1065         MF.setPhysRegUsed(DesignatedReg);
1066         ReusedOperands.markClobbered(DesignatedReg);
1067         MRI->copyRegToReg(MBB, &MI, DesignatedReg, PhysReg, RC, RC);
1068
1069         MachineInstr *CopyMI = prior(MII);
1070         UpdateKills(*CopyMI, RegKills, KillOps);
1071
1072         // This invalidates DesignatedReg.
1073         Spills.ClobberPhysReg(DesignatedReg);
1074
1075         Spills.addAvailable(ReuseSlot, &MI, DesignatedReg);
1076         unsigned RReg =
1077           isSubReg ? MRI->getSubReg(DesignatedReg, SubIdx) : DesignatedReg;
1078         MI.getOperand(i).setReg(RReg);
1079         DOUT << '\t' << *prior(MII);
1080         ++NumReused;
1081         continue;
1082       } // if (PhysReg)
1083
1084       // Otherwise, reload it and remember that we have it.
1085       PhysReg = VRM.getPhys(VirtReg);
1086       assert(PhysReg && "Must map virtreg to physreg!");
1087
1088       // Note that, if we reused a register for a previous operand, the
1089       // register we want to reload into might not actually be
1090       // available.  If this occurs, use the register indicated by the
1091       // reuser.
1092       if (ReusedOperands.hasReuses())
1093         PhysReg = ReusedOperands.GetRegForReload(PhysReg, &MI,
1094                                Spills, MaybeDeadStores, RegKills, KillOps, VRM);
1095
1096       MF.setPhysRegUsed(PhysReg);
1097       ReusedOperands.markClobbered(PhysReg);
1098       if (DoReMat) {
1099         MRI->reMaterialize(MBB, &MI, PhysReg, VRM.getReMaterializedMI(VirtReg));
1100         ++NumReMats;
1101       } else {
1102         const TargetRegisterClass* RC = RegMap->getRegClass(VirtReg);
1103         MRI->loadRegFromStackSlot(MBB, &MI, PhysReg, SSorRMId, RC);
1104         ++NumLoads;
1105       }
1106       // This invalidates PhysReg.
1107       Spills.ClobberPhysReg(PhysReg);
1108
1109       // Any stores to this stack slot are not dead anymore.
1110       if (!DoReMat)
1111         MaybeDeadStores[SSorRMId] = NULL;
1112       Spills.addAvailable(SSorRMId, &MI, PhysReg);
1113       // Assumes this is the last use. IsKill will be unset if reg is reused
1114       // unless it's a two-address operand.
1115       if (TID->getOperandConstraint(i, TOI::TIED_TO) == -1)
1116         MI.getOperand(i).setIsKill();
1117       unsigned RReg = isSubReg ? MRI->getSubReg(PhysReg, SubIdx) : PhysReg;
1118       MI.getOperand(i).setReg(RReg);
1119       UpdateKills(*prior(MII), RegKills, KillOps);
1120       DOUT << '\t' << *prior(MII);
1121     }
1122
1123     DOUT << '\t' << MI;
1124
1125     // If we have folded references to memory operands, make sure we clear all
1126     // physical registers that may contain the value of the spilled virtual
1127     // register
1128     SmallSet<int, 2> FoldedSS;
1129     for (tie(I, End) = VRM.getFoldedVirts(&MI); I != End; ++I) {
1130       unsigned VirtReg = I->second.first;
1131       VirtRegMap::ModRef MR = I->second.second;
1132       DOUT << "Folded vreg: " << VirtReg << "  MR: " << MR;
1133       if (VRM.isAssignedReg(VirtReg)) {
1134         DOUT << ": No stack slot!\n";
1135         continue;
1136       }
1137       int SS = VRM.getStackSlot(VirtReg);
1138       FoldedSS.insert(SS);
1139       DOUT << " - StackSlot: " << SS << "\n";
1140
1141       // If this folded instruction is just a use, check to see if it's a
1142       // straight load from the virt reg slot.
1143       if ((MR & VirtRegMap::isRef) && !(MR & VirtRegMap::isMod)) {
1144         int FrameIdx;
1145         unsigned DestReg = TII->isLoadFromStackSlot(&MI, FrameIdx);
1146         if (DestReg && FrameIdx == SS) {
1147           // If this spill slot is available, turn it into a copy (or nothing)
1148           // instead of leaving it as a load!
1149           if (unsigned InReg = Spills.getSpillSlotOrReMatPhysReg(SS)) {
1150             DOUT << "Promoted Load To Copy: " << MI;
1151             if (DestReg != InReg) {
1152               const TargetRegisterClass *RC = RegMap->getRegClass(VirtReg);
1153               MRI->copyRegToReg(MBB, &MI, DestReg, InReg, RC, RC);
1154               // Revisit the copy so we make sure to notice the effects of the
1155               // operation on the destreg (either needing to RA it if it's
1156               // virtual or needing to clobber any values if it's physical).
1157               NextMII = &MI;
1158               --NextMII;  // backtrack to the copy.
1159               BackTracked = true;
1160             } else
1161               DOUT << "Removing now-noop copy: " << MI;
1162
1163             VRM.RemoveFromFoldedVirtMap(&MI);
1164             MBB.erase(&MI);
1165             Erased = true;
1166             goto ProcessNextInst;
1167           }
1168         } else {
1169           unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(SS);
1170           SmallVector<MachineInstr*, 4> NewMIs;
1171           if (PhysReg &&
1172               MRI->unfoldMemoryOperand(MF, &MI, PhysReg, false, false, NewMIs)) {
1173             MBB.insert(MII, NewMIs[0]);
1174             VRM.RemoveFromFoldedVirtMap(&MI);
1175             MBB.erase(&MI);
1176             Erased = true;
1177             --NextMII;  // backtrack to the unfolded instruction.
1178             BackTracked = true;
1179             goto ProcessNextInst;
1180           }
1181         }
1182       }
1183
1184       // If this reference is not a use, any previous store is now dead.
1185       // Otherwise, the store to this stack slot is not dead anymore.
1186       MachineInstr* DeadStore = MaybeDeadStores[SS];
1187       if (DeadStore) {
1188         bool isDead = !(MR & VirtRegMap::isRef);
1189         MachineInstr *NewStore = NULL;
1190         if (MR & VirtRegMap::isModRef) {
1191           unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(SS);
1192           SmallVector<MachineInstr*, 4> NewMIs;
1193           if (PhysReg &&
1194               DeadStore->findRegisterUseOperandIdx(PhysReg, true) != -1 &&
1195               MRI->unfoldMemoryOperand(MF, &MI, PhysReg, false, true, NewMIs)) {
1196             MBB.insert(MII, NewMIs[0]);
1197             NewStore = NewMIs[1];
1198             MBB.insert(MII, NewStore);
1199             VRM.RemoveFromFoldedVirtMap(&MI);
1200             MBB.erase(&MI);
1201             Erased = true;
1202             --NextMII;
1203             --NextMII;  // backtrack to the unfolded instruction.
1204             BackTracked = true;
1205             isDead = true;
1206           }
1207         }
1208
1209         if (isDead) {  // Previous store is dead.
1210           // If we get here, the store is dead, nuke it now.
1211           DOUT << "Removed dead store:\t" << *DeadStore;
1212           InvalidateKills(*DeadStore, RegKills, KillOps);
1213           VRM.RemoveFromFoldedVirtMap(DeadStore);
1214           MBB.erase(DeadStore);
1215           if (!NewStore)
1216             ++NumDSE;
1217         }
1218
1219         MaybeDeadStores[SS] = NULL;
1220         if (NewStore) {
1221           // Treat this store as a spill merged into a copy. That makes the
1222           // stack slot value available.
1223           VRM.virtFolded(VirtReg, NewStore, VirtRegMap::isMod);
1224           goto ProcessNextInst;
1225         }
1226       }
1227
1228       // If the spill slot value is available, and this is a new definition of
1229       // the value, the value is not available anymore.
1230       if (MR & VirtRegMap::isMod) {
1231         // Notice that the value in this stack slot has been modified.
1232         Spills.ModifyStackSlotOrReMat(SS);
1233
1234         // If this is *just* a mod of the value, check to see if this is just a
1235         // store to the spill slot (i.e. the spill got merged into the copy). If
1236         // so, realize that the vreg is available now, and add the store to the
1237         // MaybeDeadStore info.
1238         int StackSlot;
1239         if (!(MR & VirtRegMap::isRef)) {
1240           if (unsigned SrcReg = TII->isStoreToStackSlot(&MI, StackSlot)) {
1241             assert(MRegisterInfo::isPhysicalRegister(SrcReg) &&
1242                    "Src hasn't been allocated yet?");
1243             // Okay, this is certainly a store of SrcReg to [StackSlot].  Mark
1244             // this as a potentially dead store in case there is a subsequent
1245             // store into the stack slot without a read from it.
1246             MaybeDeadStores[StackSlot] = &MI;
1247
1248             // If the stack slot value was previously available in some other
1249             // register, change it now.  Otherwise, make the register available,
1250             // in PhysReg.
1251             Spills.addAvailable(StackSlot, &MI, SrcReg, false/*don't clobber*/);
1252           }
1253         }
1254       }
1255     }
1256
1257     // Process all of the spilled defs.
1258     for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
1259       MachineOperand &MO = MI.getOperand(i);
1260       if (!(MO.isRegister() && MO.getReg() && MO.isDef()))
1261         continue;
1262
1263       unsigned VirtReg = MO.getReg();
1264       if (!MRegisterInfo::isVirtualRegister(VirtReg)) {
1265         // Check to see if this is a noop copy.  If so, eliminate the
1266         // instruction before considering the dest reg to be changed.
1267         unsigned Src, Dst;
1268         if (TII->isMoveInstr(MI, Src, Dst) && Src == Dst) {
1269           ++NumDCE;
1270           DOUT << "Removing now-noop copy: " << MI;
1271           MBB.erase(&MI);
1272           Erased = true;
1273           VRM.RemoveFromFoldedVirtMap(&MI);
1274           Spills.disallowClobberPhysReg(VirtReg);
1275           goto ProcessNextInst;
1276         }
1277
1278         // If it's not a no-op copy, it clobbers the value in the destreg.
1279         Spills.ClobberPhysReg(VirtReg);
1280         ReusedOperands.markClobbered(VirtReg);
1281
1282         // Check to see if this instruction is a load from a stack slot into
1283         // a register.  If so, this provides the stack slot value in the reg.
1284         int FrameIdx;
1285         if (unsigned DestReg = TII->isLoadFromStackSlot(&MI, FrameIdx)) {
1286           assert(DestReg == VirtReg && "Unknown load situation!");
1287
1288           // If it is a folded reference, then it's not safe to clobber.
1289           bool Folded = FoldedSS.count(FrameIdx);
1290           // Otherwise, if it wasn't available, remember that it is now!
1291           Spills.addAvailable(FrameIdx, &MI, DestReg, !Folded);
1292           goto ProcessNextInst;
1293         }
1294
1295         continue;
1296       }
1297
1298       bool DoReMat = VRM.isReMaterialized(VirtReg);
1299       if (DoReMat)
1300         ReMatDefs.insert(&MI);
1301
1302       // The only vregs left are stack slot definitions.
1303       int StackSlot = VRM.getStackSlot(VirtReg);
1304       const TargetRegisterClass *RC = RegMap->getRegClass(VirtReg);
1305
1306       // If this def is part of a two-address operand, make sure to execute
1307       // the store from the correct physical register.
1308       unsigned PhysReg;
1309       int TiedOp = MI.getInstrDescriptor()->findTiedToSrcOperand(i);
1310       if (TiedOp != -1)
1311         PhysReg = MI.getOperand(TiedOp).getReg();
1312       else {
1313         PhysReg = VRM.getPhys(VirtReg);
1314         if (ReusedOperands.isClobbered(PhysReg)) {
1315           // Another def has taken the assigned physreg. It must have been a
1316           // use&def which got it due to reuse. Undo the reuse!
1317           PhysReg = ReusedOperands.GetRegForReload(PhysReg, &MI,
1318                                Spills, MaybeDeadStores, RegKills, KillOps, VRM);
1319         }
1320       }
1321
1322       MF.setPhysRegUsed(PhysReg);
1323       ReusedOperands.markClobbered(PhysReg);
1324       MI.getOperand(i).setReg(PhysReg);
1325       if (!MO.isDead()) {
1326         MRI->storeRegToStackSlot(MBB, next(MII), PhysReg, StackSlot, RC);
1327         DOUT << "Store:\t" << *next(MII);
1328
1329         // If there is a dead store to this stack slot, nuke it now.
1330         MachineInstr *&LastStore = MaybeDeadStores[StackSlot];
1331         if (LastStore) {
1332           DOUT << "Removed dead store:\t" << *LastStore;
1333           ++NumDSE;
1334           SmallVector<unsigned, 2> KillRegs;
1335           InvalidateKills(*LastStore, RegKills, KillOps, &KillRegs);
1336           MachineBasicBlock::iterator PrevMII = LastStore;
1337           bool CheckDef = PrevMII != MBB.begin();
1338           if (CheckDef)
1339             --PrevMII;
1340           MBB.erase(LastStore);
1341           VRM.RemoveFromFoldedVirtMap(LastStore);
1342           if (CheckDef) {
1343             // Look at defs of killed registers on the store. Mark the defs
1344             // as dead since the store has been deleted and they aren't
1345             // being reused.
1346             for (unsigned j = 0, ee = KillRegs.size(); j != ee; ++j) {
1347               bool HasOtherDef = false;
1348               if (InvalidateRegDef(PrevMII, MI, KillRegs[j], HasOtherDef)) {
1349                 MachineInstr *DeadDef = PrevMII;
1350                 if (ReMatDefs.count(DeadDef) && !HasOtherDef) {
1351                   // FIXME: This assumes a remat def does not have side
1352                   // effects.
1353                   MBB.erase(DeadDef);
1354                   VRM.RemoveFromFoldedVirtMap(DeadDef);
1355                   ++NumDRM;
1356                 }
1357               }
1358             }
1359           }
1360         }
1361         LastStore = next(MII);
1362
1363         // If the stack slot value was previously available in some other
1364         // register, change it now.  Otherwise, make the register available,
1365         // in PhysReg.
1366         Spills.ModifyStackSlotOrReMat(StackSlot);
1367         Spills.ClobberPhysReg(PhysReg);
1368         Spills.addAvailable(StackSlot, LastStore, PhysReg);
1369         ++NumStores;
1370
1371         // Check to see if this is a noop copy.  If so, eliminate the
1372         // instruction before considering the dest reg to be changed.
1373         {
1374           unsigned Src, Dst;
1375           if (TII->isMoveInstr(MI, Src, Dst) && Src == Dst) {
1376             ++NumDCE;
1377             DOUT << "Removing now-noop copy: " << MI;
1378             MBB.erase(&MI);
1379             Erased = true;
1380             VRM.RemoveFromFoldedVirtMap(&MI);
1381             UpdateKills(*LastStore, RegKills, KillOps);
1382             goto ProcessNextInst;
1383           }
1384         }
1385       }
1386     }
1387   ProcessNextInst:
1388     if (!Erased && !BackTracked)
1389       for (MachineBasicBlock::iterator II = MI; II != NextMII; ++II)
1390         UpdateKills(*II, RegKills, KillOps);
1391     MII = NextMII;
1392   }
1393 }
1394
1395
1396 llvm::Spiller* llvm::createSpiller() {
1397   switch (SpillerOpt) {
1398   default: assert(0 && "Unreachable!");
1399   case local:
1400     return new LocalSpiller();
1401   case simple:
1402     return new SimpleSpiller();
1403   }
1404 }