1 //===- StrongPhiElimination.cpp - Eliminate PHI nodes by inserting copies -===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Owen Anderson and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This pass eliminates machine instruction PHI nodes by inserting copy
11 // instructions, using an intelligent copy-folding technique based on
12 // dominator information. This is technique is derived from:
14 // Budimlic, et al. Fast copy coalescing and live-range identification.
15 // In Proceedings of the ACM SIGPLAN 2002 Conference on Programming Language
16 // Design and Implementation (Berlin, Germany, June 17 - 19, 2002).
17 // PLDI '02. ACM, New York, NY, 25-32.
18 // DOI= http://doi.acm.org/10.1145/512529.512534
20 //===----------------------------------------------------------------------===//
22 #define DEBUG_TYPE "strongphielim"
23 #include "llvm/CodeGen/Passes.h"
24 #include "llvm/CodeGen/BreakCriticalMachineEdge.h"
25 #include "llvm/CodeGen/LiveVariables.h"
26 #include "llvm/CodeGen/MachineDominators.h"
27 #include "llvm/CodeGen/MachineFunctionPass.h"
28 #include "llvm/CodeGen/MachineInstr.h"
29 #include "llvm/Target/TargetInstrInfo.h"
30 #include "llvm/Target/TargetMachine.h"
31 #include "llvm/ADT/Statistic.h"
32 #include "llvm/Support/Compiler.h"
37 struct VISIBILITY_HIDDEN StrongPHIElimination : public MachineFunctionPass {
38 static char ID; // Pass identification, replacement for typeid
39 StrongPHIElimination() : MachineFunctionPass((intptr_t)&ID) {}
41 bool runOnMachineFunction(MachineFunction &Fn);
43 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
44 AU.addPreserved<LiveVariables>();
45 AU.addPreservedID(PHIEliminationID);
46 AU.addRequired<MachineDominatorTree>();
47 AU.addRequired<LiveVariables>();
49 MachineFunctionPass::getAnalysisUsage(AU);
52 virtual void releaseMemory() {
60 struct DomForestNode {
62 std::vector<DomForestNode*> children;
65 void addChild(DomForestNode* DFN) { children.push_back(DFN); }
68 typedef std::vector<DomForestNode*>::iterator iterator;
70 DomForestNode(unsigned r, DomForestNode* parent) : reg(r) {
72 parent->addChild(this);
76 for (iterator I = begin(), E = end(); I != E; ++I)
80 inline unsigned getReg() { return reg; }
82 inline DomForestNode::iterator begin() { return children.begin(); }
83 inline DomForestNode::iterator end() { return children.end(); }
86 DenseMap<MachineBasicBlock*, unsigned> preorder;
87 DenseMap<MachineBasicBlock*, unsigned> maxpreorder;
89 DenseMap<MachineBasicBlock*, std::vector<MachineInstr*> > waiting;
92 void computeDFS(MachineFunction& MF);
93 void processBlock(MachineBasicBlock* MBB);
95 std::vector<DomForestNode*> computeDomForest(std::set<unsigned>& instrs);
96 void breakCriticalEdges(MachineFunction &Fn);
100 char StrongPHIElimination::ID = 0;
101 RegisterPass<StrongPHIElimination> X("strong-phi-node-elimination",
102 "Eliminate PHI nodes for register allocation, intelligently");
105 const PassInfo *llvm::StrongPHIEliminationID = X.getPassInfo();
107 /// computeDFS - Computes the DFS-in and DFS-out numbers of the dominator tree
108 /// of the given MachineFunction. These numbers are then used in other parts
109 /// of the PHI elimination process.
110 void StrongPHIElimination::computeDFS(MachineFunction& MF) {
111 SmallPtrSet<MachineDomTreeNode*, 8> frontier;
112 SmallPtrSet<MachineDomTreeNode*, 8> visited;
116 MachineDominatorTree& DT = getAnalysis<MachineDominatorTree>();
118 MachineDomTreeNode* node = DT.getRootNode();
120 std::vector<MachineDomTreeNode*> worklist;
121 worklist.push_back(node);
123 while (!worklist.empty()) {
124 MachineDomTreeNode* currNode = worklist.back();
126 if (!frontier.count(currNode)) {
127 frontier.insert(currNode);
129 preorder.insert(std::make_pair(currNode->getBlock(), time));
132 bool inserted = false;
133 for (MachineDomTreeNode::iterator I = node->begin(), E = node->end();
135 if (!frontier.count(*I) && !visited.count(*I)) {
136 worklist.push_back(*I);
142 frontier.erase(currNode);
143 visited.insert(currNode);
144 maxpreorder.insert(std::make_pair(currNode->getBlock(), time));
151 /// PreorderSorter - a helper class that is used to sort registers
152 /// according to the preorder number of their defining blocks
153 class PreorderSorter {
155 DenseMap<MachineBasicBlock*, unsigned>& preorder;
159 PreorderSorter(DenseMap<MachineBasicBlock*, unsigned>& p,
160 LiveVariables& L) : preorder(p), LV(L) { }
162 bool operator()(unsigned A, unsigned B) {
166 MachineBasicBlock* ABlock = LV.getVarInfo(A).DefInst->getParent();
167 MachineBasicBlock* BBlock = LV.getVarInfo(A).DefInst->getParent();
169 if (preorder[ABlock] < preorder[BBlock])
171 else if (preorder[ABlock] > preorder[BBlock])
174 assert(0 && "Error sorting by dominance!");
179 /// computeDomForest - compute the subforest of the DomTree corresponding
180 /// to the defining blocks of the registers in question
181 std::vector<StrongPHIElimination::DomForestNode*>
182 StrongPHIElimination::computeDomForest(std::set<unsigned>& regs) {
183 LiveVariables& LV = getAnalysis<LiveVariables>();
185 DomForestNode* VirtualRoot = new DomForestNode(0, 0);
186 maxpreorder.insert(std::make_pair((MachineBasicBlock*)0, ~0UL));
188 std::vector<unsigned> worklist;
189 worklist.reserve(regs.size());
190 for (std::set<unsigned>::iterator I = regs.begin(), E = regs.end();
192 worklist.push_back(*I);
194 PreorderSorter PS(preorder, LV);
195 std::sort(worklist.begin(), worklist.end(), PS);
197 DomForestNode* CurrentParent = VirtualRoot;
198 std::vector<DomForestNode*> stack;
199 stack.push_back(VirtualRoot);
201 for (std::vector<unsigned>::iterator I = worklist.begin(), E = worklist.end();
203 unsigned pre = preorder[LV.getVarInfo(*I).DefInst->getParent()];
204 MachineBasicBlock* parentBlock =
205 LV.getVarInfo(CurrentParent->getReg()).DefInst->getParent();
207 while (pre > maxpreorder[parentBlock]) {
209 CurrentParent = stack.back();
211 parentBlock = LV.getVarInfo(CurrentParent->getReg()).DefInst->getParent();
214 DomForestNode* child = new DomForestNode(*I, CurrentParent);
215 stack.push_back(child);
216 CurrentParent = child;
219 std::vector<DomForestNode*> ret;
220 ret.insert(ret.end(), VirtualRoot->begin(), VirtualRoot->end());
224 /// isLiveIn - helper method that determines, from a VarInfo, if a register
225 /// is live into a block
226 bool isLiveIn(LiveVariables::VarInfo& V, MachineBasicBlock* MBB) {
227 if (V.AliveBlocks.test(MBB->getNumber()))
230 if (V.DefInst->getParent() != MBB &&
231 V.UsedBlocks.test(MBB->getNumber()))
237 /// isLiveOut - help method that determines, from a VarInfo, if a register is
238 /// live out of a block.
239 bool isLiveOut(LiveVariables::VarInfo& V, MachineBasicBlock* MBB) {
240 if (MBB == V.DefInst->getParent() ||
241 V.UsedBlocks.test(MBB->getNumber())) {
242 for (std::vector<MachineInstr*>::iterator I = V.Kills.begin(),
243 E = V.Kills.end(); I != E; ++I)
244 if ((*I)->getParent() == MBB)
253 /// processBlock - Eliminate PHIs in the given block
254 void StrongPHIElimination::processBlock(MachineBasicBlock* MBB) {
255 LiveVariables& LV = getAnalysis<LiveVariables>();
257 // Holds names that have been added to a set in any PHI within this block
258 // before the current one.
259 std::set<unsigned> ProcessedNames;
261 MachineBasicBlock::iterator P = MBB->begin();
262 while (P->getOpcode() == TargetInstrInfo::PHI) {
263 LiveVariables::VarInfo& PHIInfo = LV.getVarInfo(P->getOperand(0).getReg());
265 // Hold the names that are currently in the candidate set.
266 std::set<unsigned> PHIUnion;
267 std::set<MachineBasicBlock*> UnionedBlocks;
269 for (int i = P->getNumOperands() - 1; i >= 2; i-=2) {
270 unsigned SrcReg = P->getOperand(i-1).getReg();
271 LiveVariables::VarInfo& SrcInfo = LV.getVarInfo(SrcReg);
273 if (isLiveIn(SrcInfo, P->getParent())) {
274 // add a copy from a_i to p in Waiting[From[a_i]]
275 } else if (isLiveOut(PHIInfo, SrcInfo.DefInst->getParent())) {
276 // add a copy to Waiting[From[a_i]]
277 } else if (PHIInfo.DefInst->getOpcode() == TargetInstrInfo::PHI &&
278 isLiveIn(PHIInfo, SrcInfo.DefInst->getParent())) {
279 // add a copy to Waiting[From[a_i]]
280 } else if (ProcessedNames.count(SrcReg)) {
281 // add a copy to Waiting[From[a_i]]
282 } else if (UnionedBlocks.count(SrcInfo.DefInst->getParent())) {
283 // add a copy to Waiting[From[a_i]]
285 PHIUnion.insert(SrcReg);
286 UnionedBlocks.insert(SrcInfo.DefInst->getParent());
292 ProcessedNames.insert(PHIUnion.begin(), PHIUnion.end());
299 void StrongPHIElimination::breakCriticalEdges(MachineFunction &Fn) {
300 typedef std::pair<MachineBasicBlock*, MachineBasicBlock*> MBB_pair;
302 MachineDominatorTree& MDT = getAnalysis<MachineDominatorTree>();
303 //LiveVariables& LV = getAnalysis<LiveVariables>();
305 std::vector<MBB_pair> criticals;
306 for (MachineFunction::iterator I = Fn.begin(), E = Fn.end(); I != E; ++I)
308 I->begin()->getOpcode() == TargetInstrInfo::PHI &&
310 for (MachineBasicBlock::pred_iterator PI = I->pred_begin(),
311 PE = I->pred_end(); PI != PE; ++PI)
312 if ((*PI)->succ_size() > 1)
313 criticals.push_back(std::make_pair(*PI, I));
315 for (std::vector<MBB_pair>::iterator I = criticals.begin(),
316 E = criticals.end(); I != E; ++I) {
317 SplitCriticalMachineEdge(I->first, I->second);
319 MDT.splitBlock(I->first);
323 bool StrongPHIElimination::runOnMachineFunction(MachineFunction &Fn) {
324 breakCriticalEdges(Fn);
327 for (MachineFunction::iterator I = Fn.begin(), E = Fn.end(); I != E; ++I)
329 I->begin()->getOpcode() == TargetInstrInfo::PHI)