lib/Analysis/RegionInfo.cpp

   1 //===- RegionInfo.cpp - SESE region detection analysis --------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 // Detects single entry single exit regions in the control flow graph.
  10 //===----------------------------------------------------------------------===//
  11
  12 #include "llvm/Analysis/RegionInfo.h"
  13 #include "llvm/Analysis/RegionIterator.h"
  14
  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"
  21
  22 #define DEBUG_TYPE "region"
  23 #include "llvm/Support/Debug.h"
  24
  25 #include <set>
  26 #include <algorithm>
  27
  28 using namespace llvm;
  29
  30 // Always verify if expensive checking is enabled.
  31 #ifdef XDEBUG
  32 static bool VerifyRegionInfo = true;
  33 #else
  34 static bool VerifyRegionInfo = false;
  35 #endif
  36
  37 static cl::opt<bool,true>
  38 VerifyRegionInfoX("verify-region-info", cl::location(VerifyRegionInfo),
  39                 cl::desc("Verify region info (time consuming)"));
  40
  41 STATISTIC(numRegions,       "The # of regions");
  42 STATISTIC(numSimpleRegions, "The # of simple regions");
  43
  44 //===----------------------------------------------------------------------===//
  45 /// PrintStyle - Print region in difference ways.
  46 enum PrintStyle { PrintNone, PrintBB, PrintRN  };
  47
  48 cl::opt<enum PrintStyle> printStyle("print-region-style", cl::Hidden,
  49   cl::desc("style of printing regions"),
  50   cl::values(
  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"),
  54     clEnumValEnd));
  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) {}
  60
  61 Region::~Region() {
  62   // Free the cached nodes.
  63   for (BBNodeMapT::iterator it = BBNodeMap.begin(),
  64          ie = BBNodeMap.end(); it != ie; ++it)
  65     delete it->second;
  66
  67   // Only clean the cache for this Region. Caches of child Regions will be
  68   // cleaned when the child Regions are deleted.
  69   BBNodeMap.clear();
  70
  71   for (iterator I = begin(), E = end(); I != E; ++I)
  72     delete *I;
  73 }
  74
  75 void Region::replaceEntry(BasicBlock *BB) {
  76   entry.setPointer(BB);
  77 }
  78
  79 void Region::replaceExit(BasicBlock *BB) {
  80   assert(exit && "No exit to replace!");
  81   exit = BB;
  82 }
  83
  84 bool Region::contains(const BasicBlock *B) const {
  85   BasicBlock *BB = const_cast<BasicBlock*>(B);
  86
  87   assert(DT->getNode(BB) && "BB not part of the dominance tree");
  88
  89   BasicBlock *entry = getEntry(), *exit = getExit();
  90
  91   // Toplevel region.
  92   if (!exit)
  93     return true;
  94
  95   return (DT->dominates(entry, BB)
  96     && !(DT->dominates(exit, BB) && DT->dominates(entry, exit)));
  97 }
  98
  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.
 103   if (L == 0)
 104     return getExit() == 0;
 105
 106   if (!contains(L->getHeader()))
 107     return false;
 108
 109   SmallVector<BasicBlock *, 8> ExitingBlocks;
 110   L->getExitingBlocks(ExitingBlocks);
 111
 112   for (SmallVectorImpl<BasicBlock*>::iterator BI = ExitingBlocks.begin(),
 113        BE = ExitingBlocks.end(); BI != BE; ++BI)
 114     if (!contains(*BI))
 115       return false;
 116
 117   return true;
 118 }
 119
 120 Loop *Region::outermostLoopInRegion(Loop *L) const {
 121   if (!contains(L))
 122     return 0;
 123
 124   while (L && contains(L->getParentLoop())) {
 125     L = L->getParentLoop();
 126   }
 127
 128   return L;
 129 }
 130
 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);
 135 }
 136
 137 bool Region::isSimple() const {
 138   bool isSimple = true;
 139   bool found = false;
 140
 141   BasicBlock *entry = getEntry(), *exit = getExit();
 142
 143   // TopLevelRegion
 144   if (!exit)
 145     return false;
 146
 147   for (pred_iterator PI = pred_begin(entry), PE = pred_end(entry); PI != PE;
 148        ++PI) {
 149     BasicBlock *Pred = *PI;
 150     if (DT->getNode(Pred) && !contains(Pred)) {
 151       if (found) {
 152         isSimple = false;
 153         break;
 154       }
 155       found = true;
 156     }
 157   }
 158
 159   found = false;
 160
 161   for (pred_iterator PI = pred_begin(exit), PE = pred_end(exit); PI != PE;
 162        ++PI)
 163     if (contains(*PI)) {
 164       if (found) {
 165         isSimple = false;
 166         break;
 167       }
 168       found = true;
 169     }
 170
 171   return isSimple;
 172 }
 173
 174 std::string Region::getNameStr() const {
 175   std::string exitName;
 176   std::string entryName;
 177
 178   if (getEntry()->getName().empty()) {
 179     raw_string_ostream OS(entryName);
 180
 181     WriteAsOperand(OS, getEntry(), false);
 182     entryName = OS.str();
 183   } else
 184     entryName = getEntry()->getNameStr();
 185
 186   if (getExit()) {
 187     if (getExit()->getName().empty()) {
 188       raw_string_ostream OS(exitName);
 189
 190       WriteAsOperand(OS, getExit(), false);
 191       exitName = OS.str();
 192     } else
 193       exitName = getExit()->getNameStr();
 194   } else
 195     exitName = "<Function Return>";
 196
 197   return entryName + " => " + exitName;
 198 }
 199
 200 void Region::verifyBBInRegion(BasicBlock *BB) const {
 201   if (!contains(BB))
 202     llvm_unreachable("Broken region found!");
 203
 204   BasicBlock *entry = getEntry(), *exit = getExit();
 205
 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!");
 209
 210   if (entry != BB)
 211     for (pred_iterator SI = pred_begin(BB), SE = pred_end(BB); SI != SE; ++SI)
 212       if (!contains(*SI))
 213         llvm_unreachable("Broken region found!");
 214 }
 215
 216 void Region::verifyWalk(BasicBlock *BB, std::set<BasicBlock*> *visited) const {
 217   BasicBlock *exit = getExit();
 218
 219   visited->insert(BB);
 220
 221   verifyBBInRegion(BB);
 222
 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);
 226 }
 227
 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;
 232
 233   std::set<BasicBlock*> visited;
 234   verifyWalk(getEntry(), &visited);
 235 }
 236
 237 void Region::verifyRegionNest() const {
 238   for (Region::const_iterator RI = begin(), RE = end(); RI != RE; ++RI)
 239     (*RI)->verifyRegionNest();
 240
 241   verifyRegion();
 242 }
 243
 244 Region::block_iterator Region::block_begin() {
 245   return GraphTraits<FlatIt<Region*> >::nodes_begin(this);
 246 }
 247
 248 Region::block_iterator Region::block_end() {
 249   return GraphTraits<FlatIt<Region*> >::nodes_end(this);
 250 }
 251
 252 Region::const_block_iterator Region::block_begin() const {
 253   return GraphTraits<FlatIt<const Region*> >::nodes_begin(this);
 254 }
 255
 256 Region::const_block_iterator Region::block_end() const {
 257   return GraphTraits<FlatIt<const Region*> >::nodes_end(this);
 258 }
 259
 260 Region::element_iterator Region::element_begin() {
 261   return GraphTraits<Region*>::nodes_begin(this);
 262 }
 263
 264 Region::element_iterator Region::element_end() {
 265   return GraphTraits<Region*>::nodes_end(this);
 266 }
 267
 268 Region::const_element_iterator Region::element_begin() const {
 269   return GraphTraits<const Region*>::nodes_begin(this);
 270 }
 271
 272 Region::const_element_iterator Region::element_end() const {
 273   return GraphTraits<const Region*>::nodes_end(this);
 274 }
 275
 276 Region* Region::getSubRegionNode(BasicBlock *BB) const {
 277   Region *R = RI->getRegionFor(BB);
 278
 279   if (!R || R == this)
 280     return 0;
 281
 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!");
 284
 285   while (contains(R->getParent()) && R->getParent() != this)
 286     R = R->getParent();
 287
 288   if (R->getEntry() != BB)
 289     return 0;
 290
 291   return R;
 292 }
 293
 294 RegionNode* Region::getBBNode(BasicBlock *BB) const {
 295   assert(contains(BB) && "Can get BB node out of this region!");
 296
 297   BBNodeMapT::const_iterator at = BBNodeMap.find(BB);
 298
 299   if (at != BBNodeMap.end())
 300     return at->second;
 301
 302   RegionNode *NewNode = new RegionNode(const_cast<Region*>(this), BB);
 303   BBNodeMap.insert(std::make_pair(BB, NewNode));
 304   return NewNode;
 305 }
 306
 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();
 311
 312   return getBBNode(BB);
 313 }
 314
 315 void Region::transferChildrenTo(Region *To) {
 316   for (iterator I = begin(), E = end(); I != E; ++I) {
 317     (*I)->parent = To;
 318     To->children.push_back(*I);
 319   }
 320   children.clear();
 321 }
 322
 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!");
 327
 328   SubRegion->parent = this;
 329   children.push_back(SubRegion);
 330
 331   if (!moveChildren)
 332     return;
 333
 334   assert(SubRegion->children.size() == 0
 335          && "SubRegions that contain children are not supported");
 336
 337   for (element_iterator I = element_begin(), E = element_end(); I != E; ++I)
 338     if (!(*I)->isSubRegion()) {
 339       BasicBlock *BB = (*I)->getNodeAs<BasicBlock>();
 340
 341       if (SubRegion->contains(BB))
 342         RI->setRegionFor(BB, SubRegion);
 343     }
 344
 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;
 350     } else
 351       Keep.push_back(*I);
 352
 353   children.clear();
 354   children.insert(children.begin(), Keep.begin(), Keep.end());
 355 }
 356
 357
 358 Region *Region::removeSubRegion(Region *Child) {
 359   assert(Child->parent == this && "Child is not a child of this region!");
 360   Child->parent = 0;
 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()));
 364   return Child;
 365 }
 366
 367 unsigned Region::getDepth() const {
 368   unsigned Depth = 0;
 369
 370   for (Region *R = parent; R != 0; R = R->parent)
 371     ++Depth;
 372
 373   return Depth;
 374 }
 375
 376 void Region::print(raw_ostream &OS, bool print_tree, unsigned level) const {
 377   if (print_tree)
 378     OS.indent(level*2) << "[" << level << "] " << getNameStr();
 379   else
 380     OS.indent(level*2) << getNameStr();
 381
 382   OS << "\n";
 383
 384
 385   if (printStyle != PrintNone) {
 386     OS.indent(level*2) << "{\n";
 387     OS.indent(level*2 + 2);
 388
 389     if (printStyle == PrintBB) {
 390       for (const_block_iterator I = block_begin(), E = block_end(); I!=E; ++I)
 391         OS << **I << ", "; // TODO: remove the last ","
 392     } else if (printStyle == PrintRN) {
 393       for (const_element_iterator I = element_begin(), E = element_end(); I!=E; ++I)
 394         OS << **I << ", "; // TODO: remove the last ",
 395     }
 396
 397     OS << "\n";
 398   }
 399
 400   if (print_tree)
 401     for (const_iterator RI = begin(), RE = end(); RI != RE; ++RI)
 402       (*RI)->print(OS, print_tree, level+1);
 403
 404   if (printStyle != PrintNone)
 405     OS.indent(level*2) << "} \n";
 406 }
 407
 408 void Region::dump() const {
 409   print(dbgs(), true, getDepth());
 410 }
 411
 412 void Region::clearNodeCache() {
 413   // Free the cached nodes.
 414   for (BBNodeMapT::iterator I = BBNodeMap.begin(),
 415        IE = BBNodeMap.end(); I != IE; ++IE)
 416     delete I->second;
 417
 418   BBNodeMap.clear();
 419   for (Region::iterator RI = begin(), RE = end(); RI != RE; ++RI)
 420     (*RI)->clearNodeCache();
 421 }
 422
 423 //===----------------------------------------------------------------------===//
 424 // RegionInfo implementation
 425 //
 426
 427 bool RegionInfo::isCommonDomFrontier(BasicBlock *BB, BasicBlock *entry,
 428                                      BasicBlock *exit) const {
 429   for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE; ++PI) {
 430     BasicBlock *P = *PI;
 431     if (DT->dominates(entry, P) && !DT->dominates(exit, P))
 432       return false;
 433   }
 434   return true;
 435 }
 436
 437 bool RegionInfo::isRegion(BasicBlock *entry, BasicBlock *exit) const {
 438   assert(entry && exit && "entry and exit must not be null!");
 439   typedef DominanceFrontier::DomSetType DST;
 440
 441   DST *entrySuccs = &DF->find(entry)->second;
 442
 443   // Exit is the header of a loop that contains the entry. In this case,
 444   // the dominance frontier must only contain the exit.
 445   if (!DT->dominates(entry, exit)) {
 446     for (DST::iterator SI = entrySuccs->begin(), SE = entrySuccs->end();
 447          SI != SE; ++SI)
 448       if (*SI != exit && *SI != entry)
 449         return false;
 450
 451     return true;
 452   }
 453
 454   DST *exitSuccs = &DF->find(exit)->second;
 455
 456   // Do not allow edges leaving the region.
 457   for (DST::iterator SI = entrySuccs->begin(), SE = entrySuccs->end();
 458        SI != SE; ++SI) {
 459     if (*SI == exit || *SI == entry)
 460       continue;
 461     if (exitSuccs->find(*SI) == exitSuccs->end())
 462       return false;
 463     if (!isCommonDomFrontier(*SI, entry, exit))
 464       return false;
 465   }
 466
 467   // Do not allow edges pointing into the region.
 468   for (DST::iterator SI = exitSuccs->begin(), SE = exitSuccs->end();
 469        SI != SE; ++SI)
 470     if (DT->properlyDominates(entry, *SI) && *SI != exit)
 471       return false;
 472
 473
 474   return true;
 475 }
 476
 477 void RegionInfo::insertShortCut(BasicBlock *entry, BasicBlock *exit,
 478                              BBtoBBMap *ShortCut) const {
 479   assert(entry && exit && "entry and exit must not be null!");
 480
 481   BBtoBBMap::iterator e = ShortCut->find(exit);
 482
 483   if (e == ShortCut->end())
 484     // No further region at exit available.
 485     (*ShortCut)[entry] = exit;
 486   else {
 487     // We found a region e that starts at exit. Therefore (entry, e->second)
 488     // is also a region, that is larger than (entry, exit). Insert the
 489     // larger one.
 490     BasicBlock *BB = e->second;
 491     (*ShortCut)[entry] = BB;
 492   }
 493 }
 494
 495 DomTreeNode* RegionInfo::getNextPostDom(DomTreeNode* N,
 496                                         BBtoBBMap *ShortCut) const {
 497   BBtoBBMap::iterator e = ShortCut->find(N->getBlock());
 498
 499   if (e == ShortCut->end())
 500     return N->getIDom();
 501
 502   return PDT->getNode(e->second)->getIDom();
 503 }
 504
 505 bool RegionInfo::isTrivialRegion(BasicBlock *entry, BasicBlock *exit) const {
 506   assert(entry && exit && "entry and exit must not be null!");
 507
 508   unsigned num_successors = succ_end(entry) - succ_begin(entry);
 509
 510   if (num_successors <= 1 && exit == *(succ_begin(entry)))
 511     return true;
 512
 513   return false;
 514 }
 515
 516 void RegionInfo::updateStatistics(Region *R) {
 517   ++numRegions;
 518
 519   // TODO: Slow. Should only be enabled if -stats is used.
 520   if (R->isSimple()) ++numSimpleRegions;
 521 }
 522
 523 Region *RegionInfo::createRegion(BasicBlock *entry, BasicBlock *exit) {
 524   assert(entry && exit && "entry and exit must not be null!");
 525
 526   if (isTrivialRegion(entry, exit))
 527     return 0;
 528
 529   Region *region = new Region(entry, exit, this, DT);
 530   BBtoRegion.insert(std::make_pair(entry, region));
 531
 532  #ifdef XDEBUG
 533     region->verifyRegion();
 534  #else
 535     DEBUG(region->verifyRegion());
 536  #endif
 537
 538   updateStatistics(region);
 539   return region;
 540 }
 541
 542 void RegionInfo::findRegionsWithEntry(BasicBlock *entry, BBtoBBMap *ShortCut) {
 543   assert(entry);
 544
 545   DomTreeNode *N = PDT->getNode(entry);
 546
 547   if (!N)
 548     return;
 549
 550   Region *lastRegion= 0;
 551   BasicBlock *lastExit = entry;
 552
 553   // As only a BasicBlock that postdominates entry can finish a region, walk the
 554   // post dominance tree upwards.
 555   while ((N = getNextPostDom(N, ShortCut))) {
 556     BasicBlock *exit = N->getBlock();
 557
 558     if (!exit)
 559       break;
 560
 561     if (isRegion(entry, exit)) {
 562       Region *newRegion = createRegion(entry, exit);
 563
 564       if (lastRegion)
 565         newRegion->addSubRegion(lastRegion);
 566
 567       lastRegion = newRegion;
 568       lastExit = exit;
 569     }
 570
 571     // This can never be a region, so stop the search.
 572     if (!DT->dominates(entry, exit))
 573       break;
 574   }
 575
 576   // Tried to create regions from entry to lastExit.  Next time take a
 577   // shortcut from entry to lastExit.
 578   if (lastExit != entry)
 579     insertShortCut(entry, lastExit, ShortCut);
 580 }
 581
 582 void RegionInfo::scanForRegions(Function &F, BBtoBBMap *ShortCut) {
 583   BasicBlock *entry = &(F.getEntryBlock());
 584   DomTreeNode *N = DT->getNode(entry);
 585
 586   // Iterate over the dominance tree in post order to start with the small
 587   // regions from the bottom of the dominance tree.  If the small regions are
 588   // detected first, detection of bigger regions is faster, as we can jump
 589   // over the small regions.
 590   for (po_iterator<DomTreeNode*> FI = po_begin(N), FE = po_end(N); FI != FE;
 591     ++FI) {
 592     findRegionsWithEntry(FI->getBlock(), ShortCut);
 593   }
 594 }
 595
 596 Region *RegionInfo::getTopMostParent(Region *region) {
 597   while (region->parent)
 598     region = region->getParent();
 599
 600   return region;
 601 }
 602
 603 void RegionInfo::buildRegionsTree(DomTreeNode *N, Region *region) {
 604   BasicBlock *BB = N->getBlock();
 605
 606   // Passed region exit
 607   while (BB == region->getExit())
 608     region = region->getParent();
 609
 610   BBtoRegionMap::iterator it = BBtoRegion.find(BB);
 611
 612   // This basic block is a start block of a region. It is already in the
 613   // BBtoRegion relation. Only the child basic blocks have to be updated.
 614   if (it != BBtoRegion.end()) {
 615     Region *newRegion = it->second;;
 616     region->addSubRegion(getTopMostParent(newRegion));
 617     region = newRegion;
 618   } else {
 619     BBtoRegion[BB] = region;
 620   }
 621
 622   for (DomTreeNode::iterator CI = N->begin(), CE = N->end(); CI != CE; ++CI)
 623     buildRegionsTree(*CI, region);
 624 }
 625
 626 void RegionInfo::releaseMemory() {
 627   BBtoRegion.clear();
 628   if (TopLevelRegion)
 629     delete TopLevelRegion;
 630   TopLevelRegion = 0;
 631 }
 632
 633 RegionInfo::RegionInfo() : FunctionPass(ID) {
 634   TopLevelRegion = 0;
 635 }
 636
 637 RegionInfo::~RegionInfo() {
 638   releaseMemory();
 639 }
 640
 641 void RegionInfo::Calculate(Function &F) {
 642   // ShortCut a function where for every BB the exit of the largest region
 643   // starting with BB is stored. These regions can be threated as single BBS.
 644   // This improves performance on linear CFGs.
 645   BBtoBBMap ShortCut;
 646
 647   scanForRegions(F, &ShortCut);
 648   BasicBlock *BB = &F.getEntryBlock();
 649   buildRegionsTree(DT->getNode(BB), TopLevelRegion);
 650 }
 651
 652 bool RegionInfo::runOnFunction(Function &F) {
 653   releaseMemory();
 654
 655   DT = &getAnalysis<DominatorTree>();
 656   PDT = &getAnalysis<PostDominatorTree>();
 657   DF = &getAnalysis<DominanceFrontier>();
 658
 659   TopLevelRegion = new Region(&F.getEntryBlock(), 0, this, DT, 0);
 660   updateStatistics(TopLevelRegion);
 661
 662   Calculate(F);
 663
 664   return false;
 665 }
 666
 667 void RegionInfo::getAnalysisUsage(AnalysisUsage &AU) const {
 668   AU.setPreservesAll();
 669   AU.addRequiredTransitive<DominatorTree>();
 670   AU.addRequired<PostDominatorTree>();
 671   AU.addRequired<DominanceFrontier>();
 672 }
 673
 674 void RegionInfo::print(raw_ostream &OS, const Module *) const {
 675   OS << "Region tree:\n";
 676   TopLevelRegion->print(OS, true, 0);
 677   OS << "End region tree\n";
 678 }
 679
 680 void RegionInfo::verifyAnalysis() const {
 681   // Only do verification when user wants to, otherwise this expensive check
 682   // will be invoked by PMDataManager::verifyPreservedAnalysis when
 683   // a regionpass (marked PreservedAll) finish.
 684   if (!VerifyRegionInfo) return;
 685
 686   TopLevelRegion->verifyRegionNest();
 687 }
 688
 689 // Region pass manager support.
 690 Region *RegionInfo::getRegionFor(BasicBlock *BB) const {
 691   BBtoRegionMap::const_iterator I=
 692     BBtoRegion.find(BB);
 693   return I != BBtoRegion.end() ? I->second : 0;
 694 }
 695
 696 void RegionInfo::setRegionFor(BasicBlock *BB, Region *R) {
 697   BBtoRegion[BB] = R;
 698 }
 699
 700 Region *RegionInfo::operator[](BasicBlock *BB) const {
 701   return getRegionFor(BB);
 702 }
 703
 704 BasicBlock *RegionInfo::getMaxRegionExit(BasicBlock *BB) const {
 705   BasicBlock *Exit = NULL;
 706
 707   while (true) {
 708     // Get largest region that starts at BB.
 709     Region *R = getRegionFor(BB);
 710     while (R && R->getParent() && R->getParent()->getEntry() == BB)
 711       R = R->getParent();
 712
 713     // Get the single exit of BB.
 714     if (R && R->getEntry() == BB)
 715       Exit = R->getExit();
 716     else if (++succ_begin(BB) == succ_end(BB))
 717       Exit = *succ_begin(BB);
 718     else // No single exit exists.
 719       return Exit;
 720
 721     // Get largest region that starts at Exit.
 722     Region *ExitR = getRegionFor(Exit);
 723     while (ExitR && ExitR->getParent()
 724            && ExitR->getParent()->getEntry() == Exit)
 725       ExitR = ExitR->getParent();
 726
 727     for (pred_iterator PI = pred_begin(Exit), PE = pred_end(Exit); PI != PE;
 728          ++PI)
 729       if (!R->contains(*PI) && !ExitR->contains(*PI))
 730         break;
 731
 732     // This stops infinite cycles.
 733     if (DT->dominates(Exit, BB))
 734       break;
 735
 736     BB = Exit;
 737   }
 738
 739   return Exit;
 740 }
 741
 742 Region*
 743 RegionInfo::getCommonRegion(Region *A, Region *B) const {
 744   assert (A && B && "One of the Regions is NULL");
 745
 746   if (A->contains(B)) return A;
 747
 748   while (!B->contains(A))
 749     B = B->getParent();
 750
 751   return B;
 752 }
 753
 754 Region*
 755 RegionInfo::getCommonRegion(SmallVectorImpl<Region*> &Regions) const {
 756   Region* ret = Regions.back();
 757   Regions.pop_back();
 758
 759   for (SmallVectorImpl<Region*>::const_iterator I = Regions.begin(),
 760        E = Regions.end(); I != E; ++I)
 761       ret = getCommonRegion(ret, *I);
 762
 763   return ret;
 764 }
 765
 766 Region*
 767 RegionInfo::getCommonRegion(SmallVectorImpl<BasicBlock*> &BBs) const {
 768   Region* ret = getRegionFor(BBs.back());
 769   BBs.pop_back();
 770
 771   for (SmallVectorImpl<BasicBlock*>::const_iterator I = BBs.begin(),
 772        E = BBs.end(); I != E; ++I)
 773       ret = getCommonRegion(ret, getRegionFor(*I));
 774
 775   return ret;
 776 }
 777
 778 char RegionInfo::ID = 0;
 779 INITIALIZE_PASS_BEGIN(RegionInfo, "regions",
 780                 "Detect single entry single exit regions", true, true)
 781 INITIALIZE_PASS_DEPENDENCY(DominatorTree)
 782 INITIALIZE_PASS_DEPENDENCY(PostDominatorTree)
 783 INITIALIZE_PASS_DEPENDENCY(DominanceFrontier)
 784 INITIALIZE_PASS_END(RegionInfo, "regions",
 785                 "Detect single entry single exit regions", true, true)
 786
 787 // Create methods available outside of this file, to use them
 788 // "include/llvm/LinkAllPasses.h". Otherwise the pass would be deleted by
 789 // the link time optimization.
 790
 791 namespace llvm {
 792   FunctionPass *createRegionInfoPass() {
 793     return new RegionInfo();
 794   }
 795 }
 796