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