lib/Analysis/MemoryDependenceAnalysis.cpp

   1 //===- MemoryDependenceAnalysis.cpp - Mem Deps Implementation -------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements an analysis that determines, for a given memory
  11 // operation, what preceding memory operations it depends on.  It builds on
  12 // alias analysis information, and tries to provide a lazy, caching interface to
  13 // a common kind of alias information query.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/Analysis/MemoryDependenceAnalysis.h"
  18 #include "llvm/ADT/STLExtras.h"
  19 #include "llvm/ADT/Statistic.h"
  20 #include "llvm/Analysis/AliasAnalysis.h"
  21 #include "llvm/Analysis/InstructionSimplify.h"
  22 #include "llvm/Analysis/MemoryBuiltins.h"
  23 #include "llvm/Analysis/PHITransAddr.h"
  24 #include "llvm/Analysis/ValueTracking.h"
  25 #include "llvm/IR/DataLayout.h"
  26 #include "llvm/IR/Dominators.h"
  27 #include "llvm/IR/Function.h"
  28 #include "llvm/IR/Instructions.h"
  29 #include "llvm/IR/IntrinsicInst.h"
  30 #include "llvm/IR/LLVMContext.h"
  31 #include "llvm/IR/PredIteratorCache.h"
  32 #include "llvm/Support/Debug.h"
  33 using namespace llvm;
  34
  35 #define DEBUG_TYPE "memdep"
  36
  37 STATISTIC(NumCacheNonLocal, "Number of fully cached non-local responses");
  38 STATISTIC(NumCacheDirtyNonLocal, "Number of dirty cached non-local responses");
  39 STATISTIC(NumUncacheNonLocal, "Number of uncached non-local responses");
  40
  41 STATISTIC(NumCacheNonLocalPtr,
  42           "Number of fully cached non-local ptr responses");
  43 STATISTIC(NumCacheDirtyNonLocalPtr,
  44           "Number of cached, but dirty, non-local ptr responses");
  45 STATISTIC(NumUncacheNonLocalPtr,
  46           "Number of uncached non-local ptr responses");
  47 STATISTIC(NumCacheCompleteNonLocalPtr,
  48           "Number of block queries that were completely cached");
  49
  50 // Limit for the number of instructions to scan in a block.
  51 static const int BlockScanLimit = 100;
  52
  53 char MemoryDependenceAnalysis::ID = 0;
  54
  55 // Register this pass...
  56 INITIALIZE_PASS_BEGIN(MemoryDependenceAnalysis, "memdep",
  57                 "Memory Dependence Analysis", false, true)
  58 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
  59 INITIALIZE_PASS_END(MemoryDependenceAnalysis, "memdep",
  60                       "Memory Dependence Analysis", false, true)
  61
  62 MemoryDependenceAnalysis::MemoryDependenceAnalysis()
  63     : FunctionPass(ID), PredCache() {
  64   initializeMemoryDependenceAnalysisPass(*PassRegistry::getPassRegistry());
  65 }
  66 MemoryDependenceAnalysis::~MemoryDependenceAnalysis() {
  67 }
  68
  69 /// Clean up memory in between runs
  70 void MemoryDependenceAnalysis::releaseMemory() {
  71   LocalDeps.clear();
  72   NonLocalDeps.clear();
  73   NonLocalPointerDeps.clear();
  74   ReverseLocalDeps.clear();
  75   ReverseNonLocalDeps.clear();
  76   ReverseNonLocalPtrDeps.clear();
  77   PredCache->clear();
  78 }
  79
  80
  81
  82 /// getAnalysisUsage - Does not modify anything.  It uses Alias Analysis.
  83 ///
  84 void MemoryDependenceAnalysis::getAnalysisUsage(AnalysisUsage &AU) const {
  85   AU.setPreservesAll();
  86   AU.addRequiredTransitive<AliasAnalysis>();
  87 }
  88
  89 bool MemoryDependenceAnalysis::runOnFunction(Function &) {
  90   AA = &getAnalysis<AliasAnalysis>();
  91   DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
  92   DL = DLP ? &DLP->getDataLayout() : nullptr;
  93   DominatorTreeWrapperPass *DTWP =
  94       getAnalysisIfAvailable<DominatorTreeWrapperPass>();
  95   DT = DTWP ? &DTWP->getDomTree() : nullptr;
  96   if (!PredCache)
  97     PredCache.reset(new PredIteratorCache());
  98   return false;
  99 }
 100
 101 /// RemoveFromReverseMap - This is a helper function that removes Val from
 102 /// 'Inst's set in ReverseMap.  If the set becomes empty, remove Inst's entry.
 103 template <typename KeyTy>
 104 static void RemoveFromReverseMap(DenseMap<Instruction*,
 105                                  SmallPtrSet<KeyTy, 4> > &ReverseMap,
 106                                  Instruction *Inst, KeyTy Val) {
 107   typename DenseMap<Instruction*, SmallPtrSet<KeyTy, 4> >::iterator
 108   InstIt = ReverseMap.find(Inst);
 109   assert(InstIt != ReverseMap.end() && "Reverse map out of sync?");
 110   bool Found = InstIt->second.erase(Val);
 111   assert(Found && "Invalid reverse map!"); (void)Found;
 112   if (InstIt->second.empty())
 113     ReverseMap.erase(InstIt);
 114 }
 115
 116 /// GetLocation - If the given instruction references a specific memory
 117 /// location, fill in Loc with the details, otherwise set Loc.Ptr to null.
 118 /// Return a ModRefInfo value describing the general behavior of the
 119 /// instruction.
 120 static
 121 AliasAnalysis::ModRefResult GetLocation(const Instruction *Inst,
 122                                         AliasAnalysis::Location &Loc,
 123                                         AliasAnalysis *AA) {
 124   if (const LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
 125     if (LI->isUnordered()) {
 126       Loc = AA->getLocation(LI);
 127       return AliasAnalysis::Ref;
 128     }
 129     if (LI->getOrdering() == Monotonic) {
 130       Loc = AA->getLocation(LI);
 131       return AliasAnalysis::ModRef;
 132     }
 133     Loc = AliasAnalysis::Location();
 134     return AliasAnalysis::ModRef;
 135   }
 136
 137   if (const StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
 138     if (SI->isUnordered()) {
 139       Loc = AA->getLocation(SI);
 140       return AliasAnalysis::Mod;
 141     }
 142     if (SI->getOrdering() == Monotonic) {
 143       Loc = AA->getLocation(SI);
 144       return AliasAnalysis::ModRef;
 145     }
 146     Loc = AliasAnalysis::Location();
 147     return AliasAnalysis::ModRef;
 148   }
 149
 150   if (const VAArgInst *V = dyn_cast<VAArgInst>(Inst)) {
 151     Loc = AA->getLocation(V);
 152     return AliasAnalysis::ModRef;
 153   }
 154
 155   if (const CallInst *CI = isFreeCall(Inst, AA->getTargetLibraryInfo())) {
 156     // calls to free() deallocate the entire structure
 157     Loc = AliasAnalysis::Location(CI->getArgOperand(0));
 158     return AliasAnalysis::Mod;
 159   }
 160
 161   if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
 162     AAMDNodes AAInfo;
 163
 164     switch (II->getIntrinsicID()) {
 165     case Intrinsic::lifetime_start:
 166     case Intrinsic::lifetime_end:
 167     case Intrinsic::invariant_start:
 168       II->getAAMetadata(AAInfo);
 169       Loc = AliasAnalysis::Location(II->getArgOperand(1),
 170                                     cast<ConstantInt>(II->getArgOperand(0))
 171                                       ->getZExtValue(), AAInfo);
 172       // These intrinsics don't really modify the memory, but returning Mod
 173       // will allow them to be handled conservatively.
 174       return AliasAnalysis::Mod;
 175     case Intrinsic::invariant_end:
 176       II->getAAMetadata(AAInfo);
 177       Loc = AliasAnalysis::Location(II->getArgOperand(2),
 178                                     cast<ConstantInt>(II->getArgOperand(1))
 179                                       ->getZExtValue(), AAInfo);
 180       // These intrinsics don't really modify the memory, but returning Mod
 181       // will allow them to be handled conservatively.
 182       return AliasAnalysis::Mod;
 183     default:
 184       break;
 185     }
 186   }
 187
 188   // Otherwise, just do the coarse-grained thing that always works.
 189   if (Inst->mayWriteToMemory())
 190     return AliasAnalysis::ModRef;
 191   if (Inst->mayReadFromMemory())
 192     return AliasAnalysis::Ref;
 193   return AliasAnalysis::NoModRef;
 194 }
 195
 196 /// getCallSiteDependencyFrom - Private helper for finding the local
 197 /// dependencies of a call site.
 198 MemDepResult MemoryDependenceAnalysis::
 199 getCallSiteDependencyFrom(CallSite CS, bool isReadOnlyCall,
 200                           BasicBlock::iterator ScanIt, BasicBlock *BB) {
 201   unsigned Limit = BlockScanLimit;
 202
 203   // Walk backwards through the block, looking for dependencies
 204   while (ScanIt != BB->begin()) {
 205     // Limit the amount of scanning we do so we don't end up with quadratic
 206     // running time on extreme testcases.
 207     --Limit;
 208     if (!Limit)
 209       return MemDepResult::getUnknown();
 210
 211     Instruction *Inst = --ScanIt;
 212
 213     // If this inst is a memory op, get the pointer it accessed
 214     AliasAnalysis::Location Loc;
 215     AliasAnalysis::ModRefResult MR = GetLocation(Inst, Loc, AA);
 216     if (Loc.Ptr) {
 217       // A simple instruction.
 218       if (AA->getModRefInfo(CS, Loc) != AliasAnalysis::NoModRef)
 219         return MemDepResult::getClobber(Inst);
 220       continue;
 221     }
 222
 223     if (CallSite InstCS = cast<Value>(Inst)) {
 224       // Debug intrinsics don't cause dependences.
 225       if (isa<DbgInfoIntrinsic>(Inst)) continue;
 226       // If these two calls do not interfere, look past it.
 227       switch (AA->getModRefInfo(CS, InstCS)) {
 228       case AliasAnalysis::NoModRef:
 229         // If the two calls are the same, return InstCS as a Def, so that
 230         // CS can be found redundant and eliminated.
 231         if (isReadOnlyCall && !(MR & AliasAnalysis::Mod) &&
 232             CS.getInstruction()->isIdenticalToWhenDefined(Inst))
 233           return MemDepResult::getDef(Inst);
 234
 235         // Otherwise if the two calls don't interact (e.g. InstCS is readnone)
 236         // keep scanning.
 237         continue;
 238       default:
 239         return MemDepResult::getClobber(Inst);
 240       }
 241     }
 242
 243     // If we could not obtain a pointer for the instruction and the instruction
 244     // touches memory then assume that this is a dependency.
 245     if (MR != AliasAnalysis::NoModRef)
 246       return MemDepResult::getClobber(Inst);
 247   }
 248
 249   // No dependence found.  If this is the entry block of the function, it is
 250   // unknown, otherwise it is non-local.
 251   if (BB != &BB->getParent()->getEntryBlock())
 252     return MemDepResult::getNonLocal();
 253   return MemDepResult::getNonFuncLocal();
 254 }
 255
 256 /// isLoadLoadClobberIfExtendedToFullWidth - Return true if LI is a load that
 257 /// would fully overlap MemLoc if done as a wider legal integer load.
 258 ///
 259 /// MemLocBase, MemLocOffset are lazily computed here the first time the
 260 /// base/offs of memloc is needed.
 261 static bool
 262 isLoadLoadClobberIfExtendedToFullWidth(const AliasAnalysis::Location &MemLoc,
 263                                        const Value *&MemLocBase,
 264                                        int64_t &MemLocOffs,
 265                                        const LoadInst *LI,
 266                                        const DataLayout *DL) {
 267   // If we have no target data, we can't do this.
 268   if (!DL) return false;
 269
 270   // If we haven't already computed the base/offset of MemLoc, do so now.
 271   if (!MemLocBase)
 272     MemLocBase = GetPointerBaseWithConstantOffset(MemLoc.Ptr, MemLocOffs, DL);
 273
 274   unsigned Size = MemoryDependenceAnalysis::
 275     getLoadLoadClobberFullWidthSize(MemLocBase, MemLocOffs, MemLoc.Size,
 276                                     LI, *DL);
 277   return Size != 0;
 278 }
 279
 280 /// getLoadLoadClobberFullWidthSize - This is a little bit of analysis that
 281 /// looks at a memory location for a load (specified by MemLocBase, Offs,
 282 /// and Size) and compares it against a load.  If the specified load could
 283 /// be safely widened to a larger integer load that is 1) still efficient,
 284 /// 2) safe for the target, and 3) would provide the specified memory
 285 /// location value, then this function returns the size in bytes of the
 286 /// load width to use.  If not, this returns zero.
 287 unsigned MemoryDependenceAnalysis::
 288 getLoadLoadClobberFullWidthSize(const Value *MemLocBase, int64_t MemLocOffs,
 289                                 unsigned MemLocSize, const LoadInst *LI,
 290                                 const DataLayout &DL) {
 291   // We can only extend simple integer loads.
 292   if (!isa<IntegerType>(LI->getType()) || !LI->isSimple()) return 0;
 293
 294   // Load widening is hostile to ThreadSanitizer: it may cause false positives
 295   // or make the reports more cryptic (access sizes are wrong).
 296   if (LI->getParent()->getParent()->getAttributes().
 297       hasAttribute(AttributeSet::FunctionIndex, Attribute::SanitizeThread))
 298     return 0;
 299
 300   // Get the base of this load.
 301   int64_t LIOffs = 0;
 302   const Value *LIBase =
 303     GetPointerBaseWithConstantOffset(LI->getPointerOperand(), LIOffs, &DL);
 304
 305   // If the two pointers are not based on the same pointer, we can't tell that
 306   // they are related.
 307   if (LIBase != MemLocBase) return 0;
 308
 309   // Okay, the two values are based on the same pointer, but returned as
 310   // no-alias.  This happens when we have things like two byte loads at "P+1"
 311   // and "P+3".  Check to see if increasing the size of the "LI" load up to its
 312   // alignment (or the largest native integer type) will allow us to load all
 313   // the bits required by MemLoc.
 314
 315   // If MemLoc is before LI, then no widening of LI will help us out.
 316   if (MemLocOffs < LIOffs) return 0;
 317
 318   // Get the alignment of the load in bytes.  We assume that it is safe to load
 319   // any legal integer up to this size without a problem.  For example, if we're
 320   // looking at an i8 load on x86-32 that is known 1024 byte aligned, we can
 321   // widen it up to an i32 load.  If it is known 2-byte aligned, we can widen it
 322   // to i16.
 323   unsigned LoadAlign = LI->getAlignment();
 324
 325   int64_t MemLocEnd = MemLocOffs+MemLocSize;
 326
 327   // If no amount of rounding up will let MemLoc fit into LI, then bail out.
 328   if (LIOffs+LoadAlign < MemLocEnd) return 0;
 329
 330   // This is the size of the load to try.  Start with the next larger power of
 331   // two.
 332   unsigned NewLoadByteSize = LI->getType()->getPrimitiveSizeInBits()/8U;
 333   NewLoadByteSize = NextPowerOf2(NewLoadByteSize);
 334
 335   while (1) {
 336     // If this load size is bigger than our known alignment or would not fit
 337     // into a native integer register, then we fail.
 338     if (NewLoadByteSize > LoadAlign ||
 339         !DL.fitsInLegalInteger(NewLoadByteSize*8))
 340       return 0;
 341
 342     if (LIOffs+NewLoadByteSize > MemLocEnd &&
 343         LI->getParent()->getParent()->getAttributes().
 344           hasAttribute(AttributeSet::FunctionIndex, Attribute::SanitizeAddress))
 345       // We will be reading past the location accessed by the original program.
 346       // While this is safe in a regular build, Address Safety analysis tools
 347       // may start reporting false warnings. So, don't do widening.
 348       return 0;
 349
 350     // If a load of this width would include all of MemLoc, then we succeed.
 351     if (LIOffs+NewLoadByteSize >= MemLocEnd)
 352       return NewLoadByteSize;
 353
 354     NewLoadByteSize <<= 1;
 355   }
 356 }
 357
 358 /// getPointerDependencyFrom - Return the instruction on which a memory
 359 /// location depends.  If isLoad is true, this routine ignores may-aliases with
 360 /// read-only operations.  If isLoad is false, this routine ignores may-aliases
 361 /// with reads from read-only locations.  If possible, pass the query
 362 /// instruction as well; this function may take advantage of the metadata
 363 /// annotated to the query instruction to refine the result.
 364 MemDepResult MemoryDependenceAnalysis::
 365 getPointerDependencyFrom(const AliasAnalysis::Location &MemLoc, bool isLoad,
 366                          BasicBlock::iterator ScanIt, BasicBlock *BB,
 367                          Instruction *QueryInst) {
 368
 369   const Value *MemLocBase = nullptr;
 370   int64_t MemLocOffset = 0;
 371   unsigned Limit = BlockScanLimit;
 372   bool isInvariantLoad = false;
 373
 374   // We must be careful with atomic accesses, as they may allow another thread
 375   //   to touch this location, cloberring it. We are conservative: if the
 376   //   QueryInst is not a simple (non-atomic) memory access, we automatically
 377   //   return getClobber.
 378   // If it is simple, we know based on the results of
 379   // "Compiler testing via a theory of sound optimisations in the C11/C++11
 380   //   memory model" in PLDI 2013, that a non-atomic location can only be
 381   //   clobbered between a pair of a release and an acquire action, with no
 382   //   access to the location in between.
 383   // Here is an example for giving the general intuition behind this rule.
 384   // In the following code:
 385   //   store x 0;
 386   //   release action; [1]
 387   //   acquire action; [4]
 388   //   %val = load x;
 389   // It is unsafe to replace %val by 0 because another thread may be running:
 390   //   acquire action; [2]
 391   //   store x 42;
 392   //   release action; [3]
 393   // with synchronization from 1 to 2 and from 3 to 4, resulting in %val
 394   // being 42. A key property of this program however is that if either
 395   // 1 or 4 were missing, there would be a race between the store of 42
 396   // either the store of 0 or the load (making the whole progam racy).
 397   // The paper mentionned above shows that the same property is respected
 398   // by every program that can detect any optimisation of that kind: either
 399   // it is racy (undefined) or there is a release followed by an acquire
 400   // between the pair of accesses under consideration.
 401   bool HasSeenAcquire = false;
 402
 403   if (isLoad && QueryInst) {
 404     LoadInst *LI = dyn_cast<LoadInst>(QueryInst);
 405     if (LI && LI->getMetadata(LLVMContext::MD_invariant_load) != nullptr)
 406       isInvariantLoad = true;
 407   }
 408
 409   // Walk backwards through the basic block, looking for dependencies.
 410   while (ScanIt != BB->begin()) {
 411     Instruction *Inst = --ScanIt;
 412
 413     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst))
 414       // Debug intrinsics don't (and can't) cause dependencies.
 415       if (isa<DbgInfoIntrinsic>(II)) continue;
 416
 417     // Limit the amount of scanning we do so we don't end up with quadratic
 418     // running time on extreme testcases.
 419     --Limit;
 420     if (!Limit)
 421       return MemDepResult::getUnknown();
 422
 423     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
 424       // If we reach a lifetime begin or end marker, then the query ends here
 425       // because the value is undefined.
 426       if (II->getIntrinsicID() == Intrinsic::lifetime_start) {
 427         // FIXME: This only considers queries directly on the invariant-tagged
 428         // pointer, not on query pointers that are indexed off of them.  It'd
 429         // be nice to handle that at some point (the right approach is to use
 430         // GetPointerBaseWithConstantOffset).
 431         if (AA->isMustAlias(AliasAnalysis::Location(II->getArgOperand(1)),
 432                             MemLoc))
 433           return MemDepResult::getDef(II);
 434         continue;
 435       }
 436     }
 437
 438     // Values depend on loads if the pointers are must aliased.  This means that
 439     // a load depends on another must aliased load from the same value.
 440     // One exception is atomic loads: a value can depend on an atomic load that it
 441     // does not alias with when this atomic load indicates that another thread may
 442     // be accessing the location.
 443     if (LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
 444       // Atomic loads have complications involved.
 445       // A Monotonic (or higher) load is OK if the query inst is itself not atomic.
 446       // An Acquire (or higher) load sets the HasSeenAcquire flag, so that any
 447       //   release store will know to return getClobber.
 448       // FIXME: This is overly conservative.
 449       if (!LI->isUnordered()) {
 450         if (!QueryInst)
 451           return MemDepResult::getClobber(LI);
 452         if (auto *QueryLI = dyn_cast<LoadInst>(QueryInst)) {
 453           if (!QueryLI->isSimple())
 454             return MemDepResult::getClobber(LI);
 455         } else if (auto *QuerySI = dyn_cast<StoreInst>(QueryInst)) {
 456           if (!QuerySI->isSimple())
 457             return MemDepResult::getClobber(LI);
 458         } else if (QueryInst->mayReadOrWriteMemory()) {
 459           return MemDepResult::getClobber(LI);
 460         }
 461
 462         if (isAtLeastAcquire(LI->getOrdering()))
 463           HasSeenAcquire = true;
 464       }
 465
 466       // FIXME: this is overly conservative.
 467       // While volatile access cannot be eliminated, they do not have to clobber
 468       // non-aliasing locations, as normal accesses can for example be reordered
 469       // with volatile accesses.
 470       if (LI->isVolatile())
 471         return MemDepResult::getClobber(LI);
 472
 473       AliasAnalysis::Location LoadLoc = AA->getLocation(LI);
 474
 475       // If we found a pointer, check if it could be the same as our pointer.
 476       AliasAnalysis::AliasResult R = AA->alias(LoadLoc, MemLoc);
 477
 478       if (isLoad) {
 479         if (R == AliasAnalysis::NoAlias) {
 480           // If this is an over-aligned integer load (for example,
 481           // "load i8* %P, align 4") see if it would obviously overlap with the
 482           // queried location if widened to a larger load (e.g. if the queried
 483           // location is 1 byte at P+1).  If so, return it as a load/load
 484           // clobber result, allowing the client to decide to widen the load if
 485           // it wants to.
 486           if (IntegerType *ITy = dyn_cast<IntegerType>(LI->getType()))
 487             if (LI->getAlignment()*8 > ITy->getPrimitiveSizeInBits() &&
 488                 isLoadLoadClobberIfExtendedToFullWidth(MemLoc, MemLocBase,
 489                                                        MemLocOffset, LI, DL))
 490               return MemDepResult::getClobber(Inst);
 491
 492           continue;
 493         }
 494
 495         // Must aliased loads are defs of each other.
 496         if (R == AliasAnalysis::MustAlias)
 497           return MemDepResult::getDef(Inst);
 498
 499 #if 0 // FIXME: Temporarily disabled. GVN is cleverly rewriting loads
 500       // in terms of clobbering loads, but since it does this by looking
 501       // at the clobbering load directly, it doesn't know about any
 502       // phi translation that may have happened along the way.
 503
 504         // If we have a partial alias, then return this as a clobber for the
 505         // client to handle.
 506         if (R == AliasAnalysis::PartialAlias)
 507           return MemDepResult::getClobber(Inst);
 508 #endif
 509
 510         // Random may-alias loads don't depend on each other without a
 511         // dependence.
 512         continue;
 513       }
 514
 515       // Stores don't depend on other no-aliased accesses.
 516       if (R == AliasAnalysis::NoAlias)
 517         continue;
 518
 519       // Stores don't alias loads from read-only memory.
 520       if (AA->pointsToConstantMemory(LoadLoc))
 521         continue;
 522
 523       // Stores depend on may/must aliased loads.
 524       return MemDepResult::getDef(Inst);
 525     }
 526
 527     if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
 528       // Atomic stores have complications involved.
 529       // A Monotonic store is OK if the query inst is itself not atomic.
 530       // A Release (or higher) store further requires that no acquire load
 531       //   has been seen.
 532       // FIXME: This is overly conservative.
 533       if (!SI->isUnordered()) {
 534         if (!QueryInst)
 535           return MemDepResult::getClobber(SI);
 536         if (auto *QueryLI = dyn_cast<LoadInst>(QueryInst)) {
 537           if (!QueryLI->isSimple())
 538             return MemDepResult::getClobber(SI);
 539         } else if (auto *QuerySI = dyn_cast<StoreInst>(QueryInst)) {
 540           if (!QuerySI->isSimple())
 541             return MemDepResult::getClobber(SI);
 542         } else if (QueryInst->mayReadOrWriteMemory()) {
 543           return MemDepResult::getClobber(SI);
 544         }
 545
 546         if (HasSeenAcquire && isAtLeastRelease(SI->getOrdering()))
 547           return MemDepResult::getClobber(SI);
 548       }
 549
 550       // FIXME: this is overly conservative.
 551       // While volatile access cannot be eliminated, they do not have to clobber
 552       // non-aliasing locations, as normal accesses can for example be reordered
 553       // with volatile accesses.
 554       if (SI->isVolatile())
 555         return MemDepResult::getClobber(SI);
 556
 557       // If alias analysis can tell that this store is guaranteed to not modify
 558       // the query pointer, ignore it.  Use getModRefInfo to handle cases where
 559       // the query pointer points to constant memory etc.
 560       if (AA->getModRefInfo(SI, MemLoc) == AliasAnalysis::NoModRef)
 561         continue;
 562
 563       // Ok, this store might clobber the query pointer.  Check to see if it is
 564       // a must alias: in this case, we want to return this as a def.
 565       AliasAnalysis::Location StoreLoc = AA->getLocation(SI);
 566
 567       // If we found a pointer, check if it could be the same as our pointer.
 568       AliasAnalysis::AliasResult R = AA->alias(StoreLoc, MemLoc);
 569
 570       if (R == AliasAnalysis::NoAlias)
 571         continue;
 572       if (R == AliasAnalysis::MustAlias)
 573         return MemDepResult::getDef(Inst);
 574       if (isInvariantLoad)
 575        continue;
 576       return MemDepResult::getClobber(Inst);
 577     }
 578
 579     // If this is an allocation, and if we know that the accessed pointer is to
 580     // the allocation, return Def.  This means that there is no dependence and
 581     // the access can be optimized based on that.  For example, a load could
 582     // turn into undef.
 583     // Note: Only determine this to be a malloc if Inst is the malloc call, not
 584     // a subsequent bitcast of the malloc call result.  There can be stores to
 585     // the malloced memory between the malloc call and its bitcast uses, and we
 586     // need to continue scanning until the malloc call.
 587     const TargetLibraryInfo *TLI = AA->getTargetLibraryInfo();
 588     if (isa<AllocaInst>(Inst) || isNoAliasFn(Inst, TLI)) {
 589       const Value *AccessPtr = GetUnderlyingObject(MemLoc.Ptr, DL);
 590
 591       if (AccessPtr == Inst || AA->isMustAlias(Inst, AccessPtr))
 592         return MemDepResult::getDef(Inst);
 593       // Be conservative if the accessed pointer may alias the allocation.
 594       if (AA->alias(Inst, AccessPtr) != AliasAnalysis::NoAlias)
 595         return MemDepResult::getClobber(Inst);
 596       // If the allocation is not aliased and does not read memory (like
 597       // strdup), it is safe to ignore.
 598       if (isa<AllocaInst>(Inst) ||
 599           isMallocLikeFn(Inst, TLI) || isCallocLikeFn(Inst, TLI))
 600         continue;
 601     }
 602
 603     // See if this instruction (e.g. a call or vaarg) mod/ref's the pointer.
 604     AliasAnalysis::ModRefResult MR = AA->getModRefInfo(Inst, MemLoc);
 605     // If necessary, perform additional analysis.
 606     if (MR == AliasAnalysis::ModRef)
 607       MR = AA->callCapturesBefore(Inst, MemLoc, DT);
 608     switch (MR) {
 609     case AliasAnalysis::NoModRef:
 610       // If the call has no effect on the queried pointer, just ignore it.
 611       continue;
 612     case AliasAnalysis::Mod:
 613       return MemDepResult::getClobber(Inst);
 614     case AliasAnalysis::Ref:
 615       // If the call is known to never store to the pointer, and if this is a
 616       // load query, we can safely ignore it (scan past it).
 617       if (isLoad)
 618         continue;
 619     default:
 620       // Otherwise, there is a potential dependence.  Return a clobber.
 621       return MemDepResult::getClobber(Inst);
 622     }
 623   }
 624
 625   // No dependence found.  If this is the entry block of the function, it is
 626   // unknown, otherwise it is non-local.
 627   if (BB != &BB->getParent()->getEntryBlock())
 628     return MemDepResult::getNonLocal();
 629   return MemDepResult::getNonFuncLocal();
 630 }
 631
 632 /// getDependency - Return the instruction on which a memory operation
 633 /// depends.
 634 MemDepResult MemoryDependenceAnalysis::getDependency(Instruction *QueryInst) {
 635   Instruction *ScanPos = QueryInst;
 636
 637   // Check for a cached result
 638   MemDepResult &LocalCache = LocalDeps[QueryInst];
 639
 640   // If the cached entry is non-dirty, just return it.  Note that this depends
 641   // on MemDepResult's default constructing to 'dirty'.
 642   if (!LocalCache.isDirty())
 643     return LocalCache;
 644
 645   // Otherwise, if we have a dirty entry, we know we can start the scan at that
 646   // instruction, which may save us some work.
 647   if (Instruction *Inst = LocalCache.getInst()) {
 648     ScanPos = Inst;
 649
 650     RemoveFromReverseMap(ReverseLocalDeps, Inst, QueryInst);
 651   }
 652
 653   BasicBlock *QueryParent = QueryInst->getParent();
 654
 655   // Do the scan.
 656   if (BasicBlock::iterator(QueryInst) == QueryParent->begin()) {
 657     // No dependence found.  If this is the entry block of the function, it is
 658     // unknown, otherwise it is non-local.
 659     if (QueryParent != &QueryParent->getParent()->getEntryBlock())
 660       LocalCache = MemDepResult::getNonLocal();
 661     else
 662       LocalCache = MemDepResult::getNonFuncLocal();
 663   } else {
 664     AliasAnalysis::Location MemLoc;
 665     AliasAnalysis::ModRefResult MR = GetLocation(QueryInst, MemLoc, AA);
 666     if (MemLoc.Ptr) {
 667       // If we can do a pointer scan, make it happen.
 668       bool isLoad = !(MR & AliasAnalysis::Mod);
 669       if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(QueryInst))
 670         isLoad |= II->getIntrinsicID() == Intrinsic::lifetime_start;
 671
 672       LocalCache = getPointerDependencyFrom(MemLoc, isLoad, ScanPos,
 673                                             QueryParent, QueryInst);
 674     } else if (isa<CallInst>(QueryInst) || isa<InvokeInst>(QueryInst)) {
 675       CallSite QueryCS(QueryInst);
 676       bool isReadOnly = AA->onlyReadsMemory(QueryCS);
 677       LocalCache = getCallSiteDependencyFrom(QueryCS, isReadOnly, ScanPos,
 678                                              QueryParent);
 679     } else
 680       // Non-memory instruction.
 681       LocalCache = MemDepResult::getUnknown();
 682   }
 683
 684   // Remember the result!
 685   if (Instruction *I = LocalCache.getInst())
 686     ReverseLocalDeps[I].insert(QueryInst);
 687
 688   return LocalCache;
 689 }
 690
 691 #ifndef NDEBUG
 692 /// AssertSorted - This method is used when -debug is specified to verify that
 693 /// cache arrays are properly kept sorted.
 694 static void AssertSorted(MemoryDependenceAnalysis::NonLocalDepInfo &Cache,
 695                          int Count = -1) {
 696   if (Count == -1) Count = Cache.size();
 697   if (Count == 0) return;
 698
 699   for (unsigned i = 1; i != unsigned(Count); ++i)
 700     assert(!(Cache[i] < Cache[i-1]) && "Cache isn't sorted!");
 701 }
 702 #endif
 703
 704 /// getNonLocalCallDependency - Perform a full dependency query for the
 705 /// specified call, returning the set of blocks that the value is
 706 /// potentially live across.  The returned set of results will include a
 707 /// "NonLocal" result for all blocks where the value is live across.
 708 ///
 709 /// This method assumes the instruction returns a "NonLocal" dependency
 710 /// within its own block.
 711 ///
 712 /// This returns a reference to an internal data structure that may be
 713 /// invalidated on the next non-local query or when an instruction is
 714 /// removed.  Clients must copy this data if they want it around longer than
 715 /// that.
 716 const MemoryDependenceAnalysis::NonLocalDepInfo &
 717 MemoryDependenceAnalysis::getNonLocalCallDependency(CallSite QueryCS) {
 718   assert(getDependency(QueryCS.getInstruction()).isNonLocal() &&
 719  "getNonLocalCallDependency should only be used on calls with non-local deps!");
 720   PerInstNLInfo &CacheP = NonLocalDeps[QueryCS.getInstruction()];
 721   NonLocalDepInfo &Cache = CacheP.first;
 722
 723   /// DirtyBlocks - This is the set of blocks that need to be recomputed.  In
 724   /// the cached case, this can happen due to instructions being deleted etc. In
 725   /// the uncached case, this starts out as the set of predecessors we care
 726   /// about.
 727   SmallVector<BasicBlock*, 32> DirtyBlocks;
 728
 729   if (!Cache.empty()) {
 730     // Okay, we have a cache entry.  If we know it is not dirty, just return it
 731     // with no computation.
 732     if (!CacheP.second) {
 733       ++NumCacheNonLocal;
 734       return Cache;
 735     }
 736
 737     // If we already have a partially computed set of results, scan them to
 738     // determine what is dirty, seeding our initial DirtyBlocks worklist.
 739     for (NonLocalDepInfo::iterator I = Cache.begin(), E = Cache.end();
 740        I != E; ++I)
 741       if (I->getResult().isDirty())
 742         DirtyBlocks.push_back(I->getBB());
 743
 744     // Sort the cache so that we can do fast binary search lookups below.
 745     std::sort(Cache.begin(), Cache.end());
 746
 747     ++NumCacheDirtyNonLocal;
 748     //cerr << "CACHED CASE: " << DirtyBlocks.size() << " dirty: "
 749     //     << Cache.size() << " cached: " << *QueryInst;
 750   } else {
 751     // Seed DirtyBlocks with each of the preds of QueryInst's block.
 752     BasicBlock *QueryBB = QueryCS.getInstruction()->getParent();
 753     for (BasicBlock **PI = PredCache->GetPreds(QueryBB); *PI; ++PI)
 754       DirtyBlocks.push_back(*PI);
 755     ++NumUncacheNonLocal;
 756   }
 757
 758   // isReadonlyCall - If this is a read-only call, we can be more aggressive.
 759   bool isReadonlyCall = AA->onlyReadsMemory(QueryCS);
 760
 761   SmallPtrSet<BasicBlock*, 64> Visited;
 762
 763   unsigned NumSortedEntries = Cache.size();
 764   DEBUG(AssertSorted(Cache));
 765
 766   // Iterate while we still have blocks to update.
 767   while (!DirtyBlocks.empty()) {
 768     BasicBlock *DirtyBB = DirtyBlocks.back();
 769     DirtyBlocks.pop_back();
 770
 771     // Already processed this block?
 772     if (!Visited.insert(DirtyBB))
 773       continue;
 774
 775     // Do a binary search to see if we already have an entry for this block in
 776     // the cache set.  If so, find it.
 777     DEBUG(AssertSorted(Cache, NumSortedEntries));
 778     NonLocalDepInfo::iterator Entry =
 779       std::upper_bound(Cache.begin(), Cache.begin()+NumSortedEntries,
 780                        NonLocalDepEntry(DirtyBB));
 781     if (Entry != Cache.begin() && std::prev(Entry)->getBB() == DirtyBB)
 782       --Entry;
 783
 784     NonLocalDepEntry *ExistingResult = nullptr;
 785     if (Entry != Cache.begin()+NumSortedEntries &&
 786         Entry->getBB() == DirtyBB) {
 787       // If we already have an entry, and if it isn't already dirty, the block
 788       // is done.
 789       if (!Entry->getResult().isDirty())
 790         continue;
 791
 792       // Otherwise, remember this slot so we can update the value.
 793       ExistingResult = &*Entry;
 794     }
 795
 796     // If the dirty entry has a pointer, start scanning from it so we don't have
 797     // to rescan the entire block.
 798     BasicBlock::iterator ScanPos = DirtyBB->end();
 799     if (ExistingResult) {
 800       if (Instruction *Inst = ExistingResult->getResult().getInst()) {
 801         ScanPos = Inst;
 802         // We're removing QueryInst's use of Inst.
 803         RemoveFromReverseMap(ReverseNonLocalDeps, Inst,
 804                              QueryCS.getInstruction());
 805       }
 806     }
 807
 808     // Find out if this block has a local dependency for QueryInst.
 809     MemDepResult Dep;
 810
 811     if (ScanPos != DirtyBB->begin()) {
 812       Dep = getCallSiteDependencyFrom(QueryCS, isReadonlyCall,ScanPos, DirtyBB);
 813     } else if (DirtyBB != &DirtyBB->getParent()->getEntryBlock()) {
 814       // No dependence found.  If this is the entry block of the function, it is
 815       // a clobber, otherwise it is unknown.
 816       Dep = MemDepResult::getNonLocal();
 817     } else {
 818       Dep = MemDepResult::getNonFuncLocal();
 819     }
 820
 821     // If we had a dirty entry for the block, update it.  Otherwise, just add
 822     // a new entry.
 823     if (ExistingResult)
 824       ExistingResult->setResult(Dep);
 825     else
 826       Cache.push_back(NonLocalDepEntry(DirtyBB, Dep));
 827
 828     // If the block has a dependency (i.e. it isn't completely transparent to
 829     // the value), remember the association!
 830     if (!Dep.isNonLocal()) {
 831       // Keep the ReverseNonLocalDeps map up to date so we can efficiently
 832       // update this when we remove instructions.
 833       if (Instruction *Inst = Dep.getInst())
 834         ReverseNonLocalDeps[Inst].insert(QueryCS.getInstruction());
 835     } else {
 836
 837       // If the block *is* completely transparent to the load, we need to check
 838       // the predecessors of this block.  Add them to our worklist.
 839       for (BasicBlock **PI = PredCache->GetPreds(DirtyBB); *PI; ++PI)
 840         DirtyBlocks.push_back(*PI);
 841     }
 842   }
 843
 844   return Cache;
 845 }
 846
 847 /// getNonLocalPointerDependency - Perform a full dependency query for an
 848 /// access to the specified (non-volatile) memory location, returning the
 849 /// set of instructions that either define or clobber the value.
 850 ///
 851 /// This method assumes the pointer has a "NonLocal" dependency within its
 852 /// own block.
 853 ///
 854 void MemoryDependenceAnalysis::
 855 getNonLocalPointerDependency(const AliasAnalysis::Location &Loc, bool isLoad,
 856                              BasicBlock *FromBB,
 857                              SmallVectorImpl<NonLocalDepResult> &Result) {
 858   assert(Loc.Ptr->getType()->isPointerTy() &&
 859          "Can't get pointer deps of a non-pointer!");
 860   Result.clear();
 861
 862   PHITransAddr Address(const_cast<Value *>(Loc.Ptr), DL);
 863
 864   // This is the set of blocks we've inspected, and the pointer we consider in
 865   // each block.  Because of critical edges, we currently bail out if querying
 866   // a block with multiple different pointers.  This can happen during PHI
 867   // translation.
 868   DenseMap<BasicBlock*, Value*> Visited;
 869   if (!getNonLocalPointerDepFromBB(Address, Loc, isLoad, FromBB,
 870                                    Result, Visited, true))
 871     return;
 872   Result.clear();
 873   Result.push_back(NonLocalDepResult(FromBB,
 874                                      MemDepResult::getUnknown(),
 875                                      const_cast<Value *>(Loc.Ptr)));
 876 }
 877
 878 /// GetNonLocalInfoForBlock - Compute the memdep value for BB with
 879 /// Pointer/PointeeSize using either cached information in Cache or by doing a
 880 /// lookup (which may use dirty cache info if available).  If we do a lookup,
 881 /// add the result to the cache.
 882 MemDepResult MemoryDependenceAnalysis::
 883 GetNonLocalInfoForBlock(const AliasAnalysis::Location &Loc,
 884                         bool isLoad, BasicBlock *BB,
 885                         NonLocalDepInfo *Cache, unsigned NumSortedEntries) {
 886
 887   // Do a binary search to see if we already have an entry for this block in
 888   // the cache set.  If so, find it.
 889   NonLocalDepInfo::iterator Entry =
 890     std::upper_bound(Cache->begin(), Cache->begin()+NumSortedEntries,
 891                      NonLocalDepEntry(BB));
 892   if (Entry != Cache->begin() && (Entry-1)->getBB() == BB)
 893     --Entry;
 894
 895   NonLocalDepEntry *ExistingResult = nullptr;
 896   if (Entry != Cache->begin()+NumSortedEntries && Entry->getBB() == BB)
 897     ExistingResult = &*Entry;
 898
 899   // If we have a cached entry, and it is non-dirty, use it as the value for
 900   // this dependency.
 901   if (ExistingResult && !ExistingResult->getResult().isDirty()) {
 902     ++NumCacheNonLocalPtr;
 903     return ExistingResult->getResult();
 904   }
 905
 906   // Otherwise, we have to scan for the value.  If we have a dirty cache
 907   // entry, start scanning from its position, otherwise we scan from the end
 908   // of the block.
 909   BasicBlock::iterator ScanPos = BB->end();
 910   if (ExistingResult && ExistingResult->getResult().getInst()) {
 911     assert(ExistingResult->getResult().getInst()->getParent() == BB &&
 912            "Instruction invalidated?");
 913     ++NumCacheDirtyNonLocalPtr;
 914     ScanPos = ExistingResult->getResult().getInst();
 915
 916     // Eliminating the dirty entry from 'Cache', so update the reverse info.
 917     ValueIsLoadPair CacheKey(Loc.Ptr, isLoad);
 918     RemoveFromReverseMap(ReverseNonLocalPtrDeps, ScanPos, CacheKey);
 919   } else {
 920     ++NumUncacheNonLocalPtr;
 921   }
 922
 923   // Scan the block for the dependency.
 924   MemDepResult Dep = getPointerDependencyFrom(Loc, isLoad, ScanPos, BB);
 925
 926   // If we had a dirty entry for the block, update it.  Otherwise, just add
 927   // a new entry.
 928   if (ExistingResult)
 929     ExistingResult->setResult(Dep);
 930   else
 931     Cache->push_back(NonLocalDepEntry(BB, Dep));
 932
 933   // If the block has a dependency (i.e. it isn't completely transparent to
 934   // the value), remember the reverse association because we just added it
 935   // to Cache!
 936   if (!Dep.isDef() && !Dep.isClobber())
 937     return Dep;
 938
 939   // Keep the ReverseNonLocalPtrDeps map up to date so we can efficiently
 940   // update MemDep when we remove instructions.
 941   Instruction *Inst = Dep.getInst();
 942   assert(Inst && "Didn't depend on anything?");
 943   ValueIsLoadPair CacheKey(Loc.Ptr, isLoad);
 944   ReverseNonLocalPtrDeps[Inst].insert(CacheKey);
 945   return Dep;
 946 }
 947
 948 /// SortNonLocalDepInfoCache - Sort the NonLocalDepInfo cache, given a certain
 949 /// number of elements in the array that are already properly ordered.  This is
 950 /// optimized for the case when only a few entries are added.
 951 static void
 952 SortNonLocalDepInfoCache(MemoryDependenceAnalysis::NonLocalDepInfo &Cache,
 953                          unsigned NumSortedEntries) {
 954   switch (Cache.size() - NumSortedEntries) {
 955   case 0:
 956     // done, no new entries.
 957     break;
 958   case 2: {
 959     // Two new entries, insert the last one into place.
 960     NonLocalDepEntry Val = Cache.back();
 961     Cache.pop_back();
 962     MemoryDependenceAnalysis::NonLocalDepInfo::iterator Entry =
 963       std::upper_bound(Cache.begin(), Cache.end()-1, Val);
 964     Cache.insert(Entry, Val);
 965     // FALL THROUGH.
 966   }
 967   case 1:
 968     // One new entry, Just insert the new value at the appropriate position.
 969     if (Cache.size() != 1) {
 970       NonLocalDepEntry Val = Cache.back();
 971       Cache.pop_back();
 972       MemoryDependenceAnalysis::NonLocalDepInfo::iterator Entry =
 973         std::upper_bound(Cache.begin(), Cache.end(), Val);
 974       Cache.insert(Entry, Val);
 975     }
 976     break;
 977   default:
 978     // Added many values, do a full scale sort.
 979     std::sort(Cache.begin(), Cache.end());
 980     break;
 981   }
 982 }
 983
 984 /// getNonLocalPointerDepFromBB - Perform a dependency query based on
 985 /// pointer/pointeesize starting at the end of StartBB.  Add any clobber/def
 986 /// results to the results vector and keep track of which blocks are visited in
 987 /// 'Visited'.
 988 ///
 989 /// This has special behavior for the first block queries (when SkipFirstBlock
 990 /// is true).  In this special case, it ignores the contents of the specified
 991 /// block and starts returning dependence info for its predecessors.
 992 ///
 993 /// This function returns false on success, or true to indicate that it could
 994 /// not compute dependence information for some reason.  This should be treated
 995 /// as a clobber dependence on the first instruction in the predecessor block.
 996 bool MemoryDependenceAnalysis::
 997 getNonLocalPointerDepFromBB(const PHITransAddr &Pointer,
 998                             const AliasAnalysis::Location &Loc,
 999                             bool isLoad, BasicBlock *StartBB,
1000                             SmallVectorImpl<NonLocalDepResult> &Result,
1001                             DenseMap<BasicBlock*, Value*> &Visited,
1002                             bool SkipFirstBlock) {
1003   // Look up the cached info for Pointer.
1004   ValueIsLoadPair CacheKey(Pointer.getAddr(), isLoad);
1005
1006   // Set up a temporary NLPI value. If the map doesn't yet have an entry for
1007   // CacheKey, this value will be inserted as the associated value. Otherwise,
1008   // it'll be ignored, and we'll have to check to see if the cached size and
1009   // aa tags are consistent with the current query.
1010   NonLocalPointerInfo InitialNLPI;
1011   InitialNLPI.Size = Loc.Size;
1012   InitialNLPI.AATags = Loc.AATags;
1013
1014   // Get the NLPI for CacheKey, inserting one into the map if it doesn't
1015   // already have one.
1016   std::pair<CachedNonLocalPointerInfo::iterator, bool> Pair =
1017     NonLocalPointerDeps.insert(std::make_pair(CacheKey, InitialNLPI));
1018   NonLocalPointerInfo *CacheInfo = &Pair.first->second;
1019
1020   // If we already have a cache entry for this CacheKey, we may need to do some
1021   // work to reconcile the cache entry and the current query.
1022   if (!Pair.second) {
1023     if (CacheInfo->Size < Loc.Size) {
1024       // The query's Size is greater than the cached one. Throw out the
1025       // cached data and proceed with the query at the greater size.
1026       CacheInfo->Pair = BBSkipFirstBlockPair();
1027       CacheInfo->Size = Loc.Size;
1028       for (NonLocalDepInfo::iterator DI = CacheInfo->NonLocalDeps.begin(),
1029            DE = CacheInfo->NonLocalDeps.end(); DI != DE; ++DI)
1030         if (Instruction *Inst = DI->getResult().getInst())
1031           RemoveFromReverseMap(ReverseNonLocalPtrDeps, Inst, CacheKey);
1032       CacheInfo->NonLocalDeps.clear();
1033     } else if (CacheInfo->Size > Loc.Size) {
1034       // This query's Size is less than the cached one. Conservatively restart
1035       // the query using the greater size.
1036       return getNonLocalPointerDepFromBB(Pointer,
1037                                          Loc.getWithNewSize(CacheInfo->Size),
1038                                          isLoad, StartBB, Result, Visited,
1039                                          SkipFirstBlock);
1040     }
1041
1042     // If the query's AATags are inconsistent with the cached one,
1043     // conservatively throw out the cached data and restart the query with
1044     // no tag if needed.
1045     if (CacheInfo->AATags != Loc.AATags) {
1046       if (CacheInfo->AATags) {
1047         CacheInfo->Pair = BBSkipFirstBlockPair();
1048         CacheInfo->AATags = AAMDNodes();
1049         for (NonLocalDepInfo::iterator DI = CacheInfo->NonLocalDeps.begin(),
1050              DE = CacheInfo->NonLocalDeps.end(); DI != DE; ++DI)
1051           if (Instruction *Inst = DI->getResult().getInst())
1052             RemoveFromReverseMap(ReverseNonLocalPtrDeps, Inst, CacheKey);
1053         CacheInfo->NonLocalDeps.clear();
1054       }
1055       if (Loc.AATags)
1056         return getNonLocalPointerDepFromBB(Pointer, Loc.getWithoutAATags(),
1057                                            isLoad, StartBB, Result, Visited,
1058                                            SkipFirstBlock);
1059     }
1060   }
1061
1062   NonLocalDepInfo *Cache = &CacheInfo->NonLocalDeps;
1063
1064   // If we have valid cached information for exactly the block we are
1065   // investigating, just return it with no recomputation.
1066   if (CacheInfo->Pair == BBSkipFirstBlockPair(StartBB, SkipFirstBlock)) {
1067     // We have a fully cached result for this query then we can just return the
1068     // cached results and populate the visited set.  However, we have to verify
1069     // that we don't already have conflicting results for these blocks.  Check
1070     // to ensure that if a block in the results set is in the visited set that
1071     // it was for the same pointer query.
1072     if (!Visited.empty()) {
1073       for (NonLocalDepInfo::iterator I = Cache->begin(), E = Cache->end();
1074            I != E; ++I) {
1075         DenseMap<BasicBlock*, Value*>::iterator VI = Visited.find(I->getBB());
1076         if (VI == Visited.end() || VI->second == Pointer.getAddr())
1077           continue;
1078
1079         // We have a pointer mismatch in a block.  Just return clobber, saying
1080         // that something was clobbered in this result.  We could also do a
1081         // non-fully cached query, but there is little point in doing this.
1082         return true;
1083       }
1084     }
1085
1086     Value *Addr = Pointer.getAddr();
1087     for (NonLocalDepInfo::iterator I = Cache->begin(), E = Cache->end();
1088          I != E; ++I) {
1089       Visited.insert(std::make_pair(I->getBB(), Addr));
1090       if (I->getResult().isNonLocal()) {
1091         continue;
1092       }
1093
1094       if (!DT) {
1095         Result.push_back(NonLocalDepResult(I->getBB(),
1096                                            MemDepResult::getUnknown(),
1097                                            Addr));
1098       } else if (DT->isReachableFromEntry(I->getBB())) {
1099         Result.push_back(NonLocalDepResult(I->getBB(), I->getResult(), Addr));
1100       }
1101     }
1102     ++NumCacheCompleteNonLocalPtr;
1103     return false;
1104   }
1105
1106   // Otherwise, either this is a new block, a block with an invalid cache
1107   // pointer or one that we're about to invalidate by putting more info into it
1108   // than its valid cache info.  If empty, the result will be valid cache info,
1109   // otherwise it isn't.
1110   if (Cache->empty())
1111     CacheInfo->Pair = BBSkipFirstBlockPair(StartBB, SkipFirstBlock);
1112   else
1113     CacheInfo->Pair = BBSkipFirstBlockPair();
1114
1115   SmallVector<BasicBlock*, 32> Worklist;
1116   Worklist.push_back(StartBB);
1117
1118   // PredList used inside loop.
1119   SmallVector<std::pair<BasicBlock*, PHITransAddr>, 16> PredList;
1120
1121   // Keep track of the entries that we know are sorted.  Previously cached
1122   // entries will all be sorted.  The entries we add we only sort on demand (we
1123   // don't insert every element into its sorted position).  We know that we
1124   // won't get any reuse from currently inserted values, because we don't
1125   // revisit blocks after we insert info for them.
1126   unsigned NumSortedEntries = Cache->size();
1127   DEBUG(AssertSorted(*Cache));
1128
1129   while (!Worklist.empty()) {
1130     BasicBlock *BB = Worklist.pop_back_val();
1131
1132     // Skip the first block if we have it.
1133     if (!SkipFirstBlock) {
1134       // Analyze the dependency of *Pointer in FromBB.  See if we already have
1135       // been here.
1136       assert(Visited.count(BB) && "Should check 'visited' before adding to WL");
1137
1138       // Get the dependency info for Pointer in BB.  If we have cached
1139       // information, we will use it, otherwise we compute it.
1140       DEBUG(AssertSorted(*Cache, NumSortedEntries));
1141       MemDepResult Dep = GetNonLocalInfoForBlock(Loc, isLoad, BB, Cache,
1142                                                  NumSortedEntries);
1143
1144       // If we got a Def or Clobber, add this to the list of results.
1145       if (!Dep.isNonLocal()) {
1146         if (!DT) {
1147           Result.push_back(NonLocalDepResult(BB,
1148                                              MemDepResult::getUnknown(),
1149                                              Pointer.getAddr()));
1150           continue;
1151         } else if (DT->isReachableFromEntry(BB)) {
1152           Result.push_back(NonLocalDepResult(BB, Dep, Pointer.getAddr()));
1153           continue;
1154         }
1155       }
1156     }
1157
1158     // If 'Pointer' is an instruction defined in this block, then we need to do
1159     // phi translation to change it into a value live in the predecessor block.
1160     // If not, we just add the predecessors to the worklist and scan them with
1161     // the same Pointer.
1162     if (!Pointer.NeedsPHITranslationFromBlock(BB)) {
1163       SkipFirstBlock = false;
1164       SmallVector<BasicBlock*, 16> NewBlocks;
1165       for (BasicBlock **PI = PredCache->GetPreds(BB); *PI; ++PI) {
1166         // Verify that we haven't looked at this block yet.
1167         std::pair<DenseMap<BasicBlock*,Value*>::iterator, bool>
1168           InsertRes = Visited.insert(std::make_pair(*PI, Pointer.getAddr()));
1169         if (InsertRes.second) {
1170           // First time we've looked at *PI.
1171           NewBlocks.push_back(*PI);
1172           continue;
1173         }
1174
1175         // If we have seen this block before, but it was with a different
1176         // pointer then we have a phi translation failure and we have to treat
1177         // this as a clobber.
1178         if (InsertRes.first->second != Pointer.getAddr()) {
1179           // Make sure to clean up the Visited map before continuing on to
1180           // PredTranslationFailure.
1181           for (unsigned i = 0; i < NewBlocks.size(); i++)
1182             Visited.erase(NewBlocks[i]);
1183           goto PredTranslationFailure;
1184         }
1185       }
1186       Worklist.append(NewBlocks.begin(), NewBlocks.end());
1187       continue;
1188     }
1189
1190     // We do need to do phi translation, if we know ahead of time we can't phi
1191     // translate this value, don't even try.
1192     if (!Pointer.IsPotentiallyPHITranslatable())
1193       goto PredTranslationFailure;
1194
1195     // We may have added values to the cache list before this PHI translation.
1196     // If so, we haven't done anything to ensure that the cache remains sorted.
1197     // Sort it now (if needed) so that recursive invocations of
1198     // getNonLocalPointerDepFromBB and other routines that could reuse the cache
1199     // value will only see properly sorted cache arrays.
1200     if (Cache && NumSortedEntries != Cache->size()) {
1201       SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
1202       NumSortedEntries = Cache->size();
1203     }
1204     Cache = nullptr;
1205
1206     PredList.clear();
1207     for (BasicBlock **PI = PredCache->GetPreds(BB); *PI; ++PI) {
1208       BasicBlock *Pred = *PI;
1209       PredList.push_back(std::make_pair(Pred, Pointer));
1210
1211       // Get the PHI translated pointer in this predecessor.  This can fail if
1212       // not translatable, in which case the getAddr() returns null.
1213       PHITransAddr &PredPointer = PredList.back().second;
1214       PredPointer.PHITranslateValue(BB, Pred, nullptr);
1215
1216       Value *PredPtrVal = PredPointer.getAddr();
1217
1218       // Check to see if we have already visited this pred block with another
1219       // pointer.  If so, we can't do this lookup.  This failure can occur
1220       // with PHI translation when a critical edge exists and the PHI node in
1221       // the successor translates to a pointer value different than the
1222       // pointer the block was first analyzed with.
1223       std::pair<DenseMap<BasicBlock*,Value*>::iterator, bool>
1224         InsertRes = Visited.insert(std::make_pair(Pred, PredPtrVal));
1225
1226       if (!InsertRes.second) {
1227         // We found the pred; take it off the list of preds to visit.
1228         PredList.pop_back();
1229
1230         // If the predecessor was visited with PredPtr, then we already did
1231         // the analysis and can ignore it.
1232         if (InsertRes.first->second == PredPtrVal)
1233           continue;
1234
1235         // Otherwise, the block was previously analyzed with a different
1236         // pointer.  We can't represent the result of this case, so we just
1237         // treat this as a phi translation failure.
1238
1239         // Make sure to clean up the Visited map before continuing on to
1240         // PredTranslationFailure.
1241         for (unsigned i = 0, n = PredList.size(); i < n; ++i)
1242           Visited.erase(PredList[i].first);
1243
1244         goto PredTranslationFailure;
1245       }
1246     }
1247
1248     // Actually process results here; this need to be a separate loop to avoid
1249     // calling getNonLocalPointerDepFromBB for blocks we don't want to return
1250     // any results for.  (getNonLocalPointerDepFromBB will modify our
1251     // datastructures in ways the code after the PredTranslationFailure label
1252     // doesn't expect.)
1253     for (unsigned i = 0, n = PredList.size(); i < n; ++i) {
1254       BasicBlock *Pred = PredList[i].first;
1255       PHITransAddr &PredPointer = PredList[i].second;
1256       Value *PredPtrVal = PredPointer.getAddr();
1257
1258       bool CanTranslate = true;
1259       // If PHI translation was unable to find an available pointer in this
1260       // predecessor, then we have to assume that the pointer is clobbered in
1261       // that predecessor.  We can still do PRE of the load, which would insert
1262       // a computation of the pointer in this predecessor.
1263       if (!PredPtrVal)
1264         CanTranslate = false;
1265
1266       // FIXME: it is entirely possible that PHI translating will end up with
1267       // the same value.  Consider PHI translating something like:
1268       // X = phi [x, bb1], [y, bb2].  PHI translating for bb1 doesn't *need*
1269       // to recurse here, pedantically speaking.
1270
1271       // If getNonLocalPointerDepFromBB fails here, that means the cached
1272       // result conflicted with the Visited list; we have to conservatively
1273       // assume it is unknown, but this also does not block PRE of the load.
1274       if (!CanTranslate ||
1275           getNonLocalPointerDepFromBB(PredPointer,
1276                                       Loc.getWithNewPtr(PredPtrVal),
1277                                       isLoad, Pred,
1278                                       Result, Visited)) {
1279         // Add the entry to the Result list.
1280         NonLocalDepResult Entry(Pred, MemDepResult::getUnknown(), PredPtrVal);
1281         Result.push_back(Entry);
1282
1283         // Since we had a phi translation failure, the cache for CacheKey won't
1284         // include all of the entries that we need to immediately satisfy future
1285         // queries.  Mark this in NonLocalPointerDeps by setting the
1286         // BBSkipFirstBlockPair pointer to null.  This requires reuse of the
1287         // cached value to do more work but not miss the phi trans failure.
1288         NonLocalPointerInfo &NLPI = NonLocalPointerDeps[CacheKey];
1289         NLPI.Pair = BBSkipFirstBlockPair();
1290         continue;
1291       }
1292     }
1293
1294     // Refresh the CacheInfo/Cache pointer so that it isn't invalidated.
1295     CacheInfo = &NonLocalPointerDeps[CacheKey];
1296     Cache = &CacheInfo->NonLocalDeps;
1297     NumSortedEntries = Cache->size();
1298
1299     // Since we did phi translation, the "Cache" set won't contain all of the
1300     // results for the query.  This is ok (we can still use it to accelerate
1301     // specific block queries) but we can't do the fastpath "return all
1302     // results from the set"  Clear out the indicator for this.
1303     CacheInfo->Pair = BBSkipFirstBlockPair();
1304     SkipFirstBlock = false;
1305     continue;
1306
1307   PredTranslationFailure:
1308     // The following code is "failure"; we can't produce a sane translation
1309     // for the given block.  It assumes that we haven't modified any of
1310     // our datastructures while processing the current block.
1311
1312     if (!Cache) {
1313       // Refresh the CacheInfo/Cache pointer if it got invalidated.
1314       CacheInfo = &NonLocalPointerDeps[CacheKey];
1315       Cache = &CacheInfo->NonLocalDeps;
1316       NumSortedEntries = Cache->size();
1317     }
1318
1319     // Since we failed phi translation, the "Cache" set won't contain all of the
1320     // results for the query.  This is ok (we can still use it to accelerate
1321     // specific block queries) but we can't do the fastpath "return all
1322     // results from the set".  Clear out the indicator for this.
1323     CacheInfo->Pair = BBSkipFirstBlockPair();
1324
1325     // If *nothing* works, mark the pointer as unknown.
1326     //
1327     // If this is the magic first block, return this as a clobber of the whole
1328     // incoming value.  Since we can't phi translate to one of the predecessors,
1329     // we have to bail out.
1330     if (SkipFirstBlock)
1331       return true;
1332
1333     for (NonLocalDepInfo::reverse_iterator I = Cache->rbegin(); ; ++I) {
1334       assert(I != Cache->rend() && "Didn't find current block??");
1335       if (I->getBB() != BB)
1336         continue;
1337
1338       assert(I->getResult().isNonLocal() &&
1339              "Should only be here with transparent block");
1340       I->setResult(MemDepResult::getUnknown());
1341       Result.push_back(NonLocalDepResult(I->getBB(), I->getResult(),
1342                                          Pointer.getAddr()));
1343       break;
1344     }
1345   }
1346
1347   // Okay, we're done now.  If we added new values to the cache, re-sort it.
1348   SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
1349   DEBUG(AssertSorted(*Cache));
1350   return false;
1351 }
1352
1353 /// RemoveCachedNonLocalPointerDependencies - If P exists in
1354 /// CachedNonLocalPointerInfo, remove it.
1355 void MemoryDependenceAnalysis::
1356 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair P) {
1357   CachedNonLocalPointerInfo::iterator It =
1358     NonLocalPointerDeps.find(P);
1359   if (It == NonLocalPointerDeps.end()) return;
1360
1361   // Remove all of the entries in the BB->val map.  This involves removing
1362   // instructions from the reverse map.
1363   NonLocalDepInfo &PInfo = It->second.NonLocalDeps;
1364
1365   for (unsigned i = 0, e = PInfo.size(); i != e; ++i) {
1366     Instruction *Target = PInfo[i].getResult().getInst();
1367     if (!Target) continue;  // Ignore non-local dep results.
1368     assert(Target->getParent() == PInfo[i].getBB());
1369
1370     // Eliminating the dirty entry from 'Cache', so update the reverse info.
1371     RemoveFromReverseMap(ReverseNonLocalPtrDeps, Target, P);
1372   }
1373
1374   // Remove P from NonLocalPointerDeps (which deletes NonLocalDepInfo).
1375   NonLocalPointerDeps.erase(It);
1376 }
1377
1378
1379 /// invalidateCachedPointerInfo - This method is used to invalidate cached
1380 /// information about the specified pointer, because it may be too
1381 /// conservative in memdep.  This is an optional call that can be used when
1382 /// the client detects an equivalence between the pointer and some other
1383 /// value and replaces the other value with ptr. This can make Ptr available
1384 /// in more places that cached info does not necessarily keep.
1385 void MemoryDependenceAnalysis::invalidateCachedPointerInfo(Value *Ptr) {
1386   // If Ptr isn't really a pointer, just ignore it.
1387   if (!Ptr->getType()->isPointerTy()) return;
1388   // Flush store info for the pointer.
1389   RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, false));
1390   // Flush load info for the pointer.
1391   RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, true));
1392 }
1393
1394 /// invalidateCachedPredecessors - Clear the PredIteratorCache info.
1395 /// This needs to be done when the CFG changes, e.g., due to splitting
1396 /// critical edges.
1397 void MemoryDependenceAnalysis::invalidateCachedPredecessors() {
1398   PredCache->clear();
1399 }
1400
1401 /// removeInstruction - Remove an instruction from the dependence analysis,
1402 /// updating the dependence of instructions that previously depended on it.
1403 /// This method attempts to keep the cache coherent using the reverse map.
1404 void MemoryDependenceAnalysis::removeInstruction(Instruction *RemInst) {
1405   // Walk through the Non-local dependencies, removing this one as the value
1406   // for any cached queries.
1407   NonLocalDepMapType::iterator NLDI = NonLocalDeps.find(RemInst);
1408   if (NLDI != NonLocalDeps.end()) {
1409     NonLocalDepInfo &BlockMap = NLDI->second.first;
1410     for (NonLocalDepInfo::iterator DI = BlockMap.begin(), DE = BlockMap.end();
1411          DI != DE; ++DI)
1412       if (Instruction *Inst = DI->getResult().getInst())
1413         RemoveFromReverseMap(ReverseNonLocalDeps, Inst, RemInst);
1414     NonLocalDeps.erase(NLDI);
1415   }
1416
1417   // If we have a cached local dependence query for this instruction, remove it.
1418   //
1419   LocalDepMapType::iterator LocalDepEntry = LocalDeps.find(RemInst);
1420   if (LocalDepEntry != LocalDeps.end()) {
1421     // Remove us from DepInst's reverse set now that the local dep info is gone.
1422     if (Instruction *Inst = LocalDepEntry->second.getInst())
1423       RemoveFromReverseMap(ReverseLocalDeps, Inst, RemInst);
1424
1425     // Remove this local dependency info.
1426     LocalDeps.erase(LocalDepEntry);
1427   }
1428
1429   // If we have any cached pointer dependencies on this instruction, remove
1430   // them.  If the instruction has non-pointer type, then it can't be a pointer
1431   // base.
1432
1433   // Remove it from both the load info and the store info.  The instruction
1434   // can't be in either of these maps if it is non-pointer.
1435   if (RemInst->getType()->isPointerTy()) {
1436     RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, false));
1437     RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, true));
1438   }
1439
1440   // Loop over all of the things that depend on the instruction we're removing.
1441   //
1442   SmallVector<std::pair<Instruction*, Instruction*>, 8> ReverseDepsToAdd;
1443
1444   // If we find RemInst as a clobber or Def in any of the maps for other values,
1445   // we need to replace its entry with a dirty version of the instruction after
1446   // it.  If RemInst is a terminator, we use a null dirty value.
1447   //
1448   // Using a dirty version of the instruction after RemInst saves having to scan
1449   // the entire block to get to this point.
1450   MemDepResult NewDirtyVal;
1451   if (!RemInst->isTerminator())
1452     NewDirtyVal = MemDepResult::getDirty(++BasicBlock::iterator(RemInst));
1453
1454   ReverseDepMapType::iterator ReverseDepIt = ReverseLocalDeps.find(RemInst);
1455   if (ReverseDepIt != ReverseLocalDeps.end()) {
1456     // RemInst can't be the terminator if it has local stuff depending on it.
1457     assert(!ReverseDepIt->second.empty() && !isa<TerminatorInst>(RemInst) &&
1458            "Nothing can locally depend on a terminator");
1459
1460     for (Instruction *InstDependingOnRemInst : ReverseDepIt->second) {
1461       assert(InstDependingOnRemInst != RemInst &&
1462              "Already removed our local dep info");
1463
1464       LocalDeps[InstDependingOnRemInst] = NewDirtyVal;
1465
1466       // Make sure to remember that new things depend on NewDepInst.
1467       assert(NewDirtyVal.getInst() && "There is no way something else can have "
1468              "a local dep on this if it is a terminator!");
1469       ReverseDepsToAdd.push_back(std::make_pair(NewDirtyVal.getInst(),
1470                                                 InstDependingOnRemInst));
1471     }
1472
1473     ReverseLocalDeps.erase(ReverseDepIt);
1474
1475     // Add new reverse deps after scanning the set, to avoid invalidating the
1476     // 'ReverseDeps' reference.
1477     while (!ReverseDepsToAdd.empty()) {
1478       ReverseLocalDeps[ReverseDepsToAdd.back().first]
1479         .insert(ReverseDepsToAdd.back().second);
1480       ReverseDepsToAdd.pop_back();
1481     }
1482   }
1483
1484   ReverseDepIt = ReverseNonLocalDeps.find(RemInst);
1485   if (ReverseDepIt != ReverseNonLocalDeps.end()) {
1486     for (Instruction *I : ReverseDepIt->second) {
1487       assert(I != RemInst && "Already removed NonLocalDep info for RemInst");
1488
1489       PerInstNLInfo &INLD = NonLocalDeps[I];
1490       // The information is now dirty!
1491       INLD.second = true;
1492
1493       for (NonLocalDepInfo::iterator DI = INLD.first.begin(),
1494            DE = INLD.first.end(); DI != DE; ++DI) {
1495         if (DI->getResult().getInst() != RemInst) continue;
1496
1497         // Convert to a dirty entry for the subsequent instruction.
1498         DI->setResult(NewDirtyVal);
1499
1500         if (Instruction *NextI = NewDirtyVal.getInst())
1501           ReverseDepsToAdd.push_back(std::make_pair(NextI, I));
1502       }
1503     }
1504
1505     ReverseNonLocalDeps.erase(ReverseDepIt);
1506
1507     // Add new reverse deps after scanning the set, to avoid invalidating 'Set'
1508     while (!ReverseDepsToAdd.empty()) {
1509       ReverseNonLocalDeps[ReverseDepsToAdd.back().first]
1510         .insert(ReverseDepsToAdd.back().second);
1511       ReverseDepsToAdd.pop_back();
1512     }
1513   }
1514
1515   // If the instruction is in ReverseNonLocalPtrDeps then it appears as a
1516   // value in the NonLocalPointerDeps info.
1517   ReverseNonLocalPtrDepTy::iterator ReversePtrDepIt =
1518     ReverseNonLocalPtrDeps.find(RemInst);
1519   if (ReversePtrDepIt != ReverseNonLocalPtrDeps.end()) {
1520     SmallVector<std::pair<Instruction*, ValueIsLoadPair>,8> ReversePtrDepsToAdd;
1521
1522     for (ValueIsLoadPair P : ReversePtrDepIt->second) {
1523       assert(P.getPointer() != RemInst &&
1524              "Already removed NonLocalPointerDeps info for RemInst");
1525
1526       NonLocalDepInfo &NLPDI = NonLocalPointerDeps[P].NonLocalDeps;
1527
1528       // The cache is not valid for any specific block anymore.
1529       NonLocalPointerDeps[P].Pair = BBSkipFirstBlockPair();
1530
1531       // Update any entries for RemInst to use the instruction after it.
1532       for (NonLocalDepInfo::iterator DI = NLPDI.begin(), DE = NLPDI.end();
1533            DI != DE; ++DI) {
1534         if (DI->getResult().getInst() != RemInst) continue;
1535
1536         // Convert to a dirty entry for the subsequent instruction.
1537         DI->setResult(NewDirtyVal);
1538
1539         if (Instruction *NewDirtyInst = NewDirtyVal.getInst())
1540           ReversePtrDepsToAdd.push_back(std::make_pair(NewDirtyInst, P));
1541       }
1542
1543       // Re-sort the NonLocalDepInfo.  Changing the dirty entry to its
1544       // subsequent value may invalidate the sortedness.
1545       std::sort(NLPDI.begin(), NLPDI.end());
1546     }
1547
1548     ReverseNonLocalPtrDeps.erase(ReversePtrDepIt);
1549
1550     while (!ReversePtrDepsToAdd.empty()) {
1551       ReverseNonLocalPtrDeps[ReversePtrDepsToAdd.back().first]
1552         .insert(ReversePtrDepsToAdd.back().second);
1553       ReversePtrDepsToAdd.pop_back();
1554     }
1555   }
1556
1557
1558   assert(!NonLocalDeps.count(RemInst) && "RemInst got reinserted?");
1559   AA->deleteValue(RemInst);
1560   DEBUG(verifyRemoved(RemInst));
1561 }
1562 /// verifyRemoved - Verify that the specified instruction does not occur
1563 /// in our internal data structures. This function verifies by asserting in
1564 /// debug builds.
1565 void MemoryDependenceAnalysis::verifyRemoved(Instruction *D) const {
1566 #ifndef NDEBUG
1567   for (LocalDepMapType::const_iterator I = LocalDeps.begin(),
1568        E = LocalDeps.end(); I != E; ++I) {
1569     assert(I->first != D && "Inst occurs in data structures");
1570     assert(I->second.getInst() != D &&
1571            "Inst occurs in data structures");
1572   }
1573
1574   for (CachedNonLocalPointerInfo::const_iterator I =NonLocalPointerDeps.begin(),
1575        E = NonLocalPointerDeps.end(); I != E; ++I) {
1576     assert(I->first.getPointer() != D && "Inst occurs in NLPD map key");
1577     const NonLocalDepInfo &Val = I->second.NonLocalDeps;
1578     for (NonLocalDepInfo::const_iterator II = Val.begin(), E = Val.end();
1579          II != E; ++II)
1580       assert(II->getResult().getInst() != D && "Inst occurs as NLPD value");
1581   }
1582
1583   for (NonLocalDepMapType::const_iterator I = NonLocalDeps.begin(),
1584        E = NonLocalDeps.end(); I != E; ++I) {
1585     assert(I->first != D && "Inst occurs in data structures");
1586     const PerInstNLInfo &INLD = I->second;
1587     for (NonLocalDepInfo::const_iterator II = INLD.first.begin(),
1588          EE = INLD.first.end(); II  != EE; ++II)
1589       assert(II->getResult().getInst() != D && "Inst occurs in data structures");
1590   }
1591
1592   for (ReverseDepMapType::const_iterator I = ReverseLocalDeps.begin(),
1593        E = ReverseLocalDeps.end(); I != E; ++I) {
1594     assert(I->first != D && "Inst occurs in data structures");
1595     for (Instruction *Inst : I->second)
1596       assert(Inst != D && "Inst occurs in data structures");
1597   }
1598
1599   for (ReverseDepMapType::const_iterator I = ReverseNonLocalDeps.begin(),
1600        E = ReverseNonLocalDeps.end();
1601        I != E; ++I) {
1602     assert(I->first != D && "Inst occurs in data structures");
1603     for (Instruction *Inst : I->second)
1604       assert(Inst != D && "Inst occurs in data structures");
1605   }
1606
1607   for (ReverseNonLocalPtrDepTy::const_iterator
1608        I = ReverseNonLocalPtrDeps.begin(),
1609        E = ReverseNonLocalPtrDeps.end(); I != E; ++I) {
1610     assert(I->first != D && "Inst occurs in rev NLPD map");
1611
1612     for (ValueIsLoadPair P : I->second)
1613       assert(P != ValueIsLoadPair(D, false) &&
1614              P != ValueIsLoadPair(D, true) &&
1615              "Inst occurs in ReverseNonLocalPtrDeps map");
1616   }
1617 #endif
1618 }