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