1 //===-- MachineCSE.cpp - Machine Common Subexpression Elimination Pass ----===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This pass performs global common subexpression elimination on machine
11 // instructions using a scoped hash table based value numbering scheme. It
12 // must be run while the machine function is still in SSA form.
14 //===----------------------------------------------------------------------===//
16 #define DEBUG_TYPE "machine-cse"
17 #include "llvm/CodeGen/Passes.h"
18 #include "llvm/CodeGen/MachineDominators.h"
19 #include "llvm/CodeGen/MachineInstr.h"
20 #include "llvm/CodeGen/MachineRegisterInfo.h"
21 #include "llvm/Analysis/AliasAnalysis.h"
22 #include "llvm/Target/TargetInstrInfo.h"
23 #include "llvm/ADT/ScopedHashTable.h"
24 #include "llvm/ADT/Statistic.h"
25 #include "llvm/Support/Debug.h"
29 STATISTIC(NumCoalesces, "Number of copies coalesced");
30 STATISTIC(NumCSEs, "Number of common subexpression eliminated");
33 class MachineCSE : public MachineFunctionPass {
34 const TargetInstrInfo *TII;
35 const TargetRegisterInfo *TRI;
36 MachineRegisterInfo *MRI;
37 MachineDominatorTree *DT;
40 static char ID; // Pass identification
41 MachineCSE() : MachineFunctionPass(&ID), CurrVN(0) {}
43 virtual bool runOnMachineFunction(MachineFunction &MF);
45 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
47 MachineFunctionPass::getAnalysisUsage(AU);
48 AU.addRequired<AliasAnalysis>();
49 AU.addRequired<MachineDominatorTree>();
50 AU.addPreserved<MachineDominatorTree>();
55 ScopedHashTable<MachineInstr*, unsigned, MachineInstrExpressionTrait> VNT;
56 SmallVector<MachineInstr*, 64> Exps;
58 bool PerformTrivialCoalescing(MachineInstr *MI, MachineBasicBlock *MBB);
59 bool isPhysDefTriviallyDead(unsigned Reg,
60 MachineBasicBlock::const_iterator I,
61 MachineBasicBlock::const_iterator E);
62 bool hasLivePhysRegDefUse(MachineInstr *MI, MachineBasicBlock *MBB);
63 bool isCSECandidate(MachineInstr *MI);
64 bool ProcessBlock(MachineDomTreeNode *Node);
66 } // end anonymous namespace
68 char MachineCSE::ID = 0;
69 static RegisterPass<MachineCSE>
70 X("machine-cse", "Machine Common Subexpression Elimination");
72 FunctionPass *llvm::createMachineCSEPass() { return new MachineCSE(); }
74 bool MachineCSE::PerformTrivialCoalescing(MachineInstr *MI,
75 MachineBasicBlock *MBB) {
77 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
78 MachineOperand &MO = MI->getOperand(i);
79 if (!MO.isReg() || !MO.isUse())
81 unsigned Reg = MO.getReg();
82 if (!Reg || TargetRegisterInfo::isPhysicalRegister(Reg))
84 if (!MRI->hasOneUse(Reg))
85 // Only coalesce single use copies. This ensure the copy will be
88 MachineInstr *DefMI = MRI->getVRegDef(Reg);
89 if (DefMI->getParent() != MBB)
91 unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
92 if (TII->isMoveInstr(*DefMI, SrcReg, DstReg, SrcSubIdx, DstSubIdx) &&
93 TargetRegisterInfo::isVirtualRegister(SrcReg) &&
94 !SrcSubIdx && !DstSubIdx) {
96 DefMI->eraseFromParent();
105 bool MachineCSE::isPhysDefTriviallyDead(unsigned Reg,
106 MachineBasicBlock::const_iterator I,
107 MachineBasicBlock::const_iterator E) {
108 unsigned LookAheadLeft = 5;
109 while (LookAheadLeft--) {
111 // Reached end of block, register is obviously dead.
114 if (I->isDebugValue())
116 bool SeenDef = false;
117 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
118 const MachineOperand &MO = I->getOperand(i);
119 if (!MO.isReg() || !MO.getReg())
121 if (!TRI->regsOverlap(MO.getReg(), Reg))
128 // See a def of Reg (or an alias) before encountering any use, it's
136 bool MachineCSE::hasLivePhysRegDefUse(MachineInstr *MI, MachineBasicBlock *MBB){
137 unsigned PhysDef = 0;
138 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
139 MachineOperand &MO = MI->getOperand(i);
142 unsigned Reg = MO.getReg();
145 if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
147 // Can't touch anything to read a physical register.
150 // If the def is dead, it's ok.
152 // Ok, this is a physical register def that's not marked "dead". That's
153 // common since this pass is run before livevariables. We can scan
154 // forward a few instructions and check if it is obviously dead.
156 // Multiple physical register defs. These are rare, forget about it.
163 MachineBasicBlock::iterator I = MI; I = llvm::next(I);
164 if (!isPhysDefTriviallyDead(PhysDef, I, MBB->end()))
170 bool MachineCSE::isCSECandidate(MachineInstr *MI) {
171 // Ignore copies or instructions that read / write physical registers
172 // (except for dead defs of physical registers).
173 unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
174 if (TII->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx) ||
175 MI->isExtractSubreg() || MI->isInsertSubreg() || MI->isSubregToReg())
178 // Ignore stuff that we obviously can't move.
179 const TargetInstrDesc &TID = MI->getDesc();
180 if (TID.mayStore() || TID.isCall() || TID.isTerminator() ||
181 TID.hasUnmodeledSideEffects())
185 // Okay, this instruction does a load. As a refinement, we allow the target
186 // to decide whether the loaded value is actually a constant. If so, we can
187 // actually use it as a load.
188 if (!MI->isInvariantLoad(AA))
189 // FIXME: we should be able to hoist loads with no other side effects if
190 // there are no other instructions which can change memory in this loop.
191 // This is a trivial form of alias analysis.
197 bool MachineCSE::ProcessBlock(MachineDomTreeNode *Node) {
198 bool Changed = false;
200 ScopedHashTableScope<MachineInstr*, unsigned,
201 MachineInstrExpressionTrait> VNTS(VNT);
202 MachineBasicBlock *MBB = Node->getBlock();
203 for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end(); I != E; ) {
204 MachineInstr *MI = &*I;
207 if (!isCSECandidate(MI))
210 bool FoundCSE = VNT.count(MI);
212 // Look for trivial copy coalescing opportunities.
213 if (PerformTrivialCoalescing(MI, MBB))
214 FoundCSE = VNT.count(MI);
216 // FIXME: commute commutable instructions?
218 // If the instruction defines a physical register and the value *may* be
219 // used, then it's not safe to replace it with a common subexpression.
220 if (FoundCSE && hasLivePhysRegDefUse(MI, MBB))
224 VNT.insert(MI, CurrVN++);
229 // Found a common subexpression, eliminate it.
230 unsigned CSVN = VNT.lookup(MI);
231 MachineInstr *CSMI = Exps[CSVN];
232 DEBUG(dbgs() << "Examining: " << *MI);
233 DEBUG(dbgs() << "*** Found a common subexpression: " << *CSMI);
234 unsigned NumDefs = MI->getDesc().getNumDefs();
235 for (unsigned i = 0, e = MI->getNumOperands(); NumDefs && i != e; ++i) {
236 MachineOperand &MO = MI->getOperand(i);
237 if (!MO.isReg() || !MO.isDef())
239 unsigned OldReg = MO.getReg();
240 unsigned NewReg = CSMI->getOperand(i).getReg();
241 assert(OldReg != NewReg &&
242 TargetRegisterInfo::isVirtualRegister(OldReg) &&
243 TargetRegisterInfo::isVirtualRegister(NewReg) &&
244 "Do not CSE physical register defs!");
245 MRI->replaceRegWith(OldReg, NewReg);
248 MI->eraseFromParent();
252 // Recursively call ProcessBlock with childred.
253 const std::vector<MachineDomTreeNode*> &Children = Node->getChildren();
254 for (unsigned i = 0, e = Children.size(); i != e; ++i)
255 Changed |= ProcessBlock(Children[i]);
260 bool MachineCSE::runOnMachineFunction(MachineFunction &MF) {
261 TII = MF.getTarget().getInstrInfo();
262 TRI = MF.getTarget().getRegisterInfo();
263 MRI = &MF.getRegInfo();
264 DT = &getAnalysis<MachineDominatorTree>();
265 AA = &getAnalysis<AliasAnalysis>();
266 return ProcessBlock(DT->getRootNode());