lib/Analysis/MemoryDependenceAnalysis.cpp

   1 //===- MemoryDependenceAnalysis.cpp - Mem Deps Implementation  --*- C++ -*-===//
   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 #define DEBUG_TYPE "memdep"
  18 #include "llvm/Analysis/MemoryDependenceAnalysis.h"
  19 #include "llvm/Instructions.h"
  20 #include "llvm/IntrinsicInst.h"
  21 #include "llvm/Function.h"
  22 #include "llvm/Analysis/AliasAnalysis.h"
  23 #include "llvm/Analysis/MemoryBuiltins.h"
  24 #include "llvm/ADT/Statistic.h"
  25 #include "llvm/ADT/STLExtras.h"
  26 #include "llvm/Support/PredIteratorCache.h"
  27 #include "llvm/Support/Debug.h"
  28 using namespace llvm;
  29
  30 STATISTIC(NumCacheNonLocal, "Number of fully cached non-local responses");
  31 STATISTIC(NumCacheDirtyNonLocal, "Number of dirty cached non-local responses");
  32 STATISTIC(NumUncacheNonLocal, "Number of uncached non-local responses");
  33
  34 STATISTIC(NumCacheNonLocalPtr,
  35           "Number of fully cached non-local ptr responses");
  36 STATISTIC(NumCacheDirtyNonLocalPtr,
  37           "Number of cached, but dirty, non-local ptr responses");
  38 STATISTIC(NumUncacheNonLocalPtr,
  39           "Number of uncached non-local ptr responses");
  40 STATISTIC(NumCacheCompleteNonLocalPtr,
  41           "Number of block queries that were completely cached");
  42
  43 char MemoryDependenceAnalysis::ID = 0;
  44
  45 // Register this pass...
  46 static RegisterPass<MemoryDependenceAnalysis> X("memdep",
  47                                      "Memory Dependence Analysis", false, true);
  48
  49 MemoryDependenceAnalysis::MemoryDependenceAnalysis()
  50 : FunctionPass(&ID), PredCache(0) {
  51 }
  52 MemoryDependenceAnalysis::~MemoryDependenceAnalysis() {
  53 }
  54
  55 /// Clean up memory in between runs
  56 void MemoryDependenceAnalysis::releaseMemory() {
  57   LocalDeps.clear();
  58   NonLocalDeps.clear();
  59   NonLocalPointerDeps.clear();
  60   ReverseLocalDeps.clear();
  61   ReverseNonLocalDeps.clear();
  62   ReverseNonLocalPtrDeps.clear();
  63   PredCache->clear();
  64 }
  65
  66
  67
  68 /// getAnalysisUsage - Does not modify anything.  It uses Alias Analysis.
  69 ///
  70 void MemoryDependenceAnalysis::getAnalysisUsage(AnalysisUsage &AU) const {
  71   AU.setPreservesAll();
  72   AU.addRequiredTransitive<AliasAnalysis>();
  73 }
  74
  75 bool MemoryDependenceAnalysis::runOnFunction(Function &) {
  76   AA = &getAnalysis<AliasAnalysis>();
  77   if (PredCache == 0)
  78     PredCache.reset(new PredIteratorCache());
  79   return false;
  80 }
  81
  82 /// RemoveFromReverseMap - This is a helper function that removes Val from
  83 /// 'Inst's set in ReverseMap.  If the set becomes empty, remove Inst's entry.
  84 template <typename KeyTy>
  85 static void RemoveFromReverseMap(DenseMap<Instruction*,
  86                                  SmallPtrSet<KeyTy, 4> > &ReverseMap,
  87                                  Instruction *Inst, KeyTy Val) {
  88   typename DenseMap<Instruction*, SmallPtrSet<KeyTy, 4> >::iterator
  89   InstIt = ReverseMap.find(Inst);
  90   assert(InstIt != ReverseMap.end() && "Reverse map out of sync?");
  91   bool Found = InstIt->second.erase(Val);
  92   assert(Found && "Invalid reverse map!"); Found=Found;
  93   if (InstIt->second.empty())
  94     ReverseMap.erase(InstIt);
  95 }
  96
  97
  98 /// getCallSiteDependencyFrom - Private helper for finding the local
  99 /// dependencies of a call site.
 100 MemDepResult MemoryDependenceAnalysis::
 101 getCallSiteDependencyFrom(CallSite CS, bool isReadOnlyCall,
 102                           BasicBlock::iterator ScanIt, BasicBlock *BB) {
 103   // Walk backwards through the block, looking for dependencies
 104   while (ScanIt != BB->begin()) {
 105     Instruction *Inst = --ScanIt;
 106
 107     // If this inst is a memory op, get the pointer it accessed
 108     Value *Pointer = 0;
 109     uint64_t PointerSize = 0;
 110     if (StoreInst *S = dyn_cast<StoreInst>(Inst)) {
 111       Pointer = S->getPointerOperand();
 112       PointerSize = AA->getTypeStoreSize(S->getOperand(0)->getType());
 113     } else if (VAArgInst *V = dyn_cast<VAArgInst>(Inst)) {
 114       Pointer = V->getOperand(0);
 115       PointerSize = AA->getTypeStoreSize(V->getType());
 116     } else if (isFreeCall(Inst)) {
 117       Pointer = Inst->getOperand(1);
 118       // calls to free() erase the entire structure
 119       PointerSize = ~0ULL;
 120     } else if (isFreeCall(Inst)) {
 121       Pointer = Inst->getOperand(0);
 122       // calls to free() erase the entire structure
 123       PointerSize = ~0ULL;
 124     } else if (isa<CallInst>(Inst) || isa<InvokeInst>(Inst)) {
 125       // Debug intrinsics don't cause dependences.
 126       if (isa<DbgInfoIntrinsic>(Inst)) continue;
 127       CallSite InstCS = CallSite::get(Inst);
 128       // If these two calls do not interfere, look past it.
 129       switch (AA->getModRefInfo(CS, InstCS)) {
 130       case AliasAnalysis::NoModRef:
 131         // If the two calls don't interact (e.g. InstCS is readnone) keep
 132         // scanning.
 133         continue;
 134       case AliasAnalysis::Ref:
 135         // If the two calls read the same memory locations and CS is a readonly
 136         // function, then we have two cases: 1) the calls may not interfere with
 137         // each other at all.  2) the calls may produce the same value.  In case
 138         // #1 we want to ignore the values, in case #2, we want to return Inst
 139         // as a Def dependence.  This allows us to CSE in cases like:
 140         //   X = strlen(P);
 141         //    memchr(...);
 142         //   Y = strlen(P);  // Y = X
 143         if (isReadOnlyCall) {
 144           if (CS.getCalledFunction() != 0 &&
 145               CS.getCalledFunction() == InstCS.getCalledFunction())
 146             return MemDepResult::getDef(Inst);
 147           // Ignore unrelated read/read call dependences.
 148           continue;
 149         }
 150         // FALL THROUGH
 151       default:
 152         return MemDepResult::getClobber(Inst);
 153       }
 154     } else {
 155       // Non-memory instruction.
 156       continue;
 157     }
 158
 159     if (AA->getModRefInfo(CS, Pointer, PointerSize) != AliasAnalysis::NoModRef)
 160       return MemDepResult::getClobber(Inst);
 161   }
 162
 163   // No dependence found.  If this is the entry block of the function, it is a
 164   // clobber, otherwise it is non-local.
 165   if (BB != &BB->getParent()->getEntryBlock())
 166     return MemDepResult::getNonLocal();
 167   return MemDepResult::getClobber(ScanIt);
 168 }
 169
 170 /// getPointerDependencyFrom - Return the instruction on which a memory
 171 /// location depends.  If isLoad is true, this routine ignore may-aliases with
 172 /// read-only operations.
 173 MemDepResult MemoryDependenceAnalysis::
 174 getPointerDependencyFrom(Value *MemPtr, uint64_t MemSize, bool isLoad,
 175                          BasicBlock::iterator ScanIt, BasicBlock *BB) {
 176
 177   Value* invariantTag = 0;
 178
 179   // Walk backwards through the basic block, looking for dependencies.
 180   while (ScanIt != BB->begin()) {
 181     Instruction *Inst = --ScanIt;
 182
 183     // If we're in an invariant region, no dependencies can be found before
 184     // we pass an invariant-begin marker.
 185     if (invariantTag == Inst) {
 186       invariantTag = 0;
 187       continue;
 188     } else if (IntrinsicInst* II = dyn_cast<IntrinsicInst>(Inst)) {
 189       // If we pass an invariant-end marker, then we've just entered an
 190       // invariant region and can start ignoring dependencies.
 191       if (II->getIntrinsicID() == Intrinsic::invariant_end) {
 192         uint64_t invariantSize = ~0ULL;
 193         if (ConstantInt* CI = dyn_cast<ConstantInt>(II->getOperand(2)))
 194           invariantSize = CI->getZExtValue();
 195
 196         AliasAnalysis::AliasResult R =
 197           AA->alias(II->getOperand(3), invariantSize, MemPtr, MemSize);
 198         if (R == AliasAnalysis::MustAlias) {
 199           invariantTag = II->getOperand(1);
 200           continue;
 201         }
 202
 203       // If we reach a lifetime begin or end marker, then the query ends here
 204       // because the value is undefined.
 205       } else if (II->getIntrinsicID() == Intrinsic::lifetime_start ||
 206                    II->getIntrinsicID() == Intrinsic::lifetime_end) {
 207         uint64_t invariantSize = ~0ULL;
 208         if (ConstantInt* CI = dyn_cast<ConstantInt>(II->getOperand(1)))
 209           invariantSize = CI->getZExtValue();
 210
 211         AliasAnalysis::AliasResult R =
 212           AA->alias(II->getOperand(2), invariantSize, MemPtr, MemSize);
 213         if (R == AliasAnalysis::MustAlias)
 214           return MemDepResult::getDef(II);
 215       }
 216     }
 217
 218     // If we're querying on a load and we're in an invariant region, we're done
 219     // at this point. Nothing a load depends on can live in an invariant region.
 220     if (isLoad && invariantTag) continue;
 221
 222     // Debug intrinsics don't cause dependences.
 223     if (isa<DbgInfoIntrinsic>(Inst)) continue;
 224
 225     // Values depend on loads if the pointers are must aliased.  This means that
 226     // a load depends on another must aliased load from the same value.
 227     if (LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
 228       Value *Pointer = LI->getPointerOperand();
 229       uint64_t PointerSize = AA->getTypeStoreSize(LI->getType());
 230
 231       // If we found a pointer, check if it could be the same as our pointer.
 232       AliasAnalysis::AliasResult R =
 233         AA->alias(Pointer, PointerSize, MemPtr, MemSize);
 234       if (R == AliasAnalysis::NoAlias)
 235         continue;
 236
 237       // May-alias loads don't depend on each other without a dependence.
 238       if (isLoad && R == AliasAnalysis::MayAlias)
 239         continue;
 240       // Stores depend on may and must aliased loads, loads depend on must-alias
 241       // loads.
 242       return MemDepResult::getDef(Inst);
 243     }
 244
 245     if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
 246       // There can't be stores to the value we care about inside an
 247       // invariant region.
 248       if (invariantTag) continue;
 249
 250       // If alias analysis can tell that this store is guaranteed to not modify
 251       // the query pointer, ignore it.  Use getModRefInfo to handle cases where
 252       // the query pointer points to constant memory etc.
 253       if (AA->getModRefInfo(SI, MemPtr, MemSize) == AliasAnalysis::NoModRef)
 254         continue;
 255
 256       // Ok, this store might clobber the query pointer.  Check to see if it is
 257       // a must alias: in this case, we want to return this as a def.
 258       Value *Pointer = SI->getPointerOperand();
 259       uint64_t PointerSize = AA->getTypeStoreSize(SI->getOperand(0)->getType());
 260
 261       // If we found a pointer, check if it could be the same as our pointer.
 262       AliasAnalysis::AliasResult R =
 263         AA->alias(Pointer, PointerSize, MemPtr, MemSize);
 264
 265       if (R == AliasAnalysis::NoAlias)
 266         continue;
 267       if (R == AliasAnalysis::MayAlias)
 268         return MemDepResult::getClobber(Inst);
 269       return MemDepResult::getDef(Inst);
 270     }
 271
 272     // If this is an allocation, and if we know that the accessed pointer is to
 273     // the allocation, return Def.  This means that there is no dependence and
 274     // the access can be optimized based on that.  For example, a load could
 275     // turn into undef.
 276     // Note: Only determine this to be a malloc if Inst is the malloc call, not
 277     // a subsequent bitcast of the malloc call result.  There can be stores to
 278     // the malloced memory between the malloc call and its bitcast uses, and we
 279     // need to continue scanning until the malloc call.
 280     if (isa<AllocaInst>(Inst) || extractMallocCall(Inst)) {
 281       Value *AccessPtr = MemPtr->getUnderlyingObject();
 282
 283       if (AccessPtr == Inst ||
 284           AA->alias(Inst, 1, AccessPtr, 1) == AliasAnalysis::MustAlias)
 285         return MemDepResult::getDef(Inst);
 286       continue;
 287     }
 288
 289     // See if this instruction (e.g. a call or vaarg) mod/ref's the pointer.
 290     switch (AA->getModRefInfo(Inst, MemPtr, MemSize)) {
 291     case AliasAnalysis::NoModRef:
 292       // If the call has no effect on the queried pointer, just ignore it.
 293       continue;
 294     case AliasAnalysis::Mod:
 295       // If we're in an invariant region, we can ignore calls that ONLY
 296       // modify the pointer.
 297       if (invariantTag) continue;
 298       return MemDepResult::getClobber(Inst);
 299     case AliasAnalysis::Ref:
 300       // If the call is known to never store to the pointer, and if this is a
 301       // load query, we can safely ignore it (scan past it).
 302       if (isLoad)
 303         continue;
 304     default:
 305       // Otherwise, there is a potential dependence.  Return a clobber.
 306       return MemDepResult::getClobber(Inst);
 307     }
 308   }
 309
 310   // No dependence found.  If this is the entry block of the function, it is a
 311   // clobber, otherwise it is non-local.
 312   if (BB != &BB->getParent()->getEntryBlock())
 313     return MemDepResult::getNonLocal();
 314   return MemDepResult::getClobber(ScanIt);
 315 }
 316
 317 /// getDependency - Return the instruction on which a memory operation
 318 /// depends.
 319 MemDepResult MemoryDependenceAnalysis::getDependency(Instruction *QueryInst) {
 320   Instruction *ScanPos = QueryInst;
 321
 322   // Check for a cached result
 323   MemDepResult &LocalCache = LocalDeps[QueryInst];
 324
 325   // If the cached entry is non-dirty, just return it.  Note that this depends
 326   // on MemDepResult's default constructing to 'dirty'.
 327   if (!LocalCache.isDirty())
 328     return LocalCache;
 329
 330   // Otherwise, if we have a dirty entry, we know we can start the scan at that
 331   // instruction, which may save us some work.
 332   if (Instruction *Inst = LocalCache.getInst()) {
 333     ScanPos = Inst;
 334
 335     RemoveFromReverseMap(ReverseLocalDeps, Inst, QueryInst);
 336   }
 337
 338   BasicBlock *QueryParent = QueryInst->getParent();
 339
 340   Value *MemPtr = 0;
 341   uint64_t MemSize = 0;
 342
 343   // Do the scan.
 344   if (BasicBlock::iterator(QueryInst) == QueryParent->begin()) {
 345     // No dependence found.  If this is the entry block of the function, it is a
 346     // clobber, otherwise it is non-local.
 347     if (QueryParent != &QueryParent->getParent()->getEntryBlock())
 348       LocalCache = MemDepResult::getNonLocal();
 349     else
 350       LocalCache = MemDepResult::getClobber(QueryInst);
 351   } else if (StoreInst *SI = dyn_cast<StoreInst>(QueryInst)) {
 352     // If this is a volatile store, don't mess around with it.  Just return the
 353     // previous instruction as a clobber.
 354     if (SI->isVolatile())
 355       LocalCache = MemDepResult::getClobber(--BasicBlock::iterator(ScanPos));
 356     else {
 357       MemPtr = SI->getPointerOperand();
 358       MemSize = AA->getTypeStoreSize(SI->getOperand(0)->getType());
 359     }
 360   } else if (LoadInst *LI = dyn_cast<LoadInst>(QueryInst)) {
 361     // If this is a volatile load, don't mess around with it.  Just return the
 362     // previous instruction as a clobber.
 363     if (LI->isVolatile())
 364       LocalCache = MemDepResult::getClobber(--BasicBlock::iterator(ScanPos));
 365     else {
 366       MemPtr = LI->getPointerOperand();
 367       MemSize = AA->getTypeStoreSize(LI->getType());
 368     }
 369   } else if (isFreeCall(QueryInst)) {
 370     MemPtr = QueryInst->getOperand(1);
 371     // calls to free() erase the entire structure, not just a field.
 372     MemSize = ~0UL;
 373   } else if (isa<CallInst>(QueryInst) || isa<InvokeInst>(QueryInst)) {
 374     CallSite QueryCS = CallSite::get(QueryInst);
 375     bool isReadOnly = AA->onlyReadsMemory(QueryCS);
 376     LocalCache = getCallSiteDependencyFrom(QueryCS, isReadOnly, ScanPos,
 377                                            QueryParent);
 378   } else {
 379     // Non-memory instruction.
 380     LocalCache = MemDepResult::getClobber(--BasicBlock::iterator(ScanPos));
 381   }
 382
 383   // If we need to do a pointer scan, make it happen.
 384   if (MemPtr)
 385     LocalCache = getPointerDependencyFrom(MemPtr, MemSize,
 386                                           isa<LoadInst>(QueryInst),
 387                                           ScanPos, QueryParent);
 388
 389   // Remember the result!
 390   if (Instruction *I = LocalCache.getInst())
 391     ReverseLocalDeps[I].insert(QueryInst);
 392
 393   return LocalCache;
 394 }
 395
 396 #ifndef NDEBUG
 397 /// AssertSorted - This method is used when -debug is specified to verify that
 398 /// cache arrays are properly kept sorted.
 399 static void AssertSorted(MemoryDependenceAnalysis::NonLocalDepInfo &Cache,
 400                          int Count = -1) {
 401   if (Count == -1) Count = Cache.size();
 402   if (Count == 0) return;
 403
 404   for (unsigned i = 1; i != unsigned(Count); ++i)
 405     assert(Cache[i-1] <= Cache[i] && "Cache isn't sorted!");
 406 }
 407 #endif
 408
 409 /// getNonLocalCallDependency - Perform a full dependency query for the
 410 /// specified call, returning the set of blocks that the value is
 411 /// potentially live across.  The returned set of results will include a
 412 /// "NonLocal" result for all blocks where the value is live across.
 413 ///
 414 /// This method assumes the instruction returns a "NonLocal" dependency
 415 /// within its own block.
 416 ///
 417 /// This returns a reference to an internal data structure that may be
 418 /// invalidated on the next non-local query or when an instruction is
 419 /// removed.  Clients must copy this data if they want it around longer than
 420 /// that.
 421 const MemoryDependenceAnalysis::NonLocalDepInfo &
 422 MemoryDependenceAnalysis::getNonLocalCallDependency(CallSite QueryCS) {
 423   assert(getDependency(QueryCS.getInstruction()).isNonLocal() &&
 424  "getNonLocalCallDependency should only be used on calls with non-local deps!");
 425   PerInstNLInfo &CacheP = NonLocalDeps[QueryCS.getInstruction()];
 426   NonLocalDepInfo &Cache = CacheP.first;
 427
 428   /// DirtyBlocks - This is the set of blocks that need to be recomputed.  In
 429   /// the cached case, this can happen due to instructions being deleted etc. In
 430   /// the uncached case, this starts out as the set of predecessors we care
 431   /// about.
 432   SmallVector<BasicBlock*, 32> DirtyBlocks;
 433
 434   if (!Cache.empty()) {
 435     // Okay, we have a cache entry.  If we know it is not dirty, just return it
 436     // with no computation.
 437     if (!CacheP.second) {
 438       NumCacheNonLocal++;
 439       return Cache;
 440     }
 441
 442     // If we already have a partially computed set of results, scan them to
 443     // determine what is dirty, seeding our initial DirtyBlocks worklist.
 444     for (NonLocalDepInfo::iterator I = Cache.begin(), E = Cache.end();
 445        I != E; ++I)
 446       if (I->second.isDirty())
 447         DirtyBlocks.push_back(I->first);
 448
 449     // Sort the cache so that we can do fast binary search lookups below.
 450     std::sort(Cache.begin(), Cache.end());
 451
 452     ++NumCacheDirtyNonLocal;
 453     //cerr << "CACHED CASE: " << DirtyBlocks.size() << " dirty: "
 454     //     << Cache.size() << " cached: " << *QueryInst;
 455   } else {
 456     // Seed DirtyBlocks with each of the preds of QueryInst's block.
 457     BasicBlock *QueryBB = QueryCS.getInstruction()->getParent();
 458     for (BasicBlock **PI = PredCache->GetPreds(QueryBB); *PI; ++PI)
 459       DirtyBlocks.push_back(*PI);
 460     NumUncacheNonLocal++;
 461   }
 462
 463   // isReadonlyCall - If this is a read-only call, we can be more aggressive.
 464   bool isReadonlyCall = AA->onlyReadsMemory(QueryCS);
 465
 466   SmallPtrSet<BasicBlock*, 64> Visited;
 467
 468   unsigned NumSortedEntries = Cache.size();
 469   DEBUG(AssertSorted(Cache));
 470
 471   // Iterate while we still have blocks to update.
 472   while (!DirtyBlocks.empty()) {
 473     BasicBlock *DirtyBB = DirtyBlocks.back();
 474     DirtyBlocks.pop_back();
 475
 476     // Already processed this block?
 477     if (!Visited.insert(DirtyBB))
 478       continue;
 479
 480     // Do a binary search to see if we already have an entry for this block in
 481     // the cache set.  If so, find it.
 482     DEBUG(AssertSorted(Cache, NumSortedEntries));
 483     NonLocalDepInfo::iterator Entry =
 484       std::upper_bound(Cache.begin(), Cache.begin()+NumSortedEntries,
 485                        std::make_pair(DirtyBB, MemDepResult()));
 486     if (Entry != Cache.begin() && prior(Entry)->first == DirtyBB)
 487       --Entry;
 488
 489     MemDepResult *ExistingResult = 0;
 490     if (Entry != Cache.begin()+NumSortedEntries &&
 491         Entry->first == DirtyBB) {
 492       // If we already have an entry, and if it isn't already dirty, the block
 493       // is done.
 494       if (!Entry->second.isDirty())
 495         continue;
 496
 497       // Otherwise, remember this slot so we can update the value.
 498       ExistingResult = &Entry->second;
 499     }
 500
 501     // If the dirty entry has a pointer, start scanning from it so we don't have
 502     // to rescan the entire block.
 503     BasicBlock::iterator ScanPos = DirtyBB->end();
 504     if (ExistingResult) {
 505       if (Instruction *Inst = ExistingResult->getInst()) {
 506         ScanPos = Inst;
 507         // We're removing QueryInst's use of Inst.
 508         RemoveFromReverseMap(ReverseNonLocalDeps, Inst,
 509                              QueryCS.getInstruction());
 510       }
 511     }
 512
 513     // Find out if this block has a local dependency for QueryInst.
 514     MemDepResult Dep;
 515
 516     if (ScanPos != DirtyBB->begin()) {
 517       Dep = getCallSiteDependencyFrom(QueryCS, isReadonlyCall,ScanPos, DirtyBB);
 518     } else if (DirtyBB != &DirtyBB->getParent()->getEntryBlock()) {
 519       // No dependence found.  If this is the entry block of the function, it is
 520       // a clobber, otherwise it is non-local.
 521       Dep = MemDepResult::getNonLocal();
 522     } else {
 523       Dep = MemDepResult::getClobber(ScanPos);
 524     }
 525
 526     // If we had a dirty entry for the block, update it.  Otherwise, just add
 527     // a new entry.
 528     if (ExistingResult)
 529       *ExistingResult = Dep;
 530     else
 531       Cache.push_back(std::make_pair(DirtyBB, Dep));
 532
 533     // If the block has a dependency (i.e. it isn't completely transparent to
 534     // the value), remember the association!
 535     if (!Dep.isNonLocal()) {
 536       // Keep the ReverseNonLocalDeps map up to date so we can efficiently
 537       // update this when we remove instructions.
 538       if (Instruction *Inst = Dep.getInst())
 539         ReverseNonLocalDeps[Inst].insert(QueryCS.getInstruction());
 540     } else {
 541
 542       // If the block *is* completely transparent to the load, we need to check
 543       // the predecessors of this block.  Add them to our worklist.
 544       for (BasicBlock **PI = PredCache->GetPreds(DirtyBB); *PI; ++PI)
 545         DirtyBlocks.push_back(*PI);
 546     }
 547   }
 548
 549   return Cache;
 550 }
 551
 552 /// getNonLocalPointerDependency - Perform a full dependency query for an
 553 /// access to the specified (non-volatile) memory location, returning the
 554 /// set of instructions that either define or clobber the value.
 555 ///
 556 /// This method assumes the pointer has a "NonLocal" dependency within its
 557 /// own block.
 558 ///
 559 void MemoryDependenceAnalysis::
 560 getNonLocalPointerDependency(Value *Pointer, bool isLoad, BasicBlock *FromBB,
 561                              SmallVectorImpl<NonLocalDepEntry> &Result) {
 562   assert(isa<PointerType>(Pointer->getType()) &&
 563          "Can't get pointer deps of a non-pointer!");
 564   Result.clear();
 565
 566   // We know that the pointer value is live into FromBB find the def/clobbers
 567   // from presecessors.
 568   const Type *EltTy = cast<PointerType>(Pointer->getType())->getElementType();
 569   uint64_t PointeeSize = AA->getTypeStoreSize(EltTy);
 570
 571   // This is the set of blocks we've inspected, and the pointer we consider in
 572   // each block.  Because of critical edges, we currently bail out if querying
 573   // a block with multiple different pointers.  This can happen during PHI
 574   // translation.
 575   DenseMap<BasicBlock*, Value*> Visited;
 576   if (!getNonLocalPointerDepFromBB(Pointer, PointeeSize, isLoad, FromBB,
 577                                    Result, Visited, true))
 578     return;
 579   Result.clear();
 580   Result.push_back(std::make_pair(FromBB,
 581                                   MemDepResult::getClobber(FromBB->begin())));
 582 }
 583
 584 /// GetNonLocalInfoForBlock - Compute the memdep value for BB with
 585 /// Pointer/PointeeSize using either cached information in Cache or by doing a
 586 /// lookup (which may use dirty cache info if available).  If we do a lookup,
 587 /// add the result to the cache.
 588 MemDepResult MemoryDependenceAnalysis::
 589 GetNonLocalInfoForBlock(Value *Pointer, uint64_t PointeeSize,
 590                         bool isLoad, BasicBlock *BB,
 591                         NonLocalDepInfo *Cache, unsigned NumSortedEntries) {
 592
 593   // Do a binary search to see if we already have an entry for this block in
 594   // the cache set.  If so, find it.
 595   NonLocalDepInfo::iterator Entry =
 596     std::upper_bound(Cache->begin(), Cache->begin()+NumSortedEntries,
 597                      std::make_pair(BB, MemDepResult()));
 598   if (Entry != Cache->begin() && prior(Entry)->first == BB)
 599     --Entry;
 600
 601   MemDepResult *ExistingResult = 0;
 602   if (Entry != Cache->begin()+NumSortedEntries && Entry->first == BB)
 603     ExistingResult = &Entry->second;
 604
 605   // If we have a cached entry, and it is non-dirty, use it as the value for
 606   // this dependency.
 607   if (ExistingResult && !ExistingResult->isDirty()) {
 608     ++NumCacheNonLocalPtr;
 609     return *ExistingResult;
 610   }
 611
 612   // Otherwise, we have to scan for the value.  If we have a dirty cache
 613   // entry, start scanning from its position, otherwise we scan from the end
 614   // of the block.
 615   BasicBlock::iterator ScanPos = BB->end();
 616   if (ExistingResult && ExistingResult->getInst()) {
 617     assert(ExistingResult->getInst()->getParent() == BB &&
 618            "Instruction invalidated?");
 619     ++NumCacheDirtyNonLocalPtr;
 620     ScanPos = ExistingResult->getInst();
 621
 622     // Eliminating the dirty entry from 'Cache', so update the reverse info.
 623     ValueIsLoadPair CacheKey(Pointer, isLoad);
 624     RemoveFromReverseMap(ReverseNonLocalPtrDeps, ScanPos, CacheKey);
 625   } else {
 626     ++NumUncacheNonLocalPtr;
 627   }
 628
 629   // Scan the block for the dependency.
 630   MemDepResult Dep = getPointerDependencyFrom(Pointer, PointeeSize, isLoad,
 631                                               ScanPos, BB);
 632
 633   // If we had a dirty entry for the block, update it.  Otherwise, just add
 634   // a new entry.
 635   if (ExistingResult)
 636     *ExistingResult = Dep;
 637   else
 638     Cache->push_back(std::make_pair(BB, Dep));
 639
 640   // If the block has a dependency (i.e. it isn't completely transparent to
 641   // the value), remember the reverse association because we just added it
 642   // to Cache!
 643   if (Dep.isNonLocal())
 644     return Dep;
 645
 646   // Keep the ReverseNonLocalPtrDeps map up to date so we can efficiently
 647   // update MemDep when we remove instructions.
 648   Instruction *Inst = Dep.getInst();
 649   assert(Inst && "Didn't depend on anything?");
 650   ValueIsLoadPair CacheKey(Pointer, isLoad);
 651   ReverseNonLocalPtrDeps[Inst].insert(CacheKey);
 652   return Dep;
 653 }
 654
 655 /// SortNonLocalDepInfoCache - Sort the a NonLocalDepInfo cache, given a certain
 656 /// number of elements in the array that are already properly ordered.  This is
 657 /// optimized for the case when only a few entries are added.
 658 static void
 659 SortNonLocalDepInfoCache(MemoryDependenceAnalysis::NonLocalDepInfo &Cache,
 660                          unsigned NumSortedEntries) {
 661   switch (Cache.size() - NumSortedEntries) {
 662   case 0:
 663     // done, no new entries.
 664     break;
 665   case 2: {
 666     // Two new entries, insert the last one into place.
 667     MemoryDependenceAnalysis::NonLocalDepEntry Val = Cache.back();
 668     Cache.pop_back();
 669     MemoryDependenceAnalysis::NonLocalDepInfo::iterator Entry =
 670       std::upper_bound(Cache.begin(), Cache.end()-1, Val);
 671     Cache.insert(Entry, Val);
 672     // FALL THROUGH.
 673   }
 674   case 1:
 675     // One new entry, Just insert the new value at the appropriate position.
 676     if (Cache.size() != 1) {
 677       MemoryDependenceAnalysis::NonLocalDepEntry Val = Cache.back();
 678       Cache.pop_back();
 679       MemoryDependenceAnalysis::NonLocalDepInfo::iterator Entry =
 680         std::upper_bound(Cache.begin(), Cache.end(), Val);
 681       Cache.insert(Entry, Val);
 682     }
 683     break;
 684   default:
 685     // Added many values, do a full scale sort.
 686     std::sort(Cache.begin(), Cache.end());
 687     break;
 688   }
 689 }
 690
 691
 692 /// getNonLocalPointerDepFromBB - Perform a dependency query based on
 693 /// pointer/pointeesize starting at the end of StartBB.  Add any clobber/def
 694 /// results to the results vector and keep track of which blocks are visited in
 695 /// 'Visited'.
 696 ///
 697 /// This has special behavior for the first block queries (when SkipFirstBlock
 698 /// is true).  In this special case, it ignores the contents of the specified
 699 /// block and starts returning dependence info for its predecessors.
 700 ///
 701 /// This function returns false on success, or true to indicate that it could
 702 /// not compute dependence information for some reason.  This should be treated
 703 /// as a clobber dependence on the first instruction in the predecessor block.
 704 bool MemoryDependenceAnalysis::
 705 getNonLocalPointerDepFromBB(Value *Pointer, uint64_t PointeeSize,
 706                             bool isLoad, BasicBlock *StartBB,
 707                             SmallVectorImpl<NonLocalDepEntry> &Result,
 708                             DenseMap<BasicBlock*, Value*> &Visited,
 709                             bool SkipFirstBlock) {
 710
 711   // Look up the cached info for Pointer.
 712   ValueIsLoadPair CacheKey(Pointer, isLoad);
 713
 714   std::pair<BBSkipFirstBlockPair, NonLocalDepInfo> *CacheInfo =
 715     &NonLocalPointerDeps[CacheKey];
 716   NonLocalDepInfo *Cache = &CacheInfo->second;
 717
 718   // If we have valid cached information for exactly the block we are
 719   // investigating, just return it with no recomputation.
 720   if (CacheInfo->first == BBSkipFirstBlockPair(StartBB, SkipFirstBlock)) {
 721     // We have a fully cached result for this query then we can just return the
 722     // cached results and populate the visited set.  However, we have to verify
 723     // that we don't already have conflicting results for these blocks.  Check
 724     // to ensure that if a block in the results set is in the visited set that
 725     // it was for the same pointer query.
 726     if (!Visited.empty()) {
 727       for (NonLocalDepInfo::iterator I = Cache->begin(), E = Cache->end();
 728            I != E; ++I) {
 729         DenseMap<BasicBlock*, Value*>::iterator VI = Visited.find(I->first);
 730         if (VI == Visited.end() || VI->second == Pointer) continue;
 731
 732         // We have a pointer mismatch in a block.  Just return clobber, saying
 733         // that something was clobbered in this result.  We could also do a
 734         // non-fully cached query, but there is little point in doing this.
 735         return true;
 736       }
 737     }
 738
 739     for (NonLocalDepInfo::iterator I = Cache->begin(), E = Cache->end();
 740          I != E; ++I) {
 741       Visited.insert(std::make_pair(I->first, Pointer));
 742       if (!I->second.isNonLocal())
 743         Result.push_back(*I);
 744     }
 745     ++NumCacheCompleteNonLocalPtr;
 746     return false;
 747   }
 748
 749   // Otherwise, either this is a new block, a block with an invalid cache
 750   // pointer or one that we're about to invalidate by putting more info into it
 751   // than its valid cache info.  If empty, the result will be valid cache info,
 752   // otherwise it isn't.
 753   if (Cache->empty())
 754     CacheInfo->first = BBSkipFirstBlockPair(StartBB, SkipFirstBlock);
 755   else
 756     CacheInfo->first = BBSkipFirstBlockPair();
 757
 758   SmallVector<BasicBlock*, 32> Worklist;
 759   Worklist.push_back(StartBB);
 760
 761   // Keep track of the entries that we know are sorted.  Previously cached
 762   // entries will all be sorted.  The entries we add we only sort on demand (we
 763   // don't insert every element into its sorted position).  We know that we
 764   // won't get any reuse from currently inserted values, because we don't
 765   // revisit blocks after we insert info for them.
 766   unsigned NumSortedEntries = Cache->size();
 767   DEBUG(AssertSorted(*Cache));
 768
 769   while (!Worklist.empty()) {
 770     BasicBlock *BB = Worklist.pop_back_val();
 771
 772     // Skip the first block if we have it.
 773     if (!SkipFirstBlock) {
 774       // Analyze the dependency of *Pointer in FromBB.  See if we already have
 775       // been here.
 776       assert(Visited.count(BB) && "Should check 'visited' before adding to WL");
 777
 778       // Get the dependency info for Pointer in BB.  If we have cached
 779       // information, we will use it, otherwise we compute it.
 780       DEBUG(AssertSorted(*Cache, NumSortedEntries));
 781       MemDepResult Dep = GetNonLocalInfoForBlock(Pointer, PointeeSize, isLoad,
 782                                                  BB, Cache, NumSortedEntries);
 783
 784       // If we got a Def or Clobber, add this to the list of results.
 785       if (!Dep.isNonLocal()) {
 786         Result.push_back(NonLocalDepEntry(BB, Dep));
 787         continue;
 788       }
 789     }
 790
 791     // If 'Pointer' is an instruction defined in this block, then we need to do
 792     // phi translation to change it into a value live in the predecessor block.
 793     // If phi translation fails, then we can't continue dependence analysis.
 794     Instruction *PtrInst = dyn_cast<Instruction>(Pointer);
 795     bool NeedsPHITranslation = PtrInst && PtrInst->getParent() == BB;
 796
 797     // If no PHI translation is needed, just add all the predecessors of this
 798     // block to scan them as well.
 799     if (!NeedsPHITranslation) {
 800       SkipFirstBlock = false;
 801       for (BasicBlock **PI = PredCache->GetPreds(BB); *PI; ++PI) {
 802         // Verify that we haven't looked at this block yet.
 803         std::pair<DenseMap<BasicBlock*,Value*>::iterator, bool>
 804           InsertRes = Visited.insert(std::make_pair(*PI, Pointer));
 805         if (InsertRes.second) {
 806           // First time we've looked at *PI.
 807           Worklist.push_back(*PI);
 808           continue;
 809         }
 810
 811         // If we have seen this block before, but it was with a different
 812         // pointer then we have a phi translation failure and we have to treat
 813         // this as a clobber.
 814         if (InsertRes.first->second != Pointer)
 815           goto PredTranslationFailure;
 816       }
 817       continue;
 818     }
 819
 820     // If we do need to do phi translation, then there are a bunch of different
 821     // cases, because we have to find a Value* live in the predecessor block. We
 822     // know that PtrInst is defined in this block at least.
 823
 824     // We may have added values to the cache list before this PHI translation.
 825     // If so, we haven't done anything to ensure that the cache remains sorted.
 826     // Sort it now (if needed) so that recursive invocations of
 827     // getNonLocalPointerDepFromBB and other routines that could reuse the cache
 828     // value will only see properly sorted cache arrays.
 829     if (Cache && NumSortedEntries != Cache->size()) {
 830       SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
 831       NumSortedEntries = Cache->size();
 832     }
 833
 834     // If this is directly a PHI node, just use the incoming values for each
 835     // pred as the phi translated version.
 836     if (PHINode *PtrPHI = dyn_cast<PHINode>(PtrInst)) {
 837       Cache = 0;
 838
 839       for (BasicBlock **PI = PredCache->GetPreds(BB); *PI; ++PI) {
 840         BasicBlock *Pred = *PI;
 841         Value *PredPtr = PtrPHI->getIncomingValueForBlock(Pred);
 842
 843         // Check to see if we have already visited this pred block with another
 844         // pointer.  If so, we can't do this lookup.  This failure can occur
 845         // with PHI translation when a critical edge exists and the PHI node in
 846         // the successor translates to a pointer value different than the
 847         // pointer the block was first analyzed with.
 848         std::pair<DenseMap<BasicBlock*,Value*>::iterator, bool>
 849           InsertRes = Visited.insert(std::make_pair(Pred, PredPtr));
 850
 851         if (!InsertRes.second) {
 852           // If the predecessor was visited with PredPtr, then we already did
 853           // the analysis and can ignore it.
 854           if (InsertRes.first->second == PredPtr)
 855             continue;
 856
 857           // Otherwise, the block was previously analyzed with a different
 858           // pointer.  We can't represent the result of this case, so we just
 859           // treat this as a phi translation failure.
 860           goto PredTranslationFailure;
 861         }
 862
 863         // FIXME: it is entirely possible that PHI translating will end up with
 864         // the same value.  Consider PHI translating something like:
 865         // X = phi [x, bb1], [y, bb2].  PHI translating for bb1 doesn't *need*
 866         // to recurse here, pedantically speaking.
 867
 868         // If we have a problem phi translating, fall through to the code below
 869         // to handle the failure condition.
 870         if (getNonLocalPointerDepFromBB(PredPtr, PointeeSize, isLoad, Pred,
 871                                         Result, Visited))
 872           goto PredTranslationFailure;
 873       }
 874
 875       // Refresh the CacheInfo/Cache pointer so that it isn't invalidated.
 876       CacheInfo = &NonLocalPointerDeps[CacheKey];
 877       Cache = &CacheInfo->second;
 878       NumSortedEntries = Cache->size();
 879
 880       // Since we did phi translation, the "Cache" set won't contain all of the
 881       // results for the query.  This is ok (we can still use it to accelerate
 882       // specific block queries) but we can't do the fastpath "return all
 883       // results from the set"  Clear out the indicator for this.
 884       CacheInfo->first = BBSkipFirstBlockPair();
 885       SkipFirstBlock = false;
 886       continue;
 887     }
 888
 889     // TODO: BITCAST, GEP.
 890
 891     //   cerr << "MEMDEP: Could not PHI translate: " << *Pointer;
 892     //   if (isa<BitCastInst>(PtrInst) || isa<GetElementPtrInst>(PtrInst))
 893     //     cerr << "OP:\t\t\t\t" << *PtrInst->getOperand(0);
 894   PredTranslationFailure:
 895
 896     if (Cache == 0) {
 897       // Refresh the CacheInfo/Cache pointer if it got invalidated.
 898       CacheInfo = &NonLocalPointerDeps[CacheKey];
 899       Cache = &CacheInfo->second;
 900       NumSortedEntries = Cache->size();
 901     }
 902
 903     // Since we did phi translation, the "Cache" set won't contain all of the
 904     // results for the query.  This is ok (we can still use it to accelerate
 905     // specific block queries) but we can't do the fastpath "return all
 906     // results from the set"  Clear out the indicator for this.
 907     CacheInfo->first = BBSkipFirstBlockPair();
 908
 909     // If *nothing* works, mark the pointer as being clobbered by the first
 910     // instruction in this block.
 911     //
 912     // If this is the magic first block, return this as a clobber of the whole
 913     // incoming value.  Since we can't phi translate to one of the predecessors,
 914     // we have to bail out.
 915     if (SkipFirstBlock)
 916       return true;
 917
 918     for (NonLocalDepInfo::reverse_iterator I = Cache->rbegin(); ; ++I) {
 919       assert(I != Cache->rend() && "Didn't find current block??");
 920       if (I->first != BB)
 921         continue;
 922
 923       assert(I->second.isNonLocal() &&
 924              "Should only be here with transparent block");
 925       I->second = MemDepResult::getClobber(BB->begin());
 926       ReverseNonLocalPtrDeps[BB->begin()].insert(CacheKey);
 927       Result.push_back(*I);
 928       break;
 929     }
 930   }
 931
 932   // Okay, we're done now.  If we added new values to the cache, re-sort it.
 933   SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
 934   DEBUG(AssertSorted(*Cache));
 935   return false;
 936 }
 937
 938 /// RemoveCachedNonLocalPointerDependencies - If P exists in
 939 /// CachedNonLocalPointerInfo, remove it.
 940 void MemoryDependenceAnalysis::
 941 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair P) {
 942   CachedNonLocalPointerInfo::iterator It =
 943     NonLocalPointerDeps.find(P);
 944   if (It == NonLocalPointerDeps.end()) return;
 945
 946   // Remove all of the entries in the BB->val map.  This involves removing
 947   // instructions from the reverse map.
 948   NonLocalDepInfo &PInfo = It->second.second;
 949
 950   for (unsigned i = 0, e = PInfo.size(); i != e; ++i) {
 951     Instruction *Target = PInfo[i].second.getInst();
 952     if (Target == 0) continue;  // Ignore non-local dep results.
 953     assert(Target->getParent() == PInfo[i].first);
 954
 955     // Eliminating the dirty entry from 'Cache', so update the reverse info.
 956     RemoveFromReverseMap(ReverseNonLocalPtrDeps, Target, P);
 957   }
 958
 959   // Remove P from NonLocalPointerDeps (which deletes NonLocalDepInfo).
 960   NonLocalPointerDeps.erase(It);
 961 }
 962
 963
 964 /// invalidateCachedPointerInfo - This method is used to invalidate cached
 965 /// information about the specified pointer, because it may be too
 966 /// conservative in memdep.  This is an optional call that can be used when
 967 /// the client detects an equivalence between the pointer and some other
 968 /// value and replaces the other value with ptr. This can make Ptr available
 969 /// in more places that cached info does not necessarily keep.
 970 void MemoryDependenceAnalysis::invalidateCachedPointerInfo(Value *Ptr) {
 971   // If Ptr isn't really a pointer, just ignore it.
 972   if (!isa<PointerType>(Ptr->getType())) return;
 973   // Flush store info for the pointer.
 974   RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, false));
 975   // Flush load info for the pointer.
 976   RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, true));
 977 }
 978
 979 /// removeInstruction - Remove an instruction from the dependence analysis,
 980 /// updating the dependence of instructions that previously depended on it.
 981 /// This method attempts to keep the cache coherent using the reverse map.
 982 void MemoryDependenceAnalysis::removeInstruction(Instruction *RemInst) {
 983   // Walk through the Non-local dependencies, removing this one as the value
 984   // for any cached queries.
 985   NonLocalDepMapType::iterator NLDI = NonLocalDeps.find(RemInst);
 986   if (NLDI != NonLocalDeps.end()) {
 987     NonLocalDepInfo &BlockMap = NLDI->second.first;
 988     for (NonLocalDepInfo::iterator DI = BlockMap.begin(), DE = BlockMap.end();
 989          DI != DE; ++DI)
 990       if (Instruction *Inst = DI->second.getInst())
 991         RemoveFromReverseMap(ReverseNonLocalDeps, Inst, RemInst);
 992     NonLocalDeps.erase(NLDI);
 993   }
 994
 995   // If we have a cached local dependence query for this instruction, remove it.
 996   //
 997   LocalDepMapType::iterator LocalDepEntry = LocalDeps.find(RemInst);
 998   if (LocalDepEntry != LocalDeps.end()) {
 999     // Remove us from DepInst's reverse set now that the local dep info is gone.
1000     if (Instruction *Inst = LocalDepEntry->second.getInst())
1001       RemoveFromReverseMap(ReverseLocalDeps, Inst, RemInst);
1002
1003     // Remove this local dependency info.
1004     LocalDeps.erase(LocalDepEntry);
1005   }
1006
1007   // If we have any cached pointer dependencies on this instruction, remove
1008   // them.  If the instruction has non-pointer type, then it can't be a pointer
1009   // base.
1010
1011   // Remove it from both the load info and the store info.  The instruction
1012   // can't be in either of these maps if it is non-pointer.
1013   if (isa<PointerType>(RemInst->getType())) {
1014     RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, false));
1015     RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, true));
1016   }
1017
1018   // Loop over all of the things that depend on the instruction we're removing.
1019   //
1020   SmallVector<std::pair<Instruction*, Instruction*>, 8> ReverseDepsToAdd;
1021
1022   // If we find RemInst as a clobber or Def in any of the maps for other values,
1023   // we need to replace its entry with a dirty version of the instruction after
1024   // it.  If RemInst is a terminator, we use a null dirty value.
1025   //
1026   // Using a dirty version of the instruction after RemInst saves having to scan
1027   // the entire block to get to this point.
1028   MemDepResult NewDirtyVal;
1029   if (!RemInst->isTerminator())
1030     NewDirtyVal = MemDepResult::getDirty(++BasicBlock::iterator(RemInst));
1031
1032   ReverseDepMapType::iterator ReverseDepIt = ReverseLocalDeps.find(RemInst);
1033   if (ReverseDepIt != ReverseLocalDeps.end()) {
1034     SmallPtrSet<Instruction*, 4> &ReverseDeps = ReverseDepIt->second;
1035     // RemInst can't be the terminator if it has local stuff depending on it.
1036     assert(!ReverseDeps.empty() && !isa<TerminatorInst>(RemInst) &&
1037            "Nothing can locally depend on a terminator");
1038
1039     for (SmallPtrSet<Instruction*, 4>::iterator I = ReverseDeps.begin(),
1040          E = ReverseDeps.end(); I != E; ++I) {
1041       Instruction *InstDependingOnRemInst = *I;
1042       assert(InstDependingOnRemInst != RemInst &&
1043              "Already removed our local dep info");
1044
1045       LocalDeps[InstDependingOnRemInst] = NewDirtyVal;
1046
1047       // Make sure to remember that new things depend on NewDepInst.
1048       assert(NewDirtyVal.getInst() && "There is no way something else can have "
1049              "a local dep on this if it is a terminator!");
1050       ReverseDepsToAdd.push_back(std::make_pair(NewDirtyVal.getInst(),
1051                                                 InstDependingOnRemInst));
1052     }
1053
1054     ReverseLocalDeps.erase(ReverseDepIt);
1055
1056     // Add new reverse deps after scanning the set, to avoid invalidating the
1057     // 'ReverseDeps' reference.
1058     while (!ReverseDepsToAdd.empty()) {
1059       ReverseLocalDeps[ReverseDepsToAdd.back().first]
1060         .insert(ReverseDepsToAdd.back().second);
1061       ReverseDepsToAdd.pop_back();
1062     }
1063   }
1064
1065   ReverseDepIt = ReverseNonLocalDeps.find(RemInst);
1066   if (ReverseDepIt != ReverseNonLocalDeps.end()) {
1067     SmallPtrSet<Instruction*, 4> &Set = ReverseDepIt->second;
1068     for (SmallPtrSet<Instruction*, 4>::iterator I = Set.begin(), E = Set.end();
1069          I != E; ++I) {
1070       assert(*I != RemInst && "Already removed NonLocalDep info for RemInst");
1071
1072       PerInstNLInfo &INLD = NonLocalDeps[*I];
1073       // The information is now dirty!
1074       INLD.second = true;
1075
1076       for (NonLocalDepInfo::iterator DI = INLD.first.begin(),
1077            DE = INLD.first.end(); DI != DE; ++DI) {
1078         if (DI->second.getInst() != RemInst) continue;
1079
1080         // Convert to a dirty entry for the subsequent instruction.
1081         DI->second = NewDirtyVal;
1082
1083         if (Instruction *NextI = NewDirtyVal.getInst())
1084           ReverseDepsToAdd.push_back(std::make_pair(NextI, *I));
1085       }
1086     }
1087
1088     ReverseNonLocalDeps.erase(ReverseDepIt);
1089
1090     // Add new reverse deps after scanning the set, to avoid invalidating 'Set'
1091     while (!ReverseDepsToAdd.empty()) {
1092       ReverseNonLocalDeps[ReverseDepsToAdd.back().first]
1093         .insert(ReverseDepsToAdd.back().second);
1094       ReverseDepsToAdd.pop_back();
1095     }
1096   }
1097
1098   // If the instruction is in ReverseNonLocalPtrDeps then it appears as a
1099   // value in the NonLocalPointerDeps info.
1100   ReverseNonLocalPtrDepTy::iterator ReversePtrDepIt =
1101     ReverseNonLocalPtrDeps.find(RemInst);
1102   if (ReversePtrDepIt != ReverseNonLocalPtrDeps.end()) {
1103     SmallPtrSet<ValueIsLoadPair, 4> &Set = ReversePtrDepIt->second;
1104     SmallVector<std::pair<Instruction*, ValueIsLoadPair>,8> ReversePtrDepsToAdd;
1105
1106     for (SmallPtrSet<ValueIsLoadPair, 4>::iterator I = Set.begin(),
1107          E = Set.end(); I != E; ++I) {
1108       ValueIsLoadPair P = *I;
1109       assert(P.getPointer() != RemInst &&
1110              "Already removed NonLocalPointerDeps info for RemInst");
1111
1112       NonLocalDepInfo &NLPDI = NonLocalPointerDeps[P].second;
1113
1114       // The cache is not valid for any specific block anymore.
1115       NonLocalPointerDeps[P].first = BBSkipFirstBlockPair();
1116
1117       // Update any entries for RemInst to use the instruction after it.
1118       for (NonLocalDepInfo::iterator DI = NLPDI.begin(), DE = NLPDI.end();
1119            DI != DE; ++DI) {
1120         if (DI->second.getInst() != RemInst) continue;
1121
1122         // Convert to a dirty entry for the subsequent instruction.
1123         DI->second = NewDirtyVal;
1124
1125         if (Instruction *NewDirtyInst = NewDirtyVal.getInst())
1126           ReversePtrDepsToAdd.push_back(std::make_pair(NewDirtyInst, P));
1127       }
1128
1129       // Re-sort the NonLocalDepInfo.  Changing the dirty entry to its
1130       // subsequent value may invalidate the sortedness.
1131       std::sort(NLPDI.begin(), NLPDI.end());
1132     }
1133
1134     ReverseNonLocalPtrDeps.erase(ReversePtrDepIt);
1135
1136     while (!ReversePtrDepsToAdd.empty()) {
1137       ReverseNonLocalPtrDeps[ReversePtrDepsToAdd.back().first]
1138         .insert(ReversePtrDepsToAdd.back().second);
1139       ReversePtrDepsToAdd.pop_back();
1140     }
1141   }
1142
1143
1144   assert(!NonLocalDeps.count(RemInst) && "RemInst got reinserted?");
1145   AA->deleteValue(RemInst);
1146   DEBUG(verifyRemoved(RemInst));
1147 }
1148 /// verifyRemoved - Verify that the specified instruction does not occur
1149 /// in our internal data structures.
1150 void MemoryDependenceAnalysis::verifyRemoved(Instruction *D) const {
1151   for (LocalDepMapType::const_iterator I = LocalDeps.begin(),
1152        E = LocalDeps.end(); I != E; ++I) {
1153     assert(I->first != D && "Inst occurs in data structures");
1154     assert(I->second.getInst() != D &&
1155            "Inst occurs in data structures");
1156   }
1157
1158   for (CachedNonLocalPointerInfo::const_iterator I =NonLocalPointerDeps.begin(),
1159        E = NonLocalPointerDeps.end(); I != E; ++I) {
1160     assert(I->first.getPointer() != D && "Inst occurs in NLPD map key");
1161     const NonLocalDepInfo &Val = I->second.second;
1162     for (NonLocalDepInfo::const_iterator II = Val.begin(), E = Val.end();
1163          II != E; ++II)
1164       assert(II->second.getInst() != D && "Inst occurs as NLPD value");
1165   }
1166
1167   for (NonLocalDepMapType::const_iterator I = NonLocalDeps.begin(),
1168        E = NonLocalDeps.end(); I != E; ++I) {
1169     assert(I->first != D && "Inst occurs in data structures");
1170     const PerInstNLInfo &INLD = I->second;
1171     for (NonLocalDepInfo::const_iterator II = INLD.first.begin(),
1172          EE = INLD.first.end(); II  != EE; ++II)
1173       assert(II->second.getInst() != D && "Inst occurs in data structures");
1174   }
1175
1176   for (ReverseDepMapType::const_iterator I = ReverseLocalDeps.begin(),
1177        E = ReverseLocalDeps.end(); I != E; ++I) {
1178     assert(I->first != D && "Inst occurs in data structures");
1179     for (SmallPtrSet<Instruction*, 4>::const_iterator II = I->second.begin(),
1180          EE = I->second.end(); II != EE; ++II)
1181       assert(*II != D && "Inst occurs in data structures");
1182   }
1183
1184   for (ReverseDepMapType::const_iterator I = ReverseNonLocalDeps.begin(),
1185        E = ReverseNonLocalDeps.end();
1186        I != E; ++I) {
1187     assert(I->first != D && "Inst occurs in data structures");
1188     for (SmallPtrSet<Instruction*, 4>::const_iterator II = I->second.begin(),
1189          EE = I->second.end(); II != EE; ++II)
1190       assert(*II != D && "Inst occurs in data structures");
1191   }
1192
1193   for (ReverseNonLocalPtrDepTy::const_iterator
1194        I = ReverseNonLocalPtrDeps.begin(),
1195        E = ReverseNonLocalPtrDeps.end(); I != E; ++I) {
1196     assert(I->first != D && "Inst occurs in rev NLPD map");
1197
1198     for (SmallPtrSet<ValueIsLoadPair, 4>::const_iterator II = I->second.begin(),
1199          E = I->second.end(); II != E; ++II)
1200       assert(*II != ValueIsLoadPair(D, false) &&
1201              *II != ValueIsLoadPair(D, true) &&
1202              "Inst occurs in ReverseNonLocalPtrDeps map");
1203   }
1204
1205 }