blob: a33c01a0e461ebb1e2355e8e909c0f39a0ec3bfa [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"
Craig Topperdfc89552017-05-14 06:18:34 +000020#include "llvm/Analysis/AssumptionCache.h"
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +000021#include "llvm/Analysis/CFG.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000022#include "llvm/Analysis/CaptureTracking.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000023#include "llvm/Analysis/InstructionSimplify.h"
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +000024#include "llvm/Analysis/LoopInfo.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000025#include "llvm/Analysis/MemoryBuiltins.h"
26#include "llvm/Analysis/ValueTracking.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"
Craig Topper1a36b7d2017-05-15 06:39:41 +000039#include "llvm/Support/KnownBits.h"
Alkis Evlogimenosa5c04ee2004-09-03 18:19:51 +000040#include <algorithm>
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +000041
42#define DEBUG_TYPE "basicaa"
43
Chris Lattner35997482003-11-25 18:33:40 +000044using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000045
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +000046/// Enable analysis of recursive PHI nodes.
Chandler Carruth903c5f92015-08-06 07:57:58 +000047static cl::opt<bool> EnableRecPhiAnalysis("basicaa-recphi", cl::Hidden,
48 cl::init(false));
Wei Mid67daae2015-08-05 23:40:30 +000049/// SearchLimitReached / SearchTimes shows how often the limit of
50/// to decompose GEPs is reached. It will affect the precision
51/// of basic alias analysis.
Wei Mid67daae2015-08-05 23:40:30 +000052STATISTIC(SearchLimitReached, "Number of times the limit to "
53 "decompose GEPs is reached");
54STATISTIC(SearchTimes, "Number of times a GEP is decomposed");
55
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +000056/// Cutoff after which to stop analysing a set of phi nodes potentially involved
Sanjay Patel9613b292016-01-17 23:13:48 +000057/// in a cycle. Because we are analysing 'through' phi nodes, we need to be
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +000058/// careful with value equivalence. We use reachability to make sure a value
59/// cannot be involved in a cycle.
60const unsigned MaxNumPhiBBsValueReachabilityCheck = 20;
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +000061
Arnold Schwaighofer1a444482014-03-26 21:30:19 +000062// The max limit of the search depth in DecomposeGEPExpression() and
63// GetUnderlyingObject(), both functions need to use the same search
64// depth otherwise the algorithm in aliasGEP will assert.
65static const unsigned MaxLookupSearchDepth = 6;
66
Chandler Carruthaa351672016-12-27 10:30:45 +000067bool BasicAAResult::invalidate(Function &F, const PreservedAnalyses &PA,
68 FunctionAnalysisManager::Invalidator &Inv) {
Chandler Carruthaa351672016-12-27 10:30:45 +000069 // We don't care if this analysis itself is preserved, it has no state. But
70 // we need to check that the analyses it depends on have been. Note that we
71 // may be created without handles to some analyses and in that case don't
72 // depend on them.
73 if (Inv.invalidate<AssumptionAnalysis>(F, PA) ||
74 (DT && Inv.invalidate<DominatorTreeAnalysis>(F, PA)) ||
75 (LI && Inv.invalidate<LoopAnalysis>(F, PA)))
76 return true;
77
78 // Otherwise this analysis result remains valid.
79 return false;
80}
81
Chris Lattner2d332972008-06-16 06:30:22 +000082//===----------------------------------------------------------------------===//
83// Useful predicates
84//===----------------------------------------------------------------------===//
Devang Patel09f162c2007-05-01 21:15:47 +000085
Chandler Carruthc5d81122015-08-06 08:17:06 +000086/// Returns true if the pointer is to a function-local object that never
87/// escapes from the function.
Dan Gohman84f90a32010-07-01 20:08:40 +000088static bool isNonEscapingLocalObject(const Value *V) {
Chris Lattnerfa482582008-06-16 06:28:01 +000089 // If this is a local allocation, check to see if it escapes.
Dan Gohman84f90a32010-07-01 20:08:40 +000090 if (isa<AllocaInst>(V) || isNoAliasCall(V))
Dan Gohman94e61762009-11-19 21:57:48 +000091 // Set StoreCaptures to True so that we can assume in our callers that the
92 // pointer is not the result of a load instruction. Currently
93 // PointerMayBeCaptured doesn't have any special analysis for the
94 // StoreCaptures=false case; if it did, our callers could be refined to be
95 // more precise.
96 return !PointerMayBeCaptured(V, false, /*StoreCaptures=*/true);
Duncan Sands8d65f362009-01-05 21:19:53 +000097
Chris Lattnerfa482582008-06-16 06:28:01 +000098 // If this is an argument that corresponds to a byval or noalias argument,
Duncan Sands8d65f362009-01-05 21:19:53 +000099 // then it has not escaped before entering the function. Check if it escapes
100 // inside the function.
Dan Gohman84f90a32010-07-01 20:08:40 +0000101 if (const Argument *A = dyn_cast<Argument>(V))
Richard Osbornea1fffcf2012-11-05 10:48:24 +0000102 if (A->hasByValAttr() || A->hasNoAliasAttr())
Sanjay Patel9613b292016-01-17 23:13:48 +0000103 // Note even if the argument is marked nocapture, we still need to check
Richard Osbornea1fffcf2012-11-05 10:48:24 +0000104 // for copies made inside the function. The nocapture attribute only
105 // specifies that there are no copies made that outlive the function.
Dan Gohman84f90a32010-07-01 20:08:40 +0000106 return !PointerMayBeCaptured(V, false, /*StoreCaptures=*/true);
Richard Osbornea1fffcf2012-11-05 10:48:24 +0000107
Chris Lattnerb35d9b52008-06-16 06:19:11 +0000108 return false;
109}
110
Chandler Carruthc5d81122015-08-06 08:17:06 +0000111/// Returns true if the pointer is one which would have been considered an
112/// escape by isNonEscapingLocalObject.
Dan Gohman84f90a32010-07-01 20:08:40 +0000113static bool isEscapeSource(const Value *V) {
114 if (isa<CallInst>(V) || isa<InvokeInst>(V) || isa<Argument>(V))
115 return true;
Dan Gohman0824aff2010-06-29 00:50:39 +0000116
117 // The load case works because isNonEscapingLocalObject considers all
118 // stores to be escapes (it passes true for the StoreCaptures argument
119 // to PointerMayBeCaptured).
120 if (isa<LoadInst>(V))
121 return true;
122
123 return false;
124}
Chris Lattnerb35d9b52008-06-16 06:19:11 +0000125
Sanjay Patel9613b292016-01-17 23:13:48 +0000126/// Returns the size of the object specified by V or UnknownSize if unknown.
Rafael Espindola5f57f462014-02-21 18:34:28 +0000127static uint64_t getObjectSize(const Value *V, const DataLayout &DL,
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000128 const TargetLibraryInfo &TLI,
Eli Friedman8bc169c2012-02-27 20:46:07 +0000129 bool RoundToAlign = false) {
Nuno Lopes55fff832012-06-21 15:45:28 +0000130 uint64_t Size;
George Burgess IV56c7e882017-03-21 20:08:59 +0000131 ObjectSizeOpts Opts;
132 Opts.RoundToAlign = RoundToAlign;
133 if (getObjectSize(V, Size, DL, &TLI, Opts))
Nuno Lopes55fff832012-06-21 15:45:28 +0000134 return Size;
Chandler Carruthecbd1682015-06-17 07:21:38 +0000135 return MemoryLocation::UnknownSize;
Dan Gohman44da55b2011-01-18 21:16:06 +0000136}
137
Chandler Carruthc5d81122015-08-06 08:17:06 +0000138/// Returns true if we can prove that the object specified by V is smaller than
139/// Size.
Dan Gohman44da55b2011-01-18 21:16:06 +0000140static bool isObjectSmallerThan(const Value *V, uint64_t Size,
Rafael Espindola5f57f462014-02-21 18:34:28 +0000141 const DataLayout &DL,
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000142 const TargetLibraryInfo &TLI) {
Nadav Rotemabcc64f2013-04-09 18:16:05 +0000143 // Note that the meanings of the "object" are slightly different in the
144 // following contexts:
145 // c1: llvm::getObjectSize()
146 // c2: llvm.objectsize() intrinsic
147 // c3: isObjectSmallerThan()
148 // c1 and c2 share the same meaning; however, the meaning of "object" in c3
149 // refers to the "entire object".
150 //
151 // Consider this example:
152 // char *p = (char*)malloc(100)
153 // char *q = p+80;
154 //
155 // In the context of c1 and c2, the "object" pointed by q refers to the
156 // stretch of memory of q[0:19]. So, getObjectSize(q) should return 20.
157 //
158 // However, in the context of c3, the "object" refers to the chunk of memory
159 // being allocated. So, the "object" has 100 bytes, and q points to the middle
160 // the "object". In case q is passed to isObjectSmallerThan() as the 1st
161 // parameter, before the llvm::getObjectSize() is called to get the size of
162 // entire object, we should:
163 // - either rewind the pointer q to the base-address of the object in
164 // question (in this case rewind to p), or
165 // - just give up. It is up to caller to make sure the pointer is pointing
166 // to the base address the object.
Jakub Staszak07f383f2013-08-24 14:16:00 +0000167 //
Nadav Rotemabcc64f2013-04-09 18:16:05 +0000168 // We go for 2nd option for simplicity.
169 if (!isIdentifiedObject(V))
170 return false;
171
Eli Friedman8bc169c2012-02-27 20:46:07 +0000172 // This function needs to use the aligned object size because we allow
173 // reads a bit past the end given sufficient alignment.
Chandler Carruth903c5f92015-08-06 07:57:58 +0000174 uint64_t ObjectSize = getObjectSize(V, DL, TLI, /*RoundToAlign*/ true);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000175
Chandler Carruthecbd1682015-06-17 07:21:38 +0000176 return ObjectSize != MemoryLocation::UnknownSize && ObjectSize < Size;
Dan Gohman44da55b2011-01-18 21:16:06 +0000177}
178
Chandler Carruthc5d81122015-08-06 08:17:06 +0000179/// Returns true if we can prove that the object specified by V has size Size.
Chandler Carruth903c5f92015-08-06 07:57:58 +0000180static bool isObjectSize(const Value *V, uint64_t Size, const DataLayout &DL,
181 const TargetLibraryInfo &TLI) {
Rafael Espindola5f57f462014-02-21 18:34:28 +0000182 uint64_t ObjectSize = getObjectSize(V, DL, TLI);
Chandler Carruthecbd1682015-06-17 07:21:38 +0000183 return ObjectSize != MemoryLocation::UnknownSize && ObjectSize == Size;
Chris Lattner98ad8162008-06-16 06:10:11 +0000184}
185
Chris Lattner2d332972008-06-16 06:30:22 +0000186//===----------------------------------------------------------------------===//
Chris Lattner9f7500f2010-08-18 22:07:29 +0000187// GetElementPtr Instruction Decomposition and Analysis
188//===----------------------------------------------------------------------===//
189
Chandler Carruthc5d81122015-08-06 08:17:06 +0000190/// Analyzes the specified value as a linear expression: "A*V + B", where A and
191/// B are constant integers.
192///
193/// Returns the scale and offset values as APInts and return V as a Value*, and
194/// return whether we looked through any sign or zero extends. The incoming
Sanjay Patel9613b292016-01-17 23:13:48 +0000195/// Value is known to have IntegerType, and it may already be sign or zero
Chandler Carruthc5d81122015-08-06 08:17:06 +0000196/// extended.
Chris Lattner3decde92010-08-18 23:09:49 +0000197///
198/// Note that this looks through extends, so the high bits may not be
199/// represented in the result.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000200/*static*/ const Value *BasicAAResult::GetLinearExpression(
Quentin Colombet5989bc62015-08-31 22:32:47 +0000201 const Value *V, APInt &Scale, APInt &Offset, unsigned &ZExtBits,
202 unsigned &SExtBits, const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000203 AssumptionCache *AC, DominatorTree *DT, bool &NSW, bool &NUW) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000204 assert(V->getType()->isIntegerTy() && "Not an integer value");
205
206 // Limit our recursion depth.
207 if (Depth == 6) {
208 Scale = 1;
209 Offset = 0;
210 return V;
211 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000212
Quentin Colombet5989bc62015-08-31 22:32:47 +0000213 if (const ConstantInt *Const = dyn_cast<ConstantInt>(V)) {
Sanjay Patel9613b292016-01-17 23:13:48 +0000214 // If it's a constant, just convert it to an offset and remove the variable.
215 // If we've been called recursively, the Offset bit width will be greater
Quentin Colombet5989bc62015-08-31 22:32:47 +0000216 // than the constant's (the Offset's always as wide as the outermost call),
217 // so we'll zext here and process any extension in the isa<SExtInst> &
218 // isa<ZExtInst> cases below.
219 Offset += Const->getValue().zextOrSelf(Offset.getBitWidth());
220 assert(Scale == 0 && "Constant values don't have a scale");
221 return V;
222 }
223
224 if (const BinaryOperator *BOp = dyn_cast<BinaryOperator>(V)) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000225 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(BOp->getOperand(1))) {
Quentin Colombet5989bc62015-08-31 22:32:47 +0000226
Sanjay Patel9613b292016-01-17 23:13:48 +0000227 // If we've been called recursively, then Offset and Scale will be wider
228 // than the BOp operands. We'll always zext it here as we'll process sign
Quentin Colombet5989bc62015-08-31 22:32:47 +0000229 // extensions below (see the isa<SExtInst> / isa<ZExtInst> cases).
230 APInt RHS = RHSC->getValue().zextOrSelf(Offset.getBitWidth());
231
Chris Lattner9f7500f2010-08-18 22:07:29 +0000232 switch (BOp->getOpcode()) {
Chandler Carruth903c5f92015-08-06 07:57:58 +0000233 default:
Quentin Colombet5989bc62015-08-31 22:32:47 +0000234 // We don't understand this instruction, so we can't decompose it any
235 // further.
236 Scale = 1;
237 Offset = 0;
238 return V;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000239 case Instruction::Or:
240 // X|C == X+C if all the bits in C are unset in X. Otherwise we can't
241 // analyze it.
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000242 if (!MaskedValueIsZero(BOp->getOperand(0), RHSC->getValue(), DL, 0, AC,
Quentin Colombet5989bc62015-08-31 22:32:47 +0000243 BOp, DT)) {
244 Scale = 1;
245 Offset = 0;
246 return V;
247 }
Justin Bognercd1d5aa2016-08-17 20:30:52 +0000248 LLVM_FALLTHROUGH;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000249 case Instruction::Add:
Quentin Colombet5989bc62015-08-31 22:32:47 +0000250 V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000251 SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000252 Offset += RHS;
253 break;
254 case Instruction::Sub:
255 V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000256 SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000257 Offset -= RHS;
258 break;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000259 case Instruction::Mul:
Quentin Colombet5989bc62015-08-31 22:32:47 +0000260 V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000261 SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000262 Offset *= RHS;
263 Scale *= RHS;
264 break;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000265 case Instruction::Shl:
Quentin Colombet5989bc62015-08-31 22:32:47 +0000266 V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000267 SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000268 Offset <<= RHS.getLimitedValue();
269 Scale <<= RHS.getLimitedValue();
270 // the semantics of nsw and nuw for left shifts don't match those of
271 // multiplications, so we won't propagate them.
272 NSW = NUW = false;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000273 return V;
274 }
Quentin Colombet5989bc62015-08-31 22:32:47 +0000275
276 if (isa<OverflowingBinaryOperator>(BOp)) {
277 NUW &= BOp->hasNoUnsignedWrap();
278 NSW &= BOp->hasNoSignedWrap();
279 }
280 return V;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000281 }
282 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000283
Chris Lattner9f7500f2010-08-18 22:07:29 +0000284 // Since GEP indices are sign extended anyway, we don't care about the high
Chris Lattner3decde92010-08-18 23:09:49 +0000285 // bits of a sign or zero extended value - just scales and offsets. The
286 // extensions have to be consistent though.
Quentin Colombet5989bc62015-08-31 22:32:47 +0000287 if (isa<SExtInst>(V) || isa<ZExtInst>(V)) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000288 Value *CastOp = cast<CastInst>(V)->getOperand(0);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000289 unsigned NewWidth = V->getType()->getPrimitiveSizeInBits();
Chris Lattner9f7500f2010-08-18 22:07:29 +0000290 unsigned SmallWidth = CastOp->getType()->getPrimitiveSizeInBits();
Quentin Colombet5989bc62015-08-31 22:32:47 +0000291 unsigned OldZExtBits = ZExtBits, OldSExtBits = SExtBits;
292 const Value *Result =
293 GetLinearExpression(CastOp, Scale, Offset, ZExtBits, SExtBits, DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000294 Depth + 1, AC, DT, NSW, NUW);
Chris Lattner3decde92010-08-18 23:09:49 +0000295
Simon Pilgrimf2fbf432016-11-20 13:47:59 +0000296 // zext(zext(%x)) == zext(%x), and similarly for sext; we'll handle this
Quentin Colombet5989bc62015-08-31 22:32:47 +0000297 // by just incrementing the number of bits we've extended by.
298 unsigned ExtendedBy = NewWidth - SmallWidth;
299
300 if (isa<SExtInst>(V) && ZExtBits == 0) {
301 // sext(sext(%x, a), b) == sext(%x, a + b)
302
303 if (NSW) {
304 // We haven't sign-wrapped, so it's valid to decompose sext(%x + c)
305 // into sext(%x) + sext(c). We'll sext the Offset ourselves:
306 unsigned OldWidth = Offset.getBitWidth();
307 Offset = Offset.trunc(SmallWidth).sext(NewWidth).zextOrSelf(OldWidth);
308 } else {
309 // We may have signed-wrapped, so don't decompose sext(%x + c) into
310 // sext(%x) + sext(c)
311 Scale = 1;
312 Offset = 0;
313 Result = CastOp;
314 ZExtBits = OldZExtBits;
315 SExtBits = OldSExtBits;
316 }
317 SExtBits += ExtendedBy;
318 } else {
319 // sext(zext(%x, a), b) = zext(zext(%x, a), b) = zext(%x, a + b)
320
321 if (!NUW) {
322 // We may have unsigned-wrapped, so don't decompose zext(%x + c) into
323 // zext(%x) + zext(c)
324 Scale = 1;
325 Offset = 0;
326 Result = CastOp;
327 ZExtBits = OldZExtBits;
328 SExtBits = OldSExtBits;
329 }
330 ZExtBits += ExtendedBy;
331 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000332
Chris Lattner9f7500f2010-08-18 22:07:29 +0000333 return Result;
334 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000335
Chris Lattner9f7500f2010-08-18 22:07:29 +0000336 Scale = 1;
337 Offset = 0;
338 return V;
339}
340
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000341/// To ensure a pointer offset fits in an integer of size PointerSize
342/// (in bits) when that size is smaller than 64. This is an issue in
343/// particular for 32b programs with negative indices that rely on two's
Gerolf Hoflehnerd24671f2016-01-30 05:58:38 +0000344/// complement wrap-arounds for precise alias information.
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000345static int64_t adjustToPointerSize(int64_t Offset, unsigned PointerSize) {
346 assert(PointerSize <= 64 && "Invalid PointerSize!");
347 unsigned ShiftBits = 64 - PointerSize;
Gerolf Hoflehner73fc84b2016-01-30 05:35:09 +0000348 return (int64_t)((uint64_t)Offset << ShiftBits) >> ShiftBits;
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000349}
350
Chandler Carruthc5d81122015-08-06 08:17:06 +0000351/// If V is a symbolic pointer expression, decompose it into a base pointer
352/// with a constant offset and a number of scaled symbolic offsets.
Chris Lattner9f7500f2010-08-18 22:07:29 +0000353///
Chandler Carruthc5d81122015-08-06 08:17:06 +0000354/// The scaled symbolic offsets (represented by pairs of a Value* and a scale
355/// in the VarIndices vector) are Value*'s that are known to be scaled by the
356/// specified amount, but which may have other unrepresented high bits. As
357/// such, the gep cannot necessarily be reconstructed from its decomposed form.
Chris Lattner9f7500f2010-08-18 22:07:29 +0000358///
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000359/// When DataLayout is around, this function is capable of analyzing everything
Arnold Schwaighofer1a444482014-03-26 21:30:19 +0000360/// that GetUnderlyingObject can look through. To be able to do that
361/// GetUnderlyingObject and DecomposeGEPExpression must use the same search
Chandler Carruthc5d81122015-08-06 08:17:06 +0000362/// depth (MaxLookupSearchDepth). When DataLayout not is around, it just looks
363/// through pointer casts.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000364bool BasicAAResult::DecomposeGEPExpression(const Value *V,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000365 DecomposedGEP &Decomposed, const DataLayout &DL, AssumptionCache *AC,
Michael Kuperstein82069c42016-05-25 22:23:08 +0000366 DominatorTree *DT) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000367 // Limit recursion depth to limit compile time in crazy cases.
Arnold Schwaighofer1a444482014-03-26 21:30:19 +0000368 unsigned MaxLookup = MaxLookupSearchDepth;
Wei Mid67daae2015-08-05 23:40:30 +0000369 SearchTimes++;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000370
Michael Kuperstein82069c42016-05-25 22:23:08 +0000371 Decomposed.StructOffset = 0;
372 Decomposed.OtherOffset = 0;
373 Decomposed.VarIndices.clear();
Chris Lattner9f7500f2010-08-18 22:07:29 +0000374 do {
375 // See if this is a bitcast or GEP.
376 const Operator *Op = dyn_cast<Operator>(V);
Craig Topper9f008862014-04-15 04:59:12 +0000377 if (!Op) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000378 // The only non-operator case we can handle are GlobalAliases.
379 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +0000380 if (!GA->isInterposable()) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000381 V = GA->getAliasee();
382 continue;
383 }
384 }
Michael Kuperstein82069c42016-05-25 22:23:08 +0000385 Decomposed.Base = V;
386 return false;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000387 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000388
Matt Arsenault70f4db882014-07-15 00:56:40 +0000389 if (Op->getOpcode() == Instruction::BitCast ||
390 Op->getOpcode() == Instruction::AddrSpaceCast) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000391 V = Op->getOperand(0);
392 continue;
393 }
Dan Gohman05b18f12010-12-15 20:49:55 +0000394
Chris Lattner9f7500f2010-08-18 22:07:29 +0000395 const GEPOperator *GEPOp = dyn_cast<GEPOperator>(Op);
Craig Topper9f008862014-04-15 04:59:12 +0000396 if (!GEPOp) {
Hal Finkel5c12d8f2016-07-11 01:32:20 +0000397 if (auto CS = ImmutableCallSite(V))
398 if (const Value *RV = CS.getReturnedArgOperand()) {
399 V = RV;
400 continue;
401 }
402
Dan Gohman0573b552011-05-24 18:24:08 +0000403 // If it's not a GEP, hand it off to SimplifyInstruction to see if it
404 // can come up with something. This matches what GetUnderlyingObject does.
405 if (const Instruction *I = dyn_cast<Instruction>(V))
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000406 // TODO: Get a DominatorTree and AssumptionCache and use them here
407 // (these are both now available in this function, but this should be
408 // updated when GetUnderlyingObject is updated). TLI should be
409 // provided also.
Dan Gohman0573b552011-05-24 18:24:08 +0000410 if (const Value *Simplified =
Chandler Carruth903c5f92015-08-06 07:57:58 +0000411 SimplifyInstruction(const_cast<Instruction *>(I), DL)) {
Dan Gohman0573b552011-05-24 18:24:08 +0000412 V = Simplified;
413 continue;
414 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000415
Michael Kuperstein82069c42016-05-25 22:23:08 +0000416 Decomposed.Base = V;
417 return false;
Dan Gohman0573b552011-05-24 18:24:08 +0000418 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000419
Chris Lattner9f7500f2010-08-18 22:07:29 +0000420 // Don't attempt to analyze GEPs over unsized objects.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000421 if (!GEPOp->getSourceElementType()->isSized()) {
422 Decomposed.Base = V;
423 return false;
424 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000425
Matt Arsenaulta8fe22b2013-11-16 00:36:43 +0000426 unsigned AS = GEPOp->getPointerAddressSpace();
Chris Lattner9f7500f2010-08-18 22:07:29 +0000427 // Walk the indices of the GEP, accumulating them into BaseOff/VarIndices.
428 gep_type_iterator GTI = gep_type_begin(GEPOp);
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000429 unsigned PointerSize = DL.getPointerSizeInBits(AS);
Gerolf Hoflehner9e2afa82016-10-22 02:41:39 +0000430 // Assume all GEP operands are constants until proven otherwise.
431 bool GepHasConstantOffset = true;
Chandler Carruth903c5f92015-08-06 07:57:58 +0000432 for (User::const_op_iterator I = GEPOp->op_begin() + 1, E = GEPOp->op_end();
Peter Collingbourneab85225b2016-12-02 02:24:42 +0000433 I != E; ++I, ++GTI) {
Quentin Colombet5989bc62015-08-31 22:32:47 +0000434 const Value *Index = *I;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000435 // Compute the (potentially symbolic) offset in bytes for this index.
Peter Collingbourneab85225b2016-12-02 02:24:42 +0000436 if (StructType *STy = GTI.getStructTypeOrNull()) {
Chris Lattner9f7500f2010-08-18 22:07:29 +0000437 // For a struct, add the member offset.
438 unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
Chandler Carruth903c5f92015-08-06 07:57:58 +0000439 if (FieldNo == 0)
440 continue;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000441
Michael Kuperstein82069c42016-05-25 22:23:08 +0000442 Decomposed.StructOffset +=
443 DL.getStructLayout(STy)->getElementOffset(FieldNo);
Chris Lattner9f7500f2010-08-18 22:07:29 +0000444 continue;
445 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000446
Chris Lattner9f7500f2010-08-18 22:07:29 +0000447 // For an array/pointer, add the element offset, explicitly scaled.
Quentin Colombet5989bc62015-08-31 22:32:47 +0000448 if (const ConstantInt *CIdx = dyn_cast<ConstantInt>(Index)) {
Chandler Carruth903c5f92015-08-06 07:57:58 +0000449 if (CIdx->isZero())
450 continue;
Michael Kuperstein82069c42016-05-25 22:23:08 +0000451 Decomposed.OtherOffset +=
Peter Collingbourneab85225b2016-12-02 02:24:42 +0000452 DL.getTypeAllocSize(GTI.getIndexedType()) * CIdx->getSExtValue();
Chris Lattner9f7500f2010-08-18 22:07:29 +0000453 continue;
454 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000455
Gerolf Hoflehner9e2afa82016-10-22 02:41:39 +0000456 GepHasConstantOffset = false;
457
Peter Collingbourneab85225b2016-12-02 02:24:42 +0000458 uint64_t Scale = DL.getTypeAllocSize(GTI.getIndexedType());
Quentin Colombet5989bc62015-08-31 22:32:47 +0000459 unsigned ZExtBits = 0, SExtBits = 0;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000460
Chris Lattner3decde92010-08-18 23:09:49 +0000461 // If the integer type is smaller than the pointer size, it is implicitly
462 // sign extended to pointer size.
Matt Arsenaultfa252722013-09-27 22:18:51 +0000463 unsigned Width = Index->getType()->getIntegerBitWidth();
Quentin Colombet5989bc62015-08-31 22:32:47 +0000464 if (PointerSize > Width)
465 SExtBits += PointerSize - Width;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000466
Chris Lattner3decde92010-08-18 23:09:49 +0000467 // Use GetLinearExpression to decompose the index into a C1*V+C2 form.
Chris Lattner9f7500f2010-08-18 22:07:29 +0000468 APInt IndexScale(Width, 0), IndexOffset(Width, 0);
Quentin Colombet5989bc62015-08-31 22:32:47 +0000469 bool NSW = true, NUW = true;
470 Index = GetLinearExpression(Index, IndexScale, IndexOffset, ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000471 SExtBits, DL, 0, AC, DT, NSW, NUW);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000472
Chris Lattner9f7500f2010-08-18 22:07:29 +0000473 // The GEP index scale ("Scale") scales C1*V+C2, yielding (C1*V+C2)*Scale.
474 // This gives us an aggregate computation of (C1*Scale)*V + C2*Scale.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000475 Decomposed.OtherOffset += IndexOffset.getSExtValue() * Scale;
Eli Friedmanab3a1282010-09-15 20:08:03 +0000476 Scale *= IndexScale.getSExtValue();
Jakub Staszak07f383f2013-08-24 14:16:00 +0000477
Chris Lattner0ab5e2c2011-04-15 05:18:47 +0000478 // If we already had an occurrence of this index variable, merge this
Chris Lattner9f7500f2010-08-18 22:07:29 +0000479 // scale into it. For example, we want to handle:
480 // A[x][x] -> x*16 + x*4 -> x*20
481 // This also ensures that 'x' only appears in the index list once.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000482 for (unsigned i = 0, e = Decomposed.VarIndices.size(); i != e; ++i) {
Gerolf Hoflehner9e2afa82016-10-22 02:41:39 +0000483 if (Decomposed.VarIndices[i].V == Index &&
Michael Kuperstein82069c42016-05-25 22:23:08 +0000484 Decomposed.VarIndices[i].ZExtBits == ZExtBits &&
485 Decomposed.VarIndices[i].SExtBits == SExtBits) {
486 Scale += Decomposed.VarIndices[i].Scale;
487 Decomposed.VarIndices.erase(Decomposed.VarIndices.begin() + i);
Chris Lattner9f7500f2010-08-18 22:07:29 +0000488 break;
489 }
490 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000491
Chris Lattner9f7500f2010-08-18 22:07:29 +0000492 // Make sure that we have a scale that makes sense for this target's
493 // pointer size.
Gerolf Hoflehner1d1fbb52016-01-30 02:42:11 +0000494 Scale = adjustToPointerSize(Scale, PointerSize);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000495
Chris Lattner1b9c3872010-08-18 22:47:56 +0000496 if (Scale) {
Quentin Colombet5989bc62015-08-31 22:32:47 +0000497 VariableGEPIndex Entry = {Index, ZExtBits, SExtBits,
Jeffrey Yasskin6381c012011-07-27 06:22:51 +0000498 static_cast<int64_t>(Scale)};
Michael Kuperstein82069c42016-05-25 22:23:08 +0000499 Decomposed.VarIndices.push_back(Entry);
Chris Lattner1b9c3872010-08-18 22:47:56 +0000500 }
Chris Lattner9f7500f2010-08-18 22:07:29 +0000501 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000502
Gerolf Hoflehner87ddb652016-01-30 05:52:53 +0000503 // Take care of wrap-arounds
Gerolf Hoflehner9e2afa82016-10-22 02:41:39 +0000504 if (GepHasConstantOffset) {
505 Decomposed.StructOffset =
506 adjustToPointerSize(Decomposed.StructOffset, PointerSize);
507 Decomposed.OtherOffset =
508 adjustToPointerSize(Decomposed.OtherOffset, PointerSize);
509 }
Gerolf Hoflehner87ddb652016-01-30 05:52:53 +0000510
Chris Lattner9f7500f2010-08-18 22:07:29 +0000511 // Analyze the base pointer next.
512 V = GEPOp->getOperand(0);
513 } while (--MaxLookup);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000514
Chris Lattner9f7500f2010-08-18 22:07:29 +0000515 // If the chain of expressions is too deep, just return early.
Michael Kuperstein82069c42016-05-25 22:23:08 +0000516 Decomposed.Base = V;
Wei Mid67daae2015-08-05 23:40:30 +0000517 SearchLimitReached++;
Michael Kuperstein82069c42016-05-25 22:23:08 +0000518 return true;
Chris Lattner9f7500f2010-08-18 22:07:29 +0000519}
520
Chandler Carruthc5d81122015-08-06 08:17:06 +0000521/// Returns whether the given pointer value points to memory that is local to
522/// the function, with global constants being considered local to all
523/// functions.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000524bool BasicAAResult::pointsToConstantMemory(const MemoryLocation &Loc,
525 bool OrLocal) {
Dan Gohman9130bad2010-11-08 16:45:26 +0000526 assert(Visited.empty() && "Visited must be cleared after use!");
Chris Lattner2d332972008-06-16 06:30:22 +0000527
Dan Gohman142ff822010-11-08 20:26:19 +0000528 unsigned MaxLookup = 8;
Dan Gohman9130bad2010-11-08 16:45:26 +0000529 SmallVector<const Value *, 16> Worklist;
530 Worklist.push_back(Loc.Ptr);
531 do {
Chandler Carruth7b560d42015-09-09 17:55:00 +0000532 const Value *V = GetUnderlyingObject(Worklist.pop_back_val(), DL);
David Blaikie70573dc2014-11-19 07:49:26 +0000533 if (!Visited.insert(V).second) {
Dan Gohman9130bad2010-11-08 16:45:26 +0000534 Visited.clear();
Chandler Carruth7b560d42015-09-09 17:55:00 +0000535 return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
Dan Gohman9130bad2010-11-08 16:45:26 +0000536 }
Dan Gohman5f1702e2010-08-06 01:25:49 +0000537
Dan Gohman9130bad2010-11-08 16:45:26 +0000538 // An alloca instruction defines local memory.
539 if (OrLocal && isa<AllocaInst>(V))
540 continue;
541
542 // A global constant counts as local memory for our purposes.
543 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
544 // Note: this doesn't require GV to be "ODR" because it isn't legal for a
545 // global to be marked constant in some modules and non-constant in
546 // others. GV may even be a declaration, not a definition.
547 if (!GV->isConstant()) {
548 Visited.clear();
Chandler Carruth7b560d42015-09-09 17:55:00 +0000549 return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
Dan Gohman9130bad2010-11-08 16:45:26 +0000550 }
551 continue;
552 }
553
554 // If both select values point to local memory, then so does the select.
555 if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
556 Worklist.push_back(SI->getTrueValue());
557 Worklist.push_back(SI->getFalseValue());
558 continue;
559 }
560
561 // If all values incoming to a phi node point to local memory, then so does
562 // the phi.
563 if (const PHINode *PN = dyn_cast<PHINode>(V)) {
Dan Gohman142ff822010-11-08 20:26:19 +0000564 // Don't bother inspecting phi nodes with many operands.
565 if (PN->getNumIncomingValues() > MaxLookup) {
566 Visited.clear();
Chandler Carruth7b560d42015-09-09 17:55:00 +0000567 return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
Dan Gohman142ff822010-11-08 20:26:19 +0000568 }
Pete Cooper833f34d2015-05-12 20:05:31 +0000569 for (Value *IncValue : PN->incoming_values())
570 Worklist.push_back(IncValue);
Dan Gohman9130bad2010-11-08 16:45:26 +0000571 continue;
572 }
573
574 // Otherwise be conservative.
575 Visited.clear();
Chandler Carruth7b560d42015-09-09 17:55:00 +0000576 return AAResultBase::pointsToConstantMemory(Loc, OrLocal);
Dan Gohman9130bad2010-11-08 16:45:26 +0000577
Dan Gohman142ff822010-11-08 20:26:19 +0000578 } while (!Worklist.empty() && --MaxLookup);
Dan Gohman9130bad2010-11-08 16:45:26 +0000579
580 Visited.clear();
Dan Gohman142ff822010-11-08 20:26:19 +0000581 return Worklist.empty();
Chris Lattner2d332972008-06-16 06:30:22 +0000582}
583
Chandler Carruthc5d81122015-08-06 08:17:06 +0000584/// Returns the behavior when calling the given call site.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000585FunctionModRefBehavior BasicAAResult::getModRefBehavior(ImmutableCallSite CS) {
Dan Gohman5f1702e2010-08-06 01:25:49 +0000586 if (CS.doesNotAccessMemory())
587 // Can't do better than this.
Chandler Carruth194f59c2015-07-22 23:15:57 +0000588 return FMRB_DoesNotAccessMemory;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000589
Chandler Carruth194f59c2015-07-22 23:15:57 +0000590 FunctionModRefBehavior Min = FMRB_UnknownModRefBehavior;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000591
592 // If the callsite knows it only reads memory, don't return worse
593 // than that.
594 if (CS.onlyReadsMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000595 Min = FMRB_OnlyReadsMemory;
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000596 else if (CS.doesNotReadMemory())
597 Min = FMRB_DoesNotReadMemory;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000598
Igor Laevsky39d662f2015-07-11 10:30:36 +0000599 if (CS.onlyAccessesArgMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000600 Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesArgumentPointees);
Igor Laevsky39d662f2015-07-11 10:30:36 +0000601
Chandler Carruth12884f72016-03-02 15:56:53 +0000602 // If CS has operand bundles then aliasing attributes from the function it
603 // calls do not directly apply to the CallSite. This can be made more
604 // precise in the future.
605 if (!CS.hasOperandBundles())
606 if (const Function *F = CS.getCalledFunction())
607 Min =
608 FunctionModRefBehavior(Min & getBestAAResults().getModRefBehavior(F));
609
610 return Min;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000611}
612
Chandler Carruthc5d81122015-08-06 08:17:06 +0000613/// Returns the behavior when calling the given function. For use when the call
614/// site is not known.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000615FunctionModRefBehavior BasicAAResult::getModRefBehavior(const Function *F) {
Dan Gohmane461d7d2010-11-08 16:08:43 +0000616 // If the function declares it doesn't access memory, we can't do better.
Dan Gohman5f1702e2010-08-06 01:25:49 +0000617 if (F->doesNotAccessMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000618 return FMRB_DoesNotAccessMemory;
Dan Gohmane461d7d2010-11-08 16:08:43 +0000619
Chandler Carruth194f59c2015-07-22 23:15:57 +0000620 FunctionModRefBehavior Min = FMRB_UnknownModRefBehavior;
Dan Gohman2694e142010-11-10 01:02:18 +0000621
Dan Gohmane461d7d2010-11-08 16:08:43 +0000622 // If the function declares it only reads memory, go with that.
Dan Gohman5f1702e2010-08-06 01:25:49 +0000623 if (F->onlyReadsMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000624 Min = FMRB_OnlyReadsMemory;
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000625 else if (F->doesNotReadMemory())
626 Min = FMRB_DoesNotReadMemory;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000627
Igor Laevsky39d662f2015-07-11 10:30:36 +0000628 if (F->onlyAccessesArgMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000629 Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesArgumentPointees);
Andrew Kaylor9604f342016-11-08 21:07:42 +0000630 else if (F->onlyAccessesInaccessibleMemory())
631 Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesInaccessibleMem);
632 else if (F->onlyAccessesInaccessibleMemOrArgMem())
633 Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesInaccessibleOrArgMem);
Igor Laevsky39d662f2015-07-11 10:30:36 +0000634
Chandler Carruth12884f72016-03-02 15:56:53 +0000635 return Min;
Dan Gohman5f1702e2010-08-06 01:25:49 +0000636}
Owen Anderson98a36172009-02-05 23:36:27 +0000637
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000638/// Returns true if this is a writeonly (i.e Mod only) parameter.
Philip Reamesfe46cad2016-01-06 18:10:35 +0000639static bool isWriteOnlyParam(ImmutableCallSite CS, unsigned ArgIdx,
640 const TargetLibraryInfo &TLI) {
Reid Klecknerfb502d22017-04-14 20:19:02 +0000641 if (CS.paramHasAttr(ArgIdx, Attribute::WriteOnly))
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000642 return true;
Hal Finkel354e23b2014-07-17 01:28:25 +0000643
644 // We can bound the aliasing properties of memset_pattern16 just as we can
645 // for memcpy/memset. This is particularly important because the
646 // LoopIdiomRecognizer likes to turn loops into calls to memset_pattern16
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000647 // whenever possible.
648 // FIXME Consider handling this in InferFunctionAttr.cpp together with other
649 // attributes.
David L. Jonesd21529f2017-01-23 23:16:46 +0000650 LibFunc F;
Ahmed Bougachad765a822016-04-27 19:04:35 +0000651 if (CS.getCalledFunction() && TLI.getLibFunc(*CS.getCalledFunction(), F) &&
David L. Jonesd21529f2017-01-23 23:16:46 +0000652 F == LibFunc_memset_pattern16 && TLI.has(F))
Philip Reamesae050a52016-01-06 04:53:16 +0000653 if (ArgIdx == 0)
Philip Reamesfe46cad2016-01-06 18:10:35 +0000654 return true;
655
656 // TODO: memset_pattern4, memset_pattern8
657 // TODO: _chk variants
658 // TODO: strcmp, strcpy
659
660 return false;
661}
662
663ModRefInfo BasicAAResult::getArgModRefInfo(ImmutableCallSite CS,
664 unsigned ArgIdx) {
665
Nicolai Haehnle84c9f992016-07-04 08:01:29 +0000666 // Checking for known builtin intrinsics and target library functions.
Philip Reamesfe46cad2016-01-06 18:10:35 +0000667 if (isWriteOnlyParam(CS, ArgIdx, TLI))
668 return MRI_Mod;
Hal Finkel354e23b2014-07-17 01:28:25 +0000669
Reid Klecknerfb502d22017-04-14 20:19:02 +0000670 if (CS.paramHasAttr(ArgIdx, Attribute::ReadOnly))
Igor Laevsky36e84c02015-10-28 16:42:00 +0000671 return MRI_Ref;
672
Reid Klecknerfb502d22017-04-14 20:19:02 +0000673 if (CS.paramHasAttr(ArgIdx, Attribute::ReadNone))
Igor Laevsky559d1702015-10-28 17:54:48 +0000674 return MRI_NoModRef;
675
Chandler Carruth7b560d42015-09-09 17:55:00 +0000676 return AAResultBase::getArgModRefInfo(CS, ArgIdx);
Hal Finkel354e23b2014-07-17 01:28:25 +0000677}
678
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000679static bool isIntrinsicCall(ImmutableCallSite CS, Intrinsic::ID IID) {
Hal Finkel93046912014-07-25 21:13:35 +0000680 const IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction());
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000681 return II && II->getIntrinsicID() == IID;
Hal Finkel93046912014-07-25 21:13:35 +0000682}
683
Justin Bognerabdcb3c2015-09-24 05:29:31 +0000684#ifndef NDEBUG
Justin Bogner49655f82015-09-24 04:59:24 +0000685static const Function *getParent(const Value *V) {
686 if (const Instruction *inst = dyn_cast<Instruction>(V))
687 return inst->getParent()->getParent();
688
689 if (const Argument *arg = dyn_cast<Argument>(V))
690 return arg->getParent();
691
692 return nullptr;
693}
694
695static bool notDifferentParent(const Value *O1, const Value *O2) {
696
697 const Function *F1 = getParent(O1);
698 const Function *F2 = getParent(O2);
699
700 return !F1 || !F2 || F1 == F2;
701}
Justin Bognerabdcb3c2015-09-24 05:29:31 +0000702#endif
Justin Bogner49655f82015-09-24 04:59:24 +0000703
704AliasResult BasicAAResult::alias(const MemoryLocation &LocA,
705 const MemoryLocation &LocB) {
706 assert(notDifferentParent(LocA.Ptr, LocB.Ptr) &&
707 "BasicAliasAnalysis doesn't support interprocedural queries.");
708
709 // If we have a directly cached entry for these locations, we have recursed
710 // through this once, so just return the cached results. Notably, when this
711 // happens, we don't clear the cache.
712 auto CacheIt = AliasCache.find(LocPair(LocA, LocB));
713 if (CacheIt != AliasCache.end())
714 return CacheIt->second;
715
716 AliasResult Alias = aliasCheck(LocA.Ptr, LocA.Size, LocA.AATags, LocB.Ptr,
717 LocB.Size, LocB.AATags);
718 // AliasCache rarely has more than 1 or 2 elements, always use
719 // shrink_and_clear so it quickly returns to the inline capacity of the
720 // SmallDenseMap if it ever grows larger.
721 // FIXME: This should really be shrink_to_inline_capacity_and_clear().
722 AliasCache.shrink_and_clear();
723 VisitedPhiBBs.clear();
724 return Alias;
725}
726
Chandler Carruthc5d81122015-08-06 08:17:06 +0000727/// Checks to see if the specified callsite can clobber the specified memory
728/// object.
729///
730/// Since we only look at local properties of this function, we really can't
731/// say much about this query. We do, however, use simple "address taken"
732/// analysis on local objects.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000733ModRefInfo BasicAAResult::getModRefInfo(ImmutableCallSite CS,
734 const MemoryLocation &Loc) {
Dan Gohman41f14cf2010-09-14 21:25:10 +0000735 assert(notDifferentParent(CS.getInstruction(), Loc.Ptr) &&
Dan Gohman00ef9322010-07-07 14:27:09 +0000736 "AliasAnalysis query involving multiple functions!");
737
Chandler Carruth7b560d42015-09-09 17:55:00 +0000738 const Value *Object = GetUnderlyingObject(Loc.Ptr, DL);
Jakub Staszak07f383f2013-08-24 14:16:00 +0000739
Dan Gohman41f14cf2010-09-14 21:25:10 +0000740 // If this is a tail call and Loc.Ptr points to a stack location, we know that
Chris Lattnerd6a49ad2009-11-22 16:05:05 +0000741 // the tail call cannot access or modify the local stack.
742 // We cannot exclude byval arguments here; these belong to the caller of
743 // the current function not to the current function, and a tail callee
744 // may reference them.
745 if (isa<AllocaInst>(Object))
Dan Gohman5442c712010-08-03 21:48:53 +0000746 if (const CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
Chris Lattnerd6a49ad2009-11-22 16:05:05 +0000747 if (CI->isTailCall())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000748 return MRI_NoModRef;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000749
Chris Lattnerd6a49ad2009-11-22 16:05:05 +0000750 // If the pointer is to a locally allocated object that does not escape,
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000751 // then the call can not mod/ref the pointer unless the call takes the pointer
752 // as an argument, and itself doesn't capture it.
Chris Lattner1e7b37e2009-11-23 16:46:41 +0000753 if (!isa<Constant>(Object) && CS.getInstruction() != Object &&
Dan Gohman84f90a32010-07-01 20:08:40 +0000754 isNonEscapingLocalObject(Object)) {
Igor Laevsky37cba432017-03-01 13:19:51 +0000755
756 // Optimistically assume that call doesn't touch Object and check this
757 // assumption in the following loop.
758 ModRefInfo Result = MRI_NoModRef;
759
Igor Laevsky28eeb3f2016-01-16 12:15:53 +0000760 unsigned OperandNo = 0;
761 for (auto CI = CS.data_operands_begin(), CE = CS.data_operands_end();
762 CI != CE; ++CI, ++OperandNo) {
Chris Lattner026f5e62011-05-23 05:15:43 +0000763 // Only look at the no-capture or byval pointer arguments. If this
764 // pointer were passed to arguments that were neither of these, then it
765 // couldn't be no-capture.
Duncan Sands19d0b472010-02-16 11:11:14 +0000766 if (!(*CI)->getType()->isPointerTy() ||
Hal Finkel39fed392016-12-15 05:09:15 +0000767 (!CS.doesNotCapture(OperandNo) &&
768 OperandNo < CS.getNumArgOperands() && !CS.isByValArgument(OperandNo)))
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000769 continue;
Jakub Staszak07f383f2013-08-24 14:16:00 +0000770
Igor Laevsky37cba432017-03-01 13:19:51 +0000771 // Call doesn't access memory through this operand, so we don't care
772 // if it aliases with Object.
773 if (CS.doesNotAccessMemory(OperandNo))
774 continue;
775
Dan Gohman41f14cf2010-09-14 21:25:10 +0000776 // If this is a no-capture pointer argument, see if we can tell that it
Igor Laevsky37cba432017-03-01 13:19:51 +0000777 // is impossible to alias the pointer we're checking.
Chandler Carruth7b560d42015-09-09 17:55:00 +0000778 AliasResult AR =
779 getBestAAResults().alias(MemoryLocation(*CI), MemoryLocation(Object));
Igor Laevsky37cba432017-03-01 13:19:51 +0000780
781 // Operand doesnt alias 'Object', continue looking for other aliases
782 if (AR == NoAlias)
783 continue;
784 // Operand aliases 'Object', but call doesn't modify it. Strengthen
785 // initial assumption and keep looking in case if there are more aliases.
786 if (CS.onlyReadsMemory(OperandNo)) {
787 Result = static_cast<ModRefInfo>(Result | MRI_Ref);
788 continue;
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000789 }
Igor Laevsky37cba432017-03-01 13:19:51 +0000790 // Operand aliases 'Object' but call only writes into it.
791 if (CS.doesNotReadMemory(OperandNo)) {
792 Result = static_cast<ModRefInfo>(Result | MRI_Mod);
793 continue;
794 }
795 // This operand aliases 'Object' and call reads and writes into it.
796 Result = MRI_ModRef;
797 break;
Chris Lattner84ed59ab2009-11-23 16:44:43 +0000798 }
Jakub Staszak07f383f2013-08-24 14:16:00 +0000799
Igor Laevsky37cba432017-03-01 13:19:51 +0000800 // Early return if we improved mod ref information
801 if (Result != MRI_ModRef)
802 return Result;
Chris Lattnerd6a49ad2009-11-22 16:05:05 +0000803 }
804
Philip Reamesd9f4a3d2016-03-09 23:19:56 +0000805 // If the CallSite is to malloc or calloc, we can assume that it doesn't
806 // modify any IR visible value. This is only valid because we assume these
807 // routines do not read values visible in the IR. TODO: Consider special
808 // casing realloc and strdup routines which access only their arguments as
809 // well. Or alternatively, replace all of this with inaccessiblememonly once
810 // that's implemented fully.
811 auto *Inst = CS.getInstruction();
Craig Topper09bb7602017-04-18 21:43:46 +0000812 if (isMallocOrCallocLikeFn(Inst, &TLI)) {
Philip Reamesd9f4a3d2016-03-09 23:19:56 +0000813 // Be conservative if the accessed pointer may alias the allocation -
814 // fallback to the generic handling below.
815 if (getBestAAResults().alias(MemoryLocation(Inst), Loc) == NoAlias)
816 return MRI_NoModRef;
817 }
818
Bryant Wonga07d9b12016-12-25 22:42:27 +0000819 // The semantics of memcpy intrinsics forbid overlap between their respective
820 // operands, i.e., source and destination of any given memcpy must no-alias.
821 // If Loc must-aliases either one of these two locations, then it necessarily
822 // no-aliases the other.
823 if (auto *Inst = dyn_cast<MemCpyInst>(CS.getInstruction())) {
824 AliasResult SrcAA, DestAA;
825
826 if ((SrcAA = getBestAAResults().alias(MemoryLocation::getForSource(Inst),
827 Loc)) == MustAlias)
828 // Loc is exactly the memcpy source thus disjoint from memcpy dest.
829 return MRI_Ref;
830 if ((DestAA = getBestAAResults().alias(MemoryLocation::getForDest(Inst),
831 Loc)) == MustAlias)
832 // The converse case.
833 return MRI_Mod;
834
835 // It's also possible for Loc to alias both src and dest, or neither.
836 ModRefInfo rv = MRI_NoModRef;
837 if (SrcAA != NoAlias)
838 rv = static_cast<ModRefInfo>(rv | MRI_Ref);
839 if (DestAA != NoAlias)
840 rv = static_cast<ModRefInfo>(rv | MRI_Mod);
841 return rv;
842 }
843
Hal Finkel93046912014-07-25 21:13:35 +0000844 // While the assume intrinsic is marked as arbitrarily writing so that
845 // proper control dependencies will be maintained, it never aliases any
846 // particular memory location.
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000847 if (isIntrinsicCall(CS, Intrinsic::assume))
Chandler Carruth194f59c2015-07-22 23:15:57 +0000848 return MRI_NoModRef;
Hal Finkel93046912014-07-25 21:13:35 +0000849
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000850 // Like assumes, guard intrinsics are also marked as arbitrarily writing so
851 // that proper control dependencies are maintained but they never mods any
852 // particular memory location.
853 //
854 // *Unlike* assumes, guard intrinsics are modeled as reading memory since the
855 // heap state at the point the guard is issued needs to be consistent in case
856 // the guard invokes the "deopt" continuation.
857 if (isIntrinsicCall(CS, Intrinsic::experimental_guard))
858 return MRI_Ref;
859
Anna Thomas037e5402016-08-09 17:18:05 +0000860 // Like assumes, invariant.start intrinsics were also marked as arbitrarily
861 // writing so that proper control dependencies are maintained but they never
862 // mod any particular memory location visible to the IR.
863 // *Unlike* assumes (which are now modeled as NoModRef), invariant.start
864 // intrinsic is now modeled as reading memory. This prevents hoisting the
865 // invariant.start intrinsic over stores. Consider:
866 // *ptr = 40;
867 // *ptr = 50;
868 // invariant_start(ptr)
869 // int val = *ptr;
870 // print(val);
871 //
872 // This cannot be transformed to:
873 //
874 // *ptr = 40;
875 // invariant_start(ptr)
876 // *ptr = 50;
877 // int val = *ptr;
878 // print(val);
879 //
880 // The transformation will cause the second store to be ignored (based on
881 // rules of invariant.start) and print 40, while the first program always
882 // prints 50.
883 if (isIntrinsicCall(CS, Intrinsic::invariant_start))
884 return MRI_Ref;
885
Chandler Carruth7b560d42015-09-09 17:55:00 +0000886 // The AAResultBase base class has some smarts, lets use them.
887 return AAResultBase::getModRefInfo(CS, Loc);
Dan Gohman64d842e2010-09-08 01:32:20 +0000888}
Chris Lattner2d332972008-06-16 06:30:22 +0000889
Chandler Carruth7b560d42015-09-09 17:55:00 +0000890ModRefInfo BasicAAResult::getModRefInfo(ImmutableCallSite CS1,
891 ImmutableCallSite CS2) {
Hal Finkel93046912014-07-25 21:13:35 +0000892 // While the assume intrinsic is marked as arbitrarily writing so that
893 // proper control dependencies will be maintained, it never aliases any
894 // particular memory location.
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000895 if (isIntrinsicCall(CS1, Intrinsic::assume) ||
896 isIntrinsicCall(CS2, Intrinsic::assume))
Chandler Carruth194f59c2015-07-22 23:15:57 +0000897 return MRI_NoModRef;
Hal Finkel93046912014-07-25 21:13:35 +0000898
Sanjoy Dasd47f4242016-05-10 02:35:41 +0000899 // Like assumes, guard intrinsics are also marked as arbitrarily writing so
900 // that proper control dependencies are maintained but they never mod any
901 // particular memory location.
902 //
903 // *Unlike* assumes, guard intrinsics are modeled as reading memory since the
904 // heap state at the point the guard is issued needs to be consistent in case
905 // the guard invokes the "deopt" continuation.
906
907 // NB! This function is *not* commutative, so we specical case two
908 // possibilities for guard intrinsics.
909
910 if (isIntrinsicCall(CS1, Intrinsic::experimental_guard))
911 return getModRefBehavior(CS2) & MRI_Mod ? MRI_Ref : MRI_NoModRef;
912
913 if (isIntrinsicCall(CS2, Intrinsic::experimental_guard))
914 return getModRefBehavior(CS1) & MRI_Mod ? MRI_Mod : MRI_NoModRef;
915
Chandler Carruth7b560d42015-09-09 17:55:00 +0000916 // The AAResultBase base class has some smarts, lets use them.
917 return AAResultBase::getModRefInfo(CS1, CS2);
Hal Finkel93046912014-07-25 21:13:35 +0000918}
919
Chandler Carruthc5d81122015-08-06 08:17:06 +0000920/// Provide ad-hoc rules to disambiguate accesses through two GEP operators,
921/// both having the exact same pointer operand.
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000922static AliasResult aliasSameBasePointerGEPs(const GEPOperator *GEP1,
923 uint64_t V1Size,
924 const GEPOperator *GEP2,
925 uint64_t V2Size,
926 const DataLayout &DL) {
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000927
Piotr Padlewski610c9662017-04-24 19:37:17 +0000928 assert(GEP1->getPointerOperand()->stripPointerCastsAndBarriers() ==
929 GEP2->getPointerOperand()->stripPointerCastsAndBarriers() &&
Sanjoy Dasf09c1e32017-04-18 22:00:54 +0000930 GEP1->getPointerOperandType() == GEP2->getPointerOperandType() &&
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000931 "Expected GEPs with the same pointer operand");
932
933 // Try to determine whether GEP1 and GEP2 index through arrays, into structs,
934 // such that the struct field accesses provably cannot alias.
935 // We also need at least two indices (the pointer, and the struct field).
Daniel Berlin73694bb2016-06-01 18:55:32 +0000936 if (GEP1->getNumIndices() != GEP2->getNumIndices() ||
937 GEP1->getNumIndices() < 2)
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000938 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000939
940 // If we don't know the size of the accesses through both GEPs, we can't
941 // determine whether the struct fields accessed can't alias.
Chandler Carruthecbd1682015-06-17 07:21:38 +0000942 if (V1Size == MemoryLocation::UnknownSize ||
943 V2Size == MemoryLocation::UnknownSize)
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000944 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000945
946 ConstantInt *C1 =
947 dyn_cast<ConstantInt>(GEP1->getOperand(GEP1->getNumOperands() - 1));
948 ConstantInt *C2 =
949 dyn_cast<ConstantInt>(GEP2->getOperand(GEP2->getNumOperands() - 1));
950
James Molloy5a4d8cd2015-10-22 13:28:18 +0000951 // If the last (struct) indices are constants and are equal, the other indices
952 // might be also be dynamically equal, so the GEPs can alias.
Vedant Kumaree202942016-05-11 15:45:43 +0000953 if (C1 && C2 && C1->getSExtValue() == C2->getSExtValue())
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000954 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000955
956 // Find the last-indexed type of the GEP, i.e., the type you'd get if
957 // you stripped the last index.
958 // On the way, look at each indexed type. If there's something other
959 // than an array, different indices can lead to different final types.
960 SmallVector<Value *, 8> IntermediateIndices;
961
962 // Insert the first index; we don't need to check the type indexed
963 // through it as it only drops the pointer indirection.
964 assert(GEP1->getNumIndices() > 1 && "Not enough GEP indices to examine");
965 IntermediateIndices.push_back(GEP1->getOperand(1));
966
967 // Insert all the remaining indices but the last one.
968 // Also, check that they all index through arrays.
969 for (unsigned i = 1, e = GEP1->getNumIndices() - 1; i != e; ++i) {
970 if (!isa<ArrayType>(GetElementPtrInst::getIndexedType(
David Blaikied288fb82015-03-30 21:41:43 +0000971 GEP1->getSourceElementType(), IntermediateIndices)))
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000972 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000973 IntermediateIndices.push_back(GEP1->getOperand(i + 1));
974 }
975
James Molloy5a4d8cd2015-10-22 13:28:18 +0000976 auto *Ty = GetElementPtrInst::getIndexedType(
977 GEP1->getSourceElementType(), IntermediateIndices);
978 StructType *LastIndexedStruct = dyn_cast<StructType>(Ty);
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +0000979
James Molloy5a4d8cd2015-10-22 13:28:18 +0000980 if (isa<SequentialType>(Ty)) {
981 // We know that:
982 // - both GEPs begin indexing from the exact same pointer;
983 // - the last indices in both GEPs are constants, indexing into a sequential
984 // type (array or pointer);
985 // - both GEPs only index through arrays prior to that.
986 //
987 // Because array indices greater than the number of elements are valid in
988 // GEPs, unless we know the intermediate indices are identical between
989 // GEP1 and GEP2 we cannot guarantee that the last indexed arrays don't
James Molloy05a896a2015-10-23 14:17:03 +0000990 // partially overlap. We also need to check that the loaded size matches
991 // the element size, otherwise we could still have overlap.
992 const uint64_t ElementSize =
993 DL.getTypeStoreSize(cast<SequentialType>(Ty)->getElementType());
994 if (V1Size != ElementSize || V2Size != ElementSize)
995 return MayAlias;
996
James Molloy5a4d8cd2015-10-22 13:28:18 +0000997 for (unsigned i = 0, e = GEP1->getNumIndices() - 1; i != e; ++i)
998 if (GEP1->getOperand(i + 1) != GEP2->getOperand(i + 1))
999 return MayAlias;
James Molloy05a896a2015-10-23 14:17:03 +00001000
James Molloy5a4d8cd2015-10-22 13:28:18 +00001001 // Now we know that the array/pointer that GEP1 indexes into and that
1002 // that GEP2 indexes into must either precisely overlap or be disjoint.
1003 // Because they cannot partially overlap and because fields in an array
1004 // cannot overlap, if we can prove the final indices are different between
1005 // GEP1 and GEP2, we can conclude GEP1 and GEP2 don't alias.
1006
1007 // If the last indices are constants, we've already checked they don't
1008 // equal each other so we can exit early.
1009 if (C1 && C2)
1010 return NoAlias;
1011 if (isKnownNonEqual(GEP1->getOperand(GEP1->getNumOperands() - 1),
1012 GEP2->getOperand(GEP2->getNumOperands() - 1),
1013 DL))
1014 return NoAlias;
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001015 return MayAlias;
James Molloy5a4d8cd2015-10-22 13:28:18 +00001016 } else if (!LastIndexedStruct || !C1 || !C2) {
1017 return MayAlias;
1018 }
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +00001019
1020 // We know that:
1021 // - both GEPs begin indexing from the exact same pointer;
1022 // - the last indices in both GEPs are constants, indexing into a struct;
1023 // - said indices are different, hence, the pointed-to fields are different;
1024 // - both GEPs only index through arrays prior to that.
1025 //
1026 // This lets us determine that the struct that GEP1 indexes into and the
1027 // struct that GEP2 indexes into must either precisely overlap or be
1028 // completely disjoint. Because they cannot partially overlap, indexing into
1029 // different non-overlapping fields of the struct will never alias.
1030
1031 // Therefore, the only remaining thing needed to show that both GEPs can't
1032 // alias is that the fields are not overlapping.
1033 const StructLayout *SL = DL.getStructLayout(LastIndexedStruct);
1034 const uint64_t StructSize = SL->getSizeInBytes();
1035 const uint64_t V1Off = SL->getElementOffset(C1->getZExtValue());
1036 const uint64_t V2Off = SL->getElementOffset(C2->getZExtValue());
1037
1038 auto EltsDontOverlap = [StructSize](uint64_t V1Off, uint64_t V1Size,
1039 uint64_t V2Off, uint64_t V2Size) {
1040 return V1Off < V2Off && V1Off + V1Size <= V2Off &&
1041 ((V2Off + V2Size <= StructSize) ||
1042 (V2Off + V2Size - StructSize <= V1Off));
1043 };
1044
1045 if (EltsDontOverlap(V1Off, V1Size, V2Off, V2Size) ||
1046 EltsDontOverlap(V2Off, V2Size, V1Off, V1Size))
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001047 return NoAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +00001048
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001049 return MayAlias;
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +00001050}
1051
Michael Kuperstein82069c42016-05-25 22:23:08 +00001052// If a we have (a) a GEP and (b) a pointer based on an alloca, and the
1053// beginning of the object the GEP points would have a negative offset with
1054// repsect to the alloca, that means the GEP can not alias pointer (b).
1055// Note that the pointer based on the alloca may not be a GEP. For
1056// example, it may be the alloca itself.
Michael Kupersteinae214912016-05-26 19:30:49 +00001057// The same applies if (b) is based on a GlobalVariable. Note that just being
1058// based on isIdentifiedObject() is not enough - we need an identified object
1059// that does not permit access to negative offsets. For example, a negative
1060// offset from a noalias argument or call can be inbounds w.r.t the actual
1061// underlying object.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001062//
1063// For example, consider:
1064//
1065// struct { int f0, int f1, ...} foo;
1066// foo alloca;
1067// foo* random = bar(alloca);
1068// int *f0 = &alloca.f0
1069// int *f1 = &random->f1;
1070//
1071// Which is lowered, approximately, to:
1072//
1073// %alloca = alloca %struct.foo
1074// %random = call %struct.foo* @random(%struct.foo* %alloca)
1075// %f0 = getelementptr inbounds %struct, %struct.foo* %alloca, i32 0, i32 0
1076// %f1 = getelementptr inbounds %struct, %struct.foo* %random, i32 0, i32 1
1077//
1078// Assume %f1 and %f0 alias. Then %f1 would point into the object allocated
1079// by %alloca. Since the %f1 GEP is inbounds, that means %random must also
1080// point into the same object. But since %f0 points to the beginning of %alloca,
1081// the highest %f1 can be is (%alloca + 3). This means %random can not be higher
1082// than (%alloca - 1), and so is not inbounds, a contradiction.
1083bool BasicAAResult::isGEPBaseAtNegativeOffset(const GEPOperator *GEPOp,
Michael Kupersteinae214912016-05-26 19:30:49 +00001084 const DecomposedGEP &DecompGEP, const DecomposedGEP &DecompObject,
1085 uint64_t ObjectAccessSize) {
1086 // If the object access size is unknown, or the GEP isn't inbounds, bail.
1087 if (ObjectAccessSize == MemoryLocation::UnknownSize || !GEPOp->isInBounds())
Michael Kuperstein82069c42016-05-25 22:23:08 +00001088 return false;
1089
Michael Kupersteinae214912016-05-26 19:30:49 +00001090 // We need the object to be an alloca or a globalvariable, and want to know
1091 // the offset of the pointer from the object precisely, so no variable
1092 // indices are allowed.
1093 if (!(isa<AllocaInst>(DecompObject.Base) ||
1094 isa<GlobalVariable>(DecompObject.Base)) ||
1095 !DecompObject.VarIndices.empty())
Michael Kuperstein82069c42016-05-25 22:23:08 +00001096 return false;
1097
Michael Kupersteinae214912016-05-26 19:30:49 +00001098 int64_t ObjectBaseOffset = DecompObject.StructOffset +
1099 DecompObject.OtherOffset;
Michael Kuperstein82069c42016-05-25 22:23:08 +00001100
1101 // If the GEP has no variable indices, we know the precise offset
1102 // from the base, then use it. If the GEP has variable indices, we're in
1103 // a bit more trouble: we can't count on the constant offsets that come
1104 // from non-struct sources, since these can be "rewound" by a negative
1105 // variable offset. So use only offsets that came from structs.
1106 int64_t GEPBaseOffset = DecompGEP.StructOffset;
1107 if (DecompGEP.VarIndices.empty())
1108 GEPBaseOffset += DecompGEP.OtherOffset;
1109
Michael Kupersteinae214912016-05-26 19:30:49 +00001110 return (GEPBaseOffset >= ObjectBaseOffset + (int64_t)ObjectAccessSize);
Michael Kuperstein82069c42016-05-25 22:23:08 +00001111}
1112
Chandler Carruthc5d81122015-08-06 08:17:06 +00001113/// Provides a bunch of ad-hoc rules to disambiguate a GEP instruction against
1114/// another pointer.
Chris Lattnera99edbe2009-11-26 02:11:08 +00001115///
Chandler Carruthc5d81122015-08-06 08:17:06 +00001116/// We know that V1 is a GEP, but we don't know anything about V2.
1117/// UnderlyingV1 is GetUnderlyingObject(GEP1, DL), UnderlyingV2 is the same for
1118/// V2.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001119AliasResult BasicAAResult::aliasGEP(const GEPOperator *GEP1, uint64_t V1Size,
1120 const AAMDNodes &V1AAInfo, const Value *V2,
1121 uint64_t V2Size, const AAMDNodes &V2AAInfo,
1122 const Value *UnderlyingV1,
1123 const Value *UnderlyingV2) {
Michael Kuperstein82069c42016-05-25 22:23:08 +00001124 DecomposedGEP DecompGEP1, DecompGEP2;
1125 bool GEP1MaxLookupReached =
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001126 DecomposeGEPExpression(GEP1, DecompGEP1, DL, &AC, DT);
Michael Kuperstein82069c42016-05-25 22:23:08 +00001127 bool GEP2MaxLookupReached =
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001128 DecomposeGEPExpression(V2, DecompGEP2, DL, &AC, DT);
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001129
Michael Kuperstein82069c42016-05-25 22:23:08 +00001130 int64_t GEP1BaseOffset = DecompGEP1.StructOffset + DecompGEP1.OtherOffset;
1131 int64_t GEP2BaseOffset = DecompGEP2.StructOffset + DecompGEP2.OtherOffset;
1132
1133 assert(DecompGEP1.Base == UnderlyingV1 && DecompGEP2.Base == UnderlyingV2 &&
1134 "DecomposeGEPExpression returned a result different from "
1135 "GetUnderlyingObject");
1136
1137 // If the GEP's offset relative to its base is such that the base would
1138 // fall below the start of the object underlying V2, then the GEP and V2
1139 // cannot alias.
1140 if (!GEP1MaxLookupReached && !GEP2MaxLookupReached &&
1141 isGEPBaseAtNegativeOffset(GEP1, DecompGEP1, DecompGEP2, V2Size))
1142 return NoAlias;
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001143 // If we have two gep instructions with must-alias or not-alias'ing base
1144 // pointers, figure out if the indexes to the GEP tell us anything about the
1145 // derived pointer.
Chris Lattnera99edbe2009-11-26 02:11:08 +00001146 if (const GEPOperator *GEP2 = dyn_cast<GEPOperator>(V2)) {
Michael Kuperstein82069c42016-05-25 22:23:08 +00001147 // Check for the GEP base being at a negative offset, this time in the other
1148 // direction.
1149 if (!GEP1MaxLookupReached && !GEP2MaxLookupReached &&
1150 isGEPBaseAtNegativeOffset(GEP2, DecompGEP2, DecompGEP1, V1Size))
1151 return NoAlias;
Arnold Schwaighoferaadf1042013-03-26 18:07:53 +00001152 // Do the base pointers alias?
Chandler Carruthecbd1682015-06-17 07:21:38 +00001153 AliasResult BaseAlias =
1154 aliasCheck(UnderlyingV1, MemoryLocation::UnknownSize, AAMDNodes(),
1155 UnderlyingV2, MemoryLocation::UnknownSize, AAMDNodes());
Arnold Schwaighoferaadf1042013-03-26 18:07:53 +00001156
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001157 // Check for geps of non-aliasing underlying pointers where the offsets are
1158 // identical.
Arnold Schwaighoferaadf1042013-03-26 18:07:53 +00001159 if ((BaseAlias == MayAlias) && V1Size == V2Size) {
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001160 // Do the base pointers alias assuming type and size.
Chandler Carruth903c5f92015-08-06 07:57:58 +00001161 AliasResult PreciseBaseAlias = aliasCheck(UnderlyingV1, V1Size, V1AAInfo,
1162 UnderlyingV2, V2Size, V2AAInfo);
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001163 if (PreciseBaseAlias == NoAlias) {
1164 // See if the computed offset from the common pointer tells us about the
1165 // relation of the resulting pointer.
Arnold Schwaighofer1a444482014-03-26 21:30:19 +00001166 // If the max search depth is reached the result is undefined
1167 if (GEP2MaxLookupReached || GEP1MaxLookupReached)
1168 return MayAlias;
1169
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001170 // Same offsets.
1171 if (GEP1BaseOffset == GEP2BaseOffset &&
Michael Kuperstein82069c42016-05-25 22:23:08 +00001172 DecompGEP1.VarIndices == DecompGEP2.VarIndices)
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001173 return NoAlias;
Arnold Schwaighofer76dca582012-09-06 14:31:51 +00001174 }
1175 }
Jakub Staszak07f383f2013-08-24 14:16:00 +00001176
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001177 // If we get a No or May, then return it immediately, no amount of analysis
1178 // will improve this situation.
Chandler Carruth903c5f92015-08-06 07:57:58 +00001179 if (BaseAlias != MustAlias)
1180 return BaseAlias;
Jakub Staszak07f383f2013-08-24 14:16:00 +00001181
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001182 // Otherwise, we have a MustAlias. Since the base pointers alias each other
1183 // exactly, see if the computed offset from the common pointer tells us
1184 // about the relation of the resulting pointer.
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +00001185 // If we know the two GEPs are based off of the exact same pointer (and not
1186 // just the same underlying object), see if that tells us anything about
1187 // the resulting pointers.
Piotr Padlewski610c9662017-04-24 19:37:17 +00001188 if (GEP1->getPointerOperand()->stripPointerCastsAndBarriers() ==
1189 GEP2->getPointerOperand()->stripPointerCastsAndBarriers() &&
Sanjoy Dasf09c1e32017-04-18 22:00:54 +00001190 GEP1->getPointerOperandType() == GEP2->getPointerOperandType()) {
Chandler Carruth7b560d42015-09-09 17:55:00 +00001191 AliasResult R = aliasSameBasePointerGEPs(GEP1, V1Size, GEP2, V2Size, DL);
Ahmed Bougacha29efe3b2015-02-07 17:04:29 +00001192 // If we couldn't find anything interesting, don't abandon just yet.
1193 if (R != MayAlias)
1194 return R;
1195 }
1196
Sanjay Patel9613b292016-01-17 23:13:48 +00001197 // If the max search depth is reached, the result is undefined
Arnold Schwaighofer1a444482014-03-26 21:30:19 +00001198 if (GEP2MaxLookupReached || GEP1MaxLookupReached)
1199 return MayAlias;
Jakub Staszak07f383f2013-08-24 14:16:00 +00001200
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001201 // Subtract the GEP2 pointer from the GEP1 pointer to find out their
1202 // symbolic difference.
1203 GEP1BaseOffset -= GEP2BaseOffset;
Michael Kuperstein82069c42016-05-25 22:23:08 +00001204 GetIndexDifference(DecompGEP1.VarIndices, DecompGEP2.VarIndices);
Jakub Staszak07f383f2013-08-24 14:16:00 +00001205
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001206 } else {
1207 // Check to see if these two pointers are related by the getelementptr
1208 // instruction. If one pointer is a GEP with a non-zero index of the other
1209 // pointer, we know they cannot alias.
Chris Lattner5c1cfc22009-11-26 16:52:32 +00001210
1211 // If both accesses are unknown size, we can't do anything useful here.
Chandler Carruthecbd1682015-06-17 07:21:38 +00001212 if (V1Size == MemoryLocation::UnknownSize &&
1213 V2Size == MemoryLocation::UnknownSize)
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001214 return MayAlias;
Chris Lattner6ea17f77f2003-12-11 22:44:13 +00001215
Chandler Carruthecbd1682015-06-17 07:21:38 +00001216 AliasResult R = aliasCheck(UnderlyingV1, MemoryLocation::UnknownSize,
Mehdi Amini1726fc62017-01-27 16:12:22 +00001217 AAMDNodes(), V2, MemoryLocation::UnknownSize,
1218 V2AAInfo, nullptr, UnderlyingV2);
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001219 if (R != MustAlias)
1220 // If V2 may alias GEP base pointer, conservatively returns MayAlias.
1221 // If V2 is known not to alias GEP base pointer, then the two values
Mehdi Amini1726fc62017-01-27 16:12:22 +00001222 // cannot alias per GEP semantics: "Any memory access must be done through
1223 // a pointer value associated with an address range of the memory access,
1224 // otherwise the behavior is undefined.".
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001225 return R;
Chris Lattner6ea17f77f2003-12-11 22:44:13 +00001226
Arnold Schwaighofer1a444482014-03-26 21:30:19 +00001227 // If the max search depth is reached the result is undefined
1228 if (GEP1MaxLookupReached)
1229 return MayAlias;
Chris Lattner6ea17f77f2003-12-11 22:44:13 +00001230 }
Jakub Staszak07f383f2013-08-24 14:16:00 +00001231
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001232 // In the two GEP Case, if there is no difference in the offsets of the
1233 // computed pointers, the resultant pointers are a must alias. This
Sanjay Patel9613b292016-01-17 23:13:48 +00001234 // happens when we have two lexically identical GEP's (for example).
Chris Lattnerd6a2a992003-02-26 19:41:54 +00001235 //
Chris Lattner7a5b56a2009-11-26 02:17:34 +00001236 // In the other case, if we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2
1237 // must aliases the GEP, the end result is a must alias also.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001238 if (GEP1BaseOffset == 0 && DecompGEP1.VarIndices.empty())
Evan Chengc1eed9d2009-10-14 06:41:49 +00001239 return MustAlias;
Evan Chengf1f3dd32009-10-13 18:42:04 +00001240
Eli Friedman3d1b3072011-09-08 02:23:31 +00001241 // If there is a constant difference between the pointers, but the difference
1242 // is less than the size of the associated memory object, then we know
1243 // that the objects are partially overlapping. If the difference is
1244 // greater, we know they do not overlap.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001245 if (GEP1BaseOffset != 0 && DecompGEP1.VarIndices.empty()) {
Eli Friedman3d1b3072011-09-08 02:23:31 +00001246 if (GEP1BaseOffset >= 0) {
Chandler Carruthecbd1682015-06-17 07:21:38 +00001247 if (V2Size != MemoryLocation::UnknownSize) {
Eli Friedman3d1b3072011-09-08 02:23:31 +00001248 if ((uint64_t)GEP1BaseOffset < V2Size)
1249 return PartialAlias;
1250 return NoAlias;
1251 }
1252 } else {
Arnold Schwaighofere3ac0992014-01-16 04:53:18 +00001253 // We have the situation where:
1254 // + +
1255 // | BaseOffset |
1256 // ---------------->|
1257 // |-->V1Size |-------> V2Size
1258 // GEP1 V2
1259 // We need to know that V2Size is not unknown, otherwise we might have
1260 // stripped a gep with negative index ('gep <ptr>, -1, ...).
Chandler Carruthecbd1682015-06-17 07:21:38 +00001261 if (V1Size != MemoryLocation::UnknownSize &&
1262 V2Size != MemoryLocation::UnknownSize) {
Eli Friedman3d1b3072011-09-08 02:23:31 +00001263 if (-(uint64_t)GEP1BaseOffset < V1Size)
1264 return PartialAlias;
1265 return NoAlias;
1266 }
1267 }
Dan Gohmanc4bf5ca2010-12-13 22:50:24 +00001268 }
1269
Michael Kuperstein82069c42016-05-25 22:23:08 +00001270 if (!DecompGEP1.VarIndices.empty()) {
Eli Friedmanb78ac542011-09-08 02:37:07 +00001271 uint64_t Modulo = 0;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001272 bool AllPositive = true;
Michael Kuperstein82069c42016-05-25 22:23:08 +00001273 for (unsigned i = 0, e = DecompGEP1.VarIndices.size(); i != e; ++i) {
Quentin Colombet5989bc62015-08-31 22:32:47 +00001274
1275 // Try to distinguish something like &A[i][1] against &A[42][0].
1276 // Grab the least significant bit set in any of the scales. We
1277 // don't need std::abs here (even if the scale's negative) as we'll
1278 // be ^'ing Modulo with itself later.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001279 Modulo |= (uint64_t)DecompGEP1.VarIndices[i].Scale;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001280
1281 if (AllPositive) {
1282 // If the Value could change between cycles, then any reasoning about
1283 // the Value this cycle may not hold in the next cycle. We'll just
1284 // give up if we can't determine conditions that hold for every cycle:
Michael Kuperstein82069c42016-05-25 22:23:08 +00001285 const Value *V = DecompGEP1.VarIndices[i].V;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001286
Craig Topper1a36b7d2017-05-15 06:39:41 +00001287 KnownBits Known = computeKnownBits(V, DL, 0, &AC, nullptr, DT);
1288 bool SignKnownZero = Known.isNonNegative();
1289 bool SignKnownOne = Known.isNegative();
Quentin Colombet5989bc62015-08-31 22:32:47 +00001290
1291 // Zero-extension widens the variable, and so forces the sign
1292 // bit to zero.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001293 bool IsZExt = DecompGEP1.VarIndices[i].ZExtBits > 0 || isa<ZExtInst>(V);
Quentin Colombet5989bc62015-08-31 22:32:47 +00001294 SignKnownZero |= IsZExt;
1295 SignKnownOne &= !IsZExt;
1296
1297 // If the variable begins with a zero then we know it's
1298 // positive, regardless of whether the value is signed or
1299 // unsigned.
Michael Kuperstein82069c42016-05-25 22:23:08 +00001300 int64_t Scale = DecompGEP1.VarIndices[i].Scale;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001301 AllPositive =
1302 (SignKnownZero && Scale >= 0) || (SignKnownOne && Scale < 0);
1303 }
1304 }
1305
Eli Friedmanb78ac542011-09-08 02:37:07 +00001306 Modulo = Modulo ^ (Modulo & (Modulo - 1));
Eli Friedman3d1b3072011-09-08 02:23:31 +00001307
Eli Friedmanb78ac542011-09-08 02:37:07 +00001308 // We can compute the difference between the two addresses
1309 // mod Modulo. Check whether that difference guarantees that the
1310 // two locations do not alias.
1311 uint64_t ModOffset = (uint64_t)GEP1BaseOffset & (Modulo - 1);
Chandler Carruthecbd1682015-06-17 07:21:38 +00001312 if (V1Size != MemoryLocation::UnknownSize &&
1313 V2Size != MemoryLocation::UnknownSize && ModOffset >= V2Size &&
1314 V1Size <= Modulo - ModOffset)
Eli Friedmanb78ac542011-09-08 02:37:07 +00001315 return NoAlias;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001316
1317 // If we know all the variables are positive, then GEP1 >= GEP1BasePtr.
1318 // If GEP1BasePtr > V2 (GEP1BaseOffset > 0) then we know the pointers
1319 // don't alias if V2Size can fit in the gap between V2 and GEP1BasePtr.
1320 if (AllPositive && GEP1BaseOffset > 0 && V2Size <= (uint64_t)GEP1BaseOffset)
1321 return NoAlias;
1322
Michael Kuperstein82069c42016-05-25 22:23:08 +00001323 if (constantOffsetHeuristic(DecompGEP1.VarIndices, V1Size, V2Size,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001324 GEP1BaseOffset, &AC, DT))
Quentin Colombet5989bc62015-08-31 22:32:47 +00001325 return NoAlias;
Eli Friedmanb78ac542011-09-08 02:37:07 +00001326 }
Eli Friedman3d1b3072011-09-08 02:23:31 +00001327
Dan Gohmanadf80ae2011-06-04 06:50:18 +00001328 // Statically, we can see that the base objects are the same, but the
1329 // pointers have dynamic offsets which we can't resolve. And none of our
1330 // little tricks above worked.
1331 //
1332 // TODO: Returning PartialAlias instead of MayAlias is a mild hack; the
1333 // practical effect of this is protecting TBAA in the case of dynamic
Dan Gohman9017b842012-02-17 18:33:38 +00001334 // indices into arrays of unions or malloc'd memory.
Dan Gohmanadf80ae2011-06-04 06:50:18 +00001335 return PartialAlias;
Evan Chengf1f3dd32009-10-13 18:42:04 +00001336}
1337
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001338static AliasResult MergeAliasResults(AliasResult A, AliasResult B) {
Dan Gohman4e7e7952011-06-03 20:17:36 +00001339 // If the results agree, take it.
1340 if (A == B)
1341 return A;
1342 // A mix of PartialAlias and MustAlias is PartialAlias.
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001343 if ((A == PartialAlias && B == MustAlias) ||
1344 (B == PartialAlias && A == MustAlias))
1345 return PartialAlias;
Dan Gohman4e7e7952011-06-03 20:17:36 +00001346 // Otherwise, we don't know anything.
Chandler Carruthc3f49eb2015-06-22 02:16:51 +00001347 return MayAlias;
Dan Gohman4e7e7952011-06-03 20:17:36 +00001348}
1349
Chandler Carruthc5d81122015-08-06 08:17:06 +00001350/// Provides a bunch of ad-hoc rules to disambiguate a Select instruction
1351/// against another.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001352AliasResult BasicAAResult::aliasSelect(const SelectInst *SI, uint64_t SISize,
1353 const AAMDNodes &SIAAInfo,
1354 const Value *V2, uint64_t V2Size,
Ehsan Amiri17e17012016-08-12 16:05:03 +00001355 const AAMDNodes &V2AAInfo,
1356 const Value *UnderV2) {
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001357 // If the values are Selects with the same condition, we can do a more precise
1358 // check: just check for aliases between the values on corresponding arms.
1359 if (const SelectInst *SI2 = dyn_cast<SelectInst>(V2))
1360 if (SI->getCondition() == SI2->getCondition()) {
Chandler Carruth903c5f92015-08-06 07:57:58 +00001361 AliasResult Alias = aliasCheck(SI->getTrueValue(), SISize, SIAAInfo,
1362 SI2->getTrueValue(), V2Size, V2AAInfo);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001363 if (Alias == MayAlias)
1364 return MayAlias;
1365 AliasResult ThisAlias =
Chandler Carruth903c5f92015-08-06 07:57:58 +00001366 aliasCheck(SI->getFalseValue(), SISize, SIAAInfo,
1367 SI2->getFalseValue(), V2Size, V2AAInfo);
Dan Gohman4e7e7952011-06-03 20:17:36 +00001368 return MergeAliasResults(ThisAlias, Alias);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001369 }
1370
1371 // If both arms of the Select node NoAlias or MustAlias V2, then returns
1372 // NoAlias / MustAlias. Otherwise, returns MayAlias.
1373 AliasResult Alias =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001374 aliasCheck(V2, V2Size, V2AAInfo, SI->getTrueValue(),
1375 SISize, SIAAInfo, UnderV2);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001376 if (Alias == MayAlias)
1377 return MayAlias;
Dan Gohman7c34ece2010-06-28 21:16:52 +00001378
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001379 AliasResult ThisAlias =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001380 aliasCheck(V2, V2Size, V2AAInfo, SI->getFalseValue(), SISize, SIAAInfo,
1381 UnderV2);
Dan Gohman4e7e7952011-06-03 20:17:36 +00001382 return MergeAliasResults(ThisAlias, Alias);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001383}
1384
Chandler Carruthc5d81122015-08-06 08:17:06 +00001385/// Provide a bunch of ad-hoc rules to disambiguate a PHI instruction against
1386/// another.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001387AliasResult BasicAAResult::aliasPHI(const PHINode *PN, uint64_t PNSize,
1388 const AAMDNodes &PNAAInfo, const Value *V2,
Ehsan Amiri17e17012016-08-12 16:05:03 +00001389 uint64_t V2Size, const AAMDNodes &V2AAInfo,
1390 const Value *UnderV2) {
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001391 // Track phi nodes we have visited. We use this information when we determine
1392 // value equivalence.
1393 VisitedPhiBBs.insert(PN->getParent());
1394
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001395 // If the values are PHIs in the same block, we can do a more precise
1396 // as well as efficient check: just check for aliases between the values
1397 // on corresponding edges.
1398 if (const PHINode *PN2 = dyn_cast<PHINode>(V2))
1399 if (PN2->getParent() == PN->getParent()) {
Chandler Carruthac80dc72015-06-17 07:18:54 +00001400 LocPair Locs(MemoryLocation(PN, PNSize, PNAAInfo),
1401 MemoryLocation(V2, V2Size, V2AAInfo));
Arnold Schwaighofer8dc34cf2012-09-06 14:41:53 +00001402 if (PN > V2)
1403 std::swap(Locs.first, Locs.second);
Arnold Schwaighoferedd62b12012-12-10 23:02:41 +00001404 // Analyse the PHIs' inputs under the assumption that the PHIs are
1405 // NoAlias.
1406 // If the PHIs are May/MustAlias there must be (recursively) an input
1407 // operand from outside the PHIs' cycle that is MayAlias/MustAlias or
1408 // there must be an operation on the PHIs within the PHIs' value cycle
1409 // that causes a MayAlias.
1410 // Pretend the phis do not alias.
1411 AliasResult Alias = NoAlias;
1412 assert(AliasCache.count(Locs) &&
1413 "There must exist an entry for the phi node");
1414 AliasResult OrigAliasResult = AliasCache[Locs];
1415 AliasCache[Locs] = NoAlias;
Arnold Schwaighofer8dc34cf2012-09-06 14:41:53 +00001416
Hal Finkela6f86fc2012-11-17 02:33:15 +00001417 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001418 AliasResult ThisAlias =
Chandler Carruth903c5f92015-08-06 07:57:58 +00001419 aliasCheck(PN->getIncomingValue(i), PNSize, PNAAInfo,
1420 PN2->getIncomingValueForBlock(PN->getIncomingBlock(i)),
1421 V2Size, V2AAInfo);
Dan Gohman4e7e7952011-06-03 20:17:36 +00001422 Alias = MergeAliasResults(ThisAlias, Alias);
1423 if (Alias == MayAlias)
1424 break;
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001425 }
Arnold Schwaighofer8dc34cf2012-09-06 14:41:53 +00001426
1427 // Reset if speculation failed.
Arnold Schwaighoferedd62b12012-12-10 23:02:41 +00001428 if (Alias != NoAlias)
Arnold Schwaighofer8dc34cf2012-09-06 14:41:53 +00001429 AliasCache[Locs] = OrigAliasResult;
1430
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001431 return Alias;
1432 }
1433
Chandler Carruth903c5f92015-08-06 07:57:58 +00001434 SmallPtrSet<Value *, 4> UniqueSrc;
1435 SmallVector<Value *, 4> V1Srcs;
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +00001436 bool isRecursive = false;
Pete Cooper833f34d2015-05-12 20:05:31 +00001437 for (Value *PV1 : PN->incoming_values()) {
Evan Chengc10e88d2009-10-13 22:02:20 +00001438 if (isa<PHINode>(PV1))
1439 // If any of the source itself is a PHI, return MayAlias conservatively
Evan Chengc1eed9d2009-10-14 06:41:49 +00001440 // to avoid compile time explosion. The worst possible case is if both
1441 // sides are PHI nodes. In which case, this is O(m x n) time where 'm'
1442 // and 'n' are the number of PHI sources.
Evan Chengc10e88d2009-10-13 22:02:20 +00001443 return MayAlias;
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +00001444
1445 if (EnableRecPhiAnalysis)
1446 if (GEPOperator *PV1GEP = dyn_cast<GEPOperator>(PV1)) {
1447 // Check whether the incoming value is a GEP that advances the pointer
1448 // result of this PHI node (e.g. in a loop). If this is the case, we
1449 // would recurse and always get a MayAlias. Handle this case specially
1450 // below.
1451 if (PV1GEP->getPointerOperand() == PN && PV1GEP->getNumIndices() == 1 &&
1452 isa<ConstantInt>(PV1GEP->idx_begin())) {
1453 isRecursive = true;
1454 continue;
1455 }
1456 }
1457
David Blaikie70573dc2014-11-19 07:49:26 +00001458 if (UniqueSrc.insert(PV1).second)
Evan Chengc10e88d2009-10-13 22:02:20 +00001459 V1Srcs.push_back(PV1);
1460 }
1461
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +00001462 // If this PHI node is recursive, set the size of the accessed memory to
1463 // unknown to represent all the possible values the GEP could advance the
1464 // pointer to.
1465 if (isRecursive)
1466 PNSize = MemoryLocation::UnknownSize;
1467
Chandler Carruth903c5f92015-08-06 07:57:58 +00001468 AliasResult Alias =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001469 aliasCheck(V2, V2Size, V2AAInfo, V1Srcs[0],
1470 PNSize, PNAAInfo, UnderV2);
Tobias Edler von Kochd8ce16b2015-07-15 19:32:22 +00001471
Evan Chengf92f5552009-10-14 05:22:03 +00001472 // Early exit if the check of the first PHI source against V2 is MayAlias.
1473 // Other results are not possible.
1474 if (Alias == MayAlias)
1475 return MayAlias;
1476
Evan Chengc10e88d2009-10-13 22:02:20 +00001477 // If all sources of the PHI node NoAlias or MustAlias V2, then returns
1478 // NoAlias / MustAlias. Otherwise, returns MayAlias.
Evan Chengc10e88d2009-10-13 22:02:20 +00001479 for (unsigned i = 1, e = V1Srcs.size(); i != e; ++i) {
1480 Value *V = V1Srcs[i];
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001481
Chandler Carruth903c5f92015-08-06 07:57:58 +00001482 AliasResult ThisAlias =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001483 aliasCheck(V2, V2Size, V2AAInfo, V, PNSize, PNAAInfo, UnderV2);
Dan Gohman4e7e7952011-06-03 20:17:36 +00001484 Alias = MergeAliasResults(ThisAlias, Alias);
1485 if (Alias == MayAlias)
1486 break;
Evan Chengc10e88d2009-10-13 22:02:20 +00001487 }
1488
1489 return Alias;
1490}
1491
David Majnemer0345b0f2015-11-17 08:15:08 +00001492/// Provides a bunch of ad-hoc rules to disambiguate in common cases, such as
Chandler Carruthc5d81122015-08-06 08:17:06 +00001493/// array references.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001494AliasResult BasicAAResult::aliasCheck(const Value *V1, uint64_t V1Size,
1495 AAMDNodes V1AAInfo, const Value *V2,
Ehsan Amiri17e17012016-08-12 16:05:03 +00001496 uint64_t V2Size, AAMDNodes V2AAInfo,
1497 const Value *O1, const Value *O2) {
Dan Gohmancb45bd92010-04-08 18:11:50 +00001498 // If either of the memory references is empty, it doesn't matter what the
1499 // pointer values are.
1500 if (V1Size == 0 || V2Size == 0)
1501 return NoAlias;
1502
Evan Chengf1f3dd32009-10-13 18:42:04 +00001503 // Strip off any casts if they exist.
Piotr Padlewski610c9662017-04-24 19:37:17 +00001504 V1 = V1->stripPointerCastsAndBarriers();
1505 V2 = V2->stripPointerCastsAndBarriers();
Evan Chengf1f3dd32009-10-13 18:42:04 +00001506
Daniel Berlin3459d6e2015-05-05 18:10:49 +00001507 // If V1 or V2 is undef, the result is NoAlias because we can always pick a
1508 // value for undef that aliases nothing in the program.
1509 if (isa<UndefValue>(V1) || isa<UndefValue>(V2))
1510 return NoAlias;
1511
Evan Chengf1f3dd32009-10-13 18:42:04 +00001512 // Are we checking for alias of the same value?
Sanjay Patel9613b292016-01-17 23:13:48 +00001513 // Because we look 'through' phi nodes, we could look at "Value" pointers from
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001514 // different iterations. We must therefore make sure that this is not the
1515 // case. The function isValueEqualInPotentialCycles ensures that this cannot
1516 // happen by looking at the visited phi nodes and making sure they cannot
1517 // reach the value.
1518 if (isValueEqualInPotentialCycles(V1, V2))
1519 return MustAlias;
Evan Chengf1f3dd32009-10-13 18:42:04 +00001520
Duncan Sands19d0b472010-02-16 11:11:14 +00001521 if (!V1->getType()->isPointerTy() || !V2->getType()->isPointerTy())
Chandler Carruth903c5f92015-08-06 07:57:58 +00001522 return NoAlias; // Scalars cannot alias each other
Evan Chengf1f3dd32009-10-13 18:42:04 +00001523
1524 // Figure out what objects these things are pointing to if we can.
Ehsan Amiri17e17012016-08-12 16:05:03 +00001525 if (O1 == nullptr)
1526 O1 = GetUnderlyingObject(V1, DL, MaxLookupSearchDepth);
1527
1528 if (O2 == nullptr)
1529 O2 = GetUnderlyingObject(V2, DL, MaxLookupSearchDepth);
Evan Chengf1f3dd32009-10-13 18:42:04 +00001530
Dan Gohmanccb45842009-11-09 19:29:11 +00001531 // Null values in the default address space don't point to any object, so they
1532 // don't alias any other pointer.
1533 if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O1))
1534 if (CPN->getType()->getAddressSpace() == 0)
1535 return NoAlias;
1536 if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O2))
1537 if (CPN->getType()->getAddressSpace() == 0)
1538 return NoAlias;
1539
Evan Chengf1f3dd32009-10-13 18:42:04 +00001540 if (O1 != O2) {
Sanjay Patel9613b292016-01-17 23:13:48 +00001541 // If V1/V2 point to two different objects, we know that we have no alias.
Dan Gohman00ef9322010-07-07 14:27:09 +00001542 if (isIdentifiedObject(O1) && isIdentifiedObject(O2))
Evan Chengf1f3dd32009-10-13 18:42:04 +00001543 return NoAlias;
Nick Lewyckyc53e2ec2009-11-14 06:15:14 +00001544
1545 // Constant pointers can't alias with non-const isIdentifiedObject objects.
Dan Gohman00ef9322010-07-07 14:27:09 +00001546 if ((isa<Constant>(O1) && isIdentifiedObject(O2) && !isa<Constant>(O2)) ||
1547 (isa<Constant>(O2) && isIdentifiedObject(O1) && !isa<Constant>(O1)))
Nick Lewyckyc53e2ec2009-11-14 06:15:14 +00001548 return NoAlias;
1549
Michael Kupersteinf3e663a2013-05-28 08:17:48 +00001550 // Function arguments can't alias with things that are known to be
1551 // unambigously identified at the function level.
1552 if ((isa<Argument>(O1) && isIdentifiedFunctionLocal(O2)) ||
1553 (isa<Argument>(O2) && isIdentifiedFunctionLocal(O1)))
Dan Gohman84f90a32010-07-01 20:08:40 +00001554 return NoAlias;
Evan Chengf1f3dd32009-10-13 18:42:04 +00001555
1556 // Most objects can't alias null.
Dan Gohman00ef9322010-07-07 14:27:09 +00001557 if ((isa<ConstantPointerNull>(O2) && isKnownNonNull(O1)) ||
1558 (isa<ConstantPointerNull>(O1) && isKnownNonNull(O2)))
Evan Chengf1f3dd32009-10-13 18:42:04 +00001559 return NoAlias;
Jakub Staszak07f383f2013-08-24 14:16:00 +00001560
Dan Gohman5b0a8a82010-07-07 14:30:04 +00001561 // If one pointer is the result of a call/invoke or load and the other is a
1562 // non-escaping local object within the same function, then we know the
1563 // object couldn't escape to a point where the call could return it.
1564 //
1565 // Note that if the pointers are in different functions, there are a
1566 // variety of complications. A call with a nocapture argument may still
1567 // temporary store the nocapture argument's value in a temporary memory
1568 // location if that memory location doesn't escape. Or it may pass a
1569 // nocapture value to other functions as long as they don't capture it.
1570 if (isEscapeSource(O1) && isNonEscapingLocalObject(O2))
1571 return NoAlias;
1572 if (isEscapeSource(O2) && isNonEscapingLocalObject(O1))
1573 return NoAlias;
1574 }
1575
Evan Chengf1f3dd32009-10-13 18:42:04 +00001576 // If the size of one access is larger than the entire object on the other
1577 // side, then we know such behavior is undefined and can assume no alias.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001578 if ((V1Size != MemoryLocation::UnknownSize &&
1579 isObjectSmallerThan(O2, V1Size, DL, TLI)) ||
1580 (V2Size != MemoryLocation::UnknownSize &&
1581 isObjectSmallerThan(O1, V2Size, DL, TLI)))
1582 return NoAlias;
Jakub Staszak07f383f2013-08-24 14:16:00 +00001583
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001584 // Check the cache before climbing up use-def chains. This also terminates
1585 // otherwise infinitely recursive queries.
Chandler Carruthac80dc72015-06-17 07:18:54 +00001586 LocPair Locs(MemoryLocation(V1, V1Size, V1AAInfo),
1587 MemoryLocation(V2, V2Size, V2AAInfo));
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001588 if (V1 > V2)
1589 std::swap(Locs.first, Locs.second);
1590 std::pair<AliasCacheTy::iterator, bool> Pair =
Chandler Carruth903c5f92015-08-06 07:57:58 +00001591 AliasCache.insert(std::make_pair(Locs, MayAlias));
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001592 if (!Pair.second)
1593 return Pair.first->second;
1594
Chris Lattner89288992009-11-26 02:13:03 +00001595 // FIXME: This isn't aggressively handling alias(GEP, PHI) for example: if the
1596 // GEP can't simplify, we don't even look at the PHI cases.
Chris Lattnerb2647b92009-10-17 23:48:54 +00001597 if (!isa<GEPOperator>(V1) && isa<GEPOperator>(V2)) {
Chris Lattnerd6a2a992003-02-26 19:41:54 +00001598 std::swap(V1, V2);
1599 std::swap(V1Size, V2Size);
Chris Lattner5341c962009-11-26 02:14:59 +00001600 std::swap(O1, O2);
Hal Finkelcc39b672014-07-24 12:16:19 +00001601 std::swap(V1AAInfo, V2AAInfo);
Chris Lattnerd6a2a992003-02-26 19:41:54 +00001602 }
Dan Gohman02538ac2010-10-18 18:04:47 +00001603 if (const GEPOperator *GV1 = dyn_cast<GEPOperator>(V1)) {
Chandler Carruth903c5f92015-08-06 07:57:58 +00001604 AliasResult Result =
1605 aliasGEP(GV1, V1Size, V1AAInfo, V2, V2Size, V2AAInfo, O1, O2);
1606 if (Result != MayAlias)
1607 return AliasCache[Locs] = Result;
Dan Gohman02538ac2010-10-18 18:04:47 +00001608 }
Evan Chengc10e88d2009-10-13 22:02:20 +00001609
1610 if (isa<PHINode>(V2) && !isa<PHINode>(V1)) {
1611 std::swap(V1, V2);
Ehsan Amiri17e17012016-08-12 16:05:03 +00001612 std::swap(O1, O2);
Evan Chengc10e88d2009-10-13 22:02:20 +00001613 std::swap(V1Size, V2Size);
Hal Finkelcc39b672014-07-24 12:16:19 +00001614 std::swap(V1AAInfo, V2AAInfo);
Evan Chengc10e88d2009-10-13 22:02:20 +00001615 }
Dan Gohman02538ac2010-10-18 18:04:47 +00001616 if (const PHINode *PN = dyn_cast<PHINode>(V1)) {
Ehsan Amiri17e17012016-08-12 16:05:03 +00001617 AliasResult Result = aliasPHI(PN, V1Size, V1AAInfo,
1618 V2, V2Size, V2AAInfo, O2);
Chandler Carruth903c5f92015-08-06 07:57:58 +00001619 if (Result != MayAlias)
1620 return AliasCache[Locs] = Result;
Dan Gohman02538ac2010-10-18 18:04:47 +00001621 }
Misha Brukman01808ca2005-04-21 21:13:18 +00001622
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001623 if (isa<SelectInst>(V2) && !isa<SelectInst>(V1)) {
1624 std::swap(V1, V2);
Ehsan Amiri17e17012016-08-12 16:05:03 +00001625 std::swap(O1, O2);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001626 std::swap(V1Size, V2Size);
Hal Finkelcc39b672014-07-24 12:16:19 +00001627 std::swap(V1AAInfo, V2AAInfo);
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001628 }
Dan Gohman02538ac2010-10-18 18:04:47 +00001629 if (const SelectInst *S1 = dyn_cast<SelectInst>(V1)) {
Chandler Carruth903c5f92015-08-06 07:57:58 +00001630 AliasResult Result =
Ehsan Amiri17e17012016-08-12 16:05:03 +00001631 aliasSelect(S1, V1Size, V1AAInfo, V2, V2Size, V2AAInfo, O2);
Chandler Carruth903c5f92015-08-06 07:57:58 +00001632 if (Result != MayAlias)
1633 return AliasCache[Locs] = Result;
Dan Gohman02538ac2010-10-18 18:04:47 +00001634 }
Dan Gohman3b7ba5f2009-10-26 21:55:43 +00001635
Dan Gohman44da55b2011-01-18 21:16:06 +00001636 // If both pointers are pointing into the same object and one of them
Sanjay Patel9613b292016-01-17 23:13:48 +00001637 // accesses the entire object, then the accesses must overlap in some way.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001638 if (O1 == O2)
Chandler Carruthecbd1682015-06-17 07:21:38 +00001639 if ((V1Size != MemoryLocation::UnknownSize &&
Chandler Carruth7b560d42015-09-09 17:55:00 +00001640 isObjectSize(O1, V1Size, DL, TLI)) ||
Chandler Carruthecbd1682015-06-17 07:21:38 +00001641 (V2Size != MemoryLocation::UnknownSize &&
Chandler Carruth7b560d42015-09-09 17:55:00 +00001642 isObjectSize(O2, V2Size, DL, TLI)))
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001643 return AliasCache[Locs] = PartialAlias;
Dan Gohman44da55b2011-01-18 21:16:06 +00001644
Chandler Carruth7b560d42015-09-09 17:55:00 +00001645 // Recurse back into the best AA results we have, potentially with refined
1646 // memory locations. We have already ensured that BasicAA has a MayAlias
1647 // cache result for these, so any recursion back into BasicAA won't loop.
1648 AliasResult Result = getBestAAResults().alias(Locs.first, Locs.second);
Dan Gohmanfb02cec2011-06-04 00:31:50 +00001649 return AliasCache[Locs] = Result;
Chris Lattnerd6a2a992003-02-26 19:41:54 +00001650}
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001651
Chandler Carruthc5d81122015-08-06 08:17:06 +00001652/// Check whether two Values can be considered equivalent.
1653///
1654/// In addition to pointer equivalence of \p V1 and \p V2 this checks whether
1655/// they can not be part of a cycle in the value graph by looking at all
1656/// visited phi nodes an making sure that the phis cannot reach the value. We
1657/// have to do this because we are looking through phi nodes (That is we say
1658/// noalias(V, phi(VA, VB)) if noalias(V, VA) and noalias(V, VB).
Chandler Carruth7b560d42015-09-09 17:55:00 +00001659bool BasicAAResult::isValueEqualInPotentialCycles(const Value *V,
1660 const Value *V2) {
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001661 if (V != V2)
1662 return false;
1663
1664 const Instruction *Inst = dyn_cast<Instruction>(V);
1665 if (!Inst)
1666 return true;
1667
Daniel Berlin9e77de22015-03-20 18:05:49 +00001668 if (VisitedPhiBBs.empty())
1669 return true;
1670
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001671 if (VisitedPhiBBs.size() > MaxNumPhiBBsValueReachabilityCheck)
1672 return false;
1673
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001674 // Make sure that the visited phis cannot reach the Value. This ensures that
1675 // the Values cannot come from different iterations of a potential cycle the
1676 // phi nodes could be involved in.
Craig Topper46276792014-08-24 23:23:06 +00001677 for (auto *P : VisitedPhiBBs)
Duncan P. N. Exon Smith5a82c912015-10-10 00:53:03 +00001678 if (isPotentiallyReachable(&P->front(), Inst, DT, LI))
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001679 return false;
1680
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001681 return true;
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001682}
1683
Chandler Carruthc5d81122015-08-06 08:17:06 +00001684/// Computes the symbolic difference between two de-composed GEPs.
1685///
1686/// Dest and Src are the variable indices from two decomposed GetElementPtr
1687/// instructions GEP1 and GEP2 which have common base pointers.
Chandler Carruth7b560d42015-09-09 17:55:00 +00001688void BasicAAResult::GetIndexDifference(
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001689 SmallVectorImpl<VariableGEPIndex> &Dest,
1690 const SmallVectorImpl<VariableGEPIndex> &Src) {
1691 if (Src.empty())
1692 return;
1693
1694 for (unsigned i = 0, e = Src.size(); i != e; ++i) {
1695 const Value *V = Src[i].V;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001696 unsigned ZExtBits = Src[i].ZExtBits, SExtBits = Src[i].SExtBits;
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001697 int64_t Scale = Src[i].Scale;
1698
1699 // Find V in Dest. This is N^2, but pointer indices almost never have more
1700 // than a few variable indexes.
1701 for (unsigned j = 0, e = Dest.size(); j != e; ++j) {
Arnold Schwaighofer833a82e2014-01-03 05:47:03 +00001702 if (!isValueEqualInPotentialCycles(Dest[j].V, V) ||
Quentin Colombet5989bc62015-08-31 22:32:47 +00001703 Dest[j].ZExtBits != ZExtBits || Dest[j].SExtBits != SExtBits)
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001704 continue;
1705
1706 // If we found it, subtract off Scale V's from the entry in Dest. If it
1707 // goes to zero, remove the entry.
1708 if (Dest[j].Scale != Scale)
1709 Dest[j].Scale -= Scale;
1710 else
1711 Dest.erase(Dest.begin() + j);
1712 Scale = 0;
1713 break;
1714 }
1715
1716 // If we didn't consume this entry, add it to the end of the Dest list.
1717 if (Scale) {
Quentin Colombet5989bc62015-08-31 22:32:47 +00001718 VariableGEPIndex Entry = {V, ZExtBits, SExtBits, -Scale};
Arnold Schwaighofer0d10a9d2014-01-02 03:31:36 +00001719 Dest.push_back(Entry);
1720 }
1721 }
1722}
Quentin Colombet5989bc62015-08-31 22:32:47 +00001723
Chandler Carruth7b560d42015-09-09 17:55:00 +00001724bool BasicAAResult::constantOffsetHeuristic(
Quentin Colombet5989bc62015-08-31 22:32:47 +00001725 const SmallVectorImpl<VariableGEPIndex> &VarIndices, uint64_t V1Size,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001726 uint64_t V2Size, int64_t BaseOffset, AssumptionCache *AC,
Chandler Carruth7b560d42015-09-09 17:55:00 +00001727 DominatorTree *DT) {
Quentin Colombet5989bc62015-08-31 22:32:47 +00001728 if (VarIndices.size() != 2 || V1Size == MemoryLocation::UnknownSize ||
Chandler Carruth7b560d42015-09-09 17:55:00 +00001729 V2Size == MemoryLocation::UnknownSize)
Quentin Colombet5989bc62015-08-31 22:32:47 +00001730 return false;
1731
1732 const VariableGEPIndex &Var0 = VarIndices[0], &Var1 = VarIndices[1];
1733
1734 if (Var0.ZExtBits != Var1.ZExtBits || Var0.SExtBits != Var1.SExtBits ||
1735 Var0.Scale != -Var1.Scale)
1736 return false;
1737
1738 unsigned Width = Var1.V->getType()->getIntegerBitWidth();
1739
1740 // We'll strip off the Extensions of Var0 and Var1 and do another round
1741 // of GetLinearExpression decomposition. In the example above, if Var0
1742 // is zext(%x + 1) we should get V1 == %x and V1Offset == 1.
1743
1744 APInt V0Scale(Width, 0), V0Offset(Width, 0), V1Scale(Width, 0),
1745 V1Offset(Width, 0);
1746 bool NSW = true, NUW = true;
1747 unsigned V0ZExtBits = 0, V0SExtBits = 0, V1ZExtBits = 0, V1SExtBits = 0;
1748 const Value *V0 = GetLinearExpression(Var0.V, V0Scale, V0Offset, V0ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001749 V0SExtBits, DL, 0, AC, DT, NSW, NUW);
Richard Trieu7a083812016-02-18 22:09:30 +00001750 NSW = true;
1751 NUW = true;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001752 const Value *V1 = GetLinearExpression(Var1.V, V1Scale, V1Offset, V1ZExtBits,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001753 V1SExtBits, DL, 0, AC, DT, NSW, NUW);
Quentin Colombet5989bc62015-08-31 22:32:47 +00001754
1755 if (V0Scale != V1Scale || V0ZExtBits != V1ZExtBits ||
1756 V0SExtBits != V1SExtBits || !isValueEqualInPotentialCycles(V0, V1))
1757 return false;
1758
1759 // We have a hit - Var0 and Var1 only differ by a constant offset!
1760
1761 // If we've been sext'ed then zext'd the maximum difference between Var0 and
1762 // Var1 is possible to calculate, but we're just interested in the absolute
Benjamin Kramer557b6012015-10-24 11:38:01 +00001763 // minimum difference between the two. The minimum distance may occur due to
Quentin Colombet5989bc62015-08-31 22:32:47 +00001764 // wrapping; consider "add i3 %i, 5": if %i == 7 then 7 + 5 mod 8 == 4, and so
1765 // the minimum distance between %i and %i + 5 is 3.
Benjamin Kramer557b6012015-10-24 11:38:01 +00001766 APInt MinDiff = V0Offset - V1Offset, Wrapped = -MinDiff;
Quentin Colombet5989bc62015-08-31 22:32:47 +00001767 MinDiff = APIntOps::umin(MinDiff, Wrapped);
1768 uint64_t MinDiffBytes = MinDiff.getZExtValue() * std::abs(Var0.Scale);
1769
1770 // We can't definitely say whether GEP1 is before or after V2 due to wrapping
1771 // arithmetic (i.e. for some values of GEP1 and V2 GEP1 < V2, and for other
1772 // values GEP1 > V2). We'll therefore only declare NoAlias if both V1Size and
1773 // V2Size can fit in the MinDiffBytes gap.
1774 return V1Size + std::abs(BaseOffset) <= MinDiffBytes &&
1775 V2Size + std::abs(BaseOffset) <= MinDiffBytes;
1776}
Chandler Carruth7b560d42015-09-09 17:55:00 +00001777
1778//===----------------------------------------------------------------------===//
1779// BasicAliasAnalysis Pass
1780//===----------------------------------------------------------------------===//
1781
Chandler Carruthdab4eae2016-11-23 17:53:26 +00001782AnalysisKey BasicAA::Key;
Chandler Carruthb4faf132016-03-11 10:22:49 +00001783
Sean Silva36e0d012016-08-09 00:28:15 +00001784BasicAAResult BasicAA::run(Function &F, FunctionAnalysisManager &AM) {
Chandler Carruth7b560d42015-09-09 17:55:00 +00001785 return BasicAAResult(F.getParent()->getDataLayout(),
Chandler Carruthb47f8012016-03-11 11:05:24 +00001786 AM.getResult<TargetLibraryAnalysis>(F),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001787 AM.getResult<AssumptionAnalysis>(F),
Chandler Carruth5bfbc3f2016-03-11 13:53:18 +00001788 &AM.getResult<DominatorTreeAnalysis>(F),
Chandler Carruthb47f8012016-03-11 11:05:24 +00001789 AM.getCachedResult<LoopAnalysis>(F));
Chandler Carruth7b560d42015-09-09 17:55:00 +00001790}
1791
Keno Fischer277bfae2015-10-26 21:22:58 +00001792BasicAAWrapperPass::BasicAAWrapperPass() : FunctionPass(ID) {
1793 initializeBasicAAWrapperPassPass(*PassRegistry::getPassRegistry());
1794}
1795
Chandler Carruth7b560d42015-09-09 17:55:00 +00001796char BasicAAWrapperPass::ID = 0;
1797void BasicAAWrapperPass::anchor() {}
1798
1799INITIALIZE_PASS_BEGIN(BasicAAWrapperPass, "basicaa",
1800 "Basic Alias Analysis (stateless AA impl)", true, true)
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001801INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
Chandler Carruth5bfbc3f2016-03-11 13:53:18 +00001802INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
Chandler Carruth7b560d42015-09-09 17:55:00 +00001803INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
1804INITIALIZE_PASS_END(BasicAAWrapperPass, "basicaa",
1805 "Basic Alias Analysis (stateless AA impl)", true, true)
1806
1807FunctionPass *llvm::createBasicAAWrapperPass() {
1808 return new BasicAAWrapperPass();
1809}
1810
1811bool BasicAAWrapperPass::runOnFunction(Function &F) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001812 auto &ACT = getAnalysis<AssumptionCacheTracker>();
Chandler Carruth7b560d42015-09-09 17:55:00 +00001813 auto &TLIWP = getAnalysis<TargetLibraryInfoWrapperPass>();
Chandler Carruth5bfbc3f2016-03-11 13:53:18 +00001814 auto &DTWP = getAnalysis<DominatorTreeWrapperPass>();
Chandler Carruth7b560d42015-09-09 17:55:00 +00001815 auto *LIWP = getAnalysisIfAvailable<LoopInfoWrapperPass>();
1816
1817 Result.reset(new BasicAAResult(F.getParent()->getDataLayout(), TLIWP.getTLI(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001818 ACT.getAssumptionCache(F), &DTWP.getDomTree(),
Chandler Carruth7b560d42015-09-09 17:55:00 +00001819 LIWP ? &LIWP->getLoopInfo() : nullptr));
1820
1821 return false;
1822}
1823
1824void BasicAAWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
1825 AU.setPreservesAll();
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001826 AU.addRequired<AssumptionCacheTracker>();
Chandler Carruth5bfbc3f2016-03-11 13:53:18 +00001827 AU.addRequired<DominatorTreeWrapperPass>();
Chandler Carruth7b560d42015-09-09 17:55:00 +00001828 AU.addRequired<TargetLibraryInfoWrapperPass>();
1829}
1830
1831BasicAAResult llvm::createLegacyPMBasicAAResult(Pass &P, Function &F) {
1832 return BasicAAResult(
1833 F.getParent()->getDataLayout(),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00001834 P.getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(),
1835 P.getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F));
Chandler Carruth7b560d42015-09-09 17:55:00 +00001836}