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/Support/raw_ostream.h"
20 #include "llvm/Analysis/LoopInfo.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 //===----------------------------------------------------------------------===//
45 /// PrintStyle - Print region in difference ways.
46 enum PrintStyle { PrintNone, PrintBB, PrintRN };
48 cl::opt<enum PrintStyle> printStyle("print-region-style", cl::Hidden,
49 cl::desc("style of printing regions"),
51 clEnumValN(PrintNone, "none", "print no details"),
52 clEnumValN(PrintBB, "bb", "print regions in detail with block_iterator"),
53 clEnumValN(PrintRN, "rn", "print regions in detail with element_iterator"),
55 //===----------------------------------------------------------------------===//
56 /// Region Implementation
57 Region::Region(BasicBlock *Entry, BasicBlock *Exit, RegionInfo* RInfo,
58 DominatorTree *dt, Region *Parent)
59 : RegionNode(Parent, Entry, 1), RI(RInfo), DT(dt), exit(Exit) {}
62 // Free the cached nodes.
63 for (BBNodeMapT::iterator it = BBNodeMap.begin(),
64 ie = BBNodeMap.end(); it != ie; ++it)
67 // Only clean the cache for this Region. Caches of child Regions will be
68 // cleaned when the child Regions are deleted.
71 for (iterator I = begin(), E = end(); I != E; ++I)
75 void Region::replaceEntry(BasicBlock *BB) {
79 void Region::replaceExit(BasicBlock *BB) {
80 assert(exit && "No exit to replace!");
84 bool Region::contains(const BasicBlock *B) const {
85 BasicBlock *BB = const_cast<BasicBlock*>(B);
87 assert(DT->getNode(BB) && "BB not part of the dominance tree");
89 BasicBlock *entry = getEntry(), *exit = getExit();
95 return (DT->dominates(entry, BB)
96 && !(DT->dominates(exit, BB) && DT->dominates(entry, exit)));
99 bool Region::contains(const Loop *L) const {
100 // BBs that are not part of any loop are element of the Loop
101 // described by the NULL pointer. This loop is not part of any region,
102 // except if the region describes the whole function.
104 return getExit() == 0;
106 if (!contains(L->getHeader()))
109 SmallVector<BasicBlock *, 8> ExitingBlocks;
110 L->getExitingBlocks(ExitingBlocks);
112 for (SmallVectorImpl<BasicBlock*>::iterator BI = ExitingBlocks.begin(),
113 BE = ExitingBlocks.end(); BI != BE; ++BI)
120 Loop *Region::outermostLoopInRegion(Loop *L) const {
124 while (L && contains(L->getParentLoop())) {
125 L = L->getParentLoop();
131 Loop *Region::outermostLoopInRegion(LoopInfo *LI, BasicBlock* BB) const {
132 assert(LI && BB && "LI and BB cannot be null!");
133 Loop *L = LI->getLoopFor(BB);
134 return outermostLoopInRegion(L);
137 bool Region::isSimple() const {
138 bool isSimple = true;
141 BasicBlock *entry = getEntry(), *exit = getExit();
147 for (pred_iterator PI = pred_begin(entry), PE = pred_end(entry); PI != PE;
149 BasicBlock *Pred = *PI;
150 if (DT->getNode(Pred) && !contains(Pred)) {
161 for (pred_iterator PI = pred_begin(exit), PE = pred_end(exit); PI != PE;
174 std::string Region::getNameStr() const {
175 std::string exitName;
176 std::string entryName;
178 if (getEntry()->getName().empty()) {
179 raw_string_ostream OS(entryName);
181 WriteAsOperand(OS, getEntry(), false);
182 entryName = OS.str();
184 entryName = getEntry()->getNameStr();
187 if (getExit()->getName().empty()) {
188 raw_string_ostream OS(exitName);
190 WriteAsOperand(OS, getExit(), false);
193 exitName = getExit()->getNameStr();
195 exitName = "<Function Return>";
197 return entryName + " => " + exitName;
200 void Region::verifyBBInRegion(BasicBlock *BB) const {
202 llvm_unreachable("Broken region found!");
204 BasicBlock *entry = getEntry(), *exit = getExit();
206 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
207 if (!contains(*SI) && exit != *SI)
208 llvm_unreachable("Broken region found!");
211 for (pred_iterator SI = pred_begin(BB), SE = pred_end(BB); SI != SE; ++SI)
213 llvm_unreachable("Broken region found!");
216 void Region::verifyWalk(BasicBlock *BB, std::set<BasicBlock*> *visited) const {
217 BasicBlock *exit = getExit();
221 verifyBBInRegion(BB);
223 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
224 if (*SI != exit && visited->find(*SI) == visited->end())
225 verifyWalk(*SI, visited);
228 void Region::verifyRegion() const {
229 // Only do verification when user wants to, otherwise this expensive
230 // check will be invoked by PassManager.
231 if (!VerifyRegionInfo) return;
233 std::set<BasicBlock*> visited;
234 verifyWalk(getEntry(), &visited);
237 void Region::verifyRegionNest() const {
238 for (Region::const_iterator RI = begin(), RE = end(); RI != RE; ++RI)
239 (*RI)->verifyRegionNest();
244 Region::block_iterator Region::block_begin() {
245 return GraphTraits<FlatIt<Region*> >::nodes_begin(this);
248 Region::block_iterator Region::block_end() {
249 return GraphTraits<FlatIt<Region*> >::nodes_end(this);
252 Region::const_block_iterator Region::block_begin() const {
253 return GraphTraits<FlatIt<const Region*> >::nodes_begin(this);
256 Region::const_block_iterator Region::block_end() const {
257 return GraphTraits<FlatIt<const Region*> >::nodes_end(this);
260 Region::element_iterator Region::element_begin() {
261 return GraphTraits<Region*>::nodes_begin(this);
264 Region::element_iterator Region::element_end() {
265 return GraphTraits<Region*>::nodes_end(this);
268 Region::const_element_iterator Region::element_begin() const {
269 return GraphTraits<const Region*>::nodes_begin(this);
272 Region::const_element_iterator Region::element_end() const {
273 return GraphTraits<const Region*>::nodes_end(this);
276 Region* Region::getSubRegionNode(BasicBlock *BB) const {
277 Region *R = RI->getRegionFor(BB);
282 // If we pass the BB out of this region, that means our code is broken.
283 assert(contains(R) && "BB not in current region!");
285 while (contains(R->getParent()) && R->getParent() != this)
288 if (R->getEntry() != BB)
294 RegionNode* Region::getBBNode(BasicBlock *BB) const {
295 assert(contains(BB) && "Can get BB node out of this region!");
297 BBNodeMapT::const_iterator at = BBNodeMap.find(BB);
299 if (at != BBNodeMap.end())
302 RegionNode *NewNode = new RegionNode(const_cast<Region*>(this), BB);
303 BBNodeMap.insert(std::make_pair(BB, NewNode));
307 RegionNode* Region::getNode(BasicBlock *BB) const {
308 assert(contains(BB) && "Can get BB node out of this region!");
309 if (Region* Child = getSubRegionNode(BB))
310 return Child->getNode();
312 return getBBNode(BB);
315 void Region::transferChildrenTo(Region *To) {
316 for (iterator I = begin(), E = end(); I != E; ++I) {
318 To->children.push_back(*I);
323 void Region::addSubRegion(Region *SubRegion, bool moveChildren) {
324 assert(SubRegion->parent == 0 && "SubRegion already has a parent!");
325 assert(std::find(begin(), end(), SubRegion) == children.end()
326 && "Subregion already exists!");
328 SubRegion->parent = this;
329 children.push_back(SubRegion);
334 assert(SubRegion->children.size() == 0
335 && "SubRegions that contain children are not supported");
337 for (element_iterator I = element_begin(), E = element_end(); I != E; ++I)
338 if (!(*I)->isSubRegion()) {
339 BasicBlock *BB = (*I)->getNodeAs<BasicBlock>();
341 if (SubRegion->contains(BB))
342 RI->setRegionFor(BB, SubRegion);
345 std::vector<Region*> Keep;
346 for (iterator I = begin(), E = end(); I != E; ++I)
347 if (SubRegion->contains(*I) && *I != SubRegion) {
348 SubRegion->children.push_back(*I);
349 (*I)->parent = SubRegion;
354 children.insert(children.begin(), Keep.begin(), Keep.end());
358 Region *Region::removeSubRegion(Region *Child) {
359 assert(Child->parent == this && "Child is not a child of this region!");
361 RegionSet::iterator I = std::find(children.begin(), children.end(), Child);
362 assert(I != children.end() && "Region does not exit. Unable to remove.");
363 children.erase(children.begin()+(I-begin()));
367 unsigned Region::getDepth() const {
370 for (Region *R = parent; R != 0; R = R->parent)
376 Region *Region::getExpandedRegion() const {
377 unsigned NumSuccessors = exit->getTerminator()->getNumSuccessors();
379 if (NumSuccessors == 0)
382 for (pred_iterator PI = pred_begin(getExit()), PE = pred_end(getExit());
384 if (!DT->dominates(getEntry(), *PI))
387 Region *R = RI->getRegionFor(exit);
389 if (R->getEntry() != exit) {
390 if (exit->getTerminator()->getNumSuccessors() == 1)
391 return new Region(getEntry(), *succ_begin(exit), RI, DT);
396 while (R->getParent() && R->getParent()->getEntry() == exit)
399 if (!DT->dominates(getEntry(), R->getExit()))
400 for (pred_iterator PI = pred_begin(getExit()), PE = pred_end(getExit());
402 if (!DT->dominates(R->getExit(), *PI))
405 return new Region(getEntry(), R->getExit(), RI, DT);
408 void Region::print(raw_ostream &OS, bool print_tree, unsigned level) const {
410 OS.indent(level*2) << "[" << level << "] " << getNameStr();
412 OS.indent(level*2) << getNameStr();
417 if (printStyle != PrintNone) {
418 OS.indent(level*2) << "{\n";
419 OS.indent(level*2 + 2);
421 if (printStyle == PrintBB) {
422 for (const_block_iterator I = block_begin(), E = block_end(); I!=E; ++I)
423 OS << **I << ", "; // TODO: remove the last ","
424 } else if (printStyle == PrintRN) {
425 for (const_element_iterator I = element_begin(), E = element_end(); I!=E; ++I)
426 OS << **I << ", "; // TODO: remove the last ",
433 for (const_iterator RI = begin(), RE = end(); RI != RE; ++RI)
434 (*RI)->print(OS, print_tree, level+1);
436 if (printStyle != PrintNone)
437 OS.indent(level*2) << "} \n";
440 void Region::dump() const {
441 print(dbgs(), true, getDepth());
444 void Region::clearNodeCache() {
445 // Free the cached nodes.
446 for (BBNodeMapT::iterator I = BBNodeMap.begin(),
447 IE = BBNodeMap.end(); I != IE; ++IE)
451 for (Region::iterator RI = begin(), RE = end(); RI != RE; ++RI)
452 (*RI)->clearNodeCache();
455 //===----------------------------------------------------------------------===//
456 // RegionInfo implementation
459 bool RegionInfo::isCommonDomFrontier(BasicBlock *BB, BasicBlock *entry,
460 BasicBlock *exit) const {
461 for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE; ++PI) {
463 if (DT->dominates(entry, P) && !DT->dominates(exit, P))
469 bool RegionInfo::isRegion(BasicBlock *entry, BasicBlock *exit) const {
470 assert(entry && exit && "entry and exit must not be null!");
471 typedef DominanceFrontier::DomSetType DST;
473 DST *entrySuccs = &DF->find(entry)->second;
475 // Exit is the header of a loop that contains the entry. In this case,
476 // the dominance frontier must only contain the exit.
477 if (!DT->dominates(entry, exit)) {
478 for (DST::iterator SI = entrySuccs->begin(), SE = entrySuccs->end();
480 if (*SI != exit && *SI != entry)
486 DST *exitSuccs = &DF->find(exit)->second;
488 // Do not allow edges leaving the region.
489 for (DST::iterator SI = entrySuccs->begin(), SE = entrySuccs->end();
491 if (*SI == exit || *SI == entry)
493 if (exitSuccs->find(*SI) == exitSuccs->end())
495 if (!isCommonDomFrontier(*SI, entry, exit))
499 // Do not allow edges pointing into the region.
500 for (DST::iterator SI = exitSuccs->begin(), SE = exitSuccs->end();
502 if (DT->properlyDominates(entry, *SI) && *SI != exit)
509 void RegionInfo::insertShortCut(BasicBlock *entry, BasicBlock *exit,
510 BBtoBBMap *ShortCut) const {
511 assert(entry && exit && "entry and exit must not be null!");
513 BBtoBBMap::iterator e = ShortCut->find(exit);
515 if (e == ShortCut->end())
516 // No further region at exit available.
517 (*ShortCut)[entry] = exit;
519 // We found a region e that starts at exit. Therefore (entry, e->second)
520 // is also a region, that is larger than (entry, exit). Insert the
522 BasicBlock *BB = e->second;
523 (*ShortCut)[entry] = BB;
527 DomTreeNode* RegionInfo::getNextPostDom(DomTreeNode* N,
528 BBtoBBMap *ShortCut) const {
529 BBtoBBMap::iterator e = ShortCut->find(N->getBlock());
531 if (e == ShortCut->end())
534 return PDT->getNode(e->second)->getIDom();
537 bool RegionInfo::isTrivialRegion(BasicBlock *entry, BasicBlock *exit) const {
538 assert(entry && exit && "entry and exit must not be null!");
540 unsigned num_successors = succ_end(entry) - succ_begin(entry);
542 if (num_successors <= 1 && exit == *(succ_begin(entry)))
548 void RegionInfo::updateStatistics(Region *R) {
551 // TODO: Slow. Should only be enabled if -stats is used.
552 if (R->isSimple()) ++numSimpleRegions;
555 Region *RegionInfo::createRegion(BasicBlock *entry, BasicBlock *exit) {
556 assert(entry && exit && "entry and exit must not be null!");
558 if (isTrivialRegion(entry, exit))
561 Region *region = new Region(entry, exit, this, DT);
562 BBtoRegion.insert(std::make_pair(entry, region));
565 region->verifyRegion();
567 DEBUG(region->verifyRegion());
570 updateStatistics(region);
574 void RegionInfo::findRegionsWithEntry(BasicBlock *entry, BBtoBBMap *ShortCut) {
577 DomTreeNode *N = PDT->getNode(entry);
582 Region *lastRegion= 0;
583 BasicBlock *lastExit = entry;
585 // As only a BasicBlock that postdominates entry can finish a region, walk the
586 // post dominance tree upwards.
587 while ((N = getNextPostDom(N, ShortCut))) {
588 BasicBlock *exit = N->getBlock();
593 if (isRegion(entry, exit)) {
594 Region *newRegion = createRegion(entry, exit);
597 newRegion->addSubRegion(lastRegion);
599 lastRegion = newRegion;
603 // This can never be a region, so stop the search.
604 if (!DT->dominates(entry, exit))
608 // Tried to create regions from entry to lastExit. Next time take a
609 // shortcut from entry to lastExit.
610 if (lastExit != entry)
611 insertShortCut(entry, lastExit, ShortCut);
614 void RegionInfo::scanForRegions(Function &F, BBtoBBMap *ShortCut) {
615 BasicBlock *entry = &(F.getEntryBlock());
616 DomTreeNode *N = DT->getNode(entry);
618 // Iterate over the dominance tree in post order to start with the small
619 // regions from the bottom of the dominance tree. If the small regions are
620 // detected first, detection of bigger regions is faster, as we can jump
621 // over the small regions.
622 for (po_iterator<DomTreeNode*> FI = po_begin(N), FE = po_end(N); FI != FE;
624 findRegionsWithEntry(FI->getBlock(), ShortCut);
628 Region *RegionInfo::getTopMostParent(Region *region) {
629 while (region->parent)
630 region = region->getParent();
635 void RegionInfo::buildRegionsTree(DomTreeNode *N, Region *region) {
636 BasicBlock *BB = N->getBlock();
638 // Passed region exit
639 while (BB == region->getExit())
640 region = region->getParent();
642 BBtoRegionMap::iterator it = BBtoRegion.find(BB);
644 // This basic block is a start block of a region. It is already in the
645 // BBtoRegion relation. Only the child basic blocks have to be updated.
646 if (it != BBtoRegion.end()) {
647 Region *newRegion = it->second;;
648 region->addSubRegion(getTopMostParent(newRegion));
651 BBtoRegion[BB] = region;
654 for (DomTreeNode::iterator CI = N->begin(), CE = N->end(); CI != CE; ++CI)
655 buildRegionsTree(*CI, region);
658 void RegionInfo::releaseMemory() {
661 delete TopLevelRegion;
665 RegionInfo::RegionInfo() : FunctionPass(ID) {
669 RegionInfo::~RegionInfo() {
673 void RegionInfo::Calculate(Function &F) {
674 // ShortCut a function where for every BB the exit of the largest region
675 // starting with BB is stored. These regions can be threated as single BBS.
676 // This improves performance on linear CFGs.
679 scanForRegions(F, &ShortCut);
680 BasicBlock *BB = &F.getEntryBlock();
681 buildRegionsTree(DT->getNode(BB), TopLevelRegion);
684 bool RegionInfo::runOnFunction(Function &F) {
687 DT = &getAnalysis<DominatorTree>();
688 PDT = &getAnalysis<PostDominatorTree>();
689 DF = &getAnalysis<DominanceFrontier>();
691 TopLevelRegion = new Region(&F.getEntryBlock(), 0, this, DT, 0);
692 updateStatistics(TopLevelRegion);
699 void RegionInfo::getAnalysisUsage(AnalysisUsage &AU) const {
700 AU.setPreservesAll();
701 AU.addRequiredTransitive<DominatorTree>();
702 AU.addRequired<PostDominatorTree>();
703 AU.addRequired<DominanceFrontier>();
706 void RegionInfo::print(raw_ostream &OS, const Module *) const {
707 OS << "Region tree:\n";
708 TopLevelRegion->print(OS, true, 0);
709 OS << "End region tree\n";
712 void RegionInfo::verifyAnalysis() const {
713 // Only do verification when user wants to, otherwise this expensive check
714 // will be invoked by PMDataManager::verifyPreservedAnalysis when
715 // a regionpass (marked PreservedAll) finish.
716 if (!VerifyRegionInfo) return;
718 TopLevelRegion->verifyRegionNest();
721 // Region pass manager support.
722 Region *RegionInfo::getRegionFor(BasicBlock *BB) const {
723 BBtoRegionMap::const_iterator I=
725 return I != BBtoRegion.end() ? I->second : 0;
728 void RegionInfo::setRegionFor(BasicBlock *BB, Region *R) {
732 Region *RegionInfo::operator[](BasicBlock *BB) const {
733 return getRegionFor(BB);
736 BasicBlock *RegionInfo::getMaxRegionExit(BasicBlock *BB) const {
737 BasicBlock *Exit = NULL;
740 // Get largest region that starts at BB.
741 Region *R = getRegionFor(BB);
742 while (R && R->getParent() && R->getParent()->getEntry() == BB)
745 // Get the single exit of BB.
746 if (R && R->getEntry() == BB)
748 else if (++succ_begin(BB) == succ_end(BB))
749 Exit = *succ_begin(BB);
750 else // No single exit exists.
753 // Get largest region that starts at Exit.
754 Region *ExitR = getRegionFor(Exit);
755 while (ExitR && ExitR->getParent()
756 && ExitR->getParent()->getEntry() == Exit)
757 ExitR = ExitR->getParent();
759 for (pred_iterator PI = pred_begin(Exit), PE = pred_end(Exit); PI != PE;
761 if (!R->contains(*PI) && !ExitR->contains(*PI))
764 // This stops infinite cycles.
765 if (DT->dominates(Exit, BB))
775 RegionInfo::getCommonRegion(Region *A, Region *B) const {
776 assert (A && B && "One of the Regions is NULL");
778 if (A->contains(B)) return A;
780 while (!B->contains(A))
787 RegionInfo::getCommonRegion(SmallVectorImpl<Region*> &Regions) const {
788 Region* ret = Regions.back();
791 for (SmallVectorImpl<Region*>::const_iterator I = Regions.begin(),
792 E = Regions.end(); I != E; ++I)
793 ret = getCommonRegion(ret, *I);
799 RegionInfo::getCommonRegion(SmallVectorImpl<BasicBlock*> &BBs) const {
800 Region* ret = getRegionFor(BBs.back());
803 for (SmallVectorImpl<BasicBlock*>::const_iterator I = BBs.begin(),
804 E = BBs.end(); I != E; ++I)
805 ret = getCommonRegion(ret, getRegionFor(*I));
810 void RegionInfo::splitBlock(BasicBlock* NewBB, BasicBlock *OldBB)
812 Region *R = getRegionFor(OldBB);
813 setRegionFor(NewBB, R);
815 while (R->getEntry() == OldBB && R->getParent()) {
816 R->replaceEntry(NewBB);
820 setRegionFor(OldBB, R);
823 char RegionInfo::ID = 0;
824 INITIALIZE_PASS_BEGIN(RegionInfo, "regions",
825 "Detect single entry single exit regions", true, true)
826 INITIALIZE_PASS_DEPENDENCY(DominatorTree)
827 INITIALIZE_PASS_DEPENDENCY(PostDominatorTree)
828 INITIALIZE_PASS_DEPENDENCY(DominanceFrontier)
829 INITIALIZE_PASS_END(RegionInfo, "regions",
830 "Detect single entry single exit regions", true, true)
832 // Create methods available outside of this file, to use them
833 // "include/llvm/LinkAllPasses.h". Otherwise the pass would be deleted by
834 // the link time optimization.
837 FunctionPass *createRegionInfoPass() {
838 return new RegionInfo();