2006-05-26 21:11:53 +00:00
|
|
|
//===-- LCSSA.cpp - Convert loops into loop-closed SSA form ---------------===//
|
2006-05-26 13:58:26 +00:00
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-29 20:36:04 +00:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2006-05-26 13:58:26 +00:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This pass transforms loops by placing phi nodes at the end of the loops for
|
|
|
|
// all values that are live across the loop boundary. For example, it turns
|
|
|
|
// the left into the right code:
|
|
|
|
//
|
|
|
|
// for (...) for (...)
|
2007-05-11 21:10:54 +00:00
|
|
|
// if (c) if (c)
|
2006-05-26 13:58:26 +00:00
|
|
|
// X1 = ... X1 = ...
|
|
|
|
// else else
|
|
|
|
// X2 = ... X2 = ...
|
|
|
|
// X3 = phi(X1, X2) X3 = phi(X1, X2)
|
|
|
|
// ... = 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
|
|
|
|
// transformation is that it makes many other loop optimizations, such as
|
|
|
|
// LoopUnswitching, simpler.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2006-12-19 22:17:40 +00:00
|
|
|
#define DEBUG_TYPE "lcssa"
|
2006-05-26 21:11:53 +00:00
|
|
|
#include "llvm/Transforms/Scalar.h"
|
2006-07-09 08:14:06 +00:00
|
|
|
#include "llvm/Constants.h"
|
2006-05-26 13:58:26 +00:00
|
|
|
#include "llvm/Pass.h"
|
|
|
|
#include "llvm/Function.h"
|
|
|
|
#include "llvm/Instructions.h"
|
2006-06-04 00:02:23 +00:00
|
|
|
#include "llvm/ADT/SetVector.h"
|
2006-05-27 00:31:37 +00:00
|
|
|
#include "llvm/ADT/Statistic.h"
|
2006-05-26 21:11:53 +00:00
|
|
|
#include "llvm/Analysis/Dominators.h"
|
2007-07-13 23:57:11 +00:00
|
|
|
#include "llvm/Analysis/LoopPass.h"
|
|
|
|
#include "llvm/Analysis/ScalarEvolution.h"
|
2006-05-26 13:58:26 +00:00
|
|
|
#include "llvm/Support/CFG.h"
|
2007-02-05 23:32:05 +00:00
|
|
|
#include "llvm/Support/Compiler.h"
|
2006-05-26 21:11:53 +00:00
|
|
|
#include <algorithm>
|
2007-02-05 05:23:32 +00:00
|
|
|
#include <map>
|
2006-05-26 13:58:26 +00:00
|
|
|
using namespace llvm;
|
|
|
|
|
2006-12-19 22:17:40 +00:00
|
|
|
STATISTIC(NumLCSSA, "Number of live out of a loop variables");
|
|
|
|
|
2006-05-26 13:58:26 +00:00
|
|
|
namespace {
|
2007-07-13 23:57:11 +00:00
|
|
|
struct VISIBILITY_HIDDEN LCSSA : public LoopPass {
|
2007-05-06 13:37:16 +00:00
|
|
|
static char ID; // Pass identification, replacement for typeid
|
2007-07-13 23:57:11 +00:00
|
|
|
LCSSA() : LoopPass((intptr_t)&ID) {}
|
2007-05-01 21:15:47 +00:00
|
|
|
|
2006-08-02 00:06:09 +00:00
|
|
|
// Cached analysis information for the current function.
|
|
|
|
LoopInfo *LI;
|
2007-04-18 22:39:00 +00:00
|
|
|
DominatorTree *DT;
|
2006-06-06 04:28:30 +00:00
|
|
|
std::vector<BasicBlock*> LoopBlocks;
|
2006-05-26 13:58:26 +00:00
|
|
|
|
2007-07-13 23:57:11 +00:00
|
|
|
virtual bool runOnLoop(Loop *L, LPPassManager &LPM);
|
|
|
|
|
2006-08-02 00:06:09 +00:00
|
|
|
void ProcessInstruction(Instruction* Instr,
|
2007-08-21 00:31:24 +00:00
|
|
|
const SmallVector<BasicBlock*, 8>& exitBlocks);
|
2006-05-26 13:58:26 +00:00
|
|
|
|
|
|
|
/// This transformation requires natural loop information & requires that
|
2006-05-27 00:31:37 +00:00
|
|
|
/// loop preheaders be inserted into the CFG. It maintains both of these,
|
|
|
|
/// as well as the CFG. It also requires dominator information.
|
2006-05-26 13:58:26 +00:00
|
|
|
///
|
|
|
|
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
|
2006-05-26 21:11:53 +00:00
|
|
|
AU.setPreservesCFG();
|
2006-05-26 13:58:26 +00:00
|
|
|
AU.addRequiredID(LoopSimplifyID);
|
|
|
|
AU.addPreservedID(LoopSimplifyID);
|
|
|
|
AU.addRequired<LoopInfo>();
|
2007-07-13 23:57:11 +00:00
|
|
|
AU.addPreserved<LoopInfo>();
|
2007-04-18 22:39:00 +00:00
|
|
|
AU.addRequired<DominatorTree>();
|
2007-07-13 23:57:11 +00:00
|
|
|
AU.addPreserved<ScalarEvolution>();
|
2007-07-30 20:23:45 +00:00
|
|
|
AU.addPreserved<DominatorTree>();
|
|
|
|
|
|
|
|
// Request DominanceFrontier now, even though LCSSA does
|
|
|
|
// not use it. This allows Pass Manager to schedule Dominance
|
|
|
|
// Frontier early enough such that one LPPassManager can handle
|
|
|
|
// multiple loop transformation passes.
|
|
|
|
AU.addRequired<DominanceFrontier>();
|
|
|
|
AU.addPreserved<DominanceFrontier>();
|
2006-05-26 13:58:26 +00:00
|
|
|
}
|
|
|
|
private:
|
2007-04-14 22:10:17 +00:00
|
|
|
void getLoopValuesUsedOutsideLoop(Loop *L,
|
|
|
|
SetVector<Instruction*> &AffectedValues);
|
2006-08-02 00:06:09 +00:00
|
|
|
|
2007-06-04 00:32:22 +00:00
|
|
|
Value *GetValueForBlock(DomTreeNode *BB, Instruction *OrigInst,
|
|
|
|
std::map<DomTreeNode*, Value*> &Phis);
|
2006-08-02 00:06:09 +00:00
|
|
|
|
2006-06-06 04:28:30 +00:00
|
|
|
/// inLoop - returns true if the given block is within the current loop
|
2008-02-20 12:07:57 +00:00
|
|
|
bool inLoop(BasicBlock* B) {
|
2006-06-06 04:36:36 +00:00
|
|
|
return std::binary_search(LoopBlocks.begin(), LoopBlocks.end(), B);
|
|
|
|
}
|
2006-05-26 13:58:26 +00:00
|
|
|
};
|
|
|
|
|
2007-05-03 01:11:54 +00:00
|
|
|
char LCSSA::ID = 0;
|
2006-08-27 22:42:52 +00:00
|
|
|
RegisterPass<LCSSA> X("lcssa", "Loop-Closed SSA Form Pass");
|
2006-05-26 13:58:26 +00:00
|
|
|
}
|
|
|
|
|
2007-07-13 23:57:11 +00:00
|
|
|
LoopPass *llvm::createLCSSAPass() { return new LCSSA(); }
|
2006-06-08 20:02:53 +00:00
|
|
|
const PassInfo *llvm::LCSSAID = X.getPassInfo();
|
2006-05-26 13:58:26 +00:00
|
|
|
|
2006-06-08 20:02:53 +00:00
|
|
|
/// runOnFunction - Process all loops in the function, inner-most out.
|
2007-07-13 23:57:11 +00:00
|
|
|
bool LCSSA::runOnLoop(Loop *L, LPPassManager &LPM) {
|
2006-06-13 19:37:18 +00:00
|
|
|
|
2007-07-13 23:57:11 +00:00
|
|
|
LI = &LPM.getAnalysis<LoopInfo>();
|
2007-04-18 22:39:00 +00:00
|
|
|
DT = &getAnalysis<DominatorTree>();
|
2007-08-17 21:59:16 +00:00
|
|
|
|
2006-05-26 21:11:53 +00:00
|
|
|
// Speed up queries by creating a sorted list of blocks
|
2006-06-06 04:28:30 +00:00
|
|
|
LoopBlocks.clear();
|
|
|
|
LoopBlocks.insert(LoopBlocks.end(), L->block_begin(), L->block_end());
|
|
|
|
std::sort(LoopBlocks.begin(), LoopBlocks.end());
|
2006-05-26 21:11:53 +00:00
|
|
|
|
2007-04-14 22:10:17 +00:00
|
|
|
SetVector<Instruction*> AffectedValues;
|
|
|
|
getLoopValuesUsedOutsideLoop(L, AffectedValues);
|
2006-05-26 13:58:26 +00:00
|
|
|
|
2006-05-31 20:55:06 +00:00
|
|
|
// If no values are affected, we can save a lot of work, since we know that
|
|
|
|
// nothing will be changed.
|
|
|
|
if (AffectedValues.empty())
|
|
|
|
return false;
|
|
|
|
|
2007-08-21 00:31:24 +00:00
|
|
|
SmallVector<BasicBlock*, 8> exitBlocks;
|
|
|
|
L->getExitBlocks(exitBlocks);
|
2006-05-27 18:47:11 +00:00
|
|
|
|
|
|
|
// Iterate over all affected values for this loop and insert Phi nodes
|
|
|
|
// for them in the appropriate exit blocks
|
2006-05-31 20:55:06 +00:00
|
|
|
|
2006-06-04 00:02:23 +00:00
|
|
|
for (SetVector<Instruction*>::iterator I = AffectedValues.begin(),
|
2006-08-02 00:06:09 +00:00
|
|
|
E = AffectedValues.end(); I != E; ++I)
|
|
|
|
ProcessInstruction(*I, exitBlocks);
|
2006-05-31 20:55:06 +00:00
|
|
|
|
2006-06-11 19:22:28 +00:00
|
|
|
assert(L->isLCSSAForm());
|
|
|
|
|
2006-06-06 04:28:30 +00:00
|
|
|
return true;
|
2006-05-31 20:55:06 +00:00
|
|
|
}
|
|
|
|
|
2006-06-08 20:02:53 +00:00
|
|
|
/// processInstruction - Given a live-out instruction, insert LCSSA Phi nodes,
|
|
|
|
/// eliminate all out-of-loop uses.
|
2006-08-02 00:06:09 +00:00
|
|
|
void LCSSA::ProcessInstruction(Instruction *Instr,
|
2007-08-21 00:31:24 +00:00
|
|
|
const SmallVector<BasicBlock*, 8>& exitBlocks) {
|
2006-05-31 20:55:06 +00:00
|
|
|
++NumLCSSA; // We are applying the transformation
|
2006-08-02 00:06:09 +00:00
|
|
|
|
|
|
|
// Keep track of the blocks that have the value available already.
|
2007-06-04 00:32:22 +00:00
|
|
|
std::map<DomTreeNode*, Value*> Phis;
|
2006-08-02 00:06:09 +00:00
|
|
|
|
2007-06-04 00:32:22 +00:00
|
|
|
DomTreeNode *InstrNode = DT->getNode(Instr->getParent());
|
2006-08-02 00:06:09 +00:00
|
|
|
|
|
|
|
// Insert the LCSSA phi's into the exit blocks (dominated by the value), and
|
|
|
|
// add them to the Phi's map.
|
2007-08-21 00:31:24 +00:00
|
|
|
for (SmallVector<BasicBlock*, 8>::const_iterator BBI = exitBlocks.begin(),
|
2006-06-12 07:10:16 +00:00
|
|
|
BBE = exitBlocks.end(); BBI != BBE; ++BBI) {
|
2006-08-02 00:06:09 +00:00
|
|
|
BasicBlock *BB = *BBI;
|
2007-06-04 00:32:22 +00:00
|
|
|
DomTreeNode *ExitBBNode = DT->getNode(BB);
|
2007-04-18 22:39:00 +00:00
|
|
|
Value *&Phi = Phis[ExitBBNode];
|
2007-06-07 17:47:21 +00:00
|
|
|
if (!Phi && DT->dominates(InstrNode, ExitBBNode)) {
|
2006-10-31 18:56:48 +00:00
|
|
|
PHINode *PN = new PHINode(Instr->getType(), Instr->getName()+".lcssa",
|
|
|
|
BB->begin());
|
|
|
|
PN->reserveOperandSpace(std::distance(pred_begin(BB), pred_end(BB)));
|
|
|
|
|
|
|
|
// Remember that this phi makes the value alive in this block.
|
|
|
|
Phi = PN;
|
2006-08-02 00:06:09 +00:00
|
|
|
|
|
|
|
// Add inputs from inside the loop for this PHI.
|
|
|
|
for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
|
2006-10-31 18:56:48 +00:00
|
|
|
PN->addIncoming(Instr, *PI);
|
2006-05-28 19:33:28 +00:00
|
|
|
}
|
2006-06-03 23:22:50 +00:00
|
|
|
}
|
|
|
|
|
2006-05-29 01:00:00 +00:00
|
|
|
|
2006-08-02 00:06:09 +00:00
|
|
|
// Record all uses of Instr outside the loop. We need to rewrite these. The
|
|
|
|
// LCSSA phis won't be included because they use the value in the loop.
|
|
|
|
for (Value::use_iterator UI = Instr->use_begin(), E = Instr->use_end();
|
|
|
|
UI != E;) {
|
|
|
|
BasicBlock *UserBB = cast<Instruction>(*UI)->getParent();
|
|
|
|
if (PHINode *P = dyn_cast<PHINode>(*UI)) {
|
2006-06-13 20:50:09 +00:00
|
|
|
unsigned OperandNo = UI.getOperandNo();
|
2006-08-02 00:06:09 +00:00
|
|
|
UserBB = P->getIncomingBlock(OperandNo/2);
|
2006-06-13 20:50:09 +00:00
|
|
|
}
|
|
|
|
|
2006-08-02 00:06:09 +00:00
|
|
|
// If the user is in the loop, don't rewrite it!
|
2006-08-02 00:16:47 +00:00
|
|
|
if (UserBB == Instr->getParent() || inLoop(UserBB)) {
|
2006-08-02 00:06:09 +00:00
|
|
|
++UI;
|
|
|
|
continue;
|
2006-06-01 06:05:47 +00:00
|
|
|
}
|
2006-08-02 00:06:09 +00:00
|
|
|
|
|
|
|
// Otherwise, patch up uses of the value with the appropriate LCSSA Phi,
|
|
|
|
// inserting PHI nodes into join points where needed.
|
2007-04-18 22:39:00 +00:00
|
|
|
Value *Val = GetValueForBlock(DT->getNode(UserBB), Instr, Phis);
|
2006-08-02 00:06:09 +00:00
|
|
|
|
|
|
|
// Preincrement the iterator to avoid invalidating it when we change the
|
|
|
|
// value.
|
|
|
|
Use &U = UI.getUse();
|
|
|
|
++UI;
|
|
|
|
U.set(Val);
|
2006-05-31 20:55:06 +00:00
|
|
|
}
|
2006-05-26 13:58:26 +00:00
|
|
|
}
|
|
|
|
|
2006-05-26 21:11:53 +00:00
|
|
|
/// getLoopValuesUsedOutsideLoop - Return any values defined in the loop that
|
|
|
|
/// are used by instructions outside of it.
|
2007-04-14 22:10:17 +00:00
|
|
|
void LCSSA::getLoopValuesUsedOutsideLoop(Loop *L,
|
|
|
|
SetVector<Instruction*> &AffectedValues) {
|
2006-05-31 20:55:06 +00:00
|
|
|
// 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.
|
2006-05-26 13:58:26 +00:00
|
|
|
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();
|
2006-06-13 19:37:18 +00:00
|
|
|
if (PHINode* p = dyn_cast<PHINode>(*UI)) {
|
|
|
|
unsigned OperandNo = UI.getOperandNo();
|
|
|
|
UserBB = p->getIncomingBlock(OperandNo/2);
|
|
|
|
}
|
|
|
|
|
2006-08-02 00:16:47 +00:00
|
|
|
if (*BB != UserBB && !inLoop(UserBB)) {
|
2006-05-26 13:58:26 +00:00
|
|
|
AffectedValues.insert(I);
|
2006-05-31 20:55:06 +00:00
|
|
|
break;
|
|
|
|
}
|
2006-05-26 13:58:26 +00:00
|
|
|
}
|
|
|
|
}
|
2006-05-26 21:11:53 +00:00
|
|
|
}
|
2006-05-31 20:55:06 +00:00
|
|
|
|
2006-08-02 00:06:09 +00:00
|
|
|
/// GetValueForBlock - Get the value to use within the specified basic block.
|
|
|
|
/// available values are in Phis.
|
2007-06-04 00:32:22 +00:00
|
|
|
Value *LCSSA::GetValueForBlock(DomTreeNode *BB, Instruction *OrigInst,
|
|
|
|
std::map<DomTreeNode*, Value*> &Phis) {
|
2006-10-31 18:56:48 +00:00
|
|
|
// If there is no dominator info for this BB, it is unreachable.
|
|
|
|
if (BB == 0)
|
|
|
|
return UndefValue::get(OrigInst->getType());
|
|
|
|
|
2006-08-02 00:06:09 +00:00
|
|
|
// If we have already computed this value, return the previously computed val.
|
2006-10-31 18:56:48 +00:00
|
|
|
Value *&V = Phis[BB];
|
2006-08-02 00:06:09 +00:00
|
|
|
if (V) return V;
|
|
|
|
|
2007-06-04 00:32:22 +00:00
|
|
|
DomTreeNode *IDom = BB->getIDom();
|
2006-08-02 00:06:09 +00:00
|
|
|
|
|
|
|
// Otherwise, there are two cases: we either have to insert a PHI node or we
|
|
|
|
// don't. We need to insert a PHI node if this block is not dominated by one
|
|
|
|
// of the exit nodes from the loop (the loop could have multiple exits, and
|
|
|
|
// though the value defined *inside* the loop dominated all its uses, each
|
|
|
|
// exit by itself may not dominate all the uses).
|
|
|
|
//
|
|
|
|
// The simplest way to check for this condition is by checking to see if the
|
|
|
|
// idom is in the loop. If so, we *know* that none of the exit blocks
|
|
|
|
// dominate this block. Note that we *know* that the block defining the
|
|
|
|
// original instruction is in the idom chain, because if it weren't, then the
|
|
|
|
// original value didn't dominate this use.
|
2007-04-18 22:39:00 +00:00
|
|
|
if (!inLoop(IDom->getBlock())) {
|
2006-08-02 00:06:09 +00:00
|
|
|
// Idom is not in the loop, we must still be "below" the exit block and must
|
|
|
|
// be fully dominated by the value live in the idom.
|
|
|
|
return V = GetValueForBlock(IDom, OrigInst, Phis);
|
|
|
|
}
|
2006-07-09 08:14:06 +00:00
|
|
|
|
2007-04-18 22:39:00 +00:00
|
|
|
BasicBlock *BBN = BB->getBlock();
|
|
|
|
|
2006-08-02 00:06:09 +00:00
|
|
|
// Otherwise, the idom is the loop, so we need to insert a PHI node. Do so
|
|
|
|
// now, then get values to fill in the incoming values for the PHI.
|
2006-10-31 18:56:48 +00:00
|
|
|
PHINode *PN = new PHINode(OrigInst->getType(), OrigInst->getName()+".lcssa",
|
2007-04-18 22:39:00 +00:00
|
|
|
BBN->begin());
|
|
|
|
PN->reserveOperandSpace(std::distance(pred_begin(BBN), pred_end(BBN)));
|
2006-10-31 18:56:48 +00:00
|
|
|
V = PN;
|
|
|
|
|
2006-08-02 00:06:09 +00:00
|
|
|
// Fill in the incoming values for the block.
|
2007-04-18 22:39:00 +00:00
|
|
|
for (pred_iterator PI = pred_begin(BBN), E = pred_end(BBN); PI != E; ++PI)
|
|
|
|
PN->addIncoming(GetValueForBlock(DT->getNode(*PI), OrigInst, Phis), *PI);
|
2006-10-31 18:56:48 +00:00
|
|
|
return PN;
|
2006-05-31 20:55:06 +00:00
|
|
|
}
|
2006-08-02 00:06:09 +00:00
|
|
|
|