Finish LLVMContext-ing lib/Analysis. This required pushing LLVMContext's through...
[oota-llvm.git] / include / llvm / Analysis / DominatorInternals.h
index 5d5714a5c78da87a7b1b121aa6ef1e20ad2a6605..cca0d502b69c393a036b81e35e14cca5154f41b3 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by Owen Anderson and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
@@ -11,8 +11,8 @@
 #define LLVM_ANALYSIS_DOMINATOR_INTERNALS_H
 
 #include "llvm/Analysis/Dominators.h"
-#include "llvm/ADT/DenseMap.h"
 #include "llvm/ADT/SmallPtrSet.h"
+
 //===----------------------------------------------------------------------===//
 //
 // DominatorTree construction - This pass constructs immediate dominator
 namespace llvm {
 
 template<class GraphT>
-unsigned DFSPass(DominatorTreeBase& DT, typename GraphT::NodeType* V,
-                 unsigned N) {
+unsigned DFSPass(DominatorTreeBase<typename GraphT::NodeType>& DT,
+                 typename GraphT::NodeType* V, unsigned N) {
   // This is more understandable as a recursive algorithm, but we can't use the
   // recursive algorithm due to stack depth issues.  Keep it here for
   // documentation purposes.
 #if 0
   InfoRec &VInfo = DT.Info[DT.Roots[i]];
-  VInfo.Semi = ++N;
+  VInfo.DFSNum = VInfo.Semi = ++N;
   VInfo.Label = V;
 
   Vertex.push_back(V);        // Vertex[n] = V;
@@ -58,6 +58,8 @@ unsigned DFSPass(DominatorTreeBase& DT, typename GraphT::NodeType* V,
     }
   }
 #else
+  bool IsChilOfArtificialExit = (N != 0);
+
   std::vector<std::pair<typename GraphT::NodeType*,
                         typename GraphT::ChildIteratorType> > Worklist;
   Worklist.push_back(std::make_pair(V, GraphT::child_begin(V)));
@@ -65,18 +67,29 @@ unsigned DFSPass(DominatorTreeBase& DT, typename GraphT::NodeType* V,
     typename GraphT::NodeType* BB = Worklist.back().first;
     typename GraphT::ChildIteratorType NextSucc = Worklist.back().second;
 
+    typename DominatorTreeBase<typename GraphT::NodeType>::InfoRec &BBInfo =
+                                                                    DT.Info[BB];
+
     // First time we visited this BB?
     if (NextSucc == GraphT::child_begin(BB)) {
-      DominatorTree::InfoRec &BBInfo = DT.Info[BB];
-      BBInfo.Semi = ++N;
+      BBInfo.DFSNum = BBInfo.Semi = ++N;
       BBInfo.Label = BB;
 
       DT.Vertex.push_back(BB);       // Vertex[n] = V;
       //BBInfo[V].Ancestor = 0;   // Ancestor[n] = 0
       //BBInfo[V].Child = 0;      // Child[v] = 0
       BBInfo.Size = 1;            // Size[v] = 1
+
+      if (IsChilOfArtificialExit)
+        BBInfo.Parent = 1;
+
+      IsChilOfArtificialExit = false;
     }
-    
+
+    // store the DFS number of the current BB - the reference to BBInfo might
+    // get invalidated when processing the successors.
+    unsigned BBDFSNum = BBInfo.DFSNum;
+
     // If we are done with this block, remove it from the worklist.
     if (NextSucc == GraphT::child_end(BB)) {
       Worklist.pop_back();
@@ -89,9 +102,10 @@ unsigned DFSPass(DominatorTreeBase& DT, typename GraphT::NodeType* V,
     // Visit the successor next, if it isn't already visited.
     typename GraphT::NodeType* Succ = *NextSucc;
 
-    DominatorTree::InfoRec &SuccVInfo = DT.Info[Succ];
+    typename DominatorTreeBase<typename GraphT::NodeType>::InfoRec &SuccVInfo =
+                                                                  DT.Info[Succ];
     if (SuccVInfo.Semi == 0) {
-      SuccVInfo.Parent = BB;
+      SuccVInfo.Parent = BBDFSNum;
       Worklist.push_back(std::make_pair(Succ, GraphT::child_begin(Succ)));
     }
   }
@@ -100,20 +114,23 @@ unsigned DFSPass(DominatorTreeBase& DT, typename GraphT::NodeType* V,
 }
 
 template<class GraphT>
-void Compress(DominatorTreeBase& DT, typename GraphT::NodeType *VIn) {
+void Compress(DominatorTreeBase<typename GraphT::NodeType>& DT,
+              typename GraphT::NodeType *VIn) {
   std::vector<typename GraphT::NodeType*> Work;
   SmallPtrSet<typename GraphT::NodeType*, 32> Visited;
-  typename GraphT::NodeType* VInAncestor = DT.Info[VIn].Ancestor;
-  DominatorTreeBase::InfoRec &VInVAInfo = DT.Info[VInAncestor];
+  typename DominatorTreeBase<typename GraphT::NodeType>::InfoRec &VInVAInfo =
+                                      DT.Info[DT.Vertex[DT.Info[VIn].Ancestor]];
 
   if (VInVAInfo.Ancestor != 0)
     Work.push_back(VIn);
   
   while (!Work.empty()) {
     typename GraphT::NodeType* V = Work.back();
-    DominatorTree::InfoRec &VInfo = DT.Info[V];
-    typename GraphT::NodeType* VAncestor = VInfo.Ancestor;
-    DominatorTreeBase::InfoRec &VAInfo = DT.Info[VAncestor];
+    typename DominatorTreeBase<typename GraphT::NodeType>::InfoRec &VInfo =
+                                                                     DT.Info[V];
+    typename GraphT::NodeType* VAncestor = DT.Vertex[VInfo.Ancestor];
+    typename DominatorTreeBase<typename GraphT::NodeType>::InfoRec &VAInfo =
+                                                             DT.Info[VAncestor];
 
     // Process Ancestor first
     if (Visited.insert(VAncestor) &&
@@ -135,9 +152,10 @@ void Compress(DominatorTreeBase& DT, typename GraphT::NodeType *VIn) {
 }
 
 template<class GraphT>
-typename GraphT::NodeType* Eval(DominatorTreeBase& DT,
+typename GraphT::NodeType* Eval(DominatorTreeBase<typename GraphT::NodeType>& DT,
                                 typename GraphT::NodeType *V) {
-  DominatorTreeBase::InfoRec &VInfo = DT.Info[V];
+  typename DominatorTreeBase<typename GraphT::NodeType>::InfoRec &VInfo =
+                                                                     DT.Info[V];
 #if !BALANCE_IDOM_TREE
   // Higher-complexity but faster implementation
   if (VInfo.Ancestor == 0)
@@ -160,11 +178,12 @@ typename GraphT::NodeType* Eval(DominatorTreeBase& DT,
 }
 
 template<class GraphT>
-void Link(DominatorTreeBase& DT, typename GraphT::NodeType* V,
-          typename GraphT::NodeType* W, DominatorTreeBase::InfoRec &WInfo) {
+void Link(DominatorTreeBase<typename GraphT::NodeType>& DT,
+          unsigned DFSNumV, typename GraphT::NodeType* W,
+        typename DominatorTreeBase<typename GraphT::NodeType>::InfoRec &WInfo) {
 #if !BALANCE_IDOM_TREE
   // Higher-complexity but faster implementation
-  WInfo.Ancestor = V;
+  WInfo.Ancestor = DFSNumV;
 #else
   // Lower-complexity but slower implementation
   GraphT::NodeType* WLabel = WInfo.Label;
@@ -208,82 +227,126 @@ void Link(DominatorTreeBase& DT, typename GraphT::NodeType* V,
 #endif
 }
 
-template<class NodeT>
-void Calculate(DominatorTreeBase& DT, Function& F) {
+template<class FuncT, class NodeT>
+void Calculate(DominatorTreeBase<typename GraphTraits<NodeT>::NodeType>& DT,
+               FuncT& F) {
+  typedef GraphTraits<NodeT> GraphT;
+
+  unsigned N = 0;
+  bool MultipleRoots = (DT.Roots.size() > 1);
+  if (MultipleRoots) {
+    typename DominatorTreeBase<typename GraphT::NodeType>::InfoRec &BBInfo =
+        DT.Info[NULL];
+    BBInfo.DFSNum = BBInfo.Semi = ++N;
+    BBInfo.Label = NULL;
+
+    DT.Vertex.push_back(NULL);       // Vertex[n] = V;
+      //BBInfo[V].Ancestor = 0;   // Ancestor[n] = 0
+      //BBInfo[V].Child = 0;      // Child[v] = 0
+    BBInfo.Size = 1;            // Size[v] = 1
+  }
+
   // Step #1: Number blocks in depth-first order and initialize variables used
   // in later stages of the algorithm.
-  unsigned N = 0;
-  for (unsigned i = 0, e = DT.Roots.size(); i != e; ++i)
-    N = DFSPass<GraphTraits<NodeT> >(DT, DT.Roots[i], N);
+  for (unsigned i = 0, e = static_cast<unsigned>(DT.Roots.size());
+       i != e; ++i)
+    N = DFSPass<GraphT>(DT, DT.Roots[i], N);
+
+  // it might be that some blocks did not get a DFS number (e.g., blocks of 
+  // infinite loops). In these cases an artificial exit node is required.
+  MultipleRoots |= (DT.isPostDominator() && N != F.size());
 
   for (unsigned i = N; i >= 2; --i) {
-    typename GraphTraits<NodeT>::NodeType* W = DT.Vertex[i];
-    DominatorTree::InfoRec &WInfo = DT.Info[W];
+    typename GraphT::NodeType* W = DT.Vertex[i];
+    typename DominatorTreeBase<typename GraphT::NodeType>::InfoRec &WInfo =
+                                                                     DT.Info[W];
 
     // Step #2: Calculate the semidominators of all vertices
+    bool HasChildOutsideDFS = false;
+
+    // initialize the semi dominator to point to the parent node
+    WInfo.Semi = WInfo.Parent;
     for (typename GraphTraits<Inverse<NodeT> >::ChildIteratorType CI =
          GraphTraits<Inverse<NodeT> >::child_begin(W),
-         E = GraphTraits<Inverse<NodeT> >::child_end(W); CI != E; ++CI)
+         E = GraphTraits<Inverse<NodeT> >::child_end(W); CI != E; ++CI) {
       if (DT.Info.count(*CI)) {  // Only if this predecessor is reachable!
-        unsigned SemiU = DT.Info[Eval<GraphTraits<NodeT> >(DT, *CI)].Semi;
+        unsigned SemiU = DT.Info[Eval<GraphT>(DT, *CI)].Semi;
         if (SemiU < WInfo.Semi)
           WInfo.Semi = SemiU;
       }
+      else {
+        // if the child has no DFS number it is not post-dominated by any exit, 
+        // and so is the current block.
+        HasChildOutsideDFS = true;
+      }
+    }
+
+    // if some child has no DFS number it is not post-dominated by any exit, 
+    // and so is the current block.
+    if (DT.isPostDominator() && HasChildOutsideDFS)
+      WInfo.Semi = 0;
 
     DT.Info[DT.Vertex[WInfo.Semi]].Bucket.push_back(W);
 
-    typename GraphTraits<NodeT>::NodeType* WParent = WInfo.Parent;
-    Link<GraphTraits<NodeT> >(DT, WParent, W, WInfo);
+    typename GraphT::NodeType* WParent = DT.Vertex[WInfo.Parent];
+    Link<GraphT>(DT, WInfo.Parent, W, WInfo);
 
     // Step #3: Implicitly define the immediate dominator of vertices
-    std::vector<typename GraphTraits<NodeT>::NodeType*> &WParentBucket =
+    std::vector<typename GraphT::NodeType*> &WParentBucket =
                                                         DT.Info[WParent].Bucket;
     while (!WParentBucket.empty()) {
-      typename GraphTraits<NodeT>::NodeType* V = WParentBucket.back();
+      typename GraphT::NodeType* V = WParentBucket.back();
       WParentBucket.pop_back();
-      typename GraphTraits<NodeT>::NodeType* U =
-                                               Eval<GraphTraits<NodeT> >(DT, V);
+      typename GraphT::NodeType* U = Eval<GraphT>(DT, V);
       DT.IDoms[V] = DT.Info[U].Semi < DT.Info[V].Semi ? U : WParent;
     }
   }
 
   // Step #4: Explicitly define the immediate dominator of each vertex
   for (unsigned i = 2; i <= N; ++i) {
-    typename GraphTraits<NodeT>::NodeType* W = DT.Vertex[i];
-    typename GraphTraits<NodeT>::NodeType*& WIDom = DT.IDoms[W];
+    typename GraphT::NodeType* W = DT.Vertex[i];
+    typename GraphT::NodeType*& WIDom = DT.IDoms[W];
     if (WIDom != DT.Vertex[DT.Info[W].Semi])
       WIDom = DT.IDoms[WIDom];
   }
-  
+
   if (DT.Roots.empty()) return;
-  
+
   // Add a node for the root.  This node might be the actual root, if there is
   // one exit block, or it may be the virtual exit (denoted by (BasicBlock *)0)
-  // which postdominates all real exits if there are multiple exit blocks.
-  typename GraphTraits<NodeT>::NodeType* Root = DT.Roots.size() == 1 ? DT.Roots[0]
-                                                                     : 0;
-  DT.DomTreeNodes[Root] = DT.RootNode = new DomTreeNode(Root, 0);
-  
+  // which postdominates all real exits if there are multiple exit blocks, or
+  // an infinite loop.
+  typename GraphT::NodeType* Root = !MultipleRoots ? DT.Roots[0] : 0;
+
+  DT.DomTreeNodes[Root] = DT.RootNode =
+                        new DomTreeNodeBase<typename GraphT::NodeType>(Root, 0);
+
   // Loop over all of the reachable blocks in the function...
-  for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
-    if (typename GraphTraits<NodeT>::NodeType* ImmDom = DT.getIDom(I)) {
-      // Reachable block.
-      DomTreeNode *BBNode = DT.DomTreeNodes[I];
-      if (BBNode) continue;  // Haven't calculated this node yet?
-
-      // Get or calculate the node for the immediate dominator
-      DomTreeNode *IDomNode = DT.getNodeForBlock(ImmDom);
-
-      // Add a new tree node for this BasicBlock, and link it as a child of
-      // IDomNode
-      DomTreeNode *C = new DomTreeNode(I, IDomNode);
-      DT.DomTreeNodes[I] = IDomNode->addChild(C);
-    }
-  
+  for (unsigned i = 2; i <= N; ++i) {
+    typename GraphT::NodeType* W = DT.Vertex[i];
+
+    DomTreeNodeBase<typename GraphT::NodeType> *BBNode = DT.DomTreeNodes[W];
+    if (BBNode) continue;  // Haven't calculated this node yet?
+
+    typename GraphT::NodeType* ImmDom = DT.getIDom(W);
+
+    assert(ImmDom || DT.DomTreeNodes[NULL]);
+
+    // Get or calculate the node for the immediate dominator
+    DomTreeNodeBase<typename GraphT::NodeType> *IDomNode =
+                                                     DT.getNodeForBlock(ImmDom);
+
+    // Add a new tree node for this BasicBlock, and link it as a child of
+    // IDomNode
+    DomTreeNodeBase<typename GraphT::NodeType> *C =
+                    new DomTreeNodeBase<typename GraphT::NodeType>(W, IDomNode);
+    DT.DomTreeNodes[W] = IDomNode->addChild(C);
+  }
+
   // Free temporary memory used to construct idom's
   DT.IDoms.clear();
   DT.Info.clear();
-  std::vector<typename GraphTraits<NodeT>::NodeType*>().swap(DT.Vertex);
+  std::vector<typename GraphT::NodeType*>().swap(DT.Vertex);
   
   // FIXME: This does not work on PostDomTrees.  It seems likely that this is
   // due to an error in the algorithm for post-dominators.  This really should