//
//===----------------------------------------------------------------------===//
-#ifndef LLVM_DOMINATORS_H
-#define LLVM_DOMINATORS_H
+#ifndef LLVM_ANALYSIS_DOMINATORS_H
+#define LLVM_ANALYSIS_DOMINATORS_H
#include "llvm/Pass.h"
#include <set>
-namespace cfg {
+class Instruction;
+
+template <typename GraphType> struct GraphTraits;
//===----------------------------------------------------------------------===//
//
inline DominatorBase(bool isPostDom) : Root(0), IsPostDominators(isPostDom) {}
public:
- inline const BasicBlock *getRoot() const { return Root; }
- inline BasicBlock *getRoot() { return Root; }
+ inline BasicBlock *getRoot() const { return Root; }
// Returns true if analysis based of postdoms
bool isPostDominator() const { return IsPostDominators; }
//===----------------------------------------------------------------------===//
//
-// DominatorSet - Maintain a set<const BasicBlock*> for every basic block in a
+// DominatorSet - Maintain a set<BasicBlock*> for every basic block in a
// function, that represents the blocks that dominate the block.
//
-class DominatorSet : public DominatorBase {
+class DominatorSetBase : public DominatorBase {
public:
- typedef std::set<const BasicBlock*> DomSetType; // Dom set for a bb
+ typedef std::set<BasicBlock*> DomSetType; // Dom set for a bb
// Map of dom sets
- typedef std::map<const BasicBlock*, DomSetType> DomSetMapType;
-private:
+ typedef std::map<BasicBlock*, DomSetType> DomSetMapType;
+protected:
DomSetMapType Doms;
-
- void calcForwardDominatorSet(Function *F);
- void calcPostDominatorSet(Function *F);
public:
- // DominatorSet ctor - Build either the dominator set or the post-dominator
- // set for a function...
- //
- static AnalysisID ID; // Build dominator set
- static AnalysisID PostDomID; // Build postdominator set
-
- DominatorSet(AnalysisID id) : DominatorBase(id == PostDomID) {}
+ DominatorSetBase(bool isPostDom) : DominatorBase(isPostDom) {}
- virtual bool runOnFunction(Function *F);
+ virtual void releaseMemory() { Doms.clear(); }
// Accessor interface:
typedef DomSetMapType::const_iterator const_iterator;
inline iterator begin() { return Doms.begin(); }
inline const_iterator end() const { return Doms.end(); }
inline iterator end() { return Doms.end(); }
- inline const_iterator find(const BasicBlock* B) const { return Doms.find(B); }
- inline iterator find( BasicBlock* B) { return Doms.find(B); }
+ inline const_iterator find(BasicBlock* B) const { return Doms.find(B); }
+ inline iterator find(BasicBlock* B) { return Doms.find(B); }
- // getDominators - Return the set of basic blocks that dominate the specified
- // block.
- //
- inline const DomSetType &getDominators(const BasicBlock *BB) const {
+
+ /// getDominators - Return the set of basic blocks that dominate the specified
+ /// block.
+ ///
+ inline const DomSetType &getDominators(BasicBlock *BB) const {
const_iterator I = find(BB);
assert(I != end() && "BB not in function!");
return I->second;
}
- // dominates - Return true if A dominates B.
- //
- inline bool dominates(const BasicBlock *A, const BasicBlock *B) const {
+ /// dominates - Return true if A dominates B.
+ ///
+ inline bool dominates(BasicBlock *A, BasicBlock *B) const {
return getDominators(B).count(A) != 0;
}
- // getAnalysisUsage - This obviously provides a dominator set, but it also
- // uses the UnifyFunctionExitNode pass if building post-dominators
+ /// properlyDominates - Return true if A dominates B and A != B.
+ ///
+ bool properlyDominates(BasicBlock *A, BasicBlock *B) const {
+ return dominates(A, B) && A != B;
+ }
+
+ /// print - Convert to human readable form
+ virtual void print(std::ostream &OS) const;
+
+ /// dominates - Return true if A dominates B. This performs the special
+ /// checks neccesary if A and B are in the same basic block.
+ ///
+ bool dominates(Instruction *A, Instruction *B) const;
+
+ //===--------------------------------------------------------------------===//
+ // API to update (Post)DominatorSet information based on modifications to
+ // the CFG...
+
+ /// addBasicBlock - Call to update the dominator set with information about a
+ /// new block that was inserted into the function.
+ void addBasicBlock(BasicBlock *BB, const DomSetType &Dominators) {
+ assert(find(BB) == end() && "Block already in DominatorSet!");
+ Doms.insert(std::make_pair(BB, Dominators));
+ }
+
+ // addDominator - If a new block is inserted into the CFG, then method may be
+ // called to notify the blocks it dominates that it is in their set.
//
- virtual void getAnalysisUsage(AnalysisUsage &AU) const;
+ void addDominator(BasicBlock *BB, BasicBlock *NewDominator) {
+ iterator I = find(BB);
+ assert(I != end() && "BB is not in DominatorSet!");
+ I->second.insert(NewDominator);
+ }
+};
+
+
+//===-------------------------------------
+// DominatorSet Class - Concrete subclass of DominatorSetBase that is used to
+// compute a normal dominator set.
+//
+struct DominatorSet : public DominatorSetBase {
+ DominatorSet() : DominatorSetBase(false) {}
+
+ virtual bool runOnFunction(Function &F);
+
+ /// recalculate - This method may be called by external passes that modify the
+ /// CFG and then need dominator information recalculated. This method is
+ /// obviously really slow, so it should be avoided if at all possible.
+ void recalculate();
+
+ // getAnalysisUsage - This simply provides a dominator set
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.setPreservesAll();
+ }
+private:
+ void calculateDominatorsFromBlock(BasicBlock *BB);
};
// ImmediateDominators - Calculate the immediate dominator for each node in a
// function.
//
-class ImmediateDominators : public DominatorBase {
- std::map<const BasicBlock*, const BasicBlock*> IDoms;
- void calcIDoms(const DominatorSet &DS);
+class ImmediateDominatorsBase : public DominatorBase {
+protected:
+ std::map<BasicBlock*, BasicBlock*> IDoms;
+ void calcIDoms(const DominatorSetBase &DS);
public:
+ ImmediateDominatorsBase(bool isPostDom) : DominatorBase(isPostDom) {}
- // ImmediateDominators ctor - Calculate the idom or post-idom mapping,
- // for a function...
- //
- static AnalysisID ID; // Build immediate dominators
- static AnalysisID PostDomID; // Build immediate postdominators
-
- ImmediateDominators(AnalysisID id) : DominatorBase(id == PostDomID) {}
-
- virtual bool runOnFunction(Function *F) {
- IDoms.clear(); // Reset from the last time we were run...
- DominatorSet *DS;
- if (isPostDominator())
- DS = &getAnalysis<DominatorSet>(DominatorSet::PostDomID);
- else
- DS = &getAnalysis<DominatorSet>();
-
- Root = DS->getRoot();
- calcIDoms(*DS); // Can be used to make rev-idoms
- return false;
- }
+ virtual void releaseMemory() { IDoms.clear(); }
// Accessor interface:
- typedef std::map<const BasicBlock*, const BasicBlock*> IDomMapType;
+ typedef std::map<BasicBlock*, BasicBlock*> IDomMapType;
typedef IDomMapType::const_iterator const_iterator;
inline const_iterator begin() const { return IDoms.begin(); }
inline const_iterator end() const { return IDoms.end(); }
- inline const_iterator find(const BasicBlock* B) const { return IDoms.find(B);}
+ inline const_iterator find(BasicBlock* B) const { return IDoms.find(B);}
// operator[] - Return the idom for the specified basic block. The start
// node returns null, because it does not have an immediate dominator.
//
- inline const BasicBlock *operator[](const BasicBlock *BB) const {
- std::map<const BasicBlock*, const BasicBlock*>::const_iterator I =
- IDoms.find(BB);
+ inline BasicBlock *operator[](BasicBlock *BB) const {
+ return get(BB);
+ }
+
+ // get() - Synonym for operator[].
+ inline BasicBlock *get(BasicBlock *BB) const {
+ std::map<BasicBlock*, BasicBlock*>::const_iterator I = IDoms.find(BB);
return I != IDoms.end() ? I->second : 0;
}
- // getAnalysisUsage - This obviously provides a dominator tree, but it
- // can only do so with the input of dominator sets
- //
+ //===--------------------------------------------------------------------===//
+ // API to update Immediate(Post)Dominators information based on modifications
+ // to the CFG...
+
+ /// addNewBlock - Add a new block to the CFG, with the specified immediate
+ /// dominator.
+ ///
+ void addNewBlock(BasicBlock *BB, BasicBlock *IDom) {
+ assert(get(BB) == 0 && "BasicBlock already in idom info!");
+ IDoms[BB] = IDom;
+ }
+
+ /// setImmediateDominator - Update the immediate dominator information to
+ /// change the current immediate dominator for the specified block to another
+ /// block. This method requires that BB already have an IDom, otherwise just
+ /// use addNewBlock.
+ void setImmediateDominator(BasicBlock *BB, BasicBlock *NewIDom) {
+ assert(IDoms.find(BB) != IDoms.end() && "BB doesn't have idom yet!");
+ IDoms[BB] = NewIDom;
+ }
+
+ // print - Convert to human readable form
+ virtual void print(std::ostream &OS) const;
+};
+
+//===-------------------------------------
+// ImmediateDominators Class - Concrete subclass of ImmediateDominatorsBase that
+// is used to compute a normal immediate dominator set.
+//
+struct ImmediateDominators : public ImmediateDominatorsBase {
+ ImmediateDominators() : ImmediateDominatorsBase(false) {}
+
+ virtual bool runOnFunction(Function &F) {
+ IDoms.clear(); // Reset from the last time we were run...
+ DominatorSet &DS = getAnalysis<DominatorSet>();
+ Root = DS.getRoot();
+ calcIDoms(DS);
+ return false;
+ }
+
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
- if (isPostDominator()) {
- AU.addRequired(DominatorSet::PostDomID);
- AU.addProvided(PostDomID);
- } else {
- AU.addRequired(DominatorSet::ID);
- AU.addProvided(ID);
- }
+ AU.addRequired<DominatorSet>();
}
};
//
// DominatorTree - Calculate the immediate dominator tree for a function.
//
-class DominatorTree : public DominatorBase {
+class DominatorTreeBase : public DominatorBase {
+protected:
class Node2;
public:
typedef Node2 Node;
-private:
- std::map<const BasicBlock*, Node*> Nodes;
- void calculate(const DominatorSet &DS);
+protected:
+ std::map<BasicBlock*, Node*> Nodes;
void reset();
- typedef std::map<const BasicBlock*, Node*> NodeMapType;
+ typedef std::map<BasicBlock*, Node*> NodeMapType;
public:
- class Node2 : public std::vector<Node*> {
+ class Node2 {
friend class DominatorTree;
- const BasicBlock *TheNode;
- Node2 * const IDom;
+ friend class PostDominatorTree;
+ friend class DominatorTreeBase;
+ BasicBlock *TheNode;
+ Node2 *IDom;
+ std::vector<Node*> Children;
public:
- inline const BasicBlock *getNode() const { return TheNode; }
+ typedef std::vector<Node*>::iterator iterator;
+ typedef std::vector<Node*>::const_iterator const_iterator;
+
+ iterator begin() { return Children.begin(); }
+ iterator end() { return Children.end(); }
+ const_iterator begin() const { return Children.begin(); }
+ const_iterator end() const { return Children.end(); }
+
+ inline BasicBlock *getNode() const { return TheNode; }
inline Node2 *getIDom() const { return IDom; }
- inline const std::vector<Node*> &getChildren() const { return *this; }
+ inline const std::vector<Node*> &getChildren() const { return Children; }
// dominates - Returns true iff this dominates N. Note that this is not a
// constant time operation!
}
private:
- inline Node2(const BasicBlock *node, Node *iDom)
+ inline Node2(BasicBlock *node, Node *iDom)
: TheNode(node), IDom(iDom) {}
- inline Node2 *addChild(Node *C) { push_back(C); return C; }
+ inline Node2 *addChild(Node *C) { Children.push_back(C); return C; }
+
+ void setIDom(Node2 *NewIDom);
};
public:
- // DominatorTree ctor - Compute a dominator tree, given various amounts of
- // previous knowledge...
- static AnalysisID ID; // Build dominator tree
- static AnalysisID PostDomID; // Build postdominator tree
-
- DominatorTree(AnalysisID id) : DominatorBase(id == PostDomID) {}
- ~DominatorTree() { reset(); }
-
- virtual bool runOnFunction(Function *F) {
- reset();
- DominatorSet *DS;
- if (isPostDominator())
- DS = &getAnalysis<DominatorSet>(DominatorSet::PostDomID);
- else
- DS = &getAnalysis<DominatorSet>();
- Root = DS->getRoot();
- calculate(*DS); // Can be used to make rev-idoms
- return false;
- }
+ DominatorTreeBase(bool isPostDom) : DominatorBase(isPostDom) {}
+ ~DominatorTreeBase() { reset(); }
+
+ virtual void releaseMemory() { reset(); }
- inline const Node *operator[](const BasicBlock *BB) const {
+ /// getNode - return the (Post)DominatorTree node for the specified basic
+ /// block. This is the same as using operator[] on this class.
+ ///
+ inline Node *getNode(BasicBlock *BB) const {
NodeMapType::const_iterator i = Nodes.find(BB);
return (i != Nodes.end()) ? i->second : 0;
}
- // getAnalysisUsage - This obviously provides a dominator tree, but it
- // uses dominator sets
- //
+ inline Node *operator[](BasicBlock *BB) const {
+ return getNode(BB);
+ }
+
+ //===--------------------------------------------------------------------===// // API to update (Post)DominatorTree information based on modifications to
+ // the CFG...
+
+ /// createNewNode - Add a new node to the dominator tree information. This
+ /// creates a new node as a child of IDomNode, linking it into the children
+ /// list of the immediate dominator.
+ ///
+ Node *createNewNode(BasicBlock *BB, Node *IDomNode) {
+ assert(getNode(BB) == 0 && "Block already in dominator tree!");
+ assert(IDomNode && "Not immediate dominator specified for block!");
+ return Nodes[BB] = IDomNode->addChild(new Node(BB, IDomNode));
+ }
+
+ /// changeImmediateDominator - This method is used to update the dominator
+ /// tree information when a node's immediate dominator changes.
+ ///
+ void changeImmediateDominator(Node *Node, Node *NewIDom) {
+ assert(Node && NewIDom && "Cannot change null node pointers!");
+ Node->setIDom(NewIDom);
+ }
+
+ /// print - Convert to human readable form
+ virtual void print(std::ostream &OS) const;
+};
+
+
+//===-------------------------------------
+// DominatorTree Class - Concrete subclass of DominatorTreeBase that is used to
+// compute a normal dominator tree.
+//
+struct DominatorTree : public DominatorTreeBase {
+ DominatorTree() : DominatorTreeBase(false) {}
+
+ virtual bool runOnFunction(Function &F) {
+ reset(); // Reset from the last time we were run...
+ DominatorSet &DS = getAnalysis<DominatorSet>();
+ Root = DS.getRoot();
+ calculate(DS);
+ return false;
+ }
+
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
- if (isPostDominator()) {
- AU.addRequired(DominatorSet::PostDomID);
- AU.addProvided(PostDomID);
- } else {
- AU.addRequired(DominatorSet::ID);
- AU.addProvided(ID);
- }
+ AU.addRequired<DominatorSet>();
}
+private:
+ void calculate(const DominatorSet &DS);
};
+//===-------------------------------------
+// DominatorTree GraphTraits specialization so the DominatorTree can be
+// iterable by generic graph iterators.
+
+template <> struct GraphTraits<DominatorTree::Node*> {
+ typedef DominatorTree::Node NodeType;
+ typedef NodeType::iterator ChildIteratorType;
+
+ static NodeType *getEntryNode(NodeType *N) {
+ return N;
+ }
+ static inline ChildIteratorType child_begin(NodeType* N) {
+ return N->begin();
+ }
+ static inline ChildIteratorType child_end(NodeType* N) {
+ return N->end();
+ }
+};
+
+template <> struct GraphTraits<DominatorTree*>
+ : public GraphTraits<DominatorTree::Node*> {
+ static NodeType *getEntryNode(DominatorTree *DT) {
+ return DT->getNode(DT->getRoot());
+ }
+};
//===----------------------------------------------------------------------===//
//
// DominanceFrontier - Calculate the dominance frontiers for a function.
//
-class DominanceFrontier : public DominatorBase {
+class DominanceFrontierBase : public DominatorBase {
public:
- typedef std::set<const BasicBlock*> DomSetType; // Dom set for a bb
- typedef std::map<const BasicBlock*, DomSetType> DomSetMapType; // Dom set map
-private:
+ typedef std::set<BasicBlock*> DomSetType; // Dom set for a bb
+ typedef std::map<BasicBlock*, DomSetType> DomSetMapType; // Dom set map
+protected:
DomSetMapType Frontiers;
- const DomSetType &calcDomFrontier(const DominatorTree &DT,
- const DominatorTree::Node *Node);
- const DomSetType &calcPostDomFrontier(const DominatorTree &DT,
- const DominatorTree::Node *Node);
public:
+ DominanceFrontierBase(bool isPostDom) : DominatorBase(isPostDom) {}
- // DominatorFrontier ctor - Compute dominator frontiers for a function
- //
- static AnalysisID ID; // Build dominator frontier
- static AnalysisID PostDomID; // Build postdominator frontier
+ virtual void releaseMemory() { Frontiers.clear(); }
- DominanceFrontier(AnalysisID id) : DominatorBase(id == PostDomID) {}
+ // Accessor interface:
+ typedef DomSetMapType::iterator iterator;
+ typedef DomSetMapType::const_iterator const_iterator;
+ iterator begin() { return Frontiers.begin(); }
+ const_iterator begin() const { return Frontiers.begin(); }
+ iterator end() { return Frontiers.end(); }
+ const_iterator end() const { return Frontiers.end(); }
+ iterator find(BasicBlock *B) { return Frontiers.find(B); }
+ const_iterator find(BasicBlock *B) const { return Frontiers.find(B); }
+
+ void addBasicBlock(BasicBlock *BB, const DomSetType &frontier) {
+ assert(find(BB) == end() && "Block already in DominanceFrontier!");
+ Frontiers.insert(std::make_pair(BB, frontier));
+ }
- virtual bool runOnFunction(Function *) {
+ void addToFrontier(iterator I, BasicBlock *Node) {
+ assert(I != end() && "BB is not in DominanceFrontier!");
+ I->second.insert(Node);
+ }
+
+ void removeFromFrontier(iterator I, BasicBlock *Node) {
+ assert(I != end() && "BB is not in DominanceFrontier!");
+ assert(I->second.count(Node) && "Node is not in DominanceFrontier of BB");
+ I->second.erase(Node);
+ }
+
+ // print - Convert to human readable form
+ virtual void print(std::ostream &OS) const;
+};
+
+
+//===-------------------------------------
+// DominatorTree Class - Concrete subclass of DominatorTreeBase that is used to
+// compute a normal dominator tree.
+//
+struct DominanceFrontier : public DominanceFrontierBase {
+ DominanceFrontier() : DominanceFrontierBase(false) {}
+
+ virtual bool runOnFunction(Function &) {
Frontiers.clear();
- DominatorTree *DT;
- if (isPostDominator())
- DT = &getAnalysis<DominatorTree>(DominatorTree::PostDomID);
- else
- DT = &getAnalysis<DominatorTree>();
- Root = DT->getRoot();
-
- if (isPostDominator())
- calcPostDomFrontier(*DT, (*DT)[Root]);
- else
- calcDomFrontier(*DT, (*DT)[Root]);
+ DominatorTree &DT = getAnalysis<DominatorTree>();
+ Root = DT.getRoot();
+ calculate(DT, DT[Root]);
return false;
}
- // Accessor interface:
- typedef DomSetMapType::const_iterator const_iterator;
- inline const_iterator begin() const { return Frontiers.begin(); }
- inline const_iterator end() const { return Frontiers.end(); }
- inline const_iterator find(const BasicBlock* B) const { return Frontiers.find(B); }
-
- // getAnalysisUsage - This obviously provides the dominance frontier, but it
- // uses dominator sets
- //
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
- if (isPostDominator()) {
- AU.addRequired(DominatorTree::PostDomID);
- AU.addProvided(PostDomID);
- } else {
- AU.addRequired(DominatorTree::ID);
- AU.addProvided(ID);
- }
+ AU.addRequired<DominatorTree>();
}
+private:
+ const DomSetType &calculate(const DominatorTree &DT,
+ const DominatorTree::Node *Node);
};
-} // End namespace cfg
-
#endif
projects / oota-llvm.git / blobdiff