Tidy up BasicBlock::getFirstNonPHI, and change a bunch of places to
[oota-llvm.git] / lib / Transforms / Scalar / LoopRotation.cpp
1 //===- LoopRotation.cpp - Loop Rotation Pass ------------------------------===//
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 // This file implements Loop Rotation Pass.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #define DEBUG_TYPE "loop-rotate"
15
16 #include "llvm/Transforms/Scalar.h"
17 #include "llvm/Function.h"
18 #include "llvm/Instructions.h"
19 #include "llvm/Analysis/LoopInfo.h"
20 #include "llvm/Analysis/LoopPass.h"
21 #include "llvm/Analysis/Dominators.h"
22 #include "llvm/Analysis/ScalarEvolution.h"
23 #include "llvm/Transforms/Utils/Local.h"
24 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
25 #include "llvm/Support/CommandLine.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/ADT/Statistic.h"
28 #include "llvm/ADT/SmallVector.h"
29
30 using namespace llvm;
31
32 #define MAX_HEADER_SIZE 16
33
34 STATISTIC(NumRotated, "Number of loops rotated");
35 namespace {
36
37   class VISIBILITY_HIDDEN RenameData {
38   public:
39     RenameData(Instruction *O, Value *P, Instruction *H) 
40       : Original(O), PreHeader(P), Header(H) { }
41   public:
42     Instruction *Original; // Original instruction
43     Value *PreHeader; // Original pre-header replacement
44     Instruction *Header; // New header replacement
45   };
46   
47   class VISIBILITY_HIDDEN LoopRotate : public LoopPass {
48
49   public:
50     static char ID; // Pass ID, replacement for typeid
51     LoopRotate() : LoopPass((intptr_t)&ID) {}
52
53     // Rotate Loop L as many times as possible. Return true if
54     // loop is rotated at least once.
55     bool runOnLoop(Loop *L, LPPassManager &LPM);
56
57     // LCSSA form makes instruction renaming easier.
58     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
59       AU.addRequiredID(LoopSimplifyID);
60       AU.addPreservedID(LoopSimplifyID);
61       AU.addRequiredID(LCSSAID);
62       AU.addPreservedID(LCSSAID);
63       AU.addPreserved<ScalarEvolution>();
64       AU.addPreserved<LoopInfo>();
65       AU.addPreserved<DominatorTree>();
66       AU.addPreserved<DominanceFrontier>();
67     }
68
69     // Helper functions
70
71     /// Do actual work
72     bool rotateLoop(Loop *L, LPPassManager &LPM);
73     
74     /// Initialize local data
75     void initialize();
76
77     /// Make sure all Exit block PHINodes have required incoming values.
78     /// If incoming value is constant or defined outside the loop then
79     /// PHINode may not have an entry for original pre-header. 
80     void  updateExitBlock();
81
82     /// Return true if this instruction is used outside original header.
83     bool usedOutsideOriginalHeader(Instruction *In);
84
85     /// Find Replacement information for instruction. Return NULL if it is
86     /// not available.
87     const RenameData *findReplacementData(Instruction *I);
88
89     /// After loop rotation, loop pre-header has multiple sucessors.
90     /// Insert one forwarding basic block to ensure that loop pre-header
91     /// has only one successor.
92     void preserveCanonicalLoopForm(LPPassManager &LPM);
93
94   private:
95
96     Loop *L;
97     BasicBlock *OrigHeader;
98     BasicBlock *OrigPreHeader;
99     BasicBlock *OrigLatch;
100     BasicBlock *NewHeader;
101     BasicBlock *Exit;
102     LPPassManager *LPM_Ptr;
103     SmallVector<RenameData, MAX_HEADER_SIZE> LoopHeaderInfo;
104   };
105 }
106   
107 char LoopRotate::ID = 0;
108 static RegisterPass<LoopRotate> X("loop-rotate", "Rotate Loops");
109
110 LoopPass *llvm::createLoopRotatePass() { return new LoopRotate(); }
111
112 /// Rotate Loop L as many times as possible. Return true if
113 /// loop is rotated at least once.
114 bool LoopRotate::runOnLoop(Loop *Lp, LPPassManager &LPM) {
115
116   bool RotatedOneLoop = false;
117   initialize();
118   LPM_Ptr = &LPM;
119
120   // One loop can be rotated multiple times.
121   while (rotateLoop(Lp,LPM)) {
122     RotatedOneLoop = true;
123     initialize();
124   }
125
126   return RotatedOneLoop;
127 }
128
129 /// Rotate loop LP. Return true if the loop is rotated.
130 bool LoopRotate::rotateLoop(Loop *Lp, LPPassManager &LPM) {
131
132   L = Lp;
133
134   OrigHeader =  L->getHeader();
135   OrigPreHeader = L->getLoopPreheader();
136   OrigLatch = L->getLoopLatch();
137
138   // If loop has only one block then there is not much to rotate.
139   if (L->getBlocks().size() == 1)
140     return false;
141
142   assert (OrigHeader && OrigLatch && OrigPreHeader &&
143           "Loop is not in canonical form");
144
145   // If loop header is not one of the loop exit block then
146   // either this loop is already rotated or it is not 
147   // suitable for loop rotation transformations.
148   if (!L->isLoopExit(OrigHeader))
149     return false;
150
151   BranchInst *BI = dyn_cast<BranchInst>(OrigHeader->getTerminator());
152   if (!BI)
153     return false;
154   assert (BI->isConditional() && "Branch Instruction is not conditional");
155
156   // Updating PHInodes in loops with multiple exits adds complexity. 
157   // Keep it simple, and restrict loop rotation to loops with one exit only.
158   // In future, lift this restriction and support for multiple exits if
159   // required.
160   SmallVector<BasicBlock*, 8> ExitBlocks;
161   L->getExitBlocks(ExitBlocks);
162   if (ExitBlocks.size() > 1)
163     return false;
164
165   // Check size of original header and reject
166   // loop if it is very big.
167   if (OrigHeader->getInstList().size() > MAX_HEADER_SIZE)
168     return false;
169
170   // Now, this loop is suitable for rotation.
171
172   // Find new Loop header. NewHeader is a Header's one and only successor
173   // that is inside loop.  Header's other successor is out side the
174   // loop. Otherwise loop is not suitable for rotation.
175   Exit = BI->getSuccessor(0);
176   NewHeader = BI->getSuccessor(1);
177   if (L->contains(Exit))
178     std::swap(Exit, NewHeader);
179   assert (NewHeader && "Unable to determine new loop header");
180   assert(L->contains(NewHeader) && !L->contains(Exit) && 
181          "Unable to determine loop header and exit blocks");
182
183   // Copy PHI nodes and other instructions from original header
184   // into original pre-header. Unlike original header, original pre-header is
185   // not a member of loop. 
186   //
187   // New loop header is one and only successor of original header that 
188   // is inside the loop. All other original header successors are outside 
189   // the loop. Copy PHI Nodes from original header into new loop header. 
190   // Add second incoming value, from original loop pre-header into these phi 
191   // nodes. If a value defined in original header is used outside original 
192   // header then new loop header will need new phi nodes with two incoming 
193   // values, one definition from original header and second definition is 
194   // from original loop pre-header.
195
196   // Remove terminator from Original pre-header. Original pre-header will
197   // receive a clone of original header terminator as a new terminator.
198   OrigPreHeader->getInstList().pop_back();
199   BasicBlock::iterator I = OrigHeader->begin(), E = OrigHeader->end();
200   PHINode *PN = NULL;
201   for (; (PN = dyn_cast<PHINode>(I)); ++I) {
202     Instruction *In = I;
203
204     // PHI nodes are not copied into original pre-header. Instead their values
205     // are directly propagated.
206     Value * NPV = PN->getIncomingValueForBlock(OrigPreHeader);
207
208     // Create new PHI node with two incoming values for NewHeader.
209     // One incoming value is from OrigLatch (through OrigHeader) and 
210     // second incoming value is from original pre-header.
211     PHINode *NH = PHINode::Create(In->getType(), In->getName());
212     NH->addIncoming(PN->getIncomingValueForBlock(OrigLatch), OrigHeader);
213     NH->addIncoming(NPV, OrigPreHeader);
214     NewHeader->getInstList().push_front(NH);
215     
216     // "In" can be replaced by NH at various places.
217     LoopHeaderInfo.push_back(RenameData(In, NPV, NH));
218   }
219
220   // Now, handle non-phi instructions.
221   for (; I != E; ++I) {
222     Instruction *In = I;
223
224     assert (!isa<PHINode>(In) && "PHINode is not expected here");
225     // This is not a PHI instruction. Insert its clone into original pre-header.
226     // If this instruction is using a value from same basic block then
227     // update it to use value from cloned instruction.
228     Instruction *C = In->clone();
229     C->setName(In->getName());
230     OrigPreHeader->getInstList().push_back(C);
231
232     for (unsigned opi = 0, e = In->getNumOperands(); opi != e; ++opi) {
233       if (Instruction *OpPhi = dyn_cast<PHINode>(In->getOperand(opi))) {
234         if (const RenameData *D = findReplacementData(OpPhi)) {
235           // This is using values from original header PHI node.
236           // Here, directly used incoming value from original pre-header.
237           C->setOperand(opi, D->PreHeader);
238         }
239       }
240       else if (Instruction *OpInsn = 
241                dyn_cast<Instruction>(In->getOperand(opi))) {
242         if (const RenameData *D = findReplacementData(OpInsn))
243           C->setOperand(opi, D->PreHeader);
244       }
245     }
246
247
248     // If this instruction is used outside this basic block then
249     // create new PHINode for this instruction.
250     Instruction *NewHeaderReplacement = NULL;
251     if (usedOutsideOriginalHeader(In)) {
252       // FIXME: remove this when we have first-class aggregates.
253       if (isa<StructType>(In->getType())) {
254         // Can't create PHI nodes for this type.  If there are any getResults
255         // not defined in this block, move them back to this block.  PHI
256         // nodes will be created for all getResults later.
257         BasicBlock::iterator InsertPoint;
258         if (InvokeInst *II = dyn_cast<InvokeInst>(In)) {
259           InsertPoint = II->getNormalDest()->getFirstNonPHI();
260         } else {
261           InsertPoint = I;  // call
262           ++InsertPoint;
263         }
264         for (Value::use_iterator UI = In->use_begin(), UE = In->use_end();
265              UI != UE; ++UI) {
266           GetResultInst *InGR = cast<GetResultInst>(UI);
267           if (InGR->getParent() != OrigHeader) {
268             // Move InGR to immediately after the call or in the normal dest of
269             // the invoke.  It will be picked up, cloned and PHI'd on the next
270             // iteration.
271             InGR->moveBefore(InsertPoint);
272           }
273         }
274       } else {
275         PHINode *PN = PHINode::Create(In->getType(), In->getName());
276         PN->addIncoming(In, OrigHeader);
277         PN->addIncoming(C, OrigPreHeader);
278         NewHeader->getInstList().push_front(PN);
279         NewHeaderReplacement = PN;
280       }
281     }
282     LoopHeaderInfo.push_back(RenameData(In, C, NewHeaderReplacement));
283   }
284
285   // Rename uses of original header instructions to reflect their new
286   // definitions (either from original pre-header node or from newly created
287   // new header PHINodes.
288   //
289   // Original header instructions are used in
290   // 1) Original header:
291   //
292   //    If instruction is used in non-phi instructions then it is using
293   //    defintion from original heder iteself. Do not replace this use
294   //    with definition from new header or original pre-header.
295   //
296   //    If instruction is used in phi node then it is an incoming 
297   //    value. Rename its use to reflect new definition from new-preheader
298   //    or new header.
299   //
300   // 2) Inside loop but not in original header
301   //
302   //    Replace this use to reflect definition from new header.
303   for(unsigned LHI = 0, LHI_E = LoopHeaderInfo.size(); LHI != LHI_E; ++LHI) {
304     const RenameData &ILoopHeaderInfo = LoopHeaderInfo[LHI];
305
306     if (!ILoopHeaderInfo.Header)
307       continue;
308
309     Instruction *OldPhi = ILoopHeaderInfo.Original;
310     Instruction *NewPhi = ILoopHeaderInfo.Header;
311
312     // Before replacing uses, collect them first, so that iterator is
313     // not invalidated.
314     SmallVector<Instruction *, 16> AllUses;
315     for (Value::use_iterator UI = OldPhi->use_begin(), UE = OldPhi->use_end();
316          UI != UE; ++UI) {
317       Instruction *U = cast<Instruction>(UI);
318       AllUses.push_back(U);
319     }
320
321     for (SmallVector<Instruction *, 16>::iterator UI = AllUses.begin(), 
322            UE = AllUses.end(); UI != UE; ++UI) {
323       Instruction *U = *UI;
324       BasicBlock *Parent = U->getParent();
325
326       // Used inside original header
327       if (Parent == OrigHeader) {
328         // Do not rename uses inside original header non-phi instructions.
329         PHINode *PU = dyn_cast<PHINode>(U);
330         if (!PU)
331           continue;
332
333         // Do not rename uses inside original header phi nodes, if the
334         // incoming value is for new header.
335         if (PU->getBasicBlockIndex(NewHeader) != -1
336             && PU->getIncomingValueForBlock(NewHeader) == U)
337           continue;
338         
339        U->replaceUsesOfWith(OldPhi, NewPhi);
340        continue;
341       }
342
343       // Used inside loop, but not in original header.
344       if (L->contains(U->getParent())) {
345         if (U != NewPhi)
346           U->replaceUsesOfWith(OldPhi, NewPhi);
347         continue;
348       }
349       
350       // Used inside Exit Block. Since we are in LCSSA form, U must be PHINode.
351       if (U->getParent() == Exit) {
352         assert (isa<PHINode>(U) && "Use in Exit Block that is not PHINode");
353         
354         PHINode *UPhi = cast<PHINode>(U);
355         // UPhi already has one incoming argument from original header. 
356         // Add second incoming argument from new Pre header.
357         UPhi->addIncoming(ILoopHeaderInfo.PreHeader, OrigPreHeader);
358       } else {
359         // Used outside Exit block. Create a new PHI node from exit block
360         // to receive value from ne new header ane pre header.
361         PHINode *PN = PHINode::Create(U->getType(), U->getName());
362         PN->addIncoming(ILoopHeaderInfo.PreHeader, OrigPreHeader);
363         PN->addIncoming(OldPhi, OrigHeader);
364         Exit->getInstList().push_front(PN);
365         U->replaceUsesOfWith(OldPhi, PN);
366       }
367     }
368   }
369   
370   /// Make sure all Exit block PHINodes have required incoming values.
371   updateExitBlock();
372
373   // Update CFG
374
375   // Removing incoming branch from loop preheader to original header.
376   // Now original header is inside the loop.
377   for (BasicBlock::iterator I = OrigHeader->begin(), E = OrigHeader->end();
378        I != E; ++I) {
379     Instruction *In = I;
380     PHINode *PN = dyn_cast<PHINode>(In);
381     if (!PN)
382       break;
383
384     PN->removeIncomingValue(OrigPreHeader);
385   }
386
387   // Make NewHeader as the new header for the loop.
388   L->moveToHeader(NewHeader);
389
390   preserveCanonicalLoopForm(LPM);
391
392   NumRotated++;
393   return true;
394 }
395
396 /// Make sure all Exit block PHINodes have required incoming values.
397 /// If incoming value is constant or defined outside the loop then
398 /// PHINode may not have an entry for original pre-header. 
399 void LoopRotate::updateExitBlock() {
400
401   for (BasicBlock::iterator I = Exit->begin(), E = Exit->end();
402        I != E; ++I) {
403
404     PHINode *PN = dyn_cast<PHINode>(I);
405     if (!PN)
406       break;
407
408     // There is already one incoming value from original pre-header block.
409     if (PN->getBasicBlockIndex(OrigPreHeader) != -1)
410       continue;
411
412     const RenameData *ILoopHeaderInfo;
413     Value *V = PN->getIncomingValueForBlock(OrigHeader);
414     if (isa<Instruction>(V) && 
415         (ILoopHeaderInfo = findReplacementData(cast<Instruction>(V)))) {
416       assert(ILoopHeaderInfo->PreHeader && "Missing New Preheader Instruction");
417       PN->addIncoming(ILoopHeaderInfo->PreHeader, OrigPreHeader);
418     } else {
419       PN->addIncoming(V, OrigPreHeader);
420     }
421   }
422 }
423
424 /// Initialize local data
425 void LoopRotate::initialize() {
426   L = NULL;
427   OrigHeader = NULL;
428   OrigPreHeader = NULL;
429   NewHeader = NULL;
430   Exit = NULL;
431
432   LoopHeaderInfo.clear();
433 }
434
435 /// Return true if this instruction is used by any instructions in the loop that
436 /// aren't in original header.
437 bool LoopRotate::usedOutsideOriginalHeader(Instruction *In) {
438
439   for (Value::use_iterator UI = In->use_begin(), UE = In->use_end();
440        UI != UE; ++UI) {
441     Instruction *U = cast<Instruction>(UI);
442     if (U->getParent() != OrigHeader) {
443       if (L->contains(U->getParent()))
444         return true;
445     }
446   }
447
448   return false;
449 }
450
451 /// Find Replacement information for instruction. Return NULL if it is
452 /// not available.
453 const RenameData *LoopRotate::findReplacementData(Instruction *In) {
454
455   // Since LoopHeaderInfo is small, linear walk is OK.
456   for(unsigned LHI = 0, LHI_E = LoopHeaderInfo.size(); LHI != LHI_E; ++LHI) {
457     const RenameData &ILoopHeaderInfo = LoopHeaderInfo[LHI];
458     if (ILoopHeaderInfo.Original == In)
459       return &ILoopHeaderInfo;
460   }
461   return NULL;
462 }
463
464 /// After loop rotation, loop pre-header has multiple sucessors.
465 /// Insert one forwarding basic block to ensure that loop pre-header
466 /// has only one successor.
467 void LoopRotate::preserveCanonicalLoopForm(LPPassManager &LPM) {
468
469   // Right now original pre-header has two successors, new header and
470   // exit block. Insert new block between original pre-header and
471   // new header such that loop's new pre-header has only one successor.
472   BasicBlock *NewPreHeader = BasicBlock::Create("bb.nph",
473                                                 OrigHeader->getParent(), 
474                                                 NewHeader);
475   LoopInfo &LI = LPM.getAnalysis<LoopInfo>();
476   if (Loop *PL = LI.getLoopFor(OrigPreHeader))
477     PL->addBasicBlockToLoop(NewPreHeader, LI.getBase());
478   BranchInst::Create(NewHeader, NewPreHeader);
479   
480   BranchInst *OrigPH_BI = cast<BranchInst>(OrigPreHeader->getTerminator());
481   if (OrigPH_BI->getSuccessor(0) == NewHeader)
482     OrigPH_BI->setSuccessor(0, NewPreHeader);
483   else {
484     assert (OrigPH_BI->getSuccessor(1) == NewHeader &&
485             "Unexpected original pre-header terminator");
486     OrigPH_BI->setSuccessor(1, NewPreHeader);
487   }
488   
489   for (BasicBlock::iterator I = NewHeader->begin(), E = NewHeader->end();
490        I != E; ++I) {
491     Instruction *In = I;
492     PHINode *PN = dyn_cast<PHINode>(In);
493     if (!PN)
494       break;
495
496     int index = PN->getBasicBlockIndex(OrigPreHeader);
497     assert (index != -1 && "Expected incoming value from Original PreHeader");
498     PN->setIncomingBlock(index, NewPreHeader);
499     assert (PN->getBasicBlockIndex(OrigPreHeader) == -1 && 
500             "Expected only one incoming value from Original PreHeader");
501   }
502
503   if (DominatorTree *DT = getAnalysisToUpdate<DominatorTree>()) {
504     DT->addNewBlock(NewPreHeader, OrigPreHeader);
505     DT->changeImmediateDominator(L->getHeader(), NewPreHeader);
506     DT->changeImmediateDominator(Exit, OrigPreHeader);
507     for (Loop::block_iterator BI = L->block_begin(), BE = L->block_end();
508          BI != BE; ++BI) {
509       BasicBlock *B = *BI;
510       if (L->getHeader() != B) {
511         DomTreeNode *Node = DT->getNode(B);
512         if (Node && Node->getBlock() == OrigHeader)
513           DT->changeImmediateDominator(*BI, L->getHeader());
514       }
515     }
516     DT->changeImmediateDominator(OrigHeader, OrigLatch);
517   }
518
519   if(DominanceFrontier *DF = getAnalysisToUpdate<DominanceFrontier>()) {
520
521     // New Preheader's dominance frontier is Exit block.
522     DominanceFrontier::DomSetType NewPHSet;
523     NewPHSet.insert(Exit);
524     DF->addBasicBlock(NewPreHeader, NewPHSet);
525
526     // New Header's dominance frontier now includes itself and Exit block
527     DominanceFrontier::iterator HeadI = DF->find(L->getHeader());
528     if (HeadI != DF->end()) {
529       DominanceFrontier::DomSetType & HeaderSet = HeadI->second;
530       HeaderSet.clear();
531       HeaderSet.insert(L->getHeader());
532       HeaderSet.insert(Exit);
533     } else {
534       DominanceFrontier::DomSetType HeaderSet;
535       HeaderSet.insert(L->getHeader());
536       HeaderSet.insert(Exit);
537       DF->addBasicBlock(L->getHeader(), HeaderSet);
538     }
539
540     // Original header (new Loop Latch)'s dominance frontier is Exit.
541     DominanceFrontier::iterator LatchI = DF->find(L->getLoopLatch());
542     if (LatchI != DF->end()) {
543       DominanceFrontier::DomSetType &LatchSet = LatchI->second;
544       LatchSet = LatchI->second;
545       LatchSet.clear();
546       LatchSet.insert(Exit);
547     } else {
548       DominanceFrontier::DomSetType LatchSet;
549       LatchSet.insert(Exit);
550       DF->addBasicBlock(L->getHeader(), LatchSet);
551     }
552
553     // If a loop block dominates new loop latch then its frontier is
554     // new header and Exit.
555     BasicBlock *NewLatch = L->getLoopLatch();
556     DominatorTree *DT = getAnalysisToUpdate<DominatorTree>();
557     for (Loop::block_iterator BI = L->block_begin(), BE = L->block_end();
558          BI != BE; ++BI) {
559       BasicBlock *B = *BI;
560       if (DT->dominates(B, NewLatch)) {
561         DominanceFrontier::iterator BDFI = DF->find(B);
562         if (BDFI != DF->end()) {
563           DominanceFrontier::DomSetType &BSet = BDFI->second;
564           BSet = BDFI->second;
565           BSet.clear();
566           BSet.insert(L->getHeader());
567           BSet.insert(Exit);
568         } else {
569           DominanceFrontier::DomSetType BSet;
570           BSet.insert(L->getHeader());
571           BSet.insert(Exit);
572           DF->addBasicBlock(B, BSet);
573         }
574       }
575     }
576   }
577
578   // Preserve canonical loop form, which means Exit block should
579   // have only one predecessor.
580   BasicBlock *NExit = SplitEdge(L->getLoopLatch(), Exit, this);
581
582   // Preserve LCSSA.
583   BasicBlock::iterator I = Exit->begin(), E = Exit->end();
584   PHINode *PN = NULL;
585   for (; (PN = dyn_cast<PHINode>(I)); ++I) {
586     PHINode *NewPN = PHINode::Create(PN->getType(), PN->getName());
587     unsigned N = PN->getNumIncomingValues();
588     for (unsigned index = 0; index < N; ++index)
589       if (PN->getIncomingBlock(index) == NExit) {
590         NewPN->addIncoming(PN->getIncomingValue(index), L->getLoopLatch());
591         PN->setIncomingValue(index, NewPN);
592         PN->setIncomingBlock(index, NExit);
593         NExit->getInstList().push_front(NewPN);
594       }
595   }
596
597   assert (NewHeader && L->getHeader() == NewHeader 
598           && "Invalid loop header after loop rotation");
599   assert (NewPreHeader && L->getLoopPreheader() == NewPreHeader
600           && "Invalid loop preheader after loop rotation");
601   assert (L->getLoopLatch() 
602           && "Invalid loop latch after loop rotation");
603
604 }