blob: 6c115ac375b68b23333bcceabd8c51ec2c0f945a [file] [log] [blame]
Chris Lattner25db5802004-10-07 04:16:33 +00001//===- GlobalOpt.cpp - Optimize Global Variables --------------------------===//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
Chris Lattner25db5802004-10-07 04:16:33 +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 Brukmanb1c93172005-04-21 23:48:37 +00007//
Chris Lattner25db5802004-10-07 04:16:33 +00008//===----------------------------------------------------------------------===//
9//
10// This pass transforms simple global variables that never have their address
11// taken. If obviously true, it marks read/write globals as constant, deletes
12// variables only stored to, etc.
13//
14//===----------------------------------------------------------------------===//
15
Chris Lattner25db5802004-10-07 04:16:33 +000016#include "llvm/Transforms/IPO.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000017#include "llvm/ADT/DenseMap.h"
18#include "llvm/ADT/STLExtras.h"
19#include "llvm/ADT/SmallPtrSet.h"
David Majnemerdad0a642014-06-27 18:19:56 +000020#include "llvm/ADT/SmallSet.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000021#include "llvm/ADT/SmallVector.h"
22#include "llvm/ADT/Statistic.h"
23#include "llvm/Analysis/ConstantFolding.h"
24#include "llvm/Analysis/MemoryBuiltins.h"
Benjamin Kramer799003b2015-03-23 19:32:43 +000025#include "llvm/Analysis/TargetLibraryInfo.h"
Chandler Carruth219b89b2014-03-04 11:01:28 +000026#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000027#include "llvm/IR/CallingConv.h"
28#include "llvm/IR/Constants.h"
29#include "llvm/IR/DataLayout.h"
30#include "llvm/IR/DerivedTypes.h"
James Molloy9c7d4d82015-11-15 14:21:37 +000031#include "llvm/IR/Dominators.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000032#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000033#include "llvm/IR/Instructions.h"
34#include "llvm/IR/IntrinsicInst.h"
35#include "llvm/IR/Module.h"
36#include "llvm/IR/Operator.h"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000037#include "llvm/IR/ValueHandle.h"
Chris Lattner25db5802004-10-07 04:16:33 +000038#include "llvm/Pass.h"
Chris Lattner024f4ab2007-01-30 23:46:24 +000039#include "llvm/Support/Debug.h"
Torok Edwin56d06592009-07-11 20:10:48 +000040#include "llvm/Support/ErrorHandling.h"
Chris Lattner67ca6f632008-04-26 07:40:11 +000041#include "llvm/Support/MathExtras.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000042#include "llvm/Support/raw_ostream.h"
Nico Weber4b2acde2014-05-02 18:35:25 +000043#include "llvm/Transforms/Utils/CtorUtils.h"
Rafael Espindola3d7fc252013-10-21 17:14:55 +000044#include "llvm/Transforms/Utils/GlobalStatus.h"
Rafael Espindola17600e22013-07-25 03:23:25 +000045#include "llvm/Transforms/Utils/ModuleUtils.h"
Chris Lattner25db5802004-10-07 04:16:33 +000046#include <algorithm>
Benjamin Kramer64425fe2014-05-03 15:50:37 +000047#include <deque>
Chris Lattner25db5802004-10-07 04:16:33 +000048using namespace llvm;
49
Chandler Carruth964daaa2014-04-22 02:55:47 +000050#define DEBUG_TYPE "globalopt"
51
Chris Lattner1631bcb2006-12-19 22:09:18 +000052STATISTIC(NumMarked , "Number of globals marked constant");
Rafael Espindolafc355bc2011-01-19 16:32:21 +000053STATISTIC(NumUnnamed , "Number of globals marked unnamed_addr");
Chris Lattner1631bcb2006-12-19 22:09:18 +000054STATISTIC(NumSRA , "Number of aggregate globals broken into scalars");
55STATISTIC(NumHeapSRA , "Number of heap objects SRA'd");
56STATISTIC(NumSubstitute,"Number of globals with initializers stored into them");
57STATISTIC(NumDeleted , "Number of globals deleted");
Chris Lattner1631bcb2006-12-19 22:09:18 +000058STATISTIC(NumGlobUses , "Number of global uses devirtualized");
Alexey Samsonova1944e62013-10-07 19:03:24 +000059STATISTIC(NumLocalized , "Number of globals localized");
Chris Lattner1631bcb2006-12-19 22:09:18 +000060STATISTIC(NumShrunkToBool , "Number of global vars shrunk to booleans");
61STATISTIC(NumFastCallFns , "Number of functions converted to fastcc");
62STATISTIC(NumCtorsEvaluated, "Number of static ctors evaluated");
Duncan Sands573b3f82008-02-16 20:56:04 +000063STATISTIC(NumNestRemoved , "Number of nest attributes removed");
Duncan Sandsb3f27882009-02-15 09:56:08 +000064STATISTIC(NumAliasesResolved, "Number of global aliases resolved");
65STATISTIC(NumAliasesRemoved, "Number of global aliases eliminated");
Anders Carlssonee6bc702011-03-20 17:59:11 +000066STATISTIC(NumCXXDtorsRemoved, "Number of global C++ destructors removed");
Chris Lattner25db5802004-10-07 04:16:33 +000067
Chris Lattner1631bcb2006-12-19 22:09:18 +000068namespace {
Nick Lewycky02d5f772009-10-25 06:33:48 +000069 struct GlobalOpt : public ModulePass {
Craig Topper3e4c6972014-03-05 09:10:37 +000070 void getAnalysisUsage(AnalysisUsage &AU) const override {
Chandler Carruthb98f63d2015-01-15 10:41:28 +000071 AU.addRequired<TargetLibraryInfoWrapperPass>();
James Molloy9c7d4d82015-11-15 14:21:37 +000072 AU.addRequired<DominatorTreeWrapperPass>();
Chris Lattner004e2502004-10-11 05:54:41 +000073 }
Nick Lewyckye7da2d62007-05-06 13:37:16 +000074 static char ID; // Pass identification, replacement for typeid
Owen Anderson6c18d1a2010-10-19 17:21:58 +000075 GlobalOpt() : ModulePass(ID) {
76 initializeGlobalOptPass(*PassRegistry::getPassRegistry());
77 }
Misha Brukmanb1c93172005-04-21 23:48:37 +000078
Craig Topper3e4c6972014-03-05 09:10:37 +000079 bool runOnModule(Module &M) override;
Chris Lattner004e2502004-10-11 05:54:41 +000080
81 private:
Chris Lattner41b6a5a2005-09-26 01:43:45 +000082 bool OptimizeFunctions(Module &M);
83 bool OptimizeGlobalVars(Module &M);
Duncan Sandsed722832009-03-06 10:21:56 +000084 bool OptimizeGlobalAliases(Module &M);
Rafael Espindola2cc46b32015-12-22 19:38:07 +000085 bool deleteIfDead(GlobalValue &GV);
Rafael Espindola10d9a032015-12-22 20:43:30 +000086 bool processGlobal(GlobalValue &GV);
Rafael Espindolae4ed0e52015-12-22 19:16:50 +000087 bool processInternalGlobal(GlobalVariable *GV, const GlobalStatus &GS);
Anders Carlssonee6bc702011-03-20 17:59:11 +000088 bool OptimizeEmptyGlobalCXXDtors(Function *CXAAtExitFn);
James Molloyd4d23572015-11-16 10:16:22 +000089
90 bool isPointerValueDeadOnEntryToFunction(const Function *F,
91 GlobalValue *GV);
92
Nick Lewyckycf6aae62012-02-12 01:13:18 +000093 TargetLibraryInfo *TLI;
David Majnemer1b3b70e2014-10-08 07:23:31 +000094 SmallSet<const Comdat *, 8> NotDiscardableComdats;
Chris Lattner25db5802004-10-07 04:16:33 +000095 };
Alexander Kornienkof00654e2015-06-23 09:49:53 +000096}
Chris Lattner25db5802004-10-07 04:16:33 +000097
Dan Gohmand78c4002008-05-13 00:00:25 +000098char GlobalOpt::ID = 0;
Chad Rosiere6de63d2011-12-01 21:29:16 +000099INITIALIZE_PASS_BEGIN(GlobalOpt, "globalopt",
100 "Global Variable Optimizer", false, false)
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000101INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
James Molloy9c7d4d82015-11-15 14:21:37 +0000102INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
Chad Rosiere6de63d2011-12-01 21:29:16 +0000103INITIALIZE_PASS_END(GlobalOpt, "globalopt",
Owen Andersondf7a4f22010-10-07 22:25:06 +0000104 "Global Variable Optimizer", false, false)
Dan Gohmand78c4002008-05-13 00:00:25 +0000105
Chris Lattner25db5802004-10-07 04:16:33 +0000106ModulePass *llvm::createGlobalOptimizerPass() { return new GlobalOpt(); }
107
James Molloyea31ad32015-11-13 11:05:07 +0000108/// Is this global variable possibly used by a leak checker as a root? If so,
109/// we might not really want to eliminate the stores to it.
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000110static bool isLeakCheckerRoot(GlobalVariable *GV) {
111 // A global variable is a root if it is a pointer, or could plausibly contain
112 // a pointer. There are two challenges; one is that we could have a struct
113 // the has an inner member which is a pointer. We recurse through the type to
114 // detect these (up to a point). The other is that we may actually be a union
115 // of a pointer and another type, and so our LLVM type is an integer which
116 // gets converted into a pointer, or our type is an [i8 x #] with a pointer
117 // potentially contained here.
118
119 if (GV->hasPrivateLinkage())
120 return false;
121
122 SmallVector<Type *, 4> Types;
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000123 Types.push_back(GV->getValueType());
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000124
125 unsigned Limit = 20;
126 do {
127 Type *Ty = Types.pop_back_val();
128 switch (Ty->getTypeID()) {
129 default: break;
130 case Type::PointerTyID: return true;
131 case Type::ArrayTyID:
132 case Type::VectorTyID: {
133 SequentialType *STy = cast<SequentialType>(Ty);
134 Types.push_back(STy->getElementType());
135 break;
136 }
137 case Type::StructTyID: {
138 StructType *STy = cast<StructType>(Ty);
139 if (STy->isOpaque()) return true;
140 for (StructType::element_iterator I = STy->element_begin(),
141 E = STy->element_end(); I != E; ++I) {
142 Type *InnerTy = *I;
143 if (isa<PointerType>(InnerTy)) return true;
144 if (isa<CompositeType>(InnerTy))
145 Types.push_back(InnerTy);
146 }
147 break;
148 }
149 }
150 if (--Limit == 0) return true;
151 } while (!Types.empty());
152 return false;
153}
154
155/// Given a value that is stored to a global but never read, determine whether
156/// it's safe to remove the store and the chain of computation that feeds the
157/// store.
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000158static bool IsSafeComputationToRemove(Value *V, const TargetLibraryInfo *TLI) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000159 do {
160 if (isa<Constant>(V))
161 return true;
162 if (!V->hasOneUse())
163 return false;
Nick Lewycky7d0f1102012-07-25 21:19:40 +0000164 if (isa<LoadInst>(V) || isa<InvokeInst>(V) || isa<Argument>(V) ||
165 isa<GlobalValue>(V))
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000166 return false;
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000167 if (isAllocationFn(V, TLI))
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000168 return true;
169
170 Instruction *I = cast<Instruction>(V);
171 if (I->mayHaveSideEffects())
172 return false;
173 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(I)) {
174 if (!GEP->hasAllConstantIndices())
175 return false;
176 } else if (I->getNumOperands() != 1) {
177 return false;
178 }
179
180 V = I->getOperand(0);
181 } while (1);
182}
183
James Molloyea31ad32015-11-13 11:05:07 +0000184/// This GV is a pointer root. Loop over all users of the global and clean up
185/// any that obviously don't assign the global a value that isn't dynamically
186/// allocated.
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000187static bool CleanupPointerRootUsers(GlobalVariable *GV,
188 const TargetLibraryInfo *TLI) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000189 // A brief explanation of leak checkers. The goal is to find bugs where
190 // pointers are forgotten, causing an accumulating growth in memory
191 // usage over time. The common strategy for leak checkers is to whitelist the
192 // memory pointed to by globals at exit. This is popular because it also
193 // solves another problem where the main thread of a C++ program may shut down
194 // before other threads that are still expecting to use those globals. To
195 // handle that case, we expect the program may create a singleton and never
196 // destroy it.
197
198 bool Changed = false;
199
200 // If Dead[n].first is the only use of a malloc result, we can delete its
201 // chain of computation and the store to the global in Dead[n].second.
202 SmallVector<std::pair<Instruction *, Instruction *>, 32> Dead;
203
204 // Constants can't be pointers to dynamically allocated memory.
Chandler Carruthcdf47882014-03-09 03:16:01 +0000205 for (Value::user_iterator UI = GV->user_begin(), E = GV->user_end();
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000206 UI != E;) {
207 User *U = *UI++;
208 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
209 Value *V = SI->getValueOperand();
210 if (isa<Constant>(V)) {
211 Changed = true;
212 SI->eraseFromParent();
213 } else if (Instruction *I = dyn_cast<Instruction>(V)) {
214 if (I->hasOneUse())
215 Dead.push_back(std::make_pair(I, SI));
216 }
217 } else if (MemSetInst *MSI = dyn_cast<MemSetInst>(U)) {
218 if (isa<Constant>(MSI->getValue())) {
219 Changed = true;
220 MSI->eraseFromParent();
221 } else if (Instruction *I = dyn_cast<Instruction>(MSI->getValue())) {
222 if (I->hasOneUse())
223 Dead.push_back(std::make_pair(I, MSI));
224 }
225 } else if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(U)) {
226 GlobalVariable *MemSrc = dyn_cast<GlobalVariable>(MTI->getSource());
227 if (MemSrc && MemSrc->isConstant()) {
228 Changed = true;
229 MTI->eraseFromParent();
230 } else if (Instruction *I = dyn_cast<Instruction>(MemSrc)) {
231 if (I->hasOneUse())
232 Dead.push_back(std::make_pair(I, MTI));
233 }
234 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
235 if (CE->use_empty()) {
236 CE->destroyConstant();
237 Changed = true;
238 }
239 } else if (Constant *C = dyn_cast<Constant>(U)) {
Rafael Espindola27797ba2013-10-17 18:06:32 +0000240 if (isSafeToDestroyConstant(C)) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000241 C->destroyConstant();
242 // This could have invalidated UI, start over from scratch.
243 Dead.clear();
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000244 CleanupPointerRootUsers(GV, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000245 return true;
246 }
247 }
248 }
249
250 for (int i = 0, e = Dead.size(); i != e; ++i) {
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000251 if (IsSafeComputationToRemove(Dead[i].first, TLI)) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000252 Dead[i].second->eraseFromParent();
253 Instruction *I = Dead[i].first;
254 do {
Michael Gottesman2a654272013-01-11 23:08:52 +0000255 if (isAllocationFn(I, TLI))
256 break;
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000257 Instruction *J = dyn_cast<Instruction>(I->getOperand(0));
258 if (!J)
259 break;
260 I->eraseFromParent();
261 I = J;
Nick Lewycky38be9312012-07-24 21:33:00 +0000262 } while (1);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000263 I->eraseFromParent();
264 }
265 }
266
267 return Changed;
268}
269
James Molloyea31ad32015-11-13 11:05:07 +0000270/// We just marked GV constant. Loop over all users of the global, cleaning up
271/// the obvious ones. This is largely just a quick scan over the use list to
272/// clean up the easy and obvious cruft. This returns true if it made a change.
Nick Lewyckycf6aae62012-02-12 01:13:18 +0000273static bool CleanupConstantGlobalUsers(Value *V, Constant *Init,
Mehdi Amini46a43552015-03-04 18:43:29 +0000274 const DataLayout &DL,
Rafael Espindolaaeff8a92014-02-24 23:12:18 +0000275 TargetLibraryInfo *TLI) {
Chris Lattnercb9f1522004-10-10 16:43:46 +0000276 bool Changed = false;
Hal Finkelf59fd7d2013-12-12 20:45:24 +0000277 // Note that we need to use a weak value handle for the worklist items. When
278 // we delete a constant array, we may also be holding pointer to one of its
279 // elements (or an element of one of its elements if we're dealing with an
280 // array of arrays) in the worklist.
Chandler Carruthcdf47882014-03-09 03:16:01 +0000281 SmallVector<WeakVH, 8> WorkList(V->user_begin(), V->user_end());
Bill Wendling88d06c32013-04-02 08:16:45 +0000282 while (!WorkList.empty()) {
Hal Finkelf59fd7d2013-12-12 20:45:24 +0000283 Value *UV = WorkList.pop_back_val();
284 if (!UV)
285 continue;
286
287 User *U = cast<User>(UV);
Misha Brukmanb1c93172005-04-21 23:48:37 +0000288
Chris Lattner25db5802004-10-07 04:16:33 +0000289 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner7561ca12005-02-27 18:58:52 +0000290 if (Init) {
291 // Replace the load with the initializer.
292 LI->replaceAllUsesWith(Init);
293 LI->eraseFromParent();
294 Changed = true;
295 }
Chris Lattner25db5802004-10-07 04:16:33 +0000296 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
297 // Store must be unreachable or storing Init into the global.
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000298 SI->eraseFromParent();
Chris Lattnercb9f1522004-10-10 16:43:46 +0000299 Changed = true;
Chris Lattner25db5802004-10-07 04:16:33 +0000300 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
301 if (CE->getOpcode() == Instruction::GetElementPtr) {
Craig Topperf40110f2014-04-25 05:29:35 +0000302 Constant *SubInit = nullptr;
Chris Lattner46d9ff082005-09-26 07:34:35 +0000303 if (Init)
Dan Gohmane525d9d2009-10-05 16:36:26 +0000304 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000305 Changed |= CleanupConstantGlobalUsers(CE, SubInit, DL, TLI);
Matt Arsenault461c8e02014-01-02 20:01:43 +0000306 } else if ((CE->getOpcode() == Instruction::BitCast &&
307 CE->getType()->isPointerTy()) ||
308 CE->getOpcode() == Instruction::AddrSpaceCast) {
Chris Lattner7561ca12005-02-27 18:58:52 +0000309 // Pointer cast, delete any stores and memsets to the global.
Craig Topperf40110f2014-04-25 05:29:35 +0000310 Changed |= CleanupConstantGlobalUsers(CE, nullptr, DL, TLI);
Chris Lattner7561ca12005-02-27 18:58:52 +0000311 }
312
313 if (CE->use_empty()) {
314 CE->destroyConstant();
315 Changed = true;
Chris Lattner25db5802004-10-07 04:16:33 +0000316 }
317 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattnerf9c0fd72007-11-09 17:33:02 +0000318 // Do not transform "gepinst (gep constexpr (GV))" here, because forming
319 // "gepconstexpr (gep constexpr (GV))" will cause the two gep's to fold
320 // and will invalidate our notion of what Init is.
Craig Topperf40110f2014-04-25 05:29:35 +0000321 Constant *SubInit = nullptr;
Chris Lattnerf9c0fd72007-11-09 17:33:02 +0000322 if (!isa<ConstantExpr>(GEP->getOperand(0))) {
Mehdi Amini46a43552015-03-04 18:43:29 +0000323 ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000324 ConstantFoldInstruction(GEP, DL, TLI));
Chris Lattnerf9c0fd72007-11-09 17:33:02 +0000325 if (Init && CE && CE->getOpcode() == Instruction::GetElementPtr)
Dan Gohmane525d9d2009-10-05 16:36:26 +0000326 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Benjamin Krameraa9e4a52012-03-28 14:50:09 +0000327
328 // If the initializer is an all-null value and we have an inbounds GEP,
329 // we already know what the result of any load from that GEP is.
330 // TODO: Handle splats.
331 if (Init && isa<ConstantAggregateZero>(Init) && GEP->isInBounds())
Eduard Burtescu19eb0312016-01-19 17:28:00 +0000332 SubInit = Constant::getNullValue(GEP->getResultElementType());
Chris Lattnerf9c0fd72007-11-09 17:33:02 +0000333 }
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000334 Changed |= CleanupConstantGlobalUsers(GEP, SubInit, DL, TLI);
Chris Lattnera0e769c2004-10-10 16:47:33 +0000335
Chris Lattnercb9f1522004-10-10 16:43:46 +0000336 if (GEP->use_empty()) {
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000337 GEP->eraseFromParent();
Chris Lattnercb9f1522004-10-10 16:43:46 +0000338 Changed = true;
339 }
Chris Lattner7561ca12005-02-27 18:58:52 +0000340 } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(U)) { // memset/cpy/mv
341 if (MI->getRawDest() == V) {
342 MI->eraseFromParent();
343 Changed = true;
344 }
345
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000346 } else if (Constant *C = dyn_cast<Constant>(U)) {
347 // If we have a chain of dead constantexprs or other things dangling from
348 // us, and if they are all dead, nuke them without remorse.
Rafael Espindola27797ba2013-10-17 18:06:32 +0000349 if (isSafeToDestroyConstant(C)) {
Devang Pateld926aaa2009-03-06 01:37:41 +0000350 C->destroyConstant();
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000351 CleanupConstantGlobalUsers(V, Init, DL, TLI);
Chris Lattnercb9f1522004-10-10 16:43:46 +0000352 return true;
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000353 }
Chris Lattner25db5802004-10-07 04:16:33 +0000354 }
355 }
Chris Lattnercb9f1522004-10-10 16:43:46 +0000356 return Changed;
Chris Lattner25db5802004-10-07 04:16:33 +0000357}
358
James Molloyea31ad32015-11-13 11:05:07 +0000359/// Return true if the specified instruction is a safe user of a derived
360/// expression from a global that we want to SROA.
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000361static bool isSafeSROAElementUse(Value *V) {
362 // We might have a dead and dangling constant hanging off of here.
363 if (Constant *C = dyn_cast<Constant>(V))
Rafael Espindola27797ba2013-10-17 18:06:32 +0000364 return isSafeToDestroyConstant(C);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000365
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000366 Instruction *I = dyn_cast<Instruction>(V);
367 if (!I) return false;
368
369 // Loads are ok.
370 if (isa<LoadInst>(I)) return true;
371
372 // Stores *to* the pointer are ok.
373 if (StoreInst *SI = dyn_cast<StoreInst>(I))
374 return SI->getOperand(0) != V;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000375
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000376 // Otherwise, it must be a GEP.
377 GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I);
Craig Topperf40110f2014-04-25 05:29:35 +0000378 if (!GEPI) return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000379
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000380 if (GEPI->getNumOperands() < 3 || !isa<Constant>(GEPI->getOperand(1)) ||
381 !cast<Constant>(GEPI->getOperand(1))->isNullValue())
382 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000383
Chandler Carruthcdf47882014-03-09 03:16:01 +0000384 for (User *U : GEPI->users())
385 if (!isSafeSROAElementUse(U))
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000386 return false;
Chris Lattnerab053722008-01-14 01:31:05 +0000387 return true;
388}
389
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000390
James Molloyea31ad32015-11-13 11:05:07 +0000391/// U is a direct user of the specified global value. Look at it and its uses
392/// and decide whether it is safe to SROA this global.
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000393static bool IsUserOfGlobalSafeForSRA(User *U, GlobalValue *GV) {
394 // The user of the global must be a GEP Inst or a ConstantExpr GEP.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000395 if (!isa<GetElementPtrInst>(U) &&
396 (!isa<ConstantExpr>(U) ||
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000397 cast<ConstantExpr>(U)->getOpcode() != Instruction::GetElementPtr))
398 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000399
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000400 // Check to see if this ConstantExpr GEP is SRA'able. In particular, we
401 // don't like < 3 operand CE's, and we don't like non-constant integer
402 // indices. This enforces that all uses are 'gep GV, 0, C, ...' for some
403 // value of C.
404 if (U->getNumOperands() < 3 || !isa<Constant>(U->getOperand(1)) ||
405 !cast<Constant>(U->getOperand(1))->isNullValue() ||
406 !isa<ConstantInt>(U->getOperand(2)))
407 return false;
408
409 gep_type_iterator GEPI = gep_type_begin(U), E = gep_type_end(U);
410 ++GEPI; // Skip over the pointer index.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000411
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000412 // If this is a use of an array allocation, do a bit more checking for sanity.
Chris Lattner229907c2011-07-18 04:54:35 +0000413 if (ArrayType *AT = dyn_cast<ArrayType>(*GEPI)) {
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000414 uint64_t NumElements = AT->getNumElements();
415 ConstantInt *Idx = cast<ConstantInt>(U->getOperand(2));
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000416
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000417 // Check to make sure that index falls within the array. If not,
418 // something funny is going on, so we won't do the optimization.
419 //
420 if (Idx->getZExtValue() >= NumElements)
421 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000422
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000423 // We cannot scalar repl this level of the array unless any array
424 // sub-indices are in-range constants. In particular, consider:
425 // A[0][i]. We cannot know that the user isn't doing invalid things like
426 // allowing i to index an out-of-range subscript that accesses A[1].
427 //
428 // Scalar replacing *just* the outer index of the array is probably not
429 // going to be a win anyway, so just give up.
430 for (++GEPI; // Skip array index.
Dan Gohman82ac81b2009-08-18 14:58:19 +0000431 GEPI != E;
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000432 ++GEPI) {
433 uint64_t NumElements;
Chris Lattner229907c2011-07-18 04:54:35 +0000434 if (ArrayType *SubArrayTy = dyn_cast<ArrayType>(*GEPI))
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000435 NumElements = SubArrayTy->getNumElements();
Chris Lattner229907c2011-07-18 04:54:35 +0000436 else if (VectorType *SubVectorTy = dyn_cast<VectorType>(*GEPI))
Dan Gohman82ac81b2009-08-18 14:58:19 +0000437 NumElements = SubVectorTy->getNumElements();
438 else {
Duncan Sands19d0b472010-02-16 11:11:14 +0000439 assert((*GEPI)->isStructTy() &&
Dan Gohman82ac81b2009-08-18 14:58:19 +0000440 "Indexed GEP type is not array, vector, or struct!");
441 continue;
442 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000443
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000444 ConstantInt *IdxVal = dyn_cast<ConstantInt>(GEPI.getOperand());
445 if (!IdxVal || IdxVal->getZExtValue() >= NumElements)
446 return false;
447 }
448 }
449
Chandler Carruthcdf47882014-03-09 03:16:01 +0000450 for (User *UU : U->users())
451 if (!isSafeSROAElementUse(UU))
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000452 return false;
Chandler Carruthcdf47882014-03-09 03:16:01 +0000453
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000454 return true;
455}
456
James Molloyea31ad32015-11-13 11:05:07 +0000457/// Look at all uses of the global and decide whether it is safe for us to
458/// perform this transformation.
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000459static bool GlobalUsersSafeToSRA(GlobalValue *GV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000460 for (User *U : GV->users())
461 if (!IsUserOfGlobalSafeForSRA(U, GV))
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000462 return false;
Chandler Carruthcdf47882014-03-09 03:16:01 +0000463
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000464 return true;
465}
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000466
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000467
James Molloyea31ad32015-11-13 11:05:07 +0000468/// Perform scalar replacement of aggregates on the specified global variable.
469/// This opens the door for other optimizations by exposing the behavior of the
470/// program in a more fine-grained way. We have determined that this
471/// transformation is safe already. We return the first global variable we
Chris Lattnerabab0712004-10-08 17:32:09 +0000472/// insert so that the caller can reprocess it.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000473static GlobalVariable *SRAGlobal(GlobalVariable *GV, const DataLayout &DL) {
Chris Lattnerab053722008-01-14 01:31:05 +0000474 // Make sure this global only has simple uses that we can SRA.
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000475 if (!GlobalUsersSafeToSRA(GV))
Craig Topperf40110f2014-04-25 05:29:35 +0000476 return nullptr;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000477
Rafael Espindola6de96a12009-01-15 20:18:42 +0000478 assert(GV->hasLocalLinkage() && !GV->isConstant());
Chris Lattnerabab0712004-10-08 17:32:09 +0000479 Constant *Init = GV->getInitializer();
Chris Lattner229907c2011-07-18 04:54:35 +0000480 Type *Ty = Init->getType();
Misha Brukmanb1c93172005-04-21 23:48:37 +0000481
Chris Lattnerabab0712004-10-08 17:32:09 +0000482 std::vector<GlobalVariable*> NewGlobals;
483 Module::GlobalListType &Globals = GV->getParent()->getGlobalList();
484
Chris Lattner67ca6f632008-04-26 07:40:11 +0000485 // Get the alignment of the global, either explicit or target-specific.
486 unsigned StartAlignment = GV->getAlignment();
487 if (StartAlignment == 0)
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000488 StartAlignment = DL.getABITypeAlignment(GV->getType());
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000489
Chris Lattner229907c2011-07-18 04:54:35 +0000490 if (StructType *STy = dyn_cast<StructType>(Ty)) {
Chris Lattnerabab0712004-10-08 17:32:09 +0000491 NewGlobals.reserve(STy->getNumElements());
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000492 const StructLayout &Layout = *DL.getStructLayout(STy);
Chris Lattnerabab0712004-10-08 17:32:09 +0000493 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
Chris Lattner67058832012-01-25 06:48:06 +0000494 Constant *In = Init->getAggregateElement(i);
Chris Lattnerabab0712004-10-08 17:32:09 +0000495 assert(In && "Couldn't get element of initializer?");
Chris Lattner46b5c642009-11-06 04:27:31 +0000496 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(i), false,
Chris Lattnerabab0712004-10-08 17:32:09 +0000497 GlobalVariable::InternalLinkage,
Daniel Dunbar132f7832009-07-30 17:37:43 +0000498 In, GV->getName()+"."+Twine(i),
Hans Wennborgcbe34b42012-06-23 11:37:03 +0000499 GV->getThreadLocalMode(),
Owen Anderson5948fdf2009-07-08 01:26:06 +0000500 GV->getType()->getAddressSpace());
Oliver Stannardc1103392015-11-09 16:47:16 +0000501 NGV->setExternallyInitialized(GV->isExternallyInitialized());
Rafael Espindolae4ed0e52015-12-22 19:16:50 +0000502 Globals.push_back(NGV);
Chris Lattnerabab0712004-10-08 17:32:09 +0000503 NewGlobals.push_back(NGV);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000504
Chris Lattner67ca6f632008-04-26 07:40:11 +0000505 // Calculate the known alignment of the field. If the original aggregate
506 // had 256 byte alignment for example, something might depend on that:
507 // propagate info to each field.
508 uint64_t FieldOffset = Layout.getElementOffset(i);
509 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, FieldOffset);
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000510 if (NewAlign > DL.getABITypeAlignment(STy->getElementType(i)))
Chris Lattner67ca6f632008-04-26 07:40:11 +0000511 NGV->setAlignment(NewAlign);
Chris Lattnerabab0712004-10-08 17:32:09 +0000512 }
Chris Lattner229907c2011-07-18 04:54:35 +0000513 } else if (SequentialType *STy = dyn_cast<SequentialType>(Ty)) {
Chris Lattnerabab0712004-10-08 17:32:09 +0000514 unsigned NumElements = 0;
Chris Lattner229907c2011-07-18 04:54:35 +0000515 if (ArrayType *ATy = dyn_cast<ArrayType>(STy))
Chris Lattnerabab0712004-10-08 17:32:09 +0000516 NumElements = ATy->getNumElements();
Chris Lattnerabab0712004-10-08 17:32:09 +0000517 else
Chris Lattner67ca6f632008-04-26 07:40:11 +0000518 NumElements = cast<VectorType>(STy)->getNumElements();
Chris Lattnerabab0712004-10-08 17:32:09 +0000519
Chris Lattner25169ca2005-02-23 16:53:04 +0000520 if (NumElements > 16 && GV->hasNUsesOrMore(16))
Craig Topperf40110f2014-04-25 05:29:35 +0000521 return nullptr; // It's not worth it.
Chris Lattnerabab0712004-10-08 17:32:09 +0000522 NewGlobals.reserve(NumElements);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000523
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000524 uint64_t EltSize = DL.getTypeAllocSize(STy->getElementType());
525 unsigned EltAlign = DL.getABITypeAlignment(STy->getElementType());
Chris Lattnerabab0712004-10-08 17:32:09 +0000526 for (unsigned i = 0, e = NumElements; i != e; ++i) {
Chris Lattner67058832012-01-25 06:48:06 +0000527 Constant *In = Init->getAggregateElement(i);
Chris Lattnerabab0712004-10-08 17:32:09 +0000528 assert(In && "Couldn't get element of initializer?");
529
Chris Lattner46b5c642009-11-06 04:27:31 +0000530 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(), false,
Chris Lattnerabab0712004-10-08 17:32:09 +0000531 GlobalVariable::InternalLinkage,
Daniel Dunbar132f7832009-07-30 17:37:43 +0000532 In, GV->getName()+"."+Twine(i),
Hans Wennborgcbe34b42012-06-23 11:37:03 +0000533 GV->getThreadLocalMode(),
Owen Andersonb17f3292009-07-08 19:03:57 +0000534 GV->getType()->getAddressSpace());
Oliver Stannardc1103392015-11-09 16:47:16 +0000535 NGV->setExternallyInitialized(GV->isExternallyInitialized());
Rafael Espindolae4ed0e52015-12-22 19:16:50 +0000536 Globals.push_back(NGV);
Chris Lattnerabab0712004-10-08 17:32:09 +0000537 NewGlobals.push_back(NGV);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000538
Chris Lattner67ca6f632008-04-26 07:40:11 +0000539 // Calculate the known alignment of the field. If the original aggregate
540 // had 256 byte alignment for example, something might depend on that:
541 // propagate info to each field.
542 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, EltSize*i);
543 if (NewAlign > EltAlign)
544 NGV->setAlignment(NewAlign);
Chris Lattnerabab0712004-10-08 17:32:09 +0000545 }
546 }
547
548 if (NewGlobals.empty())
Craig Topperf40110f2014-04-25 05:29:35 +0000549 return nullptr;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000550
James Molloyef607a22015-10-28 14:30:53 +0000551 DEBUG(dbgs() << "PERFORMING GLOBAL SRA ON: " << *GV << "\n");
Chris Lattner004e2502004-10-11 05:54:41 +0000552
Chris Lattner46b5c642009-11-06 04:27:31 +0000553 Constant *NullInt =Constant::getNullValue(Type::getInt32Ty(GV->getContext()));
Chris Lattnerabab0712004-10-08 17:32:09 +0000554
555 // Loop over all of the uses of the global, replacing the constantexpr geps,
556 // with smaller constantexpr geps or direct references.
557 while (!GV->use_empty()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000558 User *GEP = GV->user_back();
Chris Lattner004e2502004-10-11 05:54:41 +0000559 assert(((isa<ConstantExpr>(GEP) &&
560 cast<ConstantExpr>(GEP)->getOpcode()==Instruction::GetElementPtr)||
561 isa<GetElementPtrInst>(GEP)) && "NonGEP CE's are not SRAable!");
Misha Brukmanb1c93172005-04-21 23:48:37 +0000562
Chris Lattnerabab0712004-10-08 17:32:09 +0000563 // Ignore the 1th operand, which has to be zero or else the program is quite
564 // broken (undefined). Get the 2nd operand, which is the structure or array
565 // index.
Reid Spencere0fc4df2006-10-20 07:07:24 +0000566 unsigned Val = cast<ConstantInt>(GEP->getOperand(2))->getZExtValue();
Chris Lattnerabab0712004-10-08 17:32:09 +0000567 if (Val >= NewGlobals.size()) Val = 0; // Out of bound array access.
568
Chris Lattner004e2502004-10-11 05:54:41 +0000569 Value *NewPtr = NewGlobals[Val];
David Blaikied9d900c2015-05-07 17:28:58 +0000570 Type *NewTy = NewGlobals[Val]->getValueType();
Chris Lattnerabab0712004-10-08 17:32:09 +0000571
572 // Form a shorter GEP if needed.
Anton Korobeynikov1bfd1212008-02-20 11:26:25 +0000573 if (GEP->getNumOperands() > 3) {
Chris Lattner004e2502004-10-11 05:54:41 +0000574 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEP)) {
Chris Lattnerf96f4a82007-01-31 04:40:53 +0000575 SmallVector<Constant*, 8> Idxs;
Chris Lattner004e2502004-10-11 05:54:41 +0000576 Idxs.push_back(NullInt);
577 for (unsigned i = 3, e = CE->getNumOperands(); i != e; ++i)
578 Idxs.push_back(CE->getOperand(i));
David Blaikie4a2e73b2015-04-02 18:55:32 +0000579 NewPtr =
580 ConstantExpr::getGetElementPtr(NewTy, cast<Constant>(NewPtr), Idxs);
Chris Lattner004e2502004-10-11 05:54:41 +0000581 } else {
582 GetElementPtrInst *GEPI = cast<GetElementPtrInst>(GEP);
Chris Lattner927653f2007-01-31 19:59:55 +0000583 SmallVector<Value*, 8> Idxs;
Chris Lattner004e2502004-10-11 05:54:41 +0000584 Idxs.push_back(NullInt);
585 for (unsigned i = 3, e = GEPI->getNumOperands(); i != e; ++i)
586 Idxs.push_back(GEPI->getOperand(i));
David Blaikie741c8f82015-03-14 01:53:18 +0000587 NewPtr = GetElementPtrInst::Create(
David Blaikied9d900c2015-05-07 17:28:58 +0000588 NewTy, NewPtr, Idxs, GEPI->getName() + "." + Twine(Val), GEPI);
Chris Lattner004e2502004-10-11 05:54:41 +0000589 }
Anton Korobeynikov1bfd1212008-02-20 11:26:25 +0000590 }
Chris Lattner004e2502004-10-11 05:54:41 +0000591 GEP->replaceAllUsesWith(NewPtr);
592
593 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(GEP))
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000594 GEPI->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000595 else
596 cast<ConstantExpr>(GEP)->destroyConstant();
Chris Lattnerabab0712004-10-08 17:32:09 +0000597 }
598
Chris Lattner73ad73e2004-10-08 20:25:55 +0000599 // Delete the old global, now that it is dead.
600 Globals.erase(GV);
Chris Lattnerabab0712004-10-08 17:32:09 +0000601 ++NumSRA;
Chris Lattner004e2502004-10-11 05:54:41 +0000602
603 // Loop over the new globals array deleting any globals that are obviously
604 // dead. This can arise due to scalarization of a structure or an array that
605 // has elements that are dead.
606 unsigned FirstGlobal = 0;
607 for (unsigned i = 0, e = NewGlobals.size(); i != e; ++i)
608 if (NewGlobals[i]->use_empty()) {
609 Globals.erase(NewGlobals[i]);
610 if (FirstGlobal == i) ++FirstGlobal;
611 }
612
Craig Topperf40110f2014-04-25 05:29:35 +0000613 return FirstGlobal != NewGlobals.size() ? NewGlobals[FirstGlobal] : nullptr;
Chris Lattnerabab0712004-10-08 17:32:09 +0000614}
615
James Molloyea31ad32015-11-13 11:05:07 +0000616/// Return true if all users of the specified value will trap if the value is
617/// dynamically null. PHIs keeps track of any phi nodes we've seen to avoid
618/// reprocessing them.
Gabor Greif67972872010-04-06 19:24:18 +0000619static bool AllUsesOfValueWillTrapIfNull(const Value *V,
Craig Topper71b7b682014-08-21 05:55:13 +0000620 SmallPtrSetImpl<const PHINode*> &PHIs) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000621 for (const User *U : V->users())
Gabor Greif08355d62010-04-06 19:14:05 +0000622 if (isa<LoadInst>(U)) {
Chris Lattner09a52722004-10-09 21:48:45 +0000623 // Will trap.
Gabor Greif67972872010-04-06 19:24:18 +0000624 } else if (const StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattner09a52722004-10-09 21:48:45 +0000625 if (SI->getOperand(0) == V) {
Gabor Greif08355d62010-04-06 19:14:05 +0000626 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000627 return false; // Storing the value.
628 }
Gabor Greif67972872010-04-06 19:24:18 +0000629 } else if (const CallInst *CI = dyn_cast<CallInst>(U)) {
Gabor Greiffebf6ab2010-03-20 21:00:25 +0000630 if (CI->getCalledValue() != V) {
Gabor Greif08355d62010-04-06 19:14:05 +0000631 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000632 return false; // Not calling the ptr
633 }
Gabor Greif67972872010-04-06 19:24:18 +0000634 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(U)) {
Gabor Greiffebf6ab2010-03-20 21:00:25 +0000635 if (II->getCalledValue() != V) {
Gabor Greif08355d62010-04-06 19:14:05 +0000636 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000637 return false; // Not calling the ptr
638 }
Gabor Greif67972872010-04-06 19:24:18 +0000639 } else if (const BitCastInst *CI = dyn_cast<BitCastInst>(U)) {
Chris Lattner2d2892e2007-09-13 16:30:19 +0000640 if (!AllUsesOfValueWillTrapIfNull(CI, PHIs)) return false;
Gabor Greif67972872010-04-06 19:24:18 +0000641 } else if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner2d2892e2007-09-13 16:30:19 +0000642 if (!AllUsesOfValueWillTrapIfNull(GEPI, PHIs)) return false;
Gabor Greif67972872010-04-06 19:24:18 +0000643 } else if (const PHINode *PN = dyn_cast<PHINode>(U)) {
Chris Lattner2d2892e2007-09-13 16:30:19 +0000644 // If we've already seen this phi node, ignore it, it has already been
645 // checked.
David Blaikie70573dc2014-11-19 07:49:26 +0000646 if (PHIs.insert(PN).second && !AllUsesOfValueWillTrapIfNull(PN, PHIs))
Jakob Stoklund Olesene27dc722010-01-29 23:54:14 +0000647 return false;
Gabor Greif08355d62010-04-06 19:14:05 +0000648 } else if (isa<ICmpInst>(U) &&
Chandler Carruthcdf47882014-03-09 03:16:01 +0000649 isa<ConstantPointerNull>(U->getOperand(1))) {
Nick Lewycky614fb942010-02-25 06:39:10 +0000650 // Ignore icmp X, null
Chris Lattner09a52722004-10-09 21:48:45 +0000651 } else {
Gabor Greif08355d62010-04-06 19:14:05 +0000652 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000653 return false;
654 }
Chandler Carruthcdf47882014-03-09 03:16:01 +0000655
Chris Lattner09a52722004-10-09 21:48:45 +0000656 return true;
657}
658
James Molloyea31ad32015-11-13 11:05:07 +0000659/// Return true if all uses of any loads from GV will trap if the loaded value
660/// is null. Note that this also permits comparisons of the loaded value
661/// against null, as a special case.
Gabor Greif67972872010-04-06 19:24:18 +0000662static bool AllUsesOfLoadedValueWillTrapIfNull(const GlobalVariable *GV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000663 for (const User *U : GV->users())
Gabor Greif67972872010-04-06 19:24:18 +0000664 if (const LoadInst *LI = dyn_cast<LoadInst>(U)) {
665 SmallPtrSet<const PHINode*, 8> PHIs;
Chris Lattner2d2892e2007-09-13 16:30:19 +0000666 if (!AllUsesOfValueWillTrapIfNull(LI, PHIs))
Chris Lattner09a52722004-10-09 21:48:45 +0000667 return false;
Gabor Greif08355d62010-04-06 19:14:05 +0000668 } else if (isa<StoreInst>(U)) {
Chris Lattner09a52722004-10-09 21:48:45 +0000669 // Ignore stores to the global.
670 } else {
671 // We don't know or understand this user, bail out.
Gabor Greif08355d62010-04-06 19:14:05 +0000672 //cerr << "UNKNOWN USER OF GLOBAL!: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000673 return false;
674 }
Chris Lattner09a52722004-10-09 21:48:45 +0000675 return true;
676}
677
Chris Lattner46b5c642009-11-06 04:27:31 +0000678static bool OptimizeAwayTrappingUsesOfValue(Value *V, Constant *NewV) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000679 bool Changed = false;
Chandler Carruthcdf47882014-03-09 03:16:01 +0000680 for (auto UI = V->user_begin(), E = V->user_end(); UI != E; ) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000681 Instruction *I = cast<Instruction>(*UI++);
682 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
683 LI->setOperand(0, NewV);
684 Changed = true;
685 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
686 if (SI->getOperand(1) == V) {
687 SI->setOperand(1, NewV);
688 Changed = true;
689 }
690 } else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
Gabor Greif04397892010-04-06 18:45:08 +0000691 CallSite CS(I);
692 if (CS.getCalledValue() == V) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000693 // Calling through the pointer! Turn into a direct call, but be careful
694 // that the pointer is not also being passed as an argument.
Gabor Greif04397892010-04-06 18:45:08 +0000695 CS.setCalledFunction(NewV);
Chris Lattnere42eb312004-10-10 23:14:11 +0000696 Changed = true;
697 bool PassedAsArg = false;
Gabor Greif04397892010-04-06 18:45:08 +0000698 for (unsigned i = 0, e = CS.arg_size(); i != e; ++i)
699 if (CS.getArgument(i) == V) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000700 PassedAsArg = true;
Gabor Greif04397892010-04-06 18:45:08 +0000701 CS.setArgument(i, NewV);
Chris Lattnere42eb312004-10-10 23:14:11 +0000702 }
703
704 if (PassedAsArg) {
705 // Being passed as an argument also. Be careful to not invalidate UI!
Chandler Carruthcdf47882014-03-09 03:16:01 +0000706 UI = V->user_begin();
Chris Lattnere42eb312004-10-10 23:14:11 +0000707 }
708 }
709 } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
710 Changed |= OptimizeAwayTrappingUsesOfValue(CI,
Owen Anderson487375e2009-07-29 18:55:55 +0000711 ConstantExpr::getCast(CI->getOpcode(),
Chris Lattner46b5c642009-11-06 04:27:31 +0000712 NewV, CI->getType()));
Chris Lattnere42eb312004-10-10 23:14:11 +0000713 if (CI->use_empty()) {
714 Changed = true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000715 CI->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000716 }
717 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
718 // Should handle GEP here.
Chris Lattnerf96f4a82007-01-31 04:40:53 +0000719 SmallVector<Constant*, 8> Idxs;
720 Idxs.reserve(GEPI->getNumOperands()-1);
Gabor Greif3a9fba52008-05-29 01:59:18 +0000721 for (User::op_iterator i = GEPI->op_begin() + 1, e = GEPI->op_end();
722 i != e; ++i)
723 if (Constant *C = dyn_cast<Constant>(*i))
Chris Lattnerf96f4a82007-01-31 04:40:53 +0000724 Idxs.push_back(C);
Chris Lattnere42eb312004-10-10 23:14:11 +0000725 else
726 break;
Chris Lattnerf96f4a82007-01-31 04:40:53 +0000727 if (Idxs.size() == GEPI->getNumOperands()-1)
David Blaikie4a2e73b2015-04-02 18:55:32 +0000728 Changed |= OptimizeAwayTrappingUsesOfValue(
729 GEPI, ConstantExpr::getGetElementPtr(nullptr, NewV, Idxs));
Chris Lattnere42eb312004-10-10 23:14:11 +0000730 if (GEPI->use_empty()) {
731 Changed = true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000732 GEPI->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000733 }
734 }
735 }
736
737 return Changed;
738}
739
740
James Molloyea31ad32015-11-13 11:05:07 +0000741/// The specified global has only one non-null value stored into it. If there
742/// are uses of the loaded value that would trap if the loaded value is
743/// dynamically null, then we know that they cannot be reachable with a null
744/// optimize away the load.
Nick Lewyckycf6aae62012-02-12 01:13:18 +0000745static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV,
Mehdi Amini46a43552015-03-04 18:43:29 +0000746 const DataLayout &DL,
Nick Lewyckycf6aae62012-02-12 01:13:18 +0000747 TargetLibraryInfo *TLI) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000748 bool Changed = false;
749
Chris Lattner2538eb62009-01-14 00:12:58 +0000750 // Keep track of whether we are able to remove all the uses of the global
751 // other than the store that defines it.
752 bool AllNonStoreUsesGone = true;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000753
Chris Lattnere42eb312004-10-10 23:14:11 +0000754 // Replace all uses of loads with uses of uses of the stored value.
Chandler Carruthcdf47882014-03-09 03:16:01 +0000755 for (Value::user_iterator GUI = GV->user_begin(), E = GV->user_end(); GUI != E;){
Chris Lattner2538eb62009-01-14 00:12:58 +0000756 User *GlobalUser = *GUI++;
757 if (LoadInst *LI = dyn_cast<LoadInst>(GlobalUser)) {
Chris Lattner46b5c642009-11-06 04:27:31 +0000758 Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV);
Chris Lattner2538eb62009-01-14 00:12:58 +0000759 // If we were able to delete all uses of the loads
760 if (LI->use_empty()) {
761 LI->eraseFromParent();
762 Changed = true;
763 } else {
764 AllNonStoreUsesGone = false;
765 }
766 } else if (isa<StoreInst>(GlobalUser)) {
767 // Ignore the store that stores "LV" to the global.
768 assert(GlobalUser->getOperand(1) == GV &&
769 "Must be storing *to* the global");
Chris Lattnere42eb312004-10-10 23:14:11 +0000770 } else {
Chris Lattner2538eb62009-01-14 00:12:58 +0000771 AllNonStoreUsesGone = false;
772
773 // If we get here we could have other crazy uses that are transitively
774 // loaded.
775 assert((isa<PHINode>(GlobalUser) || isa<SelectInst>(GlobalUser) ||
Benjamin Kramered843602012-09-28 10:01:27 +0000776 isa<ConstantExpr>(GlobalUser) || isa<CmpInst>(GlobalUser) ||
777 isa<BitCastInst>(GlobalUser) ||
778 isa<GetElementPtrInst>(GlobalUser)) &&
Chris Lattner1a1acc22011-05-22 07:15:13 +0000779 "Only expect load and stores!");
Chris Lattnere42eb312004-10-10 23:14:11 +0000780 }
Chris Lattner2538eb62009-01-14 00:12:58 +0000781 }
Chris Lattnere42eb312004-10-10 23:14:11 +0000782
783 if (Changed) {
James Molloyef607a22015-10-28 14:30:53 +0000784 DEBUG(dbgs() << "OPTIMIZED LOADS FROM STORED ONCE POINTER: " << *GV << "\n");
Chris Lattnere42eb312004-10-10 23:14:11 +0000785 ++NumGlobUses;
786 }
787
Chris Lattnere42eb312004-10-10 23:14:11 +0000788 // If we nuked all of the loads, then none of the stores are needed either,
789 // nor is the global.
Chris Lattner2538eb62009-01-14 00:12:58 +0000790 if (AllNonStoreUsesGone) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000791 if (isLeakCheckerRoot(GV)) {
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000792 Changed |= CleanupPointerRootUsers(GV, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000793 } else {
794 Changed = true;
Craig Topperf40110f2014-04-25 05:29:35 +0000795 CleanupConstantGlobalUsers(GV, nullptr, DL, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000796 }
Chris Lattnere42eb312004-10-10 23:14:11 +0000797 if (GV->use_empty()) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000798 DEBUG(dbgs() << " *** GLOBAL NOW DEAD!\n");
799 Changed = true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000800 GV->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000801 ++NumDeleted;
802 }
Chris Lattnere42eb312004-10-10 23:14:11 +0000803 }
804 return Changed;
805}
806
James Molloyea31ad32015-11-13 11:05:07 +0000807/// Walk the use list of V, constant folding all of the instructions that are
808/// foldable.
Mehdi Amini46a43552015-03-04 18:43:29 +0000809static void ConstantPropUsersOf(Value *V, const DataLayout &DL,
Rafael Espindolaaeff8a92014-02-24 23:12:18 +0000810 TargetLibraryInfo *TLI) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000811 for (Value::user_iterator UI = V->user_begin(), E = V->user_end(); UI != E; )
Chris Lattner004e2502004-10-11 05:54:41 +0000812 if (Instruction *I = dyn_cast<Instruction>(*UI++))
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000813 if (Constant *NewC = ConstantFoldInstruction(I, DL, TLI)) {
Chris Lattner004e2502004-10-11 05:54:41 +0000814 I->replaceAllUsesWith(NewC);
815
Chris Lattnerd6a44922005-02-01 01:23:31 +0000816 // Advance UI to the next non-I use to avoid invalidating it!
817 // Instructions could multiply use V.
818 while (UI != E && *UI == I)
Chris Lattner004e2502004-10-11 05:54:41 +0000819 ++UI;
Chris Lattnerd6a44922005-02-01 01:23:31 +0000820 I->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000821 }
822}
823
James Molloyea31ad32015-11-13 11:05:07 +0000824/// This function takes the specified global variable, and transforms the
825/// program as if it always contained the result of the specified malloc.
826/// Because it is always the result of the specified malloc, there is no reason
827/// to actually DO the malloc. Instead, turn the malloc into a global, and any
828/// loads of GV as uses of the new global.
Mehdi Amini46a43552015-03-04 18:43:29 +0000829static GlobalVariable *
830OptimizeGlobalAddressOfMalloc(GlobalVariable *GV, CallInst *CI, Type *AllocTy,
831 ConstantInt *NElements, const DataLayout &DL,
832 TargetLibraryInfo *TLI) {
Chris Lattner7939f792010-02-25 22:33:52 +0000833 DEBUG(errs() << "PROMOTING GLOBAL: " << *GV << " CALL = " << *CI << '\n');
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000834
Chris Lattner229907c2011-07-18 04:54:35 +0000835 Type *GlobalType;
Chris Lattner7939f792010-02-25 22:33:52 +0000836 if (NElements->getZExtValue() == 1)
837 GlobalType = AllocTy;
838 else
839 // If we have an array allocation, the global variable is of an array.
840 GlobalType = ArrayType::get(AllocTy, NElements->getZExtValue());
Victor Hernandez5d034492009-09-18 22:35:49 +0000841
842 // Create the new global variable. The contents of the malloc'd memory is
843 // undefined, so initialize with an undef value.
Rafael Espindolae4ed0e52015-12-22 19:16:50 +0000844 GlobalVariable *NewGV = new GlobalVariable(
845 *GV->getParent(), GlobalType, false, GlobalValue::InternalLinkage,
846 UndefValue::get(GlobalType), GV->getName() + ".body", nullptr,
847 GV->getThreadLocalMode());
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000848
Chris Lattner7939f792010-02-25 22:33:52 +0000849 // If there are bitcast users of the malloc (which is typical, usually we have
850 // a malloc + bitcast) then replace them with uses of the new global. Update
851 // other users to use the global as well.
Craig Topperf40110f2014-04-25 05:29:35 +0000852 BitCastInst *TheBC = nullptr;
Chris Lattner7939f792010-02-25 22:33:52 +0000853 while (!CI->use_empty()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000854 Instruction *User = cast<Instruction>(CI->user_back());
Chris Lattner7939f792010-02-25 22:33:52 +0000855 if (BitCastInst *BCI = dyn_cast<BitCastInst>(User)) {
856 if (BCI->getType() == NewGV->getType()) {
857 BCI->replaceAllUsesWith(NewGV);
858 BCI->eraseFromParent();
859 } else {
860 BCI->setOperand(0, NewGV);
861 }
862 } else {
Craig Topperf40110f2014-04-25 05:29:35 +0000863 if (!TheBC)
Chris Lattner7939f792010-02-25 22:33:52 +0000864 TheBC = new BitCastInst(NewGV, CI->getType(), "newgv", CI);
865 User->replaceUsesOfWith(CI, TheBC);
866 }
867 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000868
Victor Hernandez5d034492009-09-18 22:35:49 +0000869 Constant *RepValue = NewGV;
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000870 if (NewGV->getType() != GV->getValueType())
871 RepValue = ConstantExpr::getBitCast(RepValue, GV->getValueType());
Victor Hernandez5d034492009-09-18 22:35:49 +0000872
873 // If there is a comparison against null, we will insert a global bool to
874 // keep track of whether the global was initialized yet or not.
875 GlobalVariable *InitBool =
Chris Lattner46b5c642009-11-06 04:27:31 +0000876 new GlobalVariable(Type::getInt1Ty(GV->getContext()), false,
Victor Hernandez5d034492009-09-18 22:35:49 +0000877 GlobalValue::InternalLinkage,
Chris Lattner46b5c642009-11-06 04:27:31 +0000878 ConstantInt::getFalse(GV->getContext()),
Hans Wennborgcbe34b42012-06-23 11:37:03 +0000879 GV->getName()+".init", GV->getThreadLocalMode());
Victor Hernandez5d034492009-09-18 22:35:49 +0000880 bool InitBoolUsed = false;
881
882 // Loop over all uses of GV, processing them in turn.
Chris Lattner7939f792010-02-25 22:33:52 +0000883 while (!GV->use_empty()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000884 if (StoreInst *SI = dyn_cast<StoreInst>(GV->user_back())) {
Victor Hernandez5d034492009-09-18 22:35:49 +0000885 // The global is initialized when the store to it occurs.
Nick Lewycky52da72b2012-02-05 19:56:38 +0000886 new StoreInst(ConstantInt::getTrue(GV->getContext()), InitBool, false, 0,
887 SI->getOrdering(), SI->getSynchScope(), SI);
Victor Hernandez5d034492009-09-18 22:35:49 +0000888 SI->eraseFromParent();
Chris Lattner7939f792010-02-25 22:33:52 +0000889 continue;
Victor Hernandez5d034492009-09-18 22:35:49 +0000890 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000891
Chandler Carruthcdf47882014-03-09 03:16:01 +0000892 LoadInst *LI = cast<LoadInst>(GV->user_back());
Chris Lattner7939f792010-02-25 22:33:52 +0000893 while (!LI->use_empty()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000894 Use &LoadUse = *LI->use_begin();
895 ICmpInst *ICI = dyn_cast<ICmpInst>(LoadUse.getUser());
896 if (!ICI) {
Chris Lattner7939f792010-02-25 22:33:52 +0000897 LoadUse = RepValue;
898 continue;
899 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000900
Chris Lattner7939f792010-02-25 22:33:52 +0000901 // Replace the cmp X, 0 with a use of the bool value.
Nick Lewycky52da72b2012-02-05 19:56:38 +0000902 // Sink the load to where the compare was, if atomic rules allow us to.
903 Value *LV = new LoadInst(InitBool, InitBool->getName()+".val", false, 0,
904 LI->getOrdering(), LI->getSynchScope(),
905 LI->isUnordered() ? (Instruction*)ICI : LI);
Chris Lattner7939f792010-02-25 22:33:52 +0000906 InitBoolUsed = true;
907 switch (ICI->getPredicate()) {
908 default: llvm_unreachable("Unknown ICmp Predicate!");
909 case ICmpInst::ICMP_ULT:
910 case ICmpInst::ICMP_SLT: // X < null -> always false
911 LV = ConstantInt::getFalse(GV->getContext());
912 break;
913 case ICmpInst::ICMP_ULE:
914 case ICmpInst::ICMP_SLE:
915 case ICmpInst::ICMP_EQ:
916 LV = BinaryOperator::CreateNot(LV, "notinit", ICI);
917 break;
918 case ICmpInst::ICMP_NE:
919 case ICmpInst::ICMP_UGE:
920 case ICmpInst::ICMP_SGE:
921 case ICmpInst::ICMP_UGT:
922 case ICmpInst::ICMP_SGT:
923 break; // no change.
924 }
925 ICI->replaceAllUsesWith(LV);
926 ICI->eraseFromParent();
927 }
928 LI->eraseFromParent();
929 }
Victor Hernandez5d034492009-09-18 22:35:49 +0000930
931 // If the initialization boolean was used, insert it, otherwise delete it.
932 if (!InitBoolUsed) {
933 while (!InitBool->use_empty()) // Delete initializations
Chandler Carruthcdf47882014-03-09 03:16:01 +0000934 cast<StoreInst>(InitBool->user_back())->eraseFromParent();
Victor Hernandez5d034492009-09-18 22:35:49 +0000935 delete InitBool;
936 } else
Duncan P. N. Exon Smith17323402015-10-13 17:51:03 +0000937 GV->getParent()->getGlobalList().insert(GV->getIterator(), InitBool);
Victor Hernandez5d034492009-09-18 22:35:49 +0000938
Chris Lattner7939f792010-02-25 22:33:52 +0000939 // Now the GV is dead, nuke it and the malloc..
Victor Hernandez5d034492009-09-18 22:35:49 +0000940 GV->eraseFromParent();
Victor Hernandez5d034492009-09-18 22:35:49 +0000941 CI->eraseFromParent();
942
943 // To further other optimizations, loop over all users of NewGV and try to
944 // constant prop them. This will promote GEP instructions with constant
945 // indices into GEP constant-exprs, which will allow global-opt to hack on it.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000946 ConstantPropUsersOf(NewGV, DL, TLI);
Victor Hernandez5d034492009-09-18 22:35:49 +0000947 if (RepValue != NewGV)
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000948 ConstantPropUsersOf(RepValue, DL, TLI);
Victor Hernandez5d034492009-09-18 22:35:49 +0000949
950 return NewGV;
951}
952
James Molloyea31ad32015-11-13 11:05:07 +0000953/// Scan the use-list of V checking to make sure that there are no complex uses
954/// of V. We permit simple things like dereferencing the pointer, but not
955/// storing through the address, unless it is to the specified global.
Gabor Greifa21bc0f2010-04-06 18:58:22 +0000956static bool ValueIsOnlyUsedLocallyOrStoredToOneGlobal(const Instruction *V,
957 const GlobalVariable *GV,
Craig Topper71b7b682014-08-21 05:55:13 +0000958 SmallPtrSetImpl<const PHINode*> &PHIs) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000959 for (const User *U : V->users()) {
960 const Instruction *Inst = cast<Instruction>(U);
Gabor Greif08355d62010-04-06 19:14:05 +0000961
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000962 if (isa<LoadInst>(Inst) || isa<CmpInst>(Inst)) {
963 continue; // Fine, ignore.
964 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000965
Gabor Greifa21bc0f2010-04-06 18:58:22 +0000966 if (const StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
Chris Lattnerc0677c02004-12-02 07:11:07 +0000967 if (SI->getOperand(0) == V && SI->getOperand(1) != GV)
968 return false; // Storing the pointer itself... bad.
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000969 continue; // Otherwise, storing through it, or storing into GV... fine.
970 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000971
Chris Lattnerb9801ff2010-04-10 18:19:22 +0000972 // Must index into the array and into the struct.
973 if (isa<GetElementPtrInst>(Inst) && Inst->getNumOperands() >= 3) {
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000974 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Inst, GV, PHIs))
Chris Lattnerc0677c02004-12-02 07:11:07 +0000975 return false;
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000976 continue;
977 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000978
Gabor Greifa21bc0f2010-04-06 18:58:22 +0000979 if (const PHINode *PN = dyn_cast<PHINode>(Inst)) {
Chris Lattner6eed0e72007-09-13 16:37:20 +0000980 // PHIs are ok if all uses are ok. Don't infinitely recurse through PHI
981 // cycles.
David Blaikie70573dc2014-11-19 07:49:26 +0000982 if (PHIs.insert(PN).second)
Chris Lattner5d13fb532007-09-14 03:41:21 +0000983 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(PN, GV, PHIs))
984 return false;
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000985 continue;
Chris Lattnerc0677c02004-12-02 07:11:07 +0000986 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000987
Gabor Greifa21bc0f2010-04-06 18:58:22 +0000988 if (const BitCastInst *BCI = dyn_cast<BitCastInst>(Inst)) {
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000989 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(BCI, GV, PHIs))
990 return false;
991 continue;
992 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000993
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000994 return false;
995 }
Chris Lattnerc0677c02004-12-02 07:11:07 +0000996 return true;
Chris Lattnerc0677c02004-12-02 07:11:07 +0000997}
998
James Molloyea31ad32015-11-13 11:05:07 +0000999/// The Alloc pointer is stored into GV somewhere. Transform all uses of the
1000/// allocation into loads from the global and uses of the resultant pointer.
1001/// Further, delete the store into GV. This assumes that these value pass the
Chris Lattner24d3d422006-09-30 23:32:09 +00001002/// 'ValueIsOnlyUsedLocallyOrStoredToOneGlobal' predicate.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001003static void ReplaceUsesOfMallocWithGlobal(Instruction *Alloc,
Chris Lattner24d3d422006-09-30 23:32:09 +00001004 GlobalVariable *GV) {
1005 while (!Alloc->use_empty()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001006 Instruction *U = cast<Instruction>(*Alloc->user_begin());
Chris Lattnerba98f892007-09-13 18:00:31 +00001007 Instruction *InsertPt = U;
Chris Lattner24d3d422006-09-30 23:32:09 +00001008 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
1009 // If this is the store of the allocation into the global, remove it.
1010 if (SI->getOperand(1) == GV) {
1011 SI->eraseFromParent();
1012 continue;
1013 }
Chris Lattnerba98f892007-09-13 18:00:31 +00001014 } else if (PHINode *PN = dyn_cast<PHINode>(U)) {
1015 // Insert the load in the corresponding predecessor, not right before the
1016 // PHI.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001017 InsertPt = PN->getIncomingBlock(*Alloc->use_begin())->getTerminator();
Chris Lattner49e3bdc2008-12-15 21:44:34 +00001018 } else if (isa<BitCastInst>(U)) {
1019 // Must be bitcast between the malloc and store to initialize the global.
1020 ReplaceUsesOfMallocWithGlobal(U, GV);
1021 U->eraseFromParent();
1022 continue;
1023 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
1024 // If this is a "GEP bitcast" and the user is a store to the global, then
1025 // just process it as a bitcast.
1026 if (GEPI->hasAllZeroIndices() && GEPI->hasOneUse())
Chandler Carruthcdf47882014-03-09 03:16:01 +00001027 if (StoreInst *SI = dyn_cast<StoreInst>(GEPI->user_back()))
Chris Lattner49e3bdc2008-12-15 21:44:34 +00001028 if (SI->getOperand(1) == GV) {
1029 // Must be bitcast GEP between the malloc and store to initialize
1030 // the global.
1031 ReplaceUsesOfMallocWithGlobal(GEPI, GV);
1032 GEPI->eraseFromParent();
1033 continue;
1034 }
Chris Lattner24d3d422006-09-30 23:32:09 +00001035 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001036
Chris Lattner24d3d422006-09-30 23:32:09 +00001037 // Insert a load from the global, and use it instead of the malloc.
Chris Lattnerba98f892007-09-13 18:00:31 +00001038 Value *NL = new LoadInst(GV, GV->getName()+".val", InsertPt);
Chris Lattner24d3d422006-09-30 23:32:09 +00001039 U->replaceUsesOfWith(Alloc, NL);
1040 }
1041}
1042
James Molloyea31ad32015-11-13 11:05:07 +00001043/// Verify that all uses of V (a load, or a phi of a load) are simple enough to
1044/// perform heap SRA on. This permits GEP's that index through the array and
1045/// struct field, icmps of null, and PHIs.
Gabor Greif5d5db532010-04-01 08:21:08 +00001046static bool LoadUsesSimpleEnoughForHeapSRA(const Value *V,
Craig Topper71b7b682014-08-21 05:55:13 +00001047 SmallPtrSetImpl<const PHINode*> &LoadUsingPHIs,
1048 SmallPtrSetImpl<const PHINode*> &LoadUsingPHIsPerLoad) {
Chris Lattner56b55382008-12-16 21:24:51 +00001049 // We permit two users of the load: setcc comparing against the null
1050 // pointer, and a getelementptr of a specific form.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001051 for (const User *U : V->users()) {
1052 const Instruction *UI = cast<Instruction>(U);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001053
Chris Lattner56b55382008-12-16 21:24:51 +00001054 // Comparison against null is ok.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001055 if (const ICmpInst *ICI = dyn_cast<ICmpInst>(UI)) {
Chris Lattner56b55382008-12-16 21:24:51 +00001056 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
1057 return false;
1058 continue;
1059 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001060
Chris Lattner56b55382008-12-16 21:24:51 +00001061 // getelementptr is also ok, but only a simple form.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001062 if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(UI)) {
Chris Lattner56b55382008-12-16 21:24:51 +00001063 // Must index into the array and into the struct.
1064 if (GEPI->getNumOperands() < 3)
1065 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001066
Chris Lattner56b55382008-12-16 21:24:51 +00001067 // Otherwise the GEP is ok.
1068 continue;
1069 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001070
Chandler Carruthcdf47882014-03-09 03:16:01 +00001071 if (const PHINode *PN = dyn_cast<PHINode>(UI)) {
David Blaikie70573dc2014-11-19 07:49:26 +00001072 if (!LoadUsingPHIsPerLoad.insert(PN).second)
Evan Cheng83689442009-06-02 00:56:07 +00001073 // This means some phi nodes are dependent on each other.
1074 // Avoid infinite looping!
1075 return false;
David Blaikie70573dc2014-11-19 07:49:26 +00001076 if (!LoadUsingPHIs.insert(PN).second)
Evan Cheng83689442009-06-02 00:56:07 +00001077 // If we have already analyzed this PHI, then it is safe.
Chris Lattner56b55382008-12-16 21:24:51 +00001078 continue;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001079
Chris Lattner222ef4c2008-12-17 05:28:49 +00001080 // Make sure all uses of the PHI are simple enough to transform.
Evan Cheng83689442009-06-02 00:56:07 +00001081 if (!LoadUsesSimpleEnoughForHeapSRA(PN,
1082 LoadUsingPHIs, LoadUsingPHIsPerLoad))
Chris Lattner56b55382008-12-16 21:24:51 +00001083 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001084
Chris Lattner56b55382008-12-16 21:24:51 +00001085 continue;
Chris Lattner24d3d422006-09-30 23:32:09 +00001086 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001087
Chris Lattner56b55382008-12-16 21:24:51 +00001088 // Otherwise we don't know what this is, not ok.
1089 return false;
1090 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001091
Chris Lattner56b55382008-12-16 21:24:51 +00001092 return true;
1093}
1094
1095
James Molloyea31ad32015-11-13 11:05:07 +00001096/// If all users of values loaded from GV are simple enough to perform HeapSRA,
1097/// return true.
Gabor Greif5d5db532010-04-01 08:21:08 +00001098static bool AllGlobalLoadUsesSimpleEnoughForHeapSRA(const GlobalVariable *GV,
Victor Hernandez5d034492009-09-18 22:35:49 +00001099 Instruction *StoredVal) {
Gabor Greif5d5db532010-04-01 08:21:08 +00001100 SmallPtrSet<const PHINode*, 32> LoadUsingPHIs;
1101 SmallPtrSet<const PHINode*, 32> LoadUsingPHIsPerLoad;
Chandler Carruthcdf47882014-03-09 03:16:01 +00001102 for (const User *U : GV->users())
1103 if (const LoadInst *LI = dyn_cast<LoadInst>(U)) {
Evan Cheng83689442009-06-02 00:56:07 +00001104 if (!LoadUsesSimpleEnoughForHeapSRA(LI, LoadUsingPHIs,
1105 LoadUsingPHIsPerLoad))
Chris Lattner56b55382008-12-16 21:24:51 +00001106 return false;
Evan Cheng83689442009-06-02 00:56:07 +00001107 LoadUsingPHIsPerLoad.clear();
1108 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001109
Chris Lattner222ef4c2008-12-17 05:28:49 +00001110 // If we reach here, we know that all uses of the loads and transitive uses
1111 // (through PHI nodes) are simple enough to transform. However, we don't know
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001112 // that all inputs the to the PHI nodes are in the same equivalence sets.
Chris Lattner222ef4c2008-12-17 05:28:49 +00001113 // Check to verify that all operands of the PHIs are either PHIS that can be
1114 // transformed, loads from GV, or MI itself.
Craig Topper46276792014-08-24 23:23:06 +00001115 for (const PHINode *PN : LoadUsingPHIs) {
Chris Lattner222ef4c2008-12-17 05:28:49 +00001116 for (unsigned op = 0, e = PN->getNumIncomingValues(); op != e; ++op) {
1117 Value *InVal = PN->getIncomingValue(op);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001118
Chris Lattner222ef4c2008-12-17 05:28:49 +00001119 // PHI of the stored value itself is ok.
Victor Hernandez5d034492009-09-18 22:35:49 +00001120 if (InVal == StoredVal) continue;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001121
Gabor Greif5d5db532010-04-01 08:21:08 +00001122 if (const PHINode *InPN = dyn_cast<PHINode>(InVal)) {
Chris Lattner222ef4c2008-12-17 05:28:49 +00001123 // One of the PHIs in our set is (optimistically) ok.
1124 if (LoadUsingPHIs.count(InPN))
1125 continue;
1126 return false;
1127 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001128
Chris Lattner222ef4c2008-12-17 05:28:49 +00001129 // Load from GV is ok.
Gabor Greif5d5db532010-04-01 08:21:08 +00001130 if (const LoadInst *LI = dyn_cast<LoadInst>(InVal))
Chris Lattner222ef4c2008-12-17 05:28:49 +00001131 if (LI->getOperand(0) == GV)
1132 continue;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001133
Chris Lattner222ef4c2008-12-17 05:28:49 +00001134 // UNDEF? NULL?
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001135
Chris Lattner222ef4c2008-12-17 05:28:49 +00001136 // Anything else is rejected.
1137 return false;
1138 }
1139 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001140
Chris Lattner24d3d422006-09-30 23:32:09 +00001141 return true;
1142}
1143
Chris Lattner222ef4c2008-12-17 05:28:49 +00001144static Value *GetHeapSROAValue(Value *V, unsigned FieldNo,
1145 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001146 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattner222ef4c2008-12-17 05:28:49 +00001147 std::vector<Value*> &FieldVals = InsertedScalarizedValues[V];
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001148
Chris Lattner222ef4c2008-12-17 05:28:49 +00001149 if (FieldNo >= FieldVals.size())
1150 FieldVals.resize(FieldNo+1);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001151
Chris Lattner222ef4c2008-12-17 05:28:49 +00001152 // If we already have this value, just reuse the previously scalarized
1153 // version.
1154 if (Value *FieldVal = FieldVals[FieldNo])
1155 return FieldVal;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001156
Chris Lattner222ef4c2008-12-17 05:28:49 +00001157 // Depending on what instruction this is, we have several cases.
1158 Value *Result;
1159 if (LoadInst *LI = dyn_cast<LoadInst>(V)) {
1160 // This is a scalarized version of the load from the global. Just create
1161 // a new Load of the scalarized global.
1162 Result = new LoadInst(GetHeapSROAValue(LI->getOperand(0), FieldNo,
1163 InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001164 PHIsToRewrite),
Daniel Dunbar132f7832009-07-30 17:37:43 +00001165 LI->getName()+".f"+Twine(FieldNo), LI);
David Blaikie741c8f82015-03-14 01:53:18 +00001166 } else {
1167 PHINode *PN = cast<PHINode>(V);
Chris Lattner222ef4c2008-12-17 05:28:49 +00001168 // PN's type is pointer to struct. Make a new PHI of pointer to struct
1169 // field.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001170
Matt Arsenaultfcd74012014-04-23 20:36:10 +00001171 PointerType *PTy = cast<PointerType>(PN->getType());
1172 StructType *ST = cast<StructType>(PTy->getElementType());
1173
1174 unsigned AS = PTy->getAddressSpace();
Jay Foade0938d82011-03-30 11:19:20 +00001175 PHINode *NewPN =
Matt Arsenaultfcd74012014-04-23 20:36:10 +00001176 PHINode::Create(PointerType::get(ST->getElementType(FieldNo), AS),
Jay Foad52131342011-03-30 11:28:46 +00001177 PN->getNumIncomingValues(),
Daniel Dunbar132f7832009-07-30 17:37:43 +00001178 PN->getName()+".f"+Twine(FieldNo), PN);
Jay Foade0938d82011-03-30 11:19:20 +00001179 Result = NewPN;
Chris Lattner222ef4c2008-12-17 05:28:49 +00001180 PHIsToRewrite.push_back(std::make_pair(PN, FieldNo));
Chris Lattner222ef4c2008-12-17 05:28:49 +00001181 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001182
Chris Lattner222ef4c2008-12-17 05:28:49 +00001183 return FieldVals[FieldNo] = Result;
Chris Lattnerba98f892007-09-13 18:00:31 +00001184}
1185
James Molloyea31ad32015-11-13 11:05:07 +00001186/// Given a load instruction and a value derived from the load, rewrite the
1187/// derived value to use the HeapSRoA'd load.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001188static void RewriteHeapSROALoadUser(Instruction *LoadUser,
Chris Lattner222ef4c2008-12-17 05:28:49 +00001189 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001190 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattnerf315d4f2007-09-13 17:29:05 +00001191 // If this is a comparison against null, handle it.
1192 if (ICmpInst *SCI = dyn_cast<ICmpInst>(LoadUser)) {
1193 assert(isa<ConstantPointerNull>(SCI->getOperand(1)));
1194 // If we have a setcc of the loaded pointer, we can use a setcc of any
1195 // field.
Chris Lattner222ef4c2008-12-17 05:28:49 +00001196 Value *NPtr = GetHeapSROAValue(SCI->getOperand(0), 0,
Chris Lattner46b5c642009-11-06 04:27:31 +00001197 InsertedScalarizedValues, PHIsToRewrite);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001198
Owen Anderson1e5f00e2009-07-09 23:48:35 +00001199 Value *New = new ICmpInst(SCI, SCI->getPredicate(), NPtr,
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001200 Constant::getNullValue(NPtr->getType()),
Owen Anderson1e5f00e2009-07-09 23:48:35 +00001201 SCI->getName());
Chris Lattnerf315d4f2007-09-13 17:29:05 +00001202 SCI->replaceAllUsesWith(New);
1203 SCI->eraseFromParent();
1204 return;
1205 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001206
Chris Lattner222ef4c2008-12-17 05:28:49 +00001207 // Handle 'getelementptr Ptr, Idx, i32 FieldNo ...'
Chris Lattnerba98f892007-09-13 18:00:31 +00001208 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(LoadUser)) {
1209 assert(GEPI->getNumOperands() >= 3 && isa<ConstantInt>(GEPI->getOperand(2))
1210 && "Unexpected GEPI!");
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001211
Chris Lattnerba98f892007-09-13 18:00:31 +00001212 // Load the pointer for this field.
1213 unsigned FieldNo = cast<ConstantInt>(GEPI->getOperand(2))->getZExtValue();
Chris Lattner222ef4c2008-12-17 05:28:49 +00001214 Value *NewPtr = GetHeapSROAValue(GEPI->getOperand(0), FieldNo,
Chris Lattner46b5c642009-11-06 04:27:31 +00001215 InsertedScalarizedValues, PHIsToRewrite);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001216
Chris Lattnerba98f892007-09-13 18:00:31 +00001217 // Create the new GEP idx vector.
1218 SmallVector<Value*, 8> GEPIdx;
1219 GEPIdx.push_back(GEPI->getOperand(1));
1220 GEPIdx.append(GEPI->op_begin()+3, GEPI->op_end());
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001221
David Blaikie22319eb2015-03-14 19:24:04 +00001222 Value *NGEPI = GetElementPtrInst::Create(GEPI->getResultElementType(), NewPtr, GEPIdx,
Gabor Greife9ecc682008-04-06 20:25:17 +00001223 GEPI->getName(), GEPI);
Chris Lattnerba98f892007-09-13 18:00:31 +00001224 GEPI->replaceAllUsesWith(NGEPI);
1225 GEPI->eraseFromParent();
1226 return;
1227 }
Chris Lattner011f91b2007-09-13 21:31:36 +00001228
Chris Lattner222ef4c2008-12-17 05:28:49 +00001229 // Recursively transform the users of PHI nodes. This will lazily create the
1230 // PHIs that are needed for individual elements. Keep track of what PHIs we
1231 // see in InsertedScalarizedValues so that we don't get infinite loops (very
1232 // antisocial). If the PHI is already in InsertedScalarizedValues, it has
1233 // already been seen first by another load, so its uses have already been
1234 // processed.
1235 PHINode *PN = cast<PHINode>(LoadUser);
Chris Lattner5cf753c2011-07-21 06:21:31 +00001236 if (!InsertedScalarizedValues.insert(std::make_pair(PN,
1237 std::vector<Value*>())).second)
1238 return;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001239
Chris Lattner222ef4c2008-12-17 05:28:49 +00001240 // If this is the first time we've seen this PHI, recursively process all
1241 // users.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001242 for (auto UI = PN->user_begin(), E = PN->user_end(); UI != E;) {
Chris Lattner0cdf5232008-12-17 05:42:08 +00001243 Instruction *User = cast<Instruction>(*UI++);
Chris Lattner46b5c642009-11-06 04:27:31 +00001244 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
Chris Lattner0cdf5232008-12-17 05:42:08 +00001245 }
Chris Lattnerf315d4f2007-09-13 17:29:05 +00001246}
1247
James Molloyea31ad32015-11-13 11:05:07 +00001248/// We are performing Heap SRoA on a global. Ptr is a value loaded from the
1249/// global. Eliminate all uses of Ptr, making them use FieldGlobals instead.
1250/// All uses of loaded values satisfy AllGlobalLoadUsesSimpleEnoughForHeapSRA.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001251static void RewriteUsesOfLoadForHeapSRoA(LoadInst *Load,
Chris Lattner222ef4c2008-12-17 05:28:49 +00001252 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001253 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001254 for (auto UI = Load->user_begin(), E = Load->user_end(); UI != E;) {
Chris Lattner0cdf5232008-12-17 05:42:08 +00001255 Instruction *User = cast<Instruction>(*UI++);
Chris Lattner46b5c642009-11-06 04:27:31 +00001256 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
Chris Lattner0cdf5232008-12-17 05:42:08 +00001257 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001258
Chris Lattner222ef4c2008-12-17 05:28:49 +00001259 if (Load->use_empty()) {
1260 Load->eraseFromParent();
1261 InsertedScalarizedValues.erase(Load);
1262 }
Chris Lattner24d3d422006-09-30 23:32:09 +00001263}
1264
James Molloyea31ad32015-11-13 11:05:07 +00001265/// CI is an allocation of an array of structures. Break it up into multiple
1266/// allocations of arrays of the fields.
Victor Hernandezf3db9152009-11-07 00:16:28 +00001267static GlobalVariable *PerformHeapAllocSRoA(GlobalVariable *GV, CallInst *CI,
Mehdi Amini46a43552015-03-04 18:43:29 +00001268 Value *NElems, const DataLayout &DL,
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001269 const TargetLibraryInfo *TLI) {
David Greene44cb8ad2010-01-05 01:28:05 +00001270 DEBUG(dbgs() << "SROA HEAP ALLOC: " << *GV << " MALLOC = " << *CI << '\n');
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001271 Type *MAT = getMallocAllocatedType(CI, TLI);
Chris Lattner229907c2011-07-18 04:54:35 +00001272 StructType *STy = cast<StructType>(MAT);
Victor Hernandez5d034492009-09-18 22:35:49 +00001273
1274 // There is guaranteed to be at least one use of the malloc (storing
1275 // it into GV). If there are other uses, change them to be uses of
1276 // the global to simplify later code. This also deletes the store
1277 // into GV.
Victor Hernandezf3db9152009-11-07 00:16:28 +00001278 ReplaceUsesOfMallocWithGlobal(CI, GV);
1279
Victor Hernandez5d034492009-09-18 22:35:49 +00001280 // Okay, at this point, there are no users of the malloc. Insert N
1281 // new mallocs at the same place as CI, and N globals.
1282 std::vector<Value*> FieldGlobals;
1283 std::vector<Value*> FieldMallocs;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001284
Matt Arsenaultfcd74012014-04-23 20:36:10 +00001285 unsigned AS = GV->getType()->getPointerAddressSpace();
Victor Hernandez5d034492009-09-18 22:35:49 +00001286 for (unsigned FieldNo = 0, e = STy->getNumElements(); FieldNo != e;++FieldNo){
Chris Lattner229907c2011-07-18 04:54:35 +00001287 Type *FieldTy = STy->getElementType(FieldNo);
Matt Arsenaultfcd74012014-04-23 20:36:10 +00001288 PointerType *PFieldTy = PointerType::get(FieldTy, AS);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001289
Rafael Espindolae4ed0e52015-12-22 19:16:50 +00001290 GlobalVariable *NGV = new GlobalVariable(
1291 *GV->getParent(), PFieldTy, false, GlobalValue::InternalLinkage,
1292 Constant::getNullValue(PFieldTy), GV->getName() + ".f" + Twine(FieldNo),
1293 nullptr, GV->getThreadLocalMode());
Victor Hernandez5d034492009-09-18 22:35:49 +00001294 FieldGlobals.push_back(NGV);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001295
Mehdi Amini46a43552015-03-04 18:43:29 +00001296 unsigned TypeSize = DL.getTypeAllocSize(FieldTy);
Chris Lattner229907c2011-07-18 04:54:35 +00001297 if (StructType *ST = dyn_cast<StructType>(FieldTy))
Mehdi Amini46a43552015-03-04 18:43:29 +00001298 TypeSize = DL.getStructLayout(ST)->getSizeInBytes();
1299 Type *IntPtrTy = DL.getIntPtrType(CI->getType());
Victor Hernandezf3db9152009-11-07 00:16:28 +00001300 Value *NMI = CallInst::CreateMalloc(CI, IntPtrTy, FieldTy,
1301 ConstantInt::get(IntPtrTy, TypeSize),
Craig Topperf40110f2014-04-25 05:29:35 +00001302 NElems, nullptr,
Victor Hernandezf3db9152009-11-07 00:16:28 +00001303 CI->getName() + ".f" + Twine(FieldNo));
Chris Lattner0521c092010-02-26 18:23:13 +00001304 FieldMallocs.push_back(NMI);
Victor Hernandezf3db9152009-11-07 00:16:28 +00001305 new StoreInst(NMI, NGV, CI);
Victor Hernandez5d034492009-09-18 22:35:49 +00001306 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001307
Victor Hernandez5d034492009-09-18 22:35:49 +00001308 // The tricky aspect of this transformation is handling the case when malloc
1309 // fails. In the original code, malloc failing would set the result pointer
1310 // of malloc to null. In this case, some mallocs could succeed and others
1311 // could fail. As such, we emit code that looks like this:
1312 // F0 = malloc(field0)
1313 // F1 = malloc(field1)
1314 // F2 = malloc(field2)
1315 // if (F0 == 0 || F1 == 0 || F2 == 0) {
1316 // if (F0) { free(F0); F0 = 0; }
1317 // if (F1) { free(F1); F1 = 0; }
1318 // if (F2) { free(F2); F2 = 0; }
1319 // }
Victor Hernandezfcc77b12009-11-10 08:32:25 +00001320 // The malloc can also fail if its argument is too large.
Gabor Greif218f5542010-06-24 14:42:01 +00001321 Constant *ConstantZero = ConstantInt::get(CI->getArgOperand(0)->getType(), 0);
1322 Value *RunningOr = new ICmpInst(CI, ICmpInst::ICMP_SLT, CI->getArgOperand(0),
Victor Hernandezfcc77b12009-11-10 08:32:25 +00001323 ConstantZero, "isneg");
Victor Hernandez5d034492009-09-18 22:35:49 +00001324 for (unsigned i = 0, e = FieldMallocs.size(); i != e; ++i) {
Victor Hernandezf3db9152009-11-07 00:16:28 +00001325 Value *Cond = new ICmpInst(CI, ICmpInst::ICMP_EQ, FieldMallocs[i],
1326 Constant::getNullValue(FieldMallocs[i]->getType()),
1327 "isnull");
Victor Hernandezfcc77b12009-11-10 08:32:25 +00001328 RunningOr = BinaryOperator::CreateOr(RunningOr, Cond, "tmp", CI);
Victor Hernandez5d034492009-09-18 22:35:49 +00001329 }
1330
1331 // Split the basic block at the old malloc.
Victor Hernandezf3db9152009-11-07 00:16:28 +00001332 BasicBlock *OrigBB = CI->getParent();
Duncan P. N. Exon Smith17323402015-10-13 17:51:03 +00001333 BasicBlock *ContBB =
1334 OrigBB->splitBasicBlock(CI->getIterator(), "malloc_cont");
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001335
Victor Hernandez5d034492009-09-18 22:35:49 +00001336 // Create the block to check the first condition. Put all these blocks at the
1337 // end of the function as they are unlikely to be executed.
Chris Lattner46b5c642009-11-06 04:27:31 +00001338 BasicBlock *NullPtrBlock = BasicBlock::Create(OrigBB->getContext(),
1339 "malloc_ret_null",
Victor Hernandez5d034492009-09-18 22:35:49 +00001340 OrigBB->getParent());
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001341
Victor Hernandez5d034492009-09-18 22:35:49 +00001342 // Remove the uncond branch from OrigBB to ContBB, turning it into a cond
1343 // branch on RunningOr.
1344 OrigBB->getTerminator()->eraseFromParent();
1345 BranchInst::Create(NullPtrBlock, ContBB, RunningOr, OrigBB);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001346
Victor Hernandez5d034492009-09-18 22:35:49 +00001347 // Within the NullPtrBlock, we need to emit a comparison and branch for each
1348 // pointer, because some may be null while others are not.
1349 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1350 Value *GVVal = new LoadInst(FieldGlobals[i], "tmp", NullPtrBlock);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001351 Value *Cmp = new ICmpInst(*NullPtrBlock, ICmpInst::ICMP_NE, GVVal,
Benjamin Kramer547b6c52011-09-27 20:39:19 +00001352 Constant::getNullValue(GVVal->getType()));
Chris Lattner46b5c642009-11-06 04:27:31 +00001353 BasicBlock *FreeBlock = BasicBlock::Create(Cmp->getContext(), "free_it",
Victor Hernandez5d034492009-09-18 22:35:49 +00001354 OrigBB->getParent());
Chris Lattner46b5c642009-11-06 04:27:31 +00001355 BasicBlock *NextBlock = BasicBlock::Create(Cmp->getContext(), "next",
Victor Hernandez5d034492009-09-18 22:35:49 +00001356 OrigBB->getParent());
Victor Hernandeze2971492009-10-24 04:23:03 +00001357 Instruction *BI = BranchInst::Create(FreeBlock, NextBlock,
1358 Cmp, NullPtrBlock);
Victor Hernandez5d034492009-09-18 22:35:49 +00001359
1360 // Fill in FreeBlock.
Victor Hernandeze2971492009-10-24 04:23:03 +00001361 CallInst::CreateFree(GVVal, BI);
Victor Hernandez5d034492009-09-18 22:35:49 +00001362 new StoreInst(Constant::getNullValue(GVVal->getType()), FieldGlobals[i],
1363 FreeBlock);
1364 BranchInst::Create(NextBlock, FreeBlock);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001365
Victor Hernandez5d034492009-09-18 22:35:49 +00001366 NullPtrBlock = NextBlock;
1367 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001368
Victor Hernandez5d034492009-09-18 22:35:49 +00001369 BranchInst::Create(ContBB, NullPtrBlock);
Victor Hernandezf3db9152009-11-07 00:16:28 +00001370
1371 // CI is no longer needed, remove it.
Victor Hernandez5d034492009-09-18 22:35:49 +00001372 CI->eraseFromParent();
1373
James Molloyea31ad32015-11-13 11:05:07 +00001374 /// As we process loads, if we can't immediately update all uses of the load,
1375 /// keep track of what scalarized loads are inserted for a given load.
Victor Hernandez5d034492009-09-18 22:35:49 +00001376 DenseMap<Value*, std::vector<Value*> > InsertedScalarizedValues;
1377 InsertedScalarizedValues[GV] = FieldGlobals;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001378
Victor Hernandez5d034492009-09-18 22:35:49 +00001379 std::vector<std::pair<PHINode*, unsigned> > PHIsToRewrite;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001380
Victor Hernandez5d034492009-09-18 22:35:49 +00001381 // Okay, the malloc site is completely handled. All of the uses of GV are now
1382 // loads, and all uses of those loads are simple. Rewrite them to use loads
1383 // of the per-field globals instead.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001384 for (auto UI = GV->user_begin(), E = GV->user_end(); UI != E;) {
Victor Hernandez5d034492009-09-18 22:35:49 +00001385 Instruction *User = cast<Instruction>(*UI++);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001386
Victor Hernandez5d034492009-09-18 22:35:49 +00001387 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
Chris Lattner46b5c642009-11-06 04:27:31 +00001388 RewriteUsesOfLoadForHeapSRoA(LI, InsertedScalarizedValues, PHIsToRewrite);
Victor Hernandez5d034492009-09-18 22:35:49 +00001389 continue;
1390 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001391
Victor Hernandez5d034492009-09-18 22:35:49 +00001392 // Must be a store of null.
1393 StoreInst *SI = cast<StoreInst>(User);
1394 assert(isa<ConstantPointerNull>(SI->getOperand(0)) &&
1395 "Unexpected heap-sra user!");
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001396
Victor Hernandez5d034492009-09-18 22:35:49 +00001397 // Insert a store of null into each global.
1398 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +00001399 Type *ValTy = cast<GlobalValue>(FieldGlobals[i])->getValueType();
1400 Constant *Null = Constant::getNullValue(ValTy);
Victor Hernandez5d034492009-09-18 22:35:49 +00001401 new StoreInst(Null, FieldGlobals[i], SI);
1402 }
1403 // Erase the original store.
1404 SI->eraseFromParent();
1405 }
1406
1407 // While we have PHIs that are interesting to rewrite, do it.
1408 while (!PHIsToRewrite.empty()) {
1409 PHINode *PN = PHIsToRewrite.back().first;
1410 unsigned FieldNo = PHIsToRewrite.back().second;
1411 PHIsToRewrite.pop_back();
1412 PHINode *FieldPN = cast<PHINode>(InsertedScalarizedValues[PN][FieldNo]);
1413 assert(FieldPN->getNumIncomingValues() == 0 &&"Already processed this phi");
1414
1415 // Add all the incoming values. This can materialize more phis.
1416 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1417 Value *InVal = PN->getIncomingValue(i);
1418 InVal = GetHeapSROAValue(InVal, FieldNo, InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001419 PHIsToRewrite);
Victor Hernandez5d034492009-09-18 22:35:49 +00001420 FieldPN->addIncoming(InVal, PN->getIncomingBlock(i));
1421 }
1422 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001423
Victor Hernandez5d034492009-09-18 22:35:49 +00001424 // Drop all inter-phi links and any loads that made it this far.
1425 for (DenseMap<Value*, std::vector<Value*> >::iterator
1426 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1427 I != E; ++I) {
1428 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1429 PN->dropAllReferences();
1430 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1431 LI->dropAllReferences();
1432 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001433
Victor Hernandez5d034492009-09-18 22:35:49 +00001434 // Delete all the phis and loads now that inter-references are dead.
1435 for (DenseMap<Value*, std::vector<Value*> >::iterator
1436 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1437 I != E; ++I) {
1438 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1439 PN->eraseFromParent();
1440 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1441 LI->eraseFromParent();
1442 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001443
Victor Hernandez5d034492009-09-18 22:35:49 +00001444 // The old global is now dead, remove it.
1445 GV->eraseFromParent();
1446
1447 ++NumHeapSRA;
1448 return cast<GlobalVariable>(FieldGlobals[0]);
1449}
1450
James Molloyea31ad32015-11-13 11:05:07 +00001451/// This function is called when we see a pointer global variable with a single
1452/// value stored it that is a malloc or cast of malloc.
Rafael Espindolae4ed0e52015-12-22 19:16:50 +00001453static bool tryToOptimizeStoreOfMallocToGlobal(GlobalVariable *GV, CallInst *CI,
Chris Lattner229907c2011-07-18 04:54:35 +00001454 Type *AllocTy,
Nick Lewycky52da72b2012-02-05 19:56:38 +00001455 AtomicOrdering Ordering,
Mehdi Amini46a43552015-03-04 18:43:29 +00001456 const DataLayout &DL,
Nick Lewyckycf6aae62012-02-12 01:13:18 +00001457 TargetLibraryInfo *TLI) {
Victor Hernandez5d034492009-09-18 22:35:49 +00001458 // If this is a malloc of an abstract type, don't touch it.
1459 if (!AllocTy->isSized())
1460 return false;
1461
1462 // We can't optimize this global unless all uses of it are *known* to be
1463 // of the malloc value, not of the null initializer value (consider a use
1464 // that compares the global's value against zero to see if the malloc has
1465 // been reached). To do this, we check to see if all uses of the global
1466 // would trap if the global were null: this proves that they must all
1467 // happen after the malloc.
1468 if (!AllUsesOfLoadedValueWillTrapIfNull(GV))
1469 return false;
1470
1471 // We can't optimize this if the malloc itself is used in a complex way,
1472 // for example, being stored into multiple globals. This allows the
Nick Lewyckybbd11562012-02-05 19:48:37 +00001473 // malloc to be stored into the specified global, loaded icmp'd, and
Victor Hernandez5d034492009-09-18 22:35:49 +00001474 // GEP'd. These are all things we could transform to using the global
1475 // for.
Evan Cheng21b588b2010-04-14 20:52:55 +00001476 SmallPtrSet<const PHINode*, 8> PHIs;
1477 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(CI, GV, PHIs))
1478 return false;
Victor Hernandez5d034492009-09-18 22:35:49 +00001479
1480 // If we have a global that is only initialized with a fixed size malloc,
1481 // transform the program to use global memory instead of malloc'd memory.
1482 // This eliminates dynamic allocation, avoids an indirection accessing the
1483 // data, and exposes the resultant global to further GlobalOpt.
Victor Hernandez264da322009-10-16 23:12:25 +00001484 // We cannot optimize the malloc if we cannot determine malloc array size.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001485 Value *NElems = getMallocArraySize(CI, DL, TLI, true);
Evan Cheng21b588b2010-04-14 20:52:55 +00001486 if (!NElems)
1487 return false;
Victor Hernandez5d034492009-09-18 22:35:49 +00001488
Evan Cheng21b588b2010-04-14 20:52:55 +00001489 if (ConstantInt *NElements = dyn_cast<ConstantInt>(NElems))
1490 // Restrict this transformation to only working on small allocations
1491 // (2048 bytes currently), as we don't want to introduce a 16M global or
1492 // something.
Mehdi Amini46a43552015-03-04 18:43:29 +00001493 if (NElements->getZExtValue() * DL.getTypeAllocSize(AllocTy) < 2048) {
Rafael Espindolae4ed0e52015-12-22 19:16:50 +00001494 OptimizeGlobalAddressOfMalloc(GV, CI, AllocTy, NElements, DL, TLI);
Evan Cheng21b588b2010-04-14 20:52:55 +00001495 return true;
Victor Hernandez5d034492009-09-18 22:35:49 +00001496 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001497
Evan Cheng21b588b2010-04-14 20:52:55 +00001498 // If the allocation is an array of structures, consider transforming this
1499 // into multiple malloc'd arrays, one for each field. This is basically
1500 // SRoA for malloc'd memory.
1501
Nick Lewycky52da72b2012-02-05 19:56:38 +00001502 if (Ordering != NotAtomic)
1503 return false;
1504
Evan Cheng21b588b2010-04-14 20:52:55 +00001505 // If this is an allocation of a fixed size array of structs, analyze as a
1506 // variable size array. malloc [100 x struct],1 -> malloc struct, 100
Gabor Greif218f5542010-06-24 14:42:01 +00001507 if (NElems == ConstantInt::get(CI->getArgOperand(0)->getType(), 1))
Chris Lattner229907c2011-07-18 04:54:35 +00001508 if (ArrayType *AT = dyn_cast<ArrayType>(AllocTy))
Evan Cheng21b588b2010-04-14 20:52:55 +00001509 AllocTy = AT->getElementType();
Gabor Greif218f5542010-06-24 14:42:01 +00001510
Chris Lattner229907c2011-07-18 04:54:35 +00001511 StructType *AllocSTy = dyn_cast<StructType>(AllocTy);
Evan Cheng21b588b2010-04-14 20:52:55 +00001512 if (!AllocSTy)
1513 return false;
1514
1515 // This the structure has an unreasonable number of fields, leave it
1516 // alone.
1517 if (AllocSTy->getNumElements() <= 16 && AllocSTy->getNumElements() != 0 &&
1518 AllGlobalLoadUsesSimpleEnoughForHeapSRA(GV, CI)) {
1519
1520 // If this is a fixed size array, transform the Malloc to be an alloc of
1521 // structs. malloc [100 x struct],1 -> malloc struct, 100
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001522 if (ArrayType *AT = dyn_cast<ArrayType>(getMallocAllocatedType(CI, TLI))) {
Mehdi Amini46a43552015-03-04 18:43:29 +00001523 Type *IntPtrTy = DL.getIntPtrType(CI->getType());
1524 unsigned TypeSize = DL.getStructLayout(AllocSTy)->getSizeInBytes();
Evan Cheng21b588b2010-04-14 20:52:55 +00001525 Value *AllocSize = ConstantInt::get(IntPtrTy, TypeSize);
1526 Value *NumElements = ConstantInt::get(IntPtrTy, AT->getNumElements());
1527 Instruction *Malloc = CallInst::CreateMalloc(CI, IntPtrTy, AllocSTy,
1528 AllocSize, NumElements,
Craig Topperf40110f2014-04-25 05:29:35 +00001529 nullptr, CI->getName());
Evan Cheng21b588b2010-04-14 20:52:55 +00001530 Instruction *Cast = new BitCastInst(Malloc, CI->getType(), "tmp", CI);
1531 CI->replaceAllUsesWith(Cast);
1532 CI->eraseFromParent();
Nuno Lopes9792d682012-06-22 00:25:01 +00001533 if (BitCastInst *BCI = dyn_cast<BitCastInst>(Malloc))
1534 CI = cast<CallInst>(BCI->getOperand(0));
1535 else
Nuno Lopes0b60ebb2012-06-22 00:29:58 +00001536 CI = cast<CallInst>(Malloc);
Evan Cheng21b588b2010-04-14 20:52:55 +00001537 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001538
Rafael Espindolae4ed0e52015-12-22 19:16:50 +00001539 PerformHeapAllocSRoA(GV, CI, getMallocArraySize(CI, DL, TLI, true), DL,
1540 TLI);
Evan Cheng21b588b2010-04-14 20:52:55 +00001541 return true;
Victor Hernandez5d034492009-09-18 22:35:49 +00001542 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001543
Victor Hernandez5d034492009-09-18 22:35:49 +00001544 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001545}
Victor Hernandez5d034492009-09-18 22:35:49 +00001546
Rafael Espindolae4ed0e52015-12-22 19:16:50 +00001547// Try to optimize globals based on the knowledge that only one value (besides
1548// its initializer) is ever stored to the global.
1549static bool optimizeOnceStoredGlobal(GlobalVariable *GV, Value *StoredOnceVal,
Nick Lewycky52da72b2012-02-05 19:56:38 +00001550 AtomicOrdering Ordering,
Mehdi Amini46a43552015-03-04 18:43:29 +00001551 const DataLayout &DL,
Rafael Espindolaaeff8a92014-02-24 23:12:18 +00001552 TargetLibraryInfo *TLI) {
Chris Lattner1c731fa2008-12-15 21:20:32 +00001553 // Ignore no-op GEPs and bitcasts.
1554 StoredOnceVal = StoredOnceVal->stripPointerCasts();
Chris Lattner09a52722004-10-09 21:48:45 +00001555
Chris Lattnere42eb312004-10-10 23:14:11 +00001556 // If we are dealing with a pointer global that is initialized to null and
1557 // only has one (non-null) value stored into it, then we can optimize any
1558 // users of the loaded value (often calls and loads) that would trap if the
1559 // value was null.
Duncan Sands19d0b472010-02-16 11:11:14 +00001560 if (GV->getInitializer()->getType()->isPointerTy() &&
Chris Lattner09a52722004-10-09 21:48:45 +00001561 GV->getInitializer()->isNullValue()) {
Chris Lattnere42eb312004-10-10 23:14:11 +00001562 if (Constant *SOVC = dyn_cast<Constant>(StoredOnceVal)) {
1563 if (GV->getInitializer()->getType() != SOVC->getType())
Chris Lattner1a1acc22011-05-22 07:15:13 +00001564 SOVC = ConstantExpr::getBitCast(SOVC, GV->getInitializer()->getType());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001565
Chris Lattnere42eb312004-10-10 23:14:11 +00001566 // Optimize away any trapping uses of the loaded value.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001567 if (OptimizeAwayTrappingUsesOfLoads(GV, SOVC, DL, TLI))
Chris Lattner604ed7a2004-10-10 17:07:12 +00001568 return true;
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001569 } else if (CallInst *CI = extractMallocCall(StoredOnceVal, TLI)) {
1570 Type *MallocType = getMallocAllocatedType(CI, TLI);
Rafael Espindolae4ed0e52015-12-22 19:16:50 +00001571 if (MallocType && tryToOptimizeStoreOfMallocToGlobal(GV, CI, MallocType,
1572 Ordering, DL, TLI))
Victor Hernandezf3db9152009-11-07 00:16:28 +00001573 return true;
Chris Lattnere42eb312004-10-10 23:14:11 +00001574 }
Chris Lattner09a52722004-10-09 21:48:45 +00001575 }
Chris Lattner004e2502004-10-11 05:54:41 +00001576
Chris Lattner09a52722004-10-09 21:48:45 +00001577 return false;
1578}
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001579
James Molloyea31ad32015-11-13 11:05:07 +00001580/// At this point, we have learned that the only two values ever stored into GV
1581/// are its initializer and OtherVal. See if we can shrink the global into a
1582/// boolean and select between the two values whenever it is used. This exposes
1583/// the values to other scalar optimizations.
Lang Hames459b5dc2014-03-23 04:22:31 +00001584static bool TryToShrinkGlobalToBoolean(GlobalVariable *GV, Constant *OtherVal) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +00001585 Type *GVElType = GV->getValueType();
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001586
Lang Hames459b5dc2014-03-23 04:22:31 +00001587 // If GVElType is already i1, it is already shrunk. If the type of the GV is
1588 // an FP value, pointer or vector, don't do this optimization because a select
1589 // between them is very expensive and unlikely to lead to later
1590 // simplification. In these cases, we typically end up with "cond ? v1 : v2"
1591 // where v1 and v2 both require constant pool loads, a big loss.
Chris Lattner46b5c642009-11-06 04:27:31 +00001592 if (GVElType == Type::getInt1Ty(GV->getContext()) ||
Duncan Sands9dff9be2010-02-15 16:12:20 +00001593 GVElType->isFloatingPointTy() ||
Duncan Sands19d0b472010-02-16 11:11:14 +00001594 GVElType->isPointerTy() || GVElType->isVectorTy())
Chris Lattner20bbac32008-01-14 01:17:44 +00001595 return false;
Gabor Greifa75ed762010-07-12 14:13:15 +00001596
Chris Lattner20bbac32008-01-14 01:17:44 +00001597 // Walk the use list of the global seeing if all the uses are load or store.
1598 // If there is anything else, bail out.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001599 for (User *U : GV->users())
Gabor Greifa75ed762010-07-12 14:13:15 +00001600 if (!isa<LoadInst>(U) && !isa<StoreInst>(U))
Chris Lattner20bbac32008-01-14 01:17:44 +00001601 return false;
Gabor Greifa75ed762010-07-12 14:13:15 +00001602
James Molloyef607a22015-10-28 14:30:53 +00001603 DEBUG(dbgs() << " *** SHRINKING TO BOOL: " << *GV << "\n");
Lang Hames459b5dc2014-03-23 04:22:31 +00001604
1605 // Create the new global, initializing it to false.
1606 GlobalVariable *NewGV = new GlobalVariable(Type::getInt1Ty(GV->getContext()),
1607 false,
1608 GlobalValue::InternalLinkage,
1609 ConstantInt::getFalse(GV->getContext()),
1610 GV->getName()+".b",
1611 GV->getThreadLocalMode(),
1612 GV->getType()->getAddressSpace());
Duncan P. N. Exon Smith17323402015-10-13 17:51:03 +00001613 GV->getParent()->getGlobalList().insert(GV->getIterator(), NewGV);
Lang Hames459b5dc2014-03-23 04:22:31 +00001614
Chris Lattner40e4cec2004-12-12 05:53:50 +00001615 Constant *InitVal = GV->getInitializer();
Chris Lattner46b5c642009-11-06 04:27:31 +00001616 assert(InitVal->getType() != Type::getInt1Ty(GV->getContext()) &&
Lang Hames459b5dc2014-03-23 04:22:31 +00001617 "No reason to shrink to bool!");
Chris Lattner40e4cec2004-12-12 05:53:50 +00001618
Lang Hames459b5dc2014-03-23 04:22:31 +00001619 // If initialized to zero and storing one into the global, we can use a cast
1620 // instead of a select to synthesize the desired value.
1621 bool IsOneZero = false;
1622 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal))
1623 IsOneZero = InitVal->isNullValue() && CI->isOne();
Chris Lattner40e4cec2004-12-12 05:53:50 +00001624
Lang Hames459b5dc2014-03-23 04:22:31 +00001625 while (!GV->use_empty()) {
1626 Instruction *UI = cast<Instruction>(GV->user_back());
1627 if (StoreInst *SI = dyn_cast<StoreInst>(UI)) {
1628 // Change the store into a boolean store.
1629 bool StoringOther = SI->getOperand(0) == OtherVal;
1630 // Only do this if we weren't storing a loaded value.
1631 Value *StoreVal;
1632 if (StoringOther || SI->getOperand(0) == InitVal) {
1633 StoreVal = ConstantInt::get(Type::getInt1Ty(GV->getContext()),
1634 StoringOther);
Bill Wendling7297b862013-02-13 23:00:51 +00001635 } else {
Lang Hames459b5dc2014-03-23 04:22:31 +00001636 // Otherwise, we are storing a previously loaded copy. To do this,
1637 // change the copy from copying the original value to just copying the
1638 // bool.
1639 Instruction *StoredVal = cast<Instruction>(SI->getOperand(0));
1640
1641 // If we've already replaced the input, StoredVal will be a cast or
1642 // select instruction. If not, it will be a load of the original
1643 // global.
1644 if (LoadInst *LI = dyn_cast<LoadInst>(StoredVal)) {
1645 assert(LI->getOperand(0) == GV && "Not a copy!");
1646 // Insert a new load, to preserve the saved value.
1647 StoreVal = new LoadInst(NewGV, LI->getName()+".b", false, 0,
1648 LI->getOrdering(), LI->getSynchScope(), LI);
1649 } else {
1650 assert((isa<CastInst>(StoredVal) || isa<SelectInst>(StoredVal)) &&
1651 "This is not a form that we understand!");
1652 StoreVal = StoredVal->getOperand(0);
1653 assert(isa<LoadInst>(StoreVal) && "Not a load of NewGV!");
1654 }
Chris Lattner745196a2004-12-12 19:34:41 +00001655 }
Lang Hames459b5dc2014-03-23 04:22:31 +00001656 new StoreInst(StoreVal, NewGV, false, 0,
1657 SI->getOrdering(), SI->getSynchScope(), SI);
1658 } else {
1659 // Change the load into a load of bool then a select.
1660 LoadInst *LI = cast<LoadInst>(UI);
1661 LoadInst *NLI = new LoadInst(NewGV, LI->getName()+".b", false, 0,
1662 LI->getOrdering(), LI->getSynchScope(), LI);
1663 Value *NSI;
1664 if (IsOneZero)
1665 NSI = new ZExtInst(NLI, LI->getType(), "", LI);
1666 else
1667 NSI = SelectInst::Create(NLI, OtherVal, InitVal, "", LI);
1668 NSI->takeName(LI);
1669 LI->replaceAllUsesWith(NSI);
Devang Patelfc507a12009-03-06 01:39:36 +00001670 }
Lang Hames459b5dc2014-03-23 04:22:31 +00001671 UI->eraseFromParent();
Chris Lattner40e4cec2004-12-12 05:53:50 +00001672 }
1673
Lang Hames459b5dc2014-03-23 04:22:31 +00001674 // Retain the name of the old global variable. People who are debugging their
1675 // programs may expect these variables to be named the same.
1676 NewGV->takeName(GV);
1677 GV->eraseFromParent();
Chris Lattner20bbac32008-01-14 01:17:44 +00001678 return true;
Chris Lattner40e4cec2004-12-12 05:53:50 +00001679}
1680
Rafael Espindola2cc46b32015-12-22 19:38:07 +00001681bool GlobalOpt::deleteIfDead(GlobalValue &GV) {
1682 GV.removeDeadConstantUsers();
1683
1684 if (!GV.isDiscardableIfUnused())
1685 return false;
1686
1687 if (const Comdat *C = GV.getComdat())
1688 if (!GV.hasLocalLinkage() && NotDiscardableComdats.count(C))
1689 return false;
1690
1691 bool Dead;
1692 if (auto *F = dyn_cast<Function>(&GV))
1693 Dead = F->isDefTriviallyDead();
1694 else
1695 Dead = GV.use_empty();
1696 if (!Dead)
1697 return false;
1698
1699 DEBUG(dbgs() << "GLOBAL DEAD: " << GV << "\n");
1700 GV.eraseFromParent();
1701 ++NumDeleted;
1702 return true;
1703}
Chris Lattner40e4cec2004-12-12 05:53:50 +00001704
James Molloyea31ad32015-11-13 11:05:07 +00001705/// Analyze the specified global variable and optimize it if possible. If we
1706/// make a change, return true.
Rafael Espindola10d9a032015-12-22 20:43:30 +00001707bool GlobalOpt::processGlobal(GlobalValue &GV) {
Rafael Espindola2cc46b32015-12-22 19:38:07 +00001708 // Do more involved optimizations if the global is internal.
Rafael Espindola10d9a032015-12-22 20:43:30 +00001709 if (!GV.hasLocalLinkage())
Rafael Espindola1821c6c2012-06-15 18:00:24 +00001710 return false;
1711
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001712 GlobalStatus GS;
1713
Rafael Espindola10d9a032015-12-22 20:43:30 +00001714 if (GlobalStatus::analyzeGlobal(&GV, GS))
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001715 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001716
Rafael Espindola10d9a032015-12-22 20:43:30 +00001717 bool Changed = false;
1718 if (!GS.IsCompared && !GV.hasUnnamedAddr()) {
1719 GV.setUnnamedAddr(true);
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001720 NumUnnamed++;
Rafael Espindola10d9a032015-12-22 20:43:30 +00001721 Changed = true;
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001722 }
1723
Rafael Espindola10d9a032015-12-22 20:43:30 +00001724 auto *GVar = dyn_cast<GlobalVariable>(&GV);
1725 if (!GVar)
1726 return Changed;
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001727
Rafael Espindola10d9a032015-12-22 20:43:30 +00001728 if (GVar->isConstant() || !GVar->hasInitializer())
1729 return Changed;
1730
1731 return processInternalGlobal(GVar, GS) || Changed;
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001732}
1733
James Molloy9c7d4d82015-11-15 14:21:37 +00001734bool GlobalOpt::isPointerValueDeadOnEntryToFunction(const Function *F, GlobalValue *GV) {
1735 // Find all uses of GV. We expect them all to be in F, and if we can't
1736 // identify any of the uses we bail out.
1737 //
1738 // On each of these uses, identify if the memory that GV points to is
1739 // used/required/live at the start of the function. If it is not, for example
1740 // if the first thing the function does is store to the GV, the GV can
1741 // possibly be demoted.
1742 //
1743 // We don't do an exhaustive search for memory operations - simply look
1744 // through bitcasts as they're quite common and benign.
1745 const DataLayout &DL = GV->getParent()->getDataLayout();
1746 SmallVector<LoadInst *, 4> Loads;
1747 SmallVector<StoreInst *, 4> Stores;
1748 for (auto *U : GV->users()) {
1749 if (Operator::getOpcode(U) == Instruction::BitCast) {
1750 for (auto *UU : U->users()) {
1751 if (auto *LI = dyn_cast<LoadInst>(UU))
1752 Loads.push_back(LI);
1753 else if (auto *SI = dyn_cast<StoreInst>(UU))
1754 Stores.push_back(SI);
1755 else
1756 return false;
1757 }
1758 continue;
1759 }
1760
1761 Instruction *I = dyn_cast<Instruction>(U);
1762 if (!I)
1763 return false;
1764 assert(I->getParent()->getParent() == F);
1765
1766 if (auto *LI = dyn_cast<LoadInst>(I))
1767 Loads.push_back(LI);
1768 else if (auto *SI = dyn_cast<StoreInst>(I))
1769 Stores.push_back(SI);
1770 else
1771 return false;
1772 }
1773
1774 // We have identified all uses of GV into loads and stores. Now check if all
1775 // of them are known not to depend on the value of the global at the function
1776 // entry point. We do this by ensuring that every load is dominated by at
1777 // least one store.
1778 auto &DT = getAnalysis<DominatorTreeWrapperPass>(*const_cast<Function *>(F))
1779 .getDomTree();
1780
James Molloyd4d23572015-11-16 10:16:22 +00001781 // The below check is quadratic. Check we're not going to do too many tests.
1782 // FIXME: Even though this will always have worst-case quadratic time, we
1783 // could put effort into minimizing the average time by putting stores that
1784 // have been shown to dominate at least one load at the beginning of the
1785 // Stores array, making subsequent dominance checks more likely to succeed
1786 // early.
1787 //
1788 // The threshold here is fairly large because global->local demotion is a
1789 // very powerful optimization should it fire.
1790 const unsigned Threshold = 100;
1791 if (Loads.size() * Stores.size() > Threshold)
1792 return false;
1793
James Molloy9c7d4d82015-11-15 14:21:37 +00001794 for (auto *L : Loads) {
1795 auto *LTy = L->getType();
1796 if (!std::any_of(Stores.begin(), Stores.end(), [&](StoreInst *S) {
1797 auto *STy = S->getValueOperand()->getType();
1798 // The load is only dominated by the store if DomTree says so
1799 // and the number of bits loaded in L is less than or equal to
1800 // the number of bits stored in S.
1801 return DT.dominates(S, L) &&
1802 DL.getTypeStoreSize(LTy) <= DL.getTypeStoreSize(STy);
1803 }))
1804 return false;
1805 }
1806 // All loads have known dependences inside F, so the global can be localized.
1807 return true;
1808}
1809
James Molloy1d695a02015-11-19 18:04:33 +00001810/// C may have non-instruction users. Can all of those users be turned into
1811/// instructions?
1812static bool allNonInstructionUsersCanBeMadeInstructions(Constant *C) {
1813 // We don't do this exhaustively. The most common pattern that we really need
1814 // to care about is a constant GEP or constant bitcast - so just looking
1815 // through one single ConstantExpr.
1816 //
1817 // The set of constants that this function returns true for must be able to be
1818 // handled by makeAllConstantUsesInstructions.
1819 for (auto *U : C->users()) {
1820 if (isa<Instruction>(U))
1821 continue;
1822 if (!isa<ConstantExpr>(U))
1823 // Non instruction, non-constantexpr user; cannot convert this.
1824 return false;
1825 for (auto *UU : U->users())
1826 if (!isa<Instruction>(UU))
1827 // A constantexpr used by another constant. We don't try and recurse any
1828 // further but just bail out at this point.
1829 return false;
1830 }
1831
1832 return true;
1833}
1834
1835/// C may have non-instruction users, and
1836/// allNonInstructionUsersCanBeMadeInstructions has returned true. Convert the
1837/// non-instruction users to instructions.
1838static void makeAllConstantUsesInstructions(Constant *C) {
1839 SmallVector<ConstantExpr*,4> Users;
1840 for (auto *U : C->users()) {
1841 if (isa<ConstantExpr>(U))
1842 Users.push_back(cast<ConstantExpr>(U));
1843 else
1844 // We should never get here; allNonInstructionUsersCanBeMadeInstructions
1845 // should not have returned true for C.
1846 assert(
1847 isa<Instruction>(U) &&
1848 "Can't transform non-constantexpr non-instruction to instruction!");
1849 }
1850
1851 SmallVector<Value*,4> UUsers;
1852 for (auto *U : Users) {
1853 UUsers.clear();
1854 for (auto *UU : U->users())
1855 UUsers.push_back(UU);
1856 for (auto *UU : UUsers) {
1857 Instruction *UI = cast<Instruction>(UU);
1858 Instruction *NewU = U->getAsInstruction();
1859 NewU->insertBefore(UI);
1860 UI->replaceUsesOfWith(U, NewU);
1861 }
1862 U->dropAllReferences();
1863 }
1864}
1865
James Molloyea31ad32015-11-13 11:05:07 +00001866/// Analyze the specified global variable and optimize
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001867/// it if possible. If we make a change, return true.
Rafael Espindolae4ed0e52015-12-22 19:16:50 +00001868bool GlobalOpt::processInternalGlobal(GlobalVariable *GV,
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001869 const GlobalStatus &GS) {
Mehdi Amini46a43552015-03-04 18:43:29 +00001870 auto &DL = GV->getParent()->getDataLayout();
James Molloy9c7d4d82015-11-15 14:21:37 +00001871 // If this is a first class global and has only one accessing function and
1872 // this function is non-recursive, we replace the global with a local alloca
1873 // in this function.
Alexey Samsonova1944e62013-10-07 19:03:24 +00001874 //
Alp Tokerf907b892013-12-05 05:44:44 +00001875 // NOTE: It doesn't make sense to promote non-single-value types since we
Alexey Samsonova1944e62013-10-07 19:03:24 +00001876 // are just replacing static memory to stack memory.
1877 //
1878 // If the global is in different address space, don't bring it to stack.
1879 if (!GS.HasMultipleAccessingFunctions &&
James Molloy1d695a02015-11-19 18:04:33 +00001880 GS.AccessingFunction &&
Manuel Jacob5f6eaac2016-01-16 20:30:46 +00001881 GV->getValueType()->isSingleValueType() &&
James Molloy9c7d4d82015-11-15 14:21:37 +00001882 GV->getType()->getAddressSpace() == 0 &&
1883 !GV->isExternallyInitialized() &&
James Molloy1d695a02015-11-19 18:04:33 +00001884 allNonInstructionUsersCanBeMadeInstructions(GV) &&
James Molloy9c7d4d82015-11-15 14:21:37 +00001885 GS.AccessingFunction->doesNotRecurse() &&
1886 isPointerValueDeadOnEntryToFunction(GS.AccessingFunction, GV) ) {
James Molloy33e73452015-11-13 11:05:13 +00001887 DEBUG(dbgs() << "LOCALIZING GLOBAL: " << *GV << "\n");
Alexey Samsonova1944e62013-10-07 19:03:24 +00001888 Instruction &FirstI = const_cast<Instruction&>(*GS.AccessingFunction
1889 ->getEntryBlock().begin());
Manuel Jacob5f6eaac2016-01-16 20:30:46 +00001890 Type *ElemTy = GV->getValueType();
Alexey Samsonova1944e62013-10-07 19:03:24 +00001891 // FIXME: Pass Global's alignment when globals have alignment
Craig Topperf40110f2014-04-25 05:29:35 +00001892 AllocaInst *Alloca = new AllocaInst(ElemTy, nullptr,
1893 GV->getName(), &FirstI);
Alexey Samsonova1944e62013-10-07 19:03:24 +00001894 if (!isa<UndefValue>(GV->getInitializer()))
1895 new StoreInst(GV->getInitializer(), Alloca, &FirstI);
1896
James Molloy1d695a02015-11-19 18:04:33 +00001897 makeAllConstantUsesInstructions(GV);
1898
Alexey Samsonova1944e62013-10-07 19:03:24 +00001899 GV->replaceAllUsesWith(Alloca);
1900 GV->eraseFromParent();
1901 ++NumLocalized;
1902 return true;
1903 }
1904
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001905 // If the global is never loaded (but may be stored to), it is dead.
1906 // Delete it now.
Rafael Espindola045a78f2013-10-17 18:18:52 +00001907 if (!GS.IsLoaded) {
James Molloy33e73452015-11-13 11:05:13 +00001908 DEBUG(dbgs() << "GLOBAL NEVER LOADED: " << *GV << "\n");
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001909
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +00001910 bool Changed;
1911 if (isLeakCheckerRoot(GV)) {
1912 // Delete any constant stores to the global.
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001913 Changed = CleanupPointerRootUsers(GV, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +00001914 } else {
1915 // Delete any stores we can find to the global. We may not be able to
1916 // make it completely dead though.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001917 Changed = CleanupConstantGlobalUsers(GV, GV->getInitializer(), DL, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +00001918 }
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001919
1920 // If the global is dead now, delete it.
1921 if (GV->use_empty()) {
1922 GV->eraseFromParent();
1923 ++NumDeleted;
1924 Changed = true;
1925 }
1926 return Changed;
1927
Rafael Espindola045a78f2013-10-17 18:18:52 +00001928 } else if (GS.StoredType <= GlobalStatus::InitializerStored) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00001929 DEBUG(dbgs() << "MARKING CONSTANT: " << *GV << "\n");
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001930 GV->setConstant(true);
1931
1932 // Clean up any obviously simplifiable users now.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001933 CleanupConstantGlobalUsers(GV, GV->getInitializer(), DL, TLI);
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001934
1935 // If the global is dead now, just nuke it.
1936 if (GV->use_empty()) {
1937 DEBUG(dbgs() << " *** Marking constant allowed us to simplify "
1938 << "all users and delete global!\n");
1939 GV->eraseFromParent();
1940 ++NumDeleted;
1941 }
1942
1943 ++NumMarked;
1944 return true;
1945 } else if (!GV->getInitializer()->getType()->isSingleValueType()) {
Mehdi Amini46a43552015-03-04 18:43:29 +00001946 const DataLayout &DL = GV->getParent()->getDataLayout();
Rafael Espindolae4ed0e52015-12-22 19:16:50 +00001947 if (SRAGlobal(GV, DL))
Mehdi Amini46a43552015-03-04 18:43:29 +00001948 return true;
Oliver Stannard939724c2015-10-12 13:20:52 +00001949 } else if (GS.StoredType == GlobalStatus::StoredOnce && GS.StoredOnceValue) {
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001950 // If the initial value for the global was an undef value, and if only
1951 // one other value was stored into it, we can just change the
1952 // initializer to be the stored value, then delete all stores to the
1953 // global. This allows us to mark it constant.
1954 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1955 if (isa<UndefValue>(GV->getInitializer())) {
1956 // Change the initial value here.
1957 GV->setInitializer(SOVConstant);
1958
1959 // Clean up any obviously simplifiable users now.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001960 CleanupConstantGlobalUsers(GV, GV->getInitializer(), DL, TLI);
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001961
1962 if (GV->use_empty()) {
1963 DEBUG(dbgs() << " *** Substituting initializer allowed us to "
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +00001964 << "simplify all users and delete global!\n");
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001965 GV->eraseFromParent();
1966 ++NumDeleted;
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001967 }
1968 ++NumSubstitute;
1969 return true;
1970 }
1971
1972 // Try to optimize globals based on the knowledge that only one value
1973 // (besides its initializer) is ever stored to the global.
Rafael Espindolae4ed0e52015-12-22 19:16:50 +00001974 if (optimizeOnceStoredGlobal(GV, GS.StoredOnceValue, GS.Ordering, DL, TLI))
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001975 return true;
1976
Lang Hames459b5dc2014-03-23 04:22:31 +00001977 // Otherwise, if the global was not a boolean, we can shrink it to be a
1978 // boolean.
Eli Friedman33d37002013-09-09 22:00:13 +00001979 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue)) {
1980 if (GS.Ordering == NotAtomic) {
Lang Hames459b5dc2014-03-23 04:22:31 +00001981 if (TryToShrinkGlobalToBoolean(GV, SOVConstant)) {
Eli Friedman33d37002013-09-09 22:00:13 +00001982 ++NumShrunkToBool;
1983 return true;
1984 }
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001985 }
Eli Friedman33d37002013-09-09 22:00:13 +00001986 }
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001987 }
1988
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001989 return false;
1990}
1991
James Molloyea31ad32015-11-13 11:05:07 +00001992/// Walk all of the direct calls of the specified function, changing them to
1993/// FastCC.
Chris Lattnera4c80222005-05-08 22:18:06 +00001994static void ChangeCalleesToFastCall(Function *F) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001995 for (User *U : F->users()) {
1996 if (isa<BlockAddress>(U))
Jay Foadca0c4992012-05-12 08:30:16 +00001997 continue;
Chandler Carruthcdf47882014-03-09 03:16:01 +00001998 CallSite CS(cast<Instruction>(U));
1999 CS.setCallingConv(CallingConv::Fast);
Chris Lattnera4c80222005-05-08 22:18:06 +00002000 }
2001}
Chris Lattner1c4bddc2004-10-08 20:59:28 +00002002
Bill Wendlinge94d8432012-12-07 23:16:57 +00002003static AttributeSet StripNest(LLVMContext &C, const AttributeSet &Attrs) {
Chris Lattner8a923e72008-03-12 17:45:29 +00002004 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendling57625a42013-01-25 23:09:36 +00002005 unsigned Index = Attrs.getSlotIndex(i);
2006 if (!Attrs.getSlotAttributes(i).hasAttribute(Index, Attribute::Nest))
Duncan Sands85fab3a2008-02-18 17:32:13 +00002007 continue;
2008
Duncan Sands85fab3a2008-02-18 17:32:13 +00002009 // There can be only one.
Bill Wendling57625a42013-01-25 23:09:36 +00002010 return Attrs.removeAttribute(C, Index, Attribute::Nest);
Duncan Sands573b3f82008-02-16 20:56:04 +00002011 }
2012
2013 return Attrs;
2014}
2015
2016static void RemoveNestAttribute(Function *F) {
Bill Wendling85a64c22012-10-14 06:39:53 +00002017 F->setAttributes(StripNest(F->getContext(), F->getAttributes()));
Chandler Carruthcdf47882014-03-09 03:16:01 +00002018 for (User *U : F->users()) {
2019 if (isa<BlockAddress>(U))
Jay Foadca0c4992012-05-12 08:30:16 +00002020 continue;
Chandler Carruthcdf47882014-03-09 03:16:01 +00002021 CallSite CS(cast<Instruction>(U));
2022 CS.setAttributes(StripNest(F->getContext(), CS.getAttributes()));
Duncan Sands573b3f82008-02-16 20:56:04 +00002023 }
2024}
2025
Reid Kleckner22869372014-02-26 19:57:30 +00002026/// Return true if this is a calling convention that we'd like to change. The
2027/// idea here is that we don't want to mess with the convention if the user
2028/// explicitly requested something with performance implications like coldcc,
2029/// GHC, or anyregcc.
2030static bool isProfitableToMakeFastCC(Function *F) {
2031 CallingConv::ID CC = F->getCallingConv();
2032 // FIXME: Is it worth transforming x86_stdcallcc and x86_fastcallcc?
2033 return CC == CallingConv::C || CC == CallingConv::X86_ThisCall;
2034}
2035
Chris Lattner41b6a5a2005-09-26 01:43:45 +00002036bool GlobalOpt::OptimizeFunctions(Module &M) {
2037 bool Changed = false;
2038 // Optimize functions.
2039 for (Module::iterator FI = M.begin(), E = M.end(); FI != E; ) {
Duncan P. N. Exon Smith17323402015-10-13 17:51:03 +00002040 Function *F = &*FI++;
Duncan Sandsed722832009-03-06 10:21:56 +00002041 // Functions without names cannot be referenced outside this module.
David Majnemer5c921152014-07-01 15:26:50 +00002042 if (!F->hasName() && !F->isDeclaration() && !F->hasLocalLinkage())
Duncan Sandsed722832009-03-06 10:21:56 +00002043 F->setLinkage(GlobalValue::InternalLinkage);
David Majnemer1b3b70e2014-10-08 07:23:31 +00002044
Rafael Espindola2cc46b32015-12-22 19:38:07 +00002045 if (deleteIfDead(*F)) {
Chris Lattner41b6a5a2005-09-26 01:43:45 +00002046 Changed = true;
Rafael Espindola9f0bebc2015-12-22 19:26:18 +00002047 continue;
2048 }
Rafael Espindola10d9a032015-12-22 20:43:30 +00002049
2050 Changed |= processGlobal(*F);
2051
Rafael Espindola9f0bebc2015-12-22 19:26:18 +00002052 if (!F->hasLocalLinkage())
2053 continue;
2054 if (isProfitableToMakeFastCC(F) && !F->isVarArg() &&
2055 !F->hasAddressTaken()) {
2056 // If this function has a calling convention worth changing, is not a
2057 // varargs function, and is only called directly, promote it to use the
2058 // Fast calling convention.
2059 F->setCallingConv(CallingConv::Fast);
2060 ChangeCalleesToFastCall(F);
2061 ++NumFastCallFns;
2062 Changed = true;
2063 }
Duncan Sands573b3f82008-02-16 20:56:04 +00002064
Rafael Espindola9f0bebc2015-12-22 19:26:18 +00002065 if (F->getAttributes().hasAttrSomewhere(Attribute::Nest) &&
2066 !F->hasAddressTaken()) {
2067 // The function is not used by a trampoline intrinsic, so it is safe
2068 // to remove the 'nest' attribute.
2069 RemoveNestAttribute(F);
2070 ++NumNestRemoved;
2071 Changed = true;
Chris Lattner41b6a5a2005-09-26 01:43:45 +00002072 }
2073 }
2074 return Changed;
2075}
2076
2077bool GlobalOpt::OptimizeGlobalVars(Module &M) {
2078 bool Changed = false;
David Majnemerdad0a642014-06-27 18:19:56 +00002079
Chris Lattner41b6a5a2005-09-26 01:43:45 +00002080 for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
2081 GVI != E; ) {
Duncan P. N. Exon Smith17323402015-10-13 17:51:03 +00002082 GlobalVariable *GV = &*GVI++;
Duncan Sandsed722832009-03-06 10:21:56 +00002083 // Global variables without names cannot be referenced outside this module.
David Majnemer5c921152014-07-01 15:26:50 +00002084 if (!GV->hasName() && !GV->isDeclaration() && !GV->hasLocalLinkage())
Duncan Sandsed722832009-03-06 10:21:56 +00002085 GV->setLinkage(GlobalValue::InternalLinkage);
Dan Gohman580b80d2009-11-23 16:22:21 +00002086 // Simplify the initializer.
2087 if (GV->hasInitializer())
2088 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GV->getInitializer())) {
Mehdi Amini46a43552015-03-04 18:43:29 +00002089 auto &DL = M.getDataLayout();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002090 Constant *New = ConstantFoldConstantExpression(CE, DL, TLI);
Dan Gohman580b80d2009-11-23 16:22:21 +00002091 if (New && New != CE)
2092 GV->setInitializer(New);
2093 }
Rafael Espindolafc355bc2011-01-19 16:32:21 +00002094
Rafael Espindola10d9a032015-12-22 20:43:30 +00002095 if (deleteIfDead(*GV)) {
2096 Changed = true;
2097 continue;
2098 }
2099
2100 Changed |= processGlobal(*GV);
Chris Lattner41b6a5a2005-09-26 01:43:45 +00002101 }
2102 return Changed;
2103}
2104
Jakub Staszak9525a772012-12-06 21:57:16 +00002105static inline bool
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002106isSimpleEnoughValueToCommit(Constant *C,
Mehdi Amini46a43552015-03-04 18:43:29 +00002107 SmallPtrSetImpl<Constant *> &SimpleConstants,
2108 const DataLayout &DL);
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002109
James Molloyea31ad32015-11-13 11:05:07 +00002110/// Return true if the specified constant can be handled by the code generator.
2111/// We don't want to generate something like:
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002112/// void *X = &X/42;
2113/// because the code generator doesn't have a relocation that can handle that.
2114///
2115/// This function should be called if C was not found (but just got inserted)
2116/// in SimpleConstants to avoid having to rescan the same constants all the
2117/// time.
Mehdi Amini46a43552015-03-04 18:43:29 +00002118static bool
2119isSimpleEnoughValueToCommitHelper(Constant *C,
2120 SmallPtrSetImpl<Constant *> &SimpleConstants,
2121 const DataLayout &DL) {
David Majnemer6098b2f2014-06-26 03:02:19 +00002122 // Simple global addresses are supported, do not allow dllimport or
2123 // thread-local globals.
David Majnemer23fc9af2014-06-24 06:53:45 +00002124 if (auto *GV = dyn_cast<GlobalValue>(C))
David Majnemer6098b2f2014-06-26 03:02:19 +00002125 return !GV->hasDLLImportStorageClass() && !GV->isThreadLocal();
David Majnemer23fc9af2014-06-24 06:53:45 +00002126
2127 // Simple integer, undef, constant aggregate zero, etc are all supported.
2128 if (C->getNumOperands() == 0 || isa<BlockAddress>(C))
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002129 return true;
Jakub Staszak9525a772012-12-06 21:57:16 +00002130
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002131 // Aggregate values are safe if all their elements are.
2132 if (isa<ConstantArray>(C) || isa<ConstantStruct>(C) ||
2133 isa<ConstantVector>(C)) {
Pete Cooper125ad172015-06-25 20:51:38 +00002134 for (Value *Op : C->operands())
2135 if (!isSimpleEnoughValueToCommit(cast<Constant>(Op), SimpleConstants, DL))
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002136 return false;
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002137 return true;
2138 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002139
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002140 // We don't know exactly what relocations are allowed in constant expressions,
2141 // so we allow &global+constantoffset, which is safe and uniformly supported
2142 // across targets.
2143 ConstantExpr *CE = cast<ConstantExpr>(C);
2144 switch (CE->getOpcode()) {
2145 case Instruction::BitCast:
Eli Friedman55fa49f32012-01-05 23:03:32 +00002146 // Bitcast is fine if the casted value is fine.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002147 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, DL);
Eli Friedman55fa49f32012-01-05 23:03:32 +00002148
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002149 case Instruction::IntToPtr:
2150 case Instruction::PtrToInt:
Eli Friedman55fa49f32012-01-05 23:03:32 +00002151 // int <=> ptr is fine if the int type is the same size as the
2152 // pointer type.
Mehdi Amini46a43552015-03-04 18:43:29 +00002153 if (DL.getTypeSizeInBits(CE->getType()) !=
2154 DL.getTypeSizeInBits(CE->getOperand(0)->getType()))
Eli Friedman55fa49f32012-01-05 23:03:32 +00002155 return false;
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002156 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, DL);
Jakub Staszak9525a772012-12-06 21:57:16 +00002157
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002158 // GEP is fine if it is simple + constant offset.
2159 case Instruction::GetElementPtr:
2160 for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
2161 if (!isa<ConstantInt>(CE->getOperand(i)))
2162 return false;
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002163 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, DL);
Jakub Staszak9525a772012-12-06 21:57:16 +00002164
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002165 case Instruction::Add:
2166 // We allow simple+cst.
2167 if (!isa<ConstantInt>(CE->getOperand(1)))
2168 return false;
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002169 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, DL);
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002170 }
2171 return false;
2172}
2173
Jakub Staszak9525a772012-12-06 21:57:16 +00002174static inline bool
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002175isSimpleEnoughValueToCommit(Constant *C,
Mehdi Amini46a43552015-03-04 18:43:29 +00002176 SmallPtrSetImpl<Constant *> &SimpleConstants,
2177 const DataLayout &DL) {
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002178 // If we already checked this constant, we win.
David Blaikie70573dc2014-11-19 07:49:26 +00002179 if (!SimpleConstants.insert(C).second)
2180 return true;
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002181 // Check the constant.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002182 return isSimpleEnoughValueToCommitHelper(C, SimpleConstants, DL);
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002183}
2184
2185
James Molloyea31ad32015-11-13 11:05:07 +00002186/// Return true if this constant is simple enough for us to understand. In
2187/// particular, if it is a cast to anything other than from one pointer type to
2188/// another pointer type, we punt. We basically just support direct accesses to
2189/// globals and GEP's of globals. This should be kept up to date with
2190/// CommitValueTo.
Chris Lattner46b5c642009-11-06 04:27:31 +00002191static bool isSimpleEnoughPointerToCommit(Constant *C) {
Dan Gohman82e74752009-09-07 22:42:05 +00002192 // Conservatively, avoid aggregate types. This is because we don't
2193 // want to worry about them partially overlapping other stores.
2194 if (!cast<PointerType>(C->getType())->getElementType()->isSingleValueType())
2195 return false;
2196
Dan Gohmanf7f3fb12009-09-07 22:31:26 +00002197 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
David Majnemer23fc9af2014-06-24 06:53:45 +00002198 // Do not allow weak/*_odr/linkonce linkage or external globals.
Mikhail Glushenkov2072db22010-10-19 16:47:23 +00002199 return GV->hasUniqueInitializer();
Dan Gohmanf7f3fb12009-09-07 22:31:26 +00002200
Owen Anderson3e2f6cf2011-01-14 22:31:13 +00002201 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Chris Lattner46af55e2005-09-26 06:52:44 +00002202 // Handle a constantexpr gep.
2203 if (CE->getOpcode() == Instruction::GetElementPtr &&
Dan Gohmanbeee35a2009-09-07 22:40:13 +00002204 isa<GlobalVariable>(CE->getOperand(0)) &&
2205 cast<GEPOperator>(CE)->isInBounds()) {
Chris Lattner46af55e2005-09-26 06:52:44 +00002206 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Mikhail Glushenkov2072db22010-10-19 16:47:23 +00002207 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
Dan Gohmanf7f3fb12009-09-07 22:31:26 +00002208 // external globals.
Mikhail Glushenkov2072db22010-10-19 16:47:23 +00002209 if (!GV->hasUniqueInitializer())
Dan Gohmanf7f3fb12009-09-07 22:31:26 +00002210 return false;
Dan Gohman161429f2009-09-07 22:44:55 +00002211
Dan Gohman161429f2009-09-07 22:44:55 +00002212 // The first index must be zero.
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +00002213 ConstantInt *CI = dyn_cast<ConstantInt>(*std::next(CE->op_begin()));
Dan Gohman161429f2009-09-07 22:44:55 +00002214 if (!CI || !CI->isZero()) return false;
Dan Gohman161429f2009-09-07 22:44:55 +00002215
2216 // The remaining indices must be compile-time known integers within the
Dan Gohman7190d482009-09-10 23:37:55 +00002217 // notional bounds of the corresponding static array types.
2218 if (!CE->isGEPWithNoNotionalOverIndexing())
2219 return false;
Dan Gohman161429f2009-09-07 22:44:55 +00002220
Dan Gohmane525d9d2009-10-05 16:36:26 +00002221 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
Jakub Staszak9525a772012-12-06 21:57:16 +00002222
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002223 // A constantexpr bitcast from a pointer to another pointer is a no-op,
2224 // and we know how to evaluate it by moving the bitcast from the pointer
2225 // operand to the value operand.
2226 } else if (CE->getOpcode() == Instruction::BitCast &&
Chris Lattner8b4952f2011-01-16 02:05:10 +00002227 isa<GlobalVariable>(CE->getOperand(0))) {
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002228 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
2229 // external globals.
Chris Lattner8b4952f2011-01-16 02:05:10 +00002230 return cast<GlobalVariable>(CE->getOperand(0))->hasUniqueInitializer();
Chris Lattner46af55e2005-09-26 06:52:44 +00002231 }
Owen Anderson3e2f6cf2011-01-14 22:31:13 +00002232 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002233
Chris Lattner99e23fa2005-09-26 04:44:35 +00002234 return false;
2235}
2236
James Molloyea31ad32015-11-13 11:05:07 +00002237/// Evaluate a piece of a constantexpr store into a global initializer. This
2238/// returns 'Init' modified to reflect 'Val' stored into it. At this point, the
2239/// GEP operands of Addr [0, OpNo) have been stepped into.
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002240static Constant *EvaluateStoreInto(Constant *Init, Constant *Val,
2241 ConstantExpr *Addr, unsigned OpNo) {
2242 // Base case of the recursion.
2243 if (OpNo == Addr->getNumOperands()) {
2244 assert(Val->getType() == Init->getType() && "Type mismatch!");
2245 return Val;
2246 }
2247
2248 SmallVector<Constant*, 32> Elts;
2249 if (StructType *STy = dyn_cast<StructType>(Init->getType())) {
2250 // Break up the constant into its elements.
2251 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
2252 Elts.push_back(Init->getAggregateElement(i));
2253
2254 // Replace the element that we are supposed to.
2255 ConstantInt *CU = cast<ConstantInt>(Addr->getOperand(OpNo));
2256 unsigned Idx = CU->getZExtValue();
2257 assert(Idx < STy->getNumElements() && "Struct index out of range!");
2258 Elts[Idx] = EvaluateStoreInto(Elts[Idx], Val, Addr, OpNo+1);
2259
2260 // Return the modified struct.
2261 return ConstantStruct::get(STy, Elts);
2262 }
2263
2264 ConstantInt *CI = cast<ConstantInt>(Addr->getOperand(OpNo));
2265 SequentialType *InitTy = cast<SequentialType>(Init->getType());
2266
2267 uint64_t NumElts;
2268 if (ArrayType *ATy = dyn_cast<ArrayType>(InitTy))
2269 NumElts = ATy->getNumElements();
2270 else
2271 NumElts = InitTy->getVectorNumElements();
2272
2273 // Break up the array into elements.
2274 for (uint64_t i = 0, e = NumElts; i != e; ++i)
2275 Elts.push_back(Init->getAggregateElement(i));
2276
2277 assert(CI->getZExtValue() < NumElts);
2278 Elts[CI->getZExtValue()] =
2279 EvaluateStoreInto(Elts[CI->getZExtValue()], Val, Addr, OpNo+1);
2280
2281 if (Init->getType()->isArrayTy())
2282 return ConstantArray::get(cast<ArrayType>(InitTy), Elts);
2283 return ConstantVector::get(Elts);
2284}
2285
James Molloyea31ad32015-11-13 11:05:07 +00002286/// We have decided that Addr (which satisfies the predicate
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002287/// isSimpleEnoughPointerToCommit) should get Val as its value. Make it happen.
2288static void CommitValueTo(Constant *Val, Constant *Addr) {
2289 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Addr)) {
2290 assert(GV->hasInitializer());
2291 GV->setInitializer(Val);
2292 return;
2293 }
2294
2295 ConstantExpr *CE = cast<ConstantExpr>(Addr);
2296 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
2297 GV->setInitializer(EvaluateStoreInto(GV->getInitializer(), Val, CE, 2));
2298}
2299
Nick Lewycky60829a582012-02-20 03:25:59 +00002300namespace {
2301
James Molloyea31ad32015-11-13 11:05:07 +00002302/// This class evaluates LLVM IR, producing the Constant representing each SSA
2303/// instruction. Changes to global variables are stored in a mapping that can
2304/// be iterated over after the evaluation is complete. Once an evaluation call
2305/// fails, the evaluation object should not be reused.
Nick Lewycky60829a582012-02-20 03:25:59 +00002306class Evaluator {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002307public:
Mehdi Amini46a43552015-03-04 18:43:29 +00002308 Evaluator(const DataLayout &DL, const TargetLibraryInfo *TLI)
2309 : DL(DL), TLI(TLI) {
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002310 ValueStack.emplace_back();
Nick Lewycky73be5e32012-02-19 23:26:27 +00002311 }
2312
Nick Lewycky60829a582012-02-20 03:25:59 +00002313 ~Evaluator() {
David Blaikiebc442202014-04-21 20:49:36 +00002314 for (auto &Tmp : AllocaTmps)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002315 // If there are still users of the alloca, the program is doing something
2316 // silly, e.g. storing the address of the alloca somewhere and using it
2317 // later. Since this is undefined, we'll just make it be null.
2318 if (!Tmp->use_empty())
2319 Tmp->replaceAllUsesWith(Constant::getNullValue(Tmp->getType()));
Nick Lewycky73be5e32012-02-19 23:26:27 +00002320 }
2321
James Molloyea31ad32015-11-13 11:05:07 +00002322 /// Evaluate a call to function F, returning true if successful, false if we
2323 /// can't evaluate it. ActualArgs contains the formal arguments for the
2324 /// function.
Nick Lewycky73be5e32012-02-19 23:26:27 +00002325 bool EvaluateFunction(Function *F, Constant *&RetVal,
2326 const SmallVectorImpl<Constant*> &ActualArgs);
2327
James Molloyea31ad32015-11-13 11:05:07 +00002328 /// Evaluate all instructions in block BB, returning true if successful, false
2329 /// if we can't evaluate it. NewBB returns the next BB that control flows
2330 /// into, or null upon return.
Nick Lewycky73be5e32012-02-19 23:26:27 +00002331 bool EvaluateBlock(BasicBlock::iterator CurInst, BasicBlock *&NextBB);
2332
2333 Constant *getVal(Value *V) {
2334 if (Constant *CV = dyn_cast<Constant>(V)) return CV;
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002335 Constant *R = ValueStack.back().lookup(V);
Nick Lewycky73be5e32012-02-19 23:26:27 +00002336 assert(R && "Reference to an uncomputed value!");
2337 return R;
2338 }
2339
2340 void setVal(Value *V, Constant *C) {
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002341 ValueStack.back()[V] = C;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002342 }
2343
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002344 const DenseMap<Constant*, Constant*> &getMutatedMemory() const {
2345 return MutatedMemory;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002346 }
2347
Craig Topper71b7b682014-08-21 05:55:13 +00002348 const SmallPtrSetImpl<GlobalVariable*> &getInvariants() const {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002349 return Invariants;
2350 }
2351
2352private:
2353 Constant *ComputeLoadResult(Constant *P);
2354
James Molloyea31ad32015-11-13 11:05:07 +00002355 /// As we compute SSA register values, we store their contents here. The back
2356 /// of the deque contains the current function and the stack contains the
2357 /// values in the calling frames.
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002358 std::deque<DenseMap<Value*, Constant*>> ValueStack;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002359
James Molloyea31ad32015-11-13 11:05:07 +00002360 /// This is used to detect recursion. In pathological situations we could hit
2361 /// exponential behavior, but at least there is nothing unbounded.
Nick Lewycky73be5e32012-02-19 23:26:27 +00002362 SmallVector<Function*, 4> CallStack;
2363
James Molloyea31ad32015-11-13 11:05:07 +00002364 /// For each store we execute, we update this map. Loads check this to get
2365 /// the most up-to-date value. If evaluation is successful, this state is
2366 /// committed to the process.
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002367 DenseMap<Constant*, Constant*> MutatedMemory;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002368
James Molloyea31ad32015-11-13 11:05:07 +00002369 /// To 'execute' an alloca, we create a temporary global variable to represent
2370 /// its body. This vector is needed so we can delete the temporary globals
2371 /// when we are done.
David Blaikiebc442202014-04-21 20:49:36 +00002372 SmallVector<std::unique_ptr<GlobalVariable>, 32> AllocaTmps;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002373
James Molloyea31ad32015-11-13 11:05:07 +00002374 /// These global variables have been marked invariant by the static
2375 /// constructor.
Nick Lewycky73be5e32012-02-19 23:26:27 +00002376 SmallPtrSet<GlobalVariable*, 8> Invariants;
2377
James Molloyea31ad32015-11-13 11:05:07 +00002378 /// These are constants we have checked and know to be simple enough to live
2379 /// in a static initializer of a global.
Nick Lewycky73be5e32012-02-19 23:26:27 +00002380 SmallPtrSet<Constant*, 8> SimpleConstants;
2381
Mehdi Amini46a43552015-03-04 18:43:29 +00002382 const DataLayout &DL;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002383 const TargetLibraryInfo *TLI;
2384};
2385
Nick Lewycky60829a582012-02-20 03:25:59 +00002386} // anonymous namespace
2387
James Molloyea31ad32015-11-13 11:05:07 +00002388/// Return the value that would be computed by a load from P after the stores
2389/// reflected by 'memory' have been performed. If we can't decide, return null.
Nick Lewycky60829a582012-02-20 03:25:59 +00002390Constant *Evaluator::ComputeLoadResult(Constant *P) {
Chris Lattner4b05c322005-09-26 05:15:37 +00002391 // If this memory location has been recently stored, use the stored value: it
2392 // is the most up-to-date.
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002393 DenseMap<Constant*, Constant*>::const_iterator I = MutatedMemory.find(P);
2394 if (I != MutatedMemory.end()) return I->second;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002395
Chris Lattner4b05c322005-09-26 05:15:37 +00002396 // Access it.
2397 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(P)) {
Dan Gohman5d5bc6d2009-08-19 18:20:44 +00002398 if (GV->hasDefinitiveInitializer())
Chris Lattner4b05c322005-09-26 05:15:37 +00002399 return GV->getInitializer();
Craig Topperf40110f2014-04-25 05:29:35 +00002400 return nullptr;
Chris Lattner4b05c322005-09-26 05:15:37 +00002401 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002402
Chris Lattner46af55e2005-09-26 06:52:44 +00002403 // Handle a constantexpr getelementptr.
2404 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(P))
2405 if (CE->getOpcode() == Instruction::GetElementPtr &&
2406 isa<GlobalVariable>(CE->getOperand(0))) {
2407 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Dan Gohman5d5bc6d2009-08-19 18:20:44 +00002408 if (GV->hasDefinitiveInitializer())
Dan Gohmane525d9d2009-10-05 16:36:26 +00002409 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
Chris Lattner46af55e2005-09-26 06:52:44 +00002410 }
2411
Craig Topperf40110f2014-04-25 05:29:35 +00002412 return nullptr; // don't know how to evaluate.
Chris Lattner4b05c322005-09-26 05:15:37 +00002413}
2414
James Molloyea31ad32015-11-13 11:05:07 +00002415/// Evaluate all instructions in block BB, returning true if successful, false
2416/// if we can't evaluate it. NewBB returns the next BB that control flows into,
2417/// or null upon return.
Nick Lewycky60829a582012-02-20 03:25:59 +00002418bool Evaluator::EvaluateBlock(BasicBlock::iterator CurInst,
2419 BasicBlock *&NextBB) {
Chris Lattner99e23fa2005-09-26 04:44:35 +00002420 // This is the main evaluation loop.
2421 while (1) {
Craig Topperf40110f2014-04-25 05:29:35 +00002422 Constant *InstResult = nullptr;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002423
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002424 DEBUG(dbgs() << "Evaluating Instruction: " << *CurInst << "\n");
2425
Chris Lattner99e23fa2005-09-26 04:44:35 +00002426 if (StoreInst *SI = dyn_cast<StoreInst>(CurInst)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002427 if (!SI->isSimple()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002428 DEBUG(dbgs() << "Store is not simple! Can not evaluate.\n");
2429 return false; // no volatile/atomic accesses.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002430 }
Nick Lewycky73be5e32012-02-19 23:26:27 +00002431 Constant *Ptr = getVal(SI->getOperand(1));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002432 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002433 DEBUG(dbgs() << "Folding constant ptr expression: " << *Ptr);
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002434 Ptr = ConstantFoldConstantExpression(CE, DL, TLI);
Michael Gottesman2a654272013-01-11 23:08:52 +00002435 DEBUG(dbgs() << "; To: " << *Ptr << "\n");
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002436 }
2437 if (!isSimpleEnoughPointerToCommit(Ptr)) {
Chris Lattner99e23fa2005-09-26 04:44:35 +00002438 // If this is too complex for us to commit, reject it.
Michael Gottesman2a654272013-01-11 23:08:52 +00002439 DEBUG(dbgs() << "Pointer is too complex for us to evaluate store.");
Chris Lattner65a3a092005-09-27 04:45:34 +00002440 return false;
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002441 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002442
Nick Lewycky73be5e32012-02-19 23:26:27 +00002443 Constant *Val = getVal(SI->getOperand(0));
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002444
2445 // If this might be too difficult for the backend to handle (e.g. the addr
2446 // of one global variable divided by another) then we can't commit it.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002447 if (!isSimpleEnoughValueToCommit(Val, SimpleConstants, DL)) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002448 DEBUG(dbgs() << "Store value is too complex to evaluate store. " << *Val
2449 << "\n");
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002450 return false;
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002451 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002452
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002453 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002454 if (CE->getOpcode() == Instruction::BitCast) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002455 DEBUG(dbgs() << "Attempting to resolve bitcast on constant ptr.\n");
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002456 // If we're evaluating a store through a bitcast, then we need
2457 // to pull the bitcast off the pointer type and push it onto the
2458 // stored value.
Chris Lattner8b4952f2011-01-16 02:05:10 +00002459 Ptr = CE->getOperand(0);
Jakub Staszak9525a772012-12-06 21:57:16 +00002460
Nick Lewycky239fdf02012-02-06 08:24:44 +00002461 Type *NewTy = cast<PointerType>(Ptr->getType())->getElementType();
Jakub Staszak9525a772012-12-06 21:57:16 +00002462
Owen Anderson4e54efd2011-01-16 04:33:33 +00002463 // In order to push the bitcast onto the stored value, a bitcast
2464 // from NewTy to Val's type must be legal. If it's not, we can try
2465 // introspecting NewTy to find a legal conversion.
2466 while (!Val->getType()->canLosslesslyBitCastTo(NewTy)) {
2467 // If NewTy is a struct, we can convert the pointer to the struct
2468 // into a pointer to its first member.
2469 // FIXME: This could be extended to support arrays as well.
Chris Lattner229907c2011-07-18 04:54:35 +00002470 if (StructType *STy = dyn_cast<StructType>(NewTy)) {
Owen Anderson4e54efd2011-01-16 04:33:33 +00002471 NewTy = STy->getTypeAtIndex(0U);
2472
Nick Lewycky239fdf02012-02-06 08:24:44 +00002473 IntegerType *IdxTy = IntegerType::get(NewTy->getContext(), 32);
Owen Anderson4e54efd2011-01-16 04:33:33 +00002474 Constant *IdxZero = ConstantInt::get(IdxTy, 0, false);
2475 Constant * const IdxList[] = {IdxZero, IdxZero};
2476
David Blaikie4a2e73b2015-04-02 18:55:32 +00002477 Ptr = ConstantExpr::getGetElementPtr(nullptr, Ptr, IdxList);
Nick Lewycky9d0da182012-02-21 22:08:06 +00002478 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002479 Ptr = ConstantFoldConstantExpression(CE, DL, TLI);
Nick Lewycky9d0da182012-02-21 22:08:06 +00002480
Owen Anderson4e54efd2011-01-16 04:33:33 +00002481 // If we can't improve the situation by introspecting NewTy,
2482 // we have to give up.
2483 } else {
Michael Gottesman2a654272013-01-11 23:08:52 +00002484 DEBUG(dbgs() << "Failed to bitcast constant ptr, can not "
2485 "evaluate.\n");
Nick Lewycky239fdf02012-02-06 08:24:44 +00002486 return false;
Owen Anderson4e54efd2011-01-16 04:33:33 +00002487 }
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002488 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002489
Owen Anderson4e54efd2011-01-16 04:33:33 +00002490 // If we found compatible types, go ahead and push the bitcast
2491 // onto the stored value.
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002492 Val = ConstantExpr::getBitCast(Val, NewTy);
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002493
Michael Gottesman2a654272013-01-11 23:08:52 +00002494 DEBUG(dbgs() << "Evaluated bitcast: " << *Val << "\n");
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002495 }
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002496 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002497
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002498 MutatedMemory[Ptr] = Val;
Chris Lattner99e23fa2005-09-26 04:44:35 +00002499 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CurInst)) {
Owen Anderson487375e2009-07-29 18:55:55 +00002500 InstResult = ConstantExpr::get(BO->getOpcode(),
Nick Lewycky73be5e32012-02-19 23:26:27 +00002501 getVal(BO->getOperand(0)),
2502 getVal(BO->getOperand(1)));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002503 DEBUG(dbgs() << "Found a BinaryOperator! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002504 << "\n");
Reid Spencer266e42b2006-12-23 06:05:41 +00002505 } else if (CmpInst *CI = dyn_cast<CmpInst>(CurInst)) {
Owen Anderson487375e2009-07-29 18:55:55 +00002506 InstResult = ConstantExpr::getCompare(CI->getPredicate(),
Nick Lewycky73be5e32012-02-19 23:26:27 +00002507 getVal(CI->getOperand(0)),
2508 getVal(CI->getOperand(1)));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002509 DEBUG(dbgs() << "Found a CmpInst! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002510 << "\n");
Chris Lattner99e23fa2005-09-26 04:44:35 +00002511 } else if (CastInst *CI = dyn_cast<CastInst>(CurInst)) {
Owen Anderson487375e2009-07-29 18:55:55 +00002512 InstResult = ConstantExpr::getCast(CI->getOpcode(),
Nick Lewycky73be5e32012-02-19 23:26:27 +00002513 getVal(CI->getOperand(0)),
Chris Lattner99e23fa2005-09-26 04:44:35 +00002514 CI->getType());
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002515 DEBUG(dbgs() << "Found a Cast! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002516 << "\n");
Chris Lattner99e23fa2005-09-26 04:44:35 +00002517 } else if (SelectInst *SI = dyn_cast<SelectInst>(CurInst)) {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002518 InstResult = ConstantExpr::getSelect(getVal(SI->getOperand(0)),
2519 getVal(SI->getOperand(1)),
2520 getVal(SI->getOperand(2)));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002521 DEBUG(dbgs() << "Found a Select! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002522 << "\n");
David Majnemerfe8c7542014-08-08 05:50:43 +00002523 } else if (auto *EVI = dyn_cast<ExtractValueInst>(CurInst)) {
2524 InstResult = ConstantExpr::getExtractValue(
2525 getVal(EVI->getAggregateOperand()), EVI->getIndices());
2526 DEBUG(dbgs() << "Found an ExtractValueInst! Simplifying: " << *InstResult
2527 << "\n");
2528 } else if (auto *IVI = dyn_cast<InsertValueInst>(CurInst)) {
2529 InstResult = ConstantExpr::getInsertValue(
2530 getVal(IVI->getAggregateOperand()),
2531 getVal(IVI->getInsertedValueOperand()), IVI->getIndices());
2532 DEBUG(dbgs() << "Found an InsertValueInst! Simplifying: " << *InstResult
2533 << "\n");
Chris Lattner4b05c322005-09-26 05:15:37 +00002534 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(CurInst)) {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002535 Constant *P = getVal(GEP->getOperand(0));
Chris Lattnerf96f4a82007-01-31 04:40:53 +00002536 SmallVector<Constant*, 8> GEPOps;
Gabor Greif3a9fba52008-05-29 01:59:18 +00002537 for (User::op_iterator i = GEP->op_begin() + 1, e = GEP->op_end();
2538 i != e; ++i)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002539 GEPOps.push_back(getVal(*i));
Jay Foad2f5fc8c2011-07-21 15:15:37 +00002540 InstResult =
David Blaikie4a2e73b2015-04-02 18:55:32 +00002541 ConstantExpr::getGetElementPtr(GEP->getSourceElementType(), P, GEPOps,
2542 cast<GEPOperator>(GEP)->isInBounds());
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002543 DEBUG(dbgs() << "Found a GEP! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002544 << "\n");
Chris Lattner4b05c322005-09-26 05:15:37 +00002545 } else if (LoadInst *LI = dyn_cast<LoadInst>(CurInst)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002546
2547 if (!LI->isSimple()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002548 DEBUG(dbgs() << "Found a Load! Not a simple load, can not evaluate.\n");
2549 return false; // no volatile/atomic accesses.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002550 }
2551
Nick Lewycky9d0da182012-02-21 22:08:06 +00002552 Constant *Ptr = getVal(LI->getOperand(0));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002553 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002554 Ptr = ConstantFoldConstantExpression(CE, DL, TLI);
Michael Gottesman2a654272013-01-11 23:08:52 +00002555 DEBUG(dbgs() << "Found a constant pointer expression, constant "
2556 "folding: " << *Ptr << "\n");
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002557 }
Nick Lewycky9d0da182012-02-21 22:08:06 +00002558 InstResult = ComputeLoadResult(Ptr);
Craig Topperf40110f2014-04-25 05:29:35 +00002559 if (!InstResult) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002560 DEBUG(dbgs() << "Failed to compute load result. Can not evaluate load."
2561 "\n");
2562 return false; // Could not evaluate load.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002563 }
2564
2565 DEBUG(dbgs() << "Evaluated load: " << *InstResult << "\n");
Chris Lattner6bf2cd52005-09-26 17:07:09 +00002566 } else if (AllocaInst *AI = dyn_cast<AllocaInst>(CurInst)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002567 if (AI->isArrayAllocation()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002568 DEBUG(dbgs() << "Found an array alloca. Can not evaluate.\n");
2569 return false; // Cannot handle array allocs.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002570 }
Eduard Burtescu90c44492016-01-18 00:10:01 +00002571 Type *Ty = AI->getAllocatedType();
David Blaikiebc442202014-04-21 20:49:36 +00002572 AllocaTmps.push_back(
2573 make_unique<GlobalVariable>(Ty, false, GlobalValue::InternalLinkage,
2574 UndefValue::get(Ty), AI->getName()));
2575 InstResult = AllocaTmps.back().get();
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002576 DEBUG(dbgs() << "Found an alloca. Result: " << *InstResult << "\n");
Nick Lewyckyc1572e42012-02-12 05:09:35 +00002577 } else if (isa<CallInst>(CurInst) || isa<InvokeInst>(CurInst)) {
Duncan P. N. Exon Smith17323402015-10-13 17:51:03 +00002578 CallSite CS(&*CurInst);
Devang Patel04852aa2009-03-09 23:04:12 +00002579
2580 // Debug info can safely be ignored here.
Nick Lewyckyc1572e42012-02-12 05:09:35 +00002581 if (isa<DbgInfoIntrinsic>(CS.getInstruction())) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002582 DEBUG(dbgs() << "Ignoring debug info.\n");
Devang Patel04852aa2009-03-09 23:04:12 +00002583 ++CurInst;
2584 continue;
2585 }
2586
Chris Lattnerfd2e13b2006-07-07 21:37:01 +00002587 // Cannot handle inline asm.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002588 if (isa<InlineAsm>(CS.getCalledValue())) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002589 DEBUG(dbgs() << "Found inline asm, can not evaluate.\n");
2590 return false;
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002591 }
Chris Lattnerfd2e13b2006-07-07 21:37:01 +00002592
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002593 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction())) {
2594 if (MemSetInst *MSI = dyn_cast<MemSetInst>(II)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002595 if (MSI->isVolatile()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002596 DEBUG(dbgs() << "Can not optimize a volatile memset " <<
2597 "intrinsic.\n");
2598 return false;
2599 }
Nick Lewycky73be5e32012-02-19 23:26:27 +00002600 Constant *Ptr = getVal(MSI->getDest());
2601 Constant *Val = getVal(MSI->getValue());
2602 Constant *DestVal = ComputeLoadResult(getVal(Ptr));
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002603 if (Val->isNullValue() && DestVal && DestVal->isNullValue()) {
2604 // This memset is a no-op.
Michael Gottesman2a654272013-01-11 23:08:52 +00002605 DEBUG(dbgs() << "Ignoring no-op memset.\n");
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002606 ++CurInst;
2607 continue;
2608 }
2609 }
2610
2611 if (II->getIntrinsicID() == Intrinsic::lifetime_start ||
2612 II->getIntrinsicID() == Intrinsic::lifetime_end) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002613 DEBUG(dbgs() << "Ignoring lifetime intrinsic.\n");
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002614 ++CurInst;
2615 continue;
2616 }
2617
2618 if (II->getIntrinsicID() == Intrinsic::invariant_start) {
2619 // We don't insert an entry into Values, as it doesn't have a
2620 // meaningful return value.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002621 if (!II->use_empty()) {
Alp Tokerf907b892013-12-05 05:44:44 +00002622 DEBUG(dbgs() << "Found unused invariant_start. Can't evaluate.\n");
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002623 return false;
Michael Gottesman2a654272013-01-11 23:08:52 +00002624 }
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002625 ConstantInt *Size = cast<ConstantInt>(II->getArgOperand(0));
Nick Lewycky519561f2012-02-20 23:32:26 +00002626 Value *PtrArg = getVal(II->getArgOperand(1));
2627 Value *Ptr = PtrArg->stripPointerCasts();
2628 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Ptr)) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +00002629 Type *ElemTy = GV->getValueType();
Mehdi Amini46a43552015-03-04 18:43:29 +00002630 if (!Size->isAllOnesValue() &&
Nick Lewycky519561f2012-02-20 23:32:26 +00002631 Size->getValue().getLimitedValue() >=
Mehdi Amini46a43552015-03-04 18:43:29 +00002632 DL.getTypeStoreSize(ElemTy)) {
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002633 Invariants.insert(GV);
Michael Gottesman2a654272013-01-11 23:08:52 +00002634 DEBUG(dbgs() << "Found a global var that is an invariant: " << *GV
2635 << "\n");
2636 } else {
2637 DEBUG(dbgs() << "Found a global var, but can not treat it as an "
2638 "invariant.\n");
2639 }
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002640 }
2641 // Continue even if we do nothing.
Nick Lewyckya3bb03e2011-05-29 18:41:56 +00002642 ++CurInst;
2643 continue;
Piotr Padlewski4e7f7522015-08-25 01:34:15 +00002644 } else if (II->getIntrinsicID() == Intrinsic::assume) {
2645 DEBUG(dbgs() << "Skipping assume intrinsic.\n");
2646 ++CurInst;
2647 continue;
Nick Lewyckya3bb03e2011-05-29 18:41:56 +00002648 }
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002649
Michael Gottesman2a654272013-01-11 23:08:52 +00002650 DEBUG(dbgs() << "Unknown intrinsic. Can not evaluate.\n");
Nick Lewyckya3bb03e2011-05-29 18:41:56 +00002651 return false;
2652 }
2653
Chris Lattner65a3a092005-09-27 04:45:34 +00002654 // Resolve function pointers.
Nick Lewycky73be5e32012-02-19 23:26:27 +00002655 Function *Callee = dyn_cast<Function>(getVal(CS.getCalledValue()));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002656 if (!Callee || Callee->mayBeOverridden()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002657 DEBUG(dbgs() << "Can not resolve function pointer.\n");
Nick Lewyckyc1572e42012-02-12 05:09:35 +00002658 return false; // Cannot resolve.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002659 }
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002660
Duncan Sandsc4ce58d82009-08-17 14:33:27 +00002661 SmallVector<Constant*, 8> Formals;
Nick Lewyckyc1572e42012-02-12 05:09:35 +00002662 for (User::op_iterator i = CS.arg_begin(), e = CS.arg_end(); i != e; ++i)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002663 Formals.push_back(getVal(*i));
Duncan Sandsc4ce58d82009-08-17 14:33:27 +00002664
Reid Spencer5301e7c2007-01-30 20:08:39 +00002665 if (Callee->isDeclaration()) {
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002666 // If this is a function we can constant fold, do it.
Chad Rosiere6de63d2011-12-01 21:29:16 +00002667 if (Constant *C = ConstantFoldCall(Callee, Formals, TLI)) {
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002668 InstResult = C;
Michael Gottesman2a654272013-01-11 23:08:52 +00002669 DEBUG(dbgs() << "Constant folded function call. Result: " <<
2670 *InstResult << "\n");
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002671 } else {
Michael Gottesman2a654272013-01-11 23:08:52 +00002672 DEBUG(dbgs() << "Can not constant fold function call.\n");
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002673 return false;
2674 }
2675 } else {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002676 if (Callee->getFunctionType()->isVarArg()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002677 DEBUG(dbgs() << "Can not constant fold vararg function call.\n");
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002678 return false;
Michael Gottesman2a654272013-01-11 23:08:52 +00002679 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002680
Craig Topperf40110f2014-04-25 05:29:35 +00002681 Constant *RetVal = nullptr;
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002682 // Execute the call, if successful, use the return value.
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002683 ValueStack.emplace_back();
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002684 if (!EvaluateFunction(Callee, RetVal, Formals)) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002685 DEBUG(dbgs() << "Failed to evaluate function.\n");
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002686 return false;
Michael Gottesman2a654272013-01-11 23:08:52 +00002687 }
David Blaikiebc442202014-04-21 20:49:36 +00002688 ValueStack.pop_back();
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002689 InstResult = RetVal;
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002690
Craig Topperf40110f2014-04-25 05:29:35 +00002691 if (InstResult) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002692 DEBUG(dbgs() << "Successfully evaluated function. Result: " <<
2693 InstResult << "\n\n");
2694 } else {
2695 DEBUG(dbgs() << "Successfully evaluated function. Result: 0\n\n");
2696 }
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002697 }
Reid Spencerde46e482006-11-02 20:25:50 +00002698 } else if (isa<TerminatorInst>(CurInst)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002699 DEBUG(dbgs() << "Found a terminator instruction.\n");
2700
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002701 if (BranchInst *BI = dyn_cast<BranchInst>(CurInst)) {
2702 if (BI->isUnconditional()) {
Nick Lewycky239fdf02012-02-06 08:24:44 +00002703 NextBB = BI->getSuccessor(0);
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002704 } else {
Zhou Sheng75b871f2007-01-11 12:24:14 +00002705 ConstantInt *Cond =
Nick Lewycky73be5e32012-02-19 23:26:27 +00002706 dyn_cast<ConstantInt>(getVal(BI->getCondition()));
Chris Lattner15649082007-01-12 18:30:11 +00002707 if (!Cond) return false; // Cannot determine.
Zhou Sheng75b871f2007-01-11 12:24:14 +00002708
Nick Lewycky239fdf02012-02-06 08:24:44 +00002709 NextBB = BI->getSuccessor(!Cond->getZExtValue());
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002710 }
2711 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurInst)) {
2712 ConstantInt *Val =
Nick Lewycky73be5e32012-02-19 23:26:27 +00002713 dyn_cast<ConstantInt>(getVal(SI->getCondition()));
Chris Lattner65a3a092005-09-27 04:45:34 +00002714 if (!Val) return false; // Cannot determine.
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00002715 NextBB = SI->findCaseValue(Val).getCaseSuccessor();
Chris Lattner31274882009-10-29 05:51:50 +00002716 } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(CurInst)) {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002717 Value *Val = getVal(IBI->getAddress())->stripPointerCasts();
Chris Lattner31274882009-10-29 05:51:50 +00002718 if (BlockAddress *BA = dyn_cast<BlockAddress>(Val))
Nick Lewycky239fdf02012-02-06 08:24:44 +00002719 NextBB = BA->getBasicBlock();
Chris Lattneraa99c942009-11-01 01:27:45 +00002720 else
2721 return false; // Cannot determine.
Nick Lewycky239fdf02012-02-06 08:24:44 +00002722 } else if (isa<ReturnInst>(CurInst)) {
Craig Topperf40110f2014-04-25 05:29:35 +00002723 NextBB = nullptr;
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002724 } else {
Bill Wendlingf891bf82011-07-31 06:30:59 +00002725 // invoke, unwind, resume, unreachable.
Michael Gottesman2a654272013-01-11 23:08:52 +00002726 DEBUG(dbgs() << "Can not handle terminator.");
Chris Lattner65a3a092005-09-27 04:45:34 +00002727 return false; // Cannot handle this terminator.
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002728 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002729
Nick Lewycky239fdf02012-02-06 08:24:44 +00002730 // We succeeded at evaluating this block!
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002731 DEBUG(dbgs() << "Successfully evaluated block.\n");
Nick Lewycky239fdf02012-02-06 08:24:44 +00002732 return true;
Chris Lattner99e23fa2005-09-26 04:44:35 +00002733 } else {
Chris Lattner99e23fa2005-09-26 04:44:35 +00002734 // Did not know how to evaluate this!
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002735 DEBUG(dbgs() << "Failed to evaluate block due to unhandled instruction."
Michael Gottesman2a654272013-01-11 23:08:52 +00002736 "\n");
Chris Lattner65a3a092005-09-27 04:45:34 +00002737 return false;
Chris Lattner99e23fa2005-09-26 04:44:35 +00002738 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002739
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002740 if (!CurInst->use_empty()) {
2741 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(InstResult))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002742 InstResult = ConstantFoldConstantExpression(CE, DL, TLI);
Jakub Staszak9525a772012-12-06 21:57:16 +00002743
Duncan P. N. Exon Smith17323402015-10-13 17:51:03 +00002744 setVal(&*CurInst, InstResult);
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002745 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002746
Dan Gohmaneab06fa2012-03-13 18:01:37 +00002747 // If we just processed an invoke, we finished evaluating the block.
2748 if (InvokeInst *II = dyn_cast<InvokeInst>(CurInst)) {
2749 NextBB = II->getNormalDest();
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002750 DEBUG(dbgs() << "Found an invoke instruction. Finished Block.\n\n");
Dan Gohmaneab06fa2012-03-13 18:01:37 +00002751 return true;
2752 }
2753
Chris Lattner99e23fa2005-09-26 04:44:35 +00002754 // Advance program counter.
2755 ++CurInst;
2756 }
Chris Lattnerda1889b2005-09-27 04:27:01 +00002757}
2758
James Molloyea31ad32015-11-13 11:05:07 +00002759/// Evaluate a call to function F, returning true if successful, false if we
2760/// can't evaluate it. ActualArgs contains the formal arguments for the
2761/// function.
Nick Lewycky60829a582012-02-20 03:25:59 +00002762bool Evaluator::EvaluateFunction(Function *F, Constant *&RetVal,
2763 const SmallVectorImpl<Constant*> &ActualArgs) {
Nick Lewycky239fdf02012-02-06 08:24:44 +00002764 // Check to see if this function is already executing (recursion). If so,
2765 // bail out. TODO: we might want to accept limited recursion.
2766 if (std::find(CallStack.begin(), CallStack.end(), F) != CallStack.end())
2767 return false;
2768
2769 CallStack.push_back(F);
2770
Nick Lewycky239fdf02012-02-06 08:24:44 +00002771 // Initialize arguments to the incoming values specified.
2772 unsigned ArgNo = 0;
2773 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end(); AI != E;
2774 ++AI, ++ArgNo)
Duncan P. N. Exon Smith17323402015-10-13 17:51:03 +00002775 setVal(&*AI, ActualArgs[ArgNo]);
Nick Lewycky239fdf02012-02-06 08:24:44 +00002776
2777 // ExecutedBlocks - We only handle non-looping, non-recursive code. As such,
2778 // we can only evaluate any one basic block at most once. This set keeps
2779 // track of what we have executed so we can detect recursive cases etc.
2780 SmallPtrSet<BasicBlock*, 32> ExecutedBlocks;
2781
2782 // CurBB - The current basic block we're evaluating.
Duncan P. N. Exon Smith17323402015-10-13 17:51:03 +00002783 BasicBlock *CurBB = &F->front();
Nick Lewycky239fdf02012-02-06 08:24:44 +00002784
Nick Lewycky4231c412012-02-12 00:47:24 +00002785 BasicBlock::iterator CurInst = CurBB->begin();
2786
Nick Lewycky239fdf02012-02-06 08:24:44 +00002787 while (1) {
Craig Topperf40110f2014-04-25 05:29:35 +00002788 BasicBlock *NextBB = nullptr; // Initialized to avoid compiler warnings.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002789 DEBUG(dbgs() << "Trying to evaluate BB: " << *CurBB << "\n");
2790
Nick Lewycky73be5e32012-02-19 23:26:27 +00002791 if (!EvaluateBlock(CurInst, NextBB))
Nick Lewycky239fdf02012-02-06 08:24:44 +00002792 return false;
2793
Craig Topperf40110f2014-04-25 05:29:35 +00002794 if (!NextBB) {
Nick Lewycky239fdf02012-02-06 08:24:44 +00002795 // Successfully running until there's no next block means that we found
2796 // the return. Fill it the return value and pop the call stack.
2797 ReturnInst *RI = cast<ReturnInst>(CurBB->getTerminator());
2798 if (RI->getNumOperands())
Nick Lewycky73be5e32012-02-19 23:26:27 +00002799 RetVal = getVal(RI->getOperand(0));
Nick Lewycky239fdf02012-02-06 08:24:44 +00002800 CallStack.pop_back();
2801 return true;
2802 }
2803
2804 // Okay, we succeeded in evaluating this control flow. See if we have
2805 // executed the new block before. If so, we have a looping function,
2806 // which we cannot evaluate in reasonable time.
David Blaikie70573dc2014-11-19 07:49:26 +00002807 if (!ExecutedBlocks.insert(NextBB).second)
Nick Lewycky239fdf02012-02-06 08:24:44 +00002808 return false; // looped!
2809
2810 // Okay, we have never been in this block before. Check to see if there
2811 // are any PHI nodes. If so, evaluate them with information about where
2812 // we came from.
Craig Topperf40110f2014-04-25 05:29:35 +00002813 PHINode *PN = nullptr;
Nick Lewycky4231c412012-02-12 00:47:24 +00002814 for (CurInst = NextBB->begin();
2815 (PN = dyn_cast<PHINode>(CurInst)); ++CurInst)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002816 setVal(PN, getVal(PN->getIncomingValueForBlock(CurBB)));
Nick Lewycky239fdf02012-02-06 08:24:44 +00002817
2818 // Advance to the next block.
2819 CurBB = NextBB;
2820 }
2821}
2822
James Molloyea31ad32015-11-13 11:05:07 +00002823/// Evaluate static constructors in the function, if we can. Return true if we
2824/// can, false otherwise.
Mehdi Amini46a43552015-03-04 18:43:29 +00002825static bool EvaluateStaticConstructor(Function *F, const DataLayout &DL,
Chad Rosiere6de63d2011-12-01 21:29:16 +00002826 const TargetLibraryInfo *TLI) {
Chris Lattnerda1889b2005-09-27 04:27:01 +00002827 // Call the function.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002828 Evaluator Eval(DL, TLI);
Chris Lattner65a3a092005-09-27 04:45:34 +00002829 Constant *RetValDummy;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002830 bool EvalSuccess = Eval.EvaluateFunction(F, RetValDummy,
2831 SmallVector<Constant*, 0>());
Jakub Staszak9525a772012-12-06 21:57:16 +00002832
Chris Lattnerda1889b2005-09-27 04:27:01 +00002833 if (EvalSuccess) {
Nico Weber4b2acde2014-05-02 18:35:25 +00002834 ++NumCtorsEvaluated;
2835
Chris Lattner6bf2cd52005-09-26 17:07:09 +00002836 // We succeeded at evaluation: commit the result.
David Greene44cb8ad2010-01-05 01:28:05 +00002837 DEBUG(dbgs() << "FULLY EVALUATED GLOBAL CTOR FUNCTION '"
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002838 << F->getName() << "' to " << Eval.getMutatedMemory().size()
2839 << " stores.\n");
2840 for (DenseMap<Constant*, Constant*>::const_iterator I =
2841 Eval.getMutatedMemory().begin(), E = Eval.getMutatedMemory().end();
2842 I != E; ++I)
2843 CommitValueTo(I->second, I->first);
Craig Topper46276792014-08-24 23:23:06 +00002844 for (GlobalVariable *GV : Eval.getInvariants())
2845 GV->setConstant(true);
Chris Lattner6bf2cd52005-09-26 17:07:09 +00002846 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002847
Chris Lattnerda1889b2005-09-27 04:27:01 +00002848 return EvalSuccess;
Chris Lattner99e23fa2005-09-26 04:44:35 +00002849}
2850
Benjamin Krameradf1ea82014-03-07 21:52:38 +00002851static int compareNames(Constant *const *A, Constant *const *B) {
Sean Silvaace78182015-09-28 19:02:11 +00002852 return (*A)->stripPointerCasts()->getName().compare(
2853 (*B)->stripPointerCasts()->getName());
Benjamin Krameradf1ea82014-03-07 21:52:38 +00002854}
2855
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002856static void setUsedInitializer(GlobalVariable &V,
Craig Topper97ebe532014-08-19 07:44:27 +00002857 const SmallPtrSet<GlobalValue *, 8> &Init) {
Rafael Espindolac2bb73f2013-07-20 23:33:15 +00002858 if (Init.empty()) {
2859 V.eraseFromParent();
2860 return;
2861 }
2862
Matt Arsenaultda1deab2014-01-02 19:53:49 +00002863 // Type of pointer to the array of pointers.
2864 PointerType *Int8PtrTy = Type::getInt8PtrTy(V.getContext(), 0);
Rafael Espindola00752162013-05-09 17:22:59 +00002865
Matt Arsenaultda1deab2014-01-02 19:53:49 +00002866 SmallVector<llvm::Constant *, 8> UsedArray;
Craig Topper71b7b682014-08-21 05:55:13 +00002867 for (GlobalValue *GV : Init) {
Matt Arsenaultda1deab2014-01-02 19:53:49 +00002868 Constant *Cast
Craig Topper71b7b682014-08-21 05:55:13 +00002869 = ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, Int8PtrTy);
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002870 UsedArray.push_back(Cast);
Rafael Espindola00752162013-05-09 17:22:59 +00002871 }
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002872 // Sort to get deterministic order.
Benjamin Krameradf1ea82014-03-07 21:52:38 +00002873 array_pod_sort(UsedArray.begin(), UsedArray.end(), compareNames);
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002874 ArrayType *ATy = ArrayType::get(Int8PtrTy, UsedArray.size());
Rafael Espindola00752162013-05-09 17:22:59 +00002875
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002876 Module *M = V.getParent();
2877 V.removeFromParent();
2878 GlobalVariable *NV =
2879 new GlobalVariable(*M, ATy, false, llvm::GlobalValue::AppendingLinkage,
2880 llvm::ConstantArray::get(ATy, UsedArray), "");
2881 NV->takeName(&V);
2882 NV->setSection("llvm.metadata");
2883 delete &V;
Rafael Espindola00752162013-05-09 17:22:59 +00002884}
2885
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002886namespace {
James Molloyea31ad32015-11-13 11:05:07 +00002887/// An easy to access representation of llvm.used and llvm.compiler.used.
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002888class LLVMUsed {
2889 SmallPtrSet<GlobalValue *, 8> Used;
2890 SmallPtrSet<GlobalValue *, 8> CompilerUsed;
2891 GlobalVariable *UsedV;
2892 GlobalVariable *CompilerUsedV;
2893
2894public:
Rafael Espindolaec2375f2013-07-25 02:50:08 +00002895 LLVMUsed(Module &M) {
Rafael Espindola17600e22013-07-25 03:23:25 +00002896 UsedV = collectUsedGlobalVariables(M, Used, false);
2897 CompilerUsedV = collectUsedGlobalVariables(M, CompilerUsed, true);
Rafael Espindola00752162013-05-09 17:22:59 +00002898 }
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002899 typedef SmallPtrSet<GlobalValue *, 8>::iterator iterator;
Craig Topper46276792014-08-24 23:23:06 +00002900 typedef iterator_range<iterator> used_iterator_range;
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002901 iterator usedBegin() { return Used.begin(); }
2902 iterator usedEnd() { return Used.end(); }
Craig Topper46276792014-08-24 23:23:06 +00002903 used_iterator_range used() {
2904 return used_iterator_range(usedBegin(), usedEnd());
2905 }
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002906 iterator compilerUsedBegin() { return CompilerUsed.begin(); }
2907 iterator compilerUsedEnd() { return CompilerUsed.end(); }
Craig Topper46276792014-08-24 23:23:06 +00002908 used_iterator_range compilerUsed() {
2909 return used_iterator_range(compilerUsedBegin(), compilerUsedEnd());
2910 }
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002911 bool usedCount(GlobalValue *GV) const { return Used.count(GV); }
2912 bool compilerUsedCount(GlobalValue *GV) const {
2913 return CompilerUsed.count(GV);
2914 }
2915 bool usedErase(GlobalValue *GV) { return Used.erase(GV); }
2916 bool compilerUsedErase(GlobalValue *GV) { return CompilerUsed.erase(GV); }
David Blaikie70573dc2014-11-19 07:49:26 +00002917 bool usedInsert(GlobalValue *GV) { return Used.insert(GV).second; }
2918 bool compilerUsedInsert(GlobalValue *GV) {
2919 return CompilerUsed.insert(GV).second;
2920 }
Rafael Espindola00752162013-05-09 17:22:59 +00002921
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002922 void syncVariablesAndSets() {
2923 if (UsedV)
2924 setUsedInitializer(*UsedV, Used);
2925 if (CompilerUsedV)
2926 setUsedInitializer(*CompilerUsedV, CompilerUsed);
2927 }
2928};
Alexander Kornienkof00654e2015-06-23 09:49:53 +00002929}
Rafael Espindola00752162013-05-09 17:22:59 +00002930
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002931static bool hasUseOtherThanLLVMUsed(GlobalAlias &GA, const LLVMUsed &U) {
2932 if (GA.use_empty()) // No use at all.
2933 return false;
2934
2935 assert((!U.usedCount(&GA) || !U.compilerUsedCount(&GA)) &&
2936 "We should have removed the duplicated "
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002937 "element from llvm.compiler.used");
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002938 if (!GA.hasOneUse())
2939 // Strictly more than one use. So at least one is not in llvm.used and
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002940 // llvm.compiler.used.
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002941 return true;
2942
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002943 // Exactly one use. Check if it is in llvm.used or llvm.compiler.used.
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002944 return !U.usedCount(&GA) && !U.compilerUsedCount(&GA);
Rafael Espindola00752162013-05-09 17:22:59 +00002945}
2946
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002947static bool hasMoreThanOneUseOtherThanLLVMUsed(GlobalValue &V,
2948 const LLVMUsed &U) {
2949 unsigned N = 2;
2950 assert((!U.usedCount(&V) || !U.compilerUsedCount(&V)) &&
2951 "We should have removed the duplicated "
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002952 "element from llvm.compiler.used");
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002953 if (U.usedCount(&V) || U.compilerUsedCount(&V))
2954 ++N;
2955 return V.hasNUsesOrMore(N);
2956}
2957
2958static bool mayHaveOtherReferences(GlobalAlias &GA, const LLVMUsed &U) {
2959 if (!GA.hasLocalLinkage())
2960 return true;
2961
2962 return U.usedCount(&GA) || U.compilerUsedCount(&GA);
2963}
2964
Craig Topper71b7b682014-08-21 05:55:13 +00002965static bool hasUsesToReplace(GlobalAlias &GA, const LLVMUsed &U,
2966 bool &RenameTarget) {
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002967 RenameTarget = false;
Rafael Espindola00752162013-05-09 17:22:59 +00002968 bool Ret = false;
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002969 if (hasUseOtherThanLLVMUsed(GA, U))
Rafael Espindola00752162013-05-09 17:22:59 +00002970 Ret = true;
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002971
2972 // If the alias is externally visible, we may still be able to simplify it.
2973 if (!mayHaveOtherReferences(GA, U))
2974 return Ret;
2975
2976 // If the aliasee has internal linkage, give it the name and linkage
2977 // of the alias, and delete the alias. This turns:
2978 // define internal ... @f(...)
2979 // @a = alias ... @f
2980 // into:
2981 // define ... @a(...)
2982 Constant *Aliasee = GA.getAliasee();
2983 GlobalValue *Target = cast<GlobalValue>(Aliasee->stripPointerCasts());
2984 if (!Target->hasLocalLinkage())
2985 return Ret;
2986
2987 // Do not perform the transform if multiple aliases potentially target the
2988 // aliasee. This check also ensures that it is safe to replace the section
2989 // and other attributes of the aliasee with those of the alias.
2990 if (hasMoreThanOneUseOtherThanLLVMUsed(*Target, U))
2991 return Ret;
2992
2993 RenameTarget = true;
2994 return true;
Rafael Espindola00752162013-05-09 17:22:59 +00002995}
2996
Duncan Sandsed722832009-03-06 10:21:56 +00002997bool GlobalOpt::OptimizeGlobalAliases(Module &M) {
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00002998 bool Changed = false;
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002999 LLVMUsed Used(M);
3000
Craig Topper46276792014-08-24 23:23:06 +00003001 for (GlobalValue *GV : Used.used())
3002 Used.compilerUsedErase(GV);
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00003003
Duncan Sands0bcf0852009-01-07 20:01:06 +00003004 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
Duncan Sandsb3f27882009-02-15 09:56:08 +00003005 I != E;) {
Rafael Espindola5349d872015-12-22 19:50:22 +00003006 GlobalAlias *J = &*I++;
3007
Duncan Sandsed722832009-03-06 10:21:56 +00003008 // Aliases without names cannot be referenced outside this module.
David Majnemer5c921152014-07-01 15:26:50 +00003009 if (!J->hasName() && !J->isDeclaration() && !J->hasLocalLinkage())
Duncan Sandsed722832009-03-06 10:21:56 +00003010 J->setLinkage(GlobalValue::InternalLinkage);
Rafael Espindola5349d872015-12-22 19:50:22 +00003011
3012 if (deleteIfDead(*J)) {
3013 Changed = true;
3014 continue;
3015 }
3016
Duncan Sandsb3f27882009-02-15 09:56:08 +00003017 // If the aliasee may change at link time, nothing can be done - bail out.
3018 if (J->mayBeOverridden())
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00003019 continue;
3020
Duncan Sandsb3f27882009-02-15 09:56:08 +00003021 Constant *Aliasee = J->getAliasee();
David Majnemer0e2cc2a2014-07-01 00:30:56 +00003022 GlobalValue *Target = dyn_cast<GlobalValue>(Aliasee->stripPointerCasts());
3023 // We can't trivially replace the alias with the aliasee if the aliasee is
3024 // non-trivial in some way.
3025 // TODO: Try to handle non-zero GEPs of local aliasees.
3026 if (!Target)
3027 continue;
Duncan Sands7a1db332009-02-18 17:55:38 +00003028 Target->removeDeadConstantUsers();
Duncan Sandsb3f27882009-02-15 09:56:08 +00003029
3030 // Make all users of the alias use the aliasee instead.
Rafael Espindolaa82555c2013-06-11 17:48:06 +00003031 bool RenameTarget;
3032 if (!hasUsesToReplace(*J, Used, RenameTarget))
Rafael Espindola00752162013-05-09 17:22:59 +00003033 continue;
Duncan Sandsb3f27882009-02-15 09:56:08 +00003034
Rafael Espindola6b238632014-05-16 19:35:39 +00003035 J->replaceAllUsesWith(ConstantExpr::getBitCast(Aliasee, J->getType()));
Rafael Espindolaa82555c2013-06-11 17:48:06 +00003036 ++NumAliasesResolved;
3037 Changed = true;
Duncan Sandsb3f27882009-02-15 09:56:08 +00003038
Rafael Espindolaa82555c2013-06-11 17:48:06 +00003039 if (RenameTarget) {
Duncan Sands6a3df7b2009-12-08 10:10:20 +00003040 // Give the aliasee the name, linkage and other attributes of the alias.
Duncan P. N. Exon Smith17323402015-10-13 17:51:03 +00003041 Target->takeName(&*J);
Duncan Sands6a3df7b2009-12-08 10:10:20 +00003042 Target->setLinkage(J->getLinkage());
Reid Kleckner22b19da2014-02-13 02:18:36 +00003043 Target->setVisibility(J->getVisibility());
3044 Target->setDLLStorageClass(J->getDLLStorageClass());
Rafael Espindolaa82555c2013-06-11 17:48:06 +00003045
Duncan P. N. Exon Smith17323402015-10-13 17:51:03 +00003046 if (Used.usedErase(&*J))
Rafael Espindolaa82555c2013-06-11 17:48:06 +00003047 Used.usedInsert(Target);
3048
Duncan P. N. Exon Smith17323402015-10-13 17:51:03 +00003049 if (Used.compilerUsedErase(&*J))
Rafael Espindolaa82555c2013-06-11 17:48:06 +00003050 Used.compilerUsedInsert(Target);
Rafael Espindola8d304802013-06-12 16:45:47 +00003051 } else if (mayHaveOtherReferences(*J, Used))
Rafael Espindolaa82555c2013-06-11 17:48:06 +00003052 continue;
3053
Duncan Sandsb3f27882009-02-15 09:56:08 +00003054 // Delete the alias.
3055 M.getAliasList().erase(J);
3056 ++NumAliasesRemoved;
3057 Changed = true;
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00003058 }
3059
Rafael Espindolaa82555c2013-06-11 17:48:06 +00003060 Used.syncVariablesAndSets();
3061
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00003062 return Changed;
3063}
Chris Lattner41b6a5a2005-09-26 01:43:45 +00003064
Nick Lewycky4b273cb2012-02-12 02:15:20 +00003065static Function *FindCXAAtExit(Module &M, TargetLibraryInfo *TLI) {
3066 if (!TLI->has(LibFunc::cxa_atexit))
Craig Topperf40110f2014-04-25 05:29:35 +00003067 return nullptr;
Nick Lewycky4b273cb2012-02-12 02:15:20 +00003068
3069 Function *Fn = M.getFunction(TLI->getName(LibFunc::cxa_atexit));
Jakub Staszak9525a772012-12-06 21:57:16 +00003070
Anders Carlssonee6bc702011-03-20 17:59:11 +00003071 if (!Fn)
Craig Topperf40110f2014-04-25 05:29:35 +00003072 return nullptr;
Nick Lewycky4b273cb2012-02-12 02:15:20 +00003073
Chris Lattner229907c2011-07-18 04:54:35 +00003074 FunctionType *FTy = Fn->getFunctionType();
Jakub Staszak9525a772012-12-06 21:57:16 +00003075
3076 // Checking that the function has the right return type, the right number of
Anders Carlsson48a44912011-03-20 19:51:13 +00003077 // parameters and that they all have pointer types should be enough.
3078 if (!FTy->getReturnType()->isIntegerTy() ||
3079 FTy->getNumParams() != 3 ||
Anders Carlssonee6bc702011-03-20 17:59:11 +00003080 !FTy->getParamType(0)->isPointerTy() ||
3081 !FTy->getParamType(1)->isPointerTy() ||
3082 !FTy->getParamType(2)->isPointerTy())
Craig Topperf40110f2014-04-25 05:29:35 +00003083 return nullptr;
Anders Carlssonee6bc702011-03-20 17:59:11 +00003084
3085 return Fn;
3086}
3087
James Molloyea31ad32015-11-13 11:05:07 +00003088/// Returns whether the given function is an empty C++ destructor and can
3089/// therefore be eliminated.
Anders Carlssonee6bc702011-03-20 17:59:11 +00003090/// Note that we assume that other optimization passes have already simplified
3091/// the code so we only look for a function with a single basic block, where
Benjamin Kramer1a4695a2012-02-09 16:28:15 +00003092/// the only allowed instructions are 'ret', 'call' to an empty C++ dtor and
3093/// other side-effect free instructions.
Anders Carlssonfcec2f52011-03-20 20:16:43 +00003094static bool cxxDtorIsEmpty(const Function &Fn,
3095 SmallPtrSet<const Function *, 8> &CalledFunctions) {
Anders Carlsson48a44912011-03-20 19:51:13 +00003096 // FIXME: We could eliminate C++ destructors if they're readonly/readnone and
Nick Lewyckyd0781832011-03-21 02:26:01 +00003097 // nounwind, but that doesn't seem worth doing.
Anders Carlsson48a44912011-03-20 19:51:13 +00003098 if (Fn.isDeclaration())
3099 return false;
Anders Carlssonee6bc702011-03-20 17:59:11 +00003100
3101 if (++Fn.begin() != Fn.end())
3102 return false;
3103
3104 const BasicBlock &EntryBlock = Fn.getEntryBlock();
3105 for (BasicBlock::const_iterator I = EntryBlock.begin(), E = EntryBlock.end();
3106 I != E; ++I) {
3107 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
Anders Carlsson4dd420f2011-03-21 14:54:40 +00003108 // Ignore debug intrinsics.
3109 if (isa<DbgInfoIntrinsic>(CI))
3110 continue;
3111
Anders Carlssonee6bc702011-03-20 17:59:11 +00003112 const Function *CalledFn = CI->getCalledFunction();
3113
3114 if (!CalledFn)
3115 return false;
3116
Anders Carlsson1cc80732011-03-22 03:21:01 +00003117 SmallPtrSet<const Function *, 8> NewCalledFunctions(CalledFunctions);
3118
Anders Carlsson48a44912011-03-20 19:51:13 +00003119 // Don't treat recursive functions as empty.
David Blaikie70573dc2014-11-19 07:49:26 +00003120 if (!NewCalledFunctions.insert(CalledFn).second)
Anders Carlsson48a44912011-03-20 19:51:13 +00003121 return false;
3122
Anders Carlsson1cc80732011-03-22 03:21:01 +00003123 if (!cxxDtorIsEmpty(*CalledFn, NewCalledFunctions))
Anders Carlssonee6bc702011-03-20 17:59:11 +00003124 return false;
3125 } else if (isa<ReturnInst>(*I))
Benjamin Kramer487a3962012-02-09 14:26:06 +00003126 return true; // We're done.
3127 else if (I->mayHaveSideEffects())
3128 return false; // Destructor with side effects, bail.
Anders Carlssonee6bc702011-03-20 17:59:11 +00003129 }
3130
3131 return false;
3132}
3133
3134bool GlobalOpt::OptimizeEmptyGlobalCXXDtors(Function *CXAAtExitFn) {
3135 /// Itanium C++ ABI p3.3.5:
3136 ///
3137 /// After constructing a global (or local static) object, that will require
3138 /// destruction on exit, a termination function is registered as follows:
3139 ///
3140 /// extern "C" int __cxa_atexit ( void (*f)(void *), void *p, void *d );
3141 ///
3142 /// This registration, e.g. __cxa_atexit(f,p,d), is intended to cause the
3143 /// call f(p) when DSO d is unloaded, before all such termination calls
3144 /// registered before this one. It returns zero if registration is
Nick Lewyckyd0781832011-03-21 02:26:01 +00003145 /// successful, nonzero on failure.
Anders Carlssonee6bc702011-03-20 17:59:11 +00003146
3147 // This pass will look for calls to __cxa_atexit where the function is trivial
3148 // and remove them.
3149 bool Changed = false;
3150
Chandler Carruthcdf47882014-03-09 03:16:01 +00003151 for (auto I = CXAAtExitFn->user_begin(), E = CXAAtExitFn->user_end();
3152 I != E;) {
Anders Carlsson336fd902011-03-20 20:21:33 +00003153 // We're only interested in calls. Theoretically, we could handle invoke
3154 // instructions as well, but neither llvm-gcc nor clang generate invokes
3155 // to __cxa_atexit.
Anders Carlsson4dd420f2011-03-21 14:54:40 +00003156 CallInst *CI = dyn_cast<CallInst>(*I++);
3157 if (!CI)
Anders Carlsson336fd902011-03-20 20:21:33 +00003158 continue;
3159
Jakub Staszak9525a772012-12-06 21:57:16 +00003160 Function *DtorFn =
Anders Carlsson4dd420f2011-03-21 14:54:40 +00003161 dyn_cast<Function>(CI->getArgOperand(0)->stripPointerCasts());
Anders Carlssonee6bc702011-03-20 17:59:11 +00003162 if (!DtorFn)
3163 continue;
3164
Anders Carlssonfcec2f52011-03-20 20:16:43 +00003165 SmallPtrSet<const Function *, 8> CalledFunctions;
3166 if (!cxxDtorIsEmpty(*DtorFn, CalledFunctions))
Anders Carlssonee6bc702011-03-20 17:59:11 +00003167 continue;
3168
3169 // Just remove the call.
Anders Carlsson4dd420f2011-03-21 14:54:40 +00003170 CI->replaceAllUsesWith(Constant::getNullValue(CI->getType()));
3171 CI->eraseFromParent();
Anders Carlsson48a44912011-03-20 19:51:13 +00003172
Anders Carlssonee6bc702011-03-20 17:59:11 +00003173 ++NumCXXDtorsRemoved;
3174
3175 Changed |= true;
3176 }
3177
3178 return Changed;
3179}
3180
Chris Lattner25db5802004-10-07 04:16:33 +00003181bool GlobalOpt::runOnModule(Module &M) {
3182 bool Changed = false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003183
Mehdi Amini46a43552015-03-04 18:43:29 +00003184 auto &DL = M.getDataLayout();
Chandler Carruthb98f63d2015-01-15 10:41:28 +00003185 TLI = &getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
Nick Lewyckycf6aae62012-02-12 01:13:18 +00003186
Chris Lattner25db5802004-10-07 04:16:33 +00003187 bool LocalChange = true;
3188 while (LocalChange) {
3189 LocalChange = false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003190
David Majnemer1b3b70e2014-10-08 07:23:31 +00003191 NotDiscardableComdats.clear();
3192 for (const GlobalVariable &GV : M.globals())
3193 if (const Comdat *C = GV.getComdat())
3194 if (!GV.isDiscardableIfUnused() || !GV.use_empty())
3195 NotDiscardableComdats.insert(C);
3196 for (Function &F : M)
3197 if (const Comdat *C = F.getComdat())
3198 if (!F.isDefTriviallyDead())
3199 NotDiscardableComdats.insert(C);
3200 for (GlobalAlias &GA : M.aliases())
3201 if (const Comdat *C = GA.getComdat())
3202 if (!GA.isDiscardableIfUnused() || !GA.use_empty())
3203 NotDiscardableComdats.insert(C);
3204
Chris Lattner41b6a5a2005-09-26 01:43:45 +00003205 // Delete functions that are trivially dead, ccc -> fastcc
3206 LocalChange |= OptimizeFunctions(M);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003207
Chris Lattner41b6a5a2005-09-26 01:43:45 +00003208 // Optimize global_ctors list.
Richard Smithc167d652014-05-06 01:44:26 +00003209 LocalChange |= optimizeGlobalCtorsList(M, [&](Function *F) {
3210 return EvaluateStaticConstructor(F, DL, TLI);
3211 });
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003212
Chris Lattner41b6a5a2005-09-26 01:43:45 +00003213 // Optimize non-address-taken globals.
3214 LocalChange |= OptimizeGlobalVars(M);
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00003215
3216 // Resolve aliases, when possible.
Duncan Sandsed722832009-03-06 10:21:56 +00003217 LocalChange |= OptimizeGlobalAliases(M);
Anders Carlssonee6bc702011-03-20 17:59:11 +00003218
Manman Renb3c52fb2013-05-14 21:52:44 +00003219 // Try to remove trivial global destructors if they are not removed
3220 // already.
3221 Function *CXAAtExitFn = FindCXAAtExit(M, TLI);
Anders Carlssonee6bc702011-03-20 17:59:11 +00003222 if (CXAAtExitFn)
3223 LocalChange |= OptimizeEmptyGlobalCXXDtors(CXAAtExitFn);
3224
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00003225 Changed |= LocalChange;
Chris Lattner25db5802004-10-07 04:16:33 +00003226 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003227
Chris Lattner41b6a5a2005-09-26 01:43:45 +00003228 // TODO: Move all global ctors functions to the end of the module for code
3229 // layout.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003230
Chris Lattner25db5802004-10-07 04:16:33 +00003231 return Changed;
3232}
Anthony Pescha2d93692015-07-22 18:50:10 +00003233