blob: 5153abbc4e1160589ca47bc47923408d3b5ed4a2 [file] [log] [blame]
Evan Chengc6fe3332010-03-02 02:38:24 +00001//===-- MachineCSE.cpp - Machine Common Subexpression Elimination Pass ----===//
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 pass performs global common subexpression elimination on machine
Evan Chengc5bbba12010-03-02 19:02:27 +000011// instructions using a scoped hash table based value numbering scheme. It
Evan Chengc6fe3332010-03-02 02:38:24 +000012// must be run while the machine function is still in SSA form.
13//
14//===----------------------------------------------------------------------===//
15
16#define DEBUG_TYPE "machine-cse"
17#include "llvm/CodeGen/Passes.h"
18#include "llvm/CodeGen/MachineDominators.h"
19#include "llvm/CodeGen/MachineInstr.h"
Evan Cheng6ba95542010-03-03 02:48:20 +000020#include "llvm/CodeGen/MachineRegisterInfo.h"
Evan Chenga5f32cb2010-03-04 21:18:08 +000021#include "llvm/Analysis/AliasAnalysis.h"
Evan Cheng6ba95542010-03-03 02:48:20 +000022#include "llvm/Target/TargetInstrInfo.h"
Evan Cheng31156982010-04-21 00:21:07 +000023#include "llvm/ADT/DenseMap.h"
Evan Chengc6fe3332010-03-02 02:38:24 +000024#include "llvm/ADT/ScopedHashTable.h"
Evan Cheng189c1ec2010-10-29 23:36:03 +000025#include "llvm/ADT/SmallSet.h"
Evan Chengc6fe3332010-03-02 02:38:24 +000026#include "llvm/ADT/Statistic.h"
27#include "llvm/Support/Debug.h"
Cameron Zwarich53eeba52011-01-03 04:07:46 +000028#include "llvm/Support/RecyclingAllocator.h"
Evan Chengc6fe3332010-03-02 02:38:24 +000029using namespace llvm;
30
Evan Cheng16b48b82010-03-03 21:20:05 +000031STATISTIC(NumCoalesces, "Number of copies coalesced");
32STATISTIC(NumCSEs, "Number of common subexpression eliminated");
Evan Cheng189c1ec2010-10-29 23:36:03 +000033STATISTIC(NumPhysCSEs,
34 "Number of physreg referencing common subexpr eliminated");
Evan Cheng97b5beb2012-01-10 02:02:58 +000035STATISTIC(NumCrossBBCSEs,
36 "Number of cross-MBB physreg referencing CS eliminated");
Evan Chenga63cde22010-12-15 22:16:21 +000037STATISTIC(NumCommutes, "Number of copies coalesced after commuting");
Bob Wilson38441732010-06-03 18:28:31 +000038
Evan Chengc6fe3332010-03-02 02:38:24 +000039namespace {
40 class MachineCSE : public MachineFunctionPass {
Evan Cheng6ba95542010-03-03 02:48:20 +000041 const TargetInstrInfo *TII;
Evan Chengb3958e82010-03-04 01:33:55 +000042 const TargetRegisterInfo *TRI;
Evan Chenga5f32cb2010-03-04 21:18:08 +000043 AliasAnalysis *AA;
Evan Cheng31f94c72010-03-09 03:21:12 +000044 MachineDominatorTree *DT;
45 MachineRegisterInfo *MRI;
Evan Chengc6fe3332010-03-02 02:38:24 +000046 public:
47 static char ID; // Pass identification
Owen Anderson081c34b2010-10-19 17:21:58 +000048 MachineCSE() : MachineFunctionPass(ID), LookAheadLimit(5), CurrVN(0) {
49 initializeMachineCSEPass(*PassRegistry::getPassRegistry());
50 }
Evan Chengc6fe3332010-03-02 02:38:24 +000051
52 virtual bool runOnMachineFunction(MachineFunction &MF);
Andrew Trick1df91b02012-02-08 21:22:43 +000053
Evan Chengc6fe3332010-03-02 02:38:24 +000054 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
55 AU.setPreservesCFG();
56 MachineFunctionPass::getAnalysisUsage(AU);
Evan Chenga5f32cb2010-03-04 21:18:08 +000057 AU.addRequired<AliasAnalysis>();
Evan Cheng65424162010-08-17 20:57:42 +000058 AU.addPreservedID(MachineLoopInfoID);
Evan Chengc6fe3332010-03-02 02:38:24 +000059 AU.addRequired<MachineDominatorTree>();
60 AU.addPreserved<MachineDominatorTree>();
61 }
62
Evan Chengc2b768f2010-09-17 21:59:42 +000063 virtual void releaseMemory() {
64 ScopeMap.clear();
65 Exps.clear();
Lang Hamesc2e08db2012-02-17 00:27:16 +000066 AllocatableRegs.clear();
67 ReservedRegs.clear();
Evan Chengc2b768f2010-09-17 21:59:42 +000068 }
69
Evan Chengc6fe3332010-03-02 02:38:24 +000070 private:
Evan Cheng835810b2010-05-21 21:22:19 +000071 const unsigned LookAheadLimit;
Cameron Zwarich53eeba52011-01-03 04:07:46 +000072 typedef RecyclingAllocator<BumpPtrAllocator,
73 ScopedHashTableVal<MachineInstr*, unsigned> > AllocatorTy;
74 typedef ScopedHashTable<MachineInstr*, unsigned,
75 MachineInstrExpressionTrait, AllocatorTy> ScopedHTType;
76 typedef ScopedHTType::ScopeTy ScopeType;
Evan Cheng31156982010-04-21 00:21:07 +000077 DenseMap<MachineBasicBlock*, ScopeType*> ScopeMap;
Cameron Zwarich53eeba52011-01-03 04:07:46 +000078 ScopedHTType VNT;
Evan Cheng16b48b82010-03-03 21:20:05 +000079 SmallVector<MachineInstr*, 64> Exps;
Evan Cheng31156982010-04-21 00:21:07 +000080 unsigned CurrVN;
Lang Hamesc2e08db2012-02-17 00:27:16 +000081 BitVector AllocatableRegs;
82 BitVector ReservedRegs;
Evan Cheng16b48b82010-03-03 21:20:05 +000083
Evan Chenga5f32cb2010-03-04 21:18:08 +000084 bool PerformTrivialCoalescing(MachineInstr *MI, MachineBasicBlock *MBB);
Evan Chengb3958e82010-03-04 01:33:55 +000085 bool isPhysDefTriviallyDead(unsigned Reg,
86 MachineBasicBlock::const_iterator I,
Nick Lewycky7a7a6db2012-07-05 06:19:21 +000087 MachineBasicBlock::const_iterator E) const;
Evan Cheng189c1ec2010-10-29 23:36:03 +000088 bool hasLivePhysRegDefUses(const MachineInstr *MI,
89 const MachineBasicBlock *MBB,
Evan Cheng97b5beb2012-01-10 02:02:58 +000090 SmallSet<unsigned,8> &PhysRefs,
91 SmallVector<unsigned,2> &PhysDefs) const;
Evan Cheng189c1ec2010-10-29 23:36:03 +000092 bool PhysRegDefsReach(MachineInstr *CSMI, MachineInstr *MI,
Evan Cheng97b5beb2012-01-10 02:02:58 +000093 SmallSet<unsigned,8> &PhysRefs,
Evan Chengf96703e2012-01-11 00:38:11 +000094 SmallVector<unsigned,2> &PhysDefs,
Evan Cheng97b5beb2012-01-10 02:02:58 +000095 bool &NonLocal) const;
Evan Chenga5f32cb2010-03-04 21:18:08 +000096 bool isCSECandidate(MachineInstr *MI);
Evan Cheng2938a002010-03-10 02:12:03 +000097 bool isProfitableToCSE(unsigned CSReg, unsigned Reg,
98 MachineInstr *CSMI, MachineInstr *MI);
Evan Cheng31156982010-04-21 00:21:07 +000099 void EnterScope(MachineBasicBlock *MBB);
100 void ExitScope(MachineBasicBlock *MBB);
101 bool ProcessBlock(MachineBasicBlock *MBB);
102 void ExitScopeIfDone(MachineDomTreeNode *Node,
Bill Wendling96cb1122012-07-19 00:04:14 +0000103 DenseMap<MachineDomTreeNode*, unsigned> &OpenChildren);
Evan Cheng31156982010-04-21 00:21:07 +0000104 bool PerformCSE(MachineDomTreeNode *Node);
Evan Chengc6fe3332010-03-02 02:38:24 +0000105 };
106} // end anonymous namespace
107
108char MachineCSE::ID = 0;
Andrew Trick1dd8c852012-02-08 21:23:13 +0000109char &llvm::MachineCSEID = MachineCSE::ID;
Owen Anderson2ab36d32010-10-12 19:48:12 +0000110INITIALIZE_PASS_BEGIN(MachineCSE, "machine-cse",
111 "Machine Common Subexpression Elimination", false, false)
112INITIALIZE_PASS_DEPENDENCY(MachineDominatorTree)
113INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
114INITIALIZE_PASS_END(MachineCSE, "machine-cse",
Owen Andersonce665bd2010-10-07 22:25:06 +0000115 "Machine Common Subexpression Elimination", false, false)
Evan Chengc6fe3332010-03-02 02:38:24 +0000116
Evan Cheng6ba95542010-03-03 02:48:20 +0000117bool MachineCSE::PerformTrivialCoalescing(MachineInstr *MI,
118 MachineBasicBlock *MBB) {
119 bool Changed = false;
120 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
121 MachineOperand &MO = MI->getOperand(i);
Evan Cheng16b48b82010-03-03 21:20:05 +0000122 if (!MO.isReg() || !MO.isUse())
123 continue;
124 unsigned Reg = MO.getReg();
Jakob Stoklund Olesenc9df0252011-01-10 02:58:51 +0000125 if (!TargetRegisterInfo::isVirtualRegister(Reg))
Evan Cheng16b48b82010-03-03 21:20:05 +0000126 continue;
Evan Chengf437f732010-09-17 21:56:26 +0000127 if (!MRI->hasOneNonDBGUse(Reg))
Evan Cheng16b48b82010-03-03 21:20:05 +0000128 // Only coalesce single use copies. This ensure the copy will be
129 // deleted.
130 continue;
131 MachineInstr *DefMI = MRI->getVRegDef(Reg);
132 if (DefMI->getParent() != MBB)
133 continue;
Jakob Stoklund Olesen0bc25f42010-07-08 16:40:22 +0000134 if (!DefMI->isCopy())
135 continue;
Jakob Stoklund Olesen04c528a2010-07-16 04:45:42 +0000136 unsigned SrcReg = DefMI->getOperand(1).getReg();
Jakob Stoklund Olesen0bc25f42010-07-08 16:40:22 +0000137 if (!TargetRegisterInfo::isVirtualRegister(SrcReg))
138 continue;
139 if (DefMI->getOperand(0).getSubReg() || DefMI->getOperand(1).getSubReg())
140 continue;
Jakob Stoklund Olesenbf4699c2010-10-06 23:54:39 +0000141 if (!MRI->constrainRegClass(SrcReg, MRI->getRegClass(Reg)))
Jakob Stoklund Olesen0bc25f42010-07-08 16:40:22 +0000142 continue;
143 DEBUG(dbgs() << "Coalescing: " << *DefMI);
Jakob Stoklund Olesenbf4699c2010-10-06 23:54:39 +0000144 DEBUG(dbgs() << "*** to: " << *MI);
Jakob Stoklund Olesen0bc25f42010-07-08 16:40:22 +0000145 MO.setReg(SrcReg);
146 MRI->clearKillFlags(SrcReg);
Jakob Stoklund Olesen0bc25f42010-07-08 16:40:22 +0000147 DefMI->eraseFromParent();
148 ++NumCoalesces;
149 Changed = true;
Evan Cheng6ba95542010-03-03 02:48:20 +0000150 }
151
152 return Changed;
153}
154
Evan Cheng835810b2010-05-21 21:22:19 +0000155bool
156MachineCSE::isPhysDefTriviallyDead(unsigned Reg,
157 MachineBasicBlock::const_iterator I,
158 MachineBasicBlock::const_iterator E) const {
Eric Christophere81d0102010-05-21 23:40:03 +0000159 unsigned LookAheadLeft = LookAheadLimit;
Evan Cheng112e5e72010-03-23 20:33:48 +0000160 while (LookAheadLeft) {
Evan Cheng22504252010-03-24 01:50:28 +0000161 // Skip over dbg_value's.
162 while (I != E && I->isDebugValue())
163 ++I;
164
Evan Chengb3958e82010-03-04 01:33:55 +0000165 if (I == E)
166 // Reached end of block, register is obviously dead.
167 return true;
168
Evan Chengb3958e82010-03-04 01:33:55 +0000169 bool SeenDef = false;
170 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
171 const MachineOperand &MO = I->getOperand(i);
Jakob Stoklund Olesen2129a0f2012-02-28 02:08:50 +0000172 if (MO.isRegMask() && MO.clobbersPhysReg(Reg))
173 SeenDef = true;
Evan Chengb3958e82010-03-04 01:33:55 +0000174 if (!MO.isReg() || !MO.getReg())
175 continue;
176 if (!TRI->regsOverlap(MO.getReg(), Reg))
177 continue;
178 if (MO.isUse())
Evan Cheng835810b2010-05-21 21:22:19 +0000179 // Found a use!
Evan Chengb3958e82010-03-04 01:33:55 +0000180 return false;
181 SeenDef = true;
182 }
183 if (SeenDef)
Andrew Trick1df91b02012-02-08 21:22:43 +0000184 // See a def of Reg (or an alias) before encountering any use, it's
Evan Chengb3958e82010-03-04 01:33:55 +0000185 // trivially dead.
186 return true;
Evan Cheng112e5e72010-03-23 20:33:48 +0000187
188 --LookAheadLeft;
Evan Chengb3958e82010-03-04 01:33:55 +0000189 ++I;
190 }
191 return false;
192}
193
Evan Cheng189c1ec2010-10-29 23:36:03 +0000194/// hasLivePhysRegDefUses - Return true if the specified instruction read/write
Evan Cheng835810b2010-05-21 21:22:19 +0000195/// physical registers (except for dead defs of physical registers). It also
Evan Cheng2b4e7272010-06-04 23:28:13 +0000196/// returns the physical register def by reference if it's the only one and the
197/// instruction does not uses a physical register.
Evan Cheng189c1ec2010-10-29 23:36:03 +0000198bool MachineCSE::hasLivePhysRegDefUses(const MachineInstr *MI,
199 const MachineBasicBlock *MBB,
Evan Cheng97b5beb2012-01-10 02:02:58 +0000200 SmallSet<unsigned,8> &PhysRefs,
201 SmallVector<unsigned,2> &PhysDefs) const{
Evan Cheng189c1ec2010-10-29 23:36:03 +0000202 MachineBasicBlock::const_iterator I = MI; I = llvm::next(I);
Evan Cheng6ba95542010-03-03 02:48:20 +0000203 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
Evan Cheng835810b2010-05-21 21:22:19 +0000204 const MachineOperand &MO = MI->getOperand(i);
Evan Cheng6ba95542010-03-03 02:48:20 +0000205 if (!MO.isReg())
206 continue;
207 unsigned Reg = MO.getReg();
208 if (!Reg)
209 continue;
Evan Cheng835810b2010-05-21 21:22:19 +0000210 if (TargetRegisterInfo::isVirtualRegister(Reg))
211 continue;
Evan Cheng189c1ec2010-10-29 23:36:03 +0000212 // If the def is dead, it's ok. But the def may not marked "dead". That's
Evan Cheng835810b2010-05-21 21:22:19 +0000213 // common since this pass is run before livevariables. We can scan
214 // forward a few instructions and check if it is obviously dead.
Evan Cheng189c1ec2010-10-29 23:36:03 +0000215 if (MO.isDef() &&
216 (MO.isDead() || isPhysDefTriviallyDead(Reg, I, MBB->end())))
217 continue;
Jakob Stoklund Olesenf152fe82012-06-01 20:36:54 +0000218 for (MCRegAliasIterator AI(Reg, TRI, true); AI.isValid(); ++AI)
219 PhysRefs.insert(*AI);
Evan Cheng97b5beb2012-01-10 02:02:58 +0000220 if (MO.isDef())
221 PhysDefs.push_back(Reg);
Evan Chengb3958e82010-03-04 01:33:55 +0000222 }
223
Evan Cheng189c1ec2010-10-29 23:36:03 +0000224 return !PhysRefs.empty();
Evan Chengc6fe3332010-03-02 02:38:24 +0000225}
226
Evan Cheng189c1ec2010-10-29 23:36:03 +0000227bool MachineCSE::PhysRegDefsReach(MachineInstr *CSMI, MachineInstr *MI,
Evan Cheng97b5beb2012-01-10 02:02:58 +0000228 SmallSet<unsigned,8> &PhysRefs,
Evan Chengf96703e2012-01-11 00:38:11 +0000229 SmallVector<unsigned,2> &PhysDefs,
Evan Cheng97b5beb2012-01-10 02:02:58 +0000230 bool &NonLocal) const {
Eli Friedman5e926ac2011-05-06 05:23:07 +0000231 // For now conservatively returns false if the common subexpression is
Evan Cheng97b5beb2012-01-10 02:02:58 +0000232 // not in the same basic block as the given instruction. The only exception
233 // is if the common subexpression is in the sole predecessor block.
234 const MachineBasicBlock *MBB = MI->getParent();
235 const MachineBasicBlock *CSMBB = CSMI->getParent();
236
237 bool CrossMBB = false;
238 if (CSMBB != MBB) {
Evan Chengf96703e2012-01-11 00:38:11 +0000239 if (MBB->pred_size() != 1 || *MBB->pred_begin() != CSMBB)
Evan Cheng97b5beb2012-01-10 02:02:58 +0000240 return false;
Evan Chengf96703e2012-01-11 00:38:11 +0000241
242 for (unsigned i = 0, e = PhysDefs.size(); i != e; ++i) {
Lang Hamesc2e08db2012-02-17 00:27:16 +0000243 if (AllocatableRegs.test(PhysDefs[i]) || ReservedRegs.test(PhysDefs[i]))
244 // Avoid extending live range of physical registers if they are
245 //allocatable or reserved.
Evan Chengf96703e2012-01-11 00:38:11 +0000246 return false;
247 }
248 CrossMBB = true;
Evan Cheng97b5beb2012-01-10 02:02:58 +0000249 }
Eli Friedman5e926ac2011-05-06 05:23:07 +0000250 MachineBasicBlock::const_iterator I = CSMI; I = llvm::next(I);
251 MachineBasicBlock::const_iterator E = MI;
Evan Cheng97b5beb2012-01-10 02:02:58 +0000252 MachineBasicBlock::const_iterator EE = CSMBB->end();
Evan Cheng835810b2010-05-21 21:22:19 +0000253 unsigned LookAheadLeft = LookAheadLimit;
254 while (LookAheadLeft) {
Eli Friedman5e926ac2011-05-06 05:23:07 +0000255 // Skip over dbg_value's.
Evan Cheng97b5beb2012-01-10 02:02:58 +0000256 while (I != E && I != EE && I->isDebugValue())
Evan Cheng835810b2010-05-21 21:22:19 +0000257 ++I;
Eli Friedman5e926ac2011-05-06 05:23:07 +0000258
Evan Cheng97b5beb2012-01-10 02:02:58 +0000259 if (I == EE) {
260 assert(CrossMBB && "Reaching end-of-MBB without finding MI?");
Duncan Sands5b8a1db2012-02-05 14:20:11 +0000261 (void)CrossMBB;
Evan Cheng97b5beb2012-01-10 02:02:58 +0000262 CrossMBB = false;
263 NonLocal = true;
264 I = MBB->begin();
265 EE = MBB->end();
266 continue;
267 }
268
Eli Friedman5e926ac2011-05-06 05:23:07 +0000269 if (I == E)
270 return true;
271
272 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
273 const MachineOperand &MO = I->getOperand(i);
Jakob Stoklund Olesen2129a0f2012-02-28 02:08:50 +0000274 // RegMasks go on instructions like calls that clobber lots of physregs.
275 // Don't attempt to CSE across such an instruction.
276 if (MO.isRegMask())
277 return false;
Eli Friedman5e926ac2011-05-06 05:23:07 +0000278 if (!MO.isReg() || !MO.isDef())
279 continue;
280 unsigned MOReg = MO.getReg();
281 if (TargetRegisterInfo::isVirtualRegister(MOReg))
282 continue;
283 if (PhysRefs.count(MOReg))
284 return false;
Evan Cheng189c1ec2010-10-29 23:36:03 +0000285 }
Eli Friedman5e926ac2011-05-06 05:23:07 +0000286
287 --LookAheadLeft;
288 ++I;
Evan Cheng835810b2010-05-21 21:22:19 +0000289 }
290
291 return false;
292}
293
Evan Chenga5f32cb2010-03-04 21:18:08 +0000294bool MachineCSE::isCSECandidate(MachineInstr *MI) {
Evan Cheng51960182010-03-08 23:49:12 +0000295 if (MI->isLabel() || MI->isPHI() || MI->isImplicitDef() ||
Dale Johannesene68ea062010-03-11 02:10:24 +0000296 MI->isKill() || MI->isInlineAsm() || MI->isDebugValue())
Evan Cheng51960182010-03-08 23:49:12 +0000297 return false;
298
Evan Cheng2938a002010-03-10 02:12:03 +0000299 // Ignore copies.
Jakob Stoklund Olesen04c528a2010-07-16 04:45:42 +0000300 if (MI->isCopyLike())
Evan Chenga5f32cb2010-03-04 21:18:08 +0000301 return false;
302
303 // Ignore stuff that we obviously can't move.
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000304 if (MI->mayStore() || MI->isCall() || MI->isTerminator() ||
Evan Chengc36b7062011-01-07 23:50:32 +0000305 MI->hasUnmodeledSideEffects())
Evan Chenga5f32cb2010-03-04 21:18:08 +0000306 return false;
307
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000308 if (MI->mayLoad()) {
Evan Chenga5f32cb2010-03-04 21:18:08 +0000309 // Okay, this instruction does a load. As a refinement, we allow the target
310 // to decide whether the loaded value is actually a constant. If so, we can
311 // actually use it as a load.
312 if (!MI->isInvariantLoad(AA))
313 // FIXME: we should be able to hoist loads with no other side effects if
314 // there are no other instructions which can change memory in this loop.
315 // This is a trivial form of alias analysis.
316 return false;
317 }
318 return true;
319}
320
Evan Cheng31f94c72010-03-09 03:21:12 +0000321/// isProfitableToCSE - Return true if it's profitable to eliminate MI with a
322/// common expression that defines Reg.
Evan Cheng2938a002010-03-10 02:12:03 +0000323bool MachineCSE::isProfitableToCSE(unsigned CSReg, unsigned Reg,
324 MachineInstr *CSMI, MachineInstr *MI) {
325 // FIXME: Heuristics that works around the lack the live range splitting.
326
Manman Renba86b132012-08-07 06:16:46 +0000327 // If CSReg is used at all uses of Reg, CSE should not increase register
328 // pressure of CSReg.
329 bool MayIncreasePressure = true;
330 if (TargetRegisterInfo::isVirtualRegister(CSReg) &&
331 TargetRegisterInfo::isVirtualRegister(Reg)) {
332 MayIncreasePressure = false;
333 SmallPtrSet<MachineInstr*, 8> CSUses;
334 for (MachineRegisterInfo::use_nodbg_iterator I =MRI->use_nodbg_begin(CSReg),
335 E = MRI->use_nodbg_end(); I != E; ++I) {
336 MachineInstr *Use = &*I;
337 CSUses.insert(Use);
338 }
339 for (MachineRegisterInfo::use_nodbg_iterator I = MRI->use_nodbg_begin(Reg),
340 E = MRI->use_nodbg_end(); I != E; ++I) {
341 MachineInstr *Use = &*I;
342 if (!CSUses.count(Use)) {
343 MayIncreasePressure = true;
344 break;
345 }
346 }
347 }
348 if (!MayIncreasePressure) return true;
349
Chris Lattner622a11b2011-01-10 07:51:31 +0000350 // Heuristics #1: Don't CSE "cheap" computation if the def is not local or in
351 // an immediate predecessor. We don't want to increase register pressure and
352 // end up causing other computation to be spilled.
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000353 if (MI->isAsCheapAsAMove()) {
Evan Cheng2938a002010-03-10 02:12:03 +0000354 MachineBasicBlock *CSBB = CSMI->getParent();
355 MachineBasicBlock *BB = MI->getParent();
Chris Lattner622a11b2011-01-10 07:51:31 +0000356 if (CSBB != BB && !CSBB->isSuccessor(BB))
Evan Cheng2938a002010-03-10 02:12:03 +0000357 return false;
358 }
359
360 // Heuristics #2: If the expression doesn't not use a vr and the only use
361 // of the redundant computation are copies, do not cse.
362 bool HasVRegUse = false;
363 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
364 const MachineOperand &MO = MI->getOperand(i);
Jakob Stoklund Olesenc9df0252011-01-10 02:58:51 +0000365 if (MO.isReg() && MO.isUse() &&
Evan Cheng2938a002010-03-10 02:12:03 +0000366 TargetRegisterInfo::isVirtualRegister(MO.getReg())) {
367 HasVRegUse = true;
368 break;
369 }
370 }
371 if (!HasVRegUse) {
372 bool HasNonCopyUse = false;
373 for (MachineRegisterInfo::use_nodbg_iterator I = MRI->use_nodbg_begin(Reg),
374 E = MRI->use_nodbg_end(); I != E; ++I) {
375 MachineInstr *Use = &*I;
376 // Ignore copies.
Jakob Stoklund Olesen04c528a2010-07-16 04:45:42 +0000377 if (!Use->isCopyLike()) {
Evan Cheng2938a002010-03-10 02:12:03 +0000378 HasNonCopyUse = true;
379 break;
380 }
381 }
382 if (!HasNonCopyUse)
383 return false;
384 }
385
386 // Heuristics #3: If the common subexpression is used by PHIs, do not reuse
387 // it unless the defined value is already used in the BB of the new use.
Evan Cheng31f94c72010-03-09 03:21:12 +0000388 bool HasPHI = false;
389 SmallPtrSet<MachineBasicBlock*, 4> CSBBs;
Evan Cheng2938a002010-03-10 02:12:03 +0000390 for (MachineRegisterInfo::use_nodbg_iterator I = MRI->use_nodbg_begin(CSReg),
Evan Cheng31f94c72010-03-09 03:21:12 +0000391 E = MRI->use_nodbg_end(); I != E; ++I) {
392 MachineInstr *Use = &*I;
393 HasPHI |= Use->isPHI();
394 CSBBs.insert(Use->getParent());
395 }
396
397 if (!HasPHI)
398 return true;
399 return CSBBs.count(MI->getParent());
400}
401
Evan Cheng31156982010-04-21 00:21:07 +0000402void MachineCSE::EnterScope(MachineBasicBlock *MBB) {
403 DEBUG(dbgs() << "Entering: " << MBB->getName() << '\n');
404 ScopeType *Scope = new ScopeType(VNT);
405 ScopeMap[MBB] = Scope;
406}
407
408void MachineCSE::ExitScope(MachineBasicBlock *MBB) {
409 DEBUG(dbgs() << "Exiting: " << MBB->getName() << '\n');
410 DenseMap<MachineBasicBlock*, ScopeType*>::iterator SI = ScopeMap.find(MBB);
411 assert(SI != ScopeMap.end());
412 ScopeMap.erase(SI);
413 delete SI->second;
414}
415
416bool MachineCSE::ProcessBlock(MachineBasicBlock *MBB) {
Evan Cheng6ba95542010-03-03 02:48:20 +0000417 bool Changed = false;
418
Evan Cheng31f94c72010-03-09 03:21:12 +0000419 SmallVector<std::pair<unsigned, unsigned>, 8> CSEPairs;
Manman Ren39ad5682012-08-08 00:51:41 +0000420 SmallVector<unsigned, 2> ImplicitDefsToUpdate;
Evan Cheng16b48b82010-03-03 21:20:05 +0000421 for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end(); I != E; ) {
Evan Cheng6ba95542010-03-03 02:48:20 +0000422 MachineInstr *MI = &*I;
Evan Cheng16b48b82010-03-03 21:20:05 +0000423 ++I;
Evan Chenga5f32cb2010-03-04 21:18:08 +0000424
425 if (!isCSECandidate(MI))
Evan Cheng6ba95542010-03-03 02:48:20 +0000426 continue;
Evan Cheng6ba95542010-03-03 02:48:20 +0000427
428 bool FoundCSE = VNT.count(MI);
429 if (!FoundCSE) {
430 // Look for trivial copy coalescing opportunities.
Evan Chengdb8771a2010-04-02 02:21:24 +0000431 if (PerformTrivialCoalescing(MI, MBB)) {
Evan Chengcfea9852011-04-11 18:47:20 +0000432 Changed = true;
433
Evan Chengdb8771a2010-04-02 02:21:24 +0000434 // After coalescing MI itself may become a copy.
Jakob Stoklund Olesen04c528a2010-07-16 04:45:42 +0000435 if (MI->isCopyLike())
Evan Chengdb8771a2010-04-02 02:21:24 +0000436 continue;
Evan Cheng6ba95542010-03-03 02:48:20 +0000437 FoundCSE = VNT.count(MI);
Evan Chengdb8771a2010-04-02 02:21:24 +0000438 }
Evan Cheng6ba95542010-03-03 02:48:20 +0000439 }
Evan Chenga63cde22010-12-15 22:16:21 +0000440
441 // Commute commutable instructions.
442 bool Commuted = false;
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000443 if (!FoundCSE && MI->isCommutable()) {
Evan Chenga63cde22010-12-15 22:16:21 +0000444 MachineInstr *NewMI = TII->commuteInstruction(MI);
445 if (NewMI) {
446 Commuted = true;
447 FoundCSE = VNT.count(NewMI);
Evan Chengcfea9852011-04-11 18:47:20 +0000448 if (NewMI != MI) {
Evan Chenga63cde22010-12-15 22:16:21 +0000449 // New instruction. It doesn't need to be kept.
450 NewMI->eraseFromParent();
Evan Chengcfea9852011-04-11 18:47:20 +0000451 Changed = true;
452 } else if (!FoundCSE)
Evan Chenga63cde22010-12-15 22:16:21 +0000453 // MI was changed but it didn't help, commute it back!
454 (void)TII->commuteInstruction(MI);
455 }
456 }
Evan Cheng6ba95542010-03-03 02:48:20 +0000457
Evan Cheng189c1ec2010-10-29 23:36:03 +0000458 // If the instruction defines physical registers and the values *may* be
Evan Cheng67bda722010-03-03 23:59:08 +0000459 // used, then it's not safe to replace it with a common subexpression.
Evan Cheng189c1ec2010-10-29 23:36:03 +0000460 // It's also not safe if the instruction uses physical registers.
Evan Cheng97b5beb2012-01-10 02:02:58 +0000461 bool CrossMBBPhysDef = false;
Nick Lewycky7a7a6db2012-07-05 06:19:21 +0000462 SmallSet<unsigned, 8> PhysRefs;
Evan Cheng97b5beb2012-01-10 02:02:58 +0000463 SmallVector<unsigned, 2> PhysDefs;
464 if (FoundCSE && hasLivePhysRegDefUses(MI, MBB, PhysRefs, PhysDefs)) {
Evan Cheng67bda722010-03-03 23:59:08 +0000465 FoundCSE = false;
466
Evan Cheng97b5beb2012-01-10 02:02:58 +0000467 // ... Unless the CS is local or is in the sole predecessor block
468 // and it also defines the physical register which is not clobbered
469 // in between and the physical register uses were not clobbered.
Evan Cheng189c1ec2010-10-29 23:36:03 +0000470 unsigned CSVN = VNT.lookup(MI);
471 MachineInstr *CSMI = Exps[CSVN];
Evan Chengf96703e2012-01-11 00:38:11 +0000472 if (PhysRegDefsReach(CSMI, MI, PhysRefs, PhysDefs, CrossMBBPhysDef))
Evan Cheng189c1ec2010-10-29 23:36:03 +0000473 FoundCSE = true;
Evan Cheng835810b2010-05-21 21:22:19 +0000474 }
475
Evan Cheng16b48b82010-03-03 21:20:05 +0000476 if (!FoundCSE) {
477 VNT.insert(MI, CurrVN++);
478 Exps.push_back(MI);
479 continue;
480 }
481
482 // Found a common subexpression, eliminate it.
483 unsigned CSVN = VNT.lookup(MI);
484 MachineInstr *CSMI = Exps[CSVN];
485 DEBUG(dbgs() << "Examining: " << *MI);
486 DEBUG(dbgs() << "*** Found a common subexpression: " << *CSMI);
Evan Cheng31f94c72010-03-09 03:21:12 +0000487
488 // Check if it's profitable to perform this CSE.
489 bool DoCSE = true;
Manman Ren39ad5682012-08-08 00:51:41 +0000490 unsigned NumDefs = MI->getDesc().getNumDefs() +
491 MI->getDesc().getNumImplicitDefs();
492
Evan Cheng16b48b82010-03-03 21:20:05 +0000493 for (unsigned i = 0, e = MI->getNumOperands(); NumDefs && i != e; ++i) {
494 MachineOperand &MO = MI->getOperand(i);
495 if (!MO.isReg() || !MO.isDef())
496 continue;
497 unsigned OldReg = MO.getReg();
498 unsigned NewReg = CSMI->getOperand(i).getReg();
Manman Ren39ad5682012-08-08 00:51:41 +0000499
500 // Go through implicit defs of CSMI and MI, if a def is not dead at MI,
501 // we should make sure it is not dead at CSMI.
502 if (MO.isImplicit() && !MO.isDead() && CSMI->getOperand(i).isDead())
503 ImplicitDefsToUpdate.push_back(i);
504 if (OldReg == NewReg) {
505 --NumDefs;
Evan Cheng6cc1aea2010-03-06 01:14:19 +0000506 continue;
Manman Ren39ad5682012-08-08 00:51:41 +0000507 }
Bill Wendlingf6fb7ed2011-10-12 23:03:40 +0000508
Evan Cheng6cc1aea2010-03-06 01:14:19 +0000509 assert(TargetRegisterInfo::isVirtualRegister(OldReg) &&
Evan Cheng16b48b82010-03-03 21:20:05 +0000510 TargetRegisterInfo::isVirtualRegister(NewReg) &&
511 "Do not CSE physical register defs!");
Bill Wendlingf6fb7ed2011-10-12 23:03:40 +0000512
Evan Cheng2938a002010-03-10 02:12:03 +0000513 if (!isProfitableToCSE(NewReg, OldReg, CSMI, MI)) {
Nick Lewycky7a7a6db2012-07-05 06:19:21 +0000514 DEBUG(dbgs() << "*** Not profitable, avoid CSE!\n");
Evan Cheng31f94c72010-03-09 03:21:12 +0000515 DoCSE = false;
516 break;
517 }
Bill Wendlingf6fb7ed2011-10-12 23:03:40 +0000518
519 // Don't perform CSE if the result of the old instruction cannot exist
520 // within the register class of the new instruction.
521 const TargetRegisterClass *OldRC = MRI->getRegClass(OldReg);
522 if (!MRI->constrainRegClass(NewReg, OldRC)) {
Nick Lewycky7a7a6db2012-07-05 06:19:21 +0000523 DEBUG(dbgs() << "*** Not the same register class, avoid CSE!\n");
Bill Wendlingf6fb7ed2011-10-12 23:03:40 +0000524 DoCSE = false;
525 break;
526 }
527
Evan Cheng31f94c72010-03-09 03:21:12 +0000528 CSEPairs.push_back(std::make_pair(OldReg, NewReg));
Evan Cheng16b48b82010-03-03 21:20:05 +0000529 --NumDefs;
530 }
Evan Cheng31f94c72010-03-09 03:21:12 +0000531
532 // Actually perform the elimination.
533 if (DoCSE) {
Dan Gohman49b45892010-05-13 19:24:00 +0000534 for (unsigned i = 0, e = CSEPairs.size(); i != e; ++i) {
Evan Cheng31f94c72010-03-09 03:21:12 +0000535 MRI->replaceRegWith(CSEPairs[i].first, CSEPairs[i].second);
Dan Gohman49b45892010-05-13 19:24:00 +0000536 MRI->clearKillFlags(CSEPairs[i].second);
537 }
Evan Cheng97b5beb2012-01-10 02:02:58 +0000538
Manman Ren39ad5682012-08-08 00:51:41 +0000539 // Go through implicit defs of CSMI and MI, if a def is not dead at MI,
540 // we should make sure it is not dead at CSMI.
541 for (unsigned i = 0, e = ImplicitDefsToUpdate.size(); i != e; ++i)
542 CSMI->getOperand(ImplicitDefsToUpdate[i]).setIsDead(false);
543
Evan Cheng97b5beb2012-01-10 02:02:58 +0000544 if (CrossMBBPhysDef) {
545 // Add physical register defs now coming in from a predecessor to MBB
546 // livein list.
547 while (!PhysDefs.empty()) {
548 unsigned LiveIn = PhysDefs.pop_back_val();
549 if (!MBB->isLiveIn(LiveIn))
550 MBB->addLiveIn(LiveIn);
551 }
552 ++NumCrossBBCSEs;
553 }
554
Evan Cheng31f94c72010-03-09 03:21:12 +0000555 MI->eraseFromParent();
556 ++NumCSEs;
Evan Cheng189c1ec2010-10-29 23:36:03 +0000557 if (!PhysRefs.empty())
Evan Cheng2b4e7272010-06-04 23:28:13 +0000558 ++NumPhysCSEs;
Evan Chenga63cde22010-12-15 22:16:21 +0000559 if (Commuted)
560 ++NumCommutes;
Evan Chengcfea9852011-04-11 18:47:20 +0000561 Changed = true;
Evan Cheng31f94c72010-03-09 03:21:12 +0000562 } else {
Evan Cheng31f94c72010-03-09 03:21:12 +0000563 VNT.insert(MI, CurrVN++);
564 Exps.push_back(MI);
565 }
566 CSEPairs.clear();
Manman Ren39ad5682012-08-08 00:51:41 +0000567 ImplicitDefsToUpdate.clear();
Evan Cheng6ba95542010-03-03 02:48:20 +0000568 }
569
Evan Cheng31156982010-04-21 00:21:07 +0000570 return Changed;
571}
572
573/// ExitScopeIfDone - Destroy scope for the MBB that corresponds to the given
574/// dominator tree node if its a leaf or all of its children are done. Walk
575/// up the dominator tree to destroy ancestors which are now done.
576void
577MachineCSE::ExitScopeIfDone(MachineDomTreeNode *Node,
Nick Lewycky7a7a6db2012-07-05 06:19:21 +0000578 DenseMap<MachineDomTreeNode*, unsigned> &OpenChildren) {
Evan Cheng31156982010-04-21 00:21:07 +0000579 if (OpenChildren[Node])
580 return;
581
582 // Pop scope.
583 ExitScope(Node->getBlock());
584
585 // Now traverse upwards to pop ancestors whose offsprings are all done.
Nick Lewycky7a7a6db2012-07-05 06:19:21 +0000586 while (MachineDomTreeNode *Parent = Node->getIDom()) {
Evan Cheng31156982010-04-21 00:21:07 +0000587 unsigned Left = --OpenChildren[Parent];
588 if (Left != 0)
589 break;
590 ExitScope(Parent->getBlock());
591 Node = Parent;
592 }
593}
594
595bool MachineCSE::PerformCSE(MachineDomTreeNode *Node) {
596 SmallVector<MachineDomTreeNode*, 32> Scopes;
597 SmallVector<MachineDomTreeNode*, 8> WorkList;
Evan Cheng31156982010-04-21 00:21:07 +0000598 DenseMap<MachineDomTreeNode*, unsigned> OpenChildren;
599
Evan Chengc2b768f2010-09-17 21:59:42 +0000600 CurrVN = 0;
601
Evan Cheng31156982010-04-21 00:21:07 +0000602 // Perform a DFS walk to determine the order of visit.
603 WorkList.push_back(Node);
604 do {
605 Node = WorkList.pop_back_val();
606 Scopes.push_back(Node);
607 const std::vector<MachineDomTreeNode*> &Children = Node->getChildren();
608 unsigned NumChildren = Children.size();
609 OpenChildren[Node] = NumChildren;
610 for (unsigned i = 0; i != NumChildren; ++i) {
611 MachineDomTreeNode *Child = Children[i];
Evan Cheng31156982010-04-21 00:21:07 +0000612 WorkList.push_back(Child);
613 }
614 } while (!WorkList.empty());
615
616 // Now perform CSE.
617 bool Changed = false;
618 for (unsigned i = 0, e = Scopes.size(); i != e; ++i) {
619 MachineDomTreeNode *Node = Scopes[i];
620 MachineBasicBlock *MBB = Node->getBlock();
621 EnterScope(MBB);
622 Changed |= ProcessBlock(MBB);
623 // If it's a leaf node, it's done. Traverse upwards to pop ancestors.
Nick Lewycky7a7a6db2012-07-05 06:19:21 +0000624 ExitScopeIfDone(Node, OpenChildren);
Evan Cheng31156982010-04-21 00:21:07 +0000625 }
Evan Cheng6ba95542010-03-03 02:48:20 +0000626
627 return Changed;
628}
629
Evan Chengc6fe3332010-03-02 02:38:24 +0000630bool MachineCSE::runOnMachineFunction(MachineFunction &MF) {
Evan Cheng6ba95542010-03-03 02:48:20 +0000631 TII = MF.getTarget().getInstrInfo();
Evan Chengb3958e82010-03-04 01:33:55 +0000632 TRI = MF.getTarget().getRegisterInfo();
Evan Cheng6ba95542010-03-03 02:48:20 +0000633 MRI = &MF.getRegInfo();
Evan Chenga5f32cb2010-03-04 21:18:08 +0000634 AA = &getAnalysis<AliasAnalysis>();
Evan Cheng31f94c72010-03-09 03:21:12 +0000635 DT = &getAnalysis<MachineDominatorTree>();
Lang Hamesc2e08db2012-02-17 00:27:16 +0000636 AllocatableRegs = TRI->getAllocatableSet(MF);
637 ReservedRegs = TRI->getReservedRegs(MF);
Evan Cheng31156982010-04-21 00:21:07 +0000638 return PerformCSE(DT->getRootNode());
Evan Chengc6fe3332010-03-02 02:38:24 +0000639}