1 //===- RegionInfo.cpp - SESE region detection analysis --------------------===//
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 //===----------------------------------------------------------------------===//
9 // Detects single entry single exit regions in the control flow graph.
10 //===----------------------------------------------------------------------===//
12 #include "llvm/Analysis/RegionInfo.h"
13 #include "llvm/Analysis/RegionIterator.h"
15 #include "llvm/ADT/PostOrderIterator.h"
16 #include "llvm/ADT/Statistic.h"
17 #include "llvm/Support/CommandLine.h"
18 #include "llvm/Support/ErrorHandling.h"
19 #include "llvm/Analysis/LoopInfo.h"
20 #include "llvm/Assembly/Writer.h"
22 #define DEBUG_TYPE "region"
23 #include "llvm/Support/Debug.h"
30 // Always verify if expensive checking is enabled.
32 static bool VerifyRegionInfo = true;
34 static bool VerifyRegionInfo = false;
37 static cl::opt<bool,true>
38 VerifyRegionInfoX("verify-region-info", cl::location(VerifyRegionInfo),
39 cl::desc("Verify region info (time consuming)"));
41 STATISTIC(numRegions, "The # of regions");
42 STATISTIC(numSimpleRegions, "The # of simple regions");
44 static cl::opt<enum Region::PrintStyle> printStyle("print-region-style",
46 cl::desc("style of printing regions"),
48 clEnumValN(Region::PrintNone, "none", "print no details"),
49 clEnumValN(Region::PrintBB, "bb",
50 "print regions in detail with block_iterator"),
51 clEnumValN(Region::PrintRN, "rn",
52 "print regions in detail with element_iterator"),
54 //===----------------------------------------------------------------------===//
55 /// Region Implementation
56 Region::Region(BasicBlock *Entry, BasicBlock *Exit, RegionInfo* RInfo,
57 DominatorTree *dt, Region *Parent)
58 : RegionNode(Parent, Entry, 1), RI(RInfo), DT(dt), exit(Exit) {}
61 // Free the cached nodes.
62 for (BBNodeMapT::iterator it = BBNodeMap.begin(),
63 ie = BBNodeMap.end(); it != ie; ++it)
66 // Only clean the cache for this Region. Caches of child Regions will be
67 // cleaned when the child Regions are deleted.
70 for (iterator I = begin(), E = end(); I != E; ++I)
74 void Region::replaceEntry(BasicBlock *BB) {
78 void Region::replaceExit(BasicBlock *BB) {
79 assert(exit && "No exit to replace!");
83 bool Region::contains(const BasicBlock *B) const {
84 BasicBlock *BB = const_cast<BasicBlock*>(B);
86 assert(DT->getNode(BB) && "BB not part of the dominance tree");
88 BasicBlock *entry = getEntry(), *exit = getExit();
94 return (DT->dominates(entry, BB)
95 && !(DT->dominates(exit, BB) && DT->dominates(entry, exit)));
98 bool Region::contains(const Loop *L) const {
99 // BBs that are not part of any loop are element of the Loop
100 // described by the NULL pointer. This loop is not part of any region,
101 // except if the region describes the whole function.
103 return getExit() == 0;
105 if (!contains(L->getHeader()))
108 SmallVector<BasicBlock *, 8> ExitingBlocks;
109 L->getExitingBlocks(ExitingBlocks);
111 for (SmallVectorImpl<BasicBlock*>::iterator BI = ExitingBlocks.begin(),
112 BE = ExitingBlocks.end(); BI != BE; ++BI)
119 Loop *Region::outermostLoopInRegion(Loop *L) const {
123 while (L && contains(L->getParentLoop())) {
124 L = L->getParentLoop();
130 Loop *Region::outermostLoopInRegion(LoopInfo *LI, BasicBlock* BB) const {
131 assert(LI && BB && "LI and BB cannot be null!");
132 Loop *L = LI->getLoopFor(BB);
133 return outermostLoopInRegion(L);
136 BasicBlock *Region::getEnteringBlock() const {
137 BasicBlock *entry = getEntry();
139 BasicBlock *enteringBlock = 0;
141 for (pred_iterator PI = pred_begin(entry), PE = pred_end(entry); PI != PE;
144 if (DT->getNode(Pred) && !contains(Pred)) {
148 enteringBlock = Pred;
152 return enteringBlock;
155 BasicBlock *Region::getExitingBlock() const {
156 BasicBlock *exit = getExit();
158 BasicBlock *exitingBlock = 0;
163 for (pred_iterator PI = pred_begin(exit), PE = pred_end(exit); PI != PE;
166 if (contains(Pred)) {
177 bool Region::isSimple() const {
178 return !isTopLevelRegion() && getEnteringBlock() && getExitingBlock();
181 std::string Region::getNameStr() const {
182 std::string exitName;
183 std::string entryName;
185 if (getEntry()->getName().empty()) {
186 raw_string_ostream OS(entryName);
188 WriteAsOperand(OS, getEntry(), false);
190 entryName = getEntry()->getName();
193 if (getExit()->getName().empty()) {
194 raw_string_ostream OS(exitName);
196 WriteAsOperand(OS, getExit(), false);
198 exitName = getExit()->getName();
200 exitName = "<Function Return>";
202 return entryName + " => " + exitName;
205 void Region::verifyBBInRegion(BasicBlock *BB) const {
207 llvm_unreachable("Broken region found!");
209 BasicBlock *entry = getEntry(), *exit = getExit();
211 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
212 if (!contains(*SI) && exit != *SI)
213 llvm_unreachable("Broken region found!");
216 for (pred_iterator SI = pred_begin(BB), SE = pred_end(BB); SI != SE; ++SI)
218 llvm_unreachable("Broken region found!");
221 void Region::verifyWalk(BasicBlock *BB, std::set<BasicBlock*> *visited) const {
222 BasicBlock *exit = getExit();
226 verifyBBInRegion(BB);
228 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
229 if (*SI != exit && visited->find(*SI) == visited->end())
230 verifyWalk(*SI, visited);
233 void Region::verifyRegion() const {
234 // Only do verification when user wants to, otherwise this expensive
235 // check will be invoked by PassManager.
236 if (!VerifyRegionInfo) return;
238 std::set<BasicBlock*> visited;
239 verifyWalk(getEntry(), &visited);
242 void Region::verifyRegionNest() const {
243 for (Region::const_iterator RI = begin(), RE = end(); RI != RE; ++RI)
244 (*RI)->verifyRegionNest();
249 Region::block_iterator Region::block_begin() {
250 return GraphTraits<FlatIt<Region*> >::nodes_begin(this);
253 Region::block_iterator Region::block_end() {
254 return GraphTraits<FlatIt<Region*> >::nodes_end(this);
257 Region::const_block_iterator Region::block_begin() const {
258 return GraphTraits<FlatIt<const Region*> >::nodes_begin(this);
261 Region::const_block_iterator Region::block_end() const {
262 return GraphTraits<FlatIt<const Region*> >::nodes_end(this);
265 Region::element_iterator Region::element_begin() {
266 return GraphTraits<Region*>::nodes_begin(this);
269 Region::element_iterator Region::element_end() {
270 return GraphTraits<Region*>::nodes_end(this);
273 Region::const_element_iterator Region::element_begin() const {
274 return GraphTraits<const Region*>::nodes_begin(this);
277 Region::const_element_iterator Region::element_end() const {
278 return GraphTraits<const Region*>::nodes_end(this);
281 Region* Region::getSubRegionNode(BasicBlock *BB) const {
282 Region *R = RI->getRegionFor(BB);
287 // If we pass the BB out of this region, that means our code is broken.
288 assert(contains(R) && "BB not in current region!");
290 while (contains(R->getParent()) && R->getParent() != this)
293 if (R->getEntry() != BB)
299 RegionNode* Region::getBBNode(BasicBlock *BB) const {
300 assert(contains(BB) && "Can get BB node out of this region!");
302 BBNodeMapT::const_iterator at = BBNodeMap.find(BB);
304 if (at != BBNodeMap.end())
307 RegionNode *NewNode = new RegionNode(const_cast<Region*>(this), BB);
308 BBNodeMap.insert(std::make_pair(BB, NewNode));
312 RegionNode* Region::getNode(BasicBlock *BB) const {
313 assert(contains(BB) && "Can get BB node out of this region!");
314 if (Region* Child = getSubRegionNode(BB))
315 return Child->getNode();
317 return getBBNode(BB);
320 void Region::transferChildrenTo(Region *To) {
321 for (iterator I = begin(), E = end(); I != E; ++I) {
323 To->children.push_back(*I);
328 void Region::addSubRegion(Region *SubRegion, bool moveChildren) {
329 assert(SubRegion->parent == 0 && "SubRegion already has a parent!");
330 assert(std::find(begin(), end(), SubRegion) == children.end()
331 && "Subregion already exists!");
333 SubRegion->parent = this;
334 children.push_back(SubRegion);
339 assert(SubRegion->children.size() == 0
340 && "SubRegions that contain children are not supported");
342 for (element_iterator I = element_begin(), E = element_end(); I != E; ++I)
343 if (!(*I)->isSubRegion()) {
344 BasicBlock *BB = (*I)->getNodeAs<BasicBlock>();
346 if (SubRegion->contains(BB))
347 RI->setRegionFor(BB, SubRegion);
350 std::vector<Region*> Keep;
351 for (iterator I = begin(), E = end(); I != E; ++I)
352 if (SubRegion->contains(*I) && *I != SubRegion) {
353 SubRegion->children.push_back(*I);
354 (*I)->parent = SubRegion;
359 children.insert(children.begin(), Keep.begin(), Keep.end());
363 Region *Region::removeSubRegion(Region *Child) {
364 assert(Child->parent == this && "Child is not a child of this region!");
366 RegionSet::iterator I = std::find(children.begin(), children.end(), Child);
367 assert(I != children.end() && "Region does not exit. Unable to remove.");
368 children.erase(children.begin()+(I-begin()));
372 unsigned Region::getDepth() const {
375 for (Region *R = parent; R != 0; R = R->parent)
381 Region *Region::getExpandedRegion() const {
382 unsigned NumSuccessors = exit->getTerminator()->getNumSuccessors();
384 if (NumSuccessors == 0)
387 for (pred_iterator PI = pred_begin(getExit()), PE = pred_end(getExit());
389 if (!DT->dominates(getEntry(), *PI))
392 Region *R = RI->getRegionFor(exit);
394 if (R->getEntry() != exit) {
395 if (exit->getTerminator()->getNumSuccessors() == 1)
396 return new Region(getEntry(), *succ_begin(exit), RI, DT);
401 while (R->getParent() && R->getParent()->getEntry() == exit)
404 if (!DT->dominates(getEntry(), R->getExit()))
405 for (pred_iterator PI = pred_begin(getExit()), PE = pred_end(getExit());
407 if (!DT->dominates(R->getExit(), *PI))
410 return new Region(getEntry(), R->getExit(), RI, DT);
413 void Region::print(raw_ostream &OS, bool print_tree, unsigned level,
414 enum PrintStyle Style) const {
416 OS.indent(level*2) << "[" << level << "] " << getNameStr();
418 OS.indent(level*2) << getNameStr();
423 if (Style != PrintNone) {
424 OS.indent(level*2) << "{\n";
425 OS.indent(level*2 + 2);
427 if (Style == PrintBB) {
428 for (const_block_iterator I = block_begin(), E = block_end(); I!=E; ++I)
429 OS << **I << ", "; // TODO: remove the last ","
430 } else if (Style == PrintRN) {
431 for (const_element_iterator I = element_begin(), E = element_end(); I!=E; ++I)
432 OS << **I << ", "; // TODO: remove the last ",
439 for (const_iterator RI = begin(), RE = end(); RI != RE; ++RI)
440 (*RI)->print(OS, print_tree, level+1, Style);
442 if (Style != PrintNone)
443 OS.indent(level*2) << "} \n";
446 void Region::dump() const {
447 print(dbgs(), true, getDepth(), printStyle.getValue());
450 void Region::clearNodeCache() {
451 // Free the cached nodes.
452 for (BBNodeMapT::iterator I = BBNodeMap.begin(),
453 IE = BBNodeMap.end(); I != IE; ++I)
457 for (Region::iterator RI = begin(), RE = end(); RI != RE; ++RI)
458 (*RI)->clearNodeCache();
461 //===----------------------------------------------------------------------===//
462 // RegionInfo implementation
465 bool RegionInfo::isCommonDomFrontier(BasicBlock *BB, BasicBlock *entry,
466 BasicBlock *exit) const {
467 for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE; ++PI) {
469 if (DT->dominates(entry, P) && !DT->dominates(exit, P))
475 bool RegionInfo::isRegion(BasicBlock *entry, BasicBlock *exit) const {
476 assert(entry && exit && "entry and exit must not be null!");
477 typedef DominanceFrontier::DomSetType DST;
479 DST *entrySuccs = &DF->find(entry)->second;
481 // Exit is the header of a loop that contains the entry. In this case,
482 // the dominance frontier must only contain the exit.
483 if (!DT->dominates(entry, exit)) {
484 for (DST::iterator SI = entrySuccs->begin(), SE = entrySuccs->end();
486 if (*SI != exit && *SI != entry)
492 DST *exitSuccs = &DF->find(exit)->second;
494 // Do not allow edges leaving the region.
495 for (DST::iterator SI = entrySuccs->begin(), SE = entrySuccs->end();
497 if (*SI == exit || *SI == entry)
499 if (exitSuccs->find(*SI) == exitSuccs->end())
501 if (!isCommonDomFrontier(*SI, entry, exit))
505 // Do not allow edges pointing into the region.
506 for (DST::iterator SI = exitSuccs->begin(), SE = exitSuccs->end();
508 if (DT->properlyDominates(entry, *SI) && *SI != exit)
515 void RegionInfo::insertShortCut(BasicBlock *entry, BasicBlock *exit,
516 BBtoBBMap *ShortCut) const {
517 assert(entry && exit && "entry and exit must not be null!");
519 BBtoBBMap::iterator e = ShortCut->find(exit);
521 if (e == ShortCut->end())
522 // No further region at exit available.
523 (*ShortCut)[entry] = exit;
525 // We found a region e that starts at exit. Therefore (entry, e->second)
526 // is also a region, that is larger than (entry, exit). Insert the
528 BasicBlock *BB = e->second;
529 (*ShortCut)[entry] = BB;
533 DomTreeNode* RegionInfo::getNextPostDom(DomTreeNode* N,
534 BBtoBBMap *ShortCut) const {
535 BBtoBBMap::iterator e = ShortCut->find(N->getBlock());
537 if (e == ShortCut->end())
540 return PDT->getNode(e->second)->getIDom();
543 bool RegionInfo::isTrivialRegion(BasicBlock *entry, BasicBlock *exit) const {
544 assert(entry && exit && "entry and exit must not be null!");
546 unsigned num_successors = succ_end(entry) - succ_begin(entry);
548 if (num_successors <= 1 && exit == *(succ_begin(entry)))
554 void RegionInfo::updateStatistics(Region *R) {
557 // TODO: Slow. Should only be enabled if -stats is used.
558 if (R->isSimple()) ++numSimpleRegions;
561 Region *RegionInfo::createRegion(BasicBlock *entry, BasicBlock *exit) {
562 assert(entry && exit && "entry and exit must not be null!");
564 if (isTrivialRegion(entry, exit))
567 Region *region = new Region(entry, exit, this, DT);
568 BBtoRegion.insert(std::make_pair(entry, region));
571 region->verifyRegion();
573 DEBUG(region->verifyRegion());
576 updateStatistics(region);
580 void RegionInfo::findRegionsWithEntry(BasicBlock *entry, BBtoBBMap *ShortCut) {
583 DomTreeNode *N = PDT->getNode(entry);
588 Region *lastRegion= 0;
589 BasicBlock *lastExit = entry;
591 // As only a BasicBlock that postdominates entry can finish a region, walk the
592 // post dominance tree upwards.
593 while ((N = getNextPostDom(N, ShortCut))) {
594 BasicBlock *exit = N->getBlock();
599 if (isRegion(entry, exit)) {
600 Region *newRegion = createRegion(entry, exit);
603 newRegion->addSubRegion(lastRegion);
605 lastRegion = newRegion;
609 // This can never be a region, so stop the search.
610 if (!DT->dominates(entry, exit))
614 // Tried to create regions from entry to lastExit. Next time take a
615 // shortcut from entry to lastExit.
616 if (lastExit != entry)
617 insertShortCut(entry, lastExit, ShortCut);
620 void RegionInfo::scanForRegions(Function &F, BBtoBBMap *ShortCut) {
621 BasicBlock *entry = &(F.getEntryBlock());
622 DomTreeNode *N = DT->getNode(entry);
624 // Iterate over the dominance tree in post order to start with the small
625 // regions from the bottom of the dominance tree. If the small regions are
626 // detected first, detection of bigger regions is faster, as we can jump
627 // over the small regions.
628 for (po_iterator<DomTreeNode*> FI = po_begin(N), FE = po_end(N); FI != FE;
630 findRegionsWithEntry(FI->getBlock(), ShortCut);
634 Region *RegionInfo::getTopMostParent(Region *region) {
635 while (region->parent)
636 region = region->getParent();
641 void RegionInfo::buildRegionsTree(DomTreeNode *N, Region *region) {
642 BasicBlock *BB = N->getBlock();
644 // Passed region exit
645 while (BB == region->getExit())
646 region = region->getParent();
648 BBtoRegionMap::iterator it = BBtoRegion.find(BB);
650 // This basic block is a start block of a region. It is already in the
651 // BBtoRegion relation. Only the child basic blocks have to be updated.
652 if (it != BBtoRegion.end()) {
653 Region *newRegion = it->second;
654 region->addSubRegion(getTopMostParent(newRegion));
657 BBtoRegion[BB] = region;
660 for (DomTreeNode::iterator CI = N->begin(), CE = N->end(); CI != CE; ++CI)
661 buildRegionsTree(*CI, region);
664 void RegionInfo::releaseMemory() {
667 delete TopLevelRegion;
671 RegionInfo::RegionInfo() : FunctionPass(ID) {
672 initializeRegionInfoPass(*PassRegistry::getPassRegistry());
676 RegionInfo::~RegionInfo() {
680 void RegionInfo::Calculate(Function &F) {
681 // ShortCut a function where for every BB the exit of the largest region
682 // starting with BB is stored. These regions can be threated as single BBS.
683 // This improves performance on linear CFGs.
686 scanForRegions(F, &ShortCut);
687 BasicBlock *BB = &F.getEntryBlock();
688 buildRegionsTree(DT->getNode(BB), TopLevelRegion);
691 bool RegionInfo::runOnFunction(Function &F) {
694 DT = &getAnalysis<DominatorTree>();
695 PDT = &getAnalysis<PostDominatorTree>();
696 DF = &getAnalysis<DominanceFrontier>();
698 TopLevelRegion = new Region(&F.getEntryBlock(), 0, this, DT, 0);
699 updateStatistics(TopLevelRegion);
706 void RegionInfo::getAnalysisUsage(AnalysisUsage &AU) const {
707 AU.setPreservesAll();
708 AU.addRequiredTransitive<DominatorTree>();
709 AU.addRequired<PostDominatorTree>();
710 AU.addRequired<DominanceFrontier>();
713 void RegionInfo::print(raw_ostream &OS, const Module *) const {
714 OS << "Region tree:\n";
715 TopLevelRegion->print(OS, true, 0, printStyle.getValue());
716 OS << "End region tree\n";
719 void RegionInfo::verifyAnalysis() const {
720 // Only do verification when user wants to, otherwise this expensive check
721 // will be invoked by PMDataManager::verifyPreservedAnalysis when
722 // a regionpass (marked PreservedAll) finish.
723 if (!VerifyRegionInfo) return;
725 TopLevelRegion->verifyRegionNest();
728 // Region pass manager support.
729 Region *RegionInfo::getRegionFor(BasicBlock *BB) const {
730 BBtoRegionMap::const_iterator I=
732 return I != BBtoRegion.end() ? I->second : 0;
735 void RegionInfo::setRegionFor(BasicBlock *BB, Region *R) {
739 Region *RegionInfo::operator[](BasicBlock *BB) const {
740 return getRegionFor(BB);
743 BasicBlock *RegionInfo::getMaxRegionExit(BasicBlock *BB) const {
744 BasicBlock *Exit = NULL;
747 // Get largest region that starts at BB.
748 Region *R = getRegionFor(BB);
749 while (R && R->getParent() && R->getParent()->getEntry() == BB)
752 // Get the single exit of BB.
753 if (R && R->getEntry() == BB)
755 else if (++succ_begin(BB) == succ_end(BB))
756 Exit = *succ_begin(BB);
757 else // No single exit exists.
760 // Get largest region that starts at Exit.
761 Region *ExitR = getRegionFor(Exit);
762 while (ExitR && ExitR->getParent()
763 && ExitR->getParent()->getEntry() == Exit)
764 ExitR = ExitR->getParent();
766 for (pred_iterator PI = pred_begin(Exit), PE = pred_end(Exit); PI != PE;
768 if (!R->contains(*PI) && !ExitR->contains(*PI))
771 // This stops infinite cycles.
772 if (DT->dominates(Exit, BB))
782 RegionInfo::getCommonRegion(Region *A, Region *B) const {
783 assert (A && B && "One of the Regions is NULL");
785 if (A->contains(B)) return A;
787 while (!B->contains(A))
794 RegionInfo::getCommonRegion(SmallVectorImpl<Region*> &Regions) const {
795 Region* ret = Regions.back();
798 for (SmallVectorImpl<Region*>::const_iterator I = Regions.begin(),
799 E = Regions.end(); I != E; ++I)
800 ret = getCommonRegion(ret, *I);
806 RegionInfo::getCommonRegion(SmallVectorImpl<BasicBlock*> &BBs) const {
807 Region* ret = getRegionFor(BBs.back());
810 for (SmallVectorImpl<BasicBlock*>::const_iterator I = BBs.begin(),
811 E = BBs.end(); I != E; ++I)
812 ret = getCommonRegion(ret, getRegionFor(*I));
817 void RegionInfo::splitBlock(BasicBlock* NewBB, BasicBlock *OldBB)
819 Region *R = getRegionFor(OldBB);
821 setRegionFor(NewBB, R);
823 while (R->getEntry() == OldBB && !R->isTopLevelRegion()) {
824 R->replaceEntry(NewBB);
828 setRegionFor(OldBB, R);
831 char RegionInfo::ID = 0;
832 INITIALIZE_PASS_BEGIN(RegionInfo, "regions",
833 "Detect single entry single exit regions", true, true)
834 INITIALIZE_PASS_DEPENDENCY(DominatorTree)
835 INITIALIZE_PASS_DEPENDENCY(PostDominatorTree)
836 INITIALIZE_PASS_DEPENDENCY(DominanceFrontier)
837 INITIALIZE_PASS_END(RegionInfo, "regions",
838 "Detect single entry single exit regions", true, true)
840 // Create methods available outside of this file, to use them
841 // "include/llvm/LinkAllPasses.h". Otherwise the pass would be deleted by
842 // the link time optimization.
845 FunctionPass *createRegionInfoPass() {
846 return new RegionInfo();