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