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/IR/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   bool doInitialization(Region *R, RGPassManager &RGM) override;
 239
 240   bool runOnRegion(Region *R, RGPassManager &RGM) override;
 241
 242   const char *getPassName() const override {
 243     return "Structurize control flow";
 244   }
 245
 246   void getAnalysisUsage(AnalysisUsage &AU) const override {
 247     AU.addRequiredID(LowerSwitchID);
 248     AU.addRequired<DominatorTreeWrapperPass>();
 249     AU.addPreserved<DominatorTreeWrapperPass>();
 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(DominatorTreeWrapperPass)
 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   for (Order.clear(); !I.isAtEnd(); ++I) {
 282     std::vector<RegionNode *> &Nodes = *I;
 283     Order.append(Nodes.begin(), Nodes.end());
 284   }
 285 }
 286
 287 /// \brief Determine the end of the loops
 288 void StructurizeCFG::analyzeLoops(RegionNode *N) {
 289   if (N->isSubRegion()) {
 290     // Test for exit as back edge
 291     BasicBlock *Exit = N->getNodeAs<Region>()->getExit();
 292     if (Visited.count(Exit))
 293       Loops[Exit] = N->getEntry();
 294
 295   } else {
 296     // Test for sucessors as back edge
 297     BasicBlock *BB = N->getNodeAs<BasicBlock>();
 298     BranchInst *Term = cast<BranchInst>(BB->getTerminator());
 299
 300     for (unsigned i = 0, e = Term->getNumSuccessors(); i != e; ++i) {
 301       BasicBlock *Succ = Term->getSuccessor(i);
 302
 303       if (Visited.count(Succ))
 304         Loops[Succ] = BB;
 305     }
 306   }
 307 }
 308
 309 /// \brief Invert the given condition
 310 Value *StructurizeCFG::invert(Value *Condition) {
 311   // First: Check if it's a constant
 312   if (Condition == BoolTrue)
 313     return BoolFalse;
 314
 315   if (Condition == BoolFalse)
 316     return BoolTrue;
 317
 318   if (Condition == BoolUndef)
 319     return BoolUndef;
 320
 321   // Second: If the condition is already inverted, return the original value
 322   if (match(Condition, m_Not(m_Value(Condition))))
 323     return Condition;
 324
 325   if (Instruction *Inst = dyn_cast<Instruction>(Condition)) {
 326     // Third: Check all the users for an invert
 327     BasicBlock *Parent = Inst->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   if (Argument *Arg = dyn_cast<Argument>(Condition)) {
 344     BasicBlock &EntryBlock = Arg->getParent()->getEntryBlock();
 345     return BinaryOperator::CreateNot(Condition,
 346                                      Arg->getName() + ".inv",
 347                                      EntryBlock.getTerminator());
 348   }
 349
 350   llvm_unreachable("Unhandled condition to invert");
 351 }
 352
 353 /// \brief Build the condition for one edge
 354 Value *StructurizeCFG::buildCondition(BranchInst *Term, unsigned Idx,
 355                                       bool Invert) {
 356   Value *Cond = Invert ? BoolFalse : BoolTrue;
 357   if (Term->isConditional()) {
 358     Cond = Term->getCondition();
 359
 360     if (Idx != (unsigned)Invert)
 361       Cond = invert(Cond);
 362   }
 363   return Cond;
 364 }
 365
 366 /// \brief Analyze the predecessors of each block and build up predicates
 367 void StructurizeCFG::gatherPredicates(RegionNode *N) {
 368   RegionInfo *RI = ParentRegion->getRegionInfo();
 369   BasicBlock *BB = N->getEntry();
 370   BBPredicates &Pred = Predicates[BB];
 371   BBPredicates &LPred = LoopPreds[BB];
 372
 373   for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
 374        PI != PE; ++PI) {
 375
 376     // Ignore it if it's a branch from outside into our region entry
 377     if (!ParentRegion->contains(*PI))
 378       continue;
 379
 380     Region *R = RI->getRegionFor(*PI);
 381     if (R == ParentRegion) {
 382
 383       // It's a top level block in our region
 384       BranchInst *Term = cast<BranchInst>((*PI)->getTerminator());
 385       for (unsigned i = 0, e = Term->getNumSuccessors(); i != e; ++i) {
 386         BasicBlock *Succ = Term->getSuccessor(i);
 387         if (Succ != BB)
 388           continue;
 389
 390         if (Visited.count(*PI)) {
 391           // Normal forward edge
 392           if (Term->isConditional()) {
 393             // Try to treat it like an ELSE block
 394             BasicBlock *Other = Term->getSuccessor(!i);
 395             if (Visited.count(Other) && !Loops.count(Other) &&
 396                 !Pred.count(Other) && !Pred.count(*PI)) {
 397
 398               Pred[Other] = BoolFalse;
 399               Pred[*PI] = BoolTrue;
 400               continue;
 401             }
 402           }
 403           Pred[*PI] = buildCondition(Term, i, false);
 404
 405         } else {
 406           // Back edge
 407           LPred[*PI] = buildCondition(Term, i, true);
 408         }
 409       }
 410
 411     } else {
 412
 413       // It's an exit from a sub region
 414       while(R->getParent() != ParentRegion)
 415         R = R->getParent();
 416
 417       // Edge from inside a subregion to its entry, ignore it
 418       if (R == N)
 419         continue;
 420
 421       BasicBlock *Entry = R->getEntry();
 422       if (Visited.count(Entry))
 423         Pred[Entry] = BoolTrue;
 424       else
 425         LPred[Entry] = BoolFalse;
 426     }
 427   }
 428 }
 429
 430 /// \brief Collect various loop and predicate infos
 431 void StructurizeCFG::collectInfos() {
 432   // Reset predicate
 433   Predicates.clear();
 434
 435   // and loop infos
 436   Loops.clear();
 437   LoopPreds.clear();
 438
 439   // Reset the visited nodes
 440   Visited.clear();
 441
 442   for (RNVector::reverse_iterator OI = Order.rbegin(), OE = Order.rend();
 443        OI != OE; ++OI) {
 444
 445     // Analyze all the conditions leading to a node
 446     gatherPredicates(*OI);
 447
 448     // Remember that we've seen this node
 449     Visited.insert((*OI)->getEntry());
 450
 451     // Find the last back edges
 452     analyzeLoops(*OI);
 453   }
 454 }
 455
 456 /// \brief Insert the missing branch conditions
 457 void StructurizeCFG::insertConditions(bool Loops) {
 458   BranchVector &Conds = Loops ? LoopConds : Conditions;
 459   Value *Default = Loops ? BoolTrue : BoolFalse;
 460   SSAUpdater PhiInserter;
 461
 462   for (BranchVector::iterator I = Conds.begin(),
 463        E = Conds.end(); I != E; ++I) {
 464
 465     BranchInst *Term = *I;
 466     assert(Term->isConditional());
 467
 468     BasicBlock *Parent = Term->getParent();
 469     BasicBlock *SuccTrue = Term->getSuccessor(0);
 470     BasicBlock *SuccFalse = Term->getSuccessor(1);
 471
 472     PhiInserter.Initialize(Boolean, "");
 473     PhiInserter.AddAvailableValue(&Func->getEntryBlock(), Default);
 474     PhiInserter.AddAvailableValue(Loops ? SuccFalse : Parent, Default);
 475
 476     BBPredicates &Preds = Loops ? LoopPreds[SuccFalse] : Predicates[SuccTrue];
 477
 478     NearestCommonDominator Dominator(DT);
 479     Dominator.addBlock(Parent, false);
 480
 481     Value *ParentValue = 0;
 482     for (BBPredicates::iterator PI = Preds.begin(), PE = Preds.end();
 483          PI != PE; ++PI) {
 484
 485       if (PI->first == Parent) {
 486         ParentValue = PI->second;
 487         break;
 488       }
 489       PhiInserter.AddAvailableValue(PI->first, PI->second);
 490       Dominator.addBlock(PI->first);
 491     }
 492
 493     if (ParentValue) {
 494       Term->setCondition(ParentValue);
 495     } else {
 496       if (!Dominator.wasResultExplicitMentioned())
 497         PhiInserter.AddAvailableValue(Dominator.getResult(), Default);
 498
 499       Term->setCondition(PhiInserter.GetValueInMiddleOfBlock(Parent));
 500     }
 501   }
 502 }
 503
 504 /// \brief Remove all PHI values coming from "From" into "To" and remember
 505 /// them in DeletedPhis
 506 void StructurizeCFG::delPhiValues(BasicBlock *From, BasicBlock *To) {
 507   PhiMap &Map = DeletedPhis[To];
 508   for (BasicBlock::iterator I = To->begin(), E = To->end();
 509        I != E && isa<PHINode>(*I);) {
 510
 511     PHINode &Phi = cast<PHINode>(*I++);
 512     while (Phi.getBasicBlockIndex(From) != -1) {
 513       Value *Deleted = Phi.removeIncomingValue(From, false);
 514       Map[&Phi].push_back(std::make_pair(From, Deleted));
 515     }
 516   }
 517 }
 518
 519 /// \brief Add a dummy PHI value as soon as we knew the new predecessor
 520 void StructurizeCFG::addPhiValues(BasicBlock *From, BasicBlock *To) {
 521   for (BasicBlock::iterator I = To->begin(), E = To->end();
 522        I != E && isa<PHINode>(*I);) {
 523
 524     PHINode &Phi = cast<PHINode>(*I++);
 525     Value *Undef = UndefValue::get(Phi.getType());
 526     Phi.addIncoming(Undef, From);
 527   }
 528   AddedPhis[To].push_back(From);
 529 }
 530
 531 /// \brief Add the real PHI value as soon as everything is set up
 532 void StructurizeCFG::setPhiValues() {
 533   SSAUpdater Updater;
 534   for (BB2BBVecMap::iterator AI = AddedPhis.begin(), AE = AddedPhis.end();
 535        AI != AE; ++AI) {
 536
 537     BasicBlock *To = AI->first;
 538     BBVector &From = AI->second;
 539
 540     if (!DeletedPhis.count(To))
 541       continue;
 542
 543     PhiMap &Map = DeletedPhis[To];
 544     for (PhiMap::iterator PI = Map.begin(), PE = Map.end();
 545          PI != PE; ++PI) {
 546
 547       PHINode *Phi = PI->first;
 548       Value *Undef = UndefValue::get(Phi->getType());
 549       Updater.Initialize(Phi->getType(), "");
 550       Updater.AddAvailableValue(&Func->getEntryBlock(), Undef);
 551       Updater.AddAvailableValue(To, Undef);
 552
 553       NearestCommonDominator Dominator(DT);
 554       Dominator.addBlock(To, false);
 555       for (BBValueVector::iterator VI = PI->second.begin(),
 556            VE = PI->second.end(); VI != VE; ++VI) {
 557
 558         Updater.AddAvailableValue(VI->first, VI->second);
 559         Dominator.addBlock(VI->first);
 560       }
 561
 562       if (!Dominator.wasResultExplicitMentioned())
 563         Updater.AddAvailableValue(Dominator.getResult(), Undef);
 564
 565       for (BBVector::iterator FI = From.begin(), FE = From.end();
 566            FI != FE; ++FI) {
 567
 568         int Idx = Phi->getBasicBlockIndex(*FI);
 569         assert(Idx != -1);
 570         Phi->setIncomingValue(Idx, Updater.GetValueAtEndOfBlock(*FI));
 571       }
 572     }
 573
 574     DeletedPhis.erase(To);
 575   }
 576   assert(DeletedPhis.empty());
 577 }
 578
 579 /// \brief Remove phi values from all successors and then remove the terminator.
 580 void StructurizeCFG::killTerminator(BasicBlock *BB) {
 581   TerminatorInst *Term = BB->getTerminator();
 582   if (!Term)
 583     return;
 584
 585   for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB);
 586        SI != SE; ++SI) {
 587
 588     delPhiValues(BB, *SI);
 589   }
 590
 591   Term->eraseFromParent();
 592 }
 593
 594 /// \brief Let node exit(s) point to NewExit
 595 void StructurizeCFG::changeExit(RegionNode *Node, BasicBlock *NewExit,
 596                                 bool IncludeDominator) {
 597   if (Node->isSubRegion()) {
 598     Region *SubRegion = Node->getNodeAs<Region>();
 599     BasicBlock *OldExit = SubRegion->getExit();
 600     BasicBlock *Dominator = 0;
 601
 602     // Find all the edges from the sub region to the exit
 603     for (pred_iterator I = pred_begin(OldExit), E = pred_end(OldExit);
 604          I != E;) {
 605
 606       BasicBlock *BB = *I++;
 607       if (!SubRegion->contains(BB))
 608         continue;
 609
 610       // Modify the edges to point to the new exit
 611       delPhiValues(BB, OldExit);
 612       BB->getTerminator()->replaceUsesOfWith(OldExit, NewExit);
 613       addPhiValues(BB, NewExit);
 614
 615       // Find the new dominator (if requested)
 616       if (IncludeDominator) {
 617         if (!Dominator)
 618           Dominator = BB;
 619         else
 620           Dominator = DT->findNearestCommonDominator(Dominator, BB);
 621       }
 622     }
 623
 624     // Change the dominator (if requested)
 625     if (Dominator)
 626       DT->changeImmediateDominator(NewExit, Dominator);
 627
 628     // Update the region info
 629     SubRegion->replaceExit(NewExit);
 630
 631   } else {
 632     BasicBlock *BB = Node->getNodeAs<BasicBlock>();
 633     killTerminator(BB);
 634     BranchInst::Create(NewExit, BB);
 635     addPhiValues(BB, NewExit);
 636     if (IncludeDominator)
 637       DT->changeImmediateDominator(NewExit, BB);
 638   }
 639 }
 640
 641 /// \brief Create a new flow node and update dominator tree and region info
 642 BasicBlock *StructurizeCFG::getNextFlow(BasicBlock *Dominator) {
 643   LLVMContext &Context = Func->getContext();
 644   BasicBlock *Insert = Order.empty() ? ParentRegion->getExit() :
 645                        Order.back()->getEntry();
 646   BasicBlock *Flow = BasicBlock::Create(Context, FlowBlockName,
 647                                         Func, Insert);
 648   DT->addNewBlock(Flow, Dominator);
 649   ParentRegion->getRegionInfo()->setRegionFor(Flow, ParentRegion);
 650   return Flow;
 651 }
 652
 653 /// \brief Create a new or reuse the previous node as flow node
 654 BasicBlock *StructurizeCFG::needPrefix(bool NeedEmpty) {
 655   BasicBlock *Entry = PrevNode->getEntry();
 656
 657   if (!PrevNode->isSubRegion()) {
 658     killTerminator(Entry);
 659     if (!NeedEmpty || Entry->getFirstInsertionPt() == Entry->end())
 660       return Entry;
 661
 662   }
 663
 664   // create a new flow node
 665   BasicBlock *Flow = getNextFlow(Entry);
 666
 667   // and wire it up
 668   changeExit(PrevNode, Flow, true);
 669   PrevNode = ParentRegion->getBBNode(Flow);
 670   return Flow;
 671 }
 672
 673 /// \brief Returns the region exit if possible, otherwise just a new flow node
 674 BasicBlock *StructurizeCFG::needPostfix(BasicBlock *Flow,
 675                                         bool ExitUseAllowed) {
 676   if (Order.empty() && ExitUseAllowed) {
 677     BasicBlock *Exit = ParentRegion->getExit();
 678     DT->changeImmediateDominator(Exit, Flow);
 679     addPhiValues(Flow, Exit);
 680     return Exit;
 681   }
 682   return getNextFlow(Flow);
 683 }
 684
 685 /// \brief Set the previous node
 686 void StructurizeCFG::setPrevNode(BasicBlock *BB) {
 687   PrevNode =  ParentRegion->contains(BB) ? ParentRegion->getBBNode(BB) : 0;
 688 }
 689
 690 /// \brief Does BB dominate all the predicates of Node ?
 691 bool StructurizeCFG::dominatesPredicates(BasicBlock *BB, RegionNode *Node) {
 692   BBPredicates &Preds = Predicates[Node->getEntry()];
 693   for (BBPredicates::iterator PI = Preds.begin(), PE = Preds.end();
 694        PI != PE; ++PI) {
 695
 696     if (!DT->dominates(BB, PI->first))
 697       return false;
 698   }
 699   return true;
 700 }
 701
 702 /// \brief Can we predict that this node will always be called?
 703 bool StructurizeCFG::isPredictableTrue(RegionNode *Node) {
 704   BBPredicates &Preds = Predicates[Node->getEntry()];
 705   bool Dominated = false;
 706
 707   // Regionentry is always true
 708   if (PrevNode == 0)
 709     return true;
 710
 711   for (BBPredicates::iterator I = Preds.begin(), E = Preds.end();
 712        I != E; ++I) {
 713
 714     if (I->second != BoolTrue)
 715       return false;
 716
 717     if (!Dominated && DT->dominates(I->first, PrevNode->getEntry()))
 718       Dominated = true;
 719   }
 720
 721   // TODO: The dominator check is too strict
 722   return Dominated;
 723 }
 724
 725 /// Take one node from the order vector and wire it up
 726 void StructurizeCFG::wireFlow(bool ExitUseAllowed,
 727                               BasicBlock *LoopEnd) {
 728   RegionNode *Node = Order.pop_back_val();
 729   Visited.insert(Node->getEntry());
 730
 731   if (isPredictableTrue(Node)) {
 732     // Just a linear flow
 733     if (PrevNode) {
 734       changeExit(PrevNode, Node->getEntry(), true);
 735     }
 736     PrevNode = Node;
 737
 738   } else {
 739     // Insert extra prefix node (or reuse last one)
 740     BasicBlock *Flow = needPrefix(false);
 741
 742     // Insert extra postfix node (or use exit instead)
 743     BasicBlock *Entry = Node->getEntry();
 744     BasicBlock *Next = needPostfix(Flow, ExitUseAllowed);
 745
 746     // let it point to entry and next block
 747     Conditions.push_back(BranchInst::Create(Entry, Next, BoolUndef, Flow));
 748     addPhiValues(Flow, Entry);
 749     DT->changeImmediateDominator(Entry, Flow);
 750
 751     PrevNode = Node;
 752     while (!Order.empty() && !Visited.count(LoopEnd) &&
 753            dominatesPredicates(Entry, Order.back())) {
 754       handleLoops(false, LoopEnd);
 755     }
 756
 757     changeExit(PrevNode, Next, false);
 758     setPrevNode(Next);
 759   }
 760 }
 761
 762 void StructurizeCFG::handleLoops(bool ExitUseAllowed,
 763                                  BasicBlock *LoopEnd) {
 764   RegionNode *Node = Order.back();
 765   BasicBlock *LoopStart = Node->getEntry();
 766
 767   if (!Loops.count(LoopStart)) {
 768     wireFlow(ExitUseAllowed, LoopEnd);
 769     return;
 770   }
 771
 772   if (!isPredictableTrue(Node))
 773     LoopStart = needPrefix(true);
 774
 775   LoopEnd = Loops[Node->getEntry()];
 776   wireFlow(false, LoopEnd);
 777   while (!Visited.count(LoopEnd)) {
 778     handleLoops(false, LoopEnd);
 779   }
 780
 781   // If the start of the loop is the entry block, we can't branch to it so
 782   // insert a new dummy entry block.
 783   Function *LoopFunc = LoopStart->getParent();
 784   if (LoopStart == &LoopFunc->getEntryBlock()) {
 785     LoopStart->setName("entry.orig");
 786
 787     BasicBlock *NewEntry =
 788       BasicBlock::Create(LoopStart->getContext(),
 789                          "entry",
 790                          LoopFunc,
 791                          LoopStart);
 792     BranchInst::Create(LoopStart, NewEntry);
 793   }
 794
 795   // Create an extra loop end node
 796   LoopEnd = needPrefix(false);
 797   BasicBlock *Next = needPostfix(LoopEnd, ExitUseAllowed);
 798   LoopConds.push_back(BranchInst::Create(Next, LoopStart,
 799                                          BoolUndef, LoopEnd));
 800   addPhiValues(LoopEnd, LoopStart);
 801   setPrevNode(Next);
 802 }
 803
 804 /// After this function control flow looks like it should be, but
 805 /// branches and PHI nodes only have undefined conditions.
 806 void StructurizeCFG::createFlow() {
 807   BasicBlock *Exit = ParentRegion->getExit();
 808   bool EntryDominatesExit = DT->dominates(ParentRegion->getEntry(), Exit);
 809
 810   DeletedPhis.clear();
 811   AddedPhis.clear();
 812   Conditions.clear();
 813   LoopConds.clear();
 814
 815   PrevNode = 0;
 816   Visited.clear();
 817
 818   while (!Order.empty()) {
 819     handleLoops(EntryDominatesExit, 0);
 820   }
 821
 822   if (PrevNode)
 823     changeExit(PrevNode, Exit, EntryDominatesExit);
 824   else
 825     assert(EntryDominatesExit);
 826 }
 827
 828 /// Handle a rare case where the disintegrated nodes instructions
 829 /// no longer dominate all their uses. Not sure if this is really nessasary
 830 void StructurizeCFG::rebuildSSA() {
 831   SSAUpdater Updater;
 832   for (const auto &BB : ParentRegion->blocks())
 833     for (BasicBlock::iterator II = BB->begin(), IE = BB->end();
 834          II != IE; ++II) {
 835
 836       bool Initialized = false;
 837       for (Use *I = &II->use_begin().getUse(), *Next; I; I = Next) {
 838
 839         Next = I->getNext();
 840
 841         Instruction *User = cast<Instruction>(I->getUser());
 842         if (User->getParent() == BB) {
 843           continue;
 844
 845         } else if (PHINode *UserPN = dyn_cast<PHINode>(User)) {
 846           if (UserPN->getIncomingBlock(*I) == BB)
 847             continue;
 848         }
 849
 850         if (DT->dominates(II, User))
 851           continue;
 852
 853         if (!Initialized) {
 854           Value *Undef = UndefValue::get(II->getType());
 855           Updater.Initialize(II->getType(), "");
 856           Updater.AddAvailableValue(&Func->getEntryBlock(), Undef);
 857           Updater.AddAvailableValue(BB, II);
 858           Initialized = true;
 859         }
 860         Updater.RewriteUseAfterInsertions(*I);
 861       }
 862     }
 863 }
 864
 865 /// \brief Run the transformation for each region found
 866 bool StructurizeCFG::runOnRegion(Region *R, RGPassManager &RGM) {
 867   if (R->isTopLevelRegion())
 868     return false;
 869
 870   Func = R->getEntry()->getParent();
 871   ParentRegion = R;
 872
 873   DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
 874
 875   orderNodes();
 876   collectInfos();
 877   createFlow();
 878   insertConditions(false);
 879   insertConditions(true);
 880   setPhiValues();
 881   rebuildSSA();
 882
 883   // Cleanup
 884   Order.clear();
 885   Visited.clear();
 886   DeletedPhis.clear();
 887   AddedPhis.clear();
 888   Predicates.clear();
 889   Conditions.clear();
 890   Loops.clear();
 891   LoopPreds.clear();
 892   LoopConds.clear();
 893
 894   return true;
 895 }
 896
 897 /// \brief Create the pass
 898 Pass *llvm::createStructurizeCFGPass() {
 899   return new StructurizeCFG();
 900 }