blob: c1d8e3e65a624b58e16c692010145dbb69c045ca [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"
Rafael Espindola8f3fabe2012-03-28 21:31:24 +000024#include "llvm/IntrinsicInst.h"
Chris Lattner3b04a8a2004-06-28 06:33:13 +000025#include "llvm/Analysis/AliasAnalysis.h"
26#include "llvm/Analysis/CallGraph.h"
Victor Hernandezf006b182009-10-27 20:05:49 +000027#include "llvm/Analysis/MemoryBuiltins.h"
Dan Gohman5034dd32010-12-15 20:02:24 +000028#include "llvm/Analysis/ValueTracking.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000029#include "llvm/Support/CommandLine.h"
Reid Spencerd7d83db2007-02-05 23:42:17 +000030#include "llvm/Support/InstIterator.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000031#include "llvm/ADT/Statistic.h"
32#include "llvm/ADT/SCCIterator.h"
Chris Lattner3b04a8a2004-06-28 06:33:13 +000033#include <set>
34using namespace llvm;
35
Chris Lattner3b27d682006-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 Lattner3b04a8a2004-06-28 06:33:13 +000043namespace {
Chris Lattnerfe98f272004-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 Lewycky6726b6d2009-10-25 06:33:48 +000048 struct FunctionRecord {
Chris Lattnerfe98f272004-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 Gohman79fca6f2010-08-03 21:48:53 +000052 std::map<const GlobalValue*, unsigned> GlobalInfo;
Chris Lattnerfe98f272004-07-27 06:40:37 +000053
Duncan Sands2bb4a4d2008-09-12 07:29:58 +000054 /// MayReadAnyGlobal - May read global variables, but it is not known which.
55 bool MayReadAnyGlobal;
56
Dan Gohman79fca6f2010-08-03 21:48:53 +000057 unsigned getInfoForGlobal(const GlobalValue *GV) const {
Duncan Sands2bb4a4d2008-09-12 07:29:58 +000058 unsigned Effect = MayReadAnyGlobal ? AliasAnalysis::Ref : 0;
Dan Gohman79fca6f2010-08-03 21:48:53 +000059 std::map<const GlobalValue*, unsigned>::const_iterator I =
60 GlobalInfo.find(GV);
Chris Lattnerfe98f272004-07-27 06:40:37 +000061 if (I != GlobalInfo.end())
Duncan Sands2bb4a4d2008-09-12 07:29:58 +000062 Effect |= I->second;
63 return Effect;
Chris Lattnerfe98f272004-07-27 06:40:37 +000064 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +000065
Chris Lattnerfe98f272004-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 Lattner105d26a2004-07-27 07:46:26 +000069
Duncan Sands2bb4a4d2008-09-12 07:29:58 +000070 FunctionRecord() : MayReadAnyGlobal (false), FunctionEffect(0) {}
Chris Lattnerfe98f272004-07-27 06:40:37 +000071 };
72
73 /// GlobalsModRef - The actual analysis pass.
Nick Lewycky6726b6d2009-10-25 06:33:48 +000074 class GlobalsModRef : public ModulePass, public AliasAnalysis {
Chris Lattnerfe98f272004-07-27 06:40:37 +000075 /// NonAddressTakenGlobals - The globals that do not have their addresses
76 /// taken.
Dan Gohman79fca6f2010-08-03 21:48:53 +000077 std::set<const GlobalValue*> NonAddressTakenGlobals;
Chris Lattner3b04a8a2004-06-28 06:33:13 +000078
Chris Lattnerab383582006-10-01 22:36:45 +000079 /// IndirectGlobals - The memory pointed to by this global is known to be
80 /// 'owned' by the global.
Dan Gohman79fca6f2010-08-03 21:48:53 +000081 std::set<const GlobalValue*> IndirectGlobals;
Duncan Sands9a036b92008-09-03 12:55:42 +000082
Chris Lattnerab383582006-10-01 22:36:45 +000083 /// AllocsForIndirectGlobals - If an instruction allocates memory for an
84 /// indirect global, this map indicates which one.
Dan Gohman79fca6f2010-08-03 21:48:53 +000085 std::map<const Value*, const GlobalValue*> AllocsForIndirectGlobals;
Duncan Sands9a036b92008-09-03 12:55:42 +000086
Chris Lattner3b04a8a2004-06-28 06:33:13 +000087 /// FunctionInfo - For each function, keep track of what globals are
88 /// modified or read.
Dan Gohman79fca6f2010-08-03 21:48:53 +000089 std::map<const Function*, FunctionRecord> FunctionInfo;
Chris Lattner3b04a8a2004-06-28 06:33:13 +000090
91 public:
Devang Patel19974732007-05-03 01:11:54 +000092 static char ID;
Owen Anderson081c34b2010-10-19 17:21:58 +000093 GlobalsModRef() : ModulePass(ID) {
94 initializeGlobalsModRefPass(*PassRegistry::getPassRegistry());
95 }
Devang Patel1cee94f2008-03-18 00:39:19 +000096
Chris Lattnerb12914b2004-09-20 04:48:05 +000097 bool runOnModule(Module &M) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +000098 InitializeAliasAnalysis(this); // set up super class
99 AnalyzeGlobals(M); // find non-addr taken globals
100 AnalyzeCallGraph(getAnalysis<CallGraph>(), M); // Propagate on CG
101 return false;
102 }
103
104 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
105 AliasAnalysis::getAnalysisUsage(AU);
106 AU.addRequired<CallGraph>();
107 AU.setPreservesAll(); // Does not transform code
108 }
109
110 //------------------------------------------------
111 // Implement the AliasAnalysis API
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000112 //
Dan Gohmanb2143b62010-09-14 21:25:10 +0000113 AliasResult alias(const Location &LocA, const Location &LocB);
Dan Gohman79fca6f2010-08-03 21:48:53 +0000114 ModRefResult getModRefInfo(ImmutableCallSite CS,
Dan Gohmanb2143b62010-09-14 21:25:10 +0000115 const Location &Loc);
Dan Gohman79fca6f2010-08-03 21:48:53 +0000116 ModRefResult getModRefInfo(ImmutableCallSite CS1,
117 ImmutableCallSite CS2) {
118 return AliasAnalysis::getModRefInfo(CS1, CS2);
Reid Spencer4a7ebfa2004-12-07 08:11:24 +0000119 }
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000120
Chris Lattner0af024c2004-12-15 07:22:13 +0000121 /// getModRefBehavior - Return the behavior of the specified function if
122 /// called from the specified call site. The call site may be null in which
123 /// case the most generic behavior of this function should be returned.
Dan Gohmana41af342010-08-03 23:08:10 +0000124 ModRefBehavior getModRefBehavior(const Function *F) {
Dan Gohman42c31a72010-11-10 01:02:18 +0000125 ModRefBehavior Min = UnknownModRefBehavior;
126
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +0000127 if (FunctionRecord *FR = getFunctionInfo(F)) {
Chris Lattnerfe98f272004-07-27 06:40:37 +0000128 if (FR->FunctionEffect == 0)
Dan Gohman42c31a72010-11-10 01:02:18 +0000129 Min = DoesNotAccessMemory;
Misha Brukmandedf2bd2005-04-22 04:01:18 +0000130 else if ((FR->FunctionEffect & Mod) == 0)
Dan Gohman42c31a72010-11-10 01:02:18 +0000131 Min = OnlyReadsMemory;
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +0000132 }
Dan Gohman42c31a72010-11-10 01:02:18 +0000133
134 return ModRefBehavior(AliasAnalysis::getModRefBehavior(F) & Min);
Owen Andersone7942202009-02-05 23:36:27 +0000135 }
136
137 /// getModRefBehavior - Return the behavior of the specified function if
138 /// called from the specified call site. The call site may be null in which
139 /// case the most generic behavior of this function should be returned.
Dan Gohmana41af342010-08-03 23:08:10 +0000140 ModRefBehavior getModRefBehavior(ImmutableCallSite CS) {
Dan Gohman42c31a72010-11-10 01:02:18 +0000141 ModRefBehavior Min = UnknownModRefBehavior;
142
143 if (const Function* F = CS.getCalledFunction())
144 if (FunctionRecord *FR = getFunctionInfo(F)) {
145 if (FR->FunctionEffect == 0)
146 Min = DoesNotAccessMemory;
147 else if ((FR->FunctionEffect & Mod) == 0)
148 Min = OnlyReadsMemory;
149 }
150
151 return ModRefBehavior(AliasAnalysis::getModRefBehavior(CS) & Min);
Chris Lattnerfe98f272004-07-27 06:40:37 +0000152 }
Chris Lattnerfe98f272004-07-27 06:40:37 +0000153
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000154 virtual void deleteValue(Value *V);
155 virtual void copyValue(Value *From, Value *To);
Owen Anderson392249f2011-01-03 23:51:43 +0000156 virtual void addEscapingUse(Use &U);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000157
Chris Lattnerfc570e42010-01-20 19:53:32 +0000158 /// getAdjustedAnalysisPointer - This method is used when a pass implements
159 /// an analysis interface through multiple inheritance. If needed, it
160 /// should override this to adjust the this pointer as needed for the
161 /// specified pass info.
Owen Anderson90c579d2010-08-06 18:33:48 +0000162 virtual void *getAdjustedAnalysisPointer(AnalysisID PI) {
163 if (PI == &AliasAnalysis::ID)
Chris Lattnerfc570e42010-01-20 19:53:32 +0000164 return (AliasAnalysis*)this;
165 return this;
166 }
167
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000168 private:
Chris Lattnerfe98f272004-07-27 06:40:37 +0000169 /// getFunctionInfo - Return the function info for the function, or null if
Duncan Sands9a036b92008-09-03 12:55:42 +0000170 /// we don't have anything useful to say about it.
Dan Gohman79fca6f2010-08-03 21:48:53 +0000171 FunctionRecord *getFunctionInfo(const Function *F) {
172 std::map<const Function*, FunctionRecord>::iterator I =
173 FunctionInfo.find(F);
Chris Lattnerfe98f272004-07-27 06:40:37 +0000174 if (I != FunctionInfo.end())
175 return &I->second;
176 return 0;
177 }
178
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000179 void AnalyzeGlobals(Module &M);
180 void AnalyzeCallGraph(CallGraph &CG, Module &M);
Chris Lattnerab383582006-10-01 22:36:45 +0000181 bool AnalyzeUsesOfPointer(Value *V, std::vector<Function*> &Readers,
182 std::vector<Function*> &Writers,
183 GlobalValue *OkayStoreDest = 0);
184 bool AnalyzeIndirectGlobalMemory(GlobalValue *GV);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000185 };
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000186}
187
Dan Gohman844731a2008-05-13 00:00:25 +0000188char GlobalsModRef::ID = 0;
Owen Anderson2ab36d32010-10-12 19:48:12 +0000189INITIALIZE_AG_PASS_BEGIN(GlobalsModRef, AliasAnalysis,
190 "globalsmodref-aa", "Simple mod/ref analysis for globals",
191 false, true, false)
192INITIALIZE_AG_DEPENDENCY(CallGraph)
193INITIALIZE_AG_PASS_END(GlobalsModRef, AliasAnalysis,
Owen Anderson02dd53e2010-08-23 17:52:01 +0000194 "globalsmodref-aa", "Simple mod/ref analysis for globals",
Owen Andersonce665bd2010-10-07 22:25:06 +0000195 false, true, false)
Dan Gohman844731a2008-05-13 00:00:25 +0000196
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000197Pass *llvm::createGlobalsModRefPass() { return new GlobalsModRef(); }
198
Chris Lattnerab383582006-10-01 22:36:45 +0000199/// AnalyzeGlobals - Scan through the users of all of the internal
Duncan Sands9a036b92008-09-03 12:55:42 +0000200/// GlobalValue's in the program. If none of them have their "address taken"
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000201/// (really, their address passed to something nontrivial), record this fact,
202/// and record the functions that they are used directly in.
203void GlobalsModRef::AnalyzeGlobals(Module &M) {
204 std::vector<Function*> Readers, Writers;
205 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
Rafael Espindolabb46f522009-01-15 20:18:42 +0000206 if (I->hasLocalLinkage()) {
Chris Lattnerab383582006-10-01 22:36:45 +0000207 if (!AnalyzeUsesOfPointer(I, Readers, Writers)) {
Chris Lattnerfe98f272004-07-27 06:40:37 +0000208 // Remember that we are tracking this global.
209 NonAddressTakenGlobals.insert(I);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000210 ++NumNonAddrTakenFunctions;
211 }
212 Readers.clear(); Writers.clear();
213 }
214
Chris Lattnerf5eaf3c2005-03-23 23:51:12 +0000215 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
216 I != E; ++I)
Rafael Espindolabb46f522009-01-15 20:18:42 +0000217 if (I->hasLocalLinkage()) {
Chris Lattnerab383582006-10-01 22:36:45 +0000218 if (!AnalyzeUsesOfPointer(I, Readers, Writers)) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000219 // Remember that we are tracking this global, and the mod/ref fns
Chris Lattnerfe98f272004-07-27 06:40:37 +0000220 NonAddressTakenGlobals.insert(I);
Duncan Sands9a036b92008-09-03 12:55:42 +0000221
Chris Lattnerfe98f272004-07-27 06:40:37 +0000222 for (unsigned i = 0, e = Readers.size(); i != e; ++i)
223 FunctionInfo[Readers[i]].GlobalInfo[I] |= Ref;
224
225 if (!I->isConstant()) // No need to keep track of writers to constants
226 for (unsigned i = 0, e = Writers.size(); i != e; ++i)
227 FunctionInfo[Writers[i]].GlobalInfo[I] |= Mod;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000228 ++NumNonAddrTakenGlobalVars;
Duncan Sands9a036b92008-09-03 12:55:42 +0000229
Chris Lattnerab383582006-10-01 22:36:45 +0000230 // If this global holds a pointer type, see if it is an indirect global.
Duncan Sands1df98592010-02-16 11:11:14 +0000231 if (I->getType()->getElementType()->isPointerTy() &&
Chris Lattnerab383582006-10-01 22:36:45 +0000232 AnalyzeIndirectGlobalMemory(I))
233 ++NumIndirectGlobalVars;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000234 }
235 Readers.clear(); Writers.clear();
236 }
237}
238
Chris Lattnerab383582006-10-01 22:36:45 +0000239/// AnalyzeUsesOfPointer - Look at all of the users of the specified pointer.
240/// If this is used by anything complex (i.e., the address escapes), return
241/// true. Also, while we are at it, keep track of those functions that read and
242/// write to the value.
243///
244/// If OkayStoreDest is non-null, stores into this global are allowed.
245bool GlobalsModRef::AnalyzeUsesOfPointer(Value *V,
246 std::vector<Function*> &Readers,
247 std::vector<Function*> &Writers,
248 GlobalValue *OkayStoreDest) {
Duncan Sands1df98592010-02-16 11:11:14 +0000249 if (!V->getType()->isPointerTy()) return true;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000250
Gabor Greifd7cc5212010-07-09 15:53:42 +0000251 for (Value::use_iterator UI = V->use_begin(), E=V->use_end(); UI != E; ++UI) {
252 User *U = *UI;
253 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000254 Readers.push_back(LI->getParent()->getParent());
Gabor Greifd7cc5212010-07-09 15:53:42 +0000255 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000256 if (V == SI->getOperand(1)) {
257 Writers.push_back(SI->getParent()->getParent());
258 } else if (SI->getOperand(1) != OkayStoreDest) {
259 return true; // Storing the pointer
260 }
Gabor Greifd7cc5212010-07-09 15:53:42 +0000261 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000262 if (AnalyzeUsesOfPointer(GEP, Readers, Writers)) return true;
Gabor Greifd7cc5212010-07-09 15:53:42 +0000263 } else if (BitCastInst *BCI = dyn_cast<BitCastInst>(U)) {
Victor Hernandez46e83122009-09-18 21:34:51 +0000264 if (AnalyzeUsesOfPointer(BCI, Readers, Writers, OkayStoreDest))
265 return true;
Gabor Greifd7cc5212010-07-09 15:53:42 +0000266 } else if (isFreeCall(U)) {
267 Writers.push_back(cast<Instruction>(U)->getParent()->getParent());
268 } else if (CallInst *CI = dyn_cast<CallInst>(U)) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000269 // Make sure that this is just the function being called, not that it is
270 // passing into the function.
Bill Wendling22a5b292010-06-07 19:05:06 +0000271 for (unsigned i = 0, e = CI->getNumArgOperands(); i != e; ++i)
272 if (CI->getArgOperand(i) == V) return true;
Gabor Greifd7cc5212010-07-09 15:53:42 +0000273 } else if (InvokeInst *II = dyn_cast<InvokeInst>(U)) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000274 // Make sure that this is just the function being called, not that it is
275 // passing into the function.
Bill Wendling22a5b292010-06-07 19:05:06 +0000276 for (unsigned i = 0, e = II->getNumArgOperands(); i != e; ++i)
277 if (II->getArgOperand(i) == V) return true;
Gabor Greifd7cc5212010-07-09 15:53:42 +0000278 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
Duncan Sands9a036b92008-09-03 12:55:42 +0000279 if (CE->getOpcode() == Instruction::GetElementPtr ||
Reid Spencer3da59db2006-11-27 01:05:10 +0000280 CE->getOpcode() == Instruction::BitCast) {
Chris Lattnerab383582006-10-01 22:36:45 +0000281 if (AnalyzeUsesOfPointer(CE, Readers, Writers))
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000282 return true;
283 } else {
284 return true;
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000285 }
Gabor Greifd7cc5212010-07-09 15:53:42 +0000286 } else if (ICmpInst *ICI = dyn_cast<ICmpInst>(U)) {
Reid Spencere4d87aa2006-12-23 06:05:41 +0000287 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
Chris Lattnerab383582006-10-01 22:36:45 +0000288 return true; // Allow comparison against null.
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000289 } else {
290 return true;
291 }
Gabor Greifd7cc5212010-07-09 15:53:42 +0000292 }
293
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000294 return false;
295}
296
Chris Lattnerab383582006-10-01 22:36:45 +0000297/// AnalyzeIndirectGlobalMemory - We found an non-address-taken global variable
298/// which holds a pointer type. See if the global always points to non-aliased
299/// heap memory: that is, all initializers of the globals are allocations, and
300/// those allocations have no use other than initialization of the global.
301/// Further, all loads out of GV must directly use the memory, not store the
302/// pointer somewhere. If this is true, we consider the memory pointed to by
303/// GV to be owned by GV and can disambiguate other pointers from it.
304bool GlobalsModRef::AnalyzeIndirectGlobalMemory(GlobalValue *GV) {
305 // Keep track of values related to the allocation of the memory, f.e. the
306 // value produced by the malloc call and any casts.
307 std::vector<Value*> AllocRelatedValues;
Duncan Sands9a036b92008-09-03 12:55:42 +0000308
Chris Lattnerab383582006-10-01 22:36:45 +0000309 // Walk the user list of the global. If we find anything other than a direct
310 // load or store, bail out.
311 for (Value::use_iterator I = GV->use_begin(), E = GV->use_end(); I != E; ++I){
Gabor Greif8ba992a2010-07-09 16:22:36 +0000312 User *U = *I;
313 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000314 // The pointer loaded from the global can only be used in simple ways:
315 // we allow addressing of it and loading storing to it. We do *not* allow
316 // storing the loaded pointer somewhere else or passing to a function.
317 std::vector<Function*> ReadersWriters;
318 if (AnalyzeUsesOfPointer(LI, ReadersWriters, ReadersWriters))
319 return false; // Loaded pointer escapes.
320 // TODO: Could try some IP mod/ref of the loaded pointer.
Gabor Greif8ba992a2010-07-09 16:22:36 +0000321 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000322 // Storing the global itself.
323 if (SI->getOperand(0) == GV) return false;
Duncan Sands9a036b92008-09-03 12:55:42 +0000324
Chris Lattnerab383582006-10-01 22:36:45 +0000325 // If storing the null pointer, ignore it.
326 if (isa<ConstantPointerNull>(SI->getOperand(0)))
327 continue;
Duncan Sands9a036b92008-09-03 12:55:42 +0000328
Chris Lattnerab383582006-10-01 22:36:45 +0000329 // Check the value being stored.
Dan Gohman5034dd32010-12-15 20:02:24 +0000330 Value *Ptr = GetUnderlyingObject(SI->getOperand(0));
Chris Lattnerab383582006-10-01 22:36:45 +0000331
Victor Hernandeza276c602009-10-17 01:18:07 +0000332 if (isMalloc(Ptr)) {
Chris Lattnerab383582006-10-01 22:36:45 +0000333 // Okay, easy case.
334 } else if (CallInst *CI = dyn_cast<CallInst>(Ptr)) {
335 Function *F = CI->getCalledFunction();
Reid Spencer5cbf9852007-01-30 20:08:39 +0000336 if (!F || !F->isDeclaration()) return false; // Too hard to analyze.
Chris Lattnerab383582006-10-01 22:36:45 +0000337 if (F->getName() != "calloc") return false; // Not calloc.
338 } else {
339 return false; // Too hard to analyze.
340 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000341
Chris Lattnerab383582006-10-01 22:36:45 +0000342 // Analyze all uses of the allocation. If any of them are used in a
343 // non-simple way (e.g. stored to another global) bail out.
344 std::vector<Function*> ReadersWriters;
345 if (AnalyzeUsesOfPointer(Ptr, ReadersWriters, ReadersWriters, GV))
346 return false; // Loaded pointer escapes.
347
348 // Remember that this allocation is related to the indirect global.
349 AllocRelatedValues.push_back(Ptr);
350 } else {
351 // Something complex, bail out.
352 return false;
353 }
354 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000355
Chris Lattnerab383582006-10-01 22:36:45 +0000356 // Okay, this is an indirect global. Remember all of the allocations for
357 // this global in AllocsForIndirectGlobals.
358 while (!AllocRelatedValues.empty()) {
359 AllocsForIndirectGlobals[AllocRelatedValues.back()] = GV;
360 AllocRelatedValues.pop_back();
361 }
362 IndirectGlobals.insert(GV);
363 return true;
364}
365
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000366/// AnalyzeCallGraph - At this point, we know the functions where globals are
367/// immediately stored to and read from. Propagate this information up the call
Chris Lattnerfe98f272004-07-27 06:40:37 +0000368/// graph to all callers and compute the mod/ref info for all memory for each
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000369/// function.
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000370void GlobalsModRef::AnalyzeCallGraph(CallGraph &CG, Module &M) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000371 // We do a bottom-up SCC traversal of the call graph. In other words, we
372 // visit all callees before callers (leaf-first).
Duncan Sands9a036b92008-09-03 12:55:42 +0000373 for (scc_iterator<CallGraph*> I = scc_begin(&CG), E = scc_end(&CG); I != E;
374 ++I) {
375 std::vector<CallGraphNode *> &SCC = *I;
Duncan Sandsf423abc2008-09-04 19:16:20 +0000376 assert(!SCC.empty() && "SCC with no functions?");
Duncan Sands9a036b92008-09-03 12:55:42 +0000377
Duncan Sandsf423abc2008-09-04 19:16:20 +0000378 if (!SCC[0]->getFunction()) {
379 // Calls externally - can't say anything useful. Remove any existing
380 // function records (may have been created when scanning globals).
381 for (unsigned i = 0, e = SCC.size(); i != e; ++i)
382 FunctionInfo.erase(SCC[i]->getFunction());
Duncan Sands9a036b92008-09-03 12:55:42 +0000383 continue;
Duncan Sandsf423abc2008-09-04 19:16:20 +0000384 }
385
386 FunctionRecord &FR = FunctionInfo[SCC[0]->getFunction()];
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000387
Duncan Sands9a036b92008-09-03 12:55:42 +0000388 bool KnowNothing = false;
389 unsigned FunctionEffect = 0;
Chris Lattnerfe98f272004-07-27 06:40:37 +0000390
Duncan Sands9a036b92008-09-03 12:55:42 +0000391 // Collect the mod/ref properties due to called functions. We only compute
392 // one mod-ref set.
393 for (unsigned i = 0, e = SCC.size(); i != e && !KnowNothing; ++i) {
394 Function *F = SCC[i]->getFunction();
395 if (!F) {
396 KnowNothing = true;
Chris Lattnerfe98f272004-07-27 06:40:37 +0000397 break;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000398 }
Chris Lattnerfe98f272004-07-27 06:40:37 +0000399
Duncan Sands9a036b92008-09-03 12:55:42 +0000400 if (F->isDeclaration()) {
401 // Try to get mod/ref behaviour from function attributes.
Duncan Sandsd0ac3732008-09-03 15:31:24 +0000402 if (F->doesNotAccessMemory()) {
403 // Can't do better than that!
404 } else if (F->onlyReadsMemory()) {
Duncan Sands9a036b92008-09-03 12:55:42 +0000405 FunctionEffect |= Ref;
Duncan Sands2bb4a4d2008-09-12 07:29:58 +0000406 if (!F->isIntrinsic())
Duncan Sands1abe60b2008-09-11 15:43:12 +0000407 // This function might call back into the module and read a global -
Duncan Sands2bb4a4d2008-09-12 07:29:58 +0000408 // consider every global as possibly being read by this function.
409 FR.MayReadAnyGlobal = true;
Duncan Sandsd0ac3732008-09-03 15:31:24 +0000410 } else {
Duncan Sands892b8402008-09-11 19:35:55 +0000411 FunctionEffect |= ModRef;
412 // Can't say anything useful unless it's an intrinsic - they don't
413 // read or write global variables of the kind considered here.
414 KnowNothing = !F->isIntrinsic();
Duncan Sands9a036b92008-09-03 12:55:42 +0000415 }
416 continue;
417 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000418
Duncan Sands9a036b92008-09-03 12:55:42 +0000419 for (CallGraphNode::iterator CI = SCC[i]->begin(), E = SCC[i]->end();
Duncan Sandsf423abc2008-09-04 19:16:20 +0000420 CI != E && !KnowNothing; ++CI)
Duncan Sands9a036b92008-09-03 12:55:42 +0000421 if (Function *Callee = CI->second->getFunction()) {
422 if (FunctionRecord *CalleeFR = getFunctionInfo(Callee)) {
423 // Propagate function effect up.
424 FunctionEffect |= CalleeFR->FunctionEffect;
425
426 // Incorporate callee's effects on globals into our info.
Dan Gohman79fca6f2010-08-03 21:48:53 +0000427 for (std::map<const GlobalValue*, unsigned>::iterator GI =
Duncan Sands9a036b92008-09-03 12:55:42 +0000428 CalleeFR->GlobalInfo.begin(), E = CalleeFR->GlobalInfo.end();
429 GI != E; ++GI)
Duncan Sandsf423abc2008-09-04 19:16:20 +0000430 FR.GlobalInfo[GI->first] |= GI->second;
Duncan Sands2bb4a4d2008-09-12 07:29:58 +0000431 FR.MayReadAnyGlobal |= CalleeFR->MayReadAnyGlobal;
Duncan Sands9a036b92008-09-03 12:55:42 +0000432 } else {
433 // Can't say anything about it. However, if it is inside our SCC,
434 // then nothing needs to be done.
435 CallGraphNode *CalleeNode = CG[Callee];
436 if (std::find(SCC.begin(), SCC.end(), CalleeNode) == SCC.end())
437 KnowNothing = true;
438 }
439 } else {
440 KnowNothing = true;
441 }
442 }
443
444 // If we can't say anything useful about this SCC, remove all SCC functions
445 // from the FunctionInfo map.
446 if (KnowNothing) {
447 for (unsigned i = 0, e = SCC.size(); i != e; ++i)
448 FunctionInfo.erase(SCC[i]->getFunction());
Duncan Sandsb070bee2008-09-03 16:10:55 +0000449 continue;
Duncan Sands9a036b92008-09-03 12:55:42 +0000450 }
451
452 // Scan the function bodies for explicit loads or stores.
Chris Lattnerfe98f272004-07-27 06:40:37 +0000453 for (unsigned i = 0, e = SCC.size(); i != e && FunctionEffect != ModRef;++i)
454 for (inst_iterator II = inst_begin(SCC[i]->getFunction()),
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000455 E = inst_end(SCC[i]->getFunction());
Chris Lattnerfe98f272004-07-27 06:40:37 +0000456 II != E && FunctionEffect != ModRef; ++II)
Duncan Sandsb8ca4ff2008-09-13 12:45:50 +0000457 if (isa<LoadInst>(*II)) {
Chris Lattnerfe98f272004-07-27 06:40:37 +0000458 FunctionEffect |= Ref;
Duncan Sandsb8ca4ff2008-09-13 12:45:50 +0000459 if (cast<LoadInst>(*II).isVolatile())
460 // Volatile loads may have side-effects, so mark them as writing
461 // memory (for example, a flag inside the processor).
462 FunctionEffect |= Mod;
463 } else if (isa<StoreInst>(*II)) {
Chris Lattnerfe98f272004-07-27 06:40:37 +0000464 FunctionEffect |= Mod;
Duncan Sandsb8ca4ff2008-09-13 12:45:50 +0000465 if (cast<StoreInst>(*II).isVolatile())
466 // Treat volatile stores as reading memory somewhere.
467 FunctionEffect |= Ref;
Victor Hernandez046e78c2009-10-26 23:43:48 +0000468 } else if (isMalloc(&cast<Instruction>(*II)) ||
Victor Hernandez66284e02009-10-24 04:23:03 +0000469 isFreeCall(&cast<Instruction>(*II))) {
Chris Lattner3fe4d3c2005-04-22 05:36:59 +0000470 FunctionEffect |= ModRef;
Rafael Espindola8f3fabe2012-03-28 21:31:24 +0000471 } else if (IntrinsicInst *Intrinsic = dyn_cast<IntrinsicInst>(&*II)) {
472 // The callgraph doesn't include intrinsic calls.
473 Function *Callee = Intrinsic->getCalledFunction();
474 ModRefBehavior Behaviour = AliasAnalysis::getModRefBehavior(Callee);
475 FunctionEffect |= (Behaviour & ModRef);
Duncan Sandsb8ca4ff2008-09-13 12:45:50 +0000476 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000477
478 if ((FunctionEffect & Mod) == 0)
479 ++NumReadMemFunctions;
480 if (FunctionEffect == 0)
481 ++NumNoMemFunctions;
Duncan Sandsf423abc2008-09-04 19:16:20 +0000482 FR.FunctionEffect = FunctionEffect;
Duncan Sands9a036b92008-09-03 12:55:42 +0000483
484 // Finally, now that we know the full effect on this SCC, clone the
485 // information to each function in the SCC.
486 for (unsigned i = 1, e = SCC.size(); i != e; ++i)
Duncan Sandsf423abc2008-09-04 19:16:20 +0000487 FunctionInfo[SCC[i]->getFunction()] = FR;
Chris Lattnerfe98f272004-07-27 06:40:37 +0000488 }
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000489}
490
491
492
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000493/// alias - If one of the pointers is to a global that we are tracking, and the
494/// other is some random pointer, we know there cannot be an alias, because the
495/// address of the global isn't taken.
496AliasAnalysis::AliasResult
Dan Gohmanb2143b62010-09-14 21:25:10 +0000497GlobalsModRef::alias(const Location &LocA,
498 const Location &LocB) {
Chris Lattnerab383582006-10-01 22:36:45 +0000499 // Get the base object these pointers point to.
Dan Gohman5034dd32010-12-15 20:02:24 +0000500 const Value *UV1 = GetUnderlyingObject(LocA.Ptr);
501 const Value *UV2 = GetUnderlyingObject(LocB.Ptr);
Duncan Sands9a036b92008-09-03 12:55:42 +0000502
Chris Lattnerab383582006-10-01 22:36:45 +0000503 // If either of the underlying values is a global, they may be non-addr-taken
504 // globals, which we can answer queries about.
Dan Gohman79fca6f2010-08-03 21:48:53 +0000505 const GlobalValue *GV1 = dyn_cast<GlobalValue>(UV1);
506 const GlobalValue *GV2 = dyn_cast<GlobalValue>(UV2);
Chris Lattnerab383582006-10-01 22:36:45 +0000507 if (GV1 || GV2) {
508 // If the global's address is taken, pretend we don't know it's a pointer to
509 // the global.
510 if (GV1 && !NonAddressTakenGlobals.count(GV1)) GV1 = 0;
511 if (GV2 && !NonAddressTakenGlobals.count(GV2)) GV2 = 0;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000512
Dan Gohmanf451cb82010-02-10 16:03:48 +0000513 // If the two pointers are derived from two different non-addr-taken
Chris Lattnerab383582006-10-01 22:36:45 +0000514 // globals, or if one is and the other isn't, we know these can't alias.
515 if ((GV1 || GV2) && GV1 != GV2)
516 return NoAlias;
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000517
Chris Lattnerab383582006-10-01 22:36:45 +0000518 // Otherwise if they are both derived from the same addr-taken global, we
519 // can't know the two accesses don't overlap.
520 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000521
Chris Lattnerab383582006-10-01 22:36:45 +0000522 // These pointers may be based on the memory owned by an indirect global. If
523 // so, we may be able to handle this. First check to see if the base pointer
524 // is a direct load from an indirect global.
525 GV1 = GV2 = 0;
Dan Gohman79fca6f2010-08-03 21:48:53 +0000526 if (const LoadInst *LI = dyn_cast<LoadInst>(UV1))
Chris Lattnerab383582006-10-01 22:36:45 +0000527 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getOperand(0)))
528 if (IndirectGlobals.count(GV))
529 GV1 = GV;
Dan Gohman79fca6f2010-08-03 21:48:53 +0000530 if (const LoadInst *LI = dyn_cast<LoadInst>(UV2))
531 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getOperand(0)))
Chris Lattnerab383582006-10-01 22:36:45 +0000532 if (IndirectGlobals.count(GV))
533 GV2 = GV;
Duncan Sands9a036b92008-09-03 12:55:42 +0000534
Chris Lattnerab383582006-10-01 22:36:45 +0000535 // These pointers may also be from an allocation for the indirect global. If
536 // so, also handle them.
537 if (AllocsForIndirectGlobals.count(UV1))
538 GV1 = AllocsForIndirectGlobals[UV1];
539 if (AllocsForIndirectGlobals.count(UV2))
540 GV2 = AllocsForIndirectGlobals[UV2];
Duncan Sands9a036b92008-09-03 12:55:42 +0000541
Chris Lattnerab383582006-10-01 22:36:45 +0000542 // Now that we know whether the two pointers are related to indirect globals,
543 // use this to disambiguate the pointers. If either pointer is based on an
544 // indirect global and if they are not both based on the same indirect global,
545 // they cannot alias.
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000546 if ((GV1 || GV2) && GV1 != GV2)
547 return NoAlias;
Duncan Sands9a036b92008-09-03 12:55:42 +0000548
Dan Gohmanb2143b62010-09-14 21:25:10 +0000549 return AliasAnalysis::alias(LocA, LocB);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000550}
551
552AliasAnalysis::ModRefResult
Dan Gohman79fca6f2010-08-03 21:48:53 +0000553GlobalsModRef::getModRefInfo(ImmutableCallSite CS,
Dan Gohmanb2143b62010-09-14 21:25:10 +0000554 const Location &Loc) {
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000555 unsigned Known = ModRef;
556
557 // If we are asking for mod/ref info of a direct call with a pointer to a
Chris Lattnerfe98f272004-07-27 06:40:37 +0000558 // global we are tracking, return information if we have it.
Dan Gohmanb2143b62010-09-14 21:25:10 +0000559 if (const GlobalValue *GV =
Dan Gohman5034dd32010-12-15 20:02:24 +0000560 dyn_cast<GlobalValue>(GetUnderlyingObject(Loc.Ptr)))
Rafael Espindolabb46f522009-01-15 20:18:42 +0000561 if (GV->hasLocalLinkage())
Dan Gohman79fca6f2010-08-03 21:48:53 +0000562 if (const Function *F = CS.getCalledFunction())
Chris Lattnerfe98f272004-07-27 06:40:37 +0000563 if (NonAddressTakenGlobals.count(GV))
Dan Gohman79fca6f2010-08-03 21:48:53 +0000564 if (const FunctionRecord *FR = getFunctionInfo(F))
Chris Lattnerfe98f272004-07-27 06:40:37 +0000565 Known = FR->getInfoForGlobal(GV);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000566
567 if (Known == NoModRef)
568 return NoModRef; // No need to query other mod/ref analyses
Dan Gohmanb2143b62010-09-14 21:25:10 +0000569 return ModRefResult(Known & AliasAnalysis::getModRefInfo(CS, Loc));
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000570}
571
572
573//===----------------------------------------------------------------------===//
574// Methods to update the analysis as a result of the client transformation.
575//
576void GlobalsModRef::deleteValue(Value *V) {
Chris Lattnerab383582006-10-01 22:36:45 +0000577 if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
578 if (NonAddressTakenGlobals.erase(GV)) {
579 // This global might be an indirect global. If so, remove it and remove
580 // any AllocRelatedValues for it.
581 if (IndirectGlobals.erase(GV)) {
582 // Remove any entries in AllocsForIndirectGlobals for this global.
Dan Gohman79fca6f2010-08-03 21:48:53 +0000583 for (std::map<const Value*, const GlobalValue*>::iterator
Chris Lattnerab383582006-10-01 22:36:45 +0000584 I = AllocsForIndirectGlobals.begin(),
585 E = AllocsForIndirectGlobals.end(); I != E; ) {
586 if (I->second == GV) {
587 AllocsForIndirectGlobals.erase(I++);
588 } else {
589 ++I;
590 }
591 }
592 }
593 }
594 }
Duncan Sands9a036b92008-09-03 12:55:42 +0000595
Chris Lattnerab383582006-10-01 22:36:45 +0000596 // Otherwise, if this is an allocation related to an indirect global, remove
597 // it.
598 AllocsForIndirectGlobals.erase(V);
Duncan Sands9a036b92008-09-03 12:55:42 +0000599
Chris Lattnercd883f22007-11-30 18:52:58 +0000600 AliasAnalysis::deleteValue(V);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000601}
602
603void GlobalsModRef::copyValue(Value *From, Value *To) {
Chris Lattnercd883f22007-11-30 18:52:58 +0000604 AliasAnalysis::copyValue(From, To);
Chris Lattner3b04a8a2004-06-28 06:33:13 +0000605}
Owen Anderson392249f2011-01-03 23:51:43 +0000606
607void GlobalsModRef::addEscapingUse(Use &U) {
608 // For the purposes of this analysis, it is conservatively correct to treat
609 // a newly escaping value equivalently to a deleted one. We could perhaps
610 // be more precise by processing the new use and attempting to update our
Chris Lattner7a2bdde2011-04-15 05:18:47 +0000611 // saved analysis results to accommodate it.
Owen Anderson392249f2011-01-03 23:51:43 +0000612 deleteValue(U);
613
614 AliasAnalysis::addEscapingUse(U);
615}