Cosmetic.
[oota-llvm.git] / lib / CodeGen / VirtRegMap.cpp
1 //===-- llvm/CodeGen/VirtRegMap.cpp - Virtual Register Map ----------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file 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/MachineInstrBuilder.h"
25 #include "llvm/CodeGen/MachineRegisterInfo.h"
26 #include "llvm/Target/TargetMachine.h"
27 #include "llvm/Target/TargetInstrInfo.h"
28 #include "llvm/Support/CommandLine.h"
29 #include "llvm/Support/Debug.h"
30 #include "llvm/Support/Compiler.h"
31 #include "llvm/ADT/BitVector.h"
32 #include "llvm/ADT/DenseMap.h"
33 #include "llvm/ADT/Statistic.h"
34 #include "llvm/ADT/STLExtras.h"
35 #include "llvm/ADT/SmallSet.h"
36 #include <algorithm>
37 using namespace llvm;
38
39 STATISTIC(NumSpills  , "Number of register spills");
40 STATISTIC(NumPSpills , "Number of physical register spills");
41 STATISTIC(NumReMats  , "Number of re-materialization");
42 STATISTIC(NumDRM     , "Number of re-materializable defs elided");
43 STATISTIC(NumStores  , "Number of stores added");
44 STATISTIC(NumLoads   , "Number of loads added");
45 STATISTIC(NumReused  , "Number of values reused");
46 STATISTIC(NumDSE     , "Number of dead stores elided");
47 STATISTIC(NumDCE     , "Number of copies elided");
48 STATISTIC(NumDSS     , "Number of dead spill slots removed");
49 STATISTIC(NumCommutes, "Number of instructions commuted");
50
51 namespace {
52   enum SpillerName { simple, local };
53 }
54
55 static cl::opt<SpillerName>
56 SpillerOpt("spiller",
57            cl::desc("Spiller to use: (default: local)"),
58            cl::Prefix,
59            cl::values(clEnumVal(simple, "  simple spiller"),
60                       clEnumVal(local,  "  local spiller"),
61                       clEnumValEnd),
62            cl::init(local));
63
64 //===----------------------------------------------------------------------===//
65 //  VirtRegMap implementation
66 //===----------------------------------------------------------------------===//
67
68 VirtRegMap::VirtRegMap(MachineFunction &mf)
69   : TII(*mf.getTarget().getInstrInfo()), MF(mf), 
70     Virt2PhysMap(NO_PHYS_REG), Virt2StackSlotMap(NO_STACK_SLOT),
71     Virt2ReMatIdMap(NO_STACK_SLOT), Virt2SplitMap(0),
72     Virt2SplitKillMap(0), ReMatMap(NULL), ReMatId(MAX_STACK_SLOT+1),
73     LowSpillSlot(NO_STACK_SLOT), HighSpillSlot(NO_STACK_SLOT) {
74   SpillSlotToUsesMap.resize(8);
75   ImplicitDefed.resize(MF.getRegInfo().getLastVirtReg()+1-
76                        TargetRegisterInfo::FirstVirtualRegister);
77   grow();
78 }
79
80 void VirtRegMap::grow() {
81   unsigned LastVirtReg = MF.getRegInfo().getLastVirtReg();
82   Virt2PhysMap.grow(LastVirtReg);
83   Virt2StackSlotMap.grow(LastVirtReg);
84   Virt2ReMatIdMap.grow(LastVirtReg);
85   Virt2SplitMap.grow(LastVirtReg);
86   Virt2SplitKillMap.grow(LastVirtReg);
87   ReMatMap.grow(LastVirtReg);
88   ImplicitDefed.resize(LastVirtReg-TargetRegisterInfo::FirstVirtualRegister+1);
89 }
90
91 int VirtRegMap::assignVirt2StackSlot(unsigned virtReg) {
92   assert(TargetRegisterInfo::isVirtualRegister(virtReg));
93   assert(Virt2StackSlotMap[virtReg] == NO_STACK_SLOT &&
94          "attempt to assign stack slot to already spilled register");
95   const TargetRegisterClass* RC = MF.getRegInfo().getRegClass(virtReg);
96   int SS = MF.getFrameInfo()->CreateStackObject(RC->getSize(),
97                                                 RC->getAlignment());
98   if (LowSpillSlot == NO_STACK_SLOT)
99     LowSpillSlot = SS;
100   if (HighSpillSlot == NO_STACK_SLOT || SS > HighSpillSlot)
101     HighSpillSlot = SS;
102   unsigned Idx = SS-LowSpillSlot;
103   while (Idx >= SpillSlotToUsesMap.size())
104     SpillSlotToUsesMap.resize(SpillSlotToUsesMap.size()*2);
105   Virt2StackSlotMap[virtReg] = SS;
106   ++NumSpills;
107   return SS;
108 }
109
110 void VirtRegMap::assignVirt2StackSlot(unsigned virtReg, int SS) {
111   assert(TargetRegisterInfo::isVirtualRegister(virtReg));
112   assert(Virt2StackSlotMap[virtReg] == NO_STACK_SLOT &&
113          "attempt to assign stack slot to already spilled register");
114   assert((SS >= 0 ||
115           (SS >= MF.getFrameInfo()->getObjectIndexBegin())) &&
116          "illegal fixed frame index");
117   Virt2StackSlotMap[virtReg] = SS;
118 }
119
120 int VirtRegMap::assignVirtReMatId(unsigned virtReg) {
121   assert(TargetRegisterInfo::isVirtualRegister(virtReg));
122   assert(Virt2ReMatIdMap[virtReg] == NO_STACK_SLOT &&
123          "attempt to assign re-mat id to already spilled register");
124   Virt2ReMatIdMap[virtReg] = ReMatId;
125   return ReMatId++;
126 }
127
128 void VirtRegMap::assignVirtReMatId(unsigned virtReg, int id) {
129   assert(TargetRegisterInfo::isVirtualRegister(virtReg));
130   assert(Virt2ReMatIdMap[virtReg] == NO_STACK_SLOT &&
131          "attempt to assign re-mat id to already spilled register");
132   Virt2ReMatIdMap[virtReg] = id;
133 }
134
135 int VirtRegMap::getEmergencySpillSlot(const TargetRegisterClass *RC) {
136   std::map<const TargetRegisterClass*, int>::iterator I =
137     EmergencySpillSlots.find(RC);
138   if (I != EmergencySpillSlots.end())
139     return I->second;
140   int SS = MF.getFrameInfo()->CreateStackObject(RC->getSize(),
141                                                 RC->getAlignment());
142   if (LowSpillSlot == NO_STACK_SLOT)
143     LowSpillSlot = SS;
144   if (HighSpillSlot == NO_STACK_SLOT || SS > HighSpillSlot)
145     HighSpillSlot = SS;
146   I->second = SS;
147   return SS;
148 }
149
150 void VirtRegMap::addSpillSlotUse(int FI, MachineInstr *MI) {
151   if (!MF.getFrameInfo()->isFixedObjectIndex(FI)) {
152     // If FI < LowSpillSlot, this stack reference was produced by
153     // instruction selection and is not a spill
154     if (FI >= LowSpillSlot) {
155       assert(FI >= 0 && "Spill slot index should not be negative!");
156       assert((unsigned)FI-LowSpillSlot < SpillSlotToUsesMap.size()
157              && "Invalid spill slot");
158       SpillSlotToUsesMap[FI-LowSpillSlot].insert(MI);
159     }
160   }
161 }
162
163 void VirtRegMap::virtFolded(unsigned VirtReg, MachineInstr *OldMI,
164                             MachineInstr *NewMI, ModRef MRInfo) {
165   // Move previous memory references folded to new instruction.
166   MI2VirtMapTy::iterator IP = MI2VirtMap.lower_bound(NewMI);
167   for (MI2VirtMapTy::iterator I = MI2VirtMap.lower_bound(OldMI),
168          E = MI2VirtMap.end(); I != E && I->first == OldMI; ) {
169     MI2VirtMap.insert(IP, std::make_pair(NewMI, I->second));
170     MI2VirtMap.erase(I++);
171   }
172
173   // add new memory reference
174   MI2VirtMap.insert(IP, std::make_pair(NewMI, std::make_pair(VirtReg, MRInfo)));
175 }
176
177 void VirtRegMap::virtFolded(unsigned VirtReg, MachineInstr *MI, ModRef MRInfo) {
178   MI2VirtMapTy::iterator IP = MI2VirtMap.lower_bound(MI);
179   MI2VirtMap.insert(IP, std::make_pair(MI, std::make_pair(VirtReg, MRInfo)));
180 }
181
182 void VirtRegMap::RemoveMachineInstrFromMaps(MachineInstr *MI) {
183   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
184     MachineOperand &MO = MI->getOperand(i);
185     if (!MO.isFrameIndex())
186       continue;
187     int FI = MO.getIndex();
188     if (MF.getFrameInfo()->isFixedObjectIndex(FI))
189       continue;
190     // This stack reference was produced by instruction selection and
191     // is not a spill
192     if (FI < LowSpillSlot)
193       continue;
194     assert((unsigned)FI-LowSpillSlot < SpillSlotToUsesMap.size()
195            && "Invalid spill slot");
196     SpillSlotToUsesMap[FI-LowSpillSlot].erase(MI);
197   }
198   MI2VirtMap.erase(MI);
199   SpillPt2VirtMap.erase(MI);
200   RestorePt2VirtMap.erase(MI);
201   EmergencySpillMap.erase(MI);
202 }
203
204 void VirtRegMap::print(std::ostream &OS) const {
205   const TargetRegisterInfo* TRI = MF.getTarget().getRegisterInfo();
206
207   OS << "********** REGISTER MAP **********\n";
208   for (unsigned i = TargetRegisterInfo::FirstVirtualRegister,
209          e = MF.getRegInfo().getLastVirtReg(); i <= e; ++i) {
210     if (Virt2PhysMap[i] != (unsigned)VirtRegMap::NO_PHYS_REG)
211       OS << "[reg" << i << " -> " << TRI->getName(Virt2PhysMap[i])
212          << "]\n";
213   }
214
215   for (unsigned i = TargetRegisterInfo::FirstVirtualRegister,
216          e = MF.getRegInfo().getLastVirtReg(); i <= e; ++i)
217     if (Virt2StackSlotMap[i] != VirtRegMap::NO_STACK_SLOT)
218       OS << "[reg" << i << " -> fi#" << Virt2StackSlotMap[i] << "]\n";
219   OS << '\n';
220 }
221
222 void VirtRegMap::dump() const {
223   print(cerr);
224 }
225
226
227 //===----------------------------------------------------------------------===//
228 // Simple Spiller Implementation
229 //===----------------------------------------------------------------------===//
230
231 Spiller::~Spiller() {}
232
233 namespace {
234   struct VISIBILITY_HIDDEN SimpleSpiller : public Spiller {
235     bool runOnMachineFunction(MachineFunction& mf, VirtRegMap &VRM);
236   };
237 }
238
239 bool SimpleSpiller::runOnMachineFunction(MachineFunction &MF, VirtRegMap &VRM) {
240   DOUT << "********** REWRITE MACHINE CODE **********\n";
241   DOUT << "********** Function: " << MF.getFunction()->getName() << '\n';
242   const TargetMachine &TM = MF.getTarget();
243   const TargetInstrInfo &TII = *TM.getInstrInfo();
244   
245
246   // LoadedRegs - Keep track of which vregs are loaded, so that we only load
247   // each vreg once (in the case where a spilled vreg is used by multiple
248   // operands).  This is always smaller than the number of operands to the
249   // current machine instr, so it should be small.
250   std::vector<unsigned> LoadedRegs;
251
252   for (MachineFunction::iterator MBBI = MF.begin(), E = MF.end();
253        MBBI != E; ++MBBI) {
254     DOUT << MBBI->getBasicBlock()->getName() << ":\n";
255     MachineBasicBlock &MBB = *MBBI;
256     for (MachineBasicBlock::iterator MII = MBB.begin(),
257            E = MBB.end(); MII != E; ++MII) {
258       MachineInstr &MI = *MII;
259       for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
260         MachineOperand &MO = MI.getOperand(i);
261         if (MO.isRegister() && MO.getReg()) {
262           if (TargetRegisterInfo::isVirtualRegister(MO.getReg())) {
263             unsigned VirtReg = MO.getReg();
264             unsigned PhysReg = VRM.getPhys(VirtReg);
265             if (!VRM.isAssignedReg(VirtReg)) {
266               int StackSlot = VRM.getStackSlot(VirtReg);
267               const TargetRegisterClass* RC =
268                 MF.getRegInfo().getRegClass(VirtReg);
269
270               if (MO.isUse() &&
271                   std::find(LoadedRegs.begin(), LoadedRegs.end(), VirtReg)
272                   == LoadedRegs.end()) {
273                 TII.loadRegFromStackSlot(MBB, &MI, PhysReg, StackSlot, RC);
274                 MachineInstr *LoadMI = prior(MII);
275                 VRM.addSpillSlotUse(StackSlot, LoadMI);
276                 LoadedRegs.push_back(VirtReg);
277                 ++NumLoads;
278                 DOUT << '\t' << *LoadMI;
279               }
280
281               if (MO.isDef()) {
282                 TII.storeRegToStackSlot(MBB, next(MII), PhysReg, true,
283                                         StackSlot, RC);
284                 MachineInstr *StoreMI = next(MII);
285                 VRM.addSpillSlotUse(StackSlot, StoreMI);
286                 ++NumStores;
287               }
288             }
289             MF.getRegInfo().setPhysRegUsed(PhysReg);
290             MI.getOperand(i).setReg(PhysReg);
291           } else {
292             MF.getRegInfo().setPhysRegUsed(MO.getReg());
293           }
294         }
295       }
296
297       DOUT << '\t' << MI;
298       LoadedRegs.clear();
299     }
300   }
301   return true;
302 }
303
304 //===----------------------------------------------------------------------===//
305 //  Local Spiller Implementation
306 //===----------------------------------------------------------------------===//
307
308 namespace {
309   class AvailableSpills;
310
311   /// LocalSpiller - This spiller does a simple pass over the machine basic
312   /// block to attempt to keep spills in registers as much as possible for
313   /// blocks that have low register pressure (the vreg may be spilled due to
314   /// register pressure in other blocks).
315   class VISIBILITY_HIDDEN LocalSpiller : public Spiller {
316     MachineRegisterInfo *RegInfo;
317     const TargetRegisterInfo *TRI;
318     const TargetInstrInfo *TII;
319     DenseMap<MachineInstr*, unsigned> DistanceMap;
320   public:
321     bool runOnMachineFunction(MachineFunction &MF, VirtRegMap &VRM) {
322       RegInfo = &MF.getRegInfo(); 
323       TRI = MF.getTarget().getRegisterInfo();
324       TII = MF.getTarget().getInstrInfo();
325       DOUT << "\n**** Local spiller rewriting function '"
326            << MF.getFunction()->getName() << "':\n";
327       DOUT << "**** Machine Instrs (NOTE! Does not include spills and reloads!)"
328               " ****\n";
329       DEBUG(MF.dump());
330
331       for (MachineFunction::iterator MBB = MF.begin(), E = MF.end();
332            MBB != E; ++MBB)
333         RewriteMBB(*MBB, VRM);
334
335       // Mark unused spill slots.
336       MachineFrameInfo *MFI = MF.getFrameInfo();
337       int SS = VRM.getLowSpillSlot();
338       if (SS != VirtRegMap::NO_STACK_SLOT)
339         for (int e = VRM.getHighSpillSlot(); SS <= e; ++SS)
340           if (!VRM.isSpillSlotUsed(SS)) {
341             MFI->RemoveStackObject(SS);
342             ++NumDSS;
343           }
344
345       DOUT << "**** Post Machine Instrs ****\n";
346       DEBUG(MF.dump());
347
348       return true;
349     }
350   private:
351     void TransferDeadness(MachineBasicBlock *MBB, unsigned CurDist,
352                           unsigned Reg, BitVector &RegKills,
353                           std::vector<MachineOperand*> &KillOps);
354     bool PrepForUnfoldOpti(MachineBasicBlock &MBB,
355                            MachineBasicBlock::iterator &MII,
356                            std::vector<MachineInstr*> &MaybeDeadStores,
357                            AvailableSpills &Spills, BitVector &RegKills,
358                            std::vector<MachineOperand*> &KillOps,
359                            VirtRegMap &VRM);
360     bool CommuteToFoldReload(MachineBasicBlock &MBB,
361                              MachineBasicBlock::iterator &MII,
362                              unsigned VirtReg, unsigned SrcReg, int SS,
363                              BitVector &RegKills,
364                              std::vector<MachineOperand*> &KillOps,
365                              const TargetRegisterInfo *TRI,
366                              VirtRegMap &VRM);
367     void SpillRegToStackSlot(MachineBasicBlock &MBB,
368                              MachineBasicBlock::iterator &MII,
369                              int Idx, unsigned PhysReg, int StackSlot,
370                              const TargetRegisterClass *RC,
371                              bool isAvailable, MachineInstr *&LastStore,
372                              AvailableSpills &Spills,
373                              SmallSet<MachineInstr*, 4> &ReMatDefs,
374                              BitVector &RegKills,
375                              std::vector<MachineOperand*> &KillOps,
376                              VirtRegMap &VRM);
377     void RewriteMBB(MachineBasicBlock &MBB, VirtRegMap &VRM);
378   };
379 }
380
381 /// AvailableSpills - As the local spiller is scanning and rewriting an MBB from
382 /// top down, keep track of which spills slots or remat are available in each
383 /// register.
384 ///
385 /// Note that not all physregs are created equal here.  In particular, some
386 /// physregs are reloads that we are allowed to clobber or ignore at any time.
387 /// Other physregs are values that the register allocated program is using that
388 /// we cannot CHANGE, but we can read if we like.  We keep track of this on a 
389 /// per-stack-slot / remat id basis as the low bit in the value of the
390 /// SpillSlotsAvailable entries.  The predicate 'canClobberPhysReg()' checks
391 /// this bit and addAvailable sets it if.
392 namespace {
393 class VISIBILITY_HIDDEN AvailableSpills {
394   const TargetRegisterInfo *TRI;
395   const TargetInstrInfo *TII;
396
397   // SpillSlotsOrReMatsAvailable - This map keeps track of all of the spilled
398   // or remat'ed virtual register values that are still available, due to being
399   // loaded or stored to, but not invalidated yet.
400   std::map<int, unsigned> SpillSlotsOrReMatsAvailable;
401     
402   // PhysRegsAvailable - This is the inverse of SpillSlotsOrReMatsAvailable,
403   // indicating which stack slot values are currently held by a physreg.  This
404   // is used to invalidate entries in SpillSlotsOrReMatsAvailable when a
405   // physreg is modified.
406   std::multimap<unsigned, int> PhysRegsAvailable;
407   
408   void disallowClobberPhysRegOnly(unsigned PhysReg);
409
410   void ClobberPhysRegOnly(unsigned PhysReg);
411 public:
412   AvailableSpills(const TargetRegisterInfo *tri, const TargetInstrInfo *tii)
413     : TRI(tri), TII(tii) {
414   }
415   
416   const TargetRegisterInfo *getRegInfo() const { return TRI; }
417
418   /// getSpillSlotOrReMatPhysReg - If the specified stack slot or remat is
419   /// available in a  physical register, return that PhysReg, otherwise
420   /// return 0.
421   unsigned getSpillSlotOrReMatPhysReg(int Slot) const {
422     std::map<int, unsigned>::const_iterator I =
423       SpillSlotsOrReMatsAvailable.find(Slot);
424     if (I != SpillSlotsOrReMatsAvailable.end()) {
425       return I->second >> 1;  // Remove the CanClobber bit.
426     }
427     return 0;
428   }
429
430   /// addAvailable - Mark that the specified stack slot / remat is available in
431   /// the specified physreg.  If CanClobber is true, the physreg can be modified
432   /// at any time without changing the semantics of the program.
433   void addAvailable(int SlotOrReMat, MachineInstr *MI, unsigned Reg,
434                     bool CanClobber = true) {
435     // If this stack slot is thought to be available in some other physreg, 
436     // remove its record.
437     ModifyStackSlotOrReMat(SlotOrReMat);
438     
439     PhysRegsAvailable.insert(std::make_pair(Reg, SlotOrReMat));
440     SpillSlotsOrReMatsAvailable[SlotOrReMat]= (Reg << 1) | (unsigned)CanClobber;
441   
442     if (SlotOrReMat > VirtRegMap::MAX_STACK_SLOT)
443       DOUT << "Remembering RM#" << SlotOrReMat-VirtRegMap::MAX_STACK_SLOT-1;
444     else
445       DOUT << "Remembering SS#" << SlotOrReMat;
446     DOUT << " in physreg " << TRI->getName(Reg) << "\n";
447   }
448
449   /// canClobberPhysReg - Return true if the spiller is allowed to change the 
450   /// value of the specified stackslot register if it desires.  The specified
451   /// stack slot must be available in a physreg for this query to make sense.
452   bool canClobberPhysReg(int SlotOrReMat) const {
453     assert(SpillSlotsOrReMatsAvailable.count(SlotOrReMat) &&
454            "Value not available!");
455     return SpillSlotsOrReMatsAvailable.find(SlotOrReMat)->second & 1;
456   }
457
458   /// disallowClobberPhysReg - Unset the CanClobber bit of the specified
459   /// stackslot register. The register is still available but is no longer
460   /// allowed to be modifed.
461   void disallowClobberPhysReg(unsigned PhysReg);
462   
463   /// ClobberPhysReg - This is called when the specified physreg changes
464   /// value.  We use this to invalidate any info about stuff that lives in
465   /// it and any of its aliases.
466   void ClobberPhysReg(unsigned PhysReg);
467
468   /// ModifyStackSlotOrReMat - This method is called when the value in a stack
469   /// slot changes.  This removes information about which register the previous
470   /// value for this slot lives in (as the previous value is dead now).
471   void ModifyStackSlotOrReMat(int SlotOrReMat);
472 };
473 }
474
475 /// disallowClobberPhysRegOnly - Unset the CanClobber bit of the specified
476 /// stackslot register. The register is still available but is no longer
477 /// allowed to be modifed.
478 void AvailableSpills::disallowClobberPhysRegOnly(unsigned PhysReg) {
479   std::multimap<unsigned, int>::iterator I =
480     PhysRegsAvailable.lower_bound(PhysReg);
481   while (I != PhysRegsAvailable.end() && I->first == PhysReg) {
482     int SlotOrReMat = I->second;
483     I++;
484     assert((SpillSlotsOrReMatsAvailable[SlotOrReMat] >> 1) == PhysReg &&
485            "Bidirectional map mismatch!");
486     SpillSlotsOrReMatsAvailable[SlotOrReMat] &= ~1;
487     DOUT << "PhysReg " << TRI->getName(PhysReg)
488          << " copied, it is available for use but can no longer be modified\n";
489   }
490 }
491
492 /// disallowClobberPhysReg - Unset the CanClobber bit of the specified
493 /// stackslot register and its aliases. The register and its aliases may
494 /// still available but is no longer allowed to be modifed.
495 void AvailableSpills::disallowClobberPhysReg(unsigned PhysReg) {
496   for (const unsigned *AS = TRI->getAliasSet(PhysReg); *AS; ++AS)
497     disallowClobberPhysRegOnly(*AS);
498   disallowClobberPhysRegOnly(PhysReg);
499 }
500
501 /// ClobberPhysRegOnly - This is called when the specified physreg changes
502 /// value.  We use this to invalidate any info about stuff we thing lives in it.
503 void AvailableSpills::ClobberPhysRegOnly(unsigned PhysReg) {
504   std::multimap<unsigned, int>::iterator I =
505     PhysRegsAvailable.lower_bound(PhysReg);
506   while (I != PhysRegsAvailable.end() && I->first == PhysReg) {
507     int SlotOrReMat = I->second;
508     PhysRegsAvailable.erase(I++);
509     assert((SpillSlotsOrReMatsAvailable[SlotOrReMat] >> 1) == PhysReg &&
510            "Bidirectional map mismatch!");
511     SpillSlotsOrReMatsAvailable.erase(SlotOrReMat);
512     DOUT << "PhysReg " << TRI->getName(PhysReg)
513          << " clobbered, invalidating ";
514     if (SlotOrReMat > VirtRegMap::MAX_STACK_SLOT)
515       DOUT << "RM#" << SlotOrReMat-VirtRegMap::MAX_STACK_SLOT-1 << "\n";
516     else
517       DOUT << "SS#" << SlotOrReMat << "\n";
518   }
519 }
520
521 /// ClobberPhysReg - This is called when the specified physreg changes
522 /// value.  We use this to invalidate any info about stuff we thing lives in
523 /// it and any of its aliases.
524 void AvailableSpills::ClobberPhysReg(unsigned PhysReg) {
525   for (const unsigned *AS = TRI->getAliasSet(PhysReg); *AS; ++AS)
526     ClobberPhysRegOnly(*AS);
527   ClobberPhysRegOnly(PhysReg);
528 }
529
530 /// ModifyStackSlotOrReMat - This method is called when the value in a stack
531 /// slot changes.  This removes information about which register the previous
532 /// value for this slot lives in (as the previous value is dead now).
533 void AvailableSpills::ModifyStackSlotOrReMat(int SlotOrReMat) {
534   std::map<int, unsigned>::iterator It =
535     SpillSlotsOrReMatsAvailable.find(SlotOrReMat);
536   if (It == SpillSlotsOrReMatsAvailable.end()) return;
537   unsigned Reg = It->second >> 1;
538   SpillSlotsOrReMatsAvailable.erase(It);
539   
540   // This register may hold the value of multiple stack slots, only remove this
541   // stack slot from the set of values the register contains.
542   std::multimap<unsigned, int>::iterator I = PhysRegsAvailable.lower_bound(Reg);
543   for (; ; ++I) {
544     assert(I != PhysRegsAvailable.end() && I->first == Reg &&
545            "Map inverse broken!");
546     if (I->second == SlotOrReMat) break;
547   }
548   PhysRegsAvailable.erase(I);
549 }
550
551
552
553 /// InvalidateKills - MI is going to be deleted. If any of its operands are
554 /// marked kill, then invalidate the information.
555 static void InvalidateKills(MachineInstr &MI, BitVector &RegKills,
556                             std::vector<MachineOperand*> &KillOps,
557                             SmallVector<unsigned, 2> *KillRegs = NULL) {
558   for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
559     MachineOperand &MO = MI.getOperand(i);
560     if (!MO.isRegister() || !MO.isUse() || !MO.isKill())
561       continue;
562     unsigned Reg = MO.getReg();
563     if (KillRegs)
564       KillRegs->push_back(Reg);
565     if (KillOps[Reg] == &MO) {
566       RegKills.reset(Reg);
567       KillOps[Reg] = NULL;
568     }
569   }
570 }
571
572 /// InvalidateKill - A MI that defines the specified register is being deleted,
573 /// invalidate the register kill information.
574 static void InvalidateKill(unsigned Reg, BitVector &RegKills,
575                            std::vector<MachineOperand*> &KillOps) {
576   if (RegKills[Reg]) {
577     KillOps[Reg]->setIsKill(false);
578     KillOps[Reg] = NULL;
579     RegKills.reset(Reg);
580   }
581 }
582
583 /// InvalidateRegDef - If the def operand of the specified def MI is now dead
584 /// (since it's spill instruction is removed), mark it isDead. Also checks if
585 /// the def MI has other definition operands that are not dead. Returns it by
586 /// reference.
587 static bool InvalidateRegDef(MachineBasicBlock::iterator I,
588                              MachineInstr &NewDef, unsigned Reg,
589                              bool &HasLiveDef) {
590   // Due to remat, it's possible this reg isn't being reused. That is,
591   // the def of this reg (by prev MI) is now dead.
592   MachineInstr *DefMI = I;
593   MachineOperand *DefOp = NULL;
594   for (unsigned i = 0, e = DefMI->getNumOperands(); i != e; ++i) {
595     MachineOperand &MO = DefMI->getOperand(i);
596     if (MO.isRegister() && MO.isDef()) {
597       if (MO.getReg() == Reg)
598         DefOp = &MO;
599       else if (!MO.isDead())
600         HasLiveDef = true;
601     }
602   }
603   if (!DefOp)
604     return false;
605
606   bool FoundUse = false, Done = false;
607   MachineBasicBlock::iterator E = NewDef;
608   ++I; ++E;
609   for (; !Done && I != E; ++I) {
610     MachineInstr *NMI = I;
611     for (unsigned j = 0, ee = NMI->getNumOperands(); j != ee; ++j) {
612       MachineOperand &MO = NMI->getOperand(j);
613       if (!MO.isRegister() || MO.getReg() != Reg)
614         continue;
615       if (MO.isUse())
616         FoundUse = true;
617       Done = true; // Stop after scanning all the operands of this MI.
618     }
619   }
620   if (!FoundUse) {
621     // Def is dead!
622     DefOp->setIsDead();
623     return true;
624   }
625   return false;
626 }
627
628 /// UpdateKills - Track and update kill info. If a MI reads a register that is
629 /// marked kill, then it must be due to register reuse. Transfer the kill info
630 /// over.
631 static void UpdateKills(MachineInstr &MI, BitVector &RegKills,
632                         std::vector<MachineOperand*> &KillOps) {
633   const TargetInstrDesc &TID = MI.getDesc();
634   for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
635     MachineOperand &MO = MI.getOperand(i);
636     if (!MO.isRegister() || !MO.isUse())
637       continue;
638     unsigned Reg = MO.getReg();
639     if (Reg == 0)
640       continue;
641     
642     if (RegKills[Reg] && KillOps[Reg]->getParent() != &MI) {
643       // That can't be right. Register is killed but not re-defined and it's
644       // being reused. Let's fix that.
645       KillOps[Reg]->setIsKill(false);
646       KillOps[Reg] = NULL;
647       RegKills.reset(Reg);
648       if (i < TID.getNumOperands() &&
649           TID.getOperandConstraint(i, TOI::TIED_TO) == -1)
650         // Unless it's a two-address operand, this is the new kill.
651         MO.setIsKill();
652     }
653     if (MO.isKill()) {
654       RegKills.set(Reg);
655       KillOps[Reg] = &MO;
656     }
657   }
658
659   for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
660     const MachineOperand &MO = MI.getOperand(i);
661     if (!MO.isRegister() || !MO.isDef())
662       continue;
663     unsigned Reg = MO.getReg();
664     RegKills.reset(Reg);
665     KillOps[Reg] = NULL;
666   }
667 }
668
669 /// ReMaterialize - Re-materialize definition for Reg targetting DestReg.
670 ///
671 static void ReMaterialize(MachineBasicBlock &MBB,
672                           MachineBasicBlock::iterator &MII,
673                           unsigned DestReg, unsigned Reg,
674                           const TargetInstrInfo *TII,
675                           const TargetRegisterInfo *TRI,
676                           VirtRegMap &VRM) {
677   TII->reMaterialize(MBB, MII, DestReg, VRM.getReMaterializedMI(Reg));
678   MachineInstr *NewMI = prior(MII);
679   for (unsigned i = 0, e = NewMI->getNumOperands(); i != e; ++i) {
680     MachineOperand &MO = NewMI->getOperand(i);
681     if (!MO.isRegister() || MO.getReg() == 0)
682       continue;
683     unsigned VirtReg = MO.getReg();
684     if (TargetRegisterInfo::isPhysicalRegister(VirtReg))
685       continue;
686     assert(MO.isUse());
687     unsigned SubIdx = MO.getSubReg();
688     unsigned Phys = VRM.getPhys(VirtReg);
689     assert(Phys);
690     unsigned RReg = SubIdx ? TRI->getSubReg(Phys, SubIdx) : Phys;
691     MO.setReg(RReg);
692   }
693   ++NumReMats;
694 }
695
696
697 // ReusedOp - For each reused operand, we keep track of a bit of information, in
698 // case we need to rollback upon processing a new operand.  See comments below.
699 namespace {
700   struct ReusedOp {
701     // The MachineInstr operand that reused an available value.
702     unsigned Operand;
703
704     // StackSlotOrReMat - The spill slot or remat id of the value being reused.
705     unsigned StackSlotOrReMat;
706
707     // PhysRegReused - The physical register the value was available in.
708     unsigned PhysRegReused;
709
710     // AssignedPhysReg - The physreg that was assigned for use by the reload.
711     unsigned AssignedPhysReg;
712     
713     // VirtReg - The virtual register itself.
714     unsigned VirtReg;
715
716     ReusedOp(unsigned o, unsigned ss, unsigned prr, unsigned apr,
717              unsigned vreg)
718       : Operand(o), StackSlotOrReMat(ss), PhysRegReused(prr),
719         AssignedPhysReg(apr), VirtReg(vreg) {}
720   };
721   
722   /// ReuseInfo - This maintains a collection of ReuseOp's for each operand that
723   /// is reused instead of reloaded.
724   class VISIBILITY_HIDDEN ReuseInfo {
725     MachineInstr &MI;
726     std::vector<ReusedOp> Reuses;
727     BitVector PhysRegsClobbered;
728   public:
729     ReuseInfo(MachineInstr &mi, const TargetRegisterInfo *tri) : MI(mi) {
730       PhysRegsClobbered.resize(tri->getNumRegs());
731     }
732     
733     bool hasReuses() const {
734       return !Reuses.empty();
735     }
736     
737     /// addReuse - If we choose to reuse a virtual register that is already
738     /// available instead of reloading it, remember that we did so.
739     void addReuse(unsigned OpNo, unsigned StackSlotOrReMat,
740                   unsigned PhysRegReused, unsigned AssignedPhysReg,
741                   unsigned VirtReg) {
742       // If the reload is to the assigned register anyway, no undo will be
743       // required.
744       if (PhysRegReused == AssignedPhysReg) return;
745       
746       // Otherwise, remember this.
747       Reuses.push_back(ReusedOp(OpNo, StackSlotOrReMat, PhysRegReused, 
748                                 AssignedPhysReg, VirtReg));
749     }
750
751     void markClobbered(unsigned PhysReg) {
752       PhysRegsClobbered.set(PhysReg);
753     }
754
755     bool isClobbered(unsigned PhysReg) const {
756       return PhysRegsClobbered.test(PhysReg);
757     }
758     
759     /// GetRegForReload - We are about to emit a reload into PhysReg.  If there
760     /// is some other operand that is using the specified register, either pick
761     /// a new register to use, or evict the previous reload and use this reg. 
762     unsigned GetRegForReload(unsigned PhysReg, MachineInstr *MI,
763                              AvailableSpills &Spills,
764                              std::vector<MachineInstr*> &MaybeDeadStores,
765                              SmallSet<unsigned, 8> &Rejected,
766                              BitVector &RegKills,
767                              std::vector<MachineOperand*> &KillOps,
768                              VirtRegMap &VRM) {
769       const TargetInstrInfo* TII = MI->getParent()->getParent()->getTarget()
770                                    .getInstrInfo();
771       
772       if (Reuses.empty()) return PhysReg;  // This is most often empty.
773
774       for (unsigned ro = 0, e = Reuses.size(); ro != e; ++ro) {
775         ReusedOp &Op = Reuses[ro];
776         // If we find some other reuse that was supposed to use this register
777         // exactly for its reload, we can change this reload to use ITS reload
778         // register. That is, unless its reload register has already been
779         // considered and subsequently rejected because it has also been reused
780         // by another operand.
781         if (Op.PhysRegReused == PhysReg &&
782             Rejected.count(Op.AssignedPhysReg) == 0) {
783           // Yup, use the reload register that we didn't use before.
784           unsigned NewReg = Op.AssignedPhysReg;
785           Rejected.insert(PhysReg);
786           return GetRegForReload(NewReg, MI, Spills, MaybeDeadStores, Rejected,
787                                  RegKills, KillOps, VRM);
788         } else {
789           // Otherwise, we might also have a problem if a previously reused
790           // value aliases the new register.  If so, codegen the previous reload
791           // and use this one.          
792           unsigned PRRU = Op.PhysRegReused;
793           const TargetRegisterInfo *TRI = Spills.getRegInfo();
794           if (TRI->areAliases(PRRU, PhysReg)) {
795             // Okay, we found out that an alias of a reused register
796             // was used.  This isn't good because it means we have
797             // to undo a previous reuse.
798             MachineBasicBlock *MBB = MI->getParent();
799             const TargetRegisterClass *AliasRC =
800               MBB->getParent()->getRegInfo().getRegClass(Op.VirtReg);
801
802             // Copy Op out of the vector and remove it, we're going to insert an
803             // explicit load for it.
804             ReusedOp NewOp = Op;
805             Reuses.erase(Reuses.begin()+ro);
806
807             // Ok, we're going to try to reload the assigned physreg into the
808             // slot that we were supposed to in the first place.  However, that
809             // register could hold a reuse.  Check to see if it conflicts or
810             // would prefer us to use a different register.
811             unsigned NewPhysReg = GetRegForReload(NewOp.AssignedPhysReg,
812                                                   MI, Spills, MaybeDeadStores,
813                                               Rejected, RegKills, KillOps, VRM);
814             
815             MachineBasicBlock::iterator MII = MI;
816             if (NewOp.StackSlotOrReMat > VirtRegMap::MAX_STACK_SLOT) {
817               ReMaterialize(*MBB, MII, NewPhysReg, NewOp.VirtReg, TII, TRI,VRM);
818             } else {
819               TII->loadRegFromStackSlot(*MBB, MII, NewPhysReg,
820                                         NewOp.StackSlotOrReMat, AliasRC);
821               MachineInstr *LoadMI = prior(MII);
822               VRM.addSpillSlotUse(NewOp.StackSlotOrReMat, LoadMI);
823               // Any stores to this stack slot are not dead anymore.
824               MaybeDeadStores[NewOp.StackSlotOrReMat] = NULL;            
825               ++NumLoads;
826             }
827             Spills.ClobberPhysReg(NewPhysReg);
828             Spills.ClobberPhysReg(NewOp.PhysRegReused);
829             
830             MI->getOperand(NewOp.Operand).setReg(NewPhysReg);
831             
832             Spills.addAvailable(NewOp.StackSlotOrReMat, MI, NewPhysReg);
833             --MII;
834             UpdateKills(*MII, RegKills, KillOps);
835             DOUT << '\t' << *MII;
836             
837             DOUT << "Reuse undone!\n";
838             --NumReused;
839             
840             // Finally, PhysReg is now available, go ahead and use it.
841             return PhysReg;
842           }
843         }
844       }
845       return PhysReg;
846     }
847
848     /// GetRegForReload - Helper for the above GetRegForReload(). Add a
849     /// 'Rejected' set to remember which registers have been considered and
850     /// rejected for the reload. This avoids infinite looping in case like
851     /// this:
852     /// t1 := op t2, t3
853     /// t2 <- assigned r0 for use by the reload but ended up reuse r1
854     /// t3 <- assigned r1 for use by the reload but ended up reuse r0
855     /// t1 <- desires r1
856     ///       sees r1 is taken by t2, tries t2's reload register r0
857     ///       sees r0 is taken by t3, tries t3's reload register r1
858     ///       sees r1 is taken by t2, tries t2's reload register r0 ...
859     unsigned GetRegForReload(unsigned PhysReg, MachineInstr *MI,
860                              AvailableSpills &Spills,
861                              std::vector<MachineInstr*> &MaybeDeadStores,
862                              BitVector &RegKills,
863                              std::vector<MachineOperand*> &KillOps,
864                              VirtRegMap &VRM) {
865       SmallSet<unsigned, 8> Rejected;
866       return GetRegForReload(PhysReg, MI, Spills, MaybeDeadStores, Rejected,
867                              RegKills, KillOps, VRM);
868     }
869   };
870 }
871
872 /// PrepForUnfoldOpti - Turn a store folding instruction into a load folding
873 /// instruction. e.g.
874 ///     xorl  %edi, %eax
875 ///     movl  %eax, -32(%ebp)
876 ///     movl  -36(%ebp), %eax
877 ///     orl   %eax, -32(%ebp)
878 /// ==>
879 ///     xorl  %edi, %eax
880 ///     orl   -36(%ebp), %eax
881 ///     mov   %eax, -32(%ebp)
882 /// This enables unfolding optimization for a subsequent instruction which will
883 /// also eliminate the newly introduced store instruction.
884 bool LocalSpiller::PrepForUnfoldOpti(MachineBasicBlock &MBB,
885                                     MachineBasicBlock::iterator &MII,
886                                     std::vector<MachineInstr*> &MaybeDeadStores,
887                                     AvailableSpills &Spills,
888                                     BitVector &RegKills,
889                                     std::vector<MachineOperand*> &KillOps,
890                                     VirtRegMap &VRM) {
891   MachineFunction &MF = *MBB.getParent();
892   MachineInstr &MI = *MII;
893   unsigned UnfoldedOpc = 0;
894   unsigned UnfoldPR = 0;
895   unsigned UnfoldVR = 0;
896   int FoldedSS = VirtRegMap::NO_STACK_SLOT;
897   VirtRegMap::MI2VirtMapTy::const_iterator I, End;
898   for (tie(I, End) = VRM.getFoldedVirts(&MI); I != End; ) {
899     // Only transform a MI that folds a single register.
900     if (UnfoldedOpc)
901       return false;
902     UnfoldVR = I->second.first;
903     VirtRegMap::ModRef MR = I->second.second;
904     // MI2VirtMap be can updated which invalidate the iterator.
905     // Increment the iterator first.
906     ++I; 
907     if (VRM.isAssignedReg(UnfoldVR))
908       continue;
909     // If this reference is not a use, any previous store is now dead.
910     // Otherwise, the store to this stack slot is not dead anymore.
911     FoldedSS = VRM.getStackSlot(UnfoldVR);
912     MachineInstr* DeadStore = MaybeDeadStores[FoldedSS];
913     if (DeadStore && (MR & VirtRegMap::isModRef)) {
914       unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(FoldedSS);
915       if (!PhysReg || !DeadStore->readsRegister(PhysReg))
916         continue;
917       UnfoldPR = PhysReg;
918       UnfoldedOpc = TII->getOpcodeAfterMemoryUnfold(MI.getOpcode(),
919                                                     false, true);
920     }
921   }
922
923   if (!UnfoldedOpc)
924     return false;
925
926   for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
927     MachineOperand &MO = MI.getOperand(i);
928     if (!MO.isRegister() || MO.getReg() == 0 || !MO.isUse())
929       continue;
930     unsigned VirtReg = MO.getReg();
931     if (TargetRegisterInfo::isPhysicalRegister(VirtReg) || MO.getSubReg())
932       continue;
933     if (VRM.isAssignedReg(VirtReg)) {
934       unsigned PhysReg = VRM.getPhys(VirtReg);
935       if (PhysReg && TRI->regsOverlap(PhysReg, UnfoldPR))
936         return false;
937     } else if (VRM.isReMaterialized(VirtReg))
938       continue;
939     int SS = VRM.getStackSlot(VirtReg);
940     unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(SS);
941     if (PhysReg) {
942       if (TRI->regsOverlap(PhysReg, UnfoldPR))
943         return false;
944       continue;
945     }
946     PhysReg = VRM.getPhys(VirtReg);
947     if (!TRI->regsOverlap(PhysReg, UnfoldPR))
948       continue;
949
950     // Ok, we'll need to reload the value into a register which makes
951     // it impossible to perform the store unfolding optimization later.
952     // Let's see if it is possible to fold the load if the store is
953     // unfolded. This allows us to perform the store unfolding
954     // optimization.
955     SmallVector<MachineInstr*, 4> NewMIs;
956     if (TII->unfoldMemoryOperand(MF, &MI, UnfoldVR, false, false, NewMIs)) {
957       assert(NewMIs.size() == 1);
958       MachineInstr *NewMI = NewMIs.back();
959       NewMIs.clear();
960       int Idx = NewMI->findRegisterUseOperandIdx(VirtReg, false);
961       assert(Idx != -1);
962       SmallVector<unsigned, 2> Ops;
963       Ops.push_back(Idx);
964       MachineInstr *FoldedMI = TII->foldMemoryOperand(MF, NewMI, Ops, SS);
965       if (FoldedMI) {
966         VRM.addSpillSlotUse(SS, FoldedMI);
967         if (!VRM.hasPhys(UnfoldVR))
968           VRM.assignVirt2Phys(UnfoldVR, UnfoldPR);
969         VRM.virtFolded(VirtReg, FoldedMI, VirtRegMap::isRef);
970         MII = MBB.insert(MII, FoldedMI);
971         InvalidateKills(MI, RegKills, KillOps);
972         VRM.RemoveMachineInstrFromMaps(&MI);
973         MBB.erase(&MI);
974         return true;
975       }
976       delete NewMI;
977     }
978   }
979   return false;
980 }
981
982 /// CommuteToFoldReload -
983 /// Look for
984 /// r1 = load fi#1
985 /// r1 = op r1, r2<kill>
986 /// store r1, fi#1
987 ///
988 /// If op is commutable and r2 is killed, then we can xform these to
989 /// r2 = op r2, fi#1
990 /// store r2, fi#1
991 bool LocalSpiller::CommuteToFoldReload(MachineBasicBlock &MBB,
992                                     MachineBasicBlock::iterator &MII,
993                                     unsigned VirtReg, unsigned SrcReg, int SS,
994                                     BitVector &RegKills,
995                                     std::vector<MachineOperand*> &KillOps,
996                                     const TargetRegisterInfo *TRI,
997                                     VirtRegMap &VRM) {
998   if (MII == MBB.begin() || !MII->killsRegister(SrcReg))
999     return false;
1000
1001   MachineFunction &MF = *MBB.getParent();
1002   MachineInstr &MI = *MII;
1003   MachineBasicBlock::iterator DefMII = prior(MII);
1004   MachineInstr *DefMI = DefMII;
1005   const TargetInstrDesc &TID = DefMI->getDesc();
1006   unsigned NewDstIdx;
1007   if (DefMII != MBB.begin() &&
1008       TID.isCommutable() &&
1009       TII->CommuteChangesDestination(DefMI, NewDstIdx)) {
1010     MachineOperand &NewDstMO = DefMI->getOperand(NewDstIdx);
1011     unsigned NewReg = NewDstMO.getReg();
1012     if (!NewDstMO.isKill() || TRI->regsOverlap(NewReg, SrcReg))
1013       return false;
1014     MachineInstr *ReloadMI = prior(DefMII);
1015     int FrameIdx;
1016     unsigned DestReg = TII->isLoadFromStackSlot(ReloadMI, FrameIdx);
1017     if (DestReg != SrcReg || FrameIdx != SS)
1018       return false;
1019     int UseIdx = DefMI->findRegisterUseOperandIdx(DestReg, false);
1020     if (UseIdx == -1)
1021       return false;
1022     int DefIdx = TID.getOperandConstraint(UseIdx, TOI::TIED_TO);
1023     if (DefIdx == -1)
1024       return false;
1025     assert(DefMI->getOperand(DefIdx).isRegister() &&
1026            DefMI->getOperand(DefIdx).getReg() == SrcReg);
1027
1028     // Now commute def instruction.
1029     MachineInstr *CommutedMI = TII->commuteInstruction(DefMI, true);
1030     if (!CommutedMI)
1031       return false;
1032     SmallVector<unsigned, 2> Ops;
1033     Ops.push_back(NewDstIdx);
1034     MachineInstr *FoldedMI = TII->foldMemoryOperand(MF, CommutedMI, Ops, SS);
1035     delete CommutedMI;  // Not needed since foldMemoryOperand returns new MI.
1036     if (!FoldedMI)
1037       return false;
1038
1039     VRM.addSpillSlotUse(SS, FoldedMI);
1040     VRM.virtFolded(VirtReg, FoldedMI, VirtRegMap::isRef);
1041     // Insert new def MI and spill MI.
1042     const TargetRegisterClass* RC = MF.getRegInfo().getRegClass(VirtReg);
1043     TII->storeRegToStackSlot(MBB, MI, NewReg, true, SS, RC);
1044     MII = prior(MII);
1045     MachineInstr *StoreMI = MII;
1046     VRM.addSpillSlotUse(SS, StoreMI);
1047     VRM.virtFolded(VirtReg, StoreMI, VirtRegMap::isMod);
1048     MII = MBB.insert(MII, FoldedMI);  // Update MII to backtrack.
1049
1050     // Delete all 3 old instructions.
1051     InvalidateKills(*ReloadMI, RegKills, KillOps);
1052     VRM.RemoveMachineInstrFromMaps(ReloadMI);
1053     MBB.erase(ReloadMI);
1054     InvalidateKills(*DefMI, RegKills, KillOps);
1055     VRM.RemoveMachineInstrFromMaps(DefMI);
1056     MBB.erase(DefMI);
1057     InvalidateKills(MI, RegKills, KillOps);
1058     VRM.RemoveMachineInstrFromMaps(&MI);
1059     MBB.erase(&MI);
1060
1061     ++NumCommutes;
1062     return true;
1063   }
1064
1065   return false;
1066 }
1067
1068 /// findSuperReg - Find the SubReg's super-register of given register class
1069 /// where its SubIdx sub-register is SubReg.
1070 static unsigned findSuperReg(const TargetRegisterClass *RC, unsigned SubReg,
1071                              unsigned SubIdx, const TargetRegisterInfo *TRI) {
1072   for (TargetRegisterClass::iterator I = RC->begin(), E = RC->end();
1073        I != E; ++I) {
1074     unsigned Reg = *I;
1075     if (TRI->getSubReg(Reg, SubIdx) == SubReg)
1076       return Reg;
1077   }
1078   return 0;
1079 }
1080
1081 /// SpillRegToStackSlot - Spill a register to a specified stack slot. Check if
1082 /// the last store to the same slot is now dead. If so, remove the last store.
1083 void LocalSpiller::SpillRegToStackSlot(MachineBasicBlock &MBB,
1084                                   MachineBasicBlock::iterator &MII,
1085                                   int Idx, unsigned PhysReg, int StackSlot,
1086                                   const TargetRegisterClass *RC,
1087                                   bool isAvailable, MachineInstr *&LastStore,
1088                                   AvailableSpills &Spills,
1089                                   SmallSet<MachineInstr*, 4> &ReMatDefs,
1090                                   BitVector &RegKills,
1091                                   std::vector<MachineOperand*> &KillOps,
1092                                   VirtRegMap &VRM) {
1093   TII->storeRegToStackSlot(MBB, next(MII), PhysReg, true, StackSlot, RC);
1094   MachineInstr *StoreMI = next(MII);
1095   VRM.addSpillSlotUse(StackSlot, StoreMI);
1096   DOUT << "Store:\t" << *StoreMI;
1097
1098   // If there is a dead store to this stack slot, nuke it now.
1099   if (LastStore) {
1100     DOUT << "Removed dead store:\t" << *LastStore;
1101     ++NumDSE;
1102     SmallVector<unsigned, 2> KillRegs;
1103     InvalidateKills(*LastStore, RegKills, KillOps, &KillRegs);
1104     MachineBasicBlock::iterator PrevMII = LastStore;
1105     bool CheckDef = PrevMII != MBB.begin();
1106     if (CheckDef)
1107       --PrevMII;
1108     VRM.RemoveMachineInstrFromMaps(LastStore);
1109     MBB.erase(LastStore);
1110     if (CheckDef) {
1111       // Look at defs of killed registers on the store. Mark the defs
1112       // as dead since the store has been deleted and they aren't
1113       // being reused.
1114       for (unsigned j = 0, ee = KillRegs.size(); j != ee; ++j) {
1115         bool HasOtherDef = false;
1116         if (InvalidateRegDef(PrevMII, *MII, KillRegs[j], HasOtherDef)) {
1117           MachineInstr *DeadDef = PrevMII;
1118           if (ReMatDefs.count(DeadDef) && !HasOtherDef) {
1119             // FIXME: This assumes a remat def does not have side
1120             // effects.
1121             VRM.RemoveMachineInstrFromMaps(DeadDef);
1122             MBB.erase(DeadDef);
1123             ++NumDRM;
1124           }
1125         }
1126       }
1127     }
1128   }
1129
1130   LastStore = next(MII);
1131
1132   // If the stack slot value was previously available in some other
1133   // register, change it now.  Otherwise, make the register available,
1134   // in PhysReg.
1135   Spills.ModifyStackSlotOrReMat(StackSlot);
1136   Spills.ClobberPhysReg(PhysReg);
1137   Spills.addAvailable(StackSlot, LastStore, PhysReg, isAvailable);
1138   ++NumStores;
1139 }
1140
1141 /// TransferDeadness - A identity copy definition is dead and it's being
1142 /// removed. Find the last def or use and mark it as dead / kill.
1143 void LocalSpiller::TransferDeadness(MachineBasicBlock *MBB, unsigned CurDist,
1144                                     unsigned Reg, BitVector &RegKills,
1145                                     std::vector<MachineOperand*> &KillOps) {
1146   int LastUDDist = -1;
1147   MachineInstr *LastUDMI = NULL;
1148   for (MachineRegisterInfo::reg_iterator RI = RegInfo->reg_begin(Reg),
1149          RE = RegInfo->reg_end(); RI != RE; ++RI) {
1150     MachineInstr *UDMI = &*RI;
1151     if (UDMI->getParent() != MBB)
1152       continue;
1153     DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(UDMI);
1154     if (DI == DistanceMap.end() || DI->second > CurDist)
1155       continue;
1156     if ((int)DI->second < LastUDDist)
1157       continue;
1158     LastUDDist = DI->second;
1159     LastUDMI = UDMI;
1160   }
1161
1162   if (LastUDMI) {
1163     const TargetInstrDesc &TID = LastUDMI->getDesc();
1164     MachineOperand *LastUD = NULL;
1165     for (unsigned i = 0, e = LastUDMI->getNumOperands(); i != e; ++i) {
1166       MachineOperand &MO = LastUDMI->getOperand(i);
1167       if (!MO.isRegister() || MO.getReg() != Reg)
1168         continue;
1169       if (!LastUD || (LastUD->isUse() && MO.isDef()))
1170         LastUD = &MO;
1171       if (TID.getOperandConstraint(i, TOI::TIED_TO) != -1)
1172         return;
1173     }
1174     if (LastUD->isDef())
1175       LastUD->setIsDead();
1176     else {
1177       LastUD->setIsKill();
1178       RegKills.set(Reg);
1179       KillOps[Reg] = LastUD;
1180     }
1181   }
1182 }
1183
1184 /// rewriteMBB - Keep track of which spills are available even after the
1185 /// register allocator is done with them.  If possible, avid reloading vregs.
1186 void LocalSpiller::RewriteMBB(MachineBasicBlock &MBB, VirtRegMap &VRM) {
1187   DOUT << MBB.getBasicBlock()->getName() << ":\n";
1188
1189   MachineFunction &MF = *MBB.getParent();
1190   
1191   // Spills - Keep track of which spilled values are available in physregs so
1192   // that we can choose to reuse the physregs instead of emitting reloads.
1193   AvailableSpills Spills(TRI, TII);
1194   
1195   // MaybeDeadStores - When we need to write a value back into a stack slot,
1196   // keep track of the inserted store.  If the stack slot value is never read
1197   // (because the value was used from some available register, for example), and
1198   // subsequently stored to, the original store is dead.  This map keeps track
1199   // of inserted stores that are not used.  If we see a subsequent store to the
1200   // same stack slot, the original store is deleted.
1201   std::vector<MachineInstr*> MaybeDeadStores;
1202   MaybeDeadStores.resize(MF.getFrameInfo()->getObjectIndexEnd(), NULL);
1203
1204   // ReMatDefs - These are rematerializable def MIs which are not deleted.
1205   SmallSet<MachineInstr*, 4> ReMatDefs;
1206
1207   // Keep track of kill information.
1208   BitVector RegKills(TRI->getNumRegs());
1209   std::vector<MachineOperand*>  KillOps;
1210   KillOps.resize(TRI->getNumRegs(), NULL);
1211
1212   unsigned Dist = 0;
1213   DistanceMap.clear();
1214   for (MachineBasicBlock::iterator MII = MBB.begin(), E = MBB.end();
1215        MII != E; ) {
1216     MachineBasicBlock::iterator NextMII = MII; ++NextMII;
1217
1218     VirtRegMap::MI2VirtMapTy::const_iterator I, End;
1219     bool Erased = false;
1220     bool BackTracked = false;
1221     if (PrepForUnfoldOpti(MBB, MII,
1222                           MaybeDeadStores, Spills, RegKills, KillOps, VRM))
1223       NextMII = next(MII);
1224
1225     MachineInstr &MI = *MII;
1226     const TargetInstrDesc &TID = MI.getDesc();
1227
1228     if (VRM.hasEmergencySpills(&MI)) {
1229       // Spill physical register(s) in the rare case the allocator has run out
1230       // of registers to allocate.
1231       SmallSet<int, 4> UsedSS;
1232       std::vector<unsigned> &EmSpills = VRM.getEmergencySpills(&MI);
1233       for (unsigned i = 0, e = EmSpills.size(); i != e; ++i) {
1234         unsigned PhysReg = EmSpills[i];
1235         const TargetRegisterClass *RC =
1236           TRI->getPhysicalRegisterRegClass(PhysReg);
1237         assert(RC && "Unable to determine register class!");
1238         int SS = VRM.getEmergencySpillSlot(RC);
1239         if (UsedSS.count(SS))
1240           assert(0 && "Need to spill more than one physical registers!");
1241         UsedSS.insert(SS);
1242         TII->storeRegToStackSlot(MBB, MII, PhysReg, true, SS, RC);
1243         MachineInstr *StoreMI = prior(MII);
1244         VRM.addSpillSlotUse(SS, StoreMI);
1245         TII->loadRegFromStackSlot(MBB, next(MII), PhysReg, SS, RC);
1246         MachineInstr *LoadMI = next(MII);
1247         VRM.addSpillSlotUse(SS, LoadMI);
1248         ++NumPSpills;
1249       }
1250       NextMII = next(MII);
1251     }
1252
1253     // Insert restores here if asked to.
1254     if (VRM.isRestorePt(&MI)) {
1255       std::vector<unsigned> &RestoreRegs = VRM.getRestorePtRestores(&MI);
1256       for (unsigned i = 0, e = RestoreRegs.size(); i != e; ++i) {
1257         unsigned VirtReg = RestoreRegs[e-i-1];  // Reverse order.
1258         if (!VRM.getPreSplitReg(VirtReg))
1259           continue; // Split interval spilled again.
1260         unsigned Phys = VRM.getPhys(VirtReg);
1261         RegInfo->setPhysRegUsed(Phys);
1262         if (VRM.isReMaterialized(VirtReg)) {
1263           ReMaterialize(MBB, MII, Phys, VirtReg, TII, TRI, VRM);
1264         } else {
1265           const TargetRegisterClass* RC = RegInfo->getRegClass(VirtReg);
1266           int SS = VRM.getStackSlot(VirtReg);
1267           TII->loadRegFromStackSlot(MBB, &MI, Phys, SS, RC);
1268           MachineInstr *LoadMI = prior(MII);
1269           VRM.addSpillSlotUse(SS, LoadMI);
1270           ++NumLoads;
1271         }
1272         // This invalidates Phys.
1273         Spills.ClobberPhysReg(Phys);
1274         UpdateKills(*prior(MII), RegKills, KillOps);
1275         DOUT << '\t' << *prior(MII);
1276       }
1277     }
1278
1279     // Insert spills here if asked to.
1280     if (VRM.isSpillPt(&MI)) {
1281       std::vector<std::pair<unsigned,bool> > &SpillRegs =
1282         VRM.getSpillPtSpills(&MI);
1283       for (unsigned i = 0, e = SpillRegs.size(); i != e; ++i) {
1284         unsigned VirtReg = SpillRegs[i].first;
1285         bool isKill = SpillRegs[i].second;
1286         if (!VRM.getPreSplitReg(VirtReg))
1287           continue; // Split interval spilled again.
1288         const TargetRegisterClass *RC = RegInfo->getRegClass(VirtReg);
1289         unsigned Phys = VRM.getPhys(VirtReg);
1290         int StackSlot = VRM.getStackSlot(VirtReg);
1291         TII->storeRegToStackSlot(MBB, next(MII), Phys, isKill, StackSlot, RC);
1292         MachineInstr *StoreMI = next(MII);
1293         VRM.addSpillSlotUse(StackSlot, StoreMI);
1294         DOUT << "Store:\t" << *StoreMI;
1295         VRM.virtFolded(VirtReg, StoreMI, VirtRegMap::isMod);
1296       }
1297       NextMII = next(MII);
1298     }
1299
1300     /// ReusedOperands - Keep track of operand reuse in case we need to undo
1301     /// reuse.
1302     ReuseInfo ReusedOperands(MI, TRI);
1303     SmallVector<unsigned, 4> VirtUseOps;
1304     for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
1305       MachineOperand &MO = MI.getOperand(i);
1306       if (!MO.isRegister() || MO.getReg() == 0)
1307         continue;   // Ignore non-register operands.
1308       
1309       unsigned VirtReg = MO.getReg();
1310       if (TargetRegisterInfo::isPhysicalRegister(VirtReg)) {
1311         // Ignore physregs for spilling, but remember that it is used by this
1312         // function.
1313         RegInfo->setPhysRegUsed(VirtReg);
1314         continue;
1315       }
1316
1317       // We want to process implicit virtual register uses first.
1318       if (MO.isImplicit())
1319         // If the virtual register is implicitly defined, emit a implicit_def
1320         // before so scavenger knows it's "defined".
1321         VirtUseOps.insert(VirtUseOps.begin(), i);
1322       else
1323         VirtUseOps.push_back(i);
1324     }
1325
1326     // Process all of the spilled uses and all non spilled reg references.
1327     for (unsigned j = 0, e = VirtUseOps.size(); j != e; ++j) {
1328       unsigned i = VirtUseOps[j];
1329       MachineOperand &MO = MI.getOperand(i);
1330       unsigned VirtReg = MO.getReg();
1331       assert(TargetRegisterInfo::isVirtualRegister(VirtReg) &&
1332              "Not a virtual register?");
1333
1334       unsigned SubIdx = MO.getSubReg();
1335       if (VRM.isAssignedReg(VirtReg)) {
1336         // This virtual register was assigned a physreg!
1337         unsigned Phys = VRM.getPhys(VirtReg);
1338         RegInfo->setPhysRegUsed(Phys);
1339         if (MO.isDef())
1340           ReusedOperands.markClobbered(Phys);
1341         unsigned RReg = SubIdx ? TRI->getSubReg(Phys, SubIdx) : Phys;
1342         MI.getOperand(i).setReg(RReg);
1343         if (VRM.isImplicitlyDefined(VirtReg))
1344           BuildMI(MBB, MI, TII->get(TargetInstrInfo::IMPLICIT_DEF), RReg);
1345         continue;
1346       }
1347       
1348       // This virtual register is now known to be a spilled value.
1349       if (!MO.isUse())
1350         continue;  // Handle defs in the loop below (handle use&def here though)
1351
1352       bool DoReMat = VRM.isReMaterialized(VirtReg);
1353       int SSorRMId = DoReMat
1354         ? VRM.getReMatId(VirtReg) : VRM.getStackSlot(VirtReg);
1355       int ReuseSlot = SSorRMId;
1356
1357       // Check to see if this stack slot is available.
1358       unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(SSorRMId);
1359
1360       // If this is a sub-register use, make sure the reuse register is in the
1361       // right register class. For example, for x86 not all of the 32-bit
1362       // registers have accessible sub-registers.
1363       // Similarly so for EXTRACT_SUBREG. Consider this:
1364       // EDI = op
1365       // MOV32_mr fi#1, EDI
1366       // ...
1367       //       = EXTRACT_SUBREG fi#1
1368       // fi#1 is available in EDI, but it cannot be reused because it's not in
1369       // the right register file.
1370       if (PhysReg &&
1371           (SubIdx || MI.getOpcode() == TargetInstrInfo::EXTRACT_SUBREG)) {
1372         const TargetRegisterClass* RC = RegInfo->getRegClass(VirtReg);
1373         if (!RC->contains(PhysReg))
1374           PhysReg = 0;
1375       }
1376
1377       if (PhysReg) {
1378         // This spilled operand might be part of a two-address operand.  If this
1379         // is the case, then changing it will necessarily require changing the 
1380         // def part of the instruction as well.  However, in some cases, we
1381         // aren't allowed to modify the reused register.  If none of these cases
1382         // apply, reuse it.
1383         bool CanReuse = true;
1384         int ti = TID.getOperandConstraint(i, TOI::TIED_TO);
1385         if (ti != -1 &&
1386             MI.getOperand(ti).isRegister() && 
1387             MI.getOperand(ti).getReg() == VirtReg) {
1388           // Okay, we have a two address operand.  We can reuse this physreg as
1389           // long as we are allowed to clobber the value and there isn't an
1390           // earlier def that has already clobbered the physreg.
1391           CanReuse = Spills.canClobberPhysReg(ReuseSlot) &&
1392             !ReusedOperands.isClobbered(PhysReg);
1393         }
1394         
1395         if (CanReuse) {
1396           // If this stack slot value is already available, reuse it!
1397           if (ReuseSlot > VirtRegMap::MAX_STACK_SLOT)
1398             DOUT << "Reusing RM#" << ReuseSlot-VirtRegMap::MAX_STACK_SLOT-1;
1399           else
1400             DOUT << "Reusing SS#" << ReuseSlot;
1401           DOUT << " from physreg "
1402                << TRI->getName(PhysReg) << " for vreg"
1403                << VirtReg <<" instead of reloading into physreg "
1404                << TRI->getName(VRM.getPhys(VirtReg)) << "\n";
1405           unsigned RReg = SubIdx ? TRI->getSubReg(PhysReg, SubIdx) : PhysReg;
1406           MI.getOperand(i).setReg(RReg);
1407
1408           // The only technical detail we have is that we don't know that
1409           // PhysReg won't be clobbered by a reloaded stack slot that occurs
1410           // later in the instruction.  In particular, consider 'op V1, V2'.
1411           // If V1 is available in physreg R0, we would choose to reuse it
1412           // here, instead of reloading it into the register the allocator
1413           // indicated (say R1).  However, V2 might have to be reloaded
1414           // later, and it might indicate that it needs to live in R0.  When
1415           // this occurs, we need to have information available that
1416           // indicates it is safe to use R1 for the reload instead of R0.
1417           //
1418           // To further complicate matters, we might conflict with an alias,
1419           // or R0 and R1 might not be compatible with each other.  In this
1420           // case, we actually insert a reload for V1 in R1, ensuring that
1421           // we can get at R0 or its alias.
1422           ReusedOperands.addReuse(i, ReuseSlot, PhysReg,
1423                                   VRM.getPhys(VirtReg), VirtReg);
1424           if (ti != -1)
1425             // Only mark it clobbered if this is a use&def operand.
1426             ReusedOperands.markClobbered(PhysReg);
1427           ++NumReused;
1428
1429           if (MI.getOperand(i).isKill() &&
1430               ReuseSlot <= VirtRegMap::MAX_STACK_SLOT) {
1431             // This was the last use and the spilled value is still available
1432             // for reuse. That means the spill was unnecessary!
1433             MachineInstr* DeadStore = MaybeDeadStores[ReuseSlot];
1434             if (DeadStore) {
1435               DOUT << "Removed dead store:\t" << *DeadStore;
1436               InvalidateKills(*DeadStore, RegKills, KillOps);
1437               VRM.RemoveMachineInstrFromMaps(DeadStore);
1438               MBB.erase(DeadStore);
1439               MaybeDeadStores[ReuseSlot] = NULL;
1440               ++NumDSE;
1441             }
1442           }
1443           continue;
1444         }  // CanReuse
1445         
1446         // Otherwise we have a situation where we have a two-address instruction
1447         // whose mod/ref operand needs to be reloaded.  This reload is already
1448         // available in some register "PhysReg", but if we used PhysReg as the
1449         // operand to our 2-addr instruction, the instruction would modify
1450         // PhysReg.  This isn't cool if something later uses PhysReg and expects
1451         // to get its initial value.
1452         //
1453         // To avoid this problem, and to avoid doing a load right after a store,
1454         // we emit a copy from PhysReg into the designated register for this
1455         // operand.
1456         unsigned DesignatedReg = VRM.getPhys(VirtReg);
1457         assert(DesignatedReg && "Must map virtreg to physreg!");
1458
1459         // Note that, if we reused a register for a previous operand, the
1460         // register we want to reload into might not actually be
1461         // available.  If this occurs, use the register indicated by the
1462         // reuser.
1463         if (ReusedOperands.hasReuses())
1464           DesignatedReg = ReusedOperands.GetRegForReload(DesignatedReg, &MI, 
1465                                Spills, MaybeDeadStores, RegKills, KillOps, VRM);
1466         
1467         // If the mapped designated register is actually the physreg we have
1468         // incoming, we don't need to inserted a dead copy.
1469         if (DesignatedReg == PhysReg) {
1470           // If this stack slot value is already available, reuse it!
1471           if (ReuseSlot > VirtRegMap::MAX_STACK_SLOT)
1472             DOUT << "Reusing RM#" << ReuseSlot-VirtRegMap::MAX_STACK_SLOT-1;
1473           else
1474             DOUT << "Reusing SS#" << ReuseSlot;
1475           DOUT << " from physreg " << TRI->getName(PhysReg)
1476                << " for vreg" << VirtReg
1477                << " instead of reloading into same physreg.\n";
1478           unsigned RReg = SubIdx ? TRI->getSubReg(PhysReg, SubIdx) : PhysReg;
1479           MI.getOperand(i).setReg(RReg);
1480           ReusedOperands.markClobbered(RReg);
1481           ++NumReused;
1482           continue;
1483         }
1484         
1485         const TargetRegisterClass* RC = RegInfo->getRegClass(VirtReg);
1486         RegInfo->setPhysRegUsed(DesignatedReg);
1487         ReusedOperands.markClobbered(DesignatedReg);
1488         TII->copyRegToReg(MBB, &MI, DesignatedReg, PhysReg, RC, RC);
1489
1490         MachineInstr *CopyMI = prior(MII);
1491         UpdateKills(*CopyMI, RegKills, KillOps);
1492
1493         // This invalidates DesignatedReg.
1494         Spills.ClobberPhysReg(DesignatedReg);
1495         
1496         Spills.addAvailable(ReuseSlot, &MI, DesignatedReg);
1497         unsigned RReg =
1498           SubIdx ? TRI->getSubReg(DesignatedReg, SubIdx) : DesignatedReg;
1499         MI.getOperand(i).setReg(RReg);
1500         DOUT << '\t' << *prior(MII);
1501         ++NumReused;
1502         continue;
1503       } // if (PhysReg)
1504       
1505       // Otherwise, reload it and remember that we have it.
1506       PhysReg = VRM.getPhys(VirtReg);
1507       assert(PhysReg && "Must map virtreg to physreg!");
1508
1509       // Note that, if we reused a register for a previous operand, the
1510       // register we want to reload into might not actually be
1511       // available.  If this occurs, use the register indicated by the
1512       // reuser.
1513       if (ReusedOperands.hasReuses())
1514         PhysReg = ReusedOperands.GetRegForReload(PhysReg, &MI, 
1515                                Spills, MaybeDeadStores, RegKills, KillOps, VRM);
1516       
1517       RegInfo->setPhysRegUsed(PhysReg);
1518       ReusedOperands.markClobbered(PhysReg);
1519       if (DoReMat) {
1520         ReMaterialize(MBB, MII, PhysReg, VirtReg, TII, TRI, VRM);
1521       } else {
1522         const TargetRegisterClass* RC = RegInfo->getRegClass(VirtReg);
1523         TII->loadRegFromStackSlot(MBB, &MI, PhysReg, SSorRMId, RC);
1524         MachineInstr *LoadMI = prior(MII);
1525         VRM.addSpillSlotUse(SSorRMId, LoadMI);
1526         ++NumLoads;
1527       }
1528       // This invalidates PhysReg.
1529       Spills.ClobberPhysReg(PhysReg);
1530
1531       // Any stores to this stack slot are not dead anymore.
1532       if (!DoReMat)
1533         MaybeDeadStores[SSorRMId] = NULL;
1534       Spills.addAvailable(SSorRMId, &MI, PhysReg);
1535       // Assumes this is the last use. IsKill will be unset if reg is reused
1536       // unless it's a two-address operand.
1537       if (TID.getOperandConstraint(i, TOI::TIED_TO) == -1)
1538         MI.getOperand(i).setIsKill();
1539       unsigned RReg = SubIdx ? TRI->getSubReg(PhysReg, SubIdx) : PhysReg;
1540       MI.getOperand(i).setReg(RReg);
1541       UpdateKills(*prior(MII), RegKills, KillOps);
1542       DOUT << '\t' << *prior(MII);
1543     }
1544
1545     DOUT << '\t' << MI;
1546
1547
1548     // If we have folded references to memory operands, make sure we clear all
1549     // physical registers that may contain the value of the spilled virtual
1550     // register
1551     SmallSet<int, 2> FoldedSS;
1552     for (tie(I, End) = VRM.getFoldedVirts(&MI); I != End; ) {
1553       unsigned VirtReg = I->second.first;
1554       VirtRegMap::ModRef MR = I->second.second;
1555       DOUT << "Folded vreg: " << VirtReg << "  MR: " << MR;
1556
1557       // MI2VirtMap be can updated which invalidate the iterator.
1558       // Increment the iterator first.
1559       ++I;
1560       int SS = VRM.getStackSlot(VirtReg);
1561       if (SS == VirtRegMap::NO_STACK_SLOT)
1562         continue;
1563       FoldedSS.insert(SS);
1564       DOUT << " - StackSlot: " << SS << "\n";
1565       
1566       // If this folded instruction is just a use, check to see if it's a
1567       // straight load from the virt reg slot.
1568       if ((MR & VirtRegMap::isRef) && !(MR & VirtRegMap::isMod)) {
1569         int FrameIdx;
1570         unsigned DestReg = TII->isLoadFromStackSlot(&MI, FrameIdx);
1571         if (DestReg && FrameIdx == SS) {
1572           // If this spill slot is available, turn it into a copy (or nothing)
1573           // instead of leaving it as a load!
1574           if (unsigned InReg = Spills.getSpillSlotOrReMatPhysReg(SS)) {
1575             DOUT << "Promoted Load To Copy: " << MI;
1576             if (DestReg != InReg) {
1577               const TargetRegisterClass *RC = RegInfo->getRegClass(VirtReg);
1578               TII->copyRegToReg(MBB, &MI, DestReg, InReg, RC, RC);
1579               // Revisit the copy so we make sure to notice the effects of the
1580               // operation on the destreg (either needing to RA it if it's 
1581               // virtual or needing to clobber any values if it's physical).
1582               NextMII = &MI;
1583               --NextMII;  // backtrack to the copy.
1584               BackTracked = true;
1585             } else {
1586               DOUT << "Removing now-noop copy: " << MI;
1587               // Unset last kill since it's being reused.
1588               InvalidateKill(InReg, RegKills, KillOps);
1589             }
1590
1591             InvalidateKills(MI, RegKills, KillOps);
1592             VRM.RemoveMachineInstrFromMaps(&MI);
1593             MBB.erase(&MI);
1594             Erased = true;
1595             goto ProcessNextInst;
1596           }
1597         } else {
1598           unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(SS);
1599           SmallVector<MachineInstr*, 4> NewMIs;
1600           if (PhysReg &&
1601               TII->unfoldMemoryOperand(MF, &MI, PhysReg, false, false, NewMIs)) {
1602             MBB.insert(MII, NewMIs[0]);
1603             InvalidateKills(MI, RegKills, KillOps);
1604             VRM.RemoveMachineInstrFromMaps(&MI);
1605             MBB.erase(&MI);
1606             Erased = true;
1607             --NextMII;  // backtrack to the unfolded instruction.
1608             BackTracked = true;
1609             goto ProcessNextInst;
1610           }
1611         }
1612       }
1613
1614       // If this reference is not a use, any previous store is now dead.
1615       // Otherwise, the store to this stack slot is not dead anymore.
1616       MachineInstr* DeadStore = MaybeDeadStores[SS];
1617       if (DeadStore) {
1618         bool isDead = !(MR & VirtRegMap::isRef);
1619         MachineInstr *NewStore = NULL;
1620         if (MR & VirtRegMap::isModRef) {
1621           unsigned PhysReg = Spills.getSpillSlotOrReMatPhysReg(SS);
1622           SmallVector<MachineInstr*, 4> NewMIs;
1623           // We can reuse this physreg as long as we are allowed to clobber
1624           // the value and there isn't an earlier def that has already clobbered
1625           // the physreg.
1626           if (PhysReg &&
1627               !TII->isStoreToStackSlot(&MI, SS)) { // Not profitable!
1628             MachineOperand *KillOpnd =
1629               DeadStore->findRegisterUseOperand(PhysReg, true);
1630             // Note, if the store is storing a sub-register, it's possible the
1631             // super-register is needed below.
1632             if (KillOpnd && !KillOpnd->getSubReg() &&
1633                 TII->unfoldMemoryOperand(MF, &MI, PhysReg, false, true,NewMIs)){
1634               MBB.insert(MII, NewMIs[0]);
1635               NewStore = NewMIs[1];
1636               MBB.insert(MII, NewStore);
1637               VRM.addSpillSlotUse(SS, NewStore);
1638               InvalidateKills(MI, RegKills, KillOps);
1639               VRM.RemoveMachineInstrFromMaps(&MI);
1640               MBB.erase(&MI);
1641               Erased = true;
1642               --NextMII;
1643               --NextMII;  // backtrack to the unfolded instruction.
1644               BackTracked = true;
1645               isDead = true;
1646             }
1647           }
1648         }
1649
1650         if (isDead) {  // Previous store is dead.
1651           // If we get here, the store is dead, nuke it now.
1652           DOUT << "Removed dead store:\t" << *DeadStore;
1653           InvalidateKills(*DeadStore, RegKills, KillOps);
1654           VRM.RemoveMachineInstrFromMaps(DeadStore);
1655           MBB.erase(DeadStore);
1656           if (!NewStore)
1657             ++NumDSE;
1658         }
1659
1660         MaybeDeadStores[SS] = NULL;
1661         if (NewStore) {
1662           // Treat this store as a spill merged into a copy. That makes the
1663           // stack slot value available.
1664           VRM.virtFolded(VirtReg, NewStore, VirtRegMap::isMod);
1665           goto ProcessNextInst;
1666         }
1667       }
1668
1669       // If the spill slot value is available, and this is a new definition of
1670       // the value, the value is not available anymore.
1671       if (MR & VirtRegMap::isMod) {
1672         // Notice that the value in this stack slot has been modified.
1673         Spills.ModifyStackSlotOrReMat(SS);
1674         
1675         // If this is *just* a mod of the value, check to see if this is just a
1676         // store to the spill slot (i.e. the spill got merged into the copy). If
1677         // so, realize that the vreg is available now, and add the store to the
1678         // MaybeDeadStore info.
1679         int StackSlot;
1680         if (!(MR & VirtRegMap::isRef)) {
1681           if (unsigned SrcReg = TII->isStoreToStackSlot(&MI, StackSlot)) {
1682             assert(TargetRegisterInfo::isPhysicalRegister(SrcReg) &&
1683                    "Src hasn't been allocated yet?");
1684
1685             if (CommuteToFoldReload(MBB, MII, VirtReg, SrcReg, StackSlot,
1686                                     RegKills, KillOps, TRI, VRM)) {
1687               NextMII = next(MII);
1688               BackTracked = true;
1689               goto ProcessNextInst;
1690             }
1691
1692             // Okay, this is certainly a store of SrcReg to [StackSlot].  Mark
1693             // this as a potentially dead store in case there is a subsequent
1694             // store into the stack slot without a read from it.
1695             MaybeDeadStores[StackSlot] = &MI;
1696
1697             // If the stack slot value was previously available in some other
1698             // register, change it now.  Otherwise, make the register
1699             // available in PhysReg.
1700             Spills.addAvailable(StackSlot, &MI, SrcReg, false/*!clobber*/);
1701           }
1702         }
1703       }
1704     }
1705
1706     // Process all of the spilled defs.
1707     for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
1708       MachineOperand &MO = MI.getOperand(i);
1709       if (!(MO.isRegister() && MO.getReg() && MO.isDef()))
1710         continue;
1711
1712       unsigned VirtReg = MO.getReg();
1713       if (!TargetRegisterInfo::isVirtualRegister(VirtReg)) {
1714         // Check to see if this is a noop copy.  If so, eliminate the
1715         // instruction before considering the dest reg to be changed.
1716         unsigned Src, Dst;
1717         if (TII->isMoveInstr(MI, Src, Dst) && Src == Dst) {
1718           ++NumDCE;
1719           DOUT << "Removing now-noop copy: " << MI;
1720           SmallVector<unsigned, 2> KillRegs;
1721           InvalidateKills(MI, RegKills, KillOps, &KillRegs);
1722           if (MO.isDead() && !KillRegs.empty()) {
1723             assert(KillRegs[0] == Dst);
1724             // Last def is now dead.
1725             TransferDeadness(&MBB, Dist, Src, RegKills, KillOps);
1726           }
1727           VRM.RemoveMachineInstrFromMaps(&MI);
1728           MBB.erase(&MI);
1729           Erased = true;
1730           Spills.disallowClobberPhysReg(VirtReg);
1731           goto ProcessNextInst;
1732         }
1733           
1734         // If it's not a no-op copy, it clobbers the value in the destreg.
1735         Spills.ClobberPhysReg(VirtReg);
1736         ReusedOperands.markClobbered(VirtReg);
1737  
1738         // Check to see if this instruction is a load from a stack slot into
1739         // a register.  If so, this provides the stack slot value in the reg.
1740         int FrameIdx;
1741         if (unsigned DestReg = TII->isLoadFromStackSlot(&MI, FrameIdx)) {
1742           assert(DestReg == VirtReg && "Unknown load situation!");
1743
1744           // If it is a folded reference, then it's not safe to clobber.
1745           bool Folded = FoldedSS.count(FrameIdx);
1746           // Otherwise, if it wasn't available, remember that it is now!
1747           Spills.addAvailable(FrameIdx, &MI, DestReg, !Folded);
1748           goto ProcessNextInst;
1749         }
1750             
1751         continue;
1752       }
1753
1754       unsigned SubIdx = MO.getSubReg();
1755       bool DoReMat = VRM.isReMaterialized(VirtReg);
1756       if (DoReMat)
1757         ReMatDefs.insert(&MI);
1758
1759       // The only vregs left are stack slot definitions.
1760       int StackSlot = VRM.getStackSlot(VirtReg);
1761       const TargetRegisterClass *RC = RegInfo->getRegClass(VirtReg);
1762
1763       // If this def is part of a two-address operand, make sure to execute
1764       // the store from the correct physical register.
1765       unsigned PhysReg;
1766       int TiedOp = MI.getDesc().findTiedToSrcOperand(i);
1767       if (TiedOp != -1) {
1768         PhysReg = MI.getOperand(TiedOp).getReg();
1769         if (SubIdx) {
1770           unsigned SuperReg = findSuperReg(RC, PhysReg, SubIdx, TRI);
1771           assert(SuperReg && TRI->getSubReg(SuperReg, SubIdx) == PhysReg &&
1772                  "Can't find corresponding super-register!");
1773           PhysReg = SuperReg;
1774         }
1775       } else {
1776         PhysReg = VRM.getPhys(VirtReg);
1777         if (ReusedOperands.isClobbered(PhysReg)) {
1778           // Another def has taken the assigned physreg. It must have been a
1779           // use&def which got it due to reuse. Undo the reuse!
1780           PhysReg = ReusedOperands.GetRegForReload(PhysReg, &MI, 
1781                                Spills, MaybeDeadStores, RegKills, KillOps, VRM);
1782         }
1783       }
1784
1785       assert(PhysReg && "VR not assigned a physical register?");
1786       RegInfo->setPhysRegUsed(PhysReg);
1787       unsigned RReg = SubIdx ? TRI->getSubReg(PhysReg, SubIdx) : PhysReg;
1788       ReusedOperands.markClobbered(RReg);
1789       MI.getOperand(i).setReg(RReg);
1790
1791       if (!MO.isDead()) {
1792         MachineInstr *&LastStore = MaybeDeadStores[StackSlot];
1793         SpillRegToStackSlot(MBB, MII, -1, PhysReg, StackSlot, RC, true,
1794                           LastStore, Spills, ReMatDefs, RegKills, KillOps, VRM);
1795         NextMII = next(MII);
1796
1797         // Check to see if this is a noop copy.  If so, eliminate the
1798         // instruction before considering the dest reg to be changed.
1799         {
1800           unsigned Src, Dst;
1801           if (TII->isMoveInstr(MI, Src, Dst) && Src == Dst) {
1802             ++NumDCE;
1803             DOUT << "Removing now-noop copy: " << MI;
1804             InvalidateKills(MI, RegKills, KillOps);
1805             VRM.RemoveMachineInstrFromMaps(&MI);
1806             MBB.erase(&MI);
1807             Erased = true;
1808             UpdateKills(*LastStore, RegKills, KillOps);
1809             goto ProcessNextInst;
1810           }
1811         }
1812       }    
1813     }
1814   ProcessNextInst:
1815     DistanceMap.insert(std::make_pair(&MI, Dist++));
1816     if (!Erased && !BackTracked) {
1817       for (MachineBasicBlock::iterator II = MI; II != NextMII; ++II)
1818         UpdateKills(*II, RegKills, KillOps);
1819     }
1820     MII = NextMII;
1821   }
1822 }
1823
1824 llvm::Spiller* llvm::createSpiller() {
1825   switch (SpillerOpt) {
1826   default: assert(0 && "Unreachable!");
1827   case local:
1828     return new LocalSpiller();
1829   case simple:
1830     return new SimpleSpiller();
1831   }
1832 }