1 //===- LoopSimplify.cpp - Loop Canonicalization Pass ----------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This pass performs several transformations to transform natural loops into a
11 // simpler form, which makes subsequent analyses and transformations simpler and
14 // Loop pre-header insertion guarantees that there is a single, non-critical
15 // entry edge from outside of the loop to the loop header. This simplifies a
16 // number of analyses and transformations, such as LICM.
18 // Loop exit-block insertion guarantees that all exit blocks from the loop
19 // (blocks which are outside of the loop that have predecessors inside of the
20 // loop) only have predecessors from inside of the loop (and are thus dominated
21 // by the loop header). This simplifies transformations such as store-sinking
22 // that are built into LICM.
24 // This pass also guarantees that loops will have exactly one backedge.
26 // Note that the simplifycfg pass will clean up blocks which are split out but
27 // end up being unnecessary, so usage of this pass should not pessimize
30 // This pass obviously modifies the CFG, but updates loop information and
31 // dominator information.
33 //===----------------------------------------------------------------------===//
35 #define DEBUG_TYPE "loopsimplify"
36 #include "llvm/Transforms/Scalar.h"
37 #include "llvm/Constants.h"
38 #include "llvm/Instructions.h"
39 #include "llvm/Function.h"
40 #include "llvm/Type.h"
41 #include "llvm/Analysis/AliasAnalysis.h"
42 #include "llvm/Analysis/Dominators.h"
43 #include "llvm/Analysis/LoopInfo.h"
44 #include "llvm/Support/CFG.h"
45 #include "llvm/Support/Compiler.h"
46 #include "llvm/ADT/SetOperations.h"
47 #include "llvm/ADT/SetVector.h"
48 #include "llvm/ADT/Statistic.h"
49 #include "llvm/ADT/DepthFirstIterator.h"
52 STATISTIC(NumInserted, "Number of pre-header or exit blocks inserted");
53 STATISTIC(NumNested , "Number of nested loops split out");
56 struct VISIBILITY_HIDDEN LoopSimplify : public FunctionPass {
57 static char ID; // Pass identification, replacement for typeid
58 LoopSimplify() : FunctionPass((intptr_t)&ID) {}
60 // AA - If we have an alias analysis object to update, this is it, otherwise
65 virtual bool runOnFunction(Function &F);
67 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
68 // We need loop information to identify the loops...
69 AU.addRequired<LoopInfo>();
70 AU.addRequired<DominatorTree>();
72 AU.addPreserved<LoopInfo>();
73 AU.addPreserved<DominatorTree>();
74 AU.addPreserved<DominanceFrontier>();
75 AU.addPreservedID(BreakCriticalEdgesID); // No critical edges added.
78 /// verifyAnalysis() - Verify loop nest.
79 void verifyAnalysis() const {
81 LoopInfo *NLI = &getAnalysis<LoopInfo>();
82 for (LoopInfo::iterator I = NLI->begin(), E = NLI->end(); I != E; ++I)
88 bool ProcessLoop(Loop *L);
89 BasicBlock *SplitBlockPredecessors(BasicBlock *BB, const char *Suffix,
90 const std::vector<BasicBlock*> &Preds);
91 BasicBlock *RewriteLoopExitBlock(Loop *L, BasicBlock *Exit);
92 void InsertPreheaderForLoop(Loop *L);
93 Loop *SeparateNestedLoop(Loop *L);
94 void InsertUniqueBackedgeBlock(Loop *L);
95 void PlaceSplitBlockCarefully(BasicBlock *NewBB,
96 std::vector<BasicBlock*> &SplitPreds,
100 char LoopSimplify::ID = 0;
101 RegisterPass<LoopSimplify>
102 X("loopsimplify", "Canonicalize natural loops", true);
105 // Publically exposed interface to pass...
106 const PassInfo *llvm::LoopSimplifyID = X.getPassInfo();
107 FunctionPass *llvm::createLoopSimplifyPass() { return new LoopSimplify(); }
109 /// runOnFunction - Run down all loops in the CFG (recursively, but we could do
110 /// it in any convenient order) inserting preheaders...
112 bool LoopSimplify::runOnFunction(Function &F) {
113 bool Changed = false;
114 LI = &getAnalysis<LoopInfo>();
115 AA = getAnalysisToUpdate<AliasAnalysis>();
116 DT = &getAnalysis<DominatorTree>();
118 // Check to see that no blocks (other than the header) in loops have
119 // predecessors that are not in loops. This is not valid for natural loops,
120 // but can occur if the blocks are unreachable. Since they are unreachable we
121 // can just shamelessly destroy their terminators to make them not branch into
123 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
124 // This case can only occur for unreachable blocks. Blocks that are
125 // unreachable can't be in loops, so filter those blocks out.
126 if (LI->getLoopFor(BB)) continue;
128 bool BlockUnreachable = false;
130 // Check to see if any successors of this block are non-loop-header loops
131 // that are not the header.
132 for (succ_iterator I = succ_begin(BB), E = succ_end(BB); I != E; ++I) {
133 // If this successor is not in a loop, BB is clearly ok.
134 Loop *L = LI->getLoopFor(*I);
137 // If the succ is the loop header, and if L is a top-level loop, then this
138 // is an entrance into a loop through the header, which is also ok.
139 if (L->getHeader() == *I && L->getParentLoop() == 0)
142 // Otherwise, this is an entrance into a loop from some place invalid.
143 // Either the loop structure is invalid and this is not a natural loop (in
144 // which case the compiler is buggy somewhere else) or BB is unreachable.
145 BlockUnreachable = true;
149 // If this block is ok, check the next one.
150 if (!BlockUnreachable) continue;
152 // Otherwise, this block is dead. To clean up the CFG and to allow later
153 // loop transformations to ignore this case, we delete the edges into the
154 // loop by replacing the terminator.
156 // Remove PHI entries from the successors.
157 for (succ_iterator I = succ_begin(BB), E = succ_end(BB); I != E; ++I)
158 (*I)->removePredecessor(BB);
160 // Add a new unreachable instruction before the old terminator.
161 TerminatorInst *TI = BB->getTerminator();
162 new UnreachableInst(TI);
164 // Delete the dead terminator.
165 if (AA) AA->deleteValue(TI);
166 if (!TI->use_empty())
167 TI->replaceAllUsesWith(UndefValue::get(TI->getType()));
168 TI->eraseFromParent();
172 for (LoopInfo::iterator I = LI->begin(), E = LI->end(); I != E; ++I)
173 Changed |= ProcessLoop(*I);
178 /// ProcessLoop - Walk the loop structure in depth first order, ensuring that
179 /// all loops have preheaders.
181 bool LoopSimplify::ProcessLoop(Loop *L) {
182 bool Changed = false;
185 // Canonicalize inner loops before outer loops. Inner loop canonicalization
186 // can provide work for the outer loop to canonicalize.
187 for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
188 Changed |= ProcessLoop(*I);
190 assert(L->getBlocks()[0] == L->getHeader() &&
191 "Header isn't first block in loop?");
193 // Does the loop already have a preheader? If so, don't insert one.
194 if (L->getLoopPreheader() == 0) {
195 InsertPreheaderForLoop(L);
200 // Next, check to make sure that all exit nodes of the loop only have
201 // predecessors that are inside of the loop. This check guarantees that the
202 // loop preheader/header will dominate the exit blocks. If the exit block has
203 // predecessors from outside of the loop, split the edge now.
204 SmallVector<BasicBlock*, 8> ExitBlocks;
205 L->getExitBlocks(ExitBlocks);
207 SetVector<BasicBlock*> ExitBlockSet(ExitBlocks.begin(), ExitBlocks.end());
208 for (SetVector<BasicBlock*>::iterator I = ExitBlockSet.begin(),
209 E = ExitBlockSet.end(); I != E; ++I) {
210 BasicBlock *ExitBlock = *I;
211 for (pred_iterator PI = pred_begin(ExitBlock), PE = pred_end(ExitBlock);
213 // Must be exactly this loop: no subloops, parent loops, or non-loop preds
215 if (!L->contains(*PI)) {
216 RewriteLoopExitBlock(L, ExitBlock);
223 // If the header has more than two predecessors at this point (from the
224 // preheader and from multiple backedges), we must adjust the loop.
225 unsigned NumBackedges = L->getNumBackEdges();
226 if (NumBackedges != 1) {
227 // If this is really a nested loop, rip it out into a child loop. Don't do
228 // this for loops with a giant number of backedges, just factor them into a
229 // common backedge instead.
230 if (NumBackedges < 8) {
231 if (Loop *NL = SeparateNestedLoop(L)) {
233 // This is a big restructuring change, reprocess the whole loop.
236 // GCC doesn't tail recursion eliminate this.
241 // If we either couldn't, or didn't want to, identify nesting of the loops,
242 // insert a new block that all backedges target, then make it jump to the
244 InsertUniqueBackedgeBlock(L);
249 // Scan over the PHI nodes in the loop header. Since they now have only two
250 // incoming values (the loop is canonicalized), we may have simplified the PHI
251 // down to 'X = phi [X, Y]', which should be replaced with 'Y'.
253 for (BasicBlock::iterator I = L->getHeader()->begin();
254 (PN = dyn_cast<PHINode>(I++)); )
255 if (Value *V = PN->hasConstantValue()) {
256 PN->replaceAllUsesWith(V);
257 PN->eraseFromParent();
263 /// SplitBlockPredecessors - Split the specified block into two blocks. We want
264 /// to move the predecessors specified in the Preds list to point to the new
265 /// block, leaving the remaining predecessors pointing to BB. This method
266 /// updates the SSA PHINode's and AliasAnalysis, but no other analyses.
268 BasicBlock *LoopSimplify::SplitBlockPredecessors(BasicBlock *BB,
270 const std::vector<BasicBlock*> &Preds) {
272 // Create new basic block, insert right before the original block...
274 BasicBlock::Create(BB->getName()+Suffix, BB->getParent(), BB);
276 // The preheader first gets an unconditional branch to the loop header...
277 BranchInst *BI = BranchInst::Create(BB, NewBB);
279 // For every PHI node in the block, insert a PHI node into NewBB where the
280 // incoming values from the out of loop edges are moved to NewBB. We have two
281 // possible cases here. If the loop is dead, we just insert dummy entries
282 // into the PHI nodes for the new edge. If the loop is not dead, we move the
283 // incoming edges in BB into new PHI nodes in NewBB.
285 if (Preds.empty()) { // Is the loop obviously dead?
286 for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++I) {
287 PHINode *PN = cast<PHINode>(I);
288 // Insert dummy values as the incoming value...
289 PN->addIncoming(Constant::getNullValue(PN->getType()), NewBB);
294 // Check to see if the values being merged into the new block need PHI
295 // nodes. If so, insert them.
296 for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ) {
297 PHINode *PN = cast<PHINode>(I);
300 // Check to see if all of the values coming in are the same. If so, we
301 // don't need to create a new PHI node.
302 Value *InVal = PN->getIncomingValueForBlock(Preds[0]);
303 for (unsigned i = 1, e = Preds.size(); i != e; ++i)
304 if (InVal != PN->getIncomingValueForBlock(Preds[i])) {
309 // If the values coming into the block are not the same, we need a PHI.
311 // Create the new PHI node, insert it into NewBB at the end of the block
313 PHINode::Create(PN->getType(), PN->getName()+".ph", BI);
314 if (AA) AA->copyValue(PN, NewPHI);
316 // Move all of the edges from blocks outside the loop to the new PHI
317 for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
318 Value *V = PN->removeIncomingValue(Preds[i], false);
319 NewPHI->addIncoming(V, Preds[i]);
323 // Remove all of the edges coming into the PHI nodes from outside of the
325 for (unsigned i = 0, e = Preds.size(); i != e; ++i)
326 PN->removeIncomingValue(Preds[i], false);
329 // Add an incoming value to the PHI node in the loop for the preheader
331 PN->addIncoming(InVal, NewBB);
333 // Can we eliminate this phi node now?
334 if (Value *V = PN->hasConstantValue(true)) {
335 Instruction *I = dyn_cast<Instruction>(V);
336 // If I is in NewBB, the Dominator call will fail, because NewBB isn't
337 // registered in DominatorTree yet. Handle this case explicitly.
338 if (!I || (I->getParent() != NewBB &&
339 getAnalysis<DominatorTree>().dominates(I, PN))) {
340 PN->replaceAllUsesWith(V);
341 if (AA) AA->deleteValue(PN);
342 BB->getInstList().erase(PN);
347 // Now that the PHI nodes are updated, actually move the edges from
348 // Preds to point to NewBB instead of BB.
350 for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
351 TerminatorInst *TI = Preds[i]->getTerminator();
352 for (unsigned s = 0, e = TI->getNumSuccessors(); s != e; ++s)
353 if (TI->getSuccessor(s) == BB)
354 TI->setSuccessor(s, NewBB);
356 if (Preds[i]->getUnwindDest() == BB)
357 Preds[i]->setUnwindDest(NewBB);
363 /// InsertPreheaderForLoop - Once we discover that a loop doesn't have a
364 /// preheader, this method is called to insert one. This method has two phases:
365 /// preheader insertion and analysis updating.
367 void LoopSimplify::InsertPreheaderForLoop(Loop *L) {
368 BasicBlock *Header = L->getHeader();
370 // Compute the set of predecessors of the loop that are not in the loop.
371 std::vector<BasicBlock*> OutsideBlocks;
372 for (pred_iterator PI = pred_begin(Header), PE = pred_end(Header);
374 if (!L->contains(*PI)) // Coming in from outside the loop?
375 OutsideBlocks.push_back(*PI); // Keep track of it...
377 // Split out the loop pre-header.
379 SplitBlockPredecessors(Header, ".preheader", OutsideBlocks);
382 //===--------------------------------------------------------------------===//
383 // Update analysis results now that we have performed the transformation
386 // We know that we have loop information to update... update it now.
387 if (Loop *Parent = L->getParentLoop())
388 Parent->addBasicBlockToLoop(NewBB, LI->getBase());
390 DT->splitBlock(NewBB);
391 if (DominanceFrontier *DF = getAnalysisToUpdate<DominanceFrontier>())
392 DF->splitBlock(NewBB);
394 // Make sure that NewBB is put someplace intelligent, which doesn't mess up
395 // code layout too horribly.
396 PlaceSplitBlockCarefully(NewBB, OutsideBlocks, L);
399 /// RewriteLoopExitBlock - Ensure that the loop preheader dominates all exit
400 /// blocks. This method is used to split exit blocks that have predecessors
401 /// outside of the loop.
402 BasicBlock *LoopSimplify::RewriteLoopExitBlock(Loop *L, BasicBlock *Exit) {
403 std::vector<BasicBlock*> LoopBlocks;
404 for (pred_iterator I = pred_begin(Exit), E = pred_end(Exit); I != E; ++I)
406 LoopBlocks.push_back(*I);
408 assert(!LoopBlocks.empty() && "No edges coming in from outside the loop?");
409 BasicBlock *NewBB = SplitBlockPredecessors(Exit, ".loopexit", LoopBlocks);
411 // Update Loop Information - we know that the new block will be in whichever
412 // loop the Exit block is in. Note that it may not be in that immediate loop,
413 // if the successor is some other loop header. In that case, we continue
414 // walking up the loop tree to find a loop that contains both the successor
415 // block and the predecessor block.
416 Loop *SuccLoop = LI->getLoopFor(Exit);
417 while (SuccLoop && !SuccLoop->contains(L->getHeader()))
418 SuccLoop = SuccLoop->getParentLoop();
420 SuccLoop->addBasicBlockToLoop(NewBB, LI->getBase());
422 // Update Dominator Information
423 DT->splitBlock(NewBB);
424 if (DominanceFrontier *DF = getAnalysisToUpdate<DominanceFrontier>())
425 DF->splitBlock(NewBB);
430 /// AddBlockAndPredsToSet - Add the specified block, and all of its
431 /// predecessors, to the specified set, if it's not already in there. Stop
432 /// predecessor traversal when we reach StopBlock.
433 static void AddBlockAndPredsToSet(BasicBlock *InputBB, BasicBlock *StopBlock,
434 std::set<BasicBlock*> &Blocks) {
435 std::vector<BasicBlock *> WorkList;
436 WorkList.push_back(InputBB);
438 BasicBlock *BB = WorkList.back(); WorkList.pop_back();
439 if (Blocks.insert(BB).second && BB != StopBlock)
440 // If BB is not already processed and it is not a stop block then
441 // insert its predecessor in the work list
442 for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
443 BasicBlock *WBB = *I;
444 WorkList.push_back(WBB);
446 } while(!WorkList.empty());
449 /// FindPHIToPartitionLoops - The first part of loop-nestification is to find a
450 /// PHI node that tells us how to partition the loops.
451 static PHINode *FindPHIToPartitionLoops(Loop *L, DominatorTree *DT,
453 for (BasicBlock::iterator I = L->getHeader()->begin(); isa<PHINode>(I); ) {
454 PHINode *PN = cast<PHINode>(I);
456 if (Value *V = PN->hasConstantValue())
457 if (!isa<Instruction>(V) || DT->dominates(cast<Instruction>(V), PN)) {
458 // This is a degenerate PHI already, don't modify it!
459 PN->replaceAllUsesWith(V);
460 if (AA) AA->deleteValue(PN);
461 PN->eraseFromParent();
465 // Scan this PHI node looking for a use of the PHI node by itself.
466 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
467 if (PN->getIncomingValue(i) == PN &&
468 L->contains(PN->getIncomingBlock(i)))
469 // We found something tasty to remove.
475 // PlaceSplitBlockCarefully - If the block isn't already, move the new block to
476 // right after some 'outside block' block. This prevents the preheader from
477 // being placed inside the loop body, e.g. when the loop hasn't been rotated.
478 void LoopSimplify::PlaceSplitBlockCarefully(BasicBlock *NewBB,
479 std::vector<BasicBlock*>&SplitPreds,
481 // Check to see if NewBB is already well placed.
482 Function::iterator BBI = NewBB; --BBI;
483 for (unsigned i = 0, e = SplitPreds.size(); i != e; ++i) {
484 if (&*BBI == SplitPreds[i])
488 // If it isn't already after an outside block, move it after one. This is
489 // always good as it makes the uncond branch from the outside block into a
492 // Figure out *which* outside block to put this after. Prefer an outside
493 // block that neighbors a BB actually in the loop.
494 BasicBlock *FoundBB = 0;
495 for (unsigned i = 0, e = SplitPreds.size(); i != e; ++i) {
496 Function::iterator BBI = SplitPreds[i];
497 if (++BBI != NewBB->getParent()->end() &&
499 FoundBB = SplitPreds[i];
504 // If our heuristic for a *good* bb to place this after doesn't find
505 // anything, just pick something. It's likely better than leaving it within
508 FoundBB = SplitPreds[0];
509 NewBB->moveAfter(FoundBB);
513 /// SeparateNestedLoop - If this loop has multiple backedges, try to pull one of
514 /// them out into a nested loop. This is important for code that looks like
519 /// br cond, Loop, Next
521 /// br cond2, Loop, Out
523 /// To identify this common case, we look at the PHI nodes in the header of the
524 /// loop. PHI nodes with unchanging values on one backedge correspond to values
525 /// that change in the "outer" loop, but not in the "inner" loop.
527 /// If we are able to separate out a loop, return the new outer loop that was
530 Loop *LoopSimplify::SeparateNestedLoop(Loop *L) {
531 PHINode *PN = FindPHIToPartitionLoops(L, DT, AA);
532 if (PN == 0) return 0; // No known way to partition.
534 // Pull out all predecessors that have varying values in the loop. This
535 // handles the case when a PHI node has multiple instances of itself as
537 std::vector<BasicBlock*> OuterLoopPreds;
538 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
539 if (PN->getIncomingValue(i) != PN ||
540 !L->contains(PN->getIncomingBlock(i)))
541 OuterLoopPreds.push_back(PN->getIncomingBlock(i));
543 BasicBlock *Header = L->getHeader();
544 BasicBlock *NewBB = SplitBlockPredecessors(Header, ".outer", OuterLoopPreds);
546 // Update dominator information
547 DT->splitBlock(NewBB);
548 if (DominanceFrontier *DF = getAnalysisToUpdate<DominanceFrontier>())
549 DF->splitBlock(NewBB);
551 // Make sure that NewBB is put someplace intelligent, which doesn't mess up
552 // code layout too horribly.
553 PlaceSplitBlockCarefully(NewBB, OuterLoopPreds, L);
555 // Create the new outer loop.
556 Loop *NewOuter = new Loop();
558 // Change the parent loop to use the outer loop as its child now.
559 if (Loop *Parent = L->getParentLoop())
560 Parent->replaceChildLoopWith(L, NewOuter);
562 LI->changeTopLevelLoop(L, NewOuter);
564 // This block is going to be our new header block: add it to this loop and all
566 NewOuter->addBasicBlockToLoop(NewBB, LI->getBase());
568 // L is now a subloop of our outer loop.
569 NewOuter->addChildLoop(L);
571 for (unsigned i = 0, e = L->getBlocks().size(); i != e; ++i)
572 NewOuter->addBlockEntry(L->getBlocks()[i]);
574 // Determine which blocks should stay in L and which should be moved out to
575 // the Outer loop now.
576 std::set<BasicBlock*> BlocksInL;
577 for (pred_iterator PI = pred_begin(Header), E = pred_end(Header); PI!=E; ++PI)
578 if (DT->dominates(Header, *PI))
579 AddBlockAndPredsToSet(*PI, Header, BlocksInL);
582 // Scan all of the loop children of L, moving them to OuterLoop if they are
583 // not part of the inner loop.
584 const std::vector<Loop*> &SubLoops = L->getSubLoops();
585 for (size_t I = 0; I != SubLoops.size(); )
586 if (BlocksInL.count(SubLoops[I]->getHeader()))
587 ++I; // Loop remains in L
589 NewOuter->addChildLoop(L->removeChildLoop(SubLoops.begin() + I));
591 // Now that we know which blocks are in L and which need to be moved to
592 // OuterLoop, move any blocks that need it.
593 for (unsigned i = 0; i != L->getBlocks().size(); ++i) {
594 BasicBlock *BB = L->getBlocks()[i];
595 if (!BlocksInL.count(BB)) {
596 // Move this block to the parent, updating the exit blocks sets
597 L->removeBlockFromLoop(BB);
599 LI->changeLoopFor(BB, NewOuter);
609 /// InsertUniqueBackedgeBlock - This method is called when the specified loop
610 /// has more than one backedge in it. If this occurs, revector all of these
611 /// backedges to target a new basic block and have that block branch to the loop
612 /// header. This ensures that loops have exactly one backedge.
614 void LoopSimplify::InsertUniqueBackedgeBlock(Loop *L) {
615 assert(L->getNumBackEdges() > 1 && "Must have > 1 backedge!");
617 // Get information about the loop
618 BasicBlock *Preheader = L->getLoopPreheader();
619 BasicBlock *Header = L->getHeader();
620 Function *F = Header->getParent();
622 // Figure out which basic blocks contain back-edges to the loop header.
623 std::vector<BasicBlock*> BackedgeBlocks;
624 for (pred_iterator I = pred_begin(Header), E = pred_end(Header); I != E; ++I)
625 if (*I != Preheader) BackedgeBlocks.push_back(*I);
627 // Create and insert the new backedge block...
628 BasicBlock *BEBlock = BasicBlock::Create(Header->getName()+".backedge", F);
629 BranchInst *BETerminator = BranchInst::Create(Header, BEBlock);
631 // Move the new backedge block to right after the last backedge block.
632 Function::iterator InsertPos = BackedgeBlocks.back(); ++InsertPos;
633 F->getBasicBlockList().splice(InsertPos, F->getBasicBlockList(), BEBlock);
635 // Now that the block has been inserted into the function, create PHI nodes in
636 // the backedge block which correspond to any PHI nodes in the header block.
637 for (BasicBlock::iterator I = Header->begin(); isa<PHINode>(I); ++I) {
638 PHINode *PN = cast<PHINode>(I);
639 PHINode *NewPN = PHINode::Create(PN->getType(), PN->getName()+".be",
641 NewPN->reserveOperandSpace(BackedgeBlocks.size());
642 if (AA) AA->copyValue(PN, NewPN);
644 // Loop over the PHI node, moving all entries except the one for the
645 // preheader over to the new PHI node.
646 unsigned PreheaderIdx = ~0U;
647 bool HasUniqueIncomingValue = true;
648 Value *UniqueValue = 0;
649 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
650 BasicBlock *IBB = PN->getIncomingBlock(i);
651 Value *IV = PN->getIncomingValue(i);
652 if (IBB == Preheader) {
655 NewPN->addIncoming(IV, IBB);
656 if (HasUniqueIncomingValue) {
657 if (UniqueValue == 0)
659 else if (UniqueValue != IV)
660 HasUniqueIncomingValue = false;
665 // Delete all of the incoming values from the old PN except the preheader's
666 assert(PreheaderIdx != ~0U && "PHI has no preheader entry??");
667 if (PreheaderIdx != 0) {
668 PN->setIncomingValue(0, PN->getIncomingValue(PreheaderIdx));
669 PN->setIncomingBlock(0, PN->getIncomingBlock(PreheaderIdx));
671 // Nuke all entries except the zero'th.
672 for (unsigned i = 0, e = PN->getNumIncomingValues()-1; i != e; ++i)
673 PN->removeIncomingValue(e-i, false);
675 // Finally, add the newly constructed PHI node as the entry for the BEBlock.
676 PN->addIncoming(NewPN, BEBlock);
678 // As an optimization, if all incoming values in the new PhiNode (which is a
679 // subset of the incoming values of the old PHI node) have the same value,
680 // eliminate the PHI Node.
681 if (HasUniqueIncomingValue) {
682 NewPN->replaceAllUsesWith(UniqueValue);
683 if (AA) AA->deleteValue(NewPN);
684 BEBlock->getInstList().erase(NewPN);
688 // Now that all of the PHI nodes have been inserted and adjusted, modify the
689 // backedge blocks to branch to the BEBlock instead of the header.
690 for (unsigned i = 0, e = BackedgeBlocks.size(); i != e; ++i) {
691 TerminatorInst *TI = BackedgeBlocks[i]->getTerminator();
692 for (unsigned Op = 0, e = TI->getNumSuccessors(); Op != e; ++Op)
693 if (TI->getSuccessor(Op) == Header)
694 TI->setSuccessor(Op, BEBlock);
696 if (BackedgeBlocks[i]->getUnwindDest() == Header)
697 BackedgeBlocks[i]->setUnwindDest(BEBlock);
700 //===--- Update all analyses which we must preserve now -----------------===//
702 // Update Loop Information - we know that this block is now in the current
703 // loop and all parent loops.
704 L->addBasicBlockToLoop(BEBlock, LI->getBase());
706 // Update dominator information
707 DT->splitBlock(BEBlock);
708 if (DominanceFrontier *DF = getAnalysisToUpdate<DominanceFrontier>())
709 DF->splitBlock(BEBlock);