lib/Transforms/Scalar/StructurizeCFG.cpp

   1 //===-- StructurizeCFG.cpp ------------------------------------------------===//
   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
  10 #define DEBUG_TYPE "structurizecfg"
  11 #include "llvm/Transforms/Scalar.h"
  12 #include "llvm/ADT/MapVector.h"
  13 #include "llvm/ADT/SCCIterator.h"
  14 #include "llvm/Analysis/RegionInfo.h"
  15 #include "llvm/Analysis/RegionIterator.h"
  16 #include "llvm/Analysis/RegionPass.h"
  17 #include "llvm/IR/Module.h"
  18 #include "llvm/Support/PatternMatch.h"
  19 #include "llvm/Transforms/Utils/SSAUpdater.h"
  20
  21 using namespace llvm;
  22 using namespace llvm::PatternMatch;
  23
  24 namespace {
  25
  26 // Definition of the complex types used in this pass.
  27
  28 typedef std::pair<BasicBlock *, Value *> BBValuePair;
  29
  30 typedef SmallVector<RegionNode*, 8> RNVector;
  31 typedef SmallVector<BasicBlock*, 8> BBVector;
  32 typedef SmallVector<BranchInst*, 8> BranchVector;
  33 typedef SmallVector<BBValuePair, 2> BBValueVector;
  34
  35 typedef SmallPtrSet<BasicBlock *, 8> BBSet;
  36
  37 typedef MapVector<PHINode *, BBValueVector> PhiMap;
  38 typedef MapVector<BasicBlock *, BBVector> BB2BBVecMap;
  39
  40 typedef DenseMap<DomTreeNode *, unsigned> DTN2UnsignedMap;
  41 typedef DenseMap<BasicBlock *, PhiMap> BBPhiMap;
  42 typedef DenseMap<BasicBlock *, Value *> BBPredicates;
  43 typedef DenseMap<BasicBlock *, BBPredicates> PredMap;
  44 typedef DenseMap<BasicBlock *, BasicBlock*> BB2BBMap;
  45
  46 // The name for newly created blocks.
  47
  48 static const char *const FlowBlockName = "Flow";
  49
  50 /// @brief Find the nearest common dominator for multiple BasicBlocks
  51 ///
  52 /// Helper class for StructurizeCFG
  53 /// TODO: Maybe move into common code
  54 class NearestCommonDominator {
  55   DominatorTree *DT;
  56
  57   DTN2UnsignedMap IndexMap;
  58
  59   BasicBlock *Result;
  60   unsigned ResultIndex;
  61   bool ExplicitMentioned;
  62
  63 public:
  64   /// \brief Start a new query
  65   NearestCommonDominator(DominatorTree *DomTree) {
  66     DT = DomTree;
  67     Result = 0;
  68   }
  69
  70   /// \brief Add BB to the resulting dominator
  71   void addBlock(BasicBlock *BB, bool Remember = true) {
  72     DomTreeNode *Node = DT->getNode(BB);
  73
  74     if (Result == 0) {
  75       unsigned Numbering = 0;
  76       for (;Node;Node = Node->getIDom())
  77         IndexMap[Node] = ++Numbering;
  78       Result = BB;
  79       ResultIndex = 1;
  80       ExplicitMentioned = Remember;
  81       return;
  82     }
  83
  84     for (;Node;Node = Node->getIDom())
  85       if (IndexMap.count(Node))
  86         break;
  87       else
  88         IndexMap[Node] = 0;
  89
  90     assert(Node && "Dominator tree invalid!");
  91
  92     unsigned Numbering = IndexMap[Node];
  93     if (Numbering > ResultIndex) {
  94       Result = Node->getBlock();
  95       ResultIndex = Numbering;
  96       ExplicitMentioned = Remember && (Result == BB);
  97     } else if (Numbering == ResultIndex) {
  98       ExplicitMentioned |= Remember;
  99     }
 100   }
 101
 102   /// \brief Is "Result" one of the BBs added with "Remember" = True?
 103   bool wasResultExplicitMentioned() {
 104     return ExplicitMentioned;
 105   }
 106
 107   /// \brief Get the query result
 108   BasicBlock *getResult() {
 109     return Result;
 110   }
 111 };
 112
 113 /// @brief Transforms the control flow graph on one single entry/exit region
 114 /// at a time.
 115 ///
 116 /// After the transform all "If"/"Then"/"Else" style control flow looks like
 117 /// this:
 118 ///
 119 /// \verbatim
 120 /// 1
 121 /// ||
 122 /// | |
 123 /// 2 |
 124 /// | /
 125 /// |/
 126 /// 3
 127 /// ||   Where:
 128 /// | |  1 = "If" block, calculates the condition
 129 /// 4 |  2 = "Then" subregion, runs if the condition is true
 130 /// | /  3 = "Flow" blocks, newly inserted flow blocks, rejoins the flow
 131 /// |/   4 = "Else" optional subregion, runs if the condition is false
 132 /// 5    5 = "End" block, also rejoins the control flow
 133 /// \endverbatim
 134 ///
 135 /// Control flow is expressed as a branch where the true exit goes into the
 136 /// "Then"/"Else" region, while the false exit skips the region
 137 /// The condition for the optional "Else" region is expressed as a PHI node.
 138 /// The incomming values of the PHI node are true for the "If" edge and false
 139 /// for the "Then" edge.
 140 ///
 141 /// Additionally to that even complicated loops look like this:
 142 ///
 143 /// \verbatim
 144 /// 1
 145 /// ||
 146 /// | |
 147 /// 2 ^  Where:
 148 /// | /  1 = "Entry" block
 149 /// |/   2 = "Loop" optional subregion, with all exits at "Flow" block
 150 /// 3    3 = "Flow" block, with back edge to entry block
 151 /// |
 152 /// \endverbatim
 153 ///
 154 /// The back edge of the "Flow" block is always on the false side of the branch
 155 /// while the true side continues the general flow. So the loop condition
 156 /// consist of a network of PHI nodes where the true incoming values expresses
 157 /// breaks and the false values expresses continue states.
 158 class StructurizeCFG : public RegionPass {
 159   Type *Boolean;
 160   ConstantInt *BoolTrue;
 161   ConstantInt *BoolFalse;
 162   UndefValue *BoolUndef;
 163
 164   Function *Func;
 165   Region *ParentRegion;
 166
 167   DominatorTree *DT;
 168
 169   RNVector Order;
 170   BBSet Visited;
 171
 172   BBPhiMap DeletedPhis;
 173   BB2BBVecMap AddedPhis;
 174
 175   PredMap Predicates;
 176   BranchVector Conditions;
 177
 178   BB2BBMap Loops;
 179   PredMap LoopPreds;
 180   BranchVector LoopConds;
 181
 182   RegionNode *PrevNode;
 183
 184   void orderNodes();
 185
 186   void analyzeLoops(RegionNode *N);
 187
 188   Value *invert(Value *Condition);
 189
 190   Value *buildCondition(BranchInst *Term, unsigned Idx, bool Invert);
 191
 192   void gatherPredicates(RegionNode *N);
 193
 194   void collectInfos();
 195
 196   void insertConditions(bool Loops);
 197
 198   void delPhiValues(BasicBlock *From, BasicBlock *To);
 199
 200   void addPhiValues(BasicBlock *From, BasicBlock *To);
 201
 202   void setPhiValues();
 203
 204   void killTerminator(BasicBlock *BB);
 205
 206   void changeExit(RegionNode *Node, BasicBlock *NewExit,
 207                   bool IncludeDominator);
 208
 209   BasicBlock *getNextFlow(BasicBlock *Dominator);
 210
 211   BasicBlock *needPrefix(bool NeedEmpty);
 212
 213   BasicBlock *needPostfix(BasicBlock *Flow, bool ExitUseAllowed);
 214
 215   void setPrevNode(BasicBlock *BB);
 216
 217   bool dominatesPredicates(BasicBlock *BB, RegionNode *Node);
 218
 219   bool isPredictableTrue(RegionNode *Node);
 220
 221   void wireFlow(bool ExitUseAllowed, BasicBlock *LoopEnd);
 222
 223   void handleLoops(bool ExitUseAllowed, BasicBlock *LoopEnd);
 224
 225   void createFlow();
 226
 227   void rebuildSSA();
 228
 229 public:
 230   static char ID;
 231
 232   StructurizeCFG() :
 233     RegionPass(ID) {
 234     initializeStructurizeCFGPass(*PassRegistry::getPassRegistry());
 235   }
 236
 237   using Pass::doInitialization;
 238   virtual bool doInitialization(Region *R, RGPassManager &RGM);
 239
 240   virtual bool runOnRegion(Region *R, RGPassManager &RGM);
 241
 242   virtual const char *getPassName() const {
 243     return "Structurize control flow";
 244   }
 245
 246   void getAnalysisUsage(AnalysisUsage &AU) const {
 247     AU.addRequiredID(LowerSwitchID);
 248     AU.addRequired<DominatorTree>();
 249     AU.addPreserved<DominatorTree>();
 250     RegionPass::getAnalysisUsage(AU);
 251   }
 252 };
 253
 254 } // end anonymous namespace
 255
 256 char StructurizeCFG::ID = 0;
 257
 258 INITIALIZE_PASS_BEGIN(StructurizeCFG, "structurizecfg", "Structurize the CFG",
 259                       false, false)
 260 INITIALIZE_PASS_DEPENDENCY(LowerSwitch)
 261 INITIALIZE_PASS_DEPENDENCY(DominatorTree)
 262 INITIALIZE_PASS_DEPENDENCY(RegionInfo)
 263 INITIALIZE_PASS_END(StructurizeCFG, "structurizecfg", "Structurize the CFG",
 264                     false, false)
 265
 266 /// \brief Initialize the types and constants used in the pass
 267 bool StructurizeCFG::doInitialization(Region *R, RGPassManager &RGM) {
 268   LLVMContext &Context = R->getEntry()->getContext();
 269
 270   Boolean = Type::getInt1Ty(Context);
 271   BoolTrue = ConstantInt::getTrue(Context);
 272   BoolFalse = ConstantInt::getFalse(Context);
 273   BoolUndef = UndefValue::get(Boolean);
 274
 275   return false;
 276 }
 277
 278 /// \brief Build up the general order of nodes
 279 void StructurizeCFG::orderNodes() {
 280   scc_iterator<Region *> I = scc_begin(ParentRegion),
 281                          E = scc_end(ParentRegion);
 282   for (Order.clear(); I != E; ++I) {
 283     std::vector<RegionNode *> &Nodes = *I;
 284     Order.append(Nodes.begin(), Nodes.end());
 285   }
 286 }
 287
 288 /// \brief Determine the end of the loops
 289 void StructurizeCFG::analyzeLoops(RegionNode *N) {
 290   if (N->isSubRegion()) {
 291     // Test for exit as back edge
 292     BasicBlock *Exit = N->getNodeAs<Region>()->getExit();
 293     if (Visited.count(Exit))
 294       Loops[Exit] = N->getEntry();
 295
 296   } else {
 297     // Test for sucessors as back edge
 298     BasicBlock *BB = N->getNodeAs<BasicBlock>();
 299     BranchInst *Term = cast<BranchInst>(BB->getTerminator());
 300
 301     for (unsigned i = 0, e = Term->getNumSuccessors(); i != e; ++i) {
 302       BasicBlock *Succ = Term->getSuccessor(i);
 303
 304       if (Visited.count(Succ))
 305         Loops[Succ] = BB;
 306     }
 307   }
 308 }
 309
 310 /// \brief Invert the given condition
 311 Value *StructurizeCFG::invert(Value *Condition) {
 312   // First: Check if it's a constant
 313   if (Condition == BoolTrue)
 314     return BoolFalse;
 315
 316   if (Condition == BoolFalse)
 317     return BoolTrue;
 318
 319   if (Condition == BoolUndef)
 320     return BoolUndef;
 321
 322   // Second: If the condition is already inverted, return the original value
 323   if (match(Condition, m_Not(m_Value(Condition))))
 324     return Condition;
 325
 326   // Third: Check all the users for an invert
 327   BasicBlock *Parent = cast<Instruction>(Condition)->getParent();
 328   for (Value::use_iterator I = Condition->use_begin(),
 329        E = Condition->use_end(); I != E; ++I) {
 330
 331     Instruction *User = dyn_cast<Instruction>(*I);
 332     if (!User || User->getParent() != Parent)
 333       continue;
 334
 335     if (match(*I, m_Not(m_Specific(Condition))))
 336       return *I;
 337   }
 338
 339   // Last option: Create a new instruction
 340   return BinaryOperator::CreateNot(Condition, "", Parent->getTerminator());
 341 }
 342
 343 /// \brief Build the condition for one edge
 344 Value *StructurizeCFG::buildCondition(BranchInst *Term, unsigned Idx,
 345                                       bool Invert) {
 346   Value *Cond = Invert ? BoolFalse : BoolTrue;
 347   if (Term->isConditional()) {
 348     Cond = Term->getCondition();
 349
 350     if (Idx != (unsigned)Invert)
 351       Cond = invert(Cond);
 352   }
 353   return Cond;
 354 }
 355
 356 /// \brief Analyze the predecessors of each block and build up predicates
 357 void StructurizeCFG::gatherPredicates(RegionNode *N) {
 358   RegionInfo *RI = ParentRegion->getRegionInfo();
 359   BasicBlock *BB = N->getEntry();
 360   BBPredicates &Pred = Predicates[BB];
 361   BBPredicates &LPred = LoopPreds[BB];
 362
 363   for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
 364        PI != PE; ++PI) {
 365
 366     // Ignore it if it's a branch from outside into our region entry
 367     if (!ParentRegion->contains(*PI))
 368       continue;
 369
 370     Region *R = RI->getRegionFor(*PI);
 371     if (R == ParentRegion) {
 372
 373       // It's a top level block in our region
 374       BranchInst *Term = cast<BranchInst>((*PI)->getTerminator());
 375       for (unsigned i = 0, e = Term->getNumSuccessors(); i != e; ++i) {
 376         BasicBlock *Succ = Term->getSuccessor(i);
 377         if (Succ != BB)
 378           continue;
 379
 380         if (Visited.count(*PI)) {
 381           // Normal forward edge
 382           if (Term->isConditional()) {
 383             // Try to treat it like an ELSE block
 384             BasicBlock *Other = Term->getSuccessor(!i);
 385             if (Visited.count(Other) && !Loops.count(Other) &&
 386                 !Pred.count(Other) && !Pred.count(*PI)) {
 387
 388               Pred[Other] = BoolFalse;
 389               Pred[*PI] = BoolTrue;
 390               continue;
 391             }
 392           }
 393           Pred[*PI] = buildCondition(Term, i, false);
 394
 395         } else {
 396           // Back edge
 397           LPred[*PI] = buildCondition(Term, i, true);
 398         }
 399       }
 400
 401     } else {
 402
 403       // It's an exit from a sub region
 404       while(R->getParent() != ParentRegion)
 405         R = R->getParent();
 406
 407       // Edge from inside a subregion to its entry, ignore it
 408       if (R == N)
 409         continue;
 410
 411       BasicBlock *Entry = R->getEntry();
 412       if (Visited.count(Entry))
 413         Pred[Entry] = BoolTrue;
 414       else
 415         LPred[Entry] = BoolFalse;
 416     }
 417   }
 418 }
 419
 420 /// \brief Collect various loop and predicate infos
 421 void StructurizeCFG::collectInfos() {
 422   // Reset predicate
 423   Predicates.clear();
 424
 425   // and loop infos
 426   Loops.clear();
 427   LoopPreds.clear();
 428
 429   // Reset the visited nodes
 430   Visited.clear();
 431
 432   for (RNVector::reverse_iterator OI = Order.rbegin(), OE = Order.rend();
 433        OI != OE; ++OI) {
 434
 435     // Analyze all the conditions leading to a node
 436     gatherPredicates(*OI);
 437
 438     // Remember that we've seen this node
 439     Visited.insert((*OI)->getEntry());
 440
 441     // Find the last back edges
 442     analyzeLoops(*OI);
 443   }
 444 }
 445
 446 /// \brief Insert the missing branch conditions
 447 void StructurizeCFG::insertConditions(bool Loops) {
 448   BranchVector &Conds = Loops ? LoopConds : Conditions;
 449   Value *Default = Loops ? BoolTrue : BoolFalse;
 450   SSAUpdater PhiInserter;
 451
 452   for (BranchVector::iterator I = Conds.begin(),
 453        E = Conds.end(); I != E; ++I) {
 454
 455     BranchInst *Term = *I;
 456     assert(Term->isConditional());
 457
 458     BasicBlock *Parent = Term->getParent();
 459     BasicBlock *SuccTrue = Term->getSuccessor(0);
 460     BasicBlock *SuccFalse = Term->getSuccessor(1);
 461
 462     PhiInserter.Initialize(Boolean, "");
 463     PhiInserter.AddAvailableValue(&Func->getEntryBlock(), Default);
 464     PhiInserter.AddAvailableValue(Loops ? SuccFalse : Parent, Default);
 465
 466     BBPredicates &Preds = Loops ? LoopPreds[SuccFalse] : Predicates[SuccTrue];
 467
 468     NearestCommonDominator Dominator(DT);
 469     Dominator.addBlock(Parent, false);
 470
 471     Value *ParentValue = 0;
 472     for (BBPredicates::iterator PI = Preds.begin(), PE = Preds.end();
 473          PI != PE; ++PI) {
 474
 475       if (PI->first == Parent) {
 476         ParentValue = PI->second;
 477         break;
 478       }
 479       PhiInserter.AddAvailableValue(PI->first, PI->second);
 480       Dominator.addBlock(PI->first);
 481     }
 482
 483     if (ParentValue) {
 484       Term->setCondition(ParentValue);
 485     } else {
 486       if (!Dominator.wasResultExplicitMentioned())
 487         PhiInserter.AddAvailableValue(Dominator.getResult(), Default);
 488
 489       Term->setCondition(PhiInserter.GetValueInMiddleOfBlock(Parent));
 490     }
 491   }
 492 }
 493
 494 /// \brief Remove all PHI values coming from "From" into "To" and remember
 495 /// them in DeletedPhis
 496 void StructurizeCFG::delPhiValues(BasicBlock *From, BasicBlock *To) {
 497   PhiMap &Map = DeletedPhis[To];
 498   for (BasicBlock::iterator I = To->begin(), E = To->end();
 499        I != E && isa<PHINode>(*I);) {
 500
 501     PHINode &Phi = cast<PHINode>(*I++);
 502     while (Phi.getBasicBlockIndex(From) != -1) {
 503       Value *Deleted = Phi.removeIncomingValue(From, false);
 504       Map[&Phi].push_back(std::make_pair(From, Deleted));
 505     }
 506   }
 507 }
 508
 509 /// \brief Add a dummy PHI value as soon as we knew the new predecessor
 510 void StructurizeCFG::addPhiValues(BasicBlock *From, BasicBlock *To) {
 511   for (BasicBlock::iterator I = To->begin(), E = To->end();
 512        I != E && isa<PHINode>(*I);) {
 513
 514     PHINode &Phi = cast<PHINode>(*I++);
 515     Value *Undef = UndefValue::get(Phi.getType());
 516     Phi.addIncoming(Undef, From);
 517   }
 518   AddedPhis[To].push_back(From);
 519 }
 520
 521 /// \brief Add the real PHI value as soon as everything is set up
 522 void StructurizeCFG::setPhiValues() {
 523   SSAUpdater Updater;
 524   for (BB2BBVecMap::iterator AI = AddedPhis.begin(), AE = AddedPhis.end();
 525        AI != AE; ++AI) {
 526
 527     BasicBlock *To = AI->first;
 528     BBVector &From = AI->second;
 529
 530     if (!DeletedPhis.count(To))
 531       continue;
 532
 533     PhiMap &Map = DeletedPhis[To];
 534     for (PhiMap::iterator PI = Map.begin(), PE = Map.end();
 535          PI != PE; ++PI) {
 536
 537       PHINode *Phi = PI->first;
 538       Value *Undef = UndefValue::get(Phi->getType());
 539       Updater.Initialize(Phi->getType(), "");
 540       Updater.AddAvailableValue(&Func->getEntryBlock(), Undef);
 541       Updater.AddAvailableValue(To, Undef);
 542
 543       NearestCommonDominator Dominator(DT);
 544       Dominator.addBlock(To, false);
 545       for (BBValueVector::iterator VI = PI->second.begin(),
 546            VE = PI->second.end(); VI != VE; ++VI) {
 547
 548         Updater.AddAvailableValue(VI->first, VI->second);
 549         Dominator.addBlock(VI->first);
 550       }
 551
 552       if (!Dominator.wasResultExplicitMentioned())
 553         Updater.AddAvailableValue(Dominator.getResult(), Undef);
 554
 555       for (BBVector::iterator FI = From.begin(), FE = From.end();
 556            FI != FE; ++FI) {
 557
 558         int Idx = Phi->getBasicBlockIndex(*FI);
 559         assert(Idx != -1);
 560         Phi->setIncomingValue(Idx, Updater.GetValueAtEndOfBlock(*FI));
 561       }
 562     }
 563
 564     DeletedPhis.erase(To);
 565   }
 566   assert(DeletedPhis.empty());
 567 }
 568
 569 /// \brief Remove phi values from all successors and then remove the terminator.
 570 void StructurizeCFG::killTerminator(BasicBlock *BB) {
 571   TerminatorInst *Term = BB->getTerminator();
 572   if (!Term)
 573     return;
 574
 575   for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB);
 576        SI != SE; ++SI) {
 577
 578     delPhiValues(BB, *SI);
 579   }
 580
 581   Term->eraseFromParent();
 582 }
 583
 584 /// \brief Let node exit(s) point to NewExit
 585 void StructurizeCFG::changeExit(RegionNode *Node, BasicBlock *NewExit,
 586                                 bool IncludeDominator) {
 587   if (Node->isSubRegion()) {
 588     Region *SubRegion = Node->getNodeAs<Region>();
 589     BasicBlock *OldExit = SubRegion->getExit();
 590     BasicBlock *Dominator = 0;
 591
 592     // Find all the edges from the sub region to the exit
 593     for (pred_iterator I = pred_begin(OldExit), E = pred_end(OldExit);
 594          I != E;) {
 595
 596       BasicBlock *BB = *I++;
 597       if (!SubRegion->contains(BB))
 598         continue;
 599
 600       // Modify the edges to point to the new exit
 601       delPhiValues(BB, OldExit);
 602       BB->getTerminator()->replaceUsesOfWith(OldExit, NewExit);
 603       addPhiValues(BB, NewExit);
 604
 605       // Find the new dominator (if requested)
 606       if (IncludeDominator) {
 607         if (!Dominator)
 608           Dominator = BB;
 609         else
 610           Dominator = DT->findNearestCommonDominator(Dominator, BB);
 611       }
 612     }
 613
 614     // Change the dominator (if requested)
 615     if (Dominator)
 616       DT->changeImmediateDominator(NewExit, Dominator);
 617
 618     // Update the region info
 619     SubRegion->replaceExit(NewExit);
 620
 621   } else {
 622     BasicBlock *BB = Node->getNodeAs<BasicBlock>();
 623     killTerminator(BB);
 624     BranchInst::Create(NewExit, BB);
 625     addPhiValues(BB, NewExit);
 626     if (IncludeDominator)
 627       DT->changeImmediateDominator(NewExit, BB);
 628   }
 629 }
 630
 631 /// \brief Create a new flow node and update dominator tree and region info
 632 BasicBlock *StructurizeCFG::getNextFlow(BasicBlock *Dominator) {
 633   LLVMContext &Context = Func->getContext();
 634   BasicBlock *Insert = Order.empty() ? ParentRegion->getExit() :
 635                        Order.back()->getEntry();
 636   BasicBlock *Flow = BasicBlock::Create(Context, FlowBlockName,
 637                                         Func, Insert);
 638   DT->addNewBlock(Flow, Dominator);
 639   ParentRegion->getRegionInfo()->setRegionFor(Flow, ParentRegion);
 640   return Flow;
 641 }
 642
 643 /// \brief Create a new or reuse the previous node as flow node
 644 BasicBlock *StructurizeCFG::needPrefix(bool NeedEmpty) {
 645   BasicBlock *Entry = PrevNode->getEntry();
 646
 647   if (!PrevNode->isSubRegion()) {
 648     killTerminator(Entry);
 649     if (!NeedEmpty || Entry->getFirstInsertionPt() == Entry->end())
 650       return Entry;
 651
 652   }
 653
 654   // create a new flow node
 655   BasicBlock *Flow = getNextFlow(Entry);
 656
 657   // and wire it up
 658   changeExit(PrevNode, Flow, true);
 659   PrevNode = ParentRegion->getBBNode(Flow);
 660   return Flow;
 661 }
 662
 663 /// \brief Returns the region exit if possible, otherwise just a new flow node
 664 BasicBlock *StructurizeCFG::needPostfix(BasicBlock *Flow,
 665                                         bool ExitUseAllowed) {
 666   if (Order.empty() && ExitUseAllowed) {
 667     BasicBlock *Exit = ParentRegion->getExit();
 668     DT->changeImmediateDominator(Exit, Flow);
 669     addPhiValues(Flow, Exit);
 670     return Exit;
 671   }
 672   return getNextFlow(Flow);
 673 }
 674
 675 /// \brief Set the previous node
 676 void StructurizeCFG::setPrevNode(BasicBlock *BB) {
 677   PrevNode =  ParentRegion->contains(BB) ? ParentRegion->getBBNode(BB) : 0;
 678 }
 679
 680 /// \brief Does BB dominate all the predicates of Node ?
 681 bool StructurizeCFG::dominatesPredicates(BasicBlock *BB, RegionNode *Node) {
 682   BBPredicates &Preds = Predicates[Node->getEntry()];
 683   for (BBPredicates::iterator PI = Preds.begin(), PE = Preds.end();
 684        PI != PE; ++PI) {
 685
 686     if (!DT->dominates(BB, PI->first))
 687       return false;
 688   }
 689   return true;
 690 }
 691
 692 /// \brief Can we predict that this node will always be called?
 693 bool StructurizeCFG::isPredictableTrue(RegionNode *Node) {
 694   BBPredicates &Preds = Predicates[Node->getEntry()];
 695   bool Dominated = false;
 696
 697   // Regionentry is always true
 698   if (PrevNode == 0)
 699     return true;
 700
 701   for (BBPredicates::iterator I = Preds.begin(), E = Preds.end();
 702        I != E; ++I) {
 703
 704     if (I->second != BoolTrue)
 705       return false;
 706
 707     if (!Dominated && DT->dominates(I->first, PrevNode->getEntry()))
 708       Dominated = true;
 709   }
 710
 711   // TODO: The dominator check is too strict
 712   return Dominated;
 713 }
 714
 715 /// Take one node from the order vector and wire it up
 716 void StructurizeCFG::wireFlow(bool ExitUseAllowed,
 717                               BasicBlock *LoopEnd) {
 718   RegionNode *Node = Order.pop_back_val();
 719   Visited.insert(Node->getEntry());
 720
 721   if (isPredictableTrue(Node)) {
 722     // Just a linear flow
 723     if (PrevNode) {
 724       changeExit(PrevNode, Node->getEntry(), true);
 725     }
 726     PrevNode = Node;
 727
 728   } else {
 729     // Insert extra prefix node (or reuse last one)
 730     BasicBlock *Flow = needPrefix(false);
 731
 732     // Insert extra postfix node (or use exit instead)
 733     BasicBlock *Entry = Node->getEntry();
 734     BasicBlock *Next = needPostfix(Flow, ExitUseAllowed);
 735
 736     // let it point to entry and next block
 737     Conditions.push_back(BranchInst::Create(Entry, Next, BoolUndef, Flow));
 738     addPhiValues(Flow, Entry);
 739     DT->changeImmediateDominator(Entry, Flow);
 740
 741     PrevNode = Node;
 742     while (!Order.empty() && !Visited.count(LoopEnd) &&
 743            dominatesPredicates(Entry, Order.back())) {
 744       handleLoops(false, LoopEnd);
 745     }
 746
 747     changeExit(PrevNode, Next, false);
 748     setPrevNode(Next);
 749   }
 750 }
 751
 752 void StructurizeCFG::handleLoops(bool ExitUseAllowed,
 753                                  BasicBlock *LoopEnd) {
 754   RegionNode *Node = Order.back();
 755   BasicBlock *LoopStart = Node->getEntry();
 756
 757   if (!Loops.count(LoopStart)) {
 758     wireFlow(ExitUseAllowed, LoopEnd);
 759     return;
 760   }
 761
 762   if (!isPredictableTrue(Node))
 763     LoopStart = needPrefix(true);
 764
 765   LoopEnd = Loops[Node->getEntry()];
 766   wireFlow(false, LoopEnd);
 767   while (!Visited.count(LoopEnd)) {
 768     handleLoops(false, LoopEnd);
 769   }
 770
 771   // Create an extra loop end node
 772   LoopEnd = needPrefix(false);
 773   BasicBlock *Next = needPostfix(LoopEnd, ExitUseAllowed);
 774   LoopConds.push_back(BranchInst::Create(Next, LoopStart,
 775                                          BoolUndef, LoopEnd));
 776   addPhiValues(LoopEnd, LoopStart);
 777   setPrevNode(Next);
 778 }
 779
 780 /// After this function control flow looks like it should be, but
 781 /// branches and PHI nodes only have undefined conditions.
 782 void StructurizeCFG::createFlow() {
 783   BasicBlock *Exit = ParentRegion->getExit();
 784   bool EntryDominatesExit = DT->dominates(ParentRegion->getEntry(), Exit);
 785
 786   DeletedPhis.clear();
 787   AddedPhis.clear();
 788   Conditions.clear();
 789   LoopConds.clear();
 790
 791   PrevNode = 0;
 792   Visited.clear();
 793
 794   while (!Order.empty()) {
 795     handleLoops(EntryDominatesExit, 0);
 796   }
 797
 798   if (PrevNode)
 799     changeExit(PrevNode, Exit, EntryDominatesExit);
 800   else
 801     assert(EntryDominatesExit);
 802 }
 803
 804 /// Handle a rare case where the disintegrated nodes instructions
 805 /// no longer dominate all their uses. Not sure if this is really nessasary
 806 void StructurizeCFG::rebuildSSA() {
 807   SSAUpdater Updater;
 808   for (Region::block_iterator I = ParentRegion->block_begin(),
 809                               E = ParentRegion->block_end();
 810        I != E; ++I) {
 811
 812     BasicBlock *BB = *I;
 813     for (BasicBlock::iterator II = BB->begin(), IE = BB->end();
 814          II != IE; ++II) {
 815
 816       bool Initialized = false;
 817       for (Use *I = &II->use_begin().getUse(), *Next; I; I = Next) {
 818
 819         Next = I->getNext();
 820
 821         Instruction *User = cast<Instruction>(I->getUser());
 822         if (User->getParent() == BB) {
 823           continue;
 824
 825         } else if (PHINode *UserPN = dyn_cast<PHINode>(User)) {
 826           if (UserPN->getIncomingBlock(*I) == BB)
 827             continue;
 828         }
 829
 830         if (DT->dominates(II, User))
 831           continue;
 832
 833         if (!Initialized) {
 834           Value *Undef = UndefValue::get(II->getType());
 835           Updater.Initialize(II->getType(), "");
 836           Updater.AddAvailableValue(&Func->getEntryBlock(), Undef);
 837           Updater.AddAvailableValue(BB, II);
 838           Initialized = true;
 839         }
 840         Updater.RewriteUseAfterInsertions(*I);
 841       }
 842     }
 843   }
 844 }
 845
 846 /// \brief Run the transformation for each region found
 847 bool StructurizeCFG::runOnRegion(Region *R, RGPassManager &RGM) {
 848   if (R->isTopLevelRegion())
 849     return false;
 850
 851   Func = R->getEntry()->getParent();
 852   ParentRegion = R;
 853
 854   DT = &getAnalysis<DominatorTree>();
 855
 856   orderNodes();
 857   collectInfos();
 858   createFlow();
 859   insertConditions(false);
 860   insertConditions(true);
 861   setPhiValues();
 862   rebuildSSA();
 863
 864   // Cleanup
 865   Order.clear();
 866   Visited.clear();
 867   DeletedPhis.clear();
 868   AddedPhis.clear();
 869   Predicates.clear();
 870   Conditions.clear();
 871   Loops.clear();
 872   LoopPreds.clear();
 873   LoopConds.clear();
 874
 875   return true;
 876 }
 877
 878 /// \brief Create the pass
 879 Pass *llvm::createStructurizeCFGPass() {
 880   return new StructurizeCFG();
 881 }