1f22ef01cSRoman Divacky //===- MemoryDependenceAnalysis.cpp - Mem Deps Implementation  --*- C++ -*-===//
2f22ef01cSRoman Divacky //
3f22ef01cSRoman Divacky //                     The LLVM Compiler Infrastructure
4f22ef01cSRoman Divacky //
5f22ef01cSRoman Divacky // This file is distributed under the University of Illinois Open Source
6f22ef01cSRoman Divacky // License. See LICENSE.TXT for details.
7f22ef01cSRoman Divacky //
8f22ef01cSRoman Divacky //===----------------------------------------------------------------------===//
9f22ef01cSRoman Divacky //
10f22ef01cSRoman Divacky // This file implements an analysis that determines, for a given memory
11f22ef01cSRoman Divacky // operation, what preceding memory operations it depends on.  It builds on
12f22ef01cSRoman Divacky // alias analysis information, and tries to provide a lazy, caching interface to
13f22ef01cSRoman Divacky // a common kind of alias information query.
14f22ef01cSRoman Divacky //
15f22ef01cSRoman Divacky //===----------------------------------------------------------------------===//
16f22ef01cSRoman Divacky 
17f22ef01cSRoman Divacky #define DEBUG_TYPE "memdep"
18f22ef01cSRoman Divacky #include "llvm/Analysis/MemoryDependenceAnalysis.h"
193b0f4066SDimitry Andric #include "llvm/Analysis/ValueTracking.h"
20f22ef01cSRoman Divacky #include "llvm/Instructions.h"
21f22ef01cSRoman Divacky #include "llvm/IntrinsicInst.h"
22f22ef01cSRoman Divacky #include "llvm/Function.h"
232754fe60SDimitry Andric #include "llvm/LLVMContext.h"
24f22ef01cSRoman Divacky #include "llvm/Analysis/AliasAnalysis.h"
25f22ef01cSRoman Divacky #include "llvm/Analysis/Dominators.h"
26f22ef01cSRoman Divacky #include "llvm/Analysis/InstructionSimplify.h"
27f22ef01cSRoman Divacky #include "llvm/Analysis/MemoryBuiltins.h"
28f22ef01cSRoman Divacky #include "llvm/Analysis/PHITransAddr.h"
292754fe60SDimitry Andric #include "llvm/Analysis/ValueTracking.h"
30f22ef01cSRoman Divacky #include "llvm/ADT/Statistic.h"
31f22ef01cSRoman Divacky #include "llvm/ADT/STLExtras.h"
32f22ef01cSRoman Divacky #include "llvm/Support/PredIteratorCache.h"
33f22ef01cSRoman Divacky #include "llvm/Support/Debug.h"
342754fe60SDimitry Andric #include "llvm/Target/TargetData.h"
35f22ef01cSRoman Divacky using namespace llvm;
36f22ef01cSRoman Divacky 
37f22ef01cSRoman Divacky STATISTIC(NumCacheNonLocal, "Number of fully cached non-local responses");
38f22ef01cSRoman Divacky STATISTIC(NumCacheDirtyNonLocal, "Number of dirty cached non-local responses");
39f22ef01cSRoman Divacky STATISTIC(NumUncacheNonLocal, "Number of uncached non-local responses");
40f22ef01cSRoman Divacky 
41f22ef01cSRoman Divacky STATISTIC(NumCacheNonLocalPtr,
42f22ef01cSRoman Divacky           "Number of fully cached non-local ptr responses");
43f22ef01cSRoman Divacky STATISTIC(NumCacheDirtyNonLocalPtr,
44f22ef01cSRoman Divacky           "Number of cached, but dirty, non-local ptr responses");
45f22ef01cSRoman Divacky STATISTIC(NumUncacheNonLocalPtr,
46f22ef01cSRoman Divacky           "Number of uncached non-local ptr responses");
47f22ef01cSRoman Divacky STATISTIC(NumCacheCompleteNonLocalPtr,
48f22ef01cSRoman Divacky           "Number of block queries that were completely cached");
49f22ef01cSRoman Divacky 
5017a519f9SDimitry Andric // Limit for the number of instructions to scan in a block.
5117a519f9SDimitry Andric // FIXME: Figure out what a sane value is for this.
5217a519f9SDimitry Andric //        (500 is relatively insane.)
5317a519f9SDimitry Andric static const int BlockScanLimit = 500;
5417a519f9SDimitry Andric 
55f22ef01cSRoman Divacky char MemoryDependenceAnalysis::ID = 0;
56f22ef01cSRoman Divacky 
57f22ef01cSRoman Divacky // Register this pass...
582754fe60SDimitry Andric INITIALIZE_PASS_BEGIN(MemoryDependenceAnalysis, "memdep",
592754fe60SDimitry Andric                 "Memory Dependence Analysis", false, true)
602754fe60SDimitry Andric INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
612754fe60SDimitry Andric INITIALIZE_PASS_END(MemoryDependenceAnalysis, "memdep",
622754fe60SDimitry Andric                       "Memory Dependence Analysis", false, true)
63f22ef01cSRoman Divacky 
64f22ef01cSRoman Divacky MemoryDependenceAnalysis::MemoryDependenceAnalysis()
65e580952dSDimitry Andric : FunctionPass(ID), PredCache(0) {
662754fe60SDimitry Andric   initializeMemoryDependenceAnalysisPass(*PassRegistry::getPassRegistry());
67f22ef01cSRoman Divacky }
68f22ef01cSRoman Divacky MemoryDependenceAnalysis::~MemoryDependenceAnalysis() {
69f22ef01cSRoman Divacky }
70f22ef01cSRoman Divacky 
71f22ef01cSRoman Divacky /// Clean up memory in between runs
72f22ef01cSRoman Divacky void MemoryDependenceAnalysis::releaseMemory() {
73f22ef01cSRoman Divacky   LocalDeps.clear();
74f22ef01cSRoman Divacky   NonLocalDeps.clear();
75f22ef01cSRoman Divacky   NonLocalPointerDeps.clear();
76f22ef01cSRoman Divacky   ReverseLocalDeps.clear();
77f22ef01cSRoman Divacky   ReverseNonLocalDeps.clear();
78f22ef01cSRoman Divacky   ReverseNonLocalPtrDeps.clear();
79f22ef01cSRoman Divacky   PredCache->clear();
80f22ef01cSRoman Divacky }
81f22ef01cSRoman Divacky 
82f22ef01cSRoman Divacky 
83f22ef01cSRoman Divacky 
84f22ef01cSRoman Divacky /// getAnalysisUsage - Does not modify anything.  It uses Alias Analysis.
85f22ef01cSRoman Divacky ///
86f22ef01cSRoman Divacky void MemoryDependenceAnalysis::getAnalysisUsage(AnalysisUsage &AU) const {
87f22ef01cSRoman Divacky   AU.setPreservesAll();
88f22ef01cSRoman Divacky   AU.addRequiredTransitive<AliasAnalysis>();
89f22ef01cSRoman Divacky }
90f22ef01cSRoman Divacky 
91f22ef01cSRoman Divacky bool MemoryDependenceAnalysis::runOnFunction(Function &) {
92f22ef01cSRoman Divacky   AA = &getAnalysis<AliasAnalysis>();
932754fe60SDimitry Andric   TD = getAnalysisIfAvailable<TargetData>();
94f22ef01cSRoman Divacky   if (PredCache == 0)
95f22ef01cSRoman Divacky     PredCache.reset(new PredIteratorCache());
96f22ef01cSRoman Divacky   return false;
97f22ef01cSRoman Divacky }
98f22ef01cSRoman Divacky 
99f22ef01cSRoman Divacky /// RemoveFromReverseMap - This is a helper function that removes Val from
100f22ef01cSRoman Divacky /// 'Inst's set in ReverseMap.  If the set becomes empty, remove Inst's entry.
101f22ef01cSRoman Divacky template <typename KeyTy>
102f22ef01cSRoman Divacky static void RemoveFromReverseMap(DenseMap<Instruction*,
103f22ef01cSRoman Divacky                                  SmallPtrSet<KeyTy, 4> > &ReverseMap,
104f22ef01cSRoman Divacky                                  Instruction *Inst, KeyTy Val) {
105f22ef01cSRoman Divacky   typename DenseMap<Instruction*, SmallPtrSet<KeyTy, 4> >::iterator
106f22ef01cSRoman Divacky   InstIt = ReverseMap.find(Inst);
107f22ef01cSRoman Divacky   assert(InstIt != ReverseMap.end() && "Reverse map out of sync?");
108f22ef01cSRoman Divacky   bool Found = InstIt->second.erase(Val);
1092754fe60SDimitry Andric   assert(Found && "Invalid reverse map!"); (void)Found;
110f22ef01cSRoman Divacky   if (InstIt->second.empty())
111f22ef01cSRoman Divacky     ReverseMap.erase(InstIt);
112f22ef01cSRoman Divacky }
113f22ef01cSRoman Divacky 
1142754fe60SDimitry Andric /// GetLocation - If the given instruction references a specific memory
1152754fe60SDimitry Andric /// location, fill in Loc with the details, otherwise set Loc.Ptr to null.
1162754fe60SDimitry Andric /// Return a ModRefInfo value describing the general behavior of the
1172754fe60SDimitry Andric /// instruction.
1182754fe60SDimitry Andric static
1192754fe60SDimitry Andric AliasAnalysis::ModRefResult GetLocation(const Instruction *Inst,
1202754fe60SDimitry Andric                                         AliasAnalysis::Location &Loc,
1212754fe60SDimitry Andric                                         AliasAnalysis *AA) {
1222754fe60SDimitry Andric   if (const LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
1232754fe60SDimitry Andric     if (LI->isVolatile()) {
1242754fe60SDimitry Andric       Loc = AliasAnalysis::Location();
1252754fe60SDimitry Andric       return AliasAnalysis::ModRef;
1262754fe60SDimitry Andric     }
1272754fe60SDimitry Andric     Loc = AA->getLocation(LI);
1282754fe60SDimitry Andric     return AliasAnalysis::Ref;
1292754fe60SDimitry Andric   }
1302754fe60SDimitry Andric 
1312754fe60SDimitry Andric   if (const StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
1322754fe60SDimitry Andric     if (SI->isVolatile()) {
1332754fe60SDimitry Andric       Loc = AliasAnalysis::Location();
1342754fe60SDimitry Andric       return AliasAnalysis::ModRef;
1352754fe60SDimitry Andric     }
1362754fe60SDimitry Andric     Loc = AA->getLocation(SI);
1372754fe60SDimitry Andric     return AliasAnalysis::Mod;
1382754fe60SDimitry Andric   }
1392754fe60SDimitry Andric 
1402754fe60SDimitry Andric   if (const VAArgInst *V = dyn_cast<VAArgInst>(Inst)) {
1412754fe60SDimitry Andric     Loc = AA->getLocation(V);
1422754fe60SDimitry Andric     return AliasAnalysis::ModRef;
1432754fe60SDimitry Andric   }
1442754fe60SDimitry Andric 
1452754fe60SDimitry Andric   if (const CallInst *CI = isFreeCall(Inst)) {
1462754fe60SDimitry Andric     // calls to free() deallocate the entire structure
1472754fe60SDimitry Andric     Loc = AliasAnalysis::Location(CI->getArgOperand(0));
1482754fe60SDimitry Andric     return AliasAnalysis::Mod;
1492754fe60SDimitry Andric   }
1502754fe60SDimitry Andric 
1512754fe60SDimitry Andric   if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst))
1522754fe60SDimitry Andric     switch (II->getIntrinsicID()) {
1532754fe60SDimitry Andric     case Intrinsic::lifetime_start:
1542754fe60SDimitry Andric     case Intrinsic::lifetime_end:
1552754fe60SDimitry Andric     case Intrinsic::invariant_start:
1562754fe60SDimitry Andric       Loc = AliasAnalysis::Location(II->getArgOperand(1),
1572754fe60SDimitry Andric                                     cast<ConstantInt>(II->getArgOperand(0))
1582754fe60SDimitry Andric                                       ->getZExtValue(),
1592754fe60SDimitry Andric                                     II->getMetadata(LLVMContext::MD_tbaa));
1602754fe60SDimitry Andric       // These intrinsics don't really modify the memory, but returning Mod
1612754fe60SDimitry Andric       // will allow them to be handled conservatively.
1622754fe60SDimitry Andric       return AliasAnalysis::Mod;
1632754fe60SDimitry Andric     case Intrinsic::invariant_end:
1642754fe60SDimitry Andric       Loc = AliasAnalysis::Location(II->getArgOperand(2),
1652754fe60SDimitry Andric                                     cast<ConstantInt>(II->getArgOperand(1))
1662754fe60SDimitry Andric                                       ->getZExtValue(),
1672754fe60SDimitry Andric                                     II->getMetadata(LLVMContext::MD_tbaa));
1682754fe60SDimitry Andric       // These intrinsics don't really modify the memory, but returning Mod
1692754fe60SDimitry Andric       // will allow them to be handled conservatively.
1702754fe60SDimitry Andric       return AliasAnalysis::Mod;
1712754fe60SDimitry Andric     default:
1722754fe60SDimitry Andric       break;
1732754fe60SDimitry Andric     }
1742754fe60SDimitry Andric 
1752754fe60SDimitry Andric   // Otherwise, just do the coarse-grained thing that always works.
1762754fe60SDimitry Andric   if (Inst->mayWriteToMemory())
1772754fe60SDimitry Andric     return AliasAnalysis::ModRef;
1782754fe60SDimitry Andric   if (Inst->mayReadFromMemory())
1792754fe60SDimitry Andric     return AliasAnalysis::Ref;
1802754fe60SDimitry Andric   return AliasAnalysis::NoModRef;
1812754fe60SDimitry Andric }
182f22ef01cSRoman Divacky 
183f22ef01cSRoman Divacky /// getCallSiteDependencyFrom - Private helper for finding the local
184f22ef01cSRoman Divacky /// dependencies of a call site.
185f22ef01cSRoman Divacky MemDepResult MemoryDependenceAnalysis::
186f22ef01cSRoman Divacky getCallSiteDependencyFrom(CallSite CS, bool isReadOnlyCall,
187f22ef01cSRoman Divacky                           BasicBlock::iterator ScanIt, BasicBlock *BB) {
18817a519f9SDimitry Andric   unsigned Limit = BlockScanLimit;
18917a519f9SDimitry Andric 
190f22ef01cSRoman Divacky   // Walk backwards through the block, looking for dependencies
191f22ef01cSRoman Divacky   while (ScanIt != BB->begin()) {
19217a519f9SDimitry Andric     // Limit the amount of scanning we do so we don't end up with quadratic
19317a519f9SDimitry Andric     // running time on extreme testcases.
19417a519f9SDimitry Andric     --Limit;
19517a519f9SDimitry Andric     if (!Limit)
19617a519f9SDimitry Andric       return MemDepResult::getUnknown();
19717a519f9SDimitry Andric 
198f22ef01cSRoman Divacky     Instruction *Inst = --ScanIt;
199f22ef01cSRoman Divacky 
200f22ef01cSRoman Divacky     // If this inst is a memory op, get the pointer it accessed
2012754fe60SDimitry Andric     AliasAnalysis::Location Loc;
2022754fe60SDimitry Andric     AliasAnalysis::ModRefResult MR = GetLocation(Inst, Loc, AA);
2032754fe60SDimitry Andric     if (Loc.Ptr) {
2042754fe60SDimitry Andric       // A simple instruction.
2052754fe60SDimitry Andric       if (AA->getModRefInfo(CS, Loc) != AliasAnalysis::NoModRef)
2062754fe60SDimitry Andric         return MemDepResult::getClobber(Inst);
2072754fe60SDimitry Andric       continue;
2082754fe60SDimitry Andric     }
2092754fe60SDimitry Andric 
2102754fe60SDimitry Andric     if (CallSite InstCS = cast<Value>(Inst)) {
211f22ef01cSRoman Divacky       // Debug intrinsics don't cause dependences.
212f22ef01cSRoman Divacky       if (isa<DbgInfoIntrinsic>(Inst)) continue;
213f22ef01cSRoman Divacky       // If these two calls do not interfere, look past it.
214f22ef01cSRoman Divacky       switch (AA->getModRefInfo(CS, InstCS)) {
215f22ef01cSRoman Divacky       case AliasAnalysis::NoModRef:
216e580952dSDimitry Andric         // If the two calls are the same, return InstCS as a Def, so that
217e580952dSDimitry Andric         // CS can be found redundant and eliminated.
2182754fe60SDimitry Andric         if (isReadOnlyCall && !(MR & AliasAnalysis::Mod) &&
219e580952dSDimitry Andric             CS.getInstruction()->isIdenticalToWhenDefined(Inst))
220f22ef01cSRoman Divacky           return MemDepResult::getDef(Inst);
221e580952dSDimitry Andric 
222e580952dSDimitry Andric         // Otherwise if the two calls don't interact (e.g. InstCS is readnone)
223e580952dSDimitry Andric         // keep scanning.
2242754fe60SDimitry Andric         break;
225f22ef01cSRoman Divacky       default:
226f22ef01cSRoman Divacky         return MemDepResult::getClobber(Inst);
227f22ef01cSRoman Divacky       }
228f22ef01cSRoman Divacky     }
229f22ef01cSRoman Divacky   }
230f22ef01cSRoman Divacky 
23117a519f9SDimitry Andric   // No dependence found.  If this is the entry block of the function, it is
23217a519f9SDimitry Andric   // unknown, otherwise it is non-local.
233f22ef01cSRoman Divacky   if (BB != &BB->getParent()->getEntryBlock())
234f22ef01cSRoman Divacky     return MemDepResult::getNonLocal();
23517a519f9SDimitry Andric   return MemDepResult::getUnknown();
236f22ef01cSRoman Divacky }
237f22ef01cSRoman Divacky 
2383b0f4066SDimitry Andric /// isLoadLoadClobberIfExtendedToFullWidth - Return true if LI is a load that
2393b0f4066SDimitry Andric /// would fully overlap MemLoc if done as a wider legal integer load.
2403b0f4066SDimitry Andric ///
2413b0f4066SDimitry Andric /// MemLocBase, MemLocOffset are lazily computed here the first time the
2423b0f4066SDimitry Andric /// base/offs of memloc is needed.
2433b0f4066SDimitry Andric static bool
2443b0f4066SDimitry Andric isLoadLoadClobberIfExtendedToFullWidth(const AliasAnalysis::Location &MemLoc,
2453b0f4066SDimitry Andric                                        const Value *&MemLocBase,
2463b0f4066SDimitry Andric                                        int64_t &MemLocOffs,
2473b0f4066SDimitry Andric                                        const LoadInst *LI,
2483b0f4066SDimitry Andric                                        const TargetData *TD) {
2493b0f4066SDimitry Andric   // If we have no target data, we can't do this.
2503b0f4066SDimitry Andric   if (TD == 0) return false;
2513b0f4066SDimitry Andric 
2523b0f4066SDimitry Andric   // If we haven't already computed the base/offset of MemLoc, do so now.
2533b0f4066SDimitry Andric   if (MemLocBase == 0)
2543b0f4066SDimitry Andric     MemLocBase = GetPointerBaseWithConstantOffset(MemLoc.Ptr, MemLocOffs, *TD);
2553b0f4066SDimitry Andric 
2563b0f4066SDimitry Andric   unsigned Size = MemoryDependenceAnalysis::
2573b0f4066SDimitry Andric     getLoadLoadClobberFullWidthSize(MemLocBase, MemLocOffs, MemLoc.Size,
2583b0f4066SDimitry Andric                                     LI, *TD);
2593b0f4066SDimitry Andric   return Size != 0;
2603b0f4066SDimitry Andric }
2613b0f4066SDimitry Andric 
2623b0f4066SDimitry Andric /// getLoadLoadClobberFullWidthSize - This is a little bit of analysis that
2633b0f4066SDimitry Andric /// looks at a memory location for a load (specified by MemLocBase, Offs,
2643b0f4066SDimitry Andric /// and Size) and compares it against a load.  If the specified load could
2653b0f4066SDimitry Andric /// be safely widened to a larger integer load that is 1) still efficient,
2663b0f4066SDimitry Andric /// 2) safe for the target, and 3) would provide the specified memory
2673b0f4066SDimitry Andric /// location value, then this function returns the size in bytes of the
2683b0f4066SDimitry Andric /// load width to use.  If not, this returns zero.
2693b0f4066SDimitry Andric unsigned MemoryDependenceAnalysis::
2703b0f4066SDimitry Andric getLoadLoadClobberFullWidthSize(const Value *MemLocBase, int64_t MemLocOffs,
2713b0f4066SDimitry Andric                                 unsigned MemLocSize, const LoadInst *LI,
2723b0f4066SDimitry Andric                                 const TargetData &TD) {
2733b0f4066SDimitry Andric   // We can only extend non-volatile integer loads.
2743b0f4066SDimitry Andric   if (!isa<IntegerType>(LI->getType()) || LI->isVolatile()) return 0;
2753b0f4066SDimitry Andric 
2763b0f4066SDimitry Andric   // Get the base of this load.
2773b0f4066SDimitry Andric   int64_t LIOffs = 0;
2783b0f4066SDimitry Andric   const Value *LIBase =
2793b0f4066SDimitry Andric     GetPointerBaseWithConstantOffset(LI->getPointerOperand(), LIOffs, TD);
2803b0f4066SDimitry Andric 
2813b0f4066SDimitry Andric   // If the two pointers are not based on the same pointer, we can't tell that
2823b0f4066SDimitry Andric   // they are related.
2833b0f4066SDimitry Andric   if (LIBase != MemLocBase) return 0;
2843b0f4066SDimitry Andric 
2853b0f4066SDimitry Andric   // Okay, the two values are based on the same pointer, but returned as
2863b0f4066SDimitry Andric   // no-alias.  This happens when we have things like two byte loads at "P+1"
2873b0f4066SDimitry Andric   // and "P+3".  Check to see if increasing the size of the "LI" load up to its
2883b0f4066SDimitry Andric   // alignment (or the largest native integer type) will allow us to load all
2893b0f4066SDimitry Andric   // the bits required by MemLoc.
2903b0f4066SDimitry Andric 
2913b0f4066SDimitry Andric   // If MemLoc is before LI, then no widening of LI will help us out.
2923b0f4066SDimitry Andric   if (MemLocOffs < LIOffs) return 0;
2933b0f4066SDimitry Andric 
2943b0f4066SDimitry Andric   // Get the alignment of the load in bytes.  We assume that it is safe to load
2953b0f4066SDimitry Andric   // any legal integer up to this size without a problem.  For example, if we're
2963b0f4066SDimitry Andric   // looking at an i8 load on x86-32 that is known 1024 byte aligned, we can
2973b0f4066SDimitry Andric   // widen it up to an i32 load.  If it is known 2-byte aligned, we can widen it
2983b0f4066SDimitry Andric   // to i16.
2993b0f4066SDimitry Andric   unsigned LoadAlign = LI->getAlignment();
3003b0f4066SDimitry Andric 
3013b0f4066SDimitry Andric   int64_t MemLocEnd = MemLocOffs+MemLocSize;
3023b0f4066SDimitry Andric 
3033b0f4066SDimitry Andric   // If no amount of rounding up will let MemLoc fit into LI, then bail out.
3043b0f4066SDimitry Andric   if (LIOffs+LoadAlign < MemLocEnd) return 0;
3053b0f4066SDimitry Andric 
3063b0f4066SDimitry Andric   // This is the size of the load to try.  Start with the next larger power of
3073b0f4066SDimitry Andric   // two.
3083b0f4066SDimitry Andric   unsigned NewLoadByteSize = LI->getType()->getPrimitiveSizeInBits()/8U;
3093b0f4066SDimitry Andric   NewLoadByteSize = NextPowerOf2(NewLoadByteSize);
3103b0f4066SDimitry Andric 
3113b0f4066SDimitry Andric   while (1) {
3123b0f4066SDimitry Andric     // If this load size is bigger than our known alignment or would not fit
3133b0f4066SDimitry Andric     // into a native integer register, then we fail.
3143b0f4066SDimitry Andric     if (NewLoadByteSize > LoadAlign ||
3153b0f4066SDimitry Andric         !TD.fitsInLegalInteger(NewLoadByteSize*8))
3163b0f4066SDimitry Andric       return 0;
3173b0f4066SDimitry Andric 
3183b0f4066SDimitry Andric     // If a load of this width would include all of MemLoc, then we succeed.
3193b0f4066SDimitry Andric     if (LIOffs+NewLoadByteSize >= MemLocEnd)
3203b0f4066SDimitry Andric       return NewLoadByteSize;
3213b0f4066SDimitry Andric 
3223b0f4066SDimitry Andric     NewLoadByteSize <<= 1;
3233b0f4066SDimitry Andric   }
3243b0f4066SDimitry Andric 
3253b0f4066SDimitry Andric   return 0;
3263b0f4066SDimitry Andric }
3273b0f4066SDimitry Andric 
328f22ef01cSRoman Divacky /// getPointerDependencyFrom - Return the instruction on which a memory
3292754fe60SDimitry Andric /// location depends.  If isLoad is true, this routine ignores may-aliases with
3302754fe60SDimitry Andric /// read-only operations.  If isLoad is false, this routine ignores may-aliases
3312754fe60SDimitry Andric /// with reads from read-only locations.
332f22ef01cSRoman Divacky MemDepResult MemoryDependenceAnalysis::
3332754fe60SDimitry Andric getPointerDependencyFrom(const AliasAnalysis::Location &MemLoc, bool isLoad,
334f22ef01cSRoman Divacky                          BasicBlock::iterator ScanIt, BasicBlock *BB) {
335f22ef01cSRoman Divacky 
3363b0f4066SDimitry Andric   const Value *MemLocBase = 0;
3373b0f4066SDimitry Andric   int64_t MemLocOffset = 0;
338f22ef01cSRoman Divacky 
33917a519f9SDimitry Andric   unsigned Limit = BlockScanLimit;
34017a519f9SDimitry Andric 
341f22ef01cSRoman Divacky   // Walk backwards through the basic block, looking for dependencies.
342f22ef01cSRoman Divacky   while (ScanIt != BB->begin()) {
34317a519f9SDimitry Andric     // Limit the amount of scanning we do so we don't end up with quadratic
34417a519f9SDimitry Andric     // running time on extreme testcases.
34517a519f9SDimitry Andric     --Limit;
34617a519f9SDimitry Andric     if (!Limit)
34717a519f9SDimitry Andric       return MemDepResult::getUnknown();
34817a519f9SDimitry Andric 
349f22ef01cSRoman Divacky     Instruction *Inst = --ScanIt;
350f22ef01cSRoman Divacky 
351f22ef01cSRoman Divacky     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
3522754fe60SDimitry Andric       // Debug intrinsics don't (and can't) cause dependences.
3532754fe60SDimitry Andric       if (isa<DbgInfoIntrinsic>(II)) continue;
354f22ef01cSRoman Divacky 
355f22ef01cSRoman Divacky       // If we reach a lifetime begin or end marker, then the query ends here
356f22ef01cSRoman Divacky       // because the value is undefined.
3572754fe60SDimitry Andric       if (II->getIntrinsicID() == Intrinsic::lifetime_start) {
358f22ef01cSRoman Divacky         // FIXME: This only considers queries directly on the invariant-tagged
359f22ef01cSRoman Divacky         // pointer, not on query pointers that are indexed off of them.  It'd
3603b0f4066SDimitry Andric         // be nice to handle that at some point (the right approach is to use
3613b0f4066SDimitry Andric         // GetPointerBaseWithConstantOffset).
3623b0f4066SDimitry Andric         if (AA->isMustAlias(AliasAnalysis::Location(II->getArgOperand(1)),
3633b0f4066SDimitry Andric                             MemLoc))
364f22ef01cSRoman Divacky           return MemDepResult::getDef(II);
3652754fe60SDimitry Andric         continue;
366f22ef01cSRoman Divacky       }
367f22ef01cSRoman Divacky     }
368f22ef01cSRoman Divacky 
369f22ef01cSRoman Divacky     // Values depend on loads if the pointers are must aliased.  This means that
370f22ef01cSRoman Divacky     // a load depends on another must aliased load from the same value.
371f22ef01cSRoman Divacky     if (LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
3722754fe60SDimitry Andric       AliasAnalysis::Location LoadLoc = AA->getLocation(LI);
373f22ef01cSRoman Divacky 
374f22ef01cSRoman Divacky       // If we found a pointer, check if it could be the same as our pointer.
3752754fe60SDimitry Andric       AliasAnalysis::AliasResult R = AA->alias(LoadLoc, MemLoc);
3763b0f4066SDimitry Andric 
3773b0f4066SDimitry Andric       if (isLoad) {
3783b0f4066SDimitry Andric         if (R == AliasAnalysis::NoAlias) {
3793b0f4066SDimitry Andric           // If this is an over-aligned integer load (for example,
3803b0f4066SDimitry Andric           // "load i8* %P, align 4") see if it would obviously overlap with the
3813b0f4066SDimitry Andric           // queried location if widened to a larger load (e.g. if the queried
3823b0f4066SDimitry Andric           // location is 1 byte at P+1).  If so, return it as a load/load
3833b0f4066SDimitry Andric           // clobber result, allowing the client to decide to widen the load if
3843b0f4066SDimitry Andric           // it wants to.
3853b0f4066SDimitry Andric           if (const IntegerType *ITy = dyn_cast<IntegerType>(LI->getType()))
3863b0f4066SDimitry Andric             if (LI->getAlignment()*8 > ITy->getPrimitiveSizeInBits() &&
3873b0f4066SDimitry Andric                 isLoadLoadClobberIfExtendedToFullWidth(MemLoc, MemLocBase,
3883b0f4066SDimitry Andric                                                        MemLocOffset, LI, TD))
3893b0f4066SDimitry Andric               return MemDepResult::getClobber(Inst);
3903b0f4066SDimitry Andric 
3913b0f4066SDimitry Andric           continue;
3923b0f4066SDimitry Andric         }
3933b0f4066SDimitry Andric 
3943b0f4066SDimitry Andric         // Must aliased loads are defs of each other.
3953b0f4066SDimitry Andric         if (R == AliasAnalysis::MustAlias)
3963b0f4066SDimitry Andric           return MemDepResult::getDef(Inst);
3973b0f4066SDimitry Andric 
398bd5abe19SDimitry Andric #if 0 // FIXME: Temporarily disabled. GVN is cleverly rewriting loads
399bd5abe19SDimitry Andric       // in terms of clobbering loads, but since it does this by looking
400bd5abe19SDimitry Andric       // at the clobbering load directly, it doesn't know about any
401bd5abe19SDimitry Andric       // phi translation that may have happened along the way.
402bd5abe19SDimitry Andric 
4033b0f4066SDimitry Andric         // If we have a partial alias, then return this as a clobber for the
4043b0f4066SDimitry Andric         // client to handle.
4053b0f4066SDimitry Andric         if (R == AliasAnalysis::PartialAlias)
4063b0f4066SDimitry Andric           return MemDepResult::getClobber(Inst);
407bd5abe19SDimitry Andric #endif
4083b0f4066SDimitry Andric 
4093b0f4066SDimitry Andric         // Random may-alias loads don't depend on each other without a
4103b0f4066SDimitry Andric         // dependence.
4113b0f4066SDimitry Andric         continue;
4123b0f4066SDimitry Andric       }
4133b0f4066SDimitry Andric 
4143b0f4066SDimitry Andric       // Stores don't depend on other no-aliased accesses.
415f22ef01cSRoman Divacky       if (R == AliasAnalysis::NoAlias)
416f22ef01cSRoman Divacky         continue;
417f22ef01cSRoman Divacky 
4182754fe60SDimitry Andric       // Stores don't alias loads from read-only memory.
4193b0f4066SDimitry Andric       if (AA->pointsToConstantMemory(LoadLoc))
4202754fe60SDimitry Andric         continue;
4212754fe60SDimitry Andric 
4223b0f4066SDimitry Andric       // Stores depend on may/must aliased loads.
423f22ef01cSRoman Divacky       return MemDepResult::getDef(Inst);
424f22ef01cSRoman Divacky     }
425f22ef01cSRoman Divacky 
426f22ef01cSRoman Divacky     if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
427f22ef01cSRoman Divacky       // If alias analysis can tell that this store is guaranteed to not modify
428f22ef01cSRoman Divacky       // the query pointer, ignore it.  Use getModRefInfo to handle cases where
429f22ef01cSRoman Divacky       // the query pointer points to constant memory etc.
4302754fe60SDimitry Andric       if (AA->getModRefInfo(SI, MemLoc) == AliasAnalysis::NoModRef)
431f22ef01cSRoman Divacky         continue;
432f22ef01cSRoman Divacky 
433f22ef01cSRoman Divacky       // Ok, this store might clobber the query pointer.  Check to see if it is
434f22ef01cSRoman Divacky       // a must alias: in this case, we want to return this as a def.
4352754fe60SDimitry Andric       AliasAnalysis::Location StoreLoc = AA->getLocation(SI);
436f22ef01cSRoman Divacky 
437f22ef01cSRoman Divacky       // If we found a pointer, check if it could be the same as our pointer.
4382754fe60SDimitry Andric       AliasAnalysis::AliasResult R = AA->alias(StoreLoc, MemLoc);
439f22ef01cSRoman Divacky 
440f22ef01cSRoman Divacky       if (R == AliasAnalysis::NoAlias)
441f22ef01cSRoman Divacky         continue;
4422754fe60SDimitry Andric       if (R == AliasAnalysis::MustAlias)
443f22ef01cSRoman Divacky         return MemDepResult::getDef(Inst);
4442754fe60SDimitry Andric       return MemDepResult::getClobber(Inst);
445f22ef01cSRoman Divacky     }
446f22ef01cSRoman Divacky 
447f22ef01cSRoman Divacky     // If this is an allocation, and if we know that the accessed pointer is to
448f22ef01cSRoman Divacky     // the allocation, return Def.  This means that there is no dependence and
449f22ef01cSRoman Divacky     // the access can be optimized based on that.  For example, a load could
450f22ef01cSRoman Divacky     // turn into undef.
451f22ef01cSRoman Divacky     // Note: Only determine this to be a malloc if Inst is the malloc call, not
452f22ef01cSRoman Divacky     // a subsequent bitcast of the malloc call result.  There can be stores to
453f22ef01cSRoman Divacky     // the malloced memory between the malloc call and its bitcast uses, and we
454f22ef01cSRoman Divacky     // need to continue scanning until the malloc call.
455f22ef01cSRoman Divacky     if (isa<AllocaInst>(Inst) ||
456f22ef01cSRoman Divacky         (isa<CallInst>(Inst) && extractMallocCall(Inst))) {
4572754fe60SDimitry Andric       const Value *AccessPtr = GetUnderlyingObject(MemLoc.Ptr, TD);
458f22ef01cSRoman Divacky 
4593b0f4066SDimitry Andric       if (AccessPtr == Inst || AA->isMustAlias(Inst, AccessPtr))
460f22ef01cSRoman Divacky         return MemDepResult::getDef(Inst);
461f22ef01cSRoman Divacky       continue;
462f22ef01cSRoman Divacky     }
463f22ef01cSRoman Divacky 
464f22ef01cSRoman Divacky     // See if this instruction (e.g. a call or vaarg) mod/ref's the pointer.
4652754fe60SDimitry Andric     switch (AA->getModRefInfo(Inst, MemLoc)) {
466f22ef01cSRoman Divacky     case AliasAnalysis::NoModRef:
467f22ef01cSRoman Divacky       // If the call has no effect on the queried pointer, just ignore it.
468f22ef01cSRoman Divacky       continue;
469f22ef01cSRoman Divacky     case AliasAnalysis::Mod:
470f22ef01cSRoman Divacky       return MemDepResult::getClobber(Inst);
471f22ef01cSRoman Divacky     case AliasAnalysis::Ref:
472f22ef01cSRoman Divacky       // If the call is known to never store to the pointer, and if this is a
473f22ef01cSRoman Divacky       // load query, we can safely ignore it (scan past it).
474f22ef01cSRoman Divacky       if (isLoad)
475f22ef01cSRoman Divacky         continue;
476f22ef01cSRoman Divacky     default:
477f22ef01cSRoman Divacky       // Otherwise, there is a potential dependence.  Return a clobber.
478f22ef01cSRoman Divacky       return MemDepResult::getClobber(Inst);
479f22ef01cSRoman Divacky     }
480f22ef01cSRoman Divacky   }
481f22ef01cSRoman Divacky 
48217a519f9SDimitry Andric   // No dependence found.  If this is the entry block of the function, it is
48317a519f9SDimitry Andric   // unknown, otherwise it is non-local.
484f22ef01cSRoman Divacky   if (BB != &BB->getParent()->getEntryBlock())
485f22ef01cSRoman Divacky     return MemDepResult::getNonLocal();
48617a519f9SDimitry Andric   return MemDepResult::getUnknown();
487f22ef01cSRoman Divacky }
488f22ef01cSRoman Divacky 
489f22ef01cSRoman Divacky /// getDependency - Return the instruction on which a memory operation
490f22ef01cSRoman Divacky /// depends.
491f22ef01cSRoman Divacky MemDepResult MemoryDependenceAnalysis::getDependency(Instruction *QueryInst) {
492f22ef01cSRoman Divacky   Instruction *ScanPos = QueryInst;
493f22ef01cSRoman Divacky 
494f22ef01cSRoman Divacky   // Check for a cached result
495f22ef01cSRoman Divacky   MemDepResult &LocalCache = LocalDeps[QueryInst];
496f22ef01cSRoman Divacky 
497f22ef01cSRoman Divacky   // If the cached entry is non-dirty, just return it.  Note that this depends
498f22ef01cSRoman Divacky   // on MemDepResult's default constructing to 'dirty'.
499f22ef01cSRoman Divacky   if (!LocalCache.isDirty())
500f22ef01cSRoman Divacky     return LocalCache;
501f22ef01cSRoman Divacky 
502f22ef01cSRoman Divacky   // Otherwise, if we have a dirty entry, we know we can start the scan at that
503f22ef01cSRoman Divacky   // instruction, which may save us some work.
504f22ef01cSRoman Divacky   if (Instruction *Inst = LocalCache.getInst()) {
505f22ef01cSRoman Divacky     ScanPos = Inst;
506f22ef01cSRoman Divacky 
507f22ef01cSRoman Divacky     RemoveFromReverseMap(ReverseLocalDeps, Inst, QueryInst);
508f22ef01cSRoman Divacky   }
509f22ef01cSRoman Divacky 
510f22ef01cSRoman Divacky   BasicBlock *QueryParent = QueryInst->getParent();
511f22ef01cSRoman Divacky 
512f22ef01cSRoman Divacky   // Do the scan.
513f22ef01cSRoman Divacky   if (BasicBlock::iterator(QueryInst) == QueryParent->begin()) {
51417a519f9SDimitry Andric     // No dependence found.  If this is the entry block of the function, it is
51517a519f9SDimitry Andric     // unknown, otherwise it is non-local.
516f22ef01cSRoman Divacky     if (QueryParent != &QueryParent->getParent()->getEntryBlock())
517f22ef01cSRoman Divacky       LocalCache = MemDepResult::getNonLocal();
518f22ef01cSRoman Divacky     else
51917a519f9SDimitry Andric       LocalCache = MemDepResult::getUnknown();
5202754fe60SDimitry Andric   } else {
5212754fe60SDimitry Andric     AliasAnalysis::Location MemLoc;
5222754fe60SDimitry Andric     AliasAnalysis::ModRefResult MR = GetLocation(QueryInst, MemLoc, AA);
5232754fe60SDimitry Andric     if (MemLoc.Ptr) {
5242754fe60SDimitry Andric       // If we can do a pointer scan, make it happen.
5252754fe60SDimitry Andric       bool isLoad = !(MR & AliasAnalysis::Mod);
5262754fe60SDimitry Andric       if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(QueryInst))
527bd5abe19SDimitry Andric         isLoad |= II->getIntrinsicID() == Intrinsic::lifetime_start;
528f22ef01cSRoman Divacky 
5292754fe60SDimitry Andric       LocalCache = getPointerDependencyFrom(MemLoc, isLoad, ScanPos,
5302754fe60SDimitry Andric                                             QueryParent);
5312754fe60SDimitry Andric     } else if (isa<CallInst>(QueryInst) || isa<InvokeInst>(QueryInst)) {
532e580952dSDimitry Andric       CallSite QueryCS(QueryInst);
533f22ef01cSRoman Divacky       bool isReadOnly = AA->onlyReadsMemory(QueryCS);
534f22ef01cSRoman Divacky       LocalCache = getCallSiteDependencyFrom(QueryCS, isReadOnly, ScanPos,
535f22ef01cSRoman Divacky                                              QueryParent);
5362754fe60SDimitry Andric     } else
537f22ef01cSRoman Divacky       // Non-memory instruction.
53817a519f9SDimitry Andric       LocalCache = MemDepResult::getUnknown();
539f22ef01cSRoman Divacky   }
540f22ef01cSRoman Divacky 
541f22ef01cSRoman Divacky   // Remember the result!
542f22ef01cSRoman Divacky   if (Instruction *I = LocalCache.getInst())
543f22ef01cSRoman Divacky     ReverseLocalDeps[I].insert(QueryInst);
544f22ef01cSRoman Divacky 
545f22ef01cSRoman Divacky   return LocalCache;
546f22ef01cSRoman Divacky }
547f22ef01cSRoman Divacky 
548f22ef01cSRoman Divacky #ifndef NDEBUG
549f22ef01cSRoman Divacky /// AssertSorted - This method is used when -debug is specified to verify that
550f22ef01cSRoman Divacky /// cache arrays are properly kept sorted.
551f22ef01cSRoman Divacky static void AssertSorted(MemoryDependenceAnalysis::NonLocalDepInfo &Cache,
552f22ef01cSRoman Divacky                          int Count = -1) {
553f22ef01cSRoman Divacky   if (Count == -1) Count = Cache.size();
554f22ef01cSRoman Divacky   if (Count == 0) return;
555f22ef01cSRoman Divacky 
556f22ef01cSRoman Divacky   for (unsigned i = 1; i != unsigned(Count); ++i)
557f22ef01cSRoman Divacky     assert(!(Cache[i] < Cache[i-1]) && "Cache isn't sorted!");
558f22ef01cSRoman Divacky }
559f22ef01cSRoman Divacky #endif
560f22ef01cSRoman Divacky 
561f22ef01cSRoman Divacky /// getNonLocalCallDependency - Perform a full dependency query for the
562f22ef01cSRoman Divacky /// specified call, returning the set of blocks that the value is
563f22ef01cSRoman Divacky /// potentially live across.  The returned set of results will include a
564f22ef01cSRoman Divacky /// "NonLocal" result for all blocks where the value is live across.
565f22ef01cSRoman Divacky ///
566f22ef01cSRoman Divacky /// This method assumes the instruction returns a "NonLocal" dependency
567f22ef01cSRoman Divacky /// within its own block.
568f22ef01cSRoman Divacky ///
569f22ef01cSRoman Divacky /// This returns a reference to an internal data structure that may be
570f22ef01cSRoman Divacky /// invalidated on the next non-local query or when an instruction is
571f22ef01cSRoman Divacky /// removed.  Clients must copy this data if they want it around longer than
572f22ef01cSRoman Divacky /// that.
573f22ef01cSRoman Divacky const MemoryDependenceAnalysis::NonLocalDepInfo &
574f22ef01cSRoman Divacky MemoryDependenceAnalysis::getNonLocalCallDependency(CallSite QueryCS) {
575f22ef01cSRoman Divacky   assert(getDependency(QueryCS.getInstruction()).isNonLocal() &&
576f22ef01cSRoman Divacky  "getNonLocalCallDependency should only be used on calls with non-local deps!");
577f22ef01cSRoman Divacky   PerInstNLInfo &CacheP = NonLocalDeps[QueryCS.getInstruction()];
578f22ef01cSRoman Divacky   NonLocalDepInfo &Cache = CacheP.first;
579f22ef01cSRoman Divacky 
580f22ef01cSRoman Divacky   /// DirtyBlocks - This is the set of blocks that need to be recomputed.  In
581f22ef01cSRoman Divacky   /// the cached case, this can happen due to instructions being deleted etc. In
582f22ef01cSRoman Divacky   /// the uncached case, this starts out as the set of predecessors we care
583f22ef01cSRoman Divacky   /// about.
584f22ef01cSRoman Divacky   SmallVector<BasicBlock*, 32> DirtyBlocks;
585f22ef01cSRoman Divacky 
586f22ef01cSRoman Divacky   if (!Cache.empty()) {
587f22ef01cSRoman Divacky     // Okay, we have a cache entry.  If we know it is not dirty, just return it
588f22ef01cSRoman Divacky     // with no computation.
589f22ef01cSRoman Divacky     if (!CacheP.second) {
590ffd1746dSEd Schouten       ++NumCacheNonLocal;
591f22ef01cSRoman Divacky       return Cache;
592f22ef01cSRoman Divacky     }
593f22ef01cSRoman Divacky 
594f22ef01cSRoman Divacky     // If we already have a partially computed set of results, scan them to
595f22ef01cSRoman Divacky     // determine what is dirty, seeding our initial DirtyBlocks worklist.
596f22ef01cSRoman Divacky     for (NonLocalDepInfo::iterator I = Cache.begin(), E = Cache.end();
597f22ef01cSRoman Divacky        I != E; ++I)
598f22ef01cSRoman Divacky       if (I->getResult().isDirty())
599f22ef01cSRoman Divacky         DirtyBlocks.push_back(I->getBB());
600f22ef01cSRoman Divacky 
601f22ef01cSRoman Divacky     // Sort the cache so that we can do fast binary search lookups below.
602f22ef01cSRoman Divacky     std::sort(Cache.begin(), Cache.end());
603f22ef01cSRoman Divacky 
604f22ef01cSRoman Divacky     ++NumCacheDirtyNonLocal;
605f22ef01cSRoman Divacky     //cerr << "CACHED CASE: " << DirtyBlocks.size() << " dirty: "
606f22ef01cSRoman Divacky     //     << Cache.size() << " cached: " << *QueryInst;
607f22ef01cSRoman Divacky   } else {
608f22ef01cSRoman Divacky     // Seed DirtyBlocks with each of the preds of QueryInst's block.
609f22ef01cSRoman Divacky     BasicBlock *QueryBB = QueryCS.getInstruction()->getParent();
610f22ef01cSRoman Divacky     for (BasicBlock **PI = PredCache->GetPreds(QueryBB); *PI; ++PI)
611f22ef01cSRoman Divacky       DirtyBlocks.push_back(*PI);
612ffd1746dSEd Schouten     ++NumUncacheNonLocal;
613f22ef01cSRoman Divacky   }
614f22ef01cSRoman Divacky 
615f22ef01cSRoman Divacky   // isReadonlyCall - If this is a read-only call, we can be more aggressive.
616f22ef01cSRoman Divacky   bool isReadonlyCall = AA->onlyReadsMemory(QueryCS);
617f22ef01cSRoman Divacky 
618f22ef01cSRoman Divacky   SmallPtrSet<BasicBlock*, 64> Visited;
619f22ef01cSRoman Divacky 
620f22ef01cSRoman Divacky   unsigned NumSortedEntries = Cache.size();
621f22ef01cSRoman Divacky   DEBUG(AssertSorted(Cache));
622f22ef01cSRoman Divacky 
623f22ef01cSRoman Divacky   // Iterate while we still have blocks to update.
624f22ef01cSRoman Divacky   while (!DirtyBlocks.empty()) {
625f22ef01cSRoman Divacky     BasicBlock *DirtyBB = DirtyBlocks.back();
626f22ef01cSRoman Divacky     DirtyBlocks.pop_back();
627f22ef01cSRoman Divacky 
628f22ef01cSRoman Divacky     // Already processed this block?
629f22ef01cSRoman Divacky     if (!Visited.insert(DirtyBB))
630f22ef01cSRoman Divacky       continue;
631f22ef01cSRoman Divacky 
632f22ef01cSRoman Divacky     // Do a binary search to see if we already have an entry for this block in
633f22ef01cSRoman Divacky     // the cache set.  If so, find it.
634f22ef01cSRoman Divacky     DEBUG(AssertSorted(Cache, NumSortedEntries));
635f22ef01cSRoman Divacky     NonLocalDepInfo::iterator Entry =
636f22ef01cSRoman Divacky       std::upper_bound(Cache.begin(), Cache.begin()+NumSortedEntries,
637f22ef01cSRoman Divacky                        NonLocalDepEntry(DirtyBB));
638f22ef01cSRoman Divacky     if (Entry != Cache.begin() && prior(Entry)->getBB() == DirtyBB)
639f22ef01cSRoman Divacky       --Entry;
640f22ef01cSRoman Divacky 
641f22ef01cSRoman Divacky     NonLocalDepEntry *ExistingResult = 0;
642f22ef01cSRoman Divacky     if (Entry != Cache.begin()+NumSortedEntries &&
643f22ef01cSRoman Divacky         Entry->getBB() == DirtyBB) {
644f22ef01cSRoman Divacky       // If we already have an entry, and if it isn't already dirty, the block
645f22ef01cSRoman Divacky       // is done.
646f22ef01cSRoman Divacky       if (!Entry->getResult().isDirty())
647f22ef01cSRoman Divacky         continue;
648f22ef01cSRoman Divacky 
649f22ef01cSRoman Divacky       // Otherwise, remember this slot so we can update the value.
650f22ef01cSRoman Divacky       ExistingResult = &*Entry;
651f22ef01cSRoman Divacky     }
652f22ef01cSRoman Divacky 
653f22ef01cSRoman Divacky     // If the dirty entry has a pointer, start scanning from it so we don't have
654f22ef01cSRoman Divacky     // to rescan the entire block.
655f22ef01cSRoman Divacky     BasicBlock::iterator ScanPos = DirtyBB->end();
656f22ef01cSRoman Divacky     if (ExistingResult) {
657f22ef01cSRoman Divacky       if (Instruction *Inst = ExistingResult->getResult().getInst()) {
658f22ef01cSRoman Divacky         ScanPos = Inst;
659f22ef01cSRoman Divacky         // We're removing QueryInst's use of Inst.
660f22ef01cSRoman Divacky         RemoveFromReverseMap(ReverseNonLocalDeps, Inst,
661f22ef01cSRoman Divacky                              QueryCS.getInstruction());
662f22ef01cSRoman Divacky       }
663f22ef01cSRoman Divacky     }
664f22ef01cSRoman Divacky 
665f22ef01cSRoman Divacky     // Find out if this block has a local dependency for QueryInst.
666f22ef01cSRoman Divacky     MemDepResult Dep;
667f22ef01cSRoman Divacky 
668f22ef01cSRoman Divacky     if (ScanPos != DirtyBB->begin()) {
669f22ef01cSRoman Divacky       Dep = getCallSiteDependencyFrom(QueryCS, isReadonlyCall,ScanPos, DirtyBB);
670f22ef01cSRoman Divacky     } else if (DirtyBB != &DirtyBB->getParent()->getEntryBlock()) {
671f22ef01cSRoman Divacky       // No dependence found.  If this is the entry block of the function, it is
67217a519f9SDimitry Andric       // a clobber, otherwise it is unknown.
673f22ef01cSRoman Divacky       Dep = MemDepResult::getNonLocal();
674f22ef01cSRoman Divacky     } else {
67517a519f9SDimitry Andric       Dep = MemDepResult::getUnknown();
676f22ef01cSRoman Divacky     }
677f22ef01cSRoman Divacky 
678f22ef01cSRoman Divacky     // If we had a dirty entry for the block, update it.  Otherwise, just add
679f22ef01cSRoman Divacky     // a new entry.
680f22ef01cSRoman Divacky     if (ExistingResult)
681f22ef01cSRoman Divacky       ExistingResult->setResult(Dep);
682f22ef01cSRoman Divacky     else
683f22ef01cSRoman Divacky       Cache.push_back(NonLocalDepEntry(DirtyBB, Dep));
684f22ef01cSRoman Divacky 
685f22ef01cSRoman Divacky     // If the block has a dependency (i.e. it isn't completely transparent to
686f22ef01cSRoman Divacky     // the value), remember the association!
687f22ef01cSRoman Divacky     if (!Dep.isNonLocal()) {
688f22ef01cSRoman Divacky       // Keep the ReverseNonLocalDeps map up to date so we can efficiently
689f22ef01cSRoman Divacky       // update this when we remove instructions.
690f22ef01cSRoman Divacky       if (Instruction *Inst = Dep.getInst())
691f22ef01cSRoman Divacky         ReverseNonLocalDeps[Inst].insert(QueryCS.getInstruction());
692f22ef01cSRoman Divacky     } else {
693f22ef01cSRoman Divacky 
694f22ef01cSRoman Divacky       // If the block *is* completely transparent to the load, we need to check
695f22ef01cSRoman Divacky       // the predecessors of this block.  Add them to our worklist.
696f22ef01cSRoman Divacky       for (BasicBlock **PI = PredCache->GetPreds(DirtyBB); *PI; ++PI)
697f22ef01cSRoman Divacky         DirtyBlocks.push_back(*PI);
698f22ef01cSRoman Divacky     }
699f22ef01cSRoman Divacky   }
700f22ef01cSRoman Divacky 
701f22ef01cSRoman Divacky   return Cache;
702f22ef01cSRoman Divacky }
703f22ef01cSRoman Divacky 
704f22ef01cSRoman Divacky /// getNonLocalPointerDependency - Perform a full dependency query for an
705f22ef01cSRoman Divacky /// access to the specified (non-volatile) memory location, returning the
706f22ef01cSRoman Divacky /// set of instructions that either define or clobber the value.
707f22ef01cSRoman Divacky ///
708f22ef01cSRoman Divacky /// This method assumes the pointer has a "NonLocal" dependency within its
709f22ef01cSRoman Divacky /// own block.
710f22ef01cSRoman Divacky ///
711f22ef01cSRoman Divacky void MemoryDependenceAnalysis::
7122754fe60SDimitry Andric getNonLocalPointerDependency(const AliasAnalysis::Location &Loc, bool isLoad,
7132754fe60SDimitry Andric                              BasicBlock *FromBB,
714f22ef01cSRoman Divacky                              SmallVectorImpl<NonLocalDepResult> &Result) {
7152754fe60SDimitry Andric   assert(Loc.Ptr->getType()->isPointerTy() &&
716f22ef01cSRoman Divacky          "Can't get pointer deps of a non-pointer!");
717f22ef01cSRoman Divacky   Result.clear();
718f22ef01cSRoman Divacky 
7192754fe60SDimitry Andric   PHITransAddr Address(const_cast<Value *>(Loc.Ptr), TD);
720f22ef01cSRoman Divacky 
721f22ef01cSRoman Divacky   // This is the set of blocks we've inspected, and the pointer we consider in
722f22ef01cSRoman Divacky   // each block.  Because of critical edges, we currently bail out if querying
723f22ef01cSRoman Divacky   // a block with multiple different pointers.  This can happen during PHI
724f22ef01cSRoman Divacky   // translation.
725f22ef01cSRoman Divacky   DenseMap<BasicBlock*, Value*> Visited;
7262754fe60SDimitry Andric   if (!getNonLocalPointerDepFromBB(Address, Loc, isLoad, FromBB,
727f22ef01cSRoman Divacky                                    Result, Visited, true))
728f22ef01cSRoman Divacky     return;
729f22ef01cSRoman Divacky   Result.clear();
730f22ef01cSRoman Divacky   Result.push_back(NonLocalDepResult(FromBB,
73117a519f9SDimitry Andric                                      MemDepResult::getUnknown(),
7322754fe60SDimitry Andric                                      const_cast<Value *>(Loc.Ptr)));
733f22ef01cSRoman Divacky }
734f22ef01cSRoman Divacky 
735f22ef01cSRoman Divacky /// GetNonLocalInfoForBlock - Compute the memdep value for BB with
736f22ef01cSRoman Divacky /// Pointer/PointeeSize using either cached information in Cache or by doing a
737f22ef01cSRoman Divacky /// lookup (which may use dirty cache info if available).  If we do a lookup,
738f22ef01cSRoman Divacky /// add the result to the cache.
739f22ef01cSRoman Divacky MemDepResult MemoryDependenceAnalysis::
7402754fe60SDimitry Andric GetNonLocalInfoForBlock(const AliasAnalysis::Location &Loc,
741f22ef01cSRoman Divacky                         bool isLoad, BasicBlock *BB,
742f22ef01cSRoman Divacky                         NonLocalDepInfo *Cache, unsigned NumSortedEntries) {
743f22ef01cSRoman Divacky 
744f22ef01cSRoman Divacky   // Do a binary search to see if we already have an entry for this block in
745f22ef01cSRoman Divacky   // the cache set.  If so, find it.
746f22ef01cSRoman Divacky   NonLocalDepInfo::iterator Entry =
747f22ef01cSRoman Divacky     std::upper_bound(Cache->begin(), Cache->begin()+NumSortedEntries,
748f22ef01cSRoman Divacky                      NonLocalDepEntry(BB));
749f22ef01cSRoman Divacky   if (Entry != Cache->begin() && (Entry-1)->getBB() == BB)
750f22ef01cSRoman Divacky     --Entry;
751f22ef01cSRoman Divacky 
752f22ef01cSRoman Divacky   NonLocalDepEntry *ExistingResult = 0;
753f22ef01cSRoman Divacky   if (Entry != Cache->begin()+NumSortedEntries && Entry->getBB() == BB)
754f22ef01cSRoman Divacky     ExistingResult = &*Entry;
755f22ef01cSRoman Divacky 
756f22ef01cSRoman Divacky   // If we have a cached entry, and it is non-dirty, use it as the value for
757f22ef01cSRoman Divacky   // this dependency.
758f22ef01cSRoman Divacky   if (ExistingResult && !ExistingResult->getResult().isDirty()) {
759f22ef01cSRoman Divacky     ++NumCacheNonLocalPtr;
760f22ef01cSRoman Divacky     return ExistingResult->getResult();
761f22ef01cSRoman Divacky   }
762f22ef01cSRoman Divacky 
763f22ef01cSRoman Divacky   // Otherwise, we have to scan for the value.  If we have a dirty cache
764f22ef01cSRoman Divacky   // entry, start scanning from its position, otherwise we scan from the end
765f22ef01cSRoman Divacky   // of the block.
766f22ef01cSRoman Divacky   BasicBlock::iterator ScanPos = BB->end();
767f22ef01cSRoman Divacky   if (ExistingResult && ExistingResult->getResult().getInst()) {
768f22ef01cSRoman Divacky     assert(ExistingResult->getResult().getInst()->getParent() == BB &&
769f22ef01cSRoman Divacky            "Instruction invalidated?");
770f22ef01cSRoman Divacky     ++NumCacheDirtyNonLocalPtr;
771f22ef01cSRoman Divacky     ScanPos = ExistingResult->getResult().getInst();
772f22ef01cSRoman Divacky 
773f22ef01cSRoman Divacky     // Eliminating the dirty entry from 'Cache', so update the reverse info.
7742754fe60SDimitry Andric     ValueIsLoadPair CacheKey(Loc.Ptr, isLoad);
775f22ef01cSRoman Divacky     RemoveFromReverseMap(ReverseNonLocalPtrDeps, ScanPos, CacheKey);
776f22ef01cSRoman Divacky   } else {
777f22ef01cSRoman Divacky     ++NumUncacheNonLocalPtr;
778f22ef01cSRoman Divacky   }
779f22ef01cSRoman Divacky 
780f22ef01cSRoman Divacky   // Scan the block for the dependency.
7812754fe60SDimitry Andric   MemDepResult Dep = getPointerDependencyFrom(Loc, isLoad, ScanPos, BB);
782f22ef01cSRoman Divacky 
783f22ef01cSRoman Divacky   // If we had a dirty entry for the block, update it.  Otherwise, just add
784f22ef01cSRoman Divacky   // a new entry.
785f22ef01cSRoman Divacky   if (ExistingResult)
786f22ef01cSRoman Divacky     ExistingResult->setResult(Dep);
787f22ef01cSRoman Divacky   else
788f22ef01cSRoman Divacky     Cache->push_back(NonLocalDepEntry(BB, Dep));
789f22ef01cSRoman Divacky 
790f22ef01cSRoman Divacky   // If the block has a dependency (i.e. it isn't completely transparent to
791f22ef01cSRoman Divacky   // the value), remember the reverse association because we just added it
792f22ef01cSRoman Divacky   // to Cache!
79317a519f9SDimitry Andric   if (Dep.isNonLocal() || Dep.isUnknown())
794f22ef01cSRoman Divacky     return Dep;
795f22ef01cSRoman Divacky 
796f22ef01cSRoman Divacky   // Keep the ReverseNonLocalPtrDeps map up to date so we can efficiently
797f22ef01cSRoman Divacky   // update MemDep when we remove instructions.
798f22ef01cSRoman Divacky   Instruction *Inst = Dep.getInst();
799f22ef01cSRoman Divacky   assert(Inst && "Didn't depend on anything?");
8002754fe60SDimitry Andric   ValueIsLoadPair CacheKey(Loc.Ptr, isLoad);
801f22ef01cSRoman Divacky   ReverseNonLocalPtrDeps[Inst].insert(CacheKey);
802f22ef01cSRoman Divacky   return Dep;
803f22ef01cSRoman Divacky }
804f22ef01cSRoman Divacky 
805f22ef01cSRoman Divacky /// SortNonLocalDepInfoCache - Sort the a NonLocalDepInfo cache, given a certain
806f22ef01cSRoman Divacky /// number of elements in the array that are already properly ordered.  This is
807f22ef01cSRoman Divacky /// optimized for the case when only a few entries are added.
808f22ef01cSRoman Divacky static void
809f22ef01cSRoman Divacky SortNonLocalDepInfoCache(MemoryDependenceAnalysis::NonLocalDepInfo &Cache,
810f22ef01cSRoman Divacky                          unsigned NumSortedEntries) {
811f22ef01cSRoman Divacky   switch (Cache.size() - NumSortedEntries) {
812f22ef01cSRoman Divacky   case 0:
813f22ef01cSRoman Divacky     // done, no new entries.
814f22ef01cSRoman Divacky     break;
815f22ef01cSRoman Divacky   case 2: {
816f22ef01cSRoman Divacky     // Two new entries, insert the last one into place.
817f22ef01cSRoman Divacky     NonLocalDepEntry Val = Cache.back();
818f22ef01cSRoman Divacky     Cache.pop_back();
819f22ef01cSRoman Divacky     MemoryDependenceAnalysis::NonLocalDepInfo::iterator Entry =
820f22ef01cSRoman Divacky       std::upper_bound(Cache.begin(), Cache.end()-1, Val);
821f22ef01cSRoman Divacky     Cache.insert(Entry, Val);
822f22ef01cSRoman Divacky     // FALL THROUGH.
823f22ef01cSRoman Divacky   }
824f22ef01cSRoman Divacky   case 1:
825f22ef01cSRoman Divacky     // One new entry, Just insert the new value at the appropriate position.
826f22ef01cSRoman Divacky     if (Cache.size() != 1) {
827f22ef01cSRoman Divacky       NonLocalDepEntry Val = Cache.back();
828f22ef01cSRoman Divacky       Cache.pop_back();
829f22ef01cSRoman Divacky       MemoryDependenceAnalysis::NonLocalDepInfo::iterator Entry =
830f22ef01cSRoman Divacky         std::upper_bound(Cache.begin(), Cache.end(), Val);
831f22ef01cSRoman Divacky       Cache.insert(Entry, Val);
832f22ef01cSRoman Divacky     }
833f22ef01cSRoman Divacky     break;
834f22ef01cSRoman Divacky   default:
835f22ef01cSRoman Divacky     // Added many values, do a full scale sort.
836f22ef01cSRoman Divacky     std::sort(Cache.begin(), Cache.end());
837f22ef01cSRoman Divacky     break;
838f22ef01cSRoman Divacky   }
839f22ef01cSRoman Divacky }
840f22ef01cSRoman Divacky 
841f22ef01cSRoman Divacky /// getNonLocalPointerDepFromBB - Perform a dependency query based on
842f22ef01cSRoman Divacky /// pointer/pointeesize starting at the end of StartBB.  Add any clobber/def
843f22ef01cSRoman Divacky /// results to the results vector and keep track of which blocks are visited in
844f22ef01cSRoman Divacky /// 'Visited'.
845f22ef01cSRoman Divacky ///
846f22ef01cSRoman Divacky /// This has special behavior for the first block queries (when SkipFirstBlock
847f22ef01cSRoman Divacky /// is true).  In this special case, it ignores the contents of the specified
848f22ef01cSRoman Divacky /// block and starts returning dependence info for its predecessors.
849f22ef01cSRoman Divacky ///
850f22ef01cSRoman Divacky /// This function returns false on success, or true to indicate that it could
851f22ef01cSRoman Divacky /// not compute dependence information for some reason.  This should be treated
852f22ef01cSRoman Divacky /// as a clobber dependence on the first instruction in the predecessor block.
853f22ef01cSRoman Divacky bool MemoryDependenceAnalysis::
8542754fe60SDimitry Andric getNonLocalPointerDepFromBB(const PHITransAddr &Pointer,
8552754fe60SDimitry Andric                             const AliasAnalysis::Location &Loc,
856f22ef01cSRoman Divacky                             bool isLoad, BasicBlock *StartBB,
857f22ef01cSRoman Divacky                             SmallVectorImpl<NonLocalDepResult> &Result,
858f22ef01cSRoman Divacky                             DenseMap<BasicBlock*, Value*> &Visited,
859f22ef01cSRoman Divacky                             bool SkipFirstBlock) {
860f22ef01cSRoman Divacky 
861f22ef01cSRoman Divacky   // Look up the cached info for Pointer.
862f22ef01cSRoman Divacky   ValueIsLoadPair CacheKey(Pointer.getAddr(), isLoad);
863f22ef01cSRoman Divacky 
8642754fe60SDimitry Andric   // Set up a temporary NLPI value. If the map doesn't yet have an entry for
8652754fe60SDimitry Andric   // CacheKey, this value will be inserted as the associated value. Otherwise,
8662754fe60SDimitry Andric   // it'll be ignored, and we'll have to check to see if the cached size and
8672754fe60SDimitry Andric   // tbaa tag are consistent with the current query.
8682754fe60SDimitry Andric   NonLocalPointerInfo InitialNLPI;
8692754fe60SDimitry Andric   InitialNLPI.Size = Loc.Size;
8702754fe60SDimitry Andric   InitialNLPI.TBAATag = Loc.TBAATag;
8712754fe60SDimitry Andric 
8722754fe60SDimitry Andric   // Get the NLPI for CacheKey, inserting one into the map if it doesn't
8732754fe60SDimitry Andric   // already have one.
8742754fe60SDimitry Andric   std::pair<CachedNonLocalPointerInfo::iterator, bool> Pair =
8752754fe60SDimitry Andric     NonLocalPointerDeps.insert(std::make_pair(CacheKey, InitialNLPI));
8762754fe60SDimitry Andric   NonLocalPointerInfo *CacheInfo = &Pair.first->second;
8772754fe60SDimitry Andric 
8782754fe60SDimitry Andric   // If we already have a cache entry for this CacheKey, we may need to do some
8792754fe60SDimitry Andric   // work to reconcile the cache entry and the current query.
8802754fe60SDimitry Andric   if (!Pair.second) {
8812754fe60SDimitry Andric     if (CacheInfo->Size < Loc.Size) {
8822754fe60SDimitry Andric       // The query's Size is greater than the cached one. Throw out the
8832754fe60SDimitry Andric       // cached data and procede with the query at the greater size.
8842754fe60SDimitry Andric       CacheInfo->Pair = BBSkipFirstBlockPair();
8852754fe60SDimitry Andric       CacheInfo->Size = Loc.Size;
8862754fe60SDimitry Andric       for (NonLocalDepInfo::iterator DI = CacheInfo->NonLocalDeps.begin(),
8872754fe60SDimitry Andric            DE = CacheInfo->NonLocalDeps.end(); DI != DE; ++DI)
8882754fe60SDimitry Andric         if (Instruction *Inst = DI->getResult().getInst())
8892754fe60SDimitry Andric           RemoveFromReverseMap(ReverseNonLocalPtrDeps, Inst, CacheKey);
8902754fe60SDimitry Andric       CacheInfo->NonLocalDeps.clear();
8912754fe60SDimitry Andric     } else if (CacheInfo->Size > Loc.Size) {
8922754fe60SDimitry Andric       // This query's Size is less than the cached one. Conservatively restart
8932754fe60SDimitry Andric       // the query using the greater size.
8942754fe60SDimitry Andric       return getNonLocalPointerDepFromBB(Pointer,
8952754fe60SDimitry Andric                                          Loc.getWithNewSize(CacheInfo->Size),
8962754fe60SDimitry Andric                                          isLoad, StartBB, Result, Visited,
8972754fe60SDimitry Andric                                          SkipFirstBlock);
8982754fe60SDimitry Andric     }
8992754fe60SDimitry Andric 
9002754fe60SDimitry Andric     // If the query's TBAATag is inconsistent with the cached one,
9012754fe60SDimitry Andric     // conservatively throw out the cached data and restart the query with
9022754fe60SDimitry Andric     // no tag if needed.
9032754fe60SDimitry Andric     if (CacheInfo->TBAATag != Loc.TBAATag) {
9042754fe60SDimitry Andric       if (CacheInfo->TBAATag) {
9052754fe60SDimitry Andric         CacheInfo->Pair = BBSkipFirstBlockPair();
9062754fe60SDimitry Andric         CacheInfo->TBAATag = 0;
9072754fe60SDimitry Andric         for (NonLocalDepInfo::iterator DI = CacheInfo->NonLocalDeps.begin(),
9082754fe60SDimitry Andric              DE = CacheInfo->NonLocalDeps.end(); DI != DE; ++DI)
9092754fe60SDimitry Andric           if (Instruction *Inst = DI->getResult().getInst())
9102754fe60SDimitry Andric             RemoveFromReverseMap(ReverseNonLocalPtrDeps, Inst, CacheKey);
9112754fe60SDimitry Andric         CacheInfo->NonLocalDeps.clear();
9122754fe60SDimitry Andric       }
9132754fe60SDimitry Andric       if (Loc.TBAATag)
9142754fe60SDimitry Andric         return getNonLocalPointerDepFromBB(Pointer, Loc.getWithoutTBAATag(),
9152754fe60SDimitry Andric                                            isLoad, StartBB, Result, Visited,
9162754fe60SDimitry Andric                                            SkipFirstBlock);
9172754fe60SDimitry Andric     }
9182754fe60SDimitry Andric   }
9192754fe60SDimitry Andric 
9202754fe60SDimitry Andric   NonLocalDepInfo *Cache = &CacheInfo->NonLocalDeps;
921f22ef01cSRoman Divacky 
922f22ef01cSRoman Divacky   // If we have valid cached information for exactly the block we are
923f22ef01cSRoman Divacky   // investigating, just return it with no recomputation.
9242754fe60SDimitry Andric   if (CacheInfo->Pair == BBSkipFirstBlockPair(StartBB, SkipFirstBlock)) {
925f22ef01cSRoman Divacky     // We have a fully cached result for this query then we can just return the
926f22ef01cSRoman Divacky     // cached results and populate the visited set.  However, we have to verify
927f22ef01cSRoman Divacky     // that we don't already have conflicting results for these blocks.  Check
928f22ef01cSRoman Divacky     // to ensure that if a block in the results set is in the visited set that
929f22ef01cSRoman Divacky     // it was for the same pointer query.
930f22ef01cSRoman Divacky     if (!Visited.empty()) {
931f22ef01cSRoman Divacky       for (NonLocalDepInfo::iterator I = Cache->begin(), E = Cache->end();
932f22ef01cSRoman Divacky            I != E; ++I) {
933f22ef01cSRoman Divacky         DenseMap<BasicBlock*, Value*>::iterator VI = Visited.find(I->getBB());
934f22ef01cSRoman Divacky         if (VI == Visited.end() || VI->second == Pointer.getAddr())
935f22ef01cSRoman Divacky           continue;
936f22ef01cSRoman Divacky 
937f22ef01cSRoman Divacky         // We have a pointer mismatch in a block.  Just return clobber, saying
938f22ef01cSRoman Divacky         // that something was clobbered in this result.  We could also do a
939f22ef01cSRoman Divacky         // non-fully cached query, but there is little point in doing this.
940f22ef01cSRoman Divacky         return true;
941f22ef01cSRoman Divacky       }
942f22ef01cSRoman Divacky     }
943f22ef01cSRoman Divacky 
944f22ef01cSRoman Divacky     Value *Addr = Pointer.getAddr();
945f22ef01cSRoman Divacky     for (NonLocalDepInfo::iterator I = Cache->begin(), E = Cache->end();
946f22ef01cSRoman Divacky          I != E; ++I) {
947f22ef01cSRoman Divacky       Visited.insert(std::make_pair(I->getBB(), Addr));
948f22ef01cSRoman Divacky       if (!I->getResult().isNonLocal())
949f22ef01cSRoman Divacky         Result.push_back(NonLocalDepResult(I->getBB(), I->getResult(), Addr));
950f22ef01cSRoman Divacky     }
951f22ef01cSRoman Divacky     ++NumCacheCompleteNonLocalPtr;
952f22ef01cSRoman Divacky     return false;
953f22ef01cSRoman Divacky   }
954f22ef01cSRoman Divacky 
955f22ef01cSRoman Divacky   // Otherwise, either this is a new block, a block with an invalid cache
956f22ef01cSRoman Divacky   // pointer or one that we're about to invalidate by putting more info into it
957f22ef01cSRoman Divacky   // than its valid cache info.  If empty, the result will be valid cache info,
958f22ef01cSRoman Divacky   // otherwise it isn't.
959f22ef01cSRoman Divacky   if (Cache->empty())
9602754fe60SDimitry Andric     CacheInfo->Pair = BBSkipFirstBlockPair(StartBB, SkipFirstBlock);
961f22ef01cSRoman Divacky   else
9622754fe60SDimitry Andric     CacheInfo->Pair = BBSkipFirstBlockPair();
963f22ef01cSRoman Divacky 
964f22ef01cSRoman Divacky   SmallVector<BasicBlock*, 32> Worklist;
965f22ef01cSRoman Divacky   Worklist.push_back(StartBB);
966f22ef01cSRoman Divacky 
967bd5abe19SDimitry Andric   // PredList used inside loop.
968bd5abe19SDimitry Andric   SmallVector<std::pair<BasicBlock*, PHITransAddr>, 16> PredList;
969bd5abe19SDimitry Andric 
970f22ef01cSRoman Divacky   // Keep track of the entries that we know are sorted.  Previously cached
971f22ef01cSRoman Divacky   // entries will all be sorted.  The entries we add we only sort on demand (we
972f22ef01cSRoman Divacky   // don't insert every element into its sorted position).  We know that we
973f22ef01cSRoman Divacky   // won't get any reuse from currently inserted values, because we don't
974f22ef01cSRoman Divacky   // revisit blocks after we insert info for them.
975f22ef01cSRoman Divacky   unsigned NumSortedEntries = Cache->size();
976f22ef01cSRoman Divacky   DEBUG(AssertSorted(*Cache));
977f22ef01cSRoman Divacky 
978f22ef01cSRoman Divacky   while (!Worklist.empty()) {
979f22ef01cSRoman Divacky     BasicBlock *BB = Worklist.pop_back_val();
980f22ef01cSRoman Divacky 
981f22ef01cSRoman Divacky     // Skip the first block if we have it.
982f22ef01cSRoman Divacky     if (!SkipFirstBlock) {
983f22ef01cSRoman Divacky       // Analyze the dependency of *Pointer in FromBB.  See if we already have
984f22ef01cSRoman Divacky       // been here.
985f22ef01cSRoman Divacky       assert(Visited.count(BB) && "Should check 'visited' before adding to WL");
986f22ef01cSRoman Divacky 
987f22ef01cSRoman Divacky       // Get the dependency info for Pointer in BB.  If we have cached
988f22ef01cSRoman Divacky       // information, we will use it, otherwise we compute it.
989f22ef01cSRoman Divacky       DEBUG(AssertSorted(*Cache, NumSortedEntries));
9902754fe60SDimitry Andric       MemDepResult Dep = GetNonLocalInfoForBlock(Loc, isLoad, BB, Cache,
991f22ef01cSRoman Divacky                                                  NumSortedEntries);
992f22ef01cSRoman Divacky 
993f22ef01cSRoman Divacky       // If we got a Def or Clobber, add this to the list of results.
994f22ef01cSRoman Divacky       if (!Dep.isNonLocal()) {
995f22ef01cSRoman Divacky         Result.push_back(NonLocalDepResult(BB, Dep, Pointer.getAddr()));
996f22ef01cSRoman Divacky         continue;
997f22ef01cSRoman Divacky       }
998f22ef01cSRoman Divacky     }
999f22ef01cSRoman Divacky 
1000f22ef01cSRoman Divacky     // If 'Pointer' is an instruction defined in this block, then we need to do
1001f22ef01cSRoman Divacky     // phi translation to change it into a value live in the predecessor block.
1002f22ef01cSRoman Divacky     // If not, we just add the predecessors to the worklist and scan them with
1003f22ef01cSRoman Divacky     // the same Pointer.
1004f22ef01cSRoman Divacky     if (!Pointer.NeedsPHITranslationFromBlock(BB)) {
1005f22ef01cSRoman Divacky       SkipFirstBlock = false;
1006bd5abe19SDimitry Andric       SmallVector<BasicBlock*, 16> NewBlocks;
1007f22ef01cSRoman Divacky       for (BasicBlock **PI = PredCache->GetPreds(BB); *PI; ++PI) {
1008f22ef01cSRoman Divacky         // Verify that we haven't looked at this block yet.
1009f22ef01cSRoman Divacky         std::pair<DenseMap<BasicBlock*,Value*>::iterator, bool>
1010f22ef01cSRoman Divacky           InsertRes = Visited.insert(std::make_pair(*PI, Pointer.getAddr()));
1011f22ef01cSRoman Divacky         if (InsertRes.second) {
1012f22ef01cSRoman Divacky           // First time we've looked at *PI.
1013bd5abe19SDimitry Andric           NewBlocks.push_back(*PI);
1014f22ef01cSRoman Divacky           continue;
1015f22ef01cSRoman Divacky         }
1016f22ef01cSRoman Divacky 
1017f22ef01cSRoman Divacky         // If we have seen this block before, but it was with a different
1018f22ef01cSRoman Divacky         // pointer then we have a phi translation failure and we have to treat
1019f22ef01cSRoman Divacky         // this as a clobber.
1020bd5abe19SDimitry Andric         if (InsertRes.first->second != Pointer.getAddr()) {
1021bd5abe19SDimitry Andric           // Make sure to clean up the Visited map before continuing on to
1022bd5abe19SDimitry Andric           // PredTranslationFailure.
1023bd5abe19SDimitry Andric           for (unsigned i = 0; i < NewBlocks.size(); i++)
1024bd5abe19SDimitry Andric             Visited.erase(NewBlocks[i]);
1025f22ef01cSRoman Divacky           goto PredTranslationFailure;
1026f22ef01cSRoman Divacky         }
1027bd5abe19SDimitry Andric       }
1028bd5abe19SDimitry Andric       Worklist.append(NewBlocks.begin(), NewBlocks.end());
1029f22ef01cSRoman Divacky       continue;
1030f22ef01cSRoman Divacky     }
1031f22ef01cSRoman Divacky 
1032f22ef01cSRoman Divacky     // We do need to do phi translation, if we know ahead of time we can't phi
1033f22ef01cSRoman Divacky     // translate this value, don't even try.
1034f22ef01cSRoman Divacky     if (!Pointer.IsPotentiallyPHITranslatable())
1035f22ef01cSRoman Divacky       goto PredTranslationFailure;
1036f22ef01cSRoman Divacky 
1037f22ef01cSRoman Divacky     // We may have added values to the cache list before this PHI translation.
1038f22ef01cSRoman Divacky     // If so, we haven't done anything to ensure that the cache remains sorted.
1039f22ef01cSRoman Divacky     // Sort it now (if needed) so that recursive invocations of
1040f22ef01cSRoman Divacky     // getNonLocalPointerDepFromBB and other routines that could reuse the cache
1041f22ef01cSRoman Divacky     // value will only see properly sorted cache arrays.
1042f22ef01cSRoman Divacky     if (Cache && NumSortedEntries != Cache->size()) {
1043f22ef01cSRoman Divacky       SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
1044f22ef01cSRoman Divacky       NumSortedEntries = Cache->size();
1045f22ef01cSRoman Divacky     }
1046f22ef01cSRoman Divacky     Cache = 0;
1047f22ef01cSRoman Divacky 
1048bd5abe19SDimitry Andric     PredList.clear();
1049f22ef01cSRoman Divacky     for (BasicBlock **PI = PredCache->GetPreds(BB); *PI; ++PI) {
1050f22ef01cSRoman Divacky       BasicBlock *Pred = *PI;
1051bd5abe19SDimitry Andric       PredList.push_back(std::make_pair(Pred, Pointer));
1052f22ef01cSRoman Divacky 
1053f22ef01cSRoman Divacky       // Get the PHI translated pointer in this predecessor.  This can fail if
1054f22ef01cSRoman Divacky       // not translatable, in which case the getAddr() returns null.
1055bd5abe19SDimitry Andric       PHITransAddr &PredPointer = PredList.back().second;
1056f22ef01cSRoman Divacky       PredPointer.PHITranslateValue(BB, Pred, 0);
1057f22ef01cSRoman Divacky 
1058f22ef01cSRoman Divacky       Value *PredPtrVal = PredPointer.getAddr();
1059f22ef01cSRoman Divacky 
1060f22ef01cSRoman Divacky       // Check to see if we have already visited this pred block with another
1061f22ef01cSRoman Divacky       // pointer.  If so, we can't do this lookup.  This failure can occur
1062f22ef01cSRoman Divacky       // with PHI translation when a critical edge exists and the PHI node in
1063f22ef01cSRoman Divacky       // the successor translates to a pointer value different than the
1064f22ef01cSRoman Divacky       // pointer the block was first analyzed with.
1065f22ef01cSRoman Divacky       std::pair<DenseMap<BasicBlock*,Value*>::iterator, bool>
1066f22ef01cSRoman Divacky         InsertRes = Visited.insert(std::make_pair(Pred, PredPtrVal));
1067f22ef01cSRoman Divacky 
1068f22ef01cSRoman Divacky       if (!InsertRes.second) {
1069bd5abe19SDimitry Andric         // We found the pred; take it off the list of preds to visit.
1070bd5abe19SDimitry Andric         PredList.pop_back();
1071bd5abe19SDimitry Andric 
1072f22ef01cSRoman Divacky         // If the predecessor was visited with PredPtr, then we already did
1073f22ef01cSRoman Divacky         // the analysis and can ignore it.
1074f22ef01cSRoman Divacky         if (InsertRes.first->second == PredPtrVal)
1075f22ef01cSRoman Divacky           continue;
1076f22ef01cSRoman Divacky 
1077f22ef01cSRoman Divacky         // Otherwise, the block was previously analyzed with a different
1078f22ef01cSRoman Divacky         // pointer.  We can't represent the result of this case, so we just
1079f22ef01cSRoman Divacky         // treat this as a phi translation failure.
1080bd5abe19SDimitry Andric 
1081bd5abe19SDimitry Andric         // Make sure to clean up the Visited map before continuing on to
1082bd5abe19SDimitry Andric         // PredTranslationFailure.
1083bd5abe19SDimitry Andric         for (unsigned i = 0; i < PredList.size(); i++)
1084bd5abe19SDimitry Andric           Visited.erase(PredList[i].first);
1085bd5abe19SDimitry Andric 
1086f22ef01cSRoman Divacky         goto PredTranslationFailure;
1087f22ef01cSRoman Divacky       }
1088bd5abe19SDimitry Andric     }
1089f22ef01cSRoman Divacky 
1090bd5abe19SDimitry Andric     // Actually process results here; this need to be a separate loop to avoid
1091bd5abe19SDimitry Andric     // calling getNonLocalPointerDepFromBB for blocks we don't want to return
1092bd5abe19SDimitry Andric     // any results for.  (getNonLocalPointerDepFromBB will modify our
1093bd5abe19SDimitry Andric     // datastructures in ways the code after the PredTranslationFailure label
1094bd5abe19SDimitry Andric     // doesn't expect.)
1095bd5abe19SDimitry Andric     for (unsigned i = 0; i < PredList.size(); i++) {
1096bd5abe19SDimitry Andric       BasicBlock *Pred = PredList[i].first;
1097bd5abe19SDimitry Andric       PHITransAddr &PredPointer = PredList[i].second;
1098bd5abe19SDimitry Andric       Value *PredPtrVal = PredPointer.getAddr();
1099bd5abe19SDimitry Andric 
1100bd5abe19SDimitry Andric       bool CanTranslate = true;
1101f22ef01cSRoman Divacky       // If PHI translation was unable to find an available pointer in this
1102f22ef01cSRoman Divacky       // predecessor, then we have to assume that the pointer is clobbered in
1103f22ef01cSRoman Divacky       // that predecessor.  We can still do PRE of the load, which would insert
1104f22ef01cSRoman Divacky       // a computation of the pointer in this predecessor.
1105bd5abe19SDimitry Andric       if (PredPtrVal == 0)
1106bd5abe19SDimitry Andric         CanTranslate = false;
1107bd5abe19SDimitry Andric 
1108bd5abe19SDimitry Andric       // FIXME: it is entirely possible that PHI translating will end up with
1109bd5abe19SDimitry Andric       // the same value.  Consider PHI translating something like:
1110bd5abe19SDimitry Andric       // X = phi [x, bb1], [y, bb2].  PHI translating for bb1 doesn't *need*
1111bd5abe19SDimitry Andric       // to recurse here, pedantically speaking.
1112bd5abe19SDimitry Andric 
1113bd5abe19SDimitry Andric       // If getNonLocalPointerDepFromBB fails here, that means the cached
1114bd5abe19SDimitry Andric       // result conflicted with the Visited list; we have to conservatively
111517a519f9SDimitry Andric       // assume it is unknown, but this also does not block PRE of the load.
1116bd5abe19SDimitry Andric       if (!CanTranslate ||
1117bd5abe19SDimitry Andric           getNonLocalPointerDepFromBB(PredPointer,
1118bd5abe19SDimitry Andric                                       Loc.getWithNewPtr(PredPtrVal),
1119bd5abe19SDimitry Andric                                       isLoad, Pred,
1120bd5abe19SDimitry Andric                                       Result, Visited)) {
1121f22ef01cSRoman Divacky         // Add the entry to the Result list.
112217a519f9SDimitry Andric         NonLocalDepResult Entry(Pred, MemDepResult::getUnknown(), PredPtrVal);
1123f22ef01cSRoman Divacky         Result.push_back(Entry);
1124f22ef01cSRoman Divacky 
1125f22ef01cSRoman Divacky         // Since we had a phi translation failure, the cache for CacheKey won't
1126f22ef01cSRoman Divacky         // include all of the entries that we need to immediately satisfy future
1127f22ef01cSRoman Divacky         // queries.  Mark this in NonLocalPointerDeps by setting the
1128f22ef01cSRoman Divacky         // BBSkipFirstBlockPair pointer to null.  This requires reuse of the
1129f22ef01cSRoman Divacky         // cached value to do more work but not miss the phi trans failure.
11302754fe60SDimitry Andric         NonLocalPointerInfo &NLPI = NonLocalPointerDeps[CacheKey];
11312754fe60SDimitry Andric         NLPI.Pair = BBSkipFirstBlockPair();
1132f22ef01cSRoman Divacky         continue;
1133f22ef01cSRoman Divacky       }
1134f22ef01cSRoman Divacky     }
1135f22ef01cSRoman Divacky 
1136f22ef01cSRoman Divacky     // Refresh the CacheInfo/Cache pointer so that it isn't invalidated.
1137f22ef01cSRoman Divacky     CacheInfo = &NonLocalPointerDeps[CacheKey];
11382754fe60SDimitry Andric     Cache = &CacheInfo->NonLocalDeps;
1139f22ef01cSRoman Divacky     NumSortedEntries = Cache->size();
1140f22ef01cSRoman Divacky 
1141f22ef01cSRoman Divacky     // Since we did phi translation, the "Cache" set won't contain all of the
1142f22ef01cSRoman Divacky     // results for the query.  This is ok (we can still use it to accelerate
1143f22ef01cSRoman Divacky     // specific block queries) but we can't do the fastpath "return all
1144f22ef01cSRoman Divacky     // results from the set"  Clear out the indicator for this.
11452754fe60SDimitry Andric     CacheInfo->Pair = BBSkipFirstBlockPair();
1146f22ef01cSRoman Divacky     SkipFirstBlock = false;
1147f22ef01cSRoman Divacky     continue;
1148f22ef01cSRoman Divacky 
1149f22ef01cSRoman Divacky   PredTranslationFailure:
1150bd5abe19SDimitry Andric     // The following code is "failure"; we can't produce a sane translation
1151bd5abe19SDimitry Andric     // for the given block.  It assumes that we haven't modified any of
1152bd5abe19SDimitry Andric     // our datastructures while processing the current block.
1153f22ef01cSRoman Divacky 
1154f22ef01cSRoman Divacky     if (Cache == 0) {
1155f22ef01cSRoman Divacky       // Refresh the CacheInfo/Cache pointer if it got invalidated.
1156f22ef01cSRoman Divacky       CacheInfo = &NonLocalPointerDeps[CacheKey];
11572754fe60SDimitry Andric       Cache = &CacheInfo->NonLocalDeps;
1158f22ef01cSRoman Divacky       NumSortedEntries = Cache->size();
1159f22ef01cSRoman Divacky     }
1160f22ef01cSRoman Divacky 
1161f22ef01cSRoman Divacky     // Since we failed phi translation, the "Cache" set won't contain all of the
1162f22ef01cSRoman Divacky     // results for the query.  This is ok (we can still use it to accelerate
1163f22ef01cSRoman Divacky     // specific block queries) but we can't do the fastpath "return all
1164f22ef01cSRoman Divacky     // results from the set".  Clear out the indicator for this.
11652754fe60SDimitry Andric     CacheInfo->Pair = BBSkipFirstBlockPair();
1166f22ef01cSRoman Divacky 
116717a519f9SDimitry Andric     // If *nothing* works, mark the pointer as unknown.
1168f22ef01cSRoman Divacky     //
1169f22ef01cSRoman Divacky     // If this is the magic first block, return this as a clobber of the whole
1170f22ef01cSRoman Divacky     // incoming value.  Since we can't phi translate to one of the predecessors,
1171f22ef01cSRoman Divacky     // we have to bail out.
1172f22ef01cSRoman Divacky     if (SkipFirstBlock)
1173f22ef01cSRoman Divacky       return true;
1174f22ef01cSRoman Divacky 
1175f22ef01cSRoman Divacky     for (NonLocalDepInfo::reverse_iterator I = Cache->rbegin(); ; ++I) {
1176f22ef01cSRoman Divacky       assert(I != Cache->rend() && "Didn't find current block??");
1177f22ef01cSRoman Divacky       if (I->getBB() != BB)
1178f22ef01cSRoman Divacky         continue;
1179f22ef01cSRoman Divacky 
1180f22ef01cSRoman Divacky       assert(I->getResult().isNonLocal() &&
1181f22ef01cSRoman Divacky              "Should only be here with transparent block");
118217a519f9SDimitry Andric       I->setResult(MemDepResult::getUnknown());
1183f22ef01cSRoman Divacky       Result.push_back(NonLocalDepResult(I->getBB(), I->getResult(),
1184f22ef01cSRoman Divacky                                          Pointer.getAddr()));
1185f22ef01cSRoman Divacky       break;
1186f22ef01cSRoman Divacky     }
1187f22ef01cSRoman Divacky   }
1188f22ef01cSRoman Divacky 
1189f22ef01cSRoman Divacky   // Okay, we're done now.  If we added new values to the cache, re-sort it.
1190f22ef01cSRoman Divacky   SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
1191f22ef01cSRoman Divacky   DEBUG(AssertSorted(*Cache));
1192f22ef01cSRoman Divacky   return false;
1193f22ef01cSRoman Divacky }
1194f22ef01cSRoman Divacky 
1195f22ef01cSRoman Divacky /// RemoveCachedNonLocalPointerDependencies - If P exists in
1196f22ef01cSRoman Divacky /// CachedNonLocalPointerInfo, remove it.
1197f22ef01cSRoman Divacky void MemoryDependenceAnalysis::
1198f22ef01cSRoman Divacky RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair P) {
1199f22ef01cSRoman Divacky   CachedNonLocalPointerInfo::iterator It =
1200f22ef01cSRoman Divacky     NonLocalPointerDeps.find(P);
1201f22ef01cSRoman Divacky   if (It == NonLocalPointerDeps.end()) return;
1202f22ef01cSRoman Divacky 
1203f22ef01cSRoman Divacky   // Remove all of the entries in the BB->val map.  This involves removing
1204f22ef01cSRoman Divacky   // instructions from the reverse map.
12052754fe60SDimitry Andric   NonLocalDepInfo &PInfo = It->second.NonLocalDeps;
1206f22ef01cSRoman Divacky 
1207f22ef01cSRoman Divacky   for (unsigned i = 0, e = PInfo.size(); i != e; ++i) {
1208f22ef01cSRoman Divacky     Instruction *Target = PInfo[i].getResult().getInst();
1209f22ef01cSRoman Divacky     if (Target == 0) continue;  // Ignore non-local dep results.
1210f22ef01cSRoman Divacky     assert(Target->getParent() == PInfo[i].getBB());
1211f22ef01cSRoman Divacky 
1212f22ef01cSRoman Divacky     // Eliminating the dirty entry from 'Cache', so update the reverse info.
1213f22ef01cSRoman Divacky     RemoveFromReverseMap(ReverseNonLocalPtrDeps, Target, P);
1214f22ef01cSRoman Divacky   }
1215f22ef01cSRoman Divacky 
1216f22ef01cSRoman Divacky   // Remove P from NonLocalPointerDeps (which deletes NonLocalDepInfo).
1217f22ef01cSRoman Divacky   NonLocalPointerDeps.erase(It);
1218f22ef01cSRoman Divacky }
1219f22ef01cSRoman Divacky 
1220f22ef01cSRoman Divacky 
1221f22ef01cSRoman Divacky /// invalidateCachedPointerInfo - This method is used to invalidate cached
1222f22ef01cSRoman Divacky /// information about the specified pointer, because it may be too
1223f22ef01cSRoman Divacky /// conservative in memdep.  This is an optional call that can be used when
1224f22ef01cSRoman Divacky /// the client detects an equivalence between the pointer and some other
1225f22ef01cSRoman Divacky /// value and replaces the other value with ptr. This can make Ptr available
1226f22ef01cSRoman Divacky /// in more places that cached info does not necessarily keep.
1227f22ef01cSRoman Divacky void MemoryDependenceAnalysis::invalidateCachedPointerInfo(Value *Ptr) {
1228f22ef01cSRoman Divacky   // If Ptr isn't really a pointer, just ignore it.
1229f22ef01cSRoman Divacky   if (!Ptr->getType()->isPointerTy()) return;
1230f22ef01cSRoman Divacky   // Flush store info for the pointer.
1231f22ef01cSRoman Divacky   RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, false));
1232f22ef01cSRoman Divacky   // Flush load info for the pointer.
1233f22ef01cSRoman Divacky   RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, true));
1234f22ef01cSRoman Divacky }
1235f22ef01cSRoman Divacky 
1236f22ef01cSRoman Divacky /// invalidateCachedPredecessors - Clear the PredIteratorCache info.
1237f22ef01cSRoman Divacky /// This needs to be done when the CFG changes, e.g., due to splitting
1238f22ef01cSRoman Divacky /// critical edges.
1239f22ef01cSRoman Divacky void MemoryDependenceAnalysis::invalidateCachedPredecessors() {
1240f22ef01cSRoman Divacky   PredCache->clear();
1241f22ef01cSRoman Divacky }
1242f22ef01cSRoman Divacky 
1243f22ef01cSRoman Divacky /// removeInstruction - Remove an instruction from the dependence analysis,
1244f22ef01cSRoman Divacky /// updating the dependence of instructions that previously depended on it.
1245f22ef01cSRoman Divacky /// This method attempts to keep the cache coherent using the reverse map.
1246f22ef01cSRoman Divacky void MemoryDependenceAnalysis::removeInstruction(Instruction *RemInst) {
1247f22ef01cSRoman Divacky   // Walk through the Non-local dependencies, removing this one as the value
1248f22ef01cSRoman Divacky   // for any cached queries.
1249f22ef01cSRoman Divacky   NonLocalDepMapType::iterator NLDI = NonLocalDeps.find(RemInst);
1250f22ef01cSRoman Divacky   if (NLDI != NonLocalDeps.end()) {
1251f22ef01cSRoman Divacky     NonLocalDepInfo &BlockMap = NLDI->second.first;
1252f22ef01cSRoman Divacky     for (NonLocalDepInfo::iterator DI = BlockMap.begin(), DE = BlockMap.end();
1253f22ef01cSRoman Divacky          DI != DE; ++DI)
1254f22ef01cSRoman Divacky       if (Instruction *Inst = DI->getResult().getInst())
1255f22ef01cSRoman Divacky         RemoveFromReverseMap(ReverseNonLocalDeps, Inst, RemInst);
1256f22ef01cSRoman Divacky     NonLocalDeps.erase(NLDI);
1257f22ef01cSRoman Divacky   }
1258f22ef01cSRoman Divacky 
1259f22ef01cSRoman Divacky   // If we have a cached local dependence query for this instruction, remove it.
1260f22ef01cSRoman Divacky   //
1261f22ef01cSRoman Divacky   LocalDepMapType::iterator LocalDepEntry = LocalDeps.find(RemInst);
1262f22ef01cSRoman Divacky   if (LocalDepEntry != LocalDeps.end()) {
1263f22ef01cSRoman Divacky     // Remove us from DepInst's reverse set now that the local dep info is gone.
1264f22ef01cSRoman Divacky     if (Instruction *Inst = LocalDepEntry->second.getInst())
1265f22ef01cSRoman Divacky       RemoveFromReverseMap(ReverseLocalDeps, Inst, RemInst);
1266f22ef01cSRoman Divacky 
1267f22ef01cSRoman Divacky     // Remove this local dependency info.
1268f22ef01cSRoman Divacky     LocalDeps.erase(LocalDepEntry);
1269f22ef01cSRoman Divacky   }
1270f22ef01cSRoman Divacky 
1271f22ef01cSRoman Divacky   // If we have any cached pointer dependencies on this instruction, remove
1272f22ef01cSRoman Divacky   // them.  If the instruction has non-pointer type, then it can't be a pointer
1273f22ef01cSRoman Divacky   // base.
1274f22ef01cSRoman Divacky 
1275f22ef01cSRoman Divacky   // Remove it from both the load info and the store info.  The instruction
1276f22ef01cSRoman Divacky   // can't be in either of these maps if it is non-pointer.
1277f22ef01cSRoman Divacky   if (RemInst->getType()->isPointerTy()) {
1278f22ef01cSRoman Divacky     RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, false));
1279f22ef01cSRoman Divacky     RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, true));
1280f22ef01cSRoman Divacky   }
1281f22ef01cSRoman Divacky 
1282f22ef01cSRoman Divacky   // Loop over all of the things that depend on the instruction we're removing.
1283f22ef01cSRoman Divacky   //
1284f22ef01cSRoman Divacky   SmallVector<std::pair<Instruction*, Instruction*>, 8> ReverseDepsToAdd;
1285f22ef01cSRoman Divacky 
1286f22ef01cSRoman Divacky   // If we find RemInst as a clobber or Def in any of the maps for other values,
1287f22ef01cSRoman Divacky   // we need to replace its entry with a dirty version of the instruction after
1288f22ef01cSRoman Divacky   // it.  If RemInst is a terminator, we use a null dirty value.
1289f22ef01cSRoman Divacky   //
1290f22ef01cSRoman Divacky   // Using a dirty version of the instruction after RemInst saves having to scan
1291f22ef01cSRoman Divacky   // the entire block to get to this point.
1292f22ef01cSRoman Divacky   MemDepResult NewDirtyVal;
1293f22ef01cSRoman Divacky   if (!RemInst->isTerminator())
1294f22ef01cSRoman Divacky     NewDirtyVal = MemDepResult::getDirty(++BasicBlock::iterator(RemInst));
1295f22ef01cSRoman Divacky 
1296f22ef01cSRoman Divacky   ReverseDepMapType::iterator ReverseDepIt = ReverseLocalDeps.find(RemInst);
1297f22ef01cSRoman Divacky   if (ReverseDepIt != ReverseLocalDeps.end()) {
1298f22ef01cSRoman Divacky     SmallPtrSet<Instruction*, 4> &ReverseDeps = ReverseDepIt->second;
1299f22ef01cSRoman Divacky     // RemInst can't be the terminator if it has local stuff depending on it.
1300f22ef01cSRoman Divacky     assert(!ReverseDeps.empty() && !isa<TerminatorInst>(RemInst) &&
1301f22ef01cSRoman Divacky            "Nothing can locally depend on a terminator");
1302f22ef01cSRoman Divacky 
1303f22ef01cSRoman Divacky     for (SmallPtrSet<Instruction*, 4>::iterator I = ReverseDeps.begin(),
1304f22ef01cSRoman Divacky          E = ReverseDeps.end(); I != E; ++I) {
1305f22ef01cSRoman Divacky       Instruction *InstDependingOnRemInst = *I;
1306f22ef01cSRoman Divacky       assert(InstDependingOnRemInst != RemInst &&
1307f22ef01cSRoman Divacky              "Already removed our local dep info");
1308f22ef01cSRoman Divacky 
1309f22ef01cSRoman Divacky       LocalDeps[InstDependingOnRemInst] = NewDirtyVal;
1310f22ef01cSRoman Divacky 
1311f22ef01cSRoman Divacky       // Make sure to remember that new things depend on NewDepInst.
1312f22ef01cSRoman Divacky       assert(NewDirtyVal.getInst() && "There is no way something else can have "
1313f22ef01cSRoman Divacky              "a local dep on this if it is a terminator!");
1314f22ef01cSRoman Divacky       ReverseDepsToAdd.push_back(std::make_pair(NewDirtyVal.getInst(),
1315f22ef01cSRoman Divacky                                                 InstDependingOnRemInst));
1316f22ef01cSRoman Divacky     }
1317f22ef01cSRoman Divacky 
1318f22ef01cSRoman Divacky     ReverseLocalDeps.erase(ReverseDepIt);
1319f22ef01cSRoman Divacky 
1320f22ef01cSRoman Divacky     // Add new reverse deps after scanning the set, to avoid invalidating the
1321f22ef01cSRoman Divacky     // 'ReverseDeps' reference.
1322f22ef01cSRoman Divacky     while (!ReverseDepsToAdd.empty()) {
1323f22ef01cSRoman Divacky       ReverseLocalDeps[ReverseDepsToAdd.back().first]
1324f22ef01cSRoman Divacky         .insert(ReverseDepsToAdd.back().second);
1325f22ef01cSRoman Divacky       ReverseDepsToAdd.pop_back();
1326f22ef01cSRoman Divacky     }
1327f22ef01cSRoman Divacky   }
1328f22ef01cSRoman Divacky 
1329f22ef01cSRoman Divacky   ReverseDepIt = ReverseNonLocalDeps.find(RemInst);
1330f22ef01cSRoman Divacky   if (ReverseDepIt != ReverseNonLocalDeps.end()) {
1331f22ef01cSRoman Divacky     SmallPtrSet<Instruction*, 4> &Set = ReverseDepIt->second;
1332f22ef01cSRoman Divacky     for (SmallPtrSet<Instruction*, 4>::iterator I = Set.begin(), E = Set.end();
1333f22ef01cSRoman Divacky          I != E; ++I) {
1334f22ef01cSRoman Divacky       assert(*I != RemInst && "Already removed NonLocalDep info for RemInst");
1335f22ef01cSRoman Divacky 
1336f22ef01cSRoman Divacky       PerInstNLInfo &INLD = NonLocalDeps[*I];
1337f22ef01cSRoman Divacky       // The information is now dirty!
1338f22ef01cSRoman Divacky       INLD.second = true;
1339f22ef01cSRoman Divacky 
1340f22ef01cSRoman Divacky       for (NonLocalDepInfo::iterator DI = INLD.first.begin(),
1341f22ef01cSRoman Divacky            DE = INLD.first.end(); DI != DE; ++DI) {
1342f22ef01cSRoman Divacky         if (DI->getResult().getInst() != RemInst) continue;
1343f22ef01cSRoman Divacky 
1344f22ef01cSRoman Divacky         // Convert to a dirty entry for the subsequent instruction.
1345f22ef01cSRoman Divacky         DI->setResult(NewDirtyVal);
1346f22ef01cSRoman Divacky 
1347f22ef01cSRoman Divacky         if (Instruction *NextI = NewDirtyVal.getInst())
1348f22ef01cSRoman Divacky           ReverseDepsToAdd.push_back(std::make_pair(NextI, *I));
1349f22ef01cSRoman Divacky       }
1350f22ef01cSRoman Divacky     }
1351f22ef01cSRoman Divacky 
1352f22ef01cSRoman Divacky     ReverseNonLocalDeps.erase(ReverseDepIt);
1353f22ef01cSRoman Divacky 
1354f22ef01cSRoman Divacky     // Add new reverse deps after scanning the set, to avoid invalidating 'Set'
1355f22ef01cSRoman Divacky     while (!ReverseDepsToAdd.empty()) {
1356f22ef01cSRoman Divacky       ReverseNonLocalDeps[ReverseDepsToAdd.back().first]
1357f22ef01cSRoman Divacky         .insert(ReverseDepsToAdd.back().second);
1358f22ef01cSRoman Divacky       ReverseDepsToAdd.pop_back();
1359f22ef01cSRoman Divacky     }
1360f22ef01cSRoman Divacky   }
1361f22ef01cSRoman Divacky 
1362f22ef01cSRoman Divacky   // If the instruction is in ReverseNonLocalPtrDeps then it appears as a
1363f22ef01cSRoman Divacky   // value in the NonLocalPointerDeps info.
1364f22ef01cSRoman Divacky   ReverseNonLocalPtrDepTy::iterator ReversePtrDepIt =
1365f22ef01cSRoman Divacky     ReverseNonLocalPtrDeps.find(RemInst);
1366f22ef01cSRoman Divacky   if (ReversePtrDepIt != ReverseNonLocalPtrDeps.end()) {
1367f22ef01cSRoman Divacky     SmallPtrSet<ValueIsLoadPair, 4> &Set = ReversePtrDepIt->second;
1368f22ef01cSRoman Divacky     SmallVector<std::pair<Instruction*, ValueIsLoadPair>,8> ReversePtrDepsToAdd;
1369f22ef01cSRoman Divacky 
1370f22ef01cSRoman Divacky     for (SmallPtrSet<ValueIsLoadPair, 4>::iterator I = Set.begin(),
1371f22ef01cSRoman Divacky          E = Set.end(); I != E; ++I) {
1372f22ef01cSRoman Divacky       ValueIsLoadPair P = *I;
1373f22ef01cSRoman Divacky       assert(P.getPointer() != RemInst &&
1374f22ef01cSRoman Divacky              "Already removed NonLocalPointerDeps info for RemInst");
1375f22ef01cSRoman Divacky 
13762754fe60SDimitry Andric       NonLocalDepInfo &NLPDI = NonLocalPointerDeps[P].NonLocalDeps;
1377f22ef01cSRoman Divacky 
1378f22ef01cSRoman Divacky       // The cache is not valid for any specific block anymore.
13792754fe60SDimitry Andric       NonLocalPointerDeps[P].Pair = BBSkipFirstBlockPair();
1380f22ef01cSRoman Divacky 
1381f22ef01cSRoman Divacky       // Update any entries for RemInst to use the instruction after it.
1382f22ef01cSRoman Divacky       for (NonLocalDepInfo::iterator DI = NLPDI.begin(), DE = NLPDI.end();
1383f22ef01cSRoman Divacky            DI != DE; ++DI) {
1384f22ef01cSRoman Divacky         if (DI->getResult().getInst() != RemInst) continue;
1385f22ef01cSRoman Divacky 
1386f22ef01cSRoman Divacky         // Convert to a dirty entry for the subsequent instruction.
1387f22ef01cSRoman Divacky         DI->setResult(NewDirtyVal);
1388f22ef01cSRoman Divacky 
1389f22ef01cSRoman Divacky         if (Instruction *NewDirtyInst = NewDirtyVal.getInst())
1390f22ef01cSRoman Divacky           ReversePtrDepsToAdd.push_back(std::make_pair(NewDirtyInst, P));
1391f22ef01cSRoman Divacky       }
1392f22ef01cSRoman Divacky 
1393f22ef01cSRoman Divacky       // Re-sort the NonLocalDepInfo.  Changing the dirty entry to its
1394f22ef01cSRoman Divacky       // subsequent value may invalidate the sortedness.
1395f22ef01cSRoman Divacky       std::sort(NLPDI.begin(), NLPDI.end());
1396f22ef01cSRoman Divacky     }
1397f22ef01cSRoman Divacky 
1398f22ef01cSRoman Divacky     ReverseNonLocalPtrDeps.erase(ReversePtrDepIt);
1399f22ef01cSRoman Divacky 
1400f22ef01cSRoman Divacky     while (!ReversePtrDepsToAdd.empty()) {
1401f22ef01cSRoman Divacky       ReverseNonLocalPtrDeps[ReversePtrDepsToAdd.back().first]
1402f22ef01cSRoman Divacky         .insert(ReversePtrDepsToAdd.back().second);
1403f22ef01cSRoman Divacky       ReversePtrDepsToAdd.pop_back();
1404f22ef01cSRoman Divacky     }
1405f22ef01cSRoman Divacky   }
1406f22ef01cSRoman Divacky 
1407f22ef01cSRoman Divacky 
1408f22ef01cSRoman Divacky   assert(!NonLocalDeps.count(RemInst) && "RemInst got reinserted?");
1409f22ef01cSRoman Divacky   AA->deleteValue(RemInst);
1410f22ef01cSRoman Divacky   DEBUG(verifyRemoved(RemInst));
1411f22ef01cSRoman Divacky }
1412f22ef01cSRoman Divacky /// verifyRemoved - Verify that the specified instruction does not occur
1413f22ef01cSRoman Divacky /// in our internal data structures.
1414f22ef01cSRoman Divacky void MemoryDependenceAnalysis::verifyRemoved(Instruction *D) const {
1415f22ef01cSRoman Divacky   for (LocalDepMapType::const_iterator I = LocalDeps.begin(),
1416f22ef01cSRoman Divacky        E = LocalDeps.end(); I != E; ++I) {
1417f22ef01cSRoman Divacky     assert(I->first != D && "Inst occurs in data structures");
1418f22ef01cSRoman Divacky     assert(I->second.getInst() != D &&
1419f22ef01cSRoman Divacky            "Inst occurs in data structures");
1420f22ef01cSRoman Divacky   }
1421f22ef01cSRoman Divacky 
1422f22ef01cSRoman Divacky   for (CachedNonLocalPointerInfo::const_iterator I =NonLocalPointerDeps.begin(),
1423f22ef01cSRoman Divacky        E = NonLocalPointerDeps.end(); I != E; ++I) {
1424f22ef01cSRoman Divacky     assert(I->first.getPointer() != D && "Inst occurs in NLPD map key");
14252754fe60SDimitry Andric     const NonLocalDepInfo &Val = I->second.NonLocalDeps;
1426f22ef01cSRoman Divacky     for (NonLocalDepInfo::const_iterator II = Val.begin(), E = Val.end();
1427f22ef01cSRoman Divacky          II != E; ++II)
1428f22ef01cSRoman Divacky       assert(II->getResult().getInst() != D && "Inst occurs as NLPD value");
1429f22ef01cSRoman Divacky   }
1430f22ef01cSRoman Divacky 
1431f22ef01cSRoman Divacky   for (NonLocalDepMapType::const_iterator I = NonLocalDeps.begin(),
1432f22ef01cSRoman Divacky        E = NonLocalDeps.end(); I != E; ++I) {
1433f22ef01cSRoman Divacky     assert(I->first != D && "Inst occurs in data structures");
1434f22ef01cSRoman Divacky     const PerInstNLInfo &INLD = I->second;
1435f22ef01cSRoman Divacky     for (NonLocalDepInfo::const_iterator II = INLD.first.begin(),
1436f22ef01cSRoman Divacky          EE = INLD.first.end(); II  != EE; ++II)
1437f22ef01cSRoman Divacky       assert(II->getResult().getInst() != D && "Inst occurs in data structures");
1438f22ef01cSRoman Divacky   }
1439f22ef01cSRoman Divacky 
1440f22ef01cSRoman Divacky   for (ReverseDepMapType::const_iterator I = ReverseLocalDeps.begin(),
1441f22ef01cSRoman Divacky        E = ReverseLocalDeps.end(); I != E; ++I) {
1442f22ef01cSRoman Divacky     assert(I->first != D && "Inst occurs in data structures");
1443f22ef01cSRoman Divacky     for (SmallPtrSet<Instruction*, 4>::const_iterator II = I->second.begin(),
1444f22ef01cSRoman Divacky          EE = I->second.end(); II != EE; ++II)
1445f22ef01cSRoman Divacky       assert(*II != D && "Inst occurs in data structures");
1446f22ef01cSRoman Divacky   }
1447f22ef01cSRoman Divacky 
1448f22ef01cSRoman Divacky   for (ReverseDepMapType::const_iterator I = ReverseNonLocalDeps.begin(),
1449f22ef01cSRoman Divacky        E = ReverseNonLocalDeps.end();
1450f22ef01cSRoman Divacky        I != E; ++I) {
1451f22ef01cSRoman Divacky     assert(I->first != D && "Inst occurs in data structures");
1452f22ef01cSRoman Divacky     for (SmallPtrSet<Instruction*, 4>::const_iterator II = I->second.begin(),
1453f22ef01cSRoman Divacky          EE = I->second.end(); II != EE; ++II)
1454f22ef01cSRoman Divacky       assert(*II != D && "Inst occurs in data structures");
1455f22ef01cSRoman Divacky   }
1456f22ef01cSRoman Divacky 
1457f22ef01cSRoman Divacky   for (ReverseNonLocalPtrDepTy::const_iterator
1458f22ef01cSRoman Divacky        I = ReverseNonLocalPtrDeps.begin(),
1459f22ef01cSRoman Divacky        E = ReverseNonLocalPtrDeps.end(); I != E; ++I) {
1460f22ef01cSRoman Divacky     assert(I->first != D && "Inst occurs in rev NLPD map");
1461f22ef01cSRoman Divacky 
1462f22ef01cSRoman Divacky     for (SmallPtrSet<ValueIsLoadPair, 4>::const_iterator II = I->second.begin(),
1463f22ef01cSRoman Divacky          E = I->second.end(); II != E; ++II)
1464f22ef01cSRoman Divacky       assert(*II != ValueIsLoadPair(D, false) &&
1465f22ef01cSRoman Divacky              *II != ValueIsLoadPair(D, true) &&
1466f22ef01cSRoman Divacky              "Inst occurs in ReverseNonLocalPtrDeps map");
1467f22ef01cSRoman Divacky   }
1468f22ef01cSRoman Divacky 
1469f22ef01cSRoman Divacky }
1470