//
// The LLVM Compiler Infrastructure
//
-// This file was developed by Owen Anderson and is distributed under the
-// University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// the left into the right code:
//
// for (...) for (...)
-// if (c) if(c)
+// if (c) if (c)
// X1 = ... X1 = ...
// else else
// X2 = ... X2 = ...
// X3 = phi(X1, X2) X3 = phi(X1, X2)
-// ... = X3 + 4 X4 = phi(X3)
-// ... = X4 + 4
+// ... = X3 + 4 X4 = phi(X3)
+// ... = X4 + 4
//
// This is still valid LLVM; the extra phi nodes are purely redundant, and will
// be trivially eliminated by InstCombine. The major benefit of this
//
//===----------------------------------------------------------------------===//
+#define DEBUG_TYPE "lcssa"
#include "llvm/Transforms/Scalar.h"
-#include "llvm/Pass.h"
-#include "llvm/Function.h"
-#include "llvm/Instructions.h"
-#include "llvm/ADT/SetVector.h"
+#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/Statistic.h"
-#include "llvm/Analysis/Dominators.h"
-#include "llvm/Analysis/LoopInfo.h"
-#include "llvm/Support/CFG.h"
-#include <algorithm>
-#include <map>
-
+#include "llvm/Analysis/LoopPass.h"
+#include "llvm/Analysis/ScalarEvolution.h"
+#include "llvm/IR/Constants.h"
+#include "llvm/IR/Dominators.h"
+#include "llvm/IR/Function.h"
+#include "llvm/IR/Instructions.h"
+#include "llvm/Pass.h"
+#include "llvm/Support/PredIteratorCache.h"
+#include "llvm/Transforms/Utils/SSAUpdater.h"
using namespace llvm;
+STATISTIC(NumLCSSA, "Number of live out of a loop variables");
+
namespace {
- static Statistic<> NumLCSSA("lcssa",
- "Number of live out of a loop variables");
-
- class LCSSA : public FunctionPass {
- public:
-
-
- LoopInfo *LI; // Loop information
- DominatorTree *DT; // Dominator Tree for the current Function...
- DominanceFrontier *DF; // Current Dominance Frontier
- std::vector<BasicBlock*> LoopBlocks;
-
- virtual bool runOnFunction(Function &F);
- bool visitSubloop(Loop* L);
- void processInstruction(Instruction* Instr,
- const std::vector<BasicBlock*>& exitBlocks);
+ struct LCSSA : public LoopPass {
+ static char ID; // Pass identification, replacement for typeid
+ LCSSA() : LoopPass(ID) {
+ initializeLCSSAPass(*PassRegistry::getPassRegistry());
+ }
+
+ // Cached analysis information for the current function.
+ DominatorTree *DT;
+ LoopInfo *LI;
+ ScalarEvolution *SE;
+ PredIteratorCache PredCache;
+ Loop *L;
+ virtual bool runOnLoop(Loop *L, LPPassManager &LPM);
+
/// This transformation requires natural loop information & requires that
/// loop preheaders be inserted into the CFG. It maintains both of these,
/// as well as the CFG. It also requires dominator information.
///
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesCFG();
- AU.addRequiredID(LoopSimplifyID);
- AU.addPreservedID(LoopSimplifyID);
- AU.addRequired<LoopInfo>();
+
AU.addRequired<DominatorTree>();
- AU.addRequired<DominanceFrontier>();
+ AU.addRequired<LoopInfo>();
+ AU.addPreservedID(LoopSimplifyID);
+ AU.addPreserved<ScalarEvolution>();
}
private:
- SetVector<Instruction*> getLoopValuesUsedOutsideLoop(Loop *L);
- Instruction *getValueDominatingBlock(BasicBlock *BB,
- std::map<BasicBlock*, Instruction*>& PotDoms) {
- return getValueDominatingDTNode(DT->getNode(BB), PotDoms);
- }
- Instruction *getValueDominatingDTNode(DominatorTree::Node *Node,
- std::map<BasicBlock*, Instruction*>& PotDoms);
-
- /// inLoop - returns true if the given block is within the current loop
- const bool inLoop(BasicBlock* B) {
- return std::binary_search(LoopBlocks.begin(), LoopBlocks.end(), B);
+ bool ProcessInstruction(Instruction *Inst,
+ const SmallVectorImpl<BasicBlock*> &ExitBlocks);
+
+ /// verifyAnalysis() - Verify loop nest.
+ virtual void verifyAnalysis() const {
+ // Check the special guarantees that LCSSA makes.
+ assert(L->isLCSSAForm(*DT) && "LCSSA form not preserved!");
}
};
+}
- RegisterOpt<LCSSA> X("lcssa", "Loop-Closed SSA Form Pass");
+char LCSSA::ID = 0;
+INITIALIZE_PASS_BEGIN(LCSSA, "lcssa", "Loop-Closed SSA Form Pass", false, false)
+INITIALIZE_PASS_DEPENDENCY(DominatorTree)
+INITIALIZE_PASS_DEPENDENCY(LoopInfo)
+INITIALIZE_PASS_END(LCSSA, "lcssa", "Loop-Closed SSA Form Pass", false, false)
+
+Pass *llvm::createLCSSAPass() { return new LCSSA(); }
+char &llvm::LCSSAID = LCSSA::ID;
+
+
+/// BlockDominatesAnExit - Return true if the specified block dominates at least
+/// one of the blocks in the specified list.
+static bool BlockDominatesAnExit(BasicBlock *BB,
+ const SmallVectorImpl<BasicBlock*> &ExitBlocks,
+ DominatorTree *DT) {
+ DomTreeNode *DomNode = DT->getNode(BB);
+ for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i)
+ if (DT->dominates(DomNode, DT->getNode(ExitBlocks[i])))
+ return true;
+
+ return false;
}
-FunctionPass *llvm::createLCSSAPass() { return new LCSSA(); }
-const PassInfo *llvm::LCSSAID = X.getPassInfo();
/// runOnFunction - Process all loops in the function, inner-most out.
-bool LCSSA::runOnFunction(Function &F) {
- bool changed = false;
+bool LCSSA::runOnLoop(Loop *TheLoop, LPPassManager &LPM) {
+ L = TheLoop;
- LI = &getAnalysis<LoopInfo>();
- DF = &getAnalysis<DominanceFrontier>();
DT = &getAnalysis<DominatorTree>();
-
- for (LoopInfo::iterator I = LI->begin(), E = LI->end(); I != E; ++I) {
- changed |= visitSubloop(*I);
- }
-
- return changed;
-}
+ LI = &getAnalysis<LoopInfo>();
+ SE = getAnalysisIfAvailable<ScalarEvolution>();
-/// visitSubloop - Recursively process all subloops, and then process the given
-/// loop if it has live-out values.
-bool LCSSA::visitSubloop(Loop* L) {
- for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
- visitSubloop(*I);
-
- // Speed up queries by creating a sorted list of blocks
- LoopBlocks.clear();
- LoopBlocks.insert(LoopBlocks.end(), L->block_begin(), L->block_end());
- std::sort(LoopBlocks.begin(), LoopBlocks.end());
-
- SetVector<Instruction*> AffectedValues = getLoopValuesUsedOutsideLoop(L);
+ // Get the set of exiting blocks.
+ SmallVector<BasicBlock*, 8> ExitBlocks;
+ L->getExitBlocks(ExitBlocks);
- // If no values are affected, we can save a lot of work, since we know that
- // nothing will be changed.
- if (AffectedValues.empty())
+ if (ExitBlocks.empty())
return false;
- std::vector<BasicBlock*> exitBlocks;
- L->getExitBlocks(exitBlocks);
-
-
- // Iterate over all affected values for this loop and insert Phi nodes
- // for them in the appropriate exit blocks
+ // Look at all the instructions in the loop, checking to see if they have uses
+ // outside the loop. If so, rewrite those uses.
+ bool MadeChange = false;
- for (SetVector<Instruction*>::iterator I = AffectedValues.begin(),
- E = AffectedValues.end(); I != E; ++I) {
- processInstruction(*I, exitBlocks);
+ for (Loop::block_iterator BBI = L->block_begin(), E = L->block_end();
+ BBI != E; ++BBI) {
+ BasicBlock *BB = *BBI;
+
+ // For large loops, avoid use-scanning by using dominance information: In
+ // particular, if a block does not dominate any of the loop exits, then none
+ // of the values defined in the block could be used outside the loop.
+ if (!BlockDominatesAnExit(BB, ExitBlocks, DT))
+ continue;
+
+ for (BasicBlock::iterator I = BB->begin(), E = BB->end();
+ I != E; ++I) {
+ // Reject two common cases fast: instructions with no uses (like stores)
+ // and instructions with one use that is in the same block as this.
+ if (I->use_empty() ||
+ (I->hasOneUse() && I->use_back()->getParent() == BB &&
+ !isa<PHINode>(I->use_back())))
+ continue;
+
+ MadeChange |= ProcessInstruction(I, ExitBlocks);
+ }
}
+
+ // If we modified the code, remove any caches about the loop from SCEV to
+ // avoid dangling entries.
+ // FIXME: This is a big hammer, can we clear the cache more selectively?
+ if (SE && MadeChange)
+ SE->forgetLoop(L);
- assert(L->isLCSSAForm());
-
- return true;
+ assert(L->isLCSSAForm(*DT));
+ PredCache.clear();
+
+ return MadeChange;
}
-/// processInstruction - Given a live-out instruction, insert LCSSA Phi nodes,
-/// eliminate all out-of-loop uses.
-void LCSSA::processInstruction(Instruction* Instr,
- const std::vector<BasicBlock*>& exitBlocks)
-{
- ++NumLCSSA; // We are applying the transformation
-
- std::map<BasicBlock*, Instruction*> Phis;
-
- // Add the base instruction to the Phis list. This makes tracking down
- // the dominating values easier when we're filling in Phi nodes. This will
- // be removed later, before we perform use replacement.
- Phis[Instr->getParent()] = Instr;
+/// isExitBlock - Return true if the specified block is in the list.
+static bool isExitBlock(BasicBlock *BB,
+ const SmallVectorImpl<BasicBlock*> &ExitBlocks) {
+ for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i)
+ if (ExitBlocks[i] == BB)
+ return true;
+ return false;
+}
+
+/// ProcessInstruction - Given an instruction in the loop, check to see if it
+/// has any uses that are outside the current loop. If so, insert LCSSA PHI
+/// nodes and rewrite the uses.
+bool LCSSA::ProcessInstruction(Instruction *Inst,
+ const SmallVectorImpl<BasicBlock*> &ExitBlocks) {
+ SmallVector<Use*, 16> UsesToRewrite;
- // Phi nodes that need to be IDF-processed
- std::vector<PHINode*> workList;
+ BasicBlock *InstBB = Inst->getParent();
- for (std::vector<BasicBlock*>::const_iterator BBI = exitBlocks.begin(),
- BBE = exitBlocks.end(); BBI != BBE; ++BBI) {
- Instruction*& phi = Phis[*BBI];
- if (phi == 0 &&
- DT->getNode(Instr->getParent())->dominates(DT->getNode(*BBI))) {
- phi = new PHINode(Instr->getType(), Instr->getName()+".lcssa",
- (*BBI)->begin());
- workList.push_back(cast<PHINode>(phi));
- }
+ for (Value::use_iterator UI = Inst->use_begin(), E = Inst->use_end();
+ UI != E; ++UI) {
+ User *U = *UI;
+ BasicBlock *UserBB = cast<Instruction>(U)->getParent();
+ if (PHINode *PN = dyn_cast<PHINode>(U))
+ UserBB = PN->getIncomingBlock(UI);
+
+ if (InstBB != UserBB && !L->contains(UserBB))
+ UsesToRewrite.push_back(&UI.getUse());
}
+
+ // If there are no uses outside the loop, exit with no change.
+ if (UsesToRewrite.empty()) return false;
- // Phi nodes that need to have their incoming values filled.
- std::vector<PHINode*> needIncomingValues;
+ ++NumLCSSA; // We are applying the transformation
+
+ // Invoke instructions are special in that their result value is not available
+ // along their unwind edge. The code below tests to see whether DomBB dominates
+ // the value, so adjust DomBB to the normal destination block, which is
+ // effectively where the value is first usable.
+ BasicBlock *DomBB = Inst->getParent();
+ if (InvokeInst *Inv = dyn_cast<InvokeInst>(Inst))
+ DomBB = Inv->getNormalDest();
+
+ DomTreeNode *DomNode = DT->getNode(DomBB);
+
+ SmallVector<PHINode*, 16> AddedPHIs;
+
+ SSAUpdater SSAUpdate;
+ SSAUpdate.Initialize(Inst->getType(), Inst->getName());
- // Calculate the IDF of these LCSSA Phi nodes, inserting new Phi's where
- // necessary. Keep track of these new Phi's in the "Phis" map.
- while (!workList.empty()) {
- PHINode *CurPHI = workList.back();
- workList.pop_back();
+ // Insert the LCSSA phi's into all of the exit blocks dominated by the
+ // value, and add them to the Phi's map.
+ for (SmallVectorImpl<BasicBlock*>::const_iterator BBI = ExitBlocks.begin(),
+ BBE = ExitBlocks.end(); BBI != BBE; ++BBI) {
+ BasicBlock *ExitBB = *BBI;
+ if (!DT->dominates(DomNode, DT->getNode(ExitBB))) continue;
- // Even though we've removed this Phi from the work list, we still need
- // to fill in its incoming values.
- needIncomingValues.push_back(CurPHI);
+ // If we already inserted something for this BB, don't reprocess it.
+ if (SSAUpdate.HasValueForBlock(ExitBB)) continue;
- // Get the current Phi's DF, and insert Phi nodes. Add these new
- // nodes to our worklist.
- DominanceFrontier::const_iterator it = DF->find(CurPHI->getParent());
- if (it != DF->end()) {
- const DominanceFrontier::DomSetType &S = it->second;
- for (DominanceFrontier::DomSetType::const_iterator P = S.begin(),
- PE = S.end(); P != PE; ++P) {
- if (DT->getNode(Instr->getParent())->dominates(DT->getNode(*P))) {
- Instruction *&Phi = Phis[*P];
- if (Phi == 0) {
- // Still doesn't have operands...
- Phi = new PHINode(Instr->getType(), Instr->getName()+".lcssa",
- (*P)->begin());
-
- workList.push_back(cast<PHINode>(Phi));
- }
- }
- }
- }
- }
-
- // Fill in all Phis we've inserted that need their incoming values filled in.
- for (std::vector<PHINode*>::iterator IVI = needIncomingValues.begin(),
- IVE = needIncomingValues.end(); IVI != IVE; ++IVI) {
- for (pred_iterator PI = pred_begin((*IVI)->getParent()),
- E = pred_end((*IVI)->getParent()); PI != E; ++PI)
- (*IVI)->addIncoming(getValueDominatingBlock(*PI, Phis),
- *PI);
- }
-
- // Find all uses of the affected value, and replace them with the
- // appropriate Phi.
- std::vector<Instruction*> Uses;
- for (Instruction::use_iterator UI = Instr->use_begin(), UE = Instr->use_end();
- UI != UE; ++UI) {
- Instruction* use = cast<Instruction>(*UI);
- BasicBlock* UserBB = use->getParent();
- if (PHINode* p = dyn_cast<PHINode>(use)) {
- unsigned OperandNo = UI.getOperandNo();
- UserBB = p->getIncomingBlock(OperandNo/2);
+ PHINode *PN = PHINode::Create(Inst->getType(),
+ PredCache.GetNumPreds(ExitBB),
+ Inst->getName()+".lcssa",
+ ExitBB->begin());
+
+ // Add inputs from inside the loop for this PHI.
+ for (BasicBlock **PI = PredCache.GetPreds(ExitBB); *PI; ++PI) {
+ PN->addIncoming(Inst, *PI);
+
+ // If the exit block has a predecessor not within the loop, arrange for
+ // the incoming value use corresponding to that predecessor to be
+ // rewritten in terms of a different LCSSA PHI.
+ if (!L->contains(*PI))
+ UsesToRewrite.push_back(
+ &PN->getOperandUse(
+ PN->getOperandNumForIncomingValue(PN->getNumIncomingValues()-1)));
}
+
+ AddedPHIs.push_back(PN);
- // Don't need to update uses within the loop body.
- if (!inLoop(use->getParent()))
- Uses.push_back(use);
+ // Remember that this phi makes the value alive in this block.
+ SSAUpdate.AddAvailableValue(ExitBB, PN);
}
-
- for (std::vector<Instruction*>::iterator II = Uses.begin(), IE = Uses.end();
- II != IE; ++II) {
- if (PHINode* phi = dyn_cast<PHINode>(*II)) {
- for (unsigned int i = 0; i < phi->getNumIncomingValues(); ++i) {
- if (phi->getIncomingValue(i) == Instr) {
- Instruction* dominator =
- getValueDominatingBlock(phi->getIncomingBlock(i), Phis);
- phi->setIncomingValue(i, dominator);
- }
- }
- } else {
- Value *NewVal = getValueDominatingBlock((*II)->getParent(), Phis);
- (*II)->replaceUsesOfWith(Instr, NewVal);
+
+ // Rewrite all uses outside the loop in terms of the new PHIs we just
+ // inserted.
+ for (unsigned i = 0, e = UsesToRewrite.size(); i != e; ++i) {
+ // If this use is in an exit block, rewrite to use the newly inserted PHI.
+ // This is required for correctness because SSAUpdate doesn't handle uses in
+ // the same block. It assumes the PHI we inserted is at the end of the
+ // block.
+ Instruction *User = cast<Instruction>(UsesToRewrite[i]->getUser());
+ BasicBlock *UserBB = User->getParent();
+ if (PHINode *PN = dyn_cast<PHINode>(User))
+ UserBB = PN->getIncomingBlock(*UsesToRewrite[i]);
+
+ if (isa<PHINode>(UserBB->begin()) &&
+ isExitBlock(UserBB, ExitBlocks)) {
+ // Tell the VHs that the uses changed. This updates SCEV's caches.
+ if (UsesToRewrite[i]->get()->hasValueHandle())
+ ValueHandleBase::ValueIsRAUWd(*UsesToRewrite[i], UserBB->begin());
+ UsesToRewrite[i]->set(UserBB->begin());
+ continue;
}
+
+ // Otherwise, do full PHI insertion.
+ SSAUpdate.RewriteUse(*UsesToRewrite[i]);
}
-}
-/// getLoopValuesUsedOutsideLoop - Return any values defined in the loop that
-/// are used by instructions outside of it.
-SetVector<Instruction*> LCSSA::getLoopValuesUsedOutsideLoop(Loop *L) {
-
- // FIXME: For large loops, we may be able to avoid a lot of use-scanning
- // by using dominance information. In particular, if a block does not
- // dominate any of the loop exits, then none of the values defined in the
- // block could be used outside the loop.
-
- SetVector<Instruction*> AffectedValues;
- for (Loop::block_iterator BB = L->block_begin(), E = L->block_end();
- BB != E; ++BB) {
- for (BasicBlock::iterator I = (*BB)->begin(), E = (*BB)->end(); I != E; ++I)
- for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI != E;
- ++UI) {
- BasicBlock *UserBB = cast<Instruction>(*UI)->getParent();
- if (PHINode* p = dyn_cast<PHINode>(*UI)) {
- unsigned OperandNo = UI.getOperandNo();
- UserBB = p->getIncomingBlock(OperandNo/2);
- }
-
- if (!inLoop(UserBB)) {
- AffectedValues.insert(I);
- break;
- }
- }
+ // Remove PHI nodes that did not have any uses rewritten.
+ for (unsigned i = 0, e = AddedPHIs.size(); i != e; ++i) {
+ if (AddedPHIs[i]->use_empty())
+ AddedPHIs[i]->eraseFromParent();
}
- return AffectedValues;
-}
-
-/// getValueDominatingBlock - Return the value within the potential dominators
-/// map that dominates the given block.
-Instruction *LCSSA::getValueDominatingDTNode(DominatorTree::Node *Node,
- std::map<BasicBlock*, Instruction*>& PotDoms) {
- assert(Node != 0 && "Didn't find dom value?");
- Instruction *&CacheSlot = PotDoms[Node->getBlock()];
- if (CacheSlot) return CacheSlot;
- // Otherwise, return the value of the idom and remember this for next time.
- return CacheSlot = getValueDominatingDTNode(Node->getIDom(), PotDoms);
+ return true;
}
+
projects / oota-llvm.git / blobdiff