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   if (isLoad && QueryInst) {
 374     LoadInst *LI = dyn_cast<LoadInst>(QueryInst);
 375     if (LI && LI->getMetadata(LLVMContext::MD_invariant_load) != nullptr)
 376       isInvariantLoad = true;
 377   }
 378
 379   // Walk backwards through the basic block, looking for dependencies.
 380   while (ScanIt != BB->begin()) {
 381     Instruction *Inst = --ScanIt;
 382
 383     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst))
 384       // Debug intrinsics don't (and can't) cause dependencies.
 385       if (isa<DbgInfoIntrinsic>(II)) continue;
 386
 387     // Limit the amount of scanning we do so we don't end up with quadratic
 388     // running time on extreme testcases.
 389     --Limit;
 390     if (!Limit)
 391       return MemDepResult::getUnknown();
 392
 393     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
 394       // If we reach a lifetime begin or end marker, then the query ends here
 395       // because the value is undefined.
 396       if (II->getIntrinsicID() == Intrinsic::lifetime_start) {
 397         // FIXME: This only considers queries directly on the invariant-tagged
 398         // pointer, not on query pointers that are indexed off of them.  It'd
 399         // be nice to handle that at some point (the right approach is to use
 400         // GetPointerBaseWithConstantOffset).
 401         if (AA->isMustAlias(AliasAnalysis::Location(II->getArgOperand(1)),
 402                             MemLoc))
 403           return MemDepResult::getDef(II);
 404         continue;
 405       }
 406     }
 407
 408     // Values depend on loads if the pointers are must aliased.  This means that
 409     // a load depends on another must aliased load from the same value.
 410     if (LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
 411       // Atomic loads have complications involved.
 412       // A monotonic load is OK if the query inst is itself not atomic.
 413       // FIXME: This is overly conservative.
 414       if (!LI->isUnordered()) {
 415         if (!QueryInst || LI->getOrdering() != Monotonic)
 416           return MemDepResult::getClobber(LI);
 417         if (auto *QueryLI = dyn_cast<LoadInst>(QueryInst))
 418           if (!QueryLI->isUnordered())
 419             return MemDepResult::getClobber(LI);
 420         if (auto *QuerySI = dyn_cast<StoreInst>(QueryInst))
 421           if (!QuerySI->isUnordered())
 422             return MemDepResult::getClobber(LI);
 423       }
 424
 425       AliasAnalysis::Location LoadLoc = AA->getLocation(LI);
 426
 427       // If we found a pointer, check if it could be the same as our pointer.
 428       AliasAnalysis::AliasResult R = AA->alias(LoadLoc, MemLoc);
 429
 430       if (isLoad) {
 431         if (R == AliasAnalysis::NoAlias) {
 432           // If this is an over-aligned integer load (for example,
 433           // "load i8* %P, align 4") see if it would obviously overlap with the
 434           // queried location if widened to a larger load (e.g. if the queried
 435           // location is 1 byte at P+1).  If so, return it as a load/load
 436           // clobber result, allowing the client to decide to widen the load if
 437           // it wants to.
 438           if (IntegerType *ITy = dyn_cast<IntegerType>(LI->getType()))
 439             if (LI->getAlignment()*8 > ITy->getPrimitiveSizeInBits() &&
 440                 isLoadLoadClobberIfExtendedToFullWidth(MemLoc, MemLocBase,
 441                                                        MemLocOffset, LI, DL))
 442               return MemDepResult::getClobber(Inst);
 443
 444           continue;
 445         }
 446
 447         // Must aliased loads are defs of each other.
 448         if (R == AliasAnalysis::MustAlias)
 449           return MemDepResult::getDef(Inst);
 450
 451 #if 0 // FIXME: Temporarily disabled. GVN is cleverly rewriting loads
 452       // in terms of clobbering loads, but since it does this by looking
 453       // at the clobbering load directly, it doesn't know about any
 454       // phi translation that may have happened along the way.
 455
 456         // If we have a partial alias, then return this as a clobber for the
 457         // client to handle.
 458         if (R == AliasAnalysis::PartialAlias)
 459           return MemDepResult::getClobber(Inst);
 460 #endif
 461
 462         // Random may-alias loads don't depend on each other without a
 463         // dependence.
 464         continue;
 465       }
 466
 467       // Stores don't depend on other no-aliased accesses.
 468       if (R == AliasAnalysis::NoAlias)
 469         continue;
 470
 471       // Stores don't alias loads from read-only memory.
 472       if (AA->pointsToConstantMemory(LoadLoc))
 473         continue;
 474
 475       // Stores depend on may/must aliased loads.
 476       return MemDepResult::getDef(Inst);
 477     }
 478
 479     if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
 480       // Atomic stores have complications involved.
 481       // A monotonic store is OK if the query inst is itself not atomic.
 482       // FIXME: This is overly conservative.
 483       if (!SI->isUnordered()) {
 484         if (!QueryInst || SI->getOrdering() != Monotonic)
 485           return MemDepResult::getClobber(SI);
 486         if (auto *QueryLI = dyn_cast<LoadInst>(QueryInst))
 487           if (!QueryLI->isUnordered())
 488             return MemDepResult::getClobber(SI);
 489         if (auto *QuerySI = dyn_cast<StoreInst>(QueryInst))
 490           if (!QuerySI->isUnordered())
 491             return MemDepResult::getClobber(SI);
 492       }
 493
 494       // If alias analysis can tell that this store is guaranteed to not modify
 495       // the query pointer, ignore it.  Use getModRefInfo to handle cases where
 496       // the query pointer points to constant memory etc.
 497       if (AA->getModRefInfo(SI, MemLoc) == AliasAnalysis::NoModRef)
 498         continue;
 499
 500       // Ok, this store might clobber the query pointer.  Check to see if it is
 501       // a must alias: in this case, we want to return this as a def.
 502       AliasAnalysis::Location StoreLoc = AA->getLocation(SI);
 503
 504       // If we found a pointer, check if it could be the same as our pointer.
 505       AliasAnalysis::AliasResult R = AA->alias(StoreLoc, MemLoc);
 506
 507       if (R == AliasAnalysis::NoAlias)
 508         continue;
 509       if (R == AliasAnalysis::MustAlias)
 510         return MemDepResult::getDef(Inst);
 511       if (isInvariantLoad)
 512        continue;
 513       return MemDepResult::getClobber(Inst);
 514     }
 515
 516     // If this is an allocation, and if we know that the accessed pointer is to
 517     // the allocation, return Def.  This means that there is no dependence and
 518     // the access can be optimized based on that.  For example, a load could
 519     // turn into undef.
 520     // Note: Only determine this to be a malloc if Inst is the malloc call, not
 521     // a subsequent bitcast of the malloc call result.  There can be stores to
 522     // the malloced memory between the malloc call and its bitcast uses, and we
 523     // need to continue scanning until the malloc call.
 524     const TargetLibraryInfo *TLI = AA->getTargetLibraryInfo();
 525     if (isa<AllocaInst>(Inst) || isNoAliasFn(Inst, TLI)) {
 526       const Value *AccessPtr = GetUnderlyingObject(MemLoc.Ptr, DL);
 527
 528       if (AccessPtr == Inst || AA->isMustAlias(Inst, AccessPtr))
 529         return MemDepResult::getDef(Inst);
 530       // Be conservative if the accessed pointer may alias the allocation.
 531       if (AA->alias(Inst, AccessPtr) != AliasAnalysis::NoAlias)
 532         return MemDepResult::getClobber(Inst);
 533       // If the allocation is not aliased and does not read memory (like
 534       // strdup), it is safe to ignore.
 535       if (isa<AllocaInst>(Inst) ||
 536           isMallocLikeFn(Inst, TLI) || isCallocLikeFn(Inst, TLI))
 537         continue;
 538     }
 539
 540     // See if this instruction (e.g. a call or vaarg) mod/ref's the pointer.
 541     AliasAnalysis::ModRefResult MR = AA->getModRefInfo(Inst, MemLoc);
 542     // If necessary, perform additional analysis.
 543     if (MR == AliasAnalysis::ModRef)
 544       MR = AA->callCapturesBefore(Inst, MemLoc, DT);
 545     switch (MR) {
 546     case AliasAnalysis::NoModRef:
 547       // If the call has no effect on the queried pointer, just ignore it.
 548       continue;
 549     case AliasAnalysis::Mod:
 550       return MemDepResult::getClobber(Inst);
 551     case AliasAnalysis::Ref:
 552       // If the call is known to never store to the pointer, and if this is a
 553       // load query, we can safely ignore it (scan past it).
 554       if (isLoad)
 555         continue;
 556     default:
 557       // Otherwise, there is a potential dependence.  Return a clobber.
 558       return MemDepResult::getClobber(Inst);
 559     }
 560   }
 561
 562   // No dependence found.  If this is the entry block of the function, it is
 563   // unknown, otherwise it is non-local.
 564   if (BB != &BB->getParent()->getEntryBlock())
 565     return MemDepResult::getNonLocal();
 566   return MemDepResult::getNonFuncLocal();
 567 }
 568
 569 /// getDependency - Return the instruction on which a memory operation
 570 /// depends.
 571 MemDepResult MemoryDependenceAnalysis::getDependency(Instruction *QueryInst) {
 572   Instruction *ScanPos = QueryInst;
 573
 574   // Check for a cached result
 575   MemDepResult &LocalCache = LocalDeps[QueryInst];
 576
 577   // If the cached entry is non-dirty, just return it.  Note that this depends
 578   // on MemDepResult's default constructing to 'dirty'.
 579   if (!LocalCache.isDirty())
 580     return LocalCache;
 581
 582   // Otherwise, if we have a dirty entry, we know we can start the scan at that
 583   // instruction, which may save us some work.
 584   if (Instruction *Inst = LocalCache.getInst()) {
 585     ScanPos = Inst;
 586
 587     RemoveFromReverseMap(ReverseLocalDeps, Inst, QueryInst);
 588   }
 589
 590   BasicBlock *QueryParent = QueryInst->getParent();
 591
 592   // Do the scan.
 593   if (BasicBlock::iterator(QueryInst) == QueryParent->begin()) {
 594     // No dependence found.  If this is the entry block of the function, it is
 595     // unknown, otherwise it is non-local.
 596     if (QueryParent != &QueryParent->getParent()->getEntryBlock())
 597       LocalCache = MemDepResult::getNonLocal();
 598     else
 599       LocalCache = MemDepResult::getNonFuncLocal();
 600   } else {
 601     AliasAnalysis::Location MemLoc;
 602     AliasAnalysis::ModRefResult MR = GetLocation(QueryInst, MemLoc, AA);
 603     if (MemLoc.Ptr) {
 604       // If we can do a pointer scan, make it happen.
 605       bool isLoad = !(MR & AliasAnalysis::Mod);
 606       if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(QueryInst))
 607         isLoad |= II->getIntrinsicID() == Intrinsic::lifetime_start;
 608
 609       LocalCache = getPointerDependencyFrom(MemLoc, isLoad, ScanPos,
 610                                             QueryParent, QueryInst);
 611     } else if (isa<CallInst>(QueryInst) || isa<InvokeInst>(QueryInst)) {
 612       CallSite QueryCS(QueryInst);
 613       bool isReadOnly = AA->onlyReadsMemory(QueryCS);
 614       LocalCache = getCallSiteDependencyFrom(QueryCS, isReadOnly, ScanPos,
 615                                              QueryParent);
 616     } else
 617       // Non-memory instruction.
 618       LocalCache = MemDepResult::getUnknown();
 619   }
 620
 621   // Remember the result!
 622   if (Instruction *I = LocalCache.getInst())
 623     ReverseLocalDeps[I].insert(QueryInst);
 624
 625   return LocalCache;
 626 }
 627
 628 #ifndef NDEBUG
 629 /// AssertSorted - This method is used when -debug is specified to verify that
 630 /// cache arrays are properly kept sorted.
 631 static void AssertSorted(MemoryDependenceAnalysis::NonLocalDepInfo &Cache,
 632                          int Count = -1) {
 633   if (Count == -1) Count = Cache.size();
 634   if (Count == 0) return;
 635
 636   for (unsigned i = 1; i != unsigned(Count); ++i)
 637     assert(!(Cache[i] < Cache[i-1]) && "Cache isn't sorted!");
 638 }
 639 #endif
 640
 641 /// getNonLocalCallDependency - Perform a full dependency query for the
 642 /// specified call, returning the set of blocks that the value is
 643 /// potentially live across.  The returned set of results will include a
 644 /// "NonLocal" result for all blocks where the value is live across.
 645 ///
 646 /// This method assumes the instruction returns a "NonLocal" dependency
 647 /// within its own block.
 648 ///
 649 /// This returns a reference to an internal data structure that may be
 650 /// invalidated on the next non-local query or when an instruction is
 651 /// removed.  Clients must copy this data if they want it around longer than
 652 /// that.
 653 const MemoryDependenceAnalysis::NonLocalDepInfo &
 654 MemoryDependenceAnalysis::getNonLocalCallDependency(CallSite QueryCS) {
 655   assert(getDependency(QueryCS.getInstruction()).isNonLocal() &&
 656  "getNonLocalCallDependency should only be used on calls with non-local deps!");
 657   PerInstNLInfo &CacheP = NonLocalDeps[QueryCS.getInstruction()];
 658   NonLocalDepInfo &Cache = CacheP.first;
 659
 660   /// DirtyBlocks - This is the set of blocks that need to be recomputed.  In
 661   /// the cached case, this can happen due to instructions being deleted etc. In
 662   /// the uncached case, this starts out as the set of predecessors we care
 663   /// about.
 664   SmallVector<BasicBlock*, 32> DirtyBlocks;
 665
 666   if (!Cache.empty()) {
 667     // Okay, we have a cache entry.  If we know it is not dirty, just return it
 668     // with no computation.
 669     if (!CacheP.second) {
 670       ++NumCacheNonLocal;
 671       return Cache;
 672     }
 673
 674     // If we already have a partially computed set of results, scan them to
 675     // determine what is dirty, seeding our initial DirtyBlocks worklist.
 676     for (NonLocalDepInfo::iterator I = Cache.begin(), E = Cache.end();
 677        I != E; ++I)
 678       if (I->getResult().isDirty())
 679         DirtyBlocks.push_back(I->getBB());
 680
 681     // Sort the cache so that we can do fast binary search lookups below.
 682     std::sort(Cache.begin(), Cache.end());
 683
 684     ++NumCacheDirtyNonLocal;
 685     //cerr << "CACHED CASE: " << DirtyBlocks.size() << " dirty: "
 686     //     << Cache.size() << " cached: " << *QueryInst;
 687   } else {
 688     // Seed DirtyBlocks with each of the preds of QueryInst's block.
 689     BasicBlock *QueryBB = QueryCS.getInstruction()->getParent();
 690     for (BasicBlock **PI = PredCache->GetPreds(QueryBB); *PI; ++PI)
 691       DirtyBlocks.push_back(*PI);
 692     ++NumUncacheNonLocal;
 693   }
 694
 695   // isReadonlyCall - If this is a read-only call, we can be more aggressive.
 696   bool isReadonlyCall = AA->onlyReadsMemory(QueryCS);
 697
 698   SmallPtrSet<BasicBlock*, 64> Visited;
 699
 700   unsigned NumSortedEntries = Cache.size();
 701   DEBUG(AssertSorted(Cache));
 702
 703   // Iterate while we still have blocks to update.
 704   while (!DirtyBlocks.empty()) {
 705     BasicBlock *DirtyBB = DirtyBlocks.back();
 706     DirtyBlocks.pop_back();
 707
 708     // Already processed this block?
 709     if (!Visited.insert(DirtyBB))
 710       continue;
 711
 712     // Do a binary search to see if we already have an entry for this block in
 713     // the cache set.  If so, find it.
 714     DEBUG(AssertSorted(Cache, NumSortedEntries));
 715     NonLocalDepInfo::iterator Entry =
 716       std::upper_bound(Cache.begin(), Cache.begin()+NumSortedEntries,
 717                        NonLocalDepEntry(DirtyBB));
 718     if (Entry != Cache.begin() && std::prev(Entry)->getBB() == DirtyBB)
 719       --Entry;
 720
 721     NonLocalDepEntry *ExistingResult = nullptr;
 722     if (Entry != Cache.begin()+NumSortedEntries &&
 723         Entry->getBB() == DirtyBB) {
 724       // If we already have an entry, and if it isn't already dirty, the block
 725       // is done.
 726       if (!Entry->getResult().isDirty())
 727         continue;
 728
 729       // Otherwise, remember this slot so we can update the value.
 730       ExistingResult = &*Entry;
 731     }
 732
 733     // If the dirty entry has a pointer, start scanning from it so we don't have
 734     // to rescan the entire block.
 735     BasicBlock::iterator ScanPos = DirtyBB->end();
 736     if (ExistingResult) {
 737       if (Instruction *Inst = ExistingResult->getResult().getInst()) {
 738         ScanPos = Inst;
 739         // We're removing QueryInst's use of Inst.
 740         RemoveFromReverseMap(ReverseNonLocalDeps, Inst,
 741                              QueryCS.getInstruction());
 742       }
 743     }
 744
 745     // Find out if this block has a local dependency for QueryInst.
 746     MemDepResult Dep;
 747
 748     if (ScanPos != DirtyBB->begin()) {
 749       Dep = getCallSiteDependencyFrom(QueryCS, isReadonlyCall,ScanPos, DirtyBB);
 750     } else if (DirtyBB != &DirtyBB->getParent()->getEntryBlock()) {
 751       // No dependence found.  If this is the entry block of the function, it is
 752       // a clobber, otherwise it is unknown.
 753       Dep = MemDepResult::getNonLocal();
 754     } else {
 755       Dep = MemDepResult::getNonFuncLocal();
 756     }
 757
 758     // If we had a dirty entry for the block, update it.  Otherwise, just add
 759     // a new entry.
 760     if (ExistingResult)
 761       ExistingResult->setResult(Dep);
 762     else
 763       Cache.push_back(NonLocalDepEntry(DirtyBB, Dep));
 764
 765     // If the block has a dependency (i.e. it isn't completely transparent to
 766     // the value), remember the association!
 767     if (!Dep.isNonLocal()) {
 768       // Keep the ReverseNonLocalDeps map up to date so we can efficiently
 769       // update this when we remove instructions.
 770       if (Instruction *Inst = Dep.getInst())
 771         ReverseNonLocalDeps[Inst].insert(QueryCS.getInstruction());
 772     } else {
 773
 774       // If the block *is* completely transparent to the load, we need to check
 775       // the predecessors of this block.  Add them to our worklist.
 776       for (BasicBlock **PI = PredCache->GetPreds(DirtyBB); *PI; ++PI)
 777         DirtyBlocks.push_back(*PI);
 778     }
 779   }
 780
 781   return Cache;
 782 }
 783
 784 /// getNonLocalPointerDependency - Perform a full dependency query for an
 785 /// access to the specified (non-volatile) memory location, returning the
 786 /// set of instructions that either define or clobber the value.
 787 ///
 788 /// This method assumes the pointer has a "NonLocal" dependency within its
 789 /// own block.
 790 ///
 791 void MemoryDependenceAnalysis::
 792 getNonLocalPointerDependency(const AliasAnalysis::Location &Loc, bool isLoad,
 793                              BasicBlock *FromBB,
 794                              SmallVectorImpl<NonLocalDepResult> &Result) {
 795   assert(Loc.Ptr->getType()->isPointerTy() &&
 796          "Can't get pointer deps of a non-pointer!");
 797   Result.clear();
 798
 799   PHITransAddr Address(const_cast<Value *>(Loc.Ptr), DL);
 800
 801   // This is the set of blocks we've inspected, and the pointer we consider in
 802   // each block.  Because of critical edges, we currently bail out if querying
 803   // a block with multiple different pointers.  This can happen during PHI
 804   // translation.
 805   DenseMap<BasicBlock*, Value*> Visited;
 806   if (!getNonLocalPointerDepFromBB(Address, Loc, isLoad, FromBB,
 807                                    Result, Visited, true))
 808     return;
 809   Result.clear();
 810   Result.push_back(NonLocalDepResult(FromBB,
 811                                      MemDepResult::getUnknown(),
 812                                      const_cast<Value *>(Loc.Ptr)));
 813 }
 814
 815 /// GetNonLocalInfoForBlock - Compute the memdep value for BB with
 816 /// Pointer/PointeeSize using either cached information in Cache or by doing a
 817 /// lookup (which may use dirty cache info if available).  If we do a lookup,
 818 /// add the result to the cache.
 819 MemDepResult MemoryDependenceAnalysis::
 820 GetNonLocalInfoForBlock(const AliasAnalysis::Location &Loc,
 821                         bool isLoad, BasicBlock *BB,
 822                         NonLocalDepInfo *Cache, unsigned NumSortedEntries) {
 823
 824   // Do a binary search to see if we already have an entry for this block in
 825   // the cache set.  If so, find it.
 826   NonLocalDepInfo::iterator Entry =
 827     std::upper_bound(Cache->begin(), Cache->begin()+NumSortedEntries,
 828                      NonLocalDepEntry(BB));
 829   if (Entry != Cache->begin() && (Entry-1)->getBB() == BB)
 830     --Entry;
 831
 832   NonLocalDepEntry *ExistingResult = nullptr;
 833   if (Entry != Cache->begin()+NumSortedEntries && Entry->getBB() == BB)
 834     ExistingResult = &*Entry;
 835
 836   // If we have a cached entry, and it is non-dirty, use it as the value for
 837   // this dependency.
 838   if (ExistingResult && !ExistingResult->getResult().isDirty()) {
 839     ++NumCacheNonLocalPtr;
 840     return ExistingResult->getResult();
 841   }
 842
 843   // Otherwise, we have to scan for the value.  If we have a dirty cache
 844   // entry, start scanning from its position, otherwise we scan from the end
 845   // of the block.
 846   BasicBlock::iterator ScanPos = BB->end();
 847   if (ExistingResult && ExistingResult->getResult().getInst()) {
 848     assert(ExistingResult->getResult().getInst()->getParent() == BB &&
 849            "Instruction invalidated?");
 850     ++NumCacheDirtyNonLocalPtr;
 851     ScanPos = ExistingResult->getResult().getInst();
 852
 853     // Eliminating the dirty entry from 'Cache', so update the reverse info.
 854     ValueIsLoadPair CacheKey(Loc.Ptr, isLoad);
 855     RemoveFromReverseMap(ReverseNonLocalPtrDeps, ScanPos, CacheKey);
 856   } else {
 857     ++NumUncacheNonLocalPtr;
 858   }
 859
 860   // Scan the block for the dependency.
 861   MemDepResult Dep = getPointerDependencyFrom(Loc, isLoad, ScanPos, BB);
 862
 863   // If we had a dirty entry for the block, update it.  Otherwise, just add
 864   // a new entry.
 865   if (ExistingResult)
 866     ExistingResult->setResult(Dep);
 867   else
 868     Cache->push_back(NonLocalDepEntry(BB, Dep));
 869
 870   // If the block has a dependency (i.e. it isn't completely transparent to
 871   // the value), remember the reverse association because we just added it
 872   // to Cache!
 873   if (!Dep.isDef() && !Dep.isClobber())
 874     return Dep;
 875
 876   // Keep the ReverseNonLocalPtrDeps map up to date so we can efficiently
 877   // update MemDep when we remove instructions.
 878   Instruction *Inst = Dep.getInst();
 879   assert(Inst && "Didn't depend on anything?");
 880   ValueIsLoadPair CacheKey(Loc.Ptr, isLoad);
 881   ReverseNonLocalPtrDeps[Inst].insert(CacheKey);
 882   return Dep;
 883 }
 884
 885 /// SortNonLocalDepInfoCache - Sort the a NonLocalDepInfo cache, given a certain
 886 /// number of elements in the array that are already properly ordered.  This is
 887 /// optimized for the case when only a few entries are added.
 888 static void
 889 SortNonLocalDepInfoCache(MemoryDependenceAnalysis::NonLocalDepInfo &Cache,
 890                          unsigned NumSortedEntries) {
 891   switch (Cache.size() - NumSortedEntries) {
 892   case 0:
 893     // done, no new entries.
 894     break;
 895   case 2: {
 896     // Two new entries, insert the last one into place.
 897     NonLocalDepEntry Val = Cache.back();
 898     Cache.pop_back();
 899     MemoryDependenceAnalysis::NonLocalDepInfo::iterator Entry =
 900       std::upper_bound(Cache.begin(), Cache.end()-1, Val);
 901     Cache.insert(Entry, Val);
 902     // FALL THROUGH.
 903   }
 904   case 1:
 905     // One new entry, Just insert the new value at the appropriate position.
 906     if (Cache.size() != 1) {
 907       NonLocalDepEntry Val = Cache.back();
 908       Cache.pop_back();
 909       MemoryDependenceAnalysis::NonLocalDepInfo::iterator Entry =
 910         std::upper_bound(Cache.begin(), Cache.end(), Val);
 911       Cache.insert(Entry, Val);
 912     }
 913     break;
 914   default:
 915     // Added many values, do a full scale sort.
 916     std::sort(Cache.begin(), Cache.end());
 917     break;
 918   }
 919 }
 920
 921 /// getNonLocalPointerDepFromBB - Perform a dependency query based on
 922 /// pointer/pointeesize starting at the end of StartBB.  Add any clobber/def
 923 /// results to the results vector and keep track of which blocks are visited in
 924 /// 'Visited'.
 925 ///
 926 /// This has special behavior for the first block queries (when SkipFirstBlock
 927 /// is true).  In this special case, it ignores the contents of the specified
 928 /// block and starts returning dependence info for its predecessors.
 929 ///
 930 /// This function returns false on success, or true to indicate that it could
 931 /// not compute dependence information for some reason.  This should be treated
 932 /// as a clobber dependence on the first instruction in the predecessor block.
 933 bool MemoryDependenceAnalysis::
 934 getNonLocalPointerDepFromBB(const PHITransAddr &Pointer,
 935                             const AliasAnalysis::Location &Loc,
 936                             bool isLoad, BasicBlock *StartBB,
 937                             SmallVectorImpl<NonLocalDepResult> &Result,
 938                             DenseMap<BasicBlock*, Value*> &Visited,
 939                             bool SkipFirstBlock) {
 940   // Look up the cached info for Pointer.
 941   ValueIsLoadPair CacheKey(Pointer.getAddr(), isLoad);
 942
 943   // Set up a temporary NLPI value. If the map doesn't yet have an entry for
 944   // CacheKey, this value will be inserted as the associated value. Otherwise,
 945   // it'll be ignored, and we'll have to check to see if the cached size and
 946   // aa tags are consistent with the current query.
 947   NonLocalPointerInfo InitialNLPI;
 948   InitialNLPI.Size = Loc.Size;
 949   InitialNLPI.AATags = Loc.AATags;
 950
 951   // Get the NLPI for CacheKey, inserting one into the map if it doesn't
 952   // already have one.
 953   std::pair<CachedNonLocalPointerInfo::iterator, bool> Pair =
 954     NonLocalPointerDeps.insert(std::make_pair(CacheKey, InitialNLPI));
 955   NonLocalPointerInfo *CacheInfo = &Pair.first->second;
 956
 957   // If we already have a cache entry for this CacheKey, we may need to do some
 958   // work to reconcile the cache entry and the current query.
 959   if (!Pair.second) {
 960     if (CacheInfo->Size < Loc.Size) {
 961       // The query's Size is greater than the cached one. Throw out the
 962       // cached data and proceed with the query at the greater size.
 963       CacheInfo->Pair = BBSkipFirstBlockPair();
 964       CacheInfo->Size = Loc.Size;
 965       for (NonLocalDepInfo::iterator DI = CacheInfo->NonLocalDeps.begin(),
 966            DE = CacheInfo->NonLocalDeps.end(); DI != DE; ++DI)
 967         if (Instruction *Inst = DI->getResult().getInst())
 968           RemoveFromReverseMap(ReverseNonLocalPtrDeps, Inst, CacheKey);
 969       CacheInfo->NonLocalDeps.clear();
 970     } else if (CacheInfo->Size > Loc.Size) {
 971       // This query's Size is less than the cached one. Conservatively restart
 972       // the query using the greater size.
 973       return getNonLocalPointerDepFromBB(Pointer,
 974                                          Loc.getWithNewSize(CacheInfo->Size),
 975                                          isLoad, StartBB, Result, Visited,
 976                                          SkipFirstBlock);
 977     }
 978
 979     // If the query's AATags are inconsistent with the cached one,
 980     // conservatively throw out the cached data and restart the query with
 981     // no tag if needed.
 982     if (CacheInfo->AATags != Loc.AATags) {
 983       if (CacheInfo->AATags) {
 984         CacheInfo->Pair = BBSkipFirstBlockPair();
 985         CacheInfo->AATags = AAMDNodes();
 986         for (NonLocalDepInfo::iterator DI = CacheInfo->NonLocalDeps.begin(),
 987              DE = CacheInfo->NonLocalDeps.end(); DI != DE; ++DI)
 988           if (Instruction *Inst = DI->getResult().getInst())
 989             RemoveFromReverseMap(ReverseNonLocalPtrDeps, Inst, CacheKey);
 990         CacheInfo->NonLocalDeps.clear();
 991       }
 992       if (Loc.AATags)
 993         return getNonLocalPointerDepFromBB(Pointer, Loc.getWithoutAATags(),
 994                                            isLoad, StartBB, Result, Visited,
 995                                            SkipFirstBlock);
 996     }
 997   }
 998
 999   NonLocalDepInfo *Cache = &CacheInfo->NonLocalDeps;
1000
1001   // If we have valid cached information for exactly the block we are
1002   // investigating, just return it with no recomputation.
1003   if (CacheInfo->Pair == BBSkipFirstBlockPair(StartBB, SkipFirstBlock)) {
1004     // We have a fully cached result for this query then we can just return the
1005     // cached results and populate the visited set.  However, we have to verify
1006     // that we don't already have conflicting results for these blocks.  Check
1007     // to ensure that if a block in the results set is in the visited set that
1008     // it was for the same pointer query.
1009     if (!Visited.empty()) {
1010       for (NonLocalDepInfo::iterator I = Cache->begin(), E = Cache->end();
1011            I != E; ++I) {
1012         DenseMap<BasicBlock*, Value*>::iterator VI = Visited.find(I->getBB());
1013         if (VI == Visited.end() || VI->second == Pointer.getAddr())
1014           continue;
1015
1016         // We have a pointer mismatch in a block.  Just return clobber, saying
1017         // that something was clobbered in this result.  We could also do a
1018         // non-fully cached query, but there is little point in doing this.
1019         return true;
1020       }
1021     }
1022
1023     Value *Addr = Pointer.getAddr();
1024     for (NonLocalDepInfo::iterator I = Cache->begin(), E = Cache->end();
1025          I != E; ++I) {
1026       Visited.insert(std::make_pair(I->getBB(), Addr));
1027       if (I->getResult().isNonLocal()) {
1028         continue;
1029       }
1030
1031       if (!DT) {
1032         Result.push_back(NonLocalDepResult(I->getBB(),
1033                                            MemDepResult::getUnknown(),
1034                                            Addr));
1035       } else if (DT->isReachableFromEntry(I->getBB())) {
1036         Result.push_back(NonLocalDepResult(I->getBB(), I->getResult(), Addr));
1037       }
1038     }
1039     ++NumCacheCompleteNonLocalPtr;
1040     return false;
1041   }
1042
1043   // Otherwise, either this is a new block, a block with an invalid cache
1044   // pointer or one that we're about to invalidate by putting more info into it
1045   // than its valid cache info.  If empty, the result will be valid cache info,
1046   // otherwise it isn't.
1047   if (Cache->empty())
1048     CacheInfo->Pair = BBSkipFirstBlockPair(StartBB, SkipFirstBlock);
1049   else
1050     CacheInfo->Pair = BBSkipFirstBlockPair();
1051
1052   SmallVector<BasicBlock*, 32> Worklist;
1053   Worklist.push_back(StartBB);
1054
1055   // PredList used inside loop.
1056   SmallVector<std::pair<BasicBlock*, PHITransAddr>, 16> PredList;
1057
1058   // Keep track of the entries that we know are sorted.  Previously cached
1059   // entries will all be sorted.  The entries we add we only sort on demand (we
1060   // don't insert every element into its sorted position).  We know that we
1061   // won't get any reuse from currently inserted values, because we don't
1062   // revisit blocks after we insert info for them.
1063   unsigned NumSortedEntries = Cache->size();
1064   DEBUG(AssertSorted(*Cache));
1065
1066   while (!Worklist.empty()) {
1067     BasicBlock *BB = Worklist.pop_back_val();
1068
1069     // Skip the first block if we have it.
1070     if (!SkipFirstBlock) {
1071       // Analyze the dependency of *Pointer in FromBB.  See if we already have
1072       // been here.
1073       assert(Visited.count(BB) && "Should check 'visited' before adding to WL");
1074
1075       // Get the dependency info for Pointer in BB.  If we have cached
1076       // information, we will use it, otherwise we compute it.
1077       DEBUG(AssertSorted(*Cache, NumSortedEntries));
1078       MemDepResult Dep = GetNonLocalInfoForBlock(Loc, isLoad, BB, Cache,
1079                                                  NumSortedEntries);
1080
1081       // If we got a Def or Clobber, add this to the list of results.
1082       if (!Dep.isNonLocal()) {
1083         if (!DT) {
1084           Result.push_back(NonLocalDepResult(BB,
1085                                              MemDepResult::getUnknown(),
1086                                              Pointer.getAddr()));
1087           continue;
1088         } else if (DT->isReachableFromEntry(BB)) {
1089           Result.push_back(NonLocalDepResult(BB, Dep, Pointer.getAddr()));
1090           continue;
1091         }
1092       }
1093     }
1094
1095     // If 'Pointer' is an instruction defined in this block, then we need to do
1096     // phi translation to change it into a value live in the predecessor block.
1097     // If not, we just add the predecessors to the worklist and scan them with
1098     // the same Pointer.
1099     if (!Pointer.NeedsPHITranslationFromBlock(BB)) {
1100       SkipFirstBlock = false;
1101       SmallVector<BasicBlock*, 16> NewBlocks;
1102       for (BasicBlock **PI = PredCache->GetPreds(BB); *PI; ++PI) {
1103         // Verify that we haven't looked at this block yet.
1104         std::pair<DenseMap<BasicBlock*,Value*>::iterator, bool>
1105           InsertRes = Visited.insert(std::make_pair(*PI, Pointer.getAddr()));
1106         if (InsertRes.second) {
1107           // First time we've looked at *PI.
1108           NewBlocks.push_back(*PI);
1109           continue;
1110         }
1111
1112         // If we have seen this block before, but it was with a different
1113         // pointer then we have a phi translation failure and we have to treat
1114         // this as a clobber.
1115         if (InsertRes.first->second != Pointer.getAddr()) {
1116           // Make sure to clean up the Visited map before continuing on to
1117           // PredTranslationFailure.
1118           for (unsigned i = 0; i < NewBlocks.size(); i++)
1119             Visited.erase(NewBlocks[i]);
1120           goto PredTranslationFailure;
1121         }
1122       }
1123       Worklist.append(NewBlocks.begin(), NewBlocks.end());
1124       continue;
1125     }
1126
1127     // We do need to do phi translation, if we know ahead of time we can't phi
1128     // translate this value, don't even try.
1129     if (!Pointer.IsPotentiallyPHITranslatable())
1130       goto PredTranslationFailure;
1131
1132     // We may have added values to the cache list before this PHI translation.
1133     // If so, we haven't done anything to ensure that the cache remains sorted.
1134     // Sort it now (if needed) so that recursive invocations of
1135     // getNonLocalPointerDepFromBB and other routines that could reuse the cache
1136     // value will only see properly sorted cache arrays.
1137     if (Cache && NumSortedEntries != Cache->size()) {
1138       SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
1139       NumSortedEntries = Cache->size();
1140     }
1141     Cache = nullptr;
1142
1143     PredList.clear();
1144     for (BasicBlock **PI = PredCache->GetPreds(BB); *PI; ++PI) {
1145       BasicBlock *Pred = *PI;
1146       PredList.push_back(std::make_pair(Pred, Pointer));
1147
1148       // Get the PHI translated pointer in this predecessor.  This can fail if
1149       // not translatable, in which case the getAddr() returns null.
1150       PHITransAddr &PredPointer = PredList.back().second;
1151       PredPointer.PHITranslateValue(BB, Pred, nullptr);
1152
1153       Value *PredPtrVal = PredPointer.getAddr();
1154
1155       // Check to see if we have already visited this pred block with another
1156       // pointer.  If so, we can't do this lookup.  This failure can occur
1157       // with PHI translation when a critical edge exists and the PHI node in
1158       // the successor translates to a pointer value different than the
1159       // pointer the block was first analyzed with.
1160       std::pair<DenseMap<BasicBlock*,Value*>::iterator, bool>
1161         InsertRes = Visited.insert(std::make_pair(Pred, PredPtrVal));
1162
1163       if (!InsertRes.second) {
1164         // We found the pred; take it off the list of preds to visit.
1165         PredList.pop_back();
1166
1167         // If the predecessor was visited with PredPtr, then we already did
1168         // the analysis and can ignore it.
1169         if (InsertRes.first->second == PredPtrVal)
1170           continue;
1171
1172         // Otherwise, the block was previously analyzed with a different
1173         // pointer.  We can't represent the result of this case, so we just
1174         // treat this as a phi translation failure.
1175
1176         // Make sure to clean up the Visited map before continuing on to
1177         // PredTranslationFailure.
1178         for (unsigned i = 0, n = PredList.size(); i < n; ++i)
1179           Visited.erase(PredList[i].first);
1180
1181         goto PredTranslationFailure;
1182       }
1183     }
1184
1185     // Actually process results here; this need to be a separate loop to avoid
1186     // calling getNonLocalPointerDepFromBB for blocks we don't want to return
1187     // any results for.  (getNonLocalPointerDepFromBB will modify our
1188     // datastructures in ways the code after the PredTranslationFailure label
1189     // doesn't expect.)
1190     for (unsigned i = 0, n = PredList.size(); i < n; ++i) {
1191       BasicBlock *Pred = PredList[i].first;
1192       PHITransAddr &PredPointer = PredList[i].second;
1193       Value *PredPtrVal = PredPointer.getAddr();
1194
1195       bool CanTranslate = true;
1196       // If PHI translation was unable to find an available pointer in this
1197       // predecessor, then we have to assume that the pointer is clobbered in
1198       // that predecessor.  We can still do PRE of the load, which would insert
1199       // a computation of the pointer in this predecessor.
1200       if (!PredPtrVal)
1201         CanTranslate = false;
1202
1203       // FIXME: it is entirely possible that PHI translating will end up with
1204       // the same value.  Consider PHI translating something like:
1205       // X = phi [x, bb1], [y, bb2].  PHI translating for bb1 doesn't *need*
1206       // to recurse here, pedantically speaking.
1207
1208       // If getNonLocalPointerDepFromBB fails here, that means the cached
1209       // result conflicted with the Visited list; we have to conservatively
1210       // assume it is unknown, but this also does not block PRE of the load.
1211       if (!CanTranslate ||
1212           getNonLocalPointerDepFromBB(PredPointer,
1213                                       Loc.getWithNewPtr(PredPtrVal),
1214                                       isLoad, Pred,
1215                                       Result, Visited)) {
1216         // Add the entry to the Result list.
1217         NonLocalDepResult Entry(Pred, MemDepResult::getUnknown(), PredPtrVal);
1218         Result.push_back(Entry);
1219
1220         // Since we had a phi translation failure, the cache for CacheKey won't
1221         // include all of the entries that we need to immediately satisfy future
1222         // queries.  Mark this in NonLocalPointerDeps by setting the
1223         // BBSkipFirstBlockPair pointer to null.  This requires reuse of the
1224         // cached value to do more work but not miss the phi trans failure.
1225         NonLocalPointerInfo &NLPI = NonLocalPointerDeps[CacheKey];
1226         NLPI.Pair = BBSkipFirstBlockPair();
1227         continue;
1228       }
1229     }
1230
1231     // Refresh the CacheInfo/Cache pointer so that it isn't invalidated.
1232     CacheInfo = &NonLocalPointerDeps[CacheKey];
1233     Cache = &CacheInfo->NonLocalDeps;
1234     NumSortedEntries = Cache->size();
1235
1236     // Since we did phi translation, the "Cache" set won't contain all of the
1237     // results for the query.  This is ok (we can still use it to accelerate
1238     // specific block queries) but we can't do the fastpath "return all
1239     // results from the set"  Clear out the indicator for this.
1240     CacheInfo->Pair = BBSkipFirstBlockPair();
1241     SkipFirstBlock = false;
1242     continue;
1243
1244   PredTranslationFailure:
1245     // The following code is "failure"; we can't produce a sane translation
1246     // for the given block.  It assumes that we haven't modified any of
1247     // our datastructures while processing the current block.
1248
1249     if (!Cache) {
1250       // Refresh the CacheInfo/Cache pointer if it got invalidated.
1251       CacheInfo = &NonLocalPointerDeps[CacheKey];
1252       Cache = &CacheInfo->NonLocalDeps;
1253       NumSortedEntries = Cache->size();
1254     }
1255
1256     // Since we failed phi translation, the "Cache" set won't contain all of the
1257     // results for the query.  This is ok (we can still use it to accelerate
1258     // specific block queries) but we can't do the fastpath "return all
1259     // results from the set".  Clear out the indicator for this.
1260     CacheInfo->Pair = BBSkipFirstBlockPair();
1261
1262     // If *nothing* works, mark the pointer as unknown.
1263     //
1264     // If this is the magic first block, return this as a clobber of the whole
1265     // incoming value.  Since we can't phi translate to one of the predecessors,
1266     // we have to bail out.
1267     if (SkipFirstBlock)
1268       return true;
1269
1270     for (NonLocalDepInfo::reverse_iterator I = Cache->rbegin(); ; ++I) {
1271       assert(I != Cache->rend() && "Didn't find current block??");
1272       if (I->getBB() != BB)
1273         continue;
1274
1275       assert(I->getResult().isNonLocal() &&
1276              "Should only be here with transparent block");
1277       I->setResult(MemDepResult::getUnknown());
1278       Result.push_back(NonLocalDepResult(I->getBB(), I->getResult(),
1279                                          Pointer.getAddr()));
1280       break;
1281     }
1282   }
1283
1284   // Okay, we're done now.  If we added new values to the cache, re-sort it.
1285   SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
1286   DEBUG(AssertSorted(*Cache));
1287   return false;
1288 }
1289
1290 /// RemoveCachedNonLocalPointerDependencies - If P exists in
1291 /// CachedNonLocalPointerInfo, remove it.
1292 void MemoryDependenceAnalysis::
1293 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair P) {
1294   CachedNonLocalPointerInfo::iterator It =
1295     NonLocalPointerDeps.find(P);
1296   if (It == NonLocalPointerDeps.end()) return;
1297
1298   // Remove all of the entries in the BB->val map.  This involves removing
1299   // instructions from the reverse map.
1300   NonLocalDepInfo &PInfo = It->second.NonLocalDeps;
1301
1302   for (unsigned i = 0, e = PInfo.size(); i != e; ++i) {
1303     Instruction *Target = PInfo[i].getResult().getInst();
1304     if (!Target) continue;  // Ignore non-local dep results.
1305     assert(Target->getParent() == PInfo[i].getBB());
1306
1307     // Eliminating the dirty entry from 'Cache', so update the reverse info.
1308     RemoveFromReverseMap(ReverseNonLocalPtrDeps, Target, P);
1309   }
1310
1311   // Remove P from NonLocalPointerDeps (which deletes NonLocalDepInfo).
1312   NonLocalPointerDeps.erase(It);
1313 }
1314
1315
1316 /// invalidateCachedPointerInfo - This method is used to invalidate cached
1317 /// information about the specified pointer, because it may be too
1318 /// conservative in memdep.  This is an optional call that can be used when
1319 /// the client detects an equivalence between the pointer and some other
1320 /// value and replaces the other value with ptr. This can make Ptr available
1321 /// in more places that cached info does not necessarily keep.
1322 void MemoryDependenceAnalysis::invalidateCachedPointerInfo(Value *Ptr) {
1323   // If Ptr isn't really a pointer, just ignore it.
1324   if (!Ptr->getType()->isPointerTy()) return;
1325   // Flush store info for the pointer.
1326   RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, false));
1327   // Flush load info for the pointer.
1328   RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, true));
1329 }
1330
1331 /// invalidateCachedPredecessors - Clear the PredIteratorCache info.
1332 /// This needs to be done when the CFG changes, e.g., due to splitting
1333 /// critical edges.
1334 void MemoryDependenceAnalysis::invalidateCachedPredecessors() {
1335   PredCache->clear();
1336 }
1337
1338 /// removeInstruction - Remove an instruction from the dependence analysis,
1339 /// updating the dependence of instructions that previously depended on it.
1340 /// This method attempts to keep the cache coherent using the reverse map.
1341 void MemoryDependenceAnalysis::removeInstruction(Instruction *RemInst) {
1342   // Walk through the Non-local dependencies, removing this one as the value
1343   // for any cached queries.
1344   NonLocalDepMapType::iterator NLDI = NonLocalDeps.find(RemInst);
1345   if (NLDI != NonLocalDeps.end()) {
1346     NonLocalDepInfo &BlockMap = NLDI->second.first;
1347     for (NonLocalDepInfo::iterator DI = BlockMap.begin(), DE = BlockMap.end();
1348          DI != DE; ++DI)
1349       if (Instruction *Inst = DI->getResult().getInst())
1350         RemoveFromReverseMap(ReverseNonLocalDeps, Inst, RemInst);
1351     NonLocalDeps.erase(NLDI);
1352   }
1353
1354   // If we have a cached local dependence query for this instruction, remove it.
1355   //
1356   LocalDepMapType::iterator LocalDepEntry = LocalDeps.find(RemInst);
1357   if (LocalDepEntry != LocalDeps.end()) {
1358     // Remove us from DepInst's reverse set now that the local dep info is gone.
1359     if (Instruction *Inst = LocalDepEntry->second.getInst())
1360       RemoveFromReverseMap(ReverseLocalDeps, Inst, RemInst);
1361
1362     // Remove this local dependency info.
1363     LocalDeps.erase(LocalDepEntry);
1364   }
1365
1366   // If we have any cached pointer dependencies on this instruction, remove
1367   // them.  If the instruction has non-pointer type, then it can't be a pointer
1368   // base.
1369
1370   // Remove it from both the load info and the store info.  The instruction
1371   // can't be in either of these maps if it is non-pointer.
1372   if (RemInst->getType()->isPointerTy()) {
1373     RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, false));
1374     RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, true));
1375   }
1376
1377   // Loop over all of the things that depend on the instruction we're removing.
1378   //
1379   SmallVector<std::pair<Instruction*, Instruction*>, 8> ReverseDepsToAdd;
1380
1381   // If we find RemInst as a clobber or Def in any of the maps for other values,
1382   // we need to replace its entry with a dirty version of the instruction after
1383   // it.  If RemInst is a terminator, we use a null dirty value.
1384   //
1385   // Using a dirty version of the instruction after RemInst saves having to scan
1386   // the entire block to get to this point.
1387   MemDepResult NewDirtyVal;
1388   if (!RemInst->isTerminator())
1389     NewDirtyVal = MemDepResult::getDirty(++BasicBlock::iterator(RemInst));
1390
1391   ReverseDepMapType::iterator ReverseDepIt = ReverseLocalDeps.find(RemInst);
1392   if (ReverseDepIt != ReverseLocalDeps.end()) {
1393     SmallPtrSet<Instruction*, 4> &ReverseDeps = ReverseDepIt->second;
1394     // RemInst can't be the terminator if it has local stuff depending on it.
1395     assert(!ReverseDeps.empty() && !isa<TerminatorInst>(RemInst) &&
1396            "Nothing can locally depend on a terminator");
1397
1398     for (SmallPtrSet<Instruction*, 4>::iterator I = ReverseDeps.begin(),
1399          E = ReverseDeps.end(); I != E; ++I) {
1400       Instruction *InstDependingOnRemInst = *I;
1401       assert(InstDependingOnRemInst != RemInst &&
1402              "Already removed our local dep info");
1403
1404       LocalDeps[InstDependingOnRemInst] = NewDirtyVal;
1405
1406       // Make sure to remember that new things depend on NewDepInst.
1407       assert(NewDirtyVal.getInst() && "There is no way something else can have "
1408              "a local dep on this if it is a terminator!");
1409       ReverseDepsToAdd.push_back(std::make_pair(NewDirtyVal.getInst(),
1410                                                 InstDependingOnRemInst));
1411     }
1412
1413     ReverseLocalDeps.erase(ReverseDepIt);
1414
1415     // Add new reverse deps after scanning the set, to avoid invalidating the
1416     // 'ReverseDeps' reference.
1417     while (!ReverseDepsToAdd.empty()) {
1418       ReverseLocalDeps[ReverseDepsToAdd.back().first]
1419         .insert(ReverseDepsToAdd.back().second);
1420       ReverseDepsToAdd.pop_back();
1421     }
1422   }
1423
1424   ReverseDepIt = ReverseNonLocalDeps.find(RemInst);
1425   if (ReverseDepIt != ReverseNonLocalDeps.end()) {
1426     SmallPtrSet<Instruction*, 4> &Set = ReverseDepIt->second;
1427     for (SmallPtrSet<Instruction*, 4>::iterator I = Set.begin(), E = Set.end();
1428          I != E; ++I) {
1429       assert(*I != RemInst && "Already removed NonLocalDep info for RemInst");
1430
1431       PerInstNLInfo &INLD = NonLocalDeps[*I];
1432       // The information is now dirty!
1433       INLD.second = true;
1434
1435       for (NonLocalDepInfo::iterator DI = INLD.first.begin(),
1436            DE = INLD.first.end(); DI != DE; ++DI) {
1437         if (DI->getResult().getInst() != RemInst) continue;
1438
1439         // Convert to a dirty entry for the subsequent instruction.
1440         DI->setResult(NewDirtyVal);
1441
1442         if (Instruction *NextI = NewDirtyVal.getInst())
1443           ReverseDepsToAdd.push_back(std::make_pair(NextI, *I));
1444       }
1445     }
1446
1447     ReverseNonLocalDeps.erase(ReverseDepIt);
1448
1449     // Add new reverse deps after scanning the set, to avoid invalidating 'Set'
1450     while (!ReverseDepsToAdd.empty()) {
1451       ReverseNonLocalDeps[ReverseDepsToAdd.back().first]
1452         .insert(ReverseDepsToAdd.back().second);
1453       ReverseDepsToAdd.pop_back();
1454     }
1455   }
1456
1457   // If the instruction is in ReverseNonLocalPtrDeps then it appears as a
1458   // value in the NonLocalPointerDeps info.
1459   ReverseNonLocalPtrDepTy::iterator ReversePtrDepIt =
1460     ReverseNonLocalPtrDeps.find(RemInst);
1461   if (ReversePtrDepIt != ReverseNonLocalPtrDeps.end()) {
1462     SmallPtrSet<ValueIsLoadPair, 4> &Set = ReversePtrDepIt->second;
1463     SmallVector<std::pair<Instruction*, ValueIsLoadPair>,8> ReversePtrDepsToAdd;
1464
1465     for (SmallPtrSet<ValueIsLoadPair, 4>::iterator I = Set.begin(),
1466          E = Set.end(); I != E; ++I) {
1467       ValueIsLoadPair P = *I;
1468       assert(P.getPointer() != RemInst &&
1469              "Already removed NonLocalPointerDeps info for RemInst");
1470
1471       NonLocalDepInfo &NLPDI = NonLocalPointerDeps[P].NonLocalDeps;
1472
1473       // The cache is not valid for any specific block anymore.
1474       NonLocalPointerDeps[P].Pair = BBSkipFirstBlockPair();
1475
1476       // Update any entries for RemInst to use the instruction after it.
1477       for (NonLocalDepInfo::iterator DI = NLPDI.begin(), DE = NLPDI.end();
1478            DI != DE; ++DI) {
1479         if (DI->getResult().getInst() != RemInst) continue;
1480
1481         // Convert to a dirty entry for the subsequent instruction.
1482         DI->setResult(NewDirtyVal);
1483
1484         if (Instruction *NewDirtyInst = NewDirtyVal.getInst())
1485           ReversePtrDepsToAdd.push_back(std::make_pair(NewDirtyInst, P));
1486       }
1487
1488       // Re-sort the NonLocalDepInfo.  Changing the dirty entry to its
1489       // subsequent value may invalidate the sortedness.
1490       std::sort(NLPDI.begin(), NLPDI.end());
1491     }
1492
1493     ReverseNonLocalPtrDeps.erase(ReversePtrDepIt);
1494
1495     while (!ReversePtrDepsToAdd.empty()) {
1496       ReverseNonLocalPtrDeps[ReversePtrDepsToAdd.back().first]
1497         .insert(ReversePtrDepsToAdd.back().second);
1498       ReversePtrDepsToAdd.pop_back();
1499     }
1500   }
1501
1502
1503   assert(!NonLocalDeps.count(RemInst) && "RemInst got reinserted?");
1504   AA->deleteValue(RemInst);
1505   DEBUG(verifyRemoved(RemInst));
1506 }
1507 /// verifyRemoved - Verify that the specified instruction does not occur
1508 /// in our internal data structures.
1509 void MemoryDependenceAnalysis::verifyRemoved(Instruction *D) const {
1510   for (LocalDepMapType::const_iterator I = LocalDeps.begin(),
1511        E = LocalDeps.end(); I != E; ++I) {
1512     assert(I->first != D && "Inst occurs in data structures");
1513     assert(I->second.getInst() != D &&
1514            "Inst occurs in data structures");
1515   }
1516
1517   for (CachedNonLocalPointerInfo::const_iterator I =NonLocalPointerDeps.begin(),
1518        E = NonLocalPointerDeps.end(); I != E; ++I) {
1519     assert(I->first.getPointer() != D && "Inst occurs in NLPD map key");
1520     const NonLocalDepInfo &Val = I->second.NonLocalDeps;
1521     for (NonLocalDepInfo::const_iterator II = Val.begin(), E = Val.end();
1522          II != E; ++II)
1523       assert(II->getResult().getInst() != D && "Inst occurs as NLPD value");
1524   }
1525
1526   for (NonLocalDepMapType::const_iterator I = NonLocalDeps.begin(),
1527        E = NonLocalDeps.end(); I != E; ++I) {
1528     assert(I->first != D && "Inst occurs in data structures");
1529     const PerInstNLInfo &INLD = I->second;
1530     for (NonLocalDepInfo::const_iterator II = INLD.first.begin(),
1531          EE = INLD.first.end(); II  != EE; ++II)
1532       assert(II->getResult().getInst() != D && "Inst occurs in data structures");
1533   }
1534
1535   for (ReverseDepMapType::const_iterator I = ReverseLocalDeps.begin(),
1536        E = ReverseLocalDeps.end(); I != E; ++I) {
1537     assert(I->first != D && "Inst occurs in data structures");
1538     for (SmallPtrSet<Instruction*, 4>::const_iterator II = I->second.begin(),
1539          EE = I->second.end(); II != EE; ++II)
1540       assert(*II != D && "Inst occurs in data structures");
1541   }
1542
1543   for (ReverseDepMapType::const_iterator I = ReverseNonLocalDeps.begin(),
1544        E = ReverseNonLocalDeps.end();
1545        I != E; ++I) {
1546     assert(I->first != D && "Inst occurs in data structures");
1547     for (SmallPtrSet<Instruction*, 4>::const_iterator II = I->second.begin(),
1548          EE = I->second.end(); II != EE; ++II)
1549       assert(*II != D && "Inst occurs in data structures");
1550   }
1551
1552   for (ReverseNonLocalPtrDepTy::const_iterator
1553        I = ReverseNonLocalPtrDeps.begin(),
1554        E = ReverseNonLocalPtrDeps.end(); I != E; ++I) {
1555     assert(I->first != D && "Inst occurs in rev NLPD map");
1556
1557     for (SmallPtrSet<ValueIsLoadPair, 4>::const_iterator II = I->second.begin(),
1558          E = I->second.end(); II != E; ++II)
1559       assert(*II != ValueIsLoadPair(D, false) &&
1560              *II != ValueIsLoadPair(D, true) &&
1561              "Inst occurs in ReverseNonLocalPtrDeps map");
1562   }
1563
1564 }