lib/Transforms/Scalar/LoopIndexSplit.cpp

   1 //===- LoopIndexSplit.cpp - Loop Index Splitting Pass ---------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Devang Patel and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements Loop Index Splitting Pass.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "loop-index-split"
  15
  16 #include "llvm/Transforms/Scalar.h"
  17 #include "llvm/Analysis/LoopPass.h"
  18 #include "llvm/Analysis/ScalarEvolutionExpander.h"
  19 #include "llvm/Analysis/Dominators.h"
  20 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  21 #include "llvm/Transforms/Utils/Cloning.h"
  22 #include "llvm/Support/Compiler.h"
  23 #include "llvm/ADT/DepthFirstIterator.h"
  24 #include "llvm/ADT/Statistic.h"
  25
  26 using namespace llvm;
  27
  28 STATISTIC(NumIndexSplit, "Number of loops index split");
  29
  30 namespace {
  31
  32   class VISIBILITY_HIDDEN LoopIndexSplit : public LoopPass {
  33
  34   public:
  35     static char ID; // Pass ID, replacement for typeid
  36     LoopIndexSplit() : LoopPass((intptr_t)&ID) {}
  37
  38     // Index split Loop L. Return true if loop is split.
  39     bool runOnLoop(Loop *L, LPPassManager &LPM);
  40
  41     void getAnalysisUsage(AnalysisUsage &AU) const {
  42       AU.addRequired<ScalarEvolution>();
  43       AU.addPreserved<ScalarEvolution>();
  44       AU.addRequiredID(LCSSAID);
  45       AU.addPreservedID(LCSSAID);
  46       AU.addRequired<LoopInfo>();
  47       AU.addPreserved<LoopInfo>();
  48       AU.addRequiredID(LoopSimplifyID);
  49       AU.addPreservedID(LoopSimplifyID);
  50       AU.addRequired<DominatorTree>();
  51       AU.addRequired<DominanceFrontier>();
  52       AU.addPreserved<DominatorTree>();
  53       AU.addPreserved<DominanceFrontier>();
  54     }
  55
  56   private:
  57
  58     class SplitInfo {
  59     public:
  60       SplitInfo() : SplitValue(NULL), SplitCondition(NULL) {}
  61
  62       // Induction variable's range is split at this value.
  63       Value *SplitValue;
  64
  65       // This compare instruction compares IndVar against SplitValue.
  66       ICmpInst *SplitCondition;
  67
  68       // Clear split info.
  69       void clear() {
  70         SplitValue = NULL;
  71         SplitCondition = NULL;
  72       }
  73
  74     };
  75
  76   private:
  77     /// Find condition inside a loop that is suitable candidate for index split.
  78     void findSplitCondition();
  79
  80     /// Find loop's exit condition.
  81     void findLoopConditionals();
  82
  83     /// Return induction variable associated with value V.
  84     void findIndVar(Value *V, Loop *L);
  85
  86     /// processOneIterationLoop - Current loop L contains compare instruction
  87     /// that compares induction variable, IndVar, agains loop invariant. If
  88     /// entire (i.e. meaningful) loop body is dominated by this compare
  89     /// instruction then loop body is executed only for one iteration. In
  90     /// such case eliminate loop structure surrounding this loop body. For
  91     bool processOneIterationLoop(SplitInfo &SD);
  92
  93     /// If loop header includes loop variant instruction operands then
  94     /// this loop may not be eliminated.
  95     bool safeHeader(SplitInfo &SD,  BasicBlock *BB);
  96
  97     /// If Exit block includes loop variant instructions then this
  98     /// loop may not be eliminated.
  99     bool safeExitBlock(SplitInfo &SD, BasicBlock *BB);
 100
 101     /// removeBlocks - Remove basic block DeadBB and all blocks dominated by DeadBB.
 102     /// This routine is used to remove split condition's dead branch, dominated by
 103     /// DeadBB. LiveBB dominates split conidition's other branch.
 104     void removeBlocks(BasicBlock *DeadBB, Loop *LP, BasicBlock *LiveBB);
 105
 106     /// Find cost of spliting loop L.
 107     unsigned findSplitCost(Loop *L, SplitInfo &SD);
 108     bool splitLoop(SplitInfo &SD);
 109
 110     void initialize() {
 111       IndVar = NULL;
 112       IndVarIncrement = NULL;
 113       ExitCondition = NULL;
 114       StartValue = NULL;
 115       ExitValueNum = 0;
 116       SplitData.clear();
 117     }
 118
 119   private:
 120
 121     // Current Loop.
 122     Loop *L;
 123     LPPassManager *LPM;
 124     LoopInfo *LI;
 125     ScalarEvolution *SE;
 126     DominatorTree *DT;
 127     DominanceFrontier *DF;
 128     SmallVector<SplitInfo, 4> SplitData;
 129
 130     // Induction variable whose range is being split by this transformation.
 131     PHINode *IndVar;
 132     Instruction *IndVarIncrement;
 133
 134     // Loop exit condition.
 135     ICmpInst *ExitCondition;
 136
 137     // Induction variable's initial value.
 138     Value *StartValue;
 139
 140     // Induction variable's final loop exit value operand number in exit condition..
 141     unsigned ExitValueNum;
 142   };
 143
 144   char LoopIndexSplit::ID = 0;
 145   RegisterPass<LoopIndexSplit> X ("loop-index-split", "Index Split Loops");
 146 }
 147
 148 LoopPass *llvm::createLoopIndexSplitPass() {
 149   return new LoopIndexSplit();
 150 }
 151
 152 // Index split Loop L. Return true if loop is split.
 153 bool LoopIndexSplit::runOnLoop(Loop *IncomingLoop, LPPassManager &LPM_Ref) {
 154   bool Changed = false;
 155   L = IncomingLoop;
 156   LPM = &LPM_Ref;
 157
 158   // FIXME - Nested loops make dominator info updates tricky.
 159   if (!L->getSubLoops().empty())
 160     return false;
 161
 162   SE = &getAnalysis<ScalarEvolution>();
 163   DT = &getAnalysis<DominatorTree>();
 164   LI = &getAnalysis<LoopInfo>();
 165   DF = &getAnalysis<DominanceFrontier>();
 166
 167   initialize();
 168
 169   findLoopConditionals();
 170
 171   if (!ExitCondition)
 172     return false;
 173
 174   findSplitCondition();
 175
 176   if (SplitData.empty())
 177     return false;
 178
 179   // First see if it is possible to eliminate loop itself or not.
 180   for (SmallVector<SplitInfo, 4>::iterator SI = SplitData.begin(),
 181          E = SplitData.end(); SI != E;) {
 182     SplitInfo &SD = *SI;
 183     if (SD.SplitCondition->getPredicate() == ICmpInst::ICMP_EQ) {
 184       Changed = processOneIterationLoop(SD);
 185       if (Changed) {
 186         ++NumIndexSplit;
 187         // If is loop is eliminated then nothing else to do here.
 188         return Changed;
 189       } else {
 190         SmallVector<SplitInfo, 4>::iterator Delete_SI = SI;
 191         ++SI;
 192         SplitData.erase(Delete_SI);
 193       }
 194     } else
 195       ++SI;
 196   }
 197
 198   unsigned MaxCost = 99;
 199   unsigned Index = 0;
 200   unsigned MostProfitableSDIndex = 0;
 201   for (SmallVector<SplitInfo, 4>::iterator SI = SplitData.begin(),
 202          E = SplitData.end(); SI != E; ++SI, ++Index) {
 203     SplitInfo SD = *SI;
 204
 205     // ICM_EQs are already handled above.
 206     assert (SD.SplitCondition->getPredicate() != ICmpInst::ICMP_EQ &&
 207             "Unexpected split condition predicate");
 208
 209     unsigned Cost = findSplitCost(L, SD);
 210     if (Cost < MaxCost)
 211       MostProfitableSDIndex = Index;
 212   }
 213
 214   // Split most profitiable condition.
 215   if (!SplitData.empty())
 216     Changed = splitLoop(SplitData[MostProfitableSDIndex]);
 217
 218   if (Changed)
 219     ++NumIndexSplit;
 220
 221   return Changed;
 222 }
 223
 224 /// Return true if V is a induction variable or induction variable's
 225 /// increment for loop L.
 226 void LoopIndexSplit::findIndVar(Value *V, Loop *L) {
 227
 228   Instruction *I = dyn_cast<Instruction>(V);
 229   if (!I)
 230     return;
 231
 232   // Check if I is a phi node from loop header or not.
 233   if (PHINode *PN = dyn_cast<PHINode>(V)) {
 234     if (PN->getParent() == L->getHeader()) {
 235       IndVar = PN;
 236       return;
 237     }
 238   }
 239
 240   // Check if I is a add instruction whose one operand is
 241   // phi node from loop header and second operand is constant.
 242   if (I->getOpcode() != Instruction::Add)
 243     return;
 244
 245   Value *Op0 = I->getOperand(0);
 246   Value *Op1 = I->getOperand(1);
 247
 248   if (PHINode *PN = dyn_cast<PHINode>(Op0)) {
 249     if (PN->getParent() == L->getHeader()
 250         && isa<ConstantInt>(Op1)) {
 251       IndVar = PN;
 252       IndVarIncrement = I;
 253       return;
 254     }
 255   }
 256
 257   if (PHINode *PN = dyn_cast<PHINode>(Op1)) {
 258     if (PN->getParent() == L->getHeader()
 259         && isa<ConstantInt>(Op0)) {
 260       IndVar = PN;
 261       IndVarIncrement = I;
 262       return;
 263     }
 264   }
 265
 266   return;
 267 }
 268
 269 // Find loop's exit condition and associated induction variable.
 270 void LoopIndexSplit::findLoopConditionals() {
 271
 272   BasicBlock *ExitBlock = NULL;
 273
 274   for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
 275        I != E; ++I) {
 276     BasicBlock *BB = *I;
 277     if (!L->isLoopExit(BB))
 278       continue;
 279     if (ExitBlock)
 280       return;
 281     ExitBlock = BB;
 282   }
 283
 284   if (!ExitBlock)
 285     return;
 286
 287   // If exit block's terminator is conditional branch inst then we have found
 288   // exit condition.
 289   BranchInst *BR = dyn_cast<BranchInst>(ExitBlock->getTerminator());
 290   if (!BR || BR->isUnconditional())
 291     return;
 292
 293   ICmpInst *CI = dyn_cast<ICmpInst>(BR->getCondition());
 294   if (!CI)
 295     return;
 296
 297   ExitCondition = CI;
 298
 299   // Exit condition's one operand is loop invariant exit value and second
 300   // operand is SCEVAddRecExpr based on induction variable.
 301   Value *V0 = CI->getOperand(0);
 302   Value *V1 = CI->getOperand(1);
 303
 304   SCEVHandle SH0 = SE->getSCEV(V0);
 305   SCEVHandle SH1 = SE->getSCEV(V1);
 306
 307   if (SH0->isLoopInvariant(L) && isa<SCEVAddRecExpr>(SH1)) {
 308     ExitValueNum = 0;
 309     findIndVar(V1, L);
 310   }
 311   else if (SH1->isLoopInvariant(L) && isa<SCEVAddRecExpr>(SH0)) {
 312     ExitValueNum =  1;
 313     findIndVar(V0, L);
 314   }
 315
 316   if (!IndVar)
 317     ExitCondition = NULL;
 318   else if (IndVar) {
 319     BasicBlock *Preheader = L->getLoopPreheader();
 320     StartValue = IndVar->getIncomingValueForBlock(Preheader);
 321   }
 322 }
 323
 324 /// Find condition inside a loop that is suitable candidate for index split.
 325 void LoopIndexSplit::findSplitCondition() {
 326
 327   SplitInfo SD;
 328   // Check all basic block's terminators.
 329
 330   for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
 331        I != E; ++I) {
 332     BasicBlock *BB = *I;
 333
 334     // If this basic block does not terminate in a conditional branch
 335     // then terminator is not a suitable split condition.
 336     BranchInst *BR = dyn_cast<BranchInst>(BB->getTerminator());
 337     if (!BR)
 338       continue;
 339
 340     if (BR->isUnconditional())
 341       continue;
 342
 343     ICmpInst *CI = dyn_cast<ICmpInst>(BR->getCondition());
 344     if (!CI || CI == ExitCondition)
 345       return;
 346
 347     // If one operand is loop invariant and second operand is SCEVAddRecExpr
 348     // based on induction variable then CI is a candidate split condition.
 349     Value *V0 = CI->getOperand(0);
 350     Value *V1 = CI->getOperand(1);
 351
 352     SCEVHandle SH0 = SE->getSCEV(V0);
 353     SCEVHandle SH1 = SE->getSCEV(V1);
 354
 355     if (SH0->isLoopInvariant(L) && isa<SCEVAddRecExpr>(SH1)) {
 356       SD.SplitValue = V0;
 357       SD.SplitCondition = CI;
 358       if (PHINode *PN = dyn_cast<PHINode>(V1)) {
 359         if (PN == IndVar)
 360           SplitData.push_back(SD);
 361       }
 362       else  if (Instruction *Insn = dyn_cast<Instruction>(V1)) {
 363         if (IndVarIncrement && IndVarIncrement == Insn)
 364           SplitData.push_back(SD);
 365       }
 366     }
 367     else if (SH1->isLoopInvariant(L) && isa<SCEVAddRecExpr>(SH0)) {
 368       SD.SplitValue =  V1;
 369       SD.SplitCondition = CI;
 370       if (PHINode *PN = dyn_cast<PHINode>(V0)) {
 371         if (PN == IndVar)
 372           SplitData.push_back(SD);
 373       }
 374       else  if (Instruction *Insn = dyn_cast<Instruction>(V0)) {
 375         if (IndVarIncrement && IndVarIncrement == Insn)
 376           SplitData.push_back(SD);
 377       }
 378     }
 379   }
 380 }
 381
 382 /// processOneIterationLoop - Current loop L contains compare instruction
 383 /// that compares induction variable, IndVar, against loop invariant. If
 384 /// entire (i.e. meaningful) loop body is dominated by this compare
 385 /// instruction then loop body is executed only once. In such case eliminate
 386 /// loop structure surrounding this loop body. For example,
 387 ///     for (int i = start; i < end; ++i) {
 388 ///         if ( i == somevalue) {
 389 ///           loop_body
 390 ///         }
 391 ///     }
 392 /// can be transformed into
 393 ///     if (somevalue >= start && somevalue < end) {
 394 ///        i = somevalue;
 395 ///        loop_body
 396 ///     }
 397 bool LoopIndexSplit::processOneIterationLoop(SplitInfo &SD) {
 398
 399   BasicBlock *Header = L->getHeader();
 400
 401   // First of all, check if SplitCondition dominates entire loop body
 402   // or not.
 403
 404   // If SplitCondition is not in loop header then this loop is not suitable
 405   // for this transformation.
 406   if (SD.SplitCondition->getParent() != Header)
 407     return false;
 408
 409   // If loop header includes loop variant instruction operands then
 410   // this loop may not be eliminated.
 411   if (!safeHeader(SD, Header))
 412     return false;
 413
 414   // If Exit block includes loop variant instructions then this
 415   // loop may not be eliminated.
 416   if (!safeExitBlock(SD, ExitCondition->getParent()))
 417     return false;
 418
 419   // Update CFG.
 420
 421   // Replace index variable with split value in loop body. Loop body is executed
 422   // only when index variable is equal to split value.
 423   IndVar->replaceAllUsesWith(SD.SplitValue);
 424
 425   // Remove Latch to Header edge.
 426   BasicBlock *Latch = L->getLoopLatch();
 427   BasicBlock *LatchSucc = NULL;
 428   BranchInst *BR = dyn_cast<BranchInst>(Latch->getTerminator());
 429   if (!BR)
 430     return false;
 431   Header->removePredecessor(Latch);
 432   for (succ_iterator SI = succ_begin(Latch), E = succ_end(Latch);
 433        SI != E; ++SI) {
 434     if (Header != *SI)
 435       LatchSucc = *SI;
 436   }
 437   BR->setUnconditionalDest(LatchSucc);
 438
 439   Instruction *Terminator = Header->getTerminator();
 440   Value *ExitValue = ExitCondition->getOperand(ExitValueNum);
 441
 442   // Replace split condition in header.
 443   // Transform
 444   //      SplitCondition : icmp eq i32 IndVar, SplitValue
 445   // into
 446   //      c1 = icmp uge i32 SplitValue, StartValue
 447   //      c2 = icmp ult i32 vSplitValue, ExitValue
 448   //      and i32 c1, c2
 449   bool SignedPredicate = ExitCondition->isSignedPredicate();
 450   Instruction *C1 = new ICmpInst(SignedPredicate ?
 451                                  ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE,
 452                                  SD.SplitValue, StartValue, "lisplit",
 453                                  Terminator);
 454   Instruction *C2 = new ICmpInst(SignedPredicate ?
 455                                  ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT,
 456                                  SD.SplitValue, ExitValue, "lisplit",
 457                                  Terminator);
 458   Instruction *NSplitCond = BinaryOperator::createAnd(C1, C2, "lisplit",
 459                                                       Terminator);
 460   SD.SplitCondition->replaceAllUsesWith(NSplitCond);
 461   SD.SplitCondition->eraseFromParent();
 462
 463   // Now, clear latch block. Remove instructions that are responsible
 464   // to increment induction variable.
 465   Instruction *LTerminator = Latch->getTerminator();
 466   for (BasicBlock::iterator LB = Latch->begin(), LE = Latch->end();
 467        LB != LE; ) {
 468     Instruction *I = LB;
 469     ++LB;
 470     if (isa<PHINode>(I) || I == LTerminator)
 471       continue;
 472
 473     if (I == IndVarIncrement)
 474       I->replaceAllUsesWith(ExitValue);
 475     else
 476       I->replaceAllUsesWith(UndefValue::get(I->getType()));
 477     I->eraseFromParent();
 478   }
 479
 480   LPM->deleteLoopFromQueue(L);
 481
 482   // Update Dominator Info.
 483   // Only CFG change done is to remove Latch to Header edge. This
 484   // does not change dominator tree because Latch did not dominate
 485   // Header.
 486   if (DF) {
 487     DominanceFrontier::iterator HeaderDF = DF->find(Header);
 488     if (HeaderDF != DF->end())
 489       DF->removeFromFrontier(HeaderDF, Header);
 490
 491     DominanceFrontier::iterator LatchDF = DF->find(Latch);
 492     if (LatchDF != DF->end())
 493       DF->removeFromFrontier(LatchDF, Header);
 494   }
 495   return true;
 496 }
 497
 498 // If loop header includes loop variant instruction operands then
 499 // this loop can not be eliminated. This is used by processOneIterationLoop().
 500 bool LoopIndexSplit::safeHeader(SplitInfo &SD, BasicBlock *Header) {
 501
 502   Instruction *Terminator = Header->getTerminator();
 503   for(BasicBlock::iterator BI = Header->begin(), BE = Header->end();
 504       BI != BE; ++BI) {
 505     Instruction *I = BI;
 506
 507     // PHI Nodes are OK.
 508     if (isa<PHINode>(I))
 509       continue;
 510
 511     // SplitCondition itself is OK.
 512     if (I == SD.SplitCondition)
 513       continue;
 514
 515     // Induction variable is OK.
 516     if (I == IndVar)
 517       continue;
 518
 519     // Induction variable increment is OK.
 520     if (I == IndVarIncrement)
 521       continue;
 522
 523     // Terminator is also harmless.
 524     if (I == Terminator)
 525       continue;
 526
 527     // Otherwise we have a instruction that may not be safe.
 528     return false;
 529   }
 530
 531   return true;
 532 }
 533
 534 // If Exit block includes loop variant instructions then this
 535 // loop may not be eliminated. This is used by processOneIterationLoop().
 536 bool LoopIndexSplit::safeExitBlock(SplitInfo &SD, BasicBlock *ExitBlock) {
 537
 538   for (BasicBlock::iterator BI = ExitBlock->begin(), BE = ExitBlock->end();
 539        BI != BE; ++BI) {
 540     Instruction *I = BI;
 541
 542     // PHI Nodes are OK.
 543     if (isa<PHINode>(I))
 544       continue;
 545
 546     // Induction variable increment is OK.
 547     if (IndVarIncrement && IndVarIncrement == I)
 548       continue;
 549
 550     // Check if I is induction variable increment instruction.
 551     if (!IndVarIncrement && I->getOpcode() == Instruction::Add) {
 552
 553       Value *Op0 = I->getOperand(0);
 554       Value *Op1 = I->getOperand(1);
 555       PHINode *PN = NULL;
 556       ConstantInt *CI = NULL;
 557
 558       if ((PN = dyn_cast<PHINode>(Op0))) {
 559         if ((CI = dyn_cast<ConstantInt>(Op1)))
 560           IndVarIncrement = I;
 561       } else
 562         if ((PN = dyn_cast<PHINode>(Op1))) {
 563           if ((CI = dyn_cast<ConstantInt>(Op0)))
 564             IndVarIncrement = I;
 565       }
 566
 567       if (IndVarIncrement && PN == IndVar && CI->isOne())
 568         continue;
 569     }
 570
 571     // I is an Exit condition if next instruction is block terminator.
 572     // Exit condition is OK if it compares loop invariant exit value,
 573     // which is checked below.
 574     else if (ICmpInst *EC = dyn_cast<ICmpInst>(I)) {
 575       if (EC == ExitCondition)
 576         continue;
 577     }
 578
 579     if (I == ExitBlock->getTerminator())
 580       continue;
 581
 582     // Otherwise we have instruction that may not be safe.
 583     return false;
 584   }
 585
 586   // We could not find any reason to consider ExitBlock unsafe.
 587   return true;
 588 }
 589
 590 /// Find cost of spliting loop L. Cost is measured in terms of size growth.
 591 /// Size is growth is calculated based on amount of code duplicated in second
 592 /// loop.
 593 unsigned LoopIndexSplit::findSplitCost(Loop *L, SplitInfo &SD) {
 594
 595   unsigned Cost = 0;
 596   BasicBlock *SDBlock = SD.SplitCondition->getParent();
 597   for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
 598        I != E; ++I) {
 599     BasicBlock *BB = *I;
 600     // If a block is not dominated by split condition block then
 601     // it must be duplicated in both loops.
 602     if (!DT->dominates(SDBlock, BB))
 603       Cost += BB->size();
 604   }
 605
 606   return Cost;
 607 }
 608
 609 /// removeBlocks - Remove basic block DeadBB and all blocks dominated by DeadBB.
 610 /// This routine is used to remove split condition's dead branch, dominated by
 611 /// DeadBB. LiveBB dominates split conidition's other branch.
 612 void LoopIndexSplit::removeBlocks(BasicBlock *DeadBB, Loop *LP,
 613                                   BasicBlock *LiveBB) {
 614
 615   // First update DeadBB's dominance frontier.
 616   SmallVector<BasicBlock *, 8> FrontierBBs;
 617   DominanceFrontier::iterator DeadBBDF = DF->find(DeadBB);
 618   if (DeadBBDF != DF->end()) {
 619     SmallVector<BasicBlock *, 8> PredBlocks;
 620
 621     DominanceFrontier::DomSetType DeadBBSet = DeadBBDF->second;
 622     for (DominanceFrontier::DomSetType::iterator DeadBBSetI = DeadBBSet.begin(),
 623            DeadBBSetE = DeadBBSet.end(); DeadBBSetI != DeadBBSetE; ++DeadBBSetI) {
 624       BasicBlock *FrontierBB = *DeadBBSetI;
 625       FrontierBBs.push_back(FrontierBB);
 626
 627       // Rremove any PHI incoming edge from blocks dominated by DeadBB.
 628       PredBlocks.clear();
 629       for(pred_iterator PI = pred_begin(FrontierBB), PE = pred_end(FrontierBB);
 630           PI != PE; ++PI) {
 631         BasicBlock *P = *PI;
 632         if (P == DeadBB || DT->dominates(DeadBB, P))
 633           PredBlocks.push_back(P);
 634       }
 635
 636       BasicBlock *NewDominator = NULL;
 637       for(BasicBlock::iterator FBI = FrontierBB->begin(), FBE = FrontierBB->end();
 638           FBI != FBE; ++FBI) {
 639         if (PHINode *PN = dyn_cast<PHINode>(FBI)) {
 640           for(SmallVector<BasicBlock *, 8>::iterator PI = PredBlocks.begin(),
 641                 PE = PredBlocks.end(); PI != PE; ++PI) {
 642             BasicBlock *P = *PI;
 643             PN->removeIncomingValue(P);
 644           }
 645           // If we have not identified new dominator then see if we can identify
 646           // one based on remaining incoming PHINode values.
 647           if (NewDominator == NULL && PN->getNumIncomingValues() == 1)
 648             NewDominator = PN->getIncomingBlock(0);
 649         }
 650         else
 651           break;
 652       }
 653     }
 654   }
 655
 656   // Now remove DeadBB and all nodes dominated by DeadBB in df order.
 657   SmallVector<BasicBlock *, 32> WorkList;
 658   DomTreeNode *DN = DT->getNode(DeadBB);
 659   for (df_iterator<DomTreeNode*> DI = df_begin(DN),
 660          E = df_end(DN); DI != E; ++DI) {
 661     BasicBlock *BB = DI->getBlock();
 662     WorkList.push_back(BB);
 663     BB->replaceAllUsesWith(UndefValue::get(Type::LabelTy));
 664   }
 665
 666   while (!WorkList.empty()) {
 667     BasicBlock *BB = WorkList.back(); WorkList.pop_back();
 668     for(BasicBlock::iterator BBI = BB->begin(), BBE = BB->end();
 669         BBI != BBE; ++BBI) {
 670       Instruction *I = BBI;
 671       I->replaceAllUsesWith(UndefValue::get(I->getType()));
 672       I->eraseFromParent();
 673     }
 674     LPM->deleteSimpleAnalysisValue(BB, LP);
 675     DT->eraseNode(BB);
 676     DF->removeBlock(BB);
 677     LI->removeBlock(BB);
 678     BB->eraseFromParent();
 679   }
 680
 681   // Update Frontier BBs' dominator info.
 682   while (!FrontierBBs.empty()) {
 683     BasicBlock *FBB = FrontierBBs.back(); FrontierBBs.pop_back();
 684     BasicBlock *NewDominator = FBB->getSinglePredecessor();
 685     if (!NewDominator) {
 686       pred_iterator PI = pred_begin(FBB), PE = pred_end(FBB);
 687       NewDominator = *PI;
 688       ++PI;
 689       if (NewDominator != LiveBB) {
 690         for(; PI != PE; ++PI) {
 691           BasicBlock *P = *PI;
 692           if (P == LiveBB) {
 693             NewDominator = LiveBB;
 694             break;
 695           }
 696           NewDominator = DT->findNearestCommonDominator(NewDominator, P);
 697         }
 698       }
 699     }
 700     assert (NewDominator && "Unable to fix dominator info.");
 701     DT->changeImmediateDominator(FBB, NewDominator);
 702     DF->changeImmediateDominator(FBB, NewDominator, DT);
 703   }
 704
 705 }
 706
 707 bool LoopIndexSplit::splitLoop(SplitInfo &SD) {
 708
 709   BasicBlock *Preheader = L->getLoopPreheader();
 710   BasicBlock *SplitBlock = SD.SplitCondition->getParent();
 711   BasicBlock *Latch = L->getLoopLatch();
 712   BasicBlock *Header = L->getHeader();
 713   BranchInst *SplitTerminator = cast<BranchInst>(SplitBlock->getTerminator());
 714
 715   // FIXME - Unable to handle triange loops at the moment.
 716   // In triangle loop, split condition is in header and one of the
 717   // the split destination is loop latch. If split condition is EQ
 718   // then such loops are already handle in processOneIterationLoop().
 719   if (Header == SplitBlock
 720       && (Latch == SplitTerminator->getSuccessor(0)
 721           || Latch == SplitTerminator->getSuccessor(1)))
 722     return false;
 723
 724   // If one of the split condition branch is post dominating other then loop
 725   // index split is not appropriate.
 726   BasicBlock *Succ0 = SplitTerminator->getSuccessor(0);
 727   BasicBlock *Succ1 = SplitTerminator->getSuccessor(1);
 728   if (DT->dominates(Succ0, Latch) || DT->dominates(Succ1, Latch))
 729     return false;
 730
 731   // If one of the split condition branch is a predecessor of the other
 732   // split condition branch head then do not split loop on this condition.
 733   for(pred_iterator PI = pred_begin(Succ0), PE = pred_end(Succ0); PI != PE; ++PI)
 734     if (Succ1 == *PI)
 735       return false;
 736   for(pred_iterator PI = pred_begin(Succ1), PE = pred_end(Succ1); PI != PE; ++PI)
 737     if (Succ0 == *PI)
 738       return false;
 739
 740   // True loop is original loop. False loop is cloned loop.
 741
 742   bool SignedPredicate = ExitCondition->isSignedPredicate();
 743   //[*] Calculate True loop's new Exit Value in loop preheader.
 744   //      TLExitValue = min(SplitValue, ExitValue)
 745   //[*] Calculate False loop's new Start Value in loop preheader.
 746   //      FLStartValue = min(SplitValue, TrueLoop.StartValue)
 747   Value *TLExitValue = NULL;
 748   Value *FLStartValue = NULL;
 749   if (isa<ConstantInt>(SD.SplitValue)) {
 750     TLExitValue = SD.SplitValue;
 751     FLStartValue = SD.SplitValue;
 752   }
 753   else {
 754     Value *C1 = new ICmpInst(SignedPredicate ?
 755                             ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT,
 756                             SD.SplitValue,
 757                              ExitCondition->getOperand(ExitValueNum),
 758                              "lsplit.ev",
 759                             Preheader->getTerminator());
 760     TLExitValue = new SelectInst(C1, SD.SplitValue,
 761                                  ExitCondition->getOperand(ExitValueNum),
 762                                  "lsplit.ev", Preheader->getTerminator());
 763
 764     Value *C2 = new ICmpInst(SignedPredicate ?
 765                              ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT,
 766                              SD.SplitValue, StartValue, "lsplit.sv",
 767                              Preheader->getTerminator());
 768     FLStartValue = new SelectInst(C2, SD.SplitValue, StartValue,
 769                                   "lsplit.sv", Preheader->getTerminator());
 770   }
 771
 772   //[*] Clone loop. Avoid true destination of split condition and
 773   //    the blocks dominated by true destination.
 774   DenseMap<const Value *, Value *> ValueMap;
 775   Loop *FalseLoop = CloneLoop(L, LPM, LI, ValueMap, this);
 776   BasicBlock *FalseHeader = FalseLoop->getHeader();
 777
 778   //[*] True loop's exit edge enters False loop.
 779   PHINode *IndVarClone = cast<PHINode>(ValueMap[IndVar]);
 780   BasicBlock *ExitBlock = ExitCondition->getParent();
 781   BranchInst *ExitInsn = dyn_cast<BranchInst>(ExitBlock->getTerminator());
 782   assert (ExitInsn && "Unable to find suitable loop exit branch");
 783   BasicBlock *ExitDest = ExitInsn->getSuccessor(1);
 784
 785   if (L->contains(ExitDest)) {
 786     ExitDest = ExitInsn->getSuccessor(0);
 787     ExitInsn->setSuccessor(0, FalseHeader);
 788   } else
 789     ExitInsn->setSuccessor(1, FalseHeader);
 790
 791   // Collect inverse map of Header PHINodes.
 792   DenseMap<Value *, Value *> InverseMap;
 793   for (BasicBlock::iterator BI = L->getHeader()->begin(),
 794          BE = L->getHeader()->end(); BI != BE; ++BI) {
 795     if (PHINode *PN = dyn_cast<PHINode>(BI)) {
 796       PHINode *PNClone = cast<PHINode>(ValueMap[PN]);
 797       InverseMap[PNClone] = PN;
 798     } else
 799       break;
 800   }
 801
 802   // Update False loop's header
 803   for (BasicBlock::iterator BI = FalseHeader->begin(), BE = FalseHeader->end();
 804        BI != BE; ++BI) {
 805     if (PHINode *PN = dyn_cast<PHINode>(BI)) {
 806       PN->removeIncomingValue(Preheader);
 807       if (PN == IndVarClone)
 808         PN->addIncoming(FLStartValue, ExitBlock);
 809       else {
 810         PHINode *OrigPN = cast<PHINode>(InverseMap[PN]);
 811         Value *V2 = OrigPN->getIncomingValueForBlock(ExitBlock);
 812         PN->addIncoming(V2, ExitBlock);
 813       }
 814     } else
 815       break;
 816   }
 817
 818   // Update ExitDest. Now it's predecessor is False loop's exit block.
 819   BasicBlock *ExitBlockClone = cast<BasicBlock>(ValueMap[ExitBlock]);
 820   for (BasicBlock::iterator BI = ExitDest->begin(), BE = ExitDest->end();
 821        BI != BE; ++BI) {
 822     if (PHINode *PN = dyn_cast<PHINode>(BI)) {
 823       PN->addIncoming(ValueMap[PN->getIncomingValueForBlock(ExitBlock)], ExitBlockClone);
 824       PN->removeIncomingValue(ExitBlock);
 825     } else
 826       break;
 827   }
 828
 829   if (DT) {
 830     DT->changeImmediateDominator(FalseHeader, ExitBlock);
 831     DT->changeImmediateDominator(ExitDest, cast<BasicBlock>(ValueMap[ExitBlock]));
 832   }
 833
 834   assert (!L->contains(ExitDest) && " Unable to find exit edge destination");
 835
 836   //[*] Split Exit Edge.
 837   SplitEdge(ExitBlock, FalseHeader, this);
 838
 839   //[*] Eliminate split condition's false branch from True loop.
 840   BranchInst *BR = cast<BranchInst>(SplitBlock->getTerminator());
 841   BasicBlock *FBB = BR->getSuccessor(1);
 842   BR->setUnconditionalDest(BR->getSuccessor(0));
 843   removeBlocks(FBB, L, BR->getSuccessor(0));
 844
 845   //[*] Update True loop's exit value using new exit value.
 846   ExitCondition->setOperand(ExitValueNum, TLExitValue);
 847
 848   //[*] Eliminate split condition's  true branch in False loop CFG.
 849   BasicBlock *FSplitBlock = cast<BasicBlock>(ValueMap[SplitBlock]);
 850   BranchInst *FBR = cast<BranchInst>(FSplitBlock->getTerminator());
 851   BasicBlock *TBB = FBR->getSuccessor(0);
 852   FBR->setUnconditionalDest(FBR->getSuccessor(1));
 853   removeBlocks(TBB, FalseLoop, cast<BasicBlock>(FBR->getSuccessor(0)));
 854
 855   return true;
 856 }
 857