blob: 2d971a1e192cbb35381f76b5e668f1604f9c90b3 [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 Lattnerdb125cf2011-07-18 04:54:35 +0000284 if (StructType *STy = dyn_cast<StructType>(Agg->getType())) {
Chris Lattner670c8892004-10-08 17:32:09 +0000285 if (IdxV < STy->getNumElements())
Owen Andersona7235ea2009-07-31 20:28:14 +0000286 return Constant::getNullValue(STy->getElementType(IdxV));
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000287 } else if (SequentialType *STy =
Chris Lattner670c8892004-10-08 17:32:09 +0000288 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)) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000292 if (StructType *STy = dyn_cast<StructType>(Agg->getType())) {
Chris Lattner7a7ed022004-10-16 18:09:00 +0000293 if (IdxV < STy->getNumElements())
Owen Anderson9e9a0d52009-07-30 23:03:37 +0000294 return UndefValue::get(STy->getElementType(IdxV));
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000295 } else if (SequentialType *STy =
Chris Lattner7a7ed022004-10-16 18:09:00 +0000296 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.
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000433 if (ArrayType *AT = dyn_cast<ArrayType>(*GEPI)) {
Chris Lattner941db492008-01-14 02:09:12 +0000434 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;
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000454 if (ArrayType *SubArrayTy = dyn_cast<ArrayType>(*GEPI))
Chris Lattner941db492008-01-14 02:09:12 +0000455 NumElements = SubArrayTy->getNumElements();
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000456 else if (VectorType *SubVectorTy = dyn_cast<VectorType>(*GEPI))
Dan Gohman6874a2a2009-08-18 14:58:19 +0000457 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();
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000501 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 Lattnerdb125cf2011-07-18 04:54:35 +0000511 if (StructType *STy = dyn_cast<StructType>(Ty)) {
Chris Lattner670c8892004-10-08 17:32:09 +0000512 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 }
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000534 } else if (SequentialType *STy = dyn_cast<SequentialType>(Ty)) {
Chris Lattner670c8892004-10-08 17:32:09 +0000535 unsigned NumElements = 0;
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000536 if (ArrayType *ATy = dyn_cast<ArrayType>(STy))
Chris Lattner670c8892004-10-08 17:32:09 +0000537 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));
Jay Foaddab3d292011-07-21 14:31:17 +0000599 NewPtr = ConstantExpr::getGetElementPtr(cast<Constant>(NewPtr), Idxs);
Chris Lattner30ba5692004-10-11 05:54:41 +0000600 } else {
601 GetElementPtrInst *GEPI = cast<GetElementPtrInst>(GEP);
Chris Lattner699d1442007-01-31 19:59:55 +0000602 SmallVector<Value*, 8> Idxs;
Chris Lattner30ba5692004-10-11 05:54:41 +0000603 Idxs.push_back(NullInt);
604 for (unsigned i = 3, e = GEPI->getNumOperands(); i != e; ++i)
605 Idxs.push_back(GEPI->getOperand(i));
Gabor Greif051a9502008-04-06 20:25:17 +0000606 NewPtr = GetElementPtrInst::Create(NewPtr, Idxs.begin(), Idxs.end(),
Daniel Dunbarfe09b202009-07-30 17:37:43 +0000607 GEPI->getName()+"."+Twine(Val),GEPI);
Chris Lattner30ba5692004-10-11 05:54:41 +0000608 }
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000609 }
Chris Lattner30ba5692004-10-11 05:54:41 +0000610 GEP->replaceAllUsesWith(NewPtr);
611
612 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(GEP))
Chris Lattner7a7ed022004-10-16 18:09:00 +0000613 GEPI->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000614 else
615 cast<ConstantExpr>(GEP)->destroyConstant();
Chris Lattner670c8892004-10-08 17:32:09 +0000616 }
617
Chris Lattnere40e2d12004-10-08 20:25:55 +0000618 // Delete the old global, now that it is dead.
619 Globals.erase(GV);
Chris Lattner670c8892004-10-08 17:32:09 +0000620 ++NumSRA;
Chris Lattner30ba5692004-10-11 05:54:41 +0000621
622 // Loop over the new globals array deleting any globals that are obviously
623 // dead. This can arise due to scalarization of a structure or an array that
624 // has elements that are dead.
625 unsigned FirstGlobal = 0;
626 for (unsigned i = 0, e = NewGlobals.size(); i != e; ++i)
627 if (NewGlobals[i]->use_empty()) {
628 Globals.erase(NewGlobals[i]);
629 if (FirstGlobal == i) ++FirstGlobal;
630 }
631
632 return FirstGlobal != NewGlobals.size() ? NewGlobals[FirstGlobal] : 0;
Chris Lattner670c8892004-10-08 17:32:09 +0000633}
634
Chris Lattner9b34a612004-10-09 21:48:45 +0000635/// AllUsesOfValueWillTrapIfNull - Return true if all users of the specified
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000636/// value will trap if the value is dynamically null. PHIs keeps track of any
Chris Lattner81686182007-09-13 16:30:19 +0000637/// phi nodes we've seen to avoid reprocessing them.
Gabor Greif6ce02b52010-04-06 19:24:18 +0000638static bool AllUsesOfValueWillTrapIfNull(const Value *V,
639 SmallPtrSet<const PHINode*, 8> &PHIs) {
640 for (Value::const_use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000641 ++UI) {
Gabor Greif6ce02b52010-04-06 19:24:18 +0000642 const User *U = *UI;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000643
644 if (isa<LoadInst>(U)) {
Chris Lattner9b34a612004-10-09 21:48:45 +0000645 // Will trap.
Gabor Greif6ce02b52010-04-06 19:24:18 +0000646 } else if (const StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattner9b34a612004-10-09 21:48:45 +0000647 if (SI->getOperand(0) == V) {
Gabor Greifa01d6db2010-04-06 19:14:05 +0000648 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000649 return false; // Storing the value.
650 }
Gabor Greif6ce02b52010-04-06 19:24:18 +0000651 } else if (const CallInst *CI = dyn_cast<CallInst>(U)) {
Gabor Greif654c06f2010-03-20 21:00:25 +0000652 if (CI->getCalledValue() != V) {
Gabor Greifa01d6db2010-04-06 19:14:05 +0000653 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000654 return false; // Not calling the ptr
655 }
Gabor Greif6ce02b52010-04-06 19:24:18 +0000656 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(U)) {
Gabor Greif654c06f2010-03-20 21:00:25 +0000657 if (II->getCalledValue() != V) {
Gabor Greifa01d6db2010-04-06 19:14:05 +0000658 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000659 return false; // Not calling the ptr
660 }
Gabor Greif6ce02b52010-04-06 19:24:18 +0000661 } else if (const BitCastInst *CI = dyn_cast<BitCastInst>(U)) {
Chris Lattner81686182007-09-13 16:30:19 +0000662 if (!AllUsesOfValueWillTrapIfNull(CI, PHIs)) return false;
Gabor Greif6ce02b52010-04-06 19:24:18 +0000663 } else if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner81686182007-09-13 16:30:19 +0000664 if (!AllUsesOfValueWillTrapIfNull(GEPI, PHIs)) return false;
Gabor Greif6ce02b52010-04-06 19:24:18 +0000665 } else if (const PHINode *PN = dyn_cast<PHINode>(U)) {
Chris Lattner81686182007-09-13 16:30:19 +0000666 // If we've already seen this phi node, ignore it, it has already been
667 // checked.
Jakob Stoklund Olesenb489d0f2010-01-29 23:54:14 +0000668 if (PHIs.insert(PN) && !AllUsesOfValueWillTrapIfNull(PN, PHIs))
669 return false;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000670 } else if (isa<ICmpInst>(U) &&
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000671 isa<ConstantPointerNull>(UI->getOperand(1))) {
Nick Lewyckye7ee59b2010-02-25 06:39:10 +0000672 // Ignore icmp X, null
Chris Lattner9b34a612004-10-09 21:48:45 +0000673 } else {
Gabor Greifa01d6db2010-04-06 19:14:05 +0000674 //cerr << "NONTRAPPING USE: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000675 return false;
676 }
Gabor Greifa01d6db2010-04-06 19:14:05 +0000677 }
Chris Lattner9b34a612004-10-09 21:48:45 +0000678 return true;
679}
680
681/// AllUsesOfLoadedValueWillTrapIfNull - Return true if all uses of any loads
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000682/// from GV will trap if the loaded value is null. Note that this also permits
683/// comparisons of the loaded value against null, as a special case.
Gabor Greif6ce02b52010-04-06 19:24:18 +0000684static bool AllUsesOfLoadedValueWillTrapIfNull(const GlobalVariable *GV) {
685 for (Value::const_use_iterator UI = GV->use_begin(), E = GV->use_end();
Gabor Greifa01d6db2010-04-06 19:14:05 +0000686 UI != E; ++UI) {
Gabor Greif6ce02b52010-04-06 19:24:18 +0000687 const User *U = *UI;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000688
Gabor Greif6ce02b52010-04-06 19:24:18 +0000689 if (const LoadInst *LI = dyn_cast<LoadInst>(U)) {
690 SmallPtrSet<const PHINode*, 8> PHIs;
Chris Lattner81686182007-09-13 16:30:19 +0000691 if (!AllUsesOfValueWillTrapIfNull(LI, PHIs))
Chris Lattner9b34a612004-10-09 21:48:45 +0000692 return false;
Gabor Greifa01d6db2010-04-06 19:14:05 +0000693 } else if (isa<StoreInst>(U)) {
Chris Lattner9b34a612004-10-09 21:48:45 +0000694 // Ignore stores to the global.
695 } else {
696 // We don't know or understand this user, bail out.
Gabor Greifa01d6db2010-04-06 19:14:05 +0000697 //cerr << "UNKNOWN USER OF GLOBAL!: " << *U;
Chris Lattner9b34a612004-10-09 21:48:45 +0000698 return false;
699 }
Gabor Greifa01d6db2010-04-06 19:14:05 +0000700 }
Chris Lattner9b34a612004-10-09 21:48:45 +0000701 return true;
702}
703
Chris Lattner7b550cc2009-11-06 04:27:31 +0000704static bool OptimizeAwayTrappingUsesOfValue(Value *V, Constant *NewV) {
Chris Lattner708148e2004-10-10 23:14:11 +0000705 bool Changed = false;
706 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ) {
707 Instruction *I = cast<Instruction>(*UI++);
708 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
709 LI->setOperand(0, NewV);
710 Changed = true;
711 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
712 if (SI->getOperand(1) == V) {
713 SI->setOperand(1, NewV);
714 Changed = true;
715 }
716 } else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
Gabor Greiffa1f5c22010-04-06 18:45:08 +0000717 CallSite CS(I);
718 if (CS.getCalledValue() == V) {
Chris Lattner708148e2004-10-10 23:14:11 +0000719 // Calling through the pointer! Turn into a direct call, but be careful
720 // that the pointer is not also being passed as an argument.
Gabor Greiffa1f5c22010-04-06 18:45:08 +0000721 CS.setCalledFunction(NewV);
Chris Lattner708148e2004-10-10 23:14:11 +0000722 Changed = true;
723 bool PassedAsArg = false;
Gabor Greiffa1f5c22010-04-06 18:45:08 +0000724 for (unsigned i = 0, e = CS.arg_size(); i != e; ++i)
725 if (CS.getArgument(i) == V) {
Chris Lattner708148e2004-10-10 23:14:11 +0000726 PassedAsArg = true;
Gabor Greiffa1f5c22010-04-06 18:45:08 +0000727 CS.setArgument(i, NewV);
Chris Lattner708148e2004-10-10 23:14:11 +0000728 }
729
730 if (PassedAsArg) {
731 // Being passed as an argument also. Be careful to not invalidate UI!
732 UI = V->use_begin();
733 }
734 }
735 } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
736 Changed |= OptimizeAwayTrappingUsesOfValue(CI,
Owen Andersonbaf3c402009-07-29 18:55:55 +0000737 ConstantExpr::getCast(CI->getOpcode(),
Chris Lattner7b550cc2009-11-06 04:27:31 +0000738 NewV, CI->getType()));
Chris Lattner708148e2004-10-10 23:14:11 +0000739 if (CI->use_empty()) {
740 Changed = true;
Chris Lattner7a7ed022004-10-16 18:09:00 +0000741 CI->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000742 }
743 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
744 // Should handle GEP here.
Chris Lattner55eb1c42007-01-31 04:40:53 +0000745 SmallVector<Constant*, 8> Idxs;
746 Idxs.reserve(GEPI->getNumOperands()-1);
Gabor Greif5e463212008-05-29 01:59:18 +0000747 for (User::op_iterator i = GEPI->op_begin() + 1, e = GEPI->op_end();
748 i != e; ++i)
749 if (Constant *C = dyn_cast<Constant>(*i))
Chris Lattner55eb1c42007-01-31 04:40:53 +0000750 Idxs.push_back(C);
Chris Lattner708148e2004-10-10 23:14:11 +0000751 else
752 break;
Chris Lattner55eb1c42007-01-31 04:40:53 +0000753 if (Idxs.size() == GEPI->getNumOperands()-1)
Chris Lattner708148e2004-10-10 23:14:11 +0000754 Changed |= OptimizeAwayTrappingUsesOfValue(GEPI,
Jay Foaddab3d292011-07-21 14:31:17 +0000755 ConstantExpr::getGetElementPtr(NewV, Idxs));
Chris Lattner708148e2004-10-10 23:14:11 +0000756 if (GEPI->use_empty()) {
757 Changed = true;
Chris Lattner7a7ed022004-10-16 18:09:00 +0000758 GEPI->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000759 }
760 }
761 }
762
763 return Changed;
764}
765
766
767/// OptimizeAwayTrappingUsesOfLoads - The specified global has only one non-null
768/// value stored into it. If there are uses of the loaded value that would trap
769/// if the loaded value is dynamically null, then we know that they cannot be
770/// reachable with a null optimize away the load.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000771static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV) {
Chris Lattner708148e2004-10-10 23:14:11 +0000772 bool Changed = false;
773
Chris Lattner92c6bd22009-01-14 00:12:58 +0000774 // Keep track of whether we are able to remove all the uses of the global
775 // other than the store that defines it.
776 bool AllNonStoreUsesGone = true;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000777
Chris Lattner708148e2004-10-10 23:14:11 +0000778 // Replace all uses of loads with uses of uses of the stored value.
Chris Lattner92c6bd22009-01-14 00:12:58 +0000779 for (Value::use_iterator GUI = GV->use_begin(), E = GV->use_end(); GUI != E;){
780 User *GlobalUser = *GUI++;
781 if (LoadInst *LI = dyn_cast<LoadInst>(GlobalUser)) {
Chris Lattner7b550cc2009-11-06 04:27:31 +0000782 Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV);
Chris Lattner92c6bd22009-01-14 00:12:58 +0000783 // If we were able to delete all uses of the loads
784 if (LI->use_empty()) {
785 LI->eraseFromParent();
786 Changed = true;
787 } else {
788 AllNonStoreUsesGone = false;
789 }
790 } else if (isa<StoreInst>(GlobalUser)) {
791 // Ignore the store that stores "LV" to the global.
792 assert(GlobalUser->getOperand(1) == GV &&
793 "Must be storing *to* the global");
Chris Lattner708148e2004-10-10 23:14:11 +0000794 } else {
Chris Lattner92c6bd22009-01-14 00:12:58 +0000795 AllNonStoreUsesGone = false;
796
797 // If we get here we could have other crazy uses that are transitively
798 // loaded.
799 assert((isa<PHINode>(GlobalUser) || isa<SelectInst>(GlobalUser) ||
Chris Lattner98a42b22011-05-22 07:15:13 +0000800 isa<ConstantExpr>(GlobalUser) || isa<CmpInst>(GlobalUser)) &&
801 "Only expect load and stores!");
Chris Lattner708148e2004-10-10 23:14:11 +0000802 }
Chris Lattner92c6bd22009-01-14 00:12:58 +0000803 }
Chris Lattner708148e2004-10-10 23:14:11 +0000804
805 if (Changed) {
David Greene3215b0e2010-01-05 01:28:05 +0000806 DEBUG(dbgs() << "OPTIMIZED LOADS FROM STORED ONCE POINTER: " << *GV);
Chris Lattner708148e2004-10-10 23:14:11 +0000807 ++NumGlobUses;
808 }
809
Chris Lattner708148e2004-10-10 23:14:11 +0000810 // If we nuked all of the loads, then none of the stores are needed either,
811 // nor is the global.
Chris Lattner92c6bd22009-01-14 00:12:58 +0000812 if (AllNonStoreUsesGone) {
David Greene3215b0e2010-01-05 01:28:05 +0000813 DEBUG(dbgs() << " *** GLOBAL NOW DEAD!\n");
Chris Lattner7b550cc2009-11-06 04:27:31 +0000814 CleanupConstantGlobalUsers(GV, 0);
Chris Lattner708148e2004-10-10 23:14:11 +0000815 if (GV->use_empty()) {
Chris Lattner7a7ed022004-10-16 18:09:00 +0000816 GV->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000817 ++NumDeleted;
818 }
819 Changed = true;
820 }
821 return Changed;
822}
823
Chris Lattner30ba5692004-10-11 05:54:41 +0000824/// ConstantPropUsersOf - Walk the use list of V, constant folding all of the
825/// instructions that are foldable.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000826static void ConstantPropUsersOf(Value *V) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000827 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; )
828 if (Instruction *I = dyn_cast<Instruction>(*UI++))
Chris Lattner7b550cc2009-11-06 04:27:31 +0000829 if (Constant *NewC = ConstantFoldInstruction(I)) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000830 I->replaceAllUsesWith(NewC);
831
Chris Lattnerd514d822005-02-01 01:23:31 +0000832 // Advance UI to the next non-I use to avoid invalidating it!
833 // Instructions could multiply use V.
834 while (UI != E && *UI == I)
Chris Lattner30ba5692004-10-11 05:54:41 +0000835 ++UI;
Chris Lattnerd514d822005-02-01 01:23:31 +0000836 I->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000837 }
838}
839
840/// OptimizeGlobalAddressOfMalloc - This function takes the specified global
841/// variable, and transforms the program as if it always contained the result of
842/// the specified malloc. Because it is always the result of the specified
843/// malloc, there is no reason to actually DO the malloc. Instead, turn the
Chris Lattner6e8fbad2006-11-30 17:32:29 +0000844/// malloc into a global, and any loads of GV as uses of the new global.
Chris Lattner30ba5692004-10-11 05:54:41 +0000845static GlobalVariable *OptimizeGlobalAddressOfMalloc(GlobalVariable *GV,
Victor Hernandez83d63912009-09-18 22:35:49 +0000846 CallInst *CI,
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000847 Type *AllocTy,
Chris Lattnera6874652010-02-25 22:33:52 +0000848 ConstantInt *NElements,
Victor Hernandez83d63912009-09-18 22:35:49 +0000849 TargetData* TD) {
Chris Lattnera6874652010-02-25 22:33:52 +0000850 DEBUG(errs() << "PROMOTING GLOBAL: " << *GV << " CALL = " << *CI << '\n');
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000851
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000852 Type *GlobalType;
Chris Lattnera6874652010-02-25 22:33:52 +0000853 if (NElements->getZExtValue() == 1)
854 GlobalType = AllocTy;
855 else
856 // If we have an array allocation, the global variable is of an array.
857 GlobalType = ArrayType::get(AllocTy, NElements->getZExtValue());
Victor Hernandez83d63912009-09-18 22:35:49 +0000858
859 // Create the new global variable. The contents of the malloc'd memory is
860 // undefined, so initialize with an undef value.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000861 GlobalVariable *NewGV = new GlobalVariable(*GV->getParent(),
Chris Lattnere9fd4442010-02-26 23:42:13 +0000862 GlobalType, false,
Chris Lattnera6874652010-02-25 22:33:52 +0000863 GlobalValue::InternalLinkage,
Chris Lattnere9fd4442010-02-26 23:42:13 +0000864 UndefValue::get(GlobalType),
Victor Hernandez83d63912009-09-18 22:35:49 +0000865 GV->getName()+".body",
866 GV,
867 GV->isThreadLocal());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000868
Chris Lattnera6874652010-02-25 22:33:52 +0000869 // If there are bitcast users of the malloc (which is typical, usually we have
870 // a malloc + bitcast) then replace them with uses of the new global. Update
871 // other users to use the global as well.
872 BitCastInst *TheBC = 0;
873 while (!CI->use_empty()) {
874 Instruction *User = cast<Instruction>(CI->use_back());
875 if (BitCastInst *BCI = dyn_cast<BitCastInst>(User)) {
876 if (BCI->getType() == NewGV->getType()) {
877 BCI->replaceAllUsesWith(NewGV);
878 BCI->eraseFromParent();
879 } else {
880 BCI->setOperand(0, NewGV);
881 }
882 } else {
883 if (TheBC == 0)
884 TheBC = new BitCastInst(NewGV, CI->getType(), "newgv", CI);
885 User->replaceUsesOfWith(CI, TheBC);
886 }
887 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000888
Victor Hernandez83d63912009-09-18 22:35:49 +0000889 Constant *RepValue = NewGV;
890 if (NewGV->getType() != GV->getType()->getElementType())
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000891 RepValue = ConstantExpr::getBitCast(RepValue,
Victor Hernandez83d63912009-09-18 22:35:49 +0000892 GV->getType()->getElementType());
893
894 // If there is a comparison against null, we will insert a global bool to
895 // keep track of whether the global was initialized yet or not.
896 GlobalVariable *InitBool =
Chris Lattner7b550cc2009-11-06 04:27:31 +0000897 new GlobalVariable(Type::getInt1Ty(GV->getContext()), false,
Victor Hernandez83d63912009-09-18 22:35:49 +0000898 GlobalValue::InternalLinkage,
Chris Lattner7b550cc2009-11-06 04:27:31 +0000899 ConstantInt::getFalse(GV->getContext()),
900 GV->getName()+".init", GV->isThreadLocal());
Victor Hernandez83d63912009-09-18 22:35:49 +0000901 bool InitBoolUsed = false;
902
903 // Loop over all uses of GV, processing them in turn.
Chris Lattnera6874652010-02-25 22:33:52 +0000904 while (!GV->use_empty()) {
905 if (StoreInst *SI = dyn_cast<StoreInst>(GV->use_back())) {
Victor Hernandez83d63912009-09-18 22:35:49 +0000906 // The global is initialized when the store to it occurs.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000907 new StoreInst(ConstantInt::getTrue(GV->getContext()), InitBool, SI);
Victor Hernandez83d63912009-09-18 22:35:49 +0000908 SI->eraseFromParent();
Chris Lattnera6874652010-02-25 22:33:52 +0000909 continue;
Victor Hernandez83d63912009-09-18 22:35:49 +0000910 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000911
Chris Lattnera6874652010-02-25 22:33:52 +0000912 LoadInst *LI = cast<LoadInst>(GV->use_back());
913 while (!LI->use_empty()) {
914 Use &LoadUse = LI->use_begin().getUse();
915 if (!isa<ICmpInst>(LoadUse.getUser())) {
916 LoadUse = RepValue;
917 continue;
918 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000919
Chris Lattnera6874652010-02-25 22:33:52 +0000920 ICmpInst *ICI = cast<ICmpInst>(LoadUse.getUser());
921 // Replace the cmp X, 0 with a use of the bool value.
922 Value *LV = new LoadInst(InitBool, InitBool->getName()+".val", ICI);
923 InitBoolUsed = true;
924 switch (ICI->getPredicate()) {
925 default: llvm_unreachable("Unknown ICmp Predicate!");
926 case ICmpInst::ICMP_ULT:
927 case ICmpInst::ICMP_SLT: // X < null -> always false
928 LV = ConstantInt::getFalse(GV->getContext());
929 break;
930 case ICmpInst::ICMP_ULE:
931 case ICmpInst::ICMP_SLE:
932 case ICmpInst::ICMP_EQ:
933 LV = BinaryOperator::CreateNot(LV, "notinit", ICI);
934 break;
935 case ICmpInst::ICMP_NE:
936 case ICmpInst::ICMP_UGE:
937 case ICmpInst::ICMP_SGE:
938 case ICmpInst::ICMP_UGT:
939 case ICmpInst::ICMP_SGT:
940 break; // no change.
941 }
942 ICI->replaceAllUsesWith(LV);
943 ICI->eraseFromParent();
944 }
945 LI->eraseFromParent();
946 }
Victor Hernandez83d63912009-09-18 22:35:49 +0000947
948 // If the initialization boolean was used, insert it, otherwise delete it.
949 if (!InitBoolUsed) {
950 while (!InitBool->use_empty()) // Delete initializations
Chris Lattnera6874652010-02-25 22:33:52 +0000951 cast<StoreInst>(InitBool->use_back())->eraseFromParent();
Victor Hernandez83d63912009-09-18 22:35:49 +0000952 delete InitBool;
953 } else
954 GV->getParent()->getGlobalList().insert(GV, InitBool);
955
Chris Lattnera6874652010-02-25 22:33:52 +0000956 // Now the GV is dead, nuke it and the malloc..
Victor Hernandez83d63912009-09-18 22:35:49 +0000957 GV->eraseFromParent();
Victor Hernandez83d63912009-09-18 22:35:49 +0000958 CI->eraseFromParent();
959
960 // To further other optimizations, loop over all users of NewGV and try to
961 // constant prop them. This will promote GEP instructions with constant
962 // indices into GEP constant-exprs, which will allow global-opt to hack on it.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000963 ConstantPropUsersOf(NewGV);
Victor Hernandez83d63912009-09-18 22:35:49 +0000964 if (RepValue != NewGV)
Chris Lattner7b550cc2009-11-06 04:27:31 +0000965 ConstantPropUsersOf(RepValue);
Victor Hernandez83d63912009-09-18 22:35:49 +0000966
967 return NewGV;
968}
969
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000970/// ValueIsOnlyUsedLocallyOrStoredToOneGlobal - Scan the use-list of V checking
971/// to make sure that there are no complex uses of V. We permit simple things
972/// like dereferencing the pointer, but not storing through the address, unless
973/// it is to the specified global.
Gabor Greif0b520db2010-04-06 18:58:22 +0000974static bool ValueIsOnlyUsedLocallyOrStoredToOneGlobal(const Instruction *V,
975 const GlobalVariable *GV,
Gabor Greifa01d6db2010-04-06 19:14:05 +0000976 SmallPtrSet<const PHINode*, 8> &PHIs) {
Gabor Greif0b520db2010-04-06 18:58:22 +0000977 for (Value::const_use_iterator UI = V->use_begin(), E = V->use_end();
Gabor Greifa01d6db2010-04-06 19:14:05 +0000978 UI != E; ++UI) {
Gabor Greif0b520db2010-04-06 18:58:22 +0000979 const Instruction *Inst = cast<Instruction>(*UI);
Gabor Greifa01d6db2010-04-06 19:14:05 +0000980
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000981 if (isa<LoadInst>(Inst) || isa<CmpInst>(Inst)) {
982 continue; // Fine, ignore.
983 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000984
Gabor Greif0b520db2010-04-06 18:58:22 +0000985 if (const StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000986 if (SI->getOperand(0) == V && SI->getOperand(1) != GV)
987 return false; // Storing the pointer itself... bad.
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000988 continue; // Otherwise, storing through it, or storing into GV... fine.
989 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000990
Chris Lattnera2fb2342010-04-10 18:19:22 +0000991 // Must index into the array and into the struct.
992 if (isa<GetElementPtrInst>(Inst) && Inst->getNumOperands() >= 3) {
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000993 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Inst, GV, PHIs))
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000994 return false;
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000995 continue;
996 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +0000997
Gabor Greif0b520db2010-04-06 18:58:22 +0000998 if (const PHINode *PN = dyn_cast<PHINode>(Inst)) {
Chris Lattnerc451f9c2007-09-13 16:37:20 +0000999 // PHIs are ok if all uses are ok. Don't infinitely recurse through PHI
1000 // cycles.
1001 if (PHIs.insert(PN))
Chris Lattner5e6e4942007-09-14 03:41:21 +00001002 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(PN, GV, PHIs))
1003 return false;
Chris Lattner49b6d4a2008-12-15 21:08:54 +00001004 continue;
Chris Lattnerfa07e4f2004-12-02 07:11:07 +00001005 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001006
Gabor Greif0b520db2010-04-06 18:58:22 +00001007 if (const BitCastInst *BCI = dyn_cast<BitCastInst>(Inst)) {
Chris Lattner49b6d4a2008-12-15 21:08:54 +00001008 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(BCI, GV, PHIs))
1009 return false;
1010 continue;
1011 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001012
Chris Lattner49b6d4a2008-12-15 21:08:54 +00001013 return false;
1014 }
Chris Lattnerfa07e4f2004-12-02 07:11:07 +00001015 return true;
Chris Lattnerfa07e4f2004-12-02 07:11:07 +00001016}
1017
Chris Lattner86395032006-09-30 23:32:09 +00001018/// ReplaceUsesOfMallocWithGlobal - The Alloc pointer is stored into GV
1019/// somewhere. Transform all uses of the allocation into loads from the
1020/// global and uses of the resultant pointer. Further, delete the store into
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001021/// GV. This assumes that these value pass the
Chris Lattner86395032006-09-30 23:32:09 +00001022/// 'ValueIsOnlyUsedLocallyOrStoredToOneGlobal' predicate.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001023static void ReplaceUsesOfMallocWithGlobal(Instruction *Alloc,
Chris Lattner86395032006-09-30 23:32:09 +00001024 GlobalVariable *GV) {
1025 while (!Alloc->use_empty()) {
Chris Lattnera637a8b2007-09-13 18:00:31 +00001026 Instruction *U = cast<Instruction>(*Alloc->use_begin());
1027 Instruction *InsertPt = U;
Chris Lattner86395032006-09-30 23:32:09 +00001028 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
1029 // If this is the store of the allocation into the global, remove it.
1030 if (SI->getOperand(1) == GV) {
1031 SI->eraseFromParent();
1032 continue;
1033 }
Chris Lattnera637a8b2007-09-13 18:00:31 +00001034 } else if (PHINode *PN = dyn_cast<PHINode>(U)) {
1035 // Insert the load in the corresponding predecessor, not right before the
1036 // PHI.
Gabor Greifa36791d2009-01-23 19:40:15 +00001037 InsertPt = PN->getIncomingBlock(Alloc->use_begin())->getTerminator();
Chris Lattner101f44e2008-12-15 21:44:34 +00001038 } else if (isa<BitCastInst>(U)) {
1039 // Must be bitcast between the malloc and store to initialize the global.
1040 ReplaceUsesOfMallocWithGlobal(U, GV);
1041 U->eraseFromParent();
1042 continue;
1043 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
1044 // If this is a "GEP bitcast" and the user is a store to the global, then
1045 // just process it as a bitcast.
1046 if (GEPI->hasAllZeroIndices() && GEPI->hasOneUse())
1047 if (StoreInst *SI = dyn_cast<StoreInst>(GEPI->use_back()))
1048 if (SI->getOperand(1) == GV) {
1049 // Must be bitcast GEP between the malloc and store to initialize
1050 // the global.
1051 ReplaceUsesOfMallocWithGlobal(GEPI, GV);
1052 GEPI->eraseFromParent();
1053 continue;
1054 }
Chris Lattner86395032006-09-30 23:32:09 +00001055 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001056
Chris Lattner86395032006-09-30 23:32:09 +00001057 // Insert a load from the global, and use it instead of the malloc.
Chris Lattnera637a8b2007-09-13 18:00:31 +00001058 Value *NL = new LoadInst(GV, GV->getName()+".val", InsertPt);
Chris Lattner86395032006-09-30 23:32:09 +00001059 U->replaceUsesOfWith(Alloc, NL);
1060 }
1061}
1062
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001063/// LoadUsesSimpleEnoughForHeapSRA - Verify that all uses of V (a load, or a phi
1064/// of a load) are simple enough to perform heap SRA on. This permits GEP's
1065/// that index through the array and struct field, icmps of null, and PHIs.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001066static bool LoadUsesSimpleEnoughForHeapSRA(const Value *V,
Gabor Greif27236912010-04-07 18:59:26 +00001067 SmallPtrSet<const PHINode*, 32> &LoadUsingPHIs,
1068 SmallPtrSet<const PHINode*, 32> &LoadUsingPHIsPerLoad) {
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001069 // We permit two users of the load: setcc comparing against the null
1070 // pointer, and a getelementptr of a specific form.
Gabor Greif27236912010-04-07 18:59:26 +00001071 for (Value::const_use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;
1072 ++UI) {
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001073 const Instruction *User = cast<Instruction>(*UI);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001074
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001075 // Comparison against null is ok.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001076 if (const ICmpInst *ICI = dyn_cast<ICmpInst>(User)) {
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001077 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
1078 return false;
1079 continue;
1080 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001081
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001082 // getelementptr is also ok, but only a simple form.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001083 if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001084 // Must index into the array and into the struct.
1085 if (GEPI->getNumOperands() < 3)
1086 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001087
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001088 // Otherwise the GEP is ok.
1089 continue;
1090 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001091
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001092 if (const PHINode *PN = dyn_cast<PHINode>(User)) {
Evan Cheng5d163962009-06-02 00:56:07 +00001093 if (!LoadUsingPHIsPerLoad.insert(PN))
1094 // This means some phi nodes are dependent on each other.
1095 // Avoid infinite looping!
1096 return false;
1097 if (!LoadUsingPHIs.insert(PN))
1098 // If we have already analyzed this PHI, then it is safe.
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001099 continue;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001100
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001101 // Make sure all uses of the PHI are simple enough to transform.
Evan Cheng5d163962009-06-02 00:56:07 +00001102 if (!LoadUsesSimpleEnoughForHeapSRA(PN,
1103 LoadUsingPHIs, LoadUsingPHIsPerLoad))
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001104 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001105
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001106 continue;
Chris Lattner86395032006-09-30 23:32:09 +00001107 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001108
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001109 // Otherwise we don't know what this is, not ok.
1110 return false;
1111 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001112
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001113 return true;
1114}
1115
1116
1117/// AllGlobalLoadUsesSimpleEnoughForHeapSRA - If all users of values loaded from
1118/// GV are simple enough to perform HeapSRA, return true.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001119static bool AllGlobalLoadUsesSimpleEnoughForHeapSRA(const GlobalVariable *GV,
Victor Hernandez83d63912009-09-18 22:35:49 +00001120 Instruction *StoredVal) {
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001121 SmallPtrSet<const PHINode*, 32> LoadUsingPHIs;
1122 SmallPtrSet<const PHINode*, 32> LoadUsingPHIsPerLoad;
Gabor Greif27236912010-04-07 18:59:26 +00001123 for (Value::const_use_iterator UI = GV->use_begin(), E = GV->use_end();
1124 UI != E; ++UI)
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001125 if (const LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
Evan Cheng5d163962009-06-02 00:56:07 +00001126 if (!LoadUsesSimpleEnoughForHeapSRA(LI, LoadUsingPHIs,
1127 LoadUsingPHIsPerLoad))
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001128 return false;
Evan Cheng5d163962009-06-02 00:56:07 +00001129 LoadUsingPHIsPerLoad.clear();
1130 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001131
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001132 // If we reach here, we know that all uses of the loads and transitive uses
1133 // (through PHI nodes) are simple enough to transform. However, we don't know
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001134 // that all inputs the to the PHI nodes are in the same equivalence sets.
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001135 // Check to verify that all operands of the PHIs are either PHIS that can be
1136 // transformed, loads from GV, or MI itself.
Gabor Greif27236912010-04-07 18:59:26 +00001137 for (SmallPtrSet<const PHINode*, 32>::const_iterator I = LoadUsingPHIs.begin()
1138 , E = LoadUsingPHIs.end(); I != E; ++I) {
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001139 const PHINode *PN = *I;
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001140 for (unsigned op = 0, e = PN->getNumIncomingValues(); op != e; ++op) {
1141 Value *InVal = PN->getIncomingValue(op);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001142
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001143 // PHI of the stored value itself is ok.
Victor Hernandez83d63912009-09-18 22:35:49 +00001144 if (InVal == StoredVal) continue;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001145
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001146 if (const PHINode *InPN = dyn_cast<PHINode>(InVal)) {
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001147 // One of the PHIs in our set is (optimistically) ok.
1148 if (LoadUsingPHIs.count(InPN))
1149 continue;
1150 return false;
1151 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001152
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001153 // Load from GV is ok.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001154 if (const LoadInst *LI = dyn_cast<LoadInst>(InVal))
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001155 if (LI->getOperand(0) == GV)
1156 continue;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001157
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001158 // UNDEF? NULL?
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001159
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001160 // Anything else is rejected.
1161 return false;
1162 }
1163 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001164
Chris Lattner86395032006-09-30 23:32:09 +00001165 return true;
1166}
1167
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001168static Value *GetHeapSROAValue(Value *V, unsigned FieldNo,
1169 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001170 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001171 std::vector<Value*> &FieldVals = InsertedScalarizedValues[V];
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001172
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001173 if (FieldNo >= FieldVals.size())
1174 FieldVals.resize(FieldNo+1);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001175
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001176 // If we already have this value, just reuse the previously scalarized
1177 // version.
1178 if (Value *FieldVal = FieldVals[FieldNo])
1179 return FieldVal;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001180
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001181 // Depending on what instruction this is, we have several cases.
1182 Value *Result;
1183 if (LoadInst *LI = dyn_cast<LoadInst>(V)) {
1184 // This is a scalarized version of the load from the global. Just create
1185 // a new Load of the scalarized global.
1186 Result = new LoadInst(GetHeapSROAValue(LI->getOperand(0), FieldNo,
1187 InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001188 PHIsToRewrite),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001189 LI->getName()+".f"+Twine(FieldNo), LI);
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001190 } else if (PHINode *PN = dyn_cast<PHINode>(V)) {
1191 // PN's type is pointer to struct. Make a new PHI of pointer to struct
1192 // field.
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001193 StructType *ST =
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001194 cast<StructType>(cast<PointerType>(PN->getType())->getElementType());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001195
Jay Foadd8b4fb42011-03-30 11:19:20 +00001196 PHINode *NewPN =
Owen Andersondebcb012009-07-29 22:17:13 +00001197 PHINode::Create(PointerType::getUnqual(ST->getElementType(FieldNo)),
Jay Foad3ecfc862011-03-30 11:28:46 +00001198 PN->getNumIncomingValues(),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001199 PN->getName()+".f"+Twine(FieldNo), PN);
Jay Foadd8b4fb42011-03-30 11:19:20 +00001200 Result = NewPN;
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001201 PHIsToRewrite.push_back(std::make_pair(PN, FieldNo));
1202 } else {
Torok Edwinc23197a2009-07-14 16:55:14 +00001203 llvm_unreachable("Unknown usable value");
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001204 Result = 0;
1205 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001206
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001207 return FieldVals[FieldNo] = Result;
Chris Lattnera637a8b2007-09-13 18:00:31 +00001208}
1209
Chris Lattner330245e2007-09-13 17:29:05 +00001210/// RewriteHeapSROALoadUser - Given a load instruction and a value derived from
1211/// the load, rewrite the derived value to use the HeapSRoA'd load.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001212static void RewriteHeapSROALoadUser(Instruction *LoadUser,
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001213 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001214 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattner330245e2007-09-13 17:29:05 +00001215 // If this is a comparison against null, handle it.
1216 if (ICmpInst *SCI = dyn_cast<ICmpInst>(LoadUser)) {
1217 assert(isa<ConstantPointerNull>(SCI->getOperand(1)));
1218 // If we have a setcc of the loaded pointer, we can use a setcc of any
1219 // field.
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001220 Value *NPtr = GetHeapSROAValue(SCI->getOperand(0), 0,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001221 InsertedScalarizedValues, PHIsToRewrite);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001222
Owen Anderson333c4002009-07-09 23:48:35 +00001223 Value *New = new ICmpInst(SCI, SCI->getPredicate(), NPtr,
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001224 Constant::getNullValue(NPtr->getType()),
Owen Anderson333c4002009-07-09 23:48:35 +00001225 SCI->getName());
Chris Lattner330245e2007-09-13 17:29:05 +00001226 SCI->replaceAllUsesWith(New);
1227 SCI->eraseFromParent();
1228 return;
1229 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001230
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001231 // Handle 'getelementptr Ptr, Idx, i32 FieldNo ...'
Chris Lattnera637a8b2007-09-13 18:00:31 +00001232 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(LoadUser)) {
1233 assert(GEPI->getNumOperands() >= 3 && isa<ConstantInt>(GEPI->getOperand(2))
1234 && "Unexpected GEPI!");
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001235
Chris Lattnera637a8b2007-09-13 18:00:31 +00001236 // Load the pointer for this field.
1237 unsigned FieldNo = cast<ConstantInt>(GEPI->getOperand(2))->getZExtValue();
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001238 Value *NewPtr = GetHeapSROAValue(GEPI->getOperand(0), FieldNo,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001239 InsertedScalarizedValues, PHIsToRewrite);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001240
Chris Lattnera637a8b2007-09-13 18:00:31 +00001241 // Create the new GEP idx vector.
1242 SmallVector<Value*, 8> GEPIdx;
1243 GEPIdx.push_back(GEPI->getOperand(1));
1244 GEPIdx.append(GEPI->op_begin()+3, GEPI->op_end());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001245
Gabor Greifb1dbcd82008-05-15 10:04:30 +00001246 Value *NGEPI = GetElementPtrInst::Create(NewPtr,
1247 GEPIdx.begin(), GEPIdx.end(),
Gabor Greif051a9502008-04-06 20:25:17 +00001248 GEPI->getName(), GEPI);
Chris Lattnera637a8b2007-09-13 18:00:31 +00001249 GEPI->replaceAllUsesWith(NGEPI);
1250 GEPI->eraseFromParent();
1251 return;
1252 }
Chris Lattner309f20f2007-09-13 21:31:36 +00001253
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001254 // Recursively transform the users of PHI nodes. This will lazily create the
1255 // PHIs that are needed for individual elements. Keep track of what PHIs we
1256 // see in InsertedScalarizedValues so that we don't get infinite loops (very
1257 // antisocial). If the PHI is already in InsertedScalarizedValues, it has
1258 // already been seen first by another load, so its uses have already been
1259 // processed.
1260 PHINode *PN = cast<PHINode>(LoadUser);
Chris Lattnerc30a38f2011-07-21 06:21:31 +00001261 if (!InsertedScalarizedValues.insert(std::make_pair(PN,
1262 std::vector<Value*>())).second)
1263 return;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001264
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001265 // If this is the first time we've seen this PHI, recursively process all
1266 // users.
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001267 for (Value::use_iterator UI = PN->use_begin(), E = PN->use_end(); UI != E; ) {
1268 Instruction *User = cast<Instruction>(*UI++);
Chris Lattner7b550cc2009-11-06 04:27:31 +00001269 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001270 }
Chris Lattner330245e2007-09-13 17:29:05 +00001271}
1272
Chris Lattner86395032006-09-30 23:32:09 +00001273/// RewriteUsesOfLoadForHeapSRoA - We are performing Heap SRoA on a global. Ptr
1274/// is a value loaded from the global. Eliminate all uses of Ptr, making them
1275/// use FieldGlobals instead. All uses of loaded values satisfy
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001276/// AllGlobalLoadUsesSimpleEnoughForHeapSRA.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001277static void RewriteUsesOfLoadForHeapSRoA(LoadInst *Load,
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001278 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001279 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001280 for (Value::use_iterator UI = Load->use_begin(), E = Load->use_end();
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001281 UI != E; ) {
1282 Instruction *User = cast<Instruction>(*UI++);
Chris Lattner7b550cc2009-11-06 04:27:31 +00001283 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001284 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001285
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001286 if (Load->use_empty()) {
1287 Load->eraseFromParent();
1288 InsertedScalarizedValues.erase(Load);
1289 }
Chris Lattner86395032006-09-30 23:32:09 +00001290}
1291
Victor Hernandez83d63912009-09-18 22:35:49 +00001292/// PerformHeapAllocSRoA - CI is an allocation of an array of structures. Break
1293/// it up into multiple allocations of arrays of the fields.
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001294static GlobalVariable *PerformHeapAllocSRoA(GlobalVariable *GV, CallInst *CI,
1295 Value* NElems, TargetData *TD) {
David Greene3215b0e2010-01-05 01:28:05 +00001296 DEBUG(dbgs() << "SROA HEAP ALLOC: " << *GV << " MALLOC = " << *CI << '\n');
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001297 Type* MAT = getMallocAllocatedType(CI);
1298 StructType *STy = cast<StructType>(MAT);
Victor Hernandez83d63912009-09-18 22:35:49 +00001299
1300 // There is guaranteed to be at least one use of the malloc (storing
1301 // it into GV). If there are other uses, change them to be uses of
1302 // the global to simplify later code. This also deletes the store
1303 // into GV.
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001304 ReplaceUsesOfMallocWithGlobal(CI, GV);
1305
Victor Hernandez83d63912009-09-18 22:35:49 +00001306 // Okay, at this point, there are no users of the malloc. Insert N
1307 // new mallocs at the same place as CI, and N globals.
1308 std::vector<Value*> FieldGlobals;
1309 std::vector<Value*> FieldMallocs;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001310
Victor Hernandez83d63912009-09-18 22:35:49 +00001311 for (unsigned FieldNo = 0, e = STy->getNumElements(); FieldNo != e;++FieldNo){
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001312 Type *FieldTy = STy->getElementType(FieldNo);
1313 PointerType *PFieldTy = PointerType::getUnqual(FieldTy);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001314
Victor Hernandez83d63912009-09-18 22:35:49 +00001315 GlobalVariable *NGV =
1316 new GlobalVariable(*GV->getParent(),
1317 PFieldTy, false, GlobalValue::InternalLinkage,
1318 Constant::getNullValue(PFieldTy),
1319 GV->getName() + ".f" + Twine(FieldNo), GV,
1320 GV->isThreadLocal());
1321 FieldGlobals.push_back(NGV);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001322
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001323 unsigned TypeSize = TD->getTypeAllocSize(FieldTy);
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001324 if (StructType *ST = dyn_cast<StructType>(FieldTy))
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001325 TypeSize = TD->getStructLayout(ST)->getSizeInBytes();
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001326 Type *IntPtrTy = TD->getIntPtrType(CI->getContext());
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001327 Value *NMI = CallInst::CreateMalloc(CI, IntPtrTy, FieldTy,
1328 ConstantInt::get(IntPtrTy, TypeSize),
Chris Lattner5a30a852010-07-12 00:57:28 +00001329 NElems, 0,
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001330 CI->getName() + ".f" + Twine(FieldNo));
Chris Lattner3f5e0b82010-02-26 18:23:13 +00001331 FieldMallocs.push_back(NMI);
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001332 new StoreInst(NMI, NGV, CI);
Victor Hernandez83d63912009-09-18 22:35:49 +00001333 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001334
Victor Hernandez83d63912009-09-18 22:35:49 +00001335 // The tricky aspect of this transformation is handling the case when malloc
1336 // fails. In the original code, malloc failing would set the result pointer
1337 // of malloc to null. In this case, some mallocs could succeed and others
1338 // could fail. As such, we emit code that looks like this:
1339 // F0 = malloc(field0)
1340 // F1 = malloc(field1)
1341 // F2 = malloc(field2)
1342 // if (F0 == 0 || F1 == 0 || F2 == 0) {
1343 // if (F0) { free(F0); F0 = 0; }
1344 // if (F1) { free(F1); F1 = 0; }
1345 // if (F2) { free(F2); F2 = 0; }
1346 // }
Victor Hernandez8e345a12009-11-10 08:32:25 +00001347 // The malloc can also fail if its argument is too large.
Gabor Greif9e4f2432010-06-24 14:42:01 +00001348 Constant *ConstantZero = ConstantInt::get(CI->getArgOperand(0)->getType(), 0);
1349 Value *RunningOr = new ICmpInst(CI, ICmpInst::ICMP_SLT, CI->getArgOperand(0),
Victor Hernandez8e345a12009-11-10 08:32:25 +00001350 ConstantZero, "isneg");
Victor Hernandez83d63912009-09-18 22:35:49 +00001351 for (unsigned i = 0, e = FieldMallocs.size(); i != e; ++i) {
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001352 Value *Cond = new ICmpInst(CI, ICmpInst::ICMP_EQ, FieldMallocs[i],
1353 Constant::getNullValue(FieldMallocs[i]->getType()),
1354 "isnull");
Victor Hernandez8e345a12009-11-10 08:32:25 +00001355 RunningOr = BinaryOperator::CreateOr(RunningOr, Cond, "tmp", CI);
Victor Hernandez83d63912009-09-18 22:35:49 +00001356 }
1357
1358 // Split the basic block at the old malloc.
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001359 BasicBlock *OrigBB = CI->getParent();
1360 BasicBlock *ContBB = OrigBB->splitBasicBlock(CI, "malloc_cont");
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001361
Victor Hernandez83d63912009-09-18 22:35:49 +00001362 // Create the block to check the first condition. Put all these blocks at the
1363 // end of the function as they are unlikely to be executed.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001364 BasicBlock *NullPtrBlock = BasicBlock::Create(OrigBB->getContext(),
1365 "malloc_ret_null",
Victor Hernandez83d63912009-09-18 22:35:49 +00001366 OrigBB->getParent());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001367
Victor Hernandez83d63912009-09-18 22:35:49 +00001368 // Remove the uncond branch from OrigBB to ContBB, turning it into a cond
1369 // branch on RunningOr.
1370 OrigBB->getTerminator()->eraseFromParent();
1371 BranchInst::Create(NullPtrBlock, ContBB, RunningOr, OrigBB);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001372
Victor Hernandez83d63912009-09-18 22:35:49 +00001373 // Within the NullPtrBlock, we need to emit a comparison and branch for each
1374 // pointer, because some may be null while others are not.
1375 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1376 Value *GVVal = new LoadInst(FieldGlobals[i], "tmp", NullPtrBlock);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001377 Value *Cmp = new ICmpInst(*NullPtrBlock, ICmpInst::ICMP_NE, GVVal,
Victor Hernandez83d63912009-09-18 22:35:49 +00001378 Constant::getNullValue(GVVal->getType()),
1379 "tmp");
Chris Lattner7b550cc2009-11-06 04:27:31 +00001380 BasicBlock *FreeBlock = BasicBlock::Create(Cmp->getContext(), "free_it",
Victor Hernandez83d63912009-09-18 22:35:49 +00001381 OrigBB->getParent());
Chris Lattner7b550cc2009-11-06 04:27:31 +00001382 BasicBlock *NextBlock = BasicBlock::Create(Cmp->getContext(), "next",
Victor Hernandez83d63912009-09-18 22:35:49 +00001383 OrigBB->getParent());
Victor Hernandez66284e02009-10-24 04:23:03 +00001384 Instruction *BI = BranchInst::Create(FreeBlock, NextBlock,
1385 Cmp, NullPtrBlock);
Victor Hernandez83d63912009-09-18 22:35:49 +00001386
1387 // Fill in FreeBlock.
Victor Hernandez66284e02009-10-24 04:23:03 +00001388 CallInst::CreateFree(GVVal, BI);
Victor Hernandez83d63912009-09-18 22:35:49 +00001389 new StoreInst(Constant::getNullValue(GVVal->getType()), FieldGlobals[i],
1390 FreeBlock);
1391 BranchInst::Create(NextBlock, FreeBlock);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001392
Victor Hernandez83d63912009-09-18 22:35:49 +00001393 NullPtrBlock = NextBlock;
1394 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001395
Victor Hernandez83d63912009-09-18 22:35:49 +00001396 BranchInst::Create(ContBB, NullPtrBlock);
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001397
1398 // CI is no longer needed, remove it.
Victor Hernandez83d63912009-09-18 22:35:49 +00001399 CI->eraseFromParent();
1400
1401 /// InsertedScalarizedLoads - As we process loads, if we can't immediately
1402 /// update all uses of the load, keep track of what scalarized loads are
1403 /// inserted for a given load.
1404 DenseMap<Value*, std::vector<Value*> > InsertedScalarizedValues;
1405 InsertedScalarizedValues[GV] = FieldGlobals;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001406
Victor Hernandez83d63912009-09-18 22:35:49 +00001407 std::vector<std::pair<PHINode*, unsigned> > PHIsToRewrite;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001408
Victor Hernandez83d63912009-09-18 22:35:49 +00001409 // Okay, the malloc site is completely handled. All of the uses of GV are now
1410 // loads, and all uses of those loads are simple. Rewrite them to use loads
1411 // of the per-field globals instead.
1412 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI != E;) {
1413 Instruction *User = cast<Instruction>(*UI++);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001414
Victor Hernandez83d63912009-09-18 22:35:49 +00001415 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
Chris Lattner7b550cc2009-11-06 04:27:31 +00001416 RewriteUsesOfLoadForHeapSRoA(LI, InsertedScalarizedValues, PHIsToRewrite);
Victor Hernandez83d63912009-09-18 22:35:49 +00001417 continue;
1418 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001419
Victor Hernandez83d63912009-09-18 22:35:49 +00001420 // Must be a store of null.
1421 StoreInst *SI = cast<StoreInst>(User);
1422 assert(isa<ConstantPointerNull>(SI->getOperand(0)) &&
1423 "Unexpected heap-sra user!");
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001424
Victor Hernandez83d63912009-09-18 22:35:49 +00001425 // Insert a store of null into each global.
1426 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001427 PointerType *PT = cast<PointerType>(FieldGlobals[i]->getType());
Victor Hernandez83d63912009-09-18 22:35:49 +00001428 Constant *Null = Constant::getNullValue(PT->getElementType());
1429 new StoreInst(Null, FieldGlobals[i], SI);
1430 }
1431 // Erase the original store.
1432 SI->eraseFromParent();
1433 }
1434
1435 // While we have PHIs that are interesting to rewrite, do it.
1436 while (!PHIsToRewrite.empty()) {
1437 PHINode *PN = PHIsToRewrite.back().first;
1438 unsigned FieldNo = PHIsToRewrite.back().second;
1439 PHIsToRewrite.pop_back();
1440 PHINode *FieldPN = cast<PHINode>(InsertedScalarizedValues[PN][FieldNo]);
1441 assert(FieldPN->getNumIncomingValues() == 0 &&"Already processed this phi");
1442
1443 // Add all the incoming values. This can materialize more phis.
1444 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1445 Value *InVal = PN->getIncomingValue(i);
1446 InVal = GetHeapSROAValue(InVal, FieldNo, InsertedScalarizedValues,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001447 PHIsToRewrite);
Victor Hernandez83d63912009-09-18 22:35:49 +00001448 FieldPN->addIncoming(InVal, PN->getIncomingBlock(i));
1449 }
1450 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001451
Victor Hernandez83d63912009-09-18 22:35:49 +00001452 // Drop all inter-phi links and any loads that made it this far.
1453 for (DenseMap<Value*, std::vector<Value*> >::iterator
1454 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1455 I != E; ++I) {
1456 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1457 PN->dropAllReferences();
1458 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1459 LI->dropAllReferences();
1460 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001461
Victor Hernandez83d63912009-09-18 22:35:49 +00001462 // Delete all the phis and loads now that inter-references are dead.
1463 for (DenseMap<Value*, std::vector<Value*> >::iterator
1464 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1465 I != E; ++I) {
1466 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1467 PN->eraseFromParent();
1468 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1469 LI->eraseFromParent();
1470 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001471
Victor Hernandez83d63912009-09-18 22:35:49 +00001472 // The old global is now dead, remove it.
1473 GV->eraseFromParent();
1474
1475 ++NumHeapSRA;
1476 return cast<GlobalVariable>(FieldGlobals[0]);
1477}
1478
Chris Lattnere61d0a62008-12-15 21:02:25 +00001479/// TryToOptimizeStoreOfMallocToGlobal - This function is called when we see a
1480/// pointer global variable with a single value stored it that is a malloc or
1481/// cast of malloc.
1482static bool TryToOptimizeStoreOfMallocToGlobal(GlobalVariable *GV,
Victor Hernandez83d63912009-09-18 22:35:49 +00001483 CallInst *CI,
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001484 Type *AllocTy,
Victor Hernandez83d63912009-09-18 22:35:49 +00001485 Module::global_iterator &GVI,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001486 TargetData *TD) {
Evan Cheng86cd4452010-04-14 20:52:55 +00001487 if (!TD)
1488 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001489
Victor Hernandez83d63912009-09-18 22:35:49 +00001490 // If this is a malloc of an abstract type, don't touch it.
1491 if (!AllocTy->isSized())
1492 return false;
1493
1494 // We can't optimize this global unless all uses of it are *known* to be
1495 // of the malloc value, not of the null initializer value (consider a use
1496 // that compares the global's value against zero to see if the malloc has
1497 // been reached). To do this, we check to see if all uses of the global
1498 // would trap if the global were null: this proves that they must all
1499 // happen after the malloc.
1500 if (!AllUsesOfLoadedValueWillTrapIfNull(GV))
1501 return false;
1502
1503 // We can't optimize this if the malloc itself is used in a complex way,
1504 // for example, being stored into multiple globals. This allows the
1505 // malloc to be stored into the specified global, loaded setcc'd, and
1506 // GEP'd. These are all things we could transform to using the global
1507 // for.
Evan Cheng86cd4452010-04-14 20:52:55 +00001508 SmallPtrSet<const PHINode*, 8> PHIs;
1509 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(CI, GV, PHIs))
1510 return false;
Victor Hernandez83d63912009-09-18 22:35:49 +00001511
1512 // If we have a global that is only initialized with a fixed size malloc,
1513 // transform the program to use global memory instead of malloc'd memory.
1514 // This eliminates dynamic allocation, avoids an indirection accessing the
1515 // data, and exposes the resultant global to further GlobalOpt.
Victor Hernandez8db42d22009-10-16 23:12:25 +00001516 // We cannot optimize the malloc if we cannot determine malloc array size.
Evan Cheng86cd4452010-04-14 20:52:55 +00001517 Value *NElems = getMallocArraySize(CI, TD, true);
1518 if (!NElems)
1519 return false;
Victor Hernandez83d63912009-09-18 22:35:49 +00001520
Evan Cheng86cd4452010-04-14 20:52:55 +00001521 if (ConstantInt *NElements = dyn_cast<ConstantInt>(NElems))
1522 // Restrict this transformation to only working on small allocations
1523 // (2048 bytes currently), as we don't want to introduce a 16M global or
1524 // something.
1525 if (NElements->getZExtValue() * TD->getTypeAllocSize(AllocTy) < 2048) {
1526 GVI = OptimizeGlobalAddressOfMalloc(GV, CI, AllocTy, NElements, TD);
1527 return true;
Victor Hernandez83d63912009-09-18 22:35:49 +00001528 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001529
Evan Cheng86cd4452010-04-14 20:52:55 +00001530 // If the allocation is an array of structures, consider transforming this
1531 // into multiple malloc'd arrays, one for each field. This is basically
1532 // SRoA for malloc'd memory.
1533
1534 // If this is an allocation of a fixed size array of structs, analyze as a
1535 // variable size array. malloc [100 x struct],1 -> malloc struct, 100
Gabor Greif9e4f2432010-06-24 14:42:01 +00001536 if (NElems == ConstantInt::get(CI->getArgOperand(0)->getType(), 1))
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001537 if (ArrayType *AT = dyn_cast<ArrayType>(AllocTy))
Evan Cheng86cd4452010-04-14 20:52:55 +00001538 AllocTy = AT->getElementType();
Gabor Greif9e4f2432010-06-24 14:42:01 +00001539
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001540 StructType *AllocSTy = dyn_cast<StructType>(AllocTy);
Evan Cheng86cd4452010-04-14 20:52:55 +00001541 if (!AllocSTy)
1542 return false;
1543
1544 // This the structure has an unreasonable number of fields, leave it
1545 // alone.
1546 if (AllocSTy->getNumElements() <= 16 && AllocSTy->getNumElements() != 0 &&
1547 AllGlobalLoadUsesSimpleEnoughForHeapSRA(GV, CI)) {
1548
1549 // If this is a fixed size array, transform the Malloc to be an alloc of
1550 // structs. malloc [100 x struct],1 -> malloc struct, 100
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001551 if (ArrayType *AT = dyn_cast<ArrayType>(getMallocAllocatedType(CI))) {
1552 Type *IntPtrTy = TD->getIntPtrType(CI->getContext());
Evan Cheng86cd4452010-04-14 20:52:55 +00001553 unsigned TypeSize = TD->getStructLayout(AllocSTy)->getSizeInBytes();
1554 Value *AllocSize = ConstantInt::get(IntPtrTy, TypeSize);
1555 Value *NumElements = ConstantInt::get(IntPtrTy, AT->getNumElements());
1556 Instruction *Malloc = CallInst::CreateMalloc(CI, IntPtrTy, AllocSTy,
1557 AllocSize, NumElements,
Chris Lattner5a30a852010-07-12 00:57:28 +00001558 0, CI->getName());
Evan Cheng86cd4452010-04-14 20:52:55 +00001559 Instruction *Cast = new BitCastInst(Malloc, CI->getType(), "tmp", CI);
1560 CI->replaceAllUsesWith(Cast);
1561 CI->eraseFromParent();
1562 CI = dyn_cast<BitCastInst>(Malloc) ?
1563 extractMallocCallFromBitCast(Malloc) : cast<CallInst>(Malloc);
1564 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001565
Evan Cheng86cd4452010-04-14 20:52:55 +00001566 GVI = PerformHeapAllocSRoA(GV, CI, getMallocArraySize(CI, TD, true),TD);
1567 return true;
Victor Hernandez83d63912009-09-18 22:35:49 +00001568 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001569
Victor Hernandez83d63912009-09-18 22:35:49 +00001570 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001571}
Victor Hernandez83d63912009-09-18 22:35:49 +00001572
Chris Lattner9b34a612004-10-09 21:48:45 +00001573// OptimizeOnceStoredGlobal - Try to optimize globals based on the knowledge
1574// that only one value (besides its initializer) is ever stored to the global.
Chris Lattner30ba5692004-10-11 05:54:41 +00001575static bool OptimizeOnceStoredGlobal(GlobalVariable *GV, Value *StoredOnceVal,
Chris Lattner7f8897f2006-08-27 22:42:52 +00001576 Module::global_iterator &GVI,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001577 TargetData *TD) {
Chris Lattner344b41c2008-12-15 21:20:32 +00001578 // Ignore no-op GEPs and bitcasts.
1579 StoredOnceVal = StoredOnceVal->stripPointerCasts();
Chris Lattner9b34a612004-10-09 21:48:45 +00001580
Chris Lattner708148e2004-10-10 23:14:11 +00001581 // If we are dealing with a pointer global that is initialized to null and
1582 // only has one (non-null) value stored into it, then we can optimize any
1583 // users of the loaded value (often calls and loads) that would trap if the
1584 // value was null.
Duncan Sands1df98592010-02-16 11:11:14 +00001585 if (GV->getInitializer()->getType()->isPointerTy() &&
Chris Lattner9b34a612004-10-09 21:48:45 +00001586 GV->getInitializer()->isNullValue()) {
Chris Lattner708148e2004-10-10 23:14:11 +00001587 if (Constant *SOVC = dyn_cast<Constant>(StoredOnceVal)) {
1588 if (GV->getInitializer()->getType() != SOVC->getType())
Chris Lattner98a42b22011-05-22 07:15:13 +00001589 SOVC = ConstantExpr::getBitCast(SOVC, GV->getInitializer()->getType());
Misha Brukmanfd939082005-04-21 23:48:37 +00001590
Chris Lattner708148e2004-10-10 23:14:11 +00001591 // Optimize away any trapping uses of the loaded value.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001592 if (OptimizeAwayTrappingUsesOfLoads(GV, SOVC))
Chris Lattner8be80122004-10-10 17:07:12 +00001593 return true;
Victor Hernandez83d63912009-09-18 22:35:49 +00001594 } else if (CallInst *CI = extractMallocCall(StoredOnceVal)) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001595 Type* MallocType = getMallocAllocatedType(CI);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001596 if (MallocType && TryToOptimizeStoreOfMallocToGlobal(GV, CI, MallocType,
Victor Hernandez9d0b7042009-11-07 00:16:28 +00001597 GVI, TD))
1598 return true;
Chris Lattner708148e2004-10-10 23:14:11 +00001599 }
Chris Lattner9b34a612004-10-09 21:48:45 +00001600 }
Chris Lattner30ba5692004-10-11 05:54:41 +00001601
Chris Lattner9b34a612004-10-09 21:48:45 +00001602 return false;
1603}
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001604
Chris Lattner58e44f42008-01-14 01:17:44 +00001605/// TryToShrinkGlobalToBoolean - At this point, we have learned that the only
1606/// two values ever stored into GV are its initializer and OtherVal. See if we
1607/// can shrink the global into a boolean and select between the two values
1608/// whenever it is used. This exposes the values to other scalar optimizations.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001609static bool TryToShrinkGlobalToBoolean(GlobalVariable *GV, Constant *OtherVal) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001610 Type *GVElType = GV->getType()->getElementType();
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001611
Chris Lattner58e44f42008-01-14 01:17:44 +00001612 // If GVElType is already i1, it is already shrunk. If the type of the GV is
Chris Lattner6f6923f2009-03-07 23:32:02 +00001613 // an FP value, pointer or vector, don't do this optimization because a select
1614 // between them is very expensive and unlikely to lead to later
1615 // simplification. In these cases, we typically end up with "cond ? v1 : v2"
1616 // where v1 and v2 both require constant pool loads, a big loss.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001617 if (GVElType == Type::getInt1Ty(GV->getContext()) ||
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00001618 GVElType->isFloatingPointTy() ||
Duncan Sands1df98592010-02-16 11:11:14 +00001619 GVElType->isPointerTy() || GVElType->isVectorTy())
Chris Lattner58e44f42008-01-14 01:17:44 +00001620 return false;
Gabor Greifaaaaa022010-07-12 14:13:15 +00001621
Chris Lattner58e44f42008-01-14 01:17:44 +00001622 // Walk the use list of the global seeing if all the uses are load or store.
1623 // If there is anything else, bail out.
Gabor Greifaaaaa022010-07-12 14:13:15 +00001624 for (Value::use_iterator I = GV->use_begin(), E = GV->use_end(); I != E; ++I){
1625 User *U = *I;
1626 if (!isa<LoadInst>(U) && !isa<StoreInst>(U))
Chris Lattner58e44f42008-01-14 01:17:44 +00001627 return false;
Gabor Greifaaaaa022010-07-12 14:13:15 +00001628 }
1629
David Greene3215b0e2010-01-05 01:28:05 +00001630 DEBUG(dbgs() << " *** SHRINKING TO BOOL: " << *GV);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001631
Chris Lattner96a86b22004-12-12 05:53:50 +00001632 // Create the new global, initializing it to false.
Chris Lattner7b550cc2009-11-06 04:27:31 +00001633 GlobalVariable *NewGV = new GlobalVariable(Type::getInt1Ty(GV->getContext()),
1634 false,
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001635 GlobalValue::InternalLinkage,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001636 ConstantInt::getFalse(GV->getContext()),
Nick Lewycky0e670df2009-05-03 03:49:08 +00001637 GV->getName()+".b",
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00001638 GV->isThreadLocal());
Chris Lattner96a86b22004-12-12 05:53:50 +00001639 GV->getParent()->getGlobalList().insert(GV, NewGV);
1640
1641 Constant *InitVal = GV->getInitializer();
Chris Lattner7b550cc2009-11-06 04:27:31 +00001642 assert(InitVal->getType() != Type::getInt1Ty(GV->getContext()) &&
Owen Anderson1d0be152009-08-13 21:58:54 +00001643 "No reason to shrink to bool!");
Chris Lattner96a86b22004-12-12 05:53:50 +00001644
1645 // If initialized to zero and storing one into the global, we can use a cast
1646 // instead of a select to synthesize the desired value.
1647 bool IsOneZero = false;
1648 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal))
Reid Spencercae57542007-03-02 00:28:52 +00001649 IsOneZero = InitVal->isNullValue() && CI->isOne();
Chris Lattner96a86b22004-12-12 05:53:50 +00001650
1651 while (!GV->use_empty()) {
Devang Patel771281f2009-03-06 01:39:36 +00001652 Instruction *UI = cast<Instruction>(GV->use_back());
1653 if (StoreInst *SI = dyn_cast<StoreInst>(UI)) {
Chris Lattner96a86b22004-12-12 05:53:50 +00001654 // Change the store into a boolean store.
1655 bool StoringOther = SI->getOperand(0) == OtherVal;
1656 // Only do this if we weren't storing a loaded value.
Chris Lattner38c25562004-12-12 19:34:41 +00001657 Value *StoreVal;
Chris Lattner96a86b22004-12-12 05:53:50 +00001658 if (StoringOther || SI->getOperand(0) == InitVal)
Chris Lattner7b550cc2009-11-06 04:27:31 +00001659 StoreVal = ConstantInt::get(Type::getInt1Ty(GV->getContext()),
1660 StoringOther);
Chris Lattner38c25562004-12-12 19:34:41 +00001661 else {
1662 // Otherwise, we are storing a previously loaded copy. To do this,
1663 // change the copy from copying the original value to just copying the
1664 // bool.
1665 Instruction *StoredVal = cast<Instruction>(SI->getOperand(0));
1666
Gabor Greif9e4f2432010-06-24 14:42:01 +00001667 // If we've already replaced the input, StoredVal will be a cast or
Chris Lattner38c25562004-12-12 19:34:41 +00001668 // select instruction. If not, it will be a load of the original
1669 // global.
1670 if (LoadInst *LI = dyn_cast<LoadInst>(StoredVal)) {
1671 assert(LI->getOperand(0) == GV && "Not a copy!");
1672 // Insert a new load, to preserve the saved value.
1673 StoreVal = new LoadInst(NewGV, LI->getName()+".b", LI);
1674 } else {
1675 assert((isa<CastInst>(StoredVal) || isa<SelectInst>(StoredVal)) &&
1676 "This is not a form that we understand!");
1677 StoreVal = StoredVal->getOperand(0);
1678 assert(isa<LoadInst>(StoreVal) && "Not a load of NewGV!");
1679 }
1680 }
1681 new StoreInst(StoreVal, NewGV, SI);
Devang Patel771281f2009-03-06 01:39:36 +00001682 } else {
Chris Lattner96a86b22004-12-12 05:53:50 +00001683 // Change the load into a load of bool then a select.
Devang Patel771281f2009-03-06 01:39:36 +00001684 LoadInst *LI = cast<LoadInst>(UI);
Chris Lattner046800a2007-02-11 01:08:35 +00001685 LoadInst *NLI = new LoadInst(NewGV, LI->getName()+".b", LI);
Chris Lattner96a86b22004-12-12 05:53:50 +00001686 Value *NSI;
1687 if (IsOneZero)
Chris Lattner046800a2007-02-11 01:08:35 +00001688 NSI = new ZExtInst(NLI, LI->getType(), "", LI);
Misha Brukmanfd939082005-04-21 23:48:37 +00001689 else
Gabor Greif051a9502008-04-06 20:25:17 +00001690 NSI = SelectInst::Create(NLI, OtherVal, InitVal, "", LI);
Chris Lattner046800a2007-02-11 01:08:35 +00001691 NSI->takeName(LI);
Chris Lattner96a86b22004-12-12 05:53:50 +00001692 LI->replaceAllUsesWith(NSI);
Devang Patel771281f2009-03-06 01:39:36 +00001693 }
1694 UI->eraseFromParent();
Chris Lattner96a86b22004-12-12 05:53:50 +00001695 }
1696
1697 GV->eraseFromParent();
Chris Lattner58e44f42008-01-14 01:17:44 +00001698 return true;
Chris Lattner96a86b22004-12-12 05:53:50 +00001699}
1700
1701
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001702/// ProcessInternalGlobal - Analyze the specified global variable and optimize
1703/// it if possible. If we make a change, return true.
Rafael Espindolac4440e32011-01-19 16:32:21 +00001704bool GlobalOpt::ProcessGlobal(GlobalVariable *GV,
1705 Module::global_iterator &GVI) {
1706 if (!GV->hasLocalLinkage())
1707 return false;
1708
1709 // Do more involved optimizations if the global is internal.
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001710 GV->removeDeadConstantUsers();
1711
1712 if (GV->use_empty()) {
David Greene3215b0e2010-01-05 01:28:05 +00001713 DEBUG(dbgs() << "GLOBAL DEAD: " << *GV);
Chris Lattner7a7ed022004-10-16 18:09:00 +00001714 GV->eraseFromParent();
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001715 ++NumDeleted;
1716 return true;
1717 }
1718
Rafael Espindolac4440e32011-01-19 16:32:21 +00001719 SmallPtrSet<const PHINode*, 16> PHIUsers;
1720 GlobalStatus GS;
1721
Rafael Espindoladaad56a2011-01-18 04:36:06 +00001722 if (AnalyzeGlobal(GV, GS, PHIUsers))
1723 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001724
Rafael Espindolac4440e32011-01-19 16:32:21 +00001725 if (!GS.isCompared && !GV->hasUnnamedAddr()) {
1726 GV->setUnnamedAddr(true);
1727 NumUnnamed++;
1728 }
1729
1730 if (GV->isConstant() || !GV->hasInitializer())
1731 return false;
1732
1733 return ProcessInternalGlobal(GV, GVI, PHIUsers, GS);
1734}
1735
1736/// ProcessInternalGlobal - Analyze the specified global variable and optimize
1737/// it if possible. If we make a change, return true.
1738bool GlobalOpt::ProcessInternalGlobal(GlobalVariable *GV,
1739 Module::global_iterator &GVI,
1740 const SmallPtrSet<const PHINode*, 16> &PHIUsers,
1741 const GlobalStatus &GS) {
Rafael Espindoladaad56a2011-01-18 04:36:06 +00001742 // If this is a first class global and has only one accessing function
1743 // and this function is main (which we know is not recursive we can make
1744 // this global a local variable) we replace the global with a local alloca
1745 // in this function.
1746 //
1747 // NOTE: It doesn't make sense to promote non single-value types since we
1748 // are just replacing static memory to stack memory.
1749 //
1750 // If the global is in different address space, don't bring it to stack.
1751 if (!GS.HasMultipleAccessingFunctions &&
1752 GS.AccessingFunction && !GS.HasNonInstructionUser &&
1753 GV->getType()->getElementType()->isSingleValueType() &&
1754 GS.AccessingFunction->getName() == "main" &&
1755 GS.AccessingFunction->hasExternalLinkage() &&
1756 GV->getType()->getAddressSpace() == 0) {
1757 DEBUG(dbgs() << "LOCALIZING GLOBAL: " << *GV);
1758 Instruction& FirstI = const_cast<Instruction&>(*GS.AccessingFunction
1759 ->getEntryBlock().begin());
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001760 Type* ElemTy = GV->getType()->getElementType();
Rafael Espindoladaad56a2011-01-18 04:36:06 +00001761 // FIXME: Pass Global's alignment when globals have alignment
1762 AllocaInst* Alloca = new AllocaInst(ElemTy, NULL, GV->getName(), &FirstI);
1763 if (!isa<UndefValue>(GV->getInitializer()))
1764 new StoreInst(GV->getInitializer(), Alloca, &FirstI);
Misha Brukmanfd939082005-04-21 23:48:37 +00001765
Rafael Espindoladaad56a2011-01-18 04:36:06 +00001766 GV->replaceAllUsesWith(Alloca);
1767 GV->eraseFromParent();
1768 ++NumLocalized;
1769 return true;
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001770 }
Rafael Espindoladaad56a2011-01-18 04:36:06 +00001771
1772 // If the global is never loaded (but may be stored to), it is dead.
1773 // Delete it now.
1774 if (!GS.isLoaded) {
1775 DEBUG(dbgs() << "GLOBAL NEVER LOADED: " << *GV);
1776
1777 // Delete any stores we can find to the global. We may not be able to
1778 // make it completely dead though.
1779 bool Changed = CleanupConstantGlobalUsers(GV, GV->getInitializer());
1780
1781 // If the global is dead now, delete it.
1782 if (GV->use_empty()) {
1783 GV->eraseFromParent();
1784 ++NumDeleted;
1785 Changed = true;
1786 }
1787 return Changed;
1788
1789 } else if (GS.StoredType <= GlobalStatus::isInitializerStored) {
1790 DEBUG(dbgs() << "MARKING CONSTANT: " << *GV);
1791 GV->setConstant(true);
1792
1793 // Clean up any obviously simplifiable users now.
1794 CleanupConstantGlobalUsers(GV, GV->getInitializer());
1795
1796 // If the global is dead now, just nuke it.
1797 if (GV->use_empty()) {
1798 DEBUG(dbgs() << " *** Marking constant allowed us to simplify "
1799 << "all users and delete global!\n");
1800 GV->eraseFromParent();
1801 ++NumDeleted;
1802 }
1803
1804 ++NumMarked;
1805 return true;
1806 } else if (!GV->getInitializer()->getType()->isSingleValueType()) {
1807 if (TargetData *TD = getAnalysisIfAvailable<TargetData>())
1808 if (GlobalVariable *FirstNewGV = SRAGlobal(GV, *TD)) {
1809 GVI = FirstNewGV; // Don't skip the newly produced globals!
1810 return true;
1811 }
1812 } else if (GS.StoredType == GlobalStatus::isStoredOnce) {
1813 // If the initial value for the global was an undef value, and if only
1814 // one other value was stored into it, we can just change the
1815 // initializer to be the stored value, then delete all stores to the
1816 // global. This allows us to mark it constant.
1817 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1818 if (isa<UndefValue>(GV->getInitializer())) {
1819 // Change the initial value here.
1820 GV->setInitializer(SOVConstant);
1821
1822 // Clean up any obviously simplifiable users now.
1823 CleanupConstantGlobalUsers(GV, GV->getInitializer());
1824
1825 if (GV->use_empty()) {
1826 DEBUG(dbgs() << " *** Substituting initializer allowed us to "
1827 << "simplify all users and delete global!\n");
1828 GV->eraseFromParent();
1829 ++NumDeleted;
1830 } else {
1831 GVI = GV;
1832 }
1833 ++NumSubstitute;
1834 return true;
1835 }
1836
1837 // Try to optimize globals based on the knowledge that only one value
1838 // (besides its initializer) is ever stored to the global.
1839 if (OptimizeOnceStoredGlobal(GV, GS.StoredOnceValue, GVI,
1840 getAnalysisIfAvailable<TargetData>()))
1841 return true;
1842
1843 // Otherwise, if the global was not a boolean, we can shrink it to be a
1844 // boolean.
1845 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1846 if (TryToShrinkGlobalToBoolean(GV, SOVConstant)) {
1847 ++NumShrunkToBool;
1848 return true;
1849 }
1850 }
1851
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001852 return false;
1853}
1854
Chris Lattnerfb217ad2005-05-08 22:18:06 +00001855/// ChangeCalleesToFastCall - Walk all of the direct calls of the specified
1856/// function, changing them to FastCC.
1857static void ChangeCalleesToFastCall(Function *F) {
1858 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
Duncan Sands548448a2008-02-18 17:32:13 +00001859 CallSite User(cast<Instruction>(*UI));
1860 User.setCallingConv(CallingConv::Fast);
Chris Lattnerfb217ad2005-05-08 22:18:06 +00001861 }
1862}
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001863
Devang Patel05988662008-09-25 21:00:45 +00001864static AttrListPtr StripNest(const AttrListPtr &Attrs) {
Chris Lattner58d74912008-03-12 17:45:29 +00001865 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Devang Patel05988662008-09-25 21:00:45 +00001866 if ((Attrs.getSlot(i).Attrs & Attribute::Nest) == 0)
Duncan Sands548448a2008-02-18 17:32:13 +00001867 continue;
1868
Duncan Sands548448a2008-02-18 17:32:13 +00001869 // There can be only one.
Devang Patel05988662008-09-25 21:00:45 +00001870 return Attrs.removeAttr(Attrs.getSlot(i).Index, Attribute::Nest);
Duncan Sands3d5378f2008-02-16 20:56:04 +00001871 }
1872
1873 return Attrs;
1874}
1875
1876static void RemoveNestAttribute(Function *F) {
Devang Patel05988662008-09-25 21:00:45 +00001877 F->setAttributes(StripNest(F->getAttributes()));
Duncan Sands3d5378f2008-02-16 20:56:04 +00001878 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
Duncan Sands548448a2008-02-18 17:32:13 +00001879 CallSite User(cast<Instruction>(*UI));
Devang Patel05988662008-09-25 21:00:45 +00001880 User.setAttributes(StripNest(User.getAttributes()));
Duncan Sands3d5378f2008-02-16 20:56:04 +00001881 }
1882}
1883
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001884bool GlobalOpt::OptimizeFunctions(Module &M) {
1885 bool Changed = false;
1886 // Optimize functions.
1887 for (Module::iterator FI = M.begin(), E = M.end(); FI != E; ) {
1888 Function *F = FI++;
Duncan Sandsfc5940d2009-03-06 10:21:56 +00001889 // Functions without names cannot be referenced outside this module.
1890 if (!F->hasName() && !F->isDeclaration())
1891 F->setLinkage(GlobalValue::InternalLinkage);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001892 F->removeDeadConstantUsers();
Chris Lattnerec4c7b92009-11-01 19:03:42 +00001893 if (F->use_empty() && (F->hasLocalLinkage() || F->hasLinkOnceLinkage())) {
1894 F->eraseFromParent();
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001895 Changed = true;
1896 ++NumFnDeleted;
Rafael Espindolabb46f522009-01-15 20:18:42 +00001897 } else if (F->hasLocalLinkage()) {
Duncan Sands3d5378f2008-02-16 20:56:04 +00001898 if (F->getCallingConv() == CallingConv::C && !F->isVarArg() &&
Jay Foad757068f2009-06-10 08:41:11 +00001899 !F->hasAddressTaken()) {
Duncan Sands3d5378f2008-02-16 20:56:04 +00001900 // If this function has C calling conventions, is not a varargs
1901 // function, and is only called directly, promote it to use the Fast
1902 // calling convention.
1903 F->setCallingConv(CallingConv::Fast);
1904 ChangeCalleesToFastCall(F);
1905 ++NumFastCallFns;
1906 Changed = true;
1907 }
1908
Devang Patel05988662008-09-25 21:00:45 +00001909 if (F->getAttributes().hasAttrSomewhere(Attribute::Nest) &&
Jay Foad757068f2009-06-10 08:41:11 +00001910 !F->hasAddressTaken()) {
Duncan Sands3d5378f2008-02-16 20:56:04 +00001911 // The function is not used by a trampoline intrinsic, so it is safe
1912 // to remove the 'nest' attribute.
1913 RemoveNestAttribute(F);
1914 ++NumNestRemoved;
1915 Changed = true;
1916 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001917 }
1918 }
1919 return Changed;
1920}
1921
1922bool GlobalOpt::OptimizeGlobalVars(Module &M) {
1923 bool Changed = false;
1924 for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
1925 GVI != E; ) {
1926 GlobalVariable *GV = GVI++;
Duncan Sandsfc5940d2009-03-06 10:21:56 +00001927 // Global variables without names cannot be referenced outside this module.
1928 if (!GV->hasName() && !GV->isDeclaration())
1929 GV->setLinkage(GlobalValue::InternalLinkage);
Dan Gohman01b97dd2009-11-23 16:22:21 +00001930 // Simplify the initializer.
1931 if (GV->hasInitializer())
1932 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GV->getInitializer())) {
Dan Gohmanf860db22010-04-02 03:04:37 +00001933 TargetData *TD = getAnalysisIfAvailable<TargetData>();
Dan Gohman01b97dd2009-11-23 16:22:21 +00001934 Constant *New = ConstantFoldConstantExpression(CE, TD);
1935 if (New && New != CE)
1936 GV->setInitializer(New);
1937 }
Rafael Espindolac4440e32011-01-19 16:32:21 +00001938
1939 Changed |= ProcessGlobal(GV, GVI);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001940 }
1941 return Changed;
1942}
1943
Nick Lewycky2c44a802011-04-08 07:30:21 +00001944/// FindGlobalCtors - Find the llvm.global_ctors list, verifying that all
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001945/// initializers have an init priority of 65535.
1946GlobalVariable *GlobalOpt::FindGlobalCtors(Module &M) {
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001947 GlobalVariable *GV = M.getGlobalVariable("llvm.global_ctors");
1948 if (GV == 0) return 0;
1949
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001950 // Verify that the initializer is simple enough for us to handle. We are
1951 // only allowed to optimize the initializer if it is unique.
1952 if (!GV->hasUniqueInitializer()) return 0;
Nick Lewycky5ea5c612011-04-11 22:11:20 +00001953
1954 if (isa<ConstantAggregateZero>(GV->getInitializer()))
1955 return GV;
1956 ConstantArray *CA = cast<ConstantArray>(GV->getInitializer());
Eli Friedman18a2e502011-04-09 09:11:09 +00001957
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001958 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i) {
Nick Lewycky5ea5c612011-04-11 22:11:20 +00001959 if (isa<ConstantAggregateZero>(*i))
1960 continue;
1961 ConstantStruct *CS = cast<ConstantStruct>(*i);
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001962 if (isa<ConstantPointerNull>(CS->getOperand(1)))
1963 continue;
Chris Lattner7d8e58f2005-09-26 02:19:27 +00001964
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001965 // Must have a function or null ptr.
1966 if (!isa<Function>(CS->getOperand(1)))
1967 return 0;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001968
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001969 // Init priority must be standard.
Nick Lewycky2c44a802011-04-08 07:30:21 +00001970 ConstantInt *CI = cast<ConstantInt>(CS->getOperand(0));
1971 if (CI->getZExtValue() != 65535)
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001972 return 0;
1973 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001974
Chris Lattnerf51a6cc2010-12-06 21:53:07 +00001975 return GV;
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001976}
1977
Chris Lattnerdb973e62005-09-26 02:31:18 +00001978/// ParseGlobalCtors - Given a llvm.global_ctors list that we can understand,
1979/// return a list of the functions and null terminator as a vector.
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001980static std::vector<Function*> ParseGlobalCtors(GlobalVariable *GV) {
Nick Lewycky5ea5c612011-04-11 22:11:20 +00001981 if (GV->getInitializer()->isNullValue())
1982 return std::vector<Function*>();
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001983 ConstantArray *CA = cast<ConstantArray>(GV->getInitializer());
1984 std::vector<Function*> Result;
1985 Result.reserve(CA->getNumOperands());
Gabor Greif5e463212008-05-29 01:59:18 +00001986 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i) {
1987 ConstantStruct *CS = cast<ConstantStruct>(*i);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001988 Result.push_back(dyn_cast<Function>(CS->getOperand(1)));
1989 }
1990 return Result;
1991}
1992
Chris Lattnerdb973e62005-09-26 02:31:18 +00001993/// InstallGlobalCtors - Given a specified llvm.global_ctors list, install the
1994/// specified array, returning the new global to use.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00001995static GlobalVariable *InstallGlobalCtors(GlobalVariable *GCL,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001996 const std::vector<Function*> &Ctors) {
Chris Lattnerdb973e62005-09-26 02:31:18 +00001997 // If we made a change, reassemble the initializer list.
Chris Lattnerb065b062011-06-20 04:01:31 +00001998 Constant *CSVals[2];
1999 CSVals[0] = ConstantInt::get(Type::getInt32Ty(GCL->getContext()), 65535);
2000 CSVals[1] = 0;
2001
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002002 StructType *StructTy =
Chris Lattnerb065b062011-06-20 04:01:31 +00002003 cast <StructType>(
2004 cast<ArrayType>(GCL->getType()->getElementType())->getElementType());
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002005
Chris Lattnerdb973e62005-09-26 02:31:18 +00002006 // Create the new init list.
2007 std::vector<Constant*> CAList;
2008 for (unsigned i = 0, e = Ctors.size(); i != e; ++i) {
Chris Lattner79c11012005-09-26 04:44:35 +00002009 if (Ctors[i]) {
Chris Lattnerdb973e62005-09-26 02:31:18 +00002010 CSVals[1] = Ctors[i];
Chris Lattner79c11012005-09-26 04:44:35 +00002011 } else {
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002012 Type *FTy = FunctionType::get(Type::getVoidTy(GCL->getContext()),
Chris Lattner7b550cc2009-11-06 04:27:31 +00002013 false);
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002014 PointerType *PFTy = PointerType::getUnqual(FTy);
Owen Andersona7235ea2009-07-31 20:28:14 +00002015 CSVals[1] = Constant::getNullValue(PFTy);
Chris Lattner7b550cc2009-11-06 04:27:31 +00002016 CSVals[0] = ConstantInt::get(Type::getInt32Ty(GCL->getContext()),
Nick Lewycky5ea5c612011-04-11 22:11:20 +00002017 0x7fffffff);
Chris Lattnerdb973e62005-09-26 02:31:18 +00002018 }
Chris Lattnerb065b062011-06-20 04:01:31 +00002019 CAList.push_back(ConstantStruct::get(StructTy, CSVals));
Chris Lattnerdb973e62005-09-26 02:31:18 +00002020 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002021
Chris Lattnerdb973e62005-09-26 02:31:18 +00002022 // Create the array initializer.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002023 Constant *CA = ConstantArray::get(ArrayType::get(StructTy,
Nick Lewyckyc332fba2009-09-19 20:30:26 +00002024 CAList.size()), CAList);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002025
Chris Lattnerdb973e62005-09-26 02:31:18 +00002026 // If we didn't change the number of elements, don't create a new GV.
2027 if (CA->getType() == GCL->getInitializer()->getType()) {
2028 GCL->setInitializer(CA);
2029 return GCL;
2030 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002031
Chris Lattnerdb973e62005-09-26 02:31:18 +00002032 // Create the new global and insert it next to the existing list.
Chris Lattner7b550cc2009-11-06 04:27:31 +00002033 GlobalVariable *NGV = new GlobalVariable(CA->getType(), GCL->isConstant(),
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00002034 GCL->getLinkage(), CA, "",
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00002035 GCL->isThreadLocal());
Chris Lattnerdb973e62005-09-26 02:31:18 +00002036 GCL->getParent()->getGlobalList().insert(GCL, NGV);
Chris Lattner046800a2007-02-11 01:08:35 +00002037 NGV->takeName(GCL);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002038
Chris Lattnerdb973e62005-09-26 02:31:18 +00002039 // Nuke the old list, replacing any uses with the new one.
2040 if (!GCL->use_empty()) {
2041 Constant *V = NGV;
2042 if (V->getType() != GCL->getType())
Owen Andersonbaf3c402009-07-29 18:55:55 +00002043 V = ConstantExpr::getBitCast(V, GCL->getType());
Chris Lattnerdb973e62005-09-26 02:31:18 +00002044 GCL->replaceAllUsesWith(V);
2045 }
2046 GCL->eraseFromParent();
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002047
Chris Lattnerdb973e62005-09-26 02:31:18 +00002048 if (Ctors.size())
2049 return NGV;
2050 else
2051 return 0;
2052}
Chris Lattner79c11012005-09-26 04:44:35 +00002053
2054
Chris Lattner1945d582010-12-07 04:33:29 +00002055static Constant *getVal(DenseMap<Value*, Constant*> &ComputedValues, Value *V) {
Chris Lattner79c11012005-09-26 04:44:35 +00002056 if (Constant *CV = dyn_cast<Constant>(V)) return CV;
2057 Constant *R = ComputedValues[V];
2058 assert(R && "Reference to an uncomputed value!");
2059 return R;
2060}
2061
Chris Lattner1945d582010-12-07 04:33:29 +00002062static inline bool
2063isSimpleEnoughValueToCommit(Constant *C,
2064 SmallPtrSet<Constant*, 8> &SimpleConstants);
2065
2066
2067/// isSimpleEnoughValueToCommit - Return true if the specified constant can be
2068/// handled by the code generator. We don't want to generate something like:
2069/// void *X = &X/42;
2070/// because the code generator doesn't have a relocation that can handle that.
2071///
2072/// This function should be called if C was not found (but just got inserted)
2073/// in SimpleConstants to avoid having to rescan the same constants all the
2074/// time.
2075static bool isSimpleEnoughValueToCommitHelper(Constant *C,
2076 SmallPtrSet<Constant*, 8> &SimpleConstants) {
2077 // Simple integer, undef, constant aggregate zero, global addresses, etc are
2078 // all supported.
2079 if (C->getNumOperands() == 0 || isa<BlockAddress>(C) ||
2080 isa<GlobalValue>(C))
2081 return true;
2082
2083 // Aggregate values are safe if all their elements are.
2084 if (isa<ConstantArray>(C) || isa<ConstantStruct>(C) ||
2085 isa<ConstantVector>(C)) {
2086 for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i) {
2087 Constant *Op = cast<Constant>(C->getOperand(i));
2088 if (!isSimpleEnoughValueToCommit(Op, SimpleConstants))
2089 return false;
2090 }
2091 return true;
2092 }
2093
2094 // We don't know exactly what relocations are allowed in constant expressions,
2095 // so we allow &global+constantoffset, which is safe and uniformly supported
2096 // across targets.
2097 ConstantExpr *CE = cast<ConstantExpr>(C);
2098 switch (CE->getOpcode()) {
2099 case Instruction::BitCast:
2100 case Instruction::IntToPtr:
2101 case Instruction::PtrToInt:
2102 // These casts are always fine if the casted value is.
2103 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants);
2104
2105 // GEP is fine if it is simple + constant offset.
2106 case Instruction::GetElementPtr:
2107 for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
2108 if (!isa<ConstantInt>(CE->getOperand(i)))
2109 return false;
2110 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants);
2111
2112 case Instruction::Add:
2113 // We allow simple+cst.
2114 if (!isa<ConstantInt>(CE->getOperand(1)))
2115 return false;
2116 return isSimpleEnoughValueToCommit(CE->getOperand(0), SimpleConstants);
2117 }
2118 return false;
2119}
2120
2121static inline bool
2122isSimpleEnoughValueToCommit(Constant *C,
2123 SmallPtrSet<Constant*, 8> &SimpleConstants) {
2124 // If we already checked this constant, we win.
2125 if (!SimpleConstants.insert(C)) return true;
2126 // Check the constant.
2127 return isSimpleEnoughValueToCommitHelper(C, SimpleConstants);
2128}
2129
2130
Chris Lattner79c11012005-09-26 04:44:35 +00002131/// isSimpleEnoughPointerToCommit - Return true if this constant is simple
Owen Andersoncff6b372011-01-14 22:19:20 +00002132/// enough for us to understand. In particular, if it is a cast to anything
2133/// other than from one pointer type to another pointer type, we punt.
2134/// We basically just support direct accesses to globals and GEP's of
Chris Lattner79c11012005-09-26 04:44:35 +00002135/// globals. This should be kept up to date with CommitValueTo.
Chris Lattner7b550cc2009-11-06 04:27:31 +00002136static bool isSimpleEnoughPointerToCommit(Constant *C) {
Dan Gohmance5de5b2009-09-07 22:42:05 +00002137 // Conservatively, avoid aggregate types. This is because we don't
2138 // want to worry about them partially overlapping other stores.
2139 if (!cast<PointerType>(C->getType())->getElementType()->isSingleValueType())
2140 return false;
2141
Dan Gohmanfd54a892009-09-07 22:31:26 +00002142 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
Mikhail Glushenkov99fca5d2010-10-19 16:47:23 +00002143 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
Dan Gohmanfd54a892009-09-07 22:31:26 +00002144 // external globals.
Mikhail Glushenkov99fca5d2010-10-19 16:47:23 +00002145 return GV->hasUniqueInitializer();
Dan Gohmanfd54a892009-09-07 22:31:26 +00002146
Owen Andersone95a32c2011-01-14 22:31:13 +00002147 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002148 // Handle a constantexpr gep.
2149 if (CE->getOpcode() == Instruction::GetElementPtr &&
Dan Gohmanc62482d2009-09-07 22:40:13 +00002150 isa<GlobalVariable>(CE->getOperand(0)) &&
2151 cast<GEPOperator>(CE)->isInBounds()) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002152 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Mikhail Glushenkov99fca5d2010-10-19 16:47:23 +00002153 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
Dan Gohmanfd54a892009-09-07 22:31:26 +00002154 // external globals.
Mikhail Glushenkov99fca5d2010-10-19 16:47:23 +00002155 if (!GV->hasUniqueInitializer())
Dan Gohmanfd54a892009-09-07 22:31:26 +00002156 return false;
Dan Gohman80bdc962009-09-07 22:44:55 +00002157
Dan Gohman80bdc962009-09-07 22:44:55 +00002158 // The first index must be zero.
Oscar Fuentesee56c422010-08-02 06:00:15 +00002159 ConstantInt *CI = dyn_cast<ConstantInt>(*llvm::next(CE->op_begin()));
Dan Gohman80bdc962009-09-07 22:44:55 +00002160 if (!CI || !CI->isZero()) return false;
Dan Gohman80bdc962009-09-07 22:44:55 +00002161
2162 // The remaining indices must be compile-time known integers within the
Dan Gohmane6992f72009-09-10 23:37:55 +00002163 // notional bounds of the corresponding static array types.
2164 if (!CE->isGEPWithNoNotionalOverIndexing())
2165 return false;
Dan Gohman80bdc962009-09-07 22:44:55 +00002166
Dan Gohmanc6f69e92009-10-05 16:36:26 +00002167 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
Owen Andersoncff6b372011-01-14 22:19:20 +00002168
2169 // A constantexpr bitcast from a pointer to another pointer is a no-op,
2170 // and we know how to evaluate it by moving the bitcast from the pointer
2171 // operand to the value operand.
2172 } else if (CE->getOpcode() == Instruction::BitCast &&
Chris Lattnerd5f656f2011-01-16 02:05:10 +00002173 isa<GlobalVariable>(CE->getOperand(0))) {
Owen Andersoncff6b372011-01-14 22:19:20 +00002174 // Do not allow weak/*_odr/linkonce/dllimport/dllexport linkage or
2175 // external globals.
Chris Lattnerd5f656f2011-01-16 02:05:10 +00002176 return cast<GlobalVariable>(CE->getOperand(0))->hasUniqueInitializer();
Chris Lattner798b4d52005-09-26 06:52:44 +00002177 }
Owen Andersone95a32c2011-01-14 22:31:13 +00002178 }
2179
Chris Lattner79c11012005-09-26 04:44:35 +00002180 return false;
2181}
2182
Chris Lattner798b4d52005-09-26 06:52:44 +00002183/// EvaluateStoreInto - Evaluate a piece of a constantexpr store into a global
2184/// initializer. This returns 'Init' modified to reflect 'Val' stored into it.
2185/// At this point, the GEP operands of Addr [0, OpNo) have been stepped into.
2186static Constant *EvaluateStoreInto(Constant *Init, Constant *Val,
Chris Lattner7b550cc2009-11-06 04:27:31 +00002187 ConstantExpr *Addr, unsigned OpNo) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002188 // Base case of the recursion.
2189 if (OpNo == Addr->getNumOperands()) {
2190 assert(Val->getType() == Init->getType() && "Type mismatch!");
2191 return Val;
2192 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002193
Chris Lattnera0e9a242010-01-07 01:16:21 +00002194 std::vector<Constant*> Elts;
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002195 if (StructType *STy = dyn_cast<StructType>(Init->getType())) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002196
2197 // Break up the constant into its elements.
2198 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Init)) {
Gabor Greif5e463212008-05-29 01:59:18 +00002199 for (User::op_iterator i = CS->op_begin(), e = CS->op_end(); i != e; ++i)
2200 Elts.push_back(cast<Constant>(*i));
Chris Lattner798b4d52005-09-26 06:52:44 +00002201 } else if (isa<ConstantAggregateZero>(Init)) {
2202 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
Owen Andersona7235ea2009-07-31 20:28:14 +00002203 Elts.push_back(Constant::getNullValue(STy->getElementType(i)));
Chris Lattner798b4d52005-09-26 06:52:44 +00002204 } else if (isa<UndefValue>(Init)) {
2205 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
Owen Anderson9e9a0d52009-07-30 23:03:37 +00002206 Elts.push_back(UndefValue::get(STy->getElementType(i)));
Chris Lattner798b4d52005-09-26 06:52:44 +00002207 } else {
Torok Edwinc23197a2009-07-14 16:55:14 +00002208 llvm_unreachable("This code is out of sync with "
Chris Lattner798b4d52005-09-26 06:52:44 +00002209 " ConstantFoldLoadThroughGEPConstantExpr");
2210 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002211
Chris Lattner798b4d52005-09-26 06:52:44 +00002212 // Replace the element that we are supposed to.
Reid Spencerb83eb642006-10-20 07:07:24 +00002213 ConstantInt *CU = cast<ConstantInt>(Addr->getOperand(OpNo));
2214 unsigned Idx = CU->getZExtValue();
2215 assert(Idx < STy->getNumElements() && "Struct index out of range!");
Chris Lattner7b550cc2009-11-06 04:27:31 +00002216 Elts[Idx] = EvaluateStoreInto(Elts[Idx], Val, Addr, OpNo+1);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002217
Chris Lattner798b4d52005-09-26 06:52:44 +00002218 // Return the modified struct.
Chris Lattnerb065b062011-06-20 04:01:31 +00002219 return ConstantStruct::get(STy, Elts);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002220 }
Chris Lattnerb065b062011-06-20 04:01:31 +00002221
2222 ConstantInt *CI = cast<ConstantInt>(Addr->getOperand(OpNo));
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002223 SequentialType *InitTy = cast<SequentialType>(Init->getType());
Chris Lattnerb065b062011-06-20 04:01:31 +00002224
2225 uint64_t NumElts;
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002226 if (ArrayType *ATy = dyn_cast<ArrayType>(InitTy))
Chris Lattnerb065b062011-06-20 04:01:31 +00002227 NumElts = ATy->getNumElements();
2228 else
2229 NumElts = cast<VectorType>(InitTy)->getNumElements();
2230
2231 // Break up the array into elements.
2232 if (ConstantArray *CA = dyn_cast<ConstantArray>(Init)) {
2233 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i)
2234 Elts.push_back(cast<Constant>(*i));
2235 } else if (ConstantVector *CV = dyn_cast<ConstantVector>(Init)) {
2236 for (User::op_iterator i = CV->op_begin(), e = CV->op_end(); i != e; ++i)
2237 Elts.push_back(cast<Constant>(*i));
2238 } else if (isa<ConstantAggregateZero>(Init)) {
2239 Elts.assign(NumElts, Constant::getNullValue(InitTy->getElementType()));
2240 } else {
2241 assert(isa<UndefValue>(Init) && "This code is out of sync with "
2242 " ConstantFoldLoadThroughGEPConstantExpr");
2243 Elts.assign(NumElts, UndefValue::get(InitTy->getElementType()));
2244 }
2245
2246 assert(CI->getZExtValue() < NumElts);
2247 Elts[CI->getZExtValue()] =
2248 EvaluateStoreInto(Elts[CI->getZExtValue()], Val, Addr, OpNo+1);
2249
2250 if (Init->getType()->isArrayTy())
2251 return ConstantArray::get(cast<ArrayType>(InitTy), Elts);
2252 return ConstantVector::get(Elts);
Chris Lattner798b4d52005-09-26 06:52:44 +00002253}
2254
Chris Lattner79c11012005-09-26 04:44:35 +00002255/// CommitValueTo - We have decided that Addr (which satisfies the predicate
2256/// isSimpleEnoughPointerToCommit) should get Val as its value. Make it happen.
Chris Lattner7b550cc2009-11-06 04:27:31 +00002257static void CommitValueTo(Constant *Val, Constant *Addr) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002258 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Addr)) {
2259 assert(GV->hasInitializer());
2260 GV->setInitializer(Val);
2261 return;
2262 }
Chris Lattnera0e9a242010-01-07 01:16:21 +00002263
Chris Lattner798b4d52005-09-26 06:52:44 +00002264 ConstantExpr *CE = cast<ConstantExpr>(Addr);
2265 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Chris Lattnera0e9a242010-01-07 01:16:21 +00002266 GV->setInitializer(EvaluateStoreInto(GV->getInitializer(), Val, CE, 2));
Chris Lattner79c11012005-09-26 04:44:35 +00002267}
2268
Chris Lattner562a0552005-09-26 05:16:34 +00002269/// ComputeLoadResult - Return the value that would be computed by a load from
2270/// P after the stores reflected by 'memory' have been performed. If we can't
2271/// decide, return null.
Chris Lattner04de1cf2005-09-26 05:15:37 +00002272static Constant *ComputeLoadResult(Constant *P,
Chris Lattner7b550cc2009-11-06 04:27:31 +00002273 const DenseMap<Constant*, Constant*> &Memory) {
Chris Lattner04de1cf2005-09-26 05:15:37 +00002274 // If this memory location has been recently stored, use the stored value: it
2275 // is the most up-to-date.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002276 DenseMap<Constant*, Constant*>::const_iterator I = Memory.find(P);
Chris Lattner04de1cf2005-09-26 05:15:37 +00002277 if (I != Memory.end()) return I->second;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002278
Chris Lattner04de1cf2005-09-26 05:15:37 +00002279 // Access it.
2280 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(P)) {
Dan Gohman82555732009-08-19 18:20:44 +00002281 if (GV->hasDefinitiveInitializer())
Chris Lattner04de1cf2005-09-26 05:15:37 +00002282 return GV->getInitializer();
2283 return 0;
Chris Lattner04de1cf2005-09-26 05:15:37 +00002284 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002285
Chris Lattner798b4d52005-09-26 06:52:44 +00002286 // Handle a constantexpr getelementptr.
2287 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(P))
2288 if (CE->getOpcode() == Instruction::GetElementPtr &&
2289 isa<GlobalVariable>(CE->getOperand(0))) {
2290 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Dan Gohman82555732009-08-19 18:20:44 +00002291 if (GV->hasDefinitiveInitializer())
Dan Gohmanc6f69e92009-10-05 16:36:26 +00002292 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
Chris Lattner798b4d52005-09-26 06:52:44 +00002293 }
2294
2295 return 0; // don't know how to evaluate.
Chris Lattner04de1cf2005-09-26 05:15:37 +00002296}
2297
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002298/// EvaluateFunction - Evaluate a call to function F, returning true if
2299/// successful, false if we can't evaluate it. ActualArgs contains the formal
2300/// arguments for the function.
Chris Lattnercd271422005-09-27 04:45:34 +00002301static bool EvaluateFunction(Function *F, Constant *&RetVal,
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002302 const SmallVectorImpl<Constant*> &ActualArgs,
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002303 std::vector<Function*> &CallStack,
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002304 DenseMap<Constant*, Constant*> &MutatedMemory,
Chris Lattner1945d582010-12-07 04:33:29 +00002305 std::vector<GlobalVariable*> &AllocaTmps,
2306 SmallPtrSet<Constant*, 8> &SimpleConstants,
2307 const TargetData *TD) {
Chris Lattnercd271422005-09-27 04:45:34 +00002308 // Check to see if this function is already executing (recursion). If so,
2309 // bail out. TODO: we might want to accept limited recursion.
2310 if (std::find(CallStack.begin(), CallStack.end(), F) != CallStack.end())
2311 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002312
Chris Lattnercd271422005-09-27 04:45:34 +00002313 CallStack.push_back(F);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002314
Chris Lattner79c11012005-09-26 04:44:35 +00002315 /// Values - As we compute SSA register values, we store their contents here.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002316 DenseMap<Value*, Constant*> Values;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002317
Chris Lattnercd271422005-09-27 04:45:34 +00002318 // Initialize arguments to the incoming values specified.
2319 unsigned ArgNo = 0;
2320 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end(); AI != E;
2321 ++AI, ++ArgNo)
2322 Values[AI] = ActualArgs[ArgNo];
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002323
Chris Lattnercdf98be2005-09-26 04:57:38 +00002324 /// ExecutedBlocks - We only handle non-looping, non-recursive code. As such,
2325 /// we can only evaluate any one basic block at most once. This set keeps
2326 /// track of what we have executed so we can detect recursive cases etc.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002327 SmallPtrSet<BasicBlock*, 32> ExecutedBlocks;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002328
Chris Lattner79c11012005-09-26 04:44:35 +00002329 // CurInst - The current instruction we're evaluating.
2330 BasicBlock::iterator CurInst = F->begin()->begin();
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002331
Chris Lattner79c11012005-09-26 04:44:35 +00002332 // This is the main evaluation loop.
2333 while (1) {
2334 Constant *InstResult = 0;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002335
Chris Lattner79c11012005-09-26 04:44:35 +00002336 if (StoreInst *SI = dyn_cast<StoreInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002337 if (SI->isVolatile()) return false; // no volatile accesses.
Chris Lattner79c11012005-09-26 04:44:35 +00002338 Constant *Ptr = getVal(Values, SI->getOperand(1));
Chris Lattner7b550cc2009-11-06 04:27:31 +00002339 if (!isSimpleEnoughPointerToCommit(Ptr))
Chris Lattner79c11012005-09-26 04:44:35 +00002340 // If this is too complex for us to commit, reject it.
Chris Lattnercd271422005-09-27 04:45:34 +00002341 return false;
Chris Lattner1945d582010-12-07 04:33:29 +00002342
Chris Lattner79c11012005-09-26 04:44:35 +00002343 Constant *Val = getVal(Values, SI->getOperand(0));
Chris Lattner1945d582010-12-07 04:33:29 +00002344
2345 // If this might be too difficult for the backend to handle (e.g. the addr
2346 // of one global variable divided by another) then we can't commit it.
2347 if (!isSimpleEnoughValueToCommit(Val, SimpleConstants))
2348 return false;
Owen Andersoncff6b372011-01-14 22:19:20 +00002349
2350 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
2351 if (CE->getOpcode() == Instruction::BitCast) {
2352 // If we're evaluating a store through a bitcast, then we need
2353 // to pull the bitcast off the pointer type and push it onto the
2354 // stored value.
Chris Lattnerd5f656f2011-01-16 02:05:10 +00002355 Ptr = CE->getOperand(0);
Owen Andersoncff6b372011-01-14 22:19:20 +00002356
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002357 Type *NewTy=cast<PointerType>(Ptr->getType())->getElementType();
Owen Andersoncff6b372011-01-14 22:19:20 +00002358
Owen Anderson66f708f2011-01-16 04:33:33 +00002359 // In order to push the bitcast onto the stored value, a bitcast
2360 // from NewTy to Val's type must be legal. If it's not, we can try
2361 // introspecting NewTy to find a legal conversion.
2362 while (!Val->getType()->canLosslesslyBitCastTo(NewTy)) {
2363 // If NewTy is a struct, we can convert the pointer to the struct
2364 // into a pointer to its first member.
2365 // FIXME: This could be extended to support arrays as well.
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002366 if (StructType *STy = dyn_cast<StructType>(NewTy)) {
Owen Anderson66f708f2011-01-16 04:33:33 +00002367 NewTy = STy->getTypeAtIndex(0U);
2368
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002369 IntegerType *IdxTy =IntegerType::get(NewTy->getContext(), 32);
Owen Anderson66f708f2011-01-16 04:33:33 +00002370 Constant *IdxZero = ConstantInt::get(IdxTy, 0, false);
2371 Constant * const IdxList[] = {IdxZero, IdxZero};
2372
2373 Ptr = ConstantExpr::getGetElementPtr(Ptr, IdxList, 2);
Owen Andersoncff6b372011-01-14 22:19:20 +00002374
Owen Anderson66f708f2011-01-16 04:33:33 +00002375 // If we can't improve the situation by introspecting NewTy,
2376 // we have to give up.
2377 } else {
2378 return 0;
2379 }
Owen Andersoncff6b372011-01-14 22:19:20 +00002380 }
2381
Owen Anderson66f708f2011-01-16 04:33:33 +00002382 // If we found compatible types, go ahead and push the bitcast
2383 // onto the stored value.
Owen Andersoncff6b372011-01-14 22:19:20 +00002384 Val = ConstantExpr::getBitCast(Val, NewTy);
2385 }
2386
Chris Lattner79c11012005-09-26 04:44:35 +00002387 MutatedMemory[Ptr] = Val;
2388 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CurInst)) {
Owen Andersonbaf3c402009-07-29 18:55:55 +00002389 InstResult = ConstantExpr::get(BO->getOpcode(),
Chris Lattner79c11012005-09-26 04:44:35 +00002390 getVal(Values, BO->getOperand(0)),
2391 getVal(Values, BO->getOperand(1)));
Reid Spencere4d87aa2006-12-23 06:05:41 +00002392 } else if (CmpInst *CI = dyn_cast<CmpInst>(CurInst)) {
Owen Andersonbaf3c402009-07-29 18:55:55 +00002393 InstResult = ConstantExpr::getCompare(CI->getPredicate(),
Reid Spencere4d87aa2006-12-23 06:05:41 +00002394 getVal(Values, CI->getOperand(0)),
2395 getVal(Values, CI->getOperand(1)));
Chris Lattner79c11012005-09-26 04:44:35 +00002396 } else if (CastInst *CI = dyn_cast<CastInst>(CurInst)) {
Owen Andersonbaf3c402009-07-29 18:55:55 +00002397 InstResult = ConstantExpr::getCast(CI->getOpcode(),
Chris Lattner9a989f02006-11-30 17:26:08 +00002398 getVal(Values, CI->getOperand(0)),
Chris Lattner79c11012005-09-26 04:44:35 +00002399 CI->getType());
2400 } else if (SelectInst *SI = dyn_cast<SelectInst>(CurInst)) {
Gabor Greif9e4f2432010-06-24 14:42:01 +00002401 InstResult = ConstantExpr::getSelect(getVal(Values, SI->getOperand(0)),
Eric Christopher551754c2010-04-16 23:37:20 +00002402 getVal(Values, SI->getOperand(1)),
2403 getVal(Values, SI->getOperand(2)));
Chris Lattner04de1cf2005-09-26 05:15:37 +00002404 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(CurInst)) {
2405 Constant *P = getVal(Values, GEP->getOperand(0));
Chris Lattner55eb1c42007-01-31 04:40:53 +00002406 SmallVector<Constant*, 8> GEPOps;
Gabor Greif5e463212008-05-29 01:59:18 +00002407 for (User::op_iterator i = GEP->op_begin() + 1, e = GEP->op_end();
2408 i != e; ++i)
2409 GEPOps.push_back(getVal(Values, *i));
Dan Gohman4a7e6b72009-09-07 22:34:43 +00002410 InstResult = cast<GEPOperator>(GEP)->isInBounds() ?
Jay Foaddab3d292011-07-21 14:31:17 +00002411 ConstantExpr::getInBoundsGetElementPtr(P, GEPOps) :
2412 ConstantExpr::getGetElementPtr(P, GEPOps);
Chris Lattner04de1cf2005-09-26 05:15:37 +00002413 } else if (LoadInst *LI = dyn_cast<LoadInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002414 if (LI->isVolatile()) return false; // no volatile accesses.
Chris Lattner04de1cf2005-09-26 05:15:37 +00002415 InstResult = ComputeLoadResult(getVal(Values, LI->getOperand(0)),
Chris Lattner7b550cc2009-11-06 04:27:31 +00002416 MutatedMemory);
Chris Lattnercd271422005-09-27 04:45:34 +00002417 if (InstResult == 0) return false; // Could not evaluate load.
Chris Lattnera22fdb02005-09-26 17:07:09 +00002418 } else if (AllocaInst *AI = dyn_cast<AllocaInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002419 if (AI->isArrayAllocation()) return false; // Cannot handle array allocs.
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002420 Type *Ty = AI->getType()->getElementType();
Chris Lattner7b550cc2009-11-06 04:27:31 +00002421 AllocaTmps.push_back(new GlobalVariable(Ty, false,
Chris Lattnera22fdb02005-09-26 17:07:09 +00002422 GlobalValue::InternalLinkage,
Owen Anderson9e9a0d52009-07-30 23:03:37 +00002423 UndefValue::get(Ty),
Chris Lattnera22fdb02005-09-26 17:07:09 +00002424 AI->getName()));
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002425 InstResult = AllocaTmps.back();
Chris Lattnercd271422005-09-27 04:45:34 +00002426 } else if (CallInst *CI = dyn_cast<CallInst>(CurInst)) {
Devang Patel412a4462009-03-09 23:04:12 +00002427
2428 // Debug info can safely be ignored here.
2429 if (isa<DbgInfoIntrinsic>(CI)) {
2430 ++CurInst;
2431 continue;
2432 }
2433
Chris Lattner7cd580f2006-07-07 21:37:01 +00002434 // Cannot handle inline asm.
Gabor Greifa9b23132010-04-20 13:13:04 +00002435 if (isa<InlineAsm>(CI->getCalledValue())) return false;
Chris Lattner7cd580f2006-07-07 21:37:01 +00002436
Nick Lewycky1f237b02011-05-29 18:41:56 +00002437 if (MemSetInst *MSI = dyn_cast<MemSetInst>(CI)) {
2438 if (MSI->isVolatile()) return false;
2439 Constant *Ptr = getVal(Values, MSI->getDest());
2440 Constant *Val = getVal(Values, MSI->getValue());
2441 Constant *DestVal = ComputeLoadResult(getVal(Values, Ptr),
2442 MutatedMemory);
Nick Lewyckybcb85082011-05-29 19:33:36 +00002443 if (Val->isNullValue() && DestVal && DestVal->isNullValue()) {
Nick Lewycky1f237b02011-05-29 18:41:56 +00002444 // This memset is a no-op.
2445 ++CurInst;
2446 continue;
2447 }
2448 return false;
2449 }
2450
Chris Lattnercd271422005-09-27 04:45:34 +00002451 // Resolve function pointers.
Gabor Greifa3997812010-07-22 10:37:47 +00002452 Function *Callee = dyn_cast<Function>(getVal(Values,
2453 CI->getCalledValue()));
Chris Lattnercd271422005-09-27 04:45:34 +00002454 if (!Callee) return false; // Cannot resolve.
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002455
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002456 SmallVector<Constant*, 8> Formals;
Gabor Greif9e4f2432010-06-24 14:42:01 +00002457 CallSite CS(CI);
2458 for (User::op_iterator i = CS.arg_begin(), e = CS.arg_end();
Gabor Greif5e463212008-05-29 01:59:18 +00002459 i != e; ++i)
2460 Formals.push_back(getVal(Values, *i));
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002461
Reid Spencer5cbf9852007-01-30 20:08:39 +00002462 if (Callee->isDeclaration()) {
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002463 // If this is a function we can constant fold, do it.
Jay Foad1d2f5692011-07-19 13:32:40 +00002464 if (Constant *C = ConstantFoldCall(Callee, Formals)) {
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002465 InstResult = C;
2466 } else {
2467 return false;
2468 }
2469 } else {
2470 if (Callee->getFunctionType()->isVarArg())
2471 return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002472
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002473 Constant *RetVal;
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002474 // Execute the call, if successful, use the return value.
2475 if (!EvaluateFunction(Callee, RetVal, Formals, CallStack,
Chris Lattner1945d582010-12-07 04:33:29 +00002476 MutatedMemory, AllocaTmps, SimpleConstants, TD))
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002477 return false;
2478 InstResult = RetVal;
2479 }
Reid Spencer3ed469c2006-11-02 20:25:50 +00002480 } else if (isa<TerminatorInst>(CurInst)) {
Chris Lattnercdf98be2005-09-26 04:57:38 +00002481 BasicBlock *NewBB = 0;
2482 if (BranchInst *BI = dyn_cast<BranchInst>(CurInst)) {
2483 if (BI->isUnconditional()) {
2484 NewBB = BI->getSuccessor(0);
2485 } else {
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00002486 ConstantInt *Cond =
2487 dyn_cast<ConstantInt>(getVal(Values, BI->getCondition()));
Chris Lattner97d1fad2007-01-12 18:30:11 +00002488 if (!Cond) return false; // Cannot determine.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00002489
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002490 NewBB = BI->getSuccessor(!Cond->getZExtValue());
Chris Lattnercdf98be2005-09-26 04:57:38 +00002491 }
2492 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurInst)) {
2493 ConstantInt *Val =
2494 dyn_cast<ConstantInt>(getVal(Values, SI->getCondition()));
Chris Lattnercd271422005-09-27 04:45:34 +00002495 if (!Val) return false; // Cannot determine.
Chris Lattnercdf98be2005-09-26 04:57:38 +00002496 NewBB = SI->getSuccessor(SI->findCaseValue(Val));
Chris Lattnerb3d5a652009-10-29 05:51:50 +00002497 } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(CurInst)) {
2498 Value *Val = getVal(Values, IBI->getAddress())->stripPointerCasts();
2499 if (BlockAddress *BA = dyn_cast<BlockAddress>(Val))
2500 NewBB = BA->getBasicBlock();
Chris Lattnercdfc9402009-11-01 01:27:45 +00002501 else
2502 return false; // Cannot determine.
Chris Lattnercdf98be2005-09-26 04:57:38 +00002503 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002504 if (RI->getNumOperands())
2505 RetVal = getVal(Values, RI->getOperand(0));
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002506
Chris Lattnercd271422005-09-27 04:45:34 +00002507 CallStack.pop_back(); // return from fn.
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002508 return true; // We succeeded at evaluating this ctor!
Chris Lattnercdf98be2005-09-26 04:57:38 +00002509 } else {
Chris Lattnercd271422005-09-27 04:45:34 +00002510 // invoke, unwind, unreachable.
2511 return false; // Cannot handle this terminator.
Chris Lattnercdf98be2005-09-26 04:57:38 +00002512 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002513
Chris Lattnercdf98be2005-09-26 04:57:38 +00002514 // Okay, we succeeded in evaluating this control flow. See if we have
Chris Lattnercd271422005-09-27 04:45:34 +00002515 // executed the new block before. If so, we have a looping function,
2516 // which we cannot evaluate in reasonable time.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002517 if (!ExecutedBlocks.insert(NewBB))
Chris Lattnercd271422005-09-27 04:45:34 +00002518 return false; // looped!
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002519
Chris Lattnercdf98be2005-09-26 04:57:38 +00002520 // Okay, we have never been in this block before. Check to see if there
2521 // are any PHI nodes. If so, evaluate them with information about where
2522 // we came from.
2523 BasicBlock *OldBB = CurInst->getParent();
2524 CurInst = NewBB->begin();
2525 PHINode *PN;
2526 for (; (PN = dyn_cast<PHINode>(CurInst)); ++CurInst)
2527 Values[PN] = getVal(Values, PN->getIncomingValueForBlock(OldBB));
2528
2529 // Do NOT increment CurInst. We know that the terminator had no value.
2530 continue;
Chris Lattner79c11012005-09-26 04:44:35 +00002531 } else {
Chris Lattner79c11012005-09-26 04:44:35 +00002532 // Did not know how to evaluate this!
Chris Lattnercd271422005-09-27 04:45:34 +00002533 return false;
Chris Lattner79c11012005-09-26 04:44:35 +00002534 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002535
Chris Lattner1945d582010-12-07 04:33:29 +00002536 if (!CurInst->use_empty()) {
2537 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(InstResult))
2538 InstResult = ConstantFoldConstantExpression(CE, TD);
2539
Chris Lattner79c11012005-09-26 04:44:35 +00002540 Values[CurInst] = InstResult;
Chris Lattner1945d582010-12-07 04:33:29 +00002541 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002542
Chris Lattner79c11012005-09-26 04:44:35 +00002543 // Advance program counter.
2544 ++CurInst;
2545 }
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002546}
2547
2548/// EvaluateStaticConstructor - Evaluate static constructors in the function, if
2549/// we can. Return true if we can, false otherwise.
Chris Lattner1945d582010-12-07 04:33:29 +00002550static bool EvaluateStaticConstructor(Function *F, const TargetData *TD) {
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002551 /// MutatedMemory - For each store we execute, we update this map. Loads
2552 /// check this to get the most up-to-date value. If evaluation is successful,
2553 /// this state is committed to the process.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002554 DenseMap<Constant*, Constant*> MutatedMemory;
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002555
2556 /// AllocaTmps - To 'execute' an alloca, we create a temporary global variable
2557 /// to represent its body. This vector is needed so we can delete the
2558 /// temporary globals when we are done.
2559 std::vector<GlobalVariable*> AllocaTmps;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002560
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002561 /// CallStack - This is used to detect recursion. In pathological situations
2562 /// we could hit exponential behavior, but at least there is nothing
2563 /// unbounded.
2564 std::vector<Function*> CallStack;
2565
Chris Lattner1945d582010-12-07 04:33:29 +00002566 /// SimpleConstants - These are constants we have checked and know to be
2567 /// simple enough to live in a static initializer of a global.
2568 SmallPtrSet<Constant*, 8> SimpleConstants;
2569
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002570 // Call the function.
Chris Lattnercd271422005-09-27 04:45:34 +00002571 Constant *RetValDummy;
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002572 bool EvalSuccess = EvaluateFunction(F, RetValDummy,
2573 SmallVector<Constant*, 0>(), CallStack,
Chris Lattner1945d582010-12-07 04:33:29 +00002574 MutatedMemory, AllocaTmps,
2575 SimpleConstants, TD);
2576
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002577 if (EvalSuccess) {
Chris Lattnera22fdb02005-09-26 17:07:09 +00002578 // We succeeded at evaluation: commit the result.
David Greene3215b0e2010-01-05 01:28:05 +00002579 DEBUG(dbgs() << "FULLY EVALUATED GLOBAL CTOR FUNCTION '"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +00002580 << F->getName() << "' to " << MutatedMemory.size()
2581 << " stores.\n");
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002582 for (DenseMap<Constant*, Constant*>::iterator I = MutatedMemory.begin(),
Chris Lattnera22fdb02005-09-26 17:07:09 +00002583 E = MutatedMemory.end(); I != E; ++I)
Chris Lattner7b550cc2009-11-06 04:27:31 +00002584 CommitValueTo(I->second, I->first);
Chris Lattnera22fdb02005-09-26 17:07:09 +00002585 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002586
Chris Lattnera22fdb02005-09-26 17:07:09 +00002587 // At this point, we are done interpreting. If we created any 'alloca'
2588 // temporaries, release them now.
2589 while (!AllocaTmps.empty()) {
2590 GlobalVariable *Tmp = AllocaTmps.back();
2591 AllocaTmps.pop_back();
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002592
Chris Lattnera22fdb02005-09-26 17:07:09 +00002593 // If there are still users of the alloca, the program is doing something
2594 // silly, e.g. storing the address of the alloca somewhere and using it
2595 // later. Since this is undefined, we'll just make it be null.
2596 if (!Tmp->use_empty())
Owen Andersona7235ea2009-07-31 20:28:14 +00002597 Tmp->replaceAllUsesWith(Constant::getNullValue(Tmp->getType()));
Chris Lattnera22fdb02005-09-26 17:07:09 +00002598 delete Tmp;
2599 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002600
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002601 return EvalSuccess;
Chris Lattner79c11012005-09-26 04:44:35 +00002602}
2603
Chris Lattnerdb973e62005-09-26 02:31:18 +00002604
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002605
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002606/// OptimizeGlobalCtorsList - Simplify and evaluation global ctors if possible.
2607/// Return true if anything changed.
2608bool GlobalOpt::OptimizeGlobalCtorsList(GlobalVariable *&GCL) {
2609 std::vector<Function*> Ctors = ParseGlobalCtors(GCL);
2610 bool MadeChange = false;
2611 if (Ctors.empty()) return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002612
Chris Lattner1945d582010-12-07 04:33:29 +00002613 const TargetData *TD = getAnalysisIfAvailable<TargetData>();
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002614 // Loop over global ctors, optimizing them when we can.
2615 for (unsigned i = 0; i != Ctors.size(); ++i) {
2616 Function *F = Ctors[i];
2617 // Found a null terminator in the middle of the list, prune off the rest of
2618 // the list.
Chris Lattner7d8e58f2005-09-26 02:19:27 +00002619 if (F == 0) {
2620 if (i != Ctors.size()-1) {
2621 Ctors.resize(i+1);
2622 MadeChange = true;
2623 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002624 break;
2625 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002626
Chris Lattner79c11012005-09-26 04:44:35 +00002627 // We cannot simplify external ctor functions.
2628 if (F->empty()) continue;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002629
Chris Lattner79c11012005-09-26 04:44:35 +00002630 // If we can evaluate the ctor at compile time, do.
Chris Lattner1945d582010-12-07 04:33:29 +00002631 if (EvaluateStaticConstructor(F, TD)) {
Chris Lattner79c11012005-09-26 04:44:35 +00002632 Ctors.erase(Ctors.begin()+i);
2633 MadeChange = true;
2634 --i;
2635 ++NumCtorsEvaluated;
2636 continue;
2637 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002638 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002639
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002640 if (!MadeChange) return false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002641
Chris Lattner7b550cc2009-11-06 04:27:31 +00002642 GCL = InstallGlobalCtors(GCL, Ctors);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002643 return true;
2644}
2645
Duncan Sandsfc5940d2009-03-06 10:21:56 +00002646bool GlobalOpt::OptimizeGlobalAliases(Module &M) {
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002647 bool Changed = false;
2648
Duncan Sands177d84e2009-01-07 20:01:06 +00002649 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
Duncan Sands4782b302009-02-15 09:56:08 +00002650 I != E;) {
2651 Module::alias_iterator J = I++;
Duncan Sandsfc5940d2009-03-06 10:21:56 +00002652 // Aliases without names cannot be referenced outside this module.
2653 if (!J->hasName() && !J->isDeclaration())
2654 J->setLinkage(GlobalValue::InternalLinkage);
Duncan Sands4782b302009-02-15 09:56:08 +00002655 // If the aliasee may change at link time, nothing can be done - bail out.
2656 if (J->mayBeOverridden())
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002657 continue;
2658
Duncan Sands4782b302009-02-15 09:56:08 +00002659 Constant *Aliasee = J->getAliasee();
2660 GlobalValue *Target = cast<GlobalValue>(Aliasee->stripPointerCasts());
Duncan Sands95c5d0f2009-02-18 17:55:38 +00002661 Target->removeDeadConstantUsers();
Duncan Sands4782b302009-02-15 09:56:08 +00002662 bool hasOneUse = Target->hasOneUse() && Aliasee->hasOneUse();
2663
2664 // Make all users of the alias use the aliasee instead.
2665 if (!J->use_empty()) {
2666 J->replaceAllUsesWith(Aliasee);
2667 ++NumAliasesResolved;
2668 Changed = true;
2669 }
2670
Duncan Sands7a154cf2009-12-08 10:10:20 +00002671 // If the alias is externally visible, we may still be able to simplify it.
2672 if (!J->hasLocalLinkage()) {
2673 // If the aliasee has internal linkage, give it the name and linkage
2674 // of the alias, and delete the alias. This turns:
2675 // define internal ... @f(...)
2676 // @a = alias ... @f
2677 // into:
2678 // define ... @a(...)
2679 if (!Target->hasLocalLinkage())
2680 continue;
Duncan Sands4782b302009-02-15 09:56:08 +00002681
Duncan Sands7a154cf2009-12-08 10:10:20 +00002682 // Do not perform the transform if multiple aliases potentially target the
Gabor Greif27236912010-04-07 18:59:26 +00002683 // aliasee. This check also ensures that it is safe to replace the section
Duncan Sands7a154cf2009-12-08 10:10:20 +00002684 // and other attributes of the aliasee with those of the alias.
2685 if (!hasOneUse)
2686 continue;
Duncan Sands4782b302009-02-15 09:56:08 +00002687
Duncan Sands7a154cf2009-12-08 10:10:20 +00002688 // Give the aliasee the name, linkage and other attributes of the alias.
2689 Target->takeName(J);
2690 Target->setLinkage(J->getLinkage());
2691 Target->GlobalValue::copyAttributesFrom(J);
2692 }
Duncan Sands4782b302009-02-15 09:56:08 +00002693
2694 // Delete the alias.
2695 M.getAliasList().erase(J);
2696 ++NumAliasesRemoved;
2697 Changed = true;
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002698 }
2699
2700 return Changed;
2701}
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002702
Anders Carlssona201c4c2011-03-20 17:59:11 +00002703static Function *FindCXAAtExit(Module &M) {
2704 Function *Fn = M.getFunction("__cxa_atexit");
2705
2706 if (!Fn)
2707 return 0;
2708
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002709 FunctionType *FTy = Fn->getFunctionType();
Anders Carlssona201c4c2011-03-20 17:59:11 +00002710
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00002711 // Checking that the function has the right return type, the right number of
2712 // parameters and that they all have pointer types should be enough.
2713 if (!FTy->getReturnType()->isIntegerTy() ||
2714 FTy->getNumParams() != 3 ||
Anders Carlssona201c4c2011-03-20 17:59:11 +00002715 !FTy->getParamType(0)->isPointerTy() ||
2716 !FTy->getParamType(1)->isPointerTy() ||
2717 !FTy->getParamType(2)->isPointerTy())
2718 return 0;
2719
2720 return Fn;
2721}
2722
2723/// cxxDtorIsEmpty - Returns whether the given function is an empty C++
2724/// destructor and can therefore be eliminated.
2725/// Note that we assume that other optimization passes have already simplified
2726/// the code so we only look for a function with a single basic block, where
2727/// the only allowed instructions are 'ret' or 'call' to empty C++ dtor.
Anders Carlsson372ec6a2011-03-20 20:16:43 +00002728static bool cxxDtorIsEmpty(const Function &Fn,
2729 SmallPtrSet<const Function *, 8> &CalledFunctions) {
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00002730 // FIXME: We could eliminate C++ destructors if they're readonly/readnone and
Nick Lewycky35ee1c92011-03-21 02:26:01 +00002731 // nounwind, but that doesn't seem worth doing.
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00002732 if (Fn.isDeclaration())
2733 return false;
Anders Carlssona201c4c2011-03-20 17:59:11 +00002734
2735 if (++Fn.begin() != Fn.end())
2736 return false;
2737
2738 const BasicBlock &EntryBlock = Fn.getEntryBlock();
2739 for (BasicBlock::const_iterator I = EntryBlock.begin(), E = EntryBlock.end();
2740 I != E; ++I) {
2741 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
Anders Carlssonb12caf32011-03-21 14:54:40 +00002742 // Ignore debug intrinsics.
2743 if (isa<DbgInfoIntrinsic>(CI))
2744 continue;
2745
Anders Carlssona201c4c2011-03-20 17:59:11 +00002746 const Function *CalledFn = CI->getCalledFunction();
2747
2748 if (!CalledFn)
2749 return false;
2750
Anders Carlsson807bc2a2011-03-22 03:21:01 +00002751 SmallPtrSet<const Function *, 8> NewCalledFunctions(CalledFunctions);
2752
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00002753 // Don't treat recursive functions as empty.
Anders Carlsson807bc2a2011-03-22 03:21:01 +00002754 if (!NewCalledFunctions.insert(CalledFn))
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00002755 return false;
2756
Anders Carlsson807bc2a2011-03-22 03:21:01 +00002757 if (!cxxDtorIsEmpty(*CalledFn, NewCalledFunctions))
Anders Carlssona201c4c2011-03-20 17:59:11 +00002758 return false;
2759 } else if (isa<ReturnInst>(*I))
2760 return true;
2761 else
2762 return false;
2763 }
2764
2765 return false;
2766}
2767
2768bool GlobalOpt::OptimizeEmptyGlobalCXXDtors(Function *CXAAtExitFn) {
2769 /// Itanium C++ ABI p3.3.5:
2770 ///
2771 /// After constructing a global (or local static) object, that will require
2772 /// destruction on exit, a termination function is registered as follows:
2773 ///
2774 /// extern "C" int __cxa_atexit ( void (*f)(void *), void *p, void *d );
2775 ///
2776 /// This registration, e.g. __cxa_atexit(f,p,d), is intended to cause the
2777 /// call f(p) when DSO d is unloaded, before all such termination calls
2778 /// registered before this one. It returns zero if registration is
Nick Lewycky35ee1c92011-03-21 02:26:01 +00002779 /// successful, nonzero on failure.
Anders Carlssona201c4c2011-03-20 17:59:11 +00002780
2781 // This pass will look for calls to __cxa_atexit where the function is trivial
2782 // and remove them.
2783 bool Changed = false;
2784
2785 for (Function::use_iterator I = CXAAtExitFn->use_begin(),
2786 E = CXAAtExitFn->use_end(); I != E;) {
Anders Carlsson4f735ca2011-03-20 20:21:33 +00002787 // We're only interested in calls. Theoretically, we could handle invoke
2788 // instructions as well, but neither llvm-gcc nor clang generate invokes
2789 // to __cxa_atexit.
Anders Carlssonb12caf32011-03-21 14:54:40 +00002790 CallInst *CI = dyn_cast<CallInst>(*I++);
2791 if (!CI)
Anders Carlsson4f735ca2011-03-20 20:21:33 +00002792 continue;
2793
Anders Carlssona201c4c2011-03-20 17:59:11 +00002794 Function *DtorFn =
Anders Carlssonb12caf32011-03-21 14:54:40 +00002795 dyn_cast<Function>(CI->getArgOperand(0)->stripPointerCasts());
Anders Carlssona201c4c2011-03-20 17:59:11 +00002796 if (!DtorFn)
2797 continue;
2798
Anders Carlsson372ec6a2011-03-20 20:16:43 +00002799 SmallPtrSet<const Function *, 8> CalledFunctions;
2800 if (!cxxDtorIsEmpty(*DtorFn, CalledFunctions))
Anders Carlssona201c4c2011-03-20 17:59:11 +00002801 continue;
2802
2803 // Just remove the call.
Anders Carlssonb12caf32011-03-21 14:54:40 +00002804 CI->replaceAllUsesWith(Constant::getNullValue(CI->getType()));
2805 CI->eraseFromParent();
Anders Carlsson1f7c7ba2011-03-20 19:51:13 +00002806
Anders Carlssona201c4c2011-03-20 17:59:11 +00002807 ++NumCXXDtorsRemoved;
2808
2809 Changed |= true;
2810 }
2811
2812 return Changed;
2813}
2814
Chris Lattner7a90b682004-10-07 04:16:33 +00002815bool GlobalOpt::runOnModule(Module &M) {
Chris Lattner079236d2004-02-25 21:34:36 +00002816 bool Changed = false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002817
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002818 // Try to find the llvm.globalctors list.
2819 GlobalVariable *GlobalCtors = FindGlobalCtors(M);
Chris Lattner7a90b682004-10-07 04:16:33 +00002820
Anders Carlssona201c4c2011-03-20 17:59:11 +00002821 Function *CXAAtExitFn = FindCXAAtExit(M);
2822
Chris Lattner7a90b682004-10-07 04:16:33 +00002823 bool LocalChange = true;
2824 while (LocalChange) {
2825 LocalChange = false;
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002826
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002827 // Delete functions that are trivially dead, ccc -> fastcc
2828 LocalChange |= OptimizeFunctions(M);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002829
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002830 // Optimize global_ctors list.
2831 if (GlobalCtors)
2832 LocalChange |= OptimizeGlobalCtorsList(GlobalCtors);
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002833
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002834 // Optimize non-address-taken globals.
2835 LocalChange |= OptimizeGlobalVars(M);
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002836
2837 // Resolve aliases, when possible.
Duncan Sandsfc5940d2009-03-06 10:21:56 +00002838 LocalChange |= OptimizeGlobalAliases(M);
Anders Carlssona201c4c2011-03-20 17:59:11 +00002839
2840 // Try to remove trivial global destructors.
2841 if (CXAAtExitFn)
2842 LocalChange |= OptimizeEmptyGlobalCXXDtors(CXAAtExitFn);
2843
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002844 Changed |= LocalChange;
Chris Lattner7a90b682004-10-07 04:16:33 +00002845 }
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002846
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002847 // TODO: Move all global ctors functions to the end of the module for code
2848 // layout.
Mikhail Glushenkov9d28fdd2010-10-18 21:16:00 +00002849
Chris Lattner079236d2004-02-25 21:34:36 +00002850 return Changed;
2851}