2e927ed7816765dab7205c087fb21db3ff8ad29c
[oota-llvm.git] / lib / Analysis / BasicAliasAnalysis.cpp
1 //===- BasicAliasAnalysis.cpp - Stateless Alias Analysis Impl -------------===//
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 defines the primary stateless implementation of the
11 // Alias Analysis interface that implements identities (two different
12 // globals cannot alias, etc), but does no stateful analysis.
13 //
14 //===----------------------------------------------------------------------===//
15
16 #include "llvm/Analysis/BasicAliasAnalysis.h"
17 #include "llvm/ADT/SmallVector.h"
18 #include "llvm/ADT/Statistic.h"
19 #include "llvm/Analysis/AliasAnalysis.h"
20 #include "llvm/Analysis/CFG.h"
21 #include "llvm/Analysis/CaptureTracking.h"
22 #include "llvm/Analysis/InstructionSimplify.h"
23 #include "llvm/Analysis/LoopInfo.h"
24 #include "llvm/Analysis/MemoryBuiltins.h"
25 #include "llvm/Analysis/ValueTracking.h"
26 #include "llvm/Analysis/AssumptionCache.h"
27 #include "llvm/IR/Constants.h"
28 #include "llvm/IR/DataLayout.h"
29 #include "llvm/IR/DerivedTypes.h"
30 #include "llvm/IR/Dominators.h"
31 #include "llvm/IR/GlobalAlias.h"
32 #include "llvm/IR/GlobalVariable.h"
33 #include "llvm/IR/Instructions.h"
34 #include "llvm/IR/IntrinsicInst.h"
35 #include "llvm/IR/LLVMContext.h"
36 #include "llvm/IR/Operator.h"
37 #include "llvm/Pass.h"
38 #include "llvm/Support/ErrorHandling.h"
39 #include <algorithm>
40 using namespace llvm;
41
42 /// Enable analysis of recursive PHI nodes.
43 static cl::opt<bool> EnableRecPhiAnalysis("basicaa-recphi", cl::Hidden,
44                                           cl::init(false));
45
46 /// SearchLimitReached / SearchTimes shows how often the limit of
47 /// to decompose GEPs is reached. It will affect the precision
48 /// of basic alias analysis.
49 #define DEBUG_TYPE "basicaa"
50 STATISTIC(SearchLimitReached, "Number of times the limit to "
51                               "decompose GEPs is reached");
52 STATISTIC(SearchTimes, "Number of times a GEP is decomposed");
53
54 /// Cutoff after which to stop analysing a set of phi nodes potentially involved
55 /// in a cycle. Because we are analysing 'through' phi nodes we need to be
56 /// careful with value equivalence. We use reachability to make sure a value
57 /// cannot be involved in a cycle.
58 const unsigned MaxNumPhiBBsValueReachabilityCheck = 20;
59
60 // The max limit of the search depth in DecomposeGEPExpression() and
61 // GetUnderlyingObject(), both functions need to use the same search
62 // depth otherwise the algorithm in aliasGEP will assert.
63 static const unsigned MaxLookupSearchDepth = 6;
64
65 //===----------------------------------------------------------------------===//
66 // Useful predicates
67 //===----------------------------------------------------------------------===//
68
69 /// Returns true if the pointer is to a function-local object that never
70 /// escapes from the function.
71 static bool isNonEscapingLocalObject(const Value *V) {
72   // If this is a local allocation, check to see if it escapes.
73   if (isa<AllocaInst>(V) || isNoAliasCall(V))
74     // Set StoreCaptures to True so that we can assume in our callers that the
75     // pointer is not the result of a load instruction. Currently
76     // PointerMayBeCaptured doesn't have any special analysis for the
77     // StoreCaptures=false case; if it did, our callers could be refined to be
78     // more precise.
79     return !PointerMayBeCaptured(V, false, /*StoreCaptures=*/true);
80
81   // If this is an argument that corresponds to a byval or noalias argument,
82   // then it has not escaped before entering the function.  Check if it escapes
83   // inside the function.
84   if (const Argument *A = dyn_cast<Argument>(V))
85     if (A->hasByValAttr() || A->hasNoAliasAttr())
86       // Note even if the argument is marked nocapture we still need to check
87       // for copies made inside the function. The nocapture attribute only
88       // specifies that there are no copies made that outlive the function.
89       return !PointerMayBeCaptured(V, false, /*StoreCaptures=*/true);
90
91   return false;
92 }
93
94 /// Returns true if the pointer is one which would have been considered an
95 /// escape by isNonEscapingLocalObject.
96 static bool isEscapeSource(const Value *V) {
97   if (isa<CallInst>(V) || isa<InvokeInst>(V) || isa<Argument>(V))
98     return true;
99
100   // The load case works because isNonEscapingLocalObject considers all
101   // stores to be escapes (it passes true for the StoreCaptures argument
102   // to PointerMayBeCaptured).
103   if (isa<LoadInst>(V))
104     return true;
105
106   return false;
107 }
108
109 /// Returns the size of the object specified by V, or UnknownSize if unknown.
110 static uint64_t getObjectSize(const Value *V, const DataLayout &DL,
111                               const TargetLibraryInfo &TLI,
112                               bool RoundToAlign = false) {
113   uint64_t Size;
114   if (getObjectSize(V, Size, DL, &TLI, RoundToAlign))
115     return Size;
116   return MemoryLocation::UnknownSize;
117 }
118
119 /// Returns true if we can prove that the object specified by V is smaller than
120 /// Size.
121 static bool isObjectSmallerThan(const Value *V, uint64_t Size,
122                                 const DataLayout &DL,
123                                 const TargetLibraryInfo &TLI) {
124   // Note that the meanings of the "object" are slightly different in the
125   // following contexts:
126   //    c1: llvm::getObjectSize()
127   //    c2: llvm.objectsize() intrinsic
128   //    c3: isObjectSmallerThan()
129   // c1 and c2 share the same meaning; however, the meaning of "object" in c3
130   // refers to the "entire object".
131   //
132   //  Consider this example:
133   //     char *p = (char*)malloc(100)
134   //     char *q = p+80;
135   //
136   //  In the context of c1 and c2, the "object" pointed by q refers to the
137   // stretch of memory of q[0:19]. So, getObjectSize(q) should return 20.
138   //
139   //  However, in the context of c3, the "object" refers to the chunk of memory
140   // being allocated. So, the "object" has 100 bytes, and q points to the middle
141   // the "object". In case q is passed to isObjectSmallerThan() as the 1st
142   // parameter, before the llvm::getObjectSize() is called to get the size of
143   // entire object, we should:
144   //    - either rewind the pointer q to the base-address of the object in
145   //      question (in this case rewind to p), or
146   //    - just give up. It is up to caller to make sure the pointer is pointing
147   //      to the base address the object.
148   //
149   // We go for 2nd option for simplicity.
150   if (!isIdentifiedObject(V))
151     return false;
152
153   // This function needs to use the aligned object size because we allow
154   // reads a bit past the end given sufficient alignment.
155   uint64_t ObjectSize = getObjectSize(V, DL, TLI, /*RoundToAlign*/ true);
156
157   return ObjectSize != MemoryLocation::UnknownSize && ObjectSize < Size;
158 }
159
160 /// Returns true if we can prove that the object specified by V has size Size.
161 static bool isObjectSize(const Value *V, uint64_t Size, const DataLayout &DL,
162                          const TargetLibraryInfo &TLI) {
163   uint64_t ObjectSize = getObjectSize(V, DL, TLI);
164   return ObjectSize != MemoryLocation::UnknownSize && ObjectSize == Size;
165 }
166
167 //===----------------------------------------------------------------------===//
168 // GetElementPtr Instruction Decomposition and Analysis
169 //===----------------------------------------------------------------------===//
170
171 /// Analyzes the specified value as a linear expression: "A*V + B", where A and
172 /// B are constant integers.
173 ///
174 /// Returns the scale and offset values as APInts and return V as a Value*, and
175 /// return whether we looked through any sign or zero extends.  The incoming
176 /// Value is known to have IntegerType and it may already be sign or zero
177 /// extended.
178 ///
179 /// Note that this looks through extends, so the high bits may not be
180 /// represented in the result.
181 /*static*/ const Value *BasicAAResult::GetLinearExpression(
182     const Value *V, APInt &Scale, APInt &Offset, unsigned &ZExtBits,
183     unsigned &SExtBits, const DataLayout &DL, unsigned Depth,
184     AssumptionCache *AC, DominatorTree *DT, bool &NSW, bool &NUW) {
185   assert(V->getType()->isIntegerTy() && "Not an integer value");
186
187   // Limit our recursion depth.
188   if (Depth == 6) {
189     Scale = 1;
190     Offset = 0;
191     return V;
192   }
193
194   if (const ConstantInt *Const = dyn_cast<ConstantInt>(V)) {
195     // if it's a constant, just convert it to an offset and remove the variable.
196     // If we've been called recursively the Offset bit width will be greater
197     // than the constant's (the Offset's always as wide as the outermost call),
198     // so we'll zext here and process any extension in the isa<SExtInst> &
199     // isa<ZExtInst> cases below.
200     Offset += Const->getValue().zextOrSelf(Offset.getBitWidth());
201     assert(Scale == 0 && "Constant values don't have a scale");
202     return V;
203   }
204
205   if (const BinaryOperator *BOp = dyn_cast<BinaryOperator>(V)) {
206     if (ConstantInt *RHSC = dyn_cast<ConstantInt>(BOp->getOperand(1))) {
207
208       // If we've been called recursively then Offset and Scale will be wider
209       // that the BOp operands. We'll always zext it here as we'll process sign
210       // extensions below (see the isa<SExtInst> / isa<ZExtInst> cases).
211       APInt RHS = RHSC->getValue().zextOrSelf(Offset.getBitWidth());
212
213       switch (BOp->getOpcode()) {
214       default:
215         // We don't understand this instruction, so we can't decompose it any
216         // further.
217         Scale = 1;
218         Offset = 0;
219         return V;
220       case Instruction::Or:
221         // X|C == X+C if all the bits in C are unset in X.  Otherwise we can't
222         // analyze it.
223         if (!MaskedValueIsZero(BOp->getOperand(0), RHSC->getValue(), DL, 0, AC,
224                                BOp, DT)) {
225           Scale = 1;
226           Offset = 0;
227           return V;
228         }
229       // FALL THROUGH.
230       case Instruction::Add:
231         V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
232                                 SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
233         Offset += RHS;
234         break;
235       case Instruction::Sub:
236         V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
237                                 SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
238         Offset -= RHS;
239         break;
240       case Instruction::Mul:
241         V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
242                                 SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
243         Offset *= RHS;
244         Scale *= RHS;
245         break;
246       case Instruction::Shl:
247         V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
248                                 SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
249         Offset <<= RHS.getLimitedValue();
250         Scale <<= RHS.getLimitedValue();
251         // the semantics of nsw and nuw for left shifts don't match those of
252         // multiplications, so we won't propagate them.
253         NSW = NUW = false;
254         return V;
255       }
256
257       if (isa<OverflowingBinaryOperator>(BOp)) {
258         NUW &= BOp->hasNoUnsignedWrap();
259         NSW &= BOp->hasNoSignedWrap();
260       }
261       return V;
262     }
263   }
264
265   // Since GEP indices are sign extended anyway, we don't care about the high
266   // bits of a sign or zero extended value - just scales and offsets.  The
267   // extensions have to be consistent though.
268   if (isa<SExtInst>(V) || isa<ZExtInst>(V)) {
269     Value *CastOp = cast<CastInst>(V)->getOperand(0);
270     unsigned NewWidth = V->getType()->getPrimitiveSizeInBits();
271     unsigned SmallWidth = CastOp->getType()->getPrimitiveSizeInBits();
272     unsigned OldZExtBits = ZExtBits, OldSExtBits = SExtBits;
273     const Value *Result =
274         GetLinearExpression(CastOp, Scale, Offset, ZExtBits, SExtBits, DL,
275                             Depth + 1, AC, DT, NSW, NUW);
276
277     // zext(zext(%x)) == zext(%x), and similiarly for sext; we'll handle this
278     // by just incrementing the number of bits we've extended by.
279     unsigned ExtendedBy = NewWidth - SmallWidth;
280
281     if (isa<SExtInst>(V) && ZExtBits == 0) {
282       // sext(sext(%x, a), b) == sext(%x, a + b)
283
284       if (NSW) {
285         // We haven't sign-wrapped, so it's valid to decompose sext(%x + c)
286         // into sext(%x) + sext(c). We'll sext the Offset ourselves:
287         unsigned OldWidth = Offset.getBitWidth();
288         Offset = Offset.trunc(SmallWidth).sext(NewWidth).zextOrSelf(OldWidth);
289       } else {
290         // We may have signed-wrapped, so don't decompose sext(%x + c) into
291         // sext(%x) + sext(c)
292         Scale = 1;
293         Offset = 0;
294         Result = CastOp;
295         ZExtBits = OldZExtBits;
296         SExtBits = OldSExtBits;
297       }
298       SExtBits += ExtendedBy;
299     } else {
300       // sext(zext(%x, a), b) = zext(zext(%x, a), b) = zext(%x, a + b)
301
302       if (!NUW) {
303         // We may have unsigned-wrapped, so don't decompose zext(%x + c) into
304         // zext(%x) + zext(c)
305         Scale = 1;
306         Offset = 0;
307         Result = CastOp;
308         ZExtBits = OldZExtBits;
309         SExtBits = OldSExtBits;
310       }
311       ZExtBits += ExtendedBy;
312     }
313
314     return Result;
315   }
316
317   Scale = 1;
318   Offset = 0;
319   return V;
320 }
321
322 /// If V is a symbolic pointer expression, decompose it into a base pointer
323 /// with a constant offset and a number of scaled symbolic offsets.
324 ///
325 /// The scaled symbolic offsets (represented by pairs of a Value* and a scale
326 /// in the VarIndices vector) are Value*'s that are known to be scaled by the
327 /// specified amount, but which may have other unrepresented high bits. As
328 /// such, the gep cannot necessarily be reconstructed from its decomposed form.
329 ///
330 /// When DataLayout is around, this function is capable of analyzing everything
331 /// that GetUnderlyingObject can look through. To be able to do that
332 /// GetUnderlyingObject and DecomposeGEPExpression must use the same search
333 /// depth (MaxLookupSearchDepth). When DataLayout not is around, it just looks
334 /// through pointer casts.
335 /*static*/ const Value *BasicAAResult::DecomposeGEPExpression(
336     const Value *V, int64_t &BaseOffs,
337     SmallVectorImpl<VariableGEPIndex> &VarIndices, bool &MaxLookupReached,
338     const DataLayout &DL, AssumptionCache *AC, DominatorTree *DT) {
339   // Limit recursion depth to limit compile time in crazy cases.
340   unsigned MaxLookup = MaxLookupSearchDepth;
341   MaxLookupReached = false;
342   SearchTimes++;
343
344   BaseOffs = 0;
345   do {
346     // See if this is a bitcast or GEP.
347     const Operator *Op = dyn_cast<Operator>(V);
348     if (!Op) {
349       // The only non-operator case we can handle are GlobalAliases.
350       if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
351         if (!GA->mayBeOverridden()) {
352           V = GA->getAliasee();
353           continue;
354         }
355       }
356       return V;
357     }
358
359     if (Op->getOpcode() == Instruction::BitCast ||
360         Op->getOpcode() == Instruction::AddrSpaceCast) {
361       V = Op->getOperand(0);
362       continue;
363     }
364
365     const GEPOperator *GEPOp = dyn_cast<GEPOperator>(Op);
366     if (!GEPOp) {
367       // If it's not a GEP, hand it off to SimplifyInstruction to see if it
368       // can come up with something. This matches what GetUnderlyingObject does.
369       if (const Instruction *I = dyn_cast<Instruction>(V))
370         // TODO: Get a DominatorTree and AssumptionCache and use them here
371         // (these are both now available in this function, but this should be
372         // updated when GetUnderlyingObject is updated). TLI should be
373         // provided also.
374         if (const Value *Simplified =
375                 SimplifyInstruction(const_cast<Instruction *>(I), DL)) {
376           V = Simplified;
377           continue;
378         }
379
380       return V;
381     }
382
383     // Don't attempt to analyze GEPs over unsized objects.
384     if (!GEPOp->getOperand(0)->getType()->getPointerElementType()->isSized())
385       return V;
386
387     unsigned AS = GEPOp->getPointerAddressSpace();
388     // Walk the indices of the GEP, accumulating them into BaseOff/VarIndices.
389     gep_type_iterator GTI = gep_type_begin(GEPOp);
390     for (User::const_op_iterator I = GEPOp->op_begin() + 1, E = GEPOp->op_end();
391          I != E; ++I) {
392       const Value *Index = *I;
393       // Compute the (potentially symbolic) offset in bytes for this index.
394       if (StructType *STy = dyn_cast<StructType>(*GTI++)) {
395         // For a struct, add the member offset.
396         unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
397         if (FieldNo == 0)
398           continue;
399
400         BaseOffs += DL.getStructLayout(STy)->getElementOffset(FieldNo);
401         continue;
402       }
403
404       // For an array/pointer, add the element offset, explicitly scaled.
405       if (const ConstantInt *CIdx = dyn_cast<ConstantInt>(Index)) {
406         if (CIdx->isZero())
407           continue;
408         BaseOffs += DL.getTypeAllocSize(*GTI) * CIdx->getSExtValue();
409         continue;
410       }
411
412       uint64_t Scale = DL.getTypeAllocSize(*GTI);
413       unsigned ZExtBits = 0, SExtBits = 0;
414
415       // If the integer type is smaller than the pointer size, it is implicitly
416       // sign extended to pointer size.
417       unsigned Width = Index->getType()->getIntegerBitWidth();
418       unsigned PointerSize = DL.getPointerSizeInBits(AS);
419       if (PointerSize > Width)
420         SExtBits += PointerSize - Width;
421
422       // Use GetLinearExpression to decompose the index into a C1*V+C2 form.
423       APInt IndexScale(Width, 0), IndexOffset(Width, 0);
424       bool NSW = true, NUW = true;
425       Index = GetLinearExpression(Index, IndexScale, IndexOffset, ZExtBits,
426                                   SExtBits, DL, 0, AC, DT, NSW, NUW);
427
428       // The GEP index scale ("Scale") scales C1*V+C2, yielding (C1*V+C2)*Scale.
429       // This gives us an aggregate computation of (C1*Scale)*V + C2*Scale.
430       BaseOffs += IndexOffset.getSExtValue() * Scale;
431       Scale *= IndexScale.getSExtValue();
432
433       // If we already had an occurrence of this index variable, merge this
434       // scale into it.  For example, we want to handle:
435       //   A[x][x] -> x*16 + x*4 -> x*20
436       // This also ensures that 'x' only appears in the index list once.
437       for (unsigned i = 0, e = VarIndices.size(); i != e; ++i) {
438         if (VarIndices[i].V == Index && VarIndices[i].ZExtBits == ZExtBits &&
439             VarIndices[i].SExtBits == SExtBits) {
440           Scale += VarIndices[i].Scale;
441           VarIndices.erase(VarIndices.begin() + i);
442           break;
443         }
444       }
445
446       // Make sure that we have a scale that makes sense for this target's
447       // pointer size.
448       if (unsigned ShiftBits = 64 - PointerSize) {
449         Scale <<= ShiftBits;
450         Scale = (int64_t)Scale >> ShiftBits;
451       }
452
453       if (Scale) {
454         VariableGEPIndex Entry = {Index, ZExtBits, SExtBits,
455                                   static_cast<int64_t>(Scale)};
456         VarIndices.push_back(Entry);
457       }
458     }
459
460     // Analyze the base pointer next.
461     V = GEPOp->getOperand(0);
462   } while (--MaxLookup);
463
464   // If the chain of expressions is too deep, just return early.
465   MaxLookupReached = true;
466   SearchLimitReached++;
467   return V;
468 }
469
470 /// Returns whether the given pointer value points to memory that is local to
471 /// the function, with global constants being considered local to all
472 /// functions.
473 bool BasicAAResult::pointsToConstantMemory(const MemoryLocation &Loc,
474                                            bool OrLocal) {
475   assert(Visited.empty() && "Visited must be cleared after use!");
476
477   unsigned MaxLookup = 8;
478   SmallVector<const Value *, 16> Worklist;
479   Worklist.push_back(Loc.Ptr);
480   do {
481     const Value *V = GetUnderlyingObject(Worklist.pop_back_val(), DL);
482     if (!Visited.insert(V).second) {
483       Visited.clear();
484       return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
485     }
486
487     // An alloca instruction defines local memory.
488     if (OrLocal && isa<AllocaInst>(V))
489       continue;
490
491     // A global constant counts as local memory for our purposes.
492     if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
493       // Note: this doesn't require GV to be "ODR" because it isn't legal for a
494       // global to be marked constant in some modules and non-constant in
495       // others.  GV may even be a declaration, not a definition.
496       if (!GV->isConstant()) {
497         Visited.clear();
498         return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
499       }
500       continue;
501     }
502
503     // If both select values point to local memory, then so does the select.
504     if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
505       Worklist.push_back(SI->getTrueValue());
506       Worklist.push_back(SI->getFalseValue());
507       continue;
508     }
509
510     // If all values incoming to a phi node point to local memory, then so does
511     // the phi.
512     if (const PHINode *PN = dyn_cast<PHINode>(V)) {
513       // Don't bother inspecting phi nodes with many operands.
514       if (PN->getNumIncomingValues() > MaxLookup) {
515         Visited.clear();
516         return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
517       }
518       for (Value *IncValue : PN->incoming_values())
519         Worklist.push_back(IncValue);
520       continue;
521     }
522
523     // Otherwise be conservative.
524     Visited.clear();
525     return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
526
527   } while (!Worklist.empty() && --MaxLookup);
528
529   Visited.clear();
530   return Worklist.empty();
531 }
532
533 // FIXME: This code is duplicated with MemoryLocation and should be hoisted to
534 // some common utility location.
535 static bool isMemsetPattern16(const Function *MS,
536                               const TargetLibraryInfo &TLI) {
537   if (TLI.has(LibFunc::memset_pattern16) &&
538       MS->getName() == "memset_pattern16") {
539     FunctionType *MemsetType = MS->getFunctionType();
540     if (!MemsetType->isVarArg() && MemsetType->getNumParams() == 3 &&
541         isa<PointerType>(MemsetType->getParamType(0)) &&
542         isa<PointerType>(MemsetType->getParamType(1)) &&
543         isa<IntegerType>(MemsetType->getParamType(2)))
544       return true;
545   }
546
547   return false;
548 }
549
550 /// Returns the behavior when calling the given call site.
551 FunctionModRefBehavior BasicAAResult::getModRefBehavior(ImmutableCallSite CS) {
552   if (CS.doesNotAccessMemory())
553     // Can't do better than this.
554     return FMRB_DoesNotAccessMemory;
555
556   FunctionModRefBehavior Min = FMRB_UnknownModRefBehavior;
557
558   // If the callsite knows it only reads memory, don't return worse
559   // than that.
560   if (CS.onlyReadsMemory())
561     Min = FMRB_OnlyReadsMemory;
562
563   if (CS.onlyAccessesArgMemory())
564     Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesArgumentPointees);
565
566   // The AAResultBase base class has some smarts, lets use them.
567   return FunctionModRefBehavior(AAResultBase::getModRefBehavior(CS) & Min);
568 }
569
570 /// Returns the behavior when calling the given function. For use when the call
571 /// site is not known.
572 FunctionModRefBehavior BasicAAResult::getModRefBehavior(const Function *F) {
573   // If the function declares it doesn't access memory, we can't do better.
574   if (F->doesNotAccessMemory())
575     return FMRB_DoesNotAccessMemory;
576
577   FunctionModRefBehavior Min = FMRB_UnknownModRefBehavior;
578
579   // If the function declares it only reads memory, go with that.
580   if (F->onlyReadsMemory())
581     Min = FMRB_OnlyReadsMemory;
582
583   if (F->onlyAccessesArgMemory())
584     Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesArgumentPointees);
585
586   if (isMemsetPattern16(F, TLI))
587     Min = FMRB_OnlyAccessesArgumentPointees;
588
589   // Otherwise be conservative.
590   return FunctionModRefBehavior(AAResultBase::getModRefBehavior(F) & Min);
591 }
592
593 ModRefInfo BasicAAResult::getArgModRefInfo(ImmutableCallSite CS,
594                                            unsigned ArgIdx) {
595   if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction()))
596     switch (II->getIntrinsicID()) {
597     default:
598       break;
599     case Intrinsic::memset:
600     case Intrinsic::memcpy:
601     case Intrinsic::memmove:
602       assert((ArgIdx == 0 || ArgIdx == 1) &&
603              "Invalid argument index for memory intrinsic");
604       return ArgIdx ? MRI_Ref : MRI_Mod;
605     }
606
607   // We can bound the aliasing properties of memset_pattern16 just as we can
608   // for memcpy/memset.  This is particularly important because the
609   // LoopIdiomRecognizer likes to turn loops into calls to memset_pattern16
610   // whenever possible.
611   if (CS.getCalledFunction() &&
612       isMemsetPattern16(CS.getCalledFunction(), TLI)) {
613     assert((ArgIdx == 0 || ArgIdx == 1) &&
614            "Invalid argument index for memset_pattern16");
615     return ArgIdx ? MRI_Ref : MRI_Mod;
616   }
617   // FIXME: Handle memset_pattern4 and memset_pattern8 also.
618
619   return AAResultBase::getArgModRefInfo(CS, ArgIdx);
620 }
621
622 static bool isAssumeIntrinsic(ImmutableCallSite CS) {
623   const IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction());
624   if (II && II->getIntrinsicID() == Intrinsic::assume)
625     return true;
626
627   return false;
628 }
629
630 static const Function *getParent(const Value *V) {
631   if (const Instruction *inst = dyn_cast<Instruction>(V))
632     return inst->getParent()->getParent();
633
634   if (const Argument *arg = dyn_cast<Argument>(V))
635     return arg->getParent();
636
637   return nullptr;
638 }
639
640 static bool notDifferentParent(const Value *O1, const Value *O2) {
641
642   const Function *F1 = getParent(O1);
643   const Function *F2 = getParent(O2);
644
645   return !F1 || !F2 || F1 == F2;
646 }
647
648 AliasResult BasicAAResult::alias(const MemoryLocation &LocA,
649                                  const MemoryLocation &LocB) {
650   assert(notDifferentParent(LocA.Ptr, LocB.Ptr) &&
651          "BasicAliasAnalysis doesn't support interprocedural queries.");
652
653   // If we have a directly cached entry for these locations, we have recursed
654   // through this once, so just return the cached results. Notably, when this
655   // happens, we don't clear the cache.
656   auto CacheIt = AliasCache.find(LocPair(LocA, LocB));
657   if (CacheIt != AliasCache.end())
658     return CacheIt->second;
659
660   AliasResult Alias = aliasCheck(LocA.Ptr, LocA.Size, LocA.AATags, LocB.Ptr,
661                                  LocB.Size, LocB.AATags);
662   // AliasCache rarely has more than 1 or 2 elements, always use
663   // shrink_and_clear so it quickly returns to the inline capacity of the
664   // SmallDenseMap if it ever grows larger.
665   // FIXME: This should really be shrink_to_inline_capacity_and_clear().
666   AliasCache.shrink_and_clear();
667   VisitedPhiBBs.clear();
668   return Alias;
669 }
670
671 /// Checks to see if the specified callsite can clobber the specified memory
672 /// object.
673 ///
674 /// Since we only look at local properties of this function, we really can't
675 /// say much about this query.  We do, however, use simple "address taken"
676 /// analysis on local objects.
677 ModRefInfo BasicAAResult::getModRefInfo(ImmutableCallSite CS,
678                                         const MemoryLocation &Loc) {
679   assert(notDifferentParent(CS.getInstruction(), Loc.Ptr) &&
680          "AliasAnalysis query involving multiple functions!");
681
682   const Value *Object = GetUnderlyingObject(Loc.Ptr, DL);
683
684   // If this is a tail call and Loc.Ptr points to a stack location, we know that
685   // the tail call cannot access or modify the local stack.
686   // We cannot exclude byval arguments here; these belong to the caller of
687   // the current function not to the current function, and a tail callee
688   // may reference them.
689   if (isa<AllocaInst>(Object))
690     if (const CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
691       if (CI->isTailCall())
692         return MRI_NoModRef;
693
694   // If the pointer is to a locally allocated object that does not escape,
695   // then the call can not mod/ref the pointer unless the call takes the pointer
696   // as an argument, and itself doesn't capture it.
697   if (!isa<Constant>(Object) && CS.getInstruction() != Object &&
698       isNonEscapingLocalObject(Object)) {
699     bool PassedAsArg = false;
700     unsigned ArgNo = 0;
701     for (ImmutableCallSite::arg_iterator CI = CS.arg_begin(), CE = CS.arg_end();
702          CI != CE; ++CI, ++ArgNo) {
703       // Only look at the no-capture or byval pointer arguments.  If this
704       // pointer were passed to arguments that were neither of these, then it
705       // couldn't be no-capture.
706       if (!(*CI)->getType()->isPointerTy() ||
707           (!CS.doesNotCapture(ArgNo) && !CS.isByValArgument(ArgNo)))
708         continue;
709
710       // If this is a no-capture pointer argument, see if we can tell that it
711       // is impossible to alias the pointer we're checking.  If not, we have to
712       // assume that the call could touch the pointer, even though it doesn't
713       // escape.
714       AliasResult AR =
715           getBestAAResults().alias(MemoryLocation(*CI), MemoryLocation(Object));
716       if (AR) {
717         PassedAsArg = true;
718         break;
719       }
720     }
721
722     if (!PassedAsArg)
723       return MRI_NoModRef;
724   }
725
726   // While the assume intrinsic is marked as arbitrarily writing so that
727   // proper control dependencies will be maintained, it never aliases any
728   // particular memory location.
729   if (isAssumeIntrinsic(CS))
730     return MRI_NoModRef;
731
732   // The AAResultBase base class has some smarts, lets use them.
733   return AAResultBase::getModRefInfo(CS, Loc);
734 }
735
736 ModRefInfo BasicAAResult::getModRefInfo(ImmutableCallSite CS1,
737                                         ImmutableCallSite CS2) {
738   // While the assume intrinsic is marked as arbitrarily writing so that
739   // proper control dependencies will be maintained, it never aliases any
740   // particular memory location.
741   if (isAssumeIntrinsic(CS1) || isAssumeIntrinsic(CS2))
742     return MRI_NoModRef;
743
744   // The AAResultBase base class has some smarts, lets use them.
745   return AAResultBase::getModRefInfo(CS1, CS2);
746 }
747
748 /// Provide ad-hoc rules to disambiguate accesses through two GEP operators,
749 /// both having the exact same pointer operand.
750 static AliasResult aliasSameBasePointerGEPs(const GEPOperator *GEP1,
751                                             uint64_t V1Size,
752                                             const GEPOperator *GEP2,
753                                             uint64_t V2Size,
754                                             const DataLayout &DL) {
755
756   assert(GEP1->getPointerOperand() == GEP2->getPointerOperand() &&
757          "Expected GEPs with the same pointer operand");
758
759   // Try to determine whether GEP1 and GEP2 index through arrays, into structs,
760   // such that the struct field accesses provably cannot alias.
761   // We also need at least two indices (the pointer, and the struct field).
762   if (GEP1->getNumIndices() != GEP2->getNumIndices() ||
763       GEP1->getNumIndices() < 2)
764     return MayAlias;
765
766   // If we don't know the size of the accesses through both GEPs, we can't
767   // determine whether the struct fields accessed can't alias.
768   if (V1Size == MemoryLocation::UnknownSize ||
769       V2Size == MemoryLocation::UnknownSize)
770     return MayAlias;
771
772   ConstantInt *C1 =
773       dyn_cast<ConstantInt>(GEP1->getOperand(GEP1->getNumOperands() - 1));
774   ConstantInt *C2 =
775       dyn_cast<ConstantInt>(GEP2->getOperand(GEP2->getNumOperands() - 1));
776
777   // If the last (struct) indices aren't constants, we can't say anything.
778   // If they're identical, the other indices might be also be dynamically
779   // equal, so the GEPs can alias.
780   if (!C1 || !C2 || C1 == C2)
781     return MayAlias;
782
783   // Find the last-indexed type of the GEP, i.e., the type you'd get if
784   // you stripped the last index.
785   // On the way, look at each indexed type.  If there's something other
786   // than an array, different indices can lead to different final types.
787   SmallVector<Value *, 8> IntermediateIndices;
788
789   // Insert the first index; we don't need to check the type indexed
790   // through it as it only drops the pointer indirection.
791   assert(GEP1->getNumIndices() > 1 && "Not enough GEP indices to examine");
792   IntermediateIndices.push_back(GEP1->getOperand(1));
793
794   // Insert all the remaining indices but the last one.
795   // Also, check that they all index through arrays.
796   for (unsigned i = 1, e = GEP1->getNumIndices() - 1; i != e; ++i) {
797     if (!isa<ArrayType>(GetElementPtrInst::getIndexedType(
798             GEP1->getSourceElementType(), IntermediateIndices)))
799       return MayAlias;
800     IntermediateIndices.push_back(GEP1->getOperand(i + 1));
801   }
802
803   StructType *LastIndexedStruct =
804       dyn_cast<StructType>(GetElementPtrInst::getIndexedType(
805           GEP1->getSourceElementType(), IntermediateIndices));
806
807   if (!LastIndexedStruct)
808     return MayAlias;
809
810   // We know that:
811   // - both GEPs begin indexing from the exact same pointer;
812   // - the last indices in both GEPs are constants, indexing into a struct;
813   // - said indices are different, hence, the pointed-to fields are different;
814   // - both GEPs only index through arrays prior to that.
815   //
816   // This lets us determine that the struct that GEP1 indexes into and the
817   // struct that GEP2 indexes into must either precisely overlap or be
818   // completely disjoint.  Because they cannot partially overlap, indexing into
819   // different non-overlapping fields of the struct will never alias.
820
821   // Therefore, the only remaining thing needed to show that both GEPs can't
822   // alias is that the fields are not overlapping.
823   const StructLayout *SL = DL.getStructLayout(LastIndexedStruct);
824   const uint64_t StructSize = SL->getSizeInBytes();
825   const uint64_t V1Off = SL->getElementOffset(C1->getZExtValue());
826   const uint64_t V2Off = SL->getElementOffset(C2->getZExtValue());
827
828   auto EltsDontOverlap = [StructSize](uint64_t V1Off, uint64_t V1Size,
829                                       uint64_t V2Off, uint64_t V2Size) {
830     return V1Off < V2Off && V1Off + V1Size <= V2Off &&
831            ((V2Off + V2Size <= StructSize) ||
832             (V2Off + V2Size - StructSize <= V1Off));
833   };
834
835   if (EltsDontOverlap(V1Off, V1Size, V2Off, V2Size) ||
836       EltsDontOverlap(V2Off, V2Size, V1Off, V1Size))
837     return NoAlias;
838
839   return MayAlias;
840 }
841
842 /// Provides a bunch of ad-hoc rules to disambiguate a GEP instruction against
843 /// another pointer.
844 ///
845 /// We know that V1 is a GEP, but we don't know anything about V2.
846 /// UnderlyingV1 is GetUnderlyingObject(GEP1, DL), UnderlyingV2 is the same for
847 /// V2.
848 AliasResult BasicAAResult::aliasGEP(const GEPOperator *GEP1, uint64_t V1Size,
849                                     const AAMDNodes &V1AAInfo, const Value *V2,
850                                     uint64_t V2Size, const AAMDNodes &V2AAInfo,
851                                     const Value *UnderlyingV1,
852                                     const Value *UnderlyingV2) {
853   int64_t GEP1BaseOffset;
854   bool GEP1MaxLookupReached;
855   SmallVector<VariableGEPIndex, 4> GEP1VariableIndices;
856
857   // If we have two gep instructions with must-alias or not-alias'ing base
858   // pointers, figure out if the indexes to the GEP tell us anything about the
859   // derived pointer.
860   if (const GEPOperator *GEP2 = dyn_cast<GEPOperator>(V2)) {
861     // Do the base pointers alias?
862     AliasResult BaseAlias =
863         aliasCheck(UnderlyingV1, MemoryLocation::UnknownSize, AAMDNodes(),
864                    UnderlyingV2, MemoryLocation::UnknownSize, AAMDNodes());
865
866     // Check for geps of non-aliasing underlying pointers where the offsets are
867     // identical.
868     if ((BaseAlias == MayAlias) && V1Size == V2Size) {
869       // Do the base pointers alias assuming type and size.
870       AliasResult PreciseBaseAlias = aliasCheck(UnderlyingV1, V1Size, V1AAInfo,
871                                                 UnderlyingV2, V2Size, V2AAInfo);
872       if (PreciseBaseAlias == NoAlias) {
873         // See if the computed offset from the common pointer tells us about the
874         // relation of the resulting pointer.
875         int64_t GEP2BaseOffset;
876         bool GEP2MaxLookupReached;
877         SmallVector<VariableGEPIndex, 4> GEP2VariableIndices;
878         const Value *GEP2BasePtr =
879             DecomposeGEPExpression(GEP2, GEP2BaseOffset, GEP2VariableIndices,
880                                    GEP2MaxLookupReached, DL, &AC, DT);
881         const Value *GEP1BasePtr =
882             DecomposeGEPExpression(GEP1, GEP1BaseOffset, GEP1VariableIndices,
883                                    GEP1MaxLookupReached, DL, &AC, DT);
884         // DecomposeGEPExpression and GetUnderlyingObject should return the
885         // same result except when DecomposeGEPExpression has no DataLayout.
886         // FIXME: They always have a DataLayout so this should become an
887         // assert.
888         if (GEP1BasePtr != UnderlyingV1 || GEP2BasePtr != UnderlyingV2) {
889           return MayAlias;
890         }
891         // If the max search depth is reached the result is undefined
892         if (GEP2MaxLookupReached || GEP1MaxLookupReached)
893           return MayAlias;
894
895         // Same offsets.
896         if (GEP1BaseOffset == GEP2BaseOffset &&
897             GEP1VariableIndices == GEP2VariableIndices)
898           return NoAlias;
899         GEP1VariableIndices.clear();
900       }
901     }
902
903     // If we get a No or May, then return it immediately, no amount of analysis
904     // will improve this situation.
905     if (BaseAlias != MustAlias)
906       return BaseAlias;
907
908     // Otherwise, we have a MustAlias.  Since the base pointers alias each other
909     // exactly, see if the computed offset from the common pointer tells us
910     // about the relation of the resulting pointer.
911     const Value *GEP1BasePtr =
912         DecomposeGEPExpression(GEP1, GEP1BaseOffset, GEP1VariableIndices,
913                                GEP1MaxLookupReached, DL, &AC, DT);
914
915     int64_t GEP2BaseOffset;
916     bool GEP2MaxLookupReached;
917     SmallVector<VariableGEPIndex, 4> GEP2VariableIndices;
918     const Value *GEP2BasePtr =
919         DecomposeGEPExpression(GEP2, GEP2BaseOffset, GEP2VariableIndices,
920                                GEP2MaxLookupReached, DL, &AC, DT);
921
922     // DecomposeGEPExpression and GetUnderlyingObject should return the
923     // same result except when DecomposeGEPExpression has no DataLayout.
924     // FIXME: They always have a DataLayout so this should become an assert.
925     if (GEP1BasePtr != UnderlyingV1 || GEP2BasePtr != UnderlyingV2) {
926       return MayAlias;
927     }
928
929     // If we know the two GEPs are based off of the exact same pointer (and not
930     // just the same underlying object), see if that tells us anything about
931     // the resulting pointers.
932     if (GEP1->getPointerOperand() == GEP2->getPointerOperand()) {
933       AliasResult R = aliasSameBasePointerGEPs(GEP1, V1Size, GEP2, V2Size, DL);
934       // If we couldn't find anything interesting, don't abandon just yet.
935       if (R != MayAlias)
936         return R;
937     }
938
939     // If the max search depth is reached the result is undefined
940     if (GEP2MaxLookupReached || GEP1MaxLookupReached)
941       return MayAlias;
942
943     // Subtract the GEP2 pointer from the GEP1 pointer to find out their
944     // symbolic difference.
945     GEP1BaseOffset -= GEP2BaseOffset;
946     GetIndexDifference(GEP1VariableIndices, GEP2VariableIndices);
947
948   } else {
949     // Check to see if these two pointers are related by the getelementptr
950     // instruction.  If one pointer is a GEP with a non-zero index of the other
951     // pointer, we know they cannot alias.
952
953     // If both accesses are unknown size, we can't do anything useful here.
954     if (V1Size == MemoryLocation::UnknownSize &&
955         V2Size == MemoryLocation::UnknownSize)
956       return MayAlias;
957
958     AliasResult R = aliasCheck(UnderlyingV1, MemoryLocation::UnknownSize,
959                                AAMDNodes(), V2, V2Size, V2AAInfo);
960     if (R != MustAlias)
961       // If V2 may alias GEP base pointer, conservatively returns MayAlias.
962       // If V2 is known not to alias GEP base pointer, then the two values
963       // cannot alias per GEP semantics: "A pointer value formed from a
964       // getelementptr instruction is associated with the addresses associated
965       // with the first operand of the getelementptr".
966       return R;
967
968     const Value *GEP1BasePtr =
969         DecomposeGEPExpression(GEP1, GEP1BaseOffset, GEP1VariableIndices,
970                                GEP1MaxLookupReached, DL, &AC, DT);
971
972     // DecomposeGEPExpression and GetUnderlyingObject should return the
973     // same result except when DecomposeGEPExpression has no DataLayout.
974     // FIXME: They always have a DataLayout so this should become an assert.
975     if (GEP1BasePtr != UnderlyingV1) {
976       return MayAlias;
977     }
978     // If the max search depth is reached the result is undefined
979     if (GEP1MaxLookupReached)
980       return MayAlias;
981   }
982
983   // In the two GEP Case, if there is no difference in the offsets of the
984   // computed pointers, the resultant pointers are a must alias.  This
985   // hapens when we have two lexically identical GEP's (for example).
986   //
987   // In the other case, if we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2
988   // must aliases the GEP, the end result is a must alias also.
989   if (GEP1BaseOffset == 0 && GEP1VariableIndices.empty())
990     return MustAlias;
991
992   // If there is a constant difference between the pointers, but the difference
993   // is less than the size of the associated memory object, then we know
994   // that the objects are partially overlapping.  If the difference is
995   // greater, we know they do not overlap.
996   if (GEP1BaseOffset != 0 && GEP1VariableIndices.empty()) {
997     if (GEP1BaseOffset >= 0) {
998       if (V2Size != MemoryLocation::UnknownSize) {
999         if ((uint64_t)GEP1BaseOffset < V2Size)
1000           return PartialAlias;
1001         return NoAlias;
1002       }
1003     } else {
1004       // We have the situation where:
1005       // +                +
1006       // | BaseOffset     |
1007       // ---------------->|
1008       // |-->V1Size       |-------> V2Size
1009       // GEP1             V2
1010       // We need to know that V2Size is not unknown, otherwise we might have
1011       // stripped a gep with negative index ('gep <ptr>, -1, ...).
1012       if (V1Size != MemoryLocation::UnknownSize &&
1013           V2Size != MemoryLocation::UnknownSize) {
1014         if (-(uint64_t)GEP1BaseOffset < V1Size)
1015           return PartialAlias;
1016         return NoAlias;
1017       }
1018     }
1019   }
1020
1021   if (!GEP1VariableIndices.empty()) {
1022     uint64_t Modulo = 0;
1023     bool AllPositive = true;
1024     for (unsigned i = 0, e = GEP1VariableIndices.size(); i != e; ++i) {
1025
1026       // Try to distinguish something like &A[i][1] against &A[42][0].
1027       // Grab the least significant bit set in any of the scales. We
1028       // don't need std::abs here (even if the scale's negative) as we'll
1029       // be ^'ing Modulo with itself later.
1030       Modulo |= (uint64_t)GEP1VariableIndices[i].Scale;
1031
1032       if (AllPositive) {
1033         // If the Value could change between cycles, then any reasoning about
1034         // the Value this cycle may not hold in the next cycle. We'll just
1035         // give up if we can't determine conditions that hold for every cycle:
1036         const Value *V = GEP1VariableIndices[i].V;
1037
1038         bool SignKnownZero, SignKnownOne;
1039         ComputeSignBit(const_cast<Value *>(V), SignKnownZero, SignKnownOne, DL,
1040                        0, &AC, nullptr, DT);
1041
1042         // Zero-extension widens the variable, and so forces the sign
1043         // bit to zero.
1044         bool IsZExt = GEP1VariableIndices[i].ZExtBits > 0 || isa<ZExtInst>(V);
1045         SignKnownZero |= IsZExt;
1046         SignKnownOne &= !IsZExt;
1047
1048         // If the variable begins with a zero then we know it's
1049         // positive, regardless of whether the value is signed or
1050         // unsigned.
1051         int64_t Scale = GEP1VariableIndices[i].Scale;
1052         AllPositive =
1053             (SignKnownZero && Scale >= 0) || (SignKnownOne && Scale < 0);
1054       }
1055     }
1056
1057     Modulo = Modulo ^ (Modulo & (Modulo - 1));
1058
1059     // We can compute the difference between the two addresses
1060     // mod Modulo. Check whether that difference guarantees that the
1061     // two locations do not alias.
1062     uint64_t ModOffset = (uint64_t)GEP1BaseOffset & (Modulo - 1);
1063     if (V1Size != MemoryLocation::UnknownSize &&
1064         V2Size != MemoryLocation::UnknownSize && ModOffset >= V2Size &&
1065         V1Size <= Modulo - ModOffset)
1066       return NoAlias;
1067
1068     // If we know all the variables are positive, then GEP1 >= GEP1BasePtr.
1069     // If GEP1BasePtr > V2 (GEP1BaseOffset > 0) then we know the pointers
1070     // don't alias if V2Size can fit in the gap between V2 and GEP1BasePtr.
1071     if (AllPositive && GEP1BaseOffset > 0 && V2Size <= (uint64_t)GEP1BaseOffset)
1072       return NoAlias;
1073
1074     if (constantOffsetHeuristic(GEP1VariableIndices, V1Size, V2Size,
1075                                 GEP1BaseOffset, &AC, DT))
1076       return NoAlias;
1077   }
1078
1079   // Statically, we can see that the base objects are the same, but the
1080   // pointers have dynamic offsets which we can't resolve. And none of our
1081   // little tricks above worked.
1082   //
1083   // TODO: Returning PartialAlias instead of MayAlias is a mild hack; the
1084   // practical effect of this is protecting TBAA in the case of dynamic
1085   // indices into arrays of unions or malloc'd memory.
1086   return PartialAlias;
1087 }
1088
1089 static AliasResult MergeAliasResults(AliasResult A, AliasResult B) {
1090   // If the results agree, take it.
1091   if (A == B)
1092     return A;
1093   // A mix of PartialAlias and MustAlias is PartialAlias.
1094   if ((A == PartialAlias && B == MustAlias) ||
1095       (B == PartialAlias && A == MustAlias))
1096     return PartialAlias;
1097   // Otherwise, we don't know anything.
1098   return MayAlias;
1099 }
1100
1101 /// Provides a bunch of ad-hoc rules to disambiguate a Select instruction
1102 /// against another.
1103 AliasResult BasicAAResult::aliasSelect(const SelectInst *SI, uint64_t SISize,
1104                                        const AAMDNodes &SIAAInfo,
1105                                        const Value *V2, uint64_t V2Size,
1106                                        const AAMDNodes &V2AAInfo) {
1107   // If the values are Selects with the same condition, we can do a more precise
1108   // check: just check for aliases between the values on corresponding arms.
1109   if (const SelectInst *SI2 = dyn_cast<SelectInst>(V2))
1110     if (SI->getCondition() == SI2->getCondition()) {
1111       AliasResult Alias = aliasCheck(SI->getTrueValue(), SISize, SIAAInfo,
1112                                      SI2->getTrueValue(), V2Size, V2AAInfo);
1113       if (Alias == MayAlias)
1114         return MayAlias;
1115       AliasResult ThisAlias =
1116           aliasCheck(SI->getFalseValue(), SISize, SIAAInfo,
1117                      SI2->getFalseValue(), V2Size, V2AAInfo);
1118       return MergeAliasResults(ThisAlias, Alias);
1119     }
1120
1121   // If both arms of the Select node NoAlias or MustAlias V2, then returns
1122   // NoAlias / MustAlias. Otherwise, returns MayAlias.
1123   AliasResult Alias =
1124       aliasCheck(V2, V2Size, V2AAInfo, SI->getTrueValue(), SISize, SIAAInfo);
1125   if (Alias == MayAlias)
1126     return MayAlias;
1127
1128   AliasResult ThisAlias =
1129       aliasCheck(V2, V2Size, V2AAInfo, SI->getFalseValue(), SISize, SIAAInfo);
1130   return MergeAliasResults(ThisAlias, Alias);
1131 }
1132
1133 /// Provide a bunch of ad-hoc rules to disambiguate a PHI instruction against
1134 /// another.
1135 AliasResult BasicAAResult::aliasPHI(const PHINode *PN, uint64_t PNSize,
1136                                     const AAMDNodes &PNAAInfo, const Value *V2,
1137                                     uint64_t V2Size,
1138                                     const AAMDNodes &V2AAInfo) {
1139   // Track phi nodes we have visited. We use this information when we determine
1140   // value equivalence.
1141   VisitedPhiBBs.insert(PN->getParent());
1142
1143   // If the values are PHIs in the same block, we can do a more precise
1144   // as well as efficient check: just check for aliases between the values
1145   // on corresponding edges.
1146   if (const PHINode *PN2 = dyn_cast<PHINode>(V2))
1147     if (PN2->getParent() == PN->getParent()) {
1148       LocPair Locs(MemoryLocation(PN, PNSize, PNAAInfo),
1149                    MemoryLocation(V2, V2Size, V2AAInfo));
1150       if (PN > V2)
1151         std::swap(Locs.first, Locs.second);
1152       // Analyse the PHIs' inputs under the assumption that the PHIs are
1153       // NoAlias.
1154       // If the PHIs are May/MustAlias there must be (recursively) an input
1155       // operand from outside the PHIs' cycle that is MayAlias/MustAlias or
1156       // there must be an operation on the PHIs within the PHIs' value cycle
1157       // that causes a MayAlias.
1158       // Pretend the phis do not alias.
1159       AliasResult Alias = NoAlias;
1160       assert(AliasCache.count(Locs) &&
1161              "There must exist an entry for the phi node");
1162       AliasResult OrigAliasResult = AliasCache[Locs];
1163       AliasCache[Locs] = NoAlias;
1164
1165       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1166         AliasResult ThisAlias =
1167             aliasCheck(PN->getIncomingValue(i), PNSize, PNAAInfo,
1168                        PN2->getIncomingValueForBlock(PN->getIncomingBlock(i)),
1169                        V2Size, V2AAInfo);
1170         Alias = MergeAliasResults(ThisAlias, Alias);
1171         if (Alias == MayAlias)
1172           break;
1173       }
1174
1175       // Reset if speculation failed.
1176       if (Alias != NoAlias)
1177         AliasCache[Locs] = OrigAliasResult;
1178
1179       return Alias;
1180     }
1181
1182   SmallPtrSet<Value *, 4> UniqueSrc;
1183   SmallVector<Value *, 4> V1Srcs;
1184   bool isRecursive = false;
1185   for (Value *PV1 : PN->incoming_values()) {
1186     if (isa<PHINode>(PV1))
1187       // If any of the source itself is a PHI, return MayAlias conservatively
1188       // to avoid compile time explosion. The worst possible case is if both
1189       // sides are PHI nodes. In which case, this is O(m x n) time where 'm'
1190       // and 'n' are the number of PHI sources.
1191       return MayAlias;
1192
1193     if (EnableRecPhiAnalysis)
1194       if (GEPOperator *PV1GEP = dyn_cast<GEPOperator>(PV1)) {
1195         // Check whether the incoming value is a GEP that advances the pointer
1196         // result of this PHI node (e.g. in a loop). If this is the case, we
1197         // would recurse and always get a MayAlias. Handle this case specially
1198         // below.
1199         if (PV1GEP->getPointerOperand() == PN && PV1GEP->getNumIndices() == 1 &&
1200             isa<ConstantInt>(PV1GEP->idx_begin())) {
1201           isRecursive = true;
1202           continue;
1203         }
1204       }
1205
1206     if (UniqueSrc.insert(PV1).second)
1207       V1Srcs.push_back(PV1);
1208   }
1209
1210   // If this PHI node is recursive, set the size of the accessed memory to
1211   // unknown to represent all the possible values the GEP could advance the
1212   // pointer to.
1213   if (isRecursive)
1214     PNSize = MemoryLocation::UnknownSize;
1215
1216   AliasResult Alias =
1217       aliasCheck(V2, V2Size, V2AAInfo, V1Srcs[0], PNSize, PNAAInfo);
1218
1219   // Early exit if the check of the first PHI source against V2 is MayAlias.
1220   // Other results are not possible.
1221   if (Alias == MayAlias)
1222     return MayAlias;
1223
1224   // If all sources of the PHI node NoAlias or MustAlias V2, then returns
1225   // NoAlias / MustAlias. Otherwise, returns MayAlias.
1226   for (unsigned i = 1, e = V1Srcs.size(); i != e; ++i) {
1227     Value *V = V1Srcs[i];
1228
1229     AliasResult ThisAlias =
1230         aliasCheck(V2, V2Size, V2AAInfo, V, PNSize, PNAAInfo);
1231     Alias = MergeAliasResults(ThisAlias, Alias);
1232     if (Alias == MayAlias)
1233       break;
1234   }
1235
1236   return Alias;
1237 }
1238
1239 /// Provideis a bunch of ad-hoc rules to disambiguate in common cases, such as
1240 /// array references.
1241 AliasResult BasicAAResult::aliasCheck(const Value *V1, uint64_t V1Size,
1242                                       AAMDNodes V1AAInfo, const Value *V2,
1243                                       uint64_t V2Size, AAMDNodes V2AAInfo) {
1244   // If either of the memory references is empty, it doesn't matter what the
1245   // pointer values are.
1246   if (V1Size == 0 || V2Size == 0)
1247     return NoAlias;
1248
1249   // Strip off any casts if they exist.
1250   V1 = V1->stripPointerCasts();
1251   V2 = V2->stripPointerCasts();
1252
1253   // If V1 or V2 is undef, the result is NoAlias because we can always pick a
1254   // value for undef that aliases nothing in the program.
1255   if (isa<UndefValue>(V1) || isa<UndefValue>(V2))
1256     return NoAlias;
1257
1258   // Are we checking for alias of the same value?
1259   // Because we look 'through' phi nodes we could look at "Value" pointers from
1260   // different iterations. We must therefore make sure that this is not the
1261   // case. The function isValueEqualInPotentialCycles ensures that this cannot
1262   // happen by looking at the visited phi nodes and making sure they cannot
1263   // reach the value.
1264   if (isValueEqualInPotentialCycles(V1, V2))
1265     return MustAlias;
1266
1267   if (!V1->getType()->isPointerTy() || !V2->getType()->isPointerTy())
1268     return NoAlias; // Scalars cannot alias each other
1269
1270   // Figure out what objects these things are pointing to if we can.
1271   const Value *O1 = GetUnderlyingObject(V1, DL, MaxLookupSearchDepth);
1272   const Value *O2 = GetUnderlyingObject(V2, DL, MaxLookupSearchDepth);
1273
1274   // Null values in the default address space don't point to any object, so they
1275   // don't alias any other pointer.
1276   if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O1))
1277     if (CPN->getType()->getAddressSpace() == 0)
1278       return NoAlias;
1279   if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O2))
1280     if (CPN->getType()->getAddressSpace() == 0)
1281       return NoAlias;
1282
1283   if (O1 != O2) {
1284     // If V1/V2 point to two different objects we know that we have no alias.
1285     if (isIdentifiedObject(O1) && isIdentifiedObject(O2))
1286       return NoAlias;
1287
1288     // Constant pointers can't alias with non-const isIdentifiedObject objects.
1289     if ((isa<Constant>(O1) && isIdentifiedObject(O2) && !isa<Constant>(O2)) ||
1290         (isa<Constant>(O2) && isIdentifiedObject(O1) && !isa<Constant>(O1)))
1291       return NoAlias;
1292
1293     // Function arguments can't alias with things that are known to be
1294     // unambigously identified at the function level.
1295     if ((isa<Argument>(O1) && isIdentifiedFunctionLocal(O2)) ||
1296         (isa<Argument>(O2) && isIdentifiedFunctionLocal(O1)))
1297       return NoAlias;
1298
1299     // Most objects can't alias null.
1300     if ((isa<ConstantPointerNull>(O2) && isKnownNonNull(O1)) ||
1301         (isa<ConstantPointerNull>(O1) && isKnownNonNull(O2)))
1302       return NoAlias;
1303
1304     // If one pointer is the result of a call/invoke or load and the other is a
1305     // non-escaping local object within the same function, then we know the
1306     // object couldn't escape to a point where the call could return it.
1307     //
1308     // Note that if the pointers are in different functions, there are a
1309     // variety of complications. A call with a nocapture argument may still
1310     // temporary store the nocapture argument's value in a temporary memory
1311     // location if that memory location doesn't escape. Or it may pass a
1312     // nocapture value to other functions as long as they don't capture it.
1313     if (isEscapeSource(O1) && isNonEscapingLocalObject(O2))
1314       return NoAlias;
1315     if (isEscapeSource(O2) && isNonEscapingLocalObject(O1))
1316       return NoAlias;
1317   }
1318
1319   // If the size of one access is larger than the entire object on the other
1320   // side, then we know such behavior is undefined and can assume no alias.
1321   if ((V1Size != MemoryLocation::UnknownSize &&
1322        isObjectSmallerThan(O2, V1Size, DL, TLI)) ||
1323       (V2Size != MemoryLocation::UnknownSize &&
1324        isObjectSmallerThan(O1, V2Size, DL, TLI)))
1325     return NoAlias;
1326
1327   // Check the cache before climbing up use-def chains. This also terminates
1328   // otherwise infinitely recursive queries.
1329   LocPair Locs(MemoryLocation(V1, V1Size, V1AAInfo),
1330                MemoryLocation(V2, V2Size, V2AAInfo));
1331   if (V1 > V2)
1332     std::swap(Locs.first, Locs.second);
1333   std::pair<AliasCacheTy::iterator, bool> Pair =
1334       AliasCache.insert(std::make_pair(Locs, MayAlias));
1335   if (!Pair.second)
1336     return Pair.first->second;
1337
1338   // FIXME: This isn't aggressively handling alias(GEP, PHI) for example: if the
1339   // GEP can't simplify, we don't even look at the PHI cases.
1340   if (!isa<GEPOperator>(V1) && isa<GEPOperator>(V2)) {
1341     std::swap(V1, V2);
1342     std::swap(V1Size, V2Size);
1343     std::swap(O1, O2);
1344     std::swap(V1AAInfo, V2AAInfo);
1345   }
1346   if (const GEPOperator *GV1 = dyn_cast<GEPOperator>(V1)) {
1347     AliasResult Result =
1348         aliasGEP(GV1, V1Size, V1AAInfo, V2, V2Size, V2AAInfo, O1, O2);
1349     if (Result != MayAlias)
1350       return AliasCache[Locs] = Result;
1351   }
1352
1353   if (isa<PHINode>(V2) && !isa<PHINode>(V1)) {
1354     std::swap(V1, V2);
1355     std::swap(V1Size, V2Size);
1356     std::swap(V1AAInfo, V2AAInfo);
1357   }
1358   if (const PHINode *PN = dyn_cast<PHINode>(V1)) {
1359     AliasResult Result = aliasPHI(PN, V1Size, V1AAInfo, V2, V2Size, V2AAInfo);
1360     if (Result != MayAlias)
1361       return AliasCache[Locs] = Result;
1362   }
1363
1364   if (isa<SelectInst>(V2) && !isa<SelectInst>(V1)) {
1365     std::swap(V1, V2);
1366     std::swap(V1Size, V2Size);
1367     std::swap(V1AAInfo, V2AAInfo);
1368   }
1369   if (const SelectInst *S1 = dyn_cast<SelectInst>(V1)) {
1370     AliasResult Result =
1371         aliasSelect(S1, V1Size, V1AAInfo, V2, V2Size, V2AAInfo);
1372     if (Result != MayAlias)
1373       return AliasCache[Locs] = Result;
1374   }
1375
1376   // If both pointers are pointing into the same object and one of them
1377   // accesses is accessing the entire object, then the accesses must
1378   // overlap in some way.
1379   if (O1 == O2)
1380     if ((V1Size != MemoryLocation::UnknownSize &&
1381          isObjectSize(O1, V1Size, DL, TLI)) ||
1382         (V2Size != MemoryLocation::UnknownSize &&
1383          isObjectSize(O2, V2Size, DL, TLI)))
1384       return AliasCache[Locs] = PartialAlias;
1385
1386   // Recurse back into the best AA results we have, potentially with refined
1387   // memory locations. We have already ensured that BasicAA has a MayAlias
1388   // cache result for these, so any recursion back into BasicAA won't loop.
1389   AliasResult Result = getBestAAResults().alias(Locs.first, Locs.second);
1390   return AliasCache[Locs] = Result;
1391 }
1392
1393 /// Check whether two Values can be considered equivalent.
1394 ///
1395 /// In addition to pointer equivalence of \p V1 and \p V2 this checks whether
1396 /// they can not be part of a cycle in the value graph by looking at all
1397 /// visited phi nodes an making sure that the phis cannot reach the value. We
1398 /// have to do this because we are looking through phi nodes (That is we say
1399 /// noalias(V, phi(VA, VB)) if noalias(V, VA) and noalias(V, VB).
1400 bool BasicAAResult::isValueEqualInPotentialCycles(const Value *V,
1401                                                   const Value *V2) {
1402   if (V != V2)
1403     return false;
1404
1405   const Instruction *Inst = dyn_cast<Instruction>(V);
1406   if (!Inst)
1407     return true;
1408
1409   if (VisitedPhiBBs.empty())
1410     return true;
1411
1412   if (VisitedPhiBBs.size() > MaxNumPhiBBsValueReachabilityCheck)
1413     return false;
1414
1415   // Make sure that the visited phis cannot reach the Value. This ensures that
1416   // the Values cannot come from different iterations of a potential cycle the
1417   // phi nodes could be involved in.
1418   for (auto *P : VisitedPhiBBs)
1419     if (isPotentiallyReachable(P->begin(), Inst, DT, LI))
1420       return false;
1421
1422   return true;
1423 }
1424
1425 /// Computes the symbolic difference between two de-composed GEPs.
1426 ///
1427 /// Dest and Src are the variable indices from two decomposed GetElementPtr
1428 /// instructions GEP1 and GEP2 which have common base pointers.
1429 void BasicAAResult::GetIndexDifference(
1430     SmallVectorImpl<VariableGEPIndex> &Dest,
1431     const SmallVectorImpl<VariableGEPIndex> &Src) {
1432   if (Src.empty())
1433     return;
1434
1435   for (unsigned i = 0, e = Src.size(); i != e; ++i) {
1436     const Value *V = Src[i].V;
1437     unsigned ZExtBits = Src[i].ZExtBits, SExtBits = Src[i].SExtBits;
1438     int64_t Scale = Src[i].Scale;
1439
1440     // Find V in Dest.  This is N^2, but pointer indices almost never have more
1441     // than a few variable indexes.
1442     for (unsigned j = 0, e = Dest.size(); j != e; ++j) {
1443       if (!isValueEqualInPotentialCycles(Dest[j].V, V) ||
1444           Dest[j].ZExtBits != ZExtBits || Dest[j].SExtBits != SExtBits)
1445         continue;
1446
1447       // If we found it, subtract off Scale V's from the entry in Dest.  If it
1448       // goes to zero, remove the entry.
1449       if (Dest[j].Scale != Scale)
1450         Dest[j].Scale -= Scale;
1451       else
1452         Dest.erase(Dest.begin() + j);
1453       Scale = 0;
1454       break;
1455     }
1456
1457     // If we didn't consume this entry, add it to the end of the Dest list.
1458     if (Scale) {
1459       VariableGEPIndex Entry = {V, ZExtBits, SExtBits, -Scale};
1460       Dest.push_back(Entry);
1461     }
1462   }
1463 }
1464
1465 bool BasicAAResult::constantOffsetHeuristic(
1466     const SmallVectorImpl<VariableGEPIndex> &VarIndices, uint64_t V1Size,
1467     uint64_t V2Size, int64_t BaseOffset, AssumptionCache *AC,
1468     DominatorTree *DT) {
1469   if (VarIndices.size() != 2 || V1Size == MemoryLocation::UnknownSize ||
1470       V2Size == MemoryLocation::UnknownSize)
1471     return false;
1472
1473   const VariableGEPIndex &Var0 = VarIndices[0], &Var1 = VarIndices[1];
1474
1475   if (Var0.ZExtBits != Var1.ZExtBits || Var0.SExtBits != Var1.SExtBits ||
1476       Var0.Scale != -Var1.Scale)
1477     return false;
1478
1479   unsigned Width = Var1.V->getType()->getIntegerBitWidth();
1480
1481   // We'll strip off the Extensions of Var0 and Var1 and do another round
1482   // of GetLinearExpression decomposition. In the example above, if Var0
1483   // is zext(%x + 1) we should get V1 == %x and V1Offset == 1.
1484
1485   APInt V0Scale(Width, 0), V0Offset(Width, 0), V1Scale(Width, 0),
1486       V1Offset(Width, 0);
1487   bool NSW = true, NUW = true;
1488   unsigned V0ZExtBits = 0, V0SExtBits = 0, V1ZExtBits = 0, V1SExtBits = 0;
1489   const Value *V0 = GetLinearExpression(Var0.V, V0Scale, V0Offset, V0ZExtBits,
1490                                         V0SExtBits, DL, 0, AC, DT, NSW, NUW);
1491   NSW = true, NUW = true;
1492   const Value *V1 = GetLinearExpression(Var1.V, V1Scale, V1Offset, V1ZExtBits,
1493                                         V1SExtBits, DL, 0, AC, DT, NSW, NUW);
1494
1495   if (V0Scale != V1Scale || V0ZExtBits != V1ZExtBits ||
1496       V0SExtBits != V1SExtBits || !isValueEqualInPotentialCycles(V0, V1))
1497     return false;
1498
1499   // We have a hit - Var0 and Var1 only differ by a constant offset!
1500
1501   // If we've been sext'ed then zext'd the maximum difference between Var0 and
1502   // Var1 is possible to calculate, but we're just interested in the absolute
1503   // minumum difference between the two. The minimum distance may occur due to
1504   // wrapping; consider "add i3 %i, 5": if %i == 7 then 7 + 5 mod 8 == 4, and so
1505   // the minimum distance between %i and %i + 5 is 3.
1506   APInt MinDiff = V0Offset - V1Offset,
1507         Wrapped = APInt::getMaxValue(Width) - MinDiff + APInt(Width, 1);
1508   MinDiff = APIntOps::umin(MinDiff, Wrapped);
1509   uint64_t MinDiffBytes = MinDiff.getZExtValue() * std::abs(Var0.Scale);
1510
1511   // We can't definitely say whether GEP1 is before or after V2 due to wrapping
1512   // arithmetic (i.e. for some values of GEP1 and V2 GEP1 < V2, and for other
1513   // values GEP1 > V2). We'll therefore only declare NoAlias if both V1Size and
1514   // V2Size can fit in the MinDiffBytes gap.
1515   return V1Size + std::abs(BaseOffset) <= MinDiffBytes &&
1516          V2Size + std::abs(BaseOffset) <= MinDiffBytes;
1517 }
1518
1519 //===----------------------------------------------------------------------===//
1520 // BasicAliasAnalysis Pass
1521 //===----------------------------------------------------------------------===//
1522
1523 char BasicAA::PassID;
1524
1525 BasicAAResult BasicAA::run(Function &F, AnalysisManager<Function> *AM) {
1526   return BasicAAResult(F.getParent()->getDataLayout(),
1527                        AM->getResult<TargetLibraryAnalysis>(F),
1528                        AM->getResult<AssumptionAnalysis>(F),
1529                        AM->getCachedResult<DominatorTreeAnalysis>(F),
1530                        AM->getCachedResult<LoopAnalysis>(F));
1531 }
1532
1533 char BasicAAWrapperPass::ID = 0;
1534 void BasicAAWrapperPass::anchor() {}
1535
1536 INITIALIZE_PASS_BEGIN(BasicAAWrapperPass, "basicaa",
1537                       "Basic Alias Analysis (stateless AA impl)", true, true)
1538 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
1539 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
1540 INITIALIZE_PASS_END(BasicAAWrapperPass, "basicaa",
1541                     "Basic Alias Analysis (stateless AA impl)", true, true)
1542
1543 FunctionPass *llvm::createBasicAAWrapperPass() {
1544   return new BasicAAWrapperPass();
1545 }
1546
1547 bool BasicAAWrapperPass::runOnFunction(Function &F) {
1548   auto &ACT = getAnalysis<AssumptionCacheTracker>();
1549   auto &TLIWP = getAnalysis<TargetLibraryInfoWrapperPass>();
1550   auto *DTWP = getAnalysisIfAvailable<DominatorTreeWrapperPass>();
1551   auto *LIWP = getAnalysisIfAvailable<LoopInfoWrapperPass>();
1552
1553   Result.reset(new BasicAAResult(F.getParent()->getDataLayout(), TLIWP.getTLI(),
1554                                  ACT.getAssumptionCache(F),
1555                                  DTWP ? &DTWP->getDomTree() : nullptr,
1556                                  LIWP ? &LIWP->getLoopInfo() : nullptr));
1557
1558   return false;
1559 }
1560
1561 void BasicAAWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
1562   AU.setPreservesAll();
1563   AU.addRequired<AssumptionCacheTracker>();
1564   AU.addRequired<TargetLibraryInfoWrapperPass>();
1565 }
1566
1567 BasicAAResult llvm::createLegacyPMBasicAAResult(Pass &P, Function &F) {
1568   return BasicAAResult(
1569       F.getParent()->getDataLayout(),
1570       P.getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(),
1571       P.getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F));
1572 }