1 //===-- llvm/CodeGen/VirtRegMap.cpp - Virtual Register Map ----------------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This file implements the VirtRegMap class.
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
17 //===----------------------------------------------------------------------===//
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/ADT/Statistic.h"
30 #include "llvm/ADT/STLExtras.h"
35 Statistic<> NumSpills("spiller", "Number of register spills");
36 Statistic<> NumStores("spiller", "Number of stores added");
37 Statistic<> NumLoads ("spiller", "Number of loads added");
38 Statistic<> NumReused("spiller", "Number of values reused");
39 Statistic<> NumDSE ("spiller", "Number of dead stores elided");
41 enum SpillerName { simple, local };
45 cl::desc("Spiller to use: (default: local)"),
47 cl::values(clEnumVal(simple, " simple spiller"),
48 clEnumVal(local, " local spiller"),
53 //===----------------------------------------------------------------------===//
54 // VirtRegMap implementation
55 //===----------------------------------------------------------------------===//
57 void VirtRegMap::grow() {
58 Virt2PhysMap.grow(MF.getSSARegMap()->getLastVirtReg());
59 Virt2StackSlotMap.grow(MF.getSSARegMap()->getLastVirtReg());
62 int VirtRegMap::assignVirt2StackSlot(unsigned virtReg) {
63 assert(MRegisterInfo::isVirtualRegister(virtReg));
64 assert(Virt2StackSlotMap[virtReg] == NO_STACK_SLOT &&
65 "attempt to assign stack slot to already spilled register");
66 const TargetRegisterClass* RC = MF.getSSARegMap()->getRegClass(virtReg);
67 int frameIndex = MF.getFrameInfo()->CreateStackObject(RC->getSize(),
69 Virt2StackSlotMap[virtReg] = frameIndex;
74 void VirtRegMap::assignVirt2StackSlot(unsigned virtReg, int frameIndex) {
75 assert(MRegisterInfo::isVirtualRegister(virtReg));
76 assert(Virt2StackSlotMap[virtReg] == NO_STACK_SLOT &&
77 "attempt to assign stack slot to already spilled register");
78 Virt2StackSlotMap[virtReg] = frameIndex;
81 void VirtRegMap::virtFolded(unsigned VirtReg, MachineInstr *OldMI,
82 unsigned OpNo, MachineInstr *NewMI) {
83 // Move previous memory references folded to new instruction.
84 MI2VirtMapTy::iterator IP = MI2VirtMap.lower_bound(NewMI);
85 for (MI2VirtMapTy::iterator I = MI2VirtMap.lower_bound(OldMI),
86 E = MI2VirtMap.end(); I != E && I->first == OldMI; ) {
87 MI2VirtMap.insert(IP, std::make_pair(NewMI, I->second));
88 MI2VirtMap.erase(I++);
92 if (!OldMI->getOperand(OpNo).isDef()) {
93 assert(OldMI->getOperand(OpNo).isUse() && "Operand is not use or def?");
96 MRInfo = OldMI->getOperand(OpNo).isUse() ? isModRef : isMod;
99 // add new memory reference
100 MI2VirtMap.insert(IP, std::make_pair(NewMI, std::make_pair(VirtReg, MRInfo)));
103 void VirtRegMap::print(std::ostream &OS) const {
104 const MRegisterInfo* MRI = MF.getTarget().getRegisterInfo();
106 OS << "********** REGISTER MAP **********\n";
107 for (unsigned i = MRegisterInfo::FirstVirtualRegister,
108 e = MF.getSSARegMap()->getLastVirtReg(); i <= e; ++i) {
109 if (Virt2PhysMap[i] != (unsigned)VirtRegMap::NO_PHYS_REG)
110 OS << "[reg" << i << " -> " << MRI->getName(Virt2PhysMap[i]) << "]\n";
114 for (unsigned i = MRegisterInfo::FirstVirtualRegister,
115 e = MF.getSSARegMap()->getLastVirtReg(); i <= e; ++i)
116 if (Virt2StackSlotMap[i] != VirtRegMap::NO_STACK_SLOT)
117 OS << "[reg" << i << " -> fi#" << Virt2StackSlotMap[i] << "]\n";
121 void VirtRegMap::dump() const { print(std::cerr); }
124 //===----------------------------------------------------------------------===//
125 // Simple Spiller Implementation
126 //===----------------------------------------------------------------------===//
128 Spiller::~Spiller() {}
131 struct SimpleSpiller : public Spiller {
132 bool runOnMachineFunction(MachineFunction& mf, const VirtRegMap &VRM);
136 bool SimpleSpiller::runOnMachineFunction(MachineFunction &MF,
137 const VirtRegMap &VRM) {
138 DEBUG(std::cerr << "********** REWRITE MACHINE CODE **********\n");
139 DEBUG(std::cerr << "********** Function: "
140 << MF.getFunction()->getName() << '\n');
141 const TargetMachine &TM = MF.getTarget();
142 const MRegisterInfo &MRI = *TM.getRegisterInfo();
143 bool *PhysRegsUsed = MF.getUsedPhysregs();
145 // LoadedRegs - Keep track of which vregs are loaded, so that we only load
146 // each vreg once (in the case where a spilled vreg is used by multiple
147 // operands). This is always smaller than the number of operands to the
148 // current machine instr, so it should be small.
149 std::vector<unsigned> LoadedRegs;
151 for (MachineFunction::iterator MBBI = MF.begin(), E = MF.end();
153 DEBUG(std::cerr << MBBI->getBasicBlock()->getName() << ":\n");
154 MachineBasicBlock &MBB = *MBBI;
155 for (MachineBasicBlock::iterator MII = MBB.begin(),
156 E = MBB.end(); MII != E; ++MII) {
157 MachineInstr &MI = *MII;
158 for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
159 MachineOperand &MO = MI.getOperand(i);
160 if (MO.isRegister() && MO.getReg())
161 if (MRegisterInfo::isVirtualRegister(MO.getReg())) {
162 unsigned VirtReg = MO.getReg();
163 unsigned PhysReg = VRM.getPhys(VirtReg);
164 if (VRM.hasStackSlot(VirtReg)) {
165 int StackSlot = VRM.getStackSlot(VirtReg);
168 std::find(LoadedRegs.begin(), LoadedRegs.end(), VirtReg)
169 == LoadedRegs.end()) {
170 MRI.loadRegFromStackSlot(MBB, &MI, PhysReg, StackSlot);
171 LoadedRegs.push_back(VirtReg);
173 DEBUG(std::cerr << '\t' << *prior(MII));
177 MRI.storeRegToStackSlot(MBB, next(MII), PhysReg, StackSlot);
181 PhysRegsUsed[PhysReg] = true;
182 MI.SetMachineOperandReg(i, PhysReg);
184 PhysRegsUsed[MO.getReg()] = true;
188 DEBUG(std::cerr << '\t' << MI);
195 //===----------------------------------------------------------------------===//
196 // Local Spiller Implementation
197 //===----------------------------------------------------------------------===//
200 /// LocalSpiller - This spiller does a simple pass over the machine basic
201 /// block to attempt to keep spills in registers as much as possible for
202 /// blocks that have low register pressure (the vreg may be spilled due to
203 /// register pressure in other blocks).
204 class LocalSpiller : public Spiller {
205 const MRegisterInfo *MRI;
206 const TargetInstrInfo *TII;
208 bool runOnMachineFunction(MachineFunction &MF, const VirtRegMap &VRM) {
209 MRI = MF.getTarget().getRegisterInfo();
210 TII = MF.getTarget().getInstrInfo();
211 DEBUG(std::cerr << "\n**** Local spiller rewriting function '"
212 << MF.getFunction()->getName() << "':\n");
214 for (MachineFunction::iterator MBB = MF.begin(), E = MF.end();
216 RewriteMBB(*MBB, VRM);
220 void RewriteMBB(MachineBasicBlock &MBB, const VirtRegMap &VRM);
221 void ClobberPhysReg(unsigned PR, std::map<int, unsigned> &SpillSlots,
222 std::map<unsigned, int> &PhysRegs);
223 void ClobberPhysRegOnly(unsigned PR, std::map<int, unsigned> &SpillSlots,
224 std::map<unsigned, int> &PhysRegs);
228 void LocalSpiller::ClobberPhysRegOnly(unsigned PhysReg,
229 std::map<int, unsigned> &SpillSlots,
230 std::map<unsigned, int> &PhysRegs) {
231 std::map<unsigned, int>::iterator I = PhysRegs.find(PhysReg);
232 if (I != PhysRegs.end()) {
233 int Slot = I->second;
235 assert(SpillSlots[Slot] == PhysReg && "Bidirectional map mismatch!");
236 SpillSlots.erase(Slot);
237 DEBUG(std::cerr << "PhysReg " << MRI->getName(PhysReg)
238 << " clobbered, invalidating SS#" << Slot << "\n");
243 void LocalSpiller::ClobberPhysReg(unsigned PhysReg,
244 std::map<int, unsigned> &SpillSlots,
245 std::map<unsigned, int> &PhysRegs) {
246 for (const unsigned *AS = MRI->getAliasSet(PhysReg); *AS; ++AS)
247 ClobberPhysRegOnly(*AS, SpillSlots, PhysRegs);
248 ClobberPhysRegOnly(PhysReg, SpillSlots, PhysRegs);
252 // ReusedOp - For each reused operand, we keep track of a bit of information, in
253 // case we need to rollback upon processing a new operand. See comments below.
256 // The MachineInstr operand that reused an available value.
259 // StackSlot - The spill slot of the value being reused.
262 // PhysRegReused - The physical register the value was available in.
263 unsigned PhysRegReused;
265 // AssignedPhysReg - The physreg that was assigned for use by the reload.
266 unsigned AssignedPhysReg;
268 ReusedOp(unsigned o, unsigned ss, unsigned prr, unsigned apr)
269 : Operand(o), StackSlot(ss), PhysRegReused(prr), AssignedPhysReg(apr) {}
274 /// rewriteMBB - Keep track of which spills are available even after the
275 /// register allocator is done with them. If possible, avoid reloading vregs.
276 void LocalSpiller::RewriteMBB(MachineBasicBlock &MBB, const VirtRegMap &VRM) {
278 // SpillSlotsAvailable - This map keeps track of all of the spilled virtual
279 // register values that are still available, due to being loaded to stored to,
280 // but not invalidated yet.
281 std::map<int, unsigned> SpillSlotsAvailable;
283 // PhysRegsAvailable - This is the inverse of SpillSlotsAvailable, indicating
284 // which physregs are in use holding a stack slot value.
285 std::map<unsigned, int> PhysRegsAvailable;
287 DEBUG(std::cerr << MBB.getBasicBlock()->getName() << ":\n");
289 std::vector<ReusedOp> ReusedOperands;
291 // DefAndUseVReg - When we see a def&use operand that is spilled, keep track
292 // of it. ".first" is the machine operand index (should always be 0 for now),
293 // and ".second" is the virtual register that is spilled.
294 std::vector<std::pair<unsigned, unsigned> > DefAndUseVReg;
296 // MaybeDeadStores - When we need to write a value back into a stack slot,
297 // keep track of the inserted store. If the stack slot value is never read
298 // (because the value was used from some available register, for example), and
299 // subsequently stored to, the original store is dead. This map keeps track
300 // of inserted stores that are not used. If we see a subsequent store to the
301 // same stack slot, the original store is deleted.
302 std::map<int, MachineInstr*> MaybeDeadStores;
304 bool *PhysRegsUsed = MBB.getParent()->getUsedPhysregs();
306 for (MachineBasicBlock::iterator MII = MBB.begin(), E = MBB.end();
308 MachineInstr &MI = *MII;
309 MachineBasicBlock::iterator NextMII = MII; ++NextMII;
311 ReusedOperands.clear();
312 DefAndUseVReg.clear();
314 // Process all of the spilled uses and all non spilled reg references.
315 for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
316 MachineOperand &MO = MI.getOperand(i);
317 if (MO.isRegister() && MO.getReg() &&
318 MRegisterInfo::isPhysicalRegister(MO.getReg()))
319 PhysRegsUsed[MO.getReg()] = true;
320 else if (MO.isRegister() && MO.getReg() &&
321 MRegisterInfo::isVirtualRegister(MO.getReg())) {
322 unsigned VirtReg = MO.getReg();
324 if (!VRM.hasStackSlot(VirtReg)) {
325 // This virtual register was assigned a physreg!
326 unsigned Phys = VRM.getPhys(VirtReg);
327 PhysRegsUsed[Phys] = true;
328 MI.SetMachineOperandReg(i, Phys);
330 // Is this virtual register a spilled value?
332 int StackSlot = VRM.getStackSlot(VirtReg);
335 // Check to see if this stack slot is available.
336 std::map<int, unsigned>::iterator SSI =
337 SpillSlotsAvailable.find(StackSlot);
338 if (SSI != SpillSlotsAvailable.end()) {
339 DEBUG(std::cerr << "Reusing SS#" << StackSlot << " from physreg "
340 << MRI->getName(SSI->second) << " for vreg"
341 << VirtReg <<" instead of reloading into physreg "
342 << MRI->getName(VRM.getPhys(VirtReg)) << "\n");
343 // If this stack slot value is already available, reuse it!
344 PhysReg = SSI->second;
345 MI.SetMachineOperandReg(i, PhysReg);
347 // The only technical detail we have is that we don't know that
348 // PhysReg won't be clobbered by a reloaded stack slot that occurs
349 // later in the instruction. In particular, consider 'op V1, V2'.
350 // If V1 is available in physreg R0, we would choose to reuse it
351 // here, instead of reloading it into the register the allocator
352 // indicated (say R1). However, V2 might have to be reloaded
353 // later, and it might indicate that it needs to live in R0. When
354 // this occurs, we need to have information available that
355 // indicates it is safe to use R1 for the reload instead of R0.
357 // To further complicate matters, we might conflict with an alias,
358 // or R0 and R1 might not be compatible with each other. In this
359 // case, we actually insert a reload for V1 in R1, ensuring that
360 // we can get at R0 or its alias.
361 ReusedOperands.push_back(ReusedOp(i, StackSlot, PhysReg,
362 VRM.getPhys(VirtReg)));
365 // Otherwise, reload it and remember that we have it.
366 PhysReg = VRM.getPhys(VirtReg);
369 // Note that, if we reused a register for a previous operand, the
370 // register we want to reload into might not actually be
371 // available. If this occurs, use the register indicated by the
373 if (!ReusedOperands.empty()) // This is most often empty.
374 for (unsigned ro = 0, e = ReusedOperands.size(); ro != e; ++ro)
375 if (ReusedOperands[ro].PhysRegReused == PhysReg) {
376 // Yup, use the reload register that we didn't use before.
377 PhysReg = ReusedOperands[ro].AssignedPhysReg;
378 goto RecheckRegister;
380 ReusedOp &Op = ReusedOperands[ro];
381 unsigned PRRU = Op.PhysRegReused;
382 for (const unsigned *AS = MRI->getAliasSet(PRRU); *AS; ++AS)
383 if (*AS == PhysReg) {
384 // Okay, we found out that an alias of a reused register
385 // was used. This isn't good because it means we have
386 // to undo a previous reuse.
387 MRI->loadRegFromStackSlot(MBB, &MI, Op.AssignedPhysReg,
389 ClobberPhysReg(Op.AssignedPhysReg, SpillSlotsAvailable,
392 // Any stores to this stack slot are not dead anymore.
393 MaybeDeadStores.erase(Op.StackSlot);
395 MI.SetMachineOperandReg(Op.Operand, Op.AssignedPhysReg);
396 PhysRegsAvailable[Op.AssignedPhysReg] = Op.StackSlot;
397 SpillSlotsAvailable[Op.StackSlot] = Op.AssignedPhysReg;
398 PhysRegsAvailable.erase(Op.PhysRegReused);
399 DEBUG(std::cerr << "Remembering SS#" << Op.StackSlot
401 << MRI->getName(Op.AssignedPhysReg) << "\n");
403 DEBUG(std::cerr << '\t' << *prior(MII));
405 DEBUG(std::cerr << "Reuse undone!\n");
406 ReusedOperands.erase(ReusedOperands.begin()+ro);
412 PhysRegsUsed[PhysReg] = true;
413 MRI->loadRegFromStackSlot(MBB, &MI, PhysReg, StackSlot);
414 // This invalidates PhysReg.
415 ClobberPhysReg(PhysReg, SpillSlotsAvailable, PhysRegsAvailable);
417 // Any stores to this stack slot are not dead anymore.
418 MaybeDeadStores.erase(StackSlot);
420 MI.SetMachineOperandReg(i, PhysReg);
421 PhysRegsAvailable[PhysReg] = StackSlot;
422 SpillSlotsAvailable[StackSlot] = PhysReg;
423 DEBUG(std::cerr << "Remembering SS#" << StackSlot <<" in physreg "
424 << MRI->getName(PhysReg) << "\n");
426 DEBUG(std::cerr << '\t' << *prior(MII));
429 // If this is both a def and a use, we need to emit a store to the
430 // stack slot after the instruction. Keep track of D&U operands
431 // because we already changed it to a physreg here.
433 // Remember that this was a def-and-use operand, and that the
434 // stack slot is live after this instruction executes.
435 DefAndUseVReg.push_back(std::make_pair(i, VirtReg));
442 // Loop over all of the implicit defs, clearing them from our available
444 for (const unsigned *ImpDef = TII->getImplicitDefs(MI.getOpcode());
446 PhysRegsUsed[*ImpDef] = true;
447 ClobberPhysReg(*ImpDef, SpillSlotsAvailable, PhysRegsAvailable);
450 DEBUG(std::cerr << '\t' << MI);
452 // If we have folded references to memory operands, make sure we clear all
453 // physical registers that may contain the value of the spilled virtual
455 VirtRegMap::MI2VirtMapTy::const_iterator I, End;
456 for (tie(I, End) = VRM.getFoldedVirts(&MI); I != End; ++I) {
457 DEBUG(std::cerr << "Folded vreg: " << I->second.first << " MR: "
458 << I->second.second);
459 unsigned VirtReg = I->second.first;
460 VirtRegMap::ModRef MR = I->second.second;
461 if (VRM.hasStackSlot(VirtReg)) {
462 int SS = VRM.getStackSlot(VirtReg);
463 DEBUG(std::cerr << " - StackSlot: " << SS << "\n");
465 // If this reference is not a use, any previous store is now dead.
466 // Otherwise, the store to this stack slot is not dead anymore.
467 std::map<int, MachineInstr*>::iterator MDSI = MaybeDeadStores.find(SS);
468 if (MDSI != MaybeDeadStores.end()) {
469 if (MR & VirtRegMap::isRef) // Previous store is not dead.
470 MaybeDeadStores.erase(MDSI);
472 // If we get here, the store is dead, nuke it now.
473 assert(MR == VirtRegMap::isMod && "Can't be modref!");
474 MBB.erase(MDSI->second);
475 MaybeDeadStores.erase(MDSI);
480 // If the spill slot value is available, and this is a new definition of
481 // the value, the value is not available anymore.
482 if (MR & VirtRegMap::isMod) {
483 std::map<int, unsigned>::iterator It = SpillSlotsAvailable.find(SS);
484 if (It != SpillSlotsAvailable.end()) {
485 PhysRegsAvailable.erase(It->second);
486 SpillSlotsAvailable.erase(It);
490 DEBUG(std::cerr << ": No stack slot!\n");
494 // Process all of the spilled defs.
495 for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
496 MachineOperand &MO = MI.getOperand(i);
497 if (MO.isRegister() && MO.getReg() && MO.isDef()) {
498 unsigned VirtReg = MO.getReg();
500 bool TakenCareOf = false;
501 if (!MRegisterInfo::isVirtualRegister(VirtReg)) {
502 // Check to see if this is a def-and-use vreg operand that we do need
503 // to insert a store for.
504 bool OpTakenCareOf = false;
505 if (MO.isUse() && !DefAndUseVReg.empty()) {
506 for (unsigned dau = 0, e = DefAndUseVReg.size(); dau != e; ++dau)
507 if (DefAndUseVReg[dau].first == i) {
508 VirtReg = DefAndUseVReg[dau].second;
509 OpTakenCareOf = true;
514 if (!OpTakenCareOf) {
515 ClobberPhysReg(VirtReg, SpillSlotsAvailable, PhysRegsAvailable);
521 // The only vregs left are stack slot definitions.
522 int StackSlot = VRM.getStackSlot(VirtReg);
525 // If this is a def&use operand, and we used a different physreg for
526 // it than the one assigned, make sure to execute the store from the
527 // correct physical register.
528 if (MO.getReg() == VirtReg)
529 PhysReg = VRM.getPhys(VirtReg);
531 PhysReg = MO.getReg();
533 PhysRegsUsed[PhysReg] = true;
534 MRI->storeRegToStackSlot(MBB, next(MII), PhysReg, StackSlot);
535 DEBUG(std::cerr << "Store:\t" << *next(MII));
536 MI.SetMachineOperandReg(i, PhysReg);
538 // If there is a dead store to this stack slot, nuke it now.
539 MachineInstr *&LastStore = MaybeDeadStores[StackSlot];
541 DEBUG(std::cerr << " Killed store:\t" << *LastStore);
543 MBB.erase(LastStore);
545 LastStore = next(MII);
547 // If the stack slot value was previously available in some other
548 // register, change it now. Otherwise, make the register available,
550 std::map<int, unsigned>::iterator SSA =
551 SpillSlotsAvailable.find(StackSlot);
552 if (SSA != SpillSlotsAvailable.end()) {
553 // Remove the record for physreg.
554 PhysRegsAvailable.erase(SSA->second);
555 SpillSlotsAvailable.erase(SSA);
557 ClobberPhysReg(PhysReg, SpillSlotsAvailable, PhysRegsAvailable);
559 PhysRegsAvailable[PhysReg] = StackSlot;
560 SpillSlotsAvailable[StackSlot] = PhysReg;
561 DEBUG(std::cerr << "Updating SS#" << StackSlot <<" in physreg "
562 << MRI->getName(PhysReg) << " for virtreg #"
576 llvm::Spiller* llvm::createSpiller() {
577 switch (SpillerOpt) {
578 default: assert(0 && "Unreachable!");
580 return new LocalSpiller();
582 return new SimpleSpiller();