1 //===-- LCSSA.cpp - Convert loops into loop-closed SSA form ---------------===//
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 transforms loops by placing phi nodes at the end of the loops for
11 // all values that are live across the loop boundary. For example, it turns
12 // the left into the right code:
14 // for (...) for (...)
19 // X3 = phi(X1, X2) X3 = phi(X1, X2)
20 // ... = X3 + 4 X4 = phi(X3)
23 // This is still valid LLVM; the extra phi nodes are purely redundant, and will
24 // be trivially eliminated by InstCombine. The major benefit of this
25 // transformation is that it makes many other loop optimizations, such as
26 // LoopUnswitching, simpler.
28 //===----------------------------------------------------------------------===//
30 #define DEBUG_TYPE "lcssa"
31 #include "llvm/Transforms/Scalar.h"
32 #include "llvm/Constants.h"
33 #include "llvm/Pass.h"
34 #include "llvm/Function.h"
35 #include "llvm/Instructions.h"
36 #include "llvm/Analysis/Dominators.h"
37 #include "llvm/Analysis/LoopPass.h"
38 #include "llvm/Analysis/ScalarEvolution.h"
39 #include "llvm/Transforms/Utils/SSAUpdater.h"
40 #include "llvm/ADT/Statistic.h"
41 #include "llvm/ADT/STLExtras.h"
42 #include "llvm/Support/PredIteratorCache.h"
45 STATISTIC(NumLCSSA, "Number of live out of a loop variables");
48 struct LCSSA : public LoopPass {
49 static char ID; // Pass identification, replacement for typeid
50 LCSSA() : LoopPass(ID) {}
52 // Cached analysis information for the current function.
54 std::vector<BasicBlock*> LoopBlocks;
55 PredIteratorCache PredCache;
58 virtual bool runOnLoop(Loop *L, LPPassManager &LPM);
60 /// This transformation requires natural loop information & requires that
61 /// loop preheaders be inserted into the CFG. It maintains both of these,
62 /// as well as the CFG. It also requires dominator information.
64 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
67 AU.addRequired<DominatorTree>();
68 AU.addPreserved<DominatorTree>();
69 AU.addPreserved<DominanceFrontier>();
70 AU.addRequired<LoopInfo>();
71 AU.addPreserved<LoopInfo>();
72 AU.addPreservedID(LoopSimplifyID);
73 AU.addPreserved<ScalarEvolution>();
76 bool ProcessInstruction(Instruction *Inst,
77 const SmallVectorImpl<BasicBlock*> &ExitBlocks);
79 /// verifyAnalysis() - Verify loop nest.
80 virtual void verifyAnalysis() const {
81 // Check the special guarantees that LCSSA makes.
82 assert(L->isLCSSAForm(*DT) && "LCSSA form not preserved!");
85 /// inLoop - returns true if the given block is within the current loop
86 bool inLoop(BasicBlock *B) const {
87 return std::binary_search(LoopBlocks.begin(), LoopBlocks.end(), B);
93 INITIALIZE_PASS_BEGIN(LCSSA, "lcssa", "Loop-Closed SSA Form Pass", false, false)
94 INITIALIZE_PASS_DEPENDENCY(DominatorTree)
95 INITIALIZE_PASS_DEPENDENCY(DominanceFrontier)
96 INITIALIZE_PASS_DEPENDENCY(LoopInfo)
97 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
98 INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
99 INITIALIZE_PASS_END(LCSSA, "lcssa", "Loop-Closed SSA Form Pass", false, false)
101 Pass *llvm::createLCSSAPass() { return new LCSSA(); }
102 char &llvm::LCSSAID = LCSSA::ID;
105 /// BlockDominatesAnExit - Return true if the specified block dominates at least
106 /// one of the blocks in the specified list.
107 static bool BlockDominatesAnExit(BasicBlock *BB,
108 const SmallVectorImpl<BasicBlock*> &ExitBlocks,
110 DomTreeNode *DomNode = DT->getNode(BB);
111 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i)
112 if (DT->dominates(DomNode, DT->getNode(ExitBlocks[i])))
119 /// runOnFunction - Process all loops in the function, inner-most out.
120 bool LCSSA::runOnLoop(Loop *TheLoop, LPPassManager &LPM) {
123 DT = &getAnalysis<DominatorTree>();
125 // Get the set of exiting blocks.
126 SmallVector<BasicBlock*, 8> ExitBlocks;
127 L->getExitBlocks(ExitBlocks);
129 if (ExitBlocks.empty())
132 // Speed up queries by creating a sorted vector of blocks.
134 LoopBlocks.insert(LoopBlocks.end(), L->block_begin(), L->block_end());
135 array_pod_sort(LoopBlocks.begin(), LoopBlocks.end());
137 // Look at all the instructions in the loop, checking to see if they have uses
138 // outside the loop. If so, rewrite those uses.
139 bool MadeChange = false;
141 for (Loop::block_iterator BBI = L->block_begin(), E = L->block_end();
143 BasicBlock *BB = *BBI;
145 // For large loops, avoid use-scanning by using dominance information: In
146 // particular, if a block does not dominate any of the loop exits, then none
147 // of the values defined in the block could be used outside the loop.
148 if (!BlockDominatesAnExit(BB, ExitBlocks, DT))
151 for (BasicBlock::iterator I = BB->begin(), E = BB->end();
153 // Reject two common cases fast: instructions with no uses (like stores)
154 // and instructions with one use that is in the same block as this.
155 if (I->use_empty() ||
156 (I->hasOneUse() && I->use_back()->getParent() == BB &&
157 !isa<PHINode>(I->use_back())))
160 MadeChange |= ProcessInstruction(I, ExitBlocks);
164 assert(L->isLCSSAForm(*DT));
170 /// isExitBlock - Return true if the specified block is in the list.
171 static bool isExitBlock(BasicBlock *BB,
172 const SmallVectorImpl<BasicBlock*> &ExitBlocks) {
173 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i)
174 if (ExitBlocks[i] == BB)
179 /// ProcessInstruction - Given an instruction in the loop, check to see if it
180 /// has any uses that are outside the current loop. If so, insert LCSSA PHI
181 /// nodes and rewrite the uses.
182 bool LCSSA::ProcessInstruction(Instruction *Inst,
183 const SmallVectorImpl<BasicBlock*> &ExitBlocks) {
184 SmallVector<Use*, 16> UsesToRewrite;
186 BasicBlock *InstBB = Inst->getParent();
188 for (Value::use_iterator UI = Inst->use_begin(), E = Inst->use_end();
191 BasicBlock *UserBB = cast<Instruction>(U)->getParent();
192 if (PHINode *PN = dyn_cast<PHINode>(U))
193 UserBB = PN->getIncomingBlock(UI);
195 if (InstBB != UserBB && !inLoop(UserBB))
196 UsesToRewrite.push_back(&UI.getUse());
199 // If there are no uses outside the loop, exit with no change.
200 if (UsesToRewrite.empty()) return false;
202 ++NumLCSSA; // We are applying the transformation
204 // Invoke instructions are special in that their result value is not available
205 // along their unwind edge. The code below tests to see whether DomBB dominates
206 // the value, so adjust DomBB to the normal destination block, which is
207 // effectively where the value is first usable.
208 BasicBlock *DomBB = Inst->getParent();
209 if (InvokeInst *Inv = dyn_cast<InvokeInst>(Inst))
210 DomBB = Inv->getNormalDest();
212 DomTreeNode *DomNode = DT->getNode(DomBB);
214 SSAUpdater SSAUpdate;
215 SSAUpdate.Initialize(Inst->getType(), Inst->getName());
217 // Insert the LCSSA phi's into all of the exit blocks dominated by the
218 // value, and add them to the Phi's map.
219 for (SmallVectorImpl<BasicBlock*>::const_iterator BBI = ExitBlocks.begin(),
220 BBE = ExitBlocks.end(); BBI != BBE; ++BBI) {
221 BasicBlock *ExitBB = *BBI;
222 if (!DT->dominates(DomNode, DT->getNode(ExitBB))) continue;
224 // If we already inserted something for this BB, don't reprocess it.
225 if (SSAUpdate.HasValueForBlock(ExitBB)) continue;
227 PHINode *PN = PHINode::Create(Inst->getType(), Inst->getName()+".lcssa",
229 PN->reserveOperandSpace(PredCache.GetNumPreds(ExitBB));
231 // Add inputs from inside the loop for this PHI.
232 for (BasicBlock **PI = PredCache.GetPreds(ExitBB); *PI; ++PI) {
233 PN->addIncoming(Inst, *PI);
235 // If the exit block has a predecessor not within the loop, arrange for
236 // the incoming value use corresponding to that predecessor to be
237 // rewritten in terms of a different LCSSA PHI.
239 UsesToRewrite.push_back(
241 PN->getOperandNumForIncomingValue(PN->getNumIncomingValues()-1)));
244 // Remember that this phi makes the value alive in this block.
245 SSAUpdate.AddAvailableValue(ExitBB, PN);
248 // Rewrite all uses outside the loop in terms of the new PHIs we just
250 for (unsigned i = 0, e = UsesToRewrite.size(); i != e; ++i) {
251 // If this use is in an exit block, rewrite to use the newly inserted PHI.
252 // This is required for correctness because SSAUpdate doesn't handle uses in
253 // the same block. It assumes the PHI we inserted is at the end of the
255 Instruction *User = cast<Instruction>(UsesToRewrite[i]->getUser());
256 BasicBlock *UserBB = User->getParent();
257 if (PHINode *PN = dyn_cast<PHINode>(User))
258 UserBB = PN->getIncomingBlock(*UsesToRewrite[i]);
260 if (isa<PHINode>(UserBB->begin()) &&
261 isExitBlock(UserBB, ExitBlocks)) {
262 UsesToRewrite[i]->set(UserBB->begin());
266 // Otherwise, do full PHI insertion.
267 SSAUpdate.RewriteUse(*UsesToRewrite[i]);