blob: a28db6c269e96be61eb8e0c8e3f6557230acbaa5 [file] [log] [blame]
Dan Gohmanda85ed82010-10-19 23:09:08 +00001//===- BasicAliasAnalysis.cpp - Stateless Alias Analysis Impl -------------===//
Misha Brukman01808ca2005-04-21 21:13:18 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman01808ca2005-04-21 21:13:18 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattnerd6a2a992003-02-26 19:41:54 +00009//
Dan Gohmanda85ed82010-10-19 23:09:08 +000010// 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.
Chris Lattnerd6a2a992003-02-26 19:41:54 +000013//
14//===----------------------------------------------------------------------===//
15
Chandler Carruth17e0bc32015-08-06 07:33:15 +000016#include "llvm/Analysis/BasicAliasAnalysis.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000017#include "llvm/ADT/SmallVector.h"
Wei Mid67daae2015-08-05 23:40:30 +000018#include "llvm/ADT/Statistic.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000019#include "llvm/Analysis/AliasAnalysis.h"
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +000020#include "llvm/Analysis/CFG.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000021#include "llvm/Analysis/CaptureTracking.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000022#include "llvm/Analysis/InstructionSimplify.h"
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +000023#include "llvm/Analysis/LoopInfo.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000024#include "llvm/Analysis/MemoryBuiltins.h"
25#include "llvm/Analysis/ValueTracking.h"
Chandler Carruth7b560d42015-09-09 17:55:00 +000026#include "llvm/Analysis/AssumptionCache.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000027#include "llvm/IR/Constants.h"
28#include "llvm/IR/DataLayout.h"
29#include "llvm/IR/DerivedTypes.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000030#include "llvm/IR/Dominators.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000031#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"
Chris Lattnerd82256a2004-03-15 03:36:49 +000037#include "llvm/Pass.h"
Torok Edwin56d06592009-07-11 20:10:48 +000038#include "llvm/Support/ErrorHandling.h"
Alkis Evlogimenosa5c04ee2004-09-03 18:19:51 +000039#include <algorithm>
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +000040
41#define DEBUG_TYPE "basicaa"
42
Chris Lattner35997482003-11-25 18:33:40 +000043using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000044
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +000045/// Enable analysis of recursive PHI nodes.
Chandler Carruth903c5f92015-08-06 07:57:58 +000046static cl::opt<bool> EnableRecPhiAnalysis("basicaa-recphi", cl::Hidden,
47 cl::init(false));
Wei Mid67daae2015-08-05 23:40:30 +000048/// SearchLimitReached / SearchTimes shows how often the limit of
49/// to decompose GEPs is reached. It will affect the precision
50/// of basic alias analysis.
Wei Mid67daae2015-08-05 23:40:30 +000051STATISTIC(SearchLimitReached, "Number of times the limit to "
52 "decompose GEPs is reached");
53STATISTIC(SearchTimes, "Number of times a GEP is decomposed");
54
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +000055/// Cutoff after which to stop analysing a set of phi nodes potentially involved
Sanjay Patel9613b292016-01-17 23:13:48 +000056/// in a cycle. Because we are analysing 'through' phi nodes, we need to be
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +000057/// careful with value equivalence. We use reachability to make sure a value
58/// cannot be involved in a cycle.
59const unsigned MaxNumPhiBBsValueReachabilityCheck = 20;
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +000060
Arnold Schwaighofer1a444482014-03-26 21:30:19 +000061// 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.
64static const unsigned MaxLookupSearchDepth = 6;
65
Chris Lattner2d332972008-06-16 06:30:22 +000066//===----------------------------------------------------------------------===//
67// Useful predicates
68//===----------------------------------------------------------------------===//
Devang Patel09f162c2007-05-01 21:15:47 +000069
Chandler Carruthc5d81122015-08-06 08:17:06 +000070/// Returns true if the pointer is to a function-local object that never
71/// escapes from the function.
Dan Gohman84f90a32010-07-01 20:08:40 +000072static bool isNonEscapingLocalObject(const Value *V) {
Chris Lattnerfa482582008-06-16 06:28:01 +000073 // If this is a local allocation, check to see if it escapes.
Dan Gohman84f90a32010-07-01 20:08:40 +000074 if (isa<AllocaInst>(V) || isNoAliasCall(V))
Dan Gohman94e61762009-11-19 21:57:48 +000075 // 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);
Duncan Sands8d65f362009-01-05 21:19:53 +000081
Chris Lattnerfa482582008-06-16 06:28:01 +000082 // If this is an argument that corresponds to a byval or noalias argument,
Duncan Sands8d65f362009-01-05 21:19:53 +000083 // then it has not escaped before entering the function. Check if it escapes
84 // inside the function.
Dan Gohman84f90a32010-07-01 20:08:40 +000085 if (const Argument *A = dyn_cast<Argument>(V))
Richard Osbornea1fffcf2012-11-05 10:48:24 +000086 if (A->hasByValAttr() || A->hasNoAliasAttr())
Sanjay Patel9613b292016-01-17 23:13:48 +000087 // Note even if the argument is marked nocapture, we still need to check
Richard Osbornea1fffcf2012-11-05 10:48:24 +000088 // for copies made inside the function. The nocapture attribute only
89 // specifies that there are no copies made that outlive the function.
Dan Gohman84f90a32010-07-01 20:08:40 +000090 return !PointerMayBeCaptured(V, false, /*StoreCaptures=*/true);
Richard Osbornea1fffcf2012-11-05 10:48:24 +000091
Chris Lattnerb35d9b52008-06-16 06:19:11 +000092 return false;
93}
94
Chandler Carruthc5d81122015-08-06 08:17:06 +000095/// Returns true if the pointer is one which would have been considered an
96/// escape by isNonEscapingLocalObject.
Dan Gohman84f90a32010-07-01 20:08:40 +000097static bool isEscapeSource(const Value *V) {
98 if (isa<CallInst>(V) || isa<InvokeInst>(V) || isa<Argument>(V))
99 return true;
Dan Gohman0824aff2010-06-29 00:50:39 +0000100
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}
Chris Lattnerb35d9b52008-06-16 06:19:11 +0000109
Sanjay Patel9613b292016-01-17 23:13:48 +0000110/// Returns the size of the object specified by V or UnknownSize if unknown.
Rafael Espindola5f57f462014-02-21 18:34:28 +0000111static uint64_t getObjectSize(const Value *V, const DataLayout &DL,
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000112 const TargetLibraryInfo &TLI,
Eli Friedman8bc169c2012-02-27 20:46:07 +0000113 bool RoundToAlign = false) {
Nuno Lopes55fff832012-06-21 15:45:28 +0000114 uint64_t Size;
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000115 if (getObjectSize(V, Size, DL, &TLI, RoundToAlign))
Nuno Lopes55fff832012-06-21 15:45:28 +0000116 return Size;
Chandler Carruthecbd1682015-06-17 07:21:38 +0000117 return MemoryLocation::UnknownSize;
Dan Gohman44da55b2011-01-18 21:16:06 +0000118}
119
Chandler Carruthc5d81122015-08-06 08:17:06 +0000120/// Returns true if we can prove that the object specified by V is smaller than
121/// Size.
Dan Gohman44da55b2011-01-18 21:16:06 +0000122static bool isObjectSmallerThan(const Value *V, uint64_t Size,
Rafael Espindola5f57f462014-02-21 18:34:28 +0000123 const DataLayout &DL,
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000124 const TargetLibraryInfo &TLI) {
Nadav Rotemabcc64f2013-04-09 18:16:05 +0000125 // 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.
Jakub Staszak07f383f2013-08-24 14:16:00 +0000149 //
Nadav Rotemabcc64f2013-04-09 18:16:05 +0000150 // We go for 2nd option for simplicity.
151 if (!isIdentifiedObject(V))
152 return false;
153
Eli Friedman8bc169c2012-02-27 20:46:07 +0000154 // This function needs to use the aligned object size because we allow
155 // reads a bit past the end given sufficient alignment.
Chandler Carruth903c5f92015-08-06 07:57:58 +0000156 uint64_t ObjectSize = getObjectSize(V, DL, TLI, /*RoundToAlign*/ true);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000157
Chandler Carruthecbd1682015-06-17 07:21:38 +0000158 return ObjectSize != MemoryLocation::UnknownSize && ObjectSize < Size;
Dan Gohman44da55b2011-01-18 21:16:06 +0000159}
160
Chandler Carruthc5d81122015-08-06 08:17:06 +0000161/// Returns true if we can prove that the object specified by V has size Size.
Chandler Carruth903c5f92015-08-06 07:57:58 +0000162static bool isObjectSize(const Value *V, uint64_t Size, const DataLayout &DL,
163 const TargetLibraryInfo &TLI) {
Rafael Espindola5f57f462014-02-21 18:34:28 +0000164 uint64_t ObjectSize = getObjectSize(V, DL, TLI);
Chandler Carruthecbd1682015-06-17 07:21:38 +0000165 return ObjectSize != MemoryLocation::UnknownSize && ObjectSize == Size;
Chris Lattner98ad8162008-06-16 06:10:11 +0000166}
167
Chris Lattner2d332972008-06-16 06:30:22 +0000168//===----------------------------------------------------------------------===//
Chris Lattner9f7500f2010-08-18 22:07:29 +0000169// GetElementPtr Instruction Decomposition and Analysis
170//===----------------------------------------------------------------------===//
171
Chandler Carruthc5d81122015-08-06 08:17:06 +0000172/// 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
Sanjay Patel9613b292016-01-17 23:13:48 +0000177/// Value is known to have IntegerType, and it may already be sign or zero
Chandler Carruthc5d81122015-08-06 08:17:06 +0000178/// extended.
Chris Lattner3decde92010-08-18 23:09:49 +0000179///
180/// Note that this looks through extends, so the high bits may not be
181/// represented in the result.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000182/*static*/ const Value *BasicAAResult::GetLinearExpression(
Quentin Colombet5989bc62015-08-31 22:32:47 +0000183 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) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000186 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 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000194
Quentin Colombet5989bc62015-08-31 22:32:47 +0000195 if (const ConstantInt *Const = dyn_cast<ConstantInt>(V)) {
Sanjay Patel9613b292016-01-17 23:13:48 +0000196 // 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
Quentin Colombet5989bc62015-08-31 22:32:47 +0000198 // 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)) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000207 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(BOp->getOperand(1))) {
Quentin Colombet5989bc62015-08-31 22:32:47 +0000208
Sanjay Patel9613b292016-01-17 23:13:48 +0000209 // 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
Quentin Colombet5989bc62015-08-31 22:32:47 +0000211 // extensions below (see the isa<SExtInst> / isa<ZExtInst> cases).
212 APInt RHS = RHSC->getValue().zextOrSelf(Offset.getBitWidth());
213
Chris Lattner9f7500f2010-08-18 22:07:29 +0000214 switch (BOp->getOpcode()) {
Chandler Carruth903c5f92015-08-06 07:57:58 +0000215 default:
Quentin Colombet5989bc62015-08-31 22:32:47 +0000216 // We don't understand this instruction, so we can't decompose it any
217 // further.
218 Scale = 1;
219 Offset = 0;
220 return V;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000221 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.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000224 if (!MaskedValueIsZero(BOp->getOperand(0), RHSC->getValue(), DL, 0, AC,
Quentin Colombet5989bc62015-08-31 22:32:47 +0000225 BOp, DT)) {
226 Scale = 1;
227 Offset = 0;
228 return V;
229 }
Justin Bognercd1d5aa2016-08-17 20:30:52 +0000230 LLVM_FALLTHROUGH;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000231 case Instruction::Add:
Quentin Colombet5989bc62015-08-31 22:32:47 +0000232 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;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000241 case Instruction::Mul:
Quentin Colombet5989bc62015-08-31 22:32:47 +0000242 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;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000247 case Instruction::Shl:
Quentin Colombet5989bc62015-08-31 22:32:47 +0000248 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;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000255 return V;
256 }
Quentin Colombet5989bc62015-08-31 22:32:47 +0000257
258 if (isa<OverflowingBinaryOperator>(BOp)) {
259 NUW &= BOp->hasNoUnsignedWrap();
260 NSW &= BOp->hasNoSignedWrap();
261 }
262 return V;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000263 }
264 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000265
Chris Lattner9f7500f2010-08-18 22:07:29 +0000266 // Since GEP indices are sign extended anyway, we don't care about the high
Chris Lattner3decde92010-08-18 23:09:49 +0000267 // bits of a sign or zero extended value - just scales and offsets. The
268 // extensions have to be consistent though.
Quentin Colombet5989bc62015-08-31 22:32:47 +0000269 if (isa<SExtInst>(V) || isa<ZExtInst>(V)) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000270 Value *CastOp = cast<CastInst>(V)->getOperand(0);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000271 unsigned NewWidth = V->getType()->getPrimitiveSizeInBits();
Chris Lattner9f7500f2010-08-18 22:07:29 +0000272 unsigned SmallWidth = CastOp->getType()->getPrimitiveSizeInBits();
Quentin Colombet5989bc62015-08-31 22:32:47 +0000273 unsigned OldZExtBits = ZExtBits, OldSExtBits = SExtBits;
274 const Value *Result =
275 GetLinearExpression(CastOp, Scale, Offset, ZExtBits, SExtBits, DL,
276 Depth + 1, AC, DT, NSW, NUW);
Chris Lattner3decde92010-08-18 23:09:49 +0000277
Quentin Colombet5989bc62015-08-31 22:32:47 +0000278 // 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 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000314
Chris Lattner9f7500f2010-08-18 22:07:29 +0000315 return Result;
316 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000317
Chris Lattner9f7500f2010-08-18 22:07:29 +0000318 Scale = 1;
319 Offset = 0;
320 return V;
321}
322
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000323/// 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
Gerolf Hoflehnerd24671f2016-01-30 05:58:38 +0000326/// complement wrap-arounds for precise alias information.
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000327static int64_t adjustToPointerSize(int64_t Offset, unsigned PointerSize) {
328 assert(PointerSize <= 64 && "Invalid PointerSize!");
329 unsigned ShiftBits = 64 - PointerSize;
Gerolf Hoflehner73fc84b2016-01-30 05:35:09 +0000330 return (int64_t)((uint64_t)Offset << ShiftBits) >> ShiftBits;
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000331}
332
Chandler Carruthc5d81122015-08-06 08:17:06 +0000333/// 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.
Chris Lattner9f7500f2010-08-18 22:07:29 +0000335///
Chandler Carruthc5d81122015-08-06 08:17:06 +0000336/// 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.
Chris Lattner9f7500f2010-08-18 22:07:29 +0000340///
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000341/// When DataLayout is around, this function is capable of analyzing everything
Arnold Schwaighofer1a444482014-03-26 21:30:19 +0000342/// that GetUnderlyingObject can look through. To be able to do that
343/// GetUnderlyingObject and DecomposeGEPExpression must use the same search
Chandler Carruthc5d81122015-08-06 08:17:06 +0000344/// depth (MaxLookupSearchDepth). When DataLayout not is around, it just looks
345/// through pointer casts.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000346bool BasicAAResult::DecomposeGEPExpression(const Value *V,
347 DecomposedGEP &Decomposed, const DataLayout &DL, AssumptionCache *AC,
348 DominatorTree *DT) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000349 // Limit recursion depth to limit compile time in crazy cases.
Arnold Schwaighofer1a444482014-03-26 21:30:19 +0000350 unsigned MaxLookup = MaxLookupSearchDepth;
Wei Mid67daae2015-08-05 23:40:30 +0000351 SearchTimes++;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000352
Michael Kuperstein82069c42016-05-25 22:23:08 +0000353 Decomposed.StructOffset = 0;
354 Decomposed.OtherOffset = 0;
355 Decomposed.VarIndices.clear();
Chris Lattner9f7500f2010-08-18 22:07:29 +0000356 do {
357 // See if this is a bitcast or GEP.
358 const Operator *Op = dyn_cast<Operator>(V);
Craig Topper9f008862014-04-15 04:59:12 +0000359 if (!Op) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000360 // The only non-operator case we can handle are GlobalAliases.
361 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +0000362 if (!GA->isInterposable()) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000363 V = GA->getAliasee();
364 continue;
365 }
366 }
Michael Kuperstein82069c42016-05-25 22:23:08 +0000367 Decomposed.Base = V;
368 return false;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000369 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000370
Matt Arsenault70f4db882014-07-15 00:56:40 +0000371 if (Op->getOpcode() == Instruction::BitCast ||
372 Op->getOpcode() == Instruction::AddrSpaceCast) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000373 V = Op->getOperand(0);
374 continue;
375 }
Dan Gohman05b18f12010-12-15 20:49:55 +0000376
Chris Lattner9f7500f2010-08-18 22:07:29 +0000377 const GEPOperator *GEPOp = dyn_cast<GEPOperator>(Op);
Craig Topper9f008862014-04-15 04:59:12 +0000378 if (!GEPOp) {
Hal Finkel5c12d8f2016-07-11 01:32:20 +0000379 if (auto CS = ImmutableCallSite(V))
380 if (const Value *RV = CS.getReturnedArgOperand()) {
381 V = RV;
382 continue;
383 }
384
Dan Gohman0573b552011-05-24 18:24:08 +0000385 // 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))
Chandler Carruth66b31302015-01-04 12:03:27 +0000388 // TODO: Get a DominatorTree and AssumptionCache and use them here
Hal Finkel60db0582014-09-07 18:57:58 +0000389 // (these are both now available in this function, but this should be
390 // updated when GetUnderlyingObject is updated). TLI should be
391 // provided also.
Dan Gohman0573b552011-05-24 18:24:08 +0000392 if (const Value *Simplified =
Chandler Carruth903c5f92015-08-06 07:57:58 +0000393 SimplifyInstruction(const_cast<Instruction *>(I), DL)) {
Dan Gohman0573b552011-05-24 18:24:08 +0000394 V = Simplified;
395 continue;
396 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000397
Michael Kuperstein82069c42016-05-25 22:23:08 +0000398 Decomposed.Base = V;
399 return false;
Dan Gohman0573b552011-05-24 18:24:08 +0000400 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000401
Chris Lattner9f7500f2010-08-18 22:07:29 +0000402 // Don't attempt to analyze GEPs over unsized objects.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000403 if (!GEPOp->getSourceElementType()->isSized()) {
404 Decomposed.Base = V;
405 return false;
406 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000407
Matt Arsenaulta8fe22b2013-11-16 00:36:43 +0000408 unsigned AS = GEPOp->getPointerAddressSpace();
Chris Lattner9f7500f2010-08-18 22:07:29 +0000409 // Walk the indices of the GEP, accumulating them into BaseOff/VarIndices.
410 gep_type_iterator GTI = gep_type_begin(GEPOp);
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000411 unsigned PointerSize = DL.getPointerSizeInBits(AS);
Chandler Carruth903c5f92015-08-06 07:57:58 +0000412 for (User::const_op_iterator I = GEPOp->op_begin() + 1, E = GEPOp->op_end();
413 I != E; ++I) {
Quentin Colombet5989bc62015-08-31 22:32:47 +0000414 const Value *Index = *I;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000415 // Compute the (potentially symbolic) offset in bytes for this index.
Chris Lattner229907c2011-07-18 04:54:35 +0000416 if (StructType *STy = dyn_cast<StructType>(*GTI++)) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000417 // For a struct, add the member offset.
418 unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
Chandler Carruth903c5f92015-08-06 07:57:58 +0000419 if (FieldNo == 0)
420 continue;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000421
Michael Kuperstein82069c42016-05-25 22:23:08 +0000422 Decomposed.StructOffset +=
423 DL.getStructLayout(STy)->getElementOffset(FieldNo);
Chris Lattner9f7500f2010-08-18 22:07:29 +0000424 continue;
425 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000426
Chris Lattner9f7500f2010-08-18 22:07:29 +0000427 // For an array/pointer, add the element offset, explicitly scaled.
Quentin Colombet5989bc62015-08-31 22:32:47 +0000428 if (const ConstantInt *CIdx = dyn_cast<ConstantInt>(Index)) {
Chandler Carruth903c5f92015-08-06 07:57:58 +0000429 if (CIdx->isZero())
430 continue;
Michael Kuperstein82069c42016-05-25 22:23:08 +0000431 Decomposed.OtherOffset +=
432 DL.getTypeAllocSize(*GTI) * CIdx->getSExtValue();
Chris Lattner9f7500f2010-08-18 22:07:29 +0000433 continue;
434 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000435
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000436 uint64_t Scale = DL.getTypeAllocSize(*GTI);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000437 unsigned ZExtBits = 0, SExtBits = 0;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000438
Chris Lattner3decde92010-08-18 23:09:49 +0000439 // If the integer type is smaller than the pointer size, it is implicitly
440 // sign extended to pointer size.
Matt Arsenaultfa252722013-09-27 22:18:51 +0000441 unsigned Width = Index->getType()->getIntegerBitWidth();
Quentin Colombet5989bc62015-08-31 22:32:47 +0000442 if (PointerSize > Width)
443 SExtBits += PointerSize - Width;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000444
Chris Lattner3decde92010-08-18 23:09:49 +0000445 // Use GetLinearExpression to decompose the index into a C1*V+C2 form.
Chris Lattner9f7500f2010-08-18 22:07:29 +0000446 APInt IndexScale(Width, 0), IndexOffset(Width, 0);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000447 bool NSW = true, NUW = true;
448 Index = GetLinearExpression(Index, IndexScale, IndexOffset, ZExtBits,
449 SExtBits, DL, 0, AC, DT, NSW, NUW);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000450
Chris Lattner9f7500f2010-08-18 22:07:29 +0000451 // 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.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000453 Decomposed.OtherOffset += IndexOffset.getSExtValue() * Scale;
Eli Friedmanab3a1282010-09-15 20:08:03 +0000454 Scale *= IndexScale.getSExtValue();
Jakub Staszak07f383f2013-08-24 14:16:00 +0000455
Chris Lattner0ab5e2c2011-04-15 05:18:47 +0000456 // If we already had an occurrence of this index variable, merge this
Chris Lattner9f7500f2010-08-18 22:07:29 +0000457 // 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.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000460 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);
Chris Lattner9f7500f2010-08-18 22:07:29 +0000466 break;
467 }
468 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000469
Chris Lattner9f7500f2010-08-18 22:07:29 +0000470 // Make sure that we have a scale that makes sense for this target's
471 // pointer size.
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000472 Scale = adjustToPointerSize(Scale, PointerSize);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000473
Chris Lattner1b9c3872010-08-18 22:47:56 +0000474 if (Scale) {
Quentin Colombet5989bc62015-08-31 22:32:47 +0000475 VariableGEPIndex Entry = {Index, ZExtBits, SExtBits,
Jeffrey Yasskin6381c012011-07-27 06:22:51 +0000476 static_cast<int64_t>(Scale)};
Michael Kuperstein82069c42016-05-25 22:23:08 +0000477 Decomposed.VarIndices.push_back(Entry);
Chris Lattner1b9c3872010-08-18 22:47:56 +0000478 }
Chris Lattner9f7500f2010-08-18 22:07:29 +0000479 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000480
Gerolf Hoflehner87ddb652016-01-30 05:52:53 +0000481 // Take care of wrap-arounds
Michael Kuperstein82069c42016-05-25 22:23:08 +0000482 Decomposed.StructOffset =
483 adjustToPointerSize(Decomposed.StructOffset, PointerSize);
484 Decomposed.OtherOffset =
485 adjustToPointerSize(Decomposed.OtherOffset, PointerSize);
Gerolf Hoflehner87ddb652016-01-30 05:52:53 +0000486
Chris Lattner9f7500f2010-08-18 22:07:29 +0000487 // Analyze the base pointer next.
488 V = GEPOp->getOperand(0);
489 } while (--MaxLookup);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000490
Chris Lattner9f7500f2010-08-18 22:07:29 +0000491 // If the chain of expressions is too deep, just return early.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000492 Decomposed.Base = V;
Wei Mid67daae2015-08-05 23:40:30 +0000493 SearchLimitReached++;
Michael Kuperstein82069c42016-05-25 22:23:08 +0000494 return true;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000495}
496
Chandler Carruthc5d81122015-08-06 08:17:06 +0000497/// 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.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000500bool BasicAAResult::pointsToConstantMemory(const MemoryLocation &Loc,
501 bool OrLocal) {
Dan Gohman9130bad2010-11-08 16:45:26 +0000502 assert(Visited.empty() && "Visited must be cleared after use!");
Chris Lattner2d332972008-06-16 06:30:22 +0000503
Dan Gohman142ff822010-11-08 20:26:19 +0000504 unsigned MaxLookup = 8;
Dan Gohman9130bad2010-11-08 16:45:26 +0000505 SmallVector<const Value *, 16> Worklist;
506 Worklist.push_back(Loc.Ptr);
507 do {
Chandler Carruth7b560d42015-09-09 17:55:00 +0000508 const Value *V = GetUnderlyingObject(Worklist.pop_back_val(), DL);
David Blaikie70573dc2014-11-19 07:49:26 +0000509 if (!Visited.insert(V).second) {
Dan Gohman9130bad2010-11-08 16:45:26 +0000510 Visited.clear();
Chandler Carruth7b560d42015-09-09 17:55:00 +0000511 return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
Dan Gohman9130bad2010-11-08 16:45:26 +0000512 }
Dan Gohman5f1702e2010-08-06 01:25:49 +0000513
Dan Gohman9130bad2010-11-08 16:45:26 +0000514 // 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();
Chandler Carruth7b560d42015-09-09 17:55:00 +0000525 return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
Dan Gohman9130bad2010-11-08 16:45:26 +0000526 }
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)) {
Dan Gohman142ff822010-11-08 20:26:19 +0000540 // Don't bother inspecting phi nodes with many operands.
541 if (PN->getNumIncomingValues() > MaxLookup) {
542 Visited.clear();
Chandler Carruth7b560d42015-09-09 17:55:00 +0000543 return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
Dan Gohman142ff822010-11-08 20:26:19 +0000544 }
Pete Cooper833f34d2015-05-12 20:05:31 +0000545 for (Value *IncValue : PN->incoming_values())
546 Worklist.push_back(IncValue);
Dan Gohman9130bad2010-11-08 16:45:26 +0000547 continue;
548 }
549
550 // Otherwise be conservative.
551 Visited.clear();
Chandler Carruth7b560d42015-09-09 17:55:00 +0000552 return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
Dan Gohman9130bad2010-11-08 16:45:26 +0000553
Dan Gohman142ff822010-11-08 20:26:19 +0000554 } while (!Worklist.empty() && --MaxLookup);
Dan Gohman9130bad2010-11-08 16:45:26 +0000555
556 Visited.clear();
Dan Gohman142ff822010-11-08 20:26:19 +0000557 return Worklist.empty();
Chris Lattner2d332972008-06-16 06:30:22 +0000558}
559
Chandler Carruthc5d81122015-08-06 08:17:06 +0000560/// Returns the behavior when calling the given call site.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000561FunctionModRefBehavior BasicAAResult::getModRefBehavior(ImmutableCallSite CS) {
Dan Gohman5f1702e2010-08-06 01:25:49 +0000562 if (CS.doesNotAccessMemory())
563 // Can't do better than this.
Chandler Carruth194f59c2015-07-22 23:15:57 +0000564 return FMRB_DoesNotAccessMemory;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000565
Chandler Carruth194f59c2015-07-22 23:15:57 +0000566 FunctionModRefBehavior Min = FMRB_UnknownModRefBehavior;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000567
568 // If the callsite knows it only reads memory, don't return worse
569 // than that.
570 if (CS.onlyReadsMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000571 Min = FMRB_OnlyReadsMemory;
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000572 else if (CS.doesNotReadMemory())
573 Min = FMRB_DoesNotReadMemory;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000574
Igor Laevsky39d662f2015-07-11 10:30:36 +0000575 if (CS.onlyAccessesArgMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000576 Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesArgumentPointees);
Igor Laevsky39d662f2015-07-11 10:30:36 +0000577
Chandler Carruth12884f72016-03-02 15:56:53 +0000578 // 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;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000587}
588
Chandler Carruthc5d81122015-08-06 08:17:06 +0000589/// Returns the behavior when calling the given function. For use when the call
590/// site is not known.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000591FunctionModRefBehavior BasicAAResult::getModRefBehavior(const Function *F) {
Dan Gohmane461d7d2010-11-08 16:08:43 +0000592 // If the function declares it doesn't access memory, we can't do better.
Dan Gohman5f1702e2010-08-06 01:25:49 +0000593 if (F->doesNotAccessMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000594 return FMRB_DoesNotAccessMemory;
Dan Gohmane461d7d2010-11-08 16:08:43 +0000595
Chandler Carruth194f59c2015-07-22 23:15:57 +0000596 FunctionModRefBehavior Min = FMRB_UnknownModRefBehavior;
Dan Gohman2694e142010-11-10 01:02:18 +0000597
Dan Gohmane461d7d2010-11-08 16:08:43 +0000598 // If the function declares it only reads memory, go with that.
Dan Gohman5f1702e2010-08-06 01:25:49 +0000599 if (F->onlyReadsMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000600 Min = FMRB_OnlyReadsMemory;
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000601 else if (F->doesNotReadMemory())
602 Min = FMRB_DoesNotReadMemory;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000603
Igor Laevsky39d662f2015-07-11 10:30:36 +0000604 if (F->onlyAccessesArgMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000605 Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesArgumentPointees);
Igor Laevsky39d662f2015-07-11 10:30:36 +0000606
Chandler Carruth12884f72016-03-02 15:56:53 +0000607 return Min;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000608}
Owen Anderson98a36172009-02-05 23:36:27 +0000609
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000610/// Returns true if this is a writeonly (i.e Mod only) parameter.
Philip Reamesfe46cad2016-01-06 18:10:35 +0000611static bool isWriteOnlyParam(ImmutableCallSite CS, unsigned ArgIdx,
612 const TargetLibraryInfo &TLI) {
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000613 if (CS.paramHasAttr(ArgIdx + 1, Attribute::WriteOnly))
614 return true;
Hal Finkel354e23b2014-07-17 01:28:25 +0000615
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
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000619 // whenever possible.
620 // FIXME Consider handling this in InferFunctionAttr.cpp together with other
621 // attributes.
Ahmed Bougachad765a822016-04-27 19:04:35 +0000622 LibFunc::Func F;
623 if (CS.getCalledFunction() && TLI.getLibFunc(*CS.getCalledFunction(), F) &&
624 F == LibFunc::memset_pattern16 && TLI.has(F))
Philip Reamesae050a52016-01-06 04:53:16 +0000625 if (ArgIdx == 0)
Philip Reamesfe46cad2016-01-06 18:10:35 +0000626 return true;
627
628 // TODO: memset_pattern4, memset_pattern8
629 // TODO: _chk variants
630 // TODO: strcmp, strcpy
631
632 return false;
633}
634
635ModRefInfo BasicAAResult::getArgModRefInfo(ImmutableCallSite CS,
636 unsigned ArgIdx) {
637
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000638 // Checking for known builtin intrinsics and target library functions.
Philip Reamesfe46cad2016-01-06 18:10:35 +0000639 if (isWriteOnlyParam(CS, ArgIdx, TLI))
640 return MRI_Mod;
Hal Finkel354e23b2014-07-17 01:28:25 +0000641
Igor Laevsky36e84c02015-10-28 16:42:00 +0000642 if (CS.paramHasAttr(ArgIdx + 1, Attribute::ReadOnly))
643 return MRI_Ref;
644
Igor Laevsky559d1702015-10-28 17:54:48 +0000645 if (CS.paramHasAttr(ArgIdx + 1, Attribute::ReadNone))
646 return MRI_NoModRef;
647
Chandler Carruth7b560d42015-09-09 17:55:00 +0000648 return AAResultBase::getArgModRefInfo(CS, ArgIdx);
Hal Finkel354e23b2014-07-17 01:28:25 +0000649}
650
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000651static bool isIntrinsicCall(ImmutableCallSite CS, Intrinsic::ID IID) {
Hal Finkel93046912014-07-25 21:13:35 +0000652 const IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction());
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000653 return II && II->getIntrinsicID() == IID;
Hal Finkel93046912014-07-25 21:13:35 +0000654}
655
Justin Bognerabdcb3c2015-09-24 05:29:31 +0000656#ifndef NDEBUG
Justin Bogner49655f82015-09-24 04:59:24 +0000657static 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
667static 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}
Justin Bognerabdcb3c2015-09-24 05:29:31 +0000674#endif
Justin Bogner49655f82015-09-24 04:59:24 +0000675
676AliasResult 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
Chandler Carruthc5d81122015-08-06 08:17:06 +0000699/// 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.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000705ModRefInfo BasicAAResult::getModRefInfo(ImmutableCallSite CS,
706 const MemoryLocation &Loc) {
Dan Gohman41f14cf2010-09-14 21:25:10 +0000707 assert(notDifferentParent(CS.getInstruction(), Loc.Ptr) &&
Dan Gohman00ef9322010-07-07 14:27:09 +0000708 "AliasAnalysis query involving multiple functions!");
709
Chandler Carruth7b560d42015-09-09 17:55:00 +0000710 const Value *Object = GetUnderlyingObject(Loc.Ptr, DL);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000711
Dan Gohman41f14cf2010-09-14 21:25:10 +0000712 // If this is a tail call and Loc.Ptr points to a stack location, we know that
Chris Lattnerd6a49ad2009-11-22 16:05:05 +0000713 // 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))
Dan Gohman5442c712010-08-03 21:48:53 +0000718 if (const CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
Chris Lattnerd6a49ad2009-11-22 16:05:05 +0000719 if (CI->isTailCall())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000720 return MRI_NoModRef;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000721
Chris Lattnerd6a49ad2009-11-22 16:05:05 +0000722 // If the pointer is to a locally allocated object that does not escape,
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000723 // 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.
Chris Lattner1e7b37e2009-11-23 16:46:41 +0000725 if (!isa<Constant>(Object) && CS.getInstruction() != Object &&
Dan Gohman84f90a32010-07-01 20:08:40 +0000726 isNonEscapingLocalObject(Object)) {
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000727 bool PassedAsArg = false;
Igor Laevsky28eeb3f2016-01-16 12:15:53 +0000728 unsigned OperandNo = 0;
729 for (auto CI = CS.data_operands_begin(), CE = CS.data_operands_end();
730 CI != CE; ++CI, ++OperandNo) {
Chris Lattner026f5e62011-05-23 05:15:43 +0000731 // 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.
Duncan Sands19d0b472010-02-16 11:11:14 +0000734 if (!(*CI)->getType()->isPointerTy() ||
Igor Laevsky28eeb3f2016-01-16 12:15:53 +0000735 (!CS.doesNotCapture(OperandNo) && !CS.isByValArgument(OperandNo)))
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000736 continue;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000737
Dan Gohman41f14cf2010-09-14 21:25:10 +0000738 // If this is a no-capture pointer argument, see if we can tell that it
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000739 // 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.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000742 AliasResult AR =
743 getBestAAResults().alias(MemoryLocation(*CI), MemoryLocation(Object));
744 if (AR) {
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000745 PassedAsArg = true;
746 break;
747 }
748 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000749
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000750 if (!PassedAsArg)
Chandler Carruth194f59c2015-07-22 23:15:57 +0000751 return MRI_NoModRef;
Chris Lattnerd6a49ad2009-11-22 16:05:05 +0000752 }
753
Philip Reamesd9f4a3d2016-03-09 23:19:56 +0000754 // 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
Hal Finkel93046912014-07-25 21:13:35 +0000768 // 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.
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000771 if (isIntrinsicCall(CS, Intrinsic::assume))
Chandler Carruth194f59c2015-07-22 23:15:57 +0000772 return MRI_NoModRef;
Hal Finkel93046912014-07-25 21:13:35 +0000773
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000774 // 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
Anna Thomas037e5402016-08-09 17:18:05 +0000784 // 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
Chandler Carruth7b560d42015-09-09 17:55:00 +0000810 // The AAResultBase base class has some smarts, lets use them.
811 return AAResultBase::getModRefInfo(CS, Loc);
Dan Gohman64d842e2010-09-08 01:32:20 +0000812}
Chris Lattner2d332972008-06-16 06:30:22 +0000813
Chandler Carruth7b560d42015-09-09 17:55:00 +0000814ModRefInfo BasicAAResult::getModRefInfo(ImmutableCallSite CS1,
815 ImmutableCallSite CS2) {
Hal Finkel93046912014-07-25 21:13:35 +0000816 // 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.
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000819 if (isIntrinsicCall(CS1, Intrinsic::assume) ||
820 isIntrinsicCall(CS2, Intrinsic::assume))
Chandler Carruth194f59c2015-07-22 23:15:57 +0000821 return MRI_NoModRef;
Hal Finkel93046912014-07-25 21:13:35 +0000822
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000823 // 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
Chandler Carruth7b560d42015-09-09 17:55:00 +0000840 // The AAResultBase base class has some smarts, lets use them.
841 return AAResultBase::getModRefInfo(CS1, CS2);
Hal Finkel93046912014-07-25 21:13:35 +0000842}
843
Chandler Carruthc5d81122015-08-06 08:17:06 +0000844/// Provide ad-hoc rules to disambiguate accesses through two GEP operators,
845/// both having the exact same pointer operand.
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000846static AliasResult aliasSameBasePointerGEPs(const GEPOperator *GEP1,
847 uint64_t V1Size,
848 const GEPOperator *GEP2,
849 uint64_t V2Size,
850 const DataLayout &DL) {
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000851
Hal Finkel5c12d8f2016-07-11 01:32:20 +0000852 assert(GEP1->getPointerOperand()->stripPointerCasts() ==
853 GEP2->getPointerOperand()->stripPointerCasts() &&
854 GEP1->getPointerOperand()->getType() ==
855 GEP2->getPointerOperand()->getType() &&
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000856 "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).
Daniel Berlin73694bb2016-06-01 18:55:32 +0000861 if (GEP1->getNumIndices() != GEP2->getNumIndices() ||
862 GEP1->getNumIndices() < 2)
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000863 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000864
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.
Chandler Carruthecbd1682015-06-17 07:21:38 +0000867 if (V1Size == MemoryLocation::UnknownSize ||
868 V2Size == MemoryLocation::UnknownSize)
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000869 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000870
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
James Molloy5a4d8cd2015-10-22 13:28:18 +0000876 // 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.
Vedant Kumaree202942016-05-11 15:45:43 +0000878 if (C1 && C2 && C1->getSExtValue() == C2->getSExtValue())
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000879 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000880
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(
David Blaikied288fb82015-03-30 21:41:43 +0000896 GEP1->getSourceElementType(), IntermediateIndices)))
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000897 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000898 IntermediateIndices.push_back(GEP1->getOperand(i + 1));
899 }
900
James Molloy5a4d8cd2015-10-22 13:28:18 +0000901 auto *Ty = GetElementPtrInst::getIndexedType(
902 GEP1->getSourceElementType(), IntermediateIndices);
903 StructType *LastIndexedStruct = dyn_cast<StructType>(Ty);
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000904
James Molloy5a4d8cd2015-10-22 13:28:18 +0000905 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
James Molloy05a896a2015-10-23 14:17:03 +0000915 // 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
James Molloy5a4d8cd2015-10-22 13:28:18 +0000922 for (unsigned i = 0, e = GEP1->getNumIndices() - 1; i != e; ++i)
923 if (GEP1->getOperand(i + 1) != GEP2->getOperand(i + 1))
924 return MayAlias;
James Molloy05a896a2015-10-23 14:17:03 +0000925
James Molloy5a4d8cd2015-10-22 13:28:18 +0000926 // 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;
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000940 return MayAlias;
James Molloy5a4d8cd2015-10-22 13:28:18 +0000941 } else if (!LastIndexedStruct || !C1 || !C2) {
942 return MayAlias;
943 }
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000944
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))
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000972 return NoAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000973
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000974 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000975}
976
Michael Kuperstein82069c42016-05-25 22:23:08 +0000977// 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.
Michael Kupersteinae214912016-05-26 19:30:49 +0000982// 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.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000987//
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.
1008bool BasicAAResult::isGEPBaseAtNegativeOffset(const GEPOperator *GEPOp,
Michael Kupersteinae214912016-05-26 19:30:49 +00001009 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())
Michael Kuperstein82069c42016-05-25 22:23:08 +00001013 return false;
1014
Michael Kupersteinae214912016-05-26 19:30:49 +00001015 // 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())
Michael Kuperstein82069c42016-05-25 22:23:08 +00001021 return false;
1022
Michael Kupersteinae214912016-05-26 19:30:49 +00001023 int64_t ObjectBaseOffset = DecompObject.StructOffset +
1024 DecompObject.OtherOffset;
Michael Kuperstein82069c42016-05-25 22:23:08 +00001025
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
Michael Kupersteinae214912016-05-26 19:30:49 +00001035 return (GEPBaseOffset >= ObjectBaseOffset + (int64_t)ObjectAccessSize);
Michael Kuperstein82069c42016-05-25 22:23:08 +00001036}
1037
Chandler Carruthc5d81122015-08-06 08:17:06 +00001038/// Provides a bunch of ad-hoc rules to disambiguate a GEP instruction against
1039/// another pointer.
Chris Lattnera99edbe2009-11-26 02:11:08 +00001040///
Chandler Carruthc5d81122015-08-06 08:17:06 +00001041/// 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.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001044AliasResult 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) {
Michael Kuperstein82069c42016-05-25 22:23:08 +00001049 DecomposedGEP DecompGEP1, DecompGEP2;
1050 bool GEP1MaxLookupReached =
1051 DecomposeGEPExpression(GEP1, DecompGEP1, DL, &AC, DT);
1052 bool GEP2MaxLookupReached =
1053 DecomposeGEPExpression(V2, DecompGEP2, DL, &AC, DT);
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001054
Michael Kuperstein82069c42016-05-25 22:23:08 +00001055 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;
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001068 // 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.
Chris Lattnera99edbe2009-11-26 02:11:08 +00001071 if (const GEPOperator *GEP2 = dyn_cast<GEPOperator>(V2)) {
Michael Kuperstein82069c42016-05-25 22:23:08 +00001072 // 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;
Arnold Schwaighoferaadf1042013-03-26 18:07:53 +00001077 // Do the base pointers alias?
Chandler Carruthecbd1682015-06-17 07:21:38 +00001078 AliasResult BaseAlias =
1079 aliasCheck(UnderlyingV1, MemoryLocation::UnknownSize, AAMDNodes(),
1080 UnderlyingV2, MemoryLocation::UnknownSize, AAMDNodes());
Arnold Schwaighoferaadf1042013-03-26 18:07:53 +00001081
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001082 // Check for geps of non-aliasing underlying pointers where the offsets are
1083 // identical.
Arnold Schwaighoferaadf1042013-03-26 18:07:53 +00001084 if ((BaseAlias == MayAlias) && V1Size == V2Size) {
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001085 // Do the base pointers alias assuming type and size.
Chandler Carruth903c5f92015-08-06 07:57:58 +00001086 AliasResult PreciseBaseAlias = aliasCheck(UnderlyingV1, V1Size, V1AAInfo,
1087 UnderlyingV2, V2Size, V2AAInfo);
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001088 if (PreciseBaseAlias == NoAlias) {
1089 // See if the computed offset from the common pointer tells us about the
1090 // relation of the resulting pointer.
Arnold Schwaighofer1a444482014-03-26 21:30:19 +00001091 // If the max search depth is reached the result is undefined
1092 if (GEP2MaxLookupReached || GEP1MaxLookupReached)
1093 return MayAlias;
1094
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001095 // Same offsets.
1096 if (GEP1BaseOffset == GEP2BaseOffset &&
Michael Kuperstein82069c42016-05-25 22:23:08 +00001097 DecompGEP1.VarIndices == DecompGEP2.VarIndices)
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001098 return NoAlias;
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001099 }
1100 }
Jakub Staszak07f383f2013-08-24 14:16:00 +00001101
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001102 // If we get a No or May, then return it immediately, no amount of analysis
1103 // will improve this situation.
Chandler Carruth903c5f92015-08-06 07:57:58 +00001104 if (BaseAlias != MustAlias)
1105 return BaseAlias;
Jakub Staszak07f383f2013-08-24 14:16:00 +00001106
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001107 // 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.
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +00001110 // 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.
Hal Finkel5c12d8f2016-07-11 01:32:20 +00001113 if (GEP1->getPointerOperand()->stripPointerCasts() ==
1114 GEP2->getPointerOperand()->stripPointerCasts() &&
1115 GEP1->getPointerOperand()->getType() ==
1116 GEP2->getPointerOperand()->getType()) {
Chandler Carruth7b560d42015-09-09 17:55:00 +00001117 AliasResult R = aliasSameBasePointerGEPs(GEP1, V1Size, GEP2, V2Size, DL);
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +00001118 // If we couldn't find anything interesting, don't abandon just yet.
1119 if (R != MayAlias)
1120 return R;
1121 }
1122
Sanjay Patel9613b292016-01-17 23:13:48 +00001123 // If the max search depth is reached, the result is undefined
Arnold Schwaighofer1a444482014-03-26 21:30:19 +00001124 if (GEP2MaxLookupReached || GEP1MaxLookupReached)
1125 return MayAlias;
Jakub Staszak07f383f2013-08-24 14:16:00 +00001126
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001127 // Subtract the GEP2 pointer from the GEP1 pointer to find out their
1128 // symbolic difference.
1129 GEP1BaseOffset -= GEP2BaseOffset;
Michael Kuperstein82069c42016-05-25 22:23:08 +00001130 GetIndexDifference(DecompGEP1.VarIndices, DecompGEP2.VarIndices);
Jakub Staszak07f383f2013-08-24 14:16:00 +00001131
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001132 } 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.
Chris Lattner5c1cfc22009-11-26 16:52:32 +00001136
1137 // If both accesses are unknown size, we can't do anything useful here.
Chandler Carruthecbd1682015-06-17 07:21:38 +00001138 if (V1Size == MemoryLocation::UnknownSize &&
1139 V2Size == MemoryLocation::UnknownSize)
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001140 return MayAlias;
Chris Lattner6ea17f77f2003-12-11 22:44:13 +00001141
Chandler Carruthecbd1682015-06-17 07:21:38 +00001142 AliasResult R = aliasCheck(UnderlyingV1, MemoryLocation::UnknownSize,
Ehsan Amiri17e17012016-08-12 16:05:03 +00001143 AAMDNodes(), V2, V2Size, V2AAInfo,
1144 nullptr, UnderlyingV2);
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001145 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;
Chris Lattner6ea17f77f2003-12-11 22:44:13 +00001152
Arnold Schwaighofer1a444482014-03-26 21:30:19 +00001153 // If the max search depth is reached the result is undefined
1154 if (GEP1MaxLookupReached)
1155 return MayAlias;
Chris Lattner6ea17f77f2003-12-11 22:44:13 +00001156 }
Jakub Staszak07f383f2013-08-24 14:16:00 +00001157
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001158 // 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
Sanjay Patel9613b292016-01-17 23:13:48 +00001160 // happens when we have two lexically identical GEP's (for example).
Chris Lattnerd6a2a992003-02-26 19:41:54 +00001161 //
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001162 // 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.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001164 if (GEP1BaseOffset == 0 && DecompGEP1.VarIndices.empty())
Evan Chengc1eed9d2009-10-14 06:41:49 +00001165 return MustAlias;
Evan Chengf1f3dd32009-10-13 18:42:04 +00001166
Eli Friedman3d1b3072011-09-08 02:23:31 +00001167 // 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.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001171 if (GEP1BaseOffset != 0 && DecompGEP1.VarIndices.empty()) {
Eli Friedman3d1b3072011-09-08 02:23:31 +00001172 if (GEP1BaseOffset >= 0) {
Chandler Carruthecbd1682015-06-17 07:21:38 +00001173 if (V2Size != MemoryLocation::UnknownSize) {
Eli Friedman3d1b3072011-09-08 02:23:31 +00001174 if ((uint64_t)GEP1BaseOffset < V2Size)
1175 return PartialAlias;
1176 return NoAlias;
1177 }
1178 } else {
Arnold Schwaighofere3ac0992014-01-16 04:53:18 +00001179 // 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, ...).
Chandler Carruthecbd1682015-06-17 07:21:38 +00001187 if (V1Size != MemoryLocation::UnknownSize &&
1188 V2Size != MemoryLocation::UnknownSize) {
Eli Friedman3d1b3072011-09-08 02:23:31 +00001189 if (-(uint64_t)GEP1BaseOffset < V1Size)
1190 return PartialAlias;
1191 return NoAlias;
1192 }
1193 }
Dan Gohmanc4bf5ca2010-12-13 22:50:24 +00001194 }
1195
Michael Kuperstein82069c42016-05-25 22:23:08 +00001196 if (!DecompGEP1.VarIndices.empty()) {
Eli Friedmanb78ac542011-09-08 02:37:07 +00001197 uint64_t Modulo = 0;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001198 bool AllPositive = true;
Michael Kuperstein82069c42016-05-25 22:23:08 +00001199 for (unsigned i = 0, e = DecompGEP1.VarIndices.size(); i != e; ++i) {
Quentin Colombet5989bc62015-08-31 22:32:47 +00001200
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.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001205 Modulo |= (uint64_t)DecompGEP1.VarIndices[i].Scale;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001206
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:
Michael Kuperstein82069c42016-05-25 22:23:08 +00001211 const Value *V = DecompGEP1.VarIndices[i].V;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001212
1213 bool SignKnownZero, SignKnownOne;
Chandler Carruth7b560d42015-09-09 17:55:00 +00001214 ComputeSignBit(const_cast<Value *>(V), SignKnownZero, SignKnownOne, DL,
1215 0, &AC, nullptr, DT);
Quentin Colombet5989bc62015-08-31 22:32:47 +00001216
1217 // Zero-extension widens the variable, and so forces the sign
1218 // bit to zero.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001219 bool IsZExt = DecompGEP1.VarIndices[i].ZExtBits > 0 || isa<ZExtInst>(V);
Quentin Colombet5989bc62015-08-31 22:32:47 +00001220 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.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001226 int64_t Scale = DecompGEP1.VarIndices[i].Scale;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001227 AllPositive =
1228 (SignKnownZero && Scale >= 0) || (SignKnownOne && Scale < 0);
1229 }
1230 }
1231
Eli Friedmanb78ac542011-09-08 02:37:07 +00001232 Modulo = Modulo ^ (Modulo & (Modulo - 1));
Eli Friedman3d1b3072011-09-08 02:23:31 +00001233
Eli Friedmanb78ac542011-09-08 02:37:07 +00001234 // 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);
Chandler Carruthecbd1682015-06-17 07:21:38 +00001238 if (V1Size != MemoryLocation::UnknownSize &&
1239 V2Size != MemoryLocation::UnknownSize && ModOffset >= V2Size &&
1240 V1Size <= Modulo - ModOffset)
Eli Friedmanb78ac542011-09-08 02:37:07 +00001241 return NoAlias;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001242
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
Michael Kuperstein82069c42016-05-25 22:23:08 +00001249 if (constantOffsetHeuristic(DecompGEP1.VarIndices, V1Size, V2Size,
Chandler Carruth7b560d42015-09-09 17:55:00 +00001250 GEP1BaseOffset, &AC, DT))
Quentin Colombet5989bc62015-08-31 22:32:47 +00001251 return NoAlias;
Eli Friedmanb78ac542011-09-08 02:37:07 +00001252 }
Eli Friedman3d1b3072011-09-08 02:23:31 +00001253
Dan Gohmanadf80ae2011-06-04 06:50:18 +00001254 // 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
Dan Gohman9017b842012-02-17 18:33:38 +00001260 // indices into arrays of unions or malloc'd memory.
Dan Gohmanadf80ae2011-06-04 06:50:18 +00001261 return PartialAlias;
Evan Chengf1f3dd32009-10-13 18:42:04 +00001262}
1263
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001264static AliasResult MergeAliasResults(AliasResult A, AliasResult B) {
Dan Gohman4e7e7952011-06-03 20:17:36 +00001265 // If the results agree, take it.
1266 if (A == B)
1267 return A;
1268 // A mix of PartialAlias and MustAlias is PartialAlias.
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001269 if ((A == PartialAlias && B == MustAlias) ||
1270 (B == PartialAlias && A == MustAlias))
1271 return PartialAlias;
Dan Gohman4e7e7952011-06-03 20:17:36 +00001272 // Otherwise, we don't know anything.
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001273 return MayAlias;
Dan Gohman4e7e7952011-06-03 20:17:36 +00001274}
1275
Chandler Carruthc5d81122015-08-06 08:17:06 +00001276/// Provides a bunch of ad-hoc rules to disambiguate a Select instruction
1277/// against another.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001278AliasResult BasicAAResult::aliasSelect(const SelectInst *SI, uint64_t SISize,
1279 const AAMDNodes &SIAAInfo,
1280 const Value *V2, uint64_t V2Size,
Ehsan Amiri17e17012016-08-12 16:05:03 +00001281 const AAMDNodes &V2AAInfo,
1282 const Value *UnderV2) {
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001283 // 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()) {
Chandler Carruth903c5f92015-08-06 07:57:58 +00001287 AliasResult Alias = aliasCheck(SI->getTrueValue(), SISize, SIAAInfo,
1288 SI2->getTrueValue(), V2Size, V2AAInfo);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001289 if (Alias == MayAlias)
1290 return MayAlias;
1291 AliasResult ThisAlias =
Chandler Carruth903c5f92015-08-06 07:57:58 +00001292 aliasCheck(SI->getFalseValue(), SISize, SIAAInfo,
1293 SI2->getFalseValue(), V2Size, V2AAInfo);
Dan Gohman4e7e7952011-06-03 20:17:36 +00001294 return MergeAliasResults(ThisAlias, Alias);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001295 }
1296
1297 // If both arms of the Select node NoAlias or MustAlias V2, then returns
1298 // NoAlias / MustAlias. Otherwise, returns MayAlias.
1299 AliasResult Alias =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001300 aliasCheck(V2, V2Size, V2AAInfo, SI->getTrueValue(),
1301 SISize, SIAAInfo, UnderV2);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001302 if (Alias == MayAlias)
1303 return MayAlias;
Dan Gohman7c34ece2010-06-28 21:16:52 +00001304
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001305 AliasResult ThisAlias =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001306 aliasCheck(V2, V2Size, V2AAInfo, SI->getFalseValue(), SISize, SIAAInfo,
1307 UnderV2);
Dan Gohman4e7e7952011-06-03 20:17:36 +00001308 return MergeAliasResults(ThisAlias, Alias);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001309}
1310
Chandler Carruthc5d81122015-08-06 08:17:06 +00001311/// Provide a bunch of ad-hoc rules to disambiguate a PHI instruction against
1312/// another.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001313AliasResult BasicAAResult::aliasPHI(const PHINode *PN, uint64_t PNSize,
1314 const AAMDNodes &PNAAInfo, const Value *V2,
Ehsan Amiri17e17012016-08-12 16:05:03 +00001315 uint64_t V2Size, const AAMDNodes &V2AAInfo,
1316 const Value *UnderV2) {
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001317 // Track phi nodes we have visited. We use this information when we determine
1318 // value equivalence.
1319 VisitedPhiBBs.insert(PN->getParent());
1320
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001321 // 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()) {
Chandler Carruthac80dc72015-06-17 07:18:54 +00001326 LocPair Locs(MemoryLocation(PN, PNSize, PNAAInfo),
1327 MemoryLocation(V2, V2Size, V2AAInfo));
Arnold Schwaighofer8dc34cf2012-09-06 14:41:53 +00001328 if (PN > V2)
1329 std::swap(Locs.first, Locs.second);
Arnold Schwaighoferedd62b12012-12-10 23:02:41 +00001330 // 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;
Arnold Schwaighofer8dc34cf2012-09-06 14:41:53 +00001342
Hal Finkela6f86fc2012-11-17 02:33:15 +00001343 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001344 AliasResult ThisAlias =
Chandler Carruth903c5f92015-08-06 07:57:58 +00001345 aliasCheck(PN->getIncomingValue(i), PNSize, PNAAInfo,
1346 PN2->getIncomingValueForBlock(PN->getIncomingBlock(i)),
1347 V2Size, V2AAInfo);
Dan Gohman4e7e7952011-06-03 20:17:36 +00001348 Alias = MergeAliasResults(ThisAlias, Alias);
1349 if (Alias == MayAlias)
1350 break;
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001351 }
Arnold Schwaighofer8dc34cf2012-09-06 14:41:53 +00001352
1353 // Reset if speculation failed.
Arnold Schwaighoferedd62b12012-12-10 23:02:41 +00001354 if (Alias != NoAlias)
Arnold Schwaighofer8dc34cf2012-09-06 14:41:53 +00001355 AliasCache[Locs] = OrigAliasResult;
1356
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001357 return Alias;
1358 }
1359
Chandler Carruth903c5f92015-08-06 07:57:58 +00001360 SmallPtrSet<Value *, 4> UniqueSrc;
1361 SmallVector<Value *, 4> V1Srcs;
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +00001362 bool isRecursive = false;
Pete Cooper833f34d2015-05-12 20:05:31 +00001363 for (Value *PV1 : PN->incoming_values()) {
Evan Chengc10e88d2009-10-13 22:02:20 +00001364 if (isa<PHINode>(PV1))
1365 // If any of the source itself is a PHI, return MayAlias conservatively
Evan Chengc1eed9d2009-10-14 06:41:49 +00001366 // 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.
Evan Chengc10e88d2009-10-13 22:02:20 +00001369 return MayAlias;
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +00001370
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
David Blaikie70573dc2014-11-19 07:49:26 +00001384 if (UniqueSrc.insert(PV1).second)
Evan Chengc10e88d2009-10-13 22:02:20 +00001385 V1Srcs.push_back(PV1);
1386 }
1387
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +00001388 // 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
Chandler Carruth903c5f92015-08-06 07:57:58 +00001394 AliasResult Alias =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001395 aliasCheck(V2, V2Size, V2AAInfo, V1Srcs[0],
1396 PNSize, PNAAInfo, UnderV2);
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +00001397
Evan Chengf92f5552009-10-14 05:22:03 +00001398 // 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
Evan Chengc10e88d2009-10-13 22:02:20 +00001403 // If all sources of the PHI node NoAlias or MustAlias V2, then returns
1404 // NoAlias / MustAlias. Otherwise, returns MayAlias.
Evan Chengc10e88d2009-10-13 22:02:20 +00001405 for (unsigned i = 1, e = V1Srcs.size(); i != e; ++i) {
1406 Value *V = V1Srcs[i];
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001407
Chandler Carruth903c5f92015-08-06 07:57:58 +00001408 AliasResult ThisAlias =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001409 aliasCheck(V2, V2Size, V2AAInfo, V, PNSize, PNAAInfo, UnderV2);
Dan Gohman4e7e7952011-06-03 20:17:36 +00001410 Alias = MergeAliasResults(ThisAlias, Alias);
1411 if (Alias == MayAlias)
1412 break;
Evan Chengc10e88d2009-10-13 22:02:20 +00001413 }
1414
1415 return Alias;
1416}
1417
David Majnemer0345b0f2015-11-17 08:15:08 +00001418/// Provides a bunch of ad-hoc rules to disambiguate in common cases, such as
Chandler Carruthc5d81122015-08-06 08:17:06 +00001419/// array references.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001420AliasResult BasicAAResult::aliasCheck(const Value *V1, uint64_t V1Size,
1421 AAMDNodes V1AAInfo, const Value *V2,
Ehsan Amiri17e17012016-08-12 16:05:03 +00001422 uint64_t V2Size, AAMDNodes V2AAInfo,
1423 const Value *O1, const Value *O2) {
Dan Gohmancb45bd92010-04-08 18:11:50 +00001424 // 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
Evan Chengf1f3dd32009-10-13 18:42:04 +00001429 // Strip off any casts if they exist.
1430 V1 = V1->stripPointerCasts();
1431 V2 = V2->stripPointerCasts();
1432
Daniel Berlin3459d6e2015-05-05 18:10:49 +00001433 // 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
Evan Chengf1f3dd32009-10-13 18:42:04 +00001438 // Are we checking for alias of the same value?
Sanjay Patel9613b292016-01-17 23:13:48 +00001439 // Because we look 'through' phi nodes, we could look at "Value" pointers from
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001440 // 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;
Evan Chengf1f3dd32009-10-13 18:42:04 +00001446
Duncan Sands19d0b472010-02-16 11:11:14 +00001447 if (!V1->getType()->isPointerTy() || !V2->getType()->isPointerTy())
Chandler Carruth903c5f92015-08-06 07:57:58 +00001448 return NoAlias; // Scalars cannot alias each other
Evan Chengf1f3dd32009-10-13 18:42:04 +00001449
1450 // Figure out what objects these things are pointing to if we can.
Ehsan Amiri17e17012016-08-12 16:05:03 +00001451 if (O1 == nullptr)
1452 O1 = GetUnderlyingObject(V1, DL, MaxLookupSearchDepth);
1453
1454 if (O2 == nullptr)
1455 O2 = GetUnderlyingObject(V2, DL, MaxLookupSearchDepth);
Evan Chengf1f3dd32009-10-13 18:42:04 +00001456
Dan Gohmanccb45842009-11-09 19:29:11 +00001457 // 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
Evan Chengf1f3dd32009-10-13 18:42:04 +00001466 if (O1 != O2) {
Sanjay Patel9613b292016-01-17 23:13:48 +00001467 // If V1/V2 point to two different objects, we know that we have no alias.
Dan Gohman00ef9322010-07-07 14:27:09 +00001468 if (isIdentifiedObject(O1) && isIdentifiedObject(O2))
Evan Chengf1f3dd32009-10-13 18:42:04 +00001469 return NoAlias;
Nick Lewyckyc53e2ec2009-11-14 06:15:14 +00001470
1471 // Constant pointers can't alias with non-const isIdentifiedObject objects.
Dan Gohman00ef9322010-07-07 14:27:09 +00001472 if ((isa<Constant>(O1) && isIdentifiedObject(O2) && !isa<Constant>(O2)) ||
1473 (isa<Constant>(O2) && isIdentifiedObject(O1) && !isa<Constant>(O1)))
Nick Lewyckyc53e2ec2009-11-14 06:15:14 +00001474 return NoAlias;
1475
Michael Kupersteinf3e663a2013-05-28 08:17:48 +00001476 // 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)))
Dan Gohman84f90a32010-07-01 20:08:40 +00001480 return NoAlias;
Evan Chengf1f3dd32009-10-13 18:42:04 +00001481
1482 // Most objects can't alias null.
Dan Gohman00ef9322010-07-07 14:27:09 +00001483 if ((isa<ConstantPointerNull>(O2) && isKnownNonNull(O1)) ||
1484 (isa<ConstantPointerNull>(O1) && isKnownNonNull(O2)))
Evan Chengf1f3dd32009-10-13 18:42:04 +00001485 return NoAlias;
Jakub Staszak07f383f2013-08-24 14:16:00 +00001486
Dan Gohman5b0a8a82010-07-07 14:30:04 +00001487 // 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
Evan Chengf1f3dd32009-10-13 18:42:04 +00001502 // 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.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001504 if ((V1Size != MemoryLocation::UnknownSize &&
1505 isObjectSmallerThan(O2, V1Size, DL, TLI)) ||
1506 (V2Size != MemoryLocation::UnknownSize &&
1507 isObjectSmallerThan(O1, V2Size, DL, TLI)))
1508 return NoAlias;
Jakub Staszak07f383f2013-08-24 14:16:00 +00001509
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001510 // Check the cache before climbing up use-def chains. This also terminates
1511 // otherwise infinitely recursive queries.
Chandler Carruthac80dc72015-06-17 07:18:54 +00001512 LocPair Locs(MemoryLocation(V1, V1Size, V1AAInfo),
1513 MemoryLocation(V2, V2Size, V2AAInfo));
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001514 if (V1 > V2)
1515 std::swap(Locs.first, Locs.second);
1516 std::pair<AliasCacheTy::iterator, bool> Pair =
Chandler Carruth903c5f92015-08-06 07:57:58 +00001517 AliasCache.insert(std::make_pair(Locs, MayAlias));
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001518 if (!Pair.second)
1519 return Pair.first->second;
1520
Chris Lattner89288992009-11-26 02:13:03 +00001521 // 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.
Chris Lattnerb2647b92009-10-17 23:48:54 +00001523 if (!isa<GEPOperator>(V1) && isa<GEPOperator>(V2)) {
Chris Lattnerd6a2a992003-02-26 19:41:54 +00001524 std::swap(V1, V2);
1525 std::swap(V1Size, V2Size);
Chris Lattner5341c962009-11-26 02:14:59 +00001526 std::swap(O1, O2);
Hal Finkelcc39b672014-07-24 12:16:19 +00001527 std::swap(V1AAInfo, V2AAInfo);
Chris Lattnerd6a2a992003-02-26 19:41:54 +00001528 }
Dan Gohman02538ac2010-10-18 18:04:47 +00001529 if (const GEPOperator *GV1 = dyn_cast<GEPOperator>(V1)) {
Chandler Carruth903c5f92015-08-06 07:57:58 +00001530 AliasResult Result =
1531 aliasGEP(GV1, V1Size, V1AAInfo, V2, V2Size, V2AAInfo, O1, O2);
1532 if (Result != MayAlias)
1533 return AliasCache[Locs] = Result;
Dan Gohman02538ac2010-10-18 18:04:47 +00001534 }
Evan Chengc10e88d2009-10-13 22:02:20 +00001535
1536 if (isa<PHINode>(V2) && !isa<PHINode>(V1)) {
1537 std::swap(V1, V2);
Ehsan Amiri17e17012016-08-12 16:05:03 +00001538 std::swap(O1, O2);
Evan Chengc10e88d2009-10-13 22:02:20 +00001539 std::swap(V1Size, V2Size);
Hal Finkelcc39b672014-07-24 12:16:19 +00001540 std::swap(V1AAInfo, V2AAInfo);
Evan Chengc10e88d2009-10-13 22:02:20 +00001541 }
Dan Gohman02538ac2010-10-18 18:04:47 +00001542 if (const PHINode *PN = dyn_cast<PHINode>(V1)) {
Ehsan Amiri17e17012016-08-12 16:05:03 +00001543 AliasResult Result = aliasPHI(PN, V1Size, V1AAInfo,
1544 V2, V2Size, V2AAInfo, O2);
Chandler Carruth903c5f92015-08-06 07:57:58 +00001545 if (Result != MayAlias)
1546 return AliasCache[Locs] = Result;
Dan Gohman02538ac2010-10-18 18:04:47 +00001547 }
Misha Brukman01808ca2005-04-21 21:13:18 +00001548
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001549 if (isa<SelectInst>(V2) && !isa<SelectInst>(V1)) {
1550 std::swap(V1, V2);
Ehsan Amiri17e17012016-08-12 16:05:03 +00001551 std::swap(O1, O2);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001552 std::swap(V1Size, V2Size);
Hal Finkelcc39b672014-07-24 12:16:19 +00001553 std::swap(V1AAInfo, V2AAInfo);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001554 }
Dan Gohman02538ac2010-10-18 18:04:47 +00001555 if (const SelectInst *S1 = dyn_cast<SelectInst>(V1)) {
Chandler Carruth903c5f92015-08-06 07:57:58 +00001556 AliasResult Result =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001557 aliasSelect(S1, V1Size, V1AAInfo, V2, V2Size, V2AAInfo, O2);
Chandler Carruth903c5f92015-08-06 07:57:58 +00001558 if (Result != MayAlias)
1559 return AliasCache[Locs] = Result;
Dan Gohman02538ac2010-10-18 18:04:47 +00001560 }
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001561
Dan Gohman44da55b2011-01-18 21:16:06 +00001562 // If both pointers are pointing into the same object and one of them
Sanjay Patel9613b292016-01-17 23:13:48 +00001563 // accesses the entire object, then the accesses must overlap in some way.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001564 if (O1 == O2)
Chandler Carruthecbd1682015-06-17 07:21:38 +00001565 if ((V1Size != MemoryLocation::UnknownSize &&
Chandler Carruth7b560d42015-09-09 17:55:00 +00001566 isObjectSize(O1, V1Size, DL, TLI)) ||
Chandler Carruthecbd1682015-06-17 07:21:38 +00001567 (V2Size != MemoryLocation::UnknownSize &&
Chandler Carruth7b560d42015-09-09 17:55:00 +00001568 isObjectSize(O2, V2Size, DL, TLI)))
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001569 return AliasCache[Locs] = PartialAlias;
Dan Gohman44da55b2011-01-18 21:16:06 +00001570
Chandler Carruth7b560d42015-09-09 17:55:00 +00001571 // 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);
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001575 return AliasCache[Locs] = Result;
Chris Lattnerd6a2a992003-02-26 19:41:54 +00001576}
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001577
Chandler Carruthc5d81122015-08-06 08:17:06 +00001578/// 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).
Chandler Carruth7b560d42015-09-09 17:55:00 +00001585bool BasicAAResult::isValueEqualInPotentialCycles(const Value *V,
1586 const Value *V2) {
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001587 if (V != V2)
1588 return false;
1589
1590 const Instruction *Inst = dyn_cast<Instruction>(V);
1591 if (!Inst)
1592 return true;
1593
Daniel Berlin9e77de22015-03-20 18:05:49 +00001594 if (VisitedPhiBBs.empty())
1595 return true;
1596
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001597 if (VisitedPhiBBs.size() > MaxNumPhiBBsValueReachabilityCheck)
1598 return false;
1599
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001600 // 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.
Craig Topper46276792014-08-24 23:23:06 +00001603 for (auto *P : VisitedPhiBBs)
Duncan P. N. Exon Smith5a82c912015-10-10 00:53:03 +00001604 if (isPotentiallyReachable(&P->front(), Inst, DT, LI))
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001605 return false;
1606
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001607 return true;
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001608}
1609
Chandler Carruthc5d81122015-08-06 08:17:06 +00001610/// 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.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001614void BasicAAResult::GetIndexDifference(
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001615 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;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001622 unsigned ZExtBits = Src[i].ZExtBits, SExtBits = Src[i].SExtBits;
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001623 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) {
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001628 if (!isValueEqualInPotentialCycles(Dest[j].V, V) ||
Quentin Colombet5989bc62015-08-31 22:32:47 +00001629 Dest[j].ZExtBits != ZExtBits || Dest[j].SExtBits != SExtBits)
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001630 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) {
Quentin Colombet5989bc62015-08-31 22:32:47 +00001644 VariableGEPIndex Entry = {V, ZExtBits, SExtBits, -Scale};
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001645 Dest.push_back(Entry);
1646 }
1647 }
1648}
Quentin Colombet5989bc62015-08-31 22:32:47 +00001649
Chandler Carruth7b560d42015-09-09 17:55:00 +00001650bool BasicAAResult::constantOffsetHeuristic(
Quentin Colombet5989bc62015-08-31 22:32:47 +00001651 const SmallVectorImpl<VariableGEPIndex> &VarIndices, uint64_t V1Size,
Chandler Carruth7b560d42015-09-09 17:55:00 +00001652 uint64_t V2Size, int64_t BaseOffset, AssumptionCache *AC,
1653 DominatorTree *DT) {
Quentin Colombet5989bc62015-08-31 22:32:47 +00001654 if (VarIndices.size() != 2 || V1Size == MemoryLocation::UnknownSize ||
Chandler Carruth7b560d42015-09-09 17:55:00 +00001655 V2Size == MemoryLocation::UnknownSize)
Quentin Colombet5989bc62015-08-31 22:32:47 +00001656 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,
Chandler Carruth7b560d42015-09-09 17:55:00 +00001675 V0SExtBits, DL, 0, AC, DT, NSW, NUW);
Richard Trieu7a083812016-02-18 22:09:30 +00001676 NSW = true;
1677 NUW = true;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001678 const Value *V1 = GetLinearExpression(Var1.V, V1Scale, V1Offset, V1ZExtBits,
Chandler Carruth7b560d42015-09-09 17:55:00 +00001679 V1SExtBits, DL, 0, AC, DT, NSW, NUW);
Quentin Colombet5989bc62015-08-31 22:32:47 +00001680
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
Benjamin Kramer557b6012015-10-24 11:38:01 +00001689 // minimum difference between the two. The minimum distance may occur due to
Quentin Colombet5989bc62015-08-31 22:32:47 +00001690 // 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.
Benjamin Kramer557b6012015-10-24 11:38:01 +00001692 APInt MinDiff = V0Offset - V1Offset, Wrapped = -MinDiff;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001693 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}
Chandler Carruth7b560d42015-09-09 17:55:00 +00001703
1704//===----------------------------------------------------------------------===//
1705// BasicAliasAnalysis Pass
1706//===----------------------------------------------------------------------===//
1707
Chandler Carruthb4faf132016-03-11 10:22:49 +00001708char BasicAA::PassID;
1709
Sean Silva36e0d012016-08-09 00:28:15 +00001710BasicAAResult BasicAA::run(Function &F, FunctionAnalysisManager &AM) {
Chandler Carruth7b560d42015-09-09 17:55:00 +00001711 return BasicAAResult(F.getParent()->getDataLayout(),
Chandler Carruthb47f8012016-03-11 11:05:24 +00001712 AM.getResult<TargetLibraryAnalysis>(F),
1713 AM.getResult<AssumptionAnalysis>(F),
Chandler Carruth5bfbc3f2016-03-11 13:53:18 +00001714 &AM.getResult<DominatorTreeAnalysis>(F),
Chandler Carruthb47f8012016-03-11 11:05:24 +00001715 AM.getCachedResult<LoopAnalysis>(F));
Chandler Carruth7b560d42015-09-09 17:55:00 +00001716}
1717
Keno Fischer277bfae2015-10-26 21:22:58 +00001718BasicAAWrapperPass::BasicAAWrapperPass() : FunctionPass(ID) {
1719 initializeBasicAAWrapperPassPass(*PassRegistry::getPassRegistry());
1720}
1721
Chandler Carruth7b560d42015-09-09 17:55:00 +00001722char BasicAAWrapperPass::ID = 0;
1723void BasicAAWrapperPass::anchor() {}
1724
1725INITIALIZE_PASS_BEGIN(BasicAAWrapperPass, "basicaa",
1726 "Basic Alias Analysis (stateless AA impl)", true, true)
1727INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
Chandler Carruth5bfbc3f2016-03-11 13:53:18 +00001728INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
Chandler Carruth7b560d42015-09-09 17:55:00 +00001729INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
1730INITIALIZE_PASS_END(BasicAAWrapperPass, "basicaa",
1731 "Basic Alias Analysis (stateless AA impl)", true, true)
1732
1733FunctionPass *llvm::createBasicAAWrapperPass() {
1734 return new BasicAAWrapperPass();
1735}
1736
1737bool BasicAAWrapperPass::runOnFunction(Function &F) {
1738 auto &ACT = getAnalysis<AssumptionCacheTracker>();
1739 auto &TLIWP = getAnalysis<TargetLibraryInfoWrapperPass>();
Chandler Carruth5bfbc3f2016-03-11 13:53:18 +00001740 auto &DTWP = getAnalysis<DominatorTreeWrapperPass>();
Chandler Carruth7b560d42015-09-09 17:55:00 +00001741 auto *LIWP = getAnalysisIfAvailable<LoopInfoWrapperPass>();
1742
1743 Result.reset(new BasicAAResult(F.getParent()->getDataLayout(), TLIWP.getTLI(),
Chandler Carruth5bfbc3f2016-03-11 13:53:18 +00001744 ACT.getAssumptionCache(F), &DTWP.getDomTree(),
Chandler Carruth7b560d42015-09-09 17:55:00 +00001745 LIWP ? &LIWP->getLoopInfo() : nullptr));
1746
1747 return false;
1748}
1749
1750void BasicAAWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
1751 AU.setPreservesAll();
1752 AU.addRequired<AssumptionCacheTracker>();
Chandler Carruth5bfbc3f2016-03-11 13:53:18 +00001753 AU.addRequired<DominatorTreeWrapperPass>();
Chandler Carruth7b560d42015-09-09 17:55:00 +00001754 AU.addRequired<TargetLibraryInfoWrapperPass>();
1755}
1756
1757BasicAAResult 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}