blob: 116aaf418ea0ebb6f8d4866bfcc80a3eb47723f8 [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"
Dan Gohman5034dd32010-12-15 20:02:24 +000027#include "llvm/Analysis/ValueTracking.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000028#include "llvm/Support/CommandLine.h"
Reid Spencerd7d83db2007-02-05 23:42:17 +000029#include "llvm/Support/InstIterator.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000030#include "llvm/ADT/Statistic.h"
31#include "llvm/ADT/SCCIterator.h"
Chris Lattner3b04a8a2004-06-28 06:33:13 +000032#include <set>
33using namespace llvm;
34
Chris Lattner3b27d682006-12-19 22:30:33 +000035STATISTIC(NumNonAddrTakenGlobalVars,
36 "Number of global vars without address taken");
37STATISTIC(NumNonAddrTakenFunctions,"Number of functions without address taken");
38STATISTIC(NumNoMemFunctions, "Number of functions that do not access memory");
39STATISTIC(NumReadMemFunctions, "Number of functions that only read memory");
40STATISTIC(NumIndirectGlobalVars, "Number of indirect global objects");
41
Chris Lattner3b04a8a2004-06-28 06:33:13 +000042namespace {
Chris Lattnerfe98f272004-07-27 06:40:37 +000043 /// FunctionRecord - One instance of this structure is stored for every
44 /// function in the program. Later, the entries for these functions are
45 /// removed if the function is found to call an external function (in which
46 /// case we know nothing about it.
Nick Lewycky6726b6d2009-10-25 06:33:48 +000047 struct FunctionRecord {
Chris Lattnerfe98f272004-07-27 06:40:37 +000048 /// GlobalInfo - Maintain mod/ref info for all of the globals without
49 /// addresses taken that are read or written (transitively) by this
50 /// function.
Dan Gohman79fca6f2010-08-03 21:48:53 +000051 std::map<const GlobalValue*, unsigned> GlobalInfo;
Chris Lattnerfe98f272004-07-27 06:40:37 +000052
Duncan Sands2bb4a4d2008-09-12 07:29:58 +000053 /// MayReadAnyGlobal - May read global variables, but it is not known which.
54 bool MayReadAnyGlobal;
55
Dan Gohman79fca6f2010-08-03 21:48:53 +000056 unsigned getInfoForGlobal(const GlobalValue *GV) const {
Duncan Sands2bb4a4d2008-09-12 07:29:58 +000057 unsigned Effect = MayReadAnyGlobal ? AliasAnalysis::Ref : 0;
Dan Gohman79fca6f2010-08-03 21:48:53 +000058 std::map<const GlobalValue*, unsigned>::const_iterator I =
59 GlobalInfo.find(GV);
Chris Lattnerfe98f272004-07-27 06:40:37 +000060 if (I != GlobalInfo.end())
Duncan Sands2bb4a4d2008-09-12 07:29:58 +000061 Effect |= I->second;
62 return Effect;
Chris Lattnerfe98f272004-07-27 06:40:37 +000063 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +000064
Chris Lattnerfe98f272004-07-27 06:40:37 +000065 /// FunctionEffect - Capture whether or not this function reads or writes to
66 /// ANY memory. If not, we can do a lot of aggressive analysis on it.
67 unsigned FunctionEffect;
Chris Lattner105d26a2004-07-27 07:46:26 +000068
Duncan Sands2bb4a4d2008-09-12 07:29:58 +000069 FunctionRecord() : MayReadAnyGlobal (false), FunctionEffect(0) {}
Chris Lattnerfe98f272004-07-27 06:40:37 +000070 };
71
72 /// GlobalsModRef - The actual analysis pass.
Nick Lewycky6726b6d2009-10-25 06:33:48 +000073 class GlobalsModRef : public ModulePass, public AliasAnalysis {
Chris Lattnerfe98f272004-07-27 06:40:37 +000074 /// NonAddressTakenGlobals - The globals that do not have their addresses
75 /// taken.
Dan Gohman79fca6f2010-08-03 21:48:53 +000076 std::set<const GlobalValue*> NonAddressTakenGlobals;
Chris Lattner3b04a8a2004-06-28 06:33:13 +000077
Chris Lattnerab383582006-10-01 22:36:45 +000078 /// IndirectGlobals - The memory pointed to by this global is known to be
79 /// 'owned' by the global.
Dan Gohman79fca6f2010-08-03 21:48:53 +000080 std::set<const GlobalValue*> IndirectGlobals;
Duncan Sands9a036b92008-09-03 12:55:42 +000081
Chris Lattnerab383582006-10-01 22:36:45 +000082 /// AllocsForIndirectGlobals - If an instruction allocates memory for an
83 /// indirect global, this map indicates which one.
Dan Gohman79fca6f2010-08-03 21:48:53 +000084 std::map<const Value*, const GlobalValue*> AllocsForIndirectGlobals;
Duncan Sands9a036b92008-09-03 12:55:42 +000085
Chris Lattner3b04a8a2004-06-28 06:33:13 +000086 /// FunctionInfo - For each function, keep track of what globals are
87 /// modified or read.
Dan Gohman79fca6f2010-08-03 21:48:53 +000088 std::map<const Function*, FunctionRecord> FunctionInfo;
Chris Lattner3b04a8a2004-06-28 06:33:13 +000089
90 public:
Devang Patel19974732007-05-03 01:11:54 +000091 static char ID;
Owen Anderson081c34b2010-10-19 17:21:58 +000092 GlobalsModRef() : ModulePass(ID) {
93 initializeGlobalsModRefPass(*PassRegistry::getPassRegistry());
94 }
Devang Patel1cee94f2008-03-18 00:39:19 +000095
Chris Lattnerb12914b2004-09-20 04:48:05 +000096 bool runOnModule(Module &M) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +000097 InitializeAliasAnalysis(this); // set up super class
98 AnalyzeGlobals(M); // find non-addr taken globals
99 AnalyzeCallGraph(getAnalysis<CallGraph>(), M); // Propagate on CG
100 return false;
101 }
102
103 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
104 AliasAnalysis::getAnalysisUsage(AU);
105 AU.addRequired<CallGraph>();
106 AU.setPreservesAll(); // Does not transform code
107 }
108
109 //------------------------------------------------
110 // Implement the AliasAnalysis API
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000111 //
Dan Gohmanb2143b62010-09-14 21:25:10 +0000112 AliasResult alias(const Location &LocA, const Location &LocB);
Dan Gohman79fca6f2010-08-03 21:48:53 +0000113 ModRefResult getModRefInfo(ImmutableCallSite CS,
Dan Gohmanb2143b62010-09-14 21:25:10 +0000114 const Location &Loc);
Dan Gohman79fca6f2010-08-03 21:48:53 +0000115 ModRefResult getModRefInfo(ImmutableCallSite CS1,
116 ImmutableCallSite CS2) {
117 return AliasAnalysis::getModRefInfo(CS1, CS2);
Reid Spencer4a7ebfa2004-12-07 08:11:24 +0000118 }
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000119
Chris Lattner0af024c2004-12-15 07:22:13 +0000120 /// getModRefBehavior - Return the behavior of the specified function if
121 /// called from the specified call site. The call site may be null in which
122 /// case the most generic behavior of this function should be returned.
Dan Gohmana41af342010-08-03 23:08:10 +0000123 ModRefBehavior getModRefBehavior(const Function *F) {
Dan Gohman42c31a72010-11-10 01:02:18 +0000124 ModRefBehavior Min = UnknownModRefBehavior;
125
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +0000126 if (FunctionRecord *FR = getFunctionInfo(F)) {
Chris Lattnerfe98f272004-07-27 06:40:37 +0000127 if (FR->FunctionEffect == 0)
Dan Gohman42c31a72010-11-10 01:02:18 +0000128 Min = DoesNotAccessMemory;
Misha Brukmandedf2bd2005-04-22 04:01:18 +0000129 else if ((FR->FunctionEffect & Mod) == 0)
Dan Gohman42c31a72010-11-10 01:02:18 +0000130 Min = OnlyReadsMemory;
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +0000131 }
Dan Gohman42c31a72010-11-10 01:02:18 +0000132
133 return ModRefBehavior(AliasAnalysis::getModRefBehavior(F) & Min);
Owen Andersone7942202009-02-05 23:36:27 +0000134 }
135
136 /// getModRefBehavior - Return the behavior of the specified function if
137 /// called from the specified call site. The call site may be null in which
138 /// case the most generic behavior of this function should be returned.
Dan Gohmana41af342010-08-03 23:08:10 +0000139 ModRefBehavior getModRefBehavior(ImmutableCallSite CS) {
Dan Gohman42c31a72010-11-10 01:02:18 +0000140 ModRefBehavior Min = UnknownModRefBehavior;
141
142 if (const Function* F = CS.getCalledFunction())
143 if (FunctionRecord *FR = getFunctionInfo(F)) {
144 if (FR->FunctionEffect == 0)
145 Min = DoesNotAccessMemory;
146 else if ((FR->FunctionEffect & Mod) == 0)
147 Min = OnlyReadsMemory;
148 }
149
150 return ModRefBehavior(AliasAnalysis::getModRefBehavior(CS) & Min);
Chris Lattnerfe98f272004-07-27 06:40:37 +0000151 }
Chris Lattnerfe98f272004-07-27 06:40:37 +0000152
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000153 virtual void deleteValue(Value *V);
154 virtual void copyValue(Value *From, Value *To);
Owen Anderson392249f2011-01-03 23:51:43 +0000155 virtual void addEscapingUse(Use &U);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000156
Chris Lattnerfc570e42010-01-20 19:53:32 +0000157 /// getAdjustedAnalysisPointer - This method is used when a pass implements
158 /// an analysis interface through multiple inheritance. If needed, it
159 /// should override this to adjust the this pointer as needed for the
160 /// specified pass info.
Owen Anderson90c579d2010-08-06 18:33:48 +0000161 virtual void *getAdjustedAnalysisPointer(AnalysisID PI) {
162 if (PI == &AliasAnalysis::ID)
Chris Lattnerfc570e42010-01-20 19:53:32 +0000163 return (AliasAnalysis*)this;
164 return this;
165 }
166
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000167 private:
Chris Lattnerfe98f272004-07-27 06:40:37 +0000168 /// getFunctionInfo - Return the function info for the function, or null if
Duncan Sands9a036b92008-09-03 12:55:42 +0000169 /// we don't have anything useful to say about it.
Dan Gohman79fca6f2010-08-03 21:48:53 +0000170 FunctionRecord *getFunctionInfo(const Function *F) {
171 std::map<const Function*, FunctionRecord>::iterator I =
172 FunctionInfo.find(F);
Chris Lattnerfe98f272004-07-27 06:40:37 +0000173 if (I != FunctionInfo.end())
174 return &I->second;
175 return 0;
176 }
177
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000178 void AnalyzeGlobals(Module &M);
179 void AnalyzeCallGraph(CallGraph &CG, Module &M);
Chris Lattnerab383582006-10-01 22:36:45 +0000180 bool AnalyzeUsesOfPointer(Value *V, std::vector<Function*> &Readers,
181 std::vector<Function*> &Writers,
182 GlobalValue *OkayStoreDest = 0);
183 bool AnalyzeIndirectGlobalMemory(GlobalValue *GV);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000184 };
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000185}
186
Dan Gohman844731a2008-05-13 00:00:25 +0000187char GlobalsModRef::ID = 0;
Owen Anderson2ab36d32010-10-12 19:48:12 +0000188INITIALIZE_AG_PASS_BEGIN(GlobalsModRef, AliasAnalysis,
189 "globalsmodref-aa", "Simple mod/ref analysis for globals",
190 false, true, false)
191INITIALIZE_AG_DEPENDENCY(CallGraph)
192INITIALIZE_AG_PASS_END(GlobalsModRef, AliasAnalysis,
Owen Anderson02dd53e2010-08-23 17:52:01 +0000193 "globalsmodref-aa", "Simple mod/ref analysis for globals",
Owen Andersonce665bd2010-10-07 22:25:06 +0000194 false, true, false)
Dan Gohman844731a2008-05-13 00:00:25 +0000195
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000196Pass *llvm::createGlobalsModRefPass() { return new GlobalsModRef(); }
197
Chris Lattnerab383582006-10-01 22:36:45 +0000198/// AnalyzeGlobals - Scan through the users of all of the internal
Duncan Sands9a036b92008-09-03 12:55:42 +0000199/// GlobalValue's in the program. If none of them have their "address taken"
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000200/// (really, their address passed to something nontrivial), record this fact,
201/// and record the functions that they are used directly in.
202void GlobalsModRef::AnalyzeGlobals(Module &M) {
203 std::vector<Function*> Readers, Writers;
204 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
Rafael Espindolabb46f522009-01-15 20:18:42 +0000205 if (I->hasLocalLinkage()) {
Chris Lattnerab383582006-10-01 22:36:45 +0000206 if (!AnalyzeUsesOfPointer(I, Readers, Writers)) {
Chris Lattnerfe98f272004-07-27 06:40:37 +0000207 // Remember that we are tracking this global.
208 NonAddressTakenGlobals.insert(I);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000209 ++NumNonAddrTakenFunctions;
210 }
211 Readers.clear(); Writers.clear();
212 }
213
Chris Lattnerf5eaf3c2005-03-23 23:51:12 +0000214 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
215 I != E; ++I)
Rafael Espindolabb46f522009-01-15 20:18:42 +0000216 if (I->hasLocalLinkage()) {
Chris Lattnerab383582006-10-01 22:36:45 +0000217 if (!AnalyzeUsesOfPointer(I, Readers, Writers)) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000218 // Remember that we are tracking this global, and the mod/ref fns
Chris Lattnerfe98f272004-07-27 06:40:37 +0000219 NonAddressTakenGlobals.insert(I);
Duncan Sands9a036b92008-09-03 12:55:42 +0000220
Chris Lattnerfe98f272004-07-27 06:40:37 +0000221 for (unsigned i = 0, e = Readers.size(); i != e; ++i)
222 FunctionInfo[Readers[i]].GlobalInfo[I] |= Ref;
223
224 if (!I->isConstant()) // No need to keep track of writers to constants
225 for (unsigned i = 0, e = Writers.size(); i != e; ++i)
226 FunctionInfo[Writers[i]].GlobalInfo[I] |= Mod;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000227 ++NumNonAddrTakenGlobalVars;
Duncan Sands9a036b92008-09-03 12:55:42 +0000228
Chris Lattnerab383582006-10-01 22:36:45 +0000229 // If this global holds a pointer type, see if it is an indirect global.
Duncan Sands1df98592010-02-16 11:11:14 +0000230 if (I->getType()->getElementType()->isPointerTy() &&
Chris Lattnerab383582006-10-01 22:36:45 +0000231 AnalyzeIndirectGlobalMemory(I))
232 ++NumIndirectGlobalVars;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000233 }
234 Readers.clear(); Writers.clear();
235 }
236}
237
Chris Lattnerab383582006-10-01 22:36:45 +0000238/// AnalyzeUsesOfPointer - Look at all of the users of the specified pointer.
239/// If this is used by anything complex (i.e., the address escapes), return
240/// true. Also, while we are at it, keep track of those functions that read and
241/// write to the value.
242///
243/// If OkayStoreDest is non-null, stores into this global are allowed.
244bool GlobalsModRef::AnalyzeUsesOfPointer(Value *V,
245 std::vector<Function*> &Readers,
246 std::vector<Function*> &Writers,
247 GlobalValue *OkayStoreDest) {
Duncan Sands1df98592010-02-16 11:11:14 +0000248 if (!V->getType()->isPointerTy()) return true;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000249
Gabor Greifd7cc5212010-07-09 15:53:42 +0000250 for (Value::use_iterator UI = V->use_begin(), E=V->use_end(); UI != E; ++UI) {
251 User *U = *UI;
252 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000253 Readers.push_back(LI->getParent()->getParent());
Gabor Greifd7cc5212010-07-09 15:53:42 +0000254 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000255 if (V == SI->getOperand(1)) {
256 Writers.push_back(SI->getParent()->getParent());
257 } else if (SI->getOperand(1) != OkayStoreDest) {
258 return true; // Storing the pointer
259 }
Gabor Greifd7cc5212010-07-09 15:53:42 +0000260 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000261 if (AnalyzeUsesOfPointer(GEP, Readers, Writers)) return true;
Gabor Greifd7cc5212010-07-09 15:53:42 +0000262 } else if (BitCastInst *BCI = dyn_cast<BitCastInst>(U)) {
Victor Hernandez46e83122009-09-18 21:34:51 +0000263 if (AnalyzeUsesOfPointer(BCI, Readers, Writers, OkayStoreDest))
264 return true;
Gabor Greifd7cc5212010-07-09 15:53:42 +0000265 } else if (isFreeCall(U)) {
266 Writers.push_back(cast<Instruction>(U)->getParent()->getParent());
267 } else if (CallInst *CI = dyn_cast<CallInst>(U)) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000268 // Make sure that this is just the function being called, not that it is
269 // passing into the function.
Bill Wendling22a5b292010-06-07 19:05:06 +0000270 for (unsigned i = 0, e = CI->getNumArgOperands(); i != e; ++i)
271 if (CI->getArgOperand(i) == V) return true;
Gabor Greifd7cc5212010-07-09 15:53:42 +0000272 } else if (InvokeInst *II = dyn_cast<InvokeInst>(U)) {
Chris Lattner3b04a8a2004-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 Wendling22a5b292010-06-07 19:05:06 +0000275 for (unsigned i = 0, e = II->getNumArgOperands(); i != e; ++i)
276 if (II->getArgOperand(i) == V) return true;
Gabor Greifd7cc5212010-07-09 15:53:42 +0000277 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
Duncan Sands9a036b92008-09-03 12:55:42 +0000278 if (CE->getOpcode() == Instruction::GetElementPtr ||
Reid Spencer3da59db2006-11-27 01:05:10 +0000279 CE->getOpcode() == Instruction::BitCast) {
Chris Lattnerab383582006-10-01 22:36:45 +0000280 if (AnalyzeUsesOfPointer(CE, Readers, Writers))
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000281 return true;
282 } else {
283 return true;
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000284 }
Gabor Greifd7cc5212010-07-09 15:53:42 +0000285 } else if (ICmpInst *ICI = dyn_cast<ICmpInst>(U)) {
Reid Spencere4d87aa2006-12-23 06:05:41 +0000286 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
Chris Lattnerab383582006-10-01 22:36:45 +0000287 return true; // Allow comparison against null.
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000288 } else {
289 return true;
290 }
Gabor Greifd7cc5212010-07-09 15:53:42 +0000291 }
292
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000293 return false;
294}
295
Chris Lattnerab383582006-10-01 22:36:45 +0000296/// AnalyzeIndirectGlobalMemory - We found an non-address-taken global variable
297/// which holds a pointer type. See if the global always points to non-aliased
298/// heap memory: that is, all initializers of the globals are allocations, and
299/// those allocations have no use other than initialization of the global.
300/// Further, all loads out of GV must directly use the memory, not store the
301/// pointer somewhere. If this is true, we consider the memory pointed to by
302/// GV to be owned by GV and can disambiguate other pointers from it.
303bool GlobalsModRef::AnalyzeIndirectGlobalMemory(GlobalValue *GV) {
304 // Keep track of values related to the allocation of the memory, f.e. the
305 // value produced by the malloc call and any casts.
306 std::vector<Value*> AllocRelatedValues;
Duncan Sands9a036b92008-09-03 12:55:42 +0000307
Chris Lattnerab383582006-10-01 22:36:45 +0000308 // Walk the user list of the global. If we find anything other than a direct
309 // load or store, bail out.
310 for (Value::use_iterator I = GV->use_begin(), E = GV->use_end(); I != E; ++I){
Gabor Greif8ba992a2010-07-09 16:22:36 +0000311 User *U = *I;
312 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000313 // The pointer loaded from the global can only be used in simple ways:
314 // we allow addressing of it and loading storing to it. We do *not* allow
315 // storing the loaded pointer somewhere else or passing to a function.
316 std::vector<Function*> ReadersWriters;
317 if (AnalyzeUsesOfPointer(LI, ReadersWriters, ReadersWriters))
318 return false; // Loaded pointer escapes.
319 // TODO: Could try some IP mod/ref of the loaded pointer.
Gabor Greif8ba992a2010-07-09 16:22:36 +0000320 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000321 // Storing the global itself.
322 if (SI->getOperand(0) == GV) return false;
Duncan Sands9a036b92008-09-03 12:55:42 +0000323
Chris Lattnerab383582006-10-01 22:36:45 +0000324 // If storing the null pointer, ignore it.
325 if (isa<ConstantPointerNull>(SI->getOperand(0)))
326 continue;
Duncan Sands9a036b92008-09-03 12:55:42 +0000327
Chris Lattnerab383582006-10-01 22:36:45 +0000328 // Check the value being stored.
Dan Gohman5034dd32010-12-15 20:02:24 +0000329 Value *Ptr = GetUnderlyingObject(SI->getOperand(0));
Chris Lattnerab383582006-10-01 22:36:45 +0000330
Victor Hernandeza276c602009-10-17 01:18:07 +0000331 if (isMalloc(Ptr)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000332 // Okay, easy case.
333 } else if (CallInst *CI = dyn_cast<CallInst>(Ptr)) {
334 Function *F = CI->getCalledFunction();
Reid Spencer5cbf9852007-01-30 20:08:39 +0000335 if (!F || !F->isDeclaration()) return false; // Too hard to analyze.
Chris Lattnerab383582006-10-01 22:36:45 +0000336 if (F->getName() != "calloc") return false; // Not calloc.
337 } else {
338 return false; // Too hard to analyze.
339 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000340
Chris Lattnerab383582006-10-01 22:36:45 +0000341 // Analyze all uses of the allocation. If any of them are used in a
342 // non-simple way (e.g. stored to another global) bail out.
343 std::vector<Function*> ReadersWriters;
344 if (AnalyzeUsesOfPointer(Ptr, ReadersWriters, ReadersWriters, GV))
345 return false; // Loaded pointer escapes.
346
347 // Remember that this allocation is related to the indirect global.
348 AllocRelatedValues.push_back(Ptr);
349 } else {
350 // Something complex, bail out.
351 return false;
352 }
353 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000354
Chris Lattnerab383582006-10-01 22:36:45 +0000355 // Okay, this is an indirect global. Remember all of the allocations for
356 // this global in AllocsForIndirectGlobals.
357 while (!AllocRelatedValues.empty()) {
358 AllocsForIndirectGlobals[AllocRelatedValues.back()] = GV;
359 AllocRelatedValues.pop_back();
360 }
361 IndirectGlobals.insert(GV);
362 return true;
363}
364
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000365/// AnalyzeCallGraph - At this point, we know the functions where globals are
366/// immediately stored to and read from. Propagate this information up the call
Chris Lattnerfe98f272004-07-27 06:40:37 +0000367/// graph to all callers and compute the mod/ref info for all memory for each
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000368/// function.
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000369void GlobalsModRef::AnalyzeCallGraph(CallGraph &CG, Module &M) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000370 // We do a bottom-up SCC traversal of the call graph. In other words, we
371 // visit all callees before callers (leaf-first).
Duncan Sands9a036b92008-09-03 12:55:42 +0000372 for (scc_iterator<CallGraph*> I = scc_begin(&CG), E = scc_end(&CG); I != E;
373 ++I) {
374 std::vector<CallGraphNode *> &SCC = *I;
Duncan Sandsf423abc2008-09-04 19:16:20 +0000375 assert(!SCC.empty() && "SCC with no functions?");
Duncan Sands9a036b92008-09-03 12:55:42 +0000376
Duncan Sandsf423abc2008-09-04 19:16:20 +0000377 if (!SCC[0]->getFunction()) {
378 // Calls externally - can't say anything useful. Remove any existing
379 // function records (may have been created when scanning globals).
380 for (unsigned i = 0, e = SCC.size(); i != e; ++i)
381 FunctionInfo.erase(SCC[i]->getFunction());
Duncan Sands9a036b92008-09-03 12:55:42 +0000382 continue;
Duncan Sandsf423abc2008-09-04 19:16:20 +0000383 }
384
385 FunctionRecord &FR = FunctionInfo[SCC[0]->getFunction()];
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000386
Duncan Sands9a036b92008-09-03 12:55:42 +0000387 bool KnowNothing = false;
388 unsigned FunctionEffect = 0;
Chris Lattnerfe98f272004-07-27 06:40:37 +0000389
Duncan Sands9a036b92008-09-03 12:55:42 +0000390 // Collect the mod/ref properties due to called functions. We only compute
391 // one mod-ref set.
392 for (unsigned i = 0, e = SCC.size(); i != e && !KnowNothing; ++i) {
393 Function *F = SCC[i]->getFunction();
394 if (!F) {
395 KnowNothing = true;
Chris Lattnerfe98f272004-07-27 06:40:37 +0000396 break;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000397 }
Chris Lattnerfe98f272004-07-27 06:40:37 +0000398
Duncan Sands9a036b92008-09-03 12:55:42 +0000399 if (F->isDeclaration()) {
400 // Try to get mod/ref behaviour from function attributes.
Duncan Sandsd0ac3732008-09-03 15:31:24 +0000401 if (F->doesNotAccessMemory()) {
402 // Can't do better than that!
403 } else if (F->onlyReadsMemory()) {
Duncan Sands9a036b92008-09-03 12:55:42 +0000404 FunctionEffect |= Ref;
Duncan Sands2bb4a4d2008-09-12 07:29:58 +0000405 if (!F->isIntrinsic())
Duncan Sands1abe60b2008-09-11 15:43:12 +0000406 // This function might call back into the module and read a global -
Duncan Sands2bb4a4d2008-09-12 07:29:58 +0000407 // consider every global as possibly being read by this function.
408 FR.MayReadAnyGlobal = true;
Duncan Sandsd0ac3732008-09-03 15:31:24 +0000409 } else {
Duncan Sands892b8402008-09-11 19:35:55 +0000410 FunctionEffect |= ModRef;
411 // Can't say anything useful unless it's an intrinsic - they don't
412 // read or write global variables of the kind considered here.
413 KnowNothing = !F->isIntrinsic();
Duncan Sands9a036b92008-09-03 12:55:42 +0000414 }
415 continue;
416 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000417
Duncan Sands9a036b92008-09-03 12:55:42 +0000418 for (CallGraphNode::iterator CI = SCC[i]->begin(), E = SCC[i]->end();
Duncan Sandsf423abc2008-09-04 19:16:20 +0000419 CI != E && !KnowNothing; ++CI)
Duncan Sands9a036b92008-09-03 12:55:42 +0000420 if (Function *Callee = CI->second->getFunction()) {
421 if (FunctionRecord *CalleeFR = getFunctionInfo(Callee)) {
422 // Propagate function effect up.
423 FunctionEffect |= CalleeFR->FunctionEffect;
424
425 // Incorporate callee's effects on globals into our info.
Dan Gohman79fca6f2010-08-03 21:48:53 +0000426 for (std::map<const GlobalValue*, unsigned>::iterator GI =
Duncan Sands9a036b92008-09-03 12:55:42 +0000427 CalleeFR->GlobalInfo.begin(), E = CalleeFR->GlobalInfo.end();
428 GI != E; ++GI)
Duncan Sandsf423abc2008-09-04 19:16:20 +0000429 FR.GlobalInfo[GI->first] |= GI->second;
Duncan Sands2bb4a4d2008-09-12 07:29:58 +0000430 FR.MayReadAnyGlobal |= CalleeFR->MayReadAnyGlobal;
Duncan Sands9a036b92008-09-03 12:55:42 +0000431 } else {
432 // Can't say anything about it. However, if it is inside our SCC,
433 // then nothing needs to be done.
434 CallGraphNode *CalleeNode = CG[Callee];
435 if (std::find(SCC.begin(), SCC.end(), CalleeNode) == SCC.end())
436 KnowNothing = true;
437 }
438 } else {
439 KnowNothing = true;
440 }
441 }
442
443 // If we can't say anything useful about this SCC, remove all SCC functions
444 // from the FunctionInfo map.
445 if (KnowNothing) {
446 for (unsigned i = 0, e = SCC.size(); i != e; ++i)
447 FunctionInfo.erase(SCC[i]->getFunction());
Duncan Sandsb070bee2008-09-03 16:10:55 +0000448 continue;
Duncan Sands9a036b92008-09-03 12:55:42 +0000449 }
450
451 // Scan the function bodies for explicit loads or stores.
Chris Lattnerfe98f272004-07-27 06:40:37 +0000452 for (unsigned i = 0, e = SCC.size(); i != e && FunctionEffect != ModRef;++i)
453 for (inst_iterator II = inst_begin(SCC[i]->getFunction()),
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000454 E = inst_end(SCC[i]->getFunction());
Chris Lattnerfe98f272004-07-27 06:40:37 +0000455 II != E && FunctionEffect != ModRef; ++II)
Duncan Sandsb8ca4ff2008-09-13 12:45:50 +0000456 if (isa<LoadInst>(*II)) {
Chris Lattnerfe98f272004-07-27 06:40:37 +0000457 FunctionEffect |= Ref;
Duncan Sandsb8ca4ff2008-09-13 12:45:50 +0000458 if (cast<LoadInst>(*II).isVolatile())
459 // Volatile loads may have side-effects, so mark them as writing
460 // memory (for example, a flag inside the processor).
461 FunctionEffect |= Mod;
462 } else if (isa<StoreInst>(*II)) {
Chris Lattnerfe98f272004-07-27 06:40:37 +0000463 FunctionEffect |= Mod;
Duncan Sandsb8ca4ff2008-09-13 12:45:50 +0000464 if (cast<StoreInst>(*II).isVolatile())
465 // Treat volatile stores as reading memory somewhere.
466 FunctionEffect |= Ref;
Victor Hernandez046e78c2009-10-26 23:43:48 +0000467 } else if (isMalloc(&cast<Instruction>(*II)) ||
Victor Hernandez66284e02009-10-24 04:23:03 +0000468 isFreeCall(&cast<Instruction>(*II))) {
Chris Lattner3fe4d3c2005-04-22 05:36:59 +0000469 FunctionEffect |= ModRef;
Duncan Sandsb8ca4ff2008-09-13 12:45:50 +0000470 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000471
472 if ((FunctionEffect & Mod) == 0)
473 ++NumReadMemFunctions;
474 if (FunctionEffect == 0)
475 ++NumNoMemFunctions;
Duncan Sandsf423abc2008-09-04 19:16:20 +0000476 FR.FunctionEffect = FunctionEffect;
Duncan Sands9a036b92008-09-03 12:55:42 +0000477
478 // Finally, now that we know the full effect on this SCC, clone the
479 // information to each function in the SCC.
480 for (unsigned i = 1, e = SCC.size(); i != e; ++i)
Duncan Sandsf423abc2008-09-04 19:16:20 +0000481 FunctionInfo[SCC[i]->getFunction()] = FR;
Chris Lattnerfe98f272004-07-27 06:40:37 +0000482 }
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000483}
484
485
486
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000487/// alias - If one of the pointers is to a global that we are tracking, and the
488/// other is some random pointer, we know there cannot be an alias, because the
489/// address of the global isn't taken.
490AliasAnalysis::AliasResult
Dan Gohmanb2143b62010-09-14 21:25:10 +0000491GlobalsModRef::alias(const Location &LocA,
492 const Location &LocB) {
Chris Lattnerab383582006-10-01 22:36:45 +0000493 // Get the base object these pointers point to.
Dan Gohman5034dd32010-12-15 20:02:24 +0000494 const Value *UV1 = GetUnderlyingObject(LocA.Ptr);
495 const Value *UV2 = GetUnderlyingObject(LocB.Ptr);
Duncan Sands9a036b92008-09-03 12:55:42 +0000496
Chris Lattnerab383582006-10-01 22:36:45 +0000497 // If either of the underlying values is a global, they may be non-addr-taken
498 // globals, which we can answer queries about.
Dan Gohman79fca6f2010-08-03 21:48:53 +0000499 const GlobalValue *GV1 = dyn_cast<GlobalValue>(UV1);
500 const GlobalValue *GV2 = dyn_cast<GlobalValue>(UV2);
Chris Lattnerab383582006-10-01 22:36:45 +0000501 if (GV1 || GV2) {
502 // If the global's address is taken, pretend we don't know it's a pointer to
503 // the global.
504 if (GV1 && !NonAddressTakenGlobals.count(GV1)) GV1 = 0;
505 if (GV2 && !NonAddressTakenGlobals.count(GV2)) GV2 = 0;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000506
Dan Gohmanf451cb82010-02-10 16:03:48 +0000507 // If the two pointers are derived from two different non-addr-taken
Chris Lattnerab383582006-10-01 22:36:45 +0000508 // globals, or if one is and the other isn't, we know these can't alias.
509 if ((GV1 || GV2) && GV1 != GV2)
510 return NoAlias;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000511
Chris Lattnerab383582006-10-01 22:36:45 +0000512 // Otherwise if they are both derived from the same addr-taken global, we
513 // can't know the two accesses don't overlap.
514 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000515
Chris Lattnerab383582006-10-01 22:36:45 +0000516 // These pointers may be based on the memory owned by an indirect global. If
517 // so, we may be able to handle this. First check to see if the base pointer
518 // is a direct load from an indirect global.
519 GV1 = GV2 = 0;
Dan Gohman79fca6f2010-08-03 21:48:53 +0000520 if (const LoadInst *LI = dyn_cast<LoadInst>(UV1))
Chris Lattnerab383582006-10-01 22:36:45 +0000521 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getOperand(0)))
522 if (IndirectGlobals.count(GV))
523 GV1 = GV;
Dan Gohman79fca6f2010-08-03 21:48:53 +0000524 if (const LoadInst *LI = dyn_cast<LoadInst>(UV2))
525 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getOperand(0)))
Chris Lattnerab383582006-10-01 22:36:45 +0000526 if (IndirectGlobals.count(GV))
527 GV2 = GV;
Duncan Sands9a036b92008-09-03 12:55:42 +0000528
Chris Lattnerab383582006-10-01 22:36:45 +0000529 // These pointers may also be from an allocation for the indirect global. If
530 // so, also handle them.
531 if (AllocsForIndirectGlobals.count(UV1))
532 GV1 = AllocsForIndirectGlobals[UV1];
533 if (AllocsForIndirectGlobals.count(UV2))
534 GV2 = AllocsForIndirectGlobals[UV2];
Duncan Sands9a036b92008-09-03 12:55:42 +0000535
Chris Lattnerab383582006-10-01 22:36:45 +0000536 // Now that we know whether the two pointers are related to indirect globals,
537 // use this to disambiguate the pointers. If either pointer is based on an
538 // indirect global and if they are not both based on the same indirect global,
539 // they cannot alias.
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000540 if ((GV1 || GV2) && GV1 != GV2)
541 return NoAlias;
Duncan Sands9a036b92008-09-03 12:55:42 +0000542
Dan Gohmanb2143b62010-09-14 21:25:10 +0000543 return AliasAnalysis::alias(LocA, LocB);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000544}
545
546AliasAnalysis::ModRefResult
Dan Gohman79fca6f2010-08-03 21:48:53 +0000547GlobalsModRef::getModRefInfo(ImmutableCallSite CS,
Dan Gohmanb2143b62010-09-14 21:25:10 +0000548 const Location &Loc) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000549 unsigned Known = ModRef;
550
551 // If we are asking for mod/ref info of a direct call with a pointer to a
Chris Lattnerfe98f272004-07-27 06:40:37 +0000552 // global we are tracking, return information if we have it.
Dan Gohmanb2143b62010-09-14 21:25:10 +0000553 if (const GlobalValue *GV =
Dan Gohman5034dd32010-12-15 20:02:24 +0000554 dyn_cast<GlobalValue>(GetUnderlyingObject(Loc.Ptr)))
Rafael Espindolabb46f522009-01-15 20:18:42 +0000555 if (GV->hasLocalLinkage())
Dan Gohman79fca6f2010-08-03 21:48:53 +0000556 if (const Function *F = CS.getCalledFunction())
Chris Lattnerfe98f272004-07-27 06:40:37 +0000557 if (NonAddressTakenGlobals.count(GV))
Dan Gohman79fca6f2010-08-03 21:48:53 +0000558 if (const FunctionRecord *FR = getFunctionInfo(F))
Chris Lattnerfe98f272004-07-27 06:40:37 +0000559 Known = FR->getInfoForGlobal(GV);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000560
561 if (Known == NoModRef)
562 return NoModRef; // No need to query other mod/ref analyses
Dan Gohmanb2143b62010-09-14 21:25:10 +0000563 return ModRefResult(Known & AliasAnalysis::getModRefInfo(CS, Loc));
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000564}
565
566
567//===----------------------------------------------------------------------===//
568// Methods to update the analysis as a result of the client transformation.
569//
570void GlobalsModRef::deleteValue(Value *V) {
Chris Lattnerab383582006-10-01 22:36:45 +0000571 if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
572 if (NonAddressTakenGlobals.erase(GV)) {
573 // This global might be an indirect global. If so, remove it and remove
574 // any AllocRelatedValues for it.
575 if (IndirectGlobals.erase(GV)) {
576 // Remove any entries in AllocsForIndirectGlobals for this global.
Dan Gohman79fca6f2010-08-03 21:48:53 +0000577 for (std::map<const Value*, const GlobalValue*>::iterator
Chris Lattnerab383582006-10-01 22:36:45 +0000578 I = AllocsForIndirectGlobals.begin(),
579 E = AllocsForIndirectGlobals.end(); I != E; ) {
580 if (I->second == GV) {
581 AllocsForIndirectGlobals.erase(I++);
582 } else {
583 ++I;
584 }
585 }
586 }
587 }
588 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000589
Chris Lattnerab383582006-10-01 22:36:45 +0000590 // Otherwise, if this is an allocation related to an indirect global, remove
591 // it.
592 AllocsForIndirectGlobals.erase(V);
Duncan Sands9a036b92008-09-03 12:55:42 +0000593
Chris Lattnercd883f22007-11-30 18:52:58 +0000594 AliasAnalysis::deleteValue(V);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000595}
596
597void GlobalsModRef::copyValue(Value *From, Value *To) {
Chris Lattnercd883f22007-11-30 18:52:58 +0000598 AliasAnalysis::copyValue(From, To);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000599}
Owen Anderson392249f2011-01-03 23:51:43 +0000600
601void GlobalsModRef::addEscapingUse(Use &U) {
602 // For the purposes of this analysis, it is conservatively correct to treat
603 // a newly escaping value equivalently to a deleted one. We could perhaps
604 // be more precise by processing the new use and attempting to update our
605 // saved analysis results to accomodate it.
606 deleteValue(U);
607
608 AliasAnalysis::addEscapingUse(U);
609}