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 bool Region::contains(const BasicBlock *B) const {
76 BasicBlock *BB = const_cast<BasicBlock*>(B);
78 assert(DT->getNode(BB) && "BB not part of the dominance tree");
80 BasicBlock *entry = getEntry(), *exit = getExit();
86 return (DT->dominates(entry, BB)
87 && !(DT->dominates(exit, BB) && DT->dominates(entry, exit)));
90 bool Region::contains(const Loop *L) const {
91 // BBs that are not part of any loop are element of the Loop
92 // described by the NULL pointer. This loop is not part of any region,
93 // except if the region describes the whole function.
95 return getExit() == 0;
97 if (!contains(L->getHeader()))
100 SmallVector<BasicBlock *, 8> ExitingBlocks;
101 L->getExitingBlocks(ExitingBlocks);
103 for (SmallVectorImpl<BasicBlock*>::iterator BI = ExitingBlocks.begin(),
104 BE = ExitingBlocks.end(); BI != BE; ++BI)
111 Loop *Region::outermostLoopInRegion(Loop *L) const {
115 while (L && contains(L->getParentLoop())) {
116 L = L->getParentLoop();
122 Loop *Region::outermostLoopInRegion(LoopInfo *LI, BasicBlock* BB) const {
123 assert(LI && BB && "LI and BB cannot be null!");
124 Loop *L = LI->getLoopFor(BB);
125 return outermostLoopInRegion(L);
128 bool Region::isSimple() const {
129 bool isSimple = true;
132 BasicBlock *entry = getEntry(), *exit = getExit();
138 for (pred_iterator PI = pred_begin(entry), PE = pred_end(entry); PI != PE;
140 BasicBlock *Pred = *PI;
141 if (DT->getNode(Pred) && !contains(Pred)) {
152 for (pred_iterator PI = pred_begin(exit), PE = pred_end(exit); PI != PE;
165 std::string Region::getNameStr() const {
166 std::string exitName;
167 std::string entryName;
169 if (getEntry()->getName().empty()) {
170 raw_string_ostream OS(entryName);
172 WriteAsOperand(OS, getEntry(), false);
173 entryName = OS.str();
175 entryName = getEntry()->getNameStr();
178 if (getExit()->getName().empty()) {
179 raw_string_ostream OS(exitName);
181 WriteAsOperand(OS, getExit(), false);
184 exitName = getExit()->getNameStr();
186 exitName = "<Function Return>";
188 return entryName + " => " + exitName;
191 void Region::verifyBBInRegion(BasicBlock *BB) const {
193 llvm_unreachable("Broken region found!");
195 BasicBlock *entry = getEntry(), *exit = getExit();
197 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
198 if (!contains(*SI) && exit != *SI)
199 llvm_unreachable("Broken region found!");
202 for (pred_iterator SI = pred_begin(BB), SE = pred_end(BB); SI != SE; ++SI)
204 llvm_unreachable("Broken region found!");
207 void Region::verifyWalk(BasicBlock *BB, std::set<BasicBlock*> *visited) const {
208 BasicBlock *exit = getExit();
212 verifyBBInRegion(BB);
214 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
215 if (*SI != exit && visited->find(*SI) == visited->end())
216 verifyWalk(*SI, visited);
219 void Region::verifyRegion() const {
220 // Only do verification when user wants to, otherwise this expensive
221 // check will be invoked by PassManager.
222 if (!VerifyRegionInfo) return;
224 std::set<BasicBlock*> visited;
225 verifyWalk(getEntry(), &visited);
228 void Region::verifyRegionNest() const {
229 for (Region::const_iterator RI = begin(), RE = end(); RI != RE; ++RI)
230 (*RI)->verifyRegionNest();
235 Region::block_iterator Region::block_begin() {
236 return GraphTraits<FlatIt<Region*> >::nodes_begin(this);
239 Region::block_iterator Region::block_end() {
240 return GraphTraits<FlatIt<Region*> >::nodes_end(this);
243 Region::const_block_iterator Region::block_begin() const {
244 return GraphTraits<FlatIt<const Region*> >::nodes_begin(this);
247 Region::const_block_iterator Region::block_end() const {
248 return GraphTraits<FlatIt<const Region*> >::nodes_end(this);
251 Region::element_iterator Region::element_begin() {
252 return GraphTraits<Region*>::nodes_begin(this);
255 Region::element_iterator Region::element_end() {
256 return GraphTraits<Region*>::nodes_end(this);
259 Region::const_element_iterator Region::element_begin() const {
260 return GraphTraits<const Region*>::nodes_begin(this);
263 Region::const_element_iterator Region::element_end() const {
264 return GraphTraits<const Region*>::nodes_end(this);
267 Region* Region::getSubRegionNode(BasicBlock *BB) const {
268 Region *R = RI->getRegionFor(BB);
273 // If we pass the BB out of this region, that means our code is broken.
274 assert(contains(R) && "BB not in current region!");
276 while (contains(R->getParent()) && R->getParent() != this)
279 if (R->getEntry() != BB)
285 RegionNode* Region::getBBNode(BasicBlock *BB) const {
286 assert(contains(BB) && "Can get BB node out of this region!");
288 BBNodeMapT::const_iterator at = BBNodeMap.find(BB);
290 if (at != BBNodeMap.end())
293 RegionNode *NewNode = new RegionNode(const_cast<Region*>(this), BB);
294 BBNodeMap.insert(std::make_pair(BB, NewNode));
298 RegionNode* Region::getNode(BasicBlock *BB) const {
299 assert(contains(BB) && "Can get BB node out of this region!");
300 if (Region* Child = getSubRegionNode(BB))
301 return Child->getNode();
303 return getBBNode(BB);
306 void Region::transferChildrenTo(Region *To) {
307 for (iterator I = begin(), E = end(); I != E; ++I) {
309 To->children.push_back(*I);
314 void Region::addSubRegion(Region *SubRegion, bool moveChildren) {
315 assert(SubRegion->parent == 0 && "SubRegion already has a parent!");
316 assert(std::find(begin(), end(), SubRegion) == children.end()
317 && "Subregion already exists!");
319 SubRegion->parent = this;
320 children.push_back(SubRegion);
325 assert(SubRegion->children.size() == 0
326 && "SubRegions that contain children are not supported");
328 for (element_iterator I = element_begin(), E = element_end(); I != E; ++I)
329 if (!(*I)->isSubRegion()) {
330 BasicBlock *BB = (*I)->getNodeAs<BasicBlock>();
332 if (SubRegion->contains(BB))
333 RI->setRegionFor(BB, SubRegion);
336 std::vector<Region*> Keep;
337 for (iterator I = begin(), E = end(); I != E; ++I)
338 if (SubRegion->contains(*I) && *I != SubRegion) {
339 SubRegion->children.push_back(*I);
340 (*I)->parent = SubRegion;
345 children.insert(children.begin(), Keep.begin(), Keep.end());
349 Region *Region::removeSubRegion(Region *Child) {
350 assert(Child->parent == this && "Child is not a child of this region!");
352 RegionSet::iterator I = std::find(children.begin(), children.end(), Child);
353 assert(I != children.end() && "Region does not exit. Unable to remove.");
354 children.erase(children.begin()+(I-begin()));
358 unsigned Region::getDepth() const {
361 for (Region *R = parent; R != 0; R = R->parent)
367 void Region::print(raw_ostream &OS, bool print_tree, unsigned level) const {
369 OS.indent(level*2) << "[" << level << "] " << getNameStr();
371 OS.indent(level*2) << getNameStr();
376 if (printStyle != PrintNone) {
377 OS.indent(level*2) << "{\n";
378 OS.indent(level*2 + 2);
380 if (printStyle == PrintBB) {
381 for (const_block_iterator I = block_begin(), E = block_end(); I!=E; ++I)
382 OS << **I << ", "; // TODO: remove the last ","
383 } else if (printStyle == PrintRN) {
384 for (const_element_iterator I = element_begin(), E = element_end(); I!=E; ++I)
385 OS << **I << ", "; // TODO: remove the last ",
392 for (const_iterator RI = begin(), RE = end(); RI != RE; ++RI)
393 (*RI)->print(OS, print_tree, level+1);
395 if (printStyle != PrintNone)
396 OS.indent(level*2) << "} \n";
399 void Region::dump() const {
400 print(dbgs(), true, getDepth());
403 void Region::clearNodeCache() {
404 // Free the cached nodes.
405 for (BBNodeMapT::iterator I = BBNodeMap.begin(),
406 IE = BBNodeMap.end(); I != IE; ++IE)
410 for (Region::iterator RI = begin(), RE = end(); RI != RE; ++RI)
411 (*RI)->clearNodeCache();
414 //===----------------------------------------------------------------------===//
415 // RegionInfo implementation
418 bool RegionInfo::isCommonDomFrontier(BasicBlock *BB, BasicBlock *entry,
419 BasicBlock *exit) const {
420 for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE; ++PI) {
422 if (DT->dominates(entry, P) && !DT->dominates(exit, P))
428 bool RegionInfo::isRegion(BasicBlock *entry, BasicBlock *exit) const {
429 assert(entry && exit && "entry and exit must not be null!");
430 typedef DominanceFrontier::DomSetType DST;
432 DST *entrySuccs = &DF->find(entry)->second;
434 // Exit is the header of a loop that contains the entry. In this case,
435 // the dominance frontier must only contain the exit.
436 if (!DT->dominates(entry, exit)) {
437 for (DST::iterator SI = entrySuccs->begin(), SE = entrySuccs->end();
439 if (*SI != exit && *SI != entry)
445 DST *exitSuccs = &DF->find(exit)->second;
447 // Do not allow edges leaving the region.
448 for (DST::iterator SI = entrySuccs->begin(), SE = entrySuccs->end();
450 if (*SI == exit || *SI == entry)
452 if (exitSuccs->find(*SI) == exitSuccs->end())
454 if (!isCommonDomFrontier(*SI, entry, exit))
458 // Do not allow edges pointing into the region.
459 for (DST::iterator SI = exitSuccs->begin(), SE = exitSuccs->end();
461 if (DT->properlyDominates(entry, *SI) && *SI != exit)
468 void RegionInfo::insertShortCut(BasicBlock *entry, BasicBlock *exit,
469 BBtoBBMap *ShortCut) const {
470 assert(entry && exit && "entry and exit must not be null!");
472 BBtoBBMap::iterator e = ShortCut->find(exit);
474 if (e == ShortCut->end())
475 // No further region at exit available.
476 (*ShortCut)[entry] = exit;
478 // We found a region e that starts at exit. Therefore (entry, e->second)
479 // is also a region, that is larger than (entry, exit). Insert the
481 BasicBlock *BB = e->second;
482 (*ShortCut)[entry] = BB;
486 DomTreeNode* RegionInfo::getNextPostDom(DomTreeNode* N,
487 BBtoBBMap *ShortCut) const {
488 BBtoBBMap::iterator e = ShortCut->find(N->getBlock());
490 if (e == ShortCut->end())
493 return PDT->getNode(e->second)->getIDom();
496 bool RegionInfo::isTrivialRegion(BasicBlock *entry, BasicBlock *exit) const {
497 assert(entry && exit && "entry and exit must not be null!");
499 unsigned num_successors = succ_end(entry) - succ_begin(entry);
501 if (num_successors <= 1 && exit == *(succ_begin(entry)))
507 void RegionInfo::updateStatistics(Region *R) {
510 // TODO: Slow. Should only be enabled if -stats is used.
511 if (R->isSimple()) ++numSimpleRegions;
514 Region *RegionInfo::createRegion(BasicBlock *entry, BasicBlock *exit) {
515 assert(entry && exit && "entry and exit must not be null!");
517 if (isTrivialRegion(entry, exit))
520 Region *region = new Region(entry, exit, this, DT);
521 BBtoRegion.insert(std::make_pair(entry, region));
524 region->verifyRegion();
526 DEBUG(region->verifyRegion());
529 updateStatistics(region);
533 void RegionInfo::findRegionsWithEntry(BasicBlock *entry, BBtoBBMap *ShortCut) {
536 DomTreeNode *N = PDT->getNode(entry);
541 Region *lastRegion= 0;
542 BasicBlock *lastExit = entry;
544 // As only a BasicBlock that postdominates entry can finish a region, walk the
545 // post dominance tree upwards.
546 while ((N = getNextPostDom(N, ShortCut))) {
547 BasicBlock *exit = N->getBlock();
552 if (isRegion(entry, exit)) {
553 Region *newRegion = createRegion(entry, exit);
556 newRegion->addSubRegion(lastRegion);
558 lastRegion = newRegion;
562 // This can never be a region, so stop the search.
563 if (!DT->dominates(entry, exit))
567 // Tried to create regions from entry to lastExit. Next time take a
568 // shortcut from entry to lastExit.
569 if (lastExit != entry)
570 insertShortCut(entry, lastExit, ShortCut);
573 void RegionInfo::scanForRegions(Function &F, BBtoBBMap *ShortCut) {
574 BasicBlock *entry = &(F.getEntryBlock());
575 DomTreeNode *N = DT->getNode(entry);
577 // Iterate over the dominance tree in post order to start with the small
578 // regions from the bottom of the dominance tree. If the small regions are
579 // detected first, detection of bigger regions is faster, as we can jump
580 // over the small regions.
581 for (po_iterator<DomTreeNode*> FI = po_begin(N), FE = po_end(N); FI != FE;
583 findRegionsWithEntry(FI->getBlock(), ShortCut);
587 Region *RegionInfo::getTopMostParent(Region *region) {
588 while (region->parent)
589 region = region->getParent();
594 void RegionInfo::buildRegionsTree(DomTreeNode *N, Region *region) {
595 BasicBlock *BB = N->getBlock();
597 // Passed region exit
598 while (BB == region->getExit())
599 region = region->getParent();
601 BBtoRegionMap::iterator it = BBtoRegion.find(BB);
603 // This basic block is a start block of a region. It is already in the
604 // BBtoRegion relation. Only the child basic blocks have to be updated.
605 if (it != BBtoRegion.end()) {
606 Region *newRegion = it->second;;
607 region->addSubRegion(getTopMostParent(newRegion));
610 BBtoRegion[BB] = region;
613 for (DomTreeNode::iterator CI = N->begin(), CE = N->end(); CI != CE; ++CI)
614 buildRegionsTree(*CI, region);
617 void RegionInfo::releaseMemory() {
620 delete TopLevelRegion;
624 RegionInfo::RegionInfo() : FunctionPass(ID) {
628 RegionInfo::~RegionInfo() {
632 void RegionInfo::Calculate(Function &F) {
633 // ShortCut a function where for every BB the exit of the largest region
634 // starting with BB is stored. These regions can be threated as single BBS.
635 // This improves performance on linear CFGs.
638 scanForRegions(F, &ShortCut);
639 BasicBlock *BB = &F.getEntryBlock();
640 buildRegionsTree(DT->getNode(BB), TopLevelRegion);
643 bool RegionInfo::runOnFunction(Function &F) {
646 DT = &getAnalysis<DominatorTree>();
647 PDT = &getAnalysis<PostDominatorTree>();
648 DF = &getAnalysis<DominanceFrontier>();
650 TopLevelRegion = new Region(&F.getEntryBlock(), 0, this, DT, 0);
651 updateStatistics(TopLevelRegion);
658 void RegionInfo::getAnalysisUsage(AnalysisUsage &AU) const {
659 AU.setPreservesAll();
660 AU.addRequiredTransitive<DominatorTree>();
661 AU.addRequired<PostDominatorTree>();
662 AU.addRequired<DominanceFrontier>();
665 void RegionInfo::print(raw_ostream &OS, const Module *) const {
666 OS << "Region tree:\n";
667 TopLevelRegion->print(OS, true, 0);
668 OS << "End region tree\n";
671 void RegionInfo::verifyAnalysis() const {
672 // Only do verification when user wants to, otherwise this expensive check
673 // will be invoked by PMDataManager::verifyPreservedAnalysis when
674 // a regionpass (marked PreservedAll) finish.
675 if (!VerifyRegionInfo) return;
677 TopLevelRegion->verifyRegionNest();
680 // Region pass manager support.
681 Region *RegionInfo::getRegionFor(BasicBlock *BB) const {
682 BBtoRegionMap::const_iterator I=
684 return I != BBtoRegion.end() ? I->second : 0;
687 void RegionInfo::setRegionFor(BasicBlock *BB, Region *R) {
691 Region *RegionInfo::operator[](BasicBlock *BB) const {
692 return getRegionFor(BB);
695 BasicBlock *RegionInfo::getMaxRegionExit(BasicBlock *BB) const {
696 BasicBlock *Exit = NULL;
699 // Get largest region that starts at BB.
700 Region *R = getRegionFor(BB);
701 while (R && R->getParent() && R->getParent()->getEntry() == BB)
704 // Get the single exit of BB.
705 if (R && R->getEntry() == BB)
707 else if (++succ_begin(BB) == succ_end(BB))
708 Exit = *succ_begin(BB);
709 else // No single exit exists.
712 // Get largest region that starts at Exit.
713 Region *ExitR = getRegionFor(Exit);
714 while (ExitR && ExitR->getParent()
715 && ExitR->getParent()->getEntry() == Exit)
716 ExitR = ExitR->getParent();
718 for (pred_iterator PI = pred_begin(Exit), PE = pred_end(Exit); PI != PE;
720 if (!R->contains(*PI) && !ExitR->contains(*PI))
723 // This stops infinite cycles.
724 if (DT->dominates(Exit, BB))
734 RegionInfo::getCommonRegion(Region *A, Region *B) const {
735 assert (A && B && "One of the Regions is NULL");
737 if (A->contains(B)) return A;
739 while (!B->contains(A))
746 RegionInfo::getCommonRegion(SmallVectorImpl<Region*> &Regions) const {
747 Region* ret = Regions.back();
750 for (SmallVectorImpl<Region*>::const_iterator I = Regions.begin(),
751 E = Regions.end(); I != E; ++I)
752 ret = getCommonRegion(ret, *I);
758 RegionInfo::getCommonRegion(SmallVectorImpl<BasicBlock*> &BBs) const {
759 Region* ret = getRegionFor(BBs.back());
762 for (SmallVectorImpl<BasicBlock*>::const_iterator I = BBs.begin(),
763 E = BBs.end(); I != E; ++I)
764 ret = getCommonRegion(ret, getRegionFor(*I));
769 char RegionInfo::ID = 0;
770 INITIALIZE_PASS_BEGIN(RegionInfo, "regions",
771 "Detect single entry single exit regions", true, true)
772 INITIALIZE_PASS_DEPENDENCY(DominatorTree)
773 INITIALIZE_PASS_DEPENDENCY(PostDominatorTree)
774 INITIALIZE_PASS_DEPENDENCY(DominanceFrontier)
775 INITIALIZE_PASS_END(RegionInfo, "regions",
776 "Detect single entry single exit regions", true, true)
778 // Create methods available outside of this file, to use them
779 // "include/llvm/LinkAllPasses.h". Otherwise the pass would be deleted by
780 // the link time optimization.
783 FunctionPass *createRegionInfoPass() {
784 return new RegionInfo();