1 //===-- LICM.cpp - Loop Invariant Code Motion 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 loop invariant code motion, attempting to remove as much
11 // code from the body of a loop as possible. It does this by either hoisting
12 // code into the preheader block, or by sinking code to the exit blocks if it is
13 // safe. This pass also promotes must-aliased memory locations in the loop to
14 // live in registers, thus hoisting and sinking "invariant" loads and stores.
16 // This pass uses alias analysis for two purposes:
18 // 1. Moving loop invariant loads and calls out of loops. If we can determine
19 // that a load or call inside of a loop never aliases anything stored to,
20 // we can hoist it or sink it like any other instruction.
21 // 2. Scalar Promotion of Memory - If there is a store instruction inside of
22 // the loop, we try to move the store to happen AFTER the loop instead of
23 // inside of the loop. This can only happen if a few conditions are true:
24 // A. The pointer stored through is loop invariant
25 // B. There are no stores or loads in the loop which _may_ alias the
26 // pointer. There are no calls in the loop which mod/ref the pointer.
27 // If these conditions are true, we can promote the loads and stores in the
28 // loop of the pointer to use a temporary alloca'd variable. We then use
29 // the SSAUpdater to construct the appropriate SSA form for the value.
31 //===----------------------------------------------------------------------===//
33 #define DEBUG_TYPE "licm"
34 #include "llvm/Transforms/Scalar.h"
35 #include "llvm/Constants.h"
36 #include "llvm/DerivedTypes.h"
37 #include "llvm/IntrinsicInst.h"
38 #include "llvm/Instructions.h"
39 #include "llvm/LLVMContext.h"
40 #include "llvm/Analysis/AliasAnalysis.h"
41 #include "llvm/Analysis/AliasSetTracker.h"
42 #include "llvm/Analysis/ConstantFolding.h"
43 #include "llvm/Analysis/LoopInfo.h"
44 #include "llvm/Analysis/LoopPass.h"
45 #include "llvm/Analysis/Dominators.h"
46 #include "llvm/Transforms/Utils/Local.h"
47 #include "llvm/Transforms/Utils/SSAUpdater.h"
48 #include "llvm/Support/CFG.h"
49 #include "llvm/Support/CommandLine.h"
50 #include "llvm/Support/raw_ostream.h"
51 #include "llvm/Support/Debug.h"
52 #include "llvm/ADT/Statistic.h"
56 STATISTIC(NumSunk , "Number of instructions sunk out of loop");
57 STATISTIC(NumHoisted , "Number of instructions hoisted out of loop");
58 STATISTIC(NumMovedLoads, "Number of load insts hoisted or sunk");
59 STATISTIC(NumMovedCalls, "Number of call insts hoisted or sunk");
60 STATISTIC(NumPromoted , "Number of memory locations promoted to registers");
63 DisablePromotion("disable-licm-promotion", cl::Hidden,
64 cl::desc("Disable memory promotion in LICM pass"));
67 struct LICM : public LoopPass {
68 static char ID; // Pass identification, replacement for typeid
69 LICM() : LoopPass(ID) {
70 initializeLICMPass(*PassRegistry::getPassRegistry());
73 virtual bool runOnLoop(Loop *L, LPPassManager &LPM);
75 /// This transformation requires natural loop information & requires that
76 /// loop preheaders be inserted into the CFG...
78 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
80 AU.addRequired<DominatorTree>();
81 AU.addRequired<LoopInfo>();
82 AU.addRequiredID(LoopSimplifyID);
83 AU.addRequired<AliasAnalysis>();
84 AU.addPreserved<AliasAnalysis>();
85 AU.addPreserved("scalar-evolution");
86 AU.addPreservedID(LoopSimplifyID);
89 bool doFinalization() {
90 assert(LoopToAliasSetMap.empty() && "Didn't free loop alias sets");
95 AliasAnalysis *AA; // Current AliasAnalysis information
96 LoopInfo *LI; // Current LoopInfo
97 DominatorTree *DT; // Dominator Tree for the current Loop.
99 // State that is updated as we process loops.
100 bool Changed; // Set to true when we change anything.
101 BasicBlock *Preheader; // The preheader block of the current loop...
102 Loop *CurLoop; // The current loop we are working on...
103 AliasSetTracker *CurAST; // AliasSet information for the current loop...
104 DenseMap<Loop*, AliasSetTracker*> LoopToAliasSetMap;
106 /// cloneBasicBlockAnalysis - Simple Analysis hook. Clone alias set info.
107 void cloneBasicBlockAnalysis(BasicBlock *From, BasicBlock *To, Loop *L);
109 /// deleteAnalysisValue - Simple Analysis hook. Delete value V from alias
111 void deleteAnalysisValue(Value *V, Loop *L);
113 /// SinkRegion - Walk the specified region of the CFG (defined by all blocks
114 /// dominated by the specified block, and that are in the current loop) in
115 /// reverse depth first order w.r.t the DominatorTree. This allows us to
116 /// visit uses before definitions, allowing us to sink a loop body in one
117 /// pass without iteration.
119 void SinkRegion(DomTreeNode *N);
121 /// HoistRegion - Walk the specified region of the CFG (defined by all
122 /// blocks dominated by the specified block, and that are in the current
123 /// loop) in depth first order w.r.t the DominatorTree. This allows us to
124 /// visit definitions before uses, allowing us to hoist a loop body in one
125 /// pass without iteration.
127 void HoistRegion(DomTreeNode *N);
129 /// inSubLoop - Little predicate that returns true if the specified basic
130 /// block is in a subloop of the current one, not the current one itself.
132 bool inSubLoop(BasicBlock *BB) {
133 assert(CurLoop->contains(BB) && "Only valid if BB is IN the loop");
134 return LI->getLoopFor(BB) != CurLoop;
137 /// sink - When an instruction is found to only be used outside of the loop,
138 /// this function moves it to the exit blocks and patches up SSA form as
141 void sink(Instruction &I);
143 /// hoist - When an instruction is found to only use loop invariant operands
144 /// that is safe to hoist, this instruction is called to do the dirty work.
146 void hoist(Instruction &I);
148 /// isSafeToExecuteUnconditionally - Only sink or hoist an instruction if it
149 /// is not a trapping instruction or if it is a trapping instruction and is
150 /// guaranteed to execute.
152 bool isSafeToExecuteUnconditionally(Instruction &I);
154 /// pointerInvalidatedByLoop - Return true if the body of this loop may
155 /// store into the memory location pointed to by V.
157 bool pointerInvalidatedByLoop(Value *V, uint64_t Size,
158 const MDNode *TBAAInfo) {
159 // Check to see if any of the basic blocks in CurLoop invalidate *V.
160 return CurAST->getAliasSetForPointer(V, Size, TBAAInfo).isMod();
163 bool canSinkOrHoistInst(Instruction &I);
164 bool isNotUsedInLoop(Instruction &I);
166 void PromoteAliasSet(AliasSet &AS);
171 INITIALIZE_PASS_BEGIN(LICM, "licm", "Loop Invariant Code Motion", false, false)
172 INITIALIZE_PASS_DEPENDENCY(DominatorTree)
173 INITIALIZE_PASS_DEPENDENCY(LoopInfo)
174 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
175 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
176 INITIALIZE_PASS_END(LICM, "licm", "Loop Invariant Code Motion", false, false)
178 Pass *llvm::createLICMPass() { return new LICM(); }
180 /// Hoist expressions out of the specified loop. Note, alias info for inner
181 /// loop is not preserved so it is not a good idea to run LICM multiple
182 /// times on one loop.
184 bool LICM::runOnLoop(Loop *L, LPPassManager &LPM) {
187 // Get our Loop and Alias Analysis information...
188 LI = &getAnalysis<LoopInfo>();
189 AA = &getAnalysis<AliasAnalysis>();
190 DT = &getAnalysis<DominatorTree>();
192 CurAST = new AliasSetTracker(*AA);
193 // Collect Alias info from subloops.
194 for (Loop::iterator LoopItr = L->begin(), LoopItrE = L->end();
195 LoopItr != LoopItrE; ++LoopItr) {
196 Loop *InnerL = *LoopItr;
197 AliasSetTracker *InnerAST = LoopToAliasSetMap[InnerL];
198 assert(InnerAST && "Where is my AST?");
200 // What if InnerLoop was modified by other passes ?
201 CurAST->add(*InnerAST);
203 // Once we've incorporated the inner loop's AST into ours, we don't need the
204 // subloop's anymore.
206 LoopToAliasSetMap.erase(InnerL);
211 // Get the preheader block to move instructions into...
212 Preheader = L->getLoopPreheader();
214 // Loop over the body of this loop, looking for calls, invokes, and stores.
215 // Because subloops have already been incorporated into AST, we skip blocks in
218 for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
221 if (LI->getLoopFor(BB) == L) // Ignore blocks in subloops.
222 CurAST->add(*BB); // Incorporate the specified basic block
225 // We want to visit all of the instructions in this loop... that are not parts
226 // of our subloops (they have already had their invariants hoisted out of
227 // their loop, into this loop, so there is no need to process the BODIES of
230 // Traverse the body of the loop in depth first order on the dominator tree so
231 // that we are guaranteed to see definitions before we see uses. This allows
232 // us to sink instructions in one pass, without iteration. After sinking
233 // instructions, we perform another pass to hoist them out of the loop.
235 if (L->hasDedicatedExits())
236 SinkRegion(DT->getNode(L->getHeader()));
238 HoistRegion(DT->getNode(L->getHeader()));
240 // Now that all loop invariants have been removed from the loop, promote any
241 // memory references to scalars that we can.
242 if (!DisablePromotion && Preheader && L->hasDedicatedExits()) {
243 // Loop over all of the alias sets in the tracker object.
244 for (AliasSetTracker::iterator I = CurAST->begin(), E = CurAST->end();
249 // Clear out loops state information for the next iteration
253 // If this loop is nested inside of another one, save the alias information
254 // for when we process the outer loop.
255 if (L->getParentLoop())
256 LoopToAliasSetMap[L] = CurAST;
262 /// SinkRegion - Walk the specified region of the CFG (defined by all blocks
263 /// dominated by the specified block, and that are in the current loop) in
264 /// reverse depth first order w.r.t the DominatorTree. This allows us to visit
265 /// uses before definitions, allowing us to sink a loop body in one pass without
268 void LICM::SinkRegion(DomTreeNode *N) {
269 assert(N != 0 && "Null dominator tree node?");
270 BasicBlock *BB = N->getBlock();
272 // If this subregion is not in the top level loop at all, exit.
273 if (!CurLoop->contains(BB)) return;
275 // We are processing blocks in reverse dfo, so process children first.
276 const std::vector<DomTreeNode*> &Children = N->getChildren();
277 for (unsigned i = 0, e = Children.size(); i != e; ++i)
278 SinkRegion(Children[i]);
280 // Only need to process the contents of this block if it is not part of a
281 // subloop (which would already have been processed).
282 if (inSubLoop(BB)) return;
284 for (BasicBlock::iterator II = BB->end(); II != BB->begin(); ) {
285 Instruction &I = *--II;
287 // If the instruction is dead, we would try to sink it because it isn't used
288 // in the loop, instead, just delete it.
289 if (isInstructionTriviallyDead(&I)) {
290 DEBUG(dbgs() << "LICM deleting dead inst: " << I << '\n');
292 CurAST->deleteValue(&I);
298 // Check to see if we can sink this instruction to the exit blocks
299 // of the loop. We can do this if the all users of the instruction are
300 // outside of the loop. In this case, it doesn't even matter if the
301 // operands of the instruction are loop invariant.
303 if (isNotUsedInLoop(I) && canSinkOrHoistInst(I)) {
310 /// HoistRegion - Walk the specified region of the CFG (defined by all blocks
311 /// dominated by the specified block, and that are in the current loop) in depth
312 /// first order w.r.t the DominatorTree. This allows us to visit definitions
313 /// before uses, allowing us to hoist a loop body in one pass without iteration.
315 void LICM::HoistRegion(DomTreeNode *N) {
316 assert(N != 0 && "Null dominator tree node?");
317 BasicBlock *BB = N->getBlock();
319 // If this subregion is not in the top level loop at all, exit.
320 if (!CurLoop->contains(BB)) return;
322 // Only need to process the contents of this block if it is not part of a
323 // subloop (which would already have been processed).
325 for (BasicBlock::iterator II = BB->begin(), E = BB->end(); II != E; ) {
326 Instruction &I = *II++;
328 // Try constant folding this instruction. If all the operands are
329 // constants, it is technically hoistable, but it would be better to just
331 if (Constant *C = ConstantFoldInstruction(&I)) {
332 DEBUG(dbgs() << "LICM folding inst: " << I << " --> " << *C << '\n');
333 CurAST->copyValue(&I, C);
334 CurAST->deleteValue(&I);
335 I.replaceAllUsesWith(C);
340 // Try hoisting the instruction out to the preheader. We can only do this
341 // if all of the operands of the instruction are loop invariant and if it
342 // is safe to hoist the instruction.
344 if (CurLoop->hasLoopInvariantOperands(&I) && canSinkOrHoistInst(I) &&
345 isSafeToExecuteUnconditionally(I))
349 const std::vector<DomTreeNode*> &Children = N->getChildren();
350 for (unsigned i = 0, e = Children.size(); i != e; ++i)
351 HoistRegion(Children[i]);
354 /// canSinkOrHoistInst - Return true if the hoister and sinker can handle this
357 bool LICM::canSinkOrHoistInst(Instruction &I) {
358 // Loads have extra constraints we have to verify before we can hoist them.
359 if (LoadInst *LI = dyn_cast<LoadInst>(&I)) {
360 if (LI->isVolatile())
361 return false; // Don't hoist volatile loads!
363 // Loads from constant memory are always safe to move, even if they end up
364 // in the same alias set as something that ends up being modified.
365 if (AA->pointsToConstantMemory(LI->getOperand(0)))
368 // Don't hoist loads which have may-aliased stores in loop.
370 if (LI->getType()->isSized())
371 Size = AA->getTypeStoreSize(LI->getType());
372 return !pointerInvalidatedByLoop(LI->getOperand(0), Size,
373 LI->getMetadata(LLVMContext::MD_tbaa));
374 } else if (CallInst *CI = dyn_cast<CallInst>(&I)) {
375 // Handle obvious cases efficiently.
376 AliasAnalysis::ModRefBehavior Behavior = AA->getModRefBehavior(CI);
377 if (Behavior == AliasAnalysis::DoesNotAccessMemory)
379 if (AliasAnalysis::onlyReadsMemory(Behavior)) {
380 // If this call only reads from memory and there are no writes to memory
381 // in the loop, we can hoist or sink the call as appropriate.
382 bool FoundMod = false;
383 for (AliasSetTracker::iterator I = CurAST->begin(), E = CurAST->end();
386 if (!AS.isForwardingAliasSet() && AS.isMod()) {
391 if (!FoundMod) return true;
394 // FIXME: This should use mod/ref information to see if we can hoist or sink
400 // Otherwise these instructions are hoistable/sinkable
401 return isa<BinaryOperator>(I) || isa<CastInst>(I) ||
402 isa<SelectInst>(I) || isa<GetElementPtrInst>(I) || isa<CmpInst>(I) ||
403 isa<InsertElementInst>(I) || isa<ExtractElementInst>(I) ||
404 isa<ShuffleVectorInst>(I);
407 /// isNotUsedInLoop - Return true if the only users of this instruction are
408 /// outside of the loop. If this is true, we can sink the instruction to the
409 /// exit blocks of the loop.
411 bool LICM::isNotUsedInLoop(Instruction &I) {
412 for (Value::use_iterator UI = I.use_begin(), E = I.use_end(); UI != E; ++UI) {
413 Instruction *User = cast<Instruction>(*UI);
414 if (PHINode *PN = dyn_cast<PHINode>(User)) {
415 // PHI node uses occur in predecessor blocks!
416 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
417 if (PN->getIncomingValue(i) == &I)
418 if (CurLoop->contains(PN->getIncomingBlock(i)))
420 } else if (CurLoop->contains(User)) {
428 /// sink - When an instruction is found to only be used outside of the loop,
429 /// this function moves it to the exit blocks and patches up SSA form as needed.
430 /// This method is guaranteed to remove the original instruction from its
431 /// position, and may either delete it or move it to outside of the loop.
433 void LICM::sink(Instruction &I) {
434 DEBUG(dbgs() << "LICM sinking instruction: " << I << "\n");
436 SmallVector<BasicBlock*, 8> ExitBlocks;
437 CurLoop->getUniqueExitBlocks(ExitBlocks);
439 if (isa<LoadInst>(I)) ++NumMovedLoads;
440 else if (isa<CallInst>(I)) ++NumMovedCalls;
444 // The case where there is only a single exit node of this loop is common
445 // enough that we handle it as a special (more efficient) case. It is more
446 // efficient to handle because there are no PHI nodes that need to be placed.
447 if (ExitBlocks.size() == 1) {
448 if (!DT->dominates(I.getParent(), ExitBlocks[0])) {
449 // Instruction is not used, just delete it.
450 CurAST->deleteValue(&I);
451 // If I has users in unreachable blocks, eliminate.
452 // If I is not void type then replaceAllUsesWith undef.
453 // This allows ValueHandlers and custom metadata to adjust itself.
455 I.replaceAllUsesWith(UndefValue::get(I.getType()));
458 // Move the instruction to the start of the exit block, after any PHI
460 I.moveBefore(ExitBlocks[0]->getFirstNonPHI());
462 // This instruction is no longer in the AST for the current loop, because
463 // we just sunk it out of the loop. If we just sunk it into an outer
464 // loop, we will rediscover the operation when we process it.
465 CurAST->deleteValue(&I);
470 if (ExitBlocks.empty()) {
471 // The instruction is actually dead if there ARE NO exit blocks.
472 CurAST->deleteValue(&I);
473 // If I has users in unreachable blocks, eliminate.
474 // If I is not void type then replaceAllUsesWith undef.
475 // This allows ValueHandlers and custom metadata to adjust itself.
477 I.replaceAllUsesWith(UndefValue::get(I.getType()));
482 // Otherwise, if we have multiple exits, use the SSAUpdater to do all of the
483 // hard work of inserting PHI nodes as necessary.
484 SmallVector<PHINode*, 8> NewPHIs;
485 SSAUpdater SSA(&NewPHIs);
488 SSA.Initialize(I.getType(), I.getName());
490 // Insert a copy of the instruction in each exit block of the loop that is
491 // dominated by the instruction. Each exit block is known to only be in the
492 // ExitBlocks list once.
493 BasicBlock *InstOrigBB = I.getParent();
494 unsigned NumInserted = 0;
496 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
497 BasicBlock *ExitBlock = ExitBlocks[i];
499 if (!DT->dominates(InstOrigBB, ExitBlock))
502 // Insert the code after the last PHI node.
503 BasicBlock::iterator InsertPt = ExitBlock->getFirstNonPHI();
505 // If this is the first exit block processed, just move the original
506 // instruction, otherwise clone the original instruction and insert
509 if (NumInserted++ == 0) {
510 I.moveBefore(InsertPt);
514 if (!I.getName().empty())
515 New->setName(I.getName()+".le");
516 ExitBlock->getInstList().insert(InsertPt, New);
519 // Now that we have inserted the instruction, inform SSAUpdater.
521 SSA.AddAvailableValue(ExitBlock, New);
524 // If the instruction doesn't dominate any exit blocks, it must be dead.
525 if (NumInserted == 0) {
526 CurAST->deleteValue(&I);
528 I.replaceAllUsesWith(UndefValue::get(I.getType()));
533 // Next, rewrite uses of the instruction, inserting PHI nodes as needed.
534 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end(); UI != UE; ) {
535 // Grab the use before incrementing the iterator.
536 Use &U = UI.getUse();
537 // Increment the iterator before removing the use from the list.
539 SSA.RewriteUseAfterInsertions(U);
542 // Update CurAST for NewPHIs if I had pointer type.
543 if (I.getType()->isPointerTy())
544 for (unsigned i = 0, e = NewPHIs.size(); i != e; ++i)
545 CurAST->copyValue(&I, NewPHIs[i]);
547 // Finally, remove the instruction from CurAST. It is no longer in the loop.
548 CurAST->deleteValue(&I);
551 /// hoist - When an instruction is found to only use loop invariant operands
552 /// that is safe to hoist, this instruction is called to do the dirty work.
554 void LICM::hoist(Instruction &I) {
555 DEBUG(dbgs() << "LICM hoisting to " << Preheader->getName() << ": "
558 // Move the new node to the Preheader, before its terminator.
559 I.moveBefore(Preheader->getTerminator());
561 if (isa<LoadInst>(I)) ++NumMovedLoads;
562 else if (isa<CallInst>(I)) ++NumMovedCalls;
567 /// isSafeToExecuteUnconditionally - Only sink or hoist an instruction if it is
568 /// not a trapping instruction or if it is a trapping instruction and is
569 /// guaranteed to execute.
571 bool LICM::isSafeToExecuteUnconditionally(Instruction &Inst) {
572 // If it is not a trapping instruction, it is always safe to hoist.
573 if (Inst.isSafeToSpeculativelyExecute())
576 // Otherwise we have to check to make sure that the instruction dominates all
577 // of the exit blocks. If it doesn't, then there is a path out of the loop
578 // which does not execute this instruction, so we can't hoist it.
580 // If the instruction is in the header block for the loop (which is very
581 // common), it is always guaranteed to dominate the exit blocks. Since this
582 // is a common case, and can save some work, check it now.
583 if (Inst.getParent() == CurLoop->getHeader())
586 // Get the exit blocks for the current loop.
587 SmallVector<BasicBlock*, 8> ExitBlocks;
588 CurLoop->getExitBlocks(ExitBlocks);
590 // Verify that the block dominates each of the exit blocks of the loop.
591 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i)
592 if (!DT->dominates(Inst.getParent(), ExitBlocks[i]))
598 /// PromoteAliasSet - Try to promote memory values to scalars by sinking
599 /// stores out of the loop and moving loads to before the loop. We do this by
600 /// looping over the stores in the loop, looking for stores to Must pointers
601 /// which are loop invariant.
603 void LICM::PromoteAliasSet(AliasSet &AS) {
604 // We can promote this alias set if it has a store, if it is a "Must" alias
605 // set, if the pointer is loop invariant, and if we are not eliminating any
606 // volatile loads or stores.
607 if (AS.isForwardingAliasSet() || !AS.isMod() || !AS.isMustAlias() ||
608 AS.isVolatile() || !CurLoop->isLoopInvariant(AS.begin()->getValue()))
611 assert(!AS.empty() &&
612 "Must alias set should have at least one pointer element in it!");
613 Value *SomePtr = AS.begin()->getValue();
615 // It isn't safe to promote a load/store from the loop if the load/store is
616 // conditional. For example, turning:
618 // for () { if (c) *P += 1; }
622 // tmp = *P; for () { if (c) tmp +=1; } *P = tmp;
624 // is not safe, because *P may only be valid to access if 'c' is true.
626 // It is safe to promote P if all uses are direct load/stores and if at
627 // least one is guaranteed to be executed.
628 bool GuaranteedToExecute = false;
630 SmallVector<Instruction*, 64> LoopUses;
631 SmallPtrSet<Value*, 4> PointerMustAliases;
633 // Check that all of the pointers in the alias set have the same type. We
634 // cannot (yet) promote a memory location that is loaded and stored in
636 for (AliasSet::iterator ASI = AS.begin(), E = AS.end(); ASI != E; ++ASI) {
637 Value *ASIV = ASI->getValue();
638 PointerMustAliases.insert(ASIV);
640 // Check that all of the pointers in the alias set have the same type. We
641 // cannot (yet) promote a memory location that is loaded and stored in
643 if (SomePtr->getType() != ASIV->getType())
646 for (Value::use_iterator UI = ASIV->use_begin(), UE = ASIV->use_end();
648 // Ignore instructions that are outside the loop.
649 Instruction *Use = dyn_cast<Instruction>(*UI);
650 if (!Use || !CurLoop->contains(Use))
653 // If there is an non-load/store instruction in the loop, we can't promote
655 if (isa<LoadInst>(Use))
656 assert(!cast<LoadInst>(Use)->isVolatile() && "AST broken");
657 else if (isa<StoreInst>(Use)) {
658 // Stores *of* the pointer are not interesting, only stores *to* the
660 if (Use->getOperand(1) != ASIV)
662 assert(!cast<StoreInst>(Use)->isVolatile() && "AST broken");
664 return; // Not a load or store.
666 if (!GuaranteedToExecute)
667 GuaranteedToExecute = isSafeToExecuteUnconditionally(*Use);
669 LoopUses.push_back(Use);
673 // If there isn't a guaranteed-to-execute instruction, we can't promote.
674 if (!GuaranteedToExecute)
677 // Otherwise, this is safe to promote, lets do it!
678 DEBUG(dbgs() << "LICM: Promoting value stored to in loop: " <<*SomePtr<<'\n');
682 // We use the SSAUpdater interface to insert phi nodes as required.
683 SmallVector<PHINode*, 16> NewPHIs;
684 SSAUpdater SSA(&NewPHIs);
686 // It wants to know some value of the same type as what we'll be inserting.
688 if (isa<LoadInst>(LoopUses[0]))
689 SomeValue = LoopUses[0];
691 SomeValue = cast<StoreInst>(LoopUses[0])->getOperand(0);
692 SSA.Initialize(SomeValue->getType(), SomeValue->getName());
694 // First step: bucket up uses of the pointers by the block they occur in.
695 // This is important because we have to handle multiple defs/uses in a block
696 // ourselves: SSAUpdater is purely for cross-block references.
697 // FIXME: Want a TinyVector<Instruction*> since there is usually 0/1 element.
698 DenseMap<BasicBlock*, std::vector<Instruction*> > UsesByBlock;
699 for (unsigned i = 0, e = LoopUses.size(); i != e; ++i) {
700 Instruction *User = LoopUses[i];
701 UsesByBlock[User->getParent()].push_back(User);
704 // Okay, now we can iterate over all the blocks in the loop with uses,
705 // processing them. Keep track of which loads are loading a live-in value.
706 SmallVector<LoadInst*, 32> LiveInLoads;
707 DenseMap<Value*, Value*> ReplacedLoads;
709 for (unsigned LoopUse = 0, e = LoopUses.size(); LoopUse != e; ++LoopUse) {
710 Instruction *User = LoopUses[LoopUse];
711 std::vector<Instruction*> &BlockUses = UsesByBlock[User->getParent()];
713 // If this block has already been processed, ignore this repeat use.
714 if (BlockUses.empty()) continue;
716 // Okay, this is the first use in the block. If this block just has a
717 // single user in it, we can rewrite it trivially.
718 if (BlockUses.size() == 1) {
719 // If it is a store, it is a trivial def of the value in the block.
720 if (isa<StoreInst>(User)) {
721 SSA.AddAvailableValue(User->getParent(),
722 cast<StoreInst>(User)->getOperand(0));
724 // Otherwise it is a load, queue it to rewrite as a live-in load.
725 LiveInLoads.push_back(cast<LoadInst>(User));
731 // Otherwise, check to see if this block is all loads. If so, we can queue
732 // them all as live in loads.
733 bool HasStore = false;
734 for (unsigned i = 0, e = BlockUses.size(); i != e; ++i) {
735 if (isa<StoreInst>(BlockUses[i])) {
742 for (unsigned i = 0, e = BlockUses.size(); i != e; ++i)
743 LiveInLoads.push_back(cast<LoadInst>(BlockUses[i]));
748 // Otherwise, we have mixed loads and stores (or just a bunch of stores).
749 // Since SSAUpdater is purely for cross-block values, we need to determine
750 // the order of these instructions in the block. If the first use in the
751 // block is a load, then it uses the live in value. The last store defines
752 // the live out value. We handle this by doing a linear scan of the block.
753 BasicBlock *BB = User->getParent();
754 Value *StoredValue = 0;
755 for (BasicBlock::iterator II = BB->begin(), E = BB->end(); II != E; ++II) {
756 if (LoadInst *L = dyn_cast<LoadInst>(II)) {
757 // If this is a load from an unrelated pointer, ignore it.
758 if (!PointerMustAliases.count(L->getOperand(0))) continue;
760 // If we haven't seen a store yet, this is a live in use, otherwise
761 // use the stored value.
763 L->replaceAllUsesWith(StoredValue);
764 ReplacedLoads[L] = StoredValue;
766 LiveInLoads.push_back(L);
771 if (StoreInst *S = dyn_cast<StoreInst>(II)) {
772 // If this is a store to an unrelated pointer, ignore it.
773 if (!PointerMustAliases.count(S->getOperand(1))) continue;
775 // Remember that this is the active value in the block.
776 StoredValue = S->getOperand(0);
780 // The last stored value that happened is the live-out for the block.
781 assert(StoredValue && "Already checked that there is a store in block");
782 SSA.AddAvailableValue(BB, StoredValue);
786 // Now that all the intra-loop values are classified, set up the preheader.
787 // It gets a load of the pointer we're promoting, and it is the live-out value
788 // from the preheader.
789 LoadInst *PreheaderLoad = new LoadInst(SomePtr,SomePtr->getName()+".promoted",
790 Preheader->getTerminator());
791 SSA.AddAvailableValue(Preheader, PreheaderLoad);
793 // Now that the preheader is good to go, set up the exit blocks. Each exit
794 // block gets a store of the live-out values that feed them. Since we've
795 // already told the SSA updater about the defs in the loop and the preheader
796 // definition, it is all set and we can start using it.
797 SmallVector<BasicBlock*, 8> ExitBlocks;
798 CurLoop->getUniqueExitBlocks(ExitBlocks);
799 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
800 BasicBlock *ExitBlock = ExitBlocks[i];
801 Value *LiveInValue = SSA.GetValueInMiddleOfBlock(ExitBlock);
802 Instruction *InsertPos = ExitBlock->getFirstNonPHI();
803 new StoreInst(LiveInValue, SomePtr, InsertPos);
806 // Okay, now we rewrite all loads that use live-in values in the loop,
807 // inserting PHI nodes as necessary.
808 for (unsigned i = 0, e = LiveInLoads.size(); i != e; ++i) {
809 LoadInst *ALoad = LiveInLoads[i];
810 Value *NewVal = SSA.GetValueInMiddleOfBlock(ALoad->getParent());
811 ALoad->replaceAllUsesWith(NewVal);
812 CurAST->copyValue(ALoad, NewVal);
813 ReplacedLoads[ALoad] = NewVal;
816 // If the preheader load is itself a pointer, we need to tell alias analysis
817 // about the new pointer we created in the preheader block and about any PHI
818 // nodes that just got inserted.
819 if (PreheaderLoad->getType()->isPointerTy()) {
820 // Copy any value stored to or loaded from a must-alias of the pointer.
821 CurAST->copyValue(SomeValue, PreheaderLoad);
823 for (unsigned i = 0, e = NewPHIs.size(); i != e; ++i)
824 CurAST->copyValue(SomeValue, NewPHIs[i]);
827 // Now that everything is rewritten, delete the old instructions from the body
828 // of the loop. They should all be dead now.
829 for (unsigned i = 0, e = LoopUses.size(); i != e; ++i) {
830 Instruction *User = LoopUses[i];
832 // If this is a load that still has uses, then the load must have been added
833 // as a live value in the SSAUpdate data structure for a block (e.g. because
834 // the loaded value was stored later). In this case, we need to recursively
835 // propagate the updates until we get to the real value.
836 if (!User->use_empty()) {
837 Value *NewVal = ReplacedLoads[User];
838 assert(NewVal && "not a replaced load?");
840 // Propagate down to the ultimate replacee. The intermediately loads
841 // could theoretically already have been deleted, so we don't want to
842 // dereference the Value*'s.
843 DenseMap<Value*, Value*>::iterator RLI = ReplacedLoads.find(NewVal);
844 while (RLI != ReplacedLoads.end()) {
845 NewVal = RLI->second;
846 RLI = ReplacedLoads.find(NewVal);
849 User->replaceAllUsesWith(NewVal);
850 CurAST->copyValue(User, NewVal);
853 CurAST->deleteValue(User);
854 User->eraseFromParent();
861 /// cloneBasicBlockAnalysis - Simple Analysis hook. Clone alias set info.
862 void LICM::cloneBasicBlockAnalysis(BasicBlock *From, BasicBlock *To, Loop *L) {
863 AliasSetTracker *AST = LoopToAliasSetMap.lookup(L);
867 AST->copyValue(From, To);
870 /// deleteAnalysisValue - Simple Analysis hook. Delete value V from alias
872 void LICM::deleteAnalysisValue(Value *V, Loop *L) {
873 AliasSetTracker *AST = LoopToAliasSetMap.lookup(L);