blob: 9fe136212c451b3274bbd8fc9bdf34e4d3141e81 [file] [log] [blame]
Dan Gohmandb4708c2010-10-19 23:09:08 +00001//===- BasicAliasAnalysis.cpp - Stateless Alias Analysis Impl -------------===//
Misha Brukman2b37d7c2005-04-21 21:13:18 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-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 Brukman2b37d7c2005-04-21 21:13:18 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattnerd501c132003-02-26 19:41:54 +00009//
Dan Gohmandb4708c2010-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 Lattnerd501c132003-02-26 19:41:54 +000013//
14//===----------------------------------------------------------------------===//
15
Jeff Cohen534927d2005-01-08 22:01:16 +000016#include "llvm/Analysis/Passes.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000017#include "llvm/ADT/SmallPtrSet.h"
18#include "llvm/ADT/SmallVector.h"
19#include "llvm/Analysis/AliasAnalysis.h"
20#include "llvm/Analysis/CaptureTracking.h"
21#include "llvm/Analysis/InstructionSimplify.h"
22#include "llvm/Analysis/MemoryBuiltins.h"
23#include "llvm/Analysis/ValueTracking.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000024#include "llvm/IR/Constants.h"
25#include "llvm/IR/DataLayout.h"
26#include "llvm/IR/DerivedTypes.h"
27#include "llvm/IR/Function.h"
28#include "llvm/IR/GlobalAlias.h"
29#include "llvm/IR/GlobalVariable.h"
30#include "llvm/IR/Instructions.h"
31#include "llvm/IR/IntrinsicInst.h"
32#include "llvm/IR/LLVMContext.h"
33#include "llvm/IR/Operator.h"
Chris Lattner4244bb52004-03-15 03:36:49 +000034#include "llvm/Pass.h"
Torok Edwinc25e7582009-07-11 20:10:48 +000035#include "llvm/Support/ErrorHandling.h"
Chris Lattner30963fb2010-08-18 22:07:29 +000036#include "llvm/Support/GetElementPtrTypeIterator.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000037#include "llvm/Target/TargetLibraryInfo.h"
Alkis Evlogimenos20aa4742004-09-03 18:19:51 +000038#include <algorithm>
Chris Lattnerec4e8082003-11-25 18:33:40 +000039using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000040
Chris Lattnerdefa1c82008-06-16 06:30:22 +000041//===----------------------------------------------------------------------===//
42// Useful predicates
43//===----------------------------------------------------------------------===//
Devang Patel794fd752007-05-01 21:15:47 +000044
Chris Lattner845f0d22008-06-16 06:19:11 +000045/// isNonEscapingLocalObject - Return true if the pointer is to a function-local
46/// object that never escapes from the function.
Dan Gohman21de4c02010-07-01 20:08:40 +000047static bool isNonEscapingLocalObject(const Value *V) {
Chris Lattnere7275792008-06-16 06:28:01 +000048 // If this is a local allocation, check to see if it escapes.
Dan Gohman21de4c02010-07-01 20:08:40 +000049 if (isa<AllocaInst>(V) || isNoAliasCall(V))
Dan Gohmanf94b5ed2009-11-19 21:57:48 +000050 // Set StoreCaptures to True so that we can assume in our callers that the
51 // pointer is not the result of a load instruction. Currently
52 // PointerMayBeCaptured doesn't have any special analysis for the
53 // StoreCaptures=false case; if it did, our callers could be refined to be
54 // more precise.
55 return !PointerMayBeCaptured(V, false, /*StoreCaptures=*/true);
Duncan Sands91c9c3102009-01-05 21:19:53 +000056
Chris Lattnere7275792008-06-16 06:28:01 +000057 // If this is an argument that corresponds to a byval or noalias argument,
Duncan Sands91c9c3102009-01-05 21:19:53 +000058 // then it has not escaped before entering the function. Check if it escapes
59 // inside the function.
Dan Gohman21de4c02010-07-01 20:08:40 +000060 if (const Argument *A = dyn_cast<Argument>(V))
Richard Osborne54453332012-11-05 10:48:24 +000061 if (A->hasByValAttr() || A->hasNoAliasAttr())
62 // Note even if the argument is marked nocapture we still need to check
63 // for copies made inside the function. The nocapture attribute only
64 // specifies that there are no copies made that outlive the function.
Dan Gohman21de4c02010-07-01 20:08:40 +000065 return !PointerMayBeCaptured(V, false, /*StoreCaptures=*/true);
Richard Osborne54453332012-11-05 10:48:24 +000066
Chris Lattner845f0d22008-06-16 06:19:11 +000067 return false;
68}
69
Dan Gohman6be2bd52010-06-29 00:50:39 +000070/// isEscapeSource - Return true if the pointer is one which would have
71/// been considered an escape by isNonEscapingLocalObject.
Dan Gohman21de4c02010-07-01 20:08:40 +000072static bool isEscapeSource(const Value *V) {
73 if (isa<CallInst>(V) || isa<InvokeInst>(V) || isa<Argument>(V))
74 return true;
Dan Gohman6be2bd52010-06-29 00:50:39 +000075
76 // The load case works because isNonEscapingLocalObject considers all
77 // stores to be escapes (it passes true for the StoreCaptures argument
78 // to PointerMayBeCaptured).
79 if (isa<LoadInst>(V))
80 return true;
81
82 return false;
83}
Chris Lattner845f0d22008-06-16 06:19:11 +000084
Dan Gohman615da1a2011-01-18 21:16:06 +000085/// getObjectSize - Return the size of the object specified by V, or
86/// UnknownSize if unknown.
Micah Villmow3574eca2012-10-08 16:38:25 +000087static uint64_t getObjectSize(const Value *V, const DataLayout &TD,
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +000088 const TargetLibraryInfo &TLI,
Eli Friedman1680a242012-02-27 20:46:07 +000089 bool RoundToAlign = false) {
Nuno Lopes9e72a792012-06-21 15:45:28 +000090 uint64_t Size;
Nadav Rotem8e4df482013-04-09 18:16:05 +000091 if (getObjectSize(V, Size, &TD, &TLI, RoundToAlign))
Nuno Lopes9e72a792012-06-21 15:45:28 +000092 return Size;
93 return AliasAnalysis::UnknownSize;
Dan Gohman615da1a2011-01-18 21:16:06 +000094}
95
96/// isObjectSmallerThan - Return true if we can prove that the object specified
97/// by V is smaller than Size.
98static bool isObjectSmallerThan(const Value *V, uint64_t Size,
Micah Villmow3574eca2012-10-08 16:38:25 +000099 const DataLayout &TD,
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000100 const TargetLibraryInfo &TLI) {
Nadav Rotem8e4df482013-04-09 18:16:05 +0000101 // Note that the meanings of the "object" are slightly different in the
102 // following contexts:
103 // c1: llvm::getObjectSize()
104 // c2: llvm.objectsize() intrinsic
105 // c3: isObjectSmallerThan()
106 // c1 and c2 share the same meaning; however, the meaning of "object" in c3
107 // refers to the "entire object".
108 //
109 // Consider this example:
110 // char *p = (char*)malloc(100)
111 // char *q = p+80;
112 //
113 // In the context of c1 and c2, the "object" pointed by q refers to the
114 // stretch of memory of q[0:19]. So, getObjectSize(q) should return 20.
115 //
116 // However, in the context of c3, the "object" refers to the chunk of memory
117 // being allocated. So, the "object" has 100 bytes, and q points to the middle
118 // the "object". In case q is passed to isObjectSmallerThan() as the 1st
119 // parameter, before the llvm::getObjectSize() is called to get the size of
120 // entire object, we should:
121 // - either rewind the pointer q to the base-address of the object in
122 // question (in this case rewind to p), or
123 // - just give up. It is up to caller to make sure the pointer is pointing
124 // to the base address the object.
125 //
126 // We go for 2nd option for simplicity.
127 if (!isIdentifiedObject(V))
128 return false;
129
Eli Friedman1680a242012-02-27 20:46:07 +0000130 // This function needs to use the aligned object size because we allow
131 // reads a bit past the end given sufficient alignment.
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000132 uint64_t ObjectSize = getObjectSize(V, TD, TLI, /*RoundToAlign*/true);
Eli Friedman1680a242012-02-27 20:46:07 +0000133
Dan Gohman615da1a2011-01-18 21:16:06 +0000134 return ObjectSize != AliasAnalysis::UnknownSize && ObjectSize < Size;
135}
136
137/// isObjectSize - Return true if we can prove that the object specified
138/// by V has size Size.
139static bool isObjectSize(const Value *V, uint64_t Size,
Micah Villmow3574eca2012-10-08 16:38:25 +0000140 const DataLayout &TD, const TargetLibraryInfo &TLI) {
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000141 uint64_t ObjectSize = getObjectSize(V, TD, TLI);
Dan Gohman615da1a2011-01-18 21:16:06 +0000142 return ObjectSize != AliasAnalysis::UnknownSize && ObjectSize == Size;
Chris Lattnera4139602008-06-16 06:10:11 +0000143}
144
Michael Kuperstein9f5de6d2013-05-28 08:17:48 +0000145/// isIdentifiedFunctionLocal - Return true if V is umabigously identified
146/// at the function-level. Different IdentifiedFunctionLocals can't alias.
147/// Further, an IdentifiedFunctionLocal can not alias with any function
148/// arguments other than itself, which is not neccessarily true for
149/// IdentifiedObjects.
150static bool isIdentifiedFunctionLocal(const Value *V)
151{
152 return isa<AllocaInst>(V) || isNoAliasCall(V) || isNoAliasArgument(V);
153}
154
155
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000156//===----------------------------------------------------------------------===//
Chris Lattner30963fb2010-08-18 22:07:29 +0000157// GetElementPtr Instruction Decomposition and Analysis
158//===----------------------------------------------------------------------===//
159
Chris Lattner8807e9f2010-08-18 22:47:56 +0000160namespace {
161 enum ExtensionKind {
162 EK_NotExtended,
163 EK_SignExt,
164 EK_ZeroExt
165 };
166
167 struct VariableGEPIndex {
168 const Value *V;
169 ExtensionKind Extension;
170 int64_t Scale;
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000171
172 bool operator==(const VariableGEPIndex &Other) const {
173 return V == Other.V && Extension == Other.Extension &&
174 Scale == Other.Scale;
175 }
176
177 bool operator!=(const VariableGEPIndex &Other) const {
178 return !operator==(Other);
179 }
Chris Lattner8807e9f2010-08-18 22:47:56 +0000180 };
181}
182
Chris Lattner30963fb2010-08-18 22:07:29 +0000183
184/// GetLinearExpression - Analyze the specified value as a linear expression:
185/// "A*V + B", where A and B are constant integers. Return the scale and offset
Chris Lattner2215c602010-08-18 23:09:49 +0000186/// values as APInts and return V as a Value*, and return whether we looked
187/// through any sign or zero extends. The incoming Value is known to have
188/// IntegerType and it may already be sign or zero extended.
189///
190/// Note that this looks through extends, so the high bits may not be
191/// represented in the result.
Chris Lattner30963fb2010-08-18 22:07:29 +0000192static Value *GetLinearExpression(Value *V, APInt &Scale, APInt &Offset,
Chris Lattner2215c602010-08-18 23:09:49 +0000193 ExtensionKind &Extension,
Micah Villmow3574eca2012-10-08 16:38:25 +0000194 const DataLayout &TD, unsigned Depth) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000195 assert(V->getType()->isIntegerTy() && "Not an integer value");
196
197 // Limit our recursion depth.
198 if (Depth == 6) {
199 Scale = 1;
200 Offset = 0;
201 return V;
202 }
203
204 if (BinaryOperator *BOp = dyn_cast<BinaryOperator>(V)) {
205 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(BOp->getOperand(1))) {
206 switch (BOp->getOpcode()) {
207 default: break;
208 case Instruction::Or:
209 // X|C == X+C if all the bits in C are unset in X. Otherwise we can't
210 // analyze it.
Chris Lattnerff2efb92010-08-18 22:52:09 +0000211 if (!MaskedValueIsZero(BOp->getOperand(0), RHSC->getValue(), &TD))
Chris Lattner30963fb2010-08-18 22:07:29 +0000212 break;
213 // FALL THROUGH.
214 case Instruction::Add:
Chris Lattner2215c602010-08-18 23:09:49 +0000215 V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, Extension,
216 TD, Depth+1);
Chris Lattner30963fb2010-08-18 22:07:29 +0000217 Offset += RHSC->getValue();
218 return V;
219 case Instruction::Mul:
Chris Lattner2215c602010-08-18 23:09:49 +0000220 V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, Extension,
221 TD, Depth+1);
Chris Lattner30963fb2010-08-18 22:07:29 +0000222 Offset *= RHSC->getValue();
223 Scale *= RHSC->getValue();
224 return V;
225 case Instruction::Shl:
Chris Lattner2215c602010-08-18 23:09:49 +0000226 V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, Extension,
227 TD, Depth+1);
Chris Lattner30963fb2010-08-18 22:07:29 +0000228 Offset <<= RHSC->getValue().getLimitedValue();
229 Scale <<= RHSC->getValue().getLimitedValue();
230 return V;
231 }
232 }
233 }
234
235 // Since GEP indices are sign extended anyway, we don't care about the high
Chris Lattner2215c602010-08-18 23:09:49 +0000236 // bits of a sign or zero extended value - just scales and offsets. The
237 // extensions have to be consistent though.
238 if ((isa<SExtInst>(V) && Extension != EK_ZeroExt) ||
239 (isa<ZExtInst>(V) && Extension != EK_SignExt)) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000240 Value *CastOp = cast<CastInst>(V)->getOperand(0);
241 unsigned OldWidth = Scale.getBitWidth();
242 unsigned SmallWidth = CastOp->getType()->getPrimitiveSizeInBits();
Jay Foad40f8f622010-12-07 08:25:19 +0000243 Scale = Scale.trunc(SmallWidth);
244 Offset = Offset.trunc(SmallWidth);
Chris Lattner2215c602010-08-18 23:09:49 +0000245 Extension = isa<SExtInst>(V) ? EK_SignExt : EK_ZeroExt;
246
247 Value *Result = GetLinearExpression(CastOp, Scale, Offset, Extension,
248 TD, Depth+1);
Jay Foad40f8f622010-12-07 08:25:19 +0000249 Scale = Scale.zext(OldWidth);
250 Offset = Offset.zext(OldWidth);
Chris Lattner2215c602010-08-18 23:09:49 +0000251
Chris Lattner30963fb2010-08-18 22:07:29 +0000252 return Result;
253 }
254
255 Scale = 1;
256 Offset = 0;
257 return V;
258}
259
260/// DecomposeGEPExpression - If V is a symbolic pointer expression, decompose it
261/// into a base pointer with a constant offset and a number of scaled symbolic
262/// offsets.
263///
264/// The scaled symbolic offsets (represented by pairs of a Value* and a scale in
265/// the VarIndices vector) are Value*'s that are known to be scaled by the
266/// specified amount, but which may have other unrepresented high bits. As such,
267/// the gep cannot necessarily be reconstructed from its decomposed form.
268///
Micah Villmow3574eca2012-10-08 16:38:25 +0000269/// When DataLayout is around, this function is capable of analyzing everything
Dan Gohman5034dd32010-12-15 20:02:24 +0000270/// that GetUnderlyingObject can look through. When not, it just looks
Chris Lattner30963fb2010-08-18 22:07:29 +0000271/// through pointer casts.
272///
273static const Value *
274DecomposeGEPExpression(const Value *V, int64_t &BaseOffs,
Chris Lattner8807e9f2010-08-18 22:47:56 +0000275 SmallVectorImpl<VariableGEPIndex> &VarIndices,
Micah Villmow3574eca2012-10-08 16:38:25 +0000276 const DataLayout *TD) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000277 // Limit recursion depth to limit compile time in crazy cases.
278 unsigned MaxLookup = 6;
279
280 BaseOffs = 0;
281 do {
282 // See if this is a bitcast or GEP.
283 const Operator *Op = dyn_cast<Operator>(V);
284 if (Op == 0) {
285 // The only non-operator case we can handle are GlobalAliases.
286 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
287 if (!GA->mayBeOverridden()) {
288 V = GA->getAliasee();
289 continue;
290 }
291 }
292 return V;
293 }
294
295 if (Op->getOpcode() == Instruction::BitCast) {
296 V = Op->getOperand(0);
297 continue;
298 }
Dan Gohmanc01895c2010-12-15 20:49:55 +0000299
Chris Lattner30963fb2010-08-18 22:07:29 +0000300 const GEPOperator *GEPOp = dyn_cast<GEPOperator>(Op);
Dan Gohman9adf1512011-05-24 18:24:08 +0000301 if (GEPOp == 0) {
302 // If it's not a GEP, hand it off to SimplifyInstruction to see if it
303 // can come up with something. This matches what GetUnderlyingObject does.
304 if (const Instruction *I = dyn_cast<Instruction>(V))
305 // TODO: Get a DominatorTree and use it here.
306 if (const Value *Simplified =
307 SimplifyInstruction(const_cast<Instruction *>(I), TD)) {
308 V = Simplified;
309 continue;
310 }
311
Chris Lattner30963fb2010-08-18 22:07:29 +0000312 return V;
Dan Gohman9adf1512011-05-24 18:24:08 +0000313 }
Chris Lattner30963fb2010-08-18 22:07:29 +0000314
315 // Don't attempt to analyze GEPs over unsized objects.
316 if (!cast<PointerType>(GEPOp->getOperand(0)->getType())
317 ->getElementType()->isSized())
318 return V;
319
Micah Villmow3574eca2012-10-08 16:38:25 +0000320 // If we are lacking DataLayout information, we can't compute the offets of
Chris Lattner30963fb2010-08-18 22:07:29 +0000321 // elements computed by GEPs. However, we can handle bitcast equivalent
322 // GEPs.
Chris Lattnerff2efb92010-08-18 22:52:09 +0000323 if (TD == 0) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000324 if (!GEPOp->hasAllZeroIndices())
325 return V;
326 V = GEPOp->getOperand(0);
327 continue;
328 }
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000329
Chris Lattner30963fb2010-08-18 22:07:29 +0000330 // Walk the indices of the GEP, accumulating them into BaseOff/VarIndices.
331 gep_type_iterator GTI = gep_type_begin(GEPOp);
332 for (User::const_op_iterator I = GEPOp->op_begin()+1,
333 E = GEPOp->op_end(); I != E; ++I) {
334 Value *Index = *I;
335 // Compute the (potentially symbolic) offset in bytes for this index.
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000336 if (StructType *STy = dyn_cast<StructType>(*GTI++)) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000337 // For a struct, add the member offset.
338 unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
339 if (FieldNo == 0) continue;
340
341 BaseOffs += TD->getStructLayout(STy)->getElementOffset(FieldNo);
342 continue;
343 }
344
345 // For an array/pointer, add the element offset, explicitly scaled.
346 if (ConstantInt *CIdx = dyn_cast<ConstantInt>(Index)) {
347 if (CIdx->isZero()) continue;
348 BaseOffs += TD->getTypeAllocSize(*GTI)*CIdx->getSExtValue();
349 continue;
350 }
351
352 uint64_t Scale = TD->getTypeAllocSize(*GTI);
Chris Lattner8807e9f2010-08-18 22:47:56 +0000353 ExtensionKind Extension = EK_NotExtended;
Chris Lattner30963fb2010-08-18 22:07:29 +0000354
Chris Lattner2215c602010-08-18 23:09:49 +0000355 // If the integer type is smaller than the pointer size, it is implicitly
356 // sign extended to pointer size.
Chris Lattner30963fb2010-08-18 22:07:29 +0000357 unsigned Width = cast<IntegerType>(Index->getType())->getBitWidth();
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000358 if (TD->getPointerSizeInBits() > Width)
Chris Lattner2215c602010-08-18 23:09:49 +0000359 Extension = EK_SignExt;
360
361 // Use GetLinearExpression to decompose the index into a C1*V+C2 form.
Chris Lattner30963fb2010-08-18 22:07:29 +0000362 APInt IndexScale(Width, 0), IndexOffset(Width, 0);
Chris Lattner2215c602010-08-18 23:09:49 +0000363 Index = GetLinearExpression(Index, IndexScale, IndexOffset, Extension,
364 *TD, 0);
Chris Lattner30963fb2010-08-18 22:07:29 +0000365
366 // The GEP index scale ("Scale") scales C1*V+C2, yielding (C1*V+C2)*Scale.
367 // This gives us an aggregate computation of (C1*Scale)*V + C2*Scale.
Eli Friedman39e30122010-09-15 20:08:03 +0000368 BaseOffs += IndexOffset.getSExtValue()*Scale;
369 Scale *= IndexScale.getSExtValue();
Chris Lattner30963fb2010-08-18 22:07:29 +0000370
371
Chris Lattner7a2bdde2011-04-15 05:18:47 +0000372 // If we already had an occurrence of this index variable, merge this
Chris Lattner30963fb2010-08-18 22:07:29 +0000373 // scale into it. For example, we want to handle:
374 // A[x][x] -> x*16 + x*4 -> x*20
375 // This also ensures that 'x' only appears in the index list once.
376 for (unsigned i = 0, e = VarIndices.size(); i != e; ++i) {
Chris Lattner8807e9f2010-08-18 22:47:56 +0000377 if (VarIndices[i].V == Index &&
378 VarIndices[i].Extension == Extension) {
379 Scale += VarIndices[i].Scale;
Chris Lattner30963fb2010-08-18 22:07:29 +0000380 VarIndices.erase(VarIndices.begin()+i);
381 break;
382 }
383 }
384
385 // Make sure that we have a scale that makes sense for this target's
386 // pointer size.
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000387 if (unsigned ShiftBits = 64-TD->getPointerSizeInBits()) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000388 Scale <<= ShiftBits;
Eli Friedman39e30122010-09-15 20:08:03 +0000389 Scale = (int64_t)Scale >> ShiftBits;
Chris Lattner30963fb2010-08-18 22:07:29 +0000390 }
391
Chris Lattner8807e9f2010-08-18 22:47:56 +0000392 if (Scale) {
Jeffrey Yasskina44defe2011-07-27 06:22:51 +0000393 VariableGEPIndex Entry = {Index, Extension,
394 static_cast<int64_t>(Scale)};
Chris Lattner8807e9f2010-08-18 22:47:56 +0000395 VarIndices.push_back(Entry);
396 }
Chris Lattner30963fb2010-08-18 22:07:29 +0000397 }
398
399 // Analyze the base pointer next.
400 V = GEPOp->getOperand(0);
401 } while (--MaxLookup);
402
403 // If the chain of expressions is too deep, just return early.
404 return V;
405}
406
407/// GetIndexDifference - Dest and Src are the variable indices from two
408/// decomposed GetElementPtr instructions GEP1 and GEP2 which have common base
409/// pointers. Subtract the GEP2 indices from GEP1 to find the symbolic
410/// difference between the two pointers.
Chris Lattner8807e9f2010-08-18 22:47:56 +0000411static void GetIndexDifference(SmallVectorImpl<VariableGEPIndex> &Dest,
412 const SmallVectorImpl<VariableGEPIndex> &Src) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000413 if (Src.empty()) return;
414
415 for (unsigned i = 0, e = Src.size(); i != e; ++i) {
Chris Lattner8807e9f2010-08-18 22:47:56 +0000416 const Value *V = Src[i].V;
417 ExtensionKind Extension = Src[i].Extension;
418 int64_t Scale = Src[i].Scale;
Chris Lattner30963fb2010-08-18 22:07:29 +0000419
420 // Find V in Dest. This is N^2, but pointer indices almost never have more
421 // than a few variable indexes.
422 for (unsigned j = 0, e = Dest.size(); j != e; ++j) {
Chris Lattner8807e9f2010-08-18 22:47:56 +0000423 if (Dest[j].V != V || Dest[j].Extension != Extension) continue;
Chris Lattner30963fb2010-08-18 22:07:29 +0000424
425 // If we found it, subtract off Scale V's from the entry in Dest. If it
426 // goes to zero, remove the entry.
Chris Lattner8807e9f2010-08-18 22:47:56 +0000427 if (Dest[j].Scale != Scale)
428 Dest[j].Scale -= Scale;
Chris Lattner30963fb2010-08-18 22:07:29 +0000429 else
430 Dest.erase(Dest.begin()+j);
431 Scale = 0;
432 break;
433 }
434
435 // If we didn't consume this entry, add it to the end of the Dest list.
Chris Lattner8807e9f2010-08-18 22:47:56 +0000436 if (Scale) {
437 VariableGEPIndex Entry = { V, Extension, -Scale };
438 Dest.push_back(Entry);
439 }
Chris Lattner30963fb2010-08-18 22:07:29 +0000440 }
441}
442
443//===----------------------------------------------------------------------===//
Dan Gohman6be2bd52010-06-29 00:50:39 +0000444// BasicAliasAnalysis Pass
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000445//===----------------------------------------------------------------------===//
446
Dan Gohman9e86f432010-07-07 14:27:09 +0000447#ifndef NDEBUG
Dan Gohman6be2bd52010-06-29 00:50:39 +0000448static const Function *getParent(const Value *V) {
Dan Gohman6f205cb2010-06-29 18:12:34 +0000449 if (const Instruction *inst = dyn_cast<Instruction>(V))
Dan Gohman6be2bd52010-06-29 00:50:39 +0000450 return inst->getParent()->getParent();
451
Dan Gohman6f205cb2010-06-29 18:12:34 +0000452 if (const Argument *arg = dyn_cast<Argument>(V))
Dan Gohman6be2bd52010-06-29 00:50:39 +0000453 return arg->getParent();
454
455 return NULL;
456}
457
Dan Gohman21de4c02010-07-01 20:08:40 +0000458static bool notDifferentParent(const Value *O1, const Value *O2) {
459
460 const Function *F1 = getParent(O1);
461 const Function *F2 = getParent(O2);
462
Dan Gohman6be2bd52010-06-29 00:50:39 +0000463 return !F1 || !F2 || F1 == F2;
464}
Benjamin Kramer3432d702010-06-29 10:03:11 +0000465#endif
Dan Gohman6be2bd52010-06-29 00:50:39 +0000466
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000467namespace {
Dan Gohmandb4708c2010-10-19 23:09:08 +0000468 /// BasicAliasAnalysis - This is the primary alias analysis implementation.
469 struct BasicAliasAnalysis : public ImmutablePass, public AliasAnalysis {
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000470 static char ID; // Class identification, replacement for typeinfo
Benjamin Kramer998d3cc2012-09-05 16:49:37 +0000471 BasicAliasAnalysis() : ImmutablePass(ID) {
Owen Anderson081c34b2010-10-19 17:21:58 +0000472 initializeBasicAliasAnalysisPass(*PassRegistry::getPassRegistry());
473 }
Dan Gohman6be2bd52010-06-29 00:50:39 +0000474
Dan Gohmanc1be92f2010-10-18 18:04:47 +0000475 virtual void initializePass() {
476 InitializeAliasAnalysis(this);
477 }
478
479 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
480 AU.addRequired<AliasAnalysis>();
Owen Anderson69acc932011-09-06 23:33:25 +0000481 AU.addRequired<TargetLibraryInfo>();
Dan Gohmanc1be92f2010-10-18 18:04:47 +0000482 }
483
Dan Gohmanb2143b62010-09-14 21:25:10 +0000484 virtual AliasResult alias(const Location &LocA,
485 const Location &LocB) {
Dan Gohman1fc18d72011-06-04 00:31:50 +0000486 assert(AliasCache.empty() && "AliasCache must be cleared after use!");
Dan Gohmanb2143b62010-09-14 21:25:10 +0000487 assert(notDifferentParent(LocA.Ptr, LocB.Ptr) &&
Dan Gohman9e86f432010-07-07 14:27:09 +0000488 "BasicAliasAnalysis doesn't support interprocedural queries.");
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000489 AliasResult Alias = aliasCheck(LocA.Ptr, LocA.Size, LocA.TBAATag,
490 LocB.Ptr, LocB.Size, LocB.TBAATag);
Benjamin Kramer998d3cc2012-09-05 16:49:37 +0000491 // AliasCache rarely has more than 1 or 2 elements, always use
492 // shrink_and_clear so it quickly returns to the inline capacity of the
493 // SmallDenseMap if it ever grows larger.
494 // FIXME: This should really be shrink_to_inline_capacity_and_clear().
495 AliasCache.shrink_and_clear();
Evan Chengf0429fd2009-10-14 06:46:26 +0000496 return Alias;
Evan Cheng50a59142009-10-13 22:02:20 +0000497 }
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000498
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000499 virtual ModRefResult getModRefInfo(ImmutableCallSite CS,
Dan Gohmanb2143b62010-09-14 21:25:10 +0000500 const Location &Loc);
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000501
502 virtual ModRefResult getModRefInfo(ImmutableCallSite CS1,
503 ImmutableCallSite CS2) {
504 // The AliasAnalysis base class has some smarts, lets use them.
505 return AliasAnalysis::getModRefInfo(CS1, CS2);
506 }
Owen Andersone7942202009-02-05 23:36:27 +0000507
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000508 /// pointsToConstantMemory - Chase pointers until we find a (constant
509 /// global) or not.
Dan Gohmana25e5db2010-11-08 16:45:26 +0000510 virtual bool pointsToConstantMemory(const Location &Loc, bool OrLocal);
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000511
512 /// getModRefBehavior - Return the behavior when calling the given
513 /// call site.
514 virtual ModRefBehavior getModRefBehavior(ImmutableCallSite CS);
515
516 /// getModRefBehavior - Return the behavior when calling the given function.
517 /// For use when the call site is not known.
518 virtual ModRefBehavior getModRefBehavior(const Function *F);
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000519
Chris Lattner20330972010-01-20 19:26:14 +0000520 /// getAdjustedAnalysisPointer - This method is used when a pass implements
Dan Gohman5eeb19d2010-08-05 23:48:14 +0000521 /// an analysis interface through multiple inheritance. If needed, it
522 /// should override this to adjust the this pointer as needed for the
523 /// specified pass info.
Owen Anderson90c579d2010-08-06 18:33:48 +0000524 virtual void *getAdjustedAnalysisPointer(const void *ID) {
525 if (ID == &AliasAnalysis::ID)
Chris Lattner20330972010-01-20 19:26:14 +0000526 return (AliasAnalysis*)this;
527 return this;
528 }
529
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000530 private:
Dan Gohman1fc18d72011-06-04 00:31:50 +0000531 // AliasCache - Track alias queries to guard against recursion.
532 typedef std::pair<Location, Location> LocPair;
Benjamin Kramer998d3cc2012-09-05 16:49:37 +0000533 typedef SmallDenseMap<LocPair, AliasResult, 8> AliasCacheTy;
Dan Gohman1fc18d72011-06-04 00:31:50 +0000534 AliasCacheTy AliasCache;
535
536 // Visited - Track instructions visited by pointsToConstantMemory.
Dan Gohman50f424c2010-06-28 21:16:52 +0000537 SmallPtrSet<const Value*, 16> Visited;
Evan Cheng3dbe43b2009-10-14 05:05:02 +0000538
Chris Lattner5d56b2d2009-11-23 16:45:27 +0000539 // aliasGEP - Provide a bunch of ad-hoc rules to disambiguate a GEP
540 // instruction against another.
Dan Gohman3da848b2010-10-19 22:54:46 +0000541 AliasResult aliasGEP(const GEPOperator *V1, uint64_t V1Size,
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000542 const MDNode *V1TBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +0000543 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000544 const MDNode *V2TBAAInfo,
Chris Lattner23e2a5b2009-11-26 02:14:59 +0000545 const Value *UnderlyingV1, const Value *UnderlyingV2);
Evan Cheng50a59142009-10-13 22:02:20 +0000546
Chris Lattner5d56b2d2009-11-23 16:45:27 +0000547 // aliasPHI - Provide a bunch of ad-hoc rules to disambiguate a PHI
548 // instruction against another.
Dan Gohman3da848b2010-10-19 22:54:46 +0000549 AliasResult aliasPHI(const PHINode *PN, uint64_t PNSize,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000550 const MDNode *PNTBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +0000551 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000552 const MDNode *V2TBAAInfo);
Evan Cheng50a59142009-10-13 22:02:20 +0000553
Dan Gohman6665b0e2009-10-26 21:55:43 +0000554 /// aliasSelect - Disambiguate a Select instruction against another value.
Dan Gohman3da848b2010-10-19 22:54:46 +0000555 AliasResult aliasSelect(const SelectInst *SI, uint64_t SISize,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000556 const MDNode *SITBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +0000557 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000558 const MDNode *V2TBAAInfo);
Dan Gohman6665b0e2009-10-26 21:55:43 +0000559
Dan Gohman3da848b2010-10-19 22:54:46 +0000560 AliasResult aliasCheck(const Value *V1, uint64_t V1Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000561 const MDNode *V1TBAATag,
Dan Gohman3da848b2010-10-19 22:54:46 +0000562 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000563 const MDNode *V2TBAATag);
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000564 };
565} // End of anonymous namespace
566
567// Register this pass...
568char BasicAliasAnalysis::ID = 0;
Owen Anderson69acc932011-09-06 23:33:25 +0000569INITIALIZE_AG_PASS_BEGIN(BasicAliasAnalysis, AliasAnalysis, "basicaa",
Dan Gohmandb4708c2010-10-19 23:09:08 +0000570 "Basic Alias Analysis (stateless AA impl)",
Dan Gohmanc1be92f2010-10-18 18:04:47 +0000571 false, true, false)
Owen Anderson69acc932011-09-06 23:33:25 +0000572INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfo)
573INITIALIZE_AG_PASS_END(BasicAliasAnalysis, AliasAnalysis, "basicaa",
574 "Basic Alias Analysis (stateless AA impl)",
575 false, true, false)
576
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000577
578ImmutablePass *llvm::createBasicAliasAnalysisPass() {
579 return new BasicAliasAnalysis();
580}
581
Dan Gohmana25e5db2010-11-08 16:45:26 +0000582/// pointsToConstantMemory - Returns whether the given pointer value
583/// points to memory that is local to the function, with global constants being
584/// considered local to all functions.
585bool
586BasicAliasAnalysis::pointsToConstantMemory(const Location &Loc, bool OrLocal) {
587 assert(Visited.empty() && "Visited must be cleared after use!");
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000588
Dan Gohman3fcfc9f2010-11-08 20:26:19 +0000589 unsigned MaxLookup = 8;
Dan Gohmana25e5db2010-11-08 16:45:26 +0000590 SmallVector<const Value *, 16> Worklist;
591 Worklist.push_back(Loc.Ptr);
592 do {
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000593 const Value *V = GetUnderlyingObject(Worklist.pop_back_val(), TD);
Dan Gohmana25e5db2010-11-08 16:45:26 +0000594 if (!Visited.insert(V)) {
595 Visited.clear();
596 return AliasAnalysis::pointsToConstantMemory(Loc, OrLocal);
597 }
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000598
Dan Gohmana25e5db2010-11-08 16:45:26 +0000599 // An alloca instruction defines local memory.
600 if (OrLocal && isa<AllocaInst>(V))
601 continue;
602
603 // A global constant counts as local memory for our purposes.
604 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
605 // Note: this doesn't require GV to be "ODR" because it isn't legal for a
606 // global to be marked constant in some modules and non-constant in
607 // others. GV may even be a declaration, not a definition.
608 if (!GV->isConstant()) {
609 Visited.clear();
610 return AliasAnalysis::pointsToConstantMemory(Loc, OrLocal);
611 }
612 continue;
613 }
614
615 // If both select values point to local memory, then so does the select.
616 if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
617 Worklist.push_back(SI->getTrueValue());
618 Worklist.push_back(SI->getFalseValue());
619 continue;
620 }
621
622 // If all values incoming to a phi node point to local memory, then so does
623 // the phi.
624 if (const PHINode *PN = dyn_cast<PHINode>(V)) {
Dan Gohman3fcfc9f2010-11-08 20:26:19 +0000625 // Don't bother inspecting phi nodes with many operands.
626 if (PN->getNumIncomingValues() > MaxLookup) {
627 Visited.clear();
628 return AliasAnalysis::pointsToConstantMemory(Loc, OrLocal);
629 }
Dan Gohmana25e5db2010-11-08 16:45:26 +0000630 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
631 Worklist.push_back(PN->getIncomingValue(i));
632 continue;
633 }
634
635 // Otherwise be conservative.
636 Visited.clear();
637 return AliasAnalysis::pointsToConstantMemory(Loc, OrLocal);
638
Dan Gohman3fcfc9f2010-11-08 20:26:19 +0000639 } while (!Worklist.empty() && --MaxLookup);
Dan Gohmana25e5db2010-11-08 16:45:26 +0000640
641 Visited.clear();
Dan Gohman3fcfc9f2010-11-08 20:26:19 +0000642 return Worklist.empty();
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000643}
644
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000645/// getModRefBehavior - Return the behavior when calling the given call site.
646AliasAnalysis::ModRefBehavior
647BasicAliasAnalysis::getModRefBehavior(ImmutableCallSite CS) {
648 if (CS.doesNotAccessMemory())
649 // Can't do better than this.
650 return DoesNotAccessMemory;
651
652 ModRefBehavior Min = UnknownModRefBehavior;
653
654 // If the callsite knows it only reads memory, don't return worse
655 // than that.
656 if (CS.onlyReadsMemory())
657 Min = OnlyReadsMemory;
658
659 // The AliasAnalysis base class has some smarts, lets use them.
Dan Gohman42c31a72010-11-10 01:02:18 +0000660 return ModRefBehavior(AliasAnalysis::getModRefBehavior(CS) & Min);
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000661}
662
663/// getModRefBehavior - Return the behavior when calling the given function.
664/// For use when the call site is not known.
665AliasAnalysis::ModRefBehavior
666BasicAliasAnalysis::getModRefBehavior(const Function *F) {
Dan Gohman431c794a2010-11-08 16:08:43 +0000667 // If the function declares it doesn't access memory, we can't do better.
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000668 if (F->doesNotAccessMemory())
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000669 return DoesNotAccessMemory;
Dan Gohman431c794a2010-11-08 16:08:43 +0000670
671 // For intrinsics, we can check the table.
672 if (unsigned iid = F->getIntrinsicID()) {
673#define GET_INTRINSIC_MODREF_BEHAVIOR
Chandler Carruth351ba142013-01-02 12:09:16 +0000674#include "llvm/IR/Intrinsics.gen"
Dan Gohman431c794a2010-11-08 16:08:43 +0000675#undef GET_INTRINSIC_MODREF_BEHAVIOR
676 }
677
Dan Gohman42c31a72010-11-10 01:02:18 +0000678 ModRefBehavior Min = UnknownModRefBehavior;
679
Dan Gohman431c794a2010-11-08 16:08:43 +0000680 // If the function declares it only reads memory, go with that.
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000681 if (F->onlyReadsMemory())
Dan Gohman42c31a72010-11-10 01:02:18 +0000682 Min = OnlyReadsMemory;
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000683
Dan Gohman431c794a2010-11-08 16:08:43 +0000684 // Otherwise be conservative.
Dan Gohman42c31a72010-11-10 01:02:18 +0000685 return ModRefBehavior(AliasAnalysis::getModRefBehavior(F) & Min);
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000686}
Owen Andersone7942202009-02-05 23:36:27 +0000687
Chris Lattner5d56b2d2009-11-23 16:45:27 +0000688/// getModRefInfo - Check to see if the specified callsite can clobber the
689/// specified memory object. Since we only look at local properties of this
690/// function, we really can't say much about this query. We do, however, use
691/// simple "address taken" analysis on local objects.
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000692AliasAnalysis::ModRefResult
Dan Gohman79fca6f2010-08-03 21:48:53 +0000693BasicAliasAnalysis::getModRefInfo(ImmutableCallSite CS,
Dan Gohmanb2143b62010-09-14 21:25:10 +0000694 const Location &Loc) {
695 assert(notDifferentParent(CS.getInstruction(), Loc.Ptr) &&
Dan Gohman9e86f432010-07-07 14:27:09 +0000696 "AliasAnalysis query involving multiple functions!");
697
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000698 const Value *Object = GetUnderlyingObject(Loc.Ptr, TD);
Chris Lattner92e803c2009-11-22 16:05:05 +0000699
Dan Gohmanb2143b62010-09-14 21:25:10 +0000700 // If this is a tail call and Loc.Ptr points to a stack location, we know that
Chris Lattner92e803c2009-11-22 16:05:05 +0000701 // the tail call cannot access or modify the local stack.
702 // We cannot exclude byval arguments here; these belong to the caller of
703 // the current function not to the current function, and a tail callee
704 // may reference them.
705 if (isa<AllocaInst>(Object))
Dan Gohman79fca6f2010-08-03 21:48:53 +0000706 if (const CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
Chris Lattner92e803c2009-11-22 16:05:05 +0000707 if (CI->isTailCall())
708 return NoModRef;
709
710 // If the pointer is to a locally allocated object that does not escape,
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000711 // then the call can not mod/ref the pointer unless the call takes the pointer
712 // as an argument, and itself doesn't capture it.
Chris Lattner403ac2e2009-11-23 16:46:41 +0000713 if (!isa<Constant>(Object) && CS.getInstruction() != Object &&
Dan Gohman21de4c02010-07-01 20:08:40 +0000714 isNonEscapingLocalObject(Object)) {
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000715 bool PassedAsArg = false;
716 unsigned ArgNo = 0;
Dan Gohman79fca6f2010-08-03 21:48:53 +0000717 for (ImmutableCallSite::arg_iterator CI = CS.arg_begin(), CE = CS.arg_end();
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000718 CI != CE; ++CI, ++ArgNo) {
Chris Lattnerc10ecd82011-05-23 05:15:43 +0000719 // Only look at the no-capture or byval pointer arguments. If this
720 // pointer were passed to arguments that were neither of these, then it
721 // couldn't be no-capture.
Duncan Sands1df98592010-02-16 11:11:14 +0000722 if (!(*CI)->getType()->isPointerTy() ||
Nick Lewycky173862e2011-11-20 19:09:04 +0000723 (!CS.doesNotCapture(ArgNo) && !CS.isByValArgument(ArgNo)))
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000724 continue;
725
Dan Gohmanb2143b62010-09-14 21:25:10 +0000726 // If this is a no-capture pointer argument, see if we can tell that it
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000727 // is impossible to alias the pointer we're checking. If not, we have to
728 // assume that the call could touch the pointer, even though it doesn't
729 // escape.
Eli Friedmane6fadce2011-09-28 00:34:27 +0000730 if (!isNoAlias(Location(*CI), Location(Object))) {
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000731 PassedAsArg = true;
732 break;
733 }
734 }
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000735
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000736 if (!PassedAsArg)
Chris Lattner92e803c2009-11-22 16:05:05 +0000737 return NoModRef;
738 }
739
Owen Anderson69acc932011-09-06 23:33:25 +0000740 const TargetLibraryInfo &TLI = getAnalysis<TargetLibraryInfo>();
Dan Gohman42c31a72010-11-10 01:02:18 +0000741 ModRefResult Min = ModRef;
742
Chris Lattner92e803c2009-11-22 16:05:05 +0000743 // Finally, handle specific knowledge of intrinsics.
Dan Gohman79fca6f2010-08-03 21:48:53 +0000744 const IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction());
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000745 if (II != 0)
746 switch (II->getIntrinsicID()) {
747 default: break;
748 case Intrinsic::memcpy:
749 case Intrinsic::memmove: {
Dan Gohman3da848b2010-10-19 22:54:46 +0000750 uint64_t Len = UnknownSize;
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000751 if (ConstantInt *LenCI = dyn_cast<ConstantInt>(II->getArgOperand(2)))
752 Len = LenCI->getZExtValue();
Gabor Greif71339c92010-06-23 23:38:07 +0000753 Value *Dest = II->getArgOperand(0);
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000754 Value *Src = II->getArgOperand(1);
Chris Lattner13815d92010-11-30 00:43:16 +0000755 // If it can't overlap the source dest, then it doesn't modref the loc.
Dan Gohmanb2143b62010-09-14 21:25:10 +0000756 if (isNoAlias(Location(Dest, Len), Loc)) {
757 if (isNoAlias(Location(Src, Len), Loc))
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000758 return NoModRef;
Chris Lattner13815d92010-11-30 00:43:16 +0000759 // If it can't overlap the dest, then worst case it reads the loc.
Dan Gohman42c31a72010-11-10 01:02:18 +0000760 Min = Ref;
Chris Lattner13815d92010-11-30 00:43:16 +0000761 } else if (isNoAlias(Location(Src, Len), Loc)) {
762 // If it can't overlap the source, then worst case it mutates the loc.
763 Min = Mod;
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000764 }
765 break;
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000766 }
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000767 case Intrinsic::memset:
768 // Since memset is 'accesses arguments' only, the AliasAnalysis base class
769 // will handle it for the variable length case.
770 if (ConstantInt *LenCI = dyn_cast<ConstantInt>(II->getArgOperand(2))) {
Dan Gohman3da848b2010-10-19 22:54:46 +0000771 uint64_t Len = LenCI->getZExtValue();
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000772 Value *Dest = II->getArgOperand(0);
Dan Gohmanb2143b62010-09-14 21:25:10 +0000773 if (isNoAlias(Location(Dest, Len), Loc))
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000774 return NoModRef;
775 }
Chris Lattner201d1e52010-11-30 00:28:45 +0000776 // We know that memset doesn't load anything.
777 Min = Mod;
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000778 break;
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000779 case Intrinsic::lifetime_start:
780 case Intrinsic::lifetime_end:
781 case Intrinsic::invariant_start: {
Dan Gohman3da848b2010-10-19 22:54:46 +0000782 uint64_t PtrSize =
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000783 cast<ConstantInt>(II->getArgOperand(0))->getZExtValue();
Dan Gohmanb2143b62010-09-14 21:25:10 +0000784 if (isNoAlias(Location(II->getArgOperand(1),
785 PtrSize,
786 II->getMetadata(LLVMContext::MD_tbaa)),
787 Loc))
Chris Lattner92e803c2009-11-22 16:05:05 +0000788 return NoModRef;
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000789 break;
Nick Lewycky5c9be672009-10-13 07:48:38 +0000790 }
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000791 case Intrinsic::invariant_end: {
Dan Gohman3da848b2010-10-19 22:54:46 +0000792 uint64_t PtrSize =
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000793 cast<ConstantInt>(II->getArgOperand(1))->getZExtValue();
Dan Gohmanb2143b62010-09-14 21:25:10 +0000794 if (isNoAlias(Location(II->getArgOperand(2),
795 PtrSize,
796 II->getMetadata(LLVMContext::MD_tbaa)),
797 Loc))
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000798 return NoModRef;
799 break;
800 }
Dan Gohman1d7e8182011-04-27 20:44:28 +0000801 case Intrinsic::arm_neon_vld1: {
802 // LLVM's vld1 and vst1 intrinsics currently only support a single
803 // vector register.
804 uint64_t Size =
805 TD ? TD->getTypeStoreSize(II->getType()) : UnknownSize;
806 if (isNoAlias(Location(II->getArgOperand(0), Size,
807 II->getMetadata(LLVMContext::MD_tbaa)),
808 Loc))
809 return NoModRef;
810 break;
811 }
812 case Intrinsic::arm_neon_vst1: {
813 uint64_t Size =
814 TD ? TD->getTypeStoreSize(II->getArgOperand(1)->getType()) : UnknownSize;
815 if (isNoAlias(Location(II->getArgOperand(0), Size,
816 II->getMetadata(LLVMContext::MD_tbaa)),
817 Loc))
818 return NoModRef;
819 break;
820 }
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000821 }
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000822
Owen Anderson69acc932011-09-06 23:33:25 +0000823 // We can bound the aliasing properties of memset_pattern16 just as we can
824 // for memcpy/memset. This is particularly important because the
825 // LoopIdiomRecognizer likes to turn loops into calls to memset_pattern16
826 // whenever possible.
827 else if (TLI.has(LibFunc::memset_pattern16) &&
828 CS.getCalledFunction() &&
829 CS.getCalledFunction()->getName() == "memset_pattern16") {
830 const Function *MS = CS.getCalledFunction();
831 FunctionType *MemsetType = MS->getFunctionType();
832 if (!MemsetType->isVarArg() && MemsetType->getNumParams() == 3 &&
833 isa<PointerType>(MemsetType->getParamType(0)) &&
834 isa<PointerType>(MemsetType->getParamType(1)) &&
835 isa<IntegerType>(MemsetType->getParamType(2))) {
836 uint64_t Len = UnknownSize;
837 if (const ConstantInt *LenCI = dyn_cast<ConstantInt>(CS.getArgument(2)))
838 Len = LenCI->getZExtValue();
839 const Value *Dest = CS.getArgument(0);
840 const Value *Src = CS.getArgument(1);
841 // If it can't overlap the source dest, then it doesn't modref the loc.
842 if (isNoAlias(Location(Dest, Len), Loc)) {
Owen Andersone421ad62011-09-06 23:43:26 +0000843 // Always reads 16 bytes of the source.
844 if (isNoAlias(Location(Src, 16), Loc))
Owen Anderson69acc932011-09-06 23:33:25 +0000845 return NoModRef;
846 // If it can't overlap the dest, then worst case it reads the loc.
847 Min = Ref;
Owen Andersone421ad62011-09-06 23:43:26 +0000848 // Always reads 16 bytes of the source.
849 } else if (isNoAlias(Location(Src, 16), Loc)) {
Owen Anderson69acc932011-09-06 23:33:25 +0000850 // If it can't overlap the source, then worst case it mutates the loc.
851 Min = Mod;
852 }
853 }
854 }
855
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000856 // The AliasAnalysis base class has some smarts, lets use them.
Dan Gohman42c31a72010-11-10 01:02:18 +0000857 return ModRefResult(AliasAnalysis::getModRefInfo(CS, Loc) & Min);
Dan Gohman65924112010-09-08 01:32:20 +0000858}
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000859
Craig Toppera0ec3f92013-07-14 04:42:23 +0000860static bool areVarIndicesEqual(SmallVectorImpl<VariableGEPIndex> &Indices1,
861 SmallVectorImpl<VariableGEPIndex> &Indices2) {
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000862 unsigned Size1 = Indices1.size();
863 unsigned Size2 = Indices2.size();
864
865 if (Size1 != Size2)
866 return false;
867
868 for (unsigned I = 0; I != Size1; ++I)
869 if (Indices1[I] != Indices2[I])
870 return false;
871
872 return true;
873}
874
Chris Lattner539c9b92009-11-26 02:11:08 +0000875/// aliasGEP - Provide a bunch of ad-hoc rules to disambiguate a GEP instruction
876/// against another pointer. We know that V1 is a GEP, but we don't know
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000877/// anything about V2. UnderlyingV1 is GetUnderlyingObject(GEP1, TD),
Chris Lattner23e2a5b2009-11-26 02:14:59 +0000878/// UnderlyingV2 is the same for V2.
Chris Lattner539c9b92009-11-26 02:11:08 +0000879///
Chris Lattnerd501c132003-02-26 19:41:54 +0000880AliasAnalysis::AliasResult
Dan Gohman3da848b2010-10-19 22:54:46 +0000881BasicAliasAnalysis::aliasGEP(const GEPOperator *GEP1, uint64_t V1Size,
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000882 const MDNode *V1TBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +0000883 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000884 const MDNode *V2TBAAInfo,
Chris Lattner23e2a5b2009-11-26 02:14:59 +0000885 const Value *UnderlyingV1,
886 const Value *UnderlyingV2) {
Chris Lattnerd84eb912009-11-26 02:17:34 +0000887 int64_t GEP1BaseOffset;
Chris Lattner8807e9f2010-08-18 22:47:56 +0000888 SmallVector<VariableGEPIndex, 4> GEP1VariableIndices;
Chris Lattnerd84eb912009-11-26 02:17:34 +0000889
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000890 // If we have two gep instructions with must-alias or not-alias'ing base
891 // pointers, figure out if the indexes to the GEP tell us anything about the
892 // derived pointer.
Chris Lattner539c9b92009-11-26 02:11:08 +0000893 if (const GEPOperator *GEP2 = dyn_cast<GEPOperator>(V2)) {
Arnold Schwaighofer742dbc12013-03-26 18:07:53 +0000894 // Do the base pointers alias?
895 AliasResult BaseAlias = aliasCheck(UnderlyingV1, UnknownSize, 0,
896 UnderlyingV2, UnknownSize, 0);
897
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000898 // Check for geps of non-aliasing underlying pointers where the offsets are
899 // identical.
Arnold Schwaighofer742dbc12013-03-26 18:07:53 +0000900 if ((BaseAlias == MayAlias) && V1Size == V2Size) {
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000901 // Do the base pointers alias assuming type and size.
902 AliasResult PreciseBaseAlias = aliasCheck(UnderlyingV1, V1Size,
903 V1TBAAInfo, UnderlyingV2,
904 V2Size, V2TBAAInfo);
905 if (PreciseBaseAlias == NoAlias) {
906 // See if the computed offset from the common pointer tells us about the
907 // relation of the resulting pointer.
908 int64_t GEP2BaseOffset;
909 SmallVector<VariableGEPIndex, 4> GEP2VariableIndices;
910 const Value *GEP2BasePtr =
911 DecomposeGEPExpression(GEP2, GEP2BaseOffset, GEP2VariableIndices, TD);
912 const Value *GEP1BasePtr =
913 DecomposeGEPExpression(GEP1, GEP1BaseOffset, GEP1VariableIndices, TD);
914 // DecomposeGEPExpression and GetUnderlyingObject should return the
Micah Villmow3574eca2012-10-08 16:38:25 +0000915 // same result except when DecomposeGEPExpression has no DataLayout.
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000916 if (GEP1BasePtr != UnderlyingV1 || GEP2BasePtr != UnderlyingV2) {
917 assert(TD == 0 &&
918 "DecomposeGEPExpression and GetUnderlyingObject disagree!");
919 return MayAlias;
920 }
921 // Same offsets.
922 if (GEP1BaseOffset == GEP2BaseOffset &&
923 areVarIndicesEqual(GEP1VariableIndices, GEP2VariableIndices))
924 return NoAlias;
925 GEP1VariableIndices.clear();
926 }
927 }
Chris Lattnerd84eb912009-11-26 02:17:34 +0000928
929 // If we get a No or May, then return it immediately, no amount of analysis
930 // will improve this situation.
931 if (BaseAlias != MustAlias) return BaseAlias;
932
933 // Otherwise, we have a MustAlias. Since the base pointers alias each other
934 // exactly, see if the computed offset from the common pointer tells us
935 // about the relation of the resulting pointer.
936 const Value *GEP1BasePtr =
937 DecomposeGEPExpression(GEP1, GEP1BaseOffset, GEP1VariableIndices, TD);
938
939 int64_t GEP2BaseOffset;
Chris Lattner8807e9f2010-08-18 22:47:56 +0000940 SmallVector<VariableGEPIndex, 4> GEP2VariableIndices;
Chris Lattnerd84eb912009-11-26 02:17:34 +0000941 const Value *GEP2BasePtr =
942 DecomposeGEPExpression(GEP2, GEP2BaseOffset, GEP2VariableIndices, TD);
943
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000944 // DecomposeGEPExpression and GetUnderlyingObject should return the
Micah Villmow3574eca2012-10-08 16:38:25 +0000945 // same result except when DecomposeGEPExpression has no DataLayout.
Chris Lattnerd84eb912009-11-26 02:17:34 +0000946 if (GEP1BasePtr != UnderlyingV1 || GEP2BasePtr != UnderlyingV2) {
947 assert(TD == 0 &&
Dan Gohman5034dd32010-12-15 20:02:24 +0000948 "DecomposeGEPExpression and GetUnderlyingObject disagree!");
Chris Lattnerd84eb912009-11-26 02:17:34 +0000949 return MayAlias;
950 }
951
952 // Subtract the GEP2 pointer from the GEP1 pointer to find out their
953 // symbolic difference.
954 GEP1BaseOffset -= GEP2BaseOffset;
Dan Gohman6fc24462010-08-03 20:23:52 +0000955 GetIndexDifference(GEP1VariableIndices, GEP2VariableIndices);
Chris Lattnerd84eb912009-11-26 02:17:34 +0000956
957 } else {
958 // Check to see if these two pointers are related by the getelementptr
959 // instruction. If one pointer is a GEP with a non-zero index of the other
960 // pointer, we know they cannot alias.
Chris Lattner53692502009-11-26 16:52:32 +0000961
962 // If both accesses are unknown size, we can't do anything useful here.
Dan Gohmanef1cfac2010-08-03 01:03:11 +0000963 if (V1Size == UnknownSize && V2Size == UnknownSize)
Chris Lattnerd84eb912009-11-26 02:17:34 +0000964 return MayAlias;
Chris Lattnerb307c882003-12-11 22:44:13 +0000965
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000966 AliasResult R = aliasCheck(UnderlyingV1, UnknownSize, 0,
967 V2, V2Size, V2TBAAInfo);
Chris Lattnerd84eb912009-11-26 02:17:34 +0000968 if (R != MustAlias)
969 // If V2 may alias GEP base pointer, conservatively returns MayAlias.
970 // If V2 is known not to alias GEP base pointer, then the two values
971 // cannot alias per GEP semantics: "A pointer value formed from a
972 // getelementptr instruction is associated with the addresses associated
973 // with the first operand of the getelementptr".
974 return R;
Chris Lattnerb307c882003-12-11 22:44:13 +0000975
Chris Lattnerd84eb912009-11-26 02:17:34 +0000976 const Value *GEP1BasePtr =
977 DecomposeGEPExpression(GEP1, GEP1BaseOffset, GEP1VariableIndices, TD);
978
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000979 // DecomposeGEPExpression and GetUnderlyingObject should return the
Micah Villmow3574eca2012-10-08 16:38:25 +0000980 // same result except when DecomposeGEPExpression has no DataLayout.
Chris Lattnerd84eb912009-11-26 02:17:34 +0000981 if (GEP1BasePtr != UnderlyingV1) {
982 assert(TD == 0 &&
Dan Gohman5034dd32010-12-15 20:02:24 +0000983 "DecomposeGEPExpression and GetUnderlyingObject disagree!");
Chris Lattnerd84eb912009-11-26 02:17:34 +0000984 return MayAlias;
Chris Lattnerb307c882003-12-11 22:44:13 +0000985 }
986 }
Chris Lattnerd84eb912009-11-26 02:17:34 +0000987
988 // In the two GEP Case, if there is no difference in the offsets of the
989 // computed pointers, the resultant pointers are a must alias. This
990 // hapens when we have two lexically identical GEP's (for example).
Chris Lattnerd501c132003-02-26 19:41:54 +0000991 //
Chris Lattnerd84eb912009-11-26 02:17:34 +0000992 // In the other case, if we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2
993 // must aliases the GEP, the end result is a must alias also.
994 if (GEP1BaseOffset == 0 && GEP1VariableIndices.empty())
Evan Cheng681a33e2009-10-14 06:41:49 +0000995 return MustAlias;
Evan Cheng094f04b2009-10-13 18:42:04 +0000996
Eli Friedman81ac8dd2011-09-08 02:23:31 +0000997 // If there is a constant difference between the pointers, but the difference
998 // is less than the size of the associated memory object, then we know
999 // that the objects are partially overlapping. If the difference is
1000 // greater, we know they do not overlap.
Dan Gohman0f7f1942010-12-13 22:50:24 +00001001 if (GEP1BaseOffset != 0 && GEP1VariableIndices.empty()) {
Eli Friedman81ac8dd2011-09-08 02:23:31 +00001002 if (GEP1BaseOffset >= 0) {
1003 if (V2Size != UnknownSize) {
1004 if ((uint64_t)GEP1BaseOffset < V2Size)
1005 return PartialAlias;
1006 return NoAlias;
1007 }
1008 } else {
1009 if (V1Size != UnknownSize) {
1010 if (-(uint64_t)GEP1BaseOffset < V1Size)
1011 return PartialAlias;
1012 return NoAlias;
1013 }
1014 }
Dan Gohman0f7f1942010-12-13 22:50:24 +00001015 }
1016
Eli Friedman81ac8dd2011-09-08 02:23:31 +00001017 // Try to distinguish something like &A[i][1] against &A[42][0].
1018 // Grab the least significant bit set in any of the scales.
Eli Friedman184166d2011-09-08 02:37:07 +00001019 if (!GEP1VariableIndices.empty()) {
1020 uint64_t Modulo = 0;
1021 for (unsigned i = 0, e = GEP1VariableIndices.size(); i != e; ++i)
1022 Modulo |= (uint64_t)GEP1VariableIndices[i].Scale;
1023 Modulo = Modulo ^ (Modulo & (Modulo - 1));
Eli Friedman81ac8dd2011-09-08 02:23:31 +00001024
Eli Friedman184166d2011-09-08 02:37:07 +00001025 // We can compute the difference between the two addresses
1026 // mod Modulo. Check whether that difference guarantees that the
1027 // two locations do not alias.
1028 uint64_t ModOffset = (uint64_t)GEP1BaseOffset & (Modulo - 1);
1029 if (V1Size != UnknownSize && V2Size != UnknownSize &&
1030 ModOffset >= V2Size && V1Size <= Modulo - ModOffset)
1031 return NoAlias;
1032 }
Eli Friedman81ac8dd2011-09-08 02:23:31 +00001033
Dan Gohman5f1312c2011-06-04 06:50:18 +00001034 // Statically, we can see that the base objects are the same, but the
1035 // pointers have dynamic offsets which we can't resolve. And none of our
1036 // little tricks above worked.
1037 //
1038 // TODO: Returning PartialAlias instead of MayAlias is a mild hack; the
1039 // practical effect of this is protecting TBAA in the case of dynamic
Dan Gohmanebad58d2012-02-17 18:33:38 +00001040 // indices into arrays of unions or malloc'd memory.
Dan Gohman5f1312c2011-06-04 06:50:18 +00001041 return PartialAlias;
Evan Cheng094f04b2009-10-13 18:42:04 +00001042}
1043
Dan Gohman965fefa2011-06-03 20:17:36 +00001044static AliasAnalysis::AliasResult
1045MergeAliasResults(AliasAnalysis::AliasResult A, AliasAnalysis::AliasResult B) {
1046 // If the results agree, take it.
1047 if (A == B)
1048 return A;
1049 // A mix of PartialAlias and MustAlias is PartialAlias.
1050 if ((A == AliasAnalysis::PartialAlias && B == AliasAnalysis::MustAlias) ||
1051 (B == AliasAnalysis::PartialAlias && A == AliasAnalysis::MustAlias))
1052 return AliasAnalysis::PartialAlias;
1053 // Otherwise, we don't know anything.
1054 return AliasAnalysis::MayAlias;
1055}
1056
Chris Lattner5d56b2d2009-11-23 16:45:27 +00001057/// aliasSelect - Provide a bunch of ad-hoc rules to disambiguate a Select
1058/// instruction against another.
Dan Gohman6665b0e2009-10-26 21:55:43 +00001059AliasAnalysis::AliasResult
Dan Gohman3da848b2010-10-19 22:54:46 +00001060BasicAliasAnalysis::aliasSelect(const SelectInst *SI, uint64_t SISize,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001061 const MDNode *SITBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +00001062 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001063 const MDNode *V2TBAAInfo) {
Dan Gohman6665b0e2009-10-26 21:55:43 +00001064 // If the values are Selects with the same condition, we can do a more precise
1065 // check: just check for aliases between the values on corresponding arms.
1066 if (const SelectInst *SI2 = dyn_cast<SelectInst>(V2))
1067 if (SI->getCondition() == SI2->getCondition()) {
1068 AliasResult Alias =
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001069 aliasCheck(SI->getTrueValue(), SISize, SITBAAInfo,
1070 SI2->getTrueValue(), V2Size, V2TBAAInfo);
Dan Gohman6665b0e2009-10-26 21:55:43 +00001071 if (Alias == MayAlias)
1072 return MayAlias;
1073 AliasResult ThisAlias =
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001074 aliasCheck(SI->getFalseValue(), SISize, SITBAAInfo,
1075 SI2->getFalseValue(), V2Size, V2TBAAInfo);
Dan Gohman965fefa2011-06-03 20:17:36 +00001076 return MergeAliasResults(ThisAlias, Alias);
Dan Gohman6665b0e2009-10-26 21:55:43 +00001077 }
1078
1079 // If both arms of the Select node NoAlias or MustAlias V2, then returns
1080 // NoAlias / MustAlias. Otherwise, returns MayAlias.
1081 AliasResult Alias =
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001082 aliasCheck(V2, V2Size, V2TBAAInfo, SI->getTrueValue(), SISize, SITBAAInfo);
Dan Gohman6665b0e2009-10-26 21:55:43 +00001083 if (Alias == MayAlias)
1084 return MayAlias;
Dan Gohman50f424c2010-06-28 21:16:52 +00001085
Dan Gohman6665b0e2009-10-26 21:55:43 +00001086 AliasResult ThisAlias =
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001087 aliasCheck(V2, V2Size, V2TBAAInfo, SI->getFalseValue(), SISize, SITBAAInfo);
Dan Gohman965fefa2011-06-03 20:17:36 +00001088 return MergeAliasResults(ThisAlias, Alias);
Dan Gohman6665b0e2009-10-26 21:55:43 +00001089}
1090
Evan Chengd83c2ca2009-10-14 05:22:03 +00001091// aliasPHI - Provide a bunch of ad-hoc rules to disambiguate a PHI instruction
Evan Cheng3dbe43b2009-10-14 05:05:02 +00001092// against another.
Evan Cheng50a59142009-10-13 22:02:20 +00001093AliasAnalysis::AliasResult
Dan Gohman3da848b2010-10-19 22:54:46 +00001094BasicAliasAnalysis::aliasPHI(const PHINode *PN, uint64_t PNSize,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001095 const MDNode *PNTBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +00001096 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001097 const MDNode *V2TBAAInfo) {
Dan Gohman6665b0e2009-10-26 21:55:43 +00001098 // If the values are PHIs in the same block, we can do a more precise
1099 // as well as efficient check: just check for aliases between the values
1100 // on corresponding edges.
1101 if (const PHINode *PN2 = dyn_cast<PHINode>(V2))
1102 if (PN2->getParent() == PN->getParent()) {
Arnold Schwaighofer3d5f96e2012-09-06 14:41:53 +00001103 LocPair Locs(Location(PN, PNSize, PNTBAAInfo),
1104 Location(V2, V2Size, V2TBAAInfo));
1105 if (PN > V2)
1106 std::swap(Locs.first, Locs.second);
Arnold Schwaighofer2b475922012-12-10 23:02:41 +00001107 // Analyse the PHIs' inputs under the assumption that the PHIs are
1108 // NoAlias.
1109 // If the PHIs are May/MustAlias there must be (recursively) an input
1110 // operand from outside the PHIs' cycle that is MayAlias/MustAlias or
1111 // there must be an operation on the PHIs within the PHIs' value cycle
1112 // that causes a MayAlias.
1113 // Pretend the phis do not alias.
1114 AliasResult Alias = NoAlias;
1115 assert(AliasCache.count(Locs) &&
1116 "There must exist an entry for the phi node");
1117 AliasResult OrigAliasResult = AliasCache[Locs];
1118 AliasCache[Locs] = NoAlias;
Arnold Schwaighofer3d5f96e2012-09-06 14:41:53 +00001119
Hal Finkelc37f5022012-11-17 02:33:15 +00001120 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
Dan Gohman6665b0e2009-10-26 21:55:43 +00001121 AliasResult ThisAlias =
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001122 aliasCheck(PN->getIncomingValue(i), PNSize, PNTBAAInfo,
Dan Gohman6665b0e2009-10-26 21:55:43 +00001123 PN2->getIncomingValueForBlock(PN->getIncomingBlock(i)),
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001124 V2Size, V2TBAAInfo);
Dan Gohman965fefa2011-06-03 20:17:36 +00001125 Alias = MergeAliasResults(ThisAlias, Alias);
1126 if (Alias == MayAlias)
1127 break;
Dan Gohman6665b0e2009-10-26 21:55:43 +00001128 }
Arnold Schwaighofer3d5f96e2012-09-06 14:41:53 +00001129
1130 // Reset if speculation failed.
Arnold Schwaighofer2b475922012-12-10 23:02:41 +00001131 if (Alias != NoAlias)
Arnold Schwaighofer3d5f96e2012-09-06 14:41:53 +00001132 AliasCache[Locs] = OrigAliasResult;
1133
Dan Gohman6665b0e2009-10-26 21:55:43 +00001134 return Alias;
1135 }
1136
Evan Chenga846a8a2009-10-16 00:33:09 +00001137 SmallPtrSet<Value*, 4> UniqueSrc;
Evan Cheng50a59142009-10-13 22:02:20 +00001138 SmallVector<Value*, 4> V1Srcs;
Evan Cheng50a59142009-10-13 22:02:20 +00001139 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1140 Value *PV1 = PN->getIncomingValue(i);
1141 if (isa<PHINode>(PV1))
1142 // If any of the source itself is a PHI, return MayAlias conservatively
Evan Cheng681a33e2009-10-14 06:41:49 +00001143 // to avoid compile time explosion. The worst possible case is if both
1144 // sides are PHI nodes. In which case, this is O(m x n) time where 'm'
1145 // and 'n' are the number of PHI sources.
Evan Cheng50a59142009-10-13 22:02:20 +00001146 return MayAlias;
1147 if (UniqueSrc.insert(PV1))
1148 V1Srcs.push_back(PV1);
1149 }
1150
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001151 AliasResult Alias = aliasCheck(V2, V2Size, V2TBAAInfo,
1152 V1Srcs[0], PNSize, PNTBAAInfo);
Evan Chengd83c2ca2009-10-14 05:22:03 +00001153 // Early exit if the check of the first PHI source against V2 is MayAlias.
1154 // Other results are not possible.
1155 if (Alias == MayAlias)
1156 return MayAlias;
1157
Evan Cheng50a59142009-10-13 22:02:20 +00001158 // If all sources of the PHI node NoAlias or MustAlias V2, then returns
1159 // NoAlias / MustAlias. Otherwise, returns MayAlias.
Evan Cheng50a59142009-10-13 22:02:20 +00001160 for (unsigned i = 1, e = V1Srcs.size(); i != e; ++i) {
1161 Value *V = V1Srcs[i];
Dan Gohman6665b0e2009-10-26 21:55:43 +00001162
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001163 AliasResult ThisAlias = aliasCheck(V2, V2Size, V2TBAAInfo,
1164 V, PNSize, PNTBAAInfo);
Dan Gohman965fefa2011-06-03 20:17:36 +00001165 Alias = MergeAliasResults(ThisAlias, Alias);
1166 if (Alias == MayAlias)
1167 break;
Evan Cheng50a59142009-10-13 22:02:20 +00001168 }
1169
1170 return Alias;
1171}
1172
1173// aliasCheck - Provide a bunch of ad-hoc rules to disambiguate in common cases,
1174// such as array references.
Evan Cheng094f04b2009-10-13 18:42:04 +00001175//
1176AliasAnalysis::AliasResult
Dan Gohman3da848b2010-10-19 22:54:46 +00001177BasicAliasAnalysis::aliasCheck(const Value *V1, uint64_t V1Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001178 const MDNode *V1TBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +00001179 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001180 const MDNode *V2TBAAInfo) {
Dan Gohmanb57b6f12010-04-08 18:11:50 +00001181 // If either of the memory references is empty, it doesn't matter what the
1182 // pointer values are.
1183 if (V1Size == 0 || V2Size == 0)
1184 return NoAlias;
1185
Evan Cheng094f04b2009-10-13 18:42:04 +00001186 // Strip off any casts if they exist.
1187 V1 = V1->stripPointerCasts();
1188 V2 = V2->stripPointerCasts();
1189
1190 // Are we checking for alias of the same value?
1191 if (V1 == V2) return MustAlias;
1192
Duncan Sands1df98592010-02-16 11:11:14 +00001193 if (!V1->getType()->isPointerTy() || !V2->getType()->isPointerTy())
Evan Cheng094f04b2009-10-13 18:42:04 +00001194 return NoAlias; // Scalars cannot alias each other
1195
1196 // Figure out what objects these things are pointing to if we can.
Dan Gohmanbd1801b2011-01-24 18:53:32 +00001197 const Value *O1 = GetUnderlyingObject(V1, TD);
1198 const Value *O2 = GetUnderlyingObject(V2, TD);
Evan Cheng094f04b2009-10-13 18:42:04 +00001199
Dan Gohmanf75ef662009-11-09 19:29:11 +00001200 // Null values in the default address space don't point to any object, so they
1201 // don't alias any other pointer.
1202 if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O1))
1203 if (CPN->getType()->getAddressSpace() == 0)
1204 return NoAlias;
1205 if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O2))
1206 if (CPN->getType()->getAddressSpace() == 0)
1207 return NoAlias;
1208
Evan Cheng094f04b2009-10-13 18:42:04 +00001209 if (O1 != O2) {
1210 // If V1/V2 point to two different objects we know that we have no alias.
Dan Gohman9e86f432010-07-07 14:27:09 +00001211 if (isIdentifiedObject(O1) && isIdentifiedObject(O2))
Evan Cheng094f04b2009-10-13 18:42:04 +00001212 return NoAlias;
Nick Lewycky20162ac2009-11-14 06:15:14 +00001213
1214 // Constant pointers can't alias with non-const isIdentifiedObject objects.
Dan Gohman9e86f432010-07-07 14:27:09 +00001215 if ((isa<Constant>(O1) && isIdentifiedObject(O2) && !isa<Constant>(O2)) ||
1216 (isa<Constant>(O2) && isIdentifiedObject(O1) && !isa<Constant>(O1)))
Nick Lewycky20162ac2009-11-14 06:15:14 +00001217 return NoAlias;
1218
Michael Kuperstein9f5de6d2013-05-28 08:17:48 +00001219 // Function arguments can't alias with things that are known to be
1220 // unambigously identified at the function level.
1221 if ((isa<Argument>(O1) && isIdentifiedFunctionLocal(O2)) ||
1222 (isa<Argument>(O2) && isIdentifiedFunctionLocal(O1)))
Dan Gohman21de4c02010-07-01 20:08:40 +00001223 return NoAlias;
Evan Cheng094f04b2009-10-13 18:42:04 +00001224
1225 // Most objects can't alias null.
Dan Gohman9e86f432010-07-07 14:27:09 +00001226 if ((isa<ConstantPointerNull>(O2) && isKnownNonNull(O1)) ||
1227 (isa<ConstantPointerNull>(O1) && isKnownNonNull(O2)))
Evan Cheng094f04b2009-10-13 18:42:04 +00001228 return NoAlias;
Evan Cheng094f04b2009-10-13 18:42:04 +00001229
Dan Gohmanb8c86a02010-07-07 14:30:04 +00001230 // If one pointer is the result of a call/invoke or load and the other is a
1231 // non-escaping local object within the same function, then we know the
1232 // object couldn't escape to a point where the call could return it.
1233 //
1234 // Note that if the pointers are in different functions, there are a
1235 // variety of complications. A call with a nocapture argument may still
1236 // temporary store the nocapture argument's value in a temporary memory
1237 // location if that memory location doesn't escape. Or it may pass a
1238 // nocapture value to other functions as long as they don't capture it.
1239 if (isEscapeSource(O1) && isNonEscapingLocalObject(O2))
1240 return NoAlias;
1241 if (isEscapeSource(O2) && isNonEscapingLocalObject(O1))
1242 return NoAlias;
1243 }
1244
Evan Cheng094f04b2009-10-13 18:42:04 +00001245 // If the size of one access is larger than the entire object on the other
1246 // side, then we know such behavior is undefined and can assume no alias.
Evan Cheng094f04b2009-10-13 18:42:04 +00001247 if (TD)
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +00001248 if ((V1Size != UnknownSize && isObjectSmallerThan(O2, V1Size, *TD, *TLI)) ||
1249 (V2Size != UnknownSize && isObjectSmallerThan(O1, V2Size, *TD, *TLI)))
Evan Cheng094f04b2009-10-13 18:42:04 +00001250 return NoAlias;
1251
Dan Gohman1fc18d72011-06-04 00:31:50 +00001252 // Check the cache before climbing up use-def chains. This also terminates
1253 // otherwise infinitely recursive queries.
1254 LocPair Locs(Location(V1, V1Size, V1TBAAInfo),
1255 Location(V2, V2Size, V2TBAAInfo));
1256 if (V1 > V2)
1257 std::swap(Locs.first, Locs.second);
1258 std::pair<AliasCacheTy::iterator, bool> Pair =
1259 AliasCache.insert(std::make_pair(Locs, MayAlias));
1260 if (!Pair.second)
1261 return Pair.first->second;
1262
Chris Lattner4e91ee72009-11-26 02:13:03 +00001263 // FIXME: This isn't aggressively handling alias(GEP, PHI) for example: if the
1264 // GEP can't simplify, we don't even look at the PHI cases.
Chris Lattner391d23b2009-10-17 23:48:54 +00001265 if (!isa<GEPOperator>(V1) && isa<GEPOperator>(V2)) {
Chris Lattnerd501c132003-02-26 19:41:54 +00001266 std::swap(V1, V2);
1267 std::swap(V1Size, V2Size);
Chris Lattner23e2a5b2009-11-26 02:14:59 +00001268 std::swap(O1, O2);
Duncan Sandsa1beca62012-11-04 09:02:45 +00001269 std::swap(V1TBAAInfo, V2TBAAInfo);
Chris Lattnerd501c132003-02-26 19:41:54 +00001270 }
Dan Gohmanc1be92f2010-10-18 18:04:47 +00001271 if (const GEPOperator *GV1 = dyn_cast<GEPOperator>(V1)) {
Arnold Schwaighofer02903262012-09-06 14:31:51 +00001272 AliasResult Result = aliasGEP(GV1, V1Size, V1TBAAInfo, V2, V2Size, V2TBAAInfo, O1, O2);
Dan Gohman1fc18d72011-06-04 00:31:50 +00001273 if (Result != MayAlias) return AliasCache[Locs] = Result;
Dan Gohmanc1be92f2010-10-18 18:04:47 +00001274 }
Evan Cheng50a59142009-10-13 22:02:20 +00001275
1276 if (isa<PHINode>(V2) && !isa<PHINode>(V1)) {
1277 std::swap(V1, V2);
1278 std::swap(V1Size, V2Size);
Duncan Sandsa1beca62012-11-04 09:02:45 +00001279 std::swap(V1TBAAInfo, V2TBAAInfo);
Evan Cheng50a59142009-10-13 22:02:20 +00001280 }
Dan Gohmanc1be92f2010-10-18 18:04:47 +00001281 if (const PHINode *PN = dyn_cast<PHINode>(V1)) {
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001282 AliasResult Result = aliasPHI(PN, V1Size, V1TBAAInfo,
1283 V2, V2Size, V2TBAAInfo);
Dan Gohman1fc18d72011-06-04 00:31:50 +00001284 if (Result != MayAlias) return AliasCache[Locs] = Result;
Dan Gohmanc1be92f2010-10-18 18:04:47 +00001285 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00001286
Dan Gohman6665b0e2009-10-26 21:55:43 +00001287 if (isa<SelectInst>(V2) && !isa<SelectInst>(V1)) {
1288 std::swap(V1, V2);
1289 std::swap(V1Size, V2Size);
Duncan Sandsa1beca62012-11-04 09:02:45 +00001290 std::swap(V1TBAAInfo, V2TBAAInfo);
Dan Gohman6665b0e2009-10-26 21:55:43 +00001291 }
Dan Gohmanc1be92f2010-10-18 18:04:47 +00001292 if (const SelectInst *S1 = dyn_cast<SelectInst>(V1)) {
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001293 AliasResult Result = aliasSelect(S1, V1Size, V1TBAAInfo,
1294 V2, V2Size, V2TBAAInfo);
Dan Gohman1fc18d72011-06-04 00:31:50 +00001295 if (Result != MayAlias) return AliasCache[Locs] = Result;
Dan Gohmanc1be92f2010-10-18 18:04:47 +00001296 }
Dan Gohman6665b0e2009-10-26 21:55:43 +00001297
Dan Gohman615da1a2011-01-18 21:16:06 +00001298 // If both pointers are pointing into the same object and one of them
1299 // accesses is accessing the entire object, then the accesses must
1300 // overlap in some way.
1301 if (TD && O1 == O2)
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +00001302 if ((V1Size != UnknownSize && isObjectSize(O1, V1Size, *TD, *TLI)) ||
1303 (V2Size != UnknownSize && isObjectSize(O2, V2Size, *TD, *TLI)))
Dan Gohman1fc18d72011-06-04 00:31:50 +00001304 return AliasCache[Locs] = PartialAlias;
Dan Gohman615da1a2011-01-18 21:16:06 +00001305
Dan Gohman1fc18d72011-06-04 00:31:50 +00001306 AliasResult Result =
1307 AliasAnalysis::alias(Location(V1, V1Size, V1TBAAInfo),
1308 Location(V2, V2Size, V2TBAAInfo));
1309 return AliasCache[Locs] = Result;
Chris Lattnerd501c132003-02-26 19:41:54 +00001310}