blob: e0723026de72464197c5bc4e63c605f8efe94809 [file] [log] [blame]
Chris Lattner26dff502004-06-28 06:33:13 +00001//===- GlobalsModRef.cpp - Simple Mod/Ref Analysis for Globals ------------===//
Misha Brukman01808ca2005-04-21 21:13:18 +00002//
Chris Lattner26dff502004-06-28 06:33:13 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman01808ca2005-04-21 21:13:18 +00007//
Chris Lattner26dff502004-06-28 06:33:13 +00008//===----------------------------------------------------------------------===//
9//
10// This simple pass provides alias and mod/ref information for global values
Chris Lattner3a353e82004-07-27 06:40:37 +000011// that do not have their address taken, and keeps track of whether functions
12// read or write memory (are "pure"). For this simple (but very common) case,
13// we can provide pretty accurate and useful information.
Chris Lattner26dff502004-06-28 06:33:13 +000014//
15//===----------------------------------------------------------------------===//
16
Chris Lattner57ef9422006-12-19 22:30:33 +000017#define DEBUG_TYPE "globalsmodref-aa"
Chris Lattner26dff502004-06-28 06:33:13 +000018#include "llvm/Analysis/Passes.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000019#include "llvm/ADT/SCCIterator.h"
20#include "llvm/ADT/Statistic.h"
Chris Lattner26dff502004-06-28 06:33:13 +000021#include "llvm/Analysis/AliasAnalysis.h"
22#include "llvm/Analysis/CallGraph.h"
Victor Hernandezf390e042009-10-27 20:05:49 +000023#include "llvm/Analysis/MemoryBuiltins.h"
Dan Gohmana4fcd242010-12-15 20:02:24 +000024#include "llvm/Analysis/ValueTracking.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000025#include "llvm/IR/Constants.h"
26#include "llvm/IR/DerivedTypes.h"
27#include "llvm/IR/Instructions.h"
28#include "llvm/IR/IntrinsicInst.h"
29#include "llvm/IR/Module.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000030#include "llvm/Pass.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000031#include "llvm/Support/CommandLine.h"
Reid Spencerf75727a2007-02-05 23:42:17 +000032#include "llvm/Support/InstIterator.h"
Chris Lattner26dff502004-06-28 06:33:13 +000033#include <set>
34using namespace llvm;
35
Chris Lattner57ef9422006-12-19 22:30:33 +000036STATISTIC(NumNonAddrTakenGlobalVars,
37 "Number of global vars without address taken");
38STATISTIC(NumNonAddrTakenFunctions,"Number of functions without address taken");
39STATISTIC(NumNoMemFunctions, "Number of functions that do not access memory");
40STATISTIC(NumReadMemFunctions, "Number of functions that only read memory");
41STATISTIC(NumIndirectGlobalVars, "Number of indirect global objects");
42
Chris Lattner26dff502004-06-28 06:33:13 +000043namespace {
Chris Lattner3a353e82004-07-27 06:40:37 +000044 /// FunctionRecord - One instance of this structure is stored for every
45 /// function in the program. Later, the entries for these functions are
46 /// removed if the function is found to call an external function (in which
47 /// case we know nothing about it.
Nick Lewycky02d5f772009-10-25 06:33:48 +000048 struct FunctionRecord {
Chris Lattner3a353e82004-07-27 06:40:37 +000049 /// GlobalInfo - Maintain mod/ref info for all of the globals without
50 /// addresses taken that are read or written (transitively) by this
51 /// function.
Dan Gohman5442c712010-08-03 21:48:53 +000052 std::map<const GlobalValue*, unsigned> GlobalInfo;
Chris Lattner3a353e82004-07-27 06:40:37 +000053
Duncan Sands06dbb122008-09-12 07:29:58 +000054 /// MayReadAnyGlobal - May read global variables, but it is not known which.
55 bool MayReadAnyGlobal;
56
Dan Gohman5442c712010-08-03 21:48:53 +000057 unsigned getInfoForGlobal(const GlobalValue *GV) const {
Duncan Sands06dbb122008-09-12 07:29:58 +000058 unsigned Effect = MayReadAnyGlobal ? AliasAnalysis::Ref : 0;
Dan Gohman5442c712010-08-03 21:48:53 +000059 std::map<const GlobalValue*, unsigned>::const_iterator I =
60 GlobalInfo.find(GV);
Chris Lattner3a353e82004-07-27 06:40:37 +000061 if (I != GlobalInfo.end())
Duncan Sands06dbb122008-09-12 07:29:58 +000062 Effect |= I->second;
63 return Effect;
Chris Lattner3a353e82004-07-27 06:40:37 +000064 }
Misha Brukman01808ca2005-04-21 21:13:18 +000065
Chris Lattner3a353e82004-07-27 06:40:37 +000066 /// FunctionEffect - Capture whether or not this function reads or writes to
67 /// ANY memory. If not, we can do a lot of aggressive analysis on it.
68 unsigned FunctionEffect;
Chris Lattnerb6964622004-07-27 07:46:26 +000069
Duncan Sands06dbb122008-09-12 07:29:58 +000070 FunctionRecord() : MayReadAnyGlobal (false), FunctionEffect(0) {}
Chris Lattner3a353e82004-07-27 06:40:37 +000071 };
72
73 /// GlobalsModRef - The actual analysis pass.
Nick Lewycky02d5f772009-10-25 06:33:48 +000074 class GlobalsModRef : public ModulePass, public AliasAnalysis {
Chris Lattner3a353e82004-07-27 06:40:37 +000075 /// NonAddressTakenGlobals - The globals that do not have their addresses
76 /// taken.
Dan Gohman5442c712010-08-03 21:48:53 +000077 std::set<const GlobalValue*> NonAddressTakenGlobals;
Chris Lattner26dff502004-06-28 06:33:13 +000078
Chris Lattnerbfdd19b2006-10-01 22:36:45 +000079 /// IndirectGlobals - The memory pointed to by this global is known to be
80 /// 'owned' by the global.
Dan Gohman5442c712010-08-03 21:48:53 +000081 std::set<const GlobalValue*> IndirectGlobals;
Duncan Sands42c644e2008-09-03 12:55:42 +000082
Chris Lattnerbfdd19b2006-10-01 22:36:45 +000083 /// AllocsForIndirectGlobals - If an instruction allocates memory for an
84 /// indirect global, this map indicates which one.
Dan Gohman5442c712010-08-03 21:48:53 +000085 std::map<const Value*, const GlobalValue*> AllocsForIndirectGlobals;
Duncan Sands42c644e2008-09-03 12:55:42 +000086
Chris Lattner26dff502004-06-28 06:33:13 +000087 /// FunctionInfo - For each function, keep track of what globals are
88 /// modified or read.
Dan Gohman5442c712010-08-03 21:48:53 +000089 std::map<const Function*, FunctionRecord> FunctionInfo;
Chris Lattner26dff502004-06-28 06:33:13 +000090
91 public:
Devang Patel8c78a0b2007-05-03 01:11:54 +000092 static char ID;
Owen Anderson6c18d1a2010-10-19 17:21:58 +000093 GlobalsModRef() : ModulePass(ID) {
94 initializeGlobalsModRefPass(*PassRegistry::getPassRegistry());
95 }
Devang Patel864970e2008-03-18 00:39:19 +000096
Chris Lattner4f2cf032004-09-20 04:48:05 +000097 bool runOnModule(Module &M) {
Chandler Carruth6378cf52013-11-26 04:19:30 +000098 InitializeAliasAnalysis(this);
99
100 // Find non-addr taken globals.
101 AnalyzeGlobals(M);
102
103 // Propagate on CG.
104 AnalyzeCallGraph(getAnalysis<CallGraphWrapperPass>().getCallGraph(), M);
Chris Lattner26dff502004-06-28 06:33:13 +0000105 return false;
106 }
107
108 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
109 AliasAnalysis::getAnalysisUsage(AU);
Chandler Carruth6378cf52013-11-26 04:19:30 +0000110 AU.addRequired<CallGraphWrapperPass>();
Chris Lattner26dff502004-06-28 06:33:13 +0000111 AU.setPreservesAll(); // Does not transform code
112 }
113
114 //------------------------------------------------
115 // Implement the AliasAnalysis API
Misha Brukman01808ca2005-04-21 21:13:18 +0000116 //
Dan Gohman41f14cf2010-09-14 21:25:10 +0000117 AliasResult alias(const Location &LocA, const Location &LocB);
Dan Gohman5442c712010-08-03 21:48:53 +0000118 ModRefResult getModRefInfo(ImmutableCallSite CS,
Dan Gohman41f14cf2010-09-14 21:25:10 +0000119 const Location &Loc);
Dan Gohman5442c712010-08-03 21:48:53 +0000120 ModRefResult getModRefInfo(ImmutableCallSite CS1,
121 ImmutableCallSite CS2) {
122 return AliasAnalysis::getModRefInfo(CS1, CS2);
Reid Spencer5c132bc2004-12-07 08:11:24 +0000123 }
Chris Lattner26dff502004-06-28 06:33:13 +0000124
Chris Lattner71d04bc2004-12-15 07:22:13 +0000125 /// getModRefBehavior - Return the behavior of the specified function if
126 /// called from the specified call site. The call site may be null in which
127 /// case the most generic behavior of this function should be returned.
Dan Gohmanfc419ef2010-08-03 23:08:10 +0000128 ModRefBehavior getModRefBehavior(const Function *F) {
Dan Gohman2694e142010-11-10 01:02:18 +0000129 ModRefBehavior Min = UnknownModRefBehavior;
130
Anton Korobeynikov579f0712008-02-20 11:08:44 +0000131 if (FunctionRecord *FR = getFunctionInfo(F)) {
Chris Lattner3a353e82004-07-27 06:40:37 +0000132 if (FR->FunctionEffect == 0)
Dan Gohman2694e142010-11-10 01:02:18 +0000133 Min = DoesNotAccessMemory;
Misha Brukman77451162005-04-22 04:01:18 +0000134 else if ((FR->FunctionEffect & Mod) == 0)
Dan Gohman2694e142010-11-10 01:02:18 +0000135 Min = OnlyReadsMemory;
Anton Korobeynikov579f0712008-02-20 11:08:44 +0000136 }
Dan Gohman2694e142010-11-10 01:02:18 +0000137
138 return ModRefBehavior(AliasAnalysis::getModRefBehavior(F) & Min);
Owen Anderson98a36172009-02-05 23:36:27 +0000139 }
140
141 /// getModRefBehavior - Return the behavior of the specified function if
142 /// called from the specified call site. The call site may be null in which
143 /// case the most generic behavior of this function should be returned.
Dan Gohmanfc419ef2010-08-03 23:08:10 +0000144 ModRefBehavior getModRefBehavior(ImmutableCallSite CS) {
Dan Gohman2694e142010-11-10 01:02:18 +0000145 ModRefBehavior Min = UnknownModRefBehavior;
146
147 if (const Function* F = CS.getCalledFunction())
148 if (FunctionRecord *FR = getFunctionInfo(F)) {
149 if (FR->FunctionEffect == 0)
150 Min = DoesNotAccessMemory;
151 else if ((FR->FunctionEffect & Mod) == 0)
152 Min = OnlyReadsMemory;
153 }
154
155 return ModRefBehavior(AliasAnalysis::getModRefBehavior(CS) & Min);
Chris Lattner3a353e82004-07-27 06:40:37 +0000156 }
Chris Lattner3a353e82004-07-27 06:40:37 +0000157
Chris Lattner26dff502004-06-28 06:33:13 +0000158 virtual void deleteValue(Value *V);
159 virtual void copyValue(Value *From, Value *To);
Owen Andersond62d3722011-01-03 23:51:43 +0000160 virtual void addEscapingUse(Use &U);
Chris Lattner26dff502004-06-28 06:33:13 +0000161
Chris Lattner3b033272010-01-20 19:53:32 +0000162 /// getAdjustedAnalysisPointer - This method is used when a pass implements
163 /// an analysis interface through multiple inheritance. If needed, it
164 /// should override this to adjust the this pointer as needed for the
165 /// specified pass info.
Owen Andersona7aed182010-08-06 18:33:48 +0000166 virtual void *getAdjustedAnalysisPointer(AnalysisID PI) {
167 if (PI == &AliasAnalysis::ID)
Chris Lattner3b033272010-01-20 19:53:32 +0000168 return (AliasAnalysis*)this;
169 return this;
170 }
171
Chris Lattner26dff502004-06-28 06:33:13 +0000172 private:
Chris Lattner3a353e82004-07-27 06:40:37 +0000173 /// getFunctionInfo - Return the function info for the function, or null if
Duncan Sands42c644e2008-09-03 12:55:42 +0000174 /// we don't have anything useful to say about it.
Dan Gohman5442c712010-08-03 21:48:53 +0000175 FunctionRecord *getFunctionInfo(const Function *F) {
176 std::map<const Function*, FunctionRecord>::iterator I =
177 FunctionInfo.find(F);
Chris Lattner3a353e82004-07-27 06:40:37 +0000178 if (I != FunctionInfo.end())
179 return &I->second;
180 return 0;
181 }
182
Chris Lattner26dff502004-06-28 06:33:13 +0000183 void AnalyzeGlobals(Module &M);
184 void AnalyzeCallGraph(CallGraph &CG, Module &M);
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000185 bool AnalyzeUsesOfPointer(Value *V, std::vector<Function*> &Readers,
186 std::vector<Function*> &Writers,
187 GlobalValue *OkayStoreDest = 0);
188 bool AnalyzeIndirectGlobalMemory(GlobalValue *GV);
Chris Lattner26dff502004-06-28 06:33:13 +0000189 };
Chris Lattner26dff502004-06-28 06:33:13 +0000190}
191
Dan Gohmand78c4002008-05-13 00:00:25 +0000192char GlobalsModRef::ID = 0;
Owen Anderson8ac477f2010-10-12 19:48:12 +0000193INITIALIZE_AG_PASS_BEGIN(GlobalsModRef, AliasAnalysis,
194 "globalsmodref-aa", "Simple mod/ref analysis for globals",
195 false, true, false)
Chandler Carruth6378cf52013-11-26 04:19:30 +0000196INITIALIZE_PASS_DEPENDENCY(CallGraphWrapperPass)
Owen Anderson8ac477f2010-10-12 19:48:12 +0000197INITIALIZE_AG_PASS_END(GlobalsModRef, AliasAnalysis,
Owen Andersond31d82d2010-08-23 17:52:01 +0000198 "globalsmodref-aa", "Simple mod/ref analysis for globals",
Owen Andersondf7a4f22010-10-07 22:25:06 +0000199 false, true, false)
Dan Gohmand78c4002008-05-13 00:00:25 +0000200
Chris Lattner26dff502004-06-28 06:33:13 +0000201Pass *llvm::createGlobalsModRefPass() { return new GlobalsModRef(); }
202
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000203/// AnalyzeGlobals - Scan through the users of all of the internal
Duncan Sands42c644e2008-09-03 12:55:42 +0000204/// GlobalValue's in the program. If none of them have their "address taken"
Chris Lattner26dff502004-06-28 06:33:13 +0000205/// (really, their address passed to something nontrivial), record this fact,
206/// and record the functions that they are used directly in.
207void GlobalsModRef::AnalyzeGlobals(Module &M) {
208 std::vector<Function*> Readers, Writers;
209 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
Rafael Espindola6de96a12009-01-15 20:18:42 +0000210 if (I->hasLocalLinkage()) {
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000211 if (!AnalyzeUsesOfPointer(I, Readers, Writers)) {
Chris Lattner3a353e82004-07-27 06:40:37 +0000212 // Remember that we are tracking this global.
213 NonAddressTakenGlobals.insert(I);
Chris Lattner26dff502004-06-28 06:33:13 +0000214 ++NumNonAddrTakenFunctions;
215 }
216 Readers.clear(); Writers.clear();
217 }
218
Chris Lattner6a3f5fd2005-03-23 23:51:12 +0000219 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
220 I != E; ++I)
Rafael Espindola6de96a12009-01-15 20:18:42 +0000221 if (I->hasLocalLinkage()) {
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000222 if (!AnalyzeUsesOfPointer(I, Readers, Writers)) {
Chris Lattner26dff502004-06-28 06:33:13 +0000223 // Remember that we are tracking this global, and the mod/ref fns
Chris Lattner3a353e82004-07-27 06:40:37 +0000224 NonAddressTakenGlobals.insert(I);
Duncan Sands42c644e2008-09-03 12:55:42 +0000225
Chris Lattner3a353e82004-07-27 06:40:37 +0000226 for (unsigned i = 0, e = Readers.size(); i != e; ++i)
227 FunctionInfo[Readers[i]].GlobalInfo[I] |= Ref;
228
229 if (!I->isConstant()) // No need to keep track of writers to constants
230 for (unsigned i = 0, e = Writers.size(); i != e; ++i)
231 FunctionInfo[Writers[i]].GlobalInfo[I] |= Mod;
Chris Lattner26dff502004-06-28 06:33:13 +0000232 ++NumNonAddrTakenGlobalVars;
Duncan Sands42c644e2008-09-03 12:55:42 +0000233
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000234 // If this global holds a pointer type, see if it is an indirect global.
Duncan Sands19d0b472010-02-16 11:11:14 +0000235 if (I->getType()->getElementType()->isPointerTy() &&
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000236 AnalyzeIndirectGlobalMemory(I))
237 ++NumIndirectGlobalVars;
Chris Lattner26dff502004-06-28 06:33:13 +0000238 }
239 Readers.clear(); Writers.clear();
240 }
241}
242
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000243/// AnalyzeUsesOfPointer - Look at all of the users of the specified pointer.
244/// If this is used by anything complex (i.e., the address escapes), return
245/// true. Also, while we are at it, keep track of those functions that read and
246/// write to the value.
247///
248/// If OkayStoreDest is non-null, stores into this global are allowed.
249bool GlobalsModRef::AnalyzeUsesOfPointer(Value *V,
250 std::vector<Function*> &Readers,
251 std::vector<Function*> &Writers,
252 GlobalValue *OkayStoreDest) {
Duncan Sands19d0b472010-02-16 11:11:14 +0000253 if (!V->getType()->isPointerTy()) return true;
Chris Lattner26dff502004-06-28 06:33:13 +0000254
Gabor Greif070b9a22010-07-09 15:53:42 +0000255 for (Value::use_iterator UI = V->use_begin(), E=V->use_end(); UI != E; ++UI) {
256 User *U = *UI;
257 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner26dff502004-06-28 06:33:13 +0000258 Readers.push_back(LI->getParent()->getParent());
Gabor Greif070b9a22010-07-09 15:53:42 +0000259 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000260 if (V == SI->getOperand(1)) {
261 Writers.push_back(SI->getParent()->getParent());
262 } else if (SI->getOperand(1) != OkayStoreDest) {
263 return true; // Storing the pointer
264 }
Gabor Greif070b9a22010-07-09 15:53:42 +0000265 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000266 if (AnalyzeUsesOfPointer(GEP, Readers, Writers)) return true;
Gabor Greif070b9a22010-07-09 15:53:42 +0000267 } else if (BitCastInst *BCI = dyn_cast<BitCastInst>(U)) {
Victor Hernandez537d8d92009-09-18 21:34:51 +0000268 if (AnalyzeUsesOfPointer(BCI, Readers, Writers, OkayStoreDest))
269 return true;
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000270 } else if (isFreeCall(U, TLI)) {
Gabor Greif070b9a22010-07-09 15:53:42 +0000271 Writers.push_back(cast<Instruction>(U)->getParent()->getParent());
272 } else if (CallInst *CI = dyn_cast<CallInst>(U)) {
Chris Lattner26dff502004-06-28 06:33:13 +0000273 // Make sure that this is just the function being called, not that it is
274 // passing into the function.
Bill Wendlinga3bba332010-06-07 19:05:06 +0000275 for (unsigned i = 0, e = CI->getNumArgOperands(); i != e; ++i)
276 if (CI->getArgOperand(i) == V) return true;
Gabor Greif070b9a22010-07-09 15:53:42 +0000277 } else if (InvokeInst *II = dyn_cast<InvokeInst>(U)) {
Chris Lattner26dff502004-06-28 06:33:13 +0000278 // Make sure that this is just the function being called, not that it is
279 // passing into the function.
Bill Wendlinga3bba332010-06-07 19:05:06 +0000280 for (unsigned i = 0, e = II->getNumArgOperands(); i != e; ++i)
281 if (II->getArgOperand(i) == V) return true;
Gabor Greif070b9a22010-07-09 15:53:42 +0000282 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
Duncan Sands42c644e2008-09-03 12:55:42 +0000283 if (CE->getOpcode() == Instruction::GetElementPtr ||
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000284 CE->getOpcode() == Instruction::BitCast) {
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000285 if (AnalyzeUsesOfPointer(CE, Readers, Writers))
Chris Lattner26dff502004-06-28 06:33:13 +0000286 return true;
287 } else {
288 return true;
Misha Brukman01808ca2005-04-21 21:13:18 +0000289 }
Gabor Greif070b9a22010-07-09 15:53:42 +0000290 } else if (ICmpInst *ICI = dyn_cast<ICmpInst>(U)) {
Reid Spencer266e42b2006-12-23 06:05:41 +0000291 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000292 return true; // Allow comparison against null.
Chris Lattner26dff502004-06-28 06:33:13 +0000293 } else {
294 return true;
295 }
Gabor Greif070b9a22010-07-09 15:53:42 +0000296 }
297
Chris Lattner26dff502004-06-28 06:33:13 +0000298 return false;
299}
300
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000301/// AnalyzeIndirectGlobalMemory - We found an non-address-taken global variable
302/// which holds a pointer type. See if the global always points to non-aliased
303/// heap memory: that is, all initializers of the globals are allocations, and
304/// those allocations have no use other than initialization of the global.
305/// Further, all loads out of GV must directly use the memory, not store the
306/// pointer somewhere. If this is true, we consider the memory pointed to by
307/// GV to be owned by GV and can disambiguate other pointers from it.
308bool GlobalsModRef::AnalyzeIndirectGlobalMemory(GlobalValue *GV) {
309 // Keep track of values related to the allocation of the memory, f.e. the
310 // value produced by the malloc call and any casts.
311 std::vector<Value*> AllocRelatedValues;
Duncan Sands42c644e2008-09-03 12:55:42 +0000312
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000313 // Walk the user list of the global. If we find anything other than a direct
314 // load or store, bail out.
315 for (Value::use_iterator I = GV->use_begin(), E = GV->use_end(); I != E; ++I){
Gabor Greifaa389f52010-07-09 16:22:36 +0000316 User *U = *I;
317 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000318 // The pointer loaded from the global can only be used in simple ways:
319 // we allow addressing of it and loading storing to it. We do *not* allow
320 // storing the loaded pointer somewhere else or passing to a function.
321 std::vector<Function*> ReadersWriters;
322 if (AnalyzeUsesOfPointer(LI, ReadersWriters, ReadersWriters))
323 return false; // Loaded pointer escapes.
324 // TODO: Could try some IP mod/ref of the loaded pointer.
Gabor Greifaa389f52010-07-09 16:22:36 +0000325 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000326 // Storing the global itself.
327 if (SI->getOperand(0) == GV) return false;
Duncan Sands42c644e2008-09-03 12:55:42 +0000328
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000329 // If storing the null pointer, ignore it.
330 if (isa<ConstantPointerNull>(SI->getOperand(0)))
331 continue;
Duncan Sands42c644e2008-09-03 12:55:42 +0000332
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000333 // Check the value being stored.
Dan Gohmana4fcd242010-12-15 20:02:24 +0000334 Value *Ptr = GetUnderlyingObject(SI->getOperand(0));
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000335
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000336 if (!isAllocLikeFn(Ptr, TLI))
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000337 return false; // Too hard to analyze.
Duncan Sands42c644e2008-09-03 12:55:42 +0000338
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000339 // Analyze all uses of the allocation. If any of them are used in a
340 // non-simple way (e.g. stored to another global) bail out.
341 std::vector<Function*> ReadersWriters;
342 if (AnalyzeUsesOfPointer(Ptr, ReadersWriters, ReadersWriters, GV))
343 return false; // Loaded pointer escapes.
344
345 // Remember that this allocation is related to the indirect global.
346 AllocRelatedValues.push_back(Ptr);
347 } else {
348 // Something complex, bail out.
349 return false;
350 }
351 }
Duncan Sands42c644e2008-09-03 12:55:42 +0000352
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000353 // Okay, this is an indirect global. Remember all of the allocations for
354 // this global in AllocsForIndirectGlobals.
355 while (!AllocRelatedValues.empty()) {
356 AllocsForIndirectGlobals[AllocRelatedValues.back()] = GV;
357 AllocRelatedValues.pop_back();
358 }
359 IndirectGlobals.insert(GV);
360 return true;
361}
362
Chris Lattner26dff502004-06-28 06:33:13 +0000363/// AnalyzeCallGraph - At this point, we know the functions where globals are
364/// immediately stored to and read from. Propagate this information up the call
Chris Lattner3a353e82004-07-27 06:40:37 +0000365/// graph to all callers and compute the mod/ref info for all memory for each
Misha Brukman01808ca2005-04-21 21:13:18 +0000366/// function.
Chris Lattner26dff502004-06-28 06:33:13 +0000367void GlobalsModRef::AnalyzeCallGraph(CallGraph &CG, Module &M) {
Chris Lattner26dff502004-06-28 06:33:13 +0000368 // We do a bottom-up SCC traversal of the call graph. In other words, we
369 // visit all callees before callers (leaf-first).
Duncan Sands42c644e2008-09-03 12:55:42 +0000370 for (scc_iterator<CallGraph*> I = scc_begin(&CG), E = scc_end(&CG); I != E;
371 ++I) {
372 std::vector<CallGraphNode *> &SCC = *I;
Duncan Sands21a57992008-09-04 19:16:20 +0000373 assert(!SCC.empty() && "SCC with no functions?");
Duncan Sands42c644e2008-09-03 12:55:42 +0000374
Duncan Sands21a57992008-09-04 19:16:20 +0000375 if (!SCC[0]->getFunction()) {
376 // Calls externally - can't say anything useful. Remove any existing
377 // function records (may have been created when scanning globals).
378 for (unsigned i = 0, e = SCC.size(); i != e; ++i)
379 FunctionInfo.erase(SCC[i]->getFunction());
Duncan Sands42c644e2008-09-03 12:55:42 +0000380 continue;
Duncan Sands21a57992008-09-04 19:16:20 +0000381 }
382
383 FunctionRecord &FR = FunctionInfo[SCC[0]->getFunction()];
Chris Lattner26dff502004-06-28 06:33:13 +0000384
Duncan Sands42c644e2008-09-03 12:55:42 +0000385 bool KnowNothing = false;
386 unsigned FunctionEffect = 0;
Chris Lattner3a353e82004-07-27 06:40:37 +0000387
Duncan Sands42c644e2008-09-03 12:55:42 +0000388 // Collect the mod/ref properties due to called functions. We only compute
389 // one mod-ref set.
390 for (unsigned i = 0, e = SCC.size(); i != e && !KnowNothing; ++i) {
391 Function *F = SCC[i]->getFunction();
392 if (!F) {
393 KnowNothing = true;
Chris Lattner3a353e82004-07-27 06:40:37 +0000394 break;
Chris Lattner26dff502004-06-28 06:33:13 +0000395 }
Chris Lattner3a353e82004-07-27 06:40:37 +0000396
Duncan Sands42c644e2008-09-03 12:55:42 +0000397 if (F->isDeclaration()) {
398 // Try to get mod/ref behaviour from function attributes.
Duncan Sands0eca0572008-09-03 15:31:24 +0000399 if (F->doesNotAccessMemory()) {
400 // Can't do better than that!
401 } else if (F->onlyReadsMemory()) {
Duncan Sands42c644e2008-09-03 12:55:42 +0000402 FunctionEffect |= Ref;
Duncan Sands06dbb122008-09-12 07:29:58 +0000403 if (!F->isIntrinsic())
Duncan Sandse30b36f2008-09-11 15:43:12 +0000404 // This function might call back into the module and read a global -
Duncan Sands06dbb122008-09-12 07:29:58 +0000405 // consider every global as possibly being read by this function.
406 FR.MayReadAnyGlobal = true;
Duncan Sands0eca0572008-09-03 15:31:24 +0000407 } else {
Duncan Sandsd4133ac2008-09-11 19:35:55 +0000408 FunctionEffect |= ModRef;
409 // Can't say anything useful unless it's an intrinsic - they don't
410 // read or write global variables of the kind considered here.
411 KnowNothing = !F->isIntrinsic();
Duncan Sands42c644e2008-09-03 12:55:42 +0000412 }
413 continue;
414 }
Misha Brukman01808ca2005-04-21 21:13:18 +0000415
Duncan Sands42c644e2008-09-03 12:55:42 +0000416 for (CallGraphNode::iterator CI = SCC[i]->begin(), E = SCC[i]->end();
Duncan Sands21a57992008-09-04 19:16:20 +0000417 CI != E && !KnowNothing; ++CI)
Duncan Sands42c644e2008-09-03 12:55:42 +0000418 if (Function *Callee = CI->second->getFunction()) {
419 if (FunctionRecord *CalleeFR = getFunctionInfo(Callee)) {
420 // Propagate function effect up.
421 FunctionEffect |= CalleeFR->FunctionEffect;
422
423 // Incorporate callee's effects on globals into our info.
Dan Gohman5442c712010-08-03 21:48:53 +0000424 for (std::map<const GlobalValue*, unsigned>::iterator GI =
Duncan Sands42c644e2008-09-03 12:55:42 +0000425 CalleeFR->GlobalInfo.begin(), E = CalleeFR->GlobalInfo.end();
426 GI != E; ++GI)
Duncan Sands21a57992008-09-04 19:16:20 +0000427 FR.GlobalInfo[GI->first] |= GI->second;
Duncan Sands06dbb122008-09-12 07:29:58 +0000428 FR.MayReadAnyGlobal |= CalleeFR->MayReadAnyGlobal;
Duncan Sands42c644e2008-09-03 12:55:42 +0000429 } else {
430 // Can't say anything about it. However, if it is inside our SCC,
431 // then nothing needs to be done.
432 CallGraphNode *CalleeNode = CG[Callee];
433 if (std::find(SCC.begin(), SCC.end(), CalleeNode) == SCC.end())
434 KnowNothing = true;
435 }
436 } else {
437 KnowNothing = true;
438 }
439 }
440
441 // If we can't say anything useful about this SCC, remove all SCC functions
442 // from the FunctionInfo map.
443 if (KnowNothing) {
444 for (unsigned i = 0, e = SCC.size(); i != e; ++i)
445 FunctionInfo.erase(SCC[i]->getFunction());
Duncan Sandse74d7502008-09-03 16:10:55 +0000446 continue;
Duncan Sands42c644e2008-09-03 12:55:42 +0000447 }
448
449 // Scan the function bodies for explicit loads or stores.
Chris Lattner3a353e82004-07-27 06:40:37 +0000450 for (unsigned i = 0, e = SCC.size(); i != e && FunctionEffect != ModRef;++i)
451 for (inst_iterator II = inst_begin(SCC[i]->getFunction()),
Misha Brukman01808ca2005-04-21 21:13:18 +0000452 E = inst_end(SCC[i]->getFunction());
Chris Lattner3a353e82004-07-27 06:40:37 +0000453 II != E && FunctionEffect != ModRef; ++II)
Nuno Lopes55fff832012-06-21 15:45:28 +0000454 if (LoadInst *LI = dyn_cast<LoadInst>(&*II)) {
Chris Lattner3a353e82004-07-27 06:40:37 +0000455 FunctionEffect |= Ref;
Nuno Lopes55fff832012-06-21 15:45:28 +0000456 if (LI->isVolatile())
Duncan Sands9ddb3142008-09-13 12:45:50 +0000457 // Volatile loads may have side-effects, so mark them as writing
458 // memory (for example, a flag inside the processor).
459 FunctionEffect |= Mod;
Nuno Lopes55fff832012-06-21 15:45:28 +0000460 } else if (StoreInst *SI = dyn_cast<StoreInst>(&*II)) {
Chris Lattner3a353e82004-07-27 06:40:37 +0000461 FunctionEffect |= Mod;
Nuno Lopes55fff832012-06-21 15:45:28 +0000462 if (SI->isVolatile())
Duncan Sands9ddb3142008-09-13 12:45:50 +0000463 // Treat volatile stores as reading memory somewhere.
464 FunctionEffect |= Ref;
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000465 } else if (isAllocationFn(&*II, TLI) || isFreeCall(&*II, TLI)) {
Chris Lattnere25cfae2005-04-22 05:36:59 +0000466 FunctionEffect |= ModRef;
Rafael Espindola5054ee82012-03-28 21:31:24 +0000467 } else if (IntrinsicInst *Intrinsic = dyn_cast<IntrinsicInst>(&*II)) {
468 // The callgraph doesn't include intrinsic calls.
469 Function *Callee = Intrinsic->getCalledFunction();
470 ModRefBehavior Behaviour = AliasAnalysis::getModRefBehavior(Callee);
471 FunctionEffect |= (Behaviour & ModRef);
Duncan Sands9ddb3142008-09-13 12:45:50 +0000472 }
Duncan Sands42c644e2008-09-03 12:55:42 +0000473
474 if ((FunctionEffect & Mod) == 0)
475 ++NumReadMemFunctions;
476 if (FunctionEffect == 0)
477 ++NumNoMemFunctions;
Duncan Sands21a57992008-09-04 19:16:20 +0000478 FR.FunctionEffect = FunctionEffect;
Duncan Sands42c644e2008-09-03 12:55:42 +0000479
480 // Finally, now that we know the full effect on this SCC, clone the
481 // information to each function in the SCC.
482 for (unsigned i = 1, e = SCC.size(); i != e; ++i)
Duncan Sands21a57992008-09-04 19:16:20 +0000483 FunctionInfo[SCC[i]->getFunction()] = FR;
Chris Lattner3a353e82004-07-27 06:40:37 +0000484 }
Chris Lattner26dff502004-06-28 06:33:13 +0000485}
486
487
488
Chris Lattner26dff502004-06-28 06:33:13 +0000489/// alias - If one of the pointers is to a global that we are tracking, and the
490/// other is some random pointer, we know there cannot be an alias, because the
491/// address of the global isn't taken.
492AliasAnalysis::AliasResult
Dan Gohman41f14cf2010-09-14 21:25:10 +0000493GlobalsModRef::alias(const Location &LocA,
494 const Location &LocB) {
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000495 // Get the base object these pointers point to.
Dan Gohmana4fcd242010-12-15 20:02:24 +0000496 const Value *UV1 = GetUnderlyingObject(LocA.Ptr);
497 const Value *UV2 = GetUnderlyingObject(LocB.Ptr);
Duncan Sands42c644e2008-09-03 12:55:42 +0000498
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000499 // If either of the underlying values is a global, they may be non-addr-taken
500 // globals, which we can answer queries about.
Dan Gohman5442c712010-08-03 21:48:53 +0000501 const GlobalValue *GV1 = dyn_cast<GlobalValue>(UV1);
502 const GlobalValue *GV2 = dyn_cast<GlobalValue>(UV2);
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000503 if (GV1 || GV2) {
504 // If the global's address is taken, pretend we don't know it's a pointer to
505 // the global.
506 if (GV1 && !NonAddressTakenGlobals.count(GV1)) GV1 = 0;
507 if (GV2 && !NonAddressTakenGlobals.count(GV2)) GV2 = 0;
Chris Lattner26dff502004-06-28 06:33:13 +0000508
Dan Gohman4a618822010-02-10 16:03:48 +0000509 // If the two pointers are derived from two different non-addr-taken
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000510 // globals, or if one is and the other isn't, we know these can't alias.
511 if ((GV1 || GV2) && GV1 != GV2)
512 return NoAlias;
Chris Lattner26dff502004-06-28 06:33:13 +0000513
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000514 // Otherwise if they are both derived from the same addr-taken global, we
515 // can't know the two accesses don't overlap.
516 }
Duncan Sands42c644e2008-09-03 12:55:42 +0000517
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000518 // These pointers may be based on the memory owned by an indirect global. If
519 // so, we may be able to handle this. First check to see if the base pointer
520 // is a direct load from an indirect global.
521 GV1 = GV2 = 0;
Dan Gohman5442c712010-08-03 21:48:53 +0000522 if (const LoadInst *LI = dyn_cast<LoadInst>(UV1))
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000523 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getOperand(0)))
524 if (IndirectGlobals.count(GV))
525 GV1 = GV;
Dan Gohman5442c712010-08-03 21:48:53 +0000526 if (const LoadInst *LI = dyn_cast<LoadInst>(UV2))
527 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getOperand(0)))
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000528 if (IndirectGlobals.count(GV))
529 GV2 = GV;
Duncan Sands42c644e2008-09-03 12:55:42 +0000530
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000531 // These pointers may also be from an allocation for the indirect global. If
532 // so, also handle them.
533 if (AllocsForIndirectGlobals.count(UV1))
534 GV1 = AllocsForIndirectGlobals[UV1];
535 if (AllocsForIndirectGlobals.count(UV2))
536 GV2 = AllocsForIndirectGlobals[UV2];
Duncan Sands42c644e2008-09-03 12:55:42 +0000537
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000538 // Now that we know whether the two pointers are related to indirect globals,
539 // use this to disambiguate the pointers. If either pointer is based on an
540 // indirect global and if they are not both based on the same indirect global,
541 // they cannot alias.
Chris Lattner26dff502004-06-28 06:33:13 +0000542 if ((GV1 || GV2) && GV1 != GV2)
543 return NoAlias;
Duncan Sands42c644e2008-09-03 12:55:42 +0000544
Dan Gohman41f14cf2010-09-14 21:25:10 +0000545 return AliasAnalysis::alias(LocA, LocB);
Chris Lattner26dff502004-06-28 06:33:13 +0000546}
547
548AliasAnalysis::ModRefResult
Dan Gohman5442c712010-08-03 21:48:53 +0000549GlobalsModRef::getModRefInfo(ImmutableCallSite CS,
Dan Gohman41f14cf2010-09-14 21:25:10 +0000550 const Location &Loc) {
Chris Lattner26dff502004-06-28 06:33:13 +0000551 unsigned Known = ModRef;
552
553 // If we are asking for mod/ref info of a direct call with a pointer to a
Chris Lattner3a353e82004-07-27 06:40:37 +0000554 // global we are tracking, return information if we have it.
Dan Gohman41f14cf2010-09-14 21:25:10 +0000555 if (const GlobalValue *GV =
Dan Gohmana4fcd242010-12-15 20:02:24 +0000556 dyn_cast<GlobalValue>(GetUnderlyingObject(Loc.Ptr)))
Rafael Espindola6de96a12009-01-15 20:18:42 +0000557 if (GV->hasLocalLinkage())
Dan Gohman5442c712010-08-03 21:48:53 +0000558 if (const Function *F = CS.getCalledFunction())
Chris Lattner3a353e82004-07-27 06:40:37 +0000559 if (NonAddressTakenGlobals.count(GV))
Dan Gohman5442c712010-08-03 21:48:53 +0000560 if (const FunctionRecord *FR = getFunctionInfo(F))
Chris Lattner3a353e82004-07-27 06:40:37 +0000561 Known = FR->getInfoForGlobal(GV);
Chris Lattner26dff502004-06-28 06:33:13 +0000562
563 if (Known == NoModRef)
564 return NoModRef; // No need to query other mod/ref analyses
Dan Gohman41f14cf2010-09-14 21:25:10 +0000565 return ModRefResult(Known & AliasAnalysis::getModRefInfo(CS, Loc));
Chris Lattner26dff502004-06-28 06:33:13 +0000566}
567
568
569//===----------------------------------------------------------------------===//
570// Methods to update the analysis as a result of the client transformation.
571//
572void GlobalsModRef::deleteValue(Value *V) {
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000573 if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
574 if (NonAddressTakenGlobals.erase(GV)) {
575 // This global might be an indirect global. If so, remove it and remove
576 // any AllocRelatedValues for it.
577 if (IndirectGlobals.erase(GV)) {
578 // Remove any entries in AllocsForIndirectGlobals for this global.
Dan Gohman5442c712010-08-03 21:48:53 +0000579 for (std::map<const Value*, const GlobalValue*>::iterator
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000580 I = AllocsForIndirectGlobals.begin(),
581 E = AllocsForIndirectGlobals.end(); I != E; ) {
582 if (I->second == GV) {
583 AllocsForIndirectGlobals.erase(I++);
584 } else {
585 ++I;
586 }
587 }
588 }
589 }
590 }
Duncan Sands42c644e2008-09-03 12:55:42 +0000591
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000592 // Otherwise, if this is an allocation related to an indirect global, remove
593 // it.
594 AllocsForIndirectGlobals.erase(V);
Duncan Sands42c644e2008-09-03 12:55:42 +0000595
Chris Lattner907703c2007-11-30 18:52:58 +0000596 AliasAnalysis::deleteValue(V);
Chris Lattner26dff502004-06-28 06:33:13 +0000597}
598
599void GlobalsModRef::copyValue(Value *From, Value *To) {
Chris Lattner907703c2007-11-30 18:52:58 +0000600 AliasAnalysis::copyValue(From, To);
Chris Lattner26dff502004-06-28 06:33:13 +0000601}
Owen Andersond62d3722011-01-03 23:51:43 +0000602
603void GlobalsModRef::addEscapingUse(Use &U) {
604 // For the purposes of this analysis, it is conservatively correct to treat
605 // a newly escaping value equivalently to a deleted one. We could perhaps
606 // be more precise by processing the new use and attempting to update our
Chris Lattner0ab5e2c2011-04-15 05:18:47 +0000607 // saved analysis results to accommodate it.
Owen Andersond62d3722011-01-03 23:51:43 +0000608 deleteValue(U);
609
610 AliasAnalysis::addEscapingUse(U);
611}