SwitchInst refactoring.
[oota-llvm.git] / lib / Transforms / Scalar / LoopUnswitch.cpp
1 //===-- LoopUnswitch.cpp - Hoist loop-invariant conditionals in loop ------===//
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 pass transforms loops that contain branches on loop-invariant conditions
11 // to have multiple loops.  For example, it turns the left into the right code:
12 //
13 //  for (...)                  if (lic)
14 //    A                          for (...)
15 //    if (lic)                     A; B; C
16 //      B                      else
17 //    C                          for (...)
18 //                                 A; C
19 //
20 // This can increase the size of the code exponentially (doubling it every time
21 // a loop is unswitched) so we only unswitch if the resultant code will be
22 // smaller than a threshold.
23 //
24 // This pass expects LICM to be run before it to hoist invariant conditions out
25 // of the loop, to make the unswitching opportunity obvious.
26 //
27 //===----------------------------------------------------------------------===//
28
29 #define DEBUG_TYPE "loop-unswitch"
30 #include "llvm/Transforms/Scalar.h"
31 #include "llvm/Constants.h"
32 #include "llvm/DerivedTypes.h"
33 #include "llvm/Function.h"
34 #include "llvm/Instructions.h"
35 #include "llvm/Analysis/InlineCost.h"
36 #include "llvm/Analysis/InstructionSimplify.h"
37 #include "llvm/Analysis/LoopInfo.h"
38 #include "llvm/Analysis/LoopPass.h"
39 #include "llvm/Analysis/Dominators.h"
40 #include "llvm/Analysis/ScalarEvolution.h"
41 #include "llvm/Transforms/Utils/Cloning.h"
42 #include "llvm/Transforms/Utils/Local.h"
43 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
44 #include "llvm/ADT/Statistic.h"
45 #include "llvm/ADT/SmallPtrSet.h"
46 #include "llvm/ADT/STLExtras.h"
47 #include "llvm/Support/CommandLine.h"
48 #include "llvm/Support/Debug.h"
49 #include "llvm/Support/raw_ostream.h"
50 #include <algorithm>
51 #include <map>
52 #include <set>
53 using namespace llvm;
54
55 STATISTIC(NumBranches, "Number of branches unswitched");
56 STATISTIC(NumSwitches, "Number of switches unswitched");
57 STATISTIC(NumSelects , "Number of selects unswitched");
58 STATISTIC(NumTrivial , "Number of unswitches that are trivial");
59 STATISTIC(NumSimplify, "Number of simplifications of unswitched code");
60 STATISTIC(TotalInsts,  "Total number of instructions analyzed");
61
62 // The specific value of 100 here was chosen based only on intuition and a
63 // few specific examples.
64 static cl::opt<unsigned>
65 Threshold("loop-unswitch-threshold", cl::desc("Max loop size to unswitch"),
66           cl::init(100), cl::Hidden);
67   
68 namespace {
69   
70   class LUAnalysisCache {
71
72     typedef DenseMap<const SwitchInst*, SmallPtrSet<const Value *, 8> >
73       UnswitchedValsMap;
74     
75     typedef UnswitchedValsMap::iterator UnswitchedValsIt;
76       
77     struct LoopProperties {
78       unsigned CanBeUnswitchedCount;
79       unsigned SizeEstimation;
80       UnswitchedValsMap UnswitchedVals;
81     };
82     
83     // Here we use std::map instead of DenseMap, since we need to keep valid 
84     // LoopProperties pointer for current loop for better performance.
85     typedef std::map<const Loop*, LoopProperties> LoopPropsMap;
86     typedef LoopPropsMap::iterator LoopPropsMapIt;
87     
88     LoopPropsMap LoopsProperties;
89     UnswitchedValsMap* CurLoopInstructions;
90     LoopProperties* CurrentLoopProperties;
91     
92     // Max size of code we can produce on remained iterations.
93     unsigned MaxSize;
94       
95     public:
96     
97       LUAnalysisCache() :
98         CurLoopInstructions(NULL), CurrentLoopProperties(NULL),
99         MaxSize(Threshold)
100       {}
101     
102       // Analyze loop. Check its size, calculate is it possible to unswitch
103       // it. Returns true if we can unswitch this loop.
104       bool countLoop(const Loop* L);
105       
106       // Clean all data related to given loop.
107       void forgetLoop(const Loop* L);
108       
109       // Mark case value as unswitched.
110       // Since SI instruction can be partly unswitched, in order to avoid
111       // extra unswitching in cloned loops keep track all unswitched values.
112       void setUnswitched(const SwitchInst* SI, const Value* V);
113       
114       // Check was this case value unswitched before or not.
115       bool isUnswitched(const SwitchInst* SI, const Value* V);
116       
117       // Clone all loop-unswitch related loop properties.
118       // Redistribute unswitching quotas.
119       // Note, that new loop data is stored inside the VMap.
120       void cloneData(const Loop* NewLoop, const Loop* OldLoop,
121                      const ValueToValueMapTy& VMap);
122   };
123   
124   class LoopUnswitch : public LoopPass {
125     LoopInfo *LI;  // Loop information
126     LPPassManager *LPM;
127
128     // LoopProcessWorklist - Used to check if second loop needs processing
129     // after RewriteLoopBodyWithConditionConstant rewrites first loop.
130     std::vector<Loop*> LoopProcessWorklist;
131
132     LUAnalysisCache BranchesInfo;
133     
134     bool OptimizeForSize;
135     bool redoLoop;
136
137     Loop *currentLoop;
138     DominatorTree *DT;
139     BasicBlock *loopHeader;
140     BasicBlock *loopPreheader;
141     
142     // LoopBlocks contains all of the basic blocks of the loop, including the
143     // preheader of the loop, the body of the loop, and the exit blocks of the 
144     // loop, in that order.
145     std::vector<BasicBlock*> LoopBlocks;
146     // NewBlocks contained cloned copy of basic blocks from LoopBlocks.
147     std::vector<BasicBlock*> NewBlocks;
148
149   public:
150     static char ID; // Pass ID, replacement for typeid
151     explicit LoopUnswitch(bool Os = false) : 
152       LoopPass(ID), OptimizeForSize(Os), redoLoop(false), 
153       currentLoop(NULL), DT(NULL), loopHeader(NULL),
154       loopPreheader(NULL) {
155         initializeLoopUnswitchPass(*PassRegistry::getPassRegistry());
156       }
157
158     bool runOnLoop(Loop *L, LPPassManager &LPM);
159     bool processCurrentLoop();
160
161     /// This transformation requires natural loop information & requires that
162     /// loop preheaders be inserted into the CFG.
163     ///
164     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
165       AU.addRequiredID(LoopSimplifyID);
166       AU.addPreservedID(LoopSimplifyID);
167       AU.addRequired<LoopInfo>();
168       AU.addPreserved<LoopInfo>();
169       AU.addRequiredID(LCSSAID);
170       AU.addPreservedID(LCSSAID);
171       AU.addPreserved<DominatorTree>();
172       AU.addPreserved<ScalarEvolution>();
173     }
174
175   private:
176
177     virtual void releaseMemory() {
178       BranchesInfo.forgetLoop(currentLoop);
179     }
180
181     /// RemoveLoopFromWorklist - If the specified loop is on the loop worklist,
182     /// remove it.
183     void RemoveLoopFromWorklist(Loop *L) {
184       std::vector<Loop*>::iterator I = std::find(LoopProcessWorklist.begin(),
185                                                  LoopProcessWorklist.end(), L);
186       if (I != LoopProcessWorklist.end())
187         LoopProcessWorklist.erase(I);
188     }
189     
190     void initLoopData() {
191       loopHeader = currentLoop->getHeader();
192       loopPreheader = currentLoop->getLoopPreheader();
193     }
194
195     /// Split all of the edges from inside the loop to their exit blocks.
196     /// Update the appropriate Phi nodes as we do so.
197     void SplitExitEdges(Loop *L, const SmallVector<BasicBlock *, 8> &ExitBlocks);
198
199     bool UnswitchIfProfitable(Value *LoopCond, Constant *Val);
200     void UnswitchTrivialCondition(Loop *L, Value *Cond, Constant *Val,
201                                   BasicBlock *ExitBlock);
202     void UnswitchNontrivialCondition(Value *LIC, Constant *OnVal, Loop *L);
203
204     void RewriteLoopBodyWithConditionConstant(Loop *L, Value *LIC,
205                                               Constant *Val, bool isEqual);
206
207     void EmitPreheaderBranchOnCondition(Value *LIC, Constant *Val,
208                                         BasicBlock *TrueDest, 
209                                         BasicBlock *FalseDest,
210                                         Instruction *InsertPt);
211
212     void SimplifyCode(std::vector<Instruction*> &Worklist, Loop *L);
213     void RemoveBlockIfDead(BasicBlock *BB,
214                            std::vector<Instruction*> &Worklist, Loop *l);
215     void RemoveLoopFromHierarchy(Loop *L);
216     bool IsTrivialUnswitchCondition(Value *Cond, Constant **Val = 0,
217                                     BasicBlock **LoopExit = 0);
218
219   };
220 }
221
222 // Analyze loop. Check its size, calculate is it possible to unswitch
223 // it. Returns true if we can unswitch this loop.
224 bool LUAnalysisCache::countLoop(const Loop* L) {
225   
226   std::pair<LoopPropsMapIt, bool> InsertRes =
227       LoopsProperties.insert(std::make_pair(L, LoopProperties()));
228   
229   LoopProperties& Props = InsertRes.first->second;
230    
231   if (InsertRes.second) {
232     // New loop.
233
234     // Limit the number of instructions to avoid causing significant code
235     // expansion, and the number of basic blocks, to avoid loops with
236     // large numbers of branches which cause loop unswitching to go crazy.
237     // This is a very ad-hoc heuristic.
238     
239     // FIXME: This is overly conservative because it does not take into
240     // consideration code simplification opportunities and code that can
241     // be shared by the resultant unswitched loops.
242     CodeMetrics Metrics;
243     for (Loop::block_iterator I = L->block_begin(), 
244            E = L->block_end();
245          I != E; ++I)
246       Metrics.analyzeBasicBlock(*I);    
247
248     Props.SizeEstimation = std::min(Metrics.NumInsts, Metrics.NumBlocks * 5);
249     Props.CanBeUnswitchedCount = MaxSize / (Props.SizeEstimation);
250     MaxSize -= Props.SizeEstimation * Props.CanBeUnswitchedCount;
251   }  
252    
253   if (!Props.CanBeUnswitchedCount) {
254     DEBUG(dbgs() << "NOT unswitching loop %"
255           << L->getHeader()->getName() << ", cost too high: "
256           << L->getBlocks().size() << "\n");
257     
258     return false;
259   }
260   
261   // Be careful. This links are good only before new loop addition.
262   CurrentLoopProperties = &Props;
263   CurLoopInstructions = &Props.UnswitchedVals;
264   
265   return true;
266 }
267
268 // Clean all data related to given loop.
269 void LUAnalysisCache::forgetLoop(const Loop* L) {
270   
271   LoopPropsMapIt LIt = LoopsProperties.find(L);
272
273   if (LIt != LoopsProperties.end()) {
274     LoopProperties& Props = LIt->second;
275     MaxSize += Props.CanBeUnswitchedCount * Props.SizeEstimation;
276     LoopsProperties.erase(LIt);
277   }
278   
279   CurrentLoopProperties = NULL;
280   CurLoopInstructions = NULL;  
281 }
282
283 // Mark case value as unswitched.
284 // Since SI instruction can be partly unswitched, in order to avoid
285 // extra unswitching in cloned loops keep track all unswitched values.
286 void LUAnalysisCache::setUnswitched(const SwitchInst* SI, const Value* V) {
287   (*CurLoopInstructions)[SI].insert(V);
288 }
289
290 // Check was this case value unswitched before or not.
291 bool LUAnalysisCache::isUnswitched(const SwitchInst* SI, const Value* V) {
292   return (*CurLoopInstructions)[SI].count(V); 
293 }
294
295 // Clone all loop-unswitch related loop properties.
296 // Redistribute unswitching quotas.
297 // Note, that new loop data is stored inside the VMap.
298 void LUAnalysisCache::cloneData(const Loop* NewLoop, const Loop* OldLoop,
299                      const ValueToValueMapTy& VMap) {
300   
301   LoopProperties& NewLoopProps = LoopsProperties[NewLoop];
302   LoopProperties& OldLoopProps = *CurrentLoopProperties;
303   UnswitchedValsMap& Insts = OldLoopProps.UnswitchedVals;
304   
305   // Reallocate "can-be-unswitched quota"
306
307   --OldLoopProps.CanBeUnswitchedCount;
308   unsigned Quota = OldLoopProps.CanBeUnswitchedCount;
309   NewLoopProps.CanBeUnswitchedCount = Quota / 2;
310   OldLoopProps.CanBeUnswitchedCount = Quota - Quota / 2;
311   
312   NewLoopProps.SizeEstimation = OldLoopProps.SizeEstimation;
313   
314   // Clone unswitched values info:
315   // for new loop switches we clone info about values that was
316   // already unswitched and has redundant successors.
317   for (UnswitchedValsIt I = Insts.begin(); I != Insts.end(); ++I) {
318     const SwitchInst* OldInst = I->first;
319     Value* NewI = VMap.lookup(OldInst);
320     const SwitchInst* NewInst = cast_or_null<SwitchInst>(NewI);
321     assert(NewInst && "All instructions that are in SrcBB must be in VMap.");
322     
323     NewLoopProps.UnswitchedVals[NewInst] = OldLoopProps.UnswitchedVals[OldInst];
324   }
325 }
326
327 char LoopUnswitch::ID = 0;
328 INITIALIZE_PASS_BEGIN(LoopUnswitch, "loop-unswitch", "Unswitch loops",
329                       false, false)
330 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
331 INITIALIZE_PASS_DEPENDENCY(LoopInfo)
332 INITIALIZE_PASS_DEPENDENCY(LCSSA)
333 INITIALIZE_PASS_END(LoopUnswitch, "loop-unswitch", "Unswitch loops",
334                       false, false)
335
336 Pass *llvm::createLoopUnswitchPass(bool Os) { 
337   return new LoopUnswitch(Os); 
338 }
339
340 /// FindLIVLoopCondition - Cond is a condition that occurs in L.  If it is
341 /// invariant in the loop, or has an invariant piece, return the invariant.
342 /// Otherwise, return null.
343 static Value *FindLIVLoopCondition(Value *Cond, Loop *L, bool &Changed) {
344   
345   // We started analyze new instruction, increment scanned instructions counter.
346   ++TotalInsts;
347   
348   // We can never unswitch on vector conditions.
349   if (Cond->getType()->isVectorTy())
350     return 0;
351
352   // Constants should be folded, not unswitched on!
353   if (isa<Constant>(Cond)) return 0;
354
355   // TODO: Handle: br (VARIANT|INVARIANT).
356
357   // Hoist simple values out.
358   if (L->makeLoopInvariant(Cond, Changed))
359     return Cond;
360
361   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Cond))
362     if (BO->getOpcode() == Instruction::And ||
363         BO->getOpcode() == Instruction::Or) {
364       // If either the left or right side is invariant, we can unswitch on this,
365       // which will cause the branch to go away in one loop and the condition to
366       // simplify in the other one.
367       if (Value *LHS = FindLIVLoopCondition(BO->getOperand(0), L, Changed))
368         return LHS;
369       if (Value *RHS = FindLIVLoopCondition(BO->getOperand(1), L, Changed))
370         return RHS;
371     }
372   
373   return 0;
374 }
375
376 bool LoopUnswitch::runOnLoop(Loop *L, LPPassManager &LPM_Ref) {
377   LI = &getAnalysis<LoopInfo>();
378   LPM = &LPM_Ref;
379   DT = getAnalysisIfAvailable<DominatorTree>();
380   currentLoop = L;
381   Function *F = currentLoop->getHeader()->getParent();
382   bool Changed = false;
383   do {
384     assert(currentLoop->isLCSSAForm(*DT));
385     redoLoop = false;
386     Changed |= processCurrentLoop();
387   } while(redoLoop);
388
389   if (Changed) {
390     // FIXME: Reconstruct dom info, because it is not preserved properly.
391     if (DT)
392       DT->runOnFunction(*F);
393   }
394   return Changed;
395 }
396
397 /// processCurrentLoop - Do actual work and unswitch loop if possible 
398 /// and profitable.
399 bool LoopUnswitch::processCurrentLoop() {
400   bool Changed = false;
401
402   initLoopData();
403   
404   // If LoopSimplify was unable to form a preheader, don't do any unswitching.
405   if (!loopPreheader)
406     return false;
407   
408   LLVMContext &Context = loopHeader->getContext();
409   
410   // Probably we reach the quota of branches for this loop. If so
411   // stop unswitching.
412   if (!BranchesInfo.countLoop(currentLoop))
413     return false;
414
415   // Loop over all of the basic blocks in the loop.  If we find an interior
416   // block that is branching on a loop-invariant condition, we can unswitch this
417   // loop.
418   for (Loop::block_iterator I = currentLoop->block_begin(), 
419          E = currentLoop->block_end(); I != E; ++I) {
420     TerminatorInst *TI = (*I)->getTerminator();
421     if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
422       // If this isn't branching on an invariant condition, we can't unswitch
423       // it.
424       if (BI->isConditional()) {
425         // See if this, or some part of it, is loop invariant.  If so, we can
426         // unswitch on it if we desire.
427         Value *LoopCond = FindLIVLoopCondition(BI->getCondition(), 
428                                                currentLoop, Changed);
429         if (LoopCond && UnswitchIfProfitable(LoopCond, 
430                                              ConstantInt::getTrue(Context))) {
431           ++NumBranches;
432           return true;
433         }
434       }      
435     } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
436       Value *LoopCond = FindLIVLoopCondition(SI->getCondition(), 
437                                              currentLoop, Changed);
438       unsigned NumCases = SI->getNumCases(); 
439       if (LoopCond && NumCases) {
440         // Find a value to unswitch on:
441         // FIXME: this should chose the most expensive case!
442         // FIXME: scan for a case with a non-critical edge?
443         Constant *UnswitchVal = NULL;
444         
445         // Do not process same value again and again.
446         // At this point we have some cases already unswitched and
447         // some not yet unswitched. Let's find the first not yet unswitched one.
448         for (unsigned i = 0; i < NumCases; ++i) {
449           Constant* UnswitchValCandidate = SI->getCaseValue(i);
450           if (!BranchesInfo.isUnswitched(SI, UnswitchValCandidate)) {
451             UnswitchVal = UnswitchValCandidate;
452             break;
453           }
454         }
455         
456         if (!UnswitchVal)
457           continue;
458
459         if (UnswitchIfProfitable(LoopCond, UnswitchVal)) {
460           ++NumSwitches;
461           return true;
462         }
463       }
464     }
465     
466     // Scan the instructions to check for unswitchable values.
467     for (BasicBlock::iterator BBI = (*I)->begin(), E = (*I)->end(); 
468          BBI != E; ++BBI)
469       if (SelectInst *SI = dyn_cast<SelectInst>(BBI)) {
470         Value *LoopCond = FindLIVLoopCondition(SI->getCondition(), 
471                                                currentLoop, Changed);
472         if (LoopCond && UnswitchIfProfitable(LoopCond, 
473                                              ConstantInt::getTrue(Context))) {
474           ++NumSelects;
475           return true;
476         }
477       }
478   }
479   return Changed;
480 }
481
482 /// isTrivialLoopExitBlock - Check to see if all paths from BB exit the
483 /// loop with no side effects (including infinite loops).
484 ///
485 /// If true, we return true and set ExitBB to the block we
486 /// exit through.
487 ///
488 static bool isTrivialLoopExitBlockHelper(Loop *L, BasicBlock *BB,
489                                          BasicBlock *&ExitBB,
490                                          std::set<BasicBlock*> &Visited) {
491   if (!Visited.insert(BB).second) {
492     // Already visited. Without more analysis, this could indicate an infinite
493     // loop.
494     return false;
495   } else if (!L->contains(BB)) {
496     // Otherwise, this is a loop exit, this is fine so long as this is the
497     // first exit.
498     if (ExitBB != 0) return false;
499     ExitBB = BB;
500     return true;
501   }
502   
503   // Otherwise, this is an unvisited intra-loop node.  Check all successors.
504   for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI) {
505     // Check to see if the successor is a trivial loop exit.
506     if (!isTrivialLoopExitBlockHelper(L, *SI, ExitBB, Visited))
507       return false;
508   }
509
510   // Okay, everything after this looks good, check to make sure that this block
511   // doesn't include any side effects.
512   for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
513     if (I->mayHaveSideEffects())
514       return false;
515   
516   return true;
517 }
518
519 /// isTrivialLoopExitBlock - Return true if the specified block unconditionally
520 /// leads to an exit from the specified loop, and has no side-effects in the 
521 /// process.  If so, return the block that is exited to, otherwise return null.
522 static BasicBlock *isTrivialLoopExitBlock(Loop *L, BasicBlock *BB) {
523   std::set<BasicBlock*> Visited;
524   Visited.insert(L->getHeader());  // Branches to header make infinite loops.
525   BasicBlock *ExitBB = 0;
526   if (isTrivialLoopExitBlockHelper(L, BB, ExitBB, Visited))
527     return ExitBB;
528   return 0;
529 }
530
531 /// IsTrivialUnswitchCondition - Check to see if this unswitch condition is
532 /// trivial: that is, that the condition controls whether or not the loop does
533 /// anything at all.  If this is a trivial condition, unswitching produces no
534 /// code duplications (equivalently, it produces a simpler loop and a new empty
535 /// loop, which gets deleted).
536 ///
537 /// If this is a trivial condition, return true, otherwise return false.  When
538 /// returning true, this sets Cond and Val to the condition that controls the
539 /// trivial condition: when Cond dynamically equals Val, the loop is known to
540 /// exit.  Finally, this sets LoopExit to the BB that the loop exits to when
541 /// Cond == Val.
542 ///
543 bool LoopUnswitch::IsTrivialUnswitchCondition(Value *Cond, Constant **Val,
544                                        BasicBlock **LoopExit) {
545   BasicBlock *Header = currentLoop->getHeader();
546   TerminatorInst *HeaderTerm = Header->getTerminator();
547   LLVMContext &Context = Header->getContext();
548   
549   BasicBlock *LoopExitBB = 0;
550   if (BranchInst *BI = dyn_cast<BranchInst>(HeaderTerm)) {
551     // If the header block doesn't end with a conditional branch on Cond, we
552     // can't handle it.
553     if (!BI->isConditional() || BI->getCondition() != Cond)
554       return false;
555   
556     // Check to see if a successor of the branch is guaranteed to 
557     // exit through a unique exit block without having any 
558     // side-effects.  If so, determine the value of Cond that causes it to do
559     // this.
560     if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop, 
561                                              BI->getSuccessor(0)))) {
562       if (Val) *Val = ConstantInt::getTrue(Context);
563     } else if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop, 
564                                                     BI->getSuccessor(1)))) {
565       if (Val) *Val = ConstantInt::getFalse(Context);
566     }
567   } else if (SwitchInst *SI = dyn_cast<SwitchInst>(HeaderTerm)) {
568     // If this isn't a switch on Cond, we can't handle it.
569     if (SI->getCondition() != Cond) return false;
570     
571     // Check to see if a successor of the switch is guaranteed to go to the
572     // latch block or exit through a one exit block without having any 
573     // side-effects.  If so, determine the value of Cond that causes it to do
574     // this. 
575     // Note that we can't trivially unswitch on the default case or
576     // on already unswitched cases.
577     for (unsigned i = 0, e = SI->getNumCases(); i != e; ++i) {
578       BasicBlock* LoopExitCandidate;
579       if ((LoopExitCandidate = isTrivialLoopExitBlock(currentLoop, 
580                                                SI->getCaseSuccessor(i)))) {
581         // Okay, we found a trivial case, remember the value that is trivial.
582         ConstantInt* CaseVal = SI->getCaseValue(i);
583
584         // Check that it was not unswitched before, since already unswitched
585         // trivial vals are looks trivial too.
586         if (BranchesInfo.isUnswitched(SI, CaseVal))
587           continue;
588         LoopExitBB = LoopExitCandidate;
589         if (Val) *Val = CaseVal;
590         break;
591       }
592     }
593   }
594
595   // If we didn't find a single unique LoopExit block, or if the loop exit block
596   // contains phi nodes, this isn't trivial.
597   if (!LoopExitBB || isa<PHINode>(LoopExitBB->begin()))
598     return false;   // Can't handle this.
599   
600   if (LoopExit) *LoopExit = LoopExitBB;
601   
602   // We already know that nothing uses any scalar values defined inside of this
603   // loop.  As such, we just have to check to see if this loop will execute any
604   // side-effecting instructions (e.g. stores, calls, volatile loads) in the
605   // part of the loop that the code *would* execute.  We already checked the
606   // tail, check the header now.
607   for (BasicBlock::iterator I = Header->begin(), E = Header->end(); I != E; ++I)
608     if (I->mayHaveSideEffects())
609       return false;
610   return true;
611 }
612
613 /// UnswitchIfProfitable - We have found that we can unswitch currentLoop when
614 /// LoopCond == Val to simplify the loop.  If we decide that this is profitable,
615 /// unswitch the loop, reprocess the pieces, then return true.
616 bool LoopUnswitch::UnswitchIfProfitable(Value *LoopCond, Constant *Val) {
617
618   Function *F = loopHeader->getParent();
619
620   Constant *CondVal = 0;
621   BasicBlock *ExitBlock = 0;
622   if (IsTrivialUnswitchCondition(LoopCond, &CondVal, &ExitBlock)) {
623     // If the condition is trivial, always unswitch. There is no code growth
624     // for this case.
625     UnswitchTrivialCondition(currentLoop, LoopCond, CondVal, ExitBlock);
626     return true;
627   }
628
629   // Check to see if it would be profitable to unswitch current loop.
630
631   // Do not do non-trivial unswitch while optimizing for size.
632   if (OptimizeForSize || F->hasFnAttr(Attribute::OptimizeForSize))
633     return false;
634
635   UnswitchNontrivialCondition(LoopCond, Val, currentLoop);
636   return true;
637 }
638
639 /// CloneLoop - Recursively clone the specified loop and all of its children,
640 /// mapping the blocks with the specified map.
641 static Loop *CloneLoop(Loop *L, Loop *PL, ValueToValueMapTy &VM,
642                        LoopInfo *LI, LPPassManager *LPM) {
643   Loop *New = new Loop();
644   LPM->insertLoop(New, PL);
645
646   // Add all of the blocks in L to the new loop.
647   for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
648        I != E; ++I)
649     if (LI->getLoopFor(*I) == L)
650       New->addBasicBlockToLoop(cast<BasicBlock>(VM[*I]), LI->getBase());
651
652   // Add all of the subloops to the new loop.
653   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
654     CloneLoop(*I, New, VM, LI, LPM);
655
656   return New;
657 }
658
659 /// EmitPreheaderBranchOnCondition - Emit a conditional branch on two values
660 /// if LIC == Val, branch to TrueDst, otherwise branch to FalseDest.  Insert the
661 /// code immediately before InsertPt.
662 void LoopUnswitch::EmitPreheaderBranchOnCondition(Value *LIC, Constant *Val,
663                                                   BasicBlock *TrueDest,
664                                                   BasicBlock *FalseDest,
665                                                   Instruction *InsertPt) {
666   // Insert a conditional branch on LIC to the two preheaders.  The original
667   // code is the true version and the new code is the false version.
668   Value *BranchVal = LIC;
669   if (!isa<ConstantInt>(Val) ||
670       Val->getType() != Type::getInt1Ty(LIC->getContext()))
671     BranchVal = new ICmpInst(InsertPt, ICmpInst::ICMP_EQ, LIC, Val);
672   else if (Val != ConstantInt::getTrue(Val->getContext()))
673     // We want to enter the new loop when the condition is true.
674     std::swap(TrueDest, FalseDest);
675
676   // Insert the new branch.
677   BranchInst *BI = BranchInst::Create(TrueDest, FalseDest, BranchVal, InsertPt);
678
679   // If either edge is critical, split it. This helps preserve LoopSimplify
680   // form for enclosing loops.
681   SplitCriticalEdge(BI, 0, this);
682   SplitCriticalEdge(BI, 1, this);
683 }
684
685 /// UnswitchTrivialCondition - Given a loop that has a trivial unswitchable
686 /// condition in it (a cond branch from its header block to its latch block,
687 /// where the path through the loop that doesn't execute its body has no 
688 /// side-effects), unswitch it.  This doesn't involve any code duplication, just
689 /// moving the conditional branch outside of the loop and updating loop info.
690 void LoopUnswitch::UnswitchTrivialCondition(Loop *L, Value *Cond, 
691                                             Constant *Val, 
692                                             BasicBlock *ExitBlock) {
693   DEBUG(dbgs() << "loop-unswitch: Trivial-Unswitch loop %"
694         << loopHeader->getName() << " [" << L->getBlocks().size()
695         << " blocks] in Function " << L->getHeader()->getParent()->getName()
696         << " on cond: " << *Val << " == " << *Cond << "\n");
697   
698   // First step, split the preheader, so that we know that there is a safe place
699   // to insert the conditional branch.  We will change loopPreheader to have a
700   // conditional branch on Cond.
701   BasicBlock *NewPH = SplitEdge(loopPreheader, loopHeader, this);
702
703   // Now that we have a place to insert the conditional branch, create a place
704   // to branch to: this is the exit block out of the loop that we should
705   // short-circuit to.
706   
707   // Split this block now, so that the loop maintains its exit block, and so
708   // that the jump from the preheader can execute the contents of the exit block
709   // without actually branching to it (the exit block should be dominated by the
710   // loop header, not the preheader).
711   assert(!L->contains(ExitBlock) && "Exit block is in the loop?");
712   BasicBlock *NewExit = SplitBlock(ExitBlock, ExitBlock->begin(), this);
713     
714   // Okay, now we have a position to branch from and a position to branch to, 
715   // insert the new conditional branch.
716   EmitPreheaderBranchOnCondition(Cond, Val, NewExit, NewPH, 
717                                  loopPreheader->getTerminator());
718   LPM->deleteSimpleAnalysisValue(loopPreheader->getTerminator(), L);
719   loopPreheader->getTerminator()->eraseFromParent();
720
721   // We need to reprocess this loop, it could be unswitched again.
722   redoLoop = true;
723   
724   // Now that we know that the loop is never entered when this condition is a
725   // particular value, rewrite the loop with this info.  We know that this will
726   // at least eliminate the old branch.
727   RewriteLoopBodyWithConditionConstant(L, Cond, Val, false);
728   ++NumTrivial;
729 }
730
731 /// SplitExitEdges - Split all of the edges from inside the loop to their exit
732 /// blocks.  Update the appropriate Phi nodes as we do so.
733 void LoopUnswitch::SplitExitEdges(Loop *L, 
734                                 const SmallVector<BasicBlock *, 8> &ExitBlocks){
735
736   for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
737     BasicBlock *ExitBlock = ExitBlocks[i];
738     SmallVector<BasicBlock *, 4> Preds(pred_begin(ExitBlock),
739                                        pred_end(ExitBlock));
740
741     // Although SplitBlockPredecessors doesn't preserve loop-simplify in
742     // general, if we call it on all predecessors of all exits then it does.
743     if (!ExitBlock->isLandingPad()) {
744       SplitBlockPredecessors(ExitBlock, Preds, ".us-lcssa", this);
745     } else {
746       SmallVector<BasicBlock*, 2> NewBBs;
747       SplitLandingPadPredecessors(ExitBlock, Preds, ".us-lcssa", ".us-lcssa",
748                                   this, NewBBs);
749     }
750   }
751 }
752
753 /// UnswitchNontrivialCondition - We determined that the loop is profitable 
754 /// to unswitch when LIC equal Val.  Split it into loop versions and test the 
755 /// condition outside of either loop.  Return the loops created as Out1/Out2.
756 void LoopUnswitch::UnswitchNontrivialCondition(Value *LIC, Constant *Val, 
757                                                Loop *L) {
758   Function *F = loopHeader->getParent();
759   DEBUG(dbgs() << "loop-unswitch: Unswitching loop %"
760         << loopHeader->getName() << " [" << L->getBlocks().size()
761         << " blocks] in Function " << F->getName()
762         << " when '" << *Val << "' == " << *LIC << "\n");
763
764   if (ScalarEvolution *SE = getAnalysisIfAvailable<ScalarEvolution>())
765     SE->forgetLoop(L);
766
767   LoopBlocks.clear();
768   NewBlocks.clear();
769
770   // First step, split the preheader and exit blocks, and add these blocks to
771   // the LoopBlocks list.
772   BasicBlock *NewPreheader = SplitEdge(loopPreheader, loopHeader, this);
773   LoopBlocks.push_back(NewPreheader);
774
775   // We want the loop to come after the preheader, but before the exit blocks.
776   LoopBlocks.insert(LoopBlocks.end(), L->block_begin(), L->block_end());
777
778   SmallVector<BasicBlock*, 8> ExitBlocks;
779   L->getUniqueExitBlocks(ExitBlocks);
780
781   // Split all of the edges from inside the loop to their exit blocks.  Update
782   // the appropriate Phi nodes as we do so.
783   SplitExitEdges(L, ExitBlocks);
784
785   // The exit blocks may have been changed due to edge splitting, recompute.
786   ExitBlocks.clear();
787   L->getUniqueExitBlocks(ExitBlocks);
788
789   // Add exit blocks to the loop blocks.
790   LoopBlocks.insert(LoopBlocks.end(), ExitBlocks.begin(), ExitBlocks.end());
791
792   // Next step, clone all of the basic blocks that make up the loop (including
793   // the loop preheader and exit blocks), keeping track of the mapping between
794   // the instructions and blocks.
795   NewBlocks.reserve(LoopBlocks.size());
796   ValueToValueMapTy VMap;
797   for (unsigned i = 0, e = LoopBlocks.size(); i != e; ++i) {
798     BasicBlock *NewBB = CloneBasicBlock(LoopBlocks[i], VMap, ".us", F);
799     
800     NewBlocks.push_back(NewBB);
801     VMap[LoopBlocks[i]] = NewBB;  // Keep the BB mapping.
802     LPM->cloneBasicBlockSimpleAnalysis(LoopBlocks[i], NewBB, L);
803   }
804
805   // Splice the newly inserted blocks into the function right before the
806   // original preheader.
807   F->getBasicBlockList().splice(NewPreheader, F->getBasicBlockList(),
808                                 NewBlocks[0], F->end());
809
810   // Now we create the new Loop object for the versioned loop.
811   Loop *NewLoop = CloneLoop(L, L->getParentLoop(), VMap, LI, LPM);
812
813   // Recalculate unswitching quota, inherit simplified switches info for NewBB,
814   // Probably clone more loop-unswitch related loop properties.
815   BranchesInfo.cloneData(NewLoop, L, VMap);
816
817   Loop *ParentLoop = L->getParentLoop();
818   if (ParentLoop) {
819     // Make sure to add the cloned preheader and exit blocks to the parent loop
820     // as well.
821     ParentLoop->addBasicBlockToLoop(NewBlocks[0], LI->getBase());
822   }
823
824   for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
825     BasicBlock *NewExit = cast<BasicBlock>(VMap[ExitBlocks[i]]);
826     // The new exit block should be in the same loop as the old one.
827     if (Loop *ExitBBLoop = LI->getLoopFor(ExitBlocks[i]))
828       ExitBBLoop->addBasicBlockToLoop(NewExit, LI->getBase());
829     
830     assert(NewExit->getTerminator()->getNumSuccessors() == 1 &&
831            "Exit block should have been split to have one successor!");
832     BasicBlock *ExitSucc = NewExit->getTerminator()->getSuccessor(0);
833
834     // If the successor of the exit block had PHI nodes, add an entry for
835     // NewExit.
836     PHINode *PN;
837     for (BasicBlock::iterator I = ExitSucc->begin(); isa<PHINode>(I); ++I) {
838       PN = cast<PHINode>(I);
839       Value *V = PN->getIncomingValueForBlock(ExitBlocks[i]);
840       ValueToValueMapTy::iterator It = VMap.find(V);
841       if (It != VMap.end()) V = It->second;
842       PN->addIncoming(V, NewExit);
843     }
844
845     if (LandingPadInst *LPad = NewExit->getLandingPadInst()) {
846       PN = PHINode::Create(LPad->getType(), 0, "",
847                            ExitSucc->getFirstInsertionPt());
848
849       for (pred_iterator I = pred_begin(ExitSucc), E = pred_end(ExitSucc);
850            I != E; ++I) {
851         BasicBlock *BB = *I;
852         LandingPadInst *LPI = BB->getLandingPadInst();
853         LPI->replaceAllUsesWith(PN);
854         PN->addIncoming(LPI, BB);
855       }
856     }
857   }
858
859   // Rewrite the code to refer to itself.
860   for (unsigned i = 0, e = NewBlocks.size(); i != e; ++i)
861     for (BasicBlock::iterator I = NewBlocks[i]->begin(),
862            E = NewBlocks[i]->end(); I != E; ++I)
863       RemapInstruction(I, VMap,RF_NoModuleLevelChanges|RF_IgnoreMissingEntries);
864   
865   // Rewrite the original preheader to select between versions of the loop.
866   BranchInst *OldBR = cast<BranchInst>(loopPreheader->getTerminator());
867   assert(OldBR->isUnconditional() && OldBR->getSuccessor(0) == LoopBlocks[0] &&
868          "Preheader splitting did not work correctly!");
869
870   // Emit the new branch that selects between the two versions of this loop.
871   EmitPreheaderBranchOnCondition(LIC, Val, NewBlocks[0], LoopBlocks[0], OldBR);
872   LPM->deleteSimpleAnalysisValue(OldBR, L);
873   OldBR->eraseFromParent();
874
875   LoopProcessWorklist.push_back(NewLoop);
876   redoLoop = true;
877
878   // Keep a WeakVH holding onto LIC.  If the first call to RewriteLoopBody
879   // deletes the instruction (for example by simplifying a PHI that feeds into
880   // the condition that we're unswitching on), we don't rewrite the second
881   // iteration.
882   WeakVH LICHandle(LIC);
883   
884   // Now we rewrite the original code to know that the condition is true and the
885   // new code to know that the condition is false.
886   RewriteLoopBodyWithConditionConstant(L, LIC, Val, false);
887
888   // It's possible that simplifying one loop could cause the other to be
889   // changed to another value or a constant.  If its a constant, don't simplify
890   // it.
891   if (!LoopProcessWorklist.empty() && LoopProcessWorklist.back() == NewLoop &&
892       LICHandle && !isa<Constant>(LICHandle))
893     RewriteLoopBodyWithConditionConstant(NewLoop, LICHandle, Val, true);
894 }
895
896 /// RemoveFromWorklist - Remove all instances of I from the worklist vector
897 /// specified.
898 static void RemoveFromWorklist(Instruction *I, 
899                                std::vector<Instruction*> &Worklist) {
900   std::vector<Instruction*>::iterator WI = std::find(Worklist.begin(),
901                                                      Worklist.end(), I);
902   while (WI != Worklist.end()) {
903     unsigned Offset = WI-Worklist.begin();
904     Worklist.erase(WI);
905     WI = std::find(Worklist.begin()+Offset, Worklist.end(), I);
906   }
907 }
908
909 /// ReplaceUsesOfWith - When we find that I really equals V, remove I from the
910 /// program, replacing all uses with V and update the worklist.
911 static void ReplaceUsesOfWith(Instruction *I, Value *V, 
912                               std::vector<Instruction*> &Worklist,
913                               Loop *L, LPPassManager *LPM) {
914   DEBUG(dbgs() << "Replace with '" << *V << "': " << *I);
915
916   // Add uses to the worklist, which may be dead now.
917   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
918     if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
919       Worklist.push_back(Use);
920
921   // Add users to the worklist which may be simplified now.
922   for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
923        UI != E; ++UI)
924     Worklist.push_back(cast<Instruction>(*UI));
925   LPM->deleteSimpleAnalysisValue(I, L);
926   RemoveFromWorklist(I, Worklist);
927   I->replaceAllUsesWith(V);
928   I->eraseFromParent();
929   ++NumSimplify;
930 }
931
932 /// RemoveBlockIfDead - If the specified block is dead, remove it, update loop
933 /// information, and remove any dead successors it has.
934 ///
935 void LoopUnswitch::RemoveBlockIfDead(BasicBlock *BB,
936                                      std::vector<Instruction*> &Worklist,
937                                      Loop *L) {
938   if (pred_begin(BB) != pred_end(BB)) {
939     // This block isn't dead, since an edge to BB was just removed, see if there
940     // are any easy simplifications we can do now.
941     if (BasicBlock *Pred = BB->getSinglePredecessor()) {
942       // If it has one pred, fold phi nodes in BB.
943       while (isa<PHINode>(BB->begin()))
944         ReplaceUsesOfWith(BB->begin(), 
945                           cast<PHINode>(BB->begin())->getIncomingValue(0), 
946                           Worklist, L, LPM);
947       
948       // If this is the header of a loop and the only pred is the latch, we now
949       // have an unreachable loop.
950       if (Loop *L = LI->getLoopFor(BB))
951         if (loopHeader == BB && L->contains(Pred)) {
952           // Remove the branch from the latch to the header block, this makes
953           // the header dead, which will make the latch dead (because the header
954           // dominates the latch).
955           LPM->deleteSimpleAnalysisValue(Pred->getTerminator(), L);
956           Pred->getTerminator()->eraseFromParent();
957           new UnreachableInst(BB->getContext(), Pred);
958           
959           // The loop is now broken, remove it from LI.
960           RemoveLoopFromHierarchy(L);
961           
962           // Reprocess the header, which now IS dead.
963           RemoveBlockIfDead(BB, Worklist, L);
964           return;
965         }
966       
967       // If pred ends in a uncond branch, add uncond branch to worklist so that
968       // the two blocks will get merged.
969       if (BranchInst *BI = dyn_cast<BranchInst>(Pred->getTerminator()))
970         if (BI->isUnconditional())
971           Worklist.push_back(BI);
972     }
973     return;
974   }
975
976   DEBUG(dbgs() << "Nuking dead block: " << *BB);
977   
978   // Remove the instructions in the basic block from the worklist.
979   for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
980     RemoveFromWorklist(I, Worklist);
981     
982     // Anything that uses the instructions in this basic block should have their
983     // uses replaced with undefs.
984     // If I is not void type then replaceAllUsesWith undef.
985     // This allows ValueHandlers and custom metadata to adjust itself.
986     if (!I->getType()->isVoidTy())
987       I->replaceAllUsesWith(UndefValue::get(I->getType()));
988   }
989   
990   // If this is the edge to the header block for a loop, remove the loop and
991   // promote all subloops.
992   if (Loop *BBLoop = LI->getLoopFor(BB)) {
993     if (BBLoop->getLoopLatch() == BB) {
994       RemoveLoopFromHierarchy(BBLoop);
995       if (currentLoop == BBLoop) {
996         currentLoop = 0;
997         redoLoop = false;
998       }
999     }
1000   }
1001
1002   // Remove the block from the loop info, which removes it from any loops it
1003   // was in.
1004   LI->removeBlock(BB);
1005   
1006   
1007   // Remove phi node entries in successors for this block.
1008   TerminatorInst *TI = BB->getTerminator();
1009   SmallVector<BasicBlock*, 4> Succs;
1010   for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i) {
1011     Succs.push_back(TI->getSuccessor(i));
1012     TI->getSuccessor(i)->removePredecessor(BB);
1013   }
1014   
1015   // Unique the successors, remove anything with multiple uses.
1016   array_pod_sort(Succs.begin(), Succs.end());
1017   Succs.erase(std::unique(Succs.begin(), Succs.end()), Succs.end());
1018   
1019   // Remove the basic block, including all of the instructions contained in it.
1020   LPM->deleteSimpleAnalysisValue(BB, L);  
1021   BB->eraseFromParent();
1022   // Remove successor blocks here that are not dead, so that we know we only
1023   // have dead blocks in this list.  Nondead blocks have a way of becoming dead,
1024   // then getting removed before we revisit them, which is badness.
1025   //
1026   for (unsigned i = 0; i != Succs.size(); ++i)
1027     if (pred_begin(Succs[i]) != pred_end(Succs[i])) {
1028       // One exception is loop headers.  If this block was the preheader for a
1029       // loop, then we DO want to visit the loop so the loop gets deleted.
1030       // We know that if the successor is a loop header, that this loop had to
1031       // be the preheader: the case where this was the latch block was handled
1032       // above and headers can only have two predecessors.
1033       if (!LI->isLoopHeader(Succs[i])) {
1034         Succs.erase(Succs.begin()+i);
1035         --i;
1036       }
1037     }
1038   
1039   for (unsigned i = 0, e = Succs.size(); i != e; ++i)
1040     RemoveBlockIfDead(Succs[i], Worklist, L);
1041 }
1042
1043 /// RemoveLoopFromHierarchy - We have discovered that the specified loop has
1044 /// become unwrapped, either because the backedge was deleted, or because the
1045 /// edge into the header was removed.  If the edge into the header from the
1046 /// latch block was removed, the loop is unwrapped but subloops are still alive,
1047 /// so they just reparent loops.  If the loops are actually dead, they will be
1048 /// removed later.
1049 void LoopUnswitch::RemoveLoopFromHierarchy(Loop *L) {
1050   LPM->deleteLoopFromQueue(L);
1051   RemoveLoopFromWorklist(L);
1052 }
1053
1054 // RewriteLoopBodyWithConditionConstant - We know either that the value LIC has
1055 // the value specified by Val in the specified loop, or we know it does NOT have
1056 // that value.  Rewrite any uses of LIC or of properties correlated to it.
1057 void LoopUnswitch::RewriteLoopBodyWithConditionConstant(Loop *L, Value *LIC,
1058                                                         Constant *Val,
1059                                                         bool IsEqual) {
1060   assert(!isa<Constant>(LIC) && "Why are we unswitching on a constant?");
1061   
1062   // FIXME: Support correlated properties, like:
1063   //  for (...)
1064   //    if (li1 < li2)
1065   //      ...
1066   //    if (li1 > li2)
1067   //      ...
1068   
1069   // FOLD boolean conditions (X|LIC), (X&LIC).  Fold conditional branches,
1070   // selects, switches.
1071   std::vector<Instruction*> Worklist;
1072   LLVMContext &Context = Val->getContext();
1073
1074
1075   // If we know that LIC == Val, or that LIC == NotVal, just replace uses of LIC
1076   // in the loop with the appropriate one directly.
1077   if (IsEqual || (isa<ConstantInt>(Val) &&
1078       Val->getType()->isIntegerTy(1))) {
1079     Value *Replacement;
1080     if (IsEqual)
1081       Replacement = Val;
1082     else
1083       Replacement = ConstantInt::get(Type::getInt1Ty(Val->getContext()), 
1084                                      !cast<ConstantInt>(Val)->getZExtValue());
1085     
1086     for (Value::use_iterator UI = LIC->use_begin(), E = LIC->use_end();
1087          UI != E; ++UI) {
1088       Instruction *U = dyn_cast<Instruction>(*UI);
1089       if (!U || !L->contains(U))
1090         continue;
1091       Worklist.push_back(U);
1092     }
1093     
1094     for (std::vector<Instruction*>::iterator UI = Worklist.begin();
1095          UI != Worklist.end(); ++UI)
1096       (*UI)->replaceUsesOfWith(LIC, Replacement);        
1097     
1098     SimplifyCode(Worklist, L);
1099     return;
1100   }
1101   
1102   // Otherwise, we don't know the precise value of LIC, but we do know that it
1103   // is certainly NOT "Val".  As such, simplify any uses in the loop that we
1104   // can.  This case occurs when we unswitch switch statements.
1105   for (Value::use_iterator UI = LIC->use_begin(), E = LIC->use_end();
1106        UI != E; ++UI) {
1107     Instruction *U = dyn_cast<Instruction>(*UI);
1108     if (!U || !L->contains(U))
1109       continue;
1110
1111     Worklist.push_back(U);
1112
1113     // TODO: We could do other simplifications, for example, turning 
1114     // 'icmp eq LIC, Val' -> false.
1115
1116     // If we know that LIC is not Val, use this info to simplify code.
1117     SwitchInst *SI = dyn_cast<SwitchInst>(U);
1118     if (SI == 0 || !isa<ConstantInt>(Val)) continue;
1119     
1120     unsigned DeadCase = SI->findCaseValue(cast<ConstantInt>(Val));
1121     // Default case is live for multiple values.
1122     if (DeadCase == SwitchInst::ErrorIndex) continue;
1123     
1124     // Found a dead case value.  Don't remove PHI nodes in the 
1125     // successor if they become single-entry, those PHI nodes may
1126     // be in the Users list.
1127
1128     BasicBlock *Switch = SI->getParent();
1129     BasicBlock *SISucc = SI->getCaseSuccessor(DeadCase);
1130     BasicBlock *Latch = L->getLoopLatch();
1131     
1132     BranchesInfo.setUnswitched(SI, Val);
1133     
1134     if (!SI->findCaseDest(SISucc)) continue;  // Edge is critical.
1135     // If the DeadCase successor dominates the loop latch, then the
1136     // transformation isn't safe since it will delete the sole predecessor edge
1137     // to the latch.
1138     if (Latch && DT->dominates(SISucc, Latch))
1139       continue;
1140
1141     // FIXME: This is a hack.  We need to keep the successor around
1142     // and hooked up so as to preserve the loop structure, because
1143     // trying to update it is complicated.  So instead we preserve the
1144     // loop structure and put the block on a dead code path.
1145     SplitEdge(Switch, SISucc, this);
1146     // Compute the successors instead of relying on the return value
1147     // of SplitEdge, since it may have split the switch successor
1148     // after PHI nodes.
1149     BasicBlock *NewSISucc = SI->getCaseSuccessor(DeadCase);
1150     BasicBlock *OldSISucc = *succ_begin(NewSISucc);
1151     // Create an "unreachable" destination.
1152     BasicBlock *Abort = BasicBlock::Create(Context, "us-unreachable",
1153                                            Switch->getParent(),
1154                                            OldSISucc);
1155     new UnreachableInst(Context, Abort);
1156     // Force the new case destination to branch to the "unreachable"
1157     // block while maintaining a (dead) CFG edge to the old block.
1158     NewSISucc->getTerminator()->eraseFromParent();
1159     BranchInst::Create(Abort, OldSISucc,
1160                        ConstantInt::getTrue(Context), NewSISucc);
1161     // Release the PHI operands for this edge.
1162     for (BasicBlock::iterator II = NewSISucc->begin();
1163          PHINode *PN = dyn_cast<PHINode>(II); ++II)
1164       PN->setIncomingValue(PN->getBasicBlockIndex(Switch),
1165                            UndefValue::get(PN->getType()));
1166     // Tell the domtree about the new block. We don't fully update the
1167     // domtree here -- instead we force it to do a full recomputation
1168     // after the pass is complete -- but we do need to inform it of
1169     // new blocks.
1170     if (DT)
1171       DT->addNewBlock(Abort, NewSISucc);
1172   }
1173   
1174   SimplifyCode(Worklist, L);
1175 }
1176
1177 /// SimplifyCode - Okay, now that we have simplified some instructions in the
1178 /// loop, walk over it and constant prop, dce, and fold control flow where
1179 /// possible.  Note that this is effectively a very simple loop-structure-aware
1180 /// optimizer.  During processing of this loop, L could very well be deleted, so
1181 /// it must not be used.
1182 ///
1183 /// FIXME: When the loop optimizer is more mature, separate this out to a new
1184 /// pass.
1185 ///
1186 void LoopUnswitch::SimplifyCode(std::vector<Instruction*> &Worklist, Loop *L) {
1187   while (!Worklist.empty()) {
1188     Instruction *I = Worklist.back();
1189     Worklist.pop_back();
1190
1191     // Simple DCE.
1192     if (isInstructionTriviallyDead(I)) {
1193       DEBUG(dbgs() << "Remove dead instruction '" << *I);
1194       
1195       // Add uses to the worklist, which may be dead now.
1196       for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1197         if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
1198           Worklist.push_back(Use);
1199       LPM->deleteSimpleAnalysisValue(I, L);
1200       RemoveFromWorklist(I, Worklist);
1201       I->eraseFromParent();
1202       ++NumSimplify;
1203       continue;
1204     }
1205
1206     // See if instruction simplification can hack this up.  This is common for
1207     // things like "select false, X, Y" after unswitching made the condition be
1208     // 'false'.
1209     if (Value *V = SimplifyInstruction(I, 0, 0, DT))
1210       if (LI->replacementPreservesLCSSAForm(I, V)) {
1211         ReplaceUsesOfWith(I, V, Worklist, L, LPM);
1212         continue;
1213       }
1214
1215     // Special case hacks that appear commonly in unswitched code.
1216     if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
1217       if (BI->isUnconditional()) {
1218         // If BI's parent is the only pred of the successor, fold the two blocks
1219         // together.
1220         BasicBlock *Pred = BI->getParent();
1221         BasicBlock *Succ = BI->getSuccessor(0);
1222         BasicBlock *SinglePred = Succ->getSinglePredecessor();
1223         if (!SinglePred) continue;  // Nothing to do.
1224         assert(SinglePred == Pred && "CFG broken");
1225
1226         DEBUG(dbgs() << "Merging blocks: " << Pred->getName() << " <- " 
1227               << Succ->getName() << "\n");
1228         
1229         // Resolve any single entry PHI nodes in Succ.
1230         while (PHINode *PN = dyn_cast<PHINode>(Succ->begin()))
1231           ReplaceUsesOfWith(PN, PN->getIncomingValue(0), Worklist, L, LPM);
1232         
1233         // If Succ has any successors with PHI nodes, update them to have
1234         // entries coming from Pred instead of Succ.
1235         Succ->replaceAllUsesWith(Pred);
1236         
1237         // Move all of the successor contents from Succ to Pred.
1238         Pred->getInstList().splice(BI, Succ->getInstList(), Succ->begin(),
1239                                    Succ->end());
1240         LPM->deleteSimpleAnalysisValue(BI, L);
1241         BI->eraseFromParent();
1242         RemoveFromWorklist(BI, Worklist);
1243         
1244         // Remove Succ from the loop tree.
1245         LI->removeBlock(Succ);
1246         LPM->deleteSimpleAnalysisValue(Succ, L);
1247         Succ->eraseFromParent();
1248         ++NumSimplify;
1249         continue;
1250       }
1251       
1252       if (ConstantInt *CB = dyn_cast<ConstantInt>(BI->getCondition())){
1253         // Conditional branch.  Turn it into an unconditional branch, then
1254         // remove dead blocks.
1255         continue;  // FIXME: Enable.
1256
1257         DEBUG(dbgs() << "Folded branch: " << *BI);
1258         BasicBlock *DeadSucc = BI->getSuccessor(CB->getZExtValue());
1259         BasicBlock *LiveSucc = BI->getSuccessor(!CB->getZExtValue());
1260         DeadSucc->removePredecessor(BI->getParent(), true);
1261         Worklist.push_back(BranchInst::Create(LiveSucc, BI));
1262         LPM->deleteSimpleAnalysisValue(BI, L);
1263         BI->eraseFromParent();
1264         RemoveFromWorklist(BI, Worklist);
1265         ++NumSimplify;
1266
1267         RemoveBlockIfDead(DeadSucc, Worklist, L);
1268       }
1269       continue;
1270     }
1271   }
1272 }