1 //===- Dominators.cpp - Dominator Calculation -----------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements simple dominator construction algorithms for finding
11 // forward dominators. Postdominators are available in libanalysis, but are not
12 // included in libvmcore, because it's not needed. Forward dominators are
13 // needed to support the Verifier pass.
15 //===----------------------------------------------------------------------===//
17 #include "llvm/Analysis/Dominators.h"
18 #include "llvm/Support/CFG.h"
19 #include "llvm/Assembly/Writer.h"
20 #include "llvm/ADT/DepthFirstIterator.h"
21 #include "llvm/ADT/SetOperations.h"
22 #include "llvm/ADT/SmallPtrSet.h"
23 #include "llvm/Instructions.h"
24 #include "llvm/Support/Streams.h"
29 static std::ostream &operator<<(std::ostream &o,
30 const std::set<BasicBlock*> &BBs) {
31 for (std::set<BasicBlock*>::const_iterator I = BBs.begin(), E = BBs.end();
34 WriteAsOperand(o, *I, false);
36 o << " <<exit node>>";
41 //===----------------------------------------------------------------------===//
42 // DominatorTree Implementation
43 //===----------------------------------------------------------------------===//
45 // DominatorTree construction - This pass constructs immediate dominator
46 // information for a flow-graph based on the algorithm described in this
49 // A Fast Algorithm for Finding Dominators in a Flowgraph
50 // T. Lengauer & R. Tarjan, ACM TOPLAS July 1979, pgs 121-141.
52 // This implements both the O(n*ack(n)) and the O(n*log(n)) versions of EVAL and
53 // LINK, but it turns out that the theoretically slower O(n*log(n))
54 // implementation is actually faster than the "efficient" algorithm (even for
55 // large CFGs) because the constant overheads are substantially smaller. The
56 // lower-complexity version can be enabled with the following #define:
58 #define BALANCE_IDOM_TREE 0
60 //===----------------------------------------------------------------------===//
62 char DominatorTree::ID = 0;
63 static RegisterPass<DominatorTree>
64 E("domtree", "Dominator Tree Construction", true);
66 // NewBB is split and now it has one successor. Update dominator tree to
67 // reflect this change.
68 void DominatorTree::splitBlock(BasicBlock *NewBB) {
70 assert(NewBB->getTerminator()->getNumSuccessors() == 1
71 && "NewBB should have a single successor!");
72 BasicBlock *NewBBSucc = NewBB->getTerminator()->getSuccessor(0);
74 std::vector<BasicBlock*> PredBlocks;
75 for (pred_iterator PI = pred_begin(NewBB), PE = pred_end(NewBB);
77 PredBlocks.push_back(*PI);
79 assert(!PredBlocks.empty() && "No predblocks??");
81 // The newly inserted basic block will dominate existing basic blocks iff the
82 // PredBlocks dominate all of the non-pred blocks. If all predblocks dominate
83 // the non-pred blocks, then they all must be the same block!
85 bool NewBBDominatesNewBBSucc = true;
87 BasicBlock *OnePred = PredBlocks[0];
88 unsigned i = 1, e = PredBlocks.size();
89 for (i = 1; !isReachableFromEntry(OnePred); ++i) {
90 assert(i != e && "Didn't find reachable pred?");
91 OnePred = PredBlocks[i];
95 if (PredBlocks[i] != OnePred && isReachableFromEntry(OnePred)){
96 NewBBDominatesNewBBSucc = false;
100 if (NewBBDominatesNewBBSucc)
101 for (pred_iterator PI = pred_begin(NewBBSucc), E = pred_end(NewBBSucc);
103 if (*PI != NewBB && !dominates(NewBBSucc, *PI)) {
104 NewBBDominatesNewBBSucc = false;
109 // The other scenario where the new block can dominate its successors are when
110 // all predecessors of NewBBSucc that are not NewBB are dominated by NewBBSucc
112 if (!NewBBDominatesNewBBSucc) {
113 NewBBDominatesNewBBSucc = true;
114 for (pred_iterator PI = pred_begin(NewBBSucc), E = pred_end(NewBBSucc);
116 if (*PI != NewBB && !dominates(NewBBSucc, *PI)) {
117 NewBBDominatesNewBBSucc = false;
123 // Find NewBB's immediate dominator and create new dominator tree node for NewBB.
124 BasicBlock *NewBBIDom = 0;
126 for (i = 0; i < PredBlocks.size(); ++i)
127 if (isReachableFromEntry(PredBlocks[i])) {
128 NewBBIDom = PredBlocks[i];
131 assert(i != PredBlocks.size() && "No reachable preds?");
132 for (i = i + 1; i < PredBlocks.size(); ++i) {
133 if (isReachableFromEntry(PredBlocks[i]))
134 NewBBIDom = findNearestCommonDominator(NewBBIDom, PredBlocks[i]);
136 assert(NewBBIDom && "No immediate dominator found??");
138 // Create the new dominator tree node... and set the idom of NewBB.
139 DomTreeNode *NewBBNode = addNewBlock(NewBB, NewBBIDom);
141 // If NewBB strictly dominates other blocks, then it is now the immediate
142 // dominator of NewBBSucc. Update the dominator tree as appropriate.
143 if (NewBBDominatesNewBBSucc) {
144 DomTreeNode *NewBBSuccNode = getNode(NewBBSucc);
145 changeImmediateDominator(NewBBSuccNode, NewBBNode);
149 unsigned DominatorTree::DFSPass(BasicBlock *V, unsigned N) {
150 // This is more understandable as a recursive algorithm, but we can't use the
151 // recursive algorithm due to stack depth issues. Keep it here for
152 // documentation purposes.
154 InfoRec &VInfo = Info[Roots[i]];
158 Vertex.push_back(V); // Vertex[n] = V;
159 //Info[V].Ancestor = 0; // Ancestor[n] = 0
160 //Info[V].Child = 0; // Child[v] = 0
161 VInfo.Size = 1; // Size[v] = 1
163 for (succ_iterator SI = succ_begin(V), E = succ_end(V); SI != E; ++SI) {
164 InfoRec &SuccVInfo = Info[*SI];
165 if (SuccVInfo.Semi == 0) {
166 SuccVInfo.Parent = V;
171 std::vector<std::pair<BasicBlock*, unsigned> > Worklist;
172 Worklist.push_back(std::make_pair(V, 0U));
173 while (!Worklist.empty()) {
174 BasicBlock *BB = Worklist.back().first;
175 unsigned NextSucc = Worklist.back().second;
177 // First time we visited this BB?
179 InfoRec &BBInfo = Info[BB];
183 Vertex.push_back(BB); // Vertex[n] = V;
184 //BBInfo[V].Ancestor = 0; // Ancestor[n] = 0
185 //BBInfo[V].Child = 0; // Child[v] = 0
186 BBInfo.Size = 1; // Size[v] = 1
189 // If we are done with this block, remove it from the worklist.
190 if (NextSucc == BB->getTerminator()->getNumSuccessors()) {
195 // Otherwise, increment the successor number for the next time we get to it.
196 ++Worklist.back().second;
198 // Visit the successor next, if it isn't already visited.
199 BasicBlock *Succ = BB->getTerminator()->getSuccessor(NextSucc);
201 InfoRec &SuccVInfo = Info[Succ];
202 if (SuccVInfo.Semi == 0) {
203 SuccVInfo.Parent = BB;
204 Worklist.push_back(std::make_pair(Succ, 0U));
211 void DominatorTree::Compress(BasicBlock *VIn) {
213 std::vector<BasicBlock *> Work;
214 std::set<BasicBlock *> Visited;
215 BasicBlock *VInAncestor = Info[VIn].Ancestor;
216 InfoRec &VInVAInfo = Info[VInAncestor];
218 if (VInVAInfo.Ancestor != 0)
221 while (!Work.empty()) {
222 BasicBlock *V = Work.back();
223 InfoRec &VInfo = Info[V];
224 BasicBlock *VAncestor = VInfo.Ancestor;
225 InfoRec &VAInfo = Info[VAncestor];
227 // Process Ancestor first
228 if (Visited.count(VAncestor) == 0 && VAInfo.Ancestor != 0) {
229 Work.push_back(VAncestor);
230 Visited.insert(VAncestor);
235 // Update VInfo based on Ancestor info
236 if (VAInfo.Ancestor == 0)
238 BasicBlock *VAncestorLabel = VAInfo.Label;
239 BasicBlock *VLabel = VInfo.Label;
240 if (Info[VAncestorLabel].Semi < Info[VLabel].Semi)
241 VInfo.Label = VAncestorLabel;
242 VInfo.Ancestor = VAInfo.Ancestor;
246 BasicBlock *DominatorTree::Eval(BasicBlock *V) {
247 InfoRec &VInfo = Info[V];
248 #if !BALANCE_IDOM_TREE
249 // Higher-complexity but faster implementation
250 if (VInfo.Ancestor == 0)
255 // Lower-complexity but slower implementation
256 if (VInfo.Ancestor == 0)
259 BasicBlock *VLabel = VInfo.Label;
261 BasicBlock *VAncestorLabel = Info[VInfo.Ancestor].Label;
262 if (Info[VAncestorLabel].Semi >= Info[VLabel].Semi)
265 return VAncestorLabel;
269 void DominatorTree::Link(BasicBlock *V, BasicBlock *W, InfoRec &WInfo){
270 #if !BALANCE_IDOM_TREE
271 // Higher-complexity but faster implementation
274 // Lower-complexity but slower implementation
275 BasicBlock *WLabel = WInfo.Label;
276 unsigned WLabelSemi = Info[WLabel].Semi;
278 InfoRec *SInfo = &Info[S];
280 BasicBlock *SChild = SInfo->Child;
281 InfoRec *SChildInfo = &Info[SChild];
283 while (WLabelSemi < Info[SChildInfo->Label].Semi) {
284 BasicBlock *SChildChild = SChildInfo->Child;
285 if (SInfo->Size+Info[SChildChild].Size >= 2*SChildInfo->Size) {
286 SChildInfo->Ancestor = S;
287 SInfo->Child = SChild = SChildChild;
288 SChildInfo = &Info[SChild];
290 SChildInfo->Size = SInfo->Size;
291 S = SInfo->Ancestor = SChild;
293 SChild = SChildChild;
294 SChildInfo = &Info[SChild];
298 InfoRec &VInfo = Info[V];
299 SInfo->Label = WLabel;
301 assert(V != W && "The optimization here will not work in this case!");
302 unsigned WSize = WInfo.Size;
303 unsigned VSize = (VInfo.Size += WSize);
306 std::swap(S, VInfo.Child);
316 void DominatorTree::calculate(Function &F) {
317 BasicBlock* Root = Roots[0];
319 // Add a node for the root...
320 DomTreeNodes[Root] = RootNode = new DomTreeNode(Root, 0);
324 // Step #1: Number blocks in depth-first order and initialize variables used
325 // in later stages of the algorithm.
326 unsigned N = DFSPass(Root, 0);
328 for (unsigned i = N; i >= 2; --i) {
329 BasicBlock *W = Vertex[i];
330 InfoRec &WInfo = Info[W];
332 // Step #2: Calculate the semidominators of all vertices
333 for (pred_iterator PI = pred_begin(W), E = pred_end(W); PI != E; ++PI)
334 if (Info.count(*PI)) { // Only if this predecessor is reachable!
335 unsigned SemiU = Info[Eval(*PI)].Semi;
336 if (SemiU < WInfo.Semi)
340 Info[Vertex[WInfo.Semi]].Bucket.push_back(W);
342 BasicBlock *WParent = WInfo.Parent;
343 Link(WParent, W, WInfo);
345 // Step #3: Implicitly define the immediate dominator of vertices
346 std::vector<BasicBlock*> &WParentBucket = Info[WParent].Bucket;
347 while (!WParentBucket.empty()) {
348 BasicBlock *V = WParentBucket.back();
349 WParentBucket.pop_back();
350 BasicBlock *U = Eval(V);
351 IDoms[V] = Info[U].Semi < Info[V].Semi ? U : WParent;
355 // Step #4: Explicitly define the immediate dominator of each vertex
356 for (unsigned i = 2; i <= N; ++i) {
357 BasicBlock *W = Vertex[i];
358 BasicBlock *&WIDom = IDoms[W];
359 if (WIDom != Vertex[Info[W].Semi])
360 WIDom = IDoms[WIDom];
363 // Loop over all of the reachable blocks in the function...
364 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
365 if (BasicBlock *ImmDom = getIDom(I)) { // Reachable block.
366 DomTreeNode *BBNode = DomTreeNodes[I];
367 if (BBNode) continue; // Haven't calculated this node yet?
369 // Get or calculate the node for the immediate dominator
370 DomTreeNode *IDomNode = getNodeForBlock(ImmDom);
372 // Add a new tree node for this BasicBlock, and link it as a child of
374 DomTreeNode *C = new DomTreeNode(I, IDomNode);
375 DomTreeNodes[I] = IDomNode->addChild(C);
378 // Free temporary memory used to construct idom's
381 std::vector<BasicBlock*>().swap(Vertex);
386 void DominatorTreeBase::updateDFSNumbers() {
388 // Iterate over all nodes in depth first order.
389 for (unsigned i = 0, e = Roots.size(); i != e; ++i)
390 for (df_iterator<BasicBlock*> I = df_begin(Roots[i]),
391 E = df_end(Roots[i]); I != E; ++I) {
393 DomTreeNode *BBNode = getNode(BB);
395 if (!BBNode->getIDom())
396 BBNode->assignDFSNumber(dfsnum);
403 /// isReachableFromEntry - Return true if A is dominated by the entry
404 /// block of the function containing it.
405 const bool DominatorTreeBase::isReachableFromEntry(BasicBlock* A) {
406 assert (!isPostDominator()
407 && "This is not implemented for post dominators");
408 return dominates(&A->getParent()->getEntryBlock(), A);
411 // dominates - Return true if A dominates B. THis performs the
412 // special checks necessary if A and B are in the same basic block.
413 bool DominatorTreeBase::dominates(Instruction *A, Instruction *B) {
414 BasicBlock *BBA = A->getParent(), *BBB = B->getParent();
415 if (BBA != BBB) return dominates(BBA, BBB);
417 // It is not possible to determine dominance between two PHI nodes
418 // based on their ordering.
419 if (isa<PHINode>(A) && isa<PHINode>(B))
422 // Loop through the basic block until we find A or B.
423 BasicBlock::iterator I = BBA->begin();
424 for (; &*I != A && &*I != B; ++I) /*empty*/;
426 if(!IsPostDominators) {
427 // A dominates B if it is found first in the basic block.
430 // A post-dominates B if B is found first in the basic block.
435 // DominatorTreeBase::reset - Free all of the tree node memory.
437 void DominatorTreeBase::reset() {
438 for (DomTreeNodeMapType::iterator I = DomTreeNodes.begin(),
439 E = DomTreeNodes.end(); I != E; ++I)
441 DomTreeNodes.clear();
448 /// findNearestCommonDominator - Find nearest common dominator basic block
449 /// for basic block A and B. If there is no such block then return NULL.
450 BasicBlock *DominatorTreeBase::findNearestCommonDominator(BasicBlock *A,
453 assert (!isPostDominator()
454 && "This is not implemented for post dominators");
455 assert (A->getParent() == B->getParent()
456 && "Two blocks are not in same function");
458 // If either A or B is a entry block then it is nearest common dominator.
459 BasicBlock &Entry = A->getParent()->getEntryBlock();
460 if (A == &Entry || B == &Entry)
463 // If B dominates A then B is nearest common dominator.
467 // If A dominates B then A is nearest common dominator.
471 DomTreeNode *NodeA = getNode(A);
472 DomTreeNode *NodeB = getNode(B);
474 // Collect NodeA dominators set.
475 SmallPtrSet<DomTreeNode*, 16> NodeADoms;
476 NodeADoms.insert(NodeA);
477 DomTreeNode *IDomA = NodeA->getIDom();
479 NodeADoms.insert(IDomA);
480 IDomA = IDomA->getIDom();
483 // Walk NodeB immediate dominators chain and find common dominator node.
484 DomTreeNode *IDomB = NodeB->getIDom();
486 if (NodeADoms.count(IDomB) != 0)
487 return IDomB->getBlock();
489 IDomB = IDomB->getIDom();
495 /// assignDFSNumber - Assign In and Out numbers while walking dominator tree
497 void DomTreeNode::assignDFSNumber(int num) {
498 std::vector<DomTreeNode *> workStack;
499 std::set<DomTreeNode *> visitedNodes;
501 workStack.push_back(this);
502 visitedNodes.insert(this);
503 this->DFSNumIn = num++;
505 while (!workStack.empty()) {
506 DomTreeNode *Node = workStack.back();
508 bool visitChild = false;
509 for (std::vector<DomTreeNode*>::iterator DI = Node->begin(),
510 E = Node->end(); DI != E && !visitChild; ++DI) {
511 DomTreeNode *Child = *DI;
512 if (visitedNodes.count(Child) == 0) {
514 Child->DFSNumIn = num++;
515 workStack.push_back(Child);
516 visitedNodes.insert(Child);
520 // If we reach here means all children are visited
521 Node->DFSNumOut = num++;
522 workStack.pop_back();
527 void DomTreeNode::setIDom(DomTreeNode *NewIDom) {
528 assert(IDom && "No immediate dominator?");
529 if (IDom != NewIDom) {
530 std::vector<DomTreeNode*>::iterator I =
531 std::find(IDom->Children.begin(), IDom->Children.end(), this);
532 assert(I != IDom->Children.end() &&
533 "Not in immediate dominator children set!");
534 // I am no longer your child...
535 IDom->Children.erase(I);
537 // Switch to new dominator
539 IDom->Children.push_back(this);
543 DomTreeNode *DominatorTree::getNodeForBlock(BasicBlock *BB) {
544 DomTreeNode *&BBNode = DomTreeNodes[BB];
545 if (BBNode) return BBNode;
547 // Haven't calculated this node yet? Get or calculate the node for the
548 // immediate dominator.
549 BasicBlock *IDom = getIDom(BB);
550 DomTreeNode *IDomNode = getNodeForBlock(IDom);
552 // Add a new tree node for this BasicBlock, and link it as a child of
554 DomTreeNode *C = new DomTreeNode(BB, IDomNode);
555 DomTreeNodes[BB] = C;
556 return BBNode = IDomNode->addChild(C);
559 static std::ostream &operator<<(std::ostream &o,
560 const DomTreeNode *Node) {
561 if (Node->getBlock())
562 WriteAsOperand(o, Node->getBlock(), false);
564 o << " <<exit node>>";
568 static void PrintDomTree(const DomTreeNode *N, std::ostream &o,
570 o << std::string(2*Lev, ' ') << "[" << Lev << "] " << N;
571 for (DomTreeNode::const_iterator I = N->begin(), E = N->end();
573 PrintDomTree(*I, o, Lev+1);
576 void DominatorTreeBase::print(std::ostream &o, const Module* ) const {
577 o << "=============================--------------------------------\n"
578 << "Inorder Dominator Tree:\n";
579 PrintDomTree(getRootNode(), o, 1);
582 void DominatorTreeBase::dump() {
586 bool DominatorTree::runOnFunction(Function &F) {
587 reset(); // Reset from the last time we were run...
588 Roots.push_back(&F.getEntryBlock());
593 //===----------------------------------------------------------------------===//
594 // DominanceFrontier Implementation
595 //===----------------------------------------------------------------------===//
597 char DominanceFrontier::ID = 0;
598 static RegisterPass<DominanceFrontier>
599 G("domfrontier", "Dominance Frontier Construction", true);
601 // NewBB is split and now it has one successor. Update dominace frontier to
602 // reflect this change.
603 void DominanceFrontier::splitBlock(BasicBlock *NewBB) {
605 assert(NewBB->getTerminator()->getNumSuccessors() == 1
606 && "NewBB should have a single successor!");
607 BasicBlock *NewBBSucc = NewBB->getTerminator()->getSuccessor(0);
609 std::vector<BasicBlock*> PredBlocks;
610 for (pred_iterator PI = pred_begin(NewBB), PE = pred_end(NewBB);
612 PredBlocks.push_back(*PI);
614 if (PredBlocks.empty())
615 // If NewBB does not have any predecessors then it is a entry block.
616 // In this case, NewBB and its successor NewBBSucc dominates all
620 DominatorTree &DT = getAnalysis<DominatorTree>();
621 bool NewBBDominatesNewBBSucc = true;
622 if (!DT.dominates(NewBB, NewBBSucc))
623 NewBBDominatesNewBBSucc = false;
625 // NewBBSucc inherites original NewBB frontier.
626 DominanceFrontier::iterator NewBBI = find(NewBB);
627 if (NewBBI != end()) {
628 DominanceFrontier::DomSetType NewBBSet = NewBBI->second;
629 DominanceFrontier::DomSetType NewBBSuccSet;
630 NewBBSuccSet.insert(NewBBSet.begin(), NewBBSet.end());
631 addBasicBlock(NewBBSucc, NewBBSuccSet);
634 // If NewBB dominates NewBBSucc, then DF(NewBB) is now going to be the
635 // DF(PredBlocks[0]) without the stuff that the new block does not dominate
637 if (NewBBDominatesNewBBSucc) {
638 DominanceFrontier::iterator DFI = find(PredBlocks[0]);
640 DominanceFrontier::DomSetType Set = DFI->second;
641 // Filter out stuff in Set that we do not dominate a predecessor of.
642 for (DominanceFrontier::DomSetType::iterator SetI = Set.begin(),
643 E = Set.end(); SetI != E;) {
644 bool DominatesPred = false;
645 for (pred_iterator PI = pred_begin(*SetI), E = pred_end(*SetI);
647 if (DT.dominates(NewBB, *PI))
648 DominatesPred = true;
655 if (NewBBI != end()) {
656 DominanceFrontier::DomSetType NewBBSet = NewBBI->second;
657 NewBBSet.insert(Set.begin(), Set.end());
659 addBasicBlock(NewBB, Set);
663 // DF(NewBB) is {NewBBSucc} because NewBB does not strictly dominate
664 // NewBBSucc, but it does dominate itself (and there is an edge (NewBB ->
665 // NewBBSucc)). NewBBSucc is the single successor of NewBB.
666 DominanceFrontier::DomSetType NewDFSet;
667 NewDFSet.insert(NewBBSucc);
668 addBasicBlock(NewBB, NewDFSet);
671 // Now we must loop over all of the dominance frontiers in the function,
672 // replacing occurrences of NewBBSucc with NewBB in some cases. All
673 // blocks that dominate a block in PredBlocks and contained NewBBSucc in
674 // their dominance frontier must be updated to contain NewBB instead.
676 for (Function::iterator FI = NewBB->getParent()->begin(),
677 FE = NewBB->getParent()->end(); FI != FE; ++FI) {
678 DominanceFrontier::iterator DFI = find(FI);
679 if (DFI == end()) continue; // unreachable block.
681 // Only consider dominators of NewBBSucc
682 if (!DFI->second.count(NewBBSucc)) continue;
684 bool BlockDominatesAny = false;
685 for (std::vector<BasicBlock*>::const_iterator BI = PredBlocks.begin(),
686 BE = PredBlocks.end(); BI != BE; ++BI) {
687 if (DT.dominates(FI, *BI)) {
688 BlockDominatesAny = true;
693 if (BlockDominatesAny) {
694 // If NewBBSucc should not stay in our dominator frontier, remove it.
695 // We remove it unless there is a predecessor of NewBBSucc that we
696 // dominate, but we don't strictly dominate NewBBSucc.
697 bool ShouldRemove = true;
698 if ((BasicBlock*)FI == NewBBSucc
699 || !DT.dominates(FI, NewBBSucc)) {
700 // Okay, we know that PredDom does not strictly dominate NewBBSucc.
701 // Check to see if it dominates any predecessors of NewBBSucc.
702 for (pred_iterator PI = pred_begin(NewBBSucc),
703 E = pred_end(NewBBSucc); PI != E; ++PI)
704 if (DT.dominates(FI, *PI)) {
705 ShouldRemove = false;
710 removeFromFrontier(DFI, NewBBSucc);
711 addToFrontier(DFI, NewBB);
720 class DFCalculateWorkObject {
722 DFCalculateWorkObject(BasicBlock *B, BasicBlock *P,
723 const DomTreeNode *N,
724 const DomTreeNode *PN)
725 : currentBB(B), parentBB(P), Node(N), parentNode(PN) {}
726 BasicBlock *currentBB;
727 BasicBlock *parentBB;
728 const DomTreeNode *Node;
729 const DomTreeNode *parentNode;
733 const DominanceFrontier::DomSetType &
734 DominanceFrontier::calculate(const DominatorTree &DT,
735 const DomTreeNode *Node) {
736 BasicBlock *BB = Node->getBlock();
737 DomSetType *Result = NULL;
739 std::vector<DFCalculateWorkObject> workList;
740 SmallPtrSet<BasicBlock *, 32> visited;
742 workList.push_back(DFCalculateWorkObject(BB, NULL, Node, NULL));
744 DFCalculateWorkObject *currentW = &workList.back();
745 assert (currentW && "Missing work object.");
747 BasicBlock *currentBB = currentW->currentBB;
748 BasicBlock *parentBB = currentW->parentBB;
749 const DomTreeNode *currentNode = currentW->Node;
750 const DomTreeNode *parentNode = currentW->parentNode;
751 assert (currentBB && "Invalid work object. Missing current Basic Block");
752 assert (currentNode && "Invalid work object. Missing current Node");
753 DomSetType &S = Frontiers[currentBB];
755 // Visit each block only once.
756 if (visited.count(currentBB) == 0) {
757 visited.insert(currentBB);
759 // Loop over CFG successors to calculate DFlocal[currentNode]
760 for (succ_iterator SI = succ_begin(currentBB), SE = succ_end(currentBB);
762 // Does Node immediately dominate this successor?
763 if (DT[*SI]->getIDom() != currentNode)
768 // At this point, S is DFlocal. Now we union in DFup's of our children...
769 // Loop through and visit the nodes that Node immediately dominates (Node's
770 // children in the IDomTree)
771 bool visitChild = false;
772 for (DomTreeNode::const_iterator NI = currentNode->begin(),
773 NE = currentNode->end(); NI != NE; ++NI) {
774 DomTreeNode *IDominee = *NI;
775 BasicBlock *childBB = IDominee->getBlock();
776 if (visited.count(childBB) == 0) {
777 workList.push_back(DFCalculateWorkObject(childBB, currentBB,
778 IDominee, currentNode));
783 // If all children are visited or there is any child then pop this block
784 // from the workList.
792 DomSetType::const_iterator CDFI = S.begin(), CDFE = S.end();
793 DomSetType &parentSet = Frontiers[parentBB];
794 for (; CDFI != CDFE; ++CDFI) {
795 if (!DT.properlyDominates(parentNode, DT[*CDFI]))
796 parentSet.insert(*CDFI);
801 } while (!workList.empty());
806 void DominanceFrontierBase::print(std::ostream &o, const Module* ) const {
807 for (const_iterator I = begin(), E = end(); I != E; ++I) {
808 o << " DomFrontier for BB";
810 WriteAsOperand(o, I->first, false);
812 o << " <<exit node>>";
813 o << " is:\t" << I->second << "\n";
817 void DominanceFrontierBase::dump() {