blob: 896461fd194b52936db2b67755f419337cf91cfe [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;
Benjamin Kramer5fa2d452012-08-11 20:42:59 +0000218 // Reading constant physregs is ok.
219 if (!MRI->isConstantPhysReg(Reg, *MBB->getParent()))
220 for (MCRegAliasIterator AI(Reg, TRI, true); AI.isValid(); ++AI)
Benjamin Kramercfc0ad62012-08-11 19:05:13 +0000221 PhysRefs.insert(*AI);
Evan Cheng97b5beb2012-01-10 02:02:58 +0000222 if (MO.isDef())
223 PhysDefs.push_back(Reg);
Evan Chengb3958e82010-03-04 01:33:55 +0000224 }
225
Evan Cheng189c1ec2010-10-29 23:36:03 +0000226 return !PhysRefs.empty();
Evan Chengc6fe3332010-03-02 02:38:24 +0000227}
228
Evan Cheng189c1ec2010-10-29 23:36:03 +0000229bool MachineCSE::PhysRegDefsReach(MachineInstr *CSMI, MachineInstr *MI,
Evan Cheng97b5beb2012-01-10 02:02:58 +0000230 SmallSet<unsigned,8> &PhysRefs,
Evan Chengf96703e2012-01-11 00:38:11 +0000231 SmallVector<unsigned,2> &PhysDefs,
Evan Cheng97b5beb2012-01-10 02:02:58 +0000232 bool &NonLocal) const {
Eli Friedman5e926ac2011-05-06 05:23:07 +0000233 // For now conservatively returns false if the common subexpression is
Evan Cheng97b5beb2012-01-10 02:02:58 +0000234 // not in the same basic block as the given instruction. The only exception
235 // is if the common subexpression is in the sole predecessor block.
236 const MachineBasicBlock *MBB = MI->getParent();
237 const MachineBasicBlock *CSMBB = CSMI->getParent();
238
239 bool CrossMBB = false;
240 if (CSMBB != MBB) {
Evan Chengf96703e2012-01-11 00:38:11 +0000241 if (MBB->pred_size() != 1 || *MBB->pred_begin() != CSMBB)
Evan Cheng97b5beb2012-01-10 02:02:58 +0000242 return false;
Evan Chengf96703e2012-01-11 00:38:11 +0000243
244 for (unsigned i = 0, e = PhysDefs.size(); i != e; ++i) {
Lang Hamesc2e08db2012-02-17 00:27:16 +0000245 if (AllocatableRegs.test(PhysDefs[i]) || ReservedRegs.test(PhysDefs[i]))
246 // Avoid extending live range of physical registers if they are
247 //allocatable or reserved.
Evan Chengf96703e2012-01-11 00:38:11 +0000248 return false;
249 }
250 CrossMBB = true;
Evan Cheng97b5beb2012-01-10 02:02:58 +0000251 }
Eli Friedman5e926ac2011-05-06 05:23:07 +0000252 MachineBasicBlock::const_iterator I = CSMI; I = llvm::next(I);
253 MachineBasicBlock::const_iterator E = MI;
Evan Cheng97b5beb2012-01-10 02:02:58 +0000254 MachineBasicBlock::const_iterator EE = CSMBB->end();
Evan Cheng835810b2010-05-21 21:22:19 +0000255 unsigned LookAheadLeft = LookAheadLimit;
256 while (LookAheadLeft) {
Eli Friedman5e926ac2011-05-06 05:23:07 +0000257 // Skip over dbg_value's.
Evan Cheng97b5beb2012-01-10 02:02:58 +0000258 while (I != E && I != EE && I->isDebugValue())
Evan Cheng835810b2010-05-21 21:22:19 +0000259 ++I;
Eli Friedman5e926ac2011-05-06 05:23:07 +0000260
Evan Cheng97b5beb2012-01-10 02:02:58 +0000261 if (I == EE) {
262 assert(CrossMBB && "Reaching end-of-MBB without finding MI?");
Duncan Sands5b8a1db2012-02-05 14:20:11 +0000263 (void)CrossMBB;
Evan Cheng97b5beb2012-01-10 02:02:58 +0000264 CrossMBB = false;
265 NonLocal = true;
266 I = MBB->begin();
267 EE = MBB->end();
268 continue;
269 }
270
Eli Friedman5e926ac2011-05-06 05:23:07 +0000271 if (I == E)
272 return true;
273
274 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
275 const MachineOperand &MO = I->getOperand(i);
Jakob Stoklund Olesen2129a0f2012-02-28 02:08:50 +0000276 // RegMasks go on instructions like calls that clobber lots of physregs.
277 // Don't attempt to CSE across such an instruction.
278 if (MO.isRegMask())
279 return false;
Eli Friedman5e926ac2011-05-06 05:23:07 +0000280 if (!MO.isReg() || !MO.isDef())
281 continue;
282 unsigned MOReg = MO.getReg();
283 if (TargetRegisterInfo::isVirtualRegister(MOReg))
284 continue;
285 if (PhysRefs.count(MOReg))
286 return false;
Evan Cheng189c1ec2010-10-29 23:36:03 +0000287 }
Eli Friedman5e926ac2011-05-06 05:23:07 +0000288
289 --LookAheadLeft;
290 ++I;
Evan Cheng835810b2010-05-21 21:22:19 +0000291 }
292
293 return false;
294}
295
Evan Chenga5f32cb2010-03-04 21:18:08 +0000296bool MachineCSE::isCSECandidate(MachineInstr *MI) {
Evan Cheng51960182010-03-08 23:49:12 +0000297 if (MI->isLabel() || MI->isPHI() || MI->isImplicitDef() ||
Dale Johannesene68ea062010-03-11 02:10:24 +0000298 MI->isKill() || MI->isInlineAsm() || MI->isDebugValue())
Evan Cheng51960182010-03-08 23:49:12 +0000299 return false;
300
Evan Cheng2938a002010-03-10 02:12:03 +0000301 // Ignore copies.
Jakob Stoklund Olesen04c528a2010-07-16 04:45:42 +0000302 if (MI->isCopyLike())
Evan Chenga5f32cb2010-03-04 21:18:08 +0000303 return false;
304
305 // Ignore stuff that we obviously can't move.
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000306 if (MI->mayStore() || MI->isCall() || MI->isTerminator() ||
Evan Chengc36b7062011-01-07 23:50:32 +0000307 MI->hasUnmodeledSideEffects())
Evan Chenga5f32cb2010-03-04 21:18:08 +0000308 return false;
309
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000310 if (MI->mayLoad()) {
Evan Chenga5f32cb2010-03-04 21:18:08 +0000311 // Okay, this instruction does a load. As a refinement, we allow the target
312 // to decide whether the loaded value is actually a constant. If so, we can
313 // actually use it as a load.
314 if (!MI->isInvariantLoad(AA))
315 // FIXME: we should be able to hoist loads with no other side effects if
316 // there are no other instructions which can change memory in this loop.
317 // This is a trivial form of alias analysis.
318 return false;
319 }
320 return true;
321}
322
Evan Cheng31f94c72010-03-09 03:21:12 +0000323/// isProfitableToCSE - Return true if it's profitable to eliminate MI with a
324/// common expression that defines Reg.
Evan Cheng2938a002010-03-10 02:12:03 +0000325bool MachineCSE::isProfitableToCSE(unsigned CSReg, unsigned Reg,
326 MachineInstr *CSMI, MachineInstr *MI) {
327 // FIXME: Heuristics that works around the lack the live range splitting.
328
Manman Renba86b132012-08-07 06:16:46 +0000329 // If CSReg is used at all uses of Reg, CSE should not increase register
330 // pressure of CSReg.
331 bool MayIncreasePressure = true;
332 if (TargetRegisterInfo::isVirtualRegister(CSReg) &&
333 TargetRegisterInfo::isVirtualRegister(Reg)) {
334 MayIncreasePressure = false;
335 SmallPtrSet<MachineInstr*, 8> CSUses;
336 for (MachineRegisterInfo::use_nodbg_iterator I =MRI->use_nodbg_begin(CSReg),
337 E = MRI->use_nodbg_end(); I != E; ++I) {
338 MachineInstr *Use = &*I;
339 CSUses.insert(Use);
340 }
341 for (MachineRegisterInfo::use_nodbg_iterator I = MRI->use_nodbg_begin(Reg),
342 E = MRI->use_nodbg_end(); I != E; ++I) {
343 MachineInstr *Use = &*I;
344 if (!CSUses.count(Use)) {
345 MayIncreasePressure = true;
346 break;
347 }
348 }
349 }
350 if (!MayIncreasePressure) return true;
351
Chris Lattner622a11b2011-01-10 07:51:31 +0000352 // Heuristics #1: Don't CSE "cheap" computation if the def is not local or in
353 // an immediate predecessor. We don't want to increase register pressure and
354 // end up causing other computation to be spilled.
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000355 if (MI->isAsCheapAsAMove()) {
Evan Cheng2938a002010-03-10 02:12:03 +0000356 MachineBasicBlock *CSBB = CSMI->getParent();
357 MachineBasicBlock *BB = MI->getParent();
Chris Lattner622a11b2011-01-10 07:51:31 +0000358 if (CSBB != BB && !CSBB->isSuccessor(BB))
Evan Cheng2938a002010-03-10 02:12:03 +0000359 return false;
360 }
361
362 // Heuristics #2: If the expression doesn't not use a vr and the only use
363 // of the redundant computation are copies, do not cse.
364 bool HasVRegUse = false;
365 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
366 const MachineOperand &MO = MI->getOperand(i);
Jakob Stoklund Olesenc9df0252011-01-10 02:58:51 +0000367 if (MO.isReg() && MO.isUse() &&
Evan Cheng2938a002010-03-10 02:12:03 +0000368 TargetRegisterInfo::isVirtualRegister(MO.getReg())) {
369 HasVRegUse = true;
370 break;
371 }
372 }
373 if (!HasVRegUse) {
374 bool HasNonCopyUse = false;
375 for (MachineRegisterInfo::use_nodbg_iterator I = MRI->use_nodbg_begin(Reg),
376 E = MRI->use_nodbg_end(); I != E; ++I) {
377 MachineInstr *Use = &*I;
378 // Ignore copies.
Jakob Stoklund Olesen04c528a2010-07-16 04:45:42 +0000379 if (!Use->isCopyLike()) {
Evan Cheng2938a002010-03-10 02:12:03 +0000380 HasNonCopyUse = true;
381 break;
382 }
383 }
384 if (!HasNonCopyUse)
385 return false;
386 }
387
388 // Heuristics #3: If the common subexpression is used by PHIs, do not reuse
389 // it unless the defined value is already used in the BB of the new use.
Evan Cheng31f94c72010-03-09 03:21:12 +0000390 bool HasPHI = false;
391 SmallPtrSet<MachineBasicBlock*, 4> CSBBs;
Evan Cheng2938a002010-03-10 02:12:03 +0000392 for (MachineRegisterInfo::use_nodbg_iterator I = MRI->use_nodbg_begin(CSReg),
Evan Cheng31f94c72010-03-09 03:21:12 +0000393 E = MRI->use_nodbg_end(); I != E; ++I) {
394 MachineInstr *Use = &*I;
395 HasPHI |= Use->isPHI();
396 CSBBs.insert(Use->getParent());
397 }
398
399 if (!HasPHI)
400 return true;
401 return CSBBs.count(MI->getParent());
402}
403
Evan Cheng31156982010-04-21 00:21:07 +0000404void MachineCSE::EnterScope(MachineBasicBlock *MBB) {
405 DEBUG(dbgs() << "Entering: " << MBB->getName() << '\n');
406 ScopeType *Scope = new ScopeType(VNT);
407 ScopeMap[MBB] = Scope;
408}
409
410void MachineCSE::ExitScope(MachineBasicBlock *MBB) {
411 DEBUG(dbgs() << "Exiting: " << MBB->getName() << '\n');
412 DenseMap<MachineBasicBlock*, ScopeType*>::iterator SI = ScopeMap.find(MBB);
413 assert(SI != ScopeMap.end());
414 ScopeMap.erase(SI);
415 delete SI->second;
416}
417
418bool MachineCSE::ProcessBlock(MachineBasicBlock *MBB) {
Evan Cheng6ba95542010-03-03 02:48:20 +0000419 bool Changed = false;
420
Evan Cheng31f94c72010-03-09 03:21:12 +0000421 SmallVector<std::pair<unsigned, unsigned>, 8> CSEPairs;
Manman Ren39ad5682012-08-08 00:51:41 +0000422 SmallVector<unsigned, 2> ImplicitDefsToUpdate;
Evan Cheng16b48b82010-03-03 21:20:05 +0000423 for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end(); I != E; ) {
Evan Cheng6ba95542010-03-03 02:48:20 +0000424 MachineInstr *MI = &*I;
Evan Cheng16b48b82010-03-03 21:20:05 +0000425 ++I;
Evan Chenga5f32cb2010-03-04 21:18:08 +0000426
427 if (!isCSECandidate(MI))
Evan Cheng6ba95542010-03-03 02:48:20 +0000428 continue;
Evan Cheng6ba95542010-03-03 02:48:20 +0000429
430 bool FoundCSE = VNT.count(MI);
431 if (!FoundCSE) {
432 // Look for trivial copy coalescing opportunities.
Evan Chengdb8771a2010-04-02 02:21:24 +0000433 if (PerformTrivialCoalescing(MI, MBB)) {
Evan Chengcfea9852011-04-11 18:47:20 +0000434 Changed = true;
435
Evan Chengdb8771a2010-04-02 02:21:24 +0000436 // After coalescing MI itself may become a copy.
Jakob Stoklund Olesen04c528a2010-07-16 04:45:42 +0000437 if (MI->isCopyLike())
Evan Chengdb8771a2010-04-02 02:21:24 +0000438 continue;
Evan Cheng6ba95542010-03-03 02:48:20 +0000439 FoundCSE = VNT.count(MI);
Evan Chengdb8771a2010-04-02 02:21:24 +0000440 }
Evan Cheng6ba95542010-03-03 02:48:20 +0000441 }
Evan Chenga63cde22010-12-15 22:16:21 +0000442
443 // Commute commutable instructions.
444 bool Commuted = false;
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000445 if (!FoundCSE && MI->isCommutable()) {
Evan Chenga63cde22010-12-15 22:16:21 +0000446 MachineInstr *NewMI = TII->commuteInstruction(MI);
447 if (NewMI) {
448 Commuted = true;
449 FoundCSE = VNT.count(NewMI);
Evan Chengcfea9852011-04-11 18:47:20 +0000450 if (NewMI != MI) {
Evan Chenga63cde22010-12-15 22:16:21 +0000451 // New instruction. It doesn't need to be kept.
452 NewMI->eraseFromParent();
Evan Chengcfea9852011-04-11 18:47:20 +0000453 Changed = true;
454 } else if (!FoundCSE)
Evan Chenga63cde22010-12-15 22:16:21 +0000455 // MI was changed but it didn't help, commute it back!
456 (void)TII->commuteInstruction(MI);
457 }
458 }
Evan Cheng6ba95542010-03-03 02:48:20 +0000459
Evan Cheng189c1ec2010-10-29 23:36:03 +0000460 // If the instruction defines physical registers and the values *may* be
Evan Cheng67bda722010-03-03 23:59:08 +0000461 // used, then it's not safe to replace it with a common subexpression.
Evan Cheng189c1ec2010-10-29 23:36:03 +0000462 // It's also not safe if the instruction uses physical registers.
Evan Cheng97b5beb2012-01-10 02:02:58 +0000463 bool CrossMBBPhysDef = false;
Nick Lewycky7a7a6db2012-07-05 06:19:21 +0000464 SmallSet<unsigned, 8> PhysRefs;
Evan Cheng97b5beb2012-01-10 02:02:58 +0000465 SmallVector<unsigned, 2> PhysDefs;
466 if (FoundCSE && hasLivePhysRegDefUses(MI, MBB, PhysRefs, PhysDefs)) {
Evan Cheng67bda722010-03-03 23:59:08 +0000467 FoundCSE = false;
468
Evan Cheng97b5beb2012-01-10 02:02:58 +0000469 // ... Unless the CS is local or is in the sole predecessor block
470 // and it also defines the physical register which is not clobbered
471 // in between and the physical register uses were not clobbered.
Evan Cheng189c1ec2010-10-29 23:36:03 +0000472 unsigned CSVN = VNT.lookup(MI);
473 MachineInstr *CSMI = Exps[CSVN];
Evan Chengf96703e2012-01-11 00:38:11 +0000474 if (PhysRegDefsReach(CSMI, MI, PhysRefs, PhysDefs, CrossMBBPhysDef))
Evan Cheng189c1ec2010-10-29 23:36:03 +0000475 FoundCSE = true;
Evan Cheng835810b2010-05-21 21:22:19 +0000476 }
477
Evan Cheng16b48b82010-03-03 21:20:05 +0000478 if (!FoundCSE) {
479 VNT.insert(MI, CurrVN++);
480 Exps.push_back(MI);
481 continue;
482 }
483
484 // Found a common subexpression, eliminate it.
485 unsigned CSVN = VNT.lookup(MI);
486 MachineInstr *CSMI = Exps[CSVN];
487 DEBUG(dbgs() << "Examining: " << *MI);
488 DEBUG(dbgs() << "*** Found a common subexpression: " << *CSMI);
Evan Cheng31f94c72010-03-09 03:21:12 +0000489
490 // Check if it's profitable to perform this CSE.
491 bool DoCSE = true;
Manman Ren39ad5682012-08-08 00:51:41 +0000492 unsigned NumDefs = MI->getDesc().getNumDefs() +
493 MI->getDesc().getNumImplicitDefs();
494
Evan Cheng16b48b82010-03-03 21:20:05 +0000495 for (unsigned i = 0, e = MI->getNumOperands(); NumDefs && i != e; ++i) {
496 MachineOperand &MO = MI->getOperand(i);
497 if (!MO.isReg() || !MO.isDef())
498 continue;
499 unsigned OldReg = MO.getReg();
500 unsigned NewReg = CSMI->getOperand(i).getReg();
Manman Ren39ad5682012-08-08 00:51:41 +0000501
502 // Go through implicit defs of CSMI and MI, if a def is not dead at MI,
503 // we should make sure it is not dead at CSMI.
504 if (MO.isImplicit() && !MO.isDead() && CSMI->getOperand(i).isDead())
505 ImplicitDefsToUpdate.push_back(i);
506 if (OldReg == NewReg) {
507 --NumDefs;
Evan Cheng6cc1aea2010-03-06 01:14:19 +0000508 continue;
Manman Ren39ad5682012-08-08 00:51:41 +0000509 }
Bill Wendlingf6fb7ed2011-10-12 23:03:40 +0000510
Evan Cheng6cc1aea2010-03-06 01:14:19 +0000511 assert(TargetRegisterInfo::isVirtualRegister(OldReg) &&
Evan Cheng16b48b82010-03-03 21:20:05 +0000512 TargetRegisterInfo::isVirtualRegister(NewReg) &&
513 "Do not CSE physical register defs!");
Bill Wendlingf6fb7ed2011-10-12 23:03:40 +0000514
Evan Cheng2938a002010-03-10 02:12:03 +0000515 if (!isProfitableToCSE(NewReg, OldReg, CSMI, MI)) {
Nick Lewycky7a7a6db2012-07-05 06:19:21 +0000516 DEBUG(dbgs() << "*** Not profitable, avoid CSE!\n");
Evan Cheng31f94c72010-03-09 03:21:12 +0000517 DoCSE = false;
518 break;
519 }
Bill Wendlingf6fb7ed2011-10-12 23:03:40 +0000520
521 // Don't perform CSE if the result of the old instruction cannot exist
522 // within the register class of the new instruction.
523 const TargetRegisterClass *OldRC = MRI->getRegClass(OldReg);
524 if (!MRI->constrainRegClass(NewReg, OldRC)) {
Nick Lewycky7a7a6db2012-07-05 06:19:21 +0000525 DEBUG(dbgs() << "*** Not the same register class, avoid CSE!\n");
Bill Wendlingf6fb7ed2011-10-12 23:03:40 +0000526 DoCSE = false;
527 break;
528 }
529
Evan Cheng31f94c72010-03-09 03:21:12 +0000530 CSEPairs.push_back(std::make_pair(OldReg, NewReg));
Evan Cheng16b48b82010-03-03 21:20:05 +0000531 --NumDefs;
532 }
Evan Cheng31f94c72010-03-09 03:21:12 +0000533
534 // Actually perform the elimination.
535 if (DoCSE) {
Dan Gohman49b45892010-05-13 19:24:00 +0000536 for (unsigned i = 0, e = CSEPairs.size(); i != e; ++i) {
Evan Cheng31f94c72010-03-09 03:21:12 +0000537 MRI->replaceRegWith(CSEPairs[i].first, CSEPairs[i].second);
Dan Gohman49b45892010-05-13 19:24:00 +0000538 MRI->clearKillFlags(CSEPairs[i].second);
539 }
Evan Cheng97b5beb2012-01-10 02:02:58 +0000540
Manman Ren39ad5682012-08-08 00:51:41 +0000541 // Go through implicit defs of CSMI and MI, if a def is not dead at MI,
542 // we should make sure it is not dead at CSMI.
543 for (unsigned i = 0, e = ImplicitDefsToUpdate.size(); i != e; ++i)
544 CSMI->getOperand(ImplicitDefsToUpdate[i]).setIsDead(false);
545
Evan Cheng97b5beb2012-01-10 02:02:58 +0000546 if (CrossMBBPhysDef) {
547 // Add physical register defs now coming in from a predecessor to MBB
548 // livein list.
549 while (!PhysDefs.empty()) {
550 unsigned LiveIn = PhysDefs.pop_back_val();
551 if (!MBB->isLiveIn(LiveIn))
552 MBB->addLiveIn(LiveIn);
553 }
554 ++NumCrossBBCSEs;
555 }
556
Evan Cheng31f94c72010-03-09 03:21:12 +0000557 MI->eraseFromParent();
558 ++NumCSEs;
Evan Cheng189c1ec2010-10-29 23:36:03 +0000559 if (!PhysRefs.empty())
Evan Cheng2b4e7272010-06-04 23:28:13 +0000560 ++NumPhysCSEs;
Evan Chenga63cde22010-12-15 22:16:21 +0000561 if (Commuted)
562 ++NumCommutes;
Evan Chengcfea9852011-04-11 18:47:20 +0000563 Changed = true;
Evan Cheng31f94c72010-03-09 03:21:12 +0000564 } else {
Evan Cheng31f94c72010-03-09 03:21:12 +0000565 VNT.insert(MI, CurrVN++);
566 Exps.push_back(MI);
567 }
568 CSEPairs.clear();
Manman Ren39ad5682012-08-08 00:51:41 +0000569 ImplicitDefsToUpdate.clear();
Evan Cheng6ba95542010-03-03 02:48:20 +0000570 }
571
Evan Cheng31156982010-04-21 00:21:07 +0000572 return Changed;
573}
574
575/// ExitScopeIfDone - Destroy scope for the MBB that corresponds to the given
576/// dominator tree node if its a leaf or all of its children are done. Walk
577/// up the dominator tree to destroy ancestors which are now done.
578void
579MachineCSE::ExitScopeIfDone(MachineDomTreeNode *Node,
Nick Lewycky7a7a6db2012-07-05 06:19:21 +0000580 DenseMap<MachineDomTreeNode*, unsigned> &OpenChildren) {
Evan Cheng31156982010-04-21 00:21:07 +0000581 if (OpenChildren[Node])
582 return;
583
584 // Pop scope.
585 ExitScope(Node->getBlock());
586
587 // Now traverse upwards to pop ancestors whose offsprings are all done.
Nick Lewycky7a7a6db2012-07-05 06:19:21 +0000588 while (MachineDomTreeNode *Parent = Node->getIDom()) {
Evan Cheng31156982010-04-21 00:21:07 +0000589 unsigned Left = --OpenChildren[Parent];
590 if (Left != 0)
591 break;
592 ExitScope(Parent->getBlock());
593 Node = Parent;
594 }
595}
596
597bool MachineCSE::PerformCSE(MachineDomTreeNode *Node) {
598 SmallVector<MachineDomTreeNode*, 32> Scopes;
599 SmallVector<MachineDomTreeNode*, 8> WorkList;
Evan Cheng31156982010-04-21 00:21:07 +0000600 DenseMap<MachineDomTreeNode*, unsigned> OpenChildren;
601
Evan Chengc2b768f2010-09-17 21:59:42 +0000602 CurrVN = 0;
603
Evan Cheng31156982010-04-21 00:21:07 +0000604 // Perform a DFS walk to determine the order of visit.
605 WorkList.push_back(Node);
606 do {
607 Node = WorkList.pop_back_val();
608 Scopes.push_back(Node);
609 const std::vector<MachineDomTreeNode*> &Children = Node->getChildren();
610 unsigned NumChildren = Children.size();
611 OpenChildren[Node] = NumChildren;
612 for (unsigned i = 0; i != NumChildren; ++i) {
613 MachineDomTreeNode *Child = Children[i];
Evan Cheng31156982010-04-21 00:21:07 +0000614 WorkList.push_back(Child);
615 }
616 } while (!WorkList.empty());
617
618 // Now perform CSE.
619 bool Changed = false;
620 for (unsigned i = 0, e = Scopes.size(); i != e; ++i) {
621 MachineDomTreeNode *Node = Scopes[i];
622 MachineBasicBlock *MBB = Node->getBlock();
623 EnterScope(MBB);
624 Changed |= ProcessBlock(MBB);
625 // If it's a leaf node, it's done. Traverse upwards to pop ancestors.
Nick Lewycky7a7a6db2012-07-05 06:19:21 +0000626 ExitScopeIfDone(Node, OpenChildren);
Evan Cheng31156982010-04-21 00:21:07 +0000627 }
Evan Cheng6ba95542010-03-03 02:48:20 +0000628
629 return Changed;
630}
631
Evan Chengc6fe3332010-03-02 02:38:24 +0000632bool MachineCSE::runOnMachineFunction(MachineFunction &MF) {
Evan Cheng6ba95542010-03-03 02:48:20 +0000633 TII = MF.getTarget().getInstrInfo();
Evan Chengb3958e82010-03-04 01:33:55 +0000634 TRI = MF.getTarget().getRegisterInfo();
Evan Cheng6ba95542010-03-03 02:48:20 +0000635 MRI = &MF.getRegInfo();
Evan Chenga5f32cb2010-03-04 21:18:08 +0000636 AA = &getAnalysis<AliasAnalysis>();
Evan Cheng31f94c72010-03-09 03:21:12 +0000637 DT = &getAnalysis<MachineDominatorTree>();
Lang Hamesc2e08db2012-02-17 00:27:16 +0000638 AllocatableRegs = TRI->getAllocatableSet(MF);
639 ReservedRegs = TRI->getReservedRegs(MF);
Evan Cheng31156982010-04-21 00:21:07 +0000640 return PerformCSE(DT->getRootNode());
Evan Chengc6fe3332010-03-02 02:38:24 +0000641}