blob: c60b3ccc29884fb770b65d503745ec60a273f686 [file] [log] [blame]
Chris Lattner25db5802004-10-07 04:16:33 +00001//===- GlobalOpt.cpp - Optimize Global Variables --------------------------===//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
Chris Lattner25db5802004-10-07 04:16:33 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanb1c93172005-04-21 23:48:37 +00007//
Chris Lattner25db5802004-10-07 04:16:33 +00008//===----------------------------------------------------------------------===//
9//
10// This pass transforms simple global variables that never have their address
11// taken. If obviously true, it marks read/write globals as constant, deletes
12// variables only stored to, etc.
13//
14//===----------------------------------------------------------------------===//
15
Chris Lattner25db5802004-10-07 04:16:33 +000016#include "llvm/Transforms/IPO.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000017#include "llvm/ADT/DenseMap.h"
18#include "llvm/ADT/STLExtras.h"
19#include "llvm/ADT/SmallPtrSet.h"
David Majnemerdad0a642014-06-27 18:19:56 +000020#include "llvm/ADT/SmallSet.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000021#include "llvm/ADT/SmallVector.h"
22#include "llvm/ADT/Statistic.h"
23#include "llvm/Analysis/ConstantFolding.h"
24#include "llvm/Analysis/MemoryBuiltins.h"
Benjamin Kramer799003b2015-03-23 19:32:43 +000025#include "llvm/Analysis/TargetLibraryInfo.h"
Chandler Carruth219b89b2014-03-04 11:01:28 +000026#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000027#include "llvm/IR/CallingConv.h"
28#include "llvm/IR/Constants.h"
29#include "llvm/IR/DataLayout.h"
30#include "llvm/IR/DerivedTypes.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000031#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000032#include "llvm/IR/Instructions.h"
33#include "llvm/IR/IntrinsicInst.h"
34#include "llvm/IR/Module.h"
35#include "llvm/IR/Operator.h"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000036#include "llvm/IR/ValueHandle.h"
Chris Lattner25db5802004-10-07 04:16:33 +000037#include "llvm/Pass.h"
Chris Lattner024f4ab2007-01-30 23:46:24 +000038#include "llvm/Support/Debug.h"
Torok Edwin56d06592009-07-11 20:10:48 +000039#include "llvm/Support/ErrorHandling.h"
Chris Lattner67ca6f632008-04-26 07:40:11 +000040#include "llvm/Support/MathExtras.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000041#include "llvm/Support/raw_ostream.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 };
Alexander Kornienkof00654e2015-06-23 09:49:53 +000092}
Chris Lattner25db5802004-10-07 04:16:33 +000093
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];
David Blaikied9d900c2015-05-07 17:28:58 +0000567 Type *NewTy = NewGlobals[Val]->getValueType();
Chris Lattnerabab0712004-10-08 17:32:09 +0000568
569 // Form a shorter GEP if needed.
Anton Korobeynikov1bfd1212008-02-20 11:26:25 +0000570 if (GEP->getNumOperands() > 3) {
Chris Lattner004e2502004-10-11 05:54:41 +0000571 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEP)) {
Chris Lattnerf96f4a82007-01-31 04:40:53 +0000572 SmallVector<Constant*, 8> Idxs;
Chris Lattner004e2502004-10-11 05:54:41 +0000573 Idxs.push_back(NullInt);
574 for (unsigned i = 3, e = CE->getNumOperands(); i != e; ++i)
575 Idxs.push_back(CE->getOperand(i));
David Blaikie4a2e73b2015-04-02 18:55:32 +0000576 NewPtr =
577 ConstantExpr::getGetElementPtr(NewTy, cast<Constant>(NewPtr), Idxs);
Chris Lattner004e2502004-10-11 05:54:41 +0000578 } else {
579 GetElementPtrInst *GEPI = cast<GetElementPtrInst>(GEP);
Chris Lattner927653f2007-01-31 19:59:55 +0000580 SmallVector<Value*, 8> Idxs;
Chris Lattner004e2502004-10-11 05:54:41 +0000581 Idxs.push_back(NullInt);
582 for (unsigned i = 3, e = GEPI->getNumOperands(); i != e; ++i)
583 Idxs.push_back(GEPI->getOperand(i));
David Blaikie741c8f82015-03-14 01:53:18 +0000584 NewPtr = GetElementPtrInst::Create(
David Blaikied9d900c2015-05-07 17:28:58 +0000585 NewTy, NewPtr, Idxs, GEPI->getName() + "." + Twine(Val), GEPI);
Chris Lattner004e2502004-10-11 05:54:41 +0000586 }
Anton Korobeynikov1bfd1212008-02-20 11:26:25 +0000587 }
Chris Lattner004e2502004-10-11 05:54:41 +0000588 GEP->replaceAllUsesWith(NewPtr);
589
590 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(GEP))
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000591 GEPI->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000592 else
593 cast<ConstantExpr>(GEP)->destroyConstant();
Chris Lattnerabab0712004-10-08 17:32:09 +0000594 }
595
Chris Lattner73ad73e2004-10-08 20:25:55 +0000596 // Delete the old global, now that it is dead.
597 Globals.erase(GV);
Chris Lattnerabab0712004-10-08 17:32:09 +0000598 ++NumSRA;
Chris Lattner004e2502004-10-11 05:54:41 +0000599
600 // Loop over the new globals array deleting any globals that are obviously
601 // dead. This can arise due to scalarization of a structure or an array that
602 // has elements that are dead.
603 unsigned FirstGlobal = 0;
604 for (unsigned i = 0, e = NewGlobals.size(); i != e; ++i)
605 if (NewGlobals[i]->use_empty()) {
606 Globals.erase(NewGlobals[i]);
607 if (FirstGlobal == i) ++FirstGlobal;
608 }
609
Craig Topperf40110f2014-04-25 05:29:35 +0000610 return FirstGlobal != NewGlobals.size() ? NewGlobals[FirstGlobal] : nullptr;
Chris Lattnerabab0712004-10-08 17:32:09 +0000611}
612
Chris Lattner09a52722004-10-09 21:48:45 +0000613/// AllUsesOfValueWillTrapIfNull - Return true if all users of the specified
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000614/// value will trap if the value is dynamically null. PHIs keeps track of any
Chris Lattner2d2892e2007-09-13 16:30:19 +0000615/// phi nodes we've seen to avoid reprocessing them.
Gabor Greif67972872010-04-06 19:24:18 +0000616static bool AllUsesOfValueWillTrapIfNull(const Value *V,
Craig Topper71b7b682014-08-21 05:55:13 +0000617 SmallPtrSetImpl<const PHINode*> &PHIs) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000618 for (const User *U : V->users())
Gabor Greif08355d62010-04-06 19:14:05 +0000619 if (isa<LoadInst>(U)) {
Chris Lattner09a52722004-10-09 21:48:45 +0000620 // Will trap.
Gabor Greif67972872010-04-06 19:24:18 +0000621 } else if (const StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattner09a52722004-10-09 21:48:45 +0000622 if (SI->getOperand(0) == V) {
Gabor Greif08355d62010-04-06 19:14:05 +0000623 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000624 return false; // Storing the value.
625 }
Gabor Greif67972872010-04-06 19:24:18 +0000626 } else if (const CallInst *CI = dyn_cast<CallInst>(U)) {
Gabor Greiffebf6ab2010-03-20 21:00:25 +0000627 if (CI->getCalledValue() != V) {
Gabor Greif08355d62010-04-06 19:14:05 +0000628 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000629 return false; // Not calling the ptr
630 }
Gabor Greif67972872010-04-06 19:24:18 +0000631 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(U)) {
Gabor Greiffebf6ab2010-03-20 21:00:25 +0000632 if (II->getCalledValue() != V) {
Gabor Greif08355d62010-04-06 19:14:05 +0000633 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000634 return false; // Not calling the ptr
635 }
Gabor Greif67972872010-04-06 19:24:18 +0000636 } else if (const BitCastInst *CI = dyn_cast<BitCastInst>(U)) {
Chris Lattner2d2892e2007-09-13 16:30:19 +0000637 if (!AllUsesOfValueWillTrapIfNull(CI, PHIs)) return false;
Gabor Greif67972872010-04-06 19:24:18 +0000638 } else if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner2d2892e2007-09-13 16:30:19 +0000639 if (!AllUsesOfValueWillTrapIfNull(GEPI, PHIs)) return false;
Gabor Greif67972872010-04-06 19:24:18 +0000640 } else if (const PHINode *PN = dyn_cast<PHINode>(U)) {
Chris Lattner2d2892e2007-09-13 16:30:19 +0000641 // If we've already seen this phi node, ignore it, it has already been
642 // checked.
David Blaikie70573dc2014-11-19 07:49:26 +0000643 if (PHIs.insert(PN).second && !AllUsesOfValueWillTrapIfNull(PN, PHIs))
Jakob Stoklund Olesene27dc722010-01-29 23:54:14 +0000644 return false;
Gabor Greif08355d62010-04-06 19:14:05 +0000645 } else if (isa<ICmpInst>(U) &&
Chandler Carruthcdf47882014-03-09 03:16:01 +0000646 isa<ConstantPointerNull>(U->getOperand(1))) {
Nick Lewycky614fb942010-02-25 06:39:10 +0000647 // Ignore icmp X, null
Chris Lattner09a52722004-10-09 21:48:45 +0000648 } else {
Gabor Greif08355d62010-04-06 19:14:05 +0000649 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000650 return false;
651 }
Chandler Carruthcdf47882014-03-09 03:16:01 +0000652
Chris Lattner09a52722004-10-09 21:48:45 +0000653 return true;
654}
655
656/// AllUsesOfLoadedValueWillTrapIfNull - Return true if all uses of any loads
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000657/// from GV will trap if the loaded value is null. Note that this also permits
658/// comparisons of the loaded value against null, as a special case.
Gabor Greif67972872010-04-06 19:24:18 +0000659static bool AllUsesOfLoadedValueWillTrapIfNull(const GlobalVariable *GV) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000660 for (const User *U : GV->users())
Gabor Greif67972872010-04-06 19:24:18 +0000661 if (const LoadInst *LI = dyn_cast<LoadInst>(U)) {
662 SmallPtrSet<const PHINode*, 8> PHIs;
Chris Lattner2d2892e2007-09-13 16:30:19 +0000663 if (!AllUsesOfValueWillTrapIfNull(LI, PHIs))
Chris Lattner09a52722004-10-09 21:48:45 +0000664 return false;
Gabor Greif08355d62010-04-06 19:14:05 +0000665 } else if (isa<StoreInst>(U)) {
Chris Lattner09a52722004-10-09 21:48:45 +0000666 // Ignore stores to the global.
667 } else {
668 // We don't know or understand this user, bail out.
Gabor Greif08355d62010-04-06 19:14:05 +0000669 //cerr << "UNKNOWN USER OF GLOBAL!: " << *U;
Chris Lattner09a52722004-10-09 21:48:45 +0000670 return false;
671 }
Chris Lattner09a52722004-10-09 21:48:45 +0000672 return true;
673}
674
Chris Lattner46b5c642009-11-06 04:27:31 +0000675static bool OptimizeAwayTrappingUsesOfValue(Value *V, Constant *NewV) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000676 bool Changed = false;
Chandler Carruthcdf47882014-03-09 03:16:01 +0000677 for (auto UI = V->user_begin(), E = V->user_end(); UI != E; ) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000678 Instruction *I = cast<Instruction>(*UI++);
679 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
680 LI->setOperand(0, NewV);
681 Changed = true;
682 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
683 if (SI->getOperand(1) == V) {
684 SI->setOperand(1, NewV);
685 Changed = true;
686 }
687 } else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
Gabor Greif04397892010-04-06 18:45:08 +0000688 CallSite CS(I);
689 if (CS.getCalledValue() == V) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000690 // Calling through the pointer! Turn into a direct call, but be careful
691 // that the pointer is not also being passed as an argument.
Gabor Greif04397892010-04-06 18:45:08 +0000692 CS.setCalledFunction(NewV);
Chris Lattnere42eb312004-10-10 23:14:11 +0000693 Changed = true;
694 bool PassedAsArg = false;
Gabor Greif04397892010-04-06 18:45:08 +0000695 for (unsigned i = 0, e = CS.arg_size(); i != e; ++i)
696 if (CS.getArgument(i) == V) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000697 PassedAsArg = true;
Gabor Greif04397892010-04-06 18:45:08 +0000698 CS.setArgument(i, NewV);
Chris Lattnere42eb312004-10-10 23:14:11 +0000699 }
700
701 if (PassedAsArg) {
702 // Being passed as an argument also. Be careful to not invalidate UI!
Chandler Carruthcdf47882014-03-09 03:16:01 +0000703 UI = V->user_begin();
Chris Lattnere42eb312004-10-10 23:14:11 +0000704 }
705 }
706 } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
707 Changed |= OptimizeAwayTrappingUsesOfValue(CI,
Owen Anderson487375e2009-07-29 18:55:55 +0000708 ConstantExpr::getCast(CI->getOpcode(),
Chris Lattner46b5c642009-11-06 04:27:31 +0000709 NewV, CI->getType()));
Chris Lattnere42eb312004-10-10 23:14:11 +0000710 if (CI->use_empty()) {
711 Changed = true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000712 CI->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000713 }
714 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
715 // Should handle GEP here.
Chris Lattnerf96f4a82007-01-31 04:40:53 +0000716 SmallVector<Constant*, 8> Idxs;
717 Idxs.reserve(GEPI->getNumOperands()-1);
Gabor Greif3a9fba52008-05-29 01:59:18 +0000718 for (User::op_iterator i = GEPI->op_begin() + 1, e = GEPI->op_end();
719 i != e; ++i)
720 if (Constant *C = dyn_cast<Constant>(*i))
Chris Lattnerf96f4a82007-01-31 04:40:53 +0000721 Idxs.push_back(C);
Chris Lattnere42eb312004-10-10 23:14:11 +0000722 else
723 break;
Chris Lattnerf96f4a82007-01-31 04:40:53 +0000724 if (Idxs.size() == GEPI->getNumOperands()-1)
David Blaikie4a2e73b2015-04-02 18:55:32 +0000725 Changed |= OptimizeAwayTrappingUsesOfValue(
726 GEPI, ConstantExpr::getGetElementPtr(nullptr, NewV, Idxs));
Chris Lattnere42eb312004-10-10 23:14:11 +0000727 if (GEPI->use_empty()) {
728 Changed = true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000729 GEPI->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000730 }
731 }
732 }
733
734 return Changed;
735}
736
737
738/// OptimizeAwayTrappingUsesOfLoads - The specified global has only one non-null
739/// value stored into it. If there are uses of the loaded value that would trap
740/// if the loaded value is dynamically null, then we know that they cannot be
741/// reachable with a null optimize away the load.
Nick Lewyckycf6aae62012-02-12 01:13:18 +0000742static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV,
Mehdi Amini46a43552015-03-04 18:43:29 +0000743 const DataLayout &DL,
Nick Lewyckycf6aae62012-02-12 01:13:18 +0000744 TargetLibraryInfo *TLI) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000745 bool Changed = false;
746
Chris Lattner2538eb62009-01-14 00:12:58 +0000747 // Keep track of whether we are able to remove all the uses of the global
748 // other than the store that defines it.
749 bool AllNonStoreUsesGone = true;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000750
Chris Lattnere42eb312004-10-10 23:14:11 +0000751 // Replace all uses of loads with uses of uses of the stored value.
Chandler Carruthcdf47882014-03-09 03:16:01 +0000752 for (Value::user_iterator GUI = GV->user_begin(), E = GV->user_end(); GUI != E;){
Chris Lattner2538eb62009-01-14 00:12:58 +0000753 User *GlobalUser = *GUI++;
754 if (LoadInst *LI = dyn_cast<LoadInst>(GlobalUser)) {
Chris Lattner46b5c642009-11-06 04:27:31 +0000755 Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV);
Chris Lattner2538eb62009-01-14 00:12:58 +0000756 // If we were able to delete all uses of the loads
757 if (LI->use_empty()) {
758 LI->eraseFromParent();
759 Changed = true;
760 } else {
761 AllNonStoreUsesGone = false;
762 }
763 } else if (isa<StoreInst>(GlobalUser)) {
764 // Ignore the store that stores "LV" to the global.
765 assert(GlobalUser->getOperand(1) == GV &&
766 "Must be storing *to* the global");
Chris Lattnere42eb312004-10-10 23:14:11 +0000767 } else {
Chris Lattner2538eb62009-01-14 00:12:58 +0000768 AllNonStoreUsesGone = false;
769
770 // If we get here we could have other crazy uses that are transitively
771 // loaded.
772 assert((isa<PHINode>(GlobalUser) || isa<SelectInst>(GlobalUser) ||
Benjamin Kramered843602012-09-28 10:01:27 +0000773 isa<ConstantExpr>(GlobalUser) || isa<CmpInst>(GlobalUser) ||
774 isa<BitCastInst>(GlobalUser) ||
775 isa<GetElementPtrInst>(GlobalUser)) &&
Chris Lattner1a1acc22011-05-22 07:15:13 +0000776 "Only expect load and stores!");
Chris Lattnere42eb312004-10-10 23:14:11 +0000777 }
Chris Lattner2538eb62009-01-14 00:12:58 +0000778 }
Chris Lattnere42eb312004-10-10 23:14:11 +0000779
780 if (Changed) {
David Greene44cb8ad2010-01-05 01:28:05 +0000781 DEBUG(dbgs() << "OPTIMIZED LOADS FROM STORED ONCE POINTER: " << *GV);
Chris Lattnere42eb312004-10-10 23:14:11 +0000782 ++NumGlobUses;
783 }
784
Chris Lattnere42eb312004-10-10 23:14:11 +0000785 // If we nuked all of the loads, then none of the stores are needed either,
786 // nor is the global.
Chris Lattner2538eb62009-01-14 00:12:58 +0000787 if (AllNonStoreUsesGone) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000788 if (isLeakCheckerRoot(GV)) {
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000789 Changed |= CleanupPointerRootUsers(GV, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000790 } else {
791 Changed = true;
Craig Topperf40110f2014-04-25 05:29:35 +0000792 CleanupConstantGlobalUsers(GV, nullptr, DL, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000793 }
Chris Lattnere42eb312004-10-10 23:14:11 +0000794 if (GV->use_empty()) {
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +0000795 DEBUG(dbgs() << " *** GLOBAL NOW DEAD!\n");
796 Changed = true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000797 GV->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000798 ++NumDeleted;
799 }
Chris Lattnere42eb312004-10-10 23:14:11 +0000800 }
801 return Changed;
802}
803
Chris Lattner004e2502004-10-11 05:54:41 +0000804/// ConstantPropUsersOf - Walk the use list of V, constant folding all of the
805/// instructions that are foldable.
Mehdi Amini46a43552015-03-04 18:43:29 +0000806static void ConstantPropUsersOf(Value *V, const DataLayout &DL,
Rafael Espindolaaeff8a92014-02-24 23:12:18 +0000807 TargetLibraryInfo *TLI) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000808 for (Value::user_iterator UI = V->user_begin(), E = V->user_end(); UI != E; )
Chris Lattner004e2502004-10-11 05:54:41 +0000809 if (Instruction *I = dyn_cast<Instruction>(*UI++))
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000810 if (Constant *NewC = ConstantFoldInstruction(I, DL, TLI)) {
Chris Lattner004e2502004-10-11 05:54:41 +0000811 I->replaceAllUsesWith(NewC);
812
Chris Lattnerd6a44922005-02-01 01:23:31 +0000813 // Advance UI to the next non-I use to avoid invalidating it!
814 // Instructions could multiply use V.
815 while (UI != E && *UI == I)
Chris Lattner004e2502004-10-11 05:54:41 +0000816 ++UI;
Chris Lattnerd6a44922005-02-01 01:23:31 +0000817 I->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000818 }
819}
820
821/// OptimizeGlobalAddressOfMalloc - This function takes the specified global
822/// variable, and transforms the program as if it always contained the result of
823/// the specified malloc. Because it is always the result of the specified
824/// malloc, there is no reason to actually DO the malloc. Instead, turn the
Chris Lattner3ede00b2006-11-30 17:32:29 +0000825/// malloc into a global, and any loads of GV as uses of the new global.
Mehdi Amini46a43552015-03-04 18:43:29 +0000826static GlobalVariable *
827OptimizeGlobalAddressOfMalloc(GlobalVariable *GV, CallInst *CI, Type *AllocTy,
828 ConstantInt *NElements, const DataLayout &DL,
829 TargetLibraryInfo *TLI) {
Chris Lattner7939f792010-02-25 22:33:52 +0000830 DEBUG(errs() << "PROMOTING GLOBAL: " << *GV << " CALL = " << *CI << '\n');
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000831
Chris Lattner229907c2011-07-18 04:54:35 +0000832 Type *GlobalType;
Chris Lattner7939f792010-02-25 22:33:52 +0000833 if (NElements->getZExtValue() == 1)
834 GlobalType = AllocTy;
835 else
836 // If we have an array allocation, the global variable is of an array.
837 GlobalType = ArrayType::get(AllocTy, NElements->getZExtValue());
Victor Hernandez5d034492009-09-18 22:35:49 +0000838
839 // Create the new global variable. The contents of the malloc'd memory is
840 // undefined, so initialize with an undef value.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000841 GlobalVariable *NewGV = new GlobalVariable(*GV->getParent(),
Chris Lattner65d3a0a2010-02-26 23:42:13 +0000842 GlobalType, false,
Chris Lattner7939f792010-02-25 22:33:52 +0000843 GlobalValue::InternalLinkage,
Chris Lattner65d3a0a2010-02-26 23:42:13 +0000844 UndefValue::get(GlobalType),
Victor Hernandez5d034492009-09-18 22:35:49 +0000845 GV->getName()+".body",
846 GV,
Hans Wennborgcbe34b42012-06-23 11:37:03 +0000847 GV->getThreadLocalMode());
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000848
Chris Lattner7939f792010-02-25 22:33:52 +0000849 // If there are bitcast users of the malloc (which is typical, usually we have
850 // a malloc + bitcast) then replace them with uses of the new global. Update
851 // other users to use the global as well.
Craig Topperf40110f2014-04-25 05:29:35 +0000852 BitCastInst *TheBC = nullptr;
Chris Lattner7939f792010-02-25 22:33:52 +0000853 while (!CI->use_empty()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000854 Instruction *User = cast<Instruction>(CI->user_back());
Chris Lattner7939f792010-02-25 22:33:52 +0000855 if (BitCastInst *BCI = dyn_cast<BitCastInst>(User)) {
856 if (BCI->getType() == NewGV->getType()) {
857 BCI->replaceAllUsesWith(NewGV);
858 BCI->eraseFromParent();
859 } else {
860 BCI->setOperand(0, NewGV);
861 }
862 } else {
Craig Topperf40110f2014-04-25 05:29:35 +0000863 if (!TheBC)
Chris Lattner7939f792010-02-25 22:33:52 +0000864 TheBC = new BitCastInst(NewGV, CI->getType(), "newgv", CI);
865 User->replaceUsesOfWith(CI, TheBC);
866 }
867 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000868
Victor Hernandez5d034492009-09-18 22:35:49 +0000869 Constant *RepValue = NewGV;
870 if (NewGV->getType() != GV->getType()->getElementType())
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000871 RepValue = ConstantExpr::getBitCast(RepValue,
Victor Hernandez5d034492009-09-18 22:35:49 +0000872 GV->getType()->getElementType());
873
874 // If there is a comparison against null, we will insert a global bool to
875 // keep track of whether the global was initialized yet or not.
876 GlobalVariable *InitBool =
Chris Lattner46b5c642009-11-06 04:27:31 +0000877 new GlobalVariable(Type::getInt1Ty(GV->getContext()), false,
Victor Hernandez5d034492009-09-18 22:35:49 +0000878 GlobalValue::InternalLinkage,
Chris Lattner46b5c642009-11-06 04:27:31 +0000879 ConstantInt::getFalse(GV->getContext()),
Hans Wennborgcbe34b42012-06-23 11:37:03 +0000880 GV->getName()+".init", GV->getThreadLocalMode());
Victor Hernandez5d034492009-09-18 22:35:49 +0000881 bool InitBoolUsed = false;
882
883 // Loop over all uses of GV, processing them in turn.
Chris Lattner7939f792010-02-25 22:33:52 +0000884 while (!GV->use_empty()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000885 if (StoreInst *SI = dyn_cast<StoreInst>(GV->user_back())) {
Victor Hernandez5d034492009-09-18 22:35:49 +0000886 // The global is initialized when the store to it occurs.
Nick Lewycky52da72b2012-02-05 19:56:38 +0000887 new StoreInst(ConstantInt::getTrue(GV->getContext()), InitBool, false, 0,
888 SI->getOrdering(), SI->getSynchScope(), SI);
Victor Hernandez5d034492009-09-18 22:35:49 +0000889 SI->eraseFromParent();
Chris Lattner7939f792010-02-25 22:33:52 +0000890 continue;
Victor Hernandez5d034492009-09-18 22:35:49 +0000891 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000892
Chandler Carruthcdf47882014-03-09 03:16:01 +0000893 LoadInst *LI = cast<LoadInst>(GV->user_back());
Chris Lattner7939f792010-02-25 22:33:52 +0000894 while (!LI->use_empty()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000895 Use &LoadUse = *LI->use_begin();
896 ICmpInst *ICI = dyn_cast<ICmpInst>(LoadUse.getUser());
897 if (!ICI) {
Chris Lattner7939f792010-02-25 22:33:52 +0000898 LoadUse = RepValue;
899 continue;
900 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000901
Chris Lattner7939f792010-02-25 22:33:52 +0000902 // Replace the cmp X, 0 with a use of the bool value.
Nick Lewycky52da72b2012-02-05 19:56:38 +0000903 // Sink the load to where the compare was, if atomic rules allow us to.
904 Value *LV = new LoadInst(InitBool, InitBool->getName()+".val", false, 0,
905 LI->getOrdering(), LI->getSynchScope(),
906 LI->isUnordered() ? (Instruction*)ICI : LI);
Chris Lattner7939f792010-02-25 22:33:52 +0000907 InitBoolUsed = true;
908 switch (ICI->getPredicate()) {
909 default: llvm_unreachable("Unknown ICmp Predicate!");
910 case ICmpInst::ICMP_ULT:
911 case ICmpInst::ICMP_SLT: // X < null -> always false
912 LV = ConstantInt::getFalse(GV->getContext());
913 break;
914 case ICmpInst::ICMP_ULE:
915 case ICmpInst::ICMP_SLE:
916 case ICmpInst::ICMP_EQ:
917 LV = BinaryOperator::CreateNot(LV, "notinit", ICI);
918 break;
919 case ICmpInst::ICMP_NE:
920 case ICmpInst::ICMP_UGE:
921 case ICmpInst::ICMP_SGE:
922 case ICmpInst::ICMP_UGT:
923 case ICmpInst::ICMP_SGT:
924 break; // no change.
925 }
926 ICI->replaceAllUsesWith(LV);
927 ICI->eraseFromParent();
928 }
929 LI->eraseFromParent();
930 }
Victor Hernandez5d034492009-09-18 22:35:49 +0000931
932 // If the initialization boolean was used, insert it, otherwise delete it.
933 if (!InitBoolUsed) {
934 while (!InitBool->use_empty()) // Delete initializations
Chandler Carruthcdf47882014-03-09 03:16:01 +0000935 cast<StoreInst>(InitBool->user_back())->eraseFromParent();
Victor Hernandez5d034492009-09-18 22:35:49 +0000936 delete InitBool;
937 } else
938 GV->getParent()->getGlobalList().insert(GV, InitBool);
939
Chris Lattner7939f792010-02-25 22:33:52 +0000940 // Now the GV is dead, nuke it and the malloc..
Victor Hernandez5d034492009-09-18 22:35:49 +0000941 GV->eraseFromParent();
Victor Hernandez5d034492009-09-18 22:35:49 +0000942 CI->eraseFromParent();
943
944 // To further other optimizations, loop over all users of NewGV and try to
945 // constant prop them. This will promote GEP instructions with constant
946 // indices into GEP constant-exprs, which will allow global-opt to hack on it.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000947 ConstantPropUsersOf(NewGV, DL, TLI);
Victor Hernandez5d034492009-09-18 22:35:49 +0000948 if (RepValue != NewGV)
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000949 ConstantPropUsersOf(RepValue, DL, TLI);
Victor Hernandez5d034492009-09-18 22:35:49 +0000950
951 return NewGV;
952}
953
Chris Lattnerc0677c02004-12-02 07:11:07 +0000954/// ValueIsOnlyUsedLocallyOrStoredToOneGlobal - Scan the use-list of V checking
955/// to make sure that there are no complex uses of V. We permit simple things
956/// like dereferencing the pointer, but not storing through the address, unless
957/// it is to the specified global.
Gabor Greifa21bc0f2010-04-06 18:58:22 +0000958static bool ValueIsOnlyUsedLocallyOrStoredToOneGlobal(const Instruction *V,
959 const GlobalVariable *GV,
Craig Topper71b7b682014-08-21 05:55:13 +0000960 SmallPtrSetImpl<const PHINode*> &PHIs) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000961 for (const User *U : V->users()) {
962 const Instruction *Inst = cast<Instruction>(U);
Gabor Greif08355d62010-04-06 19:14:05 +0000963
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000964 if (isa<LoadInst>(Inst) || isa<CmpInst>(Inst)) {
965 continue; // Fine, ignore.
966 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000967
Gabor Greifa21bc0f2010-04-06 18:58:22 +0000968 if (const StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
Chris Lattnerc0677c02004-12-02 07:11:07 +0000969 if (SI->getOperand(0) == V && SI->getOperand(1) != GV)
970 return false; // Storing the pointer itself... bad.
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000971 continue; // Otherwise, storing through it, or storing into GV... fine.
972 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000973
Chris Lattnerb9801ff2010-04-10 18:19:22 +0000974 // Must index into the array and into the struct.
975 if (isa<GetElementPtrInst>(Inst) && Inst->getNumOperands() >= 3) {
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000976 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Inst, GV, PHIs))
Chris Lattnerc0677c02004-12-02 07:11:07 +0000977 return false;
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000978 continue;
979 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000980
Gabor Greifa21bc0f2010-04-06 18:58:22 +0000981 if (const PHINode *PN = dyn_cast<PHINode>(Inst)) {
Chris Lattner6eed0e72007-09-13 16:37:20 +0000982 // PHIs are ok if all uses are ok. Don't infinitely recurse through PHI
983 // cycles.
David Blaikie70573dc2014-11-19 07:49:26 +0000984 if (PHIs.insert(PN).second)
Chris Lattner5d13fb532007-09-14 03:41:21 +0000985 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(PN, GV, PHIs))
986 return false;
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000987 continue;
Chris Lattnerc0677c02004-12-02 07:11:07 +0000988 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000989
Gabor Greifa21bc0f2010-04-06 18:58:22 +0000990 if (const BitCastInst *BCI = dyn_cast<BitCastInst>(Inst)) {
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000991 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(BCI, GV, PHIs))
992 return false;
993 continue;
994 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +0000995
Chris Lattnerf0eb5682008-12-15 21:08:54 +0000996 return false;
997 }
Chris Lattnerc0677c02004-12-02 07:11:07 +0000998 return true;
Chris Lattnerc0677c02004-12-02 07:11:07 +0000999}
1000
Chris Lattner24d3d422006-09-30 23:32:09 +00001001/// ReplaceUsesOfMallocWithGlobal - The Alloc pointer is stored into GV
1002/// somewhere. Transform all uses of the allocation into loads from the
1003/// global and uses of the resultant pointer. Further, delete the store into
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001004/// GV. This assumes that these value pass the
Chris Lattner24d3d422006-09-30 23:32:09 +00001005/// 'ValueIsOnlyUsedLocallyOrStoredToOneGlobal' predicate.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001006static void ReplaceUsesOfMallocWithGlobal(Instruction *Alloc,
Chris Lattner24d3d422006-09-30 23:32:09 +00001007 GlobalVariable *GV) {
1008 while (!Alloc->use_empty()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001009 Instruction *U = cast<Instruction>(*Alloc->user_begin());
Chris Lattnerba98f892007-09-13 18:00:31 +00001010 Instruction *InsertPt = U;
Chris Lattner24d3d422006-09-30 23:32:09 +00001011 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
1012 // If this is the store of the allocation into the global, remove it.
1013 if (SI->getOperand(1) == GV) {
1014 SI->eraseFromParent();
1015 continue;
1016 }
Chris Lattnerba98f892007-09-13 18:00:31 +00001017 } else if (PHINode *PN = dyn_cast<PHINode>(U)) {
1018 // Insert the load in the corresponding predecessor, not right before the
1019 // PHI.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001020 InsertPt = PN->getIncomingBlock(*Alloc->use_begin())->getTerminator();
Chris Lattner49e3bdc2008-12-15 21:44:34 +00001021 } else if (isa<BitCastInst>(U)) {
1022 // Must be bitcast between the malloc and store to initialize the global.
1023 ReplaceUsesOfMallocWithGlobal(U, GV);
1024 U->eraseFromParent();
1025 continue;
1026 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
1027 // If this is a "GEP bitcast" and the user is a store to the global, then
1028 // just process it as a bitcast.
1029 if (GEPI->hasAllZeroIndices() && GEPI->hasOneUse())
Chandler Carruthcdf47882014-03-09 03:16:01 +00001030 if (StoreInst *SI = dyn_cast<StoreInst>(GEPI->user_back()))
Chris Lattner49e3bdc2008-12-15 21:44:34 +00001031 if (SI->getOperand(1) == GV) {
1032 // Must be bitcast GEP between the malloc and store to initialize
1033 // the global.
1034 ReplaceUsesOfMallocWithGlobal(GEPI, GV);
1035 GEPI->eraseFromParent();
1036 continue;
1037 }
Chris Lattner24d3d422006-09-30 23:32:09 +00001038 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001039
Chris Lattner24d3d422006-09-30 23:32:09 +00001040 // Insert a load from the global, and use it instead of the malloc.
Chris Lattnerba98f892007-09-13 18:00:31 +00001041 Value *NL = new LoadInst(GV, GV->getName()+".val", InsertPt);
Chris Lattner24d3d422006-09-30 23:32:09 +00001042 U->replaceUsesOfWith(Alloc, NL);
1043 }
1044}
1045
Chris Lattner56b55382008-12-16 21:24:51 +00001046/// LoadUsesSimpleEnoughForHeapSRA - Verify that all uses of V (a load, or a phi
1047/// of a load) are simple enough to perform heap SRA on. This permits GEP's
1048/// that index through the array and struct field, icmps of null, and PHIs.
Gabor Greif5d5db532010-04-01 08:21:08 +00001049static bool LoadUsesSimpleEnoughForHeapSRA(const Value *V,
Craig Topper71b7b682014-08-21 05:55:13 +00001050 SmallPtrSetImpl<const PHINode*> &LoadUsingPHIs,
1051 SmallPtrSetImpl<const PHINode*> &LoadUsingPHIsPerLoad) {
Chris Lattner56b55382008-12-16 21:24:51 +00001052 // We permit two users of the load: setcc comparing against the null
1053 // pointer, and a getelementptr of a specific form.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001054 for (const User *U : V->users()) {
1055 const Instruction *UI = cast<Instruction>(U);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001056
Chris Lattner56b55382008-12-16 21:24:51 +00001057 // Comparison against null is ok.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001058 if (const ICmpInst *ICI = dyn_cast<ICmpInst>(UI)) {
Chris Lattner56b55382008-12-16 21:24:51 +00001059 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
1060 return false;
1061 continue;
1062 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001063
Chris Lattner56b55382008-12-16 21:24:51 +00001064 // getelementptr is also ok, but only a simple form.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001065 if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(UI)) {
Chris Lattner56b55382008-12-16 21:24:51 +00001066 // Must index into the array and into the struct.
1067 if (GEPI->getNumOperands() < 3)
1068 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001069
Chris Lattner56b55382008-12-16 21:24:51 +00001070 // Otherwise the GEP is ok.
1071 continue;
1072 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001073
Chandler Carruthcdf47882014-03-09 03:16:01 +00001074 if (const PHINode *PN = dyn_cast<PHINode>(UI)) {
David Blaikie70573dc2014-11-19 07:49:26 +00001075 if (!LoadUsingPHIsPerLoad.insert(PN).second)
Evan Cheng83689442009-06-02 00:56:07 +00001076 // This means some phi nodes are dependent on each other.
1077 // Avoid infinite looping!
1078 return false;
David Blaikie70573dc2014-11-19 07:49:26 +00001079 if (!LoadUsingPHIs.insert(PN).second)
Evan Cheng83689442009-06-02 00:56:07 +00001080 // If we have already analyzed this PHI, then it is safe.
Chris Lattner56b55382008-12-16 21:24:51 +00001081 continue;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001082
Chris Lattner222ef4c2008-12-17 05:28:49 +00001083 // Make sure all uses of the PHI are simple enough to transform.
Evan Cheng83689442009-06-02 00:56:07 +00001084 if (!LoadUsesSimpleEnoughForHeapSRA(PN,
1085 LoadUsingPHIs, LoadUsingPHIsPerLoad))
Chris Lattner56b55382008-12-16 21:24:51 +00001086 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001087
Chris Lattner56b55382008-12-16 21:24:51 +00001088 continue;
Chris Lattner24d3d422006-09-30 23:32:09 +00001089 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001090
Chris Lattner56b55382008-12-16 21:24:51 +00001091 // Otherwise we don't know what this is, not ok.
1092 return false;
1093 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001094
Chris Lattner56b55382008-12-16 21:24:51 +00001095 return true;
1096}
1097
1098
1099/// AllGlobalLoadUsesSimpleEnoughForHeapSRA - If all users of values loaded from
1100/// GV are simple enough to perform HeapSRA, return true.
Gabor Greif5d5db532010-04-01 08:21:08 +00001101static bool AllGlobalLoadUsesSimpleEnoughForHeapSRA(const GlobalVariable *GV,
Victor Hernandez5d034492009-09-18 22:35:49 +00001102 Instruction *StoredVal) {
Gabor Greif5d5db532010-04-01 08:21:08 +00001103 SmallPtrSet<const PHINode*, 32> LoadUsingPHIs;
1104 SmallPtrSet<const PHINode*, 32> LoadUsingPHIsPerLoad;
Chandler Carruthcdf47882014-03-09 03:16:01 +00001105 for (const User *U : GV->users())
1106 if (const LoadInst *LI = dyn_cast<LoadInst>(U)) {
Evan Cheng83689442009-06-02 00:56:07 +00001107 if (!LoadUsesSimpleEnoughForHeapSRA(LI, LoadUsingPHIs,
1108 LoadUsingPHIsPerLoad))
Chris Lattner56b55382008-12-16 21:24:51 +00001109 return false;
Evan Cheng83689442009-06-02 00:56:07 +00001110 LoadUsingPHIsPerLoad.clear();
1111 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001112
Chris Lattner222ef4c2008-12-17 05:28:49 +00001113 // If we reach here, we know that all uses of the loads and transitive uses
1114 // (through PHI nodes) are simple enough to transform. However, we don't know
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001115 // that all inputs the to the PHI nodes are in the same equivalence sets.
Chris Lattner222ef4c2008-12-17 05:28:49 +00001116 // Check to verify that all operands of the PHIs are either PHIS that can be
1117 // transformed, loads from GV, or MI itself.
Craig Topper46276792014-08-24 23:23:06 +00001118 for (const PHINode *PN : LoadUsingPHIs) {
Chris Lattner222ef4c2008-12-17 05:28:49 +00001119 for (unsigned op = 0, e = PN->getNumIncomingValues(); op != e; ++op) {
1120 Value *InVal = PN->getIncomingValue(op);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001121
Chris Lattner222ef4c2008-12-17 05:28:49 +00001122 // PHI of the stored value itself is ok.
Victor Hernandez5d034492009-09-18 22:35:49 +00001123 if (InVal == StoredVal) continue;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001124
Gabor Greif5d5db532010-04-01 08:21:08 +00001125 if (const PHINode *InPN = dyn_cast<PHINode>(InVal)) {
Chris Lattner222ef4c2008-12-17 05:28:49 +00001126 // One of the PHIs in our set is (optimistically) ok.
1127 if (LoadUsingPHIs.count(InPN))
1128 continue;
1129 return false;
1130 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001131
Chris Lattner222ef4c2008-12-17 05:28:49 +00001132 // Load from GV is ok.
Gabor Greif5d5db532010-04-01 08:21:08 +00001133 if (const LoadInst *LI = dyn_cast<LoadInst>(InVal))
Chris Lattner222ef4c2008-12-17 05:28:49 +00001134 if (LI->getOperand(0) == GV)
1135 continue;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001136
Chris Lattner222ef4c2008-12-17 05:28:49 +00001137 // UNDEF? NULL?
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001138
Chris Lattner222ef4c2008-12-17 05:28:49 +00001139 // Anything else is rejected.
1140 return false;
1141 }
1142 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001143
Chris Lattner24d3d422006-09-30 23:32:09 +00001144 return true;
1145}
1146
Chris Lattner222ef4c2008-12-17 05:28:49 +00001147static Value *GetHeapSROAValue(Value *V, unsigned FieldNo,
1148 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001149 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattner222ef4c2008-12-17 05:28:49 +00001150 std::vector<Value*> &FieldVals = InsertedScalarizedValues[V];
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001151
Chris Lattner222ef4c2008-12-17 05:28:49 +00001152 if (FieldNo >= FieldVals.size())
1153 FieldVals.resize(FieldNo+1);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001154
Chris Lattner222ef4c2008-12-17 05:28:49 +00001155 // If we already have this value, just reuse the previously scalarized
1156 // version.
1157 if (Value *FieldVal = FieldVals[FieldNo])
1158 return FieldVal;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001159
Chris Lattner222ef4c2008-12-17 05:28:49 +00001160 // Depending on what instruction this is, we have several cases.
1161 Value *Result;
1162 if (LoadInst *LI = dyn_cast<LoadInst>(V)) {
1163 // This is a scalarized version of the load from the global. Just create
1164 // a new Load of the scalarized global.
1165 Result = new LoadInst(GetHeapSROAValue(LI->getOperand(0), FieldNo,
1166 InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001167 PHIsToRewrite),
Daniel Dunbar132f7832009-07-30 17:37:43 +00001168 LI->getName()+".f"+Twine(FieldNo), LI);
David Blaikie741c8f82015-03-14 01:53:18 +00001169 } else {
1170 PHINode *PN = cast<PHINode>(V);
Chris Lattner222ef4c2008-12-17 05:28:49 +00001171 // PN's type is pointer to struct. Make a new PHI of pointer to struct
1172 // field.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001173
Matt Arsenaultfcd74012014-04-23 20:36:10 +00001174 PointerType *PTy = cast<PointerType>(PN->getType());
1175 StructType *ST = cast<StructType>(PTy->getElementType());
1176
1177 unsigned AS = PTy->getAddressSpace();
Jay Foade0938d82011-03-30 11:19:20 +00001178 PHINode *NewPN =
Matt Arsenaultfcd74012014-04-23 20:36:10 +00001179 PHINode::Create(PointerType::get(ST->getElementType(FieldNo), AS),
Jay Foad52131342011-03-30 11:28:46 +00001180 PN->getNumIncomingValues(),
Daniel Dunbar132f7832009-07-30 17:37:43 +00001181 PN->getName()+".f"+Twine(FieldNo), PN);
Jay Foade0938d82011-03-30 11:19:20 +00001182 Result = NewPN;
Chris Lattner222ef4c2008-12-17 05:28:49 +00001183 PHIsToRewrite.push_back(std::make_pair(PN, FieldNo));
Chris Lattner222ef4c2008-12-17 05:28:49 +00001184 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001185
Chris Lattner222ef4c2008-12-17 05:28:49 +00001186 return FieldVals[FieldNo] = Result;
Chris Lattnerba98f892007-09-13 18:00:31 +00001187}
1188
Chris Lattnerf315d4f2007-09-13 17:29:05 +00001189/// RewriteHeapSROALoadUser - Given a load instruction and a value derived from
1190/// the load, rewrite the derived value to use the HeapSRoA'd load.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001191static void RewriteHeapSROALoadUser(Instruction *LoadUser,
Chris Lattner222ef4c2008-12-17 05:28:49 +00001192 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001193 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattnerf315d4f2007-09-13 17:29:05 +00001194 // If this is a comparison against null, handle it.
1195 if (ICmpInst *SCI = dyn_cast<ICmpInst>(LoadUser)) {
1196 assert(isa<ConstantPointerNull>(SCI->getOperand(1)));
1197 // If we have a setcc of the loaded pointer, we can use a setcc of any
1198 // field.
Chris Lattner222ef4c2008-12-17 05:28:49 +00001199 Value *NPtr = GetHeapSROAValue(SCI->getOperand(0), 0,
Chris Lattner46b5c642009-11-06 04:27:31 +00001200 InsertedScalarizedValues, PHIsToRewrite);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001201
Owen Anderson1e5f00e2009-07-09 23:48:35 +00001202 Value *New = new ICmpInst(SCI, SCI->getPredicate(), NPtr,
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001203 Constant::getNullValue(NPtr->getType()),
Owen Anderson1e5f00e2009-07-09 23:48:35 +00001204 SCI->getName());
Chris Lattnerf315d4f2007-09-13 17:29:05 +00001205 SCI->replaceAllUsesWith(New);
1206 SCI->eraseFromParent();
1207 return;
1208 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001209
Chris Lattner222ef4c2008-12-17 05:28:49 +00001210 // Handle 'getelementptr Ptr, Idx, i32 FieldNo ...'
Chris Lattnerba98f892007-09-13 18:00:31 +00001211 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(LoadUser)) {
1212 assert(GEPI->getNumOperands() >= 3 && isa<ConstantInt>(GEPI->getOperand(2))
1213 && "Unexpected GEPI!");
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001214
Chris Lattnerba98f892007-09-13 18:00:31 +00001215 // Load the pointer for this field.
1216 unsigned FieldNo = cast<ConstantInt>(GEPI->getOperand(2))->getZExtValue();
Chris Lattner222ef4c2008-12-17 05:28:49 +00001217 Value *NewPtr = GetHeapSROAValue(GEPI->getOperand(0), FieldNo,
Chris Lattner46b5c642009-11-06 04:27:31 +00001218 InsertedScalarizedValues, PHIsToRewrite);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001219
Chris Lattnerba98f892007-09-13 18:00:31 +00001220 // Create the new GEP idx vector.
1221 SmallVector<Value*, 8> GEPIdx;
1222 GEPIdx.push_back(GEPI->getOperand(1));
1223 GEPIdx.append(GEPI->op_begin()+3, GEPI->op_end());
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001224
David Blaikie22319eb2015-03-14 19:24:04 +00001225 Value *NGEPI = GetElementPtrInst::Create(GEPI->getResultElementType(), NewPtr, GEPIdx,
Gabor Greife9ecc682008-04-06 20:25:17 +00001226 GEPI->getName(), GEPI);
Chris Lattnerba98f892007-09-13 18:00:31 +00001227 GEPI->replaceAllUsesWith(NGEPI);
1228 GEPI->eraseFromParent();
1229 return;
1230 }
Chris Lattner011f91b2007-09-13 21:31:36 +00001231
Chris Lattner222ef4c2008-12-17 05:28:49 +00001232 // Recursively transform the users of PHI nodes. This will lazily create the
1233 // PHIs that are needed for individual elements. Keep track of what PHIs we
1234 // see in InsertedScalarizedValues so that we don't get infinite loops (very
1235 // antisocial). If the PHI is already in InsertedScalarizedValues, it has
1236 // already been seen first by another load, so its uses have already been
1237 // processed.
1238 PHINode *PN = cast<PHINode>(LoadUser);
Chris Lattner5cf753c2011-07-21 06:21:31 +00001239 if (!InsertedScalarizedValues.insert(std::make_pair(PN,
1240 std::vector<Value*>())).second)
1241 return;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001242
Chris Lattner222ef4c2008-12-17 05:28:49 +00001243 // If this is the first time we've seen this PHI, recursively process all
1244 // users.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001245 for (auto UI = PN->user_begin(), E = PN->user_end(); UI != E;) {
Chris Lattner0cdf5232008-12-17 05:42:08 +00001246 Instruction *User = cast<Instruction>(*UI++);
Chris Lattner46b5c642009-11-06 04:27:31 +00001247 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
Chris Lattner0cdf5232008-12-17 05:42:08 +00001248 }
Chris Lattnerf315d4f2007-09-13 17:29:05 +00001249}
1250
Chris Lattner24d3d422006-09-30 23:32:09 +00001251/// RewriteUsesOfLoadForHeapSRoA - We are performing Heap SRoA on a global. Ptr
1252/// is a value loaded from the global. Eliminate all uses of Ptr, making them
1253/// use FieldGlobals instead. All uses of loaded values satisfy
Chris Lattner56b55382008-12-16 21:24:51 +00001254/// AllGlobalLoadUsesSimpleEnoughForHeapSRA.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001255static void RewriteUsesOfLoadForHeapSRoA(LoadInst *Load,
Chris Lattner222ef4c2008-12-17 05:28:49 +00001256 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001257 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001258 for (auto UI = Load->user_begin(), E = Load->user_end(); UI != E;) {
Chris Lattner0cdf5232008-12-17 05:42:08 +00001259 Instruction *User = cast<Instruction>(*UI++);
Chris Lattner46b5c642009-11-06 04:27:31 +00001260 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
Chris Lattner0cdf5232008-12-17 05:42:08 +00001261 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001262
Chris Lattner222ef4c2008-12-17 05:28:49 +00001263 if (Load->use_empty()) {
1264 Load->eraseFromParent();
1265 InsertedScalarizedValues.erase(Load);
1266 }
Chris Lattner24d3d422006-09-30 23:32:09 +00001267}
1268
Victor Hernandez5d034492009-09-18 22:35:49 +00001269/// PerformHeapAllocSRoA - CI is an allocation of an array of structures. Break
1270/// it up into multiple allocations of arrays of the fields.
Victor Hernandezf3db9152009-11-07 00:16:28 +00001271static GlobalVariable *PerformHeapAllocSRoA(GlobalVariable *GV, CallInst *CI,
Mehdi Amini46a43552015-03-04 18:43:29 +00001272 Value *NElems, const DataLayout &DL,
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001273 const TargetLibraryInfo *TLI) {
David Greene44cb8ad2010-01-05 01:28:05 +00001274 DEBUG(dbgs() << "SROA HEAP ALLOC: " << *GV << " MALLOC = " << *CI << '\n');
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001275 Type *MAT = getMallocAllocatedType(CI, TLI);
Chris Lattner229907c2011-07-18 04:54:35 +00001276 StructType *STy = cast<StructType>(MAT);
Victor Hernandez5d034492009-09-18 22:35:49 +00001277
1278 // There is guaranteed to be at least one use of the malloc (storing
1279 // it into GV). If there are other uses, change them to be uses of
1280 // the global to simplify later code. This also deletes the store
1281 // into GV.
Victor Hernandezf3db9152009-11-07 00:16:28 +00001282 ReplaceUsesOfMallocWithGlobal(CI, GV);
1283
Victor Hernandez5d034492009-09-18 22:35:49 +00001284 // Okay, at this point, there are no users of the malloc. Insert N
1285 // new mallocs at the same place as CI, and N globals.
1286 std::vector<Value*> FieldGlobals;
1287 std::vector<Value*> FieldMallocs;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001288
Matt Arsenaultfcd74012014-04-23 20:36:10 +00001289 unsigned AS = GV->getType()->getPointerAddressSpace();
Victor Hernandez5d034492009-09-18 22:35:49 +00001290 for (unsigned FieldNo = 0, e = STy->getNumElements(); FieldNo != e;++FieldNo){
Chris Lattner229907c2011-07-18 04:54:35 +00001291 Type *FieldTy = STy->getElementType(FieldNo);
Matt Arsenaultfcd74012014-04-23 20:36:10 +00001292 PointerType *PFieldTy = PointerType::get(FieldTy, AS);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001293
Victor Hernandez5d034492009-09-18 22:35:49 +00001294 GlobalVariable *NGV =
1295 new GlobalVariable(*GV->getParent(),
1296 PFieldTy, false, GlobalValue::InternalLinkage,
1297 Constant::getNullValue(PFieldTy),
1298 GV->getName() + ".f" + Twine(FieldNo), GV,
Hans Wennborgcbe34b42012-06-23 11:37:03 +00001299 GV->getThreadLocalMode());
Victor Hernandez5d034492009-09-18 22:35:49 +00001300 FieldGlobals.push_back(NGV);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001301
Mehdi Amini46a43552015-03-04 18:43:29 +00001302 unsigned TypeSize = DL.getTypeAllocSize(FieldTy);
Chris Lattner229907c2011-07-18 04:54:35 +00001303 if (StructType *ST = dyn_cast<StructType>(FieldTy))
Mehdi Amini46a43552015-03-04 18:43:29 +00001304 TypeSize = DL.getStructLayout(ST)->getSizeInBytes();
1305 Type *IntPtrTy = DL.getIntPtrType(CI->getType());
Victor Hernandezf3db9152009-11-07 00:16:28 +00001306 Value *NMI = CallInst::CreateMalloc(CI, IntPtrTy, FieldTy,
1307 ConstantInt::get(IntPtrTy, TypeSize),
Craig Topperf40110f2014-04-25 05:29:35 +00001308 NElems, nullptr,
Victor Hernandezf3db9152009-11-07 00:16:28 +00001309 CI->getName() + ".f" + Twine(FieldNo));
Chris Lattner0521c092010-02-26 18:23:13 +00001310 FieldMallocs.push_back(NMI);
Victor Hernandezf3db9152009-11-07 00:16:28 +00001311 new StoreInst(NMI, NGV, CI);
Victor Hernandez5d034492009-09-18 22:35:49 +00001312 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001313
Victor Hernandez5d034492009-09-18 22:35:49 +00001314 // The tricky aspect of this transformation is handling the case when malloc
1315 // fails. In the original code, malloc failing would set the result pointer
1316 // of malloc to null. In this case, some mallocs could succeed and others
1317 // could fail. As such, we emit code that looks like this:
1318 // F0 = malloc(field0)
1319 // F1 = malloc(field1)
1320 // F2 = malloc(field2)
1321 // if (F0 == 0 || F1 == 0 || F2 == 0) {
1322 // if (F0) { free(F0); F0 = 0; }
1323 // if (F1) { free(F1); F1 = 0; }
1324 // if (F2) { free(F2); F2 = 0; }
1325 // }
Victor Hernandezfcc77b12009-11-10 08:32:25 +00001326 // The malloc can also fail if its argument is too large.
Gabor Greif218f5542010-06-24 14:42:01 +00001327 Constant *ConstantZero = ConstantInt::get(CI->getArgOperand(0)->getType(), 0);
1328 Value *RunningOr = new ICmpInst(CI, ICmpInst::ICMP_SLT, CI->getArgOperand(0),
Victor Hernandezfcc77b12009-11-10 08:32:25 +00001329 ConstantZero, "isneg");
Victor Hernandez5d034492009-09-18 22:35:49 +00001330 for (unsigned i = 0, e = FieldMallocs.size(); i != e; ++i) {
Victor Hernandezf3db9152009-11-07 00:16:28 +00001331 Value *Cond = new ICmpInst(CI, ICmpInst::ICMP_EQ, FieldMallocs[i],
1332 Constant::getNullValue(FieldMallocs[i]->getType()),
1333 "isnull");
Victor Hernandezfcc77b12009-11-10 08:32:25 +00001334 RunningOr = BinaryOperator::CreateOr(RunningOr, Cond, "tmp", CI);
Victor Hernandez5d034492009-09-18 22:35:49 +00001335 }
1336
1337 // Split the basic block at the old malloc.
Victor Hernandezf3db9152009-11-07 00:16:28 +00001338 BasicBlock *OrigBB = CI->getParent();
1339 BasicBlock *ContBB = OrigBB->splitBasicBlock(CI, "malloc_cont");
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001340
Victor Hernandez5d034492009-09-18 22:35:49 +00001341 // Create the block to check the first condition. Put all these blocks at the
1342 // end of the function as they are unlikely to be executed.
Chris Lattner46b5c642009-11-06 04:27:31 +00001343 BasicBlock *NullPtrBlock = BasicBlock::Create(OrigBB->getContext(),
1344 "malloc_ret_null",
Victor Hernandez5d034492009-09-18 22:35:49 +00001345 OrigBB->getParent());
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001346
Victor Hernandez5d034492009-09-18 22:35:49 +00001347 // Remove the uncond branch from OrigBB to ContBB, turning it into a cond
1348 // branch on RunningOr.
1349 OrigBB->getTerminator()->eraseFromParent();
1350 BranchInst::Create(NullPtrBlock, ContBB, RunningOr, OrigBB);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001351
Victor Hernandez5d034492009-09-18 22:35:49 +00001352 // Within the NullPtrBlock, we need to emit a comparison and branch for each
1353 // pointer, because some may be null while others are not.
1354 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1355 Value *GVVal = new LoadInst(FieldGlobals[i], "tmp", NullPtrBlock);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001356 Value *Cmp = new ICmpInst(*NullPtrBlock, ICmpInst::ICMP_NE, GVVal,
Benjamin Kramer547b6c52011-09-27 20:39:19 +00001357 Constant::getNullValue(GVVal->getType()));
Chris Lattner46b5c642009-11-06 04:27:31 +00001358 BasicBlock *FreeBlock = BasicBlock::Create(Cmp->getContext(), "free_it",
Victor Hernandez5d034492009-09-18 22:35:49 +00001359 OrigBB->getParent());
Chris Lattner46b5c642009-11-06 04:27:31 +00001360 BasicBlock *NextBlock = BasicBlock::Create(Cmp->getContext(), "next",
Victor Hernandez5d034492009-09-18 22:35:49 +00001361 OrigBB->getParent());
Victor Hernandeze2971492009-10-24 04:23:03 +00001362 Instruction *BI = BranchInst::Create(FreeBlock, NextBlock,
1363 Cmp, NullPtrBlock);
Victor Hernandez5d034492009-09-18 22:35:49 +00001364
1365 // Fill in FreeBlock.
Victor Hernandeze2971492009-10-24 04:23:03 +00001366 CallInst::CreateFree(GVVal, BI);
Victor Hernandez5d034492009-09-18 22:35:49 +00001367 new StoreInst(Constant::getNullValue(GVVal->getType()), FieldGlobals[i],
1368 FreeBlock);
1369 BranchInst::Create(NextBlock, FreeBlock);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001370
Victor Hernandez5d034492009-09-18 22:35:49 +00001371 NullPtrBlock = NextBlock;
1372 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001373
Victor Hernandez5d034492009-09-18 22:35:49 +00001374 BranchInst::Create(ContBB, NullPtrBlock);
Victor Hernandezf3db9152009-11-07 00:16:28 +00001375
1376 // CI is no longer needed, remove it.
Victor Hernandez5d034492009-09-18 22:35:49 +00001377 CI->eraseFromParent();
1378
1379 /// InsertedScalarizedLoads - As we process loads, if we can't immediately
1380 /// update all uses of the load, keep track of what scalarized loads are
1381 /// inserted for a given load.
1382 DenseMap<Value*, std::vector<Value*> > InsertedScalarizedValues;
1383 InsertedScalarizedValues[GV] = FieldGlobals;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001384
Victor Hernandez5d034492009-09-18 22:35:49 +00001385 std::vector<std::pair<PHINode*, unsigned> > PHIsToRewrite;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001386
Victor Hernandez5d034492009-09-18 22:35:49 +00001387 // Okay, the malloc site is completely handled. All of the uses of GV are now
1388 // loads, and all uses of those loads are simple. Rewrite them to use loads
1389 // of the per-field globals instead.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001390 for (auto UI = GV->user_begin(), E = GV->user_end(); UI != E;) {
Victor Hernandez5d034492009-09-18 22:35:49 +00001391 Instruction *User = cast<Instruction>(*UI++);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001392
Victor Hernandez5d034492009-09-18 22:35:49 +00001393 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
Chris Lattner46b5c642009-11-06 04:27:31 +00001394 RewriteUsesOfLoadForHeapSRoA(LI, InsertedScalarizedValues, PHIsToRewrite);
Victor Hernandez5d034492009-09-18 22:35:49 +00001395 continue;
1396 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001397
Victor Hernandez5d034492009-09-18 22:35:49 +00001398 // Must be a store of null.
1399 StoreInst *SI = cast<StoreInst>(User);
1400 assert(isa<ConstantPointerNull>(SI->getOperand(0)) &&
1401 "Unexpected heap-sra user!");
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001402
Victor Hernandez5d034492009-09-18 22:35:49 +00001403 // Insert a store of null into each global.
1404 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
Chris Lattner229907c2011-07-18 04:54:35 +00001405 PointerType *PT = cast<PointerType>(FieldGlobals[i]->getType());
Victor Hernandez5d034492009-09-18 22:35:49 +00001406 Constant *Null = Constant::getNullValue(PT->getElementType());
1407 new StoreInst(Null, FieldGlobals[i], SI);
1408 }
1409 // Erase the original store.
1410 SI->eraseFromParent();
1411 }
1412
1413 // While we have PHIs that are interesting to rewrite, do it.
1414 while (!PHIsToRewrite.empty()) {
1415 PHINode *PN = PHIsToRewrite.back().first;
1416 unsigned FieldNo = PHIsToRewrite.back().second;
1417 PHIsToRewrite.pop_back();
1418 PHINode *FieldPN = cast<PHINode>(InsertedScalarizedValues[PN][FieldNo]);
1419 assert(FieldPN->getNumIncomingValues() == 0 &&"Already processed this phi");
1420
1421 // Add all the incoming values. This can materialize more phis.
1422 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1423 Value *InVal = PN->getIncomingValue(i);
1424 InVal = GetHeapSROAValue(InVal, FieldNo, InsertedScalarizedValues,
Chris Lattner46b5c642009-11-06 04:27:31 +00001425 PHIsToRewrite);
Victor Hernandez5d034492009-09-18 22:35:49 +00001426 FieldPN->addIncoming(InVal, PN->getIncomingBlock(i));
1427 }
1428 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001429
Victor Hernandez5d034492009-09-18 22:35:49 +00001430 // Drop all inter-phi links and any loads that made it this far.
1431 for (DenseMap<Value*, std::vector<Value*> >::iterator
1432 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1433 I != E; ++I) {
1434 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1435 PN->dropAllReferences();
1436 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1437 LI->dropAllReferences();
1438 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001439
Victor Hernandez5d034492009-09-18 22:35:49 +00001440 // Delete all the phis and loads now that inter-references are dead.
1441 for (DenseMap<Value*, std::vector<Value*> >::iterator
1442 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1443 I != E; ++I) {
1444 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1445 PN->eraseFromParent();
1446 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1447 LI->eraseFromParent();
1448 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001449
Victor Hernandez5d034492009-09-18 22:35:49 +00001450 // The old global is now dead, remove it.
1451 GV->eraseFromParent();
1452
1453 ++NumHeapSRA;
1454 return cast<GlobalVariable>(FieldGlobals[0]);
1455}
1456
Chris Lattnerc4274a72008-12-15 21:02:25 +00001457/// TryToOptimizeStoreOfMallocToGlobal - This function is called when we see a
1458/// pointer global variable with a single value stored it that is a malloc or
1459/// cast of malloc.
Mehdi Amini46a43552015-03-04 18:43:29 +00001460static bool TryToOptimizeStoreOfMallocToGlobal(GlobalVariable *GV, CallInst *CI,
Chris Lattner229907c2011-07-18 04:54:35 +00001461 Type *AllocTy,
Nick Lewycky52da72b2012-02-05 19:56:38 +00001462 AtomicOrdering Ordering,
Victor Hernandez5d034492009-09-18 22:35:49 +00001463 Module::global_iterator &GVI,
Mehdi Amini46a43552015-03-04 18:43:29 +00001464 const DataLayout &DL,
Nick Lewyckycf6aae62012-02-12 01:13:18 +00001465 TargetLibraryInfo *TLI) {
Victor Hernandez5d034492009-09-18 22:35:49 +00001466 // If this is a malloc of an abstract type, don't touch it.
1467 if (!AllocTy->isSized())
1468 return false;
1469
1470 // We can't optimize this global unless all uses of it are *known* to be
1471 // of the malloc value, not of the null initializer value (consider a use
1472 // that compares the global's value against zero to see if the malloc has
1473 // been reached). To do this, we check to see if all uses of the global
1474 // would trap if the global were null: this proves that they must all
1475 // happen after the malloc.
1476 if (!AllUsesOfLoadedValueWillTrapIfNull(GV))
1477 return false;
1478
1479 // We can't optimize this if the malloc itself is used in a complex way,
1480 // for example, being stored into multiple globals. This allows the
Nick Lewyckybbd11562012-02-05 19:48:37 +00001481 // malloc to be stored into the specified global, loaded icmp'd, and
Victor Hernandez5d034492009-09-18 22:35:49 +00001482 // GEP'd. These are all things we could transform to using the global
1483 // for.
Evan Cheng21b588b2010-04-14 20:52:55 +00001484 SmallPtrSet<const PHINode*, 8> PHIs;
1485 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(CI, GV, PHIs))
1486 return false;
Victor Hernandez5d034492009-09-18 22:35:49 +00001487
1488 // If we have a global that is only initialized with a fixed size malloc,
1489 // transform the program to use global memory instead of malloc'd memory.
1490 // This eliminates dynamic allocation, avoids an indirection accessing the
1491 // data, and exposes the resultant global to further GlobalOpt.
Victor Hernandez264da322009-10-16 23:12:25 +00001492 // We cannot optimize the malloc if we cannot determine malloc array size.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001493 Value *NElems = getMallocArraySize(CI, DL, TLI, true);
Evan Cheng21b588b2010-04-14 20:52:55 +00001494 if (!NElems)
1495 return false;
Victor Hernandez5d034492009-09-18 22:35:49 +00001496
Evan Cheng21b588b2010-04-14 20:52:55 +00001497 if (ConstantInt *NElements = dyn_cast<ConstantInt>(NElems))
1498 // Restrict this transformation to only working on small allocations
1499 // (2048 bytes currently), as we don't want to introduce a 16M global or
1500 // something.
Mehdi Amini46a43552015-03-04 18:43:29 +00001501 if (NElements->getZExtValue() * DL.getTypeAllocSize(AllocTy) < 2048) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001502 GVI = OptimizeGlobalAddressOfMalloc(GV, CI, AllocTy, NElements, DL, TLI);
Evan Cheng21b588b2010-04-14 20:52:55 +00001503 return true;
Victor Hernandez5d034492009-09-18 22:35:49 +00001504 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001505
Evan Cheng21b588b2010-04-14 20:52:55 +00001506 // If the allocation is an array of structures, consider transforming this
1507 // into multiple malloc'd arrays, one for each field. This is basically
1508 // SRoA for malloc'd memory.
1509
Nick Lewycky52da72b2012-02-05 19:56:38 +00001510 if (Ordering != NotAtomic)
1511 return false;
1512
Evan Cheng21b588b2010-04-14 20:52:55 +00001513 // If this is an allocation of a fixed size array of structs, analyze as a
1514 // variable size array. malloc [100 x struct],1 -> malloc struct, 100
Gabor Greif218f5542010-06-24 14:42:01 +00001515 if (NElems == ConstantInt::get(CI->getArgOperand(0)->getType(), 1))
Chris Lattner229907c2011-07-18 04:54:35 +00001516 if (ArrayType *AT = dyn_cast<ArrayType>(AllocTy))
Evan Cheng21b588b2010-04-14 20:52:55 +00001517 AllocTy = AT->getElementType();
Gabor Greif218f5542010-06-24 14:42:01 +00001518
Chris Lattner229907c2011-07-18 04:54:35 +00001519 StructType *AllocSTy = dyn_cast<StructType>(AllocTy);
Evan Cheng21b588b2010-04-14 20:52:55 +00001520 if (!AllocSTy)
1521 return false;
1522
1523 // This the structure has an unreasonable number of fields, leave it
1524 // alone.
1525 if (AllocSTy->getNumElements() <= 16 && AllocSTy->getNumElements() != 0 &&
1526 AllGlobalLoadUsesSimpleEnoughForHeapSRA(GV, CI)) {
1527
1528 // If this is a fixed size array, transform the Malloc to be an alloc of
1529 // structs. malloc [100 x struct],1 -> malloc struct, 100
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001530 if (ArrayType *AT = dyn_cast<ArrayType>(getMallocAllocatedType(CI, TLI))) {
Mehdi Amini46a43552015-03-04 18:43:29 +00001531 Type *IntPtrTy = DL.getIntPtrType(CI->getType());
1532 unsigned TypeSize = DL.getStructLayout(AllocSTy)->getSizeInBytes();
Evan Cheng21b588b2010-04-14 20:52:55 +00001533 Value *AllocSize = ConstantInt::get(IntPtrTy, TypeSize);
1534 Value *NumElements = ConstantInt::get(IntPtrTy, AT->getNumElements());
1535 Instruction *Malloc = CallInst::CreateMalloc(CI, IntPtrTy, AllocSTy,
1536 AllocSize, NumElements,
Craig Topperf40110f2014-04-25 05:29:35 +00001537 nullptr, CI->getName());
Evan Cheng21b588b2010-04-14 20:52:55 +00001538 Instruction *Cast = new BitCastInst(Malloc, CI->getType(), "tmp", CI);
1539 CI->replaceAllUsesWith(Cast);
1540 CI->eraseFromParent();
Nuno Lopes9792d682012-06-22 00:25:01 +00001541 if (BitCastInst *BCI = dyn_cast<BitCastInst>(Malloc))
1542 CI = cast<CallInst>(BCI->getOperand(0));
1543 else
Nuno Lopes0b60ebb2012-06-22 00:29:58 +00001544 CI = cast<CallInst>(Malloc);
Evan Cheng21b588b2010-04-14 20:52:55 +00001545 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001546
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001547 GVI = PerformHeapAllocSRoA(GV, CI, getMallocArraySize(CI, DL, TLI, true),
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001548 DL, TLI);
Evan Cheng21b588b2010-04-14 20:52:55 +00001549 return true;
Victor Hernandez5d034492009-09-18 22:35:49 +00001550 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001551
Victor Hernandez5d034492009-09-18 22:35:49 +00001552 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001553}
Victor Hernandez5d034492009-09-18 22:35:49 +00001554
Chris Lattner09a52722004-10-09 21:48:45 +00001555// OptimizeOnceStoredGlobal - Try to optimize globals based on the knowledge
1556// that only one value (besides its initializer) is ever stored to the global.
Chris Lattner004e2502004-10-11 05:54:41 +00001557static bool OptimizeOnceStoredGlobal(GlobalVariable *GV, Value *StoredOnceVal,
Nick Lewycky52da72b2012-02-05 19:56:38 +00001558 AtomicOrdering Ordering,
Chris Lattnerc2d3d312006-08-27 22:42:52 +00001559 Module::global_iterator &GVI,
Mehdi Amini46a43552015-03-04 18:43:29 +00001560 const DataLayout &DL,
Rafael Espindolaaeff8a92014-02-24 23:12:18 +00001561 TargetLibraryInfo *TLI) {
Chris Lattner1c731fa2008-12-15 21:20:32 +00001562 // Ignore no-op GEPs and bitcasts.
1563 StoredOnceVal = StoredOnceVal->stripPointerCasts();
Chris Lattner09a52722004-10-09 21:48:45 +00001564
Chris Lattnere42eb312004-10-10 23:14:11 +00001565 // If we are dealing with a pointer global that is initialized to null and
1566 // only has one (non-null) value stored into it, then we can optimize any
1567 // users of the loaded value (often calls and loads) that would trap if the
1568 // value was null.
Duncan Sands19d0b472010-02-16 11:11:14 +00001569 if (GV->getInitializer()->getType()->isPointerTy() &&
Chris Lattner09a52722004-10-09 21:48:45 +00001570 GV->getInitializer()->isNullValue()) {
Chris Lattnere42eb312004-10-10 23:14:11 +00001571 if (Constant *SOVC = dyn_cast<Constant>(StoredOnceVal)) {
1572 if (GV->getInitializer()->getType() != SOVC->getType())
Chris Lattner1a1acc22011-05-22 07:15:13 +00001573 SOVC = ConstantExpr::getBitCast(SOVC, GV->getInitializer()->getType());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001574
Chris Lattnere42eb312004-10-10 23:14:11 +00001575 // Optimize away any trapping uses of the loaded value.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001576 if (OptimizeAwayTrappingUsesOfLoads(GV, SOVC, DL, TLI))
Chris Lattner604ed7a2004-10-10 17:07:12 +00001577 return true;
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001578 } else if (CallInst *CI = extractMallocCall(StoredOnceVal, TLI)) {
1579 Type *MallocType = getMallocAllocatedType(CI, TLI);
Nick Lewyckycf6aae62012-02-12 01:13:18 +00001580 if (MallocType &&
1581 TryToOptimizeStoreOfMallocToGlobal(GV, CI, MallocType, Ordering, GVI,
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001582 DL, TLI))
Victor Hernandezf3db9152009-11-07 00:16:28 +00001583 return true;
Chris Lattnere42eb312004-10-10 23:14:11 +00001584 }
Chris Lattner09a52722004-10-09 21:48:45 +00001585 }
Chris Lattner004e2502004-10-11 05:54:41 +00001586
Chris Lattner09a52722004-10-09 21:48:45 +00001587 return false;
1588}
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001589
Lang Hames459b5dc2014-03-23 04:22:31 +00001590/// TryToShrinkGlobalToBoolean - At this point, we have learned that the only
Chris Lattner20bbac32008-01-14 01:17:44 +00001591/// two values ever stored into GV are its initializer and OtherVal. See if we
Lang Hames459b5dc2014-03-23 04:22:31 +00001592/// can shrink the global into a boolean and select between the two values
1593/// whenever it is used. This exposes the values to other scalar optimizations.
1594static bool TryToShrinkGlobalToBoolean(GlobalVariable *GV, Constant *OtherVal) {
Chris Lattner229907c2011-07-18 04:54:35 +00001595 Type *GVElType = GV->getType()->getElementType();
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001596
Lang Hames459b5dc2014-03-23 04:22:31 +00001597 // If GVElType is already i1, it is already shrunk. If the type of the GV is
1598 // an FP value, pointer or vector, don't do this optimization because a select
1599 // between them is very expensive and unlikely to lead to later
1600 // simplification. In these cases, we typically end up with "cond ? v1 : v2"
1601 // where v1 and v2 both require constant pool loads, a big loss.
Chris Lattner46b5c642009-11-06 04:27:31 +00001602 if (GVElType == Type::getInt1Ty(GV->getContext()) ||
Duncan Sands9dff9be2010-02-15 16:12:20 +00001603 GVElType->isFloatingPointTy() ||
Duncan Sands19d0b472010-02-16 11:11:14 +00001604 GVElType->isPointerTy() || GVElType->isVectorTy())
Chris Lattner20bbac32008-01-14 01:17:44 +00001605 return false;
Gabor Greifa75ed762010-07-12 14:13:15 +00001606
Chris Lattner20bbac32008-01-14 01:17:44 +00001607 // Walk the use list of the global seeing if all the uses are load or store.
1608 // If there is anything else, bail out.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001609 for (User *U : GV->users())
Gabor Greifa75ed762010-07-12 14:13:15 +00001610 if (!isa<LoadInst>(U) && !isa<StoreInst>(U))
Chris Lattner20bbac32008-01-14 01:17:44 +00001611 return false;
Gabor Greifa75ed762010-07-12 14:13:15 +00001612
Lang Hames459b5dc2014-03-23 04:22:31 +00001613 DEBUG(dbgs() << " *** SHRINKING TO BOOL: " << *GV);
1614
1615 // Create the new global, initializing it to false.
1616 GlobalVariable *NewGV = new GlobalVariable(Type::getInt1Ty(GV->getContext()),
1617 false,
1618 GlobalValue::InternalLinkage,
1619 ConstantInt::getFalse(GV->getContext()),
1620 GV->getName()+".b",
1621 GV->getThreadLocalMode(),
1622 GV->getType()->getAddressSpace());
1623 GV->getParent()->getGlobalList().insert(GV, NewGV);
1624
Chris Lattner40e4cec2004-12-12 05:53:50 +00001625 Constant *InitVal = GV->getInitializer();
Chris Lattner46b5c642009-11-06 04:27:31 +00001626 assert(InitVal->getType() != Type::getInt1Ty(GV->getContext()) &&
Lang Hames459b5dc2014-03-23 04:22:31 +00001627 "No reason to shrink to bool!");
Chris Lattner40e4cec2004-12-12 05:53:50 +00001628
Lang Hames459b5dc2014-03-23 04:22:31 +00001629 // If initialized to zero and storing one into the global, we can use a cast
1630 // instead of a select to synthesize the desired value.
1631 bool IsOneZero = false;
1632 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal))
1633 IsOneZero = InitVal->isNullValue() && CI->isOne();
Chris Lattner40e4cec2004-12-12 05:53:50 +00001634
Lang Hames459b5dc2014-03-23 04:22:31 +00001635 while (!GV->use_empty()) {
1636 Instruction *UI = cast<Instruction>(GV->user_back());
1637 if (StoreInst *SI = dyn_cast<StoreInst>(UI)) {
1638 // Change the store into a boolean store.
1639 bool StoringOther = SI->getOperand(0) == OtherVal;
1640 // Only do this if we weren't storing a loaded value.
1641 Value *StoreVal;
1642 if (StoringOther || SI->getOperand(0) == InitVal) {
1643 StoreVal = ConstantInt::get(Type::getInt1Ty(GV->getContext()),
1644 StoringOther);
Bill Wendling7297b862013-02-13 23:00:51 +00001645 } else {
Lang Hames459b5dc2014-03-23 04:22:31 +00001646 // Otherwise, we are storing a previously loaded copy. To do this,
1647 // change the copy from copying the original value to just copying the
1648 // bool.
1649 Instruction *StoredVal = cast<Instruction>(SI->getOperand(0));
1650
1651 // If we've already replaced the input, StoredVal will be a cast or
1652 // select instruction. If not, it will be a load of the original
1653 // global.
1654 if (LoadInst *LI = dyn_cast<LoadInst>(StoredVal)) {
1655 assert(LI->getOperand(0) == GV && "Not a copy!");
1656 // Insert a new load, to preserve the saved value.
1657 StoreVal = new LoadInst(NewGV, LI->getName()+".b", false, 0,
1658 LI->getOrdering(), LI->getSynchScope(), LI);
1659 } else {
1660 assert((isa<CastInst>(StoredVal) || isa<SelectInst>(StoredVal)) &&
1661 "This is not a form that we understand!");
1662 StoreVal = StoredVal->getOperand(0);
1663 assert(isa<LoadInst>(StoreVal) && "Not a load of NewGV!");
1664 }
Chris Lattner745196a2004-12-12 19:34:41 +00001665 }
Lang Hames459b5dc2014-03-23 04:22:31 +00001666 new StoreInst(StoreVal, NewGV, false, 0,
1667 SI->getOrdering(), SI->getSynchScope(), SI);
1668 } else {
1669 // Change the load into a load of bool then a select.
1670 LoadInst *LI = cast<LoadInst>(UI);
1671 LoadInst *NLI = new LoadInst(NewGV, LI->getName()+".b", false, 0,
1672 LI->getOrdering(), LI->getSynchScope(), LI);
1673 Value *NSI;
1674 if (IsOneZero)
1675 NSI = new ZExtInst(NLI, LI->getType(), "", LI);
1676 else
1677 NSI = SelectInst::Create(NLI, OtherVal, InitVal, "", LI);
1678 NSI->takeName(LI);
1679 LI->replaceAllUsesWith(NSI);
Devang Patelfc507a12009-03-06 01:39:36 +00001680 }
Lang Hames459b5dc2014-03-23 04:22:31 +00001681 UI->eraseFromParent();
Chris Lattner40e4cec2004-12-12 05:53:50 +00001682 }
1683
Lang Hames459b5dc2014-03-23 04:22:31 +00001684 // Retain the name of the old global variable. People who are debugging their
1685 // programs may expect these variables to be named the same.
1686 NewGV->takeName(GV);
1687 GV->eraseFromParent();
Chris Lattner20bbac32008-01-14 01:17:44 +00001688 return true;
Chris Lattner40e4cec2004-12-12 05:53:50 +00001689}
1690
1691
Nick Lewycky1480f1d2012-02-12 00:52:26 +00001692/// ProcessGlobal - Analyze the specified global variable and optimize it if
1693/// possible. If we make a change, return true.
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001694bool GlobalOpt::ProcessGlobal(GlobalVariable *GV,
1695 Module::global_iterator &GVI) {
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001696 // Do more involved optimizations if the global is internal.
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001697 GV->removeDeadConstantUsers();
1698
1699 if (GV->use_empty()) {
David Greene44cb8ad2010-01-05 01:28:05 +00001700 DEBUG(dbgs() << "GLOBAL DEAD: " << *GV);
Chris Lattner8e71c6a2004-10-16 18:09:00 +00001701 GV->eraseFromParent();
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001702 ++NumDeleted;
1703 return true;
1704 }
1705
Rafael Espindola1821c6c2012-06-15 18:00:24 +00001706 if (!GV->hasLocalLinkage())
1707 return false;
1708
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001709 GlobalStatus GS;
1710
Rafael Espindola3d7fc252013-10-21 17:14:55 +00001711 if (GlobalStatus::analyzeGlobal(GV, GS))
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001712 return false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00001713
Rafael Espindola045a78f2013-10-17 18:18:52 +00001714 if (!GS.IsCompared && !GV->hasUnnamedAddr()) {
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001715 GV->setUnnamedAddr(true);
1716 NumUnnamed++;
1717 }
1718
1719 if (GV->isConstant() || !GV->hasInitializer())
1720 return false;
1721
Rafael Espindolad21ac192013-09-05 19:15:21 +00001722 return ProcessInternalGlobal(GV, GVI, GS);
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001723}
1724
1725/// ProcessInternalGlobal - Analyze the specified global variable and optimize
1726/// it if possible. If we make a change, return true.
1727bool GlobalOpt::ProcessInternalGlobal(GlobalVariable *GV,
1728 Module::global_iterator &GVI,
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001729 const GlobalStatus &GS) {
Mehdi Amini46a43552015-03-04 18:43:29 +00001730 auto &DL = GV->getParent()->getDataLayout();
Alexey Samsonova1944e62013-10-07 19:03:24 +00001731 // If this is a first class global and has only one accessing function
1732 // and this function is main (which we know is not recursive), we replace
1733 // the global with a local alloca in this function.
1734 //
Alp Tokerf907b892013-12-05 05:44:44 +00001735 // NOTE: It doesn't make sense to promote non-single-value types since we
Alexey Samsonova1944e62013-10-07 19:03:24 +00001736 // are just replacing static memory to stack memory.
1737 //
1738 // If the global is in different address space, don't bring it to stack.
1739 if (!GS.HasMultipleAccessingFunctions &&
1740 GS.AccessingFunction && !GS.HasNonInstructionUser &&
1741 GV->getType()->getElementType()->isSingleValueType() &&
1742 GS.AccessingFunction->getName() == "main" &&
1743 GS.AccessingFunction->hasExternalLinkage() &&
1744 GV->getType()->getAddressSpace() == 0) {
1745 DEBUG(dbgs() << "LOCALIZING GLOBAL: " << *GV);
1746 Instruction &FirstI = const_cast<Instruction&>(*GS.AccessingFunction
1747 ->getEntryBlock().begin());
1748 Type *ElemTy = GV->getType()->getElementType();
1749 // FIXME: Pass Global's alignment when globals have alignment
Craig Topperf40110f2014-04-25 05:29:35 +00001750 AllocaInst *Alloca = new AllocaInst(ElemTy, nullptr,
1751 GV->getName(), &FirstI);
Alexey Samsonova1944e62013-10-07 19:03:24 +00001752 if (!isa<UndefValue>(GV->getInitializer()))
1753 new StoreInst(GV->getInitializer(), Alloca, &FirstI);
1754
1755 GV->replaceAllUsesWith(Alloca);
1756 GV->eraseFromParent();
1757 ++NumLocalized;
1758 return true;
1759 }
1760
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001761 // If the global is never loaded (but may be stored to), it is dead.
1762 // Delete it now.
Rafael Espindola045a78f2013-10-17 18:18:52 +00001763 if (!GS.IsLoaded) {
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001764 DEBUG(dbgs() << "GLOBAL NEVER LOADED: " << *GV);
1765
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +00001766 bool Changed;
1767 if (isLeakCheckerRoot(GV)) {
1768 // Delete any constant stores to the global.
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001769 Changed = CleanupPointerRootUsers(GV, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +00001770 } else {
1771 // Delete any stores we can find to the global. We may not be able to
1772 // make it completely dead though.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001773 Changed = CleanupConstantGlobalUsers(GV, GV->getInitializer(), DL, TLI);
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +00001774 }
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001775
1776 // If the global is dead now, delete it.
1777 if (GV->use_empty()) {
1778 GV->eraseFromParent();
1779 ++NumDeleted;
1780 Changed = true;
1781 }
1782 return Changed;
1783
Rafael Espindola045a78f2013-10-17 18:18:52 +00001784 } else if (GS.StoredType <= GlobalStatus::InitializerStored) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00001785 DEBUG(dbgs() << "MARKING CONSTANT: " << *GV << "\n");
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001786 GV->setConstant(true);
1787
1788 // Clean up any obviously simplifiable users now.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001789 CleanupConstantGlobalUsers(GV, GV->getInitializer(), DL, TLI);
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001790
1791 // If the global is dead now, just nuke it.
1792 if (GV->use_empty()) {
1793 DEBUG(dbgs() << " *** Marking constant allowed us to simplify "
1794 << "all users and delete global!\n");
1795 GV->eraseFromParent();
1796 ++NumDeleted;
1797 }
1798
1799 ++NumMarked;
1800 return true;
1801 } else if (!GV->getInitializer()->getType()->isSingleValueType()) {
Mehdi Amini46a43552015-03-04 18:43:29 +00001802 const DataLayout &DL = GV->getParent()->getDataLayout();
1803 if (GlobalVariable *FirstNewGV = SRAGlobal(GV, DL)) {
1804 GVI = FirstNewGV; // Don't skip the newly produced globals!
1805 return true;
Rafael Espindola93512512014-02-25 17:30:31 +00001806 }
Rafael Espindola045a78f2013-10-17 18:18:52 +00001807 } else if (GS.StoredType == GlobalStatus::StoredOnce) {
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001808 // If the initial value for the global was an undef value, and if only
1809 // one other value was stored into it, we can just change the
1810 // initializer to be the stored value, then delete all stores to the
1811 // global. This allows us to mark it constant.
1812 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1813 if (isa<UndefValue>(GV->getInitializer())) {
1814 // Change the initial value here.
1815 GV->setInitializer(SOVConstant);
1816
1817 // Clean up any obviously simplifiable users now.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001818 CleanupConstantGlobalUsers(GV, GV->getInitializer(), DL, TLI);
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001819
1820 if (GV->use_empty()) {
1821 DEBUG(dbgs() << " *** Substituting initializer allowed us to "
Nick Lewyckyfaa9c3b02012-07-24 07:21:08 +00001822 << "simplify all users and delete global!\n");
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001823 GV->eraseFromParent();
1824 ++NumDeleted;
1825 } else {
1826 GVI = GV;
1827 }
1828 ++NumSubstitute;
1829 return true;
1830 }
1831
1832 // Try to optimize globals based on the knowledge that only one value
1833 // (besides its initializer) is ever stored to the global.
Nick Lewycky52da72b2012-02-05 19:56:38 +00001834 if (OptimizeOnceStoredGlobal(GV, GS.StoredOnceValue, GS.Ordering, GVI,
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001835 DL, TLI))
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001836 return true;
1837
Lang Hames459b5dc2014-03-23 04:22:31 +00001838 // Otherwise, if the global was not a boolean, we can shrink it to be a
1839 // boolean.
Eli Friedman33d37002013-09-09 22:00:13 +00001840 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue)) {
1841 if (GS.Ordering == NotAtomic) {
Lang Hames459b5dc2014-03-23 04:22:31 +00001842 if (TryToShrinkGlobalToBoolean(GV, SOVConstant)) {
Eli Friedman33d37002013-09-09 22:00:13 +00001843 ++NumShrunkToBool;
1844 return true;
1845 }
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001846 }
Eli Friedman33d37002013-09-09 22:00:13 +00001847 }
Rafael Espindolaecd5b9a2011-01-18 04:36:06 +00001848 }
1849
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001850 return false;
1851}
1852
Chris Lattnera4c80222005-05-08 22:18:06 +00001853/// ChangeCalleesToFastCall - Walk all of the direct calls of the specified
1854/// function, changing them to FastCC.
1855static void ChangeCalleesToFastCall(Function *F) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001856 for (User *U : F->users()) {
1857 if (isa<BlockAddress>(U))
Jay Foadca0c4992012-05-12 08:30:16 +00001858 continue;
Chandler Carruthcdf47882014-03-09 03:16:01 +00001859 CallSite CS(cast<Instruction>(U));
1860 CS.setCallingConv(CallingConv::Fast);
Chris Lattnera4c80222005-05-08 22:18:06 +00001861 }
1862}
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001863
Bill Wendlinge94d8432012-12-07 23:16:57 +00001864static AttributeSet StripNest(LLVMContext &C, const AttributeSet &Attrs) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001865 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendling57625a42013-01-25 23:09:36 +00001866 unsigned Index = Attrs.getSlotIndex(i);
1867 if (!Attrs.getSlotAttributes(i).hasAttribute(Index, Attribute::Nest))
Duncan Sands85fab3a2008-02-18 17:32:13 +00001868 continue;
1869
Duncan Sands85fab3a2008-02-18 17:32:13 +00001870 // There can be only one.
Bill Wendling57625a42013-01-25 23:09:36 +00001871 return Attrs.removeAttribute(C, Index, Attribute::Nest);
Duncan Sands573b3f82008-02-16 20:56:04 +00001872 }
1873
1874 return Attrs;
1875}
1876
1877static void RemoveNestAttribute(Function *F) {
Bill Wendling85a64c22012-10-14 06:39:53 +00001878 F->setAttributes(StripNest(F->getContext(), F->getAttributes()));
Chandler Carruthcdf47882014-03-09 03:16:01 +00001879 for (User *U : F->users()) {
1880 if (isa<BlockAddress>(U))
Jay Foadca0c4992012-05-12 08:30:16 +00001881 continue;
Chandler Carruthcdf47882014-03-09 03:16:01 +00001882 CallSite CS(cast<Instruction>(U));
1883 CS.setAttributes(StripNest(F->getContext(), CS.getAttributes()));
Duncan Sands573b3f82008-02-16 20:56:04 +00001884 }
1885}
1886
Reid Kleckner22869372014-02-26 19:57:30 +00001887/// Return true if this is a calling convention that we'd like to change. The
1888/// idea here is that we don't want to mess with the convention if the user
1889/// explicitly requested something with performance implications like coldcc,
1890/// GHC, or anyregcc.
1891static bool isProfitableToMakeFastCC(Function *F) {
1892 CallingConv::ID CC = F->getCallingConv();
1893 // FIXME: Is it worth transforming x86_stdcallcc and x86_fastcallcc?
1894 return CC == CallingConv::C || CC == CallingConv::X86_ThisCall;
1895}
1896
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001897bool GlobalOpt::OptimizeFunctions(Module &M) {
1898 bool Changed = false;
1899 // Optimize functions.
1900 for (Module::iterator FI = M.begin(), E = M.end(); FI != E; ) {
1901 Function *F = FI++;
Duncan Sandsed722832009-03-06 10:21:56 +00001902 // Functions without names cannot be referenced outside this module.
David Majnemer5c921152014-07-01 15:26:50 +00001903 if (!F->hasName() && !F->isDeclaration() && !F->hasLocalLinkage())
Duncan Sandsed722832009-03-06 10:21:56 +00001904 F->setLinkage(GlobalValue::InternalLinkage);
David Majnemer1b3b70e2014-10-08 07:23:31 +00001905
1906 const Comdat *C = F->getComdat();
1907 bool inComdat = C && NotDiscardableComdats.count(C);
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001908 F->removeDeadConstantUsers();
David Majnemer1b3b70e2014-10-08 07:23:31 +00001909 if ((!inComdat || F->hasLocalLinkage()) && F->isDefTriviallyDead()) {
Chris Lattnerb5d9c8c2009-11-01 19:03:42 +00001910 F->eraseFromParent();
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001911 Changed = true;
1912 ++NumFnDeleted;
Rafael Espindola6de96a12009-01-15 20:18:42 +00001913 } else if (F->hasLocalLinkage()) {
Reid Klecknere6ff5c52014-02-28 22:50:08 +00001914 if (isProfitableToMakeFastCC(F) && !F->isVarArg() &&
1915 !F->hasAddressTaken()) {
Reid Kleckner22869372014-02-26 19:57:30 +00001916 // If this function has a calling convention worth changing, is not a
1917 // varargs function, and is only called directly, promote it to use the
1918 // Fast calling convention.
Duncan Sands573b3f82008-02-16 20:56:04 +00001919 F->setCallingConv(CallingConv::Fast);
1920 ChangeCalleesToFastCall(F);
1921 ++NumFastCallFns;
1922 Changed = true;
1923 }
1924
Bill Wendling3d7b0b82012-12-19 07:18:57 +00001925 if (F->getAttributes().hasAttrSomewhere(Attribute::Nest) &&
Jay Foad557169d2009-06-10 08:41:11 +00001926 !F->hasAddressTaken()) {
Duncan Sands573b3f82008-02-16 20:56:04 +00001927 // The function is not used by a trampoline intrinsic, so it is safe
1928 // to remove the 'nest' attribute.
1929 RemoveNestAttribute(F);
1930 ++NumNestRemoved;
1931 Changed = true;
1932 }
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001933 }
1934 }
1935 return Changed;
1936}
1937
1938bool GlobalOpt::OptimizeGlobalVars(Module &M) {
1939 bool Changed = false;
David Majnemerdad0a642014-06-27 18:19:56 +00001940
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001941 for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
1942 GVI != E; ) {
1943 GlobalVariable *GV = GVI++;
Duncan Sandsed722832009-03-06 10:21:56 +00001944 // Global variables without names cannot be referenced outside this module.
David Majnemer5c921152014-07-01 15:26:50 +00001945 if (!GV->hasName() && !GV->isDeclaration() && !GV->hasLocalLinkage())
Duncan Sandsed722832009-03-06 10:21:56 +00001946 GV->setLinkage(GlobalValue::InternalLinkage);
Dan Gohman580b80d2009-11-23 16:22:21 +00001947 // Simplify the initializer.
1948 if (GV->hasInitializer())
1949 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GV->getInitializer())) {
Mehdi Amini46a43552015-03-04 18:43:29 +00001950 auto &DL = M.getDataLayout();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001951 Constant *New = ConstantFoldConstantExpression(CE, DL, TLI);
Dan Gohman580b80d2009-11-23 16:22:21 +00001952 if (New && New != CE)
1953 GV->setInitializer(New);
1954 }
Rafael Espindolafc355bc2011-01-19 16:32:21 +00001955
David Majnemerdad0a642014-06-27 18:19:56 +00001956 if (GV->isDiscardableIfUnused()) {
1957 if (const Comdat *C = GV->getComdat())
David Majnemer1b3b70e2014-10-08 07:23:31 +00001958 if (NotDiscardableComdats.count(C) && !GV->hasLocalLinkage())
David Majnemerdad0a642014-06-27 18:19:56 +00001959 continue;
1960 Changed |= ProcessGlobal(GV, GVI);
1961 }
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001962 }
1963 return Changed;
1964}
1965
Jakub Staszak9525a772012-12-06 21:57:16 +00001966static inline bool
Chris Lattner0d71c4f2010-12-07 04:33:29 +00001967isSimpleEnoughValueToCommit(Constant *C,
Mehdi Amini46a43552015-03-04 18:43:29 +00001968 SmallPtrSetImpl<Constant *> &SimpleConstants,
1969 const DataLayout &DL);
Chris Lattner0d71c4f2010-12-07 04:33:29 +00001970
1971/// isSimpleEnoughValueToCommit - Return true if the specified constant can be
1972/// handled by the code generator. We don't want to generate something like:
1973/// void *X = &X/42;
1974/// because the code generator doesn't have a relocation that can handle that.
1975///
1976/// This function should be called if C was not found (but just got inserted)
1977/// in SimpleConstants to avoid having to rescan the same constants all the
1978/// time.
Mehdi Amini46a43552015-03-04 18:43:29 +00001979static bool
1980isSimpleEnoughValueToCommitHelper(Constant *C,
1981 SmallPtrSetImpl<Constant *> &SimpleConstants,
1982 const DataLayout &DL) {
David Majnemer6098b2f2014-06-26 03:02:19 +00001983 // Simple global addresses are supported, do not allow dllimport or
1984 // thread-local globals.
David Majnemer23fc9af2014-06-24 06:53:45 +00001985 if (auto *GV = dyn_cast<GlobalValue>(C))
David Majnemer6098b2f2014-06-26 03:02:19 +00001986 return !GV->hasDLLImportStorageClass() && !GV->isThreadLocal();
David Majnemer23fc9af2014-06-24 06:53:45 +00001987
1988 // Simple integer, undef, constant aggregate zero, etc are all supported.
1989 if (C->getNumOperands() == 0 || isa<BlockAddress>(C))
Chris Lattner0d71c4f2010-12-07 04:33:29 +00001990 return true;
Jakub Staszak9525a772012-12-06 21:57:16 +00001991
Chris Lattner0d71c4f2010-12-07 04:33:29 +00001992 // Aggregate values are safe if all their elements are.
1993 if (isa<ConstantArray>(C) || isa<ConstantStruct>(C) ||
1994 isa<ConstantVector>(C)) {
Pete Cooper125ad172015-06-25 20:51:38 +00001995 for (Value *Op : C->operands())
1996 if (!isSimpleEnoughValueToCommit(cast<Constant>(Op), SimpleConstants, DL))
Chris Lattner0d71c4f2010-12-07 04:33:29 +00001997 return false;
Chris Lattner0d71c4f2010-12-07 04:33:29 +00001998 return true;
1999 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002000
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002001 // We don't know exactly what relocations are allowed in constant expressions,
2002 // so we allow &global+constantoffset, which is safe and uniformly supported
2003 // across targets.
2004 ConstantExpr *CE = cast<ConstantExpr>(C);
2005 switch (CE->getOpcode()) {
2006 case Instruction::BitCast:
Eli Friedman55fa49f32012-01-05 23:03:32 +00002007 // Bitcast is fine if the casted value is fine.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002008 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, DL);
Eli Friedman55fa49f32012-01-05 23:03:32 +00002009
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002010 case Instruction::IntToPtr:
2011 case Instruction::PtrToInt:
Eli Friedman55fa49f32012-01-05 23:03:32 +00002012 // int <=> ptr is fine if the int type is the same size as the
2013 // pointer type.
Mehdi Amini46a43552015-03-04 18:43:29 +00002014 if (DL.getTypeSizeInBits(CE->getType()) !=
2015 DL.getTypeSizeInBits(CE->getOperand(0)->getType()))
Eli Friedman55fa49f32012-01-05 23:03:32 +00002016 return false;
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002017 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, DL);
Jakub Staszak9525a772012-12-06 21:57:16 +00002018
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002019 // GEP is fine if it is simple + constant offset.
2020 case Instruction::GetElementPtr:
2021 for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
2022 if (!isa<ConstantInt>(CE->getOperand(i)))
2023 return false;
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002024 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, DL);
Jakub Staszak9525a772012-12-06 21:57:16 +00002025
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002026 case Instruction::Add:
2027 // We allow simple+cst.
2028 if (!isa<ConstantInt>(CE->getOperand(1)))
2029 return false;
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002030 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, DL);
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002031 }
2032 return false;
2033}
2034
Jakub Staszak9525a772012-12-06 21:57:16 +00002035static inline bool
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002036isSimpleEnoughValueToCommit(Constant *C,
Mehdi Amini46a43552015-03-04 18:43:29 +00002037 SmallPtrSetImpl<Constant *> &SimpleConstants,
2038 const DataLayout &DL) {
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002039 // If we already checked this constant, we win.
David Blaikie70573dc2014-11-19 07:49:26 +00002040 if (!SimpleConstants.insert(C).second)
2041 return true;
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002042 // Check the constant.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002043 return isSimpleEnoughValueToCommitHelper(C, SimpleConstants, DL);
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002044}
2045
2046
Chris Lattner99e23fa2005-09-26 04:44:35 +00002047/// isSimpleEnoughPointerToCommit - Return true if this constant is simple
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002048/// enough for us to understand. In particular, if it is a cast to anything
2049/// other than from one pointer type to another pointer type, we punt.
2050/// We basically just support direct accesses to globals and GEP's of
Chris Lattner99e23fa2005-09-26 04:44:35 +00002051/// globals. This should be kept up to date with CommitValueTo.
Chris Lattner46b5c642009-11-06 04:27:31 +00002052static bool isSimpleEnoughPointerToCommit(Constant *C) {
Dan Gohman82e74752009-09-07 22:42:05 +00002053 // Conservatively, avoid aggregate types. This is because we don't
2054 // want to worry about them partially overlapping other stores.
2055 if (!cast<PointerType>(C->getType())->getElementType()->isSingleValueType())
2056 return false;
2057
Dan Gohmanf7f3fb12009-09-07 22:31:26 +00002058 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
David Majnemer23fc9af2014-06-24 06:53:45 +00002059 // Do not allow weak/*_odr/linkonce linkage or external globals.
Mikhail Glushenkov2072db22010-10-19 16:47:23 +00002060 return GV->hasUniqueInitializer();
Dan Gohmanf7f3fb12009-09-07 22:31:26 +00002061
Owen Anderson3e2f6cf2011-01-14 22:31:13 +00002062 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Chris Lattner46af55e2005-09-26 06:52:44 +00002063 // Handle a constantexpr gep.
2064 if (CE->getOpcode() == Instruction::GetElementPtr &&
Dan Gohmanbeee35a2009-09-07 22:40:13 +00002065 isa<GlobalVariable>(CE->getOperand(0)) &&
2066 cast<GEPOperator>(CE)->isInBounds()) {
Chris Lattner46af55e2005-09-26 06:52:44 +00002067 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Mikhail Glushenkov2072db22010-10-19 16:47:23 +00002068 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
Dan Gohmanf7f3fb12009-09-07 22:31:26 +00002069 // external globals.
Mikhail Glushenkov2072db22010-10-19 16:47:23 +00002070 if (!GV->hasUniqueInitializer())
Dan Gohmanf7f3fb12009-09-07 22:31:26 +00002071 return false;
Dan Gohman161429f2009-09-07 22:44:55 +00002072
Dan Gohman161429f2009-09-07 22:44:55 +00002073 // The first index must be zero.
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +00002074 ConstantInt *CI = dyn_cast<ConstantInt>(*std::next(CE->op_begin()));
Dan Gohman161429f2009-09-07 22:44:55 +00002075 if (!CI || !CI->isZero()) return false;
Dan Gohman161429f2009-09-07 22:44:55 +00002076
2077 // The remaining indices must be compile-time known integers within the
Dan Gohman7190d482009-09-10 23:37:55 +00002078 // notional bounds of the corresponding static array types.
2079 if (!CE->isGEPWithNoNotionalOverIndexing())
2080 return false;
Dan Gohman161429f2009-09-07 22:44:55 +00002081
Dan Gohmane525d9d2009-10-05 16:36:26 +00002082 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
Jakub Staszak9525a772012-12-06 21:57:16 +00002083
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002084 // A constantexpr bitcast from a pointer to another pointer is a no-op,
2085 // and we know how to evaluate it by moving the bitcast from the pointer
2086 // operand to the value operand.
2087 } else if (CE->getOpcode() == Instruction::BitCast &&
Chris Lattner8b4952f2011-01-16 02:05:10 +00002088 isa<GlobalVariable>(CE->getOperand(0))) {
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002089 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
2090 // external globals.
Chris Lattner8b4952f2011-01-16 02:05:10 +00002091 return cast<GlobalVariable>(CE->getOperand(0))->hasUniqueInitializer();
Chris Lattner46af55e2005-09-26 06:52:44 +00002092 }
Owen Anderson3e2f6cf2011-01-14 22:31:13 +00002093 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002094
Chris Lattner99e23fa2005-09-26 04:44:35 +00002095 return false;
2096}
2097
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002098/// EvaluateStoreInto - Evaluate a piece of a constantexpr store into a global
2099/// initializer. This returns 'Init' modified to reflect 'Val' stored into it.
2100/// At this point, the GEP operands of Addr [0, OpNo) have been stepped into.
2101static Constant *EvaluateStoreInto(Constant *Init, Constant *Val,
2102 ConstantExpr *Addr, unsigned OpNo) {
2103 // Base case of the recursion.
2104 if (OpNo == Addr->getNumOperands()) {
2105 assert(Val->getType() == Init->getType() && "Type mismatch!");
2106 return Val;
2107 }
2108
2109 SmallVector<Constant*, 32> Elts;
2110 if (StructType *STy = dyn_cast<StructType>(Init->getType())) {
2111 // Break up the constant into its elements.
2112 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
2113 Elts.push_back(Init->getAggregateElement(i));
2114
2115 // Replace the element that we are supposed to.
2116 ConstantInt *CU = cast<ConstantInt>(Addr->getOperand(OpNo));
2117 unsigned Idx = CU->getZExtValue();
2118 assert(Idx < STy->getNumElements() && "Struct index out of range!");
2119 Elts[Idx] = EvaluateStoreInto(Elts[Idx], Val, Addr, OpNo+1);
2120
2121 // Return the modified struct.
2122 return ConstantStruct::get(STy, Elts);
2123 }
2124
2125 ConstantInt *CI = cast<ConstantInt>(Addr->getOperand(OpNo));
2126 SequentialType *InitTy = cast<SequentialType>(Init->getType());
2127
2128 uint64_t NumElts;
2129 if (ArrayType *ATy = dyn_cast<ArrayType>(InitTy))
2130 NumElts = ATy->getNumElements();
2131 else
2132 NumElts = InitTy->getVectorNumElements();
2133
2134 // Break up the array into elements.
2135 for (uint64_t i = 0, e = NumElts; i != e; ++i)
2136 Elts.push_back(Init->getAggregateElement(i));
2137
2138 assert(CI->getZExtValue() < NumElts);
2139 Elts[CI->getZExtValue()] =
2140 EvaluateStoreInto(Elts[CI->getZExtValue()], Val, Addr, OpNo+1);
2141
2142 if (Init->getType()->isArrayTy())
2143 return ConstantArray::get(cast<ArrayType>(InitTy), Elts);
2144 return ConstantVector::get(Elts);
2145}
2146
2147/// CommitValueTo - We have decided that Addr (which satisfies the predicate
2148/// isSimpleEnoughPointerToCommit) should get Val as its value. Make it happen.
2149static void CommitValueTo(Constant *Val, Constant *Addr) {
2150 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Addr)) {
2151 assert(GV->hasInitializer());
2152 GV->setInitializer(Val);
2153 return;
2154 }
2155
2156 ConstantExpr *CE = cast<ConstantExpr>(Addr);
2157 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
2158 GV->setInitializer(EvaluateStoreInto(GV->getInitializer(), Val, CE, 2));
2159}
2160
Nick Lewycky60829a582012-02-20 03:25:59 +00002161namespace {
2162
2163/// Evaluator - This class evaluates LLVM IR, producing the Constant
2164/// representing each SSA instruction. Changes to global variables are stored
2165/// in a mapping that can be iterated over after the evaluation is complete.
2166/// Once an evaluation call fails, the evaluation object should not be reused.
2167class Evaluator {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002168public:
Mehdi Amini46a43552015-03-04 18:43:29 +00002169 Evaluator(const DataLayout &DL, const TargetLibraryInfo *TLI)
2170 : DL(DL), TLI(TLI) {
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002171 ValueStack.emplace_back();
Nick Lewycky73be5e32012-02-19 23:26:27 +00002172 }
2173
Nick Lewycky60829a582012-02-20 03:25:59 +00002174 ~Evaluator() {
David Blaikiebc442202014-04-21 20:49:36 +00002175 for (auto &Tmp : AllocaTmps)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002176 // If there are still users of the alloca, the program is doing something
2177 // silly, e.g. storing the address of the alloca somewhere and using it
2178 // later. Since this is undefined, we'll just make it be null.
2179 if (!Tmp->use_empty())
2180 Tmp->replaceAllUsesWith(Constant::getNullValue(Tmp->getType()));
Nick Lewycky73be5e32012-02-19 23:26:27 +00002181 }
2182
2183 /// EvaluateFunction - Evaluate a call to function F, returning true if
2184 /// successful, false if we can't evaluate it. ActualArgs contains the formal
2185 /// arguments for the function.
2186 bool EvaluateFunction(Function *F, Constant *&RetVal,
2187 const SmallVectorImpl<Constant*> &ActualArgs);
2188
2189 /// EvaluateBlock - Evaluate all instructions in block BB, returning true if
2190 /// successful, false if we can't evaluate it. NewBB returns the next BB that
2191 /// control flows into, or null upon return.
2192 bool EvaluateBlock(BasicBlock::iterator CurInst, BasicBlock *&NextBB);
2193
2194 Constant *getVal(Value *V) {
2195 if (Constant *CV = dyn_cast<Constant>(V)) return CV;
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002196 Constant *R = ValueStack.back().lookup(V);
Nick Lewycky73be5e32012-02-19 23:26:27 +00002197 assert(R && "Reference to an uncomputed value!");
2198 return R;
2199 }
2200
2201 void setVal(Value *V, Constant *C) {
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002202 ValueStack.back()[V] = C;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002203 }
2204
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002205 const DenseMap<Constant*, Constant*> &getMutatedMemory() const {
2206 return MutatedMemory;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002207 }
2208
Craig Topper71b7b682014-08-21 05:55:13 +00002209 const SmallPtrSetImpl<GlobalVariable*> &getInvariants() const {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002210 return Invariants;
2211 }
2212
2213private:
2214 Constant *ComputeLoadResult(Constant *P);
2215
2216 /// ValueStack - As we compute SSA register values, we store their contents
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002217 /// here. The back of the deque contains the current function and the stack
Nick Lewycky73be5e32012-02-19 23:26:27 +00002218 /// contains the values in the calling frames.
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002219 std::deque<DenseMap<Value*, Constant*>> ValueStack;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002220
2221 /// CallStack - This is used to detect recursion. In pathological situations
2222 /// we could hit exponential behavior, but at least there is nothing
2223 /// unbounded.
2224 SmallVector<Function*, 4> CallStack;
2225
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002226 /// MutatedMemory - For each store we execute, we update this map. Loads
2227 /// check this to get the most up-to-date value. If evaluation is successful,
Nick Lewycky73be5e32012-02-19 23:26:27 +00002228 /// this state is committed to the process.
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002229 DenseMap<Constant*, Constant*> MutatedMemory;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002230
2231 /// AllocaTmps - To 'execute' an alloca, we create a temporary global variable
2232 /// to represent its body. This vector is needed so we can delete the
2233 /// temporary globals when we are done.
David Blaikiebc442202014-04-21 20:49:36 +00002234 SmallVector<std::unique_ptr<GlobalVariable>, 32> AllocaTmps;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002235
2236 /// Invariants - These global variables have been marked invariant by the
2237 /// static constructor.
2238 SmallPtrSet<GlobalVariable*, 8> Invariants;
2239
2240 /// SimpleConstants - These are constants we have checked and know to be
2241 /// simple enough to live in a static initializer of a global.
2242 SmallPtrSet<Constant*, 8> SimpleConstants;
2243
Mehdi Amini46a43552015-03-04 18:43:29 +00002244 const DataLayout &DL;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002245 const TargetLibraryInfo *TLI;
2246};
2247
Nick Lewycky60829a582012-02-20 03:25:59 +00002248} // anonymous namespace
2249
Chris Lattnerb0096632005-09-26 05:16:34 +00002250/// ComputeLoadResult - Return the value that would be computed by a load from
2251/// P after the stores reflected by 'memory' have been performed. If we can't
2252/// decide, return null.
Nick Lewycky60829a582012-02-20 03:25:59 +00002253Constant *Evaluator::ComputeLoadResult(Constant *P) {
Chris Lattner4b05c322005-09-26 05:15:37 +00002254 // If this memory location has been recently stored, use the stored value: it
2255 // is the most up-to-date.
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002256 DenseMap<Constant*, Constant*>::const_iterator I = MutatedMemory.find(P);
2257 if (I != MutatedMemory.end()) return I->second;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002258
Chris Lattner4b05c322005-09-26 05:15:37 +00002259 // Access it.
2260 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(P)) {
Dan Gohman5d5bc6d2009-08-19 18:20:44 +00002261 if (GV->hasDefinitiveInitializer())
Chris Lattner4b05c322005-09-26 05:15:37 +00002262 return GV->getInitializer();
Craig Topperf40110f2014-04-25 05:29:35 +00002263 return nullptr;
Chris Lattner4b05c322005-09-26 05:15:37 +00002264 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002265
Chris Lattner46af55e2005-09-26 06:52:44 +00002266 // Handle a constantexpr getelementptr.
2267 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(P))
2268 if (CE->getOpcode() == Instruction::GetElementPtr &&
2269 isa<GlobalVariable>(CE->getOperand(0))) {
2270 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Dan Gohman5d5bc6d2009-08-19 18:20:44 +00002271 if (GV->hasDefinitiveInitializer())
Dan Gohmane525d9d2009-10-05 16:36:26 +00002272 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
Chris Lattner46af55e2005-09-26 06:52:44 +00002273 }
2274
Craig Topperf40110f2014-04-25 05:29:35 +00002275 return nullptr; // don't know how to evaluate.
Chris Lattner4b05c322005-09-26 05:15:37 +00002276}
2277
Nick Lewycky239fdf02012-02-06 08:24:44 +00002278/// EvaluateBlock - Evaluate all instructions in block BB, returning true if
2279/// successful, false if we can't evaluate it. NewBB returns the next BB that
2280/// control flows into, or null upon return.
Nick Lewycky60829a582012-02-20 03:25:59 +00002281bool Evaluator::EvaluateBlock(BasicBlock::iterator CurInst,
2282 BasicBlock *&NextBB) {
Chris Lattner99e23fa2005-09-26 04:44:35 +00002283 // This is the main evaluation loop.
2284 while (1) {
Craig Topperf40110f2014-04-25 05:29:35 +00002285 Constant *InstResult = nullptr;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002286
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002287 DEBUG(dbgs() << "Evaluating Instruction: " << *CurInst << "\n");
2288
Chris Lattner99e23fa2005-09-26 04:44:35 +00002289 if (StoreInst *SI = dyn_cast<StoreInst>(CurInst)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002290 if (!SI->isSimple()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002291 DEBUG(dbgs() << "Store is not simple! Can not evaluate.\n");
2292 return false; // no volatile/atomic accesses.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002293 }
Nick Lewycky73be5e32012-02-19 23:26:27 +00002294 Constant *Ptr = getVal(SI->getOperand(1));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002295 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002296 DEBUG(dbgs() << "Folding constant ptr expression: " << *Ptr);
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002297 Ptr = ConstantFoldConstantExpression(CE, DL, TLI);
Michael Gottesman2a654272013-01-11 23:08:52 +00002298 DEBUG(dbgs() << "; To: " << *Ptr << "\n");
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002299 }
2300 if (!isSimpleEnoughPointerToCommit(Ptr)) {
Chris Lattner99e23fa2005-09-26 04:44:35 +00002301 // If this is too complex for us to commit, reject it.
Michael Gottesman2a654272013-01-11 23:08:52 +00002302 DEBUG(dbgs() << "Pointer is too complex for us to evaluate store.");
Chris Lattner65a3a092005-09-27 04:45:34 +00002303 return false;
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002304 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002305
Nick Lewycky73be5e32012-02-19 23:26:27 +00002306 Constant *Val = getVal(SI->getOperand(0));
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002307
2308 // If this might be too difficult for the backend to handle (e.g. the addr
2309 // of one global variable divided by another) then we can't commit it.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002310 if (!isSimpleEnoughValueToCommit(Val, SimpleConstants, DL)) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002311 DEBUG(dbgs() << "Store value is too complex to evaluate store. " << *Val
2312 << "\n");
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002313 return false;
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002314 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002315
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002316 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002317 if (CE->getOpcode() == Instruction::BitCast) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002318 DEBUG(dbgs() << "Attempting to resolve bitcast on constant ptr.\n");
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002319 // If we're evaluating a store through a bitcast, then we need
2320 // to pull the bitcast off the pointer type and push it onto the
2321 // stored value.
Chris Lattner8b4952f2011-01-16 02:05:10 +00002322 Ptr = CE->getOperand(0);
Jakub Staszak9525a772012-12-06 21:57:16 +00002323
Nick Lewycky239fdf02012-02-06 08:24:44 +00002324 Type *NewTy = cast<PointerType>(Ptr->getType())->getElementType();
Jakub Staszak9525a772012-12-06 21:57:16 +00002325
Owen Anderson4e54efd2011-01-16 04:33:33 +00002326 // In order to push the bitcast onto the stored value, a bitcast
2327 // from NewTy to Val's type must be legal. If it's not, we can try
2328 // introspecting NewTy to find a legal conversion.
2329 while (!Val->getType()->canLosslesslyBitCastTo(NewTy)) {
2330 // If NewTy is a struct, we can convert the pointer to the struct
2331 // into a pointer to its first member.
2332 // FIXME: This could be extended to support arrays as well.
Chris Lattner229907c2011-07-18 04:54:35 +00002333 if (StructType *STy = dyn_cast<StructType>(NewTy)) {
Owen Anderson4e54efd2011-01-16 04:33:33 +00002334 NewTy = STy->getTypeAtIndex(0U);
2335
Nick Lewycky239fdf02012-02-06 08:24:44 +00002336 IntegerType *IdxTy = IntegerType::get(NewTy->getContext(), 32);
Owen Anderson4e54efd2011-01-16 04:33:33 +00002337 Constant *IdxZero = ConstantInt::get(IdxTy, 0, false);
2338 Constant * const IdxList[] = {IdxZero, IdxZero};
2339
David Blaikie4a2e73b2015-04-02 18:55:32 +00002340 Ptr = ConstantExpr::getGetElementPtr(nullptr, Ptr, IdxList);
Nick Lewycky9d0da182012-02-21 22:08:06 +00002341 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002342 Ptr = ConstantFoldConstantExpression(CE, DL, TLI);
Nick Lewycky9d0da182012-02-21 22:08:06 +00002343
Owen Anderson4e54efd2011-01-16 04:33:33 +00002344 // If we can't improve the situation by introspecting NewTy,
2345 // we have to give up.
2346 } else {
Michael Gottesman2a654272013-01-11 23:08:52 +00002347 DEBUG(dbgs() << "Failed to bitcast constant ptr, can not "
2348 "evaluate.\n");
Nick Lewycky239fdf02012-02-06 08:24:44 +00002349 return false;
Owen Anderson4e54efd2011-01-16 04:33:33 +00002350 }
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002351 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002352
Owen Anderson4e54efd2011-01-16 04:33:33 +00002353 // If we found compatible types, go ahead and push the bitcast
2354 // onto the stored value.
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002355 Val = ConstantExpr::getBitCast(Val, NewTy);
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002356
Michael Gottesman2a654272013-01-11 23:08:52 +00002357 DEBUG(dbgs() << "Evaluated bitcast: " << *Val << "\n");
Owen Anderson9eb7cb482011-01-14 22:19:20 +00002358 }
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002359 }
Jakub Staszak9525a772012-12-06 21:57:16 +00002360
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002361 MutatedMemory[Ptr] = Val;
Chris Lattner99e23fa2005-09-26 04:44:35 +00002362 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CurInst)) {
Owen Anderson487375e2009-07-29 18:55:55 +00002363 InstResult = ConstantExpr::get(BO->getOpcode(),
Nick Lewycky73be5e32012-02-19 23:26:27 +00002364 getVal(BO->getOperand(0)),
2365 getVal(BO->getOperand(1)));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002366 DEBUG(dbgs() << "Found a BinaryOperator! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002367 << "\n");
Reid Spencer266e42b2006-12-23 06:05:41 +00002368 } else if (CmpInst *CI = dyn_cast<CmpInst>(CurInst)) {
Owen Anderson487375e2009-07-29 18:55:55 +00002369 InstResult = ConstantExpr::getCompare(CI->getPredicate(),
Nick Lewycky73be5e32012-02-19 23:26:27 +00002370 getVal(CI->getOperand(0)),
2371 getVal(CI->getOperand(1)));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002372 DEBUG(dbgs() << "Found a CmpInst! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002373 << "\n");
Chris Lattner99e23fa2005-09-26 04:44:35 +00002374 } else if (CastInst *CI = dyn_cast<CastInst>(CurInst)) {
Owen Anderson487375e2009-07-29 18:55:55 +00002375 InstResult = ConstantExpr::getCast(CI->getOpcode(),
Nick Lewycky73be5e32012-02-19 23:26:27 +00002376 getVal(CI->getOperand(0)),
Chris Lattner99e23fa2005-09-26 04:44:35 +00002377 CI->getType());
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002378 DEBUG(dbgs() << "Found a Cast! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002379 << "\n");
Chris Lattner99e23fa2005-09-26 04:44:35 +00002380 } else if (SelectInst *SI = dyn_cast<SelectInst>(CurInst)) {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002381 InstResult = ConstantExpr::getSelect(getVal(SI->getOperand(0)),
2382 getVal(SI->getOperand(1)),
2383 getVal(SI->getOperand(2)));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002384 DEBUG(dbgs() << "Found a Select! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002385 << "\n");
David Majnemerfe8c7542014-08-08 05:50:43 +00002386 } else if (auto *EVI = dyn_cast<ExtractValueInst>(CurInst)) {
2387 InstResult = ConstantExpr::getExtractValue(
2388 getVal(EVI->getAggregateOperand()), EVI->getIndices());
2389 DEBUG(dbgs() << "Found an ExtractValueInst! Simplifying: " << *InstResult
2390 << "\n");
2391 } else if (auto *IVI = dyn_cast<InsertValueInst>(CurInst)) {
2392 InstResult = ConstantExpr::getInsertValue(
2393 getVal(IVI->getAggregateOperand()),
2394 getVal(IVI->getInsertedValueOperand()), IVI->getIndices());
2395 DEBUG(dbgs() << "Found an InsertValueInst! Simplifying: " << *InstResult
2396 << "\n");
Chris Lattner4b05c322005-09-26 05:15:37 +00002397 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(CurInst)) {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002398 Constant *P = getVal(GEP->getOperand(0));
Chris Lattnerf96f4a82007-01-31 04:40:53 +00002399 SmallVector<Constant*, 8> GEPOps;
Gabor Greif3a9fba52008-05-29 01:59:18 +00002400 for (User::op_iterator i = GEP->op_begin() + 1, e = GEP->op_end();
2401 i != e; ++i)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002402 GEPOps.push_back(getVal(*i));
Jay Foad2f5fc8c2011-07-21 15:15:37 +00002403 InstResult =
David Blaikie4a2e73b2015-04-02 18:55:32 +00002404 ConstantExpr::getGetElementPtr(GEP->getSourceElementType(), P, GEPOps,
2405 cast<GEPOperator>(GEP)->isInBounds());
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002406 DEBUG(dbgs() << "Found a GEP! Simplifying: " << *InstResult
Michael Gottesman2a654272013-01-11 23:08:52 +00002407 << "\n");
Chris Lattner4b05c322005-09-26 05:15:37 +00002408 } else if (LoadInst *LI = dyn_cast<LoadInst>(CurInst)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002409
2410 if (!LI->isSimple()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002411 DEBUG(dbgs() << "Found a Load! Not a simple load, can not evaluate.\n");
2412 return false; // no volatile/atomic accesses.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002413 }
2414
Nick Lewycky9d0da182012-02-21 22:08:06 +00002415 Constant *Ptr = getVal(LI->getOperand(0));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002416 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002417 Ptr = ConstantFoldConstantExpression(CE, DL, TLI);
Michael Gottesman2a654272013-01-11 23:08:52 +00002418 DEBUG(dbgs() << "Found a constant pointer expression, constant "
2419 "folding: " << *Ptr << "\n");
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002420 }
Nick Lewycky9d0da182012-02-21 22:08:06 +00002421 InstResult = ComputeLoadResult(Ptr);
Craig Topperf40110f2014-04-25 05:29:35 +00002422 if (!InstResult) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002423 DEBUG(dbgs() << "Failed to compute load result. Can not evaluate load."
2424 "\n");
2425 return false; // Could not evaluate load.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002426 }
2427
2428 DEBUG(dbgs() << "Evaluated load: " << *InstResult << "\n");
Chris Lattner6bf2cd52005-09-26 17:07:09 +00002429 } else if (AllocaInst *AI = dyn_cast<AllocaInst>(CurInst)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002430 if (AI->isArrayAllocation()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002431 DEBUG(dbgs() << "Found an array alloca. Can not evaluate.\n");
2432 return false; // Cannot handle array allocs.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002433 }
Chris Lattner229907c2011-07-18 04:54:35 +00002434 Type *Ty = AI->getType()->getElementType();
David Blaikiebc442202014-04-21 20:49:36 +00002435 AllocaTmps.push_back(
2436 make_unique<GlobalVariable>(Ty, false, GlobalValue::InternalLinkage,
2437 UndefValue::get(Ty), AI->getName()));
2438 InstResult = AllocaTmps.back().get();
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002439 DEBUG(dbgs() << "Found an alloca. Result: " << *InstResult << "\n");
Nick Lewyckyc1572e42012-02-12 05:09:35 +00002440 } else if (isa<CallInst>(CurInst) || isa<InvokeInst>(CurInst)) {
2441 CallSite CS(CurInst);
Devang Patel04852aa2009-03-09 23:04:12 +00002442
2443 // Debug info can safely be ignored here.
Nick Lewyckyc1572e42012-02-12 05:09:35 +00002444 if (isa<DbgInfoIntrinsic>(CS.getInstruction())) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002445 DEBUG(dbgs() << "Ignoring debug info.\n");
Devang Patel04852aa2009-03-09 23:04:12 +00002446 ++CurInst;
2447 continue;
2448 }
2449
Chris Lattnerfd2e13b2006-07-07 21:37:01 +00002450 // Cannot handle inline asm.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002451 if (isa<InlineAsm>(CS.getCalledValue())) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002452 DEBUG(dbgs() << "Found inline asm, can not evaluate.\n");
2453 return false;
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002454 }
Chris Lattnerfd2e13b2006-07-07 21:37:01 +00002455
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002456 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction())) {
2457 if (MemSetInst *MSI = dyn_cast<MemSetInst>(II)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002458 if (MSI->isVolatile()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002459 DEBUG(dbgs() << "Can not optimize a volatile memset " <<
2460 "intrinsic.\n");
2461 return false;
2462 }
Nick Lewycky73be5e32012-02-19 23:26:27 +00002463 Constant *Ptr = getVal(MSI->getDest());
2464 Constant *Val = getVal(MSI->getValue());
2465 Constant *DestVal = ComputeLoadResult(getVal(Ptr));
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002466 if (Val->isNullValue() && DestVal && DestVal->isNullValue()) {
2467 // This memset is a no-op.
Michael Gottesman2a654272013-01-11 23:08:52 +00002468 DEBUG(dbgs() << "Ignoring no-op memset.\n");
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002469 ++CurInst;
2470 continue;
2471 }
2472 }
2473
2474 if (II->getIntrinsicID() == Intrinsic::lifetime_start ||
2475 II->getIntrinsicID() == Intrinsic::lifetime_end) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002476 DEBUG(dbgs() << "Ignoring lifetime intrinsic.\n");
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002477 ++CurInst;
2478 continue;
2479 }
2480
2481 if (II->getIntrinsicID() == Intrinsic::invariant_start) {
2482 // We don't insert an entry into Values, as it doesn't have a
2483 // meaningful return value.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002484 if (!II->use_empty()) {
Alp Tokerf907b892013-12-05 05:44:44 +00002485 DEBUG(dbgs() << "Found unused invariant_start. Can't evaluate.\n");
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002486 return false;
Michael Gottesman2a654272013-01-11 23:08:52 +00002487 }
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002488 ConstantInt *Size = cast<ConstantInt>(II->getArgOperand(0));
Nick Lewycky519561f2012-02-20 23:32:26 +00002489 Value *PtrArg = getVal(II->getArgOperand(1));
2490 Value *Ptr = PtrArg->stripPointerCasts();
2491 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Ptr)) {
2492 Type *ElemTy = cast<PointerType>(GV->getType())->getElementType();
Mehdi Amini46a43552015-03-04 18:43:29 +00002493 if (!Size->isAllOnesValue() &&
Nick Lewycky519561f2012-02-20 23:32:26 +00002494 Size->getValue().getLimitedValue() >=
Mehdi Amini46a43552015-03-04 18:43:29 +00002495 DL.getTypeStoreSize(ElemTy)) {
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002496 Invariants.insert(GV);
Michael Gottesman2a654272013-01-11 23:08:52 +00002497 DEBUG(dbgs() << "Found a global var that is an invariant: " << *GV
2498 << "\n");
2499 } else {
2500 DEBUG(dbgs() << "Found a global var, but can not treat it as an "
2501 "invariant.\n");
2502 }
Nick Lewycky68f9f9d2012-02-17 06:59:21 +00002503 }
2504 // Continue even if we do nothing.
Nick Lewyckya3bb03e2011-05-29 18:41:56 +00002505 ++CurInst;
2506 continue;
Piotr Padlewski4e7f7522015-08-25 01:34:15 +00002507 } else if (II->getIntrinsicID() == Intrinsic::assume) {
2508 DEBUG(dbgs() << "Skipping assume intrinsic.\n");
2509 ++CurInst;
2510 continue;
Nick Lewyckya3bb03e2011-05-29 18:41:56 +00002511 }
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002512
Michael Gottesman2a654272013-01-11 23:08:52 +00002513 DEBUG(dbgs() << "Unknown intrinsic. Can not evaluate.\n");
Nick Lewyckya3bb03e2011-05-29 18:41:56 +00002514 return false;
2515 }
2516
Chris Lattner65a3a092005-09-27 04:45:34 +00002517 // Resolve function pointers.
Nick Lewycky73be5e32012-02-19 23:26:27 +00002518 Function *Callee = dyn_cast<Function>(getVal(CS.getCalledValue()));
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002519 if (!Callee || Callee->mayBeOverridden()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002520 DEBUG(dbgs() << "Can not resolve function pointer.\n");
Nick Lewyckyc1572e42012-02-12 05:09:35 +00002521 return false; // Cannot resolve.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002522 }
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002523
Duncan Sandsc4ce58d82009-08-17 14:33:27 +00002524 SmallVector<Constant*, 8> Formals;
Nick Lewyckyc1572e42012-02-12 05:09:35 +00002525 for (User::op_iterator i = CS.arg_begin(), e = CS.arg_end(); i != e; ++i)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002526 Formals.push_back(getVal(*i));
Duncan Sandsc4ce58d82009-08-17 14:33:27 +00002527
Reid Spencer5301e7c2007-01-30 20:08:39 +00002528 if (Callee->isDeclaration()) {
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002529 // If this is a function we can constant fold, do it.
Chad Rosiere6de63d2011-12-01 21:29:16 +00002530 if (Constant *C = ConstantFoldCall(Callee, Formals, TLI)) {
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002531 InstResult = C;
Michael Gottesman2a654272013-01-11 23:08:52 +00002532 DEBUG(dbgs() << "Constant folded function call. Result: " <<
2533 *InstResult << "\n");
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002534 } else {
Michael Gottesman2a654272013-01-11 23:08:52 +00002535 DEBUG(dbgs() << "Can not constant fold function call.\n");
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002536 return false;
2537 }
2538 } else {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002539 if (Callee->getFunctionType()->isVarArg()) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002540 DEBUG(dbgs() << "Can not constant fold vararg function call.\n");
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002541 return false;
Michael Gottesman2a654272013-01-11 23:08:52 +00002542 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002543
Craig Topperf40110f2014-04-25 05:29:35 +00002544 Constant *RetVal = nullptr;
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002545 // Execute the call, if successful, use the return value.
Benjamin Kramer64425fe2014-05-03 15:50:37 +00002546 ValueStack.emplace_back();
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002547 if (!EvaluateFunction(Callee, RetVal, Formals)) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002548 DEBUG(dbgs() << "Failed to evaluate function.\n");
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002549 return false;
Michael Gottesman2a654272013-01-11 23:08:52 +00002550 }
David Blaikiebc442202014-04-21 20:49:36 +00002551 ValueStack.pop_back();
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002552 InstResult = RetVal;
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002553
Craig Topperf40110f2014-04-25 05:29:35 +00002554 if (InstResult) {
Michael Gottesman2a654272013-01-11 23:08:52 +00002555 DEBUG(dbgs() << "Successfully evaluated function. Result: " <<
2556 InstResult << "\n\n");
2557 } else {
2558 DEBUG(dbgs() << "Successfully evaluated function. Result: 0\n\n");
2559 }
Chris Lattner3d27e7f2005-09-27 05:02:43 +00002560 }
Reid Spencerde46e482006-11-02 20:25:50 +00002561 } else if (isa<TerminatorInst>(CurInst)) {
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002562 DEBUG(dbgs() << "Found a terminator instruction.\n");
2563
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002564 if (BranchInst *BI = dyn_cast<BranchInst>(CurInst)) {
2565 if (BI->isUnconditional()) {
Nick Lewycky239fdf02012-02-06 08:24:44 +00002566 NextBB = BI->getSuccessor(0);
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002567 } else {
Zhou Sheng75b871f2007-01-11 12:24:14 +00002568 ConstantInt *Cond =
Nick Lewycky73be5e32012-02-19 23:26:27 +00002569 dyn_cast<ConstantInt>(getVal(BI->getCondition()));
Chris Lattner15649082007-01-12 18:30:11 +00002570 if (!Cond) return false; // Cannot determine.
Zhou Sheng75b871f2007-01-11 12:24:14 +00002571
Nick Lewycky239fdf02012-02-06 08:24:44 +00002572 NextBB = BI->getSuccessor(!Cond->getZExtValue());
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002573 }
2574 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurInst)) {
2575 ConstantInt *Val =
Nick Lewycky73be5e32012-02-19 23:26:27 +00002576 dyn_cast<ConstantInt>(getVal(SI->getCondition()));
Chris Lattner65a3a092005-09-27 04:45:34 +00002577 if (!Val) return false; // Cannot determine.
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00002578 NextBB = SI->findCaseValue(Val).getCaseSuccessor();
Chris Lattner31274882009-10-29 05:51:50 +00002579 } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(CurInst)) {
Nick Lewycky73be5e32012-02-19 23:26:27 +00002580 Value *Val = getVal(IBI->getAddress())->stripPointerCasts();
Chris Lattner31274882009-10-29 05:51:50 +00002581 if (BlockAddress *BA = dyn_cast<BlockAddress>(Val))
Nick Lewycky239fdf02012-02-06 08:24:44 +00002582 NextBB = BA->getBasicBlock();
Chris Lattneraa99c942009-11-01 01:27:45 +00002583 else
2584 return false; // Cannot determine.
Nick Lewycky239fdf02012-02-06 08:24:44 +00002585 } else if (isa<ReturnInst>(CurInst)) {
Craig Topperf40110f2014-04-25 05:29:35 +00002586 NextBB = nullptr;
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002587 } else {
Bill Wendlingf891bf82011-07-31 06:30:59 +00002588 // invoke, unwind, resume, unreachable.
Michael Gottesman2a654272013-01-11 23:08:52 +00002589 DEBUG(dbgs() << "Can not handle terminator.");
Chris Lattner65a3a092005-09-27 04:45:34 +00002590 return false; // Cannot handle this terminator.
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00002591 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002592
Nick Lewycky239fdf02012-02-06 08:24:44 +00002593 // We succeeded at evaluating this block!
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002594 DEBUG(dbgs() << "Successfully evaluated block.\n");
Nick Lewycky239fdf02012-02-06 08:24:44 +00002595 return true;
Chris Lattner99e23fa2005-09-26 04:44:35 +00002596 } else {
Chris Lattner99e23fa2005-09-26 04:44:35 +00002597 // Did not know how to evaluate this!
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002598 DEBUG(dbgs() << "Failed to evaluate block due to unhandled instruction."
Michael Gottesman2a654272013-01-11 23:08:52 +00002599 "\n");
Chris Lattner65a3a092005-09-27 04:45:34 +00002600 return false;
Chris Lattner99e23fa2005-09-26 04:44:35 +00002601 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002602
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002603 if (!CurInst->use_empty()) {
2604 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(InstResult))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002605 InstResult = ConstantFoldConstantExpression(CE, DL, TLI);
Jakub Staszak9525a772012-12-06 21:57:16 +00002606
Nick Lewycky73be5e32012-02-19 23:26:27 +00002607 setVal(CurInst, InstResult);
Chris Lattner0d71c4f2010-12-07 04:33:29 +00002608 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002609
Dan Gohmaneab06fa2012-03-13 18:01:37 +00002610 // If we just processed an invoke, we finished evaluating the block.
2611 if (InvokeInst *II = dyn_cast<InvokeInst>(CurInst)) {
2612 NextBB = II->getNormalDest();
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002613 DEBUG(dbgs() << "Found an invoke instruction. Finished Block.\n\n");
Dan Gohmaneab06fa2012-03-13 18:01:37 +00002614 return true;
2615 }
2616
Chris Lattner99e23fa2005-09-26 04:44:35 +00002617 // Advance program counter.
2618 ++CurInst;
2619 }
Chris Lattnerda1889b2005-09-27 04:27:01 +00002620}
2621
Nick Lewycky239fdf02012-02-06 08:24:44 +00002622/// EvaluateFunction - Evaluate a call to function F, returning true if
2623/// successful, false if we can't evaluate it. ActualArgs contains the formal
2624/// arguments for the function.
Nick Lewycky60829a582012-02-20 03:25:59 +00002625bool Evaluator::EvaluateFunction(Function *F, Constant *&RetVal,
2626 const SmallVectorImpl<Constant*> &ActualArgs) {
Nick Lewycky239fdf02012-02-06 08:24:44 +00002627 // Check to see if this function is already executing (recursion). If so,
2628 // bail out. TODO: we might want to accept limited recursion.
2629 if (std::find(CallStack.begin(), CallStack.end(), F) != CallStack.end())
2630 return false;
2631
2632 CallStack.push_back(F);
2633
Nick Lewycky239fdf02012-02-06 08:24:44 +00002634 // Initialize arguments to the incoming values specified.
2635 unsigned ArgNo = 0;
2636 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end(); AI != E;
2637 ++AI, ++ArgNo)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002638 setVal(AI, ActualArgs[ArgNo]);
Nick Lewycky239fdf02012-02-06 08:24:44 +00002639
2640 // ExecutedBlocks - We only handle non-looping, non-recursive code. As such,
2641 // we can only evaluate any one basic block at most once. This set keeps
2642 // track of what we have executed so we can detect recursive cases etc.
2643 SmallPtrSet<BasicBlock*, 32> ExecutedBlocks;
2644
2645 // CurBB - The current basic block we're evaluating.
2646 BasicBlock *CurBB = F->begin();
2647
Nick Lewycky4231c412012-02-12 00:47:24 +00002648 BasicBlock::iterator CurInst = CurBB->begin();
2649
Nick Lewycky239fdf02012-02-06 08:24:44 +00002650 while (1) {
Craig Topperf40110f2014-04-25 05:29:35 +00002651 BasicBlock *NextBB = nullptr; // Initialized to avoid compiler warnings.
Michael Gottesmand1a46f22013-01-11 20:07:53 +00002652 DEBUG(dbgs() << "Trying to evaluate BB: " << *CurBB << "\n");
2653
Nick Lewycky73be5e32012-02-19 23:26:27 +00002654 if (!EvaluateBlock(CurInst, NextBB))
Nick Lewycky239fdf02012-02-06 08:24:44 +00002655 return false;
2656
Craig Topperf40110f2014-04-25 05:29:35 +00002657 if (!NextBB) {
Nick Lewycky239fdf02012-02-06 08:24:44 +00002658 // Successfully running until there's no next block means that we found
2659 // the return. Fill it the return value and pop the call stack.
2660 ReturnInst *RI = cast<ReturnInst>(CurBB->getTerminator());
2661 if (RI->getNumOperands())
Nick Lewycky73be5e32012-02-19 23:26:27 +00002662 RetVal = getVal(RI->getOperand(0));
Nick Lewycky239fdf02012-02-06 08:24:44 +00002663 CallStack.pop_back();
2664 return true;
2665 }
2666
2667 // Okay, we succeeded in evaluating this control flow. See if we have
2668 // executed the new block before. If so, we have a looping function,
2669 // which we cannot evaluate in reasonable time.
David Blaikie70573dc2014-11-19 07:49:26 +00002670 if (!ExecutedBlocks.insert(NextBB).second)
Nick Lewycky239fdf02012-02-06 08:24:44 +00002671 return false; // looped!
2672
2673 // Okay, we have never been in this block before. Check to see if there
2674 // are any PHI nodes. If so, evaluate them with information about where
2675 // we came from.
Craig Topperf40110f2014-04-25 05:29:35 +00002676 PHINode *PN = nullptr;
Nick Lewycky4231c412012-02-12 00:47:24 +00002677 for (CurInst = NextBB->begin();
2678 (PN = dyn_cast<PHINode>(CurInst)); ++CurInst)
Nick Lewycky73be5e32012-02-19 23:26:27 +00002679 setVal(PN, getVal(PN->getIncomingValueForBlock(CurBB)));
Nick Lewycky239fdf02012-02-06 08:24:44 +00002680
2681 // Advance to the next block.
2682 CurBB = NextBB;
2683 }
2684}
2685
Chris Lattnerda1889b2005-09-27 04:27:01 +00002686/// EvaluateStaticConstructor - Evaluate static constructors in the function, if
2687/// we can. Return true if we can, false otherwise.
Mehdi Amini46a43552015-03-04 18:43:29 +00002688static bool EvaluateStaticConstructor(Function *F, const DataLayout &DL,
Chad Rosiere6de63d2011-12-01 21:29:16 +00002689 const TargetLibraryInfo *TLI) {
Chris Lattnerda1889b2005-09-27 04:27:01 +00002690 // Call the function.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002691 Evaluator Eval(DL, TLI);
Chris Lattner65a3a092005-09-27 04:45:34 +00002692 Constant *RetValDummy;
Nick Lewycky73be5e32012-02-19 23:26:27 +00002693 bool EvalSuccess = Eval.EvaluateFunction(F, RetValDummy,
2694 SmallVector<Constant*, 0>());
Jakub Staszak9525a772012-12-06 21:57:16 +00002695
Chris Lattnerda1889b2005-09-27 04:27:01 +00002696 if (EvalSuccess) {
Nico Weber4b2acde2014-05-02 18:35:25 +00002697 ++NumCtorsEvaluated;
2698
Chris Lattner6bf2cd52005-09-26 17:07:09 +00002699 // We succeeded at evaluation: commit the result.
David Greene44cb8ad2010-01-05 01:28:05 +00002700 DEBUG(dbgs() << "FULLY EVALUATED GLOBAL CTOR FUNCTION '"
Anthony Pesche92ae2d2015-07-22 22:26:54 +00002701 << F->getName() << "' to " << Eval.getMutatedMemory().size()
2702 << " stores.\n");
2703 for (DenseMap<Constant*, Constant*>::const_iterator I =
2704 Eval.getMutatedMemory().begin(), E = Eval.getMutatedMemory().end();
2705 I != E; ++I)
2706 CommitValueTo(I->second, I->first);
Craig Topper46276792014-08-24 23:23:06 +00002707 for (GlobalVariable *GV : Eval.getInvariants())
2708 GV->setConstant(true);
Chris Lattner6bf2cd52005-09-26 17:07:09 +00002709 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00002710
Chris Lattnerda1889b2005-09-27 04:27:01 +00002711 return EvalSuccess;
Chris Lattner99e23fa2005-09-26 04:44:35 +00002712}
2713
Benjamin Krameradf1ea82014-03-07 21:52:38 +00002714static int compareNames(Constant *const *A, Constant *const *B) {
2715 return (*A)->getName().compare((*B)->getName());
2716}
2717
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002718static void setUsedInitializer(GlobalVariable &V,
Craig Topper97ebe532014-08-19 07:44:27 +00002719 const SmallPtrSet<GlobalValue *, 8> &Init) {
Rafael Espindolac2bb73f2013-07-20 23:33:15 +00002720 if (Init.empty()) {
2721 V.eraseFromParent();
2722 return;
2723 }
2724
Matt Arsenaultda1deab2014-01-02 19:53:49 +00002725 // Type of pointer to the array of pointers.
2726 PointerType *Int8PtrTy = Type::getInt8PtrTy(V.getContext(), 0);
Rafael Espindola00752162013-05-09 17:22:59 +00002727
Matt Arsenaultda1deab2014-01-02 19:53:49 +00002728 SmallVector<llvm::Constant *, 8> UsedArray;
Craig Topper71b7b682014-08-21 05:55:13 +00002729 for (GlobalValue *GV : Init) {
Matt Arsenaultda1deab2014-01-02 19:53:49 +00002730 Constant *Cast
Craig Topper71b7b682014-08-21 05:55:13 +00002731 = ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, Int8PtrTy);
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002732 UsedArray.push_back(Cast);
Rafael Espindola00752162013-05-09 17:22:59 +00002733 }
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002734 // Sort to get deterministic order.
Benjamin Krameradf1ea82014-03-07 21:52:38 +00002735 array_pod_sort(UsedArray.begin(), UsedArray.end(), compareNames);
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002736 ArrayType *ATy = ArrayType::get(Int8PtrTy, UsedArray.size());
Rafael Espindola00752162013-05-09 17:22:59 +00002737
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002738 Module *M = V.getParent();
2739 V.removeFromParent();
2740 GlobalVariable *NV =
2741 new GlobalVariable(*M, ATy, false, llvm::GlobalValue::AppendingLinkage,
2742 llvm::ConstantArray::get(ATy, UsedArray), "");
2743 NV->takeName(&V);
2744 NV->setSection("llvm.metadata");
2745 delete &V;
Rafael Espindola00752162013-05-09 17:22:59 +00002746}
2747
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002748namespace {
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002749/// \brief An easy to access representation of llvm.used and llvm.compiler.used.
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002750class LLVMUsed {
2751 SmallPtrSet<GlobalValue *, 8> Used;
2752 SmallPtrSet<GlobalValue *, 8> CompilerUsed;
2753 GlobalVariable *UsedV;
2754 GlobalVariable *CompilerUsedV;
2755
2756public:
Rafael Espindolaec2375f2013-07-25 02:50:08 +00002757 LLVMUsed(Module &M) {
Rafael Espindola17600e22013-07-25 03:23:25 +00002758 UsedV = collectUsedGlobalVariables(M, Used, false);
2759 CompilerUsedV = collectUsedGlobalVariables(M, CompilerUsed, true);
Rafael Espindola00752162013-05-09 17:22:59 +00002760 }
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002761 typedef SmallPtrSet<GlobalValue *, 8>::iterator iterator;
Craig Topper46276792014-08-24 23:23:06 +00002762 typedef iterator_range<iterator> used_iterator_range;
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002763 iterator usedBegin() { return Used.begin(); }
2764 iterator usedEnd() { return Used.end(); }
Craig Topper46276792014-08-24 23:23:06 +00002765 used_iterator_range used() {
2766 return used_iterator_range(usedBegin(), usedEnd());
2767 }
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002768 iterator compilerUsedBegin() { return CompilerUsed.begin(); }
2769 iterator compilerUsedEnd() { return CompilerUsed.end(); }
Craig Topper46276792014-08-24 23:23:06 +00002770 used_iterator_range compilerUsed() {
2771 return used_iterator_range(compilerUsedBegin(), compilerUsedEnd());
2772 }
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002773 bool usedCount(GlobalValue *GV) const { return Used.count(GV); }
2774 bool compilerUsedCount(GlobalValue *GV) const {
2775 return CompilerUsed.count(GV);
2776 }
2777 bool usedErase(GlobalValue *GV) { return Used.erase(GV); }
2778 bool compilerUsedErase(GlobalValue *GV) { return CompilerUsed.erase(GV); }
David Blaikie70573dc2014-11-19 07:49:26 +00002779 bool usedInsert(GlobalValue *GV) { return Used.insert(GV).second; }
2780 bool compilerUsedInsert(GlobalValue *GV) {
2781 return CompilerUsed.insert(GV).second;
2782 }
Rafael Espindola00752162013-05-09 17:22:59 +00002783
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002784 void syncVariablesAndSets() {
2785 if (UsedV)
2786 setUsedInitializer(*UsedV, Used);
2787 if (CompilerUsedV)
2788 setUsedInitializer(*CompilerUsedV, CompilerUsed);
2789 }
2790};
Alexander Kornienkof00654e2015-06-23 09:49:53 +00002791}
Rafael Espindola00752162013-05-09 17:22:59 +00002792
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002793static bool hasUseOtherThanLLVMUsed(GlobalAlias &GA, const LLVMUsed &U) {
2794 if (GA.use_empty()) // No use at all.
2795 return false;
2796
2797 assert((!U.usedCount(&GA) || !U.compilerUsedCount(&GA)) &&
2798 "We should have removed the duplicated "
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002799 "element from llvm.compiler.used");
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002800 if (!GA.hasOneUse())
2801 // Strictly more than one use. So at least one is not in llvm.used and
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002802 // llvm.compiler.used.
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002803 return true;
2804
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002805 // Exactly one use. Check if it is in llvm.used or llvm.compiler.used.
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002806 return !U.usedCount(&GA) && !U.compilerUsedCount(&GA);
Rafael Espindola00752162013-05-09 17:22:59 +00002807}
2808
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002809static bool hasMoreThanOneUseOtherThanLLVMUsed(GlobalValue &V,
2810 const LLVMUsed &U) {
2811 unsigned N = 2;
2812 assert((!U.usedCount(&V) || !U.compilerUsedCount(&V)) &&
2813 "We should have removed the duplicated "
Rafael Espindola9aadcc42013-07-19 18:44:51 +00002814 "element from llvm.compiler.used");
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002815 if (U.usedCount(&V) || U.compilerUsedCount(&V))
2816 ++N;
2817 return V.hasNUsesOrMore(N);
2818}
2819
2820static bool mayHaveOtherReferences(GlobalAlias &GA, const LLVMUsed &U) {
2821 if (!GA.hasLocalLinkage())
2822 return true;
2823
2824 return U.usedCount(&GA) || U.compilerUsedCount(&GA);
2825}
2826
Craig Topper71b7b682014-08-21 05:55:13 +00002827static bool hasUsesToReplace(GlobalAlias &GA, const LLVMUsed &U,
2828 bool &RenameTarget) {
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002829 RenameTarget = false;
Rafael Espindola00752162013-05-09 17:22:59 +00002830 bool Ret = false;
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002831 if (hasUseOtherThanLLVMUsed(GA, U))
Rafael Espindola00752162013-05-09 17:22:59 +00002832 Ret = true;
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002833
2834 // If the alias is externally visible, we may still be able to simplify it.
2835 if (!mayHaveOtherReferences(GA, U))
2836 return Ret;
2837
2838 // If the aliasee has internal linkage, give it the name and linkage
2839 // of the alias, and delete the alias. This turns:
2840 // define internal ... @f(...)
2841 // @a = alias ... @f
2842 // into:
2843 // define ... @a(...)
2844 Constant *Aliasee = GA.getAliasee();
2845 GlobalValue *Target = cast<GlobalValue>(Aliasee->stripPointerCasts());
2846 if (!Target->hasLocalLinkage())
2847 return Ret;
2848
2849 // Do not perform the transform if multiple aliases potentially target the
2850 // aliasee. This check also ensures that it is safe to replace the section
2851 // and other attributes of the aliasee with those of the alias.
2852 if (hasMoreThanOneUseOtherThanLLVMUsed(*Target, U))
2853 return Ret;
2854
2855 RenameTarget = true;
2856 return true;
Rafael Espindola00752162013-05-09 17:22:59 +00002857}
2858
Duncan Sandsed722832009-03-06 10:21:56 +00002859bool GlobalOpt::OptimizeGlobalAliases(Module &M) {
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00002860 bool Changed = false;
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002861 LLVMUsed Used(M);
2862
Craig Topper46276792014-08-24 23:23:06 +00002863 for (GlobalValue *GV : Used.used())
2864 Used.compilerUsedErase(GV);
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00002865
Duncan Sands0bcf0852009-01-07 20:01:06 +00002866 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
Duncan Sandsb3f27882009-02-15 09:56:08 +00002867 I != E;) {
2868 Module::alias_iterator J = I++;
Duncan Sandsed722832009-03-06 10:21:56 +00002869 // Aliases without names cannot be referenced outside this module.
David Majnemer5c921152014-07-01 15:26:50 +00002870 if (!J->hasName() && !J->isDeclaration() && !J->hasLocalLinkage())
Duncan Sandsed722832009-03-06 10:21:56 +00002871 J->setLinkage(GlobalValue::InternalLinkage);
Duncan Sandsb3f27882009-02-15 09:56:08 +00002872 // If the aliasee may change at link time, nothing can be done - bail out.
2873 if (J->mayBeOverridden())
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00002874 continue;
2875
Duncan Sandsb3f27882009-02-15 09:56:08 +00002876 Constant *Aliasee = J->getAliasee();
David Majnemer0e2cc2a2014-07-01 00:30:56 +00002877 GlobalValue *Target = dyn_cast<GlobalValue>(Aliasee->stripPointerCasts());
2878 // We can't trivially replace the alias with the aliasee if the aliasee is
2879 // non-trivial in some way.
2880 // TODO: Try to handle non-zero GEPs of local aliasees.
2881 if (!Target)
2882 continue;
Duncan Sands7a1db332009-02-18 17:55:38 +00002883 Target->removeDeadConstantUsers();
Duncan Sandsb3f27882009-02-15 09:56:08 +00002884
2885 // Make all users of the alias use the aliasee instead.
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002886 bool RenameTarget;
2887 if (!hasUsesToReplace(*J, Used, RenameTarget))
Rafael Espindola00752162013-05-09 17:22:59 +00002888 continue;
Duncan Sandsb3f27882009-02-15 09:56:08 +00002889
Rafael Espindola6b238632014-05-16 19:35:39 +00002890 J->replaceAllUsesWith(ConstantExpr::getBitCast(Aliasee, J->getType()));
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002891 ++NumAliasesResolved;
2892 Changed = true;
Duncan Sandsb3f27882009-02-15 09:56:08 +00002893
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002894 if (RenameTarget) {
Duncan Sands6a3df7b2009-12-08 10:10:20 +00002895 // Give the aliasee the name, linkage and other attributes of the alias.
2896 Target->takeName(J);
2897 Target->setLinkage(J->getLinkage());
Reid Kleckner22b19da2014-02-13 02:18:36 +00002898 Target->setVisibility(J->getVisibility());
2899 Target->setDLLStorageClass(J->getDLLStorageClass());
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002900
2901 if (Used.usedErase(J))
2902 Used.usedInsert(Target);
2903
2904 if (Used.compilerUsedErase(J))
2905 Used.compilerUsedInsert(Target);
Rafael Espindola8d304802013-06-12 16:45:47 +00002906 } else if (mayHaveOtherReferences(*J, Used))
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002907 continue;
2908
Duncan Sandsb3f27882009-02-15 09:56:08 +00002909 // Delete the alias.
2910 M.getAliasList().erase(J);
2911 ++NumAliasesRemoved;
2912 Changed = true;
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00002913 }
2914
Rafael Espindolaa82555c2013-06-11 17:48:06 +00002915 Used.syncVariablesAndSets();
2916
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00002917 return Changed;
2918}
Chris Lattner41b6a5a2005-09-26 01:43:45 +00002919
Nick Lewycky4b273cb2012-02-12 02:15:20 +00002920static Function *FindCXAAtExit(Module &M, TargetLibraryInfo *TLI) {
2921 if (!TLI->has(LibFunc::cxa_atexit))
Craig Topperf40110f2014-04-25 05:29:35 +00002922 return nullptr;
Nick Lewycky4b273cb2012-02-12 02:15:20 +00002923
2924 Function *Fn = M.getFunction(TLI->getName(LibFunc::cxa_atexit));
Jakub Staszak9525a772012-12-06 21:57:16 +00002925
Anders Carlssonee6bc702011-03-20 17:59:11 +00002926 if (!Fn)
Craig Topperf40110f2014-04-25 05:29:35 +00002927 return nullptr;
Nick Lewycky4b273cb2012-02-12 02:15:20 +00002928
Chris Lattner229907c2011-07-18 04:54:35 +00002929 FunctionType *FTy = Fn->getFunctionType();
Jakub Staszak9525a772012-12-06 21:57:16 +00002930
2931 // Checking that the function has the right return type, the right number of
Anders Carlsson48a44912011-03-20 19:51:13 +00002932 // parameters and that they all have pointer types should be enough.
2933 if (!FTy->getReturnType()->isIntegerTy() ||
2934 FTy->getNumParams() != 3 ||
Anders Carlssonee6bc702011-03-20 17:59:11 +00002935 !FTy->getParamType(0)->isPointerTy() ||
2936 !FTy->getParamType(1)->isPointerTy() ||
2937 !FTy->getParamType(2)->isPointerTy())
Craig Topperf40110f2014-04-25 05:29:35 +00002938 return nullptr;
Anders Carlssonee6bc702011-03-20 17:59:11 +00002939
2940 return Fn;
2941}
2942
2943/// cxxDtorIsEmpty - Returns whether the given function is an empty C++
2944/// destructor and can therefore be eliminated.
2945/// Note that we assume that other optimization passes have already simplified
2946/// the code so we only look for a function with a single basic block, where
Benjamin Kramer1a4695a2012-02-09 16:28:15 +00002947/// the only allowed instructions are 'ret', 'call' to an empty C++ dtor and
2948/// other side-effect free instructions.
Anders Carlssonfcec2f52011-03-20 20:16:43 +00002949static bool cxxDtorIsEmpty(const Function &Fn,
2950 SmallPtrSet<const Function *, 8> &CalledFunctions) {
Anders Carlsson48a44912011-03-20 19:51:13 +00002951 // FIXME: We could eliminate C++ destructors if they're readonly/readnone and
Nick Lewyckyd0781832011-03-21 02:26:01 +00002952 // nounwind, but that doesn't seem worth doing.
Anders Carlsson48a44912011-03-20 19:51:13 +00002953 if (Fn.isDeclaration())
2954 return false;
Anders Carlssonee6bc702011-03-20 17:59:11 +00002955
2956 if (++Fn.begin() != Fn.end())
2957 return false;
2958
2959 const BasicBlock &EntryBlock = Fn.getEntryBlock();
2960 for (BasicBlock::const_iterator I = EntryBlock.begin(), E = EntryBlock.end();
2961 I != E; ++I) {
2962 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
Anders Carlsson4dd420f2011-03-21 14:54:40 +00002963 // Ignore debug intrinsics.
2964 if (isa<DbgInfoIntrinsic>(CI))
2965 continue;
2966
Anders Carlssonee6bc702011-03-20 17:59:11 +00002967 const Function *CalledFn = CI->getCalledFunction();
2968
2969 if (!CalledFn)
2970 return false;
2971
Anders Carlsson1cc80732011-03-22 03:21:01 +00002972 SmallPtrSet<const Function *, 8> NewCalledFunctions(CalledFunctions);
2973
Anders Carlsson48a44912011-03-20 19:51:13 +00002974 // Don't treat recursive functions as empty.
David Blaikie70573dc2014-11-19 07:49:26 +00002975 if (!NewCalledFunctions.insert(CalledFn).second)
Anders Carlsson48a44912011-03-20 19:51:13 +00002976 return false;
2977
Anders Carlsson1cc80732011-03-22 03:21:01 +00002978 if (!cxxDtorIsEmpty(*CalledFn, NewCalledFunctions))
Anders Carlssonee6bc702011-03-20 17:59:11 +00002979 return false;
2980 } else if (isa<ReturnInst>(*I))
Benjamin Kramer487a3962012-02-09 14:26:06 +00002981 return true; // We're done.
2982 else if (I->mayHaveSideEffects())
2983 return false; // Destructor with side effects, bail.
Anders Carlssonee6bc702011-03-20 17:59:11 +00002984 }
2985
2986 return false;
2987}
2988
2989bool GlobalOpt::OptimizeEmptyGlobalCXXDtors(Function *CXAAtExitFn) {
2990 /// Itanium C++ ABI p3.3.5:
2991 ///
2992 /// After constructing a global (or local static) object, that will require
2993 /// destruction on exit, a termination function is registered as follows:
2994 ///
2995 /// extern "C" int __cxa_atexit ( void (*f)(void *), void *p, void *d );
2996 ///
2997 /// This registration, e.g. __cxa_atexit(f,p,d), is intended to cause the
2998 /// call f(p) when DSO d is unloaded, before all such termination calls
2999 /// registered before this one. It returns zero if registration is
Nick Lewyckyd0781832011-03-21 02:26:01 +00003000 /// successful, nonzero on failure.
Anders Carlssonee6bc702011-03-20 17:59:11 +00003001
3002 // This pass will look for calls to __cxa_atexit where the function is trivial
3003 // and remove them.
3004 bool Changed = false;
3005
Chandler Carruthcdf47882014-03-09 03:16:01 +00003006 for (auto I = CXAAtExitFn->user_begin(), E = CXAAtExitFn->user_end();
3007 I != E;) {
Anders Carlsson336fd902011-03-20 20:21:33 +00003008 // We're only interested in calls. Theoretically, we could handle invoke
3009 // instructions as well, but neither llvm-gcc nor clang generate invokes
3010 // to __cxa_atexit.
Anders Carlsson4dd420f2011-03-21 14:54:40 +00003011 CallInst *CI = dyn_cast<CallInst>(*I++);
3012 if (!CI)
Anders Carlsson336fd902011-03-20 20:21:33 +00003013 continue;
3014
Jakub Staszak9525a772012-12-06 21:57:16 +00003015 Function *DtorFn =
Anders Carlsson4dd420f2011-03-21 14:54:40 +00003016 dyn_cast<Function>(CI->getArgOperand(0)->stripPointerCasts());
Anders Carlssonee6bc702011-03-20 17:59:11 +00003017 if (!DtorFn)
3018 continue;
3019
Anders Carlssonfcec2f52011-03-20 20:16:43 +00003020 SmallPtrSet<const Function *, 8> CalledFunctions;
3021 if (!cxxDtorIsEmpty(*DtorFn, CalledFunctions))
Anders Carlssonee6bc702011-03-20 17:59:11 +00003022 continue;
3023
3024 // Just remove the call.
Anders Carlsson4dd420f2011-03-21 14:54:40 +00003025 CI->replaceAllUsesWith(Constant::getNullValue(CI->getType()));
3026 CI->eraseFromParent();
Anders Carlsson48a44912011-03-20 19:51:13 +00003027
Anders Carlssonee6bc702011-03-20 17:59:11 +00003028 ++NumCXXDtorsRemoved;
3029
3030 Changed |= true;
3031 }
3032
3033 return Changed;
3034}
3035
Chris Lattner25db5802004-10-07 04:16:33 +00003036bool GlobalOpt::runOnModule(Module &M) {
3037 bool Changed = false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003038
Mehdi Amini46a43552015-03-04 18:43:29 +00003039 auto &DL = M.getDataLayout();
Chandler Carruthb98f63d2015-01-15 10:41:28 +00003040 TLI = &getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
Nick Lewyckycf6aae62012-02-12 01:13:18 +00003041
Chris Lattner25db5802004-10-07 04:16:33 +00003042 bool LocalChange = true;
3043 while (LocalChange) {
3044 LocalChange = false;
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003045
David Majnemer1b3b70e2014-10-08 07:23:31 +00003046 NotDiscardableComdats.clear();
3047 for (const GlobalVariable &GV : M.globals())
3048 if (const Comdat *C = GV.getComdat())
3049 if (!GV.isDiscardableIfUnused() || !GV.use_empty())
3050 NotDiscardableComdats.insert(C);
3051 for (Function &F : M)
3052 if (const Comdat *C = F.getComdat())
3053 if (!F.isDefTriviallyDead())
3054 NotDiscardableComdats.insert(C);
3055 for (GlobalAlias &GA : M.aliases())
3056 if (const Comdat *C = GA.getComdat())
3057 if (!GA.isDiscardableIfUnused() || !GA.use_empty())
3058 NotDiscardableComdats.insert(C);
3059
Chris Lattner41b6a5a2005-09-26 01:43:45 +00003060 // Delete functions that are trivially dead, ccc -> fastcc
3061 LocalChange |= OptimizeFunctions(M);
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003062
Chris Lattner41b6a5a2005-09-26 01:43:45 +00003063 // Optimize global_ctors list.
Richard Smithc167d652014-05-06 01:44:26 +00003064 LocalChange |= optimizeGlobalCtorsList(M, [&](Function *F) {
3065 return EvaluateStaticConstructor(F, DL, TLI);
3066 });
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003067
Chris Lattner41b6a5a2005-09-26 01:43:45 +00003068 // Optimize non-address-taken globals.
3069 LocalChange |= OptimizeGlobalVars(M);
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00003070
3071 // Resolve aliases, when possible.
Duncan Sandsed722832009-03-06 10:21:56 +00003072 LocalChange |= OptimizeGlobalAliases(M);
Anders Carlssonee6bc702011-03-20 17:59:11 +00003073
Manman Renb3c52fb2013-05-14 21:52:44 +00003074 // Try to remove trivial global destructors if they are not removed
3075 // already.
3076 Function *CXAAtExitFn = FindCXAAtExit(M, TLI);
Anders Carlssonee6bc702011-03-20 17:59:11 +00003077 if (CXAAtExitFn)
3078 LocalChange |= OptimizeEmptyGlobalCXXDtors(CXAAtExitFn);
3079
Anton Korobeynikova9b60ee2008-09-09 19:04:59 +00003080 Changed |= LocalChange;
Chris Lattner25db5802004-10-07 04:16:33 +00003081 }
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003082
Chris Lattner41b6a5a2005-09-26 01:43:45 +00003083 // TODO: Move all global ctors functions to the end of the module for code
3084 // layout.
Mikhail Glushenkovcf2afe02010-10-18 21:16:00 +00003085
Chris Lattner25db5802004-10-07 04:16:33 +00003086 return Changed;
3087}
Anthony Pescha2d93692015-07-22 18:50:10 +00003088