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