2002-08-03 00:43:03 +08:00
|
|
|
//===- Dominators.cpp - Dominator Calculation -----------------------------===//
|
2005-04-22 07:48:37 +08:00
|
|
|
//
|
2003-10-21 03:43:21 +08:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-30 04:36:04 +08:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2005-04-22 07:48:37 +08:00
|
|
|
//
|
2003-10-21 03:43:21 +08:00
|
|
|
//===----------------------------------------------------------------------===//
|
2001-07-02 13:46:38 +08:00
|
|
|
//
|
2002-08-03 00:43:03 +08:00
|
|
|
// This file implements simple dominator construction algorithms for finding
|
|
|
|
// forward dominators. Postdominators are available in libanalysis, but are not
|
|
|
|
// included in libvmcore, because it's not needed. Forward dominators are
|
|
|
|
// needed to support the Verifier pass.
|
2001-07-02 13:46:38 +08:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2014-01-13 17:26:24 +08:00
|
|
|
#include "llvm/IR/Dominators.h"
|
2004-09-02 06:55:40 +08:00
|
|
|
#include "llvm/ADT/DepthFirstIterator.h"
|
2007-03-28 04:50:46 +08:00
|
|
|
#include "llvm/ADT/SmallPtrSet.h"
|
2007-08-08 13:51:24 +08:00
|
|
|
#include "llvm/ADT/SmallVector.h"
|
2014-03-04 19:45:46 +08:00
|
|
|
#include "llvm/IR/CFG.h"
|
2013-01-02 19:36:10 +08:00
|
|
|
#include "llvm/IR/Instructions.h"
|
2015-01-14 18:19:28 +08:00
|
|
|
#include "llvm/IR/PassManager.h"
|
2009-09-28 08:27:48 +08:00
|
|
|
#include "llvm/Support/CommandLine.h"
|
2012-12-04 00:50:05 +08:00
|
|
|
#include "llvm/Support/Compiler.h"
|
|
|
|
#include "llvm/Support/Debug.h"
|
2014-01-13 18:52:56 +08:00
|
|
|
#include "llvm/Support/GenericDomTreeConstruction.h"
|
2012-12-04 00:50:05 +08:00
|
|
|
#include "llvm/Support/raw_ostream.h"
|
2004-06-05 08:24:59 +08:00
|
|
|
#include <algorithm>
|
2003-11-22 04:23:48 +08:00
|
|
|
using namespace llvm;
|
2003-11-12 06:41:34 +08:00
|
|
|
|
2009-09-28 08:27:48 +08:00
|
|
|
// Always verify dominfo if expensive checking is enabled.
|
|
|
|
#ifdef XDEBUG
|
2010-04-16 01:08:50 +08:00
|
|
|
static bool VerifyDomInfo = true;
|
2009-09-28 08:27:48 +08:00
|
|
|
#else
|
2010-04-16 01:08:50 +08:00
|
|
|
static bool VerifyDomInfo = false;
|
2009-09-28 08:27:48 +08:00
|
|
|
#endif
|
|
|
|
static cl::opt<bool,true>
|
|
|
|
VerifyDomInfoX("verify-dom-info", cl::location(VerifyDomInfo),
|
|
|
|
cl::desc("Verify dominator info (time consuming)"));
|
|
|
|
|
2012-08-16 23:09:43 +08:00
|
|
|
bool BasicBlockEdge::isSingleEdge() const {
|
|
|
|
const TerminatorInst *TI = Start->getTerminator();
|
|
|
|
unsigned NumEdgesToEnd = 0;
|
|
|
|
for (unsigned int i = 0, n = TI->getNumSuccessors(); i < n; ++i) {
|
|
|
|
if (TI->getSuccessor(i) == End)
|
|
|
|
++NumEdgesToEnd;
|
|
|
|
if (NumEdgesToEnd >= 2)
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
assert(NumEdgesToEnd == 1);
|
|
|
|
return true;
|
2012-08-10 22:05:55 +08:00
|
|
|
}
|
|
|
|
|
2003-12-07 08:38:08 +08:00
|
|
|
//===----------------------------------------------------------------------===//
|
2007-04-15 16:47:27 +08:00
|
|
|
// DominatorTree Implementation
|
2003-12-07 08:38:08 +08:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2007-09-24 05:31:44 +08:00
|
|
|
// Provide public access to DominatorTree information. Implementation details
|
2014-01-13 18:52:56 +08:00
|
|
|
// can be found in Dominators.h, GenericDomTree.h, and
|
|
|
|
// GenericDomTreeConstruction.h.
|
2003-12-07 08:38:08 +08:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2015-07-14 01:21:31 +08:00
|
|
|
template class llvm::DomTreeNodeBase<BasicBlock>;
|
|
|
|
template class llvm::DominatorTreeBase<BasicBlock>;
|
2007-10-17 03:59:25 +08:00
|
|
|
|
2015-07-14 01:21:31 +08:00
|
|
|
template void llvm::Calculate<Function, BasicBlock *>(
|
|
|
|
DominatorTreeBase<GraphTraits<BasicBlock *>::NodeType> &DT, Function &F);
|
|
|
|
template void llvm::Calculate<Function, Inverse<BasicBlock *>>(
|
|
|
|
DominatorTreeBase<GraphTraits<Inverse<BasicBlock *>>::NodeType> &DT,
|
|
|
|
Function &F);
|
2014-02-15 06:36:16 +08:00
|
|
|
|
2012-02-26 10:19:19 +08:00
|
|
|
// dominates - Return true if Def dominates a use in User. This performs
|
|
|
|
// the special checks necessary if Def and User are in the same basic block.
|
|
|
|
// Note that Def doesn't dominate a use in Def itself!
|
|
|
|
bool DominatorTree::dominates(const Instruction *Def,
|
|
|
|
const Instruction *User) const {
|
|
|
|
const BasicBlock *UseBB = User->getParent();
|
|
|
|
const BasicBlock *DefBB = Def->getParent();
|
|
|
|
|
2012-03-31 00:46:21 +08:00
|
|
|
// Any unreachable use is dominated, even if Def == User.
|
|
|
|
if (!isReachableFromEntry(UseBB))
|
|
|
|
return true;
|
|
|
|
|
|
|
|
// Unreachable definitions don't dominate anything.
|
|
|
|
if (!isReachableFromEntry(DefBB))
|
|
|
|
return false;
|
2012-02-26 10:19:19 +08:00
|
|
|
|
|
|
|
// An instruction doesn't dominate a use in itself.
|
|
|
|
if (Def == User)
|
|
|
|
return false;
|
|
|
|
|
2015-08-15 10:46:08 +08:00
|
|
|
// The value defined by an invoke/catchpad dominates an instruction only if
|
2012-02-26 10:19:19 +08:00
|
|
|
// it dominates every instruction in UseBB.
|
|
|
|
// A PHI is dominated only if the instruction dominates every possible use
|
|
|
|
// in the UseBB.
|
2015-08-15 10:46:08 +08:00
|
|
|
if (isa<InvokeInst>(Def) || isa<CatchPadInst>(Def) || isa<PHINode>(User))
|
2012-02-26 10:19:19 +08:00
|
|
|
return dominates(Def, UseBB);
|
|
|
|
|
|
|
|
if (DefBB != UseBB)
|
|
|
|
return dominates(DefBB, UseBB);
|
2012-02-19 03:46:02 +08:00
|
|
|
|
2012-02-26 10:19:19 +08:00
|
|
|
// Loop through the basic block until we find Def or User.
|
|
|
|
BasicBlock::const_iterator I = DefBB->begin();
|
|
|
|
for (; &*I != Def && &*I != User; ++I)
|
|
|
|
/*empty*/;
|
|
|
|
|
|
|
|
return &*I == Def;
|
|
|
|
}
|
2012-02-19 03:46:02 +08:00
|
|
|
|
2012-02-26 10:19:19 +08:00
|
|
|
// true if Def would dominate a use in any instruction in UseBB.
|
|
|
|
// note that dominates(Def, Def->getParent()) is false.
|
|
|
|
bool DominatorTree::dominates(const Instruction *Def,
|
|
|
|
const BasicBlock *UseBB) const {
|
|
|
|
const BasicBlock *DefBB = Def->getParent();
|
2012-02-19 03:46:02 +08:00
|
|
|
|
2012-03-31 00:46:21 +08:00
|
|
|
// Any unreachable use is dominated, even if DefBB == UseBB.
|
|
|
|
if (!isReachableFromEntry(UseBB))
|
|
|
|
return true;
|
|
|
|
|
|
|
|
// Unreachable definitions don't dominate anything.
|
|
|
|
if (!isReachableFromEntry(DefBB))
|
|
|
|
return false;
|
2012-02-26 10:19:19 +08:00
|
|
|
|
|
|
|
if (DefBB == UseBB)
|
2009-09-22 06:30:50 +08:00
|
|
|
return false;
|
2012-02-19 03:46:02 +08:00
|
|
|
|
2015-08-15 10:46:08 +08:00
|
|
|
// Invoke/CatchPad results are only usable in the normal destination, not in
|
|
|
|
// the exceptional destination.
|
|
|
|
if (const auto *II = dyn_cast<InvokeInst>(Def)) {
|
|
|
|
BasicBlock *NormalDest = II->getNormalDest();
|
|
|
|
BasicBlockEdge E(DefBB, NormalDest);
|
|
|
|
return dominates(E, UseBB);
|
|
|
|
}
|
|
|
|
if (const auto *CPI = dyn_cast<CatchPadInst>(Def)) {
|
|
|
|
BasicBlock *NormalDest = CPI->getNormalDest();
|
|
|
|
BasicBlockEdge E(DefBB, NormalDest);
|
|
|
|
return dominates(E, UseBB);
|
|
|
|
}
|
2012-02-19 03:46:02 +08:00
|
|
|
|
2015-08-15 10:46:08 +08:00
|
|
|
return dominates(DefBB, UseBB);
|
2012-08-08 01:30:46 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
bool DominatorTree::dominates(const BasicBlockEdge &BBE,
|
|
|
|
const BasicBlock *UseBB) const {
|
2012-08-18 02:21:28 +08:00
|
|
|
// Assert that we have a single edge. We could handle them by simply
|
|
|
|
// returning false, but since isSingleEdge is linear on the number of
|
|
|
|
// edges, the callers can normally handle them more efficiently.
|
2015-08-28 14:52:00 +08:00
|
|
|
assert(BBE.isSingleEdge());
|
2012-08-18 02:21:28 +08:00
|
|
|
|
2012-08-08 01:30:46 +08:00
|
|
|
// If the BB the edge ends in doesn't dominate the use BB, then the
|
|
|
|
// edge also doesn't.
|
|
|
|
const BasicBlock *Start = BBE.getStart();
|
|
|
|
const BasicBlock *End = BBE.getEnd();
|
|
|
|
if (!dominates(End, UseBB))
|
2012-02-26 10:19:19 +08:00
|
|
|
return false;
|
|
|
|
|
2012-08-08 01:30:46 +08:00
|
|
|
// Simple case: if the end BB has a single predecessor, the fact that it
|
|
|
|
// dominates the use block implies that the edge also does.
|
|
|
|
if (End->getSinglePredecessor())
|
2012-02-26 10:19:19 +08:00
|
|
|
return true;
|
|
|
|
|
|
|
|
// The normal edge from the invoke is critical. Conceptually, what we would
|
|
|
|
// like to do is split it and check if the new block dominates the use.
|
|
|
|
// With X being the new block, the graph would look like:
|
|
|
|
//
|
|
|
|
// DefBB
|
|
|
|
// /\ . .
|
|
|
|
// / \ . .
|
|
|
|
// / \ . .
|
|
|
|
// / \ | |
|
|
|
|
// A X B C
|
|
|
|
// | \ | /
|
|
|
|
// . \|/
|
|
|
|
// . NormalDest
|
|
|
|
// .
|
|
|
|
//
|
2012-09-27 18:14:43 +08:00
|
|
|
// Given the definition of dominance, NormalDest is dominated by X iff X
|
2012-02-26 10:19:19 +08:00
|
|
|
// dominates all of NormalDest's predecessors (X, B, C in the example). X
|
|
|
|
// trivially dominates itself, so we only have to find if it dominates the
|
|
|
|
// other predecessors. Since the only way out of X is via NormalDest, X can
|
|
|
|
// only properly dominate a node if NormalDest dominates that node too.
|
2014-07-22 01:06:51 +08:00
|
|
|
for (const_pred_iterator PI = pred_begin(End), E = pred_end(End);
|
|
|
|
PI != E; ++PI) {
|
|
|
|
const BasicBlock *BB = *PI;
|
2012-08-08 01:30:46 +08:00
|
|
|
if (BB == Start)
|
2012-02-26 10:19:19 +08:00
|
|
|
continue;
|
|
|
|
|
2012-08-08 01:30:46 +08:00
|
|
|
if (!dominates(End, BB))
|
2012-02-26 10:19:19 +08:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return true;
|
2009-09-22 06:30:50 +08:00
|
|
|
}
|
2012-04-13 07:31:46 +08:00
|
|
|
|
2014-01-13 21:07:17 +08:00
|
|
|
bool DominatorTree::dominates(const BasicBlockEdge &BBE, const Use &U) const {
|
2012-08-18 02:21:28 +08:00
|
|
|
// Assert that we have a single edge. We could handle them by simply
|
|
|
|
// returning false, but since isSingleEdge is linear on the number of
|
|
|
|
// edges, the callers can normally handle them more efficiently.
|
2015-08-28 14:52:00 +08:00
|
|
|
assert(BBE.isSingleEdge());
|
2012-08-18 02:21:28 +08:00
|
|
|
|
2012-08-08 01:30:46 +08:00
|
|
|
Instruction *UserInst = cast<Instruction>(U.getUser());
|
|
|
|
// A PHI in the end of the edge is dominated by it.
|
|
|
|
PHINode *PN = dyn_cast<PHINode>(UserInst);
|
|
|
|
if (PN && PN->getParent() == BBE.getEnd() &&
|
|
|
|
PN->getIncomingBlock(U) == BBE.getStart())
|
|
|
|
return true;
|
2012-04-13 07:31:46 +08:00
|
|
|
|
2012-08-08 01:30:46 +08:00
|
|
|
// Otherwise use the edge-dominates-block query, which
|
|
|
|
// handles the crazy critical edge cases properly.
|
|
|
|
const BasicBlock *UseBB;
|
|
|
|
if (PN)
|
|
|
|
UseBB = PN->getIncomingBlock(U);
|
|
|
|
else
|
|
|
|
UseBB = UserInst->getParent();
|
|
|
|
return dominates(BBE, UseBB);
|
|
|
|
}
|
2012-04-13 07:31:46 +08:00
|
|
|
|
2014-01-13 21:07:17 +08:00
|
|
|
bool DominatorTree::dominates(const Instruction *Def, const Use &U) const {
|
2012-08-08 01:30:46 +08:00
|
|
|
Instruction *UserInst = cast<Instruction>(U.getUser());
|
2012-04-13 07:31:46 +08:00
|
|
|
const BasicBlock *DefBB = Def->getParent();
|
|
|
|
|
|
|
|
// Determine the block in which the use happens. PHI nodes use
|
|
|
|
// their operands on edges; simulate this by thinking of the use
|
|
|
|
// happening at the end of the predecessor block.
|
|
|
|
const BasicBlock *UseBB;
|
|
|
|
if (PHINode *PN = dyn_cast<PHINode>(UserInst))
|
|
|
|
UseBB = PN->getIncomingBlock(U);
|
|
|
|
else
|
|
|
|
UseBB = UserInst->getParent();
|
|
|
|
|
|
|
|
// Any unreachable use is dominated, even if Def == User.
|
|
|
|
if (!isReachableFromEntry(UseBB))
|
|
|
|
return true;
|
|
|
|
|
|
|
|
// Unreachable definitions don't dominate anything.
|
|
|
|
if (!isReachableFromEntry(DefBB))
|
|
|
|
return false;
|
|
|
|
|
2015-08-15 10:46:08 +08:00
|
|
|
// Invoke/CatchPad instructions define their return values on the edges
|
2012-04-13 07:31:46 +08:00
|
|
|
// to their normal successors, so we have to handle them specially.
|
|
|
|
// Among other things, this means they don't dominate anything in
|
|
|
|
// their own block, except possibly a phi, so we don't need to
|
|
|
|
// walk the block in any case.
|
|
|
|
if (const InvokeInst *II = dyn_cast<InvokeInst>(Def)) {
|
2012-08-08 01:30:46 +08:00
|
|
|
BasicBlock *NormalDest = II->getNormalDest();
|
|
|
|
BasicBlockEdge E(DefBB, NormalDest);
|
|
|
|
return dominates(E, U);
|
2012-04-13 07:31:46 +08:00
|
|
|
}
|
2015-08-15 10:46:08 +08:00
|
|
|
if (const auto *CPI = dyn_cast<CatchPadInst>(Def)) {
|
|
|
|
BasicBlock *NormalDest = CPI->getNormalDest();
|
|
|
|
BasicBlockEdge E(DefBB, NormalDest);
|
|
|
|
return dominates(E, U);
|
|
|
|
}
|
2012-04-13 07:31:46 +08:00
|
|
|
|
|
|
|
// If the def and use are in different blocks, do a simple CFG dominator
|
|
|
|
// tree query.
|
|
|
|
if (DefBB != UseBB)
|
|
|
|
return dominates(DefBB, UseBB);
|
|
|
|
|
|
|
|
// Ok, def and use are in the same block. If the def is an invoke, it
|
|
|
|
// doesn't dominate anything in the block. If it's a PHI, it dominates
|
|
|
|
// everything in the block.
|
|
|
|
if (isa<PHINode>(UserInst))
|
|
|
|
return true;
|
|
|
|
|
|
|
|
// Otherwise, just loop through the basic block until we find Def or User.
|
|
|
|
BasicBlock::const_iterator I = DefBB->begin();
|
|
|
|
for (; &*I != Def && &*I != UserInst; ++I)
|
|
|
|
/*empty*/;
|
|
|
|
|
|
|
|
return &*I != UserInst;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool DominatorTree::isReachableFromEntry(const Use &U) const {
|
|
|
|
Instruction *I = dyn_cast<Instruction>(U.getUser());
|
|
|
|
|
|
|
|
// ConstantExprs aren't really reachable from the entry block, but they
|
|
|
|
// don't need to be treated like unreachable code either.
|
|
|
|
if (!I) return true;
|
|
|
|
|
|
|
|
// PHI nodes use their operands on their incoming edges.
|
|
|
|
if (PHINode *PN = dyn_cast<PHINode>(I))
|
|
|
|
return isReachableFromEntry(PN->getIncomingBlock(U));
|
|
|
|
|
|
|
|
// Everything else uses their operands in their own block.
|
|
|
|
return isReachableFromEntry(I->getParent());
|
|
|
|
}
|
2014-01-13 21:07:17 +08:00
|
|
|
|
|
|
|
void DominatorTree::verifyDomTree() const {
|
|
|
|
Function &F = *getRoot()->getParent();
|
|
|
|
|
|
|
|
DominatorTree OtherDT;
|
|
|
|
OtherDT.recalculate(F);
|
|
|
|
if (compare(OtherDT)) {
|
|
|
|
errs() << "DominatorTree is not up to date!\nComputed:\n";
|
|
|
|
print(errs());
|
|
|
|
errs() << "\nActual:\n";
|
|
|
|
OtherDT.print(errs());
|
|
|
|
abort();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-01-14 18:19:28 +08:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// DominatorTreeAnalysis and related pass implementations
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This implements the DominatorTreeAnalysis which is used with the new pass
|
|
|
|
// manager. It also implements some methods from utility passes.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
DominatorTree DominatorTreeAnalysis::run(Function &F) {
|
|
|
|
DominatorTree DT;
|
|
|
|
DT.recalculate(F);
|
|
|
|
return DT;
|
|
|
|
}
|
|
|
|
|
|
|
|
char DominatorTreeAnalysis::PassID;
|
|
|
|
|
|
|
|
DominatorTreePrinterPass::DominatorTreePrinterPass(raw_ostream &OS) : OS(OS) {}
|
|
|
|
|
|
|
|
PreservedAnalyses DominatorTreePrinterPass::run(Function &F,
|
|
|
|
FunctionAnalysisManager *AM) {
|
|
|
|
OS << "DominatorTree for function: " << F.getName() << "\n";
|
|
|
|
AM->getResult<DominatorTreeAnalysis>(F).print(OS);
|
|
|
|
|
|
|
|
return PreservedAnalyses::all();
|
|
|
|
}
|
|
|
|
|
|
|
|
PreservedAnalyses DominatorTreeVerifierPass::run(Function &F,
|
|
|
|
FunctionAnalysisManager *AM) {
|
|
|
|
AM->getResult<DominatorTreeAnalysis>(F).verifyDomTree();
|
|
|
|
|
|
|
|
return PreservedAnalyses::all();
|
|
|
|
}
|
|
|
|
|
2014-01-13 21:07:17 +08:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// DominatorTreeWrapperPass Implementation
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2015-01-14 18:19:28 +08:00
|
|
|
// The implementation details of the wrapper pass that holds a DominatorTree
|
|
|
|
// suitable for use with the legacy pass manager.
|
2014-01-13 21:07:17 +08:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
char DominatorTreeWrapperPass::ID = 0;
|
|
|
|
INITIALIZE_PASS(DominatorTreeWrapperPass, "domtree",
|
|
|
|
"Dominator Tree Construction", true, true)
|
|
|
|
|
|
|
|
bool DominatorTreeWrapperPass::runOnFunction(Function &F) {
|
|
|
|
DT.recalculate(F);
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2015-05-06 16:18:41 +08:00
|
|
|
void DominatorTreeWrapperPass::verifyAnalysis() const {
|
|
|
|
if (VerifyDomInfo)
|
|
|
|
DT.verifyDomTree();
|
|
|
|
}
|
2014-01-13 21:07:17 +08:00
|
|
|
|
|
|
|
void DominatorTreeWrapperPass::print(raw_ostream &OS, const Module *) const {
|
|
|
|
DT.print(OS);
|
|
|
|
}
|
|
|
|
|