1 //=- llvm/Analysis/PostDominators.h - Post Dominator Calculation-*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file exposes interfaces to post dominance information.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_ANALYSIS_POST_DOMINATORS_H
15 #define LLVM_ANALYSIS_POST_DOMINATORS_H
17 #include "llvm/Analysis/Dominators.h"
21 /// PostDominatorTree Class - Concrete subclass of DominatorTree that is used to
22 /// compute the a post-dominator tree.
24 struct PostDominatorTree : public FunctionPass {
25 static char ID; // Pass identification, replacement for typeid
26 DominatorTreeBase<BasicBlock>* DT;
28 PostDominatorTree() : FunctionPass(&ID) {
29 DT = new DominatorTreeBase<BasicBlock>(true);
34 virtual bool runOnFunction(Function &F);
36 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
40 inline const std::vector<BasicBlock*> &getRoots() const {
41 return DT->getRoots();
44 inline DomTreeNode *getRootNode() const {
45 return DT->getRootNode();
48 inline DomTreeNode *operator[](BasicBlock *BB) const {
49 return DT->getNode(BB);
52 inline DomTreeNode *getNode(BasicBlock *BB) const {
53 return DT->getNode(BB);
56 inline bool dominates(DomTreeNode* A, DomTreeNode* B) const {
57 return DT->dominates(A, B);
60 inline bool dominates(const BasicBlock* A, const BasicBlock* B) const {
61 return DT->dominates(A, B);
64 inline bool properlyDominates(const DomTreeNode* A, DomTreeNode* B) const {
65 return DT->properlyDominates(A, B);
68 inline bool properlyDominates(BasicBlock* A, BasicBlock* B) const {
69 return DT->properlyDominates(A, B);
72 inline BasicBlock *findNearestCommonDominator(BasicBlock *A, BasicBlock *B) {
73 return DT->findNearestCommonDominator(A, B);
76 virtual void releaseMemory() {
80 virtual void print(raw_ostream &OS, const Module*) const;
83 FunctionPass* createPostDomTree();
85 template <> struct GraphTraits<PostDominatorTree*>
86 : public GraphTraits<DomTreeNode*> {
87 static NodeType *getEntryNode(PostDominatorTree *DT) {
88 return DT->getRootNode();
91 static nodes_iterator nodes_begin(PostDominatorTree *N) {
93 return df_begin(getEntryNode(N));
95 return df_end(getEntryNode(N));
98 static nodes_iterator nodes_end(PostDominatorTree *N) {
99 return df_end(getEntryNode(N));
103 /// PostDominanceFrontier Class - Concrete subclass of DominanceFrontier that is
104 /// used to compute the a post-dominance frontier.
106 struct PostDominanceFrontier : public DominanceFrontierBase {
108 PostDominanceFrontier()
109 : DominanceFrontierBase(&ID, true) {}
111 virtual bool runOnFunction(Function &) {
113 PostDominatorTree &DT = getAnalysis<PostDominatorTree>();
114 Roots = DT.getRoots();
115 if (const DomTreeNode *Root = DT.getRootNode())
120 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
121 AU.setPreservesAll();
122 AU.addRequired<PostDominatorTree>();
126 const DomSetType &calculate(const PostDominatorTree &DT,
127 const DomTreeNode *Node);
130 FunctionPass* createPostDomFrontier();
132 } // End llvm namespace