blob: 97e98bbd88971cdb25856dcded6530f8ffe30de5 [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"
Chandler Carruth219b89b2014-03-04 11:01:28 +000025#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000026#include "llvm/IR/CallingConv.h"
27#include "llvm/IR/Constants.h"
28#include "llvm/IR/DataLayout.h"
29#include "llvm/IR/DerivedTypes.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000030#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000031#include "llvm/IR/Instructions.h"
32#include "llvm/IR/IntrinsicInst.h"
33#include "llvm/IR/Module.h"
34#include "llvm/IR/Operator.h"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000035#include "llvm/IR/ValueHandle.h"
Chris Lattner25db5802004-10-07 04:16:33 +000036#include "llvm/Pass.h"
Chris Lattner024f4ab2007-01-30 23:46:24 +000037#include "llvm/Support/Debug.h"
Torok Edwin56d06592009-07-11 20:10:48 +000038#include "llvm/Support/ErrorHandling.h"
Chris Lattner67ca6f632008-04-26 07:40:11 +000039#include "llvm/Support/MathExtras.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000040#include "llvm/Support/raw_ostream.h"
Chandler Carruth62d42152015-01-15 02:16:27 +000041#include "llvm/Analysis/TargetLibraryInfo.h"
Nico Weber4b2acde2014-05-02 18:35:25 +000042#include "llvm/Transforms/Utils/CtorUtils.h"
Rafael Espindola3d7fc252013-10-21 17:14:55 +000043#include "llvm/Transforms/Utils/GlobalStatus.h"
Rafael Espindola17600e22013-07-25 03:23:25 +000044#include "llvm/Transforms/Utils/ModuleUtils.h"
Chris Lattner25db5802004-10-07 04:16:33 +000045#include <algorithm>
Benjamin Kramer64425fe2014-05-03 15:50:37 +000046#include <deque>
Chris Lattner25db5802004-10-07 04:16:33 +000047using namespace llvm;
48
Chandler Carruth964daaa2014-04-22 02:55:47 +000049#define DEBUG_TYPE "globalopt"
50
Chris Lattner1631bcb2006-12-19 22:09:18 +000051STATISTIC(NumMarked , "Number of globals marked constant");
Rafael Espindolafc355bc2011-01-19 16:32:21 +000052STATISTIC(NumUnnamed , "Number of globals marked unnamed_addr");
Chris Lattner1631bcb2006-12-19 22:09:18 +000053STATISTIC(NumSRA , "Number of aggregate globals broken into scalars");
54STATISTIC(NumHeapSRA , "Number of heap objects SRA'd");
55STATISTIC(NumSubstitute,"Number of globals with initializers stored into them");
56STATISTIC(NumDeleted , "Number of globals deleted");
57STATISTIC(NumFnDeleted , "Number of functions deleted");
58STATISTIC(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>();
Chris Lattner004e2502004-10-11 05:54:41 +000072 }
Nick Lewyckye7da2d62007-05-06 13:37:16 +000073 static char ID; // Pass identification, replacement for typeid
Owen Anderson6c18d1a2010-10-19 17:21:58 +000074 GlobalOpt() : ModulePass(ID) {
75 initializeGlobalOptPass(*PassRegistry::getPassRegistry());
76 }
Misha Brukmanb1c93172005-04-21 23:48:37 +000077
Craig Topper3e4c6972014-03-05 09:10:37 +000078 bool runOnModule(Module &M) override;
Chris Lattner004e2502004-10-11 05:54:41 +000079
80 private:
Chris Lattner41b6a5a2005-09-26 01:43:45 +000081 bool OptimizeFunctions(Module &M);
82 bool OptimizeGlobalVars(Module &M);
Duncan Sandsed722832009-03-06 10:21:56 +000083 bool OptimizeGlobalAliases(Module &M);
Rafael Espindolafc355bc2011-01-19 16:32:21 +000084 bool ProcessGlobal(GlobalVariable *GV,Module::global_iterator &GVI);
85 bool ProcessInternalGlobal(GlobalVariable *GV,Module::global_iterator &GVI,
Rafael Espindolafc355bc2011-01-19 16:32:21 +000086 const GlobalStatus &GS);
Anders Carlssonee6bc702011-03-20 17:59:11 +000087 bool OptimizeEmptyGlobalCXXDtors(Function *CXAAtExitFn);
Nick Lewyckycf6aae62012-02-12 01:13:18 +000088
Nick Lewyckycf6aae62012-02-12 01:13:18 +000089 TargetLibraryInfo *TLI;
David Majnemer1b3b70e2014-10-08 07:23:31 +000090 SmallSet<const Comdat *, 8> NotDiscardableComdats;
Chris Lattner25db5802004-10-07 04:16:33 +000091 };
Chris Lattner25db5802004-10-07 04:16:33 +000092}
93
Dan Gohmand78c4002008-05-13 00:00:25 +000094char GlobalOpt::ID = 0;
Chad Rosiere6de63d2011-12-01 21:29:16 +000095INITIALIZE_PASS_BEGIN(GlobalOpt, "globalopt",
96 "Global Variable Optimizer", false, false)
Chandler Carruthb98f63d2015-01-15 10:41:28 +000097INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
Chad Rosiere6de63d2011-12-01 21:29:16 +000098INITIALIZE_PASS_END(GlobalOpt, "globalopt",
Owen Andersondf7a4f22010-10-07 22:25:06 +000099 "Global Variable Optimizer", false, false)
Dan Gohmand78c4002008-05-13 00:00:25 +0000100
Chris Lattner25db5802004-10-07 04:16:33 +0000101ModulePass *llvm::createGlobalOptimizerPass() { return new GlobalOpt(); }
102
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000103/// isLeakCheckerRoot - Is this global variable possibly used by a leak checker
104/// as a root? If so, we might not really want to eliminate the stores to it.
105static bool isLeakCheckerRoot(GlobalVariable *GV) {
106 // A global variable is a root if it is a pointer, or could plausibly contain
107 // a pointer. There are two challenges; one is that we could have a struct
108 // the has an inner member which is a pointer. We recurse through the type to
109 // detect these (up to a point). The other is that we may actually be a union
110 // of a pointer and another type, and so our LLVM type is an integer which
111 // gets converted into a pointer, or our type is an [i8 x #] with a pointer
112 // potentially contained here.
113
114 if (GV->hasPrivateLinkage())
115 return false;
116
117 SmallVector<Type *, 4> Types;
118 Types.push_back(cast<PointerType>(GV->getType())->getElementType());
119
120 unsigned Limit = 20;
121 do {
122 Type *Ty = Types.pop_back_val();
123 switch (Ty->getTypeID()) {
124 default: break;
125 case Type::PointerTyID: return true;
126 case Type::ArrayTyID:
127 case Type::VectorTyID: {
128 SequentialType *STy = cast<SequentialType>(Ty);
129 Types.push_back(STy->getElementType());
130 break;
131 }
132 case Type::StructTyID: {
133 StructType *STy = cast<StructType>(Ty);
134 if (STy->isOpaque()) return true;
135 for (StructType::element_iterator I = STy->element_begin(),
136 E = STy->element_end(); I != E; ++I) {
137 Type *InnerTy = *I;
138 if (isa<PointerType>(InnerTy)) return true;
139 if (isa<CompositeType>(InnerTy))
140 Types.push_back(InnerTy);
141 }
142 break;
143 }
144 }
145 if (--Limit == 0) return true;
146 } while (!Types.empty());
147 return false;
148}
149
150/// Given a value that is stored to a global but never read, determine whether
151/// it's safe to remove the store and the chain of computation that feeds the
152/// store.
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000153static bool IsSafeComputationToRemove(Value *V, const TargetLibraryInfo *TLI) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000154 do {
155 if (isa<Constant>(V))
156 return true;
157 if (!V->hasOneUse())
158 return false;
Nick Lewycky7d0f1102012-07-25 21:19:40 +0000159 if (isa<LoadInst>(V) || isa<InvokeInst>(V) || isa<Argument>(V) ||
160 isa<GlobalValue>(V))
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000161 return false;
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000162 if (isAllocationFn(V, TLI))
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000163 return true;
164
165 Instruction *I = cast<Instruction>(V);
166 if (I->mayHaveSideEffects())
167 return false;
168 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(I)) {
169 if (!GEP->hasAllConstantIndices())
170 return false;
171 } else if (I->getNumOperands() != 1) {
172 return false;
173 }
174
175 V = I->getOperand(0);
176 } while (1);
177}
178
179/// CleanupPointerRootUsers - This GV is a pointer root. Loop over all users
180/// of the global and clean up any that obviously don't assign the global a
181/// value that isn't dynamically allocated.
182///
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000183static bool CleanupPointerRootUsers(GlobalVariable *GV,
184 const TargetLibraryInfo *TLI) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000185 // A brief explanation of leak checkers. The goal is to find bugs where
186 // pointers are forgotten, causing an accumulating growth in memory
187 // usage over time. The common strategy for leak checkers is to whitelist the
188 // memory pointed to by globals at exit. This is popular because it also
189 // solves another problem where the main thread of a C++ program may shut down
190 // before other threads that are still expecting to use those globals. To
191 // handle that case, we expect the program may create a singleton and never
192 // destroy it.
193
194 bool Changed = false;
195
196 // If Dead[n].first is the only use of a malloc result, we can delete its
197 // chain of computation and the store to the global in Dead[n].second.
198 SmallVector<std::pair<Instruction *, Instruction *>, 32> Dead;
199
200 // Constants can't be pointers to dynamically allocated memory.
Chandler Carruthcdf47882014-03-09 03:16:01 +0000201 for (Value::user_iterator UI = GV->user_begin(), E = GV->user_end();
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000202 UI != E;) {
203 User *U = *UI++;
204 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
205 Value *V = SI->getValueOperand();
206 if (isa<Constant>(V)) {
207 Changed = true;
208 SI->eraseFromParent();
209 } else if (Instruction *I = dyn_cast<Instruction>(V)) {
210 if (I->hasOneUse())
211 Dead.push_back(std::make_pair(I, SI));
212 }
213 } else if (MemSetInst *MSI = dyn_cast<MemSetInst>(U)) {
214 if (isa<Constant>(MSI->getValue())) {
215 Changed = true;
216 MSI->eraseFromParent();
217 } else if (Instruction *I = dyn_cast<Instruction>(MSI->getValue())) {
218 if (I->hasOneUse())
219 Dead.push_back(std::make_pair(I, MSI));
220 }
221 } else if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(U)) {
222 GlobalVariable *MemSrc = dyn_cast<GlobalVariable>(MTI->getSource());
223 if (MemSrc && MemSrc->isConstant()) {
224 Changed = true;
225 MTI->eraseFromParent();
226 } else if (Instruction *I = dyn_cast<Instruction>(MemSrc)) {
227 if (I->hasOneUse())
228 Dead.push_back(std::make_pair(I, MTI));
229 }
230 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
231 if (CE->use_empty()) {
232 CE->destroyConstant();
233 Changed = true;
234 }
235 } else if (Constant *C = dyn_cast<Constant>(U)) {
Rafael Espindola27797ba2013-10-17 18:06:32 +0000236 if (isSafeToDestroyConstant(C)) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000237 C->destroyConstant();
238 // This could have invalidated UI, start over from scratch.
239 Dead.clear();
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000240 CleanupPointerRootUsers(GV, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000241 return true;
242 }
243 }
244 }
245
246 for (int i = 0, e = Dead.size(); i != e; ++i) {
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000247 if (IsSafeComputationToRemove(Dead[i].first, TLI)) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000248 Dead[i].second->eraseFromParent();
249 Instruction *I = Dead[i].first;
250 do {
Michael Gottesman2a654272013-01-11 23:08:52 +0000251 if (isAllocationFn(I, TLI))
252 break;
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000253 Instruction *J = dyn_cast<Instruction>(I->getOperand(0));
254 if (!J)
255 break;
256 I->eraseFromParent();
257 I = J;
Nick Lewycky38be9312012-07-24 21:33:00 +0000258 } while (1);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000259 I->eraseFromParent();
260 }
261 }
262
263 return Changed;
264}
265
Chris Lattner25db5802004-10-07 04:16:33 +0000266/// CleanupConstantGlobalUsers - We just marked GV constant. Loop over all
267/// users of the global, cleaning up the obvious ones. This is largely just a
Chris Lattnercb9f1522004-10-10 16:43:46 +0000268/// quick scan over the use list to clean up the easy and obvious cruft. This
269/// returns true if it made a change.
Nick Lewyckycf6aae62012-02-12 01:13:18 +0000270static bool CleanupConstantGlobalUsers(Value *V, Constant *Init,
Mehdi Amini46a43552015-03-04 18:43:29 +0000271 const DataLayout &DL,
Rafael Espindolaaeff8a92014-02-24 23:12:18 +0000272 TargetLibraryInfo *TLI) {
Chris Lattnercb9f1522004-10-10 16:43:46 +0000273 bool Changed = false;
Hal Finkelf59fd7d2013-12-12 20:45:24 +0000274 // Note that we need to use a weak value handle for the worklist items. When
275 // we delete a constant array, we may also be holding pointer to one of its
276 // elements (or an element of one of its elements if we're dealing with an
277 // array of arrays) in the worklist.
Chandler Carruthcdf47882014-03-09 03:16:01 +0000278 SmallVector<WeakVH, 8> WorkList(V->user_begin(), V->user_end());
Bill Wendling88d06c32013-04-02 08:16:45 +0000279 while (!WorkList.empty()) {
Hal Finkelf59fd7d2013-12-12 20:45:24 +0000280 Value *UV = WorkList.pop_back_val();
281 if (!UV)
282 continue;
283
284 User *U = cast<User>(UV);
Misha Brukmanb1c93172005-04-21 23:48:37 +0000285
Chris Lattner25db5802004-10-07 04:16:33 +0000286 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner7561ca12005-02-27 18:58:52 +0000287 if (Init) {
288 // Replace the load with the initializer.
289 LI->replaceAllUsesWith(Init);
290 LI->eraseFromParent();
291 Changed = true;
292 }
Chris Lattner25db5802004-10-07 04:16:33 +0000293 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
294 // Store must be unreachable or storing Init into the global.
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000295 SI->eraseFromParent();
Chris Lattnercb9f1522004-10-10 16:43:46 +0000296 Changed = true;
Chris Lattner25db5802004-10-07 04:16:33 +0000297 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
298 if (CE->getOpcode() == Instruction::GetElementPtr) {
Craig Topperf40110f2014-04-25 05:29:35 +0000299 Constant *SubInit = nullptr;
Chris Lattner46d9ff082005-09-26 07:34:35 +0000300 if (Init)
Dan Gohmane525d9d2009-10-05 16:36:26 +0000301 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000302 Changed |= CleanupConstantGlobalUsers(CE, SubInit, DL, TLI);
Matt Arsenault461c8e02014-01-02 20:01:43 +0000303 } else if ((CE->getOpcode() == Instruction::BitCast &&
304 CE->getType()->isPointerTy()) ||
305 CE->getOpcode() == Instruction::AddrSpaceCast) {
Chris Lattner7561ca12005-02-27 18:58:52 +0000306 // Pointer cast, delete any stores and memsets to the global.
Craig Topperf40110f2014-04-25 05:29:35 +0000307 Changed |= CleanupConstantGlobalUsers(CE, nullptr, DL, TLI);
Chris Lattner7561ca12005-02-27 18:58:52 +0000308 }
309
310 if (CE->use_empty()) {
311 CE->destroyConstant();
312 Changed = true;
Chris Lattner25db5802004-10-07 04:16:33 +0000313 }
314 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattnerf9c0fd72007-11-09 17:33:02 +0000315 // Do not transform "gepinst (gep constexpr (GV))" here, because forming
316 // "gepconstexpr (gep constexpr (GV))" will cause the two gep's to fold
317 // and will invalidate our notion of what Init is.
Craig Topperf40110f2014-04-25 05:29:35 +0000318 Constant *SubInit = nullptr;
Chris Lattnerf9c0fd72007-11-09 17:33:02 +0000319 if (!isa<ConstantExpr>(GEP->getOperand(0))) {
Mehdi Amini46a43552015-03-04 18:43:29 +0000320 ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000321 ConstantFoldInstruction(GEP, DL, TLI));
Chris Lattnerf9c0fd72007-11-09 17:33:02 +0000322 if (Init && CE && CE->getOpcode() == Instruction::GetElementPtr)
Dan Gohmane525d9d2009-10-05 16:36:26 +0000323 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Benjamin Krameraa9e4a52012-03-28 14:50:09 +0000324
325 // If the initializer is an all-null value and we have an inbounds GEP,
326 // we already know what the result of any load from that GEP is.
327 // TODO: Handle splats.
328 if (Init && isa<ConstantAggregateZero>(Init) && GEP->isInBounds())
329 SubInit = Constant::getNullValue(GEP->getType()->getElementType());
Chris Lattnerf9c0fd72007-11-09 17:33:02 +0000330 }
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000331 Changed |= CleanupConstantGlobalUsers(GEP, SubInit, DL, TLI);
Chris Lattnera0e769c2004-10-10 16:47:33 +0000332
Chris Lattnercb9f1522004-10-10 16:43:46 +0000333 if (GEP->use_empty()) {
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000334 GEP->eraseFromParent();
Chris Lattnercb9f1522004-10-10 16:43:46 +0000335 Changed = true;
336 }
Chris Lattner7561ca12005-02-27 18:58:52 +0000337 } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(U)) { // memset/cpy/mv
338 if (MI->getRawDest() == V) {
339 MI->eraseFromParent();
340 Changed = true;
341 }
342
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000343 } else if (Constant *C = dyn_cast<Constant>(U)) {
344 // If we have a chain of dead constantexprs or other things dangling from
345 // us, and if they are all dead, nuke them without remorse.
Rafael Espindola27797ba2013-10-17 18:06:32 +0000346 if (isSafeToDestroyConstant(C)) {
Devang Pateld926aaa2009-03-06 01:37:41 +0000347 C->destroyConstant();
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000348 CleanupConstantGlobalUsers(V, Init, DL, TLI);
Chris Lattnercb9f1522004-10-10 16:43:46 +0000349 return true;
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000350 }
Chris Lattner25db5802004-10-07 04:16:33 +0000351 }
352 }
Chris Lattnercb9f1522004-10-10 16:43:46 +0000353 return Changed;
Chris Lattner25db5802004-10-07 04:16:33 +0000354}
355
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000356/// isSafeSROAElementUse - Return true if the specified instruction is a safe
357/// user of a derived expression from a global that we want to SROA.
358static bool isSafeSROAElementUse(Value *V) {
359 // We might have a dead and dangling constant hanging off of here.
360 if (Constant *C = dyn_cast<Constant>(V))
Rafael Espindola27797ba2013-10-17 18:06:32 +0000361 return isSafeToDestroyConstant(C);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000362
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000363 Instruction *I = dyn_cast<Instruction>(V);
364 if (!I) return false;
365
366 // Loads are ok.
367 if (isa<LoadInst>(I)) return true;
368
369 // Stores *to* the pointer are ok.
370 if (StoreInst *SI = dyn_cast<StoreInst>(I))
371 return SI->getOperand(0) != V;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000372
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000373 // Otherwise, it must be a GEP.
374 GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I);
Craig Topperf40110f2014-04-25 05:29:35 +0000375 if (!GEPI) return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000376
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000377 if (GEPI->getNumOperands() < 3 || !isa<Constant>(GEPI->getOperand(1)) ||
378 !cast<Constant>(GEPI->getOperand(1))->isNullValue())
379 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000380
Chandler Carruthcdf47882014-03-09 03:16:01 +0000381 for (User *U : GEPI->users())
382 if (!isSafeSROAElementUse(U))
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000383 return false;
Chris Lattnerab053722008-01-14 01:31:05 +0000384 return true;
385}
386
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000387
388/// IsUserOfGlobalSafeForSRA - U is a direct user of the specified global value.
389/// Look at it and its uses and decide whether it is safe to SROA this global.
390///
391static bool IsUserOfGlobalSafeForSRA(User *U, GlobalValue *GV) {
392 // The user of the global must be a GEP Inst or a ConstantExpr GEP.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000393 if (!isa<GetElementPtrInst>(U) &&
394 (!isa<ConstantExpr>(U) ||
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000395 cast<ConstantExpr>(U)->getOpcode() != Instruction::GetElementPtr))
396 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000397
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000398 // Check to see if this ConstantExpr GEP is SRA'able. In particular, we
399 // don't like < 3 operand CE's, and we don't like non-constant integer
400 // indices. This enforces that all uses are 'gep GV, 0, C, ...' for some
401 // value of C.
402 if (U->getNumOperands() < 3 || !isa<Constant>(U->getOperand(1)) ||
403 !cast<Constant>(U->getOperand(1))->isNullValue() ||
404 !isa<ConstantInt>(U->getOperand(2)))
405 return false;
406
407 gep_type_iterator GEPI = gep_type_begin(U), E = gep_type_end(U);
408 ++GEPI; // Skip over the pointer index.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000409
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000410 // If this is a use of an array allocation, do a bit more checking for sanity.
Chris Lattner229907c2011-07-18 04:54:35 +0000411 if (ArrayType *AT = dyn_cast<ArrayType>(*GEPI)) {
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000412 uint64_t NumElements = AT->getNumElements();
413 ConstantInt *Idx = cast<ConstantInt>(U->getOperand(2));
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000414
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000415 // Check to make sure that index falls within the array. If not,
416 // something funny is going on, so we won't do the optimization.
417 //
418 if (Idx->getZExtValue() >= NumElements)
419 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000420
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000421 // We cannot scalar repl this level of the array unless any array
422 // sub-indices are in-range constants. In particular, consider:
423 // A[0][i]. We cannot know that the user isn't doing invalid things like
424 // allowing i to index an out-of-range subscript that accesses A[1].
425 //
426 // Scalar replacing *just* the outer index of the array is probably not
427 // going to be a win anyway, so just give up.
428 for (++GEPI; // Skip array index.
Dan Gohman82ac81b2009-08-18 14:58:19 +0000429 GEPI != E;
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000430 ++GEPI) {
431 uint64_t NumElements;
Chris Lattner229907c2011-07-18 04:54:35 +0000432 if (ArrayType *SubArrayTy = dyn_cast<ArrayType>(*GEPI))
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000433 NumElements = SubArrayTy->getNumElements();
Chris Lattner229907c2011-07-18 04:54:35 +0000434 else if (VectorType *SubVectorTy = dyn_cast<VectorType>(*GEPI))
Dan Gohman82ac81b2009-08-18 14:58:19 +0000435 NumElements = SubVectorTy->getNumElements();
436 else {
Duncan Sands19d0b472010-02-16 11:11:14 +0000437 assert((*GEPI)->isStructTy() &&
Dan Gohman82ac81b2009-08-18 14:58:19 +0000438 "Indexed GEP type is not array, vector, or struct!");
439 continue;
440 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000441
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000442 ConstantInt *IdxVal = dyn_cast<ConstantInt>(GEPI.getOperand());
443 if (!IdxVal || IdxVal->getZExtValue() >= NumElements)
444 return false;
445 }
446 }
447
Chandler Carruthcdf47882014-03-09 03:16:01 +0000448 for (User *UU : U->users())
449 if (!isSafeSROAElementUse(UU))
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000450 return false;
Chandler Carruthcdf47882014-03-09 03:16:01 +0000451
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000452 return true;
453}
454
455/// GlobalUsersSafeToSRA - Look at all uses of the global and decide whether it
456/// is safe for us to perform this transformation.
457///
458static bool GlobalUsersSafeToSRA(GlobalValue *GV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000459 for (User *U : GV->users())
460 if (!IsUserOfGlobalSafeForSRA(U, GV))
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000461 return false;
Chandler Carruthcdf47882014-03-09 03:16:01 +0000462
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000463 return true;
464}
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000465
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000466
Chris Lattnerabab0712004-10-08 17:32:09 +0000467/// SRAGlobal - Perform scalar replacement of aggregates on the specified global
468/// variable. This opens the door for other optimizations by exposing the
469/// behavior of the program in a more fine-grained way. We have determined that
470/// this transformation is safe already. We return the first global variable we
471/// insert so that the caller can reprocess it.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000472static GlobalVariable *SRAGlobal(GlobalVariable *GV, const DataLayout &DL) {
Chris Lattnerab053722008-01-14 01:31:05 +0000473 // Make sure this global only has simple uses that we can SRA.
Chris Lattner26fe7eb2008-01-14 02:09:12 +0000474 if (!GlobalUsersSafeToSRA(GV))
Craig Topperf40110f2014-04-25 05:29:35 +0000475 return nullptr;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000476
Rafael Espindola6de96a12009-01-15 20:18:42 +0000477 assert(GV->hasLocalLinkage() && !GV->isConstant());
Chris Lattnerabab0712004-10-08 17:32:09 +0000478 Constant *Init = GV->getInitializer();
Chris Lattner229907c2011-07-18 04:54:35 +0000479 Type *Ty = Init->getType();
Misha Brukmanb1c93172005-04-21 23:48:37 +0000480
Chris Lattnerabab0712004-10-08 17:32:09 +0000481 std::vector<GlobalVariable*> NewGlobals;
482 Module::GlobalListType &Globals = GV->getParent()->getGlobalList();
483
Chris Lattner67ca6f632008-04-26 07:40:11 +0000484 // Get the alignment of the global, either explicit or target-specific.
485 unsigned StartAlignment = GV->getAlignment();
486 if (StartAlignment == 0)
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000487 StartAlignment = DL.getABITypeAlignment(GV->getType());
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000488
Chris Lattner229907c2011-07-18 04:54:35 +0000489 if (StructType *STy = dyn_cast<StructType>(Ty)) {
Chris Lattnerabab0712004-10-08 17:32:09 +0000490 NewGlobals.reserve(STy->getNumElements());
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000491 const StructLayout &Layout = *DL.getStructLayout(STy);
Chris Lattnerabab0712004-10-08 17:32:09 +0000492 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
Chris Lattner67058832012-01-25 06:48:06 +0000493 Constant *In = Init->getAggregateElement(i);
Chris Lattnerabab0712004-10-08 17:32:09 +0000494 assert(In && "Couldn't get element of initializer?");
Chris Lattner46b5c642009-11-06 04:27:31 +0000495 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(i), false,
Chris Lattnerabab0712004-10-08 17:32:09 +0000496 GlobalVariable::InternalLinkage,
Daniel Dunbar132f7832009-07-30 17:37:43 +0000497 In, GV->getName()+"."+Twine(i),
Hans Wennborgcbe34b42012-06-23 11:37:03 +0000498 GV->getThreadLocalMode(),
Owen Anderson5948fdf2009-07-08 01:26:06 +0000499 GV->getType()->getAddressSpace());
Chris Lattnerabab0712004-10-08 17:32:09 +0000500 Globals.insert(GV, NGV);
501 NewGlobals.push_back(NGV);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000502
Chris Lattner67ca6f632008-04-26 07:40:11 +0000503 // Calculate the known alignment of the field. If the original aggregate
504 // had 256 byte alignment for example, something might depend on that:
505 // propagate info to each field.
506 uint64_t FieldOffset = Layout.getElementOffset(i);
507 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, FieldOffset);
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000508 if (NewAlign > DL.getABITypeAlignment(STy->getElementType(i)))
Chris Lattner67ca6f632008-04-26 07:40:11 +0000509 NGV->setAlignment(NewAlign);
Chris Lattnerabab0712004-10-08 17:32:09 +0000510 }
Chris Lattner229907c2011-07-18 04:54:35 +0000511 } else if (SequentialType *STy = dyn_cast<SequentialType>(Ty)) {
Chris Lattnerabab0712004-10-08 17:32:09 +0000512 unsigned NumElements = 0;
Chris Lattner229907c2011-07-18 04:54:35 +0000513 if (ArrayType *ATy = dyn_cast<ArrayType>(STy))
Chris Lattnerabab0712004-10-08 17:32:09 +0000514 NumElements = ATy->getNumElements();
Chris Lattnerabab0712004-10-08 17:32:09 +0000515 else
Chris Lattner67ca6f632008-04-26 07:40:11 +0000516 NumElements = cast<VectorType>(STy)->getNumElements();
Chris Lattnerabab0712004-10-08 17:32:09 +0000517
Chris Lattner25169ca2005-02-23 16:53:04 +0000518 if (NumElements > 16 && GV->hasNUsesOrMore(16))
Craig Topperf40110f2014-04-25 05:29:35 +0000519 return nullptr; // It's not worth it.
Chris Lattnerabab0712004-10-08 17:32:09 +0000520 NewGlobals.reserve(NumElements);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000521
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000522 uint64_t EltSize = DL.getTypeAllocSize(STy->getElementType());
523 unsigned EltAlign = DL.getABITypeAlignment(STy->getElementType());
Chris Lattnerabab0712004-10-08 17:32:09 +0000524 for (unsigned i = 0, e = NumElements; i != e; ++i) {
Chris Lattner67058832012-01-25 06:48:06 +0000525 Constant *In = Init->getAggregateElement(i);
Chris Lattnerabab0712004-10-08 17:32:09 +0000526 assert(In && "Couldn't get element of initializer?");
527
Chris Lattner46b5c642009-11-06 04:27:31 +0000528 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(), false,
Chris Lattnerabab0712004-10-08 17:32:09 +0000529 GlobalVariable::InternalLinkage,
Daniel Dunbar132f7832009-07-30 17:37:43 +0000530 In, GV->getName()+"."+Twine(i),
Hans Wennborgcbe34b42012-06-23 11:37:03 +0000531 GV->getThreadLocalMode(),
Owen Andersonb17f3292009-07-08 19:03:57 +0000532 GV->getType()->getAddressSpace());
Chris Lattnerabab0712004-10-08 17:32:09 +0000533 Globals.insert(GV, NGV);
534 NewGlobals.push_back(NGV);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000535
Chris Lattner67ca6f632008-04-26 07:40:11 +0000536 // Calculate the known alignment of the field. If the original aggregate
537 // had 256 byte alignment for example, something might depend on that:
538 // propagate info to each field.
539 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, EltSize*i);
540 if (NewAlign > EltAlign)
541 NGV->setAlignment(NewAlign);
Chris Lattnerabab0712004-10-08 17:32:09 +0000542 }
543 }
544
545 if (NewGlobals.empty())
Craig Topperf40110f2014-04-25 05:29:35 +0000546 return nullptr;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000547
David Greene44cb8ad2010-01-05 01:28:05 +0000548 DEBUG(dbgs() << "PERFORMING GLOBAL SRA ON: " << *GV);
Chris Lattner004e2502004-10-11 05:54:41 +0000549
Chris Lattner46b5c642009-11-06 04:27:31 +0000550 Constant *NullInt =Constant::getNullValue(Type::getInt32Ty(GV->getContext()));
Chris Lattnerabab0712004-10-08 17:32:09 +0000551
552 // Loop over all of the uses of the global, replacing the constantexpr geps,
553 // with smaller constantexpr geps or direct references.
554 while (!GV->use_empty()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000555 User *GEP = GV->user_back();
Chris Lattner004e2502004-10-11 05:54:41 +0000556 assert(((isa<ConstantExpr>(GEP) &&
557 cast<ConstantExpr>(GEP)->getOpcode()==Instruction::GetElementPtr)||
558 isa<GetElementPtrInst>(GEP)) && "NonGEP CE's are not SRAable!");
Misha Brukmanb1c93172005-04-21 23:48:37 +0000559
Chris Lattnerabab0712004-10-08 17:32:09 +0000560 // Ignore the 1th operand, which has to be zero or else the program is quite
561 // broken (undefined). Get the 2nd operand, which is the structure or array
562 // index.
Reid Spencere0fc4df2006-10-20 07:07:24 +0000563 unsigned Val = cast<ConstantInt>(GEP->getOperand(2))->getZExtValue();
Chris Lattnerabab0712004-10-08 17:32:09 +0000564 if (Val >= NewGlobals.size()) Val = 0; // Out of bound array access.
565
Chris Lattner004e2502004-10-11 05:54:41 +0000566 Value *NewPtr = NewGlobals[Val];
Chris Lattnerabab0712004-10-08 17:32:09 +0000567
568 // Form a shorter GEP if needed.
Anton Korobeynikov1bfd1212008-02-20 11:26:25 +0000569 if (GEP->getNumOperands() > 3) {
Chris Lattner004e2502004-10-11 05:54:41 +0000570 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEP)) {
Chris Lattnerf96f4a82007-01-31 04:40:53 +0000571 SmallVector<Constant*, 8> Idxs;
Chris Lattner004e2502004-10-11 05:54:41 +0000572 Idxs.push_back(NullInt);
573 for (unsigned i = 3, e = CE->getNumOperands(); i != e; ++i)
574 Idxs.push_back(CE->getOperand(i));
Jay Foaded8db7d2011-07-21 14:31:17 +0000575 NewPtr = ConstantExpr::getGetElementPtr(cast<Constant>(NewPtr), Idxs);
Chris Lattner004e2502004-10-11 05:54:41 +0000576 } else {
577 GetElementPtrInst *GEPI = cast<GetElementPtrInst>(GEP);
Chris Lattner927653f2007-01-31 19:59:55 +0000578 SmallVector<Value*, 8> Idxs;
Chris Lattner004e2502004-10-11 05:54:41 +0000579 Idxs.push_back(NullInt);
580 for (unsigned i = 3, e = GEPI->getNumOperands(); i != e; ++i)
581 Idxs.push_back(GEPI->getOperand(i));
David Blaikie741c8f82015-03-14 01:53:18 +0000582 NewPtr = GetElementPtrInst::Create(
583 NewPtr->getType()->getPointerElementType(), NewPtr, Idxs,
584 GEPI->getName() + "." + Twine(Val), GEPI);
Chris Lattner004e2502004-10-11 05:54:41 +0000585 }
Anton Korobeynikov1bfd1212008-02-20 11:26:25 +0000586 }
Chris Lattner004e2502004-10-11 05:54:41 +0000587 GEP->replaceAllUsesWith(NewPtr);
588
589 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(GEP))
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000590 GEPI->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000591 else
592 cast<ConstantExpr>(GEP)->destroyConstant();
Chris Lattnerabab0712004-10-08 17:32:09 +0000593 }
594
Chris Lattner73ad73e2004-10-08 20:25:55 +0000595 // Delete the old global, now that it is dead.
596 Globals.erase(GV);
Chris Lattnerabab0712004-10-08 17:32:09 +0000597 ++NumSRA;
Chris Lattner004e2502004-10-11 05:54:41 +0000598
599 // Loop over the new globals array deleting any globals that are obviously
600 // dead. This can arise due to scalarization of a structure or an array that
601 // has elements that are dead.
602 unsigned FirstGlobal = 0;
603 for (unsigned i = 0, e = NewGlobals.size(); i != e; ++i)
604 if (NewGlobals[i]->use_empty()) {
605 Globals.erase(NewGlobals[i]);
606 if (FirstGlobal == i) ++FirstGlobal;
607 }
608
Craig Topperf40110f2014-04-25 05:29:35 +0000609 return FirstGlobal != NewGlobals.size() ? NewGlobals[FirstGlobal] : nullptr;
Chris Lattnerabab0712004-10-08 17:32:09 +0000610}
611
Chris Lattner09a52722004-10-09 21:48:45 +0000612/// AllUsesOfValueWillTrapIfNull - Return true if all users of the specified
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000613/// value will trap if the value is dynamically null. PHIs keeps track of any
Chris Lattner2d2892e2007-09-13 16:30:19 +0000614/// phi nodes we've seen to avoid reprocessing them.
Gabor Greif67972872010-04-06 19:24:18 +0000615static bool AllUsesOfValueWillTrapIfNull(const Value *V,
Craig Topper71b7b682014-08-21 05:55:13 +0000616 SmallPtrSetImpl<const PHINode*> &PHIs) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000617 for (const User *U : V->users())
Gabor Greif08355d62010-04-06 19:14:05 +0000618 if (isa<LoadInst>(U)) {
Chris Lattner09a52722004-10-09 21:48:45 +0000619 // Will trap.
Gabor Greif67972872010-04-06 19:24:18 +0000620 } else if (const StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattner09a52722004-10-09 21:48:45 +0000621 if (SI->getOperand(0) == V) {
Gabor Greif08355d62010-04-06 19:14:05 +0000622 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000623 return false; // Storing the value.
624 }
Gabor Greif67972872010-04-06 19:24:18 +0000625 } else if (const CallInst *CI = dyn_cast<CallInst>(U)) {
Gabor Greiffebf6ab2010-03-20 21:00:25 +0000626 if (CI->getCalledValue() != V) {
Gabor Greif08355d62010-04-06 19:14:05 +0000627 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000628 return false; // Not calling the ptr
629 }
Gabor Greif67972872010-04-06 19:24:18 +0000630 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(U)) {
Gabor Greiffebf6ab2010-03-20 21:00:25 +0000631 if (II->getCalledValue() != V) {
Gabor Greif08355d62010-04-06 19:14:05 +0000632 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000633 return false; // Not calling the ptr
634 }
Gabor Greif67972872010-04-06 19:24:18 +0000635 } else if (const BitCastInst *CI = dyn_cast<BitCastInst>(U)) {
Chris Lattner2d2892e2007-09-13 16:30:19 +0000636 if (!AllUsesOfValueWillTrapIfNull(CI, PHIs)) return false;
Gabor Greif67972872010-04-06 19:24:18 +0000637 } else if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner2d2892e2007-09-13 16:30:19 +0000638 if (!AllUsesOfValueWillTrapIfNull(GEPI, PHIs)) return false;
Gabor Greif67972872010-04-06 19:24:18 +0000639 } else if (const PHINode *PN = dyn_cast<PHINode>(U)) {
Chris Lattner2d2892e2007-09-13 16:30:19 +0000640 // If we've already seen this phi node, ignore it, it has already been
641 // checked.
David Blaikie70573dc2014-11-19 07:49:26 +0000642 if (PHIs.insert(PN).second && !AllUsesOfValueWillTrapIfNull(PN, PHIs))
Jakob Stoklund Olesene27dc722010-01-29 23:54:14 +0000643 return false;
Gabor Greif08355d62010-04-06 19:14:05 +0000644 } else if (isa<ICmpInst>(U) &&
Chandler Carruthcdf47882014-03-09 03:16:01 +0000645 isa<ConstantPointerNull>(U->getOperand(1))) {
Nick Lewycky614fb942010-02-25 06:39:10 +0000646 // Ignore icmp X, null
Chris Lattner09a52722004-10-09 21:48:45 +0000647 } else {
Gabor Greif08355d62010-04-06 19:14:05 +0000648 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000649 return false;
650 }
Chandler Carruthcdf47882014-03-09 03:16:01 +0000651
Chris Lattner09a52722004-10-09 21:48:45 +0000652 return true;
653}
654
655/// AllUsesOfLoadedValueWillTrapIfNull - Return true if all uses of any loads
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000656/// from GV will trap if the loaded value is null. Note that this also permits
657/// comparisons of the loaded value against null, as a special case.
Gabor Greif67972872010-04-06 19:24:18 +0000658static bool AllUsesOfLoadedValueWillTrapIfNull(const GlobalVariable *GV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000659 for (const User *U : GV->users())
Gabor Greif67972872010-04-06 19:24:18 +0000660 if (const LoadInst *LI = dyn_cast<LoadInst>(U)) {
661 SmallPtrSet<const PHINode*, 8> PHIs;
Chris Lattner2d2892e2007-09-13 16:30:19 +0000662 if (!AllUsesOfValueWillTrapIfNull(LI, PHIs))
Chris Lattner09a52722004-10-09 21:48:45 +0000663 return false;
Gabor Greif08355d62010-04-06 19:14:05 +0000664 } else if (isa<StoreInst>(U)) {
Chris Lattner09a52722004-10-09 21:48:45 +0000665 // Ignore stores to the global.
666 } else {
667 // We don't know or understand this user, bail out.
Gabor Greif08355d62010-04-06 19:14:05 +0000668 //cerr << "UNKNOWN USER OF GLOBAL!: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000669 return false;
670 }
Chris Lattner09a52722004-10-09 21:48:45 +0000671 return true;
672}
673
Chris Lattner46b5c642009-11-06 04:27:31 +0000674static bool OptimizeAwayTrappingUsesOfValue(Value *V, Constant *NewV) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000675 bool Changed = false;
Chandler Carruthcdf47882014-03-09 03:16:01 +0000676 for (auto UI = V->user_begin(), E = V->user_end(); UI != E; ) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000677 Instruction *I = cast<Instruction>(*UI++);
678 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
679 LI->setOperand(0, NewV);
680 Changed = true;
681 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
682 if (SI->getOperand(1) == V) {
683 SI->setOperand(1, NewV);
684 Changed = true;
685 }
686 } else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
Gabor Greif04397892010-04-06 18:45:08 +0000687 CallSite CS(I);
688 if (CS.getCalledValue() == V) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000689 // Calling through the pointer! Turn into a direct call, but be careful
690 // that the pointer is not also being passed as an argument.
Gabor Greif04397892010-04-06 18:45:08 +0000691 CS.setCalledFunction(NewV);
Chris Lattnere42eb312004-10-10 23:14:11 +0000692 Changed = true;
693 bool PassedAsArg = false;
Gabor Greif04397892010-04-06 18:45:08 +0000694 for (unsigned i = 0, e = CS.arg_size(); i != e; ++i)
695 if (CS.getArgument(i) == V) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000696 PassedAsArg = true;
Gabor Greif04397892010-04-06 18:45:08 +0000697 CS.setArgument(i, NewV);
Chris Lattnere42eb312004-10-10 23:14:11 +0000698 }
699
700 if (PassedAsArg) {
701 // Being passed as an argument also. Be careful to not invalidate UI!
Chandler Carruthcdf47882014-03-09 03:16:01 +0000702 UI = V->user_begin();
Chris Lattnere42eb312004-10-10 23:14:11 +0000703 }
704 }
705 } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
706 Changed |= OptimizeAwayTrappingUsesOfValue(CI,
Owen Anderson487375e2009-07-29 18:55:55 +0000707 ConstantExpr::getCast(CI->getOpcode(),
Chris Lattner46b5c642009-11-06 04:27:31 +0000708 NewV, CI->getType()));
Chris Lattnere42eb312004-10-10 23:14:11 +0000709 if (CI->use_empty()) {
710 Changed = true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000711 CI->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000712 }
713 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
714 // Should handle GEP here.
Chris Lattnerf96f4a82007-01-31 04:40:53 +0000715 SmallVector<Constant*, 8> Idxs;
716 Idxs.reserve(GEPI->getNumOperands()-1);
Gabor Greif3a9fba52008-05-29 01:59:18 +0000717 for (User::op_iterator i = GEPI->op_begin() + 1, e = GEPI->op_end();
718 i != e; ++i)
719 if (Constant *C = dyn_cast<Constant>(*i))
Chris Lattnerf96f4a82007-01-31 04:40:53 +0000720 Idxs.push_back(C);
Chris Lattnere42eb312004-10-10 23:14:11 +0000721 else
722 break;
Chris Lattnerf96f4a82007-01-31 04:40:53 +0000723 if (Idxs.size() == GEPI->getNumOperands()-1)
Chris Lattnere42eb312004-10-10 23:14:11 +0000724 Changed |= OptimizeAwayTrappingUsesOfValue(GEPI,
Jay Foaded8db7d2011-07-21 14:31:17 +0000725 ConstantExpr::getGetElementPtr(NewV, Idxs));
Chris Lattnere42eb312004-10-10 23:14:11 +0000726 if (GEPI->use_empty()) {
727 Changed = true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000728 GEPI->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000729 }
730 }
731 }
732
733 return Changed;
734}
735
736
737/// OptimizeAwayTrappingUsesOfLoads - The specified global has only one non-null
738/// value stored into it. If there are uses of the loaded value that would trap
739/// if the loaded value is dynamically null, then we know that they cannot be
740/// reachable with a null optimize away the load.
Nick Lewyckycf6aae62012-02-12 01:13:18 +0000741static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV,
Mehdi Amini46a43552015-03-04 18:43:29 +0000742 const DataLayout &DL,
Nick Lewyckycf6aae62012-02-12 01:13:18 +0000743 TargetLibraryInfo *TLI) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000744 bool Changed = false;
745
Chris Lattner2538eb62009-01-14 00:12:58 +0000746 // Keep track of whether we are able to remove all the uses of the global
747 // other than the store that defines it.
748 bool AllNonStoreUsesGone = true;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000749
Chris Lattnere42eb312004-10-10 23:14:11 +0000750 // Replace all uses of loads with uses of uses of the stored value.
Chandler Carruthcdf47882014-03-09 03:16:01 +0000751 for (Value::user_iterator GUI = GV->user_begin(), E = GV->user_end(); GUI != E;){
Chris Lattner2538eb62009-01-14 00:12:58 +0000752 User *GlobalUser = *GUI++;
753 if (LoadInst *LI = dyn_cast<LoadInst>(GlobalUser)) {
Chris Lattner46b5c642009-11-06 04:27:31 +0000754 Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV);
Chris Lattner2538eb62009-01-14 00:12:58 +0000755 // If we were able to delete all uses of the loads
756 if (LI->use_empty()) {
757 LI->eraseFromParent();
758 Changed = true;
759 } else {
760 AllNonStoreUsesGone = false;
761 }
762 } else if (isa<StoreInst>(GlobalUser)) {
763 // Ignore the store that stores "LV" to the global.
764 assert(GlobalUser->getOperand(1) == GV &&
765 "Must be storing *to* the global");
Chris Lattnere42eb312004-10-10 23:14:11 +0000766 } else {
Chris Lattner2538eb62009-01-14 00:12:58 +0000767 AllNonStoreUsesGone = false;
768
769 // If we get here we could have other crazy uses that are transitively
770 // loaded.
771 assert((isa<PHINode>(GlobalUser) || isa<SelectInst>(GlobalUser) ||
Benjamin Kramered843602012-09-28 10:01:27 +0000772 isa<ConstantExpr>(GlobalUser) || isa<CmpInst>(GlobalUser) ||
773 isa<BitCastInst>(GlobalUser) ||
774 isa<GetElementPtrInst>(GlobalUser)) &&
Chris Lattner1a1acc22011-05-22 07:15:13 +0000775 "Only expect load and stores!");
Chris Lattnere42eb312004-10-10 23:14:11 +0000776 }
Chris Lattner2538eb62009-01-14 00:12:58 +0000777 }
Chris Lattnere42eb312004-10-10 23:14:11 +0000778
779 if (Changed) {
David Greene44cb8ad2010-01-05 01:28:05 +0000780 DEBUG(dbgs() << "OPTIMIZED LOADS FROM STORED ONCE POINTER: " << *GV);
Chris Lattnere42eb312004-10-10 23:14:11 +0000781 ++NumGlobUses;
782 }
783
Chris Lattnere42eb312004-10-10 23:14:11 +0000784 // If we nuked all of the loads, then none of the stores are needed either,
785 // nor is the global.
Chris Lattner2538eb62009-01-14 00:12:58 +0000786 if (AllNonStoreUsesGone) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000787 if (isLeakCheckerRoot(GV)) {
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000788 Changed |= CleanupPointerRootUsers(GV, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000789 } else {
790 Changed = true;
Craig Topperf40110f2014-04-25 05:29:35 +0000791 CleanupConstantGlobalUsers(GV, nullptr, DL, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000792 }
Chris Lattnere42eb312004-10-10 23:14:11 +0000793 if (GV->use_empty()) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000794 DEBUG(dbgs() << " *** GLOBAL NOW DEAD!\n");
795 Changed = true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000796 GV->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000797 ++NumDeleted;
798 }
Chris Lattnere42eb312004-10-10 23:14:11 +0000799 }
800 return Changed;
801}
802
Chris Lattner004e2502004-10-11 05:54:41 +0000803/// ConstantPropUsersOf - Walk the use list of V, constant folding all of the
804/// instructions that are foldable.
Mehdi Amini46a43552015-03-04 18:43:29 +0000805static void ConstantPropUsersOf(Value *V, const DataLayout &DL,
Rafael Espindolaaeff8a92014-02-24 23:12:18 +0000806 TargetLibraryInfo *TLI) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000807 for (Value::user_iterator UI = V->user_begin(), E = V->user_end(); UI != E; )
Chris Lattner004e2502004-10-11 05:54:41 +0000808 if (Instruction *I = dyn_cast<Instruction>(*UI++))
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000809 if (Constant *NewC = ConstantFoldInstruction(I, DL, TLI)) {
Chris Lattner004e2502004-10-11 05:54:41 +0000810 I->replaceAllUsesWith(NewC);
811
Chris Lattnerd6a44922005-02-01 01:23:31 +0000812 // Advance UI to the next non-I use to avoid invalidating it!
813 // Instructions could multiply use V.
814 while (UI != E && *UI == I)
Chris Lattner004e2502004-10-11 05:54:41 +0000815 ++UI;
Chris Lattnerd6a44922005-02-01 01:23:31 +0000816 I->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000817 }
818}
819
820/// OptimizeGlobalAddressOfMalloc - This function takes the specified global
821/// variable, and transforms the program as if it always contained the result of
822/// the specified malloc. Because it is always the result of the specified
823/// malloc, there is no reason to actually DO the malloc. Instead, turn the
Chris Lattner3ede00b2006-11-30 17:32:29 +0000824/// malloc into a global, and any loads of GV as uses of the new global.
Mehdi Amini46a43552015-03-04 18:43:29 +0000825static GlobalVariable *
826OptimizeGlobalAddressOfMalloc(GlobalVariable *GV, CallInst *CI, Type *AllocTy,
827 ConstantInt *NElements, const DataLayout &DL,
828 TargetLibraryInfo *TLI) {
Chris Lattner7939f792010-02-25 22:33:52 +0000829 DEBUG(errs() << "PROMOTING GLOBAL: " << *GV << " CALL = " << *CI << '\n');
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000830
Chris Lattner229907c2011-07-18 04:54:35 +0000831 Type *GlobalType;
Chris Lattner7939f792010-02-25 22:33:52 +0000832 if (NElements->getZExtValue() == 1)
833 GlobalType = AllocTy;
834 else
835 // If we have an array allocation, the global variable is of an array.
836 GlobalType = ArrayType::get(AllocTy, NElements->getZExtValue());
Victor Hernandez5d034492009-09-18 22:35:49 +0000837
838 // Create the new global variable. The contents of the malloc'd memory is
839 // undefined, so initialize with an undef value.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000840 GlobalVariable *NewGV = new GlobalVariable(*GV->getParent(),
Chris Lattner65d3a0a2010-02-26 23:42:13 +0000841 GlobalType, false,
Chris Lattner7939f792010-02-25 22:33:52 +0000842 GlobalValue::InternalLinkage,
Chris Lattner65d3a0a2010-02-26 23:42:13 +0000843 UndefValue::get(GlobalType),
Victor Hernandez5d034492009-09-18 22:35:49 +0000844 GV->getName()+".body",
845 GV,
Hans Wennborgcbe34b42012-06-23 11:37:03 +0000846 GV->getThreadLocalMode());
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000847
Chris Lattner7939f792010-02-25 22:33:52 +0000848 // If there are bitcast users of the malloc (which is typical, usually we have
849 // a malloc + bitcast) then replace them with uses of the new global. Update
850 // other users to use the global as well.
Craig Topperf40110f2014-04-25 05:29:35 +0000851 BitCastInst *TheBC = nullptr;
Chris Lattner7939f792010-02-25 22:33:52 +0000852 while (!CI->use_empty()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000853 Instruction *User = cast<Instruction>(CI->user_back());
Chris Lattner7939f792010-02-25 22:33:52 +0000854 if (BitCastInst *BCI = dyn_cast<BitCastInst>(User)) {
855 if (BCI->getType() == NewGV->getType()) {
856 BCI->replaceAllUsesWith(NewGV);
857 BCI->eraseFromParent();
858 } else {
859 BCI->setOperand(0, NewGV);
860 }
861 } else {
Craig Topperf40110f2014-04-25 05:29:35 +0000862 if (!TheBC)
Chris Lattner7939f792010-02-25 22:33:52 +0000863 TheBC = new BitCastInst(NewGV, CI->getType(), "newgv", CI);
864 User->replaceUsesOfWith(CI, TheBC);
865 }
866 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000867
Victor Hernandez5d034492009-09-18 22:35:49 +0000868 Constant *RepValue = NewGV;
869 if (NewGV->getType() != GV->getType()->getElementType())
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000870 RepValue = ConstantExpr::getBitCast(RepValue,
Victor Hernandez5d034492009-09-18 22:35:49 +0000871 GV->getType()->getElementType());
872
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
937 GV->getParent()->getGlobalList().insert(GV, InitBool);
938
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
Chris Lattnerc0677c02004-12-02 07:11:07 +0000953/// ValueIsOnlyUsedLocallyOrStoredToOneGlobal - Scan the use-list of V checking
954/// to make sure that there are no complex uses of V. We permit simple things
955/// like dereferencing the pointer, but not storing through the address, unless
956/// it is to the specified global.
Gabor Greifa21bc0f2010-04-06 18:58:22 +0000957static bool ValueIsOnlyUsedLocallyOrStoredToOneGlobal(const Instruction *V,
958 const GlobalVariable *GV,
Craig Topper71b7b682014-08-21 05:55:13 +0000959 SmallPtrSetImpl<const PHINode*> &PHIs) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000960 for (const User *U : V->users()) {
961 const Instruction *Inst = cast<Instruction>(U);
Gabor Greif08355d62010-04-06 19:14:05 +0000962
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000963 if (isa<LoadInst>(Inst) || isa<CmpInst>(Inst)) {
964 continue; // Fine, ignore.
965 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000966
Gabor Greifa21bc0f2010-04-06 18:58:22 +0000967 if (const StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
Chris Lattnerc0677c02004-12-02 07:11:07 +0000968 if (SI->getOperand(0) == V && SI->getOperand(1) != GV)
969 return false; // Storing the pointer itself... bad.
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000970 continue; // Otherwise, storing through it, or storing into GV... fine.
971 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000972
Chris Lattnerb9801ff2010-04-10 18:19:22 +0000973 // Must index into the array and into the struct.
974 if (isa<GetElementPtrInst>(Inst) && Inst->getNumOperands() >= 3) {
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000975 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Inst, GV, PHIs))
Chris Lattnerc0677c02004-12-02 07:11:07 +0000976 return false;
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000977 continue;
978 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000979
Gabor Greifa21bc0f2010-04-06 18:58:22 +0000980 if (const PHINode *PN = dyn_cast<PHINode>(Inst)) {
Chris Lattner6eed0e72007-09-13 16:37:20 +0000981 // PHIs are ok if all uses are ok. Don't infinitely recurse through PHI
982 // cycles.
David Blaikie70573dc2014-11-19 07:49:26 +0000983 if (PHIs.insert(PN).second)
Chris Lattner5d13fb532007-09-14 03:41:21 +0000984 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(PN, GV, PHIs))
985 return false;
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000986 continue;
Chris Lattnerc0677c02004-12-02 07:11:07 +0000987 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000988
Gabor Greifa21bc0f2010-04-06 18:58:22 +0000989 if (const BitCastInst *BCI = dyn_cast<BitCastInst>(Inst)) {
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000990 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(BCI, GV, PHIs))
991 return false;
992 continue;
993 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000994
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000995 return false;
996 }
Chris Lattnerc0677c02004-12-02 07:11:07 +0000997 return true;
Chris Lattnerc0677c02004-12-02 07:11:07 +0000998}
999
Chris Lattner24d3d422006-09-30 23:32:09 +00001000/// ReplaceUsesOfMallocWithGlobal - The Alloc pointer is stored into GV
1001/// somewhere. Transform all uses of the allocation into loads from the
1002/// global and uses of the resultant pointer. Further, delete the store into
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001003/// GV. This assumes that these value pass the
Chris Lattner24d3d422006-09-30 23:32:09 +00001004/// 'ValueIsOnlyUsedLocallyOrStoredToOneGlobal' predicate.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001005static void ReplaceUsesOfMallocWithGlobal(Instruction *Alloc,
Chris Lattner24d3d422006-09-30 23:32:09 +00001006 GlobalVariable *GV) {
1007 while (!Alloc->use_empty()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001008 Instruction *U = cast<Instruction>(*Alloc->user_begin());
Chris Lattnerba98f892007-09-13 18:00:31 +00001009 Instruction *InsertPt = U;
Chris Lattner24d3d422006-09-30 23:32:09 +00001010 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
1011 // If this is the store of the allocation into the global, remove it.
1012 if (SI->getOperand(1) == GV) {
1013 SI->eraseFromParent();
1014 continue;
1015 }
Chris Lattnerba98f892007-09-13 18:00:31 +00001016 } else if (PHINode *PN = dyn_cast<PHINode>(U)) {
1017 // Insert the load in the corresponding predecessor, not right before the
1018 // PHI.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001019 InsertPt = PN->getIncomingBlock(*Alloc->use_begin())->getTerminator();
Chris Lattner49e3bdc2008-12-15 21:44:34 +00001020 } else if (isa<BitCastInst>(U)) {
1021 // Must be bitcast between the malloc and store to initialize the global.
1022 ReplaceUsesOfMallocWithGlobal(U, GV);
1023 U->eraseFromParent();
1024 continue;
1025 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
1026 // If this is a "GEP bitcast" and the user is a store to the global, then
1027 // just process it as a bitcast.
1028 if (GEPI->hasAllZeroIndices() && GEPI->hasOneUse())
Chandler Carruthcdf47882014-03-09 03:16:01 +00001029 if (StoreInst *SI = dyn_cast<StoreInst>(GEPI->user_back()))
Chris Lattner49e3bdc2008-12-15 21:44:34 +00001030 if (SI->getOperand(1) == GV) {
1031 // Must be bitcast GEP between the malloc and store to initialize
1032 // the global.
1033 ReplaceUsesOfMallocWithGlobal(GEPI, GV);
1034 GEPI->eraseFromParent();
1035 continue;
1036 }
Chris Lattner24d3d422006-09-30 23:32:09 +00001037 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001038
Chris Lattner24d3d422006-09-30 23:32:09 +00001039 // Insert a load from the global, and use it instead of the malloc.
Chris Lattnerba98f892007-09-13 18:00:31 +00001040 Value *NL = new LoadInst(GV, GV->getName()+".val", InsertPt);
Chris Lattner24d3d422006-09-30 23:32:09 +00001041 U->replaceUsesOfWith(Alloc, NL);
1042 }
1043}
1044
Chris Lattner56b55382008-12-16 21:24:51 +00001045/// LoadUsesSimpleEnoughForHeapSRA - Verify that all uses of V (a load, or a phi
1046/// of a load) are simple enough to perform heap SRA on. This permits GEP's
1047/// that index through the array and struct field, icmps of null, and PHIs.
Gabor Greif5d5db532010-04-01 08:21:08 +00001048static bool LoadUsesSimpleEnoughForHeapSRA(const Value *V,
Craig Topper71b7b682014-08-21 05:55:13 +00001049 SmallPtrSetImpl<const PHINode*> &LoadUsingPHIs,
1050 SmallPtrSetImpl<const PHINode*> &LoadUsingPHIsPerLoad) {
Chris Lattner56b55382008-12-16 21:24:51 +00001051 // We permit two users of the load: setcc comparing against the null
1052 // pointer, and a getelementptr of a specific form.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001053 for (const User *U : V->users()) {
1054 const Instruction *UI = cast<Instruction>(U);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001055
Chris Lattner56b55382008-12-16 21:24:51 +00001056 // Comparison against null is ok.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001057 if (const ICmpInst *ICI = dyn_cast<ICmpInst>(UI)) {
Chris Lattner56b55382008-12-16 21:24:51 +00001058 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
1059 return false;
1060 continue;
1061 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001062
Chris Lattner56b55382008-12-16 21:24:51 +00001063 // getelementptr is also ok, but only a simple form.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001064 if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(UI)) {
Chris Lattner56b55382008-12-16 21:24:51 +00001065 // Must index into the array and into the struct.
1066 if (GEPI->getNumOperands() < 3)
1067 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001068
Chris Lattner56b55382008-12-16 21:24:51 +00001069 // Otherwise the GEP is ok.
1070 continue;
1071 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001072
Chandler Carruthcdf47882014-03-09 03:16:01 +00001073 if (const PHINode *PN = dyn_cast<PHINode>(UI)) {
David Blaikie70573dc2014-11-19 07:49:26 +00001074 if (!LoadUsingPHIsPerLoad.insert(PN).second)
Evan Cheng83689442009-06-02 00:56:07 +00001075 // This means some phi nodes are dependent on each other.
1076 // Avoid infinite looping!
1077 return false;
David Blaikie70573dc2014-11-19 07:49:26 +00001078 if (!LoadUsingPHIs.insert(PN).second)
Evan Cheng83689442009-06-02 00:56:07 +00001079 // If we have already analyzed this PHI, then it is safe.
Chris Lattner56b55382008-12-16 21:24:51 +00001080 continue;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001081
Chris Lattner222ef4c2008-12-17 05:28:49 +00001082 // Make sure all uses of the PHI are simple enough to transform.
Evan Cheng83689442009-06-02 00:56:07 +00001083 if (!LoadUsesSimpleEnoughForHeapSRA(PN,
1084 LoadUsingPHIs, LoadUsingPHIsPerLoad))
Chris Lattner56b55382008-12-16 21:24:51 +00001085 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001086
Chris Lattner56b55382008-12-16 21:24:51 +00001087 continue;
Chris Lattner24d3d422006-09-30 23:32:09 +00001088 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001089
Chris Lattner56b55382008-12-16 21:24:51 +00001090 // Otherwise we don't know what this is, not ok.
1091 return false;
1092 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001093
Chris Lattner56b55382008-12-16 21:24:51 +00001094 return true;
1095}
1096
1097
1098/// AllGlobalLoadUsesSimpleEnoughForHeapSRA - If all users of values loaded from
1099/// GV are simple enough to perform HeapSRA, return true.
Gabor Greif5d5db532010-04-01 08:21:08 +00001100static bool AllGlobalLoadUsesSimpleEnoughForHeapSRA(const GlobalVariable *GV,
Victor Hernandez5d034492009-09-18 22:35:49 +00001101 Instruction *StoredVal) {
Gabor Greif5d5db532010-04-01 08:21:08 +00001102 SmallPtrSet<const PHINode*, 32> LoadUsingPHIs;
1103 SmallPtrSet<const PHINode*, 32> LoadUsingPHIsPerLoad;
Chandler Carruthcdf47882014-03-09 03:16:01 +00001104 for (const User *U : GV->users())
1105 if (const LoadInst *LI = dyn_cast<LoadInst>(U)) {
Evan Cheng83689442009-06-02 00:56:07 +00001106 if (!LoadUsesSimpleEnoughForHeapSRA(LI, LoadUsingPHIs,
1107 LoadUsingPHIsPerLoad))
Chris Lattner56b55382008-12-16 21:24:51 +00001108 return false;
Evan Cheng83689442009-06-02 00:56:07 +00001109 LoadUsingPHIsPerLoad.clear();
1110 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001111
Chris Lattner222ef4c2008-12-17 05:28:49 +00001112 // If we reach here, we know that all uses of the loads and transitive uses
1113 // (through PHI nodes) are simple enough to transform. However, we don't know
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001114 // that all inputs the to the PHI nodes are in the same equivalence sets.
Chris Lattner222ef4c2008-12-17 05:28:49 +00001115 // Check to verify that all operands of the PHIs are either PHIS that can be
1116 // transformed, loads from GV, or MI itself.
Craig Topper46276792014-08-24 23:23:06 +00001117 for (const PHINode *PN : LoadUsingPHIs) {
Chris Lattner222ef4c2008-12-17 05:28:49 +00001118 for (unsigned op = 0, e = PN->getNumIncomingValues(); op != e; ++op) {
1119 Value *InVal = PN->getIncomingValue(op);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001120
Chris Lattner222ef4c2008-12-17 05:28:49 +00001121 // PHI of the stored value itself is ok.
Victor Hernandez5d034492009-09-18 22:35:49 +00001122 if (InVal == StoredVal) continue;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001123
Gabor Greif5d5db532010-04-01 08:21:08 +00001124 if (const PHINode *InPN = dyn_cast<PHINode>(InVal)) {
Chris Lattner222ef4c2008-12-17 05:28:49 +00001125 // One of the PHIs in our set is (optimistically) ok.
1126 if (LoadUsingPHIs.count(InPN))
1127 continue;
1128 return false;
1129 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001130
Chris Lattner222ef4c2008-12-17 05:28:49 +00001131 // Load from GV is ok.
Gabor Greif5d5db532010-04-01 08:21:08 +00001132 if (const LoadInst *LI = dyn_cast<LoadInst>(InVal))
Chris Lattner222ef4c2008-12-17 05:28:49 +00001133 if (LI->getOperand(0) == GV)
1134 continue;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001135
Chris Lattner222ef4c2008-12-17 05:28:49 +00001136 // UNDEF? NULL?
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001137
Chris Lattner222ef4c2008-12-17 05:28:49 +00001138 // Anything else is rejected.
1139 return false;
1140 }
1141 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001142
Chris Lattner24d3d422006-09-30 23:32:09 +00001143 return true;
1144}
1145
Chris Lattner222ef4c2008-12-17 05:28:49 +00001146static Value *GetHeapSROAValue(Value *V, unsigned FieldNo,
1147 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001148 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattner222ef4c2008-12-17 05:28:49 +00001149 std::vector<Value*> &FieldVals = InsertedScalarizedValues[V];
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001150
Chris Lattner222ef4c2008-12-17 05:28:49 +00001151 if (FieldNo >= FieldVals.size())
1152 FieldVals.resize(FieldNo+1);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001153
Chris Lattner222ef4c2008-12-17 05:28:49 +00001154 // If we already have this value, just reuse the previously scalarized
1155 // version.
1156 if (Value *FieldVal = FieldVals[FieldNo])
1157 return FieldVal;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001158
Chris Lattner222ef4c2008-12-17 05:28:49 +00001159 // Depending on what instruction this is, we have several cases.
1160 Value *Result;
1161 if (LoadInst *LI = dyn_cast<LoadInst>(V)) {
1162 // This is a scalarized version of the load from the global. Just create
1163 // a new Load of the scalarized global.
1164 Result = new LoadInst(GetHeapSROAValue(LI->getOperand(0), FieldNo,
1165 InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001166 PHIsToRewrite),
Daniel Dunbar132f7832009-07-30 17:37:43 +00001167 LI->getName()+".f"+Twine(FieldNo), LI);
David Blaikie741c8f82015-03-14 01:53:18 +00001168 } else {
1169 PHINode *PN = cast<PHINode>(V);
Chris Lattner222ef4c2008-12-17 05:28:49 +00001170 // PN's type is pointer to struct. Make a new PHI of pointer to struct
1171 // field.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001172
Matt Arsenaultfcd74012014-04-23 20:36:10 +00001173 PointerType *PTy = cast<PointerType>(PN->getType());
1174 StructType *ST = cast<StructType>(PTy->getElementType());
1175
1176 unsigned AS = PTy->getAddressSpace();
Jay Foade0938d82011-03-30 11:19:20 +00001177 PHINode *NewPN =
Matt Arsenaultfcd74012014-04-23 20:36:10 +00001178 PHINode::Create(PointerType::get(ST->getElementType(FieldNo), AS),
Jay Foad52131342011-03-30 11:28:46 +00001179 PN->getNumIncomingValues(),
Daniel Dunbar132f7832009-07-30 17:37:43 +00001180 PN->getName()+".f"+Twine(FieldNo), PN);
Jay Foade0938d82011-03-30 11:19:20 +00001181 Result = NewPN;
Chris Lattner222ef4c2008-12-17 05:28:49 +00001182 PHIsToRewrite.push_back(std::make_pair(PN, FieldNo));
Chris Lattner222ef4c2008-12-17 05:28:49 +00001183 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001184
Chris Lattner222ef4c2008-12-17 05:28:49 +00001185 return FieldVals[FieldNo] = Result;
Chris Lattnerba98f892007-09-13 18:00:31 +00001186}
1187
Chris Lattnerf315d4f2007-09-13 17:29:05 +00001188/// RewriteHeapSROALoadUser - Given a load instruction and a value derived from
1189/// the load, rewrite the derived value to use the HeapSRoA'd load.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001190static void RewriteHeapSROALoadUser(Instruction *LoadUser,
Chris Lattner222ef4c2008-12-17 05:28:49 +00001191 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001192 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattnerf315d4f2007-09-13 17:29:05 +00001193 // If this is a comparison against null, handle it.
1194 if (ICmpInst *SCI = dyn_cast<ICmpInst>(LoadUser)) {
1195 assert(isa<ConstantPointerNull>(SCI->getOperand(1)));
1196 // If we have a setcc of the loaded pointer, we can use a setcc of any
1197 // field.
Chris Lattner222ef4c2008-12-17 05:28:49 +00001198 Value *NPtr = GetHeapSROAValue(SCI->getOperand(0), 0,
Chris Lattner46b5c642009-11-06 04:27:31 +00001199 InsertedScalarizedValues, PHIsToRewrite);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001200
Owen Anderson1e5f00e2009-07-09 23:48:35 +00001201 Value *New = new ICmpInst(SCI, SCI->getPredicate(), NPtr,
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001202 Constant::getNullValue(NPtr->getType()),
Owen Anderson1e5f00e2009-07-09 23:48:35 +00001203 SCI->getName());
Chris Lattnerf315d4f2007-09-13 17:29:05 +00001204 SCI->replaceAllUsesWith(New);
1205 SCI->eraseFromParent();
1206 return;
1207 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001208
Chris Lattner222ef4c2008-12-17 05:28:49 +00001209 // Handle 'getelementptr Ptr, Idx, i32 FieldNo ...'
Chris Lattnerba98f892007-09-13 18:00:31 +00001210 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(LoadUser)) {
1211 assert(GEPI->getNumOperands() >= 3 && isa<ConstantInt>(GEPI->getOperand(2))
1212 && "Unexpected GEPI!");
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001213
Chris Lattnerba98f892007-09-13 18:00:31 +00001214 // Load the pointer for this field.
1215 unsigned FieldNo = cast<ConstantInt>(GEPI->getOperand(2))->getZExtValue();
Chris Lattner222ef4c2008-12-17 05:28:49 +00001216 Value *NewPtr = GetHeapSROAValue(GEPI->getOperand(0), FieldNo,
Chris Lattner46b5c642009-11-06 04:27:31 +00001217 InsertedScalarizedValues, PHIsToRewrite);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001218
Chris Lattnerba98f892007-09-13 18:00:31 +00001219 // Create the new GEP idx vector.
1220 SmallVector<Value*, 8> GEPIdx;
1221 GEPIdx.push_back(GEPI->getOperand(1));
1222 GEPIdx.append(GEPI->op_begin()+3, GEPI->op_end());
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001223
David Blaikie22319eb2015-03-14 19:24:04 +00001224 Value *NGEPI = GetElementPtrInst::Create(GEPI->getResultElementType(), NewPtr, GEPIdx,
Gabor Greife9ecc682008-04-06 20:25:17 +00001225 GEPI->getName(), GEPI);
Chris Lattnerba98f892007-09-13 18:00:31 +00001226 GEPI->replaceAllUsesWith(NGEPI);
1227 GEPI->eraseFromParent();
1228 return;
1229 }
Chris Lattner011f91b2007-09-13 21:31:36 +00001230
Chris Lattner222ef4c2008-12-17 05:28:49 +00001231 // Recursively transform the users of PHI nodes. This will lazily create the
1232 // PHIs that are needed for individual elements. Keep track of what PHIs we
1233 // see in InsertedScalarizedValues so that we don't get infinite loops (very
1234 // antisocial). If the PHI is already in InsertedScalarizedValues, it has
1235 // already been seen first by another load, so its uses have already been
1236 // processed.
1237 PHINode *PN = cast<PHINode>(LoadUser);
Chris Lattner5cf753c2011-07-21 06:21:31 +00001238 if (!InsertedScalarizedValues.insert(std::make_pair(PN,
1239 std::vector<Value*>())).second)
1240 return;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001241
Chris Lattner222ef4c2008-12-17 05:28:49 +00001242 // If this is the first time we've seen this PHI, recursively process all
1243 // users.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001244 for (auto UI = PN->user_begin(), E = PN->user_end(); UI != E;) {
Chris Lattner0cdf5232008-12-17 05:42:08 +00001245 Instruction *User = cast<Instruction>(*UI++);
Chris Lattner46b5c642009-11-06 04:27:31 +00001246 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
Chris Lattner0cdf5232008-12-17 05:42:08 +00001247 }
Chris Lattnerf315d4f2007-09-13 17:29:05 +00001248}
1249
Chris Lattner24d3d422006-09-30 23:32:09 +00001250/// RewriteUsesOfLoadForHeapSRoA - We are performing Heap SRoA on a global. Ptr
1251/// is a value loaded from the global. Eliminate all uses of Ptr, making them
1252/// use FieldGlobals instead. All uses of loaded values satisfy
Chris Lattner56b55382008-12-16 21:24:51 +00001253/// AllGlobalLoadUsesSimpleEnoughForHeapSRA.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001254static void RewriteUsesOfLoadForHeapSRoA(LoadInst *Load,
Chris Lattner222ef4c2008-12-17 05:28:49 +00001255 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001256 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001257 for (auto UI = Load->user_begin(), E = Load->user_end(); UI != E;) {
Chris Lattner0cdf5232008-12-17 05:42:08 +00001258 Instruction *User = cast<Instruction>(*UI++);
Chris Lattner46b5c642009-11-06 04:27:31 +00001259 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
Chris Lattner0cdf5232008-12-17 05:42:08 +00001260 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001261
Chris Lattner222ef4c2008-12-17 05:28:49 +00001262 if (Load->use_empty()) {
1263 Load->eraseFromParent();
1264 InsertedScalarizedValues.erase(Load);
1265 }
Chris Lattner24d3d422006-09-30 23:32:09 +00001266}
1267
Victor Hernandez5d034492009-09-18 22:35:49 +00001268/// PerformHeapAllocSRoA - CI is an allocation of an array of structures. Break
1269/// it up into multiple allocations of arrays of the fields.
Victor Hernandezf3db9152009-11-07 00:16:28 +00001270static GlobalVariable *PerformHeapAllocSRoA(GlobalVariable *GV, CallInst *CI,
Mehdi Amini46a43552015-03-04 18:43:29 +00001271 Value *NElems, const DataLayout &DL,
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001272 const TargetLibraryInfo *TLI) {
David Greene44cb8ad2010-01-05 01:28:05 +00001273 DEBUG(dbgs() << "SROA HEAP ALLOC: " << *GV << " MALLOC = " << *CI << '\n');
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001274 Type *MAT = getMallocAllocatedType(CI, TLI);
Chris Lattner229907c2011-07-18 04:54:35 +00001275 StructType *STy = cast<StructType>(MAT);
Victor Hernandez5d034492009-09-18 22:35:49 +00001276
1277 // There is guaranteed to be at least one use of the malloc (storing
1278 // it into GV). If there are other uses, change them to be uses of
1279 // the global to simplify later code. This also deletes the store
1280 // into GV.
Victor Hernandezf3db9152009-11-07 00:16:28 +00001281 ReplaceUsesOfMallocWithGlobal(CI, GV);
1282
Victor Hernandez5d034492009-09-18 22:35:49 +00001283 // Okay, at this point, there are no users of the malloc. Insert N
1284 // new mallocs at the same place as CI, and N globals.
1285 std::vector<Value*> FieldGlobals;
1286 std::vector<Value*> FieldMallocs;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001287
Matt Arsenaultfcd74012014-04-23 20:36:10 +00001288 unsigned AS = GV->getType()->getPointerAddressSpace();
Victor Hernandez5d034492009-09-18 22:35:49 +00001289 for (unsigned FieldNo = 0, e = STy->getNumElements(); FieldNo != e;++FieldNo){
Chris Lattner229907c2011-07-18 04:54:35 +00001290 Type *FieldTy = STy->getElementType(FieldNo);
Matt Arsenaultfcd74012014-04-23 20:36:10 +00001291 PointerType *PFieldTy = PointerType::get(FieldTy, AS);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001292
Victor Hernandez5d034492009-09-18 22:35:49 +00001293 GlobalVariable *NGV =
1294 new GlobalVariable(*GV->getParent(),
1295 PFieldTy, false, GlobalValue::InternalLinkage,
1296 Constant::getNullValue(PFieldTy),
1297 GV->getName() + ".f" + Twine(FieldNo), GV,
Hans Wennborgcbe34b42012-06-23 11:37:03 +00001298 GV->getThreadLocalMode());
Victor Hernandez5d034492009-09-18 22:35:49 +00001299 FieldGlobals.push_back(NGV);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001300
Mehdi Amini46a43552015-03-04 18:43:29 +00001301 unsigned TypeSize = DL.getTypeAllocSize(FieldTy);
Chris Lattner229907c2011-07-18 04:54:35 +00001302 if (StructType *ST = dyn_cast<StructType>(FieldTy))
Mehdi Amini46a43552015-03-04 18:43:29 +00001303 TypeSize = DL.getStructLayout(ST)->getSizeInBytes();
1304 Type *IntPtrTy = DL.getIntPtrType(CI->getType());
Victor Hernandezf3db9152009-11-07 00:16:28 +00001305 Value *NMI = CallInst::CreateMalloc(CI, IntPtrTy, FieldTy,
1306 ConstantInt::get(IntPtrTy, TypeSize),
Craig Topperf40110f2014-04-25 05:29:35 +00001307 NElems, nullptr,
Victor Hernandezf3db9152009-11-07 00:16:28 +00001308 CI->getName() + ".f" + Twine(FieldNo));
Chris Lattner0521c092010-02-26 18:23:13 +00001309 FieldMallocs.push_back(NMI);
Victor Hernandezf3db9152009-11-07 00:16:28 +00001310 new StoreInst(NMI, NGV, CI);
Victor Hernandez5d034492009-09-18 22:35:49 +00001311 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001312
Victor Hernandez5d034492009-09-18 22:35:49 +00001313 // The tricky aspect of this transformation is handling the case when malloc
1314 // fails. In the original code, malloc failing would set the result pointer
1315 // of malloc to null. In this case, some mallocs could succeed and others
1316 // could fail. As such, we emit code that looks like this:
1317 // F0 = malloc(field0)
1318 // F1 = malloc(field1)
1319 // F2 = malloc(field2)
1320 // if (F0 == 0 || F1 == 0 || F2 == 0) {
1321 // if (F0) { free(F0); F0 = 0; }
1322 // if (F1) { free(F1); F1 = 0; }
1323 // if (F2) { free(F2); F2 = 0; }
1324 // }
Victor Hernandezfcc77b12009-11-10 08:32:25 +00001325 // The malloc can also fail if its argument is too large.
Gabor Greif218f5542010-06-24 14:42:01 +00001326 Constant *ConstantZero = ConstantInt::get(CI->getArgOperand(0)->getType(), 0);
1327 Value *RunningOr = new ICmpInst(CI, ICmpInst::ICMP_SLT, CI->getArgOperand(0),
Victor Hernandezfcc77b12009-11-10 08:32:25 +00001328 ConstantZero, "isneg");
Victor Hernandez5d034492009-09-18 22:35:49 +00001329 for (unsigned i = 0, e = FieldMallocs.size(); i != e; ++i) {
Victor Hernandezf3db9152009-11-07 00:16:28 +00001330 Value *Cond = new ICmpInst(CI, ICmpInst::ICMP_EQ, FieldMallocs[i],
1331 Constant::getNullValue(FieldMallocs[i]->getType()),
1332 "isnull");
Victor Hernandezfcc77b12009-11-10 08:32:25 +00001333 RunningOr = BinaryOperator::CreateOr(RunningOr, Cond, "tmp", CI);
Victor Hernandez5d034492009-09-18 22:35:49 +00001334 }
1335
1336 // Split the basic block at the old malloc.
Victor Hernandezf3db9152009-11-07 00:16:28 +00001337 BasicBlock *OrigBB = CI->getParent();
1338 BasicBlock *ContBB = OrigBB->splitBasicBlock(CI, "malloc_cont");
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001339
Victor Hernandez5d034492009-09-18 22:35:49 +00001340 // Create the block to check the first condition. Put all these blocks at the
1341 // end of the function as they are unlikely to be executed.
Chris Lattner46b5c642009-11-06 04:27:31 +00001342 BasicBlock *NullPtrBlock = BasicBlock::Create(OrigBB->getContext(),
1343 "malloc_ret_null",
Victor Hernandez5d034492009-09-18 22:35:49 +00001344 OrigBB->getParent());
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001345
Victor Hernandez5d034492009-09-18 22:35:49 +00001346 // Remove the uncond branch from OrigBB to ContBB, turning it into a cond
1347 // branch on RunningOr.
1348 OrigBB->getTerminator()->eraseFromParent();
1349 BranchInst::Create(NullPtrBlock, ContBB, RunningOr, OrigBB);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001350
Victor Hernandez5d034492009-09-18 22:35:49 +00001351 // Within the NullPtrBlock, we need to emit a comparison and branch for each
1352 // pointer, because some may be null while others are not.
1353 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1354 Value *GVVal = new LoadInst(FieldGlobals[i], "tmp", NullPtrBlock);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001355 Value *Cmp = new ICmpInst(*NullPtrBlock, ICmpInst::ICMP_NE, GVVal,
Benjamin Kramer547b6c52011-09-27 20:39:19 +00001356 Constant::getNullValue(GVVal->getType()));
Chris Lattner46b5c642009-11-06 04:27:31 +00001357 BasicBlock *FreeBlock = BasicBlock::Create(Cmp->getContext(), "free_it",
Victor Hernandez5d034492009-09-18 22:35:49 +00001358 OrigBB->getParent());
Chris Lattner46b5c642009-11-06 04:27:31 +00001359 BasicBlock *NextBlock = BasicBlock::Create(Cmp->getContext(), "next",
Victor Hernandez5d034492009-09-18 22:35:49 +00001360 OrigBB->getParent());
Victor Hernandeze2971492009-10-24 04:23:03 +00001361 Instruction *BI = BranchInst::Create(FreeBlock, NextBlock,
1362 Cmp, NullPtrBlock);
Victor Hernandez5d034492009-09-18 22:35:49 +00001363
1364 // Fill in FreeBlock.
Victor Hernandeze2971492009-10-24 04:23:03 +00001365 CallInst::CreateFree(GVVal, BI);
Victor Hernandez5d034492009-09-18 22:35:49 +00001366 new StoreInst(Constant::getNullValue(GVVal->getType()), FieldGlobals[i],
1367 FreeBlock);
1368 BranchInst::Create(NextBlock, FreeBlock);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001369
Victor Hernandez5d034492009-09-18 22:35:49 +00001370 NullPtrBlock = NextBlock;
1371 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001372
Victor Hernandez5d034492009-09-18 22:35:49 +00001373 BranchInst::Create(ContBB, NullPtrBlock);
Victor Hernandezf3db9152009-11-07 00:16:28 +00001374
1375 // CI is no longer needed, remove it.
Victor Hernandez5d034492009-09-18 22:35:49 +00001376 CI->eraseFromParent();
1377
1378 /// InsertedScalarizedLoads - As we process loads, if we can't immediately
1379 /// update all uses of the load, keep track of what scalarized loads are
1380 /// inserted for a given load.
1381 DenseMap<Value*, std::vector<Value*> > InsertedScalarizedValues;
1382 InsertedScalarizedValues[GV] = FieldGlobals;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001383
Victor Hernandez5d034492009-09-18 22:35:49 +00001384 std::vector<std::pair<PHINode*, unsigned> > PHIsToRewrite;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001385
Victor Hernandez5d034492009-09-18 22:35:49 +00001386 // Okay, the malloc site is completely handled. All of the uses of GV are now
1387 // loads, and all uses of those loads are simple. Rewrite them to use loads
1388 // of the per-field globals instead.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001389 for (auto UI = GV->user_begin(), E = GV->user_end(); UI != E;) {
Victor Hernandez5d034492009-09-18 22:35:49 +00001390 Instruction *User = cast<Instruction>(*UI++);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001391
Victor Hernandez5d034492009-09-18 22:35:49 +00001392 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
Chris Lattner46b5c642009-11-06 04:27:31 +00001393 RewriteUsesOfLoadForHeapSRoA(LI, InsertedScalarizedValues, PHIsToRewrite);
Victor Hernandez5d034492009-09-18 22:35:49 +00001394 continue;
1395 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001396
Victor Hernandez5d034492009-09-18 22:35:49 +00001397 // Must be a store of null.
1398 StoreInst *SI = cast<StoreInst>(User);
1399 assert(isa<ConstantPointerNull>(SI->getOperand(0)) &&
1400 "Unexpected heap-sra user!");
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001401
Victor Hernandez5d034492009-09-18 22:35:49 +00001402 // Insert a store of null into each global.
1403 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
Chris Lattner229907c2011-07-18 04:54:35 +00001404 PointerType *PT = cast<PointerType>(FieldGlobals[i]->getType());
Victor Hernandez5d034492009-09-18 22:35:49 +00001405 Constant *Null = Constant::getNullValue(PT->getElementType());
1406 new StoreInst(Null, FieldGlobals[i], SI);
1407 }
1408 // Erase the original store.
1409 SI->eraseFromParent();
1410 }
1411
1412 // While we have PHIs that are interesting to rewrite, do it.
1413 while (!PHIsToRewrite.empty()) {
1414 PHINode *PN = PHIsToRewrite.back().first;
1415 unsigned FieldNo = PHIsToRewrite.back().second;
1416 PHIsToRewrite.pop_back();
1417 PHINode *FieldPN = cast<PHINode>(InsertedScalarizedValues[PN][FieldNo]);
1418 assert(FieldPN->getNumIncomingValues() == 0 &&"Already processed this phi");
1419
1420 // Add all the incoming values. This can materialize more phis.
1421 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1422 Value *InVal = PN->getIncomingValue(i);
1423 InVal = GetHeapSROAValue(InVal, FieldNo, InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001424 PHIsToRewrite);
Victor Hernandez5d034492009-09-18 22:35:49 +00001425 FieldPN->addIncoming(InVal, PN->getIncomingBlock(i));
1426 }
1427 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001428
Victor Hernandez5d034492009-09-18 22:35:49 +00001429 // Drop all inter-phi links and any loads that made it this far.
1430 for (DenseMap<Value*, std::vector<Value*> >::iterator
1431 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1432 I != E; ++I) {
1433 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1434 PN->dropAllReferences();
1435 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1436 LI->dropAllReferences();
1437 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001438
Victor Hernandez5d034492009-09-18 22:35:49 +00001439 // Delete all the phis and loads now that inter-references are dead.
1440 for (DenseMap<Value*, std::vector<Value*> >::iterator
1441 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1442 I != E; ++I) {
1443 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1444 PN->eraseFromParent();
1445 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1446 LI->eraseFromParent();
1447 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001448
Victor Hernandez5d034492009-09-18 22:35:49 +00001449 // The old global is now dead, remove it.
1450 GV->eraseFromParent();
1451
1452 ++NumHeapSRA;
1453 return cast<GlobalVariable>(FieldGlobals[0]);
1454}
1455
Chris Lattnerc4274a72008-12-15 21:02:25 +00001456/// TryToOptimizeStoreOfMallocToGlobal - This function is called when we see a
1457/// pointer global variable with a single value stored it that is a malloc or
1458/// cast of malloc.
Mehdi Amini46a43552015-03-04 18:43:29 +00001459static bool TryToOptimizeStoreOfMallocToGlobal(GlobalVariable *GV, CallInst *CI,
Chris Lattner229907c2011-07-18 04:54:35 +00001460 Type *AllocTy,
Nick Lewycky52da72b2012-02-05 19:56:38 +00001461 AtomicOrdering Ordering,
Victor Hernandez5d034492009-09-18 22:35:49 +00001462 Module::global_iterator &GVI,
Mehdi Amini46a43552015-03-04 18:43:29 +00001463 const DataLayout &DL,
Nick Lewyckycf6aae62012-02-12 01:13:18 +00001464 TargetLibraryInfo *TLI) {
Victor Hernandez5d034492009-09-18 22:35:49 +00001465 // If this is a malloc of an abstract type, don't touch it.
1466 if (!AllocTy->isSized())
1467 return false;
1468
1469 // We can't optimize this global unless all uses of it are *known* to be
1470 // of the malloc value, not of the null initializer value (consider a use
1471 // that compares the global's value against zero to see if the malloc has
1472 // been reached). To do this, we check to see if all uses of the global
1473 // would trap if the global were null: this proves that they must all
1474 // happen after the malloc.
1475 if (!AllUsesOfLoadedValueWillTrapIfNull(GV))
1476 return false;
1477
1478 // We can't optimize this if the malloc itself is used in a complex way,
1479 // for example, being stored into multiple globals. This allows the
Nick Lewyckybbd11562012-02-05 19:48:37 +00001480 // malloc to be stored into the specified global, loaded icmp'd, and
Victor Hernandez5d034492009-09-18 22:35:49 +00001481 // GEP'd. These are all things we could transform to using the global
1482 // for.
Evan Cheng21b588b2010-04-14 20:52:55 +00001483 SmallPtrSet<const PHINode*, 8> PHIs;
1484 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(CI, GV, PHIs))
1485 return false;
Victor Hernandez5d034492009-09-18 22:35:49 +00001486
1487 // If we have a global that is only initialized with a fixed size malloc,
1488 // transform the program to use global memory instead of malloc'd memory.
1489 // This eliminates dynamic allocation, avoids an indirection accessing the
1490 // data, and exposes the resultant global to further GlobalOpt.
Victor Hernandez264da322009-10-16 23:12:25 +00001491 // We cannot optimize the malloc if we cannot determine malloc array size.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001492 Value *NElems = getMallocArraySize(CI, DL, TLI, true);
Evan Cheng21b588b2010-04-14 20:52:55 +00001493 if (!NElems)
1494 return false;
Victor Hernandez5d034492009-09-18 22:35:49 +00001495
Evan Cheng21b588b2010-04-14 20:52:55 +00001496 if (ConstantInt *NElements = dyn_cast<ConstantInt>(NElems))
1497 // Restrict this transformation to only working on small allocations
1498 // (2048 bytes currently), as we don't want to introduce a 16M global or
1499 // something.
Mehdi Amini46a43552015-03-04 18:43:29 +00001500 if (NElements->getZExtValue() * DL.getTypeAllocSize(AllocTy) < 2048) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001501 GVI = OptimizeGlobalAddressOfMalloc(GV, CI, AllocTy, NElements, DL, TLI);
Evan Cheng21b588b2010-04-14 20:52:55 +00001502 return true;
Victor Hernandez5d034492009-09-18 22:35:49 +00001503 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001504
Evan Cheng21b588b2010-04-14 20:52:55 +00001505 // If the allocation is an array of structures, consider transforming this
1506 // into multiple malloc'd arrays, one for each field. This is basically
1507 // SRoA for malloc'd memory.
1508
Nick Lewycky52da72b2012-02-05 19:56:38 +00001509 if (Ordering != NotAtomic)
1510 return false;
1511
Evan Cheng21b588b2010-04-14 20:52:55 +00001512 // If this is an allocation of a fixed size array of structs, analyze as a
1513 // variable size array. malloc [100 x struct],1 -> malloc struct, 100
Gabor Greif218f5542010-06-24 14:42:01 +00001514 if (NElems == ConstantInt::get(CI->getArgOperand(0)->getType(), 1))
Chris Lattner229907c2011-07-18 04:54:35 +00001515 if (ArrayType *AT = dyn_cast<ArrayType>(AllocTy))
Evan Cheng21b588b2010-04-14 20:52:55 +00001516 AllocTy = AT->getElementType();
Gabor Greif218f5542010-06-24 14:42:01 +00001517
Chris Lattner229907c2011-07-18 04:54:35 +00001518 StructType *AllocSTy = dyn_cast<StructType>(AllocTy);
Evan Cheng21b588b2010-04-14 20:52:55 +00001519 if (!AllocSTy)
1520 return false;
1521
1522 // This the structure has an unreasonable number of fields, leave it
1523 // alone.
1524 if (AllocSTy->getNumElements() <= 16 && AllocSTy->getNumElements() != 0 &&
1525 AllGlobalLoadUsesSimpleEnoughForHeapSRA(GV, CI)) {
1526
1527 // If this is a fixed size array, transform the Malloc to be an alloc of
1528 // structs. malloc [100 x struct],1 -> malloc struct, 100
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001529 if (ArrayType *AT = dyn_cast<ArrayType>(getMallocAllocatedType(CI, TLI))) {
Mehdi Amini46a43552015-03-04 18:43:29 +00001530 Type *IntPtrTy = DL.getIntPtrType(CI->getType());
1531 unsigned TypeSize = DL.getStructLayout(AllocSTy)->getSizeInBytes();
Evan Cheng21b588b2010-04-14 20:52:55 +00001532 Value *AllocSize = ConstantInt::get(IntPtrTy, TypeSize);
1533 Value *NumElements = ConstantInt::get(IntPtrTy, AT->getNumElements());
1534 Instruction *Malloc = CallInst::CreateMalloc(CI, IntPtrTy, AllocSTy,
1535 AllocSize, NumElements,
Craig Topperf40110f2014-04-25 05:29:35 +00001536 nullptr, CI->getName());
Evan Cheng21b588b2010-04-14 20:52:55 +00001537 Instruction *Cast = new BitCastInst(Malloc, CI->getType(), "tmp", CI);
1538 CI->replaceAllUsesWith(Cast);
1539 CI->eraseFromParent();
Nuno Lopes9792d682012-06-22 00:25:01 +00001540 if (BitCastInst *BCI = dyn_cast<BitCastInst>(Malloc))
1541 CI = cast<CallInst>(BCI->getOperand(0));
1542 else
Nuno Lopes0b60ebb2012-06-22 00:29:58 +00001543 CI = cast<CallInst>(Malloc);
Evan Cheng21b588b2010-04-14 20:52:55 +00001544 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001545
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001546 GVI = PerformHeapAllocSRoA(GV, CI, getMallocArraySize(CI, DL, TLI, true),
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001547 DL, TLI);
Evan Cheng21b588b2010-04-14 20:52:55 +00001548 return true;
Victor Hernandez5d034492009-09-18 22:35:49 +00001549 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001550
Victor Hernandez5d034492009-09-18 22:35:49 +00001551 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001552}
Victor Hernandez5d034492009-09-18 22:35:49 +00001553
Chris Lattner09a52722004-10-09 21:48:45 +00001554// OptimizeOnceStoredGlobal - Try to optimize globals based on the knowledge
1555// that only one value (besides its initializer) is ever stored to the global.
Chris Lattner004e2502004-10-11 05:54:41 +00001556static bool OptimizeOnceStoredGlobal(GlobalVariable *GV, Value *StoredOnceVal,
Nick Lewycky52da72b2012-02-05 19:56:38 +00001557 AtomicOrdering Ordering,
Chris Lattnerc2d3d312006-08-27 22:42:52 +00001558 Module::global_iterator &GVI,
Mehdi Amini46a43552015-03-04 18:43:29 +00001559 const DataLayout &DL,
Rafael Espindolaaeff8a92014-02-24 23:12:18 +00001560 TargetLibraryInfo *TLI) {
Chris Lattner1c731fa2008-12-15 21:20:32 +00001561 // Ignore no-op GEPs and bitcasts.
1562 StoredOnceVal = StoredOnceVal->stripPointerCasts();
Chris Lattner09a52722004-10-09 21:48:45 +00001563
Chris Lattnere42eb312004-10-10 23:14:11 +00001564 // If we are dealing with a pointer global that is initialized to null and
1565 // only has one (non-null) value stored into it, then we can optimize any
1566 // users of the loaded value (often calls and loads) that would trap if the
1567 // value was null.
Duncan Sands19d0b472010-02-16 11:11:14 +00001568 if (GV->getInitializer()->getType()->isPointerTy() &&
Chris Lattner09a52722004-10-09 21:48:45 +00001569 GV->getInitializer()->isNullValue()) {
Chris Lattnere42eb312004-10-10 23:14:11 +00001570 if (Constant *SOVC = dyn_cast<Constant>(StoredOnceVal)) {
1571 if (GV->getInitializer()->getType() != SOVC->getType())
Chris Lattner1a1acc22011-05-22 07:15:13 +00001572 SOVC = ConstantExpr::getBitCast(SOVC, GV->getInitializer()->getType());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001573
Chris Lattnere42eb312004-10-10 23:14:11 +00001574 // Optimize away any trapping uses of the loaded value.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001575 if (OptimizeAwayTrappingUsesOfLoads(GV, SOVC, DL, TLI))
Chris Lattner604ed7a2004-10-10 17:07:12 +00001576 return true;
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001577 } else if (CallInst *CI = extractMallocCall(StoredOnceVal, TLI)) {
1578 Type *MallocType = getMallocAllocatedType(CI, TLI);
Nick Lewyckycf6aae62012-02-12 01:13:18 +00001579 if (MallocType &&
1580 TryToOptimizeStoreOfMallocToGlobal(GV, CI, MallocType, Ordering, GVI,
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001581 DL, TLI))
Victor Hernandezf3db9152009-11-07 00:16:28 +00001582 return true;
Chris Lattnere42eb312004-10-10 23:14:11 +00001583 }
Chris Lattner09a52722004-10-09 21:48:45 +00001584 }
Chris Lattner004e2502004-10-11 05:54:41 +00001585
Chris Lattner09a52722004-10-09 21:48:45 +00001586 return false;
1587}
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001588
Lang Hames459b5dc2014-03-23 04:22:31 +00001589/// TryToShrinkGlobalToBoolean - At this point, we have learned that the only
Chris Lattner20bbac32008-01-14 01:17:44 +00001590/// two values ever stored into GV are its initializer and OtherVal. See if we
Lang Hames459b5dc2014-03-23 04:22:31 +00001591/// can shrink the global into a boolean and select between the two values
1592/// whenever it is used. This exposes the values to other scalar optimizations.
1593static bool TryToShrinkGlobalToBoolean(GlobalVariable *GV, Constant *OtherVal) {
Chris Lattner229907c2011-07-18 04:54:35 +00001594 Type *GVElType = GV->getType()->getElementType();
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001595
Lang Hames459b5dc2014-03-23 04:22:31 +00001596 // If GVElType is already i1, it is already shrunk. If the type of the GV is
1597 // an FP value, pointer or vector, don't do this optimization because a select
1598 // between them is very expensive and unlikely to lead to later
1599 // simplification. In these cases, we typically end up with "cond ? v1 : v2"
1600 // where v1 and v2 both require constant pool loads, a big loss.
Chris Lattner46b5c642009-11-06 04:27:31 +00001601 if (GVElType == Type::getInt1Ty(GV->getContext()) ||
Duncan Sands9dff9be2010-02-15 16:12:20 +00001602 GVElType->isFloatingPointTy() ||
Duncan Sands19d0b472010-02-16 11:11:14 +00001603 GVElType->isPointerTy() || GVElType->isVectorTy())
Chris Lattner20bbac32008-01-14 01:17:44 +00001604 return false;
Gabor Greifa75ed762010-07-12 14:13:15 +00001605
Chris Lattner20bbac32008-01-14 01:17:44 +00001606 // Walk the use list of the global seeing if all the uses are load or store.
1607 // If there is anything else, bail out.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001608 for (User *U : GV->users())
Gabor Greifa75ed762010-07-12 14:13:15 +00001609 if (!isa<LoadInst>(U) && !isa<StoreInst>(U))
Chris Lattner20bbac32008-01-14 01:17:44 +00001610 return false;
Gabor Greifa75ed762010-07-12 14:13:15 +00001611
Lang Hames459b5dc2014-03-23 04:22:31 +00001612 DEBUG(dbgs() << " *** SHRINKING TO BOOL: " << *GV);
1613
1614 // Create the new global, initializing it to false.
1615 GlobalVariable *NewGV = new GlobalVariable(Type::getInt1Ty(GV->getContext()),
1616 false,
1617 GlobalValue::InternalLinkage,
1618 ConstantInt::getFalse(GV->getContext()),
1619 GV->getName()+".b",
1620 GV->getThreadLocalMode(),
1621 GV->getType()->getAddressSpace());
1622 GV->getParent()->getGlobalList().insert(GV, NewGV);
1623
Chris Lattner40e4cec2004-12-12 05:53:50 +00001624 Constant *InitVal = GV->getInitializer();
Chris Lattner46b5c642009-11-06 04:27:31 +00001625 assert(InitVal->getType() != Type::getInt1Ty(GV->getContext()) &&
Lang Hames459b5dc2014-03-23 04:22:31 +00001626 "No reason to shrink to bool!");
Chris Lattner40e4cec2004-12-12 05:53:50 +00001627
Lang Hames459b5dc2014-03-23 04:22:31 +00001628 // If initialized to zero and storing one into the global, we can use a cast
1629 // instead of a select to synthesize the desired value.
1630 bool IsOneZero = false;
1631 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal))
1632 IsOneZero = InitVal->isNullValue() && CI->isOne();
Chris Lattner40e4cec2004-12-12 05:53:50 +00001633
Lang Hames459b5dc2014-03-23 04:22:31 +00001634 while (!GV->use_empty()) {
1635 Instruction *UI = cast<Instruction>(GV->user_back());
1636 if (StoreInst *SI = dyn_cast<StoreInst>(UI)) {
1637 // Change the store into a boolean store.
1638 bool StoringOther = SI->getOperand(0) == OtherVal;
1639 // Only do this if we weren't storing a loaded value.
1640 Value *StoreVal;
1641 if (StoringOther || SI->getOperand(0) == InitVal) {
1642 StoreVal = ConstantInt::get(Type::getInt1Ty(GV->getContext()),
1643 StoringOther);
Bill Wendling7297b862013-02-13 23:00:51 +00001644 } else {
Lang Hames459b5dc2014-03-23 04:22:31 +00001645 // Otherwise, we are storing a previously loaded copy. To do this,
1646 // change the copy from copying the original value to just copying the
1647 // bool.
1648 Instruction *StoredVal = cast<Instruction>(SI->getOperand(0));
1649
1650 // If we've already replaced the input, StoredVal will be a cast or
1651 // select instruction. If not, it will be a load of the original
1652 // global.
1653 if (LoadInst *LI = dyn_cast<LoadInst>(StoredVal)) {
1654 assert(LI->getOperand(0) == GV && "Not a copy!");
1655 // Insert a new load, to preserve the saved value.
1656 StoreVal = new LoadInst(NewGV, LI->getName()+".b", false, 0,
1657 LI->getOrdering(), LI->getSynchScope(), LI);
1658 } else {
1659 assert((isa<CastInst>(StoredVal) || isa<SelectInst>(StoredVal)) &&
1660 "This is not a form that we understand!");
1661 StoreVal = StoredVal->getOperand(0);
1662 assert(isa<LoadInst>(StoreVal) && "Not a load of NewGV!");
1663 }
Chris Lattner745196a2004-12-12 19:34:41 +00001664 }
Lang Hames459b5dc2014-03-23 04:22:31 +00001665 new StoreInst(StoreVal, NewGV, false, 0,
1666 SI->getOrdering(), SI->getSynchScope(), SI);
1667 } else {
1668 // Change the load into a load of bool then a select.
1669 LoadInst *LI = cast<LoadInst>(UI);
1670 LoadInst *NLI = new LoadInst(NewGV, LI->getName()+".b", false, 0,
1671 LI->getOrdering(), LI->getSynchScope(), LI);
1672 Value *NSI;
1673 if (IsOneZero)
1674 NSI = new ZExtInst(NLI, LI->getType(), "", LI);
1675 else
1676 NSI = SelectInst::Create(NLI, OtherVal, InitVal, "", LI);
1677 NSI->takeName(LI);
1678 LI->replaceAllUsesWith(NSI);
Devang Patelfc507a12009-03-06 01:39:36 +00001679 }
Lang Hames459b5dc2014-03-23 04:22:31 +00001680 UI->eraseFromParent();
Chris Lattner40e4cec2004-12-12 05:53:50 +00001681 }
1682
Lang Hames459b5dc2014-03-23 04:22:31 +00001683 // Retain the name of the old global variable. People who are debugging their
1684 // programs may expect these variables to be named the same.
1685 NewGV->takeName(GV);
1686 GV->eraseFromParent();
Chris Lattner20bbac32008-01-14 01:17:44 +00001687 return true;
Chris Lattner40e4cec2004-12-12 05:53:50 +00001688}
1689
1690
Nick Lewycky1480f1d2012-02-12 00:52:26 +00001691/// ProcessGlobal - Analyze the specified global variable and optimize it if
1692/// possible. If we make a change, return true.
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001693bool GlobalOpt::ProcessGlobal(GlobalVariable *GV,
1694 Module::global_iterator &GVI) {
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001695 // Do more involved optimizations if the global is internal.
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001696 GV->removeDeadConstantUsers();
1697
1698 if (GV->use_empty()) {
David Greene44cb8ad2010-01-05 01:28:05 +00001699 DEBUG(dbgs() << "GLOBAL DEAD: " << *GV);
Chris Lattner8e71c6a2004-10-16 18:09:00 +00001700 GV->eraseFromParent();
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001701 ++NumDeleted;
1702 return true;
1703 }
1704
Rafael Espindola1821c6c2012-06-15 18:00:24 +00001705 if (!GV->hasLocalLinkage())
1706 return false;
1707
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001708 GlobalStatus GS;
1709
Rafael Espindola3d7fc252013-10-21 17:14:55 +00001710 if (GlobalStatus::analyzeGlobal(GV, GS))
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001711 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001712
Rafael Espindola045a78f2013-10-17 18:18:52 +00001713 if (!GS.IsCompared && !GV->hasUnnamedAddr()) {
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001714 GV->setUnnamedAddr(true);
1715 NumUnnamed++;
1716 }
1717
1718 if (GV->isConstant() || !GV->hasInitializer())
1719 return false;
1720
Rafael Espindolad21ac192013-09-05 19:15:21 +00001721 return ProcessInternalGlobal(GV, GVI, GS);
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001722}
1723
1724/// ProcessInternalGlobal - Analyze the specified global variable and optimize
1725/// it if possible. If we make a change, return true.
1726bool GlobalOpt::ProcessInternalGlobal(GlobalVariable *GV,
1727 Module::global_iterator &GVI,
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001728 const GlobalStatus &GS) {
Mehdi Amini46a43552015-03-04 18:43:29 +00001729 auto &DL = GV->getParent()->getDataLayout();
Alexey Samsonova1944e62013-10-07 19:03:24 +00001730 // If this is a first class global and has only one accessing function
1731 // and this function is main (which we know is not recursive), we replace
1732 // the global with a local alloca in this function.
1733 //
Alp Tokerf907b892013-12-05 05:44:44 +00001734 // NOTE: It doesn't make sense to promote non-single-value types since we
Alexey Samsonova1944e62013-10-07 19:03:24 +00001735 // are just replacing static memory to stack memory.
1736 //
1737 // If the global is in different address space, don't bring it to stack.
1738 if (!GS.HasMultipleAccessingFunctions &&
1739 GS.AccessingFunction && !GS.HasNonInstructionUser &&
1740 GV->getType()->getElementType()->isSingleValueType() &&
1741 GS.AccessingFunction->getName() == "main" &&
1742 GS.AccessingFunction->hasExternalLinkage() &&
1743 GV->getType()->getAddressSpace() == 0) {
1744 DEBUG(dbgs() << "LOCALIZING GLOBAL: " << *GV);
1745 Instruction &FirstI = const_cast<Instruction&>(*GS.AccessingFunction
1746 ->getEntryBlock().begin());
1747 Type *ElemTy = GV->getType()->getElementType();
1748 // FIXME: Pass Global's alignment when globals have alignment
Craig Topperf40110f2014-04-25 05:29:35 +00001749 AllocaInst *Alloca = new AllocaInst(ElemTy, nullptr,
1750 GV->getName(), &FirstI);
Alexey Samsonova1944e62013-10-07 19:03:24 +00001751 if (!isa<UndefValue>(GV->getInitializer()))
1752 new StoreInst(GV->getInitializer(), Alloca, &FirstI);
1753
1754 GV->replaceAllUsesWith(Alloca);
1755 GV->eraseFromParent();
1756 ++NumLocalized;
1757 return true;
1758 }
1759
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001760 // If the global is never loaded (but may be stored to), it is dead.
1761 // Delete it now.
Rafael Espindola045a78f2013-10-17 18:18:52 +00001762 if (!GS.IsLoaded) {
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001763 DEBUG(dbgs() << "GLOBAL NEVER LOADED: " << *GV);
1764
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +00001765 bool Changed;
1766 if (isLeakCheckerRoot(GV)) {
1767 // Delete any constant stores to the global.
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001768 Changed = CleanupPointerRootUsers(GV, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +00001769 } else {
1770 // Delete any stores we can find to the global. We may not be able to
1771 // make it completely dead though.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001772 Changed = CleanupConstantGlobalUsers(GV, GV->getInitializer(), DL, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +00001773 }
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001774
1775 // If the global is dead now, delete it.
1776 if (GV->use_empty()) {
1777 GV->eraseFromParent();
1778 ++NumDeleted;
1779 Changed = true;
1780 }
1781 return Changed;
1782
Rafael Espindola045a78f2013-10-17 18:18:52 +00001783 } else if (GS.StoredType <= GlobalStatus::InitializerStored) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00001784 DEBUG(dbgs() << "MARKING CONSTANT: " << *GV << "\n");
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001785 GV->setConstant(true);
1786
1787 // Clean up any obviously simplifiable users now.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001788 CleanupConstantGlobalUsers(GV, GV->getInitializer(), DL, TLI);
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001789
1790 // If the global is dead now, just nuke it.
1791 if (GV->use_empty()) {
1792 DEBUG(dbgs() << " *** Marking constant allowed us to simplify "
1793 << "all users and delete global!\n");
1794 GV->eraseFromParent();
1795 ++NumDeleted;
1796 }
1797
1798 ++NumMarked;
1799 return true;
1800 } else if (!GV->getInitializer()->getType()->isSingleValueType()) {
Mehdi Amini46a43552015-03-04 18:43:29 +00001801 const DataLayout &DL = GV->getParent()->getDataLayout();
1802 if (GlobalVariable *FirstNewGV = SRAGlobal(GV, DL)) {
1803 GVI = FirstNewGV; // Don't skip the newly produced globals!
1804 return true;
Rafael Espindola93512512014-02-25 17:30:31 +00001805 }
Rafael Espindola045a78f2013-10-17 18:18:52 +00001806 } else if (GS.StoredType == GlobalStatus::StoredOnce) {
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001807 // If the initial value for the global was an undef value, and if only
1808 // one other value was stored into it, we can just change the
1809 // initializer to be the stored value, then delete all stores to the
1810 // global. This allows us to mark it constant.
1811 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1812 if (isa<UndefValue>(GV->getInitializer())) {
1813 // Change the initial value here.
1814 GV->setInitializer(SOVConstant);
1815
1816 // Clean up any obviously simplifiable users now.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001817 CleanupConstantGlobalUsers(GV, GV->getInitializer(), DL, TLI);
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001818
1819 if (GV->use_empty()) {
1820 DEBUG(dbgs() << " *** Substituting initializer allowed us to "
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +00001821 << "simplify all users and delete global!\n");
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001822 GV->eraseFromParent();
1823 ++NumDeleted;
1824 } else {
1825 GVI = GV;
1826 }
1827 ++NumSubstitute;
1828 return true;
1829 }
1830
1831 // Try to optimize globals based on the knowledge that only one value
1832 // (besides its initializer) is ever stored to the global.
Nick Lewycky52da72b2012-02-05 19:56:38 +00001833 if (OptimizeOnceStoredGlobal(GV, GS.StoredOnceValue, GS.Ordering, GVI,
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001834 DL, TLI))
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001835 return true;
1836
Lang Hames459b5dc2014-03-23 04:22:31 +00001837 // Otherwise, if the global was not a boolean, we can shrink it to be a
1838 // boolean.
Eli Friedman33d37002013-09-09 22:00:13 +00001839 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue)) {
1840 if (GS.Ordering == NotAtomic) {
Lang Hames459b5dc2014-03-23 04:22:31 +00001841 if (TryToShrinkGlobalToBoolean(GV, SOVConstant)) {
Eli Friedman33d37002013-09-09 22:00:13 +00001842 ++NumShrunkToBool;
1843 return true;
1844 }
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001845 }
Eli Friedman33d37002013-09-09 22:00:13 +00001846 }
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001847 }
1848
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001849 return false;
1850}
1851
Chris Lattnera4c80222005-05-08 22:18:06 +00001852/// ChangeCalleesToFastCall - Walk all of the direct calls of the specified
1853/// function, changing them to FastCC.
1854static void ChangeCalleesToFastCall(Function *F) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001855 for (User *U : F->users()) {
1856 if (isa<BlockAddress>(U))
Jay Foadca0c4992012-05-12 08:30:16 +00001857 continue;
Chandler Carruthcdf47882014-03-09 03:16:01 +00001858 CallSite CS(cast<Instruction>(U));
1859 CS.setCallingConv(CallingConv::Fast);
Chris Lattnera4c80222005-05-08 22:18:06 +00001860 }
1861}
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001862
Bill Wendlinge94d8432012-12-07 23:16:57 +00001863static AttributeSet StripNest(LLVMContext &C, const AttributeSet &Attrs) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001864 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendling57625a42013-01-25 23:09:36 +00001865 unsigned Index = Attrs.getSlotIndex(i);
1866 if (!Attrs.getSlotAttributes(i).hasAttribute(Index, Attribute::Nest))
Duncan Sands85fab3a2008-02-18 17:32:13 +00001867 continue;
1868
Duncan Sands85fab3a2008-02-18 17:32:13 +00001869 // There can be only one.
Bill Wendling57625a42013-01-25 23:09:36 +00001870 return Attrs.removeAttribute(C, Index, Attribute::Nest);
Duncan Sands573b3f82008-02-16 20:56:04 +00001871 }
1872
1873 return Attrs;
1874}
1875
1876static void RemoveNestAttribute(Function *F) {
Bill Wendling85a64c22012-10-14 06:39:53 +00001877 F->setAttributes(StripNest(F->getContext(), F->getAttributes()));
Chandler Carruthcdf47882014-03-09 03:16:01 +00001878 for (User *U : F->users()) {
1879 if (isa<BlockAddress>(U))
Jay Foadca0c4992012-05-12 08:30:16 +00001880 continue;
Chandler Carruthcdf47882014-03-09 03:16:01 +00001881 CallSite CS(cast<Instruction>(U));
1882 CS.setAttributes(StripNest(F->getContext(), CS.getAttributes()));
Duncan Sands573b3f82008-02-16 20:56:04 +00001883 }
1884}
1885
Reid Kleckner22869372014-02-26 19:57:30 +00001886/// Return true if this is a calling convention that we'd like to change. The
1887/// idea here is that we don't want to mess with the convention if the user
1888/// explicitly requested something with performance implications like coldcc,
1889/// GHC, or anyregcc.
1890static bool isProfitableToMakeFastCC(Function *F) {
1891 CallingConv::ID CC = F->getCallingConv();
1892 // FIXME: Is it worth transforming x86_stdcallcc and x86_fastcallcc?
1893 return CC == CallingConv::C || CC == CallingConv::X86_ThisCall;
1894}
1895
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001896bool GlobalOpt::OptimizeFunctions(Module &M) {
1897 bool Changed = false;
1898 // Optimize functions.
1899 for (Module::iterator FI = M.begin(), E = M.end(); FI != E; ) {
1900 Function *F = FI++;
Duncan Sandsed722832009-03-06 10:21:56 +00001901 // Functions without names cannot be referenced outside this module.
David Majnemer5c921152014-07-01 15:26:50 +00001902 if (!F->hasName() && !F->isDeclaration() && !F->hasLocalLinkage())
Duncan Sandsed722832009-03-06 10:21:56 +00001903 F->setLinkage(GlobalValue::InternalLinkage);
David Majnemer1b3b70e2014-10-08 07:23:31 +00001904
1905 const Comdat *C = F->getComdat();
1906 bool inComdat = C && NotDiscardableComdats.count(C);
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001907 F->removeDeadConstantUsers();
David Majnemer1b3b70e2014-10-08 07:23:31 +00001908 if ((!inComdat || F->hasLocalLinkage()) && F->isDefTriviallyDead()) {
Chris Lattnerb5d9c8c2009-11-01 19:03:42 +00001909 F->eraseFromParent();
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001910 Changed = true;
1911 ++NumFnDeleted;
Rafael Espindola6de96a12009-01-15 20:18:42 +00001912 } else if (F->hasLocalLinkage()) {
Reid Klecknere6ff5c52014-02-28 22:50:08 +00001913 if (isProfitableToMakeFastCC(F) && !F->isVarArg() &&
1914 !F->hasAddressTaken()) {
Reid Kleckner22869372014-02-26 19:57:30 +00001915 // If this function has a calling convention worth changing, is not a
1916 // varargs function, and is only called directly, promote it to use the
1917 // Fast calling convention.
Duncan Sands573b3f82008-02-16 20:56:04 +00001918 F->setCallingConv(CallingConv::Fast);
1919 ChangeCalleesToFastCall(F);
1920 ++NumFastCallFns;
1921 Changed = true;
1922 }
1923
Bill Wendling3d7b0b82012-12-19 07:18:57 +00001924 if (F->getAttributes().hasAttrSomewhere(Attribute::Nest) &&
Jay Foad557169d2009-06-10 08:41:11 +00001925 !F->hasAddressTaken()) {
Duncan Sands573b3f82008-02-16 20:56:04 +00001926 // The function is not used by a trampoline intrinsic, so it is safe
1927 // to remove the 'nest' attribute.
1928 RemoveNestAttribute(F);
1929 ++NumNestRemoved;
1930 Changed = true;
1931 }
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001932 }
1933 }
1934 return Changed;
1935}
1936
1937bool GlobalOpt::OptimizeGlobalVars(Module &M) {
1938 bool Changed = false;
David Majnemerdad0a642014-06-27 18:19:56 +00001939
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001940 for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
1941 GVI != E; ) {
1942 GlobalVariable *GV = GVI++;
Duncan Sandsed722832009-03-06 10:21:56 +00001943 // Global variables without names cannot be referenced outside this module.
David Majnemer5c921152014-07-01 15:26:50 +00001944 if (!GV->hasName() && !GV->isDeclaration() && !GV->hasLocalLinkage())
Duncan Sandsed722832009-03-06 10:21:56 +00001945 GV->setLinkage(GlobalValue::InternalLinkage);
Dan Gohman580b80d2009-11-23 16:22:21 +00001946 // Simplify the initializer.
1947 if (GV->hasInitializer())
1948 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GV->getInitializer())) {
Mehdi Amini46a43552015-03-04 18:43:29 +00001949 auto &DL = M.getDataLayout();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001950 Constant *New = ConstantFoldConstantExpression(CE, DL, TLI);
Dan Gohman580b80d2009-11-23 16:22:21 +00001951 if (New && New != CE)
1952 GV->setInitializer(New);
1953 }
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001954
David Majnemerdad0a642014-06-27 18:19:56 +00001955 if (GV->isDiscardableIfUnused()) {
1956 if (const Comdat *C = GV->getComdat())
David Majnemer1b3b70e2014-10-08 07:23:31 +00001957 if (NotDiscardableComdats.count(C) && !GV->hasLocalLinkage())
David Majnemerdad0a642014-06-27 18:19:56 +00001958 continue;
1959 Changed |= ProcessGlobal(GV, GVI);
1960 }
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001961 }
1962 return Changed;
1963}
1964
Jakub Staszak9525a772012-12-06 21:57:16 +00001965static inline bool
Chris Lattner0d71c4f2010-12-07 04:33:29 +00001966isSimpleEnoughValueToCommit(Constant *C,
Mehdi Amini46a43552015-03-04 18:43:29 +00001967 SmallPtrSetImpl<Constant *> &SimpleConstants,
1968 const DataLayout &DL);
Chris Lattner0d71c4f2010-12-07 04:33:29 +00001969
1970/// isSimpleEnoughValueToCommit - Return true if the specified constant can be
1971/// handled by the code generator. We don't want to generate something like:
1972/// void *X = &X/42;
1973/// because the code generator doesn't have a relocation that can handle that.
1974///
1975/// This function should be called if C was not found (but just got inserted)
1976/// in SimpleConstants to avoid having to rescan the same constants all the
1977/// time.
Mehdi Amini46a43552015-03-04 18:43:29 +00001978static bool
1979isSimpleEnoughValueToCommitHelper(Constant *C,
1980 SmallPtrSetImpl<Constant *> &SimpleConstants,
1981 const DataLayout &DL) {
David Majnemer6098b2f2014-06-26 03:02:19 +00001982 // Simple global addresses are supported, do not allow dllimport or
1983 // thread-local globals.
David Majnemer23fc9af2014-06-24 06:53:45 +00001984 if (auto *GV = dyn_cast<GlobalValue>(C))
David Majnemer6098b2f2014-06-26 03:02:19 +00001985 return !GV->hasDLLImportStorageClass() && !GV->isThreadLocal();
David Majnemer23fc9af2014-06-24 06:53:45 +00001986
1987 // Simple integer, undef, constant aggregate zero, etc are all supported.
1988 if (C->getNumOperands() == 0 || isa<BlockAddress>(C))
Chris Lattner0d71c4f2010-12-07 04:33:29 +00001989 return true;
Jakub Staszak9525a772012-12-06 21:57:16 +00001990
Chris Lattner0d71c4f2010-12-07 04:33:29 +00001991 // Aggregate values are safe if all their elements are.
1992 if (isa<ConstantArray>(C) || isa<ConstantStruct>(C) ||
1993 isa<ConstantVector>(C)) {
1994 for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i) {
1995 Constant *Op = cast<Constant>(C->getOperand(i));
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001996 if (!isSimpleEnoughValueToCommit(Op, SimpleConstants, DL))
Chris Lattner0d71c4f2010-12-07 04:33:29 +00001997 return false;
1998 }
1999 return true;
2000 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002001
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002002 // We don't know exactly what relocations are allowed in constant expressions,
2003 // so we allow &global+constantoffset, which is safe and uniformly supported
2004 // across targets.
2005 ConstantExpr *CE = cast<ConstantExpr>(C);
2006 switch (CE->getOpcode()) {
2007 case Instruction::BitCast:
Eli Friedman55fa49f32012-01-05 23:03:32 +00002008 // Bitcast is fine if the casted value is fine.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002009 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, DL);
Eli Friedman55fa49f32012-01-05 23:03:32 +00002010
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002011 case Instruction::IntToPtr:
2012 case Instruction::PtrToInt:
Eli Friedman55fa49f32012-01-05 23:03:32 +00002013 // int <=> ptr is fine if the int type is the same size as the
2014 // pointer type.
Mehdi Amini46a43552015-03-04 18:43:29 +00002015 if (DL.getTypeSizeInBits(CE->getType()) !=
2016 DL.getTypeSizeInBits(CE->getOperand(0)->getType()))
Eli Friedman55fa49f32012-01-05 23:03:32 +00002017 return false;
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002018 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, DL);
Jakub Staszak9525a772012-12-06 21:57:16 +00002019
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002020 // GEP is fine if it is simple + constant offset.
2021 case Instruction::GetElementPtr:
2022 for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
2023 if (!isa<ConstantInt>(CE->getOperand(i)))
2024 return false;
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002025 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, DL);
Jakub Staszak9525a772012-12-06 21:57:16 +00002026
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002027 case Instruction::Add:
2028 // We allow simple+cst.
2029 if (!isa<ConstantInt>(CE->getOperand(1)))
2030 return false;
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002031 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, DL);
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002032 }
2033 return false;
2034}
2035
Jakub Staszak9525a772012-12-06 21:57:16 +00002036static inline bool
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002037isSimpleEnoughValueToCommit(Constant *C,
Mehdi Amini46a43552015-03-04 18:43:29 +00002038 SmallPtrSetImpl<Constant *> &SimpleConstants,
2039 const DataLayout &DL) {
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002040 // If we already checked this constant, we win.
David Blaikie70573dc2014-11-19 07:49:26 +00002041 if (!SimpleConstants.insert(C).second)
2042 return true;
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002043 // Check the constant.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002044 return isSimpleEnoughValueToCommitHelper(C, SimpleConstants, DL);
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002045}
2046
2047
Chris Lattner99e23fa2005-09-26 04:44:35 +00002048/// isSimpleEnoughPointerToCommit - Return true if this constant is simple
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002049/// enough for us to understand. In particular, if it is a cast to anything
2050/// other than from one pointer type to another pointer type, we punt.
2051/// We basically just support direct accesses to globals and GEP's of
Chris Lattner99e23fa2005-09-26 04:44:35 +00002052/// globals. This should be kept up to date with CommitValueTo.
Chris Lattner46b5c642009-11-06 04:27:31 +00002053static bool isSimpleEnoughPointerToCommit(Constant *C) {
Dan Gohman82e74752009-09-07 22:42:05 +00002054 // Conservatively, avoid aggregate types. This is because we don't
2055 // want to worry about them partially overlapping other stores.
2056 if (!cast<PointerType>(C->getType())->getElementType()->isSingleValueType())
2057 return false;
2058
Dan Gohmanf7f3fb12009-09-07 22:31:26 +00002059 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
David Majnemer23fc9af2014-06-24 06:53:45 +00002060 // Do not allow weak/*_odr/linkonce linkage or external globals.
Mikhail Glushenkov2072db22010-10-19 16:47:23 +00002061 return GV->hasUniqueInitializer();
Dan Gohmanf7f3fb12009-09-07 22:31:26 +00002062
Owen Anderson3e2f6cf2011-01-14 22:31:13 +00002063 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Chris Lattner46af55e2005-09-26 06:52:44 +00002064 // Handle a constantexpr gep.
2065 if (CE->getOpcode() == Instruction::GetElementPtr &&
Dan Gohmanbeee35a2009-09-07 22:40:13 +00002066 isa<GlobalVariable>(CE->getOperand(0)) &&
2067 cast<GEPOperator>(CE)->isInBounds()) {
Chris Lattner46af55e2005-09-26 06:52:44 +00002068 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Mikhail Glushenkov2072db22010-10-19 16:47:23 +00002069 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
Dan Gohmanf7f3fb12009-09-07 22:31:26 +00002070 // external globals.
Mikhail Glushenkov2072db22010-10-19 16:47:23 +00002071 if (!GV->hasUniqueInitializer())
Dan Gohmanf7f3fb12009-09-07 22:31:26 +00002072 return false;
Dan Gohman161429f2009-09-07 22:44:55 +00002073
Dan Gohman161429f2009-09-07 22:44:55 +00002074 // The first index must be zero.
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +00002075 ConstantInt *CI = dyn_cast<ConstantInt>(*std::next(CE->op_begin()));
Dan Gohman161429f2009-09-07 22:44:55 +00002076 if (!CI || !CI->isZero()) return false;
Dan Gohman161429f2009-09-07 22:44:55 +00002077
2078 // The remaining indices must be compile-time known integers within the
Dan Gohman7190d482009-09-10 23:37:55 +00002079 // notional bounds of the corresponding static array types.
2080 if (!CE->isGEPWithNoNotionalOverIndexing())
2081 return false;
Dan Gohman161429f2009-09-07 22:44:55 +00002082
Dan Gohmane525d9d2009-10-05 16:36:26 +00002083 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
Jakub Staszak9525a772012-12-06 21:57:16 +00002084
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002085 // A constantexpr bitcast from a pointer to another pointer is a no-op,
2086 // and we know how to evaluate it by moving the bitcast from the pointer
2087 // operand to the value operand.
2088 } else if (CE->getOpcode() == Instruction::BitCast &&
Chris Lattner8b4952f2011-01-16 02:05:10 +00002089 isa<GlobalVariable>(CE->getOperand(0))) {
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002090 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
2091 // external globals.
Chris Lattner8b4952f2011-01-16 02:05:10 +00002092 return cast<GlobalVariable>(CE->getOperand(0))->hasUniqueInitializer();
Chris Lattner46af55e2005-09-26 06:52:44 +00002093 }
Owen Anderson3e2f6cf2011-01-14 22:31:13 +00002094 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002095
Chris Lattner99e23fa2005-09-26 04:44:35 +00002096 return false;
2097}
2098
Chris Lattner46af55e2005-09-26 06:52:44 +00002099/// EvaluateStoreInto - Evaluate a piece of a constantexpr store into a global
2100/// initializer. This returns 'Init' modified to reflect 'Val' stored into it.
2101/// At this point, the GEP operands of Addr [0, OpNo) have been stepped into.
2102static Constant *EvaluateStoreInto(Constant *Init, Constant *Val,
Zhou Sheng8e6d64a2012-12-01 10:54:28 +00002103 ConstantExpr *Addr, unsigned OpNo) {
Chris Lattner46af55e2005-09-26 06:52:44 +00002104 // Base case of the recursion.
2105 if (OpNo == Addr->getNumOperands()) {
2106 assert(Val->getType() == Init->getType() && "Type mismatch!");
2107 return Val;
2108 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002109
Chris Lattner0256be92012-01-27 03:08:05 +00002110 SmallVector<Constant*, 32> Elts;
Chris Lattner229907c2011-07-18 04:54:35 +00002111 if (StructType *STy = dyn_cast<StructType>(Init->getType())) {
Chris Lattner46af55e2005-09-26 06:52:44 +00002112 // Break up the constant into its elements.
Chris Lattnerfa775002012-01-26 02:32:04 +00002113 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
2114 Elts.push_back(Init->getAggregateElement(i));
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002115
Chris Lattner46af55e2005-09-26 06:52:44 +00002116 // Replace the element that we are supposed to.
Reid Spencere0fc4df2006-10-20 07:07:24 +00002117 ConstantInt *CU = cast<ConstantInt>(Addr->getOperand(OpNo));
2118 unsigned Idx = CU->getZExtValue();
2119 assert(Idx < STy->getNumElements() && "Struct index out of range!");
Zhou Sheng8e6d64a2012-12-01 10:54:28 +00002120 Elts[Idx] = EvaluateStoreInto(Elts[Idx], Val, Addr, OpNo+1);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002121
Chris Lattner46af55e2005-09-26 06:52:44 +00002122 // Return the modified struct.
Chris Lattnercc19efa2011-06-20 04:01:31 +00002123 return ConstantStruct::get(STy, Elts);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002124 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002125
Chris Lattnercc19efa2011-06-20 04:01:31 +00002126 ConstantInt *CI = cast<ConstantInt>(Addr->getOperand(OpNo));
Chris Lattner229907c2011-07-18 04:54:35 +00002127 SequentialType *InitTy = cast<SequentialType>(Init->getType());
Chris Lattnercc19efa2011-06-20 04:01:31 +00002128
2129 uint64_t NumElts;
Chris Lattner229907c2011-07-18 04:54:35 +00002130 if (ArrayType *ATy = dyn_cast<ArrayType>(InitTy))
Chris Lattnercc19efa2011-06-20 04:01:31 +00002131 NumElts = ATy->getNumElements();
2132 else
Chris Lattnerfa775002012-01-26 02:32:04 +00002133 NumElts = InitTy->getVectorNumElements();
Chris Lattnercc19efa2011-06-20 04:01:31 +00002134
2135 // Break up the array into elements.
Chris Lattnerfa775002012-01-26 02:32:04 +00002136 for (uint64_t i = 0, e = NumElts; i != e; ++i)
2137 Elts.push_back(Init->getAggregateElement(i));
Chris Lattnercc19efa2011-06-20 04:01:31 +00002138
2139 assert(CI->getZExtValue() < NumElts);
2140 Elts[CI->getZExtValue()] =
Zhou Sheng8e6d64a2012-12-01 10:54:28 +00002141 EvaluateStoreInto(Elts[CI->getZExtValue()], Val, Addr, OpNo+1);
Chris Lattnercc19efa2011-06-20 04:01:31 +00002142
2143 if (Init->getType()->isArrayTy())
2144 return ConstantArray::get(cast<ArrayType>(InitTy), Elts);
2145 return ConstantVector::get(Elts);
Chris Lattner46af55e2005-09-26 06:52:44 +00002146}
2147
Chris Lattner99e23fa2005-09-26 04:44:35 +00002148/// CommitValueTo - We have decided that Addr (which satisfies the predicate
2149/// isSimpleEnoughPointerToCommit) should get Val as its value. Make it happen.
Chris Lattner46b5c642009-11-06 04:27:31 +00002150static void CommitValueTo(Constant *Val, Constant *Addr) {
Chris Lattner46af55e2005-09-26 06:52:44 +00002151 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Addr)) {
2152 assert(GV->hasInitializer());
2153 GV->setInitializer(Val);
2154 return;
2155 }
Chris Lattner64ecc462010-01-07 01:16:21 +00002156
Chris Lattner46af55e2005-09-26 06:52:44 +00002157 ConstantExpr *CE = cast<ConstantExpr>(Addr);
2158 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Zhou Sheng8e6d64a2012-12-01 10:54:28 +00002159 GV->setInitializer(EvaluateStoreInto(GV->getInitializer(), Val, CE, 2));
Chris Lattner99e23fa2005-09-26 04:44:35 +00002160}
2161
Nick Lewycky60829a582012-02-20 03:25:59 +00002162namespace {
2163
2164/// Evaluator - This class evaluates LLVM IR, producing the Constant
2165/// representing each SSA instruction. Changes to global variables are stored
2166/// in a mapping that can be iterated over after the evaluation is complete.
2167/// Once an evaluation call fails, the evaluation object should not be reused.
2168class Evaluator {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002169public:
Mehdi Amini46a43552015-03-04 18:43:29 +00002170 Evaluator(const DataLayout &DL, const TargetLibraryInfo *TLI)
2171 : DL(DL), TLI(TLI) {
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002172 ValueStack.emplace_back();
Nick Lewycky73be5e32012-02-19 23:26:27 +00002173 }
2174
Nick Lewycky60829a582012-02-20 03:25:59 +00002175 ~Evaluator() {
David Blaikiebc442202014-04-21 20:49:36 +00002176 for (auto &Tmp : AllocaTmps)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002177 // If there are still users of the alloca, the program is doing something
2178 // silly, e.g. storing the address of the alloca somewhere and using it
2179 // later. Since this is undefined, we'll just make it be null.
2180 if (!Tmp->use_empty())
2181 Tmp->replaceAllUsesWith(Constant::getNullValue(Tmp->getType()));
Nick Lewycky73be5e32012-02-19 23:26:27 +00002182 }
2183
2184 /// EvaluateFunction - Evaluate a call to function F, returning true if
2185 /// successful, false if we can't evaluate it. ActualArgs contains the formal
2186 /// arguments for the function.
2187 bool EvaluateFunction(Function *F, Constant *&RetVal,
2188 const SmallVectorImpl<Constant*> &ActualArgs);
2189
2190 /// EvaluateBlock - Evaluate all instructions in block BB, returning true if
2191 /// successful, false if we can't evaluate it. NewBB returns the next BB that
2192 /// control flows into, or null upon return.
2193 bool EvaluateBlock(BasicBlock::iterator CurInst, BasicBlock *&NextBB);
2194
2195 Constant *getVal(Value *V) {
2196 if (Constant *CV = dyn_cast<Constant>(V)) return CV;
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002197 Constant *R = ValueStack.back().lookup(V);
Nick Lewycky73be5e32012-02-19 23:26:27 +00002198 assert(R && "Reference to an uncomputed value!");
2199 return R;
2200 }
2201
2202 void setVal(Value *V, Constant *C) {
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002203 ValueStack.back()[V] = C;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002204 }
2205
2206 const DenseMap<Constant*, Constant*> &getMutatedMemory() const {
2207 return MutatedMemory;
2208 }
2209
Craig Topper71b7b682014-08-21 05:55:13 +00002210 const SmallPtrSetImpl<GlobalVariable*> &getInvariants() const {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002211 return Invariants;
2212 }
2213
2214private:
2215 Constant *ComputeLoadResult(Constant *P);
2216
2217 /// ValueStack - As we compute SSA register values, we store their contents
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002218 /// here. The back of the deque contains the current function and the stack
Nick Lewycky73be5e32012-02-19 23:26:27 +00002219 /// contains the values in the calling frames.
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002220 std::deque<DenseMap<Value*, Constant*>> ValueStack;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002221
2222 /// CallStack - This is used to detect recursion. In pathological situations
2223 /// we could hit exponential behavior, but at least there is nothing
2224 /// unbounded.
2225 SmallVector<Function*, 4> CallStack;
2226
2227 /// MutatedMemory - For each store we execute, we update this map. Loads
2228 /// check this to get the most up-to-date value. If evaluation is successful,
2229 /// this state is committed to the process.
2230 DenseMap<Constant*, Constant*> MutatedMemory;
2231
2232 /// AllocaTmps - To 'execute' an alloca, we create a temporary global variable
2233 /// to represent its body. This vector is needed so we can delete the
2234 /// temporary globals when we are done.
David Blaikiebc442202014-04-21 20:49:36 +00002235 SmallVector<std::unique_ptr<GlobalVariable>, 32> AllocaTmps;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002236
2237 /// Invariants - These global variables have been marked invariant by the
2238 /// static constructor.
2239 SmallPtrSet<GlobalVariable*, 8> Invariants;
2240
2241 /// SimpleConstants - These are constants we have checked and know to be
2242 /// simple enough to live in a static initializer of a global.
2243 SmallPtrSet<Constant*, 8> SimpleConstants;
2244
Mehdi Amini46a43552015-03-04 18:43:29 +00002245 const DataLayout &DL;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002246 const TargetLibraryInfo *TLI;
2247};
2248
Nick Lewycky60829a582012-02-20 03:25:59 +00002249} // anonymous namespace
2250
Chris Lattnerb0096632005-09-26 05:16:34 +00002251/// ComputeLoadResult - Return the value that would be computed by a load from
2252/// P after the stores reflected by 'memory' have been performed. If we can't
2253/// decide, return null.
Nick Lewycky60829a582012-02-20 03:25:59 +00002254Constant *Evaluator::ComputeLoadResult(Constant *P) {
Chris Lattner4b05c322005-09-26 05:15:37 +00002255 // If this memory location has been recently stored, use the stored value: it
2256 // is the most up-to-date.
Nick Lewycky73be5e32012-02-19 23:26:27 +00002257 DenseMap<Constant*, Constant*>::const_iterator I = MutatedMemory.find(P);
2258 if (I != MutatedMemory.end()) return I->second;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002259
Chris Lattner4b05c322005-09-26 05:15:37 +00002260 // Access it.
2261 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(P)) {
Dan Gohman5d5bc6d2009-08-19 18:20:44 +00002262 if (GV->hasDefinitiveInitializer())
Chris Lattner4b05c322005-09-26 05:15:37 +00002263 return GV->getInitializer();
Craig Topperf40110f2014-04-25 05:29:35 +00002264 return nullptr;
Chris Lattner4b05c322005-09-26 05:15:37 +00002265 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002266
Chris Lattner46af55e2005-09-26 06:52:44 +00002267 // Handle a constantexpr getelementptr.
2268 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(P))
2269 if (CE->getOpcode() == Instruction::GetElementPtr &&
2270 isa<GlobalVariable>(CE->getOperand(0))) {
2271 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Dan Gohman5d5bc6d2009-08-19 18:20:44 +00002272 if (GV->hasDefinitiveInitializer())
Dan Gohmane525d9d2009-10-05 16:36:26 +00002273 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
Chris Lattner46af55e2005-09-26 06:52:44 +00002274 }
2275
Craig Topperf40110f2014-04-25 05:29:35 +00002276 return nullptr; // don't know how to evaluate.
Chris Lattner4b05c322005-09-26 05:15:37 +00002277}
2278
Nick Lewycky239fdf02012-02-06 08:24:44 +00002279/// EvaluateBlock - Evaluate all instructions in block BB, returning true if
2280/// successful, false if we can't evaluate it. NewBB returns the next BB that
2281/// control flows into, or null upon return.
Nick Lewycky60829a582012-02-20 03:25:59 +00002282bool Evaluator::EvaluateBlock(BasicBlock::iterator CurInst,
2283 BasicBlock *&NextBB) {
Chris Lattner99e23fa2005-09-26 04:44:35 +00002284 // This is the main evaluation loop.
2285 while (1) {
Craig Topperf40110f2014-04-25 05:29:35 +00002286 Constant *InstResult = nullptr;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002287
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002288 DEBUG(dbgs() << "Evaluating Instruction: " << *CurInst << "\n");
2289
Chris Lattner99e23fa2005-09-26 04:44:35 +00002290 if (StoreInst *SI = dyn_cast<StoreInst>(CurInst)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002291 if (!SI->isSimple()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002292 DEBUG(dbgs() << "Store is not simple! Can not evaluate.\n");
2293 return false; // no volatile/atomic accesses.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002294 }
Nick Lewycky73be5e32012-02-19 23:26:27 +00002295 Constant *Ptr = getVal(SI->getOperand(1));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002296 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002297 DEBUG(dbgs() << "Folding constant ptr expression: " << *Ptr);
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002298 Ptr = ConstantFoldConstantExpression(CE, DL, TLI);
Michael Gottesman2a654272013-01-11 23:08:52 +00002299 DEBUG(dbgs() << "; To: " << *Ptr << "\n");
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002300 }
2301 if (!isSimpleEnoughPointerToCommit(Ptr)) {
Chris Lattner99e23fa2005-09-26 04:44:35 +00002302 // If this is too complex for us to commit, reject it.
Michael Gottesman2a654272013-01-11 23:08:52 +00002303 DEBUG(dbgs() << "Pointer is too complex for us to evaluate store.");
Chris Lattner65a3a092005-09-27 04:45:34 +00002304 return false;
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002305 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002306
Nick Lewycky73be5e32012-02-19 23:26:27 +00002307 Constant *Val = getVal(SI->getOperand(0));
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002308
2309 // If this might be too difficult for the backend to handle (e.g. the addr
2310 // of one global variable divided by another) then we can't commit it.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002311 if (!isSimpleEnoughValueToCommit(Val, SimpleConstants, DL)) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002312 DEBUG(dbgs() << "Store value is too complex to evaluate store. " << *Val
2313 << "\n");
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002314 return false;
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002315 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002316
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002317 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002318 if (CE->getOpcode() == Instruction::BitCast) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002319 DEBUG(dbgs() << "Attempting to resolve bitcast on constant ptr.\n");
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002320 // If we're evaluating a store through a bitcast, then we need
2321 // to pull the bitcast off the pointer type and push it onto the
2322 // stored value.
Chris Lattner8b4952f2011-01-16 02:05:10 +00002323 Ptr = CE->getOperand(0);
Jakub Staszak9525a772012-12-06 21:57:16 +00002324
Nick Lewycky239fdf02012-02-06 08:24:44 +00002325 Type *NewTy = cast<PointerType>(Ptr->getType())->getElementType();
Jakub Staszak9525a772012-12-06 21:57:16 +00002326
Owen Anderson4e54efd2011-01-16 04:33:33 +00002327 // In order to push the bitcast onto the stored value, a bitcast
2328 // from NewTy to Val's type must be legal. If it's not, we can try
2329 // introspecting NewTy to find a legal conversion.
2330 while (!Val->getType()->canLosslesslyBitCastTo(NewTy)) {
2331 // If NewTy is a struct, we can convert the pointer to the struct
2332 // into a pointer to its first member.
2333 // FIXME: This could be extended to support arrays as well.
Chris Lattner229907c2011-07-18 04:54:35 +00002334 if (StructType *STy = dyn_cast<StructType>(NewTy)) {
Owen Anderson4e54efd2011-01-16 04:33:33 +00002335 NewTy = STy->getTypeAtIndex(0U);
2336
Nick Lewycky239fdf02012-02-06 08:24:44 +00002337 IntegerType *IdxTy = IntegerType::get(NewTy->getContext(), 32);
Owen Anderson4e54efd2011-01-16 04:33:33 +00002338 Constant *IdxZero = ConstantInt::get(IdxTy, 0, false);
2339 Constant * const IdxList[] = {IdxZero, IdxZero};
2340
Jay Foad17bab442011-07-22 08:52:50 +00002341 Ptr = ConstantExpr::getGetElementPtr(Ptr, IdxList);
Nick Lewycky9d0da182012-02-21 22:08:06 +00002342 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002343 Ptr = ConstantFoldConstantExpression(CE, DL, TLI);
Nick Lewycky9d0da182012-02-21 22:08:06 +00002344
Owen Anderson4e54efd2011-01-16 04:33:33 +00002345 // If we can't improve the situation by introspecting NewTy,
2346 // we have to give up.
2347 } else {
Michael Gottesman2a654272013-01-11 23:08:52 +00002348 DEBUG(dbgs() << "Failed to bitcast constant ptr, can not "
2349 "evaluate.\n");
Nick Lewycky239fdf02012-02-06 08:24:44 +00002350 return false;
Owen Anderson4e54efd2011-01-16 04:33:33 +00002351 }
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002352 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002353
Owen Anderson4e54efd2011-01-16 04:33:33 +00002354 // If we found compatible types, go ahead and push the bitcast
2355 // onto the stored value.
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002356 Val = ConstantExpr::getBitCast(Val, NewTy);
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002357
Michael Gottesman2a654272013-01-11 23:08:52 +00002358 DEBUG(dbgs() << "Evaluated bitcast: " << *Val << "\n");
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002359 }
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002360 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002361
Chris Lattner99e23fa2005-09-26 04:44:35 +00002362 MutatedMemory[Ptr] = Val;
2363 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CurInst)) {
Owen Anderson487375e2009-07-29 18:55:55 +00002364 InstResult = ConstantExpr::get(BO->getOpcode(),
Nick Lewycky73be5e32012-02-19 23:26:27 +00002365 getVal(BO->getOperand(0)),
2366 getVal(BO->getOperand(1)));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002367 DEBUG(dbgs() << "Found a BinaryOperator! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002368 << "\n");
Reid Spencer266e42b2006-12-23 06:05:41 +00002369 } else if (CmpInst *CI = dyn_cast<CmpInst>(CurInst)) {
Owen Anderson487375e2009-07-29 18:55:55 +00002370 InstResult = ConstantExpr::getCompare(CI->getPredicate(),
Nick Lewycky73be5e32012-02-19 23:26:27 +00002371 getVal(CI->getOperand(0)),
2372 getVal(CI->getOperand(1)));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002373 DEBUG(dbgs() << "Found a CmpInst! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002374 << "\n");
Chris Lattner99e23fa2005-09-26 04:44:35 +00002375 } else if (CastInst *CI = dyn_cast<CastInst>(CurInst)) {
Owen Anderson487375e2009-07-29 18:55:55 +00002376 InstResult = ConstantExpr::getCast(CI->getOpcode(),
Nick Lewycky73be5e32012-02-19 23:26:27 +00002377 getVal(CI->getOperand(0)),
Chris Lattner99e23fa2005-09-26 04:44:35 +00002378 CI->getType());
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002379 DEBUG(dbgs() << "Found a Cast! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002380 << "\n");
Chris Lattner99e23fa2005-09-26 04:44:35 +00002381 } else if (SelectInst *SI = dyn_cast<SelectInst>(CurInst)) {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002382 InstResult = ConstantExpr::getSelect(getVal(SI->getOperand(0)),
2383 getVal(SI->getOperand(1)),
2384 getVal(SI->getOperand(2)));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002385 DEBUG(dbgs() << "Found a Select! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002386 << "\n");
David Majnemerfe8c7542014-08-08 05:50:43 +00002387 } else if (auto *EVI = dyn_cast<ExtractValueInst>(CurInst)) {
2388 InstResult = ConstantExpr::getExtractValue(
2389 getVal(EVI->getAggregateOperand()), EVI->getIndices());
2390 DEBUG(dbgs() << "Found an ExtractValueInst! Simplifying: " << *InstResult
2391 << "\n");
2392 } else if (auto *IVI = dyn_cast<InsertValueInst>(CurInst)) {
2393 InstResult = ConstantExpr::getInsertValue(
2394 getVal(IVI->getAggregateOperand()),
2395 getVal(IVI->getInsertedValueOperand()), IVI->getIndices());
2396 DEBUG(dbgs() << "Found an InsertValueInst! Simplifying: " << *InstResult
2397 << "\n");
Chris Lattner4b05c322005-09-26 05:15:37 +00002398 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(CurInst)) {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002399 Constant *P = getVal(GEP->getOperand(0));
Chris Lattnerf96f4a82007-01-31 04:40:53 +00002400 SmallVector<Constant*, 8> GEPOps;
Gabor Greif3a9fba52008-05-29 01:59:18 +00002401 for (User::op_iterator i = GEP->op_begin() + 1, e = GEP->op_end();
2402 i != e; ++i)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002403 GEPOps.push_back(getVal(*i));
Jay Foad2f5fc8c2011-07-21 15:15:37 +00002404 InstResult =
2405 ConstantExpr::getGetElementPtr(P, GEPOps,
2406 cast<GEPOperator>(GEP)->isInBounds());
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002407 DEBUG(dbgs() << "Found a GEP! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002408 << "\n");
Chris Lattner4b05c322005-09-26 05:15:37 +00002409 } else if (LoadInst *LI = dyn_cast<LoadInst>(CurInst)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002410
2411 if (!LI->isSimple()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002412 DEBUG(dbgs() << "Found a Load! Not a simple load, can not evaluate.\n");
2413 return false; // no volatile/atomic accesses.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002414 }
2415
Nick Lewycky9d0da182012-02-21 22:08:06 +00002416 Constant *Ptr = getVal(LI->getOperand(0));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002417 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002418 Ptr = ConstantFoldConstantExpression(CE, DL, TLI);
Michael Gottesman2a654272013-01-11 23:08:52 +00002419 DEBUG(dbgs() << "Found a constant pointer expression, constant "
2420 "folding: " << *Ptr << "\n");
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002421 }
Nick Lewycky9d0da182012-02-21 22:08:06 +00002422 InstResult = ComputeLoadResult(Ptr);
Craig Topperf40110f2014-04-25 05:29:35 +00002423 if (!InstResult) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002424 DEBUG(dbgs() << "Failed to compute load result. Can not evaluate load."
2425 "\n");
2426 return false; // Could not evaluate load.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002427 }
2428
2429 DEBUG(dbgs() << "Evaluated load: " << *InstResult << "\n");
Chris Lattner6bf2cd52005-09-26 17:07:09 +00002430 } else if (AllocaInst *AI = dyn_cast<AllocaInst>(CurInst)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002431 if (AI->isArrayAllocation()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002432 DEBUG(dbgs() << "Found an array alloca. Can not evaluate.\n");
2433 return false; // Cannot handle array allocs.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002434 }
Chris Lattner229907c2011-07-18 04:54:35 +00002435 Type *Ty = AI->getType()->getElementType();
David Blaikiebc442202014-04-21 20:49:36 +00002436 AllocaTmps.push_back(
2437 make_unique<GlobalVariable>(Ty, false, GlobalValue::InternalLinkage,
2438 UndefValue::get(Ty), AI->getName()));
2439 InstResult = AllocaTmps.back().get();
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002440 DEBUG(dbgs() << "Found an alloca. Result: " << *InstResult << "\n");
Nick Lewyckyc1572e42012-02-12 05:09:35 +00002441 } else if (isa<CallInst>(CurInst) || isa<InvokeInst>(CurInst)) {
2442 CallSite CS(CurInst);
Devang Patel04852aa2009-03-09 23:04:12 +00002443
2444 // Debug info can safely be ignored here.
Nick Lewyckyc1572e42012-02-12 05:09:35 +00002445 if (isa<DbgInfoIntrinsic>(CS.getInstruction())) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002446 DEBUG(dbgs() << "Ignoring debug info.\n");
Devang Patel04852aa2009-03-09 23:04:12 +00002447 ++CurInst;
2448 continue;
2449 }
2450
Chris Lattnerfd2e13b2006-07-07 21:37:01 +00002451 // Cannot handle inline asm.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002452 if (isa<InlineAsm>(CS.getCalledValue())) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002453 DEBUG(dbgs() << "Found inline asm, can not evaluate.\n");
2454 return false;
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002455 }
Chris Lattnerfd2e13b2006-07-07 21:37:01 +00002456
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002457 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction())) {
2458 if (MemSetInst *MSI = dyn_cast<MemSetInst>(II)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002459 if (MSI->isVolatile()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002460 DEBUG(dbgs() << "Can not optimize a volatile memset " <<
2461 "intrinsic.\n");
2462 return false;
2463 }
Nick Lewycky73be5e32012-02-19 23:26:27 +00002464 Constant *Ptr = getVal(MSI->getDest());
2465 Constant *Val = getVal(MSI->getValue());
2466 Constant *DestVal = ComputeLoadResult(getVal(Ptr));
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002467 if (Val->isNullValue() && DestVal && DestVal->isNullValue()) {
2468 // This memset is a no-op.
Michael Gottesman2a654272013-01-11 23:08:52 +00002469 DEBUG(dbgs() << "Ignoring no-op memset.\n");
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002470 ++CurInst;
2471 continue;
2472 }
2473 }
2474
2475 if (II->getIntrinsicID() == Intrinsic::lifetime_start ||
2476 II->getIntrinsicID() == Intrinsic::lifetime_end) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002477 DEBUG(dbgs() << "Ignoring lifetime intrinsic.\n");
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002478 ++CurInst;
2479 continue;
2480 }
2481
2482 if (II->getIntrinsicID() == Intrinsic::invariant_start) {
2483 // We don't insert an entry into Values, as it doesn't have a
2484 // meaningful return value.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002485 if (!II->use_empty()) {
Alp Tokerf907b892013-12-05 05:44:44 +00002486 DEBUG(dbgs() << "Found unused invariant_start. Can't evaluate.\n");
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002487 return false;
Michael Gottesman2a654272013-01-11 23:08:52 +00002488 }
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002489 ConstantInt *Size = cast<ConstantInt>(II->getArgOperand(0));
Nick Lewycky519561f2012-02-20 23:32:26 +00002490 Value *PtrArg = getVal(II->getArgOperand(1));
2491 Value *Ptr = PtrArg->stripPointerCasts();
2492 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Ptr)) {
2493 Type *ElemTy = cast<PointerType>(GV->getType())->getElementType();
Mehdi Amini46a43552015-03-04 18:43:29 +00002494 if (!Size->isAllOnesValue() &&
Nick Lewycky519561f2012-02-20 23:32:26 +00002495 Size->getValue().getLimitedValue() >=
Mehdi Amini46a43552015-03-04 18:43:29 +00002496 DL.getTypeStoreSize(ElemTy)) {
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002497 Invariants.insert(GV);
Michael Gottesman2a654272013-01-11 23:08:52 +00002498 DEBUG(dbgs() << "Found a global var that is an invariant: " << *GV
2499 << "\n");
2500 } else {
2501 DEBUG(dbgs() << "Found a global var, but can not treat it as an "
2502 "invariant.\n");
2503 }
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002504 }
2505 // Continue even if we do nothing.
Nick Lewyckya3bb03e2011-05-29 18:41:56 +00002506 ++CurInst;
2507 continue;
2508 }
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002509
Michael Gottesman2a654272013-01-11 23:08:52 +00002510 DEBUG(dbgs() << "Unknown intrinsic. Can not evaluate.\n");
Nick Lewyckya3bb03e2011-05-29 18:41:56 +00002511 return false;
2512 }
2513
Chris Lattner65a3a092005-09-27 04:45:34 +00002514 // Resolve function pointers.
Nick Lewycky73be5e32012-02-19 23:26:27 +00002515 Function *Callee = dyn_cast<Function>(getVal(CS.getCalledValue()));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002516 if (!Callee || Callee->mayBeOverridden()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002517 DEBUG(dbgs() << "Can not resolve function pointer.\n");
Nick Lewyckyc1572e42012-02-12 05:09:35 +00002518 return false; // Cannot resolve.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002519 }
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002520
Duncan Sandsc4ce58d82009-08-17 14:33:27 +00002521 SmallVector<Constant*, 8> Formals;
Nick Lewyckyc1572e42012-02-12 05:09:35 +00002522 for (User::op_iterator i = CS.arg_begin(), e = CS.arg_end(); i != e; ++i)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002523 Formals.push_back(getVal(*i));
Duncan Sandsc4ce58d82009-08-17 14:33:27 +00002524
Reid Spencer5301e7c2007-01-30 20:08:39 +00002525 if (Callee->isDeclaration()) {
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002526 // If this is a function we can constant fold, do it.
Chad Rosiere6de63d2011-12-01 21:29:16 +00002527 if (Constant *C = ConstantFoldCall(Callee, Formals, TLI)) {
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002528 InstResult = C;
Michael Gottesman2a654272013-01-11 23:08:52 +00002529 DEBUG(dbgs() << "Constant folded function call. Result: " <<
2530 *InstResult << "\n");
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002531 } else {
Michael Gottesman2a654272013-01-11 23:08:52 +00002532 DEBUG(dbgs() << "Can not constant fold function call.\n");
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002533 return false;
2534 }
2535 } else {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002536 if (Callee->getFunctionType()->isVarArg()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002537 DEBUG(dbgs() << "Can not constant fold vararg function call.\n");
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002538 return false;
Michael Gottesman2a654272013-01-11 23:08:52 +00002539 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002540
Craig Topperf40110f2014-04-25 05:29:35 +00002541 Constant *RetVal = nullptr;
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002542 // Execute the call, if successful, use the return value.
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002543 ValueStack.emplace_back();
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002544 if (!EvaluateFunction(Callee, RetVal, Formals)) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002545 DEBUG(dbgs() << "Failed to evaluate function.\n");
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002546 return false;
Michael Gottesman2a654272013-01-11 23:08:52 +00002547 }
David Blaikiebc442202014-04-21 20:49:36 +00002548 ValueStack.pop_back();
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002549 InstResult = RetVal;
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002550
Craig Topperf40110f2014-04-25 05:29:35 +00002551 if (InstResult) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002552 DEBUG(dbgs() << "Successfully evaluated function. Result: " <<
2553 InstResult << "\n\n");
2554 } else {
2555 DEBUG(dbgs() << "Successfully evaluated function. Result: 0\n\n");
2556 }
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002557 }
Reid Spencerde46e482006-11-02 20:25:50 +00002558 } else if (isa<TerminatorInst>(CurInst)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002559 DEBUG(dbgs() << "Found a terminator instruction.\n");
2560
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002561 if (BranchInst *BI = dyn_cast<BranchInst>(CurInst)) {
2562 if (BI->isUnconditional()) {
Nick Lewycky239fdf02012-02-06 08:24:44 +00002563 NextBB = BI->getSuccessor(0);
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002564 } else {
Zhou Sheng75b871f2007-01-11 12:24:14 +00002565 ConstantInt *Cond =
Nick Lewycky73be5e32012-02-19 23:26:27 +00002566 dyn_cast<ConstantInt>(getVal(BI->getCondition()));
Chris Lattner15649082007-01-12 18:30:11 +00002567 if (!Cond) return false; // Cannot determine.
Zhou Sheng75b871f2007-01-11 12:24:14 +00002568
Nick Lewycky239fdf02012-02-06 08:24:44 +00002569 NextBB = BI->getSuccessor(!Cond->getZExtValue());
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002570 }
2571 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurInst)) {
2572 ConstantInt *Val =
Nick Lewycky73be5e32012-02-19 23:26:27 +00002573 dyn_cast<ConstantInt>(getVal(SI->getCondition()));
Chris Lattner65a3a092005-09-27 04:45:34 +00002574 if (!Val) return false; // Cannot determine.
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00002575 NextBB = SI->findCaseValue(Val).getCaseSuccessor();
Chris Lattner31274882009-10-29 05:51:50 +00002576 } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(CurInst)) {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002577 Value *Val = getVal(IBI->getAddress())->stripPointerCasts();
Chris Lattner31274882009-10-29 05:51:50 +00002578 if (BlockAddress *BA = dyn_cast<BlockAddress>(Val))
Nick Lewycky239fdf02012-02-06 08:24:44 +00002579 NextBB = BA->getBasicBlock();
Chris Lattneraa99c942009-11-01 01:27:45 +00002580 else
2581 return false; // Cannot determine.
Nick Lewycky239fdf02012-02-06 08:24:44 +00002582 } else if (isa<ReturnInst>(CurInst)) {
Craig Topperf40110f2014-04-25 05:29:35 +00002583 NextBB = nullptr;
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002584 } else {
Bill Wendlingf891bf82011-07-31 06:30:59 +00002585 // invoke, unwind, resume, unreachable.
Michael Gottesman2a654272013-01-11 23:08:52 +00002586 DEBUG(dbgs() << "Can not handle terminator.");
Chris Lattner65a3a092005-09-27 04:45:34 +00002587 return false; // Cannot handle this terminator.
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002588 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002589
Nick Lewycky239fdf02012-02-06 08:24:44 +00002590 // We succeeded at evaluating this block!
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002591 DEBUG(dbgs() << "Successfully evaluated block.\n");
Nick Lewycky239fdf02012-02-06 08:24:44 +00002592 return true;
Chris Lattner99e23fa2005-09-26 04:44:35 +00002593 } else {
Chris Lattner99e23fa2005-09-26 04:44:35 +00002594 // Did not know how to evaluate this!
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002595 DEBUG(dbgs() << "Failed to evaluate block due to unhandled instruction."
Michael Gottesman2a654272013-01-11 23:08:52 +00002596 "\n");
Chris Lattner65a3a092005-09-27 04:45:34 +00002597 return false;
Chris Lattner99e23fa2005-09-26 04:44:35 +00002598 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002599
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002600 if (!CurInst->use_empty()) {
2601 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(InstResult))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002602 InstResult = ConstantFoldConstantExpression(CE, DL, TLI);
Jakub Staszak9525a772012-12-06 21:57:16 +00002603
Nick Lewycky73be5e32012-02-19 23:26:27 +00002604 setVal(CurInst, InstResult);
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002605 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002606
Dan Gohmaneab06fa2012-03-13 18:01:37 +00002607 // If we just processed an invoke, we finished evaluating the block.
2608 if (InvokeInst *II = dyn_cast<InvokeInst>(CurInst)) {
2609 NextBB = II->getNormalDest();
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002610 DEBUG(dbgs() << "Found an invoke instruction. Finished Block.\n\n");
Dan Gohmaneab06fa2012-03-13 18:01:37 +00002611 return true;
2612 }
2613
Chris Lattner99e23fa2005-09-26 04:44:35 +00002614 // Advance program counter.
2615 ++CurInst;
2616 }
Chris Lattnerda1889b2005-09-27 04:27:01 +00002617}
2618
Nick Lewycky239fdf02012-02-06 08:24:44 +00002619/// EvaluateFunction - Evaluate a call to function F, returning true if
2620/// successful, false if we can't evaluate it. ActualArgs contains the formal
2621/// arguments for the function.
Nick Lewycky60829a582012-02-20 03:25:59 +00002622bool Evaluator::EvaluateFunction(Function *F, Constant *&RetVal,
2623 const SmallVectorImpl<Constant*> &ActualArgs) {
Nick Lewycky239fdf02012-02-06 08:24:44 +00002624 // Check to see if this function is already executing (recursion). If so,
2625 // bail out. TODO: we might want to accept limited recursion.
2626 if (std::find(CallStack.begin(), CallStack.end(), F) != CallStack.end())
2627 return false;
2628
2629 CallStack.push_back(F);
2630
Nick Lewycky239fdf02012-02-06 08:24:44 +00002631 // Initialize arguments to the incoming values specified.
2632 unsigned ArgNo = 0;
2633 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end(); AI != E;
2634 ++AI, ++ArgNo)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002635 setVal(AI, ActualArgs[ArgNo]);
Nick Lewycky239fdf02012-02-06 08:24:44 +00002636
2637 // ExecutedBlocks - We only handle non-looping, non-recursive code. As such,
2638 // we can only evaluate any one basic block at most once. This set keeps
2639 // track of what we have executed so we can detect recursive cases etc.
2640 SmallPtrSet<BasicBlock*, 32> ExecutedBlocks;
2641
2642 // CurBB - The current basic block we're evaluating.
2643 BasicBlock *CurBB = F->begin();
2644
Nick Lewycky4231c412012-02-12 00:47:24 +00002645 BasicBlock::iterator CurInst = CurBB->begin();
2646
Nick Lewycky239fdf02012-02-06 08:24:44 +00002647 while (1) {
Craig Topperf40110f2014-04-25 05:29:35 +00002648 BasicBlock *NextBB = nullptr; // Initialized to avoid compiler warnings.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002649 DEBUG(dbgs() << "Trying to evaluate BB: " << *CurBB << "\n");
2650
Nick Lewycky73be5e32012-02-19 23:26:27 +00002651 if (!EvaluateBlock(CurInst, NextBB))
Nick Lewycky239fdf02012-02-06 08:24:44 +00002652 return false;
2653
Craig Topperf40110f2014-04-25 05:29:35 +00002654 if (!NextBB) {
Nick Lewycky239fdf02012-02-06 08:24:44 +00002655 // Successfully running until there's no next block means that we found
2656 // the return. Fill it the return value and pop the call stack.
2657 ReturnInst *RI = cast<ReturnInst>(CurBB->getTerminator());
2658 if (RI->getNumOperands())
Nick Lewycky73be5e32012-02-19 23:26:27 +00002659 RetVal = getVal(RI->getOperand(0));
Nick Lewycky239fdf02012-02-06 08:24:44 +00002660 CallStack.pop_back();
2661 return true;
2662 }
2663
2664 // Okay, we succeeded in evaluating this control flow. See if we have
2665 // executed the new block before. If so, we have a looping function,
2666 // which we cannot evaluate in reasonable time.
David Blaikie70573dc2014-11-19 07:49:26 +00002667 if (!ExecutedBlocks.insert(NextBB).second)
Nick Lewycky239fdf02012-02-06 08:24:44 +00002668 return false; // looped!
2669
2670 // Okay, we have never been in this block before. Check to see if there
2671 // are any PHI nodes. If so, evaluate them with information about where
2672 // we came from.
Craig Topperf40110f2014-04-25 05:29:35 +00002673 PHINode *PN = nullptr;
Nick Lewycky4231c412012-02-12 00:47:24 +00002674 for (CurInst = NextBB->begin();
2675 (PN = dyn_cast<PHINode>(CurInst)); ++CurInst)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002676 setVal(PN, getVal(PN->getIncomingValueForBlock(CurBB)));
Nick Lewycky239fdf02012-02-06 08:24:44 +00002677
2678 // Advance to the next block.
2679 CurBB = NextBB;
2680 }
2681}
2682
Chris Lattnerda1889b2005-09-27 04:27:01 +00002683/// EvaluateStaticConstructor - Evaluate static constructors in the function, if
2684/// we can. Return true if we can, false otherwise.
Mehdi Amini46a43552015-03-04 18:43:29 +00002685static bool EvaluateStaticConstructor(Function *F, const DataLayout &DL,
Chad Rosiere6de63d2011-12-01 21:29:16 +00002686 const TargetLibraryInfo *TLI) {
Chris Lattnerda1889b2005-09-27 04:27:01 +00002687 // Call the function.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002688 Evaluator Eval(DL, TLI);
Chris Lattner65a3a092005-09-27 04:45:34 +00002689 Constant *RetValDummy;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002690 bool EvalSuccess = Eval.EvaluateFunction(F, RetValDummy,
2691 SmallVector<Constant*, 0>());
Jakub Staszak9525a772012-12-06 21:57:16 +00002692
Chris Lattnerda1889b2005-09-27 04:27:01 +00002693 if (EvalSuccess) {
Nico Weber4b2acde2014-05-02 18:35:25 +00002694 ++NumCtorsEvaluated;
2695
Chris Lattner6bf2cd52005-09-26 17:07:09 +00002696 // We succeeded at evaluation: commit the result.
David Greene44cb8ad2010-01-05 01:28:05 +00002697 DEBUG(dbgs() << "FULLY EVALUATED GLOBAL CTOR FUNCTION '"
Nick Lewycky73be5e32012-02-19 23:26:27 +00002698 << F->getName() << "' to " << Eval.getMutatedMemory().size()
Daniel Dunbar0dd5e1e2009-07-25 00:23:56 +00002699 << " stores.\n");
Nick Lewycky73be5e32012-02-19 23:26:27 +00002700 for (DenseMap<Constant*, Constant*>::const_iterator I =
2701 Eval.getMutatedMemory().begin(), E = Eval.getMutatedMemory().end();
Nick Lewyckyb74ae9c2012-06-24 04:07:14 +00002702 I != E; ++I)
Chris Lattner46b5c642009-11-06 04:27:31 +00002703 CommitValueTo(I->second, I->first);
Craig Topper46276792014-08-24 23:23:06 +00002704 for (GlobalVariable *GV : Eval.getInvariants())
2705 GV->setConstant(true);
Chris Lattner6bf2cd52005-09-26 17:07:09 +00002706 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002707
Chris Lattnerda1889b2005-09-27 04:27:01 +00002708 return EvalSuccess;
Chris Lattner99e23fa2005-09-26 04:44:35 +00002709}
2710
Benjamin Krameradf1ea82014-03-07 21:52:38 +00002711static int compareNames(Constant *const *A, Constant *const *B) {
2712 return (*A)->getName().compare((*B)->getName());
2713}
2714
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002715static void setUsedInitializer(GlobalVariable &V,
Craig Topper97ebe532014-08-19 07:44:27 +00002716 const SmallPtrSet<GlobalValue *, 8> &Init) {
Rafael Espindolac2bb73f2013-07-20 23:33:15 +00002717 if (Init.empty()) {
2718 V.eraseFromParent();
2719 return;
2720 }
2721
Matt Arsenaultda1deab2014-01-02 19:53:49 +00002722 // Type of pointer to the array of pointers.
2723 PointerType *Int8PtrTy = Type::getInt8PtrTy(V.getContext(), 0);
Rafael Espindola00752162013-05-09 17:22:59 +00002724
Matt Arsenaultda1deab2014-01-02 19:53:49 +00002725 SmallVector<llvm::Constant *, 8> UsedArray;
Craig Topper71b7b682014-08-21 05:55:13 +00002726 for (GlobalValue *GV : Init) {
Matt Arsenaultda1deab2014-01-02 19:53:49 +00002727 Constant *Cast
Craig Topper71b7b682014-08-21 05:55:13 +00002728 = ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, Int8PtrTy);
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002729 UsedArray.push_back(Cast);
Rafael Espindola00752162013-05-09 17:22:59 +00002730 }
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002731 // Sort to get deterministic order.
Benjamin Krameradf1ea82014-03-07 21:52:38 +00002732 array_pod_sort(UsedArray.begin(), UsedArray.end(), compareNames);
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002733 ArrayType *ATy = ArrayType::get(Int8PtrTy, UsedArray.size());
Rafael Espindola00752162013-05-09 17:22:59 +00002734
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002735 Module *M = V.getParent();
2736 V.removeFromParent();
2737 GlobalVariable *NV =
2738 new GlobalVariable(*M, ATy, false, llvm::GlobalValue::AppendingLinkage,
2739 llvm::ConstantArray::get(ATy, UsedArray), "");
2740 NV->takeName(&V);
2741 NV->setSection("llvm.metadata");
2742 delete &V;
Rafael Espindola00752162013-05-09 17:22:59 +00002743}
2744
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002745namespace {
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002746/// \brief An easy to access representation of llvm.used and llvm.compiler.used.
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002747class LLVMUsed {
2748 SmallPtrSet<GlobalValue *, 8> Used;
2749 SmallPtrSet<GlobalValue *, 8> CompilerUsed;
2750 GlobalVariable *UsedV;
2751 GlobalVariable *CompilerUsedV;
2752
2753public:
Rafael Espindolaec2375f2013-07-25 02:50:08 +00002754 LLVMUsed(Module &M) {
Rafael Espindola17600e22013-07-25 03:23:25 +00002755 UsedV = collectUsedGlobalVariables(M, Used, false);
2756 CompilerUsedV = collectUsedGlobalVariables(M, CompilerUsed, true);
Rafael Espindola00752162013-05-09 17:22:59 +00002757 }
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002758 typedef SmallPtrSet<GlobalValue *, 8>::iterator iterator;
Craig Topper46276792014-08-24 23:23:06 +00002759 typedef iterator_range<iterator> used_iterator_range;
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002760 iterator usedBegin() { return Used.begin(); }
2761 iterator usedEnd() { return Used.end(); }
Craig Topper46276792014-08-24 23:23:06 +00002762 used_iterator_range used() {
2763 return used_iterator_range(usedBegin(), usedEnd());
2764 }
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002765 iterator compilerUsedBegin() { return CompilerUsed.begin(); }
2766 iterator compilerUsedEnd() { return CompilerUsed.end(); }
Craig Topper46276792014-08-24 23:23:06 +00002767 used_iterator_range compilerUsed() {
2768 return used_iterator_range(compilerUsedBegin(), compilerUsedEnd());
2769 }
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002770 bool usedCount(GlobalValue *GV) const { return Used.count(GV); }
2771 bool compilerUsedCount(GlobalValue *GV) const {
2772 return CompilerUsed.count(GV);
2773 }
2774 bool usedErase(GlobalValue *GV) { return Used.erase(GV); }
2775 bool compilerUsedErase(GlobalValue *GV) { return CompilerUsed.erase(GV); }
David Blaikie70573dc2014-11-19 07:49:26 +00002776 bool usedInsert(GlobalValue *GV) { return Used.insert(GV).second; }
2777 bool compilerUsedInsert(GlobalValue *GV) {
2778 return CompilerUsed.insert(GV).second;
2779 }
Rafael Espindola00752162013-05-09 17:22:59 +00002780
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002781 void syncVariablesAndSets() {
2782 if (UsedV)
2783 setUsedInitializer(*UsedV, Used);
2784 if (CompilerUsedV)
2785 setUsedInitializer(*CompilerUsedV, CompilerUsed);
2786 }
2787};
Rafael Espindola00752162013-05-09 17:22:59 +00002788}
2789
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002790static bool hasUseOtherThanLLVMUsed(GlobalAlias &GA, const LLVMUsed &U) {
2791 if (GA.use_empty()) // No use at all.
2792 return false;
2793
2794 assert((!U.usedCount(&GA) || !U.compilerUsedCount(&GA)) &&
2795 "We should have removed the duplicated "
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002796 "element from llvm.compiler.used");
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002797 if (!GA.hasOneUse())
2798 // Strictly more than one use. So at least one is not in llvm.used and
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002799 // llvm.compiler.used.
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002800 return true;
2801
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002802 // Exactly one use. Check if it is in llvm.used or llvm.compiler.used.
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002803 return !U.usedCount(&GA) && !U.compilerUsedCount(&GA);
Rafael Espindola00752162013-05-09 17:22:59 +00002804}
2805
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002806static bool hasMoreThanOneUseOtherThanLLVMUsed(GlobalValue &V,
2807 const LLVMUsed &U) {
2808 unsigned N = 2;
2809 assert((!U.usedCount(&V) || !U.compilerUsedCount(&V)) &&
2810 "We should have removed the duplicated "
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002811 "element from llvm.compiler.used");
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002812 if (U.usedCount(&V) || U.compilerUsedCount(&V))
2813 ++N;
2814 return V.hasNUsesOrMore(N);
2815}
2816
2817static bool mayHaveOtherReferences(GlobalAlias &GA, const LLVMUsed &U) {
2818 if (!GA.hasLocalLinkage())
2819 return true;
2820
2821 return U.usedCount(&GA) || U.compilerUsedCount(&GA);
2822}
2823
Craig Topper71b7b682014-08-21 05:55:13 +00002824static bool hasUsesToReplace(GlobalAlias &GA, const LLVMUsed &U,
2825 bool &RenameTarget) {
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002826 RenameTarget = false;
Rafael Espindola00752162013-05-09 17:22:59 +00002827 bool Ret = false;
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002828 if (hasUseOtherThanLLVMUsed(GA, U))
Rafael Espindola00752162013-05-09 17:22:59 +00002829 Ret = true;
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002830
2831 // If the alias is externally visible, we may still be able to simplify it.
2832 if (!mayHaveOtherReferences(GA, U))
2833 return Ret;
2834
2835 // If the aliasee has internal linkage, give it the name and linkage
2836 // of the alias, and delete the alias. This turns:
2837 // define internal ... @f(...)
2838 // @a = alias ... @f
2839 // into:
2840 // define ... @a(...)
2841 Constant *Aliasee = GA.getAliasee();
2842 GlobalValue *Target = cast<GlobalValue>(Aliasee->stripPointerCasts());
2843 if (!Target->hasLocalLinkage())
2844 return Ret;
2845
2846 // Do not perform the transform if multiple aliases potentially target the
2847 // aliasee. This check also ensures that it is safe to replace the section
2848 // and other attributes of the aliasee with those of the alias.
2849 if (hasMoreThanOneUseOtherThanLLVMUsed(*Target, U))
2850 return Ret;
2851
2852 RenameTarget = true;
2853 return true;
Rafael Espindola00752162013-05-09 17:22:59 +00002854}
2855
Duncan Sandsed722832009-03-06 10:21:56 +00002856bool GlobalOpt::OptimizeGlobalAliases(Module &M) {
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00002857 bool Changed = false;
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002858 LLVMUsed Used(M);
2859
Craig Topper46276792014-08-24 23:23:06 +00002860 for (GlobalValue *GV : Used.used())
2861 Used.compilerUsedErase(GV);
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00002862
Duncan Sands0bcf0852009-01-07 20:01:06 +00002863 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
Duncan Sandsb3f27882009-02-15 09:56:08 +00002864 I != E;) {
2865 Module::alias_iterator J = I++;
Duncan Sandsed722832009-03-06 10:21:56 +00002866 // Aliases without names cannot be referenced outside this module.
David Majnemer5c921152014-07-01 15:26:50 +00002867 if (!J->hasName() && !J->isDeclaration() && !J->hasLocalLinkage())
Duncan Sandsed722832009-03-06 10:21:56 +00002868 J->setLinkage(GlobalValue::InternalLinkage);
Duncan Sandsb3f27882009-02-15 09:56:08 +00002869 // If the aliasee may change at link time, nothing can be done - bail out.
2870 if (J->mayBeOverridden())
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00002871 continue;
2872
Duncan Sandsb3f27882009-02-15 09:56:08 +00002873 Constant *Aliasee = J->getAliasee();
David Majnemer0e2cc2a2014-07-01 00:30:56 +00002874 GlobalValue *Target = dyn_cast<GlobalValue>(Aliasee->stripPointerCasts());
2875 // We can't trivially replace the alias with the aliasee if the aliasee is
2876 // non-trivial in some way.
2877 // TODO: Try to handle non-zero GEPs of local aliasees.
2878 if (!Target)
2879 continue;
Duncan Sands7a1db332009-02-18 17:55:38 +00002880 Target->removeDeadConstantUsers();
Duncan Sandsb3f27882009-02-15 09:56:08 +00002881
2882 // Make all users of the alias use the aliasee instead.
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002883 bool RenameTarget;
2884 if (!hasUsesToReplace(*J, Used, RenameTarget))
Rafael Espindola00752162013-05-09 17:22:59 +00002885 continue;
Duncan Sandsb3f27882009-02-15 09:56:08 +00002886
Rafael Espindola6b238632014-05-16 19:35:39 +00002887 J->replaceAllUsesWith(ConstantExpr::getBitCast(Aliasee, J->getType()));
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002888 ++NumAliasesResolved;
2889 Changed = true;
Duncan Sandsb3f27882009-02-15 09:56:08 +00002890
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002891 if (RenameTarget) {
Duncan Sands6a3df7b2009-12-08 10:10:20 +00002892 // Give the aliasee the name, linkage and other attributes of the alias.
2893 Target->takeName(J);
2894 Target->setLinkage(J->getLinkage());
Reid Kleckner22b19da2014-02-13 02:18:36 +00002895 Target->setVisibility(J->getVisibility());
2896 Target->setDLLStorageClass(J->getDLLStorageClass());
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002897
2898 if (Used.usedErase(J))
2899 Used.usedInsert(Target);
2900
2901 if (Used.compilerUsedErase(J))
2902 Used.compilerUsedInsert(Target);
Rafael Espindola8d304802013-06-12 16:45:47 +00002903 } else if (mayHaveOtherReferences(*J, Used))
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002904 continue;
2905
Duncan Sandsb3f27882009-02-15 09:56:08 +00002906 // Delete the alias.
2907 M.getAliasList().erase(J);
2908 ++NumAliasesRemoved;
2909 Changed = true;
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00002910 }
2911
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002912 Used.syncVariablesAndSets();
2913
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00002914 return Changed;
2915}
Chris Lattner41b6a5a2005-09-26 01:43:45 +00002916
Nick Lewycky4b273cb2012-02-12 02:15:20 +00002917static Function *FindCXAAtExit(Module &M, TargetLibraryInfo *TLI) {
2918 if (!TLI->has(LibFunc::cxa_atexit))
Craig Topperf40110f2014-04-25 05:29:35 +00002919 return nullptr;
Nick Lewycky4b273cb2012-02-12 02:15:20 +00002920
2921 Function *Fn = M.getFunction(TLI->getName(LibFunc::cxa_atexit));
Jakub Staszak9525a772012-12-06 21:57:16 +00002922
Anders Carlssonee6bc702011-03-20 17:59:11 +00002923 if (!Fn)
Craig Topperf40110f2014-04-25 05:29:35 +00002924 return nullptr;
Nick Lewycky4b273cb2012-02-12 02:15:20 +00002925
Chris Lattner229907c2011-07-18 04:54:35 +00002926 FunctionType *FTy = Fn->getFunctionType();
Jakub Staszak9525a772012-12-06 21:57:16 +00002927
2928 // Checking that the function has the right return type, the right number of
Anders Carlsson48a44912011-03-20 19:51:13 +00002929 // parameters and that they all have pointer types should be enough.
2930 if (!FTy->getReturnType()->isIntegerTy() ||
2931 FTy->getNumParams() != 3 ||
Anders Carlssonee6bc702011-03-20 17:59:11 +00002932 !FTy->getParamType(0)->isPointerTy() ||
2933 !FTy->getParamType(1)->isPointerTy() ||
2934 !FTy->getParamType(2)->isPointerTy())
Craig Topperf40110f2014-04-25 05:29:35 +00002935 return nullptr;
Anders Carlssonee6bc702011-03-20 17:59:11 +00002936
2937 return Fn;
2938}
2939
2940/// cxxDtorIsEmpty - Returns whether the given function is an empty C++
2941/// destructor and can therefore be eliminated.
2942/// Note that we assume that other optimization passes have already simplified
2943/// the code so we only look for a function with a single basic block, where
Benjamin Kramer1a4695a2012-02-09 16:28:15 +00002944/// the only allowed instructions are 'ret', 'call' to an empty C++ dtor and
2945/// other side-effect free instructions.
Anders Carlssonfcec2f52011-03-20 20:16:43 +00002946static bool cxxDtorIsEmpty(const Function &Fn,
2947 SmallPtrSet<const Function *, 8> &CalledFunctions) {
Anders Carlsson48a44912011-03-20 19:51:13 +00002948 // FIXME: We could eliminate C++ destructors if they're readonly/readnone and
Nick Lewyckyd0781832011-03-21 02:26:01 +00002949 // nounwind, but that doesn't seem worth doing.
Anders Carlsson48a44912011-03-20 19:51:13 +00002950 if (Fn.isDeclaration())
2951 return false;
Anders Carlssonee6bc702011-03-20 17:59:11 +00002952
2953 if (++Fn.begin() != Fn.end())
2954 return false;
2955
2956 const BasicBlock &EntryBlock = Fn.getEntryBlock();
2957 for (BasicBlock::const_iterator I = EntryBlock.begin(), E = EntryBlock.end();
2958 I != E; ++I) {
2959 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
Anders Carlsson4dd420f2011-03-21 14:54:40 +00002960 // Ignore debug intrinsics.
2961 if (isa<DbgInfoIntrinsic>(CI))
2962 continue;
2963
Anders Carlssonee6bc702011-03-20 17:59:11 +00002964 const Function *CalledFn = CI->getCalledFunction();
2965
2966 if (!CalledFn)
2967 return false;
2968
Anders Carlsson1cc80732011-03-22 03:21:01 +00002969 SmallPtrSet<const Function *, 8> NewCalledFunctions(CalledFunctions);
2970
Anders Carlsson48a44912011-03-20 19:51:13 +00002971 // Don't treat recursive functions as empty.
David Blaikie70573dc2014-11-19 07:49:26 +00002972 if (!NewCalledFunctions.insert(CalledFn).second)
Anders Carlsson48a44912011-03-20 19:51:13 +00002973 return false;
2974
Anders Carlsson1cc80732011-03-22 03:21:01 +00002975 if (!cxxDtorIsEmpty(*CalledFn, NewCalledFunctions))
Anders Carlssonee6bc702011-03-20 17:59:11 +00002976 return false;
2977 } else if (isa<ReturnInst>(*I))
Benjamin Kramer487a3962012-02-09 14:26:06 +00002978 return true; // We're done.
2979 else if (I->mayHaveSideEffects())
2980 return false; // Destructor with side effects, bail.
Anders Carlssonee6bc702011-03-20 17:59:11 +00002981 }
2982
2983 return false;
2984}
2985
2986bool GlobalOpt::OptimizeEmptyGlobalCXXDtors(Function *CXAAtExitFn) {
2987 /// Itanium C++ ABI p3.3.5:
2988 ///
2989 /// After constructing a global (or local static) object, that will require
2990 /// destruction on exit, a termination function is registered as follows:
2991 ///
2992 /// extern "C" int __cxa_atexit ( void (*f)(void *), void *p, void *d );
2993 ///
2994 /// This registration, e.g. __cxa_atexit(f,p,d), is intended to cause the
2995 /// call f(p) when DSO d is unloaded, before all such termination calls
2996 /// registered before this one. It returns zero if registration is
Nick Lewyckyd0781832011-03-21 02:26:01 +00002997 /// successful, nonzero on failure.
Anders Carlssonee6bc702011-03-20 17:59:11 +00002998
2999 // This pass will look for calls to __cxa_atexit where the function is trivial
3000 // and remove them.
3001 bool Changed = false;
3002
Chandler Carruthcdf47882014-03-09 03:16:01 +00003003 for (auto I = CXAAtExitFn->user_begin(), E = CXAAtExitFn->user_end();
3004 I != E;) {
Anders Carlsson336fd902011-03-20 20:21:33 +00003005 // We're only interested in calls. Theoretically, we could handle invoke
3006 // instructions as well, but neither llvm-gcc nor clang generate invokes
3007 // to __cxa_atexit.
Anders Carlsson4dd420f2011-03-21 14:54:40 +00003008 CallInst *CI = dyn_cast<CallInst>(*I++);
3009 if (!CI)
Anders Carlsson336fd902011-03-20 20:21:33 +00003010 continue;
3011
Jakub Staszak9525a772012-12-06 21:57:16 +00003012 Function *DtorFn =
Anders Carlsson4dd420f2011-03-21 14:54:40 +00003013 dyn_cast<Function>(CI->getArgOperand(0)->stripPointerCasts());
Anders Carlssonee6bc702011-03-20 17:59:11 +00003014 if (!DtorFn)
3015 continue;
3016
Anders Carlssonfcec2f52011-03-20 20:16:43 +00003017 SmallPtrSet<const Function *, 8> CalledFunctions;
3018 if (!cxxDtorIsEmpty(*DtorFn, CalledFunctions))
Anders Carlssonee6bc702011-03-20 17:59:11 +00003019 continue;
3020
3021 // Just remove the call.
Anders Carlsson4dd420f2011-03-21 14:54:40 +00003022 CI->replaceAllUsesWith(Constant::getNullValue(CI->getType()));
3023 CI->eraseFromParent();
Anders Carlsson48a44912011-03-20 19:51:13 +00003024
Anders Carlssonee6bc702011-03-20 17:59:11 +00003025 ++NumCXXDtorsRemoved;
3026
3027 Changed |= true;
3028 }
3029
3030 return Changed;
3031}
3032
Chris Lattner25db5802004-10-07 04:16:33 +00003033bool GlobalOpt::runOnModule(Module &M) {
3034 bool Changed = false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003035
Mehdi Amini46a43552015-03-04 18:43:29 +00003036 auto &DL = M.getDataLayout();
Chandler Carruthb98f63d2015-01-15 10:41:28 +00003037 TLI = &getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
Nick Lewyckycf6aae62012-02-12 01:13:18 +00003038
Chris Lattner25db5802004-10-07 04:16:33 +00003039 bool LocalChange = true;
3040 while (LocalChange) {
3041 LocalChange = false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003042
David Majnemer1b3b70e2014-10-08 07:23:31 +00003043 NotDiscardableComdats.clear();
3044 for (const GlobalVariable &GV : M.globals())
3045 if (const Comdat *C = GV.getComdat())
3046 if (!GV.isDiscardableIfUnused() || !GV.use_empty())
3047 NotDiscardableComdats.insert(C);
3048 for (Function &F : M)
3049 if (const Comdat *C = F.getComdat())
3050 if (!F.isDefTriviallyDead())
3051 NotDiscardableComdats.insert(C);
3052 for (GlobalAlias &GA : M.aliases())
3053 if (const Comdat *C = GA.getComdat())
3054 if (!GA.isDiscardableIfUnused() || !GA.use_empty())
3055 NotDiscardableComdats.insert(C);
3056
Chris Lattner41b6a5a2005-09-26 01:43:45 +00003057 // Delete functions that are trivially dead, ccc -> fastcc
3058 LocalChange |= OptimizeFunctions(M);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003059
Chris Lattner41b6a5a2005-09-26 01:43:45 +00003060 // Optimize global_ctors list.
Richard Smithc167d652014-05-06 01:44:26 +00003061 LocalChange |= optimizeGlobalCtorsList(M, [&](Function *F) {
3062 return EvaluateStaticConstructor(F, DL, TLI);
3063 });
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003064
Chris Lattner41b6a5a2005-09-26 01:43:45 +00003065 // Optimize non-address-taken globals.
3066 LocalChange |= OptimizeGlobalVars(M);
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00003067
3068 // Resolve aliases, when possible.
Duncan Sandsed722832009-03-06 10:21:56 +00003069 LocalChange |= OptimizeGlobalAliases(M);
Anders Carlssonee6bc702011-03-20 17:59:11 +00003070
Manman Renb3c52fb2013-05-14 21:52:44 +00003071 // Try to remove trivial global destructors if they are not removed
3072 // already.
3073 Function *CXAAtExitFn = FindCXAAtExit(M, TLI);
Anders Carlssonee6bc702011-03-20 17:59:11 +00003074 if (CXAAtExitFn)
3075 LocalChange |= OptimizeEmptyGlobalCXXDtors(CXAAtExitFn);
3076
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00003077 Changed |= LocalChange;
Chris Lattner25db5802004-10-07 04:16:33 +00003078 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003079
Chris Lattner41b6a5a2005-09-26 01:43:45 +00003080 // TODO: Move all global ctors functions to the end of the module for code
3081 // layout.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003082
Chris Lattner25db5802004-10-07 04:16:33 +00003083 return Changed;
3084}