-//===- LoopInfo.cpp - Natural Loop Calculator -------------------------------=//
+//===- LoopInfo.cpp - Natural Loop Calculator -----------------------------===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
//
// This file defines the LoopInfo class that is used to identify natural loops
// and determine the loop depth of various nodes of the CFG. Note that the
//===----------------------------------------------------------------------===//
#include "llvm/Analysis/LoopInfo.h"
+#include "llvm/Constants.h"
+#include "llvm/Instructions.h"
#include "llvm/Analysis/Dominators.h"
-#include "llvm/Support/CFG.h"
#include "llvm/Assembly/Writer.h"
-#include "Support/DepthFirstIterator.h"
+#include "llvm/Support/CFG.h"
+#include "llvm/ADT/DepthFirstIterator.h"
+#include "llvm/ADT/SmallPtrSet.h"
#include <algorithm>
+using namespace llvm;
-static RegisterAnalysis<LoopInfo>
-X("loops", "Natural Loop Construction", true);
+char LoopInfo::ID = 0;
+static RegisterPass<LoopInfo>
+X("loops", "Natural Loop Information", true, true);
//===----------------------------------------------------------------------===//
// Loop implementation
//
-bool Loop::contains(const BasicBlock *BB) const {
- return find(Blocks.begin(), Blocks.end(), BB) != Blocks.end();
-}
-bool Loop::isLoopExit(const BasicBlock *BB) const {
- for (BasicBlock::succ_const_iterator SI = succ_begin(BB), SE = succ_end(BB);
- SI != SE; ++SI) {
- if (!contains(*SI))
- return true;
- }
- return false;
+/// isLoopInvariant - Return true if the specified value is loop invariant
+///
+bool Loop::isLoopInvariant(Value *V) const {
+ if (Instruction *I = dyn_cast<Instruction>(V))
+ return isLoopInvariant(I);
+ return true; // All non-instructions are loop invariant
}
-unsigned Loop::getNumBackEdges() const {
- unsigned NumBackEdges = 0;
- BasicBlock *H = getHeader();
-
- for (std::vector<BasicBlock*>::const_iterator I = Blocks.begin(),
- E = Blocks.end(); I != E; ++I)
- for (BasicBlock::succ_iterator SI = succ_begin(*I), SE = succ_end(*I);
- SI != SE; ++SI)
- if (*SI == H)
- ++NumBackEdges;
-
- return NumBackEdges;
+/// isLoopInvariant - Return true if the specified instruction is
+/// loop-invariant.
+///
+bool Loop::isLoopInvariant(Instruction *I) const {
+ return !contains(I->getParent());
}
-void Loop::print(std::ostream &OS) const {
- OS << std::string(getLoopDepth()*2, ' ') << "Loop Containing: ";
-
- for (unsigned i = 0; i < getBlocks().size(); ++i) {
- if (i) OS << ",";
- WriteAsOperand(OS, getBlocks()[i], false);
- }
- if (!ExitBlocks.empty()) {
- OS << "\tExitBlocks: ";
- for (unsigned i = 0; i < getExitBlocks().size(); ++i) {
- if (i) OS << ",";
- WriteAsOperand(OS, getExitBlocks()[i], false);
- }
- }
-
- OS << "\n";
-
- for (unsigned i = 0, e = getSubLoops().size(); i != e; ++i)
- getSubLoops()[i]->print(OS);
+/// makeLoopInvariant - If the given value is an instruciton inside of the
+/// loop and it can be hoisted, do so to make it trivially loop-invariant.
+/// Return true if the value after any hoisting is loop invariant. This
+/// function can be used as a slightly more aggressive replacement for
+/// isLoopInvariant.
+///
+/// If InsertPt is specified, it is the point to hoist instructions to.
+/// If null, the terminator of the loop preheader is used.
+///
+bool Loop::makeLoopInvariant(Value *V, bool &Changed,
+ Instruction *InsertPt) const {
+ if (Instruction *I = dyn_cast<Instruction>(V))
+ return makeLoopInvariant(I, Changed, InsertPt);
+ return true; // All non-instructions are loop-invariant.
}
-
-//===----------------------------------------------------------------------===//
-// LoopInfo implementation
-//
-void LoopInfo::stub() {}
-
-bool LoopInfo::runOnFunction(Function &) {
- releaseMemory();
- Calculate(getAnalysis<DominatorSet>()); // Update
- return false;
+/// makeLoopInvariant - If the given instruction is inside of the
+/// loop and it can be hoisted, do so to make it trivially loop-invariant.
+/// Return true if the instruction after any hoisting is loop invariant. This
+/// function can be used as a slightly more aggressive replacement for
+/// isLoopInvariant.
+///
+/// If InsertPt is specified, it is the point to hoist instructions to.
+/// If null, the terminator of the loop preheader is used.
+///
+bool Loop::makeLoopInvariant(Instruction *I, bool &Changed,
+ Instruction *InsertPt) const {
+ // Test if the value is already loop-invariant.
+ if (isLoopInvariant(I))
+ return true;
+ if (!I->isSafeToSpeculativelyExecute())
+ return false;
+ if (I->mayReadFromMemory())
+ return false;
+ // Determine the insertion point, unless one was given.
+ if (!InsertPt) {
+ BasicBlock *Preheader = getLoopPreheader();
+ // Without a preheader, hoisting is not feasible.
+ if (!Preheader)
+ return false;
+ InsertPt = Preheader->getTerminator();
+ }
+ // Don't hoist instructions with loop-variant operands.
+ for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
+ if (!makeLoopInvariant(I->getOperand(i), Changed, InsertPt))
+ return false;
+ // Hoist.
+ I->moveBefore(InsertPt);
+ Changed = true;
+ return true;
}
-void LoopInfo::releaseMemory() {
- for (std::vector<Loop*>::iterator I = TopLevelLoops.begin(),
- E = TopLevelLoops.end(); I != E; ++I)
- delete *I; // Delete all of the loops...
+/// getCanonicalInductionVariable - Check to see if the loop has a canonical
+/// induction variable: an integer recurrence that starts at 0 and increments
+/// by one each time through the loop. If so, return the phi node that
+/// corresponds to it.
+///
+/// The IndVarSimplify pass transforms loops to have a canonical induction
+/// variable.
+///
+PHINode *Loop::getCanonicalInductionVariable() const {
+ BasicBlock *H = getHeader();
- BBMap.clear(); // Reset internal state of analysis
- TopLevelLoops.clear();
+ BasicBlock *Incoming = 0, *Backedge = 0;
+ typedef GraphTraits<Inverse<BasicBlock*> > InvBlockTraits;
+ InvBlockTraits::ChildIteratorType PI = InvBlockTraits::child_begin(H);
+ assert(PI != InvBlockTraits::child_end(H) &&
+ "Loop must have at least one backedge!");
+ Backedge = *PI++;
+ if (PI == InvBlockTraits::child_end(H)) return 0; // dead loop
+ Incoming = *PI++;
+ if (PI != InvBlockTraits::child_end(H)) return 0; // multiple backedges?
+
+ if (contains(Incoming)) {
+ if (contains(Backedge))
+ return 0;
+ std::swap(Incoming, Backedge);
+ } else if (!contains(Backedge))
+ return 0;
+
+ // Loop over all of the PHI nodes, looking for a canonical indvar.
+ for (BasicBlock::iterator I = H->begin(); isa<PHINode>(I); ++I) {
+ PHINode *PN = cast<PHINode>(I);
+ if (ConstantInt *CI =
+ dyn_cast<ConstantInt>(PN->getIncomingValueForBlock(Incoming)))
+ if (CI->isNullValue())
+ if (Instruction *Inc =
+ dyn_cast<Instruction>(PN->getIncomingValueForBlock(Backedge)))
+ if (Inc->getOpcode() == Instruction::Add &&
+ Inc->getOperand(0) == PN)
+ if (ConstantInt *CI = dyn_cast<ConstantInt>(Inc->getOperand(1)))
+ if (CI->equalsInt(1))
+ return PN;
+ }
+ return 0;
}
-
-void LoopInfo::Calculate(const DominatorSet &DS) {
- BasicBlock *RootNode = DS.getRoot();
-
- for (df_iterator<BasicBlock*> NI = df_begin(RootNode),
- NE = df_end(RootNode); NI != NE; ++NI)
- if (Loop *L = ConsiderForLoop(*NI, DS))
- TopLevelLoops.push_back(L);
-
- for (unsigned i = 0; i < TopLevelLoops.size(); ++i)
- TopLevelLoops[i]->setLoopDepth(1);
+/// getCanonicalInductionVariableIncrement - Return the LLVM value that holds
+/// the canonical induction variable value for the "next" iteration of the
+/// loop. This always succeeds if getCanonicalInductionVariable succeeds.
+///
+Instruction *Loop::getCanonicalInductionVariableIncrement() const {
+ if (PHINode *PN = getCanonicalInductionVariable()) {
+ bool P1InLoop = contains(PN->getIncomingBlock(1));
+ return cast<Instruction>(PN->getIncomingValue(P1InLoop));
+ }
+ return 0;
}
-void LoopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
- AU.setPreservesAll();
- AU.addRequired<DominatorSet>();
-}
+/// getTripCount - Return a loop-invariant LLVM value indicating the number of
+/// times the loop will be executed. Note that this means that the backedge
+/// of the loop executes N-1 times. If the trip-count cannot be determined,
+/// this returns null.
+///
+/// The IndVarSimplify pass transforms loops to have a form that this
+/// function easily understands.
+///
+Value *Loop::getTripCount() const {
+ // Canonical loops will end with a 'cmp ne I, V', where I is the incremented
+ // canonical induction variable and V is the trip count of the loop.
+ Instruction *Inc = getCanonicalInductionVariableIncrement();
+ if (Inc == 0) return 0;
+ PHINode *IV = cast<PHINode>(Inc->getOperand(0));
+
+ BasicBlock *BackedgeBlock =
+ IV->getIncomingBlock(contains(IV->getIncomingBlock(1)));
+
+ if (BranchInst *BI = dyn_cast<BranchInst>(BackedgeBlock->getTerminator()))
+ if (BI->isConditional()) {
+ if (ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition())) {
+ if (ICI->getOperand(0) == Inc) {
+ if (BI->getSuccessor(0) == getHeader()) {
+ if (ICI->getPredicate() == ICmpInst::ICMP_NE)
+ return ICI->getOperand(1);
+ } else if (ICI->getPredicate() == ICmpInst::ICMP_EQ) {
+ return ICI->getOperand(1);
+ }
+ }
+ }
+ }
-void LoopInfo::print(std::ostream &OS) const {
- for (unsigned i = 0; i < TopLevelLoops.size(); ++i)
- TopLevelLoops[i]->print(OS);
-#if 0
- for (std::map<BasicBlock*, Loop*>::const_iterator I = BBMap.begin(),
- E = BBMap.end(); I != E; ++I)
- OS << "BB '" << I->first->getName() << "' level = "
- << I->second->LoopDepth << "\n";
-#endif
+ return 0;
}
-Loop *LoopInfo::ConsiderForLoop(BasicBlock *BB, const DominatorSet &DS) {
- if (BBMap.find(BB) != BBMap.end()) return 0; // Haven't processed this node?
-
- std::vector<BasicBlock *> TodoStack;
-
- // Scan the predecessors of BB, checking to see if BB dominates any of
- // them.
- for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I)
- if (DS.dominates(BB, *I)) // If BB dominates it's predecessor...
- TodoStack.push_back(*I);
-
- if (TodoStack.empty()) return 0; // Doesn't dominate any predecessors...
-
- // Create a new loop to represent this basic block...
- Loop *L = new Loop(BB);
- BBMap[BB] = L;
-
- while (!TodoStack.empty()) { // Process all the nodes in the loop
- BasicBlock *X = TodoStack.back();
- TodoStack.pop_back();
-
- if (!L->contains(X)) { // As of yet unprocessed??
- L->Blocks.push_back(X);
-
- // Add all of the predecessors of X to the end of the work stack...
- TodoStack.insert(TodoStack.end(), pred_begin(X), pred_end(X));
+/// getSmallConstantTripCount - Returns the trip count of this loop as a
+/// normal unsigned value, if possible. Returns 0 if the trip count is unknown
+/// of not constant. Will also return 0 if the trip count is very large
+/// (>= 2^32)
+unsigned Loop::getSmallConstantTripCount() const {
+ Value* TripCount = this->getTripCount();
+ if (TripCount) {
+ if (ConstantInt *TripCountC = dyn_cast<ConstantInt>(TripCount)) {
+ // Guard against huge trip counts.
+ if (TripCountC->getValue().getActiveBits() <= 32) {
+ return (unsigned)TripCountC->getZExtValue();
+ }
}
}
+ return 0;
+}
- // If there are any loops nested within this loop, create them now!
- for (std::vector<BasicBlock*>::iterator I = L->Blocks.begin(),
- E = L->Blocks.end(); I != E; ++I)
- if (Loop *NewLoop = ConsiderForLoop(*I, DS)) {
- L->SubLoops.push_back(NewLoop);
- NewLoop->ParentLoop = L;
- }
-
-
- // Add the basic blocks that comprise this loop to the BBMap so that this
- // loop can be found for them.
- //
- for (std::vector<BasicBlock*>::iterator I = L->Blocks.begin(),
- E = L->Blocks.end(); I != E; ++I) {
- std::map<BasicBlock*, Loop*>::iterator BBMI = BBMap.lower_bound(*I);
- if (BBMI == BBMap.end() || BBMI->first != *I) // Not in map yet...
- BBMap.insert(BBMI, std::make_pair(*I, L)); // Must be at this level
+/// getSmallConstantTripMultiple - Returns the largest constant divisor of the
+/// trip count of this loop as a normal unsigned value, if possible. This
+/// means that the actual trip count is always a multiple of the returned
+/// value (don't forget the trip count could very well be zero as well!).
+///
+/// Returns 1 if the trip count is unknown or not guaranteed to be the
+/// multiple of a constant (which is also the case if the trip count is simply
+/// constant, use getSmallConstantTripCount for that case), Will also return 1
+/// if the trip count is very large (>= 2^32).
+unsigned Loop::getSmallConstantTripMultiple() const {
+ Value* TripCount = this->getTripCount();
+ // This will hold the ConstantInt result, if any
+ ConstantInt *Result = NULL;
+ if (TripCount) {
+ // See if the trip count is constant itself
+ Result = dyn_cast<ConstantInt>(TripCount);
+ // if not, see if it is a multiplication
+ if (!Result)
+ if (BinaryOperator *BO = dyn_cast<BinaryOperator>(TripCount)) {
+ switch (BO->getOpcode()) {
+ case BinaryOperator::Mul:
+ Result = dyn_cast<ConstantInt>(BO->getOperand(1));
+ break;
+ default:
+ break;
+ }
+ }
}
+ // Guard against huge trip counts.
+ if (Result && Result->getValue().getActiveBits() <= 32) {
+ return (unsigned)Result->getZExtValue();
+ } else {
+ return 1;
+ }
+}
- // Now that we know all of the blocks that make up this loop, see if there are
- // any branches to outside of the loop... building the ExitBlocks list.
- for (std::vector<BasicBlock*>::iterator BI = L->Blocks.begin(),
- BE = L->Blocks.end(); BI != BE; ++BI)
- for (succ_iterator I = succ_begin(*BI), E = succ_end(*BI); I != E; ++I)
- if (!L->contains(*I)) // Not in current loop?
- L->ExitBlocks.push_back(*I); // It must be an exit block...
+/// isLCSSAForm - Return true if the Loop is in LCSSA form
+bool Loop::isLCSSAForm() const {
+ // Sort the blocks vector so that we can use binary search to do quick
+ // lookups.
+ SmallPtrSet<BasicBlock *, 16> LoopBBs(block_begin(), block_end());
+
+ for (block_iterator BI = block_begin(), E = block_end(); BI != E; ++BI) {
+ BasicBlock *BB = *BI;
+ 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)) {
+ UserBB = P->getIncomingBlock(UI);
+ }
+
+ // Check the current block, as a fast-path. Most values are used in
+ // the same block they are defined in.
+ if (UserBB != BB && !LoopBBs.count(UserBB))
+ return false;
+ }
+ }
- return L;
+ return true;
}
-/// getLoopPreheader - If there is a preheader for this loop, return it. A
-/// loop has a preheader if there is only one edge to the header of the loop
-/// from outside of the loop. If this is the case, the block branching to the
-/// header of the loop is the preheader node. The "preheaders" pass can be
-/// "Required" to ensure that there is always a preheader node for every loop.
-///
-/// This method returns null if there is no preheader for the loop (either
-/// because the loop is dead or because multiple blocks branch to the header
-/// node of this loop).
-///
-BasicBlock *Loop::getLoopPreheader() const {
- // Keep track of nodes outside the loop branching to the header...
- BasicBlock *Out = 0;
-
- // Loop over the predecessors of the header node...
- BasicBlock *Header = getHeader();
- for (pred_iterator PI = pred_begin(Header), PE = pred_end(Header);
- PI != PE; ++PI)
- if (!contains(*PI)) { // If the block is not in the loop...
- if (Out && Out != *PI)
- return 0; // Multiple predecessors outside the loop
- Out = *PI;
- }
-
- // Make sure there is only one exit out of the preheader...
- succ_iterator SI = succ_begin(Out);
- ++SI;
- if (SI != succ_end(Out))
- return 0; // Multiple exits from the block, must not be a preheader.
-
+/// isLoopSimplifyForm - Return true if the Loop is in the form that
+/// the LoopSimplify form transforms loops to, which is sometimes called
+/// normal form.
+bool Loop::isLoopSimplifyForm() const {
+ // Normal-form loops have a preheader.
+ if (!getLoopPreheader())
+ return false;
+ // Normal-form loops have a single backedge.
+ if (!getLoopLatch())
+ return false;
+ // Each predecessor of each exit block of a normal loop is contained
+ // within the loop.
+ SmallVector<BasicBlock *, 4> ExitBlocks;
+ getExitBlocks(ExitBlocks);
+ for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i)
+ for (pred_iterator PI = pred_begin(ExitBlocks[i]),
+ PE = pred_end(ExitBlocks[i]); PI != PE; ++PI)
+ if (!contains(*PI))
+ return false;
+ // All the requirements are met.
+ return true;
+}
- // If there is exactly one preheader, return it. If there was zero, then Out
- // is still null.
- return Out;
+//===----------------------------------------------------------------------===//
+// LoopInfo implementation
+//
+bool LoopInfo::runOnFunction(Function &) {
+ releaseMemory();
+ LI.Calculate(getAnalysis<DominatorTree>().getBase()); // Update
+ return false;
}
-/// addBasicBlockToLoop - This function is used by other analyses to update loop
-/// information. NewBB is set to be a new member of the current loop. Because
-/// of this, it is added as a member of all parent loops, and is added to the
-/// specified LoopInfo object as being in the current basic block. It is not
-/// valid to replace the loop header with this method.
-///
-void Loop::addBasicBlockToLoop(BasicBlock *NewBB, LoopInfo &LI) {
- assert(LI[getHeader()] == this && "Incorrect LI specified for this loop!");
- assert(NewBB && "Cannot add a null basic block to the loop!");
- assert(LI[NewBB] == 0 && "BasicBlock already in the loop!");
-
- // Add the loop mapping to the LoopInfo object...
- LI.BBMap[NewBB] = this;
-
- // Add the basic block to this loop and all parent loops...
- Loop *L = this;
- while (L) {
- L->Blocks.push_back(NewBB);
- L = L->getParentLoop();
- }
+void LoopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.setPreservesAll();
+ AU.addRequired<DominatorTree>();
}
-/// changeExitBlock - This method is used to update loop information. All
-/// instances of the specified Old basic block are removed from the exit list
-/// and replaced with New.
-///
-void Loop::changeExitBlock(BasicBlock *Old, BasicBlock *New) {
- assert(Old != New && "Cannot changeExitBlock to the same thing!");
- assert(Old && New && "Cannot changeExitBlock to or from a null node!");
- std::vector<BasicBlock*>::iterator I =
- std::find(ExitBlocks.begin(), ExitBlocks.end(), Old);
- assert(I != ExitBlocks.end() && "Old exit block not found!");
- *I = New;
-
- I = std::find(I+1, ExitBlocks.end(), Old);
- while (I != ExitBlocks.end()) {
- *I = New;
- I = std::find(I+1, ExitBlocks.end(), Old);
- }
+void LoopInfo::print(raw_ostream &OS, const Module*) const {
+ LI.print(OS);
}
+