blob: 1accb4647e7fc4a14c3f6621670a3f9907170f42 [file] [log] [blame]
Chris Lattner26dff502004-06-28 06:33:13 +00001//===- GlobalsModRef.cpp - Simple Mod/Ref Analysis for Globals ------------===//
Misha Brukman01808ca2005-04-21 21:13:18 +00002//
Chris Lattner26dff502004-06-28 06:33:13 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman01808ca2005-04-21 21:13:18 +00007//
Chris Lattner26dff502004-06-28 06:33:13 +00008//===----------------------------------------------------------------------===//
9//
10// This simple pass provides alias and mod/ref information for global values
Chris Lattner3a353e82004-07-27 06:40:37 +000011// that do not have their address taken, and keeps track of whether functions
12// read or write memory (are "pure"). For this simple (but very common) case,
13// we can provide pretty accurate and useful information.
Chris Lattner26dff502004-06-28 06:33:13 +000014//
15//===----------------------------------------------------------------------===//
16
Chris Lattner26dff502004-06-28 06:33:13 +000017#include "llvm/Analysis/Passes.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000018#include "llvm/ADT/SCCIterator.h"
Chandler Carruthf3af4af2015-07-22 11:47:54 +000019#include "llvm/ADT/SmallPtrSet.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000020#include "llvm/ADT/Statistic.h"
Chris Lattner26dff502004-06-28 06:33:13 +000021#include "llvm/Analysis/AliasAnalysis.h"
22#include "llvm/Analysis/CallGraph.h"
Victor Hernandezf390e042009-10-27 20:05:49 +000023#include "llvm/Analysis/MemoryBuiltins.h"
Dan Gohmana4fcd242010-12-15 20:02:24 +000024#include "llvm/Analysis/ValueTracking.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000025#include "llvm/IR/Constants.h"
26#include "llvm/IR/DerivedTypes.h"
Chandler Carruth83948572014-03-04 10:30:26 +000027#include "llvm/IR/InstIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000028#include "llvm/IR/Instructions.h"
29#include "llvm/IR/IntrinsicInst.h"
30#include "llvm/IR/Module.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000031#include "llvm/Pass.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000032#include "llvm/Support/CommandLine.h"
Chandler Carruthda7c1912015-07-22 09:27:58 +000033#include <list>
Chris Lattner26dff502004-06-28 06:33:13 +000034using namespace llvm;
35
Chandler Carruthf1221bd2014-04-22 02:48:03 +000036#define DEBUG_TYPE "globalsmodref-aa"
37
Chris Lattner57ef9422006-12-19 22:30:33 +000038STATISTIC(NumNonAddrTakenGlobalVars,
39 "Number of global vars without address taken");
40STATISTIC(NumNonAddrTakenFunctions,"Number of functions without address taken");
41STATISTIC(NumNoMemFunctions, "Number of functions that do not access memory");
42STATISTIC(NumReadMemFunctions, "Number of functions that only read memory");
43STATISTIC(NumIndirectGlobalVars, "Number of indirect global objects");
44
Chandler Carruthf55803f2015-07-17 06:58:24 +000045// An option to enable unsafe alias results from the GlobalsModRef analysis.
46// When enabled, GlobalsModRef will provide no-alias results which in extremely
47// rare cases may not be conservatively correct. In particular, in the face of
48// transforms which cause assymetry between how effective GetUnderlyingObject
49// is for two pointers, it may produce incorrect results.
50//
51// These unsafe results have been returned by GMR for many years without
52// causing significant issues in the wild and so we provide a mechanism to
53// re-enable them for users of LLVM that have a particular performance
54// sensitivity and no known issues. The option also makes it easy to evaluate
55// the performance impact of these results.
56static cl::opt<bool> EnableUnsafeGlobalsModRefAliasResults(
57 "enable-unsafe-globalsmodref-alias-results", cl::init(false), cl::Hidden);
58
Chris Lattner26dff502004-06-28 06:33:13 +000059namespace {
Chandler Carruth466d7ad2015-07-14 08:42:39 +000060/// FunctionRecord - One instance of this structure is stored for every
61/// function in the program. Later, the entries for these functions are
62/// removed if the function is found to call an external function (in which
63/// case we know nothing about it.
64struct FunctionRecord {
65 /// GlobalInfo - Maintain mod/ref info for all of the globals without
66 /// addresses taken that are read or written (transitively) by this
67 /// function.
68 std::map<const GlobalValue *, unsigned> GlobalInfo;
Chris Lattner3a353e82004-07-27 06:40:37 +000069
Chandler Carruth466d7ad2015-07-14 08:42:39 +000070 /// MayReadAnyGlobal - May read global variables, but it is not known which.
71 bool MayReadAnyGlobal;
Duncan Sands06dbb122008-09-12 07:29:58 +000072
Chandler Carruth466d7ad2015-07-14 08:42:39 +000073 unsigned getInfoForGlobal(const GlobalValue *GV) const {
Chandler Carruth194f59c2015-07-22 23:15:57 +000074 unsigned Effect = MayReadAnyGlobal ? MRI_Ref : 0;
Chandler Carruth466d7ad2015-07-14 08:42:39 +000075 std::map<const GlobalValue *, unsigned>::const_iterator I =
Dan Gohman5442c712010-08-03 21:48:53 +000076 GlobalInfo.find(GV);
Chandler Carruth466d7ad2015-07-14 08:42:39 +000077 if (I != GlobalInfo.end())
78 Effect |= I->second;
79 return Effect;
80 }
81
82 /// FunctionEffect - Capture whether or not this function reads or writes to
83 /// ANY memory. If not, we can do a lot of aggressive analysis on it.
84 unsigned FunctionEffect;
85
86 FunctionRecord() : MayReadAnyGlobal(false), FunctionEffect(0) {}
87};
88
89/// GlobalsModRef - The actual analysis pass.
90class GlobalsModRef : public ModulePass, public AliasAnalysis {
Chandler Carruthda7c1912015-07-22 09:27:58 +000091 /// The globals that do not have their addresses taken.
Chandler Carruthf3af4af2015-07-22 11:47:54 +000092 SmallPtrSet<const GlobalValue *, 8> NonAddressTakenGlobals;
Chandler Carruth466d7ad2015-07-14 08:42:39 +000093
94 /// IndirectGlobals - The memory pointed to by this global is known to be
95 /// 'owned' by the global.
Chandler Carruthf3af4af2015-07-22 11:47:54 +000096 SmallPtrSet<const GlobalValue *, 8> IndirectGlobals;
Chandler Carruth466d7ad2015-07-14 08:42:39 +000097
98 /// AllocsForIndirectGlobals - If an instruction allocates memory for an
99 /// indirect global, this map indicates which one.
Chandler Carruth69192672015-07-22 11:36:09 +0000100 DenseMap<const Value *, const GlobalValue *> AllocsForIndirectGlobals;
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000101
102 /// FunctionInfo - For each function, keep track of what globals are
103 /// modified or read.
Chandler Carruth61ddab62015-07-22 22:32:34 +0000104 DenseMap<const Function *, FunctionRecord> FunctionInfo;
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000105
Chandler Carruthda7c1912015-07-22 09:27:58 +0000106 /// Handle to clear this analysis on deletion of values.
Chandler Carruth8f1b63e2015-07-22 11:10:41 +0000107 struct DeletionCallbackHandle final : CallbackVH {
108 GlobalsModRef &GMR;
109 std::list<DeletionCallbackHandle>::iterator I;
110
111 DeletionCallbackHandle(GlobalsModRef &GMR, Value *V)
112 : CallbackVH(V), GMR(GMR) {}
113
114 void deleted() override {
115 Value *V = getValPtr();
116 if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
117 if (GMR.NonAddressTakenGlobals.erase(GV)) {
118 // This global might be an indirect global. If so, remove it and
119 // remove
120 // any AllocRelatedValues for it.
121 if (GMR.IndirectGlobals.erase(GV)) {
122 // Remove any entries in AllocsForIndirectGlobals for this global.
Chandler Carruth69192672015-07-22 11:36:09 +0000123 for (auto I = GMR.AllocsForIndirectGlobals.begin(),
124 E = GMR.AllocsForIndirectGlobals.end();
125 I != E; ++I)
126 if (I->second == GV)
127 GMR.AllocsForIndirectGlobals.erase(I);
Chandler Carruth8f1b63e2015-07-22 11:10:41 +0000128 }
129 }
130 }
131
132 // If this is an allocation related to an indirect global, remove it.
133 GMR.AllocsForIndirectGlobals.erase(V);
134
135 // And clear out the handle.
136 setValPtr(nullptr);
137 GMR.Handles.erase(I);
138 // This object is now destroyed!
139 }
140 };
Chandler Carruthda7c1912015-07-22 09:27:58 +0000141
142 /// List of callbacks for globals being tracked by this analysis. Note that
143 /// these objects are quite large, but we only anticipate having one per
144 /// global tracked by this analysis. There are numerous optimizations we
145 /// could perform to the memory utilization here if this becomes a problem.
146 std::list<DeletionCallbackHandle> Handles;
147
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000148public:
149 static char ID;
150 GlobalsModRef() : ModulePass(ID) {
151 initializeGlobalsModRefPass(*PassRegistry::getPassRegistry());
152 }
153
154 bool runOnModule(Module &M) override {
155 InitializeAliasAnalysis(this, &M.getDataLayout());
156
157 // Find non-addr taken globals.
158 AnalyzeGlobals(M);
159
160 // Propagate on CG.
161 AnalyzeCallGraph(getAnalysis<CallGraphWrapperPass>().getCallGraph(), M);
162 return false;
163 }
164
165 void getAnalysisUsage(AnalysisUsage &AU) const override {
166 AliasAnalysis::getAnalysisUsage(AU);
167 AU.addRequired<CallGraphWrapperPass>();
168 AU.setPreservesAll(); // Does not transform code
169 }
170
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000171 /// getAdjustedAnalysisPointer - This method is used when a pass implements
172 /// an analysis interface through multiple inheritance. If needed, it
173 /// should override this to adjust the this pointer as needed for the
174 /// specified pass info.
175 void *getAdjustedAnalysisPointer(AnalysisID PI) override {
176 if (PI == &AliasAnalysis::ID)
177 return (AliasAnalysis *)this;
178 return this;
179 }
Chris Lattner3a353e82004-07-27 06:40:37 +0000180
Chandler Carruth194f59c2015-07-22 23:15:57 +0000181 //------------------------------------------------
182 // Implement the AliasAnalysis API
183 //
184 AliasResult alias(const MemoryLocation &LocA,
185 const MemoryLocation &LocB) override;
186 ModRefInfo getModRefInfo(ImmutableCallSite CS,
187 const MemoryLocation &Loc) override;
188 ModRefInfo getModRefInfo(ImmutableCallSite CS1,
189 ImmutableCallSite CS2) override {
190 return AliasAnalysis::getModRefInfo(CS1, CS2);
191 }
192
193 /// getModRefBehavior - Return the behavior of the specified function if
194 /// called from the specified call site. The call site may be null in which
195 /// case the most generic behavior of this function should be returned.
196 FunctionModRefBehavior getModRefBehavior(const Function *F) override {
197 FunctionModRefBehavior Min = FMRB_UnknownModRefBehavior;
198
199 if (FunctionRecord *FR = getFunctionInfo(F)) {
200 if (FR->FunctionEffect == 0)
201 Min = FMRB_DoesNotAccessMemory;
202 else if ((FR->FunctionEffect & MRI_Mod) == 0)
203 Min = FMRB_OnlyReadsMemory;
204 }
205
206 return FunctionModRefBehavior(AliasAnalysis::getModRefBehavior(F) & Min);
207 }
208
209 /// getModRefBehavior - Return the behavior of the specified function if
210 /// called from the specified call site. The call site may be null in which
211 /// case the most generic behavior of this function should be returned.
212 FunctionModRefBehavior getModRefBehavior(ImmutableCallSite CS) override {
213 FunctionModRefBehavior Min = FMRB_UnknownModRefBehavior;
214
215 if (const Function *F = CS.getCalledFunction())
216 if (FunctionRecord *FR = getFunctionInfo(F)) {
217 if (FR->FunctionEffect == 0)
218 Min = FMRB_DoesNotAccessMemory;
219 else if ((FR->FunctionEffect & MRI_Mod) == 0)
220 Min = FMRB_OnlyReadsMemory;
221 }
222
223 return FunctionModRefBehavior(AliasAnalysis::getModRefBehavior(CS) & Min);
224 }
225
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000226private:
227 /// getFunctionInfo - Return the function info for the function, or null if
228 /// we don't have anything useful to say about it.
229 FunctionRecord *getFunctionInfo(const Function *F) {
Chandler Carruth61ddab62015-07-22 22:32:34 +0000230 auto I = FunctionInfo.find(F);
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000231 if (I != FunctionInfo.end())
232 return &I->second;
233 return nullptr;
234 }
Chris Lattner3a353e82004-07-27 06:40:37 +0000235
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000236 void AnalyzeGlobals(Module &M);
237 void AnalyzeCallGraph(CallGraph &CG, Module &M);
Chandler Carruth4cef26e2015-07-22 22:10:05 +0000238 bool AnalyzeUsesOfPointer(Value *V,
239 SmallPtrSetImpl<Function *> *Readers = nullptr,
240 SmallPtrSetImpl<Function *> *Writers = nullptr,
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000241 GlobalValue *OkayStoreDest = nullptr);
242 bool AnalyzeIndirectGlobalMemory(GlobalValue *GV);
243};
Alexander Kornienkof00654e2015-06-23 09:49:53 +0000244}
Chris Lattner26dff502004-06-28 06:33:13 +0000245
Dan Gohmand78c4002008-05-13 00:00:25 +0000246char GlobalsModRef::ID = 0;
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000247INITIALIZE_AG_PASS_BEGIN(GlobalsModRef, AliasAnalysis, "globalsmodref-aa",
248 "Simple mod/ref analysis for globals", false, true,
249 false)
Chandler Carruth6378cf52013-11-26 04:19:30 +0000250INITIALIZE_PASS_DEPENDENCY(CallGraphWrapperPass)
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000251INITIALIZE_AG_PASS_END(GlobalsModRef, AliasAnalysis, "globalsmodref-aa",
252 "Simple mod/ref analysis for globals", false, true,
253 false)
Dan Gohmand78c4002008-05-13 00:00:25 +0000254
Chris Lattner26dff502004-06-28 06:33:13 +0000255Pass *llvm::createGlobalsModRefPass() { return new GlobalsModRef(); }
256
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000257/// AnalyzeGlobals - Scan through the users of all of the internal
Duncan Sands42c644e2008-09-03 12:55:42 +0000258/// GlobalValue's in the program. If none of them have their "address taken"
Chris Lattner26dff502004-06-28 06:33:13 +0000259/// (really, their address passed to something nontrivial), record this fact,
260/// and record the functions that they are used directly in.
261void GlobalsModRef::AnalyzeGlobals(Module &M) {
Chandler Carrutha033bbb2015-07-15 08:09:23 +0000262 for (Function &F : M)
Chandler Carruth4cef26e2015-07-22 22:10:05 +0000263 if (F.hasLocalLinkage())
264 if (!AnalyzeUsesOfPointer(&F)) {
Chris Lattner3a353e82004-07-27 06:40:37 +0000265 // Remember that we are tracking this global.
Chandler Carrutha033bbb2015-07-15 08:09:23 +0000266 NonAddressTakenGlobals.insert(&F);
Chandler Carruthda7c1912015-07-22 09:27:58 +0000267 Handles.emplace_front(*this, &F);
268 Handles.front().I = Handles.begin();
Chris Lattner26dff502004-06-28 06:33:13 +0000269 ++NumNonAddrTakenFunctions;
270 }
Chris Lattner26dff502004-06-28 06:33:13 +0000271
Chandler Carruth4cef26e2015-07-22 22:10:05 +0000272 SmallPtrSet<Function *, 64> Readers, Writers;
Chandler Carrutha033bbb2015-07-15 08:09:23 +0000273 for (GlobalVariable &GV : M.globals())
274 if (GV.hasLocalLinkage()) {
Chandler Carruth4cef26e2015-07-22 22:10:05 +0000275 if (!AnalyzeUsesOfPointer(&GV, &Readers,
276 GV.isConstant() ? nullptr : &Writers)) {
Chris Lattner26dff502004-06-28 06:33:13 +0000277 // Remember that we are tracking this global, and the mod/ref fns
Chandler Carrutha033bbb2015-07-15 08:09:23 +0000278 NonAddressTakenGlobals.insert(&GV);
Chandler Carruthda7c1912015-07-22 09:27:58 +0000279 Handles.emplace_front(*this, &GV);
280 Handles.front().I = Handles.begin();
Duncan Sands42c644e2008-09-03 12:55:42 +0000281
Chandler Carrutha033bbb2015-07-15 08:09:23 +0000282 for (Function *Reader : Readers)
Chandler Carruth194f59c2015-07-22 23:15:57 +0000283 FunctionInfo[Reader].GlobalInfo[&GV] |= MRI_Ref;
Chris Lattner3a353e82004-07-27 06:40:37 +0000284
Chandler Carrutha033bbb2015-07-15 08:09:23 +0000285 if (!GV.isConstant()) // No need to keep track of writers to constants
286 for (Function *Writer : Writers)
Chandler Carruth194f59c2015-07-22 23:15:57 +0000287 FunctionInfo[Writer].GlobalInfo[&GV] |= MRI_Mod;
Chris Lattner26dff502004-06-28 06:33:13 +0000288 ++NumNonAddrTakenGlobalVars;
Duncan Sands42c644e2008-09-03 12:55:42 +0000289
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000290 // If this global holds a pointer type, see if it is an indirect global.
Chandler Carrutha033bbb2015-07-15 08:09:23 +0000291 if (GV.getType()->getElementType()->isPointerTy() &&
292 AnalyzeIndirectGlobalMemory(&GV))
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000293 ++NumIndirectGlobalVars;
Chris Lattner26dff502004-06-28 06:33:13 +0000294 }
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000295 Readers.clear();
296 Writers.clear();
Chris Lattner26dff502004-06-28 06:33:13 +0000297 }
298}
299
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000300/// AnalyzeUsesOfPointer - Look at all of the users of the specified pointer.
301/// If this is used by anything complex (i.e., the address escapes), return
302/// true. Also, while we are at it, keep track of those functions that read and
303/// write to the value.
304///
305/// If OkayStoreDest is non-null, stores into this global are allowed.
306bool GlobalsModRef::AnalyzeUsesOfPointer(Value *V,
Chandler Carruth4cef26e2015-07-22 22:10:05 +0000307 SmallPtrSetImpl<Function *> *Readers,
308 SmallPtrSetImpl<Function *> *Writers,
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000309 GlobalValue *OkayStoreDest) {
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000310 if (!V->getType()->isPointerTy())
311 return true;
Chris Lattner26dff502004-06-28 06:33:13 +0000312
Chandler Carruthcdf47882014-03-09 03:16:01 +0000313 for (Use &U : V->uses()) {
314 User *I = U.getUser();
315 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
Chandler Carruth4cef26e2015-07-22 22:10:05 +0000316 if (Readers)
317 Readers->insert(LI->getParent()->getParent());
Chandler Carruthcdf47882014-03-09 03:16:01 +0000318 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000319 if (V == SI->getOperand(1)) {
Chandler Carruth4cef26e2015-07-22 22:10:05 +0000320 if (Writers)
321 Writers->insert(SI->getParent()->getParent());
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000322 } else if (SI->getOperand(1) != OkayStoreDest) {
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000323 return true; // Storing the pointer
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000324 }
Chandler Carruthcdf47882014-03-09 03:16:01 +0000325 } else if (Operator::getOpcode(I) == Instruction::GetElementPtr) {
326 if (AnalyzeUsesOfPointer(I, Readers, Writers))
Victor Hernandez537d8d92009-09-18 21:34:51 +0000327 return true;
Chandler Carruthcdf47882014-03-09 03:16:01 +0000328 } else if (Operator::getOpcode(I) == Instruction::BitCast) {
329 if (AnalyzeUsesOfPointer(I, Readers, Writers, OkayStoreDest))
Benjamin Kramerb8266d22014-02-10 14:17:30 +0000330 return true;
Benjamin Kramer3a09ef62015-04-10 14:50:08 +0000331 } else if (auto CS = CallSite(I)) {
Chris Lattner26dff502004-06-28 06:33:13 +0000332 // Make sure that this is just the function being called, not that it is
333 // passing into the function.
Chandler Carruthcdf47882014-03-09 03:16:01 +0000334 if (!CS.isCallee(&U)) {
Benjamin Kramerb8266d22014-02-10 14:17:30 +0000335 // Detect calls to free.
Chandler Carruth4cef26e2015-07-22 22:10:05 +0000336 if (isFreeCall(I, TLI)) {
337 if (Writers)
338 Writers->insert(CS->getParent()->getParent());
339 } else {
Benjamin Kramerb8266d22014-02-10 14:17:30 +0000340 return true; // Argument of an unknown call.
Chandler Carruth4cef26e2015-07-22 22:10:05 +0000341 }
Misha Brukman01808ca2005-04-21 21:13:18 +0000342 }
Chandler Carruthcdf47882014-03-09 03:16:01 +0000343 } else if (ICmpInst *ICI = dyn_cast<ICmpInst>(I)) {
Reid Spencer266e42b2006-12-23 06:05:41 +0000344 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000345 return true; // Allow comparison against null.
Chris Lattner26dff502004-06-28 06:33:13 +0000346 } else {
347 return true;
348 }
Gabor Greif070b9a22010-07-09 15:53:42 +0000349 }
350
Chris Lattner26dff502004-06-28 06:33:13 +0000351 return false;
352}
353
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000354/// AnalyzeIndirectGlobalMemory - We found an non-address-taken global variable
355/// which holds a pointer type. See if the global always points to non-aliased
356/// heap memory: that is, all initializers of the globals are allocations, and
357/// those allocations have no use other than initialization of the global.
358/// Further, all loads out of GV must directly use the memory, not store the
359/// pointer somewhere. If this is true, we consider the memory pointed to by
360/// GV to be owned by GV and can disambiguate other pointers from it.
361bool GlobalsModRef::AnalyzeIndirectGlobalMemory(GlobalValue *GV) {
362 // Keep track of values related to the allocation of the memory, f.e. the
363 // value produced by the malloc call and any casts.
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000364 std::vector<Value *> AllocRelatedValues;
Duncan Sands42c644e2008-09-03 12:55:42 +0000365
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000366 // Walk the user list of the global. If we find anything other than a direct
367 // load or store, bail out.
Chandler Carruthcdf47882014-03-09 03:16:01 +0000368 for (User *U : GV->users()) {
Gabor Greifaa389f52010-07-09 16:22:36 +0000369 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000370 // The pointer loaded from the global can only be used in simple ways:
371 // we allow addressing of it and loading storing to it. We do *not* allow
372 // storing the loaded pointer somewhere else or passing to a function.
Chandler Carruth4cef26e2015-07-22 22:10:05 +0000373 if (AnalyzeUsesOfPointer(LI))
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000374 return false; // Loaded pointer escapes.
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000375 // TODO: Could try some IP mod/ref of the loaded pointer.
Gabor Greifaa389f52010-07-09 16:22:36 +0000376 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000377 // Storing the global itself.
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000378 if (SI->getOperand(0) == GV)
379 return false;
Duncan Sands42c644e2008-09-03 12:55:42 +0000380
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000381 // If storing the null pointer, ignore it.
382 if (isa<ConstantPointerNull>(SI->getOperand(0)))
383 continue;
Duncan Sands42c644e2008-09-03 12:55:42 +0000384
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000385 // Check the value being stored.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000386 Value *Ptr = GetUnderlyingObject(SI->getOperand(0),
387 GV->getParent()->getDataLayout());
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000388
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000389 if (!isAllocLikeFn(Ptr, TLI))
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000390 return false; // Too hard to analyze.
Duncan Sands42c644e2008-09-03 12:55:42 +0000391
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000392 // Analyze all uses of the allocation. If any of them are used in a
393 // non-simple way (e.g. stored to another global) bail out.
Chandler Carruth4cef26e2015-07-22 22:10:05 +0000394 if (AnalyzeUsesOfPointer(Ptr, /*Readers*/ nullptr, /*Writers*/ nullptr,
395 GV))
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000396 return false; // Loaded pointer escapes.
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000397
398 // Remember that this allocation is related to the indirect global.
399 AllocRelatedValues.push_back(Ptr);
400 } else {
401 // Something complex, bail out.
402 return false;
403 }
404 }
Duncan Sands42c644e2008-09-03 12:55:42 +0000405
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000406 // Okay, this is an indirect global. Remember all of the allocations for
407 // this global in AllocsForIndirectGlobals.
408 while (!AllocRelatedValues.empty()) {
409 AllocsForIndirectGlobals[AllocRelatedValues.back()] = GV;
Chandler Carruthda7c1912015-07-22 09:27:58 +0000410 Handles.emplace_front(*this, AllocRelatedValues.back());
411 Handles.front().I = Handles.begin();
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000412 AllocRelatedValues.pop_back();
413 }
414 IndirectGlobals.insert(GV);
Chandler Carruthda7c1912015-07-22 09:27:58 +0000415 Handles.emplace_front(*this, GV);
416 Handles.front().I = Handles.begin();
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000417 return true;
418}
419
Chris Lattner26dff502004-06-28 06:33:13 +0000420/// AnalyzeCallGraph - At this point, we know the functions where globals are
421/// immediately stored to and read from. Propagate this information up the call
Chris Lattner3a353e82004-07-27 06:40:37 +0000422/// graph to all callers and compute the mod/ref info for all memory for each
Misha Brukman01808ca2005-04-21 21:13:18 +0000423/// function.
Chris Lattner26dff502004-06-28 06:33:13 +0000424void GlobalsModRef::AnalyzeCallGraph(CallGraph &CG, Module &M) {
Chris Lattner26dff502004-06-28 06:33:13 +0000425 // We do a bottom-up SCC traversal of the call graph. In other words, we
426 // visit all callees before callers (leaf-first).
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000427 for (scc_iterator<CallGraph *> I = scc_begin(&CG); !I.isAtEnd(); ++I) {
Duncan P. N. Exon Smithd2b2fac2014-04-25 18:24:50 +0000428 const std::vector<CallGraphNode *> &SCC = *I;
Duncan Sands21a57992008-09-04 19:16:20 +0000429 assert(!SCC.empty() && "SCC with no functions?");
Duncan Sands42c644e2008-09-03 12:55:42 +0000430
Duncan Sands21a57992008-09-04 19:16:20 +0000431 if (!SCC[0]->getFunction()) {
432 // Calls externally - can't say anything useful. Remove any existing
433 // function records (may have been created when scanning globals).
Chandler Carrutha033bbb2015-07-15 08:09:23 +0000434 for (auto *Node : SCC)
435 FunctionInfo.erase(Node->getFunction());
Duncan Sands42c644e2008-09-03 12:55:42 +0000436 continue;
Duncan Sands21a57992008-09-04 19:16:20 +0000437 }
438
439 FunctionRecord &FR = FunctionInfo[SCC[0]->getFunction()];
Chris Lattner26dff502004-06-28 06:33:13 +0000440
Duncan Sands42c644e2008-09-03 12:55:42 +0000441 bool KnowNothing = false;
442 unsigned FunctionEffect = 0;
Chris Lattner3a353e82004-07-27 06:40:37 +0000443
Duncan Sands42c644e2008-09-03 12:55:42 +0000444 // Collect the mod/ref properties due to called functions. We only compute
445 // one mod-ref set.
446 for (unsigned i = 0, e = SCC.size(); i != e && !KnowNothing; ++i) {
447 Function *F = SCC[i]->getFunction();
448 if (!F) {
449 KnowNothing = true;
Chris Lattner3a353e82004-07-27 06:40:37 +0000450 break;
Chris Lattner26dff502004-06-28 06:33:13 +0000451 }
Chris Lattner3a353e82004-07-27 06:40:37 +0000452
Duncan Sands42c644e2008-09-03 12:55:42 +0000453 if (F->isDeclaration()) {
454 // Try to get mod/ref behaviour from function attributes.
Duncan Sands0eca0572008-09-03 15:31:24 +0000455 if (F->doesNotAccessMemory()) {
456 // Can't do better than that!
457 } else if (F->onlyReadsMemory()) {
Chandler Carruth194f59c2015-07-22 23:15:57 +0000458 FunctionEffect |= MRI_Ref;
Duncan Sands06dbb122008-09-12 07:29:58 +0000459 if (!F->isIntrinsic())
Duncan Sandse30b36f2008-09-11 15:43:12 +0000460 // This function might call back into the module and read a global -
Duncan Sands06dbb122008-09-12 07:29:58 +0000461 // consider every global as possibly being read by this function.
462 FR.MayReadAnyGlobal = true;
Duncan Sands0eca0572008-09-03 15:31:24 +0000463 } else {
Chandler Carruth194f59c2015-07-22 23:15:57 +0000464 FunctionEffect |= MRI_ModRef;
Duncan Sandsd4133ac2008-09-11 19:35:55 +0000465 // Can't say anything useful unless it's an intrinsic - they don't
466 // read or write global variables of the kind considered here.
467 KnowNothing = !F->isIntrinsic();
Duncan Sands42c644e2008-09-03 12:55:42 +0000468 }
469 continue;
470 }
Misha Brukman01808ca2005-04-21 21:13:18 +0000471
Duncan Sands42c644e2008-09-03 12:55:42 +0000472 for (CallGraphNode::iterator CI = SCC[i]->begin(), E = SCC[i]->end();
Duncan Sands21a57992008-09-04 19:16:20 +0000473 CI != E && !KnowNothing; ++CI)
Duncan Sands42c644e2008-09-03 12:55:42 +0000474 if (Function *Callee = CI->second->getFunction()) {
475 if (FunctionRecord *CalleeFR = getFunctionInfo(Callee)) {
476 // Propagate function effect up.
477 FunctionEffect |= CalleeFR->FunctionEffect;
478
479 // Incorporate callee's effects on globals into our info.
Rafael Espindola0c4eea72014-05-08 17:57:50 +0000480 for (const auto &G : CalleeFR->GlobalInfo)
481 FR.GlobalInfo[G.first] |= G.second;
Duncan Sands06dbb122008-09-12 07:29:58 +0000482 FR.MayReadAnyGlobal |= CalleeFR->MayReadAnyGlobal;
Duncan Sands42c644e2008-09-03 12:55:42 +0000483 } else {
484 // Can't say anything about it. However, if it is inside our SCC,
485 // then nothing needs to be done.
486 CallGraphNode *CalleeNode = CG[Callee];
487 if (std::find(SCC.begin(), SCC.end(), CalleeNode) == SCC.end())
488 KnowNothing = true;
489 }
490 } else {
491 KnowNothing = true;
492 }
493 }
494
495 // If we can't say anything useful about this SCC, remove all SCC functions
496 // from the FunctionInfo map.
497 if (KnowNothing) {
Chandler Carrutha033bbb2015-07-15 08:09:23 +0000498 for (auto *Node : SCC)
499 FunctionInfo.erase(Node->getFunction());
Duncan Sandse74d7502008-09-03 16:10:55 +0000500 continue;
Duncan Sands42c644e2008-09-03 12:55:42 +0000501 }
502
503 // Scan the function bodies for explicit loads or stores.
Chandler Carruth6af95d02015-07-15 08:53:29 +0000504 for (auto *Node : SCC) {
Chandler Carruth194f59c2015-07-22 23:15:57 +0000505 if (FunctionEffect == MRI_ModRef)
Chandler Carruth6af95d02015-07-15 08:53:29 +0000506 break; // The mod/ref lattice saturates here.
507 for (Instruction &I : inst_range(Node->getFunction())) {
Chandler Carruth194f59c2015-07-22 23:15:57 +0000508 if (FunctionEffect == MRI_ModRef)
Chandler Carruth6af95d02015-07-15 08:53:29 +0000509 break; // The mod/ref lattice saturates here.
510
511 // We handle calls specially because the graph-relevant aspects are
512 // handled above.
513 if (auto CS = CallSite(&I)) {
514 if (isAllocationFn(&I, TLI) || isFreeCall(&I, TLI)) {
515 // FIXME: It is completely unclear why this is necessary and not
516 // handled by the above graph code.
Chandler Carruth194f59c2015-07-22 23:15:57 +0000517 FunctionEffect |= MRI_ModRef;
Chandler Carruth6af95d02015-07-15 08:53:29 +0000518 } else if (Function *Callee = CS.getCalledFunction()) {
519 // The callgraph doesn't include intrinsic calls.
520 if (Callee->isIntrinsic()) {
Chandler Carruth194f59c2015-07-22 23:15:57 +0000521 FunctionModRefBehavior Behaviour =
Chandler Carruth6af95d02015-07-15 08:53:29 +0000522 AliasAnalysis::getModRefBehavior(Callee);
Chandler Carruth194f59c2015-07-22 23:15:57 +0000523 FunctionEffect |= (Behaviour & MRI_ModRef);
Chandler Carruth6af95d02015-07-15 08:53:29 +0000524 }
525 }
526 continue;
Duncan Sands9ddb3142008-09-13 12:45:50 +0000527 }
Duncan Sands42c644e2008-09-03 12:55:42 +0000528
Chandler Carruth6af95d02015-07-15 08:53:29 +0000529 // All non-call instructions we use the primary predicates for whether
530 // thay read or write memory.
531 if (I.mayReadFromMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000532 FunctionEffect |= MRI_Ref;
Chandler Carruth6af95d02015-07-15 08:53:29 +0000533 if (I.mayWriteToMemory())
Chandler Carruth194f59c2015-07-22 23:15:57 +0000534 FunctionEffect |= MRI_Mod;
Chandler Carruth6af95d02015-07-15 08:53:29 +0000535 }
536 }
537
Chandler Carruth194f59c2015-07-22 23:15:57 +0000538 if ((FunctionEffect & MRI_Mod) == 0)
Duncan Sands42c644e2008-09-03 12:55:42 +0000539 ++NumReadMemFunctions;
540 if (FunctionEffect == 0)
541 ++NumNoMemFunctions;
Duncan Sands21a57992008-09-04 19:16:20 +0000542 FR.FunctionEffect = FunctionEffect;
Duncan Sands42c644e2008-09-03 12:55:42 +0000543
544 // Finally, now that we know the full effect on this SCC, clone the
545 // information to each function in the SCC.
546 for (unsigned i = 1, e = SCC.size(); i != e; ++i)
Duncan Sands21a57992008-09-04 19:16:20 +0000547 FunctionInfo[SCC[i]->getFunction()] = FR;
Chris Lattner3a353e82004-07-27 06:40:37 +0000548 }
Chris Lattner26dff502004-06-28 06:33:13 +0000549}
550
Chris Lattner26dff502004-06-28 06:33:13 +0000551/// alias - If one of the pointers is to a global that we are tracking, and the
552/// other is some random pointer, we know there cannot be an alias, because the
553/// address of the global isn't taken.
Chandler Carruthc3f49eb2015-06-22 02:16:51 +0000554AliasResult GlobalsModRef::alias(const MemoryLocation &LocA,
555 const MemoryLocation &LocB) {
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000556 // Get the base object these pointers point to.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000557 const Value *UV1 = GetUnderlyingObject(LocA.Ptr, *DL);
558 const Value *UV2 = GetUnderlyingObject(LocB.Ptr, *DL);
Duncan Sands42c644e2008-09-03 12:55:42 +0000559
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000560 // If either of the underlying values is a global, they may be non-addr-taken
561 // globals, which we can answer queries about.
Dan Gohman5442c712010-08-03 21:48:53 +0000562 const GlobalValue *GV1 = dyn_cast<GlobalValue>(UV1);
563 const GlobalValue *GV2 = dyn_cast<GlobalValue>(UV2);
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000564 if (GV1 || GV2) {
565 // If the global's address is taken, pretend we don't know it's a pointer to
566 // the global.
Chandler Carruth466d7ad2015-07-14 08:42:39 +0000567 if (GV1 && !NonAddressTakenGlobals.count(GV1))
568 GV1 = nullptr;
569 if (GV2 && !NonAddressTakenGlobals.count(GV2))
570 GV2 = nullptr;
Chris Lattner26dff502004-06-28 06:33:13 +0000571
Dan Gohman4a618822010-02-10 16:03:48 +0000572 // If the two pointers are derived from two different non-addr-taken
Chandler Carruthf55803f2015-07-17 06:58:24 +0000573 // globals we know these can't alias.
574 if (GV1 && GV2 && GV1 != GV2)
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000575 return NoAlias;
Chris Lattner26dff502004-06-28 06:33:13 +0000576
Chandler Carruthf55803f2015-07-17 06:58:24 +0000577 // If one is and the other isn't, it isn't strictly safe but we can fake
578 // this result if necessary for performance. This does not appear to be
579 // a common problem in practice.
580 if (EnableUnsafeGlobalsModRefAliasResults)
581 if ((GV1 || GV2) && GV1 != GV2)
582 return NoAlias;
583
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000584 // Otherwise if they are both derived from the same addr-taken global, we
585 // can't know the two accesses don't overlap.
586 }
Duncan Sands42c644e2008-09-03 12:55:42 +0000587
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000588 // These pointers may be based on the memory owned by an indirect global. If
589 // so, we may be able to handle this. First check to see if the base pointer
590 // is a direct load from an indirect global.
Craig Topper353eda42014-04-24 06:44:33 +0000591 GV1 = GV2 = nullptr;
Dan Gohman5442c712010-08-03 21:48:53 +0000592 if (const LoadInst *LI = dyn_cast<LoadInst>(UV1))
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000593 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getOperand(0)))
594 if (IndirectGlobals.count(GV))
595 GV1 = GV;
Dan Gohman5442c712010-08-03 21:48:53 +0000596 if (const LoadInst *LI = dyn_cast<LoadInst>(UV2))
597 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getOperand(0)))
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000598 if (IndirectGlobals.count(GV))
599 GV2 = GV;
Duncan Sands42c644e2008-09-03 12:55:42 +0000600
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000601 // These pointers may also be from an allocation for the indirect global. If
602 // so, also handle them.
Chandler Carruth56e2c622015-07-22 11:43:24 +0000603 if (!GV1)
604 GV1 = AllocsForIndirectGlobals.lookup(UV1);
605 if (!GV2)
606 GV2 = AllocsForIndirectGlobals.lookup(UV2);
Duncan Sands42c644e2008-09-03 12:55:42 +0000607
Chris Lattnerbfdd19b2006-10-01 22:36:45 +0000608 // Now that we know whether the two pointers are related to indirect globals,
Chandler Carruthf55803f2015-07-17 06:58:24 +0000609 // use this to disambiguate the pointers. If the pointers are based on
610 // different indirect globals they cannot alias.
611 if (GV1 && GV2 && GV1 != GV2)
Chris Lattner26dff502004-06-28 06:33:13 +0000612 return NoAlias;
Duncan Sands42c644e2008-09-03 12:55:42 +0000613
Chandler Carruthf55803f2015-07-17 06:58:24 +0000614 // If one is based on an indirect global and the other isn't, it isn't
615 // strictly safe but we can fake this result if necessary for performance.
616 // This does not appear to be a common problem in practice.
617 if (EnableUnsafeGlobalsModRefAliasResults)
618 if ((GV1 || GV2) && GV1 != GV2)
619 return NoAlias;
620
Dan Gohman41f14cf2010-09-14 21:25:10 +0000621 return AliasAnalysis::alias(LocA, LocB);
Chris Lattner26dff502004-06-28 06:33:13 +0000622}
623
Chandler Carruth194f59c2015-07-22 23:15:57 +0000624ModRefInfo GlobalsModRef::getModRefInfo(ImmutableCallSite CS,
625 const MemoryLocation &Loc) {
626 unsigned Known = MRI_ModRef;
Chris Lattner26dff502004-06-28 06:33:13 +0000627
628 // If we are asking for mod/ref info of a direct call with a pointer to a
Chris Lattner3a353e82004-07-27 06:40:37 +0000629 // global we are tracking, return information if we have it.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000630 const DataLayout &DL = CS.getCaller()->getParent()->getDataLayout();
Dan Gohman41f14cf2010-09-14 21:25:10 +0000631 if (const GlobalValue *GV =
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000632 dyn_cast<GlobalValue>(GetUnderlyingObject(Loc.Ptr, DL)))
Rafael Espindola6de96a12009-01-15 20:18:42 +0000633 if (GV->hasLocalLinkage())
Dan Gohman5442c712010-08-03 21:48:53 +0000634 if (const Function *F = CS.getCalledFunction())
Chris Lattner3a353e82004-07-27 06:40:37 +0000635 if (NonAddressTakenGlobals.count(GV))
Dan Gohman5442c712010-08-03 21:48:53 +0000636 if (const FunctionRecord *FR = getFunctionInfo(F))
Chris Lattner3a353e82004-07-27 06:40:37 +0000637 Known = FR->getInfoForGlobal(GV);
Chris Lattner26dff502004-06-28 06:33:13 +0000638
Chandler Carruth194f59c2015-07-22 23:15:57 +0000639 if (Known == MRI_NoModRef)
640 return MRI_NoModRef; // No need to query other mod/ref analyses
641 return ModRefInfo(Known & AliasAnalysis::getModRefInfo(CS, Loc));
Chris Lattner26dff502004-06-28 06:33:13 +0000642}