~ubuntu-branches/ubuntu/hardy/clamav/hardy-security

« back to all changes in this revision

Viewing changes to libclamav/c++/llvm/lib/Analysis/MemoryDependenceAnalysis.cpp

  • Committer: Package Import Robot
  • Author(s): Scott Kitterman, Marc Deslauriers, Scott Kitterman
  • Date: 2013-03-21 08:37:54 UTC
  • mfrom: (43.1.79 raring-proposed)
  • Revision ID: package-import@ubuntu.com-20130321083754-r3dnl8aewkny2rxu
Tags: 0.97.7+dfsg-1ubuntu0.08.04.1
[ Marc Deslauriers ]
* SECURITY UPDATE: Updated to 0.97.7 to fix multiple security issues.
  (LP: #1157385)
  - CVE numbers pending

[ Scott Kitterman ]
* Changes to adapt to Hardy:
  - Build without llvm support on lpia to fix FTBFS (not a regression as
    llvm has never built on hardy lpia)
  - Drop -T -W from apparmor_parser calls in clamav-daemon and freshclam
    postinsts since it is not supported in Hardy's apparmor
  - Drop deny rule in freshclam apparmor profile since deny is not
    supported in Hardy's apparmor
  - Drop dh_lintian from debian/rules and adjust version of debhelper
    build-dep
  - Drop build-dep and libclamav-dev depends on non-existent libtommath-dev
  - Changed Section to 'utils' for clamav-dbg package
  - Ignore test suite errors on hppa
  - Build-depend on libltdl3-dev instead of libltdl-dev
  - Drop hardening flags changes
  - Drop unneeded versioning on lsb-base (clamav ships it's own status
    function)

Show diffs side-by-side

added added

removed removed

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