blob: f8509dd070ff0f6bcceb77e350c4b51e0f187730 [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
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000145//===----------------------------------------------------------------------===//
Chris Lattner30963fb2010-08-18 22:07:29 +0000146// GetElementPtr Instruction Decomposition and Analysis
147//===----------------------------------------------------------------------===//
148
Chris Lattner8807e9f2010-08-18 22:47:56 +0000149namespace {
150 enum ExtensionKind {
151 EK_NotExtended,
152 EK_SignExt,
153 EK_ZeroExt
154 };
155
156 struct VariableGEPIndex {
157 const Value *V;
158 ExtensionKind Extension;
159 int64_t Scale;
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000160
161 bool operator==(const VariableGEPIndex &Other) const {
162 return V == Other.V && Extension == Other.Extension &&
163 Scale == Other.Scale;
164 }
165
166 bool operator!=(const VariableGEPIndex &Other) const {
167 return !operator==(Other);
168 }
Chris Lattner8807e9f2010-08-18 22:47:56 +0000169 };
170}
171
Chris Lattner30963fb2010-08-18 22:07:29 +0000172
173/// GetLinearExpression - Analyze the specified value as a linear expression:
174/// "A*V + B", where A and B are constant integers. Return the scale and offset
Chris Lattner2215c602010-08-18 23:09:49 +0000175/// values as APInts and return V as a Value*, and return whether we looked
176/// through any sign or zero extends. The incoming Value is known to have
177/// IntegerType and it may already be sign or zero extended.
178///
179/// Note that this looks through extends, so the high bits may not be
180/// represented in the result.
Chris Lattner30963fb2010-08-18 22:07:29 +0000181static Value *GetLinearExpression(Value *V, APInt &Scale, APInt &Offset,
Chris Lattner2215c602010-08-18 23:09:49 +0000182 ExtensionKind &Extension,
Micah Villmow3574eca2012-10-08 16:38:25 +0000183 const DataLayout &TD, unsigned Depth) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000184 assert(V->getType()->isIntegerTy() && "Not an integer value");
185
186 // Limit our recursion depth.
187 if (Depth == 6) {
188 Scale = 1;
189 Offset = 0;
190 return V;
191 }
192
193 if (BinaryOperator *BOp = dyn_cast<BinaryOperator>(V)) {
194 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(BOp->getOperand(1))) {
195 switch (BOp->getOpcode()) {
196 default: break;
197 case Instruction::Or:
198 // X|C == X+C if all the bits in C are unset in X. Otherwise we can't
199 // analyze it.
Chris Lattnerff2efb92010-08-18 22:52:09 +0000200 if (!MaskedValueIsZero(BOp->getOperand(0), RHSC->getValue(), &TD))
Chris Lattner30963fb2010-08-18 22:07:29 +0000201 break;
202 // FALL THROUGH.
203 case Instruction::Add:
Chris Lattner2215c602010-08-18 23:09:49 +0000204 V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, Extension,
205 TD, Depth+1);
Chris Lattner30963fb2010-08-18 22:07:29 +0000206 Offset += RHSC->getValue();
207 return V;
208 case Instruction::Mul:
Chris Lattner2215c602010-08-18 23:09:49 +0000209 V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, Extension,
210 TD, Depth+1);
Chris Lattner30963fb2010-08-18 22:07:29 +0000211 Offset *= RHSC->getValue();
212 Scale *= RHSC->getValue();
213 return V;
214 case Instruction::Shl:
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().getLimitedValue();
218 Scale <<= RHSC->getValue().getLimitedValue();
219 return V;
220 }
221 }
222 }
223
224 // Since GEP indices are sign extended anyway, we don't care about the high
Chris Lattner2215c602010-08-18 23:09:49 +0000225 // bits of a sign or zero extended value - just scales and offsets. The
226 // extensions have to be consistent though.
227 if ((isa<SExtInst>(V) && Extension != EK_ZeroExt) ||
228 (isa<ZExtInst>(V) && Extension != EK_SignExt)) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000229 Value *CastOp = cast<CastInst>(V)->getOperand(0);
230 unsigned OldWidth = Scale.getBitWidth();
231 unsigned SmallWidth = CastOp->getType()->getPrimitiveSizeInBits();
Jay Foad40f8f622010-12-07 08:25:19 +0000232 Scale = Scale.trunc(SmallWidth);
233 Offset = Offset.trunc(SmallWidth);
Chris Lattner2215c602010-08-18 23:09:49 +0000234 Extension = isa<SExtInst>(V) ? EK_SignExt : EK_ZeroExt;
235
236 Value *Result = GetLinearExpression(CastOp, Scale, Offset, Extension,
237 TD, Depth+1);
Jay Foad40f8f622010-12-07 08:25:19 +0000238 Scale = Scale.zext(OldWidth);
239 Offset = Offset.zext(OldWidth);
Chris Lattner2215c602010-08-18 23:09:49 +0000240
Chris Lattner30963fb2010-08-18 22:07:29 +0000241 return Result;
242 }
243
244 Scale = 1;
245 Offset = 0;
246 return V;
247}
248
249/// DecomposeGEPExpression - If V is a symbolic pointer expression, decompose it
250/// into a base pointer with a constant offset and a number of scaled symbolic
251/// offsets.
252///
253/// The scaled symbolic offsets (represented by pairs of a Value* and a scale in
254/// the VarIndices vector) are Value*'s that are known to be scaled by the
255/// specified amount, but which may have other unrepresented high bits. As such,
256/// the gep cannot necessarily be reconstructed from its decomposed form.
257///
Micah Villmow3574eca2012-10-08 16:38:25 +0000258/// When DataLayout is around, this function is capable of analyzing everything
Dan Gohman5034dd32010-12-15 20:02:24 +0000259/// that GetUnderlyingObject can look through. When not, it just looks
Chris Lattner30963fb2010-08-18 22:07:29 +0000260/// through pointer casts.
261///
262static const Value *
263DecomposeGEPExpression(const Value *V, int64_t &BaseOffs,
Chris Lattner8807e9f2010-08-18 22:47:56 +0000264 SmallVectorImpl<VariableGEPIndex> &VarIndices,
Micah Villmow3574eca2012-10-08 16:38:25 +0000265 const DataLayout *TD) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000266 // Limit recursion depth to limit compile time in crazy cases.
267 unsigned MaxLookup = 6;
268
269 BaseOffs = 0;
270 do {
271 // See if this is a bitcast or GEP.
272 const Operator *Op = dyn_cast<Operator>(V);
273 if (Op == 0) {
274 // The only non-operator case we can handle are GlobalAliases.
275 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
276 if (!GA->mayBeOverridden()) {
277 V = GA->getAliasee();
278 continue;
279 }
280 }
281 return V;
282 }
283
284 if (Op->getOpcode() == Instruction::BitCast) {
285 V = Op->getOperand(0);
286 continue;
287 }
Dan Gohmanc01895c2010-12-15 20:49:55 +0000288
Chris Lattner30963fb2010-08-18 22:07:29 +0000289 const GEPOperator *GEPOp = dyn_cast<GEPOperator>(Op);
Dan Gohman9adf1512011-05-24 18:24:08 +0000290 if (GEPOp == 0) {
291 // If it's not a GEP, hand it off to SimplifyInstruction to see if it
292 // can come up with something. This matches what GetUnderlyingObject does.
293 if (const Instruction *I = dyn_cast<Instruction>(V))
294 // TODO: Get a DominatorTree and use it here.
295 if (const Value *Simplified =
296 SimplifyInstruction(const_cast<Instruction *>(I), TD)) {
297 V = Simplified;
298 continue;
299 }
300
Chris Lattner30963fb2010-08-18 22:07:29 +0000301 return V;
Dan Gohman9adf1512011-05-24 18:24:08 +0000302 }
Chris Lattner30963fb2010-08-18 22:07:29 +0000303
304 // Don't attempt to analyze GEPs over unsized objects.
305 if (!cast<PointerType>(GEPOp->getOperand(0)->getType())
306 ->getElementType()->isSized())
307 return V;
308
Micah Villmow3574eca2012-10-08 16:38:25 +0000309 // If we are lacking DataLayout information, we can't compute the offets of
Chris Lattner30963fb2010-08-18 22:07:29 +0000310 // elements computed by GEPs. However, we can handle bitcast equivalent
311 // GEPs.
Chris Lattnerff2efb92010-08-18 22:52:09 +0000312 if (TD == 0) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000313 if (!GEPOp->hasAllZeroIndices())
314 return V;
315 V = GEPOp->getOperand(0);
316 continue;
317 }
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000318
Chris Lattner30963fb2010-08-18 22:07:29 +0000319 // Walk the indices of the GEP, accumulating them into BaseOff/VarIndices.
320 gep_type_iterator GTI = gep_type_begin(GEPOp);
321 for (User::const_op_iterator I = GEPOp->op_begin()+1,
322 E = GEPOp->op_end(); I != E; ++I) {
323 Value *Index = *I;
324 // Compute the (potentially symbolic) offset in bytes for this index.
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000325 if (StructType *STy = dyn_cast<StructType>(*GTI++)) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000326 // For a struct, add the member offset.
327 unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
328 if (FieldNo == 0) continue;
329
330 BaseOffs += TD->getStructLayout(STy)->getElementOffset(FieldNo);
331 continue;
332 }
333
334 // For an array/pointer, add the element offset, explicitly scaled.
335 if (ConstantInt *CIdx = dyn_cast<ConstantInt>(Index)) {
336 if (CIdx->isZero()) continue;
337 BaseOffs += TD->getTypeAllocSize(*GTI)*CIdx->getSExtValue();
338 continue;
339 }
340
341 uint64_t Scale = TD->getTypeAllocSize(*GTI);
Chris Lattner8807e9f2010-08-18 22:47:56 +0000342 ExtensionKind Extension = EK_NotExtended;
Chris Lattner30963fb2010-08-18 22:07:29 +0000343
Chris Lattner2215c602010-08-18 23:09:49 +0000344 // If the integer type is smaller than the pointer size, it is implicitly
345 // sign extended to pointer size.
Chris Lattner30963fb2010-08-18 22:07:29 +0000346 unsigned Width = cast<IntegerType>(Index->getType())->getBitWidth();
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000347 if (TD->getPointerSizeInBits() > Width)
Chris Lattner2215c602010-08-18 23:09:49 +0000348 Extension = EK_SignExt;
349
350 // Use GetLinearExpression to decompose the index into a C1*V+C2 form.
Chris Lattner30963fb2010-08-18 22:07:29 +0000351 APInt IndexScale(Width, 0), IndexOffset(Width, 0);
Chris Lattner2215c602010-08-18 23:09:49 +0000352 Index = GetLinearExpression(Index, IndexScale, IndexOffset, Extension,
353 *TD, 0);
Chris Lattner30963fb2010-08-18 22:07:29 +0000354
355 // The GEP index scale ("Scale") scales C1*V+C2, yielding (C1*V+C2)*Scale.
356 // This gives us an aggregate computation of (C1*Scale)*V + C2*Scale.
Eli Friedman39e30122010-09-15 20:08:03 +0000357 BaseOffs += IndexOffset.getSExtValue()*Scale;
358 Scale *= IndexScale.getSExtValue();
Chris Lattner30963fb2010-08-18 22:07:29 +0000359
360
Chris Lattner7a2bdde2011-04-15 05:18:47 +0000361 // If we already had an occurrence of this index variable, merge this
Chris Lattner30963fb2010-08-18 22:07:29 +0000362 // scale into it. For example, we want to handle:
363 // A[x][x] -> x*16 + x*4 -> x*20
364 // This also ensures that 'x' only appears in the index list once.
365 for (unsigned i = 0, e = VarIndices.size(); i != e; ++i) {
Chris Lattner8807e9f2010-08-18 22:47:56 +0000366 if (VarIndices[i].V == Index &&
367 VarIndices[i].Extension == Extension) {
368 Scale += VarIndices[i].Scale;
Chris Lattner30963fb2010-08-18 22:07:29 +0000369 VarIndices.erase(VarIndices.begin()+i);
370 break;
371 }
372 }
373
374 // Make sure that we have a scale that makes sense for this target's
375 // pointer size.
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000376 if (unsigned ShiftBits = 64-TD->getPointerSizeInBits()) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000377 Scale <<= ShiftBits;
Eli Friedman39e30122010-09-15 20:08:03 +0000378 Scale = (int64_t)Scale >> ShiftBits;
Chris Lattner30963fb2010-08-18 22:07:29 +0000379 }
380
Chris Lattner8807e9f2010-08-18 22:47:56 +0000381 if (Scale) {
Jeffrey Yasskina44defe2011-07-27 06:22:51 +0000382 VariableGEPIndex Entry = {Index, Extension,
383 static_cast<int64_t>(Scale)};
Chris Lattner8807e9f2010-08-18 22:47:56 +0000384 VarIndices.push_back(Entry);
385 }
Chris Lattner30963fb2010-08-18 22:07:29 +0000386 }
387
388 // Analyze the base pointer next.
389 V = GEPOp->getOperand(0);
390 } while (--MaxLookup);
391
392 // If the chain of expressions is too deep, just return early.
393 return V;
394}
395
396/// GetIndexDifference - Dest and Src are the variable indices from two
397/// decomposed GetElementPtr instructions GEP1 and GEP2 which have common base
398/// pointers. Subtract the GEP2 indices from GEP1 to find the symbolic
399/// difference between the two pointers.
Chris Lattner8807e9f2010-08-18 22:47:56 +0000400static void GetIndexDifference(SmallVectorImpl<VariableGEPIndex> &Dest,
401 const SmallVectorImpl<VariableGEPIndex> &Src) {
Chris Lattner30963fb2010-08-18 22:07:29 +0000402 if (Src.empty()) return;
403
404 for (unsigned i = 0, e = Src.size(); i != e; ++i) {
Chris Lattner8807e9f2010-08-18 22:47:56 +0000405 const Value *V = Src[i].V;
406 ExtensionKind Extension = Src[i].Extension;
407 int64_t Scale = Src[i].Scale;
Chris Lattner30963fb2010-08-18 22:07:29 +0000408
409 // Find V in Dest. This is N^2, but pointer indices almost never have more
410 // than a few variable indexes.
411 for (unsigned j = 0, e = Dest.size(); j != e; ++j) {
Chris Lattner8807e9f2010-08-18 22:47:56 +0000412 if (Dest[j].V != V || Dest[j].Extension != Extension) continue;
Chris Lattner30963fb2010-08-18 22:07:29 +0000413
414 // If we found it, subtract off Scale V's from the entry in Dest. If it
415 // goes to zero, remove the entry.
Chris Lattner8807e9f2010-08-18 22:47:56 +0000416 if (Dest[j].Scale != Scale)
417 Dest[j].Scale -= Scale;
Chris Lattner30963fb2010-08-18 22:07:29 +0000418 else
419 Dest.erase(Dest.begin()+j);
420 Scale = 0;
421 break;
422 }
423
424 // If we didn't consume this entry, add it to the end of the Dest list.
Chris Lattner8807e9f2010-08-18 22:47:56 +0000425 if (Scale) {
426 VariableGEPIndex Entry = { V, Extension, -Scale };
427 Dest.push_back(Entry);
428 }
Chris Lattner30963fb2010-08-18 22:07:29 +0000429 }
430}
431
432//===----------------------------------------------------------------------===//
Dan Gohman6be2bd52010-06-29 00:50:39 +0000433// BasicAliasAnalysis Pass
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000434//===----------------------------------------------------------------------===//
435
Dan Gohman9e86f432010-07-07 14:27:09 +0000436#ifndef NDEBUG
Dan Gohman6be2bd52010-06-29 00:50:39 +0000437static const Function *getParent(const Value *V) {
Dan Gohman6f205cb2010-06-29 18:12:34 +0000438 if (const Instruction *inst = dyn_cast<Instruction>(V))
Dan Gohman6be2bd52010-06-29 00:50:39 +0000439 return inst->getParent()->getParent();
440
Dan Gohman6f205cb2010-06-29 18:12:34 +0000441 if (const Argument *arg = dyn_cast<Argument>(V))
Dan Gohman6be2bd52010-06-29 00:50:39 +0000442 return arg->getParent();
443
444 return NULL;
445}
446
Dan Gohman21de4c02010-07-01 20:08:40 +0000447static bool notDifferentParent(const Value *O1, const Value *O2) {
448
449 const Function *F1 = getParent(O1);
450 const Function *F2 = getParent(O2);
451
Dan Gohman6be2bd52010-06-29 00:50:39 +0000452 return !F1 || !F2 || F1 == F2;
453}
Benjamin Kramer3432d702010-06-29 10:03:11 +0000454#endif
Dan Gohman6be2bd52010-06-29 00:50:39 +0000455
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000456namespace {
Dan Gohmandb4708c2010-10-19 23:09:08 +0000457 /// BasicAliasAnalysis - This is the primary alias analysis implementation.
458 struct BasicAliasAnalysis : public ImmutablePass, public AliasAnalysis {
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000459 static char ID; // Class identification, replacement for typeinfo
Benjamin Kramer998d3cc2012-09-05 16:49:37 +0000460 BasicAliasAnalysis() : ImmutablePass(ID) {
Owen Anderson081c34b2010-10-19 17:21:58 +0000461 initializeBasicAliasAnalysisPass(*PassRegistry::getPassRegistry());
462 }
Dan Gohman6be2bd52010-06-29 00:50:39 +0000463
Dan Gohmanc1be92f2010-10-18 18:04:47 +0000464 virtual void initializePass() {
465 InitializeAliasAnalysis(this);
466 }
467
468 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
469 AU.addRequired<AliasAnalysis>();
Owen Anderson69acc932011-09-06 23:33:25 +0000470 AU.addRequired<TargetLibraryInfo>();
Dan Gohmanc1be92f2010-10-18 18:04:47 +0000471 }
472
Dan Gohmanb2143b62010-09-14 21:25:10 +0000473 virtual AliasResult alias(const Location &LocA,
474 const Location &LocB) {
Dan Gohman1fc18d72011-06-04 00:31:50 +0000475 assert(AliasCache.empty() && "AliasCache must be cleared after use!");
Dan Gohmanb2143b62010-09-14 21:25:10 +0000476 assert(notDifferentParent(LocA.Ptr, LocB.Ptr) &&
Dan Gohman9e86f432010-07-07 14:27:09 +0000477 "BasicAliasAnalysis doesn't support interprocedural queries.");
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000478 AliasResult Alias = aliasCheck(LocA.Ptr, LocA.Size, LocA.TBAATag,
479 LocB.Ptr, LocB.Size, LocB.TBAATag);
Benjamin Kramer998d3cc2012-09-05 16:49:37 +0000480 // AliasCache rarely has more than 1 or 2 elements, always use
481 // shrink_and_clear so it quickly returns to the inline capacity of the
482 // SmallDenseMap if it ever grows larger.
483 // FIXME: This should really be shrink_to_inline_capacity_and_clear().
484 AliasCache.shrink_and_clear();
Evan Chengf0429fd2009-10-14 06:46:26 +0000485 return Alias;
Evan Cheng50a59142009-10-13 22:02:20 +0000486 }
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000487
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000488 virtual ModRefResult getModRefInfo(ImmutableCallSite CS,
Dan Gohmanb2143b62010-09-14 21:25:10 +0000489 const Location &Loc);
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000490
491 virtual ModRefResult getModRefInfo(ImmutableCallSite CS1,
492 ImmutableCallSite CS2) {
493 // The AliasAnalysis base class has some smarts, lets use them.
494 return AliasAnalysis::getModRefInfo(CS1, CS2);
495 }
Owen Andersone7942202009-02-05 23:36:27 +0000496
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000497 /// pointsToConstantMemory - Chase pointers until we find a (constant
498 /// global) or not.
Dan Gohmana25e5db2010-11-08 16:45:26 +0000499 virtual bool pointsToConstantMemory(const Location &Loc, bool OrLocal);
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000500
501 /// getModRefBehavior - Return the behavior when calling the given
502 /// call site.
503 virtual ModRefBehavior getModRefBehavior(ImmutableCallSite CS);
504
505 /// getModRefBehavior - Return the behavior when calling the given function.
506 /// For use when the call site is not known.
507 virtual ModRefBehavior getModRefBehavior(const Function *F);
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000508
Chris Lattner20330972010-01-20 19:26:14 +0000509 /// getAdjustedAnalysisPointer - This method is used when a pass implements
Dan Gohman5eeb19d2010-08-05 23:48:14 +0000510 /// an analysis interface through multiple inheritance. If needed, it
511 /// should override this to adjust the this pointer as needed for the
512 /// specified pass info.
Owen Anderson90c579d2010-08-06 18:33:48 +0000513 virtual void *getAdjustedAnalysisPointer(const void *ID) {
514 if (ID == &AliasAnalysis::ID)
Chris Lattner20330972010-01-20 19:26:14 +0000515 return (AliasAnalysis*)this;
516 return this;
517 }
518
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000519 private:
Dan Gohman1fc18d72011-06-04 00:31:50 +0000520 // AliasCache - Track alias queries to guard against recursion.
521 typedef std::pair<Location, Location> LocPair;
Benjamin Kramer998d3cc2012-09-05 16:49:37 +0000522 typedef SmallDenseMap<LocPair, AliasResult, 8> AliasCacheTy;
Dan Gohman1fc18d72011-06-04 00:31:50 +0000523 AliasCacheTy AliasCache;
524
525 // Visited - Track instructions visited by pointsToConstantMemory.
Dan Gohman50f424c2010-06-28 21:16:52 +0000526 SmallPtrSet<const Value*, 16> Visited;
Evan Cheng3dbe43b2009-10-14 05:05:02 +0000527
Chris Lattner5d56b2d2009-11-23 16:45:27 +0000528 // aliasGEP - Provide a bunch of ad-hoc rules to disambiguate a GEP
529 // instruction against another.
Dan Gohman3da848b2010-10-19 22:54:46 +0000530 AliasResult aliasGEP(const GEPOperator *V1, uint64_t V1Size,
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000531 const MDNode *V1TBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +0000532 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000533 const MDNode *V2TBAAInfo,
Chris Lattner23e2a5b2009-11-26 02:14:59 +0000534 const Value *UnderlyingV1, const Value *UnderlyingV2);
Evan Cheng50a59142009-10-13 22:02:20 +0000535
Chris Lattner5d56b2d2009-11-23 16:45:27 +0000536 // aliasPHI - Provide a bunch of ad-hoc rules to disambiguate a PHI
537 // instruction against another.
Dan Gohman3da848b2010-10-19 22:54:46 +0000538 AliasResult aliasPHI(const PHINode *PN, uint64_t PNSize,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000539 const MDNode *PNTBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +0000540 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000541 const MDNode *V2TBAAInfo);
Evan Cheng50a59142009-10-13 22:02:20 +0000542
Dan Gohman6665b0e2009-10-26 21:55:43 +0000543 /// aliasSelect - Disambiguate a Select instruction against another value.
Dan Gohman3da848b2010-10-19 22:54:46 +0000544 AliasResult aliasSelect(const SelectInst *SI, uint64_t SISize,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000545 const MDNode *SITBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +0000546 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000547 const MDNode *V2TBAAInfo);
Dan Gohman6665b0e2009-10-26 21:55:43 +0000548
Dan Gohman3da848b2010-10-19 22:54:46 +0000549 AliasResult aliasCheck(const Value *V1, uint64_t V1Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000550 const MDNode *V1TBAATag,
Dan Gohman3da848b2010-10-19 22:54:46 +0000551 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000552 const MDNode *V2TBAATag);
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000553 };
554} // End of anonymous namespace
555
556// Register this pass...
557char BasicAliasAnalysis::ID = 0;
Owen Anderson69acc932011-09-06 23:33:25 +0000558INITIALIZE_AG_PASS_BEGIN(BasicAliasAnalysis, AliasAnalysis, "basicaa",
Dan Gohmandb4708c2010-10-19 23:09:08 +0000559 "Basic Alias Analysis (stateless AA impl)",
Dan Gohmanc1be92f2010-10-18 18:04:47 +0000560 false, true, false)
Owen Anderson69acc932011-09-06 23:33:25 +0000561INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfo)
562INITIALIZE_AG_PASS_END(BasicAliasAnalysis, AliasAnalysis, "basicaa",
563 "Basic Alias Analysis (stateless AA impl)",
564 false, true, false)
565
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000566
567ImmutablePass *llvm::createBasicAliasAnalysisPass() {
568 return new BasicAliasAnalysis();
569}
570
Dan Gohmana25e5db2010-11-08 16:45:26 +0000571/// pointsToConstantMemory - Returns whether the given pointer value
572/// points to memory that is local to the function, with global constants being
573/// considered local to all functions.
574bool
575BasicAliasAnalysis::pointsToConstantMemory(const Location &Loc, bool OrLocal) {
576 assert(Visited.empty() && "Visited must be cleared after use!");
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000577
Dan Gohman3fcfc9f2010-11-08 20:26:19 +0000578 unsigned MaxLookup = 8;
Dan Gohmana25e5db2010-11-08 16:45:26 +0000579 SmallVector<const Value *, 16> Worklist;
580 Worklist.push_back(Loc.Ptr);
581 do {
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000582 const Value *V = GetUnderlyingObject(Worklist.pop_back_val(), TD);
Dan Gohmana25e5db2010-11-08 16:45:26 +0000583 if (!Visited.insert(V)) {
584 Visited.clear();
585 return AliasAnalysis::pointsToConstantMemory(Loc, OrLocal);
586 }
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000587
Dan Gohmana25e5db2010-11-08 16:45:26 +0000588 // An alloca instruction defines local memory.
589 if (OrLocal && isa<AllocaInst>(V))
590 continue;
591
592 // A global constant counts as local memory for our purposes.
593 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
594 // Note: this doesn't require GV to be "ODR" because it isn't legal for a
595 // global to be marked constant in some modules and non-constant in
596 // others. GV may even be a declaration, not a definition.
597 if (!GV->isConstant()) {
598 Visited.clear();
599 return AliasAnalysis::pointsToConstantMemory(Loc, OrLocal);
600 }
601 continue;
602 }
603
604 // If both select values point to local memory, then so does the select.
605 if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
606 Worklist.push_back(SI->getTrueValue());
607 Worklist.push_back(SI->getFalseValue());
608 continue;
609 }
610
611 // If all values incoming to a phi node point to local memory, then so does
612 // the phi.
613 if (const PHINode *PN = dyn_cast<PHINode>(V)) {
Dan Gohman3fcfc9f2010-11-08 20:26:19 +0000614 // Don't bother inspecting phi nodes with many operands.
615 if (PN->getNumIncomingValues() > MaxLookup) {
616 Visited.clear();
617 return AliasAnalysis::pointsToConstantMemory(Loc, OrLocal);
618 }
Dan Gohmana25e5db2010-11-08 16:45:26 +0000619 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
620 Worklist.push_back(PN->getIncomingValue(i));
621 continue;
622 }
623
624 // Otherwise be conservative.
625 Visited.clear();
626 return AliasAnalysis::pointsToConstantMemory(Loc, OrLocal);
627
Dan Gohman3fcfc9f2010-11-08 20:26:19 +0000628 } while (!Worklist.empty() && --MaxLookup);
Dan Gohmana25e5db2010-11-08 16:45:26 +0000629
630 Visited.clear();
Dan Gohman3fcfc9f2010-11-08 20:26:19 +0000631 return Worklist.empty();
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000632}
633
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000634/// getModRefBehavior - Return the behavior when calling the given call site.
635AliasAnalysis::ModRefBehavior
636BasicAliasAnalysis::getModRefBehavior(ImmutableCallSite CS) {
637 if (CS.doesNotAccessMemory())
638 // Can't do better than this.
639 return DoesNotAccessMemory;
640
641 ModRefBehavior Min = UnknownModRefBehavior;
642
643 // If the callsite knows it only reads memory, don't return worse
644 // than that.
645 if (CS.onlyReadsMemory())
646 Min = OnlyReadsMemory;
647
648 // The AliasAnalysis base class has some smarts, lets use them.
Dan Gohman42c31a72010-11-10 01:02:18 +0000649 return ModRefBehavior(AliasAnalysis::getModRefBehavior(CS) & Min);
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000650}
651
652/// getModRefBehavior - Return the behavior when calling the given function.
653/// For use when the call site is not known.
654AliasAnalysis::ModRefBehavior
655BasicAliasAnalysis::getModRefBehavior(const Function *F) {
Dan Gohman431c794a2010-11-08 16:08:43 +0000656 // If the function declares it doesn't access memory, we can't do better.
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000657 if (F->doesNotAccessMemory())
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000658 return DoesNotAccessMemory;
Dan Gohman431c794a2010-11-08 16:08:43 +0000659
660 // For intrinsics, we can check the table.
661 if (unsigned iid = F->getIntrinsicID()) {
662#define GET_INTRINSIC_MODREF_BEHAVIOR
Chandler Carruth351ba142013-01-02 12:09:16 +0000663#include "llvm/IR/Intrinsics.gen"
Dan Gohman431c794a2010-11-08 16:08:43 +0000664#undef GET_INTRINSIC_MODREF_BEHAVIOR
665 }
666
Dan Gohman42c31a72010-11-10 01:02:18 +0000667 ModRefBehavior Min = UnknownModRefBehavior;
668
Dan Gohman431c794a2010-11-08 16:08:43 +0000669 // If the function declares it only reads memory, go with that.
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000670 if (F->onlyReadsMemory())
Dan Gohman42c31a72010-11-10 01:02:18 +0000671 Min = OnlyReadsMemory;
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000672
Dan Gohman431c794a2010-11-08 16:08:43 +0000673 // Otherwise be conservative.
Dan Gohman42c31a72010-11-10 01:02:18 +0000674 return ModRefBehavior(AliasAnalysis::getModRefBehavior(F) & Min);
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000675}
Owen Andersone7942202009-02-05 23:36:27 +0000676
Chris Lattner5d56b2d2009-11-23 16:45:27 +0000677/// getModRefInfo - Check to see if the specified callsite can clobber the
678/// specified memory object. Since we only look at local properties of this
679/// function, we really can't say much about this query. We do, however, use
680/// simple "address taken" analysis on local objects.
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000681AliasAnalysis::ModRefResult
Dan Gohman79fca6f2010-08-03 21:48:53 +0000682BasicAliasAnalysis::getModRefInfo(ImmutableCallSite CS,
Dan Gohmanb2143b62010-09-14 21:25:10 +0000683 const Location &Loc) {
684 assert(notDifferentParent(CS.getInstruction(), Loc.Ptr) &&
Dan Gohman9e86f432010-07-07 14:27:09 +0000685 "AliasAnalysis query involving multiple functions!");
686
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000687 const Value *Object = GetUnderlyingObject(Loc.Ptr, TD);
Chris Lattner92e803c2009-11-22 16:05:05 +0000688
Dan Gohmanb2143b62010-09-14 21:25:10 +0000689 // If this is a tail call and Loc.Ptr points to a stack location, we know that
Chris Lattner92e803c2009-11-22 16:05:05 +0000690 // the tail call cannot access or modify the local stack.
691 // We cannot exclude byval arguments here; these belong to the caller of
692 // the current function not to the current function, and a tail callee
693 // may reference them.
694 if (isa<AllocaInst>(Object))
Dan Gohman79fca6f2010-08-03 21:48:53 +0000695 if (const CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
Chris Lattner92e803c2009-11-22 16:05:05 +0000696 if (CI->isTailCall())
697 return NoModRef;
698
699 // If the pointer is to a locally allocated object that does not escape,
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000700 // then the call can not mod/ref the pointer unless the call takes the pointer
701 // as an argument, and itself doesn't capture it.
Chris Lattner403ac2e2009-11-23 16:46:41 +0000702 if (!isa<Constant>(Object) && CS.getInstruction() != Object &&
Dan Gohman21de4c02010-07-01 20:08:40 +0000703 isNonEscapingLocalObject(Object)) {
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000704 bool PassedAsArg = false;
705 unsigned ArgNo = 0;
Dan Gohman79fca6f2010-08-03 21:48:53 +0000706 for (ImmutableCallSite::arg_iterator CI = CS.arg_begin(), CE = CS.arg_end();
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000707 CI != CE; ++CI, ++ArgNo) {
Chris Lattnerc10ecd82011-05-23 05:15:43 +0000708 // Only look at the no-capture or byval pointer arguments. If this
709 // pointer were passed to arguments that were neither of these, then it
710 // couldn't be no-capture.
Duncan Sands1df98592010-02-16 11:11:14 +0000711 if (!(*CI)->getType()->isPointerTy() ||
Nick Lewycky173862e2011-11-20 19:09:04 +0000712 (!CS.doesNotCapture(ArgNo) && !CS.isByValArgument(ArgNo)))
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000713 continue;
714
Dan Gohmanb2143b62010-09-14 21:25:10 +0000715 // If this is a no-capture pointer argument, see if we can tell that it
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000716 // is impossible to alias the pointer we're checking. If not, we have to
717 // assume that the call could touch the pointer, even though it doesn't
718 // escape.
Eli Friedmane6fadce2011-09-28 00:34:27 +0000719 if (!isNoAlias(Location(*CI), Location(Object))) {
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000720 PassedAsArg = true;
721 break;
722 }
723 }
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000724
Chris Lattnerb34b82e2009-11-23 16:44:43 +0000725 if (!PassedAsArg)
Chris Lattner92e803c2009-11-22 16:05:05 +0000726 return NoModRef;
727 }
728
Owen Anderson69acc932011-09-06 23:33:25 +0000729 const TargetLibraryInfo &TLI = getAnalysis<TargetLibraryInfo>();
Dan Gohman42c31a72010-11-10 01:02:18 +0000730 ModRefResult Min = ModRef;
731
Chris Lattner92e803c2009-11-22 16:05:05 +0000732 // Finally, handle specific knowledge of intrinsics.
Dan Gohman79fca6f2010-08-03 21:48:53 +0000733 const IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction());
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000734 if (II != 0)
735 switch (II->getIntrinsicID()) {
736 default: break;
737 case Intrinsic::memcpy:
738 case Intrinsic::memmove: {
Dan Gohman3da848b2010-10-19 22:54:46 +0000739 uint64_t Len = UnknownSize;
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000740 if (ConstantInt *LenCI = dyn_cast<ConstantInt>(II->getArgOperand(2)))
741 Len = LenCI->getZExtValue();
Gabor Greif71339c92010-06-23 23:38:07 +0000742 Value *Dest = II->getArgOperand(0);
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000743 Value *Src = II->getArgOperand(1);
Chris Lattner13815d92010-11-30 00:43:16 +0000744 // If it can't overlap the source dest, then it doesn't modref the loc.
Dan Gohmanb2143b62010-09-14 21:25:10 +0000745 if (isNoAlias(Location(Dest, Len), Loc)) {
746 if (isNoAlias(Location(Src, Len), Loc))
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000747 return NoModRef;
Chris Lattner13815d92010-11-30 00:43:16 +0000748 // If it can't overlap the dest, then worst case it reads the loc.
Dan Gohman42c31a72010-11-10 01:02:18 +0000749 Min = Ref;
Chris Lattner13815d92010-11-30 00:43:16 +0000750 } else if (isNoAlias(Location(Src, Len), Loc)) {
751 // If it can't overlap the source, then worst case it mutates the loc.
752 Min = Mod;
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000753 }
754 break;
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000755 }
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000756 case Intrinsic::memset:
757 // Since memset is 'accesses arguments' only, the AliasAnalysis base class
758 // will handle it for the variable length case.
759 if (ConstantInt *LenCI = dyn_cast<ConstantInt>(II->getArgOperand(2))) {
Dan Gohman3da848b2010-10-19 22:54:46 +0000760 uint64_t Len = LenCI->getZExtValue();
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000761 Value *Dest = II->getArgOperand(0);
Dan Gohmanb2143b62010-09-14 21:25:10 +0000762 if (isNoAlias(Location(Dest, Len), Loc))
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000763 return NoModRef;
764 }
Chris Lattner201d1e52010-11-30 00:28:45 +0000765 // We know that memset doesn't load anything.
766 Min = Mod;
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000767 break;
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000768 case Intrinsic::lifetime_start:
769 case Intrinsic::lifetime_end:
770 case Intrinsic::invariant_start: {
Dan Gohman3da848b2010-10-19 22:54:46 +0000771 uint64_t PtrSize =
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000772 cast<ConstantInt>(II->getArgOperand(0))->getZExtValue();
Dan Gohmanb2143b62010-09-14 21:25:10 +0000773 if (isNoAlias(Location(II->getArgOperand(1),
774 PtrSize,
775 II->getMetadata(LLVMContext::MD_tbaa)),
776 Loc))
Chris Lattner92e803c2009-11-22 16:05:05 +0000777 return NoModRef;
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000778 break;
Nick Lewycky5c9be672009-10-13 07:48:38 +0000779 }
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000780 case Intrinsic::invariant_end: {
Dan Gohman3da848b2010-10-19 22:54:46 +0000781 uint64_t PtrSize =
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000782 cast<ConstantInt>(II->getArgOperand(1))->getZExtValue();
Dan Gohmanb2143b62010-09-14 21:25:10 +0000783 if (isNoAlias(Location(II->getArgOperand(2),
784 PtrSize,
785 II->getMetadata(LLVMContext::MD_tbaa)),
786 Loc))
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000787 return NoModRef;
788 break;
789 }
Dan Gohman1d7e8182011-04-27 20:44:28 +0000790 case Intrinsic::arm_neon_vld1: {
791 // LLVM's vld1 and vst1 intrinsics currently only support a single
792 // vector register.
793 uint64_t Size =
794 TD ? TD->getTypeStoreSize(II->getType()) : UnknownSize;
795 if (isNoAlias(Location(II->getArgOperand(0), Size,
796 II->getMetadata(LLVMContext::MD_tbaa)),
797 Loc))
798 return NoModRef;
799 break;
800 }
801 case Intrinsic::arm_neon_vst1: {
802 uint64_t Size =
803 TD ? TD->getTypeStoreSize(II->getArgOperand(1)->getType()) : UnknownSize;
804 if (isNoAlias(Location(II->getArgOperand(0), Size,
805 II->getMetadata(LLVMContext::MD_tbaa)),
806 Loc))
807 return NoModRef;
808 break;
809 }
Dan Gohman6ce9d8b2010-08-06 01:25:49 +0000810 }
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000811
Owen Anderson69acc932011-09-06 23:33:25 +0000812 // We can bound the aliasing properties of memset_pattern16 just as we can
813 // for memcpy/memset. This is particularly important because the
814 // LoopIdiomRecognizer likes to turn loops into calls to memset_pattern16
815 // whenever possible.
816 else if (TLI.has(LibFunc::memset_pattern16) &&
817 CS.getCalledFunction() &&
818 CS.getCalledFunction()->getName() == "memset_pattern16") {
819 const Function *MS = CS.getCalledFunction();
820 FunctionType *MemsetType = MS->getFunctionType();
821 if (!MemsetType->isVarArg() && MemsetType->getNumParams() == 3 &&
822 isa<PointerType>(MemsetType->getParamType(0)) &&
823 isa<PointerType>(MemsetType->getParamType(1)) &&
824 isa<IntegerType>(MemsetType->getParamType(2))) {
825 uint64_t Len = UnknownSize;
826 if (const ConstantInt *LenCI = dyn_cast<ConstantInt>(CS.getArgument(2)))
827 Len = LenCI->getZExtValue();
828 const Value *Dest = CS.getArgument(0);
829 const Value *Src = CS.getArgument(1);
830 // If it can't overlap the source dest, then it doesn't modref the loc.
831 if (isNoAlias(Location(Dest, Len), Loc)) {
Owen Andersone421ad62011-09-06 23:43:26 +0000832 // Always reads 16 bytes of the source.
833 if (isNoAlias(Location(Src, 16), Loc))
Owen Anderson69acc932011-09-06 23:33:25 +0000834 return NoModRef;
835 // If it can't overlap the dest, then worst case it reads the loc.
836 Min = Ref;
Owen Andersone421ad62011-09-06 23:43:26 +0000837 // Always reads 16 bytes of the source.
838 } else if (isNoAlias(Location(Src, 16), Loc)) {
Owen Anderson69acc932011-09-06 23:33:25 +0000839 // If it can't overlap the source, then worst case it mutates the loc.
840 Min = Mod;
841 }
842 }
843 }
844
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000845 // The AliasAnalysis base class has some smarts, lets use them.
Dan Gohman42c31a72010-11-10 01:02:18 +0000846 return ModRefResult(AliasAnalysis::getModRefInfo(CS, Loc) & Min);
Dan Gohman65924112010-09-08 01:32:20 +0000847}
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000848
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000849static bool areVarIndicesEqual(SmallVector<VariableGEPIndex, 4> &Indices1,
850 SmallVector<VariableGEPIndex, 4> &Indices2) {
851 unsigned Size1 = Indices1.size();
852 unsigned Size2 = Indices2.size();
853
854 if (Size1 != Size2)
855 return false;
856
857 for (unsigned I = 0; I != Size1; ++I)
858 if (Indices1[I] != Indices2[I])
859 return false;
860
861 return true;
862}
863
Chris Lattner539c9b92009-11-26 02:11:08 +0000864/// aliasGEP - Provide a bunch of ad-hoc rules to disambiguate a GEP instruction
865/// against another pointer. We know that V1 is a GEP, but we don't know
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000866/// anything about V2. UnderlyingV1 is GetUnderlyingObject(GEP1, TD),
Chris Lattner23e2a5b2009-11-26 02:14:59 +0000867/// UnderlyingV2 is the same for V2.
Chris Lattner539c9b92009-11-26 02:11:08 +0000868///
Chris Lattnerd501c132003-02-26 19:41:54 +0000869AliasAnalysis::AliasResult
Dan Gohman3da848b2010-10-19 22:54:46 +0000870BasicAliasAnalysis::aliasGEP(const GEPOperator *GEP1, uint64_t V1Size,
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000871 const MDNode *V1TBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +0000872 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000873 const MDNode *V2TBAAInfo,
Chris Lattner23e2a5b2009-11-26 02:14:59 +0000874 const Value *UnderlyingV1,
875 const Value *UnderlyingV2) {
Chris Lattnerd84eb912009-11-26 02:17:34 +0000876 int64_t GEP1BaseOffset;
Chris Lattner8807e9f2010-08-18 22:47:56 +0000877 SmallVector<VariableGEPIndex, 4> GEP1VariableIndices;
Chris Lattnerd84eb912009-11-26 02:17:34 +0000878
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000879 // If we have two gep instructions with must-alias or not-alias'ing base
880 // pointers, figure out if the indexes to the GEP tell us anything about the
881 // derived pointer.
Chris Lattner539c9b92009-11-26 02:11:08 +0000882 if (const GEPOperator *GEP2 = dyn_cast<GEPOperator>(V2)) {
Arnold Schwaighofer742dbc12013-03-26 18:07:53 +0000883 // Do the base pointers alias?
884 AliasResult BaseAlias = aliasCheck(UnderlyingV1, UnknownSize, 0,
885 UnderlyingV2, UnknownSize, 0);
886
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000887 // Check for geps of non-aliasing underlying pointers where the offsets are
888 // identical.
Arnold Schwaighofer742dbc12013-03-26 18:07:53 +0000889 if ((BaseAlias == MayAlias) && V1Size == V2Size) {
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000890 // Do the base pointers alias assuming type and size.
891 AliasResult PreciseBaseAlias = aliasCheck(UnderlyingV1, V1Size,
892 V1TBAAInfo, UnderlyingV2,
893 V2Size, V2TBAAInfo);
894 if (PreciseBaseAlias == NoAlias) {
895 // See if the computed offset from the common pointer tells us about the
896 // relation of the resulting pointer.
897 int64_t GEP2BaseOffset;
898 SmallVector<VariableGEPIndex, 4> GEP2VariableIndices;
899 const Value *GEP2BasePtr =
900 DecomposeGEPExpression(GEP2, GEP2BaseOffset, GEP2VariableIndices, TD);
901 const Value *GEP1BasePtr =
902 DecomposeGEPExpression(GEP1, GEP1BaseOffset, GEP1VariableIndices, TD);
903 // DecomposeGEPExpression and GetUnderlyingObject should return the
Micah Villmow3574eca2012-10-08 16:38:25 +0000904 // same result except when DecomposeGEPExpression has no DataLayout.
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000905 if (GEP1BasePtr != UnderlyingV1 || GEP2BasePtr != UnderlyingV2) {
906 assert(TD == 0 &&
907 "DecomposeGEPExpression and GetUnderlyingObject disagree!");
908 return MayAlias;
909 }
910 // Same offsets.
911 if (GEP1BaseOffset == GEP2BaseOffset &&
912 areVarIndicesEqual(GEP1VariableIndices, GEP2VariableIndices))
913 return NoAlias;
914 GEP1VariableIndices.clear();
915 }
916 }
Chris Lattnerd84eb912009-11-26 02:17:34 +0000917
918 // If we get a No or May, then return it immediately, no amount of analysis
919 // will improve this situation.
920 if (BaseAlias != MustAlias) return BaseAlias;
921
922 // Otherwise, we have a MustAlias. Since the base pointers alias each other
923 // exactly, see if the computed offset from the common pointer tells us
924 // about the relation of the resulting pointer.
925 const Value *GEP1BasePtr =
926 DecomposeGEPExpression(GEP1, GEP1BaseOffset, GEP1VariableIndices, TD);
927
928 int64_t GEP2BaseOffset;
Chris Lattner8807e9f2010-08-18 22:47:56 +0000929 SmallVector<VariableGEPIndex, 4> GEP2VariableIndices;
Chris Lattnerd84eb912009-11-26 02:17:34 +0000930 const Value *GEP2BasePtr =
931 DecomposeGEPExpression(GEP2, GEP2BaseOffset, GEP2VariableIndices, TD);
932
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000933 // DecomposeGEPExpression and GetUnderlyingObject should return the
Micah Villmow3574eca2012-10-08 16:38:25 +0000934 // same result except when DecomposeGEPExpression has no DataLayout.
Chris Lattnerd84eb912009-11-26 02:17:34 +0000935 if (GEP1BasePtr != UnderlyingV1 || GEP2BasePtr != UnderlyingV2) {
936 assert(TD == 0 &&
Dan Gohman5034dd32010-12-15 20:02:24 +0000937 "DecomposeGEPExpression and GetUnderlyingObject disagree!");
Chris Lattnerd84eb912009-11-26 02:17:34 +0000938 return MayAlias;
939 }
940
941 // Subtract the GEP2 pointer from the GEP1 pointer to find out their
942 // symbolic difference.
943 GEP1BaseOffset -= GEP2BaseOffset;
Dan Gohman6fc24462010-08-03 20:23:52 +0000944 GetIndexDifference(GEP1VariableIndices, GEP2VariableIndices);
Chris Lattnerd84eb912009-11-26 02:17:34 +0000945
946 } else {
947 // Check to see if these two pointers are related by the getelementptr
948 // instruction. If one pointer is a GEP with a non-zero index of the other
949 // pointer, we know they cannot alias.
Chris Lattner53692502009-11-26 16:52:32 +0000950
951 // If both accesses are unknown size, we can't do anything useful here.
Dan Gohmanef1cfac2010-08-03 01:03:11 +0000952 if (V1Size == UnknownSize && V2Size == UnknownSize)
Chris Lattnerd84eb912009-11-26 02:17:34 +0000953 return MayAlias;
Chris Lattnerb307c882003-12-11 22:44:13 +0000954
Dan Gohman6cc7c9b2010-10-18 18:45:11 +0000955 AliasResult R = aliasCheck(UnderlyingV1, UnknownSize, 0,
956 V2, V2Size, V2TBAAInfo);
Chris Lattnerd84eb912009-11-26 02:17:34 +0000957 if (R != MustAlias)
958 // If V2 may alias GEP base pointer, conservatively returns MayAlias.
959 // If V2 is known not to alias GEP base pointer, then the two values
960 // cannot alias per GEP semantics: "A pointer value formed from a
961 // getelementptr instruction is associated with the addresses associated
962 // with the first operand of the getelementptr".
963 return R;
Chris Lattnerb307c882003-12-11 22:44:13 +0000964
Chris Lattnerd84eb912009-11-26 02:17:34 +0000965 const Value *GEP1BasePtr =
966 DecomposeGEPExpression(GEP1, GEP1BaseOffset, GEP1VariableIndices, TD);
967
Arnold Schwaighofer02903262012-09-06 14:31:51 +0000968 // DecomposeGEPExpression and GetUnderlyingObject should return the
Micah Villmow3574eca2012-10-08 16:38:25 +0000969 // same result except when DecomposeGEPExpression has no DataLayout.
Chris Lattnerd84eb912009-11-26 02:17:34 +0000970 if (GEP1BasePtr != UnderlyingV1) {
971 assert(TD == 0 &&
Dan Gohman5034dd32010-12-15 20:02:24 +0000972 "DecomposeGEPExpression and GetUnderlyingObject disagree!");
Chris Lattnerd84eb912009-11-26 02:17:34 +0000973 return MayAlias;
Chris Lattnerb307c882003-12-11 22:44:13 +0000974 }
975 }
Chris Lattnerd84eb912009-11-26 02:17:34 +0000976
977 // In the two GEP Case, if there is no difference in the offsets of the
978 // computed pointers, the resultant pointers are a must alias. This
979 // hapens when we have two lexically identical GEP's (for example).
Chris Lattnerd501c132003-02-26 19:41:54 +0000980 //
Chris Lattnerd84eb912009-11-26 02:17:34 +0000981 // In the other case, if we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2
982 // must aliases the GEP, the end result is a must alias also.
983 if (GEP1BaseOffset == 0 && GEP1VariableIndices.empty())
Evan Cheng681a33e2009-10-14 06:41:49 +0000984 return MustAlias;
Evan Cheng094f04b2009-10-13 18:42:04 +0000985
Eli Friedman81ac8dd2011-09-08 02:23:31 +0000986 // If there is a constant difference between the pointers, but the difference
987 // is less than the size of the associated memory object, then we know
988 // that the objects are partially overlapping. If the difference is
989 // greater, we know they do not overlap.
Dan Gohman0f7f1942010-12-13 22:50:24 +0000990 if (GEP1BaseOffset != 0 && GEP1VariableIndices.empty()) {
Eli Friedman81ac8dd2011-09-08 02:23:31 +0000991 if (GEP1BaseOffset >= 0) {
992 if (V2Size != UnknownSize) {
993 if ((uint64_t)GEP1BaseOffset < V2Size)
994 return PartialAlias;
995 return NoAlias;
996 }
997 } else {
998 if (V1Size != UnknownSize) {
999 if (-(uint64_t)GEP1BaseOffset < V1Size)
1000 return PartialAlias;
1001 return NoAlias;
1002 }
1003 }
Dan Gohman0f7f1942010-12-13 22:50:24 +00001004 }
1005
Eli Friedman81ac8dd2011-09-08 02:23:31 +00001006 // Try to distinguish something like &A[i][1] against &A[42][0].
1007 // Grab the least significant bit set in any of the scales.
Eli Friedman184166d2011-09-08 02:37:07 +00001008 if (!GEP1VariableIndices.empty()) {
1009 uint64_t Modulo = 0;
1010 for (unsigned i = 0, e = GEP1VariableIndices.size(); i != e; ++i)
1011 Modulo |= (uint64_t)GEP1VariableIndices[i].Scale;
1012 Modulo = Modulo ^ (Modulo & (Modulo - 1));
Eli Friedman81ac8dd2011-09-08 02:23:31 +00001013
Eli Friedman184166d2011-09-08 02:37:07 +00001014 // We can compute the difference between the two addresses
1015 // mod Modulo. Check whether that difference guarantees that the
1016 // two locations do not alias.
1017 uint64_t ModOffset = (uint64_t)GEP1BaseOffset & (Modulo - 1);
1018 if (V1Size != UnknownSize && V2Size != UnknownSize &&
1019 ModOffset >= V2Size && V1Size <= Modulo - ModOffset)
1020 return NoAlias;
1021 }
Eli Friedman81ac8dd2011-09-08 02:23:31 +00001022
Dan Gohman5f1312c2011-06-04 06:50:18 +00001023 // Statically, we can see that the base objects are the same, but the
1024 // pointers have dynamic offsets which we can't resolve. And none of our
1025 // little tricks above worked.
1026 //
1027 // TODO: Returning PartialAlias instead of MayAlias is a mild hack; the
1028 // practical effect of this is protecting TBAA in the case of dynamic
Dan Gohmanebad58d2012-02-17 18:33:38 +00001029 // indices into arrays of unions or malloc'd memory.
Dan Gohman5f1312c2011-06-04 06:50:18 +00001030 return PartialAlias;
Evan Cheng094f04b2009-10-13 18:42:04 +00001031}
1032
Dan Gohman965fefa2011-06-03 20:17:36 +00001033static AliasAnalysis::AliasResult
1034MergeAliasResults(AliasAnalysis::AliasResult A, AliasAnalysis::AliasResult B) {
1035 // If the results agree, take it.
1036 if (A == B)
1037 return A;
1038 // A mix of PartialAlias and MustAlias is PartialAlias.
1039 if ((A == AliasAnalysis::PartialAlias && B == AliasAnalysis::MustAlias) ||
1040 (B == AliasAnalysis::PartialAlias && A == AliasAnalysis::MustAlias))
1041 return AliasAnalysis::PartialAlias;
1042 // Otherwise, we don't know anything.
1043 return AliasAnalysis::MayAlias;
1044}
1045
Chris Lattner5d56b2d2009-11-23 16:45:27 +00001046/// aliasSelect - Provide a bunch of ad-hoc rules to disambiguate a Select
1047/// instruction against another.
Dan Gohman6665b0e2009-10-26 21:55:43 +00001048AliasAnalysis::AliasResult
Dan Gohman3da848b2010-10-19 22:54:46 +00001049BasicAliasAnalysis::aliasSelect(const SelectInst *SI, uint64_t SISize,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001050 const MDNode *SITBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +00001051 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001052 const MDNode *V2TBAAInfo) {
Dan Gohman6665b0e2009-10-26 21:55:43 +00001053 // If the values are Selects with the same condition, we can do a more precise
1054 // check: just check for aliases between the values on corresponding arms.
1055 if (const SelectInst *SI2 = dyn_cast<SelectInst>(V2))
1056 if (SI->getCondition() == SI2->getCondition()) {
1057 AliasResult Alias =
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001058 aliasCheck(SI->getTrueValue(), SISize, SITBAAInfo,
1059 SI2->getTrueValue(), V2Size, V2TBAAInfo);
Dan Gohman6665b0e2009-10-26 21:55:43 +00001060 if (Alias == MayAlias)
1061 return MayAlias;
1062 AliasResult ThisAlias =
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001063 aliasCheck(SI->getFalseValue(), SISize, SITBAAInfo,
1064 SI2->getFalseValue(), V2Size, V2TBAAInfo);
Dan Gohman965fefa2011-06-03 20:17:36 +00001065 return MergeAliasResults(ThisAlias, Alias);
Dan Gohman6665b0e2009-10-26 21:55:43 +00001066 }
1067
1068 // If both arms of the Select node NoAlias or MustAlias V2, then returns
1069 // NoAlias / MustAlias. Otherwise, returns MayAlias.
1070 AliasResult Alias =
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001071 aliasCheck(V2, V2Size, V2TBAAInfo, SI->getTrueValue(), SISize, SITBAAInfo);
Dan Gohman6665b0e2009-10-26 21:55:43 +00001072 if (Alias == MayAlias)
1073 return MayAlias;
Dan Gohman50f424c2010-06-28 21:16:52 +00001074
Dan Gohman6665b0e2009-10-26 21:55:43 +00001075 AliasResult ThisAlias =
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001076 aliasCheck(V2, V2Size, V2TBAAInfo, SI->getFalseValue(), SISize, SITBAAInfo);
Dan Gohman965fefa2011-06-03 20:17:36 +00001077 return MergeAliasResults(ThisAlias, Alias);
Dan Gohman6665b0e2009-10-26 21:55:43 +00001078}
1079
Evan Chengd83c2ca2009-10-14 05:22:03 +00001080// aliasPHI - Provide a bunch of ad-hoc rules to disambiguate a PHI instruction
Evan Cheng3dbe43b2009-10-14 05:05:02 +00001081// against another.
Evan Cheng50a59142009-10-13 22:02:20 +00001082AliasAnalysis::AliasResult
Dan Gohman3da848b2010-10-19 22:54:46 +00001083BasicAliasAnalysis::aliasPHI(const PHINode *PN, uint64_t PNSize,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001084 const MDNode *PNTBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +00001085 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001086 const MDNode *V2TBAAInfo) {
Dan Gohman6665b0e2009-10-26 21:55:43 +00001087 // If the values are PHIs in the same block, we can do a more precise
1088 // as well as efficient check: just check for aliases between the values
1089 // on corresponding edges.
1090 if (const PHINode *PN2 = dyn_cast<PHINode>(V2))
1091 if (PN2->getParent() == PN->getParent()) {
Arnold Schwaighofer3d5f96e2012-09-06 14:41:53 +00001092 LocPair Locs(Location(PN, PNSize, PNTBAAInfo),
1093 Location(V2, V2Size, V2TBAAInfo));
1094 if (PN > V2)
1095 std::swap(Locs.first, Locs.second);
Arnold Schwaighofer2b475922012-12-10 23:02:41 +00001096 // Analyse the PHIs' inputs under the assumption that the PHIs are
1097 // NoAlias.
1098 // If the PHIs are May/MustAlias there must be (recursively) an input
1099 // operand from outside the PHIs' cycle that is MayAlias/MustAlias or
1100 // there must be an operation on the PHIs within the PHIs' value cycle
1101 // that causes a MayAlias.
1102 // Pretend the phis do not alias.
1103 AliasResult Alias = NoAlias;
1104 assert(AliasCache.count(Locs) &&
1105 "There must exist an entry for the phi node");
1106 AliasResult OrigAliasResult = AliasCache[Locs];
1107 AliasCache[Locs] = NoAlias;
Arnold Schwaighofer3d5f96e2012-09-06 14:41:53 +00001108
Hal Finkelc37f5022012-11-17 02:33:15 +00001109 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
Dan Gohman6665b0e2009-10-26 21:55:43 +00001110 AliasResult ThisAlias =
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001111 aliasCheck(PN->getIncomingValue(i), PNSize, PNTBAAInfo,
Dan Gohman6665b0e2009-10-26 21:55:43 +00001112 PN2->getIncomingValueForBlock(PN->getIncomingBlock(i)),
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001113 V2Size, V2TBAAInfo);
Dan Gohman965fefa2011-06-03 20:17:36 +00001114 Alias = MergeAliasResults(ThisAlias, Alias);
1115 if (Alias == MayAlias)
1116 break;
Dan Gohman6665b0e2009-10-26 21:55:43 +00001117 }
Arnold Schwaighofer3d5f96e2012-09-06 14:41:53 +00001118
1119 // Reset if speculation failed.
Arnold Schwaighofer2b475922012-12-10 23:02:41 +00001120 if (Alias != NoAlias)
Arnold Schwaighofer3d5f96e2012-09-06 14:41:53 +00001121 AliasCache[Locs] = OrigAliasResult;
1122
Dan Gohman6665b0e2009-10-26 21:55:43 +00001123 return Alias;
1124 }
1125
Evan Chenga846a8a2009-10-16 00:33:09 +00001126 SmallPtrSet<Value*, 4> UniqueSrc;
Evan Cheng50a59142009-10-13 22:02:20 +00001127 SmallVector<Value*, 4> V1Srcs;
Evan Cheng50a59142009-10-13 22:02:20 +00001128 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1129 Value *PV1 = PN->getIncomingValue(i);
1130 if (isa<PHINode>(PV1))
1131 // If any of the source itself is a PHI, return MayAlias conservatively
Evan Cheng681a33e2009-10-14 06:41:49 +00001132 // to avoid compile time explosion. The worst possible case is if both
1133 // sides are PHI nodes. In which case, this is O(m x n) time where 'm'
1134 // and 'n' are the number of PHI sources.
Evan Cheng50a59142009-10-13 22:02:20 +00001135 return MayAlias;
1136 if (UniqueSrc.insert(PV1))
1137 V1Srcs.push_back(PV1);
1138 }
1139
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001140 AliasResult Alias = aliasCheck(V2, V2Size, V2TBAAInfo,
1141 V1Srcs[0], PNSize, PNTBAAInfo);
Evan Chengd83c2ca2009-10-14 05:22:03 +00001142 // Early exit if the check of the first PHI source against V2 is MayAlias.
1143 // Other results are not possible.
1144 if (Alias == MayAlias)
1145 return MayAlias;
1146
Evan Cheng50a59142009-10-13 22:02:20 +00001147 // If all sources of the PHI node NoAlias or MustAlias V2, then returns
1148 // NoAlias / MustAlias. Otherwise, returns MayAlias.
Evan Cheng50a59142009-10-13 22:02:20 +00001149 for (unsigned i = 1, e = V1Srcs.size(); i != e; ++i) {
1150 Value *V = V1Srcs[i];
Dan Gohman6665b0e2009-10-26 21:55:43 +00001151
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001152 AliasResult ThisAlias = aliasCheck(V2, V2Size, V2TBAAInfo,
1153 V, PNSize, PNTBAAInfo);
Dan Gohman965fefa2011-06-03 20:17:36 +00001154 Alias = MergeAliasResults(ThisAlias, Alias);
1155 if (Alias == MayAlias)
1156 break;
Evan Cheng50a59142009-10-13 22:02:20 +00001157 }
1158
1159 return Alias;
1160}
1161
1162// aliasCheck - Provide a bunch of ad-hoc rules to disambiguate in common cases,
1163// such as array references.
Evan Cheng094f04b2009-10-13 18:42:04 +00001164//
1165AliasAnalysis::AliasResult
Dan Gohman3da848b2010-10-19 22:54:46 +00001166BasicAliasAnalysis::aliasCheck(const Value *V1, uint64_t V1Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001167 const MDNode *V1TBAAInfo,
Dan Gohman3da848b2010-10-19 22:54:46 +00001168 const Value *V2, uint64_t V2Size,
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001169 const MDNode *V2TBAAInfo) {
Dan Gohmanb57b6f12010-04-08 18:11:50 +00001170 // If either of the memory references is empty, it doesn't matter what the
1171 // pointer values are.
1172 if (V1Size == 0 || V2Size == 0)
1173 return NoAlias;
1174
Evan Cheng094f04b2009-10-13 18:42:04 +00001175 // Strip off any casts if they exist.
1176 V1 = V1->stripPointerCasts();
1177 V2 = V2->stripPointerCasts();
1178
1179 // Are we checking for alias of the same value?
1180 if (V1 == V2) return MustAlias;
1181
Duncan Sands1df98592010-02-16 11:11:14 +00001182 if (!V1->getType()->isPointerTy() || !V2->getType()->isPointerTy())
Evan Cheng094f04b2009-10-13 18:42:04 +00001183 return NoAlias; // Scalars cannot alias each other
1184
1185 // Figure out what objects these things are pointing to if we can.
Dan Gohmanbd1801b2011-01-24 18:53:32 +00001186 const Value *O1 = GetUnderlyingObject(V1, TD);
1187 const Value *O2 = GetUnderlyingObject(V2, TD);
Evan Cheng094f04b2009-10-13 18:42:04 +00001188
Dan Gohmanf75ef662009-11-09 19:29:11 +00001189 // Null values in the default address space don't point to any object, so they
1190 // don't alias any other pointer.
1191 if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O1))
1192 if (CPN->getType()->getAddressSpace() == 0)
1193 return NoAlias;
1194 if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O2))
1195 if (CPN->getType()->getAddressSpace() == 0)
1196 return NoAlias;
1197
Evan Cheng094f04b2009-10-13 18:42:04 +00001198 if (O1 != O2) {
1199 // If V1/V2 point to two different objects we know that we have no alias.
Dan Gohman9e86f432010-07-07 14:27:09 +00001200 if (isIdentifiedObject(O1) && isIdentifiedObject(O2))
Evan Cheng094f04b2009-10-13 18:42:04 +00001201 return NoAlias;
Nick Lewycky20162ac2009-11-14 06:15:14 +00001202
1203 // Constant pointers can't alias with non-const isIdentifiedObject objects.
Dan Gohman9e86f432010-07-07 14:27:09 +00001204 if ((isa<Constant>(O1) && isIdentifiedObject(O2) && !isa<Constant>(O2)) ||
1205 (isa<Constant>(O2) && isIdentifiedObject(O1) && !isa<Constant>(O1)))
Nick Lewycky20162ac2009-11-14 06:15:14 +00001206 return NoAlias;
1207
Dan Gohman21de4c02010-07-01 20:08:40 +00001208 // Arguments can't alias with local allocations or noalias calls
1209 // in the same function.
Dan Gohman9e86f432010-07-07 14:27:09 +00001210 if (((isa<Argument>(O1) && (isa<AllocaInst>(O2) || isNoAliasCall(O2))) ||
Dan Gohman21de4c02010-07-01 20:08:40 +00001211 (isa<Argument>(O2) && (isa<AllocaInst>(O1) || isNoAliasCall(O1)))))
1212 return NoAlias;
Evan Cheng094f04b2009-10-13 18:42:04 +00001213
1214 // Most objects can't alias null.
Dan Gohman9e86f432010-07-07 14:27:09 +00001215 if ((isa<ConstantPointerNull>(O2) && isKnownNonNull(O1)) ||
1216 (isa<ConstantPointerNull>(O1) && isKnownNonNull(O2)))
Evan Cheng094f04b2009-10-13 18:42:04 +00001217 return NoAlias;
Evan Cheng094f04b2009-10-13 18:42:04 +00001218
Dan Gohmanb8c86a02010-07-07 14:30:04 +00001219 // If one pointer is the result of a call/invoke or load and the other is a
1220 // non-escaping local object within the same function, then we know the
1221 // object couldn't escape to a point where the call could return it.
1222 //
1223 // Note that if the pointers are in different functions, there are a
1224 // variety of complications. A call with a nocapture argument may still
1225 // temporary store the nocapture argument's value in a temporary memory
1226 // location if that memory location doesn't escape. Or it may pass a
1227 // nocapture value to other functions as long as they don't capture it.
1228 if (isEscapeSource(O1) && isNonEscapingLocalObject(O2))
1229 return NoAlias;
1230 if (isEscapeSource(O2) && isNonEscapingLocalObject(O1))
1231 return NoAlias;
1232 }
1233
Evan Cheng094f04b2009-10-13 18:42:04 +00001234 // If the size of one access is larger than the entire object on the other
1235 // side, then we know such behavior is undefined and can assume no alias.
Evan Cheng094f04b2009-10-13 18:42:04 +00001236 if (TD)
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +00001237 if ((V1Size != UnknownSize && isObjectSmallerThan(O2, V1Size, *TD, *TLI)) ||
1238 (V2Size != UnknownSize && isObjectSmallerThan(O1, V2Size, *TD, *TLI)))
Evan Cheng094f04b2009-10-13 18:42:04 +00001239 return NoAlias;
1240
Dan Gohman1fc18d72011-06-04 00:31:50 +00001241 // Check the cache before climbing up use-def chains. This also terminates
1242 // otherwise infinitely recursive queries.
1243 LocPair Locs(Location(V1, V1Size, V1TBAAInfo),
1244 Location(V2, V2Size, V2TBAAInfo));
1245 if (V1 > V2)
1246 std::swap(Locs.first, Locs.second);
1247 std::pair<AliasCacheTy::iterator, bool> Pair =
1248 AliasCache.insert(std::make_pair(Locs, MayAlias));
1249 if (!Pair.second)
1250 return Pair.first->second;
1251
Chris Lattner4e91ee72009-11-26 02:13:03 +00001252 // FIXME: This isn't aggressively handling alias(GEP, PHI) for example: if the
1253 // GEP can't simplify, we don't even look at the PHI cases.
Chris Lattner391d23b2009-10-17 23:48:54 +00001254 if (!isa<GEPOperator>(V1) && isa<GEPOperator>(V2)) {
Chris Lattnerd501c132003-02-26 19:41:54 +00001255 std::swap(V1, V2);
1256 std::swap(V1Size, V2Size);
Chris Lattner23e2a5b2009-11-26 02:14:59 +00001257 std::swap(O1, O2);
Duncan Sandsa1beca62012-11-04 09:02:45 +00001258 std::swap(V1TBAAInfo, V2TBAAInfo);
Chris Lattnerd501c132003-02-26 19:41:54 +00001259 }
Dan Gohmanc1be92f2010-10-18 18:04:47 +00001260 if (const GEPOperator *GV1 = dyn_cast<GEPOperator>(V1)) {
Arnold Schwaighofer02903262012-09-06 14:31:51 +00001261 AliasResult Result = aliasGEP(GV1, V1Size, V1TBAAInfo, V2, V2Size, V2TBAAInfo, O1, O2);
Dan Gohman1fc18d72011-06-04 00:31:50 +00001262 if (Result != MayAlias) return AliasCache[Locs] = Result;
Dan Gohmanc1be92f2010-10-18 18:04:47 +00001263 }
Evan Cheng50a59142009-10-13 22:02:20 +00001264
1265 if (isa<PHINode>(V2) && !isa<PHINode>(V1)) {
1266 std::swap(V1, V2);
1267 std::swap(V1Size, V2Size);
Duncan Sandsa1beca62012-11-04 09:02:45 +00001268 std::swap(V1TBAAInfo, V2TBAAInfo);
Evan Cheng50a59142009-10-13 22:02:20 +00001269 }
Dan Gohmanc1be92f2010-10-18 18:04:47 +00001270 if (const PHINode *PN = dyn_cast<PHINode>(V1)) {
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001271 AliasResult Result = aliasPHI(PN, V1Size, V1TBAAInfo,
1272 V2, V2Size, V2TBAAInfo);
Dan Gohman1fc18d72011-06-04 00:31:50 +00001273 if (Result != MayAlias) return AliasCache[Locs] = Result;
Dan Gohmanc1be92f2010-10-18 18:04:47 +00001274 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00001275
Dan Gohman6665b0e2009-10-26 21:55:43 +00001276 if (isa<SelectInst>(V2) && !isa<SelectInst>(V1)) {
1277 std::swap(V1, V2);
1278 std::swap(V1Size, V2Size);
Duncan Sandsa1beca62012-11-04 09:02:45 +00001279 std::swap(V1TBAAInfo, V2TBAAInfo);
Dan Gohman6665b0e2009-10-26 21:55:43 +00001280 }
Dan Gohmanc1be92f2010-10-18 18:04:47 +00001281 if (const SelectInst *S1 = dyn_cast<SelectInst>(V1)) {
Dan Gohman6cc7c9b2010-10-18 18:45:11 +00001282 AliasResult Result = aliasSelect(S1, 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 }
Dan Gohman6665b0e2009-10-26 21:55:43 +00001286
Dan Gohman615da1a2011-01-18 21:16:06 +00001287 // If both pointers are pointing into the same object and one of them
1288 // accesses is accessing the entire object, then the accesses must
1289 // overlap in some way.
1290 if (TD && O1 == O2)
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +00001291 if ((V1Size != UnknownSize && isObjectSize(O1, V1Size, *TD, *TLI)) ||
1292 (V2Size != UnknownSize && isObjectSize(O2, V2Size, *TD, *TLI)))
Dan Gohman1fc18d72011-06-04 00:31:50 +00001293 return AliasCache[Locs] = PartialAlias;
Dan Gohman615da1a2011-01-18 21:16:06 +00001294
Dan Gohman1fc18d72011-06-04 00:31:50 +00001295 AliasResult Result =
1296 AliasAnalysis::alias(Location(V1, V1Size, V1TBAAInfo),
1297 Location(V2, V2Size, V2TBAAInfo));
1298 return AliasCache[Locs] = Result;
Chris Lattnerd501c132003-02-26 19:41:54 +00001299}