blob: 4ac721dd0600e350319c20a187f6162e345086b0 [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"
Chris Lattnerfb217ad2005-05-08 22:18:06 +000018#include "llvm/CallingConv.h"
Chris Lattner079236d2004-02-25 21:34:36 +000019#include "llvm/Constants.h"
Chris Lattner7a90b682004-10-07 04:16:33 +000020#include "llvm/DerivedTypes.h"
Chris Lattner7d90a272004-02-27 18:09:25 +000021#include "llvm/Instructions.h"
Chris Lattner35c81b02005-02-27 18:58:52 +000022#include "llvm/IntrinsicInst.h"
Chris Lattner079236d2004-02-25 21:34:36 +000023#include "llvm/Module.h"
Jay Foad562b84b2011-04-11 09:35:34 +000024#include "llvm/Operator.h"
Chris Lattner079236d2004-02-25 21:34:36 +000025#include "llvm/Pass.h"
Chris Lattner79066fa2007-01-30 23:46:24 +000026#include "llvm/Analysis/ConstantFolding.h"
Victor Hernandezf006b182009-10-27 20:05:49 +000027#include "llvm/Analysis/MemoryBuiltins.h"
Chris Lattner30ba5692004-10-11 05:54:41 +000028#include "llvm/Target/TargetData.h"
Duncan Sands548448a2008-02-18 17:32:13 +000029#include "llvm/Support/CallSite.h"
Chris Lattner79066fa2007-01-30 23:46:24 +000030#include "llvm/Support/Debug.h"
Torok Edwinc25e7582009-07-11 20:10:48 +000031#include "llvm/Support/ErrorHandling.h"
Chris Lattner941db492008-01-14 02:09:12 +000032#include "llvm/Support/GetElementPtrTypeIterator.h"
Chris Lattner998182b2008-04-26 07:40:11 +000033#include "llvm/Support/MathExtras.h"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +000034#include "llvm/Support/raw_ostream.h"
Chris Lattner5a6bb6a2008-12-16 07:34:30 +000035#include "llvm/ADT/DenseMap.h"
Chris Lattner81686182007-09-13 16:30:19 +000036#include "llvm/ADT/SmallPtrSet.h"
Chris Lattner55eb1c42007-01-31 04:40:53 +000037#include "llvm/ADT/SmallVector.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000038#include "llvm/ADT/Statistic.h"
Chris Lattnerbce4afe2008-12-17 05:28:49 +000039#include "llvm/ADT/STLExtras.h"
Chris Lattnere47ba742004-10-06 20:57:02 +000040#include <algorithm>
Chris Lattner079236d2004-02-25 21:34:36 +000041using namespace llvm;
42
Chris Lattner86453c52006-12-19 22:09:18 +000043STATISTIC(NumMarked , "Number of globals marked constant");
Rafael Espindolac4440e32011-01-19 16:32:21 +000044STATISTIC(NumUnnamed , "Number of globals marked unnamed_addr");
Chris Lattner86453c52006-12-19 22:09:18 +000045STATISTIC(NumSRA , "Number of aggregate globals broken into scalars");
46STATISTIC(NumHeapSRA , "Number of heap objects SRA'd");
47STATISTIC(NumSubstitute,"Number of globals with initializers stored into them");
48STATISTIC(NumDeleted , "Number of globals deleted");
49STATISTIC(NumFnDeleted , "Number of functions deleted");
50STATISTIC(NumGlobUses , "Number of global uses devirtualized");
51STATISTIC(NumLocalized , "Number of globals localized");
52STATISTIC(NumShrunkToBool , "Number of global vars shrunk to booleans");
53STATISTIC(NumFastCallFns , "Number of functions converted to fastcc");
54STATISTIC(NumCtorsEvaluated, "Number of static ctors evaluated");
Duncan Sands3d5378f2008-02-16 20:56:04 +000055STATISTIC(NumNestRemoved , "Number of nest attributes removed");
Duncan Sands4782b302009-02-15 09:56:08 +000056STATISTIC(NumAliasesResolved, "Number of global aliases resolved");
57STATISTIC(NumAliasesRemoved, "Number of global aliases eliminated");
Anders Carlssona201c4c2011-03-20 17:59:11 +000058STATISTIC(NumCXXDtorsRemoved, "Number of global C++ destructors removed");
Chris Lattner079236d2004-02-25 21:34:36 +000059
Chris Lattner86453c52006-12-19 22:09:18 +000060namespace {
Rafael Espindolac4440e32011-01-19 16:32:21 +000061 struct GlobalStatus;
Nick Lewycky6726b6d2009-10-25 06:33:48 +000062 struct GlobalOpt : public ModulePass {
Chris Lattner30ba5692004-10-11 05:54:41 +000063 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Chris Lattner30ba5692004-10-11 05:54:41 +000064 }
Nick Lewyckyecd94c82007-05-06 13:37:16 +000065 static char ID; // Pass identification, replacement for typeid
Owen Anderson081c34b2010-10-19 17:21:58 +000066 GlobalOpt() : ModulePass(ID) {
67 initializeGlobalOptPass(*PassRegistry::getPassRegistry());
68 }
Misha Brukmanfd939082005-04-21 23:48:37 +000069
Chris Lattnerb12914b2004-09-20 04:48:05 +000070 bool runOnModule(Module &M);
Chris Lattner30ba5692004-10-11 05:54:41 +000071
72 private:
Chris Lattnerb1ab4582005-09-26 01:43:45 +000073 GlobalVariable *FindGlobalCtors(Module &M);
74 bool OptimizeFunctions(Module &M);
75 bool OptimizeGlobalVars(Module &M);
Duncan Sandsfc5940d2009-03-06 10:21:56 +000076 bool OptimizeGlobalAliases(Module &M);
Chris Lattnerb1ab4582005-09-26 01:43:45 +000077 bool OptimizeGlobalCtorsList(GlobalVariable *&GCL);
Rafael Espindolac4440e32011-01-19 16:32:21 +000078 bool ProcessGlobal(GlobalVariable *GV,Module::global_iterator &GVI);
79 bool ProcessInternalGlobal(GlobalVariable *GV,Module::global_iterator &GVI,
80 const SmallPtrSet<const PHINode*, 16> &PHIUsers,
81 const GlobalStatus &GS);
Anders Carlssona201c4c2011-03-20 17:59:11 +000082 bool OptimizeEmptyGlobalCXXDtors(Function *CXAAtExitFn);
Chris Lattner079236d2004-02-25 21:34:36 +000083 };
Chris Lattner079236d2004-02-25 21:34:36 +000084}
85
Dan Gohman844731a2008-05-13 00:00:25 +000086char GlobalOpt::ID = 0;
Owen Andersond13db2c2010-07-21 22:09:45 +000087INITIALIZE_PASS(GlobalOpt, "globalopt",
Owen Andersonce665bd2010-10-07 22:25:06 +000088 "Global Variable Optimizer", false, false)
Dan Gohman844731a2008-05-13 00:00:25 +000089
Chris Lattner7a90b682004-10-07 04:16:33 +000090ModulePass *llvm::createGlobalOptimizerPass() { return new GlobalOpt(); }
Chris Lattner079236d2004-02-25 21:34:36 +000091
Dan Gohman844731a2008-05-13 00:00:25 +000092namespace {
93
Chris Lattner7a90b682004-10-07 04:16:33 +000094/// GlobalStatus - As we analyze each global, keep track of some information
95/// about it. If we find out that the address of the global is taken, none of
Chris Lattnercf4d2a52004-10-07 21:30:30 +000096/// this info will be accurate.
Nick Lewycky6726b6d2009-10-25 06:33:48 +000097struct GlobalStatus {
Rafael Espindolac4440e32011-01-19 16:32:21 +000098 /// isCompared - True if the global's address is used in a comparison.
99 bool isCompared;
100
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000101 /// isLoaded - True if the global is ever loaded. If the global isn't ever
102 /// loaded it can be deleted.
Chris Lattner7a90b682004-10-07 04:16:33 +0000103 bool isLoaded;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000104
105 /// StoredType - Keep track of what stores to the global look like.
106 ///
Chris Lattner7a90b682004-10-07 04:16:33 +0000107 enum StoredType {
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000108 /// NotStored - There is no store to this global. It can thus be marked
109 /// constant.
110 NotStored,
111
112 /// isInitializerStored - This global is stored to, but the only thing
113 /// stored is the constant it was initialized with. This is only tracked
114 /// for scalar globals.
115 isInitializerStored,
116
117 /// isStoredOnce - This global is stored to, but only its initializer and
118 /// one other value is ever stored to it. If this global isStoredOnce, we
119 /// track the value stored to it in StoredOnceValue below. This is only
120 /// tracked for scalar globals.
121 isStoredOnce,
122
123 /// isStored - This global is stored to by multiple values or something else
124 /// that we cannot track.
125 isStored
Chris Lattner7a90b682004-10-07 04:16:33 +0000126 } StoredType;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000127
128 /// StoredOnceValue - If only one value (besides the initializer constant) is
129 /// ever stored to this global, keep track of what value it is.
130 Value *StoredOnceValue;
131
Chris Lattner25de4e52006-11-01 18:03:33 +0000132 /// AccessingFunction/HasMultipleAccessingFunctions - These start out
133 /// null/false. When the first accessing function is noticed, it is recorded.
134 /// When a second different accessing function is noticed,
135 /// HasMultipleAccessingFunctions is set to true.
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000136 const Function *AccessingFunction;
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +0000137 bool HasMultipleAccessingFunctions;
138
Chris Lattner25de4e52006-11-01 18:03:33 +0000139 /// HasNonInstructionUser - Set to true if this global has a user that is not
140 /// an instruction (e.g. a constant expr or GV initializer).
Chris Lattner553ca522005-06-15 21:11:48 +0000141 bool HasNonInstructionUser;
142
Chris Lattner25de4e52006-11-01 18:03:33 +0000143 /// HasPHIUser - Set to true if this global has a user that is a PHI node.
144 bool HasPHIUser;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000145
Rafael Espindolac4440e32011-01-19 16:32:21 +0000146 GlobalStatus() : isCompared(false), isLoaded(false), StoredType(NotStored),
147 StoredOnceValue(0), AccessingFunction(0),
148 HasMultipleAccessingFunctions(false), HasNonInstructionUser(false),
149 HasPHIUser(false) {}
Chris Lattner7a90b682004-10-07 04:16:33 +0000150};
Chris Lattnere47ba742004-10-06 20:57:02 +0000151
Dan Gohman844731a2008-05-13 00:00:25 +0000152}
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000153
Jay Foade3acf152009-06-09 21:37:11 +0000154// SafeToDestroyConstant - It is safe to destroy a constant iff it is only used
155// by constants itself. Note that constants cannot be cyclic, so this test is
156// pretty easy to implement recursively.
157//
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000158static bool SafeToDestroyConstant(const Constant *C) {
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000159 if (isa<GlobalValue>(C)) return false;
160
Gabor Greif27236912010-04-07 18:59:26 +0000161 for (Value::const_use_iterator UI = C->use_begin(), E = C->use_end(); UI != E;
162 ++UI)
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000163 if (const Constant *CU = dyn_cast<Constant>(*UI)) {
Jay Foade3acf152009-06-09 21:37:11 +0000164 if (!SafeToDestroyConstant(CU)) return false;
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000165 } else
166 return false;
167 return true;
168}
169
170
Chris Lattner7a90b682004-10-07 04:16:33 +0000171/// AnalyzeGlobal - Look at all uses of the global and fill in the GlobalStatus
172/// structure. If the global has its address taken, return true to indicate we
173/// can't do anything with it.
Chris Lattner079236d2004-02-25 21:34:36 +0000174///
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000175static bool AnalyzeGlobal(const Value *V, GlobalStatus &GS,
176 SmallPtrSet<const PHINode*, 16> &PHIUsers) {
Gabor Greif27236912010-04-07 18:59:26 +0000177 for (Value::const_use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;
Gabor Greife6642672010-07-09 16:51:20 +0000178 ++UI) {
179 const User *U = *UI;
180 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
Chris Lattner553ca522005-06-15 21:11:48 +0000181 GS.HasNonInstructionUser = true;
Chris Lattnerd91ed102011-01-01 22:31:46 +0000182
183 // If the result of the constantexpr isn't pointer type, then we won't
184 // know to expect it in various places. Just reject early.
185 if (!isa<PointerType>(CE->getType())) return true;
186
Chris Lattner7a90b682004-10-07 04:16:33 +0000187 if (AnalyzeGlobal(CE, GS, PHIUsers)) return true;
Gabor Greife6642672010-07-09 16:51:20 +0000188 } else if (const Instruction *I = dyn_cast<Instruction>(U)) {
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +0000189 if (!GS.HasMultipleAccessingFunctions) {
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000190 const Function *F = I->getParent()->getParent();
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +0000191 if (GS.AccessingFunction == 0)
192 GS.AccessingFunction = F;
193 else if (GS.AccessingFunction != F)
194 GS.HasMultipleAccessingFunctions = true;
195 }
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000196 if (const LoadInst *LI = dyn_cast<LoadInst>(I)) {
Chris Lattner7a90b682004-10-07 04:16:33 +0000197 GS.isLoaded = true;
Chris Lattnerc69d3c92008-01-29 19:01:37 +0000198 if (LI->isVolatile()) return true; // Don't hack on volatile loads.
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000199 } else if (const StoreInst *SI = dyn_cast<StoreInst>(I)) {
Chris Lattner36025492004-10-07 06:01:25 +0000200 // Don't allow a store OF the address, only stores TO the address.
201 if (SI->getOperand(0) == V) return true;
202
Chris Lattnerc69d3c92008-01-29 19:01:37 +0000203 if (SI->isVolatile()) return true; // Don't hack on volatile stores.
204
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000205 // If this is a direct store to the global (i.e., the global is a scalar
206 // value, not an aggregate), keep more specific information about
207 // stores.
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000208 if (GS.StoredType != GlobalStatus::isStored) {
Gabor Greif27236912010-04-07 18:59:26 +0000209 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(
210 SI->getOperand(1))) {
Chris Lattnerbd38edf2004-11-14 20:50:30 +0000211 Value *StoredVal = SI->getOperand(0);
212 if (StoredVal == GV->getInitializer()) {
213 if (GS.StoredType < GlobalStatus::isInitializerStored)
214 GS.StoredType = GlobalStatus::isInitializerStored;
215 } else if (isa<LoadInst>(StoredVal) &&
216 cast<LoadInst>(StoredVal)->getOperand(0) == GV) {
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000217 if (GS.StoredType < GlobalStatus::isInitializerStored)
218 GS.StoredType = GlobalStatus::isInitializerStored;
219 } else if (GS.StoredType < GlobalStatus::isStoredOnce) {
220 GS.StoredType = GlobalStatus::isStoredOnce;
Chris Lattnerbd38edf2004-11-14 20:50:30 +0000221 GS.StoredOnceValue = StoredVal;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000222 } else if (GS.StoredType == GlobalStatus::isStoredOnce &&
Chris Lattnerbd38edf2004-11-14 20:50:30 +0000223 GS.StoredOnceValue == StoredVal) {
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000224 // noop.
225 } else {
226 GS.StoredType = GlobalStatus::isStored;
227 }
228 } else {
Chris Lattner7a90b682004-10-07 04:16:33 +0000229 GS.StoredType = GlobalStatus::isStored;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000230 }
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000231 }
Chris Lattner35c81b02005-02-27 18:58:52 +0000232 } else if (isa<GetElementPtrInst>(I)) {
Chris Lattner7a90b682004-10-07 04:16:33 +0000233 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Chris Lattner35c81b02005-02-27 18:58:52 +0000234 } else if (isa<SelectInst>(I)) {
Chris Lattner7a90b682004-10-07 04:16:33 +0000235 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000236 } else if (const PHINode *PN = dyn_cast<PHINode>(I)) {
Chris Lattner7a90b682004-10-07 04:16:33 +0000237 // PHI nodes we can check just like select or GEP instructions, but we
238 // have to be careful about infinite recursion.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +0000239 if (PHIUsers.insert(PN)) // Not already visited.
Chris Lattner7a90b682004-10-07 04:16:33 +0000240 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Chris Lattner25de4e52006-11-01 18:03:33 +0000241 GS.HasPHIUser = true;
Reid Spencere4d87aa2006-12-23 06:05:41 +0000242 } else if (isa<CmpInst>(I)) {
Rafael Espindolac4440e32011-01-19 16:32:21 +0000243 GS.isCompared = true;
Nick Lewycky1f237b02011-05-29 18:41:56 +0000244 } else if (const MemTransferInst *MTI = dyn_cast<MemTransferInst>(I)) {
245 if (MTI->isVolatile()) return true;
Gabor Greif9e4f2432010-06-24 14:42:01 +0000246 if (MTI->getArgOperand(0) == V)
Eric Christopher551754c2010-04-16 23:37:20 +0000247 GS.StoredType = GlobalStatus::isStored;
Gabor Greif9e4f2432010-06-24 14:42:01 +0000248 if (MTI->getArgOperand(1) == V)
Chris Lattner35c81b02005-02-27 18:58:52 +0000249 GS.isLoaded = true;
Nick Lewycky1f237b02011-05-29 18:41:56 +0000250 } else if (const MemSetInst *MSI = dyn_cast<MemSetInst>(I)) {
251 assert(MSI->getArgOperand(0) == V && "Memset only takes one pointer!");
252 if (MSI->isVolatile()) return true;
Chris Lattner35c81b02005-02-27 18:58:52 +0000253 GS.StoredType = GlobalStatus::isStored;
Chris Lattner7a90b682004-10-07 04:16:33 +0000254 } else {
255 return true; // Any other non-load instruction might take address!
Chris Lattner9ce30002004-07-20 03:58:07 +0000256 }
Gabor Greife6642672010-07-09 16:51:20 +0000257 } else if (const Constant *C = dyn_cast<Constant>(U)) {
Chris Lattner553ca522005-06-15 21:11:48 +0000258 GS.HasNonInstructionUser = true;
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000259 // We might have a dead and dangling constant hanging off of here.
Jay Foade3acf152009-06-09 21:37:11 +0000260 if (!SafeToDestroyConstant(C))
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000261 return true;
Chris Lattner079236d2004-02-25 21:34:36 +0000262 } else {
Chris Lattner553ca522005-06-15 21:11:48 +0000263 GS.HasNonInstructionUser = true;
264 // Otherwise must be some other user.
Chris Lattner079236d2004-02-25 21:34:36 +0000265 return true;
266 }
Gabor Greife6642672010-07-09 16:51:20 +0000267 }
Chris Lattner079236d2004-02-25 21:34:36 +0000268
269 return false;
270}
271
Chris Lattner7b550cc2009-11-06 04:27:31 +0000272static Constant *getAggregateConstantElement(Constant *Agg, Constant *Idx) {
Chris Lattner670c8892004-10-08 17:32:09 +0000273 ConstantInt *CI = dyn_cast<ConstantInt>(Idx);
274 if (!CI) return 0;
Reid Spencerb83eb642006-10-20 07:07:24 +0000275 unsigned IdxV = CI->getZExtValue();
Chris Lattner7a90b682004-10-07 04:16:33 +0000276
Chris Lattner670c8892004-10-08 17:32:09 +0000277 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Agg)) {
278 if (IdxV < CS->getNumOperands()) return CS->getOperand(IdxV);
279 } else if (ConstantArray *CA = dyn_cast<ConstantArray>(Agg)) {
280 if (IdxV < CA->getNumOperands()) return CA->getOperand(IdxV);
Reid Spencer9d6565a2007-02-15 02:26:10 +0000281 } else if (ConstantVector *CP = dyn_cast<ConstantVector>(Agg)) {
Chris Lattner670c8892004-10-08 17:32:09 +0000282 if (IdxV < CP->getNumOperands()) return CP->getOperand(IdxV);
Chris Lattner7a7ed022004-10-16 18:09:00 +0000283 } else if (isa<ConstantAggregateZero>(Agg)) {
Chris Lattner670c8892004-10-08 17:32:09 +0000284 if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
285 if (IdxV < STy->getNumElements())
Owen Andersona7235ea2009-07-31 20:28:14 +0000286 return Constant::getNullValue(STy->getElementType(IdxV));
Chris Lattner670c8892004-10-08 17:32:09 +0000287 } else if (const SequentialType *STy =
288 dyn_cast<SequentialType>(Agg->getType())) {
Owen Andersona7235ea2009-07-31 20:28:14 +0000289 return Constant::getNullValue(STy->getElementType());
Chris Lattner670c8892004-10-08 17:32:09 +0000290 }
Chris Lattner7a7ed022004-10-16 18:09:00 +0000291 } else if (isa<UndefValue>(Agg)) {
292 if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
293 if (IdxV < STy->getNumElements())
Owen Anderson9e9a0d52009-07-30 23:03:37 +0000294 return UndefValue::get(STy->getElementType(IdxV));
Chris Lattner7a7ed022004-10-16 18:09:00 +0000295 } else if (const SequentialType *STy =
296 dyn_cast<SequentialType>(Agg->getType())) {
Owen Anderson9e9a0d52009-07-30 23:03:37 +0000297 return UndefValue::get(STy->getElementType());
Chris Lattner7a7ed022004-10-16 18:09:00 +0000298 }
Chris Lattner670c8892004-10-08 17:32:09 +0000299 }
300 return 0;
301}
Chris Lattner7a90b682004-10-07 04:16:33 +0000302
Chris Lattner7a90b682004-10-07 04:16:33 +0000303
Chris Lattnere47ba742004-10-06 20:57:02 +0000304/// CleanupConstantGlobalUsers - We just marked GV constant. Loop over all
305/// users of the global, cleaning up the obvious ones. This is largely just a
Chris Lattner031955d2004-10-10 16:43:46 +0000306/// quick scan over the use list to clean up the easy and obvious cruft. This
307/// returns true if it made a change.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000308static bool CleanupConstantGlobalUsers(Value *V, Constant *Init) {
Chris Lattner031955d2004-10-10 16:43:46 +0000309 bool Changed = false;
Chris Lattner7a90b682004-10-07 04:16:33 +0000310 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;) {
311 User *U = *UI++;
Misha Brukmanfd939082005-04-21 23:48:37 +0000312
Chris Lattner7a90b682004-10-07 04:16:33 +0000313 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner35c81b02005-02-27 18:58:52 +0000314 if (Init) {
315 // Replace the load with the initializer.
316 LI->replaceAllUsesWith(Init);
317 LI->eraseFromParent();
318 Changed = true;
319 }
Chris Lattner7a90b682004-10-07 04:16:33 +0000320 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnere47ba742004-10-06 20:57:02 +0000321 // Store must be unreachable or storing Init into the global.
Chris Lattner7a7ed022004-10-16 18:09:00 +0000322 SI->eraseFromParent();
Chris Lattner031955d2004-10-10 16:43:46 +0000323 Changed = true;
Chris Lattner7a90b682004-10-07 04:16:33 +0000324 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
325 if (CE->getOpcode() == Instruction::GetElementPtr) {
Chris Lattneraae4a1c2005-09-26 07:34:35 +0000326 Constant *SubInit = 0;
327 if (Init)
Dan Gohmanc6f69e92009-10-05 16:36:26 +0000328 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Chris Lattner7b550cc2009-11-06 04:27:31 +0000329 Changed |= CleanupConstantGlobalUsers(CE, SubInit);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000330 } else if (CE->getOpcode() == Instruction::BitCast &&
Duncan Sands1df98592010-02-16 11:11:14 +0000331 CE->getType()->isPointerTy()) {
Chris Lattner35c81b02005-02-27 18:58:52 +0000332 // Pointer cast, delete any stores and memsets to the global.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000333 Changed |= CleanupConstantGlobalUsers(CE, 0);
Chris Lattner35c81b02005-02-27 18:58:52 +0000334 }
335
336 if (CE->use_empty()) {
337 CE->destroyConstant();
338 Changed = true;
Chris Lattner7a90b682004-10-07 04:16:33 +0000339 }
340 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner7b52fe72007-11-09 17:33:02 +0000341 // Do not transform "gepinst (gep constexpr (GV))" here, because forming
342 // "gepconstexpr (gep constexpr (GV))" will cause the two gep's to fold
343 // and will invalidate our notion of what Init is.
Chris Lattner19450242007-11-13 21:46:23 +0000344 Constant *SubInit = 0;
Chris Lattner7b52fe72007-11-09 17:33:02 +0000345 if (!isa<ConstantExpr>(GEP->getOperand(0))) {
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000346 ConstantExpr *CE =
Chris Lattner7b550cc2009-11-06 04:27:31 +0000347 dyn_cast_or_null<ConstantExpr>(ConstantFoldInstruction(GEP));
Chris Lattner7b52fe72007-11-09 17:33:02 +0000348 if (Init && CE && CE->getOpcode() == Instruction::GetElementPtr)
Dan Gohmanc6f69e92009-10-05 16:36:26 +0000349 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Chris Lattner7b52fe72007-11-09 17:33:02 +0000350 }
Chris Lattner7b550cc2009-11-06 04:27:31 +0000351 Changed |= CleanupConstantGlobalUsers(GEP, SubInit);
Chris Lattnerc4d81b02004-10-10 16:47:33 +0000352
Chris Lattner031955d2004-10-10 16:43:46 +0000353 if (GEP->use_empty()) {
Chris Lattner7a7ed022004-10-16 18:09:00 +0000354 GEP->eraseFromParent();
Chris Lattner031955d2004-10-10 16:43:46 +0000355 Changed = true;
356 }
Chris Lattner35c81b02005-02-27 18:58:52 +0000357 } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(U)) { // memset/cpy/mv
358 if (MI->getRawDest() == V) {
359 MI->eraseFromParent();
360 Changed = true;
361 }
362
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000363 } else if (Constant *C = dyn_cast<Constant>(U)) {
364 // If we have a chain of dead constantexprs or other things dangling from
365 // us, and if they are all dead, nuke them without remorse.
Jay Foade3acf152009-06-09 21:37:11 +0000366 if (SafeToDestroyConstant(C)) {
Devang Patel743cdf82009-03-06 01:37:41 +0000367 C->destroyConstant();
Chris Lattner35c81b02005-02-27 18:58:52 +0000368 // This could have invalidated UI, start over from scratch.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000369 CleanupConstantGlobalUsers(V, Init);
Chris Lattner031955d2004-10-10 16:43:46 +0000370 return true;
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000371 }
Chris Lattnere47ba742004-10-06 20:57:02 +0000372 }
373 }
Chris Lattner031955d2004-10-10 16:43:46 +0000374 return Changed;
Chris Lattnere47ba742004-10-06 20:57:02 +0000375}
376
Chris Lattner941db492008-01-14 02:09:12 +0000377/// isSafeSROAElementUse - Return true if the specified instruction is a safe
378/// user of a derived expression from a global that we want to SROA.
379static bool isSafeSROAElementUse(Value *V) {
380 // We might have a dead and dangling constant hanging off of here.
381 if (Constant *C = dyn_cast<Constant>(V))
Jay Foade3acf152009-06-09 21:37:11 +0000382 return SafeToDestroyConstant(C);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000383
Chris Lattner941db492008-01-14 02:09:12 +0000384 Instruction *I = dyn_cast<Instruction>(V);
385 if (!I) return false;
386
387 // Loads are ok.
388 if (isa<LoadInst>(I)) return true;
389
390 // Stores *to* the pointer are ok.
391 if (StoreInst *SI = dyn_cast<StoreInst>(I))
392 return SI->getOperand(0) != V;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000393
Chris Lattner941db492008-01-14 02:09:12 +0000394 // Otherwise, it must be a GEP.
395 GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I);
396 if (GEPI == 0) return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000397
Chris Lattner941db492008-01-14 02:09:12 +0000398 if (GEPI->getNumOperands() < 3 || !isa<Constant>(GEPI->getOperand(1)) ||
399 !cast<Constant>(GEPI->getOperand(1))->isNullValue())
400 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000401
Chris Lattner941db492008-01-14 02:09:12 +0000402 for (Value::use_iterator I = GEPI->use_begin(), E = GEPI->use_end();
403 I != E; ++I)
404 if (!isSafeSROAElementUse(*I))
405 return false;
Chris Lattner727c2102008-01-14 01:31:05 +0000406 return true;
407}
408
Chris Lattner941db492008-01-14 02:09:12 +0000409
410/// IsUserOfGlobalSafeForSRA - U is a direct user of the specified global value.
411/// Look at it and its uses and decide whether it is safe to SROA this global.
412///
413static bool IsUserOfGlobalSafeForSRA(User *U, GlobalValue *GV) {
414 // The user of the global must be a GEP Inst or a ConstantExpr GEP.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000415 if (!isa<GetElementPtrInst>(U) &&
416 (!isa<ConstantExpr>(U) ||
Chris Lattner941db492008-01-14 02:09:12 +0000417 cast<ConstantExpr>(U)->getOpcode() != Instruction::GetElementPtr))
418 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000419
Chris Lattner941db492008-01-14 02:09:12 +0000420 // Check to see if this ConstantExpr GEP is SRA'able. In particular, we
421 // don't like < 3 operand CE's, and we don't like non-constant integer
422 // indices. This enforces that all uses are 'gep GV, 0, C, ...' for some
423 // value of C.
424 if (U->getNumOperands() < 3 || !isa<Constant>(U->getOperand(1)) ||
425 !cast<Constant>(U->getOperand(1))->isNullValue() ||
426 !isa<ConstantInt>(U->getOperand(2)))
427 return false;
428
429 gep_type_iterator GEPI = gep_type_begin(U), E = gep_type_end(U);
430 ++GEPI; // Skip over the pointer index.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000431
Chris Lattner941db492008-01-14 02:09:12 +0000432 // If this is a use of an array allocation, do a bit more checking for sanity.
433 if (const ArrayType *AT = dyn_cast<ArrayType>(*GEPI)) {
434 uint64_t NumElements = AT->getNumElements();
435 ConstantInt *Idx = cast<ConstantInt>(U->getOperand(2));
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000436
Chris Lattner941db492008-01-14 02:09:12 +0000437 // Check to make sure that index falls within the array. If not,
438 // something funny is going on, so we won't do the optimization.
439 //
440 if (Idx->getZExtValue() >= NumElements)
441 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000442
Chris Lattner941db492008-01-14 02:09:12 +0000443 // We cannot scalar repl this level of the array unless any array
444 // sub-indices are in-range constants. In particular, consider:
445 // A[0][i]. We cannot know that the user isn't doing invalid things like
446 // allowing i to index an out-of-range subscript that accesses A[1].
447 //
448 // Scalar replacing *just* the outer index of the array is probably not
449 // going to be a win anyway, so just give up.
450 for (++GEPI; // Skip array index.
Dan Gohman6874a2a2009-08-18 14:58:19 +0000451 GEPI != E;
Chris Lattner941db492008-01-14 02:09:12 +0000452 ++GEPI) {
453 uint64_t NumElements;
454 if (const ArrayType *SubArrayTy = dyn_cast<ArrayType>(*GEPI))
455 NumElements = SubArrayTy->getNumElements();
Dan Gohman6874a2a2009-08-18 14:58:19 +0000456 else if (const VectorType *SubVectorTy = dyn_cast<VectorType>(*GEPI))
457 NumElements = SubVectorTy->getNumElements();
458 else {
Duncan Sands1df98592010-02-16 11:11:14 +0000459 assert((*GEPI)->isStructTy() &&
Dan Gohman6874a2a2009-08-18 14:58:19 +0000460 "Indexed GEP type is not array, vector, or struct!");
461 continue;
462 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000463
Chris Lattner941db492008-01-14 02:09:12 +0000464 ConstantInt *IdxVal = dyn_cast<ConstantInt>(GEPI.getOperand());
465 if (!IdxVal || IdxVal->getZExtValue() >= NumElements)
466 return false;
467 }
468 }
469
470 for (Value::use_iterator I = U->use_begin(), E = U->use_end(); I != E; ++I)
471 if (!isSafeSROAElementUse(*I))
472 return false;
473 return true;
474}
475
476/// GlobalUsersSafeToSRA - Look at all uses of the global and decide whether it
477/// is safe for us to perform this transformation.
478///
479static bool GlobalUsersSafeToSRA(GlobalValue *GV) {
480 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end();
481 UI != E; ++UI) {
482 if (!IsUserOfGlobalSafeForSRA(*UI, GV))
483 return false;
484 }
485 return true;
486}
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000487
Chris Lattner941db492008-01-14 02:09:12 +0000488
Chris Lattner670c8892004-10-08 17:32:09 +0000489/// SRAGlobal - Perform scalar replacement of aggregates on the specified global
490/// variable. This opens the door for other optimizations by exposing the
491/// behavior of the program in a more fine-grained way. We have determined that
492/// this transformation is safe already. We return the first global variable we
493/// insert so that the caller can reprocess it.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000494static GlobalVariable *SRAGlobal(GlobalVariable *GV, const TargetData &TD) {
Chris Lattner727c2102008-01-14 01:31:05 +0000495 // Make sure this global only has simple uses that we can SRA.
Chris Lattner941db492008-01-14 02:09:12 +0000496 if (!GlobalUsersSafeToSRA(GV))
Chris Lattner727c2102008-01-14 01:31:05 +0000497 return 0;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000498
Rafael Espindolabb46f522009-01-15 20:18:42 +0000499 assert(GV->hasLocalLinkage() && !GV->isConstant());
Chris Lattner670c8892004-10-08 17:32:09 +0000500 Constant *Init = GV->getInitializer();
501 const Type *Ty = Init->getType();
Misha Brukmanfd939082005-04-21 23:48:37 +0000502
Chris Lattner670c8892004-10-08 17:32:09 +0000503 std::vector<GlobalVariable*> NewGlobals;
504 Module::GlobalListType &Globals = GV->getParent()->getGlobalList();
505
Chris Lattner998182b2008-04-26 07:40:11 +0000506 // Get the alignment of the global, either explicit or target-specific.
507 unsigned StartAlignment = GV->getAlignment();
508 if (StartAlignment == 0)
509 StartAlignment = TD.getABITypeAlignment(GV->getType());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000510
Chris Lattner670c8892004-10-08 17:32:09 +0000511 if (const StructType *STy = dyn_cast<StructType>(Ty)) {
512 NewGlobals.reserve(STy->getNumElements());
Chris Lattner998182b2008-04-26 07:40:11 +0000513 const StructLayout &Layout = *TD.getStructLayout(STy);
Chris Lattner670c8892004-10-08 17:32:09 +0000514 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
515 Constant *In = getAggregateConstantElement(Init,
Chris Lattner7b550cc2009-11-06 04:27:31 +0000516 ConstantInt::get(Type::getInt32Ty(STy->getContext()), i));
Chris Lattner670c8892004-10-08 17:32:09 +0000517 assert(In && "Couldn't get element of initializer?");
Chris Lattner7b550cc2009-11-06 04:27:31 +0000518 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(i), false,
Chris Lattner670c8892004-10-08 17:32:09 +0000519 GlobalVariable::InternalLinkage,
Daniel Dunbarfe09b202009-07-30 17:37:43 +0000520 In, GV->getName()+"."+Twine(i),
Matthijs Kooijmanbc1f9892008-07-17 11:59:53 +0000521 GV->isThreadLocal(),
Owen Anderson3d29df32009-07-08 01:26:06 +0000522 GV->getType()->getAddressSpace());
Chris Lattner670c8892004-10-08 17:32:09 +0000523 Globals.insert(GV, NGV);
524 NewGlobals.push_back(NGV);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000525
Chris Lattner998182b2008-04-26 07:40:11 +0000526 // Calculate the known alignment of the field. If the original aggregate
527 // had 256 byte alignment for example, something might depend on that:
528 // propagate info to each field.
529 uint64_t FieldOffset = Layout.getElementOffset(i);
530 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, FieldOffset);
531 if (NewAlign > TD.getABITypeAlignment(STy->getElementType(i)))
532 NGV->setAlignment(NewAlign);
Chris Lattner670c8892004-10-08 17:32:09 +0000533 }
534 } else if (const SequentialType *STy = dyn_cast<SequentialType>(Ty)) {
535 unsigned NumElements = 0;
536 if (const ArrayType *ATy = dyn_cast<ArrayType>(STy))
537 NumElements = ATy->getNumElements();
Chris Lattner670c8892004-10-08 17:32:09 +0000538 else
Chris Lattner998182b2008-04-26 07:40:11 +0000539 NumElements = cast<VectorType>(STy)->getNumElements();
Chris Lattner670c8892004-10-08 17:32:09 +0000540
Chris Lattner1f21ef12005-02-23 16:53:04 +0000541 if (NumElements > 16 && GV->hasNUsesOrMore(16))
Chris Lattnerd514d822005-02-01 01:23:31 +0000542 return 0; // It's not worth it.
Chris Lattner670c8892004-10-08 17:32:09 +0000543 NewGlobals.reserve(NumElements);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000544
Duncan Sands777d2302009-05-09 07:06:46 +0000545 uint64_t EltSize = TD.getTypeAllocSize(STy->getElementType());
Chris Lattner998182b2008-04-26 07:40:11 +0000546 unsigned EltAlign = TD.getABITypeAlignment(STy->getElementType());
Chris Lattner670c8892004-10-08 17:32:09 +0000547 for (unsigned i = 0, e = NumElements; i != e; ++i) {
548 Constant *In = getAggregateConstantElement(Init,
Chris Lattner7b550cc2009-11-06 04:27:31 +0000549 ConstantInt::get(Type::getInt32Ty(Init->getContext()), i));
Chris Lattner670c8892004-10-08 17:32:09 +0000550 assert(In && "Couldn't get element of initializer?");
551
Chris Lattner7b550cc2009-11-06 04:27:31 +0000552 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(), false,
Chris Lattner670c8892004-10-08 17:32:09 +0000553 GlobalVariable::InternalLinkage,
Daniel Dunbarfe09b202009-07-30 17:37:43 +0000554 In, GV->getName()+"."+Twine(i),
Matthijs Kooijmanbc1f9892008-07-17 11:59:53 +0000555 GV->isThreadLocal(),
Owen Andersone9b11b42009-07-08 19:03:57 +0000556 GV->getType()->getAddressSpace());
Chris Lattner670c8892004-10-08 17:32:09 +0000557 Globals.insert(GV, NGV);
558 NewGlobals.push_back(NGV);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000559
Chris Lattner998182b2008-04-26 07:40:11 +0000560 // Calculate the known alignment of the field. If the original aggregate
561 // had 256 byte alignment for example, something might depend on that:
562 // propagate info to each field.
563 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, EltSize*i);
564 if (NewAlign > EltAlign)
565 NGV->setAlignment(NewAlign);
Chris Lattner670c8892004-10-08 17:32:09 +0000566 }
567 }
568
569 if (NewGlobals.empty())
570 return 0;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000571
David Greene3215b0e2010-01-05 01:28:05 +0000572 DEBUG(dbgs() << "PERFORMING GLOBAL SRA ON: " << *GV);
Chris Lattner30ba5692004-10-11 05:54:41 +0000573
Chris Lattner7b550cc2009-11-06 04:27:31 +0000574 Constant *NullInt =Constant::getNullValue(Type::getInt32Ty(GV->getContext()));
Chris Lattner670c8892004-10-08 17:32:09 +0000575
576 // Loop over all of the uses of the global, replacing the constantexpr geps,
577 // with smaller constantexpr geps or direct references.
578 while (!GV->use_empty()) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000579 User *GEP = GV->use_back();
580 assert(((isa<ConstantExpr>(GEP) &&
581 cast<ConstantExpr>(GEP)->getOpcode()==Instruction::GetElementPtr)||
582 isa<GetElementPtrInst>(GEP)) && "NonGEP CE's are not SRAable!");
Misha Brukmanfd939082005-04-21 23:48:37 +0000583
Chris Lattner670c8892004-10-08 17:32:09 +0000584 // Ignore the 1th operand, which has to be zero or else the program is quite
585 // broken (undefined). Get the 2nd operand, which is the structure or array
586 // index.
Reid Spencerb83eb642006-10-20 07:07:24 +0000587 unsigned Val = cast<ConstantInt>(GEP->getOperand(2))->getZExtValue();
Chris Lattner670c8892004-10-08 17:32:09 +0000588 if (Val >= NewGlobals.size()) Val = 0; // Out of bound array access.
589
Chris Lattner30ba5692004-10-11 05:54:41 +0000590 Value *NewPtr = NewGlobals[Val];
Chris Lattner670c8892004-10-08 17:32:09 +0000591
592 // Form a shorter GEP if needed.
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000593 if (GEP->getNumOperands() > 3) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000594 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEP)) {
Chris Lattner55eb1c42007-01-31 04:40:53 +0000595 SmallVector<Constant*, 8> Idxs;
Chris Lattner30ba5692004-10-11 05:54:41 +0000596 Idxs.push_back(NullInt);
597 for (unsigned i = 3, e = CE->getNumOperands(); i != e; ++i)
598 Idxs.push_back(CE->getOperand(i));
Owen Andersonbaf3c402009-07-29 18:55:55 +0000599 NewPtr = ConstantExpr::getGetElementPtr(cast<Constant>(NewPtr),
Chris Lattner55eb1c42007-01-31 04:40:53 +0000600 &Idxs[0], Idxs.size());
Chris Lattner30ba5692004-10-11 05:54:41 +0000601 } else {
602 GetElementPtrInst *GEPI = cast<GetElementPtrInst>(GEP);
Chris Lattner699d1442007-01-31 19:59:55 +0000603 SmallVector<Value*, 8> Idxs;
Chris Lattner30ba5692004-10-11 05:54:41 +0000604 Idxs.push_back(NullInt);
605 for (unsigned i = 3, e = GEPI->getNumOperands(); i != e; ++i)
606 Idxs.push_back(GEPI->getOperand(i));
Gabor Greif051a9502008-04-06 20:25:17 +0000607 NewPtr = GetElementPtrInst::Create(NewPtr, Idxs.begin(), Idxs.end(),
Daniel Dunbarfe09b202009-07-30 17:37:43 +0000608 GEPI->getName()+"."+Twine(Val),GEPI);
Chris Lattner30ba5692004-10-11 05:54:41 +0000609 }
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000610 }
Chris Lattner30ba5692004-10-11 05:54:41 +0000611 GEP->replaceAllUsesWith(NewPtr);
612
613 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(GEP))
Chris Lattner7a7ed022004-10-16 18:09:00 +0000614 GEPI->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000615 else
616 cast<ConstantExpr>(GEP)->destroyConstant();
Chris Lattner670c8892004-10-08 17:32:09 +0000617 }
618
Chris Lattnere40e2d12004-10-08 20:25:55 +0000619 // Delete the old global, now that it is dead.
620 Globals.erase(GV);
Chris Lattner670c8892004-10-08 17:32:09 +0000621 ++NumSRA;
Chris Lattner30ba5692004-10-11 05:54:41 +0000622
623 // Loop over the new globals array deleting any globals that are obviously
624 // dead. This can arise due to scalarization of a structure or an array that
625 // has elements that are dead.
626 unsigned FirstGlobal = 0;
627 for (unsigned i = 0, e = NewGlobals.size(); i != e; ++i)
628 if (NewGlobals[i]->use_empty()) {
629 Globals.erase(NewGlobals[i]);
630 if (FirstGlobal == i) ++FirstGlobal;
631 }
632
633 return FirstGlobal != NewGlobals.size() ? NewGlobals[FirstGlobal] : 0;
Chris Lattner670c8892004-10-08 17:32:09 +0000634}
635
Chris Lattner9b34a612004-10-09 21:48:45 +0000636/// AllUsesOfValueWillTrapIfNull - Return true if all users of the specified
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000637/// value will trap if the value is dynamically null. PHIs keeps track of any
Chris Lattner81686182007-09-13 16:30:19 +0000638/// phi nodes we've seen to avoid reprocessing them.
Gabor Greif6ce02b52010-04-06 19:24:18 +0000639static bool AllUsesOfValueWillTrapIfNull(const Value *V,
640 SmallPtrSet<const PHINode*, 8> &PHIs) {
641 for (Value::const_use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000642 ++UI) {
Gabor Greif6ce02b52010-04-06 19:24:18 +0000643 const User *U = *UI;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000644
645 if (isa<LoadInst>(U)) {
Chris Lattner9b34a612004-10-09 21:48:45 +0000646 // Will trap.
Gabor Greif6ce02b52010-04-06 19:24:18 +0000647 } else if (const StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattner9b34a612004-10-09 21:48:45 +0000648 if (SI->getOperand(0) == V) {
Gabor Greifa01d6db2010-04-06 19:14:05 +0000649 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000650 return false; // Storing the value.
651 }
Gabor Greif6ce02b52010-04-06 19:24:18 +0000652 } else if (const CallInst *CI = dyn_cast<CallInst>(U)) {
Gabor Greif654c06f2010-03-20 21:00:25 +0000653 if (CI->getCalledValue() != V) {
Gabor Greifa01d6db2010-04-06 19:14:05 +0000654 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000655 return false; // Not calling the ptr
656 }
Gabor Greif6ce02b52010-04-06 19:24:18 +0000657 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(U)) {
Gabor Greif654c06f2010-03-20 21:00:25 +0000658 if (II->getCalledValue() != V) {
Gabor Greifa01d6db2010-04-06 19:14:05 +0000659 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000660 return false; // Not calling the ptr
661 }
Gabor Greif6ce02b52010-04-06 19:24:18 +0000662 } else if (const BitCastInst *CI = dyn_cast<BitCastInst>(U)) {
Chris Lattner81686182007-09-13 16:30:19 +0000663 if (!AllUsesOfValueWillTrapIfNull(CI, PHIs)) return false;
Gabor Greif6ce02b52010-04-06 19:24:18 +0000664 } else if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner81686182007-09-13 16:30:19 +0000665 if (!AllUsesOfValueWillTrapIfNull(GEPI, PHIs)) return false;
Gabor Greif6ce02b52010-04-06 19:24:18 +0000666 } else if (const PHINode *PN = dyn_cast<PHINode>(U)) {
Chris Lattner81686182007-09-13 16:30:19 +0000667 // If we've already seen this phi node, ignore it, it has already been
668 // checked.
Jakob Stoklund Olesenb489d0f2010-01-29 23:54:14 +0000669 if (PHIs.insert(PN) && !AllUsesOfValueWillTrapIfNull(PN, PHIs))
670 return false;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000671 } else if (isa<ICmpInst>(U) &&
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000672 isa<ConstantPointerNull>(UI->getOperand(1))) {
Nick Lewyckye7ee59b2010-02-25 06:39:10 +0000673 // Ignore icmp X, null
Chris Lattner9b34a612004-10-09 21:48:45 +0000674 } else {
Gabor Greifa01d6db2010-04-06 19:14:05 +0000675 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000676 return false;
677 }
Gabor Greifa01d6db2010-04-06 19:14:05 +0000678 }
Chris Lattner9b34a612004-10-09 21:48:45 +0000679 return true;
680}
681
682/// AllUsesOfLoadedValueWillTrapIfNull - Return true if all uses of any loads
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000683/// from GV will trap if the loaded value is null. Note that this also permits
684/// comparisons of the loaded value against null, as a special case.
Gabor Greif6ce02b52010-04-06 19:24:18 +0000685static bool AllUsesOfLoadedValueWillTrapIfNull(const GlobalVariable *GV) {
686 for (Value::const_use_iterator UI = GV->use_begin(), E = GV->use_end();
Gabor Greifa01d6db2010-04-06 19:14:05 +0000687 UI != E; ++UI) {
Gabor Greif6ce02b52010-04-06 19:24:18 +0000688 const User *U = *UI;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000689
Gabor Greif6ce02b52010-04-06 19:24:18 +0000690 if (const LoadInst *LI = dyn_cast<LoadInst>(U)) {
691 SmallPtrSet<const PHINode*, 8> PHIs;
Chris Lattner81686182007-09-13 16:30:19 +0000692 if (!AllUsesOfValueWillTrapIfNull(LI, PHIs))
Chris Lattner9b34a612004-10-09 21:48:45 +0000693 return false;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000694 } else if (isa<StoreInst>(U)) {
Chris Lattner9b34a612004-10-09 21:48:45 +0000695 // Ignore stores to the global.
696 } else {
697 // We don't know or understand this user, bail out.
Gabor Greifa01d6db2010-04-06 19:14:05 +0000698 //cerr << "UNKNOWN USER OF GLOBAL!: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000699 return false;
700 }
Gabor Greifa01d6db2010-04-06 19:14:05 +0000701 }
Chris Lattner9b34a612004-10-09 21:48:45 +0000702 return true;
703}
704
Chris Lattner7b550cc2009-11-06 04:27:31 +0000705static bool OptimizeAwayTrappingUsesOfValue(Value *V, Constant *NewV) {
Chris Lattner708148e2004-10-10 23:14:11 +0000706 bool Changed = false;
707 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ) {
708 Instruction *I = cast<Instruction>(*UI++);
709 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
710 LI->setOperand(0, NewV);
711 Changed = true;
712 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
713 if (SI->getOperand(1) == V) {
714 SI->setOperand(1, NewV);
715 Changed = true;
716 }
717 } else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
Gabor Greiffa1f5c22010-04-06 18:45:08 +0000718 CallSite CS(I);
719 if (CS.getCalledValue() == V) {
Chris Lattner708148e2004-10-10 23:14:11 +0000720 // Calling through the pointer! Turn into a direct call, but be careful
721 // that the pointer is not also being passed as an argument.
Gabor Greiffa1f5c22010-04-06 18:45:08 +0000722 CS.setCalledFunction(NewV);
Chris Lattner708148e2004-10-10 23:14:11 +0000723 Changed = true;
724 bool PassedAsArg = false;
Gabor Greiffa1f5c22010-04-06 18:45:08 +0000725 for (unsigned i = 0, e = CS.arg_size(); i != e; ++i)
726 if (CS.getArgument(i) == V) {
Chris Lattner708148e2004-10-10 23:14:11 +0000727 PassedAsArg = true;
Gabor Greiffa1f5c22010-04-06 18:45:08 +0000728 CS.setArgument(i, NewV);
Chris Lattner708148e2004-10-10 23:14:11 +0000729 }
730
731 if (PassedAsArg) {
732 // Being passed as an argument also. Be careful to not invalidate UI!
733 UI = V->use_begin();
734 }
735 }
736 } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
737 Changed |= OptimizeAwayTrappingUsesOfValue(CI,
Owen Andersonbaf3c402009-07-29 18:55:55 +0000738 ConstantExpr::getCast(CI->getOpcode(),
Chris Lattner7b550cc2009-11-06 04:27:31 +0000739 NewV, CI->getType()));
Chris Lattner708148e2004-10-10 23:14:11 +0000740 if (CI->use_empty()) {
741 Changed = true;
Chris Lattner7a7ed022004-10-16 18:09:00 +0000742 CI->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000743 }
744 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
745 // Should handle GEP here.
Chris Lattner55eb1c42007-01-31 04:40:53 +0000746 SmallVector<Constant*, 8> Idxs;
747 Idxs.reserve(GEPI->getNumOperands()-1);
Gabor Greif5e463212008-05-29 01:59:18 +0000748 for (User::op_iterator i = GEPI->op_begin() + 1, e = GEPI->op_end();
749 i != e; ++i)
750 if (Constant *C = dyn_cast<Constant>(*i))
Chris Lattner55eb1c42007-01-31 04:40:53 +0000751 Idxs.push_back(C);
Chris Lattner708148e2004-10-10 23:14:11 +0000752 else
753 break;
Chris Lattner55eb1c42007-01-31 04:40:53 +0000754 if (Idxs.size() == GEPI->getNumOperands()-1)
Chris Lattner708148e2004-10-10 23:14:11 +0000755 Changed |= OptimizeAwayTrappingUsesOfValue(GEPI,
Owen Andersonbaf3c402009-07-29 18:55:55 +0000756 ConstantExpr::getGetElementPtr(NewV, &Idxs[0],
Chris Lattner7b550cc2009-11-06 04:27:31 +0000757 Idxs.size()));
Chris Lattner708148e2004-10-10 23:14:11 +0000758 if (GEPI->use_empty()) {
759 Changed = true;
Chris Lattner7a7ed022004-10-16 18:09:00 +0000760 GEPI->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000761 }
762 }
763 }
764
765 return Changed;
766}
767
768
769/// OptimizeAwayTrappingUsesOfLoads - The specified global has only one non-null
770/// value stored into it. If there are uses of the loaded value that would trap
771/// if the loaded value is dynamically null, then we know that they cannot be
772/// reachable with a null optimize away the load.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000773static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV) {
Chris Lattner708148e2004-10-10 23:14:11 +0000774 bool Changed = false;
775
Chris Lattner92c6bd22009-01-14 00:12:58 +0000776 // Keep track of whether we are able to remove all the uses of the global
777 // other than the store that defines it.
778 bool AllNonStoreUsesGone = true;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000779
Chris Lattner708148e2004-10-10 23:14:11 +0000780 // Replace all uses of loads with uses of uses of the stored value.
Chris Lattner92c6bd22009-01-14 00:12:58 +0000781 for (Value::use_iterator GUI = GV->use_begin(), E = GV->use_end(); GUI != E;){
782 User *GlobalUser = *GUI++;
783 if (LoadInst *LI = dyn_cast<LoadInst>(GlobalUser)) {
Chris Lattner7b550cc2009-11-06 04:27:31 +0000784 Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV);
Chris Lattner92c6bd22009-01-14 00:12:58 +0000785 // If we were able to delete all uses of the loads
786 if (LI->use_empty()) {
787 LI->eraseFromParent();
788 Changed = true;
789 } else {
790 AllNonStoreUsesGone = false;
791 }
792 } else if (isa<StoreInst>(GlobalUser)) {
793 // Ignore the store that stores "LV" to the global.
794 assert(GlobalUser->getOperand(1) == GV &&
795 "Must be storing *to* the global");
Chris Lattner708148e2004-10-10 23:14:11 +0000796 } else {
Chris Lattner92c6bd22009-01-14 00:12:58 +0000797 AllNonStoreUsesGone = false;
798
799 // If we get here we could have other crazy uses that are transitively
800 // loaded.
801 assert((isa<PHINode>(GlobalUser) || isa<SelectInst>(GlobalUser) ||
Chris Lattner98a42b22011-05-22 07:15:13 +0000802 isa<ConstantExpr>(GlobalUser) || isa<CmpInst>(GlobalUser)) &&
803 "Only expect load and stores!");
Chris Lattner708148e2004-10-10 23:14:11 +0000804 }
Chris Lattner92c6bd22009-01-14 00:12:58 +0000805 }
Chris Lattner708148e2004-10-10 23:14:11 +0000806
807 if (Changed) {
David Greene3215b0e2010-01-05 01:28:05 +0000808 DEBUG(dbgs() << "OPTIMIZED LOADS FROM STORED ONCE POINTER: " << *GV);
Chris Lattner708148e2004-10-10 23:14:11 +0000809 ++NumGlobUses;
810 }
811
Chris Lattner708148e2004-10-10 23:14:11 +0000812 // If we nuked all of the loads, then none of the stores are needed either,
813 // nor is the global.
Chris Lattner92c6bd22009-01-14 00:12:58 +0000814 if (AllNonStoreUsesGone) {
David Greene3215b0e2010-01-05 01:28:05 +0000815 DEBUG(dbgs() << " *** GLOBAL NOW DEAD!\n");
Chris Lattner7b550cc2009-11-06 04:27:31 +0000816 CleanupConstantGlobalUsers(GV, 0);
Chris Lattner708148e2004-10-10 23:14:11 +0000817 if (GV->use_empty()) {
Chris Lattner7a7ed022004-10-16 18:09:00 +0000818 GV->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000819 ++NumDeleted;
820 }
821 Changed = true;
822 }
823 return Changed;
824}
825
Chris Lattner30ba5692004-10-11 05:54:41 +0000826/// ConstantPropUsersOf - Walk the use list of V, constant folding all of the
827/// instructions that are foldable.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000828static void ConstantPropUsersOf(Value *V) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000829 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; )
830 if (Instruction *I = dyn_cast<Instruction>(*UI++))
Chris Lattner7b550cc2009-11-06 04:27:31 +0000831 if (Constant *NewC = ConstantFoldInstruction(I)) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000832 I->replaceAllUsesWith(NewC);
833
Chris Lattnerd514d822005-02-01 01:23:31 +0000834 // Advance UI to the next non-I use to avoid invalidating it!
835 // Instructions could multiply use V.
836 while (UI != E && *UI == I)
Chris Lattner30ba5692004-10-11 05:54:41 +0000837 ++UI;
Chris Lattnerd514d822005-02-01 01:23:31 +0000838 I->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000839 }
840}
841
842/// OptimizeGlobalAddressOfMalloc - This function takes the specified global
843/// variable, and transforms the program as if it always contained the result of
844/// the specified malloc. Because it is always the result of the specified
845/// malloc, there is no reason to actually DO the malloc. Instead, turn the
Chris Lattner6e8fbad2006-11-30 17:32:29 +0000846/// malloc into a global, and any loads of GV as uses of the new global.
Chris Lattner30ba5692004-10-11 05:54:41 +0000847static GlobalVariable *OptimizeGlobalAddressOfMalloc(GlobalVariable *GV,
Victor Hernandez83d63912009-09-18 22:35:49 +0000848 CallInst *CI,
Victor Hernandez9d0b7042009-11-07 00:16:28 +0000849 const Type *AllocTy,
Chris Lattnera6874652010-02-25 22:33:52 +0000850 ConstantInt *NElements,
Victor Hernandez83d63912009-09-18 22:35:49 +0000851 TargetData* TD) {
Chris Lattnera6874652010-02-25 22:33:52 +0000852 DEBUG(errs() << "PROMOTING GLOBAL: " << *GV << " CALL = " << *CI << '\n');
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000853
Chris Lattnera6874652010-02-25 22:33:52 +0000854 const Type *GlobalType;
855 if (NElements->getZExtValue() == 1)
856 GlobalType = AllocTy;
857 else
858 // If we have an array allocation, the global variable is of an array.
859 GlobalType = ArrayType::get(AllocTy, NElements->getZExtValue());
Victor Hernandez83d63912009-09-18 22:35:49 +0000860
861 // Create the new global variable. The contents of the malloc'd memory is
862 // undefined, so initialize with an undef value.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000863 GlobalVariable *NewGV = new GlobalVariable(*GV->getParent(),
Chris Lattnere9fd4442010-02-26 23:42:13 +0000864 GlobalType, false,
Chris Lattnera6874652010-02-25 22:33:52 +0000865 GlobalValue::InternalLinkage,
Chris Lattnere9fd4442010-02-26 23:42:13 +0000866 UndefValue::get(GlobalType),
Victor Hernandez83d63912009-09-18 22:35:49 +0000867 GV->getName()+".body",
868 GV,
869 GV->isThreadLocal());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000870
Chris Lattnera6874652010-02-25 22:33:52 +0000871 // If there are bitcast users of the malloc (which is typical, usually we have
872 // a malloc + bitcast) then replace them with uses of the new global. Update
873 // other users to use the global as well.
874 BitCastInst *TheBC = 0;
875 while (!CI->use_empty()) {
876 Instruction *User = cast<Instruction>(CI->use_back());
877 if (BitCastInst *BCI = dyn_cast<BitCastInst>(User)) {
878 if (BCI->getType() == NewGV->getType()) {
879 BCI->replaceAllUsesWith(NewGV);
880 BCI->eraseFromParent();
881 } else {
882 BCI->setOperand(0, NewGV);
883 }
884 } else {
885 if (TheBC == 0)
886 TheBC = new BitCastInst(NewGV, CI->getType(), "newgv", CI);
887 User->replaceUsesOfWith(CI, TheBC);
888 }
889 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000890
Victor Hernandez83d63912009-09-18 22:35:49 +0000891 Constant *RepValue = NewGV;
892 if (NewGV->getType() != GV->getType()->getElementType())
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000893 RepValue = ConstantExpr::getBitCast(RepValue,
Victor Hernandez83d63912009-09-18 22:35:49 +0000894 GV->getType()->getElementType());
895
896 // If there is a comparison against null, we will insert a global bool to
897 // keep track of whether the global was initialized yet or not.
898 GlobalVariable *InitBool =
Chris Lattner7b550cc2009-11-06 04:27:31 +0000899 new GlobalVariable(Type::getInt1Ty(GV->getContext()), false,
Victor Hernandez83d63912009-09-18 22:35:49 +0000900 GlobalValue::InternalLinkage,
Chris Lattner7b550cc2009-11-06 04:27:31 +0000901 ConstantInt::getFalse(GV->getContext()),
902 GV->getName()+".init", GV->isThreadLocal());
Victor Hernandez83d63912009-09-18 22:35:49 +0000903 bool InitBoolUsed = false;
904
905 // Loop over all uses of GV, processing them in turn.
Chris Lattnera6874652010-02-25 22:33:52 +0000906 while (!GV->use_empty()) {
907 if (StoreInst *SI = dyn_cast<StoreInst>(GV->use_back())) {
Victor Hernandez83d63912009-09-18 22:35:49 +0000908 // The global is initialized when the store to it occurs.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000909 new StoreInst(ConstantInt::getTrue(GV->getContext()), InitBool, SI);
Victor Hernandez83d63912009-09-18 22:35:49 +0000910 SI->eraseFromParent();
Chris Lattnera6874652010-02-25 22:33:52 +0000911 continue;
Victor Hernandez83d63912009-09-18 22:35:49 +0000912 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000913
Chris Lattnera6874652010-02-25 22:33:52 +0000914 LoadInst *LI = cast<LoadInst>(GV->use_back());
915 while (!LI->use_empty()) {
916 Use &LoadUse = LI->use_begin().getUse();
917 if (!isa<ICmpInst>(LoadUse.getUser())) {
918 LoadUse = RepValue;
919 continue;
920 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000921
Chris Lattnera6874652010-02-25 22:33:52 +0000922 ICmpInst *ICI = cast<ICmpInst>(LoadUse.getUser());
923 // Replace the cmp X, 0 with a use of the bool value.
924 Value *LV = new LoadInst(InitBool, InitBool->getName()+".val", ICI);
925 InitBoolUsed = true;
926 switch (ICI->getPredicate()) {
927 default: llvm_unreachable("Unknown ICmp Predicate!");
928 case ICmpInst::ICMP_ULT:
929 case ICmpInst::ICMP_SLT: // X < null -> always false
930 LV = ConstantInt::getFalse(GV->getContext());
931 break;
932 case ICmpInst::ICMP_ULE:
933 case ICmpInst::ICMP_SLE:
934 case ICmpInst::ICMP_EQ:
935 LV = BinaryOperator::CreateNot(LV, "notinit", ICI);
936 break;
937 case ICmpInst::ICMP_NE:
938 case ICmpInst::ICMP_UGE:
939 case ICmpInst::ICMP_SGE:
940 case ICmpInst::ICMP_UGT:
941 case ICmpInst::ICMP_SGT:
942 break; // no change.
943 }
944 ICI->replaceAllUsesWith(LV);
945 ICI->eraseFromParent();
946 }
947 LI->eraseFromParent();
948 }
Victor Hernandez83d63912009-09-18 22:35:49 +0000949
950 // If the initialization boolean was used, insert it, otherwise delete it.
951 if (!InitBoolUsed) {
952 while (!InitBool->use_empty()) // Delete initializations
Chris Lattnera6874652010-02-25 22:33:52 +0000953 cast<StoreInst>(InitBool->use_back())->eraseFromParent();
Victor Hernandez83d63912009-09-18 22:35:49 +0000954 delete InitBool;
955 } else
956 GV->getParent()->getGlobalList().insert(GV, InitBool);
957
Chris Lattnera6874652010-02-25 22:33:52 +0000958 // Now the GV is dead, nuke it and the malloc..
Victor Hernandez83d63912009-09-18 22:35:49 +0000959 GV->eraseFromParent();
Victor Hernandez83d63912009-09-18 22:35:49 +0000960 CI->eraseFromParent();
961
962 // To further other optimizations, loop over all users of NewGV and try to
963 // constant prop them. This will promote GEP instructions with constant
964 // indices into GEP constant-exprs, which will allow global-opt to hack on it.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000965 ConstantPropUsersOf(NewGV);
Victor Hernandez83d63912009-09-18 22:35:49 +0000966 if (RepValue != NewGV)
Chris Lattner7b550cc2009-11-06 04:27:31 +0000967 ConstantPropUsersOf(RepValue);
Victor Hernandez83d63912009-09-18 22:35:49 +0000968
969 return NewGV;
970}
971
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000972/// ValueIsOnlyUsedLocallyOrStoredToOneGlobal - Scan the use-list of V checking
973/// to make sure that there are no complex uses of V. We permit simple things
974/// like dereferencing the pointer, but not storing through the address, unless
975/// it is to the specified global.
Gabor Greif0b520db2010-04-06 18:58:22 +0000976static bool ValueIsOnlyUsedLocallyOrStoredToOneGlobal(const Instruction *V,
977 const GlobalVariable *GV,
Gabor Greifa01d6db2010-04-06 19:14:05 +0000978 SmallPtrSet<const PHINode*, 8> &PHIs) {
Gabor Greif0b520db2010-04-06 18:58:22 +0000979 for (Value::const_use_iterator UI = V->use_begin(), E = V->use_end();
Gabor Greifa01d6db2010-04-06 19:14:05 +0000980 UI != E; ++UI) {
Gabor Greif0b520db2010-04-06 18:58:22 +0000981 const Instruction *Inst = cast<Instruction>(*UI);
Gabor Greifa01d6db2010-04-06 19:14:05 +0000982
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000983 if (isa<LoadInst>(Inst) || isa<CmpInst>(Inst)) {
984 continue; // Fine, ignore.
985 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000986
Gabor Greif0b520db2010-04-06 18:58:22 +0000987 if (const StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000988 if (SI->getOperand(0) == V && SI->getOperand(1) != GV)
989 return false; // Storing the pointer itself... bad.
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000990 continue; // Otherwise, storing through it, or storing into GV... fine.
991 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000992
Chris Lattnera2fb2342010-04-10 18:19:22 +0000993 // Must index into the array and into the struct.
994 if (isa<GetElementPtrInst>(Inst) && Inst->getNumOperands() >= 3) {
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000995 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Inst, GV, PHIs))
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000996 return false;
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000997 continue;
998 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000999
Gabor Greif0b520db2010-04-06 18:58:22 +00001000 if (const PHINode *PN = dyn_cast<PHINode>(Inst)) {
Chris Lattnerc451f9c2007-09-13 16:37:20 +00001001 // PHIs are ok if all uses are ok. Don't infinitely recurse through PHI
1002 // cycles.
1003 if (PHIs.insert(PN))
Chris Lattner5e6e4942007-09-14 03:41:21 +00001004 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(PN, GV, PHIs))
1005 return false;
Chris Lattner49b6d4a2008-12-15 21:08:54 +00001006 continue;
Chris Lattnerfa07e4f2004-12-02 07:11:07 +00001007 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001008
Gabor Greif0b520db2010-04-06 18:58:22 +00001009 if (const BitCastInst *BCI = dyn_cast<BitCastInst>(Inst)) {
Chris Lattner49b6d4a2008-12-15 21:08:54 +00001010 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(BCI, GV, PHIs))
1011 return false;
1012 continue;
1013 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001014
Chris Lattner49b6d4a2008-12-15 21:08:54 +00001015 return false;
1016 }
Chris Lattnerfa07e4f2004-12-02 07:11:07 +00001017 return true;
Chris Lattnerfa07e4f2004-12-02 07:11:07 +00001018}
1019
Chris Lattner86395032006-09-30 23:32:09 +00001020/// ReplaceUsesOfMallocWithGlobal - The Alloc pointer is stored into GV
1021/// somewhere. Transform all uses of the allocation into loads from the
1022/// global and uses of the resultant pointer. Further, delete the store into
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001023/// GV. This assumes that these value pass the
Chris Lattner86395032006-09-30 23:32:09 +00001024/// 'ValueIsOnlyUsedLocallyOrStoredToOneGlobal' predicate.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001025static void ReplaceUsesOfMallocWithGlobal(Instruction *Alloc,
Chris Lattner86395032006-09-30 23:32:09 +00001026 GlobalVariable *GV) {
1027 while (!Alloc->use_empty()) {
Chris Lattnera637a8b2007-09-13 18:00:31 +00001028 Instruction *U = cast<Instruction>(*Alloc->use_begin());
1029 Instruction *InsertPt = U;
Chris Lattner86395032006-09-30 23:32:09 +00001030 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
1031 // If this is the store of the allocation into the global, remove it.
1032 if (SI->getOperand(1) == GV) {
1033 SI->eraseFromParent();
1034 continue;
1035 }
Chris Lattnera637a8b2007-09-13 18:00:31 +00001036 } else if (PHINode *PN = dyn_cast<PHINode>(U)) {
1037 // Insert the load in the corresponding predecessor, not right before the
1038 // PHI.
Gabor Greifa36791d2009-01-23 19:40:15 +00001039 InsertPt = PN->getIncomingBlock(Alloc->use_begin())->getTerminator();
Chris Lattner101f44e2008-12-15 21:44:34 +00001040 } else if (isa<BitCastInst>(U)) {
1041 // Must be bitcast between the malloc and store to initialize the global.
1042 ReplaceUsesOfMallocWithGlobal(U, GV);
1043 U->eraseFromParent();
1044 continue;
1045 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
1046 // If this is a "GEP bitcast" and the user is a store to the global, then
1047 // just process it as a bitcast.
1048 if (GEPI->hasAllZeroIndices() && GEPI->hasOneUse())
1049 if (StoreInst *SI = dyn_cast<StoreInst>(GEPI->use_back()))
1050 if (SI->getOperand(1) == GV) {
1051 // Must be bitcast GEP between the malloc and store to initialize
1052 // the global.
1053 ReplaceUsesOfMallocWithGlobal(GEPI, GV);
1054 GEPI->eraseFromParent();
1055 continue;
1056 }
Chris Lattner86395032006-09-30 23:32:09 +00001057 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001058
Chris Lattner86395032006-09-30 23:32:09 +00001059 // Insert a load from the global, and use it instead of the malloc.
Chris Lattnera637a8b2007-09-13 18:00:31 +00001060 Value *NL = new LoadInst(GV, GV->getName()+".val", InsertPt);
Chris Lattner86395032006-09-30 23:32:09 +00001061 U->replaceUsesOfWith(Alloc, NL);
1062 }
1063}
1064
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001065/// LoadUsesSimpleEnoughForHeapSRA - Verify that all uses of V (a load, or a phi
1066/// of a load) are simple enough to perform heap SRA on. This permits GEP's
1067/// that index through the array and struct field, icmps of null, and PHIs.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001068static bool LoadUsesSimpleEnoughForHeapSRA(const Value *V,
Gabor Greif27236912010-04-07 18:59:26 +00001069 SmallPtrSet<const PHINode*, 32> &LoadUsingPHIs,
1070 SmallPtrSet<const PHINode*, 32> &LoadUsingPHIsPerLoad) {
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001071 // We permit two users of the load: setcc comparing against the null
1072 // pointer, and a getelementptr of a specific form.
Gabor Greif27236912010-04-07 18:59:26 +00001073 for (Value::const_use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;
1074 ++UI) {
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001075 const Instruction *User = cast<Instruction>(*UI);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001076
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001077 // Comparison against null is ok.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001078 if (const ICmpInst *ICI = dyn_cast<ICmpInst>(User)) {
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001079 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
1080 return false;
1081 continue;
1082 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001083
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001084 // getelementptr is also ok, but only a simple form.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001085 if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001086 // Must index into the array and into the struct.
1087 if (GEPI->getNumOperands() < 3)
1088 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001089
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001090 // Otherwise the GEP is ok.
1091 continue;
1092 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001093
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001094 if (const PHINode *PN = dyn_cast<PHINode>(User)) {
Evan Cheng5d163962009-06-02 00:56:07 +00001095 if (!LoadUsingPHIsPerLoad.insert(PN))
1096 // This means some phi nodes are dependent on each other.
1097 // Avoid infinite looping!
1098 return false;
1099 if (!LoadUsingPHIs.insert(PN))
1100 // If we have already analyzed this PHI, then it is safe.
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001101 continue;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001102
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001103 // Make sure all uses of the PHI are simple enough to transform.
Evan Cheng5d163962009-06-02 00:56:07 +00001104 if (!LoadUsesSimpleEnoughForHeapSRA(PN,
1105 LoadUsingPHIs, LoadUsingPHIsPerLoad))
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001106 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001107
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001108 continue;
Chris Lattner86395032006-09-30 23:32:09 +00001109 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001110
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001111 // Otherwise we don't know what this is, not ok.
1112 return false;
1113 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001114
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001115 return true;
1116}
1117
1118
1119/// AllGlobalLoadUsesSimpleEnoughForHeapSRA - If all users of values loaded from
1120/// GV are simple enough to perform HeapSRA, return true.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001121static bool AllGlobalLoadUsesSimpleEnoughForHeapSRA(const GlobalVariable *GV,
Victor Hernandez83d63912009-09-18 22:35:49 +00001122 Instruction *StoredVal) {
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001123 SmallPtrSet<const PHINode*, 32> LoadUsingPHIs;
1124 SmallPtrSet<const PHINode*, 32> LoadUsingPHIsPerLoad;
Gabor Greif27236912010-04-07 18:59:26 +00001125 for (Value::const_use_iterator UI = GV->use_begin(), E = GV->use_end();
1126 UI != E; ++UI)
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001127 if (const LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
Evan Cheng5d163962009-06-02 00:56:07 +00001128 if (!LoadUsesSimpleEnoughForHeapSRA(LI, LoadUsingPHIs,
1129 LoadUsingPHIsPerLoad))
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001130 return false;
Evan Cheng5d163962009-06-02 00:56:07 +00001131 LoadUsingPHIsPerLoad.clear();
1132 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001133
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001134 // If we reach here, we know that all uses of the loads and transitive uses
1135 // (through PHI nodes) are simple enough to transform. However, we don't know
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001136 // that all inputs the to the PHI nodes are in the same equivalence sets.
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001137 // Check to verify that all operands of the PHIs are either PHIS that can be
1138 // transformed, loads from GV, or MI itself.
Gabor Greif27236912010-04-07 18:59:26 +00001139 for (SmallPtrSet<const PHINode*, 32>::const_iterator I = LoadUsingPHIs.begin()
1140 , E = LoadUsingPHIs.end(); I != E; ++I) {
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001141 const PHINode *PN = *I;
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001142 for (unsigned op = 0, e = PN->getNumIncomingValues(); op != e; ++op) {
1143 Value *InVal = PN->getIncomingValue(op);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001144
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001145 // PHI of the stored value itself is ok.
Victor Hernandez83d63912009-09-18 22:35:49 +00001146 if (InVal == StoredVal) continue;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001147
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001148 if (const PHINode *InPN = dyn_cast<PHINode>(InVal)) {
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001149 // One of the PHIs in our set is (optimistically) ok.
1150 if (LoadUsingPHIs.count(InPN))
1151 continue;
1152 return false;
1153 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001154
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001155 // Load from GV is ok.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001156 if (const LoadInst *LI = dyn_cast<LoadInst>(InVal))
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001157 if (LI->getOperand(0) == GV)
1158 continue;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001159
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001160 // UNDEF? NULL?
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001161
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001162 // Anything else is rejected.
1163 return false;
1164 }
1165 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001166
Chris Lattner86395032006-09-30 23:32:09 +00001167 return true;
1168}
1169
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001170static Value *GetHeapSROAValue(Value *V, unsigned FieldNo,
1171 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001172 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001173 std::vector<Value*> &FieldVals = InsertedScalarizedValues[V];
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001174
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001175 if (FieldNo >= FieldVals.size())
1176 FieldVals.resize(FieldNo+1);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001177
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001178 // If we already have this value, just reuse the previously scalarized
1179 // version.
1180 if (Value *FieldVal = FieldVals[FieldNo])
1181 return FieldVal;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001182
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001183 // Depending on what instruction this is, we have several cases.
1184 Value *Result;
1185 if (LoadInst *LI = dyn_cast<LoadInst>(V)) {
1186 // This is a scalarized version of the load from the global. Just create
1187 // a new Load of the scalarized global.
1188 Result = new LoadInst(GetHeapSROAValue(LI->getOperand(0), FieldNo,
1189 InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001190 PHIsToRewrite),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001191 LI->getName()+".f"+Twine(FieldNo), LI);
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001192 } else if (PHINode *PN = dyn_cast<PHINode>(V)) {
1193 // PN's type is pointer to struct. Make a new PHI of pointer to struct
1194 // field.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001195 const StructType *ST =
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001196 cast<StructType>(cast<PointerType>(PN->getType())->getElementType());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001197
Jay Foadd8b4fb42011-03-30 11:19:20 +00001198 PHINode *NewPN =
Owen Andersondebcb012009-07-29 22:17:13 +00001199 PHINode::Create(PointerType::getUnqual(ST->getElementType(FieldNo)),
Jay Foad3ecfc862011-03-30 11:28:46 +00001200 PN->getNumIncomingValues(),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001201 PN->getName()+".f"+Twine(FieldNo), PN);
Jay Foadd8b4fb42011-03-30 11:19:20 +00001202 Result = NewPN;
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001203 PHIsToRewrite.push_back(std::make_pair(PN, FieldNo));
1204 } else {
Torok Edwinc23197a2009-07-14 16:55:14 +00001205 llvm_unreachable("Unknown usable value");
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001206 Result = 0;
1207 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001208
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001209 return FieldVals[FieldNo] = Result;
Chris Lattnera637a8b2007-09-13 18:00:31 +00001210}
1211
Chris Lattner330245e2007-09-13 17:29:05 +00001212/// RewriteHeapSROALoadUser - Given a load instruction and a value derived from
1213/// the load, rewrite the derived value to use the HeapSRoA'd load.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001214static void RewriteHeapSROALoadUser(Instruction *LoadUser,
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001215 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001216 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattner330245e2007-09-13 17:29:05 +00001217 // If this is a comparison against null, handle it.
1218 if (ICmpInst *SCI = dyn_cast<ICmpInst>(LoadUser)) {
1219 assert(isa<ConstantPointerNull>(SCI->getOperand(1)));
1220 // If we have a setcc of the loaded pointer, we can use a setcc of any
1221 // field.
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001222 Value *NPtr = GetHeapSROAValue(SCI->getOperand(0), 0,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001223 InsertedScalarizedValues, PHIsToRewrite);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001224
Owen Anderson333c4002009-07-09 23:48:35 +00001225 Value *New = new ICmpInst(SCI, SCI->getPredicate(), NPtr,
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001226 Constant::getNullValue(NPtr->getType()),
Owen Anderson333c4002009-07-09 23:48:35 +00001227 SCI->getName());
Chris Lattner330245e2007-09-13 17:29:05 +00001228 SCI->replaceAllUsesWith(New);
1229 SCI->eraseFromParent();
1230 return;
1231 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001232
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001233 // Handle 'getelementptr Ptr, Idx, i32 FieldNo ...'
Chris Lattnera637a8b2007-09-13 18:00:31 +00001234 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(LoadUser)) {
1235 assert(GEPI->getNumOperands() >= 3 && isa<ConstantInt>(GEPI->getOperand(2))
1236 && "Unexpected GEPI!");
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001237
Chris Lattnera637a8b2007-09-13 18:00:31 +00001238 // Load the pointer for this field.
1239 unsigned FieldNo = cast<ConstantInt>(GEPI->getOperand(2))->getZExtValue();
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001240 Value *NewPtr = GetHeapSROAValue(GEPI->getOperand(0), FieldNo,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001241 InsertedScalarizedValues, PHIsToRewrite);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001242
Chris Lattnera637a8b2007-09-13 18:00:31 +00001243 // Create the new GEP idx vector.
1244 SmallVector<Value*, 8> GEPIdx;
1245 GEPIdx.push_back(GEPI->getOperand(1));
1246 GEPIdx.append(GEPI->op_begin()+3, GEPI->op_end());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001247
Gabor Greifb1dbcd82008-05-15 10:04:30 +00001248 Value *NGEPI = GetElementPtrInst::Create(NewPtr,
1249 GEPIdx.begin(), GEPIdx.end(),
Gabor Greif051a9502008-04-06 20:25:17 +00001250 GEPI->getName(), GEPI);
Chris Lattnera637a8b2007-09-13 18:00:31 +00001251 GEPI->replaceAllUsesWith(NGEPI);
1252 GEPI->eraseFromParent();
1253 return;
1254 }
Chris Lattner309f20f2007-09-13 21:31:36 +00001255
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001256 // Recursively transform the users of PHI nodes. This will lazily create the
1257 // PHIs that are needed for individual elements. Keep track of what PHIs we
1258 // see in InsertedScalarizedValues so that we don't get infinite loops (very
1259 // antisocial). If the PHI is already in InsertedScalarizedValues, it has
1260 // already been seen first by another load, so its uses have already been
1261 // processed.
1262 PHINode *PN = cast<PHINode>(LoadUser);
1263 bool Inserted;
1264 DenseMap<Value*, std::vector<Value*> >::iterator InsertPos;
1265 tie(InsertPos, Inserted) =
1266 InsertedScalarizedValues.insert(std::make_pair(PN, std::vector<Value*>()));
1267 if (!Inserted) return;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001268
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001269 // If this is the first time we've seen this PHI, recursively process all
1270 // users.
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001271 for (Value::use_iterator UI = PN->use_begin(), E = PN->use_end(); UI != E; ) {
1272 Instruction *User = cast<Instruction>(*UI++);
Chris Lattner7b550cc2009-11-06 04:27:31 +00001273 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001274 }
Chris Lattner330245e2007-09-13 17:29:05 +00001275}
1276
Chris Lattner86395032006-09-30 23:32:09 +00001277/// RewriteUsesOfLoadForHeapSRoA - We are performing Heap SRoA on a global. Ptr
1278/// is a value loaded from the global. Eliminate all uses of Ptr, making them
1279/// use FieldGlobals instead. All uses of loaded values satisfy
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001280/// AllGlobalLoadUsesSimpleEnoughForHeapSRA.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001281static void RewriteUsesOfLoadForHeapSRoA(LoadInst *Load,
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001282 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001283 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001284 for (Value::use_iterator UI = Load->use_begin(), E = Load->use_end();
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001285 UI != E; ) {
1286 Instruction *User = cast<Instruction>(*UI++);
Chris Lattner7b550cc2009-11-06 04:27:31 +00001287 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001288 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001289
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001290 if (Load->use_empty()) {
1291 Load->eraseFromParent();
1292 InsertedScalarizedValues.erase(Load);
1293 }
Chris Lattner86395032006-09-30 23:32:09 +00001294}
1295
Victor Hernandez83d63912009-09-18 22:35:49 +00001296/// PerformHeapAllocSRoA - CI is an allocation of an array of structures. Break
1297/// it up into multiple allocations of arrays of the fields.
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001298static GlobalVariable *PerformHeapAllocSRoA(GlobalVariable *GV, CallInst *CI,
1299 Value* NElems, TargetData *TD) {
David Greene3215b0e2010-01-05 01:28:05 +00001300 DEBUG(dbgs() << "SROA HEAP ALLOC: " << *GV << " MALLOC = " << *CI << '\n');
Victor Hernandez83d63912009-09-18 22:35:49 +00001301 const Type* MAT = getMallocAllocatedType(CI);
1302 const StructType *STy = cast<StructType>(MAT);
1303
1304 // There is guaranteed to be at least one use of the malloc (storing
1305 // it into GV). If there are other uses, change them to be uses of
1306 // the global to simplify later code. This also deletes the store
1307 // into GV.
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001308 ReplaceUsesOfMallocWithGlobal(CI, GV);
1309
Victor Hernandez83d63912009-09-18 22:35:49 +00001310 // Okay, at this point, there are no users of the malloc. Insert N
1311 // new mallocs at the same place as CI, and N globals.
1312 std::vector<Value*> FieldGlobals;
1313 std::vector<Value*> FieldMallocs;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001314
Victor Hernandez83d63912009-09-18 22:35:49 +00001315 for (unsigned FieldNo = 0, e = STy->getNumElements(); FieldNo != e;++FieldNo){
1316 const Type *FieldTy = STy->getElementType(FieldNo);
1317 const PointerType *PFieldTy = PointerType::getUnqual(FieldTy);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001318
Victor Hernandez83d63912009-09-18 22:35:49 +00001319 GlobalVariable *NGV =
1320 new GlobalVariable(*GV->getParent(),
1321 PFieldTy, false, GlobalValue::InternalLinkage,
1322 Constant::getNullValue(PFieldTy),
1323 GV->getName() + ".f" + Twine(FieldNo), GV,
1324 GV->isThreadLocal());
1325 FieldGlobals.push_back(NGV);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001326
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001327 unsigned TypeSize = TD->getTypeAllocSize(FieldTy);
Victor Hernandez631f3c02009-11-07 00:41:19 +00001328 if (const StructType *ST = dyn_cast<StructType>(FieldTy))
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001329 TypeSize = TD->getStructLayout(ST)->getSizeInBytes();
Victor Hernandez631f3c02009-11-07 00:41:19 +00001330 const Type *IntPtrTy = TD->getIntPtrType(CI->getContext());
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001331 Value *NMI = CallInst::CreateMalloc(CI, IntPtrTy, FieldTy,
1332 ConstantInt::get(IntPtrTy, TypeSize),
Chris Lattner5a30a852010-07-12 00:57:28 +00001333 NElems, 0,
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001334 CI->getName() + ".f" + Twine(FieldNo));
Chris Lattner3f5e0b82010-02-26 18:23:13 +00001335 FieldMallocs.push_back(NMI);
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001336 new StoreInst(NMI, NGV, CI);
Victor Hernandez83d63912009-09-18 22:35:49 +00001337 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001338
Victor Hernandez83d63912009-09-18 22:35:49 +00001339 // The tricky aspect of this transformation is handling the case when malloc
1340 // fails. In the original code, malloc failing would set the result pointer
1341 // of malloc to null. In this case, some mallocs could succeed and others
1342 // could fail. As such, we emit code that looks like this:
1343 // F0 = malloc(field0)
1344 // F1 = malloc(field1)
1345 // F2 = malloc(field2)
1346 // if (F0 == 0 || F1 == 0 || F2 == 0) {
1347 // if (F0) { free(F0); F0 = 0; }
1348 // if (F1) { free(F1); F1 = 0; }
1349 // if (F2) { free(F2); F2 = 0; }
1350 // }
Victor Hernandez8e345a12009-11-10 08:32:25 +00001351 // The malloc can also fail if its argument is too large.
Gabor Greif9e4f2432010-06-24 14:42:01 +00001352 Constant *ConstantZero = ConstantInt::get(CI->getArgOperand(0)->getType(), 0);
1353 Value *RunningOr = new ICmpInst(CI, ICmpInst::ICMP_SLT, CI->getArgOperand(0),
Victor Hernandez8e345a12009-11-10 08:32:25 +00001354 ConstantZero, "isneg");
Victor Hernandez83d63912009-09-18 22:35:49 +00001355 for (unsigned i = 0, e = FieldMallocs.size(); i != e; ++i) {
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001356 Value *Cond = new ICmpInst(CI, ICmpInst::ICMP_EQ, FieldMallocs[i],
1357 Constant::getNullValue(FieldMallocs[i]->getType()),
1358 "isnull");
Victor Hernandez8e345a12009-11-10 08:32:25 +00001359 RunningOr = BinaryOperator::CreateOr(RunningOr, Cond, "tmp", CI);
Victor Hernandez83d63912009-09-18 22:35:49 +00001360 }
1361
1362 // Split the basic block at the old malloc.
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001363 BasicBlock *OrigBB = CI->getParent();
1364 BasicBlock *ContBB = OrigBB->splitBasicBlock(CI, "malloc_cont");
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001365
Victor Hernandez83d63912009-09-18 22:35:49 +00001366 // Create the block to check the first condition. Put all these blocks at the
1367 // end of the function as they are unlikely to be executed.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001368 BasicBlock *NullPtrBlock = BasicBlock::Create(OrigBB->getContext(),
1369 "malloc_ret_null",
Victor Hernandez83d63912009-09-18 22:35:49 +00001370 OrigBB->getParent());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001371
Victor Hernandez83d63912009-09-18 22:35:49 +00001372 // Remove the uncond branch from OrigBB to ContBB, turning it into a cond
1373 // branch on RunningOr.
1374 OrigBB->getTerminator()->eraseFromParent();
1375 BranchInst::Create(NullPtrBlock, ContBB, RunningOr, OrigBB);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001376
Victor Hernandez83d63912009-09-18 22:35:49 +00001377 // Within the NullPtrBlock, we need to emit a comparison and branch for each
1378 // pointer, because some may be null while others are not.
1379 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1380 Value *GVVal = new LoadInst(FieldGlobals[i], "tmp", NullPtrBlock);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001381 Value *Cmp = new ICmpInst(*NullPtrBlock, ICmpInst::ICMP_NE, GVVal,
Victor Hernandez83d63912009-09-18 22:35:49 +00001382 Constant::getNullValue(GVVal->getType()),
1383 "tmp");
Chris Lattner7b550cc2009-11-06 04:27:31 +00001384 BasicBlock *FreeBlock = BasicBlock::Create(Cmp->getContext(), "free_it",
Victor Hernandez83d63912009-09-18 22:35:49 +00001385 OrigBB->getParent());
Chris Lattner7b550cc2009-11-06 04:27:31 +00001386 BasicBlock *NextBlock = BasicBlock::Create(Cmp->getContext(), "next",
Victor Hernandez83d63912009-09-18 22:35:49 +00001387 OrigBB->getParent());
Victor Hernandez66284e02009-10-24 04:23:03 +00001388 Instruction *BI = BranchInst::Create(FreeBlock, NextBlock,
1389 Cmp, NullPtrBlock);
Victor Hernandez83d63912009-09-18 22:35:49 +00001390
1391 // Fill in FreeBlock.
Victor Hernandez66284e02009-10-24 04:23:03 +00001392 CallInst::CreateFree(GVVal, BI);
Victor Hernandez83d63912009-09-18 22:35:49 +00001393 new StoreInst(Constant::getNullValue(GVVal->getType()), FieldGlobals[i],
1394 FreeBlock);
1395 BranchInst::Create(NextBlock, FreeBlock);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001396
Victor Hernandez83d63912009-09-18 22:35:49 +00001397 NullPtrBlock = NextBlock;
1398 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001399
Victor Hernandez83d63912009-09-18 22:35:49 +00001400 BranchInst::Create(ContBB, NullPtrBlock);
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001401
1402 // CI is no longer needed, remove it.
Victor Hernandez83d63912009-09-18 22:35:49 +00001403 CI->eraseFromParent();
1404
1405 /// InsertedScalarizedLoads - As we process loads, if we can't immediately
1406 /// update all uses of the load, keep track of what scalarized loads are
1407 /// inserted for a given load.
1408 DenseMap<Value*, std::vector<Value*> > InsertedScalarizedValues;
1409 InsertedScalarizedValues[GV] = FieldGlobals;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001410
Victor Hernandez83d63912009-09-18 22:35:49 +00001411 std::vector<std::pair<PHINode*, unsigned> > PHIsToRewrite;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001412
Victor Hernandez83d63912009-09-18 22:35:49 +00001413 // Okay, the malloc site is completely handled. All of the uses of GV are now
1414 // loads, and all uses of those loads are simple. Rewrite them to use loads
1415 // of the per-field globals instead.
1416 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI != E;) {
1417 Instruction *User = cast<Instruction>(*UI++);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001418
Victor Hernandez83d63912009-09-18 22:35:49 +00001419 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
Chris Lattner7b550cc2009-11-06 04:27:31 +00001420 RewriteUsesOfLoadForHeapSRoA(LI, InsertedScalarizedValues, PHIsToRewrite);
Victor Hernandez83d63912009-09-18 22:35:49 +00001421 continue;
1422 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001423
Victor Hernandez83d63912009-09-18 22:35:49 +00001424 // Must be a store of null.
1425 StoreInst *SI = cast<StoreInst>(User);
1426 assert(isa<ConstantPointerNull>(SI->getOperand(0)) &&
1427 "Unexpected heap-sra user!");
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001428
Victor Hernandez83d63912009-09-18 22:35:49 +00001429 // Insert a store of null into each global.
1430 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1431 const PointerType *PT = cast<PointerType>(FieldGlobals[i]->getType());
1432 Constant *Null = Constant::getNullValue(PT->getElementType());
1433 new StoreInst(Null, FieldGlobals[i], SI);
1434 }
1435 // Erase the original store.
1436 SI->eraseFromParent();
1437 }
1438
1439 // While we have PHIs that are interesting to rewrite, do it.
1440 while (!PHIsToRewrite.empty()) {
1441 PHINode *PN = PHIsToRewrite.back().first;
1442 unsigned FieldNo = PHIsToRewrite.back().second;
1443 PHIsToRewrite.pop_back();
1444 PHINode *FieldPN = cast<PHINode>(InsertedScalarizedValues[PN][FieldNo]);
1445 assert(FieldPN->getNumIncomingValues() == 0 &&"Already processed this phi");
1446
1447 // Add all the incoming values. This can materialize more phis.
1448 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1449 Value *InVal = PN->getIncomingValue(i);
1450 InVal = GetHeapSROAValue(InVal, FieldNo, InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001451 PHIsToRewrite);
Victor Hernandez83d63912009-09-18 22:35:49 +00001452 FieldPN->addIncoming(InVal, PN->getIncomingBlock(i));
1453 }
1454 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001455
Victor Hernandez83d63912009-09-18 22:35:49 +00001456 // Drop all inter-phi links and any loads that made it this far.
1457 for (DenseMap<Value*, std::vector<Value*> >::iterator
1458 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1459 I != E; ++I) {
1460 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1461 PN->dropAllReferences();
1462 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1463 LI->dropAllReferences();
1464 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001465
Victor Hernandez83d63912009-09-18 22:35:49 +00001466 // Delete all the phis and loads now that inter-references are dead.
1467 for (DenseMap<Value*, std::vector<Value*> >::iterator
1468 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1469 I != E; ++I) {
1470 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1471 PN->eraseFromParent();
1472 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1473 LI->eraseFromParent();
1474 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001475
Victor Hernandez83d63912009-09-18 22:35:49 +00001476 // The old global is now dead, remove it.
1477 GV->eraseFromParent();
1478
1479 ++NumHeapSRA;
1480 return cast<GlobalVariable>(FieldGlobals[0]);
1481}
1482
Chris Lattnere61d0a62008-12-15 21:02:25 +00001483/// TryToOptimizeStoreOfMallocToGlobal - This function is called when we see a
1484/// pointer global variable with a single value stored it that is a malloc or
1485/// cast of malloc.
1486static bool TryToOptimizeStoreOfMallocToGlobal(GlobalVariable *GV,
Victor Hernandez83d63912009-09-18 22:35:49 +00001487 CallInst *CI,
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001488 const Type *AllocTy,
Victor Hernandez83d63912009-09-18 22:35:49 +00001489 Module::global_iterator &GVI,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001490 TargetData *TD) {
Evan Cheng86cd4452010-04-14 20:52:55 +00001491 if (!TD)
1492 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001493
Victor Hernandez83d63912009-09-18 22:35:49 +00001494 // If this is a malloc of an abstract type, don't touch it.
1495 if (!AllocTy->isSized())
1496 return false;
1497
1498 // We can't optimize this global unless all uses of it are *known* to be
1499 // of the malloc value, not of the null initializer value (consider a use
1500 // that compares the global's value against zero to see if the malloc has
1501 // been reached). To do this, we check to see if all uses of the global
1502 // would trap if the global were null: this proves that they must all
1503 // happen after the malloc.
1504 if (!AllUsesOfLoadedValueWillTrapIfNull(GV))
1505 return false;
1506
1507 // We can't optimize this if the malloc itself is used in a complex way,
1508 // for example, being stored into multiple globals. This allows the
1509 // malloc to be stored into the specified global, loaded setcc'd, and
1510 // GEP'd. These are all things we could transform to using the global
1511 // for.
Evan Cheng86cd4452010-04-14 20:52:55 +00001512 SmallPtrSet<const PHINode*, 8> PHIs;
1513 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(CI, GV, PHIs))
1514 return false;
Victor Hernandez83d63912009-09-18 22:35:49 +00001515
1516 // If we have a global that is only initialized with a fixed size malloc,
1517 // transform the program to use global memory instead of malloc'd memory.
1518 // This eliminates dynamic allocation, avoids an indirection accessing the
1519 // data, and exposes the resultant global to further GlobalOpt.
Victor Hernandez8db42d22009-10-16 23:12:25 +00001520 // We cannot optimize the malloc if we cannot determine malloc array size.
Evan Cheng86cd4452010-04-14 20:52:55 +00001521 Value *NElems = getMallocArraySize(CI, TD, true);
1522 if (!NElems)
1523 return false;
Victor Hernandez83d63912009-09-18 22:35:49 +00001524
Evan Cheng86cd4452010-04-14 20:52:55 +00001525 if (ConstantInt *NElements = dyn_cast<ConstantInt>(NElems))
1526 // Restrict this transformation to only working on small allocations
1527 // (2048 bytes currently), as we don't want to introduce a 16M global or
1528 // something.
1529 if (NElements->getZExtValue() * TD->getTypeAllocSize(AllocTy) < 2048) {
1530 GVI = OptimizeGlobalAddressOfMalloc(GV, CI, AllocTy, NElements, TD);
1531 return true;
Victor Hernandez83d63912009-09-18 22:35:49 +00001532 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001533
Evan Cheng86cd4452010-04-14 20:52:55 +00001534 // If the allocation is an array of structures, consider transforming this
1535 // into multiple malloc'd arrays, one for each field. This is basically
1536 // SRoA for malloc'd memory.
1537
1538 // If this is an allocation of a fixed size array of structs, analyze as a
1539 // variable size array. malloc [100 x struct],1 -> malloc struct, 100
Gabor Greif9e4f2432010-06-24 14:42:01 +00001540 if (NElems == ConstantInt::get(CI->getArgOperand(0)->getType(), 1))
Evan Cheng86cd4452010-04-14 20:52:55 +00001541 if (const ArrayType *AT = dyn_cast<ArrayType>(AllocTy))
1542 AllocTy = AT->getElementType();
Gabor Greif9e4f2432010-06-24 14:42:01 +00001543
Evan Cheng86cd4452010-04-14 20:52:55 +00001544 const StructType *AllocSTy = dyn_cast<StructType>(AllocTy);
1545 if (!AllocSTy)
1546 return false;
1547
1548 // This the structure has an unreasonable number of fields, leave it
1549 // alone.
1550 if (AllocSTy->getNumElements() <= 16 && AllocSTy->getNumElements() != 0 &&
1551 AllGlobalLoadUsesSimpleEnoughForHeapSRA(GV, CI)) {
1552
1553 // If this is a fixed size array, transform the Malloc to be an alloc of
1554 // structs. malloc [100 x struct],1 -> malloc struct, 100
1555 if (const ArrayType *AT = dyn_cast<ArrayType>(getMallocAllocatedType(CI))) {
1556 const Type *IntPtrTy = TD->getIntPtrType(CI->getContext());
1557 unsigned TypeSize = TD->getStructLayout(AllocSTy)->getSizeInBytes();
1558 Value *AllocSize = ConstantInt::get(IntPtrTy, TypeSize);
1559 Value *NumElements = ConstantInt::get(IntPtrTy, AT->getNumElements());
1560 Instruction *Malloc = CallInst::CreateMalloc(CI, IntPtrTy, AllocSTy,
1561 AllocSize, NumElements,
Chris Lattner5a30a852010-07-12 00:57:28 +00001562 0, CI->getName());
Evan Cheng86cd4452010-04-14 20:52:55 +00001563 Instruction *Cast = new BitCastInst(Malloc, CI->getType(), "tmp", CI);
1564 CI->replaceAllUsesWith(Cast);
1565 CI->eraseFromParent();
1566 CI = dyn_cast<BitCastInst>(Malloc) ?
1567 extractMallocCallFromBitCast(Malloc) : cast<CallInst>(Malloc);
1568 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001569
Evan Cheng86cd4452010-04-14 20:52:55 +00001570 GVI = PerformHeapAllocSRoA(GV, CI, getMallocArraySize(CI, TD, true),TD);
1571 return true;
Victor Hernandez83d63912009-09-18 22:35:49 +00001572 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001573
Victor Hernandez83d63912009-09-18 22:35:49 +00001574 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001575}
Victor Hernandez83d63912009-09-18 22:35:49 +00001576
Chris Lattner9b34a612004-10-09 21:48:45 +00001577// OptimizeOnceStoredGlobal - Try to optimize globals based on the knowledge
1578// that only one value (besides its initializer) is ever stored to the global.
Chris Lattner30ba5692004-10-11 05:54:41 +00001579static bool OptimizeOnceStoredGlobal(GlobalVariable *GV, Value *StoredOnceVal,
Chris Lattner7f8897f2006-08-27 22:42:52 +00001580 Module::global_iterator &GVI,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001581 TargetData *TD) {
Chris Lattner344b41c2008-12-15 21:20:32 +00001582 // Ignore no-op GEPs and bitcasts.
1583 StoredOnceVal = StoredOnceVal->stripPointerCasts();
Chris Lattner9b34a612004-10-09 21:48:45 +00001584
Chris Lattner708148e2004-10-10 23:14:11 +00001585 // If we are dealing with a pointer global that is initialized to null and
1586 // only has one (non-null) value stored into it, then we can optimize any
1587 // users of the loaded value (often calls and loads) that would trap if the
1588 // value was null.
Duncan Sands1df98592010-02-16 11:11:14 +00001589 if (GV->getInitializer()->getType()->isPointerTy() &&
Chris Lattner9b34a612004-10-09 21:48:45 +00001590 GV->getInitializer()->isNullValue()) {
Chris Lattner708148e2004-10-10 23:14:11 +00001591 if (Constant *SOVC = dyn_cast<Constant>(StoredOnceVal)) {
1592 if (GV->getInitializer()->getType() != SOVC->getType())
Chris Lattner98a42b22011-05-22 07:15:13 +00001593 SOVC = ConstantExpr::getBitCast(SOVC, GV->getInitializer()->getType());
Misha Brukmanfd939082005-04-21 23:48:37 +00001594
Chris Lattner708148e2004-10-10 23:14:11 +00001595 // Optimize away any trapping uses of the loaded value.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001596 if (OptimizeAwayTrappingUsesOfLoads(GV, SOVC))
Chris Lattner8be80122004-10-10 17:07:12 +00001597 return true;
Victor Hernandez83d63912009-09-18 22:35:49 +00001598 } else if (CallInst *CI = extractMallocCall(StoredOnceVal)) {
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001599 const Type* MallocType = getMallocAllocatedType(CI);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001600 if (MallocType && TryToOptimizeStoreOfMallocToGlobal(GV, CI, MallocType,
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001601 GVI, TD))
1602 return true;
Chris Lattner708148e2004-10-10 23:14:11 +00001603 }
Chris Lattner9b34a612004-10-09 21:48:45 +00001604 }
Chris Lattner30ba5692004-10-11 05:54:41 +00001605
Chris Lattner9b34a612004-10-09 21:48:45 +00001606 return false;
1607}
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001608
Chris Lattner58e44f42008-01-14 01:17:44 +00001609/// TryToShrinkGlobalToBoolean - At this point, we have learned that the only
1610/// two values ever stored into GV are its initializer and OtherVal. See if we
1611/// can shrink the global into a boolean and select between the two values
1612/// whenever it is used. This exposes the values to other scalar optimizations.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001613static bool TryToShrinkGlobalToBoolean(GlobalVariable *GV, Constant *OtherVal) {
Chris Lattner58e44f42008-01-14 01:17:44 +00001614 const Type *GVElType = GV->getType()->getElementType();
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001615
Chris Lattner58e44f42008-01-14 01:17:44 +00001616 // If GVElType is already i1, it is already shrunk. If the type of the GV is
Chris Lattner6f6923f2009-03-07 23:32:02 +00001617 // an FP value, pointer or vector, don't do this optimization because a select
1618 // between them is very expensive and unlikely to lead to later
1619 // simplification. In these cases, we typically end up with "cond ? v1 : v2"
1620 // where v1 and v2 both require constant pool loads, a big loss.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001621 if (GVElType == Type::getInt1Ty(GV->getContext()) ||
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00001622 GVElType->isFloatingPointTy() ||
Duncan Sands1df98592010-02-16 11:11:14 +00001623 GVElType->isPointerTy() || GVElType->isVectorTy())
Chris Lattner58e44f42008-01-14 01:17:44 +00001624 return false;
Gabor Greifaaaaa022010-07-12 14:13:15 +00001625
Chris Lattner58e44f42008-01-14 01:17:44 +00001626 // Walk the use list of the global seeing if all the uses are load or store.
1627 // If there is anything else, bail out.
Gabor Greifaaaaa022010-07-12 14:13:15 +00001628 for (Value::use_iterator I = GV->use_begin(), E = GV->use_end(); I != E; ++I){
1629 User *U = *I;
1630 if (!isa<LoadInst>(U) && !isa<StoreInst>(U))
Chris Lattner58e44f42008-01-14 01:17:44 +00001631 return false;
Gabor Greifaaaaa022010-07-12 14:13:15 +00001632 }
1633
David Greene3215b0e2010-01-05 01:28:05 +00001634 DEBUG(dbgs() << " *** SHRINKING TO BOOL: " << *GV);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001635
Chris Lattner96a86b22004-12-12 05:53:50 +00001636 // Create the new global, initializing it to false.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001637 GlobalVariable *NewGV = new GlobalVariable(Type::getInt1Ty(GV->getContext()),
1638 false,
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001639 GlobalValue::InternalLinkage,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001640 ConstantInt::getFalse(GV->getContext()),
Nick Lewycky0e670df2009-05-03 03:49:08 +00001641 GV->getName()+".b",
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00001642 GV->isThreadLocal());
Chris Lattner96a86b22004-12-12 05:53:50 +00001643 GV->getParent()->getGlobalList().insert(GV, NewGV);
1644
1645 Constant *InitVal = GV->getInitializer();
Chris Lattner7b550cc2009-11-06 04:27:31 +00001646 assert(InitVal->getType() != Type::getInt1Ty(GV->getContext()) &&
Owen Anderson1d0be152009-08-13 21:58:54 +00001647 "No reason to shrink to bool!");
Chris Lattner96a86b22004-12-12 05:53:50 +00001648
1649 // If initialized to zero and storing one into the global, we can use a cast
1650 // instead of a select to synthesize the desired value.
1651 bool IsOneZero = false;
1652 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal))
Reid Spencercae57542007-03-02 00:28:52 +00001653 IsOneZero = InitVal->isNullValue() && CI->isOne();
Chris Lattner96a86b22004-12-12 05:53:50 +00001654
1655 while (!GV->use_empty()) {
Devang Patel771281f2009-03-06 01:39:36 +00001656 Instruction *UI = cast<Instruction>(GV->use_back());
1657 if (StoreInst *SI = dyn_cast<StoreInst>(UI)) {
Chris Lattner96a86b22004-12-12 05:53:50 +00001658 // Change the store into a boolean store.
1659 bool StoringOther = SI->getOperand(0) == OtherVal;
1660 // Only do this if we weren't storing a loaded value.
Chris Lattner38c25562004-12-12 19:34:41 +00001661 Value *StoreVal;
Chris Lattner96a86b22004-12-12 05:53:50 +00001662 if (StoringOther || SI->getOperand(0) == InitVal)
Chris Lattner7b550cc2009-11-06 04:27:31 +00001663 StoreVal = ConstantInt::get(Type::getInt1Ty(GV->getContext()),
1664 StoringOther);
Chris Lattner38c25562004-12-12 19:34:41 +00001665 else {
1666 // Otherwise, we are storing a previously loaded copy. To do this,
1667 // change the copy from copying the original value to just copying the
1668 // bool.
1669 Instruction *StoredVal = cast<Instruction>(SI->getOperand(0));
1670
Gabor Greif9e4f2432010-06-24 14:42:01 +00001671 // If we've already replaced the input, StoredVal will be a cast or
Chris Lattner38c25562004-12-12 19:34:41 +00001672 // select instruction. If not, it will be a load of the original
1673 // global.
1674 if (LoadInst *LI = dyn_cast<LoadInst>(StoredVal)) {
1675 assert(LI->getOperand(0) == GV && "Not a copy!");
1676 // Insert a new load, to preserve the saved value.
1677 StoreVal = new LoadInst(NewGV, LI->getName()+".b", LI);
1678 } else {
1679 assert((isa<CastInst>(StoredVal) || isa<SelectInst>(StoredVal)) &&
1680 "This is not a form that we understand!");
1681 StoreVal = StoredVal->getOperand(0);
1682 assert(isa<LoadInst>(StoreVal) && "Not a load of NewGV!");
1683 }
1684 }
1685 new StoreInst(StoreVal, NewGV, SI);
Devang Patel771281f2009-03-06 01:39:36 +00001686 } else {
Chris Lattner96a86b22004-12-12 05:53:50 +00001687 // Change the load into a load of bool then a select.
Devang Patel771281f2009-03-06 01:39:36 +00001688 LoadInst *LI = cast<LoadInst>(UI);
Chris Lattner046800a2007-02-11 01:08:35 +00001689 LoadInst *NLI = new LoadInst(NewGV, LI->getName()+".b", LI);
Chris Lattner96a86b22004-12-12 05:53:50 +00001690 Value *NSI;
1691 if (IsOneZero)
Chris Lattner046800a2007-02-11 01:08:35 +00001692 NSI = new ZExtInst(NLI, LI->getType(), "", LI);
Misha Brukmanfd939082005-04-21 23:48:37 +00001693 else
Gabor Greif051a9502008-04-06 20:25:17 +00001694 NSI = SelectInst::Create(NLI, OtherVal, InitVal, "", LI);
Chris Lattner046800a2007-02-11 01:08:35 +00001695 NSI->takeName(LI);
Chris Lattner96a86b22004-12-12 05:53:50 +00001696 LI->replaceAllUsesWith(NSI);
Devang Patel771281f2009-03-06 01:39:36 +00001697 }
1698 UI->eraseFromParent();
Chris Lattner96a86b22004-12-12 05:53:50 +00001699 }
1700
1701 GV->eraseFromParent();
Chris Lattner58e44f42008-01-14 01:17:44 +00001702 return true;
Chris Lattner96a86b22004-12-12 05:53:50 +00001703}
1704
1705
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001706/// ProcessInternalGlobal - Analyze the specified global variable and optimize
1707/// it if possible. If we make a change, return true.
Rafael Espindolac4440e32011-01-19 16:32:21 +00001708bool GlobalOpt::ProcessGlobal(GlobalVariable *GV,
1709 Module::global_iterator &GVI) {
1710 if (!GV->hasLocalLinkage())
1711 return false;
1712
1713 // Do more involved optimizations if the global is internal.
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001714 GV->removeDeadConstantUsers();
1715
1716 if (GV->use_empty()) {
David Greene3215b0e2010-01-05 01:28:05 +00001717 DEBUG(dbgs() << "GLOBAL DEAD: " << *GV);
Chris Lattner7a7ed022004-10-16 18:09:00 +00001718 GV->eraseFromParent();
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001719 ++NumDeleted;
1720 return true;
1721 }
1722
Rafael Espindolac4440e32011-01-19 16:32:21 +00001723 SmallPtrSet<const PHINode*, 16> PHIUsers;
1724 GlobalStatus GS;
1725
Rafael Espindoladaad56a2011-01-18 04:36:06 +00001726 if (AnalyzeGlobal(GV, GS, PHIUsers))
1727 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001728
Rafael Espindolac4440e32011-01-19 16:32:21 +00001729 if (!GS.isCompared && !GV->hasUnnamedAddr()) {
1730 GV->setUnnamedAddr(true);
1731 NumUnnamed++;
1732 }
1733
1734 if (GV->isConstant() || !GV->hasInitializer())
1735 return false;
1736
1737 return ProcessInternalGlobal(GV, GVI, PHIUsers, GS);
1738}
1739
1740/// ProcessInternalGlobal - Analyze the specified global variable and optimize
1741/// it if possible. If we make a change, return true.
1742bool GlobalOpt::ProcessInternalGlobal(GlobalVariable *GV,
1743 Module::global_iterator &GVI,
1744 const SmallPtrSet<const PHINode*, 16> &PHIUsers,
1745 const GlobalStatus &GS) {
Rafael Espindoladaad56a2011-01-18 04:36:06 +00001746 // If this is a first class global and has only one accessing function
1747 // and this function is main (which we know is not recursive we can make
1748 // this global a local variable) we replace the global with a local alloca
1749 // in this function.
1750 //
1751 // NOTE: It doesn't make sense to promote non single-value types since we
1752 // are just replacing static memory to stack memory.
1753 //
1754 // If the global is in different address space, don't bring it to stack.
1755 if (!GS.HasMultipleAccessingFunctions &&
1756 GS.AccessingFunction && !GS.HasNonInstructionUser &&
1757 GV->getType()->getElementType()->isSingleValueType() &&
1758 GS.AccessingFunction->getName() == "main" &&
1759 GS.AccessingFunction->hasExternalLinkage() &&
1760 GV->getType()->getAddressSpace() == 0) {
1761 DEBUG(dbgs() << "LOCALIZING GLOBAL: " << *GV);
1762 Instruction& FirstI = const_cast<Instruction&>(*GS.AccessingFunction
1763 ->getEntryBlock().begin());
1764 const Type* ElemTy = GV->getType()->getElementType();
1765 // FIXME: Pass Global's alignment when globals have alignment
1766 AllocaInst* Alloca = new AllocaInst(ElemTy, NULL, GV->getName(), &FirstI);
1767 if (!isa<UndefValue>(GV->getInitializer()))
1768 new StoreInst(GV->getInitializer(), Alloca, &FirstI);
Misha Brukmanfd939082005-04-21 23:48:37 +00001769
Rafael Espindoladaad56a2011-01-18 04:36:06 +00001770 GV->replaceAllUsesWith(Alloca);
1771 GV->eraseFromParent();
1772 ++NumLocalized;
1773 return true;
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001774 }
Rafael Espindoladaad56a2011-01-18 04:36:06 +00001775
1776 // If the global is never loaded (but may be stored to), it is dead.
1777 // Delete it now.
1778 if (!GS.isLoaded) {
1779 DEBUG(dbgs() << "GLOBAL NEVER LOADED: " << *GV);
1780
1781 // Delete any stores we can find to the global. We may not be able to
1782 // make it completely dead though.
1783 bool Changed = CleanupConstantGlobalUsers(GV, GV->getInitializer());
1784
1785 // If the global is dead now, delete it.
1786 if (GV->use_empty()) {
1787 GV->eraseFromParent();
1788 ++NumDeleted;
1789 Changed = true;
1790 }
1791 return Changed;
1792
1793 } else if (GS.StoredType <= GlobalStatus::isInitializerStored) {
1794 DEBUG(dbgs() << "MARKING CONSTANT: " << *GV);
1795 GV->setConstant(true);
1796
1797 // Clean up any obviously simplifiable users now.
1798 CleanupConstantGlobalUsers(GV, GV->getInitializer());
1799
1800 // If the global is dead now, just nuke it.
1801 if (GV->use_empty()) {
1802 DEBUG(dbgs() << " *** Marking constant allowed us to simplify "
1803 << "all users and delete global!\n");
1804 GV->eraseFromParent();
1805 ++NumDeleted;
1806 }
1807
1808 ++NumMarked;
1809 return true;
1810 } else if (!GV->getInitializer()->getType()->isSingleValueType()) {
1811 if (TargetData *TD = getAnalysisIfAvailable<TargetData>())
1812 if (GlobalVariable *FirstNewGV = SRAGlobal(GV, *TD)) {
1813 GVI = FirstNewGV; // Don't skip the newly produced globals!
1814 return true;
1815 }
1816 } else if (GS.StoredType == GlobalStatus::isStoredOnce) {
1817 // If the initial value for the global was an undef value, and if only
1818 // one other value was stored into it, we can just change the
1819 // initializer to be the stored value, then delete all stores to the
1820 // global. This allows us to mark it constant.
1821 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1822 if (isa<UndefValue>(GV->getInitializer())) {
1823 // Change the initial value here.
1824 GV->setInitializer(SOVConstant);
1825
1826 // Clean up any obviously simplifiable users now.
1827 CleanupConstantGlobalUsers(GV, GV->getInitializer());
1828
1829 if (GV->use_empty()) {
1830 DEBUG(dbgs() << " *** Substituting initializer allowed us to "
1831 << "simplify all users and delete global!\n");
1832 GV->eraseFromParent();
1833 ++NumDeleted;
1834 } else {
1835 GVI = GV;
1836 }
1837 ++NumSubstitute;
1838 return true;
1839 }
1840
1841 // Try to optimize globals based on the knowledge that only one value
1842 // (besides its initializer) is ever stored to the global.
1843 if (OptimizeOnceStoredGlobal(GV, GS.StoredOnceValue, GVI,
1844 getAnalysisIfAvailable<TargetData>()))
1845 return true;
1846
1847 // Otherwise, if the global was not a boolean, we can shrink it to be a
1848 // boolean.
1849 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1850 if (TryToShrinkGlobalToBoolean(GV, SOVConstant)) {
1851 ++NumShrunkToBool;
1852 return true;
1853 }
1854 }
1855
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001856 return false;
1857}
1858
Chris Lattnerfb217ad2005-05-08 22:18:06 +00001859/// ChangeCalleesToFastCall - Walk all of the direct calls of the specified
1860/// function, changing them to FastCC.
1861static void ChangeCalleesToFastCall(Function *F) {
1862 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
Duncan Sands548448a2008-02-18 17:32:13 +00001863 CallSite User(cast<Instruction>(*UI));
1864 User.setCallingConv(CallingConv::Fast);
Chris Lattnerfb217ad2005-05-08 22:18:06 +00001865 }
1866}
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001867
Devang Patel05988662008-09-25 21:00:45 +00001868static AttrListPtr StripNest(const AttrListPtr &Attrs) {
Chris Lattner58d74912008-03-12 17:45:29 +00001869 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Devang Patel05988662008-09-25 21:00:45 +00001870 if ((Attrs.getSlot(i).Attrs & Attribute::Nest) == 0)
Duncan Sands548448a2008-02-18 17:32:13 +00001871 continue;
1872
Duncan Sands548448a2008-02-18 17:32:13 +00001873 // There can be only one.
Devang Patel05988662008-09-25 21:00:45 +00001874 return Attrs.removeAttr(Attrs.getSlot(i).Index, Attribute::Nest);
Duncan Sands3d5378f2008-02-16 20:56:04 +00001875 }
1876
1877 return Attrs;
1878}
1879
1880static void RemoveNestAttribute(Function *F) {
Devang Patel05988662008-09-25 21:00:45 +00001881 F->setAttributes(StripNest(F->getAttributes()));
Duncan Sands3d5378f2008-02-16 20:56:04 +00001882 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
Duncan Sands548448a2008-02-18 17:32:13 +00001883 CallSite User(cast<Instruction>(*UI));
Devang Patel05988662008-09-25 21:00:45 +00001884 User.setAttributes(StripNest(User.getAttributes()));
Duncan Sands3d5378f2008-02-16 20:56:04 +00001885 }
1886}
1887
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001888bool GlobalOpt::OptimizeFunctions(Module &M) {
1889 bool Changed = false;
1890 // Optimize functions.
1891 for (Module::iterator FI = M.begin(), E = M.end(); FI != E; ) {
1892 Function *F = FI++;
Duncan Sandsfc5940d2009-03-06 10:21:56 +00001893 // Functions without names cannot be referenced outside this module.
1894 if (!F->hasName() && !F->isDeclaration())
1895 F->setLinkage(GlobalValue::InternalLinkage);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001896 F->removeDeadConstantUsers();
Chris Lattnerec4c7b92009-11-01 19:03:42 +00001897 if (F->use_empty() && (F->hasLocalLinkage() || F->hasLinkOnceLinkage())) {
1898 F->eraseFromParent();
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001899 Changed = true;
1900 ++NumFnDeleted;
Rafael Espindolabb46f522009-01-15 20:18:42 +00001901 } else if (F->hasLocalLinkage()) {
Duncan Sands3d5378f2008-02-16 20:56:04 +00001902 if (F->getCallingConv() == CallingConv::C && !F->isVarArg() &&
Jay Foad757068f2009-06-10 08:41:11 +00001903 !F->hasAddressTaken()) {
Duncan Sands3d5378f2008-02-16 20:56:04 +00001904 // If this function has C calling conventions, is not a varargs
1905 // function, and is only called directly, promote it to use the Fast
1906 // calling convention.
1907 F->setCallingConv(CallingConv::Fast);
1908 ChangeCalleesToFastCall(F);
1909 ++NumFastCallFns;
1910 Changed = true;
1911 }
1912
Devang Patel05988662008-09-25 21:00:45 +00001913 if (F->getAttributes().hasAttrSomewhere(Attribute::Nest) &&
Jay Foad757068f2009-06-10 08:41:11 +00001914 !F->hasAddressTaken()) {
Duncan Sands3d5378f2008-02-16 20:56:04 +00001915 // The function is not used by a trampoline intrinsic, so it is safe
1916 // to remove the 'nest' attribute.
1917 RemoveNestAttribute(F);
1918 ++NumNestRemoved;
1919 Changed = true;
1920 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001921 }
1922 }
1923 return Changed;
1924}
1925
1926bool GlobalOpt::OptimizeGlobalVars(Module &M) {
1927 bool Changed = false;
1928 for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
1929 GVI != E; ) {
1930 GlobalVariable *GV = GVI++;
Duncan Sandsfc5940d2009-03-06 10:21:56 +00001931 // Global variables without names cannot be referenced outside this module.
1932 if (!GV->hasName() && !GV->isDeclaration())
1933 GV->setLinkage(GlobalValue::InternalLinkage);
Dan Gohman01b97dd2009-11-23 16:22:21 +00001934 // Simplify the initializer.
1935 if (GV->hasInitializer())
1936 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GV->getInitializer())) {
Dan Gohmanf860db22010-04-02 03:04:37 +00001937 TargetData *TD = getAnalysisIfAvailable<TargetData>();
Dan Gohman01b97dd2009-11-23 16:22:21 +00001938 Constant *New = ConstantFoldConstantExpression(CE, TD);
1939 if (New && New != CE)
1940 GV->setInitializer(New);
1941 }
Rafael Espindolac4440e32011-01-19 16:32:21 +00001942
1943 Changed |= ProcessGlobal(GV, GVI);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001944 }
1945 return Changed;
1946}
1947
Nick Lewycky2c44a802011-04-08 07:30:21 +00001948/// FindGlobalCtors - Find the llvm.global_ctors list, verifying that all
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001949/// initializers have an init priority of 65535.
1950GlobalVariable *GlobalOpt::FindGlobalCtors(Module &M) {
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001951 GlobalVariable *GV = M.getGlobalVariable("llvm.global_ctors");
1952 if (GV == 0) return 0;
1953
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001954 // Verify that the initializer is simple enough for us to handle. We are
1955 // only allowed to optimize the initializer if it is unique.
1956 if (!GV->hasUniqueInitializer()) return 0;
Nick Lewycky5ea5c612011-04-11 22:11:20 +00001957
1958 if (isa<ConstantAggregateZero>(GV->getInitializer()))
1959 return GV;
1960 ConstantArray *CA = cast<ConstantArray>(GV->getInitializer());
Eli Friedman18a2e502011-04-09 09:11:09 +00001961
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001962 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i) {
Nick Lewycky5ea5c612011-04-11 22:11:20 +00001963 if (isa<ConstantAggregateZero>(*i))
1964 continue;
1965 ConstantStruct *CS = cast<ConstantStruct>(*i);
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001966 if (isa<ConstantPointerNull>(CS->getOperand(1)))
1967 continue;
Chris Lattner7d8e58f2005-09-26 02:19:27 +00001968
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001969 // Must have a function or null ptr.
1970 if (!isa<Function>(CS->getOperand(1)))
1971 return 0;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001972
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001973 // Init priority must be standard.
Nick Lewycky2c44a802011-04-08 07:30:21 +00001974 ConstantInt *CI = cast<ConstantInt>(CS->getOperand(0));
1975 if (CI->getZExtValue() != 65535)
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001976 return 0;
1977 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001978
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001979 return GV;
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001980}
1981
Chris Lattnerdb973e62005-09-26 02:31:18 +00001982/// ParseGlobalCtors - Given a llvm.global_ctors list that we can understand,
1983/// return a list of the functions and null terminator as a vector.
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001984static std::vector<Function*> ParseGlobalCtors(GlobalVariable *GV) {
Nick Lewycky5ea5c612011-04-11 22:11:20 +00001985 if (GV->getInitializer()->isNullValue())
1986 return std::vector<Function*>();
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001987 ConstantArray *CA = cast<ConstantArray>(GV->getInitializer());
1988 std::vector<Function*> Result;
1989 Result.reserve(CA->getNumOperands());
Gabor Greif5e463212008-05-29 01:59:18 +00001990 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i) {
1991 ConstantStruct *CS = cast<ConstantStruct>(*i);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001992 Result.push_back(dyn_cast<Function>(CS->getOperand(1)));
1993 }
1994 return Result;
1995}
1996
Chris Lattnerdb973e62005-09-26 02:31:18 +00001997/// InstallGlobalCtors - Given a specified llvm.global_ctors list, install the
1998/// specified array, returning the new global to use.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001999static GlobalVariable *InstallGlobalCtors(GlobalVariable *GCL,
Chris Lattner7b550cc2009-11-06 04:27:31 +00002000 const std::vector<Function*> &Ctors) {
Chris Lattnerdb973e62005-09-26 02:31:18 +00002001 // If we made a change, reassemble the initializer list.
Chris Lattnerb065b062011-06-20 04:01:31 +00002002 Constant *CSVals[2];
2003 CSVals[0] = ConstantInt::get(Type::getInt32Ty(GCL->getContext()), 65535);
2004 CSVals[1] = 0;
2005
2006 const StructType *StructTy =
2007 cast <StructType>(
2008 cast<ArrayType>(GCL->getType()->getElementType())->getElementType());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002009
Chris Lattnerdb973e62005-09-26 02:31:18 +00002010 // Create the new init list.
2011 std::vector<Constant*> CAList;
2012 for (unsigned i = 0, e = Ctors.size(); i != e; ++i) {
Chris Lattner79c11012005-09-26 04:44:35 +00002013 if (Ctors[i]) {
Chris Lattnerdb973e62005-09-26 02:31:18 +00002014 CSVals[1] = Ctors[i];
Chris Lattner79c11012005-09-26 04:44:35 +00002015 } else {
Chris Lattner7b550cc2009-11-06 04:27:31 +00002016 const Type *FTy = FunctionType::get(Type::getVoidTy(GCL->getContext()),
2017 false);
Owen Andersondebcb012009-07-29 22:17:13 +00002018 const PointerType *PFTy = PointerType::getUnqual(FTy);
Owen Andersona7235ea2009-07-31 20:28:14 +00002019 CSVals[1] = Constant::getNullValue(PFTy);
Chris Lattner7b550cc2009-11-06 04:27:31 +00002020 CSVals[0] = ConstantInt::get(Type::getInt32Ty(GCL->getContext()),
Nick Lewycky5ea5c612011-04-11 22:11:20 +00002021 0x7fffffff);
Chris Lattnerdb973e62005-09-26 02:31:18 +00002022 }
Chris Lattnerb065b062011-06-20 04:01:31 +00002023 CAList.push_back(ConstantStruct::get(StructTy, CSVals));
Chris Lattnerdb973e62005-09-26 02:31:18 +00002024 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002025
Chris Lattnerdb973e62005-09-26 02:31:18 +00002026 // Create the array initializer.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002027 Constant *CA = ConstantArray::get(ArrayType::get(StructTy,
Nick Lewyckyc332fba2009-09-19 20:30:26 +00002028 CAList.size()), CAList);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002029
Chris Lattnerdb973e62005-09-26 02:31:18 +00002030 // If we didn't change the number of elements, don't create a new GV.
2031 if (CA->getType() == GCL->getInitializer()->getType()) {
2032 GCL->setInitializer(CA);
2033 return GCL;
2034 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002035
Chris Lattnerdb973e62005-09-26 02:31:18 +00002036 // Create the new global and insert it next to the existing list.
Chris Lattner7b550cc2009-11-06 04:27:31 +00002037 GlobalVariable *NGV = new GlobalVariable(CA->getType(), GCL->isConstant(),
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00002038 GCL->getLinkage(), CA, "",
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00002039 GCL->isThreadLocal());
Chris Lattnerdb973e62005-09-26 02:31:18 +00002040 GCL->getParent()->getGlobalList().insert(GCL, NGV);
Chris Lattner046800a2007-02-11 01:08:35 +00002041 NGV->takeName(GCL);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002042
Chris Lattnerdb973e62005-09-26 02:31:18 +00002043 // Nuke the old list, replacing any uses with the new one.
2044 if (!GCL->use_empty()) {
2045 Constant *V = NGV;
2046 if (V->getType() != GCL->getType())
Owen Andersonbaf3c402009-07-29 18:55:55 +00002047 V = ConstantExpr::getBitCast(V, GCL->getType());
Chris Lattnerdb973e62005-09-26 02:31:18 +00002048 GCL->replaceAllUsesWith(V);
2049 }
2050 GCL->eraseFromParent();
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002051
Chris Lattnerdb973e62005-09-26 02:31:18 +00002052 if (Ctors.size())
2053 return NGV;
2054 else
2055 return 0;
2056}
Chris Lattner79c11012005-09-26 04:44:35 +00002057
2058
Chris Lattner1945d582010-12-07 04:33:29 +00002059static Constant *getVal(DenseMap<Value*, Constant*> &ComputedValues, Value *V) {
Chris Lattner79c11012005-09-26 04:44:35 +00002060 if (Constant *CV = dyn_cast<Constant>(V)) return CV;
2061 Constant *R = ComputedValues[V];
2062 assert(R && "Reference to an uncomputed value!");
2063 return R;
2064}
2065
Chris Lattner1945d582010-12-07 04:33:29 +00002066static inline bool
2067isSimpleEnoughValueToCommit(Constant *C,
2068 SmallPtrSet<Constant*, 8> &SimpleConstants);
2069
2070
2071/// isSimpleEnoughValueToCommit - Return true if the specified constant can be
2072/// handled by the code generator. We don't want to generate something like:
2073/// void *X = &X/42;
2074/// because the code generator doesn't have a relocation that can handle that.
2075///
2076/// This function should be called if C was not found (but just got inserted)
2077/// in SimpleConstants to avoid having to rescan the same constants all the
2078/// time.
2079static bool isSimpleEnoughValueToCommitHelper(Constant *C,
2080 SmallPtrSet<Constant*, 8> &SimpleConstants) {
2081 // Simple integer, undef, constant aggregate zero, global addresses, etc are
2082 // all supported.
2083 if (C->getNumOperands() == 0 || isa<BlockAddress>(C) ||
2084 isa<GlobalValue>(C))
2085 return true;
2086
2087 // Aggregate values are safe if all their elements are.
2088 if (isa<ConstantArray>(C) || isa<ConstantStruct>(C) ||
2089 isa<ConstantVector>(C)) {
2090 for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i) {
2091 Constant *Op = cast<Constant>(C->getOperand(i));
2092 if (!isSimpleEnoughValueToCommit(Op, SimpleConstants))
2093 return false;
2094 }
2095 return true;
2096 }
2097
2098 // We don't know exactly what relocations are allowed in constant expressions,
2099 // so we allow &global+constantoffset, which is safe and uniformly supported
2100 // across targets.
2101 ConstantExpr *CE = cast<ConstantExpr>(C);
2102 switch (CE->getOpcode()) {
2103 case Instruction::BitCast:
2104 case Instruction::IntToPtr:
2105 case Instruction::PtrToInt:
2106 // These casts are always fine if the casted value is.
2107 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants);
2108
2109 // GEP is fine if it is simple + constant offset.
2110 case Instruction::GetElementPtr:
2111 for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
2112 if (!isa<ConstantInt>(CE->getOperand(i)))
2113 return false;
2114 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants);
2115
2116 case Instruction::Add:
2117 // We allow simple+cst.
2118 if (!isa<ConstantInt>(CE->getOperand(1)))
2119 return false;
2120 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants);
2121 }
2122 return false;
2123}
2124
2125static inline bool
2126isSimpleEnoughValueToCommit(Constant *C,
2127 SmallPtrSet<Constant*, 8> &SimpleConstants) {
2128 // If we already checked this constant, we win.
2129 if (!SimpleConstants.insert(C)) return true;
2130 // Check the constant.
2131 return isSimpleEnoughValueToCommitHelper(C, SimpleConstants);
2132}
2133
2134
Chris Lattner79c11012005-09-26 04:44:35 +00002135/// isSimpleEnoughPointerToCommit - Return true if this constant is simple
Owen Andersoncff6b372011-01-14 22:19:20 +00002136/// enough for us to understand. In particular, if it is a cast to anything
2137/// other than from one pointer type to another pointer type, we punt.
2138/// We basically just support direct accesses to globals and GEP's of
Chris Lattner79c11012005-09-26 04:44:35 +00002139/// globals. This should be kept up to date with CommitValueTo.
Chris Lattner7b550cc2009-11-06 04:27:31 +00002140static bool isSimpleEnoughPointerToCommit(Constant *C) {
Dan Gohmance5de5b2009-09-07 22:42:05 +00002141 // Conservatively, avoid aggregate types. This is because we don't
2142 // want to worry about them partially overlapping other stores.
2143 if (!cast<PointerType>(C->getType())->getElementType()->isSingleValueType())
2144 return false;
2145
Dan Gohmanfd54a892009-09-07 22:31:26 +00002146 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
Mikhail Glushenkov99fca5d2010-10-19 16:47:23 +00002147 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
Dan Gohmanfd54a892009-09-07 22:31:26 +00002148 // external globals.
Mikhail Glushenkov99fca5d2010-10-19 16:47:23 +00002149 return GV->hasUniqueInitializer();
Dan Gohmanfd54a892009-09-07 22:31:26 +00002150
Owen Andersone95a32c2011-01-14 22:31:13 +00002151 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002152 // Handle a constantexpr gep.
2153 if (CE->getOpcode() == Instruction::GetElementPtr &&
Dan Gohmanc62482d2009-09-07 22:40:13 +00002154 isa<GlobalVariable>(CE->getOperand(0)) &&
2155 cast<GEPOperator>(CE)->isInBounds()) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002156 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Mikhail Glushenkov99fca5d2010-10-19 16:47:23 +00002157 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
Dan Gohmanfd54a892009-09-07 22:31:26 +00002158 // external globals.
Mikhail Glushenkov99fca5d2010-10-19 16:47:23 +00002159 if (!GV->hasUniqueInitializer())
Dan Gohmanfd54a892009-09-07 22:31:26 +00002160 return false;
Dan Gohman80bdc962009-09-07 22:44:55 +00002161
Dan Gohman80bdc962009-09-07 22:44:55 +00002162 // The first index must be zero.
Oscar Fuentesee56c422010-08-02 06:00:15 +00002163 ConstantInt *CI = dyn_cast<ConstantInt>(*llvm::next(CE->op_begin()));
Dan Gohman80bdc962009-09-07 22:44:55 +00002164 if (!CI || !CI->isZero()) return false;
Dan Gohman80bdc962009-09-07 22:44:55 +00002165
2166 // The remaining indices must be compile-time known integers within the
Dan Gohmane6992f72009-09-10 23:37:55 +00002167 // notional bounds of the corresponding static array types.
2168 if (!CE->isGEPWithNoNotionalOverIndexing())
2169 return false;
Dan Gohman80bdc962009-09-07 22:44:55 +00002170
Dan Gohmanc6f69e92009-10-05 16:36:26 +00002171 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
Owen Andersoncff6b372011-01-14 22:19:20 +00002172
2173 // A constantexpr bitcast from a pointer to another pointer is a no-op,
2174 // and we know how to evaluate it by moving the bitcast from the pointer
2175 // operand to the value operand.
2176 } else if (CE->getOpcode() == Instruction::BitCast &&
Chris Lattnerd5f656f2011-01-16 02:05:10 +00002177 isa<GlobalVariable>(CE->getOperand(0))) {
Owen Andersoncff6b372011-01-14 22:19:20 +00002178 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
2179 // external globals.
Chris Lattnerd5f656f2011-01-16 02:05:10 +00002180 return cast<GlobalVariable>(CE->getOperand(0))->hasUniqueInitializer();
Chris Lattner798b4d52005-09-26 06:52:44 +00002181 }
Owen Andersone95a32c2011-01-14 22:31:13 +00002182 }
2183
Chris Lattner79c11012005-09-26 04:44:35 +00002184 return false;
2185}
2186
Chris Lattner798b4d52005-09-26 06:52:44 +00002187/// EvaluateStoreInto - Evaluate a piece of a constantexpr store into a global
2188/// initializer. This returns 'Init' modified to reflect 'Val' stored into it.
2189/// At this point, the GEP operands of Addr [0, OpNo) have been stepped into.
2190static Constant *EvaluateStoreInto(Constant *Init, Constant *Val,
Chris Lattner7b550cc2009-11-06 04:27:31 +00002191 ConstantExpr *Addr, unsigned OpNo) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002192 // Base case of the recursion.
2193 if (OpNo == Addr->getNumOperands()) {
2194 assert(Val->getType() == Init->getType() && "Type mismatch!");
2195 return Val;
2196 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002197
Chris Lattnera0e9a242010-01-07 01:16:21 +00002198 std::vector<Constant*> Elts;
Chris Lattner798b4d52005-09-26 06:52:44 +00002199 if (const StructType *STy = dyn_cast<StructType>(Init->getType())) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002200
2201 // Break up the constant into its elements.
2202 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Init)) {
Gabor Greif5e463212008-05-29 01:59:18 +00002203 for (User::op_iterator i = CS->op_begin(), e = CS->op_end(); i != e; ++i)
2204 Elts.push_back(cast<Constant>(*i));
Chris Lattner798b4d52005-09-26 06:52:44 +00002205 } else if (isa<ConstantAggregateZero>(Init)) {
2206 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
Owen Andersona7235ea2009-07-31 20:28:14 +00002207 Elts.push_back(Constant::getNullValue(STy->getElementType(i)));
Chris Lattner798b4d52005-09-26 06:52:44 +00002208 } else if (isa<UndefValue>(Init)) {
2209 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
Owen Anderson9e9a0d52009-07-30 23:03:37 +00002210 Elts.push_back(UndefValue::get(STy->getElementType(i)));
Chris Lattner798b4d52005-09-26 06:52:44 +00002211 } else {
Torok Edwinc23197a2009-07-14 16:55:14 +00002212 llvm_unreachable("This code is out of sync with "
Chris Lattner798b4d52005-09-26 06:52:44 +00002213 " ConstantFoldLoadThroughGEPConstantExpr");
2214 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002215
Chris Lattner798b4d52005-09-26 06:52:44 +00002216 // Replace the element that we are supposed to.
Reid Spencerb83eb642006-10-20 07:07:24 +00002217 ConstantInt *CU = cast<ConstantInt>(Addr->getOperand(OpNo));
2218 unsigned Idx = CU->getZExtValue();
2219 assert(Idx < STy->getNumElements() && "Struct index out of range!");
Chris Lattner7b550cc2009-11-06 04:27:31 +00002220 Elts[Idx] = EvaluateStoreInto(Elts[Idx], Val, Addr, OpNo+1);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002221
Chris Lattner798b4d52005-09-26 06:52:44 +00002222 // Return the modified struct.
Chris Lattnerb065b062011-06-20 04:01:31 +00002223 return ConstantStruct::get(STy, Elts);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002224 }
Chris Lattnerb065b062011-06-20 04:01:31 +00002225
2226 ConstantInt *CI = cast<ConstantInt>(Addr->getOperand(OpNo));
2227 const SequentialType *InitTy = cast<SequentialType>(Init->getType());
2228
2229 uint64_t NumElts;
2230 if (const ArrayType *ATy = dyn_cast<ArrayType>(InitTy))
2231 NumElts = ATy->getNumElements();
2232 else
2233 NumElts = cast<VectorType>(InitTy)->getNumElements();
2234
2235 // Break up the array into elements.
2236 if (ConstantArray *CA = dyn_cast<ConstantArray>(Init)) {
2237 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i)
2238 Elts.push_back(cast<Constant>(*i));
2239 } else if (ConstantVector *CV = dyn_cast<ConstantVector>(Init)) {
2240 for (User::op_iterator i = CV->op_begin(), e = CV->op_end(); i != e; ++i)
2241 Elts.push_back(cast<Constant>(*i));
2242 } else if (isa<ConstantAggregateZero>(Init)) {
2243 Elts.assign(NumElts, Constant::getNullValue(InitTy->getElementType()));
2244 } else {
2245 assert(isa<UndefValue>(Init) && "This code is out of sync with "
2246 " ConstantFoldLoadThroughGEPConstantExpr");
2247 Elts.assign(NumElts, UndefValue::get(InitTy->getElementType()));
2248 }
2249
2250 assert(CI->getZExtValue() < NumElts);
2251 Elts[CI->getZExtValue()] =
2252 EvaluateStoreInto(Elts[CI->getZExtValue()], Val, Addr, OpNo+1);
2253
2254 if (Init->getType()->isArrayTy())
2255 return ConstantArray::get(cast<ArrayType>(InitTy), Elts);
2256 return ConstantVector::get(Elts);
Chris Lattner798b4d52005-09-26 06:52:44 +00002257}
2258
Chris Lattner79c11012005-09-26 04:44:35 +00002259/// CommitValueTo - We have decided that Addr (which satisfies the predicate
2260/// isSimpleEnoughPointerToCommit) should get Val as its value. Make it happen.
Chris Lattner7b550cc2009-11-06 04:27:31 +00002261static void CommitValueTo(Constant *Val, Constant *Addr) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002262 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Addr)) {
2263 assert(GV->hasInitializer());
2264 GV->setInitializer(Val);
2265 return;
2266 }
Chris Lattnera0e9a242010-01-07 01:16:21 +00002267
Chris Lattner798b4d52005-09-26 06:52:44 +00002268 ConstantExpr *CE = cast<ConstantExpr>(Addr);
2269 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Chris Lattnera0e9a242010-01-07 01:16:21 +00002270 GV->setInitializer(EvaluateStoreInto(GV->getInitializer(), Val, CE, 2));
Chris Lattner79c11012005-09-26 04:44:35 +00002271}
2272
Chris Lattner562a0552005-09-26 05:16:34 +00002273/// ComputeLoadResult - Return the value that would be computed by a load from
2274/// P after the stores reflected by 'memory' have been performed. If we can't
2275/// decide, return null.
Chris Lattner04de1cf2005-09-26 05:15:37 +00002276static Constant *ComputeLoadResult(Constant *P,
Chris Lattner7b550cc2009-11-06 04:27:31 +00002277 const DenseMap<Constant*, Constant*> &Memory) {
Chris Lattner04de1cf2005-09-26 05:15:37 +00002278 // If this memory location has been recently stored, use the stored value: it
2279 // is the most up-to-date.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002280 DenseMap<Constant*, Constant*>::const_iterator I = Memory.find(P);
Chris Lattner04de1cf2005-09-26 05:15:37 +00002281 if (I != Memory.end()) return I->second;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002282
Chris Lattner04de1cf2005-09-26 05:15:37 +00002283 // Access it.
2284 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(P)) {
Dan Gohman82555732009-08-19 18:20:44 +00002285 if (GV->hasDefinitiveInitializer())
Chris Lattner04de1cf2005-09-26 05:15:37 +00002286 return GV->getInitializer();
2287 return 0;
Chris Lattner04de1cf2005-09-26 05:15:37 +00002288 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002289
Chris Lattner798b4d52005-09-26 06:52:44 +00002290 // Handle a constantexpr getelementptr.
2291 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(P))
2292 if (CE->getOpcode() == Instruction::GetElementPtr &&
2293 isa<GlobalVariable>(CE->getOperand(0))) {
2294 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Dan Gohman82555732009-08-19 18:20:44 +00002295 if (GV->hasDefinitiveInitializer())
Dan Gohmanc6f69e92009-10-05 16:36:26 +00002296 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
Chris Lattner798b4d52005-09-26 06:52:44 +00002297 }
2298
2299 return 0; // don't know how to evaluate.
Chris Lattner04de1cf2005-09-26 05:15:37 +00002300}
2301
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002302/// EvaluateFunction - Evaluate a call to function F, returning true if
2303/// successful, false if we can't evaluate it. ActualArgs contains the formal
2304/// arguments for the function.
Chris Lattnercd271422005-09-27 04:45:34 +00002305static bool EvaluateFunction(Function *F, Constant *&RetVal,
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002306 const SmallVectorImpl<Constant*> &ActualArgs,
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002307 std::vector<Function*> &CallStack,
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002308 DenseMap<Constant*, Constant*> &MutatedMemory,
Chris Lattner1945d582010-12-07 04:33:29 +00002309 std::vector<GlobalVariable*> &AllocaTmps,
2310 SmallPtrSet<Constant*, 8> &SimpleConstants,
2311 const TargetData *TD) {
Chris Lattnercd271422005-09-27 04:45:34 +00002312 // Check to see if this function is already executing (recursion). If so,
2313 // bail out. TODO: we might want to accept limited recursion.
2314 if (std::find(CallStack.begin(), CallStack.end(), F) != CallStack.end())
2315 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002316
Chris Lattnercd271422005-09-27 04:45:34 +00002317 CallStack.push_back(F);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002318
Chris Lattner79c11012005-09-26 04:44:35 +00002319 /// Values - As we compute SSA register values, we store their contents here.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002320 DenseMap<Value*, Constant*> Values;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002321
Chris Lattnercd271422005-09-27 04:45:34 +00002322 // Initialize arguments to the incoming values specified.
2323 unsigned ArgNo = 0;
2324 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end(); AI != E;
2325 ++AI, ++ArgNo)
2326 Values[AI] = ActualArgs[ArgNo];
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002327
Chris Lattnercdf98be2005-09-26 04:57:38 +00002328 /// ExecutedBlocks - We only handle non-looping, non-recursive code. As such,
2329 /// we can only evaluate any one basic block at most once. This set keeps
2330 /// track of what we have executed so we can detect recursive cases etc.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002331 SmallPtrSet<BasicBlock*, 32> ExecutedBlocks;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002332
Chris Lattner79c11012005-09-26 04:44:35 +00002333 // CurInst - The current instruction we're evaluating.
2334 BasicBlock::iterator CurInst = F->begin()->begin();
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002335
Chris Lattner79c11012005-09-26 04:44:35 +00002336 // This is the main evaluation loop.
2337 while (1) {
2338 Constant *InstResult = 0;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002339
Chris Lattner79c11012005-09-26 04:44:35 +00002340 if (StoreInst *SI = dyn_cast<StoreInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002341 if (SI->isVolatile()) return false; // no volatile accesses.
Chris Lattner79c11012005-09-26 04:44:35 +00002342 Constant *Ptr = getVal(Values, SI->getOperand(1));
Chris Lattner7b550cc2009-11-06 04:27:31 +00002343 if (!isSimpleEnoughPointerToCommit(Ptr))
Chris Lattner79c11012005-09-26 04:44:35 +00002344 // If this is too complex for us to commit, reject it.
Chris Lattnercd271422005-09-27 04:45:34 +00002345 return false;
Chris Lattner1945d582010-12-07 04:33:29 +00002346
Chris Lattner79c11012005-09-26 04:44:35 +00002347 Constant *Val = getVal(Values, SI->getOperand(0));
Chris Lattner1945d582010-12-07 04:33:29 +00002348
2349 // If this might be too difficult for the backend to handle (e.g. the addr
2350 // of one global variable divided by another) then we can't commit it.
2351 if (!isSimpleEnoughValueToCommit(Val, SimpleConstants))
2352 return false;
Owen Andersoncff6b372011-01-14 22:19:20 +00002353
2354 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
2355 if (CE->getOpcode() == Instruction::BitCast) {
2356 // If we're evaluating a store through a bitcast, then we need
2357 // to pull the bitcast off the pointer type and push it onto the
2358 // stored value.
Chris Lattnerd5f656f2011-01-16 02:05:10 +00002359 Ptr = CE->getOperand(0);
Owen Andersoncff6b372011-01-14 22:19:20 +00002360
Chris Lattnerd5f656f2011-01-16 02:05:10 +00002361 const Type *NewTy=cast<PointerType>(Ptr->getType())->getElementType();
Owen Andersoncff6b372011-01-14 22:19:20 +00002362
Owen Anderson66f708f2011-01-16 04:33:33 +00002363 // In order to push the bitcast onto the stored value, a bitcast
2364 // from NewTy to Val's type must be legal. If it's not, we can try
2365 // introspecting NewTy to find a legal conversion.
2366 while (!Val->getType()->canLosslesslyBitCastTo(NewTy)) {
2367 // If NewTy is a struct, we can convert the pointer to the struct
2368 // into a pointer to its first member.
2369 // FIXME: This could be extended to support arrays as well.
2370 if (const StructType *STy = dyn_cast<StructType>(NewTy)) {
2371 NewTy = STy->getTypeAtIndex(0U);
2372
2373 const IntegerType *IdxTy =IntegerType::get(NewTy->getContext(), 32);
2374 Constant *IdxZero = ConstantInt::get(IdxTy, 0, false);
2375 Constant * const IdxList[] = {IdxZero, IdxZero};
2376
2377 Ptr = ConstantExpr::getGetElementPtr(Ptr, IdxList, 2);
Owen Andersoncff6b372011-01-14 22:19:20 +00002378
Owen Anderson66f708f2011-01-16 04:33:33 +00002379 // If we can't improve the situation by introspecting NewTy,
2380 // we have to give up.
2381 } else {
2382 return 0;
2383 }
Owen Andersoncff6b372011-01-14 22:19:20 +00002384 }
2385
Owen Anderson66f708f2011-01-16 04:33:33 +00002386 // If we found compatible types, go ahead and push the bitcast
2387 // onto the stored value.
Owen Andersoncff6b372011-01-14 22:19:20 +00002388 Val = ConstantExpr::getBitCast(Val, NewTy);
2389 }
2390
Chris Lattner79c11012005-09-26 04:44:35 +00002391 MutatedMemory[Ptr] = Val;
2392 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CurInst)) {
Owen Andersonbaf3c402009-07-29 18:55:55 +00002393 InstResult = ConstantExpr::get(BO->getOpcode(),
Chris Lattner79c11012005-09-26 04:44:35 +00002394 getVal(Values, BO->getOperand(0)),
2395 getVal(Values, BO->getOperand(1)));
Reid Spencere4d87aa2006-12-23 06:05:41 +00002396 } else if (CmpInst *CI = dyn_cast<CmpInst>(CurInst)) {
Owen Andersonbaf3c402009-07-29 18:55:55 +00002397 InstResult = ConstantExpr::getCompare(CI->getPredicate(),
Reid Spencere4d87aa2006-12-23 06:05:41 +00002398 getVal(Values, CI->getOperand(0)),
2399 getVal(Values, CI->getOperand(1)));
Chris Lattner79c11012005-09-26 04:44:35 +00002400 } else if (CastInst *CI = dyn_cast<CastInst>(CurInst)) {
Owen Andersonbaf3c402009-07-29 18:55:55 +00002401 InstResult = ConstantExpr::getCast(CI->getOpcode(),
Chris Lattner9a989f02006-11-30 17:26:08 +00002402 getVal(Values, CI->getOperand(0)),
Chris Lattner79c11012005-09-26 04:44:35 +00002403 CI->getType());
2404 } else if (SelectInst *SI = dyn_cast<SelectInst>(CurInst)) {
Gabor Greif9e4f2432010-06-24 14:42:01 +00002405 InstResult = ConstantExpr::getSelect(getVal(Values, SI->getOperand(0)),
Eric Christopher551754c2010-04-16 23:37:20 +00002406 getVal(Values, SI->getOperand(1)),
2407 getVal(Values, SI->getOperand(2)));
Chris Lattner04de1cf2005-09-26 05:15:37 +00002408 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(CurInst)) {
2409 Constant *P = getVal(Values, GEP->getOperand(0));
Chris Lattner55eb1c42007-01-31 04:40:53 +00002410 SmallVector<Constant*, 8> GEPOps;
Gabor Greif5e463212008-05-29 01:59:18 +00002411 for (User::op_iterator i = GEP->op_begin() + 1, e = GEP->op_end();
2412 i != e; ++i)
2413 GEPOps.push_back(getVal(Values, *i));
Dan Gohman4a7e6b72009-09-07 22:34:43 +00002414 InstResult = cast<GEPOperator>(GEP)->isInBounds() ?
2415 ConstantExpr::getInBoundsGetElementPtr(P, &GEPOps[0], GEPOps.size()) :
2416 ConstantExpr::getGetElementPtr(P, &GEPOps[0], GEPOps.size());
Chris Lattner04de1cf2005-09-26 05:15:37 +00002417 } else if (LoadInst *LI = dyn_cast<LoadInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002418 if (LI->isVolatile()) return false; // no volatile accesses.
Chris Lattner04de1cf2005-09-26 05:15:37 +00002419 InstResult = ComputeLoadResult(getVal(Values, LI->getOperand(0)),
Chris Lattner7b550cc2009-11-06 04:27:31 +00002420 MutatedMemory);
Chris Lattnercd271422005-09-27 04:45:34 +00002421 if (InstResult == 0) return false; // Could not evaluate load.
Chris Lattnera22fdb02005-09-26 17:07:09 +00002422 } else if (AllocaInst *AI = dyn_cast<AllocaInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002423 if (AI->isArrayAllocation()) return false; // Cannot handle array allocs.
Chris Lattnera22fdb02005-09-26 17:07:09 +00002424 const Type *Ty = AI->getType()->getElementType();
Chris Lattner7b550cc2009-11-06 04:27:31 +00002425 AllocaTmps.push_back(new GlobalVariable(Ty, false,
Chris Lattnera22fdb02005-09-26 17:07:09 +00002426 GlobalValue::InternalLinkage,
Owen Anderson9e9a0d52009-07-30 23:03:37 +00002427 UndefValue::get(Ty),
Chris Lattnera22fdb02005-09-26 17:07:09 +00002428 AI->getName()));
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002429 InstResult = AllocaTmps.back();
Chris Lattnercd271422005-09-27 04:45:34 +00002430 } else if (CallInst *CI = dyn_cast<CallInst>(CurInst)) {
Devang Patel412a4462009-03-09 23:04:12 +00002431
2432 // Debug info can safely be ignored here.
2433 if (isa<DbgInfoIntrinsic>(CI)) {
2434 ++CurInst;
2435 continue;
2436 }
2437
Chris Lattner7cd580f2006-07-07 21:37:01 +00002438 // Cannot handle inline asm.
Gabor Greifa9b23132010-04-20 13:13:04 +00002439 if (isa<InlineAsm>(CI->getCalledValue())) return false;
Chris Lattner7cd580f2006-07-07 21:37:01 +00002440
Nick Lewycky1f237b02011-05-29 18:41:56 +00002441 if (MemSetInst *MSI = dyn_cast<MemSetInst>(CI)) {
2442 if (MSI->isVolatile()) return false;
2443 Constant *Ptr = getVal(Values, MSI->getDest());
2444 Constant *Val = getVal(Values, MSI->getValue());
2445 Constant *DestVal = ComputeLoadResult(getVal(Values, Ptr),
2446 MutatedMemory);
Nick Lewyckybcb85082011-05-29 19:33:36 +00002447 if (Val->isNullValue() && DestVal && DestVal->isNullValue()) {
Nick Lewycky1f237b02011-05-29 18:41:56 +00002448 // This memset is a no-op.
2449 ++CurInst;
2450 continue;
2451 }
2452 return false;
2453 }
2454
Chris Lattnercd271422005-09-27 04:45:34 +00002455 // Resolve function pointers.
Gabor Greifa3997812010-07-22 10:37:47 +00002456 Function *Callee = dyn_cast<Function>(getVal(Values,
2457 CI->getCalledValue()));
Chris Lattnercd271422005-09-27 04:45:34 +00002458 if (!Callee) return false; // Cannot resolve.
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002459
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002460 SmallVector<Constant*, 8> Formals;
Gabor Greif9e4f2432010-06-24 14:42:01 +00002461 CallSite CS(CI);
2462 for (User::op_iterator i = CS.arg_begin(), e = CS.arg_end();
Gabor Greif5e463212008-05-29 01:59:18 +00002463 i != e; ++i)
2464 Formals.push_back(getVal(Values, *i));
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002465
Reid Spencer5cbf9852007-01-30 20:08:39 +00002466 if (Callee->isDeclaration()) {
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002467 // If this is a function we can constant fold, do it.
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002468 if (Constant *C = ConstantFoldCall(Callee, Formals.data(),
Chris Lattner6c1f5652007-01-30 23:14:52 +00002469 Formals.size())) {
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002470 InstResult = C;
2471 } else {
2472 return false;
2473 }
2474 } else {
2475 if (Callee->getFunctionType()->isVarArg())
2476 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002477
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002478 Constant *RetVal;
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002479 // Execute the call, if successful, use the return value.
2480 if (!EvaluateFunction(Callee, RetVal, Formals, CallStack,
Chris Lattner1945d582010-12-07 04:33:29 +00002481 MutatedMemory, AllocaTmps, SimpleConstants, TD))
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002482 return false;
2483 InstResult = RetVal;
2484 }
Reid Spencer3ed469c2006-11-02 20:25:50 +00002485 } else if (isa<TerminatorInst>(CurInst)) {
Chris Lattnercdf98be2005-09-26 04:57:38 +00002486 BasicBlock *NewBB = 0;
2487 if (BranchInst *BI = dyn_cast<BranchInst>(CurInst)) {
2488 if (BI->isUnconditional()) {
2489 NewBB = BI->getSuccessor(0);
2490 } else {
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00002491 ConstantInt *Cond =
2492 dyn_cast<ConstantInt>(getVal(Values, BI->getCondition()));
Chris Lattner97d1fad2007-01-12 18:30:11 +00002493 if (!Cond) return false; // Cannot determine.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00002494
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002495 NewBB = BI->getSuccessor(!Cond->getZExtValue());
Chris Lattnercdf98be2005-09-26 04:57:38 +00002496 }
2497 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurInst)) {
2498 ConstantInt *Val =
2499 dyn_cast<ConstantInt>(getVal(Values, SI->getCondition()));
Chris Lattnercd271422005-09-27 04:45:34 +00002500 if (!Val) return false; // Cannot determine.
Chris Lattnercdf98be2005-09-26 04:57:38 +00002501 NewBB = SI->getSuccessor(SI->findCaseValue(Val));
Chris Lattnerb3d5a652009-10-29 05:51:50 +00002502 } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(CurInst)) {
2503 Value *Val = getVal(Values, IBI->getAddress())->stripPointerCasts();
2504 if (BlockAddress *BA = dyn_cast<BlockAddress>(Val))
2505 NewBB = BA->getBasicBlock();
Chris Lattnercdfc9402009-11-01 01:27:45 +00002506 else
2507 return false; // Cannot determine.
Chris Lattnercdf98be2005-09-26 04:57:38 +00002508 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002509 if (RI->getNumOperands())
2510 RetVal = getVal(Values, RI->getOperand(0));
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002511
Chris Lattnercd271422005-09-27 04:45:34 +00002512 CallStack.pop_back(); // return from fn.
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002513 return true; // We succeeded at evaluating this ctor!
Chris Lattnercdf98be2005-09-26 04:57:38 +00002514 } else {
Chris Lattnercd271422005-09-27 04:45:34 +00002515 // invoke, unwind, unreachable.
2516 return false; // Cannot handle this terminator.
Chris Lattnercdf98be2005-09-26 04:57:38 +00002517 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002518
Chris Lattnercdf98be2005-09-26 04:57:38 +00002519 // Okay, we succeeded in evaluating this control flow. See if we have
Chris Lattnercd271422005-09-27 04:45:34 +00002520 // executed the new block before. If so, we have a looping function,
2521 // which we cannot evaluate in reasonable time.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002522 if (!ExecutedBlocks.insert(NewBB))
Chris Lattnercd271422005-09-27 04:45:34 +00002523 return false; // looped!
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002524
Chris Lattnercdf98be2005-09-26 04:57:38 +00002525 // Okay, we have never been in this block before. Check to see if there
2526 // are any PHI nodes. If so, evaluate them with information about where
2527 // we came from.
2528 BasicBlock *OldBB = CurInst->getParent();
2529 CurInst = NewBB->begin();
2530 PHINode *PN;
2531 for (; (PN = dyn_cast<PHINode>(CurInst)); ++CurInst)
2532 Values[PN] = getVal(Values, PN->getIncomingValueForBlock(OldBB));
2533
2534 // Do NOT increment CurInst. We know that the terminator had no value.
2535 continue;
Chris Lattner79c11012005-09-26 04:44:35 +00002536 } else {
Chris Lattner79c11012005-09-26 04:44:35 +00002537 // Did not know how to evaluate this!
Chris Lattnercd271422005-09-27 04:45:34 +00002538 return false;
Chris Lattner79c11012005-09-26 04:44:35 +00002539 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002540
Chris Lattner1945d582010-12-07 04:33:29 +00002541 if (!CurInst->use_empty()) {
2542 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(InstResult))
2543 InstResult = ConstantFoldConstantExpression(CE, TD);
2544
Chris Lattner79c11012005-09-26 04:44:35 +00002545 Values[CurInst] = InstResult;
Chris Lattner1945d582010-12-07 04:33:29 +00002546 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002547
Chris Lattner79c11012005-09-26 04:44:35 +00002548 // Advance program counter.
2549 ++CurInst;
2550 }
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002551}
2552
2553/// EvaluateStaticConstructor - Evaluate static constructors in the function, if
2554/// we can. Return true if we can, false otherwise.
Chris Lattner1945d582010-12-07 04:33:29 +00002555static bool EvaluateStaticConstructor(Function *F, const TargetData *TD) {
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002556 /// MutatedMemory - For each store we execute, we update this map. Loads
2557 /// check this to get the most up-to-date value. If evaluation is successful,
2558 /// this state is committed to the process.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002559 DenseMap<Constant*, Constant*> MutatedMemory;
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002560
2561 /// AllocaTmps - To 'execute' an alloca, we create a temporary global variable
2562 /// to represent its body. This vector is needed so we can delete the
2563 /// temporary globals when we are done.
2564 std::vector<GlobalVariable*> AllocaTmps;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002565
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002566 /// CallStack - This is used to detect recursion. In pathological situations
2567 /// we could hit exponential behavior, but at least there is nothing
2568 /// unbounded.
2569 std::vector<Function*> CallStack;
2570
Chris Lattner1945d582010-12-07 04:33:29 +00002571 /// SimpleConstants - These are constants we have checked and know to be
2572 /// simple enough to live in a static initializer of a global.
2573 SmallPtrSet<Constant*, 8> SimpleConstants;
2574
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002575 // Call the function.
Chris Lattnercd271422005-09-27 04:45:34 +00002576 Constant *RetValDummy;
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002577 bool EvalSuccess = EvaluateFunction(F, RetValDummy,
2578 SmallVector<Constant*, 0>(), CallStack,
Chris Lattner1945d582010-12-07 04:33:29 +00002579 MutatedMemory, AllocaTmps,
2580 SimpleConstants, TD);
2581
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002582 if (EvalSuccess) {
Chris Lattnera22fdb02005-09-26 17:07:09 +00002583 // We succeeded at evaluation: commit the result.
David Greene3215b0e2010-01-05 01:28:05 +00002584 DEBUG(dbgs() << "FULLY EVALUATED GLOBAL CTOR FUNCTION '"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +00002585 << F->getName() << "' to " << MutatedMemory.size()
2586 << " stores.\n");
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002587 for (DenseMap<Constant*, Constant*>::iterator I = MutatedMemory.begin(),
Chris Lattnera22fdb02005-09-26 17:07:09 +00002588 E = MutatedMemory.end(); I != E; ++I)
Chris Lattner7b550cc2009-11-06 04:27:31 +00002589 CommitValueTo(I->second, I->first);
Chris Lattnera22fdb02005-09-26 17:07:09 +00002590 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002591
Chris Lattnera22fdb02005-09-26 17:07:09 +00002592 // At this point, we are done interpreting. If we created any 'alloca'
2593 // temporaries, release them now.
2594 while (!AllocaTmps.empty()) {
2595 GlobalVariable *Tmp = AllocaTmps.back();
2596 AllocaTmps.pop_back();
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002597
Chris Lattnera22fdb02005-09-26 17:07:09 +00002598 // If there are still users of the alloca, the program is doing something
2599 // silly, e.g. storing the address of the alloca somewhere and using it
2600 // later. Since this is undefined, we'll just make it be null.
2601 if (!Tmp->use_empty())
Owen Andersona7235ea2009-07-31 20:28:14 +00002602 Tmp->replaceAllUsesWith(Constant::getNullValue(Tmp->getType()));
Chris Lattnera22fdb02005-09-26 17:07:09 +00002603 delete Tmp;
2604 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002605
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002606 return EvalSuccess;
Chris Lattner79c11012005-09-26 04:44:35 +00002607}
2608
Chris Lattnerdb973e62005-09-26 02:31:18 +00002609
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002610
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002611/// OptimizeGlobalCtorsList - Simplify and evaluation global ctors if possible.
2612/// Return true if anything changed.
2613bool GlobalOpt::OptimizeGlobalCtorsList(GlobalVariable *&GCL) {
2614 std::vector<Function*> Ctors = ParseGlobalCtors(GCL);
2615 bool MadeChange = false;
2616 if (Ctors.empty()) return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002617
Chris Lattner1945d582010-12-07 04:33:29 +00002618 const TargetData *TD = getAnalysisIfAvailable<TargetData>();
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002619 // Loop over global ctors, optimizing them when we can.
2620 for (unsigned i = 0; i != Ctors.size(); ++i) {
2621 Function *F = Ctors[i];
2622 // Found a null terminator in the middle of the list, prune off the rest of
2623 // the list.
Chris Lattner7d8e58f2005-09-26 02:19:27 +00002624 if (F == 0) {
2625 if (i != Ctors.size()-1) {
2626 Ctors.resize(i+1);
2627 MadeChange = true;
2628 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002629 break;
2630 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002631
Chris Lattner79c11012005-09-26 04:44:35 +00002632 // We cannot simplify external ctor functions.
2633 if (F->empty()) continue;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002634
Chris Lattner79c11012005-09-26 04:44:35 +00002635 // If we can evaluate the ctor at compile time, do.
Chris Lattner1945d582010-12-07 04:33:29 +00002636 if (EvaluateStaticConstructor(F, TD)) {
Chris Lattner79c11012005-09-26 04:44:35 +00002637 Ctors.erase(Ctors.begin()+i);
2638 MadeChange = true;
2639 --i;
2640 ++NumCtorsEvaluated;
2641 continue;
2642 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002643 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002644
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002645 if (!MadeChange) return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002646
Chris Lattner7b550cc2009-11-06 04:27:31 +00002647 GCL = InstallGlobalCtors(GCL, Ctors);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002648 return true;
2649}
2650
Duncan Sandsfc5940d2009-03-06 10:21:56 +00002651bool GlobalOpt::OptimizeGlobalAliases(Module &M) {
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002652 bool Changed = false;
2653
Duncan Sands177d84e2009-01-07 20:01:06 +00002654 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
Duncan Sands4782b302009-02-15 09:56:08 +00002655 I != E;) {
2656 Module::alias_iterator J = I++;
Duncan Sandsfc5940d2009-03-06 10:21:56 +00002657 // Aliases without names cannot be referenced outside this module.
2658 if (!J->hasName() && !J->isDeclaration())
2659 J->setLinkage(GlobalValue::InternalLinkage);
Duncan Sands4782b302009-02-15 09:56:08 +00002660 // If the aliasee may change at link time, nothing can be done - bail out.
2661 if (J->mayBeOverridden())
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002662 continue;
2663
Duncan Sands4782b302009-02-15 09:56:08 +00002664 Constant *Aliasee = J->getAliasee();
2665 GlobalValue *Target = cast<GlobalValue>(Aliasee->stripPointerCasts());
Duncan Sands95c5d0f2009-02-18 17:55:38 +00002666 Target->removeDeadConstantUsers();
Duncan Sands4782b302009-02-15 09:56:08 +00002667 bool hasOneUse = Target->hasOneUse() && Aliasee->hasOneUse();
2668
2669 // Make all users of the alias use the aliasee instead.
2670 if (!J->use_empty()) {
2671 J->replaceAllUsesWith(Aliasee);
2672 ++NumAliasesResolved;
2673 Changed = true;
2674 }
2675
Duncan Sands7a154cf2009-12-08 10:10:20 +00002676 // If the alias is externally visible, we may still be able to simplify it.
2677 if (!J->hasLocalLinkage()) {
2678 // If the aliasee has internal linkage, give it the name and linkage
2679 // of the alias, and delete the alias. This turns:
2680 // define internal ... @f(...)
2681 // @a = alias ... @f
2682 // into:
2683 // define ... @a(...)
2684 if (!Target->hasLocalLinkage())
2685 continue;
Duncan Sands4782b302009-02-15 09:56:08 +00002686
Duncan Sands7a154cf2009-12-08 10:10:20 +00002687 // Do not perform the transform if multiple aliases potentially target the
Gabor Greif27236912010-04-07 18:59:26 +00002688 // aliasee. This check also ensures that it is safe to replace the section
Duncan Sands7a154cf2009-12-08 10:10:20 +00002689 // and other attributes of the aliasee with those of the alias.
2690 if (!hasOneUse)
2691 continue;
Duncan Sands4782b302009-02-15 09:56:08 +00002692
Duncan Sands7a154cf2009-12-08 10:10:20 +00002693 // Give the aliasee the name, linkage and other attributes of the alias.
2694 Target->takeName(J);
2695 Target->setLinkage(J->getLinkage());
2696 Target->GlobalValue::copyAttributesFrom(J);
2697 }
Duncan Sands4782b302009-02-15 09:56:08 +00002698
2699 // Delete the alias.
2700 M.getAliasList().erase(J);
2701 ++NumAliasesRemoved;
2702 Changed = true;
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002703 }
2704
2705 return Changed;
2706}
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002707
Anders Carlssona201c4c2011-03-20 17:59:11 +00002708static Function *FindCXAAtExit(Module &M) {
2709 Function *Fn = M.getFunction("__cxa_atexit");
2710
2711 if (!Fn)
2712 return 0;
2713
2714 const FunctionType *FTy = Fn->getFunctionType();
2715
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00002716 // Checking that the function has the right return type, the right number of
2717 // parameters and that they all have pointer types should be enough.
2718 if (!FTy->getReturnType()->isIntegerTy() ||
2719 FTy->getNumParams() != 3 ||
Anders Carlssona201c4c2011-03-20 17:59:11 +00002720 !FTy->getParamType(0)->isPointerTy() ||
2721 !FTy->getParamType(1)->isPointerTy() ||
2722 !FTy->getParamType(2)->isPointerTy())
2723 return 0;
2724
2725 return Fn;
2726}
2727
2728/// cxxDtorIsEmpty - Returns whether the given function is an empty C++
2729/// destructor and can therefore be eliminated.
2730/// Note that we assume that other optimization passes have already simplified
2731/// the code so we only look for a function with a single basic block, where
2732/// the only allowed instructions are 'ret' or 'call' to empty C++ dtor.
Anders Carlsson372ec6a2011-03-20 20:16:43 +00002733static bool cxxDtorIsEmpty(const Function &Fn,
2734 SmallPtrSet<const Function *, 8> &CalledFunctions) {
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00002735 // FIXME: We could eliminate C++ destructors if they're readonly/readnone and
Nick Lewycky35ee1c92011-03-21 02:26:01 +00002736 // nounwind, but that doesn't seem worth doing.
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00002737 if (Fn.isDeclaration())
2738 return false;
Anders Carlssona201c4c2011-03-20 17:59:11 +00002739
2740 if (++Fn.begin() != Fn.end())
2741 return false;
2742
2743 const BasicBlock &EntryBlock = Fn.getEntryBlock();
2744 for (BasicBlock::const_iterator I = EntryBlock.begin(), E = EntryBlock.end();
2745 I != E; ++I) {
2746 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
Anders Carlssonb12caf32011-03-21 14:54:40 +00002747 // Ignore debug intrinsics.
2748 if (isa<DbgInfoIntrinsic>(CI))
2749 continue;
2750
Anders Carlssona201c4c2011-03-20 17:59:11 +00002751 const Function *CalledFn = CI->getCalledFunction();
2752
2753 if (!CalledFn)
2754 return false;
2755
Anders Carlsson807bc2a2011-03-22 03:21:01 +00002756 SmallPtrSet<const Function *, 8> NewCalledFunctions(CalledFunctions);
2757
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00002758 // Don't treat recursive functions as empty.
Anders Carlsson807bc2a2011-03-22 03:21:01 +00002759 if (!NewCalledFunctions.insert(CalledFn))
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00002760 return false;
2761
Anders Carlsson807bc2a2011-03-22 03:21:01 +00002762 if (!cxxDtorIsEmpty(*CalledFn, NewCalledFunctions))
Anders Carlssona201c4c2011-03-20 17:59:11 +00002763 return false;
2764 } else if (isa<ReturnInst>(*I))
2765 return true;
2766 else
2767 return false;
2768 }
2769
2770 return false;
2771}
2772
2773bool GlobalOpt::OptimizeEmptyGlobalCXXDtors(Function *CXAAtExitFn) {
2774 /// Itanium C++ ABI p3.3.5:
2775 ///
2776 /// After constructing a global (or local static) object, that will require
2777 /// destruction on exit, a termination function is registered as follows:
2778 ///
2779 /// extern "C" int __cxa_atexit ( void (*f)(void *), void *p, void *d );
2780 ///
2781 /// This registration, e.g. __cxa_atexit(f,p,d), is intended to cause the
2782 /// call f(p) when DSO d is unloaded, before all such termination calls
2783 /// registered before this one. It returns zero if registration is
Nick Lewycky35ee1c92011-03-21 02:26:01 +00002784 /// successful, nonzero on failure.
Anders Carlssona201c4c2011-03-20 17:59:11 +00002785
2786 // This pass will look for calls to __cxa_atexit where the function is trivial
2787 // and remove them.
2788 bool Changed = false;
2789
2790 for (Function::use_iterator I = CXAAtExitFn->use_begin(),
2791 E = CXAAtExitFn->use_end(); I != E;) {
Anders Carlsson4f735ca2011-03-20 20:21:33 +00002792 // We're only interested in calls. Theoretically, we could handle invoke
2793 // instructions as well, but neither llvm-gcc nor clang generate invokes
2794 // to __cxa_atexit.
Anders Carlssonb12caf32011-03-21 14:54:40 +00002795 CallInst *CI = dyn_cast<CallInst>(*I++);
2796 if (!CI)
Anders Carlsson4f735ca2011-03-20 20:21:33 +00002797 continue;
2798
Anders Carlssona201c4c2011-03-20 17:59:11 +00002799 Function *DtorFn =
Anders Carlssonb12caf32011-03-21 14:54:40 +00002800 dyn_cast<Function>(CI->getArgOperand(0)->stripPointerCasts());
Anders Carlssona201c4c2011-03-20 17:59:11 +00002801 if (!DtorFn)
2802 continue;
2803
Anders Carlsson372ec6a2011-03-20 20:16:43 +00002804 SmallPtrSet<const Function *, 8> CalledFunctions;
2805 if (!cxxDtorIsEmpty(*DtorFn, CalledFunctions))
Anders Carlssona201c4c2011-03-20 17:59:11 +00002806 continue;
2807
2808 // Just remove the call.
Anders Carlssonb12caf32011-03-21 14:54:40 +00002809 CI->replaceAllUsesWith(Constant::getNullValue(CI->getType()));
2810 CI->eraseFromParent();
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00002811
Anders Carlssona201c4c2011-03-20 17:59:11 +00002812 ++NumCXXDtorsRemoved;
2813
2814 Changed |= true;
2815 }
2816
2817 return Changed;
2818}
2819
Chris Lattner7a90b682004-10-07 04:16:33 +00002820bool GlobalOpt::runOnModule(Module &M) {
Chris Lattner079236d2004-02-25 21:34:36 +00002821 bool Changed = false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002822
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002823 // Try to find the llvm.globalctors list.
2824 GlobalVariable *GlobalCtors = FindGlobalCtors(M);
Chris Lattner7a90b682004-10-07 04:16:33 +00002825
Anders Carlssona201c4c2011-03-20 17:59:11 +00002826 Function *CXAAtExitFn = FindCXAAtExit(M);
2827
Chris Lattner7a90b682004-10-07 04:16:33 +00002828 bool LocalChange = true;
2829 while (LocalChange) {
2830 LocalChange = false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002831
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002832 // Delete functions that are trivially dead, ccc -> fastcc
2833 LocalChange |= OptimizeFunctions(M);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002834
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002835 // Optimize global_ctors list.
2836 if (GlobalCtors)
2837 LocalChange |= OptimizeGlobalCtorsList(GlobalCtors);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002838
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002839 // Optimize non-address-taken globals.
2840 LocalChange |= OptimizeGlobalVars(M);
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002841
2842 // Resolve aliases, when possible.
Duncan Sandsfc5940d2009-03-06 10:21:56 +00002843 LocalChange |= OptimizeGlobalAliases(M);
Anders Carlssona201c4c2011-03-20 17:59:11 +00002844
2845 // Try to remove trivial global destructors.
2846 if (CXAAtExitFn)
2847 LocalChange |= OptimizeEmptyGlobalCXXDtors(CXAAtExitFn);
2848
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002849 Changed |= LocalChange;
Chris Lattner7a90b682004-10-07 04:16:33 +00002850 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002851
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002852 // TODO: Move all global ctors functions to the end of the module for code
2853 // layout.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002854
Chris Lattner079236d2004-02-25 21:34:36 +00002855 return Changed;
2856}