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/Statistic.h"
  31 #include "llvm/ADT/STLExtras.h"
  32 #include "llvm/ADT/SmallSet.h"
  33 #include <algorithm>
  34 using namespace llvm;
  35
  36 STATISTIC(NumSpills, "Number of register spills");
  37 STATISTIC(NumStores, "Number of stores added");
  38 STATISTIC(NumLoads , "Number of loads added");
  39 STATISTIC(NumReused, "Number of values reused");
  40 STATISTIC(NumDSE   , "Number of dead stores elided");
  41 STATISTIC(NumDCE   , "Number of copies elided");
  42
  43 namespace {
  44   enum SpillerName { simple, local };
  45
  46   static cl::opt<SpillerName>
  47   SpillerOpt("spiller",
  48              cl::desc("Spiller to use: (default: local)"),
  49              cl::Prefix,
  50              cl::values(clEnumVal(simple, "  simple spiller"),
  51                         clEnumVal(local,  "  local spiller"),
  52                         clEnumValEnd),
  53              cl::init(local));
  54 }
  55
  56 //===----------------------------------------------------------------------===//
  57 //  VirtRegMap implementation
  58 //===----------------------------------------------------------------------===//
  59
  60 VirtRegMap::VirtRegMap(MachineFunction &mf)
  61   : TII(*mf.getTarget().getInstrInfo()), MF(mf),
  62     Virt2PhysMap(NO_PHYS_REG), Virt2StackSlotMap(NO_STACK_SLOT) {
  63   grow();
  64 }
  65
  66 void VirtRegMap::grow() {
  67   Virt2PhysMap.grow(MF.getSSARegMap()->getLastVirtReg());
  68   Virt2StackSlotMap.grow(MF.getSSARegMap()->getLastVirtReg());
  69 }
  70
  71 int VirtRegMap::assignVirt2StackSlot(unsigned virtReg) {
  72   assert(MRegisterInfo::isVirtualRegister(virtReg));
  73   assert(Virt2StackSlotMap[virtReg] == NO_STACK_SLOT &&
  74          "attempt to assign stack slot to already spilled register");
  75   const TargetRegisterClass* RC = MF.getSSARegMap()->getRegClass(virtReg);
  76   int frameIndex = MF.getFrameInfo()->CreateStackObject(RC->getSize(),
  77                                                         RC->getAlignment());
  78   Virt2StackSlotMap[virtReg] = frameIndex;
  79   ++NumSpills;
  80   return frameIndex;
  81 }
  82
  83 void VirtRegMap::assignVirt2StackSlot(unsigned virtReg, int frameIndex) {
  84   assert(MRegisterInfo::isVirtualRegister(virtReg));
  85   assert(Virt2StackSlotMap[virtReg] == NO_STACK_SLOT &&
  86          "attempt to assign stack slot to already spilled register");
  87   Virt2StackSlotMap[virtReg] = frameIndex;
  88 }
  89
  90 void VirtRegMap::virtFolded(unsigned VirtReg, MachineInstr *OldMI,
  91                             unsigned OpNo, MachineInstr *NewMI) {
  92   // Move previous memory references folded to new instruction.
  93   MI2VirtMapTy::iterator IP = MI2VirtMap.lower_bound(NewMI);
  94   for (MI2VirtMapTy::iterator I = MI2VirtMap.lower_bound(OldMI),
  95          E = MI2VirtMap.end(); I != E && I->first == OldMI; ) {
  96     MI2VirtMap.insert(IP, std::make_pair(NewMI, I->second));
  97     MI2VirtMap.erase(I++);
  98   }
  99
 100   ModRef MRInfo;
 101   const TargetInstrDescriptor *TID = OldMI->getInstrDescriptor();
 102   if (TID->getOperandConstraint(OpNo, TOI::TIED_TO) != -1 ||
 103       TID->findTiedToSrcOperand(OpNo) != -1) {
 104     // Folded a two-address operand.
 105     MRInfo = isModRef;
 106   } else if (OldMI->getOperand(OpNo).isDef()) {
 107     MRInfo = isMod;
 108   } else {
 109     MRInfo = isRef;
 110   }
 111
 112   // add new memory reference
 113   MI2VirtMap.insert(IP, std::make_pair(NewMI, std::make_pair(VirtReg, MRInfo)));
 114 }
 115
 116 void VirtRegMap::print(std::ostream &OS) const {
 117   const MRegisterInfo* MRI = MF.getTarget().getRegisterInfo();
 118
 119   OS << "********** REGISTER MAP **********\n";
 120   for (unsigned i = MRegisterInfo::FirstVirtualRegister,
 121          e = MF.getSSARegMap()->getLastVirtReg(); i <= e; ++i) {
 122     if (Virt2PhysMap[i] != (unsigned)VirtRegMap::NO_PHYS_REG)
 123       OS << "[reg" << i << " -> " << MRI->getName(Virt2PhysMap[i]) << "]\n";
 124
 125   }
 126
 127   for (unsigned i = MRegisterInfo::FirstVirtualRegister,
 128          e = MF.getSSARegMap()->getLastVirtReg(); i <= e; ++i)
 129     if (Virt2StackSlotMap[i] != VirtRegMap::NO_STACK_SLOT)
 130       OS << "[reg" << i << " -> fi#" << Virt2StackSlotMap[i] << "]\n";
 131   OS << '\n';
 132 }
 133
 134 void VirtRegMap::dump() const {
 135   print(DOUT);
 136 }
 137
 138
 139 //===----------------------------------------------------------------------===//
 140 // Simple Spiller Implementation
 141 //===----------------------------------------------------------------------===//
 142
 143 Spiller::~Spiller() {}
 144
 145 namespace {
 146   struct VISIBILITY_HIDDEN SimpleSpiller : public Spiller {
 147     bool runOnMachineFunction(MachineFunction& mf, VirtRegMap &VRM);
 148   };
 149 }
 150
 151 bool SimpleSpiller::runOnMachineFunction(MachineFunction &MF, VirtRegMap &VRM) {
 152   DOUT << "********** REWRITE MACHINE CODE **********\n";
 153   DOUT << "********** Function: " << MF.getFunction()->getName() << '\n';
 154   const TargetMachine &TM = MF.getTarget();
 155   const MRegisterInfo &MRI = *TM.getRegisterInfo();
 156   bool *PhysRegsUsed = MF.getUsedPhysregs();
 157
 158   // LoadedRegs - Keep track of which vregs are loaded, so that we only load
 159   // each vreg once (in the case where a spilled vreg is used by multiple
 160   // operands).  This is always smaller than the number of operands to the
 161   // current machine instr, so it should be small.
 162   std::vector<unsigned> LoadedRegs;
 163
 164   for (MachineFunction::iterator MBBI = MF.begin(), E = MF.end();
 165        MBBI != E; ++MBBI) {
 166     DOUT << MBBI->getBasicBlock()->getName() << ":\n";
 167     MachineBasicBlock &MBB = *MBBI;
 168     for (MachineBasicBlock::iterator MII = MBB.begin(),
 169            E = MBB.end(); MII != E; ++MII) {
 170       MachineInstr &MI = *MII;
 171       for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
 172         MachineOperand &MO = MI.getOperand(i);
 173         if (MO.isRegister() && MO.getReg())
 174           if (MRegisterInfo::isVirtualRegister(MO.getReg())) {
 175             unsigned VirtReg = MO.getReg();
 176             unsigned PhysReg = VRM.getPhys(VirtReg);
 177             if (VRM.hasStackSlot(VirtReg)) {
 178               int StackSlot = VRM.getStackSlot(VirtReg);
 179               const TargetRegisterClass* RC =
 180                 MF.getSSARegMap()->getRegClass(VirtReg);
 181
 182               if (MO.isUse() &&
 183                   std::find(LoadedRegs.begin(), LoadedRegs.end(), VirtReg)
 184                   == LoadedRegs.end()) {
 185                 MRI.loadRegFromStackSlot(MBB, &MI, PhysReg, StackSlot, RC);
 186                 LoadedRegs.push_back(VirtReg);
 187                 ++NumLoads;
 188                 DOUT << '\t' << *prior(MII);
 189               }
 190
 191               if (MO.isDef()) {
 192                 MRI.storeRegToStackSlot(MBB, next(MII), PhysReg, StackSlot, RC);
 193                 ++NumStores;
 194               }
 195             }
 196             PhysRegsUsed[PhysReg] = true;
 197             MI.getOperand(i).setReg(PhysReg);
 198           } else {
 199             PhysRegsUsed[MO.getReg()] = true;
 200           }
 201       }
 202
 203       DOUT << '\t' << MI;
 204       LoadedRegs.clear();
 205     }
 206   }
 207   return true;
 208 }
 209
 210 //===----------------------------------------------------------------------===//
 211 //  Local Spiller Implementation
 212 //===----------------------------------------------------------------------===//
 213
 214 namespace {
 215   /// LocalSpiller - This spiller does a simple pass over the machine basic
 216   /// block to attempt to keep spills in registers as much as possible for
 217   /// blocks that have low register pressure (the vreg may be spilled due to
 218   /// register pressure in other blocks).
 219   class VISIBILITY_HIDDEN LocalSpiller : public Spiller {
 220     const MRegisterInfo *MRI;
 221     const TargetInstrInfo *TII;
 222   public:
 223     bool runOnMachineFunction(MachineFunction &MF, VirtRegMap &VRM) {
 224       MRI = MF.getTarget().getRegisterInfo();
 225       TII = MF.getTarget().getInstrInfo();
 226       DOUT << "\n**** Local spiller rewriting function '"
 227            << MF.getFunction()->getName() << "':\n";
 228
 229       for (MachineFunction::iterator MBB = MF.begin(), E = MF.end();
 230            MBB != E; ++MBB)
 231         RewriteMBB(*MBB, VRM);
 232       return true;
 233     }
 234   private:
 235     void RewriteMBB(MachineBasicBlock &MBB, VirtRegMap &VRM);
 236   };
 237 }
 238
 239 /// AvailableSpills - As the local spiller is scanning and rewriting an MBB from
 240 /// top down, keep track of which spills slots are available in each register.
 241 ///
 242 /// Note that not all physregs are created equal here.  In particular, some
 243 /// physregs are reloads that we are allowed to clobber or ignore at any time.
 244 /// Other physregs are values that the register allocated program is using that
 245 /// we cannot CHANGE, but we can read if we like.  We keep track of this on a
 246 /// per-stack-slot basis as the low bit in the value of the SpillSlotsAvailable
 247 /// entries.  The predicate 'canClobberPhysReg()' checks this bit and
 248 /// addAvailable sets it if.
 249 namespace {
 250 class VISIBILITY_HIDDEN AvailableSpills {
 251   const MRegisterInfo *MRI;
 252   const TargetInstrInfo *TII;
 253
 254   // SpillSlotsAvailable - This map keeps track of all of the spilled virtual
 255   // register values that are still available, due to being loaded or stored to,
 256   // but not invalidated yet.
 257   std::map<int, unsigned> SpillSlotsAvailable;
 258
 259   // PhysRegsAvailable - This is the inverse of SpillSlotsAvailable, indicating
 260   // which stack slot values are currently held by a physreg.  This is used to
 261   // invalidate entries in SpillSlotsAvailable when a physreg is modified.
 262   std::multimap<unsigned, int> PhysRegsAvailable;
 263
 264   void disallowClobberPhysRegOnly(unsigned PhysReg);
 265
 266   void ClobberPhysRegOnly(unsigned PhysReg);
 267 public:
 268   AvailableSpills(const MRegisterInfo *mri, const TargetInstrInfo *tii)
 269     : MRI(mri), TII(tii) {
 270   }
 271
 272   /// getSpillSlotPhysReg - If the specified stack slot is available in a
 273   /// physical register, return that PhysReg, otherwise return 0.
 274   unsigned getSpillSlotPhysReg(int Slot) const {
 275     std::map<int, unsigned>::const_iterator I = SpillSlotsAvailable.find(Slot);
 276     if (I != SpillSlotsAvailable.end())
 277       return I->second >> 1;  // Remove the CanClobber bit.
 278     return 0;
 279   }
 280
 281   const MRegisterInfo *getRegInfo() const { return MRI; }
 282
 283   /// addAvailable - Mark that the specified stack slot is available in the
 284   /// specified physreg.  If CanClobber is true, the physreg can be modified at
 285   /// any time without changing the semantics of the program.
 286   void addAvailable(int Slot, unsigned Reg, bool CanClobber = true) {
 287     // If this stack slot is thought to be available in some other physreg,
 288     // remove its record.
 289     ModifyStackSlot(Slot);
 290
 291     PhysRegsAvailable.insert(std::make_pair(Reg, Slot));
 292     SpillSlotsAvailable[Slot] = (Reg << 1) | (unsigned)CanClobber;
 293
 294     DOUT << "Remembering SS#" << Slot << " in physreg "
 295          << MRI->getName(Reg) << "\n";
 296   }
 297
 298   /// canClobberPhysReg - Return true if the spiller is allowed to change the
 299   /// value of the specified stackslot register if it desires.  The specified
 300   /// stack slot must be available in a physreg for this query to make sense.
 301   bool canClobberPhysReg(int Slot) const {
 302     assert(SpillSlotsAvailable.count(Slot) && "Slot not available!");
 303     return SpillSlotsAvailable.find(Slot)->second & 1;
 304   }
 305
 306   /// disallowClobberPhysReg - Unset the CanClobber bit of the specified
 307   /// stackslot register. The register is still available but is no longer
 308   /// allowed to be modifed.
 309   void disallowClobberPhysReg(unsigned PhysReg);
 310
 311   /// ClobberPhysReg - This is called when the specified physreg changes
 312   /// value.  We use this to invalidate any info about stuff we thing lives in
 313   /// it and any of its aliases.
 314   void ClobberPhysReg(unsigned PhysReg);
 315
 316   /// ModifyStackSlot - This method is called when the value in a stack slot
 317   /// changes.  This removes information about which register the previous value
 318   /// for this slot lives in (as the previous value is dead now).
 319   void ModifyStackSlot(int Slot);
 320 };
 321 }
 322
 323 /// disallowClobberPhysRegOnly - Unset the CanClobber bit of the specified
 324 /// stackslot register. The register is still available but is no longer
 325 /// allowed to be modifed.
 326 void AvailableSpills::disallowClobberPhysRegOnly(unsigned PhysReg) {
 327   std::multimap<unsigned, int>::iterator I =
 328     PhysRegsAvailable.lower_bound(PhysReg);
 329   while (I != PhysRegsAvailable.end() && I->first == PhysReg) {
 330     int Slot = I->second;
 331     I++;
 332     assert((SpillSlotsAvailable[Slot] >> 1) == PhysReg &&
 333            "Bidirectional map mismatch!");
 334     SpillSlotsAvailable[Slot] &= ~1;
 335     DOUT << "PhysReg " << MRI->getName(PhysReg)
 336          << " copied, it is available for use but can no longer be modified\n";
 337   }
 338 }
 339
 340 /// disallowClobberPhysReg - Unset the CanClobber bit of the specified
 341 /// stackslot register and its aliases. The register and its aliases may
 342 /// still available but is no longer allowed to be modifed.
 343 void AvailableSpills::disallowClobberPhysReg(unsigned PhysReg) {
 344   for (const unsigned *AS = MRI->getAliasSet(PhysReg); *AS; ++AS)
 345     disallowClobberPhysRegOnly(*AS);
 346   disallowClobberPhysRegOnly(PhysReg);
 347 }
 348
 349 /// ClobberPhysRegOnly - This is called when the specified physreg changes
 350 /// value.  We use this to invalidate any info about stuff we thing lives in it.
 351 void AvailableSpills::ClobberPhysRegOnly(unsigned PhysReg) {
 352   std::multimap<unsigned, int>::iterator I =
 353     PhysRegsAvailable.lower_bound(PhysReg);
 354   while (I != PhysRegsAvailable.end() && I->first == PhysReg) {
 355     int Slot = I->second;
 356     PhysRegsAvailable.erase(I++);
 357     assert((SpillSlotsAvailable[Slot] >> 1) == PhysReg &&
 358            "Bidirectional map mismatch!");
 359     SpillSlotsAvailable.erase(Slot);
 360     DOUT << "PhysReg " << MRI->getName(PhysReg)
 361          << " clobbered, invalidating SS#" << Slot << "\n";
 362   }
 363 }
 364
 365 /// ClobberPhysReg - This is called when the specified physreg changes
 366 /// value.  We use this to invalidate any info about stuff we thing lives in
 367 /// it and any of its aliases.
 368 void AvailableSpills::ClobberPhysReg(unsigned PhysReg) {
 369   for (const unsigned *AS = MRI->getAliasSet(PhysReg); *AS; ++AS)
 370     ClobberPhysRegOnly(*AS);
 371   ClobberPhysRegOnly(PhysReg);
 372 }
 373
 374 /// ModifyStackSlot - This method is called when the value in a stack slot
 375 /// changes.  This removes information about which register the previous value
 376 /// for this slot lives in (as the previous value is dead now).
 377 void AvailableSpills::ModifyStackSlot(int Slot) {
 378   std::map<int, unsigned>::iterator It = SpillSlotsAvailable.find(Slot);
 379   if (It == SpillSlotsAvailable.end()) return;
 380   unsigned Reg = It->second >> 1;
 381   SpillSlotsAvailable.erase(It);
 382
 383   // This register may hold the value of multiple stack slots, only remove this
 384   // stack slot from the set of values the register contains.
 385   std::multimap<unsigned, int>::iterator I = PhysRegsAvailable.lower_bound(Reg);
 386   for (; ; ++I) {
 387     assert(I != PhysRegsAvailable.end() && I->first == Reg &&
 388            "Map inverse broken!");
 389     if (I->second == Slot) break;
 390   }
 391   PhysRegsAvailable.erase(I);
 392 }
 393
 394
 395
 396 // ReusedOp - For each reused operand, we keep track of a bit of information, in
 397 // case we need to rollback upon processing a new operand.  See comments below.
 398 namespace {
 399   struct ReusedOp {
 400     // The MachineInstr operand that reused an available value.
 401     unsigned Operand;
 402
 403     // StackSlot - The spill slot of the value being reused.
 404     unsigned StackSlot;
 405
 406     // PhysRegReused - The physical register the value was available in.
 407     unsigned PhysRegReused;
 408
 409     // AssignedPhysReg - The physreg that was assigned for use by the reload.
 410     unsigned AssignedPhysReg;
 411
 412     // VirtReg - The virtual register itself.
 413     unsigned VirtReg;
 414
 415     ReusedOp(unsigned o, unsigned ss, unsigned prr, unsigned apr,
 416              unsigned vreg)
 417       : Operand(o), StackSlot(ss), PhysRegReused(prr), AssignedPhysReg(apr),
 418       VirtReg(vreg) {}
 419   };
 420
 421   /// ReuseInfo - This maintains a collection of ReuseOp's for each operand that
 422   /// is reused instead of reloaded.
 423   class VISIBILITY_HIDDEN ReuseInfo {
 424     MachineInstr &MI;
 425     std::vector<ReusedOp> Reuses;
 426     bool *PhysRegsClobbered;
 427   public:
 428     ReuseInfo(MachineInstr &mi, const MRegisterInfo *mri) : MI(mi) {
 429       PhysRegsClobbered = new bool[mri->getNumRegs()];
 430       std::fill(PhysRegsClobbered, PhysRegsClobbered+mri->getNumRegs(), false);
 431     }
 432     ~ReuseInfo() {
 433       delete[] PhysRegsClobbered;
 434     }
 435
 436     bool hasReuses() const {
 437       return !Reuses.empty();
 438     }
 439
 440     /// addReuse - If we choose to reuse a virtual register that is already
 441     /// available instead of reloading it, remember that we did so.
 442     void addReuse(unsigned OpNo, unsigned StackSlot,
 443                   unsigned PhysRegReused, unsigned AssignedPhysReg,
 444                   unsigned VirtReg) {
 445       // If the reload is to the assigned register anyway, no undo will be
 446       // required.
 447       if (PhysRegReused == AssignedPhysReg) return;
 448
 449       // Otherwise, remember this.
 450       Reuses.push_back(ReusedOp(OpNo, StackSlot, PhysRegReused,
 451                                 AssignedPhysReg, VirtReg));
 452     }
 453
 454     void markClobbered(unsigned PhysReg) {
 455       PhysRegsClobbered[PhysReg] = true;
 456     }
 457
 458     bool isClobbered(unsigned PhysReg) const {
 459       return PhysRegsClobbered[PhysReg];
 460     }
 461
 462     /// GetRegForReload - We are about to emit a reload into PhysReg.  If there
 463     /// is some other operand that is using the specified register, either pick
 464     /// a new register to use, or evict the previous reload and use this reg.
 465     unsigned GetRegForReload(unsigned PhysReg, MachineInstr *MI,
 466                              AvailableSpills &Spills,
 467                              std::map<int, MachineInstr*> &MaybeDeadStores,
 468                              SmallSet<unsigned, 8> &Rejected) {
 469       if (Reuses.empty()) return PhysReg;  // This is most often empty.
 470
 471       for (unsigned ro = 0, e = Reuses.size(); ro != e; ++ro) {
 472         ReusedOp &Op = Reuses[ro];
 473         // If we find some other reuse that was supposed to use this register
 474         // exactly for its reload, we can change this reload to use ITS reload
 475         // register. That is, unless its reload register has already been
 476         // considered and subsequently rejected because it has also been reused
 477         // by another operand.
 478         if (Op.PhysRegReused == PhysReg &&
 479             Rejected.count(Op.AssignedPhysReg) == 0) {
 480           // Yup, use the reload register that we didn't use before.
 481           unsigned NewReg = Op.AssignedPhysReg;
 482           Rejected.insert(PhysReg);
 483           return GetRegForReload(NewReg, MI, Spills, MaybeDeadStores, Rejected);
 484         } else {
 485           // Otherwise, we might also have a problem if a previously reused
 486           // value aliases the new register.  If so, codegen the previous reload
 487           // and use this one.
 488           unsigned PRRU = Op.PhysRegReused;
 489           const MRegisterInfo *MRI = Spills.getRegInfo();
 490           if (MRI->areAliases(PRRU, PhysReg)) {
 491             // Okay, we found out that an alias of a reused register
 492             // was used.  This isn't good because it means we have
 493             // to undo a previous reuse.
 494             MachineBasicBlock *MBB = MI->getParent();
 495             const TargetRegisterClass *AliasRC =
 496               MBB->getParent()->getSSARegMap()->getRegClass(Op.VirtReg);
 497
 498             // Copy Op out of the vector and remove it, we're going to insert an
 499             // explicit load for it.
 500             ReusedOp NewOp = Op;
 501             Reuses.erase(Reuses.begin()+ro);
 502
 503             // Ok, we're going to try to reload the assigned physreg into the
 504             // slot that we were supposed to in the first place.  However, that
 505             // register could hold a reuse.  Check to see if it conflicts or
 506             // would prefer us to use a different register.
 507             unsigned NewPhysReg = GetRegForReload(NewOp.AssignedPhysReg,
 508                                          MI, Spills, MaybeDeadStores, Rejected);
 509
 510             MRI->loadRegFromStackSlot(*MBB, MI, NewPhysReg,
 511                                       NewOp.StackSlot, AliasRC);
 512             Spills.ClobberPhysReg(NewPhysReg);
 513             Spills.ClobberPhysReg(NewOp.PhysRegReused);
 514
 515             // Any stores to this stack slot are not dead anymore.
 516             MaybeDeadStores.erase(NewOp.StackSlot);
 517
 518             MI->getOperand(NewOp.Operand).setReg(NewPhysReg);
 519
 520             Spills.addAvailable(NewOp.StackSlot, NewPhysReg);
 521             ++NumLoads;
 522             DEBUG(MachineBasicBlock::iterator MII = MI;
 523                   DOUT << '\t' << *prior(MII));
 524
 525             DOUT << "Reuse undone!\n";
 526             --NumReused;
 527
 528             // Finally, PhysReg is now available, go ahead and use it.
 529             return PhysReg;
 530           }
 531         }
 532       }
 533       return PhysReg;
 534     }
 535
 536     /// GetRegForReload - Helper for the above GetRegForReload(). Add a
 537     /// 'Rejected' set to remember which registers have been considered and
 538     /// rejected for the reload. This avoids infinite looping in case like
 539     /// this:
 540     /// t1 := op t2, t3
 541     /// t2 <- assigned r0 for use by the reload but ended up reuse r1
 542     /// t3 <- assigned r1 for use by the reload but ended up reuse r0
 543     /// t1 <- desires r1
 544     ///       sees r1 is taken by t2, tries t2's reload register r0
 545     ///       sees r0 is taken by t3, tries t3's reload register r1
 546     ///       sees r1 is taken by t2, tries t2's reload register r0 ...
 547     unsigned GetRegForReload(unsigned PhysReg, MachineInstr *MI,
 548                              AvailableSpills &Spills,
 549                              std::map<int, MachineInstr*> &MaybeDeadStores) {
 550       SmallSet<unsigned, 8> Rejected;
 551       return GetRegForReload(PhysReg, MI, Spills, MaybeDeadStores, Rejected);
 552     }
 553   };
 554 }
 555
 556
 557 /// rewriteMBB - Keep track of which spills are available even after the
 558 /// register allocator is done with them.  If possible, avoid reloading vregs.
 559 void LocalSpiller::RewriteMBB(MachineBasicBlock &MBB, VirtRegMap &VRM) {
 560
 561   DOUT << MBB.getBasicBlock()->getName() << ":\n";
 562
 563   // Spills - Keep track of which spilled values are available in physregs so
 564   // that we can choose to reuse the physregs instead of emitting reloads.
 565   AvailableSpills Spills(MRI, TII);
 566
 567   // MaybeDeadStores - When we need to write a value back into a stack slot,
 568   // keep track of the inserted store.  If the stack slot value is never read
 569   // (because the value was used from some available register, for example), and
 570   // subsequently stored to, the original store is dead.  This map keeps track
 571   // of inserted stores that are not used.  If we see a subsequent store to the
 572   // same stack slot, the original store is deleted.
 573   std::map<int, MachineInstr*> MaybeDeadStores;
 574
 575   bool *PhysRegsUsed = MBB.getParent()->getUsedPhysregs();
 576
 577   for (MachineBasicBlock::iterator MII = MBB.begin(), E = MBB.end();
 578        MII != E; ) {
 579     MachineInstr &MI = *MII;
 580     MachineBasicBlock::iterator NextMII = MII; ++NextMII;
 581
 582     /// ReusedOperands - Keep track of operand reuse in case we need to undo
 583     /// reuse.
 584     ReuseInfo ReusedOperands(MI, MRI);
 585
 586     // Loop over all of the implicit defs, clearing them from our available
 587     // sets.
 588     const TargetInstrDescriptor *TID = MI.getInstrDescriptor();
 589     const unsigned *ImpDef = TID->ImplicitDefs;
 590     if (ImpDef) {
 591       for ( ; *ImpDef; ++ImpDef) {
 592         PhysRegsUsed[*ImpDef] = true;
 593         ReusedOperands.markClobbered(*ImpDef);
 594         Spills.ClobberPhysReg(*ImpDef);
 595       }
 596     }
 597
 598     // Process all of the spilled uses and all non spilled reg references.
 599     for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
 600       MachineOperand &MO = MI.getOperand(i);
 601       if (!MO.isRegister() || MO.getReg() == 0)
 602         continue;   // Ignore non-register operands.
 603
 604       if (MRegisterInfo::isPhysicalRegister(MO.getReg())) {
 605         // Ignore physregs for spilling, but remember that it is used by this
 606         // function.
 607         PhysRegsUsed[MO.getReg()] = true;
 608         ReusedOperands.markClobbered(MO.getReg());
 609         continue;
 610       }
 611
 612       assert(MRegisterInfo::isVirtualRegister(MO.getReg()) &&
 613              "Not a virtual or a physical register?");
 614
 615       unsigned VirtReg = MO.getReg();
 616       if (!VRM.hasStackSlot(VirtReg)) {
 617         // This virtual register was assigned a physreg!
 618         unsigned Phys = VRM.getPhys(VirtReg);
 619         PhysRegsUsed[Phys] = true;
 620         if (MO.isDef())
 621           ReusedOperands.markClobbered(Phys);
 622         MI.getOperand(i).setReg(Phys);
 623         continue;
 624       }
 625
 626       // This virtual register is now known to be a spilled value.
 627       if (!MO.isUse())
 628         continue;  // Handle defs in the loop below (handle use&def here though)
 629
 630       int StackSlot = VRM.getStackSlot(VirtReg);
 631       unsigned PhysReg;
 632
 633       // Check to see if this stack slot is available.
 634       if ((PhysReg = Spills.getSpillSlotPhysReg(StackSlot))) {
 635
 636         // This spilled operand might be part of a two-address operand.  If this
 637         // is the case, then changing it will necessarily require changing the
 638         // def part of the instruction as well.  However, in some cases, we
 639         // aren't allowed to modify the reused register.  If none of these cases
 640         // apply, reuse it.
 641         bool CanReuse = true;
 642         int ti = TID->getOperandConstraint(i, TOI::TIED_TO);
 643         if (ti != -1 &&
 644             MI.getOperand(ti).isReg() &&
 645             MI.getOperand(ti).getReg() == VirtReg) {
 646           // Okay, we have a two address operand.  We can reuse this physreg as
 647           // long as we are allowed to clobber the value and there isn't an
 648           // earlier def that has already clobbered the physreg.
 649           CanReuse = Spills.canClobberPhysReg(StackSlot) &&
 650             !ReusedOperands.isClobbered(PhysReg);
 651         }
 652
 653         if (CanReuse) {
 654           // If this stack slot value is already available, reuse it!
 655           DOUT << "Reusing SS#" << StackSlot << " from physreg "
 656                << MRI->getName(PhysReg) << " for vreg"
 657                << VirtReg <<" instead of reloading into physreg "
 658                << MRI->getName(VRM.getPhys(VirtReg)) << "\n";
 659           MI.getOperand(i).setReg(PhysReg);
 660
 661           // The only technical detail we have is that we don't know that
 662           // PhysReg won't be clobbered by a reloaded stack slot that occurs
 663           // later in the instruction.  In particular, consider 'op V1, V2'.
 664           // If V1 is available in physreg R0, we would choose to reuse it
 665           // here, instead of reloading it into the register the allocator
 666           // indicated (say R1).  However, V2 might have to be reloaded
 667           // later, and it might indicate that it needs to live in R0.  When
 668           // this occurs, we need to have information available that
 669           // indicates it is safe to use R1 for the reload instead of R0.
 670           //
 671           // To further complicate matters, we might conflict with an alias,
 672           // or R0 and R1 might not be compatible with each other.  In this
 673           // case, we actually insert a reload for V1 in R1, ensuring that
 674           // we can get at R0 or its alias.
 675           ReusedOperands.addReuse(i, StackSlot, PhysReg,
 676                                   VRM.getPhys(VirtReg), VirtReg);
 677           if (ti != -1)
 678             // Only mark it clobbered if this is a use&def operand.
 679             ReusedOperands.markClobbered(PhysReg);
 680           ++NumReused;
 681           continue;
 682         }
 683
 684         // Otherwise we have a situation where we have a two-address instruction
 685         // whose mod/ref operand needs to be reloaded.  This reload is already
 686         // available in some register "PhysReg", but if we used PhysReg as the
 687         // operand to our 2-addr instruction, the instruction would modify
 688         // PhysReg.  This isn't cool if something later uses PhysReg and expects
 689         // to get its initial value.
 690         //
 691         // To avoid this problem, and to avoid doing a load right after a store,
 692         // we emit a copy from PhysReg into the designated register for this
 693         // operand.
 694         unsigned DesignatedReg = VRM.getPhys(VirtReg);
 695         assert(DesignatedReg && "Must map virtreg to physreg!");
 696
 697         // Note that, if we reused a register for a previous operand, the
 698         // register we want to reload into might not actually be
 699         // available.  If this occurs, use the register indicated by the
 700         // reuser.
 701         if (ReusedOperands.hasReuses())
 702           DesignatedReg = ReusedOperands.GetRegForReload(DesignatedReg, &MI,
 703                                                       Spills, MaybeDeadStores);
 704
 705         // If the mapped designated register is actually the physreg we have
 706         // incoming, we don't need to inserted a dead copy.
 707         if (DesignatedReg == PhysReg) {
 708           // If this stack slot value is already available, reuse it!
 709           DOUT << "Reusing SS#" << StackSlot << " from physreg "
 710                << MRI->getName(PhysReg) << " for vreg"
 711                << VirtReg
 712                << " instead of reloading into same physreg.\n";
 713           MI.getOperand(i).setReg(PhysReg);
 714           ReusedOperands.markClobbered(PhysReg);
 715           ++NumReused;
 716           continue;
 717         }
 718
 719         const TargetRegisterClass* RC =
 720           MBB.getParent()->getSSARegMap()->getRegClass(VirtReg);
 721
 722         PhysRegsUsed[DesignatedReg] = true;
 723         ReusedOperands.markClobbered(DesignatedReg);
 724         MRI->copyRegToReg(MBB, &MI, DesignatedReg, PhysReg, RC);
 725
 726         // This invalidates DesignatedReg.
 727         Spills.ClobberPhysReg(DesignatedReg);
 728
 729         Spills.addAvailable(StackSlot, DesignatedReg);
 730         MI.getOperand(i).setReg(DesignatedReg);
 731         DOUT << '\t' << *prior(MII);
 732         ++NumReused;
 733         continue;
 734       }
 735
 736       // Otherwise, reload it and remember that we have it.
 737       PhysReg = VRM.getPhys(VirtReg);
 738       assert(PhysReg && "Must map virtreg to physreg!");
 739       const TargetRegisterClass* RC =
 740         MBB.getParent()->getSSARegMap()->getRegClass(VirtReg);
 741
 742       // Note that, if we reused a register for a previous operand, the
 743       // register we want to reload into might not actually be
 744       // available.  If this occurs, use the register indicated by the
 745       // reuser.
 746       if (ReusedOperands.hasReuses())
 747         PhysReg = ReusedOperands.GetRegForReload(PhysReg, &MI,
 748                                                  Spills, MaybeDeadStores);
 749
 750       PhysRegsUsed[PhysReg] = true;
 751       ReusedOperands.markClobbered(PhysReg);
 752       MRI->loadRegFromStackSlot(MBB, &MI, PhysReg, StackSlot, RC);
 753       // This invalidates PhysReg.
 754       Spills.ClobberPhysReg(PhysReg);
 755
 756       // Any stores to this stack slot are not dead anymore.
 757       MaybeDeadStores.erase(StackSlot);
 758       Spills.addAvailable(StackSlot, PhysReg);
 759       ++NumLoads;
 760       MI.getOperand(i).setReg(PhysReg);
 761       DOUT << '\t' << *prior(MII);
 762     }
 763
 764     DOUT << '\t' << MI;
 765
 766     // If we have folded references to memory operands, make sure we clear all
 767     // physical registers that may contain the value of the spilled virtual
 768     // register
 769     VirtRegMap::MI2VirtMapTy::const_iterator I, End;
 770     for (tie(I, End) = VRM.getFoldedVirts(&MI); I != End; ++I) {
 771       DOUT << "Folded vreg: " << I->second.first << "  MR: "
 772            << I->second.second;
 773       unsigned VirtReg = I->second.first;
 774       VirtRegMap::ModRef MR = I->second.second;
 775       if (!VRM.hasStackSlot(VirtReg)) {
 776         DOUT << ": No stack slot!\n";
 777         continue;
 778       }
 779       int SS = VRM.getStackSlot(VirtReg);
 780       DOUT << " - StackSlot: " << SS << "\n";
 781
 782       // If this folded instruction is just a use, check to see if it's a
 783       // straight load from the virt reg slot.
 784       if ((MR & VirtRegMap::isRef) && !(MR & VirtRegMap::isMod)) {
 785         int FrameIdx;
 786         if (unsigned DestReg = TII->isLoadFromStackSlot(&MI, FrameIdx)) {
 787           if (FrameIdx == SS) {
 788             // If this spill slot is available, turn it into a copy (or nothing)
 789             // instead of leaving it as a load!
 790             if (unsigned InReg = Spills.getSpillSlotPhysReg(SS)) {
 791               DOUT << "Promoted Load To Copy: " << MI;
 792               MachineFunction &MF = *MBB.getParent();
 793               if (DestReg != InReg) {
 794                 MRI->copyRegToReg(MBB, &MI, DestReg, InReg,
 795                                   MF.getSSARegMap()->getRegClass(VirtReg));
 796                 // Revisit the copy so we make sure to notice the effects of the
 797                 // operation on the destreg (either needing to RA it if it's
 798                 // virtual or needing to clobber any values if it's physical).
 799                 NextMII = &MI;
 800                 --NextMII;  // backtrack to the copy.
 801               }
 802               VRM.RemoveFromFoldedVirtMap(&MI);
 803               MBB.erase(&MI);
 804               goto ProcessNextInst;
 805             }
 806           }
 807         }
 808       }
 809
 810       // If this reference is not a use, any previous store is now dead.
 811       // Otherwise, the store to this stack slot is not dead anymore.
 812       std::map<int, MachineInstr*>::iterator MDSI = MaybeDeadStores.find(SS);
 813       if (MDSI != MaybeDeadStores.end()) {
 814         if (MR & VirtRegMap::isRef)   // Previous store is not dead.
 815           MaybeDeadStores.erase(MDSI);
 816         else {
 817           // If we get here, the store is dead, nuke it now.
 818           assert(VirtRegMap::isMod && "Can't be modref!");
 819           DOUT << "Removed dead store:\t" << *MDSI->second;
 820           MBB.erase(MDSI->second);
 821           VRM.RemoveFromFoldedVirtMap(MDSI->second);
 822           MaybeDeadStores.erase(MDSI);
 823           ++NumDSE;
 824         }
 825       }
 826
 827       // If the spill slot value is available, and this is a new definition of
 828       // the value, the value is not available anymore.
 829       if (MR & VirtRegMap::isMod) {
 830         // Notice that the value in this stack slot has been modified.
 831         Spills.ModifyStackSlot(SS);
 832
 833         // If this is *just* a mod of the value, check to see if this is just a
 834         // store to the spill slot (i.e. the spill got merged into the copy). If
 835         // so, realize that the vreg is available now, and add the store to the
 836         // MaybeDeadStore info.
 837         int StackSlot;
 838         if (!(MR & VirtRegMap::isRef)) {
 839           if (unsigned SrcReg = TII->isStoreToStackSlot(&MI, StackSlot)) {
 840             assert(MRegisterInfo::isPhysicalRegister(SrcReg) &&
 841                    "Src hasn't been allocated yet?");
 842             // Okay, this is certainly a store of SrcReg to [StackSlot].  Mark
 843             // this as a potentially dead store in case there is a subsequent
 844             // store into the stack slot without a read from it.
 845             MaybeDeadStores[StackSlot] = &MI;
 846
 847             // If the stack slot value was previously available in some other
 848             // register, change it now.  Otherwise, make the register available,
 849             // in PhysReg.
 850             Spills.addAvailable(StackSlot, SrcReg, false /*don't clobber*/);
 851           }
 852         }
 853       }
 854     }
 855
 856     // Process all of the spilled defs.
 857     for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
 858       MachineOperand &MO = MI.getOperand(i);
 859       if (MO.isRegister() && MO.getReg() && MO.isDef()) {
 860         unsigned VirtReg = MO.getReg();
 861
 862         if (!MRegisterInfo::isVirtualRegister(VirtReg)) {
 863           // Check to see if this is a noop copy.  If so, eliminate the
 864           // instruction before considering the dest reg to be changed.
 865           unsigned Src, Dst;
 866           if (TII->isMoveInstr(MI, Src, Dst) && Src == Dst) {
 867             ++NumDCE;
 868             DOUT << "Removing now-noop copy: " << MI;
 869             MBB.erase(&MI);
 870             VRM.RemoveFromFoldedVirtMap(&MI);
 871             Spills.disallowClobberPhysReg(VirtReg);
 872             goto ProcessNextInst;
 873           }
 874
 875           // If it's not a no-op copy, it clobbers the value in the destreg.
 876           Spills.ClobberPhysReg(VirtReg);
 877           ReusedOperands.markClobbered(VirtReg);
 878
 879           // Check to see if this instruction is a load from a stack slot into
 880           // a register.  If so, this provides the stack slot value in the reg.
 881           int FrameIdx;
 882           if (unsigned DestReg = TII->isLoadFromStackSlot(&MI, FrameIdx)) {
 883             assert(DestReg == VirtReg && "Unknown load situation!");
 884
 885             // Otherwise, if it wasn't available, remember that it is now!
 886             Spills.addAvailable(FrameIdx, DestReg);
 887             goto ProcessNextInst;
 888           }
 889
 890           continue;
 891         }
 892
 893         // The only vregs left are stack slot definitions.
 894         int StackSlot = VRM.getStackSlot(VirtReg);
 895         const TargetRegisterClass *RC =
 896           MBB.getParent()->getSSARegMap()->getRegClass(VirtReg);
 897
 898         // If this def is part of a two-address operand, make sure to execute
 899         // the store from the correct physical register.
 900         unsigned PhysReg;
 901         int TiedOp = MI.getInstrDescriptor()->findTiedToSrcOperand(i);
 902         if (TiedOp != -1)
 903           PhysReg = MI.getOperand(TiedOp).getReg();
 904         else {
 905           PhysReg = VRM.getPhys(VirtReg);
 906           if (ReusedOperands.isClobbered(PhysReg)) {
 907             // Another def has taken the assigned physreg. It must have been a
 908             // use&def which got it due to reuse. Undo the reuse!
 909             PhysReg = ReusedOperands.GetRegForReload(PhysReg, &MI,
 910                                                      Spills, MaybeDeadStores);
 911           }
 912         }
 913
 914         PhysRegsUsed[PhysReg] = true;
 915         ReusedOperands.markClobbered(PhysReg);
 916         MRI->storeRegToStackSlot(MBB, next(MII), PhysReg, StackSlot, RC);
 917         DOUT << "Store:\t" << *next(MII);
 918         MI.getOperand(i).setReg(PhysReg);
 919
 920         // If there is a dead store to this stack slot, nuke it now.
 921         MachineInstr *&LastStore = MaybeDeadStores[StackSlot];
 922         if (LastStore) {
 923           DOUT << "Removed dead store:\t" << *LastStore;
 924           ++NumDSE;
 925           MBB.erase(LastStore);
 926           VRM.RemoveFromFoldedVirtMap(LastStore);
 927         }
 928         LastStore = next(MII);
 929
 930         // If the stack slot value was previously available in some other
 931         // register, change it now.  Otherwise, make the register available,
 932         // in PhysReg.
 933         Spills.ModifyStackSlot(StackSlot);
 934         Spills.ClobberPhysReg(PhysReg);
 935         Spills.addAvailable(StackSlot, PhysReg);
 936         ++NumStores;
 937
 938         // Check to see if this is a noop copy.  If so, eliminate the
 939         // instruction before considering the dest reg to be changed.
 940         {
 941           unsigned Src, Dst;
 942           if (TII->isMoveInstr(MI, Src, Dst) && Src == Dst) {
 943             ++NumDCE;
 944             DOUT << "Removing now-noop copy: " << MI;
 945             MBB.erase(&MI);
 946             VRM.RemoveFromFoldedVirtMap(&MI);
 947             goto ProcessNextInst;
 948           }
 949         }
 950       }
 951     }
 952   ProcessNextInst:
 953     MII = NextMII;
 954   }
 955 }
 956
 957
 958
 959 llvm::Spiller* llvm::createSpiller() {
 960   switch (SpillerOpt) {
 961   default: assert(0 && "Unreachable!");
 962   case local:
 963     return new LocalSpiller();
 964   case simple:
 965     return new SimpleSpiller();
 966   }
 967 }