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