blob: d3898aad8a7834cf82554a2ce5ff31f8908f0f85 [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"
Daniel Jasperaec2fa32016-12-19 08:22:17 +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
Chandler Carruthaa351672016-12-27 10:30:45 +000066bool BasicAAResult::invalidate(Function &F, const PreservedAnalyses &PA,
67 FunctionAnalysisManager::Invalidator &Inv) {
Chandler Carruthaa351672016-12-27 10:30:45 +000068 // We don't care if this analysis itself is preserved, it has no state. But
69 // we need to check that the analyses it depends on have been. Note that we
70 // may be created without handles to some analyses and in that case don't
71 // depend on them.
72 if (Inv.invalidate<AssumptionAnalysis>(F, PA) ||
73 (DT && Inv.invalidate<DominatorTreeAnalysis>(F, PA)) ||
74 (LI && Inv.invalidate<LoopAnalysis>(F, PA)))
75 return true;
76
77 // Otherwise this analysis result remains valid.
78 return false;
79}
80
Chris Lattner2d332972008-06-16 06:30:22 +000081//===----------------------------------------------------------------------===//
82// Useful predicates
83//===----------------------------------------------------------------------===//
Devang Patel09f162c2007-05-01 21:15:47 +000084
Chandler Carruthc5d81122015-08-06 08:17:06 +000085/// Returns true if the pointer is to a function-local object that never
86/// escapes from the function.
Dan Gohman84f90a32010-07-01 20:08:40 +000087static bool isNonEscapingLocalObject(const Value *V) {
Chris Lattnerfa482582008-06-16 06:28:01 +000088 // If this is a local allocation, check to see if it escapes.
Dan Gohman84f90a32010-07-01 20:08:40 +000089 if (isa<AllocaInst>(V) || isNoAliasCall(V))
Dan Gohman94e61762009-11-19 21:57:48 +000090 // Set StoreCaptures to True so that we can assume in our callers that the
91 // pointer is not the result of a load instruction. Currently
92 // PointerMayBeCaptured doesn't have any special analysis for the
93 // StoreCaptures=false case; if it did, our callers could be refined to be
94 // more precise.
95 return !PointerMayBeCaptured(V, false, /*StoreCaptures=*/true);
Duncan Sands8d65f362009-01-05 21:19:53 +000096
Chris Lattnerfa482582008-06-16 06:28:01 +000097 // If this is an argument that corresponds to a byval or noalias argument,
Duncan Sands8d65f362009-01-05 21:19:53 +000098 // then it has not escaped before entering the function. Check if it escapes
99 // inside the function.
Dan Gohman84f90a32010-07-01 20:08:40 +0000100 if (const Argument *A = dyn_cast<Argument>(V))
Richard Osbornea1fffcf2012-11-05 10:48:24 +0000101 if (A->hasByValAttr() || A->hasNoAliasAttr())
Sanjay Patel9613b292016-01-17 23:13:48 +0000102 // Note even if the argument is marked nocapture, we still need to check
Richard Osbornea1fffcf2012-11-05 10:48:24 +0000103 // for copies made inside the function. The nocapture attribute only
104 // specifies that there are no copies made that outlive the function.
Dan Gohman84f90a32010-07-01 20:08:40 +0000105 return !PointerMayBeCaptured(V, false, /*StoreCaptures=*/true);
Richard Osbornea1fffcf2012-11-05 10:48:24 +0000106
Chris Lattnerb35d9b52008-06-16 06:19:11 +0000107 return false;
108}
109
Chandler Carruthc5d81122015-08-06 08:17:06 +0000110/// Returns true if the pointer is one which would have been considered an
111/// escape by isNonEscapingLocalObject.
Dan Gohman84f90a32010-07-01 20:08:40 +0000112static bool isEscapeSource(const Value *V) {
113 if (isa<CallInst>(V) || isa<InvokeInst>(V) || isa<Argument>(V))
114 return true;
Dan Gohman0824aff2010-06-29 00:50:39 +0000115
116 // The load case works because isNonEscapingLocalObject considers all
117 // stores to be escapes (it passes true for the StoreCaptures argument
118 // to PointerMayBeCaptured).
119 if (isa<LoadInst>(V))
120 return true;
121
122 return false;
123}
Chris Lattnerb35d9b52008-06-16 06:19:11 +0000124
Sanjay Patel9613b292016-01-17 23:13:48 +0000125/// Returns the size of the object specified by V or UnknownSize if unknown.
Rafael Espindola5f57f462014-02-21 18:34:28 +0000126static uint64_t getObjectSize(const Value *V, const DataLayout &DL,
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000127 const TargetLibraryInfo &TLI,
Eli Friedman8bc169c2012-02-27 20:46:07 +0000128 bool RoundToAlign = false) {
Nuno Lopes55fff832012-06-21 15:45:28 +0000129 uint64_t Size;
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000130 if (getObjectSize(V, Size, DL, &TLI, RoundToAlign))
Nuno Lopes55fff832012-06-21 15:45:28 +0000131 return Size;
Chandler Carruthecbd1682015-06-17 07:21:38 +0000132 return MemoryLocation::UnknownSize;
Dan Gohman44da55b2011-01-18 21:16:06 +0000133}
134
Chandler Carruthc5d81122015-08-06 08:17:06 +0000135/// Returns true if we can prove that the object specified by V is smaller than
136/// Size.
Dan Gohman44da55b2011-01-18 21:16:06 +0000137static bool isObjectSmallerThan(const Value *V, uint64_t Size,
Rafael Espindola5f57f462014-02-21 18:34:28 +0000138 const DataLayout &DL,
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000139 const TargetLibraryInfo &TLI) {
Nadav Rotemabcc64f2013-04-09 18:16:05 +0000140 // Note that the meanings of the "object" are slightly different in the
141 // following contexts:
142 // c1: llvm::getObjectSize()
143 // c2: llvm.objectsize() intrinsic
144 // c3: isObjectSmallerThan()
145 // c1 and c2 share the same meaning; however, the meaning of "object" in c3
146 // refers to the "entire object".
147 //
148 // Consider this example:
149 // char *p = (char*)malloc(100)
150 // char *q = p+80;
151 //
152 // In the context of c1 and c2, the "object" pointed by q refers to the
153 // stretch of memory of q[0:19]. So, getObjectSize(q) should return 20.
154 //
155 // However, in the context of c3, the "object" refers to the chunk of memory
156 // being allocated. So, the "object" has 100 bytes, and q points to the middle
157 // the "object". In case q is passed to isObjectSmallerThan() as the 1st
158 // parameter, before the llvm::getObjectSize() is called to get the size of
159 // entire object, we should:
160 // - either rewind the pointer q to the base-address of the object in
161 // question (in this case rewind to p), or
162 // - just give up. It is up to caller to make sure the pointer is pointing
163 // to the base address the object.
Jakub Staszak07f383f2013-08-24 14:16:00 +0000164 //
Nadav Rotemabcc64f2013-04-09 18:16:05 +0000165 // We go for 2nd option for simplicity.
166 if (!isIdentifiedObject(V))
167 return false;
168
Eli Friedman8bc169c2012-02-27 20:46:07 +0000169 // This function needs to use the aligned object size because we allow
170 // reads a bit past the end given sufficient alignment.
Chandler Carruth903c5f92015-08-06 07:57:58 +0000171 uint64_t ObjectSize = getObjectSize(V, DL, TLI, /*RoundToAlign*/ true);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000172
Chandler Carruthecbd1682015-06-17 07:21:38 +0000173 return ObjectSize != MemoryLocation::UnknownSize && ObjectSize < Size;
Dan Gohman44da55b2011-01-18 21:16:06 +0000174}
175
Chandler Carruthc5d81122015-08-06 08:17:06 +0000176/// Returns true if we can prove that the object specified by V has size Size.
Chandler Carruth903c5f92015-08-06 07:57:58 +0000177static bool isObjectSize(const Value *V, uint64_t Size, const DataLayout &DL,
178 const TargetLibraryInfo &TLI) {
Rafael Espindola5f57f462014-02-21 18:34:28 +0000179 uint64_t ObjectSize = getObjectSize(V, DL, TLI);
Chandler Carruthecbd1682015-06-17 07:21:38 +0000180 return ObjectSize != MemoryLocation::UnknownSize && ObjectSize == Size;
Chris Lattner98ad8162008-06-16 06:10:11 +0000181}
182
Chris Lattner2d332972008-06-16 06:30:22 +0000183//===----------------------------------------------------------------------===//
Chris Lattner9f7500f2010-08-18 22:07:29 +0000184// GetElementPtr Instruction Decomposition and Analysis
185//===----------------------------------------------------------------------===//
186
Chandler Carruthc5d81122015-08-06 08:17:06 +0000187/// Analyzes the specified value as a linear expression: "A*V + B", where A and
188/// B are constant integers.
189///
190/// Returns the scale and offset values as APInts and return V as a Value*, and
191/// return whether we looked through any sign or zero extends. The incoming
Sanjay Patel9613b292016-01-17 23:13:48 +0000192/// Value is known to have IntegerType, and it may already be sign or zero
Chandler Carruthc5d81122015-08-06 08:17:06 +0000193/// extended.
Chris Lattner3decde92010-08-18 23:09:49 +0000194///
195/// Note that this looks through extends, so the high bits may not be
196/// represented in the result.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000197/*static*/ const Value *BasicAAResult::GetLinearExpression(
Quentin Colombet5989bc62015-08-31 22:32:47 +0000198 const Value *V, APInt &Scale, APInt &Offset, unsigned &ZExtBits,
199 unsigned &SExtBits, const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000200 AssumptionCache *AC, DominatorTree *DT, bool &NSW, bool &NUW) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000201 assert(V->getType()->isIntegerTy() && "Not an integer value");
202
203 // Limit our recursion depth.
204 if (Depth == 6) {
205 Scale = 1;
206 Offset = 0;
207 return V;
208 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000209
Quentin Colombet5989bc62015-08-31 22:32:47 +0000210 if (const ConstantInt *Const = dyn_cast<ConstantInt>(V)) {
Sanjay Patel9613b292016-01-17 23:13:48 +0000211 // If it's a constant, just convert it to an offset and remove the variable.
212 // If we've been called recursively, the Offset bit width will be greater
Quentin Colombet5989bc62015-08-31 22:32:47 +0000213 // than the constant's (the Offset's always as wide as the outermost call),
214 // so we'll zext here and process any extension in the isa<SExtInst> &
215 // isa<ZExtInst> cases below.
216 Offset += Const->getValue().zextOrSelf(Offset.getBitWidth());
217 assert(Scale == 0 && "Constant values don't have a scale");
218 return V;
219 }
220
221 if (const BinaryOperator *BOp = dyn_cast<BinaryOperator>(V)) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000222 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(BOp->getOperand(1))) {
Quentin Colombet5989bc62015-08-31 22:32:47 +0000223
Sanjay Patel9613b292016-01-17 23:13:48 +0000224 // If we've been called recursively, then Offset and Scale will be wider
225 // than the BOp operands. We'll always zext it here as we'll process sign
Quentin Colombet5989bc62015-08-31 22:32:47 +0000226 // extensions below (see the isa<SExtInst> / isa<ZExtInst> cases).
227 APInt RHS = RHSC->getValue().zextOrSelf(Offset.getBitWidth());
228
Chris Lattner9f7500f2010-08-18 22:07:29 +0000229 switch (BOp->getOpcode()) {
Chandler Carruth903c5f92015-08-06 07:57:58 +0000230 default:
Quentin Colombet5989bc62015-08-31 22:32:47 +0000231 // We don't understand this instruction, so we can't decompose it any
232 // further.
233 Scale = 1;
234 Offset = 0;
235 return V;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000236 case Instruction::Or:
237 // X|C == X+C if all the bits in C are unset in X. Otherwise we can't
238 // analyze it.
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000239 if (!MaskedValueIsZero(BOp->getOperand(0), RHSC->getValue(), DL, 0, AC,
Quentin Colombet5989bc62015-08-31 22:32:47 +0000240 BOp, DT)) {
241 Scale = 1;
242 Offset = 0;
243 return V;
244 }
Justin Bognercd1d5aa2016-08-17 20:30:52 +0000245 LLVM_FALLTHROUGH;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000246 case Instruction::Add:
Quentin Colombet5989bc62015-08-31 22:32:47 +0000247 V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000248 SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000249 Offset += RHS;
250 break;
251 case Instruction::Sub:
252 V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000253 SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000254 Offset -= RHS;
255 break;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000256 case Instruction::Mul:
Quentin Colombet5989bc62015-08-31 22:32:47 +0000257 V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000258 SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000259 Offset *= RHS;
260 Scale *= RHS;
261 break;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000262 case Instruction::Shl:
Quentin Colombet5989bc62015-08-31 22:32:47 +0000263 V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000264 SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000265 Offset <<= RHS.getLimitedValue();
266 Scale <<= RHS.getLimitedValue();
267 // the semantics of nsw and nuw for left shifts don't match those of
268 // multiplications, so we won't propagate them.
269 NSW = NUW = false;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000270 return V;
271 }
Quentin Colombet5989bc62015-08-31 22:32:47 +0000272
273 if (isa<OverflowingBinaryOperator>(BOp)) {
274 NUW &= BOp->hasNoUnsignedWrap();
275 NSW &= BOp->hasNoSignedWrap();
276 }
277 return V;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000278 }
279 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000280
Chris Lattner9f7500f2010-08-18 22:07:29 +0000281 // Since GEP indices are sign extended anyway, we don't care about the high
Chris Lattner3decde92010-08-18 23:09:49 +0000282 // bits of a sign or zero extended value - just scales and offsets. The
283 // extensions have to be consistent though.
Quentin Colombet5989bc62015-08-31 22:32:47 +0000284 if (isa<SExtInst>(V) || isa<ZExtInst>(V)) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000285 Value *CastOp = cast<CastInst>(V)->getOperand(0);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000286 unsigned NewWidth = V->getType()->getPrimitiveSizeInBits();
Chris Lattner9f7500f2010-08-18 22:07:29 +0000287 unsigned SmallWidth = CastOp->getType()->getPrimitiveSizeInBits();
Quentin Colombet5989bc62015-08-31 22:32:47 +0000288 unsigned OldZExtBits = ZExtBits, OldSExtBits = SExtBits;
289 const Value *Result =
290 GetLinearExpression(CastOp, Scale, Offset, ZExtBits, SExtBits, DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000291 Depth + 1, AC, DT, NSW, NUW);
Chris Lattner3decde92010-08-18 23:09:49 +0000292
Simon Pilgrimf2fbf432016-11-20 13:47:59 +0000293 // zext(zext(%x)) == zext(%x), and similarly for sext; we'll handle this
Quentin Colombet5989bc62015-08-31 22:32:47 +0000294 // by just incrementing the number of bits we've extended by.
295 unsigned ExtendedBy = NewWidth - SmallWidth;
296
297 if (isa<SExtInst>(V) && ZExtBits == 0) {
298 // sext(sext(%x, a), b) == sext(%x, a + b)
299
300 if (NSW) {
301 // We haven't sign-wrapped, so it's valid to decompose sext(%x + c)
302 // into sext(%x) + sext(c). We'll sext the Offset ourselves:
303 unsigned OldWidth = Offset.getBitWidth();
304 Offset = Offset.trunc(SmallWidth).sext(NewWidth).zextOrSelf(OldWidth);
305 } else {
306 // We may have signed-wrapped, so don't decompose sext(%x + c) into
307 // sext(%x) + sext(c)
308 Scale = 1;
309 Offset = 0;
310 Result = CastOp;
311 ZExtBits = OldZExtBits;
312 SExtBits = OldSExtBits;
313 }
314 SExtBits += ExtendedBy;
315 } else {
316 // sext(zext(%x, a), b) = zext(zext(%x, a), b) = zext(%x, a + b)
317
318 if (!NUW) {
319 // We may have unsigned-wrapped, so don't decompose zext(%x + c) into
320 // zext(%x) + zext(c)
321 Scale = 1;
322 Offset = 0;
323 Result = CastOp;
324 ZExtBits = OldZExtBits;
325 SExtBits = OldSExtBits;
326 }
327 ZExtBits += ExtendedBy;
328 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000329
Chris Lattner9f7500f2010-08-18 22:07:29 +0000330 return Result;
331 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000332
Chris Lattner9f7500f2010-08-18 22:07:29 +0000333 Scale = 1;
334 Offset = 0;
335 return V;
336}
337
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000338/// To ensure a pointer offset fits in an integer of size PointerSize
339/// (in bits) when that size is smaller than 64. This is an issue in
340/// particular for 32b programs with negative indices that rely on two's
Gerolf Hoflehnerd24671f2016-01-30 05:58:38 +0000341/// complement wrap-arounds for precise alias information.
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000342static int64_t adjustToPointerSize(int64_t Offset, unsigned PointerSize) {
343 assert(PointerSize <= 64 && "Invalid PointerSize!");
344 unsigned ShiftBits = 64 - PointerSize;
Gerolf Hoflehner73fc84b2016-01-30 05:35:09 +0000345 return (int64_t)((uint64_t)Offset << ShiftBits) >> ShiftBits;
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000346}
347
Chandler Carruthc5d81122015-08-06 08:17:06 +0000348/// If V is a symbolic pointer expression, decompose it into a base pointer
349/// with a constant offset and a number of scaled symbolic offsets.
Chris Lattner9f7500f2010-08-18 22:07:29 +0000350///
Chandler Carruthc5d81122015-08-06 08:17:06 +0000351/// The scaled symbolic offsets (represented by pairs of a Value* and a scale
352/// in the VarIndices vector) are Value*'s that are known to be scaled by the
353/// specified amount, but which may have other unrepresented high bits. As
354/// such, the gep cannot necessarily be reconstructed from its decomposed form.
Chris Lattner9f7500f2010-08-18 22:07:29 +0000355///
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000356/// When DataLayout is around, this function is capable of analyzing everything
Arnold Schwaighofer1a444482014-03-26 21:30:19 +0000357/// that GetUnderlyingObject can look through. To be able to do that
358/// GetUnderlyingObject and DecomposeGEPExpression must use the same search
Chandler Carruthc5d81122015-08-06 08:17:06 +0000359/// depth (MaxLookupSearchDepth). When DataLayout not is around, it just looks
360/// through pointer casts.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000361bool BasicAAResult::DecomposeGEPExpression(const Value *V,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000362 DecomposedGEP &Decomposed, const DataLayout &DL, AssumptionCache *AC,
Michael Kuperstein82069c42016-05-25 22:23:08 +0000363 DominatorTree *DT) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000364 // Limit recursion depth to limit compile time in crazy cases.
Arnold Schwaighofer1a444482014-03-26 21:30:19 +0000365 unsigned MaxLookup = MaxLookupSearchDepth;
Wei Mid67daae2015-08-05 23:40:30 +0000366 SearchTimes++;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000367
Michael Kuperstein82069c42016-05-25 22:23:08 +0000368 Decomposed.StructOffset = 0;
369 Decomposed.OtherOffset = 0;
370 Decomposed.VarIndices.clear();
Chris Lattner9f7500f2010-08-18 22:07:29 +0000371 do {
372 // See if this is a bitcast or GEP.
373 const Operator *Op = dyn_cast<Operator>(V);
Craig Topper9f008862014-04-15 04:59:12 +0000374 if (!Op) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000375 // The only non-operator case we can handle are GlobalAliases.
376 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +0000377 if (!GA->isInterposable()) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000378 V = GA->getAliasee();
379 continue;
380 }
381 }
Michael Kuperstein82069c42016-05-25 22:23:08 +0000382 Decomposed.Base = V;
383 return false;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000384 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000385
Matt Arsenault70f4db882014-07-15 00:56:40 +0000386 if (Op->getOpcode() == Instruction::BitCast ||
387 Op->getOpcode() == Instruction::AddrSpaceCast) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000388 V = Op->getOperand(0);
389 continue;
390 }
Dan Gohman05b18f12010-12-15 20:49:55 +0000391
Chris Lattner9f7500f2010-08-18 22:07:29 +0000392 const GEPOperator *GEPOp = dyn_cast<GEPOperator>(Op);
Craig Topper9f008862014-04-15 04:59:12 +0000393 if (!GEPOp) {
Hal Finkel5c12d8f2016-07-11 01:32:20 +0000394 if (auto CS = ImmutableCallSite(V))
395 if (const Value *RV = CS.getReturnedArgOperand()) {
396 V = RV;
397 continue;
398 }
399
Dan Gohman0573b552011-05-24 18:24:08 +0000400 // If it's not a GEP, hand it off to SimplifyInstruction to see if it
401 // can come up with something. This matches what GetUnderlyingObject does.
402 if (const Instruction *I = dyn_cast<Instruction>(V))
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000403 // TODO: Get a DominatorTree and AssumptionCache and use them here
404 // (these are both now available in this function, but this should be
405 // updated when GetUnderlyingObject is updated). TLI should be
406 // provided also.
Dan Gohman0573b552011-05-24 18:24:08 +0000407 if (const Value *Simplified =
Chandler Carruth903c5f92015-08-06 07:57:58 +0000408 SimplifyInstruction(const_cast<Instruction *>(I), DL)) {
Dan Gohman0573b552011-05-24 18:24:08 +0000409 V = Simplified;
410 continue;
411 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000412
Michael Kuperstein82069c42016-05-25 22:23:08 +0000413 Decomposed.Base = V;
414 return false;
Dan Gohman0573b552011-05-24 18:24:08 +0000415 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000416
Chris Lattner9f7500f2010-08-18 22:07:29 +0000417 // Don't attempt to analyze GEPs over unsized objects.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000418 if (!GEPOp->getSourceElementType()->isSized()) {
419 Decomposed.Base = V;
420 return false;
421 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000422
Matt Arsenaulta8fe22b2013-11-16 00:36:43 +0000423 unsigned AS = GEPOp->getPointerAddressSpace();
Chris Lattner9f7500f2010-08-18 22:07:29 +0000424 // Walk the indices of the GEP, accumulating them into BaseOff/VarIndices.
425 gep_type_iterator GTI = gep_type_begin(GEPOp);
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000426 unsigned PointerSize = DL.getPointerSizeInBits(AS);
Gerolf Hoflehner9e2afa82016-10-22 02:41:39 +0000427 // Assume all GEP operands are constants until proven otherwise.
428 bool GepHasConstantOffset = true;
Chandler Carruth903c5f92015-08-06 07:57:58 +0000429 for (User::const_op_iterator I = GEPOp->op_begin() + 1, E = GEPOp->op_end();
Peter Collingbourneab85225b2016-12-02 02:24:42 +0000430 I != E; ++I, ++GTI) {
Quentin Colombet5989bc62015-08-31 22:32:47 +0000431 const Value *Index = *I;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000432 // Compute the (potentially symbolic) offset in bytes for this index.
Peter Collingbourneab85225b2016-12-02 02:24:42 +0000433 if (StructType *STy = GTI.getStructTypeOrNull()) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000434 // For a struct, add the member offset.
435 unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
Chandler Carruth903c5f92015-08-06 07:57:58 +0000436 if (FieldNo == 0)
437 continue;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000438
Michael Kuperstein82069c42016-05-25 22:23:08 +0000439 Decomposed.StructOffset +=
440 DL.getStructLayout(STy)->getElementOffset(FieldNo);
Chris Lattner9f7500f2010-08-18 22:07:29 +0000441 continue;
442 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000443
Chris Lattner9f7500f2010-08-18 22:07:29 +0000444 // For an array/pointer, add the element offset, explicitly scaled.
Quentin Colombet5989bc62015-08-31 22:32:47 +0000445 if (const ConstantInt *CIdx = dyn_cast<ConstantInt>(Index)) {
Chandler Carruth903c5f92015-08-06 07:57:58 +0000446 if (CIdx->isZero())
447 continue;
Michael Kuperstein82069c42016-05-25 22:23:08 +0000448 Decomposed.OtherOffset +=
Peter Collingbourneab85225b2016-12-02 02:24:42 +0000449 DL.getTypeAllocSize(GTI.getIndexedType()) * CIdx->getSExtValue();
Chris Lattner9f7500f2010-08-18 22:07:29 +0000450 continue;
451 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000452
Gerolf Hoflehner9e2afa82016-10-22 02:41:39 +0000453 GepHasConstantOffset = false;
454
Peter Collingbourneab85225b2016-12-02 02:24:42 +0000455 uint64_t Scale = DL.getTypeAllocSize(GTI.getIndexedType());
Quentin Colombet5989bc62015-08-31 22:32:47 +0000456 unsigned ZExtBits = 0, SExtBits = 0;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000457
Chris Lattner3decde92010-08-18 23:09:49 +0000458 // If the integer type is smaller than the pointer size, it is implicitly
459 // sign extended to pointer size.
Matt Arsenaultfa252722013-09-27 22:18:51 +0000460 unsigned Width = Index->getType()->getIntegerBitWidth();
Quentin Colombet5989bc62015-08-31 22:32:47 +0000461 if (PointerSize > Width)
462 SExtBits += PointerSize - Width;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000463
Chris Lattner3decde92010-08-18 23:09:49 +0000464 // Use GetLinearExpression to decompose the index into a C1*V+C2 form.
Chris Lattner9f7500f2010-08-18 22:07:29 +0000465 APInt IndexScale(Width, 0), IndexOffset(Width, 0);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000466 bool NSW = true, NUW = true;
467 Index = GetLinearExpression(Index, IndexScale, IndexOffset, ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000468 SExtBits, DL, 0, AC, DT, NSW, NUW);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000469
Chris Lattner9f7500f2010-08-18 22:07:29 +0000470 // The GEP index scale ("Scale") scales C1*V+C2, yielding (C1*V+C2)*Scale.
471 // This gives us an aggregate computation of (C1*Scale)*V + C2*Scale.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000472 Decomposed.OtherOffset += IndexOffset.getSExtValue() * Scale;
Eli Friedmanab3a1282010-09-15 20:08:03 +0000473 Scale *= IndexScale.getSExtValue();
Jakub Staszak07f383f2013-08-24 14:16:00 +0000474
Chris Lattner0ab5e2c2011-04-15 05:18:47 +0000475 // If we already had an occurrence of this index variable, merge this
Chris Lattner9f7500f2010-08-18 22:07:29 +0000476 // scale into it. For example, we want to handle:
477 // A[x][x] -> x*16 + x*4 -> x*20
478 // This also ensures that 'x' only appears in the index list once.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000479 for (unsigned i = 0, e = Decomposed.VarIndices.size(); i != e; ++i) {
Gerolf Hoflehner9e2afa82016-10-22 02:41:39 +0000480 if (Decomposed.VarIndices[i].V == Index &&
Michael Kuperstein82069c42016-05-25 22:23:08 +0000481 Decomposed.VarIndices[i].ZExtBits == ZExtBits &&
482 Decomposed.VarIndices[i].SExtBits == SExtBits) {
483 Scale += Decomposed.VarIndices[i].Scale;
484 Decomposed.VarIndices.erase(Decomposed.VarIndices.begin() + i);
Chris Lattner9f7500f2010-08-18 22:07:29 +0000485 break;
486 }
487 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000488
Chris Lattner9f7500f2010-08-18 22:07:29 +0000489 // Make sure that we have a scale that makes sense for this target's
490 // pointer size.
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000491 Scale = adjustToPointerSize(Scale, PointerSize);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000492
Chris Lattner1b9c3872010-08-18 22:47:56 +0000493 if (Scale) {
Quentin Colombet5989bc62015-08-31 22:32:47 +0000494 VariableGEPIndex Entry = {Index, ZExtBits, SExtBits,
Jeffrey Yasskin6381c012011-07-27 06:22:51 +0000495 static_cast<int64_t>(Scale)};
Michael Kuperstein82069c42016-05-25 22:23:08 +0000496 Decomposed.VarIndices.push_back(Entry);
Chris Lattner1b9c3872010-08-18 22:47:56 +0000497 }
Chris Lattner9f7500f2010-08-18 22:07:29 +0000498 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000499
Gerolf Hoflehner87ddb652016-01-30 05:52:53 +0000500 // Take care of wrap-arounds
Gerolf Hoflehner9e2afa82016-10-22 02:41:39 +0000501 if (GepHasConstantOffset) {
502 Decomposed.StructOffset =
503 adjustToPointerSize(Decomposed.StructOffset, PointerSize);
504 Decomposed.OtherOffset =
505 adjustToPointerSize(Decomposed.OtherOffset, PointerSize);
506 }
Gerolf Hoflehner87ddb652016-01-30 05:52:53 +0000507
Chris Lattner9f7500f2010-08-18 22:07:29 +0000508 // Analyze the base pointer next.
509 V = GEPOp->getOperand(0);
510 } while (--MaxLookup);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000511
Chris Lattner9f7500f2010-08-18 22:07:29 +0000512 // If the chain of expressions is too deep, just return early.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000513 Decomposed.Base = V;
Wei Mid67daae2015-08-05 23:40:30 +0000514 SearchLimitReached++;
Michael Kuperstein82069c42016-05-25 22:23:08 +0000515 return true;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000516}
517
Chandler Carruthc5d81122015-08-06 08:17:06 +0000518/// Returns whether the given pointer value points to memory that is local to
519/// the function, with global constants being considered local to all
520/// functions.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000521bool BasicAAResult::pointsToConstantMemory(const MemoryLocation &Loc,
522 bool OrLocal) {
Dan Gohman9130bad2010-11-08 16:45:26 +0000523 assert(Visited.empty() && "Visited must be cleared after use!");
Chris Lattner2d332972008-06-16 06:30:22 +0000524
Dan Gohman142ff822010-11-08 20:26:19 +0000525 unsigned MaxLookup = 8;
Dan Gohman9130bad2010-11-08 16:45:26 +0000526 SmallVector<const Value *, 16> Worklist;
527 Worklist.push_back(Loc.Ptr);
528 do {
Chandler Carruth7b560d42015-09-09 17:55:00 +0000529 const Value *V = GetUnderlyingObject(Worklist.pop_back_val(), DL);
David Blaikie70573dc2014-11-19 07:49:26 +0000530 if (!Visited.insert(V).second) {
Dan Gohman9130bad2010-11-08 16:45:26 +0000531 Visited.clear();
Chandler Carruth7b560d42015-09-09 17:55:00 +0000532 return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
Dan Gohman9130bad2010-11-08 16:45:26 +0000533 }
Dan Gohman5f1702e2010-08-06 01:25:49 +0000534
Dan Gohman9130bad2010-11-08 16:45:26 +0000535 // An alloca instruction defines local memory.
536 if (OrLocal && isa<AllocaInst>(V))
537 continue;
538
539 // A global constant counts as local memory for our purposes.
540 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
541 // Note: this doesn't require GV to be "ODR" because it isn't legal for a
542 // global to be marked constant in some modules and non-constant in
543 // others. GV may even be a declaration, not a definition.
544 if (!GV->isConstant()) {
545 Visited.clear();
Chandler Carruth7b560d42015-09-09 17:55:00 +0000546 return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
Dan Gohman9130bad2010-11-08 16:45:26 +0000547 }
548 continue;
549 }
550
551 // If both select values point to local memory, then so does the select.
552 if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
553 Worklist.push_back(SI->getTrueValue());
554 Worklist.push_back(SI->getFalseValue());
555 continue;
556 }
557
558 // If all values incoming to a phi node point to local memory, then so does
559 // the phi.
560 if (const PHINode *PN = dyn_cast<PHINode>(V)) {
Dan Gohman142ff822010-11-08 20:26:19 +0000561 // Don't bother inspecting phi nodes with many operands.
562 if (PN->getNumIncomingValues() > MaxLookup) {
563 Visited.clear();
Chandler Carruth7b560d42015-09-09 17:55:00 +0000564 return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
Dan Gohman142ff822010-11-08 20:26:19 +0000565 }
Pete Cooper833f34d2015-05-12 20:05:31 +0000566 for (Value *IncValue : PN->incoming_values())
567 Worklist.push_back(IncValue);
Dan Gohman9130bad2010-11-08 16:45:26 +0000568 continue;
569 }
570
571 // Otherwise be conservative.
572 Visited.clear();
Chandler Carruth7b560d42015-09-09 17:55:00 +0000573 return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
Dan Gohman9130bad2010-11-08 16:45:26 +0000574
Dan Gohman142ff822010-11-08 20:26:19 +0000575 } while (!Worklist.empty() && --MaxLookup);
Dan Gohman9130bad2010-11-08 16:45:26 +0000576
577 Visited.clear();
Dan Gohman142ff822010-11-08 20:26:19 +0000578 return Worklist.empty();
Chris Lattner2d332972008-06-16 06:30:22 +0000579}
580
Chandler Carruthc5d81122015-08-06 08:17:06 +0000581/// Returns the behavior when calling the given call site.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000582FunctionModRefBehavior BasicAAResult::getModRefBehavior(ImmutableCallSite CS) {
Dan Gohman5f1702e2010-08-06 01:25:49 +0000583 if (CS.doesNotAccessMemory())
584 // Can't do better than this.
Chandler Carruth194f59c2015-07-22 23:15:57 +0000585 return FMRB_DoesNotAccessMemory;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000586
Chandler Carruth194f59c2015-07-22 23:15:57 +0000587 FunctionModRefBehavior Min = FMRB_UnknownModRefBehavior;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000588
589 // If the callsite knows it only reads memory, don't return worse
590 // than that.
591 if (CS.onlyReadsMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000592 Min = FMRB_OnlyReadsMemory;
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000593 else if (CS.doesNotReadMemory())
594 Min = FMRB_DoesNotReadMemory;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000595
Igor Laevsky39d662f2015-07-11 10:30:36 +0000596 if (CS.onlyAccessesArgMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000597 Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesArgumentPointees);
Igor Laevsky39d662f2015-07-11 10:30:36 +0000598
Chandler Carruth12884f72016-03-02 15:56:53 +0000599 // If CS has operand bundles then aliasing attributes from the function it
600 // calls do not directly apply to the CallSite. This can be made more
601 // precise in the future.
602 if (!CS.hasOperandBundles())
603 if (const Function *F = CS.getCalledFunction())
604 Min =
605 FunctionModRefBehavior(Min & getBestAAResults().getModRefBehavior(F));
606
607 return Min;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000608}
609
Chandler Carruthc5d81122015-08-06 08:17:06 +0000610/// Returns the behavior when calling the given function. For use when the call
611/// site is not known.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000612FunctionModRefBehavior BasicAAResult::getModRefBehavior(const Function *F) {
Dan Gohmane461d7d2010-11-08 16:08:43 +0000613 // If the function declares it doesn't access memory, we can't do better.
Dan Gohman5f1702e2010-08-06 01:25:49 +0000614 if (F->doesNotAccessMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000615 return FMRB_DoesNotAccessMemory;
Dan Gohmane461d7d2010-11-08 16:08:43 +0000616
Chandler Carruth194f59c2015-07-22 23:15:57 +0000617 FunctionModRefBehavior Min = FMRB_UnknownModRefBehavior;
Dan Gohman2694e142010-11-10 01:02:18 +0000618
Dan Gohmane461d7d2010-11-08 16:08:43 +0000619 // If the function declares it only reads memory, go with that.
Dan Gohman5f1702e2010-08-06 01:25:49 +0000620 if (F->onlyReadsMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000621 Min = FMRB_OnlyReadsMemory;
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000622 else if (F->doesNotReadMemory())
623 Min = FMRB_DoesNotReadMemory;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000624
Igor Laevsky39d662f2015-07-11 10:30:36 +0000625 if (F->onlyAccessesArgMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000626 Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesArgumentPointees);
Andrew Kaylor9604f342016-11-08 21:07:42 +0000627 else if (F->onlyAccessesInaccessibleMemory())
628 Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesInaccessibleMem);
629 else if (F->onlyAccessesInaccessibleMemOrArgMem())
630 Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesInaccessibleOrArgMem);
Igor Laevsky39d662f2015-07-11 10:30:36 +0000631
Chandler Carruth12884f72016-03-02 15:56:53 +0000632 return Min;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000633}
Owen Anderson98a36172009-02-05 23:36:27 +0000634
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000635/// Returns true if this is a writeonly (i.e Mod only) parameter.
Philip Reamesfe46cad2016-01-06 18:10:35 +0000636static bool isWriteOnlyParam(ImmutableCallSite CS, unsigned ArgIdx,
637 const TargetLibraryInfo &TLI) {
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000638 if (CS.paramHasAttr(ArgIdx + 1, Attribute::WriteOnly))
639 return true;
Hal Finkel354e23b2014-07-17 01:28:25 +0000640
641 // We can bound the aliasing properties of memset_pattern16 just as we can
642 // for memcpy/memset. This is particularly important because the
643 // LoopIdiomRecognizer likes to turn loops into calls to memset_pattern16
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000644 // whenever possible.
645 // FIXME Consider handling this in InferFunctionAttr.cpp together with other
646 // attributes.
David L. Jonesd21529f2017-01-23 23:16:46 +0000647 LibFunc F;
Ahmed Bougachad765a822016-04-27 19:04:35 +0000648 if (CS.getCalledFunction() && TLI.getLibFunc(*CS.getCalledFunction(), F) &&
David L. Jonesd21529f2017-01-23 23:16:46 +0000649 F == LibFunc_memset_pattern16 && TLI.has(F))
Philip Reamesae050a52016-01-06 04:53:16 +0000650 if (ArgIdx == 0)
Philip Reamesfe46cad2016-01-06 18:10:35 +0000651 return true;
652
653 // TODO: memset_pattern4, memset_pattern8
654 // TODO: _chk variants
655 // TODO: strcmp, strcpy
656
657 return false;
658}
659
660ModRefInfo BasicAAResult::getArgModRefInfo(ImmutableCallSite CS,
661 unsigned ArgIdx) {
662
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000663 // Checking for known builtin intrinsics and target library functions.
Philip Reamesfe46cad2016-01-06 18:10:35 +0000664 if (isWriteOnlyParam(CS, ArgIdx, TLI))
665 return MRI_Mod;
Hal Finkel354e23b2014-07-17 01:28:25 +0000666
Igor Laevsky36e84c02015-10-28 16:42:00 +0000667 if (CS.paramHasAttr(ArgIdx + 1, Attribute::ReadOnly))
668 return MRI_Ref;
669
Igor Laevsky559d1702015-10-28 17:54:48 +0000670 if (CS.paramHasAttr(ArgIdx + 1, Attribute::ReadNone))
671 return MRI_NoModRef;
672
Chandler Carruth7b560d42015-09-09 17:55:00 +0000673 return AAResultBase::getArgModRefInfo(CS, ArgIdx);
Hal Finkel354e23b2014-07-17 01:28:25 +0000674}
675
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000676static bool isIntrinsicCall(ImmutableCallSite CS, Intrinsic::ID IID) {
Hal Finkel93046912014-07-25 21:13:35 +0000677 const IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction());
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000678 return II && II->getIntrinsicID() == IID;
Hal Finkel93046912014-07-25 21:13:35 +0000679}
680
Justin Bognerabdcb3c2015-09-24 05:29:31 +0000681#ifndef NDEBUG
Justin Bogner49655f82015-09-24 04:59:24 +0000682static const Function *getParent(const Value *V) {
683 if (const Instruction *inst = dyn_cast<Instruction>(V))
684 return inst->getParent()->getParent();
685
686 if (const Argument *arg = dyn_cast<Argument>(V))
687 return arg->getParent();
688
689 return nullptr;
690}
691
692static bool notDifferentParent(const Value *O1, const Value *O2) {
693
694 const Function *F1 = getParent(O1);
695 const Function *F2 = getParent(O2);
696
697 return !F1 || !F2 || F1 == F2;
698}
Justin Bognerabdcb3c2015-09-24 05:29:31 +0000699#endif
Justin Bogner49655f82015-09-24 04:59:24 +0000700
701AliasResult BasicAAResult::alias(const MemoryLocation &LocA,
702 const MemoryLocation &LocB) {
703 assert(notDifferentParent(LocA.Ptr, LocB.Ptr) &&
704 "BasicAliasAnalysis doesn't support interprocedural queries.");
705
706 // If we have a directly cached entry for these locations, we have recursed
707 // through this once, so just return the cached results. Notably, when this
708 // happens, we don't clear the cache.
709 auto CacheIt = AliasCache.find(LocPair(LocA, LocB));
710 if (CacheIt != AliasCache.end())
711 return CacheIt->second;
712
713 AliasResult Alias = aliasCheck(LocA.Ptr, LocA.Size, LocA.AATags, LocB.Ptr,
714 LocB.Size, LocB.AATags);
715 // AliasCache rarely has more than 1 or 2 elements, always use
716 // shrink_and_clear so it quickly returns to the inline capacity of the
717 // SmallDenseMap if it ever grows larger.
718 // FIXME: This should really be shrink_to_inline_capacity_and_clear().
719 AliasCache.shrink_and_clear();
720 VisitedPhiBBs.clear();
721 return Alias;
722}
723
Chandler Carruthc5d81122015-08-06 08:17:06 +0000724/// Checks to see if the specified callsite can clobber the specified memory
725/// object.
726///
727/// Since we only look at local properties of this function, we really can't
728/// say much about this query. We do, however, use simple "address taken"
729/// analysis on local objects.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000730ModRefInfo BasicAAResult::getModRefInfo(ImmutableCallSite CS,
731 const MemoryLocation &Loc) {
Dan Gohman41f14cf2010-09-14 21:25:10 +0000732 assert(notDifferentParent(CS.getInstruction(), Loc.Ptr) &&
Dan Gohman00ef9322010-07-07 14:27:09 +0000733 "AliasAnalysis query involving multiple functions!");
734
Chandler Carruth7b560d42015-09-09 17:55:00 +0000735 const Value *Object = GetUnderlyingObject(Loc.Ptr, DL);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000736
Dan Gohman41f14cf2010-09-14 21:25:10 +0000737 // If this is a tail call and Loc.Ptr points to a stack location, we know that
Chris Lattnerd6a49ad2009-11-22 16:05:05 +0000738 // the tail call cannot access or modify the local stack.
739 // We cannot exclude byval arguments here; these belong to the caller of
740 // the current function not to the current function, and a tail callee
741 // may reference them.
742 if (isa<AllocaInst>(Object))
Dan Gohman5442c712010-08-03 21:48:53 +0000743 if (const CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
Chris Lattnerd6a49ad2009-11-22 16:05:05 +0000744 if (CI->isTailCall())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000745 return MRI_NoModRef;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000746
Chris Lattnerd6a49ad2009-11-22 16:05:05 +0000747 // If the pointer is to a locally allocated object that does not escape,
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000748 // then the call can not mod/ref the pointer unless the call takes the pointer
749 // as an argument, and itself doesn't capture it.
Chris Lattner1e7b37e2009-11-23 16:46:41 +0000750 if (!isa<Constant>(Object) && CS.getInstruction() != Object &&
Dan Gohman84f90a32010-07-01 20:08:40 +0000751 isNonEscapingLocalObject(Object)) {
Igor Laevsky37cba432017-03-01 13:19:51 +0000752
753 // Optimistically assume that call doesn't touch Object and check this
754 // assumption in the following loop.
755 ModRefInfo Result = MRI_NoModRef;
756
Igor Laevsky28eeb3f2016-01-16 12:15:53 +0000757 unsigned OperandNo = 0;
758 for (auto CI = CS.data_operands_begin(), CE = CS.data_operands_end();
759 CI != CE; ++CI, ++OperandNo) {
Chris Lattner026f5e62011-05-23 05:15:43 +0000760 // Only look at the no-capture or byval pointer arguments. If this
761 // pointer were passed to arguments that were neither of these, then it
762 // couldn't be no-capture.
Duncan Sands19d0b472010-02-16 11:11:14 +0000763 if (!(*CI)->getType()->isPointerTy() ||
Hal Finkel39fed392016-12-15 05:09:15 +0000764 (!CS.doesNotCapture(OperandNo) &&
765 OperandNo < CS.getNumArgOperands() && !CS.isByValArgument(OperandNo)))
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000766 continue;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000767
Igor Laevsky37cba432017-03-01 13:19:51 +0000768 // Call doesn't access memory through this operand, so we don't care
769 // if it aliases with Object.
770 if (CS.doesNotAccessMemory(OperandNo))
771 continue;
772
Dan Gohman41f14cf2010-09-14 21:25:10 +0000773 // If this is a no-capture pointer argument, see if we can tell that it
Igor Laevsky37cba432017-03-01 13:19:51 +0000774 // is impossible to alias the pointer we're checking.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000775 AliasResult AR =
776 getBestAAResults().alias(MemoryLocation(*CI), MemoryLocation(Object));
Igor Laevsky37cba432017-03-01 13:19:51 +0000777
778 // Operand doesnt alias 'Object', continue looking for other aliases
779 if (AR == NoAlias)
780 continue;
781 // Operand aliases 'Object', but call doesn't modify it. Strengthen
782 // initial assumption and keep looking in case if there are more aliases.
783 if (CS.onlyReadsMemory(OperandNo)) {
784 Result = static_cast<ModRefInfo>(Result | MRI_Ref);
785 continue;
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000786 }
Igor Laevsky37cba432017-03-01 13:19:51 +0000787 // Operand aliases 'Object' but call only writes into it.
788 if (CS.doesNotReadMemory(OperandNo)) {
789 Result = static_cast<ModRefInfo>(Result | MRI_Mod);
790 continue;
791 }
792 // This operand aliases 'Object' and call reads and writes into it.
793 Result = MRI_ModRef;
794 break;
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000795 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000796
Igor Laevsky37cba432017-03-01 13:19:51 +0000797 // Early return if we improved mod ref information
798 if (Result != MRI_ModRef)
799 return Result;
Chris Lattnerd6a49ad2009-11-22 16:05:05 +0000800 }
801
Philip Reamesd9f4a3d2016-03-09 23:19:56 +0000802 // If the CallSite is to malloc or calloc, we can assume that it doesn't
803 // modify any IR visible value. This is only valid because we assume these
804 // routines do not read values visible in the IR. TODO: Consider special
805 // casing realloc and strdup routines which access only their arguments as
806 // well. Or alternatively, replace all of this with inaccessiblememonly once
807 // that's implemented fully.
808 auto *Inst = CS.getInstruction();
809 if (isMallocLikeFn(Inst, &TLI) || isCallocLikeFn(Inst, &TLI)) {
810 // Be conservative if the accessed pointer may alias the allocation -
811 // fallback to the generic handling below.
812 if (getBestAAResults().alias(MemoryLocation(Inst), Loc) == NoAlias)
813 return MRI_NoModRef;
814 }
815
Bryant Wonga07d9b12016-12-25 22:42:27 +0000816 // The semantics of memcpy intrinsics forbid overlap between their respective
817 // operands, i.e., source and destination of any given memcpy must no-alias.
818 // If Loc must-aliases either one of these two locations, then it necessarily
819 // no-aliases the other.
820 if (auto *Inst = dyn_cast<MemCpyInst>(CS.getInstruction())) {
821 AliasResult SrcAA, DestAA;
822
823 if ((SrcAA = getBestAAResults().alias(MemoryLocation::getForSource(Inst),
824 Loc)) == MustAlias)
825 // Loc is exactly the memcpy source thus disjoint from memcpy dest.
826 return MRI_Ref;
827 if ((DestAA = getBestAAResults().alias(MemoryLocation::getForDest(Inst),
828 Loc)) == MustAlias)
829 // The converse case.
830 return MRI_Mod;
831
832 // It's also possible for Loc to alias both src and dest, or neither.
833 ModRefInfo rv = MRI_NoModRef;
834 if (SrcAA != NoAlias)
835 rv = static_cast<ModRefInfo>(rv | MRI_Ref);
836 if (DestAA != NoAlias)
837 rv = static_cast<ModRefInfo>(rv | MRI_Mod);
838 return rv;
839 }
840
Hal Finkel93046912014-07-25 21:13:35 +0000841 // While the assume intrinsic is marked as arbitrarily writing so that
842 // proper control dependencies will be maintained, it never aliases any
843 // particular memory location.
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000844 if (isIntrinsicCall(CS, Intrinsic::assume))
Chandler Carruth194f59c2015-07-22 23:15:57 +0000845 return MRI_NoModRef;
Hal Finkel93046912014-07-25 21:13:35 +0000846
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000847 // Like assumes, guard intrinsics are also marked as arbitrarily writing so
848 // that proper control dependencies are maintained but they never mods any
849 // particular memory location.
850 //
851 // *Unlike* assumes, guard intrinsics are modeled as reading memory since the
852 // heap state at the point the guard is issued needs to be consistent in case
853 // the guard invokes the "deopt" continuation.
854 if (isIntrinsicCall(CS, Intrinsic::experimental_guard))
855 return MRI_Ref;
856
Anna Thomas037e5402016-08-09 17:18:05 +0000857 // Like assumes, invariant.start intrinsics were also marked as arbitrarily
858 // writing so that proper control dependencies are maintained but they never
859 // mod any particular memory location visible to the IR.
860 // *Unlike* assumes (which are now modeled as NoModRef), invariant.start
861 // intrinsic is now modeled as reading memory. This prevents hoisting the
862 // invariant.start intrinsic over stores. Consider:
863 // *ptr = 40;
864 // *ptr = 50;
865 // invariant_start(ptr)
866 // int val = *ptr;
867 // print(val);
868 //
869 // This cannot be transformed to:
870 //
871 // *ptr = 40;
872 // invariant_start(ptr)
873 // *ptr = 50;
874 // int val = *ptr;
875 // print(val);
876 //
877 // The transformation will cause the second store to be ignored (based on
878 // rules of invariant.start) and print 40, while the first program always
879 // prints 50.
880 if (isIntrinsicCall(CS, Intrinsic::invariant_start))
881 return MRI_Ref;
882
Chandler Carruth7b560d42015-09-09 17:55:00 +0000883 // The AAResultBase base class has some smarts, lets use them.
884 return AAResultBase::getModRefInfo(CS, Loc);
Dan Gohman64d842e2010-09-08 01:32:20 +0000885}
Chris Lattner2d332972008-06-16 06:30:22 +0000886
Chandler Carruth7b560d42015-09-09 17:55:00 +0000887ModRefInfo BasicAAResult::getModRefInfo(ImmutableCallSite CS1,
888 ImmutableCallSite CS2) {
Hal Finkel93046912014-07-25 21:13:35 +0000889 // While the assume intrinsic is marked as arbitrarily writing so that
890 // proper control dependencies will be maintained, it never aliases any
891 // particular memory location.
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000892 if (isIntrinsicCall(CS1, Intrinsic::assume) ||
893 isIntrinsicCall(CS2, Intrinsic::assume))
Chandler Carruth194f59c2015-07-22 23:15:57 +0000894 return MRI_NoModRef;
Hal Finkel93046912014-07-25 21:13:35 +0000895
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000896 // Like assumes, guard intrinsics are also marked as arbitrarily writing so
897 // that proper control dependencies are maintained but they never mod any
898 // particular memory location.
899 //
900 // *Unlike* assumes, guard intrinsics are modeled as reading memory since the
901 // heap state at the point the guard is issued needs to be consistent in case
902 // the guard invokes the "deopt" continuation.
903
904 // NB! This function is *not* commutative, so we specical case two
905 // possibilities for guard intrinsics.
906
907 if (isIntrinsicCall(CS1, Intrinsic::experimental_guard))
908 return getModRefBehavior(CS2) & MRI_Mod ? MRI_Ref : MRI_NoModRef;
909
910 if (isIntrinsicCall(CS2, Intrinsic::experimental_guard))
911 return getModRefBehavior(CS1) & MRI_Mod ? MRI_Mod : MRI_NoModRef;
912
Chandler Carruth7b560d42015-09-09 17:55:00 +0000913 // The AAResultBase base class has some smarts, lets use them.
914 return AAResultBase::getModRefInfo(CS1, CS2);
Hal Finkel93046912014-07-25 21:13:35 +0000915}
916
Chandler Carruthc5d81122015-08-06 08:17:06 +0000917/// Provide ad-hoc rules to disambiguate accesses through two GEP operators,
918/// both having the exact same pointer operand.
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000919static AliasResult aliasSameBasePointerGEPs(const GEPOperator *GEP1,
920 uint64_t V1Size,
921 const GEPOperator *GEP2,
922 uint64_t V2Size,
923 const DataLayout &DL) {
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000924
Hal Finkel5c12d8f2016-07-11 01:32:20 +0000925 assert(GEP1->getPointerOperand()->stripPointerCasts() ==
926 GEP2->getPointerOperand()->stripPointerCasts() &&
927 GEP1->getPointerOperand()->getType() ==
928 GEP2->getPointerOperand()->getType() &&
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000929 "Expected GEPs with the same pointer operand");
930
931 // Try to determine whether GEP1 and GEP2 index through arrays, into structs,
932 // such that the struct field accesses provably cannot alias.
933 // We also need at least two indices (the pointer, and the struct field).
Daniel Berlin73694bb2016-06-01 18:55:32 +0000934 if (GEP1->getNumIndices() != GEP2->getNumIndices() ||
935 GEP1->getNumIndices() < 2)
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000936 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000937
938 // If we don't know the size of the accesses through both GEPs, we can't
939 // determine whether the struct fields accessed can't alias.
Chandler Carruthecbd1682015-06-17 07:21:38 +0000940 if (V1Size == MemoryLocation::UnknownSize ||
941 V2Size == MemoryLocation::UnknownSize)
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000942 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000943
944 ConstantInt *C1 =
945 dyn_cast<ConstantInt>(GEP1->getOperand(GEP1->getNumOperands() - 1));
946 ConstantInt *C2 =
947 dyn_cast<ConstantInt>(GEP2->getOperand(GEP2->getNumOperands() - 1));
948
James Molloy5a4d8cd2015-10-22 13:28:18 +0000949 // If the last (struct) indices are constants and are equal, the other indices
950 // might be also be dynamically equal, so the GEPs can alias.
Vedant Kumaree202942016-05-11 15:45:43 +0000951 if (C1 && C2 && C1->getSExtValue() == C2->getSExtValue())
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000952 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000953
954 // Find the last-indexed type of the GEP, i.e., the type you'd get if
955 // you stripped the last index.
956 // On the way, look at each indexed type. If there's something other
957 // than an array, different indices can lead to different final types.
958 SmallVector<Value *, 8> IntermediateIndices;
959
960 // Insert the first index; we don't need to check the type indexed
961 // through it as it only drops the pointer indirection.
962 assert(GEP1->getNumIndices() > 1 && "Not enough GEP indices to examine");
963 IntermediateIndices.push_back(GEP1->getOperand(1));
964
965 // Insert all the remaining indices but the last one.
966 // Also, check that they all index through arrays.
967 for (unsigned i = 1, e = GEP1->getNumIndices() - 1; i != e; ++i) {
968 if (!isa<ArrayType>(GetElementPtrInst::getIndexedType(
David Blaikied288fb82015-03-30 21:41:43 +0000969 GEP1->getSourceElementType(), IntermediateIndices)))
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000970 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000971 IntermediateIndices.push_back(GEP1->getOperand(i + 1));
972 }
973
James Molloy5a4d8cd2015-10-22 13:28:18 +0000974 auto *Ty = GetElementPtrInst::getIndexedType(
975 GEP1->getSourceElementType(), IntermediateIndices);
976 StructType *LastIndexedStruct = dyn_cast<StructType>(Ty);
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000977
James Molloy5a4d8cd2015-10-22 13:28:18 +0000978 if (isa<SequentialType>(Ty)) {
979 // We know that:
980 // - both GEPs begin indexing from the exact same pointer;
981 // - the last indices in both GEPs are constants, indexing into a sequential
982 // type (array or pointer);
983 // - both GEPs only index through arrays prior to that.
984 //
985 // Because array indices greater than the number of elements are valid in
986 // GEPs, unless we know the intermediate indices are identical between
987 // GEP1 and GEP2 we cannot guarantee that the last indexed arrays don't
James Molloy05a896a2015-10-23 14:17:03 +0000988 // partially overlap. We also need to check that the loaded size matches
989 // the element size, otherwise we could still have overlap.
990 const uint64_t ElementSize =
991 DL.getTypeStoreSize(cast<SequentialType>(Ty)->getElementType());
992 if (V1Size != ElementSize || V2Size != ElementSize)
993 return MayAlias;
994
James Molloy5a4d8cd2015-10-22 13:28:18 +0000995 for (unsigned i = 0, e = GEP1->getNumIndices() - 1; i != e; ++i)
996 if (GEP1->getOperand(i + 1) != GEP2->getOperand(i + 1))
997 return MayAlias;
James Molloy05a896a2015-10-23 14:17:03 +0000998
James Molloy5a4d8cd2015-10-22 13:28:18 +0000999 // Now we know that the array/pointer that GEP1 indexes into and that
1000 // that GEP2 indexes into must either precisely overlap or be disjoint.
1001 // Because they cannot partially overlap and because fields in an array
1002 // cannot overlap, if we can prove the final indices are different between
1003 // GEP1 and GEP2, we can conclude GEP1 and GEP2 don't alias.
1004
1005 // If the last indices are constants, we've already checked they don't
1006 // equal each other so we can exit early.
1007 if (C1 && C2)
1008 return NoAlias;
1009 if (isKnownNonEqual(GEP1->getOperand(GEP1->getNumOperands() - 1),
1010 GEP2->getOperand(GEP2->getNumOperands() - 1),
1011 DL))
1012 return NoAlias;
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001013 return MayAlias;
James Molloy5a4d8cd2015-10-22 13:28:18 +00001014 } else if (!LastIndexedStruct || !C1 || !C2) {
1015 return MayAlias;
1016 }
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +00001017
1018 // We know that:
1019 // - both GEPs begin indexing from the exact same pointer;
1020 // - the last indices in both GEPs are constants, indexing into a struct;
1021 // - said indices are different, hence, the pointed-to fields are different;
1022 // - both GEPs only index through arrays prior to that.
1023 //
1024 // This lets us determine that the struct that GEP1 indexes into and the
1025 // struct that GEP2 indexes into must either precisely overlap or be
1026 // completely disjoint. Because they cannot partially overlap, indexing into
1027 // different non-overlapping fields of the struct will never alias.
1028
1029 // Therefore, the only remaining thing needed to show that both GEPs can't
1030 // alias is that the fields are not overlapping.
1031 const StructLayout *SL = DL.getStructLayout(LastIndexedStruct);
1032 const uint64_t StructSize = SL->getSizeInBytes();
1033 const uint64_t V1Off = SL->getElementOffset(C1->getZExtValue());
1034 const uint64_t V2Off = SL->getElementOffset(C2->getZExtValue());
1035
1036 auto EltsDontOverlap = [StructSize](uint64_t V1Off, uint64_t V1Size,
1037 uint64_t V2Off, uint64_t V2Size) {
1038 return V1Off < V2Off && V1Off + V1Size <= V2Off &&
1039 ((V2Off + V2Size <= StructSize) ||
1040 (V2Off + V2Size - StructSize <= V1Off));
1041 };
1042
1043 if (EltsDontOverlap(V1Off, V1Size, V2Off, V2Size) ||
1044 EltsDontOverlap(V2Off, V2Size, V1Off, V1Size))
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001045 return NoAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +00001046
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001047 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +00001048}
1049
Michael Kuperstein82069c42016-05-25 22:23:08 +00001050// If a we have (a) a GEP and (b) a pointer based on an alloca, and the
1051// beginning of the object the GEP points would have a negative offset with
1052// repsect to the alloca, that means the GEP can not alias pointer (b).
1053// Note that the pointer based on the alloca may not be a GEP. For
1054// example, it may be the alloca itself.
Michael Kupersteinae214912016-05-26 19:30:49 +00001055// The same applies if (b) is based on a GlobalVariable. Note that just being
1056// based on isIdentifiedObject() is not enough - we need an identified object
1057// that does not permit access to negative offsets. For example, a negative
1058// offset from a noalias argument or call can be inbounds w.r.t the actual
1059// underlying object.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001060//
1061// For example, consider:
1062//
1063// struct { int f0, int f1, ...} foo;
1064// foo alloca;
1065// foo* random = bar(alloca);
1066// int *f0 = &alloca.f0
1067// int *f1 = &random->f1;
1068//
1069// Which is lowered, approximately, to:
1070//
1071// %alloca = alloca %struct.foo
1072// %random = call %struct.foo* @random(%struct.foo* %alloca)
1073// %f0 = getelementptr inbounds %struct, %struct.foo* %alloca, i32 0, i32 0
1074// %f1 = getelementptr inbounds %struct, %struct.foo* %random, i32 0, i32 1
1075//
1076// Assume %f1 and %f0 alias. Then %f1 would point into the object allocated
1077// by %alloca. Since the %f1 GEP is inbounds, that means %random must also
1078// point into the same object. But since %f0 points to the beginning of %alloca,
1079// the highest %f1 can be is (%alloca + 3). This means %random can not be higher
1080// than (%alloca - 1), and so is not inbounds, a contradiction.
1081bool BasicAAResult::isGEPBaseAtNegativeOffset(const GEPOperator *GEPOp,
Michael Kupersteinae214912016-05-26 19:30:49 +00001082 const DecomposedGEP &DecompGEP, const DecomposedGEP &DecompObject,
1083 uint64_t ObjectAccessSize) {
1084 // If the object access size is unknown, or the GEP isn't inbounds, bail.
1085 if (ObjectAccessSize == MemoryLocation::UnknownSize || !GEPOp->isInBounds())
Michael Kuperstein82069c42016-05-25 22:23:08 +00001086 return false;
1087
Michael Kupersteinae214912016-05-26 19:30:49 +00001088 // We need the object to be an alloca or a globalvariable, and want to know
1089 // the offset of the pointer from the object precisely, so no variable
1090 // indices are allowed.
1091 if (!(isa<AllocaInst>(DecompObject.Base) ||
1092 isa<GlobalVariable>(DecompObject.Base)) ||
1093 !DecompObject.VarIndices.empty())
Michael Kuperstein82069c42016-05-25 22:23:08 +00001094 return false;
1095
Michael Kupersteinae214912016-05-26 19:30:49 +00001096 int64_t ObjectBaseOffset = DecompObject.StructOffset +
1097 DecompObject.OtherOffset;
Michael Kuperstein82069c42016-05-25 22:23:08 +00001098
1099 // If the GEP has no variable indices, we know the precise offset
1100 // from the base, then use it. If the GEP has variable indices, we're in
1101 // a bit more trouble: we can't count on the constant offsets that come
1102 // from non-struct sources, since these can be "rewound" by a negative
1103 // variable offset. So use only offsets that came from structs.
1104 int64_t GEPBaseOffset = DecompGEP.StructOffset;
1105 if (DecompGEP.VarIndices.empty())
1106 GEPBaseOffset += DecompGEP.OtherOffset;
1107
Michael Kupersteinae214912016-05-26 19:30:49 +00001108 return (GEPBaseOffset >= ObjectBaseOffset + (int64_t)ObjectAccessSize);
Michael Kuperstein82069c42016-05-25 22:23:08 +00001109}
1110
Chandler Carruthc5d81122015-08-06 08:17:06 +00001111/// Provides a bunch of ad-hoc rules to disambiguate a GEP instruction against
1112/// another pointer.
Chris Lattnera99edbe2009-11-26 02:11:08 +00001113///
Chandler Carruthc5d81122015-08-06 08:17:06 +00001114/// We know that V1 is a GEP, but we don't know anything about V2.
1115/// UnderlyingV1 is GetUnderlyingObject(GEP1, DL), UnderlyingV2 is the same for
1116/// V2.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001117AliasResult BasicAAResult::aliasGEP(const GEPOperator *GEP1, uint64_t V1Size,
1118 const AAMDNodes &V1AAInfo, const Value *V2,
1119 uint64_t V2Size, const AAMDNodes &V2AAInfo,
1120 const Value *UnderlyingV1,
1121 const Value *UnderlyingV2) {
Michael Kuperstein82069c42016-05-25 22:23:08 +00001122 DecomposedGEP DecompGEP1, DecompGEP2;
1123 bool GEP1MaxLookupReached =
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001124 DecomposeGEPExpression(GEP1, DecompGEP1, DL, &AC, DT);
Michael Kuperstein82069c42016-05-25 22:23:08 +00001125 bool GEP2MaxLookupReached =
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001126 DecomposeGEPExpression(V2, DecompGEP2, DL, &AC, DT);
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001127
Michael Kuperstein82069c42016-05-25 22:23:08 +00001128 int64_t GEP1BaseOffset = DecompGEP1.StructOffset + DecompGEP1.OtherOffset;
1129 int64_t GEP2BaseOffset = DecompGEP2.StructOffset + DecompGEP2.OtherOffset;
1130
1131 assert(DecompGEP1.Base == UnderlyingV1 && DecompGEP2.Base == UnderlyingV2 &&
1132 "DecomposeGEPExpression returned a result different from "
1133 "GetUnderlyingObject");
1134
1135 // If the GEP's offset relative to its base is such that the base would
1136 // fall below the start of the object underlying V2, then the GEP and V2
1137 // cannot alias.
1138 if (!GEP1MaxLookupReached && !GEP2MaxLookupReached &&
1139 isGEPBaseAtNegativeOffset(GEP1, DecompGEP1, DecompGEP2, V2Size))
1140 return NoAlias;
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001141 // If we have two gep instructions with must-alias or not-alias'ing base
1142 // pointers, figure out if the indexes to the GEP tell us anything about the
1143 // derived pointer.
Chris Lattnera99edbe2009-11-26 02:11:08 +00001144 if (const GEPOperator *GEP2 = dyn_cast<GEPOperator>(V2)) {
Michael Kuperstein82069c42016-05-25 22:23:08 +00001145 // Check for the GEP base being at a negative offset, this time in the other
1146 // direction.
1147 if (!GEP1MaxLookupReached && !GEP2MaxLookupReached &&
1148 isGEPBaseAtNegativeOffset(GEP2, DecompGEP2, DecompGEP1, V1Size))
1149 return NoAlias;
Arnold Schwaighoferaadf1042013-03-26 18:07:53 +00001150 // Do the base pointers alias?
Chandler Carruthecbd1682015-06-17 07:21:38 +00001151 AliasResult BaseAlias =
1152 aliasCheck(UnderlyingV1, MemoryLocation::UnknownSize, AAMDNodes(),
1153 UnderlyingV2, MemoryLocation::UnknownSize, AAMDNodes());
Arnold Schwaighoferaadf1042013-03-26 18:07:53 +00001154
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001155 // Check for geps of non-aliasing underlying pointers where the offsets are
1156 // identical.
Arnold Schwaighoferaadf1042013-03-26 18:07:53 +00001157 if ((BaseAlias == MayAlias) && V1Size == V2Size) {
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001158 // Do the base pointers alias assuming type and size.
Chandler Carruth903c5f92015-08-06 07:57:58 +00001159 AliasResult PreciseBaseAlias = aliasCheck(UnderlyingV1, V1Size, V1AAInfo,
1160 UnderlyingV2, V2Size, V2AAInfo);
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001161 if (PreciseBaseAlias == NoAlias) {
1162 // See if the computed offset from the common pointer tells us about the
1163 // relation of the resulting pointer.
Arnold Schwaighofer1a444482014-03-26 21:30:19 +00001164 // If the max search depth is reached the result is undefined
1165 if (GEP2MaxLookupReached || GEP1MaxLookupReached)
1166 return MayAlias;
1167
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001168 // Same offsets.
1169 if (GEP1BaseOffset == GEP2BaseOffset &&
Michael Kuperstein82069c42016-05-25 22:23:08 +00001170 DecompGEP1.VarIndices == DecompGEP2.VarIndices)
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001171 return NoAlias;
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001172 }
1173 }
Jakub Staszak07f383f2013-08-24 14:16:00 +00001174
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001175 // If we get a No or May, then return it immediately, no amount of analysis
1176 // will improve this situation.
Chandler Carruth903c5f92015-08-06 07:57:58 +00001177 if (BaseAlias != MustAlias)
1178 return BaseAlias;
Jakub Staszak07f383f2013-08-24 14:16:00 +00001179
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001180 // Otherwise, we have a MustAlias. Since the base pointers alias each other
1181 // exactly, see if the computed offset from the common pointer tells us
1182 // about the relation of the resulting pointer.
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +00001183 // If we know the two GEPs are based off of the exact same pointer (and not
1184 // just the same underlying object), see if that tells us anything about
1185 // the resulting pointers.
Hal Finkel5c12d8f2016-07-11 01:32:20 +00001186 if (GEP1->getPointerOperand()->stripPointerCasts() ==
1187 GEP2->getPointerOperand()->stripPointerCasts() &&
1188 GEP1->getPointerOperand()->getType() ==
1189 GEP2->getPointerOperand()->getType()) {
Chandler Carruth7b560d42015-09-09 17:55:00 +00001190 AliasResult R = aliasSameBasePointerGEPs(GEP1, V1Size, GEP2, V2Size, DL);
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +00001191 // If we couldn't find anything interesting, don't abandon just yet.
1192 if (R != MayAlias)
1193 return R;
1194 }
1195
Sanjay Patel9613b292016-01-17 23:13:48 +00001196 // If the max search depth is reached, the result is undefined
Arnold Schwaighofer1a444482014-03-26 21:30:19 +00001197 if (GEP2MaxLookupReached || GEP1MaxLookupReached)
1198 return MayAlias;
Jakub Staszak07f383f2013-08-24 14:16:00 +00001199
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001200 // Subtract the GEP2 pointer from the GEP1 pointer to find out their
1201 // symbolic difference.
1202 GEP1BaseOffset -= GEP2BaseOffset;
Michael Kuperstein82069c42016-05-25 22:23:08 +00001203 GetIndexDifference(DecompGEP1.VarIndices, DecompGEP2.VarIndices);
Jakub Staszak07f383f2013-08-24 14:16:00 +00001204
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001205 } else {
1206 // Check to see if these two pointers are related by the getelementptr
1207 // instruction. If one pointer is a GEP with a non-zero index of the other
1208 // pointer, we know they cannot alias.
Chris Lattner5c1cfc22009-11-26 16:52:32 +00001209
1210 // If both accesses are unknown size, we can't do anything useful here.
Chandler Carruthecbd1682015-06-17 07:21:38 +00001211 if (V1Size == MemoryLocation::UnknownSize &&
1212 V2Size == MemoryLocation::UnknownSize)
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001213 return MayAlias;
Chris Lattner6ea17f77f2003-12-11 22:44:13 +00001214
Chandler Carruthecbd1682015-06-17 07:21:38 +00001215 AliasResult R = aliasCheck(UnderlyingV1, MemoryLocation::UnknownSize,
Mehdi Amini1726fc62017-01-27 16:12:22 +00001216 AAMDNodes(), V2, MemoryLocation::UnknownSize,
1217 V2AAInfo, nullptr, UnderlyingV2);
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001218 if (R != MustAlias)
1219 // If V2 may alias GEP base pointer, conservatively returns MayAlias.
1220 // If V2 is known not to alias GEP base pointer, then the two values
Mehdi Amini1726fc62017-01-27 16:12:22 +00001221 // cannot alias per GEP semantics: "Any memory access must be done through
1222 // a pointer value associated with an address range of the memory access,
1223 // otherwise the behavior is undefined.".
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001224 return R;
Chris Lattner6ea17f77f2003-12-11 22:44:13 +00001225
Arnold Schwaighofer1a444482014-03-26 21:30:19 +00001226 // If the max search depth is reached the result is undefined
1227 if (GEP1MaxLookupReached)
1228 return MayAlias;
Chris Lattner6ea17f77f2003-12-11 22:44:13 +00001229 }
Jakub Staszak07f383f2013-08-24 14:16:00 +00001230
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001231 // In the two GEP Case, if there is no difference in the offsets of the
1232 // computed pointers, the resultant pointers are a must alias. This
Sanjay Patel9613b292016-01-17 23:13:48 +00001233 // happens when we have two lexically identical GEP's (for example).
Chris Lattnerd6a2a992003-02-26 19:41:54 +00001234 //
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001235 // In the other case, if we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2
1236 // must aliases the GEP, the end result is a must alias also.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001237 if (GEP1BaseOffset == 0 && DecompGEP1.VarIndices.empty())
Evan Chengc1eed9d2009-10-14 06:41:49 +00001238 return MustAlias;
Evan Chengf1f3dd32009-10-13 18:42:04 +00001239
Eli Friedman3d1b3072011-09-08 02:23:31 +00001240 // If there is a constant difference between the pointers, but the difference
1241 // is less than the size of the associated memory object, then we know
1242 // that the objects are partially overlapping. If the difference is
1243 // greater, we know they do not overlap.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001244 if (GEP1BaseOffset != 0 && DecompGEP1.VarIndices.empty()) {
Eli Friedman3d1b3072011-09-08 02:23:31 +00001245 if (GEP1BaseOffset >= 0) {
Chandler Carruthecbd1682015-06-17 07:21:38 +00001246 if (V2Size != MemoryLocation::UnknownSize) {
Eli Friedman3d1b3072011-09-08 02:23:31 +00001247 if ((uint64_t)GEP1BaseOffset < V2Size)
1248 return PartialAlias;
1249 return NoAlias;
1250 }
1251 } else {
Arnold Schwaighofere3ac0992014-01-16 04:53:18 +00001252 // We have the situation where:
1253 // + +
1254 // | BaseOffset |
1255 // ---------------->|
1256 // |-->V1Size |-------> V2Size
1257 // GEP1 V2
1258 // We need to know that V2Size is not unknown, otherwise we might have
1259 // stripped a gep with negative index ('gep <ptr>, -1, ...).
Chandler Carruthecbd1682015-06-17 07:21:38 +00001260 if (V1Size != MemoryLocation::UnknownSize &&
1261 V2Size != MemoryLocation::UnknownSize) {
Eli Friedman3d1b3072011-09-08 02:23:31 +00001262 if (-(uint64_t)GEP1BaseOffset < V1Size)
1263 return PartialAlias;
1264 return NoAlias;
1265 }
1266 }
Dan Gohmanc4bf5ca2010-12-13 22:50:24 +00001267 }
1268
Michael Kuperstein82069c42016-05-25 22:23:08 +00001269 if (!DecompGEP1.VarIndices.empty()) {
Eli Friedmanb78ac542011-09-08 02:37:07 +00001270 uint64_t Modulo = 0;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001271 bool AllPositive = true;
Michael Kuperstein82069c42016-05-25 22:23:08 +00001272 for (unsigned i = 0, e = DecompGEP1.VarIndices.size(); i != e; ++i) {
Quentin Colombet5989bc62015-08-31 22:32:47 +00001273
1274 // Try to distinguish something like &A[i][1] against &A[42][0].
1275 // Grab the least significant bit set in any of the scales. We
1276 // don't need std::abs here (even if the scale's negative) as we'll
1277 // be ^'ing Modulo with itself later.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001278 Modulo |= (uint64_t)DecompGEP1.VarIndices[i].Scale;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001279
1280 if (AllPositive) {
1281 // If the Value could change between cycles, then any reasoning about
1282 // the Value this cycle may not hold in the next cycle. We'll just
1283 // give up if we can't determine conditions that hold for every cycle:
Michael Kuperstein82069c42016-05-25 22:23:08 +00001284 const Value *V = DecompGEP1.VarIndices[i].V;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001285
1286 bool SignKnownZero, SignKnownOne;
Chandler Carruth7b560d42015-09-09 17:55:00 +00001287 ComputeSignBit(const_cast<Value *>(V), SignKnownZero, SignKnownOne, DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001288 0, &AC, nullptr, DT);
Quentin Colombet5989bc62015-08-31 22:32:47 +00001289
1290 // Zero-extension widens the variable, and so forces the sign
1291 // bit to zero.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001292 bool IsZExt = DecompGEP1.VarIndices[i].ZExtBits > 0 || isa<ZExtInst>(V);
Quentin Colombet5989bc62015-08-31 22:32:47 +00001293 SignKnownZero |= IsZExt;
1294 SignKnownOne &= !IsZExt;
1295
1296 // If the variable begins with a zero then we know it's
1297 // positive, regardless of whether the value is signed or
1298 // unsigned.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001299 int64_t Scale = DecompGEP1.VarIndices[i].Scale;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001300 AllPositive =
1301 (SignKnownZero && Scale >= 0) || (SignKnownOne && Scale < 0);
1302 }
1303 }
1304
Eli Friedmanb78ac542011-09-08 02:37:07 +00001305 Modulo = Modulo ^ (Modulo & (Modulo - 1));
Eli Friedman3d1b3072011-09-08 02:23:31 +00001306
Eli Friedmanb78ac542011-09-08 02:37:07 +00001307 // We can compute the difference between the two addresses
1308 // mod Modulo. Check whether that difference guarantees that the
1309 // two locations do not alias.
1310 uint64_t ModOffset = (uint64_t)GEP1BaseOffset & (Modulo - 1);
Chandler Carruthecbd1682015-06-17 07:21:38 +00001311 if (V1Size != MemoryLocation::UnknownSize &&
1312 V2Size != MemoryLocation::UnknownSize && ModOffset >= V2Size &&
1313 V1Size <= Modulo - ModOffset)
Eli Friedmanb78ac542011-09-08 02:37:07 +00001314 return NoAlias;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001315
1316 // If we know all the variables are positive, then GEP1 >= GEP1BasePtr.
1317 // If GEP1BasePtr > V2 (GEP1BaseOffset > 0) then we know the pointers
1318 // don't alias if V2Size can fit in the gap between V2 and GEP1BasePtr.
1319 if (AllPositive && GEP1BaseOffset > 0 && V2Size <= (uint64_t)GEP1BaseOffset)
1320 return NoAlias;
1321
Michael Kuperstein82069c42016-05-25 22:23:08 +00001322 if (constantOffsetHeuristic(DecompGEP1.VarIndices, V1Size, V2Size,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001323 GEP1BaseOffset, &AC, DT))
Quentin Colombet5989bc62015-08-31 22:32:47 +00001324 return NoAlias;
Eli Friedmanb78ac542011-09-08 02:37:07 +00001325 }
Eli Friedman3d1b3072011-09-08 02:23:31 +00001326
Dan Gohmanadf80ae2011-06-04 06:50:18 +00001327 // Statically, we can see that the base objects are the same, but the
1328 // pointers have dynamic offsets which we can't resolve. And none of our
1329 // little tricks above worked.
1330 //
1331 // TODO: Returning PartialAlias instead of MayAlias is a mild hack; the
1332 // practical effect of this is protecting TBAA in the case of dynamic
Dan Gohman9017b842012-02-17 18:33:38 +00001333 // indices into arrays of unions or malloc'd memory.
Dan Gohmanadf80ae2011-06-04 06:50:18 +00001334 return PartialAlias;
Evan Chengf1f3dd32009-10-13 18:42:04 +00001335}
1336
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001337static AliasResult MergeAliasResults(AliasResult A, AliasResult B) {
Dan Gohman4e7e7952011-06-03 20:17:36 +00001338 // If the results agree, take it.
1339 if (A == B)
1340 return A;
1341 // A mix of PartialAlias and MustAlias is PartialAlias.
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001342 if ((A == PartialAlias && B == MustAlias) ||
1343 (B == PartialAlias && A == MustAlias))
1344 return PartialAlias;
Dan Gohman4e7e7952011-06-03 20:17:36 +00001345 // Otherwise, we don't know anything.
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001346 return MayAlias;
Dan Gohman4e7e7952011-06-03 20:17:36 +00001347}
1348
Chandler Carruthc5d81122015-08-06 08:17:06 +00001349/// Provides a bunch of ad-hoc rules to disambiguate a Select instruction
1350/// against another.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001351AliasResult BasicAAResult::aliasSelect(const SelectInst *SI, uint64_t SISize,
1352 const AAMDNodes &SIAAInfo,
1353 const Value *V2, uint64_t V2Size,
Ehsan Amiri17e17012016-08-12 16:05:03 +00001354 const AAMDNodes &V2AAInfo,
1355 const Value *UnderV2) {
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001356 // If the values are Selects with the same condition, we can do a more precise
1357 // check: just check for aliases between the values on corresponding arms.
1358 if (const SelectInst *SI2 = dyn_cast<SelectInst>(V2))
1359 if (SI->getCondition() == SI2->getCondition()) {
Chandler Carruth903c5f92015-08-06 07:57:58 +00001360 AliasResult Alias = aliasCheck(SI->getTrueValue(), SISize, SIAAInfo,
1361 SI2->getTrueValue(), V2Size, V2AAInfo);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001362 if (Alias == MayAlias)
1363 return MayAlias;
1364 AliasResult ThisAlias =
Chandler Carruth903c5f92015-08-06 07:57:58 +00001365 aliasCheck(SI->getFalseValue(), SISize, SIAAInfo,
1366 SI2->getFalseValue(), V2Size, V2AAInfo);
Dan Gohman4e7e7952011-06-03 20:17:36 +00001367 return MergeAliasResults(ThisAlias, Alias);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001368 }
1369
1370 // If both arms of the Select node NoAlias or MustAlias V2, then returns
1371 // NoAlias / MustAlias. Otherwise, returns MayAlias.
1372 AliasResult Alias =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001373 aliasCheck(V2, V2Size, V2AAInfo, SI->getTrueValue(),
1374 SISize, SIAAInfo, UnderV2);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001375 if (Alias == MayAlias)
1376 return MayAlias;
Dan Gohman7c34ece2010-06-28 21:16:52 +00001377
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001378 AliasResult ThisAlias =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001379 aliasCheck(V2, V2Size, V2AAInfo, SI->getFalseValue(), SISize, SIAAInfo,
1380 UnderV2);
Dan Gohman4e7e7952011-06-03 20:17:36 +00001381 return MergeAliasResults(ThisAlias, Alias);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001382}
1383
Chandler Carruthc5d81122015-08-06 08:17:06 +00001384/// Provide a bunch of ad-hoc rules to disambiguate a PHI instruction against
1385/// another.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001386AliasResult BasicAAResult::aliasPHI(const PHINode *PN, uint64_t PNSize,
1387 const AAMDNodes &PNAAInfo, const Value *V2,
Ehsan Amiri17e17012016-08-12 16:05:03 +00001388 uint64_t V2Size, const AAMDNodes &V2AAInfo,
1389 const Value *UnderV2) {
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001390 // Track phi nodes we have visited. We use this information when we determine
1391 // value equivalence.
1392 VisitedPhiBBs.insert(PN->getParent());
1393
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001394 // If the values are PHIs in the same block, we can do a more precise
1395 // as well as efficient check: just check for aliases between the values
1396 // on corresponding edges.
1397 if (const PHINode *PN2 = dyn_cast<PHINode>(V2))
1398 if (PN2->getParent() == PN->getParent()) {
Chandler Carruthac80dc72015-06-17 07:18:54 +00001399 LocPair Locs(MemoryLocation(PN, PNSize, PNAAInfo),
1400 MemoryLocation(V2, V2Size, V2AAInfo));
Arnold Schwaighofer8dc34cf2012-09-06 14:41:53 +00001401 if (PN > V2)
1402 std::swap(Locs.first, Locs.second);
Arnold Schwaighoferedd62b12012-12-10 23:02:41 +00001403 // Analyse the PHIs' inputs under the assumption that the PHIs are
1404 // NoAlias.
1405 // If the PHIs are May/MustAlias there must be (recursively) an input
1406 // operand from outside the PHIs' cycle that is MayAlias/MustAlias or
1407 // there must be an operation on the PHIs within the PHIs' value cycle
1408 // that causes a MayAlias.
1409 // Pretend the phis do not alias.
1410 AliasResult Alias = NoAlias;
1411 assert(AliasCache.count(Locs) &&
1412 "There must exist an entry for the phi node");
1413 AliasResult OrigAliasResult = AliasCache[Locs];
1414 AliasCache[Locs] = NoAlias;
Arnold Schwaighofer8dc34cf2012-09-06 14:41:53 +00001415
Hal Finkela6f86fc2012-11-17 02:33:15 +00001416 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001417 AliasResult ThisAlias =
Chandler Carruth903c5f92015-08-06 07:57:58 +00001418 aliasCheck(PN->getIncomingValue(i), PNSize, PNAAInfo,
1419 PN2->getIncomingValueForBlock(PN->getIncomingBlock(i)),
1420 V2Size, V2AAInfo);
Dan Gohman4e7e7952011-06-03 20:17:36 +00001421 Alias = MergeAliasResults(ThisAlias, Alias);
1422 if (Alias == MayAlias)
1423 break;
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001424 }
Arnold Schwaighofer8dc34cf2012-09-06 14:41:53 +00001425
1426 // Reset if speculation failed.
Arnold Schwaighoferedd62b12012-12-10 23:02:41 +00001427 if (Alias != NoAlias)
Arnold Schwaighofer8dc34cf2012-09-06 14:41:53 +00001428 AliasCache[Locs] = OrigAliasResult;
1429
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001430 return Alias;
1431 }
1432
Chandler Carruth903c5f92015-08-06 07:57:58 +00001433 SmallPtrSet<Value *, 4> UniqueSrc;
1434 SmallVector<Value *, 4> V1Srcs;
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +00001435 bool isRecursive = false;
Pete Cooper833f34d2015-05-12 20:05:31 +00001436 for (Value *PV1 : PN->incoming_values()) {
Evan Chengc10e88d2009-10-13 22:02:20 +00001437 if (isa<PHINode>(PV1))
1438 // If any of the source itself is a PHI, return MayAlias conservatively
Evan Chengc1eed9d2009-10-14 06:41:49 +00001439 // to avoid compile time explosion. The worst possible case is if both
1440 // sides are PHI nodes. In which case, this is O(m x n) time where 'm'
1441 // and 'n' are the number of PHI sources.
Evan Chengc10e88d2009-10-13 22:02:20 +00001442 return MayAlias;
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +00001443
1444 if (EnableRecPhiAnalysis)
1445 if (GEPOperator *PV1GEP = dyn_cast<GEPOperator>(PV1)) {
1446 // Check whether the incoming value is a GEP that advances the pointer
1447 // result of this PHI node (e.g. in a loop). If this is the case, we
1448 // would recurse and always get a MayAlias. Handle this case specially
1449 // below.
1450 if (PV1GEP->getPointerOperand() == PN && PV1GEP->getNumIndices() == 1 &&
1451 isa<ConstantInt>(PV1GEP->idx_begin())) {
1452 isRecursive = true;
1453 continue;
1454 }
1455 }
1456
David Blaikie70573dc2014-11-19 07:49:26 +00001457 if (UniqueSrc.insert(PV1).second)
Evan Chengc10e88d2009-10-13 22:02:20 +00001458 V1Srcs.push_back(PV1);
1459 }
1460
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +00001461 // If this PHI node is recursive, set the size of the accessed memory to
1462 // unknown to represent all the possible values the GEP could advance the
1463 // pointer to.
1464 if (isRecursive)
1465 PNSize = MemoryLocation::UnknownSize;
1466
Chandler Carruth903c5f92015-08-06 07:57:58 +00001467 AliasResult Alias =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001468 aliasCheck(V2, V2Size, V2AAInfo, V1Srcs[0],
1469 PNSize, PNAAInfo, UnderV2);
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +00001470
Evan Chengf92f5552009-10-14 05:22:03 +00001471 // Early exit if the check of the first PHI source against V2 is MayAlias.
1472 // Other results are not possible.
1473 if (Alias == MayAlias)
1474 return MayAlias;
1475
Evan Chengc10e88d2009-10-13 22:02:20 +00001476 // If all sources of the PHI node NoAlias or MustAlias V2, then returns
1477 // NoAlias / MustAlias. Otherwise, returns MayAlias.
Evan Chengc10e88d2009-10-13 22:02:20 +00001478 for (unsigned i = 1, e = V1Srcs.size(); i != e; ++i) {
1479 Value *V = V1Srcs[i];
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001480
Chandler Carruth903c5f92015-08-06 07:57:58 +00001481 AliasResult ThisAlias =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001482 aliasCheck(V2, V2Size, V2AAInfo, V, PNSize, PNAAInfo, UnderV2);
Dan Gohman4e7e7952011-06-03 20:17:36 +00001483 Alias = MergeAliasResults(ThisAlias, Alias);
1484 if (Alias == MayAlias)
1485 break;
Evan Chengc10e88d2009-10-13 22:02:20 +00001486 }
1487
1488 return Alias;
1489}
1490
David Majnemer0345b0f2015-11-17 08:15:08 +00001491/// Provides a bunch of ad-hoc rules to disambiguate in common cases, such as
Chandler Carruthc5d81122015-08-06 08:17:06 +00001492/// array references.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001493AliasResult BasicAAResult::aliasCheck(const Value *V1, uint64_t V1Size,
1494 AAMDNodes V1AAInfo, const Value *V2,
Ehsan Amiri17e17012016-08-12 16:05:03 +00001495 uint64_t V2Size, AAMDNodes V2AAInfo,
1496 const Value *O1, const Value *O2) {
Dan Gohmancb45bd92010-04-08 18:11:50 +00001497 // If either of the memory references is empty, it doesn't matter what the
1498 // pointer values are.
1499 if (V1Size == 0 || V2Size == 0)
1500 return NoAlias;
1501
Evan Chengf1f3dd32009-10-13 18:42:04 +00001502 // Strip off any casts if they exist.
1503 V1 = V1->stripPointerCasts();
1504 V2 = V2->stripPointerCasts();
1505
Daniel Berlin3459d6e2015-05-05 18:10:49 +00001506 // If V1 or V2 is undef, the result is NoAlias because we can always pick a
1507 // value for undef that aliases nothing in the program.
1508 if (isa<UndefValue>(V1) || isa<UndefValue>(V2))
1509 return NoAlias;
1510
Evan Chengf1f3dd32009-10-13 18:42:04 +00001511 // Are we checking for alias of the same value?
Sanjay Patel9613b292016-01-17 23:13:48 +00001512 // Because we look 'through' phi nodes, we could look at "Value" pointers from
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001513 // different iterations. We must therefore make sure that this is not the
1514 // case. The function isValueEqualInPotentialCycles ensures that this cannot
1515 // happen by looking at the visited phi nodes and making sure they cannot
1516 // reach the value.
1517 if (isValueEqualInPotentialCycles(V1, V2))
1518 return MustAlias;
Evan Chengf1f3dd32009-10-13 18:42:04 +00001519
Duncan Sands19d0b472010-02-16 11:11:14 +00001520 if (!V1->getType()->isPointerTy() || !V2->getType()->isPointerTy())
Chandler Carruth903c5f92015-08-06 07:57:58 +00001521 return NoAlias; // Scalars cannot alias each other
Evan Chengf1f3dd32009-10-13 18:42:04 +00001522
1523 // Figure out what objects these things are pointing to if we can.
Ehsan Amiri17e17012016-08-12 16:05:03 +00001524 if (O1 == nullptr)
1525 O1 = GetUnderlyingObject(V1, DL, MaxLookupSearchDepth);
1526
1527 if (O2 == nullptr)
1528 O2 = GetUnderlyingObject(V2, DL, MaxLookupSearchDepth);
Evan Chengf1f3dd32009-10-13 18:42:04 +00001529
Dan Gohmanccb45842009-11-09 19:29:11 +00001530 // Null values in the default address space don't point to any object, so they
1531 // don't alias any other pointer.
1532 if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O1))
1533 if (CPN->getType()->getAddressSpace() == 0)
1534 return NoAlias;
1535 if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O2))
1536 if (CPN->getType()->getAddressSpace() == 0)
1537 return NoAlias;
1538
Evan Chengf1f3dd32009-10-13 18:42:04 +00001539 if (O1 != O2) {
Sanjay Patel9613b292016-01-17 23:13:48 +00001540 // If V1/V2 point to two different objects, we know that we have no alias.
Dan Gohman00ef9322010-07-07 14:27:09 +00001541 if (isIdentifiedObject(O1) && isIdentifiedObject(O2))
Evan Chengf1f3dd32009-10-13 18:42:04 +00001542 return NoAlias;
Nick Lewyckyc53e2ec2009-11-14 06:15:14 +00001543
1544 // Constant pointers can't alias with non-const isIdentifiedObject objects.
Dan Gohman00ef9322010-07-07 14:27:09 +00001545 if ((isa<Constant>(O1) && isIdentifiedObject(O2) && !isa<Constant>(O2)) ||
1546 (isa<Constant>(O2) && isIdentifiedObject(O1) && !isa<Constant>(O1)))
Nick Lewyckyc53e2ec2009-11-14 06:15:14 +00001547 return NoAlias;
1548
Michael Kupersteinf3e663a2013-05-28 08:17:48 +00001549 // Function arguments can't alias with things that are known to be
1550 // unambigously identified at the function level.
1551 if ((isa<Argument>(O1) && isIdentifiedFunctionLocal(O2)) ||
1552 (isa<Argument>(O2) && isIdentifiedFunctionLocal(O1)))
Dan Gohman84f90a32010-07-01 20:08:40 +00001553 return NoAlias;
Evan Chengf1f3dd32009-10-13 18:42:04 +00001554
1555 // Most objects can't alias null.
Dan Gohman00ef9322010-07-07 14:27:09 +00001556 if ((isa<ConstantPointerNull>(O2) && isKnownNonNull(O1)) ||
1557 (isa<ConstantPointerNull>(O1) && isKnownNonNull(O2)))
Evan Chengf1f3dd32009-10-13 18:42:04 +00001558 return NoAlias;
Jakub Staszak07f383f2013-08-24 14:16:00 +00001559
Dan Gohman5b0a8a82010-07-07 14:30:04 +00001560 // If one pointer is the result of a call/invoke or load and the other is a
1561 // non-escaping local object within the same function, then we know the
1562 // object couldn't escape to a point where the call could return it.
1563 //
1564 // Note that if the pointers are in different functions, there are a
1565 // variety of complications. A call with a nocapture argument may still
1566 // temporary store the nocapture argument's value in a temporary memory
1567 // location if that memory location doesn't escape. Or it may pass a
1568 // nocapture value to other functions as long as they don't capture it.
1569 if (isEscapeSource(O1) && isNonEscapingLocalObject(O2))
1570 return NoAlias;
1571 if (isEscapeSource(O2) && isNonEscapingLocalObject(O1))
1572 return NoAlias;
1573 }
1574
Evan Chengf1f3dd32009-10-13 18:42:04 +00001575 // If the size of one access is larger than the entire object on the other
1576 // side, then we know such behavior is undefined and can assume no alias.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001577 if ((V1Size != MemoryLocation::UnknownSize &&
1578 isObjectSmallerThan(O2, V1Size, DL, TLI)) ||
1579 (V2Size != MemoryLocation::UnknownSize &&
1580 isObjectSmallerThan(O1, V2Size, DL, TLI)))
1581 return NoAlias;
Jakub Staszak07f383f2013-08-24 14:16:00 +00001582
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001583 // Check the cache before climbing up use-def chains. This also terminates
1584 // otherwise infinitely recursive queries.
Chandler Carruthac80dc72015-06-17 07:18:54 +00001585 LocPair Locs(MemoryLocation(V1, V1Size, V1AAInfo),
1586 MemoryLocation(V2, V2Size, V2AAInfo));
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001587 if (V1 > V2)
1588 std::swap(Locs.first, Locs.second);
1589 std::pair<AliasCacheTy::iterator, bool> Pair =
Chandler Carruth903c5f92015-08-06 07:57:58 +00001590 AliasCache.insert(std::make_pair(Locs, MayAlias));
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001591 if (!Pair.second)
1592 return Pair.first->second;
1593
Chris Lattner89288992009-11-26 02:13:03 +00001594 // FIXME: This isn't aggressively handling alias(GEP, PHI) for example: if the
1595 // GEP can't simplify, we don't even look at the PHI cases.
Chris Lattnerb2647b92009-10-17 23:48:54 +00001596 if (!isa<GEPOperator>(V1) && isa<GEPOperator>(V2)) {
Chris Lattnerd6a2a992003-02-26 19:41:54 +00001597 std::swap(V1, V2);
1598 std::swap(V1Size, V2Size);
Chris Lattner5341c962009-11-26 02:14:59 +00001599 std::swap(O1, O2);
Hal Finkelcc39b672014-07-24 12:16:19 +00001600 std::swap(V1AAInfo, V2AAInfo);
Chris Lattnerd6a2a992003-02-26 19:41:54 +00001601 }
Dan Gohman02538ac2010-10-18 18:04:47 +00001602 if (const GEPOperator *GV1 = dyn_cast<GEPOperator>(V1)) {
Chandler Carruth903c5f92015-08-06 07:57:58 +00001603 AliasResult Result =
1604 aliasGEP(GV1, V1Size, V1AAInfo, V2, V2Size, V2AAInfo, O1, O2);
1605 if (Result != MayAlias)
1606 return AliasCache[Locs] = Result;
Dan Gohman02538ac2010-10-18 18:04:47 +00001607 }
Evan Chengc10e88d2009-10-13 22:02:20 +00001608
1609 if (isa<PHINode>(V2) && !isa<PHINode>(V1)) {
1610 std::swap(V1, V2);
Ehsan Amiri17e17012016-08-12 16:05:03 +00001611 std::swap(O1, O2);
Evan Chengc10e88d2009-10-13 22:02:20 +00001612 std::swap(V1Size, V2Size);
Hal Finkelcc39b672014-07-24 12:16:19 +00001613 std::swap(V1AAInfo, V2AAInfo);
Evan Chengc10e88d2009-10-13 22:02:20 +00001614 }
Dan Gohman02538ac2010-10-18 18:04:47 +00001615 if (const PHINode *PN = dyn_cast<PHINode>(V1)) {
Ehsan Amiri17e17012016-08-12 16:05:03 +00001616 AliasResult Result = aliasPHI(PN, V1Size, V1AAInfo,
1617 V2, V2Size, V2AAInfo, O2);
Chandler Carruth903c5f92015-08-06 07:57:58 +00001618 if (Result != MayAlias)
1619 return AliasCache[Locs] = Result;
Dan Gohman02538ac2010-10-18 18:04:47 +00001620 }
Misha Brukman01808ca2005-04-21 21:13:18 +00001621
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001622 if (isa<SelectInst>(V2) && !isa<SelectInst>(V1)) {
1623 std::swap(V1, V2);
Ehsan Amiri17e17012016-08-12 16:05:03 +00001624 std::swap(O1, O2);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001625 std::swap(V1Size, V2Size);
Hal Finkelcc39b672014-07-24 12:16:19 +00001626 std::swap(V1AAInfo, V2AAInfo);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001627 }
Dan Gohman02538ac2010-10-18 18:04:47 +00001628 if (const SelectInst *S1 = dyn_cast<SelectInst>(V1)) {
Chandler Carruth903c5f92015-08-06 07:57:58 +00001629 AliasResult Result =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001630 aliasSelect(S1, V1Size, V1AAInfo, V2, V2Size, V2AAInfo, O2);
Chandler Carruth903c5f92015-08-06 07:57:58 +00001631 if (Result != MayAlias)
1632 return AliasCache[Locs] = Result;
Dan Gohman02538ac2010-10-18 18:04:47 +00001633 }
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001634
Dan Gohman44da55b2011-01-18 21:16:06 +00001635 // If both pointers are pointing into the same object and one of them
Sanjay Patel9613b292016-01-17 23:13:48 +00001636 // accesses the entire object, then the accesses must overlap in some way.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001637 if (O1 == O2)
Chandler Carruthecbd1682015-06-17 07:21:38 +00001638 if ((V1Size != MemoryLocation::UnknownSize &&
Chandler Carruth7b560d42015-09-09 17:55:00 +00001639 isObjectSize(O1, V1Size, DL, TLI)) ||
Chandler Carruthecbd1682015-06-17 07:21:38 +00001640 (V2Size != MemoryLocation::UnknownSize &&
Chandler Carruth7b560d42015-09-09 17:55:00 +00001641 isObjectSize(O2, V2Size, DL, TLI)))
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001642 return AliasCache[Locs] = PartialAlias;
Dan Gohman44da55b2011-01-18 21:16:06 +00001643
Chandler Carruth7b560d42015-09-09 17:55:00 +00001644 // Recurse back into the best AA results we have, potentially with refined
1645 // memory locations. We have already ensured that BasicAA has a MayAlias
1646 // cache result for these, so any recursion back into BasicAA won't loop.
1647 AliasResult Result = getBestAAResults().alias(Locs.first, Locs.second);
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001648 return AliasCache[Locs] = Result;
Chris Lattnerd6a2a992003-02-26 19:41:54 +00001649}
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001650
Chandler Carruthc5d81122015-08-06 08:17:06 +00001651/// Check whether two Values can be considered equivalent.
1652///
1653/// In addition to pointer equivalence of \p V1 and \p V2 this checks whether
1654/// they can not be part of a cycle in the value graph by looking at all
1655/// visited phi nodes an making sure that the phis cannot reach the value. We
1656/// have to do this because we are looking through phi nodes (That is we say
1657/// noalias(V, phi(VA, VB)) if noalias(V, VA) and noalias(V, VB).
Chandler Carruth7b560d42015-09-09 17:55:00 +00001658bool BasicAAResult::isValueEqualInPotentialCycles(const Value *V,
1659 const Value *V2) {
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001660 if (V != V2)
1661 return false;
1662
1663 const Instruction *Inst = dyn_cast<Instruction>(V);
1664 if (!Inst)
1665 return true;
1666
Daniel Berlin9e77de22015-03-20 18:05:49 +00001667 if (VisitedPhiBBs.empty())
1668 return true;
1669
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001670 if (VisitedPhiBBs.size() > MaxNumPhiBBsValueReachabilityCheck)
1671 return false;
1672
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001673 // Make sure that the visited phis cannot reach the Value. This ensures that
1674 // the Values cannot come from different iterations of a potential cycle the
1675 // phi nodes could be involved in.
Craig Topper46276792014-08-24 23:23:06 +00001676 for (auto *P : VisitedPhiBBs)
Duncan P. N. Exon Smith5a82c912015-10-10 00:53:03 +00001677 if (isPotentiallyReachable(&P->front(), Inst, DT, LI))
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001678 return false;
1679
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001680 return true;
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001681}
1682
Chandler Carruthc5d81122015-08-06 08:17:06 +00001683/// Computes the symbolic difference between two de-composed GEPs.
1684///
1685/// Dest and Src are the variable indices from two decomposed GetElementPtr
1686/// instructions GEP1 and GEP2 which have common base pointers.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001687void BasicAAResult::GetIndexDifference(
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001688 SmallVectorImpl<VariableGEPIndex> &Dest,
1689 const SmallVectorImpl<VariableGEPIndex> &Src) {
1690 if (Src.empty())
1691 return;
1692
1693 for (unsigned i = 0, e = Src.size(); i != e; ++i) {
1694 const Value *V = Src[i].V;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001695 unsigned ZExtBits = Src[i].ZExtBits, SExtBits = Src[i].SExtBits;
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001696 int64_t Scale = Src[i].Scale;
1697
1698 // Find V in Dest. This is N^2, but pointer indices almost never have more
1699 // than a few variable indexes.
1700 for (unsigned j = 0, e = Dest.size(); j != e; ++j) {
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001701 if (!isValueEqualInPotentialCycles(Dest[j].V, V) ||
Quentin Colombet5989bc62015-08-31 22:32:47 +00001702 Dest[j].ZExtBits != ZExtBits || Dest[j].SExtBits != SExtBits)
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001703 continue;
1704
1705 // If we found it, subtract off Scale V's from the entry in Dest. If it
1706 // goes to zero, remove the entry.
1707 if (Dest[j].Scale != Scale)
1708 Dest[j].Scale -= Scale;
1709 else
1710 Dest.erase(Dest.begin() + j);
1711 Scale = 0;
1712 break;
1713 }
1714
1715 // If we didn't consume this entry, add it to the end of the Dest list.
1716 if (Scale) {
Quentin Colombet5989bc62015-08-31 22:32:47 +00001717 VariableGEPIndex Entry = {V, ZExtBits, SExtBits, -Scale};
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001718 Dest.push_back(Entry);
1719 }
1720 }
1721}
Quentin Colombet5989bc62015-08-31 22:32:47 +00001722
Chandler Carruth7b560d42015-09-09 17:55:00 +00001723bool BasicAAResult::constantOffsetHeuristic(
Quentin Colombet5989bc62015-08-31 22:32:47 +00001724 const SmallVectorImpl<VariableGEPIndex> &VarIndices, uint64_t V1Size,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001725 uint64_t V2Size, int64_t BaseOffset, AssumptionCache *AC,
Chandler Carruth7b560d42015-09-09 17:55:00 +00001726 DominatorTree *DT) {
Quentin Colombet5989bc62015-08-31 22:32:47 +00001727 if (VarIndices.size() != 2 || V1Size == MemoryLocation::UnknownSize ||
Chandler Carruth7b560d42015-09-09 17:55:00 +00001728 V2Size == MemoryLocation::UnknownSize)
Quentin Colombet5989bc62015-08-31 22:32:47 +00001729 return false;
1730
1731 const VariableGEPIndex &Var0 = VarIndices[0], &Var1 = VarIndices[1];
1732
1733 if (Var0.ZExtBits != Var1.ZExtBits || Var0.SExtBits != Var1.SExtBits ||
1734 Var0.Scale != -Var1.Scale)
1735 return false;
1736
1737 unsigned Width = Var1.V->getType()->getIntegerBitWidth();
1738
1739 // We'll strip off the Extensions of Var0 and Var1 and do another round
1740 // of GetLinearExpression decomposition. In the example above, if Var0
1741 // is zext(%x + 1) we should get V1 == %x and V1Offset == 1.
1742
1743 APInt V0Scale(Width, 0), V0Offset(Width, 0), V1Scale(Width, 0),
1744 V1Offset(Width, 0);
1745 bool NSW = true, NUW = true;
1746 unsigned V0ZExtBits = 0, V0SExtBits = 0, V1ZExtBits = 0, V1SExtBits = 0;
1747 const Value *V0 = GetLinearExpression(Var0.V, V0Scale, V0Offset, V0ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001748 V0SExtBits, DL, 0, AC, DT, NSW, NUW);
Richard Trieu7a083812016-02-18 22:09:30 +00001749 NSW = true;
1750 NUW = true;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001751 const Value *V1 = GetLinearExpression(Var1.V, V1Scale, V1Offset, V1ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001752 V1SExtBits, DL, 0, AC, DT, NSW, NUW);
Quentin Colombet5989bc62015-08-31 22:32:47 +00001753
1754 if (V0Scale != V1Scale || V0ZExtBits != V1ZExtBits ||
1755 V0SExtBits != V1SExtBits || !isValueEqualInPotentialCycles(V0, V1))
1756 return false;
1757
1758 // We have a hit - Var0 and Var1 only differ by a constant offset!
1759
1760 // If we've been sext'ed then zext'd the maximum difference between Var0 and
1761 // Var1 is possible to calculate, but we're just interested in the absolute
Benjamin Kramer557b6012015-10-24 11:38:01 +00001762 // minimum difference between the two. The minimum distance may occur due to
Quentin Colombet5989bc62015-08-31 22:32:47 +00001763 // wrapping; consider "add i3 %i, 5": if %i == 7 then 7 + 5 mod 8 == 4, and so
1764 // the minimum distance between %i and %i + 5 is 3.
Benjamin Kramer557b6012015-10-24 11:38:01 +00001765 APInt MinDiff = V0Offset - V1Offset, Wrapped = -MinDiff;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001766 MinDiff = APIntOps::umin(MinDiff, Wrapped);
1767 uint64_t MinDiffBytes = MinDiff.getZExtValue() * std::abs(Var0.Scale);
1768
1769 // We can't definitely say whether GEP1 is before or after V2 due to wrapping
1770 // arithmetic (i.e. for some values of GEP1 and V2 GEP1 < V2, and for other
1771 // values GEP1 > V2). We'll therefore only declare NoAlias if both V1Size and
1772 // V2Size can fit in the MinDiffBytes gap.
1773 return V1Size + std::abs(BaseOffset) <= MinDiffBytes &&
1774 V2Size + std::abs(BaseOffset) <= MinDiffBytes;
1775}
Chandler Carruth7b560d42015-09-09 17:55:00 +00001776
1777//===----------------------------------------------------------------------===//
1778// BasicAliasAnalysis Pass
1779//===----------------------------------------------------------------------===//
1780
Chandler Carruthdab4eae2016-11-23 17:53:26 +00001781AnalysisKey BasicAA::Key;
Chandler Carruthb4faf132016-03-11 10:22:49 +00001782
Sean Silva36e0d012016-08-09 00:28:15 +00001783BasicAAResult BasicAA::run(Function &F, FunctionAnalysisManager &AM) {
Chandler Carruth7b560d42015-09-09 17:55:00 +00001784 return BasicAAResult(F.getParent()->getDataLayout(),
Chandler Carruthb47f8012016-03-11 11:05:24 +00001785 AM.getResult<TargetLibraryAnalysis>(F),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001786 AM.getResult<AssumptionAnalysis>(F),
Chandler Carruth5bfbc3f2016-03-11 13:53:18 +00001787 &AM.getResult<DominatorTreeAnalysis>(F),
Chandler Carruthb47f8012016-03-11 11:05:24 +00001788 AM.getCachedResult<LoopAnalysis>(F));
Chandler Carruth7b560d42015-09-09 17:55:00 +00001789}
1790
Keno Fischer277bfae2015-10-26 21:22:58 +00001791BasicAAWrapperPass::BasicAAWrapperPass() : FunctionPass(ID) {
1792 initializeBasicAAWrapperPassPass(*PassRegistry::getPassRegistry());
1793}
1794
Chandler Carruth7b560d42015-09-09 17:55:00 +00001795char BasicAAWrapperPass::ID = 0;
1796void BasicAAWrapperPass::anchor() {}
1797
1798INITIALIZE_PASS_BEGIN(BasicAAWrapperPass, "basicaa",
1799 "Basic Alias Analysis (stateless AA impl)", true, true)
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001800INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
Chandler Carruth5bfbc3f2016-03-11 13:53:18 +00001801INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
Chandler Carruth7b560d42015-09-09 17:55:00 +00001802INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
1803INITIALIZE_PASS_END(BasicAAWrapperPass, "basicaa",
1804 "Basic Alias Analysis (stateless AA impl)", true, true)
1805
1806FunctionPass *llvm::createBasicAAWrapperPass() {
1807 return new BasicAAWrapperPass();
1808}
1809
1810bool BasicAAWrapperPass::runOnFunction(Function &F) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001811 auto &ACT = getAnalysis<AssumptionCacheTracker>();
Chandler Carruth7b560d42015-09-09 17:55:00 +00001812 auto &TLIWP = getAnalysis<TargetLibraryInfoWrapperPass>();
Chandler Carruth5bfbc3f2016-03-11 13:53:18 +00001813 auto &DTWP = getAnalysis<DominatorTreeWrapperPass>();
Chandler Carruth7b560d42015-09-09 17:55:00 +00001814 auto *LIWP = getAnalysisIfAvailable<LoopInfoWrapperPass>();
1815
1816 Result.reset(new BasicAAResult(F.getParent()->getDataLayout(), TLIWP.getTLI(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001817 ACT.getAssumptionCache(F), &DTWP.getDomTree(),
Chandler Carruth7b560d42015-09-09 17:55:00 +00001818 LIWP ? &LIWP->getLoopInfo() : nullptr));
1819
1820 return false;
1821}
1822
1823void BasicAAWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
1824 AU.setPreservesAll();
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001825 AU.addRequired<AssumptionCacheTracker>();
Chandler Carruth5bfbc3f2016-03-11 13:53:18 +00001826 AU.addRequired<DominatorTreeWrapperPass>();
Chandler Carruth7b560d42015-09-09 17:55:00 +00001827 AU.addRequired<TargetLibraryInfoWrapperPass>();
1828}
1829
1830BasicAAResult llvm::createLegacyPMBasicAAResult(Pass &P, Function &F) {
1831 return BasicAAResult(
1832 F.getParent()->getDataLayout(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001833 P.getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(),
1834 P.getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F));
Chandler Carruth7b560d42015-09-09 17:55:00 +00001835}