blob: 456a80a972b3814acd9db9d9fa42130fbc03b176 [file] [log] [blame]
Chris Lattner3b04a8a2004-06-28 06:33:13 +00001//===- GlobalsModRef.cpp - Simple Mod/Ref Analysis for Globals ------------===//
Misha Brukman2b37d7c2005-04-21 21:13:18 +00002//
Chris Lattner3b04a8a2004-06-28 06:33:13 +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//
Chris Lattner3b04a8a2004-06-28 06:33:13 +00008//===----------------------------------------------------------------------===//
9//
10// This simple pass provides alias and mod/ref information for global values
Chris Lattnerfe98f272004-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 Lattner3b04a8a2004-06-28 06:33:13 +000014//
15//===----------------------------------------------------------------------===//
16
Chris Lattner3b27d682006-12-19 22:30:33 +000017#define DEBUG_TYPE "globalsmodref-aa"
Chris Lattner3b04a8a2004-06-28 06:33:13 +000018#include "llvm/Analysis/Passes.h"
19#include "llvm/Module.h"
20#include "llvm/Pass.h"
21#include "llvm/Instructions.h"
22#include "llvm/Constants.h"
Chris Lattnerab383582006-10-01 22:36:45 +000023#include "llvm/DerivedTypes.h"
Chris Lattner3b04a8a2004-06-28 06:33:13 +000024#include "llvm/Analysis/AliasAnalysis.h"
25#include "llvm/Analysis/CallGraph.h"
Victor Hernandezf006b182009-10-27 20:05:49 +000026#include "llvm/Analysis/MemoryBuiltins.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000027#include "llvm/Support/CommandLine.h"
Reid Spencerd7d83db2007-02-05 23:42:17 +000028#include "llvm/Support/InstIterator.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000029#include "llvm/ADT/Statistic.h"
30#include "llvm/ADT/SCCIterator.h"
Chris Lattner3b04a8a2004-06-28 06:33:13 +000031#include <set>
32using namespace llvm;
33
Chris Lattner3b27d682006-12-19 22:30:33 +000034STATISTIC(NumNonAddrTakenGlobalVars,
35 "Number of global vars without address taken");
36STATISTIC(NumNonAddrTakenFunctions,"Number of functions without address taken");
37STATISTIC(NumNoMemFunctions, "Number of functions that do not access memory");
38STATISTIC(NumReadMemFunctions, "Number of functions that only read memory");
39STATISTIC(NumIndirectGlobalVars, "Number of indirect global objects");
40
Chris Lattner3b04a8a2004-06-28 06:33:13 +000041namespace {
Chris Lattnerfe98f272004-07-27 06:40:37 +000042 /// FunctionRecord - One instance of this structure is stored for every
43 /// function in the program. Later, the entries for these functions are
44 /// removed if the function is found to call an external function (in which
45 /// case we know nothing about it.
Nick Lewycky6726b6d2009-10-25 06:33:48 +000046 struct FunctionRecord {
Chris Lattnerfe98f272004-07-27 06:40:37 +000047 /// GlobalInfo - Maintain mod/ref info for all of the globals without
48 /// addresses taken that are read or written (transitively) by this
49 /// function.
Dan Gohman79fca6f2010-08-03 21:48:53 +000050 std::map<const GlobalValue*, unsigned> GlobalInfo;
Chris Lattnerfe98f272004-07-27 06:40:37 +000051
Duncan Sands2bb4a4d2008-09-12 07:29:58 +000052 /// MayReadAnyGlobal - May read global variables, but it is not known which.
53 bool MayReadAnyGlobal;
54
Dan Gohman79fca6f2010-08-03 21:48:53 +000055 unsigned getInfoForGlobal(const GlobalValue *GV) const {
Duncan Sands2bb4a4d2008-09-12 07:29:58 +000056 unsigned Effect = MayReadAnyGlobal ? AliasAnalysis::Ref : 0;
Dan Gohman79fca6f2010-08-03 21:48:53 +000057 std::map<const GlobalValue*, unsigned>::const_iterator I =
58 GlobalInfo.find(GV);
Chris Lattnerfe98f272004-07-27 06:40:37 +000059 if (I != GlobalInfo.end())
Duncan Sands2bb4a4d2008-09-12 07:29:58 +000060 Effect |= I->second;
61 return Effect;
Chris Lattnerfe98f272004-07-27 06:40:37 +000062 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +000063
Chris Lattnerfe98f272004-07-27 06:40:37 +000064 /// FunctionEffect - Capture whether or not this function reads or writes to
65 /// ANY memory. If not, we can do a lot of aggressive analysis on it.
66 unsigned FunctionEffect;
Chris Lattner105d26a2004-07-27 07:46:26 +000067
Duncan Sands2bb4a4d2008-09-12 07:29:58 +000068 FunctionRecord() : MayReadAnyGlobal (false), FunctionEffect(0) {}
Chris Lattnerfe98f272004-07-27 06:40:37 +000069 };
70
71 /// GlobalsModRef - The actual analysis pass.
Nick Lewycky6726b6d2009-10-25 06:33:48 +000072 class GlobalsModRef : public ModulePass, public AliasAnalysis {
Chris Lattnerfe98f272004-07-27 06:40:37 +000073 /// NonAddressTakenGlobals - The globals that do not have their addresses
74 /// taken.
Dan Gohman79fca6f2010-08-03 21:48:53 +000075 std::set<const GlobalValue*> NonAddressTakenGlobals;
Chris Lattner3b04a8a2004-06-28 06:33:13 +000076
Chris Lattnerab383582006-10-01 22:36:45 +000077 /// IndirectGlobals - The memory pointed to by this global is known to be
78 /// 'owned' by the global.
Dan Gohman79fca6f2010-08-03 21:48:53 +000079 std::set<const GlobalValue*> IndirectGlobals;
Duncan Sands9a036b92008-09-03 12:55:42 +000080
Chris Lattnerab383582006-10-01 22:36:45 +000081 /// AllocsForIndirectGlobals - If an instruction allocates memory for an
82 /// indirect global, this map indicates which one.
Dan Gohman79fca6f2010-08-03 21:48:53 +000083 std::map<const Value*, const GlobalValue*> AllocsForIndirectGlobals;
Duncan Sands9a036b92008-09-03 12:55:42 +000084
Chris Lattner3b04a8a2004-06-28 06:33:13 +000085 /// FunctionInfo - For each function, keep track of what globals are
86 /// modified or read.
Dan Gohman79fca6f2010-08-03 21:48:53 +000087 std::map<const Function*, FunctionRecord> FunctionInfo;
Chris Lattner3b04a8a2004-06-28 06:33:13 +000088
89 public:
Devang Patel19974732007-05-03 01:11:54 +000090 static char ID;
Owen Anderson081c34b2010-10-19 17:21:58 +000091 GlobalsModRef() : ModulePass(ID) {
92 initializeGlobalsModRefPass(*PassRegistry::getPassRegistry());
93 }
Devang Patel1cee94f2008-03-18 00:39:19 +000094
Chris Lattnerb12914b2004-09-20 04:48:05 +000095 bool runOnModule(Module &M) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +000096 InitializeAliasAnalysis(this); // set up super class
97 AnalyzeGlobals(M); // find non-addr taken globals
98 AnalyzeCallGraph(getAnalysis<CallGraph>(), M); // Propagate on CG
99 return false;
100 }
101
102 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
103 AliasAnalysis::getAnalysisUsage(AU);
104 AU.addRequired<CallGraph>();
105 AU.setPreservesAll(); // Does not transform code
106 }
107
108 //------------------------------------------------
109 // Implement the AliasAnalysis API
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000110 //
Dan Gohmanb2143b62010-09-14 21:25:10 +0000111 AliasResult alias(const Location &LocA, const Location &LocB);
Dan Gohman79fca6f2010-08-03 21:48:53 +0000112 ModRefResult getModRefInfo(ImmutableCallSite CS,
Dan Gohmanb2143b62010-09-14 21:25:10 +0000113 const Location &Loc);
Dan Gohman79fca6f2010-08-03 21:48:53 +0000114 ModRefResult getModRefInfo(ImmutableCallSite CS1,
115 ImmutableCallSite CS2) {
116 return AliasAnalysis::getModRefInfo(CS1, CS2);
Reid Spencer4a7ebfa2004-12-07 08:11:24 +0000117 }
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000118
Chris Lattner0af024c2004-12-15 07:22:13 +0000119 /// getModRefBehavior - Return the behavior of the specified function if
120 /// called from the specified call site. The call site may be null in which
121 /// case the most generic behavior of this function should be returned.
Dan Gohmana41af342010-08-03 23:08:10 +0000122 ModRefBehavior getModRefBehavior(const Function *F) {
Dan Gohman42c31a72010-11-10 01:02:18 +0000123 ModRefBehavior Min = UnknownModRefBehavior;
124
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +0000125 if (FunctionRecord *FR = getFunctionInfo(F)) {
Chris Lattnerfe98f272004-07-27 06:40:37 +0000126 if (FR->FunctionEffect == 0)
Dan Gohman42c31a72010-11-10 01:02:18 +0000127 Min = DoesNotAccessMemory;
Misha Brukmandedf2bd2005-04-22 04:01:18 +0000128 else if ((FR->FunctionEffect & Mod) == 0)
Dan Gohman42c31a72010-11-10 01:02:18 +0000129 Min = OnlyReadsMemory;
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +0000130 }
Dan Gohman42c31a72010-11-10 01:02:18 +0000131
132 return ModRefBehavior(AliasAnalysis::getModRefBehavior(F) & Min);
Owen Andersone7942202009-02-05 23:36:27 +0000133 }
134
135 /// getModRefBehavior - Return the behavior of the specified function if
136 /// called from the specified call site. The call site may be null in which
137 /// case the most generic behavior of this function should be returned.
Dan Gohmana41af342010-08-03 23:08:10 +0000138 ModRefBehavior getModRefBehavior(ImmutableCallSite CS) {
Dan Gohman42c31a72010-11-10 01:02:18 +0000139 ModRefBehavior Min = UnknownModRefBehavior;
140
141 if (const Function* F = CS.getCalledFunction())
142 if (FunctionRecord *FR = getFunctionInfo(F)) {
143 if (FR->FunctionEffect == 0)
144 Min = DoesNotAccessMemory;
145 else if ((FR->FunctionEffect & Mod) == 0)
146 Min = OnlyReadsMemory;
147 }
148
149 return ModRefBehavior(AliasAnalysis::getModRefBehavior(CS) & Min);
Chris Lattnerfe98f272004-07-27 06:40:37 +0000150 }
Chris Lattnerfe98f272004-07-27 06:40:37 +0000151
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000152 virtual void deleteValue(Value *V);
153 virtual void copyValue(Value *From, Value *To);
154
Chris Lattnerfc570e42010-01-20 19:53:32 +0000155 /// getAdjustedAnalysisPointer - This method is used when a pass implements
156 /// an analysis interface through multiple inheritance. If needed, it
157 /// should override this to adjust the this pointer as needed for the
158 /// specified pass info.
Owen Anderson90c579d2010-08-06 18:33:48 +0000159 virtual void *getAdjustedAnalysisPointer(AnalysisID PI) {
160 if (PI == &AliasAnalysis::ID)
Chris Lattnerfc570e42010-01-20 19:53:32 +0000161 return (AliasAnalysis*)this;
162 return this;
163 }
164
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000165 private:
Chris Lattnerfe98f272004-07-27 06:40:37 +0000166 /// getFunctionInfo - Return the function info for the function, or null if
Duncan Sands9a036b92008-09-03 12:55:42 +0000167 /// we don't have anything useful to say about it.
Dan Gohman79fca6f2010-08-03 21:48:53 +0000168 FunctionRecord *getFunctionInfo(const Function *F) {
169 std::map<const Function*, FunctionRecord>::iterator I =
170 FunctionInfo.find(F);
Chris Lattnerfe98f272004-07-27 06:40:37 +0000171 if (I != FunctionInfo.end())
172 return &I->second;
173 return 0;
174 }
175
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000176 void AnalyzeGlobals(Module &M);
177 void AnalyzeCallGraph(CallGraph &CG, Module &M);
Chris Lattnerab383582006-10-01 22:36:45 +0000178 bool AnalyzeUsesOfPointer(Value *V, std::vector<Function*> &Readers,
179 std::vector<Function*> &Writers,
180 GlobalValue *OkayStoreDest = 0);
181 bool AnalyzeIndirectGlobalMemory(GlobalValue *GV);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000182 };
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000183}
184
Dan Gohman844731a2008-05-13 00:00:25 +0000185char GlobalsModRef::ID = 0;
Owen Anderson2ab36d32010-10-12 19:48:12 +0000186INITIALIZE_AG_PASS_BEGIN(GlobalsModRef, AliasAnalysis,
187 "globalsmodref-aa", "Simple mod/ref analysis for globals",
188 false, true, false)
189INITIALIZE_AG_DEPENDENCY(CallGraph)
190INITIALIZE_AG_PASS_END(GlobalsModRef, AliasAnalysis,
Owen Anderson02dd53e2010-08-23 17:52:01 +0000191 "globalsmodref-aa", "Simple mod/ref analysis for globals",
Owen Andersonce665bd2010-10-07 22:25:06 +0000192 false, true, false)
Dan Gohman844731a2008-05-13 00:00:25 +0000193
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000194Pass *llvm::createGlobalsModRefPass() { return new GlobalsModRef(); }
195
Chris Lattnerab383582006-10-01 22:36:45 +0000196/// AnalyzeGlobals - Scan through the users of all of the internal
Duncan Sands9a036b92008-09-03 12:55:42 +0000197/// GlobalValue's in the program. If none of them have their "address taken"
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000198/// (really, their address passed to something nontrivial), record this fact,
199/// and record the functions that they are used directly in.
200void GlobalsModRef::AnalyzeGlobals(Module &M) {
201 std::vector<Function*> Readers, Writers;
202 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
Rafael Espindolabb46f522009-01-15 20:18:42 +0000203 if (I->hasLocalLinkage()) {
Chris Lattnerab383582006-10-01 22:36:45 +0000204 if (!AnalyzeUsesOfPointer(I, Readers, Writers)) {
Chris Lattnerfe98f272004-07-27 06:40:37 +0000205 // Remember that we are tracking this global.
206 NonAddressTakenGlobals.insert(I);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000207 ++NumNonAddrTakenFunctions;
208 }
209 Readers.clear(); Writers.clear();
210 }
211
Chris Lattnerf5eaf3c2005-03-23 23:51:12 +0000212 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
213 I != E; ++I)
Rafael Espindolabb46f522009-01-15 20:18:42 +0000214 if (I->hasLocalLinkage()) {
Chris Lattnerab383582006-10-01 22:36:45 +0000215 if (!AnalyzeUsesOfPointer(I, Readers, Writers)) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000216 // Remember that we are tracking this global, and the mod/ref fns
Chris Lattnerfe98f272004-07-27 06:40:37 +0000217 NonAddressTakenGlobals.insert(I);
Duncan Sands9a036b92008-09-03 12:55:42 +0000218
Chris Lattnerfe98f272004-07-27 06:40:37 +0000219 for (unsigned i = 0, e = Readers.size(); i != e; ++i)
220 FunctionInfo[Readers[i]].GlobalInfo[I] |= Ref;
221
222 if (!I->isConstant()) // No need to keep track of writers to constants
223 for (unsigned i = 0, e = Writers.size(); i != e; ++i)
224 FunctionInfo[Writers[i]].GlobalInfo[I] |= Mod;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000225 ++NumNonAddrTakenGlobalVars;
Duncan Sands9a036b92008-09-03 12:55:42 +0000226
Chris Lattnerab383582006-10-01 22:36:45 +0000227 // If this global holds a pointer type, see if it is an indirect global.
Duncan Sands1df98592010-02-16 11:11:14 +0000228 if (I->getType()->getElementType()->isPointerTy() &&
Chris Lattnerab383582006-10-01 22:36:45 +0000229 AnalyzeIndirectGlobalMemory(I))
230 ++NumIndirectGlobalVars;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000231 }
232 Readers.clear(); Writers.clear();
233 }
234}
235
Chris Lattnerab383582006-10-01 22:36:45 +0000236/// AnalyzeUsesOfPointer - Look at all of the users of the specified pointer.
237/// If this is used by anything complex (i.e., the address escapes), return
238/// true. Also, while we are at it, keep track of those functions that read and
239/// write to the value.
240///
241/// If OkayStoreDest is non-null, stores into this global are allowed.
242bool GlobalsModRef::AnalyzeUsesOfPointer(Value *V,
243 std::vector<Function*> &Readers,
244 std::vector<Function*> &Writers,
245 GlobalValue *OkayStoreDest) {
Duncan Sands1df98592010-02-16 11:11:14 +0000246 if (!V->getType()->isPointerTy()) return true;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000247
Gabor Greifd7cc5212010-07-09 15:53:42 +0000248 for (Value::use_iterator UI = V->use_begin(), E=V->use_end(); UI != E; ++UI) {
249 User *U = *UI;
250 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000251 Readers.push_back(LI->getParent()->getParent());
Gabor Greifd7cc5212010-07-09 15:53:42 +0000252 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000253 if (V == SI->getOperand(1)) {
254 Writers.push_back(SI->getParent()->getParent());
255 } else if (SI->getOperand(1) != OkayStoreDest) {
256 return true; // Storing the pointer
257 }
Gabor Greifd7cc5212010-07-09 15:53:42 +0000258 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000259 if (AnalyzeUsesOfPointer(GEP, Readers, Writers)) return true;
Gabor Greifd7cc5212010-07-09 15:53:42 +0000260 } else if (BitCastInst *BCI = dyn_cast<BitCastInst>(U)) {
Victor Hernandez46e83122009-09-18 21:34:51 +0000261 if (AnalyzeUsesOfPointer(BCI, Readers, Writers, OkayStoreDest))
262 return true;
Gabor Greifd7cc5212010-07-09 15:53:42 +0000263 } else if (isFreeCall(U)) {
264 Writers.push_back(cast<Instruction>(U)->getParent()->getParent());
265 } else if (CallInst *CI = dyn_cast<CallInst>(U)) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000266 // Make sure that this is just the function being called, not that it is
267 // passing into the function.
Bill Wendling22a5b292010-06-07 19:05:06 +0000268 for (unsigned i = 0, e = CI->getNumArgOperands(); i != e; ++i)
269 if (CI->getArgOperand(i) == V) return true;
Gabor Greifd7cc5212010-07-09 15:53:42 +0000270 } else if (InvokeInst *II = dyn_cast<InvokeInst>(U)) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000271 // Make sure that this is just the function being called, not that it is
272 // passing into the function.
Bill Wendling22a5b292010-06-07 19:05:06 +0000273 for (unsigned i = 0, e = II->getNumArgOperands(); i != e; ++i)
274 if (II->getArgOperand(i) == V) return true;
Gabor Greifd7cc5212010-07-09 15:53:42 +0000275 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
Duncan Sands9a036b92008-09-03 12:55:42 +0000276 if (CE->getOpcode() == Instruction::GetElementPtr ||
Reid Spencer3da59db2006-11-27 01:05:10 +0000277 CE->getOpcode() == Instruction::BitCast) {
Chris Lattnerab383582006-10-01 22:36:45 +0000278 if (AnalyzeUsesOfPointer(CE, Readers, Writers))
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000279 return true;
280 } else {
281 return true;
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000282 }
Gabor Greifd7cc5212010-07-09 15:53:42 +0000283 } else if (ICmpInst *ICI = dyn_cast<ICmpInst>(U)) {
Reid Spencere4d87aa2006-12-23 06:05:41 +0000284 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
Chris Lattnerab383582006-10-01 22:36:45 +0000285 return true; // Allow comparison against null.
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000286 } else {
287 return true;
288 }
Gabor Greifd7cc5212010-07-09 15:53:42 +0000289 }
290
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000291 return false;
292}
293
Chris Lattnerab383582006-10-01 22:36:45 +0000294/// AnalyzeIndirectGlobalMemory - We found an non-address-taken global variable
295/// which holds a pointer type. See if the global always points to non-aliased
296/// heap memory: that is, all initializers of the globals are allocations, and
297/// those allocations have no use other than initialization of the global.
298/// Further, all loads out of GV must directly use the memory, not store the
299/// pointer somewhere. If this is true, we consider the memory pointed to by
300/// GV to be owned by GV and can disambiguate other pointers from it.
301bool GlobalsModRef::AnalyzeIndirectGlobalMemory(GlobalValue *GV) {
302 // Keep track of values related to the allocation of the memory, f.e. the
303 // value produced by the malloc call and any casts.
304 std::vector<Value*> AllocRelatedValues;
Duncan Sands9a036b92008-09-03 12:55:42 +0000305
Chris Lattnerab383582006-10-01 22:36:45 +0000306 // Walk the user list of the global. If we find anything other than a direct
307 // load or store, bail out.
308 for (Value::use_iterator I = GV->use_begin(), E = GV->use_end(); I != E; ++I){
Gabor Greif8ba992a2010-07-09 16:22:36 +0000309 User *U = *I;
310 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000311 // The pointer loaded from the global can only be used in simple ways:
312 // we allow addressing of it and loading storing to it. We do *not* allow
313 // storing the loaded pointer somewhere else or passing to a function.
314 std::vector<Function*> ReadersWriters;
315 if (AnalyzeUsesOfPointer(LI, ReadersWriters, ReadersWriters))
316 return false; // Loaded pointer escapes.
317 // TODO: Could try some IP mod/ref of the loaded pointer.
Gabor Greif8ba992a2010-07-09 16:22:36 +0000318 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000319 // Storing the global itself.
320 if (SI->getOperand(0) == GV) return false;
Duncan Sands9a036b92008-09-03 12:55:42 +0000321
Chris Lattnerab383582006-10-01 22:36:45 +0000322 // If storing the null pointer, ignore it.
323 if (isa<ConstantPointerNull>(SI->getOperand(0)))
324 continue;
Duncan Sands9a036b92008-09-03 12:55:42 +0000325
Chris Lattnerab383582006-10-01 22:36:45 +0000326 // Check the value being stored.
Duncan Sands5d0392c2008-10-01 15:25:41 +0000327 Value *Ptr = SI->getOperand(0)->getUnderlyingObject();
Chris Lattnerab383582006-10-01 22:36:45 +0000328
Victor Hernandeza276c602009-10-17 01:18:07 +0000329 if (isMalloc(Ptr)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000330 // Okay, easy case.
331 } else if (CallInst *CI = dyn_cast<CallInst>(Ptr)) {
332 Function *F = CI->getCalledFunction();
Reid Spencer5cbf9852007-01-30 20:08:39 +0000333 if (!F || !F->isDeclaration()) return false; // Too hard to analyze.
Chris Lattnerab383582006-10-01 22:36:45 +0000334 if (F->getName() != "calloc") return false; // Not calloc.
335 } else {
336 return false; // Too hard to analyze.
337 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000338
Chris Lattnerab383582006-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 Sands9a036b92008-09-03 12:55:42 +0000352
Chris Lattnerab383582006-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 Lattner3b04a8a2004-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 Lattnerfe98f272004-07-27 06:40:37 +0000365/// graph to all callers and compute the mod/ref info for all memory for each
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000366/// function.
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000367void GlobalsModRef::AnalyzeCallGraph(CallGraph &CG, Module &M) {
Chris Lattner3b04a8a2004-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 Sands9a036b92008-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 Sandsf423abc2008-09-04 19:16:20 +0000373 assert(!SCC.empty() && "SCC with no functions?");
Duncan Sands9a036b92008-09-03 12:55:42 +0000374
Duncan Sandsf423abc2008-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 Sands9a036b92008-09-03 12:55:42 +0000380 continue;
Duncan Sandsf423abc2008-09-04 19:16:20 +0000381 }
382
383 FunctionRecord &FR = FunctionInfo[SCC[0]->getFunction()];
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000384
Duncan Sands9a036b92008-09-03 12:55:42 +0000385 bool KnowNothing = false;
386 unsigned FunctionEffect = 0;
Chris Lattnerfe98f272004-07-27 06:40:37 +0000387
Duncan Sands9a036b92008-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 Lattnerfe98f272004-07-27 06:40:37 +0000394 break;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000395 }
Chris Lattnerfe98f272004-07-27 06:40:37 +0000396
Duncan Sands9a036b92008-09-03 12:55:42 +0000397 if (F->isDeclaration()) {
398 // Try to get mod/ref behaviour from function attributes.
Duncan Sandsd0ac3732008-09-03 15:31:24 +0000399 if (F->doesNotAccessMemory()) {
400 // Can't do better than that!
401 } else if (F->onlyReadsMemory()) {
Duncan Sands9a036b92008-09-03 12:55:42 +0000402 FunctionEffect |= Ref;
Duncan Sands2bb4a4d2008-09-12 07:29:58 +0000403 if (!F->isIntrinsic())
Duncan Sands1abe60b2008-09-11 15:43:12 +0000404 // This function might call back into the module and read a global -
Duncan Sands2bb4a4d2008-09-12 07:29:58 +0000405 // consider every global as possibly being read by this function.
406 FR.MayReadAnyGlobal = true;
Duncan Sandsd0ac3732008-09-03 15:31:24 +0000407 } else {
Duncan Sands892b8402008-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 Sands9a036b92008-09-03 12:55:42 +0000412 }
413 continue;
414 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000415
Duncan Sands9a036b92008-09-03 12:55:42 +0000416 for (CallGraphNode::iterator CI = SCC[i]->begin(), E = SCC[i]->end();
Duncan Sandsf423abc2008-09-04 19:16:20 +0000417 CI != E && !KnowNothing; ++CI)
Duncan Sands9a036b92008-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 Gohman79fca6f2010-08-03 21:48:53 +0000424 for (std::map<const GlobalValue*, unsigned>::iterator GI =
Duncan Sands9a036b92008-09-03 12:55:42 +0000425 CalleeFR->GlobalInfo.begin(), E = CalleeFR->GlobalInfo.end();
426 GI != E; ++GI)
Duncan Sandsf423abc2008-09-04 19:16:20 +0000427 FR.GlobalInfo[GI->first] |= GI->second;
Duncan Sands2bb4a4d2008-09-12 07:29:58 +0000428 FR.MayReadAnyGlobal |= CalleeFR->MayReadAnyGlobal;
Duncan Sands9a036b92008-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 Sandsb070bee2008-09-03 16:10:55 +0000446 continue;
Duncan Sands9a036b92008-09-03 12:55:42 +0000447 }
448
449 // Scan the function bodies for explicit loads or stores.
Chris Lattnerfe98f272004-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 Brukman2b37d7c2005-04-21 21:13:18 +0000452 E = inst_end(SCC[i]->getFunction());
Chris Lattnerfe98f272004-07-27 06:40:37 +0000453 II != E && FunctionEffect != ModRef; ++II)
Duncan Sandsb8ca4ff2008-09-13 12:45:50 +0000454 if (isa<LoadInst>(*II)) {
Chris Lattnerfe98f272004-07-27 06:40:37 +0000455 FunctionEffect |= Ref;
Duncan Sandsb8ca4ff2008-09-13 12:45:50 +0000456 if (cast<LoadInst>(*II).isVolatile())
457 // Volatile loads may have side-effects, so mark them as writing
458 // memory (for example, a flag inside the processor).
459 FunctionEffect |= Mod;
460 } else if (isa<StoreInst>(*II)) {
Chris Lattnerfe98f272004-07-27 06:40:37 +0000461 FunctionEffect |= Mod;
Duncan Sandsb8ca4ff2008-09-13 12:45:50 +0000462 if (cast<StoreInst>(*II).isVolatile())
463 // Treat volatile stores as reading memory somewhere.
464 FunctionEffect |= Ref;
Victor Hernandez046e78c2009-10-26 23:43:48 +0000465 } else if (isMalloc(&cast<Instruction>(*II)) ||
Victor Hernandez66284e02009-10-24 04:23:03 +0000466 isFreeCall(&cast<Instruction>(*II))) {
Chris Lattner3fe4d3c2005-04-22 05:36:59 +0000467 FunctionEffect |= ModRef;
Duncan Sandsb8ca4ff2008-09-13 12:45:50 +0000468 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000469
470 if ((FunctionEffect & Mod) == 0)
471 ++NumReadMemFunctions;
472 if (FunctionEffect == 0)
473 ++NumNoMemFunctions;
Duncan Sandsf423abc2008-09-04 19:16:20 +0000474 FR.FunctionEffect = FunctionEffect;
Duncan Sands9a036b92008-09-03 12:55:42 +0000475
476 // Finally, now that we know the full effect on this SCC, clone the
477 // information to each function in the SCC.
478 for (unsigned i = 1, e = SCC.size(); i != e; ++i)
Duncan Sandsf423abc2008-09-04 19:16:20 +0000479 FunctionInfo[SCC[i]->getFunction()] = FR;
Chris Lattnerfe98f272004-07-27 06:40:37 +0000480 }
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000481}
482
483
484
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000485/// alias - If one of the pointers is to a global that we are tracking, and the
486/// other is some random pointer, we know there cannot be an alias, because the
487/// address of the global isn't taken.
488AliasAnalysis::AliasResult
Dan Gohmanb2143b62010-09-14 21:25:10 +0000489GlobalsModRef::alias(const Location &LocA,
490 const Location &LocB) {
Chris Lattnerab383582006-10-01 22:36:45 +0000491 // Get the base object these pointers point to.
Dan Gohmanb2143b62010-09-14 21:25:10 +0000492 const Value *UV1 = LocA.Ptr->getUnderlyingObject();
493 const Value *UV2 = LocB.Ptr->getUnderlyingObject();
Duncan Sands9a036b92008-09-03 12:55:42 +0000494
Chris Lattnerab383582006-10-01 22:36:45 +0000495 // If either of the underlying values is a global, they may be non-addr-taken
496 // globals, which we can answer queries about.
Dan Gohman79fca6f2010-08-03 21:48:53 +0000497 const GlobalValue *GV1 = dyn_cast<GlobalValue>(UV1);
498 const GlobalValue *GV2 = dyn_cast<GlobalValue>(UV2);
Chris Lattnerab383582006-10-01 22:36:45 +0000499 if (GV1 || GV2) {
500 // If the global's address is taken, pretend we don't know it's a pointer to
501 // the global.
502 if (GV1 && !NonAddressTakenGlobals.count(GV1)) GV1 = 0;
503 if (GV2 && !NonAddressTakenGlobals.count(GV2)) GV2 = 0;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000504
Dan Gohmanf451cb82010-02-10 16:03:48 +0000505 // If the two pointers are derived from two different non-addr-taken
Chris Lattnerab383582006-10-01 22:36:45 +0000506 // globals, or if one is and the other isn't, we know these can't alias.
507 if ((GV1 || GV2) && GV1 != GV2)
508 return NoAlias;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000509
Chris Lattnerab383582006-10-01 22:36:45 +0000510 // Otherwise if they are both derived from the same addr-taken global, we
511 // can't know the two accesses don't overlap.
512 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000513
Chris Lattnerab383582006-10-01 22:36:45 +0000514 // These pointers may be based on the memory owned by an indirect global. If
515 // so, we may be able to handle this. First check to see if the base pointer
516 // is a direct load from an indirect global.
517 GV1 = GV2 = 0;
Dan Gohman79fca6f2010-08-03 21:48:53 +0000518 if (const LoadInst *LI = dyn_cast<LoadInst>(UV1))
Chris Lattnerab383582006-10-01 22:36:45 +0000519 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getOperand(0)))
520 if (IndirectGlobals.count(GV))
521 GV1 = GV;
Dan Gohman79fca6f2010-08-03 21:48:53 +0000522 if (const LoadInst *LI = dyn_cast<LoadInst>(UV2))
523 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getOperand(0)))
Chris Lattnerab383582006-10-01 22:36:45 +0000524 if (IndirectGlobals.count(GV))
525 GV2 = GV;
Duncan Sands9a036b92008-09-03 12:55:42 +0000526
Chris Lattnerab383582006-10-01 22:36:45 +0000527 // These pointers may also be from an allocation for the indirect global. If
528 // so, also handle them.
529 if (AllocsForIndirectGlobals.count(UV1))
530 GV1 = AllocsForIndirectGlobals[UV1];
531 if (AllocsForIndirectGlobals.count(UV2))
532 GV2 = AllocsForIndirectGlobals[UV2];
Duncan Sands9a036b92008-09-03 12:55:42 +0000533
Chris Lattnerab383582006-10-01 22:36:45 +0000534 // Now that we know whether the two pointers are related to indirect globals,
535 // use this to disambiguate the pointers. If either pointer is based on an
536 // indirect global and if they are not both based on the same indirect global,
537 // they cannot alias.
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000538 if ((GV1 || GV2) && GV1 != GV2)
539 return NoAlias;
Duncan Sands9a036b92008-09-03 12:55:42 +0000540
Dan Gohmanb2143b62010-09-14 21:25:10 +0000541 return AliasAnalysis::alias(LocA, LocB);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000542}
543
544AliasAnalysis::ModRefResult
Dan Gohman79fca6f2010-08-03 21:48:53 +0000545GlobalsModRef::getModRefInfo(ImmutableCallSite CS,
Dan Gohmanb2143b62010-09-14 21:25:10 +0000546 const Location &Loc) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000547 unsigned Known = ModRef;
548
549 // If we are asking for mod/ref info of a direct call with a pointer to a
Chris Lattnerfe98f272004-07-27 06:40:37 +0000550 // global we are tracking, return information if we have it.
Dan Gohmanb2143b62010-09-14 21:25:10 +0000551 if (const GlobalValue *GV =
552 dyn_cast<GlobalValue>(Loc.Ptr->getUnderlyingObject()))
Rafael Espindolabb46f522009-01-15 20:18:42 +0000553 if (GV->hasLocalLinkage())
Dan Gohman79fca6f2010-08-03 21:48:53 +0000554 if (const Function *F = CS.getCalledFunction())
Chris Lattnerfe98f272004-07-27 06:40:37 +0000555 if (NonAddressTakenGlobals.count(GV))
Dan Gohman79fca6f2010-08-03 21:48:53 +0000556 if (const FunctionRecord *FR = getFunctionInfo(F))
Chris Lattnerfe98f272004-07-27 06:40:37 +0000557 Known = FR->getInfoForGlobal(GV);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000558
559 if (Known == NoModRef)
560 return NoModRef; // No need to query other mod/ref analyses
Dan Gohmanb2143b62010-09-14 21:25:10 +0000561 return ModRefResult(Known & AliasAnalysis::getModRefInfo(CS, Loc));
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000562}
563
564
565//===----------------------------------------------------------------------===//
566// Methods to update the analysis as a result of the client transformation.
567//
568void GlobalsModRef::deleteValue(Value *V) {
Chris Lattnerab383582006-10-01 22:36:45 +0000569 if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
570 if (NonAddressTakenGlobals.erase(GV)) {
571 // This global might be an indirect global. If so, remove it and remove
572 // any AllocRelatedValues for it.
573 if (IndirectGlobals.erase(GV)) {
574 // Remove any entries in AllocsForIndirectGlobals for this global.
Dan Gohman79fca6f2010-08-03 21:48:53 +0000575 for (std::map<const Value*, const GlobalValue*>::iterator
Chris Lattnerab383582006-10-01 22:36:45 +0000576 I = AllocsForIndirectGlobals.begin(),
577 E = AllocsForIndirectGlobals.end(); I != E; ) {
578 if (I->second == GV) {
579 AllocsForIndirectGlobals.erase(I++);
580 } else {
581 ++I;
582 }
583 }
584 }
585 }
586 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000587
Chris Lattnerab383582006-10-01 22:36:45 +0000588 // Otherwise, if this is an allocation related to an indirect global, remove
589 // it.
590 AllocsForIndirectGlobals.erase(V);
Duncan Sands9a036b92008-09-03 12:55:42 +0000591
Chris Lattnercd883f22007-11-30 18:52:58 +0000592 AliasAnalysis::deleteValue(V);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000593}
594
595void GlobalsModRef::copyValue(Value *From, Value *To) {
Chris Lattnercd883f22007-11-30 18:52:58 +0000596 AliasAnalysis::copyValue(From, To);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000597}