blob: 642eb2f1205299f12d433bca7b108d952e957a86 [file] [log] [blame]
Chris Lattner7a90b682004-10-07 04:16:33 +00001//===- GlobalOpt.cpp - Optimize Global Variables --------------------------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
Chris Lattner079236d2004-02-25 21:34:36 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
Chris Lattner079236d2004-02-25 21:34:36 +00008//===----------------------------------------------------------------------===//
9//
Chris Lattner7a90b682004-10-07 04:16:33 +000010// 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.
Chris Lattner079236d2004-02-25 21:34:36 +000013//
14//===----------------------------------------------------------------------===//
15
Chris Lattner7a90b682004-10-07 04:16:33 +000016#define DEBUG_TYPE "globalopt"
Chris Lattner079236d2004-02-25 21:34:36 +000017#include "llvm/Transforms/IPO.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000018#include "llvm/ADT/DenseMap.h"
19#include "llvm/ADT/STLExtras.h"
20#include "llvm/ADT/SmallPtrSet.h"
21#include "llvm/ADT/SmallVector.h"
22#include "llvm/ADT/Statistic.h"
23#include "llvm/Analysis/ConstantFolding.h"
24#include "llvm/Analysis/MemoryBuiltins.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000025#include "llvm/IR/CallingConv.h"
26#include "llvm/IR/Constants.h"
27#include "llvm/IR/DataLayout.h"
28#include "llvm/IR/DerivedTypes.h"
29#include "llvm/IR/Instructions.h"
30#include "llvm/IR/IntrinsicInst.h"
31#include "llvm/IR/Module.h"
32#include "llvm/IR/Operator.h"
Chris Lattner079236d2004-02-25 21:34:36 +000033#include "llvm/Pass.h"
Duncan Sands548448a2008-02-18 17:32:13 +000034#include "llvm/Support/CallSite.h"
Chris Lattner79066fa2007-01-30 23:46:24 +000035#include "llvm/Support/Debug.h"
Torok Edwinc25e7582009-07-11 20:10:48 +000036#include "llvm/Support/ErrorHandling.h"
Chris Lattner941db492008-01-14 02:09:12 +000037#include "llvm/Support/GetElementPtrTypeIterator.h"
Chris Lattner998182b2008-04-26 07:40:11 +000038#include "llvm/Support/MathExtras.h"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +000039#include "llvm/Support/raw_ostream.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000040#include "llvm/Target/TargetLibraryInfo.h"
Rafael Espindola4ef7eaf2013-07-25 03:23:25 +000041#include "llvm/Transforms/Utils/ModuleUtils.h"
Chris Lattnere47ba742004-10-06 20:57:02 +000042#include <algorithm>
Chris Lattner079236d2004-02-25 21:34:36 +000043using namespace llvm;
44
Chris Lattner86453c52006-12-19 22:09:18 +000045STATISTIC(NumMarked , "Number of globals marked constant");
Rafael Espindolac4440e32011-01-19 16:32:21 +000046STATISTIC(NumUnnamed , "Number of globals marked unnamed_addr");
Chris Lattner86453c52006-12-19 22:09:18 +000047STATISTIC(NumSRA , "Number of aggregate globals broken into scalars");
48STATISTIC(NumHeapSRA , "Number of heap objects SRA'd");
49STATISTIC(NumSubstitute,"Number of globals with initializers stored into them");
50STATISTIC(NumDeleted , "Number of globals deleted");
51STATISTIC(NumFnDeleted , "Number of functions deleted");
52STATISTIC(NumGlobUses , "Number of global uses devirtualized");
Alexey Samsonov23eb9072013-10-07 19:03:24 +000053STATISTIC(NumLocalized , "Number of globals localized");
Chris Lattner86453c52006-12-19 22:09:18 +000054STATISTIC(NumShrunkToBool , "Number of global vars shrunk to booleans");
55STATISTIC(NumFastCallFns , "Number of functions converted to fastcc");
56STATISTIC(NumCtorsEvaluated, "Number of static ctors evaluated");
Duncan Sands3d5378f2008-02-16 20:56:04 +000057STATISTIC(NumNestRemoved , "Number of nest attributes removed");
Duncan Sands4782b302009-02-15 09:56:08 +000058STATISTIC(NumAliasesResolved, "Number of global aliases resolved");
59STATISTIC(NumAliasesRemoved, "Number of global aliases eliminated");
Anders Carlssona201c4c2011-03-20 17:59:11 +000060STATISTIC(NumCXXDtorsRemoved, "Number of global C++ destructors removed");
Chris Lattner079236d2004-02-25 21:34:36 +000061
Chris Lattner86453c52006-12-19 22:09:18 +000062namespace {
Rafael Espindolac4440e32011-01-19 16:32:21 +000063 struct GlobalStatus;
Nick Lewycky6726b6d2009-10-25 06:33:48 +000064 struct GlobalOpt : public ModulePass {
Chris Lattner30ba5692004-10-11 05:54:41 +000065 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Chad Rosier00737bd2011-12-01 21:29:16 +000066 AU.addRequired<TargetLibraryInfo>();
Chris Lattner30ba5692004-10-11 05:54:41 +000067 }
Nick Lewyckyecd94c82007-05-06 13:37:16 +000068 static char ID; // Pass identification, replacement for typeid
Owen Anderson081c34b2010-10-19 17:21:58 +000069 GlobalOpt() : ModulePass(ID) {
70 initializeGlobalOptPass(*PassRegistry::getPassRegistry());
71 }
Misha Brukmanfd939082005-04-21 23:48:37 +000072
Chris Lattnerb12914b2004-09-20 04:48:05 +000073 bool runOnModule(Module &M);
Chris Lattner30ba5692004-10-11 05:54:41 +000074
75 private:
Chris Lattnerb1ab4582005-09-26 01:43:45 +000076 GlobalVariable *FindGlobalCtors(Module &M);
77 bool OptimizeFunctions(Module &M);
78 bool OptimizeGlobalVars(Module &M);
Duncan Sandsfc5940d2009-03-06 10:21:56 +000079 bool OptimizeGlobalAliases(Module &M);
Chris Lattnerb1ab4582005-09-26 01:43:45 +000080 bool OptimizeGlobalCtorsList(GlobalVariable *&GCL);
Rafael Espindolac4440e32011-01-19 16:32:21 +000081 bool ProcessGlobal(GlobalVariable *GV,Module::global_iterator &GVI);
82 bool ProcessInternalGlobal(GlobalVariable *GV,Module::global_iterator &GVI,
Rafael Espindolac4440e32011-01-19 16:32:21 +000083 const GlobalStatus &GS);
Anders Carlssona201c4c2011-03-20 17:59:11 +000084 bool OptimizeEmptyGlobalCXXDtors(Function *CXAAtExitFn);
Nick Lewycky6a577f82012-02-12 01:13:18 +000085
Micah Villmow3574eca2012-10-08 16:38:25 +000086 DataLayout *TD;
Nick Lewycky6a577f82012-02-12 01:13:18 +000087 TargetLibraryInfo *TLI;
Chris Lattner079236d2004-02-25 21:34:36 +000088 };
Chris Lattner079236d2004-02-25 21:34:36 +000089}
90
Dan Gohman844731a2008-05-13 00:00:25 +000091char GlobalOpt::ID = 0;
Chad Rosier00737bd2011-12-01 21:29:16 +000092INITIALIZE_PASS_BEGIN(GlobalOpt, "globalopt",
93 "Global Variable Optimizer", false, false)
94INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfo)
95INITIALIZE_PASS_END(GlobalOpt, "globalopt",
Owen Andersonce665bd2010-10-07 22:25:06 +000096 "Global Variable Optimizer", false, false)
Dan Gohman844731a2008-05-13 00:00:25 +000097
Chris Lattner7a90b682004-10-07 04:16:33 +000098ModulePass *llvm::createGlobalOptimizerPass() { return new GlobalOpt(); }
Chris Lattner079236d2004-02-25 21:34:36 +000099
Dan Gohman844731a2008-05-13 00:00:25 +0000100namespace {
101
Chris Lattner7a90b682004-10-07 04:16:33 +0000102/// GlobalStatus - As we analyze each global, keep track of some information
103/// about it. If we find out that the address of the global is taken, none of
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000104/// this info will be accurate.
Nick Lewycky6726b6d2009-10-25 06:33:48 +0000105struct GlobalStatus {
Rafael Espindolac4440e32011-01-19 16:32:21 +0000106 /// isCompared - True if the global's address is used in a comparison.
107 bool isCompared;
108
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000109 /// isLoaded - True if the global is ever loaded. If the global isn't ever
110 /// loaded it can be deleted.
Chris Lattner7a90b682004-10-07 04:16:33 +0000111 bool isLoaded;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000112
113 /// StoredType - Keep track of what stores to the global look like.
114 ///
Chris Lattner7a90b682004-10-07 04:16:33 +0000115 enum StoredType {
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000116 /// NotStored - There is no store to this global. It can thus be marked
117 /// constant.
118 NotStored,
119
120 /// isInitializerStored - This global is stored to, but the only thing
121 /// stored is the constant it was initialized with. This is only tracked
122 /// for scalar globals.
123 isInitializerStored,
124
125 /// isStoredOnce - This global is stored to, but only its initializer and
126 /// one other value is ever stored to it. If this global isStoredOnce, we
127 /// track the value stored to it in StoredOnceValue below. This is only
128 /// tracked for scalar globals.
129 isStoredOnce,
130
131 /// isStored - This global is stored to by multiple values or something else
132 /// that we cannot track.
133 isStored
Chris Lattner7a90b682004-10-07 04:16:33 +0000134 } StoredType;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000135
136 /// StoredOnceValue - If only one value (besides the initializer constant) is
137 /// ever stored to this global, keep track of what value it is.
138 Value *StoredOnceValue;
139
Alexey Samsonov23eb9072013-10-07 19:03:24 +0000140 /// AccessingFunction/HasMultipleAccessingFunctions - These start out
141 /// null/false. When the first accessing function is noticed, it is recorded.
142 /// When a second different accessing function is noticed,
143 /// HasMultipleAccessingFunctions is set to true.
144 const Function *AccessingFunction;
145 bool HasMultipleAccessingFunctions;
146
147 /// HasNonInstructionUser - Set to true if this global has a user that is not
148 /// an instruction (e.g. a constant expr or GV initializer).
149 bool HasNonInstructionUser;
150
Nick Lewyckyfad4d402012-02-05 19:56:38 +0000151 /// AtomicOrdering - Set to the strongest atomic ordering requirement.
152 AtomicOrdering Ordering;
153
Alexey Samsonov23eb9072013-10-07 19:03:24 +0000154 GlobalStatus() : isCompared(false), isLoaded(false), StoredType(NotStored),
155 StoredOnceValue(0), AccessingFunction(0),
156 HasMultipleAccessingFunctions(false),
157 HasNonInstructionUser(false), Ordering(NotAtomic) {}
Chris Lattner7a90b682004-10-07 04:16:33 +0000158};
Chris Lattnere47ba742004-10-06 20:57:02 +0000159
Dan Gohman844731a2008-05-13 00:00:25 +0000160}
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000161
Nick Lewyckyfad4d402012-02-05 19:56:38 +0000162/// StrongerOrdering - Return the stronger of the two ordering. If the two
163/// orderings are acquire and release, then return AcquireRelease.
164///
165static AtomicOrdering StrongerOrdering(AtomicOrdering X, AtomicOrdering Y) {
166 if (X == Acquire && Y == Release) return AcquireRelease;
167 if (Y == Acquire && X == Release) return AcquireRelease;
168 return (AtomicOrdering)std::max(X, Y);
169}
170
Sylvestre Ledru94c22712012-09-27 10:14:43 +0000171/// SafeToDestroyConstant - It is safe to destroy a constant iff it is only used
Nick Lewyckybc384a12012-02-05 19:48:37 +0000172/// by constants itself. Note that constants cannot be cyclic, so this test is
173/// pretty easy to implement recursively.
174///
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000175static bool SafeToDestroyConstant(const Constant *C) {
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000176 if (isa<GlobalValue>(C)) return false;
177
Gabor Greif27236912010-04-07 18:59:26 +0000178 for (Value::const_use_iterator UI = C->use_begin(), E = C->use_end(); UI != E;
179 ++UI)
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000180 if (const Constant *CU = dyn_cast<Constant>(*UI)) {
Jay Foade3acf152009-06-09 21:37:11 +0000181 if (!SafeToDestroyConstant(CU)) return false;
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000182 } else
183 return false;
184 return true;
185}
186
Rafael Espindola4a7cef22013-10-17 18:00:25 +0000187static bool analyzeGlobalAux(const Value *V, GlobalStatus &GS,
188 SmallPtrSet<const PHINode *, 16> &PHIUsers) {
Gabor Greif27236912010-04-07 18:59:26 +0000189 for (Value::const_use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;
Gabor Greife6642672010-07-09 16:51:20 +0000190 ++UI) {
191 const User *U = *UI;
192 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
Alexey Samsonov23eb9072013-10-07 19:03:24 +0000193 GS.HasNonInstructionUser = true;
194
Chris Lattnerd91ed102011-01-01 22:31:46 +0000195 // If the result of the constantexpr isn't pointer type, then we won't
196 // know to expect it in various places. Just reject early.
197 if (!isa<PointerType>(CE->getType())) return true;
Jakub Staszak582088c2012-12-06 21:57:16 +0000198
Rafael Espindola4a7cef22013-10-17 18:00:25 +0000199 if (analyzeGlobalAux(CE, GS, PHIUsers))
200 return true;
Gabor Greife6642672010-07-09 16:51:20 +0000201 } else if (const Instruction *I = dyn_cast<Instruction>(U)) {
Alexey Samsonov23eb9072013-10-07 19:03:24 +0000202 if (!GS.HasMultipleAccessingFunctions) {
203 const Function *F = I->getParent()->getParent();
204 if (GS.AccessingFunction == 0)
205 GS.AccessingFunction = F;
206 else if (GS.AccessingFunction != F)
207 GS.HasMultipleAccessingFunctions = true;
208 }
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000209 if (const LoadInst *LI = dyn_cast<LoadInst>(I)) {
Chris Lattner7a90b682004-10-07 04:16:33 +0000210 GS.isLoaded = true;
Nick Lewyckyfad4d402012-02-05 19:56:38 +0000211 // Don't hack on volatile loads.
212 if (LI->isVolatile()) return true;
213 GS.Ordering = StrongerOrdering(GS.Ordering, LI->getOrdering());
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000214 } else if (const StoreInst *SI = dyn_cast<StoreInst>(I)) {
Chris Lattner36025492004-10-07 06:01:25 +0000215 // Don't allow a store OF the address, only stores TO the address.
216 if (SI->getOperand(0) == V) return true;
217
Nick Lewyckyfad4d402012-02-05 19:56:38 +0000218 // Don't hack on volatile stores.
219 if (SI->isVolatile()) return true;
Hans Wennborg18398582012-11-15 11:40:00 +0000220
Nick Lewyckyfad4d402012-02-05 19:56:38 +0000221 GS.Ordering = StrongerOrdering(GS.Ordering, SI->getOrdering());
Chris Lattnerc69d3c92008-01-29 19:01:37 +0000222
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000223 // If this is a direct store to the global (i.e., the global is a scalar
224 // value, not an aggregate), keep more specific information about
225 // stores.
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000226 if (GS.StoredType != GlobalStatus::isStored) {
Gabor Greif27236912010-04-07 18:59:26 +0000227 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(
228 SI->getOperand(1))) {
Chris Lattnerbd38edf2004-11-14 20:50:30 +0000229 Value *StoredVal = SI->getOperand(0);
Hans Wennborg18398582012-11-15 11:40:00 +0000230
231 if (Constant *C = dyn_cast<Constant>(StoredVal)) {
232 if (C->isThreadDependent()) {
233 // The stored value changes between threads; don't track it.
234 return true;
235 }
236 }
237
Chris Lattnerbd38edf2004-11-14 20:50:30 +0000238 if (StoredVal == GV->getInitializer()) {
239 if (GS.StoredType < GlobalStatus::isInitializerStored)
240 GS.StoredType = GlobalStatus::isInitializerStored;
241 } else if (isa<LoadInst>(StoredVal) &&
242 cast<LoadInst>(StoredVal)->getOperand(0) == GV) {
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000243 if (GS.StoredType < GlobalStatus::isInitializerStored)
244 GS.StoredType = GlobalStatus::isInitializerStored;
245 } else if (GS.StoredType < GlobalStatus::isStoredOnce) {
246 GS.StoredType = GlobalStatus::isStoredOnce;
Chris Lattnerbd38edf2004-11-14 20:50:30 +0000247 GS.StoredOnceValue = StoredVal;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000248 } else if (GS.StoredType == GlobalStatus::isStoredOnce &&
Chris Lattnerbd38edf2004-11-14 20:50:30 +0000249 GS.StoredOnceValue == StoredVal) {
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000250 // noop.
251 } else {
252 GS.StoredType = GlobalStatus::isStored;
253 }
254 } else {
Chris Lattner7a90b682004-10-07 04:16:33 +0000255 GS.StoredType = GlobalStatus::isStored;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000256 }
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000257 }
Duncan Sandsb2fe7f12012-07-02 18:55:39 +0000258 } else if (isa<BitCastInst>(I)) {
Rafael Espindola4a7cef22013-10-17 18:00:25 +0000259 if (analyzeGlobalAux(I, GS, PHIUsers))
260 return true;
Chris Lattner35c81b02005-02-27 18:58:52 +0000261 } else if (isa<GetElementPtrInst>(I)) {
Rafael Espindola4a7cef22013-10-17 18:00:25 +0000262 if (analyzeGlobalAux(I, GS, PHIUsers))
263 return true;
Chris Lattner35c81b02005-02-27 18:58:52 +0000264 } else if (isa<SelectInst>(I)) {
Rafael Espindola4a7cef22013-10-17 18:00:25 +0000265 if (analyzeGlobalAux(I, GS, PHIUsers))
266 return true;
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000267 } else if (const PHINode *PN = dyn_cast<PHINode>(I)) {
Chris Lattner7a90b682004-10-07 04:16:33 +0000268 // PHI nodes we can check just like select or GEP instructions, but we
269 // have to be careful about infinite recursion.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +0000270 if (PHIUsers.insert(PN)) // Not already visited.
Rafael Espindola4a7cef22013-10-17 18:00:25 +0000271 if (analyzeGlobalAux(I, GS, PHIUsers))
272 return true;
Reid Spencere4d87aa2006-12-23 06:05:41 +0000273 } else if (isa<CmpInst>(I)) {
Rafael Espindolac4440e32011-01-19 16:32:21 +0000274 GS.isCompared = true;
Nick Lewycky1f237b02011-05-29 18:41:56 +0000275 } else if (const MemTransferInst *MTI = dyn_cast<MemTransferInst>(I)) {
276 if (MTI->isVolatile()) return true;
Gabor Greif9e4f2432010-06-24 14:42:01 +0000277 if (MTI->getArgOperand(0) == V)
Eric Christopher551754c2010-04-16 23:37:20 +0000278 GS.StoredType = GlobalStatus::isStored;
Gabor Greif9e4f2432010-06-24 14:42:01 +0000279 if (MTI->getArgOperand(1) == V)
Chris Lattner35c81b02005-02-27 18:58:52 +0000280 GS.isLoaded = true;
Nick Lewycky1f237b02011-05-29 18:41:56 +0000281 } else if (const MemSetInst *MSI = dyn_cast<MemSetInst>(I)) {
282 assert(MSI->getArgOperand(0) == V && "Memset only takes one pointer!");
283 if (MSI->isVolatile()) return true;
Chris Lattner35c81b02005-02-27 18:58:52 +0000284 GS.StoredType = GlobalStatus::isStored;
Chris Lattner7a90b682004-10-07 04:16:33 +0000285 } else {
286 return true; // Any other non-load instruction might take address!
Chris Lattner9ce30002004-07-20 03:58:07 +0000287 }
Gabor Greife6642672010-07-09 16:51:20 +0000288 } else if (const Constant *C = dyn_cast<Constant>(U)) {
Alexey Samsonov23eb9072013-10-07 19:03:24 +0000289 GS.HasNonInstructionUser = true;
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000290 // We might have a dead and dangling constant hanging off of here.
Jay Foade3acf152009-06-09 21:37:11 +0000291 if (!SafeToDestroyConstant(C))
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000292 return true;
Chris Lattner079236d2004-02-25 21:34:36 +0000293 } else {
Alexey Samsonov23eb9072013-10-07 19:03:24 +0000294 GS.HasNonInstructionUser = true;
Chris Lattner553ca522005-06-15 21:11:48 +0000295 // Otherwise must be some other user.
Chris Lattner079236d2004-02-25 21:34:36 +0000296 return true;
297 }
Gabor Greife6642672010-07-09 16:51:20 +0000298 }
Chris Lattner079236d2004-02-25 21:34:36 +0000299
300 return false;
301}
302
Rafael Espindola4a7cef22013-10-17 18:00:25 +0000303/// Look at all uses of the global and fill in the GlobalStatus
304/// structure. If the global has its address taken, return true to indicate we
305/// can't do anything with it.
306///
307static bool analyzeGlobal(const Value *V, GlobalStatus &GS) {
308 SmallPtrSet<const PHINode *, 16> PHIUsers;
309 return analyzeGlobalAux(V, GS, PHIUsers);
310}
311
Nick Lewycky8899d5c2012-07-24 07:21:08 +0000312/// isLeakCheckerRoot - Is this global variable possibly used by a leak checker
313/// as a root? If so, we might not really want to eliminate the stores to it.
314static bool isLeakCheckerRoot(GlobalVariable *GV) {
315 // A global variable is a root if it is a pointer, or could plausibly contain
316 // a pointer. There are two challenges; one is that we could have a struct
317 // the has an inner member which is a pointer. We recurse through the type to
318 // detect these (up to a point). The other is that we may actually be a union
319 // of a pointer and another type, and so our LLVM type is an integer which
320 // gets converted into a pointer, or our type is an [i8 x #] with a pointer
321 // potentially contained here.
322
323 if (GV->hasPrivateLinkage())
324 return false;
325
326 SmallVector<Type *, 4> Types;
327 Types.push_back(cast<PointerType>(GV->getType())->getElementType());
328
329 unsigned Limit = 20;
330 do {
331 Type *Ty = Types.pop_back_val();
332 switch (Ty->getTypeID()) {
333 default: break;
334 case Type::PointerTyID: return true;
335 case Type::ArrayTyID:
336 case Type::VectorTyID: {
337 SequentialType *STy = cast<SequentialType>(Ty);
338 Types.push_back(STy->getElementType());
339 break;
340 }
341 case Type::StructTyID: {
342 StructType *STy = cast<StructType>(Ty);
343 if (STy->isOpaque()) return true;
344 for (StructType::element_iterator I = STy->element_begin(),
345 E = STy->element_end(); I != E; ++I) {
346 Type *InnerTy = *I;
347 if (isa<PointerType>(InnerTy)) return true;
348 if (isa<CompositeType>(InnerTy))
349 Types.push_back(InnerTy);
350 }
351 break;
352 }
353 }
354 if (--Limit == 0) return true;
355 } while (!Types.empty());
356 return false;
357}
358
359/// Given a value that is stored to a global but never read, determine whether
360/// it's safe to remove the store and the chain of computation that feeds the
361/// store.
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000362static bool IsSafeComputationToRemove(Value *V, const TargetLibraryInfo *TLI) {
Nick Lewycky8899d5c2012-07-24 07:21:08 +0000363 do {
364 if (isa<Constant>(V))
365 return true;
366 if (!V->hasOneUse())
367 return false;
Nick Lewyckyb8cd66b2012-07-25 21:19:40 +0000368 if (isa<LoadInst>(V) || isa<InvokeInst>(V) || isa<Argument>(V) ||
369 isa<GlobalValue>(V))
Nick Lewycky8899d5c2012-07-24 07:21:08 +0000370 return false;
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000371 if (isAllocationFn(V, TLI))
Nick Lewycky8899d5c2012-07-24 07:21:08 +0000372 return true;
373
374 Instruction *I = cast<Instruction>(V);
375 if (I->mayHaveSideEffects())
376 return false;
377 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(I)) {
378 if (!GEP->hasAllConstantIndices())
379 return false;
380 } else if (I->getNumOperands() != 1) {
381 return false;
382 }
383
384 V = I->getOperand(0);
385 } while (1);
386}
387
388/// CleanupPointerRootUsers - This GV is a pointer root. Loop over all users
389/// of the global and clean up any that obviously don't assign the global a
390/// value that isn't dynamically allocated.
391///
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000392static bool CleanupPointerRootUsers(GlobalVariable *GV,
393 const TargetLibraryInfo *TLI) {
Nick Lewycky8899d5c2012-07-24 07:21:08 +0000394 // A brief explanation of leak checkers. The goal is to find bugs where
395 // pointers are forgotten, causing an accumulating growth in memory
396 // usage over time. The common strategy for leak checkers is to whitelist the
397 // memory pointed to by globals at exit. This is popular because it also
398 // solves another problem where the main thread of a C++ program may shut down
399 // before other threads that are still expecting to use those globals. To
400 // handle that case, we expect the program may create a singleton and never
401 // destroy it.
402
403 bool Changed = false;
404
405 // If Dead[n].first is the only use of a malloc result, we can delete its
406 // chain of computation and the store to the global in Dead[n].second.
407 SmallVector<std::pair<Instruction *, Instruction *>, 32> Dead;
408
409 // Constants can't be pointers to dynamically allocated memory.
410 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end();
411 UI != E;) {
412 User *U = *UI++;
413 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
414 Value *V = SI->getValueOperand();
415 if (isa<Constant>(V)) {
416 Changed = true;
417 SI->eraseFromParent();
418 } else if (Instruction *I = dyn_cast<Instruction>(V)) {
419 if (I->hasOneUse())
420 Dead.push_back(std::make_pair(I, SI));
421 }
422 } else if (MemSetInst *MSI = dyn_cast<MemSetInst>(U)) {
423 if (isa<Constant>(MSI->getValue())) {
424 Changed = true;
425 MSI->eraseFromParent();
426 } else if (Instruction *I = dyn_cast<Instruction>(MSI->getValue())) {
427 if (I->hasOneUse())
428 Dead.push_back(std::make_pair(I, MSI));
429 }
430 } else if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(U)) {
431 GlobalVariable *MemSrc = dyn_cast<GlobalVariable>(MTI->getSource());
432 if (MemSrc && MemSrc->isConstant()) {
433 Changed = true;
434 MTI->eraseFromParent();
435 } else if (Instruction *I = dyn_cast<Instruction>(MemSrc)) {
436 if (I->hasOneUse())
437 Dead.push_back(std::make_pair(I, MTI));
438 }
439 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
440 if (CE->use_empty()) {
441 CE->destroyConstant();
442 Changed = true;
443 }
444 } else if (Constant *C = dyn_cast<Constant>(U)) {
445 if (SafeToDestroyConstant(C)) {
446 C->destroyConstant();
447 // This could have invalidated UI, start over from scratch.
448 Dead.clear();
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000449 CleanupPointerRootUsers(GV, TLI);
Nick Lewycky8899d5c2012-07-24 07:21:08 +0000450 return true;
451 }
452 }
453 }
454
455 for (int i = 0, e = Dead.size(); i != e; ++i) {
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000456 if (IsSafeComputationToRemove(Dead[i].first, TLI)) {
Nick Lewycky8899d5c2012-07-24 07:21:08 +0000457 Dead[i].second->eraseFromParent();
458 Instruction *I = Dead[i].first;
459 do {
Michael Gottesmandcf66952013-01-11 23:08:52 +0000460 if (isAllocationFn(I, TLI))
461 break;
Nick Lewycky8899d5c2012-07-24 07:21:08 +0000462 Instruction *J = dyn_cast<Instruction>(I->getOperand(0));
463 if (!J)
464 break;
465 I->eraseFromParent();
466 I = J;
Nick Lewycky952f5d52012-07-24 21:33:00 +0000467 } while (1);
Nick Lewycky8899d5c2012-07-24 07:21:08 +0000468 I->eraseFromParent();
469 }
470 }
471
472 return Changed;
473}
474
Chris Lattnere47ba742004-10-06 20:57:02 +0000475/// CleanupConstantGlobalUsers - We just marked GV constant. Loop over all
476/// users of the global, cleaning up the obvious ones. This is largely just a
Chris Lattner031955d2004-10-10 16:43:46 +0000477/// quick scan over the use list to clean up the easy and obvious cruft. This
478/// returns true if it made a change.
Nick Lewycky6a577f82012-02-12 01:13:18 +0000479static bool CleanupConstantGlobalUsers(Value *V, Constant *Init,
Micah Villmow3574eca2012-10-08 16:38:25 +0000480 DataLayout *TD, TargetLibraryInfo *TLI) {
Chris Lattner031955d2004-10-10 16:43:46 +0000481 bool Changed = false;
Bill Wendling2b792362013-04-02 08:16:45 +0000482 SmallVector<User*, 8> WorkList(V->use_begin(), V->use_end());
483 while (!WorkList.empty()) {
484 User *U = WorkList.pop_back_val();
Misha Brukmanfd939082005-04-21 23:48:37 +0000485
Chris Lattner7a90b682004-10-07 04:16:33 +0000486 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner35c81b02005-02-27 18:58:52 +0000487 if (Init) {
488 // Replace the load with the initializer.
489 LI->replaceAllUsesWith(Init);
490 LI->eraseFromParent();
491 Changed = true;
492 }
Chris Lattner7a90b682004-10-07 04:16:33 +0000493 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnere47ba742004-10-06 20:57:02 +0000494 // Store must be unreachable or storing Init into the global.
Chris Lattner7a7ed022004-10-16 18:09:00 +0000495 SI->eraseFromParent();
Chris Lattner031955d2004-10-10 16:43:46 +0000496 Changed = true;
Chris Lattner7a90b682004-10-07 04:16:33 +0000497 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
498 if (CE->getOpcode() == Instruction::GetElementPtr) {
Chris Lattneraae4a1c2005-09-26 07:34:35 +0000499 Constant *SubInit = 0;
500 if (Init)
Dan Gohmanc6f69e92009-10-05 16:36:26 +0000501 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Nick Lewycky6a577f82012-02-12 01:13:18 +0000502 Changed |= CleanupConstantGlobalUsers(CE, SubInit, TD, TLI);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000503 } else if (CE->getOpcode() == Instruction::BitCast &&
Duncan Sands1df98592010-02-16 11:11:14 +0000504 CE->getType()->isPointerTy()) {
Chris Lattner35c81b02005-02-27 18:58:52 +0000505 // Pointer cast, delete any stores and memsets to the global.
Nick Lewycky6a577f82012-02-12 01:13:18 +0000506 Changed |= CleanupConstantGlobalUsers(CE, 0, TD, TLI);
Chris Lattner35c81b02005-02-27 18:58:52 +0000507 }
508
509 if (CE->use_empty()) {
510 CE->destroyConstant();
511 Changed = true;
Chris Lattner7a90b682004-10-07 04:16:33 +0000512 }
513 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner7b52fe72007-11-09 17:33:02 +0000514 // Do not transform "gepinst (gep constexpr (GV))" here, because forming
515 // "gepconstexpr (gep constexpr (GV))" will cause the two gep's to fold
516 // and will invalidate our notion of what Init is.
Chris Lattner19450242007-11-13 21:46:23 +0000517 Constant *SubInit = 0;
Chris Lattner7b52fe72007-11-09 17:33:02 +0000518 if (!isa<ConstantExpr>(GEP->getOperand(0))) {
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000519 ConstantExpr *CE =
Nick Lewycky6a577f82012-02-12 01:13:18 +0000520 dyn_cast_or_null<ConstantExpr>(ConstantFoldInstruction(GEP, TD, TLI));
Chris Lattner7b52fe72007-11-09 17:33:02 +0000521 if (Init && CE && CE->getOpcode() == Instruction::GetElementPtr)
Dan Gohmanc6f69e92009-10-05 16:36:26 +0000522 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Benjamin Kramerc1ea16e2012-03-28 14:50:09 +0000523
524 // If the initializer is an all-null value and we have an inbounds GEP,
525 // we already know what the result of any load from that GEP is.
526 // TODO: Handle splats.
527 if (Init && isa<ConstantAggregateZero>(Init) && GEP->isInBounds())
528 SubInit = Constant::getNullValue(GEP->getType()->getElementType());
Chris Lattner7b52fe72007-11-09 17:33:02 +0000529 }
Nick Lewycky6a577f82012-02-12 01:13:18 +0000530 Changed |= CleanupConstantGlobalUsers(GEP, SubInit, TD, TLI);
Chris Lattnerc4d81b02004-10-10 16:47:33 +0000531
Chris Lattner031955d2004-10-10 16:43:46 +0000532 if (GEP->use_empty()) {
Chris Lattner7a7ed022004-10-16 18:09:00 +0000533 GEP->eraseFromParent();
Chris Lattner031955d2004-10-10 16:43:46 +0000534 Changed = true;
535 }
Chris Lattner35c81b02005-02-27 18:58:52 +0000536 } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(U)) { // memset/cpy/mv
537 if (MI->getRawDest() == V) {
538 MI->eraseFromParent();
539 Changed = true;
540 }
541
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000542 } else if (Constant *C = dyn_cast<Constant>(U)) {
543 // If we have a chain of dead constantexprs or other things dangling from
544 // us, and if they are all dead, nuke them without remorse.
Jay Foade3acf152009-06-09 21:37:11 +0000545 if (SafeToDestroyConstant(C)) {
Devang Patel743cdf82009-03-06 01:37:41 +0000546 C->destroyConstant();
Nick Lewycky6a577f82012-02-12 01:13:18 +0000547 CleanupConstantGlobalUsers(V, Init, TD, TLI);
Chris Lattner031955d2004-10-10 16:43:46 +0000548 return true;
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000549 }
Chris Lattnere47ba742004-10-06 20:57:02 +0000550 }
551 }
Chris Lattner031955d2004-10-10 16:43:46 +0000552 return Changed;
Chris Lattnere47ba742004-10-06 20:57:02 +0000553}
554
Chris Lattner941db492008-01-14 02:09:12 +0000555/// isSafeSROAElementUse - Return true if the specified instruction is a safe
556/// user of a derived expression from a global that we want to SROA.
557static bool isSafeSROAElementUse(Value *V) {
558 // We might have a dead and dangling constant hanging off of here.
559 if (Constant *C = dyn_cast<Constant>(V))
Jay Foade3acf152009-06-09 21:37:11 +0000560 return SafeToDestroyConstant(C);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000561
Chris Lattner941db492008-01-14 02:09:12 +0000562 Instruction *I = dyn_cast<Instruction>(V);
563 if (!I) return false;
564
565 // Loads are ok.
566 if (isa<LoadInst>(I)) return true;
567
568 // Stores *to* the pointer are ok.
569 if (StoreInst *SI = dyn_cast<StoreInst>(I))
570 return SI->getOperand(0) != V;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000571
Chris Lattner941db492008-01-14 02:09:12 +0000572 // Otherwise, it must be a GEP.
573 GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I);
574 if (GEPI == 0) return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000575
Chris Lattner941db492008-01-14 02:09:12 +0000576 if (GEPI->getNumOperands() < 3 || !isa<Constant>(GEPI->getOperand(1)) ||
577 !cast<Constant>(GEPI->getOperand(1))->isNullValue())
578 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000579
Chris Lattner941db492008-01-14 02:09:12 +0000580 for (Value::use_iterator I = GEPI->use_begin(), E = GEPI->use_end();
581 I != E; ++I)
582 if (!isSafeSROAElementUse(*I))
583 return false;
Chris Lattner727c2102008-01-14 01:31:05 +0000584 return true;
585}
586
Chris Lattner941db492008-01-14 02:09:12 +0000587
588/// IsUserOfGlobalSafeForSRA - U is a direct user of the specified global value.
589/// Look at it and its uses and decide whether it is safe to SROA this global.
590///
591static bool IsUserOfGlobalSafeForSRA(User *U, GlobalValue *GV) {
592 // The user of the global must be a GEP Inst or a ConstantExpr GEP.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000593 if (!isa<GetElementPtrInst>(U) &&
594 (!isa<ConstantExpr>(U) ||
Chris Lattner941db492008-01-14 02:09:12 +0000595 cast<ConstantExpr>(U)->getOpcode() != Instruction::GetElementPtr))
596 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000597
Chris Lattner941db492008-01-14 02:09:12 +0000598 // Check to see if this ConstantExpr GEP is SRA'able. In particular, we
599 // don't like < 3 operand CE's, and we don't like non-constant integer
600 // indices. This enforces that all uses are 'gep GV, 0, C, ...' for some
601 // value of C.
602 if (U->getNumOperands() < 3 || !isa<Constant>(U->getOperand(1)) ||
603 !cast<Constant>(U->getOperand(1))->isNullValue() ||
604 !isa<ConstantInt>(U->getOperand(2)))
605 return false;
606
607 gep_type_iterator GEPI = gep_type_begin(U), E = gep_type_end(U);
608 ++GEPI; // Skip over the pointer index.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000609
Chris Lattner941db492008-01-14 02:09:12 +0000610 // If this is a use of an array allocation, do a bit more checking for sanity.
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000611 if (ArrayType *AT = dyn_cast<ArrayType>(*GEPI)) {
Chris Lattner941db492008-01-14 02:09:12 +0000612 uint64_t NumElements = AT->getNumElements();
613 ConstantInt *Idx = cast<ConstantInt>(U->getOperand(2));
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000614
Chris Lattner941db492008-01-14 02:09:12 +0000615 // Check to make sure that index falls within the array. If not,
616 // something funny is going on, so we won't do the optimization.
617 //
618 if (Idx->getZExtValue() >= NumElements)
619 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000620
Chris Lattner941db492008-01-14 02:09:12 +0000621 // We cannot scalar repl this level of the array unless any array
622 // sub-indices are in-range constants. In particular, consider:
623 // A[0][i]. We cannot know that the user isn't doing invalid things like
624 // allowing i to index an out-of-range subscript that accesses A[1].
625 //
626 // Scalar replacing *just* the outer index of the array is probably not
627 // going to be a win anyway, so just give up.
628 for (++GEPI; // Skip array index.
Dan Gohman6874a2a2009-08-18 14:58:19 +0000629 GEPI != E;
Chris Lattner941db492008-01-14 02:09:12 +0000630 ++GEPI) {
631 uint64_t NumElements;
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000632 if (ArrayType *SubArrayTy = dyn_cast<ArrayType>(*GEPI))
Chris Lattner941db492008-01-14 02:09:12 +0000633 NumElements = SubArrayTy->getNumElements();
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000634 else if (VectorType *SubVectorTy = dyn_cast<VectorType>(*GEPI))
Dan Gohman6874a2a2009-08-18 14:58:19 +0000635 NumElements = SubVectorTy->getNumElements();
636 else {
Duncan Sands1df98592010-02-16 11:11:14 +0000637 assert((*GEPI)->isStructTy() &&
Dan Gohman6874a2a2009-08-18 14:58:19 +0000638 "Indexed GEP type is not array, vector, or struct!");
639 continue;
640 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000641
Chris Lattner941db492008-01-14 02:09:12 +0000642 ConstantInt *IdxVal = dyn_cast<ConstantInt>(GEPI.getOperand());
643 if (!IdxVal || IdxVal->getZExtValue() >= NumElements)
644 return false;
645 }
646 }
647
648 for (Value::use_iterator I = U->use_begin(), E = U->use_end(); I != E; ++I)
649 if (!isSafeSROAElementUse(*I))
650 return false;
651 return true;
652}
653
654/// GlobalUsersSafeToSRA - Look at all uses of the global and decide whether it
655/// is safe for us to perform this transformation.
656///
657static bool GlobalUsersSafeToSRA(GlobalValue *GV) {
658 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end();
659 UI != E; ++UI) {
660 if (!IsUserOfGlobalSafeForSRA(*UI, GV))
661 return false;
662 }
663 return true;
664}
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000665
Chris Lattner941db492008-01-14 02:09:12 +0000666
Chris Lattner670c8892004-10-08 17:32:09 +0000667/// SRAGlobal - Perform scalar replacement of aggregates on the specified global
668/// variable. This opens the door for other optimizations by exposing the
669/// behavior of the program in a more fine-grained way. We have determined that
670/// this transformation is safe already. We return the first global variable we
671/// insert so that the caller can reprocess it.
Micah Villmow3574eca2012-10-08 16:38:25 +0000672static GlobalVariable *SRAGlobal(GlobalVariable *GV, const DataLayout &TD) {
Chris Lattner727c2102008-01-14 01:31:05 +0000673 // Make sure this global only has simple uses that we can SRA.
Chris Lattner941db492008-01-14 02:09:12 +0000674 if (!GlobalUsersSafeToSRA(GV))
Chris Lattner727c2102008-01-14 01:31:05 +0000675 return 0;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000676
Rafael Espindolabb46f522009-01-15 20:18:42 +0000677 assert(GV->hasLocalLinkage() && !GV->isConstant());
Chris Lattner670c8892004-10-08 17:32:09 +0000678 Constant *Init = GV->getInitializer();
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000679 Type *Ty = Init->getType();
Misha Brukmanfd939082005-04-21 23:48:37 +0000680
Chris Lattner670c8892004-10-08 17:32:09 +0000681 std::vector<GlobalVariable*> NewGlobals;
682 Module::GlobalListType &Globals = GV->getParent()->getGlobalList();
683
Chris Lattner998182b2008-04-26 07:40:11 +0000684 // Get the alignment of the global, either explicit or target-specific.
685 unsigned StartAlignment = GV->getAlignment();
686 if (StartAlignment == 0)
687 StartAlignment = TD.getABITypeAlignment(GV->getType());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000688
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000689 if (StructType *STy = dyn_cast<StructType>(Ty)) {
Chris Lattner670c8892004-10-08 17:32:09 +0000690 NewGlobals.reserve(STy->getNumElements());
Chris Lattner998182b2008-04-26 07:40:11 +0000691 const StructLayout &Layout = *TD.getStructLayout(STy);
Chris Lattner670c8892004-10-08 17:32:09 +0000692 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
Chris Lattnera1f00f42012-01-25 06:48:06 +0000693 Constant *In = Init->getAggregateElement(i);
Chris Lattner670c8892004-10-08 17:32:09 +0000694 assert(In && "Couldn't get element of initializer?");
Chris Lattner7b550cc2009-11-06 04:27:31 +0000695 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(i), false,
Chris Lattner670c8892004-10-08 17:32:09 +0000696 GlobalVariable::InternalLinkage,
Daniel Dunbarfe09b202009-07-30 17:37:43 +0000697 In, GV->getName()+"."+Twine(i),
Hans Wennborgce718ff2012-06-23 11:37:03 +0000698 GV->getThreadLocalMode(),
Owen Anderson3d29df32009-07-08 01:26:06 +0000699 GV->getType()->getAddressSpace());
Chris Lattner670c8892004-10-08 17:32:09 +0000700 Globals.insert(GV, NGV);
701 NewGlobals.push_back(NGV);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000702
Chris Lattner998182b2008-04-26 07:40:11 +0000703 // Calculate the known alignment of the field. If the original aggregate
704 // had 256 byte alignment for example, something might depend on that:
705 // propagate info to each field.
706 uint64_t FieldOffset = Layout.getElementOffset(i);
707 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, FieldOffset);
708 if (NewAlign > TD.getABITypeAlignment(STy->getElementType(i)))
709 NGV->setAlignment(NewAlign);
Chris Lattner670c8892004-10-08 17:32:09 +0000710 }
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000711 } else if (SequentialType *STy = dyn_cast<SequentialType>(Ty)) {
Chris Lattner670c8892004-10-08 17:32:09 +0000712 unsigned NumElements = 0;
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000713 if (ArrayType *ATy = dyn_cast<ArrayType>(STy))
Chris Lattner670c8892004-10-08 17:32:09 +0000714 NumElements = ATy->getNumElements();
Chris Lattner670c8892004-10-08 17:32:09 +0000715 else
Chris Lattner998182b2008-04-26 07:40:11 +0000716 NumElements = cast<VectorType>(STy)->getNumElements();
Chris Lattner670c8892004-10-08 17:32:09 +0000717
Chris Lattner1f21ef12005-02-23 16:53:04 +0000718 if (NumElements > 16 && GV->hasNUsesOrMore(16))
Chris Lattnerd514d822005-02-01 01:23:31 +0000719 return 0; // It's not worth it.
Chris Lattner670c8892004-10-08 17:32:09 +0000720 NewGlobals.reserve(NumElements);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000721
Duncan Sands777d2302009-05-09 07:06:46 +0000722 uint64_t EltSize = TD.getTypeAllocSize(STy->getElementType());
Chris Lattner998182b2008-04-26 07:40:11 +0000723 unsigned EltAlign = TD.getABITypeAlignment(STy->getElementType());
Chris Lattner670c8892004-10-08 17:32:09 +0000724 for (unsigned i = 0, e = NumElements; i != e; ++i) {
Chris Lattnera1f00f42012-01-25 06:48:06 +0000725 Constant *In = Init->getAggregateElement(i);
Chris Lattner670c8892004-10-08 17:32:09 +0000726 assert(In && "Couldn't get element of initializer?");
727
Chris Lattner7b550cc2009-11-06 04:27:31 +0000728 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(), false,
Chris Lattner670c8892004-10-08 17:32:09 +0000729 GlobalVariable::InternalLinkage,
Daniel Dunbarfe09b202009-07-30 17:37:43 +0000730 In, GV->getName()+"."+Twine(i),
Hans Wennborgce718ff2012-06-23 11:37:03 +0000731 GV->getThreadLocalMode(),
Owen Andersone9b11b42009-07-08 19:03:57 +0000732 GV->getType()->getAddressSpace());
Chris Lattner670c8892004-10-08 17:32:09 +0000733 Globals.insert(GV, NGV);
734 NewGlobals.push_back(NGV);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000735
Chris Lattner998182b2008-04-26 07:40:11 +0000736 // Calculate the known alignment of the field. If the original aggregate
737 // had 256 byte alignment for example, something might depend on that:
738 // propagate info to each field.
739 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, EltSize*i);
740 if (NewAlign > EltAlign)
741 NGV->setAlignment(NewAlign);
Chris Lattner670c8892004-10-08 17:32:09 +0000742 }
743 }
744
745 if (NewGlobals.empty())
746 return 0;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000747
David Greene3215b0e2010-01-05 01:28:05 +0000748 DEBUG(dbgs() << "PERFORMING GLOBAL SRA ON: " << *GV);
Chris Lattner30ba5692004-10-11 05:54:41 +0000749
Chris Lattner7b550cc2009-11-06 04:27:31 +0000750 Constant *NullInt =Constant::getNullValue(Type::getInt32Ty(GV->getContext()));
Chris Lattner670c8892004-10-08 17:32:09 +0000751
752 // Loop over all of the uses of the global, replacing the constantexpr geps,
753 // with smaller constantexpr geps or direct references.
754 while (!GV->use_empty()) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000755 User *GEP = GV->use_back();
756 assert(((isa<ConstantExpr>(GEP) &&
757 cast<ConstantExpr>(GEP)->getOpcode()==Instruction::GetElementPtr)||
758 isa<GetElementPtrInst>(GEP)) && "NonGEP CE's are not SRAable!");
Misha Brukmanfd939082005-04-21 23:48:37 +0000759
Chris Lattner670c8892004-10-08 17:32:09 +0000760 // Ignore the 1th operand, which has to be zero or else the program is quite
761 // broken (undefined). Get the 2nd operand, which is the structure or array
762 // index.
Reid Spencerb83eb642006-10-20 07:07:24 +0000763 unsigned Val = cast<ConstantInt>(GEP->getOperand(2))->getZExtValue();
Chris Lattner670c8892004-10-08 17:32:09 +0000764 if (Val >= NewGlobals.size()) Val = 0; // Out of bound array access.
765
Chris Lattner30ba5692004-10-11 05:54:41 +0000766 Value *NewPtr = NewGlobals[Val];
Chris Lattner670c8892004-10-08 17:32:09 +0000767
768 // Form a shorter GEP if needed.
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000769 if (GEP->getNumOperands() > 3) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000770 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEP)) {
Chris Lattner55eb1c42007-01-31 04:40:53 +0000771 SmallVector<Constant*, 8> Idxs;
Chris Lattner30ba5692004-10-11 05:54:41 +0000772 Idxs.push_back(NullInt);
773 for (unsigned i = 3, e = CE->getNumOperands(); i != e; ++i)
774 Idxs.push_back(CE->getOperand(i));
Jay Foaddab3d292011-07-21 14:31:17 +0000775 NewPtr = ConstantExpr::getGetElementPtr(cast<Constant>(NewPtr), Idxs);
Chris Lattner30ba5692004-10-11 05:54:41 +0000776 } else {
777 GetElementPtrInst *GEPI = cast<GetElementPtrInst>(GEP);
Chris Lattner699d1442007-01-31 19:59:55 +0000778 SmallVector<Value*, 8> Idxs;
Chris Lattner30ba5692004-10-11 05:54:41 +0000779 Idxs.push_back(NullInt);
780 for (unsigned i = 3, e = GEPI->getNumOperands(); i != e; ++i)
781 Idxs.push_back(GEPI->getOperand(i));
Jay Foada9203102011-07-25 09:48:08 +0000782 NewPtr = GetElementPtrInst::Create(NewPtr, Idxs,
Daniel Dunbarfe09b202009-07-30 17:37:43 +0000783 GEPI->getName()+"."+Twine(Val),GEPI);
Chris Lattner30ba5692004-10-11 05:54:41 +0000784 }
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000785 }
Chris Lattner30ba5692004-10-11 05:54:41 +0000786 GEP->replaceAllUsesWith(NewPtr);
787
788 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(GEP))
Chris Lattner7a7ed022004-10-16 18:09:00 +0000789 GEPI->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000790 else
791 cast<ConstantExpr>(GEP)->destroyConstant();
Chris Lattner670c8892004-10-08 17:32:09 +0000792 }
793
Chris Lattnere40e2d12004-10-08 20:25:55 +0000794 // Delete the old global, now that it is dead.
795 Globals.erase(GV);
Chris Lattner670c8892004-10-08 17:32:09 +0000796 ++NumSRA;
Chris Lattner30ba5692004-10-11 05:54:41 +0000797
798 // Loop over the new globals array deleting any globals that are obviously
799 // dead. This can arise due to scalarization of a structure or an array that
800 // has elements that are dead.
801 unsigned FirstGlobal = 0;
802 for (unsigned i = 0, e = NewGlobals.size(); i != e; ++i)
803 if (NewGlobals[i]->use_empty()) {
804 Globals.erase(NewGlobals[i]);
805 if (FirstGlobal == i) ++FirstGlobal;
806 }
807
808 return FirstGlobal != NewGlobals.size() ? NewGlobals[FirstGlobal] : 0;
Chris Lattner670c8892004-10-08 17:32:09 +0000809}
810
Chris Lattner9b34a612004-10-09 21:48:45 +0000811/// AllUsesOfValueWillTrapIfNull - Return true if all users of the specified
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000812/// value will trap if the value is dynamically null. PHIs keeps track of any
Chris Lattner81686182007-09-13 16:30:19 +0000813/// phi nodes we've seen to avoid reprocessing them.
Gabor Greif6ce02b52010-04-06 19:24:18 +0000814static bool AllUsesOfValueWillTrapIfNull(const Value *V,
815 SmallPtrSet<const PHINode*, 8> &PHIs) {
816 for (Value::const_use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000817 ++UI) {
Gabor Greif6ce02b52010-04-06 19:24:18 +0000818 const User *U = *UI;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000819
820 if (isa<LoadInst>(U)) {
Chris Lattner9b34a612004-10-09 21:48:45 +0000821 // Will trap.
Gabor Greif6ce02b52010-04-06 19:24:18 +0000822 } else if (const StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattner9b34a612004-10-09 21:48:45 +0000823 if (SI->getOperand(0) == V) {
Gabor Greifa01d6db2010-04-06 19:14:05 +0000824 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000825 return false; // Storing the value.
826 }
Gabor Greif6ce02b52010-04-06 19:24:18 +0000827 } else if (const CallInst *CI = dyn_cast<CallInst>(U)) {
Gabor Greif654c06f2010-03-20 21:00:25 +0000828 if (CI->getCalledValue() != V) {
Gabor Greifa01d6db2010-04-06 19:14:05 +0000829 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000830 return false; // Not calling the ptr
831 }
Gabor Greif6ce02b52010-04-06 19:24:18 +0000832 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(U)) {
Gabor Greif654c06f2010-03-20 21:00:25 +0000833 if (II->getCalledValue() != V) {
Gabor Greifa01d6db2010-04-06 19:14:05 +0000834 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000835 return false; // Not calling the ptr
836 }
Gabor Greif6ce02b52010-04-06 19:24:18 +0000837 } else if (const BitCastInst *CI = dyn_cast<BitCastInst>(U)) {
Chris Lattner81686182007-09-13 16:30:19 +0000838 if (!AllUsesOfValueWillTrapIfNull(CI, PHIs)) return false;
Gabor Greif6ce02b52010-04-06 19:24:18 +0000839 } else if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner81686182007-09-13 16:30:19 +0000840 if (!AllUsesOfValueWillTrapIfNull(GEPI, PHIs)) return false;
Gabor Greif6ce02b52010-04-06 19:24:18 +0000841 } else if (const PHINode *PN = dyn_cast<PHINode>(U)) {
Chris Lattner81686182007-09-13 16:30:19 +0000842 // If we've already seen this phi node, ignore it, it has already been
843 // checked.
Jakob Stoklund Olesenb489d0f2010-01-29 23:54:14 +0000844 if (PHIs.insert(PN) && !AllUsesOfValueWillTrapIfNull(PN, PHIs))
845 return false;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000846 } else if (isa<ICmpInst>(U) &&
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000847 isa<ConstantPointerNull>(UI->getOperand(1))) {
Nick Lewyckye7ee59b2010-02-25 06:39:10 +0000848 // Ignore icmp X, null
Chris Lattner9b34a612004-10-09 21:48:45 +0000849 } else {
Gabor Greifa01d6db2010-04-06 19:14:05 +0000850 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000851 return false;
852 }
Gabor Greifa01d6db2010-04-06 19:14:05 +0000853 }
Chris Lattner9b34a612004-10-09 21:48:45 +0000854 return true;
855}
856
857/// AllUsesOfLoadedValueWillTrapIfNull - Return true if all uses of any loads
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000858/// from GV will trap if the loaded value is null. Note that this also permits
859/// comparisons of the loaded value against null, as a special case.
Gabor Greif6ce02b52010-04-06 19:24:18 +0000860static bool AllUsesOfLoadedValueWillTrapIfNull(const GlobalVariable *GV) {
861 for (Value::const_use_iterator UI = GV->use_begin(), E = GV->use_end();
Gabor Greifa01d6db2010-04-06 19:14:05 +0000862 UI != E; ++UI) {
Gabor Greif6ce02b52010-04-06 19:24:18 +0000863 const User *U = *UI;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000864
Gabor Greif6ce02b52010-04-06 19:24:18 +0000865 if (const LoadInst *LI = dyn_cast<LoadInst>(U)) {
866 SmallPtrSet<const PHINode*, 8> PHIs;
Chris Lattner81686182007-09-13 16:30:19 +0000867 if (!AllUsesOfValueWillTrapIfNull(LI, PHIs))
Chris Lattner9b34a612004-10-09 21:48:45 +0000868 return false;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000869 } else if (isa<StoreInst>(U)) {
Chris Lattner9b34a612004-10-09 21:48:45 +0000870 // Ignore stores to the global.
871 } else {
872 // We don't know or understand this user, bail out.
Gabor Greifa01d6db2010-04-06 19:14:05 +0000873 //cerr << "UNKNOWN USER OF GLOBAL!: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000874 return false;
875 }
Gabor Greifa01d6db2010-04-06 19:14:05 +0000876 }
Chris Lattner9b34a612004-10-09 21:48:45 +0000877 return true;
878}
879
Chris Lattner7b550cc2009-11-06 04:27:31 +0000880static bool OptimizeAwayTrappingUsesOfValue(Value *V, Constant *NewV) {
Chris Lattner708148e2004-10-10 23:14:11 +0000881 bool Changed = false;
882 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ) {
883 Instruction *I = cast<Instruction>(*UI++);
884 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
885 LI->setOperand(0, NewV);
886 Changed = true;
887 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
888 if (SI->getOperand(1) == V) {
889 SI->setOperand(1, NewV);
890 Changed = true;
891 }
892 } else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
Gabor Greiffa1f5c22010-04-06 18:45:08 +0000893 CallSite CS(I);
894 if (CS.getCalledValue() == V) {
Chris Lattner708148e2004-10-10 23:14:11 +0000895 // Calling through the pointer! Turn into a direct call, but be careful
896 // that the pointer is not also being passed as an argument.
Gabor Greiffa1f5c22010-04-06 18:45:08 +0000897 CS.setCalledFunction(NewV);
Chris Lattner708148e2004-10-10 23:14:11 +0000898 Changed = true;
899 bool PassedAsArg = false;
Gabor Greiffa1f5c22010-04-06 18:45:08 +0000900 for (unsigned i = 0, e = CS.arg_size(); i != e; ++i)
901 if (CS.getArgument(i) == V) {
Chris Lattner708148e2004-10-10 23:14:11 +0000902 PassedAsArg = true;
Gabor Greiffa1f5c22010-04-06 18:45:08 +0000903 CS.setArgument(i, NewV);
Chris Lattner708148e2004-10-10 23:14:11 +0000904 }
905
906 if (PassedAsArg) {
907 // Being passed as an argument also. Be careful to not invalidate UI!
908 UI = V->use_begin();
909 }
910 }
911 } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
912 Changed |= OptimizeAwayTrappingUsesOfValue(CI,
Owen Andersonbaf3c402009-07-29 18:55:55 +0000913 ConstantExpr::getCast(CI->getOpcode(),
Chris Lattner7b550cc2009-11-06 04:27:31 +0000914 NewV, CI->getType()));
Chris Lattner708148e2004-10-10 23:14:11 +0000915 if (CI->use_empty()) {
916 Changed = true;
Chris Lattner7a7ed022004-10-16 18:09:00 +0000917 CI->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000918 }
919 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
920 // Should handle GEP here.
Chris Lattner55eb1c42007-01-31 04:40:53 +0000921 SmallVector<Constant*, 8> Idxs;
922 Idxs.reserve(GEPI->getNumOperands()-1);
Gabor Greif5e463212008-05-29 01:59:18 +0000923 for (User::op_iterator i = GEPI->op_begin() + 1, e = GEPI->op_end();
924 i != e; ++i)
925 if (Constant *C = dyn_cast<Constant>(*i))
Chris Lattner55eb1c42007-01-31 04:40:53 +0000926 Idxs.push_back(C);
Chris Lattner708148e2004-10-10 23:14:11 +0000927 else
928 break;
Chris Lattner55eb1c42007-01-31 04:40:53 +0000929 if (Idxs.size() == GEPI->getNumOperands()-1)
Chris Lattner708148e2004-10-10 23:14:11 +0000930 Changed |= OptimizeAwayTrappingUsesOfValue(GEPI,
Jay Foaddab3d292011-07-21 14:31:17 +0000931 ConstantExpr::getGetElementPtr(NewV, Idxs));
Chris Lattner708148e2004-10-10 23:14:11 +0000932 if (GEPI->use_empty()) {
933 Changed = true;
Chris Lattner7a7ed022004-10-16 18:09:00 +0000934 GEPI->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000935 }
936 }
937 }
938
939 return Changed;
940}
941
942
943/// OptimizeAwayTrappingUsesOfLoads - The specified global has only one non-null
944/// value stored into it. If there are uses of the loaded value that would trap
945/// if the loaded value is dynamically null, then we know that they cannot be
946/// reachable with a null optimize away the load.
Nick Lewycky6a577f82012-02-12 01:13:18 +0000947static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV,
Micah Villmow3574eca2012-10-08 16:38:25 +0000948 DataLayout *TD,
Nick Lewycky6a577f82012-02-12 01:13:18 +0000949 TargetLibraryInfo *TLI) {
Chris Lattner708148e2004-10-10 23:14:11 +0000950 bool Changed = false;
951
Chris Lattner92c6bd22009-01-14 00:12:58 +0000952 // Keep track of whether we are able to remove all the uses of the global
953 // other than the store that defines it.
954 bool AllNonStoreUsesGone = true;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000955
Chris Lattner708148e2004-10-10 23:14:11 +0000956 // Replace all uses of loads with uses of uses of the stored value.
Chris Lattner92c6bd22009-01-14 00:12:58 +0000957 for (Value::use_iterator GUI = GV->use_begin(), E = GV->use_end(); GUI != E;){
958 User *GlobalUser = *GUI++;
959 if (LoadInst *LI = dyn_cast<LoadInst>(GlobalUser)) {
Chris Lattner7b550cc2009-11-06 04:27:31 +0000960 Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV);
Chris Lattner92c6bd22009-01-14 00:12:58 +0000961 // If we were able to delete all uses of the loads
962 if (LI->use_empty()) {
963 LI->eraseFromParent();
964 Changed = true;
965 } else {
966 AllNonStoreUsesGone = false;
967 }
968 } else if (isa<StoreInst>(GlobalUser)) {
969 // Ignore the store that stores "LV" to the global.
970 assert(GlobalUser->getOperand(1) == GV &&
971 "Must be storing *to* the global");
Chris Lattner708148e2004-10-10 23:14:11 +0000972 } else {
Chris Lattner92c6bd22009-01-14 00:12:58 +0000973 AllNonStoreUsesGone = false;
974
975 // If we get here we could have other crazy uses that are transitively
976 // loaded.
977 assert((isa<PHINode>(GlobalUser) || isa<SelectInst>(GlobalUser) ||
Benjamin Kramerab164232012-09-28 10:01:27 +0000978 isa<ConstantExpr>(GlobalUser) || isa<CmpInst>(GlobalUser) ||
979 isa<BitCastInst>(GlobalUser) ||
980 isa<GetElementPtrInst>(GlobalUser)) &&
Chris Lattner98a42b22011-05-22 07:15:13 +0000981 "Only expect load and stores!");
Chris Lattner708148e2004-10-10 23:14:11 +0000982 }
Chris Lattner92c6bd22009-01-14 00:12:58 +0000983 }
Chris Lattner708148e2004-10-10 23:14:11 +0000984
985 if (Changed) {
David Greene3215b0e2010-01-05 01:28:05 +0000986 DEBUG(dbgs() << "OPTIMIZED LOADS FROM STORED ONCE POINTER: " << *GV);
Chris Lattner708148e2004-10-10 23:14:11 +0000987 ++NumGlobUses;
988 }
989
Chris Lattner708148e2004-10-10 23:14:11 +0000990 // If we nuked all of the loads, then none of the stores are needed either,
991 // nor is the global.
Chris Lattner92c6bd22009-01-14 00:12:58 +0000992 if (AllNonStoreUsesGone) {
Nick Lewycky8899d5c2012-07-24 07:21:08 +0000993 if (isLeakCheckerRoot(GV)) {
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000994 Changed |= CleanupPointerRootUsers(GV, TLI);
Nick Lewycky8899d5c2012-07-24 07:21:08 +0000995 } else {
996 Changed = true;
997 CleanupConstantGlobalUsers(GV, 0, TD, TLI);
998 }
Chris Lattner708148e2004-10-10 23:14:11 +0000999 if (GV->use_empty()) {
Nick Lewycky8899d5c2012-07-24 07:21:08 +00001000 DEBUG(dbgs() << " *** GLOBAL NOW DEAD!\n");
1001 Changed = true;
Chris Lattner7a7ed022004-10-16 18:09:00 +00001002 GV->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +00001003 ++NumDeleted;
1004 }
Chris Lattner708148e2004-10-10 23:14:11 +00001005 }
1006 return Changed;
1007}
1008
Chris Lattner30ba5692004-10-11 05:54:41 +00001009/// ConstantPropUsersOf - Walk the use list of V, constant folding all of the
1010/// instructions that are foldable.
Nick Lewycky6a577f82012-02-12 01:13:18 +00001011static void ConstantPropUsersOf(Value *V,
Micah Villmow3574eca2012-10-08 16:38:25 +00001012 DataLayout *TD, TargetLibraryInfo *TLI) {
Chris Lattner30ba5692004-10-11 05:54:41 +00001013 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; )
1014 if (Instruction *I = dyn_cast<Instruction>(*UI++))
Nick Lewycky6a577f82012-02-12 01:13:18 +00001015 if (Constant *NewC = ConstantFoldInstruction(I, TD, TLI)) {
Chris Lattner30ba5692004-10-11 05:54:41 +00001016 I->replaceAllUsesWith(NewC);
1017
Chris Lattnerd514d822005-02-01 01:23:31 +00001018 // Advance UI to the next non-I use to avoid invalidating it!
1019 // Instructions could multiply use V.
1020 while (UI != E && *UI == I)
Chris Lattner30ba5692004-10-11 05:54:41 +00001021 ++UI;
Chris Lattnerd514d822005-02-01 01:23:31 +00001022 I->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +00001023 }
1024}
1025
1026/// OptimizeGlobalAddressOfMalloc - This function takes the specified global
1027/// variable, and transforms the program as if it always contained the result of
1028/// the specified malloc. Because it is always the result of the specified
1029/// malloc, there is no reason to actually DO the malloc. Instead, turn the
Chris Lattner6e8fbad2006-11-30 17:32:29 +00001030/// malloc into a global, and any loads of GV as uses of the new global.
Chris Lattner30ba5692004-10-11 05:54:41 +00001031static GlobalVariable *OptimizeGlobalAddressOfMalloc(GlobalVariable *GV,
Victor Hernandez83d63912009-09-18 22:35:49 +00001032 CallInst *CI,
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001033 Type *AllocTy,
Chris Lattnera6874652010-02-25 22:33:52 +00001034 ConstantInt *NElements,
Micah Villmow3574eca2012-10-08 16:38:25 +00001035 DataLayout *TD,
Nick Lewycky6a577f82012-02-12 01:13:18 +00001036 TargetLibraryInfo *TLI) {
Chris Lattnera6874652010-02-25 22:33:52 +00001037 DEBUG(errs() << "PROMOTING GLOBAL: " << *GV << " CALL = " << *CI << '\n');
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001038
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001039 Type *GlobalType;
Chris Lattnera6874652010-02-25 22:33:52 +00001040 if (NElements->getZExtValue() == 1)
1041 GlobalType = AllocTy;
1042 else
1043 // If we have an array allocation, the global variable is of an array.
1044 GlobalType = ArrayType::get(AllocTy, NElements->getZExtValue());
Victor Hernandez83d63912009-09-18 22:35:49 +00001045
1046 // Create the new global variable. The contents of the malloc'd memory is
1047 // undefined, so initialize with an undef value.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001048 GlobalVariable *NewGV = new GlobalVariable(*GV->getParent(),
Chris Lattnere9fd4442010-02-26 23:42:13 +00001049 GlobalType, false,
Chris Lattnera6874652010-02-25 22:33:52 +00001050 GlobalValue::InternalLinkage,
Chris Lattnere9fd4442010-02-26 23:42:13 +00001051 UndefValue::get(GlobalType),
Victor Hernandez83d63912009-09-18 22:35:49 +00001052 GV->getName()+".body",
1053 GV,
Hans Wennborgce718ff2012-06-23 11:37:03 +00001054 GV->getThreadLocalMode());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001055
Chris Lattnera6874652010-02-25 22:33:52 +00001056 // If there are bitcast users of the malloc (which is typical, usually we have
1057 // a malloc + bitcast) then replace them with uses of the new global. Update
1058 // other users to use the global as well.
1059 BitCastInst *TheBC = 0;
1060 while (!CI->use_empty()) {
1061 Instruction *User = cast<Instruction>(CI->use_back());
1062 if (BitCastInst *BCI = dyn_cast<BitCastInst>(User)) {
1063 if (BCI->getType() == NewGV->getType()) {
1064 BCI->replaceAllUsesWith(NewGV);
1065 BCI->eraseFromParent();
1066 } else {
1067 BCI->setOperand(0, NewGV);
1068 }
1069 } else {
1070 if (TheBC == 0)
1071 TheBC = new BitCastInst(NewGV, CI->getType(), "newgv", CI);
1072 User->replaceUsesOfWith(CI, TheBC);
1073 }
1074 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001075
Victor Hernandez83d63912009-09-18 22:35:49 +00001076 Constant *RepValue = NewGV;
1077 if (NewGV->getType() != GV->getType()->getElementType())
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001078 RepValue = ConstantExpr::getBitCast(RepValue,
Victor Hernandez83d63912009-09-18 22:35:49 +00001079 GV->getType()->getElementType());
1080
1081 // If there is a comparison against null, we will insert a global bool to
1082 // keep track of whether the global was initialized yet or not.
1083 GlobalVariable *InitBool =
Chris Lattner7b550cc2009-11-06 04:27:31 +00001084 new GlobalVariable(Type::getInt1Ty(GV->getContext()), false,
Victor Hernandez83d63912009-09-18 22:35:49 +00001085 GlobalValue::InternalLinkage,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001086 ConstantInt::getFalse(GV->getContext()),
Hans Wennborgce718ff2012-06-23 11:37:03 +00001087 GV->getName()+".init", GV->getThreadLocalMode());
Victor Hernandez83d63912009-09-18 22:35:49 +00001088 bool InitBoolUsed = false;
1089
1090 // Loop over all uses of GV, processing them in turn.
Chris Lattnera6874652010-02-25 22:33:52 +00001091 while (!GV->use_empty()) {
1092 if (StoreInst *SI = dyn_cast<StoreInst>(GV->use_back())) {
Victor Hernandez83d63912009-09-18 22:35:49 +00001093 // The global is initialized when the store to it occurs.
Nick Lewyckyfad4d402012-02-05 19:56:38 +00001094 new StoreInst(ConstantInt::getTrue(GV->getContext()), InitBool, false, 0,
1095 SI->getOrdering(), SI->getSynchScope(), SI);
Victor Hernandez83d63912009-09-18 22:35:49 +00001096 SI->eraseFromParent();
Chris Lattnera6874652010-02-25 22:33:52 +00001097 continue;
Victor Hernandez83d63912009-09-18 22:35:49 +00001098 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001099
Chris Lattnera6874652010-02-25 22:33:52 +00001100 LoadInst *LI = cast<LoadInst>(GV->use_back());
1101 while (!LI->use_empty()) {
1102 Use &LoadUse = LI->use_begin().getUse();
1103 if (!isa<ICmpInst>(LoadUse.getUser())) {
1104 LoadUse = RepValue;
1105 continue;
1106 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001107
Chris Lattnera6874652010-02-25 22:33:52 +00001108 ICmpInst *ICI = cast<ICmpInst>(LoadUse.getUser());
1109 // Replace the cmp X, 0 with a use of the bool value.
Nick Lewyckyfad4d402012-02-05 19:56:38 +00001110 // Sink the load to where the compare was, if atomic rules allow us to.
1111 Value *LV = new LoadInst(InitBool, InitBool->getName()+".val", false, 0,
1112 LI->getOrdering(), LI->getSynchScope(),
1113 LI->isUnordered() ? (Instruction*)ICI : LI);
Chris Lattnera6874652010-02-25 22:33:52 +00001114 InitBoolUsed = true;
1115 switch (ICI->getPredicate()) {
1116 default: llvm_unreachable("Unknown ICmp Predicate!");
1117 case ICmpInst::ICMP_ULT:
1118 case ICmpInst::ICMP_SLT: // X < null -> always false
1119 LV = ConstantInt::getFalse(GV->getContext());
1120 break;
1121 case ICmpInst::ICMP_ULE:
1122 case ICmpInst::ICMP_SLE:
1123 case ICmpInst::ICMP_EQ:
1124 LV = BinaryOperator::CreateNot(LV, "notinit", ICI);
1125 break;
1126 case ICmpInst::ICMP_NE:
1127 case ICmpInst::ICMP_UGE:
1128 case ICmpInst::ICMP_SGE:
1129 case ICmpInst::ICMP_UGT:
1130 case ICmpInst::ICMP_SGT:
1131 break; // no change.
1132 }
1133 ICI->replaceAllUsesWith(LV);
1134 ICI->eraseFromParent();
1135 }
1136 LI->eraseFromParent();
1137 }
Victor Hernandez83d63912009-09-18 22:35:49 +00001138
1139 // If the initialization boolean was used, insert it, otherwise delete it.
1140 if (!InitBoolUsed) {
1141 while (!InitBool->use_empty()) // Delete initializations
Chris Lattnera6874652010-02-25 22:33:52 +00001142 cast<StoreInst>(InitBool->use_back())->eraseFromParent();
Victor Hernandez83d63912009-09-18 22:35:49 +00001143 delete InitBool;
1144 } else
1145 GV->getParent()->getGlobalList().insert(GV, InitBool);
1146
Chris Lattnera6874652010-02-25 22:33:52 +00001147 // Now the GV is dead, nuke it and the malloc..
Victor Hernandez83d63912009-09-18 22:35:49 +00001148 GV->eraseFromParent();
Victor Hernandez83d63912009-09-18 22:35:49 +00001149 CI->eraseFromParent();
1150
1151 // To further other optimizations, loop over all users of NewGV and try to
1152 // constant prop them. This will promote GEP instructions with constant
1153 // indices into GEP constant-exprs, which will allow global-opt to hack on it.
Nick Lewycky6a577f82012-02-12 01:13:18 +00001154 ConstantPropUsersOf(NewGV, TD, TLI);
Victor Hernandez83d63912009-09-18 22:35:49 +00001155 if (RepValue != NewGV)
Nick Lewycky6a577f82012-02-12 01:13:18 +00001156 ConstantPropUsersOf(RepValue, TD, TLI);
Victor Hernandez83d63912009-09-18 22:35:49 +00001157
1158 return NewGV;
1159}
1160
Chris Lattnerfa07e4f2004-12-02 07:11:07 +00001161/// ValueIsOnlyUsedLocallyOrStoredToOneGlobal - Scan the use-list of V checking
1162/// to make sure that there are no complex uses of V. We permit simple things
1163/// like dereferencing the pointer, but not storing through the address, unless
1164/// it is to the specified global.
Gabor Greif0b520db2010-04-06 18:58:22 +00001165static bool ValueIsOnlyUsedLocallyOrStoredToOneGlobal(const Instruction *V,
1166 const GlobalVariable *GV,
Gabor Greifa01d6db2010-04-06 19:14:05 +00001167 SmallPtrSet<const PHINode*, 8> &PHIs) {
Gabor Greif0b520db2010-04-06 18:58:22 +00001168 for (Value::const_use_iterator UI = V->use_begin(), E = V->use_end();
Gabor Greifa01d6db2010-04-06 19:14:05 +00001169 UI != E; ++UI) {
Gabor Greif0b520db2010-04-06 18:58:22 +00001170 const Instruction *Inst = cast<Instruction>(*UI);
Gabor Greifa01d6db2010-04-06 19:14:05 +00001171
Chris Lattner49b6d4a2008-12-15 21:08:54 +00001172 if (isa<LoadInst>(Inst) || isa<CmpInst>(Inst)) {
1173 continue; // Fine, ignore.
1174 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001175
Gabor Greif0b520db2010-04-06 18:58:22 +00001176 if (const StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
Chris Lattnerfa07e4f2004-12-02 07:11:07 +00001177 if (SI->getOperand(0) == V && SI->getOperand(1) != GV)
1178 return false; // Storing the pointer itself... bad.
Chris Lattner49b6d4a2008-12-15 21:08:54 +00001179 continue; // Otherwise, storing through it, or storing into GV... fine.
1180 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001181
Chris Lattnera2fb2342010-04-10 18:19:22 +00001182 // Must index into the array and into the struct.
1183 if (isa<GetElementPtrInst>(Inst) && Inst->getNumOperands() >= 3) {
Chris Lattner49b6d4a2008-12-15 21:08:54 +00001184 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Inst, GV, PHIs))
Chris Lattnerfa07e4f2004-12-02 07:11:07 +00001185 return false;
Chris Lattner49b6d4a2008-12-15 21:08:54 +00001186 continue;
1187 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001188
Gabor Greif0b520db2010-04-06 18:58:22 +00001189 if (const PHINode *PN = dyn_cast<PHINode>(Inst)) {
Chris Lattnerc451f9c2007-09-13 16:37:20 +00001190 // PHIs are ok if all uses are ok. Don't infinitely recurse through PHI
1191 // cycles.
1192 if (PHIs.insert(PN))
Chris Lattner5e6e4942007-09-14 03:41:21 +00001193 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(PN, GV, PHIs))
1194 return false;
Chris Lattner49b6d4a2008-12-15 21:08:54 +00001195 continue;
Chris Lattnerfa07e4f2004-12-02 07:11:07 +00001196 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001197
Gabor Greif0b520db2010-04-06 18:58:22 +00001198 if (const BitCastInst *BCI = dyn_cast<BitCastInst>(Inst)) {
Chris Lattner49b6d4a2008-12-15 21:08:54 +00001199 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(BCI, GV, PHIs))
1200 return false;
1201 continue;
1202 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001203
Chris Lattner49b6d4a2008-12-15 21:08:54 +00001204 return false;
1205 }
Chris Lattnerfa07e4f2004-12-02 07:11:07 +00001206 return true;
Chris Lattnerfa07e4f2004-12-02 07:11:07 +00001207}
1208
Chris Lattner86395032006-09-30 23:32:09 +00001209/// ReplaceUsesOfMallocWithGlobal - The Alloc pointer is stored into GV
1210/// somewhere. Transform all uses of the allocation into loads from the
1211/// global and uses of the resultant pointer. Further, delete the store into
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001212/// GV. This assumes that these value pass the
Chris Lattner86395032006-09-30 23:32:09 +00001213/// 'ValueIsOnlyUsedLocallyOrStoredToOneGlobal' predicate.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001214static void ReplaceUsesOfMallocWithGlobal(Instruction *Alloc,
Chris Lattner86395032006-09-30 23:32:09 +00001215 GlobalVariable *GV) {
1216 while (!Alloc->use_empty()) {
Chris Lattnera637a8b2007-09-13 18:00:31 +00001217 Instruction *U = cast<Instruction>(*Alloc->use_begin());
1218 Instruction *InsertPt = U;
Chris Lattner86395032006-09-30 23:32:09 +00001219 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
1220 // If this is the store of the allocation into the global, remove it.
1221 if (SI->getOperand(1) == GV) {
1222 SI->eraseFromParent();
1223 continue;
1224 }
Chris Lattnera637a8b2007-09-13 18:00:31 +00001225 } else if (PHINode *PN = dyn_cast<PHINode>(U)) {
1226 // Insert the load in the corresponding predecessor, not right before the
1227 // PHI.
Gabor Greifa36791d2009-01-23 19:40:15 +00001228 InsertPt = PN->getIncomingBlock(Alloc->use_begin())->getTerminator();
Chris Lattner101f44e2008-12-15 21:44:34 +00001229 } else if (isa<BitCastInst>(U)) {
1230 // Must be bitcast between the malloc and store to initialize the global.
1231 ReplaceUsesOfMallocWithGlobal(U, GV);
1232 U->eraseFromParent();
1233 continue;
1234 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
1235 // If this is a "GEP bitcast" and the user is a store to the global, then
1236 // just process it as a bitcast.
1237 if (GEPI->hasAllZeroIndices() && GEPI->hasOneUse())
1238 if (StoreInst *SI = dyn_cast<StoreInst>(GEPI->use_back()))
1239 if (SI->getOperand(1) == GV) {
1240 // Must be bitcast GEP between the malloc and store to initialize
1241 // the global.
1242 ReplaceUsesOfMallocWithGlobal(GEPI, GV);
1243 GEPI->eraseFromParent();
1244 continue;
1245 }
Chris Lattner86395032006-09-30 23:32:09 +00001246 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001247
Chris Lattner86395032006-09-30 23:32:09 +00001248 // Insert a load from the global, and use it instead of the malloc.
Chris Lattnera637a8b2007-09-13 18:00:31 +00001249 Value *NL = new LoadInst(GV, GV->getName()+".val", InsertPt);
Chris Lattner86395032006-09-30 23:32:09 +00001250 U->replaceUsesOfWith(Alloc, NL);
1251 }
1252}
1253
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001254/// LoadUsesSimpleEnoughForHeapSRA - Verify that all uses of V (a load, or a phi
1255/// of a load) are simple enough to perform heap SRA on. This permits GEP's
1256/// that index through the array and struct field, icmps of null, and PHIs.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001257static bool LoadUsesSimpleEnoughForHeapSRA(const Value *V,
Gabor Greif27236912010-04-07 18:59:26 +00001258 SmallPtrSet<const PHINode*, 32> &LoadUsingPHIs,
1259 SmallPtrSet<const PHINode*, 32> &LoadUsingPHIsPerLoad) {
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001260 // We permit two users of the load: setcc comparing against the null
1261 // pointer, and a getelementptr of a specific form.
Gabor Greif27236912010-04-07 18:59:26 +00001262 for (Value::const_use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;
1263 ++UI) {
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001264 const Instruction *User = cast<Instruction>(*UI);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001265
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001266 // Comparison against null is ok.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001267 if (const ICmpInst *ICI = dyn_cast<ICmpInst>(User)) {
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001268 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
1269 return false;
1270 continue;
1271 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001272
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001273 // getelementptr is also ok, but only a simple form.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001274 if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001275 // Must index into the array and into the struct.
1276 if (GEPI->getNumOperands() < 3)
1277 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001278
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001279 // Otherwise the GEP is ok.
1280 continue;
1281 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001282
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001283 if (const PHINode *PN = dyn_cast<PHINode>(User)) {
Evan Cheng5d163962009-06-02 00:56:07 +00001284 if (!LoadUsingPHIsPerLoad.insert(PN))
1285 // This means some phi nodes are dependent on each other.
1286 // Avoid infinite looping!
1287 return false;
1288 if (!LoadUsingPHIs.insert(PN))
1289 // If we have already analyzed this PHI, then it is safe.
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001290 continue;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001291
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001292 // Make sure all uses of the PHI are simple enough to transform.
Evan Cheng5d163962009-06-02 00:56:07 +00001293 if (!LoadUsesSimpleEnoughForHeapSRA(PN,
1294 LoadUsingPHIs, LoadUsingPHIsPerLoad))
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001295 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001296
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001297 continue;
Chris Lattner86395032006-09-30 23:32:09 +00001298 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001299
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001300 // Otherwise we don't know what this is, not ok.
1301 return false;
1302 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001303
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001304 return true;
1305}
1306
1307
1308/// AllGlobalLoadUsesSimpleEnoughForHeapSRA - If all users of values loaded from
1309/// GV are simple enough to perform HeapSRA, return true.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001310static bool AllGlobalLoadUsesSimpleEnoughForHeapSRA(const GlobalVariable *GV,
Victor Hernandez83d63912009-09-18 22:35:49 +00001311 Instruction *StoredVal) {
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001312 SmallPtrSet<const PHINode*, 32> LoadUsingPHIs;
1313 SmallPtrSet<const PHINode*, 32> LoadUsingPHIsPerLoad;
Gabor Greif27236912010-04-07 18:59:26 +00001314 for (Value::const_use_iterator UI = GV->use_begin(), E = GV->use_end();
1315 UI != E; ++UI)
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001316 if (const LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
Evan Cheng5d163962009-06-02 00:56:07 +00001317 if (!LoadUsesSimpleEnoughForHeapSRA(LI, LoadUsingPHIs,
1318 LoadUsingPHIsPerLoad))
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001319 return false;
Evan Cheng5d163962009-06-02 00:56:07 +00001320 LoadUsingPHIsPerLoad.clear();
1321 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001322
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001323 // If we reach here, we know that all uses of the loads and transitive uses
1324 // (through PHI nodes) are simple enough to transform. However, we don't know
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001325 // that all inputs the to the PHI nodes are in the same equivalence sets.
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001326 // Check to verify that all operands of the PHIs are either PHIS that can be
1327 // transformed, loads from GV, or MI itself.
Gabor Greif27236912010-04-07 18:59:26 +00001328 for (SmallPtrSet<const PHINode*, 32>::const_iterator I = LoadUsingPHIs.begin()
1329 , E = LoadUsingPHIs.end(); I != E; ++I) {
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001330 const PHINode *PN = *I;
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001331 for (unsigned op = 0, e = PN->getNumIncomingValues(); op != e; ++op) {
1332 Value *InVal = PN->getIncomingValue(op);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001333
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001334 // PHI of the stored value itself is ok.
Victor Hernandez83d63912009-09-18 22:35:49 +00001335 if (InVal == StoredVal) continue;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001336
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001337 if (const PHINode *InPN = dyn_cast<PHINode>(InVal)) {
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001338 // One of the PHIs in our set is (optimistically) ok.
1339 if (LoadUsingPHIs.count(InPN))
1340 continue;
1341 return false;
1342 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001343
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001344 // Load from GV is ok.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001345 if (const LoadInst *LI = dyn_cast<LoadInst>(InVal))
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001346 if (LI->getOperand(0) == GV)
1347 continue;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001348
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001349 // UNDEF? NULL?
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001350
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001351 // Anything else is rejected.
1352 return false;
1353 }
1354 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001355
Chris Lattner86395032006-09-30 23:32:09 +00001356 return true;
1357}
1358
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001359static Value *GetHeapSROAValue(Value *V, unsigned FieldNo,
1360 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001361 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001362 std::vector<Value*> &FieldVals = InsertedScalarizedValues[V];
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001363
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001364 if (FieldNo >= FieldVals.size())
1365 FieldVals.resize(FieldNo+1);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001366
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001367 // If we already have this value, just reuse the previously scalarized
1368 // version.
1369 if (Value *FieldVal = FieldVals[FieldNo])
1370 return FieldVal;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001371
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001372 // Depending on what instruction this is, we have several cases.
1373 Value *Result;
1374 if (LoadInst *LI = dyn_cast<LoadInst>(V)) {
1375 // This is a scalarized version of the load from the global. Just create
1376 // a new Load of the scalarized global.
1377 Result = new LoadInst(GetHeapSROAValue(LI->getOperand(0), FieldNo,
1378 InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001379 PHIsToRewrite),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001380 LI->getName()+".f"+Twine(FieldNo), LI);
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001381 } else if (PHINode *PN = dyn_cast<PHINode>(V)) {
1382 // PN's type is pointer to struct. Make a new PHI of pointer to struct
1383 // field.
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001384 StructType *ST =
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001385 cast<StructType>(cast<PointerType>(PN->getType())->getElementType());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001386
Jay Foadd8b4fb42011-03-30 11:19:20 +00001387 PHINode *NewPN =
Owen Andersondebcb012009-07-29 22:17:13 +00001388 PHINode::Create(PointerType::getUnqual(ST->getElementType(FieldNo)),
Jay Foad3ecfc862011-03-30 11:28:46 +00001389 PN->getNumIncomingValues(),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001390 PN->getName()+".f"+Twine(FieldNo), PN);
Jay Foadd8b4fb42011-03-30 11:19:20 +00001391 Result = NewPN;
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001392 PHIsToRewrite.push_back(std::make_pair(PN, FieldNo));
1393 } else {
Torok Edwinc23197a2009-07-14 16:55:14 +00001394 llvm_unreachable("Unknown usable value");
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001395 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001396
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001397 return FieldVals[FieldNo] = Result;
Chris Lattnera637a8b2007-09-13 18:00:31 +00001398}
1399
Chris Lattner330245e2007-09-13 17:29:05 +00001400/// RewriteHeapSROALoadUser - Given a load instruction and a value derived from
1401/// the load, rewrite the derived value to use the HeapSRoA'd load.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001402static void RewriteHeapSROALoadUser(Instruction *LoadUser,
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001403 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001404 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattner330245e2007-09-13 17:29:05 +00001405 // If this is a comparison against null, handle it.
1406 if (ICmpInst *SCI = dyn_cast<ICmpInst>(LoadUser)) {
1407 assert(isa<ConstantPointerNull>(SCI->getOperand(1)));
1408 // If we have a setcc of the loaded pointer, we can use a setcc of any
1409 // field.
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001410 Value *NPtr = GetHeapSROAValue(SCI->getOperand(0), 0,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001411 InsertedScalarizedValues, PHIsToRewrite);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001412
Owen Anderson333c4002009-07-09 23:48:35 +00001413 Value *New = new ICmpInst(SCI, SCI->getPredicate(), NPtr,
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001414 Constant::getNullValue(NPtr->getType()),
Owen Anderson333c4002009-07-09 23:48:35 +00001415 SCI->getName());
Chris Lattner330245e2007-09-13 17:29:05 +00001416 SCI->replaceAllUsesWith(New);
1417 SCI->eraseFromParent();
1418 return;
1419 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001420
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001421 // Handle 'getelementptr Ptr, Idx, i32 FieldNo ...'
Chris Lattnera637a8b2007-09-13 18:00:31 +00001422 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(LoadUser)) {
1423 assert(GEPI->getNumOperands() >= 3 && isa<ConstantInt>(GEPI->getOperand(2))
1424 && "Unexpected GEPI!");
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001425
Chris Lattnera637a8b2007-09-13 18:00:31 +00001426 // Load the pointer for this field.
1427 unsigned FieldNo = cast<ConstantInt>(GEPI->getOperand(2))->getZExtValue();
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001428 Value *NewPtr = GetHeapSROAValue(GEPI->getOperand(0), FieldNo,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001429 InsertedScalarizedValues, PHIsToRewrite);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001430
Chris Lattnera637a8b2007-09-13 18:00:31 +00001431 // Create the new GEP idx vector.
1432 SmallVector<Value*, 8> GEPIdx;
1433 GEPIdx.push_back(GEPI->getOperand(1));
1434 GEPIdx.append(GEPI->op_begin()+3, GEPI->op_end());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001435
Jay Foada9203102011-07-25 09:48:08 +00001436 Value *NGEPI = GetElementPtrInst::Create(NewPtr, GEPIdx,
Gabor Greif051a9502008-04-06 20:25:17 +00001437 GEPI->getName(), GEPI);
Chris Lattnera637a8b2007-09-13 18:00:31 +00001438 GEPI->replaceAllUsesWith(NGEPI);
1439 GEPI->eraseFromParent();
1440 return;
1441 }
Chris Lattner309f20f2007-09-13 21:31:36 +00001442
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001443 // Recursively transform the users of PHI nodes. This will lazily create the
1444 // PHIs that are needed for individual elements. Keep track of what PHIs we
1445 // see in InsertedScalarizedValues so that we don't get infinite loops (very
1446 // antisocial). If the PHI is already in InsertedScalarizedValues, it has
1447 // already been seen first by another load, so its uses have already been
1448 // processed.
1449 PHINode *PN = cast<PHINode>(LoadUser);
Chris Lattnerc30a38f2011-07-21 06:21:31 +00001450 if (!InsertedScalarizedValues.insert(std::make_pair(PN,
1451 std::vector<Value*>())).second)
1452 return;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001453
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001454 // If this is the first time we've seen this PHI, recursively process all
1455 // users.
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001456 for (Value::use_iterator UI = PN->use_begin(), E = PN->use_end(); UI != E; ) {
1457 Instruction *User = cast<Instruction>(*UI++);
Chris Lattner7b550cc2009-11-06 04:27:31 +00001458 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001459 }
Chris Lattner330245e2007-09-13 17:29:05 +00001460}
1461
Chris Lattner86395032006-09-30 23:32:09 +00001462/// RewriteUsesOfLoadForHeapSRoA - We are performing Heap SRoA on a global. Ptr
1463/// is a value loaded from the global. Eliminate all uses of Ptr, making them
1464/// use FieldGlobals instead. All uses of loaded values satisfy
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001465/// AllGlobalLoadUsesSimpleEnoughForHeapSRA.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001466static void RewriteUsesOfLoadForHeapSRoA(LoadInst *Load,
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001467 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001468 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001469 for (Value::use_iterator UI = Load->use_begin(), E = Load->use_end();
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001470 UI != E; ) {
1471 Instruction *User = cast<Instruction>(*UI++);
Chris Lattner7b550cc2009-11-06 04:27:31 +00001472 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001473 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001474
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001475 if (Load->use_empty()) {
1476 Load->eraseFromParent();
1477 InsertedScalarizedValues.erase(Load);
1478 }
Chris Lattner86395032006-09-30 23:32:09 +00001479}
1480
Victor Hernandez83d63912009-09-18 22:35:49 +00001481/// PerformHeapAllocSRoA - CI is an allocation of an array of structures. Break
1482/// it up into multiple allocations of arrays of the fields.
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001483static GlobalVariable *PerformHeapAllocSRoA(GlobalVariable *GV, CallInst *CI,
Micah Villmow3574eca2012-10-08 16:38:25 +00001484 Value *NElems, DataLayout *TD,
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +00001485 const TargetLibraryInfo *TLI) {
David Greene3215b0e2010-01-05 01:28:05 +00001486 DEBUG(dbgs() << "SROA HEAP ALLOC: " << *GV << " MALLOC = " << *CI << '\n');
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +00001487 Type *MAT = getMallocAllocatedType(CI, TLI);
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001488 StructType *STy = cast<StructType>(MAT);
Victor Hernandez83d63912009-09-18 22:35:49 +00001489
1490 // There is guaranteed to be at least one use of the malloc (storing
1491 // it into GV). If there are other uses, change them to be uses of
1492 // the global to simplify later code. This also deletes the store
1493 // into GV.
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001494 ReplaceUsesOfMallocWithGlobal(CI, GV);
1495
Victor Hernandez83d63912009-09-18 22:35:49 +00001496 // Okay, at this point, there are no users of the malloc. Insert N
1497 // new mallocs at the same place as CI, and N globals.
1498 std::vector<Value*> FieldGlobals;
1499 std::vector<Value*> FieldMallocs;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001500
Victor Hernandez83d63912009-09-18 22:35:49 +00001501 for (unsigned FieldNo = 0, e = STy->getNumElements(); FieldNo != e;++FieldNo){
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001502 Type *FieldTy = STy->getElementType(FieldNo);
1503 PointerType *PFieldTy = PointerType::getUnqual(FieldTy);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001504
Victor Hernandez83d63912009-09-18 22:35:49 +00001505 GlobalVariable *NGV =
1506 new GlobalVariable(*GV->getParent(),
1507 PFieldTy, false, GlobalValue::InternalLinkage,
1508 Constant::getNullValue(PFieldTy),
1509 GV->getName() + ".f" + Twine(FieldNo), GV,
Hans Wennborgce718ff2012-06-23 11:37:03 +00001510 GV->getThreadLocalMode());
Victor Hernandez83d63912009-09-18 22:35:49 +00001511 FieldGlobals.push_back(NGV);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001512
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001513 unsigned TypeSize = TD->getTypeAllocSize(FieldTy);
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001514 if (StructType *ST = dyn_cast<StructType>(FieldTy))
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001515 TypeSize = TD->getStructLayout(ST)->getSizeInBytes();
Matt Arsenaultcf16bae2013-09-11 07:29:40 +00001516 Type *IntPtrTy = TD->getIntPtrType(CI->getType());
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001517 Value *NMI = CallInst::CreateMalloc(CI, IntPtrTy, FieldTy,
1518 ConstantInt::get(IntPtrTy, TypeSize),
Chris Lattner5a30a852010-07-12 00:57:28 +00001519 NElems, 0,
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001520 CI->getName() + ".f" + Twine(FieldNo));
Chris Lattner3f5e0b82010-02-26 18:23:13 +00001521 FieldMallocs.push_back(NMI);
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001522 new StoreInst(NMI, NGV, CI);
Victor Hernandez83d63912009-09-18 22:35:49 +00001523 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001524
Victor Hernandez83d63912009-09-18 22:35:49 +00001525 // The tricky aspect of this transformation is handling the case when malloc
1526 // fails. In the original code, malloc failing would set the result pointer
1527 // of malloc to null. In this case, some mallocs could succeed and others
1528 // could fail. As such, we emit code that looks like this:
1529 // F0 = malloc(field0)
1530 // F1 = malloc(field1)
1531 // F2 = malloc(field2)
1532 // if (F0 == 0 || F1 == 0 || F2 == 0) {
1533 // if (F0) { free(F0); F0 = 0; }
1534 // if (F1) { free(F1); F1 = 0; }
1535 // if (F2) { free(F2); F2 = 0; }
1536 // }
Victor Hernandez8e345a12009-11-10 08:32:25 +00001537 // The malloc can also fail if its argument is too large.
Gabor Greif9e4f2432010-06-24 14:42:01 +00001538 Constant *ConstantZero = ConstantInt::get(CI->getArgOperand(0)->getType(), 0);
1539 Value *RunningOr = new ICmpInst(CI, ICmpInst::ICMP_SLT, CI->getArgOperand(0),
Victor Hernandez8e345a12009-11-10 08:32:25 +00001540 ConstantZero, "isneg");
Victor Hernandez83d63912009-09-18 22:35:49 +00001541 for (unsigned i = 0, e = FieldMallocs.size(); i != e; ++i) {
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001542 Value *Cond = new ICmpInst(CI, ICmpInst::ICMP_EQ, FieldMallocs[i],
1543 Constant::getNullValue(FieldMallocs[i]->getType()),
1544 "isnull");
Victor Hernandez8e345a12009-11-10 08:32:25 +00001545 RunningOr = BinaryOperator::CreateOr(RunningOr, Cond, "tmp", CI);
Victor Hernandez83d63912009-09-18 22:35:49 +00001546 }
1547
1548 // Split the basic block at the old malloc.
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001549 BasicBlock *OrigBB = CI->getParent();
1550 BasicBlock *ContBB = OrigBB->splitBasicBlock(CI, "malloc_cont");
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001551
Victor Hernandez83d63912009-09-18 22:35:49 +00001552 // Create the block to check the first condition. Put all these blocks at the
1553 // end of the function as they are unlikely to be executed.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001554 BasicBlock *NullPtrBlock = BasicBlock::Create(OrigBB->getContext(),
1555 "malloc_ret_null",
Victor Hernandez83d63912009-09-18 22:35:49 +00001556 OrigBB->getParent());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001557
Victor Hernandez83d63912009-09-18 22:35:49 +00001558 // Remove the uncond branch from OrigBB to ContBB, turning it into a cond
1559 // branch on RunningOr.
1560 OrigBB->getTerminator()->eraseFromParent();
1561 BranchInst::Create(NullPtrBlock, ContBB, RunningOr, OrigBB);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001562
Victor Hernandez83d63912009-09-18 22:35:49 +00001563 // Within the NullPtrBlock, we need to emit a comparison and branch for each
1564 // pointer, because some may be null while others are not.
1565 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1566 Value *GVVal = new LoadInst(FieldGlobals[i], "tmp", NullPtrBlock);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001567 Value *Cmp = new ICmpInst(*NullPtrBlock, ICmpInst::ICMP_NE, GVVal,
Benjamin Kramera9390a42011-09-27 20:39:19 +00001568 Constant::getNullValue(GVVal->getType()));
Chris Lattner7b550cc2009-11-06 04:27:31 +00001569 BasicBlock *FreeBlock = BasicBlock::Create(Cmp->getContext(), "free_it",
Victor Hernandez83d63912009-09-18 22:35:49 +00001570 OrigBB->getParent());
Chris Lattner7b550cc2009-11-06 04:27:31 +00001571 BasicBlock *NextBlock = BasicBlock::Create(Cmp->getContext(), "next",
Victor Hernandez83d63912009-09-18 22:35:49 +00001572 OrigBB->getParent());
Victor Hernandez66284e02009-10-24 04:23:03 +00001573 Instruction *BI = BranchInst::Create(FreeBlock, NextBlock,
1574 Cmp, NullPtrBlock);
Victor Hernandez83d63912009-09-18 22:35:49 +00001575
1576 // Fill in FreeBlock.
Victor Hernandez66284e02009-10-24 04:23:03 +00001577 CallInst::CreateFree(GVVal, BI);
Victor Hernandez83d63912009-09-18 22:35:49 +00001578 new StoreInst(Constant::getNullValue(GVVal->getType()), FieldGlobals[i],
1579 FreeBlock);
1580 BranchInst::Create(NextBlock, FreeBlock);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001581
Victor Hernandez83d63912009-09-18 22:35:49 +00001582 NullPtrBlock = NextBlock;
1583 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001584
Victor Hernandez83d63912009-09-18 22:35:49 +00001585 BranchInst::Create(ContBB, NullPtrBlock);
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001586
1587 // CI is no longer needed, remove it.
Victor Hernandez83d63912009-09-18 22:35:49 +00001588 CI->eraseFromParent();
1589
1590 /// InsertedScalarizedLoads - As we process loads, if we can't immediately
1591 /// update all uses of the load, keep track of what scalarized loads are
1592 /// inserted for a given load.
1593 DenseMap<Value*, std::vector<Value*> > InsertedScalarizedValues;
1594 InsertedScalarizedValues[GV] = FieldGlobals;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001595
Victor Hernandez83d63912009-09-18 22:35:49 +00001596 std::vector<std::pair<PHINode*, unsigned> > PHIsToRewrite;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001597
Victor Hernandez83d63912009-09-18 22:35:49 +00001598 // Okay, the malloc site is completely handled. All of the uses of GV are now
1599 // loads, and all uses of those loads are simple. Rewrite them to use loads
1600 // of the per-field globals instead.
1601 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI != E;) {
1602 Instruction *User = cast<Instruction>(*UI++);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001603
Victor Hernandez83d63912009-09-18 22:35:49 +00001604 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
Chris Lattner7b550cc2009-11-06 04:27:31 +00001605 RewriteUsesOfLoadForHeapSRoA(LI, InsertedScalarizedValues, PHIsToRewrite);
Victor Hernandez83d63912009-09-18 22:35:49 +00001606 continue;
1607 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001608
Victor Hernandez83d63912009-09-18 22:35:49 +00001609 // Must be a store of null.
1610 StoreInst *SI = cast<StoreInst>(User);
1611 assert(isa<ConstantPointerNull>(SI->getOperand(0)) &&
1612 "Unexpected heap-sra user!");
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001613
Victor Hernandez83d63912009-09-18 22:35:49 +00001614 // Insert a store of null into each global.
1615 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001616 PointerType *PT = cast<PointerType>(FieldGlobals[i]->getType());
Victor Hernandez83d63912009-09-18 22:35:49 +00001617 Constant *Null = Constant::getNullValue(PT->getElementType());
1618 new StoreInst(Null, FieldGlobals[i], SI);
1619 }
1620 // Erase the original store.
1621 SI->eraseFromParent();
1622 }
1623
1624 // While we have PHIs that are interesting to rewrite, do it.
1625 while (!PHIsToRewrite.empty()) {
1626 PHINode *PN = PHIsToRewrite.back().first;
1627 unsigned FieldNo = PHIsToRewrite.back().second;
1628 PHIsToRewrite.pop_back();
1629 PHINode *FieldPN = cast<PHINode>(InsertedScalarizedValues[PN][FieldNo]);
1630 assert(FieldPN->getNumIncomingValues() == 0 &&"Already processed this phi");
1631
1632 // Add all the incoming values. This can materialize more phis.
1633 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1634 Value *InVal = PN->getIncomingValue(i);
1635 InVal = GetHeapSROAValue(InVal, FieldNo, InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001636 PHIsToRewrite);
Victor Hernandez83d63912009-09-18 22:35:49 +00001637 FieldPN->addIncoming(InVal, PN->getIncomingBlock(i));
1638 }
1639 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001640
Victor Hernandez83d63912009-09-18 22:35:49 +00001641 // Drop all inter-phi links and any loads that made it this far.
1642 for (DenseMap<Value*, std::vector<Value*> >::iterator
1643 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1644 I != E; ++I) {
1645 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1646 PN->dropAllReferences();
1647 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1648 LI->dropAllReferences();
1649 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001650
Victor Hernandez83d63912009-09-18 22:35:49 +00001651 // Delete all the phis and loads now that inter-references are dead.
1652 for (DenseMap<Value*, std::vector<Value*> >::iterator
1653 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1654 I != E; ++I) {
1655 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1656 PN->eraseFromParent();
1657 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1658 LI->eraseFromParent();
1659 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001660
Victor Hernandez83d63912009-09-18 22:35:49 +00001661 // The old global is now dead, remove it.
1662 GV->eraseFromParent();
1663
1664 ++NumHeapSRA;
1665 return cast<GlobalVariable>(FieldGlobals[0]);
1666}
1667
Chris Lattnere61d0a62008-12-15 21:02:25 +00001668/// TryToOptimizeStoreOfMallocToGlobal - This function is called when we see a
1669/// pointer global variable with a single value stored it that is a malloc or
1670/// cast of malloc.
1671static bool TryToOptimizeStoreOfMallocToGlobal(GlobalVariable *GV,
Victor Hernandez83d63912009-09-18 22:35:49 +00001672 CallInst *CI,
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001673 Type *AllocTy,
Nick Lewyckyfad4d402012-02-05 19:56:38 +00001674 AtomicOrdering Ordering,
Victor Hernandez83d63912009-09-18 22:35:49 +00001675 Module::global_iterator &GVI,
Micah Villmow3574eca2012-10-08 16:38:25 +00001676 DataLayout *TD,
Nick Lewycky6a577f82012-02-12 01:13:18 +00001677 TargetLibraryInfo *TLI) {
Evan Cheng86cd4452010-04-14 20:52:55 +00001678 if (!TD)
1679 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001680
Victor Hernandez83d63912009-09-18 22:35:49 +00001681 // If this is a malloc of an abstract type, don't touch it.
1682 if (!AllocTy->isSized())
1683 return false;
1684
1685 // We can't optimize this global unless all uses of it are *known* to be
1686 // of the malloc value, not of the null initializer value (consider a use
1687 // that compares the global's value against zero to see if the malloc has
1688 // been reached). To do this, we check to see if all uses of the global
1689 // would trap if the global were null: this proves that they must all
1690 // happen after the malloc.
1691 if (!AllUsesOfLoadedValueWillTrapIfNull(GV))
1692 return false;
1693
1694 // We can't optimize this if the malloc itself is used in a complex way,
1695 // for example, being stored into multiple globals. This allows the
Nick Lewyckybc384a12012-02-05 19:48:37 +00001696 // malloc to be stored into the specified global, loaded icmp'd, and
Victor Hernandez83d63912009-09-18 22:35:49 +00001697 // GEP'd. These are all things we could transform to using the global
1698 // for.
Evan Cheng86cd4452010-04-14 20:52:55 +00001699 SmallPtrSet<const PHINode*, 8> PHIs;
1700 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(CI, GV, PHIs))
1701 return false;
Victor Hernandez83d63912009-09-18 22:35:49 +00001702
1703 // If we have a global that is only initialized with a fixed size malloc,
1704 // transform the program to use global memory instead of malloc'd memory.
1705 // This eliminates dynamic allocation, avoids an indirection accessing the
1706 // data, and exposes the resultant global to further GlobalOpt.
Victor Hernandez8db42d22009-10-16 23:12:25 +00001707 // We cannot optimize the malloc if we cannot determine malloc array size.
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +00001708 Value *NElems = getMallocArraySize(CI, TD, TLI, true);
Evan Cheng86cd4452010-04-14 20:52:55 +00001709 if (!NElems)
1710 return false;
Victor Hernandez83d63912009-09-18 22:35:49 +00001711
Evan Cheng86cd4452010-04-14 20:52:55 +00001712 if (ConstantInt *NElements = dyn_cast<ConstantInt>(NElems))
1713 // Restrict this transformation to only working on small allocations
1714 // (2048 bytes currently), as we don't want to introduce a 16M global or
1715 // something.
1716 if (NElements->getZExtValue() * TD->getTypeAllocSize(AllocTy) < 2048) {
Nick Lewycky6a577f82012-02-12 01:13:18 +00001717 GVI = OptimizeGlobalAddressOfMalloc(GV, CI, AllocTy, NElements, TD, TLI);
Evan Cheng86cd4452010-04-14 20:52:55 +00001718 return true;
Victor Hernandez83d63912009-09-18 22:35:49 +00001719 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001720
Evan Cheng86cd4452010-04-14 20:52:55 +00001721 // If the allocation is an array of structures, consider transforming this
1722 // into multiple malloc'd arrays, one for each field. This is basically
1723 // SRoA for malloc'd memory.
1724
Nick Lewyckyfad4d402012-02-05 19:56:38 +00001725 if (Ordering != NotAtomic)
1726 return false;
1727
Evan Cheng86cd4452010-04-14 20:52:55 +00001728 // If this is an allocation of a fixed size array of structs, analyze as a
1729 // variable size array. malloc [100 x struct],1 -> malloc struct, 100
Gabor Greif9e4f2432010-06-24 14:42:01 +00001730 if (NElems == ConstantInt::get(CI->getArgOperand(0)->getType(), 1))
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001731 if (ArrayType *AT = dyn_cast<ArrayType>(AllocTy))
Evan Cheng86cd4452010-04-14 20:52:55 +00001732 AllocTy = AT->getElementType();
Gabor Greif9e4f2432010-06-24 14:42:01 +00001733
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001734 StructType *AllocSTy = dyn_cast<StructType>(AllocTy);
Evan Cheng86cd4452010-04-14 20:52:55 +00001735 if (!AllocSTy)
1736 return false;
1737
1738 // This the structure has an unreasonable number of fields, leave it
1739 // alone.
1740 if (AllocSTy->getNumElements() <= 16 && AllocSTy->getNumElements() != 0 &&
1741 AllGlobalLoadUsesSimpleEnoughForHeapSRA(GV, CI)) {
1742
1743 // If this is a fixed size array, transform the Malloc to be an alloc of
1744 // structs. malloc [100 x struct],1 -> malloc struct, 100
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +00001745 if (ArrayType *AT = dyn_cast<ArrayType>(getMallocAllocatedType(CI, TLI))) {
Matt Arsenaultcf16bae2013-09-11 07:29:40 +00001746 Type *IntPtrTy = TD->getIntPtrType(CI->getType());
Evan Cheng86cd4452010-04-14 20:52:55 +00001747 unsigned TypeSize = TD->getStructLayout(AllocSTy)->getSizeInBytes();
1748 Value *AllocSize = ConstantInt::get(IntPtrTy, TypeSize);
1749 Value *NumElements = ConstantInt::get(IntPtrTy, AT->getNumElements());
1750 Instruction *Malloc = CallInst::CreateMalloc(CI, IntPtrTy, AllocSTy,
1751 AllocSize, NumElements,
Chris Lattner5a30a852010-07-12 00:57:28 +00001752 0, CI->getName());
Evan Cheng86cd4452010-04-14 20:52:55 +00001753 Instruction *Cast = new BitCastInst(Malloc, CI->getType(), "tmp", CI);
1754 CI->replaceAllUsesWith(Cast);
1755 CI->eraseFromParent();
Nuno Lopeseb7c6862012-06-22 00:25:01 +00001756 if (BitCastInst *BCI = dyn_cast<BitCastInst>(Malloc))
1757 CI = cast<CallInst>(BCI->getOperand(0));
1758 else
Nuno Lopescd88efe2012-06-22 00:29:58 +00001759 CI = cast<CallInst>(Malloc);
Evan Cheng86cd4452010-04-14 20:52:55 +00001760 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001761
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +00001762 GVI = PerformHeapAllocSRoA(GV, CI, getMallocArraySize(CI, TD, TLI, true),
1763 TD, TLI);
Evan Cheng86cd4452010-04-14 20:52:55 +00001764 return true;
Victor Hernandez83d63912009-09-18 22:35:49 +00001765 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001766
Victor Hernandez83d63912009-09-18 22:35:49 +00001767 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001768}
Victor Hernandez83d63912009-09-18 22:35:49 +00001769
Chris Lattner9b34a612004-10-09 21:48:45 +00001770// OptimizeOnceStoredGlobal - Try to optimize globals based on the knowledge
1771// that only one value (besides its initializer) is ever stored to the global.
Chris Lattner30ba5692004-10-11 05:54:41 +00001772static bool OptimizeOnceStoredGlobal(GlobalVariable *GV, Value *StoredOnceVal,
Nick Lewyckyfad4d402012-02-05 19:56:38 +00001773 AtomicOrdering Ordering,
Chris Lattner7f8897f2006-08-27 22:42:52 +00001774 Module::global_iterator &GVI,
Micah Villmow3574eca2012-10-08 16:38:25 +00001775 DataLayout *TD, TargetLibraryInfo *TLI) {
Chris Lattner344b41c2008-12-15 21:20:32 +00001776 // Ignore no-op GEPs and bitcasts.
1777 StoredOnceVal = StoredOnceVal->stripPointerCasts();
Chris Lattner9b34a612004-10-09 21:48:45 +00001778
Chris Lattner708148e2004-10-10 23:14:11 +00001779 // If we are dealing with a pointer global that is initialized to null and
1780 // only has one (non-null) value stored into it, then we can optimize any
1781 // users of the loaded value (often calls and loads) that would trap if the
1782 // value was null.
Duncan Sands1df98592010-02-16 11:11:14 +00001783 if (GV->getInitializer()->getType()->isPointerTy() &&
Chris Lattner9b34a612004-10-09 21:48:45 +00001784 GV->getInitializer()->isNullValue()) {
Chris Lattner708148e2004-10-10 23:14:11 +00001785 if (Constant *SOVC = dyn_cast<Constant>(StoredOnceVal)) {
1786 if (GV->getInitializer()->getType() != SOVC->getType())
Chris Lattner98a42b22011-05-22 07:15:13 +00001787 SOVC = ConstantExpr::getBitCast(SOVC, GV->getInitializer()->getType());
Misha Brukmanfd939082005-04-21 23:48:37 +00001788
Chris Lattner708148e2004-10-10 23:14:11 +00001789 // Optimize away any trapping uses of the loaded value.
Nick Lewycky6a577f82012-02-12 01:13:18 +00001790 if (OptimizeAwayTrappingUsesOfLoads(GV, SOVC, TD, TLI))
Chris Lattner8be80122004-10-10 17:07:12 +00001791 return true;
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +00001792 } else if (CallInst *CI = extractMallocCall(StoredOnceVal, TLI)) {
1793 Type *MallocType = getMallocAllocatedType(CI, TLI);
Nick Lewycky6a577f82012-02-12 01:13:18 +00001794 if (MallocType &&
1795 TryToOptimizeStoreOfMallocToGlobal(GV, CI, MallocType, Ordering, GVI,
1796 TD, TLI))
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001797 return true;
Chris Lattner708148e2004-10-10 23:14:11 +00001798 }
Chris Lattner9b34a612004-10-09 21:48:45 +00001799 }
Chris Lattner30ba5692004-10-11 05:54:41 +00001800
Chris Lattner9b34a612004-10-09 21:48:45 +00001801 return false;
1802}
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001803
Chris Lattner58e44f42008-01-14 01:17:44 +00001804/// TryToShrinkGlobalToBoolean - At this point, we have learned that the only
1805/// two values ever stored into GV are its initializer and OtherVal. See if we
1806/// can shrink the global into a boolean and select between the two values
1807/// whenever it is used. This exposes the values to other scalar optimizations.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001808static bool TryToShrinkGlobalToBoolean(GlobalVariable *GV, Constant *OtherVal) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001809 Type *GVElType = GV->getType()->getElementType();
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001810
Chris Lattner58e44f42008-01-14 01:17:44 +00001811 // If GVElType is already i1, it is already shrunk. If the type of the GV is
Chris Lattner6f6923f2009-03-07 23:32:02 +00001812 // an FP value, pointer or vector, don't do this optimization because a select
1813 // between them is very expensive and unlikely to lead to later
1814 // simplification. In these cases, we typically end up with "cond ? v1 : v2"
1815 // where v1 and v2 both require constant pool loads, a big loss.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001816 if (GVElType == Type::getInt1Ty(GV->getContext()) ||
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00001817 GVElType->isFloatingPointTy() ||
Duncan Sands1df98592010-02-16 11:11:14 +00001818 GVElType->isPointerTy() || GVElType->isVectorTy())
Chris Lattner58e44f42008-01-14 01:17:44 +00001819 return false;
Gabor Greifaaaaa022010-07-12 14:13:15 +00001820
Chris Lattner58e44f42008-01-14 01:17:44 +00001821 // Walk the use list of the global seeing if all the uses are load or store.
1822 // If there is anything else, bail out.
Gabor Greifaaaaa022010-07-12 14:13:15 +00001823 for (Value::use_iterator I = GV->use_begin(), E = GV->use_end(); I != E; ++I){
1824 User *U = *I;
1825 if (!isa<LoadInst>(U) && !isa<StoreInst>(U))
Chris Lattner58e44f42008-01-14 01:17:44 +00001826 return false;
Gabor Greifaaaaa022010-07-12 14:13:15 +00001827 }
1828
David Greene3215b0e2010-01-05 01:28:05 +00001829 DEBUG(dbgs() << " *** SHRINKING TO BOOL: " << *GV);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001830
Chris Lattner96a86b22004-12-12 05:53:50 +00001831 // Create the new global, initializing it to false.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001832 GlobalVariable *NewGV = new GlobalVariable(Type::getInt1Ty(GV->getContext()),
1833 false,
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001834 GlobalValue::InternalLinkage,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001835 ConstantInt::getFalse(GV->getContext()),
Nick Lewycky0e670df2009-05-03 03:49:08 +00001836 GV->getName()+".b",
Joey Gouly1d505a32013-01-10 10:31:11 +00001837 GV->getThreadLocalMode(),
1838 GV->getType()->getAddressSpace());
Chris Lattner96a86b22004-12-12 05:53:50 +00001839 GV->getParent()->getGlobalList().insert(GV, NewGV);
1840
1841 Constant *InitVal = GV->getInitializer();
Chris Lattner7b550cc2009-11-06 04:27:31 +00001842 assert(InitVal->getType() != Type::getInt1Ty(GV->getContext()) &&
Owen Anderson1d0be152009-08-13 21:58:54 +00001843 "No reason to shrink to bool!");
Chris Lattner96a86b22004-12-12 05:53:50 +00001844
1845 // If initialized to zero and storing one into the global, we can use a cast
1846 // instead of a select to synthesize the desired value.
1847 bool IsOneZero = false;
1848 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal))
Reid Spencercae57542007-03-02 00:28:52 +00001849 IsOneZero = InitVal->isNullValue() && CI->isOne();
Chris Lattner96a86b22004-12-12 05:53:50 +00001850
1851 while (!GV->use_empty()) {
Devang Patel771281f2009-03-06 01:39:36 +00001852 Instruction *UI = cast<Instruction>(GV->use_back());
1853 if (StoreInst *SI = dyn_cast<StoreInst>(UI)) {
Chris Lattner96a86b22004-12-12 05:53:50 +00001854 // Change the store into a boolean store.
1855 bool StoringOther = SI->getOperand(0) == OtherVal;
1856 // Only do this if we weren't storing a loaded value.
Chris Lattner38c25562004-12-12 19:34:41 +00001857 Value *StoreVal;
Bill Wendling17fe48c2013-02-13 23:00:51 +00001858 if (StoringOther || SI->getOperand(0) == InitVal) {
Chris Lattner7b550cc2009-11-06 04:27:31 +00001859 StoreVal = ConstantInt::get(Type::getInt1Ty(GV->getContext()),
1860 StoringOther);
Bill Wendling17fe48c2013-02-13 23:00:51 +00001861 } else {
Chris Lattner38c25562004-12-12 19:34:41 +00001862 // Otherwise, we are storing a previously loaded copy. To do this,
1863 // change the copy from copying the original value to just copying the
1864 // bool.
1865 Instruction *StoredVal = cast<Instruction>(SI->getOperand(0));
1866
Gabor Greif9e4f2432010-06-24 14:42:01 +00001867 // If we've already replaced the input, StoredVal will be a cast or
Chris Lattner38c25562004-12-12 19:34:41 +00001868 // select instruction. If not, it will be a load of the original
1869 // global.
1870 if (LoadInst *LI = dyn_cast<LoadInst>(StoredVal)) {
1871 assert(LI->getOperand(0) == GV && "Not a copy!");
1872 // Insert a new load, to preserve the saved value.
Nick Lewyckyfad4d402012-02-05 19:56:38 +00001873 StoreVal = new LoadInst(NewGV, LI->getName()+".b", false, 0,
1874 LI->getOrdering(), LI->getSynchScope(), LI);
Chris Lattner38c25562004-12-12 19:34:41 +00001875 } else {
1876 assert((isa<CastInst>(StoredVal) || isa<SelectInst>(StoredVal)) &&
1877 "This is not a form that we understand!");
1878 StoreVal = StoredVal->getOperand(0);
1879 assert(isa<LoadInst>(StoreVal) && "Not a load of NewGV!");
1880 }
1881 }
Nick Lewyckyfad4d402012-02-05 19:56:38 +00001882 new StoreInst(StoreVal, NewGV, false, 0,
1883 SI->getOrdering(), SI->getSynchScope(), SI);
Devang Patel771281f2009-03-06 01:39:36 +00001884 } else {
Chris Lattner96a86b22004-12-12 05:53:50 +00001885 // Change the load into a load of bool then a select.
Devang Patel771281f2009-03-06 01:39:36 +00001886 LoadInst *LI = cast<LoadInst>(UI);
Nick Lewyckyfad4d402012-02-05 19:56:38 +00001887 LoadInst *NLI = new LoadInst(NewGV, LI->getName()+".b", false, 0,
1888 LI->getOrdering(), LI->getSynchScope(), LI);
Chris Lattner96a86b22004-12-12 05:53:50 +00001889 Value *NSI;
1890 if (IsOneZero)
Chris Lattner046800a2007-02-11 01:08:35 +00001891 NSI = new ZExtInst(NLI, LI->getType(), "", LI);
Misha Brukmanfd939082005-04-21 23:48:37 +00001892 else
Gabor Greif051a9502008-04-06 20:25:17 +00001893 NSI = SelectInst::Create(NLI, OtherVal, InitVal, "", LI);
Chris Lattner046800a2007-02-11 01:08:35 +00001894 NSI->takeName(LI);
Chris Lattner96a86b22004-12-12 05:53:50 +00001895 LI->replaceAllUsesWith(NSI);
Devang Patel771281f2009-03-06 01:39:36 +00001896 }
1897 UI->eraseFromParent();
Chris Lattner96a86b22004-12-12 05:53:50 +00001898 }
1899
Bill Wendling17fe48c2013-02-13 23:00:51 +00001900 // Retain the name of the old global variable. People who are debugging their
1901 // programs may expect these variables to be named the same.
1902 NewGV->takeName(GV);
Chris Lattner96a86b22004-12-12 05:53:50 +00001903 GV->eraseFromParent();
Chris Lattner58e44f42008-01-14 01:17:44 +00001904 return true;
Chris Lattner96a86b22004-12-12 05:53:50 +00001905}
1906
1907
Nick Lewyckydb292a62012-02-12 00:52:26 +00001908/// ProcessGlobal - Analyze the specified global variable and optimize it if
1909/// possible. If we make a change, return true.
Rafael Espindolac4440e32011-01-19 16:32:21 +00001910bool GlobalOpt::ProcessGlobal(GlobalVariable *GV,
1911 Module::global_iterator &GVI) {
Rafael Espindola03977292012-06-14 22:48:13 +00001912 if (!GV->isDiscardableIfUnused())
Rafael Espindolac4440e32011-01-19 16:32:21 +00001913 return false;
1914
1915 // Do more involved optimizations if the global is internal.
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001916 GV->removeDeadConstantUsers();
1917
1918 if (GV->use_empty()) {
David Greene3215b0e2010-01-05 01:28:05 +00001919 DEBUG(dbgs() << "GLOBAL DEAD: " << *GV);
Chris Lattner7a7ed022004-10-16 18:09:00 +00001920 GV->eraseFromParent();
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001921 ++NumDeleted;
1922 return true;
1923 }
1924
Rafael Espindola2f135d42012-06-15 18:00:24 +00001925 if (!GV->hasLocalLinkage())
1926 return false;
1927
Rafael Espindolac4440e32011-01-19 16:32:21 +00001928 GlobalStatus GS;
1929
Rafael Espindola4a7cef22013-10-17 18:00:25 +00001930 if (analyzeGlobal(GV, GS))
Rafael Espindoladaad56a2011-01-18 04:36:06 +00001931 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001932
Rafael Espindolac4440e32011-01-19 16:32:21 +00001933 if (!GS.isCompared && !GV->hasUnnamedAddr()) {
1934 GV->setUnnamedAddr(true);
1935 NumUnnamed++;
1936 }
1937
1938 if (GV->isConstant() || !GV->hasInitializer())
1939 return false;
1940
Rafael Espindola466fa172013-09-05 19:15:21 +00001941 return ProcessInternalGlobal(GV, GVI, GS);
Rafael Espindolac4440e32011-01-19 16:32:21 +00001942}
1943
1944/// ProcessInternalGlobal - Analyze the specified global variable and optimize
1945/// it if possible. If we make a change, return true.
1946bool GlobalOpt::ProcessInternalGlobal(GlobalVariable *GV,
1947 Module::global_iterator &GVI,
Rafael Espindolac4440e32011-01-19 16:32:21 +00001948 const GlobalStatus &GS) {
Alexey Samsonov23eb9072013-10-07 19:03:24 +00001949 // If this is a first class global and has only one accessing function
1950 // and this function is main (which we know is not recursive), we replace
1951 // the global with a local alloca in this function.
1952 //
1953 // NOTE: It doesn't make sense to promote non single-value types since we
1954 // are just replacing static memory to stack memory.
1955 //
1956 // If the global is in different address space, don't bring it to stack.
1957 if (!GS.HasMultipleAccessingFunctions &&
1958 GS.AccessingFunction && !GS.HasNonInstructionUser &&
1959 GV->getType()->getElementType()->isSingleValueType() &&
1960 GS.AccessingFunction->getName() == "main" &&
1961 GS.AccessingFunction->hasExternalLinkage() &&
1962 GV->getType()->getAddressSpace() == 0) {
1963 DEBUG(dbgs() << "LOCALIZING GLOBAL: " << *GV);
1964 Instruction &FirstI = const_cast<Instruction&>(*GS.AccessingFunction
1965 ->getEntryBlock().begin());
1966 Type *ElemTy = GV->getType()->getElementType();
1967 // FIXME: Pass Global's alignment when globals have alignment
1968 AllocaInst *Alloca = new AllocaInst(ElemTy, NULL, GV->getName(), &FirstI);
1969 if (!isa<UndefValue>(GV->getInitializer()))
1970 new StoreInst(GV->getInitializer(), Alloca, &FirstI);
1971
1972 GV->replaceAllUsesWith(Alloca);
1973 GV->eraseFromParent();
1974 ++NumLocalized;
1975 return true;
1976 }
1977
Rafael Espindoladaad56a2011-01-18 04:36:06 +00001978 // If the global is never loaded (but may be stored to), it is dead.
1979 // Delete it now.
1980 if (!GS.isLoaded) {
1981 DEBUG(dbgs() << "GLOBAL NEVER LOADED: " << *GV);
1982
Nick Lewycky8899d5c2012-07-24 07:21:08 +00001983 bool Changed;
1984 if (isLeakCheckerRoot(GV)) {
1985 // Delete any constant stores to the global.
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +00001986 Changed = CleanupPointerRootUsers(GV, TLI);
Nick Lewycky8899d5c2012-07-24 07:21:08 +00001987 } else {
1988 // Delete any stores we can find to the global. We may not be able to
1989 // make it completely dead though.
1990 Changed = CleanupConstantGlobalUsers(GV, GV->getInitializer(), TD, TLI);
1991 }
Rafael Espindoladaad56a2011-01-18 04:36:06 +00001992
1993 // If the global is dead now, delete it.
1994 if (GV->use_empty()) {
1995 GV->eraseFromParent();
1996 ++NumDeleted;
1997 Changed = true;
1998 }
1999 return Changed;
2000
2001 } else if (GS.StoredType <= GlobalStatus::isInitializerStored) {
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002002 DEBUG(dbgs() << "MARKING CONSTANT: " << *GV << "\n");
Rafael Espindoladaad56a2011-01-18 04:36:06 +00002003 GV->setConstant(true);
2004
2005 // Clean up any obviously simplifiable users now.
Nick Lewycky6a577f82012-02-12 01:13:18 +00002006 CleanupConstantGlobalUsers(GV, GV->getInitializer(), TD, TLI);
Rafael Espindoladaad56a2011-01-18 04:36:06 +00002007
2008 // If the global is dead now, just nuke it.
2009 if (GV->use_empty()) {
2010 DEBUG(dbgs() << " *** Marking constant allowed us to simplify "
2011 << "all users and delete global!\n");
2012 GV->eraseFromParent();
2013 ++NumDeleted;
2014 }
2015
2016 ++NumMarked;
2017 return true;
2018 } else if (!GV->getInitializer()->getType()->isSingleValueType()) {
Micah Villmow3574eca2012-10-08 16:38:25 +00002019 if (DataLayout *TD = getAnalysisIfAvailable<DataLayout>())
Rafael Espindoladaad56a2011-01-18 04:36:06 +00002020 if (GlobalVariable *FirstNewGV = SRAGlobal(GV, *TD)) {
2021 GVI = FirstNewGV; // Don't skip the newly produced globals!
2022 return true;
2023 }
2024 } else if (GS.StoredType == GlobalStatus::isStoredOnce) {
2025 // If the initial value for the global was an undef value, and if only
2026 // one other value was stored into it, we can just change the
2027 // initializer to be the stored value, then delete all stores to the
2028 // global. This allows us to mark it constant.
2029 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
2030 if (isa<UndefValue>(GV->getInitializer())) {
2031 // Change the initial value here.
2032 GV->setInitializer(SOVConstant);
2033
2034 // Clean up any obviously simplifiable users now.
Nick Lewycky6a577f82012-02-12 01:13:18 +00002035 CleanupConstantGlobalUsers(GV, GV->getInitializer(), TD, TLI);
Rafael Espindoladaad56a2011-01-18 04:36:06 +00002036
2037 if (GV->use_empty()) {
2038 DEBUG(dbgs() << " *** Substituting initializer allowed us to "
Nick Lewycky8899d5c2012-07-24 07:21:08 +00002039 << "simplify all users and delete global!\n");
Rafael Espindoladaad56a2011-01-18 04:36:06 +00002040 GV->eraseFromParent();
2041 ++NumDeleted;
2042 } else {
2043 GVI = GV;
2044 }
2045 ++NumSubstitute;
2046 return true;
2047 }
2048
2049 // Try to optimize globals based on the knowledge that only one value
2050 // (besides its initializer) is ever stored to the global.
Nick Lewyckyfad4d402012-02-05 19:56:38 +00002051 if (OptimizeOnceStoredGlobal(GV, GS.StoredOnceValue, GS.Ordering, GVI,
Nick Lewycky6a577f82012-02-12 01:13:18 +00002052 TD, TLI))
Rafael Espindoladaad56a2011-01-18 04:36:06 +00002053 return true;
2054
2055 // Otherwise, if the global was not a boolean, we can shrink it to be a
2056 // boolean.
Eli Friedmanb1c54932013-09-09 22:00:13 +00002057 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue)) {
2058 if (GS.Ordering == NotAtomic) {
2059 if (TryToShrinkGlobalToBoolean(GV, SOVConstant)) {
2060 ++NumShrunkToBool;
2061 return true;
2062 }
Rafael Espindoladaad56a2011-01-18 04:36:06 +00002063 }
Eli Friedmanb1c54932013-09-09 22:00:13 +00002064 }
Rafael Espindoladaad56a2011-01-18 04:36:06 +00002065 }
2066
Chris Lattnera4be1dc2004-10-08 20:59:28 +00002067 return false;
2068}
2069
Chris Lattnerfb217ad2005-05-08 22:18:06 +00002070/// ChangeCalleesToFastCall - Walk all of the direct calls of the specified
2071/// function, changing them to FastCC.
2072static void ChangeCalleesToFastCall(Function *F) {
2073 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
Jay Foadb7454fd2012-05-12 08:30:16 +00002074 if (isa<BlockAddress>(*UI))
2075 continue;
Duncan Sands548448a2008-02-18 17:32:13 +00002076 CallSite User(cast<Instruction>(*UI));
2077 User.setCallingConv(CallingConv::Fast);
Chris Lattnerfb217ad2005-05-08 22:18:06 +00002078 }
2079}
Chris Lattnera4be1dc2004-10-08 20:59:28 +00002080
Bill Wendling99faa3b2012-12-07 23:16:57 +00002081static AttributeSet StripNest(LLVMContext &C, const AttributeSet &Attrs) {
Chris Lattner58d74912008-03-12 17:45:29 +00002082 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendling8e47daf2013-01-25 23:09:36 +00002083 unsigned Index = Attrs.getSlotIndex(i);
2084 if (!Attrs.getSlotAttributes(i).hasAttribute(Index, Attribute::Nest))
Duncan Sands548448a2008-02-18 17:32:13 +00002085 continue;
2086
Duncan Sands548448a2008-02-18 17:32:13 +00002087 // There can be only one.
Bill Wendling8e47daf2013-01-25 23:09:36 +00002088 return Attrs.removeAttribute(C, Index, Attribute::Nest);
Duncan Sands3d5378f2008-02-16 20:56:04 +00002089 }
2090
2091 return Attrs;
2092}
2093
2094static void RemoveNestAttribute(Function *F) {
Bill Wendling5886b7b2012-10-14 06:39:53 +00002095 F->setAttributes(StripNest(F->getContext(), F->getAttributes()));
Duncan Sands3d5378f2008-02-16 20:56:04 +00002096 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
Jay Foadb7454fd2012-05-12 08:30:16 +00002097 if (isa<BlockAddress>(*UI))
2098 continue;
Duncan Sands548448a2008-02-18 17:32:13 +00002099 CallSite User(cast<Instruction>(*UI));
Bill Wendling5886b7b2012-10-14 06:39:53 +00002100 User.setAttributes(StripNest(F->getContext(), User.getAttributes()));
Duncan Sands3d5378f2008-02-16 20:56:04 +00002101 }
2102}
2103
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002104bool GlobalOpt::OptimizeFunctions(Module &M) {
2105 bool Changed = false;
2106 // Optimize functions.
2107 for (Module::iterator FI = M.begin(), E = M.end(); FI != E; ) {
2108 Function *F = FI++;
Duncan Sandsfc5940d2009-03-06 10:21:56 +00002109 // Functions without names cannot be referenced outside this module.
2110 if (!F->hasName() && !F->isDeclaration())
2111 F->setLinkage(GlobalValue::InternalLinkage);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002112 F->removeDeadConstantUsers();
Eli Friedmanc6633052011-10-20 05:23:42 +00002113 if (F->isDefTriviallyDead()) {
Chris Lattnerec4c7b92009-11-01 19:03:42 +00002114 F->eraseFromParent();
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002115 Changed = true;
2116 ++NumFnDeleted;
Rafael Espindolabb46f522009-01-15 20:18:42 +00002117 } else if (F->hasLocalLinkage()) {
Duncan Sands3d5378f2008-02-16 20:56:04 +00002118 if (F->getCallingConv() == CallingConv::C && !F->isVarArg() &&
Jay Foad757068f2009-06-10 08:41:11 +00002119 !F->hasAddressTaken()) {
Duncan Sands3d5378f2008-02-16 20:56:04 +00002120 // If this function has C calling conventions, is not a varargs
2121 // function, and is only called directly, promote it to use the Fast
2122 // calling convention.
2123 F->setCallingConv(CallingConv::Fast);
2124 ChangeCalleesToFastCall(F);
2125 ++NumFastCallFns;
2126 Changed = true;
2127 }
2128
Bill Wendling034b94b2012-12-19 07:18:57 +00002129 if (F->getAttributes().hasAttrSomewhere(Attribute::Nest) &&
Jay Foad757068f2009-06-10 08:41:11 +00002130 !F->hasAddressTaken()) {
Duncan Sands3d5378f2008-02-16 20:56:04 +00002131 // The function is not used by a trampoline intrinsic, so it is safe
2132 // to remove the 'nest' attribute.
2133 RemoveNestAttribute(F);
2134 ++NumNestRemoved;
2135 Changed = true;
2136 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002137 }
2138 }
2139 return Changed;
2140}
2141
2142bool GlobalOpt::OptimizeGlobalVars(Module &M) {
2143 bool Changed = false;
2144 for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
2145 GVI != E; ) {
2146 GlobalVariable *GV = GVI++;
Duncan Sandsfc5940d2009-03-06 10:21:56 +00002147 // Global variables without names cannot be referenced outside this module.
2148 if (!GV->hasName() && !GV->isDeclaration())
2149 GV->setLinkage(GlobalValue::InternalLinkage);
Dan Gohman01b97dd2009-11-23 16:22:21 +00002150 // Simplify the initializer.
2151 if (GV->hasInitializer())
2152 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GV->getInitializer())) {
Chad Rosieraab8e282011-12-02 01:26:24 +00002153 Constant *New = ConstantFoldConstantExpression(CE, TD, TLI);
Dan Gohman01b97dd2009-11-23 16:22:21 +00002154 if (New && New != CE)
2155 GV->setInitializer(New);
2156 }
Rafael Espindolac4440e32011-01-19 16:32:21 +00002157
2158 Changed |= ProcessGlobal(GV, GVI);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002159 }
2160 return Changed;
2161}
2162
Nick Lewycky2c44a802011-04-08 07:30:21 +00002163/// FindGlobalCtors - Find the llvm.global_ctors list, verifying that all
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002164/// initializers have an init priority of 65535.
2165GlobalVariable *GlobalOpt::FindGlobalCtors(Module &M) {
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00002166 GlobalVariable *GV = M.getGlobalVariable("llvm.global_ctors");
2167 if (GV == 0) return 0;
Jakub Staszak582088c2012-12-06 21:57:16 +00002168
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00002169 // Verify that the initializer is simple enough for us to handle. We are
2170 // only allowed to optimize the initializer if it is unique.
2171 if (!GV->hasUniqueInitializer()) return 0;
Nick Lewycky5ea5c612011-04-11 22:11:20 +00002172
2173 if (isa<ConstantAggregateZero>(GV->getInitializer()))
2174 return GV;
2175 ConstantArray *CA = cast<ConstantArray>(GV->getInitializer());
Eli Friedman18a2e502011-04-09 09:11:09 +00002176
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00002177 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i) {
Nick Lewycky5ea5c612011-04-11 22:11:20 +00002178 if (isa<ConstantAggregateZero>(*i))
2179 continue;
2180 ConstantStruct *CS = cast<ConstantStruct>(*i);
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00002181 if (isa<ConstantPointerNull>(CS->getOperand(1)))
2182 continue;
Chris Lattner7d8e58f2005-09-26 02:19:27 +00002183
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00002184 // Must have a function or null ptr.
2185 if (!isa<Function>(CS->getOperand(1)))
2186 return 0;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002187
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00002188 // Init priority must be standard.
Nick Lewycky2c44a802011-04-08 07:30:21 +00002189 ConstantInt *CI = cast<ConstantInt>(CS->getOperand(0));
2190 if (CI->getZExtValue() != 65535)
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00002191 return 0;
2192 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002193
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00002194 return GV;
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002195}
2196
Chris Lattnerdb973e62005-09-26 02:31:18 +00002197/// ParseGlobalCtors - Given a llvm.global_ctors list that we can understand,
2198/// return a list of the functions and null terminator as a vector.
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002199static std::vector<Function*> ParseGlobalCtors(GlobalVariable *GV) {
Nick Lewycky5ea5c612011-04-11 22:11:20 +00002200 if (GV->getInitializer()->isNullValue())
2201 return std::vector<Function*>();
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002202 ConstantArray *CA = cast<ConstantArray>(GV->getInitializer());
2203 std::vector<Function*> Result;
2204 Result.reserve(CA->getNumOperands());
Gabor Greif5e463212008-05-29 01:59:18 +00002205 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i) {
2206 ConstantStruct *CS = cast<ConstantStruct>(*i);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002207 Result.push_back(dyn_cast<Function>(CS->getOperand(1)));
2208 }
2209 return Result;
2210}
2211
Chris Lattnerdb973e62005-09-26 02:31:18 +00002212/// InstallGlobalCtors - Given a specified llvm.global_ctors list, install the
2213/// specified array, returning the new global to use.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002214static GlobalVariable *InstallGlobalCtors(GlobalVariable *GCL,
Chris Lattner7b550cc2009-11-06 04:27:31 +00002215 const std::vector<Function*> &Ctors) {
Chris Lattnerdb973e62005-09-26 02:31:18 +00002216 // If we made a change, reassemble the initializer list.
Chris Lattnerb065b062011-06-20 04:01:31 +00002217 Constant *CSVals[2];
2218 CSVals[0] = ConstantInt::get(Type::getInt32Ty(GCL->getContext()), 65535);
2219 CSVals[1] = 0;
2220
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002221 StructType *StructTy =
Chris Lattnerb065b062011-06-20 04:01:31 +00002222 cast <StructType>(
2223 cast<ArrayType>(GCL->getType()->getElementType())->getElementType());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002224
Chris Lattnerdb973e62005-09-26 02:31:18 +00002225 // Create the new init list.
2226 std::vector<Constant*> CAList;
2227 for (unsigned i = 0, e = Ctors.size(); i != e; ++i) {
Chris Lattner79c11012005-09-26 04:44:35 +00002228 if (Ctors[i]) {
Chris Lattnerdb973e62005-09-26 02:31:18 +00002229 CSVals[1] = Ctors[i];
Chris Lattner79c11012005-09-26 04:44:35 +00002230 } else {
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002231 Type *FTy = FunctionType::get(Type::getVoidTy(GCL->getContext()),
Chris Lattner7b550cc2009-11-06 04:27:31 +00002232 false);
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002233 PointerType *PFTy = PointerType::getUnqual(FTy);
Owen Andersona7235ea2009-07-31 20:28:14 +00002234 CSVals[1] = Constant::getNullValue(PFTy);
Chris Lattner7b550cc2009-11-06 04:27:31 +00002235 CSVals[0] = ConstantInt::get(Type::getInt32Ty(GCL->getContext()),
Nick Lewycky5ea5c612011-04-11 22:11:20 +00002236 0x7fffffff);
Chris Lattnerdb973e62005-09-26 02:31:18 +00002237 }
Chris Lattnerb065b062011-06-20 04:01:31 +00002238 CAList.push_back(ConstantStruct::get(StructTy, CSVals));
Chris Lattnerdb973e62005-09-26 02:31:18 +00002239 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002240
Chris Lattnerdb973e62005-09-26 02:31:18 +00002241 // Create the array initializer.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002242 Constant *CA = ConstantArray::get(ArrayType::get(StructTy,
Nick Lewyckyc332fba2009-09-19 20:30:26 +00002243 CAList.size()), CAList);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002244
Chris Lattnerdb973e62005-09-26 02:31:18 +00002245 // If we didn't change the number of elements, don't create a new GV.
2246 if (CA->getType() == GCL->getInitializer()->getType()) {
2247 GCL->setInitializer(CA);
2248 return GCL;
2249 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002250
Chris Lattnerdb973e62005-09-26 02:31:18 +00002251 // Create the new global and insert it next to the existing list.
Chris Lattner7b550cc2009-11-06 04:27:31 +00002252 GlobalVariable *NGV = new GlobalVariable(CA->getType(), GCL->isConstant(),
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00002253 GCL->getLinkage(), CA, "",
Hans Wennborgce718ff2012-06-23 11:37:03 +00002254 GCL->getThreadLocalMode());
Chris Lattnerdb973e62005-09-26 02:31:18 +00002255 GCL->getParent()->getGlobalList().insert(GCL, NGV);
Chris Lattner046800a2007-02-11 01:08:35 +00002256 NGV->takeName(GCL);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002257
Chris Lattnerdb973e62005-09-26 02:31:18 +00002258 // Nuke the old list, replacing any uses with the new one.
2259 if (!GCL->use_empty()) {
2260 Constant *V = NGV;
2261 if (V->getType() != GCL->getType())
Owen Andersonbaf3c402009-07-29 18:55:55 +00002262 V = ConstantExpr::getBitCast(V, GCL->getType());
Chris Lattnerdb973e62005-09-26 02:31:18 +00002263 GCL->replaceAllUsesWith(V);
2264 }
2265 GCL->eraseFromParent();
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002266
Chris Lattnerdb973e62005-09-26 02:31:18 +00002267 if (Ctors.size())
2268 return NGV;
2269 else
2270 return 0;
2271}
Chris Lattner79c11012005-09-26 04:44:35 +00002272
2273
Jakub Staszak582088c2012-12-06 21:57:16 +00002274static inline bool
Chris Lattner1945d582010-12-07 04:33:29 +00002275isSimpleEnoughValueToCommit(Constant *C,
Eli Friedmanfb54ad12012-01-05 23:03:32 +00002276 SmallPtrSet<Constant*, 8> &SimpleConstants,
Micah Villmow3574eca2012-10-08 16:38:25 +00002277 const DataLayout *TD);
Chris Lattner1945d582010-12-07 04:33:29 +00002278
2279
2280/// isSimpleEnoughValueToCommit - Return true if the specified constant can be
2281/// handled by the code generator. We don't want to generate something like:
2282/// void *X = &X/42;
2283/// because the code generator doesn't have a relocation that can handle that.
2284///
2285/// This function should be called if C was not found (but just got inserted)
2286/// in SimpleConstants to avoid having to rescan the same constants all the
2287/// time.
2288static bool isSimpleEnoughValueToCommitHelper(Constant *C,
Eli Friedmanfb54ad12012-01-05 23:03:32 +00002289 SmallPtrSet<Constant*, 8> &SimpleConstants,
Micah Villmow3574eca2012-10-08 16:38:25 +00002290 const DataLayout *TD) {
Chris Lattner1945d582010-12-07 04:33:29 +00002291 // Simple integer, undef, constant aggregate zero, global addresses, etc are
2292 // all supported.
2293 if (C->getNumOperands() == 0 || isa<BlockAddress>(C) ||
2294 isa<GlobalValue>(C))
2295 return true;
Jakub Staszak582088c2012-12-06 21:57:16 +00002296
Chris Lattner1945d582010-12-07 04:33:29 +00002297 // Aggregate values are safe if all their elements are.
2298 if (isa<ConstantArray>(C) || isa<ConstantStruct>(C) ||
2299 isa<ConstantVector>(C)) {
2300 for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i) {
2301 Constant *Op = cast<Constant>(C->getOperand(i));
Eli Friedmanfb54ad12012-01-05 23:03:32 +00002302 if (!isSimpleEnoughValueToCommit(Op, SimpleConstants, TD))
Chris Lattner1945d582010-12-07 04:33:29 +00002303 return false;
2304 }
2305 return true;
2306 }
Jakub Staszak582088c2012-12-06 21:57:16 +00002307
Chris Lattner1945d582010-12-07 04:33:29 +00002308 // We don't know exactly what relocations are allowed in constant expressions,
2309 // so we allow &global+constantoffset, which is safe and uniformly supported
2310 // across targets.
2311 ConstantExpr *CE = cast<ConstantExpr>(C);
2312 switch (CE->getOpcode()) {
2313 case Instruction::BitCast:
Eli Friedmanfb54ad12012-01-05 23:03:32 +00002314 // Bitcast is fine if the casted value is fine.
2315 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, TD);
2316
Chris Lattner1945d582010-12-07 04:33:29 +00002317 case Instruction::IntToPtr:
2318 case Instruction::PtrToInt:
Eli Friedmanfb54ad12012-01-05 23:03:32 +00002319 // int <=> ptr is fine if the int type is the same size as the
2320 // pointer type.
2321 if (!TD || TD->getTypeSizeInBits(CE->getType()) !=
2322 TD->getTypeSizeInBits(CE->getOperand(0)->getType()))
2323 return false;
2324 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, TD);
Jakub Staszak582088c2012-12-06 21:57:16 +00002325
Chris Lattner1945d582010-12-07 04:33:29 +00002326 // GEP is fine if it is simple + constant offset.
2327 case Instruction::GetElementPtr:
2328 for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
2329 if (!isa<ConstantInt>(CE->getOperand(i)))
2330 return false;
Eli Friedmanfb54ad12012-01-05 23:03:32 +00002331 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, TD);
Jakub Staszak582088c2012-12-06 21:57:16 +00002332
Chris Lattner1945d582010-12-07 04:33:29 +00002333 case Instruction::Add:
2334 // We allow simple+cst.
2335 if (!isa<ConstantInt>(CE->getOperand(1)))
2336 return false;
Eli Friedmanfb54ad12012-01-05 23:03:32 +00002337 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants, TD);
Chris Lattner1945d582010-12-07 04:33:29 +00002338 }
2339 return false;
2340}
2341
Jakub Staszak582088c2012-12-06 21:57:16 +00002342static inline bool
Chris Lattner1945d582010-12-07 04:33:29 +00002343isSimpleEnoughValueToCommit(Constant *C,
Eli Friedmanfb54ad12012-01-05 23:03:32 +00002344 SmallPtrSet<Constant*, 8> &SimpleConstants,
Micah Villmow3574eca2012-10-08 16:38:25 +00002345 const DataLayout *TD) {
Chris Lattner1945d582010-12-07 04:33:29 +00002346 // If we already checked this constant, we win.
2347 if (!SimpleConstants.insert(C)) return true;
2348 // Check the constant.
Eli Friedmanfb54ad12012-01-05 23:03:32 +00002349 return isSimpleEnoughValueToCommitHelper(C, SimpleConstants, TD);
Chris Lattner1945d582010-12-07 04:33:29 +00002350}
2351
2352
Chris Lattner79c11012005-09-26 04:44:35 +00002353/// isSimpleEnoughPointerToCommit - Return true if this constant is simple
Owen Andersoncff6b372011-01-14 22:19:20 +00002354/// enough for us to understand. In particular, if it is a cast to anything
2355/// other than from one pointer type to another pointer type, we punt.
2356/// We basically just support direct accesses to globals and GEP's of
Chris Lattner79c11012005-09-26 04:44:35 +00002357/// globals. This should be kept up to date with CommitValueTo.
Chris Lattner7b550cc2009-11-06 04:27:31 +00002358static bool isSimpleEnoughPointerToCommit(Constant *C) {
Dan Gohmance5de5b2009-09-07 22:42:05 +00002359 // Conservatively, avoid aggregate types. This is because we don't
2360 // want to worry about them partially overlapping other stores.
2361 if (!cast<PointerType>(C->getType())->getElementType()->isSingleValueType())
2362 return false;
2363
Dan Gohmanfd54a892009-09-07 22:31:26 +00002364 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
Mikhail Glushenkov99fca5d2010-10-19 16:47:23 +00002365 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
Dan Gohmanfd54a892009-09-07 22:31:26 +00002366 // external globals.
Mikhail Glushenkov99fca5d2010-10-19 16:47:23 +00002367 return GV->hasUniqueInitializer();
Dan Gohmanfd54a892009-09-07 22:31:26 +00002368
Owen Andersone95a32c2011-01-14 22:31:13 +00002369 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002370 // Handle a constantexpr gep.
2371 if (CE->getOpcode() == Instruction::GetElementPtr &&
Dan Gohmanc62482d2009-09-07 22:40:13 +00002372 isa<GlobalVariable>(CE->getOperand(0)) &&
2373 cast<GEPOperator>(CE)->isInBounds()) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002374 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Mikhail Glushenkov99fca5d2010-10-19 16:47:23 +00002375 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
Dan Gohmanfd54a892009-09-07 22:31:26 +00002376 // external globals.
Mikhail Glushenkov99fca5d2010-10-19 16:47:23 +00002377 if (!GV->hasUniqueInitializer())
Dan Gohmanfd54a892009-09-07 22:31:26 +00002378 return false;
Dan Gohman80bdc962009-09-07 22:44:55 +00002379
Dan Gohman80bdc962009-09-07 22:44:55 +00002380 // The first index must be zero.
Oscar Fuentesee56c422010-08-02 06:00:15 +00002381 ConstantInt *CI = dyn_cast<ConstantInt>(*llvm::next(CE->op_begin()));
Dan Gohman80bdc962009-09-07 22:44:55 +00002382 if (!CI || !CI->isZero()) return false;
Dan Gohman80bdc962009-09-07 22:44:55 +00002383
2384 // The remaining indices must be compile-time known integers within the
Dan Gohmane6992f72009-09-10 23:37:55 +00002385 // notional bounds of the corresponding static array types.
2386 if (!CE->isGEPWithNoNotionalOverIndexing())
2387 return false;
Dan Gohman80bdc962009-09-07 22:44:55 +00002388
Dan Gohmanc6f69e92009-10-05 16:36:26 +00002389 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
Jakub Staszak582088c2012-12-06 21:57:16 +00002390
Owen Andersoncff6b372011-01-14 22:19:20 +00002391 // A constantexpr bitcast from a pointer to another pointer is a no-op,
2392 // and we know how to evaluate it by moving the bitcast from the pointer
2393 // operand to the value operand.
2394 } else if (CE->getOpcode() == Instruction::BitCast &&
Chris Lattnerd5f656f2011-01-16 02:05:10 +00002395 isa<GlobalVariable>(CE->getOperand(0))) {
Owen Andersoncff6b372011-01-14 22:19:20 +00002396 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
2397 // external globals.
Chris Lattnerd5f656f2011-01-16 02:05:10 +00002398 return cast<GlobalVariable>(CE->getOperand(0))->hasUniqueInitializer();
Chris Lattner798b4d52005-09-26 06:52:44 +00002399 }
Owen Andersone95a32c2011-01-14 22:31:13 +00002400 }
Jakub Staszak582088c2012-12-06 21:57:16 +00002401
Chris Lattner79c11012005-09-26 04:44:35 +00002402 return false;
2403}
2404
Chris Lattner798b4d52005-09-26 06:52:44 +00002405/// EvaluateStoreInto - Evaluate a piece of a constantexpr store into a global
2406/// initializer. This returns 'Init' modified to reflect 'Val' stored into it.
2407/// At this point, the GEP operands of Addr [0, OpNo) have been stepped into.
2408static Constant *EvaluateStoreInto(Constant *Init, Constant *Val,
Zhou Shengefcdb292012-12-01 10:54:28 +00002409 ConstantExpr *Addr, unsigned OpNo) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002410 // Base case of the recursion.
2411 if (OpNo == Addr->getNumOperands()) {
2412 assert(Val->getType() == Init->getType() && "Type mismatch!");
2413 return Val;
2414 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002415
Chris Lattnera78fa8c2012-01-27 03:08:05 +00002416 SmallVector<Constant*, 32> Elts;
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002417 if (StructType *STy = dyn_cast<StructType>(Init->getType())) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002418 // Break up the constant into its elements.
Chris Lattnerd59ae902012-01-26 02:32:04 +00002419 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
2420 Elts.push_back(Init->getAggregateElement(i));
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002421
Chris Lattner798b4d52005-09-26 06:52:44 +00002422 // Replace the element that we are supposed to.
Reid Spencerb83eb642006-10-20 07:07:24 +00002423 ConstantInt *CU = cast<ConstantInt>(Addr->getOperand(OpNo));
2424 unsigned Idx = CU->getZExtValue();
2425 assert(Idx < STy->getNumElements() && "Struct index out of range!");
Zhou Shengefcdb292012-12-01 10:54:28 +00002426 Elts[Idx] = EvaluateStoreInto(Elts[Idx], Val, Addr, OpNo+1);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002427
Chris Lattner798b4d52005-09-26 06:52:44 +00002428 // Return the modified struct.
Chris Lattnerb065b062011-06-20 04:01:31 +00002429 return ConstantStruct::get(STy, Elts);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002430 }
Jakub Staszak582088c2012-12-06 21:57:16 +00002431
Chris Lattnerb065b062011-06-20 04:01:31 +00002432 ConstantInt *CI = cast<ConstantInt>(Addr->getOperand(OpNo));
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002433 SequentialType *InitTy = cast<SequentialType>(Init->getType());
Chris Lattnerb065b062011-06-20 04:01:31 +00002434
2435 uint64_t NumElts;
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002436 if (ArrayType *ATy = dyn_cast<ArrayType>(InitTy))
Chris Lattnerb065b062011-06-20 04:01:31 +00002437 NumElts = ATy->getNumElements();
2438 else
Chris Lattnerd59ae902012-01-26 02:32:04 +00002439 NumElts = InitTy->getVectorNumElements();
Chris Lattnerb065b062011-06-20 04:01:31 +00002440
2441 // Break up the array into elements.
Chris Lattnerd59ae902012-01-26 02:32:04 +00002442 for (uint64_t i = 0, e = NumElts; i != e; ++i)
2443 Elts.push_back(Init->getAggregateElement(i));
Chris Lattnerb065b062011-06-20 04:01:31 +00002444
2445 assert(CI->getZExtValue() < NumElts);
2446 Elts[CI->getZExtValue()] =
Zhou Shengefcdb292012-12-01 10:54:28 +00002447 EvaluateStoreInto(Elts[CI->getZExtValue()], Val, Addr, OpNo+1);
Chris Lattnerb065b062011-06-20 04:01:31 +00002448
2449 if (Init->getType()->isArrayTy())
2450 return ConstantArray::get(cast<ArrayType>(InitTy), Elts);
2451 return ConstantVector::get(Elts);
Chris Lattner798b4d52005-09-26 06:52:44 +00002452}
2453
Chris Lattner79c11012005-09-26 04:44:35 +00002454/// CommitValueTo - We have decided that Addr (which satisfies the predicate
2455/// isSimpleEnoughPointerToCommit) should get Val as its value. Make it happen.
Chris Lattner7b550cc2009-11-06 04:27:31 +00002456static void CommitValueTo(Constant *Val, Constant *Addr) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002457 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Addr)) {
2458 assert(GV->hasInitializer());
2459 GV->setInitializer(Val);
2460 return;
2461 }
Chris Lattnera0e9a242010-01-07 01:16:21 +00002462
Chris Lattner798b4d52005-09-26 06:52:44 +00002463 ConstantExpr *CE = cast<ConstantExpr>(Addr);
2464 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Zhou Shengefcdb292012-12-01 10:54:28 +00002465 GV->setInitializer(EvaluateStoreInto(GV->getInitializer(), Val, CE, 2));
Chris Lattner79c11012005-09-26 04:44:35 +00002466}
2467
Nick Lewycky7fa76772012-02-20 03:25:59 +00002468namespace {
2469
2470/// Evaluator - This class evaluates LLVM IR, producing the Constant
2471/// representing each SSA instruction. Changes to global variables are stored
2472/// in a mapping that can be iterated over after the evaluation is complete.
2473/// Once an evaluation call fails, the evaluation object should not be reused.
2474class Evaluator {
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002475public:
Micah Villmow3574eca2012-10-08 16:38:25 +00002476 Evaluator(const DataLayout *TD, const TargetLibraryInfo *TLI)
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002477 : TD(TD), TLI(TLI) {
2478 ValueStack.push_back(new DenseMap<Value*, Constant*>);
2479 }
2480
Nick Lewycky7fa76772012-02-20 03:25:59 +00002481 ~Evaluator() {
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002482 DeleteContainerPointers(ValueStack);
2483 while (!AllocaTmps.empty()) {
2484 GlobalVariable *Tmp = AllocaTmps.back();
2485 AllocaTmps.pop_back();
2486
2487 // If there are still users of the alloca, the program is doing something
2488 // silly, e.g. storing the address of the alloca somewhere and using it
2489 // later. Since this is undefined, we'll just make it be null.
2490 if (!Tmp->use_empty())
2491 Tmp->replaceAllUsesWith(Constant::getNullValue(Tmp->getType()));
2492 delete Tmp;
2493 }
2494 }
2495
2496 /// EvaluateFunction - Evaluate a call to function F, returning true if
2497 /// successful, false if we can't evaluate it. ActualArgs contains the formal
2498 /// arguments for the function.
2499 bool EvaluateFunction(Function *F, Constant *&RetVal,
2500 const SmallVectorImpl<Constant*> &ActualArgs);
2501
2502 /// EvaluateBlock - Evaluate all instructions in block BB, returning true if
2503 /// successful, false if we can't evaluate it. NewBB returns the next BB that
2504 /// control flows into, or null upon return.
2505 bool EvaluateBlock(BasicBlock::iterator CurInst, BasicBlock *&NextBB);
2506
2507 Constant *getVal(Value *V) {
2508 if (Constant *CV = dyn_cast<Constant>(V)) return CV;
2509 Constant *R = ValueStack.back()->lookup(V);
2510 assert(R && "Reference to an uncomputed value!");
2511 return R;
2512 }
2513
2514 void setVal(Value *V, Constant *C) {
2515 ValueStack.back()->operator[](V) = C;
2516 }
2517
2518 const DenseMap<Constant*, Constant*> &getMutatedMemory() const {
2519 return MutatedMemory;
2520 }
2521
2522 const SmallPtrSet<GlobalVariable*, 8> &getInvariants() const {
2523 return Invariants;
2524 }
2525
2526private:
2527 Constant *ComputeLoadResult(Constant *P);
2528
2529 /// ValueStack - As we compute SSA register values, we store their contents
2530 /// here. The back of the vector contains the current function and the stack
2531 /// contains the values in the calling frames.
2532 SmallVector<DenseMap<Value*, Constant*>*, 4> ValueStack;
2533
2534 /// CallStack - This is used to detect recursion. In pathological situations
2535 /// we could hit exponential behavior, but at least there is nothing
2536 /// unbounded.
2537 SmallVector<Function*, 4> CallStack;
2538
2539 /// MutatedMemory - For each store we execute, we update this map. Loads
2540 /// check this to get the most up-to-date value. If evaluation is successful,
2541 /// this state is committed to the process.
2542 DenseMap<Constant*, Constant*> MutatedMemory;
2543
2544 /// AllocaTmps - To 'execute' an alloca, we create a temporary global variable
2545 /// to represent its body. This vector is needed so we can delete the
2546 /// temporary globals when we are done.
2547 SmallVector<GlobalVariable*, 32> AllocaTmps;
2548
2549 /// Invariants - These global variables have been marked invariant by the
2550 /// static constructor.
2551 SmallPtrSet<GlobalVariable*, 8> Invariants;
2552
2553 /// SimpleConstants - These are constants we have checked and know to be
2554 /// simple enough to live in a static initializer of a global.
2555 SmallPtrSet<Constant*, 8> SimpleConstants;
2556
Micah Villmow3574eca2012-10-08 16:38:25 +00002557 const DataLayout *TD;
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002558 const TargetLibraryInfo *TLI;
2559};
2560
Nick Lewycky7fa76772012-02-20 03:25:59 +00002561} // anonymous namespace
2562
Chris Lattner562a0552005-09-26 05:16:34 +00002563/// ComputeLoadResult - Return the value that would be computed by a load from
2564/// P after the stores reflected by 'memory' have been performed. If we can't
2565/// decide, return null.
Nick Lewycky7fa76772012-02-20 03:25:59 +00002566Constant *Evaluator::ComputeLoadResult(Constant *P) {
Chris Lattner04de1cf2005-09-26 05:15:37 +00002567 // If this memory location has been recently stored, use the stored value: it
2568 // is the most up-to-date.
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002569 DenseMap<Constant*, Constant*>::const_iterator I = MutatedMemory.find(P);
2570 if (I != MutatedMemory.end()) return I->second;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002571
Chris Lattner04de1cf2005-09-26 05:15:37 +00002572 // Access it.
2573 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(P)) {
Dan Gohman82555732009-08-19 18:20:44 +00002574 if (GV->hasDefinitiveInitializer())
Chris Lattner04de1cf2005-09-26 05:15:37 +00002575 return GV->getInitializer();
2576 return 0;
Chris Lattner04de1cf2005-09-26 05:15:37 +00002577 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002578
Chris Lattner798b4d52005-09-26 06:52:44 +00002579 // Handle a constantexpr getelementptr.
2580 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(P))
2581 if (CE->getOpcode() == Instruction::GetElementPtr &&
2582 isa<GlobalVariable>(CE->getOperand(0))) {
2583 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Dan Gohman82555732009-08-19 18:20:44 +00002584 if (GV->hasDefinitiveInitializer())
Dan Gohmanc6f69e92009-10-05 16:36:26 +00002585 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
Chris Lattner798b4d52005-09-26 06:52:44 +00002586 }
2587
2588 return 0; // don't know how to evaluate.
Chris Lattner04de1cf2005-09-26 05:15:37 +00002589}
2590
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002591/// EvaluateBlock - Evaluate all instructions in block BB, returning true if
2592/// successful, false if we can't evaluate it. NewBB returns the next BB that
2593/// control flows into, or null upon return.
Nick Lewycky7fa76772012-02-20 03:25:59 +00002594bool Evaluator::EvaluateBlock(BasicBlock::iterator CurInst,
2595 BasicBlock *&NextBB) {
Chris Lattner79c11012005-09-26 04:44:35 +00002596 // This is the main evaluation loop.
2597 while (1) {
2598 Constant *InstResult = 0;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002599
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002600 DEBUG(dbgs() << "Evaluating Instruction: " << *CurInst << "\n");
2601
Chris Lattner79c11012005-09-26 04:44:35 +00002602 if (StoreInst *SI = dyn_cast<StoreInst>(CurInst)) {
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002603 if (!SI->isSimple()) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002604 DEBUG(dbgs() << "Store is not simple! Can not evaluate.\n");
2605 return false; // no volatile/atomic accesses.
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002606 }
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002607 Constant *Ptr = getVal(SI->getOperand(1));
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002608 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002609 DEBUG(dbgs() << "Folding constant ptr expression: " << *Ptr);
Nick Lewyckya641c072012-02-21 22:08:06 +00002610 Ptr = ConstantFoldConstantExpression(CE, TD, TLI);
Michael Gottesmandcf66952013-01-11 23:08:52 +00002611 DEBUG(dbgs() << "; To: " << *Ptr << "\n");
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002612 }
2613 if (!isSimpleEnoughPointerToCommit(Ptr)) {
Chris Lattner79c11012005-09-26 04:44:35 +00002614 // If this is too complex for us to commit, reject it.
Michael Gottesmandcf66952013-01-11 23:08:52 +00002615 DEBUG(dbgs() << "Pointer is too complex for us to evaluate store.");
Chris Lattnercd271422005-09-27 04:45:34 +00002616 return false;
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002617 }
Jakub Staszak582088c2012-12-06 21:57:16 +00002618
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002619 Constant *Val = getVal(SI->getOperand(0));
Chris Lattner1945d582010-12-07 04:33:29 +00002620
2621 // If this might be too difficult for the backend to handle (e.g. the addr
2622 // of one global variable divided by another) then we can't commit it.
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002623 if (!isSimpleEnoughValueToCommit(Val, SimpleConstants, TD)) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002624 DEBUG(dbgs() << "Store value is too complex to evaluate store. " << *Val
2625 << "\n");
Chris Lattner1945d582010-12-07 04:33:29 +00002626 return false;
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002627 }
Jakub Staszak582088c2012-12-06 21:57:16 +00002628
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002629 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
Owen Andersoncff6b372011-01-14 22:19:20 +00002630 if (CE->getOpcode() == Instruction::BitCast) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002631 DEBUG(dbgs() << "Attempting to resolve bitcast on constant ptr.\n");
Owen Andersoncff6b372011-01-14 22:19:20 +00002632 // If we're evaluating a store through a bitcast, then we need
2633 // to pull the bitcast off the pointer type and push it onto the
2634 // stored value.
Chris Lattnerd5f656f2011-01-16 02:05:10 +00002635 Ptr = CE->getOperand(0);
Jakub Staszak582088c2012-12-06 21:57:16 +00002636
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002637 Type *NewTy = cast<PointerType>(Ptr->getType())->getElementType();
Jakub Staszak582088c2012-12-06 21:57:16 +00002638
Owen Anderson66f708f2011-01-16 04:33:33 +00002639 // In order to push the bitcast onto the stored value, a bitcast
2640 // from NewTy to Val's type must be legal. If it's not, we can try
2641 // introspecting NewTy to find a legal conversion.
2642 while (!Val->getType()->canLosslesslyBitCastTo(NewTy)) {
2643 // If NewTy is a struct, we can convert the pointer to the struct
2644 // into a pointer to its first member.
2645 // FIXME: This could be extended to support arrays as well.
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002646 if (StructType *STy = dyn_cast<StructType>(NewTy)) {
Owen Anderson66f708f2011-01-16 04:33:33 +00002647 NewTy = STy->getTypeAtIndex(0U);
2648
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002649 IntegerType *IdxTy = IntegerType::get(NewTy->getContext(), 32);
Owen Anderson66f708f2011-01-16 04:33:33 +00002650 Constant *IdxZero = ConstantInt::get(IdxTy, 0, false);
2651 Constant * const IdxList[] = {IdxZero, IdxZero};
2652
Jay Foadb4263a62011-07-22 08:52:50 +00002653 Ptr = ConstantExpr::getGetElementPtr(Ptr, IdxList);
Nick Lewyckya641c072012-02-21 22:08:06 +00002654 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
2655 Ptr = ConstantFoldConstantExpression(CE, TD, TLI);
2656
Owen Anderson66f708f2011-01-16 04:33:33 +00002657 // If we can't improve the situation by introspecting NewTy,
2658 // we have to give up.
2659 } else {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002660 DEBUG(dbgs() << "Failed to bitcast constant ptr, can not "
2661 "evaluate.\n");
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002662 return false;
Owen Anderson66f708f2011-01-16 04:33:33 +00002663 }
Owen Andersoncff6b372011-01-14 22:19:20 +00002664 }
Jakub Staszak582088c2012-12-06 21:57:16 +00002665
Owen Anderson66f708f2011-01-16 04:33:33 +00002666 // If we found compatible types, go ahead and push the bitcast
2667 // onto the stored value.
Owen Andersoncff6b372011-01-14 22:19:20 +00002668 Val = ConstantExpr::getBitCast(Val, NewTy);
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002669
Michael Gottesmandcf66952013-01-11 23:08:52 +00002670 DEBUG(dbgs() << "Evaluated bitcast: " << *Val << "\n");
Owen Andersoncff6b372011-01-14 22:19:20 +00002671 }
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002672 }
Jakub Staszak582088c2012-12-06 21:57:16 +00002673
Chris Lattner79c11012005-09-26 04:44:35 +00002674 MutatedMemory[Ptr] = Val;
2675 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CurInst)) {
Owen Andersonbaf3c402009-07-29 18:55:55 +00002676 InstResult = ConstantExpr::get(BO->getOpcode(),
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002677 getVal(BO->getOperand(0)),
2678 getVal(BO->getOperand(1)));
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002679 DEBUG(dbgs() << "Found a BinaryOperator! Simplifying: " << *InstResult
Michael Gottesmandcf66952013-01-11 23:08:52 +00002680 << "\n");
Reid Spencere4d87aa2006-12-23 06:05:41 +00002681 } else if (CmpInst *CI = dyn_cast<CmpInst>(CurInst)) {
Owen Andersonbaf3c402009-07-29 18:55:55 +00002682 InstResult = ConstantExpr::getCompare(CI->getPredicate(),
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002683 getVal(CI->getOperand(0)),
2684 getVal(CI->getOperand(1)));
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002685 DEBUG(dbgs() << "Found a CmpInst! Simplifying: " << *InstResult
Michael Gottesmandcf66952013-01-11 23:08:52 +00002686 << "\n");
Chris Lattner79c11012005-09-26 04:44:35 +00002687 } else if (CastInst *CI = dyn_cast<CastInst>(CurInst)) {
Owen Andersonbaf3c402009-07-29 18:55:55 +00002688 InstResult = ConstantExpr::getCast(CI->getOpcode(),
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002689 getVal(CI->getOperand(0)),
Chris Lattner79c11012005-09-26 04:44:35 +00002690 CI->getType());
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002691 DEBUG(dbgs() << "Found a Cast! Simplifying: " << *InstResult
Michael Gottesmandcf66952013-01-11 23:08:52 +00002692 << "\n");
Chris Lattner79c11012005-09-26 04:44:35 +00002693 } else if (SelectInst *SI = dyn_cast<SelectInst>(CurInst)) {
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002694 InstResult = ConstantExpr::getSelect(getVal(SI->getOperand(0)),
2695 getVal(SI->getOperand(1)),
2696 getVal(SI->getOperand(2)));
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002697 DEBUG(dbgs() << "Found a Select! Simplifying: " << *InstResult
Michael Gottesmandcf66952013-01-11 23:08:52 +00002698 << "\n");
Chris Lattner04de1cf2005-09-26 05:15:37 +00002699 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(CurInst)) {
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002700 Constant *P = getVal(GEP->getOperand(0));
Chris Lattner55eb1c42007-01-31 04:40:53 +00002701 SmallVector<Constant*, 8> GEPOps;
Gabor Greif5e463212008-05-29 01:59:18 +00002702 for (User::op_iterator i = GEP->op_begin() + 1, e = GEP->op_end();
2703 i != e; ++i)
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002704 GEPOps.push_back(getVal(*i));
Jay Foad4b5e2072011-07-21 15:15:37 +00002705 InstResult =
2706 ConstantExpr::getGetElementPtr(P, GEPOps,
2707 cast<GEPOperator>(GEP)->isInBounds());
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002708 DEBUG(dbgs() << "Found a GEP! Simplifying: " << *InstResult
Michael Gottesmandcf66952013-01-11 23:08:52 +00002709 << "\n");
Chris Lattner04de1cf2005-09-26 05:15:37 +00002710 } else if (LoadInst *LI = dyn_cast<LoadInst>(CurInst)) {
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002711
2712 if (!LI->isSimple()) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002713 DEBUG(dbgs() << "Found a Load! Not a simple load, can not evaluate.\n");
2714 return false; // no volatile/atomic accesses.
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002715 }
2716
Nick Lewyckya641c072012-02-21 22:08:06 +00002717 Constant *Ptr = getVal(LI->getOperand(0));
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002718 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
Nick Lewyckya641c072012-02-21 22:08:06 +00002719 Ptr = ConstantFoldConstantExpression(CE, TD, TLI);
Michael Gottesmandcf66952013-01-11 23:08:52 +00002720 DEBUG(dbgs() << "Found a constant pointer expression, constant "
2721 "folding: " << *Ptr << "\n");
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002722 }
Nick Lewyckya641c072012-02-21 22:08:06 +00002723 InstResult = ComputeLoadResult(Ptr);
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002724 if (InstResult == 0) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002725 DEBUG(dbgs() << "Failed to compute load result. Can not evaluate load."
2726 "\n");
2727 return false; // Could not evaluate load.
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002728 }
2729
2730 DEBUG(dbgs() << "Evaluated load: " << *InstResult << "\n");
Chris Lattnera22fdb02005-09-26 17:07:09 +00002731 } else if (AllocaInst *AI = dyn_cast<AllocaInst>(CurInst)) {
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002732 if (AI->isArrayAllocation()) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002733 DEBUG(dbgs() << "Found an array alloca. Can not evaluate.\n");
2734 return false; // Cannot handle array allocs.
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002735 }
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002736 Type *Ty = AI->getType()->getElementType();
Chris Lattner7b550cc2009-11-06 04:27:31 +00002737 AllocaTmps.push_back(new GlobalVariable(Ty, false,
Chris Lattnera22fdb02005-09-26 17:07:09 +00002738 GlobalValue::InternalLinkage,
Owen Anderson9e9a0d52009-07-30 23:03:37 +00002739 UndefValue::get(Ty),
Chris Lattnera22fdb02005-09-26 17:07:09 +00002740 AI->getName()));
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002741 InstResult = AllocaTmps.back();
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002742 DEBUG(dbgs() << "Found an alloca. Result: " << *InstResult << "\n");
Nick Lewycky132bd9c2012-02-12 05:09:35 +00002743 } else if (isa<CallInst>(CurInst) || isa<InvokeInst>(CurInst)) {
2744 CallSite CS(CurInst);
Devang Patel412a4462009-03-09 23:04:12 +00002745
2746 // Debug info can safely be ignored here.
Nick Lewycky132bd9c2012-02-12 05:09:35 +00002747 if (isa<DbgInfoIntrinsic>(CS.getInstruction())) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002748 DEBUG(dbgs() << "Ignoring debug info.\n");
Devang Patel412a4462009-03-09 23:04:12 +00002749 ++CurInst;
2750 continue;
2751 }
2752
Chris Lattner7cd580f2006-07-07 21:37:01 +00002753 // Cannot handle inline asm.
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002754 if (isa<InlineAsm>(CS.getCalledValue())) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002755 DEBUG(dbgs() << "Found inline asm, can not evaluate.\n");
2756 return false;
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002757 }
Chris Lattner7cd580f2006-07-07 21:37:01 +00002758
Nick Lewycky81266c52012-02-17 06:59:21 +00002759 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction())) {
2760 if (MemSetInst *MSI = dyn_cast<MemSetInst>(II)) {
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002761 if (MSI->isVolatile()) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002762 DEBUG(dbgs() << "Can not optimize a volatile memset " <<
2763 "intrinsic.\n");
2764 return false;
2765 }
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002766 Constant *Ptr = getVal(MSI->getDest());
2767 Constant *Val = getVal(MSI->getValue());
2768 Constant *DestVal = ComputeLoadResult(getVal(Ptr));
Nick Lewycky81266c52012-02-17 06:59:21 +00002769 if (Val->isNullValue() && DestVal && DestVal->isNullValue()) {
2770 // This memset is a no-op.
Michael Gottesmandcf66952013-01-11 23:08:52 +00002771 DEBUG(dbgs() << "Ignoring no-op memset.\n");
Nick Lewycky81266c52012-02-17 06:59:21 +00002772 ++CurInst;
2773 continue;
2774 }
2775 }
2776
2777 if (II->getIntrinsicID() == Intrinsic::lifetime_start ||
2778 II->getIntrinsicID() == Intrinsic::lifetime_end) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002779 DEBUG(dbgs() << "Ignoring lifetime intrinsic.\n");
Nick Lewycky81266c52012-02-17 06:59:21 +00002780 ++CurInst;
2781 continue;
2782 }
2783
2784 if (II->getIntrinsicID() == Intrinsic::invariant_start) {
2785 // We don't insert an entry into Values, as it doesn't have a
2786 // meaningful return value.
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002787 if (!II->use_empty()) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002788 DEBUG(dbgs() << "Found unused invariant_start. Cant evaluate.\n");
Nick Lewycky81266c52012-02-17 06:59:21 +00002789 return false;
Michael Gottesmandcf66952013-01-11 23:08:52 +00002790 }
Nick Lewycky81266c52012-02-17 06:59:21 +00002791 ConstantInt *Size = cast<ConstantInt>(II->getArgOperand(0));
Nick Lewycky0ef05572012-02-20 23:32:26 +00002792 Value *PtrArg = getVal(II->getArgOperand(1));
2793 Value *Ptr = PtrArg->stripPointerCasts();
2794 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Ptr)) {
2795 Type *ElemTy = cast<PointerType>(GV->getType())->getElementType();
Nick Lewyckyb97b1622013-07-25 02:55:14 +00002796 if (TD && !Size->isAllOnesValue() &&
Nick Lewycky0ef05572012-02-20 23:32:26 +00002797 Size->getValue().getLimitedValue() >=
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002798 TD->getTypeStoreSize(ElemTy)) {
Nick Lewycky81266c52012-02-17 06:59:21 +00002799 Invariants.insert(GV);
Michael Gottesmandcf66952013-01-11 23:08:52 +00002800 DEBUG(dbgs() << "Found a global var that is an invariant: " << *GV
2801 << "\n");
2802 } else {
2803 DEBUG(dbgs() << "Found a global var, but can not treat it as an "
2804 "invariant.\n");
2805 }
Nick Lewycky81266c52012-02-17 06:59:21 +00002806 }
2807 // Continue even if we do nothing.
Nick Lewycky1f237b02011-05-29 18:41:56 +00002808 ++CurInst;
2809 continue;
2810 }
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002811
Michael Gottesmandcf66952013-01-11 23:08:52 +00002812 DEBUG(dbgs() << "Unknown intrinsic. Can not evaluate.\n");
Nick Lewycky1f237b02011-05-29 18:41:56 +00002813 return false;
2814 }
2815
Chris Lattnercd271422005-09-27 04:45:34 +00002816 // Resolve function pointers.
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002817 Function *Callee = dyn_cast<Function>(getVal(CS.getCalledValue()));
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002818 if (!Callee || Callee->mayBeOverridden()) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002819 DEBUG(dbgs() << "Can not resolve function pointer.\n");
Nick Lewycky132bd9c2012-02-12 05:09:35 +00002820 return false; // Cannot resolve.
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002821 }
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002822
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002823 SmallVector<Constant*, 8> Formals;
Nick Lewycky132bd9c2012-02-12 05:09:35 +00002824 for (User::op_iterator i = CS.arg_begin(), e = CS.arg_end(); i != e; ++i)
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002825 Formals.push_back(getVal(*i));
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002826
Reid Spencer5cbf9852007-01-30 20:08:39 +00002827 if (Callee->isDeclaration()) {
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002828 // If this is a function we can constant fold, do it.
Chad Rosier00737bd2011-12-01 21:29:16 +00002829 if (Constant *C = ConstantFoldCall(Callee, Formals, TLI)) {
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002830 InstResult = C;
Michael Gottesmandcf66952013-01-11 23:08:52 +00002831 DEBUG(dbgs() << "Constant folded function call. Result: " <<
2832 *InstResult << "\n");
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002833 } else {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002834 DEBUG(dbgs() << "Can not constant fold function call.\n");
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002835 return false;
2836 }
2837 } else {
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002838 if (Callee->getFunctionType()->isVarArg()) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002839 DEBUG(dbgs() << "Can not constant fold vararg function call.\n");
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002840 return false;
Michael Gottesmandcf66952013-01-11 23:08:52 +00002841 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002842
Benjamin Kramer08135892013-01-12 15:34:31 +00002843 Constant *RetVal = 0;
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002844 // Execute the call, if successful, use the return value.
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002845 ValueStack.push_back(new DenseMap<Value*, Constant*>);
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002846 if (!EvaluateFunction(Callee, RetVal, Formals)) {
Michael Gottesmandcf66952013-01-11 23:08:52 +00002847 DEBUG(dbgs() << "Failed to evaluate function.\n");
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002848 return false;
Michael Gottesmandcf66952013-01-11 23:08:52 +00002849 }
Benjamin Kramer3bbf2b62012-02-27 12:48:24 +00002850 delete ValueStack.pop_back_val();
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002851 InstResult = RetVal;
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002852
Michael Gottesmandcf66952013-01-11 23:08:52 +00002853 if (InstResult != NULL) {
2854 DEBUG(dbgs() << "Successfully evaluated function. Result: " <<
2855 InstResult << "\n\n");
2856 } else {
2857 DEBUG(dbgs() << "Successfully evaluated function. Result: 0\n\n");
2858 }
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002859 }
Reid Spencer3ed469c2006-11-02 20:25:50 +00002860 } else if (isa<TerminatorInst>(CurInst)) {
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002861 DEBUG(dbgs() << "Found a terminator instruction.\n");
2862
Chris Lattnercdf98be2005-09-26 04:57:38 +00002863 if (BranchInst *BI = dyn_cast<BranchInst>(CurInst)) {
2864 if (BI->isUnconditional()) {
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002865 NextBB = BI->getSuccessor(0);
Chris Lattnercdf98be2005-09-26 04:57:38 +00002866 } else {
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00002867 ConstantInt *Cond =
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002868 dyn_cast<ConstantInt>(getVal(BI->getCondition()));
Chris Lattner97d1fad2007-01-12 18:30:11 +00002869 if (!Cond) return false; // Cannot determine.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00002870
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002871 NextBB = BI->getSuccessor(!Cond->getZExtValue());
Chris Lattnercdf98be2005-09-26 04:57:38 +00002872 }
2873 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurInst)) {
2874 ConstantInt *Val =
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002875 dyn_cast<ConstantInt>(getVal(SI->getCondition()));
Chris Lattnercd271422005-09-27 04:45:34 +00002876 if (!Val) return false; // Cannot determine.
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002877 NextBB = SI->findCaseValue(Val).getCaseSuccessor();
Chris Lattnerb3d5a652009-10-29 05:51:50 +00002878 } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(CurInst)) {
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002879 Value *Val = getVal(IBI->getAddress())->stripPointerCasts();
Chris Lattnerb3d5a652009-10-29 05:51:50 +00002880 if (BlockAddress *BA = dyn_cast<BlockAddress>(Val))
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002881 NextBB = BA->getBasicBlock();
Chris Lattnercdfc9402009-11-01 01:27:45 +00002882 else
2883 return false; // Cannot determine.
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002884 } else if (isa<ReturnInst>(CurInst)) {
2885 NextBB = 0;
Chris Lattnercdf98be2005-09-26 04:57:38 +00002886 } else {
Bill Wendlingdccc03b2011-07-31 06:30:59 +00002887 // invoke, unwind, resume, unreachable.
Michael Gottesmandcf66952013-01-11 23:08:52 +00002888 DEBUG(dbgs() << "Can not handle terminator.");
Chris Lattnercd271422005-09-27 04:45:34 +00002889 return false; // Cannot handle this terminator.
Chris Lattnercdf98be2005-09-26 04:57:38 +00002890 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002891
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002892 // We succeeded at evaluating this block!
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002893 DEBUG(dbgs() << "Successfully evaluated block.\n");
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002894 return true;
Chris Lattner79c11012005-09-26 04:44:35 +00002895 } else {
Chris Lattner79c11012005-09-26 04:44:35 +00002896 // Did not know how to evaluate this!
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002897 DEBUG(dbgs() << "Failed to evaluate block due to unhandled instruction."
Michael Gottesmandcf66952013-01-11 23:08:52 +00002898 "\n");
Chris Lattnercd271422005-09-27 04:45:34 +00002899 return false;
Chris Lattner79c11012005-09-26 04:44:35 +00002900 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002901
Chris Lattner1945d582010-12-07 04:33:29 +00002902 if (!CurInst->use_empty()) {
2903 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(InstResult))
Chad Rosieraab8e282011-12-02 01:26:24 +00002904 InstResult = ConstantFoldConstantExpression(CE, TD, TLI);
Jakub Staszak582088c2012-12-06 21:57:16 +00002905
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002906 setVal(CurInst, InstResult);
Chris Lattner1945d582010-12-07 04:33:29 +00002907 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002908
Dan Gohmanf1ce79f2012-03-13 18:01:37 +00002909 // If we just processed an invoke, we finished evaluating the block.
2910 if (InvokeInst *II = dyn_cast<InvokeInst>(CurInst)) {
2911 NextBB = II->getNormalDest();
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002912 DEBUG(dbgs() << "Found an invoke instruction. Finished Block.\n\n");
Dan Gohmanf1ce79f2012-03-13 18:01:37 +00002913 return true;
2914 }
2915
Chris Lattner79c11012005-09-26 04:44:35 +00002916 // Advance program counter.
2917 ++CurInst;
2918 }
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002919}
2920
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002921/// EvaluateFunction - Evaluate a call to function F, returning true if
2922/// successful, false if we can't evaluate it. ActualArgs contains the formal
2923/// arguments for the function.
Nick Lewycky7fa76772012-02-20 03:25:59 +00002924bool Evaluator::EvaluateFunction(Function *F, Constant *&RetVal,
2925 const SmallVectorImpl<Constant*> &ActualArgs) {
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002926 // Check to see if this function is already executing (recursion). If so,
2927 // bail out. TODO: we might want to accept limited recursion.
2928 if (std::find(CallStack.begin(), CallStack.end(), F) != CallStack.end())
2929 return false;
2930
2931 CallStack.push_back(F);
2932
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002933 // Initialize arguments to the incoming values specified.
2934 unsigned ArgNo = 0;
2935 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end(); AI != E;
2936 ++AI, ++ArgNo)
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002937 setVal(AI, ActualArgs[ArgNo]);
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002938
2939 // ExecutedBlocks - We only handle non-looping, non-recursive code. As such,
2940 // we can only evaluate any one basic block at most once. This set keeps
2941 // track of what we have executed so we can detect recursive cases etc.
2942 SmallPtrSet<BasicBlock*, 32> ExecutedBlocks;
2943
2944 // CurBB - The current basic block we're evaluating.
2945 BasicBlock *CurBB = F->begin();
2946
Nick Lewycky8e4ba6b2012-02-12 00:47:24 +00002947 BasicBlock::iterator CurInst = CurBB->begin();
2948
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002949 while (1) {
Duncan Sands4b794f82012-02-23 08:23:06 +00002950 BasicBlock *NextBB = 0; // Initialized to avoid compiler warnings.
Michael Gottesmancddd8a62013-01-11 20:07:53 +00002951 DEBUG(dbgs() << "Trying to evaluate BB: " << *CurBB << "\n");
2952
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002953 if (!EvaluateBlock(CurInst, NextBB))
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002954 return false;
2955
2956 if (NextBB == 0) {
2957 // Successfully running until there's no next block means that we found
2958 // the return. Fill it the return value and pop the call stack.
2959 ReturnInst *RI = cast<ReturnInst>(CurBB->getTerminator());
2960 if (RI->getNumOperands())
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002961 RetVal = getVal(RI->getOperand(0));
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002962 CallStack.pop_back();
2963 return true;
2964 }
2965
2966 // Okay, we succeeded in evaluating this control flow. See if we have
2967 // executed the new block before. If so, we have a looping function,
2968 // which we cannot evaluate in reasonable time.
2969 if (!ExecutedBlocks.insert(NextBB))
2970 return false; // looped!
2971
2972 // Okay, we have never been in this block before. Check to see if there
2973 // are any PHI nodes. If so, evaluate them with information about where
2974 // we came from.
2975 PHINode *PN = 0;
Nick Lewycky8e4ba6b2012-02-12 00:47:24 +00002976 for (CurInst = NextBB->begin();
2977 (PN = dyn_cast<PHINode>(CurInst)); ++CurInst)
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002978 setVal(PN, getVal(PN->getIncomingValueForBlock(CurBB)));
Nick Lewyckyda82fd42012-02-06 08:24:44 +00002979
2980 // Advance to the next block.
2981 CurBB = NextBB;
2982 }
2983}
2984
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002985/// EvaluateStaticConstructor - Evaluate static constructors in the function, if
2986/// we can. Return true if we can, false otherwise.
Micah Villmow3574eca2012-10-08 16:38:25 +00002987static bool EvaluateStaticConstructor(Function *F, const DataLayout *TD,
Chad Rosier00737bd2011-12-01 21:29:16 +00002988 const TargetLibraryInfo *TLI) {
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002989 // Call the function.
Nick Lewycky7fa76772012-02-20 03:25:59 +00002990 Evaluator Eval(TD, TLI);
Chris Lattnercd271422005-09-27 04:45:34 +00002991 Constant *RetValDummy;
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002992 bool EvalSuccess = Eval.EvaluateFunction(F, RetValDummy,
2993 SmallVector<Constant*, 0>());
Jakub Staszak582088c2012-12-06 21:57:16 +00002994
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002995 if (EvalSuccess) {
Chris Lattnera22fdb02005-09-26 17:07:09 +00002996 // We succeeded at evaluation: commit the result.
David Greene3215b0e2010-01-05 01:28:05 +00002997 DEBUG(dbgs() << "FULLY EVALUATED GLOBAL CTOR FUNCTION '"
Nick Lewycky23ec5d72012-02-19 23:26:27 +00002998 << F->getName() << "' to " << Eval.getMutatedMemory().size()
Daniel Dunbarce63ffb2009-07-25 00:23:56 +00002999 << " stores.\n");
Nick Lewycky23ec5d72012-02-19 23:26:27 +00003000 for (DenseMap<Constant*, Constant*>::const_iterator I =
3001 Eval.getMutatedMemory().begin(), E = Eval.getMutatedMemory().end();
Nick Lewycky3eab3c42012-06-24 04:07:14 +00003002 I != E; ++I)
Chris Lattner7b550cc2009-11-06 04:27:31 +00003003 CommitValueTo(I->second, I->first);
Nick Lewycky23ec5d72012-02-19 23:26:27 +00003004 for (SmallPtrSet<GlobalVariable*, 8>::const_iterator I =
3005 Eval.getInvariants().begin(), E = Eval.getInvariants().end();
3006 I != E; ++I)
Nick Lewycky81266c52012-02-17 06:59:21 +00003007 (*I)->setConstant(true);
Chris Lattnera22fdb02005-09-26 17:07:09 +00003008 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00003009
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00003010 return EvalSuccess;
Chris Lattner79c11012005-09-26 04:44:35 +00003011}
3012
Chris Lattnerb1ab4582005-09-26 01:43:45 +00003013/// OptimizeGlobalCtorsList - Simplify and evaluation global ctors if possible.
3014/// Return true if anything changed.
3015bool GlobalOpt::OptimizeGlobalCtorsList(GlobalVariable *&GCL) {
3016 std::vector<Function*> Ctors = ParseGlobalCtors(GCL);
3017 bool MadeChange = false;
3018 if (Ctors.empty()) return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00003019
Chris Lattnerb1ab4582005-09-26 01:43:45 +00003020 // Loop over global ctors, optimizing them when we can.
3021 for (unsigned i = 0; i != Ctors.size(); ++i) {
3022 Function *F = Ctors[i];
3023 // Found a null terminator in the middle of the list, prune off the rest of
3024 // the list.
Chris Lattner7d8e58f2005-09-26 02:19:27 +00003025 if (F == 0) {
3026 if (i != Ctors.size()-1) {
3027 Ctors.resize(i+1);
3028 MadeChange = true;
3029 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00003030 break;
3031 }
Michael Gottesmancddd8a62013-01-11 20:07:53 +00003032 DEBUG(dbgs() << "Optimizing Global Constructor: " << *F << "\n");
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00003033
Chris Lattner79c11012005-09-26 04:44:35 +00003034 // We cannot simplify external ctor functions.
3035 if (F->empty()) continue;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00003036
Chris Lattner79c11012005-09-26 04:44:35 +00003037 // If we can evaluate the ctor at compile time, do.
Chad Rosier00737bd2011-12-01 21:29:16 +00003038 if (EvaluateStaticConstructor(F, TD, TLI)) {
Chris Lattner79c11012005-09-26 04:44:35 +00003039 Ctors.erase(Ctors.begin()+i);
3040 MadeChange = true;
3041 --i;
3042 ++NumCtorsEvaluated;
3043 continue;
3044 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00003045 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00003046
Chris Lattnerb1ab4582005-09-26 01:43:45 +00003047 if (!MadeChange) return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00003048
Chris Lattner7b550cc2009-11-06 04:27:31 +00003049 GCL = InstallGlobalCtors(GCL, Ctors);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00003050 return true;
3051}
3052
Benjamin Kramer0d293e42013-09-22 14:09:50 +00003053static int compareNames(Constant *const *A, Constant *const *B) {
3054 return (*A)->getName().compare((*B)->getName());
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003055}
Rafael Espindola95f88532013-05-09 17:22:59 +00003056
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003057static void setUsedInitializer(GlobalVariable &V,
3058 SmallPtrSet<GlobalValue *, 8> Init) {
Rafael Espindola64f2f912013-07-20 23:33:15 +00003059 if (Init.empty()) {
3060 V.eraseFromParent();
3061 return;
3062 }
3063
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003064 SmallVector<llvm::Constant *, 8> UsedArray;
3065 PointerType *Int8PtrTy = Type::getInt8PtrTy(V.getContext());
Rafael Espindola95f88532013-05-09 17:22:59 +00003066
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003067 for (SmallPtrSet<GlobalValue *, 8>::iterator I = Init.begin(), E = Init.end();
3068 I != E; ++I) {
3069 Constant *Cast = llvm::ConstantExpr::getBitCast(*I, Int8PtrTy);
3070 UsedArray.push_back(Cast);
Rafael Espindola95f88532013-05-09 17:22:59 +00003071 }
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003072 // Sort to get deterministic order.
3073 array_pod_sort(UsedArray.begin(), UsedArray.end(), compareNames);
3074 ArrayType *ATy = ArrayType::get(Int8PtrTy, UsedArray.size());
Rafael Espindola95f88532013-05-09 17:22:59 +00003075
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003076 Module *M = V.getParent();
3077 V.removeFromParent();
3078 GlobalVariable *NV =
3079 new GlobalVariable(*M, ATy, false, llvm::GlobalValue::AppendingLinkage,
3080 llvm::ConstantArray::get(ATy, UsedArray), "");
3081 NV->takeName(&V);
3082 NV->setSection("llvm.metadata");
3083 delete &V;
Rafael Espindola95f88532013-05-09 17:22:59 +00003084}
3085
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003086namespace {
Rafael Espindola70968312013-07-19 18:44:51 +00003087/// \brief An easy to access representation of llvm.used and llvm.compiler.used.
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003088class LLVMUsed {
3089 SmallPtrSet<GlobalValue *, 8> Used;
3090 SmallPtrSet<GlobalValue *, 8> CompilerUsed;
3091 GlobalVariable *UsedV;
3092 GlobalVariable *CompilerUsedV;
3093
3094public:
Rafael Espindola2d680822013-07-25 02:50:08 +00003095 LLVMUsed(Module &M) {
Rafael Espindola4ef7eaf2013-07-25 03:23:25 +00003096 UsedV = collectUsedGlobalVariables(M, Used, false);
3097 CompilerUsedV = collectUsedGlobalVariables(M, CompilerUsed, true);
Rafael Espindola95f88532013-05-09 17:22:59 +00003098 }
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003099 typedef SmallPtrSet<GlobalValue *, 8>::iterator iterator;
3100 iterator usedBegin() { return Used.begin(); }
3101 iterator usedEnd() { return Used.end(); }
3102 iterator compilerUsedBegin() { return CompilerUsed.begin(); }
3103 iterator compilerUsedEnd() { return CompilerUsed.end(); }
3104 bool usedCount(GlobalValue *GV) const { return Used.count(GV); }
3105 bool compilerUsedCount(GlobalValue *GV) const {
3106 return CompilerUsed.count(GV);
3107 }
3108 bool usedErase(GlobalValue *GV) { return Used.erase(GV); }
3109 bool compilerUsedErase(GlobalValue *GV) { return CompilerUsed.erase(GV); }
3110 bool usedInsert(GlobalValue *GV) { return Used.insert(GV); }
3111 bool compilerUsedInsert(GlobalValue *GV) { return CompilerUsed.insert(GV); }
Rafael Espindola95f88532013-05-09 17:22:59 +00003112
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003113 void syncVariablesAndSets() {
3114 if (UsedV)
3115 setUsedInitializer(*UsedV, Used);
3116 if (CompilerUsedV)
3117 setUsedInitializer(*CompilerUsedV, CompilerUsed);
3118 }
3119};
Rafael Espindola95f88532013-05-09 17:22:59 +00003120}
3121
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003122static bool hasUseOtherThanLLVMUsed(GlobalAlias &GA, const LLVMUsed &U) {
3123 if (GA.use_empty()) // No use at all.
3124 return false;
3125
3126 assert((!U.usedCount(&GA) || !U.compilerUsedCount(&GA)) &&
3127 "We should have removed the duplicated "
Rafael Espindola70968312013-07-19 18:44:51 +00003128 "element from llvm.compiler.used");
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003129 if (!GA.hasOneUse())
3130 // Strictly more than one use. So at least one is not in llvm.used and
Rafael Espindola70968312013-07-19 18:44:51 +00003131 // llvm.compiler.used.
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003132 return true;
3133
Rafael Espindola70968312013-07-19 18:44:51 +00003134 // Exactly one use. Check if it is in llvm.used or llvm.compiler.used.
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003135 return !U.usedCount(&GA) && !U.compilerUsedCount(&GA);
Rafael Espindola95f88532013-05-09 17:22:59 +00003136}
3137
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003138static bool hasMoreThanOneUseOtherThanLLVMUsed(GlobalValue &V,
3139 const LLVMUsed &U) {
3140 unsigned N = 2;
3141 assert((!U.usedCount(&V) || !U.compilerUsedCount(&V)) &&
3142 "We should have removed the duplicated "
Rafael Espindola70968312013-07-19 18:44:51 +00003143 "element from llvm.compiler.used");
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003144 if (U.usedCount(&V) || U.compilerUsedCount(&V))
3145 ++N;
3146 return V.hasNUsesOrMore(N);
3147}
3148
3149static bool mayHaveOtherReferences(GlobalAlias &GA, const LLVMUsed &U) {
3150 if (!GA.hasLocalLinkage())
3151 return true;
3152
3153 return U.usedCount(&GA) || U.compilerUsedCount(&GA);
3154}
3155
3156static bool hasUsesToReplace(GlobalAlias &GA, LLVMUsed &U, bool &RenameTarget) {
3157 RenameTarget = false;
Rafael Espindola95f88532013-05-09 17:22:59 +00003158 bool Ret = false;
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003159 if (hasUseOtherThanLLVMUsed(GA, U))
Rafael Espindola95f88532013-05-09 17:22:59 +00003160 Ret = true;
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003161
3162 // If the alias is externally visible, we may still be able to simplify it.
3163 if (!mayHaveOtherReferences(GA, U))
3164 return Ret;
3165
3166 // If the aliasee has internal linkage, give it the name and linkage
3167 // of the alias, and delete the alias. This turns:
3168 // define internal ... @f(...)
3169 // @a = alias ... @f
3170 // into:
3171 // define ... @a(...)
3172 Constant *Aliasee = GA.getAliasee();
3173 GlobalValue *Target = cast<GlobalValue>(Aliasee->stripPointerCasts());
3174 if (!Target->hasLocalLinkage())
3175 return Ret;
3176
3177 // Do not perform the transform if multiple aliases potentially target the
3178 // aliasee. This check also ensures that it is safe to replace the section
3179 // and other attributes of the aliasee with those of the alias.
3180 if (hasMoreThanOneUseOtherThanLLVMUsed(*Target, U))
3181 return Ret;
3182
3183 RenameTarget = true;
3184 return true;
Rafael Espindola95f88532013-05-09 17:22:59 +00003185}
3186
Duncan Sandsfc5940d2009-03-06 10:21:56 +00003187bool GlobalOpt::OptimizeGlobalAliases(Module &M) {
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00003188 bool Changed = false;
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003189 LLVMUsed Used(M);
3190
3191 for (SmallPtrSet<GlobalValue *, 8>::iterator I = Used.usedBegin(),
3192 E = Used.usedEnd();
3193 I != E; ++I)
3194 Used.compilerUsedErase(*I);
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00003195
Duncan Sands177d84e2009-01-07 20:01:06 +00003196 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
Duncan Sands4782b302009-02-15 09:56:08 +00003197 I != E;) {
3198 Module::alias_iterator J = I++;
Duncan Sandsfc5940d2009-03-06 10:21:56 +00003199 // Aliases without names cannot be referenced outside this module.
3200 if (!J->hasName() && !J->isDeclaration())
3201 J->setLinkage(GlobalValue::InternalLinkage);
Duncan Sands4782b302009-02-15 09:56:08 +00003202 // If the aliasee may change at link time, nothing can be done - bail out.
3203 if (J->mayBeOverridden())
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00003204 continue;
3205
Duncan Sands4782b302009-02-15 09:56:08 +00003206 Constant *Aliasee = J->getAliasee();
3207 GlobalValue *Target = cast<GlobalValue>(Aliasee->stripPointerCasts());
Duncan Sands95c5d0f2009-02-18 17:55:38 +00003208 Target->removeDeadConstantUsers();
Duncan Sands4782b302009-02-15 09:56:08 +00003209
3210 // Make all users of the alias use the aliasee instead.
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003211 bool RenameTarget;
3212 if (!hasUsesToReplace(*J, Used, RenameTarget))
Rafael Espindola95f88532013-05-09 17:22:59 +00003213 continue;
Duncan Sands4782b302009-02-15 09:56:08 +00003214
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003215 J->replaceAllUsesWith(Aliasee);
3216 ++NumAliasesResolved;
3217 Changed = true;
Duncan Sands4782b302009-02-15 09:56:08 +00003218
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003219 if (RenameTarget) {
Duncan Sands7a154cf2009-12-08 10:10:20 +00003220 // Give the aliasee the name, linkage and other attributes of the alias.
3221 Target->takeName(J);
3222 Target->setLinkage(J->getLinkage());
3223 Target->GlobalValue::copyAttributesFrom(J);
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003224
3225 if (Used.usedErase(J))
3226 Used.usedInsert(Target);
3227
3228 if (Used.compilerUsedErase(J))
3229 Used.compilerUsedInsert(Target);
Rafael Espindola100fbdd2013-06-12 16:45:47 +00003230 } else if (mayHaveOtherReferences(*J, Used))
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003231 continue;
3232
Duncan Sands4782b302009-02-15 09:56:08 +00003233 // Delete the alias.
3234 M.getAliasList().erase(J);
3235 ++NumAliasesRemoved;
3236 Changed = true;
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00003237 }
3238
Rafael Espindolad1b6ca22013-06-11 17:48:06 +00003239 Used.syncVariablesAndSets();
3240
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00003241 return Changed;
3242}
Chris Lattnerb1ab4582005-09-26 01:43:45 +00003243
Nick Lewycky6a7df9a2012-02-12 02:15:20 +00003244static Function *FindCXAAtExit(Module &M, TargetLibraryInfo *TLI) {
3245 if (!TLI->has(LibFunc::cxa_atexit))
Nick Lewycky6f160d32012-02-12 02:17:18 +00003246 return 0;
Nick Lewycky6a7df9a2012-02-12 02:15:20 +00003247
3248 Function *Fn = M.getFunction(TLI->getName(LibFunc::cxa_atexit));
Jakub Staszak582088c2012-12-06 21:57:16 +00003249
Anders Carlssona201c4c2011-03-20 17:59:11 +00003250 if (!Fn)
3251 return 0;
Nick Lewycky6a7df9a2012-02-12 02:15:20 +00003252
Chris Lattnerdb125cf2011-07-18 04:54:35 +00003253 FunctionType *FTy = Fn->getFunctionType();
Jakub Staszak582088c2012-12-06 21:57:16 +00003254
3255 // Checking that the function has the right return type, the right number of
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00003256 // parameters and that they all have pointer types should be enough.
3257 if (!FTy->getReturnType()->isIntegerTy() ||
3258 FTy->getNumParams() != 3 ||
Anders Carlssona201c4c2011-03-20 17:59:11 +00003259 !FTy->getParamType(0)->isPointerTy() ||
3260 !FTy->getParamType(1)->isPointerTy() ||
3261 !FTy->getParamType(2)->isPointerTy())
3262 return 0;
3263
3264 return Fn;
3265}
3266
3267/// cxxDtorIsEmpty - Returns whether the given function is an empty C++
3268/// destructor and can therefore be eliminated.
3269/// Note that we assume that other optimization passes have already simplified
3270/// the code so we only look for a function with a single basic block, where
Benjamin Kramerc1322a12012-02-09 16:28:15 +00003271/// the only allowed instructions are 'ret', 'call' to an empty C++ dtor and
3272/// other side-effect free instructions.
Anders Carlsson372ec6a2011-03-20 20:16:43 +00003273static bool cxxDtorIsEmpty(const Function &Fn,
3274 SmallPtrSet<const Function *, 8> &CalledFunctions) {
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00003275 // FIXME: We could eliminate C++ destructors if they're readonly/readnone and
Nick Lewycky35ee1c92011-03-21 02:26:01 +00003276 // nounwind, but that doesn't seem worth doing.
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00003277 if (Fn.isDeclaration())
3278 return false;
Anders Carlssona201c4c2011-03-20 17:59:11 +00003279
3280 if (++Fn.begin() != Fn.end())
3281 return false;
3282
3283 const BasicBlock &EntryBlock = Fn.getEntryBlock();
3284 for (BasicBlock::const_iterator I = EntryBlock.begin(), E = EntryBlock.end();
3285 I != E; ++I) {
3286 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
Anders Carlssonb12caf32011-03-21 14:54:40 +00003287 // Ignore debug intrinsics.
3288 if (isa<DbgInfoIntrinsic>(CI))
3289 continue;
3290
Anders Carlssona201c4c2011-03-20 17:59:11 +00003291 const Function *CalledFn = CI->getCalledFunction();
3292
3293 if (!CalledFn)
3294 return false;
3295
Anders Carlsson807bc2a2011-03-22 03:21:01 +00003296 SmallPtrSet<const Function *, 8> NewCalledFunctions(CalledFunctions);
3297
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00003298 // Don't treat recursive functions as empty.
Anders Carlsson807bc2a2011-03-22 03:21:01 +00003299 if (!NewCalledFunctions.insert(CalledFn))
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00003300 return false;
3301
Anders Carlsson807bc2a2011-03-22 03:21:01 +00003302 if (!cxxDtorIsEmpty(*CalledFn, NewCalledFunctions))
Anders Carlssona201c4c2011-03-20 17:59:11 +00003303 return false;
3304 } else if (isa<ReturnInst>(*I))
Benjamin Kramerd4692742012-02-09 14:26:06 +00003305 return true; // We're done.
3306 else if (I->mayHaveSideEffects())
3307 return false; // Destructor with side effects, bail.
Anders Carlssona201c4c2011-03-20 17:59:11 +00003308 }
3309
3310 return false;
3311}
3312
3313bool GlobalOpt::OptimizeEmptyGlobalCXXDtors(Function *CXAAtExitFn) {
3314 /// Itanium C++ ABI p3.3.5:
3315 ///
3316 /// After constructing a global (or local static) object, that will require
3317 /// destruction on exit, a termination function is registered as follows:
3318 ///
3319 /// extern "C" int __cxa_atexit ( void (*f)(void *), void *p, void *d );
3320 ///
3321 /// This registration, e.g. __cxa_atexit(f,p,d), is intended to cause the
3322 /// call f(p) when DSO d is unloaded, before all such termination calls
3323 /// registered before this one. It returns zero if registration is
Nick Lewycky35ee1c92011-03-21 02:26:01 +00003324 /// successful, nonzero on failure.
Anders Carlssona201c4c2011-03-20 17:59:11 +00003325
3326 // This pass will look for calls to __cxa_atexit where the function is trivial
3327 // and remove them.
3328 bool Changed = false;
3329
Jakub Staszak582088c2012-12-06 21:57:16 +00003330 for (Function::use_iterator I = CXAAtExitFn->use_begin(),
Anders Carlssona201c4c2011-03-20 17:59:11 +00003331 E = CXAAtExitFn->use_end(); I != E;) {
Anders Carlsson4f735ca2011-03-20 20:21:33 +00003332 // We're only interested in calls. Theoretically, we could handle invoke
3333 // instructions as well, but neither llvm-gcc nor clang generate invokes
3334 // to __cxa_atexit.
Anders Carlssonb12caf32011-03-21 14:54:40 +00003335 CallInst *CI = dyn_cast<CallInst>(*I++);
3336 if (!CI)
Anders Carlsson4f735ca2011-03-20 20:21:33 +00003337 continue;
3338
Jakub Staszak582088c2012-12-06 21:57:16 +00003339 Function *DtorFn =
Anders Carlssonb12caf32011-03-21 14:54:40 +00003340 dyn_cast<Function>(CI->getArgOperand(0)->stripPointerCasts());
Anders Carlssona201c4c2011-03-20 17:59:11 +00003341 if (!DtorFn)
3342 continue;
3343
Anders Carlsson372ec6a2011-03-20 20:16:43 +00003344 SmallPtrSet<const Function *, 8> CalledFunctions;
3345 if (!cxxDtorIsEmpty(*DtorFn, CalledFunctions))
Anders Carlssona201c4c2011-03-20 17:59:11 +00003346 continue;
3347
3348 // Just remove the call.
Anders Carlssonb12caf32011-03-21 14:54:40 +00003349 CI->replaceAllUsesWith(Constant::getNullValue(CI->getType()));
3350 CI->eraseFromParent();
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00003351
Anders Carlssona201c4c2011-03-20 17:59:11 +00003352 ++NumCXXDtorsRemoved;
3353
3354 Changed |= true;
3355 }
3356
3357 return Changed;
3358}
3359
Chris Lattner7a90b682004-10-07 04:16:33 +00003360bool GlobalOpt::runOnModule(Module &M) {
Chris Lattner079236d2004-02-25 21:34:36 +00003361 bool Changed = false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00003362
Micah Villmow3574eca2012-10-08 16:38:25 +00003363 TD = getAnalysisIfAvailable<DataLayout>();
Nick Lewycky6a7df9a2012-02-12 02:15:20 +00003364 TLI = &getAnalysis<TargetLibraryInfo>();
Nick Lewycky6a577f82012-02-12 01:13:18 +00003365
Chris Lattnerb1ab4582005-09-26 01:43:45 +00003366 // Try to find the llvm.globalctors list.
3367 GlobalVariable *GlobalCtors = FindGlobalCtors(M);
Chris Lattner7a90b682004-10-07 04:16:33 +00003368
Chris Lattner7a90b682004-10-07 04:16:33 +00003369 bool LocalChange = true;
3370 while (LocalChange) {
3371 LocalChange = false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00003372
Chris Lattnerb1ab4582005-09-26 01:43:45 +00003373 // Delete functions that are trivially dead, ccc -> fastcc
3374 LocalChange |= OptimizeFunctions(M);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00003375
Chris Lattnerb1ab4582005-09-26 01:43:45 +00003376 // Optimize global_ctors list.
3377 if (GlobalCtors)
3378 LocalChange |= OptimizeGlobalCtorsList(GlobalCtors);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00003379
Chris Lattnerb1ab4582005-09-26 01:43:45 +00003380 // Optimize non-address-taken globals.
3381 LocalChange |= OptimizeGlobalVars(M);
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00003382
3383 // Resolve aliases, when possible.
Duncan Sandsfc5940d2009-03-06 10:21:56 +00003384 LocalChange |= OptimizeGlobalAliases(M);
Anders Carlssona201c4c2011-03-20 17:59:11 +00003385
Manman Ren51502702013-05-14 21:52:44 +00003386 // Try to remove trivial global destructors if they are not removed
3387 // already.
3388 Function *CXAAtExitFn = FindCXAAtExit(M, TLI);
Anders Carlssona201c4c2011-03-20 17:59:11 +00003389 if (CXAAtExitFn)
3390 LocalChange |= OptimizeEmptyGlobalCXXDtors(CXAAtExitFn);
3391
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00003392 Changed |= LocalChange;
Chris Lattner7a90b682004-10-07 04:16:33 +00003393 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00003394
Chris Lattnerb1ab4582005-09-26 01:43:45 +00003395 // TODO: Move all global ctors functions to the end of the module for code
3396 // layout.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00003397
Chris Lattner079236d2004-02-25 21:34:36 +00003398 return Changed;
3399}